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.

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

Truncate values when storing to stack based on width #844

Merged
merged 2 commits into from
Mar 4, 2025

Conversation

Alan-Jowett
Copy link
Contributor

@Alan-Jowett Alan-Jowett commented Mar 3, 2025

Resolves: #841

When storing values on the stack with width != 8, it is neccessary to truncate the value to the width of the stack variables.

Summary by CodeRabbit

Summary by CodeRabbit

  • New Features

    • Simplified overflow detection process for numeric values, improving the accuracy of interval checks.
  • Tests

    • Added new test cases for verifying the handling of minimum integer values and their truncation to 8-bit and 32-bit representations.

Copy link

coderabbitai bot commented Mar 3, 2025

Walkthrough

The changes modify the overflow_bounds, overflow_signed, and overflow_unsigned functions in ebpf_transformer.cpp by simplifying the overflow_bounds interface and updating related function calls. The do_store_stack function is enhanced to include validation checks for stack storage results. In the test suite, two lines assigning values to a stack segment are removed, and three new test cases are added to validate round-trip integer storage with truncation for various bit widths.

Changes

File Change Summary
src/crab/...ebpf_transformer.cpp Updated overflow_bounds to remove number_t span parameter; modified calls in overflow_signed and overflow_unsigned. Enhanced do_store_stack with validation checks.
test-data/...stack.yaml Removed assignments of r1 values to stack segment; added three new test cases for round-trip integer storage with full, 8-bit, and 32-bit truncation.

Possibly related PRs

✨ Finishing Touches
  • 📝 Generate Docstrings

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

Copy link

@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: 2

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 880008a and 04ccc3c.

📒 Files selected for processing (2)
  • src/crab/ebpf_transformer.cpp (2 hunks)
  • test-data/stack.yaml (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (9)
  • GitHub Check: build_windows (Release, library)
  • GitHub Check: build_windows (Release, tests)
  • GitHub Check: build_ubuntu (Release, tests)
  • GitHub Check: build_windows (Debug, library)
  • GitHub Check: build_windows (Debug, tests)
  • GitHub Check: build_ubuntu (Debug, tests)
  • GitHub Check: build_ubuntu (Release)
  • GitHub Check: build_ubuntu (Debug)
  • GitHub Check: Analyze (cpp)
🔇 Additional comments (5)
test-data/stack.yaml (3)

593-594: New test section added correctly.

The YAML structure follows proper indentation and uses the same formatting as the rest of the test file.


596-615: Good test case for verifying 64-bit round trip storage.

This test correctly validates that a min int (-2147483648) can be stored and retrieved from the stack with proper value preservation.


637-655: Verify expected behavior with 32-bit truncation.

This test correctly verifies that a min int (-2147483648) truncated to 32 bits results in 2147483648 as both signed and unsigned values when retrieved.

src/crab/ebpf_transformer.cpp (2)

982-987: Added 16-bit and 8-bit support for overflow handling.

The code now properly handles 16-bit and 8-bit finite widths in the overflow_signed function by using appropriate span values from std::numeric_limits.


991-996: Added 16-bit and 8-bit support for unsigned overflow handling.

Similar to the signed case, the overflow_unsigned function now supports 16-bit and 8-bit widths properly.

@coveralls
Copy link

coveralls commented Mar 3, 2025

Coverage Status

coverage: 88.176% (+0.04%) from 88.133%
when pulling afe0f86 on Alan-Jowett:issue841
into 880008a on vbpf:main.

Copy link
Collaborator

@elazarg elazarg left a comment

Choose a reason for hiding this comment

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

LGTM, but can be refactored.

Signed-off-by: Alan Jowett <[email protected]>
Copy link

@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: 2

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 04ccc3c and afe0f86.

📒 Files selected for processing (1)
  • src/crab/ebpf_transformer.cpp (3 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (10)
  • GitHub Check: build_windows (Release, library)
  • GitHub Check: build_windows (Release, tests)
  • GitHub Check: build_ubuntu (Release, tests)
  • GitHub Check: build_windows (Debug, library)
  • GitHub Check: build_windows (Debug, tests)
  • GitHub Check: build_ubuntu (Debug, library)
  • GitHub Check: build_ubuntu (Debug, tests)
  • GitHub Check: build_ubuntu (Release)
  • GitHub Check: build_ubuntu (Debug)
  • GitHub Check: Analyze (cpp)
🔇 Additional comments (2)
src/crab/ebpf_transformer.cpp (2)

982-984: Updated overflow_signed to use the simplified interface.

Function call updated to match the new signature, removing the unnecessary span calculation.


986-988: Updated overflow_unsigned to use the simplified interface.

Function call updated to match the new signature, removing the unnecessary span calculation.

@elazarg elazarg merged commit 4712a25 into vbpf:main Mar 4, 2025
19 checks passed
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.

When storing to the stack verifier fails to truncate values
3 participants