Cleanup | Preparation for OS-independent builds (dotnet#3844)

edwardneal · web-flow · commit b1b93a8947df · 2026-04-16T11:41:35.000-07:00
* Implement early infrastructure for OS-independent builds.
Also clean up the netfx-only s_isWindowsNT variable - this was originally used to distinguish between Windows 9x and Windows NT!

* SqlFileStream

We only throw a PlatformNotSupportedException in the constructor; if this throws, there's no way execution can reach a property or method.

* SqlColumnEncryptionCngProvider

* SqlColumnEncryptionCspProvider

* Manually inline ThrowOnNonWindowsPlatform

This is necessary because when an application using SqlClient is being published, the IL trimmer doesn't see that the throw helper throws an exception, and thus doesn't eliminate the code paths which call Windows-specific APIs. As a result, the Windows-specific API paths aren't removed from executables published for a Linux platform.

* Correct preprocessor directive indentation
diff --git a/src/Microsoft.Data.SqlClient/src/Interop/Windows/Kernel32/FileTypes.cs b/src/Microsoft.Data.SqlClient/src/Interop/Windows/Kernel32/FileTypes.cs
@@ -2,8 +2,6 @@
 // The .NET Foundation licenses this file to you under the MIT license.
 // See the LICENSE file in the project root for more information.
 
-#if _WINDOWS
-
 namespace Interop.Windows.Kernel32
 {
     internal class FileTypes
@@ -14,5 +12,3 @@ internal class FileTypes
         internal const int FILE_TYPE_PIPE = 0x0003;
     }
 }
-
-#endif
diff --git a/src/Microsoft.Data.SqlClient/src/Interop/Windows/Kernel32/IoControlCodeAccess.cs b/src/Microsoft.Data.SqlClient/src/Interop/Windows/Kernel32/IoControlCodeAccess.cs
@@ -2,8 +2,6 @@
 // The .NET Foundation licenses this file to you under the MIT license.
 // See the LICENSE file in the project root for more information.
 
-#if _WINDOWS
-
 using System;
 
 namespace Interop.Windows.Kernel32
@@ -33,5 +31,3 @@ internal enum IoControlCodeAccess
         FILE_WRITE_DATA = 0x02
     }
 }
-
-#endif
diff --git a/src/Microsoft.Data.SqlClient/src/Interop/Windows/Kernel32/IoControlTransferType.cs b/src/Microsoft.Data.SqlClient/src/Interop/Windows/Kernel32/IoControlTransferType.cs
@@ -2,8 +2,6 @@
 // The .NET Foundation licenses this file to you under the MIT license.
 // See the LICENSE file in the project root for more information.
 
-#if _WINDOWS
-
 namespace Interop.Windows.Kernel32
 {
     /// <summary>
@@ -37,5 +35,3 @@ internal enum IoControlTransferType
         METHOD_NEITHER
     }
 }
-
-#endif
diff --git a/src/Microsoft.Data.SqlClient/src/Interop/Windows/Kernel32/Kernel32.cs b/src/Microsoft.Data.SqlClient/src/Interop/Windows/Kernel32/Kernel32.cs
@@ -2,15 +2,13 @@
 // The .NET Foundation licenses this file to you under the MIT license.
 // See the LICENSE file in the project root for more information.
 
-#if _WINDOWS
-
 using System;
 using System.Runtime.InteropServices;
 using System.Text;
 using Microsoft.Data.Common;
 using Microsoft.Win32.SafeHandles;
 
-#if !NETFRAMEWORK
+#if !NETFRAMEWORK && _WINDOWS
 using Interop.Windows.Handles;
 #endif
 
@@ -21,7 +19,7 @@ internal static class Kernel32
         internal const ushort FILE_DEVICE_FILE_SYSTEM = 0x0009;
         internal const uint SEM_FAILCRITICALERRORS = 1;
 
-        #if !NETFRAMEWORK
+        #if _WINDOWS && !NETFRAMEWORK
         internal const int LOAD_LIBRARY_AS_DATAFILE = 0x00000002;
         internal const int LOAD_LIBRARY_SEARCH_SYSTEM32 = 0x00000800;
         #endif
