Common: Add DynamicLibrary

common/CMakeLists.txt

@@ -15,6 +15,7 @@ target_sources(common PRIVATE
 	SafeArray.inl
 	Console.cpp
 	CrashHandler.cpp
+	DynamicLibrary.cpp
 	EventSource.cpp
 	Exceptions.cpp
 	FastJmp.cpp
@@ -66,6 +67,7 @@ target_sources(common PRIVATE
 	boost_spsc_queue.hpp
 	Console.h
 	CrashHandler.h
+	DynamicLibrary.h
 	Easing.h
 	EnumOps.h
 	EventSource.h

common/DynamicLibrary.cpp

@@ -0,0 +1,143 @@
+/*  PCSX2 - PS2 Emulator for PCs
+ *  Copyright (C) 2002-2022 PCSX2 Dev Team
+ *
+ *  PCSX2 is free software: you can redistribute it and/or modify it under the terms
+ *  of the GNU Lesser General Public License as published by the Free Software Found-
+ *  ation, either version 3 of the License, or (at your option) any later version.
+ *
+ *  PCSX2 is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
+ *  without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
+ *  PURPOSE.  See the GNU General Public License for more details.
+ *
+ *  You should have received a copy of the GNU General Public License along with PCSX2.
+ *  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#include "common/PrecompiledHeader.h"
+
+#include "common/DynamicLibrary.h"
+#include "common/Assertions.h"
+#include "common/Console.h"
+#include "common/StringUtil.h"
+
+#include <cstring>
+#include "fmt/format.h"
+
+#ifdef _WIN32
+#include "common/RedtapeWindows.h"
+#else
+#include <dlfcn.h>
+#endif
+
+using namespace Common;
+
+DynamicLibrary::DynamicLibrary() = default;
+
+DynamicLibrary::DynamicLibrary(const char* filename)
+{
+	Open(filename);
+}
+
+DynamicLibrary::DynamicLibrary(DynamicLibrary&& move)
+	: m_handle(move.m_handle)
+{
+	move.m_handle = nullptr;
+}
+
+DynamicLibrary::~DynamicLibrary()
+{
+	Close();
+}
+
+std::string DynamicLibrary::GetUnprefixedFilename(const char* filename)
+{
+#if defined(_WIN32)
+	return std::string(filename) + ".dll";
+#elif defined(__APPLE__)
+	return std::string(filename) + ".dylib";
+#else
+	return std::string(filename) + ".so";
+#endif
+}
+
+std::string DynamicLibrary::GetVersionedFilename(const char* libname, int major, int minor)
+{
+#if defined(_WIN32)
+	if (major >= 0 && minor >= 0)
+		return fmt::format("{}-{}-{}.dll", libname, major, minor);
+	else if (major >= 0)
+		return fmt::format("{}-{}.dll", libname, major);
+	else
+		return fmt::format("{}.dll", libname);
+#elif defined(__APPLE__)
+	const char* prefix = std::strncmp(libname, "lib", 3) ? "lib" : "";
+	if (major >= 0 && minor >= 0)
+		return fmt::format("{}{}.{}.{}.dylib", prefix, libname, major, minor);
+	else if (major >= 0)
+		return fmt::format("{}{}.{}.dylib", prefix, libname, major);
+	else
+		return fmt::format("{}{}.dylib", prefix, libname);
+#else
+	const char* prefix = std::strncmp(libname, "lib", 3) ? "lib" : "";
+	if (major >= 0 && minor >= 0)
+		return fmt::format("{}{}.so.{}.{}", prefix, libname, major, minor);
+	else if (major >= 0)
+		return fmt::format("{}{}.so.{}", prefix, libname, major);
+	else
+		return fmt::format("{}{}.so", prefix, libname);
+#endif
+}
+
+bool DynamicLibrary::Open(const char* filename)
+{
+#ifdef _WIN32
+	m_handle = reinterpret_cast<void*>(LoadLibraryW(StringUtil::UTF8StringToWideString(filename).c_str()));
+	if (!m_handle)
+	{
+		Console.Error(fmt::format("(DynamicLibrary) Loading {} failed: {}", filename, GetLastError()));
+		return false;
+	}
+
+	return true;
+#else
+	m_handle = dlopen(filename, RTLD_NOW);
+	if (!m_handle)
+	{
+		const char* err = dlerror();
+		Console.Error(fmt::format("(DynamicLibrary) Loading {} failed: {}", filename, err ? err : ""));
+		return false;
+	}
+
+	return true;
+#endif
+}
+
+void DynamicLibrary::Close()
+{
+	if (!IsOpen())
+		return;
+
+#ifdef _WIN32
+	FreeLibrary(reinterpret_cast<HMODULE>(m_handle));
+#else
+	dlclose(m_handle);
+#endif
+	m_handle = nullptr;
+}
+
+void* DynamicLibrary::GetSymbolAddress(const char* name) const
+{
+#ifdef _WIN32
+	return reinterpret_cast<void*>(GetProcAddress(reinterpret_cast<HMODULE>(m_handle), name));
+#else
+	return reinterpret_cast<void*>(dlsym(m_handle, name));
+#endif
+}
+
+DynamicLibrary& DynamicLibrary::operator=(DynamicLibrary&& move)
+{
+	Close();
+	m_handle = move.m_handle;
+	move.m_handle = nullptr;
+	return *this;
+}

common/DynamicLibrary.h

@@ -0,0 +1,86 @@
+/*  PCSX2 - PS2 Emulator for PCs
+ *  Copyright (C) 2002-2022 PCSX2 Dev Team
+ *
+ *  PCSX2 is free software: you can redistribute it and/or modify it under the terms
+ *  of the GNU Lesser General Public License as published by the Free Software Found-
+ *  ation, either version 3 of the License, or (at your option) any later version.
+ *
+ *  PCSX2 is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
+ *  without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
+ *  PURPOSE.  See the GNU General Public License for more details.
+ *
+ *  You should have received a copy of the GNU General Public License along with PCSX2.
+ *  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#pragma once
+#include <string>
+
+namespace Common
+{
+	/**
+	 * Provides a platform-independent interface for loading a dynamic library and retrieving symbols.
+	 * The interface maintains an internal reference count to allow one handle to be shared between
+	 * multiple users.
+	 */
+	class DynamicLibrary final
+	{
+	public:
+		/// Default constructor, does not load a library.
+		DynamicLibrary();
+
+		/// Automatically loads the specified library. Call IsOpen() to check validity before use.
+		DynamicLibrary(const char* filename);
+
+		/// Move constructor, transfers ownership.
+		DynamicLibrary(DynamicLibrary&& move);
+
+		/// Closes the library.
+		~DynamicLibrary();
+
+		/// Returns the specified library name with the platform-specific suffix added.
+		static std::string GetUnprefixedFilename(const char* filename);
+
+		/// Returns the specified library name in platform-specific format.
+		/// Major/minor versions will not be included if set to -1.
+		/// If libname already contains the "lib" prefix, it will not be added again.
+		/// Windows: LIBNAME-MAJOR-MINOR.dll
+		/// Linux: libLIBNAME.so.MAJOR.MINOR
+		/// Mac: libLIBNAME.MAJOR.MINOR.dylib
+		static std::string GetVersionedFilename(const char* libname, int major = -1, int minor = -1);
+
+		/// Returns true if a module is loaded, otherwise false.
+		bool IsOpen() const { return m_handle != nullptr; }
+
+		/// Loads (or replaces) the handle with the specified library file name.
+		/// Returns true if the library was loaded and can be used.
+		bool Open(const char* filename);
+
+		/// Unloads the library, any function pointers from this library are no longer valid.
+		void Close();
+
+		/// Returns the address of the specified symbol (function or variable) as an untyped pointer.
+		/// If the specified symbol does not exist in this library, nullptr is returned.
+		void* GetSymbolAddress(const char* name) const;
+
+		/// Obtains the address of the specified symbol, automatically casting to the correct type.
+		/// Returns true if the symbol was found and assigned, otherwise false.
+		template <typename T>
+		bool GetSymbol(const char* name, T* ptr) const
+		{
+			*ptr = reinterpret_cast<T>(GetSymbolAddress(name));
+			return *ptr != nullptr;
+		}
+
+		/// Move assignment, transfer ownership.
+		DynamicLibrary& operator=(DynamicLibrary&& move);
+
+	private:
+		DynamicLibrary(const DynamicLibrary&) = delete;
+		DynamicLibrary& operator=(const DynamicLibrary&) = delete;
+
+		/// Platform-dependent data type representing a dynamic library handle.
+		void* m_handle = nullptr;
+	};
+
+} // namespace Common

common/common.vcxproj

@@ -62,6 +62,7 @@
     <ClCompile Include="D3D12\StreamBuffer.cpp" />
     <ClCompile Include="D3D12\Texture.cpp" />
     <ClCompile Include="D3D12\Util.cpp" />
+    <ClCompile Include="DynamicLibrary.cpp" />
     <ClCompile Include="Exceptions.cpp" />
     <ClCompile Include="FastJmp.cpp">
       <ExcludedFromBuild>true</ExcludedFromBuild>
@@ -143,6 +144,7 @@
     <ClInclude Include="D3D12\StreamBuffer.h" />
     <ClInclude Include="D3D12\Texture.h" />
     <ClInclude Include="D3D12\Util.h" />
+    <ClInclude Include="DynamicLibrary.h" />
     <ClInclude Include="Easing.h" />
     <ClInclude Include="boost_spsc_queue.hpp" />
     <ClInclude Include="FastJmp.h" />

common/common.vcxproj.filters

@@ -205,6 +205,9 @@
     <ClCompile Include="MemorySettingsInterface.cpp">
       <Filter>Source Files</Filter>
     </ClCompile>
+    <ClCompile Include="DynamicLibrary.cpp">
+      <Filter>Source Files</Filter>
+    </ClCompile>
   </ItemGroup>
   <ItemGroup>
     <ClInclude Include="AlignedMalloc.h">
@@ -486,6 +489,9 @@
     <ClInclude Include="HeapArray.h">
       <Filter>Header Files</Filter>
     </ClInclude>
+    <ClInclude Include="DynamicLibrary.h">
+      <Filter>Header Files</Filter>
+    </ClInclude>
   </ItemGroup>
   <ItemGroup>
     <Filter Include="Source Files">