simple.go 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535
  1. // Copyright (c) 2012-2015 Ugorji Nwoke. All rights reserved.
  2. // Use of this source code is governed by a MIT license found in the LICENSE file.
  3. package codec
  4. import (
  5. "math"
  6. "reflect"
  7. )
  8. const (
  9. _ uint8 = iota
  10. simpleVdNil = 1
  11. simpleVdFalse = 2
  12. simpleVdTrue = 3
  13. simpleVdFloat32 = 4
  14. simpleVdFloat64 = 5
  15. // each lasts for 4 (ie n, n+1, n+2, n+3)
  16. simpleVdPosInt = 8
  17. simpleVdNegInt = 12
  18. // containers: each lasts for 4 (ie n, n+1, n+2, ... n+7)
  19. simpleVdString = 216
  20. simpleVdByteArray = 224
  21. simpleVdArray = 232
  22. simpleVdMap = 240
  23. simpleVdExt = 248
  24. )
  25. type simpleEncDriver struct {
  26. noBuiltInTypes
  27. encNoSeparator
  28. e *Encoder
  29. h *SimpleHandle
  30. w encWriter
  31. b [8]byte
  32. }
  33. func (e *simpleEncDriver) EncodeNil() {
  34. e.w.writen1(simpleVdNil)
  35. }
  36. func (e *simpleEncDriver) EncodeBool(b bool) {
  37. if b {
  38. e.w.writen1(simpleVdTrue)
  39. } else {
  40. e.w.writen1(simpleVdFalse)
  41. }
  42. }
  43. func (e *simpleEncDriver) EncodeFloat32(f float32) {
  44. e.w.writen1(simpleVdFloat32)
  45. bigenHelper{e.b[:4], e.w}.writeUint32(math.Float32bits(f))
  46. }
  47. func (e *simpleEncDriver) EncodeFloat64(f float64) {
  48. e.w.writen1(simpleVdFloat64)
  49. bigenHelper{e.b[:8], e.w}.writeUint64(math.Float64bits(f))
  50. }
  51. func (e *simpleEncDriver) EncodeInt(v int64) {
  52. if v < 0 {
  53. e.encUint(uint64(-v), simpleVdNegInt)
  54. } else {
  55. e.encUint(uint64(v), simpleVdPosInt)
  56. }
  57. }
  58. func (e *simpleEncDriver) EncodeUint(v uint64) {
  59. e.encUint(v, simpleVdPosInt)
  60. }
  61. func (e *simpleEncDriver) encUint(v uint64, bd uint8) {
  62. if v <= math.MaxUint8 {
  63. e.w.writen2(bd, uint8(v))
  64. } else if v <= math.MaxUint16 {
  65. e.w.writen1(bd + 1)
  66. bigenHelper{e.b[:2], e.w}.writeUint16(uint16(v))
  67. } else if v <= math.MaxUint32 {
  68. e.w.writen1(bd + 2)
  69. bigenHelper{e.b[:4], e.w}.writeUint32(uint32(v))
  70. } else { // if v <= math.MaxUint64 {
  71. e.w.writen1(bd + 3)
  72. bigenHelper{e.b[:8], e.w}.writeUint64(v)
  73. }
  74. }
  75. func (e *simpleEncDriver) encLen(bd byte, length int) {
  76. if length == 0 {
  77. e.w.writen1(bd)
  78. } else if length <= math.MaxUint8 {
  79. e.w.writen1(bd + 1)
  80. e.w.writen1(uint8(length))
  81. } else if length <= math.MaxUint16 {
  82. e.w.writen1(bd + 2)
  83. bigenHelper{e.b[:2], e.w}.writeUint16(uint16(length))
  84. } else if int64(length) <= math.MaxUint32 {
  85. e.w.writen1(bd + 3)
  86. bigenHelper{e.b[:4], e.w}.writeUint32(uint32(length))
  87. } else {
  88. e.w.writen1(bd + 4)
  89. bigenHelper{e.b[:8], e.w}.writeUint64(uint64(length))
  90. }
  91. }
  92. func (e *simpleEncDriver) EncodeExt(rv interface{}, xtag uint64, ext Ext, _ *Encoder) {
  93. bs := ext.WriteExt(rv)
  94. if bs == nil {
  95. e.EncodeNil()
  96. return
  97. }
  98. e.encodeExtPreamble(uint8(xtag), len(bs))
  99. e.w.writeb(bs)
  100. }
  101. func (e *simpleEncDriver) EncodeRawExt(re *RawExt, _ *Encoder) {
  102. e.encodeExtPreamble(uint8(re.Tag), len(re.Data))
  103. e.w.writeb(re.Data)
  104. }
  105. func (e *simpleEncDriver) encodeExtPreamble(xtag byte, length int) {
  106. e.encLen(simpleVdExt, length)
  107. e.w.writen1(xtag)
  108. }
  109. func (e *simpleEncDriver) EncodeArrayStart(length int) {
  110. e.encLen(simpleVdArray, length)
  111. }
  112. func (e *simpleEncDriver) EncodeMapStart(length int) {
  113. e.encLen(simpleVdMap, length)
  114. }
  115. func (e *simpleEncDriver) EncodeString(c charEncoding, v string) {
  116. e.encLen(simpleVdString, len(v))
  117. e.w.writestr(v)
  118. }
  119. func (e *simpleEncDriver) EncodeSymbol(v string) {
  120. e.EncodeString(c_UTF8, v)
  121. }
  122. func (e *simpleEncDriver) EncodeStringBytes(c charEncoding, v []byte) {
  123. e.encLen(simpleVdByteArray, len(v))
  124. e.w.writeb(v)
  125. }
  126. //------------------------------------
  127. type simpleDecDriver struct {
  128. d *Decoder
  129. h *SimpleHandle
  130. r decReader
  131. bdRead bool
  132. bd byte
  133. br bool // bytes reader
  134. noBuiltInTypes
  135. noStreamingCodec
  136. decNoSeparator
  137. b [scratchByteArrayLen]byte
  138. }
  139. func (d *simpleDecDriver) readNextBd() {
  140. d.bd = d.r.readn1()
  141. d.bdRead = true
  142. }
  143. func (d *simpleDecDriver) uncacheRead() {
  144. if d.bdRead {
  145. d.r.unreadn1()
  146. d.bdRead = false
  147. }
  148. }
  149. func (d *simpleDecDriver) ContainerType() (vt valueType) {
  150. if !d.bdRead {
  151. d.readNextBd()
  152. }
  153. if d.bd == simpleVdNil {
  154. return valueTypeNil
  155. } else if d.bd == simpleVdByteArray || d.bd == simpleVdByteArray+1 ||
  156. d.bd == simpleVdByteArray+2 || d.bd == simpleVdByteArray+3 || d.bd == simpleVdByteArray+4 {
  157. return valueTypeBytes
  158. } else if d.bd == simpleVdString || d.bd == simpleVdString+1 ||
  159. d.bd == simpleVdString+2 || d.bd == simpleVdString+3 || d.bd == simpleVdString+4 {
  160. return valueTypeString
  161. } else if d.bd == simpleVdArray || d.bd == simpleVdArray+1 ||
  162. d.bd == simpleVdArray+2 || d.bd == simpleVdArray+3 || d.bd == simpleVdArray+4 {
  163. return valueTypeArray
  164. } else if d.bd == simpleVdMap || d.bd == simpleVdMap+1 ||
  165. d.bd == simpleVdMap+2 || d.bd == simpleVdMap+3 || d.bd == simpleVdMap+4 {
  166. return valueTypeMap
  167. } else {
  168. // d.d.errorf("isContainerType: unsupported parameter: %v", vt)
  169. }
  170. return valueTypeUnset
  171. }
  172. func (d *simpleDecDriver) TryDecodeAsNil() bool {
  173. if !d.bdRead {
  174. d.readNextBd()
  175. }
  176. if d.bd == simpleVdNil {
  177. d.bdRead = false
  178. return true
  179. }
  180. return false
  181. }
  182. func (d *simpleDecDriver) decCheckInteger() (ui uint64, neg bool) {
  183. if !d.bdRead {
  184. d.readNextBd()
  185. }
  186. switch d.bd {
  187. case simpleVdPosInt:
  188. ui = uint64(d.r.readn1())
  189. case simpleVdPosInt + 1:
  190. ui = uint64(bigen.Uint16(d.r.readx(2)))
  191. case simpleVdPosInt + 2:
  192. ui = uint64(bigen.Uint32(d.r.readx(4)))
  193. case simpleVdPosInt + 3:
  194. ui = uint64(bigen.Uint64(d.r.readx(8)))
  195. case simpleVdNegInt:
  196. ui = uint64(d.r.readn1())
  197. neg = true
  198. case simpleVdNegInt + 1:
  199. ui = uint64(bigen.Uint16(d.r.readx(2)))
  200. neg = true
  201. case simpleVdNegInt + 2:
  202. ui = uint64(bigen.Uint32(d.r.readx(4)))
  203. neg = true
  204. case simpleVdNegInt + 3:
  205. ui = uint64(bigen.Uint64(d.r.readx(8)))
  206. neg = true
  207. default:
  208. d.d.errorf("decIntAny: Integer only valid from pos/neg integer1..8. Invalid descriptor: %v", d.bd)
  209. return
  210. }
  211. // don't do this check, because callers may only want the unsigned value.
  212. // if ui > math.MaxInt64 {
  213. // d.d.errorf("decIntAny: Integer out of range for signed int64: %v", ui)
  214. // return
  215. // }
  216. return
  217. }
  218. func (d *simpleDecDriver) DecodeInt(bitsize uint8) (i int64) {
  219. ui, neg := d.decCheckInteger()
  220. i, overflow := chkOvf.SignedInt(ui)
  221. if overflow {
  222. d.d.errorf("simple: overflow converting %v to signed integer", ui)
  223. return
  224. }
  225. if neg {
  226. i = -i
  227. }
  228. if chkOvf.Int(i, bitsize) {
  229. d.d.errorf("simple: overflow integer: %v", i)
  230. return
  231. }
  232. d.bdRead = false
  233. return
  234. }
  235. func (d *simpleDecDriver) DecodeUint(bitsize uint8) (ui uint64) {
  236. ui, neg := d.decCheckInteger()
  237. if neg {
  238. d.d.errorf("Assigning negative signed value to unsigned type")
  239. return
  240. }
  241. if chkOvf.Uint(ui, bitsize) {
  242. d.d.errorf("simple: overflow integer: %v", ui)
  243. return
  244. }
  245. d.bdRead = false
  246. return
  247. }
  248. func (d *simpleDecDriver) DecodeFloat(chkOverflow32 bool) (f float64) {
  249. if !d.bdRead {
  250. d.readNextBd()
  251. }
  252. if d.bd == simpleVdFloat32 {
  253. f = float64(math.Float32frombits(bigen.Uint32(d.r.readx(4))))
  254. } else if d.bd == simpleVdFloat64 {
  255. f = math.Float64frombits(bigen.Uint64(d.r.readx(8)))
  256. } else {
  257. if d.bd >= simpleVdPosInt && d.bd <= simpleVdNegInt+3 {
  258. f = float64(d.DecodeInt(64))
  259. } else {
  260. d.d.errorf("Float only valid from float32/64: Invalid descriptor: %v", d.bd)
  261. return
  262. }
  263. }
  264. if chkOverflow32 && chkOvf.Float32(f) {
  265. d.d.errorf("msgpack: float32 overflow: %v", f)
  266. return
  267. }
  268. d.bdRead = false
  269. return
  270. }
  271. // bool can be decoded from bool only (single byte).
  272. func (d *simpleDecDriver) DecodeBool() (b bool) {
  273. if !d.bdRead {
  274. d.readNextBd()
  275. }
  276. if d.bd == simpleVdTrue {
  277. b = true
  278. } else if d.bd == simpleVdFalse {
  279. } else {
  280. d.d.errorf("Invalid single-byte value for bool: %s: %x", msgBadDesc, d.bd)
  281. return
  282. }
  283. d.bdRead = false
  284. return
  285. }
  286. func (d *simpleDecDriver) ReadMapStart() (length int) {
  287. if !d.bdRead {
  288. d.readNextBd()
  289. }
  290. d.bdRead = false
  291. return d.decLen()
  292. }
  293. func (d *simpleDecDriver) ReadArrayStart() (length int) {
  294. if !d.bdRead {
  295. d.readNextBd()
  296. }
  297. d.bdRead = false
  298. return d.decLen()
  299. }
  300. func (d *simpleDecDriver) decLen() int {
  301. switch d.bd % 8 {
  302. case 0:
  303. return 0
  304. case 1:
  305. return int(d.r.readn1())
  306. case 2:
  307. return int(bigen.Uint16(d.r.readx(2)))
  308. case 3:
  309. ui := uint64(bigen.Uint32(d.r.readx(4)))
  310. if chkOvf.Uint(ui, intBitsize) {
  311. d.d.errorf("simple: overflow integer: %v", ui)
  312. return 0
  313. }
  314. return int(ui)
  315. case 4:
  316. ui := bigen.Uint64(d.r.readx(8))
  317. if chkOvf.Uint(ui, intBitsize) {
  318. d.d.errorf("simple: overflow integer: %v", ui)
  319. return 0
  320. }
  321. return int(ui)
  322. }
  323. d.d.errorf("decLen: Cannot read length: bd%%8 must be in range 0..4. Got: %d", d.bd%8)
  324. return -1
  325. }
  326. func (d *simpleDecDriver) DecodeString() (s string) {
  327. return string(d.DecodeBytes(d.b[:], true, true))
  328. }
  329. func (d *simpleDecDriver) DecodeBytes(bs []byte, isstring, zerocopy bool) (bsOut []byte) {
  330. if !d.bdRead {
  331. d.readNextBd()
  332. }
  333. if d.bd == simpleVdNil {
  334. d.bdRead = false
  335. return
  336. }
  337. clen := d.decLen()
  338. d.bdRead = false
  339. if zerocopy {
  340. if d.br {
  341. return d.r.readx(clen)
  342. } else if len(bs) == 0 {
  343. bs = d.b[:]
  344. }
  345. }
  346. return decByteSlice(d.r, clen, d.d.h.MaxInitLen, bs)
  347. }
  348. func (d *simpleDecDriver) DecodeExt(rv interface{}, xtag uint64, ext Ext) (realxtag uint64) {
  349. if xtag > 0xff {
  350. d.d.errorf("decodeExt: tag must be <= 0xff; got: %v", xtag)
  351. return
  352. }
  353. realxtag1, xbs := d.decodeExtV(ext != nil, uint8(xtag))
  354. realxtag = uint64(realxtag1)
  355. if ext == nil {
  356. re := rv.(*RawExt)
  357. re.Tag = realxtag
  358. re.Data = detachZeroCopyBytes(d.br, re.Data, xbs)
  359. } else {
  360. ext.ReadExt(rv, xbs)
  361. }
  362. return
  363. }
  364. func (d *simpleDecDriver) decodeExtV(verifyTag bool, tag byte) (xtag byte, xbs []byte) {
  365. if !d.bdRead {
  366. d.readNextBd()
  367. }
  368. switch d.bd {
  369. case simpleVdExt, simpleVdExt + 1, simpleVdExt + 2, simpleVdExt + 3, simpleVdExt + 4:
  370. l := d.decLen()
  371. xtag = d.r.readn1()
  372. if verifyTag && xtag != tag {
  373. d.d.errorf("Wrong extension tag. Got %b. Expecting: %v", xtag, tag)
  374. return
  375. }
  376. xbs = d.r.readx(l)
  377. case simpleVdByteArray, simpleVdByteArray + 1, simpleVdByteArray + 2, simpleVdByteArray + 3, simpleVdByteArray + 4:
  378. xbs = d.DecodeBytes(nil, false, true)
  379. default:
  380. d.d.errorf("Invalid d.bd for extensions (Expecting extensions or byte array). Got: 0x%x", d.bd)
  381. return
  382. }
  383. d.bdRead = false
  384. return
  385. }
  386. func (d *simpleDecDriver) DecodeNaked() {
  387. if !d.bdRead {
  388. d.readNextBd()
  389. }
  390. n := &d.d.n
  391. var decodeFurther bool
  392. switch d.bd {
  393. case simpleVdNil:
  394. n.v = valueTypeNil
  395. case simpleVdFalse:
  396. n.v = valueTypeBool
  397. n.b = false
  398. case simpleVdTrue:
  399. n.v = valueTypeBool
  400. n.b = true
  401. case simpleVdPosInt, simpleVdPosInt + 1, simpleVdPosInt + 2, simpleVdPosInt + 3:
  402. if d.h.SignedInteger {
  403. n.v = valueTypeInt
  404. n.i = d.DecodeInt(64)
  405. } else {
  406. n.v = valueTypeUint
  407. n.u = d.DecodeUint(64)
  408. }
  409. case simpleVdNegInt, simpleVdNegInt + 1, simpleVdNegInt + 2, simpleVdNegInt + 3:
  410. n.v = valueTypeInt
  411. n.i = d.DecodeInt(64)
  412. case simpleVdFloat32:
  413. n.v = valueTypeFloat
  414. n.f = d.DecodeFloat(true)
  415. case simpleVdFloat64:
  416. n.v = valueTypeFloat
  417. n.f = d.DecodeFloat(false)
  418. case simpleVdString, simpleVdString + 1, simpleVdString + 2, simpleVdString + 3, simpleVdString + 4:
  419. n.v = valueTypeString
  420. n.s = d.DecodeString()
  421. case simpleVdByteArray, simpleVdByteArray + 1, simpleVdByteArray + 2, simpleVdByteArray + 3, simpleVdByteArray + 4:
  422. n.v = valueTypeBytes
  423. n.l = d.DecodeBytes(nil, false, false)
  424. case simpleVdExt, simpleVdExt + 1, simpleVdExt + 2, simpleVdExt + 3, simpleVdExt + 4:
  425. n.v = valueTypeExt
  426. l := d.decLen()
  427. n.u = uint64(d.r.readn1())
  428. n.l = d.r.readx(l)
  429. case simpleVdArray, simpleVdArray + 1, simpleVdArray + 2, simpleVdArray + 3, simpleVdArray + 4:
  430. n.v = valueTypeArray
  431. decodeFurther = true
  432. case simpleVdMap, simpleVdMap + 1, simpleVdMap + 2, simpleVdMap + 3, simpleVdMap + 4:
  433. n.v = valueTypeMap
  434. decodeFurther = true
  435. default:
  436. d.d.errorf("decodeNaked: Unrecognized d.bd: 0x%x", d.bd)
  437. }
  438. if !decodeFurther {
  439. d.bdRead = false
  440. }
  441. return
  442. }
  443. //------------------------------------
  444. // SimpleHandle is a Handle for a very simple encoding format.
  445. //
  446. // simple is a simplistic codec similar to binc, but not as compact.
  447. // - Encoding of a value is always preceded by the descriptor byte (bd)
  448. // - True, false, nil are encoded fully in 1 byte (the descriptor)
  449. // - Integers (intXXX, uintXXX) are encoded in 1, 2, 4 or 8 bytes (plus a descriptor byte).
  450. // There are positive (uintXXX and intXXX >= 0) and negative (intXXX < 0) integers.
  451. // - Floats are encoded in 4 or 8 bytes (plus a descriptor byte)
  452. // - Lenght of containers (strings, bytes, array, map, extensions)
  453. // are encoded in 0, 1, 2, 4 or 8 bytes.
  454. // Zero-length containers have no length encoded.
  455. // For others, the number of bytes is given by pow(2, bd%3)
  456. // - maps are encoded as [bd] [length] [[key][value]]...
  457. // - arrays are encoded as [bd] [length] [value]...
  458. // - extensions are encoded as [bd] [length] [tag] [byte]...
  459. // - strings/bytearrays are encoded as [bd] [length] [byte]...
  460. //
  461. // The full spec will be published soon.
  462. type SimpleHandle struct {
  463. BasicHandle
  464. binaryEncodingType
  465. }
  466. func (h *SimpleHandle) SetBytesExt(rt reflect.Type, tag uint64, ext BytesExt) (err error) {
  467. return h.SetExt(rt, tag, &setExtWrapper{b: ext})
  468. }
  469. func (h *SimpleHandle) newEncDriver(e *Encoder) encDriver {
  470. return &simpleEncDriver{e: e, w: e.w, h: h}
  471. }
  472. func (h *SimpleHandle) newDecDriver(d *Decoder) decDriver {
  473. return &simpleDecDriver{d: d, h: h, r: d.r, br: d.bytes}
  474. }
  475. func (e *simpleEncDriver) reset() {
  476. e.w = e.e.w
  477. }
  478. func (d *simpleDecDriver) reset() {
  479. d.r, d.br = d.d.r, d.d.bytes
  480. d.bd, d.bdRead = 0, false
  481. }
  482. var _ decDriver = (*simpleDecDriver)(nil)
  483. var _ encDriver = (*simpleEncDriver)(nil)