Shared: Model generator cleanup.

csharp/ql/src/change-notes/2025-04-16-model-generation.md

@@ -0,0 +1,4 @@
+---
+category: minorAnalysis
+---
+* Changes to the MaD model generation infrastructure: Changed the query `cs/utils/modelgenerator/summary-models` to use the implementation from `cs/utils/modelgenerator/mixed-summary-models`. Removed the now-redundant `cs/utils/modelgenerator/mixed-summary-models` query. Similar replacement was made for `cs/utils/modelgenerator/neutral-models`. That is, if `GenerateFlowModel.py` is provided with `--with-summaries` combined/mixed models are now generated instead of heuristic models (and similar for `--with-neutrals`).

csharp/ql/src/utils/modelgenerator/CaptureNeutralModels.ql

@@ -9,5 +9,5 @@
 import internal.CaptureModels
 
 from DataFlowSummaryTargetApi api, string noflow
-where noflow = captureNoFlow(api)
+where noflow = captureNeutral(api)
 select noflow order by noflow

csharp/ql/src/utils/modelgenerator/CaptureSinkModels.ql

@@ -9,5 +9,5 @@
 import internal.CaptureModels
 
 from DataFlowSinkTargetApi api, string sink
-where sink = captureSink(api)
+where sink = Heuristic::captureSink(api)
 select sink order by sink

csharp/ql/src/utils/modelgenerator/CaptureSourceModels.ql

@@ -9,5 +9,5 @@
 import internal.CaptureModels
 
 from DataFlowSourceTargetApi api, string source
-where source = captureSource(api)
+where source = Heuristic::captureSource(api)
 select source order by source

csharp/ql/src/utils/modelgenerator/CaptureSummaryModels.ql

@@ -9,5 +9,5 @@
 import internal.CaptureModels
 
 from DataFlowSummaryTargetApi api, string flow
-where flow = captureFlow(api)
+where flow = captureFlow(api, _)
 select flow order by flow

csharp/ql/src/utils/modelgenerator/debug/CaptureSummaryModelsPartialPath.ql

@@ -14,7 +14,7 @@ import PartialFlow::PartialPathGraph
 
 int explorationLimit() { result = 3 }
 
-module PartialFlow = PropagateFlow::FlowExplorationFwd<explorationLimit/0>;
+module PartialFlow = Heuristic::PropagateFlow::FlowExplorationFwd<explorationLimit/0>;
 
 from
   PartialFlow::PartialPathNode source, PartialFlow::PartialPathNode sink,

csharp/ql/src/utils/modelgenerator/debug/CaptureSummaryModelsPath.ql

@@ -10,6 +10,7 @@
 
 import csharp
 import utils.modelgenerator.internal.CaptureModels
+import Heuristic
 import PropagateFlow::PathGraph
 
 from

csharp/ql/test/utils/modelgenerator/dataflow/CaptureSummaryModels.ql → csharp/ql/test/utils/modelgenerator/dataflow/CaptureHeuristicSummaryModels.ql

@@ -3,9 +3,9 @@ import utils.modelgenerator.internal.CaptureModels
 import utils.test.InlineMadTest
 
 module InlineMadTestConfig implements InlineMadTestConfigSig {
-  string getCapturedModel(Callable c) { result = captureFlow(c) }
+  string getCapturedModel(Callable c) { result = Heuristic::captureFlow(c) }
 
-  string getKind() { result = "summary" }
+  string getKind() { result = "heuristic-summary" }
 }
 
 import InlineMadTest<InlineMadTestConfig>

csharp/ql/test/utils/modelgenerator/dataflow/CaptureNeutralModels.ql

@@ -3,7 +3,7 @@ import utils.modelgenerator.internal.CaptureModels
 import utils.test.InlineMadTest
 
 module InlineMadTestConfig implements InlineMadTestConfigSig {
-  string getCapturedModel(Callable c) { result = captureNoFlow(c) }
+  string getCapturedModel(Callable c) { result = captureNeutral(c) }
 
   string getKind() { result = "neutral" }
 }

