// SPDX-FileCopyrightText: Copyright 2026 Eden Emulator Project // SPDX-License-Identifier: GPL-3.0-or-later // SPDX-FileCopyrightText: Copyright 2018 yuzu Emulator Project // SPDX-License-Identifier: GPL-2.0-or-later #include #include #include #include #include #include #include #include #include "common/logging.h" #include "common/random.h" #include "common/settings.h" #include "core/core.h" #include "core/file_sys/content_archive.h" #include "core/file_sys/control_metadata.h" #include "core/file_sys/patch_manager.h" #include "core/file_sys/romfs.h" #include "core/file_sys/romfs_factory.h" #include "core/hle/kernel/k_page_table.h" #include "core/hle/kernel/k_process.h" #include "core/hle/service/filesystem/filesystem.h" #include "core/loader/deconstructed_rom_directory.h" #include "core/loader/nso.h" #ifdef HAS_NCE #include "core/arm/nce/patcher.h" #endif #ifndef HAS_NCE namespace Core::NCE { class Patcher {}; } // namespace Core::NCE #endif namespace Loader { struct PatchCollection { explicit PatchCollection(bool is_application_) : is_application{is_application_} { module_patcher_indices.fill(-1); patchers.emplace_back(); } std::vector* GetPatchers() { if (is_application && Settings::IsNceEnabled()) { return &patchers; } return nullptr; } size_t GetTotalPatchSize() const { size_t total_size{}; #ifdef HAS_NCE for (auto& patcher : patchers) { total_size += patcher.GetSectionSize(); } #endif return total_size; } void SaveIndex(size_t module) { module_patcher_indices[module] = static_cast(patchers.size() - 1); } s32 GetIndex(size_t module) const { return module_patcher_indices[module]; } s32 GetLastIndex() const { return static_cast(patchers.size()) - 1; } bool is_application; std::vector patchers; std::array module_patcher_indices{}; }; namespace { FileSys::VirtualDir FindLooseRomFSDirectory(const FileSys::VirtualDir& parent) { if (parent == nullptr) { return nullptr; } if (const auto dir = parent->GetSubdirectory("romfs")) { return dir; } for (const auto& dir : parent->GetSubdirectories()) { const auto name = dir->GetName(); if (name.size() == 5 && std::equal(name.begin(), name.end(), "romfs", [](char a, char b) { return std::tolower(static_cast(a)) == b; })) { return dir; } } return nullptr; } // RomFS for a loose ExeFS: the first .romfs file next to main, else a romfs/ directory next to // the exefs/ directory (the usual layout of an extracted title). FileSys::VirtualFile FindLooseRomFS(const FileSys::VirtualDir& exefs_dir) { if (exefs_dir == nullptr) { return nullptr; } for (const auto& f : exefs_dir->GetFiles()) { if (f->GetExtension() == "romfs") { return f; } } if (const auto parent = exefs_dir->GetParentDirectory()) { if (const auto romfs_dir = FindLooseRomFSDirectory(parent)) { // Building it walks every file and keeps an object for each (title 1: 206k files, ~150 // MiB), so loaders of the same directory share one build while any of them holds it. static std::mutex cache_mutex; static std::map> cache; std::scoped_lock lk{cache_mutex}; auto& cached = cache[romfs_dir->GetFullPath()]; if (auto built = cached.lock()) { return built; } LOG_INFO(Loader, "Using RomFS directory next to the ExeFS"); const auto started = std::chrono::steady_clock::now(); auto built = FileSys::CreateRomFS(romfs_dir); LOG_INFO(Loader, "Loose RomFS image ready: elapsed_ms={}", std::chrono::duration_cast( std::chrono::steady_clock::now() - started) .count()); cached = built; return built; } } return nullptr; } // The newest three-digit tag in a directory's file names of the form NNN.. std::string NewestProductTag(const FileSys::VirtualDir& dir, std::string_view prefix) { std::string best; if (dir == nullptr) { return best; } for (const auto& file : dir->GetFiles()) { const std::string file_name = file->GetName(); if (!file_name.starts_with(prefix) || file_name.size() < prefix.size() + 4) { continue; } const std::string_view digits = std::string_view{file_name}.substr(prefix.size(), 3); if (file_name[prefix.size() + 3] != '.' || !std::all_of(digits.begin(), digits.end(), [](char c) { return c >= '0' && c <= '9'; })) { continue; } if (std::string version{digits}; version > best) { best = version; } } return best; } // The display version of a dump without control data, from its RomFS: Nintendo EPD titles name // their resource size tables after it (System/Resource/ResourceSizeTable.Product.180.* in Mario // Kart World 1.8.0), and some name their game data list instead (GameData/GameDataList.Product.320.* // in Donkey Kong Bananza 3.2.0). A hotfix can keep its minor version's tables (Product.110 in a // 1.1.1). std::string RomFSProductVersion(const FileSys::VirtualDir& romfs_dir) { if (romfs_dir == nullptr) { return {}; } const auto system_dir = romfs_dir->GetSubdirectory("System"); std::string best = NewestProductTag( system_dir != nullptr ? system_dir->GetSubdirectory("Resource") : nullptr, "ResourceSizeTable.Product."); if (const auto game_data = NewestProductTag(romfs_dir->GetSubdirectory("GameData"), "GameDataList.Product."); game_data > best) { best = game_data; } if (best.empty()) { return {}; } return fmt::format("{}.{}.{}", best[0], best[1], best[2]); } // Loose ExeFS dumps carry no control data, but icon/nacp sidecars can be dropped next to the // ExeFS or in the game folder above it (/exefs/main, /base/exefs/main and // /updates//exefs/main layouts). std::vector<FileSys::VirtualDir> FindSidecarDirs(const FileSys::VirtualDir& exefs_dir) { const auto equals_ignore_case = [](const std::string& a, std::string_view b) { return a.size() == b.size() && std::equal(a.begin(), a.end(), b.begin(), [](char x, char y) { return std::tolower(static_cast<unsigned char>(x)) == std::tolower(static_cast<unsigned char>(y)); }); }; std::vector<FileSys::VirtualDir> dirs{exefs_dir}; for (auto dir = exefs_dir; dirs.size() < 4;) { const auto parent = dir->GetParentDirectory(); if (parent == nullptr) { break; } const auto& name = parent->GetName(); dirs.push_back(parent); const bool storage_level = equals_ignore_case(name, "base") || equals_ignore_case(name, "update") || equals_ignore_case(name, "updates") || (!name.empty() && name.find_first_not_of("0123456789abcdefABCDEF") == std::string::npos); if (!storage_level) { break; } dir = parent; } return dirs; } } // namespace AppLoader_DeconstructedRomDirectory::AppLoader_DeconstructedRomDirectory(FileSys::VirtualFile file_, bool override_update_) : AppLoader(std::move(file_)) , override_update(override_update_) { const auto file_dir = file->GetContainingDirectory(); const auto sidecar_dirs = FindSidecarDirs(file_dir); // Title ID const auto npdm = file_dir->GetFile("main.npdm"); if (npdm != nullptr) { const auto res = metadata.Load(npdm); if (res == ResultStatus::Success) title_id = metadata.GetTitleID(); } // Icon FileSys::VirtualFile icon_file = nullptr; for (const auto& sidecar_dir : sidecar_dirs) { for (const auto& language : FileSys::LANGUAGE_NAMES) { icon_file = sidecar_dir->GetFile("icon_" + std::string(language) + ".dat"); if (icon_file != nullptr) { break; } } if (icon_file != nullptr) { icon_data = icon_file->ReadAllBytes(); break; } } if (icon_data.empty()) { // Any png, jpeg, or bmp file for (const auto& sidecar_dir : sidecar_dirs) { const auto& files = sidecar_dir->GetFiles(); const auto icon_iter = std::find_if(files.begin(), files.end(), [](const FileSys::VirtualFile& f) { return f->GetExtension() == "png" || f->GetExtension() == "jpg" || f->GetExtension() == "bmp" || f->GetExtension() == "jpeg"; }); if (icon_iter != files.end()) { icon_data = (*icon_iter)->ReadAllBytes(); break; } } } // Metadata FileSys::VirtualFile nacp_file = nullptr; for (const auto& sidecar_dir : sidecar_dirs) { nacp_file = sidecar_dir->GetFile("control.nacp"); if (nacp_file != nullptr) { break; } const auto& files = sidecar_dir->GetFiles(); const auto nacp_iter = std::find_if(files.begin(), files.end(), [](const FileSys::VirtualFile& f) { return f->GetExtension() == "nacp"; }); if (nacp_iter != files.end()) { nacp_file = *nacp_iter; break; } } if (nacp_file != nullptr) { control.emplace(nacp_file); name = control->GetApplicationName(); } romfs_exefs_dir = file_dir; if (const auto title_dir = file_dir->GetParentDirectory()) { romfs_version = RomFSProductVersion(FindLooseRomFSDirectory(title_dir)); } } AppLoader_DeconstructedRomDirectory::AppLoader_DeconstructedRomDirectory( FileSys::VirtualDir directory, bool override_update_) : AppLoader(directory->GetFile("main")) , dir(std::move(directory)) , override_update(override_update_) { romfs_exefs_dir = dir; } // Loaders made only for metadata (the game list, title lookups) never need the RomFS, and several // of them were alive with a whole copy each. const FileSys::VirtualFile& AppLoader_DeconstructedRomDirectory::LooseRomFS() { if (!romfs_resolved) { romfs_resolved = true; romfs = FindLooseRomFS(romfs_exefs_dir); } return romfs; } FileType AppLoader_DeconstructedRomDirectory::IdentifyType(const FileSys::VirtualFile& dir_file) { if (FileSys::IsDirectoryExeFS(dir_file->GetContainingDirectory())) { return FileType::DeconstructedRomDirectory; } return FileType::Error; } AppLoader_DeconstructedRomDirectory::LoadResult AppLoader_DeconstructedRomDirectory::Load( Kernel::KProcess& process, Core::System& system) { if (is_loaded) { return {ResultStatus::ErrorAlreadyLoaded, {}}; } // Loaded directly from a loose ExeFS (not wrapped by the NCA/NSP loaders, which register // the process with the filesystem controller themselves). const bool standalone = dir == nullptr; if (dir == nullptr) { if (file == nullptr) { return {ResultStatus::ErrorNullFile, {}}; } dir = file->GetContainingDirectory(); } // Read meta to determine title ID FileSys::VirtualFile npdm = dir->GetFile("main.npdm"); if (npdm == nullptr) { return {ResultStatus::ErrorMissingNPDM, {}}; } const ResultStatus result = metadata.Load(npdm); if (result != ResultStatus::Success) { return {result, {}}; } if (override_update) { const FileSys::PatchManager patch_manager( metadata.GetTitleID(), system.GetFileSystemController(), system.GetContentProvider()); dir = patch_manager.PatchExeFS(dir); } // Reread in case PatchExeFS affected the main.npdm npdm = dir->GetFile("main.npdm"); if (npdm == nullptr) { return {ResultStatus::ErrorMissingNPDM, {}}; } const ResultStatus result2 = metadata.Reload(npdm); if (result2 != ResultStatus::Success) { return {result2, {}}; } metadata.Print(); // Loose-ExeFS loads bypass the NCA/NSP loaders, which are the ones that normally apply // LayeredFS to the RomFS; apply it here so mods in user/load/<titleid>/ work too. if (LooseRomFS() != nullptr) { const FileSys::PatchManager patch_manager(metadata.GetTitleID(), system.GetFileSystemController(), system.GetContentProvider()); auto patched = patch_manager.PatchRomFS(nullptr, romfs); if (patched != nullptr) { romfs = std::move(patched); LOG_INFO(Loader, "Applied RomFS patches (LayeredFS) for title {:016X}", metadata.GetTitleID()); } } // Enable NCE only for applications with 39-bit address space. const bool is_39bit = metadata.GetAddressSpaceType() == FileSys::ProgramAddressSpaceType::Is39Bit; const bool is_application = metadata.GetPoolPartition() == FileSys::PoolPartition::Application; Settings::SetNceEnabled(is_39bit); const std::array static_modules = {"rtld", "main", "subsdk0", "subsdk1", "subsdk2", "subsdk3", "subsdk4", "subsdk5", "subsdk6", "subsdk7", "subsdk8", "subsdk9", "sdk"}; std::size_t code_size{}; // Define an nce patch context for each potential module. PatchCollection patch_ctx{is_application}; // Use the NSO module loader to figure out the code layout for (size_t i = 0; i < static_modules.size(); i++) { const auto& module = static_modules[i]; const FileSys::VirtualFile module_file{dir->GetFile(module)}; if (!module_file) { continue; } const bool should_pass_arguments = std::strcmp(module, "rtld") == 0; const auto tentative_next_load_addr = AppLoader_NSO::LoadModule( process, system, *module_file, code_size, should_pass_arguments, false, {}, patch_ctx.GetPatchers(), patch_ctx.GetLastIndex()); if (!tentative_next_load_addr) { return {ResultStatus::ErrorLoadingNSO, {}}; } patch_ctx.SaveIndex(i); code_size = *tentative_next_load_addr; } // Enable direct memory mapping in case of NCE. const u64 fastmem_base = [&]() -> size_t { if (is_application && Settings::IsNceEnabled()) { auto& buffer = system.DeviceMemory().buffer; buffer.EnableDirectMappedAddress(); return reinterpret_cast<u64>(buffer.VirtualBasePointer()); } return 0; }(); // Add patch size to the total module size code_size += patch_ctx.GetTotalPatchSize(); // TODO: this is bad form of ASLR, it sucks std::uintptr_t aslr_offset = ((::Settings::values.rng_seed_enabled.GetValue() ? ::Settings::values.rng_seed.GetValue() : Common::Random::Random64(0)) << 12) & 0xfff000; // Setup the process code layout if (process.LoadFromMetadata(system.Kernel(), metadata, code_size, fastmem_base, aslr_offset).IsError()) { return {ResultStatus::ErrorUnableToParseKernelMetadata, {}}; } // Load NSO modules modules.clear(); const VAddr base_address{GetInteger(process.GetEntryPoint())}; VAddr next_load_addr{base_address}; const FileSys::PatchManager pm{metadata.GetTitleID(), system.GetFileSystemController(), system.GetContentProvider()}; for (size_t i = 0; i < static_modules.size(); i++) { const auto& module = static_modules[i]; const FileSys::VirtualFile module_file{dir->GetFile(module)}; if (!module_file) { continue; } const VAddr load_addr{next_load_addr}; const bool should_pass_arguments = std::strcmp(module, "rtld") == 0; const auto tentative_next_load_addr = AppLoader_NSO::LoadModule( process, system, *module_file, load_addr, should_pass_arguments, true, pm, patch_ctx.GetPatchers(), patch_ctx.GetIndex(i)); if (!tentative_next_load_addr) { return {ResultStatus::ErrorLoadingNSO, {}}; } next_load_addr = *tentative_next_load_addr; modules.insert_or_assign(load_addr, module); LOG_DEBUG(Loader, "loaded module {} @ {:#x}", module, load_addr); } if (standalone) { // Without this, fsp-srv SetCurrentProcess fails with ResultTargetNotFound. system.GetFileSystemController().RegisterProcess( process.GetProcessId(), metadata.GetTitleID(), std::make_shared<FileSys::RomFSFactory>(*this, system.GetContentProvider(), system.GetFileSystemController())); } is_loaded = true; return {ResultStatus::Success, LoadParameters{metadata.GetMainThreadPriority(), metadata.GetMainThreadStackSize()}}; } ResultStatus AppLoader_DeconstructedRomDirectory::ReadRomFS(FileSys::VirtualFile& out_dir) { if (LooseRomFS() == nullptr) { return ResultStatus::ErrorNoRomFS; } out_dir = romfs; return ResultStatus::Success; } ResultStatus AppLoader_DeconstructedRomDirectory::ReadIcon(std::vector<u8>& out_buffer) { if (icon_data.empty()) { return ResultStatus::ErrorNoIcon; } out_buffer = icon_data; return ResultStatus::Success; } ResultStatus AppLoader_DeconstructedRomDirectory::ReadProgramId(u64& out_program_id) { out_program_id = title_id; return ResultStatus::Success; } ResultStatus AppLoader_DeconstructedRomDirectory::ReadTitle(std::string& out_title) { if (name.empty()) { return ResultStatus::ErrorNoControl; } out_title = name; return ResultStatus::Success; } ResultStatus AppLoader_DeconstructedRomDirectory::ReadControlData(FileSys::NACP& out_control) { if (!control) { return ResultStatus::ErrorNoControl; } out_control = *control; return ResultStatus::Success; } ResultStatus AppLoader_DeconstructedRomDirectory::ReadDisplayVersion(std::string& version) { if (control && !control->GetVersionString().empty()) { version = control->GetVersionString(); return ResultStatus::Success; } if (!romfs_version.empty()) { version = romfs_version; return ResultStatus::Success; } return ResultStatus::ErrorNoControl; } bool AppLoader_DeconstructedRomDirectory::IsRomFSUpdatable() const { return false; } ResultStatus AppLoader_DeconstructedRomDirectory::ReadNSOModules(Modules& out_modules) { if (!is_loaded) { return ResultStatus::ErrorNotInitialized; } out_modules = this->modules; return ResultStatus::Success; } } // namespace Loader