[Xamarin.Android.Build.Tasks] introduce BannedApiAnalyzers for Mono.C…

…ecil

Context: https://github.com/dotnet/roslyn-analyzers/blob/68c643b4667c6808bd21910ef32f7e2f7bd776c5/src/Microsoft.CodeAnalysis.BannedApiAnalyzers/BannedApiAnalyzers.Help.md

In 526172b, we had some reasonable performance wins just by using
`TypeDefinitionCache`. Let's take this a step further by "banning"
usage of:

    Mono.Cecil.FieldReference.Resolve()
    Mono.Cecil.MethodReference.Resolve()
    Mono.Cecil.TypeReference.Resolve()

I applied this change to `Xamarin.Android.Build.Tasks.csproj` for now.

In various places, I had to pass `TypeDefinitionCache` around or use
an existing one.

In a future PR, I'll make a small change in xamarin/java.interop so we
can apply the same treatment to `Microsoft.Android.Sdk.ILLink.csproj`.

build-tools/banned-apis/BannedSymbols.txt

@@ -0,0 +1,3 @@
+M:Mono.Cecil.FieldReference.Resolve();Use IMetadataResolver.Resolve() instead so the result is cached
+M:Mono.Cecil.MethodReference.Resolve();Use IMetadataResolver.Resolve() instead so the result is cached
+M:Mono.Cecil.TypeReference.Resolve();Use IMetadataResolver.Resolve() instead so the result is cached

build-tools/banned-apis/banned-apis.targets

@@ -0,0 +1,9 @@
+<Project>
+  <PropertyGroup>
+    <WarningsAsErrors>RS0030</WarningsAsErrors>
+  </PropertyGroup>
+  <ItemGroup>
+    <PackageReference Include="Microsoft.CodeAnalysis.BannedApiAnalyzers" Version="3.3.4" PrivateAssets="All" />
+    <AdditionalFiles Include="$(MSBuildThisFileDirectory)BannedSymbols.txt" />
+  </ItemGroup>
+</Project>

src/Microsoft.Android.Sdk.ILLink/MarkJavaObjects.cs

@@ -23,12 +23,12 @@ public void ProcessType (TypeDefinition type)
 		{
 			// If this isn't a JLO or IJavaObject implementer,
 			// then we don't need to MarkJavaObjects
-			if (!type.ImplementsIJavaObject ())
+			if (!type.ImplementsIJavaObject (cache))
 				return;
 
 			PreserveJavaObjectImplementation (type);
 
-			if (IsImplementor (type))
+			if (IsImplementor (type, cache))
 				PreserveImplementor (type);
 
 			// If a user overrode a method, we need to preserve it,
@@ -195,7 +195,7 @@ void PreserveInterfaces (TypeDefinition type)
 
 			foreach (var iface in type.Interfaces) {
 				var td = iface.InterfaceType.Resolve ();
-				if (!td.ImplementsIJavaPeerable ())
+				if (!td.ImplementsIJavaPeerable (cache))
 					continue;
 				Annotations.Mark (td);
 			}
@@ -302,9 +302,9 @@ void PreserveConstructors (TypeDefinition type, TypeDefinition helper)
 				PreserveMethod (type, ctor);
 		}
 
-		static bool IsImplementor (TypeDefinition type)
+		static bool IsImplementor (TypeDefinition type, IMetadataResolver cache)
 		{
-			return type.Name.EndsWith ("Implementor", StringComparison.Ordinal) && type.Inherits ("Java.Lang.Object");
+			return type.Name.EndsWith ("Implementor", StringComparison.Ordinal) && type.Inherits ("Java.Lang.Object", cache);
 		}
 
 		static bool IsUserType (TypeDefinition type)

src/Microsoft.Android.Sdk.ILLink/PreserveApplications.cs

@@ -37,7 +37,7 @@ public void ProcessType (TypeDefinition type)
 		{
 			if (!IsActiveFor (type.Module.Assembly))
 				return;
-			if (!type.Inherits ("Android.App.Application"))
+			if (!type.Inherits ("Android.App.Application", cache))
 				return;
 
 			ProcessAttributeProvider (type);

src/Microsoft.Android.Sdk.ILLink/PreserveJavaExceptions.cs

@@ -23,7 +23,7 @@ public override void Initialize (LinkContext context, MarkContext markContext)
 
 		public void ProcessType (TypeDefinition type)
 		{
-			if (type.IsJavaException ())
+			if (type.IsJavaException (cache))
 				PreserveJavaException (type);
 		}
 

src/Microsoft.Android.Sdk.ILLink/PreserveJavaInterfaces.cs

@@ -29,7 +29,7 @@ void ProcessType (TypeDefinition type)
 				return;
 
 			// Mono.Android interfaces will always inherit IJavaObject
-			if (!type.ImplementsIJavaObject ())
+			if (!type.ImplementsIJavaObject (cache))
 				return;
 
 			foreach (MethodReference method in type.Methods)

src/Xamarin.Android.Build.Tasks/Linker/External/Linker/OverrideInformation.cs

@@ -25,19 +25,5 @@ public bool IsOverrideOfInterfaceMember
 				return Base.DeclaringType.IsInterface;
 			}
 		}
