C#: Add output assembly to compilation

tamasvajk · tamasvajk · commit 5cfa90082899 · 2021-01-13T09:10:49.000+01:00
diff --git a/csharp/extractor/Semmle.Extraction.CSharp/Entities/Compilation.cs b/csharp/extractor/Semmle.Extraction.CSharp/Entities/Compilation.cs
@@ -21,9 +21,9 @@ public Compilation(Context cx, string cwd, string[] args) : base(cx)
 
         protected override void Populate(TextWriter trapFile)
         {
-            Extraction.Entities.Assembly.CreateOutputAssembly(cx);
+            var assembly = Extraction.Entities.Assembly.CreateOutputAssembly(cx);
 
-            trapFile.compilations(this, FileUtils.ConvertToUnix(cwd));
+            trapFile.compilations(this, FileUtils.ConvertToUnix(cwd), assembly);
 
             // Arguments
             var index = 0;
diff --git a/csharp/extractor/Semmle.Extraction.CSharp/Tuples.cs b/csharp/extractor/Semmle.Extraction.CSharp/Tuples.cs
@@ -106,9 +106,9 @@ internal static void compilation_time(this TextWriter trapFile, Compilation comp
             trapFile.WriteTuple("compilation_time", compilation, num, index, metric);
         }
 
-        internal static void compilations(this TextWriter trapFile, Compilation compilation, string cwd)
+        internal static void compilations(this TextWriter trapFile, Compilation compilation, string cwd, Assembly assembly)
         {
-            trapFile.WriteTuple("compilations", compilation, cwd);
+            trapFile.WriteTuple("compilations", compilation, cwd, assembly);
         }
 
         internal static void compiler_generated(this TextWriter trapFile, IEntity entity)
diff --git a/csharp/extractor/Semmle.Extraction/Entities/Assembly.cs b/csharp/extractor/Semmle.Extraction/Entities/Assembly.cs
@@ -58,7 +58,8 @@ private class AssemblyConstructorFactory : ICachedEntityFactory<Microsoft.CodeAn
         }
 
         private static readonly object outputAssemblyCacheKey = new object();
