2018-01-13 13:22:39 -08:00
|
|
|
// Copyright 2018 yuzu emulator team
|
2017-10-05 20:30:08 -07:00
|
|
|
// Licensed under GPLv2 or any later version
|
|
|
|
// Refer to the license.txt file included.
|
|
|
|
|
2018-07-19 21:10:21 -07:00
|
|
|
#include <utility>
|
2017-10-05 20:30:08 -07:00
|
|
|
#include <vector>
|
|
|
|
|
2017-10-14 21:11:38 -07:00
|
|
|
#include "common/common_funcs.h"
|
2018-07-23 14:27:50 -07:00
|
|
|
#include "common/common_types.h"
|
2018-01-20 12:48:37 -08:00
|
|
|
#include "common/file_util.h"
|
2017-10-05 20:30:08 -07:00
|
|
|
#include "common/logging/log.h"
|
|
|
|
#include "common/swap.h"
|
2019-04-22 14:56:56 -07:00
|
|
|
#include "core/core.h"
|
2018-07-23 09:33:24 -07:00
|
|
|
#include "core/file_sys/control_metadata.h"
|
2018-10-28 11:56:12 -07:00
|
|
|
#include "core/file_sys/romfs_factory.h"
|
2018-07-23 09:33:24 -07:00
|
|
|
#include "core/file_sys/vfs_offset.h"
|
2019-03-20 09:40:09 -07:00
|
|
|
#include "core/hle/kernel/code_set.h"
|
2020-12-30 23:01:08 -08:00
|
|
|
#include "core/hle/kernel/k_thread.h"
|
2020-04-09 11:01:34 -07:00
|
|
|
#include "core/hle/kernel/memory/page_table.h"
|
2017-10-05 20:30:08 -07:00
|
|
|
#include "core/hle/kernel/process.h"
|
2018-10-28 11:56:12 -07:00
|
|
|
#include "core/hle/service/filesystem/filesystem.h"
|
2017-10-05 20:30:08 -07:00
|
|
|
#include "core/loader/nro.h"
|
2018-09-30 11:04:48 -07:00
|
|
|
#include "core/loader/nso.h"
|
2017-10-05 20:30:08 -07:00
|
|
|
#include "core/memory.h"
|
2018-09-30 11:04:48 -07:00
|
|
|
#include "core/settings.h"
|
2017-10-05 20:30:08 -07:00
|
|
|
|
|
|
|
namespace Loader {
|
|
|
|
|
|
|
|
struct NroSegmentHeader {
|
|
|
|
u32_le offset;
|
|
|
|
u32_le size;
|
|
|
|
};
|
|
|
|
static_assert(sizeof(NroSegmentHeader) == 0x8, "NroSegmentHeader has incorrect size.");
|
|
|
|
|
|
|
|
struct NroHeader {
|
|
|
|
INSERT_PADDING_BYTES(0x4);
|
|
|
|
u32_le module_header_offset;
|
|
|
|
INSERT_PADDING_BYTES(0x8);
|
|
|
|
u32_le magic;
|
|
|
|
INSERT_PADDING_BYTES(0x4);
|
|
|
|
u32_le file_size;
|
|
|
|
INSERT_PADDING_BYTES(0x4);
|
|
|
|
std::array<NroSegmentHeader, 3> segments; // Text, RoData, Data (in that order)
|
|
|
|
u32_le bss_size;
|
|
|
|
INSERT_PADDING_BYTES(0x44);
|
|
|
|
};
|
|
|
|
static_assert(sizeof(NroHeader) == 0x80, "NroHeader has incorrect size.");
|
|
|
|
|
|
|
|
struct ModHeader {
|
|
|
|
u32_le magic;
|
|
|
|
u32_le dynamic_offset;
|
|
|
|
u32_le bss_start_offset;
|
|
|
|
u32_le bss_end_offset;
|
|
|
|
u32_le unwind_start_offset;
|
|
|
|
u32_le unwind_end_offset;
|
|
|
|
u32_le module_offset; // Offset to runtime-generated module object. typically equal to .bss base
|
|
|
|
};
|
|
|
|
static_assert(sizeof(ModHeader) == 0x1c, "ModHeader has incorrect size.");
|
|
|
|
|
2018-07-23 09:33:24 -07:00
|
|
|
struct AssetSection {
|
|
|
|
u64_le offset;
|
|
|
|
u64_le size;
|
|
|
|
};
|
|
|
|
static_assert(sizeof(AssetSection) == 0x10, "AssetSection has incorrect size.");
|
|
|
|
|
|
|
|
struct AssetHeader {
|
|
|
|
u32_le magic;
|
|
|
|
u32_le format_version;
|
|
|
|
AssetSection icon;
|
|
|
|
AssetSection nacp;
|
|
|
|
AssetSection romfs;
|
|
|
|
};
|
|
|
|
static_assert(sizeof(AssetHeader) == 0x38, "AssetHeader has incorrect size.");
|
|
|
|
|
|
|
|
AppLoader_NRO::AppLoader_NRO(FileSys::VirtualFile file) : AppLoader(file) {
|
|
|
|
NroHeader nro_header{};
|
2018-07-23 14:24:27 -07:00
|
|
|
if (file->ReadObject(&nro_header) != sizeof(NroHeader)) {
|
2018-07-23 09:33:24 -07:00
|
|
|
return;
|
2018-07-23 14:24:27 -07:00
|
|
|
}
|
2018-07-23 09:33:24 -07:00
|
|
|
|
|
|
|
if (file->GetSize() >= nro_header.file_size + sizeof(AssetHeader)) {
|
2018-07-23 14:24:27 -07:00
|
|
|
const u64 offset = nro_header.file_size;
|
2018-07-23 09:33:24 -07:00
|
|
|
AssetHeader asset_header{};
|
2018-07-23 14:24:27 -07:00
|
|
|
if (file->ReadObject(&asset_header, offset) != sizeof(AssetHeader)) {
|
2018-07-23 09:33:24 -07:00
|
|
|
return;
|
2018-07-23 14:24:27 -07:00
|
|
|
}
|
2018-07-23 09:33:24 -07:00
|
|
|
|
2018-07-23 14:24:27 -07:00
|
|
|
if (asset_header.format_version != 0) {
|
2018-07-23 09:33:24 -07:00
|
|
|
LOG_WARNING(Loader,
|
|
|
|
"NRO Asset Header has format {}, currently supported format is 0. If "
|
|
|
|
"strange glitches occur with metadata, check NRO assets.",
|
|
|
|
asset_header.format_version);
|
2018-07-23 14:24:27 -07:00
|
|
|
}
|
|
|
|
|
|
|
|
if (asset_header.magic != Common::MakeMagic('A', 'S', 'E', 'T')) {
|
2018-07-23 09:33:24 -07:00
|
|
|
return;
|
2018-07-23 14:24:27 -07:00
|
|
|
}
|
2018-07-23 09:33:24 -07:00
|
|
|
|
|
|
|
if (asset_header.nacp.size > 0) {
|
|
|
|
nacp = std::make_unique<FileSys::NACP>(std::make_shared<FileSys::OffsetVfsFile>(
|
|
|
|
file, asset_header.nacp.size, offset + asset_header.nacp.offset, "Control.nacp"));
|
|
|
|
}
|
|
|
|
|
|
|
|
if (asset_header.romfs.size > 0) {
|
|
|
|
romfs = std::make_shared<FileSys::OffsetVfsFile>(
|
|
|
|
file, asset_header.romfs.size, offset + asset_header.romfs.offset, "game.romfs");
|
|
|
|
}
|
|
|
|
|
|
|
|
if (asset_header.icon.size > 0) {
|
|
|
|
icon_data = file->ReadBytes(asset_header.icon.size, offset + asset_header.icon.offset);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
2018-01-20 12:48:37 -08:00
|
|
|
|
2018-07-23 14:27:50 -07:00
|
|
|
AppLoader_NRO::~AppLoader_NRO() = default;
|
|
|
|
|
2018-07-18 18:07:11 -07:00
|
|
|
FileType AppLoader_NRO::IdentifyType(const FileSys::VirtualFile& file) {
|
2017-10-05 20:30:08 -07:00
|
|
|
// Read NSO header
|
|
|
|
NroHeader nro_header{};
|
2018-07-18 18:07:11 -07:00
|
|
|
if (sizeof(NroHeader) != file->ReadObject(&nro_header)) {
|
2017-10-05 20:30:08 -07:00
|
|
|
return FileType::Error;
|
|
|
|
}
|
2017-10-14 21:11:38 -07:00
|
|
|
if (nro_header.magic == Common::MakeMagic('N', 'R', 'O', '0')) {
|
2017-10-05 20:30:08 -07:00
|
|
|
return FileType::NRO;
|
|
|
|
}
|
|
|
|
return FileType::Error;
|
|
|
|
}
|
|
|
|
|
|
|
|
static constexpr u32 PageAlignSize(u32 size) {
|
2020-10-13 05:10:50 -07:00
|
|
|
return static_cast<u32>((size + Core::Memory::PAGE_MASK) & ~Core::Memory::PAGE_MASK);
|
2017-10-05 20:30:08 -07:00
|
|
|
}
|
|
|
|
|
2018-12-02 19:17:09 -08:00
|
|
|
static bool LoadNroImpl(Kernel::Process& process, const std::vector<u8>& data,
|
2020-04-20 15:16:55 -07:00
|
|
|
const std::string& name) {
|
2018-10-23 15:35:20 -07:00
|
|
|
if (data.size() < sizeof(NroHeader)) {
|
2017-10-05 20:30:08 -07:00
|
|
|
return {};
|
|
|
|
}
|
2018-10-23 15:35:20 -07:00
|
|
|
|
|
|
|
// Read NSO header
|
|
|
|
NroHeader nro_header{};
|
|
|
|
std::memcpy(&nro_header, data.data(), sizeof(NroHeader));
|
2017-10-14 21:11:38 -07:00
|
|
|
if (nro_header.magic != Common::MakeMagic('N', 'R', 'O', '0')) {
|
2017-10-05 20:30:08 -07:00
|
|
|
return {};
|
|
|
|
}
|
|
|
|
|
|
|
|
// Build program image
|
2019-07-18 15:15:53 -07:00
|
|
|
Kernel::PhysicalMemory program_image(PageAlignSize(nro_header.file_size));
|
2018-10-23 15:35:20 -07:00
|
|
|
std::memcpy(program_image.data(), data.data(), program_image.size());
|
2018-07-23 14:24:27 -07:00
|
|
|
if (program_image.size() != PageAlignSize(nro_header.file_size)) {
|
2018-07-18 18:07:11 -07:00
|
|
|
return {};
|
2018-07-23 14:24:27 -07:00
|
|
|
}
|
2017-10-05 20:30:08 -07:00
|
|
|
|
2018-10-12 08:36:31 -07:00
|
|
|
Kernel::CodeSet codeset;
|
2018-07-18 17:29:04 -07:00
|
|
|
for (std::size_t i = 0; i < nro_header.segments.size(); ++i) {
|
2018-10-12 08:36:31 -07:00
|
|
|
codeset.segments[i].addr = nro_header.segments[i].offset;
|
|
|
|
codeset.segments[i].offset = nro_header.segments[i].offset;
|
|
|
|
codeset.segments[i].size = PageAlignSize(nro_header.segments[i].size);
|
2017-10-05 20:30:08 -07:00
|
|
|
}
|
|
|
|
|
2018-09-30 11:04:48 -07:00
|
|
|
if (!Settings::values.program_args.empty()) {
|
|
|
|
const auto arg_data = Settings::values.program_args;
|
2018-10-12 08:36:31 -07:00
|
|
|
codeset.DataSegment().size += NSO_ARGUMENT_DATA_ALLOCATION_SIZE;
|
2018-10-05 10:52:07 -07: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 11:04:48 -07:00
|
|
|
arg_data.size());
|
|
|
|
}
|
|
|
|
|
2018-01-17 15:16:09 -08:00
|
|
|
// Default .bss to NRO header bss size if MOD0 section doesn't exist
|
|
|
|
u32 bss_size{PageAlignSize(nro_header.bss_size)};
|
2018-10-29 18:55:06 -07:00
|
|
|
|
|
|
|
// Read MOD header
|
|
|
|
ModHeader mod_header{};
|
2017-10-05 20:30:08 -07:00
|
|
|
std::memcpy(&mod_header, program_image.data() + nro_header.module_header_offset,
|
|
|
|
sizeof(ModHeader));
|
2018-10-29 18:55:06 -07:00
|
|
|
|
2017-10-14 21:11:38 -07:00
|
|
|
const bool has_mod_header{mod_header.magic == Common::MakeMagic('M', 'O', 'D', '0')};
|
2017-10-05 20:30:08 -07:00
|
|
|
if (has_mod_header) {
|
|
|
|
// Resize program image to include .bss section and page align each section
|
|
|
|
bss_size = PageAlignSize(mod_header.bss_end_offset - mod_header.bss_start_offset);
|
|
|
|
}
|
2018-10-29 18:55:06 -07:00
|
|
|
|
2018-10-12 08:36:31 -07:00
|
|
|
codeset.DataSegment().size += bss_size;
|
2018-01-18 12:18:43 -08:00
|
|
|
program_image.resize(static_cast<u32>(program_image.size()) + bss_size);
|
2017-10-05 20:30:08 -07:00
|
|
|
|
2020-04-20 15:16:55 -07:00
|
|
|
// Setup the process code layout
|
|
|
|
if (process.LoadFromMetadata(FileSys::ProgramMetadata::GetDefault(), program_image.size())
|
|
|
|
.IsError()) {
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
2017-10-05 20:30:08 -07:00
|
|
|
// Load codeset for current process
|
2019-03-22 11:51:36 -07:00
|
|
|
codeset.memory = std::move(program_image);
|
2020-04-20 15:16:55 -07:00
|
|
|
process.LoadModule(std::move(codeset), process.PageTable().GetCodeRegionStart());
|
2017-10-05 20:30:08 -07:00
|
|
|
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
2020-04-20 15:16:55 -07:00
|
|
|
bool AppLoader_NRO::LoadNro(Kernel::Process& process, const FileSys::VfsFile& file) {
|
|
|
|
return LoadNroImpl(process, file.ReadAllBytes(), file.GetName());
|
2018-10-23 15:35:20 -07:00
|
|
|
}
|
|
|
|
|
2020-09-16 05:19:25 -07:00
|
|
|
AppLoader_NRO::LoadResult AppLoader_NRO::Load(Kernel::Process& process, Core::System& system) {
|
2017-10-05 20:30:08 -07:00
|
|
|
if (is_loaded) {
|
2019-04-09 14:03:04 -07:00
|
|
|
return {ResultStatus::ErrorAlreadyLoaded, {}};
|
2017-10-05 20:30:08 -07:00
|
|
|
}
|
|
|
|
|
2020-04-20 15:16:55 -07:00
|
|
|
if (!LoadNro(process, *file)) {
|
2019-04-09 14:03:04 -07:00
|
|
|
return {ResultStatus::ErrorLoadingNRO, {}};
|
2017-10-05 20:30:08 -07:00
|
|
|
}
|
|
|
|
|
2019-04-09 14:03:04 -07:00
|
|
|
if (romfs != nullptr) {
|
2020-09-16 15:29:24 -07:00
|
|
|
system.GetFileSystemController().RegisterRomFS(std::make_unique<FileSys::RomFSFactory>(
|
|
|
|
*this, system.GetContentProvider(), system.GetFileSystemController()));
|
2019-04-09 14:03:04 -07:00
|
|
|
}
|
2017-10-05 20:30:08 -07:00
|
|
|
|
|
|
|
is_loaded = true;
|
2019-04-09 14:03:04 -07:00
|
|
|
return {ResultStatus::Success,
|
2020-03-31 12:10:44 -07:00
|
|
|
LoadParameters{Kernel::THREADPRIO_DEFAULT, Core::Memory::DEFAULT_STACK_SIZE}};
|
2017-10-05 20:30:08 -07:00
|
|
|
}
|
|
|
|
|
2018-07-23 09:33:24 -07:00
|
|
|
ResultStatus AppLoader_NRO::ReadIcon(std::vector<u8>& buffer) {
|
2018-07-23 14:24:27 -07:00
|
|
|
if (icon_data.empty()) {
|
2018-08-09 18:06:44 -07:00
|
|
|
return ResultStatus::ErrorNoIcon;
|
2018-07-23 14:24:27 -07:00
|
|
|
}
|
|
|
|
|
2018-07-23 09:33:24 -07:00
|
|
|
buffer = icon_data;
|
|
|
|
return ResultStatus::Success;
|
|
|
|
}
|
|
|
|
|
|
|
|
ResultStatus AppLoader_NRO::ReadProgramId(u64& out_program_id) {
|
2018-07-23 14:24:27 -07:00
|
|
|
if (nacp == nullptr) {
|
2018-08-09 18:06:44 -07:00
|
|
|
return ResultStatus::ErrorNoControl;
|
2018-07-23 14:24:27 -07:00
|
|
|
}
|
|
|
|
|
2018-07-23 09:33:24 -07:00
|
|
|
out_program_id = nacp->GetTitleId();
|
|
|
|
return ResultStatus::Success;
|
|
|
|
}
|
|
|
|
|
|
|
|
ResultStatus AppLoader_NRO::ReadRomFS(FileSys::VirtualFile& dir) {
|
2018-07-23 14:24:27 -07:00
|
|
|
if (romfs == nullptr) {
|
2018-08-09 18:06:44 -07:00
|
|
|
return ResultStatus::ErrorNoRomFS;
|
2018-07-23 14:24:27 -07:00
|
|
|
}
|
|
|
|
|
2018-07-23 09:33:24 -07:00
|
|
|
dir = romfs;
|
|
|
|
return ResultStatus::Success;
|
|
|
|
}
|
|
|
|
|
|
|
|
ResultStatus AppLoader_NRO::ReadTitle(std::string& title) {
|
2018-07-23 14:24:27 -07:00
|
|
|
if (nacp == nullptr) {
|
2018-08-09 18:06:44 -07:00
|
|
|
return ResultStatus::ErrorNoControl;
|
2018-07-23 14:24:27 -07:00
|
|
|
}
|
|
|
|
|
2018-07-23 09:33:24 -07:00
|
|
|
title = nacp->GetApplicationName();
|
|
|
|
return ResultStatus::Success;
|
|
|
|
}
|
2018-08-25 16:05:04 -07:00
|
|
|
|
2019-09-07 14:40:21 -07:00
|
|
|
ResultStatus AppLoader_NRO::ReadControlData(FileSys::NACP& control) {
|
|
|
|
if (nacp == nullptr) {
|
|
|
|
return ResultStatus::ErrorNoControl;
|
|
|
|
}
|
|
|
|
|
|
|
|
control = *nacp;
|
|
|
|
return ResultStatus::Success;
|
|
|
|
}
|
|
|
|
|
2018-08-26 07:53:31 -07:00
|
|
|
bool AppLoader_NRO::IsRomFSUpdatable() const {
|
2018-08-25 16:05:04 -07:00
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
2017-10-05 20:30:08 -07:00
|
|
|
} // namespace Loader
|