Initiate Types Rule Package and Implement MISRA RULE-6-1 and RULE-6-2 #174

jeongsoolee09 · Jan 26, 2023

Description

Implemented MISRA's RULE-6-1: Bit-fields shall only be declared with an appropriate type and MISRA's RULE-6-2: Single-bit named bit fields shall not be of a signed type.

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-6-1
- RULE-6-2
Queries have been modified for the following rules:
- rule number here

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

…ULE-6-2

Using factual statements rather than a modal one, in this case `should`.

jeongsoolee09 · Jan 26, 2023

The suggested cert-help-extraction.py seems to have a bug.

√ codeql-coding-standards % python3.9 scripts/help/cert-help-extraction.py 
ID: ARR39-C - Converting contents at https://wiki.sei.cmu.edu/confluence/display/c/ARR39-C.+Do+not+add+or+subtract+a+scaled+integer+to+a+pointer into Markdown help file for DoNotAddOrSubtractAScaledIntegerToAPointer
ID: ARR39-C - Didn't find heading 'CERT', going to update the headings 'Noncompliant Code Example, Compliant Solution, Related Vulnerabilities, Automated Detection, Risk Assessment, Description, Related Guidelines, Bibliography'.
ID: CON30-C - Converting contents at https://wiki.sei.cmu.edu/confluence/display/c/CON30-C.+Clean+up+thread-specific+storage into Markdown help file for CleanUpThreadSpecificStorage
ID: CON30-C - Didn't find heading 'CERT', going to update the headings 'Noncompliant Code Example, Compliant Solution, Related Vulnerabilities, Automated Detection, Risk Assessment, Description'.
ID: CON31-C - Converting contents at https://wiki.sei.cmu.edu/confluence/display/c/CON31-C.+Do+not+destroy+a+mutex+while+it+is+locked into Markdown help file for DoNotAllowAMutexToGoOutOfScopeWhileLocked
ID: CON31-C - Didn't find heading 'CERT', going to update the headings 'Noncompliant Code Example, Compliant Solution, Related Vulnerabilities, Automated Detection, Risk Assessment, Description, Related Guidelines, Bibliography, CERT-CWE Mapping Notes'.
ID: CON31-C - Converting contents at https://wiki.sei.cmu.edu/confluence/display/c/CON31-C.+Do+not+destroy+a+mutex+while+it+is+locked into Markdown help file for DoNotDestroyAMutexWhileItIsLocked
ID: CON31-C - Didn't find heading 'CERT', going to update the headings 'Noncompliant Code Example, Compliant Solution, Related Vulnerabilities, Automated Detection, Risk Assessment, Description, Related Guidelines, Bibliography, CERT-CWE Mapping Notes'.
ID: CON32-C - Converting contents at https://wiki.sei.cmu.edu/confluence/display/c/CON32-C.+Prevent+data+races+when+accessing+bit-fields+from+multiple+threads into Markdown help file for PreventDataRacesWithMultipleThreads
ID: CON32-C - Didn't find heading 'CERT', going to update the headings 'Related Vulnerabilities, Compliant Solution (Bit-field, C11, Mutex), Automated Detection, Risk Assessment, Description, Compliant Solution (C11), Bibliography, Noncompliant Code Example (Bit-field)'.
ID: CON33-C - Converting contents at https://wiki.sei.cmu.edu/confluence/display/c/CON33-C.+Avoid+race+conditions+when+using+library+functions into Markdown help file for RaceConditionsWhenUsingLibraryFunctions
ID: CON33-C - Didn't find heading 'CERT', going to update the headings 'Noncompliant Code Example, Compliant Solution (Annex K, strerror_s()), Related Vulnerabilities, Automated Detection, Risk Assessment, Description, Related Guidelines, Bibliography, Compliant Solution (POSIX, strerror_r()), CERT-CWE Mapping Notes'.
ID: CON34-C - Converting contents at https://wiki.sei.cmu.edu/confluence/display/c/CON34-C.+Declare+objects+shared+between+threads+with+appropriate+storage+durations into Markdown help file for AppropriateThreadObjectStorageDurations
Traceback (most recent call last):
  File "/Users/jslee/Work/WorkRepos/codeql-coding-standards/scripts/help/cert-help-extraction.py", line 526, in <module>
    if find_heading(parsed_help, 'CERT'):
  File "/Users/jslee/Work/WorkRepos/codeql-coding-standards/scripts/shared/markdown_helpers.py", line 98, in find_heading
    if get_heading_text(h) == heading:
  File "/Users/jslee/Work/WorkRepos/codeql-coding-standards/scripts/shared/markdown_helpers.py", line 108, in get_heading_text
    return heading.children[0].children
