Rust: Path resolution for static items

hvitved · hvitved · commit 0547e9c98d5a · 2026-06-02T09:02:56.000+02:00
diff --git a/rust/ql/lib/codeql/rust/elements/StaticAccess.qll b/rust/ql/lib/codeql/rust/elements/StaticAccess.qll
@@ -0,0 +1,7 @@
+/**
+ * This module provides the public class `StaticAccess`.
+ */
+
+private import internal.StaticImpl
+
+final class StaticAccess = Impl::StaticAccess;
diff --git a/rust/ql/lib/codeql/rust/elements/internal/ConstImpl.qll b/rust/ql/lib/codeql/rust/elements/internal/ConstImpl.qll
@@ -24,7 +24,9 @@ module Impl {
    * const X: i32 = 42;
    * ```
    */
-  class Const extends Generated::Const { }
+  class Const extends Generated::Const {
+    override string toStringImpl() { result = "const " + this.getName().getText() }
+  }
 
   /**
    * A constant access.
diff --git a/rust/ql/lib/codeql/rust/elements/internal/StaticImpl.qll b/rust/ql/lib/codeql/rust/elements/internal/StaticImpl.qll
diff --git a/rust/ql/lib/codeql/rust/internal/PathResolution.qll b/rust/ql/lib/codeql/rust/internal/PathResolution.qll
@@ -659,6 +659,38 @@ private class ConstItemNode extends AssocItemNode instanceof Const {
   override TypeParam getTypeParam(int i) { none() }
 }
 
+private class StaticItemNode extends ItemNode instanceof Static {
+  override string getName() { result = Static.super.getName().getText() }
+
+  override Namespace getNamespace() { result.isValue() }
+
+  override Visibility getVisibility() { result = Static.super.getVisibility() }
+
+  override Attr getAnAttr() { result = Static.super.getAnAttr() }
+
+  override TypeParam getTypeParam(int i) { none() }
+
+  override predicate hasCanonicalPath(Crate c) { this.hasCanonicalPathPrefix(c) }
+
+  bindingset[c]
+  private string getCanonicalPathPart(Crate c, int i) {
+    i = 0 and
+    result = this.getCanonicalPathPrefix(c)
+    or
+    i = 1 and
+    result = "::"
+    or
+    i = 2 and
+    result = this.getName()
+  }
+
+  language[monotonicAggregates]
+  override string getCanonicalPath(Crate c) {
+    this.hasCanonicalPath(c) and
+    result = strictconcat(int i | i in [0 .. 2] | this.getCanonicalPathPart(c, i) order by i)
+  }
+}
+
 private class TypeItemTypeItemNode extends NamedItemNode, TypeItemNode instanceof TypeItem {
   override string getName() { result = TypeItem.super.getName().getText() }
 
diff --git a/rust/ql/lib/rust.qll b/rust/ql/lib/rust.qll
@@ -11,6 +11,7 @@ import codeql.rust.elements.AssignmentOperation
 import codeql.rust.elements.BitwiseOperation
 import codeql.rust.elements.ComparisonOperation
 import codeql.rust.elements.ConstAccess
+import codeql.rust.elements.StaticAccess
 import codeql.rust.elements.DerefExpr
 import codeql.rust.elements.LiteralExprExt
 import codeql.rust.elements.LogicalOperation
diff --git a/rust/ql/test/TestUtils.qll b/rust/ql/test/TestUtils.qll
@@ -20,3 +20,12 @@ class CrateElement extends Element {
 class Builtin extends AstNode {
   Builtin() { this.getFile().getAbsolutePath().matches("%/builtins/%.rs") }
 }
+
+predicate commmentAt(string text, string filepath, int line) {
+  exists(Comment c |
+    c.getLocation().hasLocationInfo(filepath, line, _, _, _) and
+    c.getCommentText().trim() = text and
+    c.fromSource() and
+    not text.matches("$%")
+  )
+}
diff --git a/rust/ql/test/extractor-tests/generated/Const/Const.expected b/rust/ql/test/extractor-tests/generated/Const/Const.expected
@@ -1,13 +1,13 @@
 instances
-| gen_const.rs:4:5:7:22 | Const | isConst: | yes | isDefault: | no | hasImplementation: | yes |
+| gen_const.rs:4:5:7:22 | const X | isConst: | yes | isDefault: | no | hasImplementation: | yes |
 getAttributeMacroExpansion
 getAttr
 getBody
-| gen_const.rs:4:5:7:22 | Const | gen_const.rs:7:20:7:21 | 42 |
+| gen_const.rs:4:5:7:22 | const X | gen_const.rs:7:20:7:21 | 42 |
 getGenericParamList
 getName
-| gen_const.rs:4:5:7:22 | Const | gen_const.rs:7:11:7:11 | X |
+| gen_const.rs:4:5:7:22 | const X | gen_const.rs:7:11:7:11 | X |
 getTypeRepr
-| gen_const.rs:4:5:7:22 | Const | gen_const.rs:7:14:7:16 | i32 |
+| gen_const.rs:4:5:7:22 | const X | gen_const.rs:7:14:7:16 | i32 |
 getVisibility
 getWhereClause
diff --git a/rust/ql/test/extractor-tests/generated/ExternItemList/ExternItemList.expected b/rust/ql/test/extractor-tests/generated/ExternItemList/ExternItemList.expected
@@ -3,4 +3,4 @@ instances
 getAttr
 getExternItem
 | gen_extern_item_list.rs:7:16:10:5 | ExternItemList | 0 | gen_extern_item_list.rs:8:9:8:17 | fn foo |
-| gen_extern_item_list.rs:7:16:10:5 | ExternItemList | 1 | gen_extern_item_list.rs:9:9:9:24 | Static |
+| gen_extern_item_list.rs:7:16:10:5 | ExternItemList | 1 | gen_extern_item_list.rs:9:9:9:24 | static BAR |
diff --git a/rust/ql/test/extractor-tests/generated/Static/Static.expected b/rust/ql/test/extractor-tests/generated/Static/Static.expected
@@ -1,11 +1,11 @@
 instances
-| gen_static.rs:4:5:7:23 | Static | isMut: | no | isStatic: | yes | isUnsafe: | no |
+| gen_static.rs:4:5:7:23 | static X | isMut: | no | isStatic: | yes | isUnsafe: | no |
 getAttributeMacroExpansion
 getAttr
 getBody
-| gen_static.rs:4:5:7:23 | Static | gen_static.rs:7:21:7:22 | 42 |
+| gen_static.rs:4:5:7:23 | static X | gen_static.rs:7:21:7:22 | 42 |
 getName
-| gen_static.rs:4:5:7:23 | Static | gen_static.rs:7:12:7:12 | X |
+| gen_static.rs:4:5:7:23 | static X | gen_static.rs:7:12:7:12 | X |
 getTypeRepr
-| gen_static.rs:4:5:7:23 | Static | gen_static.rs:7:15:7:17 | i32 |
+| gen_static.rs:4:5:7:23 | static X | gen_static.rs:7:15:7:17 | i32 |
 getVisibility
diff --git a/rust/ql/test/extractor-tests/macro-expansion/PrintAst.expected b/rust/ql/test/extractor-tests/macro-expansion/PrintAst.expected
@@ -957,7 +957,7 @@ macro_expansion.rs:
 #   94|     getName(): [Name] MyTrait
 #   98|   getItem(20): [Union] union MyDeriveUnion
 #   99|     getDeriveMacroExpansion(0): [MacroItems] MacroItems
-#   99|       getItem(0): [Const] Const
+#   99|       getItem(0): [Const] const CONST_MyDeriveUnion
 #   98|         getBody(): [IntegerLiteralExpr] 42
 #   99|         getName(): [Name] CONST_MyDeriveUnion
 #   98|         getTypeRepr(): [PathTypeRepr] u32
diff --git a/rust/ql/test/extractor-tests/macro-expansion/test.expected b/rust/ql/test/extractor-tests/macro-expansion/test.expected
@@ -18,7 +18,7 @@ derive_macros
 | macro_expansion.rs:83:1:86:1 | struct MyDerive | 0 | 0 | macro_expansion.rs:84:8:85:9 | impl ...::Debug for MyDerive::<...> { ... } |
 | macro_expansion.rs:88:1:92:1 | enum MyDeriveEnum | 0 | 0 | macro_expansion.rs:89:6:91:12 | impl ...::PartialEq for MyDeriveEnum::<...> { ... } |
 | macro_expansion.rs:88:1:92:1 | enum MyDeriveEnum | 1 | 0 | macro_expansion.rs:89:6:89:17 | impl ...::Eq for MyDeriveEnum::<...> { ... } |
-| macro_expansion.rs:98:1:102:1 | union MyDeriveUnion | 0 | 0 | macro_expansion.rs:99:7:99:19 | Const |
+| macro_expansion.rs:98:1:102:1 | union MyDeriveUnion | 0 | 0 | macro_expansion.rs:99:7:99:19 | const CONST_MyDeriveUnion |
 | macro_expansion.rs:98:1:102:1 | union MyDeriveUnion | 0 | 1 | macro_expansion.rs:99:7:99:19 | impl MyTrait for MyDeriveUnion { ... } |
 macro_calls
 | macro_expansion.rs:5:9:5:35 | concat!... | macro_expansion.rs:5:17:5:34 | "Hello world!" |
diff --git a/rust/ql/test/library-tests/const_access/const_access.expected b/rust/ql/test/library-tests/const_access/const_access.expected
@@ -1,8 +1,11 @@
 testFailures
 constAccess
-| main.rs:17:13:17:24 | GLOBAL_CONST | main.rs:1:1:1:29 | Const |
-| main.rs:19:13:19:24 | STRING_CONST | main.rs:2:1:2:35 | Const |
-| main.rs:21:13:21:33 | ...::ASSOC_CONST | main.rs:9:5:9:33 | Const |
-| main.rs:23:13:23:35 | ...::MODULE_CONST | main.rs:13:5:13:38 | Const |
-| main.rs:25:8:25:19 | GLOBAL_CONST | main.rs:1:1:1:29 | Const |
-| main.rs:29:16:29:36 | ...::ASSOC_CONST | main.rs:9:5:9:33 | Const |
+| main.rs:17:13:17:24 | GLOBAL_CONST | main.rs:1:1:1:29 | const GLOBAL_CONST |
+| main.rs:19:13:19:24 | STRING_CONST | main.rs:2:1:2:35 | const STRING_CONST |
+| main.rs:21:13:21:33 | ...::ASSOC_CONST | main.rs:9:5:9:33 | const ASSOC_CONST |
+| main.rs:23:13:23:35 | ...::MODULE_CONST | main.rs:13:5:13:38 | const MODULE_CONST |
+| main.rs:26:16:26:27 | GLOBAL_CONST | main.rs:1:1:1:29 | const GLOBAL_CONST |
+| main.rs:30:16:30:36 | ...::ASSOC_CONST | main.rs:9:5:9:33 | const ASSOC_CONST |
+| main.rs:33:20:33:31 | GLOBAL_CONST | main.rs:1:1:1:29 | const GLOBAL_CONST |
+| main.rs:39:17:39:28 | STRING_CONST | main.rs:38:9:38:43 | const STRING_CONST |
+| main.rs:43:21:43:32 | STRING_CONST | main.rs:42:13:42:48 | const STRING_CONST |
diff --git a/rust/ql/test/library-tests/const_access/const_access.ql b/rust/ql/test/library-tests/const_access/const_access.ql
@@ -5,15 +5,25 @@ import TestUtils
 query predicate constAccess(ConstAccess ca, Const c) { toBeTested(ca) and c = ca.getConst() }
 
 module ConstAccessTest implements TestSig {
+  private predicate constAt(Const c, string filepath, int line) {
+    c.getLocation().hasLocationInfo(filepath, _, _, line, _)
+  }
+
   string getARelevantTag() { result = "const_access" }
 
   predicate hasActualResult(Location location, string element, string tag, string value) {
-    exists(ConstAccess ca |
+    exists(ConstAccess ca, Const c, string filepath, int line |
       toBeTested(ca) and
       location = ca.getLocation() and
       element = ca.toString() and
       tag = "const_access" and
-      value = ca.getConst().getName().getText()
+      c = ca.getConst() and
+      constAt(c, filepath, line)
+    |
+      commmentAt(value, filepath, line)
+      or
+      not commmentAt(_, filepath, line) and
+      value = c.getName().getText()
     )
   }
 }
diff --git a/rust/ql/test/library-tests/const_access/main.rs b/rust/ql/test/library-tests/const_access/main.rs
@@ -15,18 +15,34 @@ mod my_module {
 
 fn use_consts() {
     let x = GLOBAL_CONST; // $ const_access=GLOBAL_CONST
-    
+
     let s = STRING_CONST; // $ const_access=STRING_CONST
-    
+
     let y = MyStruct::ASSOC_CONST; // $ const_access=ASSOC_CONST
-    
+
     let z = my_module::MODULE_CONST; // $ const_access=MODULE_CONST
-    
-    if GLOBAL_CONST > 0 { // $ const_access=GLOBAL_CONST
+
+    #[rustfmt::skip]
+    let _ = if GLOBAL_CONST > 0 { // $ const_access=GLOBAL_CONST
         println!("positive");
-    }
-    
+    };
+
     let arr = [MyStruct::ASSOC_CONST; 5]; // $ const_access=ASSOC_CONST
+
+    #[rustfmt::skip]
+    let _ = if let GLOBAL_CONST = 0 { // $ const_access=GLOBAL_CONST
+        println!("zero");
+    };
+
+    {
+        const STRING_CONST: &str = "inner"; // Inner1
+        let _ = STRING_CONST; // $ const_access=Inner1
+
+        {
+            const STRING_CONST: &str = "inner2"; // Inner2
+            let _ = STRING_CONST; // $ const_access=Inner2
+        }
+    }
 }
 
 fn main() {
diff --git a/rust/ql/test/library-tests/controlflow/Cfg.expected b/rust/ql/test/library-tests/controlflow/Cfg.expected
@@ -1317,10 +1317,10 @@ edges
 | test.rs:533:21:533:48 | { ... } | test.rs:533:21:533:48 | { ... } |  |
 | test.rs:533:48:533:48 | 0 | test.rs:533:21:533:48 | ... > ... |  |
 | test.rs:536:9:536:10 | 42 | test.rs:529:41:537:5 | { ... } |  |
-| test.rs:539:5:548:5 | enter fn const_block_panic | test.rs:540:9:540:30 | Const |  |
+| test.rs:539:5:548:5 | enter fn const_block_panic | test.rs:540:9:540:30 | const N |  |
 | test.rs:539:5:548:5 | exit fn const_block_panic (normal) | test.rs:539:5:548:5 | exit fn const_block_panic |  |
 | test.rs:539:35:548:5 | { ... } | test.rs:539:5:548:5 | exit fn const_block_panic (normal) |  |
-| test.rs:540:9:540:30 | Const | test.rs:541:9:546:9 | ExprStmt |  |
+| test.rs:540:9:540:30 | const N | test.rs:541:9:546:9 | ExprStmt |  |
 | test.rs:541:9:546:9 | ExprStmt | test.rs:541:12:541:16 | false |  |
 | test.rs:541:9:546:9 | if false {...} | test.rs:547:9:547:9 | N |  |
 | test.rs:541:12:541:16 | false | test.rs:541:9:546:9 | if false {...} | false |
diff --git a/rust/ql/test/library-tests/path-resolution/main.rs b/rust/ql/test/library-tests/path-resolution/main.rs
@@ -1098,6 +1098,52 @@ mod self_types {
     }
 }
 
+#[rustfmt::skip]
+mod const_static {
+    use crate::const_static; // $ item=const_static
+
+    pub const CONST_ITEM: i32 = 42; // $ item=i32
+
+    pub static STATIC_ITEM: i32 = 42; // $ item=i32
+
+    fn use_const_static() {
+        let _ = CONST_ITEM; // $ item=CONST_ITEM
+        let _ = STATIC_ITEM; // $ item=STATIC_ITEM
+        let _ = const_static::CONST_ITEM; // $ item=CONST_ITEM
+        let _ = const_static::STATIC_ITEM; // $ item=STATIC_ITEM
+        let _ = CONST_ALIAS; // $ item=C1
+        let _ = STATIC_ALIAS; // $ item=S1
+
+        const CONST_ALIAS: i32 = CONST_ITEM // $ item=CONST_ITEM item=i32
+            ; // C1
+        static STATIC_ALIAS: i32 = STATIC_ITEM // $ item=STATIC_ITEM item=i32
+            ; // S1
+
+        let _ = CONST_ALIAS; // $ item=C1
+        let _ = STATIC_ALIAS; // $ item=S1
+
+        {
+            const CONST_ALIAS: i32 = CONST_ITEM // $ item=CONST_ITEM item=i32
+                ; // C2
+            static STATIC_ALIAS: i32 = STATIC_ITEM // $ item=STATIC_ITEM item=i32
+                ; // S2
+
+            let _ = CONST_ALIAS; // $ item=C2
+            let _ = STATIC_ALIAS; // $ item=S2
+        }
+
+        {
+            const CONST_ALIAS: i32 = CONST_ITEM // $ item=CONST_ITEM item=i32
+                ; // C3
+            static STATIC_ALIAS: i32 = STATIC_ITEM // $ item=STATIC_ITEM item=i32
+                ; // S3
+
+            let _ = CONST_ALIAS; // $ item=C3
+            let _ = STATIC_ALIAS; // $ item=S3
+        }
+    }
+}
+
 fn main() {
     my::nested::nested1::nested2::f(); // $ item=I4
     my::f(); // $ item=I38
diff --git a/rust/ql/test/library-tests/path-resolution/path-resolution.expected b/rust/ql/test/library-tests/path-resolution/path-resolution.expected
diff --git a/rust/ql/test/library-tests/static_access/Cargo.lock b/rust/ql/test/library-tests/static_access/Cargo.lock
diff --git a/rust/ql/test/library-tests/static_access/main.rs b/rust/ql/test/library-tests/static_access/main.rs
diff --git a/rust/ql/test/library-tests/static_access/static_access.expected b/rust/ql/test/library-tests/static_access/static_access.expected
diff --git a/rust/ql/test/library-tests/static_access/static_access.ql b/rust/ql/test/library-tests/static_access/static_access.ql
diff --git a/rust/ql/test/library-tests/variables/variables.ql b/rust/ql/test/library-tests/variables/variables.ql
