Sprinkle SuppressGCTransition across Unix shim P/Invokes (dotnet#39206)

stephentoub · AaronRobinsonMSFT · web-flow · commit 84c1f62cc29c · 2020-07-16T10:57:47.000-04:00
* Sprinkle SuppressGCTransition across Unix shim P/Invokes

Did a quick audit and added it to all the trivial functions that just return a constant or return some static or map one value to another or such things.

* Address PR feedback

* Update src/libraries/Native/Unix/System.Native/pal_io.c

Co-authored-by: Aaron Robinson &lt;arobins@microsoft.com&gt;

Co-authored-by: Aaron Robinson &lt;arobins@microsoft.com&gt;
diff --git a/src/libraries/Common/src/Interop/Unix/Interop.Errors.cs b/src/libraries/Common/src/Interop/Unix/Interop.Errors.cs
@@ -193,9 +193,11 @@ internal static unsafe string StrError(int platformErrno)
         private static extern unsafe byte* StrErrorR(int platformErrno, byte* buffer, int bufferSize);
 #else
         [DllImport(Libraries.SystemNative, EntryPoint = "SystemNative_ConvertErrorPlatformToPal")]
+        [SuppressGCTransition]
         internal static extern Error ConvertErrorPlatformToPal(int platformErrno);
 
         [DllImport(Libraries.SystemNative, EntryPoint = "SystemNative_ConvertErrorPalToPlatform")]
+        [SuppressGCTransition]
         internal static extern int ConvertErrorPalToPlatform(Error error);
 
         [DllImport(Libraries.SystemNative, EntryPoint = "SystemNative_StrErrorR")]
diff --git a/src/libraries/Common/src/Interop/Unix/System.Native/Interop.Fcntl.Pipe.cs b/src/libraries/Common/src/Interop/Unix/System.Native/Interop.Fcntl.Pipe.cs
@@ -20,6 +20,7 @@ internal static partial class Fcntl
             internal static extern int SetPipeSz(SafePipeHandle fd, int size);
 
             [DllImport(Libraries.SystemNative, EntryPoint = "SystemNative_FcntlCanGetSetPipeSz")]
+            [SuppressGCTransition]
             private static extern int FcntlCanGetSetPipeSz();
         }
     }
diff --git a/src/libraries/Common/src/Interop/Unix/System.Native/Interop.GetDomainSocketSizes.cs b/src/libraries/Common/src/Interop/Unix/System.Native/Interop.GetDomainSocketSizes.cs
@@ -9,6 +9,7 @@ internal static partial class Interop
     internal static partial class Sys
     {
         [DllImport(Libraries.SystemNative, EntryPoint = "SystemNative_GetDomainSocketSizes")]
+        [SuppressGCTransition]
         internal static extern void GetDomainSocketSizes(out int pathOffset, out int pathSize, out int addressSize);
     }
 }
diff --git a/src/libraries/Common/src/Interop/Unix/System.Native/Interop.GetMaximumAddressSize.cs b/src/libraries/Common/src/Interop/Unix/System.Native/Interop.GetMaximumAddressSize.cs
@@ -9,6 +9,7 @@ internal static partial class Interop
     internal static partial class Sys
     {
         [DllImport(Libraries.SystemNative, EntryPoint = "SystemNative_GetMaximumAddressSize")]
+        [SuppressGCTransition]
         internal static extern int GetMaximumAddressSize();
     }
 }
diff --git a/src/libraries/Common/src/Interop/Unix/System.Native/Interop.IPPacketInformation.cs b/src/libraries/Common/src/Interop/Unix/System.Native/Interop.IPPacketInformation.cs
@@ -17,7 +17,8 @@ internal struct IPPacketInformation
         }
 
         [DllImport(Libraries.SystemNative, EntryPoint = "SystemNative_GetControlMessageBufferSize")]
-        internal static extern int GetControlMessageBufferSize(bool isIPv4, bool isIPv6);
+        [SuppressGCTransition]
+        internal static extern int GetControlMessageBufferSize(int isIPv4, int isIPv6);
 
         [DllImport(Libraries.SystemNative, EntryPoint = "SystemNative_TryGetIPPacketInformation")]
         internal static extern unsafe bool TryGetIPPacketInformation(MessageHeader* messageHeader, bool isIPv4, IPPacketInformation* packetInfo);
diff --git a/src/libraries/Common/src/Interop/Unix/System.Native/Interop.LChflags.cs b/src/libraries/Common/src/Interop/Unix/System.Native/Interop.LChflags.cs
@@ -20,6 +20,7 @@ internal enum UserFlags : uint
         internal static readonly bool CanSetHiddenFlag = (LChflagsCanSetHiddenFlag() != 0);
 
         [DllImport(Libraries.SystemNative, EntryPoint = "SystemNative_LChflagsCanSetHiddenFlag")]
