DataFlow: Add the concept of selected locations

jbj · jbj · commit d2a0f57774c3 · 2024-10-25T13:33:33.000+02:00
This extension allows queries to be diff-informed even when the elements
they select are different from the sources and sinks found by data flow.

Most of the changes are boilerplate to use the new predicates in the
backwards-compatible data-flow wrappers for all languages.
diff --git a/cpp/ql/lib/semmle/code/cpp/dataflow/internal/DataFlowImpl.qll b/cpp/ql/lib/semmle/code/cpp/dataflow/internal/DataFlowImpl.qll
@@ -2,7 +2,7 @@
  * DEPRECATED: Use `semmle.code.cpp.dataflow.new.DataFlow` instead.
  */
 
-private import semmle.code.cpp.Location
+import semmle.code.cpp.Location
 private import DataFlowImplSpecific
 private import codeql.dataflow.internal.DataFlowImpl
 import MakeImpl<Location, CppOldDataFlow>
diff --git a/cpp/ql/lib/semmle/code/cpp/dataflow/internal/DataFlowImpl1.qll b/cpp/ql/lib/semmle/code/cpp/dataflow/internal/DataFlowImpl1.qll
@@ -285,6 +285,10 @@ deprecated private module Config implements FullStateConfigSig {
   predicate includeHiddenNodes() { any(Configuration config).includeHiddenNodes() }
 
   predicate observeDiffInformedIncrementalMode() { none() }
+
+  Location getASelectedSourceLocation(Node source) { none() }
+
+  Location getASelectedSinkLocation(Node sink) { none() }
 }
 
 deprecated private import Impl<Config> as I
diff --git a/cpp/ql/lib/semmle/code/cpp/dataflow/internal/DataFlowImpl2.qll b/cpp/ql/lib/semmle/code/cpp/dataflow/internal/DataFlowImpl2.qll
@@ -285,6 +285,10 @@ deprecated private module Config implements FullStateConfigSig {
   predicate includeHiddenNodes() { any(Configuration config).includeHiddenNodes() }
 
   predicate observeDiffInformedIncrementalMode() { none() }
+
+  Location getASelectedSourceLocation(Node source) { none() }
+
+  Location getASelectedSinkLocation(Node sink) { none() }
 }
 
 deprecated private import Impl<Config> as I
diff --git a/cpp/ql/lib/semmle/code/cpp/dataflow/internal/DataFlowImpl3.qll b/cpp/ql/lib/semmle/code/cpp/dataflow/internal/DataFlowImpl3.qll
@@ -285,6 +285,10 @@ deprecated private module Config implements FullStateConfigSig {
   predicate includeHiddenNodes() { any(Configuration config).includeHiddenNodes() }
 
   predicate observeDiffInformedIncrementalMode() { none() }
+
+  Location getASelectedSourceLocation(Node source) { none() }
+
+  Location getASelectedSinkLocation(Node sink) { none() }
 }
 
 deprecated private import Impl<Config> as I
diff --git a/cpp/ql/lib/semmle/code/cpp/dataflow/internal/DataFlowImpl4.qll b/cpp/ql/lib/semmle/code/cpp/dataflow/internal/DataFlowImpl4.qll
@@ -285,6 +285,10 @@ deprecated private module Config implements FullStateConfigSig {
   predicate includeHiddenNodes() { any(Configuration config).includeHiddenNodes() }
 
   predicate observeDiffInformedIncrementalMode() { none() }
+
+  Location getASelectedSourceLocation(Node source) { none() }
+
+  Location getASelectedSinkLocation(Node sink) { none() }
 }
 
 deprecated private import Impl<Config> as I
