From a9343c9364246d3288b4e7f20919ca1ad2e1fd3e Mon Sep 17 00:00:00 2001
From: FICTURE7 <FICTURE7@gmail.com>
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<T>`

Remove `Compiler.Compile<T>` and replace it by `Map<T>` of the
`CompiledFunction` returned.
---
 ARMeilleure/CodeGen/Linking/RelocEntry.cs | 38 +++++++++++++++++++++++++++++++
 1 file changed, 38 insertions(+)
 create mode 100644 ARMeilleure/CodeGen/Linking/RelocEntry.cs

(limited to 'ARMeilleure/CodeGen/Linking/RelocEntry.cs')

diff --git a/ARMeilleure/CodeGen/Linking/RelocEntry.cs b/ARMeilleure/CodeGen/Linking/RelocEntry.cs
new file mode 100644
index 00000000..a27bfded
--- /dev/null
+++ b/ARMeilleure/CodeGen/Linking/RelocEntry.cs
@@ -0,0 +1,38 @@
+namespace ARMeilleure.CodeGen.Linking
+{
+    /// <summary>
+    /// Represents a relocation.
+    /// </summary>
+    readonly struct RelocEntry
+    {
+        public const int Stride = 13; // Bytes.
+
+        /// <summary>
+        /// Gets the position of the relocation.
+        /// </summary>
+        public int Position { get; }
+
+        /// <summary>
+        /// Gets the <see cref="Symbol"/> of the relocation.
+        /// </summary>
+        public Symbol Symbol { get; }
+
+        /// <summary>
+        /// Initializes a new instance of the <see cref="RelocEntry"/> struct with the specified position and
+        /// <see cref="Symbol"/>.
+        /// </summary>
+        /// <param name="position">Position of relocation</param>
+        /// <param name="symbol">Symbol of relocation</param>
+        public RelocEntry(int position, Symbol symbol)
+        {
+            Position = position;
+            Symbol = symbol;
+        }
+
+        /// <inheritdoc/>
+        public override string ToString()
+        {
+            return $"({nameof(Position)} = {Position}, {nameof(Symbol)} = {Symbol})";
+        }
+    }
+}
\ No newline at end of file
-- 
cgit v1.2.3