Merge branch 'main' into rvermeulen/fix-issue-#311

Author: rvermeulen

c/common/src/codingstandards/c/Literals.qll

@@ -0,0 +1,4 @@
+// Reuse the `IntegerLiteral` class
+import codingstandards.cpp.Cpp14Literal
+
+class IntegerLiteral = Cpp14Literal::IntegerLiteral;

c/misra/src/rules/RULE-7-3/LowercaseCharacterLUsedInLiteralSuffix.ql

@@ -14,10 +14,10 @@
 
 import cpp
 import codingstandards.c.misra
+import codingstandards.c.Literals
 
-from Literal l
+from IntegerLiteral l
 where
   not isExcluded(l, SyntaxPackage::lowercaseCharacterLUsedInLiteralSuffixQuery()) and
-  not l instanceof StringLiteral and
   exists(l.getValueText().indexOf("l"))
 select l, "Lowercase 'l' used as a literal suffix."

c/misra/test/rules/RULE-7-3/cpp/LowercaseCharacterLUsedInLiteralSuffix.expected

@@ -0,0 +1 @@
+rules/RULE-7-3/LowercaseCharacterLUsedInLiteralSuffix.ql

c/misra/test/rules/RULE-7-3/cpp/LowercaseCharacterLUsedInLiteralSuffix.qlref

