Merge pull request #17521 from michaelnebel/modelgen/moreimprovements

C#/Java: Content based model generation improvements.

Author: michaelnebel

csharp/ql/src/utils/modelgenerator/CaptureContentSummaryModels.ql

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

csharp/ql/src/utils/modelgenerator/CaptureMixedNeutralModels.ql

@@ -0,0 +1,13 @@
+/**
+ * @name Capture mixed neutral models.
+ * @description Finds neutral models to be used by other queries.
+ * @kind diagnostic
+ * @id cs/utils/modelgenerator/mixed-neutral-models
+ * @tags modelgenerator
+ */
+
+import internal.CaptureModels
+
+from DataFlowSummaryTargetApi api, string noflow
+where noflow = captureMixedNeutral(api)
+select noflow order by noflow

csharp/ql/src/utils/modelgenerator/CaptureMixedSummaryModels.ql

@@ -0,0 +1,13 @@
+/**
+ * @name Capture mixed summary models.
+ * @description Finds applicable summary models to be used by other queries.
+ * @kind diagnostic
+ * @id cs/utils/modelgenerator/mixed-summary-models
+ * @tags modelgenerator
+ */
+
+import internal.CaptureModels
+
+from DataFlowSummaryTargetApi api, string flow
+where flow = captureMixedFlow(api, _)
+select flow order by flow

csharp/ql/src/utils/modelgenerator/internal/CaptureModels.qll

@@ -131,7 +131,10 @@ module ModelGeneratorInput implements ModelGeneratorInputSig<Location, CsharpDat
 
     Callable lift() { result = lift }
 
-    predicate isRelevant() { relevant(this) }
+    predicate isRelevant() {
+      relevant(this) and
+      not hasManualSummaryModel(this)
+    }
   }
 
   /**

csharp/ql/test/library-tests/dataflow/external-models/ExternalFlow.cs

@@ -293,7 +293,8 @@ static void Sink(object o) { }
     }
 
     // Test synthetic fields
-    public class K {
+    public class K
+    {
 
         public object MyField;
 
@@ -309,24 +310,42 @@ public class K {
 
         public object GetMyFieldOnSyntheticField() => throw null;
 
-        public void M1() {
+        public void M1()
+        {
             var o = new object();
             SetMySyntheticField(o);
             Sink(GetMySyntheticField());
         }
 
-        public void M2() {
+        public void M2()
+        {
             var o = new object();
             SetMyNestedSyntheticField(o);
             Sink(GetMyNestedSyntheticField());
         }
 
-        public void M3() {
+        public void M3()
+        {
             var o = new object();
             SetMyFieldOnSyntheticField(o);
             Sink(GetMyFieldOnSyntheticField());
         }
 
         static void Sink(object o) { }
     }
+
+    // Test content data flow provenance.
+    public class L
+    {
+        public void M1()
+        {
+            var l = new Library();
+            var o = new object();
+            l.SetValue(o);
+            Sink(l.GetValue());
+        }
+
+        static void Sink(object o) { }
+    }
+
 }

csharp/ql/test/library-tests/dataflow/external-models/ExternalFlow.cs_

@@ -13,5 +13,9 @@ namespace My.Qltest
         public static object StepArgReturnGenerated(object x) => throw null;
 
         public static object StepArgReturnGeneratedIgnored(object x) => throw null;
+
+        public void SetValue(object o) => throw null;
+
+        public object GetValue() => throw null;
     }
 }

csharp/ql/test/library-tests/dataflow/external-models/ExternalFlow.dll

@@ -43,6 +43,8 @@ extensions:
       - ["My.Qltest", "K", false, "GetMyNestedSyntheticField", "()", "", "Argument[this].SyntheticField[My.Qltest.K.MySyntheticField1].SyntheticField[MySyntheticField1.MyNestedSyntheticField]", "ReturnValue", "value", "manual"]
       - ["My.Qltest", "K", false, "SetMyFieldOnSyntheticField", "(System.Object)", "", "Argument[0]", "Argument[this].SyntheticField[My.Qltest.K.MySyntheticField2].Field[My.Qltest.K.MyField]", "value", "manual"]
       - ["My.Qltest", "K", false, "GetMyFieldOnSyntheticField", "()", "", "Argument[this].SyntheticField[My.Qltest.K.MySyntheticField2].Field[My.Qltest.K.MyField]", "ReturnValue", "value", "manual"]
+      - ["My.Qltest", "Library", false, "SetValue", "(System.Object)", "", "Argument[0]", "Argument[this].SyntheticField[X]", "value", "dfc-generated"]
+      - ["My.Qltest", "Library", false, "GetValue", "()", "", "Argument[this].SyntheticField[X]", "ReturnValue", "value", "dfc-generated"]
 
   - addsTo:
       pack: codeql/csharp-all

csharp/ql/test/library-tests/dataflow/external-models/ExternalFlow.expected

@@ -3,7 +3,7 @@ import utils.modelgenerator.internal.CaptureModels
 import TestUtilities.InlineMadTest
 
 module InlineMadTestConfig implements InlineMadTestConfigSig {
-  string getCapturedModel(Callable c) { result = ContentSensitive::captureFlow(c) }
+  string getCapturedModel(Callable c) { result = ContentSensitive::captureFlow(c, _) }
 
   string getKind() { result = "contentbased-summary" }
 }