Rust: Adjust the taint reach metric for better stability. #19718
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
There was a problem hiding this comment.
Pull Request Overview
This PR refines the taint reach metric by excluding flow summary nodes from both the numerator and denominator, stabilizing the calculation when models change.
- Import
FlowSummaryNodeto identify summary nodes. - Update
getTaintedNodesCountandgetTaintReachto filter out summary nodes and introducegetTotalNodesCount. - Expose the new “total non-summary nodes” statistic in
taintStats.
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| rust/ql/src/queries/summary/TaintReach.qll | Import FlowSummaryNode, filter it out in tainted/total counts. |
| rust/ql/src/queries/summary/Stats.qll | Add new stat key for total non-summary nodes in taintStats. |
Comments suppressed due to low confidence (3)
rust/ql/src/queries/summary/TaintReach.qll:39
- There aren’t any existing tests covering
getTotalNodesCountor the new stat; consider adding or updating tests to validate its behavior and catch regressions.
int getTotalNodesCount() { result = count(DataFlow::Node n | not n instanceof FlowSummaryNode) }
rust/ql/src/queries/summary/Stats.qll:192
- [nitpick] The label "total non-summary nodes" doesn’t exactly match the method name
getTotalNodesCount; consider renaming it to something like "total nodes (excluding summary)" for clarity and consistency.
key = "Taint reach - total non-summary nodes" and value = getTotalNodesCount()
rust/ql/src/queries/summary/Stats.qll:192
- Indentation for this new entry should align with the existing 4-space indent on other
key = ...lines to maintain consistent formatting.
key = "Taint reach - total non-summary nodes" and value = getTotalNodesCount()
hvitved
approved these changes
Jun 11, 2025
|
DCA looks as expected (apart from one spurious build failure) |
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.
Adjust the taint reach metric for better stability.
When models are added the number of flow summary nodes generated often increases, and we've recently found this tends to cause the taint reach metric to wobble (even when the amount of actual flow and regular nodes associated with the database remains constant). We now exclude flow summary nodes from both the numerator and denominator of the taint reach calculation. I have locally verified this makes the taint reach number stable under deletion (and therefore also addition) of irrelevant summary models.
I expect to see [hopefully quite small] wobbles in the taint reach calculation in the DCA run for this change.