Declarations4: add RULE-8-3

knewbury01 · knewbury01 · commit 57d83bc507a9 · 2022-11-09T17:06:57.000-05:00
diff --git a/.vscode/tasks.json b/.vscode/tasks.json
@@ -205,6 +205,8 @@
                 "Declarations",
                 "Declarations1",
                 "Declarations2",
+                "Declarations3",
+                "Declarations4",
                 "Exceptions1",
                 "Exceptions2",
                 "Expressions",
diff --git a/c/misra/src/rules/RULE-8-3/Compatible.qll b/c/misra/src/rules/RULE-8-3/Compatible.qll
@@ -0,0 +1,30 @@
+import cpp
+
+/*
+ * This is a copy of the `arithTypesMatch` predicate from the standard set of
+ * queries as of the `codeql-cli/2.9.4` tag in `github/codeql`.
+ */
+
+pragma[inline]
+predicate arithTypesMatch(Type t1, Type t2) {
+  t1 = t2
+  or
+  t1.getSize() = t2.getSize() and
+  (
+    t1 instanceof IntegralOrEnumType and
+    t2 instanceof IntegralOrEnumType
+    or
+    t1 instanceof FloatingPointType and
+    t2 instanceof FloatingPointType
+  )
+}
+
+predicate typesCompatible(Type t1, Type t2) {
+  if t1 instanceof BuiltInType and t2 instanceof BuiltInType
+  then
+    //for simple types consider compatible
+    arithTypesMatch(t1, t2)
+  else
+    //otherwise include type qualifiers and typedef names
+     t1 = t2
+}
diff --git a/c/misra/src/rules/RULE-8-3/DeclarationsOfAFunctionSameNameAndType.ql b/c/misra/src/rules/RULE-8-3/DeclarationsOfAFunctionSameNameAndType.ql
@@ -0,0 +1,48 @@
+/**
+ * @id c/misra/declarations-of-a-function-same-name-and-type
+ * @name RULE-8-3: All declarations of a function shall use the same names and type qualifiers
+ * @description Using different types across the same declarations disallows strong type checking
+ *              and can lead to undefined behaviour.
+ * @kind problem
+ * @precision very-high
+ * @problem.severity error
+ * @tags external/misra/id/rule-8-3
+ *       correctness
+ *       external/misra/obligation/required
+ */
+
+import cpp
+import codingstandards.c.misra
+import Compatible
+
+from FunctionDeclarationEntry f1, FunctionDeclarationEntry f2, string case
+where
+  not isExcluded(f1, Declarations4Package::declarationsOfAFunctionSameNameAndTypeQuery()) and
+  not isExcluded(f2, Declarations4Package::declarationsOfAFunctionSameNameAndTypeQuery()) and
+  not f1 = f2 and
+  f1.getDeclaration() = f2.getDeclaration() and
+  //return type check
+  (
+    not typesCompatible(f1.getType(), f2.getType()) and
+    case = "return type"
+    or
+    //parameter type check
+    exists(ParameterDeclarationEntry p1, ParameterDeclarationEntry p2, int i |
+      p1 = f1.getParameterDeclarationEntry(i) and
+      p2 = f2.getParameterDeclarationEntry(i)
+    |
+      not typesCompatible(p1.getType(), p2.getType())
+    ) and
+    case = "parameter types"
+    or
+    //parameter name check
+    exists(ParameterDeclarationEntry p1, ParameterDeclarationEntry p2, int i |
+      p1 = f1.getParameterDeclarationEntry(i) and
+      p2 = f2.getParameterDeclarationEntry(i)
+    |
+      not p1.getName() = p2.getName()
+    ) and
+    case = "parameter names"
+  )
+select f1, "The " + case + " of re-declaration of $@ is not compatible with declaration $@", f1,
+  f1.getName(), f2, f2.getName()
diff --git a/c/misra/src/rules/RULE-8-3/DeclarationsOfAnObjectSameNameAndType.ql b/c/misra/src/rules/RULE-8-3/DeclarationsOfAnObjectSameNameAndType.ql
@@ -0,0 +1,28 @@
+/**
+ * @id c/misra/declarations-of-an-object-same-name-and-type
+ * @name RULE-8-3: All declarations of an object shall use the same names and type qualifiers
+ * @description Using different types across the same declarations disallows strong type checking
+ *              and can lead to undefined behaviour.
+ * @kind problem
+ * @precision very-high
+ * @problem.severity error
+ * @tags external/misra/id/rule-8-3
+ *       correctness
+ *       external/misra/obligation/required
+ */
+
+import cpp
+import codingstandards.c.misra
+import Compatible
+
+from VariableDeclarationEntry decl1, VariableDeclarationEntry decl2
+where
+  not isExcluded(decl1, Declarations4Package::declarationsOfAnObjectSameNameAndTypeQuery()) and
+  not isExcluded(decl2, Declarations4Package::declarationsOfAnObjectSameNameAndTypeQuery()) and
+  not decl1 = decl2 and
+  decl1.getVariable().getQualifiedName() = decl2.getVariable().getQualifiedName() and
+  not typesCompatible(decl1.getType(), decl2.getType())
+select decl1,
+  "The object $@ of type " + decl1.getType().toString() +
+    " is not compatible with re-declaration $@ of type " + decl2.getType().toString(), decl1,
+  decl1.getName(), decl2, decl2.getName()
diff --git a/c/misra/test/rules/RULE-8-3/DeclarationsOfAFunctionSameNameAndType.expected b/c/misra/test/rules/RULE-8-3/DeclarationsOfAFunctionSameNameAndType.expected
@@ -0,0 +1,12 @@
+| function1.c:6:6:6:7 | declaration of f3 | The return type of re-declaration of $@ is not compatible with declaration $@ | function1.c:6:6:6:7 | declaration of f3 | f3 | function1.c:8:4:8:5 | declaration of f3 | f3 |
+| function1.c:8:4:8:5 | declaration of f3 | The return type of re-declaration of $@ is not compatible with declaration $@ | function1.c:8:4:8:5 | declaration of f3 | f3 | function1.c:6:6:6:7 | declaration of f3 | f3 |
+| function1.c:8:4:8:5 | declaration of f3 | The return type of re-declaration of $@ is not compatible with declaration $@ | function1.c:8:4:8:5 | declaration of f3 | f3 | function2.c:4:6:4:7 | declaration of f3 | f3 |
+| function1.c:9:6:9:7 | declaration of f4 | The return type of re-declaration of $@ is not compatible with declaration $@ | function1.c:9:6:9:7 | declaration of f4 | f4 | function2.c:5:5:5:6 | declaration of f4 | f4 |
+| function1.c:13:5:13:6 | definition of f6 | The return type of re-declaration of $@ is not compatible with declaration $@ | function1.c:13:5:13:6 | definition of f6 | f6 | function2.c:9:6:9:7 | definition of f6 | f6 |
+| function1.c:21:3:21:5 | definition of f21 | The parameter types of re-declaration of $@ is not compatible with declaration $@ | function1.c:21:3:21:5 | definition of f21 | f21 | function2.c:17:10:17:12 | declaration of f21 | f21 |
+| function1.c:25:6:25:8 | definition of f22 | The parameter names of re-declaration of $@ is not compatible with declaration $@ | function1.c:25:6:25:8 | definition of f22 | f22 | function2.c:19:13:19:15 | declaration of f22 | f22 |
+| function2.c:4:6:4:7 | declaration of f3 | The return type of re-declaration of $@ is not compatible with declaration $@ | function2.c:4:6:4:7 | declaration of f3 | f3 | function1.c:8:4:8:5 | declaration of f3 | f3 |
+| function2.c:5:5:5:6 | declaration of f4 | The return type of re-declaration of $@ is not compatible with declaration $@ | function2.c:5:5:5:6 | declaration of f4 | f4 | function1.c:9:6:9:7 | declaration of f4 | f4 |
+| function2.c:9:6:9:7 | definition of f6 | The return type of re-declaration of $@ is not compatible with declaration $@ | function2.c:9:6:9:7 | definition of f6 | f6 | function1.c:13:5:13:6 | definition of f6 | f6 |
+| function2.c:17:10:17:12 | declaration of f21 | The parameter types of re-declaration of $@ is not compatible with declaration $@ | function2.c:17:10:17:12 | declaration of f21 | f21 | function1.c:21:3:21:5 | definition of f21 | f21 |
+| function2.c:19:13:19:15 | declaration of f22 | The parameter names of re-declaration of $@ is not compatible with declaration $@ | function2.c:19:13:19:15 | declaration of f22 | f22 | function1.c:25:6:25:8 | definition of f22 | f22 |
diff --git a/c/misra/test/rules/RULE-8-3/DeclarationsOfAFunctionSameNameAndType.qlref b/c/misra/test/rules/RULE-8-3/DeclarationsOfAFunctionSameNameAndType.qlref
@@ -0,0 +1 @@
+rules/RULE-8-3/DeclarationsOfAFunctionSameNameAndType.ql
diff --git a/c/misra/test/rules/RULE-8-3/DeclarationsOfAnObjectSameNameAndType.expected b/c/misra/test/rules/RULE-8-3/DeclarationsOfAnObjectSameNameAndType.expected
@@ -0,0 +1,16 @@
+| object1.c:3:6:3:7 | definition of a3 | The object $@ of type long is not compatible with re-declaration $@ of type LL | object1.c:3:6:3:7 | definition of a3 | a3 | object2.c:9:11:9:12 | declaration of a3 | a3 |
+| object1.c:4:6:4:7 | definition of a4 | The object $@ of type long is not compatible with re-declaration $@ of type int | object1.c:4:6:4:7 | definition of a4 | a4 | object2.c:11:12:11:13 | declaration of a4 | a4 |
+| object1.c:5:5:5:6 | definition of a5 | The object $@ of type int is not compatible with re-declaration $@ of type long | object1.c:5:5:5:6 | definition of a5 | a5 | object2.c:13:13:13:14 | declaration of a5 | a5 |
+| object1.c:6:6:6:7 | definition of a6 | The object $@ of type long is not compatible with re-declaration $@ of type int | object1.c:6:6:6:7 | definition of a6 | a6 | object2.c:17:1:17:3 | declaration of a6 | a6 |
+| object1.c:7:5:7:6 | definition of a7 | The object $@ of type int is not compatible with re-declaration $@ of type LL | object1.c:7:5:7:6 | definition of a7 | a7 | object2.c:19:11:19:12 | declaration of a7 | a7 |
+| object1.c:13:5:13:7 | definition of a10 | The object $@ of type int[100] is not compatible with re-declaration $@ of type LI[100] | object1.c:13:5:13:7 | definition of a10 | a10 | object2.c:22:4:22:6 | definition of a10 | a10 |
+| object1.c:14:5:14:7 | definition of a11 | The object $@ of type int[100] is not compatible with re-declaration $@ of type int[101] | object1.c:14:5:14:7 | definition of a11 | a11 | object2.c:23:12:23:14 | declaration of a11 | a11 |
+| object1.c:17:12:17:14 | definition of a13 | The object $@ of type int *const is not compatible with re-declaration $@ of type int * | object1.c:17:12:17:14 | definition of a13 | a13 | object2.c:26:13:26:15 | declaration of a13 | a13 |
+| object2.c:9:11:9:12 | declaration of a3 | The object $@ of type LL is not compatible with re-declaration $@ of type long | object2.c:9:11:9:12 | declaration of a3 | a3 | object1.c:3:6:3:7 | definition of a3 | a3 |
+| object2.c:11:12:11:13 | declaration of a4 | The object $@ of type int is not compatible with re-declaration $@ of type long | object2.c:11:12:11:13 | declaration of a4 | a4 | object1.c:4:6:4:7 | definition of a4 | a4 |
+| object2.c:13:13:13:14 | declaration of a5 | The object $@ of type long is not compatible with re-declaration $@ of type int | object2.c:13:13:13:14 | declaration of a5 | a5 | object1.c:5:5:5:6 | definition of a5 | a5 |
+| object2.c:17:1:17:3 | declaration of a6 | The object $@ of type int is not compatible with re-declaration $@ of type long | object2.c:17:1:17:3 | declaration of a6 | a6 | object1.c:6:6:6:7 | definition of a6 | a6 |
+| object2.c:19:11:19:12 | declaration of a7 | The object $@ of type LL is not compatible with re-declaration $@ of type int | object2.c:19:11:19:12 | declaration of a7 | a7 | object1.c:7:5:7:6 | definition of a7 | a7 |
+| object2.c:22:4:22:6 | definition of a10 | The object $@ of type LI[100] is not compatible with re-declaration $@ of type int[100] | object2.c:22:4:22:6 | definition of a10 | a10 | object1.c:13:5:13:7 | definition of a10 | a10 |
+| object2.c:23:12:23:14 | declaration of a11 | The object $@ of type int[101] is not compatible with re-declaration $@ of type int[100] | object2.c:23:12:23:14 | declaration of a11 | a11 | object1.c:14:5:14:7 | definition of a11 | a11 |
+| object2.c:26:13:26:15 | declaration of a13 | The object $@ of type int * is not compatible with re-declaration $@ of type int *const | object2.c:26:13:26:15 | declaration of a13 | a13 | object1.c:17:12:17:14 | definition of a13 | a13 |
diff --git a/c/misra/test/rules/RULE-8-3/DeclarationsOfAnObjectSameNameAndType.qlref b/c/misra/test/rules/RULE-8-3/DeclarationsOfAnObjectSameNameAndType.qlref
@@ -0,0 +1 @@
+rules/RULE-8-3/DeclarationsOfAnObjectSameNameAndType.ql
diff --git a/c/misra/test/rules/RULE-8-3/function1.c b/c/misra/test/rules/RULE-8-3/function1.c
@@ -0,0 +1,27 @@
+typedef long LL;
+
+int f1();        // COMPLIANT
+int f2(int f2a); // COMPLIANT
+
+long f3(); // NON_COMPLIANT
+
+LL f3();          // NON_COMPLIANT
+long f4(int f4a); // NON_COMPLIANT
+
+long f5(int f5a) { return 0; } // COMPLIANT
+
+int f6(int f6a) { return 0; } // NON_COMPLIANT
+
+int f20(int f20a); // COMPLIANT - overloaded function
+
+typedef int wi;
+typedef int hi;
+typedef long a;
+
+a f21(wi w, wi h) { // NON_COMPLIANT
+  return (a)w * h;
+}
+
+void f22(int f22b, int f22a) { // NON_COMPLIANT
+  return;
+}
diff --git a/c/misra/test/rules/RULE-8-3/function2.c b/c/misra/test/rules/RULE-8-3/function2.c
@@ -0,0 +1,19 @@
+int f1();        // COMPLIANT
+int f2(int f2a); // COMPLIANT
+
+long f3();       // NON_COMPLIANT
+int f4(int f4a); // NON_COMPLIANT
+
+long f5(int f5a) { return 0; } // COMPLIANT
+
+long f6(int f6a) { return 0; } // NON_COMPLIANT
+
+int f20(int f20a, int f20b); // COMPLIANT -- overloaded function
+
+typedef int wi;
+typedef int hi;
+typedef long a;
+
+extern a f21(wi w, hi h); // NON_COMPLIANT
+
+extern void f22(int f22a, int f22b); // NON_COMPLIANT
diff --git a/c/misra/test/rules/RULE-8-3/object1.c b/c/misra/test/rules/RULE-8-3/object1.c
@@ -0,0 +1,17 @@
+int a1;  // COMPLIANT
+int a2;  // COMPLIANT
+long a3; // NON_COMPLIANT
+long a4; // NON_COMPLIANT
+int a5;  // NON_COMPLIANT
+long a6; // NON_COMPLIANT
+int a7;  // NON_COMPLIANT
+
+int a8;        // COMPLIANT
+extern int a8; // COMPLIANT
+
+int a9[100];  // COMPLIANT
+int a10[100]; // NON_COMPLIANT
+int a11[100]; // NON_COMPLIANT - different sizes
+int a12;      // COMPLIANT
+
+int *const a13; // NON_COMPLIANT
diff --git a/c/misra/test/rules/RULE-8-3/object2.c b/c/misra/test/rules/RULE-8-3/object2.c
@@ -0,0 +1,26 @@
+extern int a1; // COMPLIANT
+
+#define EE extern int a2
+EE; // COMPLIANT
+
+typedef long LL;
+typedef int LI;
+
+extern LL a3; // NON_COMPLIANT
+
+extern int a4; // NON_COMPLIANT
+
+extern long a5; // NON_COMPLIANT
+
+#define EE1 extern int a6
+
+EE1; // NON_COMPLIANT
+
+extern LL a7; // NON_COMPLIANT
+
+extern int a9[100];  // COMPLIANT
+LI a10[100];         // NON_COMPLIANT
+extern int a11[101]; // NON_COMPLIANT - different sizes
+signed a12;          // COMPLIANT
+
+extern int *a13; // NON_COMPLIANT
diff --git a/c/misra/test/rules/RULE-8-3/test.c b/c/misra/test/rules/RULE-8-3/test.c
diff --git a/cpp/common/src/codingstandards/cpp/exclusions/c/Declarations4.qll b/cpp/common/src/codingstandards/cpp/exclusions/c/Declarations4.qll
@@ -5,6 +5,8 @@ import codingstandards.cpp.exclusions.RuleMetadata
 
 newtype Declarations4Query =
   TFunctionTypesNotInPrototypeFormQuery() or