@@ -56,7 +54,7 @@ internal static extern bool DeviceIoControl(
             out uint cbBytesReturned,
             IntPtr overlapped);
 
-        #if NET
+        #if NET && _WINDOWS
         [DllImport(DllName, ExactSpelling = true, SetLastError = true)]
         public static extern bool FreeLibrary([In] IntPtr hModule);
         #endif
@@ -73,17 +71,13 @@ internal static extern int GetFullPathName(
             IntPtr lpFilePartOrNull);
         #endif
 
-        #if NET
+        #if NET && _WINDOWS
         [DllImport(DllName, CharSet = CharSet.Ansi, BestFitMapping = false)]
         public static extern IntPtr GetProcAddress(IntPtr hModule, string lpProcName);
-        #endif
 
-        #if NET
         [DllImport(DllName, CharSet = CharSet.Ansi, BestFitMapping = false)]
         public static extern IntPtr GetProcAddress(SafeLibraryHandle hModule, string lpProcName);
-        #endif
 
-        #if NET
         [DllImport(DllName, ExactSpelling = true, CharSet = CharSet.Unicode, SetLastError = true)]
         public static extern SafeLibraryHandle LoadLibraryExW([In] string lpwLibFileName, [In] IntPtr hFile, [In] uint dwFlags);
         #endif
@@ -92,5 +86,3 @@ internal static extern int GetFullPathName(
         internal static extern bool SetThreadErrorMode(uint dwNewMode, out uint lpOldMode);
     }
 }
-
-#endif
diff --git a/src/Microsoft.Data.SqlClient/src/Interop/Windows/NtDll/CreateDisposition.cs b/src/Microsoft.Data.SqlClient/src/Interop/Windows/NtDll/CreateDisposition.cs
@@ -2,8 +2,6 @@
 // The .NET Foundation licenses this file to you under the MIT license.
 // See the LICENSE file in the project root for more information.
 
-#if _WINDOWS
-
 namespace Interop.Windows.NtDll
 {
     /// <summary>
@@ -56,5 +54,3 @@ internal enum CreateDisposition : uint
         FILE_OVERWRITE_IF = 5
     }
 }
-
-#endif
diff --git a/src/Microsoft.Data.SqlClient/src/Interop/Windows/NtDll/CreateOptions.cs b/src/Microsoft.Data.SqlClient/src/Interop/Windows/NtDll/CreateOptions.cs
@@ -2,8 +2,6 @@
 // The .NET Foundation licenses this file to you under the MIT license.
 // See the LICENSE file in the project root for more information.
 
-#if _WINDOWS
-
 using System;
 
 namespace Interop.Windows.NtDll
@@ -198,5 +196,3 @@ internal enum CreateOptions : uint
         // FILE_OPEN_FOR_FREE_SPACE_QUERY = 0x00800000
     }
 }
-
-#endif
diff --git a/src/Microsoft.Data.SqlClient/src/Interop/Windows/NtDll/DesiredAccess.cs b/src/Microsoft.Data.SqlClient/src/Interop/Windows/NtDll/DesiredAccess.cs
@@ -2,8 +2,6 @@
 // The .NET Foundation licenses this file to you under the MIT license.
 // See the LICENSE file in the project root for more information.
 
-#if _WINDOWS
-
 using System;
 
 namespace Interop.Windows.NtDll
@@ -190,5 +188,3 @@ internal enum DesiredAccess : uint
         FILE_GENERIC_EXECUTE = 0x20000000 // GENERIC_EXECUTE
     }
 }
-
-#endif
diff --git a/src/Microsoft.Data.SqlClient/src/Interop/Windows/NtDll/FileFullEaInformation.cs b/src/Microsoft.Data.SqlClient/src/Interop/Windows/NtDll/FileFullEaInformation.cs
@@ -2,8 +2,6 @@
 // The .NET Foundation licenses this file to you under the MIT license.
 // See the LICENSE file in the project root for more information.
 
-#if _WINDOWS
-
 using System.Runtime.InteropServices;
 
 namespace Interop.Windows.NtDll
@@ -37,5 +35,3 @@ internal struct FileFullEaInformation
 
     }
 }
