msgpack.go 21 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816
  1. // Copyright (c) 2012, 2013 Ugorji Nwoke. All rights reserved.
  2. // Use of this source code is governed by a BSD-style license found in the LICENSE file.
  3. /*
  4. MSGPACK
  5. Msgpack-c implementation powers the c, c++, python, ruby, etc libraries.
  6. We need to maintain compatibility with it and how it encodes integer values
  7. without caring about the type.
  8. For compatibility with behaviour of msgpack-c reference implementation:
  9. - Go intX (>0) and uintX
  10. IS ENCODED AS
  11. msgpack +ve fixnum, unsigned
  12. - Go intX (<0)
  13. IS ENCODED AS
  14. msgpack -ve fixnum, signed
  15. */
  16. package codec
  17. import (
  18. "fmt"
  19. "io"
  20. "math"
  21. "net/rpc"
  22. )
  23. const (
  24. mpPosFixNumMin byte = 0x00
  25. mpPosFixNumMax = 0x7f
  26. mpFixMapMin = 0x80
  27. mpFixMapMax = 0x8f
  28. mpFixArrayMin = 0x90
  29. mpFixArrayMax = 0x9f
  30. mpFixStrMin = 0xa0
  31. mpFixStrMax = 0xbf
  32. mpNil = 0xc0
  33. _ = 0xc1
  34. mpFalse = 0xc2
  35. mpTrue = 0xc3
  36. mpFloat = 0xca
  37. mpDouble = 0xcb
  38. mpUint8 = 0xcc
  39. mpUint16 = 0xcd
  40. mpUint32 = 0xce
  41. mpUint64 = 0xcf
  42. mpInt8 = 0xd0
  43. mpInt16 = 0xd1
  44. mpInt32 = 0xd2
  45. mpInt64 = 0xd3
  46. // extensions below
  47. mpBin8 = 0xc4
  48. mpBin16 = 0xc5
  49. mpBin32 = 0xc6
  50. mpExt8 = 0xc7
  51. mpExt16 = 0xc8
  52. mpExt32 = 0xc9
  53. mpFixExt1 = 0xd4
  54. mpFixExt2 = 0xd5
  55. mpFixExt4 = 0xd6
  56. mpFixExt8 = 0xd7
  57. mpFixExt16 = 0xd8
  58. mpStr8 = 0xd9 // new
  59. mpStr16 = 0xda
  60. mpStr32 = 0xdb
  61. mpArray16 = 0xdc
  62. mpArray32 = 0xdd
  63. mpMap16 = 0xde
  64. mpMap32 = 0xdf
  65. mpNegFixNumMin = 0xe0
  66. mpNegFixNumMax = 0xff
  67. )
  68. // MsgpackSpecRpcMultiArgs is a special type which signifies to the MsgpackSpecRpcCodec
  69. // that the backend RPC service takes multiple arguments, which have been arranged
  70. // in sequence in the slice.
  71. //
  72. // The Codec then passes it AS-IS to the rpc service (without wrapping it in an
  73. // array of 1 element).
  74. type MsgpackSpecRpcMultiArgs []interface{}
  75. // A MsgpackContainer type specifies the different types of msgpackContainers.
  76. type msgpackContainerType struct {
  77. fixCutoff int
  78. bFixMin, b8, b16, b32 byte
  79. hasFixMin, has8, has8Always bool
  80. }
  81. var (
  82. msgpackContainerStr = msgpackContainerType{32, mpFixStrMin, mpStr8, mpStr16, mpStr32, true, true, false}
  83. msgpackContainerBin = msgpackContainerType{0, 0, mpBin8, mpBin16, mpBin32, false, true, true}
  84. msgpackContainerList = msgpackContainerType{16, mpFixArrayMin, 0, mpArray16, mpArray32, true, false, false}
  85. msgpackContainerMap = msgpackContainerType{16, mpFixMapMin, 0, mpMap16, mpMap32, true, false, false}
  86. )
  87. //---------------------------------------------
  88. type msgpackEncDriver struct {
  89. w encWriter
  90. h *MsgpackHandle
  91. }
  92. func (e *msgpackEncDriver) isBuiltinType(rt uintptr) bool {
  93. //no builtin types. All encodings are based on kinds. Types supported as extensions.
  94. return false
  95. }
  96. func (e *msgpackEncDriver) encodeBuiltin(rt uintptr, v interface{}) {}
  97. func (e *msgpackEncDriver) encodeNil() {
  98. e.w.writen1(mpNil)
  99. }
  100. func (e *msgpackEncDriver) encodeInt(i int64) {
  101. switch {
  102. case i >= 0:
  103. e.encodeUint(uint64(i))
  104. case i >= -32:
  105. e.w.writen1(byte(i))
  106. case i >= math.MinInt8:
  107. e.w.writen2(mpInt8, byte(i))
  108. case i >= math.MinInt16:
  109. e.w.writen1(mpInt16)
  110. e.w.writeUint16(uint16(i))
  111. case i >= math.MinInt32:
  112. e.w.writen1(mpInt32)
  113. e.w.writeUint32(uint32(i))
  114. default:
  115. e.w.writen1(mpInt64)
  116. e.w.writeUint64(uint64(i))
  117. }
  118. }
  119. func (e *msgpackEncDriver) encodeUint(i uint64) {
  120. switch {
  121. case i <= math.MaxInt8:
  122. e.w.writen1(byte(i))
  123. case i <= math.MaxUint8:
  124. e.w.writen2(mpUint8, byte(i))
  125. case i <= math.MaxUint16:
  126. e.w.writen1(mpUint16)
  127. e.w.writeUint16(uint16(i))
  128. case i <= math.MaxUint32:
  129. e.w.writen1(mpUint32)
  130. e.w.writeUint32(uint32(i))
  131. default:
  132. e.w.writen1(mpUint64)
  133. e.w.writeUint64(uint64(i))
  134. }
  135. }
  136. func (e *msgpackEncDriver) encodeBool(b bool) {
  137. if b {
  138. e.w.writen1(mpTrue)
  139. } else {
  140. e.w.writen1(mpFalse)
  141. }
  142. }
  143. func (e *msgpackEncDriver) encodeFloat32(f float32) {
  144. e.w.writen1(mpFloat)
  145. e.w.writeUint32(math.Float32bits(f))
  146. }
  147. func (e *msgpackEncDriver) encodeFloat64(f float64) {
  148. e.w.writen1(mpDouble)
  149. e.w.writeUint64(math.Float64bits(f))
  150. }
  151. func (e *msgpackEncDriver) encodeExtPreamble(xtag byte, l int) {
  152. switch {
  153. case l == 1:
  154. e.w.writen2(mpFixExt1, xtag)
  155. case l == 2:
  156. e.w.writen2(mpFixExt2, xtag)
  157. case l == 4:
  158. e.w.writen2(mpFixExt4, xtag)
  159. case l == 8:
  160. e.w.writen2(mpFixExt8, xtag)
  161. case l == 16:
  162. e.w.writen2(mpFixExt16, xtag)
  163. case l < 256:
  164. e.w.writen2(mpExt8, byte(l))
  165. e.w.writen1(xtag)
  166. case l < 65536:
  167. e.w.writen1(mpExt16)
  168. e.w.writeUint16(uint16(l))
  169. e.w.writen1(xtag)
  170. default:
  171. e.w.writen1(mpExt32)
  172. e.w.writeUint32(uint32(l))
  173. e.w.writen1(xtag)
  174. }
  175. }
  176. func (e *msgpackEncDriver) encodeArrayPreamble(length int) {
  177. e.writeContainerLen(msgpackContainerList, length)
  178. }
  179. func (e *msgpackEncDriver) encodeMapPreamble(length int) {
  180. e.writeContainerLen(msgpackContainerMap, length)
  181. }
  182. func (e *msgpackEncDriver) encodeString(c charEncoding, s string) {
  183. if c == c_RAW && e.h.WriteExt {
  184. e.writeContainerLen(msgpackContainerBin, len(s))
  185. } else {
  186. e.writeContainerLen(msgpackContainerStr, len(s))
  187. }
  188. if len(s) > 0 {
  189. e.w.writestr(s)
  190. }
  191. }
  192. func (e *msgpackEncDriver) encodeSymbol(v string) {
  193. e.encodeString(c_UTF8, v)
  194. }
  195. func (e *msgpackEncDriver) encodeStringBytes(c charEncoding, bs []byte) {
  196. if c == c_RAW && e.h.WriteExt {
  197. e.writeContainerLen(msgpackContainerBin, len(bs))
  198. } else {
  199. e.writeContainerLen(msgpackContainerStr, len(bs))
  200. }
  201. if len(bs) > 0 {
  202. e.w.writeb(bs)
  203. }
  204. }
  205. func (e *msgpackEncDriver) writeContainerLen(ct msgpackContainerType, l int) {
  206. switch {
  207. case ct.hasFixMin && l < ct.fixCutoff:
  208. e.w.writen1(ct.bFixMin | byte(l))
  209. case ct.has8 && l < 256 && (ct.has8Always || e.h.WriteExt):
  210. e.w.writen2(ct.b8, uint8(l))
  211. case l < 65536:
  212. e.w.writen1(ct.b16)
  213. e.w.writeUint16(uint16(l))
  214. default:
  215. e.w.writen1(ct.b32)
  216. e.w.writeUint32(uint32(l))
  217. }
  218. }
  219. //---------------------------------------------
  220. type msgpackDecDriver struct {
  221. r decReader
  222. h *MsgpackHandle
  223. bd byte
  224. bdRead bool
  225. bdType valueType
  226. }
  227. func (d *msgpackDecDriver) isBuiltinType(rt uintptr) bool {
  228. //no builtin types. All encodings are based on kinds. Types supported as extensions.
  229. return false
  230. }
  231. func (d *msgpackDecDriver) decodeBuiltin(rt uintptr, v interface{}) {}
  232. // Note: This returns either a primitive (int, bool, etc) for non-containers,
  233. // or a containerType, or a specific type denoting nil or extension.
  234. // It is called when a nil interface{} is passed, leaving it up to the DecDriver
  235. // to introspect the stream and decide how best to decode.
  236. // It deciphers the value by looking at the stream first.
  237. func (d *msgpackDecDriver) decodeNaked() (v interface{}, vt valueType, decodeFurther bool) {
  238. d.initReadNext()
  239. bd := d.bd
  240. switch bd {
  241. case mpNil:
  242. vt = valueTypeNil
  243. d.bdRead = false
  244. case mpFalse:
  245. vt = valueTypeBool
  246. v = false
  247. case mpTrue:
  248. vt = valueTypeBool
  249. v = true
  250. case mpFloat:
  251. vt = valueTypeFloat
  252. v = float64(math.Float32frombits(d.r.readUint32()))
  253. case mpDouble:
  254. vt = valueTypeFloat
  255. v = math.Float64frombits(d.r.readUint64())
  256. case mpUint8:
  257. vt = valueTypeUint
  258. v = uint64(d.r.readn1())
  259. case mpUint16:
  260. vt = valueTypeUint
  261. v = uint64(d.r.readUint16())
  262. case mpUint32:
  263. vt = valueTypeUint
  264. v = uint64(d.r.readUint32())
  265. case mpUint64:
  266. vt = valueTypeUint
  267. v = uint64(d.r.readUint64())
  268. case mpInt8:
  269. vt = valueTypeInt
  270. v = int64(int8(d.r.readn1()))
  271. case mpInt16:
  272. vt = valueTypeInt
  273. v = int64(int16(d.r.readUint16()))
  274. case mpInt32:
  275. vt = valueTypeInt
  276. v = int64(int32(d.r.readUint32()))
  277. case mpInt64:
  278. vt = valueTypeInt
  279. v = int64(int64(d.r.readUint64()))
  280. default:
  281. switch {
  282. case bd >= mpPosFixNumMin && bd <= mpPosFixNumMax:
  283. // positive fixnum (always signed)
  284. vt = valueTypeInt
  285. v = int64(int8(bd))
  286. case bd >= mpNegFixNumMin && bd <= mpNegFixNumMax:
  287. // negative fixnum
  288. vt = valueTypeInt
  289. v = int64(int8(bd))
  290. case bd == mpStr8, bd == mpStr16, bd == mpStr32, bd >= mpFixStrMin && bd <= mpFixStrMax:
  291. if d.h.RawToString {
  292. var rvm string
  293. vt = valueTypeString
  294. v = &rvm
  295. } else {
  296. var rvm = []byte{}
  297. vt = valueTypeBytes
  298. v = &rvm
  299. }
  300. decodeFurther = true
  301. case bd == mpBin8, bd == mpBin16, bd == mpBin32:
  302. var rvm = []byte{}
  303. vt = valueTypeBytes
  304. v = &rvm
  305. decodeFurther = true
  306. case bd == mpArray16, bd == mpArray32, bd >= mpFixArrayMin && bd <= mpFixArrayMax:
  307. vt = valueTypeArray
  308. decodeFurther = true
  309. case bd == mpMap16, bd == mpMap32, bd >= mpFixMapMin && bd <= mpFixMapMax:
  310. vt = valueTypeMap
  311. decodeFurther = true
  312. case bd >= mpFixExt1 && bd <= mpFixExt16, bd >= mpExt8 && bd <= mpExt32:
  313. clen := d.readExtLen()
  314. var re RawExt
  315. re.Tag = d.r.readn1()
  316. re.Data = d.r.readn(clen)
  317. v = &re
  318. vt = valueTypeExt
  319. default:
  320. decErr("Nil-Deciphered DecodeValue: %s: hex: %x, dec: %d", msgBadDesc, bd, bd)
  321. }
  322. }
  323. if !decodeFurther {
  324. d.bdRead = false
  325. }
  326. return
  327. }
  328. // int can be decoded from msgpack type: intXXX or uintXXX
  329. func (d *msgpackDecDriver) decodeInt(bitsize uint8) (i int64) {
  330. switch d.bd {
  331. case mpUint8:
  332. i = int64(uint64(d.r.readn1()))
  333. case mpUint16:
  334. i = int64(uint64(d.r.readUint16()))
  335. case mpUint32:
  336. i = int64(uint64(d.r.readUint32()))
  337. case mpUint64:
  338. i = int64(d.r.readUint64())
  339. case mpInt8:
  340. i = int64(int8(d.r.readn1()))
  341. case mpInt16:
  342. i = int64(int16(d.r.readUint16()))
  343. case mpInt32:
  344. i = int64(int32(d.r.readUint32()))
  345. case mpInt64:
  346. i = int64(d.r.readUint64())
  347. default:
  348. switch {
  349. case d.bd >= mpPosFixNumMin && d.bd <= mpPosFixNumMax:
  350. i = int64(int8(d.bd))
  351. case d.bd >= mpNegFixNumMin && d.bd <= mpNegFixNumMax:
  352. i = int64(int8(d.bd))
  353. default:
  354. decErr("Unhandled single-byte unsigned integer value: %s: %x", msgBadDesc, d.bd)
  355. }
  356. }
  357. // check overflow (logic adapted from std pkg reflect/value.go OverflowUint()
  358. if bitsize > 0 {
  359. if trunc := (i << (64 - bitsize)) >> (64 - bitsize); i != trunc {
  360. decErr("Overflow int value: %v", i)
  361. }
  362. }
  363. d.bdRead = false
  364. return
  365. }
  366. // uint can be decoded from msgpack type: intXXX or uintXXX
  367. func (d *msgpackDecDriver) decodeUint(bitsize uint8) (ui uint64) {
  368. switch d.bd {
  369. case mpUint8:
  370. ui = uint64(d.r.readn1())
  371. case mpUint16:
  372. ui = uint64(d.r.readUint16())
  373. case mpUint32:
  374. ui = uint64(d.r.readUint32())
  375. case mpUint64:
  376. ui = d.r.readUint64()
  377. case mpInt8:
  378. if i := int64(int8(d.r.readn1())); i >= 0 {
  379. ui = uint64(i)
  380. } else {
  381. decErr("Assigning negative signed value: %v, to unsigned type", i)
  382. }
  383. case mpInt16:
  384. if i := int64(int16(d.r.readUint16())); i >= 0 {
  385. ui = uint64(i)
  386. } else {
  387. decErr("Assigning negative signed value: %v, to unsigned type", i)
  388. }
  389. case mpInt32:
  390. if i := int64(int32(d.r.readUint32())); i >= 0 {
  391. ui = uint64(i)
  392. } else {
  393. decErr("Assigning negative signed value: %v, to unsigned type", i)
  394. }
  395. case mpInt64:
  396. if i := int64(d.r.readUint64()); i >= 0 {
  397. ui = uint64(i)
  398. } else {
  399. decErr("Assigning negative signed value: %v, to unsigned type", i)
  400. }
  401. default:
  402. switch {
  403. case d.bd >= mpPosFixNumMin && d.bd <= mpPosFixNumMax:
  404. ui = uint64(d.bd)
  405. case d.bd >= mpNegFixNumMin && d.bd <= mpNegFixNumMax:
  406. decErr("Assigning negative signed value: %v, to unsigned type", int(d.bd))
  407. default:
  408. decErr("Unhandled single-byte unsigned integer value: %s: %x", msgBadDesc, d.bd)
  409. }
  410. }
  411. // check overflow (logic adapted from std pkg reflect/value.go OverflowUint()
  412. if bitsize > 0 {
  413. if trunc := (ui << (64 - bitsize)) >> (64 - bitsize); ui != trunc {
  414. decErr("Overflow uint value: %v", ui)
  415. }
  416. }
  417. d.bdRead = false
  418. return
  419. }
  420. // float can either be decoded from msgpack type: float, double or intX
  421. func (d *msgpackDecDriver) decodeFloat(chkOverflow32 bool) (f float64) {
  422. switch d.bd {
  423. case mpFloat:
  424. f = float64(math.Float32frombits(d.r.readUint32()))
  425. case mpDouble:
  426. f = math.Float64frombits(d.r.readUint64())
  427. default:
  428. f = float64(d.decodeInt(0))
  429. }
  430. checkOverflowFloat32(f, chkOverflow32)
  431. d.bdRead = false
  432. return
  433. }
  434. // bool can be decoded from bool, fixnum 0 or 1.
  435. func (d *msgpackDecDriver) decodeBool() (b bool) {
  436. switch d.bd {
  437. case mpFalse, 0:
  438. // b = false
  439. case mpTrue, 1:
  440. b = true
  441. default:
  442. decErr("Invalid single-byte value for bool: %s: %x", msgBadDesc, d.bd)
  443. }
  444. d.bdRead = false
  445. return
  446. }
  447. func (d *msgpackDecDriver) decodeString() (s string) {
  448. clen := d.readContainerLen(msgpackContainerStr)
  449. if clen > 0 {
  450. s = string(d.r.readn(clen))
  451. }
  452. d.bdRead = false
  453. return
  454. }
  455. // Callers must check if changed=true (to decide whether to replace the one they have)
  456. func (d *msgpackDecDriver) decodeBytes(bs []byte) (bsOut []byte, changed bool) {
  457. // bytes can be decoded from msgpackContainerStr or msgpackContainerBin
  458. var clen int
  459. switch d.bd {
  460. case mpBin8, mpBin16, mpBin32:
  461. clen = d.readContainerLen(msgpackContainerBin)
  462. default:
  463. clen = d.readContainerLen(msgpackContainerStr)
  464. }
  465. // if clen < 0 {
  466. // changed = true
  467. // panic("length cannot be zero. this cannot be nil.")
  468. // }
  469. if clen > 0 {
  470. // if no contents in stream, don't update the passed byteslice
  471. if len(bs) != clen {
  472. // Return changed=true if length of passed slice diff from length of bytes in stream
  473. if len(bs) > clen {
  474. bs = bs[:clen]
  475. } else {
  476. bs = make([]byte, clen)
  477. }
  478. bsOut = bs
  479. changed = true
  480. }
  481. d.r.readb(bs)
  482. }
  483. d.bdRead = false
  484. return
  485. }
  486. // Every top-level decode funcs (i.e. decodeValue, decode) must call this first.
  487. func (d *msgpackDecDriver) initReadNext() {
  488. if d.bdRead {
  489. return
  490. }
  491. d.bd = d.r.readn1()
  492. d.bdRead = true
  493. d.bdType = valueTypeUnset
  494. }
  495. func (d *msgpackDecDriver) currentEncodedType() valueType {
  496. if d.bdType == valueTypeUnset {
  497. bd := d.bd
  498. switch bd {
  499. case mpNil:
  500. d.bdType = valueTypeNil
  501. case mpFalse, mpTrue:
  502. d.bdType = valueTypeBool
  503. case mpFloat, mpDouble:
  504. d.bdType = valueTypeFloat
  505. case mpUint8, mpUint16, mpUint32, mpUint64:
  506. d.bdType = valueTypeUint
  507. case mpInt8, mpInt16, mpInt32, mpInt64:
  508. d.bdType = valueTypeInt
  509. default:
  510. switch {
  511. case bd >= mpPosFixNumMin && bd <= mpPosFixNumMax:
  512. d.bdType = valueTypeInt
  513. case bd >= mpNegFixNumMin && bd <= mpNegFixNumMax:
  514. d.bdType = valueTypeInt
  515. case bd == mpStr8, bd == mpStr16, bd == mpStr32, bd >= mpFixStrMin && bd <= mpFixStrMax:
  516. if d.h.RawToString {
  517. d.bdType = valueTypeString
  518. } else {
  519. d.bdType = valueTypeBytes
  520. }
  521. case bd == mpBin8, bd == mpBin16, bd == mpBin32:
  522. d.bdType = valueTypeBytes
  523. case bd == mpArray16, bd == mpArray32, bd >= mpFixArrayMin && bd <= mpFixArrayMax:
  524. d.bdType = valueTypeArray
  525. case bd == mpMap16, bd == mpMap32, bd >= mpFixMapMin && bd <= mpFixMapMax:
  526. d.bdType = valueTypeMap
  527. case bd >= mpFixExt1 && bd <= mpFixExt16, bd >= mpExt8 && bd <= mpExt32:
  528. d.bdType = valueTypeExt
  529. default:
  530. decErr("currentEncodedType: Undeciphered descriptor: %s: hex: %x, dec: %d", msgBadDesc, bd, bd)
  531. }
  532. }
  533. }
  534. return d.bdType
  535. }
  536. func (d *msgpackDecDriver) tryDecodeAsNil() bool {
  537. if d.bd == mpNil {
  538. d.bdRead = false
  539. return true
  540. }
  541. return false
  542. }
  543. func (d *msgpackDecDriver) readContainerLen(ct msgpackContainerType) (clen int) {
  544. bd := d.bd
  545. switch {
  546. case bd == mpNil:
  547. clen = -1 // to represent nil
  548. case bd == ct.b8:
  549. clen = int(d.r.readn1())
  550. case bd == ct.b16:
  551. clen = int(d.r.readUint16())
  552. case bd == ct.b32:
  553. clen = int(d.r.readUint32())
  554. case (ct.bFixMin & bd) == ct.bFixMin:
  555. clen = int(ct.bFixMin ^ bd)
  556. default:
  557. decErr("readContainerLen: %s: hex: %x, dec: %d", msgBadDesc, bd, bd)
  558. }
  559. d.bdRead = false
  560. return
  561. }
  562. func (d *msgpackDecDriver) readMapLen() int {
  563. return d.readContainerLen(msgpackContainerMap)
  564. }
  565. func (d *msgpackDecDriver) readArrayLen() int {
  566. return d.readContainerLen(msgpackContainerList)
  567. }
  568. func (d *msgpackDecDriver) readExtLen() (clen int) {
  569. switch d.bd {
  570. case mpNil:
  571. clen = -1 // to represent nil
  572. case mpFixExt1:
  573. clen = 1
  574. case mpFixExt2:
  575. clen = 2
  576. case mpFixExt4:
  577. clen = 4
  578. case mpFixExt8:
  579. clen = 8
  580. case mpFixExt16:
  581. clen = 16
  582. case mpExt8:
  583. clen = int(d.r.readn1())
  584. case mpExt16:
  585. clen = int(d.r.readUint16())
  586. case mpExt32:
  587. clen = int(d.r.readUint32())
  588. default:
  589. decErr("decoding ext bytes: found unexpected byte: %x", d.bd)
  590. }
  591. return
  592. }
  593. func (d *msgpackDecDriver) decodeExt(verifyTag bool, tag byte) (xtag byte, xbs []byte) {
  594. xbd := d.bd
  595. switch {
  596. case xbd == mpBin8, xbd == mpBin16, xbd == mpBin32:
  597. xbs, _ = d.decodeBytes(nil)
  598. case xbd == mpStr8, xbd == mpStr16, xbd == mpStr32,
  599. xbd >= mpFixStrMin && xbd <= mpFixStrMax:
  600. xbs = []byte(d.decodeString())
  601. default:
  602. clen := d.readExtLen()
  603. xtag = d.r.readn1()
  604. if verifyTag && xtag != tag {
  605. decErr("Wrong extension tag. Got %b. Expecting: %v", xtag, tag)
  606. }
  607. xbs = d.r.readn(clen)
  608. }
  609. d.bdRead = false
  610. return
  611. }
  612. //--------------------------------------------------
  613. //MsgpackHandle is a Handle for the Msgpack Schema-Free Encoding Format.
  614. type MsgpackHandle struct {
  615. BasicHandle
  616. // RawToString controls how raw bytes are decoded into a nil interface{}.
  617. RawToString bool
  618. // WriteExt flag supports encoding configured extensions with extension tags.
  619. // It also controls whether other elements of the new spec are encoded (ie Str8).
  620. //
  621. // With WriteExt=false, configured extensions are serialized as raw bytes
  622. // and Str8 is not encoded.
  623. //
  624. // A stream can still be decoded into a typed value, provided an appropriate value
  625. // is provided, but the type cannot be inferred from the stream. If no appropriate
  626. // type is provided (e.g. decoding into a nil interface{}), you get back
  627. // a []byte or string based on the setting of RawToString.
  628. WriteExt bool
  629. }
  630. func (h *MsgpackHandle) newEncDriver(w encWriter) encDriver {
  631. return &msgpackEncDriver{w: w, h: h}
  632. }
  633. func (h *MsgpackHandle) newDecDriver(r decReader) decDriver {
  634. return &msgpackDecDriver{r: r, h: h}
  635. }
  636. func (h *MsgpackHandle) writeExt() bool {
  637. return h.WriteExt
  638. }
  639. func (h *MsgpackHandle) getBasicHandle() *BasicHandle {
  640. return &h.BasicHandle
  641. }
  642. //--------------------------------------------------
  643. type msgpackSpecRpcCodec struct {
  644. rpcCodec
  645. }
  646. // /////////////// Spec RPC Codec ///////////////////
  647. func (c *msgpackSpecRpcCodec) WriteRequest(r *rpc.Request, body interface{}) error {
  648. // WriteRequest can write to both a Go service, and other services that do
  649. // not abide by the 1 argument rule of a Go service.
  650. // We discriminate based on if the body is a MsgpackSpecRpcMultiArgs
  651. var bodyArr []interface{}
  652. if m, ok := body.(MsgpackSpecRpcMultiArgs); ok {
  653. bodyArr = ([]interface{})(m)
  654. } else {
  655. bodyArr = []interface{}{body}
  656. }
  657. r2 := []interface{}{0, uint32(r.Seq), r.ServiceMethod, bodyArr}
  658. return c.write(r2, nil, false, true)
  659. }
  660. func (c *msgpackSpecRpcCodec) WriteResponse(r *rpc.Response, body interface{}) error {
  661. var moe interface{}
  662. if r.Error != "" {
  663. moe = r.Error
  664. }
  665. if moe != nil && body != nil {
  666. body = nil
  667. }
  668. r2 := []interface{}{1, uint32(r.Seq), moe, body}
  669. return c.write(r2, nil, false, true)
  670. }
  671. func (c *msgpackSpecRpcCodec) ReadResponseHeader(r *rpc.Response) error {
  672. return c.parseCustomHeader(1, &r.Seq, &r.Error)
  673. }
  674. func (c *msgpackSpecRpcCodec) ReadRequestHeader(r *rpc.Request) error {
  675. return c.parseCustomHeader(0, &r.Seq, &r.ServiceMethod)
  676. }
  677. func (c *msgpackSpecRpcCodec) ReadRequestBody(body interface{}) error {
  678. if body == nil { // read and discard
  679. return c.read(nil)
  680. }
  681. bodyArr := []interface{}{body}
  682. return c.read(&bodyArr)
  683. }
  684. func (c *msgpackSpecRpcCodec) parseCustomHeader(expectTypeByte byte, msgid *uint64, methodOrError *string) (err error) {
  685. if c.cls {
  686. return io.EOF
  687. }
  688. // We read the response header by hand
  689. // so that the body can be decoded on its own from the stream at a later time.
  690. const fia byte = 0x94 //four item array descriptor value
  691. // Not sure why the panic of EOF is swallowed above.
  692. // if bs1 := c.dec.r.readn1(); bs1 != fia {
  693. // err = fmt.Errorf("Unexpected value for array descriptor: Expecting %v. Received %v", fia, bs1)
  694. // return
  695. // }
  696. var b byte
  697. b, err = c.br.ReadByte()
  698. if err != nil {
  699. return
  700. }
  701. if b != fia {
  702. err = fmt.Errorf("Unexpected value for array descriptor: Expecting %v. Received %v", fia, b)
  703. return
  704. }
  705. if err = c.read(&b); err != nil {
  706. return
  707. }
  708. if b != expectTypeByte {
  709. err = fmt.Errorf("Unexpected byte descriptor in header. Expecting %v. Received %v", expectTypeByte, b)
  710. return
  711. }
  712. if err = c.read(msgid); err != nil {
  713. return
  714. }
  715. if err = c.read(methodOrError); err != nil {
  716. return
  717. }
  718. return
  719. }
  720. //--------------------------------------------------
  721. // msgpackSpecRpc is the implementation of Rpc that uses custom communication protocol
  722. // as defined in the msgpack spec at https://github.com/msgpack-rpc/msgpack-rpc/blob/master/spec.md
  723. type msgpackSpecRpc struct{}
  724. // MsgpackSpecRpc implements Rpc using the communication protocol defined in
  725. // the msgpack spec at https://github.com/msgpack-rpc/msgpack-rpc/blob/master/spec.md .
  726. // Its methods (ServerCodec and ClientCodec) return values that implement RpcCodecBuffered.
  727. var MsgpackSpecRpc msgpackSpecRpc
  728. func (x msgpackSpecRpc) ServerCodec(conn io.ReadWriteCloser, h Handle) rpc.ServerCodec {
  729. return &msgpackSpecRpcCodec{newRPCCodec(conn, h)}
  730. }
  731. func (x msgpackSpecRpc) ClientCodec(conn io.ReadWriteCloser, h Handle) rpc.ClientCodec {
  732. return &msgpackSpecRpcCodec{newRPCCodec(conn, h)}
  733. }
  734. var _ decDriver = (*msgpackDecDriver)(nil)
  735. var _ encDriver = (*msgpackEncDriver)(nil)