Declarations4: add RULE-8-4

knewbury01 · knewbury01 · commit 3b4443e27bb6 · 2022-11-17T13:01:04.000-05:00
diff --git a/c/misra/src/rules/RULE-8-3/DeclarationsOfAFunctionSameNameAndType.ql b/c/misra/src/rules/RULE-8-3/DeclarationsOfAFunctionSameNameAndType.ql
@@ -15,24 +15,6 @@ import cpp
 import codingstandards.c.misra
 import codingstandards.cpp.Compatible
 
-predicate parameterTypesIncompatible(FunctionDeclarationEntry f1, FunctionDeclarationEntry f2) {
-  exists(ParameterDeclarationEntry p1, ParameterDeclarationEntry p2, int i |
-    p1 = f1.getParameterDeclarationEntry(i) and
-    p2 = f2.getParameterDeclarationEntry(i)
-  |
-    not typesCompatible(p1.getType(), p2.getType())
-  )
-}
-
-predicate parameterNamesIncompatible(FunctionDeclarationEntry f1, FunctionDeclarationEntry f2) {
-  exists(ParameterDeclarationEntry p1, ParameterDeclarationEntry p2, int i |
-    p1 = f1.getParameterDeclarationEntry(i) and
-    p2 = f2.getParameterDeclarationEntry(i)
-  |
-    not p1.getName() = p2.getName()
-  )
-}
-
 from FunctionDeclarationEntry f1, FunctionDeclarationEntry f2, string case
 where
   not isExcluded(f1, Declarations4Package::declarationsOfAFunctionSameNameAndTypeQuery()) and
