mirror of
https://github.com/wheremyfoodat/Panda3DS.git
synced 2025-04-07 22:55:40 +12:00
Move away from PCSX2 fastmem
This commit is contained in:
parent
fbddb02ac3
commit
ede3a93cda
10 changed files with 1058 additions and 1023 deletions
|
@ -165,7 +165,7 @@ include_directories(third_party/toml11)
|
||||||
include_directories(third_party/glm)
|
include_directories(third_party/glm)
|
||||||
include_directories(third_party/renderdoc)
|
include_directories(third_party/renderdoc)
|
||||||
include_directories(third_party/duckstation)
|
include_directories(third_party/duckstation)
|
||||||
include_directories(third_party/pcsx2/include)
|
include_directories(third_party/host_memory/include)
|
||||||
|
|
||||||
add_subdirectory(third_party/cmrc)
|
add_subdirectory(third_party/cmrc)
|
||||||
|
|
||||||
|
@ -379,11 +379,11 @@ set(THIRD_PARTY_SOURCE_FILES third_party/imgui/imgui.cpp
|
||||||
|
|
||||||
third_party/cityhash/cityhash.cpp
|
third_party/cityhash/cityhash.cpp
|
||||||
third_party/xxhash/xxhash.c
|
third_party/xxhash/xxhash.c
|
||||||
)
|
|
||||||
|
|
||||||
if(WIN32)
|
third_party/host_memory/host_memory.cpp
|
||||||
set(THIRD_PARTY_SOURCE_FILES ${THIRD_PARTY_SOURCE_FILES} third_party/pcsx2/WinHostSys.cpp)
|
third_party/host_memory/virtual_buffer.cpp
|
||||||
endif()
|
third_party/host_memory/dynamic_library.cpp
|
||||||
|
)
|
||||||
|
|
||||||
if(ENABLE_LUAJIT AND NOT ANDROID)
|
if(ENABLE_LUAJIT AND NOT ANDROID)
|
||||||
# Build luv and libuv for Lua TCP server usage if we're not on Android
|
# Build luv and libuv for Lua TCP server usage if we're not on Android
|
||||||
|
|
97
third_party/host_memory/dynamic_library.cpp
vendored
Normal file
97
third_party/host_memory/dynamic_library.cpp
vendored
Normal file
|
@ -0,0 +1,97 @@
|
||||||
|
// SPDX-FileCopyrightText: 2019 Dolphin Emulator Project
|
||||||
|
// SPDX-License-Identifier: GPL-2.0-or-later
|
||||||
|
|
||||||
|
#include "host_memory/dynamic_library.h"
|
||||||
|
|
||||||
|
#include <fmt/format.h>
|
||||||
|
|
||||||
|
#include <string>
|
||||||
|
#include <utility>
|
||||||
|
|
||||||
|
#ifdef _WIN32
|
||||||
|
#include <windows.h>
|
||||||
|
#else
|
||||||
|
#include <dlfcn.h>
|
||||||
|
#endif
|
||||||
|
|
||||||
|
namespace Common {
|
||||||
|
|
||||||
|
DynamicLibrary::DynamicLibrary() = default;
|
||||||
|
DynamicLibrary::DynamicLibrary(const char* filename) { void(Open(filename)); }
|
||||||
|
DynamicLibrary::DynamicLibrary(void* handle_) : handle{handle_} {}
|
||||||
|
DynamicLibrary::DynamicLibrary(DynamicLibrary&& rhs) noexcept : handle{std::exchange(rhs.handle, nullptr)} {}
|
||||||
|
|
||||||
|
DynamicLibrary& DynamicLibrary::operator=(DynamicLibrary&& rhs) noexcept {
|
||||||
|
Close();
|
||||||
|
handle = std::exchange(rhs.handle, nullptr);
|
||||||
|
return *this;
|
||||||
|
}
|
||||||
|
|
||||||
|
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
|
||||||
|
handle = reinterpret_cast<void*>(LoadLibraryA(filename));
|
||||||
|
#else
|
||||||
|
handle = dlopen(filename, RTLD_NOW);
|
||||||
|
#endif
|
||||||
|
return handle != nullptr;
|
||||||
|
}
|
||||||
|
|
||||||
|
void DynamicLibrary::Close() {
|
||||||
|
if (!IsOpen()) return;
|
||||||
|
|
||||||
|
#ifdef _WIN32
|
||||||
|
FreeLibrary(reinterpret_cast<HMODULE>(handle));
|
||||||
|
#else
|
||||||
|
dlclose(handle);
|
||||||
|
#endif
|
||||||
|
handle = nullptr;
|
||||||
|
}
|
||||||
|
|
||||||
|
void* DynamicLibrary::GetSymbolAddress(const char* name) const {
|
||||||
|
#ifdef _WIN32
|
||||||
|
return reinterpret_cast<void*>(GetProcAddress(reinterpret_cast<HMODULE>(handle), name));
|
||||||
|
#else
|
||||||
|
return reinterpret_cast<void*>(dlsym(handle, name));
|
||||||
|
#endif
|
||||||
|
}
|
||||||
|
|
||||||
|
} // namespace Common
|
691
third_party/host_memory/host_memory.cpp
vendored
Normal file
691
third_party/host_memory/host_memory.cpp
vendored
Normal file
|
@ -0,0 +1,691 @@
|
||||||
|
// SPDX-FileCopyrightText: Copyright 2021 yuzu Emulator Project
|
||||||
|
// SPDX-License-Identifier: GPL-2.0-or-later
|
||||||
|
|
||||||
|
#ifdef _WIN32
|
||||||
|
|
||||||
|
#include <windows.h>
|
||||||
|
|
||||||
|
#include <boost/icl/separate_interval_set.hpp>
|
||||||
|
#include <iterator>
|
||||||
|
#include <unordered_map>
|
||||||
|
|
||||||
|
#include "host_memory/dynamic_library.h"
|
||||||
|
|
||||||
|
|
||||||
|
#elif defined(__linux__) || defined(__FreeBSD__) // ^^^ Windows ^^^ vvv Linux vvv
|
||||||
|
|
||||||
|
#ifndef _GNU_SOURCE
|
||||||
|
#define _GNU_SOURCE
|
||||||
|
#endif
|
||||||
|
#include <fcntl.h>
|
||||||
|
#include <sys/mman.h>
|
||||||
|
#include <sys/random.h>
|
||||||
|
#include <unistd.h>
|
||||||
|
|
||||||
|
#include <boost/icl/interval_set.hpp>
|
||||||
|
|
||||||
|
#include "common/scope_exit.h"
|
||||||
|
|
||||||
|
|
||||||
|
#ifndef MAP_NORESERVE
|
||||||
|
#define MAP_NORESERVE 0
|
||||||
|
#endif
|
||||||
|
|
||||||
|
#endif // ^^^ Linux ^^^
|
||||||
|
|
||||||
|
#include <mutex>
|
||||||
|
#include <random>
|
||||||
|
#include <memory>
|
||||||
|
|
||||||
|
#include "align.hpp"
|
||||||
|
#include <host_memory/host_memory.h>
|
||||||
|
// #include "common/free_region_manager.h"
|
||||||
|
|
||||||
|
namespace Common {
|
||||||
|
|
||||||
|
constexpr size_t PageAlignment = 0x1000;
|
||||||
|
constexpr size_t HugePageSize = 0x200000;
|
||||||
|
|
||||||
|
#ifdef _WIN32
|
||||||
|
|
||||||
|
// Manually imported for MinGW compatibility
|
||||||
|
#ifndef MEM_RESERVE_PLACEHOLDER
|
||||||
|
#define MEM_RESERVE_PLACEHOLDER 0x00040000
|
||||||
|
#endif
|
||||||
|
#ifndef MEM_REPLACE_PLACEHOLDER
|
||||||
|
#define MEM_REPLACE_PLACEHOLDER 0x00004000
|
||||||
|
#endif
|
||||||
|
#ifndef MEM_COALESCE_PLACEHOLDERS
|
||||||
|
#define MEM_COALESCE_PLACEHOLDERS 0x00000001
|
||||||
|
#endif
|
||||||
|
#ifndef MEM_PRESERVE_PLACEHOLDER
|
||||||
|
#define MEM_PRESERVE_PLACEHOLDER 0x00000002
|
||||||
|
#endif
|
||||||
|
|
||||||
|
using PFN_CreateFileMapping2 = _Ret_maybenull_ HANDLE(WINAPI*)(
|
||||||
|
_In_ HANDLE File, _In_opt_ SECURITY_ATTRIBUTES* SecurityAttributes, _In_ ULONG DesiredAccess, _In_ ULONG PageProtection,
|
||||||
|
_In_ ULONG AllocationAttributes, _In_ ULONG64 MaximumSize, _In_opt_ PCWSTR Name,
|
||||||
|
_Inout_updates_opt_(ParameterCount) MEM_EXTENDED_PARAMETER* ExtendedParameters, _In_ ULONG ParameterCount
|
||||||
|
);
|
||||||
|
|
||||||
|
using PFN_VirtualAlloc2 = _Ret_maybenull_ PVOID(WINAPI*)(
|
||||||
|
_In_opt_ HANDLE Process, _In_opt_ PVOID BaseAddress, _In_ SIZE_T Size, _In_ ULONG AllocationType, _In_ ULONG PageProtection,
|
||||||
|
_Inout_updates_opt_(ParameterCount) MEM_EXTENDED_PARAMETER* ExtendedParameters, _In_ ULONG ParameterCount
|
||||||
|
);
|
||||||
|
|
||||||
|
using PFN_MapViewOfFile3 = _Ret_maybenull_ PVOID(WINAPI*)(
|
||||||
|
_In_ HANDLE FileMapping, _In_opt_ HANDLE Process, _In_opt_ PVOID BaseAddress, _In_ ULONG64 Offset, _In_ SIZE_T ViewSize,
|
||||||
|
_In_ ULONG AllocationType, _In_ ULONG PageProtection, _Inout_updates_opt_(ParameterCount) MEM_EXTENDED_PARAMETER* ExtendedParameters,
|
||||||
|
_In_ ULONG ParameterCount
|
||||||
|
);
|
||||||
|
|
||||||
|
using PFN_UnmapViewOfFile2 = BOOL(WINAPI*)(_In_ HANDLE Process, _In_ PVOID BaseAddress, _In_ ULONG UnmapFlags);
|
||||||
|
|
||||||
|
template <typename T>
|
||||||
|
static void GetFuncAddress(Common::DynamicLibrary& dll, const char* name, T& pfn) {
|
||||||
|
if (!dll.GetSymbol(name, &pfn)) {
|
||||||
|
LOG_CRITICAL(HW_Memory, "Failed to load {}", name);
|
||||||
|
throw std::bad_alloc{};
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
class HostMemory::Impl {
|
||||||
|
public:
|
||||||
|
explicit Impl(size_t backing_size_, size_t virtual_size_)
|
||||||
|
: backing_size{backing_size_}, virtual_size{virtual_size_}, process{GetCurrentProcess()}, kernelbase_dll("Kernelbase") {
|
||||||
|
if (!kernelbase_dll.IsOpen()) {
|
||||||
|
LOG_CRITICAL(HW_Memory, "Failed to load Kernelbase.dll");
|
||||||
|
throw std::bad_alloc{};
|
||||||
|
}
|
||||||
|
GetFuncAddress(kernelbase_dll, "CreateFileMapping2", pfn_CreateFileMapping2);
|
||||||
|
GetFuncAddress(kernelbase_dll, "VirtualAlloc2", pfn_VirtualAlloc2);
|
||||||
|
GetFuncAddress(kernelbase_dll, "MapViewOfFile3", pfn_MapViewOfFile3);
|
||||||
|
GetFuncAddress(kernelbase_dll, "UnmapViewOfFile2", pfn_UnmapViewOfFile2);
|
||||||
|
|
||||||
|
// Allocate backing file map
|
||||||
|
backing_handle = pfn_CreateFileMapping2(
|
||||||
|
INVALID_HANDLE_VALUE, nullptr, FILE_MAP_WRITE | FILE_MAP_READ, PAGE_READWRITE, SEC_COMMIT, backing_size, nullptr, nullptr, 0
|
||||||
|
);
|
||||||
|
if (!backing_handle) {
|
||||||
|
LOG_CRITICAL(HW_Memory, "Failed to allocate {} MiB of backing memory", backing_size >> 20);
|
||||||
|
throw std::bad_alloc{};
|
||||||
|
}
|
||||||
|
// Allocate a virtual memory for the backing file map as placeholder
|
||||||
|
backing_base =
|
||||||
|
static_cast<u8*>(pfn_VirtualAlloc2(process, nullptr, backing_size, MEM_RESERVE | MEM_RESERVE_PLACEHOLDER, PAGE_NOACCESS, nullptr, 0));
|
||||||
|
if (!backing_base) {
|
||||||
|
Release();
|
||||||
|
LOG_CRITICAL(HW_Memory, "Failed to reserve {} MiB of virtual memory", backing_size >> 20);
|
||||||
|
throw std::bad_alloc{};
|
||||||
|
}
|
||||||
|
// Map backing placeholder
|
||||||
|
void* const ret =
|
||||||
|
pfn_MapViewOfFile3(backing_handle, process, backing_base, 0, backing_size, MEM_REPLACE_PLACEHOLDER, PAGE_READWRITE, nullptr, 0);
|
||||||
|
if (ret != backing_base) {
|
||||||
|
Release();
|
||||||
|
LOG_CRITICAL(HW_Memory, "Failed to map {} MiB of virtual memory", backing_size >> 20);
|
||||||
|
throw std::bad_alloc{};
|
||||||
|
}
|
||||||
|
// Allocate virtual address placeholder
|
||||||
|
virtual_base =
|
||||||
|
static_cast<u8*>(pfn_VirtualAlloc2(process, nullptr, virtual_size, MEM_RESERVE | MEM_RESERVE_PLACEHOLDER, PAGE_NOACCESS, nullptr, 0));
|
||||||
|
if (!virtual_base) {
|
||||||
|
Release();
|
||||||
|
LOG_CRITICAL(HW_Memory, "Failed to reserve {} GiB of virtual memory", virtual_size >> 30);
|
||||||
|
throw std::bad_alloc{};
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
~Impl() { Release(); }
|
||||||
|
|
||||||
|
void Map(size_t virtual_offset, size_t host_offset, size_t length, MemoryPermission perms) {
|
||||||
|
std::unique_lock lock{placeholder_mutex};
|
||||||
|
if (!IsNiechePlaceholder(virtual_offset, length)) {
|
||||||
|
Split(virtual_offset, length);
|
||||||
|
}
|
||||||
|
ASSERT(placeholders.find({virtual_offset, virtual_offset + length}) == placeholders.end());
|
||||||
|
TrackPlaceholder(virtual_offset, host_offset, length);
|
||||||
|
|
||||||
|
MapView(virtual_offset, host_offset, length);
|
||||||
|
}
|
||||||
|
|
||||||
|
void Unmap(size_t virtual_offset, size_t length) {
|
||||||
|
std::scoped_lock lock{placeholder_mutex};
|
||||||
|
|
||||||
|
// Unmap until there are no more placeholders
|
||||||
|
while (UnmapOnePlaceholder(virtual_offset, length)) {
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
void Protect(size_t virtual_offset, size_t length, bool read, bool write, bool execute) {
|
||||||
|
DWORD new_flags{};
|
||||||
|
if (read && write) {
|
||||||
|
new_flags = PAGE_READWRITE;
|
||||||
|
} else if (read && !write) {
|
||||||
|
new_flags = PAGE_READONLY;
|
||||||
|
} else if (!read && !write) {
|
||||||
|
new_flags = PAGE_NOACCESS;
|
||||||
|
} else {
|
||||||
|
UNIMPLEMENTED_MSG("Protection flag combination read={} write={}", read, write);
|
||||||
|
}
|
||||||
|
const size_t virtual_end = virtual_offset + length;
|
||||||
|
|
||||||
|
std::scoped_lock lock{placeholder_mutex};
|
||||||
|
auto [it, end] = placeholders.equal_range({virtual_offset, virtual_end});
|
||||||
|
while (it != end) {
|
||||||
|
const size_t offset = std::max(it->lower(), virtual_offset);
|
||||||
|
const size_t protect_length = std::min(it->upper(), virtual_end) - offset;
|
||||||
|
DWORD old_flags{};
|
||||||
|
if (!VirtualProtect(virtual_base + offset, protect_length, new_flags, &old_flags)) {
|
||||||
|
LOG_CRITICAL(HW_Memory, "Failed to change virtual memory protect rules");
|
||||||
|
}
|
||||||
|
++it;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
bool ClearBackingRegion(size_t physical_offset, size_t length) {
|
||||||
|
// TODO: This does not seem to be possible on Windows.
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
void EnableDirectMappedAddress() {
|
||||||
|
// TODO
|
||||||
|
UNREACHABLE();
|
||||||
|
}
|
||||||
|
|
||||||
|
const size_t backing_size; ///< Size of the backing memory in bytes
|
||||||
|
const size_t virtual_size; ///< Size of the virtual address placeholder in bytes
|
||||||
|
|
||||||
|
u8* backing_base{};
|
||||||
|
u8* virtual_base{};
|
||||||
|
|
||||||
|
private:
|
||||||
|
/// Release all resources in the object
|
||||||
|
void Release() {
|
||||||
|
if (!placeholders.empty()) {
|
||||||
|
for (const auto& placeholder : placeholders) {
|
||||||
|
if (!pfn_UnmapViewOfFile2(process, virtual_base + placeholder.lower(), MEM_PRESERVE_PLACEHOLDER)) {
|
||||||
|
LOG_CRITICAL(HW_Memory, "Failed to unmap virtual memory placeholder");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
Coalesce(0, virtual_size);
|
||||||
|
}
|
||||||
|
if (virtual_base) {
|
||||||
|
if (!VirtualFree(virtual_base, 0, MEM_RELEASE)) {
|
||||||
|
LOG_CRITICAL(HW_Memory, "Failed to free virtual memory");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if (backing_base) {
|
||||||
|
if (!pfn_UnmapViewOfFile2(process, backing_base, MEM_PRESERVE_PLACEHOLDER)) {
|
||||||
|
LOG_CRITICAL(HW_Memory, "Failed to unmap backing memory placeholder");
|
||||||
|
}
|
||||||
|
if (!VirtualFreeEx(process, backing_base, 0, MEM_RELEASE)) {
|
||||||
|
LOG_CRITICAL(HW_Memory, "Failed to free backing memory");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if (!CloseHandle(backing_handle)) {
|
||||||
|
LOG_CRITICAL(HW_Memory, "Failed to free backing memory file handle");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Unmap one placeholder in the given range (partial unmaps are supported)
|
||||||
|
/// Return true when there are no more placeholders to unmap
|
||||||
|
bool UnmapOnePlaceholder(size_t virtual_offset, size_t length) {
|
||||||
|
const auto it = placeholders.find({virtual_offset, virtual_offset + length});
|
||||||
|
const auto begin = placeholders.begin();
|
||||||
|
const auto end = placeholders.end();
|
||||||
|
if (it == end) {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
const size_t placeholder_begin = it->lower();
|
||||||
|
const size_t placeholder_end = it->upper();
|
||||||
|
const size_t unmap_begin = std::max(virtual_offset, placeholder_begin);
|
||||||
|
const size_t unmap_end = std::min(virtual_offset + length, placeholder_end);
|
||||||
|
ASSERT(unmap_begin >= placeholder_begin && unmap_begin < placeholder_end);
|
||||||
|
ASSERT(unmap_end <= placeholder_end && unmap_end > placeholder_begin);
|
||||||
|
|
||||||
|
const auto host_pointer_it = placeholder_host_pointers.find(placeholder_begin);
|
||||||
|
ASSERT(host_pointer_it != placeholder_host_pointers.end());
|
||||||
|
const size_t host_offset = host_pointer_it->second;
|
||||||
|
|
||||||
|
const bool split_left = unmap_begin > placeholder_begin;
|
||||||
|
const bool split_right = unmap_end < placeholder_end;
|
||||||
|
|
||||||
|
if (!pfn_UnmapViewOfFile2(process, virtual_base + placeholder_begin, MEM_PRESERVE_PLACEHOLDER)) {
|
||||||
|
LOG_CRITICAL(HW_Memory, "Failed to unmap placeholder");
|
||||||
|
}
|
||||||
|
// If we have to remap memory regions due to partial unmaps, we are in a data race as
|
||||||
|
// Windows doesn't support remapping memory without unmapping first. Avoid adding any extra
|
||||||
|
// logic within the panic region described below.
|
||||||
|
|
||||||
|
// Panic region, we are in a data race right now
|
||||||
|
if (split_left || split_right) {
|
||||||
|
Split(unmap_begin, unmap_end - unmap_begin);
|
||||||
|
}
|
||||||
|
if (split_left) {
|
||||||
|
MapView(placeholder_begin, host_offset, unmap_begin - placeholder_begin);
|
||||||
|
}
|
||||||
|
if (split_right) {
|
||||||
|
MapView(unmap_end, host_offset + unmap_end - placeholder_begin, placeholder_end - unmap_end);
|
||||||
|
}
|
||||||
|
// End panic region
|
||||||
|
|
||||||
|
size_t coalesce_begin = unmap_begin;
|
||||||
|
if (!split_left) {
|
||||||
|
// Try to coalesce pages to the left
|
||||||
|
coalesce_begin = it == begin ? 0 : std::prev(it)->upper();
|
||||||
|
if (coalesce_begin != placeholder_begin) {
|
||||||
|
Coalesce(coalesce_begin, unmap_end - coalesce_begin);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if (!split_right) {
|
||||||
|
// Try to coalesce pages to the right
|
||||||
|
const auto next = std::next(it);
|
||||||
|
const size_t next_begin = next == end ? virtual_size : next->lower();
|
||||||
|
if (placeholder_end != next_begin) {
|
||||||
|
// We can coalesce to the right
|
||||||
|
Coalesce(coalesce_begin, next_begin - coalesce_begin);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
// Remove and reinsert placeholder trackers
|
||||||
|
UntrackPlaceholder(it);
|
||||||
|
if (split_left) {
|
||||||
|
TrackPlaceholder(placeholder_begin, host_offset, unmap_begin - placeholder_begin);
|
||||||
|
}
|
||||||
|
if (split_right) {
|
||||||
|
TrackPlaceholder(unmap_end, host_offset + unmap_end - placeholder_begin, placeholder_end - unmap_end);
|
||||||
|
}
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
void MapView(size_t virtual_offset, size_t host_offset, size_t length) {
|
||||||
|
if (!pfn_MapViewOfFile3(
|
||||||
|
backing_handle, process, virtual_base + virtual_offset, host_offset, length, MEM_REPLACE_PLACEHOLDER, PAGE_READWRITE, nullptr, 0
|
||||||
|
)) {
|
||||||
|
LOG_CRITICAL(HW_Memory, "Failed to map placeholder");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
void Split(size_t virtual_offset, size_t length) {
|
||||||
|
if (!VirtualFreeEx(process, reinterpret_cast<LPVOID>(virtual_base + virtual_offset), length, MEM_RELEASE | MEM_PRESERVE_PLACEHOLDER)) {
|
||||||
|
LOG_CRITICAL(HW_Memory, "Failed to split placeholder");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
void Coalesce(size_t virtual_offset, size_t length) {
|
||||||
|
if (!VirtualFreeEx(process, reinterpret_cast<LPVOID>(virtual_base + virtual_offset), length, MEM_RELEASE | MEM_COALESCE_PLACEHOLDERS)) {
|
||||||
|
LOG_CRITICAL(HW_Memory, "Failed to coalesce placeholders");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
void TrackPlaceholder(size_t virtual_offset, size_t host_offset, size_t length) {
|
||||||
|
placeholders.insert({virtual_offset, virtual_offset + length});
|
||||||
|
placeholder_host_pointers.emplace(virtual_offset, host_offset);
|
||||||
|
}
|
||||||
|
|
||||||
|
void UntrackPlaceholder(boost::icl::separate_interval_set<size_t>::iterator it) {
|
||||||
|
placeholder_host_pointers.erase(it->lower());
|
||||||
|
placeholders.erase(it);
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Return true when a given memory region is a "nieche" and the placeholders don't have to be
|
||||||
|
/// split.
|
||||||
|
bool IsNiechePlaceholder(size_t virtual_offset, size_t length) const {
|
||||||
|
const auto it = placeholders.upper_bound({virtual_offset, virtual_offset + length});
|
||||||
|
if (it != placeholders.end() && it->lower() == virtual_offset + length) {
|
||||||
|
return it == placeholders.begin() ? virtual_offset == 0 : std::prev(it)->upper() == virtual_offset;
|
||||||
|
}
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
HANDLE process{}; ///< Current process handle
|
||||||
|
HANDLE backing_handle{}; ///< File based backing memory
|
||||||
|
|
||||||
|
DynamicLibrary kernelbase_dll;
|
||||||
|
PFN_CreateFileMapping2 pfn_CreateFileMapping2{};
|
||||||
|
PFN_VirtualAlloc2 pfn_VirtualAlloc2{};
|
||||||
|
PFN_MapViewOfFile3 pfn_MapViewOfFile3{};
|
||||||
|
PFN_UnmapViewOfFile2 pfn_UnmapViewOfFile2{};
|
||||||
|
|
||||||
|
std::mutex placeholder_mutex; ///< Mutex for placeholders
|
||||||
|
boost::icl::separate_interval_set<size_t> placeholders; ///< Mapped placeholders
|
||||||
|
std::unordered_map<size_t, size_t> placeholder_host_pointers; ///< Placeholder backing offset
|
||||||
|
};
|
||||||
|
|
||||||
|
#elif defined(__linux__) || defined(__FreeBSD__) // ^^^ Windows ^^^ vvv Linux vvv
|
||||||
|
|
||||||
|
#ifdef ARCHITECTURE_arm64
|
||||||
|
|
||||||
|
static void* ChooseVirtualBase(size_t virtual_size) {
|
||||||
|
constexpr uintptr_t Map39BitSize = (1ULL << 39);
|
||||||
|
constexpr uintptr_t Map36BitSize = (1ULL << 36);
|
||||||
|
|
||||||
|
// This is not a cryptographic application, we just want something random.
|
||||||
|
std::mt19937_64 rng;
|
||||||
|
|
||||||
|
// We want to ensure we are allocating at an address aligned to the L2 block size.
|
||||||
|
// For Qualcomm devices, we must also allocate memory above 36 bits.
|
||||||
|
const size_t lower = Map36BitSize / HugePageSize;
|
||||||
|
const size_t upper = (Map39BitSize - virtual_size) / HugePageSize;
|
||||||
|
const size_t range = upper - lower;
|
||||||
|
|
||||||
|
// Try up to 64 times to allocate memory at random addresses in the range.
|
||||||
|
for (int i = 0; i < 64; i++) {
|
||||||
|
// Calculate a possible location.
|
||||||
|
uintptr_t hint_address = ((rng() % range) + lower) * HugePageSize;
|
||||||
|
|
||||||
|
// Try to map.
|
||||||
|
// Note: we may be able to take advantage of MAP_FIXED_NOREPLACE here.
|
||||||
|
void* map_pointer =
|
||||||
|
mmap(reinterpret_cast<void*>(hint_address), virtual_size, PROT_READ | PROT_WRITE, MAP_PRIVATE | MAP_ANONYMOUS | MAP_NORESERVE, -1, 0);
|
||||||
|
|
||||||
|
// If we successfully mapped, we're done.
|
||||||
|
if (reinterpret_cast<uintptr_t>(map_pointer) == hint_address) {
|
||||||
|
return map_pointer;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Unmap if necessary, and try again.
|
||||||
|
if (map_pointer != MAP_FAILED) {
|
||||||
|
munmap(map_pointer, virtual_size);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return MAP_FAILED;
|
||||||
|
}
|
||||||
|
|
||||||
|
#else
|
||||||
|
|
||||||
|
static void* ChooseVirtualBase(size_t virtual_size) {
|
||||||
|
#if defined(__FreeBSD__)
|
||||||
|
void* virtual_base =
|
||||||
|
mmap(nullptr, virtual_size, PROT_READ | PROT_WRITE, MAP_PRIVATE | MAP_ANONYMOUS | MAP_NORESERVE | MAP_ALIGNED_SUPER, -1, 0);
|
||||||
|
|
||||||
|
if (virtual_base != MAP_FAILED) {
|
||||||
|
return virtual_base;
|
||||||
|
}
|
||||||
|
#endif
|
||||||
|
|
||||||
|
return mmap(nullptr, virtual_size, PROT_READ | PROT_WRITE, MAP_PRIVATE | MAP_ANONYMOUS | MAP_NORESERVE, -1, 0);
|
||||||
|
}
|
||||||
|
|
||||||
|
#endif
|
||||||
|
|
||||||
|
class HostMemory::Impl {
|
||||||
|
public:
|
||||||
|
explicit Impl(size_t backing_size_, size_t virtual_size_) : backing_size{backing_size_}, virtual_size{virtual_size_} {
|
||||||
|
bool good = false;
|
||||||
|
SCOPE_EXIT {
|
||||||
|
if (!good) {
|
||||||
|
Release();
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
long page_size = sysconf(_SC_PAGESIZE);
|
||||||
|
if (page_size != 0x1000) {
|
||||||
|
LOG_CRITICAL(HW_Memory, "page size {:#x} is incompatible with 4K paging", page_size);
|
||||||
|
throw std::bad_alloc{};
|
||||||
|
}
|
||||||
|
|
||||||
|
// Backing memory initialization
|
||||||
|
#if defined(__FreeBSD__) && __FreeBSD__ < 13
|
||||||
|
// XXX Drop after FreeBSD 12.* reaches EOL on 2024-06-30
|
||||||
|
fd = shm_open(SHM_ANON, O_RDWR, 0600);
|
||||||
|
#else
|
||||||
|
fd = memfd_create("HostMemory", 0);
|
||||||
|
#endif
|
||||||
|
if (fd < 0) {
|
||||||
|
LOG_CRITICAL(HW_Memory, "memfd_create failed: {}", strerror(errno));
|
||||||
|
throw std::bad_alloc{};
|
||||||
|
}
|
||||||
|
|
||||||
|
// Defined to extend the file with zeros
|
||||||
|
int ret = ftruncate(fd, backing_size);
|
||||||
|
if (ret != 0) {
|
||||||
|
LOG_CRITICAL(HW_Memory, "ftruncate failed with {}, are you out-of-memory?", strerror(errno));
|
||||||
|
throw std::bad_alloc{};
|
||||||
|
}
|
||||||
|
|
||||||
|
backing_base = static_cast<u8*>(mmap(nullptr, backing_size, PROT_READ | PROT_WRITE, MAP_SHARED, fd, 0));
|
||||||
|
if (backing_base == MAP_FAILED) {
|
||||||
|
LOG_CRITICAL(HW_Memory, "mmap failed: {}", strerror(errno));
|
||||||
|
throw std::bad_alloc{};
|
||||||
|
}
|
||||||
|
|
||||||
|
// Virtual memory initialization
|
||||||
|
virtual_base = virtual_map_base = static_cast<u8*>(ChooseVirtualBase(virtual_size));
|
||||||
|
if (virtual_base == MAP_FAILED) {
|
||||||
|
LOG_CRITICAL(HW_Memory, "mmap failed: {}", strerror(errno));
|
||||||
|
throw std::bad_alloc{};
|
||||||
|
}
|
||||||
|
#if defined(__linux__)
|
||||||
|
madvise(virtual_base, virtual_size, MADV_HUGEPAGE);
|
||||||
|
#endif
|
||||||
|
|
||||||
|
free_manager.SetAddressSpace(virtual_base, virtual_size);
|
||||||
|
good = true;
|
||||||
|
}
|
||||||
|
|
||||||
|
~Impl() { Release(); }
|
||||||
|
|
||||||
|
void Map(size_t virtual_offset, size_t host_offset, size_t length, MemoryPermission perms) {
|
||||||
|
// Intersect the range with our address space.
|
||||||
|
AdjustMap(&virtual_offset, &length);
|
||||||
|
|
||||||
|
// We are removing a placeholder.
|
||||||
|
free_manager.AllocateBlock(virtual_base + virtual_offset, length);
|
||||||
|
|
||||||
|
// Deduce mapping protection flags.
|
||||||
|
int flags = PROT_NONE;
|
||||||
|
if (True(perms & MemoryPermission::Read)) {
|
||||||
|
flags |= PROT_READ;
|
||||||
|
}
|
||||||
|
if (True(perms & MemoryPermission::Write)) {
|
||||||
|
flags |= PROT_WRITE;
|
||||||
|
}
|
||||||
|
#ifdef ARCHITECTURE_arm64
|
||||||
|
if (True(perms & MemoryPermission::Execute)) {
|
||||||
|
flags |= PROT_EXEC;
|
||||||
|
}
|
||||||
|
#endif
|
||||||
|
|
||||||
|
void* ret = mmap(virtual_base + virtual_offset, length, flags, MAP_SHARED | MAP_FIXED, fd, host_offset);
|
||||||
|
ASSERT_MSG(ret != MAP_FAILED, "mmap failed: {}", strerror(errno));
|
||||||
|
}
|
||||||
|
|
||||||
|
void Unmap(size_t virtual_offset, size_t length) {
|
||||||
|
// The method name is wrong. We're still talking about the virtual range.
|
||||||
|
// We don't want to unmap, we want to reserve this memory.
|
||||||
|
|
||||||
|
// Intersect the range with our address space.
|
||||||
|
AdjustMap(&virtual_offset, &length);
|
||||||
|
|
||||||
|
// Merge with any adjacent placeholder mappings.
|
||||||
|
auto [merged_pointer, merged_size] = free_manager.FreeBlock(virtual_base + virtual_offset, length);
|
||||||
|
|
||||||
|
void* ret = mmap(merged_pointer, merged_size, PROT_NONE, MAP_PRIVATE | MAP_ANONYMOUS | MAP_FIXED, -1, 0);
|
||||||
|
ASSERT_MSG(ret != MAP_FAILED, "mmap failed: {}", strerror(errno));
|
||||||
|
}
|
||||||
|
|
||||||
|
void Protect(size_t virtual_offset, size_t length, bool read, bool write, bool execute) {
|
||||||
|
// Intersect the range with our address space.
|
||||||
|
AdjustMap(&virtual_offset, &length);
|
||||||
|
|
||||||
|
int flags = PROT_NONE;
|
||||||
|
if (read) {
|
||||||
|
flags |= PROT_READ;
|
||||||
|
}
|
||||||
|
if (write) {
|
||||||
|
flags |= PROT_WRITE;
|
||||||
|
}
|
||||||
|
#ifdef HAS_NCE
|
||||||
|
if (execute) {
|
||||||
|
flags |= PROT_EXEC;
|
||||||
|
}
|
||||||
|
#endif
|
||||||
|
int ret = mprotect(virtual_base + virtual_offset, length, flags);
|
||||||
|
ASSERT_MSG(ret == 0, "mprotect failed: {}", strerror(errno));
|
||||||
|
}
|
||||||
|
|
||||||
|
bool ClearBackingRegion(size_t physical_offset, size_t length) {
|
||||||
|
#ifdef __linux__
|
||||||
|
// Set MADV_REMOVE on backing map to destroy it instantly.
|
||||||
|
// This also deletes the area from the backing file.
|
||||||
|
int ret = madvise(backing_base + physical_offset, length, MADV_REMOVE);
|
||||||
|
ASSERT_MSG(ret == 0, "madvise failed: {}", strerror(errno));
|
||||||
|
|
||||||
|
return true;
|
||||||
|
#else
|
||||||
|
return false;
|
||||||
|
#endif
|
||||||
|
}
|
||||||
|
|
||||||
|
void EnableDirectMappedAddress() { virtual_base = nullptr; }
|
||||||
|
|
||||||
|
const size_t backing_size; ///< Size of the backing memory in bytes
|
||||||
|
const size_t virtual_size; ///< Size of the virtual address placeholder in bytes
|
||||||
|
|
||||||
|
u8* backing_base{reinterpret_cast<u8*>(MAP_FAILED)};
|
||||||
|
u8* virtual_base{reinterpret_cast<u8*>(MAP_FAILED)};
|
||||||
|
u8* virtual_map_base{reinterpret_cast<u8*>(MAP_FAILED)};
|
||||||
|
|
||||||
|
private:
|
||||||
|
/// Release all resources in the object
|
||||||
|
void Release() {
|
||||||
|
if (virtual_map_base != MAP_FAILED) {
|
||||||
|
int ret = munmap(virtual_map_base, virtual_size);
|
||||||
|
ASSERT_MSG(ret == 0, "munmap failed: {}", strerror(errno));
|
||||||
|
}
|
||||||
|
|
||||||
|
if (backing_base != MAP_FAILED) {
|
||||||
|
int ret = munmap(backing_base, backing_size);
|
||||||
|
ASSERT_MSG(ret == 0, "munmap failed: {}", strerror(errno));
|
||||||
|
}
|
||||||
|
|
||||||
|
if (fd != -1) {
|
||||||
|
int ret = close(fd);
|
||||||
|
ASSERT_MSG(ret == 0, "close failed: {}", strerror(errno));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
void AdjustMap(size_t* virtual_offset, size_t* length) {
|
||||||
|
if (virtual_base != nullptr) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
// If we are direct mapped, we want to make sure we are operating on a region
|
||||||
|
// that is in range of our virtual mapping.
|
||||||
|
size_t intended_start = *virtual_offset;
|
||||||
|
size_t intended_end = intended_start + *length;
|
||||||
|
size_t address_space_start = reinterpret_cast<size_t>(virtual_map_base);
|
||||||
|
size_t address_space_end = address_space_start + virtual_size;
|
||||||
|
|
||||||
|
if (address_space_start > intended_end || intended_start > address_space_end) {
|
||||||
|
*virtual_offset = 0;
|
||||||
|
*length = 0;
|
||||||
|
} else {
|
||||||
|
*virtual_offset = std::max(intended_start, address_space_start);
|
||||||
|
*length = std::min(intended_end, address_space_end) - *virtual_offset;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
int fd{-1}; // memfd file descriptor, -1 is the error value of memfd_create
|
||||||
|
FreeRegionManager free_manager{};
|
||||||
|
};
|
||||||
|
|
||||||
|
#else // ^^^ Linux ^^^ vvv Generic vvv
|
||||||
|
|
||||||
|
class HostMemory::Impl {
|
||||||
|
public:
|
||||||
|
explicit Impl(size_t /*backing_size */, size_t /* virtual_size */) {
|
||||||
|
// This is just a place holder.
|
||||||
|
// Please implement fastmem in a proper way on your platform.
|
||||||
|
throw std::bad_alloc{};
|
||||||
|
}
|
||||||
|
|
||||||
|
void Map(size_t virtual_offset, size_t host_offset, size_t length, MemoryPermission perm) {}
|
||||||
|
void Unmap(size_t virtual_offset, size_t length) {}
|
||||||
|
void Protect(size_t virtual_offset, size_t length, bool read, bool write, bool execute) {}
|
||||||
|
bool ClearBackingRegion(size_t physical_offset, size_t length) { return false; }
|
||||||
|
void EnableDirectMappedAddress() {}
|
||||||
|
|
||||||
|
u8* backing_base{nullptr};
|
||||||
|
u8* virtual_base{nullptr};
|
||||||
|
};
|
||||||
|
|
||||||
|
#endif // ^^^ Generic ^^^
|
||||||
|
|
||||||
|
HostMemory::HostMemory(size_t backing_size_, size_t virtual_size_) : backing_size(backing_size_), virtual_size(virtual_size_) {
|
||||||
|
try {
|
||||||
|
// Try to allocate a fastmem arena.
|
||||||
|
// The implementation will fail with std::bad_alloc on errors.
|
||||||
|
impl = std::make_unique<HostMemory::Impl>(Common::alignUp(backing_size, PageAlignment), Common::alignUp(virtual_size, PageAlignment) + HugePageSize);
|
||||||
|
backing_base = impl->backing_base;
|
||||||
|
virtual_base = impl->virtual_base;
|
||||||
|
|
||||||
|
if (virtual_base) {
|
||||||
|
// Ensure the virtual base is aligned to the L2 block size.
|
||||||
|
virtual_base = reinterpret_cast<u8*>(Common::alignUp(reinterpret_cast<uintptr_t>(virtual_base), HugePageSize));
|
||||||
|
virtual_base_offset = virtual_base - impl->virtual_base;
|
||||||
|
}
|
||||||
|
|
||||||
|
} catch (const std::bad_alloc&) {
|
||||||
|
Helpers::warn("Fastmem unavailable, falling back to VirtualBuffer for memory allocation");
|
||||||
|
fallback_buffer = std::make_unique<Common::VirtualBuffer<u8>>(backing_size);
|
||||||
|
backing_base = fallback_buffer->data();
|
||||||
|
virtual_base = nullptr;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
HostMemory::~HostMemory() = default;
|
||||||
|
HostMemory::HostMemory(HostMemory&&) noexcept = default;
|
||||||
|
HostMemory& HostMemory::operator=(HostMemory&&) noexcept = default;
|
||||||
|
|
||||||
|
void HostMemory::Map(size_t virtual_offset, size_t host_offset, size_t length, MemoryPermission perms, bool separate_heap) {
|
||||||
|
ASSERT(virtual_offset % PageAlignment == 0);
|
||||||
|
ASSERT(host_offset % PageAlignment == 0);
|
||||||
|
ASSERT(length % PageAlignment == 0);
|
||||||
|
ASSERT(virtual_offset + length <= virtual_size);
|
||||||
|
ASSERT(host_offset + length <= backing_size);
|
||||||
|
if (length == 0 || !virtual_base || !impl) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
impl->Map(virtual_offset + virtual_base_offset, host_offset, length, perms);
|
||||||
|
}
|
||||||
|
|
||||||
|
void HostMemory::Unmap(size_t virtual_offset, size_t length, bool separate_heap) {
|
||||||
|
ASSERT(virtual_offset % PageAlignment == 0);
|
||||||
|
ASSERT(length % PageAlignment == 0);
|
||||||
|
ASSERT(virtual_offset + length <= virtual_size);
|
||||||
|
if (length == 0 || !virtual_base || !impl) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
impl->Unmap(virtual_offset + virtual_base_offset, length);
|
||||||
|
}
|
||||||
|
|
||||||
|
void HostMemory::Protect(size_t virtual_offset, size_t length, MemoryPermission perm) {
|
||||||
|
ASSERT(virtual_offset % PageAlignment == 0);
|
||||||
|
ASSERT(length % PageAlignment == 0);
|
||||||
|
ASSERT(virtual_offset + length <= virtual_size);
|
||||||
|
if (length == 0 || !virtual_base || !impl) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
const bool read = True(perm & MemoryPermission::Read);
|
||||||
|
const bool write = True(perm & MemoryPermission::Write);
|
||||||
|
const bool execute = True(perm & MemoryPermission::Execute);
|
||||||
|
impl->Protect(virtual_offset + virtual_base_offset, length, read, write, execute);
|
||||||
|
}
|
||||||
|
|
||||||
|
void HostMemory::ClearBackingRegion(size_t physical_offset, size_t length, u32 fill_value) {
|
||||||
|
if (!impl || fill_value != 0 || !impl->ClearBackingRegion(physical_offset, length)) {
|
||||||
|
std::memset(backing_base + physical_offset, fill_value, length);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
void HostMemory::EnableDirectMappedAddress() {
|
||||||
|
if (impl) {
|
||||||
|
impl->EnableDirectMappedAddress();
|
||||||
|
virtual_size += reinterpret_cast<uintptr_t>(virtual_base);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
} // namespace Common
|
75
third_party/host_memory/include/host_memory/dynamic_library.h
vendored
Normal file
75
third_party/host_memory/include/host_memory/dynamic_library.h
vendored
Normal file
|
@ -0,0 +1,75 @@
|
||||||
|
// SPDX-FileCopyrightText: 2019 Dolphin Emulator Project
|
||||||
|
// SPDX-License-Identifier: GPL-2.0-or-later
|
||||||
|
|
||||||
|
#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.
|
||||||
|
explicit DynamicLibrary();
|
||||||
|
|
||||||
|
/// Automatically loads the specified library. Call IsOpen() to check validity before use.
|
||||||
|
explicit DynamicLibrary(const char* filename);
|
||||||
|
|
||||||
|
/// Initializes the dynamic library with an already opened handle.
|
||||||
|
explicit DynamicLibrary(void* handle_);
|
||||||
|
|
||||||
|
/// Moves the library.
|
||||||
|
DynamicLibrary(DynamicLibrary&&) noexcept;
|
||||||
|
DynamicLibrary& operator=(DynamicLibrary&&) noexcept;
|
||||||
|
|
||||||
|
/// Delete copies, we can't copy a dynamic library.
|
||||||
|
DynamicLibrary(const DynamicLibrary&) = delete;
|
||||||
|
DynamicLibrary& operator=(const DynamicLibrary&) = delete;
|
||||||
|
|
||||||
|
/// Closes the library.
|
||||||
|
~DynamicLibrary();
|
||||||
|
|
||||||
|
/// Returns the specified library name with the platform-specific suffix added.
|
||||||
|
[[nodiscard]] 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
|
||||||
|
[[nodiscard]] static std::string GetVersionedFilename(const char* libname, int major = -1, int minor = -1);
|
||||||
|
|
||||||
|
/// Returns true if a module is loaded, otherwise false.
|
||||||
|
[[nodiscard]] bool IsOpen() const { return handle != nullptr; }
|
||||||
|
|
||||||
|
/// Loads (or replaces) the handle with the specified library file name.
|
||||||
|
/// Returns true if the library was loaded and can be used.
|
||||||
|
[[nodiscard]] 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.
|
||||||
|
[[nodiscard]] 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>
|
||||||
|
[[nodiscard]] bool GetSymbol(const char* name, T* ptr) const {
|
||||||
|
*ptr = reinterpret_cast<T>(GetSymbolAddress(name));
|
||||||
|
return *ptr != nullptr;
|
||||||
|
}
|
||||||
|
|
||||||
|
private:
|
||||||
|
/// Platform-dependent data type representing a dynamic library handle.
|
||||||
|
void* handle = nullptr;
|
||||||
|
};
|
||||||
|
|
||||||
|
} // namespace Common
|
75
third_party/host_memory/include/host_memory/host_memory.h
vendored
Normal file
75
third_party/host_memory/include/host_memory/host_memory.h
vendored
Normal file
|
@ -0,0 +1,75 @@
|
||||||
|
// SPDX-FileCopyrightText: Copyright 2019 yuzu Emulator Project
|
||||||
|
// SPDX-License-Identifier: GPL-2.0-or-later
|
||||||
|
|
||||||
|
#pragma once
|
||||||
|
|
||||||
|
#include <memory>
|
||||||
|
|
||||||
|
#include "common/common_funcs.h"
|
||||||
|
#include "host_memory/virtual_buffer.h"
|
||||||
|
#include "helpers.hpp"
|
||||||
|
|
||||||
|
namespace Common {
|
||||||
|
|
||||||
|
enum class MemoryPermission : u32 {
|
||||||
|
Read = 1 << 0,
|
||||||
|
Write = 1 << 1,
|
||||||
|
ReadWrite = Read | Write,
|
||||||
|
Execute = 1 << 2,
|
||||||
|
};
|
||||||
|
DECLARE_ENUM_FLAG_OPERATORS(MemoryPermission)
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A low level linear memory buffer, which supports multiple mappings
|
||||||
|
* Its purpose is to rebuild a given sparse memory layout, including mirrors.
|
||||||
|
*/
|
||||||
|
class HostMemory {
|
||||||
|
public:
|
||||||
|
explicit HostMemory(size_t backing_size_, size_t virtual_size_);
|
||||||
|
~HostMemory();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Copy constructors. They shall return a copy of the buffer without the mappings.
|
||||||
|
* TODO: Implement them with COW if needed.
|
||||||
|
*/
|
||||||
|
HostMemory(const HostMemory& other) = delete;
|
||||||
|
HostMemory& operator=(const HostMemory& other) = delete;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Move constructors. They will move the buffer and the mappings to the new object.
|
||||||
|
*/
|
||||||
|
HostMemory(HostMemory&& other) noexcept;
|
||||||
|
HostMemory& operator=(HostMemory&& other) noexcept;
|
||||||
|
|
||||||
|
void Map(size_t virtual_offset, size_t host_offset, size_t length, MemoryPermission perms, bool separate_heap);
|
||||||
|
void Unmap(size_t virtual_offset, size_t length, bool separate_heap);
|
||||||
|
void Protect(size_t virtual_offset, size_t length, MemoryPermission perms);
|
||||||
|
|
||||||
|
void EnableDirectMappedAddress();
|
||||||
|
|
||||||
|
void ClearBackingRegion(size_t physical_offset, size_t length, u32 fill_value);
|
||||||
|
|
||||||
|
[[nodiscard]] u8* BackingBasePointer() noexcept { return backing_base; }
|
||||||
|
[[nodiscard]] const u8* BackingBasePointer() const noexcept { return backing_base; }
|
||||||
|
|
||||||
|
[[nodiscard]] u8* VirtualBasePointer() noexcept { return virtual_base; }
|
||||||
|
[[nodiscard]] const u8* VirtualBasePointer() const noexcept { return virtual_base; }
|
||||||
|
|
||||||
|
bool IsInVirtualRange(void* address) const noexcept { return address >= virtual_base && address < virtual_base + virtual_size; }
|
||||||
|
|
||||||
|
private:
|
||||||
|
size_t backing_size{};
|
||||||
|
size_t virtual_size{};
|
||||||
|
|
||||||
|
// Low level handler for the platform dependent memory routines
|
||||||
|
class Impl;
|
||||||
|
std::unique_ptr<Impl> impl;
|
||||||
|
u8* backing_base{};
|
||||||
|
u8* virtual_base{};
|
||||||
|
size_t virtual_base_offset{};
|
||||||
|
|
||||||
|
// Fallback if fastmem is not supported on this platform
|
||||||
|
std::unique_ptr<Common::VirtualBuffer<u8>> fallback_buffer;
|
||||||
|
};
|
||||||
|
|
||||||
|
} // namespace Common
|
68
third_party/host_memory/include/host_memory/virtual_buffer.h
vendored
Normal file
68
third_party/host_memory/include/host_memory/virtual_buffer.h
vendored
Normal file
|
@ -0,0 +1,68 @@
|
||||||
|
// SPDX-FileCopyrightText: Copyright 2020 yuzu Emulator Project
|
||||||
|
// SPDX-License-Identifier: GPL-2.0-or-later
|
||||||
|
|
||||||
|
#pragma once
|
||||||
|
|
||||||
|
#include "helpers.hpp"
|
||||||
|
#include <utility>
|
||||||
|
|
||||||
|
namespace Common {
|
||||||
|
|
||||||
|
void* AllocateMemoryPages(std::size_t size) noexcept;
|
||||||
|
void FreeMemoryPages(void* base, std::size_t size) noexcept;
|
||||||
|
|
||||||
|
template <typename T>
|
||||||
|
class VirtualBuffer final {
|
||||||
|
public:
|
||||||
|
// TODO: Uncomment this and change Common::PageTable::PageInfo to be trivially constructible
|
||||||
|
// using std::atomic_ref once libc++ has support for it
|
||||||
|
// static_assert(
|
||||||
|
// std::is_trivially_constructible_v<T>,
|
||||||
|
// "T must be trivially constructible, as non-trivial constructors will not be executed "
|
||||||
|
// "with the current allocator");
|
||||||
|
|
||||||
|
constexpr VirtualBuffer() = default;
|
||||||
|
explicit VirtualBuffer(std::size_t count) : alloc_size{count * sizeof(T)} {
|
||||||
|
base_ptr = reinterpret_cast<T*>(AllocateMemoryPages(alloc_size));
|
||||||
|
}
|
||||||
|
|
||||||
|
~VirtualBuffer() noexcept { FreeMemoryPages(base_ptr, alloc_size); }
|
||||||
|
|
||||||
|
VirtualBuffer(const VirtualBuffer&) = delete;
|
||||||
|
VirtualBuffer& operator=(const VirtualBuffer&) = delete;
|
||||||
|
|
||||||
|
VirtualBuffer(VirtualBuffer&& other) noexcept
|
||||||
|
: alloc_size{std::exchange(other.alloc_size, 0)}, base_ptr{std::exchange(other.base_ptr), nullptr} {}
|
||||||
|
|
||||||
|
VirtualBuffer& operator=(VirtualBuffer&& other) noexcept {
|
||||||
|
alloc_size = std::exchange(other.alloc_size, 0);
|
||||||
|
base_ptr = std::exchange(other.base_ptr, nullptr);
|
||||||
|
return *this;
|
||||||
|
}
|
||||||
|
|
||||||
|
void resize(std::size_t count) {
|
||||||
|
const auto new_size = count * sizeof(T);
|
||||||
|
if (new_size == alloc_size) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
FreeMemoryPages(base_ptr, alloc_size);
|
||||||
|
|
||||||
|
alloc_size = new_size;
|
||||||
|
base_ptr = reinterpret_cast<T*>(AllocateMemoryPages(alloc_size));
|
||||||
|
}
|
||||||
|
|
||||||
|
[[nodiscard]] constexpr const T& operator[](std::size_t index) const { return base_ptr[index]; }
|
||||||
|
[[nodiscard]] constexpr T& operator[](std::size_t index) { return base_ptr[index]; }
|
||||||
|
|
||||||
|
[[nodiscard]] constexpr T* data() { return base_ptr; }
|
||||||
|
[[nodiscard]] constexpr const T* data() const { return base_ptr; }
|
||||||
|
|
||||||
|
[[nodiscard]] constexpr std::size_t size() const { return alloc_size / sizeof(T); }
|
||||||
|
|
||||||
|
private:
|
||||||
|
std::size_t alloc_size{};
|
||||||
|
T* base_ptr{};
|
||||||
|
};
|
||||||
|
|
||||||
|
} // namespace Common
|
47
third_party/host_memory/virtual_buffer.cpp
vendored
Normal file
47
third_party/host_memory/virtual_buffer.cpp
vendored
Normal file
|
@ -0,0 +1,47 @@
|
||||||
|
// SPDX-FileCopyrightText: Copyright 2020 yuzu Emulator Project
|
||||||
|
// SPDX-License-Identifier: GPL-2.0-or-later
|
||||||
|
|
||||||
|
#ifdef _WIN32
|
||||||
|
#include <windows.h>
|
||||||
|
#else
|
||||||
|
#include <sys/mman.h>
|
||||||
|
#endif
|
||||||
|
|
||||||
|
#include "host_memory/virtual_buffer.h"
|
||||||
|
|
||||||
|
namespace Common {
|
||||||
|
|
||||||
|
void* AllocateMemoryPages(std::size_t size) noexcept {
|
||||||
|
#ifdef _WIN32
|
||||||
|
void* base{VirtualAlloc(nullptr, size, MEM_COMMIT, PAGE_READWRITE)};
|
||||||
|
#else
|
||||||
|
void* base{mmap(nullptr, size, PROT_READ | PROT_WRITE, MAP_ANON | MAP_PRIVATE, -1, 0)};
|
||||||
|
|
||||||
|
if (base == MAP_FAILED) {
|
||||||
|
base = nullptr;
|
||||||
|
}
|
||||||
|
#endif
|
||||||
|
|
||||||
|
if (!base) {
|
||||||
|
Helpers::panic("Failed to allocate memory pages");
|
||||||
|
}
|
||||||
|
|
||||||
|
return base;
|
||||||
|
}
|
||||||
|
|
||||||
|
void FreeMemoryPages(void* base, [[maybe_unused]] std::size_t size) noexcept {
|
||||||
|
if (!base) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
#ifdef _WIN32
|
||||||
|
if (!VirtualFree(base, 0, MEM_RELEASE)) {
|
||||||
|
Helpers::panic("Failed to free memory pages");
|
||||||
|
}
|
||||||
|
#else
|
||||||
|
if (munmap(base, size) != 0) {
|
||||||
|
Helpers::panic("Failed to free memory pages");
|
||||||
|
}
|
||||||
|
#endif
|
||||||
|
}
|
||||||
|
|
||||||
|
} // namespace Common
|
674
third_party/pcsx2/LICENSE.md
vendored
674
third_party/pcsx2/LICENSE.md
vendored
|
@ -1,674 +0,0 @@
|
||||||
GNU GENERAL PUBLIC LICENSE
|
|
||||||
Version 3, 29 June 2007
|
|
||||||
|
|
||||||
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
|
|
||||||
Everyone is permitted to copy and distribute verbatim copies
|
|
||||||
of this license document, but changing it is not allowed.
|
|
||||||
|
|
||||||
Preamble
|
|
||||||
|
|
||||||
The GNU General Public License is a free, copyleft license for
|
|
||||||
software and other kinds of works.
|
|
||||||
|
|
||||||
The licenses for most software and other practical works are designed
|
|
||||||
to take away your freedom to share and change the works. By contrast,
|
|
||||||
the GNU General Public License is intended to guarantee your freedom to
|
|
||||||
share and change all versions of a program--to make sure it remains free
|
|
||||||
software for all its users. We, the Free Software Foundation, use the
|
|
||||||
GNU General Public License for most of our software; it applies also to
|
|
||||||
any other work released this way by its authors. You can apply it to
|
|
||||||
your programs, too.
|
|
||||||
|
|
||||||
When we speak of free software, we are referring to freedom, not
|
|
||||||
price. Our General Public Licenses are designed to make sure that you
|
|
||||||
have the freedom to distribute copies of free software (and charge for
|
|
||||||
them if you wish), that you receive source code or can get it if you
|
|
||||||
want it, that you can change the software or use pieces of it in new
|
|
||||||
free programs, and that you know you can do these things.
|
|
||||||
|
|
||||||
To protect your rights, we need to prevent others from denying you
|
|
||||||
these rights or asking you to surrender the rights. Therefore, you have
|
|
||||||
certain responsibilities if you distribute copies of the software, or if
|
|
||||||
you modify it: responsibilities to respect the freedom of others.
|
|
||||||
|
|
||||||
For example, if you distribute copies of such a program, whether
|
|
||||||
gratis or for a fee, you must pass on to the recipients the same
|
|
||||||
freedoms that you received. You must make sure that they, too, receive
|
|
||||||
or can get the source code. And you must show them these terms so they
|
|
||||||
know their rights.
|
|
||||||
|
|
||||||
Developers that use the GNU GPL protect your rights with two steps:
|
|
||||||
(1) assert copyright on the software, and (2) offer you this License
|
|
||||||
giving you legal permission to copy, distribute and/or modify it.
|
|
||||||
|
|
||||||
For the developers' and authors' protection, the GPL clearly explains
|
|
||||||
that there is no warranty for this free software. For both users' and
|
|
||||||
authors' sake, the GPL requires that modified versions be marked as
|
|
||||||
changed, so that their problems will not be attributed erroneously to
|
|
||||||
authors of previous versions.
|
|
||||||
|
|
||||||
Some devices are designed to deny users access to install or run
|
|
||||||
modified versions of the software inside them, although the manufacturer
|
|
||||||
can do so. This is fundamentally incompatible with the aim of
|
|
||||||
protecting users' freedom to change the software. The systematic
|
|
||||||
pattern of such abuse occurs in the area of products for individuals to
|
|
||||||
use, which is precisely where it is most unacceptable. Therefore, we
|
|
||||||
have designed this version of the GPL to prohibit the practice for those
|
|
||||||
products. If such problems arise substantially in other domains, we
|
|
||||||
stand ready to extend this provision to those domains in future versions
|
|
||||||
of the GPL, as needed to protect the freedom of users.
|
|
||||||
|
|
||||||
Finally, every program is threatened constantly by software patents.
|
|
||||||
States should not allow patents to restrict development and use of
|
|
||||||
software on general-purpose computers, but in those that do, we wish to
|
|
||||||
avoid the special danger that patents applied to a free program could
|
|
||||||
make it effectively proprietary. To prevent this, the GPL assures that
|
|
||||||
patents cannot be used to render the program non-free.
|
|
||||||
|
|
||||||
The precise terms and conditions for copying, distribution and
|
|
||||||
modification follow.
|
|
||||||
|
|
||||||
TERMS AND CONDITIONS
|
|
||||||
|
|
||||||
0. Definitions.
|
|
||||||
|
|
||||||
"This License" refers to version 3 of the GNU General Public License.
|
|
||||||
|
|
||||||
"Copyright" also means copyright-like laws that apply to other kinds of
|
|
||||||
works, such as semiconductor masks.
|
|
||||||
|
|
||||||
"The Program" refers to any copyrightable work licensed under this
|
|
||||||
License. Each licensee is addressed as "you". "Licensees" and
|
|
||||||
"recipients" may be individuals or organizations.
|
|
||||||
|
|
||||||
To "modify" a work means to copy from or adapt all or part of the work
|
|
||||||
in a fashion requiring copyright permission, other than the making of an
|
|
||||||
exact copy. The resulting work is called a "modified version" of the
|
|
||||||
earlier work or a work "based on" the earlier work.
|
|
||||||
|
|
||||||
A "covered work" means either the unmodified Program or a work based
|
|
||||||
on the Program.
|
|
||||||
|
|
||||||
To "propagate" a work means to do anything with it that, without
|
|
||||||
permission, would make you directly or secondarily liable for
|
|
||||||
infringement under applicable copyright law, except executing it on a
|
|
||||||
computer or modifying a private copy. Propagation includes copying,
|
|
||||||
distribution (with or without modification), making available to the
|
|
||||||
public, and in some countries other activities as well.
|
|
||||||
|
|
||||||
To "convey" a work means any kind of propagation that enables other
|
|
||||||
parties to make or receive copies. Mere interaction with a user through
|
|
||||||
a computer network, with no transfer of a copy, is not conveying.
|
|
||||||
|
|
||||||
An interactive user interface displays "Appropriate Legal Notices"
|
|
||||||
to the extent that it includes a convenient and prominently visible
|
|
||||||
feature that (1) displays an appropriate copyright notice, and (2)
|
|
||||||
tells the user that there is no warranty for the work (except to the
|
|
||||||
extent that warranties are provided), that licensees may convey the
|
|
||||||
work under this License, and how to view a copy of this License. If
|
|
||||||
the interface presents a list of user commands or options, such as a
|
|
||||||
menu, a prominent item in the list meets this criterion.
|
|
||||||
|
|
||||||
1. Source Code.
|
|
||||||
|
|
||||||
The "source code" for a work means the preferred form of the work
|
|
||||||
for making modifications to it. "Object code" means any non-source
|
|
||||||
form of a work.
|
|
||||||
|
|
||||||
A "Standard Interface" means an interface that either is an official
|
|
||||||
standard defined by a recognized standards body, or, in the case of
|
|
||||||
interfaces specified for a particular programming language, one that
|
|
||||||
is widely used among developers working in that language.
|
|
||||||
|
|
||||||
The "System Libraries" of an executable work include anything, other
|
|
||||||
than the work as a whole, that (a) is included in the normal form of
|
|
||||||
packaging a Major Component, but which is not part of that Major
|
|
||||||
Component, and (b) serves only to enable use of the work with that
|
|
||||||
Major Component, or to implement a Standard Interface for which an
|
|
||||||
implementation is available to the public in source code form. A
|
|
||||||
"Major Component", in this context, means a major essential component
|
|
||||||
(kernel, window system, and so on) of the specific operating system
|
|
||||||
(if any) on which the executable work runs, or a compiler used to
|
|
||||||
produce the work, or an object code interpreter used to run it.
|
|
||||||
|
|
||||||
The "Corresponding Source" for a work in object code form means all
|
|
||||||
the source code needed to generate, install, and (for an executable
|
|
||||||
work) run the object code and to modify the work, including scripts to
|
|
||||||
control those activities. However, it does not include the work's
|
|
||||||
System Libraries, or general-purpose tools or generally available free
|
|
||||||
programs which are used unmodified in performing those activities but
|
|
||||||
which are not part of the work. For example, Corresponding Source
|
|
||||||
includes interface definition files associated with source files for
|
|
||||||
the work, and the source code for shared libraries and dynamically
|
|
||||||
linked subprograms that the work is specifically designed to require,
|
|
||||||
such as by intimate data communication or control flow between those
|
|
||||||
subprograms and other parts of the work.
|
|
||||||
|
|
||||||
The Corresponding Source need not include anything that users
|
|
||||||
can regenerate automatically from other parts of the Corresponding
|
|
||||||
Source.
|
|
||||||
|
|
||||||
The Corresponding Source for a work in source code form is that
|
|
||||||
same work.
|
|
||||||
|
|
||||||
2. Basic Permissions.
|
|
||||||
|
|
||||||
All rights granted under this License are granted for the term of
|
|
||||||
copyright on the Program, and are irrevocable provided the stated
|
|
||||||
conditions are met. This License explicitly affirms your unlimited
|
|
||||||
permission to run the unmodified Program. The output from running a
|
|
||||||
covered work is covered by this License only if the output, given its
|
|
||||||
content, constitutes a covered work. This License acknowledges your
|
|
||||||
rights of fair use or other equivalent, as provided by copyright law.
|
|
||||||
|
|
||||||
You may make, run and propagate covered works that you do not
|
|
||||||
convey, without conditions so long as your license otherwise remains
|
|
||||||
in force. You may convey covered works to others for the sole purpose
|
|
||||||
of having them make modifications exclusively for you, or provide you
|
|
||||||
with facilities for running those works, provided that you comply with
|
|
||||||
the terms of this License in conveying all material for which you do
|
|
||||||
not control copyright. Those thus making or running the covered works
|
|
||||||
for you must do so exclusively on your behalf, under your direction
|
|
||||||
and control, on terms that prohibit them from making any copies of
|
|
||||||
your copyrighted material outside their relationship with you.
|
|
||||||
|
|
||||||
Conveying under any other circumstances is permitted solely under
|
|
||||||
the conditions stated below. Sublicensing is not allowed; section 10
|
|
||||||
makes it unnecessary.
|
|
||||||
|
|
||||||
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
|
||||||
|
|
||||||
No covered work shall be deemed part of an effective technological
|
|
||||||
measure under any applicable law fulfilling obligations under article
|
|
||||||
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
|
||||||
similar laws prohibiting or restricting circumvention of such
|
|
||||||
measures.
|
|
||||||
|
|
||||||
When you convey a covered work, you waive any legal power to forbid
|
|
||||||
circumvention of technological measures to the extent such circumvention
|
|
||||||
is effected by exercising rights under this License with respect to
|
|
||||||
the covered work, and you disclaim any intention to limit operation or
|
|
||||||
modification of the work as a means of enforcing, against the work's
|
|
||||||
users, your or third parties' legal rights to forbid circumvention of
|
|
||||||
technological measures.
|
|
||||||
|
|
||||||
4. Conveying Verbatim Copies.
|
|
||||||
|
|
||||||
You may convey verbatim copies of the Program's source code as you
|
|
||||||
receive it, in any medium, provided that you conspicuously and
|
|
||||||
appropriately publish on each copy an appropriate copyright notice;
|
|
||||||
keep intact all notices stating that this License and any
|
|
||||||
non-permissive terms added in accord with section 7 apply to the code;
|
|
||||||
keep intact all notices of the absence of any warranty; and give all
|
|
||||||
recipients a copy of this License along with the Program.
|
|
||||||
|
|
||||||
You may charge any price or no price for each copy that you convey,
|
|
||||||
and you may offer support or warranty protection for a fee.
|
|
||||||
|
|
||||||
5. Conveying Modified Source Versions.
|
|
||||||
|
|
||||||
You may convey a work based on the Program, or the modifications to
|
|
||||||
produce it from the Program, in the form of source code under the
|
|
||||||
terms of section 4, provided that you also meet all of these conditions:
|
|
||||||
|
|
||||||
a) The work must carry prominent notices stating that you modified
|
|
||||||
it, and giving a relevant date.
|
|
||||||
|
|
||||||
b) The work must carry prominent notices stating that it is
|
|
||||||
released under this License and any conditions added under section
|
|
||||||
7. This requirement modifies the requirement in section 4 to
|
|
||||||
"keep intact all notices".
|
|
||||||
|
|
||||||
c) You must license the entire work, as a whole, under this
|
|
||||||
License to anyone who comes into possession of a copy. This
|
|
||||||
License will therefore apply, along with any applicable section 7
|
|
||||||
additional terms, to the whole of the work, and all its parts,
|
|
||||||
regardless of how they are packaged. This License gives no
|
|
||||||
permission to license the work in any other way, but it does not
|
|
||||||
invalidate such permission if you have separately received it.
|
|
||||||
|
|
||||||
d) If the work has interactive user interfaces, each must display
|
|
||||||
Appropriate Legal Notices; however, if the Program has interactive
|
|
||||||
interfaces that do not display Appropriate Legal Notices, your
|
|
||||||
work need not make them do so.
|
|
||||||
|
|
||||||
A compilation of a covered work with other separate and independent
|
|
||||||
works, which are not by their nature extensions of the covered work,
|
|
||||||
and which are not combined with it such as to form a larger program,
|
|
||||||
in or on a volume of a storage or distribution medium, is called an
|
|
||||||
"aggregate" if the compilation and its resulting copyright are not
|
|
||||||
used to limit the access or legal rights of the compilation's users
|
|
||||||
beyond what the individual works permit. Inclusion of a covered work
|
|
||||||
in an aggregate does not cause this License to apply to the other
|
|
||||||
parts of the aggregate.
|
|
||||||
|
|
||||||
6. Conveying Non-Source Forms.
|
|
||||||
|
|
||||||
You may convey a covered work in object code form under the terms
|
|
||||||
of sections 4 and 5, provided that you also convey the
|
|
||||||
machine-readable Corresponding Source under the terms of this License,
|
|
||||||
in one of these ways:
|
|
||||||
|
|
||||||
a) Convey the object code in, or embodied in, a physical product
|
|
||||||
(including a physical distribution medium), accompanied by the
|
|
||||||
Corresponding Source fixed on a durable physical medium
|
|
||||||
customarily used for software interchange.
|
|
||||||
|
|
||||||
b) Convey the object code in, or embodied in, a physical product
|
|
||||||
(including a physical distribution medium), accompanied by a
|
|
||||||
written offer, valid for at least three years and valid for as
|
|
||||||
long as you offer spare parts or customer support for that product
|
|
||||||
model, to give anyone who possesses the object code either (1) a
|
|
||||||
copy of the Corresponding Source for all the software in the
|
|
||||||
product that is covered by this License, on a durable physical
|
|
||||||
medium customarily used for software interchange, for a price no
|
|
||||||
more than your reasonable cost of physically performing this
|
|
||||||
conveying of source, or (2) access to copy the
|
|
||||||
Corresponding Source from a network server at no charge.
|
|
||||||
|
|
||||||
c) Convey individual copies of the object code with a copy of the
|
|
||||||
written offer to provide the Corresponding Source. This
|
|
||||||
alternative is allowed only occasionally and noncommercially, and
|
|
||||||
only if you received the object code with such an offer, in accord
|
|
||||||
with subsection 6b.
|
|
||||||
|
|
||||||
d) Convey the object code by offering access from a designated
|
|
||||||
place (gratis or for a charge), and offer equivalent access to the
|
|
||||||
Corresponding Source in the same way through the same place at no
|
|
||||||
further charge. You need not require recipients to copy the
|
|
||||||
Corresponding Source along with the object code. If the place to
|
|
||||||
copy the object code is a network server, the Corresponding Source
|
|
||||||
may be on a different server (operated by you or a third party)
|
|
||||||
that supports equivalent copying facilities, provided you maintain
|
|
||||||
clear directions next to the object code saying where to find the
|
|
||||||
Corresponding Source. Regardless of what server hosts the
|
|
||||||
Corresponding Source, you remain obligated to ensure that it is
|
|
||||||
available for as long as needed to satisfy these requirements.
|
|
||||||
|
|
||||||
e) Convey the object code using peer-to-peer transmission, provided
|
|
||||||
you inform other peers where the object code and Corresponding
|
|
||||||
Source of the work are being offered to the general public at no
|
|
||||||
charge under subsection 6d.
|
|
||||||
|
|
||||||
A separable portion of the object code, whose source code is excluded
|
|
||||||
from the Corresponding Source as a System Library, need not be
|
|
||||||
included in conveying the object code work.
|
|
||||||
|
|
||||||
A "User Product" is either (1) a "consumer product", which means any
|
|
||||||
tangible personal property which is normally used for personal, family,
|
|
||||||
or household purposes, or (2) anything designed or sold for incorporation
|
|
||||||
into a dwelling. In determining whether a product is a consumer product,
|
|
||||||
doubtful cases shall be resolved in favor of coverage. For a particular
|
|
||||||
product received by a particular user, "normally used" refers to a
|
|
||||||
typical or common use of that class of product, regardless of the status
|
|
||||||
of the particular user or of the way in which the particular user
|
|
||||||
actually uses, or expects or is expected to use, the product. A product
|
|
||||||
is a consumer product regardless of whether the product has substantial
|
|
||||||
commercial, industrial or non-consumer uses, unless such uses represent
|
|
||||||
the only significant mode of use of the product.
|
|
||||||
|
|
||||||
"Installation Information" for a User Product means any methods,
|
|
||||||
procedures, authorization keys, or other information required to install
|
|
||||||
and execute modified versions of a covered work in that User Product from
|
|
||||||
a modified version of its Corresponding Source. The information must
|
|
||||||
suffice to ensure that the continued functioning of the modified object
|
|
||||||
code is in no case prevented or interfered with solely because
|
|
||||||
modification has been made.
|
|
||||||
|
|
||||||
If you convey an object code work under this section in, or with, or
|
|
||||||
specifically for use in, a User Product, and the conveying occurs as
|
|
||||||
part of a transaction in which the right of possession and use of the
|
|
||||||
User Product is transferred to the recipient in perpetuity or for a
|
|
||||||
fixed term (regardless of how the transaction is characterized), the
|
|
||||||
Corresponding Source conveyed under this section must be accompanied
|
|
||||||
by the Installation Information. But this requirement does not apply
|
|
||||||
if neither you nor any third party retains the ability to install
|
|
||||||
modified object code on the User Product (for example, the work has
|
|
||||||
been installed in ROM).
|
|
||||||
|
|
||||||
The requirement to provide Installation Information does not include a
|
|
||||||
requirement to continue to provide support service, warranty, or updates
|
|
||||||
for a work that has been modified or installed by the recipient, or for
|
|
||||||
the User Product in which it has been modified or installed. Access to a
|
|
||||||
network may be denied when the modification itself materially and
|
|
||||||
adversely affects the operation of the network or violates the rules and
|
|
||||||
protocols for communication across the network.
|
|
||||||
|
|
||||||
Corresponding Source conveyed, and Installation Information provided,
|
|
||||||
in accord with this section must be in a format that is publicly
|
|
||||||
documented (and with an implementation available to the public in
|
|
||||||
source code form), and must require no special password or key for
|
|
||||||
unpacking, reading or copying.
|
|
||||||
|
|
||||||
7. Additional Terms.
|
|
||||||
|
|
||||||
"Additional permissions" are terms that supplement the terms of this
|
|
||||||
License by making exceptions from one or more of its conditions.
|
|
||||||
Additional permissions that are applicable to the entire Program shall
|
|
||||||
be treated as though they were included in this License, to the extent
|
|
||||||
that they are valid under applicable law. If additional permissions
|
|
||||||
apply only to part of the Program, that part may be used separately
|
|
||||||
under those permissions, but the entire Program remains governed by
|
|
||||||
this License without regard to the additional permissions.
|
|
||||||
|
|
||||||
When you convey a copy of a covered work, you may at your option
|
|
||||||
remove any additional permissions from that copy, or from any part of
|
|
||||||
it. (Additional permissions may be written to require their own
|
|
||||||
removal in certain cases when you modify the work.) You may place
|
|
||||||
additional permissions on material, added by you to a covered work,
|
|
||||||
for which you have or can give appropriate copyright permission.
|
|
||||||
|
|
||||||
Notwithstanding any other provision of this License, for material you
|
|
||||||
add to a covered work, you may (if authorized by the copyright holders of
|
|
||||||
that material) supplement the terms of this License with terms:
|
|
||||||
|
|
||||||
a) Disclaiming warranty or limiting liability differently from the
|
|
||||||
terms of sections 15 and 16 of this License; or
|
|
||||||
|
|
||||||
b) Requiring preservation of specified reasonable legal notices or
|
|
||||||
author attributions in that material or in the Appropriate Legal
|
|
||||||
Notices displayed by works containing it; or
|
|
||||||
|
|
||||||
c) Prohibiting misrepresentation of the origin of that material, or
|
|
||||||
requiring that modified versions of such material be marked in
|
|
||||||
reasonable ways as different from the original version; or
|
|
||||||
|
|
||||||
d) Limiting the use for publicity purposes of names of licensors or
|
|
||||||
authors of the material; or
|
|
||||||
|
|
||||||
e) Declining to grant rights under trademark law for use of some
|
|
||||||
trade names, trademarks, or service marks; or
|
|
||||||
|
|
||||||
f) Requiring indemnification of licensors and authors of that
|
|
||||||
material by anyone who conveys the material (or modified versions of
|
|
||||||
it) with contractual assumptions of liability to the recipient, for
|
|
||||||
any liability that these contractual assumptions directly impose on
|
|
||||||
those licensors and authors.
|
|
||||||
|
|
||||||
All other non-permissive additional terms are considered "further
|
|
||||||
restrictions" within the meaning of section 10. If the Program as you
|
|
||||||
received it, or any part of it, contains a notice stating that it is
|
|
||||||
governed by this License along with a term that is a further
|
|
||||||
restriction, you may remove that term. If a license document contains
|
|
||||||
a further restriction but permits relicensing or conveying under this
|
|
||||||
License, you may add to a covered work material governed by the terms
|
|
||||||
of that license document, provided that the further restriction does
|
|
||||||
not survive such relicensing or conveying.
|
|
||||||
|
|
||||||
If you add terms to a covered work in accord with this section, you
|
|
||||||
must place, in the relevant source files, a statement of the
|
|
||||||
additional terms that apply to those files, or a notice indicating
|
|
||||||
where to find the applicable terms.
|
|
||||||
|
|
||||||
Additional terms, permissive or non-permissive, may be stated in the
|
|
||||||
form of a separately written license, or stated as exceptions;
|
|
||||||
the above requirements apply either way.
|
|
||||||
|
|
||||||
8. Termination.
|
|
||||||
|
|
||||||
You may not propagate or modify a covered work except as expressly
|
|
||||||
provided under this License. Any attempt otherwise to propagate or
|
|
||||||
modify it is void, and will automatically terminate your rights under
|
|
||||||
this License (including any patent licenses granted under the third
|
|
||||||
paragraph of section 11).
|
|
||||||
|
|
||||||
However, if you cease all violation of this License, then your
|
|
||||||
license from a particular copyright holder is reinstated (a)
|
|
||||||
provisionally, unless and until the copyright holder explicitly and
|
|
||||||
finally terminates your license, and (b) permanently, if the copyright
|
|
||||||
holder fails to notify you of the violation by some reasonable means
|
|
||||||
prior to 60 days after the cessation.
|
|
||||||
|
|
||||||
Moreover, your license from a particular copyright holder is
|
|
||||||
reinstated permanently if the copyright holder notifies you of the
|
|
||||||
violation by some reasonable means, this is the first time you have
|
|
||||||
received notice of violation of this License (for any work) from that
|
|
||||||
copyright holder, and you cure the violation prior to 30 days after
|
|
||||||
your receipt of the notice.
|
|
||||||
|
|
||||||
Termination of your rights under this section does not terminate the
|
|
||||||
licenses of parties who have received copies or rights from you under
|
|
||||||
this License. If your rights have been terminated and not permanently
|
|
||||||
reinstated, you do not qualify to receive new licenses for the same
|
|
||||||
material under section 10.
|
|
||||||
|
|
||||||
9. Acceptance Not Required for Having Copies.
|
|
||||||
|
|
||||||
You are not required to accept this License in order to receive or
|
|
||||||
run a copy of the Program. Ancillary propagation of a covered work
|
|
||||||
occurring solely as a consequence of using peer-to-peer transmission
|
|
||||||
to receive a copy likewise does not require acceptance. However,
|
|
||||||
nothing other than this License grants you permission to propagate or
|
|
||||||
modify any covered work. These actions infringe copyright if you do
|
|
||||||
not accept this License. Therefore, by modifying or propagating a
|
|
||||||
covered work, you indicate your acceptance of this License to do so.
|
|
||||||
|
|
||||||
10. Automatic Licensing of Downstream Recipients.
|
|
||||||
|
|
||||||
Each time you convey a covered work, the recipient automatically
|
|
||||||
receives a license from the original licensors, to run, modify and
|
|
||||||
propagate that work, subject to this License. You are not responsible
|
|
||||||
for enforcing compliance by third parties with this License.
|
|
||||||
|
|
||||||
An "entity transaction" is a transaction transferring control of an
|
|
||||||
organization, or substantially all assets of one, or subdividing an
|
|
||||||
organization, or merging organizations. If propagation of a covered
|
|
||||||
work results from an entity transaction, each party to that
|
|
||||||
transaction who receives a copy of the work also receives whatever
|
|
||||||
licenses to the work the party's predecessor in interest had or could
|
|
||||||
give under the previous paragraph, plus a right to possession of the
|
|
||||||
Corresponding Source of the work from the predecessor in interest, if
|
|
||||||
the predecessor has it or can get it with reasonable efforts.
|
|
||||||
|
|
||||||
You may not impose any further restrictions on the exercise of the
|
|
||||||
rights granted or affirmed under this License. For example, you may
|
|
||||||
not impose a license fee, royalty, or other charge for exercise of
|
|
||||||
rights granted under this License, and you may not initiate litigation
|
|
||||||
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
|
||||||
any patent claim is infringed by making, using, selling, offering for
|
|
||||||
sale, or importing the Program or any portion of it.
|
|
||||||
|
|
||||||
11. Patents.
|
|
||||||
|
|
||||||
A "contributor" is a copyright holder who authorizes use under this
|
|
||||||
License of the Program or a work on which the Program is based. The
|
|
||||||
work thus licensed is called the contributor's "contributor version".
|
|
||||||
|
|
||||||
A contributor's "essential patent claims" are all patent claims
|
|
||||||
owned or controlled by the contributor, whether already acquired or
|
|
||||||
hereafter acquired, that would be infringed by some manner, permitted
|
|
||||||
by this License, of making, using, or selling its contributor version,
|
|
||||||
but do not include claims that would be infringed only as a
|
|
||||||
consequence of further modification of the contributor version. For
|
|
||||||
purposes of this definition, "control" includes the right to grant
|
|
||||||
patent sublicenses in a manner consistent with the requirements of
|
|
||||||
this License.
|
|
||||||
|
|
||||||
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
|
||||||
patent license under the contributor's essential patent claims, to
|
|
||||||
make, use, sell, offer for sale, import and otherwise run, modify and
|
|
||||||
propagate the contents of its contributor version.
|
|
||||||
|
|
||||||
In the following three paragraphs, a "patent license" is any express
|
|
||||||
agreement or commitment, however denominated, not to enforce a patent
|
|
||||||
(such as an express permission to practice a patent or covenant not to
|
|
||||||
sue for patent infringement). To "grant" such a patent license to a
|
|
||||||
party means to make such an agreement or commitment not to enforce a
|
|
||||||
patent against the party.
|
|
||||||
|
|
||||||
If you convey a covered work, knowingly relying on a patent license,
|
|
||||||
and the Corresponding Source of the work is not available for anyone
|
|
||||||
to copy, free of charge and under the terms of this License, through a
|
|
||||||
publicly available network server or other readily accessible means,
|
|
||||||
then you must either (1) cause the Corresponding Source to be so
|
|
||||||
available, or (2) arrange to deprive yourself of the benefit of the
|
|
||||||
patent license for this particular work, or (3) arrange, in a manner
|
|
||||||
consistent with the requirements of this License, to extend the patent
|
|
||||||
license to downstream recipients. "Knowingly relying" means you have
|
|
||||||
actual knowledge that, but for the patent license, your conveying the
|
|
||||||
covered work in a country, or your recipient's use of the covered work
|
|
||||||
in a country, would infringe one or more identifiable patents in that
|
|
||||||
country that you have reason to believe are valid.
|
|
||||||
|
|
||||||
If, pursuant to or in connection with a single transaction or
|
|
||||||
arrangement, you convey, or propagate by procuring conveyance of, a
|
|
||||||
covered work, and grant a patent license to some of the parties
|
|
||||||
receiving the covered work authorizing them to use, propagate, modify
|
|
||||||
or convey a specific copy of the covered work, then the patent license
|
|
||||||
you grant is automatically extended to all recipients of the covered
|
|
||||||
work and works based on it.
|
|
||||||
|
|
||||||
A patent license is "discriminatory" if it does not include within
|
|
||||||
the scope of its coverage, prohibits the exercise of, or is
|
|
||||||
conditioned on the non-exercise of one or more of the rights that are
|
|
||||||
specifically granted under this License. You may not convey a covered
|
|
||||||
work if you are a party to an arrangement with a third party that is
|
|
||||||
in the business of distributing software, under which you make payment
|
|
||||||
to the third party based on the extent of your activity of conveying
|
|
||||||
the work, and under which the third party grants, to any of the
|
|
||||||
parties who would receive the covered work from you, a discriminatory
|
|
||||||
patent license (a) in connection with copies of the covered work
|
|
||||||
conveyed by you (or copies made from those copies), or (b) primarily
|
|
||||||
for and in connection with specific products or compilations that
|
|
||||||
contain the covered work, unless you entered into that arrangement,
|
|
||||||
or that patent license was granted, prior to 28 March 2007.
|
|
||||||
|
|
||||||
Nothing in this License shall be construed as excluding or limiting
|
|
||||||
any implied license or other defenses to infringement that may
|
|
||||||
otherwise be available to you under applicable patent law.
|
|
||||||
|
|
||||||
12. No Surrender of Others' Freedom.
|
|
||||||
|
|
||||||
If conditions are imposed on you (whether by court order, agreement or
|
|
||||||
otherwise) that contradict the conditions of this License, they do not
|
|
||||||
excuse you from the conditions of this License. If you cannot convey a
|
|
||||||
covered work so as to satisfy simultaneously your obligations under this
|
|
||||||
License and any other pertinent obligations, then as a consequence you may
|
|
||||||
not convey it at all. For example, if you agree to terms that obligate you
|
|
||||||
to collect a royalty for further conveying from those to whom you convey
|
|
||||||
the Program, the only way you could satisfy both those terms and this
|
|
||||||
License would be to refrain entirely from conveying the Program.
|
|
||||||
|
|
||||||
13. Use with the GNU Affero General Public License.
|
|
||||||
|
|
||||||
Notwithstanding any other provision of this License, you have
|
|
||||||
permission to link or combine any covered work with a work licensed
|
|
||||||
under version 3 of the GNU Affero General Public License into a single
|
|
||||||
combined work, and to convey the resulting work. The terms of this
|
|
||||||
License will continue to apply to the part which is the covered work,
|
|
||||||
but the special requirements of the GNU Affero General Public License,
|
|
||||||
section 13, concerning interaction through a network will apply to the
|
|
||||||
combination as such.
|
|
||||||
|
|
||||||
14. Revised Versions of this License.
|
|
||||||
|
|
||||||
The Free Software Foundation may publish revised and/or new versions of
|
|
||||||
the GNU General Public License from time to time. Such new versions will
|
|
||||||
be similar in spirit to the present version, but may differ in detail to
|
|
||||||
address new problems or concerns.
|
|
||||||
|
|
||||||
Each version is given a distinguishing version number. If the
|
|
||||||
Program specifies that a certain numbered version of the GNU General
|
|
||||||
Public License "or any later version" applies to it, you have the
|
|
||||||
option of following the terms and conditions either of that numbered
|
|
||||||
version or of any later version published by the Free Software
|
|
||||||
Foundation. If the Program does not specify a version number of the
|
|
||||||
GNU General Public License, you may choose any version ever published
|
|
||||||
by the Free Software Foundation.
|
|
||||||
|
|
||||||
If the Program specifies that a proxy can decide which future
|
|
||||||
versions of the GNU General Public License can be used, that proxy's
|
|
||||||
public statement of acceptance of a version permanently authorizes you
|
|
||||||
to choose that version for the Program.
|
|
||||||
|
|
||||||
Later license versions may give you additional or different
|
|
||||||
permissions. However, no additional obligations are imposed on any
|
|
||||||
author or copyright holder as a result of your choosing to follow a
|
|
||||||
later version.
|
|
||||||
|
|
||||||
15. Disclaimer of Warranty.
|
|
||||||
|
|
||||||
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
|
||||||
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
|
||||||
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
|
||||||
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
|
||||||
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
|
||||||
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
|
||||||
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
|
||||||
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
|
||||||
|
|
||||||
16. Limitation of Liability.
|
|
||||||
|
|
||||||
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
|
||||||
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
|
||||||
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
|
||||||
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
|
||||||
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
|
||||||
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
|
||||||
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
|
||||||
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
|
||||||
SUCH DAMAGES.
|
|
||||||
|
|
||||||
17. Interpretation of Sections 15 and 16.
|
|
||||||
|
|
||||||
If the disclaimer of warranty and limitation of liability provided
|
|
||||||
above cannot be given local legal effect according to their terms,
|
|
||||||
reviewing courts shall apply local law that most closely approximates
|
|
||||||
an absolute waiver of all civil liability in connection with the
|
|
||||||
Program, unless a warranty or assumption of liability accompanies a
|
|
||||||
copy of the Program in return for a fee.
|
|
||||||
|
|
||||||
END OF TERMS AND CONDITIONS
|
|
||||||
|
|
||||||
How to Apply These Terms to Your New Programs
|
|
||||||
|
|
||||||
If you develop a new program, and you want it to be of the greatest
|
|
||||||
possible use to the public, the best way to achieve this is to make it
|
|
||||||
free software which everyone can redistribute and change under these terms.
|
|
||||||
|
|
||||||
To do so, attach the following notices to the program. It is safest
|
|
||||||
to attach them to the start of each source file to most effectively
|
|
||||||
state the exclusion of warranty; and each file should have at least
|
|
||||||
the "copyright" line and a pointer to where the full notice is found.
|
|
||||||
|
|
||||||
<one line to give the program's name and a brief idea of what it does.>
|
|
||||||
Copyright (C) <year> <name of author>
|
|
||||||
|
|
||||||
This program is free software: you can redistribute it and/or modify
|
|
||||||
it under the terms of the GNU General Public License as published by
|
|
||||||
the Free Software Foundation, either version 3 of the License, or
|
|
||||||
(at your option) any later version.
|
|
||||||
|
|
||||||
This program 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 this program. If not, see <http://www.gnu.org/licenses/>.
|
|
||||||
|
|
||||||
Also add information on how to contact you by electronic and paper mail.
|
|
||||||
|
|
||||||
If the program does terminal interaction, make it output a short
|
|
||||||
notice like this when it starts in an interactive mode:
|
|
||||||
|
|
||||||
<program> Copyright (C) <year> <name of author>
|
|
||||||
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
|
||||||
This is free software, and you are welcome to redistribute it
|
|
||||||
under certain conditions; type `show c' for details.
|
|
||||||
|
|
||||||
The hypothetical commands `show w' and `show c' should show the appropriate
|
|
||||||
parts of the General Public License. Of course, your program's commands
|
|
||||||
might be different; for a GUI interface, you would use an "about box".
|
|
||||||
|
|
||||||
You should also get your employer (if you work as a programmer) or school,
|
|
||||||
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
|
||||||
For more information on this, and how to apply and follow the GNU GPL, see
|
|
||||||
<http://www.gnu.org/licenses/>.
|
|
||||||
|
|
||||||
The GNU General Public License does not permit incorporating your program
|
|
||||||
into proprietary programs. If your program is a subroutine library, you
|
|
||||||
may consider it more useful to permit linking proprietary applications with
|
|
||||||
the library. If this is what you want to do, use the GNU Lesser General
|
|
||||||
Public License instead of this License. But first, please read
|
|
||||||
<http://www.gnu.org/philosophy/why-not-lgpl.html>.
|
|
235
third_party/pcsx2/WinHostSys.cpp
vendored
235
third_party/pcsx2/WinHostSys.cpp
vendored
|
@ -1,235 +0,0 @@
|
||||||
// SPDX-FileCopyrightText: 2002-2024 PCSX2 Dev Team
|
|
||||||
// SPDX-License-Identifier: GPL-3.0+
|
|
||||||
|
|
||||||
#include <pcsx2/HostSys.h>
|
|
||||||
|
|
||||||
#include <mutex>
|
|
||||||
|
|
||||||
#include "align.hpp"
|
|
||||||
#include "fmt/core.h"
|
|
||||||
#include "fmt/format.h"
|
|
||||||
#include "helpers.hpp"
|
|
||||||
|
|
||||||
static DWORD ConvertToWinApi(const PageProtectionMode& mode) {
|
|
||||||
DWORD winmode = PAGE_NOACCESS;
|
|
||||||
|
|
||||||
// Windows has some really bizarre memory protection enumeration that uses bitwise
|
|
||||||
// numbering (like flags) but is in fact not a flag value. *Someone* from the early
|
|
||||||
// microsoft days wasn't a very good coder, me thinks. --air
|
|
||||||
|
|
||||||
if (mode.CanExecute()) {
|
|
||||||
winmode = mode.CanWrite() ? PAGE_EXECUTE_READWRITE : PAGE_EXECUTE_READ;
|
|
||||||
} else if (mode.CanRead()) {
|
|
||||||
winmode = mode.CanWrite() ? PAGE_READWRITE : PAGE_READONLY;
|
|
||||||
}
|
|
||||||
|
|
||||||
return winmode;
|
|
||||||
}
|
|
||||||
|
|
||||||
void* HostSys::Mmap(void* base, size_t size, const PageProtectionMode& mode) {
|
|
||||||
if (mode.IsNone()) return nullptr;
|
|
||||||
|
|
||||||
return VirtualAlloc(base, size, MEM_RESERVE | MEM_COMMIT, ConvertToWinApi(mode));
|
|
||||||
}
|
|
||||||
|
|
||||||
void HostSys::Munmap(void* base, size_t size) {
|
|
||||||
if (!base) return;
|
|
||||||
|
|
||||||
VirtualFree((void*)base, 0, MEM_RELEASE);
|
|
||||||
}
|
|
||||||
|
|
||||||
void HostSys::MemProtect(void* baseaddr, size_t size, const PageProtectionMode& mode) {
|
|
||||||
pxAssert((size & (__pagesize - 1)) == 0);
|
|
||||||
|
|
||||||
DWORD OldProtect; // enjoy my uselessness, yo!
|
|
||||||
if (!VirtualProtect(baseaddr, size, ConvertToWinApi(mode), &OldProtect)) pxFail("VirtualProtect() failed");
|
|
||||||
}
|
|
||||||
|
|
||||||
std::string HostSys::GetFileMappingName(const char* prefix) {
|
|
||||||
const unsigned pid = GetCurrentProcessId();
|
|
||||||
return fmt::format("{}_{}", prefix, pid);
|
|
||||||
}
|
|
||||||
|
|
||||||
void* HostSys::CreateSharedMemory(const char* name, size_t size) {
|
|
||||||
return static_cast<void*>(CreateFileMappingW(
|
|
||||||
INVALID_HANDLE_VALUE, NULL, PAGE_READWRITE, static_cast<DWORD>(size >> 32), static_cast<DWORD>(size),
|
|
||||||
StringUtil::UTF8StringToWideString(name).c_str()
|
|
||||||
));
|
|
||||||
}
|
|
||||||
|
|
||||||
void HostSys::DestroySharedMemory(void* ptr) { CloseHandle(static_cast<HANDLE>(ptr)); }
|
|
||||||
|
|
||||||
void* HostSys::MapSharedMemory(void* handle, size_t offset, void* baseaddr, size_t size, const PageProtectionMode& mode) {
|
|
||||||
void* ret = MapViewOfFileEx(
|
|
||||||
static_cast<HANDLE>(handle), FILE_MAP_READ | FILE_MAP_WRITE, static_cast<DWORD>(offset >> 32), static_cast<DWORD>(offset), size, baseaddr
|
|
||||||
);
|
|
||||||
if (!ret) return nullptr;
|
|
||||||
|
|
||||||
const DWORD prot = ConvertToWinApi(mode);
|
|
||||||
if (prot != PAGE_READWRITE) {
|
|
||||||
DWORD old_prot;
|
|
||||||
if (!VirtualProtect(ret, size, prot, &old_prot)) pxFail("Failed to protect memory mapping");
|
|
||||||
}
|
|
||||||
return ret;
|
|
||||||
}
|
|
||||||
|
|
||||||
void HostSys::UnmapSharedMemory(void* baseaddr, size_t size) {
|
|
||||||
if (!UnmapViewOfFile(baseaddr)) pxFail("Failed to unmap shared memory");
|
|
||||||
}
|
|
||||||
|
|
||||||
size_t HostSys::GetRuntimePageSize() {
|
|
||||||
SYSTEM_INFO si = {};
|
|
||||||
GetSystemInfo(&si);
|
|
||||||
return si.dwPageSize;
|
|
||||||
}
|
|
||||||
|
|
||||||
SharedMemoryMappingArea::SharedMemoryMappingArea(u8* base_ptr, size_t size, size_t num_pages)
|
|
||||||
: m_base_ptr(base_ptr), m_size(size), m_num_pages(num_pages) {
|
|
||||||
m_placeholder_ranges.emplace(0, size);
|
|
||||||
}
|
|
||||||
|
|
||||||
SharedMemoryMappingArea::~SharedMemoryMappingArea() {
|
|
||||||
pxAssertRel(m_num_mappings == 0, "No mappings left");
|
|
||||||
|
|
||||||
// hopefully this will be okay, and we don't need to coalesce all the placeholders...
|
|
||||||
if (!VirtualFreeEx(GetCurrentProcess(), m_base_ptr, 0, MEM_RELEASE)) pxFailRel("Failed to release shared memory area");
|
|
||||||
}
|
|
||||||
|
|
||||||
SharedMemoryMappingArea::PlaceholderMap::iterator SharedMemoryMappingArea::FindPlaceholder(size_t offset) {
|
|
||||||
if (m_placeholder_ranges.empty()) return m_placeholder_ranges.end();
|
|
||||||
|
|
||||||
// this will give us an iterator equal or after page
|
|
||||||
auto it = m_placeholder_ranges.lower_bound(offset);
|
|
||||||
if (it == m_placeholder_ranges.end()) {
|
|
||||||
// check the last page
|
|
||||||
it = (++m_placeholder_ranges.rbegin()).base();
|
|
||||||
}
|
|
||||||
|
|
||||||
// it's the one we found?
|
|
||||||
if (offset >= it->first && offset < it->second) return it;
|
|
||||||
|
|
||||||
// otherwise try the one before
|
|
||||||
if (it == m_placeholder_ranges.begin()) return m_placeholder_ranges.end();
|
|
||||||
|
|
||||||
--it;
|
|
||||||
if (offset >= it->first && offset < it->second)
|
|
||||||
return it;
|
|
||||||
else
|
|
||||||
return m_placeholder_ranges.end();
|
|
||||||
}
|
|
||||||
|
|
||||||
std::unique_ptr<SharedMemoryMappingArea> SharedMemoryMappingArea::Create(size_t size) {
|
|
||||||
pxAssertRel(Common::IsAlignedPow2(size, __pagesize), "Size is page aligned");
|
|
||||||
|
|
||||||
void* alloc = VirtualAlloc2(GetCurrentProcess(), nullptr, size, MEM_RESERVE | MEM_RESERVE_PLACEHOLDER, PAGE_NOACCESS, nullptr, 0);
|
|
||||||
if (!alloc) return nullptr;
|
|
||||||
|
|
||||||
return std::unique_ptr<SharedMemoryMappingArea>(new SharedMemoryMappingArea(static_cast<u8*>(alloc), size, size / __pagesize));
|
|
||||||
}
|
|
||||||
|
|
||||||
u8* SharedMemoryMappingArea::Map(void* file_handle, size_t file_offset, void* map_base, size_t map_size, const PageProtectionMode& mode) {
|
|
||||||
pxAssert(static_cast<u8*>(map_base) >= m_base_ptr && static_cast<u8*>(map_base) < (m_base_ptr + m_size));
|
|
||||||
|
|
||||||
const size_t map_offset = static_cast<u8*>(map_base) - m_base_ptr;
|
|
||||||
pxAssert(Common::IsAlignedPow2(map_offset, __pagesize));
|
|
||||||
pxAssert(Common::IsAlignedPow2(map_size, __pagesize));
|
|
||||||
|
|
||||||
// should be a placeholder. unless there's some other mapping we didn't free.
|
|
||||||
PlaceholderMap::iterator phit = FindPlaceholder(map_offset);
|
|
||||||
pxAssertMsg(phit != m_placeholder_ranges.end(), "Page we're mapping is a placeholder");
|
|
||||||
pxAssertMsg(map_offset >= phit->first && map_offset < phit->second, "Page is in returned placeholder range");
|
|
||||||
pxAssertMsg((map_offset + map_size) <= phit->second, "Page range is in returned placeholder range");
|
|
||||||
|
|
||||||
// do we need to split to the left? (i.e. is there a placeholder before this range)
|
|
||||||
const size_t old_ph_end = phit->second;
|
|
||||||
if (map_offset != phit->first) {
|
|
||||||
phit->second = map_offset;
|
|
||||||
|
|
||||||
// split it (i.e. left..start and start..end are now separated)
|
|
||||||
if (!VirtualFreeEx(GetCurrentProcess(), OffsetPointer(phit->first), (map_offset - phit->first), MEM_RELEASE | MEM_PRESERVE_PLACEHOLDER)) {
|
|
||||||
pxFailRel("Failed to left split placeholder for map");
|
|
||||||
}
|
|
||||||
} else {
|
|
||||||
// start of the placeholder is getting used, we'll split it right below if there's anything left over
|
|
||||||
m_placeholder_ranges.erase(phit);
|
|
||||||
}
|
|
||||||
|
|
||||||
// do we need to split to the right? (i.e. is there a placeholder after this range)
|
|
||||||
if ((map_offset + map_size) != old_ph_end) {
|
|
||||||
// split out end..ph_end
|
|
||||||
m_placeholder_ranges.emplace(map_offset + map_size, old_ph_end);
|
|
||||||
|
|
||||||
if (!VirtualFreeEx(GetCurrentProcess(), OffsetPointer(map_offset), map_size, MEM_RELEASE | MEM_PRESERVE_PLACEHOLDER)) {
|
|
||||||
pxFailRel("Failed to right split placeholder for map");
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// actually do the mapping, replacing the placeholder on the range
|
|
||||||
if (!MapViewOfFile3(
|
|
||||||
static_cast<HANDLE>(file_handle), GetCurrentProcess(), map_base, file_offset, map_size, MEM_REPLACE_PLACEHOLDER, PAGE_READWRITE, nullptr,
|
|
||||||
0
|
|
||||||
)) {
|
|
||||||
Console.Error("(SharedMemoryMappingArea) MapViewOfFile3() failed: %u", GetLastError());
|
|
||||||
return nullptr;
|
|
||||||
}
|
|
||||||
|
|
||||||
const DWORD prot = ConvertToWinApi(mode);
|
|
||||||
if (prot != PAGE_READWRITE) {
|
|
||||||
DWORD old_prot;
|
|
||||||
if (!VirtualProtect(map_base, map_size, prot, &old_prot)) pxFail("Failed to protect memory mapping");
|
|
||||||
}
|
|
||||||
|
|
||||||
m_num_mappings++;
|
|
||||||
return static_cast<u8*>(map_base);
|
|
||||||
}
|
|
||||||
|
|
||||||
bool SharedMemoryMappingArea::Unmap(void* map_base, size_t map_size) {
|
|
||||||
pxAssert(static_cast<u8*>(map_base) >= m_base_ptr && static_cast<u8*>(map_base) < (m_base_ptr + m_size));
|
|
||||||
|
|
||||||
const size_t map_offset = static_cast<u8*>(map_base) - m_base_ptr;
|
|
||||||
pxAssert(Common::IsAlignedPow2(map_offset, __pagesize));
|
|
||||||
pxAssert(Common::IsAlignedPow2(map_size, __pagesize));
|
|
||||||
|
|
||||||
// unmap the specified range
|
|
||||||
if (!UnmapViewOfFile2(GetCurrentProcess(), map_base, MEM_PRESERVE_PLACEHOLDER)) {
|
|
||||||
Console.Error("(SharedMemoryMappingArea) UnmapViewOfFile2() failed: %u", GetLastError());
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
|
|
||||||
// can we coalesce to the left?
|
|
||||||
PlaceholderMap::iterator left_it = (map_offset > 0) ? FindPlaceholder(map_offset - 1) : m_placeholder_ranges.end();
|
|
||||||
if (left_it != m_placeholder_ranges.end()) {
|
|
||||||
// the left placeholder should end at our start
|
|
||||||
pxAssert(map_offset == left_it->second);
|
|
||||||
left_it->second = map_offset + map_size;
|
|
||||||
|
|
||||||
// combine placeholders before and the range we're unmapping, i.e. to the left
|
|
||||||
if (!VirtualFreeEx(
|
|
||||||
GetCurrentProcess(), OffsetPointer(left_it->first), left_it->second - left_it->first, MEM_RELEASE | MEM_COALESCE_PLACEHOLDERS
|
|
||||||
)) {
|
|
||||||
pxFail("Failed to coalesce placeholders left for unmap");
|
|
||||||
}
|
|
||||||
} else {
|
|
||||||
// this is a new placeholder
|
|
||||||
left_it = m_placeholder_ranges.emplace(map_offset, map_offset + map_size).first;
|
|
||||||
}
|
|
||||||
|
|
||||||
// can we coalesce to the right?
|
|
||||||
PlaceholderMap::iterator right_it = ((map_offset + map_size) < m_size) ? FindPlaceholder(map_offset + map_size) : m_placeholder_ranges.end();
|
|
||||||
if (right_it != m_placeholder_ranges.end()) {
|
|
||||||
// should start at our end
|
|
||||||
pxAssert(right_it->first == (map_offset + map_size));
|
|
||||||
left_it->second = right_it->second;
|
|
||||||
m_placeholder_ranges.erase(right_it);
|
|
||||||
|
|
||||||
// combine our placeholder and the next, i.e. to the right
|
|
||||||
if (!VirtualFreeEx(
|
|
||||||
GetCurrentProcess(), OffsetPointer(left_it->first), left_it->second - left_it->first, MEM_RELEASE | MEM_COALESCE_PLACEHOLDERS
|
|
||||||
)) {
|
|
||||||
pxFail("Failed to coalescae placeholders right for unmap");
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
m_num_mappings--;
|
|
||||||
return true;
|
|
||||||
}
|
|
109
third_party/pcsx2/include/pcsx2/HostSys.h
vendored
109
third_party/pcsx2/include/pcsx2/HostSys.h
vendored
|
@ -1,109 +0,0 @@
|
||||||
// SPDX-FileCopyrightText: 2002-2024 PCSX2 Dev Team
|
|
||||||
// SPDX-License-Identifier: GPL-3.0+
|
|
||||||
|
|
||||||
#pragma once
|
|
||||||
|
|
||||||
#include <atomic>
|
|
||||||
#include <map>
|
|
||||||
#include <memory>
|
|
||||||
#include <string>
|
|
||||||
|
|
||||||
#include "helpers.hpp"
|
|
||||||
|
|
||||||
class PageProtectionMode {
|
|
||||||
protected:
|
|
||||||
bool m_read = false;
|
|
||||||
bool m_write = false;
|
|
||||||
bool m_exec = false;
|
|
||||||
|
|
||||||
public:
|
|
||||||
constexpr PageProtectionMode() = default;
|
|
||||||
|
|
||||||
constexpr PageProtectionMode& Read(bool allow = true) {
|
|
||||||
m_read = allow;
|
|
||||||
return *this;
|
|
||||||
}
|
|
||||||
|
|
||||||
constexpr PageProtectionMode& Write(bool allow = true) {
|
|
||||||
m_write = allow;
|
|
||||||
return *this;
|
|
||||||
}
|
|
||||||
|
|
||||||
constexpr PageProtectionMode& Execute(bool allow = true) {
|
|
||||||
m_exec = allow;
|
|
||||||
return *this;
|
|
||||||
}
|
|
||||||
|
|
||||||
constexpr PageProtectionMode& All(bool allow = true) {
|
|
||||||
m_read = m_write = m_exec = allow;
|
|
||||||
return *this;
|
|
||||||
}
|
|
||||||
|
|
||||||
constexpr bool CanRead() const { return m_read; }
|
|
||||||
constexpr bool CanWrite() const { return m_write; }
|
|
||||||
constexpr bool CanExecute() const { return m_exec && m_read; }
|
|
||||||
constexpr bool IsNone() const { return !m_read && !m_write; }
|
|
||||||
};
|
|
||||||
|
|
||||||
static PageProtectionMode PageAccess_None() { return PageProtectionMode(); }
|
|
||||||
static PageProtectionMode PageAccess_ReadOnly() { return PageProtectionMode().Read(); }
|
|
||||||
static PageProtectionMode PageAccess_WriteOnly() { return PageProtectionMode().Write(); }
|
|
||||||
static PageProtectionMode PageAccess_ReadWrite() { return PageAccess_ReadOnly().Write(); }
|
|
||||||
static PageProtectionMode PageAccess_ExecOnly() { return PageAccess_ReadOnly().Execute(); }
|
|
||||||
static PageProtectionMode PageAccess_Any() { return PageProtectionMode().All(); }
|
|
||||||
|
|
||||||
// --------------------------------------------------------------------------------------
|
|
||||||
// HostSys
|
|
||||||
// --------------------------------------------------------------------------------------
|
|
||||||
namespace HostSys {
|
|
||||||
// Maps a block of memory for use as a recompiled code buffer.
|
|
||||||
// Returns NULL on allocation failure.
|
|
||||||
extern void* Mmap(void* base, size_t size, const PageProtectionMode& mode);
|
|
||||||
|
|
||||||
// Unmaps a block allocated by SysMmap
|
|
||||||
extern void Munmap(void* base, size_t size);
|
|
||||||
|
|
||||||
extern void MemProtect(void* baseaddr, size_t size, const PageProtectionMode& mode);
|
|
||||||
|
|
||||||
extern std::string GetFileMappingName(const char* prefix);
|
|
||||||
extern void* CreateSharedMemory(const char* name, size_t size);
|
|
||||||
extern void DestroySharedMemory(void* ptr);
|
|
||||||
extern void* MapSharedMemory(void* handle, size_t offset, void* baseaddr, size_t size, const PageProtectionMode& mode);
|
|
||||||
extern void UnmapSharedMemory(void* baseaddr, size_t size);
|
|
||||||
|
|
||||||
/// Returns the size of pages for the current host.
|
|
||||||
size_t GetRuntimePageSize();
|
|
||||||
} // namespace HostSys
|
|
||||||
|
|
||||||
class SharedMemoryMappingArea {
|
|
||||||
public:
|
|
||||||
static std::unique_ptr<SharedMemoryMappingArea> Create(size_t size);
|
|
||||||
|
|
||||||
~SharedMemoryMappingArea();
|
|
||||||
|
|
||||||
size_t GetSize() const { return m_size; }
|
|
||||||
size_t GetNumPages() const { return m_num_pages; }
|
|
||||||
|
|
||||||
u8* BasePointer() const { return m_base_ptr; }
|
|
||||||
u8* OffsetPointer(size_t offset) const { return m_base_ptr + offset; }
|
|
||||||
u8* PagePointer(size_t page) const { return m_base_ptr + __pagesize * page; }
|
|
||||||
|
|
||||||
u8* Map(void* file_handle, size_t file_offset, void* map_base, size_t map_size, const PageProtectionMode& mode);
|
|
||||||
bool Unmap(void* map_base, size_t map_size);
|
|
||||||
|
|
||||||
private:
|
|
||||||
SharedMemoryMappingArea(u8* base_ptr, size_t size, size_t num_pages);
|
|
||||||
|
|
||||||
u8* m_base_ptr;
|
|
||||||
size_t m_size;
|
|
||||||
size_t m_num_pages;
|
|
||||||
size_t m_num_mappings = 0;
|
|
||||||
|
|
||||||
#ifdef _WIN32
|
|
||||||
using PlaceholderMap = std::map<size_t, size_t>;
|
|
||||||
|
|
||||||
PlaceholderMap::iterator FindPlaceholder(size_t page);
|
|
||||||
|
|
||||||
PlaceholderMap m_placeholder_ranges;
|
|
||||||
#endif
|
|
||||||
};
|
|
Loading…
Add table
Reference in a new issue