jubako 0.3.0

The reference implementation of the Jubako container format
Documentation
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
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
use std::borrow::Cow;

use crate::bases::*;

#[repr(u8)]
#[derive(Clone, Copy, Debug, PartialEq)]
enum ValueStoreKind {
    Plain = 0,
    Indexed = 1,
}

impl Parsable for ValueStoreKind {
    type Output = Self;
    fn parse(parser: &mut impl Parser) -> Result<Self> {
        match parser.read_u8()? {
            0 => Ok(ValueStoreKind::Plain),
            1 => Ok(ValueStoreKind::Indexed),
            v => Err(format_error!(
                &format!("Invalid ValueStoreKind ({v})"),
                parser
            )),
        }
    }
}

pub trait ValueStoreTrait: std::fmt::Debug + Send + Sync {
    fn get_data(&self, id: ValueIdx, size: Option<ASize>) -> Result<&[u8]>;
}

#[derive(Debug)]
#[cfg_attr(feature = "explorable", derive(serde::Serialize))]
pub enum ValueStore {
    Plain(PlainValueStore),
    Indexed(IndexedValueStore),
}

impl ValueStoreTrait for ValueStore {
    fn get_data(&self, id: ValueIdx, size: Option<ASize>) -> Result<&[u8]> {
        match self {
            ValueStore::Plain(store) => store.get_data(id, size),
            ValueStore::Indexed(store) => store.get_data(id, size),
        }
    }
}

#[cfg(feature = "explorable")]
impl Explorable for ValueStore {
    fn explore_one(&self, item: &str) -> Result<Option<Box<dyn Explorable>>> {
        match self {
            ValueStore::Plain(store) => store.explore_one(item),
            ValueStore::Indexed(store) => store.explore_one(item),
        }
    }
}

pub(crate) enum ValueStoreBuilder {
    Plain,
    Indexed(Vec<Offset>),
}

impl Parsable for ValueStoreBuilder {
    type Output = (Self, Size);
    fn parse(parser: &mut impl Parser) -> Result<Self::Output>
    where
        Self::Output: Sized,
    {
        let kind = ValueStoreKind::parse(parser)?;
        match kind {
            ValueStoreKind::Plain => {
                let data_size = Size::parse(parser)?;
                Ok((ValueStoreBuilder::Plain, data_size))
            }
            ValueStoreKind::Indexed => {
                let value_count: ValueCount = Count::<u64>::parse(parser)?.into();
                let offset_size = ByteSize::parse(parser)?;
                let data_size: Size = parser.read_usized(offset_size)?.into();

                #[cfg(target_pointer_width = "64")]
                let value_count = value_count.into_u64() as usize;

                // < instead of <= because of the +1 just after
                #[cfg(target_pointer_width = "32")]
                let value_count = if value_count.into_u64() < usize::MAX as u64 {
                    value_count.into_u64() as usize
                } else {
                    unimplemented!()
                };

                // [FIXME] A lot of value means a lot of allocation.
                // A wrong value here (or a carefully choosen one) may break our program.
                let mut value_offsets: Vec<Offset> = Vec::with_capacity(value_count + 1);
                let uninit = value_offsets.spare_capacity_mut();
                let mut first = true;
                for elem in &mut uninit[0..value_count] {
                    let value: Offset = if first {
                        first = false;
                        Offset::zero()
                    } else {
                        parser.read_usized(offset_size)?.into()
                    };
                    assert!(value.is_valid(data_size));
                    elem.write(value);
                }
                unsafe { value_offsets.set_len(value_count) }
                value_offsets.push(data_size.into());
                Ok((ValueStoreBuilder::Indexed(value_offsets), data_size))
            }
        }
    }
}

impl BlockParsable for ValueStoreBuilder {}

impl DataBlockParsable for ValueStore {
    type TailParser = ValueStoreBuilder;
    type Output = Self;

    fn finalize(
        intermediate: (ValueStoreBuilder, Size),
        header_offset: Offset,
        reader: &Reader,
    ) -> Result<Self::Output> {
        let (store_builder, data_size) = intermediate;
        let reader = reader.cut_check(
            header_offset - data_size - ASize::from(BlockCheck::Crc32.size()),
            data_size,
            BlockCheck::Crc32,
        )?;
        // We want to be sure that we load all the ValueStore data in memory first.
        Ok(match store_builder {
            ValueStoreBuilder::Plain => Self::Plain(PlainValueStore { reader }),
            ValueStoreBuilder::Indexed(value_offsets) => Self::Indexed(IndexedValueStore {
                value_offsets,
                reader,
            }),
        })
    }
}

#[derive(Debug)]
pub struct PlainValueStore {
    reader: CheckReader,
}

