// Copyright (c) 2018 Siegfried Pammer // // Permission is hereby granted, free of charge, to any person obtaining a copy of this // software and associated documentation files (the "Software"), to deal in the Software // without restriction, including without limitation the rights to use, copy, modify, merge, // publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons // to whom the Software is furnished to do so, subject to the following conditions: // // The above copyright notice and this permission notice shall be included in all copies or // substantial portions of the Software. // // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, // INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR // PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE // FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR // OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER // DEALINGS IN THE SOFTWARE. using System; using System.Collections.Generic; using System.Collections.Immutable; using System.Diagnostics; using System.IO; using System.Linq; using System.Reflection.Metadata; using System.Reflection.PortableExecutable; using ICSharpCode.Decompiler.TypeSystem; using ICSharpCode.Decompiler.Util; namespace ICSharpCode.Decompiler.Metadata { /// /// PEFile is the main class the decompiler uses to represent a metadata assembly/module. /// Every file on disk can be loaded into a standalone PEFile instance. /// /// A PEFile can be combined with its referenced assemblies/modules to form a type system, /// in that case the class is used instead. /// /// /// In addition to wrapping a System.Reflection.Metadata.PEReader, this class /// contains a few decompiler-specific caches to allow efficiently constructing a type /// system from multiple PEFiles. This allows the caches to be shared across multiple /// decompiled type systems. /// [DebuggerDisplay("{FileName}")] public class PEFile : IDisposable, TypeSystem.IModuleReference { public string FileName { get; } public PEReader Reader { get; } public MetadataReader Metadata { get; } public PEFile(string fileName, PEStreamOptions streamOptions = PEStreamOptions.Default, MetadataReaderOptions metadataOptions = MetadataReaderOptions.Default) : this(fileName, new PEReader(new FileStream(fileName, FileMode.Open, FileAccess.Read), streamOptions), metadataOptions) { } public PEFile(string fileName, Stream stream, PEStreamOptions streamOptions = PEStreamOptions.Default, MetadataReaderOptions metadataOptions = MetadataReaderOptions.Default) : this(fileName, new PEReader(stream, streamOptions), metadataOptions) { } public PEFile(string fileName, PEReader reader, MetadataReaderOptions metadataOptions = MetadataReaderOptions.Default) { this.FileName = fileName ?? throw new ArgumentNullException(nameof(fileName)); this.Reader = reader ?? throw new ArgumentNullException(nameof(reader)); if (!reader.HasMetadata) throw new PEFileNotSupportedException("PE file does not contain any managed metadata."); this.Metadata = reader.GetMetadataReader(metadataOptions); } public bool IsAssembly => Metadata.IsAssembly; public string Name => GetName(); public string FullName => IsAssembly ? Metadata.GetFullAssemblyName() : Name; public TargetRuntime GetRuntime() { string version = Metadata.MetadataVersion; switch (version[1]) { case '1': if (version[3] == 1) return TargetRuntime.Net_1_0; else return TargetRuntime.Net_1_1; case '2': return TargetRuntime.Net_2_0; case '4': return TargetRuntime.Net_4_0; default: return TargetRuntime.Unknown; } } string GetName() { var metadata = Metadata; if (metadata.IsAssembly) return metadata.GetString(metadata.GetAssemblyDefinition().Name); return metadata.GetString(metadata.GetModuleDefinition().Name); } public ImmutableArray AssemblyReferences => Metadata.AssemblyReferences.Select(r => new AssemblyReference(this, r)).ToImmutableArray(); public ImmutableArray Resources => GetResources().ToImmutableArray(); IEnumerable GetResources() { var metadata = Metadata; foreach (var h in metadata.ManifestResources) { yield return new Resource(this, h); } } public void Dispose() { Reader.Dispose(); } Dictionary typeLookup; /// /// Finds the top-level-type with the specified name. /// public TypeDefinitionHandle GetTypeDefinition(TopLevelTypeName typeName) { var lookup = LazyInit.VolatileRead(ref typeLookup); if (lookup == null) { lookup = new Dictionary(); foreach (var handle in Metadata.TypeDefinitions) { var td = Metadata.GetTypeDefinition(handle); if (!td.GetDeclaringType().IsNil) { continue; // nested type } var nsHandle = td.Namespace; string ns = nsHandle.IsNil ? string.Empty : Metadata.GetString(nsHandle); string name = ReflectionHelper.SplitTypeParameterCountFromReflectionName(Metadata.GetString(td.Name), out int typeParameterCount); lookup[new TopLevelTypeName(ns, name, typeParameterCount)] = handle; } lookup = LazyInit.GetOrSet(ref typeLookup, lookup); } if (lookup.TryGetValue(typeName, out var resultHandle)) return resultHandle; else return default; } Dictionary typeForwarderLookup; /// /// Finds the type forwarder with the specified name. /// public ExportedTypeHandle GetTypeForwarder(FullTypeName typeName) { var lookup = LazyInit.VolatileRead(ref typeForwarderLookup); if (lookup == null) { lookup = new Dictionary(); foreach (var handle in Metadata.ExportedTypes) { var td = Metadata.GetExportedType(handle); lookup[td.GetFullTypeName(Metadata)] = handle; } lookup = LazyInit.GetOrSet(ref typeForwarderLookup, lookup); } if (lookup.TryGetValue(typeName, out var resultHandle)) return resultHandle; else return default; } MethodSemanticsLookup methodSemanticsLookup; internal MethodSemanticsLookup MethodSemanticsLookup { get { var r = LazyInit.VolatileRead(ref methodSemanticsLookup); if (r != null) return r; else return LazyInit.GetOrSet(ref methodSemanticsLookup, new MethodSemanticsLookup(Metadata)); } } public TypeSystem.IModuleReference WithOptions(TypeSystemOptions options) { return new PEFileWithOptions(this, options); } IModule TypeSystem.IModuleReference.Resolve(ITypeResolveContext context) { return new MetadataModule(context.Compilation, this, TypeSystemOptions.Default); } private class PEFileWithOptions : TypeSystem.IModuleReference { readonly PEFile peFile; readonly TypeSystemOptions options; public PEFileWithOptions(PEFile peFile, TypeSystemOptions options) { this.peFile = peFile; this.options = options; } IModule TypeSystem.IModuleReference.Resolve(ITypeResolveContext context) { return new MetadataModule(context.Compilation, peFile, options); } } } }