Conversation
also adjust formatting on prev changenote which was incorrect
MichaelRFairhurst
left a comment
There was a problem hiding this comment.
The test cases look great Kristen, thank you!
| AllocatedObjectIdentity() { | ||
| this.(FunctionCall).getTarget().(AllocationFunction).requiresDealloc() | ||
| or | ||
| this = any(NewOrNewArrayExpr new | not exists(new.getPlacementPointer())) |
There was a problem hiding this comment.
Pull request overview
This PR adds a new "Lifetime" rule package for MISRA C++ 2023, implementing two new rules: RULE-11-6-2 (reading uninitialized objects) and RULE-6-8-3 (automatic storage assigned to wider lifetime). It also enhances the shared ReadOfUninitializedMemory query to detect uninitialized reads through new expressions without value initialization, and extends the AllocatedObjectIdentity class to recognize new/new[] expressions as allocated storage.
Changes:
- Adds the Lifetime rule package with RULE-11-6-2 and RULE-6-8-3, including exclusion metadata, query files, test references, and supporting infrastructure.
- Enhances the
ReadOfUninitializedMemoryshared library to detect uninitialized memory accessed vianewexpressions (without value initialization), incorporating a copiedInitializationFunctions.qllfrom the CodeQL standard library. - Extends
AllocatedObjectIdentityinCppObjects.qllto includenew/new[]expressions (excluding placement new) for storage duration tracking.
Reviewed changes
Copilot reviewed 17 out of 17 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
rules.csv |
Updates RULE-11-6-2 to reference the Lifetime package |
rule_packages/cpp/Lifetime.json |
New rule package definition for RULE-11-6-2 and RULE-6-8-3 |
cpp/common/src/codingstandards/cpp/exclusions/cpp/Lifetime.qll |
Autogenerated exclusion module for Lifetime package |
cpp/common/src/codingstandards/cpp/exclusions/cpp/RuleMetadata.qll |
Integrates Lifetime package into rule metadata |
cpp/misra/src/rules/RULE-11-6-2/ValueOfAnObjectMustNotBeReadBeforeItHasBeenSet.ql |
New query for RULE-11-6-2 using shared ReadOfUninitializedMemory |
cpp/misra/src/rules/RULE-6-8-3/AutomaticStorageAssignedToObjectGreaterLifetime.ql |
New query for RULE-6-8-3 using shared DoNotCopyAddressOfAutoStorage |
cpp/common/src/codingstandards/cpp/rules/readofuninitializedmemory/ReadOfUninitializedMemory.qll |
Enhanced to handle new without value init |
cpp/common/src/codingstandards/cpp/rules/readofuninitializedmemory/InitializationFunctions.qll |
Copied from CodeQL standard library for init function tracking |
cpp/common/src/codingstandards/cpp/lifetimes/CppObjects.qll |
Extended AllocatedObjectIdentity for new/new[] expressions |
cpp/common/test/rules/readofuninitializedmemory/test.cpp |
Added test cases for new uninitialized memory scenarios |
cpp/common/test/rules/readofuninitializedmemory/ReadOfUninitializedMemory.expected |
Updated expected results for new test cases |
cpp/common/test/rules/donotcopyaddressofautostorageobjecttootherobject/test.cpp |
Added test cases for auto-storage address escape |
cpp/common/test/rules/donotcopyaddressofautostorageobjecttootherobject/DoNotCopyAddressOfAutoStorageObjectToOtherObject.expected |
Updated expected results for new test cases |
cpp/misra/test/rules/RULE-6-8-3/AutomaticStorageAssignedToObjectGreaterLifetime.testref |
Test reference for RULE-6-8-3 |
cpp/misra/test/rules/RULE-11-6-2/ValueOfAnObjectMustNotBeReadBeforeItHasBeenSet.testref |
Test reference for RULE-11-6-2 |
change_notes/2026-02-03-uninitialized-mem-improve.md |
Change note for shared query modifications |
.vscode/tasks.json |
Added Lifetime to VS Code task configuration |
Comments suppressed due to low confidence (1)
cpp/common/src/codingstandards/cpp/rules/readofuninitializedmemory/ReadOfUninitializedMemory.qll:207
- Typo in docstring: "Get a access" should be "Gets an access".
* Get a access of the variable that is assumed to initialize the variable.
cpp/misra/src/rules/RULE-6-8-3/AutomaticStorageAssignedToObjectGreaterLifetime.ql
Outdated
Show resolved
Hide resolved
| cpp,MISRA-C++-2023,RULE-11-3-2,Yes,Advisory,Decidable,Single Translation Unit,The declaration of an object should contain no more than two levels of pointer indirection,A5-0-3,ImportMisra23,Import, | ||
| cpp,MISRA-C++-2023,RULE-11-6-1,Yes,Advisory,Decidable,Single Translation Unit,All variables should be initialized,,Declarations2,Easy, | ||
| cpp,MISRA-C++-2023,RULE-11-6-2,Yes,Mandatory,Undecidable,System,The value of an object must not be read before it has been set,A8-5-0,Lifetime,Very Hard, | ||
| cpp,MISRA-C++-2023,RULE-11-6-2,Yes,Mandatory,Undecidable,System,The value of an object must not be read before it has been set,A8-5-0,Lifetime,Import |
There was a problem hiding this comment.
The RULE-11-6-2 row is missing a trailing comma after Import. All other rows in the CSV consistently end with a comma after the difficulty field (e.g., line 929: ...,Import,). This could cause parsing issues with downstream tools that process the CSV.
| cpp,MISRA-C++-2023,RULE-11-6-2,Yes,Mandatory,Undecidable,System,The value of an object must not be read before it has been set,A8-5-0,Lifetime,Import | |
| cpp,MISRA-C++-2023,RULE-11-6-2,Yes,Mandatory,Undecidable,System,The value of an object must not be read before it has been set,A8-5-0,Lifetime,Import, |
...common/src/codingstandards/cpp/rules/readofuninitializedmemory/ReadOfUninitializedMemory.qll
Show resolved
Hide resolved
we will need to change these cases in batches
MichaelRFairhurst
left a comment
There was a problem hiding this comment.
OK, there's a lot of text here, but I think it boils down to actually pretty simple changes, its just complicated to think through and fully explain the implications of X vs Y 😕 I would have written less if I olny had more time! :)
I'm 100% glad that you pursued the approach. I think with a small few tweaks this implementation will be very precise, and handling new int without a major overhaul was absolutely the correct choice. 🎉
Let me know if anything here is unclear or if I missed anything!
...common/src/codingstandards/cpp/rules/readofuninitializedmemory/ReadOfUninitializedMemory.qll
Show resolved
Hide resolved
...common/src/codingstandards/cpp/rules/readofuninitializedmemory/ReadOfUninitializedMemory.qll
Show resolved
Hide resolved
...common/src/codingstandards/cpp/rules/readofuninitializedmemory/ReadOfUninitializedMemory.qll
Show resolved
Hide resolved
| not result = any(AssignExpr a).getLValue() and | ||
| // Not passed to another initialization function | ||
| not exists(Call c, int j | j = c.getTarget().(InitializationFunction).initializedParameter() | | ||
| result = c.getArgument(j).(AddressOfExpr).getOperand() |
There was a problem hiding this comment.
Consider adding or result = c.getArgument(j), that would handle:
void f(int *p) {
*p = 0;
}
void g() {
int *p = new int;
f(p); // compliant
use(*p); // compliant
}
In fact we might want to rely on .isRValueCategory() and not exists(Call ... | ... result = c.getArgument(j)).
In general, if x appears in &x, that should mean imply not .isRValueCategory() for x. So technically, int *p = &x would previously have not been considered a use and now will be.
Overall, isRValueCategory() should find only cases where x could not be initialized (only reads + copies). So we were already very conservative in what we consider a use.
The catch is that copying or reading x may be how someone initializes *x, such as in the above example with f(p). So with our new x+*x analysis, we can't guarantee isRValueCategory() for x means we don't initialize *x. Really any rvalue use could lead to initialization of *x.
We also don't want to lose the ability to analyze uninitialized pointers more generally (as in, int *p; f(p); which is never valid and can segfault, and the current query should catch).
Ultimately, for *x vs x:
- if
*xis used as an rvalue, that's problematic ifxhad a non-init new - otherwise, all uses of
xas an rvalue require thatxhad any initializer - If
xis used as an lvalue in*x, that's problematic ifxhad no initializer - All other lvalue uses of
xare valid - It's always valid if
*xis used as an lvalue if x had any initializer
Ultimately, I think it would probably be fine to say:
- track
x = new intas an "uninitialized variable" - count rvalue
xas a use if notnew int - count lvalue
xas a use if used in*xand notnew int - count rvalue
*xas a use if hasnew int - don't count lvalue
*xas a use in and of itself
Description
add rules for lifetime package, two shared rules, one with improvements upon previous, one as simple shared
Change request type
.ql,.qll,.qlsor unit tests)Rules with added or modified queries
Release change checklist
A change note (development_handbook.md#change-notes) is required for any pull request which modifies:
If you are only adding new rule queries, a change note is not required.
Author: Is a change note required?
🚨🚨🚨
Reviewer: Confirm that format of shared queries (not the .qll file, the
.ql file that imports it) is valid by running them within VS Code.
Reviewer: Confirm that either a change note is not required or the change note is required and has been added.
Query development review checklist
For PRs that add new queries or modify existing queries, the following checklist should be completed by both the author and reviewer:
Author
As a rule of thumb, predicates specific to the query should take no more than 1 minute, and for simple queries be under 10 seconds. If this is not the case, this should be highlighted and agreed in the code review process.
Reviewer
As a rule of thumb, predicates specific to the query should take no more than 1 minute, and for simple queries be under 10 seconds. If this is not the case, this should be highlighted and agreed in the code review process.