Skip to content

Update EXP43-C to use new dataflow. - #1204

Open
MichaelRFairhurst wants to merge 2 commits into
mainfrom
michaelrfairhurst/update-data-flow-exp43-c
Open

MichaelRFairhurst wants to merge 2 commits into
mainfrom
michaelrfairhurst/update-data-flow-exp43-c

Conversation

@MichaelRFairhurst

Copy link
Copy Markdown
Collaborator

Description

Updating to new dataflow introduced test failures in the old test.c file caused by an assignment that aliased the two primary global values under test. Most of the test assumed these were distinct pointer values, and yet, there was one assignment between them, contradicting this intention. The old dataflow library seemed to model this as a function called once, which would produce the results that the test expected. However, the new dataflow seems to assume that the function could be called multiple times, and therefore the fact that these globals were ever aliased means they have flow between them.

Broke the main test function apart into separate functions testing against separate global values, to preserve old test results as much as possible, and cleanly exercise the new justifiable difference in behavior.

Change request type

  • Release or process automation (GitHub workflows, internal scripts)
  • Internal documentation
  • External documentation
  • Query files (.ql, .qll, .qls or unit tests)
  • External scripts (analysis report or other code shipped as part of a release)

Rules with added or modified queries

  • No rules added
  • Queries have been added for the following rules:
    • rule number here
  • Queries have been modified for the following rules:
    • EXP43-C

Release change checklist

A change note (development_handbook.md#change-notes) is required for any pull request which modifies:

  • The structure or layout of the release artifacts.
  • The evaluation performance (memory, execution time) of an existing query.
  • The results of an existing query in any circumstance.

If you are only adding new rule queries, a change note is not required.

Author: Is a change note required?

  • Yes
  • No

🚨🚨🚨
Reviewer: Confirm that format of shared queries (not the .qll file, the
.ql file that imports it) is valid by running them within VS Code.

  • Confirmed

Reviewer: Confirm that either a change note is not required or the change note is required and has been added.

  • Confirmed

Query development review checklist

For PRs that add new queries or modify existing queries, the following checklist should be completed by both the author and reviewer:

Author

  • Have all the relevant rule package description files been checked in?
  • Have you verified that the metadata properties of each new query is set appropriately?
  • Do all the unit tests contain both "COMPLIANT" and "NON_COMPLIANT" cases?
  • Are the alert messages properly formatted and consistent with the style guide?
  • Have you run the queries on OpenPilot and verified that the performance and results are acceptable?
    As a rule of thumb, predicates specific to the query should take no more than 1 minute, and for simple queries be under 10 seconds. If this is not the case, this should be highlighted and agreed in the code review process.
  • Does the query have an appropriate level of in-query comments/documentation?
  • Have you considered/identified possible edge cases?
  • Does the query not reinvent features in the standard library?
  • Can the query be simplified further (not golfed!)

Reviewer

  • Have all the relevant rule package description files been checked in?
  • Have you verified that the metadata properties of each new query is set appropriately?
  • Do all the unit tests contain both "COMPLIANT" and "NON_COMPLIANT" cases?
  • Are the alert messages properly formatted and consistent with the style guide?
  • Have you run the queries on OpenPilot and verified that the performance and results are acceptable?
    As a rule of thumb, predicates specific to the query should take no more than 1 minute, and for simple queries be under 10 seconds. If this is not the case, this should be highlighted and agreed in the code review process.
  • Does the query have an appropriate level of in-query comments/documentation?
  • Have you considered/identified possible edge cases?
  • Does the query not reinvent features in the standard library?
  • Can the query be simplified further (not golfed!)

Updating to new dataflow introduced test failures in the old test.c
file caused by an assignment that aliased the two primary global
values under test. Most of the test assumed these were distinct
pointer values, and yet, there was one assignment between them,
contradicting this intention. The old dataflow library seemed to model
this as a function called once, which would produce the results that
the test expected. However, the new dataflow seems to assume that the
function could be called multiple times, and therefore the fact that
these globals were ever aliased means they have flow between them.

Broke the main test function apart into separate functions testing
against separate global values, to preserve old test results as much
as possible, and cleanly exercise the new justifiable difference in
behavior.
Copilot AI balanced review requested due to automatic review settings October 1, 2026 17:28

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Copilot review overview

🟡 Changes recommended

The migration introduces duplicate alerts for individual violations, and one test explanation reverses the assignment direction.

Review effort: Balanced
Findings: 1 Medium severity · 1 Low severity

Open (2)
What changed in this PR

Migrates EXP43-C to CodeQL’s new dataflow library and updates tests for changed global-flow behavior.

Changes:

  • Replaces the deprecated dataflow import.
  • Separates global-pointer test scenarios and updates expected results.
  • Adds the required change note.
  • Unverified: VS Code shared-query validation and OpenPilot performance.
File Description
change_notes/​2026-10-01-use-new-dataflow-in-exp43-c.md Documents the migration and result changes.
c/​cert/​src/​rules/​EXP43-C/​RestrictPointerReferencesOverlappingObject.ql Uses the new dataflow library.
c/​cert/​test/​rules/​EXP43-C/​test.c Separates global aliasing scenarios.
c/​cert/​test/​rules/​EXP43-C/​RestrictPointerReferencesOverlappingObject.expected Updates expected alerts for new flow behavior.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment on lines +4 to +5
| test.c:49:10:49:11 | g5 | Assignment to restrict-qualified pointer $@ results in pointers aliasing $@. | test.c:45:19:45:20 | i5 | i5 | test.c:41:22:41:23 | g5 | the same source value |
| test.c:49:10:49:11 | g5 | Assignment to restrict-qualified pointer $@ results in pointers aliasing $@. | test.c:45:19:45:20 | i5 | i5 | test.c:47:10:47:11 | g5 | the same source value |
//
// If we assume that `test_global_local_2` is only called once, then `g3` and
// `g4` will likely point to different values and therefore `i1` and `i2` do
// not alias each other. from g3 to g4 is too late to cause an issue. This was
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.

2 participants