Merge branch 'main' into lcartey/cpp-conversions2

Author: lcartey

change_notes/2025-06-10-a3-9-1-functions.md

@@ -0,0 +1,2 @@
+-`A3-9-1` - `VariableWidthIntegerTypesUsed.ql`:
+- This query now reports the use of non-fixed width integer types in function return types, with the exception of `char` types and for `main` functions.

cpp/autosar/src/codingstandards/cpp/CommonTypes.qll

@@ -1,7 +1,7 @@
 import cpp as default
 
 /*
- * Implementations of the C/C++ Fixed Width Types from cstdint.h.
+ * Implementations of the C/C++ Fixed Width Types from cstdint.
  *
  * TODO: Deprecate once this is available in the CodeQL standard library.
  */

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

@@ -17,26 +17,10 @@
 
 import cpp
 import codingstandards.cpp.autosar
-import codingstandards.cpp.EncapsulatingFunctions
-import codingstandards.cpp.BuiltInNumericTypes
-import codingstandards.cpp.Type
-import codingstandards.cpp.Operator
+import codingstandards.cpp.rules.variablewidthintegertypesused.VariableWidthIntegerTypesUsed
 
-fromVariablev,TypetypeStrippedOfSpecifiers
-where
-notisExcluded(v, DeclarationsPackage::variableWidthIntegerTypesUsedQuery())and
-typeStrippedOfSpecifiers=stripSpecifiers(v.getType())and
-(
-typeStrippedOfSpecifiersinstanceofBuiltInIntegerTypeor
-typeStrippedOfSpecifiersinstanceofUnsignedCharTypeor
-typeStrippedOfSpecifiersinstanceofSignedCharType
-)and
-notvinstanceofExcludedVariableand
-// Dont consider template instantiations because instantiations with
-// Fixed Width Types are recorded after stripping their typedef'd type,
-// thereby, causing false positives (#540).
-notv.isFromTemplateInstantiation(_)and
-//post-increment/post-decrement operators are required by the standard to have a dummy int parameter
-notv.(Parameter).getFunction()instanceofPostIncrementOperatorand
-notv.(Parameter).getFunction()instanceofPostDecrementOperator
-selectv,"Variable '"+v.getName()+"' has variable-width type."
+classVariableWidthIntegerTypesUsedQueryextendsVariableWidthIntegerTypesUsedSharedQuery{
+VariableWidthIntegerTypesUsedQuery(){
+this= DeclarationsPackage::variableWidthIntegerTypesUsedQuery()
+}
+}

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

@@ -0,0 +1 @@
+cpp/common/test/rules/variablewidthintegertypesused/VariableWidthIntegerTypesUsed.ql

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

@@ -1,3 +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. |
+| test.cpp:10:14:10:15 | c1 | Variable 'c1' has variable-width char type. |
+| test.cpp:14:17:14:18 | c2 | Variable 'c2' has variable-width char type. |

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

