jubako 0.4.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
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
use crate::bases::*;
use crate::creator::{private::WritableTell, Result};
use rayon::prelude::*;
use std::cell::Cell;

use std::sync::{Arc, RwLock};

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub(crate) enum ValueStoreKind {
    Plain,
    Indexed,
}

pub struct ValueHandle {
    store: Cell<Option<StoreHandle>>,
    idx: Cell<u64>,
}

impl std::fmt::Debug for ValueHandle {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.debug_struct("ValueHandle")
            .field("store", &"Unknown")
            .field("idx", &self.idx.get())
            .finish()
    }
}

impl ValueHandle {
    fn new(store: &Arc<RwLock<ValueStore>>, idx: usize) -> Self {
        Self {
            store: Cell::new(Some(StoreHandle(Arc::clone(store)))),
            idx: Cell::new(idx as u64),
        }
    }

    pub fn get(&self) -> ValueIdx {
        match self.store.take() {
            None => self.idx.get().into(),
            Some(store) => {
                let idx = store.get(self.idx.get() as usize);
                self.idx.set(idx.into_u64());
                idx
            }
        }
    }

    pub fn clone_get(&self) -> Self {
        let idx = self.get();
        Self {
            store: Cell::new(None),
            idx: Cell::new(idx.into()),
        }
    }
}

impl PartialEq for ValueHandle {
    fn eq(&self, other: &Self) -> bool {
        self.get() == other.get()
    }
}

impl From<ValueHandle> for Word<u64> {
    fn from(value_handle: ValueHandle) -> Self {
        let func: Box<dyn Fn() -> u64 + Sync + Send> = match value_handle.store.take() {
            None => {
                let idx = value_handle.idx.get();
                Box::new(move || idx)
            }
            Some(store) => {
                let idx = value_handle.idx.get() as usize;
                Box::new(move || store.get(idx).into_u64())
            }
        };
        func.into()
    }
}

#[derive(Debug, Clone)]
#[repr(transparent)]
pub struct StoreHandle(Arc<RwLock<ValueStore>>);

impl StoreHandle {
    pub(crate) fn key_size(&self) -> ByteSize {
        self.0.read().unwrap().key_size()
    }

    pub(crate) fn get_idx(&self) -> Option<ValueStoreIdx> {
        self.0.read().unwrap().get_idx()
    }

    pub fn add_value(&self, data: impl Into<Box<[u8]>>) -> ValueHandle {
        let idx = self.0.write().unwrap().add_value(data);
        ValueHandle::new(&self.0, idx)
    }

    pub(crate) fn finalize(&self, idx: ValueStoreIdx) {
        self.0.write().unwrap().finalize(idx)
    }

    pub(crate) fn kind(&self) -> ValueStoreKind {
        self.0.read().unwrap().kind()
    }

    fn get(&self, idx: usize) -> ValueIdx {
        self.0.read().unwrap().get(idx)
    }
}

impl From<ValueStore> for StoreHandle {
    fn from(s: ValueStore) -> Self {
        Self(Arc::new(RwLock::new(s)))
    }
}

impl std::ops::Deref for StoreHandle {
    type Target = Arc<RwLock<ValueStore>>;
    fn deref(&self) -> &Self::Target {
        &self.0
    }
}

#[derive(Debug)]
pub enum ValueStore {
    Plain(PlainValueStore),
    Indexed(IndexedValueStore),
}

impl ValueStore {
    pub fn new_plain(size_hint: Option<usize>) -> StoreHandle {
        Self::Plain(PlainValueStore(BaseValueStore::new(size_hint))).into()
    }

    pub fn new_indexed() -> StoreHandle {
        Self::Indexed(IndexedValueStore(BaseValueStore::new(Some(0)))).into()
    }

    pub(crate) fn finalize(&mut self, idx: ValueStoreIdx) {
        match self {
            Self::Plain(ref mut s) => s.finalize(idx),
            Self::Indexed(ref mut s) => s.finalize(idx),
        }
    }

    pub(crate) fn add_value(&mut self, data: impl Into<Box<[u8]>>) -> usize {
        match self {
            Self::Plain(s) => s.add_value(data),
            Self::Indexed(s) => s.add_value(data),
        }
    }

    pub(crate) fn key_size(&self) -> ByteSize {
        match &self {
            Self::Plain(s) => s.key_size(),
            Self::Indexed(s) => s.key_size(),
        }
    }