diff --git a/cpp/ql/lib/semmle/code/cpp/dataflow/internal/DataFlowImplLocal.qll b/cpp/ql/lib/semmle/code/cpp/dataflow/internal/DataFlowImplLocal.qll
@@ -285,6 +285,10 @@ deprecated private module Config implements FullStateConfigSig {
   predicate includeHiddenNodes() { any(Configuration config).includeHiddenNodes() }
 
   predicate observeDiffInformedIncrementalMode() { none() }
+
+  Location getASelectedSourceLocation(Node source) { none() }
+
+  Location getASelectedSinkLocation(Node sink) { none() }
 }
 
 deprecated private import Impl<Config> as I
diff --git a/cpp/ql/lib/semmle/code/cpp/ir/dataflow/internal/DataFlowImpl.qll b/cpp/ql/lib/semmle/code/cpp/ir/dataflow/internal/DataFlowImpl.qll
@@ -1,4 +1,4 @@
-private import semmle.code.cpp.Location
+import semmle.code.cpp.Location
 private import DataFlowImplSpecific
 private import codeql.dataflow.internal.DataFlowImpl
 import MakeImpl<Location, CppDataFlow>
diff --git a/cpp/ql/lib/semmle/code/cpp/ir/dataflow/internal/DataFlowImpl1.qll b/cpp/ql/lib/semmle/code/cpp/ir/dataflow/internal/DataFlowImpl1.qll
@@ -285,6 +285,10 @@ deprecated private module Config implements FullStateConfigSig {
   predicate includeHiddenNodes() { any(Configuration config).includeHiddenNodes() }
 
   predicate observeDiffInformedIncrementalMode() { none() }
+
+  Location getASelectedSourceLocation(Node source) { none() }
+
+  Location getASelectedSinkLocation(Node sink) { none() }
 }
 
 deprecated private import Impl<Config> as I
diff --git a/cpp/ql/lib/semmle/code/cpp/ir/dataflow/internal/DataFlowImpl2.qll b/cpp/ql/lib/semmle/code/cpp/ir/dataflow/internal/DataFlowImpl2.qll
@@ -285,6 +285,10 @@ deprecated private module Config implements FullStateConfigSig {
   predicate includeHiddenNodes() { any(Configuration config).includeHiddenNodes() }
 
   predicate observeDiffInformedIncrementalMode() { none() }
+
+  Location getASelectedSourceLocation(Node source) { none() }
+
+  Location getASelectedSinkLocation(Node sink) { none() }
 }
 
 deprecated private import Impl<Config> as I
diff --git a/cpp/ql/lib/semmle/code/cpp/ir/dataflow/internal/DataFlowImpl3.qll b/cpp/ql/lib/semmle/code/cpp/ir/dataflow/internal/DataFlowImpl3.qll
@@ -285,6 +285,10 @@ deprecated private module Config implements FullStateConfigSig {
   predicate includeHiddenNodes() { any(Configuration config).includeHiddenNodes() }
 
   predicate observeDiffInformedIncrementalMode() { none() }
+
+  Location getASelectedSourceLocation(Node source) { none() }
+
+  Location getASelectedSinkLocation(Node sink) { none() }
 }
 
 deprecated private import Impl<Config> as I
diff --git a/cpp/ql/lib/semmle/code/cpp/ir/dataflow/internal/DataFlowImpl4.qll b/cpp/ql/lib/semmle/code/cpp/ir/dataflow/internal/DataFlowImpl4.qll
@@ -285,6 +285,10 @@ deprecated private module Config implements FullStateConfigSig {
   predicate includeHiddenNodes() { any(Configuration config).includeHiddenNodes() }
 
   predicate observeDiffInformedIncrementalMode() { none() }
+
+  Location getASelectedSourceLocation(Node source) { none() }
+
+  Location getASelectedSinkLocation(Node sink) { none() }
 }
 
 deprecated private import Impl<Config> as I
diff --git a/csharp/ql/lib/semmle/code/csharp/dataflow/internal/DataFlowImpl.qll b/csharp/ql/lib/semmle/code/csharp/dataflow/internal/DataFlowImpl.qll
@@ -1,4 +1,4 @@
-private import semmle.code.csharp.Location
+import semmle.code.csharp.Location
 private import DataFlowImplSpecific
 private import codeql.dataflow.internal.DataFlowImpl
 import MakeImpl<Location, CsharpDataFlow>
