docs: formal spec + machine-checked proof for git refs over object storage (#721)

Signed-off-by: tlongwell-block <109685178+tlongwell-block@users.noreply.github.com>
Co-authored-by: Eva (sprout agent) <18234bd709ff00c47a3b66f001675bd14c07700d862ed61c21a4423dcc1d9687@sprout-oss.stage.blox.sqprod.co>
This commit is contained in:
tlongwell-block
2026-05-21 23:43:46 -04:00
committed by GitHub
co-authored by Eva
parent 504cfea20d
commit 3467a67b2a
3 changed files with 786 additions and 0 deletions
+520
View File
@@ -0,0 +1,520 @@
# Git Refs over Object Storage: A Formal Specification
`draft`
## Abstract
This document specifies a protocol for hosting git repositories on an object
store (S3 and S3-compatible backends such as MinIO) with **no persistent
filesystem**, and gives a formal proof of its safety properties. Repository
content is stored as create-only, content-addressed pack objects (immutable by
protocol discipline — see A1, not by assuming an immutable store); the current
state of every ref is captured by a single mutable *manifest pointer* updated
by atomic compare-and-swap (CAS). We prove two safety theorems —
**durability-ordering** (a client never observes success for a ref change that
is not yet durable) and **manifest reconstruction** (hydrating a published
manifest reconstructs every object reachable from its refs; the named pack set is
a superset of that closure) — and one
**linearizability** theorem (concurrent ref-changing pushes never lose an
update). All three reduce to three explicitly stated object-store axioms.
The protocol is not novel as an *algorithm*: it is git's post-reftable ref
model — immutable content artifacts plus an atomic pointer swap — with the
atomic primitive substituted from POSIX `rename()` to an S3 conditional `PUT`.
The contribution of this document is the **formal characterization**: to our
knowledge, no prior formal treatment of git refs over conditional-write object
storage exists (see Prior Art). The proof is *parametric over the atomic
primitive*: it holds for any backend satisfying the three axioms, and a concrete
backend is *admitted for deployment* by a single conformance gate (a finite probe
cannot prove a universal axiom; it can only admit or reject a backend).
## Scope and Non-Goals
This specification proves **safety** ("nothing bad happens"). It deliberately
does **not** prove:
- **Liveness or performance.** That a hydrate completes within a latency budget
is empirical, not formal; it is characterized by benchmark, not theorem.
- **Git's internal correctness.** `git index-pack`, `upload-pack`, and
`receive-pack` are trusted upstream components. We prove only that our
*composition* feeds them well-formed inputs and surfaces their outputs
faithfully.
- **The object-store axioms themselves.** S3's durability, read-after-write
consistency, and conditional-write linearizability are stated as axioms
(§Axioms); each backend is *admitted* per-deployment by an empirical conformance
gate (§Conformance), which rejects non-conforming backends — it does not prove
the axiom universally.
Stating this boundary is part of the claim. "Provably sound" without naming the
trust boundary does not survive scrutiny; "safety is machine-checkable relative
to three stated axioms, each empirically gated per backend" does.
## System Model
A **repository** `R` has the following state in the object store:
- A set `P_R` of **pack objects**. Each is *content-addressed* (its key is a
cryptographic digest of its bytes) and *treated as immutable by protocol*:
written create-only, so the same key is never overwritten, and verified by
digest on read (see A1 — this is protocol discipline, not an assumed store
property). Writing the same content twice is idempotent.
- A single **manifest pointer** `M_R`: a mutable object holding the digest (and
ETag) of the *current manifest*.
A **manifest** `m` is itself an immutable, content-addressed object containing:
- `m.packs` — the set of pack-object keys that constitute the repository.
- `m.refs` — a total map `refname ↦ object_id` (the published ref state).
We write `pointer(R) = (e, d)` for the current pointer state: `e` is the
object-store ETag of `M_R`, `d` is the manifest digest it holds. `manifest(d)`
denotes the (immutable) manifest object with digest `d`.
Two operations act on `R`:
- **Read(R)** — clone / fetch / ls-remote. Resolve `pointer(R) → d`, read
`manifest(d)`, download `m.packs`, reconstruct the object graph, serve the
requested refs.
- **Push(R, Δ)** — receive-pack. Δ is a set of requested ref updates
`refname ↦ (old_id, new_id)`.
**The manifest pointer is the sole source of truth.** In Sprout, a successful
push may also publish a relay event (kind:30618) so subscribers learn refs moved.
That event is a *derived notification*, never the commit point: a push has
happened iff `M_R` was CAS-swapped (A3), regardless of whether — or when — any
event is published. Relay events can lag, duplicate, or replay; subscribers must
treat them only as a signal to re-read `pointer(R)`, never as ref state. The
dangerous inversion — "the push succeeded because the event published" — would
substitute relay ordering for manifest ordering and reintroduce the lost-update
hole A3 closes. (This is a real behavioral obligation, not a restatement: today
the commit point is the local filesystem — `receive-pack` updating the bare repo,
with the relay event published best-effort afterward — so making manifest-CAS the
commit, with the event derived from it, is the change, not just a storage swap.
See §Implementation Correspondence.)
## Axioms
The protocol's safety is proved *relative to* the following properties of the
object store. Each is a documented property of AWS S3 (2024+) and a testable
assumption for any S3-compatible backend.
- **(A1) Durable write.** A `PUT` that returns success is durable. S3 does *not*
by itself make an object immutable — that is enforced by **protocol rule**, not
assumed of the store: pack and manifest objects use content-addressed keys and
are written create-only (`If-None-Match: *`), so a key is never overwritten,
and readers verify the object's bytes against its key digest. Any deviation is
therefore *detectable* (digest mismatch), not silent. (We do not rely on S3
Object Lock or bucket immutability policy; the create-only + content-address
discipline is sufficient and backend-portable.) **No deletion under the
protocol.** Pack and manifest objects are never deleted by the protocol. This
is what makes Read a consistent snapshot in the presence of concurrent writers:
a reader holding an old manifest digest can always GET every pack it names,
because no writer removes packs. Physical pruning of unreachable packs is a
*backend retention concern* outside this proof boundary; any such sweep must
honor in-flight readers (e.g. a retention window longer than the max hydrate
time), and proving that bound is future GC work, not part of the safety
argument here. (Without this rule, a GC that prunes packs a winning push
orphaned could 404 a concurrent reader mid-hydrate — see Theorem 2's reliance
on every named pack being GETtable.)
- **(A2) Strong read-after-write.** A read issued after a successful `PUT`
observes that write. (AWS S3 provides this for all regions and all
PUT/DELETE.)
- **(A3) Linearizable conditional write (CAS).** `PUT M_R If-Match: e` succeeds
iff the current ETag of `M_R` equals `e`; otherwise it fails with a
precondition error and does not modify `M_R`. Among any set of conditional
PUTs predicated on the same `e`, **at most one succeeds**, and all PUTs are
linearizable (there is a single total order consistent with observed
successes/failures). "Linearizable conditional write" is *our* formal term for
the axiom. The supporting AWS evidence: S3 documents `If-Match` as comparing the
supplied ETag against the current object ETag (match → `200`, mismatch → `412`)
and strong read-after-write consistency in all regions; the Nov 2024
conditional-update announcement states this offloads compare-and-swap to S3.
(`If-None-Match: *` for create-only PUT shipped Aug 2024.) AWS does not use the
word "linearizable" in the user guide — we treat the documented CAS + strong
consistency as evidence *for* the axiom, not as AWS asserting our term.
A3 is the single load-bearing backend assumption. It replaces the POSIX
`rename()` atomicity that reftable relies on. See §Conformance for how a backend
is *admitted* against it.
## Protocol
### Read
1. Resolve `pointer(R) = (e, d)`.
2. Fetch `manifest(d)`; let `m = manifest(d)`.
3. For each key in `m.packs`, GET the pack object (A2 guarantees visibility;
content-addressing lets the reader verify each, given A1).
4. Hydrate a bare repository from the packs; serve refs from `m.refs`.
Read takes no locks and never writes. It observes a single committed manifest
`d` and is therefore a consistent snapshot by construction, even under concurrent
writers, because: (i) `manifest(d)` and the packs it names are immutable
[A1 + content-addressing], so a writer that advances the pointer past `d` cannot
alter what `d` resolves to; and (ii) **no pack `d` names is ever deleted**
[A1, no-deletion rule] and every named pack was durably written before `d` was
published [A1 + A2, §Push step order], so a reader holding an older `d` can always
GET every pack — a concurrent GC that prunes packs unreachable from the *new*
pointer never 404s this reader. This read-consistency-during-writer property is the
reason the no-deletion rule is load-bearing, not cosmetic; it is asserted in the
prose here because the mechanized model has no Read action (it checks the writer
side; this is the reader-side complement).
### Push
```
1. receive-pack: accept the pack, index it, derive new object set O.
2. for each o in O: PUT pack-object(o) # content-addressed, idempotent (A1)
3. (e, d_before) := pointer(R); m_before := manifest(d_before)
4. validate Δ against m_before.refs # fast-forward / push rules
on rejection -> respond non-ff, STOP (no write, no fence cost)
5. m_after := m_before with refs updated per Δ; packs := m_before.packs keys(O)
6. d_after := PUT manifest-object(m_after) # content-addressed (A1)
7. result := PUT M_R (value = d_after) # CAS (A3)
If-Match: e if a pointer already exists (e from step 3)
If-None-Match: * if the repo has no pointer yet (first push / repo init)
on 412 (lost race): re-read pointer, GOTO 3 (retry) or respond non-ff
on success: the ref change is PUBLISHED
8. construct success response # ONLY after step 7 succeeds -- the FENCE
```
**The fence (step 8 after step 7).** The success response is not constructed
until the CAS in step 7 returns success. This is the publish-ordering
guarantee. It is *conditional on refs changing*: a no-op or rejected push
(step 4) never reaches step 7 and pays zero CAS/fence latency.
**No advisory lock.** Reftable serializes writers with `tables.list.lock` *and*
the rename. This protocol has **no advisory lock in v1**: writer serialization
is provided entirely by the CAS in step 7. §Theorem 3 proves this is
sufficient — the lock reftable uses is an optimization (it avoids wasted work
under contention), not a correctness requirement, *given A3*.
**Retry is policy, not safety.** The "GOTO 3" loop on a 412 is a *liveness/policy*
choice — retry count, backoff, or immediate non-ff rejection are all sound. Safety
(Theorems 13) holds for any of them, because a losing push that retries simply
re-runs steps 37 against the advanced pointer; it never writes `M_R` while
predicated on a stale ETag. We deliberately make no liveness claim here (§Scope).
## Safety Theorems
Let a push `p` be **ref-changing** if it reaches step 7. Let `observe(p) =
success` mean a client received `p`'s success response (step 8 executed).
### Theorem 1 (Durability-Ordering)
> If `observe(p) = success` for a ref-changing push `p`, then at the moment of
> observation, `pointer(R)` has held a value `d_after` whose manifest reflects
> `p`'s ref updates, and that manifest and all packs it names are durable.
**Proof.** Step 8 executes only after step 7 returns success (program order;
enforced by type in the implementation — see §Implementation Correspondence).
By A3, step 7's success means `M_R` was atomically set to `d_after`. By A1,
`manifest(d_after)` (written step 6) and every pack in `O` (written step 2,
before step 6) are durable. The fence orders the client-visible success strictly
after the durable pointer swap. Therefore observation implies durability. ∎
*Pointer integrity:* the pointer object holds a manifest *digest*, not inline
state. A1+A2 mean a successful pointer write is durable and read-after-write
consistent; a bit-flip in the stored digest yields a value that resolves to no
manifest (or a digest-mismatched one), so Read fails *closed* (error, not a
wrong-but-plausible history). The protocol never trusts an unresolvable or
mismatched pointer.
Corollary (crash safety): if the process crashes between any two steps, no
client has observed success unless step 7 completed; an incomplete push leaves
orphan packs and an unchanged pointer — wasted bytes, never a visible-but-lost
ref change.
### Theorem 2 (Manifest Reconstruction)
> Read(R) resolving to manifest digest `d` can reconstruct, in full, the object
> graph reachable from every ref in `manifest(d).refs` — no reachable object is
> missing. (The named pack set is a *superset* of that reachable closure; see
> the remark on force-push/delete below.)
**Proof.** By the push order, `d` is published (step 7) only after all packs in
`manifest(d).packs` are durably written (step 2, before step 6). By A2 a reader
that resolves `d` (step 1) can GET every pack in `manifest(d).packs` (step 3).
By A1 + content-addressing, each pack's bytes are exactly those written, and any
deviation is detected by digest. Git's `index-pack` over a complete, verified
pack set reconstructs the object graph (trusted upstream, §Non-Goals; reproducible
against a pinned minimum `git` ≥ 2.31, the first release with `git index-pack
--fsck-objects` defaults relied on here). It remains
to show `manifest(d).packs` *covers* the reachable closure of `m.refs`. By
induction on the push chain: the empty repo's manifest names ∅ and refs ∅
(covered vacuously). Step 5 sets `m_after.packs = m_before.packs keys(O)` where
`O` is every object this push introduced; and `m_after.refs` only points at
objects in `m_before.refs`' closure (unchanged or deleted refs) or in `O` (new or
force-moved refs). So every object reachable from `m_after.refs` is in
`m_before.packs` (covered by IH) or in `keys(O)` — hence in `m_after.packs`. ∎
**Remark (force-push, delete, and GC).** Coverage is a *superset*, not equality,
and that is the correct invariant. A delete-ref drops a key from `m.refs`; a
force-push repoints a ref off its old history. Neither removes packs from
`m.packs`, so objects reachable only from the old/deleted ref become unreachable
but remain named. This is safe — reconstruction of the *current* refs is
unaffected — but it means `m.packs` grows monotonically under the protocol as
specified. Garbage collection (computing reachability from `m.refs` and
publishing a manifest with a pruned pack set) is a separate, *also CAS-guarded*
operation: it is just another `Push` whose `m_after` happens to name fewer packs,
so Theorems 1 and 3 apply to it unchanged. GC correctness (that it never prunes a
reachable pack) is an obligation on the GC's reachability computation, out of
scope here and called out as future work.
### Theorem 3 (Linearizable Refs / No Lost Update)
> If two ref-changing pushes `p₁`, `p₂` execute concurrently, the published
> history of `M_R` contains both effects in some serial order, or rejects one;
> neither silently overwrites the other.
**Proof.** Both read the pointer (step 3) and CAS predicated on the ETag they
read (step 7). Suppose both read ETag `e`. By A3 at most one CAS predicated on
`e` succeeds; WLOG `p₁` succeeds, `M_R` advances to `e`. `p₂`'s CAS predicated
on `e` then fails (412): `p₂` re-reads (now `e`, `d_after(p₁)`), re-validates Δ
against `p₁`'s published refs (step 4), and either composes onto `p₁`'s state or
is rejected non-ff. `p₂` never writes `M_R` while predicated on the stale `e`.
By A3's linearizability, the successful CAS sequence is a single total order;
each push's `m_after` is computed from its immediate predecessor's published
state. Hence no update is lost and the published ref history is serial. The
absence of an advisory lock changes only *efficiency under contention* (a loser
may do wasted indexing before its 412), not correctness. ∎
The mechanized model makes "no update is lost" concrete in checked forms over
**real ref values**: the published manifests form a chain with no two sharing a
parent (`Inv_NoFork` — a shared parent *is* a lost update); an installed push's
committed ref value equals the value it proposed (`Inv_RefEffectApplied` — your
write is what lands); each install is derived from the pointer it actually read
(`Inv_RefDerivedFromParent` — never built on superseded state). Removing the CAS
guard makes the model fork; that is the precise sense in which A3 is load-bearing.
## Conformance (Admitting a Backend for A3)
A3 is the only axiom not guaranteed by the protocol itself; for AWS S3 it is
documented, for any other backend (MinIO, Ceph RGW, ...) it is an empirical
claim. A backend is **admitted** against it by a **conformance probe** run at
startup against the target backend. The probe is a **deployment admission gate**: a backend is
trusted only if it passes. Passing does *not* prove the universal axiom — a
finite probe yields operational confidence for *this backend, build, and
config*; failure invalidates the design against that backend, exactly as
non-atomic `rename()` would invalidate reftable.
The probe has both a sequential half (semantic correctness) and a concurrent
half (linearizability under contention). The concurrent half is the load-bearing
part — A3 is a claim about *races*, so a probe that only checks sequential
conditional writes cannot admit a backend against it.
1. **Sequential semantics.** create-if-absent succeeds; duplicate
`If-None-Match: *` fails; `If-Match: E` with current ETag succeeds; stale
`If-Match` fails; `If-Match` on a missing key does not create; read-after-write
returns the written value.
2. **N-way `If-Match` race (required).** Write key with body `base`; read its
ETag `E` via the *same code path production uses for the pointer*. Spawn N
(e.g. 3264) concurrent `PUT key If-Match: E` with unique bodies. **Pass** iff
exactly one succeeds, the other N1 classify as precondition-failed, a
subsequent read returns the winner's body and a new ETag, and the final body is
never one of the *failed* payloads. Repeat for R rounds (configurable; default
trades boot time against confidence).
3. **N-way `If-None-Match: *` race (required).** Same shape on a missing key:
exactly one create wins, N1 precondition failures, final body is the winner.
4. **ETag-token consistency.** Verify HEAD-path and GET-path ETag extraction
agree byte-for-byte (quoting included). `If-Match` compares tokens literally;
a quote mismatch between the read path and the write path silently tests the
wrong thing. The probe must use the exact token format the pointer write uses.
**Proof surface (explicit non-goals of the probe and the design).** The protocol
depends only on conditional writes of *small single objects* (the manifest
pointer). It does **not** depend on, and the probe does **not** test:
conditional *multipart* uploads (packs are content-addressed plain PUTs, staged
without conditionals) or conditional *delete* (GC uses retention/sweep over a
republished manifest, not `If-Match` delete). Keeping the proof surface to
single-object conditional PUT is what makes A3 both sufficient and cheaply
checkable.
If the probe passes, A3 is admitted for that backend and Theorems 13 transfer
unchanged.
## Prior Art
The *algorithm* is established; the *formal characterization* is, to our
knowledge, new.
- **JGit `DfsRefDatabase`** reduces backend ref consistency to two **per-ref**
CAS hooks, `compareAndPut(oldRef, newRef)` and `compareAndRemove(oldRef)`
(`org.eclipse.jgit/.../dfs/DfsRefDatabase.java`). This *is* the model "git
refs = CAS over ref state," spelled in Java — at per-ref granularity.
- **JGit/Google `reftable`** (`Documentation/technical/reftable.md`): immutable
reftable files plus a single mutable `tables.list` pointer swapped atomically
via `tables.list.lock` + POSIX `rename()`. Note this is *pointer*-granularity,
not the per-ref CAS of `DfsRefDatabase` — reftable CASes one stack pointer.
This protocol is the same shape: it substitutes an S3 conditional `PUT` for
reftable's `rename()` and (v1) omits the advisory lock. Our granularity is one
**repo manifest pointer** — the same single-pointer granularity as reftable,
not the per-ref granularity of `DfsRefDatabase`.
- **`awslabs/git-remote-s3`** uses per-ref lock objects via S3 conditional
writes (advisory lock substitute). **`mattn/git-remote-s3`** uses a
`latest.json` pointer with `If-Match`/`If-None-Match` optimistic locking —
closest to this design; advertises MinIO compatibility.
- **`johnny0917/jgit-aws`** stores packs in S3 but refs in DynamoDB
(`compareAndPut` → Dynamo conditional update), the canonical pre-2024 *punt*:
before S3 had conditional writes, the CAS-needing state went elsewhere. This
protocol is what becomes possible once S3 itself offers CAS.
- **Gitaly (GitLab)** supports only local Git storage for refs; it punts ref
consistency to the local filesystem and does not attempt object-store CAS.
- **arXiv:** no formal treatment of git refs over object storage found.
`arXiv:1904.06584` ("GoT: Git, but for Objects") is a git-*inspired*
replicated-object model, not a formalization of this problem.
## Implementation Correspondence
The fence (Theorem 1) maps to a single structural obligation on the
implementation, stated here as a requirement the code must meet for the proof to
transfer:
- **Unique constructor seam.** There must be exactly one path that builds a
*push* `Response`, and it is `finalize_push(PushContext) -> Response`. The
discriminator is the `PushContext`: only `finalize_push` consumes one, and a
push subprocess's output reaches a response only by being wrapped in a
`PushContext`. (The lower-level `build_git_response` helper that does the literal
`Body::from(stdout)` conversion is *shared* with the read paths — info_refs,
upload_pack — so it has two call sites; but those carry no `PushContext` and no
fence obligation, so push-side uniqueness is structural, not a property of the
body conversion itself. A reader auditing the code will see `build_git_response`
reached twice and should check the discriminator is `PushContext`, not the
conversion.) If any other path could build a push response without going through
`finalize_push`, the fence would be convention, not structure, and Theorem 1
would not hold. This is a checkable code property, verified by reviewers against
the actual seam (`finalize_push`).
- **Fallible snapshot.** Ref-state snapshots are `Result`, and the skip predicate
is `Ok(after) == Ok(before)`, never `after == before` over values that default
to equal on error. Any `Err` on either snapshot falls through to publish
("assume changed"). This closes the double-failure hole — two failed scans
comparing equal and bypassing the fence — and is exactly the `MustPublish ==
changes \/ snapErr` rule the model checks.
- **Conditional fence.** The fence engages only when refs changed; a no-op push
returns success without awaiting publish (the `SkipPublish` path). The
obligation is "publish-before-success *for ref-changing pushes*," not
unconditional publish.
Six decision tests pin every arm of the fence predicate (`should_publish`):
no-op skip, changed-refs publish, first-push-to-empty-repo publish, before-error
publish, after-error publish, and the load-bearing both-snapshots-fail publish.
Runtime *ordering* — publish completes before the `Response` is constructed — is
enforced by `finalize_push` being a single sequential async function (no detached
`tokio::spawn`), not by a test; a behavioral ordering test once a mockable publish
seam exists is named follow-up work.
**Current code status (verified provenance).** The seam *shape* exists in code as
of `quinn/transport-fence-typesplit` @ `17df7884` (`crates/sprout-relay/src/api/
git/transport.rs`), 198 relay tests green:
| Spec element | Code |
|---|---|
| `PackOutput { stdout: Vec<u8> }` | `:507` |
| `SnapshotError` | `:654` |
| `snapshot_refs -> Result<_, SnapshotError>` | `:671` |
| `PushContext { pack, refs_before, … }` | `:688` |
| `should_publish(before, after) -> bool` (pure, deny-by-default) | `:708` |
| `finalize_push(state, ctx) -> Response`**the seam** | `:730` |
| `build_git_response` (sole `Body::from(stdout)` site) | `:637` |
The push path reaches `build_git_response` *only* through `finalize_push`, which
consumes a `PushContext` — so the compiler enforces "no `PushContext` ⇒ no push
`Response`." (`build_git_response` is shared with read paths, but those carry no
`PushContext` and no fence obligation; push-side uniqueness is structural.) The
fallible-snapshot bite has a dedicated test, `should_publish_fires_when_both_
snapshots_error` — the exact double-failure hole, now structurally outside the
skip arm.
Two honest gaps remain, both named:
1. **`412 → 409` is future work.** Today `publish_ref_state` is a relay-DB insert
(`db.insert_event`, kind:30618), not an S3 pointer swap; its failure is logged.
The `if let Err(e)` arm in `finalize_push` (`:740`) is the plug point where the
S3 manifest-CAS evolution maps `412 → 409`. The spec describes that target; the
seam shape is real now, the S3 CAS is not yet.
2. **Runtime-ordering test deferred.** Six tests pin the publish *decision*; the
publish-before-response *ordering* is enforced by `finalize_push` being a single
sequential async fn (no `tokio::spawn`). A mockable-publish integration test is
the belt-and-suspenders follow-up.
## Mechanized Verification
The safety theorems are model-checked, not only argued in prose. The companion
TLA+ module `docs/spec/GitOnObjectStore.tla` models concurrent pushers racing to
advance the manifest pointer, with the CAS action (`If-Match`) as the sole
pointer writer — directly encoding axiom A3. Each push models a proposed ref
value (`newVal`, the objectId it wants `main` to hold) and whether its ref
snapshot reads succeed (`snapErr`); whether it *changes* refs is then **derived**
(`DidChange == newVal ≠ value-in-the-manifest-it-read`), not a free boolean. The
skip predicate is `MustPublish(p) == DidChange(p) \/ snapErr(p)` — "publish unless
we *observed* no change," never "publish unless `b == a`" with failed reads
compared equal.
Crucially the model carries the **real ref value** per manifest (`refs[m]` = the
objectId `main` holds in manifest `m`) and explicit **history** (`parent[m]`).
This is what lets the invariants prove ref-*update* linearizability — that *your*
ref write is what gets committed and survives — not merely pointer-id bookkeeping.
TLC checks eight invariants (a finiteness constraint, `BoundedManifests`, caps published manifests at `MaxManifests` so the retry loop terminates):
| Invariant | Theorem | Statement |
|---|---|---|
| `Inv_Fence` | T1 | an obligated push's manifest is published before success is observed |
| `Inv_ChangedPublished` | T1 | a ref-changing push is always published (fallible-snapshot bite) |
| `Inv_Closed` | T2 | a published manifest's pack set *covers* its published parent's |
| `Inv_NoFork` | T3 | no two published manifests share a parent (a fork = a lost update) |
| `Inv_RefEffectApplied` | T3 | an installed push's committed ref value equals the value it proposed |
| `Inv_RefDerivedFromParent` | T3 | an install is derived from the pointer it read (no build on superseded state) |
| `Inv_ParentPublished` | T2/T3 | every published manifest's parent is published (grounded history) |
| `Inv_PointerPublished` | T1 | the pointer always names a published manifest |
```
$ tlc GitOnObjectStore.tla -config GitOnObjectStore.cfg
Model checking completed. No error has been found.
1435102 states generated, 435745 distinct states found, 0 states left on queue.
```
**Every invariant is proven non-vacuous** by a mutation that trips it (each
checked in isolation against each mutant). This is the discipline that catches
"green but vacuous" specs:
| Mutation | Trips |
|---|---|
| skip predicate `DidChange /\ ~snapErr` (ref change + both snapshots fail → silently skipped) | `Inv_ChangedPublished` |
| `packs[m] = {m}` (manifest drops predecessor's packs) | `Inv_Closed` |
| drop CAS guard (two pushers install off one parent — a fork) | `Inv_NoFork` |
| install records the *read* ref value, not the push's proposal (effect dropped) | `Inv_RefEffectApplied` |
| record parent as root instead of the pointer actually read | `Inv_RefDerivedFromParent` (+ `Inv_NoFork`) |
The `packs[m]={m}` and CAS-guard mutations are exactly the two vacuity tests an
external reviewer ran against an earlier draft, where the then-invariants passed
unchanged; the history + real-ref-value vocabulary is what makes them fail now.
The ref-value mutations (effect-dropped, wrong-parent) are what close the gap from
"pointer CAS serializes" to "ref *updates* are linearizable" — the user-visible
theorem the title promises. (A weaker mutation, `MustPublish == DidChange` alone,
does *not* break safety — it over-publishes, safe-but-wasteful; noted so the
mutation set is honest about which mutations are true safety regressions.
`Inv_ChangedPublished` and `Inv_Fence` look redundant but are not: see the .tla
comment — mutating the `MustPublish` operator weakens `Inv_Fence`'s own predicate,
so the `DidChange`-predicated `Inv_ChangedPublished` is the one that stays
load-bearing under exactly that mutation.)
The model is checked at `Pushers = {p1,p2,p3}`, `MaxManifests = 3`, under the
`BoundedManifests` constraint (`|published| ≤ MaxManifests`) — required because
the retry loop otherwise lets pushers churn fresh manifest ids and ref values
without bound, so the model is *finite-state only with the bound*. Three
concurrent pushers exercise every CAS race relevant to these invariants (a fourth
adds no qualitatively new interleaving); the real-ref-value domain is what makes
even three a ~436K-state check. This is a *bounded* model check, not an unbounded
proof: it exhaustively verifies the invariants within the bound and is mutation-
shown non-vacuous, which is the standard claim for a TLC-checked safety spec.
## Summary
| Property | Status | Discharged by |
|---|---|---|
| Durability-ordering (T1) | Proved | Fence + A1, A2 |
| Manifest reconstruction (T2) | Proved | Content-addressing + A1, A2; git upstream |
| No lost update (T3) | Proved | A3 (no advisory lock needed) |
| A1/A2/A3 hold on backend | Empirical | Conformance probe (gate) |
| Liveness / latency | Empirical | Benchmark (out of scope) |
+10
View File
@@ -0,0 +1,10 @@
\* TLC model-check config for GitOnObjectStore.
\* Run: tlc GitOnObjectStore.tla -config GitOnObjectStore.cfg
SPECIFICATION Spec
CONSTANTS
Pushers = {p1, p2, p3}
MaxManifests = 3
INVARIANT Safety
CONSTRAINT BoundedManifests
+256
View File
@@ -0,0 +1,256 @@
-------------------------- MODULE GitOnObjectStore --------------------------
(***************************************************************************)
(* Formal model of git refs over object storage, accompanying *)
(* docs/git-on-object-storage.md. Model-checks the three safety *)
(* properties under the conditional-write (CAS) axiom A3 by construction: *)
(* the PUT/If-Match action is the only writer of the pointer and is atomic *)
(* per step (TLC interleaves at action granularity), modeling A3 directly. *)
(* *)
(* Pushers race to advance a single manifest pointer holding a ref value. *)
(* We assert (see SAFETY PROPERTIES for the full set and per-invariant docs):*)
(* T1 fence: observed success => the obligated push is durably published *)
(* T2 closure: a published manifest's pack set covers its parent's *)
(* T3 ref linearizability: installs form a fork-free chain, each commits *)
(* exactly the value it proposed, derived from the pointer it read *)
(* Each invariant is mutation-tested non-vacuous; see docs/ Mechanized §. *)
(***************************************************************************)
EXTENDS Naturals, FiniteSets, Sequences
CONSTANTS Pushers, \* set of concurrent pusher ids
MaxManifests \* bound on distinct manifests (model finiteness)
VARIABLES
pointer, \* current manifest id held by M_R (a natural; 0 = empty repo)
published, \* set of manifest ids ever installed as pointer (durable history)
packs, \* function: manifest id -> set of pack ids it names
pc, \* pusher id -> control state
readEtag, \* pusher id -> pointer value it last read (its CAS precondition)
staged, \* pusher id -> manifest id it intends to install
parent, \* manifest id -> the manifest id it was derived from (history)
refs, \* manifest id -> objectId that this manifest binds the ref "main" to
newVal, \* pusher id -> objectId this push proposes for "main" (its effect)
snapErr, \* pusher id -> did either ref-snapshot read fail? (BOOLEAN)
observed \* set of pusher ids that have observed success (fence passed)
vars == <<pointer, published, packs, pc, readEtag, staged,
parent, refs, newVal, snapErr, observed>>
\* We model a single ref, "main", whose value is an objectId in ObjIds. This is
\* enough to exhibit ref-update linearizability: a lost update is the published
\* value of "main" reverting or skipping a committed predecessor's value.
\* (Dawn's point: prove ref VALUES survive, not just that effect tokens are
\* monotone.) refs[m] is the value "main" holds in manifest m.
ObjIds == 0..MaxManifests
\* A push CHANGES refs iff the value it proposes differs from the value in the
\* manifest it READ. This is now DERIVED from real ref state, not a free boolean.
DidChange(p) == newVal[p] # refs[readEtag[p]]
ManifestIds == 0..MaxManifests
TypeOK ==
/\ pointer \in ManifestIds
/\ published \subseteq ManifestIds
/\ packs \in [ManifestIds -> SUBSET ManifestIds]
/\ pc \in [Pushers -> {"idle","staged","done","lost"}]
/\ readEtag \in [Pushers -> ManifestIds]
/\ staged \in [Pushers -> ManifestIds]
/\ parent \in [ManifestIds -> ManifestIds]
/\ refs \in [ManifestIds -> ObjIds]
/\ newVal \in [Pushers -> ObjIds]
/\ snapErr \in [Pushers -> BOOLEAN]
/\ observed \subseteq Pushers
Init ==
/\ pointer = 0
/\ published = {0}
/\ packs = [m \in ManifestIds |-> {}]
/\ pc = [p \in Pushers |-> "idle"]
/\ readEtag = [p \in Pushers |-> 0]
/\ staged = [p \in Pushers |-> 0]
/\ parent = [m \in ManifestIds |-> 0]
/\ refs = [m \in ManifestIds |-> 0] \* "main" starts at objectId 0 (empty)
/\ newVal = [p \in Pushers |-> 0]
/\ snapErr = [p \in Pushers |-> FALSE]
/\ observed = {}
\* A fresh manifest id, distinct from every published manifest AND every
\* concurrently-staged one (Perci): distinct pushes mint distinct content-addressed
\* manifests, so two concurrent stages never alias the same id. This keeps the
\* no-lost-update counterexamples about CAS serialization, not id collision.
StagedIds == { staged[q] : q \in Pushers }
FreshId == CHOOSE m \in ManifestIds : m \notin published /\ m \notin StagedIds /\ m # 0
CanStage == \E m \in ManifestIds : m \notin published /\ m \notin StagedIds /\ m # 0
\* The publish-skip decision (the fallible-snapshot fence, Quinn #2 / Dawn's case).
\* A push skips publish ONLY if its snapshots succeeded AND showed no ref change.
\* If either snapshot errored (snapErr), it must NOT skip -- it falls through to CAS.
\* This is "Ok(b) = Ok(a)", never "b = a" with errors silently equal.
MustPublish(p) == DidChange(p) \/ snapErr[p]
\* Steps 3-6: read pointer; nondeterministically this push either changes refs or
\* is a no-op, and its ref-snapshot reads either succeed or fail. Stage a manifest.
Begin(p) ==
/\ pc[p] = "idle"
/\ CanStage
\* This push proposes some value v for "main" (v = current value models a
\* no-op push; v # current models a real ref change); its snapshot reads may
\* fail (e). The staged manifest binds "main" to v and is derived from the
\* manifest the push READ -- so a stale reader builds on stale ref state, and
\* only the CAS guard stops it from clobbering a newer published value.
/\ \E v \in ObjIds, e \in BOOLEAN :
/\ newVal' = [newVal EXCEPT ![p] = v]
/\ snapErr' = [snapErr EXCEPT ![p] = e]
/\ LET m == FreshId IN
/\ readEtag' = [readEtag EXCEPT ![p] = pointer]
/\ staged' = [staged EXCEPT ![p] = m]
/\ parent' = [parent EXCEPT ![m] = pointer]
/\ packs' = [packs EXCEPT ![m] = packs[pointer] \union {m}]
/\ refs' = [refs EXCEPT ![m] = v]
/\ pc' = [pc EXCEPT ![p] = "staged"]
/\ UNCHANGED <<pointer, published, observed>>
\* No-op fast path: a push that must NOT publish (no change, snapshots ok) goes
\* straight to done WITHOUT touching the pointer -- zero CAS/publish latency.
SkipPublish(p) ==
/\ pc[p] = "staged"
/\ ~MustPublish(p)
/\ pc' = [pc EXCEPT ![p] = "done"]
/\ UNCHANGED <<pointer, published, packs, readEtag, staged, parent, refs, newVal, snapErr, observed>>
\* Step 7: CAS. Succeeds iff pointer still equals the etag this pusher read (A3).
CasSucceed(p) ==
/\ pc[p] = "staged"
/\ MustPublish(p)
/\ pointer = readEtag[p]
/\ pointer' = staged[p]
/\ published' = published \union {staged[p]}
/\ pc' = [pc EXCEPT ![p] = "done"]
/\ UNCHANGED <<packs, readEtag, staged, parent, refs, newVal, snapErr, observed>>
CasFail(p) ==
/\ pc[p] = "staged"
/\ MustPublish(p)
/\ pointer # readEtag[p]
/\ pc' = [pc EXCEPT ![p] = "lost"] \* will retry from idle
/\ UNCHANGED <<pointer, published, packs, readEtag, staged, parent, refs, newVal, snapErr, observed>>
\* Step 8: the fence. Observe success ONLY after the push reached "done"
\* (either via successful CAS or a legitimate skip).
Observe(p) ==
/\ pc[p] = "done"
/\ observed' = observed \union {p}
/\ UNCHANGED <<pointer, published, packs, pc, readEtag, staged, parent, refs, newVal, snapErr>>
\* A loser retries: back to idle, ready to re-read the advanced pointer.
Retry(p) ==
/\ pc[p] = "lost"
/\ pc' = [pc EXCEPT ![p] = "idle"]
/\ UNCHANGED <<pointer, published, packs, readEtag, staged, parent, refs, newVal, snapErr, observed>>
Next ==
\E p \in Pushers :
Begin(p) \/ SkipPublish(p) \/ CasSucceed(p) \/ CasFail(p)
\/ Observe(p) \/ Retry(p)
Spec == Init /\ [][Next]_vars /\ WF_vars(Next)
------------------------------------------------------------------------------
\* SAFETY PROPERTIES
\* T1 (Durability-Ordering): any observed push that was obligated to publish
\* (it changed refs, or its snapshot reads errored) has its staged manifest in
\* the durable published history before the client observes success. A
\* legitimately-skipped no-op push (no change, snapshots ok) is exempt -- it
\* publishes nothing and is correct to do so.
Inv_Fence ==
\A p \in observed : MustPublish(p) => staged[p] \in published
\* The bite for the fallible-snapshot case (Quinn #2 / Dawn): if a push actually
\* changed refs and was observed, its change is durably published -- regardless of
\* snapshot outcome. This is what breaks if SkipPublish ignores snapErr (i.e. if
\* the skip predicate were "b = a" instead of "Ok(b) = Ok(a) /\ no change").
\*
\* NOTE (Dawn): this is NOT redundant with Inv_Fence, even though
\* MustPublish == DidChange \/ snapErr makes Inv_Fence look strictly stronger.
\* Inv_Fence is predicated on the OPERATOR MustPublish; mutate that operator (the
\* skip-on-error bug) and Inv_Fence's own predicate moves with it, so the mutated
\* Inv_Fence stops catching the bug. Inv_ChangedPublished is predicated on
\* DidChange directly, independent of MustPublish, so it stays load-bearing under
\* exactly the mutation we care about. Do not delete it as "redundant."
Inv_ChangedPublished ==
\A p \in observed : DidChange(p) => staged[p] \in published
Installed(p) == (p \in observed) /\ MustPublish(p) /\ (staged[p] \in published)
\* (A former Inv_NoLost -- "distinct installs never share a manifest id" -- was
\* removed: with FreshId excluding in-flight staged ids, Inv_NoFork implies it, so
\* it caught only a model aliasing artifact, not a real failure mode. Verified by
\* checking that no mutation trips it without also tripping Inv_NoFork.)
\* T3b (Ref-update linearizability -- Dawn's user-visible theorem): the model
\* now carries the REAL ref value (refs[m] = the objectId "main" holds in manifest
\* m), not just effect tokens. Two properties bind the proof to ref VALUES:
\*
\* (i) Every installed push's own proposed value is exactly what its manifest
\* commits -- the push's effect is applied, not dropped.
Inv_RefEffectApplied ==
\A p \in Pushers : Installed(p) => (refs[staged[p]] = newVal[p])
\* (ii) An installed push computed its new value from the manifest that was the
\* pointer AT INSTALL TIME (its parent is the pointer it read, and the CAS
\* guard forced read == current). So no install builds "main" on top of a
\* value that a concurrent winner already superseded -- the lost-update of a
\* ref value. Operationally: an installed manifest's parent is published and
\* its value was derived from that parent, giving a single serial line of ref
\* values. (The fork ban, Inv_NoFork, plus this, is ref linearizability.)
Inv_RefDerivedFromParent ==
\A p \in Pushers :
Installed(p) => (parent[staged[p]] = readEtag[p] /\ readEtag[p] \in published)
\* T2 (Reconstruction coverage -- non-vacuous): every published non-root manifest
\* names a pack set that COVERS its published parent's pack set plus its own pack.
\* Perci's mutation (packs[m] = {m} instead of packs[parent] U {m}) breaks this,
\* because then packs[parent[m]] is not a subset of packs[m].
Inv_Closed ==
\A m \in published :
(m # 0 /\ parent[m] \in published) =>
(packs[parent[m]] \subseteq packs[m] /\ m \in packs[m])
\* Parent integrity: every published non-root manifest's parent is also published
\* (the install chain is grounded in durable history, never in vapor).
Inv_ParentPublished ==
\A m \in published : (m = 0) \/ (parent[m] \in published)
\* The pointer is always itself a published manifest (never points at vapor).
Inv_PointerPublished ==
pointer \in published
\* T3c (Linear history -- the real no-lost-update): the published manifests form
\* a single chain ending at the current pointer; there is no fork. A lost update
\* is precisely a fork: two installs sharing a parent, so one's effects are
\* dropped from the surviving line. Reachability of every published manifest from
\* the pointer via parent edges rules that out. With MaxManifests bound, we check
\* the contrapositive directly: no two distinct published non-root manifests share
\* a parent (a shared parent = a fork = a lost update). The A3 CAS guard is what
\* makes this hold; removing it lets two pushers install off the same parent.
Inv_NoFork ==
\A m1, m2 \in published :
(m1 # m2 /\ m1 # 0 /\ m2 # 0) => (parent[m1] # parent[m2])
\* Finiteness bound: at most MaxManifests distinct manifests may be published.
\* Without it the Retry loop lets pushers churn newVal/FreshId unboundedly.
BoundedManifests == Cardinality(published) <= MaxManifests
Safety ==
/\ TypeOK
/\ Inv_Fence
/\ Inv_ChangedPublished
/\ Inv_RefEffectApplied
/\ Inv_RefDerivedFromParent
/\ Inv_NoFork
/\ Inv_Closed
/\ Inv_ParentPublished
/\ Inv_PointerPublished
=============================================================================