234 lines
8.2 KiB
C++
234 lines
8.2 KiB
C++
// Copyright 2018 yuzu emulator team
|
|
// Licensed under GPLv2 or any later version
|
|
// Refer to the license.txt file included.
|
|
|
|
#include <memory>
|
|
#include <ostream>
|
|
#include <string>
|
|
#include "common/file_util.h"
|
|
#include "common/logging/log.h"
|
|
#include "common/string_util.h"
|
|
#include "core/hle/kernel/process.h"
|
|
#include "core/loader/deconstructed_rom_directory.h"
|
|
#include "core/loader/elf.h"
|
|
#include "core/loader/nax.h"
|
|
#include "core/loader/nca.h"
|
|
#include "core/loader/nro.h"
|
|
#include "core/loader/nso.h"
|
|
#include "core/loader/nsp.h"
|
|
#include "core/loader/xci.h"
|
|
|
|
namespace Loader {
|
|
|
|
FileType IdentifyFile(FileSys::VirtualFile file) {
|
|
FileType type;
|
|
|
|
#define CHECK_TYPE(loader) \
|
|
type = AppLoader_##loader::IdentifyType(file); \
|
|
if (FileType::Error != type) \
|
|
return type;
|
|
|
|
CHECK_TYPE(DeconstructedRomDirectory)
|
|
CHECK_TYPE(ELF)
|
|
CHECK_TYPE(NSO)
|
|
CHECK_TYPE(NRO)
|
|
CHECK_TYPE(NCA)
|
|
CHECK_TYPE(XCI)
|
|
CHECK_TYPE(NAX)
|
|
CHECK_TYPE(NSP)
|
|
|
|
#undef CHECK_TYPE
|
|
|
|
return FileType::Unknown;
|
|
}
|
|
|
|
FileType GuessFromFilename(const std::string& name) {
|
|
if (name == "main")
|
|
return FileType::DeconstructedRomDirectory;
|
|
if (name == "00")
|
|
return FileType::NCA;
|
|
|
|
const std::string extension =
|
|
Common::ToLower(std::string(FileUtil::GetExtensionFromFilename(name)));
|
|
|
|
if (extension == "elf")
|
|
return FileType::ELF;
|
|
if (extension == "nro")
|
|
return FileType::NRO;
|
|
if (extension == "nso")
|
|
return FileType::NSO;
|
|
if (extension == "nca")
|
|
return FileType::NCA;
|
|
if (extension == "xci")
|
|
return FileType::XCI;
|
|
if (extension == "nsp")
|
|
return FileType::NSP;
|
|
|
|
return FileType::Unknown;
|
|
}
|
|
|
|
std::string GetFileTypeString(FileType type) {
|
|
switch (type) {
|
|
case FileType::ELF:
|
|
return "ELF";
|
|
case FileType::NRO:
|
|
return "NRO";
|
|
case FileType::NSO:
|
|
return "NSO";
|
|
case FileType::NCA:
|
|
return "NCA";
|
|
case FileType::XCI:
|
|
return "XCI";
|
|
case FileType::NAX:
|
|
return "NAX";
|
|
case FileType::NSP:
|
|
return "NSP";
|
|
case FileType::DeconstructedRomDirectory:
|
|
return "Directory";
|
|
case FileType::Error:
|
|
case FileType::Unknown:
|
|
break;
|
|
}
|
|
|
|
return "unknown";
|
|
}
|
|
|
|
constexpr std::array<const char*, 62> RESULT_MESSAGES{
|
|
"The operation completed successfully.",
|
|
"The loader requested to load is already loaded.",
|
|
"The operation is not implemented.",
|
|
"The loader is not initialized properly.",
|
|
"The NPDM file has a bad header.",
|
|
"The NPDM has a bad ACID header.",
|
|
"The NPDM has a bad ACI header,",
|
|
"The NPDM file has a bad file access control.",
|
|
"The NPDM has a bad file access header.",
|
|
"The NPDM has bad kernel capability descriptors.",
|
|
"The PFS/HFS partition has a bad header.",
|
|
"The PFS/HFS partition has incorrect size as determined by the header.",
|
|
"The NCA file has a bad header.",
|
|
"The general keyfile could not be found.",
|
|
"The NCA Header key could not be found.",
|
|
"The NCA Header key is incorrect or the header is invalid.",
|
|
"Support for NCA2-type NCAs is not implemented.",
|
|
"Support for NCA0-type NCAs is not implemented.",
|
|
"The titlekey for this Rights ID could not be found.",
|
|
"The titlekek for this crypto revision could not be found.",
|
|
"The Rights ID in the header is invalid.",
|
|
"The key area key for this application type and crypto revision could not be found.",
|
|
"The key area key is incorrect or the section header is invalid.",
|
|
"The titlekey and/or titlekek is incorrect or the section header is invalid.",
|
|
"The XCI file is missing a Program-type NCA.",
|
|
"The NCA file is not an application.",
|
|
"The ExeFS partition could not be found.",
|
|
"The XCI file has a bad header.",
|
|
"The XCI file is missing a partition.",
|
|
"The file could not be found or does not exist.",
|
|
"The game is missing a program metadata file (main.npdm).",
|
|
"The game uses the currently-unimplemented 32-bit architecture.",
|
|
"Unable to completely parse the kernel metadata when loading the emulated process",
|
|
"The RomFS could not be found.",
|
|
"The ELF file has incorrect size as determined by the header.",
|
|
"There was a general error loading the NRO into emulated memory.",
|
|
"There was a general error loading the NSO into emulated memory.",
|
|
"There is no icon available.",
|
|
"There is no control data available.",
|
|
"The NAX file has a bad header.",
|
|
"The NAX file has incorrect size as determined by the header.",
|
|
"The HMAC to generated the NAX decryption keys failed.",
|
|
"The HMAC to validate the NAX decryption keys failed.",
|
|
"The NAX key derivation failed.",
|
|
"The NAX file cannot be interpreted as an NCA file.",
|
|
"The NAX file has an incorrect path.",
|
|
"The SD seed could not be found or derived.",
|
|
"The SD KEK Source could not be found.",
|
|
"The AES KEK Generation Source could not be found.",
|
|
"The AES Key Generation Source could not be found.",
|
|
"The SD Save Key Source could not be found.",
|
|
"The SD NCA Key Source could not be found.",
|
|
"The NSP file is missing a Program-type NCA.",
|
|
"The BKTR-type NCA has a bad BKTR header.",
|
|
"The BKTR Subsection entry is not located immediately after the Relocation entry.",
|
|
"The BKTR Subsection entry is not at the end of the media block.",
|
|
"The BKTR-type NCA has a bad Relocation block.",
|
|
"The BKTR-type NCA has a bad Subsection block.",
|
|
"The BKTR-type NCA has a bad Relocation bucket.",
|
|
"The BKTR-type NCA has a bad Subsection bucket.",
|
|
"The BKTR-type NCA is missing the base RomFS.",
|
|
"The NSP or XCI does not contain an update in addition to the base game.",
|
|
};
|
|
|
|
std::ostream& operator<<(std::ostream& os, ResultStatus status) {
|
|
os << RESULT_MESSAGES.at(static_cast<std::size_t>(status));
|
|
return os;
|
|
}
|
|
|
|
AppLoader::AppLoader(FileSys::VirtualFile file) : file(std::move(file)) {}
|
|
AppLoader::~AppLoader() = default;
|
|
|
|
/**
|
|
* Get a loader for a file with a specific type
|
|
* @param file The file to load
|
|
* @param type The type of the file
|
|
* @param file the file to retrieve the loader for
|
|
* @param type the file type
|
|
* @return std::unique_ptr<AppLoader> a pointer to a loader object; nullptr for unsupported type
|
|
*/
|
|
static std::unique_ptr<AppLoader> GetFileLoader(FileSys::VirtualFile file, FileType type) {
|
|
switch (type) {
|
|
|
|
// Standard ELF file format.
|
|
case FileType::ELF:
|
|
return std::make_unique<AppLoader_ELF>(std::move(file));
|
|
|
|
// NX NSO file format.
|
|
case FileType::NSO:
|
|
return std::make_unique<AppLoader_NSO>(std::move(file));
|
|
|
|
// NX NRO file format.
|
|
case FileType::NRO:
|
|
return std::make_unique<AppLoader_NRO>(std::move(file));
|
|
|
|
// NX NCA (Nintendo Content Archive) file format.
|
|
case FileType::NCA:
|
|
return std::make_unique<AppLoader_NCA>(std::move(file));
|
|
|
|
// NX XCI (nX Card Image) file format.
|
|
case FileType::XCI:
|
|
return std::make_unique<AppLoader_XCI>(std::move(file));
|
|
|
|
// NX NAX (NintendoAesXts) file format.
|
|
case FileType::NAX:
|
|
return std::make_unique<AppLoader_NAX>(std::move(file));
|
|
|
|
// NX NSP (Nintendo Submission Package) file format
|
|
case FileType::NSP:
|
|
return std::make_unique<AppLoader_NSP>(std::move(file));
|
|
|
|
// NX deconstructed ROM directory.
|
|
case FileType::DeconstructedRomDirectory:
|
|
return std::make_unique<AppLoader_DeconstructedRomDirectory>(std::move(file));
|
|
|
|
default:
|
|
return nullptr;
|
|
}
|
|
}
|
|
|
|
std::unique_ptr<AppLoader> GetLoader(FileSys::VirtualFile file) {
|
|
FileType type = IdentifyFile(file);
|
|
FileType filename_type = GuessFromFilename(file->GetName());
|
|
|
|
// Special case: 00 is either a NCA or NAX.
|
|
if (type != filename_type && !(file->GetName() == "00" && type == FileType::NAX)) {
|
|
LOG_WARNING(Loader, "File {} has a different type than its extension.", file->GetName());
|
|
if (FileType::Unknown == type)
|
|
type = filename_type;
|
|
}
|
|
|
|
LOG_DEBUG(Loader, "Loading file {} as {}...", file->GetName(), GetFileTypeString(type));
|
|
|
|
return GetFileLoader(std::move(file), type);
|
|
}
|
|
|
|
} // namespace Loader
|