Rust: Model pointer read and write functions #18896
Open
Conversation
This file contains 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
paldepind
force-pushed
the
rust-model-ptr-rw
branch
from
c6f56fc to
c4773c4
Compare
There was a problem hiding this comment.
PR Overview
This PR extends the Rust models by incorporating pointer read and write functions and updating the custom option model to use a dedicated replace function.
- Added a new module in the modeled tests to simulate pointer operations using unsafe read/write.
- Updated the custom MyOption implementations to use a new replace function instead of mem::replace.
- Extended the Rust standard library model to include pointer operations.
Reviewed Changes
| File | Description |
|---|---|
| rust/ql/test/library-tests/dataflow/modeled/main.rs | Adds a new module for pointer read/write tests and adjusts import ordering and punctuation. |
| rust/ql/test/utils-tests/modelgenerator/option.rs | Introduces a custom replace function and updates MyOption methods to use it. |
| rust/ql/lib/codeql/rust/frameworks/stdlib/lang-core.model.yml | Augments the core model with pointer operation summaries. |
Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.
Comments suppressed due to low confidence (1)
rust/ql/test/utils-tests/modelgenerator/option.rs:13
- [nitpick] The custom function name 'replace' may be confused with std::mem::replace. Consider renaming it to something more distinctive, such as 'custom_replace'.
pub fn replace<T>(dest: &mut T, src: T) -> T {
Tip: Copilot only keeps its highest confidence comments to reduce noise and keep you focused. Learn more
paldepind
force-pushed
the
rust-model-ptr-rw
branch
from
f5c436f to
77e1161
Compare
paldepind
force-pushed
the
rust-model-ptr-rw
branch
from
77e1161 to
c1ee20b
Compare
geoffw0
approved these changes
Feb 28, 2025
| @@ -14,7 +14,7 @@ | |||
| | Macro calls - resolved | 2 | | |||
| | Macro calls - total | 2 | | |||
| | Macro calls - unresolved | 0 | | |||
| | Taint edges - number of edges | 1471 | | |||
| | Taint edges - number of edges | 1670 | | |||
There was a problem hiding this comment.
I wonder if this row of output is something we should keep, or is it more bother than it's worth?
geoffw0
reviewed
Feb 28, 2025
| @@ -18,14 +18,15 @@ extensions: | |||
| - ["lang:alloc", "<crate::borrow::Cow as crate::ops::arith::AddAssign>::add_assign", "Argument[0]", "Argument[self].Reference", "value", "dfc-generated"] | |||
| - ["lang:alloc", "<crate::borrow::Cow as crate::ops::deref::Deref>::deref", "Argument[self].Reference.Field[crate::borrow::Cow::Borrowed(0)]", "ReturnValue", "value", "dfc-generated"] | |||
| - ["lang:alloc", "<crate::borrow::Cow>::into_owned", "Argument[self].Field[crate::borrow::Cow::Owned(0)]", "ReturnValue", "value", "dfc-generated"] | |||
| - ["lang:alloc", "<crate::borrow::Cow>::to_mut", "Argument[self].Reference.Field[crate::borrow::Cow::Owned(0)]", "ReturnValue", "value", "dfc-generated"] | |||
| - ["lang:alloc", "<crate::borrow::Cow>::to_mut", "Argument[self].Reference.Field[crate::borrow::Cow::Owned(0)]", "ReturnValue.Reference", "value", "dfc-generated"] | |||
There was a problem hiding this comment.
When should the qualifier be Argument[self].Reference vs just Argument[self]? I thought self is always a reference?
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.
Adds models for
ptr::readandptr::write. Since these are rather low-level, modelling them allows us to generate new models formem::replace,mem::take,Option::take,Option::replace, and a number of other things (that I haven't paid much attention to).