Skip to content

Fix perofmance RULE-6-4-2 RULE-7-0-4#1119

Open
mbaluda wants to merge 6 commits intomainfrom
mbaluda/perf_inappropriate-bitwise-or-shift-operands
Open

Fix perofmance RULE-6-4-2 RULE-7-0-4#1119
mbaluda wants to merge 6 commits intomainfrom
mbaluda/perf_inappropriate-bitwise-or-shift-operands

Conversation

@mbaluda
Copy link
Copy Markdown
Collaborator

@mbaluda mbaluda commented Apr 25, 2026

Description

This pull request introduces a new predicate to help validate constant ranges for shift operations in the InappropriateBitwiseOrShiftOperands.ql rule. The main change is the addition of the isValidShiftConstantRange predicate, which checks the range of constant values used in shift expressions.

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:
    • RULE-6-4-2
    • RULE-7-0-4

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

Copilot AI review requested due to automatic review settings April 25, 2026 13:57
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Updates the MISRA C++ RULE-7-0-4 CodeQL query to improve evaluation performance by guiding CodeQL’s optimizer for shift-constant range checking.

Changes:

  • Added bindingset[right, leftType] for isValidShiftConstantRange.
  • Added pragma[inline_late] to encourage late inlining of isValidShiftConstantRange.
Show a summary per file
File Description
cpp/misra/src/rules/RULE-7-0-4/InappropriateBitwiseOrShiftOperands.ql Adds optimizer hints to the constant-shift-range predicate to improve query performance.

Copilot's findings

  • Files reviewed: 1/1 changed files
  • Comments generated: 2

Comment thread cpp/misra/src/rules/RULE-7-0-4/InappropriateBitwiseOrShiftOperands.ql Outdated
@mbaluda mbaluda changed the title Fix perofmance inappropriate-bitwise-or-shift-operands Fix perofmance RULE-6-4-2 RULE-7-0-4 Apr 25, 2026
mbaluda added 2 commits April 25, 2026 16:55
Enhanced performance of the 'isValidShiftConstantRange' predicate by adding annotations for optimization.
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Copilot's findings

  • Files reviewed: 3/3 changed files
  • Comments generated: 1

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Copilot's findings

Comments suppressed due to low confidence (2)

change_notes/2026-04-25-fix-performance-inappropriate-bitwise-or-shift-operands.md:5

  • Change notes typically use past tense for bullet items. Please change "Remove false positives..." to "Removed false positives...".
  - Remove false positives related to the `insertion operator`.

cpp/common/src/codingstandards/cpp/rules/hiddeninheritedoverridablememberfunction/HiddenInheritedOverridableMemberFunction.qll:31

  • The PR description focuses on the RULE-7-0-4 shift-range predicate, but this PR also changes the shared hidden-inherited-member-function library used by RULE-6-4-2 (and A7-3-1). Please update the PR description to mention this additional functional area so reviewers understand the full scope of the change.
query predicate problems(
  OverridingDeclaration overridingDecl, string message, HiddenDeclaration hiddenDecl,
  string hiddenDecl_string
) {
  • Files reviewed: 3/3 changed files
  • Comments generated: 3

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.

3 participants