summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorGravatar Zach Hilman2019-06-05 00:18:25 -0400
committerGravatar Zach Hilman2019-06-05 00:18:25 -0400
commit421c3e831ac76dbcd9ab0e1c3302572b5908caef (patch)
treef69bcb3c9ec1b4f42594a91e029689881168c503 /src
parentinput_common/sdl/sdl_impl: Silence sign conversion warnings (diff)
downloadyuzu-421c3e831ac76dbcd9ab0e1c3302572b5908caef.tar.gz
yuzu-421c3e831ac76dbcd9ab0e1c3302572b5908caef.tar.xz
yuzu-421c3e831ac76dbcd9ab0e1c3302572b5908caef.zip
file_sys: Add classes to parse KIP1 and INI1 files
Diffstat (limited to 'src')
-rw-r--r--src/core/CMakeLists.txt2
-rw-r--r--src/core/file_sys/kernel_executable.cpp229
-rw-r--r--src/core/file_sys/kernel_executable.h99
3 files changed, 330 insertions, 0 deletions
diff --git a/src/core/CMakeLists.txt b/src/core/CMakeLists.txt
index a56e526a6..623a44e0c 100644
--- a/src/core/CMakeLists.txt
+++ b/src/core/CMakeLists.txt
@@ -43,6 +43,8 @@ add_library(core STATIC
43 file_sys/fsmitm_romfsbuild.h 43 file_sys/fsmitm_romfsbuild.h
44 file_sys/ips_layer.cpp 44 file_sys/ips_layer.cpp
45 file_sys/ips_layer.h 45 file_sys/ips_layer.h
46 file_sys/kernel_executable.cpp
47 file_sys/kernel_executable.h
46 file_sys/mode.h 48 file_sys/mode.h
47 file_sys/nca_metadata.cpp 49 file_sys/nca_metadata.cpp
48 file_sys/nca_metadata.h 50 file_sys/nca_metadata.h
diff --git a/src/core/file_sys/kernel_executable.cpp b/src/core/file_sys/kernel_executable.cpp
new file mode 100644
index 000000000..0ddb9a60b
--- /dev/null
+++ b/src/core/file_sys/kernel_executable.cpp
@@ -0,0 +1,229 @@
1// Copyright 2019 yuzu emulator team
2// Licensed under GPLv2 or any later version
3// Refer to the license.txt file included.
4
5#include "common/string_util.h"
6#include "core/file_sys/kernel_executable.h"
7#include "core/file_sys/vfs_offset.h"
8
9namespace FileSys {
10
11constexpr u32 INI_MAX_KIPS = 0x50;
12
13namespace {
14bool DecompressBLZ(std::vector<u8>& data) {
15 if (data.size() < 0xC)
16 return {};
17
18 const auto data_size = data.size() - 0xC;
19
20 u32 compressed_size{};
21 u32 init_index{};
22 u32 additional_size{};
23 std::memcpy(&compressed_size, data.data() + data_size, sizeof(u32));
24 std::memcpy(&init_index, data.data() + data_size + 0x4, sizeof(u32));
25 std::memcpy(&additional_size, data.data() + data_size + 0x8, sizeof(u32));
26
27 const auto start_offset = data.size() - compressed_size;
28 data.resize(compressed_size + additional_size + start_offset);
29
30 std::size_t index = compressed_size - init_index;
31 std::size_t out_index = compressed_size + additional_size;
32
33 while (out_index > 0) {
34 --index;
35 auto control = data[index + start_offset];
36 for (size_t i = 0; i < 8; ++i) {
37 if ((control & 0x80) > 0) {
38 if (index < 2) {
39 return false;
40 }
41 index -= 2;
42 std::size_t segment_offset =
43 data[index + start_offset] | data[index + start_offset + 1] << 8;
44 std::size_t segment_size = ((segment_offset >> 12) & 0xF) + 3;
45 segment_offset &= 0xFFF;
46 segment_offset += 3;
47
48 if (out_index < segment_size)
49 segment_size = out_index;
50
51 if (out_index < segment_size) {
52 return false;
53 }
54
55 out_index -= segment_size;
56
57 for (size_t j = 0; j < segment_size; ++j) {
58 if (out_index + j + segment_offset + start_offset >= data.size()) {
59 return false;
60 }
61 data[out_index + j + start_offset] =
62 data[out_index + j + segment_offset + start_offset];
63 }
64 } else {
65 if (out_index < 1) {
66 return false;
67 }
68 --out_index;
69 --index;
70 data[out_index + start_offset] = data[index + start_offset];
71 }
72
73 control <<= 1;
74 if (out_index == 0)
75 return true;
76 }
77 }
78
79 return true;
80}
81} // Anonymous namespace
82
83KIP::KIP(const VirtualFile& file) : status(Loader::ResultStatus::Success) {
84 if (file == nullptr) {
85 status = Loader::ResultStatus::ErrorNullFile;
86 return;
87 }
88
89 if (file->GetSize() < sizeof(KIPHeader) || file->ReadObject(&header) != sizeof(KIPHeader)) {
90 status = Loader::ResultStatus::ErrorBadKIPHeader;
91 return;
92 }
93
94 if (header.magic != Common::MakeMagic('K', 'I', 'P', '1')) {
95 status = Loader::ResultStatus::ErrorBadKIPHeader;
96 return;
97 }
98
99 u64 offset = sizeof(KIPHeader);
100 for (std::size_t i = 0; i < header.sections.size(); ++i) {
101 auto compressed = file->ReadBytes(header.sections[i].compressed_size, offset);
102 offset += header.sections[i].compressed_size;
103
104 if (header.sections[i].compressed_size == 0 && header.sections[i].decompressed_size != 0) {
105 decompressed_sections[i] = std::vector<u8>(header.sections[i].decompressed_size);
106 } else if (header.sections[i].compressed_size == header.sections[i].decompressed_size) {
107 decompressed_sections[i] = std::move(compressed);
108 } else {
109 decompressed_sections[i] = compressed;
110 if (!DecompressBLZ(decompressed_sections[i])) {
111 status = Loader::ResultStatus::ErrorBLZDecompressionFailed;
112 return;
113 }
114 }
115 }
116}
117
118Loader::ResultStatus KIP::GetStatus() const {
119 return status;
120}
121
122std::string KIP::GetName() const {
123 return Common::StringFromFixedZeroTerminatedBuffer(header.name.data(), header.name.size());
124}
125
126u64 KIP::GetTitleID() const {
127 return header.title_id;
128}
129
130std::vector<u8> KIP::GetSectionDecompressed(u8 index) const {
131 return decompressed_sections[index];
132}
133
134bool KIP::Is64Bit() const {
135 return header.flags & 0x8;
136}
137
138bool KIP::Is39BitAddressSpace() const {
139 return header.flags & 0x10;
140}
141
142bool KIP::IsService() const {
143 return header.flags & 0x20;
144}
145
146std::vector<u32> KIP::GetKernelCapabilities() const {
147 return std::vector(header.capabilities.begin(), header.capabilities.end());
148}
149
150s32 KIP::GetMainThreadPriority() const {
151 return header.main_thread_priority;
152}
153
154u32 KIP::GetMainThreadStackSize() const {
155 return header.sections[1].attribute;
156}
157
158u32 KIP::GetMainThreadCpuCore() const {
159 return header.default_core;
160}
161
162const std::vector<u8>& KIP::GetTextSection() const {
163 return decompressed_sections[0];
164}
165
166const std::vector<u8>& KIP::GetRODataSection() const {
167 return decompressed_sections[1];
168}
169
170const std::vector<u8>& KIP::GetDataSection() const {
171 return decompressed_sections[2];
172}
173
174u32 KIP::GetTextOffset() const {
175 return header.sections[0].offset;
176}
177
178u32 KIP::GetRODataOffset() const {
179 return header.sections[1].offset;
180}
181
182u32 KIP::GetDataOffset() const {
183 return header.sections[2].offset;
184}
185
186u32 KIP::GetBSSSize() const {
187 return header.sections[3].decompressed_size;
188}
189
190u32 KIP::GetBSSOffset() const {
191 return header.sections[3].offset;
192}
193
194INI::INI(const VirtualFile& file) : status(Loader::ResultStatus::Success) {
195 if (file->GetSize() < sizeof(INIHeader) || file->ReadObject(&header) != sizeof(INIHeader)) {
196 status = Loader::ResultStatus::ErrorBadINIHeader;
197 return;
198 }
199
200 if (header.magic != Common::MakeMagic('I', 'N', 'I', '1')) {
201 status = Loader::ResultStatus::ErrorBadINIHeader;
202 return;
203 }
204
205 if (header.kip_count > INI_MAX_KIPS) {
206 status = Loader::ResultStatus::ErrorINITooManyKIPs;
207 return;
208 }
209
210 u64 offset = sizeof(INIHeader);
211 for (std::size_t i = 0; i < header.kip_count; ++i) {
212 const auto kip_file =
213 std::make_shared<OffsetVfsFile>(file, file->GetSize() - offset, offset);
214 KIP kip(kip_file);
215 if (kip.GetStatus() == Loader::ResultStatus::Success) {
216 kips.push_back(std::move(kip));
217 }
218 }
219}
220
221Loader::ResultStatus INI::GetStatus() const {
222 return status;
223}
224
225const std::vector<KIP>& INI::GetKIPs() const {
226 return kips;
227}
228
229} // namespace FileSys
diff --git a/src/core/file_sys/kernel_executable.h b/src/core/file_sys/kernel_executable.h
new file mode 100644
index 000000000..324a57384
--- /dev/null
+++ b/src/core/file_sys/kernel_executable.h
@@ -0,0 +1,99 @@
1// Copyright 2019 yuzu emulator team
2// Licensed under GPLv2 or any later version
3// Refer to the license.txt file included.
4
5#pragma once
6
7#include "common/common_funcs.h"
8#include "common/swap.h"
9#include "core/file_sys/vfs_types.h"
10#include "core/loader/loader.h"
11
12namespace FileSys {
13
14struct KIPSectionHeader {
15 u32_le offset;
16 u32_le decompressed_size;
17 u32_le compressed_size;
18 u32_le attribute;
19};
20static_assert(sizeof(KIPSectionHeader) == 0x10, "KIPSectionHeader has incorrect size.");
21
22struct KIPHeader {
23 u32_le magic;
24 std::array<char, 0xC> name;
25 u64_le title_id;
26 u32_le process_category;
27 u8 main_thread_priority;
28 u8 default_core;
29 INSERT_PADDING_BYTES(1);
30 u8 flags;
31 std::array<KIPSectionHeader, 6> sections;
32 std::array<u32, 0x20> capabilities;
33};
34static_assert(sizeof(KIPHeader) == 0x100, "KIPHeader has incorrect size.");
35
36struct INIHeader {
37 u32_le magic;
38 u32_le size;
39 u32_le kip_count;
40 INSERT_PADDING_BYTES(0x4);
41};
42static_assert(sizeof(INIHeader) == 0x10, "INIHeader has incorrect size.");
43
44// Kernel Internal Process
45class KIP {
46public:
47 explicit KIP(const VirtualFile& file);
48
49 Loader::ResultStatus GetStatus() const;
50
51 std::string GetName() const;
52 u64 GetTitleID() const;
53 std::vector<u8> GetSectionDecompressed(u8 index) const;
54
55 // Executable Flags
56 bool Is64Bit() const;
57 bool Is39BitAddressSpace() const;
58 bool IsService() const;
59
60 std::vector<u32> GetKernelCapabilities() const;
61
62 s32 GetMainThreadPriority() const;
63 u32 GetMainThreadStackSize() const;
64 u32 GetMainThreadCpuCore() const;
65
66 const std::vector<u8>& GetTextSection() const;
67 const std::vector<u8>& GetRODataSection() const;
68 const std::vector<u8>& GetDataSection() const;
69
70 u32 GetTextOffset() const;
71 u32 GetRODataOffset() const;
72 u32 GetDataOffset() const;
73
74 u32 GetBSSSize() const;
75 u32 GetBSSOffset() const;
76
77private:
78 Loader::ResultStatus status;
79
80 KIPHeader header{};
81 std::array<std::vector<u8>, 6> decompressed_sections;
82};
83
84class INI {
85public:
86 explicit INI(const VirtualFile& file);
87
88 Loader::ResultStatus GetStatus() const;
89
90 const std::vector<KIP>& GetKIPs() const;
91
92private:
93 Loader::ResultStatus status;
94
95 INIHeader header{};
96 std::vector<KIP> kips;
97};
98
99} // namespace FileSys