Sequel to NativeLibrary API (dotnet/coreclr#21148)

Small changes to address furhter feedback:
 - Perform argument validation in the Marshall.cs instead of DllImport helpers
 - Improve doc comments.

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

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 e6a2937..e77cdbc 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
@@ -1770,12 +1770,14 @@ namespace System.Runtime.InteropServices
         /// <param name="libraryName">The name of the native library to be loaded</param>
         /// <returns>The handle for the loaded native library</returns>  
         /// <exception cref="System.ArgumentNullException">If libraryPath is null</exception>
-        /// <exception cref="System.DllNotFoundException ">Thrown if the library can't be found.</exception>
-        /// <exception cref="System.BadImageFormatException">Thrown if the library is not valid.</exception>
+        /// <exception cref="System.DllNotFoundException ">If the library can't be found.</exception>
+        /// <exception cref="System.BadImageFormatException">If the library is not valid.</exception>
         public static IntPtr LoadLibrary(string libraryPath)
         {
-            bool throwOnError = true;
-            return LoadLibraryFromPath(libraryPath, throwOnError);
+            if (libraryPath == null)
+                throw new ArgumentNullException(nameof(libraryPath));
+
+            return LoadLibraryFromPath(libraryPath, throwOnError: true);
         }
 
         /// <summary>
@@ -1787,15 +1789,20 @@ namespace System.Runtime.InteropServices
         /// <exception cref="System.ArgumentNullException">If libraryPath is null</exception>
         public static bool TryLoadLibrary(string libraryPath, out IntPtr handle)
         {
-            bool throwOnError = false;
-            handle = LoadLibraryFromPath(libraryPath, throwOnError);
+            if (libraryPath == null)
+                throw new ArgumentNullException(nameof(libraryPath));
+
+            handle = LoadLibraryFromPath(libraryPath, throwOnError: false);
             return handle != IntPtr.Zero;
         }
 
         /// <summary>
         /// NativeLibrary Loader: High-level API
         /// Given a library name, this function searches specific paths based on the 
-        /// runtime configuration and attributes of the calling module.
+        /// runtime configuration, input parameters, and attributes of the calling assembly.
+        /// If DllImportSearchPath parameter is non-null, the flags in this enumeration are used.
+        /// Otherwise, the flags specified by the DefaultDllImportSearchPaths attribute on the 
+        /// calling assembly (if any) are used. 
         /// This LoadLibrary() method does not invoke the managed call-backs for native library resolution: 
         /// * AssemblyLoadContext.LoadUnmanagedDll()
         /// </summary>
@@ -1803,16 +1810,24 @@ namespace System.Runtime.InteropServices
         /// <param name="dllImportSearchPath">The search path</param>
         /// <param name="assembly">The assembly loading the native library</param>
         /// <returns>The handle for the loaded library</returns>  
-        /// <exception cref="System.ArgumentNullException">If libraryPath is null</exception>
-        /// <exception cref="System.ArgumentNullException">If assembly is null</exception>
-        /// <exception cref="System.DllNotFoundException ">Thrown if the library can't be found.</exception>
-        /// <exception cref="System.BadImageFormatException">Thrown if the library is not valid.</exception>        
+        /// <exception cref="System.ArgumentNullException">If libraryPath or assembly is null</exception>
+        /// <exception cref="System.ArgumentException">If assembly is not a RuntimeAssembly</exception>
+        /// <exception cref="System.DllNotFoundException ">If the library can't be found.</exception>
+        /// <exception cref="System.BadImageFormatException">If the library is not valid.</exception>        
         public static IntPtr LoadLibrary(string libraryName, Assembly assembly, DllImportSearchPath? searchPath)
         {
-            RuntimeAssembly runtimeAssembly = (assembly != null) ? ((RuntimeAssembly)assembly).GetNativeHandle() : null;
-            bool throwOnError = true;
-            uint searchPathFlag =  searchPath.HasValue ? (uint)searchPath.Value : 0;
-            return LoadLibraryByName(libraryName, runtimeAssembly, searchPath.HasValue, searchPathFlag, throwOnError);
+            if (libraryName == null)
+                throw new ArgumentNullException(nameof(libraryName));
+            if (assembly == null)
+                throw new ArgumentNullException(nameof(assembly));
+            if (!(assembly is RuntimeAssembly))
+                throw new ArgumentException(SR.Argument_MustBeRuntimeAssembly);
+            
+            return LoadLibraryByName(libraryName, 
+                                     ((RuntimeAssembly)assembly).GetNativeHandle(), 
+                                     searchPath.HasValue, 
+                                     (uint) searchPath.GetValueOrDefault(), 
+                                     throwOnError: true);
         }
 
         /// <summary>
@@ -1823,14 +1838,22 @@ namespace System.Runtime.InteropServices
         /// <param name="assembly">The assembly loading the native library</param>
         /// <param name="handle">The out-parameter for the loaded native library handle</param>
         /// <returns>True on successful load, false otherwise</returns>  
-        /// <exception cref="System.ArgumentNullException">If libraryPath is null</exception>
-        /// <exception cref="System.ArgumentNullException">If assembly is null and dllImportSearchPath includes AssemblyDirectory</exception>
+        /// <exception cref="System.ArgumentNullException">If libraryPath or assembly is null</exception>
+        /// <exception cref="System.ArgumentException">If assembly is not a RuntimeAssembly</exception>
         public static bool TryLoadLibrary(string libraryName, Assembly assembly, DllImportSearchPath? searchPath, out IntPtr handle)
         {
-            RuntimeAssembly runtimeAssembly = (assembly != null) ? ((RuntimeAssembly)assembly).GetNativeHandle() : null;
-            bool throwOnError = false;
-            uint searchPathFlag =  searchPath.HasValue ? (uint)searchPath.Value : 0;
-            handle = LoadLibraryByName(libraryName, runtimeAssembly, searchPath.HasValue, searchPathFlag, throwOnError);
+            if (libraryName == null)
+                throw new ArgumentNullException(nameof(libraryName));
+            if (assembly == null)
+                throw new ArgumentNullException(nameof(assembly));
+            if (!(assembly is RuntimeAssembly))
+                throw new ArgumentException(SR.Argument_MustBeRuntimeAssembly);
+            
+            handle = LoadLibraryByName(libraryName, 
+                                       ((RuntimeAssembly)assembly).GetNativeHandle(), 
+                                       searchPath.HasValue, 
+                                       (uint) searchPath.GetValueOrDefault(),
+                                       throwOnError: false);
             return handle != IntPtr.Zero;
         }
 
@@ -1854,12 +1877,15 @@ namespace System.Runtime.InteropServices
         /// <param name="name">The name of the exported symbol</param>
         /// <returns>The address of the symbol</returns>  
         /// <exception cref="System.ArgumentNullException">If handle or name is null</exception>
-        /// <exception cref="System.ArgumentException">If name cannot be converted to UTF8</exception>
         /// <exception cref="System.EntryPointNotFoundException">If the symbol is not found</exception>
         public static IntPtr GetLibraryExport(IntPtr handle, string name)
         {
-            bool throwOnError = true;
-            return GetNativeLibraryExport(handle, name, throwOnError);
+            if (handle == IntPtr.Zero) 
+                throw new ArgumentNullException(nameof(handle));
+            if (name == null)
+                throw new ArgumentNullException(nameof(name));
+
+            return GetNativeLibraryExport(handle, name, throwOnError: true);
         }
 
         /// <summary>
@@ -1869,10 +1895,15 @@ namespace System.Runtime.InteropServices
         /// <param name="name">The name of the exported symbol</param>
         /// <param name="address"> The out-parameter for the symbol address, if it exists</param>
         /// <returns>True on success, false otherwise</returns>  
+        /// <exception cref="System.ArgumentNullException">If handle or name is null</exception>
         public static bool TryGetLibraryExport(IntPtr handle, string name, out IntPtr address)
         {
-            bool throwOnError = false;
-            address = GetNativeLibraryExport(handle, name, throwOnError);
+            if (handle == IntPtr.Zero) 
+                throw new ArgumentNullException(nameof(handle));
+            if (name == null)
+                throw new ArgumentNullException(nameof(name));
+
+            address = GetNativeLibraryExport(handle, name, throwOnError: false);
             return address != IntPtr.Zero;
         }
 

diff --git a/src/coreclr/src/vm/dllimport.cpp b/src/coreclr/src/vm/dllimport.cpp
index 18f4049..9dda48f 100644 (file)
--- a/src/coreclr/src/vm/dllimport.cpp
+++ b/src/coreclr/src/vm/dllimport.cpp
@@ -6136,10 +6136,12 @@ bool         NDirect::s_fSecureLoadLibrarySupported = false;
 // static
 NATIVE_LIBRARY_HANDLE NDirect::LoadLibraryFromPath(LPCWSTR libraryPath, BOOL throwOnError)
 {
-    STANDARD_VM_CONTRACT;
-
-    if (libraryPath == NULL)
-        COMPlusThrowArgumentNull(W("libraryPath"), W("ArgumentNull_String"));
+    CONTRACTL
+    {
+        STANDARD_VM_CHECK;
+        PRECONDITION(CheckPointer(libraryPath));
+    }
+    CONTRACTL_END;
 
     LoadLibErrorTracker errorTracker;
     const NATIVE_LIBRARY_HANDLE hmod =
@@ -6158,16 +6160,16 @@ NATIVE_LIBRARY_HANDLE NDirect::LoadLibraryByName(LPCWSTR libraryName, Assembly *
                                                  BOOL hasDllImportSearchFlag, DWORD dllImportSearchFlag, 
                                                  BOOL throwOnError)
 {
-    STANDARD_VM_CONTRACT;
+    CONTRACTL
+    {
+        STANDARD_VM_CHECK;
+        PRECONDITION(CheckPointer(libraryName));
+        PRECONDITION(CheckPointer(callingAssembly));
+    }
+    CONTRACTL_END;
 
     LoadLibErrorTracker errorTracker;
 
-    if (libraryName == NULL)
-        COMPlusThrowArgumentNull(W("libraryName"), W("ArgumentNull_String"));
-
-    if (callingAssembly == NULL)
-        COMPlusThrowArgumentNull(W("callingAssembly"), W("ArgumentNull_Assembly"));
-
     // First checks if a default DllImportSearchPathFlag was passed in, if so, use that value.
     // Otherwise checks if the assembly has the DefaultDllImportSearchPathsAttribute attribute. If so, use that value.
     BOOL searchAssemblyDirectory = TRUE;
@@ -6255,13 +6257,13 @@ void NDirect::FreeNativeLibrary(NATIVE_LIBRARY_HANDLE handle)
 //static 
 INT_PTR NDirect::GetNativeLibraryExport(NATIVE_LIBRARY_HANDLE handle, LPCWSTR symbolName, BOOL throwOnError)
 {
-    STANDARD_VM_CONTRACT;
-
-    if (handle == NULL) 
-        COMPlusThrowArgumentNull(W("handle"), W("Arg_InvalidHandle"));
-
-    if (symbolName == NULL)
-        COMPlusThrowArgumentNull(W("symbolName"), W("ArgumentNull_String"));
+    CONTRACTL
+    {
+        STANDARD_VM_CHECK;
+        PRECONDITION(CheckPointer(handle));
+        PRECONDITION(CheckPointer(symbolName));
+    }
+    CONTRACTL_END;
 
     MAKE_UTF8PTR_FROMWIDE(lpstr, symbolName);
 

diff --git a/src/coreclr/src/vm/marshalnative.cpp b/src/coreclr/src/vm/marshalnative.cpp
index 117b66d..75b6d35 100644 (file)
--- a/src/coreclr/src/vm/marshalnative.cpp
+++ b/src/coreclr/src/vm/marshalnative.cpp
@@ -947,7 +947,7 @@ INT_PTR QCALLTYPE MarshalNative::LoadLibraryByName(LPCWSTR name, QCall::Assembly
     QCALL_CONTRACT;
 
     NATIVE_LIBRARY_HANDLE handle = nullptr;
-    Assembly *pAssembly = (callingAssembly != NULL) ? callingAssembly->GetAssembly() : NULL;
+    Assembly *pAssembly = callingAssembly->GetAssembly();
 
     BEGIN_QCALL;