quiver-tools 0.1.0__tar.gz

quiver_tools-0.1.0/.gitignore

@@ -0,0 +1,19 @@
+__pycache__/
+*.pyc
+quiver/exec/quiver-exec
+quiver/exec/bvm
+quiver/exec/ipc_gen.h
+*.wal
+*.wal.done
+dist/
+*.egg-info/
+
+# chat logs / scratch
+.claude/
+
+# large data archives (never commit)
+*.tar.zstd
+*.tar.zst
+
+# static deps for bvm, built by quiver/exec/build-deps.sh
+quiver/exec/deps/

quiver_tools-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

quiver_tools-0.1.0/NOTICE

@@ -0,0 +1,13 @@
+quiver
+Copyright (c) 2026 quiver contributors
+
+This product includes software developed at Hume AI (wsds/pupyarrow,
+ducl/pwalk2 worker model).
+
+pupyarrow/fb.py contains a builder algorithm ported from
+google/flatbuffers (https://github.com/google/flatbuffers),
+licensed under the Apache License, Version 2.0.
+
+quiver/exec/md5.c and md5.h are Alexander Peslyak's (Solar Designer)
+OpenSSL-compatible MD5 implementation, placed in the public domain:
+https://openwall.info/wiki/people/solar/software/public-domain-source-code/md5

quiver_tools-0.1.0/PKG-INFO

@@ -0,0 +1,127 @@
+Metadata-Version: 2.5
+Name: quiver-tools
+Version: 0.1.0
+Summary: Set-at-a-time Unix file tools on io_uring, Polars, and Arrow; nock self-indexing archives
+Project-URL: Homepage, https://github.com/jpc/quiver
+Project-URL: Source, https://github.com/jpc/quiver
+License-Expression: Apache-2.0
+License-File: LICENSE
+License-File: NOTICE
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: C
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: System :: Archiving
+Classifier: Topic :: System :: Filesystems
+Requires-Python: >=3.10
+Requires-Dist: blake3>=0.4
+Requires-Dist: numpy>=1.26
+Requires-Dist: polars>=1.0
+Requires-Dist: zstandard>=0.22
+Provides-Extra: dev
+Requires-Dist: flatbuffers; extra == 'dev'
+Requires-Dist: pyarrow; extra == 'dev'
+Requires-Dist: pytest; extra == 'dev'
+Provides-Extra: s3
+Requires-Dist: boto3; extra == 's3'
+Description-Content-Type: text/markdown
+
+# quiver & nock
+
+**quiver** — Unix file tooling rebuilt set-at-a-time: `scan`, `cp`, `rm`,
+`du`, `sync`, `pack`. One relational planner (Polars), swappable
+execution engines (io_uring / sync), Arrow record batches as the only
+interchange.
+
+**nock** — the index format: an Arrow IPC table of members parked in the
+trailing slack of a host container (tar, raw, or Arrow IPC), making any
+shard listable in one read and extractable by predicate.
+
+Built for high-latency parallel filesystems (WEKA-class) and object
+stores, where round-trips dominate and batching wins. On a warm local
+fs, coreutils will beat it — that's expected and honest.
+
+## Install
+
+```bash
+pip install quiver-tools          # Linux x86_64 / aarch64 wheels, glibc >= 2.28; import name is `quiver`
+```
+
+The wheel ships the `bvm` executor prebuilt (static zstd, libsodium, liburing, BLAKE3).
+io_uring paths need a reasonably recent kernel; everything falls back to sync I/O otherwise.
+
+From a checkout, build the executor once (pinned dependency sources, ~1-2 minutes), then
+install editable; `pip install -e` leaves the in-tree `bvm` alone, `make` owns it:
+
+```bash
+quiver/exec/build-deps.sh && make -C quiver/exec bvm   # or: make -C quiver/exec bvm DEPS=/prefix/with/static/libs
+pip install -e ".[dev]"
+```
+
+## The one idea
+
+```
+   producers                planner                  executors
+┌──────────────┐   ┌───────────────────────┐   ┌──────────────────┐
+│ fs scan (C,  │   │ Polars: join, delta,  │   │ fs exec (C,      │
+│ io_uring)    │──▶│ cum_sum layout, epoch │──▶│ io_uring chains) │
+│ nock footers │   │ assignment, header    │   │ s3 exec (boto3)  │
+│ S3 listing   │   │ packing — all exprs   │   │ ssh remote exec  │
+└──────────────┘   └───────────────────────┘   └──────────────────┘
+```
+
+Every tool is a query over stat frames that emits command frames.
+`sync` is the general tool; `cp` is sync into an empty destination,
+`rm` is sync from an empty source. tar headers are generated as Polars
+expressions (byte-compatible with GNU tar, PAX included). Archives
+carry their own index; retrofitting existing WebDataset tar shards or
+Arrow shards touches zero payload bytes.
+
+## Highlights
+
+- **Zero-dependency runtime**: polars + numpy. pyarrow and flatbuffers
+  are test-suite oracles only — `pupyarrow/` (vendored fork of
+  [wsds](https://github.com/HumeAI/wsds)'s reader) gained a writer and
+  a hand-rolled flatbuffers subset (`fb.py`, 12.6× faster metadata
+  walks than generated accessors).
+- **One C binary** (`quiver-exec`): io_uring scanner (pwalk2 worker
+  model) + executor (linked SQE chains, refcount forest scheduler,
+  direct descriptors) + hashing (part-parallel MD5 composite ETags,
+  slice-by-8 CRC-64/NVME with GF(2) combine).
+- **Predicate pushdown into the scanner**: path prefixes prune whole
+  subtrees (no getdents), basename globs skip statx for known-regular
+  misses.
+- **Pipelined execution**: `quiver.stream` runs the executor while the
+  scan is still going; monotone plans overlap, pipeline breakers
+  (rmdir, joins, sorts) drain as a tail.
+- **WAL / resume**: the command frame *is* the write-ahead log; crash
+  anywhere, rerun the WAL — completed rows skip, failed rows retry.
+- **ssh mode**: `ssh host quiver-exec` driven verbatim; changed
+  payloads ride inside the protocol as inline chunk chains; `verify`
+  sends only u64 hashes across the wire.
+- **S3 sync**: content-addressed via listed ETags vs locally computed
+  composite ETags; multipart, CRC64 end-to-end, moto-tested.
+
+## Quickstart
+
+```sh
+apt install liburing-dev libssl-dev   # build deps
+make -C quiver/exec                    # builds quiver-exec + templates
+PYTHONPATH=. python3 -m quiver.tests.run_all   # 18 groups
+PYTHONPATH=. python3 -m quiver.cli du /some/tree
+PYTHONPATH=. python3 -m quiver.cli pack --tar /some/tree out.tar
+python3 -c "from quiver import nock; print(nock.read_index('out.tar'))"
+```
+
+## Status
+
+Prototype consolidated through P0–P2 of [docs/PLAN.md](docs/PLAN.md);
+18 integration test groups (GNU tar interop, oracle scan parity,
+crash-resume, live-sshd remote sync, moto S3). Not yet handled:
+symlinks, hardlink preservation in cp, sparse files, xattrs — see the
+plan before pointing it at trees it didn't create.
+
+## Credits
+
+`pupyarrow/` originates from HumeAI/wsds. `pupyarrow/fb.py` ports the
+builder algorithm from google/flatbuffers (Apache-2.0) — see NOTICE.
+The scanner's worker model follows HumeAI/ducl's pwalk2.

quiver_tools-0.1.0/README.md

@@ -0,0 +1,100 @@
+# quiver & nock
+
+**quiver** — Unix file tooling rebuilt set-at-a-time: `scan`, `cp`, `rm`,
+`du`, `sync`, `pack`. One relational planner (Polars), swappable
+execution engines (io_uring / sync), Arrow record batches as the only
+interchange.
+
+**nock** — the index format: an Arrow IPC table of members parked in the
+trailing slack of a host container (tar, raw, or Arrow IPC), making any
+shard listable in one read and extractable by predicate.
+
+Built for high-latency parallel filesystems (WEKA-class) and object
+stores, where round-trips dominate and batching wins. On a warm local
+fs, coreutils will beat it — that's expected and honest.
+
+## Install
+
+```bash
+pip install quiver-tools          # Linux x86_64 / aarch64 wheels, glibc >= 2.28; import name is `quiver`
+```
+
+The wheel ships the `bvm` executor prebuilt (static zstd, libsodium, liburing, BLAKE3).
+io_uring paths need a reasonably recent kernel; everything falls back to sync I/O otherwise.
+
+From a checkout, build the executor once (pinned dependency sources, ~1-2 minutes), then
+install editable; `pip install -e` leaves the in-tree `bvm` alone, `make` owns it:
+
+```bash
+quiver/exec/build-deps.sh && make -C quiver/exec bvm   # or: make -C quiver/exec bvm DEPS=/prefix/with/static/libs
+pip install -e ".[dev]"
+```
+
+## The one idea
+
+```
+   producers                planner                  executors
+┌──────────────┐   ┌───────────────────────┐   ┌──────────────────┐
+│ fs scan (C,  │   │ Polars: join, delta,  │   │ fs exec (C,      │
+│ io_uring)    │──▶│ cum_sum layout, epoch │──▶│ io_uring chains) │
+│ nock footers │   │ assignment, header    │   │ s3 exec (boto3)  │
+│ S3 listing   │   │ packing — all exprs   │   │ ssh remote exec  │
+└──────────────┘   └───────────────────────┘   └──────────────────┘
+```
+
+Every tool is a query over stat frames that emits command frames.
+`sync` is the general tool; `cp` is sync into an empty destination,
+`rm` is sync from an empty source. tar headers are generated as Polars
+expressions (byte-compatible with GNU tar, PAX included). Archives
+carry their own index; retrofitting existing WebDataset tar shards or
+Arrow shards touches zero payload bytes.
+
+## Highlights
+
+- **Zero-dependency runtime**: polars + numpy. pyarrow and flatbuffers
+  are test-suite oracles only — `pupyarrow/` (vendored fork of
+  [wsds](https://github.com/HumeAI/wsds)'s reader) gained a writer and
+  a hand-rolled flatbuffers subset (`fb.py`, 12.6× faster metadata
+  walks than generated accessors).
+- **One C binary** (`quiver-exec`): io_uring scanner (pwalk2 worker
+  model) + executor (linked SQE chains, refcount forest scheduler,
+  direct descriptors) + hashing (part-parallel MD5 composite ETags,
+  slice-by-8 CRC-64/NVME with GF(2) combine).
+- **Predicate pushdown into the scanner**: path prefixes prune whole
+  subtrees (no getdents), basename globs skip statx for known-regular
+  misses.
+- **Pipelined execution**: `quiver.stream` runs the executor while the
+  scan is still going; monotone plans overlap, pipeline breakers
+  (rmdir, joins, sorts) drain as a tail.
+- **WAL / resume**: the command frame *is* the write-ahead log; crash
+  anywhere, rerun the WAL — completed rows skip, failed rows retry.
+- **ssh mode**: `ssh host quiver-exec` driven verbatim; changed
+  payloads ride inside the protocol as inline chunk chains; `verify`
+  sends only u64 hashes across the wire.
+- **S3 sync**: content-addressed via listed ETags vs locally computed
+  composite ETags; multipart, CRC64 end-to-end, moto-tested.
+
+## Quickstart
+
+```sh
+apt install liburing-dev libssl-dev   # build deps
+make -C quiver/exec                    # builds quiver-exec + templates
+PYTHONPATH=. python3 -m quiver.tests.run_all   # 18 groups
+PYTHONPATH=. python3 -m quiver.cli du /some/tree
+PYTHONPATH=. python3 -m quiver.cli pack --tar /some/tree out.tar
+python3 -c "from quiver import nock; print(nock.read_index('out.tar'))"
+```
+
+## Status
+
+Prototype consolidated through P0–P2 of [docs/PLAN.md](docs/PLAN.md);
+18 integration test groups (GNU tar interop, oracle scan parity,
+crash-resume, live-sshd remote sync, moto S3). Not yet handled:
+symlinks, hardlink preservation in cp, sparse files, xattrs — see the
+plan before pointing it at trees it didn't create.
+
+## Credits
+
+`pupyarrow/` originates from HumeAI/wsds. `pupyarrow/fb.py` ports the
+builder algorithm from google/flatbuffers (Apache-2.0) — see NOTICE.
+The scanner's worker model follows HumeAI/ducl's pwalk2.

quiver_tools-0.1.0/bench/README.md

@@ -0,0 +1,97 @@
+# quiver benchmark suite
+
+Every performance knob quiver exposes has a **filesystem-dependent** optimum. The numbers
+below from one cluster are not portable — on WEKA, splitting output across 32 sink files is
+worth **3.9x**; on local ext4 the same change is worth **1.0x**. So measure your own storage:
+
+```sh
+make
+./run_bench.py --out results/mysite --dir /path/on/the/fs/under/test
+cat results/mysite/report.md
+```
+
+The report ends with **recommended settings computed from your run** (`--shards`,
+`--frame-mb`, `-j`), so it is directly actionable.
+
+## What it measures, and why quiver cares
+
+| bench | measures | knob it informs |
+|---|---|---|
+| `fsbw` | write bandwidth vs threads, chunk size, **sink count**, buffered/O_DIRECT | `--shards`, `--frame-mb`, `-j` |
+| `read` | read bandwidth vs threads; one file vs many | restore/verify; sharded nocksets |
+| `dirspread` | the same create/stat/unlink work over 1..N **directories** | work shuffling, `rm` strategy |
+| `scan` | `readdir`+`d_type` vs `lstat` vs raw `getdents64` | whether enumerate paths may stat |
+| `cdc` | content-defined chunking rate + delta size for a localized edit | backup/rsync delta path |
+| `hashes` | BLAKE3 / BLAKE2b / SHA-256 / SipHash | chunk-id + digest algorithm |
+| `crypto` | AES-GCM / XChaCha20-Poly1305 / keyed BLAKE2b | encryption headroom |
+| `cfr` | stored-frame write shapes: buffered copy vs `writev` vs `copy_file_range` | incompressible pack path |
+| `rw` | read+write concurrently vs each alone, **in both I/O modes** | is the job near the limit? |
+
+**Read `rw` before comparing any job against a ceiling.** The mode decides the answer. On WEKA,
+32 threads / 8 MB / 16 sinks:
+
+| mode | read-only | write-only | concurrent (each) | combined |
+|---|---|---|---|---|
+| O_DIRECT | 4.78 | 5.14 | 2.63 | 5.26 |
+| buffered + 64 MB paced writeback | 4.52 | 3.24 | 2.04 | 4.08 |
+
+quiver writes buffered with paced writeback, so 2.04 GB/s/direction is its ceiling — and it
+reaches 2.20 read / 1.78 write, i.e. 97.5% of the combined 4.08. An earlier version of this
+bench measured O_DIRECT only; comparing the job against that 2.93 figure invented a 37% gap
+that does not exist. O_DIRECT is *faster* for this bench's sequential per-thread writes and
+*2.3x slower* for quiver's offset-reserved shared-sink writes (see `BVM_SINK_DIRECT`).
+| `framecap` | compression ratio vs (zstd level x frame cap) on YOUR corpora | `--frame-cap-mb` |
+| `numa` | fully-loaded compression vs CPU/memory placement | whether to pin workers |
+| `multinode` | aggregate bandwidth with N nodes writing at once | how many nodes to use |
+| `quiver` | end-to-end pack of a real tree, incl. quiver's own queue-occupancy verdict | everything |
+
+Multi-node needs hostnames:
+
+```sh
+./run_bench.py --only multinode --nodes n1,n2,n3,n4 --node-counts 1 2 4 \
+  --srun-base "srun -p gpu -G 8 -N 1 -n 1 --mem=0 --time=30"
+```
+
+HTML reports (self-contained, no external assets):
+
+```sh
+./report_html.py results/siteA results/siteB --index results/index.html
+```
+
+`--tree /some/real/data` makes the end-to-end pack use your data instead of synthetic files;
+that is the most representative single number.
+
+## Reading the results
+
+Three traps this suite is built to avoid — all of them cost us real debugging time:
+
+1. **Buffered writes measure DRAM, not storage.** A buffered run "achieved" 20.9 GB/s here;
+   the same work with `O_DIRECT` was 6.4 GB/s, and the buffered `fsync` then stalled 17s.
+   Every headline number in the report is `O_DIRECT` (or durability-inclusive).
+2. **Data generation must not be the bottleneck.** `fsbw` fills one buffer with xorshift128+
+   *once* and reuses it hundreds of times; it prints the amortized cost (<0.001% of runtime).
+3. **Concurrent writers to one file may not scale.** This is the single biggest effect we
+   found, and it is invisible unless you test it explicitly.
+
+`quiver`'s own counters also self-report a bottleneck verdict using queue occupancy
+(Little's law): a bounded queue persistently *full* means its consumer is the constraint,
+persistently *empty* means its producer is. The report includes that verdict verbatim.
+
+## Cluster use
+
+Pass `--srun` to run each measurement on an exclusive node — otherwise co-tenants skew
+results (we measured a ~2x error from a busy node):
+
+```sh
+./run_bench.py --out results/mysite --dir /mnt/fs/scratch \
+  --srun "srun -p gpu -G 8 -N 1 -n 1 --mem=0 --time=30"
+```
+
+Multi-node aggregate bandwidth (does the fabric scale?) is a separate question; run the
+suite on N nodes simultaneously against the same filesystem and sum the `fsbw` numbers.
+
+## Re-rendering / diffing
+
+`results.json` is the machine-readable record; `./run_bench.py --report results/mysite`
+re-renders the markdown from it. Diff two `results.json` files to compare sites, kernels,
+client versions, or before/after a tuning change.

quiver_tools-0.1.0/bench/qvm2/README.md

@@ -0,0 +1,13 @@
+# qvm2 micro benchmarks / milestone gates
+
+Each `drive_m*.py` is a milestone gate (see the header of `quiver/exec/qvm2.c`);
+every one packs real bytes and self-verifies. `bench_scan.py <root>` runs the
+three-leg scan A/B (bvm cold, qvm2 I_SCAN, bvm warm — same process, back to back;
+only same-run numbers are comparable).
+
+Build first: `make -C quiver/exec bvm qvm2` (override ZSTD/URING/BLAKE3 to your
+static-lib prefixes). Gates create their trees in the CWD — run from a scratch dir:
+
+    python bench/qvm2/drive_m6.py          # cross-engine pack/unpack gate
+    python bench/qvm2/drive_m5.py <tree>   # I_SCAN leaf vs os.walk truth
+    python bench/qvm2/bench_scan.py <tree> # the A/B

quiver_tools-0.1.0/hatch_build.py

@@ -0,0 +1,82 @@
+"""Hatchling build hook -- compiles the bvm executor into the wheel.
+
+bvm (quiver/exec/bvm.c) is a plain C program linked statically against zstd, libsodium,
+liburing and BLAKE3 (see quiver/exec/build-deps.sh and the Makefile), so the wheel's only
+runtime requirement is glibc. Linux only: elsewhere the wheel is pure Python with no executor.
+
+Environment:
+  QUIVER_SKIP_BVM=1       skip the build; pure py3-none-any wheel
+  QUIVER_WHEEL_PLAT=TAG   platform tag to claim, e.g. manylinux_2_28_x86_64. release.yml builds
+                          inside that manylinux container; the default, linux_<machine>, is the
+                          honest tag for a wheel built on an arbitrary host.
+  DEPS=<prefix>           passed through to make (static deps prefix; default quiver/exec/deps)
+
+A manylinux claim is checked against the binary's GLIBC_* symbol versions: a bvm that needs a
+newer glibc than the tag promises fails the build instead of failing on users' machines.
+"""
+
+import os
+import platform
+import re
+import subprocess
+import sys
+
+from hatchling.builders.hooks.plugin.interface import BuildHookInterface
+
+
+def _max_glibc(binary: str):
+    """Highest GLIBC_x.y version the binary references, via objdump -T; None if unknown."""
+    try:
+        out = subprocess.run(["objdump", "-T", binary], capture_output=True, text=True,
+                             check=True).stdout
+    except (OSError, subprocess.CalledProcessError):
+        return None
+    versions = {tuple(int(x) for x in v.split(".")) for v in re.findall(r"GLIBC_(\d+\.\d+)", out)}
+    return max(versions) if versions else None
+
+
+class CustomBuildHook(BuildHookInterface):
+    def initialize(self, version, build_data):
+        if platform.system() != "Linux" or os.environ.get("QUIVER_SKIP_BVM"):
+            return
+
+        exec_dir = os.path.join(self.root, "quiver", "exec")
+        binary = os.path.join(exec_dir, "bvm")
+        if version == "editable":
+            # `pip install -e .`: the package runs from the checkout, so default_bvm() finds
+            # whatever ./bvm is there. Don't rebuild it behind the developer's back (it may be
+            # the binary running jobs depend on); just say so if it is missing.
+            if not os.path.isfile(binary):
+                print(f"hatch_build: no {binary}; run  quiver/exec/build-deps.sh && make -C "
+                      f"quiver/exec bvm", file=sys.stderr)
+            return
+        # -B: never ship a stale bvm left over from an earlier/other build. PYTHON: the
+        # ipc_gen.h generator runs with the build environment's interpreter (it has numpy).
+        env = dict(os.environ, PYTHON=sys.executable)
+        subprocess.check_call(["make", "-C", exec_dir, "-B", "bvm"], env=env)
+        if not os.path.isfile(binary):
+            raise SystemExit(f"hatch_build: make did not produce {binary}")
+
+        build_data.setdefault("force_include", {})[binary] = "quiver/exec/bvm"
+        build_data["pure_python"] = False
+        build_data["infer_tag"] = True
+
+        machine = platform.machine()
+        plat = os.environ.get("QUIVER_WHEEL_PLAT") or f"linux_{machine}"
+        m = re.fullmatch(r"manylinux_(\d+)_(\d+)_(\w+)", plat)
+        if m:
+            if m[3] != machine:
+                raise SystemExit(f"hatch_build: QUIVER_WHEEL_PLAT={plat} but this host is {machine}")
+            claimed = (int(m[1]), int(m[2]))
+            needed = _max_glibc(binary)
+            if needed is None:
+                print("hatch_build: objdump unavailable; cannot verify the manylinux claim",
+                      file=sys.stderr)
+            elif needed > claimed:
+                raise SystemExit(
+                    f"hatch_build: bvm needs GLIBC_{needed[0]}.{needed[1]} but the wheel would "
+                    f"claim {plat}. Build inside the quay.io/pypa/{plat} container (release.yml) "
+                    f"or unset QUIVER_WHEEL_PLAT for a plain linux_{machine} wheel.")
+            else:
+                print(f"hatch_build: bvm needs GLIBC_{needed[0]}.{needed[1]} <= {plat}: ok")
+        build_data["tag"] = f"py3-none-{plat}"