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.

Sign up for GitHub

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

Improve AssemblySymbolLoader logging #46102

Merged
merged 1 commit into from
Jan 20, 2025
Merged

Improve AssemblySymbolLoader logging #46102

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
63 changes: 42 additions & 21 deletions src/Compatibility/Microsoft.DotNet.ApiSymbolExtensions/AssemblySymbolLoader.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,8 @@ public void AddReferenceSearchPaths(params string[] paths)
/// <inheritdoc />
public IReadOnlyList<IAssemblySymbol?> LoadAssemblies(params string[] paths)
{
_log.LogMessage(MessageImportance.Low, string.Format(Resources.LoadingAssemblies, string.Join(", ", paths)));

// First resolve all assemblies that are passed in and create metadata references out of them.
// Reference assemblies of the passed in assemblies that themselves are passed in, will be skipped to be resolved,
// as they are resolved as part of the loop below.
Expand All @@ -119,6 +121,8 @@ public void AddReferenceSearchPaths(params string[] paths)
/// <inheritdoc />
public IReadOnlyList<IAssemblySymbol?> LoadAssembliesFromArchive(string archivePath, IReadOnlyList<string> relativePaths)
{
_log.LogMessage(MessageImportance.Low, string.Format(Resources.LoadingAssembliesFromArchive, string.Join(", ", relativePaths), archivePath));

using FileStream stream = File.OpenRead(archivePath);
using ZipArchive zipFile = new(stream);

Expand All @@ -144,7 +148,8 @@ public void AddReferenceSearchPaths(params string[] paths)
string name = Path.GetFileName(relativePaths[i]);
if (!_loadedAssemblies.TryGetValue(name, out MetadataReference? metadataReference))
{
metadataReference = CreateAndAddReferenceToCompilation(name, memoryStream, fileNames);
string rootAssemblyDisplayString = string.Format(Resources.RootAssemblyFromPackageDisplayString, relativePaths[i], archivePath);
metadataReference = CreateAndAddReferenceToCompilation(name, rootAssemblyDisplayString, memoryStream, fileNames);
}

metadataReferences[i] = metadataReference;
Expand All @@ -170,6 +175,8 @@ public void AddReferenceSearchPaths(params string[] paths)
/// <inheritdoc />
public IAssemblySymbol? LoadAssembly(string path)
{
_log.LogMessage(MessageImportance.Low, string.Format(Resources.LoadingAssembly, path));

MetadataReference metadataReference = CreateOrGetMetadataReferenceFromPath(path);
IAssemblySymbol? assemblySymbol = _cSharpCompilation.GetAssemblyOrModuleSymbol(metadataReference) as IAssemblySymbol;
LogCompilationDiagnostics();
Expand All @@ -180,14 +187,17 @@ public void AddReferenceSearchPaths(params string[] paths)
/// <inheritdoc />
public IAssemblySymbol? LoadAssembly(string name, Stream stream)
{
_log.LogMessage(MessageImportance.Low, string.Format(Resources.LoadingAssemblyFromStream, name));

if (stream.Position >= stream.Length)
{
throw new ArgumentException(Resources.StreamPositionGreaterThanLength, nameof(stream));
}

if (!_loadedAssemblies.TryGetValue(name, out MetadataReference? metadataReference))
{
metadataReference = CreateAndAddReferenceToCompilation(name, stream);
string rootAssemblyDisplayString = string.Format(Resources.RootAssemblyDisplayString, name);
metadataReference = CreateAndAddReferenceToCompilation(name, rootAssemblyDisplayString, stream);
}

IAssemblySymbol? assemblySymbol = _cSharpCompilation.GetAssemblyOrModuleSymbol(metadataReference) as IAssemblySymbol;
Expand Down Expand Up @@ -318,13 +328,14 @@ private MetadataReference CreateOrGetMetadataReferenceFromPath(string path, Immu
if (!_loadedAssemblies.TryGetValue(name, out MetadataReference? metadataReference))
{
using FileStream stream = File.OpenRead(path);
metadataReference = CreateAndAddReferenceToCompilation(name, stream, referenceAssemblyNamesToIgnore);
string rootAssemblyDisplayString = string.Format(Resources.RootAssemblyDisplayString, path);
metadataReference = CreateAndAddReferenceToCompilation(name, rootAssemblyDisplayString, stream, referenceAssemblyNamesToIgnore);
}

return metadataReference;
}

private MetadataReference CreateAndAddReferenceToCompilation(string name, Stream fileStream, ImmutableHashSet<string>? referenceAssemblyNamesToIgnore = null)
private MetadataReference CreateAndAddReferenceToCompilation(string assemblyName, string rootAssemblyDisplayString, Stream fileStream, ImmutableHashSet<string>? referenceAssemblyNamesToIgnore = null, string? referenceeAssemblyName = null)
Copy link
Member

Choose a reason for hiding this comment

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

typo:

Suggested change
private MetadataReference CreateAndAddReferenceToCompilation(string assemblyName, string rootAssemblyDisplayString, Stream fileStream, ImmutableHashSet<string>? referenceAssemblyNamesToIgnore = null, string? referenceeAssemblyName = null)
private MetadataReference CreateAndAddReferenceToCompilation(string assemblyName, string rootAssemblyDisplayString, Stream fileStream, ImmutableHashSet<string>? referenceAssemblyNamesToIgnore = null, string? referenceAssemblyName = null)

{
// If we need to resolve references we can't reuse the same stream after creating the metadata
// reference from it as Roslyn closes it. So instead we use PEReader and get the bytes
Expand All @@ -333,51 +344,60 @@ private MetadataReference CreateAndAddReferenceToCompilation(string name, Stream

if (!reader.HasMetadata)
{
throw new ArgumentException(string.Format(Resources.ProvidedStreamDoesNotHaveMetadata, name));
throw new ArgumentException(string.Format(Resources.ProvidedStreamDoesNotHaveMetadata, assemblyName));
}

PEMemoryBlock image = reader.GetEntireImage();
MetadataReference metadataReference = MetadataReference.CreateFromImage(image.GetContent());
_loadedAssemblies.Add(name, metadataReference);
_loadedAssemblies.Add(assemblyName, metadataReference);
_cSharpCompilation = _cSharpCompilation.AddReferences([ metadataReference ]);

if (referenceeAssemblyName is null)
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
if (referenceeAssemblyName is null)
if (referenceAssemblyName is null)

{
_log.LogMessage(MessageImportance.Low, string.Format(Resources.AssemblyLoaded, assemblyName));
}
else
{
_log.LogMessage(MessageImportance.Low, string.Format(Resources.AssemblyReferenceLoaded, assemblyName, referenceeAssemblyName));
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
_log.LogMessage(MessageImportance.Low, string.Format(Resources.AssemblyReferenceLoaded, assemblyName, referenceeAssemblyName));
_log.LogMessage(MessageImportance.Low, string.Format(Resources.AssemblyReferenceLoaded, assemblyName, referenceAssemblyName));

}

if (_resolveReferences)
{
ResolveReferences(reader, referenceAssemblyNamesToIgnore);
ResolveReferences(reader, assemblyName, rootAssemblyDisplayString, referenceAssemblyNamesToIgnore);
}

return metadataReference;
}

private void ResolveReferences(PEReader peReader, ImmutableHashSet<string>? referenceAssemblyNamesToIgnore = null)
private void ResolveReferences(PEReader peReader, string assemblyName, string rootAssemblyDisplayString, ImmutableHashSet<string>? referenceAssemblyNamesToIgnore = null)
{
MetadataReader reader = peReader.GetMetadataReader();
foreach (AssemblyReferenceHandle handle in reader.AssemblyReferences)
foreach (AssemblyReferenceHandle assemblyReferenceHandle in reader.AssemblyReferences)
{
AssemblyReference reference = reader.GetAssemblyReference(handle);
string nameWithoutExtension = reader.GetString(reference.Name);
AssemblyReference assemblyReference = reader.GetAssemblyReference(assemblyReferenceHandle);
string assemblyReferenceNameWithoutExtension = reader.GetString(assemblyReference.Name);

// Skip assemblies that should never get loaded because they are purely internal
if (s_assembliesToIgnore.Contains(nameWithoutExtension))
if (s_assembliesToIgnore.Contains(assemblyReferenceNameWithoutExtension))
continue;

string name = nameWithoutExtension + ".dll";
string assemblyReferenceName = assemblyReferenceNameWithoutExtension + ".dll";

// Skip reference assemblies that are loaded later.
if (referenceAssemblyNamesToIgnore != null && referenceAssemblyNamesToIgnore.Contains(name))
if (referenceAssemblyNamesToIgnore != null && referenceAssemblyNamesToIgnore.Contains(assemblyReferenceName))
continue;

// If the assembly reference is already loaded, don't do anything.
if (_loadedAssemblies.ContainsKey(name))
if (_loadedAssemblies.ContainsKey(assemblyReferenceName))
continue;

// First we try to see if a reference path for this specific assembly was passed in directly, and if so
// we use that.
if (_referencePathFiles.TryGetValue(name, out string? fullReferencePath))
if (_referencePathFiles.TryGetValue(assemblyReferenceName, out string? fullReferencePath))
{
// TODO: add version check and add a warning if it doesn't match?
using FileStream resolvedStream = File.OpenRead(Path.Combine(fullReferencePath, name));
CreateAndAddReferenceToCompilation(name, resolvedStream, referenceAssemblyNamesToIgnore);
using FileStream resolvedStream = File.OpenRead(Path.Combine(fullReferencePath, assemblyReferenceName));
CreateAndAddReferenceToCompilation(assemblyReferenceName, rootAssemblyDisplayString, resolvedStream, referenceAssemblyNamesToIgnore, assemblyName);
}
// If we can't find a specific reference path for the dependency, then we look in the folders where the
// rest of the reference paths are located to see if we can find the dependency there.
Expand All @@ -387,20 +407,21 @@ private void ResolveReferences(PEReader peReader, ImmutableHashSet<string>? refe

foreach (string referencePathDirectory in _referencePathDirectories)
{
string potentialPath = Path.Combine(referencePathDirectory, name);
string potentialPath = Path.Combine(referencePathDirectory, assemblyReferenceName);
if (File.Exists(potentialPath))
{
// TODO: add version check and add a warning if it doesn't match?
using FileStream resolvedStream = File.OpenRead(potentialPath);
CreateAndAddReferenceToCompilation(name, resolvedStream, referenceAssemblyNamesToIgnore);
CreateAndAddReferenceToCompilation(assemblyReferenceName, rootAssemblyDisplayString, resolvedStream, referenceAssemblyNamesToIgnore, assemblyName);
found = true;
break;
}
}

if (!found)
{
_log.LogWarning(AssemblyReferenceNotFoundErrorCode, string.Format(Resources.CouldNotResolveReference, name));
_log.LogWarning(AssemblyReferenceNotFoundErrorCode,
string.Format(Resources.CouldNotResolveReference, assemblyReferenceName, rootAssemblyDisplayString));
}
}
}
Expand Down
26 changes: 25 additions & 1 deletion src/Compatibility/Microsoft.DotNet.ApiSymbolExtensions/Resources.resx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,8 +117,26 @@
<resheader name="writer">
<value>System.Resources.ResXResourceWriter, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
</resheader>
<data name="AssemblyLoaded" xml:space="preserve">
<value>Assembly '{0}' loaded.</value>
</data>
<data name="AssemblyReferenceLoaded" xml:space="preserve">
<value>Assembly '{0}' referenced by '{1}' loaded.</value>
</data>
<data name="CouldNotResolveReference" xml:space="preserve">
<value>Could not resolve reference '{0}' in any of the provided search directories.</value>
<value>Could not resolve reference '{0}' directly or transitively referenced by {1} in any of the provided search directories.</value>
</data>
<data name="LoadingAssemblies" xml:space="preserve">
<value>Loading assemblies '{0}'.</value>
</data>
<data name="LoadingAssembliesFromArchive" xml:space="preserve">
<value>Loading assemblies '{0}' ({1}).</value>
</data>
<data name="LoadingAssembly" xml:space="preserve">
<value>Loading assembly '{0}'.</value>
</data>
<data name="LoadingAssemblyFromStream" xml:space="preserve">
<value>Loading assembly '{0}' from stream.</value>
</data>
<data name="MatchingAssemblyNotFound" xml:space="preserve">
<value>Could not find matching assembly: '{0}' in any of the search directories.</value>
Expand All @@ -129,6 +147,12 @@
<data name="ProvidedStreamDoesNotHaveMetadata" xml:space="preserve">
<value>Provided stream for assembly '{0}' doesn't have any metadata to read. from.</value>
</data>
<data name="RootAssemblyDisplayString" xml:space="preserve">
<value>'{0}'</value>
</data>
<data name="RootAssemblyFromPackageDisplayString" xml:space="preserve">
<value>'{0}' ({1})</value>
</data>
<data name="ShouldNotBeNullAndContainAtLeastOneElement" xml:space="preserve">
<value>Should not be null and contain at least one element.</value>
</data>
Expand Down
44 changes: 42 additions & 2 deletions src/Compatibility/Microsoft.DotNet.ApiSymbolExtensions/xlf/Resources.cs.xlf
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

44 changes: 42 additions & 2 deletions src/Compatibility/Microsoft.DotNet.ApiSymbolExtensions/xlf/Resources.de.xlf
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading
Loading