-
-		public TypeDefinition InterfaceType
-		{
-			get
-			{
-				if (!IsOverrideOfInterfaceMember)
-					return null;
-
-				if (MatchingInterfaceImplementation != null)
-					return MatchingInterfaceImplementation.InterfaceType.Resolve ();
-
-				return Base.DeclaringType;
-			}
-		}
 	}
-}
+}

src/Xamarin.Android.Build.Tasks/Linker/External/Mono.Tuner/CecilRocks.cs

@@ -453,67 +453,5 @@ public static ParameterDefinition GetParameter (this MethodBody self, int index)
 
 			return parameters [index];
 		}
-
-		public static bool Implements (this TypeReference self, string interfaceName)
-		{
-			if (interfaceName == null)
-				throw new ArgumentNullException ("interfaceName");
-			if (self == null)
-				return false;
-
-			TypeDefinition type = self.Resolve ();
-			if (type == null)
-				return false;	// not enough information available
-
-			// special case, check if we implement ourselves
-			if (type.IsInterface && (type.FullName == interfaceName))
-				return true;
-
-			return Implements (type, interfaceName, (interfaceName.IndexOf ('`') >= 0));
-		}
-
-		public static bool Implements (TypeDefinition type, string interfaceName, bool generic)
-		{
-			while (type != null) {
-				// does the type implements it itself
-				if (type.HasInterfaces) {
-					foreach (var iface in type.Interfaces) {
-						string fullname = (generic) ? iface.InterfaceType.GetElementType ().FullName : iface.InterfaceType.FullName;
-						if (fullname == interfaceName)
-							return true;
-						//if not, then maybe one of its parent interfaces does
-						if (Implements (iface.InterfaceType.Resolve (), interfaceName, generic))
-							return true;
-					}
-				}
-
-				type = type.BaseType != null ? type.BaseType.Resolve () : null;
-			}
-			return false;
-		}
-
-		public static bool Inherits (this TypeReference self, string @namespace, string name)
-		{
-			if (@namespace == null)
-				throw new ArgumentNullException ("namespace");
-			if (name == null)
-				throw new ArgumentNullException ("name");
-			if (self == null)
-				return false;
-
-			TypeReference current = self.Resolve ();
-			while (current != null) {
-				if (current.Is (@namespace, name))
-					return true;
-				if (current.Is ("System", "Object"))
-					return false;
-
-				TypeDefinition td = current.Resolve ();
-				if (td == null)
-					return false;		// could not resolve type
-				current = td.BaseType;
-			}
-			return false;
-		}
 	}
 }

src/Xamarin.Android.Build.Tasks/Linker/MonoDroid.Tuner/Extensions.cs

