// SPDX-FileCopyrightText: Copyright 2024 shadPS4 Emulator Project // SPDX-License-Identifier: GPL-2.0-or-later #include #include "common/alignment.h" #include "common/arch.h" #include "common/assert.h" #include "common/config.h" #include "common/elf_info.h" #include "common/error.h" #include "core/address_space.h" #include "core/libraries/kernel/memory.h" #include "core/memory.h" #include "libraries/error_codes.h" #ifdef _WIN32 #include #else #include #include #endif #if defined(__APPLE__) && (defined(ARCH_X86_64) || defined(ARCH_ARM64)) // Reserve space for the system address space using a zerofill section. // Note: These assembly directives are x86_64-specific, but the memory layout constants // below apply to both x86_64 and ARM64 on macOS. #if defined(ARCH_X86_64) asm(".zerofill SYSTEM_MANAGED,SYSTEM_MANAGED,__SYSTEM_MANAGED,0x7FFBFC000"); asm(".zerofill SYSTEM_RESERVED,SYSTEM_RESERVED,__SYSTEM_RESERVED,0x7C0004000"); asm(".zerofill USER_AREA,USER_AREA,__USER_AREA,0x5F9000000000"); #endif #endif namespace Core { // Constants used for mapping address space. constexpr VAddr SYSTEM_MANAGED_MIN = 0x400000ULL; constexpr VAddr SYSTEM_MANAGED_MAX = 0x7FFFFBFFFULL; constexpr VAddr SYSTEM_RESERVED_MIN = 0x7FFFFC000ULL; #if defined(__APPLE__) && (defined(ARCH_X86_64) || defined(ARCH_ARM64)) // Commpage ranges from 0xFC0000000 - 0xFFFFFFFFF, so decrease the system reserved maximum. constexpr VAddr SYSTEM_RESERVED_MAX = 0xFBFFFFFFFULL; // GPU-reserved memory ranges from 0x1000000000 - 0x6FFFFFFFFF, so increase the user minimum. constexpr VAddr USER_MIN = 0x7000000000ULL; #else constexpr VAddr SYSTEM_RESERVED_MAX = 0xFFFFFFFFFULL; constexpr VAddr USER_MIN = 0x1000000000ULL; #endif #if defined(__linux__) // Linux maps the shadPS4 executable around here, so limit the user maximum constexpr VAddr USER_MAX = 0x54FFFFFFFFFFULL; #else constexpr VAddr USER_MAX = 0x5FFFFFFFFFFFULL; #endif // Constants for the sizes of the ranges in address space. static constexpr u64 SystemManagedSize = SYSTEM_MANAGED_MAX - SYSTEM_MANAGED_MIN + 1; static constexpr u64 SystemReservedSize = SYSTEM_RESERVED_MAX - SYSTEM_RESERVED_MIN + 1; static constexpr u64 UserSize = USER_MAX - USER_MIN + 1; // Required backing file size for mapping physical address space. static u64 BackingSize = ORBIS_KERNEL_TOTAL_MEM_DEV_PRO; #ifdef _WIN32 [[nodiscard]] constexpr u64 ToWindowsProt(Core::MemoryProt prot) { const bool read = True(prot & Core::MemoryProt::CpuRead) || True(prot & Core::MemoryProt::GpuRead); const bool write = True(prot & Core::MemoryProt::CpuWrite) || True(prot & Core::MemoryProt::GpuWrite); const bool execute = True(prot & Core::MemoryProt::CpuExec); if (write && !read) { // While write-only CPU mappings aren't possible, write-only GPU mappings are. LOG_WARNING(Core, "Converting write-only mapping to read-write"); } // All cases involving execute permissions have separate permissions. if (execute) { if (write) { return PAGE_EXECUTE_READWRITE; } else if (read && !write) { return PAGE_EXECUTE_READ; } else { return PAGE_EXECUTE; } } else { if (write) { return PAGE_READWRITE; } else if (read && !write) { return PAGE_READONLY; } else { return PAGE_NOACCESS; } } } struct MemoryRegion { VAddr base; size_t size; bool is_mapped; }; struct AddressSpace::Impl { Impl() : process{GetCurrentProcess()} { // Determine the system's page alignment SYSTEM_INFO sys_info{}; GetSystemInfo(&sys_info); u64 alignment = sys_info.dwAllocationGranularity; // Older Windows builds have a severe performance issue with VirtualAlloc2. // We need to get the host's Windows version, then determine if it needs a workaround. auto ntdll_handle = GetModuleHandleW(L"ntdll.dll"); ASSERT_MSG(ntdll_handle, "Failed to retrieve ntdll handle"); // Get the RtlGetVersion function s64(WINAPI * RtlGetVersion)(LPOSVERSIONINFOW); *(FARPROC*)&RtlGetVersion = GetProcAddress(ntdll_handle, "RtlGetVersion"); ASSERT_MSG(RtlGetVersion, "failed to retrieve function pointer for RtlGetVersion"); // Call RtlGetVersion RTL_OSVERSIONINFOW os_version_info{}; RtlGetVersion(&os_version_info); u64 supported_user_max = USER_MAX; // This is the build number for Windows 11 22H2 static constexpr s32 AffectedBuildNumber = 22621; // Higher PS4 firmware versions prevent higher address mappings too. s32 sdk_ver = Common::ElfInfo::Instance().CompiledSdkVer(); if (os_version_info.dwBuildNumber <= AffectedBuildNumber || sdk_ver >= Common::ElfInfo::FW_30) { supported_user_max = 0x10000000000ULL; // Only log the message if we're restricting the user max due to operating system. // Since higher compiled SDK versions also get reduced max, we don't need to log there. if (sdk_ver < Common::ElfInfo::FW_30) { LOG_WARNING( Core, "Older Windows version detected, reducing user max to {:#x} to avoid problems", supported_user_max); } } // Determine the free address ranges we can access. VAddr next_addr = SYSTEM_MANAGED_MIN; MEMORY_BASIC_INFORMATION info{}; while (next_addr <= supported_user_max) { ASSERT_MSG(VirtualQuery(reinterpret_cast(next_addr), &info, sizeof(info)), "Failed to query memory information for address {:#x}", next_addr); // Ensure logic uses values aligned to bage boundaries. next_addr = reinterpret_cast(info.BaseAddress) + info.RegionSize; next_addr = Common::AlignUp(next_addr, alignment); // Prevent size from going past supported_user_max u64 size = info.RegionSize; if (next_addr > supported_user_max) { size -= (next_addr - supported_user_max); } size = Common::AlignDown(size, alignment); // Check for free memory areas // Restrict region size to avoid overly fragmenting the virtual memory space. if (info.State == MEM_FREE && info.RegionSize > 0x1000000) { VAddr addr = Common::AlignUp(reinterpret_cast(info.BaseAddress), alignment); regions.emplace(addr, MemoryRegion{addr, size, false}); } } // Reserve all detected free regions. for (auto region : regions) { auto addr = static_cast(VirtualAlloc2( process, reinterpret_cast(region.second.base), region.second.size, MEM_RESERVE | MEM_RESERVE_PLACEHOLDER, PAGE_NOACCESS, NULL, 0)); // All marked regions should reserve fine since they're free. ASSERT_MSG(addr, "Unable to reserve virtual address space: {}", Common::GetLastErrorMsg()); } // Set these constants to ensure code relying on them works. // These do not fully encapsulate the state of the address space. system_managed_base = reinterpret_cast(regions.begin()->first); system_managed_size = SystemManagedSize - (regions.begin()->first - SYSTEM_MANAGED_MIN); system_reserved_base = reinterpret_cast(SYSTEM_RESERVED_MIN); system_reserved_size = SystemReservedSize; user_base = reinterpret_cast(USER_MIN); user_size = supported_user_max - USER_MIN - 1; // Increase BackingSize to account for config options. BackingSize += Config::getExtraDmemInMbytes() * 1_MB; // Allocate backing file that represents the total physical memory. backing_handle = CreateFileMapping2(INVALID_HANDLE_VALUE, nullptr, FILE_MAP_ALL_ACCESS, PAGE_EXECUTE_READWRITE, SEC_COMMIT, BackingSize, nullptr, nullptr, 0); ASSERT_MSG(backing_handle, "{}", Common::GetLastErrorMsg()); // Allocate a virtual memory for the backing file map as placeholder backing_base = static_cast(VirtualAlloc2(process, nullptr, BackingSize, MEM_RESERVE | MEM_RESERVE_PLACEHOLDER, PAGE_NOACCESS, nullptr, 0)); ASSERT_MSG(backing_base, "{}", Common::GetLastErrorMsg()); // Map backing placeholder. This will commit the pages void* const ret = MapViewOfFile3(backing_handle, process, backing_base, 0, BackingSize, MEM_REPLACE_PLACEHOLDER, PAGE_EXECUTE_READWRITE, nullptr, 0); ASSERT_MSG(ret == backing_base, "{}", Common::GetLastErrorMsg()); } ~Impl() { if (virtual_base) { if (!VirtualFree(virtual_base, 0, MEM_RELEASE)) { LOG_CRITICAL(Render, "Failed to free virtual memory"); } } if (backing_base) { if (!UnmapViewOfFile2(process, backing_base, MEM_PRESERVE_PLACEHOLDER)) { LOG_CRITICAL(Render, "Failed to unmap backing memory placeholder"); } if (!VirtualFreeEx(process, backing_base, 0, MEM_RELEASE)) { LOG_CRITICAL(Render, "Failed to free backing memory"); } } if (!CloseHandle(backing_handle)) { LOG_CRITICAL(Render, "Failed to free backing memory file handle"); } } void* Map(VAddr virtual_addr, PAddr phys_addr, size_t size, ULONG prot, uintptr_t fd = 0) { // Before mapping we must carve a placeholder with the exact properties of our mapping. auto* region = EnsureSplitRegionForMapping(virtual_addr, size); region->is_mapped = true; void* ptr = nullptr; if (phys_addr != -1) { HANDLE backing = fd ? reinterpret_cast(fd) : backing_handle; if (fd && prot == PAGE_READONLY) { DWORD resultvar; ptr = VirtualAlloc2(process, reinterpret_cast(virtual_addr), size, MEM_RESERVE | MEM_COMMIT | MEM_REPLACE_PLACEHOLDER, PAGE_READWRITE, nullptr, 0); bool ret = ReadFile(backing, ptr, size, &resultvar, NULL); ASSERT_MSG(ret, "ReadFile failed. {}", Common::GetLastErrorMsg()); ret = VirtualProtect(ptr, size, prot, &resultvar); ASSERT_MSG(ret, "VirtualProtect failed. {}", Common::GetLastErrorMsg()); } else { ptr = MapViewOfFile3(backing, process, reinterpret_cast(virtual_addr), phys_addr, size, MEM_REPLACE_PLACEHOLDER, PAGE_EXECUTE_READWRITE, nullptr, 0); ASSERT_MSG(ptr, "MapViewOfFile3 failed. {}", Common::GetLastErrorMsg()); DWORD resultvar; bool ret = VirtualProtect(ptr, size, prot, &resultvar); ASSERT_MSG(ret, "VirtualProtect failed. {}", Common::GetLastErrorMsg()); } } else { ptr = VirtualAlloc2(process, reinterpret_cast(virtual_addr), size, MEM_RESERVE | MEM_COMMIT | MEM_REPLACE_PLACEHOLDER, prot, nullptr, 0); } ASSERT_MSG(ptr, "{}", Common::GetLastErrorMsg()); return ptr; } void Unmap(VAddr virtual_addr, size_t size, bool has_backing) { bool ret; if (has_backing) { ret = UnmapViewOfFile2(process, reinterpret_cast(virtual_addr), MEM_PRESERVE_PLACEHOLDER); } else { ret = VirtualFreeEx(process, reinterpret_cast(virtual_addr), size, MEM_RELEASE | MEM_PRESERVE_PLACEHOLDER); } ASSERT_MSG(ret, "Unmap operation on virtual_addr={:#X} failed: {}", virtual_addr, Common::GetLastErrorMsg()); // The unmap call will create a new placeholder region. We need to see if we can coalesce it // with neighbors. JoinRegionsAfterUnmap(virtual_addr, size); } // The following code is inspired from Dolphin's MemArena // https://github.com/dolphin-emu/dolphin/blob/deee3ee4/Source/Core/Common/MemArenaWin.cpp#L212 MemoryRegion* EnsureSplitRegionForMapping(VAddr address, size_t size) { // Find closest region that is <= the given address by using upper bound and decrementing auto it = regions.upper_bound(address); ASSERT_MSG(it != regions.begin(), "Invalid address {:#x}", address); --it; ASSERT_MSG(!it->second.is_mapped, "Attempt to map {:#x} with size {:#x} which overlaps with {:#x} mapping", address, size, it->second.base); auto& [base, region] = *it; const VAddr mapping_address = region.base; const size_t region_size = region.size; if (mapping_address == address) { // If this region is already split up correctly we don't have to do anything if (region_size == size) { return ®ion; } ASSERT_MSG(region_size >= size, "Region with address {:#x} and size {:#x} can't fit {:#x}", mapping_address, region_size, size); // Split the placeholder. if (!VirtualFreeEx(process, LPVOID(address), size, MEM_RELEASE | MEM_PRESERVE_PLACEHOLDER)) { UNREACHABLE_MSG("Region splitting failed: {}", Common::GetLastErrorMsg()); return nullptr; } // Update tracked mappings and return the first of the two region.size = size; const VAddr new_mapping_start = address + size; regions.emplace_hint(std::next(it), new_mapping_start, MemoryRegion(new_mapping_start, region_size - size, false)); return ®ion; } ASSERT(mapping_address < address); // Is there enough space to map this? const size_t offset_in_region = address - mapping_address; const size_t minimum_size = size + offset_in_region; ASSERT(region_size >= minimum_size); // Split the placeholder. if (!VirtualFreeEx(process, LPVOID(address), size, MEM_RELEASE | MEM_PRESERVE_PLACEHOLDER)) { UNREACHABLE_MSG("Region splitting failed: {}", Common::GetLastErrorMsg()); return nullptr; } // Do we now have two regions or three regions? if (region_size == minimum_size) { // Split into two; update tracked mappings and return the second one region.size = offset_in_region; it = regions.emplace_hint(std::next(it), address, MemoryRegion(address, size, false)); return &it->second; } else { // Split into three; update tracked mappings and return the middle one region.size = offset_in_region; const VAddr middle_mapping_start = address; const size_t middle_mapping_size = size; const VAddr after_mapping_start = address + size; const size_t after_mapping_size = region_size - minimum_size; it = regions.emplace_hint(std::next(it), after_mapping_start, MemoryRegion(after_mapping_start, after_mapping_size, false)); it = regions.emplace_hint( it, middle_mapping_start, MemoryRegion(middle_mapping_start, middle_mapping_size, false)); return &it->second; } } void JoinRegionsAfterUnmap(VAddr address, size_t size) { // There should be a mapping that matches the request exactly, find it auto it = regions.find(address); ASSERT_MSG(it != regions.end() && it->second.size == size, "Invalid address/size given to unmap."); auto& [base, region] = *it; region.is_mapped = false; // Check if a placeholder exists right before us. auto it_prev = it != regions.begin() ? std::prev(it) : regions.end(); if (it_prev != regions.end() && !it_prev->second.is_mapped) { const size_t total_size = it_prev->second.size + size; if (!VirtualFreeEx(process, LPVOID(it_prev->first), total_size, MEM_RELEASE | MEM_COALESCE_PLACEHOLDERS)) { UNREACHABLE_MSG("Region coalescing failed: {}", Common::GetLastErrorMsg()); } it_prev->second.size = total_size; regions.erase(it); it = it_prev; } // Check if a placeholder exists right after us. auto it_next = std::next(it); if (it_next != regions.end() && !it_next->second.is_mapped) { const size_t total_size = it->second.size + it_next->second.size; if (!VirtualFreeEx(process, LPVOID(it->first), total_size, MEM_RELEASE | MEM_COALESCE_PLACEHOLDERS)) { UNREACHABLE_MSG("Region coalescing failed: {}", Common::GetLastErrorMsg()); } it->second.size = total_size; regions.erase(it_next); } } void Protect(VAddr virtual_addr, size_t size, bool read, bool write, bool execute) { DWORD new_flags{}; if (write && !read) { // While write-only CPU protection isn't possible, write-only GPU protection is. LOG_WARNING(Core, "Converting write-only protection to read-write"); } // All cases involving execute permissions have separate permissions. if (execute) { // If there's some form of write protection requested, provide read-write permissions. if (write) { new_flags = PAGE_EXECUTE_READWRITE; } else if (read && !write) { new_flags = PAGE_EXECUTE_READ; } else { new_flags = PAGE_EXECUTE; } } else { if (write) { new_flags = PAGE_READWRITE; } else if (read && !write) { new_flags = PAGE_READONLY; } else { new_flags = PAGE_NOACCESS; } } // If no flags are assigned, then something's gone wrong. if (new_flags == 0) { LOG_CRITICAL(Common_Memory, "Unsupported protection flag combination for address {:#x}, size {}, " "read={}, write={}, execute={}", virtual_addr, size, read, write, execute); return; } const VAddr virtual_end = virtual_addr + size; auto it = --regions.upper_bound(virtual_addr); for (; it->first < virtual_end; it++) { if (!it->second.is_mapped) { continue; } const auto& region = it->second; const size_t range_addr = std::max(region.base, virtual_addr); const size_t range_size = std::min(region.base + region.size, virtual_end) - range_addr; DWORD old_flags{}; if (!VirtualProtectEx(process, LPVOID(range_addr), range_size, new_flags, &old_flags)) { UNREACHABLE_MSG( "Failed to change virtual memory protection for address {:#x}, size {:#x}", range_addr, range_size); } } } boost::icl::interval_set GetUsableRegions() { boost::icl::interval_set reserved_regions; for (auto region : regions) { reserved_regions.insert({region.second.base, region.second.base + region.second.size}); } return reserved_regions; } HANDLE process{}; HANDLE backing_handle{}; u8* backing_base{}; u8* virtual_base{}; u8* system_managed_base{}; size_t system_managed_size{}; u8* system_reserved_base{}; size_t system_reserved_size{}; u8* user_base{}; size_t user_size{}; std::map regions; }; #else enum PosixPageProtection { PAGE_NOACCESS = 0, PAGE_READONLY = PROT_READ, PAGE_READWRITE = PROT_READ | PROT_WRITE, PAGE_EXECUTE = PROT_EXEC, PAGE_EXECUTE_READ = PROT_EXEC | PROT_READ, PAGE_EXECUTE_READWRITE = PROT_EXEC | PROT_READ | PROT_WRITE }; [[nodiscard]] constexpr PosixPageProtection ToPosixProt(Core::MemoryProt prot) { const bool read = True(prot & Core::MemoryProt::CpuRead) || True(prot & Core::MemoryProt::GpuRead); const bool write = True(prot & Core::MemoryProt::CpuWrite) || True(prot & Core::MemoryProt::GpuWrite); const bool execute = True(prot & Core::MemoryProt::CpuExec); if (write && !read) { // While write-only CPU mappings aren't possible, write-only GPU mappings are. LOG_WARNING(Core, "Converting write-only mapping to read-write"); } // All cases involving execute permissions have separate permissions. if (execute) { if (write) { return PAGE_EXECUTE_READWRITE; } else if (read && !write) { return PAGE_EXECUTE_READ; } else { return PAGE_EXECUTE; } } else { if (write) { return PAGE_READWRITE; } else if (read && !write) { return PAGE_READONLY; } else { return PAGE_NOACCESS; } } } struct AddressSpace::Impl { Impl() { BackingSize += Config::getExtraDmemInMbytes() * 1_MB; // Allocate virtual address placeholder for our address space. system_managed_size = SystemManagedSize; system_reserved_size = SystemReservedSize; user_size = UserSize; constexpr int protection_flags = PROT_READ | PROT_WRITE; #if defined(__APPLE__) && (defined(ARCH_X86_64) || defined(ARCH_ARM64)) // On macOS (both x86_64 and ARM64), we run into limitations due to the commpage from // 0xFC0000000 - 0xFFFFFFFFF and the GPU carveout region from 0x1000000000 - 0x6FFFFFFFFF. // Because this creates gaps in the available virtual memory region, we map memory space // using three distinct parts. #if defined(ARCH_X86_64) constexpr int map_flags = MAP_PRIVATE | MAP_ANONYMOUS | MAP_NORESERVE | MAP_FIXED; system_managed_base = reinterpret_cast(mmap(reinterpret_cast(SYSTEM_MANAGED_MIN), system_managed_size, protection_flags, map_flags, -1, 0)); system_reserved_base = reinterpret_cast(mmap(reinterpret_cast(SYSTEM_RESERVED_MIN), system_reserved_size, protection_flags, map_flags, -1, 0)); user_base = reinterpret_cast( mmap(reinterpret_cast(USER_MIN), user_size, protection_flags, map_flags, -1, 0)); #elif defined(ARCH_ARM64) // On ARM64 macOS, MAP_FIXED doesn't work at low addresses (0x400000) due to system // restrictions. Map memory wherever possible and use offset calculations. This is a // temporary solution until proper address translation is implemented for ARM64. Note: This // means the PS4 virtual addresses won't match host addresses, so instruction // translation/JIT will need to handle the offset. constexpr int map_flags = MAP_PRIVATE | MAP_ANONYMOUS | MAP_NORESERVE; // Map the three regions separately, but let the system choose addresses system_managed_base = reinterpret_cast( mmap(nullptr, system_managed_size, protection_flags, map_flags, -1, 0)); if (system_managed_base == MAP_FAILED) { LOG_CRITICAL(Kernel_Vmm, "mmap failed for system_managed_base: {}", strerror(errno)); throw std::bad_alloc{}; } system_reserved_base = reinterpret_cast( mmap(nullptr, system_reserved_size, protection_flags, map_flags, -1, 0)); if (system_reserved_base == MAP_FAILED) { LOG_CRITICAL(Kernel_Vmm, "mmap failed for system_reserved_base: {}", strerror(errno)); throw std::bad_alloc{}; } user_base = reinterpret_cast(mmap(nullptr, user_size, protection_flags, map_flags, -1, 0)); if (user_base == MAP_FAILED) { LOG_CRITICAL(Kernel_Vmm, "mmap failed for user_base: {}", strerror(errno)); throw std::bad_alloc{}; } LOG_WARNING( Kernel_Vmm, "ARM64 macOS: Using flexible memory layout. " "PS4 addresses will be offset from host addresses. " "system_managed: {} (expected {}), system_reserved: {} (expected {}), user: {} " "(expected {})", fmt::ptr(system_managed_base), fmt::ptr(reinterpret_cast(SYSTEM_MANAGED_MIN)), fmt::ptr(system_reserved_base), fmt::ptr(reinterpret_cast(SYSTEM_RESERVED_MIN)), fmt::ptr(user_base), fmt::ptr(reinterpret_cast(USER_MIN))); #endif #else const auto virtual_size = system_managed_size + system_reserved_size + user_size; #if defined(ARCH_X86_64) const auto virtual_base = reinterpret_cast(mmap(reinterpret_cast(SYSTEM_MANAGED_MIN), virtual_size, protection_flags, map_flags, -1, 0)); system_managed_base = virtual_base; system_reserved_base = reinterpret_cast(SYSTEM_RESERVED_MIN); user_base = reinterpret_cast(USER_MIN); #else // Map memory wherever possible and instruction translation can handle offsetting to the // base. const auto virtual_base = reinterpret_cast(mmap(nullptr, virtual_size, protection_flags, map_flags, -1, 0)); system_managed_base = virtual_base; system_reserved_base = virtual_base + SYSTEM_RESERVED_MIN - SYSTEM_MANAGED_MIN; user_base = virtual_base + USER_MIN - SYSTEM_MANAGED_MIN; #endif #endif if (system_managed_base == MAP_FAILED || system_reserved_base == MAP_FAILED || user_base == MAP_FAILED) { LOG_CRITICAL(Kernel_Vmm, "mmap failed: {}", strerror(errno)); throw std::bad_alloc{}; } LOG_INFO(Kernel_Vmm, "System managed virtual memory region: {} - {}", fmt::ptr(system_managed_base), fmt::ptr(system_managed_base + system_managed_size - 1)); LOG_INFO(Kernel_Vmm, "System reserved virtual memory region: {} - {}", fmt::ptr(system_reserved_base), fmt::ptr(system_reserved_base + system_reserved_size - 1)); LOG_INFO(Kernel_Vmm, "User virtual memory region: {} - {}", fmt::ptr(user_base), fmt::ptr(user_base + user_size - 1)); const VAddr system_managed_addr = reinterpret_cast(system_managed_base); const VAddr system_reserved_addr = reinterpret_cast(system_reserved_base); const VAddr user_addr = reinterpret_cast(user_base); m_free_regions.insert({system_managed_addr, system_managed_addr + system_managed_size}); m_free_regions.insert({system_reserved_addr, system_reserved_addr + system_reserved_size}); m_free_regions.insert({user_addr, user_addr + user_size}); #ifdef __APPLE__ const auto shm_path = fmt::format("/BackingDmem{}", getpid()); backing_fd = shm_open(shm_path.c_str(), O_RDWR | O_CREAT | O_EXCL, 0600); if (backing_fd < 0) { LOG_CRITICAL(Kernel_Vmm, "shm_open failed: {}", strerror(errno)); throw std::bad_alloc{}; } shm_unlink(shm_path.c_str()); #else madvise(virtual_base, virtual_size, MADV_HUGEPAGE); backing_fd = memfd_create("BackingDmem", 0); if (backing_fd < 0) { LOG_CRITICAL(Kernel_Vmm, "memfd_create failed: {}", strerror(errno)); throw std::bad_alloc{}; } #endif // Defined to extend the file with zeros int ret = ftruncate(backing_fd, BackingSize); if (ret != 0) { LOG_CRITICAL(Kernel_Vmm, "ftruncate failed with {}, are you out-of-memory?", strerror(errno)); throw std::bad_alloc{}; } // Map backing dmem handle. backing_base = static_cast( mmap(nullptr, BackingSize, PROT_READ | PROT_WRITE, MAP_SHARED, backing_fd, 0)); if (backing_base == MAP_FAILED) { LOG_CRITICAL(Kernel_Vmm, "mmap failed: {}", strerror(errno)); throw std::bad_alloc{}; } } void* Map(VAddr virtual_addr, PAddr phys_addr, size_t size, PosixPageProtection prot, int fd = -1) { m_free_regions.subtract({virtual_addr, virtual_addr + size}); const int handle = phys_addr != -1 ? (fd == -1 ? backing_fd : fd) : -1; const off_t host_offset = phys_addr != -1 ? phys_addr : 0; const int flag = phys_addr != -1 ? MAP_SHARED : (MAP_ANONYMOUS | MAP_PRIVATE); #if defined(__APPLE__) && defined(ARCH_ARM64) // On ARM64 macOS, translate PS4 virtual addresses to host addresses void* host_addr = nullptr; if (virtual_addr >= SYSTEM_MANAGED_MIN && virtual_addr <= SYSTEM_MANAGED_MAX) { // System managed region u64 offset = virtual_addr - SYSTEM_MANAGED_MIN; host_addr = system_managed_base + offset; } else if (virtual_addr >= SYSTEM_RESERVED_MIN && virtual_addr <= SYSTEM_RESERVED_MAX) { // System reserved region u64 offset = virtual_addr - SYSTEM_RESERVED_MIN; host_addr = system_reserved_base + offset; } else if (virtual_addr >= USER_MIN && virtual_addr <= USER_MAX) { // User region u64 offset = virtual_addr - USER_MIN; host_addr = user_base + offset; } else { LOG_CRITICAL(Kernel_Vmm, "Invalid virtual address for mapping: {:#x}", virtual_addr); return MAP_FAILED; } void* ret = mmap(host_addr, size, prot, MAP_FIXED | flag, handle, host_offset); #else void* ret = mmap(reinterpret_cast(virtual_addr), size, prot, MAP_FIXED | flag, handle, host_offset); #endif ASSERT_MSG(ret != MAP_FAILED, "mmap failed: {}", strerror(errno)); return ret; } void Unmap(VAddr virtual_addr, size_t size, bool) { // Check to see if we are adjacent to any regions. auto start_address = virtual_addr; auto end_address = start_address + size; auto it = m_free_regions.find({start_address - 1, end_address + 1}); // If we are, join with them, ensuring we stay in bounds. if (it != m_free_regions.end()) { start_address = std::min(start_address, it->lower()); end_address = std::max(end_address, it->upper()); } // Free the relevant region. m_free_regions.insert({start_address, end_address}); #if defined(__APPLE__) && defined(ARCH_ARM64) // On ARM64 macOS, translate PS4 virtual addresses to host addresses void* host_addr = nullptr; if (start_address >= SYSTEM_MANAGED_MIN && start_address <= SYSTEM_MANAGED_MAX) { u64 offset = start_address - SYSTEM_MANAGED_MIN; host_addr = system_managed_base + offset; } else if (start_address >= SYSTEM_RESERVED_MIN && start_address <= SYSTEM_RESERVED_MAX) { u64 offset = start_address - SYSTEM_RESERVED_MIN; host_addr = system_reserved_base + offset; } else if (start_address >= USER_MIN && start_address <= USER_MAX) { u64 offset = start_address - USER_MIN; host_addr = user_base + offset; } else { LOG_CRITICAL(Kernel_Vmm, "Invalid virtual address for unmapping: {:#x}", start_address); return; } void* ret = mmap(host_addr, end_address - start_address, PROT_NONE, MAP_PRIVATE | MAP_ANONYMOUS | MAP_FIXED, -1, 0); #else // Return the adjusted pointers. void* ret = mmap(reinterpret_cast(start_address), end_address - start_address, PROT_NONE, MAP_PRIVATE | MAP_ANONYMOUS | MAP_FIXED, -1, 0); #endif ASSERT_MSG(ret != MAP_FAILED, "mmap failed: {}", strerror(errno)); } void Protect(VAddr virtual_addr, size_t size, bool read, bool write, bool execute) { int flags = PROT_NONE; if (read) { flags |= PROT_READ; } if (write) { flags |= PROT_WRITE; } #ifdef ARCH_X86_64 if (execute) { flags |= PROT_EXEC; } #endif #if defined(__APPLE__) && defined(ARCH_ARM64) // On ARM64 macOS, translate PS4 virtual addresses to host addresses void* host_addr = nullptr; if (virtual_addr >= SYSTEM_MANAGED_MIN && virtual_addr <= SYSTEM_MANAGED_MAX) { u64 offset = virtual_addr - SYSTEM_MANAGED_MIN; host_addr = system_managed_base + offset; } else if (virtual_addr >= SYSTEM_RESERVED_MIN && virtual_addr <= SYSTEM_RESERVED_MAX) { u64 offset = virtual_addr - SYSTEM_RESERVED_MIN; host_addr = system_reserved_base + offset; } else if (virtual_addr >= USER_MIN && virtual_addr <= USER_MAX) { u64 offset = virtual_addr - USER_MIN; host_addr = user_base + offset; } else { LOG_CRITICAL(Kernel_Vmm, "Invalid virtual address for protection: {:#x}", virtual_addr); return; } int ret = mprotect(host_addr, size, flags); #else int ret = mprotect(reinterpret_cast(virtual_addr), size, flags); #endif ASSERT_MSG(ret == 0, "mprotect failed: {}", strerror(errno)); } int backing_fd; u8* backing_base{}; u8* system_managed_base{}; size_t system_managed_size{}; u8* system_reserved_base{}; size_t system_reserved_size{}; u8* user_base{}; size_t user_size{}; boost::icl::interval_set m_free_regions; }; #endif AddressSpace::AddressSpace() : impl{std::make_unique()} { backing_base = impl->backing_base; system_managed_base = impl->system_managed_base; system_managed_size = impl->system_managed_size; system_reserved_base = impl->system_reserved_base; system_reserved_size = impl->system_reserved_size; user_base = impl->user_base; user_size = impl->user_size; } AddressSpace::~AddressSpace() = default; void* AddressSpace::Map(VAddr virtual_addr, size_t size, u64 alignment, PAddr phys_addr, bool is_exec) { #if ARCH_X86_64 const auto prot = is_exec ? PAGE_EXECUTE_READWRITE : PAGE_READWRITE; #else // On non-native architectures, we can simplify things by ignoring the execute flag for the // canonical copy of the memory and rely on the JIT to map translated code as executable. constexpr auto prot = PAGE_READWRITE; #endif return impl->Map(virtual_addr, phys_addr, size, prot); } void* AddressSpace::MapFile(VAddr virtual_addr, size_t size, size_t offset, u32 prot, uintptr_t fd) { #ifdef _WIN32 return impl->Map(virtual_addr, offset, size, ToWindowsProt(std::bit_cast(prot)), fd); #else return impl->Map(virtual_addr, offset, size, ToPosixProt(std::bit_cast(prot)), fd); #endif } void AddressSpace::Unmap(VAddr virtual_addr, size_t size, VAddr start_in_vma, VAddr end_in_vma, PAddr phys_base, bool is_exec, bool has_backing, bool readonly_file) { #ifdef _WIN32 // There does not appear to be comparable support for partial unmapping on Windows. // Unfortunately, a least one title was found to require this. The workaround is to unmap // the entire allocation and remap the portions outside of the requested unmapping range. impl->Unmap(virtual_addr, size, has_backing && !readonly_file); // TODO: Determine if any titles require partial unmapping support for un-backed allocations. ASSERT_MSG(has_backing || (start_in_vma == 0 && end_in_vma == size), "Partial unmapping of un-backed allocations is not supported"); if (start_in_vma != 0) { Map(virtual_addr, start_in_vma, 0, phys_base, is_exec); } if (end_in_vma != size) { Map(virtual_addr + end_in_vma, size - end_in_vma, 0, phys_base + end_in_vma, is_exec); } #else impl->Unmap(virtual_addr + start_in_vma, end_in_vma - start_in_vma, has_backing); #endif } void AddressSpace::Protect(VAddr virtual_addr, size_t size, MemoryPermission perms) { const bool read = True(perms & MemoryPermission::Read); const bool write = True(perms & MemoryPermission::Write); const bool execute = True(perms & MemoryPermission::Execute); return impl->Protect(virtual_addr, size, read, write, execute); } boost::icl::interval_set AddressSpace::GetUsableRegions() { #ifdef _WIN32 // On Windows, we need to obtain the accessible intervals from the implementation's regions. return impl->GetUsableRegions(); #else // On Linux and Mac, the memory space is fully represented by the three major regions boost::icl::interval_set reserved_regions; VAddr system_managed_addr = reinterpret_cast(system_managed_base); VAddr system_reserved_addr = reinterpret_cast(system_reserved_base); VAddr user_addr = reinterpret_cast(user_base); reserved_regions.insert({system_managed_addr, system_managed_addr + system_managed_size}); reserved_regions.insert({system_reserved_addr, system_reserved_addr + system_reserved_size}); reserved_regions.insert({user_addr, user_addr + user_size}); return reserved_regions; #endif } void* AddressSpace::TranslateAddress(VAddr ps4_addr) const { #ifdef ARCH_X86_64 // On x86_64, PS4 addresses are directly mapped, so we can cast them return reinterpret_cast(ps4_addr); #elif defined(ARCH_ARM64) && defined(__APPLE__) // On ARM64 macOS, translate PS4 virtual addresses to host addresses if (ps4_addr >= SYSTEM_MANAGED_MIN && ps4_addr <= SYSTEM_MANAGED_MAX) { u64 offset = ps4_addr - SYSTEM_MANAGED_MIN; return system_managed_base + offset; } else if (ps4_addr >= SYSTEM_RESERVED_MIN && ps4_addr <= SYSTEM_RESERVED_MAX) { u64 offset = ps4_addr - SYSTEM_RESERVED_MIN; return system_reserved_base + offset; } else if (ps4_addr >= USER_MIN && ps4_addr <= USER_MAX) { u64 offset = ps4_addr - USER_MIN; return user_base + offset; } return nullptr; #else // Generic ARM64 or other platforms return reinterpret_cast(ps4_addr); #endif } } // namespace Core