decoder.go 23 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947
  1. // Copyright 2019+ Klaus Post. All rights reserved.
  2. // License information can be found in the LICENSE file.
  3. // Based on work by Yann Collet, released under BSD License.
  4. package zstd
  5. import (
  6. "context"
  7. "encoding/binary"
  8. "io"
  9. "sync"
  10. "github.com/klauspost/compress/zstd/internal/xxhash"
  11. )
  12. // Decoder provides decoding of zstandard streams.
  13. // The decoder has been designed to operate without allocations after a warmup.
  14. // This means that you should store the decoder for best performance.
  15. // To re-use a stream decoder, use the Reset(r io.Reader) error to switch to another stream.
  16. // A decoder can safely be re-used even if the previous stream failed.
  17. // To release the resources, you must call the Close() function on a decoder.
  18. type Decoder struct {
  19. o decoderOptions
  20. // Unreferenced decoders, ready for use.
  21. decoders chan *blockDec
  22. // Current read position used for Reader functionality.
  23. current decoderState
  24. // sync stream decoding
  25. syncStream struct {
  26. decodedFrame uint64
  27. br readerWrapper
  28. enabled bool
  29. inFrame bool
  30. dstBuf []byte
  31. }
  32. frame *frameDec
  33. // Custom dictionaries.
  34. dicts map[uint32]*dict
  35. // streamWg is the waitgroup for all streams
  36. streamWg sync.WaitGroup
  37. }
  38. // decoderState is used for maintaining state when the decoder
  39. // is used for streaming.
  40. type decoderState struct {
  41. // current block being written to stream.
  42. decodeOutput
  43. // output in order to be written to stream.
  44. output chan decodeOutput
  45. // cancel remaining output.
  46. cancel context.CancelFunc
  47. // crc of current frame
  48. crc *xxhash.Digest
  49. flushed bool
  50. }
  51. var (
  52. // Check the interfaces we want to support.
  53. _ = io.WriterTo(&Decoder{})
  54. _ = io.Reader(&Decoder{})
  55. )
  56. // NewReader creates a new decoder.
  57. // A nil Reader can be provided in which case Reset can be used to start a decode.
  58. //
  59. // A Decoder can be used in two modes:
  60. //
  61. // 1) As a stream, or
  62. // 2) For stateless decoding using DecodeAll.
  63. //
  64. // Only a single stream can be decoded concurrently, but the same decoder
  65. // can run multiple concurrent stateless decodes. It is even possible to
  66. // use stateless decodes while a stream is being decoded.
  67. //
  68. // The Reset function can be used to initiate a new stream, which will considerably
  69. // reduce the allocations normally caused by NewReader.
  70. func NewReader(r io.Reader, opts ...DOption) (*Decoder, error) {
  71. initPredefined()
  72. var d Decoder
  73. d.o.setDefault()
  74. for _, o := range opts {
  75. err := o(&d.o)
  76. if err != nil {
  77. return nil, err
  78. }
  79. }
  80. d.current.crc = xxhash.New()
  81. d.current.flushed = true
  82. if r == nil {
  83. d.current.err = ErrDecoderNilInput
  84. }
  85. // Transfer option dicts.
  86. d.dicts = make(map[uint32]*dict, len(d.o.dicts))
  87. for _, dc := range d.o.dicts {
  88. d.dicts[dc.id] = dc
  89. }
  90. d.o.dicts = nil
  91. // Create decoders
  92. d.decoders = make(chan *blockDec, d.o.concurrent)
  93. for i := 0; i < d.o.concurrent; i++ {
  94. dec := newBlockDec(d.o.lowMem)
  95. dec.localFrame = newFrameDec(d.o)
  96. d.decoders <- dec
  97. }
  98. if r == nil {
  99. return &d, nil
  100. }
  101. return &d, d.Reset(r)
  102. }
  103. // Read bytes from the decompressed stream into p.
  104. // Returns the number of bytes read and any error that occurred.
  105. // When the stream is done, io.EOF will be returned.
  106. func (d *Decoder) Read(p []byte) (int, error) {
  107. var n int
  108. for {
  109. if len(d.current.b) > 0 {
  110. filled := copy(p, d.current.b)
  111. p = p[filled:]
  112. d.current.b = d.current.b[filled:]
  113. n += filled
  114. }
  115. if len(p) == 0 {
  116. break
  117. }
  118. if len(d.current.b) == 0 {
  119. // We have an error and no more data
  120. if d.current.err != nil {
  121. break
  122. }
  123. if !d.nextBlock(n == 0) {
  124. return n, d.current.err
  125. }
  126. }
  127. }
  128. if len(d.current.b) > 0 {
  129. if debugDecoder {
  130. println("returning", n, "still bytes left:", len(d.current.b))
  131. }
  132. // Only return error at end of block
  133. return n, nil
  134. }
  135. if d.current.err != nil {
  136. d.drainOutput()
  137. }
  138. if debugDecoder {
  139. println("returning", n, d.current.err, len(d.decoders))
  140. }
  141. return n, d.current.err
  142. }
  143. // Reset will reset the decoder the supplied stream after the current has finished processing.
  144. // Note that this functionality cannot be used after Close has been called.
  145. // Reset can be called with a nil reader to release references to the previous reader.
  146. // After being called with a nil reader, no other operations than Reset or DecodeAll or Close
  147. // should be used.
  148. func (d *Decoder) Reset(r io.Reader) error {
  149. if d.current.err == ErrDecoderClosed {
  150. return d.current.err
  151. }
  152. d.drainOutput()
  153. d.syncStream.br.r = nil
  154. if r == nil {
  155. d.current.err = ErrDecoderNilInput
  156. if len(d.current.b) > 0 {
  157. d.current.b = d.current.b[:0]
  158. }
  159. d.current.flushed = true
  160. return nil
  161. }
  162. // If bytes buffer and < 5MB, do sync decoding anyway.
  163. if bb, ok := r.(byter); ok && bb.Len() < d.o.decodeBufsBelow && !d.o.limitToCap {
  164. bb2 := bb
  165. if debugDecoder {
  166. println("*bytes.Buffer detected, doing sync decode, len:", bb.Len())
  167. }
  168. b := bb2.Bytes()
  169. var dst []byte
  170. if cap(d.syncStream.dstBuf) > 0 {
  171. dst = d.syncStream.dstBuf[:0]
  172. }
  173. dst, err := d.DecodeAll(b, dst)
  174. if err == nil {
  175. err = io.EOF
  176. }
  177. // Save output buffer
  178. d.syncStream.dstBuf = dst
  179. d.current.b = dst
  180. d.current.err = err
  181. d.current.flushed = true
  182. if debugDecoder {
  183. println("sync decode to", len(dst), "bytes, err:", err)
  184. }
  185. return nil
  186. }
  187. // Remove current block.
  188. d.stashDecoder()
  189. d.current.decodeOutput = decodeOutput{}
  190. d.current.err = nil
  191. d.current.flushed = false
  192. d.current.d = nil
  193. d.syncStream.dstBuf = nil
  194. // Ensure no-one else is still running...
  195. d.streamWg.Wait()
  196. if d.frame == nil {
  197. d.frame = newFrameDec(d.o)
  198. }
  199. if d.o.concurrent == 1 {
  200. return d.startSyncDecoder(r)
  201. }
  202. d.current.output = make(chan decodeOutput, d.o.concurrent)
  203. ctx, cancel := context.WithCancel(context.Background())
  204. d.current.cancel = cancel
  205. d.streamWg.Add(1)
  206. go d.startStreamDecoder(ctx, r, d.current.output)
  207. return nil
  208. }
  209. // drainOutput will drain the output until errEndOfStream is sent.
  210. func (d *Decoder) drainOutput() {
  211. if d.current.cancel != nil {
  212. if debugDecoder {
  213. println("cancelling current")
  214. }
  215. d.current.cancel()
  216. d.current.cancel = nil
  217. }
  218. if d.current.d != nil {
  219. if debugDecoder {
  220. printf("re-adding current decoder %p, decoders: %d", d.current.d, len(d.decoders))
  221. }
  222. d.decoders <- d.current.d
  223. d.current.d = nil
  224. d.current.b = nil
  225. }
  226. if d.current.output == nil || d.current.flushed {
  227. println("current already flushed")
  228. return
  229. }
  230. for v := range d.current.output {
  231. if v.d != nil {
  232. if debugDecoder {
  233. printf("re-adding decoder %p", v.d)
  234. }
  235. d.decoders <- v.d
  236. }
  237. }
  238. d.current.output = nil
  239. d.current.flushed = true
  240. }
  241. // WriteTo writes data to w until there's no more data to write or when an error occurs.
  242. // The return value n is the number of bytes written.
  243. // Any error encountered during the write is also returned.
  244. func (d *Decoder) WriteTo(w io.Writer) (int64, error) {
  245. var n int64
  246. for {
  247. if len(d.current.b) > 0 {
  248. n2, err2 := w.Write(d.current.b)
  249. n += int64(n2)
  250. if err2 != nil && (d.current.err == nil || d.current.err == io.EOF) {
  251. d.current.err = err2
  252. } else if n2 != len(d.current.b) {
  253. d.current.err = io.ErrShortWrite
  254. }
  255. }
  256. if d.current.err != nil {
  257. break
  258. }
  259. d.nextBlock(true)
  260. }
  261. err := d.current.err
  262. if err != nil {
  263. d.drainOutput()
  264. }
  265. if err == io.EOF {
  266. err = nil
  267. }
  268. return n, err
  269. }
  270. // DecodeAll allows stateless decoding of a blob of bytes.
  271. // Output will be appended to dst, so if the destination size is known
  272. // you can pre-allocate the destination slice to avoid allocations.
  273. // DecodeAll can be used concurrently.
  274. // The Decoder concurrency limits will be respected.
  275. func (d *Decoder) DecodeAll(input, dst []byte) ([]byte, error) {
  276. if d.decoders == nil {
  277. return dst, ErrDecoderClosed
  278. }
  279. // Grab a block decoder and frame decoder.
  280. block := <-d.decoders
  281. frame := block.localFrame
  282. initialSize := len(dst)
  283. defer func() {
  284. if debugDecoder {
  285. printf("re-adding decoder: %p", block)
  286. }
  287. frame.rawInput = nil
  288. frame.bBuf = nil
  289. if frame.history.decoders.br != nil {
  290. frame.history.decoders.br.in = nil
  291. frame.history.decoders.br.cursor = 0
  292. }
  293. d.decoders <- block
  294. }()
  295. frame.bBuf = input
  296. for {
  297. frame.history.reset()
  298. err := frame.reset(&frame.bBuf)
  299. if err != nil {
  300. if err == io.EOF {
  301. if debugDecoder {
  302. println("frame reset return EOF")
  303. }
  304. return dst, nil
  305. }
  306. return dst, err
  307. }
  308. if err = d.setDict(frame); err != nil {
  309. return nil, err
  310. }
  311. if frame.WindowSize > d.o.maxWindowSize {
  312. if debugDecoder {
  313. println("window size exceeded:", frame.WindowSize, ">", d.o.maxWindowSize)
  314. }
  315. return dst, ErrWindowSizeExceeded
  316. }
  317. if frame.FrameContentSize != fcsUnknown {
  318. if frame.FrameContentSize > d.o.maxDecodedSize-uint64(len(dst)-initialSize) {
  319. if debugDecoder {
  320. println("decoder size exceeded; fcs:", frame.FrameContentSize, "> mcs:", d.o.maxDecodedSize-uint64(len(dst)-initialSize), "len:", len(dst))
  321. }
  322. return dst, ErrDecoderSizeExceeded
  323. }
  324. if d.o.limitToCap && frame.FrameContentSize > uint64(cap(dst)-len(dst)) {
  325. if debugDecoder {
  326. println("decoder size exceeded; fcs:", frame.FrameContentSize, "> (cap-len)", cap(dst)-len(dst))
  327. }
  328. return dst, ErrDecoderSizeExceeded
  329. }
  330. if cap(dst)-len(dst) < int(frame.FrameContentSize) {
  331. dst2 := make([]byte, len(dst), len(dst)+int(frame.FrameContentSize)+compressedBlockOverAlloc)
  332. copy(dst2, dst)
  333. dst = dst2
  334. }
  335. }
  336. if cap(dst) == 0 && !d.o.limitToCap {
  337. // Allocate len(input) * 2 by default if nothing is provided
  338. // and we didn't get frame content size.
  339. size := min(
  340. // Cap to 1 MB.
  341. len(input)*2, 1<<20)
  342. if uint64(size) > d.o.maxDecodedSize {
  343. size = int(d.o.maxDecodedSize)
  344. }
  345. dst = make([]byte, 0, size)
  346. }
  347. dst, err = frame.runDecoder(dst, block)
  348. if err != nil {
  349. return dst, err
  350. }
  351. if uint64(len(dst)-initialSize) > d.o.maxDecodedSize {
  352. return dst, ErrDecoderSizeExceeded
  353. }
  354. if len(frame.bBuf) == 0 {
  355. if debugDecoder {
  356. println("frame dbuf empty")
  357. }
  358. break
  359. }
  360. }
  361. return dst, nil
  362. }
  363. // nextBlock returns the next block.
  364. // If an error occurs d.err will be set.
  365. // Optionally the function can block for new output.
  366. // If non-blocking mode is used the returned boolean will be false
  367. // if no data was available without blocking.
  368. func (d *Decoder) nextBlock(blocking bool) (ok bool) {
  369. if d.current.err != nil {
  370. // Keep error state.
  371. return false
  372. }
  373. d.current.b = d.current.b[:0]
  374. // SYNC:
  375. if d.syncStream.enabled {
  376. if !blocking {
  377. return false
  378. }
  379. ok = d.nextBlockSync()
  380. if !ok {
  381. d.stashDecoder()
  382. }
  383. return ok
  384. }
  385. //ASYNC:
  386. d.stashDecoder()
  387. if blocking {
  388. d.current.decodeOutput, ok = <-d.current.output
  389. } else {
  390. select {
  391. case d.current.decodeOutput, ok = <-d.current.output:
  392. default:
  393. return false
  394. }
  395. }
  396. if !ok {
  397. // This should not happen, so signal error state...
  398. d.current.err = io.ErrUnexpectedEOF
  399. return false
  400. }
  401. next := d.current.decodeOutput
  402. if next.d != nil && next.d.async.newHist != nil {
  403. d.current.crc.Reset()
  404. }
  405. if debugDecoder {
  406. var tmp [4]byte
  407. binary.LittleEndian.PutUint32(tmp[:], uint32(xxhash.Sum64(next.b)))
  408. println("got", len(d.current.b), "bytes, error:", d.current.err, "data crc:", tmp)
  409. }
  410. if d.o.ignoreChecksum {
  411. return true
  412. }
  413. if len(next.b) > 0 {
  414. d.current.crc.Write(next.b)
  415. }
  416. if next.err == nil && next.d != nil && next.d.hasCRC {
  417. got := uint32(d.current.crc.Sum64())
  418. if got != next.d.checkCRC {
  419. if debugDecoder {
  420. printf("CRC Check Failed: %08x (got) != %08x (on stream)\n", got, next.d.checkCRC)
  421. }
  422. d.current.err = ErrCRCMismatch
  423. } else {
  424. if debugDecoder {
  425. printf("CRC ok %08x\n", got)
  426. }
  427. }
  428. }
  429. return true
  430. }
  431. func (d *Decoder) nextBlockSync() (ok bool) {
  432. if d.current.d == nil {
  433. d.current.d = <-d.decoders
  434. }
  435. for len(d.current.b) == 0 {
  436. if !d.syncStream.inFrame {
  437. d.frame.history.reset()
  438. d.current.err = d.frame.reset(&d.syncStream.br)
  439. if d.current.err == nil {
  440. d.current.err = d.setDict(d.frame)
  441. }
  442. if d.current.err != nil {
  443. return false
  444. }
  445. if d.frame.WindowSize > d.o.maxDecodedSize || d.frame.WindowSize > d.o.maxWindowSize {
  446. d.current.err = ErrDecoderSizeExceeded
  447. return false
  448. }
  449. d.syncStream.decodedFrame = 0
  450. d.syncStream.inFrame = true
  451. }
  452. d.current.err = d.frame.next(d.current.d)
  453. if d.current.err != nil {
  454. return false
  455. }
  456. d.frame.history.ensureBlock()
  457. if debugDecoder {
  458. println("History trimmed:", len(d.frame.history.b), "decoded already:", d.syncStream.decodedFrame)
  459. }
  460. histBefore := len(d.frame.history.b)
  461. d.current.err = d.current.d.decodeBuf(&d.frame.history)
  462. if d.current.err != nil {
  463. println("error after:", d.current.err)
  464. return false
  465. }
  466. d.current.b = d.frame.history.b[histBefore:]
  467. if debugDecoder {
  468. println("history after:", len(d.frame.history.b))
  469. }
  470. // Check frame size (before CRC)
  471. d.syncStream.decodedFrame += uint64(len(d.current.b))
  472. if d.syncStream.decodedFrame > d.frame.FrameContentSize {
  473. if debugDecoder {
  474. printf("DecodedFrame (%d) > FrameContentSize (%d)\n", d.syncStream.decodedFrame, d.frame.FrameContentSize)
  475. }
  476. d.current.err = ErrFrameSizeExceeded
  477. return false
  478. }
  479. // Check FCS
  480. if d.current.d.Last && d.frame.FrameContentSize != fcsUnknown && d.syncStream.decodedFrame != d.frame.FrameContentSize {
  481. if debugDecoder {
  482. printf("DecodedFrame (%d) != FrameContentSize (%d)\n", d.syncStream.decodedFrame, d.frame.FrameContentSize)
  483. }
  484. d.current.err = ErrFrameSizeMismatch
  485. return false
  486. }
  487. // Update/Check CRC
  488. if d.frame.HasCheckSum {
  489. if !d.o.ignoreChecksum {
  490. d.frame.crc.Write(d.current.b)
  491. }
  492. if d.current.d.Last {
  493. if !d.o.ignoreChecksum {
  494. d.current.err = d.frame.checkCRC()
  495. } else {
  496. d.current.err = d.frame.consumeCRC()
  497. }
  498. if d.current.err != nil {
  499. println("CRC error:", d.current.err)
  500. return false
  501. }
  502. }
  503. }
  504. d.syncStream.inFrame = !d.current.d.Last
  505. }
  506. return true
  507. }
  508. func (d *Decoder) stashDecoder() {
  509. if d.current.d != nil {
  510. if debugDecoder {
  511. printf("re-adding current decoder %p", d.current.d)
  512. }
  513. d.decoders <- d.current.d
  514. d.current.d = nil
  515. }
  516. }
  517. // Close will release all resources.
  518. // It is NOT possible to reuse the decoder after this.
  519. func (d *Decoder) Close() {
  520. if d.current.err == ErrDecoderClosed {
  521. return
  522. }
  523. d.drainOutput()
  524. if d.current.cancel != nil {
  525. d.current.cancel()
  526. d.streamWg.Wait()
  527. d.current.cancel = nil
  528. }
  529. if d.decoders != nil {
  530. close(d.decoders)
  531. for dec := range d.decoders {
  532. dec.Close()
  533. }
  534. d.decoders = nil
  535. }
  536. if d.current.d != nil {
  537. d.current.d.Close()
  538. d.current.d = nil
  539. }
  540. d.current.err = ErrDecoderClosed
  541. }
  542. // IOReadCloser returns the decoder as an io.ReadCloser for convenience.
  543. // Any changes to the decoder will be reflected, so the returned ReadCloser
  544. // can be reused along with the decoder.
  545. // io.WriterTo is also supported by the returned ReadCloser.
  546. func (d *Decoder) IOReadCloser() io.ReadCloser {
  547. return closeWrapper{d: d}
  548. }
  549. // closeWrapper wraps a function call as a closer.
  550. type closeWrapper struct {
  551. d *Decoder
  552. }
  553. // WriteTo forwards WriteTo calls to the decoder.
  554. func (c closeWrapper) WriteTo(w io.Writer) (n int64, err error) {
  555. return c.d.WriteTo(w)
  556. }
  557. // Read forwards read calls to the decoder.
  558. func (c closeWrapper) Read(p []byte) (n int, err error) {
  559. return c.d.Read(p)
  560. }
  561. // Close closes the decoder.
  562. func (c closeWrapper) Close() error {
  563. c.d.Close()
  564. return nil
  565. }
  566. type decodeOutput struct {
  567. d *blockDec
  568. b []byte
  569. err error
  570. }
  571. func (d *Decoder) startSyncDecoder(r io.Reader) error {
  572. d.frame.history.reset()
  573. d.syncStream.br = readerWrapper{r: r}
  574. d.syncStream.inFrame = false
  575. d.syncStream.enabled = true
  576. d.syncStream.decodedFrame = 0
  577. return nil
  578. }
  579. // Create Decoder:
  580. // ASYNC:
  581. // Spawn 3 go routines.
  582. // 0: Read frames and decode block literals.
  583. // 1: Decode sequences.
  584. // 2: Execute sequences, send to output.
  585. func (d *Decoder) startStreamDecoder(ctx context.Context, r io.Reader, output chan decodeOutput) {
  586. defer d.streamWg.Done()
  587. br := readerWrapper{r: r}
  588. var seqDecode = make(chan *blockDec, d.o.concurrent)
  589. var seqExecute = make(chan *blockDec, d.o.concurrent)
  590. // Async 1: Decode sequences...
  591. go func() {
  592. var hist history
  593. var hasErr bool
  594. for block := range seqDecode {
  595. if hasErr {
  596. if block != nil {
  597. seqExecute <- block
  598. }
  599. continue
  600. }
  601. if block.async.newHist != nil {
  602. if debugDecoder {
  603. println("Async 1: new history, recent:", block.async.newHist.recentOffsets)
  604. }
  605. hist.reset()
  606. hist.decoders = block.async.newHist.decoders
  607. hist.recentOffsets = block.async.newHist.recentOffsets
  608. hist.windowSize = block.async.newHist.windowSize
  609. if block.async.newHist.dict != nil {
  610. hist.setDict(block.async.newHist.dict)
  611. }
  612. }
  613. if block.err != nil || block.Type != blockTypeCompressed {
  614. hasErr = block.err != nil
  615. seqExecute <- block
  616. continue
  617. }
  618. hist.decoders.literals = block.async.literals
  619. block.err = block.prepareSequences(block.async.seqData, &hist)
  620. if debugDecoder && block.err != nil {
  621. println("prepareSequences returned:", block.err)
  622. }
  623. hasErr = block.err != nil
  624. if block.err == nil {
  625. block.err = block.decodeSequences(&hist)
  626. if debugDecoder && block.err != nil {
  627. println("decodeSequences returned:", block.err)
  628. }
  629. hasErr = block.err != nil
  630. // block.async.sequence = hist.decoders.seq[:hist.decoders.nSeqs]
  631. block.async.seqSize = hist.decoders.seqSize
  632. }
  633. seqExecute <- block
  634. }
  635. close(seqExecute)
  636. hist.reset()
  637. }()
  638. var wg sync.WaitGroup
  639. wg.Add(1)
  640. // Async 3: Execute sequences...
  641. frameHistCache := d.frame.history.b
  642. go func() {
  643. var hist history
  644. var decodedFrame uint64
  645. var fcs uint64
  646. var hasErr bool
  647. for block := range seqExecute {
  648. out := decodeOutput{err: block.err, d: block}
  649. if block.err != nil || hasErr {
  650. hasErr = true
  651. output <- out
  652. continue
  653. }
  654. if block.async.newHist != nil {
  655. if debugDecoder {
  656. println("Async 2: new history")
  657. }
  658. hist.reset()
  659. hist.windowSize = block.async.newHist.windowSize
  660. hist.allocFrameBuffer = block.async.newHist.allocFrameBuffer
  661. if block.async.newHist.dict != nil {
  662. hist.setDict(block.async.newHist.dict)
  663. }
  664. if cap(hist.b) < hist.allocFrameBuffer {
  665. if cap(frameHistCache) >= hist.allocFrameBuffer {
  666. hist.b = frameHistCache
  667. } else {
  668. hist.b = make([]byte, 0, hist.allocFrameBuffer)
  669. println("Alloc history sized", hist.allocFrameBuffer)
  670. }
  671. }
  672. hist.b = hist.b[:0]
  673. fcs = block.async.fcs
  674. decodedFrame = 0
  675. }
  676. do := decodeOutput{err: block.err, d: block}
  677. switch block.Type {
  678. case blockTypeRLE:
  679. if debugDecoder {
  680. println("add rle block length:", block.RLESize)
  681. }
  682. if cap(block.dst) < int(block.RLESize) {
  683. if block.lowMem {
  684. block.dst = make([]byte, block.RLESize)
  685. } else {
  686. block.dst = make([]byte, maxCompressedBlockSize)
  687. }
  688. }
  689. block.dst = block.dst[:block.RLESize]
  690. v := block.data[0]
  691. for i := range block.dst {
  692. block.dst[i] = v
  693. }
  694. hist.append(block.dst)
  695. do.b = block.dst
  696. case blockTypeRaw:
  697. if debugDecoder {
  698. println("add raw block length:", len(block.data))
  699. }
  700. hist.append(block.data)
  701. do.b = block.data
  702. case blockTypeCompressed:
  703. if debugDecoder {
  704. println("execute with history length:", len(hist.b), "window:", hist.windowSize)
  705. }
  706. hist.decoders.seqSize = block.async.seqSize
  707. hist.decoders.literals = block.async.literals
  708. do.err = block.executeSequences(&hist)
  709. hasErr = do.err != nil
  710. if debugDecoder && hasErr {
  711. println("executeSequences returned:", do.err)
  712. }
  713. do.b = block.dst
  714. }
  715. if !hasErr {
  716. decodedFrame += uint64(len(do.b))
  717. if decodedFrame > fcs {
  718. println("fcs exceeded", block.Last, fcs, decodedFrame)
  719. do.err = ErrFrameSizeExceeded
  720. hasErr = true
  721. } else if block.Last && fcs != fcsUnknown && decodedFrame != fcs {
  722. do.err = ErrFrameSizeMismatch
  723. hasErr = true
  724. } else {
  725. if debugDecoder {
  726. println("fcs ok", block.Last, fcs, decodedFrame)
  727. }
  728. }
  729. }
  730. output <- do
  731. }
  732. close(output)
  733. frameHistCache = hist.b
  734. wg.Done()
  735. if debugDecoder {
  736. println("decoder goroutines finished")
  737. }
  738. hist.reset()
  739. }()
  740. var hist history
  741. decodeStream:
  742. for {
  743. var hasErr bool
  744. hist.reset()
  745. decodeBlock := func(block *blockDec) {
  746. if hasErr {
  747. if block != nil {
  748. seqDecode <- block
  749. }
  750. return
  751. }
  752. if block.err != nil || block.Type != blockTypeCompressed {
  753. hasErr = block.err != nil
  754. seqDecode <- block
  755. return
  756. }
  757. remain, err := block.decodeLiterals(block.data, &hist)
  758. block.err = err
  759. hasErr = block.err != nil
  760. if err == nil {
  761. block.async.literals = hist.decoders.literals
  762. block.async.seqData = remain
  763. } else if debugDecoder {
  764. println("decodeLiterals error:", err)
  765. }
  766. seqDecode <- block
  767. }
  768. frame := d.frame
  769. if debugDecoder {
  770. println("New frame...")
  771. }
  772. var historySent bool
  773. frame.history.reset()
  774. err := frame.reset(&br)
  775. if debugDecoder && err != nil {
  776. println("Frame decoder returned", err)
  777. }
  778. if err == nil {
  779. err = d.setDict(frame)
  780. }
  781. if err == nil && d.frame.WindowSize > d.o.maxWindowSize {
  782. if debugDecoder {
  783. println("decoder size exceeded, fws:", d.frame.WindowSize, "> mws:", d.o.maxWindowSize)
  784. }
  785. err = ErrDecoderSizeExceeded
  786. }
  787. if err != nil {
  788. select {
  789. case <-ctx.Done():
  790. case dec := <-d.decoders:
  791. dec.sendErr(err)
  792. decodeBlock(dec)
  793. }
  794. break decodeStream
  795. }
  796. // Go through all blocks of the frame.
  797. for {
  798. var dec *blockDec
  799. select {
  800. case <-ctx.Done():
  801. break decodeStream
  802. case dec = <-d.decoders:
  803. // Once we have a decoder, we MUST return it.
  804. }
  805. err := frame.next(dec)
  806. if !historySent {
  807. h := frame.history
  808. if debugDecoder {
  809. println("Alloc History:", h.allocFrameBuffer)
  810. }
  811. hist.reset()
  812. if h.dict != nil {
  813. hist.setDict(h.dict)
  814. }
  815. dec.async.newHist = &h
  816. dec.async.fcs = frame.FrameContentSize
  817. historySent = true
  818. } else {
  819. dec.async.newHist = nil
  820. }
  821. if debugDecoder && err != nil {
  822. println("next block returned error:", err)
  823. }
  824. dec.err = err
  825. dec.hasCRC = false
  826. if dec.Last && frame.HasCheckSum && err == nil {
  827. crc, err := frame.rawInput.readSmall(4)
  828. if len(crc) < 4 {
  829. if err == nil {
  830. err = io.ErrUnexpectedEOF
  831. }
  832. println("CRC missing?", err)
  833. dec.err = err
  834. } else {
  835. dec.checkCRC = binary.LittleEndian.Uint32(crc)
  836. dec.hasCRC = true
  837. if debugDecoder {
  838. printf("found crc to check: %08x\n", dec.checkCRC)
  839. }
  840. }
  841. }
  842. err = dec.err
  843. last := dec.Last
  844. decodeBlock(dec)
  845. if err != nil {
  846. break decodeStream
  847. }
  848. if last {
  849. break
  850. }
  851. }
  852. }
  853. close(seqDecode)
  854. wg.Wait()
  855. hist.reset()
  856. d.frame.history.b = frameHistCache
  857. }
  858. func (d *Decoder) setDict(frame *frameDec) (err error) {
  859. dict, ok := d.dicts[frame.DictionaryID]
  860. if ok {
  861. if debugDecoder {
  862. println("setting dict", frame.DictionaryID)
  863. }
  864. frame.history.setDict(dict)
  865. } else if frame.DictionaryID != 0 {
  866. // A zero or missing dictionary id is ambiguous:
  867. // either dictionary zero, or no dictionary. In particular,
  868. // zstd --patch-from uses this id for the source file,
  869. // so only return an error if the dictionary id is not zero.
  870. err = ErrUnknownDictionary
  871. }
  872. return err
  873. }