Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ILC: Allow OOB reference to upgrade framework assembly #109988

Merged
merged 2 commits into from
Nov 21, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
using Microsoft.Build.Utilities;
using System;
using System.Collections.Generic;
using System.Diagnostics;
using System.IO;
using System.Reflection.Metadata;
using System.Reflection.PortableExecutable;
Expand Down Expand Up @@ -99,16 +100,20 @@ public override bool Execute()
var list = new List<ITaskItem>();
var assembliesToSkipPublish = new List<ITaskItem>();
var satelliteAssemblies = new List<ITaskItem>();
var nativeAotFrameworkAssembliesToUse = new HashSet<string>();
var nativeAotFrameworkAssembliesToUse = new Dictionary<string, ITaskItem>();
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this use OrdinalIgnoreCase like some of the other path comparisons below? Or are the filenames guaranteed to have some sort of normalized casing?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think it is needed since the comparison is done on file names which should use consistent casing between the framework and OOB packages. I tried breaking it by using Reference with casing that doesn't match the filename:

<Reference Include="C:\path\to\.nuget\packages\system.diagnostics.diagnosticsource\9.0.0\lib\net8.0\system.diagnostics.diagnosticsource.dll" />

but this breaks the build before we get to ILC (tried on windows and linux).


foreach (ITaskItem taskItem in SdkAssemblies)
{
nativeAotFrameworkAssembliesToUse.Add(Path.GetFileName(taskItem.ItemSpec));
var fileName = Path.GetFileName(taskItem.ItemSpec);
if (!nativeAotFrameworkAssembliesToUse.ContainsKey(fileName))
nativeAotFrameworkAssembliesToUse.Add(fileName, taskItem);
}

foreach (ITaskItem taskItem in FrameworkAssemblies)
{
nativeAotFrameworkAssembliesToUse.Add(Path.GetFileName(taskItem.ItemSpec));
var fileName = Path.GetFileName(taskItem.ItemSpec);
if (!nativeAotFrameworkAssembliesToUse.ContainsKey(fileName))
nativeAotFrameworkAssembliesToUse.Add(fileName, taskItem);
}

foreach (ITaskItem taskItem in Assemblies)
Expand Down Expand Up @@ -153,8 +158,21 @@ public override bool Execute()

// Remove any assemblies whose implementation we want to come from NativeAOT's package.
// Currently that's System.Private.* SDK assemblies and a bunch of framework assemblies.
if (nativeAotFrameworkAssembliesToUse.Contains(assemblyFileName))
if (nativeAotFrameworkAssembliesToUse.TryGetValue(assemblyFileName, out ITaskItem frameworkItem))
{
if (GetFileVersion(itemSpec).CompareTo(GetFileVersion(frameworkItem.ItemSpec)) > 0)
{
if (assemblyFileName == "System.Private.CoreLib.dll")
{
Log.LogError($"Overriding System.Private.CoreLib.dll with a newer version is not supported. Attempted to use {itemSpec} instead of {frameworkItem.ItemSpec}.");
}
else
{
// Allow OOB references with higher version to take precedence over the framework assemblies.
list.Add(taskItem);
}
}

assembliesToSkipPublish.Add(taskItem);
continue;
}
Expand Down Expand Up @@ -196,6 +214,12 @@ public override bool Execute()
SatelliteAssemblies = satelliteAssemblies.ToArray();

return true;

static Version GetFileVersion(string path)
{
var versionInfo = FileVersionInfo.GetVersionInfo(path);
return new Version(versionInfo.FileMajorPart, versionInfo.FileMinorPart, versionInfo.FileBuildPart, versionInfo.FilePrivatePart);
}
}
}
}