-
-#endif
diff --git a/src/Microsoft.Data.SqlClient/src/Interop/Windows/NtDll/ImpersonationLevel.cs b/src/Microsoft.Data.SqlClient/src/Interop/Windows/NtDll/ImpersonationLevel.cs
@@ -2,8 +2,6 @@
 // The .NET Foundation licenses this file to you under the MIT license.
 // See the LICENSE file in the project root for more information.
 
-#if _WINDOWS
-
 namespace Interop.Windows.NtDll
 {
     /// <summary>
@@ -41,5 +39,3 @@ internal enum ImpersonationLevel
         SecurityDelegation = 3,
     }
 }
-
-#endif
diff --git a/src/Microsoft.Data.SqlClient/src/Interop/Windows/NtDll/IoStatusBlock.cs b/src/Microsoft.Data.SqlClient/src/Interop/Windows/NtDll/IoStatusBlock.cs
@@ -2,8 +2,6 @@
 // The .NET Foundation licenses this file to you under the MIT license.
 // See the LICENSE file in the project root for more information.
 
-#if _WINDOWS
-
 using System;
 using System.Runtime.InteropServices;
 
@@ -44,5 +42,3 @@ public struct IoStatus
         }
     }
 }
-
-#endif
diff --git a/src/Microsoft.Data.SqlClient/src/Interop/Windows/NtDll/NtDll.cs b/src/Microsoft.Data.SqlClient/src/Interop/Windows/NtDll/NtDll.cs
@@ -2,8 +2,6 @@
 // The .NET Foundation licenses this file to you under the MIT license.
 // See the LICENSE file in the project root for more information.
 
-#if _WINDOWS
-
 using System;
 using System.IO;
 using System.Runtime.InteropServices;
@@ -120,5 +118,3 @@ private static extern unsafe int NtCreateFile(
             uint EaLength);
     }
 }
-
-#endif
diff --git a/src/Microsoft.Data.SqlClient/src/Interop/Windows/NtDll/ObjectAttributeFlags.cs b/src/Microsoft.Data.SqlClient/src/Interop/Windows/NtDll/ObjectAttributeFlags.cs
@@ -2,8 +2,6 @@
 // The .NET Foundation licenses this file to you under the MIT license.
 // See the LICENSE file in the project root for more information.
 
-#if _WINDOWS
-
 using System;
 
 namespace Interop.Windows.NtDll
@@ -54,5 +52,3 @@ internal enum ObjectAttributeFlags : uint
         // OBJ_VALID_ATTRIBUTES = 0x000001F2
     }
 }
-
-#endif
diff --git a/src/Microsoft.Data.SqlClient/src/Interop/Windows/NtDll/ObjectAttributes.cs b/src/Microsoft.Data.SqlClient/src/Interop/Windows/NtDll/ObjectAttributes.cs
@@ -2,8 +2,6 @@
 // The .NET Foundation licenses this file to you under the MIT license.
 // See the LICENSE file in the project root for more information.
 
-#if _WINDOWS
-
 using System;
 
 namespace Interop.Windows.NtDll
@@ -60,5 +58,3 @@ public ObjectAttributes(
         }
     }
 }
-
-#endif
diff --git a/src/Microsoft.Data.SqlClient/src/Interop/Windows/NtDll/SecurityQualityOfService.cs b/src/Microsoft.Data.SqlClient/src/Interop/Windows/NtDll/SecurityQualityOfService.cs
@@ -2,8 +2,6 @@
 // The .NET Foundation licenses this file to you under the MIT license.
 // See the LICENSE file in the project root for more information.
 
-#if _WINDOWS
-
 using System.Runtime.InteropServices;
 
 namespace Interop.Windows.NtDll
@@ -50,5 +48,3 @@ public SecurityQualityOfService(
         public bool IsEffectiveOnly { get; set; }
     }
 }
-
-#endif
diff --git a/src/Microsoft.Data.SqlClient/src/Interop/Windows/SystemErrors.cs b/src/Microsoft.Data.SqlClient/src/Interop/Windows/SystemErrors.cs
@@ -2,8 +2,6 @@
 // The .NET Foundation licenses this file to you under the MIT license.
 // See the LICENSE file in the project root for more information.
 
