Merge pull request #18041 from paldepind/rust-cfg-self

Rust: Include `self` parameters in the CFG
github · Nov 21, 2024 · 8c74478 · 8c74478
2 parents 82ca369 + 93f6f04
commit 8c74478
Show file tree

Hide file tree

Showing 4 changed files with 67 additions and 4 deletions.
diff --git a/rust/ql/lib/codeql/rust/controlflow/internal/ControlFlowGraphImpl.qll b/rust/ql/lib/codeql/rust/controlflow/internal/ControlFlowGraphImpl.qll
@@ -73,9 +73,12 @@ class CallableScopeTree extends StandardTree, PreOrderTree, PostOrderTree, Scope
   override predicate propagatesAbnormal(AstNode child) { none() }
 
   override AstNode getChildNode(int i) {
-    result = this.getParamList().getParam(i)
+    i = 0 and
+    result = this.getParamList().getSelfParam()
     or
-    i = this.getParamList().getNumberOfParams() and
+    result = this.getParamList().getParam(i - 1)
+    or
+    i = this.getParamList().getNumberOfParams() + 1 and
     result = this.getBody()
   }
 }
@@ -191,6 +194,10 @@ class NameTree extends LeafTree, Name { }
 
 class NameRefTree extends LeafTree, NameRef { }
 
