Fully working COM to COM marshalling within .NET process

2025-02-05 23:04:10 +01:00
parent dec0a0115c
commit 36fe0d3bf2
7 changed files with 251 additions and 37 deletions
--- a/VisualStudioMock/ComProxy.cs
+++ b/VisualStudioMock/ComProxy.cs
@@ -1,3 +1,5 @@
+//#define LOG_CALLS
+
 using System;
 using System.Runtime.InteropServices;

@@ -15,6 +17,19 @@ namespace VisualStudioMock
    private static readonly Guid IID_IUnknown = new Guid("00000000-0000-0000-c000-000000000046");
    private static readonly Guid IID_IManagedObject = new Guid("C3FCC19E-A970-11D2-8B5A-00A0C9B7C9C4");

+    [DllImport("kernel32.dll", SetLastError = true)]
+    private static extern IntPtr VirtualAlloc(IntPtr lpAddress, UIntPtr dwSize, AllocationType lAllocationType, MemoryProtection flProtect);
+
+    [DllImport("KERNEL32.dll", ExactSpelling = true, SetLastError = true)]
+    private static extern bool VirtualProtect(IntPtr lpAddress, UIntPtr dwSize, PAGE_PROTECTION_FLAGS flNewProtect, out PAGE_PROTECTION_FLAGS lpflOldProtect);
+
+    [DllImport("KERNEL32.dll", ExactSpelling = true, SetLastError = true)]
+    public static extern bool FlushInstructionCache(IntPtr hProcess, [Optional] IntPtr lpBaseAddress, IntPtr dwSize);
+
+    private static IntPtr _execBlockBase;
+    private static int _execBlockNext;
+    private static int _execBlockSize;
+
    private readonly object _realInstance;
    private readonly IntPtr _realInstanceN;
    private readonly IntPtr _proxyInstanceN;
@@ -46,14 +61,18 @@ namespace VisualStudioMock
      if (iid == IID_IUnknown)
      {
        ppv = _proxyInstanceN;
+#if LOG_CALLS
        Ext.LogCall(_realInstance.GetType().Name, nameof(GetInterface), "IUnknown OK");
+#endif
        return S_OK;
      }

      if (iid == IID_IManagedObject)
      {
        ppv = IntPtr.Zero;
+#if LOG_CALLS
        Ext.LogCall(_realInstance.GetType().Name, nameof(GetInterface), "IManagedObject Fail");
+#endif
        return E_NOINTERFACE;
      }

@@ -70,20 +89,31 @@ namespace VisualStudioMock
            iType = i;
            break;
          }
+
        if (iType != null)
        {
-          // TODO generate proper thunks in machine code
+          // Generate proper thunks in machine code
          int slotCount = Marshal.GetEndComSlot(iType) + 1;
          int slotsSizeBytes = IntPtr.Size * slotCount;
-          IntPtr newVtbl = Marshal.AllocHGlobal(slotsSizeBytes);
-          ...
+          IntPtr newPpv = Marshal.AllocHGlobal(slotsSizeBytes + IntPtr.Size);
+          IntPtr newVtbl = newPpv + IntPtr.Size;
+          Marshal.WriteIntPtr(newPpv, newVtbl);
+          Marshal.WriteIntPtr(newVtbl, _getInterfaceN);
+          for (int i = 1; i < slotCount; i++)
+            Marshal.WriteIntPtr(newVtbl, i * IntPtr.Size, CreateThunk(ppv, Marshal.ReadIntPtr(origVtbl, i * IntPtr.Size)));
+          FlushThunkCode();
+          ppv = newPpv;
        }

+#if LOG_CALLS
        Ext.LogCall(_realInstance.GetType().Name, nameof(GetInterface), (iType == null ? iid.ToString() : iType.Name) + " OK");
+#endif
      }
      else
      {
+#if LOG_CALLS
        Ext.LogCall(_realInstance.GetType().Name, nameof(GetInterface), iid.ToString() + " Fail");
+#endif
      }
      return result;
    }
@@ -97,5 +127,146 @@ namespace VisualStudioMock
    {
      return 1;
    }
