Implement C package DeadCode
#163
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Create shared implementations in preparation for the C queries.
Add MISRA Rule 2.1 as an import of the UnreachableCode query.
Add support for Rule 2.2 by adoptiing the DeadCode shared query. A small modification has been made to ensure results which include macro expansions are reported, unless the macro fully generates the statement.
Adds a query to check for unused type declarations, based on the shared library. Note: the expected results for the C++ test case have been updated to include a compiler generated class. This is because shared queries do not properly apply the exclusion mechanism. See: https://github.com/github/coding-standards-team/issues/1126
Add a query for finding unused tags. This query uses `TypeMention`s to identify tags that are never referenced. Note: this query tries to exclude tags generated from macros, but this is not currently working due to a bug in the CodeQL CLI 2.9.4.
Adds a query to find unused macro declarations. The query is mostly straightforward, however #undefs are not connected in our database schema with the #defines they undefine. This means that we cannot accurately identify unused macros when there is a sequence of defs and undefs.
Adds a query to find unused labels. We consider a label unused if we never "goto" the label and never take the address of the label.
Adds a shared implementation query for identifying unused parameters.
jsinglet
reviewed
Jan 13, 2023
jsinglet
reviewed
Jan 13, 2023
cpp/common/src/codingstandards/cpp/rules/unreachablecode/UnreachableCode.qll
Show resolved
Hide resolved
jsinglet
reviewed
Jan 13, 2023
cpp/common/src/codingstandards/cpp/rules/unusedparameter/UnusedParameter.qll
Show resolved
Hide resolved
jsinglet
reviewed
Jan 13, 2023
cpp/common/src/codingstandards/cpp/rules/unusedtypedeclarations/UnusedTypeDeclarations.qll
Show resolved
Hide resolved
jsinglet
suggested changes
Jan 13, 2023
Contributor
jsinglet
left a comment
jsinglet
left a comment
There was a problem hiding this comment.
Great work Luke -- just a few items with formatting I think and then it is GTG after tests pass.
Contributor
Author
|
Comments addressed, I think. |
jsinglet
approved these changes
Jan 13, 2023
Contributor
jsinglet
left a comment
jsinglet
left a comment
There was a problem hiding this comment.
Sorry about the false alarm on the formatting, looks good now! :)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR adds queries for all the rules in the
DeadCodepackage.Rules 2.1, 2.2, 2.3 and 2.7 are shared implementations with C++ equivalents, where the new shared implementations are direct copies of the existing equivalent C++ rules.
Change request type
.ql,.qll,.qlsor unit tests)Rules with added or modified queries
Release change checklist
A change note (development_handbook.md#change-notes) is required for any pull request which modifies:
If you are only adding new rule queries, a change note is not required.
Author: Is a change note required?
🚨🚨🚨
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.
Reviewer: Confirm that either a change note is not required or the change note is required and has been added.
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
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.
Reviewer
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.