Rule 20.12: Improve performance

[lcartey]

Description

This commit optimizes the from-where-select clause of this query, which was highlighted as one of the slowest predicates for our C query suites.

This commit makes the following changes:

• Avoid repetition of m.getParameter(i), which caused a cross product
• Change the way we identify "further expanded macro"
• Modify the isExcluded predicate to reference the macro invocation not the macro.

@rvermeulen I think you wrote this rule originally, so I would appreciate a review. In particular, the change from

  exists(Macro furtherExpandedMacro |
    mi.getUnexpandedArgument(i).matches(furtherExpandedMacro.getName() + "%")
  )

to

not mi.getUnexpandedArgument(i) = mi.getExpandedArgument(i)

Achieves what you originally intended.

@mbaluda @jsinglet this addresses one of the slowest performing predicates that was highlighted in #226, although the slow performance is not related to the upgrade itself.

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 20.12

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

[github-actions]

🤖 Beep Boop! Matrix Testing for this PR has been initiated. Please check back later for results.

💡 If you do not hear back from me please check my status! I will report even if this PR does not contain files eligible for matrix testing.

[jsinglet]

🤖 Beep Boop! gcc/c/x86_64 Matrix Testing for this PR has been completed. See below for the results!

PACKAGE              : Preprocessor2
TEST_PASS            : True
SUITE                : MISRA-C-2012
COMPILE_ERROR_OUTPUT : 
QUERY                : MacroParameterUsedAsHashOperand
COMPILE_PASS         : True
TEST_DIFFERENCE      : 
RULE                 : RULE-20-12

[jsinglet]

🤖 Beep Boop! clang/cpp/x86_64 Matrix Testing for this PR has been completed but I didn't find anything to test!

[jsinglet]

🤖 Beep Boop! gcc/cpp/x86_64 Matrix Testing for this PR has been completed but I didn't find anything to test!

[jsinglet]

🤖 Beep Boop! clang/c/x86_64 Matrix Testing for this PR has been completed. See below for the results!

TEST_DIFFERENCE      : 
QUERY                : MacroParameterUsedAsHashOperand
SUITE                : MISRA-C-2012
COMPILE_PASS         : True
TEST_PASS            : True
RULE                 : RULE-20-12
PACKAGE              : Preprocessor2
COMPILE_ERROR_OUTPUT : 

[jsinglet]

🤖 Beep Boop! Matrix Testing for this PR has been completed. If no reports were posted it means this PR does not contain things that need matrix testing!

[lcartey]

Updated the issue body - I meant that the poor performance was not related to the upgrade!