+
+    private static IntPtr CreateThunk(IntPtr @this, IntPtr jmpTarget)
+    {
+      int allocSize = Environment.Is64BitProcess ? 22 : 13;
+
+      if (_execBlockSize - _execBlockNext < allocSize)
+      {
+        // Flush the now complete page
+        if (_execBlockBase != IntPtr.Zero)
+          FlushThunkCode();
+
+        // Prepare the memory for the machine code
+        _execBlockSize = Environment.SystemPageSize;
+        _execBlockBase = VirtualAlloc(IntPtr.Zero, new UIntPtr((uint)_execBlockSize), AllocationType.Commit | AllocationType.Reserve, MemoryProtection.ReadWrite);
+        if (!VirtualProtect(_execBlockBase, new UIntPtr((uint)_execBlockSize), PAGE_PROTECTION_FLAGS.PAGE_EXECUTE_READWRITE, out _))
+          throw new InvalidOperationException("Failed to make thunk data executable");
+
+        _execBlockNext = 0;
+
+#if LOG_CALLS
+        Ext.Log("Allocated thunk page at 0x" + _execBlockBase.ToString("X"));
+#endif
+      }
+
+#if LOG_CALLS
+      Ext.LogCall(nameof(ComProxy), nameof(CreateThunk), "This = 0x" + @this.ToString("X") + " Target = 0x" + jmpTarget.ToString("X"));
+#endif
+
+      IntPtr result = _execBlockBase + _execBlockNext;
+      if (Environment.Is64BitProcess)
+      {
+        // movabs rcx, this
+        Marshal.WriteInt16(_execBlockBase, _execBlockNext, unchecked((short)(0xB948)));
+        Marshal.WriteIntPtr(_execBlockBase, _execBlockNext + 2, @this);
+        _execBlockNext += 2 + IntPtr.Size;
+
+        // movabs rax, jmpTarget
+        // jmp rax
+        Marshal.WriteInt16(_execBlockBase, _execBlockNext, unchecked((short)(0xB848)));
+        Marshal.WriteIntPtr(_execBlockBase, _execBlockNext + 2, jmpTarget);
+        Marshal.WriteInt16(_execBlockBase, _execBlockNext + 10, unchecked((short)(0xE0FF)));
+        _execBlockNext += 2 + IntPtr.Size + 2;
+      }
+      else
+      {
+        // NOT tested!
+        // pop eax
+        // push this
+        Marshal.WriteByte(_execBlockBase, _execBlockNext, 0x58);
+        Marshal.WriteByte(_execBlockBase, _execBlockNext + 1, 0x68);
+        Marshal.WriteIntPtr(_execBlockBase, _execBlockNext + 2, @this);
+        _execBlockNext += 1 + 1 + IntPtr.Size;
+
+        // mov eax target_address
+        // jmp eax
+        Marshal.WriteByte(_execBlockBase, _execBlockNext, 0xB8);
+        Marshal.WriteIntPtr(_execBlockBase, _execBlockNext + 1, jmpTarget);
+        Marshal.WriteInt16(_execBlockBase, _execBlockNext + 5, unchecked((short)(0xE0FF)));
+        _execBlockNext += 1 + IntPtr.Size + 2;
+      }
+      return result;
+    }
+
+    private static void FlushThunkCode()
+    {
+      FlushInstructionCache(new IntPtr(-1), _execBlockBase, new IntPtr(_execBlockSize));
+    }
+
+        [Flags]
+    enum AllocationType
+    {
+      Commit = 0x1000,
+      Reserve = 0x2000,
+      Decommit = 0x4000,
+      Release = 0x8000,
+      Reset = 0x80000,
+      Physical = 0x400000,
+      TopDown = 0x100000,
+      WriteWatch = 0x200000,
+      LargePages = 0x20000000
+    }
+
+    [Flags]
+    enum MemoryProtection
+    {
+      Execute = 0x10,
+      ExecuteRead = 0x20,
+      ExecuteReadWrite = 0x40,
+      ExecuteWriteCopy = 0x80,
+      NoAccess = 0x01,
+      ReadOnly = 0x02,
+      ReadWrite = 0x04,
+      WriteCopy = 0x08,
+      GuardModifierflag = 0x100,
+      NoCacheModifierflag = 0x200,
+      WriteCombineModifierflag = 0x400
+    }
+
+    [Flags]
+    enum PAGE_PROTECTION_FLAGS : uint
+    {
+      PAGE_NOACCESS = 0x00000001,
+      PAGE_READONLY = 0x00000002,
+      PAGE_READWRITE = 0x00000004,
+      PAGE_WRITECOPY = 0x00000008,
+      PAGE_EXECUTE = 0x00000010,
+      PAGE_EXECUTE_READ = 0x00000020,
+      PAGE_EXECUTE_READWRITE = 0x00000040,
+      PAGE_EXECUTE_WRITECOPY = 0x00000080,
+      PAGE_GUARD = 0x00000100,
+      PAGE_NOCACHE = 0x00000200,
+      PAGE_WRITECOMBINE = 0x00000400,
+      PAGE_GRAPHICS_NOACCESS = 0x00000800,
+      PAGE_GRAPHICS_READONLY = 0x00001000,
+      PAGE_GRAPHICS_READWRITE = 0x00002000,
+      PAGE_GRAPHICS_EXECUTE = 0x00004000,
+      PAGE_GRAPHICS_EXECUTE_READ = 0x00008000,
+      PAGE_GRAPHICS_EXECUTE_READWRITE = 0x00010000,
+      PAGE_GRAPHICS_COHERENT = 0x00020000,
+      PAGE_GRAPHICS_NOCACHE = 0x00040000,
+      PAGE_ENCLAVE_THREAD_CONTROL = 0x80000000,
+      PAGE_REVERT_TO_FILE_MAP = 0x80000000,
+      PAGE_TARGETS_NO_UPDATE = 0x40000000,
+      PAGE_TARGETS_INVALID = 0x40000000,
+      PAGE_ENCLAVE_UNVALIDATED = 0x20000000,
+      PAGE_ENCLAVE_MASK = 0x10000000,
+      PAGE_ENCLAVE_DECOMMIT = 0x10000000,
+      PAGE_ENCLAVE_SS_FIRST = 0x10000001,
+      PAGE_ENCLAVE_SS_REST = 0x10000002,
+      SEC_PARTITION_OWNER_HANDLE = 0x00040000,
+      SEC_64K_PAGES = 0x00080000,
+      SEC_FILE = 0x00800000,
+      SEC_IMAGE = 0x01000000,
+      SEC_PROTECTED_IMAGE = 0x02000000,
+      SEC_RESERVE = 0x04000000,
+      SEC_COMMIT = 0x08000000,
+      SEC_NOCACHE = 0x10000000,
+      SEC_WRITECOMBINE = 0x40000000,
+      SEC_LARGE_PAGES = 0x80000000,
+      SEC_IMAGE_NO_EXECUTE = 0x11000000,
+    }
  }
 }
