Skip to content

zstd: Fix incorrect buffer size in dictionary encodes #1059

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.

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

Merged
merged 1 commit into from
Mar 13, 2025

Conversation

klauspost
Copy link
Owner

@klauspost klauspost commented Mar 12, 2025

Fix incorrect dLongTableShardSize leading to inefficient zeroing of

Also make shards 128 bytes to reduce memory use somewhat.

Summary by CodeRabbit

  • Chores
    • Optimized internal compression settings to improve dictionary management.
    • Revised shard calculation methods to potentially enhance memory utilization and processing efficiency.

Fix incorrect dLongTableShardSize leading to inefficient zeroing of

Also make shards 128 bytes to reduce memory use somewhat.
Copy link

coderabbitai bot commented Mar 12, 2025

📝 Walkthrough

Walkthrough

The pull request modifies constants in the ZSTD encoder module to adjust dictionary sharding and long table shard size calculations. In zstd/enc_base.go, the constant dictShardBits is increased from 6 to 7, which may affect the number of dictionary shards during encoding. In zstd/enc_dfast.go, the formula for computing dLongTableShardSize is updated by replacing the divisor tableShardCnt with dLongTableShardCnt (derived from bit constants), altering how shard sizes are determined.

Changes

File(s) Change Summary
zstd/enc_base.go Updated constant dictShardBits from 6 to 7, impacting dictionary sharding during encoding.
zstd/enc_dfast.go Modified calculation of dLongTableShardSize by replacing tableShardCnt with dLongTableShardCnt (computed as 1 << (dFastLongTableBits - dictShardBits)).

Tip

⚡🧪 Multi-step agentic review comment chat (experimental)
  • We're introducing multi-step agentic chat in review comments. This experimental feature enhances review discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments.
    - To enable this feature, set early_access to true under in the settings.

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 517288e and 387aaca.

📒 Files selected for processing (2)
  • zstd/enc_base.go (1 hunks)
  • zstd/enc_dfast.go (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (17)
  • GitHub Check: Analyze (go)
  • GitHub Check: build (1.23.x, macos-latest)
  • GitHub Check: build (1.23.x, ubuntu-latest)
  • GitHub Check: fuzz-s2 (nounsafe)
  • GitHub Check: build (1.24.x, ubuntu-latest)
  • GitHub Check: build (1.24.x, macos-latest)
  • GitHub Check: build (1.23.x, windows-latest)
  • GitHub Check: build (1.24.x, windows-latest)
  • GitHub Check: fuzz-s2 ("noasm,nounsafe")
  • GitHub Check: build (1.22.x, windows-latest)
  • GitHub Check: build (1.22.x, macos-latest)
  • GitHub Check: build (1.22.x, ubuntu-latest)
  • GitHub Check: build-special
  • GitHub Check: fuzz-other ("noasm,nounsafe")
  • GitHub Check: fuzz-zstd ("noasm,nounsafe")
  • GitHub Check: fuzz-other (nounsafe)
  • GitHub Check: fuzz-zstd (nounsafe)
🔇 Additional comments (2)
zstd/enc_base.go (1)

11-11: Logical change to increase dictionary shard bits

Increasing dictShardBits from 6 to 7 doubles the number of dictionary shards (from 64 to 128), which should result in more efficient dictionary encoding by providing smaller individual shards.

zstd/enc_dfast.go (1)

16-16: Fixing the incorrect buffer size calculation

This change correctly updates the formula to use dLongTableShardCnt instead of tableShardCnt for calculating dLongTableShardSize. Since dLongTableShardCnt is directly derived from dictShardBits (which was increased in the other file), this ensures that the shard size calculation is properly aligned with the dictionary sharding strategy.

This fix addresses the issue mentioned in the PR description about incorrect buffer size in dictionary encodes, which would lead to inefficient zeroing processes. Using the correct divisor ensures that operations on lines 1114-1115 (copying specific shards between tables) will work correctly with properly sized memory chunks.

✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@klauspost
Copy link
Owner Author

Reported by @cfif1982 - fuzz testing before merge.

@klauspost
Copy link
Owner Author

fuzz: elapsed: 18h39m23s, execs: 905973345 (31266/sec), new interesting: 21 (total: 7898)

Seems stable. Merging.

@klauspost klauspost merged commit 29a7d27 into master Mar 13, 2025
22 checks passed
@klauspost klauspost deleted the zstd-dict-buffer branch March 13, 2025 18:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant