Declarations1: add rule DCL37-C

Author: knewbury01

c/cert/src/rules/DCL37-C/DoNotDeclareOrDefineAReservedIdentifier.md

@@ -0,0 +1,17 @@
+# DCL37-C: Do not declare or define a reserved identifier
+
+This query implements the CERT-C rule DCL37-C:
+
+> Do not declare or define a reserved identifier
+
+## CERT
+
+** REPLACE THIS BY RUNNING THE SCRIPT `scripts/help/cert-help-extraction.py` **
+
+## Implementation notes
+
+None
+
+## References
+
+* CERT-C: [DCL37-C: Do not declare or define a reserved identifier](https://wiki.sei.cmu.edu/confluence/display/c)

c/cert/src/rules/DCL37-C/DoNotDeclareOrDefineAReservedIdentifier.ql

@@ -0,0 +1,40 @@
+/**
+ * @id c/cert/do-not-declare-or-define-a-reserved-identifier
+ * @name DCL37-C: Do not declare or define a reserved identifier
+ * @description Declaring a reserved identifier can lead to undefined behaviour.
+ * @kind problem
+ * @precision very-high
+ * @problem.severity warning
+ * @tags external/cert/id/dcl37-c
+ *       correctness
+ *       maintainability
+ *       readability
+ *       external/cert/obligation/rule
+ */
+
+import cpp
+import codingstandards.c.cert
+import codingstandards.cpp.Naming
+import codingstandards.c.Keywords
+
+from Element m, string name
+where
+  not isExcluded(m, Declarations1Package::doNotDeclareOrDefineAReservedIdentifierQuery()) and
+  (
+    m.(Macro).hasName(name) or
+    m.(Declaration).hasGlobalName(name)
+  ) and
+  (
+    Naming::Cpp14::hasStandardLibraryMacroName(name)
+    or
+    Naming::Cpp14::hasStandardLibraryObjectName(name)
+    or
+    Naming::Cpp14::hasStandardLibraryFunctionName(name)
+    or
+    name.regexpMatch("_[A-Z_].*")
+    or
+    name.regexpMatch("_.*") and m.(Declaration).hasGlobalName(name)
+    or
+    Keywords::isKeyword(name)
+  )
+select m, "Reserved identifier '" + name + "' is declared."

c/cert/test/rules/DCL37-C/DoNotDeclareOrDefineAReservedIdentifier.expected

@@ -0,0 +1,5 @@
+| test.c:2:1:2:23 | #define _RESERVED_MACRO | Reserved identifier '_RESERVED_MACRO' is declared. |
+| test.c:11:8:11:9 | _s | Reserved identifier '_s' is declared. |
+| test.c:15:6:15:7 | _f | Reserved identifier '_f' is declared. |
+| test.c:19:7:19:12 | malloc | Reserved identifier 'malloc' is declared. |
+| test.c:24:12:24:16 | errno | Reserved identifier 'errno' is declared. |

c/cert/test/rules/DCL37-C/DoNotDeclareOrDefineAReservedIdentifier.qlref

@@ -0,0 +1 @@
+rules/DCL37-C/DoNotDeclareOrDefineAReservedIdentifier.ql

c/cert/test/rules/DCL37-C/test.c

@@ -0,0 +1,24 @@
+#ifndef _RESERVED_MACRO
+#define _RESERVED_MACRO // NON_COMPLIANT
+#endif                  /* _RESERVED_MACRO */
+
+#ifndef _not_reserved_MACRO
+#define _not_reserved_MACRO // COMPLIANT
+#endif                      /* _not_reserved_MACRO */
+
+static const int INT_LIMIT_MAX = 12000; // COMPLIANT future library directions
+
+struct _s {         // NON_COMPLIANT
+  struct _s *_next; // COMPLIANT not file scope
+};
+
+void _f() { // NON_COMPLIANT
+  int _p;   // COMPLIANT not file scope
+}
+
+void *malloc(int bytes) { // NON_COMPLIANT
+  void *ptr;
+  return ptr;
+}
+
+extern int errno; // NON_COMPLIANT

cpp/common/src/codingstandards/cpp/exclusions/c/Declarations1.qll

@@ -0,0 +1,25 @@
+//** THIS FILE IS AUTOGENERATED, DO NOT MODIFY DIRECTLY.  **/
+import cpp
+import RuleMetadata
+import codingstandards.cpp.exclusions.RuleMetadata
+
+newtype Declarations1Query = TDoNotDeclareOrDefineAReservedIdentifierQuery()
+
+predicate isDeclarations1QueryMetadata(Query query, string queryId, string ruleId) {
+  query =
+    // `Query` instance for the `doNotDeclareOrDefineAReservedIdentifier` query
+    Declarations1Package::doNotDeclareOrDefineAReservedIdentifierQuery() and
+  queryId =
+    // `@id` for the `doNotDeclareOrDefineAReservedIdentifier` query
+    "c/cert/do-not-declare-or-define-a-reserved-identifier" and
+  ruleId = "DCL37-C"
+}
+
+module Declarations1Package {
+  Query doNotDeclareOrDefineAReservedIdentifierQuery() {
+    //autogenerate `Query` type
+    result =
+      // `Query` type for `doNotDeclareOrDefineAReservedIdentifier` query
+      TQueryC(TDeclarations1PackageQuery(TDoNotDeclareOrDefineAReservedIdentifierQuery()))
+  }
+}

cpp/common/src/codingstandards/cpp/exclusions/c/RuleMetadata.qll

@@ -5,6 +5,7 @@ import codingstandards.cpp.exclusions.RuleMetadata
 import Banned
 import Concurrency1
 import Concurrency2
+import Declarations1
 import IO1
 import IO2
 import IO3
@@ -27,6 +28,7 @@ newtype TCQuery =
   TBannedPackageQuery(BannedQuery q) or
   TConcurrency1PackageQuery(Concurrency1Query q) or
   TConcurrency2PackageQuery(Concurrency2Query q) or
+  TDeclarations1PackageQuery(Declarations1Query q) or
   TIO1PackageQuery(IO1Query q) or
   TIO2PackageQuery(IO2Query q) or
   TIO3PackageQuery(IO3Query q) or
@@ -49,6 +51,7 @@ predicate isQueryMetadata(Query query, string queryId, string ruleId) {
   isBannedQueryMetadata(query, queryId, ruleId) or
   isConcurrency1QueryMetadata(query, queryId, ruleId) or
   isConcurrency2QueryMetadata(query, queryId, ruleId) or
+  isDeclarations1QueryMetadata(query, queryId, ruleId) or
   isIO1QueryMetadata(query, queryId, ruleId) or
   isIO2QueryMetadata(query, queryId, ruleId) or
   isIO3QueryMetadata(query, queryId, ruleId) or

rule_packages/c/Declarations1.json

@@ -0,0 +1,29 @@
+{
+  "CERT-C": {
+    "DCL37-C": {
+      "properties": {
+        "obligation": "rule"
+      },
+      "queries": [
+        {
+          "description": "Declaring a reserved identifier can lead to undefined behaviour.",
+          "kind": "problem",
+          "name": "Do not declare or define a reserved identifier",
+          "precision": "very-high",
+          "severity": "warning",
+          "short_name": "DoNotDeclareOrDefineAReservedIdentifier",
+          "tags": [
+            "correctness",
+            "maintainability",
+            "readability"
+          ],
+          "implementation_scope": {
+            "description": "This query does not consider identifiers described in the future library directions section of the standard. This query also checks for any reserved identifier as declared regardless of whether its header file is included or not.",
+            "items": []
+          }
+        }
+      ],
+      "title": "Do not declare or define a reserved identifier"
+    }
+  }
+}

rules.csv

@@ -501,7 +501,7 @@ c,CERT-C,CON43-C,OutOfScope,Rule,,,Do not allow data races in multithreaded code
 c,CERT-C,DCL30-C,Yes,Rule,,,Declare objects with appropriate storage durations,,Declarations,Hard,
 c,CERT-C,DCL31-C,Yes,Rule,,,Declare identifiers before using them,,Declarations,Medium,
 c,CERT-C,DCL36-C,Yes,Rule,,,Do not declare an identifier with conflicting linkage classifications,,Declarations,Medium,
-c,CERT-C,DCL37-C,Yes,Rule,,,Do not declare or define a reserved identifier,,Declarations,Easy,
+c,CERT-C,DCL37-C,Yes,Rule,,,Do not declare or define a reserved identifier,,Declarations1,Easy,
 c,CERT-C,DCL38-C,Yes,Rule,,,Use the correct syntax when declaring a flexible array member,,Declarations,Easy,
 c,CERT-C,DCL39-C,Yes,Rule,,,Avoid information leakage when passing a structure across a trust boundary,,Declarations,Hard,
 c,CERT-C,DCL40-C,Yes,Rule,,,Do not create incompatible declarations of the same function or object,,Declarations,Hard,