impl PlainValueStore {
    pub(self) fn get_data(&self, id: ValueIdx, size: Option<ASize>) -> Result<&[u8]> {
        if let Some(size) = size {
            let offset = id.into_u64().into();
            if let Cow::Borrowed(s) = self.reader.get_slice(offset, size)? {
                Ok(s)
            } else {
                unreachable!("Reader must be from memory")
            }
        } else {
            panic!("Cannot use unsized with PlainValueStore");
        }
    }
}

#[cfg(feature = "explorable")]
impl serde::Serialize for PlainValueStore {
    fn serialize<S>(&self, serializer: S) -> std::result::Result<S::Ok, S::Error>
    where
        S: serde::Serializer,
    {
        use serde::ser::SerializeStruct;
        let mut ser = serializer.serialize_struct("PlainValueStore", 1)?;
        ser.serialize_field("size", &self.reader.size())?;
        ser.end()
    }
}

#[cfg(feature = "explorable")]
impl Explorable for PlainValueStore {
    fn explore_one(&self, item: &str) -> Result<Option<Box<dyn Explorable>>> {
        if let Some((first, second)) = item.split_once('-') {
            let offset = first
                .parse::<u64>()
                .map_err(|e| Error::from(format!("{e}")))?;
            let size = second
                .parse::<usize>()
                .map_err(|e| Error::from(format!("{e}")))?;
            if offset > self.reader.size().into_u64()
                || (offset + size as u64 > self.reader.size().into_u64())
            {
                return Ok(None);
            }
            Ok(Some(Box::new(
                String::from_utf8_lossy(
                    self.get_data(ValueIdx::from(offset), Some(ASize::from(size)))?,
                )
                .into_owned(),
            )))
        } else {
            Ok(None)
        }
    }
}

#[derive(Debug)]
pub struct IndexedValueStore {
    value_offsets: Vec<Offset>,
    reader: CheckReader,
}

impl IndexedValueStore {
    pub(self) fn get_data(&self, id: ValueIdx, size: Option<ASize>) -> Result<&[u8]> {
        #[cfg(target_pointer_width = "32")]
        if id.into_u64() > usize::MAX as u64 {
            unimplemented!();
        }
        let id = id.into_u64() as usize;
        if id + 1 >= self.value_offsets.len() {
            return Err(format_error!(&format!("{id} is not a valid id")));
        }
        let start = self.value_offsets[id];
        let size = match size {
            Some(s) => s,
            None => {
                let s = self.value_offsets[id + 1] - start;
                assert!(s.into_u64() <= usize::MAX as u64);
                ASize::new(s.into_u64() as usize)
            }
        };
        if let Cow::Borrowed(s) = self.reader.get_slice(start, size)? {
            Ok(s)
        } else {
            unreachable!("Reader must be from memory")
        }
    }
}

#[cfg(feature = "explorable")]
impl serde::Serialize for IndexedValueStore {
    fn serialize<S>(&self, serializer: S) -> std::prelude::v1::Result<S::Ok, S::Error>
    where
        S: serde::Serializer,
    {
        use serde::ser::SerializeStruct;
        let mut ser = serializer.serialize_struct("IndexedValueStore", 1)?;
        ser.serialize_field("offsets", &(self.value_offsets.len() - 1))?;
        ser.end()
    }
}

