OXYGENHUB
# 6d3eefbce2f0 oxygen / crates / oxy-core / src / store.rs
29.3 KiB · Rust · last changed .oxyattributes: binary, text, eol=lf|crlf, nocompress (raw chunks in packs), lockable with advisory local oxy lock/unlock (spec 0.6j) 1 month ago source blame history raw
1
//! Object store (spec §13.1, §13.3, §13.4): loose objects, one file per
2
//! object under `objects/loose/<hh>/<rest>`, and packs, `pack-<id>.pack`
3
//! with a sorted `pack-<id>.idx`, holding zstd-compressed objects. Reads
4
//! check loose objects first, then every pack; every read re-hashes.
5
//!
6
//! Pack file: `OXYPACK1` then entries of
7
//! `type u8 | flags u8 (bit 0: zstd) | stored_len u32 | raw_len u32 | ref 32 | body`.
8
//! Index file: `OXYIDX01` then `count u32` then sorted entries of
9
//! `ref 32 | offset u64 | stored_len u32 | raw_len u32 | type u8 | flags u8`.
10
11
use crate::attest::Attest;
12
use crate::hash::{hash_object, header, ObjectRef, ObjectType};
13
use crate::identity::{Identity, Signature};
14
use crate::objects::{Change, ObjectError, StateObject};
15
use rand::RngCore;
16
use std::cell::RefCell;
17
use std::fs;
18
use std::io::{self, Read, Seek, SeekFrom, Write};
19
use std::path::{Path, PathBuf};
20
21
const PACK_MAGIC: &[u8; 8] = b"OXYPACK1";
22
const IDX_MAGIC: &[u8; 8] = b"OXYIDX01";
23
const IDX_ENTRY: usize = 32 + 8 + 4 + 4 + 1 + 1;
24
const FLAG_ZSTD: u8 = 1;
25
const ZSTD_LEVEL: i32 = 3;
26
27
#[derive(Clone, Copy, Debug)]
28
struct PackEntry {
29
    offset: u64,
30
    stored_len: u32,
31
    raw_len: u32,
32
    ty: ObjectType,
33
    flags: u8,
34
}
35
36
/// One pack's index, fully in memory and sorted by ObjectRef.
37
#[derive(Debug)]
38
struct PackIndex {
39
    path: PathBuf,
40
    refs: Vec<ObjectRef>,
41
    entries: Vec<PackEntry>,
42
}
43
44
impl PackIndex {
45
    fn load(idx_path: &Path, pack_path: &Path) -> Result<PackIndex> {
46
        let data = fs::read(idx_path)?;
47
        let bad = |m: &str| StoreError::Corrupt(ObjectRef::ZERO, format!("{}: {m}", idx_path.display()));
48
        if data.len() < 12 || &data[..8] != IDX_MAGIC {
49
            return Err(bad("bad index header"));
50
        }
51
        let count = u32::from_le_bytes(data[8..12].try_into().unwrap()) as usize;
52
        if data.len() != 12 + count * IDX_ENTRY {
53
            return Err(bad("index length mismatch"));
54
        }
55
        let mut refs = Vec::with_capacity(count);
56
        let mut entries = Vec::with_capacity(count);
57
        for i in 0..count {
58
            let e = &data[12 + i * IDX_ENTRY..12 + (i + 1) * IDX_ENTRY];
59
            let r = ObjectRef::from_slice(&e[..32]).unwrap();
60
            if let Some(prev) = refs.last() {
61
                if r <= *prev {
62
                    return Err(bad("index not sorted"));
63
                }
64
            }
65
            refs.push(r);
66
            entries.push(PackEntry {
67
                offset: u64::from_le_bytes(e[32..40].try_into().unwrap()),
68
                stored_len: u32::from_le_bytes(e[40..44].try_into().unwrap()),
69
                raw_len: u32::from_le_bytes(e[44..48].try_into().unwrap()),
70
                ty: ObjectType::ALL.get(e[48] as usize).copied().ok_or_else(|| bad("unknown object type"))?,
71
                flags: e[49],
72
            });
73
        }
74
        Ok(PackIndex { path: pack_path.to_path_buf(), refs, entries })
75
    }
76
77
    fn find(&self, r: &ObjectRef) -> Option<PackEntry> {
78
        self.refs.binary_search(r).ok().map(|i| self.entries[i])
79
    }
80
81
    fn read(&self, r: &ObjectRef, e: PackEntry) -> Result<(ObjectType, Vec<u8>)> {
82
        let mut f = fs::File::open(&self.path)?;
83
        f.seek(SeekFrom::Start(e.offset))?;
84
        let mut stored = vec![0u8; e.stored_len as usize];
85
        f.read_exact(&mut stored)?;
86
        let body = if e.flags & FLAG_ZSTD != 0 {
87
            zstd::bulk::decompress(&stored, e.raw_len as usize).map_err(|err| StoreError::Corrupt(*r, format!("zstd: {err}")))?
88
        } else {
89
            stored
90
        };
91
        if body.len() != e.raw_len as usize || hash_object(e.ty, &body) != *r {
92
            return Err(StoreError::Corrupt(*r, "packed object does not match its reference".into()));
93
        }
94
        Ok((e.ty, body))
95
    }
96
}
97
98
fn type_index(ty: ObjectType) -> u8 {
99
    ObjectType::ALL.iter().position(|t| *t == ty).unwrap() as u8
100
}
101
102
/// What `pack_loose` did.
103
#[derive(Debug, Clone, Default, PartialEq, Eq)]
104
pub struct PackReport {
105
    pub objects: usize,
106
    pub raw_bytes: u64,
107
    pub packed_bytes: u64,
108
}
109
110
/// Packs tolerated before `merge_packs` folds them into one (spec §13.4).
111
pub const MAX_PACKS: usize = 16;
112
113
/// What `prune` did.
114
#[derive(Debug, Clone, Default, PartialEq, Eq)]
115
pub struct PruneReport {
116
    pub objects: usize,
117
    pub bytes: u64,
118
    /// Unreachable objects left alone because they are younger than the grace period.
119
    pub deferred: usize,
120
}
121
122
#[derive(Debug, thiserror::Error)]
123
pub enum StoreError {
124
    #[error("io: {0}")]
125
    Io(#[from] io::Error),
126
    #[error("corrupt object {0}: {1}")]
127
    Corrupt(ObjectRef, String),
128
    #[error("object {0}")]
129
    Object(#[from] ObjectError),
130
    #[error("object {0} is a {1}, expected {2}")]
131
    WrongType(ObjectRef, &'static str, &'static str),
132
    #[error("object {0} not found")]
133
    NotFound(ObjectRef),
134
}
135
136
pub type Result<T> = std::result::Result<T, StoreError>;
137
138
#[derive(Debug)]
139
pub struct Store {
140
    dir: PathBuf,
141
    packs: RefCell<Vec<PackIndex>>,
142
}
143
144
impl Store {
145
    pub fn open(dir: impl Into<PathBuf>) -> io::Result<Store> {
146
        let dir = dir.into();
147
        fs::create_dir_all(dir.join("loose"))?;
148
        let store = Store { dir, packs: RefCell::new(Vec::new()) };
149
        store.reload_packs().map_err(|e| io::Error::other(e.to_string()))?;
150
        Ok(store)
151
    }
152
153
    fn reload_packs(&self) -> Result<()> {
154
        let mut packs = Vec::new();
155
        let mut names: Vec<PathBuf> = fs::read_dir(&self.dir)?
156
            .filter_map(|e| e.ok().map(|e| e.path()))
157
            .filter(|p| p.extension().is_some_and(|x| x == "idx") && p.file_name().is_some_and(|n| n.to_string_lossy().starts_with("pack-")))
158
            .collect();
159
        names.sort();
160
        for idx in names {
161
            let pack = idx.with_extension("pack");
162
            if pack.is_file() {
163
                packs.push(PackIndex::load(&idx, &pack)?);
164
            }
165
        }
166
        *self.packs.borrow_mut() = packs;
167
        Ok(())
168
    }
169
170
    pub fn pack_count(&self) -> usize {
171
        self.packs.borrow().len()
172
    }
173
174
    fn find_packed(&self, r: &ObjectRef) -> Option<(usize, PackEntry)> {
175
        self.packs.borrow().iter().enumerate().find_map(|(i, p)| p.find(r).map(|e| (i, e)))
176
    }
177
178
    /// Loose objects on disk, with their paths.
179
    fn loose_objects(&self) -> io::Result<Vec<(ObjectRef, PathBuf)>> {
180
        let mut out = Vec::new();
181
        let loose = self.dir.join("loose");
182
        for d in fs::read_dir(&loose)? {
183
            let d = d?;
184
            if !d.file_type()?.is_dir() {
185
                continue;
186
            }
187
            let prefix = d.file_name().to_string_lossy().to_string();
188
            for f in fs::read_dir(d.path())? {
189
                let f = f?;
190
                let name = f.file_name().to_string_lossy().to_string();
191
                if let Some(r) = ObjectRef::from_hex(&format!("{prefix}{name}")) {
192
                    out.push((r, f.path()));
193
                }
194
            }
195
        }
196
        out.sort();
197
        Ok(out)
198
    }
199
200
    pub fn loose_count(&self) -> io::Result<usize> {
201
        Ok(self.loose_objects()?.len())
202
    }
203
204
    /// Move every loose object into a new pack (spec §13.4). Loose files are
205
    /// deleted only after the pack and its index are durable.
206
    pub fn pack_loose(&self) -> Result<PackReport> {
207
        let loose = self.loose_objects()?;
208
        self.write_pack(&loose.iter().map(|(r, _)| *r).collect::<Vec<_>>(), &loose.iter().map(|(_, p)| p.clone()).collect::<Vec<_>>(), &[])
209
    }
210
211
    /// Fold every pack into one when there are more than `MAX_PACKS`
212
    /// (spec §13.4). Returns how many packs were merged.
213
    pub fn merge_packs(&self) -> Result<usize> {
214
        let (refs, paths): (Vec<ObjectRef>, Vec<PathBuf>) = {
215
            let packs = self.packs.borrow();
216
            if packs.len() <= MAX_PACKS {
217
                return Ok(0);
218
            }
219
            (packs.iter().flat_map(|p| p.refs.iter().copied()).collect(), packs.iter().map(|p| p.path.clone()).collect())
220
        };
221
        let n = paths.len();
222
        self.write_pack(&refs, &[], &paths)?;
223
        Ok(n)
224
    }
225
226
    /// Delete every object not in `keep` (spec §21). Loose objects and packs
227
    /// younger than `grace` are left alone, since a concurrent writer may not
228
    /// have recorded its references yet. Packs holding unreachable objects
229
    /// are rewritten without them. Signature sidecars and seal-index entries
230
    /// of deleted objects go too.
231
    pub fn prune(&self, keep: &std::collections::HashSet<ObjectRef>, grace: std::time::Duration) -> Result<PruneReport> {
232
        let now = std::time::SystemTime::now();
233
        let old_enough = |m: &fs::Metadata| m.modified().map(|t| now.duration_since(t).unwrap_or_default() >= grace).unwrap_or(true);
234
        let mut report = PruneReport::default();
235
        // Loose objects.
236
        for (r, path) in self.loose_objects()? {
237
            if keep.contains(&r) {
238
                continue;
239
            }
240
            let meta = fs::metadata(&path)?;
241
            if !old_enough(&meta) {
242
                report.deferred += 1;
243
                continue;
244
            }
245
            report.bytes += meta.len();
246
            report.objects += 1;
247
            fs::remove_file(&path)?;
248
            let _ = fs::remove_dir(path.parent().unwrap());
249
            self.remove_sidecars(&r)?;
250
        }
251
        // Packs: rewrite those that hold unreachable objects.
252
        let mut keep_refs: Vec<ObjectRef> = Vec::new();
253
        let mut old_paths: Vec<PathBuf> = Vec::new();
254
        let mut rewrite = false;
255
        for p in self.packs.borrow().iter() {
256
            let meta = fs::metadata(&p.path)?;
257
            let unreachable = p.refs.iter().filter(|r| !keep.contains(r)).count();
258
            if unreachable == 0 {
259
                continue;
260
            }
261
            if !old_enough(&meta) {
262
                report.deferred += unreachable;
263
                continue;
264
            }
265
            rewrite = true;
266
            old_paths.push(p.path.clone());
267
            for (r, e) in p.refs.iter().zip(p.entries.iter()) {
268
                if keep.contains(r) {
269
                    keep_refs.push(*r);
270
                } else {
271
                    report.objects += 1;
272
                    report.bytes += e.stored_len as u64;
273
                }
274
            }
275
        }
276
        if rewrite {
277
            let dropped: Vec<ObjectRef> = {
278
                let packs = self.packs.borrow();
279
                packs.iter().filter(|p| old_paths.contains(&p.path)).flat_map(|p| p.refs.iter().copied()).filter(|r| !keep.contains(r)).collect()
280
            };
281
            self.write_pack(&keep_refs, &[], &old_paths)?;
282
            for r in dropped {
283
                self.remove_sidecars(&r)?;
284
            }
285
        }
286
        Ok(report)
287
    }
288
289
    fn remove_sidecars(&self, r: &ObjectRef) -> Result<()> {
290
        for path in [self.sig_path(r), self.seal_index_path(r)] {
291
            match fs::remove_file(&path) {
292
                Ok(()) => {
293
                    let _ = fs::remove_dir(path.parent().unwrap());
294
                }
295
                Err(e) if e.kind() == io::ErrorKind::NotFound => {}
296
                Err(e) => return Err(e.into()),
297
            }
298
        }
299
        Ok(())
300
    }
301
302
    /// Write `refs` into a new pack, then delete `loose_paths` and `old_packs`.
303
    fn write_pack(&self, refs: &[ObjectRef], loose_paths: &[PathBuf], old_packs: &[PathBuf]) -> Result<PackReport> {
304
        if refs.is_empty() {
305
            for p in old_packs {
306
                fs::remove_file(p)?;
307
                fs::remove_file(p.with_extension("idx"))?;
308
            }
309
            self.reload_packs()?;
310
            return Ok(PackReport::default());
311
        }
312
        let mut refs: Vec<ObjectRef> = refs.to_vec();
313
        refs.sort();
314
        refs.dedup();
315
        let mut nonce = [0u8; 8];
316
        rand::rngs::OsRng.fill_bytes(&mut nonce);
317
        let id = hex::encode(nonce);
318
        let pack_path = self.dir.join(format!("pack-{id}.pack"));
319
        let idx_path = self.dir.join(format!("pack-{id}.idx"));
320
        let tmp_pack = self.dir.join(format!("tmp-{id}.pack"));
321
        let tmp_idx = self.dir.join(format!("tmp-{id}.idx"));
322
        let mut report = PackReport::default();
323
        let mut index: Vec<(ObjectRef, PackEntry)> = Vec::with_capacity(refs.len());
324
        {
325
            let mut f = io::BufWriter::new(fs::File::create(&tmp_pack)?);
326
            f.write_all(PACK_MAGIC)?;
327
            let mut offset = PACK_MAGIC.len() as u64;
328
            for r in &refs {
329
                let (ty, body) = self.get(r)?;
330
                let (flags, stored) = if self.is_nocompress(r) {
331
                    (0, body.clone())
332
                } else {
333
                    let compressed = zstd::bulk::compress(&body, ZSTD_LEVEL).map_err(|e| StoreError::Corrupt(*r, format!("zstd: {e}")))?;
334
                    if compressed.len() < body.len() { (FLAG_ZSTD, compressed) } else { (0, body.clone()) }
335
                };
336
                let header_len = 1 + 1 + 4 + 4 + 32;
337
                f.write_all(&[type_index(ty), flags])?;
338
                f.write_all(&(stored.len() as u32).to_le_bytes())?;
339
                f.write_all(&(body.len() as u32).to_le_bytes())?;
340
                f.write_all(&r.0)?;
341
                f.write_all(&stored)?;
342
                index.push((*r, PackEntry { offset: offset + header_len, stored_len: stored.len() as u32, raw_len: body.len() as u32, ty, flags }));
343
                offset += header_len + stored.len() as u64;
344
                report.objects += 1;
345
                report.raw_bytes += body.len() as u64;
346
                report.packed_bytes += stored.len() as u64;
347
            }
348
            f.flush()?;
349
            f.get_ref().sync_all()?;
350
        }
351
        {
352
            let mut f = io::BufWriter::new(fs::File::create(&tmp_idx)?);
353
            f.write_all(IDX_MAGIC)?;
354
            f.write_all(&(index.len() as u32).to_le_bytes())?;
355
            for (r, e) in &index {
356
                f.write_all(&r.0)?;
357
                f.write_all(&e.offset.to_le_bytes())?;
358
                f.write_all(&e.stored_len.to_le_bytes())?;
359
                f.write_all(&e.raw_len.to_le_bytes())?;
360
                f.write_all(&[type_index(e.ty), e.flags])?;
361
            }
362
            f.flush()?;
363
            f.get_ref().sync_all()?;
364
        }
365
        fs::rename(&tmp_pack, &pack_path)?;
366
        fs::rename(&tmp_idx, &idx_path)?;
367
        for p in old_packs {
368
            fs::remove_file(p)?;
369
            fs::remove_file(p.with_extension("idx"))?;
370
        }
371
        self.reload_packs()?;
372
        for path in loose_paths {
373
            fs::remove_file(path)?;
374
            if let Some(dir) = path.parent() {
375
                let _ = fs::remove_dir(dir);
376
            }
377
        }
378
        Ok(report)
379
    }
380
381
    pub fn dir(&self) -> &Path {
382
        &self.dir
383
    }
384
385
    fn path_for(&self, r: &ObjectRef) -> PathBuf {
386
        let h = r.to_hex();
387
        self.dir.join("loose").join(&h[..2]).join(&h[2..])
388
    }
389
390
    pub fn has(&self, r: &ObjectRef) -> bool {
391
        self.path_for(r).is_file() || self.find_packed(r).is_some()
392
    }
393
394
    /// Store `body` as an object of type `ty`; idempotent.
395
    pub fn put(&self, ty: ObjectType, body: &[u8]) -> Result<ObjectRef> {
396
        let r = hash_object(ty, body);
397
        let path = self.path_for(&r);
398
        if path.is_file() || self.find_packed(&r).is_some() {
399
            return Ok(r);
400
        }
401
        fs::create_dir_all(path.parent().unwrap())?;
402
        let mut nonce = [0u8; 8];
403
        rand::rngs::OsRng.fill_bytes(&mut nonce);
404
        let tmp = self.dir.join("loose").join(format!("tmp-{}", hex::encode(nonce)));
405
        {
406
            let mut f = fs::File::create(&tmp)?;
407
            f.write_all(&header(ty, body.len()))?;
408
            f.write_all(body)?;
409
            f.sync_all()?;
410
        }
411
        fs::rename(&tmp, &path)?;
412
        Ok(r)
413
    }
414
415
    /// Read and verify an object, loose or packed.
416
    pub fn get(&self, r: &ObjectRef) -> Result<(ObjectType, Vec<u8>)> {
417
        let path = self.path_for(r);
418
        let data = match fs::read(&path) {
419
            Ok(d) => d,
420
            Err(e) if e.kind() == io::ErrorKind::NotFound => {
421
                return match self.find_packed(r) {
422
                    Some((i, e)) => self.packs.borrow()[i].read(r, e),
423
                    None => Err(StoreError::NotFound(*r)),
424
                };
425
            }
426
            Err(e) => return Err(e.into()),
427
        };
428
        let nul = data.iter().position(|&b| b == 0).ok_or_else(|| StoreError::Corrupt(*r, "no header".into()))?;
429
        let head = std::str::from_utf8(&data[..nul]).map_err(|_| StoreError::Corrupt(*r, "header not UTF-8".into()))?;
430
        let mut parts = head.split(' ');
431
        let (Some("oxy1"), Some(ty), Some(len), None) = (parts.next(), parts.next(), parts.next(), parts.next()) else {
432
            return Err(StoreError::Corrupt(*r, format!("bad header {head:?}")));
433
        };
434
        let ty = ObjectType::from_name(ty).ok_or_else(|| StoreError::Corrupt(*r, format!("unknown type {ty}")))?;
435
        let len: usize = len.parse().map_err(|_| StoreError::Corrupt(*r, "bad length".into()))?;
436
        let body = &data[nul + 1..];
437
        if body.len() != len {
438
            return Err(StoreError::Corrupt(*r, format!("length {} != header {len}", body.len())));
439
        }
440
        if hash_object(ty, body) != *r {
441
            return Err(StoreError::Corrupt(*r, "hash mismatch".into()));
442
        }
443
        Ok((ty, body.to_vec()))
444
    }
445
446
    pub fn get_typed(&self, r: &ObjectRef, want: ObjectType) -> Result<Vec<u8>> {
447
        let (ty, body) = self.get(r)?;
448
        if ty != want {
449
            return Err(StoreError::WrongType(*r, ty.name(), want.name()));
450
        }
451
        Ok(body)
452
    }
453
454
    pub fn put_change(&self, c: &Change) -> Result<ObjectRef> {
455
        self.put(ObjectType::Change, &c.encode())
456
    }
457
458
    pub fn get_change(&self, r: &ObjectRef) -> Result<Change> {
459
        Ok(Change::decode(&self.get_typed(r, ObjectType::Change)?)?)
460
    }
461
462
    pub fn put_chunk(&self, bytes: &[u8]) -> Result<ObjectRef> {
463
        self.put(ObjectType::Chunk, bytes)
464
    }
465
466
    /// Store a chunk that packs will keep uncompressed (`nocompress`, spec §13.3).
467
    pub fn put_chunk_nocompress(&self, bytes: &[u8]) -> Result<ObjectRef> {
468
        let r = self.put(ObjectType::Chunk, bytes)?;
469
        let dir = self.dir.join("nocompress");
470
        fs::create_dir_all(&dir)?;
471
        let _ = fs::File::create(dir.join(r.to_hex()));
472
        Ok(r)
473
    }
474
475
    fn is_nocompress(&self, r: &ObjectRef) -> bool {
476
        self.dir.join("nocompress").join(r.to_hex()).exists()
477
    }
478
479
    pub fn put_state(&self, st: &StateObject) -> Result<ObjectRef> {
480
        self.put(ObjectType::State, &st.encode())
481
    }
482
483
    pub fn get_state(&self, r: &ObjectRef) -> Result<StateObject> {
484
        Ok(StateObject::decode(&self.get_typed(r, ObjectType::State)?)?)
485
    }
486
487
    pub fn put_attest(&self, a: &Attest) -> Result<ObjectRef> {
488
        self.put(ObjectType::Attest, &a.encode())
489
    }
490
491
    pub fn get_attest(&self, r: &ObjectRef) -> Result<Attest> {
492
        Ok(Attest::decode(&self.get_typed(r, ObjectType::Attest)?)?)
493
    }
494
495
    fn seal_index_path(&self, change: &ObjectRef) -> PathBuf {
496
        let h = change.to_hex();
497
        self.dir.join("seals").join(&h[..2]).join(&h[2..])
498
    }
499
500
    /// Record that seal attestation `attest` covers `change`.
501
    pub fn index_seal(&self, change: &ObjectRef, attest: &ObjectRef) -> Result<()> {
502
        let mut seals = self.seals_for(change)?;
503
        if seals.contains(attest) {
504
            return Ok(());
505
        }
506
        seals.push(*attest);
507
        seals.sort();
508
        let path = self.seal_index_path(change);
509
        fs::create_dir_all(path.parent().unwrap())?;
510
        let text: String = seals.iter().map(|s| format!("{}\n", s.to_hex())).collect();
511
        let tmp = path.with_extension("tmp");
512
        fs::write(&tmp, text)?;
513
        fs::rename(&tmp, &path)?;
514
        Ok(())
515
    }
516
517
    /// Seal attestations known to cover `change`.
518
    pub fn seals_for(&self, change: &ObjectRef) -> Result<Vec<ObjectRef>> {
519
        match fs::read_to_string(self.seal_index_path(change)) {
520
            Ok(t) => Ok(t.lines().filter_map(ObjectRef::from_hex).collect()),
521
            Err(e) if e.kind() == io::ErrorKind::NotFound => Ok(vec![]),
522
            Err(e) => Err(e.into()),
523
        }
524
    }
525
526
    pub fn put_identity(&self, id: &Identity) -> Result<ObjectRef> {
527
        self.put(ObjectType::Identity, &id.encode())
528
    }
529
530
    pub fn get_identity(&self, r: &ObjectRef) -> Result<Identity> {
531
        Ok(Identity::decode(&self.get_typed(r, ObjectType::Identity)?)?)
532
    }
533
534
    fn sig_path(&self, r: &ObjectRef) -> PathBuf {
535
        let h = r.to_hex();
536
        self.dir.join("sigs").join(&h[..2]).join(&h[2..])
537
    }
538
539
    /// Signatures stored alongside object `r` (spec §5.4). Empty if none.
540
    pub fn signatures(&self, r: &ObjectRef) -> Result<Vec<Signature>> {
541
        match fs::read(self.sig_path(r)) {
542
            Ok(b) => Ok(Signature::decode_list(&b)?),
543
            Err(e) if e.kind() == io::ErrorKind::NotFound => Ok(vec![]),
544
            Err(e) => Err(e.into()),
545
        }
546
    }
547
548
    /// Attach a signature to object `r`, replacing any earlier one by the same key.
549
    pub fn put_signature(&self, r: &ObjectRef, sig: &Signature) -> Result<()> {
550
        let mut sigs = self.signatures(r)?;
551
        sigs.retain(|s| s.key != sig.key);
552
        sigs.push(sig.clone());
553
        sigs.sort_by_key(|s| s.key);
554
        let path = self.sig_path(r);
555
        fs::create_dir_all(path.parent().unwrap())?;
556
        let mut nonce = [0u8; 8];
557
        rand::rngs::OsRng.fill_bytes(&mut nonce);
558
        let tmp = self.dir.join(format!("sigs-tmp-{}", hex::encode(nonce)));
559
        {
560
            let mut f = fs::File::create(&tmp)?;
561
            f.write_all(&Signature::encode_list(&sigs))?;
562
            f.sync_all()?;
563
        }
564
        fs::rename(&tmp, &path)?;
565
        Ok(())
566
    }
567
568
    /// Every object reference in the store, loose and packed (slow; for gc and tests).
569
    pub fn list(&self) -> io::Result<Vec<ObjectRef>> {
570
        let mut out: Vec<ObjectRef> = self.loose_objects()?.into_iter().map(|(r, _)| r).collect();
571
        for p in self.packs.borrow().iter() {
572
            out.extend(p.refs.iter().copied());
573
        }
574
        out.sort();
575
        out.dedup();
576
        Ok(out)
577
    }
578
}
579
580
#[cfg(test)]
581
mod tests {
582
    use super::*;
583
584
    #[test]
585
    fn put_get_verify() {
586
        let dir = tempfile::tempdir().unwrap();
587
        let s = Store::open(dir.path().join("objects")).unwrap();
588
        let r = s.put(ObjectType::Chunk, b"hello").unwrap();
589
        assert!(s.has(&r));
590
        assert_eq!(s.get(&r).unwrap(), (ObjectType::Chunk, b"hello".to_vec()));
591
        assert_eq!(s.put(ObjectType::Chunk, b"hello").unwrap(), r);
592
        assert_eq!(s.list().unwrap(), vec![r]);
593
        assert!(matches!(s.get_typed(&r, ObjectType::Blob), Err(StoreError::WrongType(..))));
594
        assert!(matches!(s.get(&ObjectRef([9; 32])), Err(StoreError::NotFound(_))));
595
596
        // Tamper: flip a byte, read must fail.
597
        let path = s.path_for(&r);
598
        let mut data = fs::read(&path).unwrap();
599
        let last = data.len() - 1;
600
        data[last] ^= 1;
601
        fs::write(&path, data).unwrap();
602
        assert!(matches!(s.get(&r), Err(StoreError::Corrupt(..))));
603
    }
604
605
    #[test]
606
    fn packing_keeps_every_object_readable() {
607
        let dir = tempfile::tempdir().unwrap();
608
        let s = Store::open(dir.path()).unwrap();
609
        let mut refs = Vec::new();
610
        for i in 0..300u32 {
611
            let body = format!("object {i} ").repeat(1 + (i % 7) as usize);
612
            refs.push((s.put(ObjectType::Chunk, body.as_bytes()).unwrap(), body));
613
        }
614
        let c = crate::objects::tests::sample_change();
615
        let cr = s.put_change(&c).unwrap();
616
        assert_eq!(s.loose_count().unwrap(), 301);
617
        let report = s.pack_loose().unwrap();
618
        assert_eq!(report.objects, 301);
619
        assert!(report.packed_bytes < report.raw_bytes, "{report:?}");
620
        assert_eq!(s.loose_count().unwrap(), 0);
621
        assert_eq!(s.pack_count(), 1);
622
        for (r, body) in &refs {
623
            assert!(s.has(r));
624
            assert_eq!(s.get(r).unwrap(), (ObjectType::Chunk, body.as_bytes().to_vec()));
625
        }
626
        assert_eq!(s.get_change(&cr).unwrap(), c);
627
        assert_eq!(s.list().unwrap().len(), 301);
628
        // Re-putting a packed object is a no-op; new objects go loose and a
629
        // second pack coexists with the first.
630
        assert_eq!(s.put(ObjectType::Chunk, refs[0].1.as_bytes()).unwrap(), refs[0].0);
631
        assert_eq!(s.loose_count().unwrap(), 0);
632
        let extra = s.put(ObjectType::Chunk, b"after packing").unwrap();
633
        s.pack_loose().unwrap();
634
        assert_eq!(s.pack_count(), 2);
635
        assert_eq!(s.get(&extra).unwrap().1, b"after packing");
636
        // A reopened store sees the packs.
637
        let s2 = Store::open(dir.path()).unwrap();
638
        assert_eq!(s2.pack_count(), 2);
639
        assert_eq!(s2.get(&refs[5].0).unwrap().1, refs[5].1.as_bytes());
640
        assert!(matches!(s2.get(&ObjectRef([9; 32])), Err(StoreError::NotFound(_))));
641
        // Corrupting an object's body inside the pack is detected on read.
642
        let target = refs[5].0;
643
        let (pack_path, offset) = {
644
            let packs = s2.packs.borrow();
645
            let (i, e) = s2.find_packed(&target).unwrap();
646
            (packs[i].path.clone(), e.offset as usize)
647
        };
648
        let mut data = fs::read(&pack_path).unwrap();
649
        data[offset] ^= 0xff;
650
        fs::write(&pack_path, data).unwrap();
651
        let s3 = Store::open(dir.path()).unwrap();
652
        assert!(matches!(s3.get(&target), Err(StoreError::Corrupt(..))));
653
        assert_eq!(s3.get(&refs[6].0).unwrap().1, refs[6].1.as_bytes(), "other objects are unaffected");
654
    }
655
656
    #[test]
657
    fn nocompress_chunks_pack_raw() {
658
        let dir = tempfile::tempdir().unwrap();
659
        let s = Store::open(dir.path()).unwrap();
660
        let body = vec![b'a'; 10_000];
661
        let raw = s.put_chunk_nocompress(&body).unwrap();
662
        let compressible = s.put(ObjectType::Chunk, &vec![b'b'; 10_000]).unwrap();
663
        s.pack_loose().unwrap();
664
        let packs = s.packs.borrow();
665
        let (i, e) = s.find_packed(&raw).unwrap();
666
        assert_eq!((e.flags, e.stored_len as usize), (0, 10_000));
667
        let (_, c) = s.find_packed(&compressible).unwrap();
668
        assert_eq!(c.flags, FLAG_ZSTD);
669
        assert!(c.stored_len < 10_000);
670
        assert_eq!(packs[i].read(&raw, e).unwrap().1, body);
671
    }
672
673
    #[test]
674
    fn many_packs_merge_into_one() {
675
        let dir = tempfile::tempdir().unwrap();
676
        let s = Store::open(dir.path()).unwrap();
677
        let mut refs = Vec::new();
678
        for i in 0..(MAX_PACKS + 2) {
679
            refs.push(s.put(ObjectType::Chunk, format!("pack {i}").as_bytes()).unwrap());
680
            s.pack_loose().unwrap();
681
        }
682
        assert_eq!(s.pack_count(), MAX_PACKS + 2);
683
        assert_eq!(s.merge_packs().unwrap(), MAX_PACKS + 2);
684
        assert_eq!(s.pack_count(), 1);
685
        assert_eq!(s.merge_packs().unwrap(), 0);
686
        for (i, r) in refs.iter().enumerate() {
687
            assert_eq!(s.get(r).unwrap().1, format!("pack {i}").as_bytes());
688
        }
689
        assert_eq!(Store::open(dir.path()).unwrap().pack_count(), 1);
690
    }
691
692
    #[test]
693
    fn prune_removes_unreachable_loose_and_packed_objects() {
694
        use std::collections::HashSet;
695
        let dir = tempfile::tempdir().unwrap();
696
        let s = Store::open(dir.path()).unwrap();
697
        let keep_a = s.put(ObjectType::Chunk, b"keep a").unwrap();
698
        let drop_a = s.put(ObjectType::Chunk, b"drop a").unwrap();
699
        s.pack_loose().unwrap();
700
        let keep_b = s.put(ObjectType::Chunk, b"keep b").unwrap();
701
        let drop_b = s.put(ObjectType::Chunk, b"drop b").unwrap();
702
        let sk = crate::identity::SecretKey { ed_seed: [1; 32], ml_seed: [2; 32] };
703
        let id = sk.identity("a", "b", 0);
704
        let key = s.put_identity(&id).unwrap();
705
        s.put_signature(&drop_b, &sk.sign(crate::identity::Domain::Change, &key, &drop_b)).unwrap();
706
        s.index_seal(&drop_a, &ObjectRef([3; 32])).unwrap();
707
        let keep: HashSet<ObjectRef> = [keep_a, keep_b, key].into_iter().collect();
708
        // Everything is too young under a grace period.
709
        let r = s.prune(&keep, std::time::Duration::from_secs(3600)).unwrap();
710
        assert_eq!((r.objects, r.deferred), (0, 2));
711
        let r = s.prune(&keep, std::time::Duration::ZERO).unwrap();
712
        assert_eq!(r.objects, 2, "{r:?}");
713
        assert!(s.has(&keep_a) && s.has(&keep_b) && s.has(&key));
714
        assert!(!s.has(&drop_a) && !s.has(&drop_b));
715
        assert!(s.signatures(&drop_b).unwrap().is_empty());
716
        assert!(s.seals_for(&drop_a).unwrap().is_empty());
717
        assert_eq!(s.pack_count(), 1);
718
        assert_eq!(s.get(&keep_a).unwrap().1, b"keep a");
719
        assert_eq!(s.list().unwrap().len(), 3);
720
    }
721
722
    #[test]
723
    fn signatures_are_stored_beside_objects() {
724
        use crate::identity::{Domain, SecretKey};
725
        let dir = tempfile::tempdir().unwrap();
726
        let s = Store::open(dir.path()).unwrap();
727
        let r = s.put(ObjectType::Chunk, b"x").unwrap();
728
        assert!(s.signatures(&r).unwrap().is_empty());
729
        let sk = SecretKey { ed_seed: [1; 32], ml_seed: [2; 32] };
730
        let id = sk.identity("a", "b", 0);
731
        let key = s.put_identity(&id).unwrap();
732
        assert_eq!(s.get_identity(&key).unwrap(), id);
733
        let sig = sk.sign(Domain::Change, &key, &r);
734
        s.put_signature(&r, &sig).unwrap();
735
        s.put_signature(&r, &sig).unwrap();
736
        assert_eq!(s.signatures(&r).unwrap(), vec![sig]);
737
        // The object itself is untouched by its signatures.
738
        assert_eq!(s.get(&r).unwrap().1, b"x");
739
    }
740
741
    #[test]
742
    fn change_round_trip_through_store() {
743
        let dir = tempfile::tempdir().unwrap();
744
        let s = Store::open(dir.path()).unwrap();
745
        let c = crate::objects::tests::sample_change();
746
        let r = s.put_change(&c).unwrap();
747
        assert_eq!(r, c.hash());
748
        assert_eq!(s.get_change(&r).unwrap(), c);
749
    }
750
}