2018-01-14 00:22:39 +03:00
|
|
|
// Copyright 2018 yuzu emulator team
|
2017-09-24 18:08:31 +03:00
|
|
|
// Licensed under GPLv2 or any later version
|
|
|
|
// Refer to the license.txt file included.
|
|
|
|
|
2018-02-14 08:57:06 +03:00
|
|
|
#include <cinttypes>
|
2017-09-24 18:08:31 +03:00
|
|
|
#include <vector>
|
|
|
|
#include <lz4.h>
|
2017-10-15 07:11:38 +03:00
|
|
|
#include "common/common_funcs.h"
|
2018-01-20 23:48:37 +03:00
|
|
|
#include "common/file_util.h"
|
2017-09-24 18:08:31 +03:00
|
|
|
#include "common/logging/log.h"
|
|
|
|
#include "common/swap.h"
|
2018-03-14 00:49:59 +03:00
|
|
|
#include "core/core.h"
|
2018-07-13 06:22:59 +03:00
|
|
|
#include "core/gdbstub/gdbstub.h"
|
2018-08-31 19:21:34 +03:00
|
|
|
#include "core/hle/kernel/kernel.h"
|
2017-09-24 18:08:31 +03:00
|
|
|
#include "core/hle/kernel/process.h"
|
2018-09-25 03:01:45 +03:00
|
|
|
#include "core/hle/kernel/vm_manager.h"
|
2017-09-24 18:08:31 +03:00
|
|
|
#include "core/loader/nso.h"
|
|
|
|
#include "core/memory.h"
|
|
|
|
|
|
|
|
namespace Loader {
|
|
|
|
|
|
|
|
struct NsoSegmentHeader {
|
|
|
|
u32_le offset;
|
|
|
|
u32_le location;
|
|
|
|
u32_le size;
|
2018-01-16 20:14:36 +03:00
|
|
|
union {
|
|
|
|
u32_le alignment;
|
|
|
|
u32_le bss_size;
|
|
|
|
};
|
2017-09-24 18:08:31 +03:00
|
|
|
};
|
|
|
|
static_assert(sizeof(NsoSegmentHeader) == 0x10, "NsoSegmentHeader has incorrect size.");
|
|
|
|
|
|
|
|
struct NsoHeader {
|
|
|
|
u32_le magic;
|
2018-09-21 07:39:30 +03:00
|
|
|
u32_le version;
|
|
|
|
INSERT_PADDING_WORDS(1);
|
|
|
|
u8 flags;
|
2017-09-30 21:15:09 +03:00
|
|
|
std::array<NsoSegmentHeader, 3> segments; // Text, RoData, Data (in that order)
|
|
|
|
u32_le bss_size;
|
|
|
|
INSERT_PADDING_BYTES(0x1c);
|
2017-09-24 18:08:31 +03:00
|
|
|
std::array<u32_le, 3> segments_compressed_size;
|
2018-09-21 07:39:30 +03:00
|
|
|
|
|
|
|
bool IsSegmentCompressed(size_t segment_num) const {
|
|
|
|
ASSERT_MSG(segment_num < 3, "Invalid segment {}", segment_num);
|
|
|
|
return ((flags >> segment_num) & 1);
|
|
|
|
}
|
2017-09-24 18:08:31 +03:00
|
|
|
};
|
|
|
|
static_assert(sizeof(NsoHeader) == 0x6c, "NsoHeader has incorrect size.");
|
2018-07-19 04:07:11 +03:00
|
|
|
static_assert(std::is_trivially_copyable_v<NsoHeader>, "NsoHeader isn't trivially copyable.");
|
2017-09-24 18:08:31 +03:00
|
|
|
|
2017-09-30 21:15:09 +03:00
|
|
|
struct ModHeader {
|
|
|
|
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
|
|
|
|
};
|
2017-10-06 06:30:08 +03:00
|
|
|
static_assert(sizeof(ModHeader) == 0x1c, "ModHeader has incorrect size.");
|
2017-09-30 21:15:09 +03:00
|
|
|
|
2018-07-19 04:07:11 +03:00
|
|
|
AppLoader_NSO::AppLoader_NSO(FileSys::VirtualFile file) : AppLoader(std::move(file)) {}
|
2018-01-20 23:48:37 +03:00
|
|
|
|
2018-07-19 04:07:11 +03:00
|
|
|
FileType AppLoader_NSO::IdentifyType(const FileSys::VirtualFile& file) {
|
2017-09-30 21:15:09 +03:00
|
|
|
u32 magic = 0;
|
2018-07-19 19:40:06 +03:00
|
|
|
if (file->ReadObject(&magic) != sizeof(magic)) {
|
|
|
|
return FileType::Error;
|
|
|
|
}
|
2017-09-30 21:15:09 +03:00
|
|
|
|
2018-07-19 19:40:06 +03:00
|
|
|
if (Common::MakeMagic('N', 'S', 'O', '0') != magic) {
|
|
|
|
return FileType::Error;
|
2017-09-30 21:15:09 +03:00
|
|
|
}
|
|
|
|
|
2018-07-19 19:40:06 +03:00
|
|
|
return FileType::NSO;
|
2017-09-30 21:15:09 +03:00
|
|
|
}
|
|
|
|
|
2018-06-21 18:16:23 +03:00
|
|
|
static std::vector<u8> DecompressSegment(const std::vector<u8>& compressed_data,
|
|
|
|
const NsoSegmentHeader& header) {
|
2018-07-19 03:24:33 +03:00
|
|
|
std::vector<u8> uncompressed_data(header.size);
|
2018-07-20 03:51:15 +03:00
|
|
|
const int bytes_uncompressed =
|
|
|
|
LZ4_decompress_safe(reinterpret_cast<const char*>(compressed_data.data()),
|
|
|
|
reinterpret_cast<char*>(uncompressed_data.data()),
|
|
|
|
static_cast<int>(compressed_data.size()), header.size);
|
2018-06-21 18:16:23 +03:00
|
|
|
|
2018-07-20 03:51:15 +03:00
|
|
|
ASSERT_MSG(bytes_uncompressed == static_cast<int>(header.size) &&
|
|
|
|
bytes_uncompressed == static_cast<int>(uncompressed_data.size()),
|
2018-06-21 18:16:23 +03:00
|
|
|
"{} != {} != {}", bytes_uncompressed, header.size, uncompressed_data.size());
|
|
|
|
|
|
|
|
return uncompressed_data;
|
|
|
|
}
|
|
|
|
|
2017-09-30 21:15:09 +03:00
|
|
|
static constexpr u32 PageAlignSize(u32 size) {
|
|
|
|
return (size + Memory::PAGE_MASK) & ~Memory::PAGE_MASK;
|
|
|
|
}
|
2017-09-24 18:08:31 +03:00
|
|
|
|
2018-07-19 04:07:11 +03:00
|
|
|
VAddr AppLoader_NSO::LoadModule(FileSys::VirtualFile file, VAddr load_base) {
|
|
|
|
if (file == nullptr)
|
2018-06-21 18:16:23 +03:00
|
|
|
return {};
|
|
|
|
|
2018-07-19 04:07:11 +03:00
|
|
|
if (file->GetSize() < sizeof(NsoHeader))
|
|
|
|
return {};
|
|
|
|
|
|
|
|
NsoHeader nso_header{};
|
|
|
|
if (sizeof(NsoHeader) != file->ReadObject(&nso_header))
|
|
|
|
return {};
|
2018-07-08 06:24:51 +03:00
|
|
|
|
|
|
|
if (nso_header.magic != Common::MakeMagic('N', 'S', 'O', '0'))
|
2018-06-21 18:16:23 +03:00
|
|
|
return {};
|
|
|
|
|
2018-07-08 06:24:51 +03:00
|
|
|
// Build program image
|
2018-08-28 19:30:33 +03:00
|
|
|
auto& kernel = Core::System::GetInstance().Kernel();
|
|
|
|
Kernel::SharedPtr<Kernel::CodeSet> codeset = Kernel::CodeSet::Create(kernel, "");
|
2018-07-08 06:24:51 +03:00
|
|
|
std::vector<u8> program_image;
|
2018-07-19 03:21:25 +03:00
|
|
|
for (std::size_t i = 0; i < nso_header.segments.size(); ++i) {
|
2018-09-21 07:39:30 +03:00
|
|
|
std::vector<u8> data =
|
2018-07-19 04:07:11 +03:00
|
|
|
file->ReadBytes(nso_header.segments_compressed_size[i], nso_header.segments[i].offset);
|
2018-09-21 07:39:30 +03:00
|
|
|
if (nso_header.IsSegmentCompressed(i)) {
|
|
|
|
data = DecompressSegment(data, nso_header.segments[i]);
|
|
|
|
}
|
2018-07-08 06:24:51 +03:00
|
|
|
program_image.resize(nso_header.segments[i].location);
|
|
|
|
program_image.insert(program_image.end(), data.begin(), data.end());
|
|
|
|
codeset->segments[i].addr = nso_header.segments[i].location;
|
|
|
|
codeset->segments[i].offset = nso_header.segments[i].location;
|
|
|
|
codeset->segments[i].size = PageAlignSize(static_cast<u32>(data.size()));
|
|
|
|
}
|
|
|
|
|
|
|
|
// MOD header pointer is at .text offset + 4
|
|
|
|
u32 module_offset;
|
|
|
|
std::memcpy(&module_offset, program_image.data() + 4, sizeof(u32));
|
|
|
|
|
|
|
|
// Read MOD header
|
|
|
|
ModHeader mod_header{};
|
|
|
|
// Default .bss to size in segment header if MOD0 section doesn't exist
|
|
|
|
u32 bss_size{PageAlignSize(nso_header.segments[2].bss_size)};
|
|
|
|
std::memcpy(&mod_header, program_image.data() + module_offset, sizeof(ModHeader));
|
|
|
|
const bool has_mod_header{mod_header.magic == Common::MakeMagic('M', 'O', 'D', '0')};
|
|
|
|
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-08-03 21:33:59 +03:00
|
|
|
codeset->DataSegment().size += bss_size;
|
2018-07-08 06:24:51 +03:00
|
|
|
const u32 image_size{PageAlignSize(static_cast<u32>(program_image.size()) + bss_size)};
|
|
|
|
program_image.resize(image_size);
|
|
|
|
|
|
|
|
// Load codeset for current process
|
2018-07-19 04:07:11 +03:00
|
|
|
codeset->name = file->GetName();
|
2018-07-08 06:24:51 +03:00
|
|
|
codeset->memory = std::make_shared<std::vector<u8>>(std::move(program_image));
|
|
|
|
Core::CurrentProcess()->LoadModule(codeset, load_base);
|
|
|
|
|
2018-07-13 06:22:59 +03:00
|
|
|
// Register module with GDBStub
|
|
|
|
GDBStub::RegisterModule(codeset->name, load_base, load_base);
|
|
|
|
|
2018-07-08 06:24:51 +03:00
|
|
|
return load_base + image_size;
|
|
|
|
}
|
|
|
|
|
2018-09-29 22:57:40 +03:00
|
|
|
ResultStatus AppLoader_NSO::Load(Kernel::Process& process) {
|
2017-09-30 21:15:09 +03:00
|
|
|
if (is_loaded) {
|
2017-09-24 18:08:31 +03:00
|
|
|
return ResultStatus::ErrorAlreadyLoaded;
|
2017-09-30 21:15:09 +03:00
|
|
|
}
|
2017-09-24 18:08:31 +03:00
|
|
|
|
2018-01-20 22:20:04 +03:00
|
|
|
// Load module
|
2018-09-29 22:57:40 +03:00
|
|
|
const VAddr base_address = process.vm_manager.GetCodeRegionBaseAddress();
|
2018-09-25 03:01:45 +03:00
|
|
|
LoadModule(file, base_address);
|
|
|
|
LOG_DEBUG(Loader, "loaded module {} @ 0x{:X}", file->GetName(), base_address);
|
2017-09-24 18:08:31 +03:00
|
|
|
|
2018-09-29 22:57:40 +03:00
|
|
|
process.Run(base_address, Kernel::THREADPRIO_DEFAULT, Memory::DEFAULT_STACK_SIZE);
|
2017-09-24 18:08:31 +03:00
|
|
|
|
|
|
|
is_loaded = true;
|
|
|
|
return ResultStatus::Success;
|
|
|
|
}
|
|
|
|
|
|
|
|
} // namespace Loader
|