From 3577dd027ddbaa2517eacad700ed0768a1f4b518 Mon Sep 17 00:00:00 2001 From: bunnei Date: Mon, 16 Jun 2014 22:57:09 -0400 Subject: Loader: Added support for booting NCCH executables. NCCH: Fixed typo in printing NCCH filename. --- src/core/loader/ncch.cpp | 348 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 348 insertions(+) create mode 100644 src/core/loader/ncch.cpp (limited to 'src/core/loader/ncch.cpp') diff --git a/src/core/loader/ncch.cpp b/src/core/loader/ncch.cpp new file mode 100644 index 000000000..a01411e11 --- /dev/null +++ b/src/core/loader/ncch.cpp @@ -0,0 +1,348 @@ +// Copyright 2014 Citra Emulator Project +// Licensed under GPLv2 +// Refer to the license.txt file included. + +#include "common/file_util.h" + +#include "core/loader/ncch.h" +#include "core/hle/kernel/kernel.h" +#include "core/mem_map.h" + +//////////////////////////////////////////////////////////////////////////////////////////////////// +/// NCCH header (Note: "NCCH" appears to be a publically unknown acronym) + +struct NCCH_Header { + u8 signature[0x100]; + char magic[4]; + u32 content_size; + u8 partition_id[8]; + u16 maker_code; + u16 version; + u8 reserved_0[4]; + u8 program_id[8]; + u8 temp_flag; + u8 reserved_1[0x2f]; + u8 product_code[0x10]; + u8 extended_header_hash[0x20]; + u32 extended_header_size; + u8 reserved_2[4]; + u8 flags[8]; + u32 plain_region_offset; + u32 plain_region_size; + u8 reserved_3[8]; + u32 exefs_offset; + u32 exefs_size; + u32 exefs_hash_region_size; + u8 reserved_4[4]; + u32 romfs_offset; + u32 romfs_size; + u32 romfs_hash_region_size; + u8 reserved_5[4]; + u8 exefs_super_block_hash[0x20]; + u8 romfs_super_block_hash[0x20]; +}; + +//////////////////////////////////////////////////////////////////////////////////////////////////// +// ExeFS (executable file system) headers + +typedef struct { + char name[8]; + u32 offset; + u32 size; +} ExeFs_SectionHeader; + +typedef struct { + ExeFs_SectionHeader section[8]; + u8 reserved[0x80]; + u8 hashes[8][0x20]; +} ExeFs_Header; + +//////////////////////////////////////////////////////////////////////////////////////////////////// +// ExHeader (executable file system header) headers + +struct ExHeader_SystemInfoFlags{ + u8 reserved[5]; + u8 flag; + u8 remaster_version[2]; +} exheader_systeminfoflags; + +struct ExHeader_CodeSegmentInfo{ + u32 address; + u32 num_max_pages; + u32 code_size; +} exheader_codesegmentinfo; + +struct ExHeader_CodeSetInfo { + u8 name[8]; + ExHeader_SystemInfoFlags flags; + ExHeader_CodeSegmentInfo text; + u8 stacksize[4]; + ExHeader_CodeSegmentInfo ro; + u8 reserved[4]; + ExHeader_CodeSegmentInfo data; + u8 bsssize[4]; +}; + +struct ExHeader_DependencyList{ + u8 program_id[0x30][8]; +}; + +struct ExHeader_SystemInfo{ + u32 save_data_size; + u8 reserved[4]; + u8 jump_id[8]; + u8 reserved_2[0x30]; +}; + +struct ExHeader_StorageInfo{ + u8 ext_save_data_id[8]; + u8 system_save_data_id[8]; + u8 reserved[8]; + u8 access_info[7]; + u8 other_attributes; +}; + +struct ExHeader_ARM11_SystemLocalCaps{ + u8 program_id[8]; + u8 flags[8]; + u8 resource_limit_descriptor[0x10][2]; + ExHeader_StorageInfo storage_info; + u8 service_access_control[0x20][8]; + u8 reserved[0x1f]; + u8 resource_limit_category; +}; + +struct ExHeader_ARM11_KernelCaps{ + u8 descriptors[28][4]; + u8 reserved[0x10]; +}; + +struct ExHeader_ARM9_AccessControl{ + u8 descriptors[15]; + u8 descversion; +}; + +struct ExHeader_Header{ + ExHeader_CodeSetInfo codeset_info; + ExHeader_DependencyList dependency_list; + ExHeader_SystemInfo system_info; + ExHeader_ARM11_SystemLocalCaps arm11_system_local_caps; + ExHeader_ARM11_KernelCaps arm11_kernel_caps; + ExHeader_ARM9_AccessControl arm9_access_control; + struct { + u8 signature[0x100]; + u8 ncch_public_key_modulus[0x100]; + ExHeader_ARM11_SystemLocalCaps arm11_system_local_caps; + ExHeader_ARM11_KernelCaps arm11_kernel_caps; + ExHeader_ARM9_AccessControl arm9_access_control; + } access_desc; +}; + +//////////////////////////////////////////////////////////////////////////////////////////////////// +// Loader namespace + +namespace Loader { + +const int kExeFs_MaxSections = 8; ///< Maximum number of sections (files) in an ExeFs +const int kExeFs_BlockSize = 0x200; ///< Size of ExeFS blocks (in bytes) + +/** + * Get the decompressed size of an LZSS compressed ExeFS file + * @param buffer Buffer of compressed file + * @param size Size of compressed buffer + * @return Size of decompressed buffer + */ +u32 LZSS_GetDecompressedSize(u8* buffer, u32 size) { + u32 offset_size = *(u32*)(buffer + size - 4); + return offset_size + size; +} + +/** + * Decompress ExeFS file (compressed with LZSS) + * @param compressed Compressed buffer + * @param compressed_size Size of compressed buffer + * @param decompressed Decompressed buffer + * @param decompressed_size Size of decompressed buffer + * @param error_string String populated with error message on failure + * @return True on success, otherwise false + */ +bool LZSS_Decompress(u8* compressed, u32 compressed_size, u8* decompressed, u32 decompressed_size, + std::string* error_string) { + u8* footer = compressed + compressed_size - 8; + u32 buffer_top_and_bottom = *(u32*)footer; + u32 i, j; + u32 out = decompressed_size; + u32 index = compressed_size - ((buffer_top_and_bottom >> 24) & 0xFF); + u8 control; + u32 stop_index = compressed_size - (buffer_top_and_bottom & 0xFFFFFF); + + memset(decompressed, 0, decompressed_size); + memcpy(decompressed, compressed, compressed_size); + + while(index > stop_index) { + control = compressed[--index]; + + for(i = 0; i < 8; i++) { + if(index <= stop_index) + break; + if(index <= 0) + break; + if(out <= 0) + break; + + if(control & 0x80) { + if(index < 2) { + *error_string = "Compression out of bounds"; + return false; + } + index -= 2; + + u32 segment_offset = compressed[index] | (compressed[index + 1] << 8); + u32 segment_size = ((segment_offset >> 12) & 15) + 3; + segment_offset &= 0x0FFF; + segment_offset += 2; + + if(out < segment_size) { + *error_string = "Compression out of bounds"; + return false; + } + for(j = 0; j < segment_size; j++) { + u8 data; + if(out + segment_offset >= decompressed_size) { + *error_string = "Compression out of bounds"; + return false; + } + data = decompressed[out + segment_offset]; + decompressed[--out] = data; + } + } else { + if(out < 1) { + *error_string = "Compression out of bounds"; + return false; + } + decompressed[--out] = compressed[--index]; + } + control <<= 1; + } + } + return true; +} + +/** + * Load a data buffer into memory at the specified address + * @param addr Address to load memory into + * @param buffer Buffer of data to load into memory + * @param size Size of data to load into memory + * @todo Perhaps move this code somewhere more generic? + */ +void LoadBuffer(const u32 addr, const u8* const buffer, const int size) { + u32 *dst = (u32*)Memory::GetPointer(addr); + u32 *src = (u32*)buffer; + int size_aligned = (size + 3) / 4; + + for (int j = 0; j < size_aligned; j++) { + *dst++ = (*src++); + } + return; +} + +/** + * Loads an NCCH file (e.g. from a CCI, or the first NCCH in a CXI) + * @param filename String filename of NCCH file + * @param error_string Pointer to string to put error message if an error has occurred + * @todo Move NCSD parsing out of here and create a separate function for loading these + * @return True on success, otherwise false + */ +bool Load_NCCH(std::string& filename, std::string* error_string) { + INFO_LOG(LOADER, "Loading NCCH file %s...", filename.c_str()); + + File::IOFile file(filename, "rb"); + + if (file.IsOpen()) { + NCCH_Header ncch_header; + file.ReadBytes(&ncch_header, sizeof(NCCH_Header)); + + // Skip NCSD header and load first NCCH (NCSD is just a container of NCCH files)... + int ncch_off = 0; // Offset to NCCH header, can be 0 or after NCSD header + if (memcmp(&ncch_header.magic, "NCSD", 4) == 0) { + WARN_LOG(LOADER, "Only loading the first (bootable) NCCH within the NCSD file!"); + ncch_off = 0x4000; + file.Seek(ncch_off, 0); + file.ReadBytes(&ncch_header, sizeof(NCCH_Header)); + } + // Verify we are loading the correct file type... + if (memcmp(&ncch_header.magic, "NCCH", 4) != 0) { + *error_string = "Invalid NCCH magic number (likely incorrect file type)"; + return false; + } + // Read ExHeader + ExHeader_Header exheader_header; + file.ReadBytes(&exheader_header, sizeof(ExHeader_Header)); + + bool is_compressed = (exheader_header.codeset_info.flags.flag & 1) == 1; + + INFO_LOG(LOADER, "Name: %s", exheader_header.codeset_info.name); + INFO_LOG(LOADER, "Code compressed: %s", is_compressed ? "yes" : "no"); + + // Read ExeFS + u32 exefs_offset = ncch_header.exefs_offset * kExeFs_BlockSize; + u32 exefs_size = ncch_header.exefs_size * kExeFs_BlockSize; + + INFO_LOG(LOADER, "ExeFS offset: 0x%08X", exefs_offset); + INFO_LOG(LOADER, "ExeFS size: 0x%08X", exefs_size); + + ExeFs_Header exefs_header; + file.Seek(exefs_offset + ncch_off, 0); + file.ReadBytes(&exefs_header, sizeof(ExeFs_Header)); + + // Iterate through the ExeFs archive until we find the .code file... + for (int i = 0; i < kExeFs_MaxSections; i++) { + INFO_LOG(LOADER, "ExeFS section %d:", i); + INFO_LOG(LOADER, " name: %s", exefs_header.section[i].name); + INFO_LOG(LOADER, " offset: 0x%08X", exefs_header.section[i].offset); + INFO_LOG(LOADER, " size: 0x%08X", exefs_header.section[i].size); + + // Load the .code section (executable code)... + if (strcmp((char*) exefs_header.section[i].name, ".code") == 0) { + file.Seek(exefs_header.section[i].offset + exefs_offset + sizeof(ExeFs_Header) + + ncch_off, 0); + + u8* buffer = new u8[exefs_header.section[i].size]; + file.ReadBytes(buffer, exefs_header.section[i].size); + + // Load compressed executable... + if (i == 0 && is_compressed) { + u32 decompressed_size = LZSS_GetDecompressedSize(buffer, + exefs_header.section[i].size); + u8* decompressed_buffer = new u8[decompressed_size]; + + if (!LZSS_Decompress(buffer, exefs_header.section[i].size, decompressed_buffer, + decompressed_size, error_string)) { + return false; + } + // Load .code section into memory... + LoadBuffer(exheader_header.codeset_info.text.address, decompressed_buffer, + decompressed_size); + + delete[] decompressed_buffer; + + // Load uncompressed executable... + } else { + // Load .code section into memory... + LoadBuffer(exheader_header.codeset_info.text.address, buffer, + exefs_header.section[i].size); + } + delete[] buffer; + + // Setup kernel emulation to boot .code section... + Kernel::LoadExec(exheader_header.codeset_info.text.address); + + // No need to load the other files from ExeFS until we do something with them... + return true; + } + } + } + return false; +} + +} // namespace Loader -- cgit v1.2.3 From 79a48082e2c7b6e61f38b442a66147a4e46f2911 Mon Sep 17 00:00:00 2001 From: bunnei Date: Tue, 17 Jun 2014 06:30:14 -0400 Subject: NCCH: Changed decompression to load .code directly into memory rather than an intermediate buffer. --- src/core/loader/ncch.cpp | 12 +++--------- 1 file changed, 3 insertions(+), 9 deletions(-) (limited to 'src/core/loader/ncch.cpp') diff --git a/src/core/loader/ncch.cpp b/src/core/loader/ncch.cpp index a01411e11..23864d262 100644 --- a/src/core/loader/ncch.cpp +++ b/src/core/loader/ncch.cpp @@ -312,20 +312,14 @@ bool Load_NCCH(std::string& filename, std::string* error_string) { // Load compressed executable... if (i == 0 && is_compressed) { - u32 decompressed_size = LZSS_GetDecompressedSize(buffer, + u32 decompressed_size = LZSS_GetDecompressedSize(buffer, exefs_header.section[i].size); - u8* decompressed_buffer = new u8[decompressed_size]; - if (!LZSS_Decompress(buffer, exefs_header.section[i].size, decompressed_buffer, + if (!LZSS_Decompress(buffer, exefs_header.section[i].size, + Memory::GetPointer(exheader_header.codeset_info.text.address), decompressed_size, error_string)) { return false; } - // Load .code section into memory... - LoadBuffer(exheader_header.codeset_info.text.address, decompressed_buffer, - decompressed_size); - - delete[] decompressed_buffer; - // Load uncompressed executable... } else { // Load .code section into memory... -- cgit v1.2.3 From 7889cafc76ac99b8509fa3cd1558a09f8a7e5f91 Mon Sep 17 00:00:00 2001 From: bunnei Date: Wed, 18 Jun 2014 18:58:09 -0400 Subject: Loader: Implemented AppLoader interface for abstracting application loading. - Various cleanups/refactorings to Loader, ELF, and NCCH modules. - Added AppLoader interface to ELF and NCCH. - Updated Qt/GLFW frontends to check AppLoader ResultStatus. NCCH: Removed extra qualification typos. Loader: Removed unnecessary #include's. NCCH: Improved readability of memcmp statements. NCCH: Added missing space. Elf: Removed unnecessary usage of unique_ptr. Loader: Removed unnecessary usage of unique_ptr. --- src/core/loader/ncch.cpp | 308 ++++++++++++++++------------------------------- 1 file changed, 105 insertions(+), 203 deletions(-) (limited to 'src/core/loader/ncch.cpp') diff --git a/src/core/loader/ncch.cpp b/src/core/loader/ncch.cpp index 23864d262..765efcf65 100644 --- a/src/core/loader/ncch.cpp +++ b/src/core/loader/ncch.cpp @@ -2,142 +2,14 @@ // Licensed under GPLv2 // Refer to the license.txt file included. +#include + #include "common/file_util.h" #include "core/loader/ncch.h" #include "core/hle/kernel/kernel.h" #include "core/mem_map.h" -//////////////////////////////////////////////////////////////////////////////////////////////////// -/// NCCH header (Note: "NCCH" appears to be a publically unknown acronym) - -struct NCCH_Header { - u8 signature[0x100]; - char magic[4]; - u32 content_size; - u8 partition_id[8]; - u16 maker_code; - u16 version; - u8 reserved_0[4]; - u8 program_id[8]; - u8 temp_flag; - u8 reserved_1[0x2f]; - u8 product_code[0x10]; - u8 extended_header_hash[0x20]; - u32 extended_header_size; - u8 reserved_2[4]; - u8 flags[8]; - u32 plain_region_offset; - u32 plain_region_size; - u8 reserved_3[8]; - u32 exefs_offset; - u32 exefs_size; - u32 exefs_hash_region_size; - u8 reserved_4[4]; - u32 romfs_offset; - u32 romfs_size; - u32 romfs_hash_region_size; - u8 reserved_5[4]; - u8 exefs_super_block_hash[0x20]; - u8 romfs_super_block_hash[0x20]; -}; - -//////////////////////////////////////////////////////////////////////////////////////////////////// -// ExeFS (executable file system) headers - -typedef struct { - char name[8]; - u32 offset; - u32 size; -} ExeFs_SectionHeader; - -typedef struct { - ExeFs_SectionHeader section[8]; - u8 reserved[0x80]; - u8 hashes[8][0x20]; -} ExeFs_Header; - -//////////////////////////////////////////////////////////////////////////////////////////////////// -// ExHeader (executable file system header) headers - -struct ExHeader_SystemInfoFlags{ - u8 reserved[5]; - u8 flag; - u8 remaster_version[2]; -} exheader_systeminfoflags; - -struct ExHeader_CodeSegmentInfo{ - u32 address; - u32 num_max_pages; - u32 code_size; -} exheader_codesegmentinfo; - -struct ExHeader_CodeSetInfo { - u8 name[8]; - ExHeader_SystemInfoFlags flags; - ExHeader_CodeSegmentInfo text; - u8 stacksize[4]; - ExHeader_CodeSegmentInfo ro; - u8 reserved[4]; - ExHeader_CodeSegmentInfo data; - u8 bsssize[4]; -}; - -struct ExHeader_DependencyList{ - u8 program_id[0x30][8]; -}; - -struct ExHeader_SystemInfo{ - u32 save_data_size; - u8 reserved[4]; - u8 jump_id[8]; - u8 reserved_2[0x30]; -}; - -struct ExHeader_StorageInfo{ - u8 ext_save_data_id[8]; - u8 system_save_data_id[8]; - u8 reserved[8]; - u8 access_info[7]; - u8 other_attributes; -}; - -struct ExHeader_ARM11_SystemLocalCaps{ - u8 program_id[8]; - u8 flags[8]; - u8 resource_limit_descriptor[0x10][2]; - ExHeader_StorageInfo storage_info; - u8 service_access_control[0x20][8]; - u8 reserved[0x1f]; - u8 resource_limit_category; -}; - -struct ExHeader_ARM11_KernelCaps{ - u8 descriptors[28][4]; - u8 reserved[0x10]; -}; - -struct ExHeader_ARM9_AccessControl{ - u8 descriptors[15]; - u8 descversion; -}; - -struct ExHeader_Header{ - ExHeader_CodeSetInfo codeset_info; - ExHeader_DependencyList dependency_list; - ExHeader_SystemInfo system_info; - ExHeader_ARM11_SystemLocalCaps arm11_system_local_caps; - ExHeader_ARM11_KernelCaps arm11_kernel_caps; - ExHeader_ARM9_AccessControl arm9_access_control; - struct { - u8 signature[0x100]; - u8 ncch_public_key_modulus[0x100]; - ExHeader_ARM11_SystemLocalCaps arm11_system_local_caps; - ExHeader_ARM11_KernelCaps arm11_kernel_caps; - ExHeader_ARM9_AccessControl arm9_access_control; - } access_desc; -}; - //////////////////////////////////////////////////////////////////////////////////////////////////// // Loader namespace @@ -163,11 +35,9 @@ u32 LZSS_GetDecompressedSize(u8* buffer, u32 size) { * @param compressed_size Size of compressed buffer * @param decompressed Decompressed buffer * @param decompressed_size Size of decompressed buffer - * @param error_string String populated with error message on failure * @return True on success, otherwise false */ -bool LZSS_Decompress(u8* compressed, u32 compressed_size, u8* decompressed, u32 decompressed_size, - std::string* error_string) { +bool LZSS_Decompress(u8* compressed, u32 compressed_size, u8* decompressed, u32 decompressed_size) { u8* footer = compressed + compressed_size - 8; u32 buffer_top_and_bottom = *(u32*)footer; u32 i, j; @@ -191,8 +61,8 @@ bool LZSS_Decompress(u8* compressed, u32 compressed_size, u8* decompressed, u32 break; if(control & 0x80) { + // Check if compression is out of bounds if(index < 2) { - *error_string = "Compression out of bounds"; return false; } index -= 2; @@ -202,22 +72,22 @@ bool LZSS_Decompress(u8* compressed, u32 compressed_size, u8* decompressed, u32 segment_offset &= 0x0FFF; segment_offset += 2; + // Check if compression is out of bounds if(out < segment_size) { - *error_string = "Compression out of bounds"; return false; } for(j = 0; j < segment_size; j++) { u8 data; + // Check if compression is out of bounds if(out + segment_offset >= decompressed_size) { - *error_string = "Compression out of bounds"; return false; } data = decompressed[out + segment_offset]; decompressed[--out] = data; } } else { + // Check if compression is out of bounds if(out < 1) { - *error_string = "Compression out of bounds"; return false; } decompressed[--out] = compressed[--index]; @@ -228,34 +98,96 @@ bool LZSS_Decompress(u8* compressed, u32 compressed_size, u8* decompressed, u32 return true; } +//////////////////////////////////////////////////////////////////////////////////////////////////// +// AppLoader_NCCH class + +/// AppLoader_NCCH constructor +AppLoader_NCCH::AppLoader_NCCH(std::string& filename) { + this->filename = filename; + is_loaded = false; + is_compressed = false; + entry_point = 0; + ncch_offset = 0; + exefs_offset = 0; +} + +/// AppLoader_NCCH destructor +AppLoader_NCCH::~AppLoader_NCCH() { +} + /** - * Load a data buffer into memory at the specified address - * @param addr Address to load memory into - * @param buffer Buffer of data to load into memory - * @param size Size of data to load into memory - * @todo Perhaps move this code somewhere more generic? + * Loads .code section into memory for booting + * @return ResultStatus result of function */ -void LoadBuffer(const u32 addr, const u8* const buffer, const int size) { - u32 *dst = (u32*)Memory::GetPointer(addr); - u32 *src = (u32*)buffer; - int size_aligned = (size + 3) / 4; +const ResultStatus AppLoader_NCCH::LoadExec() const { + if (!is_loaded) + return ResultStatus::ErrorNotLoaded; - for (int j = 0; j < size_aligned; j++) { - *dst++ = (*src++); + for (std::vector::size_type i = 0; i != code.size(); i++) { + Memory::Write8(entry_point + i, code[i]); } - return; + Kernel::LoadExec(entry_point); + + return ResultStatus::Success; } +/** + * Reads an application section of an NCCH file into AppLoader (e.g. .code, .logo, etc.) + * @param file Handle to file to read from + * @param name Name of section to read out of NCCH file + * @param buffer Buffer to read section into. + */ +const ResultStatus AppLoader_NCCH::LoadSection(File::IOFile& file, const char* name, + std::vector& buffer) { + // Iterate through the ExeFs archive until we find the .code file... + for (int i = 0; i < kExeFs_MaxSections; i++) { + INFO_LOG(LOADER, "ExeFS section %d:", i); + INFO_LOG(LOADER, " name: %s", exefs_header.section[i].name); + INFO_LOG(LOADER, " offset: 0x%08X", exefs_header.section[i].offset); + INFO_LOG(LOADER, " size: 0x%08X", exefs_header.section[i].size); + + // Load the .code section (executable code)... + if (strcmp((const char*)exefs_header.section[i].name, name) == 0) { + s64 section_offset = (exefs_header.section[i].offset + exefs_offset + + sizeof(ExeFs_Header) + ncch_offset); + file.Seek(section_offset, 0); + + // Section is compressed... + if (i == 0 && is_compressed) { + // Read compressed .code section... + std::unique_ptr temp_buffer(new u8[exefs_header.section[i].size]); + file.ReadBytes(&temp_buffer[0], exefs_header.section[i].size); + + // Decompress .code section... + u32 decompressed_size = LZSS_GetDecompressedSize(&temp_buffer[0], exefs_header.section[i].size); + buffer.resize(decompressed_size); + if (!LZSS_Decompress(&temp_buffer[0], exefs_header.section[i].size, &buffer[0], + decompressed_size)) { + return ResultStatus::ErrorInvalidFormat; + } + // Section is uncompressed... + } else { + buffer.resize(exefs_header.section[i].size); + file.ReadBytes(&buffer[0], exefs_header.section[i].size); + } + return ResultStatus::Success; + } + } + return ResultStatus::Error; +} + /** * Loads an NCCH file (e.g. from a CCI, or the first NCCH in a CXI) - * @param filename String filename of NCCH file * @param error_string Pointer to string to put error message if an error has occurred * @todo Move NCSD parsing out of here and create a separate function for loading these * @return True on success, otherwise false */ -bool Load_NCCH(std::string& filename, std::string* error_string) { +const ResultStatus AppLoader_NCCH::Load() { INFO_LOG(LOADER, "Loading NCCH file %s...", filename.c_str()); + if (is_loaded) + return ResultStatus::ErrorAlreadyLoaded; + File::IOFile file(filename, "rb"); if (file.IsOpen()) { @@ -263,80 +195,50 @@ bool Load_NCCH(std::string& filename, std::string* error_string) { file.ReadBytes(&ncch_header, sizeof(NCCH_Header)); // Skip NCSD header and load first NCCH (NCSD is just a container of NCCH files)... - int ncch_off = 0; // Offset to NCCH header, can be 0 or after NCSD header - if (memcmp(&ncch_header.magic, "NCSD", 4) == 0) { + if (0 == memcmp(&ncch_header.magic, "NCSD", 4)) { WARN_LOG(LOADER, "Only loading the first (bootable) NCCH within the NCSD file!"); - ncch_off = 0x4000; - file.Seek(ncch_off, 0); + ncch_offset = 0x4000; + file.Seek(ncch_offset, 0); file.ReadBytes(&ncch_header, sizeof(NCCH_Header)); } + // Verify we are loading the correct file type... - if (memcmp(&ncch_header.magic, "NCCH", 4) != 0) { - *error_string = "Invalid NCCH magic number (likely incorrect file type)"; - return false; - } + if (0 != memcmp(&ncch_header.magic, "NCCH", 4)) + return ResultStatus::ErrorInvalidFormat; + // Read ExHeader - ExHeader_Header exheader_header; file.ReadBytes(&exheader_header, sizeof(ExHeader_Header)); - bool is_compressed = (exheader_header.codeset_info.flags.flag & 1) == 1; + is_compressed = (exheader_header.codeset_info.flags.flag & 1) == 1; + entry_point = exheader_header.codeset_info.text.address; INFO_LOG(LOADER, "Name: %s", exheader_header.codeset_info.name); INFO_LOG(LOADER, "Code compressed: %s", is_compressed ? "yes" : "no"); + INFO_LOG(LOADER, "Entry point: 0x%08X", entry_point); // Read ExeFS - u32 exefs_offset = ncch_header.exefs_offset * kExeFs_BlockSize; + exefs_offset = ncch_header.exefs_offset * kExeFs_BlockSize; u32 exefs_size = ncch_header.exefs_size * kExeFs_BlockSize; INFO_LOG(LOADER, "ExeFS offset: 0x%08X", exefs_offset); INFO_LOG(LOADER, "ExeFS size: 0x%08X", exefs_size); - ExeFs_Header exefs_header; - file.Seek(exefs_offset + ncch_off, 0); + file.Seek(exefs_offset + ncch_offset, 0); file.ReadBytes(&exefs_header, sizeof(ExeFs_Header)); - // Iterate through the ExeFs archive until we find the .code file... - for (int i = 0; i < kExeFs_MaxSections; i++) { - INFO_LOG(LOADER, "ExeFS section %d:", i); - INFO_LOG(LOADER, " name: %s", exefs_header.section[i].name); - INFO_LOG(LOADER, " offset: 0x%08X", exefs_header.section[i].offset); - INFO_LOG(LOADER, " size: 0x%08X", exefs_header.section[i].size); - - // Load the .code section (executable code)... - if (strcmp((char*) exefs_header.section[i].name, ".code") == 0) { - file.Seek(exefs_header.section[i].offset + exefs_offset + sizeof(ExeFs_Header) + - ncch_off, 0); - - u8* buffer = new u8[exefs_header.section[i].size]; - file.ReadBytes(buffer, exefs_header.section[i].size); - - // Load compressed executable... - if (i == 0 && is_compressed) { - u32 decompressed_size = LZSS_GetDecompressedSize(buffer, - exefs_header.section[i].size); - - if (!LZSS_Decompress(buffer, exefs_header.section[i].size, - Memory::GetPointer(exheader_header.codeset_info.text.address), - decompressed_size, error_string)) { - return false; - } - // Load uncompressed executable... - } else { - // Load .code section into memory... - LoadBuffer(exheader_header.codeset_info.text.address, buffer, - exefs_header.section[i].size); - } - delete[] buffer; + // TODO(bunnei): Check ResultStatus here... + LoadSection(file, ".code", code); + LoadSection(file, ".icon", icon); + LoadSection(file, ".banner", banner); + LoadSection(file, ".logo", logo); - // Setup kernel emulation to boot .code section... - Kernel::LoadExec(exheader_header.codeset_info.text.address); + is_loaded = true; // Set state to loaded - // No need to load the other files from ExeFS until we do something with them... - return true; - } - } + LoadExec(); // Load the executable into memory for booting + + return ResultStatus::Success; } - return false; + return ResultStatus::Error; } } // namespace Loader -- cgit v1.2.3 From 3da2bc6830e05d943c4d131a3167c2df25bff344 Mon Sep 17 00:00:00 2001 From: bunnei Date: Wed, 18 Jun 2014 23:53:22 -0400 Subject: NCCH: Fixes reduce unnecessary logging and load logo/banner/etc. sections correctly. Loader: Added ErrorNotUsed ReturnStatus type to specify when something is not used. --- src/core/loader/ncch.cpp | 45 +++++++++++++++++++++++++-------------------- 1 file changed, 25 insertions(+), 20 deletions(-) (limited to 'src/core/loader/ncch.cpp') diff --git a/src/core/loader/ncch.cpp b/src/core/loader/ncch.cpp index 765efcf65..4cf805ba0 100644 --- a/src/core/loader/ncch.cpp +++ b/src/core/loader/ncch.cpp @@ -15,8 +15,8 @@ namespace Loader { -const int kExeFs_MaxSections = 8; ///< Maximum number of sections (files) in an ExeFs -const int kExeFs_BlockSize = 0x200; ///< Size of ExeFS blocks (in bytes) +static const int kMaxSections = 8; ///< Maximum number of sections (files) in an ExeFs +static const int kBlockSize = 0x200; ///< Size of ExeFS blocks (in bytes) /** * Get the decompressed size of an LZSS compressed ExeFS file @@ -132,22 +132,24 @@ const ResultStatus AppLoader_NCCH::LoadExec() const { } /** - * Reads an application section of an NCCH file into AppLoader (e.g. .code, .logo, etc.) + * Reads an application ExeFS section of an NCCH file into AppLoader (e.g. .code, .logo, etc.) * @param file Handle to file to read from * @param name Name of section to read out of NCCH file * @param buffer Buffer to read section into. */ -const ResultStatus AppLoader_NCCH::LoadSection(File::IOFile& file, const char* name, +const ResultStatus AppLoader_NCCH::LoadSectionExeFS(File::IOFile& file, const char* name, std::vector& buffer) { + // Iterate through the ExeFs archive until we find the .code file... - for (int i = 0; i < kExeFs_MaxSections; i++) { - INFO_LOG(LOADER, "ExeFS section %d:", i); - INFO_LOG(LOADER, " name: %s", exefs_header.section[i].name); - INFO_LOG(LOADER, " offset: 0x%08X", exefs_header.section[i].offset); - INFO_LOG(LOADER, " size: 0x%08X", exefs_header.section[i].size); + for (int i = 0; i < kMaxSections; i++) { - // Load the .code section (executable code)... + // Load the specified section... if (strcmp((const char*)exefs_header.section[i].name, name) == 0) { + INFO_LOG(LOADER, "ExeFS section %d:", i); + INFO_LOG(LOADER, " name: %s", exefs_header.section[i].name); + INFO_LOG(LOADER, " offset: 0x%08X", exefs_header.section[i].offset); + INFO_LOG(LOADER, " size: 0x%08X", exefs_header.section[i].size); + s64 section_offset = (exefs_header.section[i].offset + exefs_offset + sizeof(ExeFs_Header) + ncch_offset); file.Seek(section_offset, 0); @@ -173,7 +175,7 @@ const ResultStatus AppLoader_NCCH::LoadSection(File::IOFile& file, const char* n return ResultStatus::Success; } } - return ResultStatus::Error; + return ResultStatus::ErrorNotUsed; } /** @@ -206,7 +208,8 @@ const ResultStatus AppLoader_NCCH::Load() { if (0 != memcmp(&ncch_header.magic, "NCCH", 4)) return ResultStatus::ErrorInvalidFormat; - // Read ExHeader + // Read ExHeader... + file.ReadBytes(&exheader_header, sizeof(ExHeader_Header)); is_compressed = (exheader_header.codeset_info.flags.flag & 1) == 1; @@ -216,9 +219,10 @@ const ResultStatus AppLoader_NCCH::Load() { INFO_LOG(LOADER, "Code compressed: %s", is_compressed ? "yes" : "no"); INFO_LOG(LOADER, "Entry point: 0x%08X", entry_point); - // Read ExeFS - exefs_offset = ncch_header.exefs_offset * kExeFs_BlockSize; - u32 exefs_size = ncch_header.exefs_size * kExeFs_BlockSize; + // Read ExeFS... + + exefs_offset = ncch_header.exefs_offset * kBlockSize; + u32 exefs_size = ncch_header.exefs_size * kBlockSize; INFO_LOG(LOADER, "ExeFS offset: 0x%08X", exefs_offset); INFO_LOG(LOADER, "ExeFS size: 0x%08X", exefs_size); @@ -226,11 +230,12 @@ const ResultStatus AppLoader_NCCH::Load() { file.Seek(exefs_offset + ncch_offset, 0); file.ReadBytes(&exefs_header, sizeof(ExeFs_Header)); - // TODO(bunnei): Check ResultStatus here... - LoadSection(file, ".code", code); - LoadSection(file, ".icon", icon); - LoadSection(file, ".banner", banner); - LoadSection(file, ".logo", logo); + // TODO(bunnei): Check ResultStatus of these... + + LoadSectionExeFS(file, ".code", code); + LoadSectionExeFS(file, "banner", banner); + LoadSectionExeFS(file, "icon", icon); + LoadSectionExeFS(file, "logo", logo); is_loaded = true; // Set state to loaded -- cgit v1.2.3 From a8c46485203d3ab00ef478bbf9daa7450df14dfd Mon Sep 17 00:00:00 2001 From: bunnei Date: Thu, 19 Jun 2014 00:11:45 -0400 Subject: NCCH: Added RomFS loading. --- src/core/loader/ncch.cpp | 29 ++++++++++++++++++++++++++++- 1 file changed, 28 insertions(+), 1 deletion(-) (limited to 'src/core/loader/ncch.cpp') diff --git a/src/core/loader/ncch.cpp b/src/core/loader/ncch.cpp index 4cf805ba0..6423da8f9 100644 --- a/src/core/loader/ncch.cpp +++ b/src/core/loader/ncch.cpp @@ -178,6 +178,32 @@ const ResultStatus AppLoader_NCCH::LoadSectionExeFS(File::IOFile& file, const ch return ResultStatus::ErrorNotUsed; } +/** + * Reads RomFS of an NCCH file into AppLoader + * @param file Handle to file to read from + * @return ResultStatus result of function + */ +const ResultStatus AppLoader_NCCH::LoadRomFS(File::IOFile& file) { + // Check if the NCCH has a RomFS... + if (ncch_header.romfs_offset != 0 && ncch_header.romfs_size != 0) { + u32 romfs_offset = ncch_offset + (ncch_header.romfs_offset * kBlockSize) + 0x1000; + u32 romfs_size = (ncch_header.romfs_size * kBlockSize) - 0x1000; + + INFO_LOG(LOADER, "RomFS offset: 0x%08X", romfs_offset); + INFO_LOG(LOADER, "RomFS size: 0x%08X", romfs_size); + + romfs.resize(romfs_size); + + file.Seek(romfs_offset, 0); + file.ReadBytes(&romfs[0], romfs_size); + + return ResultStatus::Success; + } else { + NOTICE_LOG(LOADER, "RomFS unused"); + } + return ResultStatus::ErrorNotUsed; +} + /** * Loads an NCCH file (e.g. from a CCI, or the first NCCH in a CXI) * @param error_string Pointer to string to put error message if an error has occurred @@ -193,7 +219,6 @@ const ResultStatus AppLoader_NCCH::Load() { File::IOFile file(filename, "rb"); if (file.IsOpen()) { - NCCH_Header ncch_header; file.ReadBytes(&ncch_header, sizeof(NCCH_Header)); // Skip NCSD header and load first NCCH (NCSD is just a container of NCCH files)... @@ -237,6 +262,8 @@ const ResultStatus AppLoader_NCCH::Load() { LoadSectionExeFS(file, "icon", icon); LoadSectionExeFS(file, "logo", logo); + LoadRomFS(file); + is_loaded = true; // Set state to loaded LoadExec(); // Load the executable into memory for booting -- cgit v1.2.3 From 62b444cd17c17e6f8009d87609b620bcb51b43bd Mon Sep 17 00:00:00 2001 From: bunnei Date: Thu, 19 Jun 2014 17:46:05 -0400 Subject: Loader: Refactored use of const. --- src/core/loader/ncch.cpp | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) (limited to 'src/core/loader/ncch.cpp') diff --git a/src/core/loader/ncch.cpp b/src/core/loader/ncch.cpp index 6423da8f9..a4922c2c0 100644 --- a/src/core/loader/ncch.cpp +++ b/src/core/loader/ncch.cpp @@ -102,7 +102,7 @@ bool LZSS_Decompress(u8* compressed, u32 compressed_size, u8* decompressed, u32 // AppLoader_NCCH class /// AppLoader_NCCH constructor -AppLoader_NCCH::AppLoader_NCCH(std::string& filename) { +AppLoader_NCCH::AppLoader_NCCH(const std::string& filename) { this->filename = filename; is_loaded = false; is_compressed = false; @@ -119,7 +119,7 @@ AppLoader_NCCH::~AppLoader_NCCH() { * Loads .code section into memory for booting * @return ResultStatus result of function */ -const ResultStatus AppLoader_NCCH::LoadExec() const { +ResultStatus AppLoader_NCCH::LoadExec() const { if (!is_loaded) return ResultStatus::ErrorNotLoaded; @@ -137,7 +137,7 @@ const ResultStatus AppLoader_NCCH::LoadExec() const { * @param name Name of section to read out of NCCH file * @param buffer Buffer to read section into. */ -const ResultStatus AppLoader_NCCH::LoadSectionExeFS(File::IOFile& file, const char* name, +ResultStatus AppLoader_NCCH::LoadSectionExeFS(File::IOFile& file, const char* name, std::vector& buffer) { // Iterate through the ExeFs archive until we find the .code file... @@ -183,7 +183,7 @@ const ResultStatus AppLoader_NCCH::LoadSectionExeFS(File::IOFile& file, const ch * @param file Handle to file to read from * @return ResultStatus result of function */ -const ResultStatus AppLoader_NCCH::LoadRomFS(File::IOFile& file) { +ResultStatus AppLoader_NCCH::LoadRomFS(File::IOFile& file) { // Check if the NCCH has a RomFS... if (ncch_header.romfs_offset != 0 && ncch_header.romfs_size != 0) { u32 romfs_offset = ncch_offset + (ncch_header.romfs_offset * kBlockSize) + 0x1000; @@ -210,7 +210,7 @@ const ResultStatus AppLoader_NCCH::LoadRomFS(File::IOFile& file) { * @todo Move NCSD parsing out of here and create a separate function for loading these * @return True on success, otherwise false */ -const ResultStatus AppLoader_NCCH::Load() { +ResultStatus AppLoader_NCCH::Load() { INFO_LOG(LOADER, "Loading NCCH file %s...", filename.c_str()); if (is_loaded) -- cgit v1.2.3 From a7f1c544909ee1034356666e04bea3a4b4609a95 Mon Sep 17 00:00:00 2001 From: bunnei Date: Sun, 22 Jun 2014 15:40:21 -0400 Subject: Loader: Refactored loading functions to only read data from binary if called. NCCH: Updated LoadExec to use Memory::WriteBlock function to load binary code. --- src/core/loader/ncch.cpp | 142 +++++++++++++++++++++++++++++------------------ 1 file changed, 89 insertions(+), 53 deletions(-) (limited to 'src/core/loader/ncch.cpp') diff --git a/src/core/loader/ncch.cpp b/src/core/loader/ncch.cpp index a4922c2c0..60505bdfa 100644 --- a/src/core/loader/ncch.cpp +++ b/src/core/loader/ncch.cpp @@ -113,36 +113,39 @@ AppLoader_NCCH::AppLoader_NCCH(const std::string& filename) { /// AppLoader_NCCH destructor AppLoader_NCCH::~AppLoader_NCCH() { + if (file.IsOpen()) + file.Close(); } /** * Loads .code section into memory for booting * @return ResultStatus result of function */ -ResultStatus AppLoader_NCCH::LoadExec() const { +ResultStatus AppLoader_NCCH::LoadExec() { if (!is_loaded) return ResultStatus::ErrorNotLoaded; - for (std::vector::size_type i = 0; i != code.size(); i++) { - Memory::Write8(entry_point + i, code[i]); + ResultStatus res; + code = ReadCode(res); + + if (ResultStatus::Success == res) { + Memory::WriteBlock(entry_point, &code[0], code.size()); + Kernel::LoadExec(entry_point); } - Kernel::LoadExec(entry_point); - - return ResultStatus::Success; + return res; } /** * Reads an application ExeFS section of an NCCH file into AppLoader (e.g. .code, .logo, etc.) - * @param file Handle to file to read from * @param name Name of section to read out of NCCH file - * @param buffer Buffer to read section into. + * @param buffer Vector to read data into + * @param error ResultStatus result of function + * @return Reference to buffer of data that was read */ -ResultStatus AppLoader_NCCH::LoadSectionExeFS(File::IOFile& file, const char* name, - std::vector& buffer) { - +const std::vector& AppLoader_NCCH::LoadSectionExeFS(const char* name, std::vector& buffer, + ResultStatus& error) { // Iterate through the ExeFs archive until we find the .code file... for (int i = 0; i < kMaxSections; i++) { - // Load the specified section... if (strcmp((const char*)exefs_header.section[i].name, name) == 0) { INFO_LOG(LOADER, "ExeFS section %d:", i); @@ -161,49 +164,27 @@ ResultStatus AppLoader_NCCH::LoadSectionExeFS(File::IOFile& file, const char* na file.ReadBytes(&temp_buffer[0], exefs_header.section[i].size); // Decompress .code section... - u32 decompressed_size = LZSS_GetDecompressedSize(&temp_buffer[0], exefs_header.section[i].size); + u32 decompressed_size = LZSS_GetDecompressedSize(&temp_buffer[0], + exefs_header.section[i].size); buffer.resize(decompressed_size); - if (!LZSS_Decompress(&temp_buffer[0], exefs_header.section[i].size, &buffer[0], + if (!LZSS_Decompress(&temp_buffer[0], exefs_header.section[i].size, &buffer[0], decompressed_size)) { - return ResultStatus::ErrorInvalidFormat; + error = ResultStatus::ErrorInvalidFormat; + return buffer; } // Section is uncompressed... } else { buffer.resize(exefs_header.section[i].size); file.ReadBytes(&buffer[0], exefs_header.section[i].size); } - return ResultStatus::Success; + error = ResultStatus::Success; + return buffer; } } - return ResultStatus::ErrorNotUsed; + error = ResultStatus::ErrorNotUsed; + return buffer; } -/** - * Reads RomFS of an NCCH file into AppLoader - * @param file Handle to file to read from - * @return ResultStatus result of function - */ -ResultStatus AppLoader_NCCH::LoadRomFS(File::IOFile& file) { - // Check if the NCCH has a RomFS... - if (ncch_header.romfs_offset != 0 && ncch_header.romfs_size != 0) { - u32 romfs_offset = ncch_offset + (ncch_header.romfs_offset * kBlockSize) + 0x1000; - u32 romfs_size = (ncch_header.romfs_size * kBlockSize) - 0x1000; - - INFO_LOG(LOADER, "RomFS offset: 0x%08X", romfs_offset); - INFO_LOG(LOADER, "RomFS size: 0x%08X", romfs_size); - - romfs.resize(romfs_size); - - file.Seek(romfs_offset, 0); - file.ReadBytes(&romfs[0], romfs_size); - - return ResultStatus::Success; - } else { - NOTICE_LOG(LOADER, "RomFS unused"); - } - return ResultStatus::ErrorNotUsed; -} - /** * Loads an NCCH file (e.g. from a CCI, or the first NCCH in a CXI) * @param error_string Pointer to string to put error message if an error has occurred @@ -216,7 +197,7 @@ ResultStatus AppLoader_NCCH::Load() { if (is_loaded) return ResultStatus::ErrorAlreadyLoaded; - File::IOFile file(filename, "rb"); + file = File::IOFile(filename, "rb"); if (file.IsOpen()) { file.ReadBytes(&ncch_header, sizeof(NCCH_Header)); @@ -255,15 +236,6 @@ ResultStatus AppLoader_NCCH::Load() { file.Seek(exefs_offset + ncch_offset, 0); file.ReadBytes(&exefs_header, sizeof(ExeFs_Header)); - // TODO(bunnei): Check ResultStatus of these... - - LoadSectionExeFS(file, ".code", code); - LoadSectionExeFS(file, "banner", banner); - LoadSectionExeFS(file, "icon", icon); - LoadSectionExeFS(file, "logo", logo); - - LoadRomFS(file); - is_loaded = true; // Set state to loaded LoadExec(); // Load the executable into memory for booting @@ -273,4 +245,68 @@ ResultStatus AppLoader_NCCH::Load() { return ResultStatus::Error; } +/** + * Get the code (typically .code section) of the application + * @param error ResultStatus result of function + * @return Reference to code buffer + */ +const std::vector& AppLoader_NCCH::ReadCode(ResultStatus& error) { + return LoadSectionExeFS(".code", code, error); +} + +/** + * Get the icon (typically icon section) of the application + * @param error ResultStatus result of function + * @return Reference to icon buffer + */ +const std::vector& AppLoader_NCCH::ReadIcon(ResultStatus& error) { + return LoadSectionExeFS("icon", icon, error); +} + +/** + * Get the banner (typically banner section) of the application + * @param error ResultStatus result of function + * @return Reference to banner buffer + */ +const std::vector& AppLoader_NCCH::ReadBanner(ResultStatus& error) { + return LoadSectionExeFS("banner", banner, error); +} + +/** + * Get the logo (typically logo section) of the application + * @param error ResultStatus result of function + * @return Reference to logo buffer + */ +const std::vector& AppLoader_NCCH::ReadLogo(ResultStatus& error) { + return LoadSectionExeFS("logo", logo, error); +} + +/** + * Get the RomFs archive of the application + * @param error ResultStatus result of function + * @return Reference to RomFs archive buffer + */ +const std::vector& AppLoader_NCCH::ReadRomFS(ResultStatus& error) { + // Check if the NCCH has a RomFS... + if (ncch_header.romfs_offset != 0 && ncch_header.romfs_size != 0) { + u32 romfs_offset = ncch_offset + (ncch_header.romfs_offset * kBlockSize) + 0x1000; + u32 romfs_size = (ncch_header.romfs_size * kBlockSize) - 0x1000; + + INFO_LOG(LOADER, "RomFS offset: 0x%08X", romfs_offset); + INFO_LOG(LOADER, "RomFS size: 0x%08X", romfs_size); + + romfs.resize(romfs_size); + + file.Seek(romfs_offset, 0); + file.ReadBytes(&romfs[0], romfs_size); + + error = ResultStatus::Success; + return romfs; + } else { + NOTICE_LOG(LOADER, "RomFS unused"); + } + error = ResultStatus::ErrorNotUsed; + return romfs; +} + } // namespace Loader -- cgit v1.2.3