From 33400d84bfad2124627ad4b8b57d560b3482e3a6 Mon Sep 17 00:00:00 2001 From: Aaron Robinson Date: Tue, 8 Aug 2023 07:38:54 -0700 Subject: [PATCH] Support `DllImportSearchPath.AssemblyDirectory` for NativeAOT applications (#90120) * NativeAOT - Suppress OS dialog for LoadLibrary failures on Windows. * Update NativeAOT to load from application directory when DllImportSearchPath.AssemblyDirectory is defined. --- .../NativeLibrary.NativeAot.Windows.cs | 17 +++++++++++++---- .../InteropServices/NativeLibrary.NativeAot.cs | 7 ++++++- .../Windows/Kernel32/Interop.SetThreadErrorMode.cs | 3 ++- .../DllImportSearchPathsTest.cs | 22 ++++++++++++++++++++++ .../DllImportSearchPathsTest.csproj | 18 +++++++++++++----- .../NativeLibrary/API/NativeLibraryTests.cs | 10 ++++++++++ .../NativeLibrary/API/NativeLibraryTests.csproj | 14 +++++++++++--- src/tests/issues.targets | 3 --- 8 files changed, 77 insertions(+), 17 deletions(-) diff --git a/src/coreclr/nativeaot/System.Private.CoreLib/src/System/Runtime/InteropServices/NativeLibrary.NativeAot.Windows.cs b/src/coreclr/nativeaot/System.Private.CoreLib/src/System/Runtime/InteropServices/NativeLibrary.NativeAot.Windows.cs index 6f5587f..bac99a0 100644 --- a/src/coreclr/nativeaot/System.Private.CoreLib/src/System/Runtime/InteropServices/NativeLibrary.NativeAot.Windows.cs +++ b/src/coreclr/nativeaot/System.Private.CoreLib/src/System/Runtime/InteropServices/NativeLibrary.NativeAot.Windows.cs @@ -13,26 +13,35 @@ namespace System.Runtime.InteropServices { IntPtr hmod; + // Disable the OS dialogs when failing to load. This matches CoreCLR. + uint prev; + bool set = Interop.Kernel32.SetThreadErrorMode(Interop.Kernel32.SEM_FAILCRITICALERRORS | Interop.Kernel32.SEM_NOOPENFILEERRORBOX, out prev); if (((uint)flags & 0xFFFFFF00) != 0) { hmod = Interop.Kernel32.LoadLibraryEx(libraryName, IntPtr.Zero, (int)((uint)flags & 0xFFFFFF00)); if (hmod != IntPtr.Zero) { - return hmod; + goto exit; } - int lastError = Marshal.GetLastWin32Error(); + int lastError = Marshal.GetLastPInvokeError(); if (lastError != Interop.Errors.ERROR_INVALID_PARAMETER) { errorTracker.TrackErrorCode(lastError); - return hmod; + goto exit; } } hmod = Interop.Kernel32.LoadLibraryEx(libraryName, IntPtr.Zero, flags & 0xFF); if (hmod == IntPtr.Zero) { - errorTracker.TrackErrorCode(Marshal.GetLastWin32Error()); + errorTracker.TrackErrorCode(Marshal.GetLastPInvokeError()); + } + + exit: + if (set) + { + Interop.Kernel32.SetThreadErrorMode(prev, out _); } return hmod; diff --git a/src/coreclr/nativeaot/System.Private.CoreLib/src/System/Runtime/InteropServices/NativeLibrary.NativeAot.cs b/src/coreclr/nativeaot/System.Private.CoreLib/src/System/Runtime/InteropServices/NativeLibrary.NativeAot.cs index d79088a..3abe04a 100644 --- a/src/coreclr/nativeaot/System.Private.CoreLib/src/System/Runtime/InteropServices/NativeLibrary.NativeAot.cs +++ b/src/coreclr/nativeaot/System.Private.CoreLib/src/System/Runtime/InteropServices/NativeLibrary.NativeAot.cs @@ -97,7 +97,12 @@ namespace System.Runtime.InteropServices else if ((callingAssembly != null) && searchAssemblyDirectory) { // Try to load the module alongside the assembly where the PInvoke was declared. - // This only makes sense in dynamic scenarios (JIT/interpreter), so leaving this out for now. + // For PInvokes where the DllImportSearchPath.AssemblyDirectory is specified, look next to the application. + ret = LoadLibraryHelper(Path.Combine(AppContext.BaseDirectory, currLibNameVariation), loadWithAlteredPathFlags | dllImportSearchPathFlags, ref errorTracker); + if (ret != IntPtr.Zero) + { + return ret; + } } ret = LoadLibraryHelper(currLibNameVariation, dllImportSearchPathFlags, ref errorTracker); diff --git a/src/libraries/Common/src/Interop/Windows/Kernel32/Interop.SetThreadErrorMode.cs b/src/libraries/Common/src/Interop/Windows/Kernel32/Interop.SetThreadErrorMode.cs index 340b751..c27e924 100644 --- a/src/libraries/Common/src/Interop/Windows/Kernel32/Interop.SetThreadErrorMode.cs +++ b/src/libraries/Common/src/Interop/Windows/Kernel32/Interop.SetThreadErrorMode.cs @@ -14,6 +14,7 @@ internal static partial class Interop uint dwNewMode, out uint lpOldMode); - internal const uint SEM_FAILCRITICALERRORS = 1; + internal const int SEM_FAILCRITICALERRORS = 0x00000001; + internal const int SEM_NOOPENFILEERRORBOX = 0x00008000; } } diff --git a/src/tests/Interop/DllImportSearchPaths/DllImportSearchPathsTest.cs b/src/tests/Interop/DllImportSearchPaths/DllImportSearchPathsTest.cs index d3837ad..644bb79 100644 --- a/src/tests/Interop/DllImportSearchPaths/DllImportSearchPathsTest.cs +++ b/src/tests/Interop/DllImportSearchPaths/DllImportSearchPathsTest.cs @@ -39,6 +39,13 @@ public class DllImportSearchPathsTest Assert.Equal(3, sum); } + [ConditionalFact(typeof(TestLibrary.Utilities), nameof(TestLibrary.Utilities.IsNativeAot))] + public static void AssemblyDirectoryAot_Found() + { + int sum = NativeLibraryPInvokeAot.Sum(1, 2); + Assert.Equal(3, sum); + } + [Fact] [PlatformSpecific(TestPlatforms.Windows)] public static void AssemblyDirectory_Fallback_Found() @@ -70,3 +77,18 @@ public class NativeLibraryPInvoke [DefaultDllImportSearchPaths(DllImportSearchPath.AssemblyDirectory)] static extern int NativeSum(int arg1, int arg2); } + +public class NativeLibraryPInvokeAot +{ + public static int Sum(int a, int b) + { + return NativeSum(a, b); + } + + // For NativeAOT, validate the case where the native library is next to the AOT application. + // The passing of DllImportSearchPath.System32 is done to ensure on Windows the runtime won't fallback + // and try to search the application directory by default. + [DllImport(NativeLibraryToLoad.Name + "-in-native")] + [DefaultDllImportSearchPaths(DllImportSearchPath.AssemblyDirectory | DllImportSearchPath.System32)] + static extern int NativeSum(int arg1, int arg2); +} diff --git a/src/tests/Interop/DllImportSearchPaths/DllImportSearchPathsTest.csproj b/src/tests/Interop/DllImportSearchPaths/DllImportSearchPathsTest.csproj index e4ca9dc..02284d1a 100644 --- a/src/tests/Interop/DllImportSearchPaths/DllImportSearchPathsTest.csproj +++ b/src/tests/Interop/DllImportSearchPaths/DllImportSearchPathsTest.csproj @@ -14,16 +14,24 @@ - <_FilesToMove Include="$(OutDir)/libNativeLibrary.*" /> - <_FilesToMove Include="$(OutDir)/NativeLibrary.*" /> + + - + - <_FilesToCopy Include="$(OutDir)/$(TargetName).dll" /> + - + + + + + + + + + diff --git a/src/tests/Interop/NativeLibrary/API/NativeLibraryTests.cs b/src/tests/Interop/NativeLibrary/API/NativeLibraryTests.cs index 1d29a82..556c006 100644 --- a/src/tests/Interop/NativeLibrary/API/NativeLibraryTests.cs +++ b/src/tests/Interop/NativeLibrary/API/NativeLibraryTests.cs @@ -189,6 +189,16 @@ public class NativeLibraryTests : IDisposable EXPECT(TryLoadLibrary_WithAssembly(libName, assemblyInSubdirectory, DllImportSearchPath.AssemblyDirectory)); } + if (TestLibrary.Utilities.IsNativeAot) + { + // For NativeAOT, validate the case where the native library is next to the AOT application. + // The passing of DllImportSearchPath.System32 is done to ensure on Windows the runtime won't fallback + // and try to search the application directory by default. + string libNameAot = $"{NativeLibraryToLoad.Name}-in-native"; + EXPECT(LoadLibrary_WithAssembly(libNameAot, assembly, DllImportSearchPath.AssemblyDirectory | DllImportSearchPath.System32)); + EXPECT(TryLoadLibrary_WithAssembly(libNameAot, assembly, DllImportSearchPath.AssemblyDirectory | DllImportSearchPath.System32)); + } + if (OperatingSystem.IsWindows()) { string currentDirectory = Environment.CurrentDirectory; diff --git a/src/tests/Interop/NativeLibrary/API/NativeLibraryTests.csproj b/src/tests/Interop/NativeLibrary/API/NativeLibraryTests.csproj index 16e89df..fdc11a4 100644 --- a/src/tests/Interop/NativeLibrary/API/NativeLibraryTests.csproj +++ b/src/tests/Interop/NativeLibrary/API/NativeLibraryTests.csproj @@ -24,10 +24,10 @@ - - + + - + @@ -36,4 +36,12 @@ + + + + + + + + diff --git a/src/tests/issues.targets b/src/tests/issues.targets index 3dd51b5..a7a23cd 100644 --- a/src/tests/issues.targets +++ b/src/tests/issues.targets @@ -778,9 +778,6 @@ https://github.com/dotnet/runtimelab/issues/164 - - https://github.com/dotnet/runtimelab/issues/165 - https://github.com/dotnet/runtimelab/issues/165 -- 2.7.4