Enable single file analyzer in the runtime

eng/Analyzers.props

@@ -3,11 +3,13 @@
  <CodeAnalysisRuleset>$(MSBuildThisFileDirectory)CodeAnalysis.ruleset</CodeAnalysisRuleset>
  <!-- Disable analyzers in sourcebuild -->
  <RunAnalyzers Condition="'$(DotNetBuildFromSource)' == 'true'">false</RunAnalyzers>
+ <EnableSingleFileAnalyzer>true</EnableSingleFileAnalyzer>
  </PropertyGroup>
  <ItemGroup Condition="'$(RunAnalyzers)' != 'false'">
  <PackageReference Include="Microsoft.DotNet.CodeAnalysis" Version="$(MicrosoftDotNetCodeAnalysisVersion)" PrivateAssets="all" IsImplicitlyDefined="true" />
  <PackageReference Include="Microsoft.CodeAnalysis.NetAnalyzers" Version="$(MicrosoftCodeAnalysisNetAnalyzersVersion)" PrivateAssets="all" />
  <PackageReference Include="Microsoft.CodeAnalysis.CSharp.CodeStyle" Version="$(MicrosoftCodeAnalysisCSharpCodeStyleVersion)" PrivateAssets="all" />
  <PackageReference Include="StyleCop.Analyzers" Version="$(StyleCopAnalyzersVersion)" PrivateAssets="all" />
+ <PackageReference Include="Microsoft.NET.ILLink.Analyzers" Version="$(MicrosoftNETILLinkAnalyzerPackageVersion)" PrivateAssets="all" />
  </ItemGroup>
 </Project>

eng/CodeAnalysis.ruleset

@@ -253,8 +253,6 @@
  <Rule Id="CA5401" Action="None" /> <!-- Do not use CreateEncryptor with non-default IV -->
  <Rule Id="CA5402" Action="None" /> <!-- Use CreateEncryptor with the default IV -->
  <Rule Id="CA5403" Action="None" /> <!-- Do not hard-code certificate -->
- <Rule Id="IL3000" Action="None" /> <!-- Avoid using accessing Assembly file path when publishing as a single-file -->
- <Rule Id="IL3001" Action="None" /> <!-- Avoid using accessing Assembly file path when publishing as a single-file -->
  </Rules>
  <Rules AnalyzerId="StyleCop.Analyzers" RuleNamespace="StyleCop.Analyzers">
  <Rule Id="AD0001" Action="None" /> <!-- Analyzer threw an exception -->

eng/Versions.props

@@ -160,6 +160,7 @@
  <MicrosoftPrivateIntellisenseVersion>5.0.0-preview-20201009.2</MicrosoftPrivateIntellisenseVersion>
  <!-- ILLink -->
  <MicrosoftNETILLinkTasksVersion>6.0.100-preview.2.21205.2</MicrosoftNETILLinkTasksVersion>
+ <MicrosoftNETILLinkAnalyzerPackageVersion>$(MicrosoftNETILLinkTasksVersion)</MicrosoftNETILLinkAnalyzerPackageVersion>
  <!-- ICU -->
  <MicrosoftNETCoreRuntimeICUTransportVersion>6.0.0-preview.4.21179.1</MicrosoftNETCoreRuntimeICUTransportVersion>
  <!-- Mono LLVM -->

src/libraries/Microsoft.Extensions.DependencyModel/src/DependencyContext.cs

@@ -3,6 +3,7 @@
 
 using System;
 using System.Collections.Generic;
+using System.Diagnostics.CodeAnalysis;
 using System.Linq;
 using System.Reflection;
 
@@ -74,6 +75,7 @@ public DependencyContext Merge(DependencyContext other)
  );
  }
 
+ [RequiresAssemblyFiles(Message = "Calls GetDepsJsonPath")]
  private static DependencyContext LoadDefault()
  {
  var entryAssembly = Assembly.GetEntryAssembly();
@@ -85,6 +87,7 @@ private static DependencyContext LoadDefault()
  return Load(entryAssembly);
  }
 
