Merge pull request #1105 from github/jeongsoolee09/MISRA-C++-2023-Banned7

Add Banned7 package

Author: jeongsoolee09

cpp/common/src/codingstandards/cpp/DynamicMemory.qll

@@ -0,0 +1,26 @@
+/** Provides classes for modeling dynamic memory allocation and deallocation functions. */
+
+import cpp
+
+/**
+ * A function that has namespace `std` and has name `allocate` or `deallocate`, including but
+ * not limited to:
+ * - `std::allocator<T>::allocate(std::size_t)`
+ * - `std::allocator<T>::deallocate(T*, std::size_t)`
+ * - `std::pmr::memory_resource::allocate(std::size_t, std::size_t)`
+ * - `std::pmr::memory_resource::deallocate(void*, std::size_t, std::size_t)`
+ */
+class AllocateOrDeallocateStdlibMemberFunction extends MemberFunction {
+  AllocateOrDeallocateStdlibMemberFunction() {
+    this.getName() in ["allocate", "deallocate"] and
+    this.getNamespace().getParentNamespace*() instanceof StdNamespace
+  }
+}
+
+class StdAllocator extends Class {
+  StdAllocator() { this.hasGlobalOrStdName("allocator") }
+}
+
+class StdPmrMemoryResource extends Class {
+  StdPmrMemoryResource() { this.hasQualifiedName("std::pmr", "memory_resource") }
+}

cpp/common/src/codingstandards/cpp/allocations/CustomOperatorNewDelete.qll

@@ -1,3 +1,10 @@
+/**
+ * Provides classes to help reasoning about `operator new`, `operator new[]`,
+ * `operator delete`, and `operator delete[]`.
+ *
+ * These are described in section [support.dynamic] of the C++ standard.
+ */
+
 import cpp
 import codingstandards.cpp.Handlers
 
@@ -21,6 +28,13 @@ abstract class OperatorNewOrDelete extends Operator {
   }
 }
 
