wip3

Author: hvitved

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

@@ -1029,6 +1029,10 @@ private class FunctionType extends TFunctionType {
     this = MkInheritedFunctionType(f, pos, parent, i)
   }
 
+  /**
+   * Holds if this function type applies to the function `f` at position `pos`,
+   * when viewed as a member of the `impl` or trait item `i`.
+   */
   predicate appliesTo(Function f, FunctionTypePosition pos, ImplOrTraitItemNode i) {
     this.asFunctionType(f, pos, i)
     or
@@ -1110,33 +1114,38 @@ private Function getMethodSuccessor(ItemNode item, string name, int arity) {
 /** Provides logic for resolving method calls. */
 private module MethodCallResolution {
   /**
-   * Holds if a method for `type` with the name `name` and the arity `arity`
-   * exists in `i`.
+   * Holds if method `f` with the name `name` and the arity `arity` exists in
+   * `i`, and the type of the `self` parameter is `selfType`.
+   *
+   * `rootType` is the root type of `selfType`, and `selfRootPath` points to
+   * `selfRootType` inside `selfType`, where `selfRootType` is either the type
+   * being implemented, when `i` is an `impl`, or the trait itself when `i` is
+   * a trait.
    */
   pragma[nomagic]
-  predicate methodCandidate(
-    Function f, Type type, string name, int arity, ImplOrTraitItemNode i, FunctionType self,
-    TypePath selfPath, Type selfType
+  predicate methodInfo(
+    Function f, string name, int arity, ImplOrTraitItemNode i, FunctionType selfType, Type rootType,
+    TypePath selfRootPath, Type selfRootType
   ) {
     exists(FunctionTypePosition pos |
       f = i.getASuccessor(name) and
       arity = f.getParamList().getNumberOfParams() and
-      type = self.getTypeAt(TypePath::nil()) and
-      self.appliesTo(f, pos, i) and
+      rootType = selfType.getTypeAt(TypePath::nil()) and
+      selfType.appliesTo(f, pos, i) and
       pos.isSelf() and
-      self.getTypeAt(selfPath) = selfType and
+      selfType.getTypeAt(selfRootPath) = selfRootType and
       not i.(ImplItemNode).isBlanket()
     |
-      selfType = i.(Impl).getSelfTy().(TypeMention).resolveType()
+      selfRootType = i.(Impl).getSelfTy().(TypeMention).resolveType()
       or
-      selfType = TTrait(i)
+      selfRootType = TTrait(i)
     )
   }
 
   pragma[nomagic]
-  private predicate methodCandidateImplTrait(string name, int arity, Trait trait) {
+  private predicate traitMethodInfo(string name, int arity, Trait trait) {
     exists(ImplItemNode i |
-      methodCandidate(_, _, name, arity, i, _, _, _) and
+      methodInfo(_, name, arity, i, _, _, _, _) and
       trait = i.resolveTraitTy()
     )
   }
@@ -1145,7 +1154,7 @@ private module MethodCallResolution {
   private predicate methodCallTraitCandidate(Element mc, Trait trait) {
     exists(string name, int arity |
       mc.(MethodCall).isMethodCall(name, arity) and
-      methodCandidateImplTrait(name, arity, trait)
+      traitMethodInfo(name, arity, trait)
     )
   }
 
@@ -1159,14 +1168,27 @@ private module MethodCallResolution {
     methodCallVisibleTraitCandidate(mc, impl.resolveTraitTy())
   }
 
+  /**
+   * Holds if method call `mc` may target a method in `i` with `self` parameter having
+   * type `selfType`.
+   *
+   * `rootType` is the root type of `selfType`, and `selfRootPath` points to
+   * `selfRootType` inside `selfType`, where `selfRootType` is either the type
+   * being implemented, when `i` is an `impl`, or the trait itself when `i` is
+   * a trait.
+   *
+   * This predicate only checks for matching method names and arities, and whether
+   * the trait being implemented by `i` (when `i` is not a trait itself) is visible
+   * at `mc`.
+   */
   pragma[inline]
   private predicate methodCallCandidate(
-    MethodCall mc, Type type, ImplOrTraitItemNode i, FunctionType self, TypePath selfPath,
-    Type selfType
+    MethodCall mc, ImplOrTraitItemNode i, FunctionType self, Type rootType, TypePath selfRootPath,
+    Type selfRootType
   ) {
     exists(string name, int arity |
       mc.isMethodCall(name, arity) and
-      methodCandidate(_, type, name, arity, i, self, selfPath, selfType)
+      methodInfo(_, name, arity, i, self, rootType, selfRootPath, selfRootType)
     |
       not i.(Impl).hasTrait()
       or
@@ -1236,12 +1258,12 @@ private module MethodCallResolution {
           derefChainBorrow), i, _)
       or
       // not MethodCallIsInstantiationOfInput::potentialInstantiationOf(mcc, abs, constraint)
-      exists(Type rootType, TypePath selfPath, Type selfType |
+      exists(Type rootType, TypePath selfRootPath, Type selfRootType |
         rootType = this.getACandidateReceiverTypeAtSubstituteTraitBounds(derefChainBorrow) and
         // mcc.isMethodCall(mc, selfPath, selfType, name, arity) and
-        methodCallCandidate(this, rootType, i, _, selfPath, selfType) and
-        selfType !=
-          this.getACandidateReceiverTypeAtSubstituteTraitBounds(selfPath, derefChainBorrow)
+        methodCallCandidate(this, i, _, rootType, selfRootPath, selfRootType) and
+        selfRootType !=
+          this.getACandidateReceiverTypeAtSubstituteTraitBounds(selfRootPath, derefChainBorrow)
       )
     }
 
@@ -1252,7 +1274,7 @@ private module MethodCallResolution {
         not derefChain.matches("%.ref") and // no need to try a borrow if the last thing we did was a deref
         rootType = this.getACandidateReceiverTypeAtSubstituteTraitBounds(derefChainBorrow)
       |
-        forall(ImplOrTraitItemNode i | methodCallCandidate(this, rootType, i, _, _, _) |
+        forall(ImplOrTraitItemNode i | methodCallCandidate(this, i, _, rootType, _, _) |
           this.isNotCandidate(i, derefChainBorrow)
         )
       )
@@ -1266,7 +1288,7 @@ private module MethodCallResolution {
 
     pragma[nomagic]
     private predicate hasRefCandidate(ImplOrTraitItemNode i) {
-      methodCallCandidate(this, TRefType(), i, _, _, _)
+      methodCallCandidate(this, i, _, TRefType(), _, _)
     }
 
     pragma[nomagic]
@@ -1413,7 +1435,7 @@ private module MethodCallResolution {
 
     // pragma[nomagic]
     // private predicate blah(
-    //   Type type, Impl i, FunctionType self, TypePath selfPath, Type selfType
+    //   Type type, Impl i, FunctionType self, TypePath selfRootPath, Type selfRootType
     // ) {
     //   not i.hasTrait() and
     //   mc_.blah(type, i, self, selfPath, selfType, derefChainBorrow)
@@ -1426,15 +1448,15 @@ private module MethodCallResolution {
     private predicate hasNoInherentTarget() {
       exists(Type rootType, string name, int arity |
         this.isMethodCall(_, TypePath::nil(), rootType, name, arity) and
-        forall(Impl i, FunctionType self, TypePath selfPath, Type selfType |
-          methodCandidate(_, rootType, name, arity, i, self, selfPath, selfType) and
+        forall(Impl i, FunctionType self, TypePath selfRootPath, Type selfRootType |
+          methodInfo(_, name, arity, i, self, rootType, selfRootPath, selfRootType) and
           not i.hasTrait()
         |
           // this.blah(type, i, self, selfPath, selfType)
           // or
           this.isNotInherentTarget(i)
           // forall(Impl impl |
-          //   methodCandidate(type, name, arity, impl, _, _, _) and
+          //   methodInfo(type, name, arity, impl, _, _, _) and
           //   not impl.hasTrait()
           // |
           //   this.isNotInherentTarget(impl)
@@ -1503,15 +1525,15 @@ private module MethodCallResolution {
     predicate potentialInstantiationOf(
       MethodCallCand mcc, TypeAbstraction abs, FunctionType constraint
     ) {
-      exists(MethodCall mc, string name, int arity, TypePath selfPath, Type selfType |
-        mcc.isMethodCall(mc, selfPath, selfType, name, arity) and
-        methodCallCandidate(mc, _, abs, constraint, selfPath, selfType)
+      exists(MethodCall mc, string name, int arity, TypePath selfRootPath, Type selfRootType |
+        mcc.isMethodCall(mc, selfRootPath, selfRootType, name, arity) and
+        methodCallCandidate(mc, abs, constraint, _, selfRootPath, selfRootType)
         // mc = Debug::getRelevantLocatable()
       )
     }
 
     predicate relevantTypeMention(FunctionType constraint) {
-      methodCandidate(_, _, _, _, _, constraint, _, _)
+      methodInfo(_, _, _, _, constraint, _, _, _)
     }
   }
 
@@ -1525,13 +1547,13 @@ private module MethodCallResolution {
       abs = any(Impl i | not i.hasTrait()) and
       exists(MethodCall mc, string name, int arity, Type rootType |
         mcc.isMethodCall(mc, TypePath::nil(), rootType, name, arity) and
-        methodCallCandidate(mc, rootType, abs, constraint, _, _)
+        methodCallCandidate(mc, abs, constraint, rootType, _, _)
         // mc = Debug::getRelevantLocatable()
       )
     }
 
     predicate relevantTypeMention(FunctionType constraint) {
-      methodCandidate(_, _, _, _, _, constraint, _, _)
+      methodInfo(_, _, _, _, constraint, _, _, _)
     }
   }
 }
@@ -1779,11 +1801,11 @@ private module FunctionCallResolution {
     Function getATraitCandidateMethod0(
       TraitItemNode trait, ImplOrTraitItemNode i, FunctionType self, Function resolved
     ) {
-      exists(TypePath selfPath, Type selfType |
+      exists(TypePath selfRootPath, Type selfRootType |
         result = this.getPathResolutionResolvedFunctionOrImplementation(resolved) and
         trait = this.(Call).getTrait() and
-        MethodCallResolution::methodCandidate(result, _, _, _, i, self, selfPath, selfType) and
-        this.getTypeAt(selfPath) = selfType
+        MethodCallResolution::methodInfo(result, _, _, i, self, _, selfRootPath, selfRootType) and
+        this.getTypeAt(selfRootPath) = selfRootType
       )
     }
 
@@ -1867,7 +1889,7 @@ private module FunctionCallResolution {
     }
 
     predicate relevantTypeMention(FunctionType constraint) {
-      MethodCallResolution::methodCandidate(_, _, _, _, _, constraint, _, _)
+      MethodCallResolution::methodInfo(_, _, _, _, constraint, _, _, _)
     }
   }
 }
@@ -2135,11 +2157,12 @@ private module OperationResolution {
     IsInstantiationOfInputSig<Op, FunctionType>
   {
     pragma[nomagic]
-    private predicate methodCandidate(
+    private predicate methodInfo(
       TypeAbstraction abs, FunctionType constraint, Trait trait, string name, int arity,
-      TypePath selfPath, Type selfType
+      TypePath selfRootPath, Type selfRootType
     ) {
-      MethodCallResolution::methodCandidate(_, _, name, arity, abs, constraint, selfPath, selfType) and //and
+      MethodCallResolution::methodInfo(_, name, arity, abs, constraint, _, selfRootPath,
+        selfRootType) and //and
       (
         trait = abs.(ImplItemNode).resolveTraitTy()
         or
@@ -2149,14 +2172,14 @@ private module OperationResolution {
 
     pragma[nomagic]
     predicate potentialInstantiationOf(Op op, TypeAbstraction abs, FunctionType constraint) {
-      exists(Trait trait, string name, int arity, TypePath selfPath, Type selfType |
-        op.isOperation(selfPath, selfType, trait, name, arity) and
-        methodCandidate(abs, constraint, trait, name, arity, selfPath, selfType)
+      exists(Trait trait, string name, int arity, TypePath selfRootPath, Type selfRootType |
+        op.isOperation(selfRootPath, selfRootType, trait, name, arity) and
+        methodInfo(abs, constraint, trait, name, arity, selfRootPath, selfRootType)
       )
     }
 
     predicate relevantTypeMention(FunctionType constraint) {
-      MethodCallResolution::methodCandidate(_, _, _, _, _, constraint, _, _)
+      MethodCallResolution::methodInfo(_, _, _, _, constraint, _, _, _)
     }
   }
 }

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

@@ -5,4 +5,3 @@ multipleCallTargets
 | proc_macro.rs:41:5:41:10 | ...::new(...) |
 | proc_macro.rs:41:5:41:10 | ...::new(...) |
 | proc_macro.rs:41:5:41:10 | ...::new(...) |
-| proc_macro.rs:44:27:44:30 | ...::to_tokens(...) |

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

@@ -31,6 +31,7 @@ multipleCallTargets
 | test.rs:825:30:825:43 | ...::_print(...) |
 | test.rs:840:14:840:43 | ...::_print(...) |
 | test.rs:854:14:854:34 | ...::_print(...) |
+| test.rs:865:23:865:80 | ...::try_from(...) |
 | test.rs:894:50:894:66 | ...::from(...) |
 | test.rs:894:50:894:66 | ...::from(...) |
 | test.rs:896:14:896:31 | ...::_print(...) |
@@ -75,6 +76,7 @@ multipleCallTargets
 | test.rs:977:14:977:29 | ...::_print(...) |
 | test.rs:979:27:979:36 | ...::_print(...) |
 | test.rs:980:28:980:41 | ...::_print(...) |
+| test_futures_io.rs:25:23:25:80 | ...::try_from(...) |
 | test_futures_io.rs:35:26:35:63 | pinned.poll_read(...) |
 | test_futures_io.rs:62:22:62:50 | pinned.poll_fill_buf(...) |
 | test_futures_io.rs:69:23:69:67 | ... .poll_fill_buf(...) |

rust/ql/test/library-tests/dataflow/sources/InlineFlow.expected

@@ -1,5 +1,3 @@
 | test.rs:641:14:641:20 | &buffer | Fixed missing result: hasTaintFlow="another_file.txt" |
 | test.rs:641:14:641:20 | &buffer | Fixed missing result: hasTaintFlow="file.txt" |
 | test.rs:649:14:649:20 | &buffer | Fixed missing result: hasTaintFlow="file.txt" |
-| test_futures_io.rs:46:14:46:36 | &... | Fixed missing result: hasTaintFlow=url |
-| test_futures_io.rs:104:14:104:36 | &... | Fixed missing result: hasTaintFlow=url |

rust/ql/test/library-tests/type-inference/CONSISTENCY/PathResolutionConsistency.expected

@@ -6,6 +6,9 @@ multipleCallTargets
 | dereference.rs:186:17:186:25 | S.bar(...) |
 | dereference.rs:187:17:187:29 | S.bar(...) |
 | main.rs:1803:13:1803:63 | ... .partial_cmp(...) |
+| main.rs:2318:9:2318:34 | ...::my_from2(...) |
+| main.rs:2319:9:2319:33 | ...::my_from2(...) |
+| main.rs:2320:9:2320:38 | ...::my_from2(...) |
 | main.rs:2372:13:2372:31 | ...::from(...) |
 | main.rs:2373:13:2373:31 | ...::from(...) |
 | main.rs:2374:13:2374:31 | ...::from(...) |

rust/ql/test/utils-tests/modelgenerator/CONSISTENCY/PathResolutionConsistency.expected

@@ -1,4 +1,2 @@
 unexpectedModel
-| Unexpected summary found: <test::option::MyOption>::cloned;Argument[self].Field[test::option::MyOption::MySome(0)].Reference;ReturnValue.Field[test::option::MyOption::MySome(0)];value;dfc-generated |
-| Unexpected summary found: <test::option::MyOption>::cloned;Argument[self].Field[test::option::MyOption::MySome(0)];ReturnValue.Field[test::option::MyOption::MySome(0)];value;dfc-generated |
 expectedModel