Implement resource lookup in satellite assemblies (#86689)

MichalStrehovsky · web-flow · commit b134fa28352e · 2023-05-30T08:58:32.000+09:00
Fixes #86651. This was implemented in .NET Native so we just need to resurface it from the compiler. Note that this is not full support for satellite assemblies (in the assembly binder, etc.) that never existed and nobody ever asked for and I don't even know what it entails.
diff --git a/src/coreclr/nativeaot/BuildIntegration/Microsoft.NETCore.Native.Publish.targets b/src/coreclr/nativeaot/BuildIntegration/Microsoft.NETCore.Native.Publish.targets
@@ -5,6 +5,8 @@
           DependsOnTargets="$(IlcDynamicBuildPropertyDependencies)">
     <ItemGroup>
       <IlcReference Include="@(_ManagedResolvedAssembliesToPublish)" />
+      <IlcSatelliteAssembly Include="@(_SatelliteAssembliesToPublish)" />
+      <IlcSatelliteAssembly Include="@(IntermediateSatelliteAssembliesWithTargetPath)" />
     </ItemGroup>
   </Target>
 
@@ -82,6 +84,7 @@
       FrameworkAssemblies="@(FrameworkAssemblies)">
 
       <Output TaskParameter="ManagedAssemblies" ItemName="_ManagedResolvedAssembliesToPublish" />
+      <Output TaskParameter="SatelliteAssemblies" ItemName="_SatelliteAssembliesToPublish" />
       <Output TaskParameter="AssembliesToSkipPublish" ItemName="_AssembliesToSkipPublish" />
     </ComputeManagedAssembliesToCompileToNative>
 
diff --git a/src/coreclr/nativeaot/BuildIntegration/Microsoft.NETCore.Native.targets b/src/coreclr/nativeaot/BuildIntegration/Microsoft.NETCore.Native.targets
@@ -194,6 +194,7 @@ The .NET Foundation licenses this file to you under the MIT license.
       <IlcArg Include="@(IlcCompileInput)" />
       <IlcArg Include="-o:$(NativeIntermediateOutputPath)%(ManagedBinary.Filename)$(IlcOutputFileExt)" />
       <IlcArg Include="@(IlcReference->'-r:%(Identity)')" />
+      <IlcArg Include="@(IlcSatelliteAssembly->'--satellite:%(Identity)')" />
       <IlcArg Include="@(MibcFile->'--mibc:%(Identity)')" />
       <IlcArg Condition="$(IlcGenerateMetadataLog) == 'true'" Include="--metadatalog:$(NativeIntermediateOutputPath)%(ManagedBinary.Filename).metadata.csv" />
       <IlcArg Condition="$(_targetOS) != ''" Include="--targetos:$(_targetOS)" />
@@ -262,7 +263,7 @@ The .NET Foundation licenses this file to you under the MIT license.
   </Target>
 
   <Target Name="IlcCompile"
-      Inputs="@(IlcCompileInput);@(IlcReference);@(RdXmlFile);%(ManagedBinary.IlcRspFile)"
+      Inputs="@(IlcCompileInput);@(IlcReference);@(IlcSatelliteAssembly);@(RdXmlFile);%(ManagedBinary.IlcRspFile)"
       Outputs="%(ManagedBinary.IlcOutputFile)"
       DependsOnTargets="WriteIlcRspFileForCompilation;$(IlcCompileDependsOn)">
     <Message Text="Generating native code" Importance="high" />
diff --git a/src/coreclr/tools/aot/ILCompiler.Build.Tasks/ComputeManagedAssembliesToCompileToNative.cs b/src/coreclr/tools/aot/ILCompiler.Build.Tasks/ComputeManagedAssembliesToCompileToNative.cs
@@ -80,6 +80,13 @@ public ITaskItem[] ManagedAssemblies
             set;
         }
 