@@ -20,30 +20,30 @@ static class Extensions {
 		const string IJavaPeerable = "Java.Interop.IJavaPeerable";
 		const string JavaThrowable = "Java.Lang.Throwable";
 
-		public static bool IsJavaObject (this TypeDefinition type)
+		public static bool IsJavaObject (this TypeDefinition type, IMetadataResolver resolver)
 		{
-			return type.Inherits (JavaObject);
+			return type.Inherits (JavaObject, resolver);
 		}
 
-		public static bool IsJavaException (this TypeDefinition type)
+		public static bool IsJavaException (this TypeDefinition type, IMetadataResolver resolver)
 		{
-			return type.Inherits (JavaThrowable);
+			return type.Inherits (JavaThrowable, resolver);
 		}
 
-		public static bool ImplementsIJavaObject (this TypeDefinition type)
+		public static bool ImplementsIJavaObject (this TypeDefinition type, IMetadataResolver resolver)
 		{
-			return type.Implements (IJavaObject);
+			return type.Implements (IJavaObject, resolver);
 		}
 
-		public static bool ImplementsIJavaPeerable (this TypeDefinition type)
+		public static bool ImplementsIJavaPeerable (this TypeDefinition type, IMetadataResolver resolver)
 		{
-			return type.Implements (IJavaPeerable);
+			return type.Implements (IJavaPeerable, resolver);
 		}
 
-		public static object GetSettableValue (this CustomAttributeArgument arg)
+		public static object GetSettableValue (this CustomAttributeArgument arg, IMetadataResolver cache)
 		{
 			TypeReference tr = arg.Value as TypeReference;
-			TypeDefinition td = tr != null ? tr.Resolve () : null;
+			TypeDefinition td = tr != null ? cache.Resolve (tr) : null;
 			return td != null ? td.FullName + "," + td.Module.Assembly.FullName : arg.Value;
 		}
 
@@ -119,25 +119,25 @@ public static TypeDefinition GetType (AssemblyDefinition assembly, string typeNa
 			return assembly.MainModule.GetType (typeName);
 		}
 
-		public static bool Implements (this TypeReference self, string interfaceName)
+		public static bool Implements (this TypeReference self, string interfaceName, IMetadataResolver resolver)
 		{
 			if (interfaceName == null)
 				throw new ArgumentNullException ("interfaceName");
 			if (self == null)
 				return false;
 
-			TypeDefinition type = self.Resolve ();
+			TypeDefinition type = resolver.Resolve (self);
 			if (type == null)
 				return false;	// not enough information available
 
 			// special case, check if we implement ourselves
 			if (type.IsInterface && (type.FullName == interfaceName))
 				return true;
 
-			return Implements (type, interfaceName, (interfaceName.IndexOf ('`') >= 0));
+			return Implements (type, interfaceName, (interfaceName.IndexOf ('`') >= 0), resolver);
 		}
 
-		public static bool Implements (TypeDefinition type, string interfaceName, bool generic)
+		public static bool Implements (TypeDefinition type, string interfaceName, bool generic, IMetadataResolver resolver)
 		{
 			while (type != null) {
 				// does the type implements it itself
@@ -148,32 +148,36 @@ public static bool Implements (TypeDefinition type, string interfaceName, bool g
 						if (fullname == interfaceName)
 							return true;
 						//if not, then maybe one of its parent interfaces does
-						if (Implements (iface.Resolve (), interfaceName, generic))
+						if (Implements (resolver.Resolve (iface), interfaceName, generic, resolver))
 							return true;
 					}
 				}
 
-				type = type.BaseType != null ? type.BaseType.Resolve () : null;
+				if (type.BaseType != null) {
+					type = resolver.Resolve (type.BaseType);
+				} else {
+					type = null;
+				}
 			}
 			return false;
 		}
 
