Merge remote-tracking branch 'upstream/master' into cn-7.4

Author: Bluefissure

Dalamud/Configuration/PluginConfigurations.cs

@@ -11,7 +11,7 @@ namespace Dalamud.Configuration;
 /// <summary>
 /// Configuration to store settings for a dalamud plugin.
 /// </summary>
-[Api14ToDo("Make this a service. We need to be able to dispose it reliably to write configs asynchronously. Maybe also let people write files with vfs.")]
+[Api15ToDo("Make this a service. We need to be able to dispose it reliably to write configs asynchronously. Maybe also let people write files with vfs.")]
 public sealed class PluginConfigurations
 {
     private readonly DirectoryInfo configDirectory;

Dalamud/Dalamud.cs

@@ -9,6 +9,7 @@
 using Dalamud.Common;
 using Dalamud.Configuration.Internal;
 using Dalamud.Game;
+using Dalamud.Hooking.Internal.Verification;
 using Dalamud.Plugin.Internal;
 using Dalamud.Storage;
 using Dalamud.Utility;
@@ -75,6 +76,11 @@ public Dalamud(DalamudStartInfo info, ReliableFileStorage fs, DalamudConfigurati
             scanner,
             Localization.FromAssets(info.AssetDirectory!, configuration.LanguageOverride));
 
+        using (Timings.Start("HookVerifier Init"))
+        {
+            HookVerifier.Initialize(scanner);
+        }
+
         // Set up FFXIVClientStructs
         this.SetupClientStructsResolver(cacheDir);
 

Dalamud/Game/Addon/Lifecycle/AddonArgTypes/AddonRefreshArgs.cs

@@ -55,7 +55,9 @@ public IEnumerable<AtkValuePtr> AtkValueEnumerable
                 AtkValuePtr ptr;
                 unsafe
                 {
+#pragma warning disable CS0618 // Type or member is obsolete
                     ptr = new AtkValuePtr((nint)this.AtkValueSpan.GetPointer(i));
+#pragma warning restore CS0618 // Type or member is obsolete
                 }
 
                 yield return ptr;

Dalamud/Game/Addon/Lifecycle/AddonArgTypes/AddonSetupArgs.cs

@@ -55,7 +55,9 @@ public IEnumerable<AtkValuePtr> AtkValueEnumerable
                 AtkValuePtr ptr;
                 unsafe
                 {
+#pragma warning disable CS0618 // Type or member is obsolete
                     ptr = new AtkValuePtr((nint)this.AtkValueSpan.GetPointer(i));
+#pragma warning restore CS0618 // Type or member is obsolete
                 }
 
                 yield return ptr;

Dalamud/Game/Addon/Lifecycle/AddonLifecycle.cs

@@ -1,5 +1,6 @@
 using System.Collections.Generic;
 using System.Diagnostics;
+using System.Linq;
 using System.Runtime.CompilerServices;
 
 using Dalamud.Game.Addon.Lifecycle.AddonArgTypes;
@@ -132,6 +133,19 @@ internal void InvokeListenersSafely(AddonEvent eventType, AddonArgs args, [Calle
         }
     }
 
+    /// <summary>
+    /// Resolves a virtual table address to the original virtual table address.
+    /// </summary>
+    /// <param name="tableAddress">The modified address to resolve.</param>
+    /// <returns>The original address.</returns>
+    internal AtkUnitBase.AtkUnitBaseVirtualTable* GetOriginalVirtualTable(AtkUnitBase.AtkUnitBaseVirtualTable* tableAddress)
+    {
+        var matchedTable = AllocatedTables.FirstOrDefault(table => table.ModifiedVirtualTable == tableAddress);
+        if (matchedTable == null) return null;
+
+        return matchedTable.OriginalVirtualTable;
+    }
+
     private void OnAddonInitialize(AtkUnitBase* addon)
     {
         try
@@ -246,4 +260,8 @@ public void UnregisterListener(params IAddonLifecycle.AddonEventDelegate[] handl
             });
         }
     }