--- a/VisualStudioMock/IEnumSetupInstances.cs
+++ b/VisualStudioMock/IEnumSetupInstances.cs
@@ -7,9 +7,10 @@ namespace VisualStudioMock
 	/// An enumerator of installed <see cref="ISetupInstance" /> objects.
 	/// </summary>
 	[ComImport]
-	[ComVisible(true)]
 	[Guid("6380BCFF-41D3-4B2E-8B2E-BF8A6810C848")]
 	[InterfaceType(ComInterfaceType.InterfaceIsIUnknown)]
+	[TypeIdentifier]
+	[ComVisible(true)]
 	public interface IEnumSetupInstances
 	{
 		/// <summary>
--- a/VisualStudioMock/ISetupInstance.cs
+++ b/VisualStudioMock/ISetupInstance.cs
@@ -13,65 +13,54 @@ namespace VisualStudioMock
 	[ComImport]
 	[Guid("B41463C3-8866-43B5-BC33-2B0676F7F42E")]
 	[InterfaceType(ComInterfaceType.InterfaceIsIUnknown)]
+	[TypeIdentifier]
+	[ComVisible(true)]
 	public interface ISetupInstance
 	{
 		/// <summary>
 		/// Gets the instance identifier (should match the name of the parent instance directory).
 		/// </summary>
 		/// <returns>The instance identifier.</returns>
-		[return: MarshalAs(UnmanagedType.BStr)]
-		string GetInstanceId();
-
+    [return: MarshalAs(UnmanagedType.BStr)]
+    string GetInstanceId();
 		/// <summary>
 		/// Gets the local date and time when the installation was originally installed.
 		/// </summary>
-		/// <returns>The local date and time when the installation was originally installed.</returns>
-		[return: MarshalAs(UnmanagedType.Struct)]
-		FILETIME GetInstallDate();
-
+    [return: MarshalAs(UnmanagedType.Struct)]
+    System.Runtime.InteropServices.ComTypes.FILETIME GetInstallDate();
 		/// <summary>
 		/// Gets the unique name of the installation, often indicating the branch and other information used for telemetry.
 		/// </summary>
-		/// <returns>The unique name of the installation, often indicating the branch and other information used for telemetry.</returns>
-		[return: MarshalAs(UnmanagedType.BStr)]
-		string GetInstallationName();
-
-		/// <summary>
+	  [return: MarshalAs(UnmanagedType.BStr)]
+    string GetInstallationName();
+    /// <summary>
 		/// Gets the path to the installation root of the product.
 		/// </summary>
-		/// <returns>The path to the installation root of the product.</returns>
 		[return: MarshalAs(UnmanagedType.BStr)]
-		string GetInstallationPath();
-
-		/// <summary>
+    string GetInstallationPath();
+    /// <summary>
 		/// Gets the version of the product installed in this instance.
 		/// </summary>
-		/// <returns>The version of the product installed in this instance.</returns>
 		[return: MarshalAs(UnmanagedType.BStr)]
-		string GetInstallationVersion();
-
-		/// <summary>
+    string GetInstallationVersion();
+    /// <summary>
 		/// Gets the display name (title) of the product installed in this instance.
 		/// </summary>
 		/// <param name="lcid">The LCID for the display name.</param>
-		/// <returns>The display name (title) of the product installed in this instance.</returns>
 		[return: MarshalAs(UnmanagedType.BStr)]
-		string GetDisplayName([In] [MarshalAs(UnmanagedType.U4)] int lcid = 0);
-
-		/// <summary>
+    string GetDisplayName([In][MarshalAs(UnmanagedType.U4)] int lcid = 0);
+    /// <summary>
 		/// Gets the description of the product installed in this instance.
 		/// </summary>
 		/// <param name="lcid">The LCID for the description.</param>
-		/// <returns>The description of the product installed in this instance.</returns>
 		[return: MarshalAs(UnmanagedType.BStr)]
-		string GetDescription([In] [MarshalAs(UnmanagedType.U4)] int lcid = 0);
-
-		/// <summary>
+    string GetDescription([In][MarshalAs(UnmanagedType.U4)] int lcid = 0);
+    /// <summary>
 		/// Resolves the optional relative path to the root path of the instance.
 		/// </summary>
 		/// <param name="pwszRelativePath">A relative path within the instance to resolve, or NULL to get the root path.</param>
 		/// <returns>The full path to the optional relative path within the instance. If the relative path is NULL, the root path will always terminate in a backslash.</returns>
 		[return: MarshalAs(UnmanagedType.BStr)]
-		string ResolvePath([In] [MarshalAs(UnmanagedType.LPWStr)] string pwszRelativePath = null);
+    string ResolvePath([In][MarshalAs(UnmanagedType.LPWStr)] string pwszRelativePath = null);
 	}
 }
