Merge branch 'main' into rvermeulen/fix-392

Author: rvermeulen

change_notes/2023-12-07-fix-deviations.md

@@ -0,0 +1,2 @@
+ - The following queries have been updated to address issues with applying deviations:
+   - `A18-5-11`, `A23-0-1`, `A9-3-1`, `M0-1-2`, `M3-1-2`, `M3-2-1`, `M3-2-3`, `M3-9-1`, `M4-5-3`, `M5-0-2`, `M5-2-10`, `A23-0-2`, `CTR51-CPP`, `STR52-CPP`

change_notes/2024-02-16-fix-fps-a5-1-1.md

@@ -0,0 +1,7 @@
+- `A5-1-1` - `LiteralValueUsedOutsideTypeInit.ql`:
+  - Address FP reported in #371. Exclude literals generated by uses of constexpr variables.
+  - Exclude literals used in class template instantiations.
+  - Update the alert message to adhere to the style-guide.
+  - Exclude boolean literals used as template arguments.
+  - Exclude `u` and `U` prefixed char literals.
+  - Exclude literals part of a class aggregate literal.

change_notes/2024-02-22-fix-fp-a5-0-2-and-change-alert-m5-3-1.md

@@ -0,0 +1,4 @@
+- `A5-0-2` - `NonBooleanIterationCondition.ql`:
+  - Address FP reported in #10. Exclude conditions in uninstantiated templates.
+- `M5-3-1` - `EachOperandOfTheOperatorTheLogicalAndOrTheLogicalOperatorsShallHaveTypeBool.ql`:
+  - Adjust the alert message to comply with the style guide.

change_notes/2024-02-26-exclusion-M5-14-1.md

@@ -0,0 +1,2 @@
+- `M5-14-1` - `RightHandOperandOfALogicalAndOperatorsContainSideEffects.ql`:
+    - Fix FP reported in #375. Addresses incorrect detection of side effects in unevaluated contexts.

change_notes/2024-03-04-fix-fp-a16-2-2.md

@@ -0,0 +1,2 @@
+- `A16-2-2` - `UnusedIncludeDirectives.ql`:
+  - Address FP reported in #453. Exclude reporting of redundant include directives indirectly included by included files.

change_notes/2024-03-04-improve-a8-4-7.md

@@ -0,0 +1,3 @@
+- `A8-4-7` - `InParametersForNotCheapToCopyTypesNotPassedByReference.ql`, `InParametersForCheapToCopyTypesNotPassedByValue.ql`:
+  - Improve coverage of the query by additionally alerting to non-trivially-copyable types being passed by value.
+  - Non-trivially-copyable types not passed by value will no longer be incorrectly reported.

cpp/autosar/src/rules/A16-2-2/UnusedIncludeDirectives.ql

