Declarations5: add RULE-8-8

knewbury01 · knewbury01 · commit f866dd52b20b · 2022-11-23T12:26:32.000-05:00
diff --git a/c/misra/src/rules/RULE-8-8/MissingStaticSpecifierFunctionRedeclarationC.ql b/c/misra/src/rules/RULE-8-8/MissingStaticSpecifierFunctionRedeclarationC.ql
@@ -0,0 +1,22 @@
+/**
+ * @id c/misra/missing-static-specifier-function-redeclaration-c
+ * @name RULE-8-8: If a function has internal linkage then all re-declarations shall include the static storage class
+ * @description If a function has internal linkage then all re-declarations shall include the static
+ *              storage class specifier to make the internal linkage explicit.
+ * @kind problem
+ * @precision very-high
+ * @problem.severity warning
+ * @tags external/misra/id/rule-8-8
+ *       readability
+ *       external/misra/obligation/required
+ */
+
+import cpp
+import codingstandards.c.misra
+import codingstandards.cpp.rules.missingstaticspecifierfunctionredeclarationshared.MissingStaticSpecifierFunctionRedeclarationShared
+
+class MissingStaticSpecifierFunctionRedeclarationCQuery extends MissingStaticSpecifierFunctionRedeclarationSharedSharedQuery {
+  MissingStaticSpecifierFunctionRedeclarationCQuery() {
+    this = Declarations5Package::missingStaticSpecifierFunctionRedeclarationCQuery()
+  }
+}
diff --git a/c/misra/src/rules/RULE-8-8/MissingStaticSpecifierObjectRedeclarationC.ql b/c/misra/src/rules/RULE-8-8/MissingStaticSpecifierObjectRedeclarationC.ql
@@ -0,0 +1,27 @@
+/**
+ * @id c/misra/missing-static-specifier-object-redeclaration-c
+ * @name RULE-8-8: If an object has internal linkage then all re-declarations shall include the static storage class
+ * @description If an object has internal linkage then all re-declarations shall include the static
+ *              storage class specifier to make the internal linkage explicit.
+ * @kind problem
+ * @precision very-high
+ * @problem.severity warning
+ * @tags external/misra/id/rule-8-8
+ *       readability
+ *       external/misra/obligation/required
+ */
+
+import cpp
+import codingstandards.c.misra
+
+from VariableDeclarationEntry redeclaration, VariableDeclarationEntry de
+where
+  not isExcluded(redeclaration,
+    Declarations5Package::missingStaticSpecifierObjectRedeclarationCQuery()) and
+  de.hasSpecifier("static") and
+  de.getDeclaration().isTopLevel() and
+  redeclaration.getDeclaration() = de.getDeclaration() and
+  not redeclaration.hasSpecifier("static") and
+  de != redeclaration
+select redeclaration, "The redeclaration of $@ with internal linkage misses the static specifier.",
+  de, de.getName()
diff --git a/c/misra/test/rules/RULE-8-8/MissingStaticSpecifierFunctionRedeclarationC.testref b/c/misra/test/rules/RULE-8-8/MissingStaticSpecifierFunctionRedeclarationC.testref
@@ -0,0 +1 @@
+cpp/common/test/rules/missingstaticspecifierfunctionredeclarationshared/MissingStaticSpecifierFunctionRedeclarationShared.ql
diff --git a/c/misra/test/rules/RULE-8-8/MissingStaticSpecifierObjectRedeclarationC.expected b/c/misra/test/rules/RULE-8-8/MissingStaticSpecifierObjectRedeclarationC.expected
@@ -0,0 +1 @@
+| test.c:2:12:2:12 | declaration of g | The redeclaration of $@ with internal linkage misses the static specifier. | test.c:1:12:1:12 | definition of g | g |
diff --git a/c/misra/test/rules/RULE-8-8/MissingStaticSpecifierObjectRedeclarationC.qlref b/c/misra/test/rules/RULE-8-8/MissingStaticSpecifierObjectRedeclarationC.qlref
@@ -0,0 +1 @@
+rules/RULE-8-8/MissingStaticSpecifierObjectRedeclarationC.ql
diff --git a/c/misra/test/rules/RULE-8-8/test.c b/c/misra/test/rules/RULE-8-8/test.c
@@ -0,0 +1,8 @@
+static int g = 0;
+extern int g; // NON_COMPLIANT
+
+static int g1;
+static int g1 = 0; // COMPLIANT
+
+int g2;
+int g2 = 0; // COMPLIANT
diff --git a/cpp/autosar/test/rules/M3-3-2/MissingStaticSpecifierOnFunctionRedeclaration.qlref b/cpp/autosar/test/rules/M3-3-2/MissingStaticSpecifierOnFunctionRedeclaration.qlref
diff --git a/cpp/autosar/test/rules/M3-3-2/MissingStaticSpecifierOnFunctionRedeclaration.testref b/cpp/autosar/test/rules/M3-3-2/MissingStaticSpecifierOnFunctionRedeclaration.testref
@@ -0,0 +1 @@
+cpp/common/test/rules/missingstaticspecifierfunctionredeclarationshared/MissingStaticSpecifierFunctionRedeclarationShared.ql
diff --git a/cpp/common/src/codingstandards/cpp/exclusions/c/Declarations5.qll b/cpp/common/src/codingstandards/cpp/exclusions/c/Declarations5.qll
@@ -5,7 +5,9 @@ import codingstandards.cpp.exclusions.RuleMetadata
 
 newtype Declarations5Query =
   TIdentifiersDeclaredInTheSameScopeNotDistinctQuery() or