-#if _WINDOWS
-
 namespace Interop.Windows
 {
     // https://msdn.microsoft.com/en-us/library/windows/desktop/ms681382.aspx
@@ -22,5 +20,3 @@ internal class SystemErrors
         internal const int ERROR_MR_MID_NOT_FOUND = 317;
     }
 }
-
-#endif
diff --git a/src/Microsoft.Data.SqlClient/src/Interop/Windows/UnicodeString.cs b/src/Microsoft.Data.SqlClient/src/Interop/Windows/UnicodeString.cs
@@ -2,8 +2,6 @@
 // The .NET Foundation licenses this file to you under the MIT license.
 // See the LICENSE file in the project root for more information.
 
-#if _WINDOWS
-
 using System.Runtime.InteropServices;
 
 namespace Interop.Windows
@@ -36,5 +34,3 @@ public UnicodeString(char* buffer, int length)
         }
     }
 }
-
-#endif
diff --git a/src/Microsoft.Data.SqlClient/src/Microsoft/Data/Common/AdapterUtil.cs b/src/Microsoft.Data.SqlClient/src/Microsoft/Data/Common/AdapterUtil.cs
@@ -22,6 +22,7 @@
 using Microsoft.Data.SqlClient;
 using Microsoft.Data.SqlClient.Connection;
 using Microsoft.SqlServer.Server;
+using Microsoft.Win32;
 using IsolationLevel = System.Data.IsolationLevel;
 using Microsoft.Data.SqlClient.Internal;
 
@@ -30,10 +31,6 @@
 using System.Security.Permissions;
 #endif
 