diff --git a/csharp/ql/lib/semmle/code/csharp/dataflow/internal/DataFlowImpl1.qll b/csharp/ql/lib/semmle/code/csharp/dataflow/internal/DataFlowImpl1.qll
@@ -285,6 +285,10 @@ deprecated private module Config implements FullStateConfigSig {
   predicate includeHiddenNodes() { any(Configuration config).includeHiddenNodes() }
 
   predicate observeDiffInformedIncrementalMode() { none() }
+
+  Location getASelectedSourceLocation(Node source) { none() }
+
+  Location getASelectedSinkLocation(Node sink) { none() }
 }
 
 deprecated private import Impl<Config> as I
diff --git a/csharp/ql/lib/semmle/code/csharp/dataflow/internal/DataFlowImpl2.qll b/csharp/ql/lib/semmle/code/csharp/dataflow/internal/DataFlowImpl2.qll
@@ -285,6 +285,10 @@ deprecated private module Config implements FullStateConfigSig {
   predicate includeHiddenNodes() { any(Configuration config).includeHiddenNodes() }
 
   predicate observeDiffInformedIncrementalMode() { none() }
+
+  Location getASelectedSourceLocation(Node source) { none() }
+
+  Location getASelectedSinkLocation(Node sink) { none() }
 }
 
 deprecated private import Impl<Config> as I
diff --git a/csharp/ql/lib/semmle/code/csharp/dataflow/internal/DataFlowImpl3.qll b/csharp/ql/lib/semmle/code/csharp/dataflow/internal/DataFlowImpl3.qll
@@ -285,6 +285,10 @@ deprecated private module Config implements FullStateConfigSig {
   predicate includeHiddenNodes() { any(Configuration config).includeHiddenNodes() }
 
   predicate observeDiffInformedIncrementalMode() { none() }
+
+  Location getASelectedSourceLocation(Node source) { none() }
+
+  Location getASelectedSinkLocation(Node sink) { none() }
 }
 
 deprecated private import Impl<Config> as I
diff --git a/csharp/ql/lib/semmle/code/csharp/dataflow/internal/DataFlowImpl4.qll b/csharp/ql/lib/semmle/code/csharp/dataflow/internal/DataFlowImpl4.qll
@@ -285,6 +285,10 @@ deprecated private module Config implements FullStateConfigSig {
   predicate includeHiddenNodes() { any(Configuration config).includeHiddenNodes() }
 
   predicate observeDiffInformedIncrementalMode() { none() }
+
+  Location getASelectedSourceLocation(Node source) { none() }
+
+  Location getASelectedSinkLocation(Node sink) { none() }
 }
 
 deprecated private import Impl<Config> as I
diff --git a/csharp/ql/lib/semmle/code/csharp/dataflow/internal/DataFlowImpl5.qll b/csharp/ql/lib/semmle/code/csharp/dataflow/internal/DataFlowImpl5.qll
@@ -285,6 +285,10 @@ deprecated private module Config implements FullStateConfigSig {
   predicate includeHiddenNodes() { any(Configuration config).includeHiddenNodes() }
 
   predicate observeDiffInformedIncrementalMode() { none() }
+
+  Location getASelectedSourceLocation(Node source) { none() }
+
+  Location getASelectedSinkLocation(Node sink) { none() }
 }
 
 deprecated private import Impl<Config> as I
diff --git a/go/ql/lib/semmle/go/dataflow/internal/DataFlowImpl.qll b/go/ql/lib/semmle/go/dataflow/internal/DataFlowImpl.qll
@@ -1,4 +1,4 @@
 private import DataFlowImplSpecific
 private import codeql.dataflow.internal.DataFlowImpl
-private import semmle.go.Locations
+import semmle.go.Locations
 import MakeImpl<Location, GoDataFlow>