@@ -0,0 +1 @@
+This test case was added to validate FP report [#319](https://github.com/github/codeql-coding-standards/issues/319) that occurs when this rule is run on a translation unit with language mode c++.

c/misra/test/rules/RULE-7-3/cpp/README.md

@@ -0,0 +1 @@
+semmle-extractor-options:--clang -std=c++14 --edg --diag_error=implicit_func_decl -nostdinc -I../../../../../cpp/common/test/includes/standard-library

c/misra/test/rules/RULE-7-3/cpp/options

@@ -0,0 +1 @@
+int x = false; // COMPLIANT - reported as FP in #319

c/misra/test/rules/RULE-7-3/cpp/test.cpp

@@ -41,4 +41,4 @@ long d9 = 001LU; // COMPLIANT
 
 char *e1 = "";
 char *e2 = "ul";
-char *e3 = "UL";
+char *e3 = "UL";

c/misra/test/rules/RULE-7-3/test.c

@@ -0,0 +1 @@
+ * `A7-1-1` - no longer report parameters as contravening this rule. This is inline with the rule intent as described in the referenced C++ Core Guidelines rule [CON.1](https://isocpp.github.io/CppCoreGuidelines/CppCoreGuidelines#con1-by-default-make-objects-immutable), which states "To avoid confusion and lots of false positives, don’t enforce this rule for function parameters."

change_notes/2023-11-22-remove-parameters-a7-1-1.md

@@ -0,0 +1,5 @@
+- `A3-9-1` - `VariableWidthIntegerTypesUsed.ql`:
+    - Exclude the plain char type. Still includes `signed char` and `unsigned char`.
+    - Include CV-qualified variable width integer types.
+- `A3-9-1` - `VariableWidthPlainCharTypeUsed.ql`:
+    - New query to support fine grained deviation support for the plain char type.

change_notes/2024-01-12-fix-reported-fp-a3-9-1.md

@@ -0,0 +1,2 @@
+`RULE-7-3`: `c/misra/lowercase-character-l-used-in-literal-suffix`
+    - Exclude non integer literals. This removes a false positive triggered when analyzing C++ code containing the `false` literal.

change_notes/2024-01-18-fix-reported-fp-for-rule-7-3.md

@@ -0,0 +1,2 @@
+`M9-3-3` - `MemberFunctionConstIfPossible.ql`, `MemberFunctionStaticIfPossible.ql`:
+    - Fixes #413. Exclude deleted member functions.

change_notes/2024-01-25-exclusion-m9-3-3.md

@@ -0,0 +1,3 @@
+`A8-4-7` - `InParametersForCheapToCopyTypesNotPassedByValue.ql`, `InParametersForNotCheapToCopyTypesNotPassedByReference.ql`:
+    - Fixes #397. Exclude user defined operators and move constructors.`
+    - Exclude parameters for instantiated templates because the declaration location of the function does not contain enough information about the type used in the instantiation to make an actionable alert. 

change_notes/2024-01-25-fix-reported-fp-for-a8-4-7.md

@@ -0,0 +1,2 @@
+`A5-0-2` - `NonBooleanIfStmt.qll`, `NonBooleanIterationStmt.qll`:
+    - Exclude compiler generated conditions.

change_notes/2024-01-26-exclusion-a5-0-2.md

@@ -0,0 +1,2 @@
+`M9-3-3`: `MemberFunctionConstIfPossible.ql`:
+    - Fix FP reported in 467. Excluding candidates in uninstantiated templates.

change_notes/2024-01-31-fix-fp-m9-3-3.md

@@ -0,0 +1,2 @@
+`A7-1-1` - `DeclarationUnmodifiedObjectMissingConstSpecifier.ql`
+    - Fix FP reported in #372. Exclude compiler generated variables.

change_notes/2024-02-01-fix-fp-reported-for-a7-1-1.md

@@ -1,8 +1,8 @@
 /**
  * @id cpp/autosar/variable-width-integer-types-used
  * @name A3-9-1: Use fixed-width integer types instead of basic, variable-width, integer types
- * @description The basic numerical types of char, int, short, long are not supposed to be used. The
- *              specific-length types from <cstdint> header need be used instead.
+ * @description The basic numerical types of signed/unsigned char, int, short, long are not supposed
+ *              to be used. The specific-length types from <cstdint> header need be used instead.
  * @kind problem
  * @precision very-high
  * @problem.severity error
@@ -19,15 +19,16 @@ import cpp
 import codingstandards.cpp.autosar
 import codingstandards.cpp.EncapsulatingFunctions
 import codingstandards.cpp.BuiltInNumericTypes
+import codingstandards.cpp.Type
 
-from Variable v
+from Variable v, Type typeStrippedOfSpecifiers
 where
   not isExcluded(v, DeclarationsPackage::variableWidthIntegerTypesUsedQuery()) and
+  typeStrippedOfSpecifiers = stripSpecifiers(v.getType()) and
   (
-    v.getType() instanceof BuiltInIntegerType or
-    v.getType() instanceof PlainCharType or
-    v.getType() instanceof UnsignedCharType or
-    v.getType() instanceof SignedCharType
+    typeStrippedOfSpecifiers instanceof BuiltInIntegerType or
+    typeStrippedOfSpecifiers instanceof UnsignedCharType or
+    typeStrippedOfSpecifiers instanceof SignedCharType
   ) and
   not v instanceof ExcludedVariable
 select v, "Variable '" + v.getName() + "' has variable-width type."

cpp/autosar/src/rules/A3-9-1/VariableWidthIntegerTypesUsed.ql

@@ -0,0 +1,26 @@
+/**
+ * @id cpp/autosar/variable-width-plain-char-type-used
+ * @name A3-9-1: Use a fixed-width integer type instead of a char type
+ * @description The basic numerical type char is not supposed to be used. The specific-length types
+ *              from <cstdint> header need be used instead.
+ * @kind problem
+ * @precision very-high
+ * @problem.severity error
+ * @tags external/autosar/id/a3-9-1
+ *       correctness
+ *       security
+ *       maintainability
+ *       external/autosar/allocated-target/implementation
+ *       external/autosar/enforcement/automated
+ *       external/autosar/obligation/required
+ */
+
+import cpp
+import codingstandards.cpp.autosar
+import codingstandards.cpp.Type
+
+from Variable variable
+where
+  not isExcluded(variable, DeclarationsPackage::variableWidthPlainCharTypeUsedQuery()) and
+  stripSpecifiers(variable.getType()) instanceof PlainCharType
+select variable, "Variable '" + variable.getName() + "' has variable-width char type."

cpp/autosar/src/rules/A3-9-1/VariableWidthPlainCharTypeUsed.ql

@@ -36,5 +36,6 @@ where
     else cond = " is used for an object"
   ) and
   not exists(LambdaExpression lc | lc.getACapture().getField() = v) and
-  not v.isFromUninstantiatedTemplate(_)
+  not v.isFromUninstantiatedTemplate(_) and
+  not v.isCompilerGenerated()
 select v, "Non-constant variable " + v.getName() + cond + " and is not modified."

cpp/autosar/src/rules/A7-1-1/DeclarationUnmodifiedObjectMissingConstSpecifier.ql

@@ -17,6 +17,7 @@ import cpp
 import codingstandards.cpp.autosar
 import TriviallySmallType
 import codingstandards.cpp.CommonTypes as CommonTypes
+import codingstandards.cpp.Class
 
 /*
  * For the purposes of this rule, "cheap to copy" is defined as a trivially copyable type that is no
@@ -34,8 +35,10 @@ where
   ) and
   t.isConst() and
   not exists(CatchBlock cb | cb.getParameter() = v) and
-  not exists(CopyConstructor cc | cc.getAParameter() = v) and
-  not v.isFromUninstantiatedTemplate(_)
+  not exists(SpecialMemberFunction cc | cc.getAParameter() = v) and
+  not exists(Operator op | op.getAParameter() = v) and
+  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 '" + t.getName() +
+    "' but it is passed by reference instead of by value."

cpp/autosar/src/rules/A7-1-1/DeclarationUnmodifiedParamMissingConstSpecifier.ql

@@ -31,7 +31,8 @@ where
   not v.getType() instanceof TriviallySmallType and
   not v.getType().getUnderlyingType() instanceof ReferenceType and
   not exists(CatchBlock cb | cb.getParameter() = v) and
-  not v.isFromUninstantiatedTemplate(_)
+  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.",

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

@@ -54,7 +54,10 @@ class ConstMemberFunctionCandidate extends NonConstMemberFunction {
     not this instanceof Destructor and
     not this instanceof Operator and
     //less interested in MemberFunctions with no definition
-    this.hasDefinition()
+    this.hasDefinition() and
+    // For uninstantiated templates we have only partial information that prevents us from determining
+    // if the candidate calls non-const functions. Therefore we exclude these.
+    not this.isFromUninstantiatedTemplate(_)
   }
 
   /**
@@ -121,5 +124,6 @@ where
   not f.callsNonConstOwnMember() and
   not f.callsNonConstFromMemberVariable() and
   not f.isOverride() and
-  not f.isFinal()
+  not f.isFinal() and
+  not f.isDeleted()
 select f, "Member function can be declared as const."

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

@@ -39,5 +39,6 @@ from NonStaticMemberFunction nonstatic
 where
   not isExcluded(nonstatic, ConstPackage::memberFunctionStaticIfPossibleQuery()) and
   not exists(ThisExpr t | t.getEnclosingFunction() = nonstatic) and
-  not nonstatic.isVirtual()
+  not nonstatic.isVirtual() and
+  not nonstatic.isDeleted()
 select nonstatic, "Member function can be declared as static."

cpp/autosar/src/rules/M9-3-3/MemberFunctionConstIfPossible.ql

@@ -1,4 +1,3 @@
-| test.cpp:4:8:4:8 | c | Variable 'c' has variable-width type. |
 | test.cpp:5:17:5:18 | uc | Variable 'uc' has variable-width type. |
 | test.cpp:6:15:6:16 | sc | Variable 'sc' has variable-width type. |
 | test.cpp:8:7:8:7 | i | Variable 'i' has variable-width type. |
@@ -12,3 +11,29 @@
 | test.cpp:18:8:18:8 | l | Variable 'l' has variable-width type. |
 | test.cpp:19:17:19:18 | ul | Variable 'ul' has variable-width type. |
 | test.cpp:20:15:20:16 | sl | Variable 'sl' has variable-width type. |
+| test.cpp:39:23:39:25 | uc1 | Variable 'uc1' has variable-width type. |
+| test.cpp:40:21:40:23 | sc1 | Variable 'sc1' has variable-width type. |
+| test.cpp:42:13:42:14 | i1 | Variable 'i1' has variable-width type. |
+| test.cpp:43:22:43:24 | ui1 | Variable 'ui1' has variable-width type. |
+| test.cpp:44:18:44:19 | u1 | Variable 'u1' has variable-width type. |
+| test.cpp:45:20:45:22 | si1 | Variable 'si1' has variable-width type. |
+| test.cpp:46:16:46:17 | s1 | Variable 's1' has variable-width type. |
+| test.cpp:48:15:48:17 | sh1 | Variable 'sh1' has variable-width type. |
+| test.cpp:49:24:49:27 | ush1 | Variable 'ush1' has variable-width type. |
+| test.cpp:50:22:50:25 | ssh1 | Variable 'ssh1' has variable-width type. |
+| test.cpp:52:14:52:15 | l1 | Variable 'l1' has variable-width type. |
+| test.cpp:53:23:53:25 | ul1 | Variable 'ul1' has variable-width type. |
+| test.cpp:54:21:54:23 | sl1 | Variable 'sl1' has variable-width type. |
+| test.cpp:57:26:57:28 | uc2 | Variable 'uc2' has variable-width type. |
+| test.cpp:58:24:58:26 | sc2 | Variable 'sc2' has variable-width type. |
+| test.cpp:60:16:60:17 | i2 | Variable 'i2' has variable-width type. |
+| test.cpp:61:25:61:27 | ui2 | Variable 'ui2' has variable-width type. |
+| test.cpp:62:21:62:22 | u2 | Variable 'u2' has variable-width type. |
+| test.cpp:63:23:63:25 | si2 | Variable 'si2' has variable-width type. |
+| test.cpp:64:19:64:20 | s2 | Variable 's2' has variable-width type. |
+| test.cpp:66:18:66:20 | sh2 | Variable 'sh2' has variable-width type. |
+| test.cpp:67:27:67:30 | ush2 | Variable 'ush2' has variable-width type. |
+| test.cpp:68:25:68:28 | ssh2 | Variable 'ssh2' has variable-width type. |
+| test.cpp:70:17:70:18 | l2 | Variable 'l2' has variable-width type. |
+| test.cpp:71:26:71:28 | ul2 | Variable 'ul2' has variable-width type. |
+| test.cpp:72:24:72:26 | sl2 | Variable 'sl2' has variable-width type. |

cpp/autosar/src/rules/M9-3-3/MemberFunctionStaticIfPossible.ql

@@ -0,0 +1,3 @@
+| test.cpp:4:8:4:8 | c | Variable 'c' has variable-width char type. |
+| test.cpp:38:14:38:15 | c1 | Variable 'c1' has variable-width char type. |
+| test.cpp:56:17:56:18 | c2 | Variable 'c2' has variable-width char type. |

cpp/autosar/test/rules/A3-9-1/VariableWidthIntegerTypesUsed.expected

@@ -0,0 +1 @@
+rules/A3-9-1/VariableWidthPlainCharTypeUsed.ql

cpp/autosar/test/rules/A3-9-1/VariableWidthPlainCharTypeUsed.expected

@@ -3,7 +3,7 @@
 void test_variable_width_type_variables() {
   char c;           // NON_COMPLIANT
   unsigned char uc; // NON_COMPLIANT
-  signed char sc;   // NON_COMPLIANt
+  signed char sc;   // NON_COMPLIANT
 
   int i;           // NON_COMPLIANT
   unsigned int ui; // NON_COMPLIANT
@@ -32,4 +32,42 @@ void test_variable_width_type_variables() {
 
 int main(int argc, char *argv[]) { // COMPLIANT
   // main as an exception
+}
+
+void test_variable_width_type_qualified_variables() {
+  const char c1 = 0;           // NON_COMPLIANT
+  const unsigned char uc1 = 0; // NON_COMPLIANT
+  const signed char sc1 = 0;   // NON_COMPLIANt
+
+  const int i1 = 0;           // NON_COMPLIANT
+  const unsigned int ui1 = 0; // NON_COMPLIANT
+  const unsigned u1 = 0;      // NON_COMPLIANT
+  const signed int si1 = 0;   // NON_COMPLIANT
+  const signed s1 = 0;        // NON_COMPLIANT
+
+  const short sh1 = 0;           // NON_COMPLIANT
+  const unsigned short ush1 = 0; // NON_COMPLIANT
+  const signed short ssh1 = 0;   // NON_COMPLIANT
+
+  const long l1 = 0;           // NON_COMPLIANT
+  const unsigned long ul1 = 0; // NON_COMPLIANT
+  const signed long sl1 = 0;   // NON_COMPLIANT
+
+  volatile char c2;           // NON_COMPLIANT
+  volatile unsigned char uc2; // NON_COMPLIANT
+  volatile signed char sc2;   // NON_COMPLIANt
+
+  volatile int i2;           // NON_COMPLIANT
+  volatile unsigned int ui2; // NON_COMPLIANT
+  volatile unsigned u2;      // NON_COMPLIANT
+  volatile signed int si2;   // NON_COMPLIANT
+  volatile signed s2;        // NON_COMPLIANT
+
+  volatile short sh2;           // NON_COMPLIANT
+  volatile unsigned short ush2; // NON_COMPLIANT
+  volatile signed short ssh2;   // NON_COMPLIANT
+
+  volatile long l2;           // NON_COMPLIANT
+  volatile unsigned long ul2; // NON_COMPLIANT
+  volatile signed long sl2;   // NON_COMPLIANT
 }

cpp/autosar/test/rules/A3-9-1/VariableWidthPlainCharTypeUsed.qlref

@@ -4,7 +4,7 @@
 void f1(int *p) { // COMPLIANT
   *p += 2;
 }
-void f2(int *p) { // NON_COMPLIANT
+void f2(int *p) { // COMPLIANT - we ignore parameters for this rule
   int l4 = 1;     // NON_COMPLIANT
   int *p1 = p;    // NON_COMPLIANT
 }

cpp/autosar/test/rules/A3-9-1/test.cpp

@@ -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:20:19:20:21 | f5a | Parameter 'f5a' is the trivially copyable type 'const S1' but it is passed by reference instead of by value. |

cpp/autosar/test/rules/A7-1-1/DeclarationUnmodifiedParamMissingConstSpecifier.expected

@@ -37,4 +37,12 @@ inline S1 Value(size_t n, const char *data) {} // COMPLIANT
 struct A {
   int n;
   A(const A &a) : n(a.n) {} // COMPLIANT user-defined copy ctor
+  A(const A &&other_a);     // COMPLIANT user-defined move ctor
 };
+
+class C1 {};
+
+class C2 : public C1 {
+public:
+  C2 &operator=(const C2 &); // COMPLIANT
+};