+  TDeclarationsOfAnObjectSameNameAndTypeQuery() or
+  TDeclarationsOfAFunctionSameNameAndTypeQuery() or
   TIdentifierWithExternalLinkageOneDefinitionQuery()
 
 predicate isDeclarations4QueryMetadata(Query query, string queryId, string ruleId) {
@@ -16,6 +18,22 @@ predicate isDeclarations4QueryMetadata(Query query, string queryId, string ruleI
     "c/misra/function-types-not-in-prototype-form" and
   ruleId = "RULE-8-2"
   or
+  query =
+    // `Query` instance for the `declarationsOfAnObjectSameNameAndType` query
+    Declarations4Package::declarationsOfAnObjectSameNameAndTypeQuery() and
+  queryId =
+    // `@id` for the `declarationsOfAnObjectSameNameAndType` query
+    "c/misra/declarations-of-an-object-same-name-and-type" and
+  ruleId = "RULE-8-3"
+  or
+  query =
+    // `Query` instance for the `declarationsOfAFunctionSameNameAndType` query
+    Declarations4Package::declarationsOfAFunctionSameNameAndTypeQuery() and
+  queryId =
+    // `@id` for the `declarationsOfAFunctionSameNameAndType` query
+    "c/misra/declarations-of-a-function-same-name-and-type" and
+  ruleId = "RULE-8-3"
+  or
   query =
     // `Query` instance for the `identifierWithExternalLinkageOneDefinition` query
     Declarations4Package::identifierWithExternalLinkageOneDefinitionQuery() and
@@ -33,6 +51,20 @@ module Declarations4Package {
       TQueryC(TDeclarations4PackageQuery(TFunctionTypesNotInPrototypeFormQuery()))
   }
 
+  Query declarationsOfAnObjectSameNameAndTypeQuery() {
+    //autogenerate `Query` type
+    result =
+      // `Query` type for `declarationsOfAnObjectSameNameAndType` query
+      TQueryC(TDeclarations4PackageQuery(TDeclarationsOfAnObjectSameNameAndTypeQuery()))
+  }
+
+  Query declarationsOfAFunctionSameNameAndTypeQuery() {
+    //autogenerate `Query` type
+    result =
+      // `Query` type for `declarationsOfAFunctionSameNameAndType` query
+      TQueryC(TDeclarations4PackageQuery(TDeclarationsOfAFunctionSameNameAndTypeQuery()))
+  }
+
   Query identifierWithExternalLinkageOneDefinitionQuery() {
     //autogenerate `Query` type
     result =
diff --git a/cpp/common/src/codingstandards/cpp/exclusions/c/RuleMetadata.qll b/cpp/common/src/codingstandards/cpp/exclusions/c/RuleMetadata.qll
@@ -18,6 +18,7 @@ import IO1
 import IO2
 import IO3
 import IO4
+import Language2
 import Misc
 import Pointers1
 import Pointers2
@@ -51,6 +52,7 @@ newtype TCQuery =
   TIO2PackageQuery(IO2Query q) or
   TIO3PackageQuery(IO3Query q) or
   TIO4PackageQuery(IO4Query q) or
+  TLanguage2PackageQuery(Language2Query q) or
   TMiscPackageQuery(MiscQuery q) or
   TPointers1PackageQuery(Pointers1Query q) or
   TPointers2PackageQuery(Pointers2Query q) or
@@ -84,6 +86,7 @@ predicate isQueryMetadata(Query query, string queryId, string ruleId) {
   isIO2QueryMetadata(query, queryId, ruleId) or
   isIO3QueryMetadata(query, queryId, ruleId) or
   isIO4QueryMetadata(query, queryId, ruleId) or
+  isLanguage2QueryMetadata(query, queryId, ruleId) or
   isMiscQueryMetadata(query, queryId, ruleId) or
   isPointers1QueryMetadata(query, queryId, ruleId) or
   isPointers2QueryMetadata(query, queryId, ruleId) or
diff --git a/rule_packages/c/Declarations4.json b/rule_packages/c/Declarations4.json
@@ -23,6 +23,36 @@
       ],
       "title": "Function types shall be in prototype form with named parameters"
     },
+    "RULE-8-3": {
+      "properties": {
+        "obligation": "required"
+      },
+      "queries": [
+        {
+          "description": "Using different types across the same declarations disallows strong type checking and can lead to undefined behaviour.",
+          "kind": "problem",
+          "name": "All declarations of an object shall use the same names and type qualifiers",
+          "precision": "very-high",
+          "severity": "error",
+          "short_name": "DeclarationsOfAnObjectSameNameAndType",
+          "tags": [
+            "correctness"
+          ]
+        },
+        {
+          "description": "Using different types across the same declarations disallows strong type checking and can lead to undefined behaviour.",
+          "kind": "problem",
+          "name": "All declarations of a function shall use the same names and type qualifiers",
+          "precision": "very-high",
+          "severity": "error",
+          "short_name": "DeclarationsOfAFunctionSameNameAndType",
+          "tags": [
+            "correctness"
+          ]
+        }
+      ],
+      "title": "All declarations of an object or function shall use the same names and type qualifiers"
+    },
     "RULE-8-6": {
       "properties": {
         "obligation": "required"
diff --git a/rules.csv b/rules.csv
@@ -648,7 +648,7 @@ c,MISRA-C-2012,RULE-7-3,Yes,Required,,,The lowercase character �l� shall not
 c,MISRA-C-2012,RULE-7-4,Yes,Required,,,A string literal shall not be assigned to an object unless the object�s type is �pointer to const-qualified char�,A2-13-4,Types,Easy,
 c,MISRA-C-2012,RULE-8-1,Yes,Required,,,Types shall be explicitly specified,,Declarations3,Medium,
 c,MISRA-C-2012,RULE-8-2,Yes,Required,,,Function types shall be in prototype form with named parameters,,Declarations4,Medium,
-c,MISRA-C-2012,RULE-8-3,Yes,Required,,,All declarations of an object or function shall use the same names and type qualifiers,M3-2-1,Declarations,Medium,
+c,MISRA-C-2012,RULE-8-3,Yes,Required,,,All declarations of an object or function shall use the same names and type qualifiers,M3-2-1,Declarations4,Medium,
 c,MISRA-C-2012,RULE-8-4,Yes,Required,,,A compatible declaration shall be visible when an object or function with external linkage is defined,,Declarations,Medium,
 c,MISRA-C-2012,RULE-8-5,Yes,Required,,,An external object or function shall be declared once in one and only one file,,Declarations,Medium,
 c,MISRA-C-2012,RULE-8-6,Yes,Required,,,An identifier with external linkage shall have exactly one external definition,M3-2-4,Declarations4,Import,

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+rules/RULE-8-3/DeclarationsOfAFunctionSameNameAndType.ql`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+rules/RULE-8-3/DeclarationsOfAnObjectSameNameAndType.ql`