Impose new hierarchy among operator new / delete

Author: jeongsoolee09

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

@@ -21,70 +21,73 @@ abstract class OperatorNewOrDelete extends Operator {
   }
 }
 
-/** An `operator` that implements one of the `[replacement.functions]`. */
-abstract class CustomOperatorNewOrDelete extends OperatorNewOrDelete {
+class ReplaceableOperatorNew extends OperatorNewOrDelete {
+  ReplaceableOperatorNew() {
+    this.getName().regexpMatch("operator new(\\[\\])?") and
+    this.getParameter(0).getType() instanceof Size_t and
+    (
+      this.getNumberOfParameters() = 1
+      or
+      this.getNumberOfParameters() = 2 and
+      this.getParameter(1).getType() instanceof ConstNoThrowTReferenceType
+    )
+  }
+}
+
+class CustomOperatorNewOrDelete extends OperatorNewOrDelete {
   CustomOperatorNewOrDelete() {
+    this.hasDefinition() and
     // Not in the standard library
-    exists(getFile().getRelativePath()) and
+    exists(this.getFile().getRelativePath()) and
     // Not in a file called `new`, which is likely to be a copy of the standard library
     // as it is in our tests
-    not getFile().getBaseName() = "new"
+    not this.getFile().getBaseName() = "new"
   }
 
   /**
    * Holds if this is a an allocation function that takes a `const std::nothrow_t&`.
    */
   predicate isNoThrowAllocation() {
-    getAParameter().getType() instanceof ConstNoThrowTReferenceType
+    this.getAParameter().getType() instanceof ConstNoThrowTReferenceType
   }
 
   /** Get the description of this custom allocator. */
   string getAllocDescription() {
     result =
-      getName() + "(" +
-        concat(Parameter p, int i | p = getParameter(i) | p.getType().getName(), "," order by i) +
-        ")"
+      this.getName() + "(" +
+        concat(Parameter p, int i | p = this.getParameter(i) | p.getType().getName(), "," order by i)
+        + ")"
   }
 }
 
-class CustomOperatorNew extends CustomOperatorNewOrDelete {
-  CustomOperatorNew() {
-    hasDefinition() and
-    getName().regexpMatch("operator new(\\[\\])?") and
-    getParameter(0).getType() instanceof Size_t and
-    (
-      getNumberOfParameters() = 1
-      or
-      getNumberOfParameters() = 2 and
-      getParameter(1).getType() instanceof ConstNoThrowTReferenceType
-    )
-  }
-}
+class CustomReplaceableOperatorNew extends CustomOperatorNewOrDelete, ReplaceableOperatorNew { }
 
-class CustomOperatorDelete extends CustomOperatorNewOrDelete {
-  CustomOperatorDelete() {
-    getName().regexpMatch("operator delete(\\[\\])?") and
-    getParameter(0).getType() instanceof VoidPointerType and
+class ReplaceableOperatorDelete extends OperatorNewOrDelete {
+  ReplaceableOperatorDelete() {
+    this.getName().regexpMatch("operator delete(\\[\\])?") and
+    this.getParameter(0).getType() instanceof VoidPointerType and
     (
-      getNumberOfParameters() = 1
+      this.getNumberOfParameters() = 1
       or
-      getNumberOfParameters() = 2 and
+      this.getNumberOfParameters() = 2 and
       (
-        getParameter(1).getType() instanceof ConstNoThrowTReferenceType
+        this.getParameter(1).getType() instanceof ConstNoThrowTReferenceType
         or
-        getParameter(1).getType() instanceof Size_t
+        this.getParameter(1).getType() instanceof Size_t
       )
       or
-      getNumberOfParameters() = 3 and
+      this.getNumberOfParameters() = 3 and
       (
-        getParameter(1).getType() instanceof Size_t and
-        getParameter(2).getType() instanceof ConstNoThrowTReferenceType
+        this.getParameter(1).getType() instanceof Size_t and
+        this.getParameter(2).getType() instanceof ConstNoThrowTReferenceType
       )
     )
   }
+}
 
-  CustomOperatorDelete getPartner() {
-    if getAParameter().getType() instanceof Size_t
+class CustomReplaceableOperatorDelete extends CustomOperatorNewOrDelete, ReplaceableOperatorDelete {
+  CustomReplaceableOperatorDelete getPartner() {
+    if this.getAParameter().getType() instanceof Size_t
     then
       result.getAllocDescription() = this.getAllocDescription().replaceAll(",size_t", "") and
       // Linked together in the same target

cpp/common/src/codingstandards/cpp/rules/operatordeletemissingpartner/OperatorDeleteMissingPartner.qll

@@ -36,7 +36,7 @@ Query getQuery() { result instanceof OperatorDeleteMissingPartnerSharedQuery }
  * void operator delete[](void*, std::size_t, const std::nothrow_t&)
  */
 
-query predicate problems(CustomOperatorDelete cd, string message) {
+query predicate problems(CustomReplaceableOperatorDelete cd, string message) {
   not isExcluded(cd, getQuery()) and
   not exists(cd.getPartner()) and
   if cd.getAParameter().getType() instanceof Size_t

cpp/common/src/codingstandards/cpp/rules/throwingoperatornewreturnsnull/ThrowingOperatorNewReturnsNull.qll

@@ -31,7 +31,7 @@ module NullConfig implements DataFlow::ConfigSig {
   }
 
   predicate isSink(DataFlow::Node sink) {
-    exists(CustomOperatorNew co, ReturnStmt rs |
+    exists(CustomReplaceableOperatorNew co, ReturnStmt rs |
       co.getNumberOfParameters() = 1 and
       rs.getEnclosingFunction() = co and
       rs.getExpr() = sink.asExpr()
@@ -47,7 +47,7 @@ query predicate problems(
   not isExcluded(e, getQuery()) and
   NullFlow::flowPath(source, sink) and
   sink.getNode().asExpr() = e.getExpr() and
-  exists(CustomOperatorNew op |
+  exists(CustomReplaceableOperatorNew op |
     message =
       op.getAllocDescription() + " may return null instead of throwing a std::bad_alloc exception."
   )

cpp/common/src/codingstandards/cpp/rules/throwingoperatornewthrowsinvalidexception/ThrowingOperatorNewThrowsInvalidException.qll

@@ -15,7 +15,7 @@ abstract class ThrowingOperatorNewThrowsInvalidExceptionSharedQuery extends Quer
 Query getQuery() { result instanceof ThrowingOperatorNewThrowsInvalidExceptionSharedQuery }
 
 class ThrowingCustomOperatorNew extends ExceptionThrowingFunction {
-  CustomOperatorNew op;
+  CustomReplaceableOperatorNew op;
 
   ThrowingCustomOperatorNew() {
     this = op and

cpp/misra/src/rules/RULE-21-6-3/AdvancedMemoryManagementUsed.ql

@@ -38,7 +38,7 @@ class AdvancedMemoryManagementFunction extends Function {
 class NonStandardNewOrNewArrayOperator extends OperatorNewOrDelete {
   NonStandardNewOrNewArrayOperator() {
     this.getName() in ["operator new", "operator new[]"] and
-    not this instanceof CustomOperatorNew // `CustomOperatorNew` only detects replaceable allocation functions.
+    not this instanceof CustomReplaceableOperatorNew // `CustomReplaceableOperatorNew` only detects replaceable allocation functions.
   }
 }
 
@@ -61,7 +61,7 @@ class UserDeclaredOperatorNewOrDelete extends FunctionDeclarationEntry {
 class NonStandardDeleteOrDeleteArrayOperator extends OperatorNewOrDelete {
   NonStandardDeleteOrDeleteArrayOperator() {
     this.getName() in ["operator delete", "operator delete[]"] and
-    not this instanceof CustomOperatorDelete // `CustomOperatorDelete` only detects replaceable deallocation functions.
+    not this instanceof CustomReplaceableOperatorDelete // `CustomReplaceableOperatorDelete` only detects replaceable deallocation functions.
   }
 }