+        [SuppressGCTransition]
         private static extern int LChflagsCanSetHiddenFlag();
     }
 }
diff --git a/src/libraries/Common/src/Interop/Unix/System.Native/Interop.MapTcpState.cs b/src/libraries/Common/src/Interop/Unix/System.Native/Interop.MapTcpState.cs
@@ -9,6 +9,7 @@ internal static partial class Interop
     internal static partial class Sys
     {
         [DllImport(Libraries.SystemNative, EntryPoint = "SystemNative_MapTcpState")]
+        [SuppressGCTransition]
         internal static extern TcpState MapTcpState(int nativeState);
     }
 }
diff --git a/src/libraries/Common/src/Interop/Unix/System.Native/Interop.PlatformSocketSupport.cs b/src/libraries/Common/src/Interop/Unix/System.Native/Interop.PlatformSocketSupport.cs
@@ -8,6 +8,7 @@ internal static partial class Interop
     internal static partial class Sys
     {
         [DllImport(Libraries.SystemNative, EntryPoint = "SystemNative_PlatformSupportsDualModeIPv4PacketInfo")]
-        internal static extern bool PlatformSupportsDualModeIPv4PacketInfo();
+        [SuppressGCTransition]
+        internal static extern int PlatformSupportsDualModeIPv4PacketInfo();
     }
 }
diff --git a/src/libraries/Common/src/Interop/Unix/System.Native/Interop.ReadDir.cs b/src/libraries/Common/src/Interop/Unix/System.Native/Interop.ReadDir.cs
@@ -57,6 +57,7 @@ internal ReadOnlySpan<char> GetName(Span<char> buffer)
         internal static extern IntPtr OpenDir(string path);
 
         [DllImport(Libraries.SystemNative, EntryPoint = "SystemNative_GetReadDirRBufferSize", SetLastError = false)]
+        [SuppressGCTransition]
         internal static extern int GetReadDirRBufferSize();
 
         [DllImport(Libraries.SystemNative, EntryPoint = "SystemNative_ReadDirR", SetLastError = false)]
diff --git a/src/libraries/Common/src/Interop/Unix/System.Native/Interop.RegisterForCtrlC.cs b/src/libraries/Common/src/Interop/Unix/System.Native/Interop.RegisterForCtrlC.cs
@@ -16,9 +16,11 @@ internal enum CtrlCode
         internal delegate void CtrlCallback(CtrlCode ctrlCode);
 
         [DllImport(Libraries.SystemNative, EntryPoint = "SystemNative_RegisterForCtrl")]
+        [SuppressGCTransition]
         internal static extern void RegisterForCtrl(CtrlCallback handler);
 
         [DllImport(Libraries.SystemNative, EntryPoint = "SystemNative_UnregisterForCtrl")]
+        [SuppressGCTransition]
         internal static extern void UnregisterForCtrl();
     }
 }
diff --git a/src/libraries/Common/src/Interop/Unix/System.Native/Interop.SetSignalForBreak.cs b/src/libraries/Common/src/Interop/Unix/System.Native/Interop.SetSignalForBreak.cs
@@ -8,9 +8,10 @@ internal static partial class Interop
     internal static partial class Sys
     {
         [DllImport(Libraries.SystemNative, EntryPoint = "SystemNative_GetSignalForBreak")]
-        internal static extern bool GetSignalForBreak();
+        [SuppressGCTransition]
+        internal static extern int GetSignalForBreak();
 
         [DllImport(Libraries.SystemNative, EntryPoint = "SystemNative_SetSignalForBreak")]
-        internal static extern bool SetSignalForBreak(bool signalForBreak);
+        internal static extern int SetSignalForBreak(int signalForBreak);
     }
 }
diff --git a/src/libraries/Common/src/Interop/Unix/System.Native/Interop.SetTerminalInvalidationHandler.cs b/src/libraries/Common/src/Interop/Unix/System.Native/Interop.SetTerminalInvalidationHandler.cs
@@ -10,6 +10,7 @@ internal partial class Sys
         internal delegate void TerminalInvalidationCallback();
 
         [DllImport(Libraries.SystemNative, EntryPoint = "SystemNative_SetTerminalInvalidationHandler")]
+        [SuppressGCTransition]
         internal static extern void SetTerminalInvalidationHandler(TerminalInvalidationCallback handler);
     }
 }
