@ -26,7 +26,6 @@ using System.Reflection.PortableExecutable;
using System.Runtime.CompilerServices ; using System.Runtime.CompilerServices ;
using System.Threading ; using System.Threading ;
using System.Threading.Tasks ; using System.Threading.Tasks ;
using System.Windows.Threading ;
using ICSharpCode.Decompiler.DebugInfo ; using ICSharpCode.Decompiler.DebugInfo ;
using ICSharpCode.Decompiler.Metadata ; using ICSharpCode.Decompiler.Metadata ;
@ -95,7 +94,6 @@ namespace ICSharpCode.ILSpy
this . loadingTask = Task . Run ( ( ) = > LoadAsync ( stream ) ) ; // requires that this.fileName is set
this . loadingTask = Task . Run ( ( ) = > LoadAsync ( stream ) ) ; // requires that this.fileName is set
this . shortName = Path . GetFileNameWithoutExtension ( fileName ) ; this . shortName = Path . GetFileNameWithoutExtension ( fileName ) ;
this . resolver = new MyAssemblyResolver ( this ) ;
} }
public LoadedAssembly ( LoadedAssembly bundle , string fileName , Task < Stream > stream , IAssemblyResolver assemblyResolver = null ) public LoadedAssembly ( LoadedAssembly bundle , string fileName , Task < Stream > stream , IAssemblyResolver assemblyResolver = null )
@ -158,6 +156,24 @@ namespace ICSharpCode.ILSpy
} }
} }
/// <summary>
/// Gets the <see cref="PEFile"/>.
/// Returns null in case of load errors.
/// </summary>
public async Task < PEFile > GetPEFileOrNullAsync ( )
{
try
{
var loadResult = await loadingTask . ConfigureAwait ( false ) ;
return loadResult . PEFile ;
}
catch ( Exception ex )
{
System . Diagnostics . Trace . TraceError ( ex . ToString ( ) ) ;
return null ;
}
}
ICompilation typeSystem ; ICompilation typeSystem ;
/// <summary>
/// <summary>
@ -368,162 +384,155 @@ namespace ICSharpCode.ILSpy
return debugInfoProvider ; return debugInfoProvider ;
} }
[ThreadStatic] sealed class MyAssemblyResolver : IAssemblyResolver
static int assemblyLoadDisableCount ;
public static IDisposable DisableAssemblyLoad ( AssemblyList assemblyList )
{ {
assemblyLoadDisableCount + + ; readonly LoadedAssembly parent ;
return new DecrementAssemblyLoadDisableCount ( assemblyList ) ; readonly bool loadOnDemand ;
}
public static IDisposable DisableAssemblyLoad ( ) readonly IAssemblyResolver providedAssemblyResolver ;
{ readonly AssemblyList assemblyList ;
assemblyLoadDisableCount + + ; readonly LoadedAssembly [ ] alreadyLoadedAssemblies ;
return new DecrementAssemblyLoadDisableCount ( MainWindow . Instance . CurrentAssemblyList ) ; readonly Task < string > tfmTask ;
} readonly ReferenceLoadInfo referenceLoadInfo ;
sealed class DecrementAssemblyLoadDisableCount : IDisposable public MyAssemblyResolver ( LoadedAssembly parent , bool loadOnDemand )
{ {
bool disposed ; this . parent = parent ;
AssemblyList assemblyList ; this . loadOnDemand = loadOnDemand ;
public DecrementAssemblyLoadDisableCount ( AssemblyList assemblyList ) this . providedAssemblyResolver = parent . providedAssemblyResolver ;
{ this . assemblyList = parent . assemblyList ;
this . assemblyList = assemblyList ; // Note: we cache a copy of the assembly list in the constructor, so that the
// resolve calls only search-by-asm-name in the assemblies that were already loaded
// at the time of the GetResolver() call.
this . alreadyLoadedAssemblies = assemblyList . GetAssemblies ( ) ;
// If we didn't do this, we'd also search in the assemblies that we just started to load
// in previous Resolve() calls; but we don't want to wait for those to be loaded.
this . tfmTask = parent . GetTargetFrameworkIdAsync ( ) ;
this . referenceLoadInfo = parent . LoadedAssemblyReferencesInfo ;
} }
public void Dispose ( ) public PEFile Resolve ( IAssemblyReference reference )
{
if ( ! disposed )
{ {
disposed = true ; return ResolveAsync ( reference ) . GetAwaiter ( ) . GetResult ( ) ;
assemblyLoadDisableCount - - ;
// clear the lookup cache since we might have stored the lookups failed due to DisableAssemblyLoad()
assemblyList . ClearCache ( ) ;
}
}
} }
sealed class MyAssemblyResolver : IAssemblyResolver Dictionary < string , PEFile > asmLookupByFullName ;
{ Dictionary < string , PEFile > asmLookupByShortName ;
readonly LoadedAssembly parent ;
public MyAssemblyResolver ( LoadedAssembly parent ) /// <summary>
/// 0) if we're inside a package, look for filename.dll in parent directories
/// 1) try to find exact match by tfm + full asm name in loaded assemblies
/// 2) try to find match in search paths
/// 3) if a.deps.json is found: search %USERPROFILE%/.nuget/packages/* as well
/// 4) look in /dotnet/shared/{runtime-pack}/{closest-version}
/// 5) if the version is retargetable or all zeros or ones, search C:\Windows\Microsoft.NET\Framework64\v4.0.30319
/// 6) For "mscorlib.dll" we use the exact same assembly with which ILSpy runs
/// 7) Search the GAC
/// 8) search C:\Windows\Microsoft.NET\Framework64\v4.0.30319
/// 9) try to find match by asm name (no tfm/version) in loaded assemblies
/// </summary>
public async Task < PEFile > ResolveAsync ( IAssemblyReference reference )
{ {
this . parent = parent ; PEFile module ;
} // 0) if we're inside a package, look for filename.dll in parent directories
if ( providedAssemblyResolver ! = null )
public PEFile Resolve ( IAssemblyReference reference )
{ {
var module = parent . providedAssemblyResolver ? . Resolve ( reference ) ; module = await providedAssemblyResolver . ResolveAsync ( reference ) . ConfigureAwait ( fals e ) ;
if ( module ! = null ) if ( module ! = null )
return module ; return module ;
return parent . LookupReferencedAssembly ( reference ) ? . GetPEFileOrNull ( ) ;
} }
public PEFile ResolveModule ( PEFile mainModule , string moduleName ) string tfm = await tfmTask . ConfigureAwait ( false ) ;
{
var module = parent . providedAssemblyResolver ? . ResolveModule ( mainModule , moduleName ) ;
if ( module ! = null )
return module ;
return parent . LookupReferencedModule ( mainModule , moduleName ) ? . GetPEFileOrNull ( ) ;
}
}
readonly MyAssemblyResolver resolver ; bool isWinRT = reference . IsWindowsRuntime ;
string key = tfm + ";" + ( isWinRT ? reference . Name : reference . FullName ) ;
public IAssemblyResolver GetAssemblyResolver ( ) // 1) try to find exact match by tfm + full asm name in loaded assemblies
var lookup = LazyInit . VolatileRead ( ref isWinRT ? ref asmLookupByShortName : ref asmLookupByFullName ) ;
if ( lookup = = null )
{ {
return resolver ; lookup = await CreateLoadedAssemblyLookupAsync ( shortNames : isWinRT ) . ConfigureAwait ( false ) ;
lookup = LazyInit . GetOrSet ( ref isWinRT ? ref asmLookupByShortName : ref asmLookupByFullName , lookup ) ;
} }
if ( lookup . TryGetValue ( key , out module ) )
public AssemblyReferenceClassifier GetAssemblyReferenceClassifier ( )
{ {
return universalResolver ; referenceLoadInfo . AddMessageOnce ( reference . FullName , MessageKind . Info , "Success - Found in Assembly List" ) ;
return module ;
} }
/// <summary>
string file = parent . GetUniversalResolver ( ) . FindAssemblyFile ( reference ) ;
/// Returns the debug info for this assembly. Returns null in case of load errors or no debug info is available.
/// </summary>
public IDebugInfoProvider GetDebugInfoOrNull ( )
{
if ( GetPEFileOrNull ( ) = = null )
return null ;
return debugInfoProvider ;
}
public LoadedAssembly LookupReferencedAssembly ( IAssemblyReference reference ) if ( file ! = null )
{ {
if ( reference = = null ) // Load assembly from disk
throw new ArgumentNullException ( nameof ( reference ) ) ; LoadedAssembly asm ;
var tfm = GetTargetFrameworkIdAsync ( ) . Result ; if ( loadOnDemand )
if ( reference . IsWindowsRuntime )
{ {
return assemblyList . assemblyLookupCache . GetOrAdd ( ( reference . Name , true , tfm ) , key = > LookupReferencedAssemblyInternal ( reference , true , tfm ) ) ; asm = assemblyList . OpenAssembly ( file , isAutoLoaded : true ) ;
} }
else else
{ {
return assemblyList . assemblyLookupCache . GetOrAdd ( ( reference . FullName , false , tfm ) , key = > LookupReferencedAssemblyInternal ( reference , false , tfm ) ) ; asm = assemblyList . FindAssembly ( file ) ;
}
} }
if ( asm ! = null )
public LoadedAssembly LookupReferencedModule ( PEFile mainModule , string moduleName )
{ {
if ( mainModule = = null ) referenceLoadInfo . AddMessage ( reference . ToString ( ) , MessageKind . Info , "Success - Loading from: " + file ) ;
throw new ArgumentNullException ( nameof ( mainModule ) ) ; return await asm . GetPEFileOrNullAsync ( ) . ConfigureAwait ( false ) ;
if ( moduleName = = null ) }
throw new ArgumentNullException ( nameof ( moduleName ) ) ; return null ;
return assemblyList . moduleLookupCache . GetOrAdd ( mainModule . FileName + ";" + moduleName , _ = > LookupReferencedModuleInternal ( mainModule , moduleName ) ) ;
} }
else
{
// Assembly not found; try to find a similar-enough already-loaded assembly
var candidates = new List < ( LoadedAssembly assembly , Version version ) > ( ) ;
class MyUniversalResolver : UniversalAssemblyResolver foreach ( LoadedAssembly loaded in alreadyLoadedAssemblies )
{ {
public MyUniversalResolver ( LoadedAssembly assembly ) module = await loaded . GetPEFileOrNullAsync ( ) . ConfigureAwait ( false ) ;
: base ( assembly . FileName , false , assembly . GetTargetFrameworkIdAsync ( ) . Result , PEStreamOptions . PrefetchEntireImage , DecompilerSettingsPanel . CurrentDecompilerSettings . ApplyWindowsRuntimeProjections ? MetadataReaderOptions . ApplyWindowsRuntimeProjections : MetadataReaderOptions . None ) var reader = module ? . Metadata ;
if ( reader = = null | | ! reader . IsAssembly )
continue ;
var asmDef = reader . GetAssemblyDefinition ( ) ;
var asmDefName = reader . GetString ( asmDef . Name ) ;
if ( reference . Name . Equals ( asmDefName , StringComparison . OrdinalIgnoreCase ) )
{ {
candidates . Add ( ( loaded , asmDef . Version ) ) ;
} }
} }
static readonly Dictionary < string , LoadedAssembly > loadingAssemblies = new Dictionary < string , LoadedAssembly > ( ) ; if ( candidates . Count = = 0 )
MyUniversalResolver universalResolver ;
/// <summary>
/// 0) if we're inside a package, look for filename.dll in parent directories
/// (this step already happens in MyAssemblyResolver; not in LookupReferencedAssembly)
/// 1) try to find exact match by tfm + full asm name in loaded assemblies
/// 2) try to find match in search paths
/// 3) if a.deps.json is found: search %USERPROFILE%/.nuget/packages/* as well
/// 4) look in /dotnet/shared/{runtime-pack}/{closest-version}
/// 5) if the version is retargetable or all zeros or ones, search C:\Windows\Microsoft.NET\Framework64\v4.0.30319
/// 6) For "mscorlib.dll" we use the exact same assembly with which ILSpy runs
/// 7) Search the GAC
/// 8) search C:\Windows\Microsoft.NET\Framework64\v4.0.30319
/// 9) try to find match by asm name (no tfm/version) in loaded assemblies
/// </summary>
LoadedAssembly LookupReferencedAssemblyInternal ( IAssemblyReference fullName , bool isWinRT , string tfm )
{ {
string key = tfm + ";" + ( isWinRT ? fullName . Name : fullName . FullName ) ; referenceLoadInfo . AddMessageOnce ( reference . ToString ( ) , MessageKind . Error , "Could not find reference: " + reference ) ;
return null ;
}
string file ; candidates . SortBy ( c = > c . version ) ;
LoadedAssembly asm ;
lock ( loadingAssemblies ) var bestCandidate = candidates . FirstOrDefault ( c = > c . version > = reference . Version ) . assembly ? ? candidates . Last ( ) . assembly ;
referenceLoadInfo . AddMessageOnce ( reference . ToString ( ) , MessageKind . Info , "Success - Found in Assembly List with different TFM or version: " + bestCandidate . fileName ) ;
return await bestCandidate . GetPEFileOrNullAsync ( ) . ConfigureAwait ( false ) ;
}
}
private async Task < Dictionary < string , PEFile > > CreateLoadedAssemblyLookupAsync ( bool shortNames )
{ {
foreach ( LoadedAssembly loaded in assemblyList . GetAssemblies ( ) ) var result = new Dictionary < string , PEFile > ( StringComparer . OrdinalIgnoreCase ) ;
foreach ( LoadedAssembly loaded in alreadyLoadedAssemblies )
{ {
try try
{ {
var module = loaded . GetPEFileOrNull ( ) ; var module = await loaded . GetPEFileOrNullAsync ( ) . ConfigureAwait ( false ) ;
var reader = module ? . Metadata ; var reader = module ? . Metadata ;
if ( reader = = null | | ! reader . IsAssembly ) if ( reader = = null | | ! reader . IsAssembly )
continue ; continue ;
var asmDef = reader . GetAssemblyDefinition ( ) ; var asmDef = reader . GetAssemblyDefinition ( ) ;
var asmDefName = loaded . GetTargetFrameworkIdAsync ( ) . Result + ";" string tfm = await loaded . GetTargetFrameworkIdAsync ( ) ;
+ ( isWinRT ? reader . GetString ( asmDef . Name ) : reader . GetFullAssemblyName ( ) ) ; string key = tfm + ";"
if ( key . Equals ( asmDefName , StringComparison . OrdinalIgnoreCase ) ) + ( shortNames ? reader . GetString ( asmDef . Name ) : reader . GetFullAssemblyName ( ) ) ;
if ( ! result . ContainsKey ( key ) )
{ {
LoadedAssemblyReferencesInfo . AddMessageOnce ( fullName . FullName , MessageKind . Info , "Success - Found in Assembly List" ) ; result . Add ( key , module ) ;
return loaded ;
} }
} }
catch ( BadImageFormatException ) catch ( BadImageFormatException )
@ -531,145 +540,97 @@ namespace ICSharpCode.ILSpy
continue ; continue ;
} }
} }
return result ;
}
if ( universalResolver = = null ) public PEFile ResolveModule ( PEFile mainModule , string moduleName )
{ {
universalResolver = new MyUniversalResolver ( this ) ; return ResolveModuleAsync ( mainModule , moduleName ) . GetAwaiter ( ) . GetResult ( ) ;
} }
file = universalResolver . FindAssemblyFile ( fullName ) ; public async Task < PEFile > ResolveModuleAsync ( PEFile mainModule , string moduleName )
foreach ( LoadedAssembly loaded in assemblyList . GetAssemblies ( ) )
{ {
if ( loaded . FileName . Equals ( file , StringComparison . OrdinalIgnoreCase ) ) if ( providedAssemblyResolver ! = null )
{ {
return loaded ; var module = await providedAssemblyResolver . ResolveModuleAsync ( mainModule , moduleName ) . ConfigureAwait ( false ) ;
} if ( module ! = null )
return module ;
} }
if ( file ! = null & & loadingAssemblies . TryGetValue ( file , out asm ) )
return asm ;
if ( assemblyLoadDisableCount > 0 )
return null ;
if ( file ! = null )
{
LoadedAssemblyReferencesInfo . AddMessage ( fullName . ToString ( ) , MessageKind . Info , "Success - Loading from: " + file ) ;
asm = new LoadedAssembly ( assemblyList , file ) { IsAutoLoaded = true } ;
}
else
{
var candidates = new List < ( LoadedAssembly assembly , Version version ) > ( ) ;
foreach ( LoadedAssembly loaded in assemblyList . GetAssemblies ( ) ) string file = Path . Combine ( Path . GetDirectoryName ( mainModule . FileName ) , moduleName ) ;
if ( File . Exists ( file ) )
{ {
var module = loaded . GetPEFileOrNull ( ) ; // Load module from disk
var reader = module ? . Metadata ; LoadedAssembly asm ;
if ( reader = = null | | ! reader . IsAssembly ) if ( loadOnDemand )
continue ;
var asmDef = reader . GetAssemblyDefinition ( ) ;
var asmDefName = reader . GetString ( asmDef . Name ) ;
if ( fullName . Name . Equals ( asmDefName , StringComparison . OrdinalIgnoreCase ) )
{
candidates . Add ( ( loaded , asmDef . Version ) ) ;
}
}
if ( candidates . Count = = 0 )
{ {
LoadedAssemblyReferencesInfo . AddMessageOnce ( fullName . ToString ( ) , MessageKind . Error , "Could not find reference: " + fullName ) ; asm = assemblyList . OpenAssembly ( file , isAutoLoaded : true ) ;
return null ;
}
candidates . SortBy ( c = > c . version ) ;
var bestCandidate = candidates . FirstOrDefault ( c = > c . version > = fullName . Version ) . assembly ? ? candidates . Last ( ) . assembly ;
LoadedAssemblyReferencesInfo . AddMessageOnce ( fullName . ToString ( ) , MessageKind . Info , "Success - Found in Assembly List with different TFM or version: " + bestCandidate . fileName ) ;
return bestCandidate ;
} }
loadingAssemblies . Add ( file , asm ) ; else
}
App . Current . Dispatcher . BeginInvoke ( ( Action ) delegate ( ) {
lock ( assemblyList . assemblies )
{ {
assemblyList . assemblies . Add ( asm ) ; asm = assemblyList . FindAssembly ( file ) ;
} }
lock ( loadingAssemblies ) if ( asm ! = null )
{ {
loadingAssemblies . Remove ( fil e) ; return await asm . GetPEFileOrNullAsync ( ) . ConfigureAwait ( false ) ;
} }
} , DispatcherPriority . Normal ) ;
return asm ;
} }
else
LoadedAssembly LookupReferencedModuleInternal ( PEFile mainModule , string moduleName )
{
string file ;
LoadedAssembly asm ;
lock ( loadingAssemblies )
{ {
foreach ( LoadedAssembly loaded in assemblyList . GetAssemblies ( ) ) // Module does not exist on disk, look for one with a matching name in the assemblylist:
foreach ( LoadedAssembly loaded in alreadyLoadedAssemblies )
{ {
var reader = loaded . GetPEFileOrNull ( ) ? . Metadata ; var module = await loaded . GetPEFileOrNullAsync ( ) . ConfigureAwait ( false ) ;
var reader = module ? . Metadata ;
if ( reader = = null | | reader . IsAssembly ) if ( reader = = null | | reader . IsAssembly )
continue ; continue ;
var moduleDef = reader . GetModuleDefinition ( ) ; var moduleDef = reader . GetModuleDefinition ( ) ;
if ( moduleName . Equals ( reader . GetString ( moduleDef . Name ) , StringComparison . OrdinalIgnoreCase ) ) if ( moduleName . Equals ( reader . GetString ( moduleDef . Name ) , StringComparison . OrdinalIgnoreCase ) )
{ {
LoadedAssemblyReferencesInfo . AddMessageOnce ( moduleName , MessageKind . Info , "Success - Found in Assembly List" ) ; referenceLoadInfo . AddMessageOnce ( moduleName , MessageKind . Info , "Success - Found in Assembly List" ) ;
return loaded ; return module ;
}
} }
} }
file = Path . Combine ( Path . GetDirectoryName ( mainModule . FileName ) , moduleName ) ;
if ( ! File . Exists ( file ) )
return null ; return null ;
foreach ( LoadedAssembly loaded in assemblyList . GetAssemblies ( ) )
{
if ( loaded . FileName . Equals ( file , StringComparison . OrdinalIgnoreCase ) )
{
return loaded ;
} }
} }
if ( file ! = null & & loadingAssemblies . TryGetValue ( file , out asm ) ) public IAssemblyResolver GetAssemblyResolver ( bool loadOnDemand = true )
return asm ; {
return new MyAssemblyResolver ( this , loadOnDemand ) ;
}
if ( assemblyLoadDisableCount > 0 ) private MyUniversalResolver GetUniversalResolver ( )
return null ; {
return LazyInitializer . EnsureInitialized ( ref this . universalResolver , ( ) = > new MyUniversalResolver ( this ) ) ;
}
if ( file ! = null ) public AssemblyReferenceClassifier GetAssemblyReferenceClassifier ( )
{ {
LoadedAssemblyReferencesInfo . AddMessage ( moduleName , MessageKind . Info , "Success - Loading from: " + file ) ; return GetUniversalResolver ( ) ;
asm = new LoadedAssembly ( assemblyList , file ) { IsAutoLoaded = true } ;
} }
else
/// <summary>
/// Returns the debug info for this assembly. Returns null in case of load errors or no debug info is available.
/// </summary>
public IDebugInfoProvider GetDebugInfoOrNull ( )
{ {
LoadedAssemblyReferencesInfo . AddMessageOnce ( moduleName , MessageKind . Error , "Could not find reference: " + moduleName ) ; if ( GetPEFileOrNull ( ) = = null )
return null ; return null ;
return debugInfoProvider ;
} }
loadingAssemblies . Add ( file , asm ) ;
} class MyUniversalResolver : UniversalAssemblyResolver
App . Current . Dispatcher . BeginInvoke ( ( Action ) delegate ( ) {
lock ( assemblyList . assemblies )
{ {
assemblyList . assemblies . Add ( asm ) ; public MyUniversalResolver ( LoadedAssembly assembly )
} : base ( assembly . FileName , false , assembly . GetTargetFrameworkIdAsync ( ) . Result , PEStreamOptions . PrefetchEntireImage , DecompilerSettingsPanel . CurrentDecompilerSettings . ApplyWindowsRuntimeProjections ? MetadataReaderOptions . ApplyWindowsRuntimeProjections : MetadataReaderOptions . None )
lock ( loadingAssemblies )
{ {
loadingAssemblies . Remove ( file ) ;
} }
} ) ;
return asm ;
} }
[Obsolete("Use GetPEFileAsync() or GetLoadResultAsync() instead")] MyUniversalResolver universalResolver ;
public Task ContinueWhenLoaded ( Action < Task < PEFile > > onAssemblyLoaded , TaskScheduler taskScheduler )
{
return this . GetPEFileAsync ( ) . ContinueWith ( onAssemblyLoaded , default ( CancellationToken ) , TaskContinuationOptions . RunContinuationsAsynchronously , taskScheduler ) ;
}
/// <summary>
/// <summary>
/// Wait until the assembly is loaded.
/// Wait until the assembly is loaded.
Daniel Grunwald
4 years ago
committed by
GitHub