// SPDX-FileCopyrightText: Copyright 2018 yuzu Emulator Project // SPDX-License-Identifier: GPL-2.0-or-later #include #include "common/logging/log.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_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{}; }; AppLoader_DeconstructedRomDirectory::AppLoader_DeconstructedRomDirectory(FileSys::VirtualFile file_, bool override_update_) : AppLoader(std::move(file_)), override_update(override_update_), is_hbl(false) { const auto file_dir = file->GetContainingDirectory(); // 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& language : FileSys::LANGUAGE_NAMES) { icon_file = file_dir->GetFile("icon_" + std::string(language) + ".dat"); if (icon_file != nullptr) { icon_data = icon_file->ReadAllBytes(); break; } } if (icon_data.empty()) { // Any png, jpeg, or bmp file const auto& files = file_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(); } // Metadata FileSys::VirtualFile nacp_file = file_dir->GetFile("control.nacp"); if (nacp_file == nullptr) { const auto& files = file_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; } if (nacp_file != nullptr) { FileSys::NACP nacp(nacp_file); name = nacp.GetApplicationName(); } } AppLoader_DeconstructedRomDirectory::AppLoader_DeconstructedRomDirectory( FileSys::VirtualDir directory, bool override_update_, bool is_hbl_) : AppLoader(directory->GetFile("main")), dir(std::move(directory)), override_update(override_update_), is_hbl(is_hbl_) {} 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, {}}; } 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(); // 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(buffer.VirtualBasePointer()); } return 0; }(); // Add patch size to the total module size code_size += patch_ctx.GetTotalPatchSize(); // Setup the process code layout if (process.LoadFromMetadata(metadata, code_size, fastmem_base, is_hbl).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); } is_loaded = true; return {ResultStatus::Success, LoadParameters{metadata.GetMainThreadPriority(), metadata.GetMainThreadStackSize()}}; } ResultStatus AppLoader_DeconstructedRomDirectory::ReadRomFS(FileSys::VirtualFile& out_dir) { if (romfs == nullptr) { return ResultStatus::ErrorNoRomFS; } out_dir = romfs; return ResultStatus::Success; } ResultStatus AppLoader_DeconstructedRomDirectory::ReadIcon(std::vector& 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; } 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