IndexError: list index out of range

lcartey · Jan 27, 2023

@jeongsoolee09 Can you please create a new package for your two rules? We don't want to generate and commit files for all 30 rules in the Types package, as we are not going to implement all of them.

I would recommend calling the new package BitfieldTypes. You can create it like this:

Update rules.csv so that Rule 6.1 and Rule 6.2 are assigned to the new package (BitfieldTypes).
Generate the BitfieldTypes c package description file.
Copy any changes you made for Rule 6.1 and Rule 6.2 from the existing Types.json to the BitfieldTypes.json.
Generate the package files for the new package.
Delete any files from the types package.

Thanks!

jeongsoolee09 · Jan 27, 2023

I am changing this PR to draft to accommodate RULE-6-2 as well.

Update rules.csv, move 6-1 and 6-2 from Types.json to new file BitfieldTypes.json

jeongsoolee09 · Jan 27, 2023

Undone Types and made a small rule package called BitfieldTypes.

…ub/codeql-coding-standards into HEAD

lcartey

Looks good, just a couple of changes.

c/misra/test/rules/RULE-6-2/test.c

c/misra/src/rules/RULE-6-2/SingleBitNamedBitFieldsOfASignedType.ql

rule_packages/c/Types.json

1. `compilant` and `non_compliant` to uppercase 2. mark `int x1` of 6-2 to non_compliant 3. `clang-format` all

…ub/codeql-coding-standards into jeongsoolee09/misra6-1_and_misra6-2

jeongsoolee09 · Feb 1, 2023

We can ignore implementation-specific integer types: GCC and Clang does not define any additional types that are equivalent to int.

lcartey

One minor change, otherwise looks good!

c/misra/src/rules/RULE-6-1/BitFieldsShallOnlyBeDeclaredWithAnAppropriateType.ql

Use the fact that `resolveTypedefs` is an identity operation with types that have no type alias (typedef).

c/misra/test/rules/RULE-6-2/test.c

jeongsoolee09 added 8 commits January 25, 2023 10:30

Add rule_packages/c/Types.json and add description for RULE-6-1 and R…

696111b

…ULE-6-2

Better polish description for RULE-6-1

d511157

make rule_packages/c/Types.json valid

41e755f

generate rule package files for c/Types.json

82dadd9

implement MISRA RULE-6-1

dcda9b6

Update the alert message in the select statement

26c8f62

Using factual statements rather than a modal one, in this case `should`.

Inline isInappropriateType and fix .expected

17b1ef9

Add some inline comments

50049bf

jeongsoolee09 requested review from rvermeulen and lcartey January 26, 2023 21:18

add test.c and sketch query

326534f

jeongsoolee09 added 2 commits January 27, 2023 08:57

update

abb35fc

really minor formatting

77a4c55

jeongsoolee09 changed the title ~~Initiate Types Rule Package and Implement MISRA RULE-6-1~~ Initiate Types Rule Package and Implement MISRA RULE-6-1 and RULE-6-2 Jan 27, 2023

jeongsoolee09 marked this pull request as draft January 27, 2023 17:34

jeongsoolee09 added 4 commits January 27, 2023 09:47

separate out BitfieldTypes

7796fdd

Update rules.csv, move 6-1 and 6-2 from Types.json to new file BitfieldTypes.json

Remove previous files for rules in Types.json

0e3bd23

update RuleMetadata.qll

1610215

remove remaining occurrences/reference to Types

5f30b77

jeongsoolee09 marked this pull request as ready for review January 27, 2023 22:12

