github · hvitved · Sep 4, 2020 · Feb 11, 2020 · Feb 12, 2020 · Feb 12, 2020
@@ -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
 

@@ -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;
                     }

@@ -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);

@@ -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>
         {

@@ -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>
         {

@@ -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>
         {

@@ -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");
             }

@@ -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
         {

@@ -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>
         {

@@ -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>
         {

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

@@ -18,7 +18,7 @@ class Field : CachedSymbol<IFieldSymbol>, IExpressionParentEntity
             type = new Lazy<AnnotatedType>(() => Entities.Type.Create(cx, symbol.GetAnnotatedType()));
         }
 
-        public static Field Create(Context cx, IFieldSymbol field) => FieldFactory.Instance.CreateEntity(cx, field);
+        public static Field Create(Context cx, IFieldSymbol field) => FieldFactory.Instance.CreateEntityFromSymbol(cx, field);
 
         // Do not populate backing fields.
         // Populate Tuple fields.
@@ -101,6 +101,8 @@ public override void Populate(TextWriter trapFile)
 
         public override void WriteId(TextWriter trapFile)
         {
+            trapFile.WriteSubId(Type.Type);
+            trapFile.Write(" ");
             trapFile.WriteSubId(ContainingType);
             trapFile.Write('.');
             trapFile.Write(symbol.Name);

@@ -71,7 +71,7 @@ public override void Populate(TextWriter trapFile)
                 TypeMention.Create(Context, syntax.Type, this, type);
         }
 
-        public static new Indexer Create(Context cx, IPropertySymbol prop) => IndexerFactory.Instance.CreateEntity(cx, prop);
+        public static new Indexer Create(Context cx, IPropertySymbol prop) => IndexerFactory.Instance.CreateEntityFromSymbol(cx, prop);
 
         public override void WriteId(TextWriter trapFile)
         {

@@ -22,7 +22,7 @@ public override void WriteQuotedId(TextWriter trapFile)
             trapFile.Write('*');
         }
 
-        public static new LocalFunction Create(Context cx, IMethodSymbol field) => LocalFunctionFactory.Instance.CreateEntity(cx, field);
+        public static new LocalFunction Create(Context cx, IMethodSymbol field) => LocalFunctionFactory.Instance.CreateEntityFromSymbol(cx, field);
 
         class LocalFunctionFactory : ICachedEntityFactory<IMethodSymbol, LocalFunction>
         {

@@ -43,7 +43,7 @@ symbol is ILocalSymbol l ?
 
         public static LocalVariable Create(Context cx, ISymbol local)
         {
-            return LocalVariableFactory.Instance.CreateEntity(cx, local);
+            return LocalVariableFactory.Instance.CreateEntityFromSymbol(cx, local);
         }
 
         void DefineConstantValue(TextWriter trapFile)

@@ -108,6 +108,9 @@ public void Overrides(TextWriter trapFile)
         /// </summary>
         protected static void BuildMethodId(Method m, TextWriter trapFile)
         {
+            m.symbol.ReturnType.BuildOrWriteId(m.Context, trapFile, m.symbol);
+            trapFile.Write(" ");
+
             trapFile.WriteSubId(m.ContainingType);
 
             AddExplicitInterfaceQualifierToId(m.Context, trapFile, m.symbol.ExplicitInterfaceImplementations);
@@ -129,7 +132,7 @@ protected static void BuildMethodId(Method m, TextWriter trapFile)
                     // Type arguments with different nullability can result in
                     // a constructed method with different nullability of its parameters and return type,
                     // so we need to create a distinct database entity for it.
-                    trapFile.BuildList(",", m.symbol.GetAnnotatedTypeArguments(), (ta, tb0) => { AddSignatureTypeToId(m.Context, tb0, m.symbol, ta.Symbol); trapFile.Write((int)ta.Nullability); });
+                    trapFile.BuildList(",", m.symbol.GetAnnotatedTypeArguments(), (ta, tb0) => { ta.Symbol.BuildOrWriteId(m.Context, tb0, m.symbol); trapFile.Write((int)ta.Nullability); });
                     trapFile.Write('>');
                 }
             }
@@ -163,65 +166,21 @@ public override void WriteId(TextWriter trapFile)
             BuildMethodId(this, trapFile);
         }
 
-        /// <summary>
-        /// Adds an appropriate label ID to the trap builder <paramref name="trapFile"/>
-        /// for the type <paramref name="type"/> belonging to the signature of method
-        /// <paramref name="method"/>.
-        ///
-        /// For methods without type parameters this will always add the key of the
-        /// corresponding type.
-        ///
-        /// For methods with type parameters, this will add the key of the
-        /// corresponding type if the type does *not* contain one of the method
-        /// type parameters, otherwise it will add a textual representation of
-        /// the type. This distinction is required because type parameter IDs
-        /// refer to their declaring methods.
-        ///
-        /// Example:
-        ///
-        /// <code>
-        /// int Count&lt;T&gt;(IEnumerable<T> items)
-        /// </code>
-        ///
-        /// The label definitions for <code>Count</code> (<code>#4</code>) and <code>T</code>
-        /// (<code>#5</code>) will look like:
-        ///
-        /// <code>
-        /// #1=&lt;label for System.Int32&gt;
-        /// #2=&lt;label for type containing Count&gt;
-        /// #3=&lt;label for IEnumerable`1&gt;
-        /// #4=@"{#1} {#2}.Count`2(#3<T>);method"
-        /// #5=@"{#4}T;typeparameter"
-        /// </code>
-        ///
-        /// Note how <code>int</code> is referenced in the label definition <code>#3</code> for
-        /// <code>Count</code>, while <code>T[]</code> is represented textually in order
-        /// to make the reference to <code>#3</code> in the label definition <code>#4</code> for
-        /// <code>T</code> valid.
-        /// </summary>
-        protected static void AddSignatureTypeToId(Context cx, TextWriter trapFile, IMethodSymbol method, ITypeSymbol type)
-        {
-            if (type.ContainsTypeParameters(cx, method))
-                type.BuildTypeId(cx, trapFile, (cx0, tb0, type0) => AddSignatureTypeToId(cx, tb0, method, type0));
-            else
-                trapFile.WriteSubId(Type.Create(cx, type));
-        }
-
         protected static void AddParametersToId(Context cx, TextWriter trapFile, IMethodSymbol method)
         {
             trapFile.Write('(');
             int index = 0;
 
-            if (method.MethodKind == MethodKind.ReducedExtension)
-            {
-                trapFile.WriteSeparator(",", ref index);
-                AddSignatureTypeToId(cx, trapFile, method, method.ReceiverType);
-            }
+            var @params = method.MethodKind == MethodKind.ReducedExtension
+                ? method.ReducedFrom.Parameters
+                : method.Parameters;
 
-            foreach (var param in method.Parameters)
+            foreach (var param in @params)
             {
                 trapFile.WriteSeparator(",", ref index);
-                AddSignatureTypeToId(cx, trapFile, method, param.Type);
+                param.Type.BuildOrWriteId(cx, trapFile, method);
+                trapFile.Write(" ");
+                trapFile.Write(param.Name);
                 switch (param.RefKind)
                 {
                     case RefKind.Out:
@@ -245,9 +204,7 @@ protected static void AddParametersToId(Context cx, TextWriter trapFile, IMethod
         public static void AddExplicitInterfaceQualifierToId(Context cx, System.IO.TextWriter trapFile, IEnumerable<ISymbol> explicitInterfaceImplementations)
         {
             if (explicitInterfaceImplementations.Any())
-            {
                 trapFile.AppendList(",", explicitInterfaceImplementations.Select(impl => cx.CreateEntity(impl.ContainingType)));
-            }
         }
 
         public virtual string Name => symbol.Name;

@@ -5,45 +5,24 @@
 
 namespace Semmle.Extraction.CSharp.Entities
 {
-    /// <summary>
-    /// Provide a "Key" object to allow modifiers to exist as entities in the extractor
-    /// hash map. (Raw strings would work as keys but might clash with other types).
-    /// </summary>
-    class ModifierKey : Object
+    class Modifier : Extraction.CachedEntity<string>
     {
-        public readonly string name;
-
-        public ModifierKey(string m)
-        {
-            name = m;
-        }
-
-        public override bool Equals(Object obj)
-        {
-            return obj.GetType() == GetType() && name == ((ModifierKey)obj).name;
-        }
-
-        public override int GetHashCode() => 13 * name.GetHashCode();
-    }
-
-    class Modifier : Extraction.CachedEntity<ModifierKey>
-    {
-        Modifier(Context cx, ModifierKey init)
+        Modifier(Context cx, string init)
             : base(cx, init) { }
 
         public override Microsoft.CodeAnalysis.Location ReportingLocation => null;
 
         public override void WriteId(TextWriter trapFile)
         {
-            trapFile.Write(symbol.name);
+            trapFile.Write(symbol);
             trapFile.Write(";modifier");
         }
 
         public override bool NeedsPopulation => true;
 
         public override void Populate(TextWriter trapFile)
         {
-            trapFile.modifiers(Label, symbol.name);
+            trapFile.modifiers(Label, symbol);
         }
 
         public static string AccessbilityModifier(Accessibility access)
@@ -152,17 +131,22 @@ public static void ExtractModifiers(Context cx, TextWriter trapFile, IEntity key
             }
         }
 
-        public static Modifier Create(Context cx, string modifier) =>
-            ModifierFactory.Instance.CreateEntity(cx, new ModifierKey(modifier));
+        public static Modifier Create(Context cx, string modifier)
+        {
+            return ModifierFactory.Instance.CreateEntity(cx, (typeof(Modifier), modifier), modifier);
+        }
 
-        public static Modifier Create(Context cx, Accessibility access) =>
-            ModifierFactory.Instance.CreateEntity(cx, new ModifierKey(AccessbilityModifier(access)));
+        public static Modifier Create(Context cx, Accessibility access)
+        {
+            var modifier = AccessbilityModifier(access);
+            return ModifierFactory.Instance.CreateEntity(cx, (typeof(Modifier), modifier), modifier);
+        }
 
-        class ModifierFactory : ICachedEntityFactory<ModifierKey, Modifier>
+        class ModifierFactory : ICachedEntityFactory<string, Modifier>
         {
             public static readonly ModifierFactory Instance = new ModifierFactory();
 
-            public Modifier Create(Context cx, ModifierKey init) => new Modifier(cx, init);
+            public Modifier Create(Context cx, string init) => new Modifier(cx, init);
         }
         public override TrapStackBehaviour TrapStackBehaviour => TrapStackBehaviour.OptionalLabel;
     }

@@ -34,7 +34,7 @@ public override void WriteId(TextWriter trapFile)
             trapFile.Write(";namespace");
         }
 
-        public static Namespace Create(Context cx, INamespaceSymbol ns) => NamespaceFactory.Instance.CreateEntity2(cx, ns);
+        public static Namespace Create(Context cx, INamespaceSymbol ns) => NamespaceFactory.Instance.CreateEntityFromSymbol(cx, ns);
 
         class NamespaceFactory : ICachedEntityFactory<INamespaceSymbol, Namespace>
         {

@@ -51,7 +51,7 @@ public override void Populate(TextWriter trapFile)
             ExtractCompilerGenerated(trapFile);
         }
 
-        public new static OrdinaryMethod Create(Context cx, IMethodSymbol method) => OrdinaryMethodFactory.Instance.CreateEntity(cx, method);
+        public new static OrdinaryMethod Create(Context cx, IMethodSymbol method) => OrdinaryMethodFactory.Instance.CreateEntityFromSymbol(cx, method);
 
         class OrdinaryMethodFactory : ICachedEntityFactory<IMethodSymbol, OrdinaryMethod>
         {