diff --git a/src/libraries/Common/src/Interop/Unix/System.Native/Interop.SocketAddress.cs b/src/libraries/Common/src/Interop/Unix/System.Native/Interop.SocketAddress.cs
@@ -10,24 +10,31 @@ internal static partial class Interop
     internal static partial class Sys
     {
         [DllImport(Libraries.SystemNative, EntryPoint = "SystemNative_GetIPSocketAddressSizes")]
+        [SuppressGCTransition]
         internal static extern unsafe Error GetIPSocketAddressSizes(int* ipv4SocketAddressSize, int* ipv6SocketAddressSize);
 
         [DllImport(Libraries.SystemNative, EntryPoint = "SystemNative_GetAddressFamily")]
+        [SuppressGCTransition]
         internal static extern unsafe Error GetAddressFamily(byte* socketAddress, int socketAddressLen, int* addressFamily);
 
         [DllImport(Libraries.SystemNative, EntryPoint = "SystemNative_SetAddressFamily")]
+        [SuppressGCTransition]
         internal static extern unsafe Error SetAddressFamily(byte* socketAddress, int socketAddressLen, int addressFamily);
 
         [DllImport(Libraries.SystemNative, EntryPoint = "SystemNative_GetPort")]
+        [SuppressGCTransition]
         internal static extern unsafe Error GetPort(byte* socketAddress, int socketAddressLen, ushort* port);
 
         [DllImport(Libraries.SystemNative, EntryPoint = "SystemNative_SetPort")]
+        [SuppressGCTransition]
         internal static extern unsafe Error SetPort(byte* socketAddress, int socketAddressLen, ushort port);
 
         [DllImport(Libraries.SystemNative, EntryPoint = "SystemNative_GetIPv4Address")]
+        [SuppressGCTransition]
         internal static extern unsafe Error GetIPv4Address(byte* socketAddress, int socketAddressLen, uint* address);
 
         [DllImport(Libraries.SystemNative, EntryPoint = "SystemNative_SetIPv4Address")]
+        [SuppressGCTransition]
         internal static extern unsafe Error SetIPv4Address(byte* socketAddress, int socketAddressLen, uint address);
 
         [DllImport(Libraries.SystemNative, EntryPoint = "SystemNative_GetIPv6Address")]
diff --git a/src/libraries/System.Console/src/System/ConsolePal.Unix.cs b/src/libraries/System.Console/src/System/ConsolePal.Unix.cs
@@ -143,14 +143,14 @@ public static bool TreatControlCAsInput
                     return false;
 
                 EnsureConsoleInitialized();
-                return !Interop.Sys.GetSignalForBreak();
+                return Interop.Sys.GetSignalForBreak() == 0;
             }
             set
             {
                 if (!Console.IsInputRedirected)
                 {
                     EnsureConsoleInitialized();
-                    if (!Interop.Sys.SetSignalForBreak(signalForBreak: !value))
+                    if (Interop.Sys.SetSignalForBreak(Convert.ToInt32(value)) == 0)
                         throw Interop.GetExceptionForIoErrno(Interop.Sys.GetLastErrorInfo());
                 }
             }
diff --git a/src/libraries/System.Net.Sockets/src/System/Net/Sockets/SocketPal.Unix.cs b/src/libraries/System.Net.Sockets/src/System/Net/Sockets/SocketPal.Unix.cs
@@ -22,10 +22,8 @@ internal static partial class SocketPal
         // that get stackalloced in the Linux kernel.
         private const int IovStackThreshold = 8;
 