csharp/ql/test/utils/modelgenerator/dataflow/CaptureSinkModels.ql

@@ -3,7 +3,7 @@ import utils.modelgenerator.internal.CaptureModels
 import utils.test.InlineMadTest
 
 module InlineMadTestConfig implements InlineMadTestConfigSig {
-  string getCapturedModel(Callable c) { result = captureSink(c) }
+  string getCapturedModel(Callable c) { result = Heuristic::captureSink(c) }
 
   string getKind() { result = "sink" }
 }

csharp/ql/test/utils/modelgenerator/dataflow/CaptureSourceModels.ql

@@ -3,7 +3,7 @@ import utils.modelgenerator.internal.CaptureModels
 import utils.test.InlineMadTest
 
 module InlineMadTestConfig implements InlineMadTestConfigSig {
-  string getCapturedModel(Callable c) { result = captureSource(c) }
+  string getCapturedModel(Callable c) { result = Heuristic::captureSource(c) }
 
   string getKind() { result = "source" }
 }

java/ql/src/change-notes/2025-04-16-model-generation.md

@@ -0,0 +1,4 @@
+---
+category: minorAnalysis
+---
+* Changes to the MaD model generation infrastructure: Changed the query `java/utils/modelgenerator/summary-models` to use the implementation from `java/utils/modelgenerator/mixed-summary-models`. Removed the now-redundant `java/utils/modelgenerator/mixed-summary-models` query. Similar replacement was made for `java/utils/modelgenerator/neutral-models`. That is, if `GenerateFlowModel.py` is provided with `--with-summaries` combined/mixed models are now generated instead of heuristic models (and similar for `--with-neutrals`).

java/ql/src/utils/modelgenerator/CaptureNeutralModels.ql

@@ -9,5 +9,5 @@
 import internal.CaptureModels
 
 from DataFlowSummaryTargetApi api, string noflow
-where noflow = captureNoFlow(api)
+where noflow = captureNeutral(api)
 select noflow order by noflow

java/ql/src/utils/modelgenerator/CaptureSinkModels.ql

@@ -9,5 +9,5 @@
 import internal.CaptureModels
 
 from DataFlowSinkTargetApi api, string sink
-where sink = captureSink(api)
+where sink = Heuristic::captureSink(api)
 select sink order by sink

java/ql/src/utils/modelgenerator/CaptureSourceModels.ql

@@ -9,5 +9,5 @@
 import internal.CaptureModels
 
 from DataFlowSourceTargetApi api, string source
-where source = captureSource(api)
+where source = Heuristic::captureSource(api)
 select source order by source

java/ql/src/utils/modelgenerator/CaptureSummaryModels.ql

@@ -9,5 +9,5 @@
 import internal.CaptureModels
 
 from DataFlowSummaryTargetApi api, string flow
-where flow = captureFlow(api)
+where flow = captureFlow(api, _)
 select flow order by flow

java/ql/src/utils/modelgenerator/debug/CaptureSummaryModelsPartialPath.ql

@@ -15,7 +15,7 @@ import PartialFlow::PartialPathGraph
 
 int explorationLimit() { result = 3 }
 
-module PartialFlow = PropagateFlow::FlowExplorationFwd<explorationLimit/0>;
+module PartialFlow = Heuristic::PropagateFlow::FlowExplorationFwd<explorationLimit/0>;
 
 from
   PartialFlow::PartialPathNode source, PartialFlow::PartialPathNode sink,

java/ql/src/utils/modelgenerator/debug/CaptureSummaryModelsPath.ql

@@ -11,6 +11,7 @@
 import java
 import semmle.code.java.dataflow.DataFlow
 import utils.modelgenerator.internal.CaptureModels
+import Heuristic
 import PropagateFlow::PathGraph
 
 from

