decode.go 42 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654
  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. "encoding"
  6. "errors"
  7. "fmt"
  8. "io"
  9. "reflect"
  10. )
  11. // Some tagging information for error messages.
  12. const (
  13. msgBadDesc = "Unrecognized descriptor byte"
  14. msgDecCannotExpandArr = "cannot expand go array from %v to stream length: %v"
  15. )
  16. var (
  17. onlyMapOrArrayCanDecodeIntoStructErr = errors.New("only encoded map or array can be decoded into a struct")
  18. cannotDecodeIntoNilErr = errors.New("cannot decode into nil")
  19. )
  20. // decReader abstracts the reading source, allowing implementations that can
  21. // read from an io.Reader or directly off a byte slice with zero-copying.
  22. type decReader interface {
  23. unreadn1()
  24. // readx will use the implementation scratch buffer if possible i.e. n < len(scratchbuf), OR
  25. // just return a view of the []byte being decoded from.
  26. // Ensure you call detachZeroCopyBytes later if this needs to be sent outside codec control.
  27. readx(n int) []byte
  28. readb([]byte)
  29. readn1() uint8
  30. readn1eof() (v uint8, eof bool)
  31. numread() int // number of bytes read
  32. track()
  33. stopTrack() []byte
  34. }
  35. type decReaderByteScanner interface {
  36. io.Reader
  37. io.ByteScanner
  38. }
  39. type decDriver interface {
  40. // this will check if the next token is a break.
  41. CheckBreak() bool
  42. TryDecodeAsNil() bool
  43. // check if a container type: vt is one of: Bytes, String, Nil, Slice or Map.
  44. // if vt param == valueTypeNil, and nil is seen in stream, consume the nil.
  45. IsContainerType(vt valueType) bool
  46. IsBuiltinType(rt uintptr) bool
  47. DecodeBuiltin(rt uintptr, v interface{})
  48. //decodeNaked: Numbers are decoded as int64, uint64, float64 only (no smaller sized number types).
  49. //for extensions, decodeNaked must completely decode them as a *RawExt.
  50. //extensions should also use readx to decode them, for efficiency.
  51. //kInterface will extract the detached byte slice if it has to pass it outside its realm.
  52. DecodeNaked() (v interface{}, vt valueType, decodeFurther bool)
  53. DecodeInt(bitsize uint8) (i int64)
  54. DecodeUint(bitsize uint8) (ui uint64)
  55. DecodeFloat(chkOverflow32 bool) (f float64)
  56. DecodeBool() (b bool)
  57. // DecodeString can also decode symbols.
  58. // It looks redundant as DecodeBytes is available.
  59. // However, some codecs (e.g. binc) support symbols and can
  60. // return a pre-stored string value, meaning that it can bypass
  61. // the cost of []byte->string conversion.
  62. DecodeString() (s string)
  63. // DecodeBytes may be called directly, without going through reflection.
  64. // Consequently, it must be designed to handle possible nil.
  65. DecodeBytes(bs []byte, isstring, zerocopy bool) (bsOut []byte)
  66. // decodeExt will decode into a *RawExt or into an extension.
  67. DecodeExt(v interface{}, xtag uint64, ext Ext) (realxtag uint64)
  68. // decodeExt(verifyTag bool, tag byte) (xtag byte, xbs []byte)
  69. ReadMapStart() int
  70. ReadArrayStart() int
  71. // ReadEnd registers the end of a map or array.
  72. ReadEnd()
  73. }
  74. type decNoSeparator struct{}
  75. func (_ decNoSeparator) ReadEnd() {}
  76. type DecodeOptions struct {
  77. // MapType specifies type to use during schema-less decoding of a map in the stream.
  78. // If nil, we use map[interface{}]interface{}
  79. MapType reflect.Type
  80. // SliceType specifies type to use during schema-less decoding of an array in the stream.
  81. // If nil, we use []interface{}
  82. SliceType reflect.Type
  83. // MaxInitLen defines the initial length that we "make" a collection (slice, chan or map) with.
  84. // If 0 or negative, we default to a sensible value based on the size of an element in the collection.
  85. //
  86. // For example, when decoding, a stream may say that it has MAX_UINT elements.
  87. // We should not auto-matically provision a slice of that length, to prevent Out-Of-Memory crash.
  88. // Instead, we provision up to MaxInitLen, fill that up, and start appending after that.
  89. MaxInitLen int
  90. // If ErrorIfNoField, return an error when decoding a map
  91. // from a codec stream into a struct, and no matching struct field is found.
  92. ErrorIfNoField bool
  93. // If ErrorIfNoArrayExpand, return an error when decoding a slice/array that cannot be expanded.
  94. // For example, the stream contains an array of 8 items, but you are decoding into a [4]T array,
  95. // or you are decoding into a slice of length 4 which is non-addressable (and so cannot be set).
  96. ErrorIfNoArrayExpand bool
  97. // If SignedInteger, use the int64 during schema-less decoding of unsigned values (not uint64).
  98. SignedInteger bool
  99. // MapValueReset controls how we decode into a map value.
  100. //
  101. // By default, we MAY retrieve the mapping for a key, and then decode into that.
  102. // However, especially with big maps, that retrieval may be expensive and unnecessary
  103. // if the stream already contains all that is necessary to recreate the value.
  104. //
  105. // If true, we will never retrieve the previous mapping,
  106. // but rather decode into a new value and set that in the map.
  107. //
  108. // If false, we will retrieve the previous mapping if necessary e.g.
  109. // the previous mapping is a pointer, or is a struct or array with pre-set state,
  110. // or is an interface.
  111. MapValueReset bool
  112. // InterfaceReset controls how we decode into an interface.
  113. //
  114. // By default, when we see a field that is an interface{...},
  115. // or a map with interface{...} value, we will attempt decoding into the
  116. // "contained" value.
  117. //
  118. // However, this prevents us from reading a string into an interface{}
  119. // that formerly contained a number.
  120. //
  121. // If true, we will decode into a new "blank" value, and set that in the interface.
  122. // If true, we will decode into whatever is contained in the interface.
  123. InterfaceReset bool
  124. }
  125. // ------------------------------------
  126. // ioDecByteScanner implements Read(), ReadByte(...), UnreadByte(...) methods
  127. // of io.Reader, io.ByteScanner.
  128. type ioDecByteScanner struct {
  129. r io.Reader
  130. l byte // last byte
  131. ls byte // last byte status. 0: init-canDoNothing, 1: canRead, 2: canUnread
  132. b [1]byte // tiny buffer for reading single bytes
  133. }
  134. func (z *ioDecByteScanner) Read(p []byte) (n int, err error) {
  135. var firstByte bool
  136. if z.ls == 1 {
  137. z.ls = 2
  138. p[0] = z.l
  139. if len(p) == 1 {
  140. n = 1
  141. return
  142. }
  143. firstByte = true
  144. p = p[1:]
  145. }
  146. n, err = z.r.Read(p)
  147. if n > 0 {
  148. if err == io.EOF && n == len(p) {
  149. err = nil // read was successful, so postpone EOF (till next time)
  150. }
  151. z.l = p[n-1]
  152. z.ls = 2
  153. }
  154. if firstByte {
  155. n++
  156. }
  157. return
  158. }
  159. func (z *ioDecByteScanner) ReadByte() (c byte, err error) {
  160. n, err := z.Read(z.b[:])
  161. if n == 1 {
  162. c = z.b[0]
  163. if err == io.EOF {
  164. err = nil // read was successful, so postpone EOF (till next time)
  165. }
  166. }
  167. return
  168. }
  169. func (z *ioDecByteScanner) UnreadByte() (err error) {
  170. x := z.ls
  171. if x == 0 {
  172. err = errors.New("cannot unread - nothing has been read")
  173. } else if x == 1 {
  174. err = errors.New("cannot unread - last byte has not been read")
  175. } else if x == 2 {
  176. z.ls = 1
  177. }
  178. return
  179. }
  180. // ioDecReader is a decReader that reads off an io.Reader
  181. type ioDecReader struct {
  182. br decReaderByteScanner
  183. // temp byte array re-used internally for efficiency during read.
  184. // shares buffer with Decoder, so we keep size of struct within 8 words.
  185. x *[scratchByteArrayLen]byte
  186. bs ioDecByteScanner
  187. n int // num read
  188. tr []byte // tracking bytes read
  189. trb bool
  190. }
  191. func (z *ioDecReader) numread() int {
  192. return z.n
  193. }
  194. func (z *ioDecReader) readx(n int) (bs []byte) {
  195. if n <= 0 {
  196. return
  197. }
  198. if n < len(z.x) {
  199. bs = z.x[:n]
  200. } else {
  201. bs = make([]byte, n)
  202. }
  203. if _, err := io.ReadAtLeast(z.br, bs, n); err != nil {
  204. panic(err)
  205. }
  206. z.n += len(bs)
  207. if z.trb {
  208. z.tr = append(z.tr, bs...)
  209. }
  210. return
  211. }
  212. func (z *ioDecReader) readb(bs []byte) {
  213. if len(bs) == 0 {
  214. return
  215. }
  216. n, err := io.ReadAtLeast(z.br, bs, len(bs))
  217. z.n += n
  218. if err != nil {
  219. panic(err)
  220. }
  221. if z.trb {
  222. z.tr = append(z.tr, bs...)
  223. }
  224. }
  225. func (z *ioDecReader) readn1() (b uint8) {
  226. b, err := z.br.ReadByte()
  227. if err != nil {
  228. panic(err)
  229. }
  230. z.n++
  231. if z.trb {
  232. z.tr = append(z.tr, b)
  233. }
  234. return b
  235. }
  236. func (z *ioDecReader) readn1eof() (b uint8, eof bool) {
  237. b, err := z.br.ReadByte()
  238. if err == nil {
  239. z.n++
  240. if z.trb {
  241. z.tr = append(z.tr, b)
  242. }
  243. } else if err == io.EOF {
  244. eof = true
  245. } else {
  246. panic(err)
  247. }
  248. return
  249. }
  250. func (z *ioDecReader) unreadn1() {
  251. err := z.br.UnreadByte()
  252. if err != nil {
  253. panic(err)
  254. }
  255. z.n--
  256. if z.trb {
  257. if l := len(z.tr) - 1; l >= 0 {
  258. z.tr = z.tr[:l]
  259. }
  260. }
  261. }
  262. func (z *ioDecReader) track() {
  263. if z.tr != nil {
  264. z.tr = z.tr[:0]
  265. }
  266. z.trb = true
  267. }
  268. func (z *ioDecReader) stopTrack() (bs []byte) {
  269. z.trb = false
  270. return z.tr
  271. }
  272. // ------------------------------------
  273. var bytesDecReaderCannotUnreadErr = errors.New("cannot unread last byte read")
  274. // bytesDecReader is a decReader that reads off a byte slice with zero copying
  275. type bytesDecReader struct {
  276. b []byte // data
  277. c int // cursor
  278. a int // available
  279. t int // track start
  280. }
  281. func (z *bytesDecReader) numread() int {
  282. return z.c
  283. }
  284. func (z *bytesDecReader) unreadn1() {
  285. if z.c == 0 || len(z.b) == 0 {
  286. panic(bytesDecReaderCannotUnreadErr)
  287. }
  288. z.c--
  289. z.a++
  290. return
  291. }
  292. func (z *bytesDecReader) readx(n int) (bs []byte) {
  293. // slicing from a non-constant start position is more expensive,
  294. // as more computation is required to decipher the pointer start position.
  295. // However, we do it only once, and it's better than reslicing both z.b and return value.
  296. if n <= 0 {
  297. } else if z.a == 0 {
  298. panic(io.EOF)
  299. } else if n > z.a {
  300. panic(io.ErrUnexpectedEOF)
  301. } else {
  302. c0 := z.c
  303. z.c = c0 + n
  304. z.a = z.a - n
  305. bs = z.b[c0:z.c]
  306. }
  307. return
  308. }
  309. func (z *bytesDecReader) readn1() (v uint8) {
  310. if z.a == 0 {
  311. panic(io.EOF)
  312. }
  313. v = z.b[z.c]
  314. z.c++
  315. z.a--
  316. return
  317. }
  318. func (z *bytesDecReader) readn1eof() (v uint8, eof bool) {
  319. if z.a == 0 {
  320. eof = true
  321. return
  322. }
  323. v = z.b[z.c]
  324. z.c++
  325. z.a--
  326. return
  327. }
  328. func (z *bytesDecReader) readb(bs []byte) {
  329. copy(bs, z.readx(len(bs)))
  330. }
  331. func (z *bytesDecReader) track() {
  332. z.t = z.c
  333. }
  334. func (z *bytesDecReader) stopTrack() (bs []byte) {
  335. return z.b[z.t:z.c]
  336. }
  337. // ------------------------------------
  338. type decFnInfo struct {
  339. d *Decoder
  340. ti *typeInfo
  341. xfFn Ext
  342. xfTag uint64
  343. seq seqType
  344. }
  345. // ----------------------------------------
  346. type decFn struct {
  347. i decFnInfo
  348. f func(*decFnInfo, reflect.Value)
  349. }
  350. func (f *decFnInfo) builtin(rv reflect.Value) {
  351. f.d.d.DecodeBuiltin(f.ti.rtid, rv.Addr().Interface())
  352. }
  353. func (f *decFnInfo) rawExt(rv reflect.Value) {
  354. f.d.d.DecodeExt(rv.Addr().Interface(), 0, nil)
  355. }
  356. func (f *decFnInfo) ext(rv reflect.Value) {
  357. f.d.d.DecodeExt(rv.Addr().Interface(), f.xfTag, f.xfFn)
  358. }
  359. func (f *decFnInfo) getValueForUnmarshalInterface(rv reflect.Value, indir int8) (v interface{}) {
  360. if indir == -1 {
  361. v = rv.Addr().Interface()
  362. } else if indir == 0 {
  363. v = rv.Interface()
  364. } else {
  365. for j := int8(0); j < indir; j++ {
  366. if rv.IsNil() {
  367. rv.Set(reflect.New(rv.Type().Elem()))
  368. }
  369. rv = rv.Elem()
  370. }
  371. v = rv.Interface()
  372. }
  373. return
  374. }
  375. func (f *decFnInfo) selferUnmarshal(rv reflect.Value) {
  376. f.getValueForUnmarshalInterface(rv, f.ti.csIndir).(Selfer).CodecDecodeSelf(f.d)
  377. }
  378. func (f *decFnInfo) binaryUnmarshal(rv reflect.Value) {
  379. bm := f.getValueForUnmarshalInterface(rv, f.ti.bunmIndir).(encoding.BinaryUnmarshaler)
  380. xbs := f.d.d.DecodeBytes(nil, false, true)
  381. if fnerr := bm.UnmarshalBinary(xbs); fnerr != nil {
  382. panic(fnerr)
  383. }
  384. }
  385. func (f *decFnInfo) textUnmarshal(rv reflect.Value) {
  386. tm := f.getValueForUnmarshalInterface(rv, f.ti.tunmIndir).(encoding.TextUnmarshaler)
  387. fnerr := tm.UnmarshalText(f.d.d.DecodeBytes(f.d.b[:], true, true))
  388. if fnerr != nil {
  389. panic(fnerr)
  390. }
  391. }
  392. func (f *decFnInfo) jsonUnmarshal(rv reflect.Value) {
  393. tm := f.getValueForUnmarshalInterface(rv, f.ti.junmIndir).(jsonUnmarshaler)
  394. // bs := f.d.d.DecodeBytes(f.d.b[:], true, true)
  395. // grab the bytes to be read, as UnmarshalJSON wants the full JSON to unmarshal it itself.
  396. f.d.r.track()
  397. f.d.swallow()
  398. bs := f.d.r.stopTrack()
  399. // fmt.Printf(">>>>>> REFLECTION JSON: %s\n", bs)
  400. fnerr := tm.UnmarshalJSON(bs)
  401. if fnerr != nil {
  402. panic(fnerr)
  403. }
  404. }
  405. func (f *decFnInfo) kErr(rv reflect.Value) {
  406. f.d.errorf("no decoding function defined for kind %v", rv.Kind())
  407. }
  408. func (f *decFnInfo) kString(rv reflect.Value) {
  409. rv.SetString(f.d.d.DecodeString())
  410. }
  411. func (f *decFnInfo) kBool(rv reflect.Value) {
  412. rv.SetBool(f.d.d.DecodeBool())
  413. }
  414. func (f *decFnInfo) kInt(rv reflect.Value) {
  415. rv.SetInt(f.d.d.DecodeInt(intBitsize))
  416. }
  417. func (f *decFnInfo) kInt64(rv reflect.Value) {
  418. rv.SetInt(f.d.d.DecodeInt(64))
  419. }
  420. func (f *decFnInfo) kInt32(rv reflect.Value) {
  421. rv.SetInt(f.d.d.DecodeInt(32))
  422. }
  423. func (f *decFnInfo) kInt8(rv reflect.Value) {
  424. rv.SetInt(f.d.d.DecodeInt(8))
  425. }
  426. func (f *decFnInfo) kInt16(rv reflect.Value) {
  427. rv.SetInt(f.d.d.DecodeInt(16))
  428. }
  429. func (f *decFnInfo) kFloat32(rv reflect.Value) {
  430. rv.SetFloat(f.d.d.DecodeFloat(true))
  431. }
  432. func (f *decFnInfo) kFloat64(rv reflect.Value) {
  433. rv.SetFloat(f.d.d.DecodeFloat(false))
  434. }
  435. func (f *decFnInfo) kUint8(rv reflect.Value) {
  436. rv.SetUint(f.d.d.DecodeUint(8))
  437. }
  438. func (f *decFnInfo) kUint64(rv reflect.Value) {
  439. rv.SetUint(f.d.d.DecodeUint(64))
  440. }
  441. func (f *decFnInfo) kUint(rv reflect.Value) {
  442. rv.SetUint(f.d.d.DecodeUint(uintBitsize))
  443. }
  444. func (f *decFnInfo) kUintptr(rv reflect.Value) {
  445. rv.SetUint(f.d.d.DecodeUint(uintBitsize))
  446. }
  447. func (f *decFnInfo) kUint32(rv reflect.Value) {
  448. rv.SetUint(f.d.d.DecodeUint(32))
  449. }
  450. func (f *decFnInfo) kUint16(rv reflect.Value) {
  451. rv.SetUint(f.d.d.DecodeUint(16))
  452. }
  453. // func (f *decFnInfo) kPtr(rv reflect.Value) {
  454. // debugf(">>>>>>> ??? decode kPtr called - shouldn't get called")
  455. // if rv.IsNil() {
  456. // rv.Set(reflect.New(rv.Type().Elem()))
  457. // }
  458. // f.d.decodeValue(rv.Elem())
  459. // }
  460. // var kIntfCtr uint64
  461. func (f *decFnInfo) kInterfaceNaked() (rvn reflect.Value) {
  462. // nil interface:
  463. // use some hieristics to decode it appropriately
  464. // based on the detected next value in the stream.
  465. v, vt, decodeFurther := f.d.d.DecodeNaked()
  466. if vt == valueTypeNil {
  467. return
  468. }
  469. // We cannot decode non-nil stream value into nil interface with methods (e.g. io.Reader).
  470. if num := f.ti.rt.NumMethod(); num > 0 {
  471. f.d.errorf("cannot decode non-nil codec value into nil %v (%v methods)", f.ti.rt, num)
  472. return
  473. }
  474. var useRvn bool
  475. switch vt {
  476. case valueTypeMap:
  477. if f.d.h.MapType == nil {
  478. var m2 map[interface{}]interface{}
  479. v = &m2
  480. } else {
  481. rvn = reflect.New(f.d.h.MapType).Elem()
  482. useRvn = true
  483. }
  484. case valueTypeArray:
  485. if f.d.h.SliceType == nil {
  486. var m2 []interface{}
  487. v = &m2
  488. } else {
  489. rvn = reflect.New(f.d.h.SliceType).Elem()
  490. useRvn = true
  491. }
  492. case valueTypeExt:
  493. re := v.(*RawExt)
  494. bfn := f.d.h.getExtForTag(re.Tag)
  495. if bfn == nil {
  496. re.Data = detachZeroCopyBytes(f.d.bytes, nil, re.Data)
  497. rvn = reflect.ValueOf(*re)
  498. } else {
  499. rvnA := reflect.New(bfn.rt)
  500. rvn = rvnA.Elem()
  501. if re.Data != nil {
  502. bfn.ext.ReadExt(rvnA.Interface(), re.Data)
  503. } else {
  504. bfn.ext.UpdateExt(rvnA.Interface(), re.Value)
  505. }
  506. }
  507. return
  508. }
  509. if decodeFurther {
  510. if useRvn {
  511. f.d.decodeValue(rvn, nil)
  512. } else if v != nil {
  513. // this v is a pointer, so we need to dereference it when done
  514. f.d.decode(v)
  515. rvn = reflect.ValueOf(v).Elem()
  516. useRvn = true
  517. }
  518. }
  519. if !useRvn && v != nil {
  520. rvn = reflect.ValueOf(v)
  521. }
  522. return
  523. }
  524. func (f *decFnInfo) kInterface(rv reflect.Value) {
  525. // debugf("\t===> kInterface")
  526. // Note:
  527. // A consequence of how kInterface works, is that
  528. // if an interface already contains something, we try
  529. // to decode into what was there before.
  530. // We do not replace with a generic value (as got from decodeNaked).
  531. var rvn reflect.Value
  532. if rv.IsNil() {
  533. rvn = f.kInterfaceNaked()
  534. if rvn.IsValid() {
  535. rv.Set(rvn)
  536. }
  537. } else if f.d.h.InterfaceReset {
  538. rvn = f.kInterfaceNaked()
  539. if rvn.IsValid() {
  540. rv.Set(rvn)
  541. } else {
  542. // reset to zero value based on current type in there.
  543. rv.Set(reflect.Zero(rv.Elem().Type()))
  544. }
  545. } else {
  546. rvn = rv.Elem()
  547. // Note: interface{} is settable, but underlying type may not be.
  548. // Consequently, we have to set the reflect.Value directly.
  549. // if underlying type is settable (e.g. ptr or interface),
  550. // we just decode into it.
  551. // Else we create a settable value, decode into it, and set on the interface.
  552. if rvn.CanSet() {
  553. f.d.decodeValue(rvn, nil)
  554. } else {
  555. rvn2 := reflect.New(rvn.Type()).Elem()
  556. rvn2.Set(rvn)
  557. f.d.decodeValue(rvn2, nil)
  558. rv.Set(rvn2)
  559. }
  560. }
  561. }
  562. func (f *decFnInfo) kStruct(rv reflect.Value) {
  563. fti := f.ti
  564. d := f.d
  565. dd := d.d
  566. if dd.IsContainerType(valueTypeMap) {
  567. containerLen := dd.ReadMapStart()
  568. if containerLen == 0 {
  569. dd.ReadEnd()
  570. return
  571. }
  572. tisfi := fti.sfi
  573. hasLen := containerLen >= 0
  574. if hasLen {
  575. for j := 0; j < containerLen; j++ {
  576. // rvkencname := dd.DecodeString()
  577. rvkencname := stringView(dd.DecodeBytes(f.d.b[:], true, true))
  578. // rvksi := ti.getForEncName(rvkencname)
  579. if k := fti.indexForEncName(rvkencname); k > -1 {
  580. si := tisfi[k]
  581. if dd.TryDecodeAsNil() {
  582. si.setToZeroValue(rv)
  583. } else {
  584. d.decodeValue(si.field(rv, true), nil)
  585. }
  586. } else {
  587. d.structFieldNotFound(-1, rvkencname)
  588. }
  589. }
  590. } else {
  591. for j := 0; !dd.CheckBreak(); j++ {
  592. // rvkencname := dd.DecodeString()
  593. rvkencname := stringView(dd.DecodeBytes(f.d.b[:], true, true))
  594. // rvksi := ti.getForEncName(rvkencname)
  595. if k := fti.indexForEncName(rvkencname); k > -1 {
  596. si := tisfi[k]
  597. if dd.TryDecodeAsNil() {
  598. si.setToZeroValue(rv)
  599. } else {
  600. d.decodeValue(si.field(rv, true), nil)
  601. }
  602. } else {
  603. d.structFieldNotFound(-1, rvkencname)
  604. }
  605. }
  606. dd.ReadEnd()
  607. }
  608. } else if dd.IsContainerType(valueTypeArray) {
  609. containerLen := dd.ReadArrayStart()
  610. if containerLen == 0 {
  611. dd.ReadEnd()
  612. return
  613. }
  614. // Not much gain from doing it two ways for array.
  615. // Arrays are not used as much for structs.
  616. hasLen := containerLen >= 0
  617. for j, si := range fti.sfip {
  618. if hasLen {
  619. if j == containerLen {
  620. break
  621. }
  622. } else if dd.CheckBreak() {
  623. break
  624. }
  625. if dd.TryDecodeAsNil() {
  626. si.setToZeroValue(rv)
  627. } else {
  628. d.decodeValue(si.field(rv, true), nil)
  629. }
  630. }
  631. if containerLen > len(fti.sfip) {
  632. // read remaining values and throw away
  633. for j := len(fti.sfip); j < containerLen; j++ {
  634. d.structFieldNotFound(j, "")
  635. }
  636. }
  637. dd.ReadEnd()
  638. } else {
  639. f.d.error(onlyMapOrArrayCanDecodeIntoStructErr)
  640. return
  641. }
  642. }
  643. func (f *decFnInfo) kSlice(rv reflect.Value) {
  644. // A slice can be set from a map or array in stream.
  645. // This way, the order can be kept (as order is lost with map).
  646. ti := f.ti
  647. d := f.d
  648. dd := d.d
  649. rtelem0 := ti.rt.Elem()
  650. if dd.IsContainerType(valueTypeBytes) || dd.IsContainerType(valueTypeString) {
  651. if ti.rtid == uint8SliceTypId || rtelem0.Kind() == reflect.Uint8 {
  652. if f.seq == seqTypeChan {
  653. bs2 := dd.DecodeBytes(nil, false, true)
  654. ch := rv.Interface().(chan<- byte)
  655. for _, b := range bs2 {
  656. ch <- b
  657. }
  658. } else {
  659. rvbs := rv.Bytes()
  660. bs2 := dd.DecodeBytes(rvbs, false, false)
  661. if rvbs == nil && bs2 != nil || rvbs != nil && bs2 == nil || len(bs2) != len(rvbs) {
  662. if rv.CanSet() {
  663. rv.SetBytes(bs2)
  664. } else {
  665. copy(rvbs, bs2)
  666. }
  667. }
  668. }
  669. return
  670. }
  671. }
  672. // array := f.seq == seqTypeChan
  673. slh, containerLenS := d.decSliceHelperStart()
  674. var rvlen, numToRead int
  675. var truncated bool // says that the len of the sequence is not same as the expected number of elements.
  676. numToRead = containerLenS // if truncated, reset numToRead
  677. // an array can never return a nil slice. so no need to check f.array here.
  678. if rv.IsNil() {
  679. // either chan or slice
  680. if rvlen, truncated = decInferLen(containerLenS, f.d.h.MaxInitLen, int(rtelem0.Size())); truncated {
  681. numToRead = rvlen
  682. }
  683. if f.seq == seqTypeSlice {
  684. rv.Set(reflect.MakeSlice(ti.rt, rvlen, rvlen))
  685. } else if f.seq == seqTypeChan {
  686. rv.Set(reflect.MakeChan(ti.rt, rvlen))
  687. }
  688. } else {
  689. rvlen = rv.Len()
  690. }
  691. if containerLenS == 0 {
  692. if f.seq == seqTypeSlice && rvlen != 0 {
  693. rv.SetLen(0)
  694. }
  695. // dd.ReadEnd()
  696. return
  697. }
  698. rtelem := rtelem0
  699. for rtelem.Kind() == reflect.Ptr {
  700. rtelem = rtelem.Elem()
  701. }
  702. fn := d.getDecFn(rtelem, true, true)
  703. var rv0, rv9 reflect.Value
  704. rv0 = rv
  705. rvChanged := false
  706. rvcap := rv.Cap()
  707. // for j := 0; j < containerLenS; j++ {
  708. if containerLenS >= 0 { // hasLen
  709. if f.seq == seqTypeChan {
  710. // handle chan specially:
  711. for j := 0; j < containerLenS; j++ {
  712. rv9 = reflect.New(rtelem0).Elem()
  713. d.decodeValue(rv9, fn)
  714. rv.Send(rv9)
  715. }
  716. } else { // slice or array
  717. if containerLenS > rvcap {
  718. if f.seq == seqTypeArray {
  719. d.arrayCannotExpand(rvlen, containerLenS)
  720. } else {
  721. oldRvlenGtZero := rvlen > 0
  722. rvlen, truncated = decInferLen(containerLenS, f.d.h.MaxInitLen, int(rtelem0.Size()))
  723. rv = reflect.MakeSlice(ti.rt, rvlen, rvlen)
  724. if oldRvlenGtZero && !isImmutableKind(rtelem0.Kind()) {
  725. reflect.Copy(rv, rv0) // only copy up to length NOT cap i.e. rv0.Slice(0, rvcap)
  726. }
  727. rvChanged = true
  728. }
  729. numToRead = rvlen
  730. } else if containerLenS != rvlen {
  731. if f.seq == seqTypeSlice {
  732. rv.SetLen(containerLenS)
  733. rvlen = containerLenS
  734. }
  735. }
  736. j := 0
  737. // we read up to the numToRead
  738. for ; j < numToRead; j++ {
  739. d.decodeValue(rv.Index(j), fn)
  740. }
  741. // if slice, expand and read up to containerLenS (or EOF) iff truncated
  742. // if array, swallow all the rest.
  743. if f.seq == seqTypeArray {
  744. for ; j < containerLenS; j++ {
  745. d.swallow()
  746. }
  747. } else if truncated { // slice was truncated, as chan NOT in this block
  748. for ; j < containerLenS; j++ {
  749. rv = expandSliceValue(rv, 1)
  750. rv9 = rv.Index(j)
  751. if resetSliceElemToZeroValue {
  752. rv9.Set(reflect.Zero(rtelem0))
  753. }
  754. d.decodeValue(rv9, fn)
  755. }
  756. }
  757. }
  758. } else {
  759. for j := 0; !dd.CheckBreak(); j++ {
  760. var decodeIntoBlank bool
  761. // if indefinite, etc, then expand the slice if necessary
  762. if j >= rvlen {
  763. if f.seq == seqTypeArray {
  764. d.arrayCannotExpand(rvlen, j+1)
  765. decodeIntoBlank = true
  766. } else if f.seq == seqTypeSlice {
  767. // rv = reflect.Append(rv, reflect.Zero(rtelem0)) // uses append logic, plus varargs
  768. rv = expandSliceValue(rv, 1)
  769. rv9 = rv.Index(j)
  770. // rv.Index(rv.Len() - 1).Set(reflect.Zero(rtelem0))
  771. if resetSliceElemToZeroValue {
  772. rv9.Set(reflect.Zero(rtelem0))
  773. }
  774. rvlen++
  775. rvChanged = true
  776. }
  777. } else if f.seq != seqTypeChan { // slice or array
  778. rv9 = rv.Index(j)
  779. }
  780. if f.seq == seqTypeChan {
  781. rv9 = reflect.New(rtelem0).Elem()
  782. d.decodeValue(rv9, fn)
  783. rv.Send(rv9)
  784. } else if decodeIntoBlank {
  785. d.swallow()
  786. } else { // seqTypeSlice
  787. d.decodeValue(rv9, fn)
  788. }
  789. }
  790. slh.End()
  791. }
  792. if rvChanged {
  793. rv0.Set(rv)
  794. }
  795. }
  796. func (f *decFnInfo) kArray(rv reflect.Value) {
  797. // f.d.decodeValue(rv.Slice(0, rv.Len()))
  798. f.kSlice(rv.Slice(0, rv.Len()))
  799. }
  800. func (f *decFnInfo) kMap(rv reflect.Value) {
  801. d := f.d
  802. dd := d.d
  803. containerLen := dd.ReadMapStart()
  804. ti := f.ti
  805. if rv.IsNil() {
  806. rv.Set(reflect.MakeMap(ti.rt))
  807. }
  808. if containerLen == 0 {
  809. // It is not length-prefix style container. They have no End marker.
  810. // dd.ReadMapEnd()
  811. return
  812. }
  813. ktype, vtype := ti.rt.Key(), ti.rt.Elem()
  814. ktypeId := reflect.ValueOf(ktype).Pointer()
  815. var keyFn, valFn *decFn
  816. var xtyp reflect.Type
  817. for xtyp = ktype; xtyp.Kind() == reflect.Ptr; xtyp = xtyp.Elem() {
  818. }
  819. keyFn = d.getDecFn(xtyp, true, true)
  820. for xtyp = vtype; xtyp.Kind() == reflect.Ptr; xtyp = xtyp.Elem() {
  821. }
  822. valFn = d.getDecFn(xtyp, true, true)
  823. var mapGet bool
  824. if !f.d.h.MapValueReset {
  825. // if pointer, mapGet = true
  826. // if interface, mapGet = true if !DecodeNakedAlways (else false)
  827. // if builtin, mapGet = false
  828. // else mapGet = true
  829. vtypeKind := vtype.Kind()
  830. if vtypeKind == reflect.Ptr {
  831. mapGet = true
  832. } else if vtypeKind == reflect.Interface {
  833. if !f.d.h.InterfaceReset {
  834. mapGet = true
  835. }
  836. } else if !isImmutableKind(vtypeKind) {
  837. mapGet = true
  838. }
  839. }
  840. var rvk, rvv reflect.Value
  841. // for j := 0; j < containerLen; j++ {
  842. if containerLen > 0 {
  843. for j := 0; j < containerLen; j++ {
  844. rvk = reflect.New(ktype).Elem()
  845. d.decodeValue(rvk, keyFn)
  846. // special case if a byte array.
  847. if ktypeId == intfTypId {
  848. rvk = rvk.Elem()
  849. if rvk.Type() == uint8SliceTyp {
  850. rvk = reflect.ValueOf(string(rvk.Bytes()))
  851. }
  852. }
  853. if mapGet {
  854. rvv = rv.MapIndex(rvk)
  855. if !rvv.IsValid() {
  856. rvv = reflect.New(vtype).Elem()
  857. }
  858. } else {
  859. rvv = reflect.New(vtype).Elem()
  860. }
  861. d.decodeValue(rvv, valFn)
  862. rv.SetMapIndex(rvk, rvv)
  863. }
  864. } else {
  865. for j := 0; !dd.CheckBreak(); j++ {
  866. rvk = reflect.New(ktype).Elem()
  867. d.decodeValue(rvk, keyFn)
  868. // special case if a byte array.
  869. if ktypeId == intfTypId {
  870. rvk = rvk.Elem()
  871. if rvk.Type() == uint8SliceTyp {
  872. rvk = reflect.ValueOf(string(rvk.Bytes()))
  873. }
  874. }
  875. if mapGet {
  876. rvv = rv.MapIndex(rvk)
  877. if !rvv.IsValid() {
  878. rvv = reflect.New(vtype).Elem()
  879. }
  880. } else {
  881. rvv = reflect.New(vtype).Elem()
  882. }
  883. d.decodeValue(rvv, valFn)
  884. rv.SetMapIndex(rvk, rvv)
  885. }
  886. dd.ReadEnd()
  887. }
  888. }
  889. type decRtidFn struct {
  890. rtid uintptr
  891. fn decFn
  892. }
  893. // A Decoder reads and decodes an object from an input stream in the codec format.
  894. type Decoder struct {
  895. // hopefully, reduce derefencing cost by laying the decReader inside the Decoder.
  896. // Try to put things that go together to fit within a cache line (8 words).
  897. d decDriver
  898. // NOTE: Decoder shouldn't call it's read methods,
  899. // as the handler MAY need to do some coordination.
  900. r decReader
  901. // sa [initCollectionCap]decRtidFn
  902. s []decRtidFn
  903. h *BasicHandle
  904. rb bytesDecReader
  905. hh Handle
  906. be bool // is binary encoding
  907. bytes bool // is bytes reader
  908. js bool // is json handle
  909. ri ioDecReader
  910. f map[uintptr]*decFn
  911. // _ uintptr // for alignment purposes, so next one starts from a cache line
  912. b [scratchByteArrayLen]byte
  913. }
  914. // NewDecoder returns a Decoder for decoding a stream of bytes from an io.Reader.
  915. //
  916. // For efficiency, Users are encouraged to pass in a memory buffered reader
  917. // (eg bufio.Reader, bytes.Buffer).
  918. func NewDecoder(r io.Reader, h Handle) (d *Decoder) {
  919. d = &Decoder{hh: h, h: h.getBasicHandle(), be: h.isBinary()}
  920. // d.s = d.sa[:0]
  921. d.ri.x = &d.b
  922. d.ri.bs.r = r
  923. var ok bool
  924. d.ri.br, ok = r.(decReaderByteScanner)
  925. if !ok {
  926. d.ri.br = &d.ri.bs
  927. }
  928. d.r = &d.ri
  929. _, d.js = h.(*JsonHandle)
  930. d.d = h.newDecDriver(d)
  931. return
  932. }
  933. // NewDecoderBytes returns a Decoder which efficiently decodes directly
  934. // from a byte slice with zero copying.
  935. func NewDecoderBytes(in []byte, h Handle) (d *Decoder) {
  936. d = &Decoder{hh: h, h: h.getBasicHandle(), be: h.isBinary(), bytes: true}
  937. // d.s = d.sa[:0]
  938. d.rb.b = in
  939. d.rb.a = len(in)
  940. d.r = &d.rb
  941. _, d.js = h.(*JsonHandle)
  942. d.d = h.newDecDriver(d)
  943. // d.d = h.newDecDriver(decReaderT{true, &d.rb, &d.ri})
  944. return
  945. }
  946. // Decode decodes the stream from reader and stores the result in the
  947. // value pointed to by v. v cannot be a nil pointer. v can also be
  948. // a reflect.Value of a pointer.
  949. //
  950. // Note that a pointer to a nil interface is not a nil pointer.
  951. // If you do not know what type of stream it is, pass in a pointer to a nil interface.
  952. // We will decode and store a value in that nil interface.
  953. //
  954. // Sample usages:
  955. // // Decoding into a non-nil typed value
  956. // var f float32
  957. // err = codec.NewDecoder(r, handle).Decode(&f)
  958. //
  959. // // Decoding into nil interface
  960. // var v interface{}
  961. // dec := codec.NewDecoder(r, handle)
  962. // err = dec.Decode(&v)
  963. //
  964. // When decoding into a nil interface{}, we will decode into an appropriate value based
  965. // on the contents of the stream:
  966. // - Numbers are decoded as float64, int64 or uint64.
  967. // - Other values are decoded appropriately depending on the type:
  968. // bool, string, []byte, time.Time, etc
  969. // - Extensions are decoded as RawExt (if no ext function registered for the tag)
  970. // Configurations exist on the Handle to override defaults
  971. // (e.g. for MapType, SliceType and how to decode raw bytes).
  972. //
  973. // When decoding into a non-nil interface{} value, the mode of encoding is based on the
  974. // type of the value. When a value is seen:
  975. // - If an extension is registered for it, call that extension function
  976. // - If it implements BinaryUnmarshaler, call its UnmarshalBinary(data []byte) error
  977. // - Else decode it based on its reflect.Kind
  978. //
  979. // There are some special rules when decoding into containers (slice/array/map/struct).
  980. // Decode will typically use the stream contents to UPDATE the container.
  981. // - A map can be decoded from a stream map, by updating matching keys.
  982. // - A slice can be decoded from a stream array,
  983. // by updating the first n elements, where n is length of the stream.
  984. // - A slice can be decoded from a stream map, by decoding as if
  985. // it contains a sequence of key-value pairs.
  986. // - A struct can be decoded from a stream map, by updating matching fields.
  987. // - A struct can be decoded from a stream array,
  988. // by updating fields as they occur in the struct (by index).
  989. //
  990. // When decoding a stream map or array with length of 0 into a nil map or slice,
  991. // we reset the destination map or slice to a zero-length value.
  992. //
  993. // However, when decoding a stream nil, we reset the destination container
  994. // to its "zero" value (e.g. nil for slice/map, etc).
  995. //
  996. func (d *Decoder) Decode(v interface{}) (err error) {
  997. defer panicToErr(&err)
  998. d.decode(v)
  999. return
  1000. }
  1001. // this is not a smart swallow, as it allocates objects and does unnecessary work.
  1002. func (d *Decoder) swallowViaHammer() {
  1003. var blank interface{}
  1004. d.decodeValue(reflect.ValueOf(&blank).Elem(), nil)
  1005. }
  1006. func (d *Decoder) swallow() {
  1007. // smarter decode that just swallows the content
  1008. dd := d.d
  1009. switch {
  1010. case dd.TryDecodeAsNil():
  1011. case dd.IsContainerType(valueTypeMap):
  1012. containerLen := dd.ReadMapStart()
  1013. clenGtEqualZero := containerLen >= 0
  1014. for j := 0; ; j++ {
  1015. if clenGtEqualZero {
  1016. if j >= containerLen {
  1017. break
  1018. }
  1019. } else if dd.CheckBreak() {
  1020. break
  1021. }
  1022. d.swallow()
  1023. d.swallow()
  1024. }
  1025. dd.ReadEnd()
  1026. case dd.IsContainerType(valueTypeArray):
  1027. containerLenS := dd.ReadArrayStart()
  1028. clenGtEqualZero := containerLenS >= 0
  1029. for j := 0; ; j++ {
  1030. if clenGtEqualZero {
  1031. if j >= containerLenS {
  1032. break
  1033. }
  1034. } else if dd.CheckBreak() {
  1035. break
  1036. }
  1037. d.swallow()
  1038. }
  1039. dd.ReadEnd()
  1040. case dd.IsContainerType(valueTypeBytes):
  1041. dd.DecodeBytes(d.b[:], false, true)
  1042. case dd.IsContainerType(valueTypeString):
  1043. dd.DecodeBytes(d.b[:], true, true)
  1044. // dd.DecodeStringAsBytes(d.b[:])
  1045. default:
  1046. // these are all primitives, which we can get from decodeNaked
  1047. dd.DecodeNaked()
  1048. }
  1049. }
  1050. // MustDecode is like Decode, but panics if unable to Decode.
  1051. // This provides insight to the code location that triggered the error.
  1052. func (d *Decoder) MustDecode(v interface{}) {
  1053. d.decode(v)
  1054. }
  1055. func (d *Decoder) decode(iv interface{}) {
  1056. // if ics, ok := iv.(Selfer); ok {
  1057. // ics.CodecDecodeSelf(d)
  1058. // return
  1059. // }
  1060. if d.d.TryDecodeAsNil() {
  1061. switch v := iv.(type) {
  1062. case nil:
  1063. case *string:
  1064. *v = ""
  1065. case *bool:
  1066. *v = false
  1067. case *int:
  1068. *v = 0
  1069. case *int8:
  1070. *v = 0
  1071. case *int16:
  1072. *v = 0
  1073. case *int32:
  1074. *v = 0
  1075. case *int64:
  1076. *v = 0
  1077. case *uint:
  1078. *v = 0
  1079. case *uint8:
  1080. *v = 0
  1081. case *uint16:
  1082. *v = 0
  1083. case *uint32:
  1084. *v = 0
  1085. case *uint64:
  1086. *v = 0
  1087. case *float32:
  1088. *v = 0
  1089. case *float64:
  1090. *v = 0
  1091. case *[]uint8:
  1092. *v = nil
  1093. case reflect.Value:
  1094. d.chkPtrValue(v)
  1095. v = v.Elem()
  1096. if v.IsValid() {
  1097. v.Set(reflect.Zero(v.Type()))
  1098. }
  1099. default:
  1100. rv := reflect.ValueOf(iv)
  1101. d.chkPtrValue(rv)
  1102. rv = rv.Elem()
  1103. if rv.IsValid() {
  1104. rv.Set(reflect.Zero(rv.Type()))
  1105. }
  1106. }
  1107. return
  1108. }
  1109. switch v := iv.(type) {
  1110. case nil:
  1111. d.error(cannotDecodeIntoNilErr)
  1112. return
  1113. case Selfer:
  1114. v.CodecDecodeSelf(d)
  1115. case reflect.Value:
  1116. d.chkPtrValue(v)
  1117. d.decodeValueNotNil(v.Elem(), nil)
  1118. case *string:
  1119. *v = d.d.DecodeString()
  1120. case *bool:
  1121. *v = d.d.DecodeBool()
  1122. case *int:
  1123. *v = int(d.d.DecodeInt(intBitsize))
  1124. case *int8:
  1125. *v = int8(d.d.DecodeInt(8))
  1126. case *int16:
  1127. *v = int16(d.d.DecodeInt(16))
  1128. case *int32:
  1129. *v = int32(d.d.DecodeInt(32))
  1130. case *int64:
  1131. *v = d.d.DecodeInt(64)
  1132. case *uint:
  1133. *v = uint(d.d.DecodeUint(uintBitsize))
  1134. case *uint8:
  1135. *v = uint8(d.d.DecodeUint(8))
  1136. case *uint16:
  1137. *v = uint16(d.d.DecodeUint(16))
  1138. case *uint32:
  1139. *v = uint32(d.d.DecodeUint(32))
  1140. case *uint64:
  1141. *v = d.d.DecodeUint(64)
  1142. case *float32:
  1143. *v = float32(d.d.DecodeFloat(true))
  1144. case *float64:
  1145. *v = d.d.DecodeFloat(false)
  1146. case *[]uint8:
  1147. *v = d.d.DecodeBytes(*v, false, false)
  1148. case *interface{}:
  1149. d.decodeValueNotNil(reflect.ValueOf(iv).Elem(), nil)
  1150. default:
  1151. if !fastpathDecodeTypeSwitch(iv, d) {
  1152. d.decodeI(iv, true, false, false, false)
  1153. }
  1154. }
  1155. }
  1156. func (d *Decoder) preDecodeValue(rv reflect.Value, tryNil bool) (rv2 reflect.Value, proceed bool) {
  1157. if tryNil && d.d.TryDecodeAsNil() {
  1158. // No need to check if a ptr, recursively, to determine
  1159. // whether to set value to nil.
  1160. // Just always set value to its zero type.
  1161. if rv.IsValid() { // rv.CanSet() // always settable, except it's invalid
  1162. rv.Set(reflect.Zero(rv.Type()))
  1163. }
  1164. return
  1165. }
  1166. // If stream is not containing a nil value, then we can deref to the base
  1167. // non-pointer value, and decode into that.
  1168. for rv.Kind() == reflect.Ptr {
  1169. if rv.IsNil() {
  1170. rv.Set(reflect.New(rv.Type().Elem()))
  1171. }
  1172. rv = rv.Elem()
  1173. }
  1174. return rv, true
  1175. }
  1176. func (d *Decoder) decodeI(iv interface{}, checkPtr, tryNil, checkFastpath, checkCodecSelfer bool) {
  1177. rv := reflect.ValueOf(iv)
  1178. if checkPtr {
  1179. d.chkPtrValue(rv)
  1180. }
  1181. rv, proceed := d.preDecodeValue(rv, tryNil)
  1182. if proceed {
  1183. fn := d.getDecFn(rv.Type(), checkFastpath, checkCodecSelfer)
  1184. fn.f(&fn.i, rv)
  1185. }
  1186. }
  1187. func (d *Decoder) decodeValue(rv reflect.Value, fn *decFn) {
  1188. if rv, proceed := d.preDecodeValue(rv, true); proceed {
  1189. if fn == nil {
  1190. fn = d.getDecFn(rv.Type(), true, true)
  1191. }
  1192. fn.f(&fn.i, rv)
  1193. }
  1194. }
  1195. func (d *Decoder) decodeValueNotNil(rv reflect.Value, fn *decFn) {
  1196. if rv, proceed := d.preDecodeValue(rv, false); proceed {
  1197. if fn == nil {
  1198. fn = d.getDecFn(rv.Type(), true, true)
  1199. }
  1200. fn.f(&fn.i, rv)
  1201. }
  1202. }
  1203. func (d *Decoder) getDecFn(rt reflect.Type, checkFastpath, checkCodecSelfer bool) (fn *decFn) {
  1204. rtid := reflect.ValueOf(rt).Pointer()
  1205. // retrieve or register a focus'ed function for this type
  1206. // to eliminate need to do the retrieval multiple times
  1207. // if d.f == nil && d.s == nil { debugf("---->Creating new dec f map for type: %v\n", rt) }
  1208. var ok bool
  1209. if useMapForCodecCache {
  1210. fn, ok = d.f[rtid]
  1211. } else {
  1212. for i := range d.s {
  1213. v := &(d.s[i])
  1214. if v.rtid == rtid {
  1215. fn, ok = &(v.fn), true
  1216. break
  1217. }
  1218. }
  1219. }
  1220. if ok {
  1221. return
  1222. }
  1223. if useMapForCodecCache {
  1224. if d.f == nil {
  1225. d.f = make(map[uintptr]*decFn, initCollectionCap)
  1226. }
  1227. fn = new(decFn)
  1228. d.f[rtid] = fn
  1229. } else {
  1230. if d.s == nil {
  1231. d.s = make([]decRtidFn, 0, initCollectionCap)
  1232. }
  1233. d.s = append(d.s, decRtidFn{rtid: rtid})
  1234. fn = &(d.s[len(d.s)-1]).fn
  1235. }
  1236. // debugf("\tCreating new dec fn for type: %v\n", rt)
  1237. ti := d.h.getTypeInfo(rtid, rt)
  1238. fi := &(fn.i)
  1239. fi.d = d
  1240. fi.ti = ti
  1241. // An extension can be registered for any type, regardless of the Kind
  1242. // (e.g. type BitSet int64, type MyStruct { / * unexported fields * / }, type X []int, etc.
  1243. //
  1244. // We can't check if it's an extension byte here first, because the user may have
  1245. // registered a pointer or non-pointer type, meaning we may have to recurse first
  1246. // before matching a mapped type, even though the extension byte is already detected.
  1247. //
  1248. // NOTE: if decoding into a nil interface{}, we return a non-nil
  1249. // value except even if the container registers a length of 0.
  1250. if checkCodecSelfer && ti.cs {
  1251. fn.f = (*decFnInfo).selferUnmarshal
  1252. } else if rtid == rawExtTypId {
  1253. fn.f = (*decFnInfo).rawExt
  1254. } else if d.d.IsBuiltinType(rtid) {
  1255. fn.f = (*decFnInfo).builtin
  1256. } else if xfFn := d.h.getExt(rtid); xfFn != nil {
  1257. fi.xfTag, fi.xfFn = xfFn.tag, xfFn.ext
  1258. fn.f = (*decFnInfo).ext
  1259. } else if supportMarshalInterfaces && d.be && ti.bunm {
  1260. fn.f = (*decFnInfo).binaryUnmarshal
  1261. } else if supportMarshalInterfaces && !d.be && d.js && ti.junm {
  1262. //If JSON, we should check JSONUnmarshal before textUnmarshal
  1263. fn.f = (*decFnInfo).jsonUnmarshal
  1264. } else if supportMarshalInterfaces && !d.be && ti.tunm {
  1265. fn.f = (*decFnInfo).textUnmarshal
  1266. } else {
  1267. rk := rt.Kind()
  1268. if fastpathEnabled && checkFastpath && (rk == reflect.Map || rk == reflect.Slice) {
  1269. if rt.PkgPath() == "" {
  1270. if idx := fastpathAV.index(rtid); idx != -1 {
  1271. fn.f = fastpathAV[idx].decfn
  1272. }
  1273. } else {
  1274. // use mapping for underlying type if there
  1275. ok = false
  1276. var rtu reflect.Type
  1277. if rk == reflect.Map {
  1278. rtu = reflect.MapOf(rt.Key(), rt.Elem())
  1279. } else {
  1280. rtu = reflect.SliceOf(rt.Elem())
  1281. }
  1282. rtuid := reflect.ValueOf(rtu).Pointer()
  1283. if idx := fastpathAV.index(rtuid); idx != -1 {
  1284. xfnf := fastpathAV[idx].decfn
  1285. xrt := fastpathAV[idx].rt
  1286. fn.f = func(xf *decFnInfo, xrv reflect.Value) {
  1287. // xfnf(xf, xrv.Convert(xrt))
  1288. xfnf(xf, xrv.Addr().Convert(reflect.PtrTo(xrt)).Elem())
  1289. }
  1290. }
  1291. }
  1292. }
  1293. if fn.f == nil {
  1294. switch rk {
  1295. case reflect.String:
  1296. fn.f = (*decFnInfo).kString
  1297. case reflect.Bool:
  1298. fn.f = (*decFnInfo).kBool
  1299. case reflect.Int:
  1300. fn.f = (*decFnInfo).kInt
  1301. case reflect.Int64:
  1302. fn.f = (*decFnInfo).kInt64
  1303. case reflect.Int32:
  1304. fn.f = (*decFnInfo).kInt32
  1305. case reflect.Int8:
  1306. fn.f = (*decFnInfo).kInt8
  1307. case reflect.Int16:
  1308. fn.f = (*decFnInfo).kInt16
  1309. case reflect.Float32:
  1310. fn.f = (*decFnInfo).kFloat32
  1311. case reflect.Float64:
  1312. fn.f = (*decFnInfo).kFloat64
  1313. case reflect.Uint8:
  1314. fn.f = (*decFnInfo).kUint8
  1315. case reflect.Uint64:
  1316. fn.f = (*decFnInfo).kUint64
  1317. case reflect.Uint:
  1318. fn.f = (*decFnInfo).kUint
  1319. case reflect.Uint32:
  1320. fn.f = (*decFnInfo).kUint32
  1321. case reflect.Uint16:
  1322. fn.f = (*decFnInfo).kUint16
  1323. // case reflect.Ptr:
  1324. // fn.f = (*decFnInfo).kPtr
  1325. case reflect.Uintptr:
  1326. fn.f = (*decFnInfo).kUintptr
  1327. case reflect.Interface:
  1328. fn.f = (*decFnInfo).kInterface
  1329. case reflect.Struct:
  1330. fn.f = (*decFnInfo).kStruct
  1331. case reflect.Chan:
  1332. fi.seq = seqTypeChan
  1333. fn.f = (*decFnInfo).kSlice
  1334. case reflect.Slice:
  1335. fi.seq = seqTypeSlice
  1336. fn.f = (*decFnInfo).kSlice
  1337. case reflect.Array:
  1338. fi.seq = seqTypeArray
  1339. fn.f = (*decFnInfo).kArray
  1340. case reflect.Map:
  1341. fn.f = (*decFnInfo).kMap
  1342. default:
  1343. fn.f = (*decFnInfo).kErr
  1344. }
  1345. }
  1346. }
  1347. return
  1348. }
  1349. func (d *Decoder) structFieldNotFound(index int, rvkencname string) {
  1350. if d.h.ErrorIfNoField {
  1351. if index >= 0 {
  1352. d.errorf("no matching struct field found when decoding stream array at index %v", index)
  1353. return
  1354. } else if rvkencname != "" {
  1355. d.errorf("no matching struct field found when decoding stream map with key %s", rvkencname)
  1356. return
  1357. }
  1358. }
  1359. d.swallow()
  1360. }
  1361. func (d *Decoder) arrayCannotExpand(sliceLen, streamLen int) {
  1362. if d.h.ErrorIfNoArrayExpand {
  1363. d.errorf("cannot expand array len during decode from %v to %v", sliceLen, streamLen)
  1364. }
  1365. }
  1366. func (d *Decoder) chkPtrValue(rv reflect.Value) {
  1367. // We can only decode into a non-nil pointer
  1368. if rv.Kind() == reflect.Ptr && !rv.IsNil() {
  1369. return
  1370. }
  1371. if !rv.IsValid() {
  1372. d.error(cannotDecodeIntoNilErr)
  1373. return
  1374. }
  1375. if !rv.CanInterface() {
  1376. d.errorf("cannot decode into a value without an interface: %v", rv)
  1377. return
  1378. }
  1379. rvi := rv.Interface()
  1380. d.errorf("cannot decode into non-pointer or nil pointer. Got: %v, %T, %v", rv.Kind(), rvi, rvi)
  1381. }
  1382. func (d *Decoder) error(err error) {
  1383. panic(err)
  1384. }
  1385. func (d *Decoder) errorf(format string, params ...interface{}) {
  1386. params2 := make([]interface{}, len(params)+1)
  1387. params2[0] = d.r.numread()
  1388. copy(params2[1:], params)
  1389. err := fmt.Errorf("[pos %d]: "+format, params2...)
  1390. panic(err)
  1391. }
  1392. // --------------------------------------------------
  1393. // decSliceHelper assists when decoding into a slice, from a map or an array in the stream.
  1394. // A slice can be set from a map or array in stream. This supports the MapBySlice interface.
  1395. type decSliceHelper struct {
  1396. dd decDriver
  1397. ct valueType
  1398. }
  1399. func (d *Decoder) decSliceHelperStart() (x decSliceHelper, clen int) {
  1400. x.dd = d.d
  1401. if x.dd.IsContainerType(valueTypeArray) {
  1402. x.ct = valueTypeArray
  1403. clen = x.dd.ReadArrayStart()
  1404. } else if x.dd.IsContainerType(valueTypeMap) {
  1405. x.ct = valueTypeMap
  1406. clen = x.dd.ReadMapStart() * 2
  1407. } else {
  1408. d.errorf("only encoded map or array can be decoded into a slice")
  1409. }
  1410. return
  1411. }
  1412. func (x decSliceHelper) End() {
  1413. x.dd.ReadEnd()
  1414. }
  1415. func decByteSlice(r decReader, clen int, bs []byte) (bsOut []byte) {
  1416. if clen == 0 {
  1417. return zeroByteSlice
  1418. }
  1419. if len(bs) == clen {
  1420. bsOut = bs
  1421. } else if cap(bs) >= clen {
  1422. bsOut = bs[:clen]
  1423. } else {
  1424. bsOut = make([]byte, clen)
  1425. }
  1426. r.readb(bsOut)
  1427. return
  1428. }
  1429. func detachZeroCopyBytes(isBytesReader bool, dest []byte, in []byte) (out []byte) {
  1430. if xlen := len(in); xlen > 0 {
  1431. if isBytesReader || xlen <= scratchByteArrayLen {
  1432. if cap(dest) >= xlen {
  1433. out = dest[:xlen]
  1434. } else {
  1435. out = make([]byte, xlen)
  1436. }
  1437. copy(out, in)
  1438. return
  1439. }
  1440. }
  1441. return in
  1442. }
  1443. // decInferLen will infer a sensible length, given the following:
  1444. // - clen: length wanted.
  1445. // - maxlen: max length to be returned.
  1446. // if <= 0, it is unset, and we infer it based on the unit size
  1447. // - unit: number of bytes for each element of the collection
  1448. func decInferLen(clen, maxlen, unit int) (rvlen int, truncated bool) {
  1449. // handle when maxlen is not set i.e. <= 0
  1450. if clen <= 0 {
  1451. return
  1452. }
  1453. if maxlen <= 0 {
  1454. // no maxlen defined. Use maximum of 256K memory, with a floor of 4K items.
  1455. // maxlen = 256 * 1024 / unit
  1456. // if maxlen < (4 * 1024) {
  1457. // maxlen = 4 * 1024
  1458. // }
  1459. if unit < (256 / 4) {
  1460. maxlen = 256 * 1024 / unit
  1461. } else {
  1462. maxlen = 4 * 1024
  1463. }
  1464. }
  1465. if clen > maxlen {
  1466. rvlen = maxlen
  1467. truncated = true
  1468. } else {
  1469. rvlen = clen
  1470. }
  1471. return
  1472. // if clen <= 0 {
  1473. // rvlen = 0
  1474. // } else if maxlen > 0 && clen > maxlen {
  1475. // rvlen = maxlen
  1476. // truncated = true
  1477. // } else {
  1478. // rvlen = clen
  1479. // }
  1480. // return
  1481. }
  1482. // // implement overall decReader wrapping both, for possible use inline:
  1483. // type decReaderT struct {
  1484. // bytes bool
  1485. // rb *bytesDecReader
  1486. // ri *ioDecReader
  1487. // }
  1488. //
  1489. // // implement *Decoder as a decReader.
  1490. // // Using decReaderT (defined just above) caused performance degradation
  1491. // // possibly because of constant copying the value,
  1492. // // and some value->interface conversion causing allocation.
  1493. // func (d *Decoder) unreadn1() {
  1494. // if d.bytes {
  1495. // d.rb.unreadn1()
  1496. // } else {
  1497. // d.ri.unreadn1()
  1498. // }
  1499. // }
  1500. // ... for other methods of decReader.
  1501. // Testing showed that performance improvement was negligible.