Struct reading and disassembly script overhaul, various misc. loading fixes, bump to .NET 9 (#13)
* Bump projects to .net 9 and update nugets * add VersionedSerialization + source generator * migrate versioning to StructVersion class, add handling/detection for 29.2/31.2 * add new struct definitions * rename serialization methods and add BinaryObjectStreamReader for interop * Rework metadata struct loading to use new struct versioning * move 29/31.1/.2 to use tags (-2022,-2023) instead of minor versions * fix metadata usage validity checks * rework code registration offsetting a bit and add second 29/31.1 condition * tweak .1 condition (again) * 29/31.2 was a psyop * also remove 29.2 from the readme * remove loading of packed dlls - this was a very unsafe feature * support auto-recovering type indices from type handles fixes loading of memory-dumped v29+ libraries since those replacee their class indices on load with a pointer to the corresponding type * support loading PEs without an export table * also read UnresolvedVirtualCallCount on regular v31 * Disable plugin loading for now * Overhaul disassembler script + add Binary Ninja target (#12) * Overhaul diassembler scripts: - No longer defines top level functions - Split into three classes: StatusHandler (like before), DisassemblerInterface (for interfacing with the used program API), ScriptContext (for definiting general functions that use the disassembler interface) - Add type annotations to all class methods and remove 2.7 compatibility stuff (Ghidra now supports Python 3 so this is unnecessary anymore) - Disassembler backends are now responsible for launching metadata/script processing, to better support disassembler differences - String handling is back in the base ScriptContext class, disassembler interfaces opt into the fake string segment creation and fall back to the old method if it isn't supported * Add Binary Ninja disassembler script backend This uses the new backend-controlled execution to launch metadata processing on a background thread to keep the ui responsive * make binary ninja script use own _BINARYNINJA_ define and add define helpers to header * Update README to account for new script and binary ninja backend * implement fake string segment functions for binary ninja but don't advertise support * also cache API function types in binary ninja backend * fix ida script and disable folders again * Fix metadata usage issues caused by it being a value type now * make TryMapVATR overrideable and implement it for ELFs * Make field offset reading use TryMapVATR to reduce exceptions * Fix NRE in Assembly ctor on < v24.2 * Update actions workflow to produce cross-platform CLI binaries, update readme to reflect .net 9 changes * workflow: only restore packages for projects that are being built * workflow: tweak caching and fix gui compilation * workflow: remove double .zip in CLI artifact name * 29/31.2 don't actually exist, this logic is not needed
This commit is contained in:
Luke
367
VersionedSerialization.Generator/ObjectSerializationGenerator.cs
Normal file
367
VersionedSerialization.Generator/ObjectSerializationGenerator.cs
Normal file
@@ -0,0 +1,367 @@
|
||||
using System;
|
||||
using System.Collections.Generic;
|
||||
using System.Linq;
|
||||
using System.Threading;
|
||||
using Microsoft.CodeAnalysis;
|
||||
using Microsoft.CodeAnalysis.CSharp;
|
||||
using Microsoft.CodeAnalysis.CSharp.Syntax;
|
||||
using VersionedSerialization.Generator.Models;
|
||||
using VersionedSerialization.Generator.Utils;
|
||||
|
||||
namespace VersionedSerialization.Generator
|
||||
{
|
||||
[Generator]
|
||||
public sealed class ObjectSerializationGenerator : IIncrementalGenerator
|
||||
{
|
||||
public void Initialize(IncrementalGeneratorInitializationContext context)
|
||||
{
|
||||
//Debugger.Launch();
|
||||
|
||||
var valueProvider = context.SyntaxProvider
|
||||
.ForAttributeWithMetadataName(Constants.VersionedStructAttribute,
|
||||
static (node, _) => node is ClassDeclarationSyntax or StructDeclarationSyntax or RecordDeclarationSyntax,
|
||||
static (context, _) => (ContextClass: (TypeDeclarationSyntax)context.TargetNode, context.SemanticModel))
|
||||
.Combine(context.CompilationProvider)
|
||||
.Select(static (tuple, cancellationToken) => ParseSerializationInfo(tuple.Left.ContextClass, tuple.Left.SemanticModel, tuple.Right, cancellationToken))
|
||||
.WithTrackingName(nameof(ObjectSerializationGenerator));
|
||||
|
||||
context.RegisterSourceOutput(valueProvider, EmitCode);
|
||||
}
|
||||
|
||||
private static void EmitCode(SourceProductionContext sourceProductionContext, ObjectSerializationInfo info)
|
||||
{
|
||||
var generator = new CodeGenerator();
|
||||
generator.AppendLine("#nullable restore");
|
||||
generator.AppendLine("using VersionedSerialization;");
|
||||
generator.AppendLine();
|
||||
|
||||
generator.AppendLine($"namespace {info.Namespace};");
|
||||
|
||||
var versions = new HashSet<StructVersion>();
|
||||
foreach (var condition in info.Properties.SelectMany(static x => x.VersionConditions))
|
||||
{
|
||||
if (condition.LessThan.HasValue)
|
||||
versions.Add(condition.LessThan.Value);
|
||||
|
||||
if (condition.GreaterThan.HasValue)
|
||||
versions.Add(condition.GreaterThan.Value);
|
||||
|
||||
if (condition.EqualTo.HasValue)
|
||||
versions.Add(condition.EqualTo.Value);
|
||||
}
|
||||
|
||||
if (versions.Count > 0)
|
||||
{
|
||||
generator.EnterScope("file static class Versions");
|
||||
|
||||
foreach (var version in versions)
|
||||
{
|
||||
generator.AppendLine($"public static readonly StructVersion {GetVersionIdentifier(version)} = \"{version}\";");
|
||||
}
|
||||
|
||||
generator.LeaveScope();
|
||||
}
|
||||
|
||||
var definitionType = info.DefinitionType switch
|
||||
{
|
||||
SyntaxKind.ClassDeclaration => "class",
|
||||
SyntaxKind.StructDeclaration => "struct",
|
||||
SyntaxKind.RecordDeclaration => "record",
|
||||
SyntaxKind.RecordStructDeclaration => "record struct",
|
||||
_ => throw new IndexOutOfRangeException()
|
||||
};
|
||||
|
||||
generator.EnterScope($"public partial {definitionType} {info.Name} : IReadable");
|
||||
GenerateReadMethod(generator, info);
|
||||
generator.AppendLine();
|
||||
GenerateSizeMethod(generator, info);
|
||||
generator.LeaveScope();
|
||||
|
||||
sourceProductionContext.AddSource($"{info.Namespace}.{info.Name}.g.cs", generator.ToString());
|
||||
}
|
||||
|
||||
private static void GenerateSizeMethod(CodeGenerator generator, ObjectSerializationInfo info)
|
||||
{
|
||||
generator.EnterScope("public static int Size(in StructVersion version = default, bool is32Bit = false)");
|
||||
|
||||
if (!info.CanGenerateSizeMethod)
|
||||
{
|
||||
generator.AppendLine("throw new InvalidOperationException(\"No size can be calculated for this struct.\");");
|
||||
}
|
||||
else
|
||||
{
|
||||
generator.AppendLine("var size = 0;");
|
||||
if (info.HasBaseType)
|
||||
generator.AppendLine("size += base.Size(in version, is32Bit);");
|
||||
|
||||
foreach (var property in info.Properties)
|
||||
{
|
||||
if (property.VersionConditions.Length > 0)
|
||||
GenerateVersionCondition(property.VersionConditions, generator);
|
||||
|
||||
generator.EnterScope();
|
||||
generator.AppendLine($"size += {property.SizeExpression};");
|
||||
generator.LeaveScope();
|
||||
}
|
||||
|
||||
generator.AppendLine("return size;");
|
||||
}
|
||||
|
||||
generator.LeaveScope();
|
||||
}
|
||||
|
||||
private static void GenerateReadMethod(CodeGenerator generator, ObjectSerializationInfo info)
|
||||
{
|
||||
generator.EnterScope("public void Read<TReader>(ref TReader reader, in StructVersion version = default) where TReader : IReader, allows ref struct");
|
||||
|
||||
if (info.HasBaseType)
|
||||
generator.AppendLine("base.Read(ref reader, in version);");
|
||||
|
||||
foreach (var property in info.Properties)
|
||||
{
|
||||
if (property.VersionConditions.Length > 0)
|
||||
GenerateVersionCondition(property.VersionConditions, generator);
|
||||
|
||||
generator.EnterScope();
|
||||
generator.AppendLine($"this.{property.Name} = {property.ReadMethod}");
|
||||
generator.LeaveScope();
|
||||
}
|
||||
|
||||
generator.LeaveScope();
|
||||
}
|
||||
|
||||
private static string GetVersionIdentifier(StructVersion version)
|
||||
=> $"V{version.Major}_{version.Minor}{(version.Tag == null ? "" : $"_{version.Tag}")}";
|
||||
|
||||
private static void GenerateVersionCondition(ImmutableEquatableArray<VersionCondition> conditions,
|
||||
CodeGenerator generator)
|
||||
{
|
||||
generator.AppendLine("if (");
|
||||
generator.IncreaseIndentation();
|
||||
|
||||
for (var i = 0; i < conditions.Length; i++)
|
||||
{
|
||||
generator.AppendLine("(true");
|
||||
|
||||
var condition = conditions[i];
|
||||
if (condition.LessThan.HasValue)
|
||||
generator.AppendLine($"&& Versions.{GetVersionIdentifier(condition.LessThan.Value)} >= version");
|
||||
|
||||
if (condition.GreaterThan.HasValue)
|
||||
generator.AppendLine($"&& version >= Versions.{GetVersionIdentifier(condition.GreaterThan.Value)}");
|
||||
|
||||
if (condition.EqualTo.HasValue)
|
||||
generator.AppendLine($"&& version == Versions.{GetVersionIdentifier(condition.EqualTo.Value)}");
|
||||
|
||||
if (condition.IncludingTag != null)
|
||||
generator.AppendLine(condition.IncludingTag == ""
|
||||
? "&& version.Tag == null"
|
||||
: $"&& version.Tag == \"{condition.IncludingTag}\"");
|
||||
|
||||
if (condition.ExcludingTag != null)
|
||||
generator.AppendLine(condition.IncludingTag == ""
|
||||
? "&& version.Tag != null"
|
||||
: $"&& version.Tag != \"{condition.IncludingTag}\"");
|
||||
|
||||
generator.AppendLine(")");
|
||||
|
||||
if (i != conditions.Length - 1)
|
||||
generator.AppendLine("||");
|
||||
}
|
||||
|
||||
generator.DecreaseIndentation();
|
||||
generator.AppendLine(")");
|
||||
}
|
||||
|
||||
private static ObjectSerializationInfo ParseSerializationInfo(TypeDeclarationSyntax contextClass,
|
||||
SemanticModel model, Compilation compilation,
|
||||
CancellationToken cancellationToken)
|
||||
{
|
||||
var classSymbol = model.GetDeclaredSymbol(contextClass, cancellationToken) ?? throw new InvalidOperationException();
|
||||
|
||||
//var versionedStructAttribute = compilation.GetTypeByMetadataName(Constants.VersionedStructAttribute);
|
||||
var versionConditionAttribute = compilation.GetTypeByMetadataName(Constants.VersionConditionAttribute);
|
||||
var customSerializationAttribute = compilation.GetTypeByMetadataName(Constants.CustomSerializationAttribute);
|
||||
var nativeIntegerAttribute = compilation.GetTypeByMetadataName(Constants.NativeIntegerAttribute);
|
||||
|
||||
var canGenerateSizeMethod = true;
|
||||
|
||||
var properties = new List<PropertySerializationInfo>();
|
||||
foreach (var member in classSymbol.GetMembers())
|
||||
{
|
||||
if (member.IsStatic
|
||||
|| member is IFieldSymbol { AssociatedSymbol: not null }
|
||||
|| member is IPropertySymbol { SetMethod: null })
|
||||
continue;
|
||||
|
||||
var versionConditions = new List<VersionCondition>();
|
||||
|
||||
ITypeSymbol type;
|
||||
switch (member)
|
||||
{
|
||||
case IFieldSymbol field:
|
||||
type = field.Type;
|
||||
break;
|
||||
case IPropertySymbol property:
|
||||
type = property.Type;
|
||||
break;
|
||||
default:
|
||||
continue;
|
||||
}
|
||||
|
||||
var typeInfo = ParseType(type);
|
||||
string? readMethod = null;
|
||||
string? sizeExpression = null;
|
||||
|
||||
foreach (var attribute in member.GetAttributes())
|
||||
{
|
||||
if (SymbolEqualityComparer.Default.Equals(attribute.AttributeClass, versionConditionAttribute))
|
||||
{
|
||||
StructVersion? lessThan = null,
|
||||
moreThan = null,
|
||||
equalTo = null;
|
||||
|
||||
string? includingTag = null,
|
||||
excludingTag = null;
|
||||
|
||||
foreach (var argument in attribute.NamedArguments)
|
||||
{
|
||||
switch (argument.Key)
|
||||
{
|
||||
case Constants.LessThan:
|
||||
lessThan = (StructVersion)(string)argument.Value.Value!;
|
||||
break;
|
||||
case Constants.GreaterThan:
|
||||
moreThan = (StructVersion)(string)argument.Value.Value!;
|
||||
break;
|
||||
case Constants.EqualTo:
|
||||
equalTo = (StructVersion)(string)argument.Value.Value!;
|
||||
break;
|
||||
case Constants.IncludingTag:
|
||||
includingTag = (string)argument.Value.Value!;
|
||||
break;
|
||||
case Constants.ExcludingTag:
|
||||
excludingTag = (string)argument.Value.Value!;
|
||||
break;
|
||||
default:
|
||||
throw new ArgumentOutOfRangeException();
|
||||
}
|
||||
}
|
||||
|
||||
versionConditions.Add(new VersionCondition(lessThan, moreThan, equalTo, includingTag, excludingTag));
|
||||
}
|
||||
else if (SymbolEqualityComparer.Default.Equals(attribute.AttributeClass, customSerializationAttribute))
|
||||
{
|
||||
typeInfo = (PropertyType.Custom, "", typeInfo.IsArray);
|
||||
readMethod = (string)attribute.ConstructorArguments[0].Value!;
|
||||
sizeExpression = (string)attribute.ConstructorArguments[1].Value!;
|
||||
}
|
||||
else if (SymbolEqualityComparer.Default.Equals(attribute.AttributeClass, nativeIntegerAttribute))
|
||||
{
|
||||
typeInfo = (typeInfo.Type.IsUnsignedType()
|
||||
? PropertyType.UNativeInteger
|
||||
: PropertyType.NativeInteger,
|
||||
typeInfo.ComplexTypeName == ""
|
||||
? typeInfo.Type.GetTypeName()
|
||||
: typeInfo.ComplexTypeName,
|
||||
typeInfo.IsArray);
|
||||
}
|
||||
}
|
||||
|
||||
canGenerateSizeMethod &= typeInfo.Type != PropertyType.String;
|
||||
|
||||
if (readMethod == null)
|
||||
{
|
||||
if (typeInfo.Type == PropertyType.None)
|
||||
{
|
||||
readMethod = $"reader.ReadVersionedObject<{typeInfo.ComplexTypeName}>(in version);";
|
||||
}
|
||||
else
|
||||
{
|
||||
readMethod = typeInfo.Type.IsSeperateMethod()
|
||||
? $"reader.Read{typeInfo.Type.GetTypeName()}();"
|
||||
: $"reader.ReadPrimitive<{typeInfo.Type.GetTypeName()}>();";
|
||||
|
||||
if (typeInfo.ComplexTypeName != "")
|
||||
readMethod = $"({typeInfo.ComplexTypeName}){readMethod}";
|
||||
}
|
||||
}
|
||||
|
||||
sizeExpression ??= typeInfo.Type switch
|
||||
{
|
||||
PropertyType.None => $"{typeInfo.ComplexTypeName}.Size(in version, is32Bit)",
|
||||
PropertyType.NativeInteger or PropertyType.UNativeInteger =>
|
||||
"is32Bit ? sizeof(uint) : sizeof(ulong)",
|
||||
_ => $"sizeof({typeInfo.Type.GetTypeName()})"
|
||||
};
|
||||
|
||||
properties.Add(new PropertySerializationInfo(
|
||||
member.Name,
|
||||
readMethod,
|
||||
sizeExpression,
|
||||
typeInfo.Type,
|
||||
versionConditions.ToImmutableEquatableArray()
|
||||
));
|
||||
}
|
||||
|
||||
var hasBaseType = false;
|
||||
if (classSymbol.BaseType != null)
|
||||
{
|
||||
var objectSymbol = compilation.GetSpecialType(SpecialType.System_Object);
|
||||
var valueTypeSymbol = compilation.GetSpecialType(SpecialType.System_ValueType);
|
||||
|
||||
if (!SymbolEqualityComparer.Default.Equals(objectSymbol, classSymbol.BaseType)
|
||||
&& !SymbolEqualityComparer.Default.Equals(valueTypeSymbol, classSymbol.BaseType))
|
||||
hasBaseType = true;
|
||||
}
|
||||
|
||||
return new ObjectSerializationInfo(
|
||||
classSymbol.ContainingNamespace.ToDisplayString(),
|
||||
classSymbol.Name,
|
||||
hasBaseType,
|
||||
contextClass.Kind(),
|
||||
canGenerateSizeMethod,
|
||||
properties.ToImmutableEquatableArray()
|
||||
);
|
||||
}
|
||||
|
||||
private static (PropertyType Type, string ComplexTypeName, bool IsArray) ParseType(ITypeSymbol typeSymbol)
|
||||
{
|
||||
switch (typeSymbol)
|
||||
{
|
||||
case IArrayTypeSymbol arrayTypeSymbol:
|
||||
{
|
||||
var elementType = ParseType(arrayTypeSymbol.ElementType);
|
||||
return (elementType.Type, elementType.ComplexTypeName, true);
|
||||
}
|
||||
case INamedTypeSymbol { EnumUnderlyingType: not null } namedTypeSymbol:
|
||||
var res = ParseType(namedTypeSymbol.EnumUnderlyingType);
|
||||
return (res.Type, typeSymbol.ToDisplayString(SymbolDisplayFormat.FullyQualifiedFormat), false);
|
||||
}
|
||||
|
||||
if (typeSymbol.SpecialType != SpecialType.None)
|
||||
{
|
||||
var type = typeSymbol.SpecialType switch
|
||||
{
|
||||
SpecialType.System_Boolean => PropertyType.Boolean,
|
||||
SpecialType.System_Byte => PropertyType.UInt8,
|
||||
SpecialType.System_UInt16 => PropertyType.UInt16,
|
||||
SpecialType.System_UInt32 => PropertyType.UInt32,
|
||||
SpecialType.System_UInt64 => PropertyType.UInt64,
|
||||
SpecialType.System_SByte => PropertyType.Int8,
|
||||
SpecialType.System_Int16 => PropertyType.Int16,
|
||||
SpecialType.System_Int32 => PropertyType.Int32,
|
||||
SpecialType.System_Int64 => PropertyType.Int64,
|
||||
SpecialType.System_String => PropertyType.String,
|
||||
_ => PropertyType.Unsupported
|
||||
};
|
||||
|
||||
return (type, "", false);
|
||||
}
|
||||
|
||||
var complexType = typeSymbol.ToDisplayString(SymbolDisplayFormat.FullyQualifiedFormat);
|
||||
|
||||
return (PropertyType.None, complexType, false);
|
||||
}
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user