Project: ArangoDB (App Definition and Development / Database)
File: lz4_Block_format.md

LZ4 Block Format Description ============================ Last revised: 2019-03-30. Author : Yann Collet This specification is intended for developers willing to produce LZ4-compatible compressed data blocks using any programming language. LZ4 is an LZ77-type compressor with a fixed, byte-oriented encoding. There is no entropy encoder back-end nor framing layer. The latter is assumed to be handled by other parts of the system (see [LZ4 Frame format]). This design is assumed to favor simplicity and speed. It helps later on for optimizations, compactness, and features. This document describes only the block format, not how the compressor nor decompressor actually work. The correctness of the decompressor should not depend on implementation details of the compressor, and vice versa. Compressed block format -- An LZ4 compressed block is composed of sequences. A sequence is a suite of literals (not-compressed bytes), followed by a match copy. Each sequence starts with a `token`. The `token` is a one byte value, separated into two 4-bits fields. Therefore each field ranges from 0 to 15. The first field uses the 4 high-bits of the token. It provides the length of literals to follow. If the field value is 0, then there is no literal. If it is 15, then we need to add some more bytes to indicate the full length. Each additional byte then represent a value from 0 to 255, which is added to the previous value to produce a total length. When the byte value is 255, another byte is output. There can be any number of bytes following `token`. There is no "size limit". (Side note : this is why a not-compressible input block is expanded by 0.4%). Example 1 : A literal length of 48 will be represented as : 15 : value for the 4-bits High field 33 : (=48-15) remaining length to reach 48 Example 2 : A literal length of 280 will be represented as : 15 : value for the 4-bits High field 255 : following byte is maxed, since 280-15 >= 255 10 : (=280 - 15 - 255) ) remaining length to reach 280 Example 3 : A literal length of 15 will be represented as : 15 : value for the 4-bits High field 0 : (=15-15) yes, the zero must be output Following `token` and optional length bytes, are the literals themselves. They are exactly as numerous as previously decoded (length of literals). It's possible that there are zero literal. Following the literals is the match copy operation. It starts by the `offset`. This is a 2 bytes value, in little endian format (the 1st byte is the "low" byte, the 2nd one is the "high" byte). The `offset` represents the position of the match to be copied from. 1 means "current position - 1 byte". The maximum `offset` value is 65535, 65536 cannot be coded. Note that 0 is an invalid value, not used. Then we need to extract the `matchlength`. For this, we use the second token field, the low 4-bits. Value, obviously, ranges from 0 to 15. However here, 0 means that the copy operation will be minimal. The minimum length of a match, called `minmatch`, is

As a consequence, a 0 value means 4 bytes, and a value of 15 means 19+ bytes. Similar to literal length, on reaching the highest possible value (15), we output additional bytes, one at a time, with values ranging from 0 to 255. They are added to total to provide the final match length. A 255 value means there is another byte to read and add. There is no limit to the number of optional bytes that can be output this way. (This points towards a maximum achievable compression ratio of about 250). Decoding the `matchlength` reaches the end of current sequence. Next byte will be the start of another sequence. But before moving to next sequence, it's time to use the decoded match position and length. The decoder copies `matchlength` bytes from match position to current position. In some cases, `matchlength` is larger than `offset`. Therefore, `matchpos + matchlength > currentpos`, which means that later bytes to copy are not yet decoded. This is called an "overlap match", and must be handled with special care. A common case is an offset of 1, meaning the last byte is repeated `matchlength` times. End of block restrictions -- There are specific rules required to terminate a block. The last sequence contains only literals. The block ends right after them. The last 5 bytes of input are always literals. Therefore, the last sequence contains at least 5 bytes. Special : if input is smaller than 5 bytes, there is only one sequence, it contains the whole input as literals. Empty input can be represented with a zero byte, interpreted as a final token without literal and without a match. The last match must start at least 12 bytes before the end of block. The last match is part of the penultimate sequence. It is followed by the last sequence, which contains only literals. Note that, as a consequence, an independent block < 13 bytes cannot be compressed, because the match must copy "something", so it needs at least one prior byte. When a block can reference data from another block, it can start immediately with a match and no literal, so a block of 12 bytes can be compressed. When a block does not respect these end conditions, a conformant decoder is allowed to reject the block as incorrect. These rules are in place to ensure that a conformant decoder can be designed for speed, issuing speculatively instructions, while never reading nor writing beyond provided I/O buffers. Additional notes -- If the decoder will decompress data from an external source, it is recommended to ensure that the decoder will not be vulnerable to buffer overflow manipulations. Always ensure that read and write operations remain within the limits of provided buffers. Test the decoder with fuzzers to ensure it's resilient to improbable combinations. The format makes no assumption nor limits to the way the compressor searches and selects matches within the source data block. Multiple techniques can be considered, featuring distinct time / performance trade offs. As long as the format is respected, the result will be compatible and decodable by any compliant decoder. An upper compression limit can be reached, using a technique called "full optimal parsing", at high cpu cost.