@@ -223,10 +223,19 @@ private predicate firstReliableProvide(File f, File g, int line) {
 
 cached
 predicate mayProvideFirst(IncludeDepends i, File g) {
-  // i may provide g and does not come after a reliable include of g.
+  // i may provide g
   i.provides(g) and
-  not exists(int line | firstReliableProvide(i.getFile(), g, line) |
-    line < i.getLocation().getStartLine()
+  (
+    // and does not come after a reliable include of g.
+    not exists(int line | firstReliableProvide(i.getFile(), g, line) |
+      line < i.getLocation().getStartLine()
+    )
+    or
+    // or it comes after a reliable include of g, and although redundant,
+    // is not necessarily an issue e.g. in the case of libraries with
+    // public header forwards to an internal header.
+    // therefore, hold for transitive includes as well to exclude those results.
+    not i.getIncludedFile() = g
   )
 }
 

cpp/autosar/src/rules/A18-5-11/OperatorNewAndOperatorDeleteNotDefinedLocally.ql

@@ -19,7 +19,8 @@ import codingstandards.cpp.autosar
 
 from MemberFunction operator_new, Class c
 where
-  not isExcluded(operator_new) and
+  not isExcluded(operator_new,
+    DeclarationsPackage::operatorNewAndOperatorDeleteNotDefinedLocallyQuery()) and
   not isExcluded(c, DeclarationsPackage::operatorNewAndOperatorDeleteNotDefinedLocallyQuery()) and
   operator_new.hasName("operator new") and
   operator_new.getDeclaringType() = c and

cpp/autosar/src/rules/A23-0-1/IteratorImplicitlyConvertedToConstIterator.ql

@@ -40,8 +40,8 @@ import codingstandards.cpp.Iterators
 
 from ConstIteratorVariable v, STLContainer c, Expr e
 where
-  not isExcluded(v) and
-  not isExcluded(e) and
+  not isExcluded(v, IteratorsPackage::iteratorImplicitlyConvertedToConstIteratorQuery()) and
+  not isExcluded(e, IteratorsPackage::iteratorImplicitlyConvertedToConstIteratorQuery()) and
   e = v.getAnAssignedValue() and
   e.getAChild*() = /* see note at top of query */ c.getANonConstIteratorFunctionCall()
 select e, "Non-const version of container call immediately converted to a `const_iterator`."

cpp/autosar/src/rules/A5-1-1/LiteralValueUsedOutsideTypeInit.ql

@@ -18,6 +18,7 @@ import cpp
 import codingstandards.cpp.autosar
 import codingstandards.cpp.LoggingOperation
 import codingstandards.cpp.Literals
+import codingstandards.cpp.Cpp14Literal
 
 from Literal l
 where
@@ -35,11 +36,11 @@ where
   // Exclude literal 0
   not l.getValue() = "0" and
   // Exclude character literals
-  not l instanceof CharLiteral and
+  not l instanceof Cpp14Literal::CharLiteral and
   // Exclude `nullptr`
   not l.getType() instanceof NullPointerType and
   // Exclude boolean `true` and `false`
-  not l.getType() instanceof BoolType and
+  not l instanceof BoolLiteral and
   // Exclude empty string
   not l.getValue() = "" and
   // Template functions use literals to represent calls which are unknown
@@ -51,7 +52,14 @@ where
   // Aggregate literal
   not l = any(ArrayOrVectorAggregateLiteral aal).getAnElementExpr(_).getAChild*() and
   // Ignore x - 1 expressions
-  not exists(SubExpr se | se.getRightOperand() = l and l.getValue() = "1")
-select l,
-  "Literal value " + getTruncatedLiteralText(l) + " used outside of type initialization " +
-    l.getAPrimaryQlClass()
+  not exists(SubExpr se | se.getRightOperand() = l and l.getValue() = "1") and
+  // Exclude compile time computed integral literals as they can appear as integral literals
+  // when used as non-type template arguments.
+  // We limit ourselves to integral literals, because floating point literals as non-type
+  // template arguments are not supported in C++ 14. Those are supported shince C++ 20.
+  not l instanceof CompileTimeComputedIntegralLiteral and
+  // Exclude literals to instantiate a class template per example in the standard
+  // where an type of std::array is intialized with size 5.
+  not l = any(ClassTemplateInstantiation cti).getATemplateArgument() and
+  not l = any(ClassAggregateLiteral cal).getAFieldExpr(_)
+select l, "Literal value '" + getTruncatedLiteralText(l) + "' used outside of type initialization."

cpp/autosar/src/rules/A8-4-7/InParametersForCheapToCopyTypesNotPassedByValue.ql

@@ -15,7 +15,7 @@
 
 import cpp
 import codingstandards.cpp.autosar
-import TriviallySmallType
+import TriviallyCopyableSmallType
 import codingstandards.cpp.CommonTypes as CommonTypes
 import codingstandards.cpp.Class
 
@@ -26,7 +26,7 @@ import codingstandards.cpp.Class
  * In this rule, we will look cases where a "cheap to copy" type is not passed by value.
  */
 
-from Parameter v, TriviallySmallType t
+from Parameter v, TriviallyCopyableSmallType t
 where
   not isExcluded(v, ClassesPackage::inParametersForCheapToCopyTypesNotPassedByValueQuery()) and
   exists(ReferenceType rt |
@@ -40,5 +40,6 @@ where
   not v.isFromUninstantiatedTemplate(_) and
   not v.isFromTemplateInstantiation(_)
 select v,
-  "Parameter '" + v.getName() + "' is the trivially copyable type '" + t.getName() +
-    "' but it is passed by reference instead of by value."
+  "Parameter '" + v.getName() +
+    "' is the trivially copyable type $@ but it is passed by reference instead of by value.", t,
+  t.getName()

cpp/autosar/src/rules/A8-4-7/InParametersForNotCheapToCopyTypesNotPassedByReference.ql

@@ -15,7 +15,7 @@
 
 import cpp
 import codingstandards.cpp.autosar
-import TriviallySmallType
+import TriviallyCopyableSmallType
 import codingstandards.cpp.CommonTypes as CommonTypes
 
 /*
@@ -28,12 +28,12 @@ import codingstandards.cpp.CommonTypes as CommonTypes
 from Parameter v
 where
   not isExcluded(v, ClassesPackage::inParametersForNotCheapToCopyTypesNotPassedByReferenceQuery()) and
-  not v.getType() instanceof TriviallySmallType and
+  not v.getType() instanceof TriviallyCopyableSmallType and
   not v.getType().getUnderlyingType() instanceof ReferenceType and
   not exists(CatchBlock cb | cb.getParameter() = v) and
   not v.isFromUninstantiatedTemplate(_) and
   not v.isFromTemplateInstantiation(_)
 select v,
-  "Parameter " + v.getName() +
-    " is the trivially non-copyable type $@ but it is passed by value instead of by reference.",
+  "Parameter '" + v.getName() +
+    "' is the trivially non-copyable type $@ but it is passed by value instead of by reference.",
   v.getType(), v.getType().getName()

cpp/autosar/src/rules/A8-4-7/TriviallySmallType.qll renamed to cpp/autosar/src/rules/A8-4-7/TriviallyCopyableSmallType.qll

@@ -1,5 +1,6 @@
 import cpp
 import codingstandards.cpp.autosar
+import codingstandards.cpp.TrivialType
 
 /**
  * Get the largest word size, in bytes. Some projects may have multiple different
@@ -13,6 +14,9 @@ int wordSize() { result = max(VoidPointerType v | | v.getSize()) }
 bindingset[bytes]
 int bytesToWords(int bytes) { result = bytes / wordSize() }
 
-class TriviallySmallType extends Type {
-  TriviallySmallType() { exists(int size | size = this.getSize() | bytesToWords(size) <= 2) }
+class TriviallyCopyableSmallType extends Type {
+  TriviallyCopyableSmallType() {
+    isTriviallyCopyableType(this) and
+    exists(int size | size = this.getSize() | bytesToWords(size) <= 2)
+  }
 }

cpp/autosar/src/rules/A9-3-1/ReturnsNonConstRawPointersOrReferencesToPrivateOrProtectedData.ql

@@ -57,7 +57,8 @@ class AccessAwareMemberFunction extends MemberFunction {
 
 from Class c, AccessAwareMemberFunction mf, FieldAccess a, ReturnStmt rs
 where
-  not isExcluded(c) and
+  not isExcluded(c,
+    ClassesPackage::returnsNonConstRawPointersOrReferencesToPrivateOrProtectedDataQuery()) and
   not isExcluded(mf,
     ClassesPackage::returnsNonConstRawPointersOrReferencesToPrivateOrProtectedDataQuery()) and
   // Find all of the methods within this class

cpp/autosar/src/rules/M0-1-2/InfeasiblePath.ql

@@ -158,6 +158,6 @@ predicate hasInfeasiblePath(
 
 from ConditionalControlFlowNode cond, boolean infeasiblePath, string explanation
 where
-  not isExcluded(cond) and
+  not isExcluded(cond, DeadCodePackage::infeasiblePathQuery()) and
   hasInfeasiblePath(cond, infeasiblePath, explanation)
 select cond, "The " + infeasiblePath + " path is infeasible because " + explanation + "."

cpp/autosar/src/rules/M3-1-2/FunctionsDeclaredAtBlockScope.ql

@@ -20,7 +20,7 @@ import codingstandards.cpp.autosar
 
 from DeclStmt decl, Function f
 where
-  not isExcluded(decl) and
+  not isExcluded(decl, DeclarationsPackage::functionsDeclaredAtBlockScopeQuery()) and
   not isExcluded(f, DeclarationsPackage::functionsDeclaredAtBlockScopeQuery()) and
   decl.getADeclaration() = f
 select f, "Function " + f.getName() + " is declared at block scope."

cpp/autosar/src/rules/M3-2-1/DeclarationsOfAFunctionShallHaveCompatibleTypes.ql

@@ -22,7 +22,7 @@ import codingstandards.cpp.Typehelpers
 
 from FunctionDeclarationEntry f1, FunctionDeclarationEntry f2
 where
-  not isExcluded(f1) and
+  not isExcluded(f1, DeclarationsPackage::declarationsOfAFunctionShallHaveCompatibleTypesQuery()) and
   not isExcluded(f2, DeclarationsPackage::declarationsOfAFunctionShallHaveCompatibleTypesQuery()) and
   not f1 = f2 and
   f1.getDeclaration() = f2.getDeclaration() and

cpp/autosar/src/rules/M3-2-3/MultipleDeclarationViolation.ql

@@ -20,7 +20,7 @@ import codingstandards.cpp.Scope
 
 from DeclarationEntry de, DeclarationEntry otherDeclaration, string kind
 where
-  not isExcluded(de) and
+  not isExcluded(de, ScopePackage::multipleDeclarationViolationQuery()) and
   exists(Declaration d |
     de.getDeclaration() = d and
     otherDeclaration.getDeclaration() = d and

cpp/autosar/src/rules/M3-9-1/TypesNotIdenticalInObjectDeclarations.ql

@@ -18,7 +18,7 @@ import codingstandards.cpp.autosar
 
 from VariableDeclarationEntry decl1, VariableDeclarationEntry decl2
 where
-  not isExcluded(decl1) and
+  not isExcluded(decl1, DeclarationsPackage::typesNotIdenticalInObjectDeclarationsQuery()) and
   not isExcluded(decl2, DeclarationsPackage::typesNotIdenticalInObjectDeclarationsQuery()) and
   decl1.getDeclaration() = decl2.getDeclaration() and
   not decl1.getType() = decl2.getType()

cpp/autosar/src/rules/M3-9-1/TypesNotIdenticalInReturnDeclarations.ql

@@ -18,7 +18,7 @@ import codingstandards.cpp.autosar
 
 from FunctionDeclarationEntry f1, FunctionDeclarationEntry f2
 where
-  not isExcluded(f1) and
+  not isExcluded(f1, DeclarationsPackage::typesNotIdenticalInReturnDeclarationsQuery()) and
   not isExcluded(f2, DeclarationsPackage::typesNotIdenticalInReturnDeclarationsQuery()) and
   f1.getDeclaration() = f2.getDeclaration() and
   not f1.getType() = f2.getType()

cpp/autosar/src/rules/M4-5-3/CharUsedAsOperandsToDisallowedBuiltInOperators.ql

@@ -22,7 +22,7 @@ import codingstandards.cpp.autosar
 
 from Operation o
 where
-  not isExcluded(o) and
+  not isExcluded(o, ExpressionsPackage::charUsedAsOperandsToDisallowedBuiltInOperatorsQuery()) and
   not (
     o instanceof EqualityOperation or
     o instanceof BitwiseAndExpr or

cpp/autosar/src/rules/M5-0-2/GratuitousUseOfParentheses.ql

@@ -84,7 +84,7 @@ predicate isGratuitousUseOfParentheses(ParenthesisExpr pe) {
 
 from ParenthesisExpr p
 where
-  not isExcluded(p) and
+  not isExcluded(p, OrderOfEvaluationPackage::gratuitousUseOfParenthesesQuery()) and
   isGratuitousUseOfParentheses(p) and
   not p.isInMacroExpansion()
 select p, "Gratuitous use of parentheses around $@.", p.getExpr(), p.getExpr().toString()

cpp/autosar/src/rules/M5-14-1/RightHandOperandOfALogicalAndOperatorsContainSideEffects.ql

@@ -18,11 +18,13 @@ import cpp
 import codingstandards.cpp.autosar
 import codingstandards.cpp.SideEffect
 import codingstandards.cpp.sideeffect.DefaultEffects
+import codingstandards.cpp.Expr
 
 from BinaryLogicalOperation op, Expr rhs
 where
   not isExcluded(op,
     SideEffects1Package::rightHandOperandOfALogicalAndOperatorsContainSideEffectsQuery()) and
   rhs = op.getRightOperand() and
-  hasSideEffect(rhs)
+  hasSideEffect(rhs) and
+  not rhs instanceof UnevaluatedExprExtension
 select op, "The $@ may have a side effect that is not always evaluated.", rhs, "right-hand operand"

cpp/autosar/src/rules/M5-2-10/IncrementAndDecrementOperatorsMixedWithOtherOperatorsInExpression.ql

@@ -20,7 +20,8 @@ import codingstandards.cpp.Expr
 
 from CrementOperation cop, ArithmeticOperation op, string name
 where
-  not isExcluded(cop) and
+  not isExcluded(cop,
+    OrderOfEvaluationPackage::incrementAndDecrementOperatorsMixedWithOtherOperatorsInExpressionQuery()) and
   not isExcluded(op,
     OrderOfEvaluationPackage::incrementAndDecrementOperatorsMixedWithOtherOperatorsInExpressionQuery()) and
   op.getAnOperand() = cop and

cpp/autosar/src/rules/M5-3-1/EachOperandOfTheOperatorTheLogicalAndOrTheLogicalOperatorsShallHaveTypeBool.ql

@@ -29,4 +29,4 @@ where
     rt = t.getUnderlyingType().getUnspecifiedType() and rt.getBaseType() instanceof BoolType
   ) and
   not operand.isFromUninstantiatedTemplate(_)
-select operand, "bool operator called with a non-bool operand of type " + t.getName() + "."
+select operand, "Call to bool operator with a non-bool operand of type '" + t.getName() + "'."

cpp/autosar/test/rules/A16-2-2/internal.h

@@ -0,0 +1 @@
+void f();

cpp/autosar/test/rules/A16-2-2/test.hpp

@@ -1 +1,3 @@
-void f();
+#include "z.h"
+
+void g() { f(); }

cpp/autosar/test/rules/A16-2-2/test2.cpp

@@ -0,0 +1,7 @@
+#include "test.hpp" // COMPLIANT
+#include "z.h"      // COMPLIANT
+
+void test() {
+  f();
+  g();
+}

cpp/autosar/test/rules/A16-2-2/z.h

@@ -0,0 +1 @@
+#include "internal.h"

cpp/autosar/test/rules/A5-1-1/LiteralValueUsedOutsideTypeInit.expected

@@ -1,5 +1,8 @@
-| test.cpp:5:9:5:25 | constant string | Literal value "constant string" used outside of type initialization StringLiteral |
-| test.cpp:14:23:14:25 | 100 | Literal value 100 used outside of type initialization Literal |
-| test.cpp:54:7:54:7 | 1 | Literal value 1 used outside of type initialization Literal |
-| test.cpp:75:23:75:28 | test | Literal value "test" used outside of type initialization StringLiteral |
-| test.cpp:76:19:76:28 | not okay | Literal value "not okay" used outside of type initialization StringLiteral |
+| test.cpp:5:9:5:25 | constant string | Literal value '"constant string"' used outside of type initialization. |
+| test.cpp:14:23:14:25 | 100 | Literal value '100' used outside of type initialization. |
+| test.cpp:54:7:54:7 | 1 | Literal value '1' used outside of type initialization. |
+| test.cpp:75:23:75:28 | test | Literal value '"test"' used outside of type initialization. |
+| test.cpp:76:19:76:28 | not okay | Literal value '"not okay"' used outside of type initialization. |
+| test.cpp:104:8:104:8 | 4 | Literal value '4' used outside of type initialization. |
+| test.cpp:104:8:104:8 | 4 | Literal value '4' used outside of type initialization. |
+| test.cpp:104:8:104:8 | 4 | Literal value '4' used outside of type initialization. |

cpp/autosar/test/rules/A5-1-1/test.cpp

@@ -80,10 +80,46 @@ void test_not_wrapper_stream(std::ostream &os, const char *str) noexcept {
 #define MACRO_LOG(test_str)                                                    \
   do {                                                                         \
     struct test_struct {                                                       \
-      static const char *get_str() { return static_cast<char *>(test_str); }   \
+      static const char *get_str() {                                           \
+        return static_cast<const char *>(test_str);                            \
+      }                                                                        \
     };                                                                         \
   } while (false)
 
 void f() {
   MACRO_LOG("test"); // COMPLIANT - exclusion
+}
+
+template <typename T> struct S1 { static constexpr size_t value(); };
+
+template <> struct S1<int> {
+  static constexpr size_t value() { return sizeof(int); };
+};
+
+constexpr size_t g1 = S1<int>::value();
+constexpr size_t f1() { return sizeof(int); }
+
+template <typename T, int size> struct S2 {
+  T m1[size]; // COMPLIANT
+  T m2[4];    // NON_COMPLIANT
+};
+
+template <typename T, T val> struct S3 {
+  static constexpr T value = val; // COMPLIANT;
+};
+
+void test_fp_reported_in_371() {
+  struct S2<int, 1> l1;    // COMPLIANT
+  struct S2<int, g1> l2;   // COMPLIANT
+  struct S2<int, f1()> l3; // COMPLIANT
+
+  S3<char16_t, u'\u03c0'> l4;                      // COMPLIANT
+  S3<char16_t, S3<char16_t, u'\u2286'>::value> l5; // COMPLIANT
+  S3<char32_t, U'🌌'> l6;                           // COMPLIANT
+  S3<char32_t, S3<char32_t, U'⭐'>::value> l7;      // COMPLIANT
+
+  constexpr float l8 = 3.14159f;
+#define delta 0.1f
+  for (float i = 0.0f; i < l8; i += delta) { // COMPLIANT
+  }
 }

cpp/autosar/test/rules/A8-4-7/InParametersForCheapToCopyTypesNotPassedByValue.expected

@@ -1 +1 @@
-| test.cpp:20:19:20:21 | f5a | Parameter 'f5a' is the trivially copyable type 'const S1' but it is passed by reference instead of by value. |
+| test.cpp:22:19:22:21 | f5a | Parameter 'f5a' is the trivially copyable type $@ but it is passed by reference instead of by value. | file://:0:0:0:0 | const S1 | const S1 |

cpp/autosar/test/rules/A8-4-7/InParametersForNotCheapToCopyTypesNotPassedByReference.expected

@@ -1,2 +1,3 @@
-| test.cpp:23:12:23:14 | f8a | Parameter f8a is the trivially non-copyable type $@ but it is passed by value instead of by reference. | test.cpp:14:8:14:9 | S2 | S2 |
-| test.cpp:27:13:27:16 | f12a | Parameter f12a is the trivially non-copyable type $@ but it is passed by value instead of by reference. | test.cpp:14:8:14:9 | S2 | S2 |
+| test.cpp:25:12:25:14 | f8a | Parameter 'f8a' is the trivially non-copyable type $@ but it is passed by value instead of by reference. | test.cpp:16:8:16:9 | S2 | S2 |
+| test.cpp:29:13:29:16 | f12a | Parameter 'f12a' is the trivially non-copyable type $@ but it is passed by value instead of by reference. | test.cpp:16:8:16:9 | S2 | S2 |
+| test.cpp:70:13:70:16 | f17a | Parameter 'f17a' is the trivially non-copyable type $@ but it is passed by value instead of by reference. | test.cpp:60:8:60:9 | S4 | S4 |