diff --git a/c/misra/src/rules/RULE-8-4/CompatibleDeclarationFunctionDefined.ql b/c/misra/src/rules/RULE-8-4/CompatibleDeclarationFunctionDefined.ql
@@ -0,0 +1,50 @@
+/**
+ * @id c/misra/compatible-declaration-function-defined
+ * @name RULE-8-4: A compatible declaration shall be visible when a function with external linkage is defined
+ * @description A compatible declaration shall be visible when a function with external linkage is
+ *              defined, otherwise program behaviour may be undefined.
+ * @kind problem
+ * @precision very-high
+ * @problem.severity error
+ * @tags external/misra/id/rule-8-4
+ *       readability
+ *       maintainability
+ *       correctness
+ *       external/misra/obligation/required
+ */
+
+import cpp
+import codingstandards.c.misra
+import codingstandards.cpp.Identifiers
+import codingstandards.cpp.Compatible
+
+from FunctionDeclarationEntry f1
+where
+  not isExcluded(f1, Declarations4Package::compatibleDeclarationFunctionDefinedQuery()) and
+  f1.isDefinition() and
+  f1.getDeclaration() instanceof ExternalIdentifiers and
+  //no declaration matches exactly
+  (
+    not exists(FunctionDeclarationEntry f2 |
+      not f2.isDefinition() and
+      f2.getDeclaration() = f1.getDeclaration()
+    )
+    or
+    //or one exists that is close but incompatible in some way
+    exists(FunctionDeclarationEntry f2 |
+      f1.getName() = f2.getName() and
+      not f2.isDefinition() and
+      f2.getDeclaration() = f1.getDeclaration() and
+      //return types differ
+      (
+        not typesCompatible(f1.getType(), f2.getType())
+        or
+        //parameter types differ
+        parameterTypesIncompatible(f1, f2)
+        or
+        //parameter names differ
+        parameterNamesIncompatible(f1, f2)
+      )
+    )
+  )
+select f1, "No separate compatible declaration found for this definition."
diff --git a/c/misra/src/rules/RULE-8-4/CompatibleDeclarationObjectDefined.ql b/c/misra/src/rules/RULE-8-4/CompatibleDeclarationObjectDefined.ql
@@ -0,0 +1,38 @@
+/**
+ * @id c/misra/compatible-declaration-object-defined
+ * @name RULE-8-4: A compatible declaration shall be visible when an object with external linkage is defined
+ * @description A compatible declaration shall be visible when an object with external linkage is
+ *              defined, otherwise program behaviour may be undefined.
+ * @kind problem
+ * @precision very-high
+ * @problem.severity error
+ * @tags external/misra/id/rule-8-4
+ *       readability
+ *       maintainability
+ *       correctness
+ *       external/misra/obligation/required
+ */
+
+import cpp
+import codingstandards.c.misra
+import codingstandards.cpp.Identifiers
+import codingstandards.cpp.Compatible
+
+from VariableDeclarationEntry decl1
+where
+  not isExcluded(decl1, Declarations4Package::compatibleDeclarationObjectDefinedQuery()) and
+  decl1.isDefinition() and
+  decl1.getDeclaration() instanceof ExternalIdentifiers and
+  (
+    //no declaration matches exactly
+    not exists(VariableDeclarationEntry decl2 |
+      not decl2.isDefinition() and decl2.getDeclaration() = decl1.getDeclaration()
+    ) and
+    //and none is close enough
+    not exists(VariableDeclarationEntry decl2 |
+      not decl2.isDefinition() and
+      decl1.getVariable().getQualifiedName() = decl2.getVariable().getQualifiedName() and
+      typesCompatible(decl1.getType(), decl2.getType())
+    )
+  )
+select decl1, "No separate compatible declaration found for this definition."
diff --git a/c/misra/test/rules/RULE-8-4/CompatibleDeclarationFunctionDefined.expected b/c/misra/test/rules/RULE-8-4/CompatibleDeclarationFunctionDefined.expected
@@ -0,0 +1,2 @@
+| function2.c:5:6:5:7 | definition of f3 |  |
+| function2.c:7:6:7:7 | definition of f4 |  |
diff --git a/c/misra/test/rules/RULE-8-4/CompatibleDeclarationFunctionDefined.qlref b/c/misra/test/rules/RULE-8-4/CompatibleDeclarationFunctionDefined.qlref
@@ -0,0 +1 @@
+rules/RULE-8-4/CompatibleDeclarationFunctionDefined.ql
diff --git a/c/misra/test/rules/RULE-8-4/CompatibleDeclarationObjectDefined.expected b/c/misra/test/rules/RULE-8-4/CompatibleDeclarationObjectDefined.expected
@@ -0,0 +1,3 @@
+| object1.c:4:12:4:13 | definition of i1 | No separate compatible declaration found for this definition. |
+| object1.c:6:5:6:6 | definition of i2 | No separate compatible declaration found for this definition. |
+| object2.c:1:7:1:8 | definition of i3 | No separate compatible declaration found for this definition. |
diff --git a/c/misra/test/rules/RULE-8-4/CompatibleDeclarationObjectDefined.qlref b/c/misra/test/rules/RULE-8-4/CompatibleDeclarationObjectDefined.qlref
@@ -0,0 +1 @@
+rules/RULE-8-4/CompatibleDeclarationObjectDefined.ql
diff --git a/c/misra/test/rules/RULE-8-4/function1.c b/c/misra/test/rules/RULE-8-4/function1.c
@@ -0,0 +1,3 @@
+extern void f1();             // COMPLIANT
+extern void f2(int x, int y); // COMPLIANT
+extern void f3(int x, int y); // NON_COMPLIANT
diff --git a/c/misra/test/rules/RULE-8-4/function2.c b/c/misra/test/rules/RULE-8-4/function2.c
@@ -0,0 +1,9 @@
+void f1() {} // COMPLIANT
+
+void f2(int x, int y) {} // COMPLIANT
+
+void f3(short x, int y) {} // NON_COMPLIANT
+
+void f4() {} // NON_COMPLIANT
+
+static void f5() {} // COMPLIANT
diff --git a/c/misra/test/rules/RULE-8-4/object1.c b/c/misra/test/rules/RULE-8-4/object1.c
@@ -0,0 +1,10 @@
+extern int i;
+i = 0; // COMPLIANT
+
+extern int i1 = 0; // NON_COMPLIANT
+
+int i2 = 0; // NON_COMPLIANT
+
+extern int i3; // NON_COMPLIANT
+
+extern int i4; // COMPLIANT
diff --git a/c/misra/test/rules/RULE-8-4/object2.c b/c/misra/test/rules/RULE-8-4/object2.c
@@ -0,0 +1,3 @@
+short i3 = 0; // NON_COMPLIANT
+
+signed int i4 = 0; // COMPLIANT
diff --git a/c/misra/test/rules/RULE-8-4/test.c b/c/misra/test/rules/RULE-8-4/test.c
diff --git a/cpp/common/src/codingstandards/cpp/Compatible.qll b/cpp/common/src/codingstandards/cpp/Compatible.qll
@@ -6,3 +6,21 @@ predicate typesCompatible(Type t1, Type t2) {
   //signed int is same as int ect
   t1.(IntegralType).getCanonicalArithmeticType() = t2.(IntegralType).getCanonicalArithmeticType()
 }