-		public static bool Inherits (this TypeReference self, string className)
+		public static bool Inherits (this TypeReference self, string className, IMetadataResolver resolver)
 		{
 			if (className == null)
 				throw new ArgumentNullException ("className");
 			if (self == null)
 				return false;
 
-			TypeReference current = self.Resolve ();
+			TypeReference current = resolver.Resolve (self);
 			while (current != null) {
 				string fullname = current.FullName;
 				if (fullname == className)
 					return true;
 				if (fullname == "System.Object")
 					return false;
 
-				TypeDefinition td = current.Resolve ();
+				TypeDefinition td = resolver.Resolve (current);
 				if (td == null)
 					return false;		// could not resolve type
 				current = td.BaseType;
@@ -285,7 +289,7 @@ public static bool TryGetBaseOrInterfaceRegisterMember (this MethodDefinition me
 				if (iface.InterfaceType.IsGenericInstance)
 					continue;
 
-				var itype = iface.InterfaceType.Resolve ();
+				var itype = resolver.Resolve (iface.InterfaceType);
 				if (itype == null || !itype.HasMethods)
 					continue;
 

src/Xamarin.Android.Build.Tasks/Linker/MonoDroid.Tuner/FixLegacyResourceDesignerStep.cs

@@ -26,6 +26,10 @@ public class FixLegacyResourceDesignerStep : LinkDesignerBase
 		internal const string DesignerAssemblyName = "_Microsoft.Android.Resource.Designer";
 		internal const string DesignerAssemblyNamespace = "_Microsoft.Android.Resource.Designer";
 
+#if !ILLINK
+		public FixLegacyResourceDesignerStep (IMetadataResolver cache) : base (cache) { }
+#endif
+
 		bool designerLoaded = false;
 		AssemblyDefinition designerAssembly = null;
 		TypeDefinition designerType = null;
@@ -93,7 +97,7 @@ internal override bool ProcessAssemblyDesigner (AssemblyDefinition assembly)
 
 			LogMessage ($"    Adding reference {designerAssembly.Name.Name}.");
 			assembly.MainModule.AssemblyReferences.Add (designerAssembly.Name);
-			var importedDesignerType = assembly.MainModule.ImportReference (designerType.Resolve ());
+			var importedDesignerType = assembly.MainModule.ImportReference (Cache.Resolve (designerType));
 
 			LogMessage ($"    FixupAssemblyTypes {assembly.Name.Name}.");
 			// now replace all ldsfld with a call to the property get_ method.
@@ -150,7 +154,7 @@ string GetFixupKey (Instruction instruction, string designerFullName)
 					(fieldRef.DeclaringType?.ToString()?.Contains (".Resource/") ?? false)) {
 				var canResolve = false;
 				try {
-					var resolved  = fieldRef.Resolve ();
+					var resolved  = Cache.Resolve (fieldRef);
 					canResolve    = resolved != null;
 				} catch (Exception) {
 				}

src/Xamarin.Android.Build.Tasks/Linker/MonoDroid.Tuner/LinkDesignerBase.cs

@@ -15,7 +15,19 @@
 
 
 namespace MonoDroid.Tuner  {
-	public abstract class LinkDesignerBase : BaseStep {
+	public abstract class LinkDesignerBase : BaseStep
+	{
+#if ILLINK
+		protected IMetadataResolver Cache => Context;
+#else   // !ILLINK
+		public LinkDesignerBase (IMetadataResolver cache)
+		{
+			Cache = cache;
+		}
+
+		protected IMetadataResolver Cache { get; private set; }
+#endif  // !ILLINK
+
 		public virtual void LogMessage (string message)
 		{
 			Context.LogMessage (message);

src/Xamarin.Android.Build.Tasks/Linker/MonoDroid.Tuner/RemoveResourceDesignerStep.cs

@@ -20,6 +20,11 @@ public class RemoveResourceDesignerStep : LinkDesignerBase
 		CustomAttribute mainDesignerAttribute;
 		Dictionary<string, int> designerConstants;
 		Regex opCodeRegex = new Regex (@"([\w]+): ([\w]+) ([\w.]+) ([\w:./]+)");
+
+#if !ILLINK
+		public RemoveResourceDesignerStep (IMetadataResolver cache) : base (cache) { }
+#endif
+
 		protected override void LoadDesigner ()
 		{
 			if (mainAssembly != null)

src/Xamarin.Android.Build.Tasks/Mono.Android/ActivityAttribute.Partial.cs

@@ -334,7 +334,7 @@ partial class ActivityAttribute {
 		TypeDefinition type;
 		ICollection<string> specified;
 
-		public static ActivityAttribute FromTypeDefinition (TypeDefinition type)
+		public static ActivityAttribute FromTypeDefinition (TypeDefinition type, TypeDefinitionCache cache)
 		{
 			CustomAttribute attr = type.GetCustomAttributes ("Android.App.ActivityAttribute")
 				.SingleOrDefault ();
@@ -343,7 +343,7 @@ public static ActivityAttribute FromTypeDefinition (TypeDefinition type)
 			ActivityAttribute self = new ActivityAttribute () {
 				type = type,
 			};
-			self.specified = mapping.Load (self, attr);
+			self.specified = mapping.Load (self, attr, cache);
 			return self;
 		}
 

src/Xamarin.Android.Build.Tasks/Mono.Android/ApplicationAttribute.Partial.cs

@@ -240,7 +240,7 @@ partial class ApplicationAttribute {
 
 		ICollection<string> specified;
 
-		public static ApplicationAttribute FromCustomAttributeProvider (ICustomAttributeProvider provider)
+		public static ApplicationAttribute FromCustomAttributeProvider (ICustomAttributeProvider provider, TypeDefinitionCache cache)
 		{
 			CustomAttribute attr = provider.GetCustomAttributes ("Android.App.ApplicationAttribute")
 				.SingleOrDefault ();
@@ -249,7 +249,7 @@ public static ApplicationAttribute FromCustomAttributeProvider (ICustomAttribute
 			ApplicationAttribute self = new ApplicationAttribute () {
 				provider  = provider,
 			};
-			self.specified = mapping.Load (self, attr);
+			self.specified = mapping.Load (self, attr, cache);
 			if (provider is TypeDefinition) {
 				self.specified.Add ("Name");
 			}