Add Banned5

Author: jeongsoolee09

cpp/common/src/codingstandards/cpp/exclusions/cpp/Banned5.qll

@@ -0,0 +1,26 @@
+//** THIS FILE IS AUTOGENERATED, DO NOT MODIFY DIRECTLY.  **/
+import cpp
+import RuleMetadata
+import codingstandards.cpp.exclusions.RuleMetadata
+
+newtype Banned5Query = TBitFieldsShouldNotBeDeclaredQuery()
+
+predicate isBanned5QueryMetadata(Query query, string queryId, string ruleId, string category) {
+  query =
+    // `Query` instance for the `bitFieldsShouldNotBeDeclared` query
+    Banned5Package::bitFieldsShouldNotBeDeclaredQuery() and
+  queryId =
+    // `@id` for the `bitFieldsShouldNotBeDeclared` query
+    "cpp/misra/bit-fields-should-not-be-declared" and
+  ruleId = "RULE-12-2-1" and
+  category = "advisory"
+}
+
+module Banned5Package {
+  Query bitFieldsShouldNotBeDeclaredQuery() {
+    //autogenerate `Query` type
+    result =
+      // `Query` type for `bitFieldsShouldNotBeDeclared` query
+      TQueryCPP(TBanned5PackageQuery(TBitFieldsShouldNotBeDeclaredQuery()))
+  }
+}

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

@@ -4,6 +4,7 @@ import codingstandards.cpp.exclusions.RuleMetadata
 //** Import packages for this language **/
 import Allocations
 import Banned1
+import Banned5
 import Banned8
 import BannedAPIs
 import BannedFunctions
@@ -96,6 +97,7 @@ import VirtualFunctions
 newtype TCPPQuery =
   TAllocationsPackageQuery(AllocationsQuery q) or
   TBanned1PackageQuery(Banned1Query q) or
+  TBanned5PackageQuery(Banned5Query q) or
   TBanned8PackageQuery(Banned8Query q) or
   TBannedAPIsPackageQuery(BannedAPIsQuery q) or
   TBannedFunctionsPackageQuery(BannedFunctionsQuery q) or
