Finalize as Declaration6 - rule 10-1-1 properly const qualify refs & pointers.

Author: MichaelRFairhurst

…rds/cpp/exclusions/cpp/Declarations3.qll …rds/cpp/exclusions/cpp/Declarations6.qllcpp/common/src/codingstandards/cpp/exclusions/cpp/Declarations3.qll renamed to cpp/common/src/codingstandards/cpp/exclusions/cpp/Declarations6.qll cpp/common/src/codingstandards/cpp/exclusions/cpp/Declarations3.qll renamed to cpp/common/src/codingstandards/cpp/exclusions/cpp/Declarations6.qll

@@ -3,24 +3,24 @@ import cpp
 import RuleMetadata
 import codingstandards.cpp.exclusions.RuleMetadata
 
-newtype Declarations3Query = TPointerOrRefParamNotConstQuery()
+newtype Declarations6Query = TPointerOrRefParamNotConstQuery()
 
-predicate isDeclarations3QueryMetadata(Query query, string queryId, string ruleId, string category) {
+predicate isDeclarations6QueryMetadata(Query query, string queryId, string ruleId, string category) {
   query =
     // `Query` instance for the `pointerOrRefParamNotConst` query
-    Declarations3Package::pointerOrRefParamNotConstQuery() and
+    Declarations6Package::pointerOrRefParamNotConstQuery() and
   queryId =
     // `@id` for the `pointerOrRefParamNotConst` query
     "cpp/misra/pointer-or-ref-param-not-const" and
   ruleId = "RULE-10-1-1" and
   category = "advisory"
 }
 
-module Declarations3Package {
+module Declarations6Package {
   Query pointerOrRefParamNotConstQuery() {
     //autogenerate `Query` type
     result =
       // `Query` type for `pointerOrRefParamNotConst` query
-      TQueryCPP(TDeclarations3PackageQuery(TPointerOrRefParamNotConstQuery()))
+      TQueryCPP(TDeclarations6PackageQuery(TPointerOrRefParamNotConstQuery()))
   }
 }

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

@@ -28,7 +28,7 @@ import DeadCode8
 import DeadCode9
 import Declarations
 import Declarations1
-import Declarations3
+import Declarations6
 import ExceptionSafety
 import Exceptions1
 import Exceptions2
@@ -120,7 +120,7 @@ newtype TCPPQuery =
   TDeadCode9PackageQuery(DeadCode9Query q) or
   TDeclarationsPackageQuery(DeclarationsQuery q) or
   TDeclarations1PackageQuery(Declarations1Query q) or
-  TDeclarations3PackageQuery(Declarations3Query q) or
+  TDeclarations6PackageQuery(Declarations6Query q) or
   TExceptionSafetyPackageQuery(ExceptionSafetyQuery q) or
   TExceptions1PackageQuery(Exceptions1Query q) or
   TExceptions2PackageQuery(Exceptions2Query q) or
@@ -212,7 +212,7 @@ predicate isQueryMetadata(Query query, string queryId, string ruleId, string cat
   isDeadCode9QueryMetadata(query, queryId, ruleId, category) or
   isDeclarationsQueryMetadata(query, queryId, ruleId, category) or
   isDeclarations1QueryMetadata(query, queryId, ruleId, category) or
-  isDeclarations3QueryMetadata(query, queryId, ruleId, category) or
+  isDeclarations6QueryMetadata(query, queryId, ruleId, category) or
   isExceptionSafetyQueryMetadata(query, queryId, ruleId, category) or
   isExceptions1QueryMetadata(query, queryId, ruleId, category) or
   isExceptions2QueryMetadata(query, queryId, ruleId, category) or

cpp/misra/src/rules/RULE-10-1-1/PointerOrRefParamNotConst.ql

@@ -18,6 +18,7 @@
 import cpp
 import codingstandards.cpp.misra
 import codingstandards.cpp.types.Pointers
+import codingstandards.cpp.Call
 import codingstandards.cpp.SideEffect
 import codingstandards.cpp.alertreporting.HoldsForAllCopies
 
@@ -94,8 +95,7 @@ class PointerLikeParam extends Parameter {
     pointerLikeType = this.getType() and
     not pointerLikeType.pointsToConst() and
     // Exclude pointers to non-object types
-    not pointerLikeType.getInnerType() instanceof RoutineType and
-    not pointerLikeType.getInnerType() instanceof VoidType
+    not pointerLikeType.getInnerType() instanceof RoutineType
   }
 
   /**
@@ -134,6 +134,24 @@ class PointerLikeParam extends Parameter {
   }
 }
 
+predicate test(Assignment a, Field f, Parameter p, string n) {
+  a.getLValue() = f.getAnAccess() and
+  a.getRValue() = p.getAnAccess() and
+  f.getName() = "planes" and
+  n = p.getFunction().getName() and
+  a.getFile().getBaseName() = "matrix_iterator.cpp"
+}
+
+predicate test2(Parameter p) {
+  p.getName() = ["planes", "_planes"] and
+  p.getFunction().getName() = "init"
+}
+
+predicate test3(Function f, int num) {
+  f.getName() = "init" and
+  num = strictcount(Parameter p | p.getFunction() = f and p.getName() = ["planes", "_planes"])
+}
+
 /**
  * A `VariableEffect` whose target variable is a `PointerLikeParam`.
  *
@@ -176,6 +194,7 @@ class PointerLikeEffect extends VariableEffect {
 class NonConstParam extends PointerLikeParam {
   NonConstParam() {
     not pointerLikeType.pointsToConst() and
+    not pointerLikeType.getInnerType() instanceof VoidType and
     // Ignore parameters in functions without bodies
     exists(this.getFunction().getBlock()) and
     // Ignore unnamed parameters
@@ -199,14 +218,14 @@ class NonConstParam extends PointerLikeParam {
       effect.getTarget() = this and
       effect.affectsInnerType()
     ) and
-    // Exclude parameters passed as arguments to functions taking non-const pointer/ref params
-    not exists(FunctionCall fc, int i |
-      fc.getArgument(i) = this.getAPointerLikeAccess() and
-      fc.getTarget().getParameter(i).getType().(PointerLikeType).pointsToNonConst()
+    // Exclude parameters passed as arguments to non-const pointer/ref params
+    not exists(CallArgumentExpr arg |
+      arg = this.getAPointerLikeAccess() and
+      arg.getParamType().(PointerLikeType).pointsToNonConst()
     ) and
     // Exclude parameters used as qualifier for a non-const member function
     not exists(FunctionCall fc |
-      fc.getQualifier() = this.getAnAccess() and
+      fc.getQualifier() = [this.getAnAccess(), this.getAPointerLikeAccess()] and
       not fc.getTarget().hasSpecifier("const") and
       not fc.getTarget().isStatic()
     ) and
@@ -228,14 +247,25 @@ class NonConstParam extends PointerLikeParam {
       // exclude pointer to pointer and reference to pointer cases.
       addrOf.getOperand() = this.getAPointerLikeAccess() and
       addrOf.getType().(PointerLikeType).getInnerType() instanceof PointerLikeType
+    ) and
+    not exists(PointerArithmeticOperation pointerManip |
+      pointerManip.getAnOperand() = this.getAPointerLikeAccess() and
+      pointerManip.getType().(PointerLikeType).pointsToNonConst()
     )
   }
 }
 
 from NonConstParam param, Type innerType
 where
   not isExcluded(param, Declarations3Package::pointerOrRefParamNotConstQuery()) and
-  innerType = param.getPointerLikeType().getInnerType()
+  innerType = param.getPointerLikeType().getInnerType() and
+  not param.isAffectedByMacro() and
+  // Exclude functions with copied parameters which leads to wrong results.
+  count(Parameter p |
+    p.getFunction() = param.getFunction() and
+    p.getIndex() = param.getIndex()
+  ) = 1
 select param,
   "Parameter '" + param.getName() + "' points/refers to a non-const type '" + innerType.toString() +
-    "' but does not modify the target object."
+    "' but does not modify the target object in the $@.", param.getFunction().getDefinition(),
+  "function definition"