Update certain Marshal APIs to match exception thrown on .NET Framework (dotnet/corec...

Update certain Marshal APIs to match exception thrown on Desktop

Commit migrated from https://github.com/dotnet/coreclr/commit/c32eff71383529355f85c83c3caee1953501e2e1

diff --git a/src/coreclr/src/System.Private.CoreLib/src/System/Runtime/InteropServices/Marshal.cs b/src/coreclr/src/System.Private.CoreLib/src/System/Runtime/InteropServices/Marshal.cs
index 3805c2f..40b934c 100644 (file)
--- a/src/coreclr/src/System.Private.CoreLib/src/System/Runtime/InteropServices/Marshal.cs
+++ b/src/coreclr/src/System.Private.CoreLib/src/System/Runtime/InteropServices/Marshal.cs
@@ -484,7 +484,7 @@ namespace System.Runtime.InteropServices
 #if BIT64
             return (IntPtr)ReadInt64(ptr, ofs);
 #else // 32
-                return (IntPtr) ReadInt32(ptr, ofs);
+            return (IntPtr)ReadInt32(ptr, ofs);
 #endif
         }
 
@@ -493,7 +493,7 @@ namespace System.Runtime.InteropServices
 #if BIT64
             return (IntPtr)ReadInt64(ptr, ofs);
 #else // 32
-                return (IntPtr) ReadInt32(ptr, ofs);
+            return (IntPtr)ReadInt32(ptr, ofs);
 #endif
         }
 
@@ -502,7 +502,7 @@ namespace System.Runtime.InteropServices
 #if BIT64
             return (IntPtr)ReadInt64(ptr, 0);
 #else // 32
-                return (IntPtr) ReadInt32(ptr, 0);
+            return (IntPtr)ReadInt32(ptr, 0);
 #endif
         }
 
@@ -553,23 +553,22 @@ namespace System.Runtime.InteropServices
         // Read value from marshaled object (marshaled using AsAny)
         // It's quite slow and can return back dangling pointers
         // It's only there for backcompact
-        // I don't think we should spend time optimizing it
-        // People should really call the IntPtr overload instead
+        // People should instead use the IntPtr overloads
         //====================================================================
         private static unsafe T ReadValueSlow<T>(object ptr, int ofs, Func<IntPtr, int, T> readValueHelper)
         {
-            // We AV on desktop if passing NULL. So this is technically a breaking change but is an improvement
+            // Consumers of this method are documented to throw AccessViolationException on any AV
             if (ptr == null)
-                throw new ArgumentNullException(nameof(ptr));
+                throw new AccessViolationException();
 
             int dwFlags = 
                 (int)AsAnyMarshaler.AsAnyFlags.In | 
                 (int)AsAnyMarshaler.AsAnyFlags.IsAnsi | 
                 (int)AsAnyMarshaler.AsAnyFlags.IsBestFit;
 
-            MngdNativeArrayMarshaler.MarshalerState nativeArrayMarshalerState = new MngdNativeArrayMarshaler.MarshalerState();                
+            MngdNativeArrayMarshaler.MarshalerState nativeArrayMarshalerState = new MngdNativeArrayMarshaler.MarshalerState();
             AsAnyMarshaler marshaler = new AsAnyMarshaler(new IntPtr(&nativeArrayMarshalerState));
-                
+
             IntPtr pNativeHome = IntPtr.Zero;
 
             try
@@ -580,11 +579,9 @@ namespace System.Runtime.InteropServices
             finally
             {
                 marshaler.ClearNative(pNativeHome);
-            }    
+            }
         }
 
-
-
         //====================================================================
         // Write to memory
         //====================================================================
@@ -704,7 +701,7 @@ namespace System.Runtime.InteropServices
 #if BIT64
             WriteInt64(ptr, ofs, (long)val);
 #else // 32
-                WriteInt32(ptr, ofs, (int)val);
+            WriteInt32(ptr, ofs, (int)val);
 #endif
         }
 
@@ -713,7 +710,7 @@ namespace System.Runtime.InteropServices
 #if BIT64
             WriteInt64(ptr, ofs, (long)val);
 #else // 32
-                WriteInt32(ptr, ofs, (int)val);
+            WriteInt32(ptr, ofs, (int)val);
 #endif
         }
 
@@ -722,7 +719,7 @@ namespace System.Runtime.InteropServices
 #if BIT64
             WriteInt64(ptr, 0, (long)val);
 #else // 32
-                WriteInt32(ptr, 0, (int)val);
+            WriteInt32(ptr, 0, (int)val);
 #endif
         }
 
