Repository navigation
Conversation
Signed-off-by: Willis Wu <willis060510@gmail.com>
lihuiba
reviewed
Oct 3, 2026
| See the License for the specific language governing permissions and | ||
| limitations under the License. | ||
| */ | ||
| #pragma once |
Contributor
There was a problem hiding this comment.
merge this file into zfile.cpp
| } | ||
|
|
||
| // Shared by the whole-file writer and both streaming builders. | ||
| static int write_index(IFile *file, const std::vector<uint32_t> &lengths, |
Contributor
There was a problem hiding this comment.
why static? why not let it be a member of ZFileBuilderBase?
| pht->opt.use_dict); | ||
|
|
||
| if (index_bytes > trailer_offset - pht->index_offset) | ||
| LOG_ERROR_RETURN(0, false, "invalid index bytes or size. "); |
Contributor
There was a problem hiding this comment.
is it necessary to change so much here?
Contributor
There was a problem hiding this comment.
Copilot review overview
🔵 Needs a closer look
An unresolved out-of-bounds read needs correction, and historical format compatibility still requires human review.
Review effort: Balanced
Findings: 1
What changed in this PR
Adds opt-in ZFile index compression while preserving raw indexes by default.
Changes:
- Adds LZ4/ZSTD index compression shared by all writers.
- Exposes API and CLI options.
- Strengthens validation and adds round-trip and malformed-input tests.
| File | Description |
|---|---|
| src/tools/overlaybd-zfile.cpp | Adds --compress-index. |
| src/overlaybd/zfile/zfile.cpp | Integrates index compression and validation. |
| src/overlaybd/zfile/test/test.cpp | Tests writers, codecs, and invalid inputs. |
| src/overlaybd/zfile/index_compression.h | Implements index codec helpers. |
| src/overlaybd/zfile/format_spec.md | Documents compressed-index storage and compatibility. |
| src/overlaybd/zfile/compressor.h | Adds the opt-in API setting. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Signed-off-by: Willis Wu <willis060510@gmail.com>
lihuiba
reviewed
Oct 12, 2026
|
|
||
| // Whole-index codecs use CPU routines: data-block/QAT buffer limits do not apply. | ||
| // Return 1 for compressed output, 0 to keep the original, or -1 on codec error. | ||
| static int compress_index_buffer(const void *src, size_t size, uint8_t algo, |
Contributor
There was a problem hiding this comment.
make it a member of ZFileBuilderBase.
| } | ||
|
|
||
| // A successful decode must restore exactly the expected index byte count. | ||
| static int decompress_index_buffer(const void *src, size_t size, void *dst, |
Contributor
There was a problem hiding this comment.
make it a member of ZFileBuilderBase.
Signed-off-by: Willis Wu <willis060510@gmail.com>
lihuiba
reviewed
Oct 19, 2026
| } | ||
|
|
||
| // Check before buffering or queueing data, not after the index has already grown. | ||
| static int check_input_size(uint64_t current_size, size_t count, uint32_t block_size) { |
Contributor
There was a problem hiding this comment.
put it into ZFileBuilderBase, not necessarily static.
| virtual int fini() = 0; | ||
| // Whole-index codecs use CPU routines: data-block/QAT buffer limits do not apply. | ||
| // Return 1 for compressed output, 0 to keep the original, or -1 on codec error. | ||
| static int compress_index_buffer(const void *src, size_t size, uint8_t algo, |
| } | ||
|
|
||
| // A successful decode must restore exactly the expected index byte count. | ||
| static int decompress_index_buffer(const void *src, size_t size, void *dst, |
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
ZFile already compresses data blocks, but stores the block-length index uncompressed. This PR adds optional index compression using the existing format’s flag bit 5.
Changes:
CompressArgs::compress_indexand the--compress-indexCLI flag, disabled by default.Format choices:
index_sizeremains the entry count.Existing raw indexes remain supported. Older readers cannot read compressed indexes, so compression remains opt-in. I have not compared these format choices with the historical ease implementation.
Validation:
zfile_testsuite: all 12 tests passed.git diff --checkpassed.