    pub(crate) fn get_idx(&self) -> Option<ValueStoreIdx> {
        match &self {
            Self::Plain(s) => s.get_idx(),
            Self::Indexed(s) => s.get_idx(),
        }
    }

    pub(crate) fn kind(&self) -> ValueStoreKind {
        match &self {
            Self::Plain(_) => ValueStoreKind::Plain,
            Self::Indexed(_) => ValueStoreKind::Indexed,
        }
    }

    fn get(&self, idx: usize) -> ValueIdx {
        match self {
            Self::Plain(s) => s.get(idx),
            Self::Indexed(s) => s.get(idx),
        }
    }
}

impl WritableTell for ValueStore {
    fn write_data(&mut self, stream: &mut dyn OutStream) -> Result<()> {
        match self {
            Self::Plain(s) => s.write_data(stream),
            Self::Indexed(s) => s.write_data(stream),
        }
    }

    fn serialize_tail(&mut self, ser: &mut Serializer) -> IoResult<()> {
        match self {
            Self::Plain(s) => s.serialize_tail(ser),
            Self::Indexed(s) => s.serialize_tail(ser),
        }
    }
}

struct BaseValueStore {
    idx: Option<ValueStoreIdx>,
    data: Vec<(Box<[u8]>, u64)>, // The array storing the data and the index it will be written when sorted.
    sorted_indirect: Vec<usize>, // An array reindexing the data in sorted order.
    // data[sorted_indirect[i]].0 <= data[sorted_indirect[j]] for any i < j
    size: Size,
    finalized: bool,
}

impl BaseValueStore {
    pub(crate) fn new(size_hint: Option<usize>) -> Self {
        let data = Vec::with_capacity(size_hint.unwrap_or(1024));
        let sorted_indirect = Vec::with_capacity(size_hint.unwrap_or(1024));
        Self {
            idx: None,
            data,
            sorted_indirect,
            size: Size::zero(),
            finalized: false,
        }
    }

    pub(crate) fn add_value(&mut self, data: impl Into<Box<[u8]>>) -> usize {
        // Let's act like if data is sorted when we add it
        let key = self.data.len();
        self.data.push((data.into(), 0));
        self.sorted_indirect.push(key);
        key
    }

    fn get(&self, idx: usize) -> ValueIdx {
        if !self.finalized {
            panic!("We can get only on finalized store.");
        }
        self.data[idx].1.into()
    }
}

#[repr(transparent)]
pub struct PlainValueStore(BaseValueStore);

impl PlainValueStore {
    pub(self) fn size(&self) -> Size {
        self.0.size
    }

    pub(self) fn finalize(&mut self, idx: ValueStoreIdx) {
        self.0.idx = Some(idx);
        self.0
            .sorted_indirect
            .par_sort_unstable_by_key(|e| &self.0.data[*e].0);
        let mut offset = 0;
        let mut last_data_key: Option<usize> = None;
        for data_key in self.0.sorted_indirect.iter_mut() {
            //let data = &mut self.0.data[*data_key];
            // If we have a last, it is the same data ?
            if let Some(i) = last_data_key {
                assert_ne!(*data_key, i);
                //let last_data = &self.0.data[i];
                if self.0.data[*data_key].0 == self.0.data[i].0 {
                    // We have a duplicate
                    self.0.data[*data_key].1 = self.0.data[i].1;
                    *data_key = i;
                    continue;
                }
            }
            // No duplicate
            let data = &mut self.0.data[*data_key];
            data.1 = offset;
            offset += data.0.len() as u64;
            last_data_key = Some(*data_key);
        }
        self.0.size = offset.into();
        self.0.finalized = true;
    }

    pub(self) fn add_value(&mut self, data: impl Into<Box<[u8]>>) -> usize {
        self.0.add_value(data)
    }

    pub(self) fn get(&self, idx: usize) -> ValueIdx {
        self.0.get(idx)
    }

    pub(self) fn key_size(&self) -> ByteSize {
        needed_bytes(self.size().into_u64())
    }

    pub(self) fn get_idx(&self) -> Option<ValueStoreIdx> {
        self.0.idx
    }
}

impl WritableTell for PlainValueStore {
    fn write_data(&mut self, stream: &mut dyn OutStream) -> Result<()> {
        let mut serializer = Serializer::new(BlockCheck::Crc32);
        let mut last_data_key: Option<usize> = None;
        for data_key in &self.0.sorted_indirect {
            if let Some(i) = last_data_key {
                if *data_key == i {
                    // We have a duplicate
                    // skip
                    continue;
                }
            }
            last_data_key = Some(*data_key);
            serializer.write_data(&self.0.data[*data_key].0)?;
        }
        stream.write_serializer(serializer)?;
        Ok(())
    }