+
+predicate parameterTypesIncompatible(FunctionDeclarationEntry f1, FunctionDeclarationEntry f2) {
+  exists(ParameterDeclarationEntry p1, ParameterDeclarationEntry p2, int i |
+    p1 = f1.getParameterDeclarationEntry(i) and
+    p2 = f2.getParameterDeclarationEntry(i)
+  |
+    not typesCompatible(p1.getType(), p2.getType())
+  )
+}
+
+predicate parameterNamesIncompatible(FunctionDeclarationEntry f1, FunctionDeclarationEntry f2) {
+  exists(ParameterDeclarationEntry p1, ParameterDeclarationEntry p2, int i |
+    p1 = f1.getParameterDeclarationEntry(i) and
+    p2 = f2.getParameterDeclarationEntry(i)
+  |
+    not p1.getName() = p2.getName()
+  )
+}
diff --git a/cpp/common/src/codingstandards/cpp/exclusions/c/Declarations4.qll b/cpp/common/src/codingstandards/cpp/exclusions/c/Declarations4.qll
@@ -7,6 +7,8 @@ newtype Declarations4Query =
   TFunctionTypesNotInPrototypeFormQuery() or
   TDeclarationsOfAnObjectSameNameAndTypeQuery() or
   TDeclarationsOfAFunctionSameNameAndTypeQuery() or
