Merge branch 'main' into lcartey/remove-old-is-excluded

rvermeulen · web-flow · commit 93f6cdce8b16 · 2024-03-04T17:10:34.000-08:00
diff --git a/README.md b/README.md
@@ -6,15 +6,12 @@ This repository contains CodeQL queries and libraries which support various Codi
 
 _Carnegie Mellon and CERT are registered trademarks of Carnegie Mellon University._
 
-This repository contains CodeQL queries and libraries which support various Coding Standards for the [C++14](https://www.iso.org/standard/64029.html) programming language.
+This repository contains CodeQL queries and libraries which support various Coding Standards for the [C++14](https://www.iso.org/standard/64029.html), [C99](https://www.iso.org/standard/29237.html) and [C11](https://www.iso.org/standard/57853.html) programming languages.
 
 The following coding standards are supported:
 - [AUTOSAR - Guidelines for the use of C++14 language in critical and safety-related systems (Releases R22-11, R20-11, R19-11 and R19-03)](https://www.autosar.org/fileadmin/standards/R22-11/AP/AUTOSAR_RS_CPP14Guidelines.pdf). 
 - [MISRA C++:2008](https://www.misra.org.uk) (support limited to the rules specified in AUTOSAR).
 - [SEI CERT C++ Coding Standard: Rules for Developing Safe, Reliable, and Secure Systems (2016 Edition)](https://resources.sei.cmu.edu/library/asset-view.cfm?assetID=494932)
-
-In addition, the following Coding Standards for the C programming language are under development:
-
 - [SEI CERT C Coding Standard: Rules for Developing Safe, Reliable, and Secure Systems (2016 Edition)](https://resources.sei.cmu.edu/downloads/secure-coding/assets/sei-cert-c-coding-standard-2016-v01.pdf)
 - [MISRA C 2012](https://www.misra.org.uk/product/misra-c2012-third-edition-first-revision/).
 
diff --git a/change_notes/2024-02-22-fix-fp-a5-0-2-and-change-alert-m5-3-1.md b/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.
diff --git a/change_notes/2024-02-26-exclusion-M5-14-1.md b/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.
diff --git a/cpp/autosar/src/rules/M5-14-1/RightHandOperandOfALogicalAndOperatorsContainSideEffects.ql b/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"
diff --git a/cpp/autosar/src/rules/M5-3-1/EachOperandOfTheOperatorTheLogicalAndOrTheLogicalOperatorsShallHaveTypeBool.ql b/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() + "'."
diff --git a/cpp/autosar/test/rules/M5-14-1/RightHandOperandOfALogicalAndOperatorsContainSideEffects.expected b/cpp/autosar/test/rules/M5-14-1/RightHandOperandOfALogicalAndOperatorsContainSideEffects.expected
@@ -1,3 +1,4 @@
 | test.cpp:15:7:15:14 | ... \|\| ... | The $@ may have a side effect that is not always evaluated. | test.cpp:15:12:15:14 | ... ++ | right-hand operand |
 | test.cpp:18:7:18:21 | ... \|\| ... | The $@ may have a side effect that is not always evaluated. | test.cpp:18:13:18:20 | ... == ... | right-hand operand |
 | test.cpp:21:7:21:15 | ... \|\| ... | The $@ may have a side effect that is not always evaluated. | test.cpp:21:12:21:13 | call to f1 | right-hand operand |
+| test.cpp:40:7:40:41 | ... \|\| ... | The $@ may have a side effect that is not always evaluated. | test.cpp:40:26:40:26 | call to operator== | right-hand operand |
diff --git a/cpp/autosar/test/rules/M5-14-1/test.cpp b/cpp/autosar/test/rules/M5-14-1/test.cpp
@@ -23,4 +23,20 @@ void f3(bool b) {
 
   if (b || f2()) { // COMPLIANT, f2 has local side-effects
   }
+}
+
+int g1 = 0;
+int f4() { return g1++; }
+int f5() { return 1; }
+
+#include <typeinfo>
+
+void f6() {
+  if (1 && sizeof(f4())) {
+  } // COMPLIANT  - sizeof operands not evaluated
+  if (1 &&noexcept(f4()) &&noexcept(f4())) {
+  } // COMPLIANT  - noexcept operands not evaluated
+
+  if (1 || (typeid(f5()) == typeid(f4()))) {
+  } // NON_COMPLIANT  - typeid operands not evaluated, but the ==operator is
 }
diff --git a/cpp/autosar/test/rules/M5-3-1/EachOperandOfTheOperatorTheLogicalAndOrTheLogicalOperatorsShallHaveTypeBool.expected b/cpp/autosar/test/rules/M5-3-1/EachOperandOfTheOperatorTheLogicalAndOrTheLogicalOperatorsShallHaveTypeBool.expected
@@ -1,3 +1,3 @@
-| test.cpp:10:8:10:8 | 0 | bool operator called with a non-bool operand of type int. |
-| test.cpp:12:7:12:7 | 0 | bool operator called with a non-bool operand of type int. |
-| test.cpp:12:13:12:17 | ... + ... | bool operator called with a non-bool operand of type int. |
+| test.cpp:10:8:10:8 | 0 | Call to bool operator with a non-bool operand of type 'int'. |
+| test.cpp:12:7:12:7 | 0 | Call to bool operator with a non-bool operand of type 'int'. |
+| test.cpp:12:13:12:17 | ... + ... | Call to bool operator with a non-bool operand of type 'int'. |
diff --git a/cpp/common/src/codingstandards/cpp/Expr.qll b/cpp/common/src/codingstandards/cpp/Expr.qll
@@ -189,3 +189,17 @@ module MisraExpr {
     CValue() { isCValue(this) }
   }
 }
+
+/**
+ * an operator that does not evaluate its operand
+ */
+class UnevaluatedExprExtension extends Expr {
+  UnevaluatedExprExtension() {
+    this.getAChild().isUnevaluated()
+    or
+    exists(FunctionCall declval |
+      declval.getTarget().hasQualifiedName("std", "declval") and
+      declval.getAChild() = this
+    )
+  }
+}
diff --git a/cpp/common/src/codingstandards/cpp/rules/nonbooleaniterationstmt/NonBooleanIterationStmt.qll b/cpp/common/src/codingstandards/cpp/rules/nonbooleaniterationstmt/NonBooleanIterationStmt.qll
@@ -1,5 +1,5 @@
 /**
- * Provides a library which includes a `problems` predicate for reporting....
+ * Provides a library which includes a `problems` predicate for reporting non-boolean iteration conditions.
  */
 
 import cpp
@@ -16,8 +16,10 @@ query predicate problems(Loop loopStmt, string message) {
     condition = loopStmt.getCondition() and
     explicitConversionType = condition.getExplicitlyConverted().getType().getUnspecifiedType() and
     not explicitConversionType instanceof BoolType and
-    //exclude any generated conditions
+    // exclude any generated conditions
     not condition.isCompilerGenerated() and
+    // exclude any conditions in uninstantiated templates, because their type will be unknown.
+    not condition.isFromUninstantiatedTemplate(_) and
     message = "Iteration condition has non boolean type " + explicitConversionType + "."
   )
 }
diff --git a/cpp/common/test/includes/standard-library/typeinfo.h b/cpp/common/test/includes/standard-library/typeinfo.h
@@ -4,5 +4,6 @@ namespace std {
 struct type_info {
   const char *name() const noexcept;
   std::size_t hash_code() const noexcept;
+  bool operator==(const type_info &rhs) const;
 };
 } // namespace std
diff --git a/cpp/common/test/rules/nonbooleanifstmt/test.cpp b/cpp/common/test/rules/nonbooleanifstmt/test.cpp
@@ -46,3 +46,16 @@ void test_boolean_conditions() {
   if (a) { // COMPLIANT - a has an explicit operator bool()
   }
 }
+
+template <typename T> bool test_fp_reported_in_10a(T &p1) {
+  if (p1.length() > 10) { // COMPLIANT
+    return true;
+  }
+  return false;
+}
+
+#include <string>
+void test_fp_reported_in_10b() {
+  std::string s;
+  test_fp_reported_in_10a(s);
+}
diff --git a/cpp/common/test/rules/nonbooleaniterationstmt/test.cpp b/cpp/common/test/rules/nonbooleaniterationstmt/test.cpp
@@ -41,4 +41,17 @@ class ClassC {
     if (!d.empty()) { // COMPLIANT
     }
   }
-};
+};
+
+#include <vector>
+template <typename T> void test_fp_reported_in_10a(std::vector<T> &p1) {
+  for (typename std::vector<T>::iterator it = p1.begin(); it != p1.end();
+       ++it) { // COMPLIANT
+    (*it)++;
+  }
+}
+
+void test_fp_reported_in_10b() {
+  std::vector<int> vl1;
+  test_fp_reported_in_10a(vl1);
+}
diff --git a/docs/development_handbook.md b/docs/development_handbook.md
@@ -38,14 +38,15 @@
 | 0.29.0 | 2023-10-11 | Remco Vermeulen | Update release process. |
 | 0.29.1 | 2023-10-11 | Remco Vermeulen | Address Markdown linter problems. |
 | 0.30.0 | 2023-11-14 | Remco Vermeulen | Clarify release steps in case of a hotfix release. |
+| 0.31.0 | 2024-02-23 | Remco Vermeulen | Clarify the required use of Python version 3.9 |
 
 ## Scope of work
 
 A *coding standard* is a set of rules or guidelines which restrict or prohibit the use of certain dangerous or confusing coding patterns or language features. This repository contains CodeQL queries (and supporting processes) which implement a number of different coding standards. The currently supported standards are:
 
 | Standard                                                                                                             | Version | Total rules | Total supportable rules | Status         | Notes                                                                                                                                                     |
 | -------------------------------------------------------------------------------------------------------------------- | ------- | ----------- | ----------------------- | -------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| [AUTOSAR C++](https://www.autosar.org/fileadmin/standards/R22-11/AP/AUTOSAR_RS_CPP14Guidelines.pdf) | R22-11, R21-11, R20-11, R19-11, R19-03  | 397         | 375                     | Implemented    |
+| [AUTOSAR C++](https://www.autosar.org/fileadmin/standards/R22-11/AP/AUTOSAR_RS_CPP14Guidelines.pdf) | R22-11, R21-11, R20-11, R19-11, R19-03  | 397         | 375                     | Implemented    | |
 | [CERT-C++](https://resources.sei.cmu.edu/downloads/secure-coding/assets/sei-cert-cpp-coding-standard-2016-v01.pdf)   | 2016    | 83          | 83                      | Implemented    | AUTOSAR includes a sub-set of rules take from MISRA C++ 2008, which can be purchased for a small fee from [the MISRA website](https://misra.org.uk/shop). |
 | [CERT-C](https://resources.sei.cmu.edu/downloads/secure-coding/assets/sei-cert-c-coding-standard-2016-v01.pdf)       | 2016    | 120         | 99                      | In development | The implementation excludes rules not part of 2016, but that are added to the [CERT-C wiki](https://wiki.sei.cmu.edu/confluence/display/c/)               |
 | [MISRA C](https://www.misra.org.uk/product/misra-c2012-third-edition-first-revision/ )                               | 2012    | 172         | 172                     | In development | This includes the [MISRA C:2012 Amendment 2](https://www.misra.org.uk/app/uploads/2021/06/MISRA-C-2012-AMD2.pdf)                                          |
@@ -163,6 +164,7 @@ These files will be ready for query implementation.
 
 #### Step 0: Prepare the Python environment
 
+The tooling standardizes on Python 3.9 and requires the use of version 3.9 to run all tooling.
 The `scripts` directory contains the pip package specification file `requirements.txt` that contains the dependencies our generation scripts rely upon.
 
 The dependencies can be installed as follows:
@@ -171,12 +173,12 @@ The dependencies can be installed as follows:
 pip3.9 install -r scripts/requirements.txt
 ```
 
-It is advisable to use a Python virtual environment which needs to be created and activated before installing the dependencies. This can be done as follows:
+It is advisable to use a Python 3.9 virtual environment which needs to be created and activated before installing the dependencies. This can be done as follows:
 
 ```bash
 python3.9 -mvenv scripts/.venv
 . scripts/.venv/bin/activate
-pip install -r scripts/requirements.txt
+pip3.9 install -r scripts/requirements.txt
 ```
 
 #### Step 1: Generate rule package description file
@@ -265,7 +267,7 @@ The `generate_package_description.py` script provides a "best-effort" approach t
     - `performance` - if the query identifies an issue which has a negative impact on the performance of the code.
     - `concurrency` - if the query identifies a concurrency issue.
   - Validate the rule package description file using the `validate-rule-package.py` script that validates the rule package descriptions against the schema `rule-package.schema.json` located in the `schemas` directory.
-    - `python3 scripts/validate-rule-package.py <rule_package_name>`
+    - `python3.9 scripts/validate-rule-package.py <rule_package_name>`
 
 #### Step 3
 
@@ -350,7 +352,7 @@ All public predicates, classes, modules and files should be documented with QLDo
 
 ### Installing QL dependencies
 
-All of our query and library packs depend on the standard CodeQL library for C++, `codeql/cpp-all`. This dependency is specified in the `qlpack.yml` file for each of our packs. Before compiling, running, or testing any of our queries or libraries, you must download the proper dependencies by running `python3 scripts/install-packs.py`. This will download the appropriate version of the standard library from the public package registry, installing it in a cache in your `~/.codeql` directory. When compiling queries or running tests, the QL compiler will pick up the appropriate dependencies from this cache without any need to specify an additional library search path on the command line.
+All of our query and library packs depend on the standard CodeQL library for C++, `codeql/cpp-all`. This dependency is specified in the `qlpack.yml` file for each of our packs. Before compiling, running, or testing any of our queries or libraries, you must download the proper dependencies by running `python3.9 scripts/install-packs.py`. This will download the appropriate version of the standard library from the public package registry, installing it in a cache in your `~/.codeql` directory. When compiling queries or running tests, the QL compiler will pick up the appropriate dependencies from this cache without any need to specify an additional library search path on the command line.
 
 Because the downloaded packs are cached, it is only necessary to run `install-packs.py` once each time we upgrade to a new standard library version. It does not hurt to run it more often; if all necessary packs are already in the download cache, then it will complete quickly without trying to download anything.
 
diff --git a/docs/user_manual.md b/docs/user_manual.md
diff --git a/rules.csv b/rules.csv
diff --git a/scripts/generate_rules/generate_package_description.py b/scripts/generate_rules/generate_package_description.py
diff --git a/scripts/verify_rule_package_consistency.py b/scripts/verify_rule_package_consistency.py

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