Browse Source

Providers: share NativeProviderLoader between provider implementations

pull/506/merge
Christoph Ruegg 5 years ago
parent
commit
041a7de17f
  1. 1
      src/Providers.CUDA/CudaProvider.cs
  2. 302
      src/Providers.CUDA/NativeProviderLoader.cs
  3. 5
      src/Providers.CUDA/Providers.CUDA.csproj
  4. 1
      src/Providers.MKL/MklProvider.cs
  5. 2
      src/Providers.MKL/NativeProviderLoader.cs
  6. 302
      src/Providers.OpenBLAS/NativeProviderLoader.cs
  7. 1
      src/Providers.OpenBLAS/OpenBlasProvider.cs
  8. 5
      src/Providers.OpenBLAS/Providers.OpenBLAS.csproj

1
src/Providers.CUDA/CudaProvider.cs

@ -29,6 +29,7 @@
using System;
using System.Collections.Generic;
using MathNet.Numerics.Providers.Common;
namespace MathNet.Numerics.Providers.CUDA
{

302
src/Providers.CUDA/NativeProviderLoader.cs

@ -1,302 +0,0 @@
// <copyright file="NativeProviderLoader.cs" company="Math.NET">
// Math.NET Numerics, part of the Math.NET Project
// http://numerics.mathdotnet.com
// http://github.com/mathnet/mathnet-numerics
//
// Copyright (c) 2009-2021 Math.NET
//
// Permission is hereby granted, free of charge, to any person
// obtaining a copy of this software and associated documentation
// files (the "Software"), to deal in the Software without
// restriction, including without limitation the rights to use,
// copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the
// Software is furnished to do so, subject to the following
// conditions:
//
// The above copyright notice and this permission notice shall be
// included in all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
// OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
// WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
// OTHER DEALINGS IN THE SOFTWARE.
// </copyright>
using System;
using System.Collections.Generic;
using System.IO;
using System.Reflection;
using System.Runtime.InteropServices;
using System.Security;
using System.Threading;
namespace MathNet.Numerics.Providers.CUDA
{
internal enum Runtime
{
Unknown = 0,
WindowsX64,
WindowsX86,
WindowsArm64,
WindowsArm,
LinuxX64,
LinuxX86,
}
/// <summary>
/// Helper class to load native libraries depending on the architecture of the OS and process.
/// </summary>
internal static class NativeProviderLoader
{
static readonly object StaticLock = new Object();
/// <summary>
/// Dictionary of handles to previously loaded libraries,
/// </summary>
static readonly Lazy<Dictionary<string, IntPtr>> NativeHandles = new Lazy<Dictionary<string, IntPtr>>(LazyThreadSafetyMode.PublicationOnly);
/// <summary>
/// Gets a string indicating the architecture and bitness of the current process.
/// </summary>
static readonly Lazy<Runtime> RuntimeKey = new Lazy<Runtime>(EvaluateRuntime, LazyThreadSafetyMode.PublicationOnly);
/// <summary>
/// If the last native library failed to load then gets the corresponding exception
/// which occurred or null if the library was successfully loaded.
/// </summary>
internal static Exception LastException { get; private set; }
static bool IsUnix
{
get
{
var p = Environment.OSVersion.Platform;
return p == PlatformID.Unix || p == PlatformID.MacOSX;
}
}
static Runtime EvaluateRuntime()
{
//return (IntPtr.Size == 8) ? X64 : X86;
if (IsUnix)
{
// Only support x86 and amd64 on Unix as there isn't a reliable way to detect the architecture
return Environment.Is64BitProcess ? Runtime.LinuxX64 : Runtime.LinuxX86;
}
var architecture = Environment.GetEnvironmentVariable("PROCESSOR_ARCHITECTURE");
if (string.Equals(architecture, "x86", StringComparison.OrdinalIgnoreCase))
{
return Runtime.WindowsX86;
}
if (string.Equals(architecture, "amd64", StringComparison.OrdinalIgnoreCase)
|| string.Equals(architecture, "x64", StringComparison.OrdinalIgnoreCase))
{
return Environment.Is64BitProcess ? Runtime.WindowsX64 : Runtime.WindowsX86;
}
if (string.Equals(architecture, "arm", StringComparison.OrdinalIgnoreCase))
{
return Environment.Is64BitProcess ? Runtime.WindowsArm64 : Runtime.WindowsArm;
}
// Fallback if unknown
return Runtime.Unknown;
}
/// <summary>
/// Load the native library with the given filename.
/// </summary>
/// <param name="fileName">The file name of the library to load.</param>
/// <param name="hintPath">Hint path where to look for the native binaries. Can be null.</param>
/// <returns>True if the library was successfully loaded or if it has already been loaded.</returns>
internal static bool TryLoad(string fileName, string hintPath)
{
if (string.IsNullOrEmpty(fileName))
{
throw new ArgumentNullException(nameof(fileName));
}
// If we have hint path provided by the user, look there first
if (TryLoadFromDirectory(fileName, hintPath))
{
return true;
}
// If we have an overall hint path provided by the user, look there next
if (Control.NativeProviderPath != hintPath && TryLoadFromDirectory(fileName, Control.NativeProviderPath))
{
return true;
}
// Look under the current AppDomain's base directory
if (TryLoadFromDirectory(fileName, AppDomain.CurrentDomain.BaseDirectory))
{
return true;
}
// Look at this assembly's directory
if (TryLoadFromDirectory(fileName, Path.GetDirectoryName(Assembly.GetExecutingAssembly().Location)))
{
return true;
}
return false;
}
/// <summary>
/// Try to load a native library by providing its name and a directory.
/// Tries to load an implementation suitable for the current CPU architecture
/// and process mode if there is a matching subfolder.
/// </summary>
/// <returns>True if the library was successfully loaded or if it has already been loaded.</returns>
static bool TryLoadFromDirectory(string fileName, string directory)
{
if (!Directory.Exists(directory))
{
return false;
}
directory = Path.GetFullPath(directory);
// If we have a know architecture, try the matching subdirectory first
switch (RuntimeKey.Value)
{
case Runtime.WindowsX64:
if (TryLoadFile(directory, "x64", fileName)
|| TryLoadFile(directory, "runtimes/win-x64/native", fileName)
|| TryLoadFile(directory, "win-x64/native", fileName)
|| TryLoadFile(directory, "win-x64", fileName))
{
return true;
}
break;
case Runtime.WindowsX86:
if (TryLoadFile(directory, "x86", fileName)
|| TryLoadFile(directory, "runtimes/win-x86/native", fileName)
|| TryLoadFile(directory, "win-x86/native", fileName)
|| TryLoadFile(directory, "win-x86", fileName))
{
return true;
}
break;
case Runtime.WindowsArm64:
if (TryLoadFile(directory, "arm64", fileName)
|| TryLoadFile(directory, "runtimes/win-arm64/native", fileName)
|| TryLoadFile(directory, "win-arm64/native", fileName)
|| TryLoadFile(directory, "win-arm64", fileName))
{
return true;
}
break;
case Runtime.WindowsArm:
if (TryLoadFile(directory, "arm", fileName)
|| TryLoadFile(directory, "runtimes/win-arm/native", fileName)
|| TryLoadFile(directory, "win-arm/native", fileName)
|| TryLoadFile(directory, "win-arm", fileName))
{
return true;
}
break;
case Runtime.LinuxX64:
if (TryLoadFile(directory, "x64", fileName)
|| TryLoadFile(directory, "runtimes/linux-x64/native", fileName)
|| TryLoadFile(directory, "linux-x64/native", fileName)
|| TryLoadFile(directory, "linux-x64", fileName))
{
return true;
}
break;
case Runtime.LinuxX86:
if (TryLoadFile(directory, "x86", fileName)
|| TryLoadFile(directory, "runtimes/linux-x86/native", fileName)
|| TryLoadFile(directory, "linux-x86/native", fileName)
|| TryLoadFile(directory, "linux-x86", fileName))
{
return true;
}
break;
}
// Otherwise try to load directly from the provided directory
return TryLoadFile(directory, string.Empty, fileName);
}
/// <summary>
/// Try to load a native library by providing the full path including the file name of the library.
/// </summary>
/// <returns>True if the library was successfully loaded or if it has already been loaded.</returns>
static bool TryLoadFile(string directory, string relativePath, string fileName)
{
lock (StaticLock)
{
if (NativeHandles.Value.TryGetValue(fileName, out IntPtr libraryHandle))
{
return true;
}
var fullPath = Path.GetFullPath(Path.Combine(Path.Combine(directory, relativePath), fileName));
if (!File.Exists(fullPath))
{
// If the library isn't found within an architecture specific folder then return false
// to allow normal P/Invoke searching behavior when the library is called
return false;
}
// If successful this will return a handle to the library
libraryHandle = IsUnix ? UnixLoader.LoadLibrary(fullPath) : WindowsLoader.LoadLibrary(fullPath);
if (libraryHandle == IntPtr.Zero)
{
int lastError = Marshal.GetLastWin32Error();
var exception = new System.ComponentModel.Win32Exception(lastError);
LastException = exception;
}
else
{
LastException = null;
NativeHandles.Value[fileName] = libraryHandle;
}
return libraryHandle != IntPtr.Zero;
}
}
[SuppressUnmanagedCodeSecurity]
[SecurityCritical]
static class WindowsLoader
{
public static IntPtr LoadLibrary(string fileName)
{
return LoadLibraryEx(fileName, IntPtr.Zero, LOAD_WITH_ALTERED_SEARCH_PATH);
}
// Search for dependencies in the library's directory rather than the calling process's directory
const uint LOAD_WITH_ALTERED_SEARCH_PATH = 0x00000008;
[DllImport("kernel32", CallingConvention = CallingConvention.Winapi, CharSet = CharSet.Unicode, SetLastError = true)]
static extern IntPtr LoadLibraryEx(string fileName, IntPtr reservedNull, uint flags);
}
[SuppressUnmanagedCodeSecurity]
[SecurityCritical]
static class UnixLoader
{
public static IntPtr LoadLibrary(string fileName)
{
return dlopen(fileName, RTLD_NOW);
}
const int RTLD_NOW = 2;
[DllImport("libdl.so", SetLastError = true)]
static extern IntPtr dlopen(String fileName, int flags);
}
}
}

5
src/Providers.CUDA/Providers.CUDA.csproj

@ -49,4 +49,9 @@ Control.Describe now includes CPU architecture and family identifier if know</Pa
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
</PackageReference>
</ItemGroup>
<ItemGroup>
<Compile Include="..\Providers.MKL\NativeProviderLoader.cs">
<Link>NativeProviderLoader.cs</Link>
</Compile>
</ItemGroup>
</Project>

1
src/Providers.MKL/MklProvider.cs

@ -29,6 +29,7 @@
using System;
using System.Collections.Generic;
using MathNet.Numerics.Providers.Common;
namespace MathNet.Numerics.Providers.MKL
{

2
src/Providers.MKL/NativeProviderLoader.cs

@ -37,7 +37,7 @@ using System.Threading;
// ReSharper disable InconsistentNaming
namespace MathNet.Numerics.Providers.MKL
namespace MathNet.Numerics.Providers.Common
{
internal enum Runtime
{

302
src/Providers.OpenBLAS/NativeProviderLoader.cs

@ -1,302 +0,0 @@
// <copyright file="NativeProviderLoader.cs" company="Math.NET">
// Math.NET Numerics, part of the Math.NET Project
// http://numerics.mathdotnet.com
// http://github.com/mathnet/mathnet-numerics
//
// Copyright (c) 2009-2021 Math.NET
//
// Permission is hereby granted, free of charge, to any person
// obtaining a copy of this software and associated documentation
// files (the "Software"), to deal in the Software without
// restriction, including without limitation the rights to use,
// copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the
// Software is furnished to do so, subject to the following
// conditions:
//
// The above copyright notice and this permission notice shall be
// included in all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
// OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
// WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
// OTHER DEALINGS IN THE SOFTWARE.
// </copyright>
using System;
using System.Collections.Generic;
using System.IO;
using System.Reflection;
using System.Runtime.InteropServices;
using System.Security;
using System.Threading;
namespace MathNet.Numerics.Providers.OpenBLAS
{
internal enum Runtime
{
Unknown = 0,
WindowsX64,
WindowsX86,
WindowsArm64,
WindowsArm,
LinuxX64,
LinuxX86,
}
/// <summary>
/// Helper class to load native libraries depending on the architecture of the OS and process.
/// </summary>
internal static class NativeProviderLoader
{
static readonly object StaticLock = new Object();
/// <summary>
/// Dictionary of handles to previously loaded libraries,
/// </summary>
static readonly Lazy<Dictionary<string, IntPtr>> NativeHandles = new Lazy<Dictionary<string, IntPtr>>(LazyThreadSafetyMode.PublicationOnly);
/// <summary>
/// Gets a string indicating the architecture and bitness of the current process.
/// </summary>
static readonly Lazy<Runtime> RuntimeKey = new Lazy<Runtime>(EvaluateRuntime, LazyThreadSafetyMode.PublicationOnly);
/// <summary>
/// If the last native library failed to load then gets the corresponding exception
/// which occurred or null if the library was successfully loaded.
/// </summary>
internal static Exception LastException { get; private set; }
static bool IsUnix
{
get
{
var p = Environment.OSVersion.Platform;
return p == PlatformID.Unix || p == PlatformID.MacOSX;
}
}
static Runtime EvaluateRuntime()
{
//return (IntPtr.Size == 8) ? X64 : X86;
if (IsUnix)
{
// Only support x86 and amd64 on Unix as there isn't a reliable way to detect the architecture
return Environment.Is64BitProcess ? Runtime.LinuxX64 : Runtime.LinuxX86;
}
var architecture = Environment.GetEnvironmentVariable("PROCESSOR_ARCHITECTURE");
if (string.Equals(architecture, "x86", StringComparison.OrdinalIgnoreCase))
{
return Runtime.WindowsX86;
}
if (string.Equals(architecture, "amd64", StringComparison.OrdinalIgnoreCase)
|| string.Equals(architecture, "x64", StringComparison.OrdinalIgnoreCase))
{
return Environment.Is64BitProcess ? Runtime.WindowsX64 : Runtime.WindowsX86;
}
if (string.Equals(architecture, "arm", StringComparison.OrdinalIgnoreCase))
{
return Environment.Is64BitProcess ? Runtime.WindowsArm64 : Runtime.WindowsArm;
}
// Fallback if unknown
return Runtime.Unknown;
}
/// <summary>
/// Load the native library with the given filename.
/// </summary>
/// <param name="fileName">The file name of the library to load.</param>
/// <param name="hintPath">Hint path where to look for the native binaries. Can be null.</param>
/// <returns>True if the library was successfully loaded or if it has already been loaded.</returns>
internal static bool TryLoad(string fileName, string hintPath)
{
if (string.IsNullOrEmpty(fileName))
{
throw new ArgumentNullException(nameof(fileName));
}
// If we have hint path provided by the user, look there first
if (TryLoadFromDirectory(fileName, hintPath))
{
return true;
}
// If we have an overall hint path provided by the user, look there next
if (Control.NativeProviderPath != hintPath && TryLoadFromDirectory(fileName, Control.NativeProviderPath))
{
return true;
}
// Look under the current AppDomain's base directory
if (TryLoadFromDirectory(fileName, AppDomain.CurrentDomain.BaseDirectory))
{
return true;
}
// Look at this assembly's directory
if (TryLoadFromDirectory(fileName, Path.GetDirectoryName(Assembly.GetExecutingAssembly().Location)))
{
return true;
}
return false;
}
/// <summary>
/// Try to load a native library by providing its name and a directory.
/// Tries to load an implementation suitable for the current CPU architecture
/// and process mode if there is a matching subfolder.
/// </summary>
/// <returns>True if the library was successfully loaded or if it has already been loaded.</returns>
static bool TryLoadFromDirectory(string fileName, string directory)
{
if (!Directory.Exists(directory))
{
return false;
}
directory = Path.GetFullPath(directory);
// If we have a know architecture, try the matching subdirectory first
switch (RuntimeKey.Value)
{
case Runtime.WindowsX64:
if (TryLoadFile(directory, "x64", fileName)
|| TryLoadFile(directory, "runtimes/win-x64/native", fileName)
|| TryLoadFile(directory, "win-x64/native", fileName)
|| TryLoadFile(directory, "win-x64", fileName))
{
return true;
}
break;
case Runtime.WindowsX86:
if (TryLoadFile(directory, "x86", fileName)
|| TryLoadFile(directory, "runtimes/win-x86/native", fileName)
|| TryLoadFile(directory, "win-x86/native", fileName)
|| TryLoadFile(directory, "win-x86", fileName))
{
return true;
}
break;
case Runtime.WindowsArm64:
if (TryLoadFile(directory, "arm64", fileName)
|| TryLoadFile(directory, "runtimes/win-arm64/native", fileName)
|| TryLoadFile(directory, "win-arm64/native", fileName)
|| TryLoadFile(directory, "win-arm64", fileName))
{
return true;
}
break;
case Runtime.WindowsArm:
if (TryLoadFile(directory, "arm", fileName)
|| TryLoadFile(directory, "runtimes/win-arm/native", fileName)
|| TryLoadFile(directory, "win-arm/native", fileName)
|| TryLoadFile(directory, "win-arm", fileName))
{
return true;
}
break;
case Runtime.LinuxX64:
if (TryLoadFile(directory, "x64", fileName)
|| TryLoadFile(directory, "runtimes/linux-x64/native", fileName)
|| TryLoadFile(directory, "linux-x64/native", fileName)
|| TryLoadFile(directory, "linux-x64", fileName))
{
return true;
}
break;
case Runtime.LinuxX86:
if (TryLoadFile(directory, "x86", fileName)
|| TryLoadFile(directory, "runtimes/linux-x86/native", fileName)
|| TryLoadFile(directory, "linux-x86/native", fileName)
|| TryLoadFile(directory, "linux-x86", fileName))
{
return true;
}
break;
}
// Otherwise try to load directly from the provided directory
return TryLoadFile(directory, string.Empty, fileName);
}
/// <summary>
/// Try to load a native library by providing the full path including the file name of the library.
/// </summary>
/// <returns>True if the library was successfully loaded or if it has already been loaded.</returns>
static bool TryLoadFile(string directory, string relativePath, string fileName)
{
lock (StaticLock)
{
if (NativeHandles.Value.TryGetValue(fileName, out IntPtr libraryHandle))
{
return true;
}
var fullPath = Path.GetFullPath(Path.Combine(Path.Combine(directory, relativePath), fileName));
if (!File.Exists(fullPath))
{
// If the library isn't found within an architecture specific folder then return false
// to allow normal P/Invoke searching behavior when the library is called
return false;
}
// If successful this will return a handle to the library
libraryHandle = IsUnix ? UnixLoader.LoadLibrary(fullPath) : WindowsLoader.LoadLibrary(fullPath);
if (libraryHandle == IntPtr.Zero)
{
int lastError = Marshal.GetLastWin32Error();
var exception = new System.ComponentModel.Win32Exception(lastError);
LastException = exception;
}
else
{
LastException = null;
NativeHandles.Value[fileName] = libraryHandle;
}
return libraryHandle != IntPtr.Zero;
}
}
[SuppressUnmanagedCodeSecurity]
[SecurityCritical]
static class WindowsLoader
{
public static IntPtr LoadLibrary(string fileName)
{
return LoadLibraryEx(fileName, IntPtr.Zero, LOAD_WITH_ALTERED_SEARCH_PATH);
}
// Search for dependencies in the library's directory rather than the calling process's directory
const uint LOAD_WITH_ALTERED_SEARCH_PATH = 0x00000008;
[DllImport("kernel32", CallingConvention = CallingConvention.Winapi, CharSet = CharSet.Unicode, SetLastError = true)]
static extern IntPtr LoadLibraryEx(string fileName, IntPtr reservedNull, uint flags);
}
[SuppressUnmanagedCodeSecurity]
[SecurityCritical]
static class UnixLoader
{
public static IntPtr LoadLibrary(string fileName)
{
return dlopen(fileName, RTLD_NOW);
}
const int RTLD_NOW = 2;
[DllImport("libdl.so", SetLastError = true)]
static extern IntPtr dlopen(String fileName, int flags);
}
}
}

1
src/Providers.OpenBLAS/OpenBlasProvider.cs

@ -29,6 +29,7 @@
using System;
using System.Collections.Generic;
using MathNet.Numerics.Providers.Common;
namespace MathNet.Numerics.Providers.OpenBLAS
{

5
src/Providers.OpenBLAS/Providers.OpenBLAS.csproj

@ -49,4 +49,9 @@ Control.Describe now includes CPU architecture and family identifier if know</Pa
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
</PackageReference>
</ItemGroup>
<ItemGroup>
<Compile Include="..\Providers.MKL\NativeProviderLoader.cs">
<Link>NativeProviderLoader.cs</Link>
</Compile>
</ItemGroup>
</Project>

Loading…
Cancel
Save