Skip to content

Rust: Extract SelfParams from crate graph #19369

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
hvitved merged 2 commits into from
Apr 29, 2025
Merged

Rust: Extract SelfParams from crate graph #19369

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6df5a1e
Rust: Extract `SelfParam`s from crate graph
hvitved Apr 24, 2025
7e20536
Rust: Adjust `clone` modeling
hvitved Apr 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 37 additions & 8 deletions rust/extractor/src/crate_graph.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -383,25 +383,54 @@ fn emit_function(
assert_eq!(sig.binders.len(Interner), parameters.len());
let sig = sig.skip_binders();
let ty_vars = &[parameters];
let function_data = db.function_data(function);
let mut self_param = None;
let params = sig
.params()
.iter()
.map(|p| {
.enumerate()
.filter_map(|(idx, p)| {
let type_repr = emit_hir_ty(trap, db, ty_vars, p);
trap.emit(generated::Param {
id: trap::TrapId::Star,
attrs: vec![],
type_repr,
pat: None,
})

if idx == 0 && function_data.has_self_param() {
Copy link

Copilot AI Apr 25, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider extracting the self parameter logic into a separate helper function to improve clarity and reduce complexity in the parameter iteration block.

Copilot uses AI. Check for mistakes.
// Check if the self parameter is a reference
let (is_ref, is_mut) = match p.kind(Interner) {
chalk_ir::TyKind::Ref(mutability, _, _) => {
(true, matches!(mutability, chalk_ir::Mutability::Mut))
}
chalk_ir::TyKind::Raw(mutability, _) => {
(false, matches!(mutability, chalk_ir::Mutability::Mut))
}
_ => (false, false),
};

self_param = Some(trap.emit(generated::SelfParam {
id: trap::TrapId::Star,
attrs: vec![],
type_repr,
is_ref,
is_mut,
lifetime: None,
name: None,
Comment on lines +413 to +414
Copy link
Contributor

@aibaars aibaars Apr 29, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't the name be simply self? Is it possible to populate the lifetime field, or is it not important?

Copy link
Contributor Author

@hvitved hvitved Apr 29, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I decided to not populate the name, since we also don't do that for non-self parameters. Lifetimes are currently not important.

}));
None
} else {
Some(trap.emit(generated::Param {
id: trap::TrapId::Star,
attrs: vec![],
type_repr,
pat: None,
}))
}
})
.collect();

let ret_type = emit_hir_ty(trap, db, ty_vars, sig.ret());

let param_list = trap.emit(generated::ParamList {
id: trap::TrapId::Star,
params,
self_param: None,
self_param,
});
let ret_type = ret_type.map(|ret_type| {
trap.emit(generated::RetTypeRepr {
Expand Down
4 changes: 3 additions & 1 deletion rust/ql/lib/codeql/rust/frameworks/stdlib/Clone.qll
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,9 @@ final class CloneCallable extends SummarizedCallable::Range {
final override predicate propagatesFlow(
string input, string output, boolean preservesValue, string model
) {
input = "Argument[self]" and
// The `clone` method takes a `&self` parameter and dereferences it;
// make sure to not clone the reference itself
input = ["Argument[self].Reference", "Argument[self].WithoutReference"] and
output = "ReturnValue" and
preservesValue = true and
model = "generated"
Expand Down
6 changes: 6 additions & 0 deletions rust/ql/test/library-tests/dataflow/modeled/inline-flow.expected
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,18 +8,22 @@ models
| 7 | Summary: lang:core; crate::ptr::write; Argument[1]; Argument[0].Reference; value |
edges
| main.rs:12:9:12:9 | a [Some] | main.rs:13:10:13:19 | a.unwrap() | provenance | MaD:2 |
| main.rs:12:9:12:9 | a [Some] | main.rs:14:13:14:13 | a [Some] | provenance | |
| main.rs:12:9:12:9 | a [Some] | main.rs:14:13:14:21 | a.clone() [Some] | provenance | MaD:1 |
| main.rs:12:9:12:9 | a [Some] | main.rs:14:13:14:21 | a.clone() [Some] | provenance | generated |
| main.rs:12:13:12:28 | Some(...) [Some] | main.rs:12:9:12:9 | a [Some] | provenance | |
| main.rs:12:18:12:27 | source(...) | main.rs:12:13:12:28 | Some(...) [Some] | provenance | |
| main.rs:14:9:14:9 | b [Some] | main.rs:15:10:15:19 | b.unwrap() | provenance | MaD:2 |
| main.rs:14:13:14:13 | a [Some] | main.rs:14:13:14:21 | a.clone() [Some] | provenance | generated |
| main.rs:14:13:14:21 | a.clone() [Some] | main.rs:14:9:14:9 | b [Some] | provenance | |
| main.rs:19:9:19:9 | a [Ok] | main.rs:20:10:20:19 | a.unwrap() | provenance | MaD:5 |
| main.rs:19:9:19:9 | a [Ok] | main.rs:21:13:21:13 | a [Ok] | provenance | |
| main.rs:19:9:19:9 | a [Ok] | main.rs:21:13:21:21 | a.clone() [Ok] | provenance | MaD:4 |
| main.rs:19:9:19:9 | a [Ok] | main.rs:21:13:21:21 | a.clone() [Ok] | provenance | generated |
| main.rs:19:31:19:44 | Ok(...) [Ok] | main.rs:19:9:19:9 | a [Ok] | provenance | |
| main.rs:19:34:19:43 | source(...) | main.rs:19:31:19:44 | Ok(...) [Ok] | provenance | |
| main.rs:21:9:21:9 | b [Ok] | main.rs:22:10:22:19 | b.unwrap() | provenance | MaD:5 |
| main.rs:21:13:21:13 | a [Ok] | main.rs:21:13:21:21 | a.clone() [Ok] | provenance | generated |
| main.rs:21:13:21:21 | a.clone() [Ok] | main.rs:21:9:21:9 | b [Ok] | provenance | |
| main.rs:26:9:26:9 | a | main.rs:27:10:27:10 | a | provenance | |
| main.rs:26:9:26:9 | a | main.rs:28:13:28:21 | a.clone() | provenance | generated |
Expand Down Expand Up @@ -57,13 +61,15 @@ nodes
| main.rs:12:18:12:27 | source(...) | semmle.label | source(...) |
| main.rs:13:10:13:19 | a.unwrap() | semmle.label | a.unwrap() |
| main.rs:14:9:14:9 | b [Some] | semmle.label | b [Some] |
| main.rs:14:13:14:13 | a [Some] | semmle.label | a [Some] |
| main.rs:14:13:14:21 | a.clone() [Some] | semmle.label | a.clone() [Some] |
| main.rs:15:10:15:19 | b.unwrap() | semmle.label | b.unwrap() |
| main.rs:19:9:19:9 | a [Ok] | semmle.label | a [Ok] |
| main.rs:19:31:19:44 | Ok(...) [Ok] | semmle.label | Ok(...) [Ok] |
| main.rs:19:34:19:43 | source(...) | semmle.label | source(...) |
| main.rs:20:10:20:19 | a.unwrap() | semmle.label | a.unwrap() |
| main.rs:21:9:21:9 | b [Ok] | semmle.label | b [Ok] |
| main.rs:21:13:21:13 | a [Ok] | semmle.label | a [Ok] |
| main.rs:21:13:21:21 | a.clone() [Ok] | semmle.label | a.clone() [Ok] |
| main.rs:22:10:22:19 | b.unwrap() | semmle.label | b.unwrap() |
| main.rs:26:9:26:9 | a | semmle.label | a |
Expand Down
3 changes: 2 additions & 1 deletion rust/ql/test/library-tests/type-inference/type-inference.ql
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@ import codeql.rust.internal.TypeInference as TypeInference
import TypeInference

query predicate inferType(AstNode n, TypePath path, Type t) {
t = TypeInference::inferType(n, path)
t = TypeInference::inferType(n, path) and
n.fromSource()
}

module ResolveTest implements TestSig {
Expand Down
13 changes: 13 additions & 0 deletions rust/ql/test/query-tests/security/CWE-089/CONSISTENCY/PathResolutionConsistency.expected
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
multipleMethodCallTargets
| sqlx.rs:65:30:65:52 | unsafe_query_2.as_str() | file://:0:0:0:0 | fn as_str |
| sqlx.rs:65:30:65:52 | unsafe_query_2.as_str() | file://:0:0:0:0 | fn as_str |
| sqlx.rs:65:30:65:52 | unsafe_query_2.as_str() | file://:0:0:0:0 | fn as_str |
| sqlx.rs:65:30:65:52 | unsafe_query_2.as_str() | file://:0:0:0:0 | fn as_str |
| sqlx.rs:65:30:65:52 | unsafe_query_2.as_str() | file://:0:0:0:0 | fn as_str |
| sqlx.rs:65:30:65:52 | unsafe_query_2.as_str() | file://:0:0:0:0 | fn as_str |
| sqlx.rs:76:29:76:51 | unsafe_query_2.as_str() | file://:0:0:0:0 | fn as_str |
| sqlx.rs:76:29:76:51 | unsafe_query_2.as_str() | file://:0:0:0:0 | fn as_str |
| sqlx.rs:76:29:76:51 | unsafe_query_2.as_str() | file://:0:0:0:0 | fn as_str |
| sqlx.rs:76:29:76:51 | unsafe_query_2.as_str() | file://:0:0:0:0 | fn as_str |
| sqlx.rs:76:29:76:51 | unsafe_query_2.as_str() | file://:0:0:0:0 | fn as_str |
| sqlx.rs:76:29:76:51 | unsafe_query_2.as_str() | file://:0:0:0:0 | fn as_str |