Skip to content

A0-1-6: Do not consider specialized alias templates as unused #37

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Aug 16, 2022

Conversation

lcartey
Copy link
Collaborator

@lcartey lcartey commented Aug 1, 2022

Description

Fixes #36.

Alias templates (e.g. template <typename T> using Z = Y<T>) were always considered unused, because instantiations were not considered as a "use" of the template.

Handling this case is slightly harder than expected, because alias templates are not well represented in the database schema or the CodeQL C/C++ standard library API. Instead, we have to make use of matching qualified names, and the observation that instantiations of an alias template do not have a valid location.

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:
    • A0-1-6

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

lcartey and others added 4 commits July 31, 2022 21:45
An alias template is an alias (e.g. a using statement) which is part of
a template, and is currently considered to be unused even if the
template is instantiated.
alias templates are not properly handled by the extractor, so we provide
special case handling that ensures alias template instantiations are
correctly associated with alias templates.

alias templates are not represented using the same template
infrastructure as other templates. Instead, each instantiation is a copy
of the template type, with no specified location. We use this to
identify templates with at least one instantiation. We assume an
instantiated template is used, as the only way it would be instantiated
is if it was used.
@nicolaswill nicolaswill self-requested a review August 16, 2022 17:23
Copy link
Contributor

@nicolaswill nicolaswill left a comment

Choose a reason for hiding this comment

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

LGTM

@nicolaswill nicolaswill enabled auto-merge August 16, 2022 17:38
@nicolaswill nicolaswill merged commit 36a4bdc into github:main Aug 16, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Development

Successfully merging this pull request may close these issues.

A0-1-6: Alias template is considered unused even when a specialization is used.
2 participants