diff --git a/common/CMakeLists.txt b/common/CMakeLists.txt index 06c7258470..31f350f638 100644 --- a/common/CMakeLists.txt +++ b/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 diff --git a/common/DynamicLibrary.cpp b/common/DynamicLibrary.cpp new file mode 100644 index 0000000000..c69063f442 --- /dev/null +++ b/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 . + */ + +#include "common/PrecompiledHeader.h" + +#include "common/DynamicLibrary.h" +#include "common/Assertions.h" +#include "common/Console.h" +#include "common/StringUtil.h" + +#include +#include "fmt/format.h" + +#ifdef _WIN32 +#include "common/RedtapeWindows.h" +#else +#include +#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(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(m_handle)); +#else + dlclose(m_handle); +#endif + m_handle = nullptr; +} + +void* DynamicLibrary::GetSymbolAddress(const char* name) const +{ +#ifdef _WIN32 + return reinterpret_cast(GetProcAddress(reinterpret_cast(m_handle), name)); +#else + return reinterpret_cast(dlsym(m_handle, name)); +#endif +} + +DynamicLibrary& DynamicLibrary::operator=(DynamicLibrary&& move) +{ + Close(); + m_handle = move.m_handle; + move.m_handle = nullptr; + return *this; +} diff --git a/common/DynamicLibrary.h b/common/DynamicLibrary.h new file mode 100644 index 0000000000..50cf74420c --- /dev/null +++ b/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 . + */ + +#pragma once +#include + +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 + bool GetSymbol(const char* name, T* ptr) const + { + *ptr = reinterpret_cast(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 \ No newline at end of file diff --git a/common/common.vcxproj b/common/common.vcxproj index 3c2f29a9d0..a2f90bcea3 100644 --- a/common/common.vcxproj +++ b/common/common.vcxproj @@ -62,6 +62,7 @@ + true @@ -143,6 +144,7 @@ + diff --git a/common/common.vcxproj.filters b/common/common.vcxproj.filters index bcbe2f0f70..d71e5af636 100644 --- a/common/common.vcxproj.filters +++ b/common/common.vcxproj.filters @@ -205,6 +205,9 @@ Source Files + + Source Files + @@ -486,6 +489,9 @@ Header Files + + Header Files +