Merge pull request #4017 from hvitved/csharp/unqualify-trap-ids3

C#: Remove assembly prefixes from TRAP labels

Author: hvitved

change-notes/1.26/analysis-csharp.md

@@ -21,6 +21,10 @@ The following changes in version 1.26 affect C# analysis in all applications.
 * Partial method bodies are extracted. Previously, partial method bodies were skipped completely.
 * Inferring the lengths of implicitely sized arrays is fixed. Previously, multidimensional arrays were always extracted with the same length for
 each dimension. With the fix, the array sizes `2` and `1` are extracted for `new int[,]{{1},{2}}`. Previously `2` and `2` were extracted.
+* The extractor is now assembly-insensitive by default. This means that two entities with the same
+  fully-qualified name are now mapped to the same entity in the resulting database, regardless of
+  whether they belong to different assemblies. Assembly sensitivity can be reenabled by passing
+  `--assemblysensitivetrap` to the extractor.
 
 ## Changes to libraries
 

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

@@ -141,7 +141,7 @@ public static void ExtractCIL(Layout layout, string assemblyPath, ILogger logger
                     trapFile = trapWriter.TrapFile;
                     if (nocache || !System.IO.File.Exists(trapFile))
                     {
-                        var cx = extractor.CreateContext(null, trapWriter, null);
+                        var cx = extractor.CreateContext(null, trapWriter, null, false);
                         ExtractCIL(cx, assemblyPath, extractPdbs);
                         extracted = true;
                     }

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

@@ -25,9 +25,12 @@ public class Analyser : IDisposable
 
         public readonly ILogger Logger;
 
-        public Analyser(IProgressMonitor pm, ILogger logger)
+        public readonly bool AddAssemblyTrapPrefix;
+
+        public Analyser(IProgressMonitor pm, ILogger logger, bool addAssemblyTrapPrefix)
         {
             Logger = logger;
+            AddAssemblyTrapPrefix = addAssemblyTrapPrefix;
             Logger.Log(Severity.Info, "EXTRACTION STARTING at {0}", DateTime.Now);
             stopWatch.Start();
             progressMonitor = pm;
@@ -231,7 +234,7 @@ void DoAnalyseCompilation(string cwd, string[] args)
                 var projectLayout = layout.LookupProjectOrDefault(assemblyPath);
                 var trapWriter = projectLayout.CreateTrapWriter(Logger, assemblyPath, true, options.TrapCompression);
                 compilationTrapFile = trapWriter;  // Dispose later
-                var cx = extractor.CreateContext(compilation.Clone(), trapWriter, new AssemblyScope(assembly, assemblyPath, true));
+                var cx = extractor.CreateContext(compilation.Clone(), trapWriter, new AssemblyScope(assembly, assemblyPath, true), AddAssemblyTrapPrefix);
 
                 compilationEntity = new Entities.Compilation(cx, cwd, args);
             }
@@ -286,7 +289,7 @@ void DoAnalyseAssembly(PortableExecutableReference r)
 
                         if (assembly != null)
                         {
-                            var cx = extractor.CreateContext(c, trapWriter, new AssemblyScope(assembly, assemblyPath, false));
+                            var cx = extractor.CreateContext(c, trapWriter, new AssemblyScope(assembly, assemblyPath, false), AddAssemblyTrapPrefix);
 
                             foreach (var module in assembly.Modules)
                             {
@@ -372,7 +375,7 @@ void DoExtractTree(SyntaxTree tree)
 
                         if (!upToDate)
                         {
-                            Context cx = extractor.CreateContext(compilation.Clone(), trapWriter, new SourceScope(tree));
+                            Context cx = extractor.CreateContext(compilation.Clone(), trapWriter, new SourceScope(tree), AddAssemblyTrapPrefix);
                             Populators.CompilationUnit.Extract(cx, tree.GetRoot());
                             cx.PopulateAll();
                             cx.ExtractComments(cx.CommentGenerator);

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

@@ -77,7 +77,7 @@ public override void Populate(TextWriter trapFile)
         }
 
         public new static Accessor Create(Context cx, IMethodSymbol symbol) =>
-            AccessorFactory.Instance.CreateEntity(cx, symbol);
+            AccessorFactory.Instance.CreateEntityFromSymbol(cx, symbol);
 
         class AccessorFactory : ICachedEntityFactory<IMethodSymbol, Accessor>
         {

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

@@ -35,7 +35,7 @@ public void BindTo(Label entity, CommentBinding binding)
             Context.TrapWriter.Writer.commentblock_binding(this, entity, binding);
         }
 
-        public static CommentBlock Create(Context cx, ICommentBlock block) => CommentBlockFactory.Instance.CreateEntity(cx, block);
+        public static CommentBlock Create(Context cx, ICommentBlock block) => CommentBlockFactory.Instance.CreateEntity(cx, block, block);
 
         class CommentBlockFactory : ICachedEntityFactory<ICommentBlock, CommentBlock>
         {

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

@@ -129,7 +129,11 @@ public override void WriteId(TextWriter trapFile)
             trapFile.Write(";commentline");
         }
 
-        static CommentLine Create(Context cx, Microsoft.CodeAnalysis.Location loc, CommentLineType type, string text, string raw) => CommentLineFactory.Instance.CreateEntity(cx, loc, type, text, raw);
+        static CommentLine Create(Context cx, Microsoft.CodeAnalysis.Location loc, CommentLineType type, string text, string raw)
+        {
+            var init = (loc, type, text, raw);
+            return CommentLineFactory.Instance.CreateEntity(cx, init, init);
+        }
 
         class CommentLineFactory : ICachedEntityFactory<(Microsoft.CodeAnalysis.Location, CommentLineType, string, string), CommentLine>
         {

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

@@ -104,7 +104,7 @@ ConstructorDeclarationSyntax Syntax
             {
                 case MethodKind.StaticConstructor:
                 case MethodKind.Constructor:
-                    return ConstructorFactory.Instance.CreateEntity(cx, constructor);
+                    return ConstructorFactory.Instance.CreateEntityFromSymbol(cx, constructor);
                 default:
                     throw new InternalError(constructor, "Attempt to create a Constructor from a symbol that isn't a constructor");
             }

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

@@ -11,7 +11,7 @@ class Conversion : UserOperator
             : base(cx, init) { }
 
         public new static Conversion Create(Context cx, IMethodSymbol symbol) =>
-            ConversionFactory.Instance.CreateEntity(cx, symbol);
+            ConversionFactory.Instance.CreateEntityFromSymbol(cx, symbol);
 
         public override Microsoft.CodeAnalysis.Location ReportingLocation
         {

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

@@ -24,7 +24,7 @@ public override void Populate(TextWriter trapFile)
         }
 
         public new static Destructor Create(Context cx, IMethodSymbol symbol) =>
-            DestructorFactory.Instance.CreateEntity(cx, symbol);
+            DestructorFactory.Instance.CreateEntityFromSymbol(cx, symbol);
 
         class DestructorFactory : ICachedEntityFactory<IMethodSymbol, Destructor>
         {

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

@@ -60,7 +60,7 @@ public override void Populate(TextWriter trapFile)
                 TypeMention.Create(Context, syntaxType, this, type);
         }
 
-        public static Event Create(Context cx, IEventSymbol symbol) => EventFactory.Instance.CreateEntity(cx, symbol);
+        public static Event Create(Context cx, IEventSymbol symbol) => EventFactory.Instance.CreateEntityFromSymbol(cx, symbol);
 
         class EventFactory : ICachedEntityFactory<IEventSymbol, Event>
         {