+
+    /// <inheritdoc/>
+    public unsafe nint GetOriginalVirtualTable(nint virtualTableAddress)
+        => (nint)this.addonLifecycleService.GetOriginalVirtualTable((AtkUnitBase.AtkUnitBaseVirtualTable*)virtualTableAddress);
 }

Dalamud/Game/Addon/Lifecycle/AddonVirtualTable.cs

@@ -45,9 +45,6 @@ internal unsafe class AddonVirtualTable : IDisposable
 
     private readonly AtkUnitBase* atkUnitBase;
 
-    private readonly AtkUnitBase.AtkUnitBaseVirtualTable* originalVirtualTable;
-    private readonly AtkUnitBase.AtkUnitBaseVirtualTable* modifiedVirtualTable;
-
     // Pinned Function Delegates, as these functions get assigned to an unmanaged virtual table,
     // the CLR needs to know they are in use, or it will invalidate them causing random crashing.
     private readonly AtkUnitBase.Delegates.Dtor destructorFunction;
@@ -78,16 +75,16 @@ internal AddonVirtualTable(AtkUnitBase* addon, AddonLifecycle lifecycleService)
         this.lifecycleService = lifecycleService;
 
         // Save original virtual table
-        this.originalVirtualTable = addon->VirtualTable;
+        this.OriginalVirtualTable = addon->VirtualTable;
 
         // Create copy of original table
         // Note this will copy any derived/overriden functions that this specific addon has.
         // Note: currently there are 73 virtual functions, but there's no harm in copying more for when they add new virtual functions to the game
-        this.modifiedVirtualTable = (AtkUnitBase.AtkUnitBaseVirtualTable*)IMemorySpace.GetUISpace()->Malloc(0x8 * VirtualTableEntryCount, 8);
-        NativeMemory.Copy(addon->VirtualTable, this.modifiedVirtualTable, 0x8 * VirtualTableEntryCount);
+        this.ModifiedVirtualTable = (AtkUnitBase.AtkUnitBaseVirtualTable*)IMemorySpace.GetUISpace()->Malloc(0x8 * VirtualTableEntryCount, 8);
+        NativeMemory.Copy(addon->VirtualTable, this.ModifiedVirtualTable, 0x8 * VirtualTableEntryCount);
 
         // Overwrite the addons existing virtual table with our own
-        addon->VirtualTable = this.modifiedVirtualTable;
+        addon->VirtualTable = this.ModifiedVirtualTable;
 
         // Pin each of our listener functions
         this.destructorFunction = this.OnAddonDestructor;
@@ -108,30 +105,40 @@ internal AddonVirtualTable(AtkUnitBase* addon, AddonLifecycle lifecycleService)
         this.focusFunction = this.OnAddonFocus;
 
         // Overwrite specific virtual table entries