@@ -770,25 +767,25 @@ namespace System.Runtime.InteropServices
         //====================================================================
         // Write value into marshaled object (marshaled using AsAny) and
         // propagate the value back
-        // It's quite slow and is only there for backcompact
-        // I don't think we should spend time optimizing it
-        // People should really call the IntPtr overload instead
+        // It's quite slow and can return back dangling pointers
+        // It's only there for backcompact
+        // People should instead use the IntPtr overloads
         //====================================================================
         private static unsafe void WriteValueSlow<T>(object ptr, int ofs, T val, Action<IntPtr, int, T> writeValueHelper)
         {
-            // We AV on desktop if passing NULL. So this is technically a breaking change but is an improvement
+            // Consumers of this method are documented to throw AccessViolationException on any AV
             if (ptr == null)
-                throw new ArgumentNullException(nameof(ptr));
-                            
+                throw new AccessViolationException();
+
             int dwFlags = 
                 (int)AsAnyMarshaler.AsAnyFlags.In | 
                 (int)AsAnyMarshaler.AsAnyFlags.Out | 
                 (int)AsAnyMarshaler.AsAnyFlags.IsAnsi | 
                 (int)AsAnyMarshaler.AsAnyFlags.IsBestFit;
 
-            MngdNativeArrayMarshaler.MarshalerState nativeArrayMarshalerState = new MngdNativeArrayMarshaler.MarshalerState();                
+            MngdNativeArrayMarshaler.MarshalerState nativeArrayMarshalerState = new MngdNativeArrayMarshaler.MarshalerState();
             AsAnyMarshaler marshaler = new AsAnyMarshaler(new IntPtr(&nativeArrayMarshalerState));
-                
+
             IntPtr pNativeHome = IntPtr.Zero;
 
             try
@@ -800,7 +797,7 @@ namespace System.Runtime.InteropServices
             finally
             {
                 marshaler.ClearNative(pNativeHome);
-            }            
+            }
         }
 
         //====================================================================

diff --git a/src/coreclr/tests/src/Interop/MarshalAPI/ReadWrite/ReadWriteObject.cs b/src/coreclr/tests/src/Interop/MarshalAPI/ReadWrite/ReadWriteObject.cs
index a11c10b..951954f 100644 (file)
--- a/src/coreclr/tests/src/Interop/MarshalAPI/ReadWrite/ReadWriteObject.cs
+++ b/src/coreclr/tests/src/Interop/MarshalAPI/ReadWrite/ReadWriteObject.cs
@@ -37,15 +37,15 @@ class Test
 
     static void TestNegativeCases()
     {
-        Assert.Throws<ArgumentNullException>(() => { Marshal.WriteByte(null, 0, 0); });
-        Assert.Throws<ArgumentNullException>(() => { Marshal.WriteInt16(null, 0, 0); });
-        Assert.Throws<ArgumentNullException>(() => { Marshal.WriteInt32(null, 0, 0); });
-        Assert.Throws<ArgumentNullException>(() => { Marshal.WriteInt64(null, 0, 0); });
-        Assert.Throws<ArgumentNullException>(() => { Marshal.WriteIntPtr(null, 0, IntPtr.Zero); });
-        Assert.Throws<ArgumentNullException>(() => { Marshal.ReadByte(null, 0); });
-        Assert.Throws<ArgumentNullException>(() => { Marshal.ReadInt16(null, 0); });
-        Assert.Throws<ArgumentNullException>(() => { Marshal.ReadInt32(null, 0); });
-        Assert.Throws<ArgumentNullException>(() => { Marshal.ReadIntPtr(null, 0); });
+        Assert.Throws<AccessViolationException>(() => { Marshal.WriteByte(null, 0, 0); });
+        Assert.Throws<AccessViolationException>(() => { Marshal.WriteInt16(null, 0, 0); });
+        Assert.Throws<AccessViolationException>(() => { Marshal.WriteInt32(null, 0, 0); });
+        Assert.Throws<AccessViolationException>(() => { Marshal.WriteInt64(null, 0, 0); });
+        Assert.Throws<AccessViolationException>(() => { Marshal.WriteIntPtr(null, 0, IntPtr.Zero); });
+        Assert.Throws<AccessViolationException>(() => { Marshal.ReadByte(null, 0); });
+        Assert.Throws<AccessViolationException>(() => { Marshal.ReadInt16(null, 0); });
+        Assert.Throws<AccessViolationException>(() => { Marshal.ReadInt32(null, 0); });
+        Assert.Throws<AccessViolationException>(() => { Marshal.ReadIntPtr(null, 0); });
     }
 
     static void TestBlittableStruct()