|
12 | 12 |
|
13 | 13 | namespace System.Runtime.InteropServices |
14 | 14 | { |
| 15 | + |
| 16 | + /// <summary> |
| 17 | + /// A delegate used to resolve native libraries via callback. |
| 18 | + /// </summary> |
| 19 | + /// <param name="libraryName">The native library to resolve</param> |
| 20 | + /// <param name="assembly">The assembly requesting the resolution</param> |
| 21 | + /// <param name="DllImportSearchPath?"> |
| 22 | + /// The DllImportSearchPathsAttribute on the PInvoke, if any. |
| 23 | + /// Otherwise, the DllImportSearchPathsAttribute on the assembly, if any. |
| 24 | + /// Otherwise null. |
| 25 | + /// </param> |
| 26 | + /// <returns>The handle for the loaded native library on success, null on failure</returns> |
| 27 | + public delegate IntPtr DllImportResolver(string libraryName, |
| 28 | + Assembly assembly, |
| 29 | + DllImportSearchPath? searchPath); |
| 30 | + |
15 | 31 | /// <summary> |
16 | 32 | /// APIs for managing Native Libraries |
17 | 33 | /// </summary> |
@@ -58,7 +74,9 @@ public static bool TryLoad(string libraryPath, out IntPtr handle) |
58 | 74 | /// Otherwise, the flags specified by the DefaultDllImportSearchPaths attribute on the |
59 | 75 | /// calling assembly (if any) are used. |
60 | 76 | /// This LoadLibrary() method does not invoke the managed call-backs for native library resolution: |
| 77 | + /// * The per-assembly registered callback |
61 | 78 | /// * AssemblyLoadContext.LoadUnmanagedDll() |
| 79 | + /// * AssemblyLoadContext.ResolvingUnmanagedDllEvent |
62 | 80 | /// </summary> |
63 | 81 | /// <param name="libraryName">The name of the native library to be loaded</param> |
64 | 82 | /// <param name="assembly">The assembly loading the native library</param> |
@@ -117,7 +135,6 @@ public static bool TryLoad(string libraryName, Assembly assembly, DllImportSearc |
117 | 135 | /// No action if the input handle is null. |
118 | 136 | /// </summary> |
119 | 137 | /// <param name="handle">The native library handle to be freed</param> |
120 | | - /// <exception cref="System.InvalidOperationException">If the operation fails</exception> |
121 | 138 | public static void Free(IntPtr handle) |
122 | 139 | { |
123 | 140 | FreeLib(handle); |
@@ -161,6 +178,67 @@ public static bool TryGetExport(IntPtr handle, string name, out IntPtr address) |
161 | 178 | return address != IntPtr.Zero; |
162 | 179 | } |
163 | 180 |
|
| 181 | + /// <summary> |
| 182 | + /// Map from assembly to native-library-resolution-callback. |
| 183 | + /// Generally interop specific fields and properties are not added to assembly. |
| 184 | + /// Therefore, this table uses weak assembly pointers to indirectly achieve |
| 185 | + /// similar behavior. |
| 186 | + /// </summary> |
| 187 | + public static ConditionalWeakTable<Assembly, DllImportResolver> s_nativeDllResolveMap = null; |
| 188 | + |
| 189 | + /// <summary> |
| 190 | + /// Set a callback for resolving native library imports from an assembly. |
| 191 | + /// This per-assembly callback is the first attempt to resolve native library loads |
| 192 | + /// initiated by this assembly. |
| 193 | + /// |
| 194 | + /// Only one resolver callback can be registered per assembly. |
| 195 | + /// Trying to register a second callback fails with InvalidOperationException. |
| 196 | + /// </summary> |
| 197 | + /// <param name="assembly">The assembly for which the callback is registered</param> |
| 198 | + /// <param name="resolver">The callback to register</param> |
| 199 | + /// <exception cref="System.ArgumentNullException">If assembly or resolver is null</exception> |
| 200 | + /// <exception cref="System.ArgumentException">If a callback is already set for this assembly</exception> |
| 201 | + public static void SetDllImportResolver(Assembly assembly, DllImportResolver resolver) |
| 202 | + { |
| 203 | + if (assembly == null) |
| 204 | + throw new ArgumentNullException(nameof(assembly)); |
| 205 | + if (resolver == null) |
| 206 | + throw new ArgumentNullException(nameof(resolver)); |
| 207 | + if (!(assembly is RuntimeAssembly)) |
| 208 | + throw new ArgumentException(SR.Argument_MustBeRuntimeAssembly); |
| 209 | + |
| 210 | + if (s_nativeDllResolveMap == null) |
| 211 | + { |
| 212 | + s_nativeDllResolveMap = new ConditionalWeakTable<Assembly, DllImportResolver>(); |
| 213 | + } |
| 214 | + |
| 215 | + // ConditionalWealTable throws ArgumentException if the Key already exists |
| 216 | + s_nativeDllResolveMap.Add(assembly, resolver); |
| 217 | + } |
| 218 | + |
| 219 | + /// <summary> |
| 220 | + /// The helper function that calls the per-assembly native-library resolver |
| 221 | + /// if one is registered for this assembly. |
| 222 | + /// </summary> |
| 223 | + /// <param name="libraryName">The native library to load</param> |
| 224 | + /// <param name="assembly">The assembly trying load the native library</param> |
| 225 | + /// <param name="hasDllImportSearchPathFlags">If the pInvoke has DefaultDllImportSearchPathAttribute</param> |
| 226 | + /// <param name="dllImportSearchPathFlags">If hasdllImportSearchPathFlags is true, the flags in |
| 227 | + /// DefaultDllImportSearchPathAttribute; meaningless otherwise </param> |
| 228 | + /// <returns>The handle for the loaded library on success. Null on failure.</returns> |
| 229 | + internal static IntPtr LoadLibraryCallbackStub(string libraryName, Assembly assembly, |
| 230 | + bool hasDllImportSearchPathFlags, uint dllImportSearchPathFlags) |
| 231 | + { |
| 232 | + DllImportResolver resolver; |
| 233 | + |
| 234 | + if (!s_nativeDllResolveMap.TryGetValue(assembly, out resolver)) |
| 235 | + { |
| 236 | + return IntPtr.Zero; |
| 237 | + } |
| 238 | + |
| 239 | + return resolver(libraryName, assembly, hasDllImportSearchPathFlags ? (DllImportSearchPath?)dllImportSearchPathFlags : null); |
| 240 | + } |
| 241 | + |
164 | 242 | /// External functions that implement the NativeLibrary interface |
165 | 243 |
|
166 | 244 | [DllImport(JitHelpers.QCall, CharSet = CharSet.Unicode)] |
|
0 commit comments