diff --git a/Il2CppDumper/Il2CppCSharpDumper.cs b/Il2CppDumper/Il2CppCSharpDumper.cs index 1503b25..d2dc708 100644 --- a/Il2CppDumper/Il2CppCSharpDumper.cs +++ b/Il2CppDumper/Il2CppCSharpDumper.cs @@ -23,6 +23,9 @@ namespace Il2CppInspector // Suppress types, fields and methods with the CompilerGenerated attribute; suppress the attribute itself from property getters and setters public bool SuppressGenerated { get; set; } + // Suppress binary metadata in code comments + public bool SuppressMetadata { get; set; } + private const string CGAttribute = "System.Runtime.CompilerServices.CompilerGeneratedAttribute"; private const string FBAttribute = "System.Runtime.CompilerServices.FixedBufferAttribute"; private const string ExtAttribute = "System.Runtime.CompilerServices.ExtensionAttribute"; @@ -158,7 +161,7 @@ namespace Il2CppInspector text.Append($"// Image {asm.Index}: {asm.FullName} - {asm.ImageDefinition.typeStart}\n"); // Assembly-level attributes - text.Append(asm.CustomAttributes.Where(a => a.AttributeType.FullName != ExtAttribute).OrderBy(a => a.AttributeType.Name).ToString(attributePrefix: "assembly: ")); + text.Append(asm.CustomAttributes.Where(a => a.AttributeType.FullName != ExtAttribute).OrderBy(a => a.AttributeType.Name).ToString(attributePrefix: "assembly: ", emitPointer: !SuppressMetadata)); if (asm.CustomAttributes.Any()) text.Append("\n"); } @@ -185,14 +188,16 @@ namespace Il2CppInspector sb.Append(prefix + "\t[NonSerialized]\n"); // Attributes - sb.Append(field.CustomAttributes.Where(a => a.AttributeType.FullName != FBAttribute).OrderBy(a => a.AttributeType.Name).ToString(prefix + "\t")); + sb.Append(field.CustomAttributes.Where(a => a.AttributeType.FullName != FBAttribute).OrderBy(a => a.AttributeType.Name).ToString(prefix + "\t", emitPointer: !SuppressMetadata)); sb.Append(prefix + "\t"); sb.Append(field.GetModifierString()); // Fixed buffers - if (field.GetCustomAttributes(FBAttribute).Any()) - sb.Append($"/* {((ulong) field.GetCustomAttributes(FBAttribute)[0].VirtualAddress).ToAddressString()} */" + - $" {field.FieldType.DeclaredFields[0].FieldType.CSharpName} {field.Name}[0]"); // FixedElementField + if (field.GetCustomAttributes(FBAttribute).Any()) { + if (!SuppressMetadata) + sb.Append($"/* {((ulong) field.GetCustomAttributes(FBAttribute)[0].VirtualAddress).ToAddressString()} */ "); + sb.Append($"{field.FieldType.DeclaredFields[0].FieldType.CSharpName} {field.Name}[0]"); // FixedElementField + } // Regular fields else sb.Append($"{field.FieldType.CSharpName} {field.Name}"); @@ -200,7 +205,7 @@ namespace Il2CppInspector sb.Append($" = {field.DefaultValueString}"); sb.Append(";"); // Don't output field indices for const fields (they don't have any storage) - if (!field.IsLiteral) + if (!field.IsLiteral && !SuppressMetadata) sb.Append($" // 0x{(uint) field.Offset:X2}"); sb.Append("\n"); } @@ -211,7 +216,7 @@ namespace Il2CppInspector sb.Clear(); foreach (var prop in type.DeclaredProperties) { // Attributes - sb.Append(prop.CustomAttributes.OrderBy(a => a.AttributeType.Name).ToString(prefix + "\t")); + sb.Append(prop.CustomAttributes.OrderBy(a => a.AttributeType.Name).ToString(prefix + "\t", emitPointer: !SuppressMetadata)); // The access mask enum values go from 1 (private) to 6 (public) in order from most to least restrictive var getAccess = (prop.GetMethod?.Attributes ?? 0) & MethodAttributes.MemberAccessMask; @@ -225,16 +230,20 @@ namespace Il2CppInspector sb.Append($"{prop.Name} {{ "); // Indexer else - sb.Append("this[" + string.Join(", ", primary.DeclaredParameters.SkipLast(getAccess >= setAccess? 0 : 1).Select(p => p.GetParameterString())) + "] { "); + sb.Append("this[" + string.Join(", ", primary.DeclaredParameters.SkipLast(getAccess >= setAccess? 0 : 1).Select(p => p.GetParameterString(!SuppressMetadata))) + "] { "); - sb.Append((prop.CanRead? prop.GetMethod.CustomAttributes.Where(a => !SuppressGenerated || a.AttributeType.FullName != CGAttribute).ToString(inline: true) + sb.Append((prop.CanRead? prop.GetMethod.CustomAttributes.Where(a => !SuppressGenerated || a.AttributeType.FullName != CGAttribute).ToString(inline: true, emitPointer: !SuppressMetadata) + (getAccess < setAccess? prop.GetMethod.GetAccessModifierString() : "") + "get; " : "") - + (prop.CanWrite? prop.SetMethod.CustomAttributes.Where(a => !SuppressGenerated || a.AttributeType.FullName != CGAttribute).ToString(inline: true) + + (prop.CanWrite? prop.SetMethod.CustomAttributes.Where(a => !SuppressGenerated || a.AttributeType.FullName != CGAttribute).ToString(inline: true, emitPointer: !SuppressMetadata) + (setAccess < getAccess? prop.SetMethod.GetAccessModifierString() : "") + "set; " : "") + "}"); - if ((prop.CanRead && prop.GetMethod.VirtualAddress != 0) || (prop.CanWrite && prop.SetMethod.VirtualAddress != 0)) - sb.Append(" // "); - sb.Append((prop.CanRead && prop.GetMethod.VirtualAddress != 0 ? prop.GetMethod.VirtualAddress.ToAddressString() + " " : "") - + (prop.CanWrite && prop.SetMethod.VirtualAddress != 0 ? prop.SetMethod.VirtualAddress.ToAddressString() : "") + "\n"); + if (!SuppressMetadata) { + if ((prop.CanRead && prop.GetMethod.VirtualAddress != 0) || (prop.CanWrite && prop.SetMethod.VirtualAddress != 0)) + sb.Append(" // "); + sb.Append((prop.CanRead && prop.GetMethod.VirtualAddress != 0 ? prop.GetMethod.VirtualAddress.ToAddressString() + " " : "") + + (prop.CanWrite && prop.SetMethod.VirtualAddress != 0 ? prop.SetMethod.VirtualAddress.ToAddressString() : "")); + } + sb.Append("\n"); + usedMethods.Add(prop.GetMethod); usedMethods.Add(prop.SetMethod); } @@ -244,7 +253,7 @@ namespace Il2CppInspector sb.Clear(); foreach (var evt in type.DeclaredEvents) { // Attributes - sb.Append(evt.CustomAttributes.OrderBy(a => a.AttributeType.Name).ToString(prefix + "\t")); + sb.Append(evt.CustomAttributes.OrderBy(a => a.AttributeType.Name).ToString(prefix + "\t", emitPointer: !SuppressMetadata)); string modifiers = evt.AddMethod?.GetModifierString(); sb.Append($"{prefix}\t{modifiers}event {evt.EventHandlerType.CSharpName} {evt.Name} {{\n"); @@ -252,7 +261,7 @@ namespace Il2CppInspector if (evt.AddMethod != null) m.Add("add", evt.AddMethod.VirtualAddress); if (evt.RemoveMethod != null) m.Add("remove", evt.RemoveMethod.VirtualAddress); if (evt.RaiseMethod != null) m.Add("raise", evt.RaiseMethod.VirtualAddress); - sb.Append(string.Join("\n", m.Select(x => $"{prefix}\t\t{x.Key}; // {x.Value.ToAddressString()}")) + "\n" + prefix + "\t}\n"); + sb.Append(string.Join("\n", m.Select(x => $"{prefix}\t\t{x.Key};{(SuppressMetadata? "" : " // " + x.Value.ToAddressString())}")) + "\n" + prefix + "\t}\n"); usedMethods.Add(evt.AddMethod); usedMethods.Add(evt.RemoveMethod); usedMethods.Add(evt.RaiseMethod); @@ -266,11 +275,11 @@ namespace Il2CppInspector sb.Clear(); foreach (var method in type.DeclaredConstructors) { // Attributes - sb.Append(method.CustomAttributes.OrderBy(a => a.AttributeType.Name).ToString(prefix + "\t")); + sb.Append(method.CustomAttributes.OrderBy(a => a.AttributeType.Name).ToString(prefix + "\t", emitPointer: !SuppressMetadata)); sb.Append($"{prefix}\t{method.GetModifierString()}{method.DeclaringType.UnmangledBaseName}{method.GetTypeParametersString()}("); - sb.Append(method.GetParametersString()); - sb.Append(");" + (method.VirtualAddress != 0 ? $" // {method.VirtualAddress.ToAddressString()}" : "") + "\n"); + sb.Append(method.GetParametersString(!SuppressMetadata) + ");"); + sb.Append((!SuppressMetadata && method.VirtualAddress != 0 ? $" // {method.VirtualAddress.ToAddressString()}" : "") + "\n"); } codeBlocks.Add("Constructors", sb.ToString()); @@ -294,7 +303,7 @@ namespace Il2CppInspector // TODO: DefaultMemberAttribute should be output if it is present and the type does not have an indexer, otherwise suppressed // See https://docs.microsoft.com/en-us/dotnet/api/system.reflection.defaultmemberattribute?view=netframework-4.8 sb.Append(type.CustomAttributes.Where(a => a.AttributeType.FullName != DMAttribute && a.AttributeType.FullName != ExtAttribute) - .OrderBy(a => a.AttributeType.Name).ToString(prefix)); + .OrderBy(a => a.AttributeType.Name).ToString(prefix, emitPointer: !SuppressMetadata)); // Roll-up multicast delegates to use the 'delegate' syntactic sugar if (type.IsClass && type.IsSealed && type.BaseType?.FullName == "System.MulticastDelegate") { @@ -302,12 +311,14 @@ namespace Il2CppInspector var del = type.GetMethod("Invoke"); // IL2CPP doesn't seem to retain return type attributes - //sb.Append(del.ReturnType.CustomAttributes.ToString(prefix, "return: ")); + //sb.Append(del.ReturnType.CustomAttributes.ToString(prefix, "return: ", emitPointer: !SuppressMetadata)); if (del.RequiresUnsafeContext) sb.Append("unsafe "); sb.Append($"delegate {del.ReturnType.CSharpName} {type.CSharpTypeDeclarationName}("); - sb.Append(del.GetParametersString()); - sb.Append($"); // TypeDefIndex: {type.Index}; {del.VirtualAddress.ToAddressString()}\n"); + sb.Append(del.GetParametersString(!SuppressMetadata) + ");"); + if (!SuppressMetadata) + sb.Append($" // TypeDefIndex: {type.Index}; {del.VirtualAddress.ToAddressString()}"); + sb.Append("\n"); return sb.ToString(); } @@ -320,7 +331,10 @@ namespace Il2CppInspector @base.Insert(0, type.GetEnumUnderlyingType().CSharpName); var baseText = @base.Count > 0 ? " : " + string.Join(", ", @base) : string.Empty; - sb.Append($"{type.CSharpTypeDeclarationName}{baseText} // TypeDefIndex: {type.Index}\n"); + sb.Append($"{type.CSharpTypeDeclarationName}{baseText}"); + if (!SuppressMetadata) + sb.Append($" // TypeDefIndex: {type.Index}"); + sb.Append("\n"); if (type.GenericTypeParameters != null) foreach (var gp in type.GenericTypeParameters) { @@ -352,16 +366,16 @@ namespace Il2CppInspector var writer = new StringBuilder(); // Attributes - writer.Append(method.CustomAttributes.Where(a => a.AttributeType.FullName != ExtAttribute).OrderBy(a => a.AttributeType.Name).ToString(prefix + "\t")); + writer.Append(method.CustomAttributes.Where(a => a.AttributeType.FullName != ExtAttribute).OrderBy(a => a.AttributeType.Name).ToString(prefix + "\t", emitPointer: !SuppressMetadata)); // IL2CPP doesn't seem to retain return type attributes - //writer.Append(method.ReturnType.CustomAttributes.ToString(prefix + "\t", "return: ")); + //writer.Append(method.ReturnType.CustomAttributes.ToString(prefix + "\t", "return: ", emitPointer: !SuppressMetadata)); writer.Append($"{prefix}\t{method.GetModifierString()}"); if (method.Name != "op_Implicit" && method.Name != "op_Explicit") writer.Append($"{method.ReturnParameter.GetReturnParameterString()} {method.CSharpName}{method.GetTypeParametersString()}"); else writer.Append($"{method.CSharpName}{method.ReturnType.CSharpName}"); - writer.Append("(" + method.GetParametersString() + ")"); + writer.Append("(" + method.GetParametersString(!SuppressMetadata) + ")"); if (method.GenericTypeParameters != null) foreach (var gp in method.GenericTypeParameters) { @@ -370,7 +384,7 @@ namespace Il2CppInspector writer.Append($"\n{prefix}\t\t{constraint}"); } - writer.Append(";" + (method.VirtualAddress != 0 ? $" // {method.VirtualAddress.ToAddressString()}" : "") + "\n"); + writer.Append(";" + (!SuppressMetadata && method.VirtualAddress != 0 ? $" // {method.VirtualAddress.ToAddressString()}" : "") + "\n"); return writer.ToString(); } diff --git a/Il2CppDumper/Program.cs b/Il2CppDumper/Program.cs index f80ac8f..513f179 100644 --- a/Il2CppDumper/Program.cs +++ b/Il2CppDumper/Program.cs @@ -48,6 +48,9 @@ namespace Il2CppInspector [Option('g', "no-suppress-cg", Required = false, HelpText = "Don't suppress generation of C# code for items with CompilerGenerated attribute", Default = false)] public bool DontSuppressCompilerGenerated { get; set; } + + [Option('n', "suppress-metadata", Required = false, HelpText = "Suppress method pointers, field offsets and type indices from C# output. Useful for comparing two versions of a binary for changes with a diff tool", Default = false)] + public bool SuppressMetadata { get; set; } } public static int Main(string[] args) => @@ -84,7 +87,8 @@ namespace Il2CppInspector // C# signatures output var writer = new Il2CppCSharpDumper(model) { ExcludedNamespaces = options.ExcludedNamespaces.ToList(), - SuppressGenerated = !options.DontSuppressCompilerGenerated + SuppressGenerated = !options.DontSuppressCompilerGenerated, + SuppressMetadata = options.SuppressMetadata }; var imageSuffix = i++ > 0 ? "-" + (i - 1) : ""; diff --git a/Il2CppInspector/Reflection/Extensions.cs b/Il2CppInspector/Reflection/Extensions.cs index a2bf237..1139081 100644 --- a/Il2CppInspector/Reflection/Extensions.cs +++ b/Il2CppInspector/Reflection/Extensions.cs @@ -7,7 +7,7 @@ namespace Il2CppInspector.Reflection public static class Extensions { // Convert a list of CustomAttributeData objects into C#-friendly attribute usages - public static string ToString(this IEnumerable attributes, string linePrefix = "", string attributePrefix = "", bool inline = false) { + public static string ToString(this IEnumerable attributes, string linePrefix = "", string attributePrefix = "", bool inline = false, bool emitPointer = false) { var sb = new StringBuilder(); foreach (var cad in attributes) { @@ -15,7 +15,10 @@ namespace Il2CppInspector.Reflection var suffix = name.LastIndexOf("Attribute", StringComparison.Ordinal); if (suffix != -1) name = name[..suffix]; - sb.Append($"{linePrefix}[{attributePrefix}{name}] {(inline? "/*" : "//")} {((ulong)cad.VirtualAddress).ToAddressString()}{(inline? " */ " : "\n")}"); + sb.Append($"{linePrefix}[{attributePrefix}{name}]"); + if (emitPointer) + sb.Append($" {(inline? "/*" : "//")} {((ulong)cad.VirtualAddress).ToAddressString()}{(inline? " */" : "")}"); + sb.Append(inline? " ":"\n"); } return sb.ToString(); diff --git a/Il2CppInspector/Reflection/MethodBase.cs b/Il2CppInspector/Reflection/MethodBase.cs index e113961..ae574d0 100644 --- a/Il2CppInspector/Reflection/MethodBase.cs +++ b/Il2CppInspector/Reflection/MethodBase.cs @@ -163,7 +163,7 @@ namespace Il2CppInspector.Reflection } // Get C# syntax-friendly list of parameters - public string GetParametersString() => string.Join(", ", DeclaredParameters.Select(p => p.GetParameterString())); + public string GetParametersString(bool emitPointer = false) => string.Join(", ", DeclaredParameters.Select(p => p.GetParameterString(emitPointer))); public string GetTypeParametersString() => GenericTypeParameters == null? "" : "<" + string.Join(", ", GenericTypeParameters.Select(p => p.CSharpName)) + ">"; diff --git a/Il2CppInspector/Reflection/ParameterInfo.cs b/Il2CppInspector/Reflection/ParameterInfo.cs index ec4860a..b5f3ae8 100644 --- a/Il2CppInspector/Reflection/ParameterInfo.cs +++ b/Il2CppInspector/Reflection/ParameterInfo.cs @@ -96,9 +96,9 @@ namespace Il2CppInspector.Reflection private string getCSharpSignatureString() => $"{GetModifierString()}{ParameterType.CSharpName}"; public string GetSignatureString() => $"{GetModifierString()}{ParameterType.FullName}"; - public string GetParameterString() => IsRetval? null : + public string GetParameterString(bool emitPointer = false) => IsRetval? null : (Position == 0 && Member.GetCustomAttributes("System.Runtime.CompilerServices.ExtensionAttribute").Any()? "this ":"") - + $"{CustomAttributes.ToString(inline: true).Replace("[ParamArray]", "params")}" + + $"{CustomAttributes.ToString(inline: true, emitPointer: emitPointer).Replace("[ParamArray]", "params")}" + $"{getCSharpSignatureString()} {Name}" + (HasDefaultValue ? " = " + DefaultValue.ToCSharpValue() : ""); diff --git a/Il2CppTests/TestRunner.cs b/Il2CppTests/TestRunner.cs index 9742b9d..4458f99 100644 --- a/Il2CppTests/TestRunner.cs +++ b/Il2CppTests/TestRunner.cs @@ -54,7 +54,7 @@ namespace Il2CppInspector // Dump each image in the binary separately int i = 0; foreach (var il2cpp in inspectors) - new Il2CppCSharpDumper(new Il2CppModel(il2cpp)) {ExcludedNamespaces = excludedNamespaces, SuppressGenerated = true} + new Il2CppCSharpDumper(new Il2CppModel(il2cpp)) {ExcludedNamespaces = excludedNamespaces, SuppressGenerated = true, SuppressMetadata = false} .WriteSingleFile(testPath + @"\test-result" + (i++ > 0 ? "-" + (i - 1) : "") + ".cs"); // Compare test result with expected result diff --git a/README.md b/README.md index 8eca973..fd07c1e 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ # Il2CppInspector -Extract types, methods, properties and fields from Unity IL2CPP binaries. +Easily extract types and metadata from IL2CPP binaries. * **No manual reverse-engineering required; all data is calculated automatically!** * Supports ELF (Android .so), PE (Windows .exe), Mach-O (Apple iOS/Mac) and Universal Binary (Fat Mach-O) file formats @@ -13,7 +13,7 @@ Extract types, methods, properties and fields from Unity IL2CPP binaries. * Dynamic symbol table scanning for ELF binaries if present * Symbol relocation handling for ELF binaries * **Il2CppInspector** re-usable class library for low-level access to IL2CPP binaries and metadata -* **Il2CppReflector** re-usable class library for high-level .NET Reflection-style access to IL2CPP types and data as a tree model +* **Il2CppModel** re-usable class library for high-level .NET Reflection-style access to IL2CPP types and data as a tree model * Test chassis for automated integration testing of IL2CPP binaries Class library targets .NET Standard 2.1. Application targets .NET Core 3.0. Built with Visual Studio 2019. @@ -45,6 +45,7 @@ File format and architecture are automatically detected. -s, --sort (Default: index) Sort order of type definitions in C# output ('index' = by type definition index, 'name' = by type name). No effect when using file-per-class layout -f, --flatten (Default: false) Flatten the namespace hierarchy into a single folder rather than using per-namespace subfolders. Only used when layout is per-namespace or per-class -g, --no-suppress-cg (Default: false) Don't suppress generation of C# code for items with CompilerGenerated attribute + -n, --suppress-metadata (Default: false) Suppress method pointers, field offsets and type indices from C# output. Useful for comparing two versions of a binary for changes with a diff tool ``` Defaults if not specified: