OXYGENHUB
# c96354484bd9 oxygen / crates / oxy-core / src / store.rs
101.1 KiB · Rust · last changed The issuer countersigns when it accepted a certified update (keyless step 4c) 19 days ago source blame history raw
64818938 Andy McCall ↶ 1
//! Object store (spec §13.1, §13.3, §13.4): loose objects, one per key
2
//! under `loose/<hh>/<rest>`, and packs, `pack-<id>.pack` with a sorted
3
//! `pack-<id>.idx`, holding zstd-compressed objects. Reads check loose
4
//! objects first, then every pack; every read re-hashes.
d02e545d Andy McCall ↶ 5
//!
64818938 Andy McCall ↶ 6
//! Everything is kept on a [`crate::strata::Store`] (docs/stores.md): a
7
//! directory, which is what `.oxy/objects` is, or a bucket, which is how a
8
//! repository lives in its owner's region with the hub as one client of
9
//! it. The keys are the same wherever the store is, so a bucket holds
10
//! exactly what a directory would, and a directory store is as fast as
11
//! the files were before there was a trait: a loose object is one file, a
12
//! packed one is one ranged read of the pack. What must be local, the
13
//! pack being streamed out and the derived `metas` cache, lives in a
14
//! scratch directory.
15
//!
d02e545d Andy McCall ↶ 16
//! Pack file: `OXYPACK1` then entries of
17
//! `type u8 | flags u8 (bit 0: zstd) | stored_len u32 | raw_len u32 | ref 32 | body`.
18
//! Index file: `OXYIDX01` then `count u32` then sorted entries of
19
//! `ref 32 | offset u64 | stored_len u32 | raw_len u32 | type u8 | flags u8`.
64818938 Andy McCall ↶ 20
//!
21
//! Beside the objects: `nocompress/<hex>` marks a chunk packs keep raw;
22
//! `sig/<hh>/<rest>/<key>` holds one signature over an object, written
23
//! once per signer; `seal/<hh>/<rest>/<attest>` and
24
//! `receipt/<hh>/<rest>/<attest>` index the seals covering a change and
25
//! the receipts on a state. Older stores hold these as one list per
26
//! object (`sigs/`, `seals/`, `receipts/`), which are still read.
ff0af1ee unknown 27
5b9c6ad4 Andy McCall ↶ 28
use crate::attest::Attest;
ff0af1ee unknown 29
use crate::hash::{hash_object, header, ObjectRef, ObjectType};
1983686f Andy McCall ↶ 30
use crate::identity::{Identity, Signature};
6f8aeb99 Andy McCall ↶ 31
use crate::objects::{Blob, Change, ObjectError, StateObject};
fc1a466a Andy McCall ↶ 32
use crate::receipt::Receipt;
64818938 Andy McCall ↶ 33
use crate::strata::{self, Error as BackendError, LocalStore, MemoryStore};
ff0af1ee unknown 34
use rand::RngCore;
d02e545d Andy McCall ↶ 35
use std::cell::RefCell;
ff0af1ee unknown 36
use std::fs;
64818938 Andy McCall ↶ 37
use std::io::{self, Write};
ff0af1ee unknown 38
use std::path::{Path, PathBuf};
64818938 Andy McCall ↶ 39
use std::sync::Arc;
ff0af1ee unknown 40
d02e545d Andy McCall ↶ 41
const PACK_MAGIC: &[u8; 8] = b"OXYPACK1";
42
const IDX_MAGIC: &[u8; 8] = b"OXYIDX01";
43
const IDX_ENTRY: usize = 32 + 8 + 4 + 4 + 1 + 1;
44
const FLAG_ZSTD: u8 = 1;
a17fc622 Andy McCall ↶ 45
/// Compressed with the pack's trained dictionary (`pack-ID.dict`), which a
46
/// full repack makes from a sample of the objects it packs: small files
47
/// share most of their vocabulary, which each one alone cannot use.
48
const FLAG_DICT: u8 = 2;
49
/// The size of a pack's dictionary, and the least a repack must pack for
50
/// one to pay.
51
const DICT_BYTES: usize = 110 << 10;
52
const DICT_MIN_OBJECTS: usize = 1000;
53
/// Objects up to this size are compressed with the dictionary.
54
const DICT_OBJECT_MAX: usize = 64 << 10;
d02e545d Andy McCall ↶ 55
const ZSTD_LEVEL: i32 = 3;
da652d63 Andy McCall ↶ 56
/// The level of a full repack (`oxy gc`): slower, once, for a smaller store.
57
pub const REPACK_ZSTD_LEVEL: i32 = 9;
2b872d07 Andy McCall ↶ 58
/// Largest object a pack entry may claim; anything bigger is corruption,
59
/// and refusing it keeps a bad index from driving huge allocations.
60
const MAX_OBJECT_LEN: u32 = 1 << 30;
d02e545d Andy McCall ↶ 61
afaba5f1 Andy McCall ↶ 62
/// An object read from the store: its type and body.
63
pub type Object = (ObjectType, Vec<u8>);
64
9ae4d15a Andy McCall ↶ 65
/// Where a long operation reports what it is doing (oxygen#66): a phase,
66
/// or a count within one, as a line for a spinner or a log.
67
pub type Progress<'a> = &'a mut dyn FnMut(&str);
64818938 Andy McCall ↶ 68
69
/// The storage under a store: objects by key, see [`crate::strata`].
70
pub type Backend = dyn strata::Store;
9ae4d15a Andy McCall ↶ 71
72
fn silent() -> impl FnMut(&str) {
73
    |_| {}
64818938 Andy McCall ↶ 74
}
75
76
/// A backend error as a store error: what is not found or already there
77
/// is handled where it matters; the rest is an I/O failure.
78
fn backend_err(e: BackendError) -> StoreError {
79
    match e {
80
        BackendError::Io(e) => StoreError::Io(e),
81
        other => StoreError::Io(io::Error::other(other.to_string())),
82
    }
83
}
84
85
/// `put_new` where an object already there is what we wanted.
86
fn put_new_or_existing(backend: &Backend, key: &str, bytes: &[u8]) -> Result<()> {
87
    match backend.put_new(key, bytes) {
88
        Ok(()) | Err(BackendError::Exists(_)) => Ok(()),
89
        Err(e) => Err(backend_err(e)),
90
    }
91
}
92
93
/// `get` as an option: `None` when there is no such key.
94
fn get_optional(backend: &Backend, key: &str) -> Result<Option<Vec<u8>>> {
95
    match backend.get(key) {
96
        Ok(b) => Ok(Some(b)),
97
        Err(BackendError::NotFound(_)) => Ok(None),
98
        Err(e) => Err(backend_err(e)),
99
    }
100
}
101
102
fn delete(backend: &Backend, key: &str) -> Result<()> {
103
    backend.delete(key).map_err(backend_err)
104
}
105
106
/// `loose/<hh>/<rest>`.
107
fn loose_key(r: &ObjectRef) -> String {
108
    let h = r.to_hex();
109
    format!("loose/{}/{}", &h[..2], &h[2..])
110
}
111
112
/// The object a loose key names, if it is one.
113
fn loose_ref(key: &str) -> Option<ObjectRef> {
114
    let rest = key.strip_prefix("loose/")?;
115
    let (hh, tail) = rest.split_once('/')?;
116
    if hh.len() != 2 || tail.contains('/') {
117
        return None;
118
    }
119
    ObjectRef::from_hex(&format!("{hh}{tail}"))
120
}
121
122
/// `<index>/<hh>/<rest>/` for the entries kept under an object.
123
fn fanout_prefix(index: &str, r: &ObjectRef) -> String {
124
    let h = r.to_hex();
125
    format!("{index}/{}/{}/", &h[..2], &h[2..])
126
}
127
128
/// `<index>/<hh>/<rest>`: the one-file-per-object layout of older stores.
129
fn legacy_key(index: &str, r: &ObjectRef) -> String {
130
    let h = r.to_hex();
131
    format!("{index}/{}/{}", &h[..2], &h[2..])
9ae4d15a Andy McCall ↶ 132
}
133
64818938 Andy McCall ↶ 134
fn now_ms() -> u64 {
135
    std::time::SystemTime::now()
136
        .duration_since(std::time::UNIX_EPOCH)
137
        .map(|d| d.as_millis() as u64)
138
        .unwrap_or(0)
139
}
140
d02e545d Andy McCall ↶ 141
#[derive(Clone, Copy, Debug)]
142
struct PackEntry {
143
    offset: u64,
144
    stored_len: u32,
145
    raw_len: u32,
146
    ty: ObjectType,
147
    flags: u8,
148
}
149
150
/// One pack's index, fully in memory and sorted by ObjectRef.
151
struct PackIndex {
64818938 Andy McCall ↶ 152
    /// The pack's key, `pack-<id>.pack`.
153
    key: String,
d02e545d Andy McCall ↶ 154
    refs: Vec<ObjectRef>,
155
    entries: Vec<PackEntry>,
a17fc622 Andy McCall ↶ 156
    /// The pack's dictionary, prepared once, when it has one.
64818938 Andy McCall ↶ 157
    dict: Option<Arc<zstd::dict::DecoderDictionary<'static>>>,
d02e545d Andy McCall ↶ 158
}
159
a17fc622 Andy McCall ↶ 160
impl std::fmt::Debug for PackIndex {
161
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
162
        f.debug_struct("PackIndex")
64818938 Andy McCall ↶ 163
            .field("key", &self.key)
a17fc622 Andy McCall ↶ 164
            .field("objects", &self.refs.len())
165
            .field("dict", &self.dict.is_some())
166
            .finish()
64818938 Andy McCall ↶ 167
    }
168
}
169
170
/// Decode a stored pack entry and check it against its reference.
171
fn decode_entry(
172
    r: &ObjectRef,
173
    e: PackEntry,
174
    stored: Vec<u8>,
175
    dict: Option<&Arc<zstd::dict::DecoderDictionary<'static>>>,
176
) -> Result<Object> {
177
    let body = if e.flags & FLAG_DICT != 0 {
178
        let dict = dict.ok_or_else(|| {
179
            StoreError::Corrupt(*r, "packed with a dictionary the pack lacks".into())
180
        })?;
181
        zstd::bulk::Decompressor::with_prepared_dictionary(dict)
182
            .and_then(|mut d| d.decompress(&stored, e.raw_len as usize))
183
            .map_err(|err| StoreError::Corrupt(*r, format!("zstd: {err}")))?
184
    } else if e.flags & FLAG_ZSTD != 0 {
185
        zstd::bulk::decompress(&stored, e.raw_len as usize)
186
            .map_err(|err| StoreError::Corrupt(*r, format!("zstd: {err}")))?
187
    } else {
188
        stored
189
    };
190
    if body.len() != e.raw_len as usize || hash_object(e.ty, &body) != *r {
191
        return Err(StoreError::Corrupt(
192
            *r,
193
            "packed object does not match its reference".into(),
194
        ));
a17fc622 Andy McCall ↶ 195
    }
64818938 Andy McCall ↶ 196
    Ok((e.ty, body))
a17fc622 Andy McCall ↶ 197
}
198
d02e545d Andy McCall ↶ 199
impl PackIndex {
64818938 Andy McCall ↶ 200
    fn load(backend: &Backend, idx_key: &str, pack_key: &str) -> Result<PackIndex> {
201
        let data = backend.get(idx_key).map_err(backend_err)?;
202
        let bad = |m: &str| StoreError::Corrupt(ObjectRef::ZERO, format!("{idx_key}: {m}"));
d02e545d Andy McCall ↶ 203
        if data.len() < 12 || &data[..8] != IDX_MAGIC {
204
            return Err(bad("bad index header"));
205
        }
206
        let count = u32::from_le_bytes(data[8..12].try_into().unwrap()) as usize;
207
        if data.len() != 12 + count * IDX_ENTRY {
208
            return Err(bad("index length mismatch"));
209
        }
64818938 Andy McCall ↶ 210
        let pack_len = backend
211
            .stat(pack_key)
212
            .map_err(backend_err)?
213
            .ok_or_else(|| bad("the index names a pack that is not there"))?
214
            .size;
d02e545d Andy McCall ↶ 215
        let mut refs = Vec::with_capacity(count);
216
        let mut entries = Vec::with_capacity(count);
217
        for i in 0..count {
218
            let e = &data[12 + i * IDX_ENTRY..12 + (i + 1) * IDX_ENTRY];
219
            let r = ObjectRef::from_slice(&e[..32]).unwrap();
220
            if let Some(prev) = refs.last() {
221
                if r <= *prev {
222
                    return Err(bad("index not sorted"));
223
                }
224
            }
225
            refs.push(r);
2b872d07 Andy McCall ↶ 226
            let entry = PackEntry {
d02e545d Andy McCall ↶ 227
                offset: u64::from_le_bytes(e[32..40].try_into().unwrap()),
228
                stored_len: u32::from_le_bytes(e[40..44].try_into().unwrap()),
229
                raw_len: u32::from_le_bytes(e[44..48].try_into().unwrap()),
75167672 Andy McCall 230
                ty: ObjectType::ALL
231
                    .get(e[48] as usize)
232
                    .copied()
233
                    .ok_or_else(|| bad("unknown object type"))?,
d02e545d Andy McCall ↶ 234
                flags: e[49],
2b872d07 Andy McCall ↶ 235
            };
a9f686ed Andy McCall ↶ 236
            if entry.stored_len > MAX_OBJECT_LEN || entry.raw_len > MAX_OBJECT_LEN {
237
                return Err(StoreError::Corrupt(
238
                    r,
239
                    format!(
64818938 Andy McCall ↶ 240
                        "{idx_key}: the index claims an object of {} bytes ({} stored), more than the {MAX_OBJECT_LEN} an object may be",
241
                        entry.raw_len, entry.stored_len
a9f686ed Andy McCall ↶ 242
                    ),
243
                ));
244
            }
245
            if entry.offset.saturating_add(entry.stored_len as u64) > pack_len {
2b872d07 Andy McCall ↶ 246
                return Err(bad("index entry points outside the pack"));
247
            }
248
            entries.push(entry);
d02e545d Andy McCall ↶ 249
        }
64818938 Andy McCall ↶ 250
        let dict_key = format!("{}.dict", pack_key.trim_end_matches(".pack"));
251
        let dict = get_optional(backend, &dict_key)?
252
            .map(|d| Arc::new(zstd::dict::DecoderDictionary::copy(&d)));
75167672 Andy McCall 253
        Ok(PackIndex {
64818938 Andy McCall ↶ 254
            key: pack_key.to_string(),
75167672 Andy McCall 255
            refs,
256
            entries,
a17fc622 Andy McCall ↶ 257
            dict,
75167672 Andy McCall 258
        })
d02e545d Andy McCall ↶ 259
    }
260
261
    fn find(&self, r: &ObjectRef) -> Option<PackEntry> {
262
        self.refs.binary_search(r).ok().map(|i| self.entries[i])
263
    }
264
64818938 Andy McCall ↶ 265
    /// Read one entry from the pack: one ranged read, then decode.
266
    fn fetch(&self, backend: &Backend, r: &ObjectRef, e: PackEntry) -> Result<Object> {
267
        let stored = backend
268
            .get_range(&self.key, e.offset..e.offset + e.stored_len as u64)
269
            .map_err(|err| match err {
270
                BackendError::NotFound(_) => StoreError::NotFound(*r),
271
                other => backend_err(other),
a17fc622 Andy McCall ↶ 272
            })?;
64818938 Andy McCall ↶ 273
        decode_entry(r, e, stored, self.dict.as_ref())
d02e545d Andy McCall ↶ 274
    }
275
}
276
277
fn type_index(ty: ObjectType) -> u8 {
278
    ObjectType::ALL.iter().position(|t| *t == ty).unwrap() as u8
279
}
280
281
/// What `pack_loose` did.
282
#[derive(Debug, Clone, Default, PartialEq, Eq)]
283
pub struct PackReport {
284
    pub objects: usize,
285
    pub raw_bytes: u64,
286
    pub packed_bytes: u64,
287
}
288
135212de Andy McCall ↶ 289
/// Packs tolerated before `merge_packs` folds them into one (spec §13.4).
290
pub const MAX_PACKS: usize = 16;
291
ba160f60 Andy McCall ↶ 292
/// What `prune` did.
293
#[derive(Debug, Clone, Default, PartialEq, Eq)]
294
pub struct PruneReport {
295
    pub objects: usize,
296
    pub bytes: u64,
297
    /// Unreachable objects left alone because they are younger than the grace period.
298
    pub deferred: usize,
299
}
300
ff0af1ee unknown 301
#[derive(Debug, thiserror::Error)]
302
pub enum StoreError {
303
    #[error("io: {0}")]
304
    Io(#[from] io::Error),
305
    #[error("corrupt object {0}: {1}")]
306
    Corrupt(ObjectRef, String),
307
    #[error("object {0}")]
308
    Object(#[from] ObjectError),
309
    #[error("object {0} is a {1}, expected {2}")]
310
    WrongType(ObjectRef, &'static str, &'static str),
311
    #[error("object {0} not found")]
312
    NotFound(ObjectRef),
6f8aeb99 Andy McCall ↶ 313
    #[error("a {kind} object of {size} bytes is larger than the {limit} bytes an object may be; nothing was stored. A change this large adds or touches too many files at once: commit it in parts (a directory at a time)")]
a9f686ed Andy McCall ↶ 314
    TooLarge {
315
        kind: &'static str,
316
        size: usize,
317
        limit: u32,
318
    },
ff0af1ee unknown 319
}
320
321
pub type Result<T> = std::result::Result<T, StoreError>;
322
323
pub struct Store {
64818938 Andy McCall ↶ 324
    backend: Arc<Backend>,
325
    /// Temporary files (a pack being streamed) and derived caches (`metas`).
326
    /// For a store in a directory it is that directory.
327
    scratch: PathBuf,
328
    /// The backend is that directory, so the old file paths still hold.
329
    local: bool,
d02e545d Andy McCall ↶ 330
    packs: RefCell<Vec<PackIndex>>,
8f10a07a Andy McCall ↶ 331
    /// An open write batch (spec §13.4): objects go here instead of to loose
332
    /// files, and are written out with one `fsync` when the batch finishes.
333
    pending: RefCell<Option<Pending>>,
334
    batch_depth: std::cell::Cell<u32>,
ce14f0d6 Andy McCall ↶ 335
    /// Change metadata already read, from the `metas` cache file.
336
    metas: RefCell<Option<crate::fasthash::FastMap<ObjectRef, crate::state::ChangeMeta>>>,
8f10a07a Andy McCall ↶ 337
}
338
64818938 Andy McCall ↶ 339
impl std::fmt::Debug for Store {
340
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
341
        f.debug_struct("Store")
342
            .field("backend", &self.backend.describe())
343
            .field("scratch", &self.scratch)
344
            .field("packs", &self.packs.borrow().len())
345
            .finish()
346
    }
347
}
348
8f10a07a Andy McCall ↶ 349
/// Objects written since `begin_batch`. Small batches stay in memory and
350
/// become loose objects; once `SPILL_OBJECTS` or `SPILL_BYTES` is exceeded
351
/// the batch streams into a pack file instead.
352
#[derive(Debug)]
353
struct Pending {
354
    buffered: Vec<(ObjectType, Vec<u8>)>,
355
    buffered_bytes: usize,
356
    lookup: std::collections::HashMap<ObjectRef, PendingEntry>,
357
    pack: Option<PendingPack>,
358
    report: PackReport,
ff0af1ee unknown 359
}
360
8f10a07a Andy McCall ↶ 361
#[derive(Debug, Clone, Copy)]
362
enum PendingEntry {
363
    Buffered(usize),
364
    Packed(PackEntry),
365
}
366
367
#[derive(Debug)]
368
struct PendingPack {
369
    id: String,
370
    tmp_path: PathBuf,
371
    writer: io::BufWriter<fs::File>,
372
    offset: u64,
373
    index: Vec<(ObjectRef, PackEntry)>,
374
}
375
376
const SPILL_OBJECTS: usize = 256;
377
const SPILL_BYTES: usize = 8 << 20;
378
379
/// Finishes the enclosing batch when dropped; call `finish` to see errors.
380
pub struct Batch<'a> {
381
    store: &'a Store,
382
    done: bool,
383
}
384
385
impl Batch<'_> {
386
    pub fn finish(mut self) -> Result<()> {
387
        self.done = true;
388
        self.store.finish_batch()
389
    }
390
}
391
392
impl Drop for Batch<'_> {
393
    fn drop(&mut self) {
394
        if !self.done {
395
            let _ = self.store.finish_batch();
396
        }
397
    }
398
}
399
192fad1e Andy McCall ↶ 400
/// Append one stored object to a pending pack and index it.
401
fn write_pack_entry(
402
    pack: &mut PendingPack,
403
    r: &ObjectRef,
404
    ty: ObjectType,
405
    raw_len: usize,
406
    flags: u8,
407
    stored: &[u8],
408
    report: &mut PackReport,
409
) -> Result<PackEntry> {
410
    let header_len = 1 + 1 + 4 + 4 + 32;
411
    pack.writer.write_all(&[type_index(ty), flags])?;
412
    pack.writer
413
        .write_all(&(stored.len() as u32).to_le_bytes())?;
414
    pack.writer.write_all(&(raw_len as u32).to_le_bytes())?;
415
    pack.writer.write_all(&r.0)?;
416
    pack.writer.write_all(stored)?;
417
    let entry = PackEntry {
418
        offset: pack.offset + header_len,
419
        stored_len: stored.len() as u32,
420
        raw_len: raw_len as u32,
421
        ty,
422
        flags,
423
    };
424
    pack.offset += header_len + stored.len() as u64;
425
    pack.index.push((*r, entry));
426
    report.objects += 1;
427
    report.raw_bytes += raw_len as u64;
428
    report.packed_bytes += stored.len() as u64;
429
    Ok(entry)
64818938 Andy McCall ↶ 430
}
431
432
/// A random name for a temporary file or a pack.
433
fn fresh_id() -> String {
434
    let mut nonce = [0u8; 8];
435
    rand::rngs::OsRng.fill_bytes(&mut nonce);
436
    hex::encode(nonce)
437
}
438
439
/// Under `OXY_STORE_BACKEND=memory` every store opens on a store in
440
/// memory shared by directory, so the whole test suite can run without a
441
/// directory store, as it would over a bucket. Objects live for the
442
/// process.
443
fn memory_backend_for(dir: &Path) -> Option<Arc<Backend>> {
444
    use std::collections::HashMap;
445
    use std::sync::{Mutex, OnceLock};
446
    if std::env::var_os("OXY_STORE_BACKEND").as_deref() != Some(std::ffi::OsStr::new("memory")) {
447
        return None;
448
    }
449
    static STORES: OnceLock<Mutex<HashMap<PathBuf, Arc<MemoryStore>>>> = OnceLock::new();
450
    let key = dir.canonicalize().unwrap_or_else(|_| dir.to_path_buf());
451
    let mut map = STORES
452
        .get_or_init(Default::default)
453
        .lock()
454
        .unwrap_or_else(|p| p.into_inner());
455
    let store = map
456
        .entry(key)
457
        .or_insert_with(|| Arc::new(MemoryStore::new()))
458
        .clone();
459
    Some(store)
192fad1e Andy McCall ↶ 460
}
461
dd21fd82 Andy McCall ↶ 462
#[cfg(test)]
463
thread_local! {
464
    /// A backend every store opened on this thread uses instead of its
465
    /// directory: tests of a repository kept on a store that is not this
466
    /// disk's directory, with several handles on one store.
467
    pub(crate) static TEST_BACKEND: RefCell<Option<Arc<Backend>>> = const { RefCell::new(None) };
468
}
469
ff0af1ee unknown 470
impl Store {
64818938 Andy McCall ↶ 471
    /// Open the store in `dir`, which is also its scratch directory.
ff0af1ee unknown 472
    pub fn open(dir: impl Into<PathBuf>) -> io::Result<Store> {
473
        let dir = dir.into();
474
        fs::create_dir_all(dir.join("loose"))?;
dd21fd82 Andy McCall ↶ 475
        #[cfg(test)]
476
        if let Some(backend) = TEST_BACKEND.with(|t| t.borrow().clone()) {
477
            return Store::open_on(backend, dir);
478
        }
64818938 Andy McCall ↶ 479
        if let Some(backend) = memory_backend_for(&dir) {
480
            return Store::open_on(backend, dir);
481
        }
482
        let backend: Arc<Backend> =
483
            Arc::new(LocalStore::open(&dir).map_err(|e| io::Error::other(e.to_string()))?);
484
        let mut store = Store::open_on(backend, dir)?;
485
        store.local = true;
486
        Ok(store)
487
    }
488
489
    /// Open the store kept on `backend`, with `scratch` for what must be
490
    /// on this disk: a pack while it is being written, and caches.
491
    pub fn open_on(backend: Arc<Backend>, scratch: impl Into<PathBuf>) -> io::Result<Store> {
492
        let scratch = scratch.into();
493
        fs::create_dir_all(&scratch)?;
75167672 Andy McCall 494
        let store = Store {
64818938 Andy McCall ↶ 495
            backend,
496
            scratch,
497
            local: false,
75167672 Andy McCall 498
            packs: RefCell::new(Vec::new()),
499
            pending: RefCell::new(None),
500
            batch_depth: std::cell::Cell::new(0),
ce14f0d6 Andy McCall ↶ 501
            metas: RefCell::new(None),
75167672 Andy McCall 502
        };
503
        store
504
            .reload_packs()
505
            .map_err(|e| io::Error::other(e.to_string()))?;
d02e545d Andy McCall ↶ 506
        Ok(store)
64818938 Andy McCall ↶ 507
    }
508
509
    /// The storage under this store.
510
    pub fn backend(&self) -> &Arc<Backend> {
511
        &self.backend
d02e545d Andy McCall ↶ 512
    }
513
64818938 Andy McCall ↶ 514
    /// Whether the store is the directory `dir()` names, where every key
515
    /// is a file.
516
    pub fn is_local(&self) -> bool {
517
        self.local
518
    }
519
d02e545d Andy McCall ↶ 520
    fn reload_packs(&self) -> Result<()> {
64818938 Andy McCall ↶ 521
        let listed = self.backend.list("pack-").map_err(backend_err)?;
522
        let mut idx_keys: Vec<&str> = listed
523
            .iter()
524
            .map(|e| e.key.as_str())
525
            .filter(|k| k.ends_with(".idx"))
d02e545d Andy McCall ↶ 526
            .collect();
64818938 Andy McCall ↶ 527
        idx_keys.sort();
528
        let mut packs = Vec::new();
529
        for idx in idx_keys {
530
            let pack = format!("{}.pack", idx.trim_end_matches(".idx"));
531
            if listed.iter().any(|e| e.key == pack) {
532
                packs.push(PackIndex::load(self.backend.as_ref(), idx, &pack)?);
d02e545d Andy McCall ↶ 533
            }
534
        }
535
        *self.packs.borrow_mut() = packs;
536
        Ok(())
537
    }
538
539
    pub fn pack_count(&self) -> usize {
540
        self.packs.borrow().len()
541
    }
542
543
    fn find_packed(&self, r: &ObjectRef) -> Option<(usize, PackEntry)> {
75167672 Andy McCall 544
        self.packs
545
            .borrow()
546
            .iter()
547
            .enumerate()
548
            .find_map(|(i, p)| p.find(r).map(|e| (i, e)))
d02e545d Andy McCall ↶ 549
    }
550
64818938 Andy McCall ↶ 551
    /// Loose objects, with their keys and ages.
552
    fn loose_objects(&self) -> Result<Vec<(ObjectRef, strata::Entry)>> {
553
        let mut out: Vec<(ObjectRef, strata::Entry)> = self
554
            .backend
555
            .list("loose/")
556
            .map_err(backend_err)?
557
            .into_iter()
558
            .filter_map(|e| loose_ref(&e.key).map(|r| (r, e)))
559
            .collect();
560
        out.sort_by_key(|(r, _)| *r);
d02e545d Andy McCall ↶ 561
        Ok(out)
562
    }
563
564
    pub fn loose_count(&self) -> io::Result<usize> {
64818938 Andy McCall ↶ 565
        self.loose_objects()
566
            .map(|l| l.len())
567
            .map_err(|e| io::Error::other(e.to_string()))
d02e545d Andy McCall ↶ 568
    }
569
64818938 Andy McCall ↶ 570
    /// Move every loose object into a new pack (spec §13.4). Loose objects
571
    /// are deleted only after the pack and its index are durable.
d02e545d Andy McCall ↶ 572
    pub fn pack_loose(&self) -> Result<PackReport> {
573
        let loose = self.loose_objects()?;
75167672 Andy McCall 574
        self.write_pack(
575
            &loose.iter().map(|(r, _)| *r).collect::<Vec<_>>(),
64818938 Andy McCall ↶ 576
            &loose.iter().map(|(_, e)| e.key.clone()).collect::<Vec<_>>(),
75167672 Andy McCall 577
            &[],
da652d63 Andy McCall ↶ 578
            ZSTD_LEVEL,
9ae4d15a Andy McCall ↶ 579
            &mut silent(),
75167672 Andy McCall 580
        )
da652d63 Andy McCall ↶ 581
    }
582
583
    /// Fold every pack and loose object into one pack compressed at
584
    /// `level` (spec §13.4): what an explicit `oxy gc` does, as `git gc`
585
    /// repacks. Returns the report and how many packs were folded in.
586
    pub fn repack_all(&self, level: i32) -> Result<(PackReport, usize)> {
9ae4d15a Andy McCall ↶ 587
        self.repack_all_with(level, &mut silent())
588
    }
589
590
    /// [`Store::repack_all`], reporting progress.
591
    pub fn repack_all_with(&self, level: i32, progress: Progress) -> Result<(PackReport, usize)> {
da652d63 Andy McCall ↶ 592
        let loose = self.loose_objects()?;
64818938 Andy McCall ↶ 593
        let (mut refs, keys): (Vec<ObjectRef>, Vec<String>) = {
da652d63 Andy McCall ↶ 594
            let packs = self.packs.borrow();
595
            (
596
                packs.iter().flat_map(|p| p.refs.iter().copied()).collect(),
64818938 Andy McCall ↶ 597
                packs.iter().map(|p| p.key.clone()).collect(),
da652d63 Andy McCall ↶ 598
            )
599
        };
64818938 Andy McCall ↶ 600
        if loose.is_empty() && keys.len() <= 1 && level == ZSTD_LEVEL {
da652d63 Andy McCall ↶ 601
            return Ok((PackReport::default(), 0));
602
        }
603
        refs.extend(loose.iter().map(|(r, _)| *r));
64818938 Andy McCall ↶ 604
        let loose_keys: Vec<String> = loose.into_iter().map(|(_, e)| e.key).collect();
605
        let n = keys.len();
606
        let report = self.write_pack(&refs, &loose_keys, &keys, level, progress)?;
da652d63 Andy McCall ↶ 607
        Ok((report, n))
ba160f60 Andy McCall ↶ 608
    }
609
135212de Andy McCall ↶ 610
    /// Fold every pack into one when there are more than `MAX_PACKS`
611
    /// (spec §13.4). Returns how many packs were merged.
612
    pub fn merge_packs(&self) -> Result<usize> {
64818938 Andy McCall ↶ 613
        let (refs, keys): (Vec<ObjectRef>, Vec<String>) = {
135212de Andy McCall ↶ 614
            let packs = self.packs.borrow();
615
            if packs.len() <= MAX_PACKS {
616
                return Ok(0);
617
            }
75167672 Andy McCall 618
            (
619
                packs.iter().flat_map(|p| p.refs.iter().copied()).collect(),
64818938 Andy McCall ↶ 620
                packs.iter().map(|p| p.key.clone()).collect(),
75167672 Andy McCall 621
            )
135212de Andy McCall ↶ 622
        };
64818938 Andy McCall ↶ 623
        let n = keys.len();
624
        self.write_pack(&refs, &[], &keys, ZSTD_LEVEL, &mut silent())?;
135212de Andy McCall ↶ 625
        Ok(n)
626
    }
627
ba160f60 Andy McCall ↶ 628
    /// Delete every object not in `keep` (spec §21). Loose objects and packs
629
    /// younger than `grace` are left alone, since a concurrent writer may not
630
    /// have recorded its references yet. Packs holding unreachable objects
64818938 Andy McCall ↶ 631
    /// are rewritten without them. Signatures, seal and receipt entries of
632
    /// deleted objects go too.
75167672 Andy McCall 633
    pub fn prune(
9ae4d15a Andy McCall ↶ 634
        &self,
635
        keep: &std::collections::HashSet<ObjectRef>,
636
        grace: std::time::Duration,
637
    ) -> Result<PruneReport> {
638
        self.prune_with(keep, grace, &mut silent())
639
    }
640
641
    /// [`Store::prune`], reporting progress.
642
    pub fn prune_with(
75167672 Andy McCall 643
        &self,
644
        keep: &std::collections::HashSet<ObjectRef>,
645
        grace: std::time::Duration,
9ae4d15a Andy McCall ↶ 646
        progress: Progress,
75167672 Andy McCall 647
    ) -> Result<PruneReport> {
9ae4d15a Andy McCall ↶ 648
        progress("pruning loose objects");
64818938 Andy McCall ↶ 649
        let now = now_ms();
650
        let grace_ms = grace.as_millis() as u64;
651
        // An object whose age the store does not know is old enough.
652
        let old_enough =
653
            |modified: Option<u64>| modified.is_none_or(|t| now.saturating_sub(t) >= grace_ms);
ba160f60 Andy McCall ↶ 654
        let mut report = PruneReport::default();
655
        // Loose objects.
64818938 Andy McCall ↶ 656
        for (r, entry) in self.loose_objects()? {
ba160f60 Andy McCall ↶ 657
            if keep.contains(&r) {
658
                continue;
659
            }
64818938 Andy McCall ↶ 660
            if !old_enough(entry.modified_ms) {
ba160f60 Andy McCall ↶ 661
                report.deferred += 1;
662
                continue;
663
            }
64818938 Andy McCall ↶ 664
            report.bytes += entry.size;
ba160f60 Andy McCall ↶ 665
            report.objects += 1;
64818938 Andy McCall ↶ 666
            delete(self.backend.as_ref(), &entry.key)?;
ba160f60 Andy McCall ↶ 667
            self.remove_sidecars(&r)?;
668
        }
669
        // Packs: rewrite those that hold unreachable objects.
670
        let mut keep_refs: Vec<ObjectRef> = Vec::new();
64818938 Andy McCall ↶ 671
        let mut old_keys: Vec<String> = Vec::new();
ba160f60 Andy McCall ↶ 672
        let mut rewrite = false;
9ae4d15a Andy McCall ↶ 673
        progress("pruning packs");
ba160f60 Andy McCall ↶ 674
        for p in self.packs.borrow().iter() {
675
            let unreachable = p.refs.iter().filter(|r| !keep.contains(r)).count();
676
            if unreachable == 0 {
677
                continue;
678
            }
64818938 Andy McCall ↶ 679
            let modified = self
680
                .backend
681
                .stat(&p.key)
682
                .map_err(backend_err)?
683
                .and_then(|e| e.modified_ms);
684
            if !old_enough(modified) {
ba160f60 Andy McCall ↶ 685
                report.deferred += unreachable;
686
                continue;
687
            }
688
            rewrite = true;
64818938 Andy McCall ↶ 689
            old_keys.push(p.key.clone());
ba160f60 Andy McCall ↶ 690
            for (r, e) in p.refs.iter().zip(p.entries.iter()) {
691
                if keep.contains(r) {
692
                    keep_refs.push(*r);
693
                } else {
694
                    report.objects += 1;
695
                    report.bytes += e.stored_len as u64;
696
                }
697
            }
698
        }
699
        if rewrite {
700
            let dropped: Vec<ObjectRef> = {
701
                let packs = self.packs.borrow();
75167672 Andy McCall 702
                packs
703
                    .iter()
64818938 Andy McCall ↶ 704
                    .filter(|p| old_keys.contains(&p.key))
75167672 Andy McCall 705
                    .flat_map(|p| p.refs.iter().copied())
706
                    .filter(|r| !keep.contains(r))
707
                    .collect()
ba160f60 Andy McCall ↶ 708
            };
64818938 Andy McCall ↶ 709
            self.write_pack(&keep_refs, &[], &old_keys, ZSTD_LEVEL, progress)?;
ba160f60 Andy McCall ↶ 710
            for r in dropped {
711
                self.remove_sidecars(&r)?;
712
            }
713
        }
714
        Ok(report)
715
    }
716
64818938 Andy McCall ↶ 717
    /// Everything kept beside an object: its signatures and the seal and
718
    /// receipt entries under it, in both layouts.
ba160f60 Andy McCall ↶ 719
    fn remove_sidecars(&self, r: &ObjectRef) -> Result<()> {
64818938 Andy McCall ↶ 720
        for index in ["sigs", "seals", "receipts"] {
721
            delete(self.backend.as_ref(), &legacy_key(index, r))?;
722
        }
723
        for index in ["sig", "seal", "receipt"] {
724
            for e in self
725
                .backend
726
                .list(&fanout_prefix(index, r))
727
                .map_err(backend_err)?
728
            {
729
                delete(self.backend.as_ref(), &e.key)?;
ba160f60 Andy McCall ↶ 730
            }
731
        }
732
        Ok(())
733
    }
734
64818938 Andy McCall ↶ 735
    /// Put a complete, synced temporary pack file and its index into the
736
    /// store; `index` must be sorted by ObjectRef. The pack goes first: an
737
    /// index never names a pack that is not there.
75167672 Andy McCall 738
    fn finish_pack_files(
739
        &self,
740
        id: &str,
741
        tmp_pack: &Path,
742
        index: &[(ObjectRef, PackEntry)],
743
    ) -> Result<()> {
64818938 Andy McCall ↶ 744
        let mut idx = Vec::with_capacity(12 + index.len() * IDX_ENTRY);
745
        idx.extend_from_slice(IDX_MAGIC);
746
        idx.extend_from_slice(&(index.len() as u32).to_le_bytes());
747
        for (r, e) in index {
748
            idx.extend_from_slice(&r.0);
749
            idx.extend_from_slice(&e.offset.to_le_bytes());
750
            idx.extend_from_slice(&e.stored_len.to_le_bytes());
751
            idx.extend_from_slice(&e.raw_len.to_le_bytes());
752
            idx.extend_from_slice(&[type_index(e.ty), e.flags]);
8f10a07a Andy McCall ↶ 753
        }
64818938 Andy McCall ↶ 754
        let put = self
755
            .backend
756
            .put_new_file(&format!("pack-{id}.pack"), tmp_pack)
757
            .map_err(backend_err);
758
        // A store on another disk copied it; the one in this directory
759
        // moved it and this finds nothing.
760
        let _ = fs::remove_file(tmp_pack);
761
        put?;
762
        self.backend
763
            .put_new(&format!("pack-{id}.idx"), &idx)
764
            .map_err(backend_err)?;
8f10a07a Andy McCall ↶ 765
        self.reload_packs()
64818938 Andy McCall ↶ 766
    }
767
768
    /// Remove a pack with its index and dictionary.
769
    fn remove_pack(&self, pack_key: &str) -> Result<()> {
770
        let stem = pack_key.trim_end_matches(".pack");
771
        delete(self.backend.as_ref(), pack_key)?;
772
        delete(self.backend.as_ref(), &format!("{stem}.idx"))?;
773
        delete(self.backend.as_ref(), &format!("{stem}.dict"))
8f10a07a Andy McCall ↶ 774
    }
775
64818938 Andy McCall ↶ 776
    /// Write `refs` into a new pack, then delete `loose_keys` and `old_packs`.
75167672 Andy McCall 777
    fn write_pack(
778
        &self,
779
        refs: &[ObjectRef],
64818938 Andy McCall ↶ 780
        loose_keys: &[String],
781
        old_packs: &[String],
da652d63 Andy McCall ↶ 782
        level: i32,
9ae4d15a Andy McCall ↶ 783
        progress: Progress,
75167672 Andy McCall 784
    ) -> Result<PackReport> {
ba160f60 Andy McCall ↶ 785
        if refs.is_empty() {
786
            for p in old_packs {
64818938 Andy McCall ↶ 787
                self.remove_pack(p)?;
ba160f60 Andy McCall ↶ 788
            }
789
            self.reload_packs()?;
d02e545d Andy McCall ↶ 790
            return Ok(PackReport::default());
791
        }
ba160f60 Andy McCall ↶ 792
        let mut refs: Vec<ObjectRef> = refs.to_vec();
793
        refs.sort();
794
        refs.dedup();
64818938 Andy McCall ↶ 795
        let id = fresh_id();
796
        let tmp_pack = self.scratch.join(format!(".tmp-{id}.pack"));
d02e545d Andy McCall ↶ 797
        let mut report = PackReport::default();
ba160f60 Andy McCall ↶ 798
        let mut index: Vec<(ObjectRef, PackEntry)> = Vec::with_capacity(refs.len());
a17fc622 Andy McCall ↶ 799
        // A full repack of enough objects trains a dictionary for them.
800
        let dict = if level == REPACK_ZSTD_LEVEL && refs.len() >= DICT_MIN_OBJECTS {
801
            let _t = crate::timing::phase("pack: train a dictionary");
9ae4d15a Andy McCall ↶ 802
            progress(&format!("training a dictionary on {} objects", refs.len()));
a17fc622 Andy McCall ↶ 803
            self.train_dictionary(&refs)
804
        } else {
805
            None
806
        };
807
        let encoder = dict
808
            .as_ref()
809
            .map(|d| zstd::dict::EncoderDictionary::copy(d, level));
64818938 Andy McCall ↶ 810
        let nocompress = self.nocompress_set()?;
d02e545d Andy McCall ↶ 811
        {
812
            let mut f = io::BufWriter::new(fs::File::create(&tmp_pack)?);
813
            f.write_all(PACK_MAGIC)?;
814
            let mut offset = PACK_MAGIC.len() as u64;
da652d63 Andy McCall ↶ 815
            // Read a batch (the store is not shared between threads),
816
            // compress it on every core, write it in order.
817
            let mut batches = refs.chunks(1024);
818
            let mut compressed_batch = Vec::new();
9ae4d15a Andy McCall ↶ 819
            let total = refs.len();
820
            let mut reported = usize::MAX;
da652d63 Andy McCall ↶ 821
            loop {
822
                if compressed_batch.is_empty() {
823
                    let Some(batch) = batches.next() else { break };
9ae4d15a Andy McCall ↶ 824
                    // Every tenth, and the first batch.
825
                    let tenth = report.objects * 10 / total.max(1);
826
                    if tenth != reported {
827
                        reported = tenth;
828
                        progress(&format!("packing {} of {total} objects", report.objects));
829
                    }
da652d63 Andy McCall ↶ 830
                    let mut read: Vec<(ObjectRef, ObjectType, Vec<u8>, bool)> =
831
                        Vec::with_capacity(batch.len());
832
                    for r in batch {
833
                        let (ty, body) = self.get(r)?;
64818938 Andy McCall ↶ 834
                        read.push((*r, ty, body, nocompress.contains(r)));
75167672 Andy McCall 835
                    }
da652d63 Andy McCall ↶ 836
                    use rayon::prelude::*;
837
                    compressed_batch = read
838
                        .into_par_iter()
a17fc622 Andy McCall ↶ 839
                        .map_init(
840
                            || {
841
                                encoder.as_ref().and_then(|e| {
842
                                    zstd::bulk::Compressor::with_prepared_dictionary(e).ok()
843
                                })
844
                            },
845
                            |with_dict, (r, ty, body, raw)| {
846
                                let packed = if raw {
847
                                    None
848
                                } else {
849
                                    // Small objects with the dictionary;
850
                                    // a large one has context enough.
851
                                    let dicted = with_dict
852
                                        .as_mut()
853
                                        .filter(|_| body.len() <= DICT_OBJECT_MAX)
854
                                        .and_then(|c| c.compress(&body).ok())
855
                                        .map(|c| (FLAG_ZSTD | FLAG_DICT, c));
856
                                    dicted
857
                                        .or_else(|| {
858
                                            zstd::bulk::compress(&body, level)
859
                                                .ok()
860
                                                .map(|c| (FLAG_ZSTD, c))
861
                                        })
862
                                        .filter(|(_, c)| c.len() < body.len())
863
                                };
864
                                (r, ty, body, packed)
865
                            },
866
                        )
da652d63 Andy McCall ↶ 867
                        .collect::<Vec<_>>();
868
                    compressed_batch.reverse();
869
                }
870
                let Some((r, ty, body, packed)) = compressed_batch.pop() else {
871
                    continue;
872
                };
873
                let r = &r;
874
                let (flags, stored) = match packed {
a17fc622 Andy McCall ↶ 875
                    Some(c) => c,
da652d63 Andy McCall ↶ 876
                    None => (0, body.clone()),
cdb5beba Andy McCall ↶ 877
                };
d02e545d Andy McCall ↶ 878
                let header_len = 1 + 1 + 4 + 4 + 32;
879
                f.write_all(&[type_index(ty), flags])?;
880
                f.write_all(&(stored.len() as u32).to_le_bytes())?;
881
                f.write_all(&(body.len() as u32).to_le_bytes())?;
882
                f.write_all(&r.0)?;
883
                f.write_all(&stored)?;
75167672 Andy McCall 884
                index.push((
885
                    *r,
886
                    PackEntry {
887
                        offset: offset + header_len,
888
                        stored_len: stored.len() as u32,
889
                        raw_len: body.len() as u32,
890
                        ty,
891
                        flags,
892
                    },
893
                ));
d02e545d Andy McCall ↶ 894
                offset += header_len + stored.len() as u64;
895
                report.objects += 1;
896
                report.raw_bytes += body.len() as u64;
897
                report.packed_bytes += stored.len() as u64;
898
            }
899
            f.flush()?;
900
            f.get_ref().sync_all()?;
a17fc622 Andy McCall ↶ 901
        }
902
        // The dictionary before the pack that needs it becomes visible.
903
        if let Some(d) = &dict {
64818938 Andy McCall ↶ 904
            self.backend
905
                .put_new(&format!("pack-{id}.dict"), d)
906
                .map_err(backend_err)?;
d02e545d Andy McCall ↶ 907
        }
9ae4d15a Andy McCall ↶ 908
        progress(&format!("writing the index of {} objects", index.len()));
8f10a07a Andy McCall ↶ 909
        self.finish_pack_files(&id, &tmp_pack, &index)?;
ba160f60 Andy McCall ↶ 910
        for p in old_packs {
64818938 Andy McCall ↶ 911
            self.remove_pack(p)?;
ba160f60 Andy McCall ↶ 912
        }
d02e545d Andy McCall ↶ 913
        self.reload_packs()?;
64818938 Andy McCall ↶ 914
        for key in loose_keys {
915
            delete(self.backend.as_ref(), key)?;
d02e545d Andy McCall ↶ 916
        }
917
        Ok(report)
ff0af1ee unknown 918
    }
919
a17fc622 Andy McCall ↶ 920
    /// A dictionary for these objects, trained on a sample of them (at
921
    /// most 10 000, 32 MB); `None` when training fails.
922
    fn train_dictionary(&self, refs: &[ObjectRef]) -> Option<Vec<u8>> {
923
        let step = (refs.len() / 10_000).max(1);
924
        let mut samples: Vec<Vec<u8>> = Vec::new();
925
        let mut total = 0usize;
926
        for r in refs.iter().step_by(step) {
927
            if total > 32 << 20 {
928
                break;
929
            }
930
            let Ok((ty, body)) = self.get(r) else {
931
                continue;
932
            };
933
            if matches!(
934
                ty,
935
                ObjectType::Chunk | ObjectType::Blob | ObjectType::Change
936
            ) && !body.is_empty()
937
                && body.len() < 1 << 20
938
            {
939
                total += body.len();
940
                samples.push(body);
941
            }
942
        }
943
        zstd::dict::from_samples(&samples, DICT_BYTES).ok()
944
    }
945
64818938 Andy McCall ↶ 946
    /// The scratch directory: for a store in a directory, that directory.
ff0af1ee unknown 947
    pub fn dir(&self) -> &Path {
64818938 Andy McCall ↶ 948
        &self.scratch
ff0af1ee unknown 949
    }
950
64818938 Andy McCall ↶ 951
    /// Where a loose object is kept, for a store in a directory (tests
952
    /// tamper with and remove objects there).
953
    #[cfg(test)]
387335ff Andy McCall ↶ 954
    pub(crate) fn path_for(&self, r: &ObjectRef) -> PathBuf {
64818938 Andy McCall ↶ 955
        self.scratch.join(loose_key(r))
956
    }
957
958
    /// Remove a loose object, whatever the store is on (tests make an
959
    /// object go missing).
960
    #[cfg(test)]
961
    pub(crate) fn remove_loose_for_test(&self, r: &ObjectRef) -> Result<()> {
962
        delete(self.backend.as_ref(), &loose_key(r))
ff0af1ee unknown 963
    }
964
965
    pub fn has(&self, r: &ObjectRef) -> bool {
64818938 Andy McCall ↶ 966
        self.backend.has(&loose_key(r)).unwrap_or(false)
75167672 Andy McCall 967
            || self.find_packed(r).is_some()
968
            || self
969
                .pending
970
                .borrow()
971
                .as_ref()
972
                .is_some_and(|p| p.lookup.contains_key(r))
ff0af1ee unknown 973
    }
974
8f10a07a Andy McCall ↶ 975
    /// Start a write batch: until the matching `finish`, `put` collects
976
    /// objects and writes them out together, with one `fsync` for a large
977
    /// batch (a pack) instead of one per object. Batches nest; only the
978
    /// outermost does the work. Objects are readable while pending.
979
    pub fn begin_batch(&self) -> Result<Batch<'_>> {
980
        let depth = self.batch_depth.get();
981
        if depth == 0 {
75167672 Andy McCall 982
            *self.pending.borrow_mut() = Some(Pending {
983
                buffered: vec![],
984
                buffered_bytes: 0,
985
                lookup: Default::default(),
986
                pack: None,
987
                report: PackReport::default(),
988
            });
8f10a07a Andy McCall ↶ 989
        }
990
        self.batch_depth.set(depth + 1);
75167672 Andy McCall 991
        Ok(Batch {
992
            store: self,
993
            done: false,
994
        })
8f10a07a Andy McCall ↶ 995
    }
996
997
    fn finish_batch(&self) -> Result<()> {
998
        let depth = self.batch_depth.get();
999
        if depth == 0 {
1000
            return Ok(());
1001
        }
1002
        self.batch_depth.set(depth - 1);
1003
        if depth > 1 {
1004
            return Ok(());
1005
        }
75167672 Andy McCall 1006
        let Some(pending) = self.pending.borrow_mut().take() else {
1007
            return Ok(());
1008
        };
4dcb8c09 Andy McCall ↶ 1009
        self.write_pending(pending)
1010
    }
1011
1012
    /// Make every object written so far durable, even inside an open
1013
    /// batch, which stays open. Call before a reference that names them
1014
    /// is moved (spec §13.6): the operation head, a bookmark pointer.
1015
    pub fn flush(&self) -> Result<()> {
1016
        let Some(pending) = self.pending.borrow_mut().take() else {
1017
            return Ok(());
1018
        };
1019
        self.write_pending(pending)?;
1020
        *self.pending.borrow_mut() = Some(Pending {
1021
            buffered: vec![],
1022
            buffered_bytes: 0,
1023
            lookup: Default::default(),
1024
            pack: None,
1025
            report: PackReport::default(),
1026
        });
1027
        Ok(())
1028
    }
1029
1030
    fn write_pending(&self, pending: Pending) -> Result<()> {
8f10a07a Andy McCall ↶ 1031
        match pending.pack {
1032
            None => {
b30a880f Andy McCall ↶ 1033
                let objects: Vec<(ObjectType, &[u8])> = pending
1034
                    .buffered
1035
                    .iter()
1036
                    .map(|(ty, body)| (*ty, body.as_slice()))
1037
                    .collect();
1038
                self.put_loose_many(&objects)
8f10a07a Andy McCall ↶ 1039
            }
1040
            Some(mut pack) => {
1041
                pack.writer.flush()?;
1042
                pack.writer.get_ref().sync_all()?;
1043
                drop(pack.writer);
1044
                pack.index.sort_by_key(|(r, _)| *r);
1045
                self.finish_pack_files(&pack.id, &pack.tmp_path, &pack.index)?;
1046
                Ok(())
1047
            }
1048
        }
1049
    }
1050
1051
    /// Whether a batch is open and holds `r`.
64818938 Andy McCall ↶ 1052
    fn pending_get(&self, r: &ObjectRef) -> Option<Result<Object>> {
8f10a07a Andy McCall ↶ 1053
        let mut guard = self.pending.borrow_mut();
1054
        let pending = guard.as_mut()?;
1055
        let entry = *pending.lookup.get(r)?;
1056
        Some(match entry {
1057
            PendingEntry::Buffered(i) => {
1058
                let (ty, body) = &pending.buffered[i];
1059
                Ok((*ty, body.clone()))
1060
            }
1061
            PendingEntry::Packed(e) => {
75167672 Andy McCall 1062
                let Some(pack) = pending.pack.as_mut() else {
1063
                    return Some(Err(StoreError::NotFound(*r)));
1064
                };
64818938 Andy McCall ↶ 1065
                // Read from the pack file being written, on this disk.
1066
                (|| {
1067
                    pack.writer.flush()?;
1068
                    use std::io::{Read, Seek, SeekFrom};
1069
                    let mut f = fs::File::open(&pack.tmp_path)?;
1070
                    f.seek(SeekFrom::Start(e.offset))?;
1071
                    let mut stored = vec![0u8; e.stored_len as usize];
1072
                    f.read_exact(&mut stored)?;
1073
                    decode_entry(r, e, stored, None)
1074
                })()
8f10a07a Andy McCall ↶ 1075
            }
1076
        })
1077
    }
1078
1079
    /// Append one object to the pending pack file.
75167672 Andy McCall 1080
    fn pending_pack_write(
1081
        &self,
1082
        pack: &mut PendingPack,
1083
        r: &ObjectRef,
1084
        ty: ObjectType,
1085
        body: &[u8],
1086
        report: &mut PackReport,
1087
    ) -> Result<PackEntry> {
8f10a07a Andy McCall ↶ 1088
        let (flags, stored) = if self.is_nocompress(r) {
1089
            (0, body.to_vec())
1090
        } else {
75167672 Andy McCall 1091
            let compressed = zstd::bulk::compress(body, ZSTD_LEVEL)
1092
                .map_err(|e| StoreError::Corrupt(*r, format!("zstd: {e}")))?;
1093
            if compressed.len() < body.len() {
1094
                (FLAG_ZSTD, compressed)
1095
            } else {
1096
                (0, body.to_vec())
1097
            }
8f10a07a Andy McCall ↶ 1098
        };
192fad1e Andy McCall ↶ 1099
        write_pack_entry(pack, r, ty, body.len(), flags, &stored, report)
8f10a07a Andy McCall ↶ 1100
    }
1101
1102
    fn put_pending(&self, r: ObjectRef, ty: ObjectType, body: &[u8]) -> Result<()> {
1103
        let mut guard = self.pending.borrow_mut();
1104
        let pending = guard.as_mut().expect("batch open");
1105
        if pending.lookup.contains_key(&r) {
1106
            return Ok(());
1107
        }
75167672 Andy McCall 1108
        if pending.pack.is_none()
1109
            && pending.buffered.len() < SPILL_OBJECTS
1110
            && pending.buffered_bytes + body.len() <= SPILL_BYTES
1111
        {
8f10a07a Andy McCall ↶ 1112
            pending.buffered.push((ty, body.to_vec()));
1113
            pending.buffered_bytes += body.len();
75167672 Andy McCall 1114
            pending
1115
                .lookup
1116
                .insert(r, PendingEntry::Buffered(pending.buffered.len() - 1));
8f10a07a Andy McCall ↶ 1117
            return Ok(());
1118
        }
192fad1e Andy McCall ↶ 1119
        self.ensure_pack(pending)?;
1120
        let mut report = std::mem::take(&mut pending.report);
1121
        let pack = pending.pack.as_mut().unwrap();
1122
        let e = self.pending_pack_write(pack, &r, ty, body, &mut report)?;
1123
        pending.report = report;
1124
        pending.lookup.insert(r, PendingEntry::Packed(e));
1125
        Ok(())
1126
    }
1127
1128
    /// Open the pending batch's pack, moving the objects buffered so far
1129
    /// into it (a spill).
1130
    fn ensure_pack(&self, pending: &mut Pending) -> Result<()> {
8f10a07a Andy McCall ↶ 1131
        if pending.pack.is_none() {
1132
            // Spill: open the pack and move the buffered objects into it.
64818938 Andy McCall ↶ 1133
            let id = fresh_id();
1134
            let tmp_path = self.scratch.join(format!(".tmp-{id}.pack"));
8f10a07a Andy McCall ↶ 1135
            let mut writer = io::BufWriter::new(fs::File::create(&tmp_path)?);
1136
            writer.write_all(PACK_MAGIC)?;
75167672 Andy McCall 1137
            let mut pack = PendingPack {
1138
                id,
1139
                tmp_path,
1140
                writer,
1141
                offset: PACK_MAGIC.len() as u64,
1142
                index: vec![],
1143
            };
8f10a07a Andy McCall ↶ 1144
            let buffered = std::mem::take(&mut pending.buffered);
1145
            pending.buffered_bytes = 0;
1146
            let mut report = std::mem::take(&mut pending.report);
1147
            for (bty, bbody) in &buffered {
1148
                let br = hash_object(*bty, bbody);
1149
                let e = self.pending_pack_write(&mut pack, &br, *bty, bbody, &mut report)?;
1150
                pending.lookup.insert(br, PendingEntry::Packed(e));
1151
            }
1152
            pending.report = report;
1153
            pending.pack = Some(pack);
192fad1e Andy McCall ↶ 1154
        }
1155
        Ok(())
1156
    }
1157
1158
    /// Store many objects at once. Inside a large write batch they are
1159
    /// compressed on every core and appended in order; otherwise each is
1160
    /// stored as [`Store::put`] does.
1161
    pub fn put_many(&self, objects: &[(ObjectType, &[u8])]) -> Result<Vec<ObjectRef>> {
1162
        use rayon::prelude::*;
1163
        let total: usize = objects.iter().map(|(_, b)| b.len()).sum();
1164
        if self.pending.borrow().is_none() || total < SPILL_BYTES {
1165
            return objects.iter().map(|(ty, b)| self.put(*ty, b)).collect();
1166
        }
1167
        for (ty, b) in objects {
1168
            if b.len() > MAX_OBJECT_LEN as usize {
1169
                return Err(StoreError::TooLarge {
1170
                    kind: ty.name(),
1171
                    size: b.len(),
1172
                    limit: MAX_OBJECT_LEN,
1173
                });
1174
            }
8f10a07a Andy McCall ↶ 1175
        }
192fad1e Andy McCall ↶ 1176
        let refs: Vec<ObjectRef> = objects
1177
            .par_iter()
1178
            .map(|(ty, b)| hash_object(*ty, b))
1179
            .collect();
1180
        // What is new: not stored already, not earlier in this call.
1181
        let mut seen: std::collections::HashSet<ObjectRef> = std::collections::HashSet::new();
1182
        let mut todo: Vec<usize> = Vec::new();
1183
        for (i, r) in refs.iter().enumerate() {
1184
            let known = self
1185
                .pending
1186
                .borrow()
1187
                .as_ref()
1188
                .is_some_and(|p| p.lookup.contains_key(r));
1189
            if seen.insert(*r)
1190
                && !known
1191
                && self.find_packed(r).is_none()
64818938 Andy McCall ↶ 1192
                && !self.backend.has(&loose_key(r)).unwrap_or(false)
192fad1e Andy McCall ↶ 1193
            {
1194
                todo.push(i);
1195
            }
1196
        }
64818938 Andy McCall ↶ 1197
        let raw = self.nocompress_set()?;
192fad1e Andy McCall ↶ 1198
        let packed: Vec<(u8, Vec<u8>)> = todo
1199
            .par_iter()
1200
            .map(|i| {
1201
                let body = objects[*i].1;
1202
                if raw.contains(&refs[*i]) {
1203
                    return (0, body.to_vec());
1204
                }
1205
                match zstd::bulk::compress(body, ZSTD_LEVEL) {
1206
                    Ok(c) if c.len() < body.len() => (FLAG_ZSTD, c),
1207
                    _ => (0, body.to_vec()),
1208
                }
1209
            })
1210
            .collect();
1211
        let mut guard = self.pending.borrow_mut();
1212
        let pending = guard.as_mut().expect("batch open");
1213
        self.ensure_pack(pending)?;
8f10a07a Andy McCall ↶ 1214
        let mut report = std::mem::take(&mut pending.report);
1215
        let pack = pending.pack.as_mut().unwrap();
192fad1e Andy McCall ↶ 1216
        for (i, (flags, stored)) in todo.iter().zip(packed) {
1217
            let (ty, body) = objects[*i];
1218
            let e = write_pack_entry(pack, &refs[*i], ty, body.len(), flags, &stored, &mut report)?;
1219
            pending.lookup.insert(refs[*i], PendingEntry::Packed(e));
1220
        }
8f10a07a Andy McCall ↶ 1221
        pending.report = report;
192fad1e Andy McCall ↶ 1222
        Ok(refs)
8f10a07a Andy McCall ↶ 1223
    }
1224
ff0af1ee unknown 1225
    /// Store `body` as an object of type `ty`; idempotent.
1226
    pub fn put(&self, ty: ObjectType, body: &[u8]) -> Result<ObjectRef> {
a9f686ed Andy McCall ↶ 1227
        // Refuse what the store could not read back (spec §13.2), before
1228
        // anything is written: a pack must never hold an entry its index
1229
        // would reject.
1230
        if body.len() > MAX_OBJECT_LEN as usize {
1231
            return Err(StoreError::TooLarge {
1232
                kind: ty.name(),
1233
                size: body.len(),
1234
                limit: MAX_OBJECT_LEN,
1235
            });
1236
        }
ff0af1ee unknown 1237
        let r = hash_object(ty, body);
64818938 Andy McCall ↶ 1238
        if self.find_packed(&r).is_some() || self.backend.has(&loose_key(&r)).unwrap_or(false) {
ff0af1ee unknown 1239
            return Ok(r);
1240
        }
8f10a07a Andy McCall ↶ 1241
        if self.pending.borrow().is_some() {
1242
            self.put_pending(r, ty, body)?;
1243
            return Ok(r);
1244
        }
1245
        self.put_loose(ty, body)?;
1246
        Ok(r)
1247
    }
1248
64818938 Andy McCall ↶ 1249
    /// Write one loose object, durable when this returns.
8f10a07a Andy McCall ↶ 1250
    fn put_loose(&self, ty: ObjectType, body: &[u8]) -> Result<ObjectRef> {
1251
        let r = hash_object(ty, body);
64818938 Andy McCall ↶ 1252
        let mut bytes = header(ty, body.len());
1253
        bytes.extend_from_slice(body);
4dcb8c09 Andy McCall ↶ 1254
        crate::durable::step("write loose object")?;
64818938 Andy McCall ↶ 1255
        put_new_or_existing(self.backend.as_ref(), &loose_key(&r), &bytes)?;
ff0af1ee unknown 1256
        Ok(r)
b30a880f Andy McCall ↶ 1257
    }
1258
1259
    /// Write several loose objects with as few waits on the disk as the
64818938 Andy McCall ↶ 1260
    /// guarantees allow (a directory store writes them all, then syncs
1261
    /// each directory once). Durable when this returns, as `put_loose`
1262
    /// one at a time would be (spec §13.6).
b30a880f Andy McCall ↶ 1263
    fn put_loose_many(&self, objects: &[(ObjectType, &[u8])]) -> Result<()> {
1264
        if objects.len() <= 1 {
1265
            for (ty, body) in objects {
1266
                self.put_loose(*ty, body)?;
1267
            }
1268
            return Ok(());
1269
        }
1270
        let mut seen = std::collections::HashSet::new();
64818938 Andy McCall ↶ 1271
        let items: Vec<(String, Vec<u8>)> = objects
b30a880f Andy McCall ↶ 1272
            .iter()
1273
            .filter_map(|(ty, body)| {
1274
                let r = hash_object(*ty, body);
64818938 Andy McCall ↶ 1275
                seen.insert(r).then(|| {
1276
                    let mut bytes = header(*ty, body.len());
1277
                    bytes.extend_from_slice(body);
1278
                    (loose_key(&r), bytes)
b30a880f Andy McCall ↶ 1279
                })
1280
            })
1281
            .collect();
64818938 Andy McCall ↶ 1282
        self.backend.put_many_new(&items).map_err(backend_err)
ff0af1ee unknown 1283
    }
1284
8f10a07a Andy McCall ↶ 1285
    /// Read and verify an object, loose, packed, or pending in a batch.
64818938 Andy McCall ↶ 1286
    pub fn get(&self, r: &ObjectRef) -> Result<Object> {
1287
        match get_optional(self.backend.as_ref(), &loose_key(r))? {
1288
            Some(bytes) => parse_loose(&bytes, r),
afaba5f1 Andy McCall ↶ 1289
            None => match self.find_packed(r) {
64818938 Andy McCall ↶ 1290
                Some((i, e)) => self.packs.borrow()[i].fetch(self.backend.as_ref(), r, e),
afaba5f1 Andy McCall ↶ 1291
                None => self.pending_get(r).unwrap_or(Err(StoreError::NotFound(*r))),
1292
            },
1293
        }
1294
    }
1295
1296
    /// Many objects at once: loose ones are read and verified in parallel,
64818938 Andy McCall ↶ 1297
    /// then packed ones in parallel, then what is pending in a batch.
1298
    /// Results are in the order of `refs`.
afaba5f1 Andy McCall ↶ 1299
    pub fn get_many(&self, refs: &[ObjectRef]) -> Vec<Result<Object>> {
1300
        use rayon::prelude::*;
64818938 Andy McCall ↶ 1301
        let backend = self.backend.as_ref();
1302
        let mut found: Vec<Option<Result<Object>>> = refs
1303
            .par_iter()
1304
            .map(|r| match get_optional(backend, &loose_key(r)) {
1305
                Ok(Some(bytes)) => Some(parse_loose(&bytes, r)),
1306
                Ok(None) => None,
1307
                Err(e) => Some(Err(e)),
1308
            })
1309
            .collect();
afaba5f1 Andy McCall ↶ 1310
        // Packed ones: look them up in order, then read them in parallel.
1311
        let packs = self.packs.borrow();
1312
        let packed: Vec<(usize, usize, PackEntry)> = found
75167672 Andy McCall 1313
            .iter()
afaba5f1 Andy McCall ↶ 1314
            .enumerate()
1315
            .filter(|(_, f)| f.is_none())
1316
            .filter_map(|(i, _)| {
1317
                packs
1318
                    .iter()
1319
                    .enumerate()
1320
                    .find_map(|(p, pack)| pack.find(&refs[i]).map(|e| (i, p, e)))
1321
            })
1322
            .collect();
1323
        let indexes: &[PackIndex] = &packs;
1324
        let read: Vec<(usize, Result<Object>)> = packed
1325
            .par_iter()
64818938 Andy McCall ↶ 1326
            .map(|(i, p, e)| (*i, indexes[*p].fetch(backend, &refs[*i], *e)))
afaba5f1 Andy McCall ↶ 1327
            .collect();
1328
        drop(packs);
1329
        for (i, r) in read {
1330
            found[i] = Some(r);
ff0af1ee unknown 1331
        }
afaba5f1 Andy McCall ↶ 1332
        found
1333
            .into_iter()
1334
            .zip(refs)
1335
            .map(|(f, r)| match f {
1336
                Some(f) => f,
1337
                None => self.get(r),
1338
            })
1339
            .collect()
ff0af1ee unknown 1340
    }
1341
1342
    pub fn get_typed(&self, r: &ObjectRef, want: ObjectType) -> Result<Vec<u8>> {
1343
        let (ty, body) = self.get(r)?;
1344
        if ty != want {
1345
            return Err(StoreError::WrongType(*r, ty.name(), want.name()));
1346
        }
1347
        Ok(body)
1348
    }
1349
6f8aeb99 Andy McCall ↶ 1350
    /// Store a change and the text blobs (and their chunks) its large
1351
    /// inserts are stored as (spec §6.1).
ff0af1ee unknown 1352
    pub fn put_change(&self, c: &Change) -> Result<ObjectRef> {
5b4c5130 Andy McCall ↶ 1353
        let encoding = crate::timing::phase("store: encode the change and its texts");
17f94b13 Andy McCall ↶ 1354
        let bytes = c.encode_streaming(|batch| self.put_texts(&batch))?;
5b4c5130 Andy McCall ↶ 1355
        drop(encoding);
1356
        let _t = crate::timing::phase("store: put the encoding");
17f94b13 Andy McCall ↶ 1357
        self.put(ObjectType::Change, &bytes)
6f8aeb99 Andy McCall ↶ 1358
    }
1359
17f94b13 Andy McCall ↶ 1360
    /// Store text blobs and their chunks: every chunk at once (compressed
1361
    /// on every core in a large batch), then the blobs.
1362
    pub fn put_texts(&self, texts: &[crate::objects::StoredText]) -> Result<()> {
192fad1e Andy McCall ↶ 1363
        let mut chunks: Vec<(ObjectType, &[u8])> = Vec::new();
1364
        for t in texts {
1365
            if !self.has(&t.blob.hash()) {
1366
                chunks.extend(
1367
                    crate::chunk::chunks(&t.content)
1368
                        .into_iter()
1369
                        .map(|c| (ObjectType::Chunk, c)),
1370
                );
1371
            }
6f8aeb99 Andy McCall ↶ 1372
        }
192fad1e Andy McCall ↶ 1373
        self.put_many(&chunks)?;
1374
        for t in texts {
1375
            self.put(ObjectType::Blob, &t.blob.encode())?;
6f8aeb99 Andy McCall ↶ 1376
        }
17f94b13 Andy McCall ↶ 1377
        Ok(())
ff0af1ee unknown 1378
    }
1379
1380
    pub fn get_change(&self, r: &ObjectRef) -> Result<Change> {
6f8aeb99 Andy McCall ↶ 1381
        Ok(self.get_change_parts(r)?.0)
1382
    }
1383
1384
    /// A change and the objects its stored inserts are made of: each text
1385
    /// blob and its chunks, which travel and are kept with it.
1386
    pub fn get_change_parts(&self, r: &ObjectRef) -> Result<(Change, Vec<ObjectRef>)> {
1387
        let bytes = self.get_typed(r, ObjectType::Change)?;
1388
        let mut parts = Vec::new();
1389
        let mut failed = None;
0f93f49c Andy McCall ↶ 1390
        let decoded = Change::decode_with(&bytes, &mut |text, count, form| match self
1391
            .read_text(text)
1392
        {
6f8aeb99 Andy McCall ↶ 1393
            Ok((blob, content)) => {
1394
                parts.push(*text);
1395
                parts.extend(blob.chunks);
0f93f49c Andy McCall ↶ 1396
                crate::objects::text_lines(&content, count, form)
6f8aeb99 Andy McCall ↶ 1397
            }
1398
            Err(e) => {
1399
                let why = e.to_string();
1400
                failed = Some(e);
1401
                Err(ObjectError::Schema(format!(
1402
                    "text blob {}: {why}",
1403
                    text.short(12)
1404
                )))
1405
            }
1406
        });
1407
        match (decoded, failed) {
1408
            (Ok(c), _) => Ok((c, parts)),
1409
            (Err(_), Some(StoreError::NotFound(t))) => Err(StoreError::Corrupt(
1410
                *r,
1411
                format!("its text blob {} is missing", t.short(12)),
1412
            )),
1413
            (Err(e), _) => Err(StoreError::Corrupt(*r, e.to_string())),
1414
        }
1415
    }
1416
a4fad5b0 Andy McCall ↶ 1417
    /// A change with every insert left without its lines (empty
1418
    /// placeholders), and where each one's lines are, in order: for
1419
    /// history-only states, which read text only for the graphs they build
1420
    /// (see [`Change::decode_skeleton`]).
1421
    pub fn get_change_lazy(&self, r: &ObjectRef) -> Result<(Change, Vec<crate::objects::TextRef>)> {
86e1824f Andy McCall ↶ 1422
        let bytes = self.get_typed(r, ObjectType::Change)?;
a4fad5b0 Andy McCall ↶ 1423
        Change::decode_skeleton(&bytes, *r).map_err(|e| StoreError::Corrupt(*r, e.to_string()))
86e1824f Andy McCall ↶ 1424
    }
1425
69816d68 Andy McCall ↶ 1426
    /// A change's metadata (id, dependencies, author, clock, message, kind)
1427
    /// without its contents: read from its skeleton, so neither its text
1428
    /// blobs nor its inline lines are read (spec §11).
ce14f0d6 Andy McCall ↶ 1429
    ///
1430
    /// Served from the `metas` cache when this store read it before (a
1431
    /// change object can be as large as the tree it adds), as long as the
1432
    /// store still has the change.
69816d68 Andy McCall ↶ 1433
    pub fn get_change_meta(&self, r: &ObjectRef) -> Result<crate::state::ChangeMeta> {
ce14f0d6 Andy McCall ↶ 1434
        if self.metas.borrow().is_none() {
1435
            *self.metas.borrow_mut() = Some(self.read_metas_cache());
1436
        }
1437
        let cached = self.metas.borrow().as_ref().and_then(|m| m.get(r).cloned());
1438
        if let Some(meta) = cached {
1439
            if self.has(r) {
1440
                #[cfg(test)]
1441
                assert_eq!(
1442
                    meta,
1443
                    Change::decode_meta(&self.get_typed(r, ObjectType::Change)?).unwrap(),
1444
                    "the metadata cache holds a change's metadata"
1445
                );
1446
                return Ok(meta);
1447
            }
1448
        }
4d6c9c1b Andy McCall ↶ 1449
        let bytes = self.get_typed(r, ObjectType::Change)?;
ce14f0d6 Andy McCall ↶ 1450
        let meta =
1451
            Change::decode_meta(&bytes).map_err(|e| StoreError::Corrupt(*r, e.to_string()))?;
1452
        self.remember_meta(r, &meta);
1453
        Ok(meta)
1454
    }
1455
1456
    /// The metadata cache: records of a change hash, its metadata in the
1457
    /// flat layout, and the first 8 bytes of BLAKE3 over both, each
1458
    /// appended in one write. Derived only: a record that does not check
64818938 Andy McCall ↶ 1459
    /// ends the reading (a torn write), and the cache can be deleted. It
1460
    /// lives in the scratch directory, on this disk.
ce14f0d6 Andy McCall ↶ 1461
    fn read_metas_cache(&self) -> crate::fasthash::FastMap<ObjectRef, crate::state::ChangeMeta> {
1462
        let mut out = crate::fasthash::FastMap::default();
64818938 Andy McCall ↶ 1463
        let Ok(bytes) = fs::read(self.scratch.join("metas")) else {
ce14f0d6 Andy McCall ↶ 1464
            return out;
1465
        };
1466
        let mut r = crate::flat::Reader::new(&bytes);
1467
        let mut good = 0;
1468
        while !r.at_end() {
1469
            let mut record = || -> std::result::Result<_, ObjectError> {
1470
                let h = r.object()?;
1471
                let body = r.bytes()?;
1472
                let check = r.fixed::<8>()?;
1473
                Ok((h, body, check))
1474
            };
1475
            let Ok((h, body, check)) = record() else {
1476
                break;
1477
            };
1478
            let mut sum = blake3::Hasher::new();
1479
            sum.update(&h.0).update(body);
1480
            if sum.finalize().as_bytes()[..8] != check {
1481
                break;
1482
            }
1483
            match crate::state::ChangeMeta::read_flat(&mut crate::flat::Reader::new(body)) {
1484
                Ok(m) => out.insert(h, m),
1485
                Err(_) => break,
1486
            };
1487
            good += 32 + 4 + body.len() + 8;
1488
        }
1489
        // Cut a bad tail, so records appended later are read.
1490
        if good < bytes.len() {
1491
            let _ = fs::OpenOptions::new()
1492
                .write(true)
64818938 Andy McCall ↶ 1493
                .open(self.scratch.join("metas"))
ce14f0d6 Andy McCall ↶ 1494
                .and_then(|f| f.set_len(good as u64));
1495
        }
1496
        out
1497
    }
1498
1499
    /// Add a change's metadata to the cache; quietly nothing when it
1500
    /// cannot be written (it is only a cache).
1501
    fn remember_meta(&self, r: &ObjectRef, meta: &crate::state::ChangeMeta) {
1502
        let mut body = crate::flat::Writer::default();
1503
        meta.write_flat(&mut body);
1504
        let mut w = crate::flat::Writer::default();
1505
        w.object(r);
1506
        w.bytes(&body.0);
1507
        let mut sum = blake3::Hasher::new();
1508
        sum.update(&r.0).update(&body.0);
1509
        w.fixed(&sum.finalize().as_bytes()[..8]);
1510
        let _ = fs::OpenOptions::new()
1511
            .create(true)
1512
            .append(true)
64818938 Andy McCall ↶ 1513
            .open(self.scratch.join("metas"))
ce14f0d6 Andy McCall ↶ 1514
            .and_then(|mut f| f.write_all(&w.0));
1515
        if let Some(m) = self.metas.borrow_mut().as_mut() {
1516
            m.insert(*r, meta.clone());
1517
        }
69816d68 Andy McCall ↶ 1518
    }
1519
6f8aeb99 Andy McCall ↶ 1520
    fn read_text(&self, r: &ObjectRef) -> Result<(Blob, Vec<u8>)> {
1521
        let blob = Blob::decode(&self.get_typed(r, ObjectType::Blob)?)?;
1522
        let mut content = Vec::with_capacity(blob.length as usize);
1523
        for c in &blob.chunks {
1524
            content.extend(self.get_typed(c, ObjectType::Chunk)?);
1525
        }
1526
        Ok((blob, content))
ff0af1ee unknown 1527
    }
1528
1529
    pub fn put_chunk(&self, bytes: &[u8]) -> Result<ObjectRef> {
1530
        self.put(ObjectType::Chunk, bytes)
1531
    }
1532
cdb5beba Andy McCall ↶ 1533
    /// Store a chunk that packs will keep uncompressed (`nocompress`, spec §13.3).
1534
    pub fn put_chunk_nocompress(&self, bytes: &[u8]) -> Result<ObjectRef> {
8f10a07a Andy McCall ↶ 1535
        let r = hash_object(ObjectType::Chunk, bytes);
64818938 Andy McCall ↶ 1536
        put_new_or_existing(
1537
            self.backend.as_ref(),
1538
            &format!("nocompress/{}", r.to_hex()),
1539
            b"",
1540
        )?;
8f10a07a Andy McCall ↶ 1541
        self.put(ObjectType::Chunk, bytes)
cdb5beba Andy McCall ↶ 1542
    }
1543
1544
    fn is_nocompress(&self, r: &ObjectRef) -> bool {
64818938 Andy McCall ↶ 1545
        self.backend
1546
            .has(&format!("nocompress/{}", r.to_hex()))
1547
            .unwrap_or(false)
1548
    }
1549
1550
    /// Every chunk marked to be kept raw.
1551
    fn nocompress_set(&self) -> Result<std::collections::HashSet<ObjectRef>> {
1552
        Ok(self
1553
            .backend
1554
            .list("nocompress/")
1555
            .map_err(backend_err)?
1556
            .into_iter()
1557
            .filter_map(|e| ObjectRef::from_hex(e.key.trim_start_matches("nocompress/")))
1558
            .collect())
cdb5beba Andy McCall ↶ 1559
    }
1560
86e682c2 Andy McCall ↶ 1561
    pub fn put_state(&self, st: &StateObject) -> Result<ObjectRef> {
1562
        self.put(ObjectType::State, &st.encode())
1563
    }
1564
1565
    pub fn get_state(&self, r: &ObjectRef) -> Result<StateObject> {
1566
        Ok(StateObject::decode(&self.get_typed(r, ObjectType::State)?)?)
1567
    }
1568
5b9c6ad4 Andy McCall ↶ 1569
    pub fn put_attest(&self, a: &Attest) -> Result<ObjectRef> {
1570
        self.put(ObjectType::Attest, &a.encode())
1571
    }
1572
1573
    pub fn get_attest(&self, r: &ObjectRef) -> Result<Attest> {
1574
        Ok(Attest::decode(&self.get_typed(r, ObjectType::Attest)?)?)
fc1a466a Andy McCall ↶ 1575
    }
1576
1577
    pub fn put_receipt(&self, r: &Receipt) -> Result<ObjectRef> {
1578
        self.put(ObjectType::Receipt, &r.encode())
5b9c6ad4 Andy McCall ↶ 1579
    }
1580
fc1a466a Andy McCall ↶ 1581
    pub fn get_receipt(&self, r: &ObjectRef) -> Result<Receipt> {
1582
        Ok(Receipt::decode(&self.get_typed(r, ObjectType::Receipt)?)?)
5b9c6ad4 Andy McCall ↶ 1583
    }
1584
64818938 Andy McCall ↶ 1585
    /// Record `value` under `key` in `index`: one write-once entry, so two
1586
    /// writers of a shared store never lose each other's.
1587
    fn index_add(&self, index: &str, key: &ObjectRef, value: &ObjectRef) -> Result<()> {
1588
        let entry = format!("{}{}", fanout_prefix(index, key), value.to_hex());
1589
        put_new_or_existing(self.backend.as_ref(), &entry, b"")
fc1a466a Andy McCall ↶ 1590
    }
1591
64818938 Andy McCall ↶ 1592
    /// The values recorded under `key` in `index`, with those an older
1593
    /// store kept as one list in `legacy`, sorted.
1594
    fn index_get(&self, index: &str, legacy: &str, key: &ObjectRef) -> Result<Vec<ObjectRef>> {
1595
        let mut values: Vec<ObjectRef> = self
1596
            .backend
1597
            .list(&fanout_prefix(index, key))
1598
            .map_err(backend_err)?
1599
            .into_iter()
1600
            .filter_map(|e| e.key.rsplit('/').next().and_then(ObjectRef::from_hex))
1601
            .collect();
1602
        if let Some(bytes) = get_optional(self.backend.as_ref(), &legacy_key(legacy, key))? {
1603
            values.extend(
1604
                String::from_utf8_lossy(&bytes)
1605
                    .lines()
1606
                    .filter_map(ObjectRef::from_hex),
1607
            );
5b9c6ad4 Andy McCall ↶ 1608
        }
fc1a466a Andy McCall ↶ 1609
        values.sort();
64818938 Andy McCall ↶ 1610
        values.dedup();
1611
        Ok(values)
5b9c6ad4 Andy McCall ↶ 1612
    }
1613
fc1a466a Andy McCall ↶ 1614
    /// Record that seal attestation `attest` covers `change`.
1615
    pub fn index_seal(&self, change: &ObjectRef, attest: &ObjectRef) -> Result<()> {
64818938 Andy McCall ↶ 1616
        self.index_add("seal", change, attest)
fc1a466a Andy McCall ↶ 1617
    }
1618
1619
    /// Seal attestations known to cover `change`.
1620
    pub fn seals_for(&self, change: &ObjectRef) -> Result<Vec<ObjectRef>> {
64818938 Andy McCall ↶ 1621
        self.index_get("seal", "seals", change)
fc1a466a Andy McCall ↶ 1622
    }
1623
1624
    /// Record receipt attestation `attest` for `state` (spec §14.6).
c63fed2e Andy McCall ↶ 1625
    /// Keep a short-lived key's certificate (spec §14.7), with its issuer's
1626
    /// signature, indexed by the key it certifies.
1627
    pub fn put_certificate(&self, c: &crate::cert::SignedCertificate) -> Result<ObjectRef> {
1628
        let r = self.put(ObjectType::Certificate, &c.cert.encode())?;
1629
        self.put_signature(&r, &c.sig)?;
1630
        self.index_add("cert", &c.cert.key_id(), &r)?;
1631
        Ok(r)
1632
    }
1633
1634
    /// A kept certificate with its issuer's signature.
1635
    pub fn get_certificate(&self, r: &ObjectRef) -> Result<crate::cert::SignedCertificate> {
1636
        let cert = crate::cert::Certificate::decode(&self.get_typed(r, ObjectType::Certificate)?)?;
1637
        let sig = self
1638
            .signatures(r)?
1639
            .into_iter()
1640
            .find(|s| s.key == cert.issuer)
1641
            .ok_or(StoreError::NotFound(*r))?;
1642
        Ok(crate::cert::SignedCertificate { cert, sig })
1643
    }
1644
1645
    /// The certificate kept for short-lived key `key`, if any.
1646
    pub fn certificate_of(&self, key: &ObjectRef) -> Result<Option<ObjectRef>> {
1647
        Ok(self
1648
            .index_get("cert", "certs", key)?
1649
            .into_iter()
1650
            .find(|r| self.has(r)))
1651
    }
1652
f53cbe7a Andy McCall ↶ 1653
    /// Record `value` under `key` in index `index` (for repository code).
1654
    pub(crate) fn index_add_pub(
1655
        &self,
1656
        index: &str,
1657
        key: &ObjectRef,
1658
        value: &ObjectRef,
1659
    ) -> Result<()> {
1660
        self.index_add(index, key, value)
1661
    }
1662
1663
    /// The values recorded under `key` in index `index` (which has no
1664
    /// older one-list form: the legacy name only has to differ from it).
1665
    pub(crate) fn index_get_pub(&self, index: &str, key: &ObjectRef) -> Result<Vec<ObjectRef>> {
1666
        self.index_get(index, &format!("{index}-lists"), key)
1667
    }
