From a9343c9364246d3288b4e7f20919ca1ad2e1fd3e Mon Sep 17 00:00:00 2001 From: FICTURE7 Date: Tue, 14 Sep 2021 03:23:37 +0400 Subject: Refactor `PtcInfo` (#2625) * Refactor `PtcInfo` This change reduces the coupling of `PtcInfo` by moving relocation tracking to the backend. `RelocEntry`s remains as `RelocEntry`s through out the pipeline until it actually needs to be written to the PTC streams. Keeping this representation makes inspecting and manipulating relocations after compilations less painful. This is something I needed to do to patch relocations to 0 to diff dumps. Contributes to #1125. * Turn `Symbol` & `RelocInfo` into readonly structs * Add documentation to `CompiledFunction` * Remove `Compiler.Compile` Remove `Compiler.Compile` and replace it by `Map` of the `CompiledFunction` returned. --- ARMeilleure/Translation/PTC/Ptc.cs | 48 +++++++++----- ARMeilleure/Translation/PTC/PtcInfo.cs | 63 ------------------- ARMeilleure/Translation/PTC/RelocEntry.cs | 21 ------- ARMeilleure/Translation/PTC/Symbol.cs | 100 ------------------------------ ARMeilleure/Translation/PTC/SymbolType.cs | 28 --------- 5 files changed, 33 insertions(+), 227 deletions(-) delete mode 100644 ARMeilleure/Translation/PTC/PtcInfo.cs delete mode 100644 ARMeilleure/Translation/PTC/RelocEntry.cs delete mode 100644 ARMeilleure/Translation/PTC/Symbol.cs delete mode 100644 ARMeilleure/Translation/PTC/SymbolType.cs (limited to 'ARMeilleure/Translation/PTC') diff --git a/ARMeilleure/Translation/PTC/Ptc.cs b/ARMeilleure/Translation/PTC/Ptc.cs index 8d4f971b..ad2871d0 100644 --- a/ARMeilleure/Translation/PTC/Ptc.cs +++ b/ARMeilleure/Translation/PTC/Ptc.cs @@ -1,9 +1,9 @@ using ARMeilleure.CodeGen; +using ARMeilleure.CodeGen.Linking; using ARMeilleure.CodeGen.Unwinding; using ARMeilleure.CodeGen.X86; using ARMeilleure.Common; using ARMeilleure.Memory; -using ARMeilleure.Translation.Cache; using Ryujinx.Common; using Ryujinx.Common.Configuration; using Ryujinx.Common.Logging; @@ -727,15 +727,10 @@ namespace ARMeilleure.Translation.PTC UnwindInfo unwindInfo, bool highCq) { - CompiledFunction cFunc = new CompiledFunction(code, unwindInfo); + var cFunc = new CompiledFunction(code, unwindInfo, RelocInfo.Empty); + var gFunc = cFunc.Map(); - IntPtr codePtr = JitCache.Map(cFunc); - - GuestFunction gFunc = Marshal.GetDelegateForFunctionPointer(codePtr); - - TranslatedFunction tFunc = new TranslatedFunction(gFunc, callCounter, guestSize, highCq); - - return tFunc; + return new TranslatedFunction(gFunc, callCounter, guestSize, highCq); } private static void UpdateInfo(InfoEntry infoEntry) @@ -889,10 +884,14 @@ namespace ARMeilleure.Translation.PTC return XXHash128.ComputeHash(memory.GetSpan(address, checked((int)(guestSize)))); } - internal static void WriteInfoCodeRelocUnwindInfo(ulong address, ulong guestSize, Hash128 hash, bool highCq, PtcInfo ptcInfo) + internal static void WriteCompiledFunction(ulong address, ulong guestSize, Hash128 hash, bool highCq, CompiledFunction compiledFunc) { lock (_lock) { + byte[] code = compiledFunc.Code; + RelocInfo relocInfo = compiledFunc.RelocInfo; + UnwindInfo unwindInfo = compiledFunc.UnwindInfo; + InfoEntry infoEntry = new InfoEntry(); infoEntry.Address = address; @@ -900,18 +899,37 @@ namespace ARMeilleure.Translation.PTC infoEntry.Hash = hash; infoEntry.HighCq = highCq; infoEntry.Stubbed = false; - infoEntry.CodeLength = ptcInfo.Code.Length; - infoEntry.RelocEntriesCount = ptcInfo.RelocEntriesCount; + infoEntry.CodeLength = code.Length; + infoEntry.RelocEntriesCount = relocInfo.Entries.Length; SerializeStructure(_infosStream, infoEntry); - WriteCode(ptcInfo.Code.AsSpan()); + WriteCode(code.AsSpan()); // WriteReloc. - ptcInfo.RelocStream.WriteTo(_relocsStream); + using var relocInfoWriter = new BinaryWriter(_relocsStream, EncodingCache.UTF8NoBOM, true); + + foreach (RelocEntry entry in relocInfo.Entries) + { + relocInfoWriter.Write(entry.Position); + relocInfoWriter.Write((byte)entry.Symbol.Type); + relocInfoWriter.Write(entry.Symbol.Value); + } // WriteUnwindInfo. - ptcInfo.UnwindInfoStream.WriteTo(_unwindInfosStream); + using var unwindInfoWriter = new BinaryWriter(_unwindInfosStream, EncodingCache.UTF8NoBOM, true); + + unwindInfoWriter.Write(unwindInfo.PushEntries.Length); + + foreach (UnwindPushEntry unwindPushEntry in unwindInfo.PushEntries) + { + unwindInfoWriter.Write((int)unwindPushEntry.PseudoOp); + unwindInfoWriter.Write(unwindPushEntry.PrologOffset); + unwindInfoWriter.Write(unwindPushEntry.RegIndex); + unwindInfoWriter.Write(unwindPushEntry.StackOffsetOrAllocSize); + } + + unwindInfoWriter.Write(unwindInfo.PrologSize); } } diff --git a/ARMeilleure/Translation/PTC/PtcInfo.cs b/ARMeilleure/Translation/PTC/PtcInfo.cs deleted file mode 100644 index b28b2dc1..00000000 --- a/ARMeilleure/Translation/PTC/PtcInfo.cs +++ /dev/null @@ -1,63 +0,0 @@ -using ARMeilleure.CodeGen.Unwinding; -using System; -using System.IO; - -namespace ARMeilleure.Translation.PTC -{ - class PtcInfo : IDisposable - { - private readonly BinaryWriter _relocWriter; - private readonly BinaryWriter _unwindInfoWriter; - - public byte[] Code { get; set; } - - public MemoryStream RelocStream { get; } - public MemoryStream UnwindInfoStream { get; } - - public int RelocEntriesCount { get; private set; } - - public PtcInfo() - { - RelocStream = new MemoryStream(); - UnwindInfoStream = new MemoryStream(); - - _relocWriter = new BinaryWriter(RelocStream, EncodingCache.UTF8NoBOM, true); - _unwindInfoWriter = new BinaryWriter(UnwindInfoStream, EncodingCache.UTF8NoBOM, true); - - RelocEntriesCount = 0; - } - - public void WriteRelocEntry(RelocEntry relocEntry) - { - _relocWriter.Write((int)relocEntry.Position); - _relocWriter.Write((byte)relocEntry.Symbol.Type); - _relocWriter.Write((ulong)relocEntry.Symbol.Value); - - RelocEntriesCount++; - } - - public void WriteUnwindInfo(UnwindInfo unwindInfo) - { - _unwindInfoWriter.Write((int)unwindInfo.PushEntries.Length); - - foreach (UnwindPushEntry unwindPushEntry in unwindInfo.PushEntries) - { - _unwindInfoWriter.Write((int)unwindPushEntry.PseudoOp); - _unwindInfoWriter.Write((int)unwindPushEntry.PrologOffset); - _unwindInfoWriter.Write((int)unwindPushEntry.RegIndex); - _unwindInfoWriter.Write((int)unwindPushEntry.StackOffsetOrAllocSize); - } - - _unwindInfoWriter.Write((int)unwindInfo.PrologSize); - } - - public void Dispose() - { - _relocWriter.Dispose(); - _unwindInfoWriter.Dispose(); - - RelocStream.Dispose(); - UnwindInfoStream.Dispose(); - } - } -} \ No newline at end of file diff --git a/ARMeilleure/Translation/PTC/RelocEntry.cs b/ARMeilleure/Translation/PTC/RelocEntry.cs deleted file mode 100644 index 545612d0..00000000 --- a/ARMeilleure/Translation/PTC/RelocEntry.cs +++ /dev/null @@ -1,21 +0,0 @@ -namespace ARMeilleure.Translation.PTC -{ - struct RelocEntry - { - public const int Stride = 13; // Bytes. - - public int Position; - public Symbol Symbol; - - public RelocEntry(int position, Symbol symbol) - { - Position = position; - Symbol = symbol; - } - - public override string ToString() - { - return $"({nameof(Position)} = {Position}, {nameof(Symbol)} = {Symbol})"; - } - } -} \ No newline at end of file diff --git a/ARMeilleure/Translation/PTC/Symbol.cs b/ARMeilleure/Translation/PTC/Symbol.cs deleted file mode 100644 index f9d67742..00000000 --- a/ARMeilleure/Translation/PTC/Symbol.cs +++ /dev/null @@ -1,100 +0,0 @@ -using System; - -namespace ARMeilleure.Translation.PTC -{ - /// - /// Represents a symbol. - /// - struct Symbol - { - private readonly ulong _value; - - /// - /// Gets the of the . - /// - public SymbolType Type { get; } - - /// - /// Gets the value of the . - /// - /// is - public ulong Value - { - get - { - if (Type == SymbolType.None) - { - ThrowSymbolNone(); - } - - return _value; - } - } - - /// - /// Initializes a new instance of the structure with the specified and value. - /// - /// Type of symbol - /// Value of symbol - public Symbol(SymbolType type, ulong value) - { - (Type, _value) = (type, value); - } - - /// - /// Determines if the specified instances are equal. - /// - /// First instance - /// Second instance - /// if equal; otherwise - public static bool operator ==(Symbol a, Symbol b) - { - return a.Equals(b); - } - - /// - /// Determines if the specified instances are not equal. - /// - /// First instance - /// Second instance - /// if not equal; otherwise - /// - public static bool operator !=(Symbol a, Symbol b) - { - return !(a == b); - } - - /// - /// Determines if the specified is equal to this instance. - /// - /// Other instance - /// if equal; otherwise - public bool Equals(Symbol other) - { - return other.Type == Type && other._value == _value; - } - - /// - public override bool Equals(object obj) - { - return obj is Symbol sym && Equals(sym); - } - - /// - public override int GetHashCode() - { - return HashCode.Combine(Type, _value); - } - - /// - public override string ToString() - { - return $"{Type}:{_value}"; - } - - private static void ThrowSymbolNone() - { - throw new InvalidOperationException("Symbol refers to nothing."); - } - } -} diff --git a/ARMeilleure/Translation/PTC/SymbolType.cs b/ARMeilleure/Translation/PTC/SymbolType.cs deleted file mode 100644 index cd7b6c1c..00000000 --- a/ARMeilleure/Translation/PTC/SymbolType.cs +++ /dev/null @@ -1,28 +0,0 @@ -namespace ARMeilleure.Translation.PTC -{ - /// - /// Types of . - /// - enum SymbolType : byte - { - /// - /// Refers to nothing, i.e no symbol. - /// - None, - - /// - /// Refers to an entry in . - /// - DelegateTable, - - /// - /// Refers to an entry in . - /// - FunctionTable, - - /// - /// Refers to a special symbol which is handled by . - /// - Special - } -} -- cgit v1.2.3