/* Copyright 2017-2019 Katy Coe - http://www.hearthcode.org - http://www.djkaty.com All rights reserved. */ using System; using System.Collections.Generic; using System.IO; using System.Linq; using System.Reflection; using NoisyCowStudios.Bin2Object; namespace Il2CppInspector { public interface IFileFormatReader { BinaryObjectReader Stream { get; } double Version { get; set; } long Length { get; } uint NumImages { get; } IEnumerable Images { get; } IFileFormatReader this[uint index] { get; } long Position { get; set; } string Format { get; } string Arch { get; } int Bits { get; } ulong GlobalOffset { get; } Dictionary GetSymbolTable(); uint[] GetFunctionTable(); U ReadMappedObject(ulong uiAddr) where U : new(); U[] ReadMappedArray(ulong uiAddr, int count) where U : new(); long[] ReadMappedWordArray(ulong uiAddr, int count); uint MapVATR(ulong uiAddr); byte[] ReadBytes(int count); ulong ReadUInt64(); ulong ReadUInt64(long uiAddr); uint ReadUInt32(); uint ReadUInt32(long uiAddr); ushort ReadUInt16(); ushort ReadUInt16(long uiAddr); byte ReadByte(); byte ReadByte(long uiAddr); long ReadWord(); long ReadWord(long uiAddr); U ReadObject() where U : new(); string ReadMappedNullTerminatedString(ulong uiAddr); List ReadMappedObjectPointerArray(ulong uiAddr, int count) where U : new(); event EventHandler OnStatusUpdate; } public class FileFormatReader { // Helper method to try all defined file formats when the contents of the binary is unknown public static IFileFormatReader Load(string filename, EventHandler statusCallback = null) => Load(new FileStream(filename, FileMode.Open, FileAccess.Read), statusCallback); public static IFileFormatReader Load(Stream stream, EventHandler statusCallback = null) { var types = Assembly.GetExecutingAssembly().DefinedTypes .Where(x => x.ImplementedInterfaces.Contains(typeof(IFileFormatReader)) && !x.IsGenericTypeDefinition); foreach (var type in types) { if (type.GetMethod("Load", BindingFlags.FlattenHierarchy | BindingFlags.Static | BindingFlags.Public, null, new [] {typeof(Stream), typeof(EventHandler)}, null) .Invoke(null, new object[] { stream, statusCallback }) is IFileFormatReader loaded) return loaded; } return null; } } public abstract class FileFormatReader : BinaryObjectReader, IFileFormatReader where T : FileFormatReader { public FileFormatReader(Stream stream) : base(stream) { } public BinaryObjectReader Stream => this; public long Length => BaseStream.Length; public uint NumImages { get; protected set; } = 1; public ulong GlobalOffset { get; protected set; } public virtual string Format => throw new NotImplementedException(); public virtual string Arch => throw new NotImplementedException(); public virtual int Bits => throw new NotImplementedException(); public event EventHandler OnStatusUpdate; protected void StatusUpdate(string status) => OnStatusUpdate?.Invoke(this, status); public IEnumerable Images { get { for (uint i = 0; i < NumImages; i++) yield return this[i]; } } public static T Load(string filename, EventHandler statusCallback = null) { using var stream = new FileStream(filename, FileMode.Open, FileAccess.Read); return Load(stream, statusCallback); } public static T Load(Stream stream, EventHandler statusCallback = null) { // Copy the original stream in case we modify it var ms = new MemoryStream(); stream.Position = 0; stream.CopyTo(ms); ms.Position = 0; var pe = (T) Activator.CreateInstance(typeof(T), ms); return pe.InitImpl(statusCallback) ? pe : null; } private bool InitImpl(EventHandler statusCallback = null) { OnStatusUpdate += statusCallback; return Init(); } // Confirm file is valid and set up RVA mappings protected virtual bool Init() => throw new NotImplementedException(); // Choose a sub-binary within the image for multi-architecture binaries public virtual IFileFormatReader this[uint index] => (index == 0)? this : throw new IndexOutOfRangeException("Binary image index out of bounds"); // Find search locations in the symbol table for Il2Cpp data public virtual Dictionary GetSymbolTable() => null; // Find search locations in the machine code for Il2Cpp data public virtual uint[] GetFunctionTable() => throw new NotImplementedException(); // Map an RVA to an offset into the file image // No mapping by default public virtual uint MapVATR(ulong uiAddr) => (uint) uiAddr; // Read a file format dependent word (32 or 64 bits) // The primitive mappings in Bin2Object will automatically read a uint if the file is 32-bit public long ReadWord() => ReadObject(); public long ReadWord(long uiAddr) => ReadObject(uiAddr); // Retrieve object(s) from specified RVA(s) public U ReadMappedObject(ulong uiAddr) where U : new() => ReadObject(MapVATR(uiAddr)); public U[] ReadMappedArray(ulong uiAddr, int count) where U : new() => ReadArray(MapVATR(uiAddr), count); // Read a file format dependent array of words (32 or 64 bits) // The primitive mappings in Bin2Object will automatically read a uint if the file is 32-bit public long[] ReadMappedWordArray(ulong uiAddr, int count) => ReadArray(MapVATR(uiAddr), count); public string ReadMappedNullTerminatedString(ulong uiAddr) => ReadNullTerminatedString(MapVATR(uiAddr)); // Reads a list of pointers, then reads each object pointed to public List ReadMappedObjectPointerArray(ulong uiAddr, int count) where U : new() { var pointers = ReadMappedArray(uiAddr, count); var array = new List(); for (int i = 0; i < count; i++) array.Add(ReadMappedObject(pointers[i])); return array; } } }