-        this.modifiedVirtualTable->Dtor = (delegate* unmanaged<AtkUnitBase*, byte, AtkEventListener*>)Marshal.GetFunctionPointerForDelegate(this.destructorFunction);
-        this.modifiedVirtualTable->OnSetup = (delegate* unmanaged<AtkUnitBase*, uint, AtkValue*, void>)Marshal.GetFunctionPointerForDelegate(this.onSetupFunction);
-        this.modifiedVirtualTable->Finalizer = (delegate* unmanaged<AtkUnitBase*, void>)Marshal.GetFunctionPointerForDelegate(this.finalizerFunction);
-        this.modifiedVirtualTable->Draw = (delegate* unmanaged<AtkUnitBase*, void>)Marshal.GetFunctionPointerForDelegate(this.drawFunction);
-        this.modifiedVirtualTable->Update = (delegate* unmanaged<AtkUnitBase*, float, void>)Marshal.GetFunctionPointerForDelegate(this.updateFunction);
-        this.modifiedVirtualTable->OnRefresh = (delegate* unmanaged<AtkUnitBase*, uint, AtkValue*, bool>)Marshal.GetFunctionPointerForDelegate(this.onRefreshFunction);
-        this.modifiedVirtualTable->OnRequestedUpdate = (delegate* unmanaged<AtkUnitBase*, NumberArrayData**, StringArrayData**, void>)Marshal.GetFunctionPointerForDelegate(this.onRequestedUpdateFunction);
-        this.modifiedVirtualTable->ReceiveEvent = (delegate* unmanaged<AtkUnitBase*, AtkEventType, int, AtkEvent*, AtkEventData*, void>)Marshal.GetFunctionPointerForDelegate(this.onReceiveEventFunction);
-        this.modifiedVirtualTable->Open = (delegate* unmanaged<AtkUnitBase*, uint, bool>)Marshal.GetFunctionPointerForDelegate(this.openFunction);
-        this.modifiedVirtualTable->Close = (delegate* unmanaged<AtkUnitBase*, bool, bool>)Marshal.GetFunctionPointerForDelegate(this.closeFunction);
-        this.modifiedVirtualTable->Show = (delegate* unmanaged<AtkUnitBase*, bool, uint, void>)Marshal.GetFunctionPointerForDelegate(this.showFunction);
-        this.modifiedVirtualTable->Hide = (delegate* unmanaged<AtkUnitBase*, bool, bool, uint, void>)Marshal.GetFunctionPointerForDelegate(this.hideFunction);
-        this.modifiedVirtualTable->OnMove = (delegate* unmanaged<AtkUnitBase*, void>)Marshal.GetFunctionPointerForDelegate(this.onMoveFunction);
-        this.modifiedVirtualTable->OnMouseOver = (delegate* unmanaged<AtkUnitBase*, void>)Marshal.GetFunctionPointerForDelegate(this.onMouseOverFunction);
-        this.modifiedVirtualTable->OnMouseOut = (delegate* unmanaged<AtkUnitBase*, void>)Marshal.GetFunctionPointerForDelegate(this.onMouseOutFunction);
-        this.modifiedVirtualTable->Focus = (delegate* unmanaged<AtkUnitBase*, void>)Marshal.GetFunctionPointerForDelegate(this.focusFunction);
+        this.ModifiedVirtualTable->Dtor = (delegate* unmanaged<AtkUnitBase*, byte, AtkEventListener*>)Marshal.GetFunctionPointerForDelegate(this.destructorFunction);
+        this.ModifiedVirtualTable->OnSetup = (delegate* unmanaged<AtkUnitBase*, uint, AtkValue*, void>)Marshal.GetFunctionPointerForDelegate(this.onSetupFunction);
+        this.ModifiedVirtualTable->Finalizer = (delegate* unmanaged<AtkUnitBase*, void>)Marshal.GetFunctionPointerForDelegate(this.finalizerFunction);
+        this.ModifiedVirtualTable->Draw = (delegate* unmanaged<AtkUnitBase*, void>)Marshal.GetFunctionPointerForDelegate(this.drawFunction);
+        this.ModifiedVirtualTable->Update = (delegate* unmanaged<AtkUnitBase*, float, void>)Marshal.GetFunctionPointerForDelegate(this.updateFunction);
+        this.ModifiedVirtualTable->OnRefresh = (delegate* unmanaged<AtkUnitBase*, uint, AtkValue*, bool>)Marshal.GetFunctionPointerForDelegate(this.onRefreshFunction);
+        this.ModifiedVirtualTable->OnRequestedUpdate = (delegate* unmanaged<AtkUnitBase*, NumberArrayData**, StringArrayData**, void>)Marshal.GetFunctionPointerForDelegate(this.onRequestedUpdateFunction);
+        this.ModifiedVirtualTable->ReceiveEvent = (delegate* unmanaged<AtkUnitBase*, AtkEventType, int, AtkEvent*, AtkEventData*, void>)Marshal.GetFunctionPointerForDelegate(this.onReceiveEventFunction);
+        this.ModifiedVirtualTable->Open = (delegate* unmanaged<AtkUnitBase*, uint, bool>)Marshal.GetFunctionPointerForDelegate(this.openFunction);
+        this.ModifiedVirtualTable->Close = (delegate* unmanaged<AtkUnitBase*, bool, bool>)Marshal.GetFunctionPointerForDelegate(this.closeFunction);
+        this.ModifiedVirtualTable->Show = (delegate* unmanaged<AtkUnitBase*, bool, uint, void>)Marshal.GetFunctionPointerForDelegate(this.showFunction);
+        this.ModifiedVirtualTable->Hide = (delegate* unmanaged<AtkUnitBase*, bool, bool, uint, void>)Marshal.GetFunctionPointerForDelegate(this.hideFunction);
+        this.ModifiedVirtualTable->OnMove = (delegate* unmanaged<AtkUnitBase*, void>)Marshal.GetFunctionPointerForDelegate(this.onMoveFunction);
+        this.ModifiedVirtualTable->OnMouseOver = (delegate* unmanaged<AtkUnitBase*, void>)Marshal.GetFunctionPointerForDelegate(this.onMouseOverFunction);
+        this.ModifiedVirtualTable->OnMouseOut = (delegate* unmanaged<AtkUnitBase*, void>)Marshal.GetFunctionPointerForDelegate(this.onMouseOutFunction);
+        this.ModifiedVirtualTable->Focus = (delegate* unmanaged<AtkUnitBase*, void>)Marshal.GetFunctionPointerForDelegate(this.focusFunction);
     }
 