+        [Output]
+        public ITaskItem[] SatelliteAssemblies
+        {
+            get;
+            set;
+        }
+
         [Output]
         public ITaskItem[] AssembliesToSkipPublish
         {
@@ -91,6 +98,7 @@ public override bool Execute()
         {
             var list = new List<ITaskItem>();
             var assembliesToSkipPublish = new List<ITaskItem>();
+            var satelliteAssemblies = new List<ITaskItem>();
             var nativeAotFrameworkAssembliesToUse = new HashSet<string>();
 
             foreach (ITaskItem taskItem in SdkAssemblies)
@@ -164,11 +172,16 @@ public override bool Execute()
                                 string culture = moduleMetadataReader.GetString(moduleMetadataReader.GetAssemblyDefinition().Culture);
 
                                 assembliesToSkipPublish.Add(taskItem);
+
+                                // Split satellite assemblies from normal assemblies
                                 if (culture == "" || culture.Equals("neutral", StringComparison.OrdinalIgnoreCase))
                                 {
-                                    // NativeAOT doesn't consume resource assemblies yet so skip them
                                     list.Add(taskItem);
                                 }
+                                else
+                                {
+                                    satelliteAssemblies.Add(taskItem);
+                                }
                             }
                         }
                     }
@@ -180,6 +193,7 @@ public override bool Execute()
 
             ManagedAssemblies = list.ToArray();
             AssembliesToSkipPublish = assembliesToSkipPublish.ToArray();
+            SatelliteAssemblies = satelliteAssemblies.ToArray();
 
             return true;
         }
diff --git a/src/coreclr/tools/aot/ILCompiler.Compiler.Tests/DependencyGraphTests.cs b/src/coreclr/tools/aot/ILCompiler.Compiler.Tests/DependencyGraphTests.cs
@@ -73,7 +73,7 @@ public void TestDependencyGraphInvariants(EcmaMethod method)
                 new FullyBlockedMetadataBlockingPolicy(), new FullyBlockedManifestResourceBlockingPolicy(),
                 null, new NoStackTraceEmissionPolicy(), new NoDynamicInvokeThunkGenerationPolicy(),
                 new ILLink.Shared.TrimAnalysis.FlowAnnotations(Logger.Null, ilProvider, compilerGeneratedState), UsageBasedMetadataGenerationOptions.None,
-                default, Logger.Null, Array.Empty<KeyValuePair<string, bool>>(), Array.Empty<string>(), Array.Empty<string>(), Array.Empty<string>());
+                default, Logger.Null, Array.Empty<KeyValuePair<string, bool>>(), Array.Empty<string>(), Array.Empty<string>(), Array.Empty<string>(), Array.Empty<string>());
 
             CompilationBuilder builder = new RyuJitCompilationBuilder(context, compilationGroup)
                 .UseILProvider(ilProvider);
diff --git a/src/coreclr/tools/aot/ILCompiler.Compiler/Compiler/DependencyAnalysis/ModuleMetadataNode.cs b/src/coreclr/tools/aot/ILCompiler.Compiler/Compiler/DependencyAnalysis/ModuleMetadataNode.cs
@@ -44,7 +44,14 @@ public override IEnumerable<DependencyListEntry> GetStaticDependencies(NodeFacto
                 dependencies.Add(factory.ReflectedMethod(entrypoint), "Reflectable entrypoint");
             }
 
-            CustomAttributeBasedDependencyAlgorithm.AddDependenciesDueToCustomAttributes(ref dependencies, factory, (EcmaAssembly)_module);
+            EcmaAssembly ecmaAssembly = (EcmaAssembly)_module;
+
+            CustomAttributeBasedDependencyAlgorithm.AddDependenciesDueToCustomAttributes(ref dependencies, factory, ecmaAssembly);
+
+            foreach (EcmaModule satelliteModule in ((UsageBasedMetadataManager)factory.MetadataManager).GetSatelliteAssemblies(ecmaAssembly))
+            {
+                dependencies.Add(factory.ModuleMetadata(satelliteModule), "Satellite assembly");
+            }
 
             return dependencies;
         }