+/**
+ * An `operator new` and `operator new[]` function described in [new.delete.single]
+ * and [new.delete.array], respectively.
+ *
+ * Note that these do not include [new.delete.placement]. These are captured in
+ * `PlacementOperatorNew`.
+ */
 class ReplaceableOperatorNew extends OperatorNewOrDelete {
   ReplaceableOperatorNew() {
     this.getName().regexpMatch("operator new(\\[\\])?") and
@@ -34,6 +48,12 @@ class ReplaceableOperatorNew extends OperatorNewOrDelete {
   }
 }
 
+/**
+ * `operator new`, `operator new[]`, `operator delete`, or `operator delete[]` functions
+ * that are very likely provided by the user.
+ *
+ * Note that this captures _any_ function that has one of the above four names.
+ */
 class CustomOperatorNewOrDelete extends OperatorNewOrDelete {
   CustomOperatorNewOrDelete() {
     this.hasDefinition() and
@@ -60,8 +80,18 @@ class CustomOperatorNewOrDelete extends OperatorNewOrDelete {
   }
 }
 
+/**
+ * The replaceable `operator new` or `operator new[]` functions that have custom
+ * definitions provided by the user.
+ *
+ * Also see `CustomReplaceableOperatorDelete`.
+ */
 class CustomReplaceableOperatorNew extends CustomOperatorNewOrDelete, ReplaceableOperatorNew { }
 
+/**
+ * An `operator delete` or `operator delete[]` deallocation function described in
+ * [new.delete.single] and [new.delete.array], respectively.
+ */
 class ReplaceableOperatorDelete extends OperatorNewOrDelete {
   ReplaceableOperatorDelete() {
     this.getName().regexpMatch("operator delete(\\[\\])?") and
@@ -85,6 +115,12 @@ class ReplaceableOperatorDelete extends OperatorNewOrDelete {
   }
 }
 
+/**
+ * The replaceable `operator new` or `operator new[]` functions that have custom
+ * definitions provided by the user.
+ *
+ * Also see `CustomReplaceableOperatorNew`.
+ */
 class CustomReplaceableOperatorDelete extends CustomOperatorNewOrDelete, ReplaceableOperatorDelete {
   CustomReplaceableOperatorDelete getPartner() {
     if this.getAParameter().getType() instanceof Size_t
@@ -95,3 +131,18 @@ class CustomReplaceableOperatorDelete extends CustomOperatorNewOrDelete, Replace
     else result.getPartner() = this
   }
 }
+
+/**
+ * An `operator new` or `operator new[]` allocation function called by a placement-new expression,
+ * as described in [new.delete.placement].
+ *
+ * The operator functions have a `std::size_t` as their first parameter and a
+ * `void*` parameter somewhere in the rest of the parameter list.
+ */
+class PlacementOperatorNew extends AllocationFunction {
+  PlacementOperatorNew() {
+    this.getName() in ["operator new", "operator new[]"] and
+    this.getParameter(0).getType().resolveTypedefs*() instanceof Size_t and
+    this.getAParameter().getUnderlyingType() instanceof VoidPointerType
+  }
+}

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

@@ -0,0 +1,26 @@
+//** THIS FILE IS AUTOGENERATED, DO NOT MODIFY DIRECTLY.  **/
+import cpp
+import RuleMetadata
+import codingstandards.cpp.exclusions.RuleMetadata
+
+newtype Banned7Query = TDynamicMemoryShouldNotBeUsedQuery()
+
+predicate isBanned7QueryMetadata(Query query, string queryId, string ruleId, string category) {
+  query =
+    // `Query` instance for the `dynamicMemoryShouldNotBeUsed` query
+    Banned7Package::dynamicMemoryShouldNotBeUsedQuery() and
+  queryId =
+    // `@id` for the `dynamicMemoryShouldNotBeUsed` query
+    "cpp/misra/dynamic-memory-should-not-be-used" and
+  ruleId = "RULE-21-6-1" and
+  category = "advisory"
+}
+
+module Banned7Package {
+  Query dynamicMemoryShouldNotBeUsedQuery() {
+    //autogenerate `Query` type
+    result =
+      // `Query` type for `dynamicMemoryShouldNotBeUsed` query
+      TQueryCPP(TBanned7PackageQuery(TDynamicMemoryShouldNotBeUsedQuery()))
+  }
+}

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

@@ -9,6 +9,7 @@ import Banned3
 import Banned4
 import Banned5
 import Banned6
+import Banned7
 import Banned8
 import BannedAPIs
 import BannedFunctions
@@ -116,6 +117,7 @@ newtype TCPPQuery =
   TBanned4PackageQuery(Banned4Query q) or
   TBanned5PackageQuery(Banned5Query q) or
   TBanned6PackageQuery(Banned6Query q) or
+  TBanned7PackageQuery(Banned7Query q) or
   TBanned8PackageQuery(Banned8Query q) or
   TBannedAPIsPackageQuery(BannedAPIsQuery q) or
   TBannedFunctionsPackageQuery(BannedFunctionsQuery q) or
@@ -223,6 +225,7 @@ predicate isQueryMetadata(Query query, string queryId, string ruleId, string cat
   isBanned4QueryMetadata(query, queryId, ruleId, category) or
   isBanned5QueryMetadata(query, queryId, ruleId, category) or
   isBanned6QueryMetadata(query, queryId, ruleId, category) or
+  isBanned7QueryMetadata(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/test/includes/standard-library/any

@@ -0,0 +1 @@
+#include <any.h>

cpp/common/test/includes/standard-library/any.h

@@ -0,0 +1,16 @@
+#ifndef _GHLIBCPP_ANY
+#define _GHLIBCPP_ANY
+namespace std {
+
+class any {
+public:
+  any();
+  any(const any &);
+  any(any &&);
+  ~any();
+  template <typename T> any(T &&);
+};
+
+} // namespace std
+
+#endif // _GHLIBCPP_ANY

cpp/common/test/includes/standard-library/bitset

@@ -0,0 +1 @@
+#include <bitset.h>

cpp/common/test/includes/standard-library/bitset.h

@@ -0,0 +1,18 @@
+// stubs/bitset
+
+#ifndef _GHLIBCPP_BITSET
+#define _GHLIBCPP_BITSET
+
+#include <cstddef>
+
+namespace std {
+
+template <std::size_t N> class bitset {
+public:
+  bitset();
+  bitset(unsigned long long);
+};
+
+} // namespace std
+
+#endif // _GHLIBCPP_BITSET

cpp/common/test/includes/standard-library/deque.h

@@ -1,10 +1,10 @@
 #ifndef _GHLIBCPP_DEQUE
 #define _GHLIBCPP_DEQUE
-#include <iterator>
-#include <string>
 #include "memory.h"
-#include <initializer_list>
 #include <empty.h>
+#include <initializer_list>
+#include <iterator>
+#include <string>
 
 namespace std {
 template <class T, class Allocator = std::allocator<T>> class deque {
@@ -14,8 +14,11 @@ template <class T, class Allocator = std::allocator<T>> class deque {
   typedef value_type &reference;
   typedef const value_type &const_reference;
 
-  deque() = default;
+  deque();
+  deque(const deque &);
+  deque(deque &&);
   deque(std::initializer_list<T>, const Allocator & = Allocator());
+  ~deque();
 
   typedef __iterator<T> iterator;
   typedef __iterator<T> const_iterator;
@@ -40,4 +43,4 @@ template <class T, class Allocator = std::allocator<T>> class deque {
 };
 } // namespace std
 
-#endif // _GHLIBCPP_DEQUE
+#endif // _GHLIBCPP_DEQUE

cpp/common/test/includes/standard-library/filesystem

@@ -0,0 +1 @@
+#include <filesystem.h>