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 literals decoding #1430

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

modules/zstd: Add literals decoding #1430

wants to merge 26 commits into from

Conversation

rw1nkler
Copy link
Contributor

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

In the beginning, we will focus on implementing the entire RAW and RLE literals decoding path.
Support for literals that use Huffman coding will be added later.

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

rw1nkler and others added 25 commits May 16, 2024 15:09
@rw1nkler @lpawelcz
modules/zstd: Add buffer library
17baf76 
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 <rwinkler@antmicro.com>
@rw1nkler @lpawelcz
modules/zstd: Add Buffer use-case example
63d63e9 
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 <rwinkler@antmicro.com>
@rw1nkler @lpawelcz
modules/zstd: Add library for parsing magic number
c44b5d1 
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 <rwinkler@antmicro.com>
@rw1nkler @rdob-ant @lpawelcz
modules/zstd: Add library for parsing frame header
8a41680 
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 <rdobrodii@antmicro.com>
Co-authored-by: Pawel Czarnecki <pczarnecki@antmicro.com>
Signed-off-by: Robert Winkler <rwinkler@antmicro.com>
Signed-off-by: Pawel Czarnecki <pczarnecki@antmicro.com>
@lpawelcz
dependency_support/libzstd: Make zstd_errors.h public
611912e 
Required for expected_status inference in C++ tests for ZSTD decoder
components

Internal-tag: [#53465]
Signed-off-by: Pawel Czarnecki <pczarnecki@antmicro.com>
@rw1nkler @lpawelcz
dependency_support: Add decodecorpus binary
434deae 
Internal-tag: [#50967]
Signed-off-by: Robert Winkler <rwinkler@antmicro.com>
@rw1nkler @lpawelcz
modules/zstd: Add data generator library
87314ea 
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 <rwinkler@antmicro.com>
@rw1nkler @lpawelcz
modules/zstd: Add zstd frame header tests
81c8aab 
Internal-tag: [#50967]
Co-authored-by: Pawel Czarnecki <pczarnecki@antmicro.com>
Signed-off-by: Robert Winkler <rwinkler@antmicro.com>
Signed-off-by: Pawel Czarnecki <pczarnecki@antmicro.com>
@rw1nkler @lpawelcz
modules/zstd: Add common zstd definitions
098762e 
Internal-tag: [#51343]
Signed-off-by: Robert Winkler <rwinkler@antmicro.com>
@rw1nkler @lpawelcz
modules/zstd: Add raw block decoder
18f498c 
Internal-tag: [#51343]
Signed-off-by: Robert Winkler <rwinkler@antmicro.com>
@lpawelcz
modules/zstd: Add rle block decoder
d31ecb6 
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 <pczarnecki@antmicro.com>
@rw1nkler @lpawelcz
modules/zstd: Add block header parsing library
5af9376 
Internal-tag: [#51343]
Signed-off-by: Robert Winkler <rwinkler@antmicro.com>
@lpawelcz
modules/zstd: Add SequenceExecutorPacket to common definitions
3c63b05 
Signed-off-by: Pawel Czarnecki <pczarnecki@antmicro.com>
@rw1nkler @lpawelcz
modules/zstd: Add block data muxer library
c1b657e 
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 <rwinkler@antmicro.com>
@mtdudek @rw1nkler @lpawelcz
modules/zstd: Add block demuxer library
6c53600 
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 <rwinkler@antmicro.com>
Signed-off-by: Maciej Dudek <mdudek@antmicro.com>
@lpawelcz
modules/zstd: Add block decoder module
7bfcd31 
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 <pczarnecki@antmicro.com>
@lpawelcz
xls/moduels/common: Specify decoder output format
a083037 
Internal-tag: [#52954]
Signed-off-by: Pawel Czarnecki <pczarnecki@antmicro.com>
@rw1nkler @lpawelcz
examples/ram: Export internal RAM API to other modules
8d6dd22 
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 <rwinkler@antmicro.com>
@rw1nkler @lpawelcz
modules/zstd: Add Offset type to common zstd definitions
9d691be 
Internal-tag: [#54705]
Signed-off-by: Robert Winkler <rwinkler@antmicro.com>
@rw1nkler @lpawelcz
modules/zstd: Add RamPrinter Proc
d07433f 
This commit adds RAM printer block usefull for debugging
HistoryBuffer inside SequenceExecutor.

Internal-tag: [#54705]
Signed-off-by: Robert Winkler <rwinkler@antmicro.com>
@rw1nkler @lpawelcz
modules/zstd: Add SequenceExecutor Proc
d90bc17 
Add Proc responsible for handling ZSTD Sequence Execution step,
which is described in:
https://datatracker.ietf.org/doc/html/rfc8878#name-sequence-execution

Internal-tag: [#54705]
Signed-off-by: Robert Winkler <rwinkler@antmicro.com>
@lpawelcz
xls/modules/zstd: Add repacketizer
46dbc63 
Internal-tag: [#52954]
Signed-off-by: Pawel Czarnecki <pczarnecki@antmicro.com>
@m-torhan @rw1nkler
modules/zstd: Add literals dispatcher
64c37f4 
Signed-off-by: Maciej Torhan <mtorhan@antmicro.com>
@m-torhan @rw1nkler
modules/zstd: Add RLE literals decoder implementation
ccc946e 
Signed-off-by: Maciej Torhan <mtorhan@antmicro.com>
@RRozak @rw1nkler
modules/zstd: Add RawLiteralsDecoder
3c28899 
Internal-tag: [#56124]
Signed-off-by: Ryszard Rozak <rrozak@antmicro.com>
@google-cla Google CLA
Copy link

google-cla bot commented May 24, 2024

Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

View this failed invocation of the CLA check for more information.

For the most up to date status, view the checks section at the bottom of the pull request.

@m-torhan
modules/zstd: Add LiteralsBuffer proc, add literals synchronization
b5a9985 
Signed-off-by: Maciej Torhan <mtorhan@antmicro.com>
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.

None yet
5 participants
@rw1nkler @lpawelcz @mtdudek @m-torhan @RRozak