2014-04-08 16:15:46 -07:00
|
|
|
// Copyright 2014 Citra Emulator Project
|
2014-12-16 21:38:14 -08:00
|
|
|
// Licensed under GPLv2 or any later version
|
2014-04-08 16:15:46 -07:00
|
|
|
// Refer to the license.txt file included.
|
2013-09-19 20:21:22 -07:00
|
|
|
|
2014-04-08 16:15:46 -07:00
|
|
|
#pragma once
|
2013-09-19 20:21:22 -07:00
|
|
|
|
2015-06-21 06:58:59 -07:00
|
|
|
#include <algorithm>
|
|
|
|
#include <initializer_list>
|
2015-06-21 05:40:28 -07:00
|
|
|
#include <memory>
|
2015-06-21 06:58:59 -07:00
|
|
|
#include <string>
|
2017-03-08 17:21:31 -08:00
|
|
|
#include <utility>
|
2014-06-18 15:58:09 -07:00
|
|
|
#include <vector>
|
2016-11-26 20:13:40 -08:00
|
|
|
#include <boost/optional.hpp>
|
2015-05-06 00:06:12 -07:00
|
|
|
#include "common/common_types.h"
|
2015-01-06 13:30:40 -08:00
|
|
|
#include "common/file_util.h"
|
2013-09-19 20:21:22 -07:00
|
|
|
|
2015-06-21 06:58:59 -07:00
|
|
|
namespace Kernel {
|
|
|
|
struct AddressMapping;
|
|
|
|
}
|
2015-05-03 20:01:16 -07:00
|
|
|
|
2013-09-19 20:21:22 -07:00
|
|
|
////////////////////////////////////////////////////////////////////////////////////////////////////
|
2014-06-16 20:18:10 -07:00
|
|
|
// Loader namespace
|
2013-09-19 20:21:22 -07:00
|
|
|
|
|
|
|
namespace Loader {
|
|
|
|
|
2014-06-18 15:58:09 -07:00
|
|
|
/// File types supported by CTR
|
|
|
|
enum class FileType {
|
|
|
|
Error,
|
|
|
|
Unknown,
|
|
|
|
CCI,
|
|
|
|
CXI,
|
|
|
|
CIA,
|
|
|
|
ELF,
|
2016-09-17 17:38:01 -07:00
|
|
|
THREEDSX, // 3DSX
|
2014-06-18 15:58:09 -07:00
|
|
|
};
|
|
|
|
|
2015-08-31 18:28:37 -07:00
|
|
|
/**
|
|
|
|
* Identifies the type of a bootable file based on the magic value in its header.
|
|
|
|
* @param file open file
|
|
|
|
* @return FileType of file
|
|
|
|
*/
|
|
|
|
FileType IdentifyFile(FileUtil::IOFile& file);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Identifies the type of a bootable file based on the magic value in its header.
|
|
|
|
* @param file_name path to file
|
|
|
|
* @return FileType of file. Note: this will return FileType::Unknown if it is unable to determine
|
|
|
|
* a filetype, and will never return FileType::Error.
|
|
|
|
*/
|
|
|
|
FileType IdentifyFile(const std::string& file_name);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Guess the type of a bootable file from its extension
|
|
|
|
* @param extension String extension of bootable file
|
|
|
|
* @return FileType of file. Note: this will return FileType::Unknown if it is unable to determine
|
|
|
|
* a filetype, and will never return FileType::Error.
|
|
|
|
*/
|
2017-02-26 17:58:51 -08:00
|
|
|
FileType GuessFromExtension(const std::string& extension);
|
2015-08-31 18:28:37 -07:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Convert a FileType into a string which can be displayed to the user.
|
|
|
|
*/
|
|
|
|
const char* GetFileTypeString(FileType type);
|
|
|
|
|
2014-06-18 15:58:09 -07:00
|
|
|
/// Return type for functions in Loader namespace
|
|
|
|
enum class ResultStatus {
|
|
|
|
Success,
|
|
|
|
Error,
|
|
|
|
ErrorInvalidFormat,
|
|
|
|
ErrorNotImplemented,
|
|
|
|
ErrorNotLoaded,
|
2014-06-18 20:53:22 -07:00
|
|
|
ErrorNotUsed,
|
2014-06-18 15:58:09 -07:00
|
|
|
ErrorAlreadyLoaded,
|
2014-07-04 17:32:06 -07:00
|
|
|
ErrorMemoryAllocationFailed,
|
2015-10-10 18:50:10 -07:00
|
|
|
ErrorEncrypted,
|
2014-06-18 15:58:09 -07:00
|
|
|
};
|
|
|
|
|
2016-03-21 00:28:22 -07:00
|
|
|
constexpr u32 MakeMagic(char a, char b, char c, char d) {
|
2015-01-06 15:10:13 -08:00
|
|
|
return a | b << 8 | c << 16 | d << 24;
|
|
|
|
}
|
|
|
|
|
2014-06-18 15:58:09 -07:00
|
|
|
/// Interface for loading an application
|
|
|
|
class AppLoader : NonCopyable {
|
|
|
|
public:
|
2016-09-18 18:01:46 -07:00
|
|
|
AppLoader(FileUtil::IOFile&& file) : file(std::move(file)) {}
|
|
|
|
virtual ~AppLoader() {}
|
2014-06-18 15:58:09 -07:00
|
|
|
|
2016-05-17 15:30:44 -07:00
|
|
|
/**
|
|
|
|
* Returns the type of this file
|
|
|
|
* @return FileType corresponding to the loaded file
|
|
|
|
*/
|
|
|
|
virtual FileType GetFileType() = 0;
|
|
|
|
|
2014-06-18 15:58:09 -07:00
|
|
|
/**
|
|
|
|
* Load the application
|
|
|
|
* @return ResultStatus result of function
|
|
|
|
*/
|
2014-06-19 14:46:05 -07:00
|
|
|
virtual ResultStatus Load() = 0;
|
2014-06-18 15:58:09 -07:00
|
|
|
|
2016-11-19 17:40:04 -08:00
|
|
|
/**
|
|
|
|
* Loads the system mode that this application needs.
|
2016-11-26 20:13:40 -08:00
|
|
|
* This function defaults to 2 (96MB allocated to the application) if it can't read the
|
|
|
|
* information.
|
2017-04-12 22:18:54 -07:00
|
|
|
* @returns a pair of Optional with the kernel system mode and ResultStatus.
|
2016-11-19 17:40:04 -08:00
|
|
|
*/
|
2017-03-08 17:21:31 -08:00
|
|
|
virtual std::pair<boost::optional<u32>, ResultStatus> LoadKernelSystemMode() {
|
2016-11-26 20:13:40 -08:00
|
|
|
// 96MB allocated to the application.
|
2017-03-08 17:21:31 -08:00
|
|
|
return std::make_pair(2, ResultStatus::Success);
|
2016-11-19 17:40:04 -08:00
|
|
|
}
|
|
|
|
|
2014-06-18 15:58:09 -07:00
|
|
|
/**
|
|
|
|
* Get the code (typically .code section) of the application
|
2014-06-27 12:33:23 -07:00
|
|
|
* @param buffer Reference to buffer to store data
|
|
|
|
* @return ResultStatus result of function
|
2014-06-18 15:58:09 -07:00
|
|
|
*/
|
2015-07-11 15:16:33 -07:00
|
|
|
virtual ResultStatus ReadCode(std::vector<u8>& buffer) {
|
2014-06-27 12:33:23 -07:00
|
|
|
return ResultStatus::ErrorNotImplemented;
|
2014-06-18 15:58:09 -07:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2014-06-22 12:40:21 -07:00
|
|
|
* Get the icon (typically icon section) of the application
|
2014-06-27 12:33:23 -07:00
|
|
|
* @param buffer Reference to buffer to store data
|
|
|
|
* @return ResultStatus result of function
|
2014-06-18 15:58:09 -07:00
|
|
|
*/
|
2015-07-11 15:16:33 -07:00
|
|
|
virtual ResultStatus ReadIcon(std::vector<u8>& buffer) {
|
2014-06-27 12:33:23 -07:00
|
|
|
return ResultStatus::ErrorNotImplemented;
|
2014-06-18 15:58:09 -07:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2014-06-22 12:40:21 -07:00
|
|
|
* Get the banner (typically banner section) of the application
|
2014-06-27 12:33:23 -07:00
|
|
|
* @param buffer Reference to buffer to store data
|
|
|
|
* @return ResultStatus result of function
|
2014-06-18 15:58:09 -07:00
|
|
|
*/
|
2015-07-11 15:16:33 -07:00
|
|
|
virtual ResultStatus ReadBanner(std::vector<u8>& buffer) {
|
2014-06-27 12:33:23 -07:00
|
|
|
return ResultStatus::ErrorNotImplemented;
|
2014-06-18 15:58:09 -07:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2014-06-22 12:40:21 -07:00
|
|
|
* Get the logo (typically logo section) of the application
|
2014-06-27 12:33:23 -07:00
|
|
|
* @param buffer Reference to buffer to store data
|
|
|
|
* @return ResultStatus result of function
|
2014-06-18 15:58:09 -07:00
|
|
|
*/
|
2015-07-11 15:16:33 -07:00
|
|
|
virtual ResultStatus ReadLogo(std::vector<u8>& buffer) {
|
2014-06-27 12:33:23 -07:00
|
|
|
return ResultStatus::ErrorNotImplemented;
|
2014-06-18 15:58:09 -07:00
|
|
|
}
|
2013-09-19 20:21:22 -07:00
|
|
|
|
2016-12-15 01:54:25 -08:00
|
|
|
/**
|
|
|
|
* Get the program id of the application
|
|
|
|
* @param out_program_id Reference to store program id into
|
|
|
|
* @return ResultStatus result of function
|
|
|
|
*/
|
|
|
|
virtual ResultStatus ReadProgramId(u64& out_program_id) {
|
|
|
|
return ResultStatus::ErrorNotImplemented;
|
|
|
|
}
|
|
|
|
|
2014-06-18 15:58:09 -07:00
|
|
|
/**
|
2014-06-27 12:33:23 -07:00
|
|
|
* Get the RomFS of the application
|
2015-07-09 14:55:23 -07:00
|
|
|
* Since the RomFS can be huge, we return a file reference instead of copying to a buffer
|
|
|
|
* @param romfs_file The file containing the RomFS
|
|
|
|
* @param offset The offset the romfs begins on
|
|
|
|
* @param size The size of the romfs
|
2014-06-27 12:33:23 -07:00
|
|
|
* @return ResultStatus result of function
|
2014-06-18 15:58:09 -07:00
|
|
|
*/
|
2016-09-17 17:38:01 -07:00
|
|
|
virtual ResultStatus ReadRomFS(std::shared_ptr<FileUtil::IOFile>& romfs_file, u64& offset,
|
|
|
|
u64& size) {
|
2014-06-27 12:33:23 -07:00
|
|
|
return ResultStatus::ErrorNotImplemented;
|
2014-06-18 15:58:09 -07:00
|
|
|
}
|
2015-01-06 13:30:40 -08:00
|
|
|
|
|
|
|
protected:
|
2015-07-11 15:16:33 -07:00
|
|
|
FileUtil::IOFile file;
|
|
|
|
bool is_loaded = false;
|
2013-09-19 20:21:22 -07:00
|
|
|
};
|
|
|
|
|
2015-05-03 20:01:16 -07:00
|
|
|
/**
|
|
|
|
* Common address mappings found in most games, used for binary formats that don't have this
|
|
|
|
* information.
|
|
|
|
*/
|
2015-05-08 14:12:25 -07:00
|
|
|
extern const std::initializer_list<Kernel::AddressMapping> default_address_mappings;
|
2015-05-03 20:01:16 -07:00
|
|
|
|
2013-09-19 20:21:22 -07:00
|
|
|
/**
|
2016-05-17 15:06:33 -07:00
|
|
|
* Identifies a bootable file and return a suitable loader
|
2013-09-19 20:21:22 -07:00
|
|
|
* @param filename String filename of bootable file
|
2016-05-17 15:06:33 -07:00
|
|
|
* @return best loader for this file
|
2013-09-19 20:21:22 -07:00
|
|
|
*/
|
2016-05-18 14:06:50 -07:00
|
|
|
std::unique_ptr<AppLoader> GetLoader(const std::string& filename);
|
2013-09-19 20:21:22 -07:00
|
|
|
|
|
|
|
} // namespace
|