diff --git a/src/coreclr/tools/aot/ILCompiler.Compiler/Compiler/UsageBasedMetadataManager.cs b/src/coreclr/tools/aot/ILCompiler.Compiler/Compiler/UsageBasedMetadataManager.cs
@@ -63,6 +63,7 @@ private static (string AttributeName, DiagnosticId Id)[] _requiresAttributeMisma
 
         private readonly HashSet<string> _rootEntireAssembliesModules;
         private readonly HashSet<string> _trimmedAssemblies;
+        private readonly List<string> _satelliteAssemblyFiles;
 
         internal FlowAnnotations FlowAnnotations { get; }
 
@@ -83,7 +84,8 @@ public UsageBasedMetadataManager(
             IEnumerable<KeyValuePair<string, bool>> featureSwitchValues,
             IEnumerable<string> rootEntireAssembliesModules,
             IEnumerable<string> additionalRootedAssemblies,
-            IEnumerable<string> trimmedAssemblies)
+            IEnumerable<string> trimmedAssemblies,
+            IEnumerable<string> satelliteAssemblyFilePaths)
             : base(typeSystemContext, blockingPolicy, resourceBlockingPolicy, logFile, stackTracePolicy, invokeThunkGenerationPolicy, options)
         {
             _compilationModuleGroup = group;
@@ -98,6 +100,20 @@ public UsageBasedMetadataManager(
             _rootEntireAssembliesModules = new HashSet<string>(rootEntireAssembliesModules);
             _rootEntireAssembliesModules.UnionWith(additionalRootedAssemblies);
             _trimmedAssemblies = new HashSet<string>(trimmedAssemblies);
+            _satelliteAssemblyFiles = new List<string>(satelliteAssemblyFilePaths);
+        }
+
+        public IEnumerable<EcmaModule> GetSatelliteAssemblies(EcmaAssembly module)
+        {
+            string expectedSimpleName = module.GetName().Name + ".resources";
+            foreach (string filePath in _satelliteAssemblyFiles)
+            {
+                string simpleName = Path.GetFileNameWithoutExtension(filePath);
+                if (simpleName == expectedSimpleName)
+                {
+                    yield return _typeSystemContext.GetMetadataOnlyModuleFromPath(filePath);
+                }
+            }
         }
 
         protected override void Graph_NewMarkedNode(DependencyNodeCore<NodeFactory> obj)
diff --git a/src/coreclr/tools/aot/ILCompiler/ILCompiler.props b/src/coreclr/tools/aot/ILCompiler/ILCompiler.props
@@ -15,7 +15,6 @@
     <ServerGarbageCollection>true</ServerGarbageCollection>
     <TieredCompilation>false</TieredCompilation>
     <EventSourceSupport>true</EventSourceSupport>
-    <InvariantGlobalization>true</InvariantGlobalization>
     <OptimizationPreference>Speed</OptimizationPreference>
   </PropertyGroup>
 
diff --git a/src/coreclr/tools/aot/ILCompiler/ILCompilerRootCommand.cs b/src/coreclr/tools/aot/ILCompiler/ILCompilerRootCommand.cs
@@ -28,6 +28,8 @@ internal sealed class ILCompilerRootCommand : RootCommand
             new(new[] { "--optimize-time", "--Ot" }, "Enable optimizations, favor code speed");
         public Option<string[]> MibcFilePaths { get; } =
             new(new[] { "--mibc", "-m" }, Array.Empty<string>, "Mibc file(s) for profile guided optimization");
+        public Option<string[]> SatelliteFilePaths { get; } =
+            new(new[] { "--satellite" }, Array.Empty<string>, "Satellite assemblies associated with inputs/references");
         public Option<bool> EnableDebugInfo { get; } =
             new(new[] { "--debug", "-g" }, "Emit debugging information");
         public Option<bool> UseDwarf5 { get; } =
@@ -173,6 +175,7 @@ public ILCompilerRootCommand(string[] args) : base(".NET Native IL Compiler")
             AddOption(OptimizeSpace);
             AddOption(OptimizeTime);
             AddOption(MibcFilePaths);
+            AddOption(SatelliteFilePaths);
             AddOption(EnableDebugInfo);
             AddOption(UseDwarf5);
             AddOption(NativeLib);
diff --git a/src/coreclr/tools/aot/ILCompiler/Program.cs b/src/coreclr/tools/aot/ILCompiler/Program.cs
@@ -391,7 +391,8 @@ public int Run()
                     featureSwitches,
                     Get(_command.ConditionallyRootedAssemblies),
                     rootedAssemblies,
-                    Get(_command.TrimmedAssemblies));
+                    Get(_command.TrimmedAssemblies),
+                    Get(_command.SatelliteFilePaths));
 
             InteropStateManager interopStateManager = new InteropStateManager(typeSystemContext.GeneratedAssembly);
             InteropStubManager interopStubManager = new UsageBasedInteropStubManager(interopStateManager, pinvokePolicy, logger);
