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
use std::fmt;
use std::io::Cursor;
use std::io::Read;
use std::sync::{Arc, RwLock};
use bitreader::BitReader;
use byteorder::{LittleEndian, ReadBytesExt};
use memmap::Mmap;
use xz2::read::XzDecoder;
use crate::errors::{Error, Result};
#[repr(u8)]
#[derive(Debug, PartialEq, Eq, Clone, Copy)]
pub enum Compression {
None = 0,
LZMA2 = 4,
}
impl From<Compression> for u8 {
fn from(mode: Compression) -> u8 {
mode as u8
}
}
impl Compression {
pub fn from(raw: u8) -> Result<Compression> {
match raw {
0 => Ok(Compression::None),
1 => Ok(Compression::None),
4 => Ok(Compression::LZMA2),
_ => Err(Error::UnknownCompression),
}
}
}
#[derive(Clone)]
pub struct Cluster<'a>(Arc<RwLock<InnerCluster<'a>>>);
pub struct InnerCluster<'a> {
extended: bool,
compression: Compression,
start: u64,
end: u64,
size: u64,
view: &'a [u8],
blob_list: Option<Vec<u64>>,
decompressed: Option<Vec<u8>>,
}
impl<'a> fmt::Debug for Cluster<'a> {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
let raw = self.0.read().unwrap();
f.debug_struct("Cluster")
.field("extended", &raw.extended)
.field("compression", &raw.compression)
.field("start", &raw.start)
.field("end", &raw.end)
.field("size", &raw.size)
.field("view len", &raw.view.len())
.field("blob_list", &raw.blob_list)
.field(
"decompressed len",
&raw.decompressed.as_ref().map(|s| s.len()),
)
.finish()
}
}
impl<'a> Cluster<'a> {
pub fn new(
master_view: &'a Mmap,
cluster_list: &'a Vec<u64>,
idx: u32,
checksum_pos: u64,
version: u16,
) -> Result<Cluster<'a>> {
Ok(Cluster(Arc::new(RwLock::new(InnerCluster::new(
master_view,
cluster_list,
idx,
checksum_pos,
version,
)?))))
}
pub fn decompress(&self) -> Result<()> {
self.0.write().unwrap().decompress()
}
pub fn get_blob<'b: 'a>(&'b self, idx: u32) -> Result<Blob<'a, 'b>> {
{
let lock = self.0.read().unwrap();
if lock.needs_decompression() {
drop(lock);
self.0.write().unwrap().decompress()?;
}
}
match Blob::try_new(self.0.read().unwrap(), |lock| lock.get_blob(idx)) {
Ok(blob) => Ok(blob),
Err(rental::RentalError(err, _)) => Err(err),
}
}
}
rental! {
pub mod rents {
use super::*;
#[rental(deref_suffix)]
pub struct Blob<'a, 'b> {
#[target_ty = "InnerCluster<'a>"]
guard: std::sync::RwLockReadGuard<'b, InnerCluster<'a>>,
slice: &'guard [u8],
}
}
}
use rents::*;
impl<'a> InnerCluster<'a> {
fn new(
master_view: &'a Mmap,
cluster_list: &'a Vec<u64>,
idx: u32,
checksum_pos: u64,
version: u16,
) -> Result<Self> {
let idx = idx as usize;
let start = cluster_list[idx];
let end = if idx < cluster_list.len() - 1 {
cluster_list[idx + 1]
} else {
checksum_pos
};
assert!(end > start);
let cluster_size = end - start;
let cluster_view = master_view
.get(start as usize..end as usize)
.ok_or(Error::OutOfBounds)?;
let (extended, compression) =
parse_details(cluster_view.get(0).ok_or(Error::OutOfBounds)?)?;
if extended && version != 6 {
return Err(Error::InvalidClusterExtension);
}
let blob_list = if Compression::None == compression {
let cur = Cursor::new(&cluster_view[1..]);
Some(parse_blob_list(cur, extended)?)
} else {
None
};
Ok(Self {
extended: extended,
compression: compression,
start: start,
end: end,
size: cluster_size,
view: cluster_view,
decompressed: None,
blob_list,
})
}
fn needs_decompression(&self) -> bool {
match self.compression {
Compression::LZMA2 => self.decompressed.is_none() || self.blob_list.is_none(),
Compression::None => false,
}
}
fn decompress(&mut self) -> Result<()> {
match self.compression {
Compression::LZMA2 => {
if self.decompressed.is_none() {
let mut decoder = XzDecoder::new(&self.view[1..]);
let mut d = Vec::with_capacity(self.view.len());
decoder.read_to_end(&mut d)?;
self.decompressed = Some(d);
}
}
Compression::None => {}
}
if self.blob_list.is_none() {
match self.compression {
Compression::LZMA2 => {
let cur = Cursor::new(self.decompressed.as_ref().unwrap());
let blob_list = parse_blob_list(cur, self.extended)?;
self.blob_list = Some(blob_list);
}
Compression::None => {}
}
}
Ok(())
}
fn get_blob<'b>(&'b self, idx: u32) -> Result<&'b [u8]> {
match self.blob_list {
Some(ref list) => {
let start = list[idx as usize] as usize;
let n = idx as usize + 1;
let end = if list.len() > n {
list[n] as usize
} else {
self.size as usize
};
Ok(match self.compression {
Compression::LZMA2 => {
&self.decompressed.as_ref().unwrap().as_slice()[start..end]
}
Compression::None => &self.view[1 + start..1 + end],
})
}
None => Err(Error::MissingBlobList),
}
}
}
fn parse_details(details: &u8) -> Result<(bool, Compression)> {
let slice = &[*details];
let mut reader = BitReader::new(slice);
reader.skip(3)?;
Ok((reader.read_bool()?, Compression::from(reader.read_u8(4)?)?))
}
fn parse_blob_list<T: ReadBytesExt>(mut cur: T, extended: bool) -> Result<Vec<u64>> {
let mut blob_list = Vec::new();
let first = if extended {
cur.read_u64::<LittleEndian>()?
} else {
cur.read_u32::<LittleEndian>()? as u64
};
let count = if extended { first / 8 } else { first / 4 };
blob_list.push(first);
for _ in 0..(count as usize - 1) {
if extended {
blob_list.push(cur.read_u64::<LittleEndian>()?);
} else {
blob_list.push(cur.read_u32::<LittleEndian>()? as u64);
}
}
Ok(blob_list)
}