@@ -2,88 +2,16 @@
 
 voidtest_variable_width_type_variables(){
 char c; // NON_COMPLIANT
-unsignedchar uc; // NON_COMPLIANT
-signedchar sc; // NON_COMPLIANT
-
-int i; // NON_COMPLIANT
-unsignedint ui; // NON_COMPLIANT
-unsigned u; // NON_COMPLIANT
-signedint si; // NON_COMPLIANT
-signed s; // NON_COMPLIANT
-
-short sh; // NON_COMPLIANT
-unsignedshort ush; // NON_COMPLIANT
-signedshort ssh; // NON_COMPLIANT
-
-long l; // NON_COMPLIANT
-unsignedlong ul; // NON_COMPLIANT
-signedlong sl; // NON_COMPLIANT
-
- std::int8_ti8; // COMPLIANT
- std::int16_ti16; // COMPLIANT
- std::int32_ti32; // COMPLIANT
- std::int64_ti64; // COMPLIANT
-
- std::uint8_tu8; // COMPLIANT
- std::uint16_tu16; // COMPLIANT
- std::uint32_tu32; // COMPLIANT
- std::uint64_tu64; // COMPLIANT
-}
-
-intmain(int argc, char *argv[]){// COMPLIANT
-// main as an exception
+unsignedchar uc; // COMPLIANT - covered by VariableWidthIntegerTypesUsed
+signedchar sc; // COMPLIANT - covered by VariableWidthIntegerTypesUsed
 }
 
 voidtest_variable_width_type_qualified_variables(){
 constchar c1 = 0; // NON_COMPLIANT
-constunsignedchar uc1 = 0; // NON_COMPLIANT
-constsignedchar sc1 = 0; // NON_COMPLIANt
-
-constint i1 = 0; // NON_COMPLIANT
-constunsignedint ui1 = 0; // NON_COMPLIANT
-constunsigned u1 = 0; // NON_COMPLIANT
-constsignedint si1 = 0; // NON_COMPLIANT
-constsigned s1 = 0; // NON_COMPLIANT
-
-constshort sh1 = 0; // NON_COMPLIANT
-constunsignedshort ush1 = 0; // NON_COMPLIANT
-constsignedshort ssh1 = 0; // NON_COMPLIANT
-
-constlong l1 = 0; // NON_COMPLIANT
-constunsignedlong ul1 = 0; // NON_COMPLIANT
-constsignedlong sl1 = 0; // NON_COMPLIANT
+constunsignedchar uc1 = 0; // COMPLIANT - (VariableWidthIntegerTypesUsed)
+constsignedchar sc1 = 0; // COMPLIANT - (VariableWidthIntegerTypesUsed)
 
 volatilechar c2; // NON_COMPLIANT
-volatileunsignedchar uc2; // NON_COMPLIANT
-volatilesignedchar sc2; // NON_COMPLIANt
-
-volatileint i2; // NON_COMPLIANT
-volatileunsignedint ui2; // NON_COMPLIANT
-volatileunsigned u2; // NON_COMPLIANT
-volatilesignedint si2; // NON_COMPLIANT
-volatilesigned s2; // NON_COMPLIANT
-
-volatileshort sh2; // NON_COMPLIANT
-volatileunsignedshort ush2; // NON_COMPLIANT
-volatilesignedshort ssh2; // NON_COMPLIANT
-
-volatilelong l2; // NON_COMPLIANT
-volatileunsignedlong ul2; // NON_COMPLIANT
-volatilesignedlong sl2; // NON_COMPLIANT
-}
-
-structtest_fix_fp_614{
- test_fix_fp_614 operator++(int); // COMPLIANT
- test_fix_fp_614 operator--(int); // COMPLIANT
-};
-
-// COMPLIANT - instantiated with Fixed Width Types.
-template <typename MyType> constexprvoidtest_fix_fp_540(MyType value){
- value++;
-}
-
-intcall_test_fix_fp_540(){
- test_fix_fp_540<std::uint8_t>(19);
- test_fix_fp_540<std::int16_t>(20);
-return0;
-}
+volatileunsignedchar uc2; // COMPLIANT - (VariableWidthIntegerTypesUsed)
+volatilesignedchar sc2; // COMPLIANT - (VariableWidthIntegerTypesUsed)
+}

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

@@ -0,0 +1,69 @@
+/**
+ * A library for supporting the consistent detection of banned functions in C++ code.
+ */
+
+import cpp
+import AlertReporting
+
+/**
+ * A signature for a banned function.
+ */
+signatureclassBannedFunctionextendsFunction;
+
+/**
+ * A module for detecting uses of banned functions in C++ code.
+ */
+module BannedFunctions<BannedFunction F>{
+finalprivateclassFinalExpr=Expr;
+
+/**
+ * An expression that uses a banned function.
+ *
+ * It can be either a function call or a function access (taking the address of the function).
+ */
+classUseExprextendsFinalExpr{
+stringaction;
+FbannedFunction;
+
+UseExpr(){
+this.(FunctionCall).getTarget()=bannedFunctionand
+action="Call to"
+or
+this.(FunctionAccess).getTarget()=bannedFunctionand
+action="Address taken for"
+}
+
+stringgetFunctionName(){result=bannedFunction.getName()}
+
+stringgetAction(){result=action}
+
+ElementgetPrimaryElement(){
+// If this is defined in a macro in the users source location, then report the macro
+// expansion, otherwise report the element itself. This ensures that we always report
+// the use of the terminating function, but combine usages when the macro is defined
+// by the user.
+exists(Elemente|e= MacroUnwrapper<UseExpr>::unwrapElement(this)|
+ifexists(e.getFile().getRelativePath())thenresult=eelseresult=this
+)
+}
+}
+
+finalprivateclassFinalElement=Element;
+
+/**
+ * A `Use` of a banned function.
+ *
+ * This is an `Element` in a program which represents the use of a banned function.
+ * For uses within macro expansions, this may report the location of the macro, if
+ * it is defined within the user's source code.
+ */
+classUseextendsFinalElement{
+UseExpruse;
+
+Use(){this=use.getPrimaryElement()}
+
+stringgetFunctionName(){result=use.getFunctionName()}
+
+stringgetAction(){result=use.getAction()}
+}
+}

cpp/common/src/codingstandards/cpp/BannedFunctions.qll

@@ -20,3 +20,10 @@ class BuiltInIntegerType extends BuiltInType{
 classExcludedVariableextendsParameter{
 ExcludedVariable(){getFunction()instanceofMainFunction}
 }
+
+/**
+ * Any main function.
+ */
+classExcludedFunctionextendsFunction{
+ExcludedFunction(){thisinstanceofMainFunction}
+}