2022-04-23 10:59:50 +02:00
|
|
|
// SPDX-FileCopyrightText: Copyright 2018 yuzu Emulator Project
|
|
|
|
// SPDX-License-Identifier: GPL-2.0-or-later
|
2017-09-24 17:08:31 +02:00
|
|
|
|
2018-02-14 06:57:06 +01:00
|
|
|
#include <cinttypes>
|
2020-01-12 16:51:07 +01:00
|
|
|
#include <cstring>
|
2017-09-24 17:08:31 +02:00
|
|
|
#include <vector>
|
2019-02-07 19:40:39 +01:00
|
|
|
|
2017-10-15 06:11:38 +02:00
|
|
|
#include "common/common_funcs.h"
|
2018-12-23 03:31:07 +01:00
|
|
|
#include "common/hex_util.h"
|
2017-09-24 17:08:31 +02:00
|
|
|
#include "common/logging/log.h"
|
2019-02-08 06:45:50 +01:00
|
|
|
#include "common/lz4_compression.h"
|
2021-04-15 01:07:40 +02:00
|
|
|
#include "common/settings.h"
|
2017-09-24 17:08:31 +02:00
|
|
|
#include "common/swap.h"
|
2018-12-23 03:31:07 +01:00
|
|
|
#include "core/core.h"
|
2018-09-30 04:16:09 +02:00
|
|
|
#include "core/file_sys/patch_manager.h"
|
2019-03-20 17:40:09 +01:00
|
|
|
#include "core/hle/kernel/code_set.h"
|
2021-02-13 02:58:31 +01:00
|
|
|
#include "core/hle/kernel/k_page_table.h"
|
2021-04-24 07:04:28 +02:00
|
|
|
#include "core/hle/kernel/k_process.h"
|
2020-12-31 08:01:08 +01:00
|
|
|
#include "core/hle/kernel/k_thread.h"
|
2017-09-24 17:08:31 +02:00
|
|
|
#include "core/loader/nso.h"
|
|
|
|
#include "core/memory.h"
|
|
|
|
|
2023-11-20 14:52:18 +01:00
|
|
|
#ifdef HAS_NCE
|
2023-11-17 22:44:53 +01:00
|
|
|
#include "core/arm/nce/patch.h"
|
|
|
|
#endif
|
|
|
|
|
2017-09-24 17:08:31 +02:00
|
|
|
namespace Loader {
|
2019-03-22 19:00:01 +01:00
|
|
|
namespace {
|
2019-03-22 18:04:41 +01:00
|
|
|
struct MODHeader {
|
2017-09-30 20:15:09 +02:00
|
|
|
u32_le magic;
|
|
|
|
u32_le dynamic_offset;
|
|
|
|
u32_le bss_start_offset;
|
|
|
|
u32_le bss_end_offset;
|
|
|
|
u32_le eh_frame_hdr_start_offset;
|
|
|
|
u32_le eh_frame_hdr_end_offset;
|
|
|
|
u32_le module_offset; // Offset to runtime-generated module object. typically equal to .bss base
|
|
|
|
};
|
2019-03-22 18:04:41 +01:00
|
|
|
static_assert(sizeof(MODHeader) == 0x1c, "MODHeader has incorrect size.");
|
2017-09-30 20:15:09 +02:00
|
|
|
|
2019-03-22 19:00:01 +01:00
|
|
|
std::vector<u8> DecompressSegment(const std::vector<u8>& compressed_data,
|
|
|
|
const NSOSegmentHeader& header) {
|
2020-04-18 01:26:48 +02:00
|
|
|
std::vector<u8> uncompressed_data =
|
2019-02-08 06:45:50 +01:00
|
|
|
Common::Compression::DecompressDataLZ4(compressed_data, header.size);
|
2018-06-21 17:16:23 +02:00
|
|
|
|
2019-05-25 22:53:31 +02:00
|
|
|
ASSERT_MSG(uncompressed_data.size() == header.size, "{} != {}", header.size,
|
2019-02-08 06:45:50 +01:00
|
|
|
uncompressed_data.size());
|
2018-06-21 17:16:23 +02:00
|
|
|
|
|
|
|
return uncompressed_data;
|
|
|
|
}
|
|
|
|
|
2019-03-22 19:00:01 +01:00
|
|
|
constexpr u32 PageAlignSize(u32 size) {
|
2022-08-19 01:28:55 +02:00
|
|
|
return static_cast<u32>((size + Core::Memory::YUZU_PAGEMASK) & ~Core::Memory::YUZU_PAGEMASK);
|
2017-09-30 20:15:09 +02:00
|
|
|
}
|
2019-03-22 19:00:01 +01:00
|
|
|
} // Anonymous namespace
|
|
|
|
|
2019-03-22 18:04:41 +01:00
|
|
|
bool NSOHeader::IsSegmentCompressed(size_t segment_num) const {
|
|
|
|
ASSERT_MSG(segment_num < 3, "Invalid segment {}", segment_num);
|
|
|
|
return ((flags >> segment_num) & 1) != 0;
|
|
|
|
}
|
2017-09-30 20:15:09 +02:00
|
|
|
|
2021-04-27 18:05:34 +02:00
|
|
|
AppLoader_NSO::AppLoader_NSO(FileSys::VirtualFile file_) : AppLoader(std::move(file_)) {}
|
2018-01-20 21:48:37 +01:00
|
|
|
|
2021-04-27 18:05:34 +02:00
|
|
|
FileType AppLoader_NSO::IdentifyType(const FileSys::VirtualFile& in_file) {
|
2017-09-30 20:15:09 +02:00
|
|
|
u32 magic = 0;
|
2021-04-27 18:05:34 +02:00
|
|
|
if (in_file->ReadObject(&magic) != sizeof(magic)) {
|
2018-07-19 18:40:06 +02:00
|
|
|
return FileType::Error;
|
|
|
|
}
|
2017-09-30 20:15:09 +02:00
|
|
|
|
2018-07-19 18:40:06 +02:00
|
|
|
if (Common::MakeMagic('N', 'S', 'O', '0') != magic) {
|
|
|
|
return FileType::Error;
|
2017-09-30 20:15:09 +02:00
|
|
|
}
|
|
|
|
|
2018-07-19 18:40:06 +02:00
|
|
|
return FileType::NSO;
|
2017-09-30 20:15:09 +02:00
|
|
|
}
|
2017-09-24 17:08:31 +02:00
|
|
|
|
2021-04-24 07:04:28 +02:00
|
|
|
std::optional<VAddr> AppLoader_NSO::LoadModule(Kernel::KProcess& process, Core::System& system,
|
2021-04-27 18:05:34 +02:00
|
|
|
const FileSys::VfsFile& nso_file, VAddr load_base,
|
2020-04-09 22:12:31 +02:00
|
|
|
bool should_pass_arguments, bool load_into_process,
|
2023-11-17 22:44:53 +01:00
|
|
|
std::optional<FileSys::PatchManager> pm,
|
|
|
|
Core::NCE::Patcher* patch) {
|
2021-04-27 18:05:34 +02:00
|
|
|
if (nso_file.GetSize() < sizeof(NSOHeader)) {
|
2020-09-22 23:31:53 +02:00
|
|
|
return std::nullopt;
|
2019-03-22 18:04:41 +01:00
|
|
|
}
|
2018-07-19 03:07:11 +02:00
|
|
|
|
2019-03-22 18:04:41 +01:00
|
|
|
NSOHeader nso_header{};
|
2021-04-27 18:05:34 +02:00
|
|
|
if (sizeof(NSOHeader) != nso_file.ReadObject(&nso_header)) {
|
2020-09-22 23:31:53 +02:00
|
|
|
return std::nullopt;
|
2019-03-22 18:04:41 +01:00
|
|
|
}
|
2018-07-08 05:24:51 +02:00
|
|
|
|
2019-03-22 18:04:41 +01:00
|
|
|
if (nso_header.magic != Common::MakeMagic('N', 'S', 'O', '0')) {
|
2020-09-22 23:31:53 +02:00
|
|
|
return std::nullopt;
|
2019-03-22 18:04:41 +01:00
|
|
|
}
|
2018-06-21 17:16:23 +02:00
|
|
|
|
2023-11-17 22:44:53 +01:00
|
|
|
// Allocate some space at the beginning if we are patching in PreText mode.
|
|
|
|
const size_t module_start = [&]() -> size_t {
|
2023-11-20 14:52:18 +01:00
|
|
|
#ifdef HAS_NCE
|
2023-11-19 10:21:53 +01:00
|
|
|
if (patch && patch->GetPatchMode() == Core::NCE::PatchMode::PreText) {
|
|
|
|
return patch->GetSectionSize();
|
2023-11-17 22:44:53 +01:00
|
|
|
}
|
|
|
|
#endif
|
|
|
|
return 0;
|
|
|
|
}();
|
|
|
|
|
2018-07-08 05:24:51 +02:00
|
|
|
// Build program image
|
2018-10-12 17:36:31 +02:00
|
|
|
Kernel::CodeSet codeset;
|
2019-07-19 00:15:53 +02:00
|
|
|
Kernel::PhysicalMemory program_image;
|
2018-07-19 02:21:25 +02:00
|
|
|
for (std::size_t i = 0; i < nso_header.segments.size(); ++i) {
|
2021-04-27 18:05:34 +02:00
|
|
|
std::vector<u8> data = nso_file.ReadBytes(nso_header.segments_compressed_size[i],
|
|
|
|
nso_header.segments[i].offset);
|
2018-09-21 06:39:30 +02:00
|
|
|
if (nso_header.IsSegmentCompressed(i)) {
|
|
|
|
data = DecompressSegment(data, nso_header.segments[i]);
|
|
|
|
}
|
2023-11-17 22:44:53 +01:00
|
|
|
program_image.resize(module_start + nso_header.segments[i].location +
|
|
|
|
static_cast<u32>(data.size()));
|
|
|
|
std::memcpy(program_image.data() + module_start + nso_header.segments[i].location,
|
|
|
|
data.data(), data.size());
|
|
|
|
codeset.segments[i].addr = module_start + nso_header.segments[i].location;
|
|
|
|
codeset.segments[i].offset = module_start + nso_header.segments[i].location;
|
2020-03-21 04:44:28 +01:00
|
|
|
codeset.segments[i].size = nso_header.segments[i].size;
|
2018-07-08 05:24:51 +02:00
|
|
|
}
|
|
|
|
|
2021-06-28 21:58:16 +02:00
|
|
|
if (should_pass_arguments && !Settings::values.program_args.GetValue().empty()) {
|
|
|
|
const auto arg_data{Settings::values.program_args.GetValue()};
|
2020-04-09 22:12:31 +02:00
|
|
|
|
2018-10-12 17:36:31 +02:00
|
|
|
codeset.DataSegment().size += NSO_ARGUMENT_DATA_ALLOCATION_SIZE;
|
2018-10-05 19:52:07 +02:00
|
|
|
NSOArgumentHeader args_header{
|
|
|
|
NSO_ARGUMENT_DATA_ALLOCATION_SIZE, static_cast<u32_le>(arg_data.size()), {}};
|
|
|
|
const auto end_offset = program_image.size();
|
|
|
|
program_image.resize(static_cast<u32>(program_image.size()) +
|
|
|
|
NSO_ARGUMENT_DATA_ALLOCATION_SIZE);
|
|
|
|
std::memcpy(program_image.data() + end_offset, &args_header, sizeof(NSOArgumentHeader));
|
|
|
|
std::memcpy(program_image.data() + end_offset + sizeof(NSOArgumentHeader), arg_data.data(),
|
2018-09-30 20:04:48 +02:00
|
|
|
arg_data.size());
|
|
|
|
}
|
|
|
|
|
2020-03-21 04:44:28 +01:00
|
|
|
codeset.DataSegment().size += nso_header.segments[2].bss_size;
|
2023-11-17 22:44:53 +01:00
|
|
|
u32 image_size{
|
2020-03-21 04:44:28 +01:00
|
|
|
PageAlignSize(static_cast<u32>(program_image.size()) + nso_header.segments[2].bss_size)};
|
2018-07-08 05:24:51 +02:00
|
|
|
program_image.resize(image_size);
|
|
|
|
|
2020-03-21 04:44:28 +01:00
|
|
|
for (std::size_t i = 0; i < nso_header.segments.size(); ++i) {
|
|
|
|
codeset.segments[i].size = PageAlignSize(codeset.segments[i].size);
|
|
|
|
}
|
|
|
|
|
2018-09-30 04:16:09 +02:00
|
|
|
// Apply patches if necessary
|
2023-09-14 20:34:05 +02:00
|
|
|
const auto name = nso_file.GetName();
|
|
|
|
if (pm && (pm->HasNSOPatch(nso_header.build_id, name) || Settings::values.dump_nso)) {
|
2022-06-12 23:14:27 +02:00
|
|
|
std::vector<u8> pi_header(sizeof(NSOHeader) + program_image.size());
|
|
|
|
std::memcpy(pi_header.data(), &nso_header, sizeof(NSOHeader));
|
|
|
|
std::memcpy(pi_header.data() + sizeof(NSOHeader), program_image.data(),
|
|
|
|
program_image.size());
|
2018-09-30 04:16:09 +02:00
|
|
|
|
2023-09-14 20:34:05 +02:00
|
|
|
pi_header = pm->PatchNSO(pi_header, name);
|
2018-09-30 04:16:09 +02:00
|
|
|
|
2020-01-12 16:51:07 +01:00
|
|
|
std::copy(pi_header.begin() + sizeof(NSOHeader), pi_header.end(), program_image.data());
|
2018-09-30 04:16:09 +02:00
|
|
|
}
|
|
|
|
|
2023-11-20 14:52:18 +01:00
|
|
|
#ifdef HAS_NCE
|
2023-11-17 22:44:53 +01:00
|
|
|
// If we are computing the process code layout and using nce backend, patch.
|
|
|
|
const auto& code = codeset.CodeSegment();
|
2023-11-19 10:21:53 +01:00
|
|
|
if (patch && patch->GetPatchMode() == Core::NCE::PatchMode::None) {
|
2023-11-17 22:44:53 +01:00
|
|
|
// Patch SVCs and MRS calls in the guest code
|
|
|
|
patch->PatchText(program_image, code);
|
|
|
|
|
|
|
|
// Add patch section size to the module size.
|
2023-11-19 10:21:53 +01:00
|
|
|
image_size += patch->GetSectionSize();
|
2023-11-17 22:44:53 +01:00
|
|
|
} else if (patch) {
|
|
|
|
// Relocate code patch and copy to the program_image.
|
|
|
|
patch->RelocateAndCopy(load_base, code, program_image, &process.GetPostHandlers());
|
|
|
|
|
|
|
|
// Update patch section.
|
|
|
|
auto& patch_segment = codeset.PatchSegment();
|
2023-11-19 10:21:53 +01:00
|
|
|
patch_segment.addr =
|
|
|
|
patch->GetPatchMode() == Core::NCE::PatchMode::PreText ? 0 : image_size;
|
|
|
|
patch_segment.size = static_cast<u32>(patch->GetSectionSize());
|
2023-11-17 22:44:53 +01:00
|
|
|
|
|
|
|
// Add patch section size to the module size. In PreText mode image_size
|
|
|
|
// already contains the patch segment as part of module_start.
|
2023-11-19 10:21:53 +01:00
|
|
|
if (patch->GetPatchMode() == Core::NCE::PatchMode::PostData) {
|
2023-11-17 22:44:53 +01:00
|
|
|
image_size += patch_segment.size;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
#endif
|
|
|
|
|
2020-04-09 22:12:31 +02:00
|
|
|
// If we aren't actually loading (i.e. just computing the process code layout), we are done
|
|
|
|
if (!load_into_process) {
|
|
|
|
return load_base + image_size;
|
|
|
|
}
|
|
|
|
|
2018-12-23 03:31:07 +01:00
|
|
|
// Apply cheats if they exist and the program has a valid title ID
|
|
|
|
if (pm) {
|
2023-02-13 17:21:43 +01:00
|
|
|
system.SetApplicationProcessBuildID(nso_header.build_id);
|
2020-11-18 13:53:10 +01:00
|
|
|
const auto cheats = pm->CreateCheatList(nso_header.build_id);
|
2018-12-23 03:31:07 +01:00
|
|
|
if (!cheats.empty()) {
|
2019-05-31 01:35:28 +02:00
|
|
|
system.RegisterCheatList(cheats, nso_header.build_id, load_base, image_size);
|
2018-12-23 03:31:07 +01:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2018-07-08 05:24:51 +02:00
|
|
|
// Load codeset for current process
|
2019-03-22 19:51:36 +01:00
|
|
|
codeset.memory = std::move(program_image);
|
2018-12-03 04:24:43 +01:00
|
|
|
process.LoadModule(std::move(codeset), load_base);
|
2018-07-08 05:24:51 +02:00
|
|
|
|
|
|
|
return load_base + image_size;
|
|
|
|
}
|
|
|
|
|
2021-04-24 07:04:28 +02:00
|
|
|
AppLoader_NSO::LoadResult AppLoader_NSO::Load(Kernel::KProcess& process, Core::System& system) {
|
2017-09-30 20:15:09 +02:00
|
|
|
if (is_loaded) {
|
2019-04-09 23:03:04 +02:00
|
|
|
return {ResultStatus::ErrorAlreadyLoaded, {}};
|
2017-09-30 20:15:09 +02:00
|
|
|
}
|
2017-09-24 17:08:31 +02:00
|
|
|
|
2019-05-26 17:40:41 +02:00
|
|
|
modules.clear();
|
|
|
|
|
2018-01-20 20:20:04 +01:00
|
|
|
// Load module
|
2023-08-25 23:59:32 +02:00
|
|
|
const VAddr base_address = GetInteger(process.GetEntryPoint());
|
2020-09-16 14:19:25 +02:00
|
|
|
if (!LoadModule(process, system, *file, base_address, true, true)) {
|
2019-04-09 23:03:04 +02:00
|
|
|
return {ResultStatus::ErrorLoadingNSO, {}};
|
2018-10-15 03:41:58 +02:00
|
|
|
}
|
2019-05-26 17:40:41 +02:00
|
|
|
|
|
|
|
modules.insert_or_assign(base_address, file->GetName());
|
2018-09-25 02:01:45 +02:00
|
|
|
LOG_DEBUG(Loader, "loaded module {} @ 0x{:X}", file->GetName(), base_address);
|
2017-09-24 17:08:31 +02:00
|
|
|
|
|
|
|
is_loaded = true;
|
2021-01-01 11:06:06 +01:00
|
|
|
return {ResultStatus::Success, LoadParameters{Kernel::KThread::DefaultThreadPriority,
|
|
|
|
Core::Memory::DEFAULT_STACK_SIZE}};
|
2017-09-24 17:08:31 +02:00
|
|
|
}
|
|
|
|
|
2021-04-27 18:05:34 +02:00
|
|
|
ResultStatus AppLoader_NSO::ReadNSOModules(Modules& out_modules) {
|
|
|
|
out_modules = this->modules;
|
2019-05-26 17:40:41 +02:00
|
|
|
return ResultStatus::Success;
|
|
|
|
}
|
|
|
|
|
2017-09-24 17:08:31 +02:00
|
|
|
} // namespace Loader
|