Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

modules/zstd: Add sequence decoding #1362

Draft
wants to merge 53 commits into
base: main
Choose a base branch
from
Draft

modules/zstd: Add sequence decoding #1362

wants to merge 53 commits into from

Conversation

rw1nkler
Copy link
Contributor

@rw1nkler rw1nkler commented Mar 28, 2024 •
edited
Loading

This PR is meant to provide a proc implementing sequence section decoding as described in:
https://datatracker.ietf.org/doc/html/rfc8878#section-3.1.1.3.2

NOTE: this is based on #1214, please ignore commits from that branch when reviewing.

@rw1nkler rw1nkler force-pushed the 55149-fse branch 2 times, most recently from f2a9d34 to c8465a5 Compare March 29, 2024 15:31
@proppy
Copy link
Member

proppy commented Apr 3, 2024

is it independent from #1315 or should they be reviewed together?

@rw1nkler rw1nkler force-pushed the 55149-fse branch 2 times, most recently from f30c47b to 6c3b033 Compare April 4, 2024 14:09
@rw1nkler
Copy link
Contributor Author

rw1nkler commented Apr 4, 2024

is it independent from #1315 or should they be reviewed together?

We agreed that this should be reviewed as an independent PR after merging #1315

@rw1nkler rw1nkler changed the title modules/zstd: Add FSE decoding modules/zstd: Add sequence decoding May 24, 2024
rw1nkler and others added 20 commits July 24, 2024 14:58
@rw1nkler @mtdudek
modules/zstd: Add buffer library
bccd3d3 
This commit adds a DSLX Buffer library that provides the Buffer struct,
and helper functions that can be used to operate on it. The Buffer
is meant to be a storage for data coming from the channel. It acts like
a FIFO, allowing data of any length to be put in or popped out of it.
Provided DSLX tests verify the correct behaviour of the library.

