Added: Usage warning for ExternalMemory

Author: Sewer56

src/Reloaded.Memory/ExternalMemory.cs

@@ -47,9 +47,18 @@ namespace Reloaded.Memory;
 
     /// <summary>
     ///     Creates an instance of the <see cref="ExternalMemory" /> class used to read from an
-    ///     external process with a specified handle.
+    ///     external process with a specified handle. <br/>
+    ///     Note: See warning in <see cref="ExternalMemory(Process)" />.
     /// </summary>
-    /// <param name="process">The individual process to read/write memory from.</param>
+    /// <param name="process">
+    ///     The individual process to read/write memory from.<br/>
+    ///     Warning!! <see cref="ExternalMemory"/> does not hold a reference to the process.<br/> <br/>
+    ///     In order to ensure the handle stays valid, you MUST MANUALLY prevent this parameter from being
+    ///     garbage collected/disposed by storing it somewhere else.
+    /// </param>
+    /// <remarks>
+    ///     On Linux, please insert Process ID here.
+    /// </remarks>
     public ExternalMemory(Process process) : this()
     {
         if (Polyfills.IsWindows())

src/Reloaded.Memory/Native/Windows/Kernel32.cs

@@ -50,6 +50,9 @@ public static partial class Kernel32
     ///     <para>The function fails if the requested read operation crosses into an area of the process that is inaccessible.</para>
     /// </returns>
     [SuppressUnmanagedCodeSecurity]
+#if NET5_0_OR_GREATER
+    [SuppressGCTransition]
+#endif
 #if NET7_0_OR_GREATER
     [LibraryImport("kernel32.dll", SetLastError = true)]
     [return: MarshalAs(UnmanagedType.Bool)]
@@ -97,6 +100,9 @@ public static extern bool ReadProcessMemory(IntPtr hProcess, UIntPtr lpBaseAddre
     ///     </para>
     /// </returns>
     [SuppressUnmanagedCodeSecurity]
+    #if NET5_0_OR_GREATER
+    [SuppressGCTransition]
+    #endif
 #if NET7_0_OR_GREATER
     [LibraryImport("kernel32.dll", SetLastError = true)]
     [return: MarshalAs(UnmanagedType.Bool)]
@@ -281,6 +287,9 @@ public static extern bool WriteProcessMemory(IntPtr hProcess, UIntPtr lpBaseAddr
     ///     </para>
     /// </returns>
     [SuppressUnmanagedCodeSecurity]
+#if NET5_0_OR_GREATER
+    [SuppressGCTransition]
+#endif
 #if NET7_0_OR_GREATER
     [LibraryImport("kernel32.dll", SetLastError = true)]
     public static partial nuint VirtualAllocEx(IntPtr hProcess, UIntPtr lpAddress, UIntPtr dwSize,
@@ -372,6 +381,9 @@ public static extern nuint VirtualAllocEx(IntPtr hProcess, UIntPtr lpAddress, UI
     ///     </para>
     /// </returns>
     [SuppressUnmanagedCodeSecurity]
+#if NET5_0_OR_GREATER
+    [SuppressGCTransition]
+#endif
 #if NET7_0_OR_GREATER
     [LibraryImport("kernel32.dll")]
     [return: MarshalAs(UnmanagedType.Bool)]
@@ -426,6 +438,9 @@ public static extern bool VirtualFreeEx(IntPtr hProcess, UIntPtr lpAddress, UInt
     ///     <para>If the function fails, the return value is zero. To get extended error information, call <c>GetLastError</c>.</para>
     /// </returns>
     [SuppressUnmanagedCodeSecurity]
+#if NET5_0_OR_GREATER
+    [SuppressGCTransition]
+#endif
 #if NET7_0_OR_GREATER
     [LibraryImport("kernel32.dll", SetLastError = true)]
     [return: MarshalAs(UnmanagedType.Bool)]
@@ -610,6 +625,9 @@ public static extern bool VirtualProtectEx(IntPtr hProcess, UIntPtr lpAddress, U
     ///     </para>
     /// </returns>
     [SuppressUnmanagedCodeSecurity]
+#if NET5_0_OR_GREATER
+    [SuppressGCTransition]
+#endif
 #if NET7_0_OR_GREATER
     [LibraryImport("kernel32.dll", SetLastError = true)]
     public static partial nuint VirtualAlloc(UIntPtr lpAddress, UIntPtr dwSize,
@@ -699,6 +717,9 @@ public static extern nuint VirtualAlloc(UIntPtr lpAddress, UIntPtr dwSize,
     ///     </para>
     /// </returns>
     [SuppressUnmanagedCodeSecurity]
+#if NET5_0_OR_GREATER
+    [SuppressGCTransition]
+#endif
 #if NET7_0_OR_GREATER
     [LibraryImport("kernel32.dll")]
     [return: MarshalAs(UnmanagedType.Bool)]
@@ -752,6 +773,9 @@ public static extern nuint VirtualAlloc(UIntPtr lpAddress, UIntPtr dwSize,
     ///     <para>If the function fails, the return value is zero. To get extended error information, call <c>GetLastError</c>.</para>
     /// </returns>
     [SuppressUnmanagedCodeSecurity]
+#if NET5_0_OR_GREATER
+    [SuppressGCTransition]
+#endif
 #if NET7_0_OR_GREATER
     [LibraryImport("kernel32.dll", SetLastError = true)]
     [return: MarshalAs(UnmanagedType.Bool)]

src/Reloaded.Memory/Reloaded.Memory.csproj

@@ -6,7 +6,7 @@
     <RootNamespace>Reloaded.Memory</RootNamespace>
     <PackageProjectUrl>https://github.com/Reloaded-Project/Reloaded.Memory</PackageProjectUrl>
     <Description>High performance, near zero overhead utilities for working with native memory.</Description>
-    <Version>9.0.0</Version>
+    <Version>9.0.1</Version>
     <Authors>Sewer56</Authors>
     <Product>Reloaded Memory Library</Product>
     <PackageId>Reloaded.Memory</PackageId>