diff --git a/go/ql/lib/semmle/go/dataflow/internal/DataFlowImpl1.qll b/go/ql/lib/semmle/go/dataflow/internal/DataFlowImpl1.qll
@@ -285,6 +285,10 @@ deprecated private module Config implements FullStateConfigSig {
   predicate includeHiddenNodes() { any(Configuration config).includeHiddenNodes() }
 
   predicate observeDiffInformedIncrementalMode() { none() }
+
+  Location getASelectedSourceLocation(Node source) { none() }
+
+  Location getASelectedSinkLocation(Node sink) { none() }
 }
 
 deprecated private import Impl<Config> as I
diff --git a/go/ql/lib/semmle/go/dataflow/internal/DataFlowImpl2.qll b/go/ql/lib/semmle/go/dataflow/internal/DataFlowImpl2.qll
@@ -285,6 +285,10 @@ deprecated private module Config implements FullStateConfigSig {
   predicate includeHiddenNodes() { any(Configuration config).includeHiddenNodes() }
 
   predicate observeDiffInformedIncrementalMode() { none() }
+
+  Location getASelectedSourceLocation(Node source) { none() }
+
+  Location getASelectedSinkLocation(Node sink) { none() }
 }
 
 deprecated private import Impl<Config> as I
diff --git a/java/ql/lib/semmle/code/java/dataflow/internal/DataFlowImpl.qll b/java/ql/lib/semmle/code/java/dataflow/internal/DataFlowImpl.qll
@@ -1,4 +1,4 @@
 private import DataFlowImplSpecific
 private import codeql.dataflow.internal.DataFlowImpl
-private import semmle.code.Location
+import semmle.code.Location
 import MakeImpl<Location, JavaDataFlow>
diff --git a/java/ql/lib/semmle/code/java/dataflow/internal/DataFlowImpl1.qll b/java/ql/lib/semmle/code/java/dataflow/internal/DataFlowImpl1.qll
@@ -285,6 +285,10 @@ deprecated private module Config implements FullStateConfigSig {
   predicate includeHiddenNodes() { any(Configuration config).includeHiddenNodes() }
 
   predicate observeDiffInformedIncrementalMode() { none() }
+
+  Location getASelectedSourceLocation(Node source) { none() }
+
+  Location getASelectedSinkLocation(Node sink) { none() }
 }
 
 deprecated private import Impl<Config> as I
diff --git a/java/ql/lib/semmle/code/java/dataflow/internal/DataFlowImpl2.qll b/java/ql/lib/semmle/code/java/dataflow/internal/DataFlowImpl2.qll
@@ -285,6 +285,10 @@ deprecated private module Config implements FullStateConfigSig {
   predicate includeHiddenNodes() { any(Configuration config).includeHiddenNodes() }
 
   predicate observeDiffInformedIncrementalMode() { none() }
+
+  Location getASelectedSourceLocation(Node source) { none() }
+
+  Location getASelectedSinkLocation(Node sink) { none() }
 }
 
 deprecated private import Impl<Config> as I
diff --git a/java/ql/lib/semmle/code/java/dataflow/internal/DataFlowImpl3.qll b/java/ql/lib/semmle/code/java/dataflow/internal/DataFlowImpl3.qll
@@ -285,6 +285,10 @@ deprecated private module Config implements FullStateConfigSig {
   predicate includeHiddenNodes() { any(Configuration config).includeHiddenNodes() }
 
   predicate observeDiffInformedIncrementalMode() { none() }
+
+  Location getASelectedSourceLocation(Node source) { none() }
+
+  Location getASelectedSinkLocation(Node sink) { none() }
 }
 
 deprecated private import Impl<Config> as I