diff --git a/src/coreclr/tools/aot/Mono.Linker.Tests/TestCasesRunner/ILCompilerDriver.cs b/src/coreclr/tools/aot/Mono.Linker.Tests/TestCasesRunner/ILCompilerDriver.cs
@@ -111,7 +111,8 @@ public ILScanResults Trim (ILCompilerOptions options, ILogWriter logWriter)
 				Array.Empty<KeyValuePair<string, bool>> (),
 				Array.Empty<string> (),
 				options.AdditionalRootAssemblies.ToArray (),
-				options.TrimAssemblies.ToArray ());
+				options.TrimAssemblies.ToArray (),
+				Array.Empty<string> ());
 
 			PInvokeILEmitterConfiguration pinvokePolicy = new ILCompilerTestPInvokePolicy ();
 			InteropStateManager interopStateManager = new InteropStateManager (typeSystemContext.GeneratedAssembly);
diff --git a/src/coreclr/tools/aot/crossgen2/crossgen2.props b/src/coreclr/tools/aot/crossgen2/crossgen2.props
@@ -15,7 +15,6 @@
     <Configurations>Debug;Release;Checked</Configurations>
     <ServerGarbageCollection>true</ServerGarbageCollection>
     <EventSourceSupport>true</EventSourceSupport>
-    <InvariantGlobalization>true</InvariantGlobalization>
     <OptimizationPreference>Speed</OptimizationPreference>
     <RunAnalyzers>false</RunAnalyzers>
   </PropertyGroup>
diff --git a/src/libraries/System.Resources.ResourceManager/tests/ResourceManagerTests.cs b/src/libraries/System.Resources.ResourceManager/tests/ResourceManagerTests.cs
@@ -87,7 +87,6 @@ public static IEnumerable<object[]> CultureResourceData()
 
         [Theory]
         [MemberData(nameof(CultureResourceData))]
