Skip to content

Implement MISRA C:2025 Rule 8.18 - #1224

Open
mbaluda wants to merge 2 commits into
misra-c-2025-developmentfrom
misra-c-2025-rule-8-18
Open

mbaluda wants to merge 2 commits into
misra-c-2025-developmentfrom
misra-c-2025-rule-8-18

Conversation

@mbaluda

@mbaluda mbaluda commented Nov 18, 2026 •

Copy link
Copy Markdown
Collaborator

Description

Implement MISRA C:2025 Rule 8.18 by reporting tentative file-scope definitions in headers.
The query and relative tests cover extern and initialized declarations, static objects, redeclarations, macros, and source-file and local controls.

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:
    • MISRA C:2025 Rule 8.18
  • Queries have been modified for the following rules:
    • None

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!)

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot AI adaptive review requested due to automatic review settings November 18, 2026 19:01
@mbaluda
mbaluda changed the base branch from misra-c-2025-development to main November 18, 2026 19:03
@mbaluda
mbaluda changed the base branch from main to misra-c-2025-development November 18, 2026 19:04
@mbaluda
mbaluda changed the base branch from misra-c-2025-development to main November 18, 2026 19:04

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.

🟡 Changes recommended

Initializer matching relies on source locations and argument order, which can suppress tentative definitions across translation units and falsely flag compliant macro-based initialized declarations.

2 open issues
What changed in this PR

Adds MISRA C:2025 Rule 8.18 detection for tentative file-scope definitions in headers, building on the edition infrastructure from #1216.

Changes:

  • Adds the query, rule metadata, exclusion registration, and implementation status.
  • Adds fixtures covering declarations, initializers, macros, redeclarations, and translation-unit differences.
  • Extends release-tool testing to exclude the new rule from older editions.
File Description
scripts/​release/​create_supported_rules_list_test.py Checks that Rule 8.18 does not appear in older editions.
rules-misra-c-2025.csv Marks Rule 8.18 as implemented.
rule_packages/​c/​Declarations5.json Defines query metadata and implementation scope.
cpp/​common/​src/​codingstandards/​cpp/​exclusions/​c/​Declarations5.qll Registers the query for exclusions.
c/​misra/​test/​rules/​RULE-8-18/​test.c Adds source-file and local-variable controls.
c/​misra/​test/​rules/​RULE-8-18/​sample.h Covers header declarations, redeclarations, and macros.
c/​misra/​test/​rules/​RULE-8-18/​other.c Provides cross-translation-unit test cases.
c/​misra/​test/​rules/​RULE-8-18/​DefinitionsInHeader.qlref Connects fixtures to the production query.
c/​misra/​test/​rules/​RULE-8-18/​DefinitionsInHeader.expected Records expected alerts.
c/​misra/​test/​rules/​RULE-8-18/​conditional.h Tests conditionally initialized declarations.
c/​misra/​src/​rules/​RULE-8-18/​DefinitionsInHeader.ql Implements tentative-definition detection in included files.

Review effort: Balanced (adaptive)

this.isDefinition() and
initializer = this.getVariable().getInitializer() and
(
initializer.getLocation().subsumes(this.getLocation())
initializer.getLocation().subsumes(this.getLocation())
or
// Initializers follow their own declarators, not definitions in other translation units.
this.getLocation().isBefore(initializer.getLocation(), _) and
@mbaluda
mbaluda changed the base branch from main to misra-c-2025-development November 18, 2026 22:00
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