java/ql/test/utils/modelgenerator/dataflow/CaptureSummaryModels.ql → java/ql/test/utils/modelgenerator/dataflow/CaptureHeuristicSummaryModels.ql

@@ -3,9 +3,9 @@ import utils.modelgenerator.internal.CaptureModels
 import utils.test.InlineMadTest
 
 module InlineMadTestConfig implements InlineMadTestConfigSig {
-  string getCapturedModel(Callable c) { result = captureFlow(c) }
+  string getCapturedModel(Callable c) { result = Heuristic::captureFlow(c) }
 
-  string getKind() { result = "summary" }
+  string getKind() { result = "heuristic-summary" }
 }
 
 import InlineMadTest<InlineMadTestConfig>

java/ql/test/utils/modelgenerator/dataflow/CaptureNeutralModels.ql

@@ -3,7 +3,7 @@ import utils.modelgenerator.internal.CaptureModels
 import utils.test.InlineMadTest
 
 module InlineMadTestConfig implements InlineMadTestConfigSig {
-  string getCapturedModel(Callable c) { result = captureNoFlow(c) }
+  string getCapturedModel(Callable c) { result = captureNeutral(c) }
 
   string getKind() { result = "neutral" }
 }

java/ql/test/utils/modelgenerator/dataflow/CaptureSinkModels.ql

@@ -3,7 +3,7 @@ import utils.modelgenerator.internal.CaptureModels
 import utils.test.InlineMadTest
 
 module InlineMadTestConfig implements InlineMadTestConfigSig {
-  string getCapturedModel(Callable c) { result = captureSink(c) }
+  string getCapturedModel(Callable c) { result = Heuristic::captureSink(c) }
 
   string getKind() { result = "sink" }
 }

java/ql/test/utils/modelgenerator/dataflow/CaptureSourceModels.ql

@@ -3,7 +3,7 @@ import utils.modelgenerator.internal.CaptureModels
 import utils.test.InlineMadTest
 
 module InlineMadTestConfig implements InlineMadTestConfigSig {
-  string getCapturedModel(Callable c) { result = captureSource(c) }
+  string getCapturedModel(Callable c) { result = Heuristic::captureSource(c) }
 
   string getKind() { result = "source" }
 }

java/ql/test/utils/modelgenerator/dataflow/p/Factory.java

