Skip to content

Declarations4 cpp misra 2023 #1100

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.

Sign up for GitHub

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

Open
knewbury01 wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Declarations4 cpp misra 2023 #1100

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6fd7c37
Add RULE-10-1-2
knewbury01 Apr 1, 2026
578a35f
Fix accidental inclusion of git merge syntax in ql file
knewbury01 Apr 1, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions cpp/common/src/codingstandards/cpp/exclusions/cpp/Declarations4.qll
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
//** THIS FILE IS AUTOGENERATED, DO NOT MODIFY DIRECTLY. **/
import cpp
import RuleMetadata
import codingstandards.cpp.exclusions.RuleMetadata

newtype Declarations4Query = TVolatileQualifierNotUsedAppropriatelyQuery()

predicate isDeclarations4QueryMetadata(Query query, string queryId, string ruleId, string category) {
query =
// `Query` instance for the `volatileQualifierNotUsedAppropriately` query
Declarations4Package::volatileQualifierNotUsedAppropriatelyQuery() and
queryId =
// `@id` for the `volatileQualifierNotUsedAppropriately` query
"cpp/misra/volatile-qualifier-not-used-appropriately" and
ruleId = "RULE-10-1-2" and
category = "required"
}

module Declarations4Package {
Query volatileQualifierNotUsedAppropriatelyQuery() {
//autogenerate `Query` type
result =
// `Query` type for `volatileQualifierNotUsedAppropriately` query
TQueryCPP(TDeclarations4PackageQuery(TVolatileQualifierNotUsedAppropriatelyQuery()))
}
}
3 changes: 3 additions & 0 deletions cpp/common/src/codingstandards/cpp/exclusions/cpp/RuleMetadata.qll
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ import DeadCode8
import DeadCode9
import Declarations
import Declarations1
import Declarations4
import ExceptionSafety
import Exceptions1
import Exceptions2
Expand Down Expand Up @@ -129,6 +130,7 @@ newtype TCPPQuery =
TDeadCode9PackageQuery(DeadCode9Query q) or
TDeclarationsPackageQuery(DeclarationsQuery q) or
TDeclarations1PackageQuery(Declarations1Query q) or
TDeclarations4PackageQuery(Declarations4Query q) or
TExceptionSafetyPackageQuery(ExceptionSafetyQuery q) or
TExceptions1PackageQuery(Exceptions1Query q) or
TExceptions2PackageQuery(Exceptions2Query q) or
Expand Down Expand Up @@ -225,6 +227,7 @@ predicate isQueryMetadata(Query query, string queryId, string ruleId, string cat
isDeadCode9QueryMetadata(query, queryId, ruleId, category) or
isDeclarationsQueryMetadata(query, queryId, ruleId, category) or
isDeclarations1QueryMetadata(query, queryId, ruleId, category) or
isDeclarations4QueryMetadata(query, queryId, ruleId, category) or
isExceptionSafetyQueryMetadata(query, queryId, ruleId, category) or
isExceptions1QueryMetadata(query, queryId, ruleId, category) or
isExceptions2QueryMetadata(query, queryId, ruleId, category) or
Expand Down
31 changes: 31 additions & 0 deletions cpp/misra/src/rules/RULE-10-1-2/VolatileQualifierNotUsedAppropriately.ql
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
/**
* @id cpp/misra/volatile-qualifier-not-used-appropriately
* @name RULE-10-1-2: The volatile qualifier shall be used appropriately
* @description Using the volatile qualifier on certain entities can lead to undefined behavior or
* code that is hard to understand.
* @kind problem
* @precision very-high
* @problem.severity error
* @tags external/misra/id/rule-10-1-2
* correctness
* readability
* maintainability
* scope/single-translation-unit
* external/misra/enforcement/decidable
* external/misra/obligation/required
*/

import cpp
import codingstandards.cpp.misra

from Declaration d
where
not isExcluded(d, Declarations4Package::volatileQualifierNotUsedAppropriatelyQuery()) and
d.getADeclarationEntry().getType().isVolatile() and
(
d instanceof LocalVariable or
exists(d.(Parameter).getFunction()) or
d instanceof Function or
d.(Variable).isStructuredBinding()
)
select d, "Volatile entity declared."
Copy link
Copy Markdown
Collaborator

@MichaelRFairhurst MichaelRFairhurst Apr 8, 2026

Choose a reason for hiding this comment

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

Suggested change
select d, "Volatile entity declared."
select d, "Volatile entity '" + d.getName() + "' declared."

To help users sort through potential findings easier in line with the style guide

7 changes: 7 additions & 0 deletions cpp/misra/test/rules/RULE-10-1-2/VolatileQualifierNotUsedAppropriately.expected
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
| test.cpp:2:16:2:16 | g1 | Volatile entity declared. |
| test.cpp:4:21:4:21 | p | Volatile entity declared. |
| test.cpp:5:16:5:16 | x | Volatile entity declared. |
| test.cpp:9:18:9:18 | a | Volatile entity declared. |
| test.cpp:12:14:12:15 | f1 | Volatile entity declared. |
| test.cpp:15:23:15:23 | p | Volatile entity declared. |
| test.cpp:19:16:19:16 | m | Volatile entity declared. |
1 change: 1 addition & 0 deletions cpp/misra/test/rules/RULE-10-1-2/VolatileQualifierNotUsedAppropriately.qlref
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
rules/RULE-10-1-2/VolatileQualifierNotUsedAppropriately.ql
26 changes: 26 additions & 0 deletions cpp/misra/test/rules/RULE-10-1-2/test.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
int g[1] = {1};
auto volatile [g1] = g; // NON_COMPLIANT
Copy link
Copy Markdown
Collaborator

@MichaelRFairhurst MichaelRFairhurst Apr 8, 2026

Choose a reason for hiding this comment

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

Let's add a test for volatile int g2, which should be compliant for hardware interaction such as signal handlers.


void f(volatile int p) { // NON_COMPLIANT
volatile int x = 1; // NON_COMPLIANT
int y = 2; // COMPLIANT

int z[1] = {1};
auto volatile [a] = z; // NON_COMPLIANT
}

volatile int f1(); // NON_COMPLIANT

void f2(volatile int *p); // COMPLIANT
void f3(int *volatile p); // NON_COMPLIANT

class C {
public:
volatile int m(); // NON_COMPLIANT
int m1(); // COMPLIANT
volatile int m2; // COMPLIANT
};

struct S {
volatile int s; // COMPLIANT
};
27 changes: 27 additions & 0 deletions rule_packages/cpp/Declarations4.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
{
"MISRA-C++-2023": {
"RULE-10-1-2": {
"properties": {
"enforcement": "decidable",
"obligation": "required"
},
"queries": [
{
"description": "Using the volatile qualifier on certain entities can lead to undefined behavior or code that is hard to understand.",
Copy link
Copy Markdown
Collaborator

@MichaelRFairhurst MichaelRFairhurst Apr 8, 2026

Choose a reason for hiding this comment

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

Consider adding that it is often misused for multithreading and/or that the behavior for these usages of volatile aren't well defined

"kind": "problem",
"name": "The volatile qualifier shall be used appropriately",
"precision": "very-high",
"severity": "error",
"short_name": "VolatileQualifierNotUsedAppropriately",
"tags": [
"correctness",
"readability",
"maintainability",
"scope/single-translation-unit"
]
}
],
"title": "The volatile qualifier shall be used appropriately"
}
}
}
2 changes: 1 addition & 1 deletion rules.csv
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -916,7 +916,7 @@ cpp,MISRA-C++-2023,RULE-9-6-4,Yes,Required,Undecidable,System,A function declare
cpp,MISRA-C++-2023,RULE-9-6-5,Yes,Required,Decidable,Single Translation Unit,A function with non-void return type shall return a value on all paths,MSC52-CPP,ImportMisra23,Import,
cpp,MISRA-C++-2023,RULE-10-0-1,Yes,Advisory,Decidable,Single Translation Unit,A declaration should not declare more than one variable or member variable,M8-0-1,ImportMisra23,Import,
cpp,MISRA-C++-2023,RULE-10-1-1,Yes,Advisory,Decidable,Single Translation Unit,The target type of a pointer or lvalue reference parameter should be const-qualified appropriately,RULE-8-13,Declarations2,Hard,
cpp,MISRA-C++-2023,RULE-10-1-2,Yes,Required,Decidable,Single Translation Unit,The volatile qualifier shall be used appropriately,,Declarations2,Easy,
cpp,MISRA-C++-2023,RULE-10-1-2,Yes,Required,Decidable,Single Translation Unit,The volatile qualifier shall be used appropriately,A2-11-1,Declarations4,Easy,
cpp,MISRA-C++-2023,RULE-10-2-1,Yes,Required,Decidable,Single Translation Unit,An enumeration shall be defined with an explicit underlying type,A7-2-2,ImportMisra23,Import,
cpp,MISRA-C++-2023,RULE-10-2-2,Yes,Advisory,Decidable,Single Translation Unit,Unscoped enumerations should not be declared,A7-2-3,Banned2,Easy,
cpp,MISRA-C++-2023,RULE-10-2-3,Yes,Required,Decidable,Single Translation Unit,The numeric value of an unscoped enumeration with no fixed underlying type shall not be used,A4-5-1,Banned3,Easy,
Expand Down
Loading