-  TExternalObjectOrFunctionNotDeclaredInOneFileQuery()
+  TExternalObjectOrFunctionNotDeclaredInOneFileQuery() or
+  TMissingStaticSpecifierFunctionRedeclarationCQuery() or
+  TMissingStaticSpecifierObjectRedeclarationCQuery()
 
 predicate isDeclarations5QueryMetadata(Query query, string queryId, string ruleId) {
   query =
@@ -23,6 +25,22 @@ predicate isDeclarations5QueryMetadata(Query query, string queryId, string ruleI
     // `@id` for the `externalObjectOrFunctionNotDeclaredInOneFile` query
     "c/misra/external-object-or-function-not-declared-in-one-file" and
   ruleId = "RULE-8-5"
+  or
+  query =
+    // `Query` instance for the `missingStaticSpecifierFunctionRedeclarationC` query
+    Declarations5Package::missingStaticSpecifierFunctionRedeclarationCQuery() and
+  queryId =
+    // `@id` for the `missingStaticSpecifierFunctionRedeclarationC` query
+    "c/misra/missing-static-specifier-function-redeclaration-c" and
+  ruleId = "RULE-8-8"
+  or
+  query =
+    // `Query` instance for the `missingStaticSpecifierObjectRedeclarationC` query
+    Declarations5Package::missingStaticSpecifierObjectRedeclarationCQuery() and
+  queryId =
+    // `@id` for the `missingStaticSpecifierObjectRedeclarationC` query
+    "c/misra/missing-static-specifier-object-redeclaration-c" and
+  ruleId = "RULE-8-8"
 }
 
 module Declarations5Package {
@@ -39,4 +57,18 @@ module Declarations5Package {
       // `Query` type for `externalObjectOrFunctionNotDeclaredInOneFile` query
       TQueryC(TDeclarations5PackageQuery(TExternalObjectOrFunctionNotDeclaredInOneFileQuery()))
   }
+
+  Query missingStaticSpecifierFunctionRedeclarationCQuery() {
+    //autogenerate `Query` type
+    result =
+      // `Query` type for `missingStaticSpecifierFunctionRedeclarationC` query
+      TQueryC(TDeclarations5PackageQuery(TMissingStaticSpecifierFunctionRedeclarationCQuery()))
+  }
+
+  Query missingStaticSpecifierObjectRedeclarationCQuery() {
+    //autogenerate `Query` type
+    result =
+      // `Query` type for `missingStaticSpecifierObjectRedeclarationC` query
+      TQueryC(TDeclarations5PackageQuery(TMissingStaticSpecifierObjectRedeclarationCQuery()))
+  }
 }
diff --git a/cpp/common/src/codingstandards/cpp/rules/missingstaticspecifierfunctionredeclarationshared/MissingStaticSpecifierFunctionRedeclarationShared.qll b/cpp/common/src/codingstandards/cpp/rules/missingstaticspecifierfunctionredeclarationshared/MissingStaticSpecifierFunctionRedeclarationShared.qll
@@ -0,0 +1,25 @@
+/**
+ * Provides a library which includes a `problems` predicate for reporting....
+ */
+
+import cpp
+import codingstandards.cpp.Customizations
+import codingstandards.cpp.Exclusions
+
+abstract class MissingStaticSpecifierFunctionRedeclarationSharedSharedQuery extends Query { }
+
+Query getQuery() { result instanceof MissingStaticSpecifierFunctionRedeclarationSharedSharedQuery }
+
+query predicate problems(
+  FunctionDeclarationEntry redeclaration, string message, FunctionDeclarationEntry fde,
+  string msgpiece
+) {
+  not isExcluded(redeclaration, getQuery()) and
+  fde.hasSpecifier("static") and
+  fde.getDeclaration().isTopLevel() and
+  redeclaration.getDeclaration() = fde.getDeclaration() and
+  not redeclaration.hasSpecifier("static") and
+  fde != redeclaration and
+  message = "The redeclaration of $@ with internal linkage misses the static specifier." and
+  msgpiece = "function"
+}
diff --git a/cpp/common/test/rules/missingstaticspecifierfunctionredeclarationshared/MissingStaticSpecifierFunctionRedeclarationShared.expected b/cpp/common/test/rules/missingstaticspecifierfunctionredeclarationshared/MissingStaticSpecifierFunctionRedeclarationShared.expected
diff --git a/cpp/common/test/rules/missingstaticspecifierfunctionredeclarationshared/MissingStaticSpecifierFunctionRedeclarationShared.ql b/cpp/common/test/rules/missingstaticspecifierfunctionredeclarationshared/MissingStaticSpecifierFunctionRedeclarationShared.ql
@@ -0,0 +1,2 @@
+// GENERATED FILE - DO NOT MODIFY
+import codingstandards.cpp.rules.missingstaticspecifierfunctionredeclarationshared.MissingStaticSpecifierFunctionRedeclarationShared
diff --git a/cpp/common/test/rules/missingstaticspecifierfunctionredeclarationshared/test.cpp b/cpp/common/test/rules/missingstaticspecifierfunctionredeclarationshared/test.cpp
diff --git a/rule_packages/c/Declarations5.json b/rule_packages/c/Declarations5.json
@@ -43,6 +43,37 @@
         }
       ],
       "title": "An external object or function shall be declared once in one and only one file"