+    /// <summary>
+    /// Gets the original virtual table address for this addon.
+    /// </summary>
+    internal AtkUnitBase.AtkUnitBaseVirtualTable* OriginalVirtualTable { get; private set; }
+
+    /// <summary>
+    /// Gets the modified virtual address for this addon.
+    /// </summary>
+    internal AtkUnitBase.AtkUnitBaseVirtualTable* ModifiedVirtualTable { get; private set; }
+
     /// <inheritdoc/>
     public void Dispose()
     {
         // Ensure restoration is done atomically.
-        Interlocked.Exchange(ref *(nint*)&this.atkUnitBase->VirtualTable, (nint)this.originalVirtualTable);
-        IMemorySpace.Free(this.modifiedVirtualTable, 0x8 * VirtualTableEntryCount);
+        Interlocked.Exchange(ref *(nint*)&this.atkUnitBase->VirtualTable, (nint)this.OriginalVirtualTable);
+        IMemorySpace.Free(this.ModifiedVirtualTable, 0x8 * VirtualTableEntryCount);
     }
 
     private AtkEventListener* OnAddonDestructor(AtkUnitBase* thisPtr, byte freeFlags)
@@ -144,7 +151,7 @@ public void Dispose()
 
             try
             {
-                result = this.originalVirtualTable->Dtor(thisPtr, freeFlags);
+                result = this.OriginalVirtualTable->Dtor(thisPtr, freeFlags);
             }
             catch (Exception e)
             {
@@ -153,7 +160,7 @@ public void Dispose()
 
             if ((freeFlags & 1) == 1)
             {
-                IMemorySpace.Free(this.modifiedVirtualTable, 0x8 * VirtualTableEntryCount);
+                IMemorySpace.Free(this.ModifiedVirtualTable, 0x8 * VirtualTableEntryCount);
                 AddonLifecycle.AllocatedTables.Remove(this);
             }
         }
