Rust: turn off macro expansion in code to be expanded by attribute macros #19572
Conversation
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
added 5 commits
May 23, 2025 12:00
There was a problem hiding this comment.
Pull Request Overview
This PR updates the Rust extractor and QL query for CWE-696 to stop expanding inner macros when under attribute macros, and adjusts templates and tests to match the new behavior.
- Enhance
edgesFwdto follow attribute macro expansions (with fallback) and refine alert messages. - Track
macro_context_depthin the extractor and wrap AST emissions withpre_emit/post_emitto suppress nested expansions. - Update codegen templates and revise integration and query-test expectations to align spans and annotations.
Reviewed Changes
Copilot reviewed 10 out of 10 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| rust/ql/src/queries/security/CWE-696/BadCtorInitialization.ql | Handle attribute-macro expansions in edgesFwd and update the alert text |
| rust/extractor/src/translate/base.rs | Introduce macro_context_depth, setup_item_expansion, and skip nested macro-call emissions |
| rust/ast-generator/templates/extractor.mustache | Replace emit_detached with pre_emit/post_emit hooks around node emissions |
| rust/ql/test/query-tests/security/CWE-696/test.rs | Adjust test annotations (Source/Alert) for ctor initialization cases |
| rust/ql/test/query-tests/security/CWE-696/BadCTorInitialization.expected | Update expected error spans and messages for ctor initialization tests |
| rust/ql/integration-tests/macro-expansion/src/lib.rs | Add function body and nested #[repeat] call to test nested macro expansion |
| rust/ql/integration-tests/macro-expansion/test.expected | Revise integration-test spans for expanded macros |
| rust/ql/integration-tests/macro-expansion/summary.qlref | Add summary query for reduced macro-expansion statistics |
| rust/ql/integration-tests/macro-expansion/summary.expected | Introduce expected macro-expansion summary stats |
Comments suppressed due to low confidence (2)
rust/ql/test/query-tests/security/CWE-696/test.rs:168
- The annotation on the
#[ctor]forbad4_1was changed to an Alert marker, and the corresponding Alert on the macro call was removed. To keep the test harness consistent, the attribute line should be// $ Source=source4_1and the call line should have// $ Alert[rust/ctor-initialization]=source4_1.
#[ctor] // $ Alert[rust/ctor-initialization]
rust/ql/integration-tests/macro-expansion/test.expected:4
- [nitpick] This mapping for
fn inner→fn inner_0at0is repeated multiple times. Consolidate duplicate entries to one line per mapping for clarity.
| src/lib.rs:7:5:8:16 | fn inner | 0 | src/lib.rs:8:5:8:16 | fn inner_0 |
redsun82
commented
May 23, 2025
|
This looks pretty good on the experiment prior to the merge from main (with the library extraction merge). @aibaars I think we can review this, I'll restart another DCA to see how this interacts with the library extraction work. |
|
Looks good to me. Let's not forget to remove codeql/rust/extractor/src/translate/base.rs Lines 737 to 740 in a749cf9 Done in #19588 |
aibaars
approved these changes
May 26, 2025
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.
This commits were separated from #19314
The QL part was already reviewed in the context of that PR.