jeongsoolee09 added 3 commits January 31, 2023 08:46

update test.c for RULE-6-1 to differ from given examples

e49bcd6

Merge branch 'main' into jeongsoolee09/misra6-1_and_misra6-2

cceac32

Merge branch 'jeongsoolee09/misra6-1_and_misra6-2' of github.com:gith…

6291dca

…ub/codeql-coding-standards into HEAD

lcartey requested changes Jan 31, 2023

View reviewed changes

lcartey reviewed Jan 31, 2023

View reviewed changes

rule_packages/c/Types.json Outdated Show resolved Hide resolved

delete remaining tests and delete Types.json

c0ba262

jeongsoolee09 added 6 commits January 31, 2023 13:36

update test.c for 6-1 and 6-2

60f2824

1. `compilant` and `non_compliant` to uppercase 2. mark `int x1` of 6-2 to non_compliant 3. `clang-format` all

update .expected files to reflect clang-format

294e49e

incorporate requested changes for query

a6e86eb

Merge branch 'main' into jeongsoolee09/misra6-1_and_misra6-2

8fddaf4

minor format

49674de

Merge branch 'jeongsoolee09/misra6-1_and_misra6-2' of github.com:gith…

c079a14

…ub/codeql-coding-standards into jeongsoolee09/misra6-1_and_misra6-2

jeongsoolee09 enabled auto-merge February 1, 2023 00:16

format qldoc comment (indentation)

831cf03

jeongsoolee09 disabled auto-merge February 1, 2023 00:24

jeongsoolee09 requested a review from lcartey February 1, 2023 01:07

jeongsoolee09 enabled auto-merge February 1, 2023 01:09

lcartey requested changes Feb 1, 2023

View reviewed changes

c/misra/src/rules/RULE-6-1/BitFieldsShallOnlyBeDeclaredWithAnAppropriateType.ql Outdated Show resolved Hide resolved

refine RULE-6-1

3e96c5f

Use the fact that `resolveTypedefs` is an identity operation with types that have no type alias (typedef).

lcartey approved these changes Feb 2, 2023

View reviewed changes

jeongsoolee09 merged commit b18a89e into main Feb 2, 2023

jeongsoolee09 deleted the jeongsoolee09/misra6-1_and_misra6-2 branch February 2, 2023 09:05

rvermeulen reviewed Feb 3, 2023

View reviewed changes

c/misra/test/rules/RULE-6-2/test.c Show resolved Hide resolved

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Initiate Types Rule Package and Implement MISRA RULE-6-1 and RULE-6-2 #174

Initiate Types Rule Package and Implement MISRA RULE-6-1 and RULE-6-2 #174

Uh oh!

jeongsoolee09 commented Jan 26, 2023 •

edited by lcartey

Loading

Uh oh!

jeongsoolee09 commented Jan 26, 2023

Uh oh!

lcartey commented Jan 27, 2023

Uh oh!

jeongsoolee09 commented Jan 27, 2023

Uh oh!

jeongsoolee09 commented Jan 27, 2023

Uh oh!

lcartey left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jeongsoolee09 commented Feb 1, 2023

Uh oh!

lcartey left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Search code, repositories, users, issues, pull requests...

Initiate Types Rule Package and Implement MISRA RULE-6-1 and RULE-6-2 #174

Initiate Types Rule Package and Implement MISRA RULE-6-1 and RULE-6-2 #174

Uh oh!

Conversation

jeongsoolee09 commented Jan 26, 2023 • edited by lcartey Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Change request type

Rules with added or modified queries

Release change checklist

Query development review checklist

Author

Reviewer

Uh oh!

jeongsoolee09 commented Jan 26, 2023

Uh oh!

lcartey commented Jan 27, 2023

Uh oh!

jeongsoolee09 commented Jan 27, 2023

Uh oh!

jeongsoolee09 commented Jan 27, 2023

Uh oh!

lcartey left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jeongsoolee09 commented Feb 1, 2023

Uh oh!

lcartey left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jeongsoolee09 commented Jan 26, 2023 •

edited by lcartey

Loading