@@ -182,7 +189,7 @@ private void OnAddonSetup(AtkUnitBase* addon, uint valueCount, AtkValue* values)
 
             try
             {
-                this.originalVirtualTable->OnSetup(addon, valueCount, values);
+                this.OriginalVirtualTable->OnSetup(addon, valueCount, values);
             }
             catch (Exception e)
             {
@@ -209,7 +216,7 @@ private void OnAddonFinalize(AtkUnitBase* thisPtr)
 
             try
             {
-                this.originalVirtualTable->Finalizer(thisPtr);
+                this.OriginalVirtualTable->Finalizer(thisPtr);
             }
             catch (Exception e)
             {
@@ -234,7 +241,7 @@ private void OnAddonDraw(AtkUnitBase* addon)
 
             try
             {
-                this.originalVirtualTable->Draw(addon);
+                this.OriginalVirtualTable->Draw(addon);
             }
             catch (Exception e)
             {
@@ -265,7 +272,7 @@ private void OnAddonUpdate(AtkUnitBase* addon, float delta)
 
             try
             {
-                this.originalVirtualTable->Update(addon,  delta);
+                this.OriginalVirtualTable->Update(addon,  delta);
             }
             catch (Exception e)
             {
@@ -299,7 +306,7 @@ private bool OnAddonRefresh(AtkUnitBase* addon, uint valueCount, AtkValue* value
 
             try
             {
-                result = this.originalVirtualTable->OnRefresh(addon, valueCount, values);
+                result = this.OriginalVirtualTable->OnRefresh(addon, valueCount, values);
             }
             catch (Exception e)
             {
@@ -333,7 +340,7 @@ private void OnRequestedUpdate(AtkUnitBase* addon, NumberArrayData** numberArray
 
             try
             {
-                this.originalVirtualTable->OnRequestedUpdate(addon, numberArrayData, stringArrayData);
+                this.OriginalVirtualTable->OnRequestedUpdate(addon, numberArrayData, stringArrayData);
             }
             catch (Exception e)
             {
@@ -369,7 +376,7 @@ private void OnAddonReceiveEvent(AtkUnitBase* addon, AtkEventType eventType, int
 
             try
             {
-                this.originalVirtualTable->ReceiveEvent(addon, eventType, eventParam, atkEvent, atkEventData);
+                this.OriginalVirtualTable->ReceiveEvent(addon, eventType, eventParam, atkEvent, atkEventData);
             }
             catch (Exception e)
             {
@@ -398,7 +405,7 @@ private bool OnAddonOpen(AtkUnitBase* thisPtr, uint depthLayer)
 
             try
             {
-                result = this.originalVirtualTable->Open(thisPtr, depthLayer);
+                result = this.OriginalVirtualTable->Open(thisPtr, depthLayer);
             }
             catch (Exception e)
             {
@@ -432,7 +439,7 @@ private bool OnAddonClose(AtkUnitBase* thisPtr, bool fireCallback)
 
             try
             {
-                result = this.originalVirtualTable->Close(thisPtr, fireCallback);
+                result = this.OriginalVirtualTable->Close(thisPtr, fireCallback);
             }
             catch (Exception e)
             {
@@ -466,7 +473,7 @@ private void OnAddonShow(AtkUnitBase* thisPtr, bool silenceOpenSoundEffect, uint
 
             try
             {
-                this.originalVirtualTable->Show(thisPtr, silenceOpenSoundEffect, unsetShowHideFlags);
+                this.OriginalVirtualTable->Show(thisPtr, silenceOpenSoundEffect, unsetShowHideFlags);
             }
             catch (Exception e)
             {
@@ -500,7 +507,7 @@ private void OnAddonHide(AtkUnitBase* thisPtr, bool unkBool, bool callHideCallba
 
             try
             {
-                this.originalVirtualTable->Hide(thisPtr, unkBool, callHideCallback, setShowHideFlags);
+                this.OriginalVirtualTable->Hide(thisPtr, unkBool, callHideCallback, setShowHideFlags);
             }
             catch (Exception e)
             {
@@ -527,7 +534,7 @@ private void OnAddonMove(AtkUnitBase* thisPtr)
 
             try
             {
-                this.originalVirtualTable->OnMove(thisPtr);
+                this.OriginalVirtualTable->OnMove(thisPtr);
             }
             catch (Exception e)
             {
@@ -554,7 +561,7 @@ private void OnAddonMouseOver(AtkUnitBase* thisPtr)
 
             try
             {
-                this.originalVirtualTable->OnMouseOver(thisPtr);
+                this.OriginalVirtualTable->OnMouseOver(thisPtr);
             }
             catch (Exception e)
             {
@@ -581,7 +588,7 @@ private void OnAddonMouseOut(AtkUnitBase* thisPtr)
 
             try
             {
-                this.originalVirtualTable->OnMouseOut(thisPtr);
+                this.OriginalVirtualTable->OnMouseOut(thisPtr);
             }
             catch (Exception e)
             {
@@ -608,7 +615,7 @@ private void OnAddonFocus(AtkUnitBase* thisPtr)
 
             try
             {
-                this.originalVirtualTable->Focus(thisPtr);
+                this.OriginalVirtualTable->Focus(thisPtr);
             }
             catch (Exception e)
             {

Dalamud/Game/Gui/Dtr/DtrBarEntry.cs

@@ -150,7 +150,7 @@ public bool Shown
     }
 
     /// <inheritdoc/>
-    [Api14ToDo("Maybe make this config scoped to internal name?")]
+    [Api15ToDo("Maybe make this config scoped to internal name?")]
     public bool UserHidden => this.configuration.DtrIgnore?.Contains(this.Title) ?? false;
 
     /// <inheritdoc/>

Dalamud/Hooking/Hook.cs

@@ -4,6 +4,7 @@
 
 using Dalamud.Configuration.Internal;
 using Dalamud.Hooking.Internal;
+using Dalamud.Hooking.Internal.Verification;
 
 namespace Dalamud.Hooking;
 
@@ -230,6 +231,8 @@ internal static Hook<T> FromAddress(IntPtr procAddress, T detour, bool useMinHoo
         if (EnvironmentConfiguration.DalamudForceMinHook)
             useMinHook = true;
 
+        HookVerifier.Verify<T>(procAddress);
+
         procAddress = HookManager.FollowJmp(procAddress);
         if (useMinHook)
             return new MinHookHook<T>(procAddress, detour, Assembly.GetCallingAssembly());

Dalamud/Hooking/Internal/Verification/HookVerificationException.cs

@@ -0,0 +1,41 @@
+using System.Linq;
+
+namespace Dalamud.Hooking.Internal.Verification;
+
+/// <summary>
+/// Exception thrown when a provided delegate for a hook does not match a known delegate.
+/// </summary>
+public class HookVerificationException : Exception
+{
+    private HookVerificationException(string message)
+        : base(message)
+    {
+    }
+
+    /// <summary>
+    /// Create a new <see cref="HookVerificationException"/> exception.
+    /// </summary>
+    /// <param name="address">The address of the function that is being hooked.</param>
+    /// <param name="passed">The delegate passed by the user.</param>
+    /// <param name="enforced">The delegate we think is correct.</param>
+    /// <param name="message">Additional context to show to the user.</param>
+    /// <returns>The created exception.</returns>
+    internal static HookVerificationException Create(IntPtr address, Type passed, Type enforced, string message)
+    {
+        return new HookVerificationException(
+            $"Hook verification failed for address 0x{address.ToInt64():X}\n\n" +
+            $"Why:               {message}\n" +
+            $"Passed Delegate:   {GetSignature(passed)}\n" +
+            $"Correct Delegate:  {GetSignature(enforced)}\n\n" +
+            "The hook delegate must exactly match the provided signature to prevent memory corruption and wrong data passed to originals.");
+    }
+
+    private static string GetSignature(Type delegateType)
+    {
+        var method = delegateType.GetMethod("Invoke");
+        if (method == null) return delegateType.Name;
+
+        var parameters = string.Join(", ", method.GetParameters().Select(p => p.ParameterType.Name));
+        return $"{method.ReturnType.Name} ({parameters})";
+    }
+}