    fn serialize_tail(&mut self, ser: &mut Serializer) -> IoResult<()> {
        ser.write_u8(0x00)?;
        self.size().serialize(ser)?;
        Ok(())
    }
}

impl std::fmt::Debug for PlainValueStore {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.debug_struct("PlainValueStore")
            .field("idx", &self.get_idx())
            .field("size", &self.size())
            .field("key_size", &self.key_size())
            .field("data count", &self.0.data.len())
            .finish()
    }
}

#[repr(transparent)]
pub struct IndexedValueStore(BaseValueStore);
// data[sorted_indirect[i]].1 == i

impl IndexedValueStore {
    pub(self) fn finalize(&mut self, idx: ValueStoreIdx) {
        self.0.idx = Some(idx);
        self.0
            .sorted_indirect
            .par_sort_by_key(|e| &self.0.data[*e].0);
        for (idx, data_key) in self.0.sorted_indirect.iter().enumerate() {
            self.0.data[*data_key].1 = idx as u64;
        }
        self.0.finalized = true;
    }

    pub(self) fn add_value(&mut self, data: impl Into<Box<[u8]>>) -> usize {
        let data = data.into();
        // [TODO] This is a long search when we have a lot of values...
        let potential_idx = if self.0.data.len() >= 1024 {
            self.0
                .data
                .par_iter()
                .position_any(|(existing_data, _)| &data == existing_data)
        } else {
            self.0
                .data
                .iter()
                .position(|(existing_data, _)| &data == existing_data)
        };
        match potential_idx {
            Some(idx) => idx,
            None => {
                self.0.size += data.len();
                self.0.add_value(data)
            }
        }
    }

    pub(self) fn get(&self, idx: usize) -> ValueIdx {
        self.0.get(idx)
    }

    pub(self) fn key_size(&self) -> ByteSize {
        needed_bytes(self.0.sorted_indirect.len())
    }

    pub(self) fn get_idx(&self) -> Option<ValueStoreIdx> {
        self.0.idx
    }
}

impl WritableTell for IndexedValueStore {
    fn write_data(&mut self, stream: &mut dyn OutStream) -> Result<()> {
        let mut serializer = Serializer::new(BlockCheck::Crc32);
        for idx in &self.0.sorted_indirect {
            serializer.write_data(&self.0.data[*idx].0)?;
        }
        stream.write_serializer(serializer)?;
        Ok(())
    }

    fn serialize_tail(&mut self, ser: &mut Serializer) -> IoResult<()> {
        ser.write_u8(0x01)?;
        ser.write_u64(self.0.sorted_indirect.len() as u64)?; // key count
        let data_size = self.0.size.into_u64();
        let offset_size = needed_bytes(data_size);
        offset_size.serialize(ser)?; // offset_size
        ser.write_usized(data_size, offset_size)?; // data size
        let mut offset = 0;
        if !self.0.sorted_indirect.is_empty() {
            for idx in &self.0.sorted_indirect[..(self.0.sorted_indirect.len() - 1)] {
                let data = &self.0.data[*idx].0;
                offset += data.len() as u64;
                ser.write_usized(offset, offset_size)?;
            }
        }
        Ok(())
    }
}

impl std::fmt::Debug for IndexedValueStore {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.debug_struct("IndexedValueStore")
            .field("idx", &self.get_idx())
            .field("size", &self.0.size)
            .field("key_size", &self.key_size())
            .field("data count", &self.0.data.len())
            .finish()
    }
}

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

    #[rustest::test]
    fn test_empty_plain() -> rustest::Result {
        let creator = ValueStore::new_plain(None);
        creator.finalize(0.into());
        let buffer = vec![];
        let mut out_stream = std::io::Cursor::new(buffer);
        creator.write().unwrap().write(&mut out_stream)?;
        Ok(())
    }

    #[rustest::test]
    fn test_empty_indexed() -> rustest::Result {
        let creator = ValueStore::new_indexed();
        creator.finalize(0.into());
        let buffer = vec![];
        let mut out_stream = std::io::Cursor::new(buffer);
        creator.write().unwrap().write(&mut out_stream)?;
        Ok(())
    }
}