1668
fc1a466a Andy McCall ↶ 1669
    pub fn index_receipt(&self, state: &ObjectRef, attest: &ObjectRef) -> Result<()> {
64818938 Andy McCall ↶ 1670
        self.index_add("receipt", state, attest)
fc1a466a Andy McCall ↶ 1671
    }
1672
1673
    /// Receipt attestations recorded for `state`.
1674
    pub fn receipts_for(&self, state: &ObjectRef) -> Result<Vec<ObjectRef>> {
64818938 Andy McCall ↶ 1675
        self.index_get("receipt", "receipts", state)
fc1a466a Andy McCall ↶ 1676
    }
1677
1678
    /// Every state with a receipt, for garbage collection.
1679
    pub fn receipt_states(&self) -> Result<Vec<ObjectRef>> {
64818938 Andy McCall ↶ 1680
        let mut out: Vec<ObjectRef> = Vec::new();
1681
        for e in self.backend.list("receipt/").map_err(backend_err)? {
1682
            // receipt/<hh>/<rest>/<attest>
1683
            let mut parts = e.key.splitn(4, '/');
1684
            let (Some(_), Some(hh), Some(rest), Some(_)) =
1685
                (parts.next(), parts.next(), parts.next(), parts.next())
1686
            else {
1687
                continue;
1688
            };
1689
            out.extend(ObjectRef::from_hex(&format!("{hh}{rest}")));
fc1a466a Andy McCall ↶ 1690
        }
64818938 Andy McCall ↶ 1691
        for e in self.backend.list("receipts/").map_err(backend_err)? {
1692
            let mut parts = e.key.splitn(3, '/');
1693
            let (Some(_), Some(hh), Some(rest)) = (parts.next(), parts.next(), parts.next()) else {
1694
                continue;
1695
            };
1696
            out.extend(ObjectRef::from_hex(&format!("{hh}{rest}")));
1697
        }
fc1a466a Andy McCall ↶ 1698
        out.sort();
64818938 Andy McCall ↶ 1699
        out.dedup();
fc1a466a Andy McCall ↶ 1700
        Ok(out)
5b9c6ad4 Andy McCall ↶ 1701
    }
1702
1983686f Andy McCall ↶ 1703
    pub fn put_identity(&self, id: &Identity) -> Result<ObjectRef> {
1704
        self.put(ObjectType::Identity, &id.encode())
1705
    }
1706
1707
    pub fn get_identity(&self, r: &ObjectRef) -> Result<Identity> {
1708
        Ok(Identity::decode(&self.get_typed(r, ObjectType::Identity)?)?)
1709
    }
1710
64818938 Andy McCall ↶ 1711
    /// Signatures stored alongside object `r` (spec §5.4), one per signing
1712
    /// key, sorted by key. Empty if none.
1983686f Andy McCall ↶ 1713
    pub fn signatures(&self, r: &ObjectRef) -> Result<Vec<Signature>> {
64818938 Andy McCall ↶ 1714
        let mut sigs: Vec<Signature> = Vec::new();
1715
        for e in self
1716
            .backend
1717
            .list(&fanout_prefix("sig", r))
1718
            .map_err(backend_err)?
1719
        {
1720
            let bytes = self.backend.get(&e.key).map_err(backend_err)?;
1721
            sigs.extend(Signature::decode_list(&bytes)?);
1983686f Andy McCall ↶ 1722
        }
64818938 Andy McCall ↶ 1723
        // An older store's one list per object; a signer kept there and
1724
        // here counts once, as written here.
1725
        if let Some(bytes) = get_optional(self.backend.as_ref(), &legacy_key("sigs", r))? {
1726
            for sig in Signature::decode_list(&bytes)? {
1727
                if !sigs.iter().any(|s| s.key == sig.key) {
1728
                    sigs.push(sig);
1729
                }
1730
            }
1731
        }
1732
        sigs.sort_by_key(|s| s.key);
1733
        sigs.dedup_by_key(|s| s.key);
1734
        Ok(sigs)
1983686f Andy McCall ↶ 1735
    }
1736
64818938 Andy McCall ↶ 1737
    /// Attach a signature to object `r`, replacing any earlier one by the
1738
    /// same key: one entry per signer, so the latest by a key is the one
1739
    /// kept, and two signers never touch each other's.
1983686f Andy McCall ↶ 1740
    pub fn put_signature(&self, r: &ObjectRef, sig: &Signature) -> Result<()> {
64818938 Andy McCall ↶ 1741
        let key = format!("{}{}", fanout_prefix("sig", r), sig.key.to_hex());
1742
        let bytes = Signature::encode_list(std::slice::from_ref(sig));
1743
        if get_optional(self.backend.as_ref(), &key)?.as_deref() == Some(bytes.as_slice()) {
1744
            return Ok(());
1983686f Andy McCall ↶ 1745
        }
64818938 Andy McCall ↶ 1746
        delete(self.backend.as_ref(), &key)?;
1747
        put_new_or_existing(self.backend.as_ref(), &key, &bytes)
1983686f Andy McCall ↶ 1748
    }
1749
54e2e630 Andy McCall ↶ 1750
    /// Finish packs a writer left unfinished: a batch writes its objects to
1751
    /// `.tmp-ID.pack` and only indexes it at the end, so a process that
1752
    /// stopped part way (an import killed after hours) leaves every object
1753
    /// in a pack nothing can read. Each such pack untouched for `min_age`
1754
    /// is read through: every whole entry checked against its reference,
1755
    /// a torn last one cut off, then indexed as a pack of the store.
1756
    /// Returns the packs and objects adopted.
1757
    pub fn adopt_unfinished_packs(
1758
        &self,
1759
        min_age: std::time::Duration,
1760
        progress: &dyn Fn(&str),
1761
    ) -> Result<(usize, usize)> {
1762
        use std::io::{BufReader, Read};
1763
        let mut packs = 0;
1764
        let mut objects = 0;
1765
        let Ok(dir) = fs::read_dir(&self.scratch) else {
1766
            return Ok((0, 0));
1767
        };
1768
        for entry in dir.flatten() {
1769
            let name = entry.file_name().to_string_lossy().to_string();
1770
            let Some(id) = name
1771
                .strip_prefix(".tmp-")
1772
                .and_then(|n| n.strip_suffix(".pack"))
1773
            else {
1774
                continue;
1775
            };
1776
            let path = entry.path();
1777
            let meta = fs::metadata(&path)?;
1778
            let age = meta
1779
                .modified()
1780
                .ok()
1781
                .and_then(|m| m.elapsed().ok())
1782
                .unwrap_or_default();
1783
            if age < min_age {
1784
                progress(&format!(
1785
                    "{name}: written to {}s ago, left alone",
1786
                    age.as_secs()
1787
                ));
1788
                continue;
1789
            }
1790
            let mut f = BufReader::with_capacity(1 << 20, fs::File::open(&path)?);
1791
            let mut magic = [0u8; 8];
1792
            if f.read_exact(&mut magic).is_err() || &magic != PACK_MAGIC {
1793
                progress(&format!("{name}: not a pack, left alone"));
1794
                continue;
1795
            }
1796
            let mut offset = PACK_MAGIC.len() as u64;
1797
            let mut index: Vec<(ObjectRef, PackEntry)> = Vec::new();
1798
            loop {
1799
                let mut head = [0u8; 42];
1800
                if f.read_exact(&mut head).is_err() {
1801
                    break;
1802
                }
1803
                let Some(ty) = ObjectType::ALL.get(head[0] as usize).copied() else {
1804
                    break;
1805
                };
1806
                let flags = head[1];
1807
                let stored_len = u32::from_le_bytes(head[2..6].try_into().unwrap());
1808
                let raw_len = u32::from_le_bytes(head[6..10].try_into().unwrap());
1809
                let r = ObjectRef(head[10..42].try_into().unwrap());
1810
                let mut stored = vec![0u8; stored_len as usize];
1811
                if flags & FLAG_DICT != 0 || f.read_exact(&mut stored).is_err() {
1812
                    break;
1813
                }
1814
                let e = PackEntry {
1815
                    offset: offset + 42,
1816
                    stored_len,
1817
                    raw_len,
1818
                    ty,
1819
                    flags,
1820
                };
1821
                if decode_entry(&r, e, stored, None).is_err() {
1822
                    break;
1823
                }
1824
                index.push((r, e));
1825
                offset += 42 + stored_len as u64;
1826
                if index.len().is_multiple_of(200_000) {
1827
                    progress(&format!(
1828
                        "{name}: {} objects checked, {} MiB",
1829
                        index.len(),
1830
                        offset >> 20
1831
                    ));
1832
                }
1833
            }
1834
            if index.is_empty() {
1835
                progress(&format!("{name}: no whole object, left alone"));
1836
                continue;
1837
            }
1838
            if offset < meta.len() {
1839
                progress(&format!(
1840
                    "{name}: {} torn bytes at the end cut off",
1841
                    meta.len() - offset
1842
                ));
1843
                fs::OpenOptions::new()
1844
                    .write(true)
1845
                    .open(&path)?
1846
                    .set_len(offset)?;
1847
            }
1848
            index.sort_by_key(|(r, _)| *r);
1849
            index.dedup_by_key(|(r, _)| *r);
1850
            objects += index.len();
1851
            packs += 1;
1852
            progress(&format!("{name}: {} objects indexed", index.len()));
1853
            self.finish_pack_files(id, &path, &index)?;
1854
        }
1855
        Ok((packs, objects))
1856
    }
1857
d02e545d Andy McCall ↶ 1858
    /// Every object reference in the store, loose and packed (slow; for gc and tests).
ff0af1ee unknown 1859
    pub fn list(&self) -> io::Result<Vec<ObjectRef>> {
64818938 Andy McCall ↶ 1860
        let mut out: Vec<ObjectRef> = self
1861
            .loose_objects()
1862
            .map_err(|e| io::Error::other(e.to_string()))?
1863
            .into_iter()
1864
            .map(|(r, _)| r)
1865
            .collect();
d02e545d Andy McCall ↶ 1866
        for p in self.packs.borrow().iter() {
1867
            out.extend(p.refs.iter().copied());
ff0af1ee unknown 1868
        }
1869
        out.sort();
d02e545d Andy McCall ↶ 1870
        out.dedup();
ff0af1ee unknown 1871
        Ok(out)
1872
    }