Internal-tag: [#50221]
Signed-off-by: Robert Winkler <[email protected]>
@rw1nkler @mtdudek
modules/zstd: Add Buffer use-case example
04bf3e8 
This commit adds a simple test that shows, how one can use the Buffer
struct inside a Proc.

Internal-tag: [#50221]
Signed-off-by: Robert Winkler <[email protected]>
@rw1nkler @mtdudek
modules/zstd: Add library for parsing magic number
a43fa9c 
This commit adds the library with functions for parsing a magic number and
tests that verify its correctness.

Internal-tag: [#50221]
Signed-off-by: Robert Winkler <[email protected]>
@rw1nkler @rdob-ant
@lpawelcz @mtdudek
modules/zstd: Add library for parsing frame header
d3048bf 
This commit adds the library with functions for parsing a frame header.
The provided tests verify the correcness of the library.

Internal-tag: [#49967]
Co-authored-by: Roman Dobrodii <[email protected]>
Co-authored-by: Pawel Czarnecki <[email protected]>
Signed-off-by: Robert Winkler <[email protected]>
Signed-off-by: Pawel Czarnecki <[email protected]>
@lpawelcz @mtdudek
dependency_support/libzstd: Make zstd_errors.h public
86de6a7 
Required for expected_status inference in C++ tests for ZSTD decoder
components

Internal-tag: [#53465]
Signed-off-by: Pawel Czarnecki <[email protected]>
@rw1nkler @mtdudek
dependency_support: Add decodecorpus binary
3208de7 
Internal-tag: [#50967]
Signed-off-by: Robert Winkler <[email protected]>
@rw1nkler @mtdudek
modules/zstd: Add data generator library
9375be5 
This commit adds a binary that calls decoding to generate data and loads
it into a vector of bytes.

Internal-tag: [#50967]
Signed-off-by: Robert Winkler <[email protected]>
@rw1nkler @lpawelcz @mtdudek
modules/zstd: Add zstd frame header tests
c65b32c 
Internal-tag: [#50967]
Co-authored-by: Pawel Czarnecki <[email protected]>
Signed-off-by: Robert Winkler <[email protected]>
Signed-off-by: Pawel Czarnecki <[email protected]>
@rw1nkler @mtdudek
modules/zstd: Add common zstd definitions
236d96e 
Internal-tag: [#51343]
Signed-off-by: Robert Winkler <[email protected]>
@rw1nkler @mtdudek
modules/zstd: Add raw block decoder
4fecaca 
Internal-tag: [#51343]
Signed-off-by: Robert Winkler <[email protected]>
@lpawelcz @mtdudek
modules/zstd: Add rle block decoder
6f2d89b 
Adds RleBlockDecoder responsible for decoding Blocks
of RLE_Block Block_Type as specified in RFC 8878, paragraph 3.1.1.2.2.
https://datatracker.ietf.org/doc/html/rfc8878#section-3.1.1.2.2

RleBlockDecoder communicates through BlockDataPacket channels.
It reuses existing RunLengthDecoder block which is interfaced through
two seprate procs:

 * RleDataPacker
 * BatchPacker

Which are responsible for converting input data into format accepted by
RLE decoder and for gathering RLE decoder output symbols into batches
which are then send out through BlockDataPacket.

Internal-tag: [#51473]
Signed-off-by: Pawel Czarnecki <[email protected]>
@rw1nkler @mtdudek
modules/zstd: Add block header parsing library
4bd9c40 
Internal-tag: [#51343]
Signed-off-by: Robert Winkler <[email protected]>
@lpawelcz @mtdudek
modules/zstd: Add SequenceExecutorPacket to common definitions
3de695e 
Signed-off-by: Pawel Czarnecki <[email protected]>
@rw1nkler @mtdudek
modules/zstd: Add block data muxer library
1c525a6 
This commit adds DecoderMux Proc, which collects data from specialized
Raw, RLE, and Compressed Block decoders and re-sends them in the correct order.

Internal-tag: [#51343]
Signed-off-by: Robert Winkler <[email protected]>
@mtdudek @rw1nkler
modules/zstd: Add block demuxer library
27573e2 
This DSLX proc responsibility is to dispatch encoded blocks to a correct
decoder: RAW, RLE, COMPRESSED.

It tracks and assigns block IDs.
The ID counter is reset on the frame's last block on the last data packet.

Internal-tag: [#51736]
Co-authored-by: Robert Winkler <[email protected]>
Signed-off-by: Maciej Dudek <[email protected]>
@lpawelcz @mtdudek
modules/zstd: Add block decoder module
323214e 
This adds a decoder of block data. It decodes block header and
demuxes remaining input data into one of specific block decoders
depending on the type of the parsed block. Then it muxes outputs
from those decoders into single output channel.

Internal-tag: [#51873]
Signed-off-by: Pawel Czarnecki <[email protected]>
@lpawelcz @mtdudek
modules/zstd/common: Specify decoder output format
4f19952 
Internal-tag: [#52954]
Signed-off-by: Pawel Czarnecki <[email protected]>
@rw1nkler @mtdudek
examples/ram: Export internal RAM API to other modules
410d78c 
This commit marks SimultaneousReadWriteBehavior enum and
num_partitions function as public to allow for creating
simpler tests that interact with RAM models.

Internal-tag: [#53241]
Signed-off-by: Robert Winkler <[email protected]>
@rw1nkler @mtdudek
modules/zstd: Add Offset type to common zstd definitions
0b613d2 
Internal-tag: [#54705]
Signed-off-by: Robert Winkler <[email protected]>
@rw1nkler @mtdudek
modules/zstd: Add RamPrinter Proc
0ca18c4 
This commit adds RAM printer block usefull for debugging
HistoryBuffer inside SequenceExecutor.

Internal-tag: [#54705]
Signed-off-by: Robert Winkler <[email protected]>
lpawelcz and others added 28 commits July 24, 2024 15:29
@lpawelcz @mtdudek
CI: Add custom ZSTD module workflow
ab5fb05 
Internal-tag: [#52186]
Signed-off-by: Pawel Czarnecki <[email protected]>
@lpawelcz @mtdudek
[FIXUP] Update copyrights notice and add missing license header
495353d 
Internal-tag: [#52186]
Signed-off-by: Pawel Czarnecki <[email protected]>
@lpawelcz @mtdudek
[FIXUP] Update README
593e40c 
Internal-tag: [#52186]
Signed-off-by: Pawel Czarnecki <[email protected]>
@lpawelcz @mtdudek
[FIXUP] Add manual tags to test rules
dc6cb3c 
Internal-tag: [#52186]
Signed-off-by: Pawel Czarnecki <[email protected]>
@lpawelcz @mtdudek
[FIXUP] restore original main CI workflow
d7463ba 
Internal-tag: [#52186]
Signed-off-by: Pawel Czarnecki <[email protected]>
@lpawelcz @mtdudek
[FIXUP] Explicitly run test targets in ZSTD CI workflow
b46ee8c 
Internal-tag: [#52186]
Signed-off-by: Pawel Czarnecki <[email protected]>
@lpawelcz @mtdudek
[FIXUP] document the usage of libzstd dependency
9ddd7ce 
Internal-tag: [#52186]
Signed-off-by: Pawel Czarnecki <[email protected]>
@lpawelcz @mtdudek
[FIXUP] return reference to the data vector
9483420 
Internal-tag: [#52186]
Signed-off-by: Pawel Czarnecki <[email protected]>
@lpawelcz @mtdudek
[FIXUP] fix RLE block handling in decodecorpus
a16c27a 
Internal-tag: [#52186]
Signed-off-by: Pawel Czarnecki <[email protected]>
@lpawelcz @mtdudek
[FIXUP] fix generating data when we don't force the block type
8c350b5 
Internal-tag: [#52186]
Signed-off-by: Pawel Czarnecki <[email protected]>
@lpawelcz @mtdudek
modules/zstd/frame_header_test: Reproduce bugs
5c5011c 
Internal-tag: [#60906]
Signed-off-by: Pawel Czarnecki <[email protected]>
@lpawelcz @mtdudek
[FIXUP] return expect empty buffer on the unsupported windows size error
cc33b0b 
Internal-tag: [#60906]
Signed-off-by: Pawel Czarnecki <[email protected]>
@lpawelcz @mtdudek
[FIXUP] Handle special case of difference between libzstd and ZSTD de…
2aef289 
…coder

Internal-tag: [#60906]
Signed-off-by: Pawel Czarnecki <[email protected]>
@lpawelcz @mtdudek
[FIXUP] Add DSLX test case for unsupported FCS
14fe3f0 
Internal-tag: [#60906]
Signed-off-by: Pawel Czarnecki <[email protected]>
@lpawelcz @mtdudek
[FIXUP] fix max_window_size calculation types
e3804ff 
Internal-tag: [#52186]
Signed-off-by: Pawel Czarnecki <[email protected]>
@lpawelcz @mtdudek
[FIXUP] dependencies cleanup
cdeff69 
Signed-off-by: Pawel Czarnecki <[email protected]>
@lpawelcz @mtdudek
[FIXUP] shorten test case names in frame_header tests
210e322 
Signed-off-by: Pawel Czarnecki <[email protected]>
@mtdudek
[FIXUP] Update to zstd-top
ba7eda4 
Signed-off-by: Maciej Dudek <[email protected]>
@rw1nkler @m-torhan
modules/zstd: Add buffer implementing desired API
f758928 
Add a buffering proc that implements the desired API of the final buffering mechanism.
A more efficient implementation will be provided later.

Internal-tag: [#55149]
Signed-off-by: Robert Winkler <[email protected]>
@rw1nkler @m-torhan
modules/zstd: Add common FSE definitions
934ef92 
Internal-tag: [#57353]
Signed-off-by: Robert Winkler <[email protected]>
@rw1nkler @m-torhan
modules/zstd: Add a proc handling RAM write completion
1fc12f1 
Internal-tag: [#57353]
Signed-off-by: Robert Winkler <[email protected]>
@rw1nkler @m-torhan
modules/zstd: Add FSE probability frequency decoder
aab399d 
Internal-tag: [#57353]
Signed-off-by: Robert Winkler <[email protected]>
@rw1nkler @m-torhan
modules/zstd: Add proc for generating symbol order for FSE lookup
807275b 
Internal-tag: [#57353]
Signed-off-by: Robert Winkler <[email protected]>
@RRozak @m-torhan
modules/zstd: Add CommandConstructor proc
4935945 
Internal-tag: [#58422]
Signed-off-by: Ryszard Rozak <[email protected]>
@rw1nkler @RRozak @m-torhan
modules/zstd: Add Ram demux
4b23a24 
Internal-tag: [#58557]
Co-authored-by: Ryszard Rozak <[email protected]>
Co-authored-by: Maciej Torhan <[email protected]>
Signed-off-by: Robert Winkler <[email protected]>
@RRozak @m-torhan
modules/zstd: Add FSE table creator
c15b8d4 
Internal-tag: [#57353]
Signed-off-by: Robert Winkler <[email protected]>
@m-torhan
modules/zstd: Update FSE branch
7c0d935 
Signed-off-by: Maciej Torhan <[email protected]>
@m-torhan
modules/zstd: Add FseDecoder implementation
9b273b2 
Signed-off-by: Maciej Torhan <[email protected]>
@proppy
Copy link
Member

proppy commented Aug 19, 2024

should this be rebased now that #1315 has been merged?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@rw1nkler @proppy @lpawelcz @mtdudek @RRozak @m-torhan