1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
use super::file::{PKEntry, PKEntryData, PKTrailer};
use super::parser;
use crate::common::{CRCTree, CRCTreeCollector, CRCTreeVisitor};
use crate::sd0;
use crate::sd0::read::SegmentedDecoder;
use nom::{Finish, IResult, Offset};
use std::cmp::Ordering;
use std::convert::TryFrom;
use std::error::Error;
use std::fmt;
use std::io::{self, ErrorKind};
use std::io::{BufRead, Read, Seek, SeekFrom};
use std::marker::{Send, Sync};
use std::ops::ControlFlow;
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
pub struct ParseError {
structure: &'static str,
addr: u64,
offset: usize,
code: nom::error::ErrorKind,
}
impl ParseError {
fn map<'r>(
structure: &'static str,
addr: u64,
slice: &'r [u8],
) -> impl FnOnce(nom::error::Error<&'r [u8]>) -> Self {
move |e: nom::error::Error<&'r [u8]>| ParseError {
structure,
addr,
offset: slice.offset(e.input),
code: e.code,
}
}
}
impl std::error::Error for ParseError {}
impl fmt::Display for ParseError {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
write!(
f,
"Failed to parse {} at {} (+{}) with code {:?}",
self.structure, self.addr, self.offset, self.code
)
}
}
impl From<ParseError> for io::Error {
fn from(error: ParseError) -> Self {
io::Error::new(io::ErrorKind::Other, error)
}
}
pub struct PackFile<T> {
inner: T,
}
pub struct PackStreamReader<'b, T> {
base_addr: u32,
offset: u32,
size: u32,
file: &'b mut PackFile<T>,
}
trait Readable {
type Buf: AsMut<[u8]> + AsRef<[u8]>;
type Output: Sized;
const NAME: &'static str;
fn make() -> Self::Buf;
fn parse(input: &[u8]) -> IResult<&[u8], Self::Output>;
}
struct MagicBytes;
macro_rules! readable_impl {
($ty:ty ; $parser:ident([u8;$size:literal]) -> $out:ty) => {
impl Readable for $ty {
type Buf = [u8; $size];
type Output = $out;
const NAME: &'static str = std::stringify!($ty);
fn make() -> Self::Buf {
[0; $size]
}
fn parse(input: &[u8]) -> IResult<&[u8], Self::Output> {
parser::$parser(input)
}
}
};
($ty:ty ; $parser:ident([u8;$size:literal])) => {
readable_impl!($ty; $parser([u8;$size]) -> $ty);
}
}
readable_impl!(MagicBytes; parse_pk_magic([u8;4]) -> ());
readable_impl!(PKTrailer; parse_pk_trailer([u8;8]));
readable_impl!(PKEntry; parse_pk_entry([u8;100]));
fn read_value<V: Readable, R: Read + Seek>(reader: &mut R, addr: u64) -> io::Result<V::Output> {
let mut bytes: V::Buf = V::make();
reader.read_exact(bytes.as_mut())?;
let (_, value) = V::parse(bytes.as_ref()).finish().map_err(ParseError::map(
V::NAME,
addr,
bytes.as_ref(),
))?;
Ok(value)
}
impl<T> PackFile<T>
where
T: Seek + BufRead,
{
pub fn open(inner: T) -> Self {
PackFile { inner }
}
pub fn into_inner(self) -> T {
self.inner
}
pub fn get_ref(&self) -> &T {
&self.inner
}
pub fn get_mut(&mut self) -> &T {
&mut self.inner
}
pub fn check_magic(&mut self) -> io::Result<()> {
self.inner.seek(SeekFrom::Start(0))?;
read_value::<MagicBytes, _>(&mut self.inner, 0)
}
pub fn get_header(&mut self) -> io::Result<PKTrailer> {
let addr = self.inner.seek(SeekFrom::End(-8))?;
read_value::<PKTrailer, _>(&mut self.inner, addr)
}
pub fn get_entry(&mut self, addr: u32) -> io::Result<PKEntry> {
let addr = u64::from(addr);
self.inner.seek(SeekFrom::Start(addr))?;
read_value::<PKEntry, _>(&mut self.inner, addr)
}
pub fn get_entry_accessor(mut self, addr: u32) -> io::Result<PackEntryAccessor<T>> {
let mut count_bytes: [u8; 4] = [0; 4];
self.inner.seek(SeekFrom::Start(u64::from(addr)))?;
self.inner.read_exact(&mut count_bytes)?;
let count = u32::from_le_bytes(count_bytes);
Ok(PackEntryAccessor {
base_addr: addr + 4,
count,
file: self,
})
}
pub fn get_entry_list(&mut self, addr: u32) -> io::Result<Vec<PKEntry>> {
let mut bytes: Vec<u8> = Vec::new();
let addr = self.inner.seek(SeekFrom::Start(u64::from(addr)))?;
self.inner.read_to_end(&mut bytes)?;
let (_rest, entry_list) = parser::parse_pk_entry_list(&bytes)
.finish()
.map_err(ParseError::map("Vec<PKEntry>", addr, &bytes))?;
Ok(entry_list)
}
pub fn get_file_stream<'b>(&'b mut self, entry: PKEntry) -> PackStreamReader<'b, T> {
let base_addr = entry.file_data_addr;
let size = if (entry.is_compressed & 0xff) == 0 {
entry.orig_file_size
} else {
entry.compr_file_size
};
PackStreamReader::<'b, T> {
file: self,
base_addr,
offset: 0,
size,
}
}
pub fn get_file_data(
&mut self,
entry: PKEntry,
) -> std::result::Result<PackDataStream<T>, sd0::read::Error> {
let is_compr = (entry.is_compressed & 0xff) > 0;
let file_stream = self.get_file_stream(entry);
Ok(if is_compr {
let compr_stream = SegmentedDecoder::new(file_stream)?;
PackDataStream::Compressed(compr_stream)
} else {
PackDataStream::Plain(file_stream)
})
}
}
pub enum PackDataStream<'b, T> {
Plain(PackStreamReader<'b, T>),
Compressed(SegmentedDecoder<PackStreamReader<'b, T>>),
}
impl<'b, T: Seek + BufRead> std::io::Read for PackDataStream<'b, T> {
fn read(&mut self, buf: &mut [u8]) -> io::Result<usize> {
match self {
Self::Plain(inner) => inner.read(buf),
Self::Compressed(inner) => inner.read(buf),
}
}
}
pub struct PackEntryAccessor<T> {
base_addr: u32,
count: u32,
file: PackFile<T>,
}
impl<T> PackEntryAccessor<T> {
pub fn into_inner(self) -> PackFile<T> {
self.file
}
pub fn get_mut(&mut self) -> &mut PackFile<T> {
&mut self.file
}
pub fn get_ref(&self) -> &PackFile<T> {
&self.file
}
}
impl<T> PackEntryAccessor<T>
where
T: Seek + BufRead,
{
pub fn get_entry(&mut self, index: i32) -> io::Result<Option<PKEntry>> {
if index >= 0 {
Ok(Some(
self.file.get_entry(self.base_addr + (index as u32) * 100)?,
))
} else {
Ok(None)
}
}
pub fn read_all(&mut self) -> io::Result<CRCTree<PKEntryData>> {
let mut collector = CRCTreeCollector::new();
self.visit(&mut collector)?;
Ok(collector.into_inner())
}
pub fn visit<V>(&mut self, visitor: &mut V) -> io::Result<ControlFlow<V::Break>>
where
V: CRCTreeVisitor<PKEntryData>,
{
let parent = self.get_root_entry()?;
self.visit_recursive(visitor, parent)
}
fn visit_recursive<V>(
&mut self,
visitor: &mut V,
parent: Option<PKEntry>,
) -> io::Result<ControlFlow<V::Break>>
where
V: CRCTreeVisitor<PKEntryData>,
{
let data = if let Some(entry) = parent {
entry
} else {
return Ok(ControlFlow::Continue(()));
};
let left = self.get_entry(data.left)?;
if let ControlFlow::Break(e) = self.visit_recursive(visitor, left)? {
return Ok(ControlFlow::Break(e));
}
if let ControlFlow::Break(e) = visitor.visit(data.crc, data.data) {
return Ok(ControlFlow::Break(e));
}
let right = self.get_entry(data.right)?;
if let ControlFlow::Break(e) = self.visit_recursive(visitor, right)? {
return Ok(ControlFlow::Break(e));
}
Ok(ControlFlow::Continue(()))
}
pub fn get_root_entry(&mut self) -> io::Result<Option<PKEntry>> {
self.get_entry((self.count / 2) as i32)
}
fn find_entry_recursive(
&mut self,
parent: Option<PKEntry>,
crc: u32,
) -> io::Result<Option<PKEntry>> {
let data = match parent {
Some(x) => x,
None => return Ok(None),
};
match data.crc.cmp(&crc) {
Ordering::Less => {
let right = self.get_entry(data.right)?;
self.find_entry_recursive(right, crc)
}
Ordering::Greater => {
let left = self.get_entry(data.left)?;
self.find_entry_recursive(left, crc)
}
Ordering::Equal => Ok(Some(data)),
}
}
pub fn find_entry(&mut self, crc: u32) -> io::Result<Option<PKEntry>> {
let root = self.get_root_entry()?;
self.find_entry_recursive(root, crc)
}
pub fn get_count(&self) -> u32 {
self.count
}
}
fn other_io_err<E>(e: E) -> io::Error
where
E: Into<Box<dyn Error + Send + Sync>>,
{
io::Error::new(ErrorKind::Other, e)
}
impl<'b, T> Read for PackStreamReader<'b, T>
where
T: Seek + BufRead,
{
fn read(&mut self, buf: &mut [u8]) -> io::Result<usize> {
let pos = u64::from(self.base_addr + self.offset);
self.file.inner.seek(SeekFrom::Start(pos))?;
let buf_len = buf.len();
let offset = usize::try_from(self.offset).map_err(other_io_err)?;
let size = usize::try_from(self.size).map_err(other_io_err)?;
if offset + buf_len > size {
let max = size - offset;
self.file.inner.read(&mut buf[..max])
} else {
self.file.inner.read(buf)
}
.and_then(|n| {
self.offset += u32::try_from(n).map_err(other_io_err)?;
Ok(n)
})
}
}