-        private static bool GetPlatformSupportsDualModeIPv4PacketInfo()
-        {
-            return Interop.Sys.PlatformSupportsDualModeIPv4PacketInfo();
-        }
+        private static bool GetPlatformSupportsDualModeIPv4PacketInfo() =>
+            Interop.Sys.PlatformSupportsDualModeIPv4PacketInfo() != 0;
 
         public static void Initialize()
         {
@@ -422,8 +420,8 @@ private static unsafe int SysReceiveMessageFrom(SafeSocketHandle socket, SocketF
         {
             Debug.Assert(socketAddress != null, "Expected non-null socketAddress");
 
-            int cmsgBufferLen = Interop.Sys.GetControlMessageBufferSize(isIPv4, isIPv6);
-            var cmsgBuffer = stackalloc byte[cmsgBufferLen];
+            int cmsgBufferLen = Interop.Sys.GetControlMessageBufferSize(Convert.ToInt32(isIPv4), Convert.ToInt32(isIPv6));
+            byte* cmsgBuffer = stackalloc byte[cmsgBufferLen];
 
             int sockAddrLen = socketAddressLen;
 
@@ -498,8 +496,8 @@ private static unsafe int SysReceiveMessageFrom(
                 fixed (byte* sockAddr = socketAddress)
                 fixed (Interop.Sys.IOVector* iov = iovecs)
                 {
-                    int cmsgBufferLen = Interop.Sys.GetControlMessageBufferSize(isIPv4, isIPv6);
-                    var cmsgBuffer = stackalloc byte[cmsgBufferLen];
+                    int cmsgBufferLen = Interop.Sys.GetControlMessageBufferSize(Convert.ToInt32(isIPv4), Convert.ToInt32(isIPv6));
+                    byte* cmsgBuffer = stackalloc byte[cmsgBufferLen];
 
                     var messageHeader = new Interop.Sys.MessageHeader
                     {

Original file line number	Diff line number	Diff line change
`@@ -20,6 +20,7 @@ internal static partial class Fcntl`
`20`	`20`	`internal static extern int SetPipeSz(SafePipeHandle fd, int size);`
`21`	`21`
`22`	`22`	`[DllImport(Libraries.SystemNative, EntryPoint = "SystemNative_FcntlCanGetSetPipeSz")]`
	`23`	`+ [SuppressGCTransition]`
`23`	`24`	`private static extern int FcntlCanGetSetPipeSz();`
`24`	`25`	`}`
`25`	`26`	`}`
Original file line number	Diff line number	Diff line change
`@@ -9,6 +9,7 @@ internal static partial class Interop`
`9`	`9`	`internal static partial class Sys`
`10`	`10`	`{`
`11`	`11`	`[DllImport(Libraries.SystemNative, EntryPoint = "SystemNative_GetDomainSocketSizes")]`
	`12`	`+ [SuppressGCTransition]`
`12`	`13`	`internal static extern void GetDomainSocketSizes(out int pathOffset, out int pathSize, out int addressSize);`
`13`	`14`	`}`
`14`	`15`	`}`
Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,8 @@ internal struct IPPacketInformation`
`17`	`17`	`}`
`18`	`18`
`19`	`19`	`[DllImport(Libraries.SystemNative, EntryPoint = "SystemNative_GetControlMessageBufferSize")]`
`20`		`- internal static extern int GetControlMessageBufferSize(bool isIPv4, bool isIPv6);`
	`20`	`+ [SuppressGCTransition]`
	`21`	`+ internal static extern int GetControlMessageBufferSize(int isIPv4, int isIPv6);`
`21`	`22`
`22`	`23`	`[DllImport(Libraries.SystemNative, EntryPoint = "SystemNative_TryGetIPPacketInformation")]`
`23`	`24`	`internal static extern unsafe bool TryGetIPPacketInformation(MessageHeader* messageHeader, bool isIPv4, IPPacketInformation* packetInfo);`
Original file line number	Diff line number	Diff line change
`@@ -20,6 +20,7 @@ internal enum UserFlags : uint`
`20`	`20`	`internal static readonly bool CanSetHiddenFlag = (LChflagsCanSetHiddenFlag() != 0);`
`21`	`21`
`22`	`22`	`[DllImport(Libraries.SystemNative, EntryPoint = "SystemNative_LChflagsCanSetHiddenFlag")]`
	`23`	`+ [SuppressGCTransition]`
`23`	`24`	`private static extern int LChflagsCanSetHiddenFlag();`
`24`	`25`	`}`
`25`	`26`	`}`
Original file line number	Diff line number	Diff line change
`@@ -8,6 +8,7 @@ internal static partial class Interop`
`8`	`8`	`internal static partial class Sys`
`9`	`9`	`{`
`10`	`10`	`[DllImport(Libraries.SystemNative, EntryPoint = "SystemNative_PlatformSupportsDualModeIPv4PacketInfo")]`
`11`		`- internal static extern bool PlatformSupportsDualModeIPv4PacketInfo();`
	`11`	`+ [SuppressGCTransition]`
	`12`	`+ internal static extern int PlatformSupportsDualModeIPv4PacketInfo();`
`12`	`13`	`}`
`13`	`14`	`}`
Original file line number	Diff line number	Diff line change
`@@ -16,9 +16,11 @@ internal enum CtrlCode`
`16`	`16`	`internal delegate void CtrlCallback(CtrlCode ctrlCode);`
`17`	`17`
`18`	`18`	`[DllImport(Libraries.SystemNative, EntryPoint = "SystemNative_RegisterForCtrl")]`
	`19`	`+ [SuppressGCTransition]`
`19`	`20`	`internal static extern void RegisterForCtrl(CtrlCallback handler);`
`20`	`21`
`21`	`22`	`[DllImport(Libraries.SystemNative, EntryPoint = "SystemNative_UnregisterForCtrl")]`
	`23`	`+ [SuppressGCTransition]`
`22`	`24`	`internal static extern void UnregisterForCtrl();`
`23`	`25`	`}`
`24`	`26`	`}`