decode.go 40 KB

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