#[cfg(feature = "explorable")]
impl Explorable for IndexedValueStore {
    fn explore_one(&self, item: &str) -> Result<Option<Box<dyn Explorable>>> {
        let (idx, size) = if let Some((first, second)) = item.split_once('-') {
            let offset = first
                .parse::<u64>()
                .map_err(|e| Error::from(format!("{e}")))?;
            let size = Some(ASize::from(
                second
                    .parse::<usize>()
                    .map_err(|e| Error::from(format!("{e}")))?,
            ));
            (offset, size)
        } else {
            let offset = item
                .parse::<u64>()
                .map_err(|e| Error::from(format!("{e}")))?;
            (offset, None)
        };
        if idx >= self.value_offsets.len() as u64 {
            return Err(format!("{idx} is not a valid index").into());
        }
        Ok(Some(Box::new(
            String::from_utf8_lossy(self.get_data(ValueIdx::from(idx), size)?).into_owned(),
        )))
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_valuestorekind() {
        let reader = CheckReader::from([0x00, 0x01, 0x02]);
        let mut parser = reader.create_parser(Offset::zero(), 3.into()).unwrap();
        assert_eq!(
            ValueStoreKind::parse(&mut parser).unwrap(),
            ValueStoreKind::Plain
        );
        assert_eq!(
            ValueStoreKind::parse(&mut parser).unwrap(),
            ValueStoreKind::Indexed
        );
        assert_eq!(parser.tell(), Offset::new(2));
        assert!(ValueStoreKind::parse(&mut parser).is_err());
    }

    #[test]
    fn test_plainvaluestore() {
        #[rustfmt::skip]
        let reader = Reader::from(
            vec![
                0x11, 0x12, 0x13, 0x14, 0x15, // Data of entry 0
                0x21, 0x22, 0x23, // Data of entry 1
                0x31, 0x32, 0x33, 0x34, 0x35, 0x36, 0x37, // Data of entry 2
                0x0D, 0x0D, 0x73, 0xA0, // CRC
                0x00, // kind
                0x0F, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, // data_size
                0xE4, 0x65, 0xB6, 0xC7, // CRC
            ]
        );
        let value_store = reader
            .parse_data_block::<ValueStore>(SizedOffset::new(ASize::new(9), Offset::new(19)))
            .unwrap();
        match &value_store {
            ValueStore::Plain(plainvaluestore) => {
                assert_eq!(plainvaluestore.reader.size(), Size::from(0x0F_u64));
                assert_eq!(
                    plainvaluestore
                        .reader
                        .get_slice(Offset::zero(), ASize::new(8))
                        .unwrap()
                        .as_ref(),
                    &[0x11, 0x12, 0x13, 0x14, 0x15, 0x21, 0x22, 0x23]
                );
                assert_eq!(
                    plainvaluestore
                        .reader
                        .get_slice(Offset::new(7), ASize::new(5))
                        .unwrap()
                        .as_ref(),
                    &[0x23, 0x31, 0x32, 0x33, 0x34]
                );
            }
            _ => panic!("Wrong type"),
        }

        assert_eq!(
            value_store.get_data(0.into(), Some(5.into())).unwrap(),
            vec![0x11, 0x12, 0x13, 0x14, 0x15]
        );
        assert_eq!(
            value_store.get_data(5.into(), Some(3.into())).unwrap(),
            vec![0x21, 0x22, 0x23]
        );
        assert_eq!(
            value_store.get_data(8.into(), Some(7.into())).unwrap(),
            vec![0x31, 0x32, 0x33, 0x34, 0x35, 0x36, 0x37]
        );
    }

    #[test]
    fn test_indexedvaluestore() {
        #[rustfmt::skip]
        let reader = Reader::from(
            vec![
                0x11, 0x12, 0x13, 0x14, 0x15, // Data of entry 0
                0x21, 0x22, 0x23, // Data of entry 1
                0x31, 0x32, 0x33, 0x34, 0x35, 0x36, 0x37, // Data of entry 2
                0x0D, 0x0D, 0x73, 0xA0, // CRC
                0x01, // kind
                0x03, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, // value count
                0x01, // offset_size
                0x0f, // data_size
                0x05, // Offset of entry 1
                0x08, // Offset of entry 2
                0x1E, 0x6E, 0xE7, 0xB7, // CRC
            ]
        );
        let value_store = reader
            .parse_data_block::<ValueStore>(SizedOffset::new(ASize::new(13), Offset::new(19)))
            .unwrap();
        match &value_store {
            ValueStore::Indexed(indexedvaluestore) => {
                assert_eq!(
                    indexedvaluestore.value_offsets,
                    vec![0_u64.into(), 5_u64.into(), 8_u64.into(), 15_u64.into()]
                );
                assert_eq!(indexedvaluestore.reader.size(), Size::from(0x0f_u64));
                assert_eq!(
                    indexedvaluestore
                        .reader
                        .get_slice(Offset::zero(), ASize::new(8))
                        .unwrap()
                        .as_ref(),
                    &[0x11, 0x12, 0x13, 0x14, 0x15, 0x21, 0x22, 0x23]
                );
                assert_eq!(
                    indexedvaluestore
                        .reader
                        .get_slice(Offset::new(8), ASize::from(ByteSize::U7 as usize))
                        .unwrap()
                        .as_ref(),
                    &[0x31, 0x32, 0x33, 0x34, 0x35, 0x36, 0x37]
                );
            }
            _ => panic!("Wrong type"),
        }

        assert_eq!(
            value_store.get_data(0.into(), None).unwrap(),
            vec![0x11, 0x12, 0x13, 0x14, 0x15]
        );
        assert_eq!(
            value_store.get_data(1.into(), None).unwrap(),
            vec![0x21, 0x22, 0x23]
        );
        assert_eq!(
            value_store.get_data(2.into(), None).unwrap(),
            vec![0x31, 0x32, 0x33, 0x34, 0x35, 0x36, 0x37]
        );

        assert_eq!(
            value_store.get_data(0.into(), Some(5.into())).unwrap(),
            vec![0x11, 0x12, 0x13, 0x14, 0x15]
        );
        assert_eq!(
            value_store.get_data(1.into(), Some(3.into())).unwrap(),
            vec![0x21, 0x22, 0x23]
        );
        assert_eq!(
            value_store.get_data(2.into(), Some(7.into())).unwrap(),
            vec![0x31, 0x32, 0x33, 0x34, 0x35, 0x36, 0x37]
        );
    }
}