+  TCompatibleDeclarationObjectDefinedQuery() or
+  TCompatibleDeclarationFunctionDefinedQuery() or
   TIdentifierWithExternalLinkageOneDefinitionQuery()
 
 predicate isDeclarations4QueryMetadata(Query query, string queryId, string ruleId) {
@@ -34,6 +36,22 @@ predicate isDeclarations4QueryMetadata(Query query, string queryId, string ruleI
     "c/misra/declarations-of-a-function-same-name-and-type" and
   ruleId = "RULE-8-3"
   or
+  query =
+    // `Query` instance for the `compatibleDeclarationObjectDefined` query
+    Declarations4Package::compatibleDeclarationObjectDefinedQuery() and
+  queryId =
+    // `@id` for the `compatibleDeclarationObjectDefined` query
+    "c/misra/compatible-declaration-object-defined" and
+  ruleId = "RULE-8-4"
+  or
+  query =
+    // `Query` instance for the `compatibleDeclarationFunctionDefined` query
+    Declarations4Package::compatibleDeclarationFunctionDefinedQuery() and
+  queryId =
+    // `@id` for the `compatibleDeclarationFunctionDefined` query
+    "c/misra/compatible-declaration-function-defined" and
+  ruleId = "RULE-8-4"
+  or
   query =
     // `Query` instance for the `identifierWithExternalLinkageOneDefinition` query
     Declarations4Package::identifierWithExternalLinkageOneDefinitionQuery() and
@@ -65,6 +83,20 @@ module Declarations4Package {
       TQueryC(TDeclarations4PackageQuery(TDeclarationsOfAFunctionSameNameAndTypeQuery()))
   }
 
+  Query compatibleDeclarationObjectDefinedQuery() {
+    //autogenerate `Query` type
+    result =
+      // `Query` type for `compatibleDeclarationObjectDefined` query
+      TQueryC(TDeclarations4PackageQuery(TCompatibleDeclarationObjectDefinedQuery()))
+  }
+
+  Query compatibleDeclarationFunctionDefinedQuery() {
+    //autogenerate `Query` type
+    result =
+      // `Query` type for `compatibleDeclarationFunctionDefined` query
+      TQueryC(TDeclarations4PackageQuery(TCompatibleDeclarationFunctionDefinedQuery()))
+  }
+
   Query identifierWithExternalLinkageOneDefinitionQuery() {
     //autogenerate `Query` type
     result =
diff --git a/rule_packages/c/Declarations4.json b/rule_packages/c/Declarations4.json
@@ -53,6 +53,48 @@
       ],
       "title": "All declarations of an object or function shall use the same names and type qualifiers"
     },
+    "RULE-8-4": {
+      "properties": {
+        "obligation": "required"
+      },
+      "queries": [
+        {
+          "description": "A compatible declaration shall be visible when an object with external linkage is defined, otherwise program behaviour may be undefined.",
+          "kind": "problem",
+          "name": "A compatible declaration shall be visible when an object with external linkage is defined",
+          "precision": "very-high",
+          "severity": "error",
+          "short_name": "CompatibleDeclarationObjectDefined",
+          "tags": [
+            "readability",
+            "maintainability",
+            "correctness"
+          ],
+          "implementation_scope": {
+            "description": "This query does not check for the recommendation of declarations in headers.",
+            "items": []
+          }
+        },
+        {
+          "description": "A compatible declaration shall be visible when a function with external linkage is defined, otherwise program behaviour may be undefined.",
+          "kind": "problem",
+          "name": "A compatible declaration shall be visible when a function with external linkage is defined",
+          "precision": "very-high",
+          "severity": "error",
+          "short_name": "CompatibleDeclarationFunctionDefined",
+          "tags": [
+            "readability",
+            "maintainability",
+            "correctness"
+          ],
+          "implementation_scope": {
+            "description": "This query does not check for the recommendation of declarations in headers.",
+            "items": []
+          }
+        }
+      ],
+      "title": "A compatible declaration shall be visible when an object or function with external linkage is defined"
+    },
     "RULE-8-6": {
       "properties": {
         "obligation": "required"
diff --git a/rules.csv b/rules.csv
@@ -649,7 +649,7 @@ c,MISRA-C-2012,RULE-7-4,Yes,Required,,,A string literal shall not be assigned to
 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,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-4,Yes,Required,,,A compatible declaration shall be visible when an object or function with external linkage is defined,,Declarations4,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,
 c,MISRA-C-2012,RULE-8-7,Yes,Advisory,,,Functions and objects should not be defined with external linkage if they are referenced in only one translation unit,,Declarations,Medium,

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+\| function2.c:5:6:5:7 \| definition of f3 \| \|`
	`2`	`+\| function2.c:7:6:7:7 \| definition of f4 \| \|`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+rules/RULE-8-4/CompatibleDeclarationFunctionDefined.ql`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+\| object1.c:4:12:4:13 \| definition of i1 \| No separate compatible declaration found for this definition. \|`
	`2`	`+\| object1.c:6:5:6:6 \| definition of i2 \| No separate compatible declaration found for this definition. \|`
	`3`	`+\| object2.c:1:7:1:8 \| definition of i3 \| No separate compatible declaration found for this definition. \|`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+rules/RULE-8-4/CompatibleDeclarationObjectDefined.ql`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+extern void f1(); // COMPLIANT`
	`2`	`+extern void f2(int x, int y); // COMPLIANT`
	`3`	`+extern void f3(int x, int y); // NON_COMPLIANT`