Skip to content

Compute the "safe" distance properly#1801

Merged
Dead2 merged 1 commit intozlib-ng:developfrom
KungFuJesus:fix_safe_calc
Oct 8, 2024
Merged

Compute the "safe" distance properly#1801
Dead2 merged 1 commit intozlib-ng:developfrom
KungFuJesus:fix_safe_calc

Conversation

@KungFuJesus
Copy link
Copy Markdown
Collaborator

@KungFuJesus KungFuJesus commented Oct 3, 2024 •
edited by coderabbitai bot
Loading

The safe pointer that is computed is an exclusive, not inclusive bounds. While we were probably rarely ever bit this, if ever, it still makes sense to apply the limit, properly.

Summary by CodeRabbit

  • Bug Fixes

    • Adjusted memory operation parameters for improved performance in the decompression process.

  • Documentation

    • Maintained existing comments and documentation for clarity on function purpose and behavior.

@KungFuJesus
Compute the "safe" distance properly
f80a8bf 
The safe pointer that is computed is an exclusive, not inclusive bounds.
While we were probably rarely ever bit this, if ever, it still makes
sense to apply the limit, properly.
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Oct 3, 2024 •
edited
Loading

Walkthrough

The changes involve modifications to the inflate_fast function in the inffast.c file, specifically regarding memory operation handling. The adjustment involves removing an unnecessary + 1 from the parameters passed to the CHUNKMEMSET_SAFE function, which impacts how the function calculates the number of bytes to be set during memory operations. The overall structure, logic, and documentation of the function remain unchanged, ensuring that the decompression process's fundamental functionality is preserved.

Changes

File Change Summary
inffast.c Modified inflate_fast function to remove + 1 from the third parameter of CHUNKMEMSET_SAFE, affecting memory operation calculations. Comments and documentation remain unchanged.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant InflateFast
    participant ChunkMemSetSafe

    User->>InflateFast: Call inflate_fast()
    InflateFast->>ChunkMemSetSafe: Call CHUNKMEMSET_SAFE(params)
    ChunkMemSetSafe-->>InflateFast: Memory operation complete
    InflateFast-->>User: Return to user
Loading

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ 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 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.

coderabbitai[bot]
coderabbitai bot reviewed Oct 3, 2024
View reviewed changes
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 8d10c30 and f80a8bf.

📒 Files selected for processing (1)
  • inffast_tpl.h (1 hunks)
🔇 Additional comments (1)
inffast_tpl.h (1)

263-263: Approve: Correct adjustment for exclusive bounds

This change aligns with the PR objective of computing the 'safe' distance properly. By removing the + 1, the CHUNKMEMSET_SAFE function now uses exclusive bounds instead of inclusive ones. This subtle but crucial adjustment enhances the safety of memory operations by preventing potential buffer overruns.

The modification is correct and improves the overall robustness of the decompression algorithm.

Dead2
Dead2 approved these changes Oct 7, 2024
View reviewed changes
Copy link
Copy Markdown
Member

@Dead2 Dead2 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@Dead2 Dead2 merged commit 3297953 into zlib-ng:develop Oct 8, 2024
This was referenced Oct 8, 2024
Merged
Merged
Merged
Merged
@coderabbitai coderabbitai bot mentioned this pull request Nov 3, 2024
Draft
This was referenced Nov 27, 2024
Merged
Closed
Merged
@Dead2 Dead2 mentioned this pull request Dec 31, 2024
Merged
@coderabbitai coderabbitai bot mentioned this pull request Jan 26, 2025
Merged
@coderabbitai coderabbitai bot mentioned this pull request Mar 10, 2026
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

@Dead2 Dead2 Dead2 approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@KungFuJesus @Dead2