-        public static Location CreateOutputAssembly(Context cx)
+
+        public static Assembly CreateOutputAssembly(Context cx)
         {
             if (cx.Extractor.OutputPath == null)
                 throw new InternalError("Attempting to create the output assembly in standalone extraction mode");
diff --git a/csharp/ql/src/semmle/code/csharp/Location.qll b/csharp/ql/src/semmle/code/csharp/Location.qll
@@ -14,6 +14,7 @@
 
 import File
 private import Attribute
+private import semmle.code.csharp.commons.Compilation
 
 /**
  * A location of a program element.
@@ -171,6 +172,9 @@ class Assembly extends Location, Attributable, @assembly {
   /** Gets the version of this assembly. */
   Version getVersion() { assemblies(this, _, _, _, result) }
 
+  /** Gets the compilation producing this assembly if any. */
+  Compilation getCompilation() { compilations(result, _, this) }
+
   override File getFile() { assemblies(this, result, _, _, _) }
 
   override string toString() { result = this.getFullName() }
diff --git a/csharp/ql/src/semmle/code/csharp/commons/Compilation.qll b/csharp/ql/src/semmle/code/csharp/commons/Compilation.qll
@@ -7,7 +7,10 @@ class Compilation extends @compilation {
   string toString() { result = "compilation" }
 
   /** Gets the directory in which this compilation was run, as a string. */
-  string getDirectoryString() { compilations(this, result) }
+  string getDirectoryString() { compilations(this, result, _) }
+
+  /** Gets the output assembly. */
+  Assembly getOutputAssembly() { compilations(this, _, result) }
 
   /** Gets the folder in which this compilation was run. */
   Folder getFolder() { result.getAbsolutePath() = getDirectoryString() }
diff --git a/csharp/ql/src/semmlecode.csharp.dbscheme b/csharp/ql/src/semmlecode.csharp.dbscheme
@@ -7,11 +7,13 @@
  *   csc f1.cs f2.cs f3.cs
  *
  * The `id` simply identifies the invocation, while `cwd` is the working
- * directory from which the compiler was invoked.
+ * directory from which the compiler was invoked. The `assembly` identifies
+ * the output assembly of the compilation.
  */
 compilations(
     unique int id : @compilation,
-    string cwd : string ref
+    string cwd : string ref,
+    int assembly: @assembly ref
 );
 
 /**
diff --git a/csharp/ql/test/library-tests/assemblies/compilation.expected b/csharp/ql/test/library-tests/assemblies/compilation.expected
@@ -0,0 +1,9 @@
+| Assembly1, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null | no compilation |
+| Locations, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null | has compilation |
+| System, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 | no compilation |
+| System.Console, Version=4.1.2.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a | no compilation |
+| System.Core, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 | no compilation |
+| System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e | no compilation |
+| System.Runtime, Version=4.2.2.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a | no compilation |
+| System.Runtime.Extensions, Version=4.2.2.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a | no compilation |
+| mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 | no compilation |
diff --git a/csharp/ql/test/library-tests/assemblies/compilation.ql b/csharp/ql/test/library-tests/assemblies/compilation.ql
@@ -0,0 +1,8 @@
+import csharp
+
+private string hasCompilation(Assembly a) {
+  if exists(a.getCompilation()) then result = "has compilation" else result = "no compilation"
+}
+
+from Assembly a
+select a.getFullName(), hasCompilation(a)
diff --git a/csharp/ql/test/library-tests/compilations/Compilations.expected b/csharp/ql/test/library-tests/compilations/Compilations.expected
@@ -35,3 +35,5 @@ references
 | compilation | mscorlib.dll |
 timings
 | compilation |
+assembly
+| compilation | Program.dll:0:0:0:0 | Program, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null |
diff --git a/csharp/ql/test/library-tests/compilations/Compilations.ql b/csharp/ql/test/library-tests/compilations/Compilations.ql
@@ -39,3 +39,5 @@ query predicate timings(Compilation c) {
   c.getCpuSeconds() > 0 and
   c.getElapsedSeconds() > 0
 }
+
+query predicate assembly(Compilation c, Assembly a) { c.getOutputAssembly() = a }

Original file line number	Diff line number	Diff line change
`@@ -21,9 +21,9 @@ public Compilation(Context cx, string cwd, string[] args) : base(cx)`
`21`	`21`
`22`	`22`	`protected override void Populate(TextWriter trapFile)`
`23`	`23`	`{`
`24`		`- Extraction.Entities.Assembly.CreateOutputAssembly(cx);`
	`24`	`+ var assembly = Extraction.Entities.Assembly.CreateOutputAssembly(cx);`
`25`	`25`
`26`		`- trapFile.compilations(this, FileUtils.ConvertToUnix(cwd));`
	`26`	`+ trapFile.compilations(this, FileUtils.ConvertToUnix(cwd), assembly);`
`27`	`27`
`28`	`28`	`// Arguments`
`29`	`29`	`var index = 0;`
Original file line number	Diff line number	Diff line change
`@@ -106,9 +106,9 @@ internal static void compilation_time(this TextWriter trapFile, Compilation comp`
`106`	`106`	`trapFile.WriteTuple("compilation_time", compilation, num, index, metric);`
`107`	`107`	`}`
`108`	`108`
`109`		`- internal static void compilations(this TextWriter trapFile, Compilation compilation, string cwd)`
	`109`	`+ internal static void compilations(this TextWriter trapFile, Compilation compilation, string cwd, Assembly assembly)`
`110`	`110`	`{`
`111`		`- trapFile.WriteTuple("compilations", compilation, cwd);`
	`111`	`+ trapFile.WriteTuple("compilations", compilation, cwd, assembly);`
`112`	`112`	`}`
`113`	`113`
`114`	`114`	`internal static void compiler_generated(this TextWriter trapFile, IEntity entity)`
Original file line number	Diff line number	Diff line change
`@@ -58,7 +58,8 @@ private class AssemblyConstructorFactory : ICachedEntityFactory<Microsoft.CodeAn`
`58`	`58`	`}`
`59`	`59`
`60`	`60`	`private static readonly object outputAssemblyCacheKey = new object();`
`61`		`- public static Location CreateOutputAssembly(Context cx)`
	`61`	`+`
	`62`	`+ public static Assembly CreateOutputAssembly(Context cx)`
`62`	`63`	`{`
`63`	`64`	`if (cx.Extractor.OutputPath == null)`
`64`	`65`	`throw new InternalError("Attempting to create the output assembly in standalone extraction mode");`
Original file line number	Diff line number	Diff line change
`@@ -39,3 +39,5 @@ query predicate timings(Compilation c) {`
`39`	`39`	`c.getCpuSeconds() > 0 and`
`40`	`40`	`c.getElapsedSeconds() > 0`
`41`	`41`	`}`
	`42`	`+`
	`43`	`+query predicate assembly(Compilation c, Assembly a) { c.getOutputAssembly() = a }`