simple.go 13 KB

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