+class SelfParamTree extends StandardPostOrderTree, SelfParam {
+  override AstNode getChildNode(int i) { i = 0 and result = this.getName() }
+}
+
 class TypeRefTree extends LeafTree instanceof TypeRef { }
 
 /**

diff --git a/rust/ql/test/library-tests/controlflow/Cfg.expected b/rust/ql/test/library-tests/controlflow/Cfg.expected
@@ -1044,6 +1044,40 @@ edges
 | test.rs:490:5:490:19 | ExprStmt | test.rs:490:5:490:10 | nested |  |
 | test.rs:490:12:490:17 | RefExpr | test.rs:490:5:490:18 | CallExpr |  |
 | test.rs:490:17:490:17 | x | test.rs:490:12:490:17 | RefExpr |  |
+| test.rs:502:5:504:5 | enter new | test.rs:502:12:502:12 | a |  |
+| test.rs:502:5:504:5 | exit new (normal) | test.rs:502:5:504:5 | exit new |  |
+| test.rs:502:12:502:12 | a | test.rs:502:12:502:17 | Param | match |
+| test.rs:502:12:502:17 | Param | test.rs:503:23:503:23 | a |  |
+| test.rs:502:28:504:5 | BlockExpr | test.rs:502:5:504:5 | exit new (normal) |  |
+| test.rs:503:9:503:25 | RecordExpr | test.rs:502:28:504:5 | BlockExpr |  |
+| test.rs:503:23:503:23 | a | test.rs:503:9:503:25 | RecordExpr |  |
+| test.rs:506:5:508:5 | enter negated | test.rs:506:16:506:19 | self |  |
+| test.rs:506:5:508:5 | exit negated (normal) | test.rs:506:5:508:5 | exit negated |  |
+| test.rs:506:16:506:19 | SelfParam | test.rs:507:23:507:26 | self |  |
+| test.rs:506:16:506:19 | self | test.rs:506:16:506:19 | SelfParam |  |
+| test.rs:506:30:508:5 | BlockExpr | test.rs:506:5:508:5 | exit negated (normal) |  |
+| test.rs:507:9:507:30 | RecordExpr | test.rs:506:30:508:5 | BlockExpr |  |
+| test.rs:507:23:507:26 | self | test.rs:507:23:507:28 | FieldExpr |  |
+| test.rs:507:23:507:28 | FieldExpr | test.rs:507:9:507:30 | RecordExpr |  |
+| test.rs:510:5:512:5 | enter multifly_add | test.rs:510:26:510:29 | self |  |
+| test.rs:510:5:512:5 | exit multifly_add (normal) | test.rs:510:5:512:5 | exit multifly_add |  |
+| test.rs:510:21:510:29 | SelfParam | test.rs:510:32:510:32 | a |  |
+| test.rs:510:26:510:29 | self | test.rs:510:21:510:29 | SelfParam |  |
+| test.rs:510:32:510:32 | a | test.rs:510:32:510:37 | Param | match |
+| test.rs:510:32:510:37 | Param | test.rs:510:40:510:40 | b |  |
+| test.rs:510:40:510:40 | b | test.rs:510:40:510:45 | Param | match |
+| test.rs:510:40:510:45 | Param | test.rs:511:9:511:34 | ExprStmt |  |
+| test.rs:510:48:512:5 | BlockExpr | test.rs:510:5:512:5 | exit multifly_add (normal) |  |
+| test.rs:511:9:511:12 | self | test.rs:511:9:511:14 | FieldExpr |  |
+| test.rs:511:9:511:14 | FieldExpr | test.rs:511:19:511:22 | self |  |
+| test.rs:511:9:511:33 | ... = ... | test.rs:510:48:512:5 | BlockExpr |  |
+| test.rs:511:9:511:34 | ExprStmt | test.rs:511:9:511:12 | self |  |
+| test.rs:511:18:511:33 | ... + ... | test.rs:511:9:511:33 | ... = ... |  |
+| test.rs:511:19:511:22 | self | test.rs:511:19:511:24 | FieldExpr |  |
+| test.rs:511:19:511:24 | FieldExpr | test.rs:511:28:511:28 | a |  |
+| test.rs:511:19:511:28 | ... * ... | test.rs:511:33:511:33 | b |  |
+| test.rs:511:28:511:28 | a | test.rs:511:19:511:28 | ... * ... |  |
+| test.rs:511:33:511:33 | b | test.rs:511:18:511:33 | ... + ... |  |
 breakTarget
 | test.rs:34:17:34:21 | BreakExpr | test.rs:28:9:40:9 | LoopExpr |
 | test.rs:48:21:48:25 | BreakExpr | test.rs:46:13:53:13 | LoopExpr |

diff --git a/rust/ql/test/library-tests/controlflow/test.rs b/rust/ql/test/library-tests/controlflow/test.rs
@@ -493,3 +493,21 @@ fn test_nested_function2() {
 trait MyFrom<T> {
     fn my_from(x: T) -> Self;
 }
+
+struct MyNumber {
+    n: i64,
+}
+
+impl MyNumber {
+    fn new(a: i64) -> Self {
+        MyNumber { n: a }
+    }
+
+    fn negated(self) -> Self {
+        MyNumber { n: self.n }
+    }
+
+    fn multifly_add(&mut self, a: i64, b: i64) {
+        self.n = (self.n * a) + b;
+    }
+}
diff --git a/rust/ql/test/library-tests/variables/Cfg.expected b/rust/ql/test/library-tests/variables/Cfg.expected
@@ -1070,8 +1070,10 @@ edges
 | variables.rs:472:9:472:20 | CallExpr | variables.rs:471:12:473:5 | BlockExpr |  |
 | variables.rs:472:9:472:21 | ExprStmt | variables.rs:472:9:472:17 | print_i64 |  |
 | variables.rs:472:19:472:19 | x | variables.rs:472:9:472:20 | CallExpr |  |
-| variables.rs:482:5:484:5 | enter my_get | variables.rs:483:9:483:24 | ExprStmt |  |
+| variables.rs:482:5:484:5 | enter my_get | variables.rs:482:20:482:23 | self |  |
 | variables.rs:482:5:484:5 | exit my_get (normal) | variables.rs:482:5:484:5 | exit my_get |  |
+| variables.rs:482:15:482:23 | SelfParam | variables.rs:483:9:483:24 | ExprStmt |  |
+| variables.rs:482:20:482:23 | self | variables.rs:482:15:482:23 | SelfParam |  |
 | variables.rs:483:9:483:23 | ReturnExpr | variables.rs:482:5:484:5 | exit my_get (normal) | return |
 | variables.rs:483:9:483:24 | ExprStmt | variables.rs:483:16:483:19 | self |  |
 | variables.rs:483:16:483:19 | self | variables.rs:483:16:483:23 | FieldExpr |  |
@@ -1131,8 +1133,10 @@ edges
 | variables.rs:502:5:502:22 | ExprStmt | variables.rs:502:5:502:17 | print_i64_ref |  |
 | variables.rs:502:19:502:20 | RefExpr | variables.rs:502:5:502:21 | CallExpr |  |
 | variables.rs:502:20:502:20 | z | variables.rs:502:19:502:20 | RefExpr |  |
-| variables.rs:510:3:512:3 | enter bar | variables.rs:511:5:511:32 | ExprStmt |  |
+| variables.rs:510:3:512:3 | enter bar | variables.rs:510:15:510:18 | self |  |
 | variables.rs:510:3:512:3 | exit bar (normal) | variables.rs:510:3:512:3 | exit bar |  |
+| variables.rs:510:10:510:18 | SelfParam | variables.rs:511:5:511:32 | ExprStmt |  |
+| variables.rs:510:15:510:18 | self | variables.rs:510:10:510:18 | SelfParam |  |
 | variables.rs:510:21:512:3 | BlockExpr | variables.rs:510:3:512:3 | exit bar (normal) |  |
 | variables.rs:511:5:511:9 | * ... | variables.rs:511:29:511:29 | 3 |  |
 | variables.rs:511:5:511:31 | ... = ... | variables.rs:510:21:512:3 | BlockExpr |  |