afaba5f1 Andy McCall ↶ 1873
}
1874
64818938 Andy McCall ↶ 1875
/// A loose object's bytes, verified against `r`.
1876
fn parse_loose(data: &[u8], r: &ObjectRef) -> Result<Object> {
1877
    let nul = data
1878
        .iter()
1879
        .position(|&b| b == 0)
1880
        .ok_or_else(|| StoreError::Corrupt(*r, "no header".into()))?;
1881
    let head = std::str::from_utf8(&data[..nul])
1882
        .map_err(|_| StoreError::Corrupt(*r, "header not UTF-8".into()))?;
1883
    let mut parts = head.split(' ');
1884
    let (Some("oxy1"), Some(ty), Some(len), None) =
1885
        (parts.next(), parts.next(), parts.next(), parts.next())
1886
    else {
1887
        return Err(StoreError::Corrupt(*r, format!("bad header {head:?}")));
afaba5f1 Andy McCall ↶ 1888
    };
64818938 Andy McCall ↶ 1889
    let ty = ObjectType::from_name(ty)
1890
        .ok_or_else(|| StoreError::Corrupt(*r, format!("unknown type {ty}")))?;
1891
    let len: usize = len
1892
        .parse()
1893
        .map_err(|_| StoreError::Corrupt(*r, "bad length".into()))?;
1894
    let body = &data[nul + 1..];
1895
    if body.len() != len {
1896
        return Err(StoreError::Corrupt(
1897
            *r,
1898
            format!("length {} != header {len}", body.len()),
1899
        ));
1900
    }
1901
    if hash_object(ty, body) != *r {
1902
        return Err(StoreError::Corrupt(*r, "hash mismatch".into()));
1903
    }
1904
    Ok((ty, body.to_vec()))
1905
}
1906
1907
/// Whether the objects are files that a test may tamper with: not under
1908
/// `OXY_STORE_BACKEND=memory`.
1909
#[cfg(test)]
1910
fn files_on_disk() -> bool {
1911
    std::env::var_os("OXY_STORE_BACKEND").is_none()
ff0af1ee unknown 1912
}
1913
1914
#[cfg(test)]
1915
mod tests {
1916
    use super::*;
64818938 Andy McCall ↶ 1917
1918
    /// The store under test twice: in a directory, and on a store in
1919
    /// memory with a scratch directory, as over a bucket.
1920
    fn each_store(dir: &Path, f: impl Fn(&str, Store)) {
1921
        f("directory", Store::open(dir.join("objects")).unwrap());
1922
        f(
1923
            "memory",
1924
            Store::open_on(Arc::new(MemoryStore::new()), dir.join("scratch")).unwrap(),
1925
        );
1926
    }
ff0af1ee unknown 1927
1928
    #[test]
1929
    fn put_get_verify() {
64818938 Andy McCall ↶ 1930
        if !super::files_on_disk() {
1931
            return;
1932
        }
ff0af1ee unknown 1933
        let dir = tempfile::tempdir().unwrap();
1934
        let s = Store::open(dir.path().join("objects")).unwrap();
1935
        let r = s.put(ObjectType::Chunk, b"hello").unwrap();
1936
        assert!(s.has(&r));
1937
        assert_eq!(s.get(&r).unwrap(), (ObjectType::Chunk, b"hello".to_vec()));
1938
        assert_eq!(s.put(ObjectType::Chunk, b"hello").unwrap(), r);
1939
        assert_eq!(s.list().unwrap(), vec![r]);
75167672 Andy McCall 1940
        assert!(matches!(
1941
            s.get_typed(&r, ObjectType::Blob),
1942
            Err(StoreError::WrongType(..))
1943
        ));
1944
        assert!(matches!(
1945
            s.get(&ObjectRef([9; 32])),
1946
            Err(StoreError::NotFound(_))
1947
        ));
ff0af1ee unknown 1948
1949
        // Tamper: flip a byte, read must fail.
1950
        let path = s.path_for(&r);
1951
        let mut data = fs::read(&path).unwrap();
1952
        let last = data.len() - 1;
1953
        data[last] ^= 1;
1954
        fs::write(&path, data).unwrap();
1955
        assert!(matches!(s.get(&r), Err(StoreError::Corrupt(..))));
1956
    }
1957
1958
    #[test]
d02e545d Andy McCall ↶ 1959
    fn packing_keeps_every_object_readable() {
64818938 Andy McCall ↶ 1960
        if !super::files_on_disk() {
1961
            return;
1962
        }
d02e545d Andy McCall ↶ 1963
        let dir = tempfile::tempdir().unwrap();
1964
        let s = Store::open(dir.path()).unwrap();
1965
        let mut refs = Vec::new();
1966
        for i in 0..300u32 {
1967
            let body = format!("object {i} ").repeat(1 + (i % 7) as usize);
1968
            refs.push((s.put(ObjectType::Chunk, body.as_bytes()).unwrap(), body));
1969
        }
1970
        let c = crate::objects::tests::sample_change();
1971
        let cr = s.put_change(&c).unwrap();
1972
        assert_eq!(s.loose_count().unwrap(), 301);
1973
        let report = s.pack_loose().unwrap();
1974
        assert_eq!(report.objects, 301);
1975
        assert!(report.packed_bytes < report.raw_bytes, "{report:?}");
1976
        assert_eq!(s.loose_count().unwrap(), 0);
1977
        assert_eq!(s.pack_count(), 1);
1978
        for (r, body) in &refs {
1979
            assert!(s.has(r));
75167672 Andy McCall 1980
            assert_eq!(
1981
                s.get(r).unwrap(),
1982
                (ObjectType::Chunk, body.as_bytes().to_vec())
1983
            );
d02e545d Andy McCall ↶ 1984
        }
1985
        assert_eq!(s.get_change(&cr).unwrap(), c);
1986
        assert_eq!(s.list().unwrap().len(), 301);
1987
        // Re-putting a packed object is a no-op; new objects go loose and a
1988
        // second pack coexists with the first.
75167672 Andy McCall 1989
        assert_eq!(
1990
            s.put(ObjectType::Chunk, refs[0].1.as_bytes()).unwrap(),
1991
            refs[0].0
1992
        );
d02e545d Andy McCall ↶ 1993
        assert_eq!(s.loose_count().unwrap(), 0);
1994
        let extra = s.put(ObjectType::Chunk, b"after packing").unwrap();
1995
        s.pack_loose().unwrap();
1996
        assert_eq!(s.pack_count(), 2);
1997
        assert_eq!(s.get(&extra).unwrap().1, b"after packing");
1998
        // A reopened store sees the packs.
1999
        let s2 = Store::open(dir.path()).unwrap();
2000
        assert_eq!(s2.pack_count(), 2);
2001
        assert_eq!(s2.get(&refs[5].0).unwrap().1, refs[5].1.as_bytes());
75167672 Andy McCall 2002
        assert!(matches!(
2003
            s2.get(&ObjectRef([9; 32])),
2004
            Err(StoreError::NotFound(_))
2005
        ));
d02e545d Andy McCall ↶ 2006
        // Corrupting an object's body inside the pack is detected on read.
2007
        let target = refs[5].0;
2008
        let (pack_path, offset) = {
2009
            let packs = s2.packs.borrow();
2010
            let (i, e) = s2.find_packed(&target).unwrap();
64818938 Andy McCall ↶ 2011
            (dir.path().join(&packs[i].key), e.offset as usize)
d02e545d Andy McCall ↶ 2012
        };
2013
        let mut data = fs::read(&pack_path).unwrap();
2014
        data[offset] ^= 0xff;
2015
        fs::write(&pack_path, data).unwrap();
2016
        let s3 = Store::open(dir.path()).unwrap();
2017
        assert!(matches!(s3.get(&target), Err(StoreError::Corrupt(..))));
75167672 Andy McCall 2018
        assert_eq!(
2019
            s3.get(&refs[6].0).unwrap().1,
2020
            refs[6].1.as_bytes(),
2021
            "other objects are unaffected"
2022
        );
a17fc622 Andy McCall ↶ 2023
    }
2024
2025
    #[test]
2026
    fn a_full_repack_trains_a_dictionary_and_reads_back() {
64818938 Andy McCall ↶ 2027
        if !super::files_on_disk() {
2028
            return;
2029
        }
a17fc622 Andy McCall ↶ 2030
        let dir = tempfile::tempdir().unwrap();
2031
        let s = Store::open(dir.path()).unwrap();
2032
        // Many small, alike files: what a dictionary is for.
2033
        let bodies: Vec<Vec<u8>> = (0..1500)
2034
            .map(|i| {
2035
                format!(
2036
                    "// SPDX-License-Identifier: GPL-2.0\n#include <linux/module.h>\n\
2037
                     static int probe_{i}(struct device *dev)\n{{\n\treturn {i};\n}}\n"
2038
                )
2039
                .into_bytes()
2040
            })
2041
            .collect();
2042
        let refs: Vec<ObjectRef> = bodies
2043
            .iter()
2044
            .map(|b| s.put(ObjectType::Chunk, b).unwrap())
2045
            .collect();
2046
        s.repack_all(REPACK_ZSTD_LEVEL).unwrap();
2047
        let dicts = fs::read_dir(dir.path())
2048
            .unwrap()
2049
            .flatten()
2050
            .filter(|e| e.path().extension().is_some_and(|x| x == "dict"))
2051
            .count();
2052
        assert_eq!(dicts, 1, "the pack has a dictionary");
2053
        let with_dict = refs
2054
            .iter()
2055
            .filter(|r| s.find_packed(r).unwrap().1.flags & FLAG_DICT != 0)
2056
            .count();
2057
        assert!(with_dict > 1000, "most use it: {with_dict}");
2058
        let again = Store::open(dir.path()).unwrap();
2059
        for (r, b) in refs.iter().zip(&bodies) {
2060
            assert_eq!(&again.get(r).unwrap().1, b);
2061
        }
2062
        // A repack after that replaces the pack and its dictionary.
2063
        again.repack_all(REPACK_ZSTD_LEVEL).unwrap();
2064
        let files: Vec<String> = fs::read_dir(dir.path())
2065
            .unwrap()
2066
            .flatten()
2067
            .map(|e| e.file_name().to_string_lossy().into_owned())
2068
            .filter(|n| n.starts_with("pack-"))
2069
            .collect();
2070
        assert_eq!(files.len(), 3, "one pack, index and dictionary: {files:?}");
2071
        assert_eq!(&again.get(&refs[7]).unwrap().1, &bodies[7]);
d02e545d Andy McCall ↶ 2072
    }
2073
2074
    #[test]
cdb5beba Andy McCall ↶ 2075
    fn nocompress_chunks_pack_raw() {
2076
        let dir = tempfile::tempdir().unwrap();
2077
        let s = Store::open(dir.path()).unwrap();
2078
        let body = vec![b'a'; 10_000];
2079
        let raw = s.put_chunk_nocompress(&body).unwrap();
2080
        let compressible = s.put(ObjectType::Chunk, &vec![b'b'; 10_000]).unwrap();
2081
        s.pack_loose().unwrap();
2082
        let packs = s.packs.borrow();
2083
        let (i, e) = s.find_packed(&raw).unwrap();
2084
        assert_eq!((e.flags, e.stored_len as usize), (0, 10_000));
2085
        let (_, c) = s.find_packed(&compressible).unwrap();
2086
        assert_eq!(c.flags, FLAG_ZSTD);
2087
        assert!(c.stored_len < 10_000);
64818938 Andy McCall ↶ 2088
        assert_eq!(packs[i].fetch(s.backend.as_ref(), &raw, e).unwrap().1, body);
cdb5beba Andy McCall ↶ 2089
    }
2090
2091
    #[test]
135212de Andy McCall ↶ 2092
    fn many_packs_merge_into_one() {
2093
        let dir = tempfile::tempdir().unwrap();
64818938 Andy McCall ↶ 2094
        each_store(dir.path(), |which, s| {
2095
            let mut refs = Vec::new();
2096
            for i in 0..(MAX_PACKS + 2) {
2097
                refs.push(
2098
                    s.put(ObjectType::Chunk, format!("pack {i}").as_bytes())
2099
                        .unwrap(),
2100
                );
2101
                s.pack_loose().unwrap();
2102
            }
2103
            assert_eq!(s.pack_count(), MAX_PACKS + 2, "{which}");
2104
            assert_eq!(s.merge_packs().unwrap(), MAX_PACKS + 2);
2105
            assert_eq!(s.pack_count(), 1);
2106
            assert_eq!(s.merge_packs().unwrap(), 0);
2107
            for (i, r) in refs.iter().enumerate() {
2108
                assert_eq!(s.get(r).unwrap().1, format!("pack {i}").as_bytes());
2109
            }
2110
            let again = Store::open_on(s.backend().clone(), s.dir()).unwrap();
2111
            assert_eq!(again.pack_count(), 1, "{which}: reopened");
2112
        });
135212de Andy McCall ↶ 2113
    }
2114
2115
    #[test]
ba160f60 Andy McCall ↶ 2116
    fn prune_removes_unreachable_loose_and_packed_objects() {
2117
        use std::collections::HashSet;
2118
        let dir = tempfile::tempdir().unwrap();
64818938 Andy McCall ↶ 2119
        each_store(dir.path(), |which, s| {
2120
            let keep_a = s.put(ObjectType::Chunk, b"keep a").unwrap();
2121
            let drop_a = s.put(ObjectType::Chunk, b"drop a").unwrap();
2122
            s.pack_loose().unwrap();
2123
            let keep_b = s.put(ObjectType::Chunk, b"keep b").unwrap();
2124
            let drop_b = s.put(ObjectType::Chunk, b"drop b").unwrap();
2125
            let sk = crate::identity::SecretKey {
2126
                ed_seed: [1; 32],
2127
                ml_seed: [2; 32],
2128
            };
2129
            let id = sk.identity("a", "b", 0);
2130
            let key = s.put_identity(&id).unwrap();
2131
            s.put_signature(
2132
                &drop_b,
2133
                &sk.sign(crate::identity::Domain::Change, &key, &drop_b),
2134
            )
75167672 Andy McCall 2135
            .unwrap();
64818938 Andy McCall ↶ 2136
            s.index_seal(&drop_a, &ObjectRef([3; 32])).unwrap();
2137
            let keep: HashSet<ObjectRef> = [keep_a, keep_b, key].into_iter().collect();
2138
            // Everything is too young under a grace period.
2139
            let r = s
2140
                .prune(&keep, std::time::Duration::from_secs(3600))
2141
                .unwrap();
2142
            assert_eq!((r.objects, r.deferred), (0, 2), "{which}");
2143
            let r = s.prune(&keep, std::time::Duration::ZERO).unwrap();
2144
            assert_eq!(r.objects, 2, "{which}: {r:?}");
2145
            assert!(s.has(&keep_a) && s.has(&keep_b) && s.has(&key));
2146
            assert!(!s.has(&drop_a) && !s.has(&drop_b));
2147
            assert!(s.signatures(&drop_b).unwrap().is_empty());
2148
            assert!(s.seals_for(&drop_a).unwrap().is_empty());
2149
            assert_eq!(s.pack_count(), 1);
2150
            assert_eq!(s.get(&keep_a).unwrap().1, b"keep a");
2151
            assert_eq!(s.list().unwrap().len(), 3);
2152
        });
ba160f60 Andy McCall ↶ 2153
    }
2154
2155
    #[test]
1983686f Andy McCall ↶ 2156
    fn signatures_are_stored_beside_objects() {
64818938 Andy McCall ↶ 2157
        use crate::identity::{Domain, SecretKey};
2158
        let dir = tempfile::tempdir().unwrap();
2159
        each_store(dir.path(), |which, s| {
2160
            let r = s.put(ObjectType::Chunk, b"x").unwrap();
2161
            assert!(s.signatures(&r).unwrap().is_empty());
2162
            let sk = SecretKey {
2163
                ed_seed: [1; 32],
2164
                ml_seed: [2; 32],
2165
            };
2166
            let id = sk.identity("a", "b", 0);
2167
            let key = s.put_identity(&id).unwrap();
2168
            assert_eq!(s.get_identity(&key).unwrap(), id);
2169
            let sig = sk.sign(Domain::Change, &key, &r);
2170
            s.put_signature(&r, &sig).unwrap();
2171
            s.put_signature(&r, &sig).unwrap();
2172
            assert_eq!(s.signatures(&r).unwrap(), vec![sig.clone()], "{which}");
2173
            // A second signer is kept beside the first, sorted by key.
2174
            let sk2 = SecretKey {
2175
                ed_seed: [3; 32],
2176
                ml_seed: [4; 32],
2177
            };
2178
            let key2 = s.put_identity(&sk2.identity("c", "d", 0)).unwrap();
2179
            let sig2 = sk2.sign(Domain::Change, &key2, &r);
2180
            s.put_signature(&r, &sig2).unwrap();
2181
            let mut both = vec![sig.clone(), sig2.clone()];
2182
            both.sort_by_key(|s| s.key);
2183
            assert_eq!(s.signatures(&r).unwrap(), both);
2184
            // The object itself is untouched by its signatures.
2185
            assert_eq!(s.get(&r).unwrap().1, b"x");
2186
            // Seal and receipt entries, and the states with receipts.
2187
            s.index_seal(&r, &ObjectRef([5; 32])).unwrap();
2188
            s.index_seal(&r, &ObjectRef([4; 32])).unwrap();
2189
            s.index_seal(&r, &ObjectRef([5; 32])).unwrap();
2190
            assert_eq!(
2191
                s.seals_for(&r).unwrap(),
2192
                vec![ObjectRef([4; 32]), ObjectRef([5; 32])]
2193
            );
2194
            let st = ObjectRef([6; 32]);
2195
            s.index_receipt(&st, &ObjectRef([7; 32])).unwrap();
2196
            assert_eq!(s.receipts_for(&st).unwrap(), vec![ObjectRef([7; 32])]);
2197
            assert_eq!(s.receipt_states().unwrap(), vec![st]);
2198
        });
2199
    }
2200
2201
    /// A store written before signatures, seals and receipts were one
2202
    /// entry each (`sigs/`, `seals/`, `receipts/` lists) still reads, and
2203
    /// what is written now sits beside what was there.
2204
    #[test]
2205
    fn an_older_store_s_sidecar_lists_are_still_read() {
2206
        if !super::files_on_disk() {
2207
            return;
2208
        }
1983686f Andy McCall ↶ 2209
        use crate::identity::{Domain, SecretKey};
2210
        let dir = tempfile::tempdir().unwrap();
2211
        let s = Store::open(dir.path()).unwrap();
64818938 Andy McCall ↶ 2212
        let r = s.put(ObjectType::Chunk, b"old").unwrap();
2213
        let h = r.to_hex();
75167672 Andy McCall 2214
        let sk = SecretKey {
2215
            ed_seed: [1; 32],
2216
            ml_seed: [2; 32],
2217
        };
64818938 Andy McCall ↶ 2218
        let key = s.put_identity(&sk.identity("a", "b", 0)).unwrap();
1983686f Andy McCall ↶ 2219
        let sig = sk.sign(Domain::Change, &key, &r);
64818938 Andy McCall ↶ 2220
        let legacy = dir.path().join("sigs").join(&h[..2]);
2221
        fs::create_dir_all(&legacy).unwrap();
2222
        fs::write(
2223
            legacy.join(&h[2..]),
2224
            Signature::encode_list(std::slice::from_ref(&sig)),
2225
        )
2226
        .unwrap();
2227
        let seals = dir.path().join("seals").join(&h[..2]);
2228
        fs::create_dir_all(&seals).unwrap();
2229
        fs::write(
2230
            seals.join(&h[2..]),
2231
            format!("{}\n", ObjectRef([9; 32]).to_hex()),
2232
        )
2233
        .unwrap();
2234
        let receipts = dir.path().join("receipts").join(&h[..2]);
2235
        fs::create_dir_all(&receipts).unwrap();
2236
        fs::write(
2237
            receipts.join(&h[2..]),
2238
            format!("{}\n", ObjectRef([8; 32]).to_hex()),
2239
        )
2240
        .unwrap();
2241
2242
        assert_eq!(s.signatures(&r).unwrap(), vec![sig.clone()]);
2243
        assert_eq!(s.seals_for(&r).unwrap(), vec![ObjectRef([9; 32])]);
2244
        assert_eq!(s.receipts_for(&r).unwrap(), vec![ObjectRef([8; 32])]);
2245
        assert_eq!(s.receipt_states().unwrap(), vec![r]);
2246
        // New entries join the old ones; the same signer is not doubled.
1983686f Andy McCall ↶ 2247
        s.put_signature(&r, &sig).unwrap();
64818938 Andy McCall ↶ 2248
        s.index_seal(&r, &ObjectRef([1; 32])).unwrap();
2249
        assert_eq!(s.signatures(&r).unwrap().len(), 1);
2250
        assert_eq!(
2251
            s.seals_for(&r).unwrap(),
2252
            vec![ObjectRef([1; 32]), ObjectRef([9; 32])]
2253
        );
2254
        // Pruning the object takes both layouts with it.
2255
        let r2 = s.put(ObjectType::Chunk, b"kept").unwrap();
2256
        let keep = [r2, key].into_iter().collect();
2257
        s.prune(&keep, std::time::Duration::ZERO).unwrap();
2258
        assert!(s.signatures(&r).unwrap().is_empty());
2259
        assert!(s.seals_for(&r).unwrap().is_empty());
2260
        assert!(s.receipt_states().unwrap().is_empty());
1983686f Andy McCall ↶ 2261
    }
2262
2263
    #[test]
ff0af1ee unknown 2264
    fn change_round_trip_through_store() {
2265
        let dir = tempfile::tempdir().unwrap();
64818938 Andy McCall ↶ 2266
        each_store(dir.path(), |which, s| {
2267
            let c = crate::objects::tests::sample_change();
2268
            let r = s.put_change(&c).unwrap();
2269
            assert_eq!(r, c.hash(), "{which}");
2270
            assert_eq!(s.get_change(&r).unwrap(), c);
2271
            assert_eq!(s.get_change_meta(&r).unwrap().message, c.message);
2272
        });
ff0af1ee unknown 2273
    }
2b872d07 Andy McCall ↶ 2274
2275
    fn xorshift(state: &mut u64) -> u64 {
2276
        *state ^= *state << 13;
2277
        *state ^= *state >> 7;
2278
        *state ^= *state << 17;
2279
        *state
2280
    }
2281
2282
    /// Random corruption of pack and index files never panics: reads fail
2283
    /// with an error or the store refuses to open, and untouched objects
2284
    /// stay readable when the index survives.
2285
    #[test]
2286
    fn corrupted_packs_and_indexes_fail_cleanly() {
64818938 Andy McCall ↶ 2287
        if !super::files_on_disk() {
2288
            return;
2289
        }
2b872d07 Andy McCall ↶ 2290
        let dir = tempfile::tempdir().unwrap();
2291
        let objects = dir.path().join("objects");
2292
        let s = Store::open(&objects).unwrap();
2293
        let mut refs = Vec::new();
2294
        let mut seed = 0x9e3779b97f4a7c15u64;
2295
        for i in 0..40u32 {
2296
            let len = (xorshift(&mut seed) % 5000) as usize;
2297
            let mut body = vec![0u8; len];
2298
            for b in body.iter_mut() {
75167672 Andy McCall 2299
                *b = if i % 2 == 0 {
2300
                    (xorshift(&mut seed) & 0xff) as u8
2301
                } else {
2302
                    b'a' + (i % 26) as u8
2303
                };
2b872d07 Andy McCall ↶ 2304
            }
2305
            refs.push(s.put(ObjectType::Chunk, &body).unwrap());
2306
        }
2307
        s.pack_loose().unwrap();
75167672 Andy McCall 2308
        let pack = fs::read_dir(&objects)
2309
            .unwrap()
2310
            .filter_map(|e| e.ok().map(|e| e.path()))
2311
            .find(|p| p.extension().is_some_and(|x| x == "pack"))
2312
            .unwrap();
2b872d07 Andy McCall ↶ 2313
        let idx = pack.with_extension("idx");
2314
        let pristine_pack = fs::read(&pack).unwrap();
2315
        let pristine_idx = fs::read(&idx).unwrap();
2316
2317
        for round in 0..300u32 {
75167672 Andy McCall 2318
            let (path, pristine) = if round % 2 == 0 {
2319
                (&pack, &pristine_pack)
2320
            } else {
2321
                (&idx, &pristine_idx)
2322
            };
2b872d07 Andy McCall ↶ 2323
            let mut data = pristine.clone();
2324
            match xorshift(&mut seed) % 4 {
2325
                0 => {
2326
                    let at = (xorshift(&mut seed) as usize) % data.len();
2327
                    data[at] ^= 1 << (xorshift(&mut seed) % 8);
2328
                }
2329
                1 => {
2330
                    let at = (xorshift(&mut seed) as usize) % data.len();
2331
                    data[at] = (xorshift(&mut seed) & 0xff) as u8;
2332
                }
2333
                2 => {
2334
                    let keep = (xorshift(&mut seed) as usize) % data.len();
2335
                    data.truncate(keep);
2336
                }
2337
                _ => {
2338
                    let at = (xorshift(&mut seed) as usize) % data.len();
2339
                    let n = ((xorshift(&mut seed) % 8) + 1) as usize;
2340
                    for k in 0..n.min(data.len() - at) {
2341
                        data[at + k] = 0xff;
2342
                    }
2343
                }
2344
            }
2345
            fs::write(path, &data).unwrap();
2346
            // Opening may refuse a broken index; a store that opens must
2347
            // either return each object intact or report it corrupt/missing.
2348
            if let Ok(s2) = Store::open(&objects) {
2349
                for r in &refs {
2350
                    match s2.get(r) {
75167672 Andy McCall 2351
                        Ok((ty, body)) => assert_eq!(
2352
                            hash_object(ty, &body),
2353
                            *r,
2354
                            "a returned object always matches its reference"
2355
                        ),
2356
                        Err(StoreError::Corrupt(..))
2357
                        | Err(StoreError::NotFound(_))
2358
                        | Err(StoreError::Io(_)) => {}
2b872d07 Andy McCall ↶ 2359
                        Err(e) => panic!("unexpected error {e}"),
2360
                    }
2361
                }
2362
            }
2363
            fs::write(path, pristine).unwrap();
2364
        }
2365
        // Restored files read back in full.
2366
        let s3 = Store::open(&objects).unwrap();
2367
        for r in &refs {
2368
            let (ty, body) = s3.get(r).unwrap();
2369
            assert_eq!(hash_object(ty, &body), *r);
2370
        }
2371
    }
8f10a07a Andy McCall ↶ 2372
2373
    /// A small batch becomes loose objects; a large one becomes a single
2374
    /// pack. Objects are readable while pending, and batches nest.
2375
    #[test]
2376
    fn batches_write_loose_or_one_pack() {
2377
        let dir = tempfile::tempdir().unwrap();
64818938 Andy McCall ↶ 2378
        each_store(dir.path(), |which, s| {
2379
            let outer = s.begin_batch().unwrap();
2380
            let a = s.put(ObjectType::Chunk, b"small a").unwrap();
2381
            {
2382
                let inner = s.begin_batch().unwrap();
2383
                let b = s.put(ObjectType::Chunk, b"small b").unwrap();
2384
                assert!(s.has(&b));
2385
                assert_eq!(s.get(&b).unwrap().1, b"small b");
2386
                inner.finish().unwrap();
2387
                assert_eq!(
2388
                    s.loose_count().unwrap(),
2389
                    0,
2390
                    "{which}: the inner batch defers to the outer one"
2391
                );
2392
            }
2393
            assert_eq!(s.get(&a).unwrap().1, b"small a");
75167672 Andy McCall 2394
            assert_eq!(
64818938 Andy McCall ↶ 2395
                s.put(ObjectType::Chunk, b"small a").unwrap(),
2396
                a,
2397
                "idempotent while pending"
75167672 Andy McCall 2398
            );
64818938 Andy McCall ↶ 2399
            outer.finish().unwrap();
2400
            assert_eq!(s.loose_count().unwrap(), 2);
2401
            assert_eq!(s.pack_count(), 0);
2402
            assert_eq!(s.get(&a).unwrap().1, b"small a");
8f10a07a Andy McCall ↶ 2403
64818938 Andy McCall ↶ 2404
            // Large: spills into one pack, readable during and after.
2405
            let big = s.begin_batch().unwrap();
2406
            let mut refs = Vec::new();
2407
            let mut seed = 7u64;
2408
            for i in 0..300u32 {
2409
                let mut body = vec![b'z'; 40_000];
2410
                if i % 3 == 0 {
2411
                    for b in body.iter_mut() {
2412
                        *b = (xorshift(&mut seed) & 0xff) as u8;
2413
                    }
8f10a07a Andy McCall ↶ 2414
                }
64818938 Andy McCall ↶ 2415
                body[..4].copy_from_slice(&i.to_le_bytes());
2416
                let r = if i % 5 == 0 {
2417
                    s.put_chunk_nocompress(&body).unwrap()
2418
                } else {
2419
                    s.put(ObjectType::Chunk, &body).unwrap()
2420
                };
2421
                assert_eq!(
2422
                    s.get(&r).unwrap().1,
2423
                    body,
2424
                    "readable while pending (object {i})"
2425
                );
2426
                refs.push((r, body));
8f10a07a Andy McCall ↶ 2427
            }
64818938 Andy McCall ↶ 2428
            assert!(s.has(&refs[0].0));
2429
            big.finish().unwrap();
2430
            assert_eq!(s.pack_count(), 1);
75167672 Andy McCall 2431
            assert_eq!(
64818938 Andy McCall ↶ 2432
                s.loose_count().unwrap(),
2433
                2,
2434
                "nothing from the big batch is loose"
75167672 Andy McCall 2435
            );
64818938 Andy McCall ↶ 2436
            assert!(fs::read_dir(s.dir())
75167672 Andy McCall 2437
                .unwrap()
64818938 Andy McCall ↶ 2438
                .flatten()
2439
                .all(|e| !e.file_name().to_string_lossy().contains("tmp-")));
2440
            let s2 = Store::open_on(s.backend().clone(), s.dir()).unwrap();
2441
            for (r, body) in &refs {
2442
                assert_eq!(s2.get(r).unwrap().1, *body);
2443
            }
2444
            // A dropped batch still writes its objects.
2445
            {
2446
                let _b = s2.begin_batch().unwrap();
2447
                s2.put(ObjectType::Chunk, b"dropped").unwrap();
2448
            }
2449
            assert_eq!(
2450
                s2.get(&hash_object(ObjectType::Chunk, b"dropped"))
2451
                    .unwrap()
2452
                    .1,
2453
                b"dropped"
2454
            );
2455
        });
afaba5f1 Andy McCall ↶ 2456
    }
2457
2458
    #[test]
2459
    fn get_many_reads_loose_and_packed_objects_in_order() {
2460
        let dir = tempfile::tempdir().unwrap();
64818938 Andy McCall ↶ 2461
        each_store(dir.path(), |which, s| {
2462
            let packed: Vec<ObjectRef> = (0..20)
2463
                .map(|i| {
2464
                    s.put(ObjectType::Chunk, format!("packed {i}").as_bytes())
2465
                        .unwrap()
2466
                })
2467
                .collect();
2468
            s.pack_loose().unwrap();
2469
            let loose: Vec<ObjectRef> = (0..20)
2470
                .map(|i| {
2471
                    s.put(ObjectType::Chunk, format!("loose {i}").as_bytes())
2472
                        .unwrap()
2473
                })
2474
                .collect();
2475
            let missing = hash_object(ObjectType::Chunk, b"never stored");
2476
            let mut refs: Vec<ObjectRef> = Vec::new();
2477
            for i in 0..20 {
2478
                refs.push(loose[i]);
2479
                refs.push(packed[i]);
2480
            }
2481
            refs.push(missing);
2482
            let got = s.get_many(&refs);
2483
            assert_eq!(got.len(), refs.len());
2484
            for (i, r) in refs.iter().enumerate().take(40) {
2485
                let want = if i % 2 == 0 {
2486
                    format!("loose {}", i / 2)
2487
                } else {
2488
                    format!("packed {}", i / 2)
2489
                };
2490
                let (ty, body) = got[i].as_ref().unwrap();
2491
                assert_eq!(
2492
                    (*ty, body.as_slice()),
2493
                    (ObjectType::Chunk, want.as_bytes()),
2494
                    "{which}: {r:?}"
2495
                );
2496
            }
2497
            assert!(matches!(got[40], Err(StoreError::NotFound(_))));
2498
        });
a9f686ed Andy McCall ↶ 2499
    }
2500
}
2501
2502
#[cfg(test)]
2503
mod batch_tests {
2504
    use super::*;
2505
2506
    #[test]
2507
    fn a_large_batch_packs_every_object_and_indexes_them_all() {
2508
        let dir = tempfile::tempdir().unwrap();
2509
        let store = Store::open(dir.path()).unwrap();
2510
        let mut refs = Vec::new();
2511
        {
2512
            let batch = store.begin_batch().unwrap();
2513
            for i in 0..1000u32 {
2514
                let body = format!("object {i} {}", "x".repeat(20_000 + i as usize)).into_bytes();
2515
                refs.push(store.put(ObjectType::Blob, &body).unwrap());
2516
            }
2517
            batch.finish().unwrap();
2518
        }
2519
        let again = Store::open(dir.path()).unwrap();
2520
        for r in &refs {
2521
            again
54e2e630 Andy McCall ↶ 2522
                .get(r)
2523
                .unwrap_or_else(|e| panic!("{}: {e}", r.short(12)));
2524
        }
2525
    }
2526
2527
    #[test]
2528
    fn a_pack_a_stopped_batch_left_is_adopted_and_its_torn_end_cut() {
2529
        // oxygen#79: a batch never finished (a process killed part way)
2530
        // leaves its objects in an unindexed .tmp pack.
2531
        let dir = tempfile::tempdir().unwrap();
2532
        let mut refs = Vec::new();
2533
        {
2534
            let store = Store::open(dir.path()).unwrap();
2535
            let batch = store.begin_batch().unwrap();
2536
            for i in 0..300u32 {
2537
                let body = format!("object {i} {}", "y".repeat(20_000 + i as usize)).into_bytes();
2538
                refs.push(store.put(ObjectType::Blob, &body).unwrap());
2539
            }
2540
            std::mem::forget(batch);
2541
        }
2542
        let tmp: Vec<_> = fs::read_dir(dir.path())
2543
            .unwrap()
2544
            .flatten()
2545
            .filter(|e| e.file_name().to_string_lossy().starts_with(".tmp-"))
2546
            .map(|e| e.path())
2547
            .collect();
2548
        assert_eq!(tmp.len(), 1, "one unfinished pack");
2549
        // A torn last entry: a header and part of its body.
2550
        let mut f = fs::OpenOptions::new().append(true).open(&tmp[0]).unwrap();
2551
        f.write_all(&[0, 1, 0xff, 0, 0, 0, 9, 9, 0, 0]).unwrap();
2552
        f.write_all(&[7; 40]).unwrap();
2553
        drop(f);
2554
        let store = Store::open(dir.path()).unwrap();
2555
        assert!(store.get(&refs[0]).is_err(), "unreadable before");
2556
        let young = store
2557
            .adopt_unfinished_packs(std::time::Duration::from_secs(3600), &|_| {})
2558
            .unwrap();
2559
        assert_eq!(young, (0, 0), "a pack written to lately is left alone");
2560
        let (packs, objects) = store
2561
            .adopt_unfinished_packs(std::time::Duration::ZERO, &|_| {})
2562
            .unwrap();
2563
        assert_eq!((packs, objects), (1, 300));
2564
        for r in &refs {
2565
            store
a9f686ed Andy McCall ↶ 2566
                .get(r)
2567
                .unwrap_or_else(|e| panic!("{}: {e}", r.short(12)));
2568
        }
54e2e630 Andy McCall ↶ 2569
        let again = Store::open(dir.path()).unwrap();
2570
        assert!(again.get(&refs[299]).is_ok(), "indexed for good");
a9f686ed Andy McCall ↶ 2571
    }
2572
}
2573
2574
#[cfg(test)]
2575
mod size_tests {
2576
    use super::*;
2577
2578
    #[test]
2579
    fn an_object_over_the_limit_is_refused_and_nothing_is_written() {
2580
        let dir = tempfile::tempdir().unwrap();
2581
        let store = Store::open(dir.path()).unwrap();
2582
        let big = vec![b'x'; MAX_OBJECT_LEN as usize + 1];
2583
        {
2584
            let batch = store.begin_batch().unwrap();
2585
            store.put(ObjectType::Blob, b"small").unwrap();
2586
            let e = store.put(ObjectType::Change, &big).unwrap_err();
2587
            assert!(
2588
                matches!(e, StoreError::TooLarge { kind: "change", .. }),
2589
                "{e}"
2590
            );
2591
            assert!(e.to_string().contains("commit it in parts"), "{e}");
2592
            batch.finish().unwrap();
2593
        }
2594
        // The store still opens and reads what was written.
2595
        let again = Store::open(dir.path()).unwrap();
2596
        again.get(&hash_object(ObjectType::Blob, b"small")).unwrap();
6f8aeb99 Andy McCall ↶ 2597
    }
2598
}
2599
2600
#[cfg(test)]
2601
mod text_tests {
2602
    use super::*;
2603
    use crate::objects::{AtomRef, Edit, CHANGE_VERSION};
2604
2605
    fn large_change() -> Change {
2606
        let mut c = crate::objects::tests::sample_change();
2607
        assert_eq!(c.version, CHANGE_VERSION);
2608
        c.edits[0] = Edit::Insert {
2609
            node: crate::ids::NodeId([7; 16]),
2610
            after: AtomRef::Start,
2611
            before: AtomRef::End,
2612
            lines: (0..2000)
2613
                .map(|i| format!("line {i}\n").into_bytes())
2614
                .collect(),
2615
        };
2616
        c
2617
    }
2618
2619
    #[test]
2620
    fn a_large_insert_is_stored_beside_its_change_and_read_back() {
2621
        let dir = tempfile::tempdir().unwrap();
2622
        let s = Store::open(dir.path()).unwrap();
2623
        let c = large_change();
2624
        let r = s.put_change(&c).unwrap();
2625
        assert_eq!(r, c.hash());
2626
        let (_, body) = s.get(&r).unwrap();
2627
        assert!(
2628
            body.len() < 1024,
2629
            "the change holds a reference, not {} bytes of lines",
2630
            body.len()
2631
        );
2632
        let (back, parts) = s.get_change_parts(&r).unwrap();
2633
        assert_eq!(back, c);
2634
        // The text blob and its chunk.
2635
        assert_eq!(parts.len(), 2);
2636
        for p in &parts {
2637
            assert!(s.has(p));
2638
        }
2639
        // Storing it again writes nothing new.
2640
        let n = s.list().unwrap().len();
2641
        s.put_change(&c).unwrap();
2642
        assert_eq!(s.list().unwrap().len(), n);
2643
    }
2644
2645
    #[test]
2646
    fn a_change_whose_text_blob_is_missing_is_reported_not_misread() {
64818938 Andy McCall ↶ 2647
        if !super::files_on_disk() {
2648
            return;
2649
        }
6f8aeb99 Andy McCall ↶ 2650
        let dir = tempfile::tempdir().unwrap();
2651
        let s = Store::open(dir.path()).unwrap();
2652
        let c = large_change();
2653
        let r = s.put_change(&c).unwrap();
2654
        let (_, parts) = s.get_change_parts(&r).unwrap();
2655
        fs::remove_file(s.path_for(&parts[0])).unwrap();
2656
        let e = s.get_change(&r).unwrap_err();
2657
        assert!(
2658
            matches!(&e, StoreError::Corrupt(h, why) if *h == r && why.contains("missing")),
2659
            "{e}"
2660
        );
192fad1e Andy McCall ↶ 2661
    }
2662
}
2663
2664
#[cfg(test)]
2665
mod put_many_tests {
2666
    use super::*;
2667
2668
    #[test]
2669
    fn many_objects_in_a_batch_are_compressed_together_and_all_read_back() {
2670
        let dir = tempfile::tempdir().unwrap();
2671
        let s = Store::open(dir.path()).unwrap();
2672
        let before = s.put(ObjectType::Chunk, b"already here").unwrap();
2673
        let bodies: Vec<Vec<u8>> = (0..200u32)
2674
            .map(|i| format!("chunk {i} ").repeat(6000).into_bytes())
2675
            .collect();
2676
        let mut objects: Vec<(ObjectType, &[u8])> = bodies
2677
            .iter()
2678
            .map(|b| (ObjectType::Chunk, b.as_slice()))
2679
            .collect();
2680
        objects.push((ObjectType::Chunk, bodies[0].as_slice()));
2681
        objects.push((ObjectType::Chunk, b"already here"));
2682
        let refs = {
2683
            let batch = s.begin_batch().unwrap();
2684
            let refs = s.put_many(&objects).unwrap();
2685
            batch.finish().unwrap();
2686
            refs
2687
        };
2688
        assert_eq!(refs.len(), objects.len());
2689
        assert_eq!(refs[200], refs[0], "a repeat is the same object");
2690
        assert_eq!(refs[201], before);
2691
        let again = Store::open(dir.path()).unwrap();
2692
        for (r, b) in refs.iter().zip(&objects) {
2693
            assert_eq!(again.get(r).unwrap().1, b.1);
2694
        }
8f10a07a Andy McCall ↶ 2695
    }
ff0af1ee unknown 2696
}