znippy_plugin_git/git_ops.rs
1//! **`GitOps` — ours, typed, and base znippy never sees it.**
2//!
3//! §13.2: `ArchiveTypePlugin` is base znippy's contract and
4//! [`crate::NativeGitPlugin`] implements it — base stores, the plugin annotates,
5//! exactly as maven, python, rust-toolchain and media already work. `GitOps` is
6//! the *other* trait: the one gunnar calls, with git's own vocabulary in it.
7//!
8//! §13.3: `ArchiveTypePlugin::run_command(cmd, args)` is **CLI-only string
9//! dispatch** and delegates here. A server's hot path does not go through
10//! stringly-typed dispatch, so nothing below takes a `&str` command or an
11//! `args: &[String]`.
12//!
13//! ```text
14//! gunnar ──typed──► GitOps (this file, twelve methods)
15//! │
16//! ┌────────────────┼──────────────────┬─────────────┐
17//! ▼ ▼ ▼ ▼
18//! ArchiveWrite ObjectIndex RefLog Gc
19//! SafeWriter ObjectReadStack push log NewGeneration
20//! (blob fsync, (stree → Arrow (Arrow IPC (link, compact,
21//! journal row) → redb tail) frame = tx) verify, rename)
22//! ```
23//!
24//! Every arm under that diagram already existed and was already measured. This
25//! file adds no storage, no index and no durability mechanism of its own — if a
26//! method here looks like it is inventing one, that is a bug.
27//!
28//! # The one thing that is NOT here
29//!
30//! `run_command` still lives on the plugin in [`crate::lib`], and it now
31//! delegates. Nothing git-shaped went into base znippy for any of this.
32
33use std::collections::{BTreeMap, HashMap};
34use std::fs::File;
35use std::path::{Path, PathBuf};
36use std::sync::{Arc, Mutex, RwLock};
37
38use anyhow::{anyhow, bail, Context, Result};
39use znippy_common::ReservedSection;
40
41use crate::arms::StoreConfig;
42use crate::exploded::ExplodedStats;
43use crate::exploded_cache::ExplodedCache;
44use crate::gc::{Gc, GcReport};
45use crate::graph::{assign_generations, CommitNode};
46use crate::index_layout::{ObjectIndex, OneTableFourColumns};
47use crate::indexer::{IndexJob, ObjectAbsorb, PushPath};
48use crate::object::{GitHashKind, GitObjectKind};
49use crate::pack_walk::PackWalk;
50use crate::reach::ReachEntry;
51use crate::read_stack::{ObjectReadStack, RebuildTriggers};
52use crate::refs::{RefLog, RefUpdate};
53use crate::resolve::BaseSource;
54
55// ── the contract, now owned by `git-storage-trait` ────────────────────────────
56//
57// `GitOps` (the neutral ELEVEN) and its value types live in the
58// `git-storage-trait` crate at this repo's root, so a gix backend
59// (edda/storage-git-gix) can implement the same contract without linking Arrow
60// or OpenZL. The twelfth method, `seal()`, returns `znippy_common::
61// ReservedSection` (an Arrow type a gix backend has no analog for), so it is an
62// **inherent** method on [`GitStore`] / [`SelectedStore`], not part of the
63// trait. The re-exports below keep every existing path
64// (`znippy_plugin_git::git_ops::{GitOps, Oid, …}`) alive.
65pub use git_storage_trait::{Extent, GitOps, Oid, RefRow, Stored, TxId};
66
67
68// ── the batch shape, which is measured and must not be papered over ───────────
69
70/// Which path a lookup of `n` oids takes.
71///
72/// The number this dispatch was written for is `index_layout_bench`'s: on the bare
73/// Arrow arms, `lookup_batch` with a **single** element costs 818 ns against
74/// `lookup`'s 482 ns — 1.7x worse — because the batch path allocates a result
75/// vector, a key vector and a second pass over them to serve one oid.
76///
77/// **RE-MEASURED against the shipping read stack, and the magnitude does not
78/// carry over.** oden 2026-08-07, release, 1-min loadavg 4.94 (another tenant's
79/// work — see LAW: never measure on a busy box, and read these as a ratio rather
80/// than as absolutes), `ObjectReadStack<OneTableFourColumns>` over a real
81/// repository's 2687-object pack, 20 000 iterations
82/// ([`crate::store::tests::the_batch_of_one_really_is_slower_than_the_serial_path`]):
83///
84/// | call | per oid |
85/// |---|---:|
86/// | `lookup` | **628 ns** |
87/// | `lookup_batch` with 1 oid | **639 ns** — 1.02x worse |
88/// | `lookup_batch` with 100 oids | **161 ns** — 3.9x better |
89///
90/// So: the *direction* holds and the dispatch is right — a batch of one is never
91/// faster — but on this stack at this size it costs 2%, not 70%. The real finding
92/// is the third row: the batch path is worth **3.9x** at
93/// [`BATCH_SATURATES_AT`], which is a much stronger reason to keep the two paths
94/// apart than the batch-of-one penalty ever was. Both numbers are stated because
95/// quoting only the 1.7x would be quoting a figure this stack does not reproduce.
96///
97/// The dispatch is a named function with its own guard precisely so it cannot
98/// quietly become `lookup_batch` for every n.
99#[derive(Debug, Clone, Copy, PartialEq, Eq)]
100pub enum LookupPath {
101 /// One oid: `ObjectIndex::lookup`.
102 Serial,
103 /// Two or more: `ObjectIndex::lookup_batch`, one pass.
104 Batch,
105}
106
107/// Oids at which the batch path stops getting faster. Reported, not enforced:
108/// splitting a bigger batch would cost a pass and buy nothing.
109pub const BATCH_SATURATES_AT: usize = 100;
110
111/// The dispatch, in one place.
112pub fn lookup_path(n: usize) -> LookupPath {
113 if n == 1 {
114 LookupPath::Serial
115 } else {
116 LookupPath::Batch
117 }
118}
119
120// ── the store ─────────────────────────────────────────────────────────────────
121
122/// A pack whose bytes are durable but whose objects the index has not absorbed.
123///
124/// §13.12's `indexed` bit, in the form this store needs it: membership in
125/// [`PackState::pending`] *is* the bit being clear. A read that arrives while it
126/// is non-empty falls back to absorbing it — slower, never wrong.
127#[derive(Debug, Clone, Copy, PartialEq, Eq)]
128struct PendingPack {
129 pack_id: u64,
130 offset: u64,
131 len: u64,
132 /// The journal queued it on open (a restart), not a push in this process.
133 /// What makes the progress row say `resumed 0%` after a reboot.
134 resumed: bool,
135}
136
137impl PendingPack {
138 fn from_job(j: IndexJob) -> Self {
139 Self {
140 pack_id: j.pack_id,
141 offset: j.offset,
142 len: j.len,
143 resumed: false,
144 }
145 }
146}
147
148/// **§13.12's `indexed` bit — one bit per pack, indexed by pack ordinal.**
149///
150/// A plain bitset, and the two rejected alternatives say why:
151///
152/// * **not a hash set.** Pack ordinals are dense and small: they are assigned
153/// `0..N` within **one repository** (§13.14 scopes a negotiation, and therefore
154/// this store, to one repository — account-wide they would be sparse and the
155/// array would grow with the account's total packs). Dense means the bit is one
156/// shift and one AND with no hashing, and 10 000 packs is **1250 bytes** of
157/// `words`, which lives in L1.
158/// * **not a bloom filter.** A bloom's false positive would be *actively wrong*
159/// here: it would report a pack absorbed when it is not, the read path would
160/// stop falling back, and negotiation would be told `absent` about an object
161/// whose bytes are durable — which makes a client withhold objects and lose
162/// data. The bitset has no such mode. `1` means absorbed, `0` means fall back,
163/// and both are exact.
164///
165/// **The bit is never stored.** It is derived on open by diffing two facts that
166/// are already durable — the journal's extents against the index's rows — in
167/// [`Absorber::adopt_journal`]. There is nothing for a derived bit to drift from.
168///
169/// **Why the extents sit beside it.** A `0` bit is only actionable with the
170/// extent to absorb, so `extent[i]` carries it; `None` means "this store has not
171/// been told about ordinal `i`", which is not the same as "not absorbed" and must
172/// not be counted as work.
173///
174/// **Why `absorbed` is a separate fact from `extent`.** The ack path does two
175/// things in this order: record the pack pending, then hand its extent to the
176/// account's channel. The indexer's worker is a different thread and can reach
177/// `absorb` *before* the first of those returns. With only a pending list, that
178/// race ends in a bit that is set after the rows are already in and is never
179/// cleared, so every later read pays a pointless fallback for the life of the
180/// process. The bit is what the two writers agree on: [`PackState::note`] will
181/// not queue a pack that is already done, and `absorb` will not do the work
182/// twice.
183///
184/// Touched only under short critical sections — never across an absorb, which is
185/// what the separate [`Absorber::gate`] is for. **The ack path must never block
186/// behind index work.**
187#[derive(Default)]
188struct PackState {
189 /// One bit per pack ordinal, 64 to a word. `1` = its rows are in the index.
190 words: Vec<u64>,
191 /// The extent of each known ordinal, so a `0` bit can be acted on.
192 extent: Vec<Option<Extent>>,
193 /// Known ordinals whose bit is `0` — what [`GitStore::unindexed_packs`]
194 /// reports, kept as a count so the read path's check is a field load rather
195 /// than a scan.
196 unabsorbed: usize,
197}
198
199impl PackState {
200 /// The bit.
201 fn is_absorbed(&self, pack_id: u64) -> bool {
202 let i = pack_id as usize;
203 self.words
204 .get(i / 64)
205 .is_some_and(|w| w >> (i % 64) & 1 == 1)
206 }
207
208 /// Record a durable pack whose rows are not in yet. The bit **going clear**.
209 ///
210 /// **Idempotent, and the extent slot is the single thing that makes it so.**
211 /// A second `note` for an ordinal that already has one — the ack path
212 /// arriving after the drain has already absorbed the pack, or a re-queue on
213 /// open racing the same pack's push — finds the slot filled and counts no new
214 /// work. [`PackState::mark_absorbed`] fills that same slot, so a pack that is
215 /// already done cannot be queued behind its own completion, and there is no
216 /// second condition here that could disagree with the first.
217 fn note(&mut self, pack_id: u64, extent: Extent) {
218 let i = pack_id as usize;
219 self.grow_to(i);
220 if self.extent[i].is_none() {
221 self.extent[i] = Some(extent);
222 self.unabsorbed += 1;
223 }
224 }
225
226 /// Room for ordinal `i` in both arrays. Dense ordinals are what makes this a
227 /// `resize` and not an insert.
228 fn grow_to(&mut self, i: usize) {
229 if self.words.len() <= i / 64 {
230 self.words.resize(i / 64 + 1, 0);
231 }
232 if self.extent.len() <= i {
233 self.extent.resize(i + 1, None);
234 }
235 }
236
237 /// The bit **going up**: this pack's rows are in the index.
238 fn mark_absorbed(&mut self, pack_id: u64, extent: Extent) {
239 let i = pack_id as usize;
240 self.grow_to(i);
241 if self.words[i / 64] >> (i % 64) & 1 == 0 {
242 self.words[i / 64] |= 1 << (i % 64);
243 if self.extent[i].is_some() {
244 self.unabsorbed -= 1;
245 }
246 }
247 self.extent[i] = Some(extent);
248 }
249
250 /// Every known pack whose bit is clear, in ordinal order.
251 fn pending(&self) -> Vec<PendingPack> {
252 self.extent
253 .iter()
254 .enumerate()
255 .filter(|(i, e)| e.is_some() && !self.is_absorbed(*i as u64))
256 .map(|(i, e)| {
257 let (offset, len) = e.expect("filtered on Some");
258 PendingPack {
259 pack_id: i as u64,
260 offset,
261 len,
262 resumed: true,
263 }
264 })
265 .collect()
266 }
267}
268
269/// The derived tables: the commit graph, the tree payloads the reachability
270/// bitmaps are built from, and this store's own ordinal space.
271///
272/// **The ordinal space is this struct's, not the projection's.** An
273/// [`crate::index_layout::IndexRow::ordinal`] is a row address inside one
274/// projection generation and is re-derived by every rebuild, so a bitmap built
275/// over projection ordinals would silently address different objects after any
276/// rebuild. The bitmaps here are over `ordinal`, which is rebuilt in the same
277/// fold that rebuilds them — the two cannot drift because one call produces both.
278/// **Nothing in here is a source of truth.** Every field is folded from the
279/// `objects` table and §14's exploded table by [`Absorber::refold`], and both of
280/// those are on disk — which is what makes a clean reopen come back with the
281/// same graph it shut down with. Before the exploded table existed, `graph` and
282/// `trees` were *accumulated* here as packs were absorbed and stored nowhere, so
283/// a clean shutdown lost them silently: MEASURED on oden 2026-08-08, a reopened
284/// store over a fully absorbed 2687-object pack had all 2687 rows and **0 of 551
285/// commits**, with `reachable()` returning a commit alone instead of its closure
286/// and `gc` seeing an empty live set.
287#[derive(Default)]
288struct Derived {
289 /// Parents-before-children, generations assigned. Folded from the exploded
290 /// table's commit payloads.
291 graph: Vec<CommitNode>,
292 // **`trees` is GONE (lane Q, 2026-08-30).** It held every tree payload in
293 // the repository, resident, keyed by a hex `String`, and was rebuilt from
294 // the exploded table on every fold. MEASURED on the real `torvalds/linux`
295 // mirror: 28.24 GB of tree payloads, 3.24× the 8.13 GiB pack, kept eagerly
296 // on disk so this map could be rebuilt into a 50.9 GiB RSS — on a box that
297 // ships with 16 GB. `crate::reach::TreeSource` replaced it with a lookup
298 // ([`Absorber::tree_source`]), so a tree is read the way every other object
299 // is: from the cache if it is there, from its own delta chain in the
300 // mmapped pack if it is not.
301 /// **The ordinal space, and the ONLY copy of it: every distinct oid in the
302 /// store, raw, fixed-width, back to back, in oid-lexicographic order.**
303 ///
304 /// Ordinal `o` is the slice `oids_raw[o * oid_len .. (o + 1) * oid_len]`, and
305 /// because the buffer is **sorted** the inverse (oid → ordinal) is a binary
306 /// search over it — [`crate::reach::OrdinalSpace`] is that pair of lookups
307 /// and owns nothing but a borrow of this field.
308 ///
309 /// # Why this is now the only representation
310 ///
311 /// It used to be one of THREE. `refold` also built `oids: Vec<String>` (the
312 /// same list, hex) and `ordinal: HashMap<String, u32>` (the inverse, hex
313 /// keys) — a 40-byte hex `String` per oid in the vector, a second as each
314 /// map key, plus 20 raw bytes here. MEASURED, lane MEMORY, oden 2026-08-31
315 /// (`examples/rss_per_open_store`): a cached open store cost **382 bytes of
316 /// live RSS per indexed object** on a blob-only corpus and **744–966 B** on
317 /// the two real repository packs — about half of it that pair. And it was
318 /// paid twice at every fold: REFOLD measured the hex `Vec` at ~0.13 s and
319 /// the `HashMap` at ~0.08 s of a 136k-object reopen, ~0.21 s spent turning
320 /// bytes the tail already held into `String`-keyed tables.
321 ///
322 /// The flat buffer already answered both questions — a slice and a binary
323 /// search — so the two `String`-per-oid tables were LAW 5's exact shape: a
324 /// second and third spelling of one list that a comment had to *promise*
325 /// agreed. They are gone; the serve path reads oid ⇄ ordinal straight off
326 /// this buffer. See `gunnar/.nornir/stinky.md` S-082.
327 ///
328 /// # Why raw rather than hex
329 ///
330 /// Because every *serving* answer is built out of raw bytes.
331 /// `reachable_raw` answers in oid bytes and each object is a
332 /// `copy_from_slice` of a slice of this buffer — nothing is encoded,
333 /// decoded or allocated per object. `reachable_oids` (the maintenance path)
334 /// encodes on the way out, at one `String` per object, and nothing on the
335 /// serve path calls it. The tail hands oids in oid order, which over
336 /// fixed-width oids is byte order, so this is already the sorted
337 /// concatenation with no sort of its own — see [`Absorber::refold`].
338 oids_raw: Vec<u8>,
339 /// The bitmaps, or empty if nothing has needed them since the last fold.
340 ///
341 /// **Behind an `Arc` since 2026-08-14, and that is a measurement and not a
342 /// tidy-up.** [`Absorber::reach_bitmaps`] used to hand out `d.reach.clone()`
343 /// — a deep copy of every commit's `RoaringBitmap` plus its oid `String` —
344 /// and `crate::serve::GitServe::select` calls
345 /// [`GitStore::reachable_oids`] **twice** per request (once for `want`, once
346 /// to close over `have`). MEASURED on oden with `stage-probe`, the
347 /// znippy-served `nornir` mirror (12 455 objects), a 4-object negotiated
348 /// fetch: the `select.bitmap` stage was **75.2 % of the request's CPU** and
349 /// **645 876 allocations**; at four requests sharing one warm store it was
350 /// still 62 762 allocations *per request*. None of that copying is work the
351 /// answer depends on — the table is immutable between folds — so the `Arc`
352 /// removes it rather than dividing it across cores.
353 reach: Arc<Vec<ReachEntry>>,
354 /// Every commit's oid as **raw bytes**, the form
355 /// [`crate::serve::GitServe::select`] tests a `want` against.
356 ///
357 /// `None` means a graph row's oid did not parse as hex, which `select`
358 /// answers by declining the whole request. That check is why this is
359 /// `Option` rather than a plain set: it used to run **per request** —
360 /// `graph_snapshot()` cloned the whole `Vec<CommitNode>` and then
361 /// `hex::decode`d every commit into a fresh `Vec<u8>` — and the answer
362 /// cannot change between folds, so it is folded once here and borrowed
363 /// after. The refusal is preserved exactly; only the arithmetic moved.
364 commit_raw: Option<Arc<std::collections::HashSet<Vec<u8>>>>,
365 /// **hex oid → index into [`Derived::graph`].** The graph-by-oid lookup
366 /// [`crate::reach::accumulate`]'s walk needs, folded once by the same call
367 /// that folds `graph` and `commit_raw` rather than rebuilt on every
368 /// negotiation. `reachable` used to `d.graph.iter().map(...).collect()` a
369 /// `HashMap<&str,&CommitNode>` per call — O(commits) per fetch, on every
370 /// fetch and clone — for a table that cannot change between folds. MEASURED
371 /// on oden 2026-09-01 (`bench_reachable_negotiation`, a 20 000-commit linear
372 /// history): a negotiation over a one-object closure spent **895 µs**
373 /// building this map and the reach one below, work the answer never used.
374 /// It is keyed by hex, not raw, because the walk keys by hex — parents and
375 /// tree oids in a [`CommitNode`] are hex — so a raw key would force a decode
376 /// per walked edge to save the O(w+h) tip encode, a bad trade at any size.
377 graph_index: HashMap<String, u32>,
378 /// **hex commit oid → index into the [`Derived::reach`] table**, built by
379 /// the same call that builds `reach` and cleared with it, so the pair is
380 /// always in step. Replaces the per-call `HashMap<&str,&RoaringBitmap>`
381 /// `reachable` rebuilt over every bitmap on every request. Behind an `Arc`
382 /// for the same reason `reach` is: it is handed to the negotiation with a
383 /// refcount bump, never a copy.
384 reach_index: Arc<HashMap<String, u32>>,
385 /// How many commits the graph held when [`Derived::reach`] was last built
386 /// from scratch — the denominator of the carry rule in
387 /// [`Absorber::refold`]. Bitmaps carried across a fold are exact for the
388 /// commits they cover, but every commit added since is served by walking
389 /// down to the nearest carried one, so once the additions outgrow
390 /// [`REACH_CARRY_MAX`] of this the next reader rebuilds the table whole.
391 reach_full_len: usize,
392 /// Verbatim packs, so any absorbed object's content can be re-derived from
393 /// the truth on demand. `(archive offset, len)`.
394 packs: Vec<(u64, u64)>,
395}
396
397/// **The carry rule's ceiling**: a fold carries the reachability bitmaps
398/// across when the graph has grown by at most this fraction of the commits the
399/// last full build covered (and never fewer than 64 commits' worth). Beyond it
400/// the table is rebuilt from scratch on the next read — which is what every
401/// fold used to do, unconditionally.
402///
403/// MEASURED 2026-09-05 on oden (`gunnar serve`, a 10 000-commit / 51 023-object
404/// repository over ssh): the FIRST clone after any push took 10.2 s and the next
405/// 1.3 s, and after one more 4-object push the pattern repeated (10.9 s, then
406/// 1.0 s). The fold had dropped `Derived::reach` and the next `reachable`
407/// rebuilt every commit's tree closure — 0.2 ms per object of server CPU for a
408/// push that changed nothing about any existing commit's reachability. A bitmap
409/// is a fact about an immutable commit; only its ordinal numbering moves when
410/// the sorted oid space grows, and a monotone remap costs one pass over the
411/// bits. Sized at a tenth so the amortised rebuild stays bounded by the pushes
412/// that earned it, like the persisted index's own fold threshold.
413///
414/// MEASURED AGAIN with the carry in place, same box, same repository, same
415/// sequence (seed push, clone, clone, 4-object push, clone, clone): 10.5 s,
416/// 1.15 s, then **1.12 s** and 1.15 s. The server logged the fold carrying all
417/// 501 sampled entries, and the one 9.3 s build from scratch is the first
418/// clone's, which no carry can serve. `reach_source_stats` is the same fact for
419/// a test to assert.
420pub(crate) const REACH_CARRY_MAX_FRACTION: usize = 10;
421/// The floor under the rule, in commits: a repository small enough that a tenth
422/// of it is a handful still carries across pushes of up to this many commits.
423pub(crate) const REACH_CARRY_MIN_COMMITS: usize = 64;
424
425/// **The object-level index, and the one thing that writes into it.**
426///
427/// Its own allocation rather than a field group inside [`GitStore`], and §13.9-12
428/// is the only reason: the drain runs on the account indexer's worker thread, so
429/// whatever it absorbs into cannot be reachable solely through a `&GitStore`.
430/// Splitting it out is what lets the background worker and a falling-back read
431/// call **the same** absorb instead of two copies of it (LAW 5) — the alternative
432/// was a second implementation on the worker side, which is precisely the
433/// twinning that law forbids.
434///
435/// It is a **leaf**: nothing in here points back at the store, so the worker's
436/// `Arc` closes no cycle and the store still drops (and joins its worker)
437/// normally.
438/// Entries below which [`GitStore::resolve_emit_payloads`] does **not** fan out.
439///
440/// A `std::thread::scope` spawn is ~10–20 µs a worker and the per-entry work it
441/// would divide is a bounds check plus a varint; a 100-object fetch would pay
442/// four spawns to save four microseconds of parsing. The threshold is what keeps
443/// `crate::serve`'s "one core's worth per transfer" true for every request that
444/// is not a bulk clone — and a bulk clone is the only request the copy this
445/// replaces was ever measured on.
446const FAN_OUT_AT: usize = 4096;
447
448/// The folded commit graph, cached beside the verbatim pack so a reopen *reads*
449/// it instead of re-deriving it from every commit payload (S-065).
450const GRAPH_CACHE_FILE: &str = "objects.graph";
451/// `objects.graph` framing: 4-byte magic + 1-byte version + 32-byte token, then
452/// the Arrow IPC commit graph.
453const GRAPH_CACHE_MAGIC: &[u8; 4] = b"GRPH";
454const GRAPH_CACHE_HEADER: usize = 4 + 1 + 32;
455
456/// **`objects.ordinal` is no longer written, and an existing one is removed at
457/// open.** It was S-082's memo of the ordinal space — every oid in sorted order,
458/// with a `(epoch, count)` header validated against the redb tail — so that a
459/// cold open could *read* the space instead of scanning the whole redb tail to
460/// rebuild it. Since 2026-09-04 the read stack persists its projection
461/// (`objects.index`) and the sorted oid list IS that index's oid column, mapped;
462/// [`ObjectReadStack::oids_raw`] hands it back with a merge of the few redb rows
463/// since the last fold. The scan the memo spared no longer exists, and a second
464/// file carrying the same bytes under a bespoke header is exactly the kind of
465/// file this store should not have. On the kernel mirror it was 278 964 902 B —
466/// 20.0 B/object, the oid column to the byte. The name is kept only so the
467/// stale file can be found and deleted.
468const ORDINAL_CACHE_FILE: &str = "objects.ordinal";
469
470/// The validity token for a persisted commit graph: blake3 over the sorted raw
471/// oids of **every** object in the store.
472///
473/// It is both necessary and sufficient. The graph is a pure, deterministic
474/// function of the commit payloads, which are content-addressed by their oids,
475/// so an identical object set yields a byte-identical graph — and this hashes
476/// the whole object set, in the one order `refold` already sorts it into, with
477/// no read the fold did not already make. A mismatch (any push, any gc) forces a
478/// recompute; a 256-bit blake3 makes an accidental match of two different object
479/// sets not a case worth engineering against.
480/// **`seen − live`: what a GC may drop.** `seen` is every oid the index held
481/// when the GC started (`oids_in_order`), `live` the reachable set computed
482/// after it. The difference is the dead set, and it is a POSITIVE set on
483/// purpose: `retain(|o| live.contains(o))` would also drop every row that
484/// arrived between the snapshot and the drop — a push in flight, whose refs
485/// are not updated yet — because to `live` those are simply unknown. A row in
486/// neither set is kept. `live` is hex, `seen` raw; the decode happens once
487/// here rather than once per row in the retain predicate.
488pub(crate) fn dead_oids(
489 seen: Vec<Vec<u8>>,
490 live: &std::collections::HashSet<String>,
491) -> std::collections::HashSet<Vec<u8>> {
492 let live_raw: std::collections::HashSet<Vec<u8>> =
493 live.iter().filter_map(|h| hex::decode(h).ok()).collect();
494 seen.into_iter().filter(|o| !live_raw.contains(o)).collect()
495}
496
497fn graph_token(oids_raw: &[u8]) -> [u8; 32] {
498 let mut h = znippy_common::blake3::Hasher::new();
499 h.update(oids_raw);
500 *h.finalize().as_bytes()
501}
502
503/// Commits that get a reachability bitmap on the **live** selection path.
504///
505/// # It was `usize::MAX`, and that was the single most expensive line in a fetch
506///
507/// The comment that stood here said a sampled table *"is for the sealed archive
508/// where the cost is disk"* and that every commit must be bitmapped on the live
509/// path. That was not a preference, it was forced:
510/// [`GitStore::reachable_oids`] had no walk, so a `want` with no bitmap could
511/// only contribute itself — a silent under-send — and `crate::serve`'s `select`
512/// therefore had to refuse unless *"in the graph"* and *"has a bitmap"* were the
513/// same fact.
514///
515/// MEASURED on oden 2026-08-14, one 4-object negotiated fetch out of the
516/// znippy-served `nornir` mirror (1 581 commits, 12 455 objects): the
517/// `select.bitmap` stage was **75 % of the request's CPU**, and **530 218 of its
518/// 575 349 allocations were this build** — which `refold` throws away again on
519/// the next push. The gix arm answered the identical fetch in 6.8 ms because it
520/// *reads* a `.bitmap` instead of building one.
521///
522/// [`crate::reach::accumulate`] is the walk that makes the cap legal, and 512 is
523/// the number [`crate::reach::ReachPolicy::default`] already uses for the sealed
524/// archive — the same figure git's own bitmap selection is of the order of, and
525/// deliberately not a second, different constant to keep in step.
526const LIVE_REACH_COMMITS: usize = 512;
527
528/// [`LIVE_REACH_COMMITS`], or `ZNIPPY_GIT_REACH_COMMITS`.
529///
530/// **An operator knob, not an arm.** It selects no implementation and changes no
531/// byte of any answer: the walk covers whatever the table does not, so the cap
532/// trades build cost against walk cost and nothing else. That property is the
533/// whole subject of
534/// `the_bounded_walk_answers_exactly_what_a_full_bitmap_table_answers`, which
535/// drives this very knob to its two extremes over one store.
536///
537/// Read **once per process** through [`crate::arms::read_env`], so it is
538/// counted with every other environment read this crate makes, and so a
539/// reachability request does not cost a `getenv` — until 2026-08-21 it did,
540/// once per `reach_bitmaps`/`reachable_oids` call, uncounted.
541fn live_reach_policy() -> crate::reach::ReachPolicy {
542 static MAX: std::sync::OnceLock<usize> = std::sync::OnceLock::new();
543 let max_commits = *MAX.get_or_init(|| {
544 crate::arms::read_env(crate::arms::ENV_REACH_COMMITS)
545 .and_then(|v| v.parse::<usize>().ok())
546 .unwrap_or(LIVE_REACH_COMMITS)
547 });
548 crate::reach::ReachPolicy { max_commits }
549}
550
551/// Ceiling on phase-1 workers **per request**.
552///
553/// The serving tier admits ~32 concurrent transfers, and the fan-out primitive
554/// has no reentrancy detection, so an uncapped `gatling_for_each` here is
555/// 32 × ncores threads on a 128-core box. Four is a bound that leaves the
556/// admission gate in charge of the machine.
557const MAX_RESOLVE_WORKERS: usize = 4;
558
559/// Workers for phase 1: [`MAX_RESOLVE_WORKERS`], or `ZNIPPY_GIT_EMIT_WORKERS`.
560///
561/// **An operator knob, not an arm.** It selects no implementation and changes no
562/// byte of the emitted pack — a pack emitted at one worker and at sixteen is
563/// byte-identical, because phase 1 only decides *where each entry's bytes are*
564/// and phase 2 writes them in one serial order either way. `0` is read as "as
565/// many as this box has cores", which is `gatling_for_each`'s own convention.
566///
567/// Read **once per process** through [`crate::arms::read_env`] — see
568/// [`live_reach_policy`] for why; this one was a `getenv` per emitted request
569/// until 2026-08-21.
570fn emit_workers() -> usize {
571 static WORKERS: std::sync::OnceLock<usize> = std::sync::OnceLock::new();
572 *WORKERS.get_or_init(|| {
573 crate::arms::read_env(crate::arms::ENV_EMIT_WORKERS)
574 .and_then(|v| v.parse::<usize>().ok())
575 .unwrap_or(MAX_RESOLVE_WORKERS)
576 })
577}
578
579pub(crate) struct Absorber<S: ObjectIndex = OneTableFourColumns> {
580 blobs: PathBuf,
581 /// Read handle on the verbatim packs, for `pread` of an extent.
582 ///
583 /// The **fallback**, since 2026-08-14, not the ordinary path: `map` below
584 /// answers every extent the mapping covers, and this reads the ones past its
585 /// end (a push that landed after the snapshot was taken).
586 ///
587 /// **It is the writer's own open file description** (2026-08-30, lane AH),
588 /// not a second `File::open`: this reads with `pread` at an explicit offset
589 /// and shares no cursor with `append`, so a private descriptor bought a
590 /// kernel object and a page-cache alias per open repository and no
591 /// isolation. See [`crate::archive_write::open_blobs`] and
592 /// `tests/fd_per_store.rs`.
593 reader: Arc<File>,
594 /// The same file, mapped read-only. See [`crate::archive_map`] for why an
595 /// append-only file `gc` never rewrites is safe to map, and for the ~20 % of
596 /// serve cycles the `pread`-per-object shape was spending on copies.
597 map: crate::archive_map::ArchiveMap,
598 hash: GitHashKind,
599 /// The `objects` table: stree → Arrow → redb tail.
600 ///
601 /// `S` is the payload layout the projection is built in
602 /// ([`crate::arms::IndexArm`]) and it is a **type parameter, not a field**:
603 /// this is the hot path, every lookup goes through it, and the whole reason
604 /// the arms exist is to measure the differences between them. A `dyn` here
605 /// would put a virtual call on every single oid.
606 objects: ObjectReadStack<S>,
607 /// **§14's exploded objects table** — oid → resolved type and content, built
608 /// eagerly by this absorb and by nothing else.
609 ///
610 /// Beside the `objects` table rather than inside it because the two have
611 /// different lifetimes: `objects` is the index and losing it loses the
612 /// repository's addressing, while this one is derived, verifiable against the
613 /// verbatim bytes and deletable at any time. They are separate files so that
614 /// "droppable" is a `rm`, not a schema migration.
615 ///
616 /// SWAPPED 2026-08-13 from the redb `ExplodedTable` to **one Arrow IPC
617 /// table**, payload in the row. redb held 16.8 GB of kernel payload in a
618 /// 204 GB file — 12× — and serialised the gatling fan-out behind its one
619 /// writer at 96.8% of a single core. See [`crate::exploded_arrow`].
620 ///
621 /// **BUDGETED AND EVICTABLE since lane Q (2026-08-30)**: the two-pool
622 /// [`ExplodedCache`] — the indexer's eager pool (commits and tags) beside a
623 /// lazy pool the FIRST reader of a blob or tree fills and a byte budget
624 /// empties. The unbounded eager tier it replaces MEASURED **141.7 GiB** for
625 /// the 8.12 GiB `torvalds/linux` pack on the rig, 17× the pack, which is
626 /// more than one appliance holds for all its repositories together.
627 exploded: Arc<ExplodedCache>,
628 derived: RwLock<Derived>,
629 /// How many folds since open read the persisted commit graph off disk vs
630 /// recomputed it from the exploded table. Counters, not clocks — the only
631 /// thing that can say which path a fold took (LAW 2). See
632 /// [`Absorber::graph_source_stats`].
633 graph_read: std::sync::atomic::AtomicU64,
634 graph_recomputed: std::sync::atomic::AtomicU64,
635 /// **Is `objects.graph` read and written at all** ([`crate::arms::ENV_GRAPH_CACHE`],
636 /// read once at open). `false` folds from the exploded table every time and
637 /// leaves no file: a store that serves no reads holds no derived memo.
638 graph_cache: std::sync::atomic::AtomicBool,
639 /// How many folds CARRIED the reachability table across (renumbered, no
640 /// tree opened) vs how many reads had to build it from scratch. The only
641 /// witness that the carry ran — the bytes a carried and a rebuilt table
642 /// answer with are identical by construction (LAW 2). See
643 /// [`Absorber::reach_source_stats`].
644 reach_carried: std::sync::atomic::AtomicU64,
645 reach_rebuilt: std::sync::atomic::AtomicU64,
646 /// Where the last fold's **ordinal space** came from: how many oids straight
647 /// off the persisted index's column, how many off a scan of the redb tail.
648 /// The same shape as [`Self::graph_read`]/[`Self::graph_recomputed`], and for
649 /// the same reason: which source produced the space is not visible in the
650 /// (identical) bytes, only in a counter (LAW 2). See
651 /// [`Absorber::ordinal_source_stats`].
652 ordinal_folded: std::sync::atomic::AtomicU64,
653 ordinal_tail: std::sync::atomic::AtomicU64,
654 packs: Mutex<PackState>,
655 /// Serialises **absorption**, which is long. Held across a whole pack.
656 ///
657 /// Two absorbs of one pack are duplicated *work* and nothing worse: every
658 /// writer under it is keyed by oid — [`ObjectReadStack::append`] swallows an
659 /// identical second row, the exploded table overwrites its own key, and the
660 /// commit graph is folded from that table rather than pushed at, so it cannot
661 /// double. (It could before §14's table existed, when the graph was a `Vec`
662 /// accumulated per absorb; that is why this paragraph used to say the gate
663 /// was load-bearing for correctness and now does not.) The gate is still what
664 /// makes the ordering below hold: **the rows go in, and only then is the bit
665 /// cleared**, so a read either finds the bit still clear (and waits here) or
666 /// finds the rows. Neither order can produce "absent".
667 gate: Mutex<()>,
668 /// **The progress counter** ([`crate::progress`]) a dashboard or a stats
669 /// call reads. One per store, registered process-wide.
670 progress: Arc<crate::progress::IndexProgress>,
671 /// Set by [`GitStore::cancel_index`]: the repository is being deleted. The
672 /// resolver checks it every few thousand objects and aborts the pack; the
673 /// drain skips every pack still queued.
674 cancel: std::sync::atomic::AtomicBool,
675 /// Names the store in log lines: its root directory.
676 label: String,
677 /// The memory watchdog this store's worker pauses on. The process-wide one
678 /// unless a test hands in a fake ([`GitStore::set_mem_watchdog`]).
679 watchdog: RwLock<Arc<crate::memguard::MemWatchdog>>,
680 /// **Pending packs a reader has already scanned**, keyed by pack offset:
681 /// the walk and an oid-sorted row table, built by ONE read-only pass and
682 /// kept until the pack is absorbed. Every later lookup into that pack is
683 /// a binary search; a content read inflates one chain. Without this,
684 /// every `has` during the index window re-resolved the whole pack —
685 /// MEASURED on the rig 2026-08-30: a `push --mirror` of linux stalled
686 /// pre-ack, ~800 ref updates × one 8 GiB resolve each.
687 scanned: Mutex<HashMap<u64, Arc<ScannedPack>>>,
688 /// One scan build at a time: a second reader waits for the first reader's
689 /// pass rather than starting its own. That is waiting on a *reader*, not
690 /// on the indexer.
691 scan_build: Mutex<()>,
692 /// **Packs this store has stopped trying to index**, by ordinal, with how
693 /// many attempts it took to stop and the reason the last one gave.
694 ///
695 /// 🔴 The state this replaces was *no state*. A pack whose absorb failed
696 /// stayed pending, every absorb loop hit it FIRST (they run in ordinal
697 /// order) and aborted on it with `?`, so the packs behind it were never
698 /// reached — and the next push, and the one after that, re-did the same
699 /// doomed resolve and was refused for it. MEASURED on oden 2026-08-30
700 /// (lane AI): one pack that could not be absorbed refused **every** push to
701 /// that repository from then on, 21 of 140, and lane AD's standby re-asked
702 /// for it every 300 s for 21 minutes. Work that cannot succeed has to stop
703 /// and say why; see [`MAX_ABSORB_ATTEMPTS`] and [`Absorber::absorb_each`].
704 unindexable: Mutex<HashMap<u64, Unindexable>>,
705}
706
707/// A pack this store will not try to index again, and why.
708#[derive(Debug, Clone)]
709pub struct Unindexable {
710 /// The pack's ordinal.
711 pub pack_id: u64,
712 /// Its extent in the verbatim archive. The bytes are still there.
713 pub extent: Extent,
714 /// How many absorbs were spent before it stopped.
715 pub attempts: u32,
716 /// The last attempt's root cause — the backend's own sentence, which is
717 /// what a client and an operator both get told.
718 pub reason: String,
719}
720
721/// How many times one pack's absorb is attempted before the store stops.
722///
723/// Three, and the reason it is not one: an absorb can fail for a reason outside
724/// the pack — the memory watchdog gave up, the repository was being deleted, a
725/// transient read error — and a single bad moment must not condemn durable
726/// bytes. It is not thirty either, because the resolve is deterministic in the
727/// store's own state: a pack that failed three times with nothing else changing
728/// fails the fourth time for the same reason, and every one of those attempts
729/// is paid for by a client waiting on a push.
730pub const MAX_ABSORB_ATTEMPTS: u32 = 3;
731
732// **The pack this thread is inside an absorb of**, if any.
733//
734// `absorb_gated` holds `Absorber::gate` for the whole pack, and the resolver it
735// runs asks this very store for delta bases through `BaseSource::content`. That
736// re-entry must not take the gate again — a `std::sync::Mutex` is not
737// reentrant, so it would not be a wait, it would be a deadlock — and it must
738// not treat the pack it is halfway through as something it can absorb. One
739// `Cell` answers both questions, and it is the same guard shape
740// `scan_pending`'s `SCANNING` uses for the same reason.
741thread_local! {
742 static IN_ABSORB: std::cell::Cell<Option<u64>> = const { std::cell::Cell::new(None) };
743}
744
745/// Sets [`IN_ABSORB`] for the duration of one absorb and restores whatever was
746/// there before — absorbs nest (a pack whose base is in another pending pack).
747struct InAbsorb(Option<u64>);
748
749impl InAbsorb {
750 fn enter(pack_id: u64) -> Self {
751 InAbsorb(IN_ABSORB.with(|c| c.replace(Some(pack_id))))
752 }
753}
754
755impl Drop for InAbsorb {
756 fn drop(&mut self) {
757 IN_ABSORB.with(|c| c.set(self.0));
758 }
759}
760
761/// One pending pack, scanned read-only: what a lookup needs and nothing that
762/// the index will hold. O(objects) memory — for linux ~56 B of walk + 32 B of
763/// row per object, ~1.2 GB — and gone when the pack's bit goes up.
764///
765/// **Nothing on the production read path builds one of these any more.** A
766/// reader that needs an un-indexed pack indexes it instead
767/// ([`Absorber::index_pending_now`]); this remains for the one caller that
768/// cannot — a resolver already inside `absorb_gated`, which may consult a scan
769/// somebody else already built but must never start one.
770struct ScannedPack {
771 walk: crate::pack_walk::PackWalk,
772 /// `(oid, entry index, resolved size)`, sorted by oid.
773 rows: Vec<(Vec<u8>, u32, u64)>,
774 archive_offset: u64,
775}
776
777impl ScannedPack {
778 fn find(&self, oid: &[u8]) -> Option<(usize, u64)> {
779 self.rows
780 .binary_search_by(|(o, _, _)| o.as_slice().cmp(oid))
781 .ok()
782 .map(|i| (self.rows[i].1 as usize, self.rows[i].2))
783 }
784
785 fn row(&self, oid: &[u8]) -> Option<crate::index_layout::IndexRow> {
786 let (entry, size) = self.find(oid)?;
787 let e = &self.walk.entries[entry];
788 Some(crate::index_layout::IndexRow {
789 // Not ranked: the row is not in the index yet.
790 ordinal: u32::MAX,
791 offset: e.offset + self.archive_offset,
792 len: e.len,
793 obj_type: e.obj_type,
794 uncompressed_size: size,
795 delta_base: match &e.delta_base {
796 crate::pack_walk::DeltaBase::Offset(o) => o + self.archive_offset,
797 _ => 0,
798 },
799 })
800 }
801}
802
803/// One repository's git store.
804///
805/// | on disk | what it is | who owns the format |
806/// |---|---|---|
807/// | `<root>/objects.pack` | the verbatim pack bytes, appended | [`SafeWriter`] |
808/// | `<root>/objects.pack.journal` | the durable extent rows | [`SafeWriter`] |
809/// | `<root>/objects.tail` | the un-sealed index tail | [`ObjectReadStack`] (redb) |
810/// | `<root>/objects.exploded` | §14's resolved content, **droppable** | [`ExplodedArchive`] (one Arrow IPC table) |
811/// | `<root>/refs.log` | the ref transaction log | [`RefLog`] (Arrow IPC frames) |
812/// | `<root>/<name>.znippy` | the sealed archive GC compacts | base znippy |
813///
814/// Nothing in that table is new. The store is the composition, not a fifth
815/// format.
816/// # Which implementation of each trait, and how a caller picks
817///
818/// Three of the four boxes in the diagram at the top of this file have more than
819/// one implementation. [`StoreConfig`] is the choice, [`crate::arms`] documents
820/// what each arm promises, and the dispatch is split deliberately:
821///
822/// | trait | selected by | dispatch | cost |
823/// |---|---|---|---|
824/// | [`ObjectIndex`] | the type parameter `S` | **static** | none — the hot path is monomorphised |
825/// | [`ArchiveWrite`](crate::archive_write::ArchiveWrite) | [`StoreConfig::writer`] | `dyn`, inside [`PushPath`] as it already was | one virtual call **per pack append**, not per object |
826/// | [`Gc`] | [`StoreConfig::gc`] | `dyn` | one virtual call per `gc()` run |
827///
828/// `S` defaults to [`OneTableFourColumns`], so `GitStore` still names exactly
829/// what it named before and every existing caller compiles unchanged.
830pub struct GitStore<S: ObjectIndex = OneTableFourColumns> {
831 root: PathBuf,
832 /// The verbatim pack bytes. The **truth** (§14).
833 blobs: PathBuf,
834 /// The sealed znippy archive `gc` compacts. Only GC and `seal` touch it.
835 archive: PathBuf,
836 /// The selected [`ArchiveWrite`](crate::archive_write::ArchiveWrite) arm
837 /// plus the per-account index channel. The ack path.
838 push: PushPath,
839 account: String,
840 hash: GitHashKind,
841 /// The object-level index and the absorb behind it — **shared with the
842 /// account indexer's worker**, which is how a push ends in object rows
843 /// without a read having to ask for them.
844 absorber: Arc<Absorber<S>>,
845 refs: RefLog,
846 /// Serialises the ref log's read-compare-append. A CAS that read the
847 /// namespace, then appended, without holding this could be overtaken between
848 /// the two and would overwrite the update it did not see.
849 ref_gate: Mutex<()>,
850 /// The selected [`Gc`] arm. Built once, here, and run by
851 /// [`GitOps::gc`] — a `Box<dyn>` because a GC is a whole-archive
852 /// compaction that happens on a maintenance timer, so one virtual call
853 /// against it is unmeasurable and a third type parameter on every signature
854 /// in the crate is not free to read.
855 gc: Box<dyn Gc + Send + Sync>,
856 /// What this store was built with, for a bench row or a config dump. A
857 /// description of the arms already constructed — **nothing consults it on a
858 /// serving path**.
859 arms: StoreConfig,
860}
861
862impl GitStore<OneTableFourColumns> {
863 /// Open (creating) the store for one repository under `root`.
864 ///
865 /// **The default arms, and it reads no environment to get them.** An
866 /// operator who exported `ZNIPPY_GIT_WRITER=fast` does not change what this
867 /// builds — a caller that never asked for a selector must not have its
868 /// durability contract moved out from under it. Use
869 /// [`open_from_env`] when the selection is wanted.
870 ///
871 /// ⚠ One variable *is* read here, and it is not an arm:
872 /// `ZNIPPY_GIT_REDB_CACHE_BYTES` (see
873 /// [`crate::arms::redb_cache_bytes`]). It selects no implementation,
874 /// changes no durability contract and leaves the bytes on disk identical —
875 /// it caps redb's page cache, whose own default is 1 GiB *per database*, of
876 /// which this store opens two. The sentence above is about arms, and a
877 /// memory ceiling is not one.
878 pub fn open(root: &Path, account: &str) -> Result<Self> {
879 Self::open_with(root, account, GitHashKind::Sha1)
880 }
881
882 /// Same, with an explicit oid width. sha256 repositories exist and the store
883 /// does not get to assume otherwise; every oid it stores is
884 /// [`GitHashKind::oid_len`] bytes wide and the tail refuses a mixed batch.
885 ///
886 /// # What a reopen recovers, and why nothing had to be stored for it
887 ///
888 /// A store opened over an `objects.pack` some earlier process was still
889 /// indexing has to end up in the same state that process would have reached.
890 /// §13.12's `indexed` bit is what says so, and it is **derived here rather
891 /// than persisted**: a pack is unabsorbed *iff* its extent is in the journal
892 /// and its rows are not in the index, and both of those are already durable
893 /// (see [`Absorber::adopt_journal`]). The packs that come back clear are put
894 /// straight onto the account's channel, so the drain finishes the interrupted
895 /// work with no read having to ask — and until it does, every read falls back
896 /// exactly as it would have before the crash. **Slower, never wrong**, across
897 /// a restart as well as within one.
898 ///
899 /// The bits are set **before** the channel is fed, which is the same ordering
900 /// the ack path uses for the same reason: a read that arrives in between finds
901 /// the bit clear and waits, never an index that does not mention the pack.
902 ///
903 /// # What a reopen recovers of the DERIVED tables, and how that was fixed
904 ///
905 /// [`Derived::graph`] and [`Derived::trees`] come back **in full**, for every
906 /// pack, whether or not anything is re-queued. They are folded from §14's
907 /// exploded table ([`Absorber::refold`]), which is on disk, so a clean
908 /// shutdown carries them across.
909 ///
910 /// This was a live correctness hole until 2026-08-08 and it is recorded
911 /// rather than quietly repaired. The graph was *accumulated in RAM* as packs
912 /// were absorbed and stored nowhere; a store killed mid-absorb got it back
913 /// because the interrupted pack was re-queued and re-resolved, but a store
914 /// that shut down **cleanly** re-queued nothing and came back with an empty
915 /// graph. MEASURED on oden 2026-08-08: 2687 rows and **0 of 551 commits**,
916 /// `reachable` on a commit returning that commit alone instead of its
917 /// closure — a *quiet* wrong answer — and `gc` seeing an empty live set. The
918 /// fix is the table, because the payloads the graph is folded from had no
919 /// home; [`tests::a_clean_shutdown_and_reopen_keeps_the_graph_and_reachable`]
920 /// is what proves it, over a real process that exits normally.
921 ///
922 /// The exploded table is still **droppable**: if its row count is short of
923 /// the `objects` table's, [`Absorber::adopt_journal`] declares no pack
924 /// absorbed and every one of them is re-queued and re-exploded. Absent means
925 /// rebuild, never wrong (§13.12, applied unchanged to a derived table).
926 ///
927 /// **Also the default arms, and also no environment read** — see
928 /// [`open`](GitStore::open).
929 pub fn open_with(root: &Path, account: &str, hash: GitHashKind) -> Result<Self> {
930 // The default ARMS, and the environment's CEILING: the one variable
931 // this constructor reads, because an operator capping a server's
932 // footprint must not have to pick a different constructor to do it.
933 // See [`crate::arms::redb_cache_bytes`].
934 Self::open_with_arms(
935 root,
936 account,
937 hash,
938 StoreConfig::DEFAULT.with_redb_cache_bytes(crate::arms::redb_cache_bytes()?),
939 )
940 }
941}
942
943/// Where a stored entry's delta base sits, relative to the request being served.
944///
945/// The `Outside` arm carries the base in **both** namings because the two delta
946/// forms know only one each — an `OFS_DELTA` its archive offset, a `REF_DELTA`
947/// its oid — and [`GitStore::emit_set`]'s thin arm has to ask "does the client
948/// hold this" in whichever one the entry speaks.
949enum BaseOf {
950 /// Not a delta at all. There is nothing to place it after and nothing to
951 /// re-head; the stored entry is copied as it stands.
952 Whole,
953 /// A delta whose base **is** in the request, at this archive offset.
954 ///
955 /// The offset is carried rather than recomputed because a `REF_DELTA` does
956 /// not know it — it names its base by oid, and its own `delta_base` column
957 /// is `0` by construction — and the emitter needs it twice: as the
958 /// `EmitEntry::delta_base` that [`crate::pack_walk::topological_order`]
959 /// orders on, and as the base an in-pack ref-delta is re-headed to point at.
960 Inside { at: u64 },
961 /// A delta whose base the request does not carry.
962 Outside {
963 /// The base's archive offset, `0` when the entry named an oid instead.
964 offset: u64,
965 /// The base's oid, `None` when the entry named an offset instead — or
966 /// when the entry is too short to read one out of.
967 oid: Option<Vec<u8>>,
968 },
969}
970
971/// The bases a **thin** pack may name without carrying them: what the receiver
972/// already held before this transfer, keyed both ways.
973///
974/// Built by [`GitStore::client_bases`], which is where the argument for trusting
975/// it is written down.
976struct ExternalBases {
977 /// The held object's oid, keyed by its archive offset — the coordinate an
978 /// `OFS_DELTA` names its base in, and the only reason this map exists.
979 by_offset: HashMap<u64, OidKey>,
980 /// The same objects keyed the way a `REF_DELTA` names them.
981 held: std::collections::HashSet<OidKey>,
982}
983
984/// **A raw oid as a fixed-size, `Copy` hash key — 20 bytes for SHA-1, 32 for
985/// SHA-256, and no heap allocation either way.**
986///
987/// The two maps in [`ExternalBases`] are repository-sized: the client's `have`
988/// closure on an incremental fetch is very nearly every object in the store.
989/// Keying them by `Vec<u8>` is one heap allocation per entry per request —
990/// 12 112 of them for a 69-object fetch, measured on oden 2026-08-15 — for a
991/// question (*does the client hold this base?*) that never looks at more than
992/// `oid_len` bytes.
993///
994/// Padded to the widest hash rather than parameterised by width: a store holds
995/// exactly one hash kind, so every key in one set has the same real length and
996/// two different oids can never collide through the padding. The length is
997/// carried anyway, because a key that silently compared equal across widths is
998/// the kind of wrong that only shows up in a mixed-hash mirror.
999#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
1000struct OidKey {
1001 bytes: [u8; 32],
1002 len: u8,
1003}
1004
1005impl OidKey {
1006 /// The key for `oid`, or a refusal for one wider than any git hash.
1007 fn new(oid: &[u8]) -> Result<Self> {
1008 let len = oid.len();
1009 if len == 0 || len > 32 {
1010 bail!("{len} is not the width of any git object id (1..=32 bytes)");
1011 }
1012 let mut bytes = [0u8; 32];
1013 bytes[..len].copy_from_slice(oid);
1014 Ok(OidKey {
1015 bytes,
1016 len: len as u8,
1017 })
1018 }
1019
1020 /// The oid back, at its real width.
1021 fn as_slice(&self) -> &[u8] {
1022 &self.bytes[..self.len as usize]
1023 }
1024}
1025
1026impl<S: ObjectIndex + 'static> GitStore<S> {
1027 /// **The one constructor**, with every arm named.
1028 ///
1029 /// `S` picks the [`ObjectIndex`] layout at compile time; `arms` picks the
1030 /// [`ArchiveWrite`](crate::archive_write::ArchiveWrite) and [`Gc`]
1031 /// implementations at run time. [`open`](GitStore::open) and
1032 /// [`open_with`](GitStore::open_with) are this function with
1033 /// [`StoreConfig::DEFAULT`], which is why nothing about them moved.
1034 ///
1035 /// `arms.index` is **not** consulted here — `S` is the index arm, and a
1036 /// value that disagreed with the type would be a second source of truth.
1037 /// [`open_from_env`] is the one place the two are tied together, and it does
1038 /// it by choosing `S` from the value.
1039 ///
1040 /// ```no_run
1041 /// use znippy_plugin_git::arms::{GcArm, StoreConfig, WriterArm};
1042 /// use znippy_plugin_git::index_layout::PackedPayload;
1043 /// use znippy_plugin_git::{GitHashKind, GitStore};
1044 ///
1045 /// // A rebuildable import mirror: the ceiling writer, the packed payload
1046 /// // layout, and an in-place compaction.
1047 /// let arms = StoreConfig::DEFAULT
1048 /// .with_writer(WriterArm::Fast)
1049 /// .with_gc(GcArm::CompactInPlace);
1050 /// let store = GitStore::<PackedPayload>::open_with_arms(
1051 /// std::path::Path::new("/srv/repo"),
1052 /// "rickard",
1053 /// GitHashKind::Sha1,
1054 /// arms,
1055 /// )?;
1056 /// # Ok::<(), anyhow::Error>(())
1057 /// ```
1058 pub fn open_with_arms(
1059 root: &Path,
1060 account: &str,
1061 hash: GitHashKind,
1062 arms: StoreConfig,
1063 ) -> Result<Self> {
1064 std::fs::create_dir_all(root)
1065 .with_context(|| format!("creating the store root {}", root.display()))?;
1066 let blobs = root.join("objects.pack");
1067 let writer = arms.writer.create(&blobs)?;
1068 // `None` for an arm that keeps no durable ack log — see
1069 // [`crate::arms::WriterArm::journal`]. Everything below that touches the
1070 // journal is written against that `Option` rather than assuming one.
1071 let journal = arms.writer.journal(&blobs);
1072 // **The redb ceiling**, carried in on the config rather
1073 // than read here: `StoreConfig::from_env` reads it with the arms, and
1074 // `open`/`open_with` put the environment's value on `DEFAULT` before
1075 // getting here, so every constructor still honours the variable and
1076 // `arms.to_string()` prints what was actually applied. Not an arm — see
1077 // [`crate::arms::redb_cache_bytes`] — redb's own default is 1 GiB *per
1078 // database*, and this store opens exactly ONE of them, the
1079 // `ObjectReadStack` below. The `let _ = cache_bytes` two lines down is
1080 // what is left of the second.
1081 let cache_bytes = arms.redb_cache_bytes;
1082 let objects = ObjectReadStack::<S>::open(
1083 &root.join("objects.tail"),
1084 RebuildTriggers::default(),
1085 cache_bytes,
1086 )?;
1087 let _ = cache_bytes; // no page cache to size: the blob is pread, the index is a slice
1088 // A store written before 2026-09-04 carries `objects.ordinal`, the memo
1089 // of the sorted oid list the read stack's persisted index now IS. Its
1090 // bytes are never read again, so it goes on the first open by this
1091 // build — 278 964 902 B on the kernel mirror. Absent is the normal case
1092 // and not an event; anything else that stops the delete is logged, not
1093 // fatal, because the store does not depend on the file being gone.
1094 match std::fs::remove_file(root.join(ORDINAL_CACHE_FILE)) {
1095 Ok(()) => tracing::info!(
1096 target: "znippy.git",
1097 path = %root.join(ORDINAL_CACHE_FILE).display(),
1098 "removed a stale objects.ordinal — the persisted index's oid column is the \
1099 ordinal space now"
1100 ),
1101 Err(e) if e.kind() == std::io::ErrorKind::NotFound => {}
1102 Err(e) => tracing::warn!(
1103 target: "znippy.git",
1104 path = %root.join(ORDINAL_CACHE_FILE).display(),
1105 error = %e,
1106 "could not remove a stale objects.ordinal; it is dead weight, not a fault"
1107 ),
1108 }
1109 let exploded = Arc::new(ExplodedCache::open(
1110 &root.join("objects.exploded"),
1111 crate::exploded_arrow::ExplodePolicy::from_env()?,
1112 crate::exploded_cache::budget_from_env(root)?,
1113 )?)
1114 .registered();
1115 // **One descriptor on the blob file, not three.** The writer opened it
1116 // read/write and `flock`ed it; the absorber's `pread` fallback and the
1117 // index workers' `read_exact_at` both address it positionally, so they
1118 // take the same open file description rather than two more of their
1119 // own. 5 descriptors per open store → 3, which is the divisor of
1120 // gunnar's `open_repo_budget` (`tests/fd_per_store.rs`).
1121 let absorber = Arc::new(Absorber::<S>::open(
1122 &blobs,
1123 writer.blobs_shared(),
1124 hash,
1125 objects,
1126 exploded,
1127 )?);
1128
1129 // **The `indexed` bit, derived.** Every extent this archive has ever
1130 // acked, diffed against the rows the index holds. `SafeWriter::create`
1131 // above appends to that journal and never truncates it, which is what
1132 // makes the older extents still be here to diff against.
1133 //
1134 // An arm with no journal has nothing to derive the bit from, and that is
1135 // the honest consequence of choosing it rather than a gap: a
1136 // `FastWriter` store has no durable record that a pack was acked, so a
1137 // reopen re-queues nothing and there is nothing for it to re-queue.
1138 let acked = match journal.as_deref() {
1139 Some(p) if p.exists() => crate::archive_write::read_journal(p).with_context(|| {
1140 format!(
1141 "reading {} — it is the durable half of the indexed bit and a store \
1142 cannot be opened without knowing which packs it owes index work for",
1143 p.display()
1144 )
1145 })?,
1146 _ => Vec::new(),
1147 };
1148 let requeue = absorber.adopt_journal(&acked)?;
1149
1150 // **The wiring.** The absorber goes into the push path, which hands it to
1151 // every account indexer it starts, so the drain behind `push_pack` ends
1152 // in object rows instead of one pack row. Nothing about the ack changes:
1153 // `append` still returns after the two fsyncs and this is all downstream
1154 // of that (§13.9).
1155 let push = PushPath::with_absorber(
1156 writer,
1157 &blobs,
1158 journal,
1159 absorber.clone() as Arc<dyn ObjectAbsorb>,
1160 )?;
1161 let refs = RefLog::new(root.join("refs.log"));
1162 let archive = root.join("repository.znippy");
1163
1164 let store = Self {
1165 root: root.to_path_buf(),
1166 blobs,
1167 archive,
1168 push,
1169 account: account.to_string(),
1170 hash,
1171 absorber,
1172 refs,
1173 ref_gate: Mutex::new(()),
1174 gc: arms.gc.create(),
1175 arms,
1176 };
1177 // The interrupted work, back on the channel it fell off. Nothing reads
1178 // here and nothing blocks: this is the same 24-byte handoff a push makes,
1179 // and the drain picks it up on its own thread (§13.9-11).
1180 let indexer = store.push.indexer(&store.account);
1181 for p in &requeue {
1182 indexer.submit(IndexJob {
1183 pack_id: p.pack_id,
1184 offset: p.offset,
1185 len: p.len,
1186 })?;
1187 }
1188 // A store reopened over an existing tail already knows its objects; the
1189 // derived tables are rebuilt from them rather than from a side-car,
1190 // because a side-car is a second truth.
1191 store.refold()?;
1192 Ok(store)
1193 }
1194
1195 /// The arms this store was built with. A description of what was
1196 /// constructed, not a switch — nothing on a serving path reads it.
1197 pub fn arms(&self) -> StoreConfig {
1198 self.arms
1199 }
1200
1201 /// The selected writer's name, as it goes on a bench row.
1202 pub fn writer_name(&self) -> &'static str {
1203 self.push.name()
1204 }
1205
1206 /// What the selected writer's `append` actually promises. Printed next to a
1207 /// throughput, because a throughput without it is not a comparison.
1208 pub fn writer_durability(&self) -> &'static str {
1209 self.push.durability()
1210 }
1211
1212 /// The selected [`Gc`] arm.
1213 pub(crate) fn gc_arm(&self) -> &dyn Gc {
1214 self.gc.as_ref()
1215 }
1216
1217 /// Where the verbatim packs are.
1218 pub fn blobs_path(&self) -> &Path {
1219 &self.blobs
1220 }
1221
1222 /// The sealed archive GC operates on.
1223 pub fn archive_path(&self) -> &Path {
1224 &self.archive
1225 }
1226
1227 pub fn root(&self) -> &Path {
1228 &self.root
1229 }
1230
1231 pub fn hash_kind(&self) -> GitHashKind {
1232 self.hash
1233 }
1234
1235 /// The `objects` table, for a caller that wants the index directly (the
1236 /// bench does).
1237 pub fn index(&self) -> &ObjectReadStack<S> {
1238 &self.absorber.objects
1239 }
1240
1241 /// Objects in the `objects` table.
1242 pub fn object_count(&self) -> usize {
1243 self.absorber.objects.len()
1244 }
1245
1246 /// Commits in the graph.
1247 pub fn commit_count(&self) -> usize {
1248 self.absorber
1249 .derived
1250 .read()
1251 .expect("derived lock")
1252 .graph
1253 .len()
1254 }
1255
1256 /// `(graph_read_from_disk, graph_recomputed)` since this store was opened —
1257 /// how many folds read the persisted `objects.graph` vs re-derived it.
1258 pub fn graph_source_stats(&self) -> (u64, u64) {
1259 self.absorber.graph_source_stats()
1260 }
1261
1262 /// `(reach_carried, reach_rebuilt)` since this store was opened — how many
1263 /// folds carried the reachability table across (renumbered, no tree
1264 /// opened) vs how many reads built it from scratch. The witness for the
1265 /// clone-after-push lever; see `REACH_CARRY_MAX_FRACTION`.
1266 pub fn reach_source_stats(&self) -> (u64, u64) {
1267 self.absorber.reach_source_stats()
1268 }
1269
1270 /// `(folded_rows, tail_rows)` of the ordinal space the last fold built — how
1271 /// many oids came off the persisted index's oid column and how many off a
1272 /// scan of the redb tail. Replaces S-082's `(read, recomputed)`: there is no
1273 /// memo to read any more, the index IS the space.
1274 pub fn ordinal_source_stats(&self) -> (u64, u64) {
1275 self.absorber.ordinal_source_stats()
1276 }
1277
1278 /// The folded ordinal space — every oid in ordinal order, hex. For the tests
1279 /// that assert a memo read reproduces the scanned space exactly (same oids,
1280 /// same order, same ordinals — the ordinal is the index into this vector).
1281 ///
1282 /// Formatted on demand from `oids_raw`: there is no resident hex `Vec` any
1283 /// more (S-082), and a test that wants hex encodes the flat buffer here
1284 /// rather than the store carrying a second copy for it.
1285 #[cfg(test)]
1286 pub(crate) fn ordinal_oids(&self) -> Vec<String> {
1287 let oid_len = self.hash.oid_len();
1288 self.absorber
1289 .derived
1290 .read()
1291 .expect("derived lock")
1292 .oids_raw
1293 .chunks_exact(oid_len)
1294 .map(hex::encode)
1295 .collect()
1296 }
1297
1298 /// **One object's resolved content** — §14's exploded table, in one lookup.
1299 ///
1300 /// Not one of the twelve and deliberately not on [`GitOps`]: the twelve are
1301 /// the wire vocabulary and they hand back **stored** bytes ([`GitOps::get`]),
1302 /// which for a delta entry is a delta. This is the other question — *what
1303 /// does this object contain* — and it is the one §14's table exists to make
1304 /// a point lookup instead of a chain walk.
1305 ///
1306 /// It absorbs any pending pack first, for the same reason
1307 /// [`GitOps::has`] does: a store with durable bytes it has not indexed cannot
1308 /// answer "absent" without lying.
1309 pub fn content(&self, oid: Oid<'_>) -> Result<Option<(GitObjectKind, Vec<u8>)>> {
1310 // No absorb here any more: a pack the worker has not reached is read
1311 // for this one oid by `Absorber::resolved`'s third arm — on this thread,
1312 // from the mmapped pack, without waiting for the worker.
1313 self.absorber.resolved(oid)
1314 }
1315
1316 /// **One object, with the bill for producing it.**
1317 ///
1318 /// [`Self::content`] plus what the read cost: `None` for a cost when the
1319 /// exploded pools answered (nothing was rebuilt), `Some(cost)` when the
1320 /// object was inflated out of the pack. What a measurement needs and a
1321 /// server does not — the cache admission decision is made inside, not by
1322 /// the caller.
1323 pub fn content_costed(
1324 &self,
1325 oid: Oid<'_>,
1326 ) -> Result<Option<(GitObjectKind, Vec<u8>, Option<crate::resolve::ReadCost>)>> {
1327 self.absorber.resolved_costed(oid)
1328 }
1329
1330 /// §14's table, counted: rows, rows written, reads it served, reads that fell
1331 /// through to re-deriving from the verbatim truth.
1332 ///
1333 /// Applied output. Both content paths return identical bytes, so `served`
1334 /// against `rederived` is the only thing that can say which one ran.
1335 pub fn exploded_stats(&self) -> ExplodedStats {
1336 self.absorber.exploded.engine_stats()
1337 }
1338
1339 /// **What the exploded tier is holding and what it is allowed to hold** —
1340 /// the row a dashboard prints (`explode 3.1G/8G`) and `Admin.StorageInfo`
1341 /// carries, per repository.
1342 pub fn explode_cache_use(&self) -> crate::exploded_cache::CacheUse {
1343 self.absorber.exploded.use_now()
1344 }
1345
1346 /// Rows in the EAGER pool only — the graph the push wrote, with nothing a
1347 /// reader has since cached. What `adopt_journal` compares against the index
1348 /// and what a test asking "did the push explode the graph" must ask,
1349 /// because [`Self::exploded_stats`]'s `rows` counts both pools and a read
1350 /// moves it.
1351 pub fn exploded_eager_rows(&self) -> Result<u64> {
1352 self.absorber.exploded.eager_rows()
1353 }
1354
1355 /// **Set this repository's explode budget** — what the control plane calls
1356 /// when an account's quota changes. Takes effect at the next rotation; it
1357 /// never refuses a read, never refuses a write and never deletes on the
1358 /// caller's thread. A bigger budget buys a bigger cache and therefore faster
1359 /// first reads; a smaller one costs re-inflation, never an error.
1360 pub fn set_explode_budget(&self, bytes: u64) {
1361 self.absorber.exploded.set_budget(bytes);
1362 }
1363
1364 /// Flush the lazy pool, rotate it and evict it back under budget — on
1365 /// **this** thread. What a test and a `gc` call; a reader never does, it
1366 /// starts a write-back thread and walks away.
1367 pub fn explode_cache_maintain(&self) -> Result<u64> {
1368 self.absorber.exploded.maintain()
1369 }
1370
1371 /// **`repo gc` reclaims the cache**: every lazy segment unlinked, the graph
1372 /// pool kept. Returns the bytes that left the filesystem.
1373 pub fn drop_explode_cache(&self) -> Result<u64> {
1374 self.absorber.exploded.drop_cache()
1375 }
1376
1377 /// Where §14's table lives. Deleting this file while no store holds it is the
1378 /// sanctioned way to drop it; the next open re-explodes every pack.
1379 pub fn exploded_path(&self) -> &Path {
1380 self.absorber.exploded.path()
1381 }
1382
1383 /// Every live row of one kind, with its payload — what the graph fold reads,
1384 /// exposed so a measurement can ask **the table** how many bytes it holds
1385 /// rather than dividing a file size by what the pack claimed.
1386 pub fn exploded_of_kind(&self, kind: GitObjectKind) -> Result<Vec<(Vec<u8>, Vec<u8>)>> {
1387 self.absorber.exploded.of_kind(kind)
1388 }
1389
1390 /// The commit graph as it stands, generations included. A snapshot: the
1391 /// caller holds no lock and the next fold replaces it wholesale.
1392 pub fn graph_snapshot(&self) -> Vec<CommitNode> {
1393 self.absorber
1394 .derived
1395 .read()
1396 .expect("derived lock")
1397 .graph
1398 .clone()
1399 }
1400
1401 /// Packs whose objects are not in the index yet — §13.12's bit, counted.
1402 pub fn unindexed_packs(&self) -> usize {
1403 self.absorber.unindexed_packs()
1404 }
1405
1406 /// This account's indexer: the thread that drains the channel a push queues
1407 /// on. `is_indexed(pack_id)` on it is §13.12's bit at the pack level, and it
1408 /// is set only once that pack's **objects** are in the index.
1409 pub fn indexer(&self) -> std::sync::Arc<crate::indexer::AccountIndexer> {
1410 self.push.indexer(&self.account)
1411 }
1412
1413 /// Block until the background drain has absorbed everything this store has
1414 /// pushed. What a maintenance tick, a seal or a test uses instead of racing
1415 /// it.
1416 pub fn wait_indexed(&self) {
1417 self.push.pool().wait_caught_up();
1418 }
1419
1420 /// **Stop this store's index work — the repository is being deleted.**
1421 ///
1422 /// Sets the cancel flag the resolver polls every few thousand objects and
1423 /// the drain checks before every pack. The pack in flight is **aborted at
1424 /// its next checkpoint** (milliseconds), not finished: its rows are keyed
1425 /// by oid and the exploded tier is droppable, and the whole directory is
1426 /// about to be removed anyway. Every pack still queued is skipped. After
1427 /// this the store can be dropped without the drop joining a worker that is
1428 /// hours into a kernel pack — which is what `Drop for AccountIndexer` would
1429 /// otherwise do.
1430 pub fn cancel_index(&self) {
1431 self.absorber.cancel.store(true, std::sync::atomic::Ordering::SeqCst);
1432 self.push.pool().cancel_all();
1433 }
1434
1435 /// Put a different memory watchdog under this store's worker — a test's
1436 /// fake `/proc/meminfo`. Takes effect from the next pack.
1437 pub fn set_mem_watchdog(&self, dog: Arc<crate::memguard::MemWatchdog>) {
1438 *self.absorber.watchdog.write().unwrap_or_else(|e| e.into_inner()) = dog;
1439 }
1440
1441 /// Has [`cancel_index`](Self::cancel_index) been called?
1442 pub fn index_cancelled(&self) -> bool {
1443 self.absorber.cancel.load(std::sync::atomic::Ordering::SeqCst)
1444 }
1445
1446 /// This store's index progress counter, for a dashboard or a stats call.
1447 pub fn index_progress(&self) -> crate::progress::Snapshot {
1448 self.absorber.progress.snapshot()
1449 }
1450
1451 /// **The indexer's half of the split**, and not one of the twelve.
1452 ///
1453 /// Runs on the account indexer's worker (§13.9), and on a read that arrives
1454 /// before that worker got there — the same function either way, which is why
1455 /// there is no such thing as a background index that behaves differently from
1456 /// the fallback one.
1457 pub fn absorb_pending(&self) -> Result<usize> {
1458 self.absorber.absorb_pending()
1459 }
1460
1461 /// **Make every durable object addressable, on this thread, now** —
1462 /// [`git_storage_trait::GitServe::index_now`]'s implementation and the ack
1463 /// path's one call. See [`Absorber::index_pending_now`] for why the
1464 /// connectivity check is the only caller allowed to wait here.
1465 pub fn index_now(&self) -> Result<usize> {
1466 self.absorber.index_pending_now()
1467 }
1468
1469 /// **The packs this store has stopped trying to index**, with the reason
1470 /// each one stopped for.
1471 ///
1472 /// Empty is the ordinary answer and the only good one. A non-empty list is
1473 /// a repository that is missing objects whose bytes are durable, and it is
1474 /// the fact an operator needs before wondering why a push was refused or a
1475 /// standby is behind — see [`MAX_ABSORB_ATTEMPTS`].
1476 pub fn unindexable_packs(&self) -> Vec<Unindexable> {
1477 self.absorber.unindexable_packs()
1478 }
1479
1480 /// **The object ids a stored pack introduced**, and not one of the twelve.
1481 ///
1482 /// [`GitOps::put_pack`] cannot answer this and never will: the walk it does
1483 /// reads pack *entries*, and a pack entry does not carry its oid — that is
1484 /// why [`crate::pack_walk::Closure`] can only name the `REF_DELTA` bases and
1485 /// says so. The oids exist once the indexer has absorbed the pack, so this
1486 /// absorbs first rather than racing the drain, and is therefore the one
1487 /// caller that deliberately pays §13.9's deferral back.
1488 ///
1489 /// **Only call it when something needs the set.** A push whose policy has no
1490 /// gate over objects must not pay this, which is the whole reason it is a
1491 /// separate call and not a field on `TxId`.
1492 ///
1493 /// The extent *is* the identity: §14 stores a pack verbatim as one
1494 /// contiguous append, so "introduced by this pack" and "indexed at an offset
1495 /// inside this pack's extent" are the same set, with no pack column to keep
1496 /// in step. Bases the push deltas against live in *other* extents and are
1497 /// excluded by construction — which is what a thin push needs, and what
1498 /// reading a written `.idx` back could never do.
1499 ///
1500 /// Cost is one pass over the index, so it is O(objects in the repository),
1501 /// not O(objects pushed). Recorded rather than hidden: a per-pack ordinal
1502 /// range would make it O(pushed), and needs the indexer to keep one.
1503 pub fn oids_in_extent(&self, extent: Extent) -> Result<Vec<Vec<u8>>> {
1504 let (start, len) = extent;
1505 // **Never waits on the indexer.** If the gate is free this thread
1506 // absorbs the pending packs (the same work, done now, by the caller
1507 // that needs it); if the worker holds it, the extent is resolved
1508 // read-only on this thread and its oids are the answer — the same
1509 // resolver, no sink, no rows written.
1510 if self.try_absorb_pending()?.is_none() {
1511 let snap = self.archive_snapshot()?;
1512 let bytes = self.extent(&snap, start, len)?;
1513 let walked = crate::pack_walk::walk(&bytes, self.hash.oid_len())?;
1514 let mut oids: Vec<Vec<u8>> = Vec::with_capacity(walked.entries.len());
1515 let limits = crate::resolve::ResolveLimits {
1516 base_budget: (crate::resolve::base_budget_from_env() / 4).max(1),
1517 ..crate::resolve::ResolveLimits::none()
1518 };
1519 crate::resolve::resolve_streaming(
1520 &bytes,
1521 &walked,
1522 self.hash,
1523 start,
1524 &*self.absorber,
1525 &crate::exploded::NoSink,
1526 limits,
1527 &mut |rows| {
1528 oids.extend(rows.drain(..).map(|r| r.oid));
1529 Ok(())
1530 },
1531 )
1532 .context("resolving the pushed pack read-only to enumerate its objects")?;
1533 return Ok(oids);
1534 }
1535 let end = start.saturating_add(len);
1536 let all = self.index().oids_in_order()?;
1537 let refs: Vec<&[u8]> = all.iter().map(Vec::as_slice).collect();
1538 let extents = self.index().extents_batch(&refs);
1539 Ok(all
1540 .into_iter()
1541 .zip(extents)
1542 .filter_map(|(oid, at)| match at {
1543 Some((offset, _)) if offset >= start && offset < end => Some(oid),
1544 _ => None,
1545 })
1546 .collect())
1547 }
1548
1549 /// **Everything needed to emit a pack for EXACTLY `oids`** — nothing added,
1550 /// nothing dropped.
1551 ///
1552 /// Not one of the twelve. It sits beside [`absorb_pending`](Self::absorb_pending)
1553 /// for the same reason those do: it is about how storage is *shaped*, not
1554 /// about what a caller stores or reads.
1555 ///
1556 /// # 🔴 It used to add the delta bases, and that shipped broken clones
1557 ///
1558 /// Until 2026-08-11 this closed the request over its delta bases: an
1559 /// `OFS_DELTA` names its base by position, so a base outside the set cannot
1560 /// be encoded, and *adding the base* looked like the answer that is always
1561 /// safe. It is not, and the failure is silent on the server:
1562 ///
1563 /// ```text
1564 /// git clone --bare --single-branch --branch base <url>
1565 /// fatal: did not receive expected object 8601ec33920b7d701c9887fa04916501136d6e90
1566 /// fatal: fetch-pack: invalid index-pack output
1567 /// event="git.upload_pack.served" objects=33773 ← the server said SUCCESS
1568 /// ```
1569 ///
1570 /// Measured on the `h2h-linear-sha1-2048c-1024f-16k` fixture: `base` reaches
1571 /// **31 805** objects, the delta-base closure added **1 968** more — 33 773,
1572 /// exactly the count the server logged — and 507 of those additions were
1573 /// **trees**. A tree that is not reachable from the wants drags its own
1574 /// children in as a *requirement*, because `git index-pack
1575 /// --check-self-contained-and-connected` (which is what a clone runs, and
1576 /// which sets `strict`) walks every received object's links and then demands
1577 /// each one exist. Those 507 trees named **204** objects the pack did not
1578 /// contain. `8601ec33…` is one of them.
1579 ///
1580 /// So a delta base pulled into a narrowed request is not free: it satisfies
1581 /// the *pack format* and violates *connectivity*. Closing over the added
1582 /// bases' children in turn does terminate — the same fixture reaches a fixed
1583 /// point at 34 534 objects — but it is an over-send by construction, and on
1584 /// a `--filter=blob:none` fetch it adds back exactly the blobs the filter
1585 /// excluded, which is the defect
1586 /// `emit_pack_emits_exactly_the_set_it_is_given_and_never_its_closure`
1587 /// exists to forbid.
1588 ///
1589 /// # What it does instead: the base decides how the entry is encoded
1590 ///
1591 /// The set is never widened. For each requested object:
1592 ///
1593 /// * **base inside the request** → the stored entry is copied byte for byte,
1594 /// which is the whole point of this engine and is what a full clone does
1595 /// for every single object;
1596 /// * **base outside the request** → the entry is **rebuilt** from §14's
1597 /// resolved content and marked
1598 /// [`EmitEntry::recompressed`](crate::pack_walk::EmitEntry::recompressed) —
1599 /// as a computed delta against a base the request *does* carry where one
1600 /// can be found (see [`Self::in_request_chain_ancestor`] and
1601 /// [`crate::delta`]), and whole where it cannot.
1602 ///
1603 /// That is what stock `pack-objects` does — it reuses a stored delta only
1604 /// when the base is also being packed — and it keeps the receipt a fact:
1605 /// `copied` and `recompressed` add up to the objects written, and
1606 /// `recompressed` is **0 for a whole-repository clone** because such a
1607 /// selection contains every base. The cost lands on the boundary a narrowed
1608 /// request cuts through and nowhere else: 1 968 of 33 773 entries, 5.9 %, on
1609 /// the fixture above.
1610 ///
1611 /// `ofs_delta_ok` is the client's `ofs-delta` capability. An old client that
1612 /// cannot parse one is not refused any more: the entry is re-headed as a
1613 /// `REF_DELTA` naming its base by oid, **carrying the same compressed delta
1614 /// payload**, so that arm stays a copy too. Only a base outside the request
1615 /// costs a rebuild.
1616 ///
1617 /// # `thin_haves` — the boundary entry that does NOT have to be rebuilt
1618 ///
1619 /// `Some(tips)` says the client consented to a thin pack *and* the
1620 /// negotiation found common ground; [`crate::serve::GitStore::emit_oids`] is
1621 /// where the two halves are required together, because either alone is a
1622 /// failed fetch rather than a smaller one. Given it, a base outside the
1623 /// request is checked against [`the client's own objects`](GitStore::client_bases),
1624 /// and one the client already holds is named by oid in a `REF_DELTA` that
1625 /// carries the **stored delta stream unchanged**. That entry counts as
1626 /// `copied`, because it is: nothing was inflated and nothing was deflated.
1627 ///
1628 /// `None` — a clone, or a client that did not ask for a thin pack — behaves
1629 /// exactly as before, and a **full clone is byte-identical either way**,
1630 /// because a whole-repository request has no base outside itself for any of
1631 /// this to apply to.
1632 ///
1633 /// It does nothing for the *clone* half of the boundary cost, and cannot: a
1634 /// clone's receiver holds nothing, so there is no external base to name.
1635 /// That half is the arm below it — [`crate::delta`] computes a delta against
1636 /// something the pack **does** carry, which is the only move left when there
1637 /// is no receiver to lean on. The two do not overlap: `thin_haves` reaches a
1638 /// boundary entry first and costs nothing when it fires, so a fetch stays a
1639 /// pure copy and only a clone pays for a computed delta.
1640 ///
1641 /// # An oid this repository does not hold is REFUSED
1642 ///
1643 /// It used to be skipped, which is the same silent-under-send shape as the
1644 /// closure defect above wearing a different hat: N asked, N-1 emitted,
1645 /// `PackStats` reporting success, and the client the first to know. gunnar's
1646 /// in-memory arm has always refused it, so the skip also meant the two
1647 /// engines behind one contract disagreed about what a missing object means.
1648 /// A partial-clone filter does not depend on the skip and cannot: a filter
1649 /// *removes* oids from the selection, it never adds one the store lacks.
1650 ///
1651 /// # Cost
1652 ///
1653 /// O(objects requested). The previous shape read `oids_in_order()` and
1654 /// `lookup_batch` over the **whole repository** on every call, to build an
1655 /// offset→oid map it needed only for the closure; with no closure the
1656 /// selection's own offsets answer "is this base in the request", so that
1657 /// scan is gone and no reverse index has to exist.
1658 pub fn emit_set(
1659 &self,
1660 oids: &[Oid<'_>],
1661 ofs_delta_ok: bool,
1662 thin_haves: Option<&[Oid<'_>]>,
1663 ) -> Result<Vec<crate::pack_walk::EmitEntry>> {
1664 use crate::index_layout::ObjType;
1665 use std::collections::hash_map::Entry;
1666
1667 // If the gate is free, absorb now; if the worker holds it, the rows
1668 // come from the index plus a read-only pass over the pending packs
1669 // (`lookup_batch_never_wait` below). Never a wait.
1670 let _ = self
1671 .try_absorb_pending()
1672 .context("absorbing pending index work before emitting a pack")?;
1673
1674 // Deduplicate, preserving the caller's order. A repeated oid in the
1675 // request must not become a repeated entry in the pack.
1676 //
1677 // **A map and not a set**, keyed oid → position in `asked` (which is the
1678 // position in `rows`). The membership question is the one it always was;
1679 // what the position buys is the base's *archive offset* for a
1680 // `REF_DELTA`, which names its base by oid and can learn where that base
1681 // sits no other way. It is a `usize` per requested object on a vector
1682 // this function already builds — not a second pass and not a second
1683 // index lookup.
1684 let mut asked: Vec<&[u8]> = Vec::with_capacity(oids.len());
1685 let mut seen: HashMap<&[u8], usize> = HashMap::with_capacity(oids.len());
1686 for oid in oids {
1687 if let Entry::Vacant(slot) = seen.entry(*oid) {
1688 slot.insert(asked.len());
1689 asked.push(*oid);
1690 }
1691 }
1692
1693 let rows = self.lookup_batch_never_wait(&asked)?;
1694
1695 // **One mapping for the whole emit set.** Only the header probes below
1696 // read through it — the entries themselves are recorded as extents and
1697 // resolved by [`Self::resolve_emit_payloads`], which takes its own
1698 // snapshot of the same [`ArchiveMap`](crate::archive_map::ArchiveMap) and
1699 // therefore the same `Arc` unless a push landed in between.
1700 let snap = self.archive_snapshot()?;
1701
1702 // The two questions "is this base in the request" are asked in the two
1703 // coordinate systems the two delta forms use, and both are answered off
1704 // the request itself rather than off the index.
1705 //
1706 // **Offset → position in the request**, not a bare set of offsets. The
1707 // membership question is the same one it always was; what the position
1708 // buys is the base's *oid*, which the re-delta arm below needs in order
1709 // to read the base's content. It is the same single pass over `rows`
1710 // that built the set, so it costs a `usize` per requested object and no
1711 // extra work — and it is emphatically not the whole-repository
1712 // offset→oid scan the old delta-base closure used to do.
1713 let in_set_offsets: HashMap<u64, usize> = rows
1714 .iter()
1715 .enumerate()
1716 .filter_map(|(i, r)| r.as_ref().map(|r| (r.offset, i)))
1717 .collect();
1718 let oid_len = self.hash_kind().oid_len();
1719
1720 // The base of the last boundary entry that was re-deltified, kept so a
1721 // run of entries hanging off one ancestor inflates it once. One slot and
1722 // not an LRU: measured on `h2h-linear-sha1-2048c-1024f-16k`, 961
1723 // boundary entries name 855 distinct stored bases, so there is no reuse
1724 // worth a cache that could hold a repository's worth of objects — and
1725 // this crate is under a live RSS budget.
1726 let mut base_content: Option<(u64, Vec<u8>)> = None;
1727
1728 // What the client already holds, built **lazily and at most once**. A
1729 // clone never asks for it (`thin_haves` is `None`), and a fetch every one
1730 // of whose bases is inside the request never reaches the line that builds
1731 // it either — only a request that actually cuts a delta chain pays, which
1732 // is the only request it can help.
1733 let mut client_bases: Option<ExternalBases> = None;
1734
1735 let mut out = Vec::with_capacity(asked.len());
1736 for (oid, row) in asked.iter().zip(rows.iter()) {
1737 // **An oid this repository does not hold is REFUSED, not dropped.**
1738 //
1739 // This used to `continue`, and that is the same silent-under-send
1740 // shape as the closure defect above: the request asks for N objects,
1741 // the pack carries N-1, the receipt says success and the client is
1742 // the first to find out. It also made the two engines disagree about
1743 // what a missing object *means* — gunnar's in-memory arm has always
1744 // said *"emit_pack was asked for X, which this store does not hold;
1745 // a pack emitter that skipped it would send a pack no client can
1746 // close"* — so a benchmark across the two was comparing two
1747 // contracts.
1748 //
1749 // No legitimate caller relies on the skip. Every set that reaches
1750 // here is built out of this store's own index: `select` answers from
1751 // the reachability bitmaps, and gunnar's own walk resolves each id
1752 // against the store before it selects it. A partial-clone filter is
1753 // no exception and is the case worth naming, because it is the one
1754 // that *looks* like it might be: `--filter=blob:none` **removes**
1755 // oids from the selection, it never adds one the store lacks, so a
1756 // filtered request is a smaller set of objects that are all present
1757 // and this refusal never fires on it.
1758 let Some(row) = row.as_ref() else {
1759 bail!(
1760 "this pack was asked for {}, which this repository does not hold; emitting \
1761 the rest would be a short pack reported as a success, so this refuses \
1762 instead",
1763 hex::encode(oid)
1764 );
1765 };
1766
1767 // Which base this entry names, if any, and whether the request holds
1768 // it. A `REF_DELTA`'s `delta_base` column is 0 by construction —
1769 // `DeltaBase::as_offset` reports 0 for a ref base and 0 is also the
1770 // no-base sentinel — so its base is read out of the entry's own
1771 // bytes, directly after the type/size varint.
1772 //
1773 // A base that is *outside* the request is carried in **both**
1774 // coordinate systems rather than as a bare `false`, because that is
1775 // what the thin arm below needs: an `OFS_DELTA` knows only where its
1776 // base sits, a `REF_DELTA` knows only what it is called, and
1777 // "does the client hold it" has to be asked in whichever one the
1778 // entry speaks.
1779 let base = match row.obj_type {
1780 ObjType::OfsDelta => match in_set_offsets.get(&row.delta_base) {
1781 Some(_) => BaseOf::Inside {
1782 at: row.delta_base,
1783 },
1784 None => BaseOf::Outside {
1785 offset: row.delta_base,
1786 oid: None,
1787 },
1788 },
1789 ObjType::RefDelta => {
1790 let head = self.extent(&snap, row.offset, row.len.min(64))?;
1791 let (_, _, n) = crate::pack_walk::type_and_size_of(&head)?;
1792 match head.get(n..n + oid_len) {
1793 // In the request — **and where**. `rows[i]` is `None`
1794 // only for an oid this store does not hold, which the
1795 // refusal above turns into an error the moment the loop
1796 // reaches it; until then the base is treated as outside,
1797 // which is the answer that cannot be wrong.
1798 Some(b) => match seen
1799 .get(b)
1800 .and_then(|i| rows[*i].as_ref())
1801 .map(|r| r.offset)
1802 {
1803 Some(at) => BaseOf::Inside { at },
1804 None => BaseOf::Outside {
1805 offset: 0,
1806 oid: Some(b.to_vec()),
1807 },
1808 },
1809 // A truncated entry names no base this can read. It is
1810 // not "inside", and it is not offered to the client
1811 // either — it falls through to the whole rebuild, which
1812 // is the answer that cannot be wrong.
1813 None => BaseOf::Outside {
1814 offset: 0,
1815 oid: None,
1816 },
1817 }
1818 }
1819 _ => BaseOf::Whole,
1820 };
1821
1822 if let BaseOf::Whole | BaseOf::Inside { .. } = base {
1823 let inside_at = match base {
1824 BaseOf::Inside { at } => Some(at),
1825 _ => None,
1826 };
1827 // **The whole-clone arm, and it reads not one byte here.** The
1828 // entry is recorded as its address in the archive; the bytes are
1829 // resolved against the mapping at emit time and go straight from
1830 // the page cache to the wire. This line used to be a `pread`
1831 // into a fresh `Vec` — 13.8 M of each on a `linux.git` clone, all
1832 // of them held at once, which is the 2314 MB peak RSS
1833 // [`crate::pack_walk::EntryBytes`] documents.
1834 let extent = crate::pack_walk::EntryBytes::Extent {
1835 offset: row.offset,
1836 len: row.len,
1837 };
1838 let (stored, obj_type, delta_base) = match (row.obj_type, inside_at) {
1839 // An `OFS_DELTA` for a client that cannot read one: re-head it
1840 // as a `REF_DELTA` naming the same base by oid. The compressed
1841 // payload is the delta stream either way, so this is still a
1842 // copy in the `recompressed` sense — nothing is inflated — but
1843 // the concatenation of a new header and an old payload exists
1844 // nowhere on disk, so it cannot be an extent and is `Owned`.
1845 (ObjType::OfsDelta, Some(_)) if !ofs_delta_ok => {
1846 let base_oid = self.oid_at_offset(row.delta_base, &asked, &rows)?;
1847 let bytes = self.extent(&snap, row.offset, row.len)?;
1848 (
1849 crate::pack_walk::EntryBytes::Owned(Self::as_ref_delta(
1850 &bytes, &base_oid,
1851 )?),
1852 ObjType::RefDelta,
1853 0,
1854 )
1855 }
1856 // 🚨 **A stored `REF_DELTA` whose base is IN THIS PACK is
1857 // re-headed as an `OFS_DELTA`, and that is not an
1858 // optimisation.**
1859 //
1860 // gitoxide — which is `gunnar_client`, `gunnar`'s own
1861 // `receive-pack`, and every other gix-based receiver — reads
1862 // every `OBJ_REF_DELTA` in an incoming pack as naming an
1863 // object *the receiver already has*.
1864 // `gix_pack::data::input::LookupRefDeltaObjectsIter` consults
1865 // the local object database and the bases it has already
1866 // spliced in, and **nowhere else**: never inside the pack it
1867 // is reading. A base that is in the pack and not in the
1868 // receiver's store is `input::Error::NotFound`, and the fetch
1869 // dies with `The object <base> could not be decoded or wasn't
1870 // found` — with the whole pack rejected, on a clone whose
1871 // target is empty by definition, so *every* such entry is
1872 // fatal. That is `S-003` / gitoxide#2882, and `gunnar-wire`'s
1873 // `Selection::client_has` carries the same rule for gunnar's
1874 // own emitter.
1875 //
1876 // Stock git resolves it happily, which is why this survived
1877 // five green `git clone` runs against the store that could
1878 // not serve one `gunnar_client` fetch (`gunnar.rewrite`
1879 // round 0 and `gunnar.year` week 0, all four znippy columns,
1880 // 2026-08-14 — the server logged the same request `served`).
1881 //
1882 // The entry keeps its compressed delta stream byte for byte;
1883 // only the header changes, from "base named by oid" to "base
1884 // named by distance", which is the naming every receiver in
1885 // existence resolves inside the pack. This is where such an
1886 // entry comes from in the first place: `git index-pack
1887 // --fix-thin` appends the base into the pack and leaves the
1888 // ref-delta naming it by oid, so any repository pushed to
1889 // more than once holds them.
1890 //
1891 // # What it costs, stated rather than glossed
1892 //
1893 // `Owned`, so this is the one arm that gives up the zero-copy
1894 // property for an entry it does **not** rebuild: the
1895 // compressed delta stream is memcpy'd once, because a new
1896 // header concatenated with an old payload exists nowhere on
1897 // disk and no extent can address it. Bounded by the
1898 // compressed size of the ref-deltas whose base is in the
1899 // request — not by the repository, and not by the pack.
1900 //
1901 // It could be avoided: `emit_pack` re-encodes every header
1902 // from `EmitEntry::obj_type` while `header_len` finds the
1903 // payload from the STORED bytes' own type, so an `Extent`
1904 // over the untouched ref-delta declared as an `OfsDelta`
1905 // would emit the identical pack with no copy at all. That is
1906 // deliberately not done: it makes an `EmitEntry` disagree
1907 // with the bytes it points at, and the entry model being
1908 // trustworthy is worth more than the memcpy. If the RSS
1909 // budget ever says otherwise, the honest form is a third
1910 // `EntryBytes` variant that carries the new header beside
1911 // the extent, not a silent disagreement.
1912 (ObjType::RefDelta, Some(at)) if ofs_delta_ok => {
1913 let bytes = self.extent(&snap, row.offset, row.len)?;
1914 (
1915 crate::pack_walk::EntryBytes::Owned(Self::as_ofs_delta(
1916 &bytes, oid_len, row.offset, at,
1917 )?),
1918 ObjType::OfsDelta,
1919 at,
1920 )
1921 }
1922 // Everything else copies. A `REF_DELTA` left as one here is
1923 // the `!ofs_delta_ok` client, which cannot be handed a
1924 // distance at all — and which is stock git older than 1.4.4,
1925 // never a gix receiver, since gix has always advertised
1926 // `ofs-delta`.
1927 _ => (extent, row.obj_type, row.delta_base),
1928 };
1929 out.push(crate::pack_walk::EmitEntry {
1930 oid: oid.to_vec(),
1931 stored,
1932 obj_type,
1933 uncompressed_size: row.uncompressed_size,
1934 delta_base,
1935 offset: row.offset,
1936 recompressed: false,
1937 deltified: false,
1938 });
1939 continue;
1940 }
1941
1942 // ── the base is outside the request ──────────────────────────────
1943 //
1944 // **Thin first.** If the client consented to a thin pack and the
1945 // negotiation vouches that it already holds this base, the entry
1946 // goes out as a `REF_DELTA` naming that base by oid, carrying the
1947 // **same compressed delta stream**. Nothing is inflated, nothing is
1948 // deflated, and the pack is smaller than the whole object by exactly
1949 // the margin the delta was worth. That is what `caps.thin` has always
1950 // been the allowance for.
1951 //
1952 // An `OFS_DELTA` cannot survive this: it names its base by a
1953 // backwards distance *within the pack*, and the base is not in the
1954 // pack. Re-heading it as a `REF_DELTA` is the same header swap the
1955 // no-`ofs-delta` client path does, over an unchanged payload.
1956 if let Some(haves) = thin_haves {
1957 if client_bases.is_none() {
1958 client_bases = Some(self.client_bases(haves)?);
1959 }
1960 let ext = client_bases
1961 .as_ref()
1962 .expect("the client's bases were just built");
1963 let base_oid: Option<Vec<u8>> = match &base {
1964 // Unreachable: the arm above `continue`s on both. Matched
1965 // rather than `unreachable!()` so that a future arm falling
1966 // through here declines the thin path instead of panicking
1967 // inside a serving thread.
1968 BaseOf::Whole | BaseOf::Inside { .. } => None,
1969 BaseOf::Outside {
1970 oid: Some(named), ..
1971 } => ext
1972 .held
1973 .contains(&OidKey::new(named)?)
1974 .then(|| named.clone()),
1975 BaseOf::Outside {
1976 offset,
1977 oid: None,
1978 } => ext.by_offset.get(offset).map(|k| k.as_slice().to_vec()),
1979 };
1980 if let Some(base_oid) = base_oid {
1981 // A stored `REF_DELTA` already names its base by oid, so its
1982 // bytes go out untouched and stay an extent. An `OFS_DELTA`
1983 // has to be re-headed, and the result is new bytes.
1984 let stored = if row.obj_type == ObjType::OfsDelta {
1985 let bytes = self.extent(&snap, row.offset, row.len)?;
1986 crate::pack_walk::EntryBytes::Owned(Self::as_ref_delta(&bytes, &base_oid)?)
1987 } else {
1988 crate::pack_walk::EntryBytes::Extent {
1989 offset: row.offset,
1990 len: row.len,
1991 }
1992 };
1993 out.push(crate::pack_walk::EmitEntry {
1994 oid: oid.to_vec(),
1995 stored,
1996 obj_type: ObjType::RefDelta,
1997 uncompressed_size: row.uncompressed_size,
1998 // The base is NOT in this pack, so nothing may be ordered
1999 // after it: `topological_order` reads 0 as "names no base
2000 // in here", which for an external base is the truth.
2001 delta_base: 0,
2002 offset: row.offset,
2003 // Copied. The payload never left the archive's bytes.
2004 recompressed: false,
2005 deltified: false,
2006 });
2007 continue;
2008 }
2009 }
2010
2011 // The base is not being sent and the client cannot supply it, so the
2012 // stored bytes cannot go out as they are. Two answers remain, and
2013 // the first is worth ~4× the second on the wire.
2014 let (kind, body) = self.content(oid)?.ok_or_else(|| {
2015 anyhow!(
2016 "{} is a delta whose base is outside this request, so it must be sent whole, \
2017 and this repository cannot produce its content — neither §14's exploded \
2018 table nor a re-derivation from the verbatim packs answered",
2019 hex::encode(oid)
2020 )
2021 })?;
2022
2023 // ── re-delta against a base the request DOES carry ────────────────
2024 //
2025 // The candidate comes from the entry's own stored delta chain: the
2026 // nearest ancestor that is inside the request. That is the packer's
2027 // original similarity judgement, already made and already written
2028 // down — no window, no sort, no scan of the repository.
2029 let candidate = if crate::delta::enabled() {
2030 self.in_request_chain_ancestor(row.delta_base, row.offset, &in_set_offsets)?
2031 } else {
2032 None
2033 };
2034 if let Some(base_at) = candidate {
2035 let at = *in_set_offsets
2036 .get(&base_at)
2037 .expect("the ancestor was found by lookup in this very map");
2038 // Reuse the last base if this entry hangs off the same one.
2039 if base_content.as_ref().is_none_or(|(o, _)| *o != base_at) {
2040 let base_oid = asked[at];
2041 let (_, base_body) = self.content(base_oid)?.ok_or_else(|| {
2042 anyhow!(
2043 "{} is in this request and is the delta base chosen for {}, and this \
2044 repository cannot produce its content",
2045 hex::encode(base_oid),
2046 hex::encode(oid)
2047 )
2048 })?;
2049 base_content = Some((base_at, base_body));
2050 }
2051 let (_, base_body) = base_content.as_ref().expect("just filled");
2052
2053 // `None` is the encoder declining — an unrelated base, or a
2054 // delta that came out no smaller than the object. Falling
2055 // through to the whole rebuild is then strictly right.
2056 if let Some(d) = crate::delta::delta(base_body, &body)? {
2057 let stored = Self::ofs_delta_entry(&d, row.offset, base_at)?;
2058 // A client with no `ofs-delta` is served the same computed
2059 // delta under a `REF_DELTA` head naming the base by oid —
2060 // the identical header swap the base-inside arm above does,
2061 // over a payload that is already built.
2062 // **The `Owned` exception, in its primary shape.** These
2063 // bytes were computed here and exist on no disk, so no
2064 // extent addresses them; carrying them on the entry is
2065 // correct and is bounded by the boundary a narrowed request
2066 // cuts through (961 of 33 773 entries on the fixture below),
2067 // never by the repository.
2068 let (stored, obj_type, delta_base) = if ofs_delta_ok {
2069 (
2070 crate::pack_walk::EntryBytes::Owned(stored),
2071 ObjType::OfsDelta,
2072 base_at,
2073 )
2074 } else {
2075 (
2076 crate::pack_walk::EntryBytes::Owned(Self::as_ref_delta(
2077 &stored, asked[at],
2078 )?),
2079 ObjType::RefDelta,
2080 0,
2081 )
2082 };
2083 out.push(crate::pack_walk::EmitEntry {
2084 oid: oid.to_vec(),
2085 stored,
2086 obj_type,
2087 uncompressed_size: row.uncompressed_size,
2088 delta_base,
2089 offset: row.offset,
2090 // Inflated and re-deflated, so NOT a copy — and the
2091 // receipt says which of the two rebuilds ran.
2092 recompressed: true,
2093 deltified: true,
2094 });
2095 continue;
2096 }
2097 }
2098
2099 // Ship the object whole rather than dragging an unreachable base —
2100 // and its children — into a clone.
2101 out.push(crate::pack_walk::EmitEntry {
2102 oid: oid.to_vec(),
2103 // Inflated and re-deflated from §14's resolved content: the
2104 // `Owned` exception again, and again bounded by the boundary.
2105 stored: crate::pack_walk::EntryBytes::Owned(Self::whole_entry(kind, &body)?),
2106 obj_type: crate::serve::resolved_type(kind),
2107 uncompressed_size: body.len() as u64,
2108 // Whole: it names no base, and nothing may order it after one.
2109 delta_base: 0,
2110 offset: row.offset,
2111 recompressed: true,
2112 deltified: false,
2113 });
2114 }
2115 Ok(out)
2116 }
2117
2118 /// **PHASE 1 of emitting: resolve every entry's stored bytes, in parallel.**
2119 ///
2120 /// Emission splits in two, and the split is not a preference — it is where
2121 /// the ordering dependency actually is:
2122 ///
2123 /// | phase | what it does | why |
2124 /// |---|---|---|
2125 /// | 1, **here**, parallel | address → bytes for every entry | the archive is immutable, so N workers over disjoint (or shared) extents need **no lock at all** |
2126 /// | 2, [`crate::pack_walk::emit_pack`], serial | assign output offsets, encode `OFS_DELTA` distances, write, hash | an `OFS_DELTA` names its base by **distance back in the output pack**, so entry *n* cannot be encoded until every earlier entry's byte length is known |
2127 ///
2128 /// Phase 2 is not parallelisable and no attempt is made: the distance chain
2129 /// is a genuine serial dependency, and a running sha1 is another.
2130 ///
2131 /// # No lock, and why that is a fact rather than an intention
2132 ///
2133 /// [`Self::adopt_journal`] states the storage property this rests on — *"the
2134 /// blob file is append-only and `gc` truncates nothing, so a retired pack's
2135 /// bytes are still exactly where the journal says they are"*. Every byte a
2136 /// snapshot covers is therefore immutable for the life of the file, so the
2137 /// workers below share one `&Mapped` and read it concurrently with no
2138 /// synchronisation of any kind. There is no mutex here; if one were needed
2139 /// the data model would be wrong.
2140 ///
2141 /// # 🚨 This is a fan-out inside the serving tier, and `crate::serve`'s
2142 /// header says that tier is serial
2143 ///
2144 /// It did, and the reason it gave is still true and still respected: the
2145 /// constellation's fan-out primitive has no reentrancy detection, so an
2146 /// unbounded fan-out per request inside an admission gate that already runs
2147 /// 32 transfers spawns W² threads. That is why this is **bounded twice**:
2148 ///
2149 /// * it does not fan out at all below [`FAN_OUT_AT`] entries, so every fetch
2150 /// small enough for thread-spawn to dominate runs on the calling thread
2151 /// exactly as before, and
2152 /// * it never exceeds [`MAX_RESOLVE_WORKERS`] (override with
2153 /// `ZNIPPY_GIT_EMIT_WORKERS`), so the worst case is 32 × 4 and not
2154 /// 32 × ncores.
2155 ///
2156 /// # What the fan-out is worth — stated honestly
2157 ///
2158 /// Resolving a mapped extent is a bounds check and a pointer, so the work
2159 /// this parallelises is **not** the resolve itself. It is the two things
2160 /// beside it: the first-touch **page fault** on each entry's header (the
2161 /// grammar is parsed here, which is what forces that fault, and it validates
2162 /// the entry before phase 2 commits a byte to the wire), and the `pread`
2163 /// fallback for any extent the mapping does not cover. On a warm page cache
2164 /// with the whole archive mapped, phase 1 is nearly free and the fan-out
2165 /// buys correspondingly little — the 20 % of cycles this change is aimed at
2166 /// is recovered by *not copying*, not by threads. I could not measure the
2167 /// fan-out's own contribution separately: oden was at loadavg 25.9 while
2168 /// this was written (2026-08-14), and a shared box cannot answer a question
2169 /// that fine.
2170 pub(crate) fn resolve_emit_payloads<'a>(
2171 &self,
2172 entries: &'a [crate::pack_walk::EmitEntry],
2173 snap: &'a crate::archive_map::Mapped,
2174 ) -> Result<Vec<std::borrow::Cow<'a, [u8]>>>
2175 where
2176 Self: Sync,
2177 {
2178 let workers = if entries.len() < FAN_OUT_AT {
2179 1
2180 } else {
2181 emit_workers()
2182 };
2183 self.resolve_with(entries, snap, workers)
2184 }
2185
2186 /// [`Self::resolve_emit_payloads`] with the worker count named rather than
2187 /// decided — `1` runs inline on the calling thread.
2188 ///
2189 /// Split out so the fan-out is **testable at a size a test fixture can
2190 /// reach**. The production threshold is 4096 entries and the corpus these
2191 /// guards run on holds 2687, so a test that went through the front door
2192 /// would exercise the serial arm every time and the gatling arm never;
2193 /// `the_fan_out_resolves_the_identical_bytes_the_serial_pass_does` calls
2194 /// this with 1 and with 4 over the same set and requires the two to agree
2195 /// byte for byte.
2196 pub(crate) fn resolve_with<'a>(
2197 &self,
2198 entries: &'a [crate::pack_walk::EmitEntry],
2199 snap: &'a crate::archive_map::Mapped,
2200 workers: usize,
2201 ) -> Result<Vec<std::borrow::Cow<'a, [u8]>>>
2202 where
2203 Self: Sync,
2204 {
2205 use znippy_zoomies::gatling_forkjoin::gatling_for_each;
2206
2207 let one = |i: usize| -> Result<std::borrow::Cow<'a, [u8]>> {
2208 let e = &entries[i];
2209 let bytes = match &e.stored {
2210 // The bytes live on the entry — the rebuilt-delta exception.
2211 // Borrowed, never cloned: `EntryBytes::Owned` is already the
2212 // only allocation this path makes and copying it would double it.
2213 crate::pack_walk::EntryBytes::Owned(v) => std::borrow::Cow::Borrowed(v.as_slice()),
2214 crate::pack_walk::EntryBytes::Extent { offset, len } => {
2215 self.extent(snap, *offset, *len)?
2216 }
2217 };
2218 // Parse the entry's own header now. Two things fall out: a malformed
2219 // entry is refused **before** phase 2 has written any of the pack,
2220 // and the first cache line of every entry is touched here — on
2221 // whichever worker got it — rather than one at a time on the serial
2222 // writer.
2223 crate::pack_walk::type_and_size_of(&bytes).with_context(|| {
2224 format!(
2225 "resolving the stored bytes of {} for emission",
2226 hex::encode(&e.oid)
2227 )
2228 })?;
2229 Ok(bytes)
2230 };
2231
2232 if workers <= 1 {
2233 return (0..entries.len()).map(one).collect();
2234 }
2235 gatling_for_each(entries.len(), workers, one)
2236 .into_iter()
2237 .collect()
2238 }
2239
2240 /// **Both phases, one call** — the only way a caller in this crate turns an
2241 /// ordered emit set into pack bytes.
2242 ///
2243 /// It is three lines, and it is a function rather than three lines because
2244 /// LAW 5's *fix by construction* applies exactly here: the snapshot has to
2245 /// outlive the slices taken from it, and a caller that took its own snapshot
2246 /// per entry, or dropped it between the phases, would be writing a pack out
2247 /// of a mapping that no longer exists. Routing `emit_oids` and every test
2248 /// through one writer makes that impossible to get wrong twice.
2249 pub(crate) fn emit_ordered(
2250 &self,
2251 ordered: &[crate::pack_walk::EmitEntry],
2252 out: &mut dyn std::io::Write,
2253 ) -> Result<crate::pack_walk::EmitReport>
2254 where
2255 Self: Sync,
2256 {
2257 let snap = self
2258 .archive_snapshot()
2259 .context("mapping the archive to emit")?;
2260 let payloads = self
2261 .resolve_emit_payloads(ordered, &snap)
2262 .context("resolving the emit set's stored bytes")?;
2263 crate::pack_walk::emit_pack(
2264 ordered,
2265 self.hash_kind(),
2266 out,
2267 &|i| Ok(payloads[i].as_ref()),
2268 )
2269 }
2270
2271 /// **The nearest ancestor of `from`'s stored delta chain that is inside the
2272 /// request**, or `None` when the chain leaves the request and never comes
2273 /// back.
2274 ///
2275 /// `from` is the archive offset of a base already known to be *outside* the
2276 /// request; `entry_at` is the offset of the entry that named it.
2277 ///
2278 /// # Why this cannot make a cycle, and why that is not a comment but an
2279 /// invariant
2280 ///
2281 /// The answer is required to satisfy `answer < entry_at`. In a well-formed
2282 /// pack a base always precedes the delta that names it, so every edge in the
2283 /// stored graph already points from a higher offset to a lower one; a new
2284 /// edge with the same property keeps the emitted graph a DAG **by
2285 /// construction**, whatever else the request contains. That matters because
2286 /// the obvious better candidate — the entry's own delta *children*, one
2287 /// revision away instead of two to nine — is exactly the set that would
2288 /// close a cycle: a child's stored base is this entry, so pointing this
2289 /// entry at the child makes `topological_order` unable to order either, and
2290 /// `emit_pack` refuses the set. Measured cost of the restriction on
2291 /// `h2h-linear-sha1-2048c-1024f-16k`: ~1 470 bytes per boundary entry
2292 /// against ~314 for the cyclic candidate, and 5 800 for shipping it whole.
2293 ///
2294 /// An `OFS_DELTA` decreases the offset every hop, so the bound is free
2295 /// there; a `REF_DELTA` names its base by oid and could point anywhere, so
2296 /// the comparison is made rather than assumed.
2297 ///
2298 /// # Cost
2299 ///
2300 /// One 64-byte `pread` per hop, no inflate, no allocation sized by an
2301 /// object — the same walk and the same ceiling as
2302 /// [`crate::serve::GitStore::resolved_type_at`], for the same reason: a
2303 /// pushed pack's back-references are not under this server's control, so a
2304 /// cycle must terminate rather than spin. Measured hop counts on the fixture
2305 /// above: 2 for 392 of the 859 that resolve, 3 for 260, and 9 at the worst.
2306 fn in_request_chain_ancestor(
2307 &self,
2308 from: u64,
2309 entry_at: u64,
2310 in_request: &HashMap<u64, usize>,
2311 ) -> Result<Option<u64>> {
2312 use crate::index_layout::{ObjType, ObjectIndex as _};
2313
2314 /// git's own `pack.depth` ceiling, doubled — the same bound
2315 /// `resolved_type_at` carries and for the same reason.
2316 const MAX_LINKS: usize = 100;
2317 /// Enough of an entry to read its type/size varint plus either an
2318 /// `OFS_DELTA` distance or a `REF_DELTA` oid.
2319 const HEADER_PROBE: u64 = 64;
2320
2321 let oid_len = self.hash_kind().oid_len();
2322 let mut at = from;
2323 for _ in 0..MAX_LINKS {
2324 if at != 0 && at < entry_at && in_request.contains_key(&at) {
2325 return Ok(Some(at));
2326 }
2327 if at == 0 {
2328 return Ok(None);
2329 }
2330 let head = self.read_extent(at, HEADER_PROBE)?;
2331 let (t, _, n) = crate::pack_walk::type_and_size_of(&head)?;
2332 at = match t {
2333 // A whole object with no base: the chain ends here, and it was
2334 // not in the request.
2335 ObjType::Commit | ObjType::Tree | ObjType::Blob | ObjType::Tag => {
2336 return Ok(None)
2337 }
2338 ObjType::OfsDelta => {
2339 let (distance, _) = crate::pack_walk::ofs_distance_of(&head[n..])?;
2340 match at.checked_sub(distance) {
2341 Some(next) if next != 0 => next,
2342 // A base before the start of the archive is a corrupt
2343 // back-reference. The whole rebuild is always a correct
2344 // answer, so this declines rather than failing a clone
2345 // over an entry it was only ever going to optimise.
2346 _ => return Ok(None),
2347 }
2348 }
2349 ObjType::RefDelta => {
2350 let Some(base_oid) = head.get(n..n + oid_len) else {
2351 return Ok(None);
2352 };
2353 match self.index().lookup(base_oid) {
2354 Some(row) => row.offset,
2355 None => return Ok(None),
2356 }
2357 }
2358 };
2359 }
2360 Ok(None)
2361 }
2362
2363 /// An `OFS_DELTA` pack entry carrying `d`, deflated.
2364 ///
2365 /// The distance written here is the **archive** distance, which is the same
2366 /// coordinate every stored entry's distance is in;
2367 /// [`crate::pack_walk::emit_pack`] rewrites it into output coordinates for
2368 /// every entry it emits, copied or not, so this only has to be well-formed
2369 /// and self-consistent — [`crate::pack_walk::header_len`] parses it back to
2370 /// find where the payload starts.
2371 ///
2372 /// `Compression::fast` for the same reason [`Self::whole_entry`] uses it,
2373 /// and the trade is far better here: the buffer being deflated is the delta,
2374 /// which on the measured fixture is ~1.4 KB against the object's 16 KiB, so
2375 /// this path deflates roughly a **tenth** of the bytes the whole rebuild it
2376 /// replaces does.
2377 fn ofs_delta_entry(d: &[u8], entry_at: u64, base_at: u64) -> Result<Vec<u8>> {
2378 use crate::index_layout::ObjType;
2379 use std::io::Write as _;
2380
2381 let distance = entry_at.checked_sub(base_at).ok_or_else(|| {
2382 anyhow!(
2383 "a computed delta at archive offset {entry_at} names a base at {base_at}, which \
2384 is after it — an ofs-delta distance is backwards and this would not encode"
2385 )
2386 })?;
2387 let mut out = Vec::with_capacity(d.len() / 2 + 32);
2388 crate::pack_walk::encode_type_and_size(&mut out, ObjType::OfsDelta, d.len() as u64);
2389 crate::pack_walk::encode_ofs_distance(&mut out, distance);
2390 let mut z = flate2::write::ZlibEncoder::new(out, flate2::Compression::fast());
2391 z.write_all(d)?;
2392 Ok(z.finish()?)
2393 }
2394
2395 /// **The objects the receiver already held before this transfer**, in both
2396 /// coordinate systems a delta can name a base in.
2397 ///
2398 /// `haves` is the negotiated common **tips**, exactly as
2399 /// [`git_storage_trait::GitServe::emit_pack`] defines them, and the closure
2400 /// over them is this store's own — the contract deliberately passes tips
2401 /// rather than the walk's exclusion set, because the closure is
2402 /// repository-sized and the engine can rebuild it from its own bitmaps.
2403 ///
2404 /// # This is a VOUCHER, and the caller has to be able to stand behind it
2405 ///
2406 /// Every object named here may be pointed at by a delta the pack does not
2407 /// carry. If the receiver turns out **not** to hold one, its
2408 /// `index-pack --fix-thin` dies with `pack has N unresolved deltas`, so a
2409 /// caller that cannot vouch must not pass `caps.thin`. The case that matters
2410 /// is a **partial clone**: a `blob:none` client's `have` tips reach blobs it
2411 /// was deliberately never sent, so the closure over-states what it holds and
2412 /// a filtered fetch must not be marked thin.
2413 ///
2414 /// # Cost
2415 ///
2416 /// One bitmap union plus one point lookup per held object, and it happens at
2417 /// most once per request — and only on a request that has a base outside
2418 /// itself to place. The `by_offset` map exists because an `OFS_DELTA` knows
2419 /// its base only as an archive offset; building it over what the *client*
2420 /// holds rather than over the repository is what keeps this off the
2421 /// whole-repository scan the closure used to do.
2422 ///
2423 /// **And it is spent in raw bytes now, end to end.** This used to ask
2424 /// [`GitOps::reachable`] — hex out of the ordinal space, `hex::decode`d
2425 /// straight back to bytes, then a third `to_vec` per object to key the
2426 /// offset map, three heap allocations per held object for a set the size of
2427 /// the client's history. It asks [`GitStore::reachable_raw`] instead: one
2428 /// buffer for the closure, one hash table of [`OidKey`]s over it, and
2429 /// nothing per object.
2430 fn client_bases(&self, haves: &[Oid<'_>]) -> Result<ExternalBases> {
2431 use crate::index_layout::ObjectIndex as _;
2432
2433 let held = self.reachable_raw(haves, &[]).context(
2434 "closing over the negotiated common tips, to learn which bases the client can supply \
2435 for itself",
2436 )?;
2437 let refs: Vec<&[u8]> = held.iter().collect();
2438 let rows = self.index().lookup_batch(&refs);
2439 let mut by_offset = HashMap::with_capacity(refs.len());
2440 let mut keys = std::collections::HashSet::with_capacity(refs.len());
2441 for (oid, row) in refs.iter().zip(rows.iter()) {
2442 let key = OidKey::new(oid)?;
2443 if let Some(row) = row {
2444 by_offset.insert(row.offset, key);
2445 }
2446 keys.insert(key);
2447 }
2448 Ok(ExternalBases {
2449 by_offset,
2450 held: keys,
2451 })
2452 }
2453
2454 /// The oid of the entry at `offset`, looked up **in the request** — which is
2455 /// the only place it can be, because this is called for a base the request
2456 /// was just shown to contain.
2457 ///
2458 /// Linear over the request rather than a map, because it runs only on the
2459 /// `ofs-delta`-less client path: a capability no git since 1.4.4 omits, and
2460 /// one that has to be *advertised absent* to reach here at all.
2461 fn oid_at_offset(
2462 &self,
2463 offset: u64,
2464 asked: &[&[u8]],
2465 rows: &[Option<crate::index_layout::IndexRow>],
2466 ) -> Result<Vec<u8>> {
2467 asked
2468 .iter()
2469 .zip(rows)
2470 .find(|(_, r)| r.as_ref().is_some_and(|r| r.offset == offset))
2471 .map(|(oid, _)| oid.to_vec())
2472 .ok_or_else(|| {
2473 anyhow!(
2474 "the entry at archive offset {offset} was checked to be in this request and \
2475 then could not be found in it"
2476 )
2477 })
2478 }
2479
2480 /// Re-head a stored `OFS_DELTA` as a `REF_DELTA` naming `base_oid`.
2481 ///
2482 /// The compressed delta stream is copied unchanged; only the header differs,
2483 /// because the two forms differ in **how the base is named** and in nothing
2484 /// else. This is why a client without `ofs-delta` costs bytes and not CPU.
2485 fn as_ref_delta(stored: &[u8], base_oid: &[u8]) -> Result<Vec<u8>> {
2486 use crate::index_layout::ObjType;
2487 let (t, stated_size, n) = crate::pack_walk::type_and_size_of(stored)?;
2488 if t != ObjType::OfsDelta {
2489 bail!("only an ofs-delta can be re-headed as a ref-delta, this entry is {t:?}");
2490 }
2491 let (_, d) = crate::pack_walk::ofs_distance_of(stored.get(n..).unwrap_or(&[]))?;
2492 let mut out = Vec::with_capacity(stored.len() + base_oid.len());
2493 crate::pack_walk::encode_type_and_size(&mut out, ObjType::RefDelta, stated_size);
2494 out.extend_from_slice(base_oid);
2495 out.extend_from_slice(stored.get(n + d..).unwrap_or(&[]));
2496 Ok(out)
2497 }
2498
2499 /// Re-head a stored `REF_DELTA` as an `OFS_DELTA` naming the base that sits
2500 /// at `base_at` — **the inverse of [`Self::as_ref_delta`]**, and the fix for
2501 /// the one pack shape gitoxide cannot read.
2502 ///
2503 /// The compressed delta stream is copied unchanged; only the header differs,
2504 /// because the two forms differ in how the base is *named* and in nothing
2505 /// else. The reason this has to exist is in the caller: a `REF_DELTA` whose
2506 /// base is inside the same pack is resolved by stock git and refused by
2507 /// every gix-based receiver.
2508 ///
2509 /// # The distance written here is a placeholder, and that is by design
2510 ///
2511 /// Exactly as [`Self::ofs_delta_entry`] documents: the distance an
2512 /// `OFS_DELTA` carries is relative to a position in the pack it is *in*, so
2513 /// [`crate::pack_walk::emit_pack`] re-encodes it for every entry from the
2514 /// output offsets it is assigning, and [`crate::pack_walk::header_len`]
2515 /// parses whatever is written here only to find where the payload starts. It
2516 /// therefore has to be well-formed and self-consistent, and nothing more.
2517 ///
2518 /// It cannot simply be `entry_at - base_at`: a `REF_DELTA` is allowed to
2519 /// name a base that comes **after** it in the pack, and `git index-pack
2520 /// --fix-thin` produces exactly that — it appends the base at the end. So a
2521 /// forward reference encodes as `1`, and `emit_pack` writes the real
2522 /// backwards distance once `topological_order` has put the base first.
2523 fn as_ofs_delta(
2524 stored: &[u8],
2525 oid_len: usize,
2526 entry_at: u64,
2527 base_at: u64,
2528 ) -> Result<Vec<u8>> {
2529 use crate::index_layout::ObjType;
2530 let (t, stated_size, n) = crate::pack_walk::type_and_size_of(stored)?;
2531 if t != ObjType::RefDelta {
2532 bail!("only a ref-delta can be re-headed as an ofs-delta, this entry is {t:?}");
2533 }
2534 let payload = stored.get(n + oid_len..).ok_or_else(|| {
2535 anyhow!(
2536 "a ref-delta entry at archive offset {entry_at} is {} bytes, which is not even its \
2537 header plus a {oid_len}-byte base oid",
2538 stored.len()
2539 )
2540 })?;
2541 let mut out = Vec::with_capacity(payload.len() + 32);
2542 crate::pack_walk::encode_type_and_size(&mut out, ObjType::OfsDelta, stated_size);
2543 crate::pack_walk::encode_ofs_distance(
2544 &mut out,
2545 entry_at.checked_sub(base_at).filter(|d| *d > 0).unwrap_or(1),
2546 );
2547 out.extend_from_slice(payload);
2548 Ok(out)
2549 }
2550
2551 /// A whole (non-delta) pack entry for `body`: type/size header, then the
2552 /// body deflated.
2553 ///
2554 /// The **only** place in this crate that deflates on a serving path, and the
2555 /// only reason it exists is a delta whose base the request does not contain.
2556 /// `Compression::fast` deliberately: these bytes are re-compressed because
2557 /// they *cannot* be copied, so the trade is wire size against a clone's
2558 /// latency, and the entries this runs on are a small boundary fraction of any
2559 /// real request.
2560 fn whole_entry(kind: crate::object::GitObjectKind, body: &[u8]) -> Result<Vec<u8>> {
2561 use std::io::Write as _;
2562 let mut out = Vec::with_capacity(body.len() / 2 + 32);
2563 crate::pack_walk::encode_type_and_size(
2564 &mut out,
2565 crate::serve::resolved_type(kind),
2566 body.len() as u64,
2567 );
2568 let mut z = flate2::write::ZlibEncoder::new(out, flate2::Compression::fast());
2569 z.write_all(body)?;
2570 Ok(z.finish()?)
2571 }
2572
2573 /// Take the absorb gate and hold it.
2574 ///
2575 /// The only way to observe "a read that arrived before the drain" as a
2576 /// **state** rather than as a race: with this held, the worker is parked at
2577 /// the top of its absorb, so the pack is provably durable, provably queued
2578 /// and provably not indexed. Its guard is in this module's tests, and nothing
2579 /// on a serving path takes it.
2580 #[cfg(test)]
2581 pub(crate) fn hold_absorb_gate(&self) -> std::sync::MutexGuard<'_, ()> {
2582 self.absorber.gate.lock().expect("absorb gate poisoned")
2583 }
2584
2585 /// `pread` an extent out of the verbatim archive, into a fresh `Vec`.
2586 ///
2587 /// **The fallback and the owning path.** A caller that can hold a borrow
2588 /// wants [`Self::archive_snapshot`] plus [`Self::extent`] instead: this one
2589 /// costs a syscall, an allocation and a kernel→user copy, which is the shape
2590 /// [`crate::archive_map`] exists to get off the emit path.
2591 pub(crate) fn read_extent(&self, offset: u64, len: u64) -> Result<Vec<u8>> {
2592 self.absorber.read_extent(offset, len)
2593 }
2594
2595 /// One mapping of the verbatim archive, to be taken **once per operation**
2596 /// and sliced N times. See [`crate::archive_map::ArchiveMap::snapshot`].
2597 pub(crate) fn archive_snapshot(&self) -> Result<Arc<crate::archive_map::Mapped>> {
2598 self.absorber.map.snapshot()
2599 }
2600
2601 /// **The one resolver**: an extent's bytes, borrowed from `snap` when it
2602 /// covers them and `pread` into a fresh buffer when it does not.
2603 ///
2604 /// `Cow::Borrowed` is the ordinary answer and the whole point — no syscall,
2605 /// no allocation, no copy, just a bounds-checked slice of the page cache.
2606 /// `Cow::Owned` happens for an extent past the mapped end, which means the
2607 /// blob file grew after the snapshot was taken (a push landed mid-clone).
2608 /// `Mapped::get` returning `None` is *"go and pread it"* and never *"there
2609 /// are no bytes"*, so the two arms return the **same bytes** and differ only
2610 /// in what they cost — which is the property
2611 /// `an_extent_past_the_mapping_falls_back_and_returns_the_same_bytes`
2612 /// asserts.
2613 pub(crate) fn extent<'m>(
2614 &self,
2615 snap: &'m crate::archive_map::Mapped,
2616 offset: u64,
2617 len: u64,
2618 ) -> Result<std::borrow::Cow<'m, [u8]>> {
2619 match snap.get(offset, len) {
2620 Some(b) => Ok(std::borrow::Cow::Borrowed(b)),
2621 None => Ok(std::borrow::Cow::Owned(self.read_extent(offset, len)?)),
2622 }
2623 }
2624
2625 /// Record a durable pack as pending index work.
2626 ///
2627 /// The **bit going clear**, and the ack path's last act before it returns.
2628 pub(crate) fn queue(&self, pack_id: u64, extent: Extent) -> Result<()> {
2629 self.absorber.queue(pack_id, extent)
2630 }
2631
2632 fn reach_bitmaps(&self) -> Result<Arc<Vec<ReachEntry>>> {
2633 self.absorber.reach_bitmaps()
2634 }
2635
2636 /// [`Absorber::reach_bitmaps_with`], for the differential guard.
2637 pub(crate) fn reach_bitmaps_with(
2638 &self,
2639 policy: crate::reach::ReachPolicy,
2640 cache: bool,
2641 ) -> Result<Arc<Vec<ReachEntry>>> {
2642 self.absorber.reach_bitmaps_with(policy, cache)
2643 }
2644
2645 /// [`Absorber::reach_tables_with`] — the reach table paired with its oid
2646 /// index, for the negotiation.
2647 pub(crate) fn reach_tables_with(
2648 &self,
2649 policy: crate::reach::ReachPolicy,
2650 cache: bool,
2651 ) -> Result<(Arc<Vec<ReachEntry>>, Arc<HashMap<String, u32>>)> {
2652 self.absorber.reach_tables_with(policy, cache)
2653 }
2654
2655 /// The commit oid set, raw, shared. See [`Derived::commit_raw`].
2656 pub(crate) fn commit_oids_raw(
2657 &self,
2658 ) -> Result<Option<Arc<std::collections::HashSet<Vec<u8>>>>> {
2659 self.absorber.commit_oids_raw()
2660 }
2661
2662 pub(crate) fn refold(&self) -> Result<()> {
2663 self.absorber.refold()
2664 }
2665}
2666
2667impl<S: ObjectIndex> Absorber<S> {
2668 /// `shared` is the writer's descriptor on the same file
2669 /// ([`crate::archive_write::ArchiveWrite::blobs_shared`]); `None` opens one,
2670 /// which is what a caller with no writer does.
2671 fn open(
2672 blobs: &Path,
2673 shared: Option<Arc<File>>,
2674 hash: GitHashKind,
2675 objects: ObjectReadStack<S>,
2676 exploded: Arc<ExplodedCache>,
2677 ) -> Result<Self> {
2678 let reader = match shared {
2679 Some(f) => f,
2680 None => Arc::new(
2681 File::open(blobs)
2682 .with_context(|| format!("opening {} for reads", blobs.display()))?,
2683 ),
2684 };
2685 let label = blobs
2686 .parent()
2687 .map(|p| p.display().to_string())
2688 .unwrap_or_else(|| blobs.display().to_string());
2689 let graph_cache = crate::arms::graph_cache_from_env()?;
2690 if !graph_cache {
2691 // A memo left by an earlier open with the cache on: this store keeps none.
2692 let stale = blobs.with_file_name(GRAPH_CACHE_FILE);
2693 match std::fs::remove_file(&stale) {
2694 Ok(()) => {}
2695 Err(e) if e.kind() == std::io::ErrorKind::NotFound => {}
2696 Err(e) => tracing::warn!(
2697 target: "znippy.git",
2698 path = %stale.display(),
2699 error = %e,
2700 "the graph cache is off but a stale objects.graph could not be removed"
2701 ),
2702 }
2703 }
2704 Ok(Self {
2705 blobs: blobs.to_path_buf(),
2706 reader,
2707 map: crate::archive_map::ArchiveMap::new(blobs),
2708 hash,
2709 objects,
2710 exploded,
2711 derived: RwLock::new(Derived::default()),
2712 graph_read: std::sync::atomic::AtomicU64::new(0),
2713 graph_recomputed: std::sync::atomic::AtomicU64::new(0),
2714 graph_cache: std::sync::atomic::AtomicBool::new(graph_cache),
2715 reach_carried: std::sync::atomic::AtomicU64::new(0),
2716 reach_rebuilt: std::sync::atomic::AtomicU64::new(0),
2717 ordinal_folded: std::sync::atomic::AtomicU64::new(0),
2718 ordinal_tail: std::sync::atomic::AtomicU64::new(0),
2719 packs: Mutex::new(PackState::default()),
2720 gate: Mutex::new(()),
2721 progress: crate::progress::IndexProgress::new(&label),
2722 cancel: std::sync::atomic::AtomicBool::new(false),
2723 label,
2724 watchdog: RwLock::new(crate::memguard::global()),
2725 scanned: Mutex::new(HashMap::new()),
2726 scan_build: Mutex::new(()),
2727 unindexable: Mutex::new(HashMap::new()),
2728 })
2729 }
2730
2731 /// **Tree payloads, on demand** — [`crate::reach::TreeSource`] over this
2732 /// store.
2733 ///
2734 /// One lookup per tree the walk actually visits, instead of a resident map
2735 /// of every tree in the repository. Where the bytes come from is
2736 /// [`Absorber::resolved`]'s business and nobody else's: the exploded cache
2737 /// if the tree is in it, its own delta chain out of the mmapped pack if it
2738 /// is not — and the read then writes it back, so a second walk finds it
2739 /// warm.
2740 ///
2741 /// It must not take the `derived` lock, and it does not: `resolved` reads
2742 /// the exploded pools, the `objects` index and the pending packs, none of
2743 /// which is `derived`. Both callers build one of these **inside** their
2744 /// `derived.write()` section, and that is only sound because of this
2745 /// sentence.
2746 fn tree_source(&self) -> TreesFromStore<'_, S> {
2747 TreesFromStore { abs: self }
2748 }
2749
2750 /// Packs whose objects are not in the index yet — §13.12's bit, counted.
2751 fn unindexed_packs(&self) -> usize {
2752 self.packs.lock().expect("pack state lock").unabsorbed
2753 }
2754
2755 /// **Index everything durable, here, now — the ack path's half of §13.9.**
2756 ///
2757 /// # The two hours, in one function
2758 ///
2759 /// MEASURED by lane P2 on the oden rig 2026-08-30. `git.receive_pack.checking`
2760 /// fired at 07:43:49; its very first `peel` of a pushed tip missed the
2761 /// exploded table and missed the `objects` index (the worker was minutes
2762 /// into a 13 948 244-object pack), and fell into [`Self::scan_pending`],
2763 /// which ran **a second, read-only, throw-away resolve of the whole 8.12 GiB
2764 /// pack on the connection thread**:
2765 ///
2766 /// ```text
2767 /// 09:20:21 index.scanned "a reader scanned a pending pack for itself:
2768 /// 13948244 objects in 5792442 ms"
2769 /// ```
2770 ///
2771 /// 1h36m32s on the 16 GB box and 1h44m14s on the 8 GB one, for rows it then
2772 /// threw away with the comment *"keeping them would be the index, and the
2773 /// worker is building that"*. That sentence is the defect: two resolvers
2774 /// over the same bytes, each holding its own O(pack) `PackWalk::entries` and
2775 /// oid table, on four vCPUs — which is also **why the watchdog paused**. The
2776 /// reader's second copy is what ate the `MemAvailable` the indexer tripped
2777 /// over, and neither pass ever finished the check.
2778 ///
2779 /// # Who may call this
2780 ///
2781 /// **The ack path, and nothing else.** It takes [`Absorber::gate`], so it
2782 /// waits for whoever is absorbing — and *"nobody waits on the indexer"* is a
2783 /// law with its own red test
2784 /// (`a_read_before_the_drain_is_served_from_the_pack_and_never_waits`): a
2785 /// clone, an `ls-remote`, a `control status` must be answered while the
2786 /// drain is parked, and they still are, through [`Self::scan_pending`].
2787 ///
2788 /// The connectivity check is the one caller for which that is the wrong
2789 /// trade. It has to prove that every object reachable from 2874 new tips is
2790 /// present, which means reading them; an entry's oid exists only once its
2791 /// delta chain has been applied; so the pack must be resolved before the
2792 /// check can answer, and the only question is whether it is resolved **once
2793 /// or twice**. This makes it once. `git receive-pack` makes the same choice
2794 /// and calls it `index-pack`.
2795 ///
2796 /// If the account worker already holds the gate, this blocks on it and then
2797 /// finds `is_absorbed` set and returns: whoever got there first did the work.
2798 ///
2799 /// Returns how many packs this call absorbed; `0` means it could not (it is
2800 /// nested inside an absorb of the only pending pack, or there was nothing
2801 /// to do).
2802 fn index_pending_now(&self) -> Result<usize> {
2803 if self.unindexed_packs() == 0 {
2804 return Ok(0);
2805 }
2806 // **Nested**: this thread is already inside `absorb_gated` and holds the
2807 // gate, so taking it again is a deadlock, not a wait. The other pending
2808 // packs are still ours to absorb inline — that is lane U's case, a thin
2809 // push whose base sits in a pack pushed a moment earlier — and the one
2810 // we are in the middle of is not.
2811 if let Some(current) = IN_ABSORB.with(|c| c.get()) {
2812 let jobs: Vec<PendingPack> = {
2813 let s = self.packs.lock().map_err(|_| anyhow!("pack state poisoned"))?;
2814 s.pending()
2815 };
2816 return self.absorb_each(&jobs, Some(current));
2817 }
2818 let _gate = self.gate.lock().map_err(|_| anyhow!("absorb gate poisoned"))?;
2819 let jobs: Vec<PendingPack> = {
2820 let s = self.packs.lock().map_err(|_| anyhow!("pack state poisoned"))?;
2821 s.pending()
2822 };
2823 // `absorb_gated` is a no-op for a pack somebody absorbed while we were
2824 // queued on the gate, so the loser of the race pays nothing.
2825 self.absorb_each(&jobs, None)
2826 }
2827
2828 /// **Absorb the pending packs only if nobody else is absorbing.**
2829 ///
2830 /// `Some(n)` = the gate was free and this caller did the work; `None` = the
2831 /// worker (or another reader) holds the gate — possibly paused by the
2832 /// memory watchdog for as long as the box is short — and this caller did
2833 /// **not** wait for it. Rickard's rule, 2026-08-30: *nobody waits on the
2834 /// indexer.* A read that needs the index now answers from the pack for
2835 /// itself ([`Self::scan_pending`]) and a read that needs the whole graph
2836 /// says so by name rather than blocking behind a kernel pack.
2837 fn try_absorb_pending(&self) -> Result<Option<usize>> {
2838 if self.unindexed_packs() == 0 {
2839 return Ok(Some(0));
2840 }
2841 let _gate = match self.gate.try_lock() {
2842 Ok(g) => g,
2843 Err(std::sync::TryLockError::WouldBlock) => return Ok(None),
2844 Err(std::sync::TryLockError::Poisoned(_)) => bail!("absorb gate poisoned"),
2845 };
2846 let jobs: Vec<PendingPack> = {
2847 let s = self
2848 .packs
2849 .lock()
2850 .map_err(|_| anyhow!("pack state poisoned"))?;
2851 s.pending()
2852 };
2853 self.absorb_each(&jobs, None).map(Some)
2854 }
2855
2856 /// **A read served from the pack on the reader's own request, never by
2857 /// waiting for the worker.**
2858 ///
2859 /// Every oid in `wants` is looked up in the `objects` table first — the
2860 /// rows the worker has already landed, batch by batch, are visible there
2861 /// with no lock in common with it. The ones still missing, if any pack is
2862 /// still un-indexed, are found by **resolving the pending packs read-only
2863 /// on this thread**: the same resolver the worker runs
2864 /// ([`crate::resolve::resolve_streaming`]), over the same mmapped bytes,
2865 /// with a bounded base set, but with **no sink, no gate and no rows
2866 /// written** — it produces rows for the caller and nothing else. The pass
2867 /// stops the moment every wanted oid has been seen.
2868 ///
2869 /// `capture` names one oid whose **content** the caller wants as well (a
2870 /// [`GitStore::content`] read); it rides through a
2871 /// [`crate::exploded::CaptureOne`] sink and comes back in the second slot.
2872 ///
2873 /// # Cost, stated
2874 ///
2875 /// An oid that is in a pending pack costs one read-only pass up to where it
2876 /// sits; an oid that is **absent** costs a full pass over every pending
2877 /// pack — for a kernel pack, minutes of one core. That is the price of
2878 /// never answering "absent" for an object whose bytes are durable, paid by
2879 /// the reader that asked and by nobody else. The rows it computes are not
2880 /// kept: keeping them would be the index, and the worker is building that.
2881 fn scan_pending(
2882 &self,
2883 wants: &[&[u8]],
2884 capture: Option<&[u8]>,
2885 ) -> Result<(Vec<Option<crate::index_layout::IndexRow>>, Option<(GitObjectKind, Vec<u8>)>)> {
2886 use crate::index_layout::IndexRow;
2887 let mut out: Vec<Option<IndexRow>> = vec![None; wants.len()];
2888 let mut missing: HashMap<&[u8], Vec<usize>> = HashMap::with_capacity(wants.len());
2889 for (i, w) in wants.iter().enumerate() {
2890 missing.entry(*w).or_default().push(i);
2891 }
2892 if missing.is_empty() && capture.is_none() {
2893 return Ok((out, None));
2894 }
2895 // **No nested BUILD.** The resolver asks this absorber (as its
2896 // `BaseSource`) for a thin pack's external base, and that base may
2897 // itself be un-indexed — a second *scan build* started from inside the
2898 // first, and a third from inside that, without end.
2899 //
2900 // The guard used to answer `None` outright when re-entered, and that
2901 // was wider than the recursion it was written for: a base sitting in
2902 // **another pack that is already scanned** is one binary search away,
2903 // and refusing it made a thin push on top of a just-acked one fail
2904 // `[remote rejected] … missing necessary objects` — lane U's rig
2905 // finding, 2026-08-30. So a nested call now consults the scans that
2906 // exist and builds none: a lookup terminates, a build is what does not.
2907 thread_local! { static SCANNING: std::cell::Cell<bool> = const { std::cell::Cell::new(false) }; }
2908 let nested = SCANNING.with(|s| s.get());
2909 struct Unset(bool);
2910 impl Drop for Unset {
2911 fn drop(&mut self) {
2912 if !self.0 {
2913 SCANNING.with(|s| s.set(false));
2914 }
2915 }
2916 }
2917 SCANNING.with(|s| s.set(true));
2918 let _unset = Unset(nested);
2919 let pending: Vec<PendingPack> = {
2920 let s = self
2921 .packs
2922 .lock()
2923 .map_err(|_| anyhow!("pack state poisoned"))?;
2924 s.pending()
2925 };
2926 if pending.is_empty() {
2927 return Ok((out, None));
2928 }
2929 let snap = self.map.snapshot()?;
2930 let mut content: Option<(GitObjectKind, Vec<u8>)> = None;
2931 for job in &pending {
2932 if missing.is_empty() && (capture.is_none() || content.is_some()) {
2933 break;
2934 }
2935 let scanned = match self.cached_scan(job.offset) {
2936 Some(s) => s,
2937 // Inside another scan: no build, so the recursion the guard
2938 // exists for cannot happen, and a pack nobody has scanned yet
2939 // is simply not consulted for this base.
2940 None if nested => continue,
2941 None => self.scanned_pack(&snap, job)?,
2942 };
2943 missing.retain(|oid, slots| match scanned.row(oid) {
2944 Some(r) => {
2945 for &i in slots.iter() {
2946 out[i] = Some(r.clone());
2947 }
2948 false
2949 }
2950 None => true,
2951 });
2952 if let Some(want) = capture
2953 && content.is_none()
2954 && let Some((entry, _)) = scanned.find(want)
2955 {
2956 let bytes: std::borrow::Cow<'_, [u8]> = match snap.get(job.offset, job.len) {
2957 Some(b) => std::borrow::Cow::Borrowed(b),
2958 None => std::borrow::Cow::Owned(self.read_extent(job.offset, job.len)?),
2959 };
2960 let sp = scanned.clone();
2961 let offset_of = move |oid: &[u8]| sp.find(oid).map(|(e, _)| sp.walk.entries[e].offset);
2962 content = Some(crate::resolve::materialize_entry(
2963 &bytes,
2964 &scanned.walk,
2965 entry,
2966 self.hash.oid_len(),
2967 &offset_of,
2968 self,
2969 )?);
2970 }
2971 }
2972 Ok((out, content))
2973 }
2974
2975 /// The scan of one pending pack **if it is already built** — a lookup, and
2976 /// nothing that could recurse. What a nested `scan_pending` is allowed.
2977 fn cached_scan(&self, offset: u64) -> Option<Arc<ScannedPack>> {
2978 self.scanned
2979 .lock()
2980 .unwrap_or_else(|e| e.into_inner())
2981 .get(&offset)
2982 .cloned()
2983 }
2984
2985 /// The scan of one pending pack: cached, or built now by one read-only
2986 /// pass (the same resolver, bounded bases, no sink, no rows written).
2987 fn scanned_pack(&self, snap: &crate::archive_map::Mapped, job: &PendingPack) -> Result<Arc<ScannedPack>> {
2988 if let Some(s) = self.scanned.lock().unwrap_or_else(|e| e.into_inner()).get(&job.offset) {
2989 return Ok(s.clone());
2990 }
2991 let _one_at_a_time = self.scan_build.lock().unwrap_or_else(|e| e.into_inner());
2992 if let Some(s) = self.scanned.lock().unwrap_or_else(|e| e.into_inner()).get(&job.offset) {
2993 return Ok(s.clone());
2994 }
2995 let t0 = std::time::Instant::now();
2996 let bytes: std::borrow::Cow<'_, [u8]> = match snap.get(job.offset, job.len) {
2997 Some(b) => std::borrow::Cow::Borrowed(b),
2998 None => std::borrow::Cow::Owned(self.read_extent(job.offset, job.len)?),
2999 };
3000 let walk = crate::pack_walk::walk(&bytes, self.hash.oid_len())?;
3001 let mut rows: Vec<(Vec<u8>, u32, u64)> = Vec::with_capacity(walk.entries.len());
3002 // A reader's own budget: a quarter of the worker's, no watchdog —
3003 // the pause is the worker's and only the worker's.
3004 let limits = crate::resolve::ResolveLimits {
3005 base_budget: (crate::resolve::base_budget_from_env() / 4).max(1),
3006 cancel: Some(&self.cancel),
3007 label: &self.label,
3008 ..crate::resolve::ResolveLimits::none()
3009 };
3010 // Entry index = position in offset order; the rows come out in
3011 // resolution order, so map offset → index by binary search.
3012 let report = crate::resolve::resolve_streaming(
3013 &bytes,
3014 &walk,
3015 self.hash,
3016 job.offset,
3017 self,
3018 &crate::exploded::NoSink,
3019 limits,
3020 &mut |batch| {
3021 for r in batch.drain(..) {
3022 let pack_off = r.offset - job.offset;
3023 let idx = walk
3024 .entries
3025 .binary_search_by_key(&pack_off, |e| e.offset)
3026 .map_err(|_| anyhow!("resolved row at {pack_off} has no walk entry"))?;
3027 rows.push((r.oid, idx as u32, r.uncompressed_size));
3028 }
3029 Ok(())
3030 },
3031 )
3032 .context("resolving a pending pack read-only for lookups")?;
3033 rows.sort_unstable_by(|a, b| a.0.cmp(&b.0));
3034 let scanned = Arc::new(ScannedPack {
3035 walk,
3036 rows,
3037 archive_offset: job.offset,
3038 });
3039 tracing::info!(
3040 target: "gunnar::index",
3041 event = "index.scanned",
3042 repo = %self.label,
3043 pack_id = job.pack_id,
3044 objects = scanned.rows.len(),
3045 reinflations = report.reinflations,
3046 elapsed_ms = t0.elapsed().as_millis() as u64,
3047 "a reader scanned a pending pack for itself: {} objects in {} ms",
3048 scanned.rows.len(),
3049 t0.elapsed().as_millis()
3050 );
3051 self.scanned
3052 .lock()
3053 .unwrap_or_else(|e| e.into_inner())
3054 .insert(job.offset, scanned.clone());
3055 Ok(scanned)
3056 }
3057
3058 /// **Drop everything this store holds that can be rebuilt** — what the
3059 /// watchdog's flush reaches: the readers' scanned packs (`scanned`, ~1.2
3060 /// GB on linux, rebuilt by the next lookup's pass) and the exploded
3061 /// table's oid tree and batch cache. The rows on disk are untouched.
3062 ///
3063 /// **Returns the rows it actually dropped**, and that number is the point.
3064 /// Lane P2's rig logged this event 190 and 627 times with
3065 /// `scanned_rows_dropped=0` on every single one and kept waiting anyway,
3066 /// because the caller could not tell a spill that freed a gigabyte from one
3067 /// that freed nothing. Three zeros in a row now end the pause
3068 /// ([`crate::memguard::PauseEnd::NothingToGive`]).
3069 ///
3070 /// The exploded table's own caches are an mmap index and a small batch
3071 /// cache; they are dropped here too and deliberately not counted, because
3072 /// they are not where a kernel-sized pack's memory is.
3073 fn spill(&self) -> u64 {
3074 let dropped = {
3075 let mut s = self.scanned.lock().unwrap_or_else(|e| e.into_inner());
3076 let n: usize = s.values().map(|p| p.rows.len()).sum();
3077 s.clear();
3078 n
3079 };
3080 self.exploded.drop_caches();
3081 tracing::info!(
3082 target: "gunnar::index",
3083 event = "index.spilled",
3084 repo = %self.label,
3085 scanned_rows_dropped = dropped,
3086 "the store dropped its rebuildable caches for the memory watchdog"
3087 );
3088 dropped as u64
3089 }
3090
3091 /// This store's watchdog (see the field).
3092 fn watchdog(&self) -> Arc<crate::memguard::MemWatchdog> {
3093 self.watchdog.read().unwrap_or_else(|e| e.into_inner()).clone()
3094 }
3095
3096 /// One oid, never waiting: the index, then the pending packs.
3097 fn lookup_never_wait(&self, oid: &[u8]) -> Result<Option<crate::index_layout::IndexRow>> {
3098 if let Some(r) = self.objects.lookup(oid) {
3099 return Ok(Some(r));
3100 }
3101 if self.unindexed_packs() == 0 {
3102 return Ok(None);
3103 }
3104 let (mut rows, _) = self.scan_pending(&[oid], None)?;
3105 Ok(rows.pop().flatten())
3106 }
3107
3108 /// Many oids, never waiting: one index pass, then one read-only pass over
3109 /// the pending packs for whatever the index did not have.
3110 fn lookup_batch_never_wait(&self, oids: &[&[u8]]) -> Result<Vec<Option<crate::index_layout::IndexRow>>> {
3111 let mut rows = self.objects.lookup_batch(oids);
3112 if self.unindexed_packs() == 0 || rows.iter().all(Option::is_some) {
3113 return Ok(rows);
3114 }
3115 let missing: Vec<&[u8]> = oids
3116 .iter()
3117 .zip(&rows)
3118 .filter(|(_, r)| r.is_none())
3119 .map(|(o, _)| *o)
3120 .collect();
3121 let (found, _) = self.scan_pending(&missing, None)?;
3122 let mut by_oid: HashMap<&[u8], crate::index_layout::IndexRow> = HashMap::with_capacity(found.len());
3123 for (o, r) in missing.iter().zip(found) {
3124 if let Some(r) = r {
3125 by_oid.insert(*o, r);
3126 }
3127 }
3128 for (o, slot) in oids.iter().zip(rows.iter_mut()) {
3129 if slot.is_none()
3130 && let Some(r) = by_oid.get(*o)
3131 {
3132 *slot = Some(r.clone());
3133 }
3134 }
3135 Ok(rows)
3136 }
3137
3138 /// The bit going clear: this pack is durable and its objects are not in.
3139 ///
3140 /// Skips a pack the drain already absorbed — the ack path queues *after* it
3141 /// has handed the extent to the channel, so the worker can legitimately be
3142 /// finished before this runs, and clearing a bit for a pack that is already
3143 /// indexed would leave it clear for ever.
3144 fn queue(&self, pack_id: u64, extent: Extent) -> Result<()> {
3145 let mut s = self
3146 .packs
3147 .lock()
3148 .map_err(|_| anyhow!("pack state poisoned"))?;
3149 s.note(pack_id, extent);
3150 Ok(())
3151 }
3152
3153 /// **The bit, derived from the two durable facts, on open.**
3154 ///
3155 /// `journal` is every row this archive's journal holds, in append order.
3156 /// [`acked_packs`](crate::archive_write::acked_packs) is what turns that into
3157 /// the packs: its index *is* the pack ordinal — dense by construction, and
3158 /// re-derived the same way by every later open. For each one, the question is
3159 /// only *does this pack have any rows in the index*, which
3160 /// [`ObjectReadStack::extents_with_rows`] answers in one early-terminating
3161 /// scan rather than per pack.
3162 ///
3163 /// Returns the packs whose bit came up **clear**: durable bytes, no rows. The
3164 /// caller re-queues them on the account's channel, which is what makes a
3165 /// pack that was mid-absorb when the process died get absorbed by the next
3166 /// one instead of being durable-but-invisible for ever.
3167 ///
3168 /// The verbatim extents are also handed to [`Derived::packs`] — *all* of
3169 /// them, not only the unabsorbed ones. That is what lets [`BaseSource`]
3170 /// re-derive a delta base's content from the truth after a restart; without
3171 /// it a reopened store knows the rows of a pack it can no longer find the
3172 /// bytes of.
3173 ///
3174 /// # The one case where "no rows" does not mean "never absorbed" — and the
3175 /// third durable fact that now tells them apart
3176 ///
3177 /// [`GitOps::gc`] is the only thing that removes rows. A pack **all** of
3178 /// whose objects it finds dead therefore ends with a journal extent and no
3179 /// rows, which is byte for byte the state a pack that was in flight when the
3180 /// machine died leaves behind. This diff cannot tell them apart, and it must
3181 /// not guess: re-queueing the first resurrects every dead object, and *not*
3182 /// re-queueing the second loses a pack whose bytes were acked.
3183 ///
3184 /// So `gc` says which it is, durably, before it drops a row:
3185 /// [`retire_packs`](crate::archive_write::retire_packs) appends a tombstone
3186 /// naming the retired pack's offset, and a pack named by one is never
3187 /// re-queued here. The bit is still derived from durable facts only — there
3188 /// are now three of them (the journal's pack rows, the journal's tombstones,
3189 /// the index's rows) and none of them is a cache of another.
3190 ///
3191 /// A **partly** dead pack is not tombstoned and still has rows, so it takes
3192 /// the `absorbed` branch exactly as it always did.
3193 ///
3194 /// A tombstoned pack that *does* still have rows is a `gc` that was killed
3195 /// between the tombstone and the drop. It is treated as absorbed, which is
3196 /// what its rows say: nothing is lost, and the next `gc` finishes the job.
3197 ///
3198 /// Its extent still goes to [`Derived::packs`] either way. The blob file is
3199 /// append-only and `gc` truncates nothing, so a retired pack's bytes are
3200 /// still exactly where the journal says they are — and a live object may
3201 /// legitimately be a delta against a base that is itself unreachable, so
3202 /// dropping the extent from that list would break the resolve rather than
3203 /// tidy it.
3204 ///
3205 /// # The second durable fact: §14's exploded table
3206 ///
3207 /// A pack counts as absorbed only if the exploded table is **whole**, which
3208 /// is `exploded.rows() >= objects.len()` — one row per object, because §14's
3209 /// table is eager and skips nothing. If it is short, the table has been
3210 /// dropped (or a process died between the two commits) and **no** pack counts
3211 /// as absorbed: every one is re-queued and re-exploded from the verbatim
3212 /// truth. That is the whole of "droppable": deleting the file is a supported
3213 /// operation whose only cost is one re-ingest, and §13.12's rule holds
3214 /// unchanged over it — absent means fall back, never means wrong.
3215 ///
3216 /// `>=` and not `==` on purpose. A resolve that failed part way leaves rows
3217 /// for the objects it got to, and a `gc` retires both tables together, so the
3218 /// table can legitimately hold *more* than the index names; only being
3219 /// **short** is evidence of a gap.
3220 fn adopt_journal(&self, journal: &[Extent]) -> Result<Vec<PendingPack>> {
3221 if journal.is_empty() {
3222 return Ok(Vec::new());
3223 }
3224 // The packs, in ordinal order, and the offsets a `gc` retired. A
3225 // tombstone is a row and not a pack, so it holds no ordinal.
3226 let packs = crate::archive_write::acked_packs(journal);
3227 let retired = crate::archive_write::retired_offsets(journal);
3228 if packs.is_empty() {
3229 return Ok(Vec::new());
3230 }
3231 // Under `Graph` the table is short **by design** — commits and trees
3232 // only — so the row-count comparison would call every store dropped and
3233 // re-queue every pack on every open. It is weakened to "not empty",
3234 // which still catches the case this rule exists for (the file deleted),
3235 // and is stated rather than hidden: making it exact needs a durable
3236 // commit-and-tree count, which the index does not publish today.
3237 // Only `Full` explodes one row per object, so only `Full` can compare
3238 // counts. Under `Commits` (the shipped default) and `Graph` the eager
3239 // pool is short **by design**, and the comparison would call every store
3240 // dropped and re-queue every pack on every open — a Linux-sized re-index
3241 // per restart. The weakened test still catches what the rule exists for
3242 // (the file deleted) and is stated rather than hidden: making it exact
3243 // needs a durable per-kind count, which the index does not publish.
3244 //
3245 // The LAZY pool is deliberately not consulted. Its size is a function of
3246 // what has been READ, so it says nothing about whether a pack was
3247 // absorbed, and an eviction must never look like a lost index.
3248 let exploded_is_whole = match self.exploded.policy() {
3249 crate::exploded_arrow::ExplodePolicy::Full => {
3250 self.exploded.eager_rows()? >= self.objects.len() as u64
3251 }
3252 crate::exploded_arrow::ExplodePolicy::Off => true,
3253 _ => self.objects.len() == 0 || self.exploded.eager_rows()? > 0,
3254 };
3255 let has_rows = if exploded_is_whole {
3256 self.objects.extents_with_rows(&packs)?
3257 } else {
3258 vec![false; packs.len()]
3259 };
3260 {
3261 let mut d = self
3262 .derived
3263 .write()
3264 .map_err(|_| anyhow!("derived poisoned"))?;
3265 d.packs = packs.clone();
3266 }
3267 let mut s = self
3268 .packs
3269 .lock()
3270 .map_err(|_| anyhow!("pack state poisoned"))?;
3271 let mut requeue = Vec::new();
3272 for (i, (&extent, &absorbed)) in packs.iter().zip(&has_rows).enumerate() {
3273 let pack_id = i as u64;
3274 if absorbed {
3275 s.mark_absorbed(pack_id, extent);
3276 } else if retired.contains(&extent.0) {
3277 // A `gc` dropped every row this pack had and said so durably
3278 // *before* dropping them. There is no index work owed for it,
3279 // ever: re-queueing it is precisely how its dead objects would
3280 // come back. The bit goes **up** rather than being left clear,
3281 // because a clear bit is what makes a read fall back to
3282 // absorbing — which is the same resurrection by another door.
3283 s.mark_absorbed(pack_id, extent);
3284 } else {
3285 s.note(pack_id, extent);
3286 requeue.push(PendingPack {
3287 pack_id,
3288 offset: extent.0,
3289 len: extent.1,
3290 resumed: true,
3291 });
3292 }
3293 }
3294 Ok(requeue)
3295 }
3296
3297 /// **The indexer's half of the split**, and not one of the twelve.
3298 ///
3299 /// Reads each pending pack's verbatim bytes back out of the archive,
3300 /// resolves them to oids ([`crate::resolve`]), appends the rows to the
3301 /// `objects` table and re-folds the derived tables. This is what §13.9-12
3302 /// puts behind the channel; it runs after the ack, never before one.
3303 ///
3304 /// Two callers, one function: the account indexer's worker (through
3305 /// [`ObjectAbsorb`]) and a read that arrived before that worker did. The
3306 /// second is §13.12's fallback in its literal form — *slower, never wrong*.
3307 fn absorb_pending(&self) -> Result<usize> {
3308 // Nothing to do, and — this is the point — **no gate taken**: the common
3309 // case is a store whose drain has kept up, and it must not queue behind
3310 // one that is running.
3311 if self.unindexed_packs() == 0 {
3312 return Ok(0);
3313 }
3314 let _gate = self
3315 .gate
3316 .lock()
3317 .map_err(|_| anyhow!("absorb gate poisoned"))?;
3318 let jobs: Vec<PendingPack> = {
3319 let s = self
3320 .packs
3321 .lock()
3322 .map_err(|_| anyhow!("pack state poisoned"))?;
3323 s.pending()
3324 };
3325 self.absorb_each(&jobs, None)
3326 }
3327
3328 /// **Every pack it can, skipping the ones it has already given up on.**
3329 ///
3330 /// The one loop all four absorb entry points run (LAW 5): they were four
3331 /// copies of `for job in &jobs { self.absorb_gated(job)?; }`, and that `?`
3332 /// is the bug this function exists to remove. Two rules, and both are
3333 /// consequences of the same sentence — *work that can never succeed must
3334 /// stop and say why*:
3335 ///
3336 /// 1. **A failure does not abandon the packs behind it.** The loop runs to
3337 /// the end and reports the FIRST failure afterwards, so a pack that
3338 /// cannot be indexed no longer stops the push that arrived after it from
3339 /// being indexed and acked.
3340 /// 2. **A pack that has been given up on is not attempted again.** After
3341 /// [`MAX_ABSORB_ATTEMPTS`] it is recorded in
3342 /// [`Absorber::unindexable`] with the reason, logged once as
3343 /// `index.unindexable`, and skipped from then on. Its objects are then
3344 /// genuinely absent from the index, which every read path already knows
3345 /// how to say — a push that needs one is refused by name at
3346 /// `external_bases_exist`, and a clone that needs one fails the
3347 /// connectivity check. What no longer happens is the store re-resolving
3348 /// it on every request for the rest of the process's life.
3349 ///
3350 /// `skip` is the pack this thread is standing inside an absorb of
3351 /// ([`IN_ABSORB`]).
3352 fn absorb_each(&self, jobs: &[PendingPack], skip: Option<u64>) -> Result<usize> {
3353 let mut absorbed = 0usize;
3354 let mut first: Option<anyhow::Error> = None;
3355 for job in jobs {
3356 if skip == Some(job.pack_id) || self.given_up_on(job.pack_id) {
3357 continue;
3358 }
3359 match self.absorb_gated(job) {
3360 Ok(()) => absorbed += 1,
3361 Err(e) => {
3362 // Cancellation is the repository being deleted: there is no
3363 // queue left worth draining and nothing to record.
3364 if self.cancel.load(std::sync::atomic::Ordering::Relaxed) {
3365 return Err(e);
3366 }
3367 self.note_absorb_failure(job, &e);
3368 if first.is_none() {
3369 first = Some(e);
3370 }
3371 }
3372 }
3373 }
3374 match first {
3375 None => Ok(absorbed),
3376 Some(e) => Err(e),
3377 }
3378 }
3379
3380 /// Every pack this store has given up on, ordinal order.
3381 fn unindexable_packs(&self) -> Vec<Unindexable> {
3382 let mut v: Vec<Unindexable> = self
3383 .unindexable
3384 .lock()
3385 .unwrap_or_else(|e| e.into_inner())
3386 .values()
3387 .cloned()
3388 .collect();
3389 v.sort_by_key(|u| u.pack_id);
3390 v
3391 }
3392
3393 /// Has this store stopped trying to index that pack?
3394 fn given_up_on(&self, pack_id: u64) -> bool {
3395 self.unindexable
3396 .lock()
3397 .unwrap_or_else(|e| e.into_inner())
3398 .contains_key(&pack_id)
3399 }
3400
3401 /// Count one failed absorb, and stop at [`MAX_ABSORB_ATTEMPTS`].
3402 ///
3403 /// The reason recorded is `root_cause`, not the outermost wrapper: that is
3404 /// the sentence the backend actually has to offer, and lane Z's rule is that
3405 /// the client gets it verbatim rather than a layer's paraphrase of it.
3406 fn note_absorb_failure(&self, job: &PendingPack, err: &anyhow::Error) {
3407 let giving_up;
3408 {
3409 let mut map = self.unindexable.lock().unwrap_or_else(|e| e.into_inner());
3410 // A pack already given up on is not attempted, so an entry here is
3411 // always a fresh count.
3412 let e = map.entry(job.pack_id).or_insert_with(|| Unindexable {
3413 pack_id: job.pack_id,
3414 extent: (job.offset, job.len),
3415 attempts: 0,
3416 reason: String::new(),
3417 });
3418 e.attempts += 1;
3419 e.reason = format!("{}", err.root_cause());
3420 if e.attempts < MAX_ABSORB_ATTEMPTS {
3421 let attempts = e.attempts;
3422 map.remove(&job.pack_id);
3423 tracing::warn!(
3424 target: "znippy.git",
3425 store = %self.label,
3426 pack = job.pack_id,
3427 attempts,
3428 max = MAX_ABSORB_ATTEMPTS,
3429 error = %err.root_cause(),
3430 "a pack could not be indexed; it stays pending and will be tried again"
3431 );
3432 return;
3433 }
3434 giving_up = Some(e.clone());
3435 }
3436 if let Some(u) = giving_up {
3437 tracing::error!(
3438 target: "znippy.git",
3439 store = %self.label,
3440 event = "index.unindexable",
3441 pack = u.pack_id,
3442 offset = u.extent.0,
3443 len = u.extent.1,
3444 attempts = u.attempts,
3445 error = %u.reason,
3446 "this store has STOPPED trying to index this pack after {} attempts. Its bytes \
3447 are durable and untouched, and every object it introduced is absent from the \
3448 index — a push that deltas against one is refused by name and a clone that \
3449 needs one fails its connectivity check, both immediately. Nothing will retry \
3450 it: re-push the pack, or delete and re-create the repository.",
3451 u.attempts
3452 );
3453 }
3454 }
3455
3456 /// One pack, **with [`Absorber::gate`] already held**.
3457 ///
3458 /// The order at the end is the correctness argument: the rows are in the
3459 /// index *before* the bit is cleared. A read that finds the bit still clear
3460 /// blocks on the gate and then finds the rows; a read that finds it set finds
3461 /// the rows too. There is no interleaving in which a durable object answers
3462 /// "absent" — which during negotiation would make a client withhold objects
3463 /// and lose data.
3464 fn absorb_gated(&self, job: &PendingPack) -> Result<()> {
3465 if self.cancel.load(std::sync::atomic::Ordering::Relaxed) {
3466 // The repository is being deleted: no pack still queued is worth a
3467 // byte of work, and the drain must get through its queue fast so
3468 // the store can be dropped and the directory removed.
3469 return Err(crate::resolve::ResolveError::cancelled());
3470 }
3471 {
3472 let s = self
3473 .packs
3474 .lock()
3475 .map_err(|_| anyhow!("pack state poisoned"))?;
3476 if s.is_absorbed(job.pack_id) {
3477 // Already in, by whoever reached it first. Re-resolving is now
3478 // *correct* — the exploded table is keyed by oid and the graph is
3479 // folded from it rather than pushed at, so a second absorb of one
3480 // pack changes nothing (that idempotence is what makes dropping
3481 // the table and re-queueing every pack a safe operation). It is
3482 // still a whole pack re-read, re-inflated and re-hashed for
3483 // nothing, so it is skipped.
3484 return Ok(());
3485 }
3486 }
3487 // From here to the end of `absorb_one` this thread holds the gate, and
3488 // the resolver is about to ask this same store for delta bases. See
3489 // [`IN_ABSORB`]: the re-entry must not take the gate again and must not
3490 // try to absorb the pack it is standing in.
3491 let _in = InAbsorb::enter(job.pack_id);
3492 self.absorb_one(job).map_err(|e| {
3493 // The entry stays pending by construction — it was never removed —
3494 // so the bytes are durable, the pack is still un-indexed, and reads
3495 // keep falling back rather than answering absent.
3496 e.context(format!(
3497 "absorbing pack {} at ({}, {}) — its bytes are durable and it stays \
3498 un-indexed; reads will keep falling back rather than answer absent",
3499 job.pack_id, job.offset, job.len
3500 ))
3501 })?;
3502 let mut s = self
3503 .packs
3504 .lock()
3505 .map_err(|_| anyhow!("pack state poisoned"))?;
3506 s.mark_absorbed(job.pack_id, (job.offset, job.len));
3507 drop(s);
3508 // The index answers for it now; the reader's scan is dead weight.
3509 self.scanned.lock().unwrap_or_else(|e| e.into_inner()).remove(&job.offset);
3510 Ok(())
3511 }
3512
3513 /// One pack: verbatim bytes in, `objects` rows **and** §14's exploded rows
3514 /// out, from **one** walk and **one** resolve.
3515 ///
3516 /// The exploded rows are not a second pass and not a second resolver (LAW 5):
3517 /// [`crate::resolve::resolve_walked`] hands every object it produces to the
3518 /// sink as it produces it, including the blob payloads it is about to drop,
3519 /// so the side table falls out of the pass that was already being made.
3520 ///
3521 /// Ordering is the correctness argument, and it is the same one the drain
3522 /// makes one level up: **the exploded rows are committed before the fold that
3523 /// reads them**, and the fold runs before this returns, so there is no
3524 /// interleaving in which the graph is folded over a table that does not yet
3525 /// hold this pack's commits.
3526 fn absorb_one(&self, job: &PendingPack) -> Result<()> {
3527 let t0 = std::time::Instant::now();
3528 self.progress.begin(job.pack_id, job.len, job.resumed);
3529 // **A live row every 10 s for as long as this pack takes**, carrying
3530 // `peak_rss` and the re-inflation count. Those two rode only on
3531 // `index.finished`, so lane P2's two rig boxes — which ran for 2h14m
3532 // and 2h12m and never finished a pack — produced neither, in exactly
3533 // the failure they were built for. The ticker is a thread and not a
3534 // hook inside the resolve loop on purpose: it prints while the resolver
3535 // is PAUSED too, which is when an operator most needs it.
3536 let _tick = crate::progress::ProgressTicker::start(self.progress.clone());
3537 let result = self.absorb_one_inner(job, t0);
3538 self.progress.sample_memory();
3539 self.progress.finish();
3540 result
3541 }
3542
3543 /// The body of [`absorb_one`](Self::absorb_one), so `finish` runs on every
3544 /// exit and the progress row never sticks at 99 %.
3545 fn absorb_one_inner(&self, job: &PendingPack, t0: std::time::Instant) -> Result<()> {
3546 use crate::progress::Phase;
3547 let progress = &self.progress;
3548 // **The pack is read where it already is.** `read_extent` was a
3549 // `pread` of the whole extent into a fresh `Vec` — 8.12 GiB of
3550 // anonymous heap for torvalds/linux, before one byte was inflated, on a
3551 // 16 GB box. The mapping costs nothing the kernel cannot reclaim
3552 // ([`crate::archive_map`]), and `MemAvailable` — what the watchdog
3553 // reads — knows that.
3554 let snap = self.map.snapshot()?;
3555 let bytes: std::borrow::Cow<'_, [u8]> = match snap.get(job.offset, job.len) {
3556 Some(b) => std::borrow::Cow::Borrowed(b),
3557 // Past the mapping: the file grew after the snapshot. Same bytes,
3558 // one `pread` — the exception, not the shape.
3559 None => std::borrow::Cow::Owned(self.read_extent(job.offset, job.len)?),
3560 };
3561 progress.set_phase(Phase::Walk);
3562 let walked = crate::pack_walk::walk(&bytes, self.hash.oid_len())?;
3563 let t_walk = t0.elapsed();
3564 let dog = self.watchdog();
3565 let spill = || self.spill();
3566 let limits = crate::resolve::ResolveLimits::for_indexer(
3567 &self.label,
3568 &self.cancel,
3569 progress,
3570 dog,
3571 &spill,
3572 );
3573 let mut batches = 0u64;
3574 let mut appended = 0u64;
3575 let mut entries: Vec<crate::index_layout::IndexEntry> = Vec::with_capacity(limits.row_batch);
3576 let report = crate::resolve::resolve_streaming(
3577 &bytes,
3578 &walked,
3579 self.hash,
3580 job.offset,
3581 self,
3582 &*self.exploded,
3583 limits,
3584 &mut |rows| {
3585 // **One batch of rows lands, then the next.** The exploded
3586 // tier already flushed itself every 64 MiB; the index rows
3587 // used to wait for the whole pack. Now the batch is the unit:
3588 // rows go to the `objects` table as they are produced, and the
3589 // pack's own "indexed" bit still goes up only after the LAST
3590 // batch — `mark_absorbed` is the caller's, after this returns.
3591 entries.clear();
3592 entries.extend(rows.iter().map(|r| r.index_entry()));
3593 rows.clear();
3594 self.objects.append(&entries)?;
3595 appended += entries.len() as u64;
3596 batches += 1;
3597 Ok(())
3598 },
3599 )?;
3600 drop(entries);
3601 let t_resolve = t0.elapsed() - t_walk;
3602 progress.set_phase(Phase::Flush);
3603 // Down before anything folds over it.
3604 self.exploded.flush()?;
3605
3606 {
3607 let mut d = self
3608 .derived
3609 .write()
3610 .map_err(|_| anyhow!("derived poisoned"))?;
3611 // A reopen already listed every acked extent (`adopt_journal`), so
3612 // this is the first absorb of a pack pushed in *this* process — or a
3613 // re-queued one that is already listed. `find` is what reads this
3614 // list, so a duplicate would not be wrong, only unbounded.
3615 if !d.packs.contains(&(job.offset, job.len)) {
3616 d.packs.push((job.offset, job.len));
3617 }
3618 }
3619 progress.set_phase(Phase::Fold);
3620 let t_fold0 = std::time::Instant::now();
3621 // The graph and the tree payloads are folded from the exploded table, not
3622 // pushed at from here. That is what makes a re-absorb idempotent — which
3623 // it has to be, because dropping the table re-queues every pack.
3624 self.refold()?;
3625 let _ = self.objects.maybe_rebuild()?;
3626 let t_fold = t_fold0.elapsed();
3627 // **The audit line**: every number is applied output of this absorb.
3628 // `peak_rss` is the process's VmHWM off /proc/self/status — the high
3629 // water mark of the whole server, which on the appliance is the box.
3630 tracing::info!(
3631 target: "gunnar::index",
3632 event = "index.finished",
3633 repo = %self.label,
3634 pack_id = job.pack_id,
3635 pack_bytes = job.len,
3636 peak_rss = crate::memguard::peak_rss_bytes(),
3637 mem_available = self.watchdog().available().unwrap_or(0),
3638 objects = report.rows,
3639 batches = batches,
3640 rows_appended = appended,
3641 reinflations = report.reinflations,
3642 evictions = report.evictions,
3643 watchdog_drops = report.watchdog_drops,
3644 peak_base_bytes = report.peak_base_bytes,
3645 pauses = report.pauses,
3646 paused_ms = report.paused_ms,
3647 walk_ms = t_walk.as_millis() as u64,
3648 resolve_ms = t_resolve.as_millis() as u64,
3649 fold_ms = t_fold.as_millis() as u64,
3650 total_ms = t0.elapsed().as_millis() as u64,
3651 resumed = job.resumed,
3652 "indexed {} objects in {} batches: walk {} ms, resolve {} ms, fold {} ms; peak bases {}, {} evictions, {} re-inflations, {} pauses ({} ms); peak rss {}",
3653 report.rows,
3654 batches,
3655 t_walk.as_millis(),
3656 t_resolve.as_millis(),
3657 t_fold.as_millis(),
3658 crate::memguard::fmt_bytes(report.peak_base_bytes),
3659 report.evictions,
3660 report.reinflations,
3661 report.pauses,
3662 report.paused_ms,
3663 crate::memguard::fmt_bytes(crate::memguard::peak_rss_bytes())
3664 );
3665 Ok(())
3666 }
3667
3668 /// Recompute everything derived from the object set: the commit graph, the
3669 /// tree payloads, the ordinal space, the generation numbers, and (lazily) the
3670 /// bitmaps.
3671 ///
3672 /// **The graph is folded from §14's exploded table, not accumulated.** That
3673 /// is the whole fix for the clean-reopen hole: commit and tree payloads are
3674 /// on disk, so this call produces the same graph after a restart as before
3675 /// one, and it is called at the end of [`GitStore::open_with_arms`] for
3676 /// exactly that reason. It also makes a re-absorb idempotent — the old
3677 /// accumulate-into-a-`Vec` shape doubled every commit if a pack was absorbed
3678 /// twice, which is why dropping the table and re-queueing everything was not
3679 /// a safe operation before this.
3680 ///
3681 /// **Generations are stored and must be recomputed in any fold** (§13,
3682 /// decided). A generation number is `1 + max(parents)`, so it is invalidated
3683 /// the moment history's shape changes — which is exactly what absorbing a
3684 /// pack does. [`assign_generations`] is the one writer of that number and it
3685 /// is called here, over the whole graph, rather than incrementally: an
3686 /// incremental update would have to know which descendants moved, and being
3687 /// wrong about that produces an ancestry cutoff that skips real ancestors.
3688 ///
3689 /// # Cost
3690 ///
3691 /// One range scan of the exploded table's commits and one of its trees, per
3692 /// absorbed pack. It is the same order as the `tail_oids` scan below, which
3693 /// this function already made on every absorb, and it reads **no blob
3694 /// payload** — that is what the kind index in
3695 /// [`crate::exploded`] is for.
3696 ///
3697 /// ## And that order is the whole repository, on every push
3698 ///
3699 /// Said plainly, because "the same order as the scan below" reads like a
3700 /// reassurance and is not one: **nothing here is proportional to the push.**
3701 /// Every call rebuilds every tree payload, every commit node, every
3702 /// generation number, a `HashMap<String, u32>` over every oid in the
3703 /// repository and a sorted `Vec<String>` of the same — for a push of one
3704 /// commit exactly as for a push of ten thousand.
3705 ///
3706 /// MEASURED on oden 2026-08-11, release, quiet box (`some avg10` 0.00). The
3707 /// **same** 100-commit increment, pushed onto the same history seeded to
3708 /// four different depths, server CPU for the push:
3709 ///
3710 /// | objects already in the repository | CPU |
3711 /// |---:|---:|
3712 /// | 9 614 | 0.12 s |
3713 /// | 35 350 | 0.23 s |
3714 /// | 103 988 | 0.45 s |
3715 /// | 206 925 | 0.77 s |
3716 ///
3717 /// That is a straight line: **≈88 ms fixed, plus ≈3.3 µs per object already
3718 /// stored**, and the fit predicts the four points to within 20 ms. It is
3719 /// also why a push is slower than the ack path suggests — §13.9 puts the
3720 /// index behind a channel, but `put_refs` checks every ref target with
3721 /// `has`, `has` calls `lookup_one`, and `lookup_one` absorbs pending packs
3722 /// first. The drain is off the *ack* and squarely on the *push*.
3723 ///
3724 /// This is not fixed here and the numbers are recorded so the next attempt
3725 /// starts from them rather than from a guess. The obvious lever — fold
3726 /// incrementally — is the one the paragraph above rules out for
3727 /// generations, so it needs its own argument and its own gate.
3728 fn refold(&self) -> Result<()> {
3729 // Everything derived is computed **before** the write lock, which is then
3730 // held only for the swap: the fold is the long part and nothing that
3731 // reads `derived` should queue behind it.
3732 //
3733 // Ordinals first — **read, not re-scanned, when the tail has not moved.**
3734 // S-082's fix, mirroring the commit-graph memo one paragraph down:
3735 // `objects.ordinal` beside the pack holds `oids_raw` (every oid in the
3736 // store, in ordinal = sorted-raw order), and a cold open reads its couple
3737 // of megabytes back sequentially in milliseconds instead of walking the
3738 // whole redb B-tree — REFOLD measured that scan at ~65% (0.45 s) of a
3739 // 136k-object reopen, and proved a flat buffer measured the same, so the
3740 // cost is the SCAN, not the allocation. It is a memo, not a second truth:
3741 // the redb tail stays authoritative and the file is discarded unless its
3742 // (epoch, count) both match the live tail, so a push, a gc or a torn
3743 // write all fall back to the scan and re-persist.
3744 //
3745 // The raw concatenation is BOTH the ordinal space and the validity token
3746 // for the commit graph below, so the graph is read whenever the object
3747 // set is unchanged; the hex form and the ordinal map fold out of the same
3748 // bytes, so ordinal `o` names the same object in every representation by
3749 // construction rather than by agreeing computations (LAW 5). The tail
3750 // hands oids in oid order, which is byte order over fixed-width oids and
3751 // therefore already the sorted concatenation the memo stores.
3752 //
3753 // **2026-09-04: the memo is gone, because the scan it spared is gone.**
3754 // The read stack persists its projection now (`objects.index`), and the
3755 // sorted oid list IS that index's oid column — one contiguous copy out
3756 // of a mapped buffer, plus a merge of the few rows redb still holds
3757 // since the last fold. No file of its own, no header, no epoch to
3758 // validate: the projection is current by construction. What is kept is
3759 // the provenance — how many oids came off the index and how many off
3760 // the tail — because that is the only thing that can prove the space
3761 // was not a scan (both paths yield identical bytes).
3762 let space = self.objects.oids_raw()?;
3763 self.ordinal_folded
3764 .store(space.folded_rows, std::sync::atomic::Ordering::Relaxed);
3765 self.ordinal_tail
3766 .store(space.tail_rows, std::sync::atomic::Ordering::Relaxed);
3767 let oids_raw = space.raw;
3768 let token = graph_token(&oids_raw);
3769
3770 // The commit graph — **read, not recomputed, when the object set has not
3771 // moved.** S-065's fix: `objects.graph` beside the pack holds the folded
3772 // graph with generations, written by this same call at derive time and
3773 // read here. It is not a second truth — it is a memoized projection
3774 // validated on every read against the authoritative object set (the
3775 // token is a blake3 over every oid in the store), and an absent file, a
3776 // stale token or a decode failure all fall back to the fold and
3777 // re-persist. Same shape as lane REFCAS persisting a tag's peeled target.
3778 //
3779 // On a fold, commit payloads are read out of §14's exploded table (no
3780 // tree payload — that was lane Q's 28.24 GB and most of the 50.9 GiB RSS
3781 // on `torvalds/linux`), parsed, and generation-numbered. That is the
3782 // whole of the O(commits) open cost this persistence removes.
3783 let cached = if self.graph_cache.load(std::sync::atomic::Ordering::Relaxed) {
3784 self.load_persisted_graph()?
3785 } else {
3786 None
3787 };
3788 let graph: Vec<CommitNode> = match cached {
3789 Some((tok, g)) if tok == token => {
3790 self.graph_read.fetch_add(1, std::sync::atomic::Ordering::Relaxed);
3791 g
3792 }
3793 _ => {
3794 self.graph_recomputed
3795 .fetch_add(1, std::sync::atomic::Ordering::Relaxed);
3796 let commits = self.exploded.of_kind(GitObjectKind::Commit)?;
3797 let g: Vec<CommitNode> = commits
3798 .iter()
3799 .map(|(oid, payload)| {
3800 let h = crate::object::parse_commit(payload);
3801 CommitNode {
3802 oid: hex::encode(oid),
3803 parents: h.parents,
3804 tree: h.tree,
3805 committer_time: h.committer_time,
3806 generation: 0,
3807 }
3808 })
3809 .collect();
3810 let g = assign_generations(g);
3811 // Persist for the next open. A write failure is not fatal to the
3812 // fold — the graph is correct in memory and the next open simply
3813 // recomputes — so it is logged, not propagated.
3814 if !self.graph_cache.load(std::sync::atomic::Ordering::Relaxed) {
3815 // Switched off: no memo on this disk.
3816 } else if let Err(e) = self.persist_graph(&token, &g) {
3817 tracing::warn!(store = %self.label, "could not persist objects.graph: {e:#}");
3818 }
3819 g
3820 }
3821 };
3822
3823 // The same commit set `select` refuses a `want` against, in the raw form
3824 // it tests. Folded once here instead of once per request; see the field.
3825 // A row that does not decode makes the whole set `None`, which is the
3826 // decline `select` used to reach by returning early out of its own loop.
3827 let commit_raw = graph
3828 .iter()
3829 .map(|n| hex::decode(&n.oid).ok())
3830 .collect::<Option<std::collections::HashSet<Vec<u8>>>>()
3831 .map(Arc::new);
3832 // No hex `Vec<String>` and no `HashMap<String, u32>` are folded here any
3833 // more (S-082): `oids_raw` is the whole ordinal space, and oid ⇄ ordinal
3834 // is served off it by [`crate::reach::OrdinalSpace`] — a slice one way, a
3835 // binary search the other. That removed the ~0.13 s + ~0.08 s this fold
3836 // spent building those two per-oid `String` tables, and their resident
3837 // cost with them.
3838 // The graph-by-oid lookup, folded here so `reachable` borrows it instead
3839 // of rebuilding it per negotiation. Keyed by hex, the form the walk
3840 // keys by. Same lifecycle as `commit_raw`: rebuilt on every fold, so it
3841 // cannot outlive the graph it indexes.
3842 let graph_index: HashMap<String, u32> = graph
3843 .iter()
3844 .enumerate()
3845 .map(|(i, n)| (n.oid.clone(), i as u32))
3846 .collect();
3847
3848 let mut d = self
3849 .derived
3850 .write()
3851 .map_err(|_| anyhow!("derived poisoned"))?;
3852 // ── carry the reachability table across the fold ──────────────────
3853 //
3854 // The table describes immutable commits; the fold only renumbers the
3855 // ordinal space. Carry it (renumbered) while the graph has not outgrown
3856 // the last full build by more than the carry rule allows — else drop it
3857 // and let the next reader rebuild, which is what every fold used to do.
3858 // See `REACH_CARRY_MAX_FRACTION` for the measurement behind this.
3859 let carried: Option<Vec<ReachEntry>> = if d.reach.is_empty() {
3860 None
3861 } else {
3862 let grown = graph.len().saturating_sub(d.reach_full_len);
3863 let allowed = (d.reach_full_len / REACH_CARRY_MAX_FRACTION).max(REACH_CARRY_MIN_COMMITS);
3864 if grown > allowed {
3865 None
3866 } else {
3867 let oid_len = self.hash.oid_len();
3868 let old_space = crate::reach::OrdinalSpace::new(&d.oids_raw, oid_len);
3869 let new_space = crate::reach::OrdinalSpace::new(&oids_raw, oid_len);
3870 crate::reach::carry_reach(&d.reach, &old_space, &new_space, |c| graph_index.contains_key(c))
3871 }
3872 };
3873 tracing::info!(
3874 store = %self.label,
3875 reach_len = d.reach.len(),
3876 reach_full_len = d.reach_full_len,
3877 graph_len = graph.len(),
3878 carried = carried.as_ref().map(Vec::len),
3879 "fold: reachability table carry decision"
3880 );
3881 d.graph = graph;
3882 d.graph_index = graph_index;
3883 d.commit_raw = commit_raw;
3884 d.oids_raw = oids_raw;
3885 match carried {
3886 Some(entries) => {
3887 let index: HashMap<String, u32> = entries
3888 .iter()
3889 .enumerate()
3890 .map(|(i, e)| (e.commit.clone(), i as u32))
3891 .collect();
3892 d.reach = Arc::new(entries);
3893 d.reach_index = Arc::new(index);
3894 self.reach_carried
3895 .fetch_add(1, std::sync::atomic::Ordering::Relaxed);
3896 }
3897 None => {
3898 // Over the ordinal space that just changed and not carriable;
3899 // both are rebuilt lazily by `reach_bitmaps_with`.
3900 d.reach = Arc::default();
3901 d.reach_index = Arc::default();
3902 }
3903 }
3904 Ok(())
3905 }
3906
3907 /// `(reach_carried, reach_rebuilt)` — how many folds since open carried the
3908 /// reachability table across (renumbered) vs how many reads built it from
3909 /// scratch. See [`tests::a_push_carries_the_reach_table_across_the_fold`].
3910 fn reach_source_stats(&self) -> (u64, u64) {
3911 (
3912 self.reach_carried.load(std::sync::atomic::Ordering::Relaxed),
3913 self.reach_rebuilt.load(std::sync::atomic::Ordering::Relaxed),
3914 )
3915 }
3916
3917 /// Where the folded commit graph is cached, beside the verbatim pack:
3918 /// `<root>/objects.graph`.
3919 fn graph_cache_path(&self) -> PathBuf {
3920 self.blobs.with_file_name(GRAPH_CACHE_FILE)
3921 }
3922
3923 /// The persisted graph and the token it was written under, or `None` when
3924 /// the cache is absent, truncated, an unknown version, or fails to decode —
3925 /// every one of which is a signal to recompute and re-persist rather than an
3926 /// error, because the cache is a memo and the exploded table is the truth.
3927 fn load_persisted_graph(&self) -> Result<Option<([u8; 32], Vec<CommitNode>)>> {
3928 let bytes = match std::fs::read(self.graph_cache_path()) {
3929 Ok(b) => b,
3930 Err(e) if e.kind() == std::io::ErrorKind::NotFound => return Ok(None),
3931 Err(e) => {
3932 return Err(e).with_context(|| {
3933 format!("reading {}", self.graph_cache_path().display())
3934 });
3935 }
3936 };
3937 // Frame: b"GRPH" (4) + version (1) + token (32) + Arrow IPC graph.
3938 if bytes.len() < GRAPH_CACHE_HEADER || &bytes[..4] != GRAPH_CACHE_MAGIC || bytes[4] != 1 {
3939 return Ok(None);
3940 }
3941 let mut token = [0u8; 32];
3942 token.copy_from_slice(&bytes[5..GRAPH_CACHE_HEADER]);
3943 match crate::graph::decode_graph(&bytes[GRAPH_CACHE_HEADER..]) {
3944 Ok(g) => Ok(Some((token, g))),
3945 Err(_) => Ok(None),
3946 }
3947 }
3948
3949 /// Write the folded graph and its token durably: encode, write a temp file,
3950 /// fsync it, then rename over the cache — the rename is the atomic publish,
3951 /// so a reader never sees a half-written graph.
3952 fn persist_graph(&self, token: &[u8; 32], nodes: &[CommitNode]) -> Result<()> {
3953 use std::io::Write as _;
3954 let ipc = crate::graph::encode_graph(nodes)?;
3955 let mut out = Vec::with_capacity(GRAPH_CACHE_HEADER + ipc.len());
3956 out.extend_from_slice(GRAPH_CACHE_MAGIC);
3957 out.push(1);
3958 out.extend_from_slice(token);
3959 out.extend_from_slice(&ipc);
3960
3961 let path = self.graph_cache_path();
3962 let tmp = path.with_extension("graph.tmp");
3963 {
3964 let mut f = File::create(&tmp)
3965 .with_context(|| format!("creating {}", tmp.display()))?;
3966 f.write_all(&out)
3967 .with_context(|| format!("writing {}", tmp.display()))?;
3968 f.sync_all()
3969 .with_context(|| format!("fsync {}", tmp.display()))?;
3970 }
3971 std::fs::rename(&tmp, &path)
3972 .with_context(|| format!("publishing {}", path.display()))?;
3973 Ok(())
3974 }
3975
3976 /// `(graph_read_from_disk, graph_recomputed)` — how many folds since open
3977 /// read the persisted graph vs recomputed it. The only thing that can prove
3978 /// the persisted path ran; see
3979 /// [`tests::a_reopen_reads_the_persisted_graph_it_does_not_recompute`].
3980 fn graph_source_stats(&self) -> (u64, u64) {
3981 (
3982 self.graph_read.load(std::sync::atomic::Ordering::Relaxed),
3983 self.graph_recomputed
3984 .load(std::sync::atomic::Ordering::Relaxed),
3985 )
3986 }
3987
3988 /// `(folded_rows, tail_rows)` of the ordinal space the last fold built — how
3989 /// many oids came straight off the persisted index's oid column and how many
3990 /// off a scan of the redb tail. The only thing that can prove the space was
3991 /// not a scan (LAW 2), because both sources yield identical bytes; see
3992 /// [`tests::the_ordinal_space_comes_off_the_index_not_a_scan`].
3993 fn ordinal_source_stats(&self) -> (u64, u64) {
3994 (
3995 self.ordinal_folded.load(std::sync::atomic::Ordering::Relaxed),
3996 self.ordinal_tail.load(std::sync::atomic::Ordering::Relaxed),
3997 )
3998 }
3999
4000 /// The bitmaps, built on first use after a fold and cached until the next.
4001 fn reach_bitmaps(&self) -> Result<Arc<Vec<ReachEntry>>> {
4002 self.reach_bitmaps_with(live_reach_policy(), true)
4003 }
4004
4005 /// [`Absorber::reach_bitmaps`] with the policy **named** and the cache
4006 /// optional. The bitmaps alone; [`Absorber::reach_tables_with`] is the one
4007 /// builder and this drops the index it also returns, for callers that seal
4008 /// the table or compare two of them and never key into one by oid.
4009 fn reach_bitmaps_with(
4010 &self,
4011 policy: crate::reach::ReachPolicy,
4012 cache: bool,
4013 ) -> Result<Arc<Vec<ReachEntry>>> {
4014 Ok(self.reach_tables_with(policy, cache)?.0)
4015 }
4016
4017 /// **The reach table and its oid index, as one pair that is always in
4018 /// step.** [`crate::reach::accumulate`] keys the table by commit oid, and
4019 /// building that index per negotiation is exactly the O(commits) waste this
4020 /// lane removes — so it is built once, here, beside the table, and handed
4021 /// back with it. The two travel together (both cached, both returned) so a
4022 /// caller can never pair a fresh index against a stale table or the reverse.
4023 ///
4024 /// `cache` is false for the differential guard, which builds the table at two
4025 /// very different caps over one store and requires the two to answer
4026 /// identically; letting either poison `d.reach` would make the second arm
4027 /// read the first one's table and the comparison would be of a thing against
4028 /// itself.
4029 fn reach_tables_with(
4030 &self,
4031 policy: crate::reach::ReachPolicy,
4032 cache: bool,
4033 ) -> Result<(Arc<Vec<ReachEntry>>, Arc<HashMap<String, u32>>)> {
4034 {
4035 let d = self
4036 .derived
4037 .read()
4038 .map_err(|_| anyhow!("derived poisoned"))?;
4039 if cache && !d.reach.is_empty() {
4040 // Two refcount bumps. This was `d.reach.clone()` — one deep copy
4041 // of every commit's roaring bitmap, per call, twice per request
4042 // — plus, before this lane, a whole `HashMap<&str,_>` rebuilt
4043 // from the table on every call at the negotiation site.
4044 return Ok((Arc::clone(&d.reach), Arc::clone(&d.reach_index)));
4045 }
4046 if d.graph.is_empty() {
4047 return Ok((Arc::default(), Arc::default()));
4048 }
4049 }
4050 let mut d = self
4051 .derived
4052 .write()
4053 .map_err(|_| anyhow!("derived poisoned"))?;
4054 // Built before the facts so it outlives them, and deliberately NOT
4055 // holding the `derived` guard: `Absorber::resolved` does not take that
4056 // lock, which is what makes a live tree lookup legal from inside this
4057 // write section at all.
4058 let trees = self.tree_source();
4059 let oid_len = self.hash.oid_len();
4060 let facts = crate::reach::ObjectFacts {
4061 ordinal: crate::reach::OrdinalSpace::new(&d.oids_raw, oid_len),
4062 trees: &trees,
4063 oid_len,
4064 };
4065 let started = std::time::Instant::now();
4066 let built = Arc::new(crate::reach::build_reach(&d.graph, &facts, policy));
4067 self.reach_rebuilt
4068 .fetch_add(1, std::sync::atomic::Ordering::Relaxed);
4069 tracing::info!(
4070 store = %self.label,
4071 entries = built.len(),
4072 commits = d.graph.len(),
4073 elapsed_ms = started.elapsed().as_millis() as u64,
4074 cache,
4075 "built the reachability table from scratch"
4076 );
4077 // The commit count this build covered — the denominator the next fold's
4078 // carry rule divides by (`REACH_CARRY_MAX_FRACTION`).
4079 d.reach_full_len = d.graph.len();
4080 // The index over the table just built — commit oid → row — so the
4081 // negotiation looks a bitmap up by a hash rather than by rebuilding this
4082 // map first.
4083 let index: Arc<HashMap<String, u32>> = Arc::new(
4084 built
4085 .iter()
4086 .enumerate()
4087 .map(|(i, e)| (e.commit.clone(), i as u32))
4088 .collect(),
4089 );
4090 if cache {
4091 // `Arc::new` once each, then a refcount bump into the cache — the
4092 // second full copy the table line used to make
4093 // (`d.reach = built.clone()`) is gone, and the index is cached in
4094 // lockstep so the read arm above can hand out both.
4095 d.reach = Arc::clone(&built);
4096 d.reach_index = Arc::clone(&index);
4097 }
4098 Ok((built, index))
4099 }
4100
4101 /// The commit oid set, raw, as folded. See [`Derived::commit_raw`].
4102 fn commit_oids_raw(&self) -> Result<Option<Arc<std::collections::HashSet<Vec<u8>>>>> {
4103 Ok(self
4104 .derived
4105 .read()
4106 .map_err(|_| anyhow!("derived poisoned"))?
4107 .commit_raw
4108 .clone())
4109 }
4110
4111 // `ordinal_space()` lived here: `d.oids.clone()`, a fresh `Vec<String>` of
4112 // every oid in the store, handed to `reachable_oids` twice per request. It
4113 // is gone, and so is `d.oids` itself (S-082): the serve path borrows
4114 // `d.oids_raw` as an `OrdinalSpace` under the read guard it was already
4115 // going to take, and reads oid ⇄ ordinal straight off it.
4116
4117 /// `pread` an extent out of the verbatim archive, **into uninitialised
4118 /// capacity** — no zero-fill before the read.
4119 ///
4120 /// This used to be `vec![0u8; len]` + `read_exact_at`, and under emit
4121 /// concurrency the zeroing was not a detail: profiled on oden 2026-08-12
4122 /// (gunnar serving 32 concurrent clones, perf on the server pid), ~44 % of
4123 /// serve CPU was memory zeroing/copying — `memset` 18.1 % plus kernel
4124 /// page-zeroing 7.8 % — against ~12 % for one clone, because 32 threads
4125 /// churning pack-scale buffers recycle mimalloc freelist blocks that must
4126 /// each be memset before `pread` immediately overwrites every byte.
4127 ///
4128 /// Soundness: no reference to uninitialised memory is ever formed. The
4129 /// bytes are written through a raw pointer into the `Vec`'s spare
4130 /// capacity, `EINTR` retries, a short read refuses, and `set_len` runs
4131 /// only after every one of `len` bytes has been written.
4132 fn read_extent(&self, offset: u64, len: u64) -> Result<Vec<u8>> {
4133 use std::os::fd::AsRawFd;
4134 let want = usize::try_from(len).context("extent length overflows usize")?;
4135 let mut buf: Vec<u8> = Vec::with_capacity(want);
4136 let fd = self.reader.as_raw_fd();
4137 let mut filled = 0usize;
4138 while filled < want {
4139 let n = unsafe {
4140 libc::pread(
4141 fd,
4142 buf.as_mut_ptr().add(filled).cast(),
4143 want - filled,
4144 i64::try_from(offset + filled as u64).context("extent offset overflows off_t")?,
4145 )
4146 };
4147 if n < 0 {
4148 let err = std::io::Error::last_os_error();
4149 if err.kind() == std::io::ErrorKind::Interrupted {
4150 continue;
4151 }
4152 return Err(err).with_context(|| {
4153 format!("reading ({offset}, {len}) out of {}", self.blobs.display())
4154 });
4155 }
4156 if n == 0 {
4157 bail!(
4158 "short read at ({offset}, {len}) out of {}: {filled} of {want} bytes before \
4159 EOF — the archive is truncated relative to its index",
4160 self.blobs.display()
4161 );
4162 }
4163 filled += n as usize;
4164 }
4165 // Every byte of `want` is now initialised.
4166 unsafe { buf.set_len(want) };
4167 Ok(buf)
4168 }
4169}
4170
4171/// **The drain's object-level ingress**, and the reason a push ends in object
4172/// rows without anybody reading first.
4173///
4174/// The account indexer holds this as an `Arc<dyn ObjectAbsorb>` and calls it once
4175/// per drained job, on its own thread, after the ack. It is the *same* absorb a
4176/// falling-back read takes, gate and all (LAW 5): there is no background copy of
4177/// this logic to drift.
4178impl<S: ObjectIndex> ObjectAbsorb for Absorber<S> {
4179 fn absorb(&self, job: IndexJob) -> Result<()> {
4180 // **The memory watchdog, BEFORE the pack and BEFORE the gate**
4181 // ([`crate::memguard`]). Inside the pack the resolver checks again
4182 // every few thousand objects; this is the check that keeps a burst of
4183 // packs from starting one more absorb on a box that is already short.
4184 // Taken before the gate on purpose: a paused worker holds nothing —
4185 // not the gate, not a row, not a base — so a reader that wants to
4186 // absorb for itself can, and every other reader scans the pack.
4187 if self.cancel.load(std::sync::atomic::Ordering::Relaxed) {
4188 return Err(crate::resolve::ResolveError::cancelled());
4189 }
4190 let dog = self.watchdog();
4191 if dog.breached().is_some() {
4192 self.progress.begin(job.pack_id, job.len, false);
4193 self.progress.set_phase(crate::progress::Phase::Paused);
4194 self.progress.add_pause();
4195 let r = dog.pause_until_ok(&self.label, Some(&self.cancel), &mut || Ok(self.spill()));
4196 self.progress.finish();
4197 let paused = r?;
4198 // The pause before the pack has the same rule as the one inside it:
4199 // a give-up is not a resume. Starting an 8 GiB pack on a box that
4200 // just told us it has nothing left is how the parked hours began.
4201 if paused.end.gave_up() {
4202 return Err(crate::resolve::ResolveError::out_of_memory(
4203 paused.end.as_str(),
4204 paused.available,
4205 paused.budget,
4206 0,
4207 0,
4208 ));
4209 }
4210 }
4211 let _gate = self
4212 .gate
4213 .lock()
4214 .map_err(|_| anyhow!("absorb gate poisoned"))?;
4215 self.absorb_gated(&PendingPack::from_job(job))
4216 }
4217}
4218
4219impl<S: ObjectIndex + 'static> GitStore<S> {
4220 /// The push path, for the two `put` halves.
4221 pub(crate) fn push_path(&self) -> &PushPath {
4222 &self.push
4223 }
4224
4225 pub(crate) fn account(&self) -> &str {
4226 &self.account
4227 }
4228
4229 pub(crate) fn ref_log(&self) -> &RefLog {
4230 &self.refs
4231 }
4232
4233 pub(crate) fn ref_gate(&self) -> &Mutex<()> {
4234 &self.ref_gate
4235 }
4236
4237 /// The closure check's index half: a `REF_DELTA`'s base has to exist —
4238 /// **in the store, or in this very pack**.
4239 ///
4240 /// This is the one part of receive-pack that reads `objects.oid` (§13's
4241 /// table), and on the path a real push takes it reads nothing else.
4242 ///
4243 /// # The second half of that sentence used to be missing, and it refused
4244 /// packs git itself writes
4245 ///
4246 /// [`crate::pack_walk::PackWalk::closure`] cannot do better on its own:
4247 /// a walk reports what the bytes say, and the bytes of a `REF_DELTA` name a
4248 /// base by **oid**, which is a fact about resolved content that no walk can
4249 /// know. So every ref base came back on `external_refs` and every one of
4250 /// them was required to be in the store already.
4251 ///
4252 /// A `REF_DELTA` naming a base *inside the same pack* is ordinary and git
4253 /// writes it constantly: `git index-pack --fix-thin` completes a pushed thin
4254 /// pack by **appending the base object to the pack** and leaving the delta
4255 /// naming it by oid. Every such pack was refused with *"this pack deltas
4256 /// against X, which this repository does not have"*, on a store that was
4257 /// being handed a perfectly ordinary, self-contained packfile — the base was
4258 /// entry 1 of 25 in the pack's own `.idx` (`gunnar.multi_pack_serve`,
4259 /// 2026-08-14). The same missing check is `S-003` / gitoxide#2882 in
4260 /// `LookupRefDeltaObjectsIter`; it is the same defect wearing the receiving
4261 /// hat instead of the sending one.
4262 ///
4263 /// # What it costs, and where
4264 ///
4265 /// **Nothing on any push that was going to succeed before.** Every base
4266 /// found in the store short-circuits exactly as it did, and a pack with no
4267 /// ref-delta at all never gets past the first loop.
4268 ///
4269 /// The pack is resolved only when the alternative is *refusing it*, and then
4270 /// the resolve is the cheapest honest answer available: an entry's oid is
4271 /// knowable only by applying its delta chain, which is precisely what
4272 /// [`crate::resolve::resolve_walked`] does — the same resolver the absorb is
4273 /// about to run over the same pack anyway, reused rather than twinned
4274 /// (LAW 5). A push that is genuinely thin against a base nobody has still
4275 /// fails, one resolve later, and still names the oid.
4276 pub(crate) fn external_bases_exist(&self, bytes: &[u8], w: &PackWalk) -> Result<()> {
4277 let c = w.closure();
4278 if !c.broken_offsets.is_empty() {
4279 bail!(
4280 "this pack is corrupt: {} delta base offset(s) do not land on an entry — first {}",
4281 c.broken_offsets.len(),
4282 c.broken_offsets[0]
4283 );
4284 }
4285 // The fast path, unchanged: a base the store already holds is settled
4286 // without reading one byte of the pack.
4287 let mut unheld: Vec<&[u8]> = Vec::new();
4288 for oid in &c.external_refs {
4289 if self.lookup_one(oid)?.is_none() {
4290 unheld.push(oid.as_slice());
4291 }
4292 }
4293 if unheld.is_empty() {
4294 return Ok(());
4295 }
4296
4297 // Only now, and only because the alternative is refusing the push: does
4298 // the pack supply these itself? `resolve_walked` answers with the
4299 // store behind it, so a base that really is external is still found the
4300 // cheap way and only a genuinely absent one fails.
4301 let resolved = crate::resolve::resolve_walked(
4302 bytes,
4303 w,
4304 self.hash_kind(),
4305 0,
4306 &*self.absorber,
4307 &crate::exploded::NoSink,
4308 )
4309 .with_context(|| {
4310 format!(
4311 "this pack deltas against {} object(s) this repository does not have, so it was \
4312 resolved to find out whether the pack carries them itself — first {}",
4313 unheld.len(),
4314 hex::encode(unheld[0])
4315 )
4316 })?;
4317 let in_pack: std::collections::HashSet<&[u8]> =
4318 resolved.iter().map(|r| r.oid.as_slice()).collect();
4319 for oid in unheld {
4320 if !in_pack.contains(oid) {
4321 bail!(
4322 "this pack deltas against {}, which this repository does not have and which \
4323 the pack does not carry either — the push is refused rather than stored with \
4324 a dangling base",
4325 hex::encode(oid)
4326 );
4327 }
4328 }
4329 Ok(())
4330 }
4331
4332 /// One oid, on the **serial** path. See [`lookup_path`].
4333 pub(crate) fn lookup_one(&self, oid: Oid<'_>) -> Result<Option<crate::index_layout::IndexRow>> {
4334 // **Never waits on the indexer.** The rows the worker has landed so far
4335 // are in the index; an oid it has not reached is resolved from the
4336 // pending pack on this thread (`Absorber::scan_pending`).
4337 self.absorber.lookup_never_wait(oid)
4338 }
4339
4340 /// Many oids, on the **batch** path, never waiting on the indexer.
4341 pub(crate) fn lookup_batch_never_wait(
4342 &self,
4343 oids: &[Oid<'_>],
4344 ) -> Result<Vec<Option<crate::index_layout::IndexRow>>> {
4345 self.absorber.lookup_batch_never_wait(oids)
4346 }
4347
4348 /// Absorb the pending packs on this thread **if the gate is free**;
4349 /// `None` = the worker holds it and this caller did not wait. See
4350 /// `Absorber::try_absorb_pending`.
4351 pub fn try_absorb_pending(&self) -> Result<Option<usize>> {
4352 self.absorber.try_absorb_pending()
4353 }
4354
4355 /// The named refusal for a request that needs the whole derived graph
4356 /// while a pack is still being indexed: `reachable` cannot be answered
4357 /// from a graph that does not hold the pack's commits yet, and waiting for
4358 /// the worker is forbidden. The message carries the progress row's
4359 /// numbers so the client knows when to come back.
4360 fn index_in_progress(&self) -> anyhow::Error {
4361 let p = self.index_progress();
4362 anyhow!(
4363 "index in progress for this repository: pack {} {}% ({}/{} objects, {}) — reachability \
4364 needs the whole graph; retry when the index row reaches 100 %",
4365 p.pack_id,
4366 p.percent(),
4367 p.objects_done,
4368 p.objects_total,
4369 p.phase.as_str()
4370 )
4371 }
4372
4373 /// The current ref namespace, as the log folds to it. The whole-snapshot
4374 /// accessor; [`ref_get`](Self::ref_get) is the keyed one.
4375 pub(crate) fn ref_state(&self) -> Result<BTreeMap<String, crate::refs::RefState>> {
4376 self.refs.current()
4377 }
4378
4379 /// One ref by name, O(log r), without cloning the namespace — for `head`
4380 /// and a single-ref CAS. See [`crate::refs::RefLog::get`].
4381 pub(crate) fn ref_get(&self, name: &str) -> Result<Option<crate::refs::RefState>> {
4382 self.refs.get(name)
4383 }
4384
4385 /// Reachability over the graph, as roaring bitmaps, in **this store's**
4386 /// ordinal space.
4387 ///
4388 /// Returns `(want ∪ closure) − (have ∪ closure)` as oid hex. Every object —
4389 /// commit, tree and blob — is in the bitmaps, because
4390 /// [`crate::reach::build_reach`] walks the trees; that is why this can answer
4391 /// with objects rather than only with commits.
4392 ///
4393 /// **Hex is for the maintenance path, not the serving one.** The answer is
4394 /// computed in raw bytes by [`GitStore::reachable_raw_with`] and encoded
4395 /// here, at one `String` per object; every caller that serves a request asks
4396 /// for the raw form instead. See [`Derived::oids_raw`] for what that cost.
4397 pub(crate) fn reachable_oids(&self, want: &[Oid<'_>], have: &[Oid<'_>]) -> Result<Vec<String>> {
4398 Ok(self
4399 .reachable_raw_with(want, have, live_reach_policy(), true)?
4400 .iter()
4401 .map(hex::encode)
4402 .collect())
4403 }
4404
4405 /// [`GitStore::reachable_oids`] with the bitmap policy **named** and the
4406 /// cache optional.
4407 ///
4408 /// One body, not two (LAW 5): both are [`GitStore::reachable_raw_with`], so
4409 /// the guarded path and the shipped path are the same code.
4410 #[cfg(test)]
4411 pub(crate) fn reachable_oids_with(
4412 &self,
4413 want: &[Oid<'_>],
4414 have: &[Oid<'_>],
4415 policy: crate::reach::ReachPolicy,
4416 cache: bool,
4417 ) -> Result<Vec<String>> {
4418 Ok(self
4419 .reachable_raw_with(want, have, policy, cache)?
4420 .iter()
4421 .map(hex::encode)
4422 .collect())
4423 }
4424
4425 /// `(want ∪ closure) − (have ∪ closure)`, in **raw oid bytes**, in one
4426 /// allocation.
4427 ///
4428 /// The answer every serving caller wants and the one the bitmaps naturally
4429 /// produce: an ordinal indexes straight into [`Derived::oids_raw`], so
4430 /// nothing is encoded, decoded or allocated per object on the way out.
4431 pub(crate) fn reachable_raw(
4432 &self,
4433 want: &[Oid<'_>],
4434 have: &[Oid<'_>],
4435 ) -> Result<git_storage_trait::OidList> {
4436 self.reachable_raw_with(want, have, live_reach_policy(), true)
4437 }
4438
4439 /// [`GitStore::reachable_raw`] with the bitmap policy **named** and the
4440 /// cache optional.
4441 ///
4442 /// It exists because the answer is defined to be **independent of the
4443 /// policy** — [`crate::reach::accumulate`] covers whatever the table does
4444 /// not — and a property like that can only be tested by driving the policy.
4445 /// A test that could not reach it would be asserting that one code path
4446 /// equals itself. `cache: false` keeps one arm's table from being read by
4447 /// the next, which is the same trap in a different hat.
4448 pub(crate) fn reachable_raw_with(
4449 &self,
4450 want: &[Oid<'_>],
4451 have: &[Oid<'_>],
4452 policy: crate::reach::ReachPolicy,
4453 cache: bool,
4454 ) -> Result<git_storage_trait::OidList> {
4455 // The graph is folded by the absorb, so a pending pack has to be
4456 // absorbed before reachability can be right. If the gate is free this
4457 // thread does it; if the worker holds it — hours into a kernel pack,
4458 // or paused by the watchdog — this is refused by name, not waited on.
4459 if self.try_absorb_pending()?.is_none() {
4460 return Err(self.index_in_progress());
4461 }
4462 // `reach_bitmaps` may take the derived WRITE lock to build, so it runs
4463 // to completion before the read guard below is taken. Getting that order
4464 // wrong is a self-deadlock, not a slow path.
4465 // The reach table AND its oid index, one pair from the same fold. Both
4466 // used to be rebuilt at this site on every call: the bitmap map
4467 // (`e.commit → &bitmap`) here, and the graph map below — O(commits)
4468 // apiece, per request, for tables that cannot change between folds. They
4469 // are folded once now and borrowed through a [`crate::reach::ReachView`].
4470 let (bitmaps, reach_index) = self.reach_tables_with(policy, cache)?;
4471 // **One read guard, held across the whole answer, and nothing cloned out
4472 // of it.** This used to be `ordinal_space()?` (a `Vec<String>` of every
4473 // oid in the store) plus `.ordinal.clone()` (a `HashMap<String, u32>` of
4474 // the same, again) — ~2 × 12 455 `String` allocations per call and two
4475 // calls per request, for two tables that cannot change between folds.
4476 // Borrowing them is not a lock held longer than the work: the guard is a
4477 // reader, folds take the writer, and a fold that lands mid-answer would
4478 // invalidate the ordinals this loop is translating.
4479 let d = self
4480 .absorber
4481 .derived
4482 .read()
4483 .map_err(|_| anyhow!("derived poisoned"))?;
4484 let space = &d.oids_raw;
4485 let oid_len = self.hash.oid_len();
4486 // oid ⇄ ordinal off the flat buffer — a binary search, no map to clone
4487 // out of the guard. `want`/`have` arrive as raw bytes, so those lookups
4488 // take the raw form directly (`ordinal.ordinal_of_raw`) and never encode.
4489 let ordinal = crate::reach::OrdinalSpace::new(space, oid_len);
4490
4491 // The graph-by-oid lookup for [`crate::reach::accumulate`]'s commit walk
4492 // is `d.graph_index`, folded beside `d.graph` and borrowed here — not
4493 // rebuilt per call. The reach table's index (`reach_index`) is paired
4494 // with `bitmaps` above by the same fold, so this view never mixes a
4495 // table with an index from a different one.
4496 let view = crate::reach::ReachView {
4497 reach: &bitmaps,
4498 reach_index: &reach_index,
4499 graph: &d.graph,
4500 graph_index: &d.graph_index,
4501 };
4502 let trees = self.absorber.tree_source();
4503 let facts = crate::reach::ObjectFacts {
4504 ordinal,
4505 trees: &trees,
4506 oid_len,
4507 };
4508
4509 let mut union = roaring::RoaringBitmap::new();
4510 for oid in want {
4511 let hex = hex::encode(oid);
4512 match view.bitmap(hex.as_str()) {
4513 // A commit with a bitmap: its whole closure, in one OR.
4514 Some(bm) => union |= bm,
4515 // **No bitmap. This is the case that used to be a wrong answer.**
4516 //
4517 // It contributed the object itself and nothing else — see
4518 // `crate::reach::accumulate`'s header for what that cost. Now a
4519 // commit the graph holds is WALKED, bounded by the first
4520 // bitmapped commit behind it, and only a `want` the store does
4521 // not hold at all is still refused.
4522 None => {
4523 if view.is_commit(hex.as_str()) {
4524 crate::reach::accumulate(hex.as_str(), &view, &facts, &mut union);
4525 } else if let Some(o) = ordinal.ordinal_of_raw(oid) {
4526 // Not a commit at all — a TAG or a blob asked for
4527 // directly.
4528 union.insert(o);
4529 // **A tag contributes what it points AT, and until
4530 // 2026-08-31 it did not.**
4531 //
4532 // The bitmaps are built over the commit graph and no
4533 // tree points at a tag, so a tag is in nobody's closure
4534 // and this arm was the only place its target could
4535 // enter. It did not, so an annotated tag shipped as one
4536 // object with its commit missing, and the far end said
4537 // `missing necessary objects … (peeling a tag)`. That
4538 // is exactly what gunnar's replication hit on six
4539 // repositories: 25 tags on one commit no branch carried.
4540 //
4541 // gunnar's own serve paths never had the bug because
4542 // they peel BEFORE they ask a store
4543 // (`gunnar-wire`'s `select_objects`, step 1). A store
4544 // that answers `reachable` has to peel here, because
4545 // its caller cannot know which oids are tags.
4546 //
4547 // A tag object is only ever reachable as a REF TIP —
4548 // nothing inside a commit or a tree points at one — so
4549 // peeling in the `want` loop is complete, not partial.
4550 peel_tag_into(
4551 self.absorber.as_ref(),
4552 &hex,
4553 &view,
4554 &facts,
4555 &mut union,
4556 );
4557 } else {
4558 bail!(
4559 "want {hex} is not in this repository — a negotiation must not be \
4560 answered from a partial set"
4561 );
4562 }
4563 }
4564 }
4565 }
4566 let mut had = roaring::RoaringBitmap::new();
4567 for oid in have {
4568 let hex = hex::encode(oid);
4569 if let Some(bm) = view.bitmap(hex.as_str()) {
4570 had |= bm;
4571 } else if view.is_commit(hex.as_str()) {
4572 // The same walk on the exclude side, and it must be the same
4573 // walk: an under-counted `have` over-sends (harmless, wasteful)
4574 // but an under-counted `want` under-sends, and answering the two
4575 // sides by different rules is how a `want − have` stops being a
4576 // subtraction of like for like.
4577 crate::reach::accumulate(hex.as_str(), &view, &facts, &mut had);
4578 } else if let Some(o) = ordinal.ordinal_of_raw(oid) {
4579 had.insert(o);
4580 }
4581 // An unknown `have` is normal: the client may have objects we do not.
4582 // It contributes nothing, which is the safe direction — we send more,
4583 // never less.
4584 }
4585
4586 let delta = union - had;
4587 // One allocation for the whole answer, sized before the loop. The
4588 // ordinal space is a flat buffer, so each object is a `copy_from_slice`
4589 // of `oid_len` bytes into it and nothing else.
4590 let mut out = git_storage_trait::OidList::with_capacity(delta.len() as usize, oid_len);
4591 for o in delta {
4592 let at = o as usize * oid_len;
4593 let raw = space
4594 .get(at..at + oid_len)
4595 .ok_or_else(|| anyhow!("ordinal {o} is outside this store's ordinal space"))?;
4596 out.push(raw)?;
4597 }
4598 Ok(out)
4599 }
4600
4601 /// Every object reachable from every ref: what a GC must keep.
4602 pub(crate) fn live_set(&self) -> Result<std::collections::HashSet<String>> {
4603 let refs = self.ref_state()?;
4604 let tips: Vec<Vec<u8>> = refs
4605 .values()
4606 .filter_map(|s| s.target.as_deref())
4607 .filter_map(|t| hex::decode(t).ok())
4608 .collect();
4609 if tips.is_empty() {
4610 bail!(
4611 "this repository has no ref pointing at an object, so every object in it would be \
4612 dead. A GC that would delete everything is refused: name a ref first"
4613 );
4614 }
4615 let borrowed: Vec<Oid<'_>> = tips.iter().map(|t| t.as_slice()).collect();
4616 let mut live: std::collections::HashSet<String> =
4617 self.reachable_oids(&borrowed, &[])?.into_iter().collect();
4618 // The peeled targets of annotated tags are reachable too, and a tag
4619 // object is not a commit so it has no bitmap of its own.
4620 for s in refs.values() {
4621 if let Some(p) = &s.peeled {
4622 live.insert(p.clone());
4623 }
4624 if let Some(t) = &s.target {
4625 live.insert(t.clone());
4626 }
4627 }
4628 Ok(live)
4629 }
4630
4631 /// Drop every row the live set does not name. The index is append-only for
4632 /// everything except this.
4633 ///
4634 /// **Both tables, in one call.** §14's exploded table is retired with the
4635 /// `objects` table because its row count against that one's is what says
4636 /// whether it is whole ([`Absorber::adopt_journal`]): dropping from one and
4637 /// not the other would leave every later open re-exploding the entire
4638 /// repository. The count returned is still the index's — that is what a
4639 /// [`GcReport`] means by a dropped row.
4640 /// Drop exactly the rows in `dead` — a set the GC computed as "seen at its
4641 /// start and not reachable", never "not in `live`". The distinction is a
4642 /// row that arrived after the GC took its snapshot: it is in neither set,
4643 /// and the predicate below keeps it. See [`dead_oids`].
4644 pub(crate) fn drop_dead_rows(&self, dead: &std::collections::HashSet<Vec<u8>>) -> Result<u64> {
4645 let dropped = self
4646 .absorber
4647 .objects
4648 .retain(&|oid: &[u8]| !dead.contains(oid))?;
4649 self.absorber
4650 .exploded
4651 .retain(&|oid: &[u8]| !dead.contains(oid))?;
4652 // **Everything folded from those two tables, refolded.** The commit
4653 // graph, the tree payloads, the ordinal space and the bitmaps are all
4654 // derivations of the rows that just went, and a derivation that still
4655 // names a dropped oid is *wrong* rather than merely stale — a `reachable`
4656 // over a graph holding dead commits selects objects the index can no
4657 // longer serve. This is the same [`Absorber::refold`] every absorb and
4658 // every open already calls, over the table this call just changed;
4659 // nothing about how the graph is rebuilt is touched here.
4660 //
4661 // The bitmaps go with it: they address **ordinals**, and dropping rows
4662 // renumbers the ordinal space, so `refold` clears them and the next
4663 // `reach_bitmaps()` builds them over the new numbering. Carrying them
4664 // across would be carrying an index into a different array.
4665 self.absorber.refold()?;
4666 Ok(dropped)
4667 }
4668
4669 /// **The journal's half of a GC: retire every pack whose objects are now all
4670 /// dead, before a single row is dropped.**
4671 ///
4672 /// Returns the offsets retired.
4673 ///
4674 /// # Why this exists
4675 ///
4676 /// §13.12's `indexed` bit is derived on open as *extent in the journal, rows
4677 /// not in the index* ([`Absorber::adopt_journal`]). Dropping every row of a
4678 /// pack produces that state exactly, so without this call the next open
4679 /// re-queues the pack and re-absorbs the objects a GC just decided were dead.
4680 /// A **partly** dead pack keeps rows and was never affected; this is only
4681 /// about the all-dead case.
4682 ///
4683 /// # What it does not do
4684 ///
4685 /// It does not truncate `objects.pack`. The blob file is append-only and a
4686 /// pack in the middle of it cannot be cut out without moving every extent
4687 /// after it — which would invalidate every index row in the archive. The dead
4688 /// pack's bytes stay; what changes is that nothing will ever index them
4689 /// again. Reclaiming those bytes is a rewrite of the blob file, and it is not
4690 /// this function.
4691 ///
4692 /// An arm with no journal ([`FastWriter`](crate::archive_write::FastWriter))
4693 /// has nothing to retire and nothing that re-queues, so it returns empty.
4694 ///
4695 /// # Cost
4696 ///
4697 /// One [`ObjectReadStack::extents_with_rows`] scan plus one batch lookup of
4698 /// the live set. Both are already the shape a GC pays elsewhere, and both run
4699 /// once per `gc()`, not per pack.
4700 /// Where the journal's acked extents end right now — the GC's snapshot of
4701 /// "packs that existed when I started". A pack acked past this point during
4702 /// the GC belongs to a push in flight and is not the GC's to judge.
4703 pub(crate) fn acked_end(&self) -> Result<u64> {
4704 let Some(journal) = self.arms.writer.journal(&self.blobs) else {
4705 return Ok(u64::MAX);
4706 };
4707 if !journal.exists() {
4708 return Ok(0);
4709 }
4710 let rows = crate::archive_write::read_journal(&journal)?;
4711 Ok(crate::archive_write::acked_packs(&rows)
4712 .iter()
4713 .map(|(o, l)| o + l)
4714 .max()
4715 .unwrap_or(0))
4716 }
4717
4718 /// Tombstone every acked pack that holds no live object — among the packs
4719 /// whose extent ends at or before `acked_end`, the GC's snapshot from
4720 /// [`acked_end`](Self::acked_end). A pack pushed after that snapshot has
4721 /// objects `live` never saw, and without the bound it would be retired for
4722 /// being unknown, which is how a GC would delete a push in flight.
4723 pub(crate) fn retire_dead_packs(
4724 &self,
4725 live: &std::collections::HashSet<String>,
4726 acked_end: u64,
4727 ) -> Result<Vec<u64>> {
4728 let Some(journal) = self.arms.writer.journal(&self.blobs) else {
4729 return Ok(Vec::new());
4730 };
4731 if !journal.exists() {
4732 return Ok(Vec::new());
4733 }
4734 let rows = crate::archive_write::read_journal(&journal)?;
4735 let packs: Vec<(u64, u64)> = crate::archive_write::acked_packs(&rows)
4736 .into_iter()
4737 .filter(|(o, l)| o + l <= acked_end)
4738 .collect();
4739 let already = crate::archive_write::retired_offsets(&rows);
4740 if packs.is_empty() {
4741 return Ok(Vec::new());
4742 }
4743
4744 // Which packs hold any row at all right now. A pack with none is either
4745 // already retired or was never absorbed — neither is this call's
4746 // business, and calling the second one dead would lose it.
4747 let occupied = self.absorber.objects.extents_with_rows(&packs)?;
4748
4749 // Which packs hold a row that survives. Placed by binary search over the
4750 // pack starts, the same way the scan above places a row.
4751 let mut order: Vec<usize> = (0..packs.len()).filter(|&i| packs[i].1 > 0).collect();
4752 order.sort_unstable_by_key(|&i| packs[i].0);
4753 let starts: Vec<u64> = order.iter().map(|&i| packs[i].0).collect();
4754 let live_oids: Vec<Vec<u8>> = live.iter().filter_map(|h| hex::decode(h).ok()).collect();
4755 let borrowed: Vec<&[u8]> = live_oids.iter().map(|o| o.as_slice()).collect();
4756 let mut has_live = vec![false; packs.len()];
4757 for (offset, _) in self
4758 .absorber
4759 .objects
4760 .extents_batch(&borrowed)
4761 .into_iter()
4762 .flatten()
4763 {
4764 let p = starts.partition_point(|&s| s <= offset);
4765 if p == 0 {
4766 continue;
4767 }
4768 let i = order[p - 1];
4769 if offset < packs[i].0 + packs[i].1 {
4770 has_live[i] = true;
4771 }
4772 }
4773
4774 let dead: Vec<u64> = (0..packs.len())
4775 .filter(|&i| occupied[i] && !has_live[i] && !already.contains(&packs[i].0))
4776 .map(|i| packs[i].0)
4777 .collect();
4778 // Durable before the rows go. The one ordering this function has.
4779 crate::archive_write::retire_packs(&journal, &dead)?;
4780 Ok(dead)
4781 }
4782
4783 /// **Write generation 0** at [`archive_path`](Self::archive_path), carrying
4784 /// the verbatim packs this store has acked plus `reserved`.
4785 ///
4786 /// The whole of the decision-making lives in
4787 /// [`seal_generation_zero`](crate::archive_write::seal_generation_zero); this
4788 /// is the three paths it needs, taken off the same fields the push path and
4789 /// the GC read, so a seal cannot address a different blob file or a different
4790 /// journal from the one that acked the packs.
4791 pub(crate) fn seal_archive(
4792 &self,
4793 reserved: Vec<ReservedSection>,
4794 ) -> Result<crate::archive_write::SealReport> {
4795 crate::archive_write::seal_generation_zero(
4796 &self.blobs,
4797 self.arms.writer.journal(&self.blobs).as_deref(),
4798 &self.archive,
4799 reserved,
4800 )
4801 }
4802
4803 /// The sections a sealed archive carries: the ref log, the commit graph and
4804 /// the bitmaps.
4805 pub(crate) fn reserved_sections(&self) -> Result<Vec<ReservedSection>> {
4806 use znippy_common::{GUNNAR_GRAPH_MODULE, GUNNAR_REACH_MODULE};
4807 let mut out = vec![self.refs.seal_section()?];
4808 let d = self
4809 .absorber
4810 .derived
4811 .read()
4812 .map_err(|_| anyhow!("derived poisoned"))?;
4813 if !d.graph.is_empty() {
4814 out.push(ReservedSection::arrow(
4815 GUNNAR_GRAPH_MODULE,
4816 crate::graph::graph_schema(),
4817 vec![crate::graph::build_graph_batch(&d.graph)?],
4818 ));
4819 }
4820 drop(d);
4821 let reach = self.reach_bitmaps()?;
4822 if !reach.is_empty() {
4823 out.push(ReservedSection::arrow(
4824 GUNNAR_REACH_MODULE,
4825 crate::reach::reach_schema(),
4826 vec![crate::reach::build_reach_batch(&reach)?],
4827 ));
4828 }
4829 Ok(out)
4830 }
4831}
4832
4833// ── the runtime selector ──────────────────────────────────────────────────────
4834
4835/// **A [`GitStore`] whose index arm was chosen at run time.**
4836///
4837/// The [`ObjectIndex`] arm is a *type*, so a value can only choose it by naming
4838/// every monomorphisation. This enum is that list, and it is an enum rather than
4839/// a `Box<dyn GitOps>` for two reasons:
4840///
4841/// * a boxed trait object can only offer the twelve, and the arms differ in
4842/// things the twelve deliberately do not expose — how many Arrow bytes the
4843/// projection actually materialised, which writer is on the ack path. A bench
4844/// or an operator dump needs those, and a guard needs them to assert that the
4845/// selector selected **on applied output** rather than on a label;
4846/// * there is no allocation and no vtable: the `match` is one predictable branch
4847/// at the top of a call, and everything under it — the `stree` probe, the
4848/// Arrow gather, the redb tail — is the same fully static code
4849/// [`GitStore::<S>::open_with_arms`](GitStore::open_with_arms) produces,
4850/// because `S` is known inside each arm.
4851///
4852/// # What it costs, stated rather than hidden
4853///
4854/// One branch per [`GitOps`] call — **not per object**. `extents(&[1000 oids])`
4855/// is one branch and a thousand monomorphised lookups behind it. The binary
4856/// carries three copies of the store, which is the price of picking a type at
4857/// run time and there is no version of this that does not pay it.
4858///
4859/// A caller that knows its arm at compile time should **not** come through here:
4860/// [`GitStore::open`] and [`GitStore::open_with_arms`] hand back a concrete
4861/// store with no branch at all, and that includes every caller that wants the
4862/// default.
4863pub enum SelectedStore {
4864 OneTableFourColumns(GitStore<OneTableFourColumns>),
4865 FourTables(GitStore<crate::index_layout::FourTables>),
4866 PackedPayload(GitStore<crate::index_layout::PackedPayload>),
4867}
4868
4869/// One expression, evaluated against whichever concrete store this is. The
4870/// delegation below is generated from it so there is no second copy of any
4871/// method body (LAW 5).
4872macro_rules! on_arm {
4873 ($self:ident, $s:ident => $body:expr) => {
4874 match $self {
4875 SelectedStore::OneTableFourColumns($s) => $body,
4876 SelectedStore::FourTables($s) => $body,
4877 SelectedStore::PackedPayload($s) => $body,
4878 }
4879 };
4880}
4881
4882impl SelectedStore {
4883 /// The arms this store was built with.
4884 pub fn arms(&self) -> StoreConfig {
4885 on_arm!(self, s => s.arms())
4886 }
4887
4888 /// **The explode band** — bytes held in each pool, the budget, and what has
4889 /// been evicted since this store was opened. `Admin.StorageInfo` and the
4890 /// dashboard's `explode 3.1G/8G` cell.
4891 pub fn explode_cache_use(&self) -> crate::exploded_cache::CacheUse {
4892 on_arm!(self, s => s.explode_cache_use())
4893 }
4894
4895 /// **This repository's explode quota, set live.** What the control plane
4896 /// calls when an account's plan changes. It never refuses a read and never
4897 /// deletes on the caller's thread: over budget evicts at the next rotation,
4898 /// and an account at its limit still serves every object — from the pack,
4899 /// which is slower and never wrong.
4900 pub fn set_explode_budget(&self, bytes: u64) {
4901 on_arm!(self, s => s.set_explode_budget(bytes))
4902 }
4903
4904 /// **`repo gc` reclaims the cache**: every lazy segment unlinked, the graph
4905 /// pool kept. Returns the bytes that left the filesystem.
4906 pub fn drop_explode_cache(&self) -> anyhow::Result<u64> {
4907 on_arm!(self, s => s.drop_explode_cache())
4908 }
4909
4910 /// The selected writer's name, as it goes on a bench row.
4911 pub fn writer_name(&self) -> &'static str {
4912 on_arm!(self, s => s.writer_name())
4913 }
4914
4915 /// What the selected writer's `append` promises.
4916 pub fn writer_durability(&self) -> &'static str {
4917 on_arm!(self, s => s.writer_durability())
4918 }
4919
4920 /// **Arrow IPC bytes the selected index arm actually materialised.**
4921 ///
4922 /// The applied output that distinguishes one layout from another: a packed
4923 /// 25-byte column, four columns in one section and four independent
4924 /// sections are three different numbers for the same objects. This is what
4925 /// a guard reads to prove the selector selected, because a *name* would
4926 /// prove only that a name was copied.
4927 pub fn index_ipc_bytes(&self) -> usize {
4928 on_arm!(self, s => s.index().ipc_bytes())
4929 }
4930
4931 /// **The name the built projection reports about itself** —
4932 /// `OneTableFourColumns`, `FourTables` or `PackedPayload`.
4933 ///
4934 /// The other half of the applied-output pair [`index_ipc_bytes`] starts:
4935 /// the byte count separates the arms once objects are in the store, and
4936 /// this separates them from the instant it is built, including on an empty
4937 /// store where all three materialise nothing. It is the value
4938 /// [`crate::arms::IndexArm::projection_name`] exists to be compared with —
4939 /// what the layout calls itself, never what the selector asked for — so a
4940 /// server logging it is stating what it built rather than repeating its own
4941 /// environment back.
4942 ///
4943 /// [`index_ipc_bytes`]: SelectedStore::index_ipc_bytes
4944 pub fn index_name(&self) -> &'static str {
4945 on_arm!(self, s => s.index().projection_name())
4946 }
4947
4948 /// The oids a pushed extent introduced — [`GitStore::oids_in_extent`],
4949 /// delegated.
4950 ///
4951 /// Not one of the twelve (a pack's extent is a znippy concept), so it does
4952 /// not arrive with the [`GitOps`] impl below and has to be forwarded by
4953 /// hand. A server that reports the objects a push introduced needs it, and
4954 /// a server that picked its index arm at run time still needs it.
4955 pub fn oids_in_extent(&self, extent: Extent) -> Result<Vec<Vec<u8>>> {
4956 on_arm!(self, s => s.oids_in_extent(extent))
4957 }
4958
4959 /// Objects in the `objects` table.
4960 pub fn object_count(&self) -> usize {
4961 on_arm!(self, s => s.object_count())
4962 }
4963
4964 /// Block until the background drain has absorbed everything pushed.
4965 pub fn wait_indexed(&self) {
4966 on_arm!(self, s => s.wait_indexed())
4967 }
4968
4969 /// Stop this store's index work; see [`GitStore::cancel_index`].
4970 pub fn cancel_index(&self) {
4971 on_arm!(self, s => s.cancel_index())
4972 }
4973
4974 /// This store's index progress; see [`GitStore::index_progress`].
4975 pub fn index_progress(&self) -> crate::progress::Snapshot {
4976 on_arm!(self, s => s.index_progress())
4977 }
4978
4979 /// Rebuild the projection, so the layout under test is what answers rather
4980 /// than the redb tail.
4981 pub fn rebuild_projection(&self) -> Result<()> {
4982 on_arm!(self, s => s.index().rebuild())
4983 }
4984
4985 /// The twelfth method — inherent, not on [`GitOps`], because it returns
4986 /// Arrow `ReservedSection`s a gix backend has no analog for.
4987 pub fn seal(&self) -> Result<Vec<ReservedSection>> {
4988 on_arm!(self, s => s.seal())
4989 }
4990}
4991
4992impl GitOps for SelectedStore {
4993 fn put(&self, pack: &[u8], refs: &[RefUpdate]) -> Result<TxId> {
4994 on_arm!(self, s => s.put(pack, refs))
4995 }
4996 fn put_pack(&self, bytes: &[u8]) -> Result<TxId> {
4997 on_arm!(self, s => s.put_pack(bytes))
4998 }
4999 // Delegated like every other method, and that is the point: without these
5000 // two lines a `SelectedStore` would silently inherit the trait's *default*
5001 // `put_pack_observed` — the one that publishes nothing — and every store
5002 // gunnar actually opens goes through this enum. The count would have been
5003 // implemented in `store.rs` and unreachable in production.
5004 fn put_pack_observed(
5005 &self,
5006 bytes: &[u8],
5007 progress: &dyn git_storage_trait::PackProgress,
5008 ) -> Result<TxId> {
5009 on_arm!(self, s => s.put_pack_observed(bytes, progress))
5010 }
5011 fn publishes_pack_progress(&self) -> bool {
5012 on_arm!(self, s => s.publishes_pack_progress())
5013 }
5014 fn put_refs(&self, updates: &[RefUpdate]) -> Result<TxId> {
5015 on_arm!(self, s => s.put_refs(updates))
5016 }
5017 fn get(&self, oid: Oid<'_>) -> Result<Option<Stored>> {
5018 on_arm!(self, s => s.get(oid))
5019 }
5020 fn has(&self, oid: Oid<'_>) -> Result<bool> {
5021 on_arm!(self, s => s.has(oid))
5022 }
5023 fn size(&self, oid: Oid<'_>) -> Result<Option<u64>> {
5024 on_arm!(self, s => s.size(oid))
5025 }
5026 fn extents(&self, oids: &[Oid<'_>]) -> Result<Vec<Option<Extent>>> {
5027 on_arm!(self, s => s.extents(oids))
5028 }
5029 fn refs(&self) -> Result<Vec<RefRow>> {
5030 on_arm!(self, s => s.refs())
5031 }
5032 fn update_ref(&self, name: &str, old: Option<Oid<'_>>, new: Option<Oid<'_>>) -> Result<TxId> {
5033 on_arm!(self, s => s.update_ref(name, old, new))
5034 }
5035 fn put_refs_cas(&self, edits: &[git_storage_trait::RefCas<'_>]) -> Result<TxId> {
5036 on_arm!(self, s => s.put_refs_cas(edits))
5037 }
5038 fn reachable(&self, want: &[Oid<'_>], have: &[Oid<'_>]) -> Result<Vec<Vec<u8>>> {
5039 on_arm!(self, s => s.reachable(want, have))
5040 }
5041 fn gc(&self) -> Result<GcReport> {
5042 on_arm!(self, s => s.gc())
5043 }
5044}
5045
5046/// The reading contract, delegated the same way [`GitOps`] is.
5047///
5048/// Every method is one predictable branch over a monomorphised body — the same
5049/// arrangement, and the same cost argument, [`SelectedStore`] makes for the
5050/// eleven. It is here rather than in [`crate::serve`] only because the macro
5051/// that generates it lives in this module.
5052impl crate::serve::GitServe for SelectedStore {
5053 fn read(&self, oid: Oid<'_>) -> Result<Option<(crate::index_layout::ObjType, Vec<u8>)>> {
5054 on_arm!(self, s => crate::serve::GitServe::read(s, oid))
5055 }
5056 fn header(&self, oid: Oid<'_>) -> Result<Option<(crate::index_layout::ObjType, u64)>> {
5057 on_arm!(self, s => crate::serve::GitServe::header(s, oid))
5058 }
5059 fn sizes(&self, oids: &[Oid<'_>]) -> Result<Vec<Option<u64>>> {
5060 on_arm!(self, s => crate::serve::GitServe::sizes(s, oids))
5061 }
5062 fn index_now(&self) -> Result<usize> {
5063 on_arm!(self, s => crate::serve::GitServe::index_now(s))
5064 }
5065 fn head(&self) -> Result<Option<RefRow>> {
5066 on_arm!(self, s => crate::serve::GitServe::head(s))
5067 }
5068 fn set_head(&self, target: &str) -> Result<TxId> {
5069 on_arm!(self, s => crate::serve::GitServe::set_head(s, target))
5070 }
5071 /// `objects` is the **exact set to emit**, not tips to close over — the
5072 /// contract's word, and this forwarder uses it so that the name cannot drift
5073 /// back into `want` one arm at a time. See [`crate::serve::GitServe::emit_pack`].
5074 fn emit_pack(
5075 &self,
5076 objects: &[Oid<'_>],
5077 have: &[Oid<'_>],
5078 caps: &git_storage_trait::Caps,
5079 out: &mut dyn std::io::Write,
5080 ) -> Result<git_storage_trait::PackStats> {
5081 on_arm!(self, s => crate::serve::GitServe::emit_pack(s, objects, have, caps, out))
5082 }
5083 fn select(
5084 &self,
5085 want: &[Oid<'_>],
5086 have: &[Oid<'_>],
5087 ) -> Result<Option<git_storage_trait::ReachSet>> {
5088 on_arm!(self, s => crate::serve::GitServe::select(s, want, have))
5089 }
5090}
5091
5092/// **Open a store with all three arms chosen at run time.**
5093///
5094/// The one place [`crate::arms::IndexArm`] — a value — is turned into `S` — a
5095/// type. See [`SelectedStore`] for what the resulting handle costs.
5096pub fn open_selected(
5097 root: &Path,
5098 account: &str,
5099 hash: GitHashKind,
5100 arms: StoreConfig,
5101) -> Result<SelectedStore> {
5102 use crate::arms::IndexArm;
5103 use crate::index_layout::{FourTables, PackedPayload};
5104 Ok(match arms.index {
5105 IndexArm::OneTableFourColumns => {
5106 SelectedStore::OneTableFourColumns(GitStore::<OneTableFourColumns>::open_with_arms(
5107 root, account, hash, arms,
5108 )?)
5109 }
5110 IndexArm::FourTables => SelectedStore::FourTables(GitStore::<FourTables>::open_with_arms(
5111 root, account, hash, arms,
5112 )?),
5113 IndexArm::PackedPayload => SelectedStore::PackedPayload(
5114 GitStore::<PackedPayload>::open_with_arms(root, account, hash, arms)?,
5115 ),
5116 })
5117}
5118
5119/// **The env-driven front door**: read the three variables **once**, here, and
5120/// build the store they name.
5121///
5122/// This is the whole runtime selector a server or a bench needs — one call, one
5123/// triple of `getenv`s, and from then on the store holds built objects and reads
5124/// nothing. There is deliberately no per-operation lookup of any kind: a
5125/// `std::env::var` inside a serving loop would be one syscall per object served,
5126/// which is a real defect that was found and fixed in gunnar the day before this
5127/// was written. [`crate::arms::env_reads`] counts every read this crate makes so
5128/// that "once, at construction" is an assertion rather than a claim.
5129///
5130/// An unset variable takes the shipping default, so a process with a clean
5131/// environment gets exactly [`GitStore::open`]'s combination.
5132pub fn open_from_env(root: &Path, account: &str, hash: GitHashKind) -> Result<SelectedStore> {
5133 let arms = StoreConfig::from_env()?;
5134 open_selected(root, account, hash, arms)
5135}
5136
5137impl<S: ObjectIndex> Absorber<S> {
5138 /// **One object's resolved content, and §14's table is what answers.**
5139 ///
5140 /// Two paths, and they are not interchangeable even though they return
5141 /// identical bytes:
5142 ///
5143 /// 1. **the exploded table** — one point lookup, no inflate, no delta chain;
5144 /// 2. **re-derived from the verbatim truth** — find which pack holds the
5145 /// object, read the whole pack back, resolve it. Correct and slow, and it
5146 /// exists because the table is droppable: a store whose table has been
5147 /// deleted, or whose re-explosion has not caught up, must still answer.
5148 ///
5149 /// The counters are the only way to tell them apart. Identical bytes come
5150 /// back either way, so a byte comparison proves nothing about which path ran
5151 /// — that is the identity-value trap in its exact form, and it is why
5152 /// [`crate::exploded::ExplodedStats::rederived`] is bumped here rather than
5153 /// inferred.
5154 ///
5155 /// On the [`Absorber`] rather than on [`GitStore`] because that is where the
5156 /// absorb runs: the background worker has no store handle, and a base lookup
5157 /// that needed one would put the whole store behind the drain.
5158 fn resolved(&self, oid: &[u8]) -> Result<Option<(GitObjectKind, Vec<u8>)>> {
5159 Ok(self
5160 .resolved_costed(oid)?
5161 .map(|(kind, payload, _)| (kind, payload)))
5162 }
5163
5164 /// [`Self::resolved`] and the bill. `None` for the cost means a pool
5165 /// answered and nothing was rebuilt.
5166 #[allow(clippy::type_complexity)]
5167 fn resolved_costed(
5168 &self,
5169 oid: &[u8],
5170 ) -> Result<Option<(GitObjectKind, Vec<u8>, Option<crate::resolve::ReadCost>)>> {
5171 // (1) §14's table.
5172 if let Some((kind, payload)) = self.exploded.content(oid)? {
5173 return Ok(Some((kind, payload, None)));
5174 }
5175 // (2) the verbatim truth, re-derived.
5176 let Some(row) = self.objects.lookup(oid) else {
5177 // (3) not indexed yet: the pending packs, read-only, on this
5178 // reader's own thread — never by waiting for the worker.
5179 //
5180 // **This arm is the ack path's trap and it is not the ack path's
5181 // fix.** `a_read_before_the_drain_is_served_from_the_pack_and_never_waits`
5182 // is the law here: a clone must be answered while the drain is
5183 // parked, so a read may not take the absorb gate. What must not
5184 // happen is the ACK arriving here, and it no longer does —
5185 // `GitServe::index_now` runs before the connectivity check, so by
5186 // the time the check reads there is nothing pending to scan. See
5187 // [`Absorber::index_pending_now`].
5188 if self.unindexed_packs() == 0 {
5189 return Ok(None);
5190 }
5191 self.exploded.note_rederived();
5192 let (_, content) = self.scan_pending(&[], Some(oid))?;
5193 // The pending scan resolves through a `PackWalk` rather than a
5194 // chain walk, so it does not produce a bill. `None` is honest here
5195 // and is not "it was free".
5196 return Ok(content.map(|(k, p)| (k, p, None)));
5197 };
5198 // ── ONE CHAIN, not one pack ─────────────────────────────────────
5199 //
5200 // The row's `offset` addresses the entry in the archive directly, so the
5201 // object is materialised by following its own delta chain out of the
5202 // mapping — `d` inflates and `d − 1` delta applications, nothing else
5203 // touched. This used to `read_extent` the WHOLE containing pack and
5204 // re-resolve it: for `torvalds/linux` an 8.12 GiB read and a 13.9 M
5205 // object resolve **per object served**, which is the cost that forced
5206 // the exploded tier to be built eagerly at push time — and that tier
5207 // MEASURED 141.7 GiB for an 8.12 GiB pack (17×). Lazy explode is only
5208 // affordable because of this function
5209 // (`ideas/lazy-explode-index-only-at-push.md`).
5210 //
5211 // It also does not care whether the containing pack has been ABSORBED:
5212 // the bytes were fsynced before the ack, so an object whose row is in
5213 // the index is readable the instant the row is. The pending-pack scan
5214 // below is for the window before the row exists at all.
5215 self.exploded.note_rederived();
5216 let snap = self.map.snapshot()?;
5217 let src = ArchiveWindow { abs: self, snap: &snap };
5218 let offset_of = |base: &[u8]| self.objects.lookup(base).map(|r| r.offset);
5219 match crate::resolve::materialize_at(
5220 &src,
5221 row.offset,
5222 self.hash.oid_len(),
5223 &offset_of,
5224 self,
5225 ) {
5226 Ok((kind, payload, cost)) => {
5227 self.keep_for_the_next_reader(oid, kind, &payload, cost);
5228 Ok(Some((kind, payload, Some(cost))))
5229 }
5230 Err(e) => {
5231 // A chain that cannot be followed out of the mapping is not a
5232 // wrong answer to hand back: fall through to the pending scan,
5233 // which re-derives from the pack the row came in on.
5234 //
5235 // **And if that finds nothing either, the ORIGINAL error is
5236 // what comes back — never `Ok(None)`.** The row says this store
5237 // holds the object; a failed read of an object we hold is a
5238 // store defect, and answering "absent" for it turned that defect
5239 // into a refusal of somebody else's push (lane AI, 2026-08-30 —
5240 // see `crate::resolve::MAX_DELTA_LINKS`). Absence is a fact the
5241 // index states, not a shape an error decays into.
5242 if self.unindexed_packs() == 0 {
5243 return Err(e);
5244 }
5245 match self.scan_pending(&[], Some(oid))? {
5246 (_, Some((k, p))) => Ok(Some((k, p, None))),
5247 (_, None) => Err(e),
5248 }
5249 }
5250 }
5251 }
5252}
5253
5254impl<S: ObjectIndex> Absorber<S> {
5255 /// **The write-back, and it is off the reader's path.**
5256 ///
5257 /// The reader has its bytes already — this buffers a copy into the lazy
5258 /// pool's newest segment (a `memcpy` under one lock, no I/O, no fsync, no
5259 /// eviction) and, once 4 MiB have accumulated, starts a thread to do the
5260 /// writing. That is Rickard's law from the design note in one function:
5261 /// *nobody waits*. A failure here is not the read's failure — the bytes
5262 /// were correct before the cache was consulted and are correct after it
5263 /// refuses — so it is counted and swallowed rather than propagated.
5264 ///
5265 /// **It does not always write.** A shallow, small object is cheaper to
5266 /// inflate again than to keep — a whole object is one `inflate` of one zlib
5267 /// stream at one offset — so the cache declines it and counts the read as
5268 /// `direct_reads` (`exploded_cache::worth_caching`). That is Rickard's
5269 /// refinement, 2026-08-30: *do not explode uniformly*. The reader that just
5270 /// paid the bill is the only thing that knows what it was, which is why the
5271 /// cost comes back out of [`crate::resolve::materialize_at`] rather than
5272 /// being predicted from an index column.
5273 ///
5274 /// Two readers racing on one oid is benign: identical bytes, and the table
5275 /// keeps the first row it filed under that key.
5276 fn keep_for_the_next_reader(
5277 &self,
5278 oid: &[u8],
5279 kind: GitObjectKind,
5280 payload: &[u8],
5281 cost: crate::resolve::ReadCost,
5282 ) {
5283 match self.exploded.write_back(oid, kind, payload, cost) {
5284 Ok(true) => self.exploded.kick(),
5285 Ok(false) => {}
5286 Err(e) => {
5287 tracing::debug!(
5288 target: "znippy.git",
5289 store = %self.label,
5290 error = %e,
5291 "the exploded cache would not take a write-back; the read is unaffected"
5292 );
5293 }
5294 }
5295 }
5296}
5297
5298/// [`crate::reach::TreeSource`] over a live store — see
5299/// [`Absorber::tree_source`].
5300/// The oid a tag object points at, out of its header.
5301///
5302/// A tag object's payload begins `object <hex>\n` — that is the format, not a
5303/// heuristic, and it is the whole parse. Deliberately NOT reached for with a
5304/// git object library: this crate is a shipped archiver and `gix-object` is a
5305/// dev-dependency here, so pulling it into the read path to read one line would
5306/// put the pack pipeline back in an archive-only build (S-071).
5307fn tag_target_hex(payload: &[u8], oid_len: usize) -> Option<String> {
5308 let line = payload.split(|b| *b == b'\n').next()?;
5309 let rest = line.strip_prefix(b"object ")?;
5310 // Exactly the hash width this store uses, and hex. A shorter or longer
5311 // field is a malformed tag, and guessing at one would put a wrong oid into
5312 // a reachability answer — the one place a wrong answer is silent.
5313 if rest.len() != oid_len * 2 || !rest.iter().all(u8::is_ascii_hexdigit) {
5314 return None;
5315 }
5316 std::str::from_utf8(rest).ok().map(str::to_owned)
5317}
5318
5319/// Add what a tag points at — and what THAT reaches — to a reachability union.
5320///
5321/// See the call site in `reachable_raw_with` for why this exists and why doing
5322/// it in the `want` loop is complete rather than partial.
5323///
5324/// A tag of a tag is legal git, so this follows the chain; `MAX_TAG_HOPS`
5325/// bounds it because a corrupt archive could point one at itself and a
5326/// reachability walk must terminate on bad data, not hang on it.
5327fn peel_tag_into<S: ObjectIndex>(
5328 abs: &Absorber<S>,
5329 tag_hex: &str,
5330 view: &crate::reach::ReachView<'_>,
5331 facts: &crate::reach::ObjectFacts<'_>,
5332 union: &mut roaring::RoaringBitmap,
5333) {
5334 const MAX_TAG_HOPS: usize = 8;
5335 let mut cursor = tag_hex.to_owned();
5336 for _ in 0..MAX_TAG_HOPS {
5337 let Ok(raw) = hex::decode(&cursor) else { return };
5338 // Not a tag, unreadable, or absent: nothing to peel. An unreadable
5339 // object makes the closure SHORT, and a short closure is refused
5340 // downstream by name (`missing necessary objects`) rather than served
5341 // as though it were complete — the same contract `TreesFromStore::tree`
5342 // documents.
5343 let Ok(Some((GitObjectKind::Tag, payload))) = abs.resolved(&raw) else { return };
5344 let Some(target) = tag_target_hex(&payload, facts.oid_len) else { return };
5345 if let Some(bm) = view.bitmap(target.as_str()) {
5346 *union |= bm;
5347 return;
5348 }
5349 if view.is_commit(target.as_str()) {
5350 crate::reach::accumulate(target.as_str(), view, facts, union);
5351 return;
5352 }
5353 let Some(o) = facts.ordinal.ordinal_of_hex(target.as_str()) else { return };
5354 union.insert(o);
5355 // A tag may point at a TREE, whose subtrees and blobs are then just as
5356 // necessary as a commit's would be. Inserting the tree alone would be
5357 // the same bug one level down.
5358 match abs.resolved(&hex::decode(&target).unwrap_or_default()) {
5359 Ok(Some((GitObjectKind::Tree, _))) => {
5360 crate::reach::accumulate_tree(target.as_str(), facts, union);
5361 return;
5362 }
5363 Ok(Some((GitObjectKind::Tag, _))) => cursor = target,
5364 // A blob, or unreadable: it is in, and it has no closure.
5365 _ => return,
5366 }
5367 }
5368}
5369
5370struct TreesFromStore<'a, S: ObjectIndex> {
5371 abs: &'a Absorber<S>,
5372}
5373
5374impl<S: ObjectIndex> crate::reach::TreeSource for TreesFromStore<'_, S> {
5375 fn tree(&self, oid_hex: &str) -> Option<std::borrow::Cow<'_, [u8]>> {
5376 let raw = hex::decode(oid_hex).ok()?;
5377 // A read that fails is `None`, which is what an object this archive
5378 // does not hold has always answered here — the walk stops at it. It is
5379 // NOT silently dropping an error that matters: an unreadable tree makes
5380 // the closure short, and a short closure is refused downstream by name
5381 // (`missing necessary objects`) rather than served as if it were
5382 // complete.
5383 match self.abs.resolved(&raw) {
5384 Ok(Some((GitObjectKind::Tree, payload))) => Some(std::borrow::Cow::Owned(payload)),
5385 // A blob, a tag, a gitlink, or absent: all "not a tree here".
5386 Ok(_) => None,
5387 Err(e) => {
5388 tracing::debug!(
5389 target: "znippy.git",
5390 store = %self.abs.label,
5391 oid = oid_hex,
5392 error = %e,
5393 "a reachability walk could not read a tree; the walk stops there"
5394 );
5395 None
5396 }
5397 }
5398 }
5399}
5400
5401/// The verbatim archive as [`crate::resolve::ArchiveBytes`]: **the mapping
5402/// where it reaches, a `pread` past its end.**
5403///
5404/// One snapshot is taken per read and sliced as many times as the chain is
5405/// deep, which is [`crate::archive_map::ArchiveMap::snapshot`]'s contract. The
5406/// `pread` arm is the one a push that landed after the snapshot takes; both
5407/// arms return the same bytes and differ only in what they cost.
5408struct ArchiveWindow<'a, S: ObjectIndex> {
5409 abs: &'a Absorber<S>,
5410 snap: &'a crate::archive_map::Mapped,
5411}
5412
5413impl<S: ObjectIndex> crate::resolve::ArchiveBytes for ArchiveWindow<'_, S> {
5414 fn at(&self, at: u64, len: u64) -> Result<std::borrow::Cow<'_, [u8]>> {
5415 // A probe near the end of the archive legitimately gets fewer bytes
5416 // than it asked for, so the window is clamped rather than refused —
5417 // the parsers read a grammar, not a fixed width.
5418 let mapped = self.snap.len();
5419 if at < mapped {
5420 let have = (mapped - at).min(len);
5421 if let Some(b) = self.snap.get(at, have) {
5422 return Ok(std::borrow::Cow::Borrowed(b));
5423 }
5424 }
5425 let end = self
5426 .abs
5427 .reader
5428 .metadata()
5429 .map(|m| m.len())
5430 .unwrap_or(mapped);
5431 if at >= end {
5432 return Ok(std::borrow::Cow::Owned(Vec::new()));
5433 }
5434 let have = (end - at).min(len);
5435 Ok(std::borrow::Cow::Owned(self.abs.read_extent(at, have)?))
5436 }
5437}
5438
5439/// A thin pack's external delta base, answered from §14's exploded table.
5440///
5441/// Before that table existed this had to read and re-resolve a whole pack per
5442/// base, and it deliberately cached nothing — because a cache here *would* have
5443/// been the undecided table. It is decided now (eager, 2026-08-08), so the cache
5444/// is the table and this is one point lookup.
5445///
5446/// **`None` means absent and `Err` means unreadable, and they are not the same
5447/// answer.** A base this store does not hold still comes back `Ok(None)` and
5448/// [`crate::resolve::ResolveError::missing_base`] refuses the pack by name.
5449///
5450/// # 🔴 This was `.ok().flatten()`
5451///
5452/// A store that HELD the base and could not reconstruct it answered exactly
5453/// like one that never had it, so the resolver blamed the pushed pack: *"this
5454/// repository genuinely does not have that object"*, about an object one index
5455/// lookup away. That sentence went to the client on the `ng` line and to the
5456/// operator in the log, and it named the wrong party — lane AI, 2026-08-30, 21
5457/// of 140 ordinary pushes. The error travels now.
5458impl<S: ObjectIndex> BaseSource for Absorber<S> {
5459 fn content(&self, oid: &[u8]) -> Result<Option<(GitObjectKind, Vec<u8>)>> {
5460 self.resolved(oid).with_context(|| {
5461 format!(
5462 "reading the delta base {} out of this store — it is not absent, it could not \
5463 be reconstructed",
5464 hex::encode(oid)
5465 )
5466 })
5467 }
5468}
5469
5470#[cfg(test)]
5471mod tests {
5472 use super::*;
5473 use crate::archive_write::{read_journal, SafeWriter};
5474 use crate::object::GitObjectKind;
5475 use crate::store::tests::{one_blob_pack, corpus_pack, tmpdir};
5476 use std::collections::HashSet;
5477 use std::sync::atomic::{AtomicBool, AtomicU64, Ordering as AtomicOrdering};
5478 use std::time::{Duration, Instant};
5479 use znippy_zoomies::background::Job;
5480 use znippy_zoomies::gatling_forkjoin::gatling_for_each;
5481
5482 fn loadavg() -> String {
5483 std::fs::read_to_string("/proc/loadavg")
5484 .unwrap_or_default()
5485 .split_whitespace()
5486 .take(3)
5487 .collect::<Vec<_>>()
5488 .join(" ")
5489 }
5490
5491 /// **The one representation answers exactly what the two it replaced did.**
5492 ///
5493 /// Before S-082 the store carried the ordinal space three times: `oids_raw`
5494 /// (flat bytes), `oids` (hex `Vec<String>`) and `ordinal`
5495 /// (`HashMap<String, u32>`). The last two are gone; oid ⇄ ordinal is now a
5496 /// slice and a binary search over `oids_raw`, through
5497 /// [`crate::reach::OrdinalSpace`]. This rebuilds those two OLD tables inline
5498 /// from the SAME `oids_raw` the store folded, and asserts the new lookups
5499 /// return the identical answer **for every oid in a real corpus** — the
5500 /// property that lets the field be removed without a server ever naming the
5501 /// wrong object in a pack, which no exit code could see.
5502 ///
5503 /// Seen RED by an off-by-one binary search (`Equal => Some(mid as u32 + 1)`
5504 /// in [`crate::reach::OrdinalSpace::ordinal_of_raw`]): every
5505 /// `ordinal_of_raw` / `ordinal_of_hex` below disagreed with the old
5506 /// `HashMap`, and the closure comparison at the end disagreed as well.
5507 #[test]
5508 fn the_one_ordinal_space_answers_what_the_two_it_replaced_did() {
5509 let dir = tmpdir("ordinal-space-one-representation");
5510 let (pack, rows) = corpus_pack();
5511 let store = GitStore::open(&dir, "rickard").unwrap();
5512 store.put_pack(&pack).unwrap();
5513 store.wait_indexed();
5514
5515 let oid_len = store.hash_kind().oid_len();
5516 let raw = {
5517 let d = store.absorber.derived.read().unwrap();
5518 d.oids_raw.clone()
5519 };
5520 // The two tables `refold` used to build, rebuilt here from the same
5521 // bytes — this IS the "old" answer the new lookups must equal.
5522 let old_oids: Vec<String> = raw.chunks_exact(oid_len).map(hex::encode).collect();
5523 let old_ordinal: std::collections::HashMap<String, u32> = old_oids
5524 .iter()
5525 .enumerate()
5526 .map(|(i, o)| (o.clone(), i as u32))
5527 .collect();
5528
5529 assert!(
5530 !old_oids.is_empty(),
5531 "the fixture pack ({} entries) folded to an EMPTY ordinal space, so every \
5532 comparison below would hold vacuously",
5533 rows.len()
5534 );
5535 assert_eq!(
5536 raw.len(),
5537 old_oids.len() * oid_len,
5538 "the raw ordinal space is {} bytes for {} oids of {oid_len} bytes",
5539 raw.len(),
5540 old_oids.len()
5541 );
5542
5543 let space = crate::reach::OrdinalSpace::new(&raw, oid_len);
5544 assert_eq!(space.len(), old_oids.len(), "the space holds a different count");
5545 let mut checked = 0usize;
5546 for (o, h) in old_oids.iter().enumerate() {
5547 let want_ord = old_ordinal[h];
5548 // oid → ordinal, hex and raw, both == the old HashMap answer.
5549 assert_eq!(
5550 space.ordinal_of_hex(h),
5551 Some(want_ord),
5552 "ordinal_of_hex({h}) != the old HashMap answer {want_ord}"
5553 );
5554 let raw_oid = hex::decode(h).unwrap();
5555 assert_eq!(
5556 space.ordinal_of_raw(&raw_oid),
5557 Some(want_ord),
5558 "ordinal_of_raw disagrees with the old HashMap at {h}"
5559 );
5560 // ordinal → oid == the old hex Vec's slice, in both spellings.
5561 assert_eq!(
5562 space.oid(o as u32),
5563 Some(raw_oid.as_slice()),
5564 "oid({o}) != the old oids_raw slice"
5565 );
5566 assert_eq!(
5567 space.oid(o as u32).map(hex::encode).as_deref(),
5568 Some(h.as_str()),
5569 "oid({o}) hex != the old hex Vec entry {h}"
5570 );
5571 checked += 1;
5572 }
5573 assert_eq!(checked, old_oids.len());
5574
5575 // A non-member answers None both ways, exactly as `HashMap::get` did for
5576 // an absent key — the binary search must not land on a neighbour.
5577 let absent = vec![0xffu8; oid_len];
5578 assert_eq!(space.ordinal_of_raw(&absent), None, "an absent oid resolved to an ordinal");
5579 assert_eq!(
5580 space.ordinal_of_hex(&hex::encode(&absent)),
5581 None,
5582 "an absent hex oid resolved to an ordinal"
5583 );
5584 // A wrong-width key is absent, not a panic.
5585 assert_eq!(space.ordinal_of_raw(&absent[..oid_len - 1]), None);
5586 assert_eq!(space.oid(old_oids.len() as u32), None, "an out-of-range ordinal named an oid");
5587
5588 // And the answer built out of it: the raw closure IS the hex closure,
5589 // for a real tip rather than for an empty request.
5590 let tip = store
5591 .graph_snapshot()
5592 .into_iter()
5593 .max_by_key(|c| c.generation)
5594 .expect("a graph");
5595 let tip_raw = hex::decode(&tip.oid).unwrap();
5596 let flat = store.reachable_raw(&[&tip_raw], &[]).unwrap();
5597 let hexed = store.reachable_oids(&[&tip_raw], &[]).unwrap();
5598 assert!(
5599 flat.len() > 1,
5600 "the tip's closure is {} object(s) — too small to tell an ordering bug from a \
5601 coincidence",
5602 flat.len()
5603 );
5604 assert_eq!(
5605 flat.iter().map(hex::encode).collect::<Vec<_>>(),
5606 hexed,
5607 "the serving answer and the maintenance answer name different objects"
5608 );
5609 assert!(flat.contains(&tip_raw), "a closure without its own tip");
5610 eprintln!(
5611 "load {}; {} ordinals agree in both spellings, tip closure {} objects",
5612 loadavg(),
5613 checked,
5614 flat.len()
5615 );
5616 }
5617
5618 /// Distinct commits in a resolved pack — what the graph must hold exactly
5619 /// once.
5620 fn commits_in(rows: &[crate::resolve::Resolved]) -> usize {
5621 rows.iter()
5622 .filter(|r| r.kind == GitObjectKind::Commit)
5623 .map(|r| r.oid.clone())
5624 .collect::<HashSet<Vec<u8>>>()
5625 .len()
5626 }
5627
5628 /// **A push ends in object rows, and no read asked for them.**
5629 ///
5630 /// This is the seam this file wires: before it, `put` produced a *pack* row
5631 /// on the account indexer's channel and the object rows appeared only when
5632 /// somebody read (or called `absorb_pending` by hand). Here nothing is read
5633 /// between `put_pack` and `wait_indexed` — the only thing that could have
5634 /// built the rows is the drain.
5635 ///
5636 /// Asserted on applied output: one row per pack entry, every oid resolving
5637 /// out of the index, and the pack's indexed bit up. `absorb_failures` is
5638 /// asserted too, because a drain that absorbed nothing and recorded the
5639 /// failure would otherwise look like a drain that was never called.
5640 ///
5641 /// Seen RED by making the drain skip the absorber
5642 /// (`match absorber.as_deref()` → `match None::<&dyn ObjectAbsorb>` in
5643 /// `indexer::index_worker`): "the drain built no object rows: 0 of 2687".
5644 /// Restored.
5645 ///
5646 /// MEASURED on oden, 2026-08-08, release, three runs at **1-minute loadavg
5647 /// 5.77** (another tenant's work — oden is shared, so this is not an idle
5648 /// box): 2687 objects out of a 5 653 302-byte real pack absorbed in
5649 /// 161–164 ms, **16 421–16 673 object rows/s**, behind an ack of 29.1–29.4 ms.
5650 /// An earlier set at loadavg 16.94 gave 15 528 rows/s, so the figure moves
5651 /// about 7% with the box.
5652 ///
5653 /// Read it as a *floor* rather than as the engine's speed: the drain here is
5654 /// one pack, so it never uses more than one absorb, and the 162 ms covers a
5655 /// full inflate-and-delta-apply of every entry, a SHA-1 per object, the redb
5656 /// append and a whole-tail re-fold. Nothing about it has been optimised and
5657 /// no arm of it has been isolated. The rate is printed with the loadavg of
5658 /// its own run so a later number is never compared against a different
5659 /// machine state by accident.
5660 #[test]
5661 fn a_push_ends_in_object_rows_and_no_read_asked_for_them() {
5662 let dir = tmpdir("drain-rows");
5663 let store = GitStore::open(&dir, "rickard").unwrap();
5664 let (pack, rows) = corpus_pack();
5665
5666 let t = Instant::now();
5667 let tx = store.put_pack(&pack).unwrap();
5668 let ack = t.elapsed();
5669 let pack_id = tx.pack_id.expect("a pack push assigns an id");
5670
5671 // Nothing is read here. The drain is the only thing that can move.
5672 store.wait_indexed();
5673 let drained = t.elapsed();
5674
5675 assert_eq!(
5676 store.object_count(),
5677 rows.len(),
5678 "the drain built no object rows: {} of {}",
5679 store.object_count(),
5680 rows.len()
5681 );
5682 assert_eq!(store.unindexed_packs(), 0, "the bit is still clear");
5683 assert!(
5684 store.indexer().is_indexed(pack_id),
5685 "the pack's indexed bit is not up after the drain"
5686 );
5687 assert_eq!(
5688 store.indexer().absorb_failures(),
5689 0,
5690 "the drain recorded an absorb failure: {:?}",
5691 store.indexer().last_absorb_error()
5692 );
5693
5694 // Every oid answers **out of the rows**, not out of a fallback: the
5695 // index is asked directly, so nothing can absorb behind this loop.
5696 for (i, r) in rows.iter().enumerate() {
5697 let row = store
5698 .index()
5699 .lookup(&r.oid)
5700 .unwrap_or_else(|| panic!("object {i} {} has no row", hex::encode(&r.oid)));
5701 assert_eq!(
5702 (row.offset, row.len),
5703 (tx.extent.unwrap().0 + r.offset, r.len)
5704 );
5705 assert_eq!(row.uncompressed_size, r.uncompressed_size);
5706 }
5707 assert_eq!(
5708 store.absorb_pending().unwrap(),
5709 0,
5710 "the drain left work for a read to do"
5711 );
5712 assert_eq!(
5713 store.commit_count(),
5714 commits_in(&rows),
5715 "the commit graph does not match the pack"
5716 );
5717
5718 let secs = (drained - ack).as_secs_f64();
5719 eprintln!(
5720 "load {}; {} objects in {} bytes: ack {:.0} µs, drain {:.1} ms, {:.0} object rows/s",
5721 loadavg(),
5722 rows.len(),
5723 pack.len(),
5724 ack.as_secs_f64() * 1e6,
5725 (drained - ack).as_secs_f64() * 1e3,
5726 rows.len() as f64 / secs.max(1e-9),
5727 );
5728 }
5729
5730 // ── the bit across a restart ─────────────────────────────────────────────
5731
5732 /// Where the child of the kill guard finds its fixture and leaves its marker.
5733 const KILL_DIR: &str = "GUNNAR_KILL_MID_ABSORB_DIR";
5734
5735 /// **The other half of [`a_store_reopened_after_a_kill_mid_absorb_requeues_the_pack`]:
5736 /// the process that dies.**
5737 ///
5738 /// It runs as a child of that test and it **aborts on purpose**, which is why
5739 /// it is `#[ignore]`d: `SIGABRT` from inside a test binary is a failing test
5740 /// run, and the point is for the *parent* to see the signal.
5741 ///
5742 /// The kill lands where it has to land — after `put_pack` has returned, so
5743 /// the bytes and the journal row are on the platter, and before any row is in
5744 /// the index, which the held absorb gate makes a **state** rather than a
5745 /// hope. Nothing is simulated: no injected error, no fault flag, no early
5746 /// return. The process is gone.
5747 #[test]
5748 #[ignore = "spawned by a_store_reopened_after_a_kill_mid_absorb_requeues_the_pack; it aborts on purpose"]
5749 fn the_child_that_dies_between_durable_bytes_and_indexed_rows() {
5750 let Ok(dir) = std::env::var(KILL_DIR) else {
5751 // Run by hand with `--ignored` and no fixture: there is nothing to
5752 // kill over, so do nothing rather than abort somebody's test run.
5753 return;
5754 };
5755 let dir = PathBuf::from(dir);
5756 let pack = std::fs::read(dir.join("fixture.pack")).expect("the parent's fixture");
5757
5758 let store = GitStore::open(&dir, "rickard").expect("open");
5759 // The drain is parked in front of its absorb for as long as this lives,
5760 // so no row can land before the abort below.
5761 let _gate = store.hold_absorb_gate();
5762 let tx = store.put_pack(&pack).expect("the ack path");
5763 assert_eq!(tx.pack_id, Some(0), "a fresh archive starts at ordinal 0");
5764 assert_eq!(store.unindexed_packs(), 1, "the pack is not queued");
5765 assert_eq!(store.index().len(), 0, "a row landed before the kill");
5766 std::fs::write(dir.join("ready"), b"durable, not indexed").expect("marker");
5767
5768 // Not `panic!`, not `exit`: the process stops here with a live gate, a
5769 // live worker and a live redb handle, which is what a machine that dies
5770 // mid-absorb leaves behind.
5771 std::process::abort();
5772 }
5773
5774 /// **A store reopened over a pack that was still being absorbed re-queues
5775 /// it, answers correctly the whole way through, and gets its derived tables
5776 /// back.**
5777 ///
5778 /// The interruption is a **real** one: a child process is spawned, pushes the
5779 /// pack, and is killed by `SIGABRT` between "bytes durable" and "rows
5780 /// indexed". The parent then asserts what the kill left on disk — one journal
5781 /// row, the pack verbatim, **zero** index rows — before opening a store over
5782 /// it, so the recovery is being tested against the state it claims to
5783 /// recover from and not against a lucky one.
5784 ///
5785 /// Three things are then asserted, all on applied output:
5786 ///
5787 /// 1. **the pack is re-queued** — the account indexer of the *new* process
5788 /// publishes ordinal 0, which it can only do for a job somebody submitted;
5789 /// 2. **a read is correct throughout** — `has` is asked the instant the store
5790 /// is open, before any drain has been waited for, and must answer `true`;
5791 /// 3. **`commit_count()` and `reachable()` come back** — the derived tables
5792 /// are rebuilt by the same absorb, so the graph holds exactly the pack's
5793 /// commits and a tip's closure is non-empty.
5794 ///
5795 /// Seen RED by making `open_with` re-queue nothing (`absorber
5796 /// .adopt_journal(&acked)?` → an empty `Vec`, which is what this store did
5797 /// before this change): "a durable object read `absent` from a store reopened
5798 /// over the pack that holds it — the crash-recovery bit did not re-queue
5799 /// anything". Restored.
5800 ///
5801 /// Seen RED a second time by inverting the diff in
5802 /// [`Absorber::adopt_journal`] (`if absorbed` → `if !absorbed`), so a pack
5803 /// with **no** rows has its bit set and a pack with rows is re-queued: the
5804 /// same first assertion fires, because a set bit over an empty index is
5805 /// exactly the wrong answer a bloom filter's false positive would have
5806 /// produced — the read stops falling back and says `absent` about an object
5807 /// whose bytes are durable. Restored.
5808 ///
5809 /// **Why the assertions are not immediately after the reopen.** The trap the
5810 /// drain guards already record applies here too, mirrored: right after
5811 /// `GitStore::open` the drain may legitimately have finished the re-queued
5812 /// pack already, so `unindexed_packs() == 1` is not assertable and is not
5813 /// asserted. What *is* assertable at that instant is the answer to a read,
5814 /// which must be `true` whichever side of the drain it lands on — and that is
5815 /// exactly the property §13.12 promises.
5816 ///
5817 /// **And it still holds now that a `gc` can retire a pack's journal row.**
5818 /// The tombstone tells "indexed then garbage-collected" from "never
5819 /// indexed", and this pack is the second: nothing retired it, so it must
5820 /// still be re-queued. Seen RED by making `adopt_journal` treat *every* pack
5821 /// as retired (`retired.contains(&extent.0)` → `true`): "a durable object
5822 /// read `absent` from a store reopened over the pack that holds it — the
5823 /// crash-recovery bit did not re-queue anything". Restored.
5824 #[test]
5825 fn a_store_reopened_after_a_kill_mid_absorb_requeues_the_pack() {
5826 use std::os::unix::process::ExitStatusExt;
5827
5828 let dir = tmpdir("kill-mid-absorb");
5829 let (pack, rows) = corpus_pack();
5830 std::fs::write(dir.join("fixture.pack"), &pack).unwrap();
5831
5832 let status = std::process::Command::new(std::env::current_exe().unwrap())
5833 .args([
5834 "--exact",
5835 "--ignored",
5836 "--nocapture",
5837 "git_ops::tests::the_child_that_dies_between_durable_bytes_and_indexed_rows",
5838 ])
5839 .env(KILL_DIR, &dir)
5840 .status()
5841 .expect("spawn the child that dies");
5842 assert_eq!(
5843 status.signal(),
5844 Some(6),
5845 "the child did not die by SIGABRT — it {status:?}, so nothing was interrupted"
5846 );
5847 assert!(
5848 dir.join("ready").exists(),
5849 "the child never reached the kill point"
5850 );
5851
5852 // ── what the kill left on disk ───────────────────────────────────────
5853 let blobs = dir.join("objects.pack");
5854 let acked = read_journal(&SafeWriter::journal_path(&blobs)).unwrap();
5855 assert_eq!(
5856 acked.len(),
5857 1,
5858 "the pack's extent is not durable: {acked:?}"
5859 );
5860 assert_eq!(acked[0].1, pack.len() as u64);
5861 let on_disk = std::fs::read(&blobs).unwrap();
5862 assert_eq!(
5863 &on_disk[acked[0].0 as usize..(acked[0].0 + acked[0].1) as usize],
5864 &pack[..],
5865 "the verbatim bytes did not survive the kill"
5866 );
5867 {
5868 // Opened and dropped before the store takes redb's file lock.
5869 let tail = ObjectReadStack::<OneTableFourColumns>::open(
5870 &dir.join("objects.tail"),
5871 RebuildTriggers::default(),
5872 crate::arms::DEFAULT_REDB_CACHE_BYTES,
5873 )
5874 .unwrap();
5875 assert_eq!(
5876 tail.len(),
5877 0,
5878 "the kill landed after the rows were indexed, not between the bytes and the rows \
5879 — this guard would then be testing nothing"
5880 );
5881 }
5882
5883 // ── the reopen ───────────────────────────────────────────────────────
5884 let store = GitStore::open(&dir, "rickard").unwrap();
5885 assert!(
5886 store.has(&rows[0].oid).unwrap(),
5887 "a durable object read `absent` from a store reopened over the pack that holds it — \
5888 the crash-recovery bit did not re-queue anything"
5889 );
5890
5891 store.wait_indexed();
5892 assert_eq!(
5893 store.object_count(),
5894 rows.len(),
5895 "the re-queued pack's objects never reached the index — left: {}, right: {}",
5896 store.object_count(),
5897 rows.len()
5898 );
5899 assert!(
5900 store.indexer().is_indexed(0),
5901 "the re-queued pack's indexed bit never went up in the new process"
5902 );
5903 assert_eq!(store.unindexed_packs(), 0);
5904 assert_eq!(store.absorb_pending().unwrap(), 0);
5905 for r in rows.iter().take(512) {
5906 let row = store
5907 .index()
5908 .lookup(&r.oid)
5909 .unwrap_or_else(|| panic!("{} has no row after recovery", hex::encode(&r.oid)));
5910 assert_eq!((row.offset, row.len), (acked[0].0 + r.offset, r.len));
5911 }
5912
5913 // ── the derived tables, which were the second symptom ────────────────
5914 assert_eq!(
5915 store.commit_count(),
5916 commits_in(&rows),
5917 "the commit graph did not come back: {} of {}",
5918 store.commit_count(),
5919 commits_in(&rows)
5920 );
5921 let tip = store
5922 .graph_snapshot()
5923 .into_iter()
5924 .max_by_key(|c| c.generation)
5925 .expect("a graph");
5926 let tip_raw = hex::decode(&tip.oid).unwrap();
5927 let closure = store.reachable(&[&tip_raw], &[]).unwrap();
5928 assert!(
5929 !closure.is_empty(),
5930 "reachable() came back empty after the reopen"
5931 );
5932 assert!(closure.contains(&tip_raw));
5933 eprintln!(
5934 "load {}; killed mid-absorb: {} journal extent(s) recovered {} object rows, {} \
5935 commits, closure of the tip {} objects",
5936 loadavg(),
5937 acked.len(),
5938 store.object_count(),
5939 store.commit_count(),
5940 closure.len(),
5941 );
5942 }
5943
5944 /// **A clean reopen re-queues nothing, and the next push gets a fresh
5945 /// ordinal.**
5946 ///
5947 /// The other side of the diff. A store whose pack was fully absorbed before
5948 /// it closed must come back with the bit **set**: re-absorbing would be a
5949 /// whole pack re-resolved for nothing, and — because the commit graph is a
5950 /// `Vec` — it is the same doubling the drain's own guard exists to prevent.
5951 ///
5952 /// "Re-queued nothing" is asserted deterministically rather than by a timing
5953 /// window: the account indexer in this process publishes a pack only for a
5954 /// job somebody submitted, so `is_indexed(0)` being **false** after
5955 /// `wait_indexed` is proof that open submitted none.
5956 ///
5957 /// The second half is the ordinal. Pack ids are the journal's row numbers, so
5958 /// a reopened store must resume after them. Asserted on applied output rather
5959 /// than on the id alone: the newly pushed pack's object has to be findable,
5960 /// and it is exactly what goes missing when a fresh pack is handed an
5961 /// absorbed pack's ordinal — `queue` skips it, the drain skips it, and its
5962 /// durable bytes are never indexed by anybody.
5963 ///
5964 /// Seen RED by making `Absorber::adopt_journal` treat every journal extent as
5965 /// unabsorbed (`let has_rows = vec![false; journal.len()]`): "a fully
5966 /// absorbed pack was re-queued on open — the diff is not exact".
5967 ///
5968 /// Seen RED a second time by `AtomicU64::new(packs_already_acked(...)?)` →
5969 /// `AtomicU64::new(0)` in `PushPath::with_absorber`: "a reopened store handed
5970 /// a fresh pack the ordinal of an absorbed one — left: Some(0), right:
5971 /// Some(1)". With that same edit **and the id assertion deleted**, the
5972 /// applied-output one goes too — "the second push's object never reached the
5973 /// index — its ordinal collided with an absorbed pack's, so every writer
5974 /// skipped it" — which is what says this guard is about the objects and not
5975 /// about a counter. Restored.
5976 #[test]
5977 fn a_clean_reopen_requeues_nothing_and_the_next_push_gets_a_fresh_ordinal() {
5978 let dir = tmpdir("clean-reopen");
5979 let (pack, rows) = corpus_pack();
5980 let (second, blob_oid) = one_blob_pack(b"a push that arrives after the restart");
5981
5982 {
5983 let store = GitStore::open(&dir, "rickard").unwrap();
5984 store.put_pack(&pack).unwrap();
5985 store.wait_indexed();
5986 assert_eq!(
5987 store.object_count(),
5988 rows.len(),
5989 "the first run did not index"
5990 );
5991 }
5992
5993 let store = GitStore::open(&dir, "rickard").unwrap();
5994 store.wait_indexed();
5995 assert!(
5996 !store.indexer().is_indexed(0),
5997 "a fully absorbed pack was re-queued on open — the diff is not exact"
5998 );
5999 assert_eq!(store.unindexed_packs(), 0);
6000 assert_eq!(
6001 store.absorb_pending().unwrap(),
6002 0,
6003 "the reopen left index work"
6004 );
6005 assert_eq!(
6006 store.object_count(),
6007 rows.len(),
6008 "the reopened store lost rows"
6009 );
6010 assert!(store.has(&rows[0].oid).unwrap());
6011
6012 let tx = store.put_pack(&second).unwrap();
6013 assert_eq!(
6014 tx.pack_id,
6015 Some(1),
6016 "a reopened store handed a fresh pack the ordinal of an absorbed one"
6017 );
6018 store.wait_indexed();
6019 assert!(
6020 store.has(&blob_oid).unwrap(),
6021 "the second push's object never reached the index — its ordinal collided with an \
6022 absorbed pack's, so every writer skipped it"
6023 );
6024 assert_eq!(store.object_count(), rows.len() + 1);
6025 assert!(store.indexer().is_indexed(1));
6026 // And the journal is a log: both packs' extents are in it, in order.
6027 let acked = read_journal(&SafeWriter::journal_path(store.blobs_path())).unwrap();
6028 assert_eq!(
6029 acked.len(),
6030 2,
6031 "the reopen truncated the journal: {acked:?}"
6032 );
6033 assert_eq!(acked[1], tx.extent.unwrap());
6034 }
6035
6036 /// **What the derive-on-open diff costs at a realistic pack count.**
6037 ///
6038 /// Not a guard — a measurement, with two assertions on it that keep it from
6039 /// measuring the wrong thing: every absorbed pack must come back `true`, and
6040 /// the one pack that has no rows must come back `false`.
6041 ///
6042 /// Both cases are timed because they are different algorithms in practice.
6043 /// The **clean reopen** — every pack absorbed — terminates as soon as each
6044 /// extent has been hit once, which happens after a few rows per pack because
6045 /// the tail is in oid order and an oid says nothing about which pack its
6046 /// object came from. The **crash** case has one pack with no rows at all, and
6047 /// proving an absence means reading the tail to the end.
6048 ///
6049 /// MEASURED on oden 2026-08-08, release, 1000 real pushed packs / 3686 object
6050 /// rows, 1-minute loadavg 2.77: **0.38 ms** clean and 0.39 ms with one pack
6051 /// un-absorbed (0.40 / 0.39 ms at loadavg 13.06, so the figure barely moves
6052 /// with the box). At this row count the two cases are the same, because a
6053 /// 3686-row tail is scanned to the end faster than the early exit saves
6054 /// anything; they diverge with the object count, and the table on
6055 /// [`ObjectReadStack::extents_with_rows`] carries that at a million rows
6056 /// (0.74 ms against 109 ms).
6057 ///
6058 /// The printed line carries the loadavg of its own run, the pack count and
6059 /// the row count, because none of the three is comparable across machines or
6060 /// across a busy box.
6061 #[test]
6062 fn the_derive_on_open_diff_costs_milliseconds_at_a_realistic_pack_count() {
6063 const PACKS: usize = 1000;
6064 let dir = tmpdir("diff-cost");
6065 let (real, rows) = corpus_pack();
6066
6067 {
6068 let store = GitStore::open(&dir, "rickard").unwrap();
6069 store.put_pack(&real).unwrap();
6070 for i in 0..PACKS - 1 {
6071 let (p, _) = one_blob_pack(format!("pack number {i}").as_bytes());
6072 store.put_pack(&p).unwrap();
6073 }
6074 store.wait_indexed();
6075 assert_eq!(
6076 store.object_count(),
6077 rows.len() + PACKS - 1,
6078 "the fixture did not absorb"
6079 );
6080 }
6081
6082 let acked = read_journal(&SafeWriter::journal_path(&dir.join("objects.pack"))).unwrap();
6083 assert_eq!(acked.len(), PACKS, "one journal row per pack");
6084 // The tail on its own, so what is timed is the diff rather than redb's
6085 // open and the projection build that a store's open also pays for.
6086 let tail = ObjectReadStack::<OneTableFourColumns>::open(
6087 &dir.join("objects.tail"),
6088 RebuildTriggers::default(),
6089 crate::arms::DEFAULT_REDB_CACHE_BYTES,
6090 )
6091 .unwrap();
6092
6093 let t = Instant::now();
6094 let hit = tail.extents_with_rows(&acked).unwrap();
6095 let clean = t.elapsed();
6096 assert!(
6097 hit.iter().all(|&h| h),
6098 "an absorbed pack was reported unabsorbed"
6099 );
6100
6101 // One pack in flight when the machine died: durable bytes, no rows.
6102 let mut in_flight = acked.clone();
6103 let end = acked[PACKS - 1].0 + acked[PACKS - 1].1;
6104 in_flight.push((end, 4096));
6105 let t = Instant::now();
6106 let hit = tail.extents_with_rows(&in_flight).unwrap();
6107 let crashed = t.elapsed();
6108 assert_eq!(
6109 hit.iter().filter(|h| !**h).count(),
6110 1,
6111 "the pack with no rows is not the only one reported unabsorbed"
6112 );
6113
6114 eprintln!(
6115 "load {}; {PACKS} packs / {} object rows: derive-on-open diff {:.2} ms clean \
6116 (early exit), {:.2} ms with one pack un-absorbed (full tail scan)",
6117 loadavg(),
6118 tail.len(),
6119 clean.as_secs_f64() * 1e3,
6120 crashed.as_secs_f64() * 1e3,
6121 );
6122 }
6123
6124 /// **The bit is a bitset over dense ordinals, and one bit is one pack.**
6125 ///
6126 /// Ordinals that straddle word boundaries (63, 64, 65) are the whole point:
6127 /// a shift that ignores the word split, or a word index that does not, sets
6128 /// a neighbour's bit — and a neighbour's bit set means a durable pack is
6129 /// declared absorbed with no rows behind it.
6130 ///
6131 /// Seen RED by `>> (i % 64) & 1` → `>> (i % 63) & 1` in
6132 /// `PackState::is_absorbed`: "the bit for ordinal 64 did not go up". Restored.
6133 ///
6134 /// Seen RED a second time by `if self.extent[i].is_none()` → `if
6135 /// self.extent[i].is_none() || true` in `PackState::note`, i.e. letting a
6136 /// re-queue of a pack that is already recorded count as new work — which is
6137 /// the race the ack path really produces, since the drain can absorb before
6138 /// `queue` runs: "an absorbed pack was queued again — left: 6, right: 5".
6139 /// Restored.
6140 #[test]
6141 fn the_indexed_bit_is_a_bitset_over_dense_pack_ordinals() {
6142 let ids = [0u64, 1, 63, 64, 65, 4095];
6143 let mut s = PackState::default();
6144 for id in ids {
6145 s.note(id, (id * 4096 + 12, 4096));
6146 }
6147 assert_eq!(s.unabsorbed, ids.len());
6148 assert!(
6149 ids.iter().all(|&i| !s.is_absorbed(i)),
6150 "a bit is up already"
6151 );
6152
6153 s.mark_absorbed(64, (64 * 4096 + 12, 4096));
6154 assert!(s.is_absorbed(64), "the bit for ordinal 64 did not go up");
6155 for other in [0u64, 1, 63, 65, 4095] {
6156 assert!(
6157 !s.is_absorbed(other),
6158 "setting ordinal 64 also set ordinal {other} — one bit spilled onto a neighbour"
6159 );
6160 }
6161 assert_eq!(s.unabsorbed, ids.len() - 1);
6162 assert_eq!(
6163 s.pending().iter().map(|p| p.pack_id).collect::<Vec<_>>(),
6164 vec![0, 1, 63, 65, 4095],
6165 "the pending list is not the clear bits"
6166 );
6167 assert_eq!(
6168 s.pending()[0],
6169 PendingPack {
6170 pack_id: 0,
6171 offset: 12,
6172 len: 4096,
6173 resumed: true,
6174 },
6175 "a pending pack lost the extent it must be absorbed from"
6176 );
6177
6178 // Both writers are idempotent, because both of them race.
6179 s.mark_absorbed(64, (64 * 4096 + 12, 4096));
6180 s.note(64, (64 * 4096 + 12, 4096));
6181 assert!(s.is_absorbed(64));
6182 assert_eq!(
6183 s.unabsorbed,
6184 ids.len() - 1,
6185 "an absorbed pack was queued again"
6186 );
6187
6188 // One bit per pack, and that is the whole cost: 4096 ordinals is 64
6189 // words. A hash set of the same ordinals is an order of magnitude more,
6190 // and a bloom would be smaller and wrong.
6191 assert_eq!(s.words.len(), 64);
6192 assert_eq!(s.words.len() * 8, 512, "4096 packs is 512 bytes of bits");
6193 }
6194
6195 /// **A read that arrives before the drain is served from the pack, on its
6196 /// own thread, and never waits for the worker.**
6197 ///
6198 /// Rickard's rule, 2026-08-30: *nobody waits on the indexer.* Until then
6199 /// this test asserted the opposite — that a read parked behind the absorb
6200 /// gate stayed unanswered until the drain released it, which on a kernel
6201 /// pack is hours, and under the memory watchdog is *as long as the box is
6202 /// short*. Now the gate is the absorbers' and only the absorbers': the read
6203 /// finds no row, sees a pending pack, and resolves that pack read-only
6204 /// from the mmapped bytes for the one oid it wants
6205 /// (`Absorber::scan_pending`). The drain is still parked, the index is
6206 /// still empty, and the answer is **present** — from the verbatim truth.
6207 ///
6208 /// Seen RED by making `lookup_never_wait` return `Ok(None)` when the index
6209 /// misses: "a read with the drain parked answered absent for a durable
6210 /// object". And by putting `self.gate.lock()` back in front of it: the
6211 /// 2-second bound below trips with the reader still parked.
6212 #[test]
6213 fn a_read_before_the_drain_is_served_from_the_pack_and_never_waits() {
6214 let dir = tmpdir("drain-before");
6215 let store = Arc::new(GitStore::open(&dir, "rickard").unwrap());
6216 let (pack, rows) = corpus_pack();
6217 let (second, blob_oid) = one_blob_pack(b"a second push while the drain is parked");
6218
6219 // The drain is parked here, before it can absorb anything.
6220 let gate = store.hold_absorb_gate();
6221 let tx = store.put_pack(&pack).unwrap();
6222 let pack_id = tx.pack_id.unwrap();
6223 assert_eq!(store.unindexed_packs(), 1, "the pack is not queued");
6224 assert_eq!(store.index().len(), 0, "the index already holds rows");
6225 assert!(!store.indexer().is_indexed(pack_id), "the bit is already up");
6226
6227 // (1) a second push does not wait either: the ack path never meets the gate.
6228 let t = Instant::now();
6229 let tx2 = store.put_pack(&second).unwrap();
6230 assert_eq!(tx2.pack_id, Some(pack_id + 1));
6231 assert!(t.elapsed() < Duration::from_secs(2), "the push waited on the parked drain");
6232
6233 // (2) reads into exactly that state: present, from the pack, bounded.
6234 let oid = rows[0].oid.clone();
6235 let last = rows[rows.len() - 1].oid.clone();
6236 let t = Instant::now();
6237 assert!(store.has(&oid).unwrap(), "a read with the drain parked answered absent for a durable object");
6238 assert!(store.has(&last).unwrap(), "the last object of the pack answered absent");
6239 assert!(store.has(&blob_oid).unwrap(), "the second (still pending) pack's object answered absent");
6240 let (kind, body) = store.content(&blob_oid).unwrap().expect("content from the pending pack");
6241 assert_eq!(kind, GitObjectKind::Blob);
6242 assert_eq!(body, b"a second push while the drain is parked");
6243 let stored = store.get(&oid).unwrap().expect("get from the pending pack");
6244 assert_eq!(stored.extent.0, rows[0].offset + tx.extent.unwrap().0);
6245 assert_eq!(
6246 store.size(&last).unwrap(),
6247 Some(rows[rows.len() - 1].uncompressed_size),
6248 "size from the pending pack"
6249 );
6250 let absent = vec![0xEEu8; 20];
6251 assert!(!store.has(&absent).unwrap(), "an oid in no pack must still be absent");
6252 let elapsed = t.elapsed();
6253 assert!(elapsed < Duration::from_secs(20), "reads took {elapsed:?} with the drain parked");
6254 // The drain is STILL parked and the index STILL empty: nothing above
6255 // absorbed anything, and nothing waited.
6256 assert_eq!(store.index().len(), 0, "a read absorbed the pack behind the parked gate");
6257 assert!(!store.indexer().is_indexed(pack_id));
6258 assert_eq!(store.unindexed_packs(), 2);
6259 eprintln!("{} reads served from two pending packs with the drain parked, in {elapsed:?}", 6);
6260
6261 // (3) a whole-graph request is refused by name, not waited on.
6262 let err = store.reachable(&[oid.as_slice()], &[]).unwrap_err();
6263 assert!(err.to_string().contains("index in progress"), "{err:#}");
6264
6265 drop(gate);
6266 // And afterwards it is served from the rows.
6267 store.wait_indexed();
6268 assert_eq!(store.unindexed_packs(), 0);
6269 assert!(store.indexer().is_indexed(pack_id));
6270 assert_eq!(store.index().len(), rows.len() + 1);
6271 assert_eq!(store.absorb_pending().unwrap(), 0);
6272 for r in rows.iter().take(256) {
6273 assert!(
6274 store.index().lookup(&r.oid).is_some(),
6275 "{} is not in the rows after the drain",
6276 hex::encode(&r.oid)
6277 );
6278 }
6279 assert!(store.reachable(&[oid.as_slice()], &[]).is_ok(), "reachable after the drain");
6280 }
6281
6282 /// **The memory watchdog pauses the indexer worker and nobody else.**
6283 ///
6284 /// A fake `/proc/meminfo` under the floor is put under the process-wide
6285 /// watchdog; the worker parks in front of its batch (`index_worker`'s
6286 /// pre-batch check) and stays parked. Meanwhile a push is acked, every
6287 /// kind of read answers from the pack, and the progress snapshot returns —
6288 /// all bounded, none of them behind the pause. Then the fake is raised,
6289 /// the worker resumes, and the pack is indexed normally.
6290 ///
6291 /// Seen RED with the pre-batch check taking the absorb gate before pausing
6292 /// (the reads' scan does not need the gate, but `absorb_pending`-based
6293 /// reads did): every read parked for the length of the pause.
6294 #[test]
6295 fn a_paused_indexer_blocks_no_push_and_no_read() {
6296 let dir = tmpdir("paused-indexer");
6297 let meminfo = dir.join("meminfo");
6298 let write = |avail_kib: u64| {
6299 std::fs::write(&meminfo, format!("MemTotal: 16000000 kB\nMemAvailable: {avail_kib} kB\n"))
6300 .unwrap()
6301 };
6302 write(1_000_000);
6303 let dog = Arc::new(crate::memguard::MemWatchdog::with(
6304 &meminfo,
6305 3_200_000 * 1024,
6306 Duration::from_millis(10),
6307 ));
6308 let store = Arc::new(GitStore::open(&dir, "rickard").unwrap());
6309 // This store's worker only: every other store in the process keeps
6310 // the real watchdog.
6311 store.set_mem_watchdog(dog.clone());
6312 let (pack, rows) = corpus_pack();
6313 let (second, blob_oid) = one_blob_pack(b"pushed while the indexer is paused");
6314
6315 let t_push = Instant::now();
6316 let tx = store.put_pack(&pack).unwrap();
6317 let pack_id = tx.pack_id.unwrap();
6318 // Give the worker time to reach its pre-batch check and park.
6319 let mut parked = false;
6320 for _ in 0..200 {
6321 if dog.is_paused() {
6322 parked = true;
6323 break;
6324 }
6325 std::thread::sleep(Duration::from_millis(10));
6326 }
6327 assert!(parked, "the worker never paused under a meminfo 1 GB < 3.2 GB");
6328 assert!(!store.indexer().is_indexed(pack_id), "indexed while paused");
6329 assert_eq!(store.index().len(), 0);
6330
6331 // The ack path: a push while paused.
6332 let tx2 = store.put_pack(&second).unwrap();
6333 assert_eq!(tx2.pack_id, Some(pack_id + 1));
6334 assert!(t_push.elapsed() < Duration::from_secs(5), "a push waited on the paused worker");
6335
6336 // Reads while paused: present, from the pack.
6337 let t = Instant::now();
6338 assert!(store.has(&rows[0].oid).unwrap());
6339 assert!(store.has(&blob_oid).unwrap());
6340 let (kind, body) = store.content(&blob_oid).unwrap().unwrap();
6341 assert_eq!((kind, body.as_slice()), (GitObjectKind::Blob, &b"pushed while the indexer is paused"[..]));
6342 assert_eq!(
6343 store.extents(&[rows[0].oid.as_slice(), rows[1].oid.as_slice(), blob_oid.as_slice()])
6344 .unwrap()
6345 .iter()
6346 .filter(|e| e.is_some())
6347 .count(),
6348 3,
6349 "the batch path answered absent while paused"
6350 );
6351 assert!(t.elapsed() < Duration::from_secs(20), "reads waited on the paused worker");
6352 // The progress row: information, never a gate.
6353 let snap = store.index_progress();
6354 assert_eq!(snap.root, store.root().display().to_string());
6355 assert!(dog.is_paused(), "the worker resumed on its own — the fake still says 1 GB");
6356 assert!(!store.indexer().is_indexed(pack_id), "indexed while still paused");
6357
6358 // A whole-graph request while the worker is paused: the gate is free
6359 // (a paused worker holds nothing), so the READER absorbs the pending
6360 // packs on its own thread and answers — the worker is still parked.
6361 let reach = store.reachable(&[rows[0].oid.as_slice()], &[]).unwrap();
6362 assert!(!reach.is_empty());
6363 assert_eq!(store.unindexed_packs(), 0, "the reader did not absorb for itself");
6364 assert!(dog.is_paused(), "the worker is still parked; the reader did the work");
6365 assert_eq!(store.index().len(), rows.len() + 1);
6366
6367 // Memory comes back: the worker resumes, finds nothing to do, and the
6368 // bits go up through the ordinary drain.
6369 write(9_000_000);
6370 store.wait_indexed();
6371 assert!(store.indexer().is_indexed(pack_id));
6372 assert!(store.indexer().is_indexed(pack_id + 1));
6373 assert_eq!(dog.pauses(), 1, "one pause, one resume");
6374 assert!(!dog.is_paused());
6375 }
6376
6377 /// **The bit is cleared after the rows go in, never before.**
6378 ///
6379 /// The ordering inside `absorb_gated` is the whole reason a read cannot be
6380 /// told "absent" while the drain is running, and the only way to see it is to
6381 /// read *during* one. Four gatling workers (LAW 3 — never rayon, and never a
6382 /// raw thread pool) hammer `has` over the pack's oids from the moment
6383 /// `put_pack` returns until the pack's bit is up.
6384 ///
6385 /// Asserted on applied output: not one of those reads may answer absent for
6386 /// an object whose bytes are already durable.
6387 ///
6388 /// Seen RED by clearing the bit *before* absorbing (a
6389 /// `s.pending.retain(|p| p.pack_id != job.pack_id)` added in `absorb_gated`
6390 /// above the `self.absorb_one(job)` call): "4 reader(s) were told a durable
6391 /// object was absent — **32 865 593** absent answers over 2687 objects".
6392 /// Restored. The count is that large because the readers spin until the bit
6393 /// goes up and, with the bit cleared first, every pass over the sample missed
6394 /// for the whole length of the absorb.
6395 ///
6396 /// The honest limit: this is a race, so a green run proves the window was not
6397 /// hit, not that no window exists. That is why the printed line carries how
6398 /// many of the reads actually landed while the pack was still un-indexed —
6399 /// **a run where that number is 0 proved nothing**, and it is reported rather
6400 /// than asserted because forcing it would mean pausing the drain, which is
6401 /// the one thing this test must not do. MEASURED 2026-08-08 on oden at
6402 /// loadavg 16.94: 336 of 336 reads landed early.
6403 #[test]
6404 fn no_read_is_told_absent_while_the_drain_is_running() {
6405 let dir = tmpdir("drain-during");
6406 let store = GitStore::open(&dir, "rickard").unwrap();
6407 let (pack, rows) = corpus_pack();
6408 let oids: Vec<&[u8]> = rows.iter().map(|r| r.oid.as_slice()).collect();
6409
6410 let tx = store.put_pack(&pack).unwrap();
6411 let pack_id = tx.pack_id.unwrap();
6412
6413 let early = AtomicU64::new(0);
6414 let absent = AtomicU64::new(0);
6415 let reads = AtomicU64::new(0);
6416 let workers = 4usize;
6417 gatling_for_each(workers, workers, |w| loop {
6418 let still_pending = store.unindexed_packs() > 0;
6419 for oid in oids.iter().skip(w).step_by(workers * 8) {
6420 if still_pending {
6421 early.fetch_add(1, AtomicOrdering::Relaxed);
6422 }
6423 reads.fetch_add(1, AtomicOrdering::Relaxed);
6424 if !store.has(oid).unwrap() {
6425 absent.fetch_add(1, AtomicOrdering::Relaxed);
6426 }
6427 }
6428 if store.indexer().is_indexed(pack_id) {
6429 break;
6430 }
6431 });
6432
6433 let absent = absent.load(AtomicOrdering::Acquire);
6434 assert_eq!(
6435 absent,
6436 0,
6437 "{workers} reader(s) were told a durable object was absent — {absent} absent answers \
6438 over {} objects",
6439 rows.len()
6440 );
6441 assert_eq!(store.object_count(), rows.len());
6442 eprintln!(
6443 "load {}; {} reads across {workers} gatling workers, {} of them while the pack was \
6444 still un-indexed",
6445 loadavg(),
6446 reads.load(AtomicOrdering::Acquire),
6447 early.load(AtomicOrdering::Acquire),
6448 );
6449 }
6450
6451 /// **One pack is absorbed once, whichever of the two callers gets there
6452 /// first.**
6453 ///
6454 /// Both callers are made to attempt it, deterministically: with the gate
6455 /// held, the drain is parked inside `ObjectAbsorb::absorb` and a reader is
6456 /// parked inside `absorb_pending`, both past their own early exits. Releasing
6457 /// the gate lets exactly one do the work; the other must take the skip.
6458 ///
6459 /// The observable is the **commit graph**, not the object table:
6460 /// `ObjectReadStack::append` is keyed by oid and would swallow a second
6461 /// identical row, but the graph is a `Vec` and a second absorb pushes every
6462 /// commit into it again — which silently doubles the fold every reachability
6463 /// bitmap is built from.
6464 ///
6465 /// Seen RED by disabling the `s.absorbed.contains(&job.pack_id)` skip in
6466 /// `absorb_gated`: "the commit graph carries **1102** commits, the pack has
6467 /// **551**" — exactly double, both callers having done the whole fold.
6468 /// Restored.
6469 #[test]
6470 fn a_pack_is_absorbed_once_even_when_both_callers_race_for_it() {
6471 let dir = tmpdir("drain-once");
6472 let store = Arc::new(GitStore::open(&dir, "rickard").unwrap());
6473 let (pack, rows) = corpus_pack();
6474
6475 let gate = store.hold_absorb_gate();
6476 store.put_pack(&pack).unwrap();
6477
6478 let s = store.clone();
6479 let reader = Job::spawn(move || s.absorb_pending().unwrap());
6480 // Both are now blocked on the gate: the drain inside `absorb`, the reader
6481 // inside `absorb_pending`, each having already decided there is work.
6482 std::thread::sleep(Duration::from_millis(100));
6483 drop(gate);
6484
6485 let by_read = reader.join().unwrap();
6486 store.wait_indexed();
6487
6488 assert_eq!(
6489 store.commit_count(),
6490 commits_in(&rows),
6491 "the commit graph carries {} commits, the pack has {}",
6492 store.commit_count(),
6493 commits_in(&rows)
6494 );
6495 assert_eq!(store.object_count(), rows.len());
6496 assert_eq!(store.unindexed_packs(), 0);
6497 eprintln!(
6498 "load {}; the read absorbed {by_read} pack(s), the drain absorbed the rest",
6499 loadavg()
6500 );
6501 }
6502
6503 // ── §14's exploded table ─────────────────────────────────────────────────
6504
6505 /// **A push produces an exploded row for every object in the pack, and each
6506 /// one hashes back to its own oid.**
6507 ///
6508 /// Eager, decided 2026-08-08: no threshold, no size cap, no type skipped —
6509 /// so the row count is the *object* count and not some subset of it. Nothing
6510 /// is read between `put_pack` and `wait_indexed`, so the only thing that
6511 /// could have built the rows is the background drain, which is the half of
6512 /// §14 that says "built by the same background indexer".
6513 ///
6514 /// The assertion is applied output in its strongest available form: every
6515 /// object's content is read back out of the table, re-serialised canonically
6516 /// and **re-hashed**, and the hash has to be the oid it was filed under. A
6517 /// row count alone could be satisfied by 2687 rows of the wrong bytes; a
6518 /// re-hash cannot.
6519 ///
6520 /// Seen RED by deleting the `sink.explode(&oid, kind, &payload)?` call in
6521 /// `resolve::resolve_walked`: "the drain built no exploded rows: 0 of 2687".
6522 /// Restored.
6523 ///
6524 /// Seen RED a second time by making the sink skip blobs in
6525 /// `ExplodedTable::explode` (`if kind == GitObjectKind::Blob { return Ok(()) }`
6526 /// at the top — which is what a *lazy* or size-capped table would look like
6527 /// from here): "the drain built no exploded rows: 1420 of 2687". Restored,
6528 /// because §14's open question was closed EAGER and disk is explicitly not a
6529 /// consideration — and because the 1267 rows that edit removes are exactly
6530 /// the blobs a content read wants most.
6531 #[test]
6532 fn a_push_produces_an_exploded_row_for_every_object_in_the_pack() {
6533 let dir = tmpdir("exploded-every-object");
6534 let store = GitStore::open(&dir, "rickard").unwrap();
6535 let (pack, rows) = corpus_pack();
6536
6537 let t = Instant::now();
6538 store.put_pack(&pack).unwrap();
6539 let ack = t.elapsed();
6540 store.wait_indexed();
6541 // **Drain, printed beside ack**, because the two answer different
6542 // questions and only one of them was ever in doubt. Ack is unchanged by
6543 // construction — nothing on it touches this table. Drain is where the
6544 // eager resolve and the sink both live, and it is the column redb's
6545 // 2026-08-08 measurement recorded as 316.2–329.8 ms against 166.7–168.6
6546 // ms with the sink stubbed out. Without it here, "did the medium buy
6547 // anything but disk" has no answer in this repository.
6548 let drain = t.elapsed();
6549
6550 let distinct: HashSet<Vec<u8>> = rows.iter().map(|r| r.oid.clone()).collect();
6551 let stats = store.exploded_stats();
6552 // **The push explodes the GRAPH, not the content.** Under the shipped
6553 // policy the drain writes commits and trees and leaves blobs in the
6554 // pack; the assertion is therefore two-sided, because "some rows" would
6555 // pass on a table that wrote one row and on one that wrote all of them,
6556 // and it is exactly the second that costs 17× the pack.
6557 let graph_rows = store.exploded_of_kind(GitObjectKind::Commit).unwrap().len();
6558 assert_eq!(
6559 store.exploded_eager_rows().unwrap(),
6560 graph_rows as u64,
6561 "the drain wrote {} eager rows and there are {} commits — the eager pool \
6562 holds something other than the graph",
6563 store.exploded_eager_rows().unwrap(),
6564 graph_rows
6565 );
6566 assert!(
6567 stats.rows > 0 && stats.rows < distinct.len() as u64,
6568 "the eager pool holds {} of {} objects; lazy explode means neither 0 \
6569 (the graph would be blind) nor all of them (that is the 22.4x tier)",
6570 stats.rows,
6571 distinct.len()
6572 );
6573
6574 // Every one of them, re-hashed. Bytes that came back wrong cannot pass.
6575 let hash = store.hash_kind();
6576 let mut checked = 0usize;
6577 for oid in &distinct {
6578 let (kind, payload) = store
6579 .content(oid)
6580 .unwrap()
6581 .unwrap_or_else(|| panic!("{} has no exploded row", hex::encode(oid)));
6582 let rehashed = hash.oid_of(&crate::object::canonical(kind, &payload));
6583 assert_eq!(
6584 &rehashed,
6585 oid,
6586 "the exploded row filed under {} contains an object that hashes to {}",
6587 hex::encode(oid),
6588 hex::encode(&rehashed)
6589 );
6590 checked += 1;
6591 }
6592 assert_eq!(checked, distinct.len());
6593 // **Every object came back byte-correct**, and the ones the eager pool
6594 // does not hold came back by inflating their own delta chain out of the
6595 // mapped pack ([`crate::resolve::materialize_at`]). So the re-derivation
6596 // count is the blob count and not zero — asserting zero here is what a
6597 // test written for the eager tier does, and it would now be asserting
6598 // that lazy explode is off.
6599 let after_reads = store.exploded_stats();
6600 assert!(
6601 after_reads.rederived > 0,
6602 "no read re-derived anything, so either every object is eager or the \
6603 lazy path never ran"
6604 );
6605 assert_eq!(
6606 after_reads.rederived + after_reads.served,
6607 checked as u64,
6608 "reads {} = served {} + rederived {} must account for every object",
6609 checked,
6610 after_reads.served,
6611 after_reads.rederived
6612 );
6613 // **What it costs on disk, measured rather than assumed.** §14 says the
6614 // price is "both copies are held" and the decision was taken with "we
6615 // don't care if disk is tripled" — so the real multiple belongs in the
6616 // output where anybody can read it, not in a sentence. It is not 3x on a
6617 // real pack: the verbatim bytes are deflated *and* delta-encoded, the
6618 // table holds raw inflated content, and redb pages it.
6619 let inflated: u64 = rows.iter().map(|r| r.uncompressed_size).sum();
6620 let table = std::fs::metadata(store.exploded_path())
6621 .map(|m| m.len())
6622 .unwrap_or(0);
6623 eprintln!(
6624 "load {}; {} pack entries → {} exploded rows, all {} re-hashed to their own oid; \
6625 ack {:.1} ms, drain {:.1} ms, {:.0} rows/s; disk: pack {:.1} MiB verbatim, objects \
6626 inflate to {:.1} MiB, table file {:.1} MiB ({:.0}x the pack, {:.3}x the payload)",
6627 loadavg(),
6628 rows.len(),
6629 stats.rows,
6630 checked,
6631 ack.as_secs_f64() * 1e3,
6632 drain.as_secs_f64() * 1e3,
6633 stats.rows as f64 / drain.as_secs_f64(),
6634 pack.len() as f64 / (1 << 20) as f64,
6635 inflated as f64 / (1 << 20) as f64,
6636 table as f64 / (1 << 20) as f64,
6637 table as f64 / pack.len() as f64,
6638 table as f64 / inflated.max(1) as f64,
6639 );
6640 }
6641
6642 /// **The amplification measurement, at whatever scale you point it at.**
6643 ///
6644 /// [`a_push_produces_an_exploded_row_for_every_object_in_the_pack`] prints
6645 /// the same ratio on a 5.4 MiB fixture and is a *guard*, so it has to stay
6646 /// fast. This is the same arithmetic with no assertion about size and no
6647 /// fixture of its own: give it a pack and it reports what the table cost.
6648 ///
6649 /// ```text
6650 /// ZNIPPY_EXPLODE_BENCH_PACK=/path/to/pack-….pack \
6651 /// cargo test -p znippy-plugin-git --lib the_table_costs_what_it_holds \
6652 /// -- --ignored --nocapture
6653 /// ```
6654 ///
6655 /// It exists because the 12× figure that killed redb — 16.8 GB of resolved
6656 /// `linux.git` content in a 204 GB file — was taken by hand off a bench run
6657 /// that no longer exists, and a number nobody can re-take is a number that
6658 /// rots. `#[ignore]`d and pack-less by default: with no pack named it
6659 /// returns, so it never fails a suite for the absence of a corpus nobody
6660 /// promised to keep.
6661 #[test]
6662 #[ignore = "needs a pack: ZNIPPY_EXPLODE_BENCH_PACK=<path> cargo test … -- --ignored --nocapture"]
6663 fn the_table_costs_what_it_holds() {
6664 let Ok(path) = std::env::var("ZNIPPY_EXPLODE_BENCH_PACK") else {
6665 eprintln!("no ZNIPPY_EXPLODE_BENCH_PACK named; nothing measured");
6666 return;
6667 };
6668 let pack = std::fs::read(&path).unwrap_or_else(|e| panic!("reading {path}: {e}"));
6669 let dir = tmpdir("exploded-cost");
6670 let store = GitStore::open(&dir, "rickard").unwrap();
6671
6672 let t = Instant::now();
6673 store.put_pack(&pack).unwrap();
6674 let ack = t.elapsed();
6675 store.wait_indexed();
6676 let drain = t.elapsed();
6677
6678 let stats = store.exploded_stats();
6679 let table = std::fs::metadata(store.exploded_path())
6680 .map(|m| m.len())
6681 .unwrap_or(0);
6682 // The payload the table actually holds, asked of the table rather than
6683 // of the pack — a pack entry's `uncompressed_size` is what git recorded,
6684 // and this is what we stored. Only the second one can be divided into
6685 // the file size and mean anything.
6686 let mut held = 0u64;
6687 for kind in [
6688 GitObjectKind::Commit,
6689 GitObjectKind::Tree,
6690 GitObjectKind::Blob,
6691 GitObjectKind::Tag,
6692 ] {
6693 held += store
6694 .exploded_of_kind(kind)
6695 .unwrap()
6696 .iter()
6697 .map(|(_, p)| p.len() as u64)
6698 .sum::<u64>();
6699 }
6700 let mib = |n: u64| n as f64 / (1 << 20) as f64;
6701 eprintln!(
6702 "load {}; pack {} — {:.1} MiB verbatim → {} rows holding {:.1} MiB, table file \
6703 {:.1} MiB = {:.3}x the payload and {:.1}x the pack; ack {:.0} ms, drain {:.0} ms",
6704 loadavg(),
6705 path,
6706 mib(pack.len() as u64),
6707 stats.rows,
6708 mib(held),
6709 mib(table),
6710 table as f64 / held.max(1) as f64,
6711 table as f64 / pack.len() as f64,
6712 ack.as_secs_f64() * 1e3,
6713 drain.as_secs_f64() * 1e3,
6714 );
6715 }
6716
6717 /// Where the child of the clean-shutdown guard finds its fixture and leaves
6718 /// its markers.
6719 const CLEAN_DIR: &str = "GUNNAR_CLEAN_SHUTDOWN_DIR";
6720
6721 /// **The other half of
6722 /// [`a_clean_shutdown_and_reopen_keeps_the_graph_and_reachable`]: the process
6723 /// that exits normally.**
6724 ///
6725 /// A real process, a real push, a real drain, and then a real `drop` — every
6726 /// worker joined, every redb handle closed, no signal, exit status 0. That is
6727 /// what makes the parent's reopen a *clean* reopen rather than a recovery,
6728 /// and it is the case the crash guard cannot reach: after a clean shutdown
6729 /// every pack's bit is legitimately set and **nothing is re-queued**, so the
6730 /// derived tables have to have been on disk or they are gone.
6731 ///
6732 /// `#[ignore]`d because it is a fixture, not a guard — run on its own it has
6733 /// no directory to work in and returns.
6734 #[test]
6735 #[ignore = "spawned by a_clean_shutdown_and_reopen_keeps_the_graph_and_reachable"]
6736 fn the_child_that_pushes_and_shuts_down_cleanly() {
6737 let Ok(dir) = std::env::var(CLEAN_DIR) else {
6738 return;
6739 };
6740 let dir = PathBuf::from(dir);
6741 let pack = std::fs::read(dir.join("fixture.pack")).expect("the parent's fixture");
6742
6743 let store = GitStore::open(&dir, "rickard").expect("open");
6744 store.put_pack(&pack).expect("the ack path");
6745 store.wait_indexed();
6746 assert_eq!(store.unindexed_packs(), 0, "the child shut down mid-index");
6747
6748 let tip = store
6749 .graph_snapshot()
6750 .into_iter()
6751 .max_by_key(|c| c.generation)
6752 .expect("the child built no graph at all");
6753 let tip_raw = hex::decode(&tip.oid).unwrap();
6754 let closure = store.reachable(&[&tip_raw], &[]).unwrap();
6755 assert!(!closure.is_empty(), "the child's own reachable() was empty");
6756
6757 std::fs::write(dir.join("tip"), &tip.oid).expect("marker");
6758 std::fs::write(dir.join("closure"), closure.len().to_string()).expect("marker");
6759 std::fs::write(dir.join("commits"), store.commit_count().to_string()).expect("marker");
6760 std::fs::write(dir.join("objects"), store.object_count().to_string()).expect("marker");
6761
6762 // **The clean shutdown.** Not a signal and not an abort: the store drops,
6763 // which closes the channel, joins the account indexer's worker and closes
6764 // redb. The process then returns normally with status 0.
6765 drop(store);
6766 std::fs::write(dir.join("clean"), b"closed").expect("marker");
6767 }
6768
6769 /// **`commit_count()` and `reachable()` are correct after a CLEAN shutdown
6770 /// and reopen.** This is the guard the exploded table exists to make pass.
6771 ///
6772 /// It was the live bug: the commit graph was folded from commit and tree
6773 /// *payloads* which were stored nowhere, accumulated in RAM as packs were
6774 /// absorbed. A store killed mid-absorb got them back only because the
6775 /// interrupted pack was re-queued and re-resolved
6776 /// ([`a_store_reopened_after_a_kill_mid_absorb_requeues_the_pack`]); a store
6777 /// that shut down **cleanly** re-queued nothing, and MEASURED on oden
6778 /// 2026-08-08 came back with 2687 rows and **0 of 551 commits** —
6779 /// `reachable()` returning a commit alone instead of its closure, and `gc`
6780 /// seeing an empty live set. Both are quiet wrong answers.
6781 ///
6782 /// The shape is the crash guard's: a **real** child process, which here exits
6783 /// normally, and the parent asserts against what is on disk. Two assertions
6784 /// carry it and they have to be in this order:
6785 ///
6786 /// 1. **`commit_count()` immediately after `open`**, before anything is
6787 /// waited on — so the graph can only have come from the fold over the
6788 /// exploded table that `open` performs, not from a re-absorb;
6789 /// 2. **`is_indexed(0)` is false after `wait_indexed()`** — the account
6790 /// indexer in *this* process publishes a pack only for a job somebody
6791 /// submitted, so a clear bit proves open re-queued nothing and the graph
6792 /// above is not a recovery artefact.
6793 ///
6794 /// `reachable()` is then asserted against the closure the child computed on
6795 /// the same tip, so it is the same answer and not merely a non-empty one.
6796 ///
6797 /// Seen RED by deleting `store.refold()?` from the end of
6798 /// `GitStore::open_with_arms`, so nothing folds the table on open: "the
6799 /// commit graph did not survive a clean shutdown: 0 of 551 commits — the
6800 /// exploded table is a warm cache, not a durable table", left 0 right 551.
6801 /// That is the recorded bug's own number, reproduced. Restored.
6802 ///
6803 /// Seen RED a second time by deleting `self.exploded.flush()?` from
6804 /// `Absorber::absorb_one`, which is the **durability** edit: the rows then
6805 /// live only in the un-flushed buffer, which answers perfectly inside the
6806 /// child and is gone when the process ends. It fires assertion (2) rather
6807 /// than (1) — "the reopen re-queued the pack, so the graph above is a
6808 /// recovery artefact rather than the table's" — and that is worth writing
6809 /// down, because assertion (1) *passed*: the 64 MiB flush threshold had
6810 /// tripped once mid-pack, leaving 1798 of 2687 rows on disk which happened
6811 /// to include all 551 commits. A guard with only assertion (1) would have
6812 /// called that edit green. Restored.
6813 /// **An annotated tag reaches the commit it points at.**
6814 ///
6815 /// # The bug this is the guard for
6816 ///
6817 /// Reachability bitmaps are built over the commit graph, and no tree points
6818 /// at a tag, so a tag is in nobody's closure. `reachable`'s `want` loop had
6819 /// one arm for "not a commit": insert the object itself, and stop. So a
6820 /// `want` that was an annotated tag answered with **one object** — the tag —
6821 /// and the commit it names, plus that commit's whole history, was left out.
6822 ///
6823 /// It stayed invisible because a tag is nearly always pushed alongside the
6824 /// branch that carries the same commit, and then the branch's closure
6825 /// covers it. It surfaces the moment a tag is the ONLY thing naming a
6826 /// commit — which is what gunnar's replication does, one ref at a time. Six
6827 /// repositories on the live fleet could not replicate on 2026-08-31, one of
6828 /// them with 25 tags hanging off a single commit no branch carried, all
6829 /// refused by the far end as `missing necessary objects … (peeling a tag)`.
6830 ///
6831 /// So the fixture asserts the premise it needs: the tag is the only `want`.
6832 ///
6833 /// # 🔴 Seen red
6834 ///
6835 /// Against the arm as it was (`union.insert(o)` and nothing more):
6836 /// `the tag's closure is 1 object, so it carries the tag and nothing it
6837 /// points at`. With the peel: the commit, its trees and its blobs.
6838 #[test]
6839 fn an_annotated_tag_reaches_the_commit_it_points_at() {
6840 let dir = tmpdir("tag-peel");
6841 let store = GitStore::open(&dir, "rickard").unwrap();
6842 let (pack, rows) = corpus_pack();
6843 store.put(&pack, &[]).unwrap();
6844 store.wait_indexed();
6845
6846 // Any commit will do: the tag is the only `want`, so nothing else can
6847 // pull this commit's closure in behind our backs.
6848 let commit = rows
6849 .iter()
6850 .find(|r| r.kind == GitObjectKind::Commit)
6851 .expect("the corpus has commits");
6852 let commit_hex = hex::encode(&commit.oid);
6853 let commit_closure = store.reachable(&[&commit.oid], &[]).unwrap();
6854 assert!(
6855 commit_closure.len() > 1,
6856 "the fixture's commit closes over nothing, so this test could not tell a peel from a no-op"
6857 );
6858
6859 let (tag_pack, tag_oid) = crate::store::tests::one_tag_pack(&commit_hex, "v1.0");
6860 store.put(&tag_pack, &[]).unwrap();
6861 store.wait_indexed();
6862
6863 let closure = store.reachable(&[&tag_oid], &[]).unwrap();
6864 assert!(
6865 closure.contains(&tag_oid),
6866 "the tag itself is not in its own closure"
6867 );
6868 assert!(
6869 closure.contains(&commit.oid),
6870 "the tag's closure is {} object(s), so it carries the tag and nothing it points at — the commit {} it names is missing and a mirror built from this answer cannot be read",
6871 closure.len(),
6872 &commit_hex[..12]
6873 );
6874 // Not merely the commit: everything the commit reaches, or a clone from
6875 // this answer is short by a tree.
6876 for oid in &commit_closure {
6877 assert!(
6878 closure.contains(oid),
6879 "the tag's closure is missing {} which the commit it points at reaches",
6880 hex::encode(oid)
6881 );
6882 }
6883 }
6884
6885 #[test]
6886 fn a_clean_shutdown_and_reopen_keeps_the_graph_and_reachable() {
6887 let dir = tmpdir("clean-shutdown-graph");
6888 let (pack, rows) = corpus_pack();
6889 std::fs::write(dir.join("fixture.pack"), &pack).unwrap();
6890
6891 let status = std::process::Command::new(std::env::current_exe().unwrap())
6892 .args([
6893 "--exact",
6894 "--ignored",
6895 "--nocapture",
6896 "git_ops::tests::the_child_that_pushes_and_shuts_down_cleanly",
6897 ])
6898 .env(CLEAN_DIR, &dir)
6899 .status()
6900 .expect("spawn the child that shuts down cleanly");
6901 assert!(
6902 status.success(),
6903 "the child did not exit cleanly — it {status:?}, so this is a crash guard and not a \
6904 clean-shutdown one"
6905 );
6906 assert!(
6907 dir.join("clean").exists(),
6908 "the child never reached its clean shutdown"
6909 );
6910
6911 let tip_hex = std::fs::read_to_string(dir.join("tip")).unwrap();
6912 let closure_before: usize = std::fs::read_to_string(dir.join("closure"))
6913 .unwrap()
6914 .parse()
6915 .unwrap();
6916 let commits_before: usize = std::fs::read_to_string(dir.join("commits"))
6917 .unwrap()
6918 .parse()
6919 .unwrap();
6920 assert_eq!(
6921 commits_before,
6922 commits_in(&rows),
6923 "the child's own graph was already wrong, so the reopen proves nothing"
6924 );
6925
6926 // ── the reopen, and (1): the graph before anything is waited on ──────
6927 let store = GitStore::open(&dir, "rickard").unwrap();
6928 assert_eq!(
6929 store.commit_count(),
6930 commits_in(&rows),
6931 "the commit graph did not survive a clean shutdown: {} of {} commits — the exploded \
6932 table is a warm cache, not a durable table",
6933 store.commit_count(),
6934 commits_in(&rows)
6935 );
6936 let tip_raw = hex::decode(&tip_hex).unwrap();
6937 let closure = store.reachable(&[&tip_raw], &[]).unwrap();
6938 assert_eq!(
6939 closure.len(),
6940 closure_before,
6941 "reachable() answers differently after a clean reopen: {} objects against the {} the \
6942 same tip closed over before the shutdown",
6943 closure.len(),
6944 closure_before
6945 );
6946 assert!(closure.contains(&tip_raw));
6947
6948 // ── (2): and none of it came from a re-absorb ────────────────────────
6949 store.wait_indexed();
6950 assert!(
6951 !store.indexer().is_indexed(0),
6952 "the reopen re-queued the pack, so the graph above is a recovery artefact rather \
6953 than the table's"
6954 );
6955 assert_eq!(store.unindexed_packs(), 0);
6956 assert_eq!(
6957 store.absorb_pending().unwrap(),
6958 0,
6959 "the reopen left index work"
6960 );
6961 assert_eq!(store.object_count(), rows.len());
6962 assert_eq!(
6963 store.exploded_stats().written,
6964 0,
6965 "this process wrote exploded rows, so the table was rebuilt rather than read"
6966 );
6967
6968 eprintln!(
6969 "load {}; clean shutdown → reopen: {} rows, {} commits, tip closure {} objects \
6970 (rebuilt nothing)",
6971 loadavg(),
6972 store.object_count(),
6973 store.commit_count(),
6974 closure.len(),
6975 );
6976 }
6977
6978 /// **A reopen READS `objects.graph`; it does not recompute it — and the
6979 /// read graph equals the recomputed one.** This is S-065's fix, and the only
6980 /// thing that can say which path a fold took is a counter, so the assertion
6981 /// is on [`GitStore::graph_source_stats`], not on the (identical) graph
6982 /// bytes — the identity-value trap, since both paths yield the same graph.
6983 ///
6984 /// One test exercises **both** arms so the counter cannot be blindly stuck:
6985 ///
6986 /// 1. A first store builds the graph, persists it, and shuts down cleanly.
6987 /// 2. `objects.graph` is deleted, so the reopen has no cache: it **recomputes**
6988 /// (`(read, recomputed) == (0, 1)`) and re-persists. Its graph and its
6989 /// `reachable()` are captured — this is the recomputed truth.
6990 /// 3. A second reopen finds the cache the step above wrote: it **reads**
6991 /// (`(1, 0)`), and its graph and `reachable()` must equal step 2's exactly
6992 /// — read == recomputed.
6993 ///
6994 /// # 🔴 Seen red
6995 ///
6996 /// With the persistence removed (open always folds), step 3 is `(0, 1)`:
6997 /// "the reopen recomputed the graph instead of reading objects.graph", left
6998 /// `(0, 1)` right `(1, 0)`. With the token check inverted so a stale cache is
6999 /// accepted, step 3's `reachable()` diverges from step 2's and the read==
7000 /// recomputed assertion fires. Restored.
7001 #[test]
7002 fn a_reopen_reads_the_persisted_graph_it_does_not_recompute() {
7003 let dir = tmpdir("persisted-graph");
7004 let (pack, rows) = corpus_pack();
7005 let tip_hex;
7006 {
7007 let store = GitStore::open(&dir, "rickard").unwrap();
7008 store.put_pack(&pack).unwrap();
7009 store.wait_indexed();
7010 tip_hex = store
7011 .graph_snapshot()
7012 .into_iter()
7013 .max_by_key(|c| c.generation)
7014 .expect("a graph")
7015 .oid;
7016 assert!(
7017 dir.join("objects.graph").exists(),
7018 "an absorb never persisted the graph, so a reopen has nothing to read"
7019 );
7020 }
7021 let tip_raw = hex::decode(&tip_hex).unwrap();
7022
7023 // ── (2) no cache → recompute, and capture the recomputed truth ───────
7024 std::fs::remove_file(dir.join("objects.graph")).unwrap();
7025 let (recomputed_graph, recomputed_closure) = {
7026 let store = GitStore::open(&dir, "rickard").unwrap();
7027 assert_eq!(
7028 store.graph_source_stats(),
7029 (0, 1),
7030 "with no objects.graph the reopen should have recomputed the graph"
7031 );
7032 assert_eq!(store.commit_count(), commits_in(&rows));
7033 let g = store.graph_snapshot();
7034 let c = store.reachable(&[&tip_raw], &[]).unwrap();
7035 assert!(!c.is_empty());
7036 (g, c)
7037 };
7038
7039 // ── (3) cache present → read, and it must equal the recomputed truth ──
7040 let store = GitStore::open(&dir, "rickard").unwrap();
7041 assert_eq!(
7042 store.graph_source_stats(),
7043 (1, 0),
7044 "the reopen recomputed the graph instead of reading objects.graph"
7045 );
7046 assert_eq!(
7047 store.graph_snapshot(),
7048 recomputed_graph,
7049 "the graph READ from objects.graph differs from the one refold RECOMPUTES"
7050 );
7051 assert_eq!(
7052 store.reachable(&[&tip_raw], &[]).unwrap(),
7053 recomputed_closure,
7054 "reachable() over the persisted graph differs from reachable() over the recomputed one"
7055 );
7056 assert_eq!(store.commit_count(), commits_in(&rows));
7057 }
7058
7059 /// **The graph cache switched off leaves no `objects.graph`** — and the store
7060 /// still answers the same graph and closure, folded from the exploded table.
7061 /// The switch is flipped on the absorber directly: `ZNIPPY_GIT_GRAPH_CACHE`
7062 /// is read at open, and setting it process-wide would race the test above.
7063 ///
7064 /// Seen red with the persist guard removed: "the graph cache is off and
7065 /// objects.graph was written anyway".
7066 #[test]
7067 fn with_the_graph_cache_off_no_objects_graph_is_written_and_the_graph_is_the_same() {
7068 let on_dir = tmpdir("graph-cache-on");
7069 let off_dir = tmpdir("graph-cache-off");
7070 let (pack, rows) = corpus_pack();
7071 let on = GitStore::open(&on_dir, "rickard").unwrap();
7072 on.put_pack(&pack).unwrap();
7073 on.wait_indexed();
7074 let off = GitStore::open(&off_dir, "rickard").unwrap();
7075 off.absorber.graph_cache.store(false, std::sync::atomic::Ordering::Relaxed);
7076 std::fs::remove_file(off_dir.join("objects.graph")).ok();
7077 off.put_pack(&pack).unwrap();
7078 off.wait_indexed();
7079 assert!(on_dir.join("objects.graph").exists(), "the default still persists the graph");
7080 assert!(
7081 !off_dir.join("objects.graph").exists(),
7082 "the graph cache is off and objects.graph was written anyway"
7083 );
7084 assert_eq!(off.graph_source_stats().0, 0, "a store with the cache off never reads one");
7085 assert_eq!(on.graph_snapshot(), off.graph_snapshot());
7086 assert_eq!(off.commit_count(), commits_in(&rows));
7087 }
7088
7089 /// **The token gates the read: a cache whose token does not match the
7090 /// object set is rejected and the graph is recomputed.** This is what makes
7091 /// `objects.graph` a memo rather than a second truth — and a push, a gc, or
7092 /// a torn write all reach the store through exactly this door.
7093 ///
7094 /// The object set is left unchanged and the token in the cache is corrupted
7095 /// directly, so the ONE thing under test is the token comparison and not
7096 /// some incidental object-count difference.
7097 ///
7098 /// # 🔴 Seen red
7099 ///
7100 /// With the token comparison dropped (`Some((_, g)) => g`), the corrupted
7101 /// cache is read and the reopen is `(1, 0)`: "a cache with the wrong token
7102 /// was trusted". Restored.
7103 #[test]
7104 fn a_graph_whose_token_does_not_match_is_rejected() {
7105 let dir = tmpdir("wrong-token-graph");
7106 let (pack, _rows) = corpus_pack();
7107 {
7108 let store = GitStore::open(&dir, "rickard").unwrap();
7109 store.put_pack(&pack).unwrap();
7110 store.wait_indexed();
7111 }
7112 // Flip a byte inside the 32-byte token (offset 5..37) without touching
7113 // the graph body, so only the token is wrong.
7114 let path = dir.join("objects.graph");
7115 let mut bytes = std::fs::read(&path).unwrap();
7116 assert!(bytes.len() > 37 && &bytes[..4] == b"GRPH");
7117 bytes[6] ^= 0xff;
7118 std::fs::write(&path, &bytes).unwrap();
7119
7120 let store = GitStore::open(&dir, "rickard").unwrap();
7121 assert_eq!(
7122 store.graph_source_stats(),
7123 (0, 1),
7124 "a cache with the wrong token was trusted instead of being recomputed"
7125 );
7126 }
7127
7128 /// **The ordinal space comes off the persisted index, not off a scan — and
7129 /// no `objects.ordinal` is ever written.** This replaces S-082's memo test:
7130 /// the memo spared a cold open the redb scan that rebuilt the sorted oid
7131 /// list, and since 2026-09-04 that list IS the persisted index's oid column,
7132 /// so there is nothing to spare and no file to validate. What is asserted:
7133 ///
7134 /// 1. A first store absorbs the corpus; its ordinal space equals the tail in
7135 /// oid order and every oid is accounted to one of the two sources. Then
7136 /// it folds explicitly, so redb is empty and the index holds everything.
7137 /// 2. The reopen is warm: its space comes **entirely off the index** —
7138 /// `(folded, tail) == (n, 0)` — and equals step 1's space, closure and
7139 /// counts exactly. `objects.ordinal` does not exist after either session.
7140 ///
7141 /// # 🔴 Seen red
7142 ///
7143 /// With `ObjectReadStack::oids_raw` returning only the redb tail on a
7144 /// persisting stack, step 2's space is empty (redb holds nothing after the
7145 /// fold) and `reachable()` over it is empty: "the ordinal space after the
7146 /// warm reopen is not the tail in oid order". Restored.
7147 #[test]
7148 fn the_ordinal_space_comes_off_the_index_not_a_scan() {
7149 let dir = tmpdir("ordinal-off-the-index");
7150 let (pack, rows) = corpus_pack();
7151 let tip_hex;
7152 let (first_oids, first_closure, first_objects, first_commits);
7153 {
7154 let store = GitStore::open(&dir, "rickard").unwrap();
7155 store.put_pack(&pack).unwrap();
7156 store.wait_indexed();
7157 tip_hex = store
7158 .graph_snapshot()
7159 .into_iter()
7160 .max_by_key(|c| c.generation)
7161 .expect("a graph")
7162 .oid;
7163 let tip_raw = hex::decode(&tip_hex).unwrap();
7164 let n = store.object_count() as u64;
7165 let (folded, tail) = store.ordinal_source_stats();
7166 assert_eq!(folded + tail, n, "every oid is accounted to the index or the tail");
7167 let oids = store.ordinal_oids();
7168 let scanned: Vec<String> =
7169 store.index().oids_in_order().unwrap().iter().map(hex::encode).collect();
7170 assert_eq!(oids, scanned, "the ordinal space is not the repository in oid order");
7171 assert!(
7172 !dir.join("objects.ordinal").exists(),
7173 "no memo may be written: the index's oid column is the ordinal space"
7174 );
7175 // Fold, so the reopen has everything on the index and nothing in redb.
7176 store.index().rebuild().unwrap();
7177 first_closure = store.reachable(&[&tip_raw], &[]).unwrap();
7178 assert!(!first_closure.is_empty());
7179 first_oids = oids;
7180 first_objects = store.object_count();
7181 first_commits = store.commit_count();
7182 }
7183 let tip_raw = hex::decode(&tip_hex).unwrap();
7184
7185 let store = GitStore::open(&dir, "rickard").unwrap();
7186 let n = store.object_count() as u64;
7187 assert_eq!(
7188 store.ordinal_source_stats(),
7189 (n, 0),
7190 "after a fold the warm reopen's ordinal space must come entirely off the index"
7191 );
7192 assert_eq!(
7193 store.ordinal_oids(),
7194 first_oids,
7195 "the ordinal space after the warm reopen is not the tail in oid order"
7196 );
7197 assert_eq!(
7198 store.reachable(&[&tip_raw], &[]).unwrap(),
7199 first_closure,
7200 "reachable() over the index's ordinal space differs from the first session's"
7201 );
7202 assert_eq!(store.object_count(), first_objects);
7203 assert_eq!(store.commit_count(), first_commits);
7204 assert_eq!(store.commit_count(), commits_in(&rows));
7205 assert!(!dir.join("objects.ordinal").exists(), "still no memo after the reopen");
7206 }
7207
7208 /// **A stale `objects.ordinal` left by an older binary is removed at open.**
7209 /// The file is dead weight now (279 MB on the kernel mirror) and its
7210 /// contents are never read, so a store that carries one loses it the first
7211 /// time this build opens it — and keeps working.
7212 ///
7213 /// # 🔴 Seen red
7214 ///
7215 /// With the `remove_file` in `open_with_arms` dropped, the file survives the
7216 /// open: "a stale objects.ordinal must be removed at open". Restored.
7217 #[test]
7218 fn a_stale_objects_ordinal_from_an_older_binary_is_removed_at_open() {
7219 let dir = tmpdir("stale-ordinal");
7220 let (pack, _rows) = corpus_pack();
7221 {
7222 let store = GitStore::open(&dir, "rickard").unwrap();
7223 store.put_pack(&pack).unwrap();
7224 store.wait_indexed();
7225 }
7226 // The old memo's shape: magic, version, oid_len, epoch, count, oids.
7227 let path = dir.join("objects.ordinal");
7228 let mut bytes = b"ORDL".to_vec();
7229 bytes.push(1);
7230 bytes.push(20);
7231 bytes.extend_from_slice(&7u64.to_le_bytes());
7232 bytes.extend_from_slice(&1u64.to_le_bytes());
7233 bytes.extend_from_slice(&[0xabu8; 20]);
7234 std::fs::write(&path, &bytes).unwrap();
7235 assert!(path.exists(), "precondition");
7236
7237 let store = GitStore::open(&dir, "rickard").unwrap();
7238 assert!(!path.exists(), "a stale objects.ordinal must be removed at open");
7239 assert!(store.object_count() > 0, "and the store still answers");
7240 }
7241
7242 /// **A content read is served from the table, not re-derived** — and the only
7243 /// thing that can say so is a counter.
7244 ///
7245 /// Both paths return the **identical** bytes: the table hands back what the
7246 /// resolver produced, and the fallback re-resolves the same pack and produces
7247 /// it again. A byte comparison therefore proves nothing at all about which
7248 /// one ran — this is the identity-value trap in its exact form, and it fired
7249 /// on this codebase once already. So the assertion is on
7250 /// [`ExplodedStats::served`] against [`ExplodedStats::rederived`], both of
7251 /// which are bumped where the work happens.
7252 ///
7253 /// The fallback is not asserted away: it is exercised in the same test, on a
7254 /// store whose table has been dropped, and the counters move the other way.
7255 /// A guard that only saw the fast path could not tell a working counter from
7256 /// one that is never incremented.
7257 ///
7258 /// Seen RED by deleting the `if let Some(hit) = self.exploded.content(oid)?`
7259 /// early return in `Absorber::resolved`, so every read re-derives: "512 content
7260 /// reads re-resolved a whole pack instead of hitting the table — served 0,
7261 /// rederived 512". The bytes were still correct on every one of them, which
7262 /// is the point. Restored.
7263 ///
7264 /// Seen RED a second time by bumping `served` unconditionally at the top of
7265 /// `ExplodedTable::content`, before the `pending`/redb probe — the counter
7266 /// then reports a hit whether or not the table had the object. The first half
7267 /// fires on the double count, "512 content reads re-resolved a whole pack
7268 /// instead of hitting the table — served 1024, rederived 0", and
7269 /// `exploded::tests::a_row_round_trips_and_the_kind_index_finds_it` fires with
7270 /// it ("a content read was not counted", left 5 right 2). Restored — a
7271 /// counter that cannot be wrong about a miss is the only kind worth
7272 /// asserting on.
7273 #[test]
7274 fn a_content_read_is_served_from_the_table_and_not_re_derived() {
7275 const READS: usize = 512;
7276 let dir = tmpdir("exploded-served");
7277 let (pack, rows) = corpus_pack();
7278 let oids: Vec<Vec<u8>> = rows
7279 .iter()
7280 .map(|r| r.oid.clone())
7281 .collect::<HashSet<Vec<u8>>>()
7282 .into_iter()
7283 .take(READS)
7284 .collect();
7285
7286 {
7287 let store = GitStore::open(&dir, "rickard").unwrap();
7288 store.put_pack(&pack).unwrap();
7289 store.wait_indexed();
7290
7291 // ── FIRST read: the lazy path, timed ────────────────────────
7292 let before = store.exploded_stats();
7293 let t = Instant::now();
7294 let mut first: Vec<(GitObjectKind, Vec<u8>)> = Vec::with_capacity(oids.len());
7295 for oid in &oids {
7296 first.push(
7297 store
7298 .content(oid)
7299 .unwrap()
7300 .expect("the store lost an object"),
7301 );
7302 }
7303 let cold = t.elapsed();
7304 let after = store.exploded_stats();
7305 let rederived = after.rederived - before.rederived;
7306 assert_eq!(
7307 rederived + (after.served - before.served),
7308 oids.len() as u64,
7309 "{} reads = served {} + rederived {} must account for every one",
7310 oids.len(),
7311 after.served - before.served,
7312 rederived
7313 );
7314 assert!(
7315 rederived > 0,
7316 "not one read re-derived: either every object is eager or the lazy \
7317 path never ran, and this test then proves nothing about either"
7318 );
7319
7320 // The write-back is off the read path, so it has to be waited for
7321 // HERE and only here — a reader never does.
7322 store.explode_cache_maintain().unwrap();
7323 // **How many of those reads the cache DECLINED.** A shallow, small
7324 // object is cheaper to inflate again than to keep, so it is read
7325 // directly and nothing is written
7326 // (`exploded_cache::worth_caching`). Those objects are re-derived
7327 // on every read for ever, on purpose, and the second pass below
7328 // has to expect exactly that many — not zero, which is what this
7329 // test asserted before the admission policy existed and would now
7330 // be asserting that the policy is off.
7331 let declined = store.explode_cache_use().direct_reads;
7332 assert!(
7333 declined > 0,
7334 "not one of {} reads was declined as cheap; either every object in \
7335 this corpus is expensive or the admission policy is not running",
7336 oids.len()
7337 );
7338
7339 // ── SECOND read: the design note's "= today" column ──────────
7340 let mid = store.exploded_stats();
7341 let t = Instant::now();
7342 for (i, oid) in oids.iter().enumerate() {
7343 let again = store.content(oid).unwrap().expect("the store lost an object");
7344 assert_eq!(again, first[i], "the second read of an object disagreed with the first");
7345 }
7346 let warm = t.elapsed();
7347 let end = store.exploded_stats();
7348 assert_eq!(
7349 end.rederived - mid.rederived,
7350 declined,
7351 "the second pass re-derived {} objects and the cache declined {declined} — \
7352 every EXPENSIVE object must come out of the table the second time, and \
7353 every cheap one must be read directly again",
7354 end.rederived - mid.rederived
7355 );
7356 assert_eq!(
7357 end.served - mid.served,
7358 oids.len() as u64 - declined,
7359 "the expensive objects did not come out of the table on the second pass"
7360 );
7361 eprintln!(
7362 "load {}; {} content reads: FIRST {:.1} ms ({:.1} µs/read, {} re-derived from \
7363 the pack, {declined} of them too cheap to cache) → SECOND {:.1} ms \
7364 ({:.1} µs/read) = {:.1}x",
7365 loadavg(),
7366 oids.len(),
7367 cold.as_secs_f64() * 1e3,
7368 cold.as_secs_f64() * 1e6 / oids.len() as f64,
7369 rederived,
7370 warm.as_secs_f64() * 1e3,
7371 warm.as_secs_f64() * 1e6 / oids.len() as f64,
7372 cold.as_secs_f64() / warm.as_secs_f64().max(f64::MIN_POSITIVE),
7373 );
7374 }
7375
7376 // ── and the fallback, so the counter is not a constant ───────────────
7377 //
7378 // The table is dropped and the *drain* is what would rebuild it, so the
7379 // reads have to happen before it gets there. `absorb_pending` is called
7380 // by hand first so the fallback under test is the content path's and not
7381 // the index's.
7382 std::fs::remove_file(dir.join("objects.exploded")).unwrap();
7383 // **And the lazy pool with it.** Dropping only the eager table leaves
7384 // the write-backs of the pass above sitting in `objects.exploded.cN`,
7385 // and those would answer — the fallback would then be measured on a
7386 // store that still has a cache, which is the exact shape of a test that
7387 // cannot fail. One `drop_explode_cache` is the sanctioned door, and it
7388 // is what `repo gc` calls.
7389 for e in std::fs::read_dir(&dir).unwrap().flatten() {
7390 if e.file_name().to_string_lossy().starts_with("objects.exploded.c") {
7391 std::fs::remove_file(e.path()).unwrap();
7392 }
7393 }
7394 let store = GitStore::open(&dir, "rickard").unwrap();
7395 let gate = store.hold_absorb_gate();
7396 let before = store.exploded_stats();
7397 let mut rederived = 0u64;
7398 for oid in oids.iter().take(8) {
7399 // Straight at the absorber: the store's `content` would absorb the
7400 // re-queued pack first and rebuild the very table this is testing
7401 // the absence of.
7402 assert!(
7403 store.absorber.resolved(oid).unwrap().is_some(),
7404 "the verbatim truth could not re-derive {}",
7405 hex::encode(oid)
7406 );
7407 rederived += 1;
7408 }
7409 let after = store.exploded_stats();
7410 // The drain starts the instant the store opens; on a loaded box it can
7411 // rebuild the small corpus's table before the gate above is taken, and
7412 // then the reads are legitimately served from it. Seen 2026-08-30 under
7413 // a parallel suite. That run proves nothing about the fallback and says
7414 // so, rather than failing on a race the test does not control.
7415 let drain_won = store.unindexed_packs() == 0;
7416 drop(gate);
7417 if drain_won {
7418 eprintln!("the drain rebuilt the table before the gate was held; the fallback was not observed this run");
7419 return;
7420 }
7421 assert_eq!(
7422 after.served - before.served,
7423 0,
7424 "a dropped table still reported {} reads served",
7425 after.served - before.served
7426 );
7427 assert_eq!(
7428 after.rederived - before.rederived,
7429 rederived,
7430 "the fallback ran but was not counted"
7431 );
7432 }
7433
7434 /// ★ **THE READ-AFTER-ACK GAP (lane U → lane Q): every read path answers
7435 /// with the indexer PAUSED, and none of them waits for it.**
7436 ///
7437 /// MEASURED on the rig 2026-08-30 (lane U, both ISOs, timing-dependent):
7438 /// right after an ACKED push a `clone` came back
7439 /// `remote error: object … is not in this repository (peeling a tag)` and a
7440 /// `push --mirror` on top got `[remote rejected] … missing necessary
7441 /// objects`. Both of those are gunnar's `Graph::load` — `GitServe::read` —
7442 /// answering `None` for an object whose bytes were fsynced before the client
7443 /// was told the push had landed. §13.12 says an index miss falls back to the
7444 /// journal; the tag-peel and connectivity-check paths were not observed to.
7445 ///
7446 /// So this holds the absorb gate — the indexer paused, exactly the state
7447 /// lane P's watchdog puts it in — and requires **`has`, `header` and `read`
7448 /// to answer for every object of a just-acked pack**, byte-correct, and to
7449 /// do it inside a deadline. The deadline is not decoration: "nobody waits"
7450 /// (the design note's rule) is violated by a read that blocks on the gate
7451 /// just as badly as by one that answers absent, and a blocking read looks
7452 /// exactly like a correct one to an assertion that has no clock.
7453 ///
7454 /// Seen RED by returning `Ok(None)` from `Absorber::resolved`'s pending arm:
7455 /// 1352 of 1352 objects report "the store said absent for an object it had
7456 /// already acked".
7457 #[test]
7458 fn every_read_path_answers_a_just_acked_push_with_the_indexer_paused() {
7459 use crate::serve::GitServe as _;
7460 let dir = tmpdir("read-after-ack");
7461 let store = Arc::new(GitStore::open(&dir, "rickard").unwrap());
7462 let (pack, rows) = corpus_pack();
7463
7464 // The ack: `put_pack` returning is what the client is told.
7465 store.put_pack(&pack).unwrap();
7466
7467 // The indexer, paused. A watchdog pause (lane P) pauses the indexer and
7468 // nothing else, so this is the shape the appliance is really in.
7469 let gate = store.hold_absorb_gate();
7470 assert!(
7471 store.unindexed_packs() > 0,
7472 "the drain absorbed the pack before the gate was taken, so this run \
7473 read an INDEXED store and proves nothing about the window"
7474 );
7475
7476 let distinct: Vec<Vec<u8>> = rows
7477 .iter()
7478 .map(|r| r.oid.clone())
7479 .collect::<HashSet<Vec<u8>>>()
7480 .into_iter()
7481 .collect();
7482 let hash = store.hash_kind();
7483 let n = distinct.len();
7484
7485 // On another thread, so the deadline measures the reads and not this
7486 // test's own patience.
7487 let (tx, rx) = std::sync::mpsc::channel::<Result<(usize, usize, usize)>>();
7488 let reader = {
7489 let store = store.clone();
7490 let distinct = distinct.clone();
7491 std::thread::spawn(move || {
7492 let mut had = 0usize;
7493 let mut headed = 0usize;
7494 let mut readback = 0usize;
7495 let r = (|| -> Result<()> {
7496 for oid in &distinct {
7497 if store.has(oid)? {
7498 had += 1;
7499 }
7500 if crate::serve::GitServe::header(&*store, oid)?.is_some() {
7501 headed += 1;
7502 }
7503 // The tag-peel / connectivity-check path, byte for byte.
7504 let Some((kind, payload)) = crate::serve::GitServe::read(&*store, oid)? else {
7505 continue;
7506 };
7507 let k = match kind {
7508 crate::index_layout::ObjType::Commit => GitObjectKind::Commit,
7509 crate::index_layout::ObjType::Tree => GitObjectKind::Tree,
7510 crate::index_layout::ObjType::Blob => GitObjectKind::Blob,
7511 crate::index_layout::ObjType::Tag => GitObjectKind::Tag,
7512 // A read resolves the chain, so a delta type coming
7513 // back out of it is the store contradicting itself.
7514 other => anyhow::bail!("`read` answered with a {other:?}"),
7515 };
7516 let rehashed = hash.oid_of(&crate::object::canonical(k, &payload));
7517 if &rehashed == oid {
7518 readback += 1;
7519 }
7520 }
7521 Ok(())
7522 })();
7523 let _ = tx.send(r.map(|_| (had, headed, readback)));
7524 })
7525 };
7526
7527 // The deadline. Generous — a cold pending scan of the corpus is
7528 // milliseconds — and it is against a WALL clock while the gate is held,
7529 // so a read that parks on the absorber trips it.
7530 let out = rx
7531 .recv_timeout(Duration::from_secs(20))
7532 .expect(
7533 "a read path blocked on the paused indexer for 20 s: 'nobody waits' is the \
7534 design note's rule and a read that waits for the drain is a bug by definition",
7535 );
7536 let (had, headed, readback) = out.expect("a read path errored inside the index window");
7537 drop(gate);
7538 let _ = reader.join();
7539
7540 assert_eq!(
7541 (had, headed, readback),
7542 (n, n, n),
7543 "the store answered for {had}/{n} `has`, {headed}/{n} `header` and {readback}/{n} \
7544 byte-correct `read`s of a pack it had already ACKED — an object the client was \
7545 told had landed must never read as absent"
7546 );
7547 }
7548
7549 /// ★ **An account at its explode budget serves EVERY object, correctly —
7550 /// only slower.**
7551 ///
7552 /// The quota is a cache size, not a storage limit: over budget the server
7553 /// EVICTS, it does not refuse. So a repository squeezed to a budget far
7554 /// under what it holds must still answer every read byte-for-byte, and the
7555 /// only thing that may change is where the bytes came from — the table, or
7556 /// the pack via [`crate::resolve::materialize_at`].
7557 ///
7558 /// This is requirement (c) of the quota: *"an account at its budget must
7559 /// still serve every read correctly, only slower"*. The `rederived`
7560 /// counter is what proves the eviction really happened, because identical
7561 /// bytes come back either way and a byte comparison cannot tell a working
7562 /// cache from a dead one — the identity-value trap in its exact form.
7563 ///
7564 /// Seen RED by having `write_back` return the payload's bytes from a
7565 /// half-written segment (`out.truncate(1)`): "the store returned the wrong
7566 /// bytes for an object under a squeezed budget".
7567 #[test]
7568 fn an_account_at_its_budget_serves_every_object_only_slower() {
7569 let dir = tmpdir("explode-budget");
7570 let store = GitStore::open(&dir, "rickard").unwrap();
7571 let (pack, rows) = corpus_pack();
7572 store.put_pack(&pack).unwrap();
7573 store.wait_indexed();
7574
7575 let oids: Vec<Vec<u8>> = rows
7576 .iter()
7577 .map(|r| r.oid.clone())
7578 .collect::<HashSet<Vec<u8>>>()
7579 .into_iter()
7580 .collect();
7581
7582 // Every object once, unsqueezed: the truth to compare against.
7583 let mut truth: Vec<(GitObjectKind, Vec<u8>)> = Vec::with_capacity(oids.len());
7584 for oid in &oids {
7585 truth.push(store.content(oid).unwrap().expect("the store lost an object"));
7586 }
7587 store.explode_cache_maintain().unwrap();
7588
7589 // Now the plan changes: a budget far under what this repository holds.
7590 store.set_explode_budget(64 << 10);
7591 let before = store.exploded_stats();
7592 for _ in 0..3 {
7593 for (i, oid) in oids.iter().enumerate() {
7594 let got = store
7595 .content(oid)
7596 .unwrap()
7597 .expect("an object went absent when the budget was lowered");
7598 assert_eq!(
7599 got, truth[i],
7600 "the store returned the wrong bytes for an object under a squeezed budget"
7601 );
7602 }
7603 store.explode_cache_maintain().unwrap();
7604 }
7605 let after = store.exploded_stats();
7606 let band = store.explode_cache_use();
7607
7608 assert!(
7609 band.evicted_bytes > 0 || band.lazy_bytes <= 64 << 10,
7610 "the budget was lowered to 64 KiB and the lazy pool holds {} B with nothing \\
7611 evicted — the quota is not enforced, so this run proves nothing about reading \\
7612 under one: {band:?}",
7613 band.lazy_bytes
7614 );
7615 assert!(
7616 after.rederived > before.rederived,
7617 "not one read re-derived from the pack under a 64 KiB budget, so the cache was \\
7618 never squeezed and 'only slower' was never tested"
7619 );
7620 eprintln!(
7621 "load {}; {} objects read 3x under a 64 KiB budget: {} re-derived, {} served, \
7622{} evicted bytes over {} segments; every byte identical",
7623 loadavg(),
7624 oids.len(),
7625 after.rederived - before.rederived,
7626 after.served - before.served,
7627 band.evicted_bytes,
7628 band.evicted_segments,
7629 );
7630 }
7631
7632 /// ★ **A THIN push on top of a just-acked one is accepted with the indexer
7633 /// PAUSED** — lane U's second rig symptom.
7634 ///
7635 /// MEASURED on the rig 2026-08-30 (lane U): right after an acked push,
7636 /// `git push --mirror` of the next pack came back
7637 /// `[remote rejected] … missing necessary objects`, on a varying set of
7638 /// repositories run to run — a race, not a repository. A thin pack names
7639 /// its delta bases by oid and expects the server to have them; the server
7640 /// **did** have them, in a pack it had acked and not yet indexed, and
7641 /// `scan_pending`'s re-entrancy guard answered `None` for every base looked
7642 /// up from inside a scan rather than only for the ones that would have
7643 /// started a second scan.
7644 ///
7645 /// Seen RED by restoring that guard (`if nested { return Ok((out, None)) }`):
7646 /// *"reading the thin pack's object errored inside the index window:
7647 /// resolving a pending pack read-only for lookups — this pack is thin: it
7648 /// deltas against 42088154… which is not in it, and no base source could
7649 /// produce that object's content"*. The **push** is accepted either way —
7650 /// `external_bases_exist` finds the base with a top-level `lookup_one`
7651 /// before it ever resolves — so the assertion that discriminates is the
7652 /// READ with the gate still held, and an earlier draft of this test that
7653 /// dropped the gate first passed under both arms.
7654 #[test]
7655 fn a_thin_push_on_top_of_an_unindexed_one_is_accepted() {
7656 let dir = tmpdir("thin-on-unindexed");
7657 let store = GitStore::open(&dir, "rickard").unwrap();
7658 let (pack, rows) = corpus_pack();
7659 store.put_pack(&pack).unwrap();
7660
7661 // The indexer, paused — so the base can only be found in the pack that
7662 // was acked a moment ago.
7663 let gate = store.hold_absorb_gate();
7664 assert!(
7665 store.unindexed_packs() > 0,
7666 "the drain absorbed the first pack before the gate was taken; this run \
7667 pushed onto an INDEXED store and proves nothing"
7668 );
7669
7670 // A base with a payload, and its real size: a `REF_DELTA` declares the
7671 // source size and the resolver checks it, so a made-up number would fail
7672 // for a reason that has nothing to do with the window under test.
7673 let base = rows
7674 .iter()
7675 .find(|r| r.kind == GitObjectKind::Blob && r.uncompressed_size > 0)
7676 .expect("the corpus has a blob");
7677 let thin = crate::pack_fixture::thin_ref_delta_pack(
7678 &base.oid,
7679 base.uncompressed_size,
7680 b"lane Q was here\n",
7681 );
7682
7683 let tx = store.put_pack(&thin).unwrap_or_else(|e| {
7684 panic!("the thin push was refused: {e:#}");
7685 });
7686 assert!(tx.pack_id.is_some(), "the thin pack was not stored");
7687
7688 // **And its object reads back with the gate STILL HELD.** This is the
7689 // nested case and the one the guard was too wide for: the read scans
7690 // pack B, B's entry is a ref-delta, its base is in pack A, and
7691 // resolving it is a second `scan_pending` from inside the first. A
7692 // lookup into A's already-built scan terminates; only a *build* would
7693 // not.
7694 let hash = store.hash_kind();
7695 let oid = hash.oid_of(&crate::object::canonical(
7696 GitObjectKind::Blob,
7697 b"lane Q was here\n",
7698 ));
7699 let got = store.content(&oid);
7700 drop(gate);
7701 let (kind, payload) = got
7702 .expect("reading the thin pack's object errored inside the index window")
7703 .expect("the thin pack's own object is absent after its push was acked");
7704 assert_eq!(kind, GitObjectKind::Blob);
7705 assert_eq!(payload, b"lane Q was here\n");
7706 }
7707
7708 /// **Dropping the table and reopening still answers correctly — fall back,
7709 /// then rebuild.**
7710 ///
7711 /// §14 calls the resolved table *droppable*: derived, verifiable against the
7712 /// verbatim truth, and deletable at any time without consulting a client.
7713 /// This is that sentence as an operation — `rm objects.exploded` between two
7714 /// opens — and §13.12's rule applied to it unchanged: **absent means fall
7715 /// back, never means wrong.**
7716 ///
7717 /// Three things are asserted, in this order:
7718 ///
7719 /// 1. the file really is gone and the reopened store really does start with
7720 /// an empty table — otherwise the rest is testing a warm one;
7721 /// 2. **`reachable()` is already correct**, asked before any drain has been
7722 /// waited on: the fall-back absorb runs inline and rebuilds what the
7723 /// answer needs;
7724 /// 3. the table is **rebuilt** — one row per object again, the graph back,
7725 /// and the rows written by *this* process, which is what says a rebuild
7726 /// happened rather than a survival.
7727 ///
7728 /// Seen RED by `let exploded_is_whole = self.exploded.rows()? >= self.objects.len()
7729 /// as u64;` → `= true;` in `Absorber::adopt_journal`, so a dropped table is
7730 /// never noticed and nothing is re-queued. Assertion (2) fires first:
7731 /// **"reachable() after dropping the table: 1 objects, against 2683
7732 /// before"** — one object, the tip alone, which is the recorded bug's exact
7733 /// symptom ("`reachable` on a commit returns that commit alone rather than
7734 /// its closure") arrived at from the other direction. Restored.
7735 ///
7736 /// Seen RED a second time by `>=` → `>` in the same expression, which makes a
7737 /// *whole* table look short. This guard stays green — the rebuild is
7738 /// correct — and two others fire instead:
7739 /// [`a_clean_shutdown_and_reopen_keeps_the_graph_and_reachable`]'s "the
7740 /// reopen re-queued the pack, so the graph above is a recovery artefact
7741 /// rather than the table's", and the pre-existing
7742 /// [`a_clean_reopen_requeues_nothing_and_the_next_push_gets_a_fresh_ordinal`]'s
7743 /// "a fully absorbed pack was re-queued on open — the diff is not exact".
7744 /// That pair is the point: one guard catches the table not being rebuilt when
7745 /// it should be, the others catch it being rebuilt when it should not.
7746 /// Restored.
7747 #[test]
7748 fn dropping_the_exploded_table_and_reopening_still_answers() {
7749 let dir = tmpdir("exploded-dropped");
7750 let (pack, rows) = corpus_pack();
7751 let tip_hex;
7752 let closure_before;
7753 {
7754 let store = GitStore::open(&dir, "rickard").unwrap();
7755 store.put_pack(&pack).unwrap();
7756 store.wait_indexed();
7757 let tip = store
7758 .graph_snapshot()
7759 .into_iter()
7760 .max_by_key(|c| c.generation)
7761 .expect("a graph");
7762 let tip_raw = hex::decode(&tip.oid).unwrap();
7763 closure_before = store.reachable(&[&tip_raw], &[]).unwrap().len();
7764 tip_hex = tip.oid;
7765 }
7766
7767 // (1) — the drop.
7768 let table = dir.join("objects.exploded");
7769 assert!(table.exists(), "the store never built an exploded table");
7770 std::fs::remove_file(&table).unwrap();
7771 {
7772 let fresh = crate::exploded_arrow::ExplodedArchive::open(&table).unwrap();
7773 assert_eq!(fresh.rows().unwrap(), 0, "the drop did not drop anything");
7774 }
7775 // Opening an absent table does not create one — so this only has
7776 // anything to remove if the assertion above was inspecting a live file.
7777 let _ = std::fs::remove_file(&table);
7778
7779 // (2) — a correct answer with the table gone.
7780 let store = GitStore::open(&dir, "rickard").unwrap();
7781 let tip_raw = hex::decode(&tip_hex).unwrap();
7782 let closure = store.reachable(&[&tip_raw], &[]).unwrap();
7783 assert_eq!(
7784 closure.len(),
7785 closure_before,
7786 "reachable() after dropping the table: {} objects, against {} before",
7787 closure.len(),
7788 closure_before
7789 );
7790 assert!(store.has(&rows[0].oid).unwrap());
7791
7792 // (3) — and it is back. The GRAPH is what comes back at push time; a
7793 // blob comes back when somebody reads it, which is the whole of lazy
7794 // explode, so the count to compare against is the graph's and not the
7795 // pack's.
7796 store.wait_indexed();
7797 let stats = store.exploded_stats();
7798 let distinct: HashSet<Vec<u8>> = rows.iter().map(|r| r.oid.clone()).collect();
7799 // Commits, and NOT `of_kind(Tree)`: under the shipped policy a tree is
7800 // lazy, so the trees this test's own reads cached are in the lazy pool
7801 // and `of_kind` unions both.
7802 let graph_rows = store.exploded_of_kind(GitObjectKind::Commit).unwrap().len();
7803 // The EAGER pool, not `stats.rows`: step (2) above read objects through
7804 // the store, and every one of those reads wrote its object back into the
7805 // lazy pool, which `stats.rows` also counts. Comparing the sum against
7806 // the graph would be comparing "what the push wrote" against "what the
7807 // push wrote plus what this test happened to read".
7808 let eager = store.exploded_eager_rows().unwrap();
7809 assert_eq!(
7810 eager, graph_rows as u64,
7811 "the dropped table came back holding {eager} rows against a {}-object graph",
7812 graph_rows
7813 );
7814 assert!(
7815 eager > 0 && eager < distinct.len() as u64,
7816 "the rebuilt pool holds {eager} of {} objects — neither 0 nor all of them is \
7817 the lane Q shape",
7818 distinct.len()
7819 );
7820 assert!(
7821 stats.written > 0,
7822 "the table came back without this process writing a row — it was never dropped"
7823 );
7824 assert_eq!(
7825 store.commit_count(),
7826 commits_in(&rows),
7827 "the graph did not come back with the table: {} of {}",
7828 store.commit_count(),
7829 commits_in(&rows)
7830 );
7831 assert_eq!(
7832 store.object_count(),
7833 rows.len(),
7834 "the rebuild lost index rows"
7835 );
7836 eprintln!(
7837 "load {}; dropped and rebuilt: {} rows written, {} commits, tip closure {} objects",
7838 loadavg(),
7839 stats.written,
7840 store.commit_count(),
7841 closure.len(),
7842 );
7843 }
7844
7845 // ─────────────────────────────────────────────────────────────────────
7846 // lane ENGINE-OPT scaffold: a graded linear-history generator, the O(C)
7847 // negotiation timing test, and the cross-push memo-invalidation guard.
7848 // ─────────────────────────────────────────────────────────────────────
7849
7850 /// A linear commit history of `n` commits as a clone pack, optionally
7851 /// chained onto `start_parent` (an oid already in the store). Each commit
7852 /// carries its own one-entry tree and one unique blob, so the object count
7853 /// is `3n` and the graph is a single parent chain `n` deep — the shape that
7854 /// makes a negotiation's cost O(commits), which is what this lane memoizes.
7855 fn linear_history_pack_from(
7856 n: usize,
7857 start_parent: Option<&[u8]>,
7858 ) -> (Vec<u8>, Vec<Vec<u8>>) {
7859 use crate::object::canonical;
7860 use crate::pack_fixture::{build_pack, Item};
7861 let hash = GitHashKind::Sha1;
7862 let mut items: Vec<Item> = Vec::with_capacity(n * 3);
7863 let mut commits: Vec<Vec<u8>> = Vec::with_capacity(n);
7864 let mut prev: Option<Vec<u8>> = start_parent.map(|p| p.to_vec());
7865 for c in 0..n {
7866 let body = format!("blob for commit {c} of {n}, parent {prev:?}\n").into_bytes();
7867 let blob_oid = hash.oid_of(&canonical(GitObjectKind::Blob, &body));
7868 items.push(Item::Whole(GitObjectKind::Blob, body));
7869
7870 let mut tpayload = Vec::new();
7871 tpayload.extend_from_slice(b"100644 f.bin\0");
7872 tpayload.extend_from_slice(&blob_oid);
7873 let tree_oid = hash.oid_of(&canonical(GitObjectKind::Tree, &tpayload));
7874 items.push(Item::Whole(GitObjectKind::Tree, tpayload));
7875
7876 let mut cbody = format!("tree {}\n", hex::encode(&tree_oid));
7877 if let Some(parent) = &prev {
7878 cbody.push_str(&format!("parent {}\n", hex::encode(parent)));
7879 }
7880 cbody.push_str(
7881 "author A U Thor <a@example.com> 1700000000 +0000\n\
7882 committer A U Thor <a@example.com> 1700000000 +0000\n\n\
7883 commit\n",
7884 );
7885 let cbody = cbody.into_bytes();
7886 let commit_oid = hash.oid_of(&canonical(GitObjectKind::Commit, &cbody));
7887 items.push(Item::Whole(GitObjectKind::Commit, cbody));
7888 prev = Some(commit_oid.clone());
7889 commits.push(commit_oid);
7890 }
7891 (build_pack(&items), commits)
7892 }
7893
7894 /// The O(commits) negotiation cost, graded. `reachable` rebuilt the
7895 /// `by_commit` and graph maps on every call — O(C) regardless of how few
7896 /// objects the request touched — so the `root` query (closure ~1) isolates
7897 /// that map-build cost from the walk, and the `tip` query (full closure)
7898 /// pays both. Median of nine, min–max, with the loadavg of its own run.
7899 #[test]
7900 #[ignore = "perf measurement; run with --release --ignored --nocapture"]
7901 fn bench_reachable_negotiation() {
7902 for &n in &[48usize, 2_000, 20_000] {
7903 let dir = tmpdir(&format!("bench-reach-{n}"));
7904 let (pack, commits) = linear_history_pack_from(n, None);
7905 let store = GitStore::open(&dir, "rickard").unwrap();
7906 store.put_pack(&pack).unwrap();
7907 store.wait_indexed();
7908 let root = commits.first().unwrap().clone();
7909 let tip = commits.last().unwrap().clone();
7910 // warm the reach bitmaps once so the loop times the negotiation, not
7911 // the one-time bitmap build.
7912 let _ = store.reachable(&[&tip], &[]).unwrap();
7913
7914 let reps = 9usize;
7915 let (mut root_t, mut tip_t) = (Vec::new(), Vec::new());
7916 for _ in 0..reps {
7917 let t = Instant::now();
7918 let _ = store.reachable(&[&root], &[]).unwrap();
7919 root_t.push(t.elapsed());
7920 let t = Instant::now();
7921 let _ = store.reachable(&[&tip], &[]).unwrap();
7922 tip_t.push(t.elapsed());
7923 }
7924 root_t.sort();
7925 tip_t.sort();
7926 let tip_closure = store.reachable(&[&tip], &[]).unwrap().len();
7927 eprintln!(
7928 "load {}; n={n}: reachable(root, closure~1) med {:?} [{:?}..{:?}] | \
7929 reachable(tip, closure {}) med {:?} [{:?}..{:?}]",
7930 loadavg(),
7931 root_t[reps / 2],
7932 root_t[0],
7933 root_t[reps - 1],
7934 tip_closure,
7935 tip_t[reps / 2],
7936 tip_t[0],
7937 tip_t[reps - 1],
7938 );
7939 }
7940 }
7941
7942 /// **A negotiation answered from the memoized reach view is the answer a
7943 /// cold fold gives — including across a push that changes the fold.**
7944 ///
7945 /// Lane ENGINE-OPT memoizes the `by_commit` and graph lookup maps that
7946 /// `reachable` used to rebuild on every call, in `Derived`, folded by the
7947 /// same call that folds `commit_raw`. The bug this discipline exists to
7948 /// catch is a memo that SURVIVES a fold it should not: after a push adds
7949 /// commits, the warm store must answer with the new closure, byte-identical
7950 /// (order included — both spaces sort the same oids) to a fresh store
7951 /// opened cold on the same bytes.
7952 ///
7953 /// Seen RED by skipping the memo rebuild in `refold` (leaving `graph_index`
7954 /// from before the push): the post-push tip is then not a known commit,
7955 /// `reachable` contributes it alone, and the warm answer is a handful of
7956 /// objects where the cold fold gives the whole chain — the assertion names
7957 /// both lengths.
7958 #[test]
7959 fn reachable_memo_matches_a_cold_fold_across_a_push() {
7960 let dir = tmpdir("reach-memo-across-push");
7961 let (pack_a, commits_a) = linear_history_pack_from(40, None);
7962 let store = GitStore::open(&dir, "rickard").unwrap();
7963 store.put_pack(&pack_a).unwrap();
7964 store.wait_indexed();
7965 let tip_a = commits_a.last().unwrap().clone();
7966 let warm_a = store.reachable(&[&tip_a], &[]).unwrap();
7967 assert!(
7968 warm_a.len() > 10,
7969 "A's closure is too small to tell a stale memo from a coincidence: {}",
7970 warm_a.len()
7971 );
7972
7973 // Push B: a second linear history chained ONTO A's tip, so B's tip
7974 // closes over A too. This is a fold that genuinely grows the graph.
7975 let (pack_b, commits_b) = linear_history_pack_from(40, Some(&tip_a));
7976 store.put_pack(&pack_b).unwrap();
7977 store.wait_indexed();
7978 let tip_b = commits_b.last().unwrap().clone();
7979 let warm_b_full = store.reachable(&[&tip_b], &[]).unwrap();
7980 let warm_b_minus_a = store.reachable(&[&tip_b], &[&tip_a]).unwrap();
7981 assert!(
7982 warm_b_full.len() > warm_a.len(),
7983 "the push did not grow the closure ({} !> {}), so the memo could be \
7984 stale and this test would not know",
7985 warm_b_full.len(),
7986 warm_a.len()
7987 );
7988
7989 // The cold oracle: a fresh handle on the same bytes, folded from disk.
7990 drop(store);
7991 let cold = GitStore::open(&dir, "rickard").unwrap();
7992 cold.wait_indexed();
7993 let cold_b_full = cold.reachable(&[&tip_b], &[]).unwrap();
7994 let cold_b_minus_a = cold.reachable(&[&tip_b], &[&tip_a]).unwrap();
7995
7996 assert_eq!(
7997 warm_b_full, cold_b_full,
7998 "warm memo != cold fold for want=tip_b (a memo that survived the push)"
7999 );
8000 assert_eq!(
8001 warm_b_minus_a, cold_b_minus_a,
8002 "warm memo != cold fold for want=tip_b have=tip_a"
8003 );
8004 // tip_a is still answered identically after the push (its closure did
8005 // not change; only the store grew around it).
8006 let cold_a = cold.reachable(&[&tip_a], &[]).unwrap();
8007 assert_eq!(
8008 warm_a, cold_a,
8009 "tip_a's closure changed across the push"
8010 );
8011 eprintln!(
8012 "load {}; A closure {}, B closure {}, B−A {}",
8013 loadavg(),
8014 warm_a.len(),
8015 warm_b_full.len(),
8016 warm_b_minus_a.len(),
8017 );
8018 }
8019
8020 /// **The clone-after-push lever, witnessed.** A push folds; the fold used
8021 /// to drop the reachability table and the next reader rebuilt it by
8022 /// walking every commit's trees — 0.2 ms per object, 10 s on a 51k-object
8023 /// repository, measured 2026-09-05. Now the fold CARRIES the table
8024 /// (renumbered) when the graph grew by no more than the carry rule allows.
8025 /// RED before the carry: `reach_rebuilt` went 1 → 2 across the push.
8026 #[test]
8027 fn a_push_carries_the_reach_table_across_the_fold() {
8028 let dir = tmpdir("reach-carry-across-push");
8029 let (pack_a, commits_a) = linear_history_pack_from(40, None);
8030 let store = GitStore::open(&dir, "rickard").unwrap();
8031 store.put_pack(&pack_a).unwrap();
8032 store.wait_indexed();
8033 let tip_a = commits_a.last().unwrap().clone();
8034 let warm_a = store.reachable(&[&tip_a], &[]).unwrap();
8035 assert_eq!(store.reach_source_stats(), (0, 1), "the first read builds the table once");
8036
8037 // A push of 30 commits onto A's tip: within the carry rule (64 or a
8038 // tenth of 40, whichever is larger), so the fold carries.
8039 let (pack_b, commits_b) = linear_history_pack_from(30, Some(&tip_a));
8040 store.put_pack(&pack_b).unwrap();
8041 store.wait_indexed();
8042 let tip_b = commits_b.last().unwrap().clone();
8043 let warm_b = store.reachable(&[&tip_b], &[]).unwrap();
8044 let warm_b_minus_a = store.reachable(&[&tip_b], &[&tip_a]).unwrap();
8045 assert_eq!(
8046 store.reach_source_stats(),
8047 (1, 1),
8048 "the fold carried the table; no read rebuilt it"
8049 );
8050 assert!(warm_b.len() > warm_a.len(), "the push grew the closure");
8051 assert_eq!(warm_b_minus_a.len(), warm_b.len() - warm_a.len(), "tip_b − tip_a is exactly the pushed objects");
8052 assert_eq!(store.reachable(&[&tip_a], &[]).unwrap(), warm_a, "tip_a's closure survived the renumbering");
8053
8054 // The cold oracle: the same bytes folded from disk with a fresh table.
8055 drop(store);
8056 let cold = GitStore::open(&dir, "rickard").unwrap();
8057 cold.wait_indexed();
8058 assert_eq!(cold.reachable(&[&tip_b], &[]).unwrap(), warm_b, "carried != rebuilt for want=tip_b");
8059 assert_eq!(
8060 cold.reachable(&[&tip_b], &[&tip_a]).unwrap(),
8061 warm_b_minus_a,
8062 "carried != rebuilt for want=tip_b have=tip_a"
8063 );
8064 assert_eq!(cold.reach_source_stats(), (0, 1), "the cold handle built once and carried nothing");
8065 }
8066
8067 /// The carry rule's other arm: a push larger than the allowance drops the
8068 /// table and the next read rebuilds it whole — bounded staleness, never a
8069 /// walk that grows without limit.
8070 #[test]
8071 fn a_push_past_the_carry_allowance_rebuilds_the_reach_table() {
8072 let dir = tmpdir("reach-carry-rebuild");
8073 let (pack_a, commits_a) = linear_history_pack_from(20, None);
8074 let store = GitStore::open(&dir, "rickard").unwrap();
8075 store.put_pack(&pack_a).unwrap();
8076 store.wait_indexed();
8077 let tip_a = commits_a.last().unwrap().clone();
8078 let _ = store.reachable(&[&tip_a], &[]).unwrap();
8079 assert_eq!(store.reach_source_stats(), (0, 1));
8080 // 100 commits > max(64, 20/10): over the allowance.
8081 let (pack_b, commits_b) = linear_history_pack_from(100, Some(&tip_a));
8082 store.put_pack(&pack_b).unwrap();
8083 store.wait_indexed();
8084 let tip_b = commits_b.last().unwrap().clone();
8085 let warm_b = store.reachable(&[&tip_b], &[]).unwrap();
8086 assert_eq!(store.reach_source_stats(), (0, 2), "over the allowance: not carried, rebuilt once more");
8087 drop(store);
8088 let cold = GitStore::open(&dir, "rickard").unwrap();
8089 cold.wait_indexed();
8090 assert_eq!(cold.reachable(&[&tip_b], &[]).unwrap(), warm_b, "rebuilt warm != cold fold");
8091 }
8092}