Rust: Include more calls in DB quality metrics

Author: hvitved

rust/ql/consistency-queries/PathResolutionConsistency.ql

@@ -15,8 +15,8 @@ class SourceLocatable extends Locatable {
   SourceLocatable() { this.fromSource() }
 }
 
-query predicate multipleCallTargets(SourceLocatable a) {
-  PathResolutionConsistency::multipleCallTargets(a, _)
+query predicate multipleResolvedTargets(SourceLocatable a) {
+  PathResolutionConsistency::multipleResolvedTargets(a, _)
 }
 
 query predicate multiplePathResolutions(SourceLocatable a) {

rust/ql/lib/codeql/rust/internal/PathResolutionConsistency.qll

@@ -24,17 +24,10 @@ query predicate multiplePathResolutions(Path p, ItemNode i) {
   strictcount(ItemNode i0 | i0 = resolvePath(p) and not i0 instanceof Crate) > 1
 }
 
-// TODO: Take other calls into account
-abstract private class CallExprBase extends ArgsExpr { }
-
-private class CallExprCallExprBase extends CallExpr, CallExprBase { }
-
-private class MethodCallExprCallExprBase extends MethodCallExpr, CallExprBase { }
-
-/** Holds if `call` has multiple static call targets including `target`. */
-query predicate multipleCallTargets(CallExprBase call, Callable target) {
-  target = call.getResolvedTarget() and
-  strictcount(call.getResolvedTarget()) > 1
+/** Holds if `ae` has multiple resolved targets including `target`. */
+query predicate multipleResolvedTargets(ArgsExpr ae, Addressable target) {
+  target = ae.getResolvedTarget() and
+  strictcount(ae.getResolvedTarget()) > 1
 }
 
 /** Holds if `fe` resolves to multiple record fields including `field`. */
@@ -62,8 +55,8 @@ int getPathResolutionInconsistencyCounts(string type) {
   type = "Multiple path resolutions" and
   result = count(Path p | multiplePathResolutions(p, _) | p)
   or
-  type = "Multiple static call targets" and
-  result = count(CallExprBase call | multipleCallTargets(call, _) | call)
+  type = "Multiple resolved targets" and
+  result = count(ArgsExpr ae | multipleResolvedTargets(ae, _) | ae)
   or
   type = "Multiple record fields" and
   result = count(FieldExpr fe | multipleStructFields(fe, _) | fe)

rust/ql/src/queries/telemetry/DatabaseQuality.qll

@@ -19,25 +19,25 @@ private class RelevantFile extends File {
 }
 
 module CallTargetStats implements StatsSig {
-  // TODO: Take other calls into account
-  abstract private class CallExprBase extends ArgsExpr { }
-
-  private class CallExprCallExprBase extends CallExpr, CallExprBase { }
-
-  private class MethodCallExprCallExprBase extends MethodCallExpr, CallExprBase { }
-
-  int getNumberOfOk() {
-    result =
-      count(CallExprBase c | c.getFile() instanceof RelevantFile and exists(c.getResolvedTarget()))
+  /**
+   * A call-like expression that is relevant for call target statistics.
+   *
+   * Note that this also includes tuple struct instantiations and tuple
+   * enum variant instantiations.
+   */
+  private class RelevantArgsExpr extends ArgsExpr {
+    RelevantArgsExpr() {
+      this.getFile() instanceof RelevantFile and
+      not this instanceof ClosureCallExpr and
+      not this = any(Operation o | not o.isOverloaded(_, _, _))
+    }
   }
 
-  additional predicate isNotOkCall(CallExprBase c) {
-    c.getFile() instanceof RelevantFile and
-    not exists(c.getResolvedTarget()) and
-    not c instanceof ClosureCallExpr
-  }
+  int getNumberOfOk() { result = count(RelevantArgsExpr e | exists(e.getResolvedTarget())) }
+
+  additional predicate isNotOkCall(RelevantArgsExpr e) { not exists(e.getResolvedTarget()) }
 
-  int getNumberOfNotOk() { result = count(CallExprBase c | isNotOkCall(c)) }
+  int getNumberOfNotOk() { result = count(RelevantArgsExpr e | isNotOkCall(e)) }
 
   string getOkText() { result = "calls with call target" }
 

rust/ql/test/extractor-tests/macro-expansion/CONSISTENCY/PathResolutionConsistency.expected

@@ -1,2 +1,2 @@
-multipleCallTargets
+multipleResolvedTargets
 | proc_macro.rs:44:27:44:30 | ...::to_tokens(...) |

rust/ql/test/library-tests/controlflow/CONSISTENCY/PathResolutionConsistency.expected

@@ -0,0 +1,4 @@
+multipleResolvedTargets
+| test.rs:419:34:419:35 | * ... |
+| test.rs:420:26:420:27 | * ... |
+| test.rs:597:9:597:10 | * ... |

rust/ql/test/library-tests/dataflow/global/CONSISTENCY/PathResolutionConsistency.expected

@@ -0,0 +1,3 @@
+multipleResolvedTargets
+| main.rs:236:11:236:15 | * ... |
+| main.rs:272:13:272:29 | * ... |

rust/ql/test/library-tests/dataflow/local/CONSISTENCY/PathResolutionConsistency.expected

@@ -0,0 +1,2 @@
+multipleResolvedTargets
+| main.rs:562:10:562:15 | * ... |

rust/ql/test/library-tests/dataflow/modeled/CONSISTENCY/PathResolutionConsistency.expected

@@ -0,0 +1,2 @@
+multipleResolvedTargets
+| main.rs:115:14:115:35 | * ... |

rust/ql/test/library-tests/dataflow/pointers/CONSISTENCY/PathResolutionConsistency.expected

@@ -0,0 +1,26 @@
+multipleResolvedTargets
+| main.rs:19:17:19:18 | * ... |
+| main.rs:53:14:53:15 | * ... |
+| main.rs:59:33:59:34 | * ... |
+| main.rs:72:14:72:15 | * ... |
+| main.rs:73:9:73:10 | * ... |
+| main.rs:74:14:74:15 | * ... |
+| main.rs:75:9:75:10 | * ... |
+| main.rs:76:14:76:15 | * ... |
+| main.rs:83:9:83:10 | * ... |
+| main.rs:90:9:90:17 | * ... |
+| main.rs:97:9:97:10 | * ... |
+| main.rs:105:9:105:10 | * ... |
+| main.rs:106:14:106:15 | * ... |
+| main.rs:113:14:113:15 | * ... |
+| main.rs:114:9:114:10 | * ... |
+| main.rs:115:14:115:15 | * ... |
+| main.rs:122:9:122:10 | * ... |
+| main.rs:125:9:125:10 | * ... |
+| main.rs:135:17:135:18 | * ... |
+| main.rs:136:17:136:18 | * ... |
+| main.rs:201:9:201:10 | * ... |
+| main.rs:209:14:209:15 | * ... |
+| main.rs:211:14:211:15 | * ... |
+| main.rs:224:13:224:17 | * ... |
+| main.rs:229:9:229:10 | * ... |

rust/ql/test/library-tests/dataflow/sources/net/CONSISTENCY/PathResolutionConsistency.expected

@@ -1,4 +1,4 @@
-multipleCallTargets
+multipleResolvedTargets
 | test.rs:59:62:59:77 | ...::from(...) |
 | test.rs:66:58:66:73 | ...::from(...) |
 | test.rs:389:30:389:67 | pinned.poll_read(...) |