-#if _WINDOWS
-using Microsoft.Win32;
-#endif
-
 namespace Microsoft.Data.Common
 {
     /// <summary>
@@ -68,6 +65,22 @@ internal static partial class ADP
         /// </summary>
         internal const int MaxBufferAccessTokenExpiry = 600;
 
+        /// <summary>
+        /// This member returns true if the current OS platform is Windows.
+        /// </summary>
+        /// <remarks>
+        /// This is a const on .NET Framework, and a property on .NET Core, because of differing API availability and JIT requirements.
+        /// .NET Framework will perform basic dead branch elimination when a const value is encountered, while .NET Core can trim Windows-specific
+        /// code when published to non-Windows platforms.
+        /// .NET Core's trimming is very limited though, so this must be used inline within methods to throw PlatformNotSupportedException,
+        /// rather than in a throw helper.
+        /// </remarks>
+        #if NETFRAMEWORK
+        public const bool IsWindows = true;
+        #else
+        public static bool IsWindows => OperatingSystem.IsWindows();
+        #endif
+
         #region UDT
 
         #if NETFRAMEWORK
@@ -435,17 +448,16 @@ internal static ArgumentOutOfRangeException InvalidCommandBehavior(CommandBehavi
             return InvalidEnumerationValue(typeof(CommandBehavior), (int)value);
         }
 
-
-        #if _UNIX
-        internal static object LocalMachineRegistryValue(string subkey, string queryvalue)
-        {
-            // No registry in non-Windows environments
-            return null;
-        }
-        #endif
-        #if _WINDOWS
         internal static object LocalMachineRegistryValue(string subkey, string queryvalue)
         {
+            #if NET
+            if (!IsWindows)
+            {
+                // No registry in non-Windows environments
+                return null;
+            }
+            #endif
+
             #if NETFRAMEWORK
             new RegistryPermission(RegistryPermissionAccess.Read, $@"HKEY_LOCAL_MACHINE\{subkey}").Assert();
             #endif
@@ -471,7 +483,6 @@ internal static object LocalMachineRegistryValue(string subkey, string queryvalu
             }
             #endif
         }
-        #endif
 
         internal static void ValidateCommandBehavior(CommandBehavior value)
         {
diff --git a/src/Microsoft.Data.SqlClient/src/Microsoft/Data/Common/AdapterUtil.netfx.cs b/src/Microsoft.Data.SqlClient/src/Microsoft/Data/Common/AdapterUtil.netfx.cs
@@ -33,10 +33,6 @@ internal static partial class ADP
         /// </summary>
         internal const int MinimumTimeoutForTnirMs = 500;
 
-        // @TODO: Use naming rules
-        // @TODO: All values but Unix and Windows32NT are used today, for netfx this should always be Win32NT. We can likely hard code this to true for netfx.
-        internal static readonly bool s_isWindowsNT = Environment.OSVersion.Platform == PlatformID.Win32NT;
-
         #endregion
 
         #region Utility Methods
diff --git a/src/Microsoft.Data.SqlClient/src/Microsoft/Data/SqlClient/ConnectionPool/DbConnectionPoolGroup.cs b/src/Microsoft.Data.SqlClient/src/Microsoft/Data/SqlClient/ConnectionPool/DbConnectionPoolGroup.cs
@@ -53,9 +53,6 @@ sealed internal class DbConnectionPoolGroup
         internal DbConnectionPoolGroup(DbConnectionOptions connectionOptions, DbConnectionPoolKey key, DbConnectionPoolGroupOptions poolGroupOptions)
         {
             Debug.Assert(connectionOptions != null, "null connection options");
-#if NETFRAMEWORK
-            Debug.Assert(poolGroupOptions == null || ADP.s_isWindowsNT, "should not have pooling options on Win9x");
-#endif
 
             _connectionOptions = connectionOptions;
             _poolKey = key;
@@ -143,10 +140,6 @@ internal IDbConnectionPool GetConnectionPool(SqlConnectionFactory connectionFact
             IDbConnectionPool pool = null;
             if (_poolGroupOptions != null)
             {
-#if NETFRAMEWORK
-                Debug.Assert(ADP.s_isWindowsNT, "should not be pooling on Win9x");
-#endif
-
                 DbConnectionPoolIdentity currentIdentity = DbConnectionPoolIdentity.NoIdentity;
 
                 if (_poolGroupOptions.PoolByIdentity)
diff --git a/src/Microsoft.Data.SqlClient/src/Microsoft/Data/SqlClient/SqlColumnEncryptionCngProvider.cs b/src/Microsoft.Data.SqlClient/src/Microsoft/Data/SqlClient/SqlColumnEncryptionCngProvider.cs
diff --git a/src/Microsoft.Data.SqlClient/src/Microsoft/Data/SqlClient/SqlColumnEncryptionCngProvider.netcore.unix.cs b/src/Microsoft.Data.SqlClient/src/Microsoft/Data/SqlClient/SqlColumnEncryptionCngProvider.netcore.unix.cs
diff --git a/src/Microsoft.Data.SqlClient/src/Microsoft/Data/SqlClient/SqlColumnEncryptionCspProvider.cs b/src/Microsoft.Data.SqlClient/src/Microsoft/Data/SqlClient/SqlColumnEncryptionCspProvider.cs
diff --git a/src/Microsoft.Data.SqlClient/src/Microsoft/Data/SqlClient/SqlColumnEncryptionCspProvider.netcore.unix.cs b/src/Microsoft.Data.SqlClient/src/Microsoft/Data/SqlClient/SqlColumnEncryptionCspProvider.netcore.unix.cs
diff --git a/src/Microsoft.Data.SqlClient/src/Microsoft/Data/SqlTypes/SqlFileStream.cs b/src/Microsoft.Data.SqlClient/src/Microsoft/Data/SqlTypes/SqlFileStream.cs
diff --git a/src/Microsoft.Data.SqlClient/src/Microsoft/Data/SqlTypes/SqlFileStream.netcore.unix.cs b/src/Microsoft.Data.SqlClient/src/Microsoft/Data/SqlTypes/SqlFileStream.netcore.unix.cs

Original file line number	Diff line number	Diff line change
`@@ -2,8 +2,6 @@`
`2`	`2`	`// The .NET Foundation licenses this file to you under the MIT license.`
`3`	`3`	`// See the LICENSE file in the project root for more information.`
`4`	`4`
`5`		`-#if _WINDOWS`
`6`		`-`
`7`	`5`	`namespace Interop.Windows.Kernel32`
`8`	`6`	`{`
`9`	`7`	`internal class FileTypes`
`@@ -14,5 +12,3 @@ internal class FileTypes`
`14`	`12`	`internal const int FILE_TYPE_PIPE = 0x0003;`
`15`	`13`	`}`
`16`	`14`	`}`
`17`		`-`
`18`		`-#endif`