Shared: Refactor DataFlowStack so that we don't depend on our own modifications to the shared dataflow library files.

Author: MathiasVP

shared/dataflowstack/codeql/dataflowstack/DataFlowStack.qll

@@ -1,13 +1,38 @@
 private import codeql.dataflow.DataFlow as DF
 private import codeql.util.Location
 
+signature module DataFlowStackSig<
+  LocationSig Location, DF::InputSig<Location> Lang, DF::Configs<Location, Lang>::ConfigSig Config>
+{
+  Lang::Node getNode(DF::DataFlowMake<Location, Lang>::Global<Config>::PathNode n);
+
+  predicate isSource(DF::DataFlowMake<Location, Lang>::Global<Config>::PathNode n);
+
+  DF::DataFlowMake<Location, Lang>::Global<Config>::PathNode getASuccessor(
+    DF::DataFlowMake<Location, Lang>::Global<Config>::PathNode n
+  );
+
+  Lang::DataFlowCallable getARuntimeTarget(Lang::DataFlowCall call);
+
+  Lang::Node getAnArgumentNode(Lang::DataFlowCall call);
+}
+
 module DataFlowStackMake<LocationSig Location, DF::InputSig<Location> Lang> {
-  import DF::DataFlowMake<Location, Lang> as DataFlow
+  module DataFlow = DF::DataFlowMake<Location, Lang>;
+
+  module BiStackAnalysis<
+    DF::Configs<Location, Lang>::ConfigSig ConfigA,
+    DataFlowStackSig<Location, Lang, ConfigA> DataFlowStackA,
+    DF::Configs<Location, Lang>::ConfigSig ConfigB,
+    DataFlowStackSig<Location, Lang, ConfigB> DataFlowStackB>
+  {
+    module FlowA = DataFlow::Global<ConfigA>;
 
-  module BiStackAnalysis<DataFlow::GlobalFlowSig FlowA, DataFlow::GlobalFlowSig FlowB> {
-    module FlowStackA = FlowStack<FlowA>;
+    module FlowStackA = FlowStack<ConfigA, DataFlowStackA>;
 
-    module FlowStackB = FlowStack<FlowB>;
+    module FlowB = DataFlow::Global<ConfigB>;
+
+    module FlowStackB = FlowStack<ConfigB, DataFlowStackB>;
 
     /**
      * Holds if either the Stack associated with `sourceNodeA` is a subset of the stack associated with `sourceNodeB`
@@ -25,9 +50,11 @@ module DataFlowStackMake<LocationSig Location, DF::InputSig<Location> Lang> {
         flowStackA = FlowStackA::createFlowStack(sourceNodeA, sinkNodeA) and
         flowStackB = FlowStackB::createFlowStack(sourceNodeB, sinkNodeB) and
         (
-          BiStackAnalysisImpl<FlowA, FlowB>::flowStackIsSubsetOf(flowStackA, flowStackB)
+          BiStackAnalysisImpl<ConfigA, DataFlowStackA, ConfigB, DataFlowStackB>::flowStackIsSubsetOf(flowStackA,
+            flowStackB)
           or
-          BiStackAnalysisImpl<FlowB, FlowA>::flowStackIsSubsetOf(flowStackB, flowStackA)
+          BiStackAnalysisImpl<ConfigB, DataFlowStackB, ConfigA, DataFlowStackA>::flowStackIsSubsetOf(flowStackB,
+            flowStackA)
         )
       )
     }
@@ -51,10 +78,10 @@ module DataFlowStackMake<LocationSig Location, DF::InputSig<Location> Lang> {
         flowStackA = FlowStackA::createFlowStack(sourceNodeA, sinkNodeA) and
         flowStackB = FlowStackB::createFlowStack(sourceNodeB, sinkNodeB) and
         (
-          BiStackAnalysisImpl<FlowA, FlowB>::flowStackIsConvergingTerminatingSubsetOf(flowStackA,
+          BiStackAnalysisImpl<ConfigA, DataFlowStackA, ConfigB, DataFlowStackB>::flowStackIsConvergingTerminatingSubsetOf(flowStackA,
             flowStackB)
           or
-          BiStackAnalysisImpl<FlowB, FlowA>::flowStackIsConvergingTerminatingSubsetOf(flowStackB,
+          BiStackAnalysisImpl<ConfigB, DataFlowStackB, ConfigA, DataFlowStackA>::flowStackIsConvergingTerminatingSubsetOf(flowStackB,
             flowStackA)
         )
       )
@@ -67,7 +94,8 @@ module DataFlowStackMake<LocationSig Location, DF::InputSig<Location> Lang> {
      * The top of stackA is in stackB and the bottom of stackA is then some successor further down stackB.
      */
     predicate flowStackIsSubsetOf(FlowStackA::FlowStack flowStackA, FlowStackB::FlowStack flowStackB) {
-      BiStackAnalysisImpl<FlowA, FlowB>::flowStackIsSubsetOf(flowStackA, flowStackB)
+      BiStackAnalysisImpl<ConfigA, DataFlowStackA, ConfigB, DataFlowStackB>::flowStackIsSubsetOf(flowStackA,
+        flowStackB)
     }
 
     /**
@@ -78,15 +106,20 @@ module DataFlowStackMake<LocationSig Location, DF::InputSig<Location> Lang> {
     predicate flowStackIsConvergingTerminatingSubsetOf(
       FlowStackA::FlowStack flowStackA, FlowStackB::FlowStack flowStackB
     ) {
-      BiStackAnalysisImpl<FlowA, FlowB>::flowStackIsConvergingTerminatingSubsetOf(flowStackA,
+      BiStackAnalysisImpl<ConfigA, DataFlowStackA, ConfigB, DataFlowStackB>::flowStackIsConvergingTerminatingSubsetOf(flowStackA,
         flowStackB)
     }
   }
 
-  private module BiStackAnalysisImpl<DataFlow::GlobalFlowSig FlowA, DataFlow::GlobalFlowSig FlowB> {
-    module FlowStackA = FlowStack<FlowA>;
+  private module BiStackAnalysisImpl<
+    DF::Configs<Location, Lang>::ConfigSig ConfigA,
+    DataFlowStackSig<Location, Lang, ConfigA> DataFlowStackA,
+    DF::Configs<Location, Lang>::ConfigSig ConfigB,
+    DataFlowStackSig<Location, Lang, ConfigB> DataFlowStackB>
+  {
+    module FlowStackA = FlowStack<ConfigA, DataFlowStackA>;
 
-    module FlowStackB = FlowStack<FlowB>;
+    module FlowStackB = FlowStack<ConfigB, DataFlowStackB>;
 
     /**
      * Holds if stackA is a subset of stackB,
@@ -130,25 +163,30 @@ module DataFlowStackMake<LocationSig Location, DF::InputSig<Location> Lang> {
     }
   }
 
-  module FlowStack<DataFlow::GlobalFlowSig Flow> {
+  module FlowStack<
+    DF::Configs<Location, Lang>::ConfigSig Config,
+    DataFlowStackSig<Location, Lang, Config> DataFlowStack>
+  {
+    private module Flow = DF::DataFlowMake<Location, Lang>::Global<Config>;
+
     /**
      * Determines whether or not the given PathNode is a source
      * TODO: Refactor to Flow::PathNode signature
      */
-    predicate isSource(Flow::PathNode node) { node.isSource() }
+    predicate isSource(Flow::PathNode node) { DataFlowStack::isSource(node) }
 
     /**
      * Determines whether or not the given PathNode is a sink
      * TODO: Refactor to Flow::PathNode signature
      */
-    predicate isSink(Flow::PathNode node) { not exists(node.getASuccessor()) }
+    predicate isSink(Flow::PathNode node) { not exists(DataFlowStack::getASuccessor(node)) }
 
     /** A FlowStack encapsulates flows between a source and a sink, and all the pathways inbetween (possibly multiple) */
     private newtype FlowStackType =
       TFlowStack(Flow::PathNode source, Flow::PathNode sink) {
-        source.isSource() and
-        not exists(sink.getASuccessor()) and
-        source.getASuccessor*() = sink
+        DataFlowStack::isSource(source) and
+        not exists(DataFlowStack::getASuccessor(sink)) and
+        DataFlowStack::getASuccessor*(source) = sink
       }
 
     class FlowStack extends FlowStackType, TFlowStack {
@@ -197,8 +235,8 @@ module DataFlowStackMake<LocationSig Location, DF::InputSig<Location> Lang> {
       TFlowStackFrame(FlowStack flowStack, CallFrame frame) {
         exists(Flow::PathNode source, Flow::PathNode sink |
           flowStack = TFlowStack(source, sink) and
-          frame.getPathNode() = source.getASuccessor*() and
-          frame.getPathNode().getASuccessor*() = sink
+          frame.getPathNode() = DataFlowStack::getASuccessor*(source) and
+          DataFlowStack::getASuccessor(frame.getPathNode()) = sink
         )
       }
 
@@ -241,7 +279,8 @@ module DataFlowStackMake<LocationSig Location, DF::InputSig<Location> Lang> {
       FlowStackFrame getChildStackFrame() {
         exists(FlowStackFrame transitiveSuccessor |
           transitiveSuccessor = this.getASuccessor+() and
-          this.getCall().getARuntimeTarget() = transitiveSuccessor.getCall().getEnclosingCallable() and
+          DataFlowStack::getARuntimeTarget(this.getCall()) =
+            transitiveSuccessor.getCall().getEnclosingCallable() and
           result = transitiveSuccessor
         )
       }
@@ -272,7 +311,9 @@ module DataFlowStackMake<LocationSig Location, DF::InputSig<Location> Lang> {
      */
     private newtype TCallFrameType =
       TCallFrame(Flow::PathNode node) {
-        exists(Lang::DataFlowCall c | c.getAnArgumentNode() = node.getNode())
+        exists(Lang::DataFlowCall c |
+          DataFlowStack::getAnArgumentNode(c) = DataFlowStack::getNode(node)
+        )
       }
 
     /**
@@ -307,7 +348,7 @@ module DataFlowStackMake<LocationSig Location, DF::InputSig<Location> Lang> {
       Lang::DataFlowCall getCall() {
         exists(Lang::DataFlowCall call, Flow::PathNode node |
           this = TCallFrame(node) and
-          call.getAnArgumentNode() = node.getNode() and
+          DataFlowStack::getAnArgumentNode(call) = DataFlowStack::getNode(node) and
           result = call
         )
       }
@@ -329,8 +370,11 @@ module DataFlowStackMake<LocationSig Location, DF::InputSig<Location> Lang> {
      */
     private Flow::PathNode getSuccessorCall(Flow::PathNode n) {
       exists(Flow::PathNode succ |
-        succ = n.getASuccessor() and
-        if exists(Lang::DataFlowCall c | c.getAnArgumentNode() = succ.getNode())
+        succ = DataFlowStack::getASuccessor(n) and
+        if
+          exists(Lang::DataFlowCall c |
+            DataFlowStack::getAnArgumentNode(c) = DataFlowStack::getNode(succ)
+          )
         then result = succ
         else result = getSuccessorCall(succ)
       )