diff --git a/java/ql/lib/semmle/code/java/dataflow/internal/DataFlowImpl4.qll b/java/ql/lib/semmle/code/java/dataflow/internal/DataFlowImpl4.qll
@@ -285,6 +285,10 @@ deprecated private module Config implements FullStateConfigSig {
   predicate includeHiddenNodes() { any(Configuration config).includeHiddenNodes() }
 
   predicate observeDiffInformedIncrementalMode() { none() }
+
+  Location getASelectedSourceLocation(Node source) { none() }
+
+  Location getASelectedSinkLocation(Node sink) { none() }
 }
 
 deprecated private import Impl<Config> as I
diff --git a/java/ql/lib/semmle/code/java/dataflow/internal/DataFlowImpl5.qll b/java/ql/lib/semmle/code/java/dataflow/internal/DataFlowImpl5.qll
@@ -285,6 +285,10 @@ deprecated private module Config implements FullStateConfigSig {
   predicate includeHiddenNodes() { any(Configuration config).includeHiddenNodes() }
 
   predicate observeDiffInformedIncrementalMode() { none() }
+
+  Location getASelectedSourceLocation(Node source) { none() }
+
+  Location getASelectedSinkLocation(Node sink) { none() }
 }
 
 deprecated private import Impl<Config> as I
diff --git a/java/ql/lib/semmle/code/java/dataflow/internal/DataFlowImpl6.qll b/java/ql/lib/semmle/code/java/dataflow/internal/DataFlowImpl6.qll
@@ -285,6 +285,10 @@ deprecated private module Config implements FullStateConfigSig {
   predicate includeHiddenNodes() { any(Configuration config).includeHiddenNodes() }
 
   predicate observeDiffInformedIncrementalMode() { none() }
+
+  Location getASelectedSourceLocation(Node source) { none() }
+
+  Location getASelectedSinkLocation(Node sink) { none() }
 }
 
 deprecated private import Impl<Config> as I
diff --git a/python/ql/lib/semmle/python/dataflow/new/internal/DataFlowImpl.qll b/python/ql/lib/semmle/python/dataflow/new/internal/DataFlowImpl.qll
@@ -1,4 +1,4 @@
 private import DataFlowImplSpecific
 private import codeql.dataflow.internal.DataFlowImpl
-private import semmle.python.Files
+import semmle.python.Files
 import MakeImpl<Location, PythonDataFlow>
diff --git a/python/ql/lib/semmle/python/dataflow/new/internal/DataFlowImpl1.qll b/python/ql/lib/semmle/python/dataflow/new/internal/DataFlowImpl1.qll
@@ -285,6 +285,10 @@ deprecated private module Config implements FullStateConfigSig {
   predicate includeHiddenNodes() { any(Configuration config).includeHiddenNodes() }
 
   predicate observeDiffInformedIncrementalMode() { none() }
+
+  Location getASelectedSourceLocation(Node source) { none() }
+
+  Location getASelectedSinkLocation(Node sink) { none() }
 }
 
 deprecated private import Impl<Config> as I
diff --git a/python/ql/lib/semmle/python/dataflow/new/internal/DataFlowImpl2.qll b/python/ql/lib/semmle/python/dataflow/new/internal/DataFlowImpl2.qll
@@ -285,6 +285,10 @@ deprecated private module Config implements FullStateConfigSig {
   predicate includeHiddenNodes() { any(Configuration config).includeHiddenNodes() }
 
   predicate observeDiffInformedIncrementalMode() { none() }
+
+  Location getASelectedSourceLocation(Node source) { none() }
+
+  Location getASelectedSinkLocation(Node sink) { none() }
 }
 
 deprecated private import Impl<Config> as I
diff --git a/python/ql/lib/semmle/python/dataflow/new/internal/DataFlowImpl3.qll b/python/ql/lib/semmle/python/dataflow/new/internal/DataFlowImpl3.qll
@@ -285,6 +285,10 @@ deprecated private module Config implements FullStateConfigSig {
   predicate includeHiddenNodes() { any(Configuration config).includeHiddenNodes() }
 
   predicate observeDiffInformedIncrementalMode() { none() }
+
+  Location getASelectedSourceLocation(Node source) { none() }
+
+  Location getASelectedSinkLocation(Node sink) { none() }
 }
 
 deprecated private import Impl<Config> as I