--- a/VisualStudioMock/ISetupInstance2.cs
+++ b/VisualStudioMock/ISetupInstance2.cs
@@ -12,8 +12,56 @@ namespace VisualStudioMock
 	[ComImport]
 	[Guid("89143C9A-05AF-49B0-B717-72E218A2185C")]
 	[InterfaceType(ComInterfaceType.InterfaceIsIUnknown)]
+	[TypeIdentifier]
+	[ComVisible(true)]
 	public interface ISetupInstance2 : ISetupInstance
 	{
+		/// <summary>
+		/// Gets the instance identifier (should match the name of the parent instance directory).
+		/// </summary>
+		/// <returns>The instance identifier.</returns>
+    [return: MarshalAs(UnmanagedType.BStr)]
+    new string GetInstanceId();
+		/// <summary>
+		/// Gets the local date and time when the installation was originally installed.
+		/// </summary>
+    [return: MarshalAs(UnmanagedType.Struct)]
+    new System.Runtime.InteropServices.ComTypes.FILETIME GetInstallDate();
+		/// <summary>
+		/// Gets the unique name of the installation, often indicating the branch and other information used for telemetry.
+		/// </summary>
+	  [return: MarshalAs(UnmanagedType.BStr)]
+    new string GetInstallationName();
+    /// <summary>
+		/// Gets the path to the installation root of the product.
+		/// </summary>
+		[return: MarshalAs(UnmanagedType.BStr)]
+    new string GetInstallationPath();
+    /// <summary>
+		/// Gets the version of the product installed in this instance.
+		/// </summary>
+		[return: MarshalAs(UnmanagedType.BStr)]
+    new string GetInstallationVersion();
+    /// <summary>
+		/// Gets the display name (title) of the product installed in this instance.
+		/// </summary>
+		/// <param name="lcid">The LCID for the display name.</param>
+		[return: MarshalAs(UnmanagedType.BStr)]
+    new string GetDisplayName([In][MarshalAs(UnmanagedType.U4)] int lcid = 0);
+    /// <summary>
+		/// Gets the description of the product installed in this instance.
+		/// </summary>
+		/// <param name="lcid">The LCID for the description.</param>
+		[return: MarshalAs(UnmanagedType.BStr)]
+    new string GetDescription([In][MarshalAs(UnmanagedType.U4)] int lcid = 0);
+    /// <summary>
+		/// Resolves the optional relative path to the root path of the instance.
+		/// </summary>
+		/// <param name="pwszRelativePath">A relative path within the instance to resolve, or NULL to get the root path.</param>
+		/// <returns>The full path to the optional relative path within the instance. If the relative path is NULL, the root path will always terminate in a backslash.</returns>
+		[return: MarshalAs(UnmanagedType.BStr)]
+    new string ResolvePath([In][MarshalAs(UnmanagedType.LPWStr)] string pwszRelativePath = null);
+
 		/// <summary>
 		/// Gets the state of the instance.
 		/// </summary>
--- a/VisualStudioMock/SetupConfiguration.cs
+++ b/VisualStudioMock/SetupConfiguration.cs
@@ -98,6 +98,7 @@ namespace VisualStudioMock
                {
                    rgelt[0] = _owner._singleInstance.ComBarrier<SetupInstance, ISetupInstance>();
                    pceltFetched = 1;
+                    _idx++;
                }
                else
                {
--- a/VisualStudioMock/SetupInstance.cs
+++ b/VisualStudioMock/SetupInstance.cs
@@ -29,13 +29,13 @@ namespace VisualStudioMock
        public string GetInstallationPath()
        {
            Ext.LogCall(nameof(SetupInstance), nameof(GetInstallationPath));
-            throw new NotImplementedException();
+            return @"C:\Program Files\Microsoft Visual Studio\2022\Community";
        }

        public string GetInstallationVersion()
        {
            Ext.LogCall(nameof(SetupInstance), nameof(GetInstallationVersion));
-            throw new NotImplementedException();
+            return "17.11.35303.130";
        }

        public FILETIME GetInstallDate()
@@ -63,7 +63,7 @@ namespace VisualStudioMock
        public string GetEnginePath()
        {
            Ext.LogCall(nameof(SetupInstance), nameof(GetEnginePath));
-            throw new NotImplementedException();
+            return @"C:\Program Files (x86)\Microsoft Visual Studio\Installer\resources\app\ServiceHub\Services\Microsoft.VisualStudio.Setup.Service";
        }

        public ISetupErrorState GetErrors()
--- a/VisualStudioMockTest/Program.cs
+++ b/VisualStudioMockTest/Program.cs
@@ -11,12 +11,16 @@ class A {
    var a = setup.EnumAllInstances();
    ISetupInstance[] b = new ISetupInstance[1];
    while (true) {
+      b[0] = null;
      a.Next(1, b, out _);
      if (b[0] == null)
        break;

-      ISetupInstance c = b[0];
+      ISetupInstance2 c = (ISetupInstance2)b[0];
      Console.WriteLine("Instance - " + c.GetDisplayName());
+      Console.WriteLine("\t GetInstallationVersion = " + c.GetInstallationVersion());
+      Console.WriteLine("\t GetInstallationPath = " + c.GetInstallationPath());
+      Console.WriteLine("\t GetEnginePath = " + c.GetEnginePath());
    }
  }
 }