+    },
+    "RULE-8-8": {
+      "properties": {
+        "obligation": "required"
+      },
+      "queries": [
+        {
+          "description": "If a function has internal linkage then all re-declarations shall include the static storage class specifier to make the internal linkage explicit.",
+          "kind": "problem",
+          "name": "If a function has internal linkage then all re-declarations shall include the static storage class",
+          "precision": "very-high",
+          "severity": "warning",
+          "short_name": "MissingStaticSpecifierFunctionRedeclarationC",
+          "shared_implementation_short_name": "MissingStaticSpecifierFunctionRedeclarationShared",
+          "tags": [
+            "readability"
+          ]
+        },
+        {
+          "description": "If an object has internal linkage then all re-declarations shall include the static storage class specifier to make the internal linkage explicit.",
+          "kind": "problem",
+          "name": "If an object has internal linkage then all re-declarations shall include the static storage class",
+          "precision": "very-high",
+          "severity": "warning",
+          "short_name": "MissingStaticSpecifierObjectRedeclarationC",
+          "tags": [
+            "readability"
+          ]
+        }
+      ],
+      "title": "The static storage class specifier shall be used in all declarations of objects and functions that have internal linkage"
     }
   }
 }
diff --git a/rule_packages/cpp/Scope.json b/rule_packages/cpp/Scope.json
@@ -179,6 +179,7 @@
           "precision": "very-high",
           "severity": "warning",
           "short_name": "MissingStaticSpecifierOnFunctionRedeclaration",
+          "shared_implementation_short_name": "MissingStaticSpecifierFunctionRedeclarationShared",
           "tags": [
             "readability"
           ]
diff --git a/rules.csv b/rules.csv
@@ -653,7 +653,7 @@ c,MISRA-C-2012,RULE-8-4,Yes,Required,,,A compatible declaration shall be visible
 c,MISRA-C-2012,RULE-8-5,Yes,Required,,,An external object or function shall be declared once in one and only one file,,Declarations5,Medium,
 c,MISRA-C-2012,RULE-8-6,Yes,Required,,,An identifier with external linkage shall have exactly one external definition,M3-2-4,Declarations,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,
-c,MISRA-C-2012,RULE-8-8,Yes,Required,,,The static storage class specifier shall be used in all declarations of objects and functions that have internal linkage,M3-3-2,Declarations,Medium,
+c,MISRA-C-2012,RULE-8-8,Yes,Required,,,The static storage class specifier shall be used in all declarations of objects and functions that have internal linkage,M3-3-2,Declarations5,Medium,
 c,MISRA-C-2012,RULE-8-9,Yes,Advisory,,,An object should be defined at block scope if its identifier only appears in a single function,M3-4-1,Declarations,Medium,
 c,MISRA-C-2012,RULE-8-10,Yes,Required,,,An inline function shall be declared with the static storage class,,Declarations,Medium,
 c,MISRA-C-2012,RULE-8-11,Yes,Advisory,,,"When an array with external linkage is declared, its size should be explicitly specified",,Declarations,Medium,

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+cpp/common/test/rules/missingstaticspecifierfunctionredeclarationshared/MissingStaticSpecifierFunctionRedeclarationShared.ql`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+\| test.c:2:12:2:12 \| declaration of g \| The redeclaration of $@ with internal linkage misses the static specifier. \| test.c:1:12:1:12 \| definition of g \| g \|`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+rules/RULE-8-8/MissingStaticSpecifierObjectRedeclarationC.ql`