@@ -6,13 +6,13 @@ public final class Factory {
 
   private int intValue;
 
-  // summary=p;Factory;false;create;(String,int);;Argument[0];ReturnValue;taint;df-generated
+  // heuristic-summary=p;Factory;false;create;(String,int);;Argument[0];ReturnValue;taint;df-generated
   // contentbased-summary=p;Factory;false;create;(String,int);;Argument[0];ReturnValue.Field[p.Factory.value];value;dfc-generated
   public static Factory create(String value, int foo) {
     return new Factory(value, foo);
   }
 
-  // summary=p;Factory;false;create;(String);;Argument[0];ReturnValue;taint;df-generated
+  // heuristic-summary=p;Factory;false;create;(String);;Argument[0];ReturnValue;taint;df-generated
   // contentbased-summary=p;Factory;false;create;(String);;Argument[0];ReturnValue.Field[p.Factory.value];value;dfc-generated
   public static Factory create(String value) {
     return new Factory(value, 0);
@@ -23,7 +23,7 @@ private Factory(String value, int intValue) {
     this.intValue = intValue;
   }
 
-  // summary=p;Factory;false;getValue;();;Argument[this];ReturnValue;taint;df-generated
+  // heuristic-summary=p;Factory;false;getValue;();;Argument[this];ReturnValue;taint;df-generated
   // contentbased-summary=p;Factory;false;getValue;();;Argument[this].Field[p.Factory.value];ReturnValue;value;dfc-generated
   public String getValue() {
     return value;

java/ql/test/utils/modelgenerator/dataflow/p/Fanout.java

@@ -10,7 +10,7 @@ public interface I2 extends I1 {}
   public class Impl1 implements I1 {
     public String v;
 
-    // summary=p;Fanout$I1;true;getValue;();;Argument[this];ReturnValue;taint;df-generated
+    // heuristic-summary=p;Fanout$I1;true;getValue;();;Argument[this];ReturnValue;taint;df-generated
     // contentbased-summary=p;Fanout$Impl1;true;getValue;();;Argument[this].Field[p.Fanout$Impl1.v];ReturnValue;value;dfc-generated
     public String getValue() {
       return v;
@@ -20,7 +20,7 @@ public String getValue() {
   public class Impl2 implements I2 {
     public String v;
 
-    // summary=p;Fanout$I1;true;getValue;();;Argument[this];ReturnValue;taint;df-generated
+    // heuristic-summary=p;Fanout$I1;true;getValue;();;Argument[this];ReturnValue;taint;df-generated
     // contentbased-summary=p;Fanout$Impl2;true;getValue;();;Argument[this].Field[p.Fanout$Impl2.v];ReturnValue;value;dfc-generated
     public String getValue() {
       return v;
@@ -30,7 +30,7 @@ public String getValue() {
   public class Impl3 implements I2 {
     public String v;
 
-    // summary=p;Fanout$I1;true;getValue;();;Argument[this];ReturnValue;taint;df-generated
+    // heuristic-summary=p;Fanout$I1;true;getValue;();;Argument[this];ReturnValue;taint;df-generated
     // contentbased-summary=p;Fanout$Impl3;true;getValue;();;Argument[this].Field[p.Fanout$Impl3.v];ReturnValue;value;dfc-generated
     public String getValue() {
       return v;
@@ -40,24 +40,24 @@ public String getValue() {
   public class Impl4 implements I2 {
     public String v;
 
-    // summary=p;Fanout$I1;true;getValue;();;Argument[this];ReturnValue;taint;df-generated
+    // heuristic-summary=p;Fanout$I1;true;getValue;();;Argument[this];ReturnValue;taint;df-generated
     // contentbased-summary=p;Fanout$Impl4;true;getValue;();;Argument[this].Field[p.Fanout$Impl4.v];ReturnValue;value;dfc-generated
     public String getValue() {
       return v;
     }
   }
 
-  // summary=p;Fanout;true;concatGetValueOnI1;(String,Fanout$I1);;Argument[0];ReturnValue;taint;df-generated
-  // summary=p;Fanout;true;concatGetValueOnI1;(String,Fanout$I1);;Argument[1];ReturnValue;taint;df-generated
+  // heuristic-summary=p;Fanout;true;concatGetValueOnI1;(String,Fanout$I1);;Argument[0];ReturnValue;taint;df-generated
+  // heuristic-summary=p;Fanout;true;concatGetValueOnI1;(String,Fanout$I1);;Argument[1];ReturnValue;taint;df-generated
   // No content based summaries are expected for this method on parameter `i`
   // as the fanout (number of content flows) exceeds the limit of 3.
   // contentbased-summary=p;Fanout;true;concatGetValueOnI1;(String,Fanout$I1);;Argument[0];ReturnValue;taint;dfc-generated
   public String concatGetValueOnI1(String other, I1 i) {
     return other + i.getValue();
   }
 
-  // summary=p;Fanout;true;concatGetValueOnI2;(String,Fanout$I2);;Argument[0];ReturnValue;taint;df-generated
-  // summary=p;Fanout;true;concatGetValueOnI2;(String,Fanout$I2);;Argument[1];ReturnValue;taint;df-generated
+  // heuristic-summary=p;Fanout;true;concatGetValueOnI2;(String,Fanout$I2);;Argument[0];ReturnValue;taint;df-generated
+  // heuristic-summary=p;Fanout;true;concatGetValueOnI2;(String,Fanout$I2);;Argument[1];ReturnValue;taint;df-generated
   // contentbased-summary=p;Fanout;true;concatGetValueOnI2;(String,Fanout$I2);;Argument[0];ReturnValue;taint;dfc-generated
   // contentbased-summary=p;Fanout;true;concatGetValueOnI2;(String,Fanout$I2);;Argument[1].Field[p.Fanout$Impl2.v];ReturnValue;taint;dfc-generated
   // contentbased-summary=p;Fanout;true;concatGetValueOnI2;(String,Fanout$I2);;Argument[1].Field[p.Fanout$Impl3.v];ReturnValue;taint;dfc-generated

java/ql/test/utils/modelgenerator/dataflow/p/FinalClass.java

@@ -4,7 +4,7 @@ public final class FinalClass {
 
   private static final String C = "constant";
 
-  // summary=p;FinalClass;false;returnsInput;(String);;Argument[0];ReturnValue;taint;df-generated
+  // heuristic-summary=p;FinalClass;false;returnsInput;(String);;Argument[0];ReturnValue;taint;df-generated
   // contentbased-summary=p;FinalClass;false;returnsInput;(String);;Argument[0];ReturnValue;value;dfc-generated
   public String returnsInput(String input) {
     return input;

java/ql/test/utils/modelgenerator/dataflow/p/FluentAPI.java

@@ -2,7 +2,7 @@
 
 public final class FluentAPI {
 
-  // summary=p;FluentAPI;false;returnsThis;(String);;Argument[this];ReturnValue;value;df-generated
+  // heuristic-summary=p;FluentAPI;false;returnsThis;(String);;Argument[this];ReturnValue;value;df-generated
   // contentbased-summary=p;FluentAPI;false;returnsThis;(String);;Argument[this];ReturnValue;value;dfc-generated
   public FluentAPI returnsThis(String input) {
     return this;

java/ql/test/utils/modelgenerator/dataflow/p/ImmutablePojo.java

@@ -6,14 +6,14 @@ public final class ImmutablePojo {
 
   private final long x;
 
-  // summary=p;ImmutablePojo;false;ImmutablePojo;(String,int);;Argument[0];Argument[this];taint;df-generated
+  // heuristic-summary=p;ImmutablePojo;false;ImmutablePojo;(String,int);;Argument[0];Argument[this];taint;df-generated
   // contentbased-summary=p;ImmutablePojo;false;ImmutablePojo;(String,int);;Argument[0];Argument[this].SyntheticField[p.ImmutablePojo.value];value;dfc-generated
   public ImmutablePojo(String value, int x) {
     this.value = value;
     this.x = x;
   }
 
-  // summary=p;ImmutablePojo;false;getValue;();;Argument[this];ReturnValue;taint;df-generated
+  // heuristic-summary=p;ImmutablePojo;false;getValue;();;Argument[this];ReturnValue;taint;df-generated
   // contentbased-summary=p;ImmutablePojo;false;getValue;();;Argument[this].SyntheticField[p.ImmutablePojo.value];ReturnValue;value;dfc-generated
   public String getValue() {
     return value;
@@ -24,8 +24,8 @@ public long getX() {
     return x;
   }
 
-  // summary=p;ImmutablePojo;false;or;(String);;Argument[0];ReturnValue;taint;df-generated
-  // summary=p;ImmutablePojo;false;or;(String);;Argument[this];ReturnValue;taint;df-generated
+  // heuristic-summary=p;ImmutablePojo;false;or;(String);;Argument[0];ReturnValue;taint;df-generated
+  // heuristic-summary=p;ImmutablePojo;false;or;(String);;Argument[this];ReturnValue;taint;df-generated
   // contentbased-summary=p;ImmutablePojo;false;or;(String);;Argument[0];ReturnValue;value;dfc-generated
   // contentbased-summary=p;ImmutablePojo;false;or;(String);;Argument[this].SyntheticField[p.ImmutablePojo.value];ReturnValue;value;dfc-generated
   public String or(String defaultValue) {