Detect cases where maps in symbol table and btf differ

[Alan-Jowett]

Description

Detect and reject cases where maps are present in the symbol table, but missing from BTF data.

Testing

CI/CD

Documentation

No.

Installation

No.

Summary by CodeRabbit

• Bug Fixes
  • Enhanced error handling to ensure more descriptive messages and safer execution when encountering missing mapping entries.

[coderabbitai]

Walkthrough

The changes update the error handling in the _parse_btf_map_info_and_populate_cache function within the verifier module. The code now uses a safe lookup (via find()) to check if a map name exists before retrieving its index. If the map name is absent, a runtime error is thrown with a descriptive message. This adjustment prevents potential issues from direct index access and undefined behavior.

Changes

File	Change Summary
libs/api/Verifier.cpp	Modified error handling in _parse_btf_map_info_and_populate_cache: replaced direct index retrieval with a safe lookup using find(), throwing a runtime error if missing.

Sequence Diagram(s)

sequenceDiagram
    participant C as Caller
    participant V as _parse_btf_map_info_and_populate_cache
    participant M as btf_map

    C->>V: Call function with map name
    V->>M: Lookup map name using find()
    alt Map name exists
        M-->>V: Return valid index
        V-->>C: Process using the retrieved index
    else Map name not found
        M-->>V: Indicate not found
        V-->>C: Throw runtime error ("Map not found")
    end

Loading

Poem

In the code's forest, I hop with glee,
Finding maps safe as can be.
No more errors in my hop,
With safe retrieval, I never stop.
🐇🥕 Cheers to clear code, just like me!

Happy coding from your bunny friend!

✨ Finishing Touches

• 📝 Generate Docstrings (Beta)

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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. (Beta)
• @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]

Actionable comments posted: 0

🧹 Nitpick comments (1)

libs/api/Verifier.cpp (1)

254-256: Consider standardizing error messages for map not found cases.

For consistency, consider using the same error message format in both _get_map_names and _parse_btf_map_info_and_populate_cache functions when a map is not found. This would make error handling more uniform across the codebase.

Apply this diff to standardize the error message:

-            throw std::runtime_error(string("Map ") + map_name.map_name + " not found.");
+            throw std::runtime_error(string("Map ") + map_name.map_name + " not found in BTF data.");

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 46e4548 and aa0d46e.

📒 Files selected for processing (1)

• libs/api/Verifier.cpp (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (4)

• GitHub Check: sanitize / build (Release)
• GitHub Check: sanitize / build (Debug)
• GitHub Check: analyze / build (Release)
• GitHub Check: analyze / build (Debug)

🔇 Additional comments (1)

libs/api/Verifier.cpp (1)

159-163: LGTM! Safer map lookup with proper error handling.

The changes improve safety by replacing direct map access with a proper lookup using find() and adding explicit error handling when a map is not found. This aligns with the PR objective of detecting inconsistencies between symbol table and BTF data.