diff --git a/python/ql/lib/semmle/python/dataflow/new/internal/DataFlowImpl4.qll b/python/ql/lib/semmle/python/dataflow/new/internal/DataFlowImpl4.qll
@@ -285,6 +285,10 @@ deprecated private module Config implements FullStateConfigSig {
   predicate includeHiddenNodes() { any(Configuration config).includeHiddenNodes() }
 
   predicate observeDiffInformedIncrementalMode() { none() }
+
+  Location getASelectedSourceLocation(Node source) { none() }
+
+  Location getASelectedSinkLocation(Node sink) { none() }
 }
 
 deprecated private import Impl<Config> as I
diff --git a/ruby/ql/lib/codeql/ruby/dataflow/internal/DataFlowImpl.qll b/ruby/ql/lib/codeql/ruby/dataflow/internal/DataFlowImpl.qll
@@ -1,4 +1,4 @@
-private import codeql.Locations
+import codeql.Locations
 private import DataFlowImplSpecific
 private import codeql.dataflow.internal.DataFlowImpl
 import MakeImpl<Location, RubyDataFlow>
diff --git a/ruby/ql/lib/codeql/ruby/dataflow/internal/DataFlowImpl1.qll b/ruby/ql/lib/codeql/ruby/dataflow/internal/DataFlowImpl1.qll
@@ -285,6 +285,10 @@ deprecated private module Config implements FullStateConfigSig {
   predicate includeHiddenNodes() { any(Configuration config).includeHiddenNodes() }
 
   predicate observeDiffInformedIncrementalMode() { none() }
+
+  Location getASelectedSourceLocation(Node source) { none() }
+
+  Location getASelectedSinkLocation(Node sink) { none() }
 }
 
 deprecated private import Impl<Config> as I
diff --git a/ruby/ql/lib/codeql/ruby/dataflow/internal/DataFlowImpl2.qll b/ruby/ql/lib/codeql/ruby/dataflow/internal/DataFlowImpl2.qll
@@ -285,6 +285,10 @@ deprecated private module Config implements FullStateConfigSig {
   predicate includeHiddenNodes() { any(Configuration config).includeHiddenNodes() }
 
   predicate observeDiffInformedIncrementalMode() { none() }
+
+  Location getASelectedSourceLocation(Node source) { none() }
+
+  Location getASelectedSinkLocation(Node sink) { none() }
 }
 
 deprecated private import Impl<Config> as I
diff --git a/shared/dataflow/codeql/dataflow/DataFlow.qll b/shared/dataflow/codeql/dataflow/DataFlow.qll
diff --git a/shared/dataflow/codeql/dataflow/internal/DataFlowImpl.qll b/shared/dataflow/codeql/dataflow/internal/DataFlowImpl.qll
diff --git a/swift/ql/lib/codeql/swift/dataflow/internal/DataFlowImpl.qll b/swift/ql/lib/codeql/swift/dataflow/internal/DataFlowImpl.qll
diff --git a/swift/ql/lib/codeql/swift/dataflow/internal/DataFlowImpl1.qll b/swift/ql/lib/codeql/swift/dataflow/internal/DataFlowImpl1.qll

Original file line number	Diff line number	Diff line change
`@@ -285,6 +285,10 @@ deprecated private module Config implements FullStateConfigSig {`
`285`	`285`	`predicate includeHiddenNodes() { any(Configuration config).includeHiddenNodes() }`
`286`	`286`
`287`	`287`	`predicate observeDiffInformedIncrementalMode() { none() }`
	`288`	`+`
	`289`	`+ Location getASelectedSourceLocation(Node source) { none() }`
	`290`	`+`
	`291`	`+ Location getASelectedSinkLocation(Node sink) { none() }`
`288`	`292`	`}`
`289`	`293`
`290`	`294`	`deprecated private import Impl<Config> as I`