-        [ActiveIssue("https://github.com/dotnet/runtimelab/issues/155", typeof(PlatformDetection), nameof(PlatformDetection.IsNativeAot))] // satellite assemblies
         public static void GetString_CultureFallback(string key, string cultureName, string expectedValue)
         {
             Type resourceType = typeof(Resources.TestResx);
@@ -98,7 +97,6 @@ public static void GetString_CultureFallback(string key, string cultureName, str
         }
 
         [Fact]
-        [ActiveIssue("https://github.com/dotnet/runtimelab/issues/155", typeof(PlatformDetection), nameof(PlatformDetection.IsNativeAot))] //satellite assemblies
         public static void GetString_FromTestClassWithoutNeutralResources()
         {
             // This test is designed to complement the GetString_FromCulutureAndResourceType "fr" & "fr-CA" cases

Original file line number	Diff line number	Diff line change
`@@ -80,6 +80,13 @@ public ITaskItem[] ManagedAssemblies`
`80`	`80`	`set;`
`81`	`81`	`}`
`82`	`82`
	`83`	`+ [Output]`
	`84`	`+ public ITaskItem[] SatelliteAssemblies`
	`85`	`+ {`
	`86`	`+ get;`
	`87`	`+ set;`
	`88`	`+ }`
	`89`	`+`
`83`	`90`	`[Output]`
`84`	`91`	`public ITaskItem[] AssembliesToSkipPublish`
`85`	`92`	`{`
`@@ -91,6 +98,7 @@ public override bool Execute()`
`91`	`98`	`{`
`92`	`99`	`var list = new List<ITaskItem>();`
`93`	`100`	`var assembliesToSkipPublish = new List<ITaskItem>();`
	`101`	`+ var satelliteAssemblies = new List<ITaskItem>();`
`94`	`102`	`var nativeAotFrameworkAssembliesToUse = new HashSet<string>();`
`95`	`103`
`96`	`104`	`foreach (ITaskItem taskItem in SdkAssemblies)`
`@@ -164,11 +172,16 @@ public override bool Execute()`
`164`	`172`	`string culture = moduleMetadataReader.GetString(moduleMetadataReader.GetAssemblyDefinition().Culture);`
`165`	`173`
`166`	`174`	`assembliesToSkipPublish.Add(taskItem);`
	`175`	`+`
	`176`	`+ // Split satellite assemblies from normal assemblies`
`167`	`177`	`if (culture == "" \|\| culture.Equals("neutral", StringComparison.OrdinalIgnoreCase))`
`168`	`178`	`{`
`169`		`- // NativeAOT doesn't consume resource assemblies yet so skip them`
`170`	`179`	`list.Add(taskItem);`
`171`	`180`	`}`
	`181`	`+ else`
	`182`	`+ {`
	`183`	`+ satelliteAssemblies.Add(taskItem);`
	`184`	`+ }`
`172`	`185`	`}`
`173`	`186`	`}`
`174`	`187`	`}`
`@@ -180,6 +193,7 @@ public override bool Execute()`
`180`	`193`
`181`	`194`	`ManagedAssemblies = list.ToArray();`
`182`	`195`	`AssembliesToSkipPublish = assembliesToSkipPublish.ToArray();`
	`196`	`+ SatelliteAssemblies = satelliteAssemblies.ToArray();`
`183`	`197`
`184`	`198`	`return true;`
`185`	`199`	`}`
Original file line number	Diff line number	Diff line change
`@@ -44,7 +44,14 @@ public override IEnumerable<DependencyListEntry> GetStaticDependencies(NodeFacto`
`44`	`44`	`dependencies.Add(factory.ReflectedMethod(entrypoint), "Reflectable entrypoint");`
`45`	`45`	`}`
`46`	`46`
`47`		`- CustomAttributeBasedDependencyAlgorithm.AddDependenciesDueToCustomAttributes(ref dependencies, factory, (EcmaAssembly)_module);`
	`47`	`+ EcmaAssembly ecmaAssembly = (EcmaAssembly)_module;`
	`48`	`+`
	`49`	`+ CustomAttributeBasedDependencyAlgorithm.AddDependenciesDueToCustomAttributes(ref dependencies, factory, ecmaAssembly);`
	`50`	`+`
	`51`	`+ foreach (EcmaModule satelliteModule in ((UsageBasedMetadataManager)factory.MetadataManager).GetSatelliteAssemblies(ecmaAssembly))`
	`52`	`+ {`
	`53`	`+ dependencies.Add(factory.ModuleMetadata(satelliteModule), "Satellite assembly");`
	`54`	`+ }`
`48`	`55`
`49`	`56`	`return dependencies;`
`50`	`57`	`}`