C++: Add missing ReadFileEx flow summary
#19595
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
Pull Request Overview
This PR adds flow tests and a summary model for the hEvent field on OVERLAPPED when used with ReadFileEx, ensuring that the field is correctly propagated to completion routines.
- Introduces two new completion routines (
FileIOCompletionRoutine2,FileIOCompletionRoutine3) and correspondingReadFileExtest cases inwindows.cpp. - Updates expected test outputs (
validatemodels.expected,sources.expected,flow.expected,nodes) to reflect the new dataflow. - Adds a new summary entry for
ReadFileExinWindows.model.yml.
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| cpp/ql/test/library-tests/dataflow/external-models/windows.cpp | Added FileIOCompletionRoutine2/3 and two new ReadFileEx tests |
| cpp/ql/test/library-tests/dataflow/external-models/validatemodels.expected | Added unrecognized spec warnings for new hEvent model entries |
| cpp/ql/test/library-tests/dataflow/external-models/sources.expected | Updated source locations for new read/write flows |
| cpp/ql/test/library-tests/dataflow/external-models/flow.expected | Expanded flow edges for the new summary parameters |
| cpp/ql/lib/ext/Windows.model.yml | Inserted a new manual summary entry for ReadFileEx’s hEvent field |
jketema
approved these changes
May 27, 2025
|
DCA was uneventful (as expected) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The
hEventfield onOVERLAPPEDremains unchanged when passed fromReadFileExto the callback function. This PR adds a summary model that reflects this.Thanks for noticing this funny behavior, @jketema!