@@ -188,6 +190,7 @@ newtype TCPPQuery =
 predicate isQueryMetadata(Query query, string queryId, string ruleId, string category) {
   isAllocationsQueryMetadata(query, queryId, ruleId, category) or
   isBanned1QueryMetadata(query, queryId, ruleId, category) or
+  isBanned5QueryMetadata(query, queryId, ruleId, category) or
   isBanned8QueryMetadata(query, queryId, ruleId, category) or
   isBannedAPIsQueryMetadata(query, queryId, ruleId, category) or
   isBannedFunctionsQueryMetadata(query, queryId, ruleId, category) or

cpp/common/src/codingstandards/cpp/rules/bitfieldsshallbeusedonlywheninterfacingtohardwareorconformingtocommunicationprotocols/BitFieldsShallBeUsedOnlyWhenInterfacingToHardwareOrConformingToCommunicationProtocols.qll

@@ -0,0 +1,20 @@
+/**
+ * Provides a configurable module BitFieldsShallBeUsedOnlyWhenInterfacingToHardwareOrConformingToCommunicationProtocols with a `problems` predicate
+ * for the following issue:
+ * The exact layout and the order of bits resulting from bit-fields in a struct is
+ * implementation-defined and therefore not portable.
+ */
+
+import cpp
+import codingstandards.cpp.Customizations
+import codingstandards.cpp.Exclusions
+
+signature module BitFieldsShallBeUsedOnlyWhenInterfacingToHardwareOrConformingToCommunicationProtocolsConfigSig {
+  Query getQuery();
+}
+
+module BitFieldsShallBeUsedOnlyWhenInterfacingToHardwareOrConformingToCommunicationProtocols<BitFieldsShallBeUsedOnlyWhenInterfacingToHardwareOrConformingToCommunicationProtocolsConfigSig Config> {
+  query predicate problems(Element e, string message) {
+    not isExcluded(e, Config::getQuery()) and message = "<replace with problem alert message for >"
+  }
+}

cpp/common/test/rules/bitfieldsshallbeusedonlywheninterfacingtohardwareorconformingtocommunicationprotocols/BitFieldsShallBeUsedOnlyWhenInterfacingToHardwareOrConformingToCommunicationProtocols.expected

@@ -0,0 +1 @@
+No expected results have yet been specified

cpp/common/test/rules/bitfieldsshallbeusedonlywheninterfacingtohardwareorconformingtocommunicationprotocols/BitFieldsShallBeUsedOnlyWhenInterfacingToHardwareOrConformingToCommunicationProtocols.ql

@@ -0,0 +1,8 @@
+// GENERATED FILE - DO NOT MODIFY
+import codingstandards.cpp.rules.bitfieldsshallbeusedonlywheninterfacingtohardwareorconformingtocommunicationprotocols.BitFieldsShallBeUsedOnlyWhenInterfacingToHardwareOrConformingToCommunicationProtocols
+
+module TestFileConfig implements BitFieldsShallBeUsedOnlyWhenInterfacingToHardwareOrConformingToCommunicationProtocolsConfigSig {
+  Query getQuery() { result instanceof TestQuery }
+}
+
+import BitFieldsShallBeUsedOnlyWhenInterfacingToHardwareOrConformingToCommunicationProtocols<TestFileConfig>

cpp/common/test/rules/bitfieldsshallbeusedonlywheninterfacingtohardwareorconformingtocommunicationprotocols/test.cpp

@@ -0,0 +1,24 @@
+/**
+ * @id cpp/misra/bit-fields-should-not-be-declared
+ * @name RULE-12-2-1: Bit-fields should not be declared
+ * @description The exact layout and the order of bits resulting from bit-fields in a struct is
+ *              implementation-defined and therefore not portable.
+ * @kind problem
+ * @precision very-high
+ * @problem.severity error
+ * @tags external/misra/id/rule-12-2-1
+ *       scope/single-translation-unit
+ *       correctness
+ *       external/misra/enforcement/decidable
+ *       external/misra/obligation/advisory
+ */
+
+import cpp
+import codingstandards.cpp.misra
+import codingstandards.cpp.rules.bitfieldsshallbeusedonlywheninterfacingtohardwareorconformingtocommunicationprotocols.BitFieldsShallBeUsedOnlyWhenInterfacingToHardwareOrConformingToCommunicationProtocols
+
+module BitFieldsShouldNotBeDeclaredConfig implements BitFieldsShallBeUsedOnlyWhenInterfacingToHardwareOrConformingToCommunicationProtocolsConfigSig {
+  Query getQuery() { result = Banned5Package::bitFieldsShouldNotBeDeclaredQuery() }
+}
+
+import BitFieldsShallBeUsedOnlyWhenInterfacingToHardwareOrConformingToCommunicationProtocols<BitFieldsShouldNotBeDeclaredConfig>

cpp/misra/src/rules/RULE-12-2-1/BitFieldsShouldNotBeDeclared.ql

@@ -0,0 +1 @@
+cpp/common/test/rules/bitfieldsshallbeusedonlywheninterfacingtohardwareorconformingtocommunicationprotocols/BitFieldsShallBeUsedOnlyWhenInterfacingToHardwareOrConformingToCommunicationProtocols.ql

cpp/misra/test/rules/RULE-12-2-1/BitFieldsShouldNotBeDeclared.testref

@@ -0,0 +1,26 @@
+{
+  "MISRA-C++-2023": {
+    "RULE-12-2-1": {
+      "properties": {
+        "enforcement": "decidable",
+        "obligation": "advisory"
+      },
+      "queries": [
+        {
+          "description": "The exact layout and the order of bits resulting from bit-fields in a struct is implementation-defined and therefore not portable.",
+          "kind": "problem",
+          "name": "Bit-fields should not be declared",
+          "precision": "very-high",
+          "severity": "error",
+          "short_name": "BitFieldsShouldNotBeDeclared",
+          "shared_implementation_short_name": "BitFieldsShallBeUsedOnlyWhenInterfacingToHardwareOrConformingToCommunicationProtocols",
+          "tags": [
+            "scope/single-translation-unit",
+            "correctness"
+          ]
+        }
+      ],
+      "title": "Bit-fields should not be declared"
+    }
+  }
+}

rule_packages/cpp/Banned5.json

@@ -15,7 +15,8 @@
           "name": "Bit-fields shall be used only when interfacing to hardware or conforming to communication protocols",
           "precision": "very-high",
           "severity": "recommendation",
-          "short_name": "BitFieldsShallBeUsedOnlyWhenInterfacingToHardwareOrConformingToCommunicationProtocols",
+          "short_name": "BitFieldsShallBeUsedOnlyWhenInterfacingToHardwareOrConformingToCommunicationProtocolsAutosarCpp",
+          "shared_implementation_short_name": "BitFieldsShallBeUsedOnlyWhenInterfacingToHardwareOrConformingToCommunicationProtocols",
           "tags": [
             "maintainability"
           ]