+ [RequiresAssemblyFiles(Message = "Calls GetDepsJsonPath")]
  public static DependencyContext Load(Assembly assembly)
  {
  return DependencyContextLoader.Default.Load(assembly);

src/libraries/Microsoft.Extensions.DependencyModel/src/DependencyContextLoader.cs

@@ -4,6 +4,7 @@
 using System;
 using System.Collections.Generic;
 using System.Diagnostics;
+using System.Diagnostics.CodeAnalysis;
 using System.IO;
 using System.Reflection;
 
@@ -50,6 +51,7 @@ private static Stream GetResourceStream(Assembly assembly, string name)
  return assembly.GetManifestResourceStream(name);
  }
 
+ [RequiresAssemblyFiles(Message = "Calls GetDepsJsonPath")]
  public DependencyContext Load(Assembly assembly)
  {
  if (assembly == null)
@@ -103,6 +105,7 @@ private DependencyContext LoadContext(IDependencyContextReader reader, string lo
  return null;
  }
 
+ [RequiresAssemblyFiles (Message = "Calls GetDepsJsonPath")]
  private DependencyContext LoadAssemblyContext(Assembly assembly, IDependencyContextReader reader)
  {
  using (Stream stream = GetResourceStream(assembly, assembly.GetName().Name + DepsJsonExtension))
@@ -125,6 +128,7 @@ private DependencyContext LoadAssemblyContext(Assembly assembly, IDependencyCont
  return null;
  }
 
+ [RequiresAssemblyFiles (Message = "Needs additional support for reading .deps.json in single file", Url = "https://github.com/dotnet/runtime/issues/41265")]
  private string GetDepsJsonPath(Assembly assembly)
  {
  // Assemblies loaded in memory (e.g. single file) return empty string from Location.

src/libraries/Microsoft.Extensions.DependencyModel/src/Microsoft.Extensions.DependencyModel.csproj

@@ -30,4 +30,8 @@
  <ProjectReference Include="$(LibrariesProjectRoot)System.Text.Json\src\System.Text.Json.csproj" />
  </ItemGroup>
 
+ <ItemGroup Condition="'$(TargetFramework)' != '$(NetCoreAppCurrent)'">
+ <Compile Include="$(CoreLibSharedDir)System\Diagnostics\CodeAnalysis\RequiresAssemblyFilesAttribute.cs" />
+ </ItemGroup>
+
 </Project>

src/libraries/Microsoft.NETCore.Platforms/src/AssemblyResolver.cs

@@ -38,7 +38,10 @@ private static Assembly CurrentDomain_AssemblyResolve(object sender, ResolveEven
  Assembly assm = null;
 
  // look next to requesting assembly
+ // The code has a fallback to use AppDomain.CurrentDomain.BaseDirectory so is not single file dangerous
+#pragma warning disable IL3000 // Avoid accessing Assembly file path when publishing as a single file
  assemblyPath = args.RequestingAssembly?.Location;
+#pragma warning restore IL3000 // Avoid accessing Assembly file path when publishing as a single file
  if (!string.IsNullOrEmpty(assemblyPath))
  {
  probingPath = Path.Combine(Path.GetDirectoryName(assemblyPath), fileName);
@@ -50,7 +53,10 @@ private static Assembly CurrentDomain_AssemblyResolve(object sender, ResolveEven
  }
 
  // look next to the executing assembly
+ // The code has a fallback to use AppDomain.CurrentDomain.BaseDirectory so is not single file dangerous
+#pragma warning disable IL3000 // Avoid accessing Assembly file path when publishing as a single file
  assemblyPath = Assembly.GetExecutingAssembly().Location;
+#pragma warning restore IL3000 // Avoid accessing Assembly file path when publishing as a single file
  if (!string.IsNullOrEmpty(assemblyPath))
  {
  probingPath = Path.Combine(Path.GetDirectoryName(assemblyPath), fileName);

src/libraries/Microsoft.XmlSerializer.Generator/src/Sgen.cs

@@ -293,14 +293,23 @@ private void GenerateFile(List<string> typeNames, string assemblyName, bool prox
  ImportType(type, mappings, importedTypes, warnings, importer, parsableerrors);
  }
  }
+ // Only used in diagnostics
+#pragma warning disable IL3000 // Avoid accessing Assembly file path when publishing as a single file
+ string nameOrLocation = assembly.Location;
+#pragma warning restore IL3000 // Avoid accessing Assembly file path when publishing as a single file
+ if (nameOrLocation == string.Empty)
+ nameOrLocation = assembly.FullName;
 
  if (importedTypes.Count > 0)
  {
  var serializableTypes = (Type[])importedTypes.ToArray(typeof(Type));
  var allMappings = (XmlMapping[])mappings.ToArray(typeof(XmlMapping));
 
  bool gac = assembly.GlobalAssemblyCache;
- outputDirectory = outputDirectory == null ? (gac ? Environment.CurrentDirectory : Path.GetDirectoryName(assembly.Location)) : outputDirectory;
+ // Code has a fallback in case the location is null
+#pragma warning disable IL3000 // Avoid accessing Assembly file path when publishing as a single file
+ outputDirectory = outputDirectory == null ? (gac ? Environment.CurrentDirectory : Path.GetDirectoryName(assembly.Location)) : outputDirectory;
+#pragma warning restore IL3000 // Avoid accessing Assembly file path when publishing as a single file
 
  if (!Directory.Exists(outputDirectory))
  {
@@ -369,17 +378,17 @@ private void GenerateFile(List<string> typeNames, string assemblyName, bool prox
  if (!silent)
  {
  Console.Out.WriteLine(SR.Format(SR.InfoFileName, codePath));
- Console.Out.WriteLine(SR.Format(SR.InfoGeneratedFile, assembly.Location, codePath));
+ Console.Out.WriteLine(SR.Format(SR.InfoGeneratedFile, nameOrLocation, codePath));
  }
  }
  else
  {
- Console.Out.WriteLine(FormatMessage(parsableerrors, false, SR.Format(SR.ErrGenerationFailed, assembly.Location)));
+ Console.Out.WriteLine(FormatMessage(parsableerrors, false, SR.Format(SR.ErrGenerationFailed, nameOrLocation)));
  }
  }
  else
  {
- Console.Out.WriteLine(FormatMessage(parsableerrors, true, SR.Format(SR.InfoNoSerializableTypes, assembly.Location)));
+ Console.Out.WriteLine(FormatMessage(parsableerrors, true, SR.Format(SR.InfoNoSerializableTypes, nameOrLocation)));
  }
  }
 

src/libraries/System.ComponentModel.Composition/src/System/ComponentModel/Composition/Hosting/AssemblyCatalog.cs

@@ -556,7 +556,10 @@ private static Assembly LoadAssembly(string codeBase)
  catch (ArgumentException)
  {
  assemblyName = new AssemblyName();
+ // Setting a CodeBase is not single-file dangerous
+#pragma warning disable IL3000 // Avoid accessing Assembly file path when publishing as a single file
  assemblyName.CodeBase = codeBase;
+#pragma warning restore IL3000 // Avoid accessing Assembly file path when publishing as a single file
  }
 
  try

src/libraries/System.ComponentModel.TypeConverter/src/System/ComponentModel/Design/DesigntimeLicenseContext.cs

@@ -78,7 +78,10 @@ public override string GetSavedLicenseKey(Type type, Assembly resourceAssembly)
  foreach (Assembly asm in AppDomain.CurrentDomain.GetAssemblies())
  {
  // Assemblies loaded in memory return empty string from Location.
+ // Suppressing the warning until gets fixed, see https://github.com/dotnet/runtime/issues/50821
+#pragma warning disable IL3000 // Avoid accessing Assembly file path when publishing as a single file
  string location = asm.Location;
+#pragma warning restore IL3000 // Avoid accessing Assembly file path when publishing as a single file
  if (location == string.Empty)
  continue;
 
@@ -101,7 +104,10 @@ public override string GetSavedLicenseKey(Type type, Assembly resourceAssembly)
  }
  else
  {
+ // Suppressing the warning until gets fixed, see https://github.com/dotnet/runtime/issues/50821
+#pragma warning disable IL3000 // Avoid accessing Assembly file path when publishing as a single file
  string location = resourceAssembly.Location;
+#pragma warning restore IL3000 // Avoid accessing Assembly file path when publishing as a single file
  if (location != string.Empty)
  {
  string fileName = Path.GetFileName(location);

src/libraries/System.Configuration.ConfigurationManager/src/System/Configuration/ClientConfigPaths.cs

@@ -50,7 +50,9 @@ private ClientConfigPaths(string exePath, bool includeUserConfig)
  exeAssembly = Assembly.GetEntryAssembly();
 
  // in case of SingleFile deployment, Assembly.Location is empty.
+#pragma warning disable IL3000 // Avoid accessing Assembly file path when publishing as a single file
  if (exeAssembly?.Location.Length == 0)
+#pragma warning restore IL3000 // Avoid accessing Assembly file path when publishing as a single file
  {
  isSingleFile = true;
  HasEntryAssembly = true;

src/libraries/System.Diagnostics.EventLog/src/System/Diagnostics/EventLog.cs

@@ -698,7 +698,10 @@ internal static string GetDllPath(string machineName)
  if (machineName == "." && !File.Exists(dllPath))
  {
  // use this assembly directory
+ // The code handles if the path is null by calling AppContext.BaseDirectory
+#pragma warning disable IL3000 // Avoid accessing Assembly file path when publishing as a single file
  string assmLocation = typeof(EventLog).Assembly.Location;
+#pragma warning restore IL3000 // Avoid accessing Assembly file path when publishing as a single file
  if (!string.IsNullOrEmpty(assmLocation))
  {
  dllPath = Path.Combine(Path.GetDirectoryName(assmLocation), AltDllName);

src/libraries/System.Private.CoreLib/src/System/AppContext.AnyOS.cs

@@ -14,7 +14,10 @@ private static string GetBaseDirectoryCore()
 #if CORERT
  string? path = Environment.ProcessPath;
 #else
+ // Single File apps should always set APP_CONTEXT_BASE_DIRECTORY therefore code handles Assembly.Location equals null
+#pragma warning disable IL3000 // Avoid accessing Assembly file path when publishing as a single file
  string? path = Assembly.GetEntryAssembly()?.Location;
+#pragma warning restore IL3000 // Avoid accessing Assembly file path when publishing as a single file
 #endif
 
  string? directory = Path.GetDirectoryName(path);

src/libraries/System.Private.CoreLib/src/System/Diagnostics/CodeAnalysis/RequiresAssemblyFilesAttribute.cs

@@ -12,7 +12,12 @@ namespace System.Diagnostics.CodeAnalysis
  AttributeTargets.Property,
  Inherited = false,
  AllowMultiple = false)]
- public sealed class RequiresAssemblyFilesAttribute : Attribute
+#if SYSTEM_PRIVATE_CORELIB
+ public
+#else
+ internal
+#endif
+ sealed class RequiresAssemblyFilesAttribute : Attribute
  {
  /// <summary>
  /// Initializes a new instance of the <see cref="RequiresAssemblyFilesAttribute"/> class.
@@ -32,4 +37,4 @@ public RequiresAssemblyFilesAttribute() { }
  /// </summary>
  public string? Url { get; set; }
  }
-}
+}

src/libraries/System.Private.CoreLib/src/System/Reflection/Assembly.cs

@@ -115,6 +115,7 @@ public virtual IEnumerable<Type> ExportedTypes
  public virtual object[] GetCustomAttributes(bool inherit) { throw NotImplemented.ByDesign; }
  public virtual object[] GetCustomAttributes(Type attributeType, bool inherit) { throw NotImplemented.ByDesign; }
 
+ [RequiresAssemblyFiles(Message = "Calls 'AssemblyName.EscapeCodeBase(string)' which is a dangerous single file pattern")]
  public virtual string EscapedCodeBase => AssemblyName.EscapeCodeBase(CodeBase);
 
  [RequiresUnreferencedCode("Assembly.CreateInstance is not supported with trimming. Use Type.GetType instead.")]
@@ -152,6 +153,7 @@ public virtual IEnumerable<Type> ExportedTypes
  public virtual Assembly GetSatelliteAssembly(CultureInfo culture, Version? version) { throw NotImplemented.ByDesign; }
 
  public virtual FileStream? GetFile(string name) { throw NotImplemented.ByDesign; }
+ [RequiresAssemblyFiles(Message = "'System.Reflection.Assembly.GetFiles(bool)' will throw for assemblies embedded in a single-file app", Url = "https://docs.microsoft.com/en-us/dotnet/fundamentals/code-analysis/quality-rules/il3001")]
  public virtual FileStream[] GetFiles() => GetFiles(getResourceModules: false);
  public virtual FileStream[] GetFiles(bool getResourceModules) { throw NotImplemented.ByDesign; }
 
@@ -268,6 +270,7 @@ public static Assembly LoadFile(string path)
  }
 
  [RequiresUnreferencedCode("Types and members the loaded assembly depends on might be removed")]
+ [RequiresAssemblyFiles (Message = "Calling 'System.Reflection.Assembly.LoadFromResolveHandler' will return a null assembly for assemblies embedded in a single-file app")]
  private static Assembly? LoadFromResolveHandler(object? sender, ResolveEventArgs args)
  {
  Assembly? requestingAssembly = args.RequestingAssembly;

src/libraries/System.Private.CoreLib/src/System/Reflection/AssemblyName.cs

@@ -2,6 +2,7 @@
 // The .NET Foundation licenses this file to you under the MIT license.
 
 using System.Configuration.Assemblies;
+using System.Diagnostics.CodeAnalysis;
 using System.Runtime.Serialization;
 using System.Text;
 using CultureInfo = System.Globalization.CultureInfo;
@@ -59,12 +60,14 @@ public string? CultureName
  set => _cultureInfo = (value == null) ? null : new CultureInfo(value);
  }
 
+ [RequiresAssemblyFiles (Message = "'System.Reflection.AssemblyName.CodeBase' always returns an empty string for assemblies embedded in a single-file app. If the path to the app directory is needed, consider calling 'System.AppContext.BaseDirectory'", Url = "https://docs.microsoft.com/en-us/dotnet/fundamentals/code-analysis/quality-rules/il3000")]
  public string? CodeBase
  {
  get => _codeBase;
  set => _codeBase = value;
  }
 
+ [RequiresAssemblyFiles (Message = "'System.Reflection.AssemblyName.EscapedCodeBase' always returns an empty string for assemblies embedded in a single-file app. If the path to the app directory is needed, consider calling 'System.AppContext.BaseDirectory'", Url = "https://docs.microsoft.com/en-us/dotnet/fundamentals/code-analysis/quality-rules/il3000")]
  public string? EscapedCodeBase
  {
  get

src/libraries/System.Private.CoreLib/src/System/Runtime/Loader/AssemblyLoadContext.cs

@@ -629,7 +629,10 @@ public void Dispose()
  handler.Method.Name,
  this != AssemblyLoadContext.Default ? ToString() : Name,
  resolvedAssembly?.FullName,
+ // This call is fine because the code handles the Assembly.Location equals null
+#pragma warning disable IL3000 // Avoid accessing Assembly file path when publishing as a single file
  resolvedAssembly != null && !resolvedAssembly.IsDynamic ? resolvedAssembly.Location : null);
+#pragma warning restore IL3000 // Avoid accessing Assembly file path when publishing as a single file
  }
 #endif // CORECLR
  if (resolvedAssembly != null)
@@ -738,7 +741,10 @@ private static void OnAssemblyLoad(RuntimeAssembly assembly)
  name,
  handler.Method.Name,
  asm?.FullName,
+ // This call is fine because the code handles the Assembly.Location equals null
+#pragma warning disable IL3000 // Avoid accessing Assembly file path when publishing as a single file
  asm != null && !asm.IsDynamic ? asm.Location : null);
+#pragma warning restore IL3000 // Avoid accessing Assembly file path when publishing as a single file
  }
 #endif // CORECLR
  RuntimeAssembly? ret = GetRuntimeAssembly(asm);
@@ -768,7 +774,10 @@ private static void OnAssemblyLoad(RuntimeAssembly assembly)
 
  AssemblyLoadContext parentALC = GetLoadContext(parentAssembly)!;
 
+ // This call is fine because native call runs before this and checks BindSatelliteResourceFromBundle
+#pragma warning disable IL3000 // Avoid accessing Assembly file path when publishing as a single file
  string? parentDirectory = Path.GetDirectoryName(parentAssembly.Location);
+#pragma warning restore IL3000 // Avoid accessing Assembly file path when publishing as a single file
  if (parentDirectory == null)
  return null;