Merge pull request github#4927 from tamasvajk/feature/comp-assembly

C#: Add output assembly to compilation

Author: tamasvajk

csharp/extractor/Semmle.Extraction.CSharp/Analyser.cs

@@ -232,7 +232,7 @@ private void DoAnalyseCompilation(string cwd, string[] args)
                 var projectLayout = layout.LookupProjectOrDefault(transformedAssemblyPath);
                 var trapWriter = projectLayout.CreateTrapWriter(Logger, transformedAssemblyPath, options.TrapCompression, discardDuplicates: false);
                 compilationTrapFile = trapWriter;  // Dispose later
-                var cx = extractor.CreateContext(compilation.Clone(), trapWriter, new AssemblyScope(assembly, assemblyPath, true), AddAssemblyTrapPrefix);
+                var cx = extractor.CreateContext(compilation.Clone(), trapWriter, new AssemblyScope(assembly, assemblyPath), AddAssemblyTrapPrefix);
 
                 compilationEntity = new Entities.Compilation(cx, cwd, args);
             }
@@ -287,7 +287,7 @@ private void DoAnalyseReferenceAssembly(PortableExecutableReference r)
 
                     if (c.GetAssemblyOrModuleSymbol(r) is IAssemblySymbol assembly)
                     {
-                        var cx = extractor.CreateContext(c, trapWriter, new AssemblyScope(assembly, assemblyPath, false), AddAssemblyTrapPrefix);
+                        var cx = extractor.CreateContext(c, trapWriter, new AssemblyScope(assembly, assemblyPath), AddAssemblyTrapPrefix);
 
                         foreach (var module in assembly.Modules)
                         {

csharp/extractor/Semmle.Extraction.CSharp/Entities/Compilation.cs

@@ -21,9 +21,10 @@ 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.compilation_assembly(this, assembly);
 
             // Arguments
             var index = 0;

csharp/extractor/Semmle.Extraction.CSharp/Tuples.cs

@@ -111,6 +111,11 @@ internal static void compilations(this TextWriter trapFile, Compilation compilat
             trapFile.WriteTuple("compilations", compilation, cwd);
         }
 
+        internal static void compilation_assembly(this TextWriter trapFile, Compilation compilation, Assembly assembly)
+        {
+            trapFile.WriteTuple("compilation_assembly", compilation, assembly);
+        }
+
         internal static void compiler_generated(this TextWriter trapFile, IEntity entity)
         {
             trapFile.WriteTuple("compiler_generated", entity);

csharp/extractor/Semmle.Extraction/AssemblyScope.cs

@@ -10,15 +10,12 @@ public class AssemblyScope : IExtractionScope
         private readonly IAssemblySymbol assembly;
         private readonly string filepath;
 
-        public AssemblyScope(IAssemblySymbol symbol, string path, bool isOutput)
+        public AssemblyScope(IAssemblySymbol symbol, string path)
         {
             assembly = symbol;
             filepath = path;
-            IsGlobalScope = isOutput;
         }
 
-        public bool IsGlobalScope { get; }
-
         public bool InFileScope(string path) => path == filepath;
 
         public bool InScope(ISymbol symbol) =>

csharp/extractor/Semmle.Extraction/Context.cs

@@ -244,8 +244,6 @@ public Context(IExtractor e, Compilation c, TrapWriter trapWriter, IExtractionSc
 
         public bool FromSource => scope.FromSource;
 
-        public bool IsGlobalContext => scope.IsGlobalScope;
-
         public ICommentGenerator CommentGenerator { get; } = new CommentProcessor();
 
         private IExtractionScope scope { get; }

csharp/extractor/Semmle.Extraction/Entities/Assembly.cs

@@ -35,8 +35,7 @@ public override void Populate(TextWriter trapFile)
             }
         }
 
-        public override bool NeedsPopulation =>
-            !SymbolEqualityComparer.Default.Equals(assembly, Context.Compilation.Assembly) || !Context.IsGlobalContext;
+        public override bool NeedsPopulation => true;
 
         public override int GetHashCode() =>
             symbol == null ? 91187354 : symbol.GetHashCode();
@@ -59,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");

csharp/extractor/Semmle.Extraction/IExtractionScope.cs

@@ -23,8 +23,6 @@ public interface IExtractionScope
         /// <param name="path">The path to populate.</param>
         bool InFileScope(string path);
 
-        bool IsGlobalScope { get; }
-
         bool FromSource { get; }
     }
 }

csharp/extractor/Semmle.Extraction/SourceScope.cs

@@ -16,8 +16,6 @@ public SourceScope(SyntaxTree tree)
             SourceTree = tree;
         }
 
-        public bool IsGlobalScope => false;
-
         public bool InFileScope(string path) => path == SourceTree.FilePath;
 
         public bool InScope(ISymbol symbol) => symbol.Locations.Any(loc => loc.SourceTree == SourceTree);

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() { compilation_assembly(result, this) }
+
   override File getFile() { assemblies(this, result, _, _, _) }
 
   override string toString() { result = this.getFullName() }

csharp/ql/src/semmle/code/csharp/commons/Compilation.qll

@@ -9,6 +9,9 @@ class Compilation extends @compilation {
   /** Gets the directory in which this compilation was run, as a string. */
   string getDirectoryString() { compilations(this, result) }
 
+  /** Gets the output assembly. */
+  Assembly getOutputAssembly() { compilation_assembly(this, result) }
+
   /** Gets the folder in which this compilation was run. */
   Folder getFolder() { result.getAbsolutePath() = getDirectoryString() }