// Copyright 2014 Citra Emulator Project // Licensed under GPLv2 or any later version // Refer to the license.txt file included. #pragma once #include #include "common/bit_field.h" #include "common/common_types.h" #include "common/swap.h" #include "core/loader/loader.h" //////////////////////////////////////////////////////////////////////////////////////////////////// /// NCCH header (Note: "NCCH" appears to be a publically unknown acronym) struct NCCH_Header { u8 signature[0x100]; u32 magic; u32 content_size; u8 partition_id[8]; u16 maker_code; u16 version; u8 reserved_0[4]; u8 program_id[8]; u8 reserved_1[0x10]; u8 logo_region_hash[0x20]; 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; u32 logo_region_offset; u32 logo_region_size; u32 exefs_offset; u32 exefs_size; u32 exefs_hash_region_size; u8 reserved_3[4]; u32 romfs_offset; u32 romfs_size; u32 romfs_hash_region_size; u8 reserved_4[4]; u8 exefs_super_block_hash[0x20]; u8 romfs_super_block_hash[0x20]; }; static_assert(sizeof(NCCH_Header) == 0x200, "NCCH header structure size is wrong"); //////////////////////////////////////////////////////////////////////////////////////////////////// // ExeFS (executable file system) headers struct ExeFs_SectionHeader { char name[8]; u32 offset; u32 size; }; struct ExeFs_Header { ExeFs_SectionHeader section[8]; u8 reserved[0x80]; u8 hashes[8][0x20]; }; //////////////////////////////////////////////////////////////////////////////////////////////////// // ExHeader (executable file system header) headers struct ExHeader_SystemInfoFlags { u8 reserved[5]; u8 flag; u8 remaster_version[2]; }; struct ExHeader_CodeSegmentInfo { u32 address; u32 num_max_pages; u32 code_size; }; struct ExHeader_CodeSetInfo { u8 name[8]; ExHeader_SystemInfoFlags flags; ExHeader_CodeSegmentInfo text; u32 stack_size; ExHeader_CodeSegmentInfo ro; u8 reserved[4]; ExHeader_CodeSegmentInfo data; u32 bss_size; }; struct ExHeader_DependencyList { u8 program_id[0x30][8]; }; struct ExHeader_SystemInfo { u64 save_data_size; 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]; u32 core_version; u8 reserved_flags[2]; union { u8 flags0; BitField<0, 2, u8> ideal_processor; BitField<2, 2, u8> affinity_mask; BitField<4, 4, u8> system_mode; }; u8 priority; u8 resource_limit_descriptor[0x10][2]; ExHeader_StorageInfo storage_info; u8 service_access_control[0x20][8]; u8 ex_service_access_control[0x2][8]; u8 reserved[0xf]; u8 resource_limit_category; }; struct ExHeader_ARM11_KernelCaps { u32_le descriptors[28]; 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; }; static_assert(sizeof(ExHeader_Header) == 0x800, "ExHeader structure size is wrong"); //////////////////////////////////////////////////////////////////////////////////////////////////// // Loader namespace namespace Loader { /// Loads an NCCH file (e.g. from a CCI, or the first NCCH in a CXI) class AppLoader_NCCH final : public AppLoader { public: AppLoader_NCCH(FileUtil::IOFile&& file, const std::string& filepath) : AppLoader(std::move(file)), filepath(filepath) { } /** * Returns the type of the file * @param file FileUtil::IOFile open file * @return FileType found, or FileType::Error if this loader doesn't know it */ static FileType IdentifyType(FileUtil::IOFile& file); /** * Load the application * @return ResultStatus result of function */ ResultStatus Load() override; /** * Get the code (typically .code section) of the application * @param buffer Reference to buffer to store data * @return ResultStatus result of function */ ResultStatus ReadCode(std::vector& buffer) override; /** * Get the icon (typically icon section) of the application * @param buffer Reference to buffer to store data * @return ResultStatus result of function */ ResultStatus ReadIcon(std::vector& buffer) override; /** * Get the banner (typically banner section) of the application * @param buffer Reference to buffer to store data * @return ResultStatus result of function */ ResultStatus ReadBanner(std::vector& buffer) override; /** * Get the logo (typically logo section) of the application * @param buffer Reference to buffer to store data * @return ResultStatus result of function */ ResultStatus ReadLogo(std::vector& buffer) override; /** * Get the RomFS of the application * @param buffer Reference to buffer to store data * @return ResultStatus result of function */ ResultStatus ReadRomFS(std::shared_ptr& romfs_file, u64& offset, u64& size) override; private: /** * Reads an application ExeFS section of an NCCH file into AppLoader (e.g. .code, .logo, etc.) * @param name Name of section to read out of NCCH file * @param buffer Vector to read data into * @return ResultStatus result of function */ ResultStatus LoadSectionExeFS(const char* name, std::vector& buffer); /** * Loads .code section into memory for booting * @return ResultStatus result of function */ ResultStatus LoadExec(); bool is_compressed = false; u32 entry_point = 0; u32 code_size = 0; u32 stack_size = 0; u32 bss_size = 0; u32 core_version = 0; u8 priority = 0; u8 resource_limit_category = 0; u32 ncch_offset = 0; // Offset to NCCH header, can be 0 or after NCSD header u32 exefs_offset = 0; NCCH_Header ncch_header; ExeFs_Header exefs_header; ExHeader_Header exheader_header; std::string filepath; }; } // namespace Loader