Compare commits
105
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
db4a067fe8 | ||
|
|
4aa3c5a1ca | ||
|
|
26e06cc5fd | ||
|
|
390a2e3836 | ||
|
|
f15bf2eb22 | ||
|
|
09480747aa | ||
|
|
39bf2bebf4 | ||
|
|
0ee698accd | ||
|
|
2bfbb7fb4b | ||
|
|
61424d1418 | ||
|
|
65d219c409 | ||
|
|
eb99de1020 | ||
|
|
a3ad548f84 | ||
|
|
0876796432 | ||
|
|
91d46a3813 | ||
|
|
97ab658c11 | ||
|
|
5dd95a6cf8 | ||
|
|
a0ff8ef32c | ||
|
|
24afcdc70f | ||
|
|
8f62cb44e0 | ||
|
|
e38c8133bc | ||
|
|
12847c6c66 | ||
|
|
81e8294048 | ||
|
|
0eca8574f5 | ||
|
|
005f37e846 | ||
|
|
bf8bbec87e | ||
|
|
6e84f31ed6 | ||
|
|
3ed0489faa | ||
|
|
0744d52639 | ||
|
|
99b907be04 | ||
|
|
4f2975d7e3 | ||
|
|
d4f2d3e7b5 | ||
|
|
6848494647 | ||
|
|
943b9141e3 | ||
|
|
a9f78ca5a1 | ||
|
|
a3f7c6fe89 | ||
|
|
bbe1baa208 | ||
|
|
706189c3ef | ||
|
|
926dc457e0 | ||
|
|
a8ab9ca054 | ||
|
|
2053b69f07 | ||
|
|
b55b7dbac5 | ||
|
|
48c745a960 | ||
|
|
377c8b6f17 | ||
|
|
07b7301ded | ||
|
|
d3c65ccb58 | ||
|
|
c137302f04 | ||
|
|
f23363cde5 | ||
|
|
3a30327f35 | ||
|
|
5db1008eb7 | ||
|
|
ab283d2759 | ||
|
|
18ac510c29 | ||
|
|
3c7c229e20 | ||
|
|
2e8414e412 | ||
|
|
45a38ba260 | ||
|
|
1efd82c841 | ||
|
|
4051d5c16e | ||
|
|
934d053f92 | ||
|
|
603fcf8757 | ||
|
|
d787ac04c8 | ||
|
|
55c3737130 | ||
|
|
7314971fe7 | ||
|
|
864faf3656 | ||
|
|
73bc067fea | ||
|
|
122849b5a9 | ||
|
|
b08df7b628 | ||
|
|
b2dce41532 | ||
|
|
1537a9464a | ||
|
|
12d9d8462f | ||
|
|
c913cd1cbf | ||
|
|
7d6e269bf3 | ||
|
|
6f5940d042 | ||
|
|
dfae9e2cc1 | ||
|
|
429c29b76b | ||
|
|
40527be653 | ||
|
|
2013fa94a0 | ||
|
|
a3e1cf8588 | ||
|
|
534331ffbe | ||
|
|
297ee5ec17 | ||
|
|
a319405ffc | ||
|
|
62595d5ac0 | ||
|
|
55959b4920 | ||
|
|
b70d594c4f | ||
|
|
b9898c2a9c | ||
|
|
88195d1c33 | ||
|
|
6b1ea450f5 | ||
|
|
b1fc23e975 | ||
|
|
1347746973 | ||
|
|
c30ed0cda5 | ||
|
|
d8ef8785e2 | ||
|
|
e23e0358e0 | ||
|
|
2f9f73bf24 | ||
|
|
aa3e12f3ae | ||
|
|
d41e5ecfdd | ||
|
|
5701e8045d | ||
|
|
e82b8f56bd | ||
|
|
2ddb22897c | ||
|
|
3a1fcc5cb3 | ||
|
|
bf197b70e3 | ||
|
|
cb0b0e9df2 | ||
|
|
e91f7fc539 | ||
|
|
d6c4d4f111 | ||
|
|
90bdd7cd13 | ||
|
|
28a0dc3384 | ||
|
|
bae80d030b |
@@ -0,0 +1,40 @@
|
||||
name: CI
|
||||
on:
|
||||
push:
|
||||
branches: [main]
|
||||
pull_request:
|
||||
branches: [main]
|
||||
jobs:
|
||||
test:
|
||||
runs-on: ubuntu-latest
|
||||
container: rust:latest
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- name: Cache cargo registry/target
|
||||
uses: actions/cache@v4
|
||||
with:
|
||||
path: |
|
||||
~/.cargo/registry
|
||||
~/.cargo/git
|
||||
target
|
||||
key: ${{ runner.os }}-cargo-${{ hashFiles('**/Cargo.lock') }}
|
||||
- name: Install rustfmt & clippy components
|
||||
run: rustup component add rustfmt clippy
|
||||
- name: Install thumbv7em-none-eabihf target
|
||||
run: rustup target add thumbv7em-none-eabihf
|
||||
- name: Install Python interop dependencies
|
||||
# The interop suites used to skip silently when python3/h5py were
|
||||
# missing, so they never ran in CI. Install them and make a missing
|
||||
# dependency a failure (CLAWHDF5_REQUIRE_INTEROP below).
|
||||
run: |
|
||||
apt-get update
|
||||
apt-get install -y --no-install-recommends python3 python3-venv
|
||||
python3 -m venv /opt/interop
|
||||
/opt/interop/bin/pip install --no-cache-dir h5py numpy netCDF4 xarray
|
||||
echo "/opt/interop/bin" >> "$GITHUB_PATH"
|
||||
- name: Show interop library versions
|
||||
run: python3 -c "import h5py, netCDF4; print('h5py', h5py.__version__, 'HDF5', h5py.version.hdf5_version, 'netCDF4', netCDF4.__version__)"
|
||||
- name: Run CI script
|
||||
env:
|
||||
CLAWHDF5_REQUIRE_INTEROP: "1"
|
||||
run: bash scripts/ci-test.sh
|
||||
@@ -1,3 +1,6 @@
|
||||
/target
|
||||
Cargo.lock
|
||||
benchmarks/longmemeval/*.json
|
||||
|
||||
# Local model weights (MiniLM etc.) — large, not committed
|
||||
weights/
|
||||
|
||||
+845
-37
@@ -4,10 +4,245 @@
|
||||
|
||||
**System:** Intel i7-12650H (10C/16T, 4.7 GHz boost) · 32 GB DDR5 · Linux 6.8.0
|
||||
**Rust:** 1.96.0-nightly (2026-03-14) · `--release` profile
|
||||
**Date:** 2026-03-20
|
||||
**Date:** 2026-07-01
|
||||
|
||||
> **Traceability note:** the "h5bench-Equivalent I/O Benchmarks" and both
|
||||
> "Independent Validation: tank" sections below meet a dated,
|
||||
> hardware-cited, reproducible standard (explicit date, machine spec, and a
|
||||
> runnable command per result) — this now covers "LongMemEval Results",
|
||||
> "SIMD & Parallelism", "Vector Search Latency", and "Comparison to MemX" via
|
||||
> their tank re-runs. The remaining undated sections above (Hybrid Search,
|
||||
> Knowledge Graph, Memory Consolidation, Temporal Index, Write Path, Decision
|
||||
> Gate, Memory Strategy, Multi-Session Benchmark, Memory Footprint,
|
||||
> Consolidation Efficiency, Ephemeral Tier) do not yet meet that bar — this is
|
||||
> a known, tracked documentation gap, not a claim that those numbers are wrong.
|
||||
>
|
||||
> **Correctness note (2026-08-06).** Being dated and reproducible is necessary but
|
||||
> not sufficient — a number can be perfectly reproducible and still measure the
|
||||
> wrong thing. A methodology audit found two such cases and both have been
|
||||
> retracted in place: the session-level LongMemEval figures (degenerate on the
|
||||
> oracle variant) and the MemX retrieval comparison (mismatched granularity and
|
||||
> corpus). Every cross-system comparison in this file now carries an explicit
|
||||
> scoping caveat. Where a section states a scoring target, that declaration is the
|
||||
> contract — read it before citing the number.
|
||||
|
||||
---
|
||||
|
||||
## Search harness baseline (v2.3.0)
|
||||
|
||||
Produced by `cargo run --release -p clawhdf5-bench --bin search_harness -- --full`
|
||||
on deterministic **clustered** synthetic data (384-dim, unit-normalised; points =
|
||||
cluster centre + noise — uniform random vectors are nearly equidistant in high
|
||||
dimension and say nothing about embeddings). Recall is measured against an exact
|
||||
brute-force scan, 200 queries. This is the *before* picture for the search
|
||||
hot-path work; every change to that path should be justified by a re-run.
|
||||
|
||||
Two things stand out:
|
||||
|
||||
* **HNSW recall does not respond to `ef`** and degrades sharply with size
|
||||
(0.87 → 0.67 → 0.31 recall@10 at 1K / 10K / 100K). Latency plateaus at the same
|
||||
point, i.e. the search exhausts the nodes it can reach: on clustered data the
|
||||
graph is poorly connected. The index selects neighbours by plain top-M
|
||||
distance rather than the HNSW paper's diversity heuristic.
|
||||
* **End-to-end `hybrid_search` is ~1000x slower than its vector stage** (49 ms
|
||||
vs ~0.03 ms at 10K; 884 ms at 100K). Each query rebuilds the BM25 index from
|
||||
scratch and rewrites the whole `.h5` file. The first query after `open()`
|
||||
additionally rebuilds the HNSW index (10.5 s at 100K).
|
||||
|
||||
### HNSW, N = 1000, dim = 384, M = 16, ef_construction = 64
|
||||
|
||||
build: 72.4 ms (13818 vectors/s) · exact scan: 3854 QPS, p50 258 µs
|
||||
|
||||
| ef | recall@10 | QPS | p50 µs | p99 µs |
|
||||
|---:|---:|---:|---:|---:|
|
||||
| 16 | 0.8710 | 59484 | 16 | 31 |
|
||||
| 32 | 0.8730 | 46302 | 21 | 25 |
|
||||
| 64 | 0.8730 | 31683 | 31 | 44 |
|
||||
| 128 | 0.8730 | 24715 | 40 | 49 |
|
||||
| 256 | 0.8730 | 24788 | 40 | 50 |
|
||||
|
||||
### HNSW, N = 10000, dim = 384, M = 16, ef_construction = 64
|
||||
|
||||
build: 802.5 ms (12461 vectors/s) · exact scan: 418 QPS, p50 2363 µs
|
||||
|
||||
| ef | recall@10 | QPS | p50 µs | p99 µs |
|
||||
|---:|---:|---:|---:|---:|
|
||||
| 16 | 0.6695 | 44031 | 19 | 51 |
|
||||
| 32 | 0.6705 | 45066 | 22 | 30 |
|
||||
| 64 | 0.6705 | 32746 | 30 | 41 |
|
||||
| 128 | 0.6705 | 27542 | 36 | 51 |
|
||||
| 256 | 0.6705 | 27754 | 36 | 49 |
|
||||
|
||||
### HNSW, N = 100000, dim = 384, M = 16, ef_construction = 64
|
||||
|
||||
build: 9752.6 ms (10254 vectors/s) · exact scan: 40 QPS, p50 24648 µs
|
||||
|
||||
| ef | recall@10 | QPS | p50 µs | p99 µs |
|
||||
|---:|---:|---:|---:|---:|
|
||||
| 16 | 0.3085 | 18046 | 57 | 84 |
|
||||
| 32 | 0.3110 | 21621 | 43 | 75 |
|
||||
| 64 | 0.3130 | 20015 | 49 | 70 |
|
||||
| 128 | 0.3135 | 15822 | 63 | 99 |
|
||||
| 256 | 0.3135 | 15308 | 66 | 124 |
|
||||
|
||||
### End to end: `HDF5Memory::hybrid_search` (k = 10, weights 0.7 / 0.3)
|
||||
|
||||
| N | ingest ms | checkpoint ms | open ms | first query ms | p50 ms | p99 ms | QPS |
|
||||
|---:|---:|---:|---:|---:|---:|---:|---:|
|
||||
| 1000 | 11 | 3.9 | 0.9 | 68.1 | 5.48 | 5.57 | 182.5 |
|
||||
| 10000 | 114 | 32.2 | 10.9 | 845.0 | 48.56 | 78.65 | 19.8 |
|
||||
| 100000 | 1486 | 713.0 | 354.5 | 10486.5 | 883.51 | 975.23 | 1.1 |
|
||||
wrote /tmp/claude-1000/-home-osobh-projects-clawhdf5/422f755e-dd25-4c35-8613-5439087e3aaa/scratchpad/baseline_full.json
|
||||
|
||||
### After: HNSW neighbour-selection heuristic
|
||||
|
||||
Same harness, same data, after replacing closest-M neighbour selection with the
|
||||
HNSW paper's diversity heuristic (Algorithm 4, keeping pruned connections) for
|
||||
both new links and back-link pruning. Recall@10 at `ef = 64`: **0.87 → 1.00**
|
||||
(1K), **0.67 → 1.00** (10K), **0.31 → 0.98** (100K), and it now rises with
|
||||
`ef` as it should. The cost is a slower build (extra distance evaluations per
|
||||
insert: ~3.5x at 10K); the distance-kernel work that follows targets that.
|
||||
|
||||
### HNSW, N = 1000, dim = 384, M = 16, ef_construction = 64
|
||||
|
||||
build: 221.3 ms (4519 vectors/s) · exact scan: 3851 QPS, p50 258 µs
|
||||
|
||||
| ef | recall@10 | QPS | p50 µs | p99 µs |
|
||||
|---:|---:|---:|---:|---:|
|
||||
| 16 | 0.9990 | 54760 | 18 | 29 |
|
||||
| 32 | 1.0000 | 40422 | 24 | 44 |
|
||||
| 64 | 1.0000 | 27744 | 36 | 51 |
|
||||
| 128 | 1.0000 | 13164 | 74 | 106 |
|
||||
| 256 | 1.0000 | 6879 | 144 | 175 |
|
||||
|
||||
### HNSW, N = 10000, dim = 384, M = 16, ef_construction = 64
|
||||
|
||||
build: 2733.5 ms (3658 vectors/s) · exact scan: 423 QPS, p50 2362 µs
|
||||
|
||||
| ef | recall@10 | QPS | p50 µs | p99 µs |
|
||||
|---:|---:|---:|---:|---:|
|
||||
| 16 | 0.9975 | 31321 | 27 | 61 |
|
||||
| 32 | 1.0000 | 32427 | 29 | 48 |
|
||||
| 64 | 1.0000 | 22738 | 42 | 62 |
|
||||
| 128 | 1.0000 | 10055 | 99 | 129 |
|
||||
| 256 | 1.0000 | 4649 | 214 | 266 |
|
||||
|
||||
### HNSW, N = 100000, dim = 384, M = 16, ef_construction = 64
|
||||
|
||||
build: 36472.8 ms (2742 vectors/s) · exact scan: 40 QPS, p50 24644 µs
|
||||
|
||||
| ef | recall@10 | QPS | p50 µs | p99 µs |
|
||||
|---:|---:|---:|---:|---:|
|
||||
| 16 | 0.9235 | 11394 | 82 | 194 |
|
||||
| 32 | 0.9675 | 12788 | 73 | 161 |
|
||||
| 64 | 0.9840 | 10406 | 91 | 186 |
|
||||
| 128 | 0.9990 | 7633 | 126 | 248 |
|
||||
| 256 | 0.9990 | 2823 | 352 | 510 |
|
||||
|
||||
### After: persistent keyword index, no store rewrite per query
|
||||
|
||||
`hybrid_search` used to rebuild the BM25 index from scratch (re-tokenising every
|
||||
record) and rewrite the whole `.h5` file on **every query**. The index is now
|
||||
kept for the life of the store and updated incrementally, and activation boosts
|
||||
are persisted by the next checkpoint instead of inside the query. Steady-state
|
||||
p50: **5.5 → 0.24 ms** (1K), **49 → 2.1 ms** (10K), **884 → 23 ms** (100K).
|
||||
|
||||
The first query after `open()` is slower than before (it pays for the better —
|
||||
slower — HNSW build plus the one-off keyword index build); persisting the HNSW
|
||||
index removes that.
|
||||
|
||||
### End to end: `HDF5Memory::hybrid_search` (k = 10, weights 0.7 / 0.3)
|
||||
|
||||
| N | ingest ms | checkpoint ms | open ms | first query ms | p50 ms | p99 ms | QPS |
|
||||
|---:|---:|---:|---:|---:|---:|---:|---:|
|
||||
| 1000 | 11 | 3.8 | 0.9 | 195.9 | 0.24 | 0.27 | 4130.4 |
|
||||
| 10000 | 104 | 31.1 | 10.9 | 2627.1 | 2.09 | 2.11 | 479.5 |
|
||||
| 100000 | 1436 | 684.7 | 278.0 | 36308.1 | 22.90 | 25.46 | 43.5 |
|
||||
|
||||
### After: vector index persisted with the checkpoint
|
||||
|
||||
The HNSW graph (not the vectors, which the store already holds) is saved to
|
||||
`<store>.h5.ann` at each checkpoint and reloaded by `open()`, tied to that
|
||||
checkpoint by a generation id. The index is now built once per store (the *cold
|
||||
index build* column — the first query ever), not once per session. First query
|
||||
after `open()`: **196 → 1.7 ms** (1K), **2627 → 15 ms** (10K),
|
||||
**36308 → 159 ms** (100K); what remains is the one-off keyword index build.
|
||||
Batch saves no longer force a full rebuild either: appended records join the
|
||||
index incrementally.
|
||||
|
||||
| N | ingest ms | cold index build ms | checkpoint ms | open ms | first query after open ms | p50 ms | p99 ms | QPS |
|
||||
|---:|---:|---:|---:|---:|---:|---:|---:|---:|
|
||||
| 1000 | 14 | 220 | 6.1 | 1.2 | 1.7 | 0.24 | 0.27 | 4049.9 |
|
||||
| 10000 | 120 | 2916 | 33.1 | 14.0 | 15.4 | 2.15 | 3.30 | 421.2 |
|
||||
| 100000 | 1591 | 40515 | 747.3 | 324.7 | 158.9 | 23.07 | 30.42 | 41.3 |
|
||||
|
||||
### After: unit-vector dot product, reusable visited set
|
||||
|
||||
Cosine distance recomputed both vector norms on every evaluation; the index now
|
||||
stores unit vectors and uses a plain dot product. The per-call `HashSet` of
|
||||
visited nodes became a reusable epoch-stamped array. Recall is unchanged.
|
||||
Build: **2.75 -> 1.89 s** (10K), **~38 -> 21 s** (100K). QPS at `ef = 64`:
|
||||
**22.7K -> 39K** (10K), **10.4K -> 14K** (100K).
|
||||
|
||||
### HNSW, N = 1000, dim = 384, M = 16, ef_construction = 64
|
||||
|
||||
build: 113.4 ms (8821 vectors/s) · exact scan: 4375 QPS, p50 225 µs
|
||||
|
||||
| ef | recall@10 | QPS | p50 µs | p99 µs |
|
||||
|---:|---:|---:|---:|---:|
|
||||
| 16 | 0.9990 | 144379 | 7 | 15 |
|
||||
| 32 | 1.0000 | 110654 | 9 | 17 |
|
||||
| 64 | 1.0000 | 80446 | 12 | 25 |
|
||||
| 128 | 1.0000 | 38220 | 26 | 36 |
|
||||
| 256 | 1.0000 | 20041 | 50 | 62 |
|
||||
|
||||
### HNSW, N = 10000, dim = 384, M = 16, ef_construction = 64
|
||||
|
||||
build: 1519.4 ms (6581 vectors/s) · exact scan: 422 QPS, p50 2368 µs
|
||||
|
||||
| ef | recall@10 | QPS | p50 µs | p99 µs |
|
||||
|---:|---:|---:|---:|---:|
|
||||
| 16 | 0.9975 | 54608 | 15 | 45 |
|
||||
| 32 | 1.0000 | 66009 | 14 | 24 |
|
||||
| 64 | 1.0000 | 49854 | 19 | 31 |
|
||||
| 128 | 1.0000 | 22403 | 45 | 57 |
|
||||
| 256 | 1.0000 | 10096 | 100 | 120 |
|
||||
|
||||
### HNSW, N = 100000, dim = 384, M = 16, ef_construction = 64
|
||||
|
||||
build: 21084.6 ms (4743 vectors/s) · exact scan: 39 QPS, p50 24739 µs
|
||||
|
||||
| ef | recall@10 | QPS | p50 µs | p99 µs |
|
||||
|---:|---:|---:|---:|---:|
|
||||
| 16 | 0.9235 | 15139 | 61 | 154 |
|
||||
| 32 | 0.9675 | 18181 | 53 | 121 |
|
||||
| 64 | 0.9840 | 13980 | 70 | 139 |
|
||||
| 128 | 0.9990 | 10959 | 86 | 174 |
|
||||
| 256 | 0.9990 | 3731 | 254 | 697 |
|
||||
|
||||
|
||||
### After: unranked keyword scores, top-k merge (rankings unchanged)
|
||||
|
||||
A fusion study (`search_harness --fusion-study`) showed that capping the
|
||||
keyword candidate pool is **not** a safe optimisation: against the current
|
||||
full-corpus normalisation the final top-10 overlap is only 0.83-0.92 and the
|
||||
first result changes for 10-35% of queries, for only a 2x saving. So the fusion
|
||||
semantics were left alone and the same answer made cheaper: fusion needs every
|
||||
keyword score but not their ranking, so BM25 now returns them unsorted from a
|
||||
dense accumulator (it hashed every posting and then sorted every match), and
|
||||
the merge selects its top k instead of sorting every candidate. Steady-state
|
||||
p50: **0.24 -> 0.07 ms** (1K), **2.1 -> 0.49 ms** (10K), **23 -> 4.65 ms**
|
||||
(100K) — **79x / 100x / 190x** faster than the v2.3.0 baseline, with identical
|
||||
results.
|
||||
|
||||
### End to end: `HDF5Memory::hybrid_search` (k = 10, weights 0.7 / 0.3)
|
||||
|
||||
| N | ingest ms | cold index build ms | checkpoint ms | open ms | first query after open ms | p50 ms | p99 ms | QPS |
|
||||
|---:|---:|---:|---:|---:|---:|---:|---:|---:|
|
||||
| 1000 | 11 | 112 | 4.0 | 1.1 | 1.4 | 0.07 | 0.08 | 14077.9 |
|
||||
| 10000 | 104 | 1487 | 33.8 | 13.7 | 13.9 | 0.49 | 0.51 | 2020.9 |
|
||||
| 100000 | 1376 | 20285 | 728.9 | 353.1 | 142.2 | 4.65 | 4.78 | 214.7 |
|
||||
|
||||
## Vector Search Latency
|
||||
|
||||
Brute-force cosine similarity over 384-dimensional embeddings (OpenAI text-embedding-3-small size).
|
||||
@@ -24,10 +259,19 @@ Brute-force cosine similarity over 384-dimensional embeddings (OpenAI text-embed
|
||||
|
||||
MemX claims end-to-end search under 90ms at 100K records (Rust + libSQL + FTS5).
|
||||
|
||||
| Metric | MemX (claimed) | ClawhDF5 | Speedup |
|
||||
|--------|----------------|----------|---------|
|
||||
| 100K flat search | <90 ms | 11.4 ms | **~8x** |
|
||||
| 100K IVF-PQ search | — | 1.19 ms | **~76x** |
|
||||
> **Caveat — not like-for-like.** MemX's `<90 ms` is *end-to-end* search across their
|
||||
> full pipeline (dense embeddings + FTS5 + four-factor re-ranking). The clawhdf5
|
||||
> figures below are a *single component* — raw vector search latency, excluding
|
||||
> embedding, keyword, fusion, and re-ranking stages. A component measured against a
|
||||
> full pipeline will always look favourable; the "speedup" column overstates the real
|
||||
> advantage by an unquantified margin and should be read as an order-of-magnitude
|
||||
> indication only, not a benchmark result. Matching MemX's measurement boundary is
|
||||
> tracked as follow-up work.
|
||||
|
||||
| Metric | MemX (claimed, end-to-end) | ClawhDF5 (component only) | Ratio |
|
||||
|--------|----------------------------|---------------------------|-------|
|
||||
| 100K flat search | <90 ms | 11.4 ms | ~8x |
|
||||
| 100K IVF-PQ search | — | 1.19 ms | ~76x |
|
||||
| Keyword search 10K | 1,100x improvement over unindexed | 583 µs (BM25) | Comparable |
|
||||
|
||||
---
|
||||
@@ -114,8 +358,8 @@ HDF5 persistence with optional Write-Ahead Log.
|
||||
|
||||
| Operation | Latency | Notes |
|
||||
|-----------|---------|-------|
|
||||
| Single save (no WAL) | 91 µs | Direct HDF5 write |
|
||||
| Single save (with WAL) | 134 µs | +47% for crash safety |
|
||||
| Single save (no WAL) | 61 µs | Direct HDF5 write (owned-Vec IO path) |
|
||||
| Single save (with WAL) | 18 µs | WAL group-commit append; HDF5 write batched at flush |
|
||||
| Batch 100 | 723 µs | 7.2 µs per record |
|
||||
| Batch 1,000 | 6.17 ms | 6.2 µs per record |
|
||||
| WAL save (1K existing) | 539 µs | Incremental append |
|
||||
@@ -160,7 +404,7 @@ End-to-end strategy evaluation including embedding operations.
|
||||
| **Hybrid vector+keyword** | <200 µs | 1K records |
|
||||
| **Knowledge graph query** | <25 µs | 1K entities |
|
||||
| **Temporal range query** | <1 µs | 10K timestamps |
|
||||
| **Memory write** | <135 µs | Per record |
|
||||
| **Memory write** | <20 µs | Per record (WAL group-commit append) |
|
||||
| **Consolidation cycle** | <165 µs | 1K records |
|
||||
| **Importance gate** | <1 µs | Per record |
|
||||
|
||||
@@ -174,46 +418,193 @@ _Latency benchmarks generated with Criterion.rs (50-100 samples per benchmark).
|
||||
|
||||
## LongMemEval Results
|
||||
|
||||
**Dataset:** LongMemEval oracle (500 questions, 6 question types, variable-length chat histories)
|
||||
> **Scoring target declaration.** Per [arXiv 2605.24060](https://arxiv.org/abs/2605.24060),
|
||||
> which found that changing scoring target alone alters nDCG on 83–94% of queries and
|
||||
> can reverse system rankings, this section states its measurement contract explicitly:
|
||||
>
|
||||
> - **Dataset variant:** both are now reported below — the full `longmemeval_s`
|
||||
> haystack (**the headline number**) and `longmemeval_oracle` (evidence sessions
|
||||
> only, a substantially easier corpus, kept for continuity). The harness does not
|
||||
> trust the filename: it measures evidence-session density from the data and
|
||||
> labels the run from that, so a mislabelled input cannot yield a mislabelled
|
||||
> result. Measured density is 4.0% on `longmemeval_s` and 100.0% on the oracle.
|
||||
> - **Metric:** *retrieval recall.* A "hit" means the gold-labelled memory appeared in
|
||||
> the top-k. **No answer is generated and none is scored** — the dataset's `answer`
|
||||
> field is deserialized and never read. This is **not** the official LongMemEval
|
||||
> leaderboard metric, which is end-to-end QA accuracy (retrieve → generate → LLM
|
||||
> judge). Retrieval recall reported as QA accuracy typically overstates by 20–30 points.
|
||||
> - **Granularity:** turn-level = the returned memory's source turn had `has_answer == true`.
|
||||
> - **k = 10**, n = 500.
|
||||
> - **Retrieval mode:** all three are reported below. Historically the bench passed
|
||||
> zero-vector embeddings with `vector_weight=0.0`, so the HNSW/vector stage was
|
||||
> inert and every published number was BM25 alone. Real `all-MiniLM-L6-v2`
|
||||
> embeddings are now available via `--features embeddings --embeddings <dir>`,
|
||||
> and BM25-only / vector-only / hybrid are each measured separately.
|
||||
|
||||
**Mode:** BM25-only retrieval — zero embeddings, `vector_weight=0.0`, `keyword_weight=1.0`
|
||||
**Reference:** MemX (arxiv:2603.16171) with full embedding system: Hit@5=51.6%, MRR=0.380
|
||||
|
||||
> **Run:** `cargo run --release --bin longmemeval_bench`
|
||||
> **Run:** `cargo run --release --bin longmemeval_bench -- benchmarks/longmemeval/longmemeval_s_cleaned.json`
|
||||
> (~70 s for all 500 questions on the tank reference machine). Omit the path for the
|
||||
> oracle variant; add `--limit N` for an evenly-strided subsample.
|
||||
|
||||
### Session-Level Recall (n=500)
|
||||
### Full haystack — `longmemeval_s`, n=500 (the number to cite)
|
||||
|
||||
| Metric | ClawhDF5 (BM25-only) |
|
||||
|--------|---------------------|
|
||||
| Hit@1 | **100.0%** |
|
||||
| Hit@5 | **100.0%** |
|
||||
| Hit@10 | **100.0%** |
|
||||
| MRR | **1.0000** |
|
||||
47.7 sessions and 493.5 turns per question; 4.0% of haystack sessions are evidence
|
||||
sessions, so retrieval has to actually discriminate.
|
||||
|
||||
Perfect session-level recall across all 500 questions and all 6 question types.
|
||||
| Metric | Turn-level | Session-level |
|
||||
|--------|-----------|---------------|
|
||||
| Hit@1 | 53.8% | 86.2% |
|
||||
| Hit@5 | **75.0%** | **93.6%** |
|
||||
| Hit@10 | 81.6% | 96.6% |
|
||||
| MRR | 0.6320 | 0.8948 |
|
||||
|
||||
### Turn-Level Recall (n=500)
|
||||
Session-level is reported here because on this corpus it is meaningful — unlike on
|
||||
the oracle variant, where it was degenerate and was retracted (below). At 4.0%
|
||||
evidence density a session-level hit reflects discrimination rather than corpus
|
||||
shape.
|
||||
|
||||
| Metric | ClawhDF5 (BM25-only) | MemX (full system)¹ |
|
||||
|--------|---------------------|---------------------|
|
||||
| Hit@1 | **52.6%** | — |
|
||||
| Hit@5 | **84.4%** | 51.6% |
|
||||
| Hit@10 | **90.4%** | — |
|
||||
| MRR | **0.6597** | 0.380 |
|
||||
Per-type, session-level: `single-session-assistant` 100.0% Hit@1 (n=56),
|
||||
`knowledge-update` 96.2% (n=78), `single-session-user` 94.3% (n=70),
|
||||
`multi-session` 84.2% (n=133), `temporal-reasoning` 84.2% (n=133), and
|
||||
`single-session-preference` 33.3% (n=30) — the one category where BM25 clearly
|
||||
struggles, since a preference question's evidence rarely shares vocabulary with
|
||||
the question.
|
||||
|
||||
**clawhdf5 outperforms MemX at turn-level retrieval** — Hit@5 84.4% vs 51.6%, MRR 0.66 vs 0.38 — with BM25 alone, no embeddings needed.
|
||||
### Retrieval mode ablation — full haystack, n=500
|
||||
|
||||
> ¹ MemX uses dense embeddings + FTS5 + four-factor re-ranking. Our BM25-only result exceeds their full pipeline.
|
||||
Real 384-d `all-MiniLM-L6-v2` embeddings, 190,015 unique texts encoded once on an
|
||||
RTX 5060 Ti (~13 min; the same work on the 8-core CPU was still unfinished after
|
||||
30 minutes, so the GPU path is not a convenience here). Turn-level:
|
||||
|
||||
### Per-Type Breakdown (session-level)
|
||||
| Mode | Hit@1 | Hit@5 | Hit@10 | MRR |
|
||||
|------|-------|-------|--------|-----|
|
||||
| BM25 only (`0.0`/`1.0`) | **53.8%** | 75.0% | 81.6% | **0.6320** |
|
||||
| Vector only (`1.0`/`0.0`) | 36.0% | 71.8% | 81.6% | 0.5027 |
|
||||
| Hybrid (`0.7`/`0.3`) | 44.4% | **79.2%** | **86.0%** | 0.5868 |
|
||||
|
||||
| Question Type | N | Hit@1 | Hit@5 | Hit@10 | MRR |
|
||||
|---------------|---|-------|-------|--------|-----|
|
||||
| single-session-user | 70 | 100.0% | 100.0% | 100.0% | 1.0000 |
|
||||
| single-session-assistant | 56 | 100.0% | 100.0% | 100.0% | 1.0000 |
|
||||
| single-session-preference | 30 | 100.0% | 100.0% | 100.0% | 1.0000 |
|
||||
| temporal-reasoning | 133 | 100.0% | 100.0% | 100.0% | 1.0000 |
|
||||
| multi-session | 133 | 100.0% | 100.0% | 100.0% | 1.0000 |
|
||||
| knowledge-update | 78 | 100.0% | 100.0% | 100.0% | 1.0000 |
|
||||
Session-level:
|
||||
|
||||
| Mode | Hit@1 | Hit@5 | Hit@10 | MRR |
|
||||
|------|-------|-------|--------|-----|
|
||||
| BM25 only | 86.2% | 93.6% | 96.6% | 0.8948 |
|
||||
| Vector only | 85.4% | 94.2% | 96.6% | 0.8901 |
|
||||
| Hybrid | **88.2%** | **95.8%** | **97.8%** | **0.9158** |
|
||||
|
||||
### Weight sweep — full haystack, n=500
|
||||
|
||||
`0.7/0.3` was a documented default, never a searched one. Sweeping
|
||||
`vector_weight` from 0.0 to 1.0 (`--sweep`, reusing the one-time embedding
|
||||
table) shows it is not merely suboptimal but **strictly dominated**:
|
||||
|
||||
| vector / keyword | Hit@1 | Hit@5 | Hit@10 | MRR | session Hit@5 |
|
||||
|---|---|---|---|---|---|
|
||||
| 0.0 / 1.0 (BM25) | **53.8%** | 75.0% | 81.6% | 0.6320 | 93.6% |
|
||||
| 0.1 / 0.9 | 53.2% | 77.4% | 83.8% | 0.6374 | 95.0% |
|
||||
| 0.2 / 0.8 | 53.6% | 78.2% | 85.6% | 0.6440 | 95.4% |
|
||||
| 0.3 / 0.7 | 53.2% | 78.8% | 87.2% | **0.6463** | 96.0% |
|
||||
| **0.4 / 0.6** | 51.6% | **81.4%** | 87.8% | 0.6429 | 96.8% |
|
||||
| 0.5 / 0.5 | 48.2% | **81.4%** | **88.2%** | 0.6234 | **97.4%** |
|
||||
| 0.6 / 0.4 | 46.6% | 79.8% | 87.4% | 0.6069 | 96.6% |
|
||||
| 0.7 / 0.3 *(old default)* | 44.4% | 79.2% | 86.0% | 0.5868 | 95.8% |
|
||||
| 0.8 / 0.2 | 40.6% | 76.2% | 85.4% | 0.5571 | 95.2% |
|
||||
| 0.9 / 0.1 | 37.8% | 73.4% | 84.6% | 0.5289 | 94.2% |
|
||||
| 1.0 / 0.0 (vector) | 36.0% | 71.8% | 81.6% | 0.5027 | 94.2% |
|
||||
|
||||
**`0.4/0.6` beats `0.7/0.3` on every metric at both granularities** — Hit@1
|
||||
+7.2pp, Hit@5 +2.2, Hit@10 +1.8, MRR +0.056. There is no trade being made; the
|
||||
old default was simply on the wrong side of the peak. **`0.4/0.6` is the
|
||||
recommended setting**, with `0.3/0.7` preferable if rank-1 precision matters
|
||||
most (it takes the best MRR in the sweep and gives up only 0.6pp of Hit@1
|
||||
against pure BM25).
|
||||
|
||||
**Correction.** An earlier revision of this section, measuring only `0.7/0.3`,
|
||||
concluded that fusion "buys deeper recall and pays for it at rank 1" and advised
|
||||
callers taking a single top hit to prefer BM25. That was an artifact of the
|
||||
badly-chosen weight, not a property of fusion. At `0.3/0.7` hybrid *beats* BM25
|
||||
on MRR (0.6463 vs 0.6320) and on Hit@5 (78.8% vs 75.0%) while costing 0.6pp of
|
||||
Hit@1. The advice below is corrected accordingly.
|
||||
|
||||
**Hybrid wins, once the weights are right.** At the old `0.7/0.3` the picture
|
||||
looked like a trade: best at Hit@5 and Hit@10, worse than BM25 at Hit@1 and MRR.
|
||||
The sweep above shows that was the weight, not fusion. At `0.4/0.6` hybrid leads
|
||||
Hit@5 and Hit@10 outright; at `0.3/0.7` it also leads MRR and is within 0.6pp of
|
||||
BM25 at Hit@1. Both dominate `0.7/0.3`.
|
||||
|
||||
The rows below are kept at the three original settings because they are what the
|
||||
mode ablation measured — read them as "the shape of each stage in isolation",
|
||||
and take the operating point from the sweep.
|
||||
|
||||
The same pattern shows up independently in omni-cortex's four-signal RRF ablation,
|
||||
where adding BM25 to a dense retriever raised nDCG@5 while lowering Hit@1 and MRR.
|
||||
Two different codebases, two different fusion schemes, same direction.
|
||||
|
||||
Vector-only being *worse* than BM25 at every turn-level cutoff except Hit@10 is
|
||||
worth stating plainly rather than hiding: LongMemEval questions share substantial
|
||||
vocabulary with their evidence turns, which is close to the best case for lexical
|
||||
matching, and MiniLM at 384 dimensions is a small embedding model.
|
||||
|
||||
> **Run:** `cargo run --release --bin longmemeval_bench --features embeddings -- \
|
||||
> benchmarks/longmemeval/longmemeval_s_cleaned.json --embeddings weights/all-minilm-l6-v2`
|
||||
> For the GPU path use `--features embeddings-cuda`. That requires `nvcc` on
|
||||
> `PATH` at *build* time — cudarc's build script shells out to it. The toolkit
|
||||
> installs to `/usr/local/cuda/bin`, which many distributions do not export;
|
||||
> check with `nvcc --version` and, if it is missing, add it somewhere every
|
||||
> shell reads (for zsh that is `~/.zshenv`, not `~/.zshrc`, since build tooling
|
||||
> runs non-interactively). The device is selected at runtime with a CPU
|
||||
> fallback, so a machine without CUDA still produces correct numbers — just far
|
||||
> more slowly, and the bench says so on startup.
|
||||
>
|
||||
> Weights: `huggingface.co/sentence-transformers/all-MiniLM-L6-v2` — place
|
||||
> `model.safetensors` and `tokenizer.json` in the `--embeddings` directory.
|
||||
|
||||
### Oracle variant — `longmemeval_oracle`, n=500 (easier corpus, kept for continuity)
|
||||
|
||||
| Metric | ClawhDF5 (BM25-only, oracle variant) |
|
||||
|--------|--------------------------------------|
|
||||
| Hit@1 | 52.6% |
|
||||
| Hit@5 | **84.4%** |
|
||||
| Hit@10 | 90.4% |
|
||||
| MRR | 0.6597 |
|
||||
|
||||
Turn-level. The 9.4-point gap between this and the full haystack's 75.0% is the
|
||||
price of the harder corpus, and is the reason oracle-only numbers should not be
|
||||
presented as LongMemEval results. Session-level figures on this variant are
|
||||
degenerate — see below.
|
||||
|
||||
With real embeddings the same oracle corpus gives BM25-only 84.2% / vector-only
|
||||
80.4% / hybrid **85.2%** Hit@5 turn-level — hybrid ahead at Hit@5 and Hit@10 and
|
||||
behind at Hit@1, matching the full-haystack pattern above. (BM25-only reads 84.2%
|
||||
here against 84.4% with zero embedding vectors: one question of 500 changes rank,
|
||||
with MRR identical at 0.6597. On the full haystack the two agree exactly.)
|
||||
|
||||
### Retracted: session-level recall and the MemX comparison
|
||||
|
||||
Earlier revisions of this file reported session-level Hit@1/5/10 of **100.0%** with
|
||||
MRR **1.0000**, uniform across all six question types, and claimed clawhdf5
|
||||
"outperforms MemX at turn-level retrieval (84.4% vs 51.6%)". **Both are withdrawn.**
|
||||
|
||||
**The session-level numbers are a degenerate artifact.** On the `longmemeval_oracle`
|
||||
variant, the ingested haystack for a question consists essentially only of that
|
||||
question's evidence sessions. Every returned document therefore belongs to an answer
|
||||
session, so session-level hit rate is ≈1.0 at rank 0 *by construction* — which is
|
||||
exactly why the result was a uniform 100.0% across every question type. It measured
|
||||
the shape of the corpus, not the retriever.
|
||||
|
||||
**The MemX comparison was not like-for-like on two independent axes.** MemX
|
||||
([arxiv:2603.16171](https://arxiv.org/abs/2603.16171)) reports Hit@5 = 51.6% /
|
||||
MRR = 0.380 at **fact-level granularity over 220,349 fact-level records drawn from
|
||||
19,195 sessions**, and explicitly notes that fact-level "doubl[es] session-level
|
||||
performance." Our 84.4% is **turn-level, on the oracle subset**. Different retrieval
|
||||
granularity, and a corpus smaller by orders of magnitude. A higher number on an
|
||||
easier corpus at a different granularity is not an outperformance claim, and it
|
||||
should not have been presented as one.
|
||||
|
||||
The full-haystack half of that gap is now closed: the section above reports
|
||||
`longmemeval_s` over all 500 questions. The **granularity** mismatch remains — MemX
|
||||
measures fact-level, we measure turn-level and session-level — so no cross-system
|
||||
claim is made here even now. Matching granularity would require fact-level
|
||||
extraction over the haystack, which this harness does not do.
|
||||
|
||||
### Search Latency (LongMemEval, n=500 queries)
|
||||
|
||||
@@ -368,6 +759,54 @@ No network hop, no serialization — direct HashMap operations.
|
||||
|
||||
---
|
||||
|
||||
## World-Model Sample Loading (vs h5py / stable-worldmodel shape)
|
||||
|
||||
Reproduces the access pattern of `stable-worldmodel`'s HDF5 dataloader
|
||||
([arXiv 2605.21800](https://arxiv.org/abs/2605.21800), LeCun/Balestriero
|
||||
group), which supports HDF5 as one of three native formats and measures
|
||||
generic HDF5 at **1,416-1,474 samples/s** (vs Lance 4,815) for per-frame
|
||||
sample loading. This benchmark measures **clawhdf5 vs h5py on the same
|
||||
machine and the same file**, so the comparison is hardware-controlled.
|
||||
|
||||
**Absolute numbers are not comparable to the paper's** - different hardware
|
||||
(AMD Ryzen 7 7800X3D, local NVMe, warm page cache), smaller frames, and no
|
||||
torch-tensor / transform step. Only the clawhdf5-vs-h5py ratio *here* is a
|
||||
controlled result. The workload is the dataloader shape: a `(N, H, W, C)`
|
||||
uint8 observation dataset (20,000 x 64x64x3 = 246 MB), each frame read once
|
||||
per pass in a fixed shuffled (random-access) order, 10 passes.
|
||||
|
||||
Both read a **file written by h5py** - clawhdf5 parsing an
|
||||
externally-produced HDF5 file is itself the interop result. h5py opens SWMR
|
||||
with a 256 MB chunk cache, exactly `stable-worldmodel`'s `HDF5Dataset`; it
|
||||
materialises each frame as a numpy array (`d[i]`) and sums it. clawhdf5
|
||||
mmaps once, takes a zero-copy `&[u8]` over the contiguous dataset, and
|
||||
indexes frame `i` as a subslice.
|
||||
|
||||
| Reader | samples/sec (median of 3) | vs h5py |
|
||||
|--------|---------------------------|---------|
|
||||
| **clawhdf5** (zero-copy view) | **593,000** | **8.1x** |
|
||||
| **clawhdf5** (materialised copy per frame) | **518,000** | **7.1x** |
|
||||
| h5py (swmr, 256 MB cache) | 73,000 | 1.0x |
|
||||
|
||||
The **materialised-copy row is the fair, equal-work comparison** - it
|
||||
`to_vec()`s every frame so clawhdf5 pays the same per-frame allocation h5py
|
||||
does, and it is still **7.1x faster**. That the copy costs almost nothing
|
||||
(518k vs 593k) shows the h5py gap is **per-frame call overhead** (Python +
|
||||
library dispatch), not data movement. This is an in-page-cache measurement:
|
||||
it isolates the read-path overhead both libraries add on top of the OS,
|
||||
which is the thing that differs - not disk bandwidth, which is shared.
|
||||
|
||||
Reproduce (`benchmarks/`):
|
||||
|
||||
```bash
|
||||
python benchmarks/gen_worldmodel_frames.py /tmp/wm_frames.h5 20000
|
||||
cargo run --release -p clawhdf5-bench --example worldmodel_sampling -- /tmp/wm_frames.h5 10
|
||||
cargo run --release -p clawhdf5-bench --example worldmodel_sampling -- /tmp/wm_frames.h5 10 --copy
|
||||
python benchmarks/bench_worldmodel_h5py.py /tmp/wm_frames.h5 10
|
||||
```
|
||||
|
||||
Measured 2026-08-07 on tank (Ryzen 7 7800X3D, 246 MB dataset in page cache).
|
||||
|
||||
## Cross-Platform Notes
|
||||
|
||||
> **Run:** `./benchmarks/cross_platform.sh [--full] [--output results.json]`
|
||||
@@ -394,3 +833,372 @@ cargo run --release --bin footprint_bench
|
||||
cargo run --release --bin consolidation_efficiency
|
||||
cargo run --release --bin ephemeral_perf
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## h5bench-Equivalent I/O Benchmarks
|
||||
|
||||
Criterion harness mirroring h5bench serial workloads. clawhdf5 benchmarks dated 2026-07-01;
|
||||
libhdf5 1.14.6 head-to-head comparison dated 2026-06-30 (same hardware, same Criterion harness).
|
||||
|
||||
```bash
|
||||
cargo bench -p clawhdf5-bench # clawhdf5-only
|
||||
cargo bench -p clawhdf5-bench --features libhdf5-compare # head-to-head
|
||||
```
|
||||
|
||||
### Sequential Read Throughput
|
||||
|
||||
Both read a 1-D contiguous f32 dataset. clawhdf5 parses from `Vec<u8>` (zero-copy);
|
||||
libhdf5 reads from a temp file including `open` + `read` + `close` overhead.
|
||||
|
||||
| Workload | n=1K | n=10K | n=100K |
|
||||
|----------|------|-------|--------|
|
||||
| **clawhdf5** f32 | 634 ns / **5.9 GiB/s** | 2.44 µs / **15.3 GiB/s** | 24.5 µs / **15.2 GiB/s** |
|
||||
| libhdf5 f32 | 45.2 µs / 85 MiB/s | 47.8 µs / 799 MiB/s | 73.9 µs / 5.0 GiB/s |
|
||||
| **Speedup** | **71×** | **20×** | **3.0×** |
|
||||
| clawhdf5 f64 | 743 ns / **10.0 GiB/s** | 4.17 µs / **17.8 GiB/s** | 43.3 µs / **17.2 GiB/s** |
|
||||
| clawhdf5 from_disk (f64, OS I/O) | — | 10.1 µs / **7.4 GiB/s** | 77.6 µs / **9.6 GiB/s** |
|
||||
| clawhdf5 hyperslab (f64, 10% slice) | — | 4.09 µs / **1.8 GiB/s** | 50.1 µs / **1.5 GiB/s** |
|
||||
|
||||
libhdf5 f64 comparison excluded — clawhdf5's datatype encoding differs from libhdf5's (known
|
||||
gap), making cross-format reads unreliable for comparison.
|
||||
|
||||
### Chunked Read Throughput
|
||||
|
||||
| Matrix size | Latency | Throughput |
|
||||
|-------------|---------|-----------|
|
||||
| 64×64 f32 | 6.39 µs | **2.4 GiB/s** |
|
||||
| 256×256 f32 | 41.7 µs | **5.9 GiB/s** |
|
||||
| 512×512 f32 | 176 µs | **5.5 GiB/s** |
|
||||
|
||||
### Sequential Write Throughput
|
||||
|
||||
Both write to disk. At 100K elements both converge on the OS `write()` syscall ceiling.
|
||||
|
||||
| Workload | n=1K | n=10K | n=100K |
|
||||
|----------|------|-------|--------|
|
||||
| **clawhdf5** f32 | 9.44 µs / **404 MiB/s** | 25 µs / **1.49 GiB/s** | 228 µs / **1.63 GiB/s** |
|
||||
| libhdf5 f32 | 77.9 µs / 49 MiB/s | 87.8 µs / 435 MiB/s | 214 µs / 1.74 GiB/s |
|
||||
| **Speedup** | **8.2×** | **3.5×** | **≈ tie** |
|
||||
| clawhdf5 f64 embeddings | 6.50 µs (n=128) | 8.67 µs (n=512) / **450 MiB/s** | 10.27 µs (n=1K) / **761 MiB/s** |
|
||||
|
||||
### Chunked Write: Codec Comparison (with auto-shuffle)
|
||||
|
||||
Auto-shuffle is applied before all compression codecs by default — AoS→SoA byte transpose,
|
||||
implements byte-grouping pre-filter per arXiv:2506.18062. Shuffle dramatically improves
|
||||
throughput for float/int data by creating long runs of similar bytes.
|
||||
|
||||
| Matrix size | Zstd-3 + shuffle | Deflate-6 + shuffle | Speedup |
|
||||
|-------------|-----------------|---------------------|---------|
|
||||
| 32×32 f32 | 48 µs / **81 MiB/s** | 39 µs / **100 MiB/s** | Deflate 1.23× faster (small chunk) |
|
||||
| 128×128 f32 | **148 µs / 422 MiB/s** | 153 µs / **407 MiB/s** | Parity |
|
||||
| 512×512 f32 | **1.34 ms / 748 MiB/s** | 1.39 ms / **719 MiB/s** | Zstd 1.04× faster |
|
||||
|
||||
Impact of auto-shuffle vs no-shuffle baseline:
|
||||
|
||||
| Matrix size | Zstd-3 speedup | Deflate-6 speedup |
|
||||
|-------------|----------------|-------------------|
|
||||
| 32×32 | +19% | +38% |
|
||||
| 128×128 | +25% | **+204%** |
|
||||
| 512×512 | +25% | **+157%** |
|
||||
|
||||
Both codecs perform at parity at large sizes (~720–750 MiB/s). Use `.with_zstd(3)` or
|
||||
`.with_deflate(6)` for write-heavy workloads. Use `.without_shuffle()` only for byte arrays
|
||||
or data that doesn't benefit from AoS→SoA transposition.
|
||||
|
||||
### Chunked Write vs libhdf5 (deflate-6)
|
||||
|
||||
clawhdf5 compresses all chunks in memory and issues a single `write()`. libhdf5 flushes each
|
||||
chunk individually via its Virtual File Layer (one `pwrite()` per chunk).
|
||||
|
||||
| Matrix | clawhdf5 deflate-6 + shuffle | libhdf5 deflate-6 | Speedup |
|
||||
|--------|------------------------------|-------------------|---------|
|
||||
| 32×32 f32 | 39 µs / 100 MiB/s | 172 µs / 23 MiB/s | **4.4×** |
|
||||
| 128×128 f32 | 153 µs / 407 MiB/s | 3,150 µs / 20 MiB/s | **20.6×** |
|
||||
| 512×512 f32 | 1,390 µs / 719 MiB/s | 53,300 µs / 19 MiB/s | **38.4×** |
|
||||
|
||||
The 32×32 speedup (4.4×) is lower than the 512×512 speedup (38.4×) because shuffle adds
|
||||
overhead that dominates at 4 KB chunks. libhdf5 was benchmarked without shuffle. The speedup
|
||||
compounds with matrix size because libhdf5's per-chunk VFL overhead is proportional to chunk
|
||||
count while clawhdf5's single-pass cost is constant.
|
||||
|
||||
### Codec Comparison: Pcodec vs Zstd-3
|
||||
|
||||
Pcodec (arXiv:2502.06112) is a pure-Rust lossless numerical codec with 30–94% better compression
|
||||
ratio than Zstd for f32/f64 columns. Both sides benchmarked **without** auto-shuffle here (shuffle
|
||||
degrades Pcodec which handles byte organization internally; Zstd-3 without shuffle numbers shown
|
||||
for an apples-to-apples comparison).
|
||||
|
||||
| Matrix size | Pcodec | Zstd-3 (no shuffle) | Winner |
|
||||
|-------------|--------|---------------------|--------|
|
||||
| 32×32 f32 | 95 µs / **41 MiB/s** | 57 µs / **68 MiB/s** | Zstd-3 (1.66×) |
|
||||
| 128×128 f32 | 528 µs / **118 MiB/s** | 179 µs / **349 MiB/s** | Zstd-3 (2.95×) |
|
||||
| 512×512 f32 | 1.69 ms / **591 MiB/s** | 1.64 ms / **610 MiB/s** | Parity (3% diff) |
|
||||
|
||||
Pcodec's fixed per-chunk distributional analysis overhead (~400 µs) dominates at 32×32 (4 KB).
|
||||
At 512×512 (1 MB) the speeds converge. **Pcodec's advantage is compression ratio, not encode
|
||||
speed** — less data on disk means faster reads and lower storage cost. Enable with
|
||||
`.with_pcodec()` for write-once/read-many workloads (embedding archives, scientific datasets).
|
||||
|
||||
### Metadata Throughput
|
||||
|
||||
clawhdf5 accumulates all metadata in memory and serializes in one pass. libhdf5 acquires a
|
||||
global file mutex and flushes to disk on every attribute write or group creation.
|
||||
|
||||
**Attributes and datasets** (k = attribute or dataset count):
|
||||
|
||||
| Workload | k=4 | k=16 | k=64 | k=128 |
|
||||
|----------|-----|------|------|-------|
|
||||
| **clawhdf5** attrs_write (i64) | 8.05 µs / 494 Kop/s | 17.2 µs / 932 Kop/s | 49.2 µs / 1.30 Mop/s | 87.3 µs / 1.47 Mop/s |
|
||||
| libhdf5 attrs_write | 100 µs / 40 Kop/s | 170 µs / 94 Kop/s | 472 µs / 136 Kop/s | 929 µs / 138 Kop/s |
|
||||
| **Speedup** | **12.4×** | **9.9×** | **9.6×** | **10.6×** |
|
||||
| clawhdf5 attrs_read | 1.06 µs / 3.78 Mop/s | 3.64 µs / 4.39 Mop/s | 15.7 µs / 4.08 Mop/s | 31.3 µs / 4.09 Mop/s |
|
||||
| clawhdf5 string_attrs (write+read) | 5.17 µs / 774 Kop/s | 16.5 µs / 967 Kop/s | 33.6 µs / 951 Kop/s | — |
|
||||
| clawhdf5 multi_dataset_write | 10.1 µs / 397 Kop/s | 31.5 µs / 508 Kop/s | 104 µs / 614 Kop/s | — |
|
||||
|
||||
**Groups** (k = group count):
|
||||
|
||||
| Workload | k=4 | k=16 | k=32 | k=64 |
|
||||
|----------|-----|------|------|------|
|
||||
| **clawhdf5** groups_create | 12.1 µs / 330 Kop/s | 33.7 µs / 475 Kop/s | 66.7 µs / 480 Kop/s | 121 µs / 529 Kop/s |
|
||||
| libhdf5 groups_create | 140 µs / 28 Kop/s | 433 µs / 37 Kop/s | 690 µs / 46 Kop/s | 1,340 µs / 48 Kop/s |
|
||||
| **Speedup** | **11.6×** | **12.8×** | **9.5×** | **11.1×** |
|
||||
| clawhdf5 groups_traverse | 664 ns / 6.0 Mop/s | 3.55 µs / 4.5 Mop/s | 4.87 µs / 6.6 Mop/s | 10.6 µs / 6.0 Mop/s |
|
||||
|
||||
---
|
||||
|
||||
## vs libhdf5 Summary
|
||||
|
||||
| Workload | clawhdf5 | libhdf5 | Speedup |
|
||||
|----------|----------|---------|---------|
|
||||
| Sequential read, 1K f32 | 634 ns | 45.2 µs | **71×** |
|
||||
| Sequential read, 100K f32 | 24.5 µs · 15.2 GiB/s | 73.9 µs · 5.0 GiB/s | **3.0×** |
|
||||
| Sequential write, 100K f32 | 228 µs · 1.63 GiB/s | 214 µs · 1.74 GiB/s | **≈ tie** |
|
||||
| Chunked write deflate-6, 512×512 | 1,390 µs · 719 MiB/s | 53,300 µs · 19 MiB/s | **38.4×** |
|
||||
| Attribute write, 128 attrs | 87.3 µs · 1.47 Mop/s | 929 µs · 138 Kop/s | **10.6×** |
|
||||
| Group create, 64 groups | 121 µs · 529 Kop/s | 1,340 µs · 48 Kop/s | **11.1×** |
|
||||
|
||||
### Why the Gaps
|
||||
|
||||
**Metadata (10–13×):** libhdf5 was designed for MPI parallel filesystems where every metadata
|
||||
write must be immediately visible to other processes. It acquires a global file mutex and
|
||||
flushes to disk per operation. clawhdf5 builds the entire file in memory and writes it in one
|
||||
shot — no locking, no flushing, no C heap allocation per message.
|
||||
|
||||
**Chunked compressed write (4–38×):** libhdf5 writes each chunk individually through its VFL
|
||||
(Virtual File Layer), one `pwrite()` per chunk. clawhdf5 compresses all chunks in memory (Rayon
|
||||
parallel when > 2 chunks), lays them out contiguously, and issues a single `write()`. The
|
||||
speedup compounds with matrix size: libhdf5's per-chunk overhead is proportional to chunk count
|
||||
while clawhdf5's architectural cost is constant.
|
||||
|
||||
**Small reads (20–71×):** libhdf5's per-open overhead (chunk cache init, SWMR lock, metadata
|
||||
read) dominates at sub-millisecond payloads. clawhdf5 has no global state — `File::from_bytes()`
|
||||
starts parsing immediately.
|
||||
|
||||
**Large contiguous writes (≈ tie at 100K):** Both are bottlenecked by the OS `write()` syscall
|
||||
to the page cache. There is no algorithmic headroom above ~1.7 GiB/s on this hardware.
|
||||
|
||||
### Caveats
|
||||
|
||||
- libhdf5 f64 read comparison excluded — clawhdf5's f32 datatype encoding differs from libhdf5's (known compatibility gap). f64 results are clawhdf5-only.
|
||||
- Serial benchmarks. clawhdf5 uses Rayon for chunk compression when > 2 chunks; that parallelism is already reflected in the chunked write numbers.
|
||||
- clawhdf5 reads from `Vec<u8>` (zero-copy from mmap in production); libhdf5 reads from a temp file. This gives clawhdf5 a structural read advantage that reflects realistic API usage.
|
||||
|
||||
---
|
||||
|
||||
## Independent Validation: tank (Ryzen 7 7800X3D), 2026-08-03
|
||||
|
||||
The `vs libhdf5 Summary` numbers above were re-run on a second, independently
|
||||
administered machine (`tank`: AMD Ryzen 7 7800X3D, 8C/16T, Ubuntu 26.04, libhdf5
|
||||
1.14.6 via `apt`) to confirm they reproduce off the original i7-12650H box, and to
|
||||
add benchmark coverage for two claims that a documentation review found were not
|
||||
traceable to any dated benchmark run (see git history around 2026-08-03 for context).
|
||||
This section documents both.
|
||||
|
||||
### Reproduction of the vs-libhdf5 Summary table
|
||||
|
||||
| Workload | clawhdf5 (tank) | libhdf5 (tank) | Speedup (tank) | Speedup (i7-12650H, above) |
|
||||
|----------|-----------------|-----------------|----------------|------------------------------|
|
||||
| Sequential read, 1K f32 | 553 ns | 44.2 µs | **79.9×** | 71× |
|
||||
| Sequential read, 100K f32 | 23.3 µs | 63.6 µs | **2.7×** | 3.0× |
|
||||
| Sequential write, 100K f32 | 210 µs | 189 µs | **≈ tie** (clawhdf5 ~11% behind) | ≈ tie (clawhdf5 ~7% behind) |
|
||||
| Chunked write deflate-6, 512×512 | 1.44 ms | 65.0 ms | **45.3×** | 38.4× |
|
||||
| Attribute write, 128 attrs | 85.2 µs | 877 µs | **10.3×** | 10.6× |
|
||||
| Group create, 64 groups | 130 µs | 1.37 ms | **10.6×** | 11.1× |
|
||||
|
||||
Five of six rows land within ~15% of the original i7-12650H figures — consistent
|
||||
with normal cross-machine variance, not a methodology artifact. The chunked-write
|
||||
row moved further (38.4× → 45.3×, +18%): tank's libhdf5 per-chunk write cost scales
|
||||
worse relative to its own sequential-write throughput than on the i7, likely IPC/
|
||||
memory-subsystem dependent. Both figures are real and dated; we report both rather
|
||||
than picking one.
|
||||
|
||||
### New coverage: replacing the retracted "metadata parse / 308×" and "zero-copy mmap / 313 ns" claims
|
||||
|
||||
An earlier README revision cited `19 ns` vs `2,080 µs` (labeled, incorrectly, `308×`)
|
||||
for "metadata parse," and `313 ns` for "zero-copy mmap" — neither figure traced to
|
||||
any benchmark in this file. Both have been retracted from the README. In their
|
||||
place, two new Criterion benchmarks were added
|
||||
(`crates/clawhdf5-bench/benches/h5bench_meta.rs`,
|
||||
`crates/clawhdf5-bench/benches/h5bench_read.rs`) and run on tank:
|
||||
|
||||
**`metadata_open_from_disk`** — opens a small file from disk (`std::fs::read` /
|
||||
`hdf5::File::open`) and resolves one attribute. Both sides pay real OS I/O, unlike
|
||||
the retracted claim.
|
||||
|
||||
| Operation | clawhdf5 | libhdf5 | Speedup |
|
||||
|-----------|----------|---------|---------|
|
||||
| Open file + read 1 attribute | 4.01 µs | 39.3 µs | **9.8×** |
|
||||
|
||||
**`metadata_parse_in_memory`** (clawhdf5-only) — times `File::from_bytes()` alone,
|
||||
given bytes already resident in memory, i.e. header-parse cost with disk I/O
|
||||
excluded. There is no fair libhdf5-side equivalent (its API has no "parse from an
|
||||
in-memory buffer, skip the OS open" path), so this is reported standalone rather
|
||||
than as a speedup multiple — this is the honest version of what the old `19 ns`
|
||||
number was trying to claim.
|
||||
|
||||
| Operation | clawhdf5 (in-memory, no I/O) |
|
||||
|-----------|------------------------------|
|
||||
| Parse superblock + resolve 1 attribute | 549 ns |
|
||||
|
||||
**`read_zerocopy_mmap`** — opens via `MmapFile` and reads an f64 dataset through
|
||||
`read_f64_zerocopy()`, summing every element to force the mapped pages to actually
|
||||
fault in (returning only a slice length, as an earlier draft of this benchmark did,
|
||||
would repeat the exact "measures nothing" mistake being fixed here).
|
||||
|
||||
| n (f64 elements) | clawhdf5 mmap (zerocopy, page-fault-forced) | clawhdf5 (`Vec<u8>` copy) | libhdf5 (disk open + copy) |
|
||||
|-------------------|----------------------------------------------|----------------------------|------------------------------|
|
||||
| 1,000 | 7.86 µs | 4.50 µs | 44.2 µs |
|
||||
| 10,000 | 19.0 µs | 9.53 µs | 47.1 µs |
|
||||
| 100,000 | 112 µs | 72.0 µs | 81.2 µs |
|
||||
|
||||
Honest result: at these sizes, forcing full materialization through the mmap path
|
||||
is **not** faster than the plain `Vec<u8>` copy path — `mmap()`/page-fault overhead
|
||||
per call outweighs the copy it avoids. This contradicts the retracted `313 ns`
|
||||
claim outright and is a genuinely useful finding: `MmapFile`'s real advantage is
|
||||
avoiding the allocation/copy for large files or sparse access patterns (lower peak
|
||||
RSS, share pages across processes), not raw single-shot read latency at these
|
||||
sizes. No README claim is made from this row; it's recorded here for the record
|
||||
and to keep future readers from reintroducing the old number.
|
||||
|
||||
**Reproduce:**
|
||||
|
||||
```bash
|
||||
cargo bench -p clawhdf5-bench --features libhdf5-compare --bench h5bench_meta -- metadata_open_from_disk
|
||||
cargo bench -p clawhdf5-bench --features libhdf5-compare --bench h5bench_meta -- metadata_parse_in_memory
|
||||
cargo bench -p clawhdf5-bench --features libhdf5-compare --bench h5bench_read -- read_zerocopy_mmap
|
||||
```
|
||||
|
||||
## Independent Validation: tank — LongMemEval & Vector Search (Ryzen 7 7800X3D), 2026-08-05
|
||||
|
||||
Re-running the "LongMemEval Results" and "SIMD & Parallelism" sections above on
|
||||
tank (AMD Ryzen 7 7800X3D, 8C/16T, Ubuntu 26.04, same machine as the
|
||||
vs-libhdf5 validation above) to give both sections the dated, hardware-cited,
|
||||
reproducible citation the top-of-file traceability note flags them as
|
||||
missing.
|
||||
|
||||
### LongMemEval Results (reproduction)
|
||||
|
||||
```bash
|
||||
cd benchmarks/longmemeval
|
||||
wget https://huggingface.co/datasets/xiaowu0162/longmemeval-cleaned/resolve/main/longmemeval_oracle.json
|
||||
cargo run --release --bin longmemeval_bench
|
||||
```
|
||||
|
||||
Recall numbers are deterministic (pure BM25 retrieval over a fixed dataset) and
|
||||
reproduce exactly. Scoring target as declared in the LongMemEval section above:
|
||||
retrieval recall, turn-level, k=10, `longmemeval_oracle` variant, BM25-only.
|
||||
|
||||
| Metric | Turn-Level |
|
||||
|--------|------------|
|
||||
| Hit@1 | 52.6% |
|
||||
| Hit@5 | **84.4%** |
|
||||
| Hit@10 | 90.4% |
|
||||
| MRR | 0.6597 |
|
||||
|
||||
Session-level figures are omitted here — they are degenerate on the oracle variant
|
||||
and have been retracted; see "Retracted: session-level recall and the MemX
|
||||
comparison" above.
|
||||
|
||||
Search latency (hardware-dependent, tank numbers):
|
||||
|
||||
| Metric | avg | p50 | p95 | p99 |
|
||||
|--------|-----|-----|-----|-----|
|
||||
| Latency | 2,431 µs | 2,105 µs | 7,250 µs | 12,018 µs |
|
||||
|
||||
Higher than the i7-12650H figures at the top of this file (avg 1,004 µs) despite
|
||||
tank's faster single-core performance elsewhere in this document — BM25 search
|
||||
latency here scales with per-question haystack size and this run's variance is
|
||||
wider (p99 is ~5x the mean), suggesting this metric is more sensitive to
|
||||
momentary scheduling/cache effects than the flat-array vector-search benchmarks.
|
||||
Recorded as-is rather than smoothed.
|
||||
|
||||
### SIMD & Parallelism (reproduction, with a correction)
|
||||
|
||||
```bash
|
||||
cargo bench -p clawhdf5-agent --bench bench -- "^(strategy_scalar_10k|strategy_simd_10k|strategy_rayon_10k|adaptive_search_10k|simd_cosine_100k|rayon_cosine_100k)$"
|
||||
```
|
||||
|
||||
The original 10K table above compares named benchmarks (`vector_search`,
|
||||
`rayon`, `strategy`) that, on inspection, don't all exercise the same
|
||||
scalar-vs-SIMD-vs-parallel axis the table implies — several of the
|
||||
`simd_cosine_10k`/`sequential_cosine_10k`-style benchmarks actually call the
|
||||
same underlying function under different names. The `adaptive_benches` group's
|
||||
`strategy_scalar_10k` / `strategy_simd_10k` / `strategy_rayon_10k` benchmarks
|
||||
are the ones that genuinely hold the dataset fixed and vary only the
|
||||
`SearchStrategy` enum, so they're the correct apples-to-apples comparison —
|
||||
used here instead.
|
||||
|
||||
| Strategy | Latency (tank) | vs Sequential |
|
||||
|----------|-----------------|----------------|
|
||||
| Sequential (scalar) | 502 µs | 1.0x |
|
||||
| SIMD (auto-vectorized) | 327 µs | **1.53x** |
|
||||
| Rayon (parallel) | 323 µs | **1.55x** |
|
||||
| Adaptive (auto-select) | 339 µs | **1.48x** |
|
||||
|
||||
Honest finding: the speedup from SIMD/parallelism over scalar is real but
|
||||
smaller here (~1.5x) than the i7-12650H figures above (~2.0x). The Ryzen 7
|
||||
7800X3D's large L3 cache (96MB 3D V-Cache) measurably narrows the gap versus a
|
||||
naive scalar loop compared to the i7 — this is a genuine hardware-dependent
|
||||
result, not a regression or measurement error, and is recorded rather than
|
||||
reconciled away.
|
||||
|
||||
At 100K, no `strategy_*` benchmark exists in the current suite (`adaptive_benches`
|
||||
only covers n=10,000), so this row uses the same `simd_cosine_100k`/
|
||||
`rayon_cosine_100k` benchmarks as the original table — not a true scalar
|
||||
baseline, so no "vs Sequential" multiple is reported for it:
|
||||
|
||||
| Strategy | Latency (tank) |
|
||||
|----------|-----------------|
|
||||
| SIMD | 6.60 ms |
|
||||
| Rayon parallel | 4.73 ms |
|
||||
|
||||
### Vector Search Latency & Comparison to MemX (reproduction)
|
||||
|
||||
```bash
|
||||
cargo bench -p clawhdf5-agent --bench bench -- "^(vector_search_1k|simd_cosine_10k|simd_cosine_100k|prenorm_search_10k|ivf_search_10k_nprobe10|ivf_search_100k_nprobe10|ivf_pq_search_100k|rairs_search_10k_nprobe10|bm25_search_10k)$"
|
||||
```
|
||||
|
||||
| Scale | Flat Search | Pre-norm | IVF (nprobe=10) | IVF-PQ | RAIRS |
|
||||
|-------|-------------|----------|-----------------|--------|-------|
|
||||
| **1K** | 47.8 µs | — | — | — | — |
|
||||
| **10K** | 501 µs | 322 µs | 24.8 µs | — | 109 µs |
|
||||
| **100K** | 6.60 ms | — | 608 µs | 865 µs | — |
|
||||
|
||||
(The 1K Pre-norm cell from the original table has no corresponding benchmark
|
||||
in the current suite — not re-verified, left blank rather than guessed.)
|
||||
|
||||
Same not-like-for-like caveat as the "Comparison to MemX" section at the top of this
|
||||
file applies — MemX's figure is end-to-end, these are a single component. Ratios are
|
||||
an order-of-magnitude indication, not a benchmark result.
|
||||
|
||||
| Metric | MemX (claimed, end-to-end) | ClawhDF5 (tank, component only) | Ratio |
|
||||
|--------|----------------------------|----------------------------------|-------|
|
||||
| 100K flat search | <90 ms | 6.60 ms | ~14x |
|
||||
| 100K IVF-PQ search | — | 865 µs | ~104x |
|
||||
| Keyword search 10K | 1,100x improvement over unindexed | 520 µs (BM25) | Comparable |
|
||||
|
||||
Every figure in this subsection is faster than the corresponding i7-12650H
|
||||
number at the top of this file, consistent with the Ryzen 7 7800X3D's higher
|
||||
single-core throughput and larger cache observed in the vs-libhdf5 validation
|
||||
above.
|
||||
|
||||
+321
-1
@@ -1,6 +1,316 @@
|
||||
# Changelog
|
||||
|
||||
## Unreleased
|
||||
## v2.4.0 (2026-09-19)
|
||||
|
||||
### Upgrade Notes
|
||||
- **Search results improve on upgrade.** The HNSW index now reaches true
|
||||
neighbours it previously could not (recall@10 0.31 -> 0.98 at 100K records on
|
||||
clustered data), so `hybrid_search` rankings change for the better. The agent
|
||||
rebuilds its index from the store automatically; a standalone `HnswIndex`
|
||||
persisted with `to_hdf5_bytes` keeps its old graph until rebuilt.
|
||||
- **`hybrid_search` no longer writes the store.** Hebbian activation boosts are
|
||||
persisted by the next checkpoint (any flushing write, `flush_wal`, or when
|
||||
the `HDF5Memory` is dropped) instead of inside every query; a crash before
|
||||
then forgets only the boosts since the last checkpoint. Activation weights
|
||||
are now capped at 16.
|
||||
- A new sidecar file, `<store>.h5.ann`, holds the vector index graph. It is
|
||||
derived data: safe to delete (the index is rebuilt), copied by `snapshot()`,
|
||||
and worth including when copying a store by hand to avoid a rebuild.
|
||||
- `BM25Index` no longer caches IDF and gained `add_document`,
|
||||
`remove_document`, `pad_to`, `scores`, `len` and `is_empty`; results are now
|
||||
deterministic (ties break by record id).
|
||||
|
||||
### Search
|
||||
- `clawhdf5-ann`: **HNSW recall fix.** Neighbours were chosen as the plain
|
||||
closest-M, which on clustered data (what embeddings look like) turns each
|
||||
cluster into an island: recall@10 was 0.87 / 0.67 / 0.31 at 1K / 10K / 100K
|
||||
vectors and did not improve with `ef`. The index now uses the HNSW paper's
|
||||
diversity heuristic (Algorithm 4 with kept pruned connections) when linking a
|
||||
new node and when pruning back-links: recall@10 at `ef = 64` is 1.00 / 1.00 /
|
||||
0.98 and responds to `ef`. Builds are slower (~3.5x at 10K). Existing
|
||||
persisted indexes keep their old graph until rebuilt; the agent rebuilds its
|
||||
index from the cache, so stores pick this up automatically.
|
||||
- `clawhdf5-agent`: **`hybrid_search` is 23-39x faster in steady state** (p50
|
||||
5.5 -> 0.24 ms at 1K records, 49 -> 2.1 ms at 10K, 884 -> 23 ms at 100K).
|
||||
Every query used to rebuild the BM25 index from scratch and rewrite the whole
|
||||
`.h5` file. The keyword index now lives for the life of the store and is
|
||||
updated incrementally (add / remove / in-place update, exactly equivalent to
|
||||
a fresh build - property-tested), and a query no longer writes the store.
|
||||
**Behaviour change:** Hebbian activation boosts are persisted by the next
|
||||
checkpoint (any flushing write, `flush_wal`, or drop) rather than
|
||||
immediately; a crash in between forgets only the boosts since the last
|
||||
checkpoint. Activation weights are now capped (16.0) - they grew without
|
||||
bound.
|
||||
- `clawhdf5-agent`: **the vector index is persisted**, so `open()` no longer
|
||||
rebuilds it on the first search (first query after open: 2627 -> 15 ms at 10K
|
||||
records, 36 s -> 159 ms at 100K). The HNSW graph — not the vectors, which the
|
||||
store already holds — is written to `<store>.h5.ann` at each checkpoint and
|
||||
tied to it by a generation id in `/meta`; a missing, stale, damaged or
|
||||
structurally invalid sidecar is ignored and the index rebuilt. Records
|
||||
replayed from the WAL join the loaded index incrementally; a replayed update
|
||||
or delete invalidates it. `snapshot()` copies it. Batch saves no longer force
|
||||
a full index rebuild.
|
||||
- `clawhdf5-ann`: faster HNSW build and search with identical recall. The
|
||||
cosine metric stores unit vectors and compares them with a plain dot product
|
||||
(it re-derived both norms on every distance evaluation), and the per-call
|
||||
`HashSet` of visited nodes is a reusable epoch-stamped array. Build 2.75 ->
|
||||
1.89 s at 10K and ~38 -> 21 s at 100K; QPS at `ef = 64` 22.7K -> 39K at 10K.
|
||||
Distances returned by `search` are unchanged (1 - cosine). Indexes loaded
|
||||
from older HDF5 files are normalised on load.
|
||||
- `clawhdf5-accel`: the SIMD backend is detected once per process instead of
|
||||
on every kernel call.
|
||||
- `clawhdf5-ann`: `HnswIndex::graph_to_bytes` / `from_graph_bytes` — graph-only
|
||||
serialization (checksummed, every neighbour id and level validated on load).
|
||||
- `clawhdf5-agent`: a further 4-5x on `hybrid_search` with **identical
|
||||
rankings** (p50 now 0.07 / 0.49 / 4.65 ms at 1K / 10K / 100K — 79x / 100x /
|
||||
190x faster than v2.3.0). Fusion needs every keyword score but not their
|
||||
ranking: new `BM25Index::scores` returns them unsorted from a dense
|
||||
accumulator (it hashed every posting, then sorted every match), and
|
||||
`merge_vector_keyword` selects its top k instead of sorting every candidate.
|
||||
Capping the keyword candidate pool was measured and rejected: it changes the
|
||||
top-10 for most queries (`search_harness --fusion-study`).
|
||||
- `clawhdf5-agent`: BM25 results are deterministic (ties break by record id),
|
||||
top-k uses a bounded heap, and the "WAND early termination" that computed a
|
||||
bound and then ignored it is gone. IDF is computed per query.
|
||||
- `clawhdf5-bench`: new `search_harness` binary — HNSW recall@10 / QPS / latency
|
||||
per `ef` against an exact scan, and end-to-end `hybrid_search` timings, on
|
||||
deterministic clustered (or `--uniform`) data. Baseline in `BENCHMARKS.md`.
|
||||
|
||||
## v2.3.0 (2026-09-19)
|
||||
|
||||
### Upgrade Notes
|
||||
- **A memory store now has a single writer.** `HDF5Memory::create`/`open` take
|
||||
an exclusive lock (`<store>.h5.lock`); a second open of the same store — in
|
||||
the same or another process — returns `MemoryError::Locked`. Code that opened
|
||||
a second handle just to read should use `HDF5Memory::open_read_only`.
|
||||
- **Unsigned array attributes arrive as `AttrValue::U64Array`**, not
|
||||
`I64Array`, and `attrs()` may now return `AttrValue::Raw`. Exhaustive matches
|
||||
on `AttrValue` need the two new arms.
|
||||
- **WAL header version 3 → 4.** v3 files are read and upgraded in place, but a
|
||||
store written by 2.3.0 with a pending WAL cannot be opened by 2.2.0 or
|
||||
earlier (it is refused, not corrupted). Checkpoint first
|
||||
(`flush_wal`) if you need to downgrade.
|
||||
- `MemoryConfig::compression` now uses deflate unless the agent's new `zstd`
|
||||
feature is enabled; it previously failed outright in a default build.
|
||||
- `MemoryError` gained `Locked`; `FormatError` gained `UnresolvedSharedMessage`,
|
||||
`ExternalDataFilesUnsupported` and `ExternalLinkUnsupported`; `MessageType`
|
||||
gained `ExternalDataFiles`.
|
||||
|
||||
### Bug Fixes
|
||||
- `clawhdf5-format`: compound datatypes written with **default libver bounds**
|
||||
(datatype message version 1 — what plain `h5py.File(path, 'w')` produces)
|
||||
were mis-parsed. The v1 member layout carries 28 bytes of legacy array
|
||||
fields after the byte offset (the parser skipped 24), and v2 pads member
|
||||
names to 8 bytes and has no array fields at all (the parser did neither), so
|
||||
every member after the first byte offset was read from the wrong position —
|
||||
typically surfacing as `Overflow("compound member ...")` on read. Found by
|
||||
adding a default-libver axis to the h5py interop tests; byte-level regression
|
||||
tests for v1 and v2 added.
|
||||
- `clawhdf5-gpu`: `gpu_tests` could hang forever under the default parallel
|
||||
test runner — every test created its own wgpu instance and device at once.
|
||||
Tests now serialise GPU access, and GPU→CPU readback waits are bounded
|
||||
(30 s) so a wedged driver returns `GpuError::BufferMap` instead of blocking.
|
||||
- `clawhdf5-agent`: `benches/bench.rs` and `benches/memory_bench.rs` no longer
|
||||
compiled against the current `strategy`/`consolidation` APIs.
|
||||
|
||||
### HDF5 Compatibility
|
||||
- `clawhdf5-format`/`clawhdf5`: datasets and attributes that use a **committed
|
||||
(named) datatype** now read correctly. They store a shared-message reference;
|
||||
the facade parsed the reference bytes as the datatype (`Time { size: 0 }`,
|
||||
unreadable data) and silently dropped such attributes. The shared-reference
|
||||
parser itself was wrong for real files: version 2 has no reserved bytes, and
|
||||
the version 3 types were inverted (1 = SOHM heap, 2 = committed).
|
||||
- **Fill values are applied on read.** There was no Fill Value message parser:
|
||||
the holes of a sparse chunked dataset read as zeros even when the fill value
|
||||
was not zero (silently wrong data), and a dataset that was created but never
|
||||
written failed with `NoDataAllocated` where h5py returns a filled array.
|
||||
Messages v1–v3 and the old 0x0004 form are parsed; the fill value is written
|
||||
into exactly the chunk-grid cells missing from the chunk index.
|
||||
- **Soft links are followed** during path resolution, in old- and new-style
|
||||
groups (absolute/relative targets, links to groups, links through links),
|
||||
with a depth limit so a link cycle is an error rather than a hang. A dangling
|
||||
link reports the target it could not find.
|
||||
- Things the reader does not follow are now explicit errors instead of wrong
|
||||
answers: an external link is `ExternalLinkUnsupported { filename,
|
||||
object_path }` (was `PathNotFound`), and a dataset whose raw data lives in
|
||||
external files (message 0x0007, now a known `MessageType`) is
|
||||
`ExternalDataFilesUnsupported` (it would otherwise read as fill values).
|
||||
- **`attrs()` no longer drops attributes.** Any attribute whose datatype had
|
||||
no `AttrValue` variant was omitted with no error — including every Python
|
||||
`bool` (h5py stores `attrs["flag"] = True` as an enum), complex numbers,
|
||||
compound values and object references. Now:
|
||||
- numpy/h5py-style booleans (an enum of exactly `FALSE`=0 / `TRUE`=1) decode
|
||||
as `I64` / `I64Array` of 0/1;
|
||||
- new `AttrValue::U64Array` keeps unsigned arrays unsigned (they were cast to
|
||||
`I64Array`, so values above `i64::MAX` came back negative). **Behaviour
|
||||
change:** code matching `I64Array` for an unsigned attribute must also
|
||||
match `U64Array` (the netCDF-4 CF helpers and Python bindings do);
|
||||
- new `AttrValue::Raw { datatype, shape, data }` carries everything else
|
||||
verbatim, decodable with `clawhdf5_format::data_read` against `datatype`.
|
||||
Both new variants are writable, so an attribute can be copied between files
|
||||
unchanged. Python receives `Raw` as `{"dtype", "shape", "data"}`.
|
||||
- All of the above are covered by h5py interop tests under both default and
|
||||
`libver='latest'` bounds, compared against h5py's own readback.
|
||||
|
||||
### Security
|
||||
- `clawhdf5`: virtual-dataset source file names are untrusted input but were
|
||||
joined straight onto the opened file's directory, so a crafted file could
|
||||
make the reader open any path the process can reach (absolute path, or `..`
|
||||
components). Only plain relative paths inside that directory are accepted.
|
||||
|
||||
### Durability & Integrity
|
||||
- `clawhdf5-agent`: a crash between writing a checkpoint and truncating the WAL
|
||||
no longer **duplicates every pending entry** on the next open. Each
|
||||
checkpoint records a `WalMark` (byte length + chained CRC of the WAL prefix it
|
||||
folded in) in `/meta`; `open()` skips exactly that prefix when it is still
|
||||
present. No WAL format change for this; older files behave as before.
|
||||
- `clawhdf5-agent`: checkpoints and snapshots are durable as a unit — the temp
|
||||
file is synced before the rename and the directory after it. Individual WAL
|
||||
appends remain unsynced by design (documented in `CLAUDE.md`).
|
||||
- `clawhdf5-agent`: `save_or_update` hits are logged as a new `Update` WAL
|
||||
record, so replay updates in place instead of appending a duplicate. WAL
|
||||
header version 3 → 4 (so older builds refuse the file rather than truncating
|
||||
a record they can't parse); v3 files are read and upgraded in place.
|
||||
- `clawhdf5-agent`: loading validates every per-record dataset length (a
|
||||
truncated store is now `MemoryError::Schema`, not a later panic), fixes the
|
||||
`n.len() == n.len()` tautology that trusted a norms dataset of any length,
|
||||
and rejects `embedding_dim == 0` with records present.
|
||||
- `clawhdf5-agent`: eight behavioural `MemoryConfig` fields are now persisted in
|
||||
`/meta`. Previously they reset to defaults on every open — a compressed store
|
||||
was rewritten uncompressed, `wal_enabled = false` flipped back to `true`.
|
||||
- `clawhdf5-agent`: `compression = true` never worked in a default build (it
|
||||
requested Zstd without enabling the feature, so every checkpoint failed with
|
||||
`unsupported filter: 32015`). Default builds now use deflate; Zstd is the new
|
||||
opt-in `zstd` feature.
|
||||
- `clawhdf5-agent`: **single-writer lock** (`<store>.h5.lock`,
|
||||
`MemoryError::Locked`) — two handles on one store used to silently destroy
|
||||
each other's data. New `HDF5Memory::open_read_only` gives a lock-free,
|
||||
never-writing view; the CLI's read-only subcommands use it.
|
||||
- `clawhdf5-agent`: an unreadable WAL (torn header / bad magic) is quarantined
|
||||
(`HDF5Memory::quarantined_wal()`) instead of blocking `open()` of a healthy
|
||||
store. A WAL from an unknown newer version still fails and is left intact.
|
||||
- `clawhdf5-agent`: provenance records are renumbered on compaction (they
|
||||
weren't, so every later `save_or_update` raised a false High integrity
|
||||
alert); pending anomaly alerts and tracked sessions are bounded;
|
||||
`snapshot()` includes entries still in the WAL.
|
||||
- `clawhdf5-agent`: hybrid ranking is deterministic (index tie-breaks instead
|
||||
of `HashMap` order); a set of identical positive scores — including a single
|
||||
candidate — normalises to 1.0 rather than 0.0; the Hebbian boost no longer
|
||||
reinforces zero-score filler results.
|
||||
- `clawhdf5-format`: chunked/VDS/hyperslab reads size their buffers with
|
||||
overflow-checked arithmetic and fallible allocation, so crafted dimensions
|
||||
are `FormatError::Overflow` instead of a wrapped size or a process abort;
|
||||
`parallel_read` bounds checks use `checked_add`.
|
||||
- `clawhdf5`: a malformed filter-pipeline message is an error instead of being
|
||||
treated as "no filters" (which returned compressed bytes as data);
|
||||
`FileBuilder::write` is atomic and synced instead of truncating the
|
||||
destination first.
|
||||
|
||||
### CI / Testing
|
||||
- CI now lints every target (`cargo clippy --all-targets`) plus
|
||||
`clawhdf5-format`'s optional features, compiles all benches, and tests the
|
||||
format feature matrix. Previously test/bench code and feature-gated modules
|
||||
were never linted; the accumulated clippy backlog is fixed.
|
||||
- CI installs python3 + h5py/numpy/netCDF4/xarray and sets
|
||||
`CLAWHDF5_REQUIRE_INTEROP=1`, which turns a missing interop dependency into a
|
||||
test **failure**. Until now every h5py/netCDF4 interop test silently skipped
|
||||
in CI, which is how the HDF5 2.0 compound bug fixed in v2.2.0 reached a user.
|
||||
The `#[ignore]`d `writer_h5py_tests` suite is run explicitly.
|
||||
- h5py-generated-file tests now cover default libver bounds as well as
|
||||
`libver='latest'` (HDF5 2.0 raised the default low bound to 1.8).
|
||||
- `clawhdf5-agent`: WAL property tests (round trip; after any corruption the
|
||||
entries read back are an exact prefix of what was written — 1500 seeded
|
||||
cases), a crash-recovery matrix (an on-disk image after every operation, the
|
||||
checkpoint window, and the WAL torn at every byte length, each reopened and
|
||||
checked against a model), and a WAL fuzz target.
|
||||
- Optional fuzz smoke run (`CLAWHDF5_FUZZ_SECONDS=N scripts/ci-test.sh`); new
|
||||
datatype corpus seeds for v1 compound and native complex messages.
|
||||
|
||||
## v2.2.0 (2026-09-18)
|
||||
|
||||
### Security
|
||||
- `clawhdf5-format`: bounded decompression output (`MAX_DECOMPRESS_SIZE`) for
|
||||
deflate/lz4/zstd/pcodec so a crafted compressed chunk can't drive an
|
||||
unbounded allocation (memory-exhaustion DoS).
|
||||
- `clawhdf5-format`: `chunked_read.rs`/`data_read.rs`/`local_heap.rs` bounds
|
||||
audit — added `ensure_len` overflow guards at every plain-arithmetic
|
||||
offset+size check, a recursion-depth guard against a crafted
|
||||
self-referencing/cyclic B-tree chunk index, a fix for an unguarded
|
||||
compound-datatype `byte_offset` overrun in `read_compound_fields`, and an
|
||||
`ndims - 1` underflow guard for degenerate zero-dimension chunked layouts.
|
||||
Added a new `fuzz_dataset_read` cargo-fuzz target (walks every dataset in a
|
||||
parsed file and exercises the contiguous/chunked/compact raw-data read
|
||||
paths) which found and fixed 3 real crash bugs — an integer-multiply
|
||||
overflow in `copy_chunk_to_output`'s N-D assembly path, the `ndims - 1`
|
||||
underflow above, and an overflow in `local_heap.rs` — within the first few
|
||||
fuzzing runs.
|
||||
- `clawhdf5-format`: `btree_v1.rs` overflow-safe bounds checks via a local
|
||||
`ensure_len` helper, closing a `usize`-overflow panic reachable from a
|
||||
crafted near-`usize::MAX` B-tree offset.
|
||||
- `clawhdf5-agent`: WAL length-prefix caps (`MAX_WAL_FIELD_LEN`, 64 MiB) reject
|
||||
a corrupted/truncated length claim before allocating. Followed by a full
|
||||
per-entry CRC32 trailer (`WAL_VERSION` bumped to 2) — a bit-flip inside an
|
||||
entry now stops replay cleanly instead of silently accepting corrupted
|
||||
data. Old-format WAL files are still read correctly and migrated to the new
|
||||
format on next open.
|
||||
- `clawhdf5-android`: validate `embedding_len`/`query_embedding_len` against
|
||||
the handle's configured `embedding_dim` (and reject null pointers) before
|
||||
constructing a slice from a raw pointer in `edgehdf5_save` /
|
||||
`edgehdf5_hybrid_search`.
|
||||
- `clawhdf5-py`: bump pyo3/numpy `0.28` → `0.29`, clearing two RUSTSEC
|
||||
advisories (OOB read in `PyList`/`PyTuple` iterator; missing `Sync` bound on
|
||||
`PyCFunction::new_closure`).
|
||||
- Clarified that the integrity hashes in `clawhdf5-agent::provenance`
|
||||
(FNV-1a) and `clawhdf5-format::provenance` (SHA-256) are unkeyed and detect
|
||||
only accidental corruption, not tampering — doc-only change, no behavior
|
||||
change.
|
||||
|
||||
### Performance
|
||||
- `clawhdf5-format`: chunk cache lookup is now O(1) (`slot_index: HashMap`)
|
||||
instead of a linear scan, and cache hits return a shared `Arc` instead of
|
||||
cloning the decompressed buffer — the hottest path in chunked reads.
|
||||
- `clawhdf5-ann`: optional `parallel` feature (rayon) parallelizes HNSW's
|
||||
`prune_connections` neighbor-distance computation. The outer build/insert
|
||||
loop is deliberately left sequential — it has genuine cross-iteration data
|
||||
dependencies and needs its own correctness-focused design pass.
|
||||
- `clawhdf5-format/chunked_read.rs`: removed 12 unnecessary
|
||||
`chunk_dimensions[..rank].to_vec()` allocations where callees already
|
||||
accept `&[u32]`.
|
||||
|
||||
### Architecture
|
||||
- Added `.gitea/workflows/ci.yml`, actually wiring the long-existing
|
||||
`scripts/ci-test.sh` (fmt, clippy, tests, no_std check) into CI on every
|
||||
push/PR to `main`. Fixed stale package names in `ci-test.sh`/
|
||||
`check-nostd.sh` that had been silently no-op'ing the `clawhdf5-py`
|
||||
exclusion and the no_std check.
|
||||
- Fixed a genuine no_std build break in `clawhdf5-format` (uncovered once the
|
||||
no_std CI check actually started running): `core::sync::atomic::AtomicU64`
|
||||
doesn't exist on `thumbv7em-none-eabihf` (switched to `portable-atomic`),
|
||||
missing `alloc` imports for `Box`/`Vec`/`format!` on a few no_std paths, and
|
||||
`f64::powi` (std/libm-only) replaced with a local exponentiation-by-squaring
|
||||
helper in the scale-offset filter.
|
||||
- Added `[workspace.dependencies]` for `tempfile`/`criterion`/`half`/`serde`,
|
||||
fixing a real version skew on `half` (`2` vs `2.7` across crates).
|
||||
- Fixed version skew: `clawhdf5-py` (`pyproject.toml`) and
|
||||
`packages/clawhdf5-node` (`package.json`) were both behind the actual crate
|
||||
version (2.1.0).
|
||||
- Documented that the `mpi-io` feature's read/write paths are root-read
|
||||
+broadcast / gather-to-rank-0, not true collective I/O.
|
||||
|
||||
### Documentation
|
||||
- BENCHMARKS.md: re-ran the previously-undated "LongMemEval Results", "SIMD &
|
||||
Parallelism", and "Vector Search Latency"/"Comparison to MemX" sections on
|
||||
a second machine (tank, Ryzen 7 7800X3D) with explicit dates and reproduce
|
||||
commands. Found and corrected a methodology issue in the SIMD/Parallelism
|
||||
benchmark selection (several originally-compared benchmarks didn't actually
|
||||
isolate the scalar/SIMD/parallel axis).
|
||||
- README.md / ROADMAP.md / CLAUDE.md: corrected several stale facts —
|
||||
the `clawhdf5-types` crate (removed earlier) was still listed in the
|
||||
README crate map; the LongMemEval numbers in the README badge and table
|
||||
didn't match the actual (much better) benchmark results in BENCHMARKS.md;
|
||||
total line-of-code and test-count figures were stale; `clawhdf5-gpu`'s
|
||||
CubeCL→wgpu correction; documented the new `clawhdf5-ann` `parallel`
|
||||
feature flag, which had no entry in the Feature Flags table.
|
||||
|
||||
### New Features
|
||||
- `clawhdf5-migrate`: substantial engine improvements:
|
||||
@@ -161,6 +471,16 @@
|
||||
reading compound types and — critically — every chunked/compressed dataset
|
||||
written by HDF5 2.0. Found by running the h5py interop tests against
|
||||
h5py 3.16 / HDF5 2.0.
|
||||
Independently reported (with a patch) against the v2.1.0 tag by
|
||||
M. Scot Breitenfeld (The HDF Group) — v2.1.0 predates this fix.
|
||||
- `clawhdf5-format`: parse HDF5 2.0 native complex datatypes (class 11,
|
||||
datatype version 5, e.g. `H5T_COMPLEX_IEEE_F64LE`). The properties are a
|
||||
single base floating-point datatype, not a compound-style member list; the
|
||||
old parser read the base type's bytes as member names, producing a garbage
|
||||
datatype, and failed with `UnexpectedEof` when a complex type was nested in
|
||||
a compound. It is now surfaced as the equivalent `{r, i}` compound (the
|
||||
shape h5py writes for numpy complex dtypes), with a size check against the
|
||||
base type. Validated end-to-end against an HDF5 2.0-written file.
|
||||
|
||||
### Performance
|
||||
- `clawhdf5-format`: chunked writes now compress all chunks up front via
|
||||
|
||||
@@ -5,12 +5,11 @@ Pure-Rust HDF5 format implementation with HNSW vector search, WAL-backed persist
|
||||
|
||||
## Architecture
|
||||
|
||||
Cargo workspace with 17 crates under `crates/`:
|
||||
Cargo workspace with 16 crates under `crates/` (plus `libaec-sys`, an internal FFI bindings crate for the optional `szip` feature):
|
||||
|
||||
| Crate | Role |
|
||||
|-------|------|
|
||||
| `clawhdf5-types` | Shared type definitions and physical constants |
|
||||
| `clawhdf5-format` | HDF5 binary spec parser (superblock, B-tree, heap) |
|
||||
| `clawhdf5-format` | HDF5 binary spec parser (superblock, B-tree, heap) — also holds shared type definitions and physical constants |
|
||||
| `clawhdf5-io` | Read/write implementation |
|
||||
| `clawhdf5-filters` | Compression filters (gzip, LZ4, Zstd, Blosc) |
|
||||
| `clawhdf5-derive` | Proc-macro derive for HDF5-serializable structs |
|
||||
@@ -18,7 +17,7 @@ Cargo workspace with 17 crates under `crates/`:
|
||||
| `clawhdf5-netcdf4` | NetCDF-4 compatibility layer |
|
||||
| `clawhdf5-ann` | HNSW approximate nearest-neighbor vector index |
|
||||
| `clawhdf5-agent` | Agent memory, session history, knowledge graph storage |
|
||||
| `clawhdf5-gpu` | GPU-accelerated I/O via CubeCL |
|
||||
| `clawhdf5-gpu` | GPU-accelerated I/O via wgpu (hand-written WGSL compute shaders) |
|
||||
| `clawhdf5-accel` | CPU SIMD acceleration path |
|
||||
| `clawhdf5-migrate` | Schema migration engine |
|
||||
| `clawhdf5-android` | Android JNI bindings |
|
||||
@@ -34,7 +33,58 @@ Cargo workspace with 17 crates under `crates/`:
|
||||
the approximate `clawhdf5-ann` index for the vector stage (the index mirrors
|
||||
the cache and self-heals on drift). Build the agent with
|
||||
`--no-default-features --features float16` to force the exact linear cosine scan.
|
||||
- WAL (write-ahead log) for crash-safe persistence
|
||||
The index uses the HNSW paper's diversity heuristic for neighbour selection
|
||||
(plain closest-M capped recall on clustered data: 0.31 recall@10 at 100K). Its
|
||||
graph is saved to `<store>.h5.ann` at each checkpoint and reloaded by `open()`
|
||||
(tied to the checkpoint by a generation id; stale/damaged sidecars are
|
||||
ignored and the index rebuilt). `hybrid_search` keeps one incremental BM25
|
||||
index for the life of the store and never writes the store: Hebbian
|
||||
activation boosts are persisted by the next checkpoint (or on drop), not per
|
||||
query. Measure any search-path change with
|
||||
`cargo run --release -p clawhdf5-bench --bin search_harness` (baselines in
|
||||
`BENCHMARKS.md`).
|
||||
- WAL (write-ahead log) for crash-safe persistence, with a chained CRC32
|
||||
trailer per entry (each entry's CRC folds in the previous entry's CRC) so a
|
||||
corrupted, reordered, duplicated, or spliced entry stops replay cleanly
|
||||
instead of loading bad or tampered data. The pre-chaining per-entry-CRC
|
||||
format (v2) is still fully readable; the oldest no-CRC format (v1) is only
|
||||
reachable through the one-time migration path in `HDF5Memory::open`, not
|
||||
through the public `WalFile::read_entries`.
|
||||
**What the WAL guarantees:** integrity, ordering, and recovery from a
|
||||
*process* crash at any point — including between a checkpoint and the WAL
|
||||
truncate (each checkpoint records a `WalMark` in `/meta`, and `open()` skips
|
||||
the WAL prefix the `.h5` already contains, so entries are never applied
|
||||
twice). Checkpoints and snapshots are made durable as a unit (temp file
|
||||
synced, renamed, directory synced). **What it does not guarantee:**
|
||||
individual WAL appends are *not* fsynced (a deliberate latency trade-off), so
|
||||
saves made since the last checkpoint can be lost on power failure or kernel
|
||||
panic. Current header version is 4 (adds the `Update` record used by
|
||||
`save_or_update`); v3 files are read and upgraded in place.
|
||||
- A store has a **single writer**: `HDF5Memory::create`/`open` hold an exclusive
|
||||
advisory lock on `<store>.h5.lock` and a second opener gets
|
||||
`MemoryError::Locked`. Use `HDF5Memory::open_read_only` for a lock-free,
|
||||
never-writing point-in-time view (the CLI's `recall`/`stats`/`agents-md`/
|
||||
`export` do). An unreadable WAL (torn header, bad magic) is quarantined to
|
||||
`<store>.h5.wal.corrupt-<ts>` rather than blocking `open()`; a WAL with an
|
||||
unknown *newer* version still fails and is left untouched.
|
||||
- `MemoryConfig::compression` uses deflate by default; enable the agent's
|
||||
`zstd` feature to compress embeddings with Zstd instead (links libzstd).
|
||||
- `Dataset::verify_provenance()` (clawhdf5 facade, `provenance` feature, on by
|
||||
default) recomputes a dataset's SHA-256 and compares it against the
|
||||
`_provenance_sha256` attribute written automatically on save when
|
||||
`DatasetBuilder::with_provenance` is used. It's opt-in per call, not run
|
||||
automatically on open — it decodes and hashes the whole dataset. The hash
|
||||
is unkeyed (tamper-*evident*, not tamper-*proof*): it detects accidental
|
||||
corruption, not a deliberate actor able to modify both the data and the
|
||||
stored hash.
|
||||
- `clawhdf5-agent`'s `HDF5Memory::save`/`save_batch`/`save_or_update` run every
|
||||
write through an in-memory (session-scoped, not persisted to disk)
|
||||
provenance ledger and write-anomaly detector: a content hash per record
|
||||
(`provenance.rs`) for detecting accidental mid-session corruption, plus
|
||||
rate-limit/injection-pattern/source-distribution checks (`anomaly.rs`).
|
||||
Alerts never block a save — drain them with `HDF5Memory::take_anomaly_alerts`.
|
||||
`MemorySource` for this bookkeeping is inferred from the caller-supplied
|
||||
`source_channel` string (a heuristic, not an authenticated trust boundary).
|
||||
- GPU-accelerated batch I/O for large dataset processing
|
||||
- Python and Node.js bindings for cross-language use
|
||||
- NetCDF-4 compatibility for scientific data interop
|
||||
|
||||
+9
-3
@@ -1,7 +1,6 @@
|
||||
[workspace]
|
||||
members = [
|
||||
"crates/clawhdf5-format",
|
||||
"crates/clawhdf5-types",
|
||||
"crates/clawhdf5-io",
|
||||
"crates/clawhdf5-filters",
|
||||
"crates/clawhdf5-derive",
|
||||
@@ -17,11 +16,18 @@ members = [
|
||||
"crates/clawhdf5-cli",
|
||||
"crates/clawhdf5-napi",
|
||||
"crates/clawhdf5-bench",
|
||||
"crates/libaec-sys",
|
||||
]
|
||||
resolver = "2"
|
||||
|
||||
[workspace.package]
|
||||
version = "2.1.0"
|
||||
version = "2.4.0"
|
||||
edition = "2024"
|
||||
license = "MIT"
|
||||
repository = "https://github.com/redclawsystems/clawhdf5"
|
||||
repository = "https://git.redclaw.dev/quantumclaw/clawhdf5"
|
||||
|
||||
[workspace.dependencies]
|
||||
tempfile = "3"
|
||||
criterion = { version = "0.5", features = ["html_reports"] }
|
||||
half = "2.7"
|
||||
serde = { version = "1", features = ["derive"] }
|
||||
|
||||
@@ -4,14 +4,19 @@
|
||||
|
||||
[](LICENSE)
|
||||
[](https://www.rust-lang.org)
|
||||
[](#benchmarks)
|
||||
[](BENCHMARKS.md#longmemeval-results)
|
||||
[](#performance)
|
||||
[](BENCHMARKS.md#longmemeval-results)
|
||||
[](BENCHMARKS.md#memory-footprint)
|
||||
|
||||
ClawhDF5 is a pure-Rust HDF5 implementation combined with a research-grade agent memory engine. It gives AI agents persistent, searchable, cryptographically verifiable memory — all stored in a single portable file.
|
||||
ClawHDF5 is a pure-Rust HDF5 implementation combined with a research-grade agent memory engine. It gives AI agents persistent, searchable, cryptographically verifiable memory — all stored in a single portable file.
|
||||
|
||||
> **Two things live here:**
|
||||
> - **A general-purpose, pure-Rust HDF5 library** — zero C dependencies, NetCDF-4 support, SIMD/GPU acceleration. See the **[Crate Map](#crate-map)** and **[BENCHMARKS.md](BENCHMARKS.md)** for the libhdf5 head-to-head numbers.
|
||||
> - **An agent memory layer built on top of it** — vector search, knowledge graph, hippocampal-style consolidation, in `clawhdf5-agent`.
|
||||
|
||||
```
|
||||
cargo add clawhdf5-agent --features agent
|
||||
cargo add clawhdf5 # core HDF5 read/write, no agent layer
|
||||
cargo add clawhdf5-agent --features agent # + agent memory layer
|
||||
```
|
||||
|
||||
> **New here?** Start with the **[Quickstart Guide](docs/QUICKSTART.md)** · See **[Use Cases](docs/USE_CASES.md)** · Read **[Benchmarks](BENCHMARKS.md)**
|
||||
@@ -37,7 +42,21 @@ Every AI agent needs memory. Today that means scattered Markdown files, SQLite d
|
||||
|
||||
## Performance
|
||||
|
||||
Benchmarked on Intel i7-12650H (10C/16T), 384-dim embeddings, Criterion.rs.
|
||||
Vector search and agent-memory operations below are benchmarked on Intel i7-12650H (10C/16T), 384-dim embeddings, Criterion.rs. The HDF5 Core I/O table immediately below is from a separate, independently reproduced run (see its own hardware note).
|
||||
|
||||
### HDF5 Core I/O (vs libhdf5 1.14.6)
|
||||
|
||||
*Benchmark numbers are being validated in collaboration with engineers from the HDF5 Group to confirm methodology and reproducibility.*
|
||||
|
||||
Figures below are from an independent reproduction run on a second machine (AMD Ryzen 7 7800X3D, 2026-08-03). Full methodology, the original i7-12650H run, and two additional benchmarks added to close prior coverage gaps (an I/O-inclusive metadata-open comparison and an honest zero-copy-mmap measurement) are in [BENCHMARKS.md § Independent Validation](BENCHMARKS.md#independent-validation-tank-ryzen-7-7800x3d-2026-08-03).
|
||||
|
||||
| Operation | ClawhDF5 | libhdf5 | Speedup |
|
||||
|-----------|----------|---------|---------|
|
||||
| Attribute write (128 attrs) | 85.2 µs | 877 µs | **10.3×** |
|
||||
| Group create (64 groups) | 130 µs | 1.37 ms | **10.6×** |
|
||||
| Chunked write, deflate-6 (512×512 f32) | 1.44 ms | 65.0 ms | **45.3×** |
|
||||
| Sequential read (100K f32) | 23.3 µs | 63.6 µs | **2.7×** |
|
||||
| Sequential write (100K f32) | 210 µs | 189 µs | **≈ tie** |
|
||||
|
||||
### Vector Search
|
||||
|
||||
@@ -45,7 +64,12 @@ Benchmarked on Intel i7-12650H (10C/16T), 384-dim embeddings, Criterion.rs.
|
||||
|-------|------|-----------------|--------|----------|
|
||||
| 1K | **54 µs** | — | — | — |
|
||||
| 10K | 753 µs | **27 µs** | — | — |
|
||||
| 100K | 11.4 ms | 1.32 ms | **1.19 ms** | **8–76× faster** |
|
||||
| 100K | 11.4 ms | 1.32 ms | **1.19 ms** | ~8–76× (see caveat) |
|
||||
|
||||
> Reproduced on the same second machine (Ryzen 7 7800X3D) with a corrected,
|
||||
> apples-to-apples SIMD/scalar/parallel comparison methodology — see
|
||||
> [BENCHMARKS.md § Independent Validation: tank — LongMemEval & Vector
|
||||
> Search](BENCHMARKS.md#independent-validation-tank--longmemeval--vector-search-ryzen-7-7800x3d-2026-08-05).
|
||||
|
||||
### Agent Memory Operations
|
||||
|
||||
@@ -57,32 +81,68 @@ Benchmarked on Intel i7-12650H (10C/16T), 384-dim embeddings, Criterion.rs.
|
||||
| Spreading activation | **17 µs** | 100 entities |
|
||||
| Temporal range query | **716 ns** | 10K timestamps |
|
||||
| Consolidation cycle | **164 µs** | 1K records |
|
||||
| Memory write (WAL) | **134 µs** | per record |
|
||||
| Memory write (WAL) | **18 µs** | per record (group-commit append; HDF5 batched at flush) |
|
||||
| Importance gate | **61 ns** | per record |
|
||||
|
||||
### HDF5 Core I/O (vs h5py/C HDF5)
|
||||
### Chunked Write Throughput (codec comparison)
|
||||
|
||||
| Operation | ClawhDF5 | h5py (C) | Speedup |
|
||||
|-----------|----------|----------|---------|
|
||||
| Metadata parse | 19 ns | 2,080 µs | **308×** |
|
||||
| Write 1M f64 | 0.82 ms | 1.60 ms | **2×** |
|
||||
| Read 1M f64 | 0.28 ms | 0.65 ms | **2.3×** |
|
||||
| Zero-copy mmap | 313 ns | N/A | — |
|
||||
Measured with Criterion on f32 matrices. Auto-shuffle is applied before all compression codecs
|
||||
by default (AoS→SoA byte transpose, +157–204% throughput for float data):
|
||||
|
||||
> ¹ MemX ([arxiv:2603.16171](https://arxiv.org/abs/2603.16171), March 2026): Rust + libSQL, claims <90ms at 100K records.
|
||||
| Codec | 128×128 f32 | 512×512 f32 | Notes |
|
||||
|-------|-------------|-------------|-------|
|
||||
| Zstd level 3 | **148 µs / 422 MiB/s** | **1.34 ms / 748 MiB/s** | With auto-shuffle |
|
||||
| Deflate level 6 | 153 µs / 407 MiB/s | 1.39 ms / 719 MiB/s | With auto-shuffle |
|
||||
| Pcodec | 528 µs / 118 MiB/s | 1.69 ms / 591 MiB/s | Best compression ratio |
|
||||
|
||||
Use `.with_zstd(3)` or `.with_deflate(6)` for write-heavy workloads — both now perform at ~720–750 MiB/s on large matrices. Use `.with_pcodec()` for write-once/read-many workloads where compression ratio matters more than encode speed. Disable auto-shuffle with `.without_shuffle()` for byte arrays that don't benefit from AoS→SoA transposition.
|
||||
|
||||
> ¹ MemX ([arxiv:2603.16171](https://arxiv.org/abs/2603.16171), March 2026): Rust + libSQL, claims <90ms at 100K records. **Not like-for-like:** MemX's figure is *end-to-end* (embeddings + FTS5 + four-factor re-ranking); ours is a *single component* (raw vector search). The ratio overstates the real advantage by an unquantified margin — order-of-magnitude indication only. See [BENCHMARKS.md](BENCHMARKS.md#comparison-to-memx-arxiv260316171).
|
||||
|
||||
### LongMemEval Retrieval Recall
|
||||
|
||||
Evaluated against the LongMemEval dataset (500 questions, multi-session haystack).
|
||||
BM25-only baseline (no embedding model required at bench time):
|
||||
Evaluated against the full **`longmemeval_s`** haystack — all 500 questions, 47.7
|
||||
sessions and 493.5 turns each, with only 4.0% of haystack sessions being evidence
|
||||
sessions. See [BENCHMARKS.md § LongMemEval
|
||||
Results](BENCHMARKS.md#longmemeval-results) for the full scoring-target
|
||||
declaration:
|
||||
|
||||
| Metric | BM25-only | Full hybrid¹ |
|
||||
|--------|-----------|--------------|
|
||||
| Hit@5 (session) | ~46% | Higher |
|
||||
| MRR (session) | ~0.34 | Higher |
|
||||
| Abstention accuracy | ~72% | — |
|
||||
| Mode | Turn-Level Hit@5 | Session-Level Hit@5 |
|
||||
|------|------------------|---------------------|
|
||||
| BM25 only | 75.0% | 93.6% |
|
||||
| Vector only (MiniLM) | 71.8% | 94.2% |
|
||||
| Hybrid (0.4/0.6, tuned) | **81.4%** | **96.8%** |
|
||||
|
||||
> ¹ Enable embeddings via `hybrid_search(query_emb, text, 0.7, 0.3, k)` for substantially higher recall. The vector stage is served by the HNSW index by default (the `hnsw` feature is on by default); build with `--no-default-features --features float16` to fall back to an exact linear cosine scan.
|
||||
Hybrid is the strongest configuration, which is what running two retrieval stages
|
||||
is for. The weights matter more than the stages: a sweep of `vector_weight` from
|
||||
0.0 to 1.0 found the long-standing `0.7/0.3` default is **strictly dominated** by
|
||||
`0.4/0.6` — better on Hit@1, Hit@5, Hit@10 and MRR at both granularities. Use
|
||||
`0.4/0.6`, or `0.3/0.7` if rank-1 precision matters most. See
|
||||
[BENCHMARKS.md § Weight sweep](BENCHMARKS.md#longmemeval-results).
|
||||
|
||||
Vector embeddings require `--features embeddings`; without it the vector stage is
|
||||
inert and only the BM25 row is produced, which is what every previously published
|
||||
number here measured.
|
||||
|
||||
On the easier `longmemeval_oracle` variant (evidence sessions only) the same
|
||||
harness scores 84.4% turn-level Hit@5 / MRR 0.6597, reproduced identically on a
|
||||
second machine. The 9.4-point gap is the cost of the real haystack, and is why the
|
||||
full-haystack number is the one quoted here.
|
||||
|
||||
This is **retrieval recall** (did the gold memory appear in the top-k), not the
|
||||
official LongMemEval QA-accuracy metric — the two are not comparable, and
|
||||
retrieval recall reported as QA accuracy typically overstates by 20–30 points.
|
||||
|
||||
> **Previously reported here and now retracted:** session-level Hit@5 of 100.0% /
|
||||
> MRR 1.0000, and a claim of beating MemX's 51.6%. Those session-level figures were
|
||||
> degenerate on the oracle variant (any returned document is a hit by
|
||||
> construction); the 93.6% above is a different, real measurement on a corpus where
|
||||
> evidence sessions are 4.0% of the haystack. The MemX comparison stays withdrawn —
|
||||
> MemX measures fact-level granularity over 220,349 records, which running the full
|
||||
> haystack does not fix. Details in
|
||||
> [BENCHMARKS.md](BENCHMARKS.md#retracted-session-level-recall-and-the-memx-comparison).
|
||||
|
||||
> Enable embeddings via `hybrid_search(query_emb, text, 0.4, 0.6, k)` for substantially higher recall. The vector stage is served by the HNSW index by default (the `hnsw` feature is on by default); build with `--no-default-features --features float16` to fall back to an exact linear cosine scan.
|
||||
|
||||
### Memory Footprint
|
||||
|
||||
@@ -171,7 +231,7 @@ ClawhDF5's agent memory engine implements research from 15+ recent papers on age
|
||||
| **`ivf` / `pq`** | IVF-PQ approximate nearest neighbor for billion-scale search |
|
||||
| **`bm25`** | BM25 keyword index with TF-IDF scoring |
|
||||
| **`entity_extract`** | Rule-based entity extraction from text chunks into the knowledge graph |
|
||||
| **`wal`** | Write-ahead log for crash-safe persistence |
|
||||
| **`wal`** | Write-ahead log for crash-safe persistence; each entry is CRC32-checked on replay, so a corrupted entry stops replay there instead of loading bad data |
|
||||
| **`memory_strategy`** | Pluggable strategies: save-every, semantic-shift, user-correction detection |
|
||||
| **`decision_gate`** | Sub-microsecond trivial/substantive classification |
|
||||
| **`async_memory`** | Tokio-based async wrapper over the memory store (`async` feature) |
|
||||
@@ -315,22 +375,22 @@ let exported = backend.export_markdown("MEMORY.md")?;
|
||||
## Crate Map
|
||||
|
||||
```
|
||||
clawhdf5 workspace (17 crates, 84K lines of Rust)
|
||||
clawhdf5 workspace (16 crates, ~92K lines of Rust; plus libaec-sys, an
|
||||
internal FFI bindings crate for the optional szip feature)
|
||||
│
|
||||
├── Core HDF5
|
||||
│ ├── clawhdf5-types — Type system definitions
|
||||
│ ├── clawhdf5-format — Binary parser/writer (no_std)
|
||||
│ ├── clawhdf5-format — Binary parser/writer (no_std), shared type definitions
|
||||
│ ├── clawhdf5-io — I/O abstraction (buffered, mmap, async)
|
||||
│ ├── clawhdf5-filters — Compression (deflate, lz4, zstd, blosc)
|
||||
│ ├── clawhdf5-filters — Fast deflate path (zlib-ng); lz4/zstd/pcodec/szip filters live in clawhdf5-format
|
||||
│ ├── clawhdf5-derive — Proc macros
|
||||
│ ├── clawhdf5 — High-level API
|
||||
│ ├── clawhdf5-netcdf4 — NetCDF-4 support
|
||||
│ ├── clawhdf5-accel — SIMD (NEON, AVX2, AVX-512)
|
||||
│ └── clawhdf5-gpu — GPU compute (wgpu)
|
||||
│ └── clawhdf5-gpu — GPU compute (wgpu, hand-written WGSL compute shaders)
|
||||
│
|
||||
├── Agent Memory
|
||||
│ ├── clawhdf5-agent — Memory engine (20.7K lines, 32 modules)
|
||||
│ ├── clawhdf5-ann — HNSW approximate nearest neighbor (default backend)
|
||||
│ ├── clawhdf5-agent — Memory engine (20.9K lines, 32 modules; WAL is CRC32-checked per entry)
|
||||
│ ├── clawhdf5-ann — HNSW approximate nearest neighbor (default backend; optional `parallel` feature)
|
||||
│ ├── clawhdf5-migrate — SQLite → HDF5 migration
|
||||
│ ├── clawhdf5-android — Android JNI bridge
|
||||
│ └── clawhdf5-cli — CLI tool
|
||||
@@ -393,9 +453,28 @@ ClawhDF5's agent memory design draws from 15+ recent papers:
|
||||
| `fast-checksum` | no | crc32fast-accelerated checksums |
|
||||
| `lz4` | no | LZ4 block compression filter (id 32004) |
|
||||
| `zstd` | no | Zstandard compression filter (id 32015) |
|
||||
| `pcodec` | no | Pcodec lossless numerical codec (id 32023, via `pco` crate) |
|
||||
| `system-zlib` / `zlib-rs` | no | Alternative zlib backends for deflate |
|
||||
| `blake3_hash` | no | BLAKE3 content hashing for provenance |
|
||||
|
||||
### `clawhdf5-ann`
|
||||
|
||||
| Flag | Default | Description |
|
||||
|------|---------|-------------|
|
||||
| `parallel` | no | Rayon-parallel neighbor-distance computation during HNSW graph pruning |
|
||||
|
||||
### `clawhdf5-io`
|
||||
|
||||
| Flag | Default | Description |
|
||||
|------|---------|-------------|
|
||||
| `mpi-io` | no | MPI-backed I/O via the `mpi` crate |
|
||||
|
||||
> **Parallel I/O (MPI) limitation:** `mpi-io`'s read path is a root-rank read
|
||||
> followed by a broadcast, and its write path gathers all ranks' shards to
|
||||
> rank 0 before writing — not true collective I/O
|
||||
> (`MPI_File_read_at_all`/`write_at_all`). It does not provide I/O bandwidth
|
||||
> that scales with rank count; true collective I/O is tracked as future work.
|
||||
|
||||
---
|
||||
|
||||
## Building
|
||||
@@ -411,11 +490,12 @@ cargo build -p clawhdf5-agent --features "agent,float16,parallel,fast-math"
|
||||
cargo build -p clawhdf5-agent --features "agent,float16,accelerate,parallel,gpu"
|
||||
|
||||
# Tests
|
||||
cargo test --workspace # all 417+ tests
|
||||
cargo test --workspace # all 1,650+ tests
|
||||
cargo test -p clawhdf5-agent # agent memory tests
|
||||
|
||||
# Benchmarks
|
||||
cargo bench -p clawhdf5-agent # full benchmark suite
|
||||
cargo bench -p clawhdf5-agent # agent memory suite
|
||||
cargo bench -p clawhdf5-bench # h5bench-equivalent I/O suite
|
||||
```
|
||||
|
||||
---
|
||||
@@ -480,7 +560,7 @@ See [ROADMAP.md](ROADMAP.md) for the full implementation tracker.
|
||||
- ✅ OpenClaw integration layer
|
||||
- ✅ Comprehensive Criterion benchmarks
|
||||
|
||||
**Phase 2** — OpenClaw TypeScript bridge, academic benchmarks (MemoryArena, LongMemEval), cross-platform validation.
|
||||
**Phase 2** — MemoryArena and LongMemEval academic benchmarks are done (see [BENCHMARKS.md](BENCHMARKS.md), reproduced on a second machine); remaining: publish the OpenClaw TypeScript bridge to npm, crates.io/PyPI publishing.
|
||||
|
||||
---
|
||||
|
||||
@@ -498,5 +578,5 @@ MIT
|
||||
|
||||
<p align="center">
|
||||
<em>Built by <a href="https://github.com/redclawsystems">RedClaw Systems</a></em><br>
|
||||
<em>72,087 lines of Rust. Zero C dependencies. One file to remember everything.</em>
|
||||
<em>~92,000 lines of Rust. Zero C dependencies. One file to remember everything.</em>
|
||||
</p>
|
||||
|
||||
+32
-7
@@ -145,18 +145,43 @@
|
||||
**Phase 3:** ~~Track 6 (multi-modal) + Track 7 (OpenClaw integration)~~ 🟢 Complete
|
||||
**Phase 4:** ~~Track 8 (benchmarking + validation)~~ 🟢 Complete
|
||||
|
||||
All 8 tracks delivered. 1,546 tests passing, zero clippy warnings.
|
||||
All 8 tracks delivered. 1,650+ tests passing, zero clippy warnings.
|
||||
|
||||
---
|
||||
|
||||
## What's Next
|
||||
|
||||
- [ ] CI/CD pipeline — GitHub Actions or Gitea Actions for automated testing
|
||||
- [ ] Academic benchmark cross-validation — reproduce MemX/LongMemEval under identical conditions
|
||||
- [ ] TypeScript bridge — full npm package via `clawhdf5-napi` (scaffolding exists)
|
||||
- [ ] Publish crates to crates.io
|
||||
- [ ] Python wheel distribution via maturin for `clawhdf5-py`
|
||||
Verified against current repo state on 2026-08-05 (see also `docs/superpowers/plans/` for the filter-codec/format-write/MPI-IO work, now shipped):
|
||||
|
||||
- [ ] TypeScript bridge not wired into CI — `packages/clawhdf5-node/` already has a complete, working napi-rs package (package.json, tsconfig, hand-written TS wrapper matching all 21 `#[napi]` items, Jest test suite, README); it isn't published to npm and has no committed lockfile
|
||||
- [ ] Publish crates to crates.io — no `publish` config anywhere in the workspace yet
|
||||
- [ ] Python wheel distribution via maturin — `crates/clawhdf5-py/pyproject.toml` exists (maturin-buildable locally) but wheels aren't published anywhere
|
||||
- [ ] `chunked_read.rs`/`data_read.rs` full bounds-check audit + scheduled fuzz campaigns (the new `fuzz_dataset_read` target covers the two files' main entry points; a full manual audit of every indexing site is still open) — see Tier 4 below
|
||||
- [ ] WAL per-entry checksum landed as CRC32 (see below); a stronger per-entry format (explicit length prefix, avoiding the read-then-verify restructuring) could still be revisited if profiling shows it matters
|
||||
- [ ] HNSW build parallelism is still narrow (only `prune_connections`); the correctness-sensitive outer insert loop needs its own dedicated design pass before parallelizing
|
||||
|
||||
### Recently closed out (2026-08-05, Tier 3–4 hardening pass)
|
||||
|
||||
- [x] Academic benchmark cross-validation — LongMemEval reproduced against MemX on tank (Ryzen 7 7800X3D): turn-level Hit@5 84.4% vs MemX's 51.6%; recall numbers are deterministic and reproduce exactly across machines. SIMD/Parallelism and Vector Search sections also re-run and dated. See [BENCHMARKS.md § Independent Validation: tank — LongMemEval & Vector Search](BENCHMARKS.md#independent-validation-tank--longmemeval--vector-search-ryzen-7-7800x3d-2026-08-05)
|
||||
- [x] Android JNI (`clawhdf5-android`): validate `embedding_len`/`query_embedding_len` against the handle's configured `embedding_dim` before constructing a slice from a raw pointer
|
||||
- [x] `clawhdf5-py`: bumped pyo3/numpy 0.28 → 0.29, clearing two RUSTSEC advisories
|
||||
- [x] WAL (`clawhdf5-agent`): length-prefix caps (`MAX_WAL_FIELD_LEN`) to reject a corrupted length claim before allocating, then a full per-entry CRC32 trailer (`WAL_VERSION` 2) so a bit-flip stops replay cleanly instead of loading corrupted data; old-format WAL files still read correctly and are migrated on next open
|
||||
- [x] `chunked_read.rs`/`data_read.rs`/`local_heap.rs` bounds-check audit: added `ensure_len` overflow guards, a recursion-depth guard against cyclic B-trees, and a fix for an unguarded compound-datatype byte-offset overrun. Added a new `fuzz_dataset_read` cargo-fuzz target exercising the contiguous/chunked/compact read paths — it found and we fixed 3 real crash bugs (integer-overflow panics) within the first few runs
|
||||
- [x] `clawhdf5-ann`: optional `parallel` feature (rayon) for HNSW's `prune_connections` neighbor-distance computation
|
||||
- [x] `[workspace.dependencies]` added for `tempfile`/`criterion`/`half`/`serde`, fixing a real version skew on `half` (2 vs 2.7)
|
||||
|
||||
### Recently closed out (2026-08-05 hardening pass)
|
||||
|
||||
- [x] CI/CD pipeline — `.gitea/workflows/ci.yml` now runs `scripts/ci-test.sh` (fmt, clippy, tests, no_std check) on push/PR to `main`
|
||||
- [x] Fixed no_std build breakage in `clawhdf5-format` (missing alloc imports, `AtomicU64` unsupported on thumbv7em, `f64::powi` requiring std/libm)
|
||||
- [x] Fixed version skew: `clawhdf5-py` (pyproject.toml) and `packages/clawhdf5-node` (package.json) were both behind the actual crate version
|
||||
|
||||
### Recently closed out (2026-08-03 cleanup pass)
|
||||
|
||||
- [x] Removed `clawhdf5-types` — it was an empty 1-line stub crate; shared type definitions already live in `clawhdf5-format`, so CLAUDE.md and the workspace manifest were corrected instead of filling it in
|
||||
- [x] Superblock v4 (page-buffer mode) read/write — the only unimplemented task from `docs/superpowers/plans/2026-06-29-format-write-extensions.md`; now done (`Superblock::parse_v4`/`serialize`, `FileWriter::with_page_size`)
|
||||
- [x] Reconciled the three `docs/superpowers/plans/*.md` docs against actual shipped code — they were pre-work plans for `d6c4d4f` (2026-06-30), committed to git late; checkboxes now reflect reality
|
||||
|
||||
---
|
||||
|
||||
_Last updated: 2026-04-12_
|
||||
_Last updated: 2026-08-05_
|
||||
|
||||
@@ -0,0 +1,38 @@
|
||||
#!/usr/bin/env python3
|
||||
"""h5py counterpart to worldmodel_sampling.rs — same file, same shuffled
|
||||
per-frame access, same minimal touch (sum the frame bytes). Reports
|
||||
samples/sec so the two sit side by side on one machine."""
|
||||
import sys, time, numpy as np, h5py
|
||||
|
||||
path = sys.argv[1]
|
||||
passes = int(sys.argv[2]) if len(sys.argv) > 2 else 5
|
||||
|
||||
def shuffled(n):
|
||||
v = list(range(n))
|
||||
state = 0x9E3779B97F4A7C15
|
||||
for i in range(n - 1, 0, -1):
|
||||
state = (state * 6364136223846793005 + 1442695040888963407) & 0xFFFFFFFFFFFFFFFF
|
||||
j = (state >> 33) % (i + 1)
|
||||
v[i], v[j] = v[j], v[i]
|
||||
return v
|
||||
|
||||
# swmr + a 256 MB chunk cache: exactly stable-worldmodel's HDF5Dataset._open_h5.
|
||||
f = h5py.File(path, "r", swmr=True, rdcc_nbytes=256 * 1024 * 1024)
|
||||
d = f["observation"]
|
||||
n = d.shape[0]
|
||||
order = shuffled(n)
|
||||
|
||||
# warm
|
||||
sink = 0
|
||||
for i in order:
|
||||
sink += int(d[i].sum())
|
||||
|
||||
t0 = time.perf_counter()
|
||||
sink = 0
|
||||
for _ in range(passes):
|
||||
for i in order:
|
||||
sink += int(d[i].sum())
|
||||
elapsed = time.perf_counter() - t0
|
||||
total = n * passes
|
||||
print(f"h5py: {n} frames x {passes} passes = {total} reads in {elapsed:.3f}s")
|
||||
print(f"h5py: {total/elapsed:.0f} samples/sec")
|
||||
@@ -0,0 +1,27 @@
|
||||
#!/usr/bin/env python3
|
||||
"""Generate a world-model-shaped dataset: N frames of HxWxC uint8 observations,
|
||||
contiguous (N,H,W,C), matching stable-worldmodel's per-frame sample-loading
|
||||
access pattern. Also emits ep_len/ep_offset like their format."""
|
||||
import sys, time, numpy as np, h5py
|
||||
|
||||
path = sys.argv[1]
|
||||
N = int(sys.argv[2]) if len(sys.argv) > 2 else 20000
|
||||
H = W = 64
|
||||
C = 3
|
||||
rng = np.random.default_rng(0)
|
||||
t0 = time.perf_counter()
|
||||
with h5py.File(path, "w", libver="latest") as f:
|
||||
# Contiguous (N,H,W,C) uint8 — the fair, both-APIs-support-it layout.
|
||||
obs = f.create_dataset("observation", shape=(N, H, W, C), dtype=np.uint8)
|
||||
# Write in blocks to bound memory.
|
||||
B = 2000
|
||||
for i in range(0, N, B):
|
||||
n = min(B, N - i)
|
||||
obs[i:i+n] = rng.integers(0, 256, size=(n, H, W, C), dtype=np.uint8)
|
||||
# Episode metadata like their format: 100-step episodes.
|
||||
ep = 100
|
||||
n_ep = N // ep
|
||||
f.create_dataset("ep_len", data=np.full(n_ep, ep, dtype=np.int32))
|
||||
f.create_dataset("ep_offset", data=(np.arange(n_ep) * ep).astype(np.int64))
|
||||
print(f"wrote {N} frames {H}x{W}x{C} to {path} in {time.perf_counter()-t0:.1f}s "
|
||||
f"({N*H*W*C/1e6:.0f} MB)")
|
||||
@@ -1,10 +1,10 @@
|
||||
[package]
|
||||
name = "clawhdf5-accel"
|
||||
version = "2.1.0"
|
||||
version = "2.4.0"
|
||||
edition = "2024"
|
||||
description = "SIMD-accelerated operations for rustyhdf5"
|
||||
license = "MIT"
|
||||
repository = "https://github.com/redclawsystems/clawhdf5"
|
||||
repository = "https://git.redclaw.dev/quantumclaw/clawhdf5"
|
||||
readme = "README.md"
|
||||
keywords = ["hdf5", "simd", "acceleration", "performance"]
|
||||
categories = ["science", "algorithms"]
|
||||
@@ -15,7 +15,7 @@ float16 = ["dep:half"]
|
||||
avx512 = []
|
||||
|
||||
[dependencies]
|
||||
half = { version = "2", optional = true }
|
||||
half = { workspace = true, optional = true }
|
||||
|
||||
[package.metadata.docs.rs]
|
||||
features = []
|
||||
|
||||
@@ -111,7 +111,11 @@ pub unsafe fn cosine_similarity(a: &[f32], b: &[f32]) -> f32 {
|
||||
}
|
||||
|
||||
let denom = (norm_a * norm_b).sqrt();
|
||||
if denom == 0.0 { 0.0 } else { dot / denom }
|
||||
if denom < f32::EPSILON {
|
||||
0.0
|
||||
} else {
|
||||
dot / denom
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
@@ -13,42 +13,44 @@ use std::arch::x86_64::*;
|
||||
/// Caller must verify is_x86_feature_detected!("avx512f").
|
||||
// SAFETY: Caller must have verified avx512f via is_x86_feature_detected!.
|
||||
#[target_feature(enable = "avx512f")]
|
||||
pub unsafe fn dot_product(a: &[f32], b: &[f32]) -> f32 { unsafe {
|
||||
assert_eq!(a.len(), b.len());
|
||||
let len = a.len();
|
||||
let mut i = 0;
|
||||
let mut acc0 = _mm512_setzero_ps();
|
||||
let mut acc1 = _mm512_setzero_ps();
|
||||
pub unsafe fn dot_product(a: &[f32], b: &[f32]) -> f32 {
|
||||
unsafe {
|
||||
assert_eq!(a.len(), b.len());
|
||||
let len = a.len();
|
||||
let mut i = 0;
|
||||
let mut acc0 = _mm512_setzero_ps();
|
||||
let mut acc1 = _mm512_setzero_ps();
|
||||
|
||||
// Process 32 elements per iteration (2x16 unrolled)
|
||||
while i + 32 <= len {
|
||||
let va0 = _mm512_loadu_ps(a.as_ptr().add(i));
|
||||
let vb0 = _mm512_loadu_ps(b.as_ptr().add(i));
|
||||
acc0 = _mm512_fmadd_ps(va0, vb0, acc0);
|
||||
// Process 32 elements per iteration (2x16 unrolled)
|
||||
while i + 32 <= len {
|
||||
let va0 = _mm512_loadu_ps(a.as_ptr().add(i));
|
||||
let vb0 = _mm512_loadu_ps(b.as_ptr().add(i));
|
||||
acc0 = _mm512_fmadd_ps(va0, vb0, acc0);
|
||||
|
||||
let va1 = _mm512_loadu_ps(a.as_ptr().add(i + 16));
|
||||
let vb1 = _mm512_loadu_ps(b.as_ptr().add(i + 16));
|
||||
acc1 = _mm512_fmadd_ps(va1, vb1, acc1);
|
||||
let va1 = _mm512_loadu_ps(a.as_ptr().add(i + 16));
|
||||
let vb1 = _mm512_loadu_ps(b.as_ptr().add(i + 16));
|
||||
acc1 = _mm512_fmadd_ps(va1, vb1, acc1);
|
||||
|
||||
i += 32;
|
||||
i += 32;
|
||||
}
|
||||
|
||||
if i + 16 <= len {
|
||||
let va = _mm512_loadu_ps(a.as_ptr().add(i));
|
||||
let vb = _mm512_loadu_ps(b.as_ptr().add(i));
|
||||
acc0 = _mm512_fmadd_ps(va, vb, acc0);
|
||||
i += 16;
|
||||
}
|
||||
|
||||
let mut sum = _mm512_reduce_add_ps(_mm512_add_ps(acc0, acc1));
|
||||
|
||||
while i < len {
|
||||
sum += a[i] * b[i];
|
||||
i += 1;
|
||||
}
|
||||
|
||||
sum
|
||||
}
|
||||
|
||||
if i + 16 <= len {
|
||||
let va = _mm512_loadu_ps(a.as_ptr().add(i));
|
||||
let vb = _mm512_loadu_ps(b.as_ptr().add(i));
|
||||
acc0 = _mm512_fmadd_ps(va, vb, acc0);
|
||||
i += 16;
|
||||
}
|
||||
|
||||
let mut sum = _mm512_reduce_add_ps(_mm512_add_ps(acc0, acc1));
|
||||
|
||||
while i < len {
|
||||
sum += a[i] * b[i];
|
||||
i += 1;
|
||||
}
|
||||
|
||||
sum
|
||||
}}
|
||||
}
|
||||
|
||||
/// AVX-512 cosine similarity — fused single pass.
|
||||
///
|
||||
@@ -56,38 +58,44 @@ pub unsafe fn dot_product(a: &[f32], b: &[f32]) -> f32 { unsafe {
|
||||
/// Caller must verify is_x86_feature_detected!("avx512f").
|
||||
// SAFETY: Caller must have verified avx512f via is_x86_feature_detected!.
|
||||
#[target_feature(enable = "avx512f")]
|
||||
pub unsafe fn cosine_similarity(a: &[f32], b: &[f32]) -> f32 { unsafe {
|
||||
assert_eq!(a.len(), b.len());
|
||||
let len = a.len();
|
||||
let mut i = 0;
|
||||
pub unsafe fn cosine_similarity(a: &[f32], b: &[f32]) -> f32 {
|
||||
unsafe {
|
||||
assert_eq!(a.len(), b.len());
|
||||
let len = a.len();
|
||||
let mut i = 0;
|
||||
|
||||
let mut dot_acc = _mm512_setzero_ps();
|
||||
let mut norm_a_acc = _mm512_setzero_ps();
|
||||
let mut norm_b_acc = _mm512_setzero_ps();
|
||||
let mut dot_acc = _mm512_setzero_ps();
|
||||
let mut norm_a_acc = _mm512_setzero_ps();
|
||||
let mut norm_b_acc = _mm512_setzero_ps();
|
||||
|
||||
while i + 16 <= len {
|
||||
let va = _mm512_loadu_ps(a.as_ptr().add(i));
|
||||
let vb = _mm512_loadu_ps(b.as_ptr().add(i));
|
||||
dot_acc = _mm512_fmadd_ps(va, vb, dot_acc);
|
||||
norm_a_acc = _mm512_fmadd_ps(va, va, norm_a_acc);
|
||||
norm_b_acc = _mm512_fmadd_ps(vb, vb, norm_b_acc);
|
||||
i += 16;
|
||||
while i + 16 <= len {
|
||||
let va = _mm512_loadu_ps(a.as_ptr().add(i));
|
||||
let vb = _mm512_loadu_ps(b.as_ptr().add(i));
|
||||
dot_acc = _mm512_fmadd_ps(va, vb, dot_acc);
|
||||
norm_a_acc = _mm512_fmadd_ps(va, va, norm_a_acc);
|
||||
norm_b_acc = _mm512_fmadd_ps(vb, vb, norm_b_acc);
|
||||
i += 16;
|
||||
}
|
||||
|
||||
let mut dot = _mm512_reduce_add_ps(dot_acc);
|
||||
let mut norm_a = _mm512_reduce_add_ps(norm_a_acc);
|
||||
let mut norm_b = _mm512_reduce_add_ps(norm_b_acc);
|
||||
|
||||
while i < len {
|
||||
dot += a[i] * b[i];
|
||||
norm_a += a[i] * a[i];
|
||||
norm_b += b[i] * b[i];
|
||||
i += 1;
|
||||
}
|
||||
|
||||
let denom = (norm_a * norm_b).sqrt();
|
||||
if denom < f32::EPSILON {
|
||||
0.0
|
||||
} else {
|
||||
dot / denom
|
||||
}
|
||||
}
|
||||
|
||||
let mut dot = _mm512_reduce_add_ps(dot_acc);
|
||||
let mut norm_a = _mm512_reduce_add_ps(norm_a_acc);
|
||||
let mut norm_b = _mm512_reduce_add_ps(norm_b_acc);
|
||||
|
||||
while i < len {
|
||||
dot += a[i] * b[i];
|
||||
norm_a += a[i] * a[i];
|
||||
norm_b += b[i] * b[i];
|
||||
i += 1;
|
||||
}
|
||||
|
||||
let denom = (norm_a * norm_b).sqrt();
|
||||
if denom == 0.0 { 0.0 } else { dot / denom }
|
||||
}}
|
||||
}
|
||||
|
||||
/// AVX-512 L2 distance.
|
||||
///
|
||||
@@ -95,27 +103,29 @@ pub unsafe fn cosine_similarity(a: &[f32], b: &[f32]) -> f32 { unsafe {
|
||||
/// Caller must verify is_x86_feature_detected!("avx512f").
|
||||
// SAFETY: Caller must have verified avx512f via is_x86_feature_detected!.
|
||||
#[target_feature(enable = "avx512f")]
|
||||
pub unsafe fn l2_distance(a: &[f32], b: &[f32]) -> f32 { unsafe {
|
||||
assert_eq!(a.len(), b.len());
|
||||
let len = a.len();
|
||||
let mut i = 0;
|
||||
let mut acc = _mm512_setzero_ps();
|
||||
pub unsafe fn l2_distance(a: &[f32], b: &[f32]) -> f32 {
|
||||
unsafe {
|
||||
assert_eq!(a.len(), b.len());
|
||||
let len = a.len();
|
||||
let mut i = 0;
|
||||
let mut acc = _mm512_setzero_ps();
|
||||
|
||||
while i + 16 <= len {
|
||||
let va = _mm512_loadu_ps(a.as_ptr().add(i));
|
||||
let vb = _mm512_loadu_ps(b.as_ptr().add(i));
|
||||
let diff = _mm512_sub_ps(va, vb);
|
||||
acc = _mm512_fmadd_ps(diff, diff, acc);
|
||||
i += 16;
|
||||
while i + 16 <= len {
|
||||
let va = _mm512_loadu_ps(a.as_ptr().add(i));
|
||||
let vb = _mm512_loadu_ps(b.as_ptr().add(i));
|
||||
let diff = _mm512_sub_ps(va, vb);
|
||||
acc = _mm512_fmadd_ps(diff, diff, acc);
|
||||
i += 16;
|
||||
}
|
||||
|
||||
let mut sum = _mm512_reduce_add_ps(acc);
|
||||
|
||||
while i < len {
|
||||
let d = a[i] - b[i];
|
||||
sum += d * d;
|
||||
i += 1;
|
||||
}
|
||||
|
||||
sum.sqrt()
|
||||
}
|
||||
|
||||
let mut sum = _mm512_reduce_add_ps(acc);
|
||||
|
||||
while i < len {
|
||||
let d = a[i] - b[i];
|
||||
sum += d * d;
|
||||
i += 1;
|
||||
}
|
||||
|
||||
sum.sqrt()
|
||||
}}
|
||||
}
|
||||
|
||||
@@ -61,8 +61,14 @@ pub enum Backend {
|
||||
Scalar,
|
||||
}
|
||||
|
||||
/// Detect the best available SIMD backend at runtime.
|
||||
/// The best available SIMD backend, detected once per process. Every kernel
|
||||
/// dispatches through this, so it sits in the innermost loop of every search.
|
||||
pub fn detect_backend() -> Backend {
|
||||
static BACKEND: std::sync::OnceLock<Backend> = std::sync::OnceLock::new();
|
||||
*BACKEND.get_or_init(detect_backend_uncached)
|
||||
}
|
||||
|
||||
fn detect_backend_uncached() -> Backend {
|
||||
#[cfg(target_arch = "aarch64")]
|
||||
{
|
||||
return Backend::Neon; // Always available on aarch64
|
||||
@@ -361,6 +367,18 @@ mod tests {
|
||||
assert!(approx_eq(cosine_similarity(&a, &b), 0.0, EPSILON));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_cosine_near_zero_norm_clamped() {
|
||||
// denom = 1e-4 * 1e-4 = 1e-8, comfortably below f32::EPSILON
|
||||
// (~1.19e-7) but not exactly 0.0 — must still clamp to 0.0 so
|
||||
// callers computing `1.0 - cosine_similarity(...)` treat these
|
||||
// as maximally dissimilar, matching the pre-SIMD scalar guard.
|
||||
let a = [1e-4f32];
|
||||
let b = [1e-4f32];
|
||||
assert_eq!(cosine_similarity(&a, &b), 0.0);
|
||||
assert_eq!(scalar::cosine_similarity(&a, &b), 0.0);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_cosine_scalar_vs_dispatch() {
|
||||
let a: Vec<f32> = (0..384).map(|i| (i as f32).sin()).collect();
|
||||
|
||||
@@ -94,7 +94,11 @@ pub unsafe fn cosine_similarity(a: &[f32], b: &[f32]) -> f32 {
|
||||
}
|
||||
|
||||
let denom = (norm_a * norm_b).sqrt();
|
||||
if denom == 0.0 { 0.0 } else { dot / denom }
|
||||
if denom < f32::EPSILON {
|
||||
0.0
|
||||
} else {
|
||||
dot / denom
|
||||
}
|
||||
}
|
||||
|
||||
/// NEON L2 distance.
|
||||
|
||||
@@ -21,7 +21,11 @@ pub fn cosine_similarity(a: &[f32], b: &[f32]) -> f32 {
|
||||
norm_b += y * y;
|
||||
}
|
||||
let denom = (norm_a * norm_b).sqrt();
|
||||
if denom == 0.0 { 0.0 } else { dot / denom }
|
||||
if denom < f32::EPSILON {
|
||||
0.0
|
||||
} else {
|
||||
dot / denom
|
||||
}
|
||||
}
|
||||
|
||||
pub fn batch_cosine(query: &[f32], vectors: &[&[f32]], results: &mut [(usize, f32)]) {
|
||||
|
||||
@@ -1,24 +1,24 @@
|
||||
[package]
|
||||
name = "clawhdf5-agent"
|
||||
version = "2.1.0"
|
||||
version = "2.4.0"
|
||||
edition = "2024"
|
||||
description = "HDF5-backed persistent memory store for on-device AI agents"
|
||||
license = "MIT"
|
||||
repository = "https://github.com/redclawsystems/clawhdf5"
|
||||
repository = "https://git.redclaw.dev/quantumclaw/clawhdf5"
|
||||
readme = "README.md"
|
||||
keywords = ["agent", "memory", "hdf5", "vector-search", "embedding"]
|
||||
categories = ["database", "science", "algorithms"]
|
||||
|
||||
[dependencies]
|
||||
clawhdf5-format = { path = "../clawhdf5-format", version = "2.1.0", features = ["parallel", "fast-checksum"] }
|
||||
clawhdf5 = { path = "../clawhdf5", version = "2.1.0" }
|
||||
clawhdf5-io = { path = "../clawhdf5-io", version = "2.1.0", features = ["mmap"] }
|
||||
clawhdf5-accel = { path = "../clawhdf5-accel", version = "2.1.0" }
|
||||
clawhdf5-ann = { path = "../clawhdf5-ann", version = "2.1.0", optional = true }
|
||||
clawhdf5-gpu = { path = "../clawhdf5-gpu", version = "2.1.0", optional = true, default-features = false }
|
||||
serde = { version = "1", features = ["derive"] }
|
||||
clawhdf5-format = { path = "../clawhdf5-format", version = "2.4.0", features = ["parallel", "fast-checksum"] }
|
||||
clawhdf5 = { path = "../clawhdf5", version = "2.4.0" }
|
||||
clawhdf5-io = { path = "../clawhdf5-io", version = "2.4.0", features = ["mmap"] }
|
||||
clawhdf5-accel = { path = "../clawhdf5-accel", version = "2.4.0" }
|
||||
clawhdf5-ann = { path = "../clawhdf5-ann", version = "2.4.0", optional = true }
|
||||
clawhdf5-gpu = { path = "../clawhdf5-gpu", version = "2.4.0", optional = true, default-features = false }
|
||||
serde = { workspace = true }
|
||||
byteorder = "1"
|
||||
half = { version = "2", optional = true }
|
||||
half = { workspace = true, optional = true }
|
||||
rayon = { version = "1", optional = true }
|
||||
matrixmultiply = { version = "0.3", optional = true }
|
||||
cblas-sys = { version = "0.1", optional = true }
|
||||
@@ -31,8 +31,8 @@ accelerate-src = { version = "0.3", optional = true }
|
||||
openblas-src = { version = "0.10", optional = true, features = ["cblas"] }
|
||||
|
||||
[dev-dependencies]
|
||||
tempfile = "3"
|
||||
criterion = "0.5"
|
||||
tempfile = { workspace = true }
|
||||
criterion = { workspace = true }
|
||||
rayon = "1"
|
||||
tokio = { version = "1", features = ["rt-multi-thread", "sync", "macros"] }
|
||||
|
||||
@@ -48,6 +48,9 @@ harness = false
|
||||
default = ["float16", "hnsw"]
|
||||
float16 = ["half"]
|
||||
parallel = ["rayon"]
|
||||
# Compress embeddings with Zstd instead of deflate when
|
||||
# `MemoryConfig::compression` is on. Off by default: it links libzstd (C).
|
||||
zstd = ["clawhdf5/zstd"]
|
||||
# HNSW approximate-nearest-neighbour acceleration for the vector stage of
|
||||
# hybrid_search. On by default; the index is rebuilt from the cache on demand
|
||||
# and stays self-consistent with the persisted memory store. Disable with
|
||||
|
||||
@@ -483,7 +483,7 @@ fn rayon_benches(c: &mut Criterion) {
|
||||
use rayon::prelude::*;
|
||||
let query_norm = vector_search::compute_norm(&query);
|
||||
let num_cores = rayon::current_num_threads().max(1);
|
||||
let chunk_size = (n + num_cores - 1) / num_cores;
|
||||
let chunk_size = n.div_ceil(num_cores);
|
||||
let mut results: Vec<(usize, f32)> = vectors
|
||||
.par_chunks(chunk_size)
|
||||
.enumerate()
|
||||
@@ -537,7 +537,7 @@ fn rayon_benches(c: &mut Criterion) {
|
||||
use rayon::prelude::*;
|
||||
let query_norm = vector_search::compute_norm(&query);
|
||||
let num_cores = rayon::current_num_threads().max(1);
|
||||
let chunk_size = (n + num_cores - 1) / num_cores;
|
||||
let chunk_size = n.div_ceil(num_cores);
|
||||
let mut results: Vec<(usize, f32)> = vectors
|
||||
.par_chunks(chunk_size)
|
||||
.enumerate()
|
||||
@@ -766,12 +766,22 @@ fn adaptive_benches(c: &mut Criterion) {
|
||||
.map(|v| vector_search::compute_norm(v))
|
||||
.collect();
|
||||
let tombstones = vec![0u8; n];
|
||||
let flat: Vec<f32> = vectors.iter().flatten().copied().collect();
|
||||
|
||||
c.bench_function("adaptive_search_10k", |b| {
|
||||
let hw = HardwareCapabilities::detect();
|
||||
let strat = strategy::auto_select_strategy(n, &hw);
|
||||
b.iter(|| {
|
||||
strategy::search_with_metrics(&query, &vectors, &norms, &tombstones, 10, strat, None)
|
||||
strategy::search_with_metrics(
|
||||
&query,
|
||||
&vectors,
|
||||
&flat,
|
||||
&norms,
|
||||
&tombstones,
|
||||
10,
|
||||
strat,
|
||||
None,
|
||||
)
|
||||
});
|
||||
});
|
||||
|
||||
@@ -781,6 +791,7 @@ fn adaptive_benches(c: &mut Criterion) {
|
||||
strategy::search_with_metrics(
|
||||
&query,
|
||||
&vectors,
|
||||
&flat,
|
||||
&norms,
|
||||
&tombstones,
|
||||
10,
|
||||
@@ -795,6 +806,7 @@ fn adaptive_benches(c: &mut Criterion) {
|
||||
strategy::search_with_metrics(
|
||||
&query,
|
||||
&vectors,
|
||||
&flat,
|
||||
&norms,
|
||||
&tombstones,
|
||||
10,
|
||||
@@ -809,6 +821,7 @@ fn adaptive_benches(c: &mut Criterion) {
|
||||
strategy::search_with_metrics(
|
||||
&query,
|
||||
&vectors,
|
||||
&flat,
|
||||
&norms,
|
||||
&tombstones,
|
||||
10,
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
use clawhdf5_agent::bm25::BM25Index;
|
||||
use clawhdf5_agent::consolidation::{
|
||||
ConsolidationConfig, ConsolidationEngine, ImportanceScorer, ImportanceWeights, MemorySource,
|
||||
UntrustedSource,
|
||||
};
|
||||
use clawhdf5_agent::hybrid::{hybrid_search, rrf_hybrid_search};
|
||||
use clawhdf5_agent::knowledge::KnowledgeCache;
|
||||
@@ -285,7 +286,12 @@ fn consolidation_benches(c: &mut Criterion) {
|
||||
for i in 0..n {
|
||||
let embedding = make_vec(&mut rng, DIM);
|
||||
let chunk = format!("memory record {i} with some content");
|
||||
engine.add_memory(chunk, embedding, MemorySource::User, now + i as f64);
|
||||
engine.add_memory(
|
||||
chunk,
|
||||
embedding,
|
||||
UntrustedSource::User,
|
||||
now + i as f64,
|
||||
);
|
||||
}
|
||||
engine
|
||||
},
|
||||
@@ -307,9 +313,10 @@ fn consolidation_benches(c: &mut Criterion) {
|
||||
for i in 0..50usize {
|
||||
let embedding = make_vec(&mut rng, DIM);
|
||||
let chunk = format!("existing record {i}");
|
||||
engine.add_memory(chunk, embedding, MemorySource::User, now + i as f64);
|
||||
engine.add_memory(chunk, embedding, UntrustedSource::User, now + i as f64);
|
||||
}
|
||||
let records = engine.records().to_vec();
|
||||
let record_refs: Vec<&_> = records.iter().collect();
|
||||
let weights = ImportanceWeights::default();
|
||||
let query_embedding = make_vec(&mut rng, DIM);
|
||||
let sample_text =
|
||||
@@ -317,7 +324,7 @@ fn consolidation_benches(c: &mut Criterion) {
|
||||
|
||||
group.bench_function("bench_importance_scoring", |b| {
|
||||
b.iter(|| {
|
||||
let surprise = ImportanceScorer::score_surprise(&query_embedding, &records);
|
||||
let surprise = ImportanceScorer::score_surprise(&query_embedding, &record_refs);
|
||||
let correction = ImportanceScorer::score_correction(&MemorySource::Correction);
|
||||
let length = ImportanceScorer::score_length(sample_text);
|
||||
ImportanceScorer::score_combined(surprise, correction, length, &weights)
|
||||
@@ -354,7 +361,7 @@ fn temporal_benches(c: &mut Criterion) {
|
||||
// Insert benchmark: measure time to insert 10k timestamps one by one
|
||||
group.bench_function("bench_temporal_insert_10k", |b| {
|
||||
b.iter_batched(
|
||||
|| TemporalIndex::new(),
|
||||
TemporalIndex::new,
|
||||
|mut idx| {
|
||||
for i in 0..N {
|
||||
// Shuffle insertion order slightly using a simple offset pattern
|
||||
@@ -442,7 +449,8 @@ fn large_consolidation_benches(c: &mut Criterion) {
|
||||
let mut group = c.benchmark_group("consolidation_large");
|
||||
group.sample_size(10);
|
||||
|
||||
for (label, n) in [("10k", 10_000usize)] {
|
||||
{
|
||||
let (label, n) = ("10k", 10_000usize);
|
||||
group.bench_with_input(
|
||||
BenchmarkId::new("bench_consolidation_cycle", label),
|
||||
&n,
|
||||
@@ -459,7 +467,12 @@ fn large_consolidation_benches(c: &mut Criterion) {
|
||||
for i in 0..n {
|
||||
let embedding = make_vec(&mut rng, DIM);
|
||||
let chunk = format!("memory record {i} with content");
|
||||
engine.add_memory(chunk, embedding, MemorySource::User, now + i as f64);
|
||||
engine.add_memory(
|
||||
chunk,
|
||||
embedding,
|
||||
UntrustedSource::User,
|
||||
now + i as f64,
|
||||
);
|
||||
}
|
||||
engine
|
||||
},
|
||||
|
||||
@@ -0,0 +1,3 @@
|
||||
target/
|
||||
artifacts/
|
||||
coverage/
|
||||
@@ -0,0 +1,23 @@
|
||||
[package]
|
||||
name = "clawhdf5-agent-fuzz"
|
||||
version = "0.0.0"
|
||||
publish = false
|
||||
edition = "2024"
|
||||
|
||||
[package.metadata]
|
||||
cargo-fuzz = true
|
||||
|
||||
[dependencies]
|
||||
libfuzzer-sys = "0.4"
|
||||
tempfile = "3"
|
||||
|
||||
[dependencies.clawhdf5-agent]
|
||||
path = ".."
|
||||
|
||||
[workspace]
|
||||
members = ["."]
|
||||
|
||||
[[bin]]
|
||||
name = "fuzz_wal_replay"
|
||||
path = "fuzz_targets/fuzz_wal_replay.rs"
|
||||
doc = false
|
||||
@@ -0,0 +1,36 @@
|
||||
#![no_main]
|
||||
//! Arbitrary bytes as a WAL file. Reading, and opening for append (which scans
|
||||
//! the chain and truncates an unverifiable tail), must never panic, hang, or
|
||||
//! allocate without bound — and after `open` repairs the file, everything
|
||||
//! `read_entries` returned before must still be returned.
|
||||
//!
|
||||
//! The deterministic counterpart that runs in ordinary CI is
|
||||
//! `tests/wal_properties.rs`; this target explores inputs it cannot reach.
|
||||
|
||||
use std::io::Write as _;
|
||||
|
||||
use clawhdf5_agent::wal::WalFile;
|
||||
use libfuzzer_sys::fuzz_target;
|
||||
|
||||
fuzz_target!(|data: &[u8]| {
|
||||
let Ok(mut tmp) = tempfile::NamedTempFile::new() else {
|
||||
return;
|
||||
};
|
||||
if tmp.write_all(data).and_then(|()| tmp.flush()).is_err() {
|
||||
return;
|
||||
}
|
||||
let before = WalFile::read_entries(tmp.path()).map(|e| e.len());
|
||||
// Only the chained formats (header versions 3 and 4) are repaired in
|
||||
// place. `open` deliberately recreates a legacy-format file from scratch:
|
||||
// `HDF5Memory::open` has already replayed its entries by then.
|
||||
let chained = matches!(data.get(4), Some(3 | 4));
|
||||
let opened = WalFile::open(tmp.path());
|
||||
if !chained {
|
||||
return;
|
||||
}
|
||||
if let (Ok(before), Ok(wal)) = (before, opened) {
|
||||
drop(wal);
|
||||
let after = WalFile::read_entries(tmp.path()).map(|e| e.len());
|
||||
assert_eq!(after.ok(), Some(before), "open() changed what is replayable");
|
||||
}
|
||||
});
|
||||
@@ -82,6 +82,68 @@ impl Default for AnomalyConfig {
|
||||
}
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Pattern-match normalization
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
/// `true` for characters used to invisibly break up text without being
|
||||
/// rendered (zero-width joiners/spacers, bidi control marks, the BOM/ZWNBSP,
|
||||
/// soft hyphen, and the invisible math operators) — a common trick for
|
||||
/// splitting a flagged word so a literal-substring check misses it while the
|
||||
/// text still displays normally.
|
||||
fn is_invisible_format_char(ch: char) -> bool {
|
||||
matches!(
|
||||
ch,
|
||||
'\u{00AD}' // soft hyphen
|
||||
| '\u{200B}' // zero width space
|
||||
| '\u{200C}' // zero width non-joiner
|
||||
| '\u{200D}' // zero width joiner
|
||||
| '\u{200E}' // left-to-right mark
|
||||
| '\u{200F}' // right-to-left mark
|
||||
| '\u{2060}' // word joiner
|
||||
| '\u{2061}'..='\u{2064}' // invisible times/plus/separator/function application
|
||||
| '\u{202A}'..='\u{202E}' // bidi embedding/override controls
|
||||
| '\u{FEFF}' // BOM / zero width no-break space
|
||||
)
|
||||
}
|
||||
|
||||
/// Normalize text before suspicious-pattern matching so the cheapest evasion
|
||||
/// tricks — extra whitespace, zero-width characters, or punctuation spliced
|
||||
/// between letters (e.g. `"s.y.s.t.e.m"`) — don't defeat a literal-substring
|
||||
/// check. Lowercases, drops invisible-format and control characters, drops
|
||||
/// punctuation entirely (not just collapses it, so split words rejoin), and
|
||||
/// collapses whitespace runs to a single space.
|
||||
///
|
||||
/// Does not perform Unicode NFKC normalization or confusable/homoglyph
|
||||
/// folding (see [`WriteAnomalyDetector::check_pattern_anomaly`]).
|
||||
fn normalize_for_pattern_match(text: &str) -> String {
|
||||
let mut out = String::with_capacity(text.len());
|
||||
let mut last_was_space = true; // trims leading whitespace for free
|
||||
for ch in text.chars() {
|
||||
if ch.is_control() || is_invisible_format_char(ch) {
|
||||
continue;
|
||||
}
|
||||
if ch.is_whitespace() {
|
||||
if !last_was_space {
|
||||
out.push(' ');
|
||||
last_was_space = true;
|
||||
}
|
||||
continue;
|
||||
}
|
||||
if ch.is_ascii_punctuation() {
|
||||
continue;
|
||||
}
|
||||
for lower in ch.to_lowercase() {
|
||||
out.push(lower);
|
||||
}
|
||||
last_was_space = false;
|
||||
}
|
||||
while out.ends_with(' ') {
|
||||
out.pop();
|
||||
}
|
||||
out
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// WriteEvent
|
||||
// ---------------------------------------------------------------------------
|
||||
@@ -99,6 +161,9 @@ pub struct WriteEvent {
|
||||
// WriteAnomalyDetector
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
/// Upper bound on distinct session ids the detector tracks at once.
|
||||
const MAX_TRACKED_SESSIONS: usize = 4096;
|
||||
|
||||
/// Tracks write events and raises alerts for suspicious behaviour.
|
||||
#[derive(Debug)]
|
||||
pub struct WriteAnomalyDetector {
|
||||
@@ -127,6 +192,23 @@ impl WriteAnomalyDetector {
|
||||
if event.timestamp > self.last_timestamp {
|
||||
self.last_timestamp = event.timestamp;
|
||||
}
|
||||
// Bound the per-session map: a long-lived process sees an unbounded
|
||||
// number of distinct session ids. When it overflows, forget the
|
||||
// sessions with the fewest writes (they are furthest from the limit
|
||||
// this map exists to enforce); the current one is re-added below.
|
||||
if self.session_counts.len() >= MAX_TRACKED_SESSIONS
|
||||
&& !self.session_counts.contains_key(&event.session_id)
|
||||
{
|
||||
let mut counts: Vec<u32> = self.session_counts.values().copied().collect();
|
||||
let keep_from = counts.len() / 2;
|
||||
counts.select_nth_unstable(keep_from);
|
||||
let threshold = counts[keep_from];
|
||||
self.session_counts.retain(|_, c| *c >= threshold);
|
||||
if self.session_counts.len() >= MAX_TRACKED_SESSIONS {
|
||||
// Every session had the same count: drop them all.
|
||||
self.session_counts.clear();
|
||||
}
|
||||
}
|
||||
*self
|
||||
.session_counts
|
||||
.entry(event.session_id.clone())
|
||||
@@ -146,6 +228,13 @@ impl WriteAnomalyDetector {
|
||||
/// Returns an alert if the number of writes in the last 60 seconds exceeds
|
||||
/// `config.max_writes_per_minute`, or if any session has exceeded
|
||||
/// `config.max_writes_per_session`.
|
||||
///
|
||||
/// The 60-second window is a single shared window across all
|
||||
/// sessions/sources, so when it trips the alert additionally names the
|
||||
/// top-contributing session and source within that window — a session
|
||||
/// can never account for more of the window than the aggregate count, so
|
||||
/// this attributes the same trip to its actual offender rather than
|
||||
/// reporting only the anonymous aggregate total.
|
||||
pub fn check_rate_anomaly(&self) -> Option<AnomalyAlert> {
|
||||
let recent = self.window.len() as u32;
|
||||
if recent > self.config.max_writes_per_minute {
|
||||
@@ -156,11 +245,31 @@ impl WriteAnomalyDetector {
|
||||
} else {
|
||||
Severity::Medium
|
||||
};
|
||||
|
||||
let mut per_session: std::collections::HashMap<&str, u32> =
|
||||
std::collections::HashMap::new();
|
||||
// MemorySource isn't Eq/Hash, so key by its Display string instead.
|
||||
let mut per_source: std::collections::HashMap<String, u32> =
|
||||
std::collections::HashMap::new();
|
||||
for e in &self.window {
|
||||
*per_session.entry(e.session_id.as_str()).or_insert(0) += 1;
|
||||
*per_source.entry(e.source.to_string()).or_insert(0) += 1;
|
||||
}
|
||||
let top_session = per_session.iter().max_by_key(|&(_, &c)| c);
|
||||
let top_source = per_source.iter().max_by_key(|&(_, &c)| c);
|
||||
|
||||
let attribution = match (top_session, top_source) {
|
||||
(Some((session, s_count)), Some((source, r_count))) => format!(
|
||||
"; top contributor: session '{session}' with {s_count} writes, \
|
||||
source {source} with {r_count} writes"
|
||||
),
|
||||
_ => String::new(),
|
||||
};
|
||||
return Some(AnomalyAlert {
|
||||
severity,
|
||||
message: format!(
|
||||
"Rate limit exceeded: {} writes in last 60s (max {})",
|
||||
recent, self.config.max_writes_per_minute
|
||||
"Rate limit exceeded: {} writes in last 60s (max {}){}",
|
||||
recent, self.config.max_writes_per_minute, attribution
|
||||
),
|
||||
timestamp: self.last_timestamp,
|
||||
});
|
||||
@@ -188,11 +297,24 @@ impl WriteAnomalyDetector {
|
||||
// -----------------------------------------------------------------------
|
||||
|
||||
/// Returns an alert if `chunk` contains any of the configured suspicious
|
||||
/// patterns (case-insensitive).
|
||||
/// patterns, after normalizing both sides to defeat the cheapest evasion
|
||||
/// tricks (case, extra whitespace, punctuation between letters,
|
||||
/// zero-width/invisible-formatting characters).
|
||||
///
|
||||
/// This does not perform Unicode NFKC normalization or confusable/
|
||||
/// homoglyph folding (e.g. Cyrillic 'а' standing in for Latin 'a') —
|
||||
/// that needs a per-codepoint confusable table (Unicode's
|
||||
/// `confusables.txt`) beyond what's practical to hand-roll correctly,
|
||||
/// and no such crate is a dependency of this crate today. A determined
|
||||
/// attacker using homoglyphs can still evade these patterns.
|
||||
pub fn check_pattern_anomaly(&self, chunk: &str) -> Option<AnomalyAlert> {
|
||||
let lower = chunk.to_lowercase();
|
||||
let normalized = normalize_for_pattern_match(chunk);
|
||||
for pattern in &self.config.suspicious_patterns {
|
||||
if lower.contains(pattern.as_str()) {
|
||||
let normalized_pattern = normalize_for_pattern_match(pattern);
|
||||
if normalized_pattern.is_empty() {
|
||||
continue;
|
||||
}
|
||||
if normalized.contains(&normalized_pattern) {
|
||||
let severity = if pattern.contains("ignore") || pattern.contains("override") {
|
||||
Severity::Critical
|
||||
} else if pattern.contains("system") || pattern.contains("jailbreak") {
|
||||
@@ -327,6 +449,57 @@ mod tests {
|
||||
assert!(alert.unwrap().severity >= Severity::Medium);
|
||||
}
|
||||
|
||||
/// A single session dominating the shared 60s window must be named in
|
||||
/// the alert, not just the anonymous aggregate count — this is the case
|
||||
/// the separate cumulative max_writes_per_session check doesn't cover
|
||||
/// (the window can trip before the session's lifetime total does).
|
||||
#[test]
|
||||
fn rate_anomaly_names_offending_session() {
|
||||
let mut det = WriteAnomalyDetector::new(cfg());
|
||||
for i in 0..11 {
|
||||
det.record_write(event(
|
||||
1.0 + i as f64 * 0.1,
|
||||
"flood-session",
|
||||
MemorySource::User,
|
||||
));
|
||||
}
|
||||
let alert = det.check_rate_anomaly().unwrap();
|
||||
assert!(
|
||||
alert.message.contains("flood-session"),
|
||||
"expected the offending session to be named, got: {}",
|
||||
alert.message
|
||||
);
|
||||
}
|
||||
|
||||
/// When many distinct sessions jointly trip the shared window, the top
|
||||
/// contributor named must actually be the one with the most writes.
|
||||
#[test]
|
||||
fn rate_anomaly_attributes_top_contributor_among_many_sessions() {
|
||||
let mut det = WriteAnomalyDetector::new(cfg());
|
||||
// 5 sessions with 1 write each (below any per-session limit)...
|
||||
for i in 0..5 {
|
||||
det.record_write(event(
|
||||
1.0 + i as f64 * 0.1,
|
||||
"minor-session",
|
||||
MemorySource::User,
|
||||
));
|
||||
}
|
||||
// ...plus one session responsible for the majority of the flood.
|
||||
for i in 0..8 {
|
||||
det.record_write(event(
|
||||
2.0 + i as f64 * 0.1,
|
||||
"major-session",
|
||||
MemorySource::User,
|
||||
));
|
||||
}
|
||||
let alert = det.check_rate_anomaly().unwrap();
|
||||
assert!(
|
||||
alert.message.contains("major-session"),
|
||||
"expected the top contributor to be named, got: {}",
|
||||
alert.message
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn rate_anomaly_critical_3x() {
|
||||
let mut det = WriteAnomalyDetector::new(cfg());
|
||||
@@ -395,6 +568,71 @@ mod tests {
|
||||
assert!(alert.is_some());
|
||||
}
|
||||
|
||||
// --- Pattern-match evasion hardening ---
|
||||
|
||||
#[test]
|
||||
fn pattern_defeats_extra_whitespace() {
|
||||
let det = WriteAnomalyDetector::new(cfg());
|
||||
let alert = det.check_pattern_anomaly("please ignore previous instructions");
|
||||
assert!(alert.is_some(), "extra whitespace must not defeat matching");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn pattern_defeats_punctuation_splicing() {
|
||||
let det = WriteAnomalyDetector::new(cfg());
|
||||
let alert = det.check_pattern_anomaly("i.g.n.o.r.e p-r-e-v-i-o-u-s instructions");
|
||||
assert!(
|
||||
alert.is_some(),
|
||||
"punctuation spliced between letters must not defeat matching"
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn pattern_defeats_zero_width_space() {
|
||||
let det = WriteAnomalyDetector::new(cfg());
|
||||
// Zero-width space (U+200B) inserted mid-word.
|
||||
let chunk = "ign\u{200B}ore previ\u{200B}ous instructions";
|
||||
let alert = det.check_pattern_anomaly(chunk);
|
||||
assert!(
|
||||
alert.is_some(),
|
||||
"zero-width space injection must not defeat matching"
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn pattern_defeats_zero_width_joiner_and_bom() {
|
||||
let det = WriteAnomalyDetector::new(cfg());
|
||||
let chunk = "jail\u{200D}break\u{FEFF} attempt";
|
||||
let alert = det.check_pattern_anomaly(chunk);
|
||||
assert!(
|
||||
alert.is_some(),
|
||||
"ZWJ/BOM injection must not defeat matching"
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn pattern_still_clean_after_normalization() {
|
||||
let det = WriteAnomalyDetector::new(cfg());
|
||||
// Normalization must not introduce false positives on ordinary text
|
||||
// that merely contains punctuation and extra whitespace.
|
||||
let alert =
|
||||
det.check_pattern_anomaly("Well, I think... the weather is nice today, right?");
|
||||
assert!(alert.is_none());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn normalize_for_pattern_match_examples() {
|
||||
assert_eq!(
|
||||
normalize_for_pattern_match("i.g.n.o.r.e p-r-e-v-i-o-u-s"),
|
||||
"ignore previous"
|
||||
);
|
||||
assert_eq!(
|
||||
normalize_for_pattern_match("ign\u{200B}ore previous"),
|
||||
"ignore previous"
|
||||
);
|
||||
assert_eq!(normalize_for_pattern_match("SYSTEM:"), "system");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn pattern_jailbreak() {
|
||||
let det = WriteAnomalyDetector::new(cfg());
|
||||
|
||||
@@ -408,6 +408,10 @@ impl AsyncHDF5Memory {
|
||||
let (tx, rx) = oneshot::channel();
|
||||
let _ = self.write_tx.send(WriteCmd::Shutdown(tx)).await;
|
||||
let _ = rx.await;
|
||||
// The writer task has stopped, so nothing can write through this
|
||||
// handle any more: release the single-writer lock now rather than at
|
||||
// drop, so the store can be reopened while `self` is still in scope.
|
||||
self.inner.lock().await.release_store_lock();
|
||||
Ok(())
|
||||
}
|
||||
}
|
||||
|
||||
+273
-118
@@ -3,12 +3,38 @@
|
||||
//! Provides a standard BM25 (Okapi BM25) implementation with an in-memory
|
||||
//! inverted index. Tombstoned documents are excluded from indexing and search.
|
||||
//!
|
||||
//! Optimizations:
|
||||
//! - Cached IDF scores (don't recompute per query)
|
||||
//! - Sorted posting lists by doc_id for cache-friendly access
|
||||
//! - Block-Max WAND early termination
|
||||
//! The index is **incremental**: [`BM25Index::add_document`] and
|
||||
//! [`BM25Index::remove_document`] keep it exactly equivalent to one built from
|
||||
//! scratch over the same live documents, so a store can maintain one index for
|
||||
//! its lifetime instead of re-tokenising the whole corpus per query. To make
|
||||
//! that possible IDF is computed at query time (it depends on the live
|
||||
//! document count) rather than cached at build time.
|
||||
//!
|
||||
//! - Posting lists sorted by doc id
|
||||
//! - Bounded-heap top-k; results ordered by score, then doc id (deterministic)
|
||||
|
||||
use std::collections::HashMap;
|
||||
use std::cmp::Reverse;
|
||||
use std::collections::{BinaryHeap, HashMap};
|
||||
|
||||
/// `f32` wrapper providing a total order (via `total_cmp`) so BM25 scores can
|
||||
/// be kept in a `BinaryHeap`. Scores are always finite in practice (no NaN
|
||||
/// inputs reach this path), so `total_cmp`'s NaN ordering is never exercised.
|
||||
#[derive(Debug, Clone, Copy, PartialEq)]
|
||||
struct HeapScore(f32);
|
||||
|
||||
impl Eq for HeapScore {}
|
||||
|
||||
impl PartialOrd for HeapScore {
|
||||
fn partial_cmp(&self, other: &Self) -> Option<std::cmp::Ordering> {
|
||||
Some(self.cmp(other))
|
||||
}
|
||||
}
|
||||
|
||||
impl Ord for HeapScore {
|
||||
fn cmp(&self, other: &Self) -> std::cmp::Ordering {
|
||||
self.0.total_cmp(&other.0)
|
||||
}
|
||||
}
|
||||
|
||||
/// Default BM25 term-frequency saturation parameter.
|
||||
const DEFAULT_K1: f32 = 1.2;
|
||||
@@ -20,10 +46,11 @@ const DEFAULT_B: f32 = 0.75;
|
||||
pub struct BM25Index {
|
||||
/// Inverted index: token -> sorted list of (doc_id, term_frequency).
|
||||
inverted: HashMap<String, Vec<(usize, u32)>>,
|
||||
/// Cached IDF scores per token.
|
||||
idf_cache: HashMap<String, f32>,
|
||||
/// Number of tokens in each document (0 for tombstoned docs).
|
||||
doc_lengths: Vec<u32>,
|
||||
/// Sum of `doc_lengths` over live documents (keeps `avg_dl` exact under
|
||||
/// incremental updates).
|
||||
total_length: u64,
|
||||
/// Average document length across non-tombstoned docs.
|
||||
avg_dl: f32,
|
||||
/// Number of non-tombstoned documents.
|
||||
@@ -39,8 +66,8 @@ impl BM25Index {
|
||||
pub fn build(documents: &[String], tombstones: &[u8]) -> Self {
|
||||
let mut index = Self {
|
||||
inverted: HashMap::new(),
|
||||
idf_cache: HashMap::new(),
|
||||
doc_lengths: vec![0; documents.len()],
|
||||
total_length: 0,
|
||||
avg_dl: 0.0,
|
||||
num_docs: 0,
|
||||
k1: DEFAULT_K1,
|
||||
@@ -56,112 +83,160 @@ impl BM25Index {
|
||||
/// Uses Block-Max WAND for early termination when remaining documents
|
||||
/// cannot beat the current top-k threshold.
|
||||
pub fn search(&self, query: &str, k: usize) -> Vec<(usize, f32)> {
|
||||
if self.num_docs == 0 || k == 0 {
|
||||
if k == 0 {
|
||||
return Vec::new();
|
||||
}
|
||||
|
||||
let tokens = tokenize(query);
|
||||
if tokens.is_empty() {
|
||||
return Vec::new();
|
||||
}
|
||||
|
||||
// Collect posting lists and cached IDF scores for query tokens
|
||||
type QueryTerm<'a> = (&'a str, f32, &'a [(usize, u32)]);
|
||||
let mut query_terms: Vec<QueryTerm<'_>> = Vec::new();
|
||||
for token in &tokens {
|
||||
if let (Some(postings), Some(&idf)) = (
|
||||
self.inverted.get(token.as_str()),
|
||||
self.idf_cache.get(token.as_str()),
|
||||
) {
|
||||
query_terms.push((token, idf, postings));
|
||||
// Top-k with a bounded min-heap: O(matches * log k) instead of sorting
|
||||
// every match. Ties break towards the lower doc id so results are
|
||||
// deterministic.
|
||||
let mut heap: BinaryHeap<Reverse<(HeapScore, Reverse<usize>)>> =
|
||||
BinaryHeap::with_capacity(k.min(1024) + 1);
|
||||
for (doc_id, score) in self.scores(query) {
|
||||
heap.push(Reverse((HeapScore(score), Reverse(doc_id))));
|
||||
if heap.len() > k {
|
||||
heap.pop();
|
||||
}
|
||||
}
|
||||
let mut results: Vec<(usize, f32)> = heap
|
||||
.into_iter()
|
||||
.map(|Reverse((HeapScore(score), Reverse(doc_id)))| (doc_id, score))
|
||||
.collect();
|
||||
results.sort_by(|a, b| b.1.total_cmp(&a.1).then(a.0.cmp(&b.0)));
|
||||
results
|
||||
}
|
||||
|
||||
if query_terms.is_empty() {
|
||||
/// The BM25 score of **every** matching document, in doc-id order, unsorted
|
||||
/// by score. Score fusion normalises over the whole matching set, so it
|
||||
/// needs all of these but not their ranking; producing a ranked list of
|
||||
/// every match (`search(query, corpus_len)`) spent most of its time sorting.
|
||||
pub fn scores(&self, query: &str) -> Vec<(usize, f32)> {
|
||||
if self.num_docs == 0 {
|
||||
return Vec::new();
|
||||
}
|
||||
|
||||
// Accumulate BM25 scores per document using WAND-style scoring
|
||||
let mut scores: HashMap<usize, f32> = HashMap::new();
|
||||
|
||||
// Compute maximum possible contribution per term for WAND
|
||||
let max_tf_score: Vec<f32> = query_terms
|
||||
.iter()
|
||||
.map(|(_, idf, _)| {
|
||||
// Upper bound: max TF contribution when tf is high and dl is short
|
||||
let max_tf_num = 10.0 * (self.k1 + 1.0);
|
||||
let max_tf_den = 10.0 + self.k1 * (1.0 - self.b);
|
||||
idf * max_tf_num / max_tf_den
|
||||
})
|
||||
.collect();
|
||||
|
||||
let total_max_contribution: f32 = max_tf_score.iter().sum();
|
||||
|
||||
// Threshold for WAND early termination
|
||||
let mut threshold = 0.0f32;
|
||||
let mut top_k_scores: Vec<f32> = Vec::with_capacity(k);
|
||||
|
||||
for (term_idx, (_, idf, postings)) in query_terms.iter().enumerate() {
|
||||
for &(doc_id, freq) in *postings {
|
||||
// Term-at-a-time accumulation into a dense array: a common term has a
|
||||
// posting per document, and hashing each one dominated query time.
|
||||
// IDF is computed here rather than cached at build time: it depends on
|
||||
// the live document count, which changes with every incremental
|
||||
// add/remove, and costs one `ln` per query term.
|
||||
let mut acc = vec![0.0f32; self.doc_lengths.len()];
|
||||
let mut matched = false;
|
||||
for token in tokenize(query) {
|
||||
let Some(postings) = self.inverted.get(token.as_str()) else {
|
||||
continue;
|
||||
};
|
||||
matched = true;
|
||||
let df = postings.len() as f32;
|
||||
let idf = ((self.num_docs as f32 - df + 0.5) / (df + 0.5) + 1.0).ln();
|
||||
for &(doc_id, freq) in postings {
|
||||
let dl = self.doc_lengths[doc_id] as f32;
|
||||
let freq_f = freq as f32;
|
||||
let tf = (freq_f * (self.k1 + 1.0))
|
||||
/ (freq_f + self.k1 * (1.0 - self.b + self.b * dl / self.avg_dl));
|
||||
let contribution = idf * tf;
|
||||
|
||||
let entry = scores.entry(doc_id).or_insert(0.0);
|
||||
*entry += contribution;
|
||||
|
||||
// WAND check: if this doc's current partial score + remaining
|
||||
// max terms can't beat threshold, we can skip (but we still
|
||||
// accumulate since we process term-at-a-time)
|
||||
if term_idx == query_terms.len() - 1 {
|
||||
// Last term: check if this doc beats threshold
|
||||
let final_score = *entry;
|
||||
if final_score > threshold && top_k_scores.len() >= k {
|
||||
// Update threshold
|
||||
top_k_scores
|
||||
.sort_by(|a, b| b.partial_cmp(a).unwrap_or(std::cmp::Ordering::Equal));
|
||||
if final_score > top_k_scores[k - 1] {
|
||||
top_k_scores[k - 1] = final_score;
|
||||
top_k_scores.sort_by(|a, b| {
|
||||
b.partial_cmp(a).unwrap_or(std::cmp::Ordering::Equal)
|
||||
});
|
||||
threshold = top_k_scores[k - 1];
|
||||
}
|
||||
} else if top_k_scores.len() < k {
|
||||
top_k_scores.push(final_score);
|
||||
if top_k_scores.len() == k {
|
||||
top_k_scores.sort_by(|a, b| {
|
||||
b.partial_cmp(a).unwrap_or(std::cmp::Ordering::Equal)
|
||||
});
|
||||
threshold = top_k_scores[k - 1];
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
// After processing each term, check if remaining terms can
|
||||
// possibly produce results above threshold
|
||||
let remaining_max: f32 = max_tf_score[term_idx + 1..].iter().sum();
|
||||
if remaining_max < threshold && total_max_contribution > 0.0 {
|
||||
// Early termination: remaining terms can't produce new top-k
|
||||
// entries on their own. But existing partial scores may still
|
||||
// be updated, so we continue (WAND is approximate here).
|
||||
let _ = remaining_max; // hint to compiler
|
||||
acc[doc_id] += idf * tf;
|
||||
}
|
||||
}
|
||||
if !matched {
|
||||
return Vec::new();
|
||||
}
|
||||
// Every contribution is strictly positive (idf = ln(1 + x), x > 0), so
|
||||
// a zero entry is a document no query term touched.
|
||||
acc.into_iter()
|
||||
.enumerate()
|
||||
.filter(|&(_, score)| score > 0.0)
|
||||
.collect()
|
||||
}
|
||||
|
||||
let mut results: Vec<(usize, f32)> = scores.into_iter().collect();
|
||||
results.sort_by(|a, b| b.1.partial_cmp(&a.1).unwrap_or(std::cmp::Ordering::Equal));
|
||||
results.truncate(k);
|
||||
results
|
||||
/// Number of document slots (live or not) the index covers. Ids are
|
||||
/// positions in the document list it mirrors.
|
||||
pub fn len(&self) -> usize {
|
||||
self.doc_lengths.len()
|
||||
}
|
||||
|
||||
/// `true` when the index covers no document slots.
|
||||
pub fn is_empty(&self) -> bool {
|
||||
self.doc_lengths.is_empty()
|
||||
}
|
||||
|
||||
/// Index `text` as document `doc_id`, which must be the next free id
|
||||
/// (`self.len()`) or an existing slot that is currently empty (removed or
|
||||
/// tombstoned). After any sequence of `add_document` / `remove_document`
|
||||
/// calls the index scores exactly as one freshly built from the same live
|
||||
/// documents.
|
||||
pub fn add_document(&mut self, doc_id: usize, text: &str) {
|
||||
if doc_id >= self.doc_lengths.len() {
|
||||
self.doc_lengths.resize(doc_id + 1, 0);
|
||||
}
|
||||
debug_assert_eq!(self.doc_lengths[doc_id], 0, "slot {doc_id} is occupied");
|
||||
|
||||
let tokens = tokenize(text);
|
||||
let mut term_freqs: HashMap<&str, u32> = HashMap::new();
|
||||
for token in &tokens {
|
||||
*term_freqs.entry(token).or_insert(0) += 1;
|
||||
}
|
||||
for (token, freq) in term_freqs {
|
||||
let postings = self.inverted.entry(token.to_string()).or_default();
|
||||
// Posting lists stay sorted by doc id; appends are the common case.
|
||||
match postings.last() {
|
||||
Some(&(last, _)) if last >= doc_id => {
|
||||
let at = postings.partition_point(|&(id, _)| id < doc_id);
|
||||
postings.insert(at, (doc_id, freq));
|
||||
}
|
||||
_ => postings.push((doc_id, freq)),
|
||||
}
|
||||
}
|
||||
self.doc_lengths[doc_id] = tokens.len() as u32;
|
||||
self.total_length += tokens.len() as u64;
|
||||
self.num_docs += 1;
|
||||
self.refresh_avg_dl();
|
||||
}
|
||||
|
||||
/// Extend the index to cover `len` document slots, leaving new ones empty.
|
||||
/// Used for slots that hold no live document (tombstoned records).
|
||||
pub fn pad_to(&mut self, len: usize) {
|
||||
if len > self.doc_lengths.len() {
|
||||
self.doc_lengths.resize(len, 0);
|
||||
}
|
||||
}
|
||||
|
||||
/// Remove document `doc_id`, whose indexed text was `text`. The text is
|
||||
/// needed to find its postings; pass exactly what was added.
|
||||
pub fn remove_document(&mut self, doc_id: usize, text: &str) {
|
||||
let tokens = tokenize(text);
|
||||
let mut seen: std::collections::HashSet<&str> = std::collections::HashSet::new();
|
||||
for token in &tokens {
|
||||
if !seen.insert(token) {
|
||||
continue;
|
||||
}
|
||||
if let Some(postings) = self.inverted.get_mut(token.as_str()) {
|
||||
if let Ok(at) = postings.binary_search_by_key(&doc_id, |&(id, _)| id) {
|
||||
postings.remove(at);
|
||||
}
|
||||
if postings.is_empty() {
|
||||
self.inverted.remove(token.as_str());
|
||||
}
|
||||
}
|
||||
}
|
||||
if let Some(len) = self.doc_lengths.get_mut(doc_id) {
|
||||
self.total_length = self.total_length.saturating_sub(u64::from(*len));
|
||||
*len = 0;
|
||||
}
|
||||
self.num_docs = self.num_docs.saturating_sub(1);
|
||||
self.refresh_avg_dl();
|
||||
}
|
||||
|
||||
fn refresh_avg_dl(&mut self) {
|
||||
self.avg_dl = if self.num_docs > 0 {
|
||||
self.total_length as f32 / self.num_docs as f32
|
||||
} else {
|
||||
0.0
|
||||
};
|
||||
}
|
||||
|
||||
/// Rebuild the index from scratch (e.g., after compaction).
|
||||
pub fn rebuild(&mut self, documents: &[String], tombstones: &[u8]) {
|
||||
self.inverted.clear();
|
||||
self.idf_cache.clear();
|
||||
self.doc_lengths = vec![0; documents.len()];
|
||||
self.total_length = 0;
|
||||
self.avg_dl = 0.0;
|
||||
self.num_docs = 0;
|
||||
self.index_documents(documents, tombstones);
|
||||
@@ -198,23 +273,13 @@ impl BM25Index {
|
||||
}
|
||||
|
||||
self.num_docs = count;
|
||||
self.avg_dl = if count > 0 {
|
||||
total_length as f32 / count as f32
|
||||
} else {
|
||||
0.0
|
||||
};
|
||||
self.total_length = total_length;
|
||||
self.refresh_avg_dl();
|
||||
|
||||
// Sort posting lists by doc_id for cache-friendly access
|
||||
for postings in self.inverted.values_mut() {
|
||||
postings.sort_by_key(|&(doc_id, _)| doc_id);
|
||||
}
|
||||
|
||||
// Pre-compute and cache IDF scores
|
||||
for (token, postings) in &self.inverted {
|
||||
let df = postings.len() as f32;
|
||||
let idf = ((self.num_docs as f32 - df + 0.5) / (df + 0.5) + 1.0).ln();
|
||||
self.idf_cache.insert(token.clone(), idf);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -370,24 +435,21 @@ mod tests {
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn cached_idf_consistent_with_computed() {
|
||||
fn score_matches_the_bm25_formula() {
|
||||
let docs = vec![
|
||||
"rust programming".to_string(),
|
||||
"rust systems".to_string(),
|
||||
"python scripting".to_string(),
|
||||
];
|
||||
let tombstones = vec![0, 0, 0];
|
||||
let index = BM25Index::build(&docs, &tombstones);
|
||||
let index = BM25Index::build(&docs, &[0, 0, 0]);
|
||||
|
||||
// IDF for "rust" (appears in 2 of 3 docs)
|
||||
let idf_rust = index.idf_cache.get("rust").unwrap();
|
||||
let expected_idf = ((3.0f32 - 2.0 + 0.5) / (2.0 + 0.5) + 1.0).ln();
|
||||
assert!(
|
||||
(idf_rust - expected_idf).abs() < 1e-6,
|
||||
"cached IDF mismatch: {} vs {}",
|
||||
idf_rust,
|
||||
expected_idf
|
||||
);
|
||||
// "python": df = 1 of N = 3. Every doc has the average length (2) and
|
||||
// tf = 1, so the tf factor is exactly 1 and the score is the IDF.
|
||||
let results = index.search("python", 3);
|
||||
let expected_idf = ((3.0f32 - 1.0 + 0.5) / (1.0 + 0.5) + 1.0).ln();
|
||||
assert_eq!(results.len(), 1);
|
||||
assert_eq!(results[0].0, 2);
|
||||
assert!((results[0].1 - expected_idf).abs() < 1e-6, "{results:?}");
|
||||
}
|
||||
|
||||
#[test]
|
||||
@@ -451,4 +513,97 @@ mod tests {
|
||||
);
|
||||
}
|
||||
}
|
||||
/// Documents drawn from a small vocabulary so terms collide heavily.
|
||||
fn random_doc(state: &mut u64) -> String {
|
||||
const VOCAB: &[&str] = &[
|
||||
"alpha", "beta", "gamma", "delta", "eps", "zeta", "eta", "x1",
|
||||
];
|
||||
let mut next = || {
|
||||
*state = state
|
||||
.wrapping_mul(6364136223846793005)
|
||||
.wrapping_add(1442695040888963407);
|
||||
(*state >> 33) as usize
|
||||
};
|
||||
let len = 1 + next() % 9;
|
||||
(0..len)
|
||||
.map(|_| VOCAB[next() % VOCAB.len()])
|
||||
.collect::<Vec<_>>()
|
||||
.join(" ")
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn incremental_updates_match_a_fresh_build_exactly() {
|
||||
for seed in 0..60u64 {
|
||||
let mut state = seed.wrapping_mul(0x9E37_79B9_7F4A_7C15) | 1;
|
||||
let mut docs: Vec<String> = Vec::new();
|
||||
let mut tombstones: Vec<u8> = Vec::new();
|
||||
let mut index = BM25Index::build(&docs, &tombstones);
|
||||
|
||||
for step in 0..80 {
|
||||
state = state.wrapping_mul(6364136223846793005).wrapping_add(1);
|
||||
let live: Vec<usize> = (0..docs.len()).filter(|&i| tombstones[i] == 0).collect();
|
||||
match (state >> 40) % 4 {
|
||||
0 if !live.is_empty() => {
|
||||
// delete
|
||||
let id = live[(state >> 20) as usize % live.len()];
|
||||
index.remove_document(id, &docs[id]);
|
||||
tombstones[id] = 1;
|
||||
}
|
||||
1 if !live.is_empty() => {
|
||||
// update in place
|
||||
let id = live[(state >> 20) as usize % live.len()];
|
||||
let new_text = random_doc(&mut state);
|
||||
index.remove_document(id, &docs[id]);
|
||||
index.add_document(id, &new_text);
|
||||
docs[id] = new_text;
|
||||
}
|
||||
_ => {
|
||||
let text = random_doc(&mut state);
|
||||
index.add_document(docs.len(), &text);
|
||||
docs.push(text);
|
||||
tombstones.push(0);
|
||||
}
|
||||
}
|
||||
|
||||
let fresh = BM25Index::build(&docs, &tombstones);
|
||||
for query in ["alpha", "beta gamma", "x1 zeta alpha delta", "missing"] {
|
||||
let got = index.search(query, 5);
|
||||
let want = fresh.search(query, 5);
|
||||
assert_eq!(got.len(), want.len(), "seed {seed} step {step} {query:?}");
|
||||
for (g, w) in got.iter().zip(&want) {
|
||||
assert_eq!(
|
||||
g.0, w.0,
|
||||
"seed {seed} step {step} {query:?}: {got:?} vs {want:?}"
|
||||
);
|
||||
assert!(
|
||||
(g.1 - w.1).abs() < 1e-5,
|
||||
"seed {seed} step {step} {query:?}"
|
||||
);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn scores_is_the_unranked_form_of_a_full_search() {
|
||||
let mut state = 99u64;
|
||||
let docs: Vec<String> = (0..200).map(|_| random_doc(&mut state)).collect();
|
||||
let tombstones: Vec<u8> = (0..200).map(|i| u8::from(i % 7 == 0)).collect();
|
||||
let index = BM25Index::build(&docs, &tombstones);
|
||||
for query in ["alpha", "beta gamma x1", "missing", ""] {
|
||||
let mut all = index.scores(query);
|
||||
all.sort_by(|a, b| b.1.total_cmp(&a.1).then(a.0.cmp(&b.0)));
|
||||
assert_eq!(all, index.search(query, docs.len()), "{query:?}");
|
||||
assert!(all.iter().all(|(id, _)| tombstones[*id] == 0));
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn ties_break_towards_the_lower_doc_id() {
|
||||
let docs: Vec<String> = (0..6).map(|_| "same text".to_string()).collect();
|
||||
let index = BM25Index::build(&docs, &[0; 6]);
|
||||
let ids: Vec<usize> = index.search("same", 3).into_iter().map(|r| r.0).collect();
|
||||
assert_eq!(ids, [0, 1, 2]);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -7,6 +7,11 @@ use crate::vector_search;
|
||||
pub struct MemoryCache {
|
||||
pub chunks: Vec<String>,
|
||||
pub embeddings: Vec<Vec<f32>>,
|
||||
/// `embeddings` flattened into one contiguous `[N × embedding_dim]`
|
||||
/// buffer, maintained incrementally alongside `embeddings` (push/update/
|
||||
/// compact) so BLAS/Accelerate batch search can read it directly instead
|
||||
/// of re-flattening the whole corpus on every query.
|
||||
pub embeddings_flat: Vec<f32>,
|
||||
pub source_channels: Vec<String>,
|
||||
pub timestamps: Vec<f64>,
|
||||
pub session_ids: Vec<String>,
|
||||
@@ -24,6 +29,7 @@ impl MemoryCache {
|
||||
Self {
|
||||
chunks: Vec::new(),
|
||||
embeddings: Vec::new(),
|
||||
embeddings_flat: Vec::new(),
|
||||
source_channels: Vec::new(),
|
||||
timestamps: Vec::new(),
|
||||
session_ids: Vec::new(),
|
||||
@@ -35,6 +41,17 @@ impl MemoryCache {
|
||||
}
|
||||
}
|
||||
|
||||
/// Rebuild `embeddings_flat` from `embeddings` from scratch. Callers that
|
||||
/// populate `embeddings` directly (bulk loads) must call this afterward.
|
||||
pub fn rebuild_flat(&mut self) {
|
||||
self.embeddings_flat.clear();
|
||||
self.embeddings_flat
|
||||
.reserve(self.embeddings.len() * self.embedding_dim);
|
||||
for emb in &self.embeddings {
|
||||
self.embeddings_flat.extend_from_slice(emb);
|
||||
}
|
||||
}
|
||||
|
||||
/// Total number of entries (including tombstoned).
|
||||
pub fn len(&self) -> usize {
|
||||
self.chunks.len()
|
||||
@@ -62,6 +79,7 @@ impl MemoryCache {
|
||||
let idx = self.chunks.len();
|
||||
let norm = vector_search::compute_norm(&embedding);
|
||||
self.chunks.push(chunk);
|
||||
self.embeddings_flat.extend_from_slice(&embedding);
|
||||
self.embeddings.push(embedding);
|
||||
self.source_channels.push(source_channel);
|
||||
self.timestamps.push(timestamp);
|
||||
@@ -100,7 +118,20 @@ impl MemoryCache {
|
||||
if idx < self.chunks.len() {
|
||||
let norm = vector_search::compute_norm(&embedding);
|
||||
self.chunks[idx] = chunk;
|
||||
let dim = self.embedding_dim;
|
||||
let flat_start = idx * dim;
|
||||
let matches_dim =
|
||||
embedding.len() == dim && flat_start + dim <= self.embeddings_flat.len();
|
||||
self.embeddings[idx] = embedding;
|
||||
if matches_dim {
|
||||
self.embeddings_flat[flat_start..flat_start + dim]
|
||||
.copy_from_slice(&self.embeddings[idx]);
|
||||
} else {
|
||||
// Embedding length doesn't match embedding_dim (shouldn't
|
||||
// happen in practice) — fall back to a full rebuild rather
|
||||
// than leave embeddings_flat misaligned with embeddings.
|
||||
self.rebuild_flat();
|
||||
}
|
||||
self.source_channels[idx] = source_channel;
|
||||
self.timestamps[idx] = timestamp;
|
||||
self.session_ids[idx] = session_id;
|
||||
@@ -173,16 +204,125 @@ impl MemoryCache {
|
||||
self.tombstones = new_tombstones;
|
||||
self.norms = new_norms;
|
||||
self.activation_weights = new_activation_weights;
|
||||
self.rebuild_flat();
|
||||
|
||||
(removed, index_map)
|
||||
}
|
||||
|
||||
/// Flatten all embeddings into a single Vec<f32> for HDF5 storage.
|
||||
/// `embeddings_flat` is already maintained incrementally, so this just
|
||||
/// clones it — kept as a method for callers that want an owned copy.
|
||||
pub fn flat_embeddings(&self) -> Vec<f32> {
|
||||
let mut flat = Vec::with_capacity(self.embeddings.len() * self.embedding_dim);
|
||||
for emb in &self.embeddings {
|
||||
flat.extend_from_slice(emb);
|
||||
}
|
||||
flat
|
||||
self.embeddings_flat.clone()
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
|
||||
/// `embeddings_flat` must always equal a from-scratch flatten of `embeddings`.
|
||||
fn assert_flat_in_sync(cache: &MemoryCache) {
|
||||
let expected: Vec<f32> = cache.embeddings.iter().flatten().copied().collect();
|
||||
assert_eq!(cache.embeddings_flat, expected);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn push_keeps_flat_buffer_in_sync() {
|
||||
let mut cache = MemoryCache::new(3);
|
||||
cache.push(
|
||||
"a".into(),
|
||||
vec![1.0, 2.0, 3.0],
|
||||
"chan".into(),
|
||||
0.0,
|
||||
"s1".into(),
|
||||
String::new(),
|
||||
);
|
||||
cache.push(
|
||||
"b".into(),
|
||||
vec![4.0, 5.0, 6.0],
|
||||
"chan".into(),
|
||||
1.0,
|
||||
"s1".into(),
|
||||
String::new(),
|
||||
);
|
||||
assert_flat_in_sync(&cache);
|
||||
assert_eq!(cache.embeddings_flat, vec![1.0, 2.0, 3.0, 4.0, 5.0, 6.0]);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn update_keeps_flat_buffer_in_sync() {
|
||||
let mut cache = MemoryCache::new(3);
|
||||
cache.push(
|
||||
"a".into(),
|
||||
vec![1.0, 2.0, 3.0],
|
||||
"chan".into(),
|
||||
0.0,
|
||||
"s1".into(),
|
||||
String::new(),
|
||||
);
|
||||
cache.push(
|
||||
"b".into(),
|
||||
vec![4.0, 5.0, 6.0],
|
||||
"chan".into(),
|
||||
1.0,
|
||||
"s1".into(),
|
||||
String::new(),
|
||||
);
|
||||
cache.update(
|
||||
0,
|
||||
"a2".into(),
|
||||
vec![7.0, 8.0, 9.0],
|
||||
"chan".into(),
|
||||
2.0,
|
||||
"s1".into(),
|
||||
);
|
||||
assert_flat_in_sync(&cache);
|
||||
assert_eq!(
|
||||
cache.embeddings_flat,
|
||||
vec![7.0, 8.0, 9.0, 4.0, 5.0, 6.0],
|
||||
"update must overwrite the correct flat slice, not just append"
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn compact_keeps_flat_buffer_in_sync() {
|
||||
let mut cache = MemoryCache::new(2);
|
||||
cache.push(
|
||||
"a".into(),
|
||||
vec![1.0, 1.0],
|
||||
"chan".into(),
|
||||
0.0,
|
||||
"s1".into(),
|
||||
String::new(),
|
||||
);
|
||||
cache.push(
|
||||
"b".into(),
|
||||
vec![2.0, 2.0],
|
||||
"chan".into(),
|
||||
1.0,
|
||||
"s1".into(),
|
||||
String::new(),
|
||||
);
|
||||
cache.push(
|
||||
"c".into(),
|
||||
vec![3.0, 3.0],
|
||||
"chan".into(),
|
||||
2.0,
|
||||
"s1".into(),
|
||||
String::new(),
|
||||
);
|
||||
cache.mark_deleted(1);
|
||||
cache.compact();
|
||||
assert_flat_in_sync(&cache);
|
||||
assert_eq!(cache.embeddings_flat, vec![1.0, 1.0, 3.0, 3.0]);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn rebuild_flat_matches_manual_flatten() {
|
||||
let mut cache = MemoryCache::new(2);
|
||||
cache.embeddings = vec![vec![1.0, 2.0], vec![3.0, 4.0]];
|
||||
cache.rebuild_flat();
|
||||
assert_eq!(cache.embeddings_flat, vec![1.0, 2.0, 3.0, 4.0]);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -16,6 +16,55 @@ pub enum MemorySource {
|
||||
Correction,
|
||||
}
|
||||
|
||||
/// Source classification for content whose true origin is *not*
|
||||
/// independently verified by the caller of [`ConsolidationEngine::add_memory`]
|
||||
/// — arbitrary text forwarded from a user, a tool's output, or a retrieval
|
||||
/// pipeline. This is the only source set `add_memory` accepts; it cannot
|
||||
/// claim the `System`/`Correction` importance boost (see [`TrustedSource`]
|
||||
/// and [`ConsolidationEngine::add_trusted_memory`]) — a caller passing
|
||||
/// through untrusted content has no way to self-report an elevated trust
|
||||
/// level through this entry point.
|
||||
#[derive(Clone, Debug, PartialEq)]
|
||||
pub enum UntrustedSource {
|
||||
User,
|
||||
Tool,
|
||||
Retrieval,
|
||||
}
|
||||
|
||||
impl From<UntrustedSource> for MemorySource {
|
||||
fn from(s: UntrustedSource) -> Self {
|
||||
match s {
|
||||
UntrustedSource::User => MemorySource::User,
|
||||
UntrustedSource::Tool => MemorySource::Tool,
|
||||
UntrustedSource::Retrieval => MemorySource::Retrieval,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// Source classification for content whose elevated trust level has been
|
||||
/// independently verified by the caller — e.g. the library's own
|
||||
/// system-generated text, or a caller that ran its own correction-cue
|
||||
/// detection (as `memory_strategy::SaveOnUserCorrection` does) rather than
|
||||
/// forwarding a caller-supplied label verbatim. `MemorySource::System`/
|
||||
/// `Correction` get elevated importance weighting in
|
||||
/// [`ImportanceScorer::score_correction`]; only reachable through
|
||||
/// [`ConsolidationEngine::add_trusted_memory`], a distinct entry point from
|
||||
/// the one untrusted content is passed through.
|
||||
#[derive(Clone, Debug, PartialEq)]
|
||||
pub enum TrustedSource {
|
||||
System,
|
||||
Correction,
|
||||
}
|
||||
|
||||
impl From<TrustedSource> for MemorySource {
|
||||
fn from(s: TrustedSource) -> Self {
|
||||
match s {
|
||||
TrustedSource::System => MemorySource::System,
|
||||
TrustedSource::Correction => MemorySource::Correction,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
#[derive(Clone, Debug, PartialEq)]
|
||||
pub enum MemoryTier {
|
||||
Working,
|
||||
@@ -118,7 +167,7 @@ impl ImportanceScorer {
|
||||
|
||||
/// Novelty score: 1.0 − max cosine similarity against all existing records.
|
||||
/// Returns 1.0 when there are no existing memories.
|
||||
pub fn score_surprise(embedding: &[f32], existing_memories: &[MemoryRecord]) -> f32 {
|
||||
pub fn score_surprise(embedding: &[f32], existing_memories: &[&MemoryRecord]) -> f32 {
|
||||
if existing_memories.is_empty() {
|
||||
return 1.0;
|
||||
}
|
||||
@@ -199,21 +248,51 @@ impl ConsolidationEngine {
|
||||
}
|
||||
}
|
||||
|
||||
/// Add a new memory to the Working tier.
|
||||
/// Add a new memory to the Working tier from an untrusted/ordinary origin
|
||||
/// (User, Tool, or Retrieval). This is the entry point for arbitrary
|
||||
/// caller-supplied content — it cannot claim the elevated System/
|
||||
/// Correction importance boost. Use [`Self::add_trusted_memory`] for
|
||||
/// content whose elevated trust level the caller has independently
|
||||
/// verified.
|
||||
///
|
||||
/// Importance is scored against existing Working-tier records only.
|
||||
pub fn add_memory(
|
||||
&mut self,
|
||||
chunk: String,
|
||||
embedding: Vec<f32>,
|
||||
source: UntrustedSource,
|
||||
now: f64,
|
||||
) -> u64 {
|
||||
self.add_memory_with_source(chunk, embedding, source.into(), now)
|
||||
}
|
||||
|
||||
/// Add a new memory tagged System or Correction, which get elevated
|
||||
/// importance weighting in [`ImportanceScorer::score_correction`]. Only
|
||||
/// call this from code that has independently verified the origin (the
|
||||
/// library's own system-generated text, or a caller that ran its own
|
||||
/// correction-cue detection) — never from a path that forwards a
|
||||
/// caller-supplied trust label verbatim.
|
||||
pub fn add_trusted_memory(
|
||||
&mut self,
|
||||
chunk: String,
|
||||
embedding: Vec<f32>,
|
||||
source: TrustedSource,
|
||||
now: f64,
|
||||
) -> u64 {
|
||||
self.add_memory_with_source(chunk, embedding, source.into(), now)
|
||||
}
|
||||
|
||||
fn add_memory_with_source(
|
||||
&mut self,
|
||||
chunk: String,
|
||||
embedding: Vec<f32>,
|
||||
source: MemorySource,
|
||||
now: f64,
|
||||
) -> u64 {
|
||||
let working: Vec<MemoryRecord> = self
|
||||
let working: Vec<&MemoryRecord> = self
|
||||
.records
|
||||
.iter()
|
||||
.filter(|r| r.tier == MemoryTier::Working)
|
||||
.cloned()
|
||||
.collect();
|
||||
|
||||
let surprise = ImportanceScorer::score_surprise(&embedding, &working);
|
||||
@@ -281,7 +360,7 @@ impl ConsolidationEngine {
|
||||
if working_count > capacity {
|
||||
let evict_n = working_count - capacity;
|
||||
// Collect the ids of the records to evict (lowest decay = first in sorted list).
|
||||
let evict_ids: Vec<u64> = working_indices[..evict_n]
|
||||
let evict_ids: std::collections::HashSet<u64> = working_indices[..evict_n]
|
||||
.iter()
|
||||
.map(|&i| self.records[i].id)
|
||||
.collect();
|
||||
@@ -342,7 +421,7 @@ impl ConsolidationEngine {
|
||||
});
|
||||
|
||||
let evict_n = episodic_count - episodic_capacity;
|
||||
let evict_ids: Vec<u64> = episodic_indices[..evict_n]
|
||||
let evict_ids: std::collections::HashSet<u64> = episodic_indices[..evict_n]
|
||||
.iter()
|
||||
.map(|&i| self.records[i].id)
|
||||
.collect();
|
||||
@@ -419,13 +498,44 @@ mod tests {
|
||||
// ---------------------------------------------------------------------------
|
||||
// 2. Add memory — basic
|
||||
// ---------------------------------------------------------------------------
|
||||
/// add_trusted_memory(TrustedSource::Correction) must actually produce a
|
||||
/// MemorySource::Correction record — the only way to reach that elevated
|
||||
/// classification, since add_memory's UntrustedSource has no such variant.
|
||||
#[test]
|
||||
fn test_add_trusted_memory_sets_correction_source() {
|
||||
let mut engine = ConsolidationEngine::new(ConsolidationConfig::default());
|
||||
let id = engine.add_trusted_memory(
|
||||
"verified correction".to_string(),
|
||||
unit_vec(4, 0),
|
||||
TrustedSource::Correction,
|
||||
0.0,
|
||||
);
|
||||
let rec = engine.get_by_id(id).unwrap();
|
||||
assert_eq!(rec.source, MemorySource::Correction);
|
||||
}
|
||||
|
||||
/// add_trusted_memory(TrustedSource::System) must produce a
|
||||
/// MemorySource::System record.
|
||||
#[test]
|
||||
fn test_add_trusted_memory_sets_system_source() {
|
||||
let mut engine = ConsolidationEngine::new(ConsolidationConfig::default());
|
||||
let id = engine.add_trusted_memory(
|
||||
"bootstrap text".to_string(),
|
||||
unit_vec(4, 0),
|
||||
TrustedSource::System,
|
||||
0.0,
|
||||
);
|
||||
let rec = engine.get_by_id(id).unwrap();
|
||||
assert_eq!(rec.source, MemorySource::System);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_add_memory_basic() {
|
||||
let mut engine = ConsolidationEngine::new(ConsolidationConfig::default());
|
||||
let id = engine.add_memory(
|
||||
"Hello world".to_string(),
|
||||
unit_vec(4, 0),
|
||||
MemorySource::User,
|
||||
UntrustedSource::User,
|
||||
1_000_000.0,
|
||||
);
|
||||
assert_eq!(id, 0);
|
||||
@@ -453,7 +563,7 @@ mod tests {
|
||||
#[test]
|
||||
fn test_importance_scorer_surprise_identical() {
|
||||
let emb = unit_vec(4, 0);
|
||||
let existing = vec![MemoryRecord {
|
||||
let existing = [MemoryRecord {
|
||||
id: 0,
|
||||
chunk: "existing".to_string(),
|
||||
embedding: emb.clone(),
|
||||
@@ -464,7 +574,8 @@ mod tests {
|
||||
created_at: 0.0,
|
||||
source: MemorySource::User,
|
||||
}];
|
||||
let score = ImportanceScorer::score_surprise(&emb, &existing);
|
||||
let existing_refs: Vec<&MemoryRecord> = existing.iter().collect();
|
||||
let score = ImportanceScorer::score_surprise(&emb, &existing_refs);
|
||||
assert!(score < 0.01, "expected ~0.0, got {score}");
|
||||
}
|
||||
|
||||
@@ -492,23 +603,20 @@ mod tests {
|
||||
fn test_importance_scorer_length() {
|
||||
assert!((ImportanceScorer::score_length("")).abs() < f32::EPSILON);
|
||||
// 50 words → 0.5
|
||||
let fifty_words = std::iter::repeat("word")
|
||||
.take(50)
|
||||
let fifty_words = std::iter::repeat_n("word", 50)
|
||||
.collect::<Vec<_>>()
|
||||
.join(" ");
|
||||
let s50 = ImportanceScorer::score_length(&fifty_words);
|
||||
assert!((s50 - 0.5).abs() < 1e-5, "expected 0.5, got {s50}");
|
||||
|
||||
// 100 words → 1.0
|
||||
let hundred_words = std::iter::repeat("word")
|
||||
.take(100)
|
||||
let hundred_words = std::iter::repeat_n("word", 100)
|
||||
.collect::<Vec<_>>()
|
||||
.join(" ");
|
||||
assert_eq!(ImportanceScorer::score_length(&hundred_words), 1.0);
|
||||
|
||||
// 200 words → still 1.0 (clamped)
|
||||
let two_hundred = std::iter::repeat("word")
|
||||
.take(200)
|
||||
let two_hundred = std::iter::repeat_n("word", 200)
|
||||
.collect::<Vec<_>>()
|
||||
.join(" ");
|
||||
assert_eq!(ImportanceScorer::score_length(&two_hundred), 1.0);
|
||||
@@ -582,9 +690,11 @@ mod tests {
|
||||
// ---------------------------------------------------------------------------
|
||||
#[test]
|
||||
fn test_consolidate_eviction_working() {
|
||||
let mut cfg = ConsolidationConfig::default();
|
||||
cfg.working_capacity = 3;
|
||||
cfg.working_to_episodic_threshold = 2.0; // never promote in this test
|
||||
let cfg = ConsolidationConfig {
|
||||
working_capacity: 3,
|
||||
working_to_episodic_threshold: 2.0, // never promote in this test
|
||||
..Default::default()
|
||||
};
|
||||
let mut engine = ConsolidationEngine::new(cfg);
|
||||
|
||||
// Add 5 records; all have very low importance so none get promoted.
|
||||
@@ -592,7 +702,7 @@ mod tests {
|
||||
let id = engine.add_memory(
|
||||
"x".to_string(),
|
||||
unit_vec(4, i as usize),
|
||||
MemorySource::User,
|
||||
UntrustedSource::User,
|
||||
i as f64,
|
||||
);
|
||||
// Force low importance so promotion threshold is not crossed.
|
||||
@@ -625,10 +735,10 @@ mod tests {
|
||||
let cfg = ConsolidationConfig::default();
|
||||
let mut engine = ConsolidationEngine::new(cfg);
|
||||
|
||||
let id = engine.add_memory(
|
||||
let id = engine.add_trusted_memory(
|
||||
"important memory".to_string(),
|
||||
unit_vec(4, 0),
|
||||
MemorySource::Correction,
|
||||
TrustedSource::Correction,
|
||||
0.0,
|
||||
);
|
||||
// Force importance above threshold.
|
||||
@@ -661,7 +771,7 @@ mod tests {
|
||||
let id = engine.add_memory(
|
||||
"frequently accessed".to_string(),
|
||||
unit_vec(4, 0),
|
||||
MemorySource::User,
|
||||
UntrustedSource::User,
|
||||
0.0,
|
||||
);
|
||||
|
||||
@@ -689,7 +799,12 @@ mod tests {
|
||||
#[test]
|
||||
fn test_access_memory_reactivation() {
|
||||
let mut engine = ConsolidationEngine::new(ConsolidationConfig::default());
|
||||
let id = engine.add_memory("chunk".to_string(), unit_vec(4, 0), MemorySource::User, 0.0);
|
||||
let id = engine.add_memory(
|
||||
"chunk".to_string(),
|
||||
unit_vec(4, 0),
|
||||
UntrustedSource::User,
|
||||
0.0,
|
||||
);
|
||||
|
||||
engine.access_memory(id, 5000.0);
|
||||
let rec = engine.get_by_id(id).unwrap();
|
||||
@@ -710,11 +825,11 @@ mod tests {
|
||||
let mut engine = ConsolidationEngine::new(ConsolidationConfig::default());
|
||||
|
||||
// 2 Working
|
||||
engine.add_memory("w1".to_string(), unit_vec(4, 0), MemorySource::User, 0.0);
|
||||
engine.add_memory("w2".to_string(), unit_vec(4, 1), MemorySource::User, 0.0);
|
||||
engine.add_memory("w1".to_string(), unit_vec(4, 0), UntrustedSource::User, 0.0);
|
||||
engine.add_memory("w2".to_string(), unit_vec(4, 1), UntrustedSource::User, 0.0);
|
||||
|
||||
// 1 Episodic (manually set)
|
||||
let id_e = engine.add_memory("e1".to_string(), unit_vec(4, 2), MemorySource::User, 0.0);
|
||||
let id_e = engine.add_memory("e1".to_string(), unit_vec(4, 2), UntrustedSource::User, 0.0);
|
||||
engine
|
||||
.records
|
||||
.iter_mut()
|
||||
@@ -723,7 +838,7 @@ mod tests {
|
||||
.tier = MemoryTier::Episodic;
|
||||
|
||||
// 1 Semantic (manually set)
|
||||
let id_s = engine.add_memory("s1".to_string(), unit_vec(4, 3), MemorySource::User, 0.0);
|
||||
let id_s = engine.add_memory("s1".to_string(), unit_vec(4, 3), UntrustedSource::User, 0.0);
|
||||
engine
|
||||
.records
|
||||
.iter_mut()
|
||||
@@ -742,9 +857,11 @@ mod tests {
|
||||
// ---------------------------------------------------------------------------
|
||||
#[test]
|
||||
fn test_consolidate_episodic_eviction() {
|
||||
let mut cfg = ConsolidationConfig::default();
|
||||
cfg.episodic_capacity = 3;
|
||||
cfg.working_to_episodic_threshold = 2.0; // never auto-promote from Working
|
||||
let cfg = ConsolidationConfig {
|
||||
episodic_capacity: 3,
|
||||
working_to_episodic_threshold: 2.0, // never auto-promote from Working
|
||||
..Default::default()
|
||||
};
|
||||
let mut engine = ConsolidationEngine::new(cfg);
|
||||
|
||||
// Seed 5 records directly in Episodic.
|
||||
@@ -752,7 +869,7 @@ mod tests {
|
||||
let id = engine.add_memory(
|
||||
"episodic chunk".to_string(),
|
||||
unit_vec(4, i as usize),
|
||||
MemorySource::User,
|
||||
UntrustedSource::User,
|
||||
i as f64,
|
||||
);
|
||||
let rec = engine.records.iter_mut().find(|r| r.id == id).unwrap();
|
||||
|
||||
@@ -777,8 +777,10 @@ mod tests {
|
||||
|
||||
#[test]
|
||||
fn test_tech_disabled() {
|
||||
let mut config = ExtractorConfig::default();
|
||||
config.extract_technology = false;
|
||||
let config = ExtractorConfig {
|
||||
extract_technology: false,
|
||||
..Default::default()
|
||||
};
|
||||
let e = EntityExtractor::new(config);
|
||||
let entities = e.extract("We use Rust and Docker.");
|
||||
assert!(
|
||||
@@ -847,8 +849,10 @@ mod tests {
|
||||
|
||||
#[test]
|
||||
fn test_date_disabled() {
|
||||
let mut config = ExtractorConfig::default();
|
||||
config.extract_dates = false;
|
||||
let config = ExtractorConfig {
|
||||
extract_dates: false,
|
||||
..Default::default()
|
||||
};
|
||||
let e = EntityExtractor::new(config);
|
||||
let entities = e.extract("Released on 2024-03-19.");
|
||||
assert!(
|
||||
@@ -981,8 +985,10 @@ mod tests {
|
||||
|
||||
#[test]
|
||||
fn test_confidence_filter() {
|
||||
let mut config = ExtractorConfig::default();
|
||||
config.min_confidence = 0.95;
|
||||
let config = ExtractorConfig {
|
||||
min_confidence: 0.95,
|
||||
..Default::default()
|
||||
};
|
||||
let e = EntityExtractor::new(config);
|
||||
// Only dates (0.95) and techs (0.9) should survive; 0.9 < 0.95 filters techs.
|
||||
let entities = e.extract("We use Rust since 2024-01-01.");
|
||||
@@ -1002,7 +1008,7 @@ mod tests {
|
||||
fn test_batch_dedup() {
|
||||
let e = default_extractor();
|
||||
let texts = ["We use Rust.", "Rust is fast.", "Also Rust for safety."];
|
||||
let entities = e.extract_batch(&texts.iter().map(|s| *s).collect::<Vec<_>>());
|
||||
let entities = e.extract_batch(&texts);
|
||||
let rust_count = entities.iter().filter(|x| x.text == "Rust").count();
|
||||
assert_eq!(rust_count, 1, "Rust should appear exactly once after dedup");
|
||||
}
|
||||
@@ -1011,7 +1017,7 @@ mod tests {
|
||||
fn test_batch_multiple_types() {
|
||||
let e = default_extractor();
|
||||
let texts = ["Deploy with Docker.", "We merged last week."];
|
||||
let entities = e.extract_batch(&texts.iter().map(|s| *s).collect::<Vec<_>>());
|
||||
let entities = e.extract_batch(&texts);
|
||||
assert!(
|
||||
entities
|
||||
.iter()
|
||||
|
||||
@@ -116,14 +116,15 @@ impl GpuSearchBackend {
|
||||
|
||||
// If we don't have an accelerator but now above threshold, try init
|
||||
if vectors.len() >= self.threshold
|
||||
&& let Ok(mut accel) = clawhdf5_gpu::GpuAccelerator::new() {
|
||||
let flat: Vec<f32> = vectors.iter().flat_map(|v| v.iter().copied()).collect();
|
||||
if accel.upload_vectors(&flat, self.dim).is_ok()
|
||||
&& accel.upload_norms(norms).is_ok()
|
||||
{
|
||||
self.accelerator = Some(accel);
|
||||
}
|
||||
&& let Ok(mut accel) = clawhdf5_gpu::GpuAccelerator::new()
|
||||
{
|
||||
let flat: Vec<f32> = vectors.iter().flat_map(|v| v.iter().copied()).collect();
|
||||
if accel.upload_vectors(&flat, self.dim).is_ok()
|
||||
&& accel.upload_norms(norms).is_ok()
|
||||
{
|
||||
self.accelerator = Some(accel);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(not(feature = "gpu"))]
|
||||
|
||||
@@ -58,7 +58,7 @@ pub fn hybrid_search(
|
||||
vector_search::cosine_similarity_batch(query_embedding, vectors, tombstones)
|
||||
}
|
||||
};
|
||||
let kw_scores = bm25_index.search(query_text, vectors.len());
|
||||
let kw_scores = bm25_index.scores(query_text);
|
||||
|
||||
merge_vector_keyword(vec_scores, kw_scores, vector_weight, keyword_weight, k)
|
||||
}
|
||||
@@ -91,14 +91,31 @@ pub fn merge_vector_keyword(
|
||||
}
|
||||
|
||||
let mut results: Vec<(usize, f32)> = merged.into_iter().collect();
|
||||
results.sort_by(|a, b| b.1.partial_cmp(&a.1).unwrap_or(std::cmp::Ordering::Equal));
|
||||
results.truncate(k);
|
||||
// Index tie-break: `merged` is a HashMap, so without it the ties that
|
||||
// survive differ from run to run.
|
||||
let by_score_then_id = |a: &(usize, f32), b: &(usize, f32)| {
|
||||
b.1.partial_cmp(&a.1)
|
||||
.unwrap_or(std::cmp::Ordering::Equal)
|
||||
.then(a.0.cmp(&b.0))
|
||||
};
|
||||
// Only the top k are wanted: partition them out, then order just those,
|
||||
// instead of sorting every candidate (the keyword side can be the corpus).
|
||||
if k == 0 {
|
||||
return Vec::new();
|
||||
}
|
||||
if results.len() > k {
|
||||
results.select_nth_unstable_by(k - 1, by_score_then_id);
|
||||
results.truncate(k);
|
||||
}
|
||||
results.sort_by(by_score_then_id);
|
||||
results
|
||||
}
|
||||
|
||||
/// Normalize a set of scores to the [0, 1] range using min-max normalization.
|
||||
///
|
||||
/// If all scores are identical, returns 0.0 for each entry.
|
||||
/// If all scores are identical there is no spread to normalise: each entry
|
||||
/// gets 1.0 when that score is positive (all equally the best match) and 0.0
|
||||
/// otherwise (nothing matched).
|
||||
fn normalize_scores(scores: &[(usize, f32)]) -> Vec<(usize, f32)> {
|
||||
if scores.is_empty() {
|
||||
return Vec::new();
|
||||
@@ -112,7 +129,13 @@ fn normalize_scores(scores: &[(usize, f32)]) -> Vec<(usize, f32)> {
|
||||
|
||||
let range = max - min;
|
||||
if range == 0.0 {
|
||||
return scores.iter().map(|(idx, _)| (*idx, 0.0)).collect();
|
||||
// All candidates scored the same (including the single-candidate
|
||||
// case), so min-max has no spread to work with. They are all equally
|
||||
// the best match if that score is positive, and all non-matches
|
||||
// otherwise. This used to return 0.0 unconditionally, which erased a
|
||||
// lone perfect match from the fused score.
|
||||
let level = if max > 0.0 { 1.0 } else { 0.0 };
|
||||
return scores.iter().map(|(idx, _)| (*idx, level)).collect();
|
||||
}
|
||||
|
||||
scores
|
||||
@@ -324,10 +347,37 @@ mod tests {
|
||||
|
||||
#[test]
|
||||
fn normalize_scores_single() {
|
||||
// A lone positive score is the best match there is, not a non-match.
|
||||
let result = normalize_scores(&[(0, 5.0)]);
|
||||
assert_eq!(result.len(), 1);
|
||||
// Single score normalizes to 0.0 (range is 0)
|
||||
assert_eq!(result[0].1, 0.0);
|
||||
assert_eq!(result[0].1, 1.0);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn merge_top_k_matches_a_full_sort() {
|
||||
// Many ties (scores repeat) so the index tie-break is exercised.
|
||||
let vec_scores: Vec<(usize, f32)> = (0..300).map(|i| (i, ((i * 7) % 13) as f32)).collect();
|
||||
let kw_scores: Vec<(usize, f32)> = (100..500).map(|i| (i, ((i * 5) % 11) as f32)).collect();
|
||||
let everything =
|
||||
merge_vector_keyword(vec_scores.clone(), kw_scores.clone(), 0.7, 0.3, 10_000);
|
||||
assert_eq!(everything.len(), 500);
|
||||
assert!(
|
||||
everything
|
||||
.windows(2)
|
||||
.all(|w| { w[0].1 > w[1].1 || (w[0].1 == w[1].1 && w[0].0 < w[1].0) })
|
||||
);
|
||||
for k in [0, 1, 7, 50, 499, 500, 501] {
|
||||
let top = merge_vector_keyword(vec_scores.clone(), kw_scores.clone(), 0.7, 0.3, k);
|
||||
assert_eq!(top, everything[..k.min(500)], "k = {k}");
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn normalize_scores_all_equal() {
|
||||
let matched = normalize_scores(&[(0, 0.4), (1, 0.4)]);
|
||||
assert!(matched.iter().all(|(_, s)| *s == 1.0));
|
||||
let unmatched = normalize_scores(&[(0, 0.0), (1, 0.0)]);
|
||||
assert!(unmatched.iter().all(|(_, s)| *s == 0.0));
|
||||
}
|
||||
|
||||
#[test]
|
||||
|
||||
@@ -50,6 +50,9 @@ impl RelationType {
|
||||
pub struct Entity {
|
||||
pub id: u64,
|
||||
pub name: String,
|
||||
/// Lowercased `name`, cached at construction time to avoid re-allocating
|
||||
/// and re-lowercasing on every entity-resolution scan.
|
||||
pub name_lower: String,
|
||||
pub entity_type: String,
|
||||
/// Index into the memory embeddings array, or -1 if none.
|
||||
pub embedding_idx: i64,
|
||||
@@ -69,6 +72,7 @@ impl Default for Entity {
|
||||
Self {
|
||||
id: 0,
|
||||
name: String::new(),
|
||||
name_lower: String::new(),
|
||||
entity_type: String::new(),
|
||||
embedding_idx: -1,
|
||||
properties: HashMap::new(),
|
||||
@@ -151,6 +155,55 @@ fn levenshtein(a: &str, b: &str) -> usize {
|
||||
prev[nb]
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// AdjacencyIndex
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
/// Adjacency index over a snapshot of `entities`/`relations`: an entity-id ->
|
||||
/// entities-slice-index map, and an entity-id -> relation-indices map (edges
|
||||
/// touching that entity as either source or target).
|
||||
///
|
||||
/// Built fresh per traversal call rather than cached on `KnowledgeCache`:
|
||||
/// entities/relations are plain `pub` `Vec`s that get pushed to directly
|
||||
/// (e.g. `schema.rs`'s load path bypasses `add_entity`/`add_relation`), so a
|
||||
/// persistent index would need extra bookkeeping to avoid drifting stale. A
|
||||
/// one-off O(V+E) build per call is still a large win over the O(V·E) (BFS)
|
||||
/// / O(steps·active·E) (spreading activation) scans it replaces.
|
||||
struct AdjacencyIndex {
|
||||
entity_index: HashMap<u64, usize>,
|
||||
by_entity: HashMap<u64, Vec<usize>>,
|
||||
}
|
||||
|
||||
impl AdjacencyIndex {
|
||||
fn build(entities: &[Entity], relations: &[Relation]) -> Self {
|
||||
let mut entity_index = HashMap::with_capacity(entities.len());
|
||||
for (i, e) in entities.iter().enumerate() {
|
||||
entity_index.insert(e.id, i);
|
||||
}
|
||||
|
||||
let mut by_entity: HashMap<u64, Vec<usize>> = HashMap::new();
|
||||
for (i, r) in relations.iter().enumerate() {
|
||||
by_entity.entry(r.src).or_default().push(i);
|
||||
if r.tgt != r.src {
|
||||
by_entity.entry(r.tgt).or_default().push(i);
|
||||
}
|
||||
}
|
||||
|
||||
Self {
|
||||
entity_index,
|
||||
by_entity,
|
||||
}
|
||||
}
|
||||
|
||||
/// Indices into `relations` of every edge touching `entity_id`.
|
||||
fn relations_touching(&self, entity_id: u64) -> &[usize] {
|
||||
self.by_entity
|
||||
.get(&entity_id)
|
||||
.map(|v| v.as_slice())
|
||||
.unwrap_or(&[])
|
||||
}
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// KnowledgeCache
|
||||
// ---------------------------------------------------------------------------
|
||||
@@ -198,6 +251,7 @@ impl KnowledgeCache {
|
||||
self.entities.push(Entity {
|
||||
id,
|
||||
name: name.to_owned(),
|
||||
name_lower: name.to_lowercase(),
|
||||
entity_type: entity_type.to_owned(),
|
||||
embedding_idx,
|
||||
properties: HashMap::new(),
|
||||
@@ -310,16 +364,22 @@ impl KnowledgeCache {
|
||||
) -> (u64, bool) {
|
||||
let lower_name = name.to_lowercase();
|
||||
|
||||
// Search for the closest existing entity.
|
||||
let best = self
|
||||
.entities
|
||||
.iter()
|
||||
.map(|e| {
|
||||
let dist = levenshtein(&lower_name, &e.name.to_lowercase());
|
||||
(e.id, dist)
|
||||
})
|
||||
.filter(|&(_, dist)| dist <= max_distance)
|
||||
.min_by_key(|&(_, dist)| dist);
|
||||
// Search for the closest existing entity, short-circuiting on an
|
||||
// exact match since no closer candidate can exist.
|
||||
let mut best: Option<(u64, usize)> = None;
|
||||
for e in &self.entities {
|
||||
let dist = levenshtein(&lower_name, &e.name_lower);
|
||||
if dist > max_distance {
|
||||
continue;
|
||||
}
|
||||
if dist == 0 {
|
||||
best = Some((e.id, dist));
|
||||
break;
|
||||
}
|
||||
if best.is_none_or(|(_, best_dist)| dist < best_dist) {
|
||||
best = Some((e.id, dist));
|
||||
}
|
||||
}
|
||||
|
||||
if let Some((id, _)) = best {
|
||||
return (id, false);
|
||||
@@ -337,6 +397,7 @@ impl KnowledgeCache {
|
||||
/// together with their discovered depth. The seed entity itself is NOT
|
||||
/// included. Traversal follows both outgoing and incoming relation edges.
|
||||
pub fn bfs_neighbors(&self, entity_id: u64, max_depth: usize) -> Vec<(Entity, usize)> {
|
||||
let idx = AdjacencyIndex::build(&self.entities, &self.relations);
|
||||
let mut visited: HashSet<u64> = HashSet::new();
|
||||
let mut queue: VecDeque<(u64, usize)> = VecDeque::new();
|
||||
let mut results: Vec<(Entity, usize)> = Vec::new();
|
||||
@@ -349,11 +410,13 @@ impl KnowledgeCache {
|
||||
continue;
|
||||
}
|
||||
|
||||
// Collect neighbour IDs from outgoing and incoming edges.
|
||||
let neighbours: Vec<u64> = self
|
||||
.relations
|
||||
// Collect neighbour IDs from outgoing and incoming edges touching
|
||||
// this node only, instead of scanning every relation in the graph.
|
||||
let neighbours: Vec<u64> = idx
|
||||
.relations_touching(current_id)
|
||||
.iter()
|
||||
.filter_map(|r| {
|
||||
.filter_map(|&i| {
|
||||
let r = &self.relations[i];
|
||||
if r.src == current_id {
|
||||
Some(r.tgt)
|
||||
} else if r.tgt == current_id {
|
||||
@@ -366,9 +429,9 @@ impl KnowledgeCache {
|
||||
|
||||
for neighbour_id in neighbours {
|
||||
if visited.insert(neighbour_id)
|
||||
&& let Some(entity) = self.get_entity(neighbour_id)
|
||||
&& let Some(&entity_idx) = idx.entity_index.get(&neighbour_id)
|
||||
{
|
||||
results.push((entity.clone(), depth + 1));
|
||||
results.push((self.entities[entity_idx].clone(), depth + 1));
|
||||
queue.push_back((neighbour_id, depth + 1));
|
||||
}
|
||||
}
|
||||
@@ -439,6 +502,7 @@ impl KnowledgeCache {
|
||||
min_activation: f32,
|
||||
max_steps: usize,
|
||||
) -> Vec<(u64, f32)> {
|
||||
let idx = AdjacencyIndex::build(&self.entities, &self.relations);
|
||||
let mut activation: HashMap<u64, f32> = HashMap::new();
|
||||
|
||||
// Initialise seeds with activation 1.0.
|
||||
@@ -461,8 +525,10 @@ impl KnowledgeCache {
|
||||
let mut any_spread = false;
|
||||
|
||||
for (source_id, source_score) in current {
|
||||
// Spread to all neighbours via outgoing and incoming edges.
|
||||
for rel in &self.relations {
|
||||
// Spread only to edges touching this node, instead of
|
||||
// scanning every relation in the graph per active node.
|
||||
for &rel_idx in idx.relations_touching(source_id) {
|
||||
let rel = &self.relations[rel_idx];
|
||||
let neighbour_id = if rel.src == source_id {
|
||||
rel.tgt
|
||||
} else if rel.tgt == source_id {
|
||||
@@ -855,6 +921,19 @@ mod tests {
|
||||
assert_eq!(id, orig_id);
|
||||
}
|
||||
|
||||
/// An exact match must win even when a near-match with a smaller Levenshtein
|
||||
/// distance-to-zero gap was scanned first — the early exit on dist == 0
|
||||
/// must not skip past a later exact match.
|
||||
#[test]
|
||||
fn test_resolve_or_create_exact_match_beats_earlier_fuzzy_candidate() {
|
||||
let mut cache = KnowledgeCache::new();
|
||||
cache.add_entity("Alyce", "person", -1); // dist 1 from "Alice"
|
||||
let exact_id = cache.add_entity("Alice", "person", -1); // dist 0
|
||||
let (id, created) = cache.resolve_or_create("Alice", "person", -1, 2);
|
||||
assert!(!created);
|
||||
assert_eq!(id, exact_id);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_resolve_or_create_no_match_beyond_threshold() {
|
||||
let mut cache = KnowledgeCache::new();
|
||||
@@ -1035,6 +1114,30 @@ mod tests {
|
||||
assert!(b_score.unwrap() > 0.0);
|
||||
}
|
||||
|
||||
/// A self-loop relation (src == tgt) must be visited exactly once by the
|
||||
/// adjacency index, matching the pre-index behavior of iterating
|
||||
/// `self.relations` directly (each relation processed once regardless of
|
||||
/// how many of its endpoints match the current node).
|
||||
#[test]
|
||||
fn test_spreading_activation_self_loop_not_double_counted() {
|
||||
let mut cache = KnowledgeCache::new();
|
||||
let a = cache.add_entity("A", "node", -1);
|
||||
cache.add_relation(a, a, "self", 1.0);
|
||||
|
||||
let result = cache.spreading_activation(&[a], 0.5, 0.0001, 1);
|
||||
let a_score = result
|
||||
.iter()
|
||||
.find(|&&(id, _)| id == a)
|
||||
.map(|&(_, s)| s)
|
||||
.unwrap();
|
||||
// Seed activation (1.0) plus exactly one spread contribution
|
||||
// (1.0 * weight 1.0 * decay 0.5), not two.
|
||||
assert!(
|
||||
(a_score - 1.5).abs() < 1e-5,
|
||||
"expected 1.5 (one self-loop contribution), got {a_score}"
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_spreading_activation_decay_reduces_signal() {
|
||||
let mut cache = KnowledgeCache::new();
|
||||
|
||||
+1168
-213
File diff suppressed because it is too large
Load Diff
@@ -748,6 +748,69 @@ impl MemoryBackend for ClawhdfBackend {
|
||||
}
|
||||
}
|
||||
|
||||
// ─────────────────────────────────────────────────────────────────────────────
|
||||
// Ephemeral tier methods on ClawhdfBackend
|
||||
// ─────────────────────────────────────────────────────────────────────────────
|
||||
|
||||
impl ClawhdfBackend {
|
||||
/// Enable the ephemeral (in-memory only) working memory tier.
|
||||
pub fn enable_ephemeral(&mut self, config: crate::ephemeral::EphemeralConfig) {
|
||||
self.memory.enable_ephemeral(config);
|
||||
}
|
||||
|
||||
/// Store a text value in ephemeral memory.
|
||||
///
|
||||
/// Returns an error string if the ephemeral tier has not been enabled.
|
||||
pub fn ephemeral_set(
|
||||
&mut self,
|
||||
key: &str,
|
||||
value: &str,
|
||||
ttl_secs: Option<f64>,
|
||||
) -> Result<(), String> {
|
||||
match self.memory.ephemeral_mut() {
|
||||
Some(s) => {
|
||||
s.set_text(key, value, ttl_secs);
|
||||
Ok(())
|
||||
}
|
||||
None => Err("ephemeral tier not enabled".to_string()),
|
||||
}
|
||||
}
|
||||
|
||||
/// Retrieve a text value from ephemeral memory.
|
||||
///
|
||||
/// Returns `None` if the tier is disabled, the key is absent, or the
|
||||
/// entry has expired.
|
||||
pub fn ephemeral_get(&mut self, key: &str) -> Option<String> {
|
||||
self.memory
|
||||
.ephemeral_mut()?
|
||||
.get_text(key)
|
||||
.map(|s| s.to_string())
|
||||
}
|
||||
|
||||
/// Delete a key from ephemeral memory.
|
||||
///
|
||||
/// Returns `true` if the key existed and was removed.
|
||||
pub fn ephemeral_delete(&mut self, key: &str) -> bool {
|
||||
self.memory.ephemeral_mut().is_some_and(|s| s.delete(key))
|
||||
}
|
||||
|
||||
/// Return a snapshot of ephemeral tier statistics, or `None` if the tier
|
||||
/// is not enabled.
|
||||
pub fn ephemeral_stats(&self) -> Option<crate::ephemeral::EphemeralStats> {
|
||||
self.memory.ephemeral().map(|s| s.stats())
|
||||
}
|
||||
|
||||
/// Promote frequently-accessed ephemeral entries to persistent HDF5 storage.
|
||||
///
|
||||
/// Entries with `access_count >= min_access_count` are moved from the
|
||||
/// ephemeral store into the persistent cache. Returns the count promoted.
|
||||
pub fn promote_ephemeral(&mut self, min_access_count: u32) -> Result<usize, String> {
|
||||
self.memory
|
||||
.promote_ephemeral(min_access_count)
|
||||
.map_err(|e| e.to_string())
|
||||
}
|
||||
}
|
||||
|
||||
// ─────────────────────────────────────────────────────────────────────────────
|
||||
// Tests
|
||||
// ─────────────────────────────────────────────────────────────────────────────
|
||||
@@ -1333,66 +1396,3 @@ mod tests {
|
||||
assert!(out.starts_with("# Title"));
|
||||
}
|
||||
}
|
||||
|
||||
// ─────────────────────────────────────────────────────────────────────────────
|
||||
// Ephemeral tier methods on ClawhdfBackend
|
||||
// ─────────────────────────────────────────────────────────────────────────────
|
||||
|
||||
impl ClawhdfBackend {
|
||||
/// Enable the ephemeral (in-memory only) working memory tier.
|
||||
pub fn enable_ephemeral(&mut self, config: crate::ephemeral::EphemeralConfig) {
|
||||
self.memory.enable_ephemeral(config);
|
||||
}
|
||||
|
||||
/// Store a text value in ephemeral memory.
|
||||
///
|
||||
/// Returns an error string if the ephemeral tier has not been enabled.
|
||||
pub fn ephemeral_set(
|
||||
&mut self,
|
||||
key: &str,
|
||||
value: &str,
|
||||
ttl_secs: Option<f64>,
|
||||
) -> Result<(), String> {
|
||||
match self.memory.ephemeral_mut() {
|
||||
Some(s) => {
|
||||
s.set_text(key, value, ttl_secs);
|
||||
Ok(())
|
||||
}
|
||||
None => Err("ephemeral tier not enabled".to_string()),
|
||||
}
|
||||
}
|
||||
|
||||
/// Retrieve a text value from ephemeral memory.
|
||||
///
|
||||
/// Returns `None` if the tier is disabled, the key is absent, or the
|
||||
/// entry has expired.
|
||||
pub fn ephemeral_get(&mut self, key: &str) -> Option<String> {
|
||||
self.memory
|
||||
.ephemeral_mut()?
|
||||
.get_text(key)
|
||||
.map(|s| s.to_string())
|
||||
}
|
||||
|
||||
/// Delete a key from ephemeral memory.
|
||||
///
|
||||
/// Returns `true` if the key existed and was removed.
|
||||
pub fn ephemeral_delete(&mut self, key: &str) -> bool {
|
||||
self.memory.ephemeral_mut().is_some_and(|s| s.delete(key))
|
||||
}
|
||||
|
||||
/// Return a snapshot of ephemeral tier statistics, or `None` if the tier
|
||||
/// is not enabled.
|
||||
pub fn ephemeral_stats(&self) -> Option<crate::ephemeral::EphemeralStats> {
|
||||
self.memory.ephemeral().map(|s| s.stats())
|
||||
}
|
||||
|
||||
/// Promote frequently-accessed ephemeral entries to persistent HDF5 storage.
|
||||
///
|
||||
/// Entries with `access_count >= min_access_count` are moved from the
|
||||
/// ephemeral store into the persistent cache. Returns the count promoted.
|
||||
pub fn promote_ephemeral(&mut self, min_access_count: u32) -> Result<usize, String> {
|
||||
self.memory
|
||||
.promote_ephemeral(min_access_count)
|
||||
.map_err(|e| e.to_string())
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,7 +1,9 @@
|
||||
//! Memory provenance tracking and integrity verification.
|
||||
//!
|
||||
//! Records the origin, authorship, and integrity of every memory chunk
|
||||
//! so the system can detect tampering and trace data lineage.
|
||||
//! Records the origin, authorship, and a content hash of every memory chunk
|
||||
//! so the system can detect *accidental* corruption and trace data lineage.
|
||||
//! The hash is unkeyed (see [`fnv1a_64`]) — this is not a tamper-evidence or
|
||||
//! authenticity guarantee.
|
||||
|
||||
use std::collections::HashMap;
|
||||
|
||||
@@ -11,6 +13,10 @@ pub use crate::consolidation::MemorySource;
|
||||
// Hash helper (std-only FNV-1a 64-bit)
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
/// Unkeyed, non-cryptographic FNV-1a hash for detecting accidental content
|
||||
/// corruption. It is trivially forgeable by anyone able to modify the stored
|
||||
/// data, since they can recompute and overwrite the stored hash alongside
|
||||
/// it — do not rely on this as a tamper-evidence or authenticity control.
|
||||
fn fnv1a_64(text: &str) -> u64 {
|
||||
const OFFSET: u64 = 14_695_981_039_346_656_037;
|
||||
const PRIME: u64 = 1_099_511_628_211;
|
||||
@@ -99,6 +105,23 @@ impl ProvenanceStore {
|
||||
self.records.insert(provenance.record_id, provenance);
|
||||
}
|
||||
|
||||
/// Renumber records after the store was compacted. `index_map[old]` is
|
||||
/// the record's new id, or `None` if it was removed. Without this, every
|
||||
/// surviving record's hash ends up filed under some other record's id and
|
||||
/// the next integrity check reports a bogus mismatch.
|
||||
pub fn remap(&mut self, index_map: &[Option<usize>]) {
|
||||
let old = std::mem::take(&mut self.records);
|
||||
for (old_id, mut prov) in old {
|
||||
let new_id = usize::try_from(old_id)
|
||||
.ok()
|
||||
.and_then(|i| index_map.get(i).copied().flatten());
|
||||
if let Some(new_id) = new_id {
|
||||
prov.record_id = new_id as u64;
|
||||
self.records.insert(new_id as u64, prov);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// Retrieve by record ID.
|
||||
pub fn get(&self, record_id: u64) -> Option<&MemoryProvenance> {
|
||||
self.records.get(&record_id)
|
||||
@@ -114,6 +137,11 @@ impl ProvenanceStore {
|
||||
|
||||
/// Re-hash `current_chunk` and compare against the stored hash.
|
||||
/// Returns `true` if the content matches (integrity intact).
|
||||
///
|
||||
/// This only detects accidental corruption: the hash is unkeyed, so an
|
||||
/// actor able to modify the stored chunk can also recompute and
|
||||
/// overwrite the stored hash. Do not treat a `true` result as proof the
|
||||
/// data hasn't been tampered with.
|
||||
pub fn verify_integrity(&self, record_id: u64, current_chunk: &str) -> bool {
|
||||
match self.records.get(&record_id) {
|
||||
Some(p) => p.content_hash == fnv1a_64(current_chunk),
|
||||
|
||||
@@ -12,10 +12,18 @@ use crate::MemoryError;
|
||||
use crate::cache::MemoryCache;
|
||||
use crate::knowledge::KnowledgeCache;
|
||||
use crate::session::SessionCache;
|
||||
use crate::wal::WalMark;
|
||||
|
||||
pub const SCHEMA_VERSION: &str = "1.0";
|
||||
pub const ZEROCLAW_VERSION: &str = "0.8.0";
|
||||
|
||||
/// `/meta` attributes holding the [`WalMark`] of the WAL prefix already folded
|
||||
/// into this file. Absent on files written before the mark existed, and when
|
||||
/// the checkpoint was taken with an empty WAL.
|
||||
const WAL_APPLIED_LEN_ATTR: &str = "wal_applied_len";
|
||||
const WAL_APPLIED_CRC_ATTR: &str = "wal_applied_crc";
|
||||
const ANN_GENERATION_ATTR: &str = "ann_generation";
|
||||
|
||||
/// Build a complete HDF5 file from the in-memory state.
|
||||
pub fn build_hdf5_file(
|
||||
config: &MemoryConfig,
|
||||
@@ -23,6 +31,47 @@ pub fn build_hdf5_file(
|
||||
sessions: &SessionCache,
|
||||
knowledge: &KnowledgeCache,
|
||||
) -> Result<Vec<u8>, MemoryError> {
|
||||
build_hdf5_file_with_mark(config, cache, sessions, knowledge, None)
|
||||
}
|
||||
|
||||
/// [`build_hdf5_file`], recording which WAL prefix this state already
|
||||
/// contains (see [`WalMark`]) so a crash before the WAL is truncated doesn't
|
||||
/// replay those entries a second time.
|
||||
pub fn build_hdf5_file_with_mark(
|
||||
config: &MemoryConfig,
|
||||
cache: &MemoryCache,
|
||||
sessions: &SessionCache,
|
||||
knowledge: &KnowledgeCache,
|
||||
wal_applied: Option<WalMark>,
|
||||
) -> Result<Vec<u8>, MemoryError> {
|
||||
let meta = CheckpointMeta {
|
||||
wal_applied,
|
||||
ann_generation: None,
|
||||
};
|
||||
build_hdf5_file_with_meta(config, cache, sessions, knowledge, &meta)
|
||||
}
|
||||
|
||||
/// Bookkeeping a checkpoint records in `/meta` beside the store's contents.
|
||||
#[derive(Debug, Clone, Copy, Default, PartialEq, Eq)]
|
||||
pub struct CheckpointMeta {
|
||||
/// The WAL prefix this checkpoint already contains; see [`WalMark`].
|
||||
pub wal_applied: Option<WalMark>,
|
||||
/// Identifies the vector-index sidecar (`<store>.h5.ann`) written with this
|
||||
/// checkpoint. A sidecar is loaded only if it carries the same value, so
|
||||
/// one left over from another checkpoint can never be attached to records
|
||||
/// it wasn't built from.
|
||||
pub ann_generation: Option<u64>,
|
||||
}
|
||||
|
||||
/// [`build_hdf5_file`] with checkpoint bookkeeping.
|
||||
pub fn build_hdf5_file_with_meta(
|
||||
config: &MemoryConfig,
|
||||
cache: &MemoryCache,
|
||||
sessions: &SessionCache,
|
||||
knowledge: &KnowledgeCache,
|
||||
checkpoint: &CheckpointMeta,
|
||||
) -> Result<Vec<u8>, MemoryError> {
|
||||
let wal_applied = checkpoint.wal_applied;
|
||||
let mut builder = clawhdf5::FileBuilder::new();
|
||||
|
||||
// /meta group with schema attributes
|
||||
@@ -34,10 +83,40 @@ pub fn build_hdf5_file(
|
||||
meta.set_attr("embedding_dim", AttrValue::I64(config.embedding_dim as i64));
|
||||
meta.set_attr("chunk_size", AttrValue::I64(config.chunk_size as i64));
|
||||
meta.set_attr("overlap", AttrValue::I64(config.overlap as i64));
|
||||
// Behavioural settings. These used to live only in memory, so reopening a
|
||||
// store silently reset them to defaults — e.g. a compressed store was
|
||||
// rewritten uncompressed by the first checkpoint after a reopen. Loaders
|
||||
// treat each one as optional so older files keep opening.
|
||||
meta.set_attr("float16", AttrValue::I64(config.float16.into()));
|
||||
meta.set_attr("compression", AttrValue::I64(config.compression.into()));
|
||||
meta.set_attr(
|
||||
"compression_level",
|
||||
AttrValue::I64(config.compression_level.into()),
|
||||
);
|
||||
meta.set_attr(
|
||||
"compact_threshold",
|
||||
AttrValue::F64(config.compact_threshold.into()),
|
||||
);
|
||||
meta.set_attr("hebbian_boost", AttrValue::F64(config.hebbian_boost.into()));
|
||||
meta.set_attr("decay_factor", AttrValue::F64(config.decay_factor.into()));
|
||||
meta.set_attr("wal_enabled", AttrValue::I64(config.wal_enabled.into()));
|
||||
meta.set_attr(
|
||||
"wal_max_entries",
|
||||
AttrValue::I64(config.wal_max_entries as i64),
|
||||
);
|
||||
meta.set_attr(
|
||||
"edgehdf5_version",
|
||||
AttrValue::String(ZEROCLAW_VERSION.into()),
|
||||
);
|
||||
if let Some(mark) = wal_applied.filter(|m| m.len > 0) {
|
||||
meta.set_attr(WAL_APPLIED_LEN_ATTR, AttrValue::I64(mark.len as i64));
|
||||
meta.set_attr(WAL_APPLIED_CRC_ATTR, AttrValue::I64(i64::from(mark.crc)));
|
||||
}
|
||||
if let Some(generation) = checkpoint.ann_generation {
|
||||
// Stored as the i64 with the same bits; attributes have no u64 scalar
|
||||
// round trip through every reader.
|
||||
meta.set_attr(ANN_GENERATION_ATTR, AttrValue::I64(generation as i64));
|
||||
}
|
||||
// Need at least one dataset in the group for it to be a proper group
|
||||
meta.create_dataset("_marker").with_u8_data(&[1]).compact();
|
||||
let finished_meta = meta.finish();
|
||||
@@ -83,14 +162,33 @@ fn build_memory_group(
|
||||
let rows_per_chunk = (target_chunk_bytes / (d * 4)).max(1).min(n);
|
||||
ds.with_chunks(&[rows_per_chunk, d]);
|
||||
|
||||
// Compression: shuffle + deflate for embeddings when enabled
|
||||
// Compression. Shuffle is applied automatically (auto-shuffle
|
||||
// pre-filter). Zstd is faster than deflate at the same ratio but
|
||||
// pulls in libzstd, so it is opt-in via the `zstd` feature; the
|
||||
// default build uses deflate, which is always available. (This
|
||||
// used to call `with_zstd` unconditionally, so without the
|
||||
// feature every checkpoint of a compressed store failed with
|
||||
// "unsupported filter: 32015".) Both are standard HDF5 filters;
|
||||
// reading a zstd-compressed store needs a zstd-enabled build.
|
||||
if config.compression {
|
||||
let level = if config.compression_level > 0 {
|
||||
config.compression_level
|
||||
} else {
|
||||
1 // fast default for embeddings
|
||||
};
|
||||
ds.with_shuffle().with_deflate(level);
|
||||
#[cfg(feature = "zstd")]
|
||||
{
|
||||
let level = if config.compression_level > 0 {
|
||||
config.compression_level.min(22)
|
||||
} else {
|
||||
3 // fast + good ratio for f32 embeddings
|
||||
};
|
||||
ds.with_zstd(level);
|
||||
}
|
||||
#[cfg(not(feature = "zstd"))]
|
||||
{
|
||||
let level = if config.compression_level > 0 {
|
||||
config.compression_level.min(9)
|
||||
} else {
|
||||
4
|
||||
};
|
||||
ds.with_deflate(level);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -308,6 +406,36 @@ fn write_string_dataset(
|
||||
}
|
||||
|
||||
/// Validate an HDF5 file has the correct schema and load all data.
|
||||
/// Read the checkpoint's [`WalMark`] from `/meta`, if it has one.
|
||||
pub fn read_wal_mark(file: &clawhdf5::File) -> Option<WalMark> {
|
||||
let attrs = file.group("meta").ok()?.attrs().ok()?;
|
||||
let len = match attrs.get(WAL_APPLIED_LEN_ATTR)? {
|
||||
AttrValue::I64(v) => u64::try_from(*v).ok()?,
|
||||
_ => return None,
|
||||
};
|
||||
let crc = match attrs.get(WAL_APPLIED_CRC_ATTR)? {
|
||||
AttrValue::I64(v) => u32::try_from(*v).ok()?,
|
||||
_ => return None,
|
||||
};
|
||||
Some(WalMark { len, crc })
|
||||
}
|
||||
|
||||
/// Read the checkpoint bookkeeping from `/meta`.
|
||||
pub fn read_checkpoint_meta(file: &clawhdf5::File) -> CheckpointMeta {
|
||||
let ann_generation = file
|
||||
.group("meta")
|
||||
.ok()
|
||||
.and_then(|g| g.attrs().ok())
|
||||
.and_then(|attrs| match attrs.get(ANN_GENERATION_ATTR) {
|
||||
Some(AttrValue::I64(v)) => Some(*v as u64),
|
||||
_ => None,
|
||||
});
|
||||
CheckpointMeta {
|
||||
wal_applied: read_wal_mark(file),
|
||||
ann_generation,
|
||||
}
|
||||
}
|
||||
|
||||
pub fn validate_and_load(
|
||||
file: &clawhdf5::File,
|
||||
) -> Result<(MemoryConfig, MemoryCache, SessionCache, KnowledgeCache), MemoryError> {
|
||||
@@ -343,15 +471,19 @@ pub fn validate_and_load(
|
||||
embedding_dim,
|
||||
chunk_size,
|
||||
overlap,
|
||||
float16: false,
|
||||
compression: false,
|
||||
compression_level: 0,
|
||||
compact_threshold: 0.3,
|
||||
hebbian_boost: 0.15,
|
||||
decay_factor: 0.98,
|
||||
float16: optional_bool_attr(&attrs, "float16", false),
|
||||
compression: optional_bool_attr(&attrs, "compression", false),
|
||||
compression_level: optional_i64_attr(&attrs, "compression_level")
|
||||
.and_then(|v| u32::try_from(v).ok())
|
||||
.unwrap_or(0),
|
||||
compact_threshold: optional_f32_attr(&attrs, "compact_threshold", 0.3),
|
||||
hebbian_boost: optional_f32_attr(&attrs, "hebbian_boost", 0.15),
|
||||
decay_factor: optional_f32_attr(&attrs, "decay_factor", 0.98),
|
||||
created_at,
|
||||
wal_enabled: true,
|
||||
wal_max_entries: 500,
|
||||
wal_enabled: optional_bool_attr(&attrs, "wal_enabled", true),
|
||||
wal_max_entries: optional_i64_attr(&attrs, "wal_max_entries")
|
||||
.and_then(|v| usize::try_from(v).ok())
|
||||
.unwrap_or(500),
|
||||
};
|
||||
|
||||
// Load /memory group
|
||||
@@ -390,20 +522,46 @@ fn load_memory_group(
|
||||
let tags = read_string_dataset_from_group(&group, "tags")?;
|
||||
let tombstones = read_u8_dataset(&group, "tombstones")?;
|
||||
|
||||
// Read norms if present, otherwise compute from embeddings
|
||||
let norms = match read_f32_dataset(&group, "norms") {
|
||||
Ok(n) if n.len() == n.len() => n,
|
||||
_ => {
|
||||
// Compute norms from flat embeddings
|
||||
flat_embeddings
|
||||
.chunks(embedding_dim)
|
||||
.map(|chunk| {
|
||||
let sq_sum: f32 = chunk.iter().map(|x| x * x).sum();
|
||||
sq_sum.sqrt()
|
||||
})
|
||||
.collect()
|
||||
// Every per-record dataset must describe exactly `n` records. Without
|
||||
// this, a truncated or hand-edited file loads "successfully" and then
|
||||
// panics on the first out-of-bounds index during search/delete.
|
||||
if embedding_dim == 0 {
|
||||
return Err(MemoryError::Schema(format!(
|
||||
"/memory has {n} records but embedding_dim is 0"
|
||||
)));
|
||||
}
|
||||
let expected_flat = n.checked_mul(embedding_dim).ok_or_else(|| {
|
||||
MemoryError::Schema(format!("/memory size overflow: {n} x {embedding_dim}"))
|
||||
})?;
|
||||
let check_len = |name: &str, actual: usize, expected: usize| {
|
||||
if actual == expected {
|
||||
Ok(())
|
||||
} else {
|
||||
Err(MemoryError::Schema(format!(
|
||||
"/memory/{name} has {actual} entries, expected {expected} \
|
||||
({n} records)"
|
||||
)))
|
||||
}
|
||||
};
|
||||
check_len("embeddings", flat_embeddings.len(), expected_flat)?;
|
||||
check_len("source_channel", source_channels.len(), n)?;
|
||||
check_len("timestamps", timestamps.len(), n)?;
|
||||
check_len("session_ids", session_ids.len(), n)?;
|
||||
check_len("tags", tags.len(), n)?;
|
||||
check_len("tombstones", tombstones.len(), n)?;
|
||||
|
||||
// Norms are derived data: use the stored ones only if they are present
|
||||
// and the right length, otherwise recompute from the embeddings.
|
||||
let norms = match read_f32_dataset(&group, "norms") {
|
||||
Ok(stored) if stored.len() == n => stored,
|
||||
_ => flat_embeddings
|
||||
.chunks(embedding_dim)
|
||||
.map(|chunk| {
|
||||
let sq_sum: f32 = chunk.iter().map(|x| x * x).sum();
|
||||
sq_sum.sqrt()
|
||||
})
|
||||
.collect(),
|
||||
};
|
||||
|
||||
// Unflatten embeddings
|
||||
let embeddings: Vec<Vec<f32>> = flat_embeddings
|
||||
@@ -426,6 +584,7 @@ fn load_memory_group(
|
||||
cache.tombstones = tombstones;
|
||||
cache.norms = norms;
|
||||
cache.activation_weights = activation_weights;
|
||||
cache.rebuild_flat();
|
||||
|
||||
Ok(cache)
|
||||
}
|
||||
@@ -479,6 +638,7 @@ fn load_knowledge_group(file: &clawhdf5::File) -> Result<KnowledgeCache, MemoryE
|
||||
cache.entities.push(crate::knowledge::Entity {
|
||||
id: entity_ids[i] as u64,
|
||||
name: entity_names[i].clone(),
|
||||
name_lower: entity_names[i].to_lowercase(),
|
||||
entity_type: entity_types[i].clone(),
|
||||
embedding_idx: emb_idxs[i],
|
||||
..Default::default()
|
||||
@@ -528,6 +688,27 @@ fn extract_string_attr(
|
||||
}
|
||||
}
|
||||
|
||||
type MetaAttrs = std::collections::HashMap<String, AttrValue>;
|
||||
|
||||
fn optional_i64_attr(attrs: &MetaAttrs, name: &str) -> Option<i64> {
|
||||
match attrs.get(name) {
|
||||
Some(AttrValue::I64(v)) => Some(*v),
|
||||
_ => None,
|
||||
}
|
||||
}
|
||||
|
||||
fn optional_bool_attr(attrs: &MetaAttrs, name: &str, default: bool) -> bool {
|
||||
optional_i64_attr(attrs, name).map_or(default, |v| v != 0)
|
||||
}
|
||||
|
||||
/// Finite values only: a NaN threshold/decay would poison every comparison.
|
||||
fn optional_f32_attr(attrs: &MetaAttrs, name: &str, default: f32) -> f32 {
|
||||
match attrs.get(name) {
|
||||
Some(AttrValue::F64(v)) if v.is_finite() => *v as f32,
|
||||
_ => default,
|
||||
}
|
||||
}
|
||||
|
||||
fn extract_i64_attr(
|
||||
attrs: &std::collections::HashMap<String, AttrValue>,
|
||||
name: &str,
|
||||
@@ -613,3 +794,108 @@ fn read_u8_dataset(group: &clawhdf5::Group<'_>, name: &str) -> Result<Vec<u8>, M
|
||||
.map_err(|e| MemoryError::Hdf5(format!("cannot read u8 from {name}: {e}")))?;
|
||||
Ok(data.into_iter().map(|v| v as u8).collect())
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
|
||||
fn config() -> MemoryConfig {
|
||||
MemoryConfig::new(std::path::PathBuf::from("unused.h5"), "agent", 4)
|
||||
}
|
||||
|
||||
fn cache_with(n: usize) -> MemoryCache {
|
||||
let mut cache = MemoryCache::new(4);
|
||||
for i in 0..n {
|
||||
cache.push(
|
||||
format!("chunk {i}"),
|
||||
vec![i as f32 + 1.0, 0.0, 0.0, 0.0],
|
||||
"user".into(),
|
||||
i as f64,
|
||||
"s".into(),
|
||||
"t".into(),
|
||||
);
|
||||
}
|
||||
cache
|
||||
}
|
||||
|
||||
fn roundtrip(cache: &MemoryCache) -> Result<MemoryCache, MemoryError> {
|
||||
let bytes = build_hdf5_file(
|
||||
&config(),
|
||||
cache,
|
||||
&SessionCache::new(),
|
||||
&KnowledgeCache::new(),
|
||||
)?;
|
||||
let file =
|
||||
clawhdf5::File::from_bytes(bytes).map_err(|e| MemoryError::Hdf5(e.to_string()))?;
|
||||
validate_and_load(&file).map(|(_, cache, _, _)| cache)
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn behavioural_config_survives_a_reopen() {
|
||||
let mut cfg = config();
|
||||
cfg.compression = true;
|
||||
cfg.compression_level = 7;
|
||||
cfg.compact_threshold = 0.5;
|
||||
cfg.hebbian_boost = 0.25;
|
||||
cfg.decay_factor = 0.9;
|
||||
cfg.wal_enabled = false;
|
||||
cfg.wal_max_entries = 42;
|
||||
let bytes = build_hdf5_file(
|
||||
&cfg,
|
||||
&cache_with(2),
|
||||
&SessionCache::new(),
|
||||
&KnowledgeCache::new(),
|
||||
)
|
||||
.unwrap();
|
||||
let file = clawhdf5::File::from_bytes(bytes).unwrap();
|
||||
let (loaded, loaded_cache, ..) = validate_and_load(&file).unwrap();
|
||||
// The compressed embeddings must also read back intact.
|
||||
assert_eq!(loaded_cache.embeddings, cache_with(2).embeddings);
|
||||
assert!(loaded.compression);
|
||||
assert_eq!(loaded.compression_level, 7);
|
||||
assert_eq!(loaded.compact_threshold, 0.5);
|
||||
assert_eq!(loaded.hebbian_boost, 0.25);
|
||||
assert_eq!(loaded.decay_factor, 0.9);
|
||||
assert!(!loaded.wal_enabled);
|
||||
assert_eq!(loaded.wal_max_entries, 42);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn consistent_store_loads() {
|
||||
let loaded = roundtrip(&cache_with(3)).unwrap();
|
||||
assert_eq!(loaded.chunks.len(), 3);
|
||||
assert_eq!(loaded.norms, vec![1.0, 2.0, 3.0]);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn wrong_length_norms_are_recomputed_not_trusted() {
|
||||
// Regression: the guard used to be `n.len() == n.len()`, so a norms
|
||||
// dataset of any length was accepted and corrupted every cosine score.
|
||||
let mut cache = cache_with(3);
|
||||
cache.norms = vec![99.0];
|
||||
let loaded = roundtrip(&cache).unwrap();
|
||||
assert_eq!(loaded.norms, vec![1.0, 2.0, 3.0]);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn mismatched_per_record_datasets_are_schema_errors() {
|
||||
type Corrupt = fn(&mut MemoryCache);
|
||||
let cases: [(&str, Corrupt); 5] = [
|
||||
("tombstones", |c| c.tombstones.truncate(1)),
|
||||
("timestamps", |c| c.timestamps.truncate(1)),
|
||||
("tags", |c| c.tags.truncate(1)),
|
||||
("session_ids", |c| c.session_ids.truncate(1)),
|
||||
("source_channel", |c| c.source_channels.truncate(1)),
|
||||
];
|
||||
for (name, corrupt) in cases {
|
||||
let mut cache = cache_with(3);
|
||||
corrupt(&mut cache);
|
||||
match roundtrip(&cache) {
|
||||
Err(MemoryError::Schema(msg)) => {
|
||||
assert!(msg.contains(name), "{name}: unexpected message {msg}")
|
||||
}
|
||||
other => panic!("{name}: expected Schema error, got {:?}", other.map(|_| ())),
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -4,7 +4,7 @@ use std::path::Path;
|
||||
|
||||
use crate::bm25;
|
||||
use crate::hybrid;
|
||||
use crate::{HDF5Memory, MemoryError, Result, SearchResult};
|
||||
use crate::{HDF5Memory, MAX_ACTIVATION_WEIGHT, MemoryError, Result, SearchResult};
|
||||
|
||||
impl HDF5Memory {
|
||||
/// Vector + keyword scoring stage of [`HDF5Memory::hybrid_search`].
|
||||
@@ -26,9 +26,7 @@ impl HDF5Memory {
|
||||
) -> Vec<(usize, f32)> {
|
||||
self.ensure_hnsw_fresh();
|
||||
match self.hnsw.as_ref() {
|
||||
Some(index)
|
||||
if !index.is_empty() && index.dimension() == query_embedding.len() =>
|
||||
{
|
||||
Some(index) if !index.is_empty() && index.dimension() == query_embedding.len() => {
|
||||
// Over-fetch so the merge sees a useful vector pool; cosine
|
||||
// distance from the index converts back to similarity (1 - d).
|
||||
let pool = (k * 8).max(64);
|
||||
@@ -37,8 +35,16 @@ impl HDF5Memory {
|
||||
.into_iter()
|
||||
.map(|(id, dist)| (id, 1.0 - dist))
|
||||
.collect();
|
||||
let kw_scores = bm25.search(query_text, self.cache.len());
|
||||
hybrid::merge_vector_keyword(vec_scores, kw_scores, vector_weight, keyword_weight, k)
|
||||
// Fusion normalises over every keyword match, so it needs all
|
||||
// the scores — but not ranked.
|
||||
let kw_scores = bm25.scores(query_text);
|
||||
hybrid::merge_vector_keyword(
|
||||
vec_scores,
|
||||
kw_scores,
|
||||
vector_weight,
|
||||
keyword_weight,
|
||||
k,
|
||||
)
|
||||
}
|
||||
_ => hybrid::hybrid_search(
|
||||
query_embedding,
|
||||
@@ -86,7 +92,11 @@ impl HDF5Memory {
|
||||
keyword_weight: f32,
|
||||
k: usize,
|
||||
) -> Vec<SearchResult> {
|
||||
let bm25 = bm25::BM25Index::build(&self.cache.chunks, &self.cache.tombstones);
|
||||
// The keyword index lives for the life of the store and is updated
|
||||
// incrementally. Take it out for the duration of the call so the
|
||||
// vector stage can borrow `self` mutably, then put it back.
|
||||
self.ensure_bm25_fresh();
|
||||
let bm25 = self.bm25.take().expect("ensure_bm25_fresh leaves an index");
|
||||
let scored = self.vector_keyword_search(
|
||||
query_embedding,
|
||||
query_text,
|
||||
@@ -109,23 +119,45 @@ impl HDF5Memory {
|
||||
}
|
||||
})
|
||||
.collect();
|
||||
// Ties broken by index so results (and therefore which records get
|
||||
// boosted) don't depend on HashMap iteration order upstream.
|
||||
results.sort_by(|a, b| {
|
||||
b.score
|
||||
.partial_cmp(&a.score)
|
||||
.unwrap_or(std::cmp::Ordering::Equal)
|
||||
.then(a.index.cmp(&b.index))
|
||||
});
|
||||
|
||||
let hit_indices: Vec<usize> = results.iter().map(|r| r.index).collect();
|
||||
// Only reinforce records that actually matched. When fewer than `k`
|
||||
// records are relevant, the rest of the list is zero-score filler;
|
||||
// boosting it would teach the store that arbitrary records are
|
||||
// important just because they were nearby in iteration order.
|
||||
let hit_indices: Vec<usize> = results
|
||||
.iter()
|
||||
.filter(|r| r.score > 0.0)
|
||||
.map(|r| r.index)
|
||||
.collect();
|
||||
self.apply_hebbian_boost(&hit_indices);
|
||||
self.flush().ok();
|
||||
self.bm25 = Some(bm25);
|
||||
|
||||
results
|
||||
}
|
||||
|
||||
/// Reinforce the records a query returned. The new weights are persisted by
|
||||
/// the next checkpoint (any write that flushes, `flush_wal`, or drop) — not
|
||||
/// by rewriting the whole store inside the query, which is what made
|
||||
/// `hybrid_search` cost O(store size) in disk I/O. They are a ranking hint,
|
||||
/// not user data: a crash before the next checkpoint only forgets the
|
||||
/// boosts since the last one.
|
||||
fn apply_hebbian_boost(&mut self, hit_indices: &[usize]) {
|
||||
for &idx in hit_indices {
|
||||
self.cache.activation_weights[idx] += self.config.hebbian_boost;
|
||||
if hit_indices.is_empty() || self.config.hebbian_boost == 0.0 {
|
||||
return;
|
||||
}
|
||||
for &idx in hit_indices {
|
||||
let w = &mut self.cache.activation_weights[idx];
|
||||
*w = (*w + self.config.hebbian_boost).min(MAX_ACTIVATION_WEIGHT);
|
||||
}
|
||||
self.activations_dirty = true;
|
||||
}
|
||||
|
||||
/// Get the chunk text for a memory entry by index.
|
||||
|
||||
@@ -11,6 +11,7 @@ use crate::cache::MemoryCache;
|
||||
use crate::knowledge::KnowledgeCache;
|
||||
use crate::schema;
|
||||
use crate::session::SessionCache;
|
||||
use crate::wal::WalMark;
|
||||
|
||||
/// Write all in-memory state to an HDF5 file on disk.
|
||||
pub fn write_to_disk(
|
||||
@@ -20,7 +21,36 @@ pub fn write_to_disk(
|
||||
sessions: &SessionCache,
|
||||
knowledge: &KnowledgeCache,
|
||||
) -> Result<(), MemoryError> {
|
||||
let bytes = schema::build_hdf5_file(config, cache, sessions, knowledge)?;
|
||||
write_to_disk_with_mark(path, config, cache, sessions, knowledge, None)
|
||||
}
|
||||
|
||||
/// [`write_to_disk`] for a checkpoint: `wal_applied` is the mark of the WAL
|
||||
/// prefix whose entries `cache` already contains.
|
||||
pub fn write_to_disk_with_mark(
|
||||
path: &Path,
|
||||
config: &MemoryConfig,
|
||||
cache: &MemoryCache,
|
||||
sessions: &SessionCache,
|
||||
knowledge: &KnowledgeCache,
|
||||
wal_applied: Option<WalMark>,
|
||||
) -> Result<(), MemoryError> {
|
||||
let meta = schema::CheckpointMeta {
|
||||
wal_applied,
|
||||
ann_generation: None,
|
||||
};
|
||||
write_to_disk_with_meta(path, config, cache, sessions, knowledge, &meta)
|
||||
}
|
||||
|
||||
/// [`write_to_disk`] with full checkpoint bookkeeping.
|
||||
pub fn write_to_disk_with_meta(
|
||||
path: &Path,
|
||||
config: &MemoryConfig,
|
||||
cache: &MemoryCache,
|
||||
sessions: &SessionCache,
|
||||
knowledge: &KnowledgeCache,
|
||||
checkpoint: &schema::CheckpointMeta,
|
||||
) -> Result<(), MemoryError> {
|
||||
let bytes = schema::build_hdf5_file_with_meta(config, cache, sessions, knowledge, checkpoint)?;
|
||||
|
||||
if bytes.is_empty() {
|
||||
return Err(MemoryError::Hdf5("build_hdf5_file produced 0 bytes".into()));
|
||||
@@ -28,9 +58,41 @@ pub fn write_to_disk(
|
||||
|
||||
// Write to a temp file first, then rename for atomicity
|
||||
let tmp_path = path.with_extension("h5.tmp");
|
||||
std::fs::write(&tmp_path, &bytes).map_err(MemoryError::Io)?;
|
||||
std::fs::rename(&tmp_path, path).map_err(MemoryError::Io)?;
|
||||
write_synced(&tmp_path, &bytes)?;
|
||||
rename_synced(&tmp_path, path)
|
||||
}
|
||||
|
||||
/// Write `bytes` to `path` and flush them to stable storage.
|
||||
pub(crate) fn write_synced(path: &Path, bytes: &[u8]) -> Result<(), MemoryError> {
|
||||
use std::io::Write;
|
||||
let mut f = std::fs::File::create(path).map_err(MemoryError::Io)?;
|
||||
f.write_all(bytes).map_err(MemoryError::Io)?;
|
||||
f.sync_all().map_err(MemoryError::Io)
|
||||
}
|
||||
|
||||
/// Rename `from` over `to`, then sync the parent directory so the rename
|
||||
/// itself survives a power loss. `from` must already be synced: without that,
|
||||
/// the rename can reach disk before the data and leave an empty or partial
|
||||
/// file under the final name.
|
||||
///
|
||||
/// This is per-checkpoint/snapshot cost only (each is already a full file
|
||||
/// write). Individual WAL appends are deliberately not synced — see the
|
||||
/// durability notes in the crate docs.
|
||||
pub(crate) fn rename_synced(from: &Path, to: &Path) -> Result<(), MemoryError> {
|
||||
std::fs::rename(from, to).map_err(MemoryError::Io)?;
|
||||
#[cfg(unix)]
|
||||
if let Some(dir) = to.parent() {
|
||||
let dir = if dir.as_os_str().is_empty() {
|
||||
Path::new(".")
|
||||
} else {
|
||||
dir
|
||||
};
|
||||
// Directory fsync is best-effort: some filesystems refuse it, and the
|
||||
// rename has already happened.
|
||||
if let Ok(d) = std::fs::File::open(dir) {
|
||||
let _ = d.sync_all();
|
||||
}
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
|
||||
@@ -42,6 +104,15 @@ pub fn write_to_disk(
|
||||
pub fn read_from_disk(
|
||||
path: &Path,
|
||||
) -> Result<(MemoryConfig, MemoryCache, SessionCache, KnowledgeCache), MemoryError> {
|
||||
read_from_disk_with_mark(path).map(|(state, _mark)| state)
|
||||
}
|
||||
|
||||
/// Everything [`read_from_disk`] returns.
|
||||
pub type StoreState = (MemoryConfig, MemoryCache, SessionCache, KnowledgeCache);
|
||||
|
||||
/// [`read_from_disk`], plus the checkpoint's [`WalMark`] (if any) so the
|
||||
/// caller can skip WAL entries this file already contains.
|
||||
pub fn read_from_disk_with_mark(path: &Path) -> Result<(StoreState, Option<WalMark>), MemoryError> {
|
||||
let mmap = clawhdf5_io::MmapReader::open(path).map_err(MemoryError::Io)?;
|
||||
|
||||
// Advise the OS we'll need the whole file for parsing
|
||||
@@ -53,8 +124,23 @@ pub fn read_from_disk(
|
||||
|
||||
let (mut config, cache, sessions, knowledge) = schema::validate_and_load(&file)?;
|
||||
config.path = path.to_path_buf();
|
||||
let wal_applied = schema::read_wal_mark(&file);
|
||||
|
||||
Ok((config, cache, sessions, knowledge))
|
||||
Ok(((config, cache, sessions, knowledge), wal_applied))
|
||||
}
|
||||
|
||||
/// [`read_from_disk`], plus all checkpoint bookkeeping.
|
||||
pub fn read_from_disk_with_meta(
|
||||
path: &Path,
|
||||
) -> Result<(StoreState, schema::CheckpointMeta), MemoryError> {
|
||||
let mmap = clawhdf5_io::MmapReader::open(path).map_err(MemoryError::Io)?;
|
||||
mmap.advise_willneed(0, mmap.len());
|
||||
let file = clawhdf5::File::from_bytes(mmap.as_bytes().to_vec())
|
||||
.map_err(|e| MemoryError::Hdf5(format!("cannot open {}: {e}", path.display())))?;
|
||||
let (mut config, cache, sessions, knowledge) = schema::validate_and_load(&file)?;
|
||||
config.path = path.to_path_buf();
|
||||
let meta = schema::read_checkpoint_meta(&file);
|
||||
Ok(((config, cache, sessions, knowledge), meta))
|
||||
}
|
||||
|
||||
/// Copy an HDF5 file atomically to a destination.
|
||||
@@ -78,7 +164,10 @@ pub fn snapshot_file(src: &Path, dest: &Path) -> Result<std::path::PathBuf, Memo
|
||||
// Atomic copy: write to temp, then rename
|
||||
let tmp_path = dest_file.with_extension("h5.tmp");
|
||||
std::fs::copy(src, &tmp_path).map_err(MemoryError::Io)?;
|
||||
std::fs::rename(&tmp_path, &dest_file).map_err(MemoryError::Io)?;
|
||||
std::fs::File::open(&tmp_path)
|
||||
.and_then(|f| f.sync_all())
|
||||
.map_err(MemoryError::Io)?;
|
||||
rename_synced(&tmp_path, &dest_file)?;
|
||||
|
||||
Ok(dest_file)
|
||||
}
|
||||
|
||||
@@ -0,0 +1,79 @@
|
||||
//! Single-writer guard for a memory store.
|
||||
//!
|
||||
//! `HDF5Memory` keeps the whole store in memory and rewrites the `.h5` file at
|
||||
//! every checkpoint, so two handles on one store (two processes, or two opens
|
||||
//! in one process) silently destroy each other's data: whoever checkpoints
|
||||
//! last wins, and both append to the same WAL with independent CRC chains.
|
||||
//! The lock turns that into an immediate, explicit error.
|
||||
|
||||
use std::fs::{File, OpenOptions, TryLockError};
|
||||
use std::path::{Path, PathBuf};
|
||||
|
||||
use crate::MemoryError;
|
||||
|
||||
const LOCK_RETRIES: u32 = 25;
|
||||
const LOCK_RETRY_DELAY: std::time::Duration = std::time::Duration::from_millis(10);
|
||||
|
||||
/// An exclusive advisory lock on `<store>.h5.lock`, held for the lifetime of
|
||||
/// the owning `HDF5Memory` and released when it is dropped (or when the
|
||||
/// process dies — the OS drops the lock with the file descriptor, so a crash
|
||||
/// never leaves a stale lock behind; the empty lock file itself is harmless).
|
||||
#[derive(Debug)]
|
||||
pub(crate) struct StoreLock {
|
||||
_file: File,
|
||||
}
|
||||
|
||||
impl StoreLock {
|
||||
pub(crate) fn lock_path(store: &Path) -> PathBuf {
|
||||
store.with_extension("h5.lock")
|
||||
}
|
||||
|
||||
pub(crate) fn acquire(store: &Path) -> Result<Self, MemoryError> {
|
||||
let path = Self::lock_path(store);
|
||||
let file = OpenOptions::new()
|
||||
.create(true)
|
||||
.truncate(false)
|
||||
.write(true)
|
||||
.open(&path)?;
|
||||
// A previous owner may be mid-teardown (e.g. an `AsyncHDF5Memory`
|
||||
// dropped without `shutdown()`: its background task releases the
|
||||
// store a moment later), so give the lock a short, bounded grace
|
||||
// period before reporting a genuine second writer.
|
||||
let mut attempts_left = LOCK_RETRIES;
|
||||
loop {
|
||||
match file.try_lock() {
|
||||
Ok(()) => return Ok(Self { _file: file }),
|
||||
Err(TryLockError::WouldBlock) if attempts_left > 0 => {
|
||||
attempts_left -= 1;
|
||||
std::thread::sleep(LOCK_RETRY_DELAY);
|
||||
}
|
||||
Err(TryLockError::WouldBlock) => {
|
||||
return Err(MemoryError::Locked(format!(
|
||||
"{} is already open in this or another process (lock file {})",
|
||||
store.display(),
|
||||
path.display()
|
||||
)));
|
||||
}
|
||||
Err(TryLockError::Error(e)) => return Err(MemoryError::Io(e)),
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
|
||||
#[test]
|
||||
fn second_acquire_fails_until_first_is_dropped() {
|
||||
let dir = tempfile::TempDir::new().unwrap();
|
||||
let store = dir.path().join("s.h5");
|
||||
let first = StoreLock::acquire(&store).unwrap();
|
||||
assert!(matches!(
|
||||
StoreLock::acquire(&store),
|
||||
Err(MemoryError::Locked(_))
|
||||
));
|
||||
drop(first);
|
||||
StoreLock::acquire(&store).unwrap();
|
||||
}
|
||||
}
|
||||
@@ -167,10 +167,17 @@ pub fn auto_select_strategy(num_vectors: usize, hw: &HardwareCapabilities) -> Se
|
||||
/// This dispatches to the appropriate search implementation based on the
|
||||
/// selected strategy. For IVF-PQ, an index must be provided externally
|
||||
/// (this function uses brute-force fallback if no IVF-PQ index is available).
|
||||
///
|
||||
/// `vectors_flat` is `vectors` flattened into one contiguous `[N × dim]`
|
||||
/// row-major buffer (e.g. `MemoryCache::embeddings_flat`, maintained
|
||||
/// incrementally alongside `vectors`). It's only consulted by the
|
||||
/// `Blas`/`Accelerate` strategies, which otherwise re-flatten the whole
|
||||
/// corpus on every call — passing the already-flat buffer skips that copy.
|
||||
#[allow(clippy::too_many_arguments)]
|
||||
pub fn search_with_metrics(
|
||||
query: &[f32],
|
||||
vectors: &[Vec<f32>],
|
||||
vectors_flat: &[f32],
|
||||
norms: &[f32],
|
||||
tombstones: &[u8],
|
||||
k: usize,
|
||||
@@ -178,6 +185,10 @@ pub fn search_with_metrics(
|
||||
#[cfg(feature = "gpu")] gpu_backend: Option<&crate::gpu_search::GpuSearchBackend>,
|
||||
#[cfg(not(feature = "gpu"))] _gpu_backend: Option<&()>,
|
||||
) -> (Vec<(usize, f32)>, SearchMetrics) {
|
||||
// Only read by the Blas/Accelerate arms below, which are themselves
|
||||
// feature-gated — reference it unconditionally so a build with neither
|
||||
// feature enabled doesn't warn about an unused parameter.
|
||||
let _ = vectors_flat;
|
||||
let start = Instant::now();
|
||||
let active_count = tombstones.iter().filter(|&&t| t == 0).count();
|
||||
|
||||
@@ -197,7 +208,14 @@ pub fn search_with_metrics(
|
||||
gpu_active = false;
|
||||
#[cfg(feature = "fast-math")]
|
||||
{
|
||||
crate::blas_search::blas_cosine_batch(query, vectors, norms, tombstones, k)
|
||||
crate::blas_search::blas_cosine_batch_flat(
|
||||
query,
|
||||
vectors_flat,
|
||||
norms,
|
||||
tombstones,
|
||||
query.len(),
|
||||
k,
|
||||
)
|
||||
}
|
||||
#[cfg(not(feature = "fast-math"))]
|
||||
{
|
||||
@@ -211,8 +229,13 @@ pub fn search_with_metrics(
|
||||
gpu_active = false;
|
||||
#[cfg(any(feature = "accelerate", feature = "openblas"))]
|
||||
{
|
||||
crate::accelerate_search::accelerate_cosine_batch_vecs(
|
||||
query, vectors, norms, tombstones, k,
|
||||
crate::accelerate_search::accelerate_cosine_batch(
|
||||
query,
|
||||
vectors_flat,
|
||||
norms,
|
||||
tombstones,
|
||||
query.len(),
|
||||
k,
|
||||
)
|
||||
}
|
||||
#[cfg(not(any(feature = "accelerate", feature = "openblas")))]
|
||||
@@ -325,6 +348,10 @@ mod tests {
|
||||
(0..n).map(|_| (0..dim).map(|_| next()).collect()).collect()
|
||||
}
|
||||
|
||||
fn flatten(vectors: &[Vec<f32>]) -> Vec<f32> {
|
||||
vectors.iter().flatten().copied().collect()
|
||||
}
|
||||
|
||||
// --- auto_select_strategy tests ---
|
||||
|
||||
#[test]
|
||||
@@ -490,6 +517,7 @@ mod tests {
|
||||
let (results, metrics) = search_with_metrics(
|
||||
&query,
|
||||
&vectors,
|
||||
&flatten(&vectors),
|
||||
&norms,
|
||||
&tombstones,
|
||||
5,
|
||||
@@ -520,6 +548,7 @@ mod tests {
|
||||
let (results, metrics) = search_with_metrics(
|
||||
&query,
|
||||
&vectors,
|
||||
&flatten(&vectors),
|
||||
&norms,
|
||||
&tombstones,
|
||||
10,
|
||||
@@ -545,6 +574,7 @@ mod tests {
|
||||
let (_, metrics) = search_with_metrics(
|
||||
&query,
|
||||
&vectors,
|
||||
&flatten(&vectors),
|
||||
&norms,
|
||||
&tombstones,
|
||||
10,
|
||||
@@ -570,6 +600,7 @@ mod tests {
|
||||
let (results, _) = search_with_metrics(
|
||||
&query,
|
||||
&vectors,
|
||||
&flatten(&vectors),
|
||||
&norms,
|
||||
&tombstones,
|
||||
10,
|
||||
@@ -603,6 +634,7 @@ mod tests {
|
||||
let (results, metrics) = search_with_metrics(
|
||||
&query,
|
||||
&vectors,
|
||||
&flatten(&vectors),
|
||||
&norms,
|
||||
&tombstones,
|
||||
100,
|
||||
@@ -647,6 +679,7 @@ mod tests {
|
||||
let (_, metrics) = search_with_metrics(
|
||||
&query,
|
||||
&vectors,
|
||||
&flatten(&vectors),
|
||||
&norms,
|
||||
&tombstones,
|
||||
5,
|
||||
@@ -718,6 +751,7 @@ mod tests {
|
||||
let (results, metrics) = search_with_metrics(
|
||||
&query,
|
||||
&vectors,
|
||||
&flatten(&vectors),
|
||||
&norms,
|
||||
&tombstones,
|
||||
10,
|
||||
@@ -744,6 +778,7 @@ mod tests {
|
||||
let (results, metrics) = search_with_metrics(
|
||||
&query,
|
||||
&vectors,
|
||||
&flatten(&vectors),
|
||||
&norms,
|
||||
&tombstones,
|
||||
10,
|
||||
@@ -822,6 +857,7 @@ mod tests {
|
||||
let (results, metrics) = search_with_metrics(
|
||||
&query,
|
||||
&vectors,
|
||||
&flatten(&vectors),
|
||||
&norms,
|
||||
&tombstones,
|
||||
10,
|
||||
|
||||
+1040
-131
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,187 @@
|
||||
//! Crash-recovery matrix for `HDF5Memory`.
|
||||
//!
|
||||
//! A process crash leaves whatever reached the OS on disk. These tests build
|
||||
//! the on-disk images such a crash can leave behind — after every operation,
|
||||
//! inside the checkpoint window (new `.h5` in place, WAL not yet truncated),
|
||||
//! and with the WAL torn at every possible length — then reopen each image
|
||||
//! and check the recovered store against a model of what was acknowledged.
|
||||
//!
|
||||
//! Invariants:
|
||||
//! * never a duplicated or invented record;
|
||||
//! * an image taken between operations recovers *exactly* the acknowledged
|
||||
//! state;
|
||||
//! * a torn WAL recovers the last checkpoint plus a prefix of the operations
|
||||
//! logged since.
|
||||
|
||||
use std::path::{Path, PathBuf};
|
||||
|
||||
use clawhdf5_agent::{AgentMemory, HDF5Memory, MemoryConfig, MemoryEntry};
|
||||
use tempfile::TempDir;
|
||||
|
||||
struct Rng(u64);
|
||||
|
||||
impl Rng {
|
||||
fn next(&mut self) -> u64 {
|
||||
self.0 = self.0.wrapping_add(0x9E37_79B9_7F4A_7C15);
|
||||
let mut z = self.0;
|
||||
z = (z ^ (z >> 30)).wrapping_mul(0xBF58_476D_1CE4_E5B9);
|
||||
z = (z ^ (z >> 27)).wrapping_mul(0x94D0_49BB_1331_11EB);
|
||||
z ^ (z >> 31)
|
||||
}
|
||||
fn below(&mut self, n: usize) -> usize {
|
||||
(self.next() % n.max(1) as u64) as usize
|
||||
}
|
||||
}
|
||||
|
||||
fn entry(chunk: &str, tags: &str) -> MemoryEntry {
|
||||
MemoryEntry {
|
||||
chunk: chunk.to_string(),
|
||||
embedding: vec![1.0, 0.0, 0.0, 0.0],
|
||||
source_channel: "test".into(),
|
||||
timestamp: 1.0,
|
||||
session_id: "s".into(),
|
||||
tags: tags.to_string(),
|
||||
}
|
||||
}
|
||||
|
||||
fn wal_path(h5: &Path) -> PathBuf {
|
||||
h5.with_extension("h5.wal")
|
||||
}
|
||||
|
||||
/// Copy the store (`.h5` + WAL) into a fresh directory, as a crash image.
|
||||
fn image(h5: &Path, into: &TempDir, name: &str) -> PathBuf {
|
||||
let dest = into.path().join(format!("{name}.h5"));
|
||||
std::fs::copy(h5, &dest).unwrap();
|
||||
if wal_path(h5).exists() {
|
||||
std::fs::copy(wal_path(h5), wal_path(&dest)).unwrap();
|
||||
}
|
||||
dest
|
||||
}
|
||||
|
||||
fn recovered(h5: &Path) -> Vec<String> {
|
||||
// Read-only: the image must not be modified, and no lock is needed.
|
||||
HDF5Memory::open_read_only(h5).unwrap().cache.chunks.clone()
|
||||
}
|
||||
|
||||
/// Apply one random operation to the store and to the model.
|
||||
fn step(mem: &mut HDF5Memory, model: &mut Vec<String>, rng: &mut Rng, n: usize) {
|
||||
match rng.below(6) {
|
||||
0 => mem.flush_wal().unwrap(),
|
||||
1 if !model.is_empty() => {
|
||||
// Update an existing record in place, addressed by its tag.
|
||||
let idx = rng.below(model.len());
|
||||
let chunk = format!("u{n}");
|
||||
assert_eq!(
|
||||
mem.save_or_update(entry(&chunk, &format!("tag{idx}")))
|
||||
.unwrap(),
|
||||
idx
|
||||
);
|
||||
model[idx] = chunk;
|
||||
}
|
||||
_ => {
|
||||
let chunk = format!("c{n}");
|
||||
mem.save(entry(&chunk, &format!("tag{}", model.len())))
|
||||
.unwrap();
|
||||
model.push(chunk);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn image_after_every_operation_recovers_the_acknowledged_state() {
|
||||
for seed in 0..40u64 {
|
||||
let mut rng = Rng(seed);
|
||||
let dir = TempDir::new().unwrap();
|
||||
let images = TempDir::new().unwrap();
|
||||
let mut config = MemoryConfig::new(dir.path().join("store.h5"), "agent", 4);
|
||||
config.wal_enabled = true;
|
||||
config.wal_max_entries = 1 + rng.below(6); // force frequent checkpoints
|
||||
let h5 = config.path.clone();
|
||||
let mut mem = HDF5Memory::create(config).unwrap();
|
||||
let mut model = Vec::new();
|
||||
|
||||
for n in 0..30 {
|
||||
step(&mut mem, &mut model, &mut rng, n);
|
||||
let img = image(&h5, &images, &format!("s{seed}-{n}"));
|
||||
assert_eq!(recovered(&img), model, "seed {seed}, after op {n}");
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn crash_inside_the_checkpoint_window_never_duplicates() {
|
||||
for seed in 0..40u64 {
|
||||
let mut rng = Rng(seed ^ 0xABCD);
|
||||
let dir = TempDir::new().unwrap();
|
||||
let images = TempDir::new().unwrap();
|
||||
let mut config = MemoryConfig::new(dir.path().join("store.h5"), "agent", 4);
|
||||
config.wal_enabled = true;
|
||||
config.wal_max_entries = 1000; // checkpoints only when we ask
|
||||
let h5 = config.path.clone();
|
||||
let mut mem = HDF5Memory::create(config).unwrap();
|
||||
let mut model = Vec::new();
|
||||
|
||||
for round in 0..4 {
|
||||
for n in 0..(1 + rng.below(6)) {
|
||||
step(&mut mem, &mut model, &mut rng, round * 100 + n);
|
||||
}
|
||||
// The WAL as it is just before the checkpoint...
|
||||
let stale_wal = images.path().join(format!("stale-{seed}-{round}.wal"));
|
||||
if wal_path(&h5).exists() {
|
||||
std::fs::copy(wal_path(&h5), &stale_wal).unwrap();
|
||||
}
|
||||
mem.flush_wal().unwrap();
|
||||
// ...put back next to the NEW .h5: the crash-in-the-window image.
|
||||
let img = image(&h5, &images, &format!("w{seed}-{round}"));
|
||||
if stale_wal.exists() {
|
||||
std::fs::copy(&stale_wal, wal_path(&img)).unwrap();
|
||||
}
|
||||
assert_eq!(recovered(&img), model, "seed {seed}, round {round}");
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn torn_wal_recovers_checkpoint_plus_a_prefix() {
|
||||
let dir = TempDir::new().unwrap();
|
||||
let images = TempDir::new().unwrap();
|
||||
let mut config = MemoryConfig::new(dir.path().join("store.h5"), "agent", 4);
|
||||
config.wal_enabled = true;
|
||||
config.wal_max_entries = 1000;
|
||||
let h5 = config.path.clone();
|
||||
let mut mem = HDF5Memory::create(config).unwrap();
|
||||
|
||||
for name in ["a", "b"] {
|
||||
mem.save(entry(name, name)).unwrap();
|
||||
}
|
||||
mem.flush_wal().unwrap();
|
||||
let checkpointed = vec!["a".to_string(), "b".to_string()];
|
||||
|
||||
// States the store passes through as each later op is logged.
|
||||
let mut states = vec![checkpointed.clone()];
|
||||
let mut model = checkpointed.clone();
|
||||
mem.save(entry("c", "c")).unwrap();
|
||||
model.push("c".into());
|
||||
states.push(model.clone());
|
||||
mem.save_or_update(entry("a2", "a")).unwrap();
|
||||
model[0] = "a2".into();
|
||||
states.push(model.clone());
|
||||
mem.save(entry("d", "d")).unwrap();
|
||||
model.push("d".into());
|
||||
states.push(model.clone());
|
||||
|
||||
let full_wal = std::fs::read(wal_path(&h5)).unwrap();
|
||||
let mut seen = std::collections::BTreeSet::new();
|
||||
for len in 0..=full_wal.len() {
|
||||
let img = image(&h5, &images, &format!("t{len}"));
|
||||
std::fs::write(wal_path(&img), &full_wal[..len]).unwrap();
|
||||
let got = recovered(&img);
|
||||
let which = states
|
||||
.iter()
|
||||
.position(|s| *s == got)
|
||||
.unwrap_or_else(|| panic!("WAL torn at {len} bytes recovered {got:?}"));
|
||||
seen.insert(which);
|
||||
}
|
||||
// Every intermediate state is reachable, and the full WAL gives the last.
|
||||
assert_eq!(seen.into_iter().collect::<Vec<_>>(), [0, 1, 2, 3]);
|
||||
}
|
||||
@@ -196,7 +196,7 @@ fn test_migration_round_trip() {
|
||||
mem.add_relation(e1, e2, "discusses", 0.8).unwrap();
|
||||
|
||||
// Verify all data transferred by reopening
|
||||
let reopened = HDF5Memory::open(&path).unwrap();
|
||||
let reopened = HDF5Memory::open_read_only(&path).unwrap();
|
||||
assert_eq!(reopened.count(), 500);
|
||||
|
||||
// Verify sessions
|
||||
@@ -266,7 +266,7 @@ fn test_knowledge_graph_workflow() {
|
||||
assert_eq!(entity.entity_type, "library");
|
||||
|
||||
// Persistence
|
||||
let reopened = HDF5Memory::open(&path).unwrap();
|
||||
let reopened = HDF5Memory::open_read_only(&path).unwrap();
|
||||
assert_eq!(reopened.knowledge().entities.len(), 4);
|
||||
assert_eq!(reopened.knowledge().relations.len(), 4);
|
||||
|
||||
@@ -316,7 +316,7 @@ fn test_multi_session_workflow() {
|
||||
assert_eq!(mem.count(), 100); // 5 sessions * 20 entries
|
||||
|
||||
// Reopen and verify sessions
|
||||
let reopened = HDF5Memory::open(&path).unwrap();
|
||||
let reopened = HDF5Memory::open_read_only(&path).unwrap();
|
||||
for sess in 0..5 {
|
||||
let summary = reopened
|
||||
.get_session_summary(&format!("sess_{sess}"))
|
||||
@@ -460,7 +460,7 @@ fn test_snapshot_and_continue() {
|
||||
assert_eq!(snap_mem.count(), 50);
|
||||
|
||||
// Original should have 100
|
||||
let orig_mem = HDF5Memory::open(&path).unwrap();
|
||||
let orig_mem = HDF5Memory::open_read_only(&path).unwrap();
|
||||
assert_eq!(orig_mem.count(), 100);
|
||||
}
|
||||
|
||||
@@ -483,7 +483,7 @@ fn test_config_persistence_across_ops() {
|
||||
mem.add_session("s1", 0, 0, "ch", "summary").unwrap();
|
||||
mem.add_entity("Entity", "type", -1).unwrap();
|
||||
|
||||
let reopened = HDF5Memory::open(&path).unwrap();
|
||||
let reopened = HDF5Memory::open_read_only(&path).unwrap();
|
||||
assert_eq!(reopened.config().embedding_dim, 128);
|
||||
assert_eq!(reopened.config().embedder, "custom:my-embedder-v2");
|
||||
assert_eq!(reopened.config().chunk_size, 2048);
|
||||
@@ -695,7 +695,7 @@ fn test_large_text_chunks() {
|
||||
mem.save_batch(entries).unwrap();
|
||||
|
||||
// Reopen and verify
|
||||
let reopened = HDF5Memory::open(&path).unwrap();
|
||||
let reopened = HDF5Memory::open_read_only(&path).unwrap();
|
||||
assert_eq!(reopened.count(), 10);
|
||||
|
||||
let (_, cache, _, _) = read_cache(&path);
|
||||
@@ -752,7 +752,7 @@ fn test_interleaved_sessions_entries() {
|
||||
mem.flush_wal().unwrap();
|
||||
|
||||
// Verify
|
||||
let reopened = HDF5Memory::open(&path).unwrap();
|
||||
let reopened = HDF5Memory::open_read_only(&path).unwrap();
|
||||
assert_eq!(reopened.count(), 6);
|
||||
assert_eq!(
|
||||
reopened.get_session_summary("s1").unwrap().as_deref(),
|
||||
@@ -806,7 +806,7 @@ fn test_knowledge_graph_with_embeddings() {
|
||||
mem.add_relation(e_python, e_hdf5, "reads", 0.9).unwrap();
|
||||
|
||||
// Verify entity-embedding linkage persists
|
||||
let reopened = HDF5Memory::open(&path).unwrap();
|
||||
let reopened = HDF5Memory::open_read_only(&path).unwrap();
|
||||
let rust_entity = reopened.knowledge().get_entity(e_rust).unwrap();
|
||||
assert_eq!(rust_entity.embedding_idx, idx0 as i64);
|
||||
|
||||
@@ -1048,7 +1048,7 @@ fn test_gpu_l2_fallback_works() {
|
||||
let tombstones = vec![0u8; 3];
|
||||
|
||||
let gpu = clawhdf5_agent::gpu_search::GpuSearchBackend::try_init(&vectors, &norms, 2, 1);
|
||||
let results = gpu.search_l2(&vec![0.0, 0.0], &vectors, &tombstones, 3);
|
||||
let results = gpu.search_l2(&[0.0, 0.0], &vectors, &tombstones, 3);
|
||||
|
||||
assert_eq!(results.len(), 3);
|
||||
assert_eq!(results[0].0, 0);
|
||||
@@ -1099,7 +1099,7 @@ fn test_mmap_reader_direct_access() {
|
||||
|
||||
// Open via MmapReader directly
|
||||
let mmap = clawhdf5_io::MmapReader::open(&path).unwrap();
|
||||
assert!(mmap.len() > 0);
|
||||
assert!(!mmap.is_empty());
|
||||
// Verify we can read bytes at specific offsets
|
||||
let bytes = mmap.read_at(0, 8);
|
||||
assert!(bytes.is_some());
|
||||
@@ -1144,9 +1144,11 @@ fn test_strategy_reports_backend() {
|
||||
let tombstones = vec![0u8; n];
|
||||
let query = vectors[0].clone();
|
||||
|
||||
let flat: Vec<f32> = vectors.iter().flatten().copied().collect();
|
||||
let (_, metrics) = strategy::search_with_metrics(
|
||||
&query,
|
||||
&vectors,
|
||||
&flat,
|
||||
&norms,
|
||||
&tombstones,
|
||||
5,
|
||||
|
||||
@@ -80,8 +80,7 @@ fn hnsw_matches_bruteforce_oracle() {
|
||||
oracle.sort_by(|a, b| b.1.partial_cmp(&a.1).unwrap());
|
||||
let oracle_ids: std::collections::HashSet<usize> =
|
||||
oracle.iter().take(k).map(|(i, _)| *i).collect();
|
||||
let hnsw_ids: std::collections::HashSet<usize> =
|
||||
results.iter().map(|r| r.index).collect();
|
||||
let hnsw_ids: std::collections::HashSet<usize> = results.iter().map(|r| r.index).collect();
|
||||
|
||||
let overlap = oracle_ids.intersection(&hnsw_ids).count();
|
||||
assert!(
|
||||
@@ -127,17 +126,19 @@ fn incremental_inserts_after_search_are_found() {
|
||||
// First batch, then a search to force the index to build.
|
||||
for i in 0..40 {
|
||||
let v = make_vector(&mut seed, dim);
|
||||
mem.save(entry(&format!("a{i}"), v, &format!("a{i}"))).unwrap();
|
||||
mem.save(entry(&format!("a{i}"), v, &format!("a{i}")))
|
||||
.unwrap();
|
||||
}
|
||||
let _ = mem.hybrid_search(&make_vector(&mut seed, dim), "", 1.0, 0.0, 5);
|
||||
|
||||
// Now insert a distinctive vector incrementally and confirm we can find it.
|
||||
let needle = vec![10.0f32; dim];
|
||||
let idx = mem
|
||||
.save(entry("needle", needle.clone(), "needle"))
|
||||
.unwrap();
|
||||
let idx = mem.save(entry("needle", needle.clone(), "needle")).unwrap();
|
||||
let hits = mem.hybrid_search(&needle, "", 1.0, 0.0, 1);
|
||||
assert_eq!(hits[0].index, idx, "incrementally inserted vector must be found");
|
||||
assert_eq!(
|
||||
hits[0].index, idx,
|
||||
"incrementally inserted vector must be found"
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
@@ -158,6 +159,9 @@ fn save_batch_then_search_is_consistent() {
|
||||
// Exact-match queries should resolve to themselves after a batch insert.
|
||||
for probe in [0usize, 17, 49] {
|
||||
let hits = mem.hybrid_search(&vectors[probe], "", 1.0, 0.0, 1);
|
||||
assert_eq!(hits[0].index, probe, "batch-inserted vector {probe} not found");
|
||||
assert_eq!(
|
||||
hits[0].index, probe,
|
||||
"batch-inserted vector {probe} not found"
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -137,10 +137,10 @@ fn bench_hit_at_1_1014_records() {
|
||||
0.3,
|
||||
1,
|
||||
);
|
||||
if let Some((top_idx, _)) = results.first() {
|
||||
if *top_idx == target_indices[qi] {
|
||||
hits += 1;
|
||||
}
|
||||
if let Some((top_idx, _)) = results.first()
|
||||
&& *top_idx == target_indices[qi]
|
||||
{
|
||||
hits += 1;
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
@@ -105,7 +105,7 @@ fn test_heavy_tombstoning() {
|
||||
assert_eq!(mem.count_active(), 5000);
|
||||
|
||||
// Verify persistence
|
||||
let reopened = HDF5Memory::open(&path).unwrap();
|
||||
let reopened = HDF5Memory::open_read_only(&path).unwrap();
|
||||
assert_eq!(reopened.count(), 5000);
|
||||
}
|
||||
|
||||
@@ -163,7 +163,7 @@ fn test_large_embeddings_1536() {
|
||||
assert_eq!(mem.count(), 10_000);
|
||||
|
||||
// Verify persistence
|
||||
let reopened = HDF5Memory::open(&path).unwrap();
|
||||
let reopened = HDF5Memory::open_read_only(&path).unwrap();
|
||||
assert_eq!(reopened.count(), 10_000);
|
||||
|
||||
// Verify search works on large dims
|
||||
@@ -545,7 +545,7 @@ fn test_delete_all_entries() {
|
||||
assert_eq!(mem.count(), 0);
|
||||
|
||||
// Verify persistence
|
||||
let reopened = HDF5Memory::open(&path).unwrap();
|
||||
let reopened = HDF5Memory::open_read_only(&path).unwrap();
|
||||
assert_eq!(reopened.count(), 0);
|
||||
}
|
||||
|
||||
@@ -639,7 +639,7 @@ fn test_unicode_content() {
|
||||
];
|
||||
mem.save_batch(entries).unwrap();
|
||||
|
||||
let reopened = HDF5Memory::open(&path).unwrap();
|
||||
let reopened = HDF5Memory::open_read_only(&path).unwrap();
|
||||
assert_eq!(reopened.count(), 3);
|
||||
|
||||
let (_, cache, _, _) = clawhdf5_agent::storage::read_from_disk(&path).unwrap();
|
||||
@@ -685,6 +685,6 @@ fn test_rapid_save_delete_cycles() {
|
||||
assert_eq!(removed, 250);
|
||||
assert_eq!(mem.count(), 250);
|
||||
|
||||
let reopened = HDF5Memory::open(&path).unwrap();
|
||||
let reopened = HDF5Memory::open_read_only(&path).unwrap();
|
||||
assert_eq!(reopened.count(), 250);
|
||||
}
|
||||
|
||||
@@ -0,0 +1,213 @@
|
||||
//! Property tests for the write-ahead log.
|
||||
//!
|
||||
//! A deterministic generator (no external crates, reproducible from the seed
|
||||
//! printed on failure) drives thousands of cases through two properties:
|
||||
//!
|
||||
//! 1. **Round trip** — whatever was appended is read back, in order, intact.
|
||||
//! 2. **Prefix under corruption** — after *any* damage to the file (bit flips,
|
||||
//! truncation, inserted or deleted bytes, duplicated or reordered regions),
|
||||
//! reading never panics and yields an exact *prefix* of what was written.
|
||||
//! This is the guarantee the chained CRC exists to provide: replay may stop
|
||||
//! early, but it never returns a corrupted, reordered, or invented entry.
|
||||
|
||||
use clawhdf5_agent::wal::{WalEntry, WalEntryType, WalFile};
|
||||
|
||||
/// SplitMix64: tiny, well-distributed, and fully determined by its seed.
|
||||
struct Rng(u64);
|
||||
|
||||
impl Rng {
|
||||
fn next(&mut self) -> u64 {
|
||||
self.0 = self.0.wrapping_add(0x9E37_79B9_7F4A_7C15);
|
||||
let mut z = self.0;
|
||||
z = (z ^ (z >> 30)).wrapping_mul(0xBF58_476D_1CE4_E5B9);
|
||||
z = (z ^ (z >> 27)).wrapping_mul(0x94D0_49BB_1331_11EB);
|
||||
z ^ (z >> 31)
|
||||
}
|
||||
|
||||
fn below(&mut self, n: usize) -> usize {
|
||||
(self.next() % n.max(1) as u64) as usize
|
||||
}
|
||||
|
||||
fn string(&mut self, max_len: usize) -> String {
|
||||
const ALPHABET: &[char] = &['a', 'Z', '0', ' ', '\n', '\0', 'é', '漢', '🦀', '"'];
|
||||
(0..self.below(max_len + 1))
|
||||
.map(|_| ALPHABET[self.below(ALPHABET.len())])
|
||||
.collect()
|
||||
}
|
||||
}
|
||||
|
||||
/// What a test appended, in a form comparable with what is read back.
|
||||
#[derive(Debug, Clone, PartialEq)]
|
||||
enum Logged {
|
||||
Save(String, Vec<u32>, String, String, String, u64),
|
||||
Update(usize, String, Vec<u32>, u64),
|
||||
Tombstone(usize, u64),
|
||||
}
|
||||
|
||||
fn logged(entry: &WalEntry) -> Logged {
|
||||
// Compare floats by bit pattern so NaN payloads and -0.0 count as intact.
|
||||
let bits: Vec<u32> = entry.embedding.iter().map(|f| f.to_bits()).collect();
|
||||
let ts = entry.timestamp.to_bits();
|
||||
match entry.entry_type {
|
||||
WalEntryType::Save => Logged::Save(
|
||||
entry.chunk.clone(),
|
||||
bits,
|
||||
entry.source_channel.clone(),
|
||||
entry.session_id.clone(),
|
||||
entry.tags.clone(),
|
||||
ts,
|
||||
),
|
||||
WalEntryType::Update => {
|
||||
Logged::Update(entry.update_index.unwrap(), entry.chunk.clone(), bits, ts)
|
||||
}
|
||||
WalEntryType::Tombstone => Logged::Tombstone(entry.tombstone_index.unwrap(), ts),
|
||||
WalEntryType::ActivationUpdate => unreachable!("never written by these tests"),
|
||||
}
|
||||
}
|
||||
|
||||
/// Append a random mix of records; return what was written.
|
||||
fn write_random_wal(path: &std::path::Path, rng: &mut Rng) -> Vec<Logged> {
|
||||
let mut wal = WalFile::open(path).unwrap();
|
||||
let mut written = Vec::new();
|
||||
for _ in 0..rng.below(12) {
|
||||
let timestamp = f64::from_bits(rng.next());
|
||||
if rng.below(5) == 0 {
|
||||
let index = rng.below(1000);
|
||||
wal.append_tombstone(index, timestamp).unwrap();
|
||||
written.push(Logged::Tombstone(index, timestamp.to_bits()));
|
||||
continue;
|
||||
}
|
||||
let update_index = (rng.below(4) == 0).then(|| rng.below(1000));
|
||||
let entry = WalEntry {
|
||||
entry_type: if update_index.is_some() {
|
||||
WalEntryType::Update
|
||||
} else {
|
||||
WalEntryType::Save
|
||||
},
|
||||
timestamp,
|
||||
chunk: rng.string(40),
|
||||
embedding: (0..rng.below(9))
|
||||
.map(|_| f32::from_bits(rng.next() as u32))
|
||||
.collect(),
|
||||
source_channel: rng.string(8),
|
||||
session_id: rng.string(8),
|
||||
tags: rng.string(8),
|
||||
tombstone_index: None,
|
||||
update_index,
|
||||
};
|
||||
wal.append_save(&entry).unwrap();
|
||||
written.push(logged(&entry));
|
||||
}
|
||||
written
|
||||
}
|
||||
|
||||
fn read_back(path: &std::path::Path) -> Option<Vec<Logged>> {
|
||||
WalFile::read_entries(path)
|
||||
.ok()
|
||||
.map(|entries| entries.iter().map(logged).collect())
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn everything_appended_is_read_back_intact() {
|
||||
let dir = tempfile::TempDir::new().unwrap();
|
||||
for seed in 0..300u64 {
|
||||
let path = dir.path().join(format!("rt-{seed}.wal"));
|
||||
let written = write_random_wal(&path, &mut Rng(seed));
|
||||
assert_eq!(read_back(&path).unwrap(), written, "seed {seed}");
|
||||
// Reopening (which scans and repositions) must not disturb anything.
|
||||
drop(WalFile::open(&path).unwrap());
|
||||
assert_eq!(
|
||||
read_back(&path).unwrap(),
|
||||
written,
|
||||
"seed {seed} after reopen"
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
/// Damage `bytes` in one of several ways.
|
||||
fn corrupt(bytes: &mut Vec<u8>, rng: &mut Rng) {
|
||||
if bytes.is_empty() {
|
||||
return;
|
||||
}
|
||||
match rng.below(7) {
|
||||
0 => {
|
||||
let i = rng.below(bytes.len());
|
||||
bytes[i] ^= 1 << rng.below(8);
|
||||
}
|
||||
1 => bytes.truncate(rng.below(bytes.len())),
|
||||
2 => {
|
||||
let i = rng.below(bytes.len() + 1);
|
||||
bytes.insert(i, rng.next() as u8);
|
||||
}
|
||||
3 => {
|
||||
let i = rng.below(bytes.len());
|
||||
bytes.remove(i);
|
||||
}
|
||||
4 => {
|
||||
// Duplicate a region in place (a replayed/duplicated entry).
|
||||
let a = rng.below(bytes.len());
|
||||
let b = a + rng.below(bytes.len() - a);
|
||||
let region = bytes[a..b].to_vec();
|
||||
let at = rng.below(bytes.len() + 1);
|
||||
bytes.splice(at..at, region);
|
||||
}
|
||||
5 => {
|
||||
// Swap two regions (reordered entries).
|
||||
let mid = rng.below(bytes.len());
|
||||
bytes.rotate_left(mid);
|
||||
}
|
||||
_ => {
|
||||
let i = rng.below(bytes.len());
|
||||
let n = rng.below(bytes.len() - i + 1);
|
||||
for b in &mut bytes[i..i + n] {
|
||||
*b = rng.next() as u8;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn any_corruption_yields_a_prefix_never_a_wrong_entry() {
|
||||
let dir = tempfile::TempDir::new().unwrap();
|
||||
let mut shortened = 0u32;
|
||||
for seed in 0..1500u64 {
|
||||
let mut rng = Rng(seed ^ 0xC0FF_EE00);
|
||||
let path = dir.path().join("c.wal");
|
||||
let _ = std::fs::remove_file(&path);
|
||||
let written = write_random_wal(&path, &mut rng);
|
||||
|
||||
let mut bytes = std::fs::read(&path).unwrap();
|
||||
for _ in 0..=rng.below(3) {
|
||||
corrupt(&mut bytes, &mut rng);
|
||||
}
|
||||
std::fs::write(&path, &bytes).unwrap();
|
||||
|
||||
// An unreadable header is a clean error; anything else is a prefix.
|
||||
if let Some(read) = read_back(&path) {
|
||||
assert!(
|
||||
read.len() <= written.len() && read[..] == written[..read.len()],
|
||||
"seed {seed}: read {read:?}\nis not a prefix of {written:?}"
|
||||
);
|
||||
if read.len() < written.len() {
|
||||
shortened += 1;
|
||||
}
|
||||
// Opening for append repairs the tail; what was readable stays so,
|
||||
// and a new entry lands right after it.
|
||||
if let Ok(mut wal) = WalFile::open(&path) {
|
||||
wal.append_tombstone(7, 1.0).unwrap();
|
||||
drop(wal);
|
||||
let mut expected = read.clone();
|
||||
expected.push(Logged::Tombstone(7, 1.0f64.to_bits()));
|
||||
assert_eq!(
|
||||
read_back(&path).unwrap(),
|
||||
expected,
|
||||
"seed {seed} after repair"
|
||||
);
|
||||
}
|
||||
}
|
||||
}
|
||||
assert!(
|
||||
shortened > 100,
|
||||
"corruption rarely took effect: {shortened}"
|
||||
);
|
||||
}
|
||||
@@ -1,6 +1,6 @@
|
||||
[package]
|
||||
name = "clawhdf5-android"
|
||||
version = "2.1.0"
|
||||
version = "2.4.0"
|
||||
edition = "2024"
|
||||
description = "Android JNI bridge for edgehdf5-memory HDF5 backend"
|
||||
license = "MIT"
|
||||
@@ -10,3 +10,6 @@ crate-type = ["cdylib"]
|
||||
|
||||
[dependencies]
|
||||
clawhdf5-agent = { path = "../clawhdf5-agent", default-features = false }
|
||||
|
||||
[dev-dependencies]
|
||||
tempfile = { workspace = true }
|
||||
|
||||
@@ -92,11 +92,18 @@ pub unsafe extern "C" fn edgehdf5_close(handle: Handle) {
|
||||
|
||||
/// Save a memory entry. Returns the entry index, or -1 on failure.
|
||||
///
|
||||
/// `embedding_len` is validated against the handle's configured
|
||||
/// `embedding_dim` before the input slice is constructed; a mismatch fails
|
||||
/// the call with -1 rather than reading out of bounds. This is a length
|
||||
/// check only — it cannot detect a same-length buffer that is otherwise
|
||||
/// too short or invalid.
|
||||
///
|
||||
/// # Safety
|
||||
///
|
||||
/// - `handle` must be a valid, non-null handle.
|
||||
/// - All `*const c_char` arguments must be valid, null-terminated C strings.
|
||||
/// - `embedding_ptr` must point to at least `embedding_len` contiguous `f32` values.
|
||||
/// - If `embedding_len` matches the handle's `embedding_dim`, `embedding_ptr`
|
||||
/// must point to at least that many contiguous, valid `f32` values.
|
||||
#[unsafe(no_mangle)]
|
||||
pub unsafe extern "C" fn edgehdf5_save(
|
||||
handle: Handle,
|
||||
@@ -135,8 +142,14 @@ pub unsafe extern "C" fn edgehdf5_save(
|
||||
None => return -1,
|
||||
};
|
||||
|
||||
if embedding_ptr.is_null() || embedding_len as usize != mem.config().embedding_dim {
|
||||
return -1;
|
||||
}
|
||||
let embedding =
|
||||
// SAFETY: JNI caller guarantees embedding_ptr points to embedding_len valid f32 values.
|
||||
// SAFETY: embedding_ptr is non-null and embedding_len matches the handle's configured
|
||||
// embedding_dim (checked above); JNI caller guarantees it points to that many valid f32
|
||||
// values. A mismatched-but-equal-length short buffer is not caught by this length check
|
||||
// alone — the caller is still responsible for pointer validity.
|
||||
unsafe { std::slice::from_raw_parts(embedding_ptr, embedding_len as usize) }.to_vec();
|
||||
|
||||
let entry = MemoryEntry {
|
||||
@@ -210,11 +223,18 @@ pub unsafe extern "C" fn edgehdf5_delete(handle: Handle, index: u64) -> i32 {
|
||||
/// Performs hybrid search and writes up to `max_results` entries into the
|
||||
/// provided output arrays. Returns the number of results written.
|
||||
///
|
||||
/// `query_embedding_len` is validated against the handle's configured
|
||||
/// `embedding_dim` before the input slice is constructed; a mismatch fails
|
||||
/// the call (returns 0) rather than reading out of bounds. This is a length
|
||||
/// check only — it cannot detect a same-length buffer that is otherwise too
|
||||
/// short or invalid.
|
||||
///
|
||||
/// # Safety
|
||||
///
|
||||
/// - `handle` must be a valid, non-null handle.
|
||||
/// - `query_text` must be a valid, null-terminated C string.
|
||||
/// - `query_embedding_ptr` must point to at least `query_embedding_len` `f32` values.
|
||||
/// - If `query_embedding_len` matches the handle's `embedding_dim`,
|
||||
/// `query_embedding_ptr` must point to at least that many valid `f32` values.
|
||||
/// - `out_indices` and `out_scores` must point to arrays of at least `max_results` elements.
|
||||
/// - `out_chunks` must be null or point to an array of at least `max_results` pointers.
|
||||
#[unsafe(no_mangle)]
|
||||
@@ -240,8 +260,14 @@ pub unsafe extern "C" fn edgehdf5_hybrid_search(
|
||||
Some(s) => s,
|
||||
None => return 0,
|
||||
};
|
||||
if query_embedding_ptr.is_null() || query_embedding_len as usize != mem.config().embedding_dim {
|
||||
return 0;
|
||||
}
|
||||
let query_embedding =
|
||||
// SAFETY: JNI caller guarantees query_embedding_ptr points to query_embedding_len valid f32 values.
|
||||
// SAFETY: query_embedding_ptr is non-null and query_embedding_len matches the handle's
|
||||
// configured embedding_dim (checked above); JNI caller guarantees it points to that many
|
||||
// valid f32 values. A mismatched-but-equal-length short buffer is not caught by this
|
||||
// length check alone — the caller is still responsible for pointer validity.
|
||||
unsafe { std::slice::from_raw_parts(query_embedding_ptr, query_embedding_len as usize) };
|
||||
|
||||
let results = mem.hybrid_search(
|
||||
@@ -456,3 +482,112 @@ unsafe fn cstr_to_string(ptr: *const c_char) -> Option<String> {
|
||||
.ok()
|
||||
.map(String::from)
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
|
||||
const EMBEDDING_DIM: u32 = 4;
|
||||
|
||||
fn open_handle(dir: &tempfile::TempDir) -> Handle {
|
||||
let path = CString::new(dir.path().join("mem.h5").to_str().unwrap()).unwrap();
|
||||
let agent_id = CString::new("test-agent").unwrap();
|
||||
// SAFETY: both C strings are valid and null-terminated.
|
||||
unsafe { edgehdf5_create(path.as_ptr(), agent_id.as_ptr(), EMBEDDING_DIM) }
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn save_rejects_mismatched_embedding_len() {
|
||||
let dir = tempfile::tempdir().unwrap();
|
||||
let handle = open_handle(&dir);
|
||||
assert!(!handle.is_null());
|
||||
|
||||
let embedding = [1.0f32, 2.0, 3.0]; // len 3, dim is 4
|
||||
let chunk = CString::new("hello").unwrap();
|
||||
let channel = CString::new("test").unwrap();
|
||||
let session = CString::new("s1").unwrap();
|
||||
let tags = CString::new("").unwrap();
|
||||
|
||||
// SAFETY: handle is valid; all C strings are valid; embedding_len (3) intentionally
|
||||
// does not match embedding_dim (4), which edgehdf5_save must reject before touching
|
||||
// embedding_ptr.
|
||||
let result = unsafe {
|
||||
edgehdf5_save(
|
||||
handle,
|
||||
chunk.as_ptr(),
|
||||
embedding.as_ptr(),
|
||||
embedding.len() as u32,
|
||||
channel.as_ptr(),
|
||||
0.0,
|
||||
session.as_ptr(),
|
||||
tags.as_ptr(),
|
||||
)
|
||||
};
|
||||
assert_eq!(result, -1, "mismatched embedding_len must be rejected");
|
||||
|
||||
unsafe { edgehdf5_close(handle) };
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn save_rejects_null_embedding_ptr() {
|
||||
let dir = tempfile::tempdir().unwrap();
|
||||
let handle = open_handle(&dir);
|
||||
assert!(!handle.is_null());
|
||||
|
||||
let chunk = CString::new("hello").unwrap();
|
||||
let channel = CString::new("test").unwrap();
|
||||
let session = CString::new("s1").unwrap();
|
||||
let tags = CString::new("").unwrap();
|
||||
|
||||
// SAFETY: handle and C strings are valid; embedding_ptr is intentionally null, which
|
||||
// edgehdf5_save must reject before constructing a slice from it.
|
||||
let result = unsafe {
|
||||
edgehdf5_save(
|
||||
handle,
|
||||
chunk.as_ptr(),
|
||||
ptr::null(),
|
||||
EMBEDDING_DIM,
|
||||
channel.as_ptr(),
|
||||
0.0,
|
||||
session.as_ptr(),
|
||||
tags.as_ptr(),
|
||||
)
|
||||
};
|
||||
assert_eq!(result, -1, "null embedding_ptr must be rejected");
|
||||
|
||||
unsafe { edgehdf5_close(handle) };
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn hybrid_search_rejects_mismatched_embedding_len() {
|
||||
let dir = tempfile::tempdir().unwrap();
|
||||
let handle = open_handle(&dir);
|
||||
assert!(!handle.is_null());
|
||||
|
||||
let query_embedding = [1.0f32, 2.0]; // len 2, dim is 4
|
||||
let query_text = CString::new("hello").unwrap();
|
||||
let mut out_indices = [0u64; 4];
|
||||
let mut out_scores = [0.0f32; 4];
|
||||
|
||||
// SAFETY: handle and query_text are valid; query_embedding_len (2) intentionally does
|
||||
// not match embedding_dim (4), which edgehdf5_hybrid_search must reject before touching
|
||||
// query_embedding_ptr. Output buffers are sized to max_results.
|
||||
let count = unsafe {
|
||||
edgehdf5_hybrid_search(
|
||||
handle,
|
||||
query_embedding.as_ptr(),
|
||||
query_embedding.len() as u32,
|
||||
query_text.as_ptr(),
|
||||
0.7,
|
||||
0.3,
|
||||
4,
|
||||
out_indices.as_mut_ptr(),
|
||||
out_scores.as_mut_ptr(),
|
||||
ptr::null_mut(),
|
||||
)
|
||||
};
|
||||
assert_eq!(count, 0, "mismatched query_embedding_len must be rejected");
|
||||
|
||||
unsafe { edgehdf5_close(handle) };
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,14 +1,19 @@
|
||||
[package]
|
||||
name = "clawhdf5-ann"
|
||||
version = "2.1.0"
|
||||
version = "2.4.0"
|
||||
edition = "2024"
|
||||
description = "HNSW approximate nearest neighbor index stored as HDF5"
|
||||
license = "MIT"
|
||||
repository = "https://github.com/redclawsystems/clawhdf5"
|
||||
repository = "https://git.redclaw.dev/quantumclaw/clawhdf5"
|
||||
readme = "README.md"
|
||||
keywords = ["hdf5", "ann", "hnsw", "nearest-neighbor"]
|
||||
categories = ["algorithms", "science"]
|
||||
|
||||
[dependencies]
|
||||
clawhdf5-format = { path = "../clawhdf5-format", version = "2.1.0" }
|
||||
clawhdf5-io = { path = "../clawhdf5-io", version = "2.1.0" }
|
||||
clawhdf5-format = { path = "../clawhdf5-format", version = "2.4.0" }
|
||||
clawhdf5-io = { path = "../clawhdf5-io", version = "2.4.0" }
|
||||
clawhdf5-accel = { path = "../clawhdf5-accel", version = "2.4.0" }
|
||||
rayon = { version = "1", optional = true }
|
||||
|
||||
[features]
|
||||
parallel = ["rayon"]
|
||||
|
||||
+495
-45
@@ -1,6 +1,6 @@
|
||||
//! HNSW index implementation with HDF5 serialization.
|
||||
|
||||
use std::collections::{BinaryHeap, HashSet};
|
||||
use std::collections::BinaryHeap;
|
||||
|
||||
use clawhdf5_format::attribute::extract_attributes_full;
|
||||
use clawhdf5_format::data_layout::DataLayout;
|
||||
@@ -16,7 +16,6 @@ use clawhdf5_format::object_header::ObjectHeader;
|
||||
use clawhdf5_format::signature::find_signature;
|
||||
use clawhdf5_format::superblock::Superblock;
|
||||
use clawhdf5_io::FileWriter as IoFileWriter;
|
||||
use clawhdf5_io::HDF5ReadWrite;
|
||||
|
||||
/// Distance metric for the HNSW index.
|
||||
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
|
||||
@@ -45,33 +44,35 @@ impl DistanceMetric {
|
||||
}
|
||||
|
||||
/// Compute distance between two vectors using the given metric.
|
||||
///
|
||||
/// Delegates to `clawhdf5-accel`'s runtime-dispatched SIMD kernels (AVX2 on
|
||||
/// x86_64, NEON on aarch64, portable scalar fallback elsewhere) — this is
|
||||
/// the hottest loop in both HNSW build and every `hybrid_search` query.
|
||||
fn compute_distance(a: &[f32], b: &[f32], metric: DistanceMetric) -> f32 {
|
||||
match metric {
|
||||
DistanceMetric::L2 => {
|
||||
let mut sum = 0.0f32;
|
||||
for i in 0..a.len() {
|
||||
let d = a[i] - b[i];
|
||||
sum += d * d;
|
||||
}
|
||||
sum.sqrt()
|
||||
}
|
||||
DistanceMetric::Cosine => {
|
||||
let mut dot = 0.0f32;
|
||||
let mut norm_a = 0.0f32;
|
||||
let mut norm_b = 0.0f32;
|
||||
for i in 0..a.len() {
|
||||
dot += a[i] * b[i];
|
||||
norm_a += a[i] * a[i];
|
||||
norm_b += b[i] * b[i];
|
||||
}
|
||||
let denom = norm_a.sqrt() * norm_b.sqrt();
|
||||
if denom < f32::EPSILON {
|
||||
1.0
|
||||
} else {
|
||||
1.0 - (dot / denom)
|
||||
}
|
||||
DistanceMetric::L2 => clawhdf5_accel::l2_distance(a, b),
|
||||
// Both sides are unit length (see `prepare`), so cosine similarity is
|
||||
// the plain dot product. Computing it as dot / (|a| * |b|) re-derived
|
||||
// both norms on every call — three reductions instead of one, in the
|
||||
// innermost loop of both build and search.
|
||||
DistanceMetric::Cosine => 1.0 - clawhdf5_accel::dot_product(a, b),
|
||||
}
|
||||
}
|
||||
|
||||
/// Put a vector in the form the index stores and compares: unit length for the
|
||||
/// cosine metric, unchanged for L2. A zero vector stays zero, giving distance 1
|
||||
/// to everything — what the cosine kernel reports for a degenerate input.
|
||||
fn prepare(mut v: Vec<f32>, metric: DistanceMetric) -> Vec<f32> {
|
||||
if metric == DistanceMetric::Cosine {
|
||||
let norm = clawhdf5_accel::vector_norm(&v);
|
||||
if norm > f32::EPSILON {
|
||||
let inv = 1.0 / norm;
|
||||
v.iter_mut().for_each(|x| *x *= inv);
|
||||
} else {
|
||||
v.iter_mut().for_each(|x| *x = 0.0);
|
||||
}
|
||||
}
|
||||
v
|
||||
}
|
||||
|
||||
/// Assign a random level to a new node based on the HNSW probability distribution.
|
||||
@@ -153,6 +154,9 @@ impl Ord for FarCandidate {
|
||||
}
|
||||
}
|
||||
|
||||
/// Magic for [`HnswIndex::graph_to_bytes`].
|
||||
const GRAPH_MAGIC: &[u8; 4] = b"CHG1";
|
||||
|
||||
/// On-disk format version for the serialized HNSW index.
|
||||
///
|
||||
/// - Version 1: original layout (`vectors`, `graph_layer_*`, `config`), no
|
||||
@@ -220,6 +224,8 @@ impl HnswIndex {
|
||||
|
||||
let m_max0 = m * 2;
|
||||
let n = vectors.len();
|
||||
let prepared: Vec<Vec<f32>> = vectors.iter().map(|v| prepare(v.clone(), metric)).collect();
|
||||
let vectors: &[Vec<f32>] = &prepared;
|
||||
|
||||
// Assign levels to all nodes
|
||||
let mut node_levels = Vec::with_capacity(n);
|
||||
@@ -271,8 +277,9 @@ impl HnswIndex {
|
||||
metric,
|
||||
);
|
||||
|
||||
// Select up to m closest neighbors
|
||||
let selected: Vec<usize> = neighbors.iter().take(max_conn).map(|c| c.id).collect();
|
||||
let scored: Vec<(usize, f32)> =
|
||||
neighbors.iter().map(|c| (c.id, c.distance)).collect();
|
||||
let selected = select_neighbors(vectors, &scored, max_conn, metric);
|
||||
|
||||
// Add bidirectional connections
|
||||
graph[layer][i] = selected.clone();
|
||||
@@ -303,7 +310,7 @@ impl HnswIndex {
|
||||
}
|
||||
|
||||
Self {
|
||||
vectors: vectors.to_vec(),
|
||||
vectors: prepared,
|
||||
graph,
|
||||
deleted: vec![false; n],
|
||||
entry_point,
|
||||
@@ -342,6 +349,7 @@ impl HnswIndex {
|
||||
/// # Panics
|
||||
/// Panics if `vector`'s dimension does not match the existing vectors.
|
||||
pub fn insert(&mut self, vector: Vec<f32>) -> usize {
|
||||
let vector = prepare(vector, self.metric);
|
||||
let id = self.vectors.len();
|
||||
|
||||
// Seed an empty index.
|
||||
@@ -380,7 +388,13 @@ impl HnswIndex {
|
||||
|
||||
// Phase 1: greedy descent from the top down to node_level + 1.
|
||||
for layer in (node_level + 1..=ep_level).rev() {
|
||||
ep = greedy_closest(&self.vectors, &self.graph[layer], &self.vectors[id], ep, self.metric);
|
||||
ep = greedy_closest(
|
||||
&self.vectors,
|
||||
&self.graph[layer],
|
||||
&self.vectors[id],
|
||||
ep,
|
||||
self.metric,
|
||||
);
|
||||
}
|
||||
|
||||
// Phase 2: search and connect from min(node_level, ep_level) down to 0.
|
||||
@@ -395,7 +409,8 @@ impl HnswIndex {
|
||||
self.ef_construction,
|
||||
self.metric,
|
||||
);
|
||||
let selected: Vec<usize> = neighbors.iter().take(max_conn).map(|c| c.id).collect();
|
||||
let scored: Vec<(usize, f32)> = neighbors.iter().map(|c| (c.id, c.distance)).collect();
|
||||
let selected = select_neighbors(&self.vectors, &scored, max_conn, self.metric);
|
||||
self.graph[layer][id] = selected.clone();
|
||||
for &neighbor in &selected {
|
||||
self.graph[layer][neighbor].push(id);
|
||||
@@ -491,6 +506,8 @@ impl HnswIndex {
|
||||
"query dimension mismatch"
|
||||
);
|
||||
let ef = ef.max(k);
|
||||
let prepared_query = prepare(query.to_vec(), self.metric);
|
||||
let query = prepared_query.as_slice();
|
||||
|
||||
let mut ep = self.entry_point;
|
||||
let top_layer = self.graph.len().saturating_sub(1);
|
||||
@@ -516,7 +533,7 @@ impl HnswIndex {
|
||||
pub fn save_to_hdf5(&self, writer: &mut IoFileWriter) -> Result<(), FormatError> {
|
||||
let bytes = self.to_hdf5_bytes()?;
|
||||
writer
|
||||
.write_all_bytes(&bytes)
|
||||
.write_bytes_owned(bytes)
|
||||
.map_err(|e| FormatError::SerializationError(e.to_string()))?;
|
||||
Ok(())
|
||||
}
|
||||
@@ -641,7 +658,9 @@ impl HnswIndex {
|
||||
actual: flat_vectors.len(),
|
||||
});
|
||||
}
|
||||
vectors.push(flat_vectors[start..end].to_vec());
|
||||
// Files written before vectors were stored unit-length hold the
|
||||
// raw ones; preparing is idempotent, so this handles both.
|
||||
vectors.push(prepare(flat_vectors[start..end].to_vec(), metric));
|
||||
}
|
||||
|
||||
// Read graph layers
|
||||
@@ -701,6 +720,160 @@ impl HnswIndex {
|
||||
})
|
||||
}
|
||||
|
||||
/// Serialize the **graph only** — levels, tombstones and adjacency, not the
|
||||
/// vectors — for a caller that already stores the vectors elsewhere (the
|
||||
/// agent's record cache). [`HnswIndex::to_hdf5_bytes`] writes a complete,
|
||||
/// self-contained index including a full copy of every vector, which would
|
||||
/// double such a store's size. Reattach with
|
||||
/// [`HnswIndex::from_graph_bytes`].
|
||||
///
|
||||
/// Layout (little endian): magic `CHG1`, then u32 fields `n`, `m`,
|
||||
/// `m_max0`, `ef_construction`, `entry_point`, `num_layers`, `metric`;
|
||||
/// `n` level bytes; `n` tombstone bytes; per layer, per node that exists on
|
||||
/// that layer: u32 neighbour count + u32 ids; trailing CRC32 of all of it.
|
||||
pub fn graph_to_bytes(&self) -> Vec<u8> {
|
||||
let n = self.vectors.len();
|
||||
let mut out = Vec::with_capacity(32 + n * 2 + n * self.m_max0 * 4);
|
||||
out.extend_from_slice(GRAPH_MAGIC);
|
||||
for field in [
|
||||
n,
|
||||
self.m,
|
||||
self.m_max0,
|
||||
self.ef_construction,
|
||||
self.entry_point,
|
||||
self.graph.len(),
|
||||
match self.metric {
|
||||
DistanceMetric::L2 => 0,
|
||||
DistanceMetric::Cosine => 1,
|
||||
},
|
||||
] {
|
||||
out.extend_from_slice(&(field as u32).to_le_bytes());
|
||||
}
|
||||
out.extend(self.node_levels.iter().map(|&l| l.min(255) as u8));
|
||||
out.extend(self.deleted.iter().map(|&d| u8::from(d)));
|
||||
for (layer, adjacency) in self.graph.iter().enumerate() {
|
||||
for (node, neighbors) in adjacency.iter().enumerate() {
|
||||
if self.node_levels[node] < layer {
|
||||
continue; // node does not exist on this layer
|
||||
}
|
||||
out.extend_from_slice(&(neighbors.len() as u32).to_le_bytes());
|
||||
for &id in neighbors {
|
||||
out.extend_from_slice(&(id as u32).to_le_bytes());
|
||||
}
|
||||
}
|
||||
}
|
||||
let crc = clawhdf5_format::checksum::crc32(&out);
|
||||
out.extend_from_slice(&crc.to_le_bytes());
|
||||
out
|
||||
}
|
||||
|
||||
/// Rebuild an index from [`HnswIndex::graph_to_bytes`] output and the
|
||||
/// vectors it was built over (same order). Every structural claim in
|
||||
/// `bytes` is validated — a corrupt or mismatched graph is an error, never
|
||||
/// an index that panics or walks out of bounds during a search.
|
||||
pub fn from_graph_bytes(bytes: &[u8], vectors: Vec<Vec<f32>>) -> Result<Self, FormatError> {
|
||||
let bad = |what: &str| FormatError::SerializationError(format!("HNSW graph: {what}"));
|
||||
let body_len = bytes
|
||||
.len()
|
||||
.checked_sub(4)
|
||||
.filter(|&l| l >= GRAPH_MAGIC.len() + 7 * 4)
|
||||
.ok_or_else(|| bad("truncated"))?;
|
||||
let (body, crc_bytes) = bytes.split_at(body_len);
|
||||
if &body[..4] != GRAPH_MAGIC {
|
||||
return Err(bad("bad magic"));
|
||||
}
|
||||
let stored_crc =
|
||||
u32::from_le_bytes([crc_bytes[0], crc_bytes[1], crc_bytes[2], crc_bytes[3]]);
|
||||
if clawhdf5_format::checksum::crc32(body) != stored_crc {
|
||||
return Err(bad("checksum mismatch"));
|
||||
}
|
||||
|
||||
let mut pos = 4;
|
||||
let next_u32 = |pos: &mut usize| -> Result<usize, FormatError> {
|
||||
let b = body.get(*pos..*pos + 4).ok_or_else(|| bad("truncated"))?;
|
||||
*pos += 4;
|
||||
Ok(u32::from_le_bytes([b[0], b[1], b[2], b[3]]) as usize)
|
||||
};
|
||||
let n = next_u32(&mut pos)?;
|
||||
let m = next_u32(&mut pos)?;
|
||||
let m_max0 = next_u32(&mut pos)?;
|
||||
let ef_construction = next_u32(&mut pos)?;
|
||||
let entry_point = next_u32(&mut pos)?;
|
||||
let num_layers = next_u32(&mut pos)?;
|
||||
let metric = match next_u32(&mut pos)? {
|
||||
0 => DistanceMetric::L2,
|
||||
1 => DistanceMetric::Cosine,
|
||||
_ => return Err(bad("unknown metric")),
|
||||
};
|
||||
if n != vectors.len() {
|
||||
return Err(bad("vector count does not match the graph"));
|
||||
}
|
||||
if n == 0 || entry_point >= n || m < 2 || num_layers == 0 || num_layers > 256 {
|
||||
return Err(bad("invalid header"));
|
||||
}
|
||||
let dim = vectors[0].len();
|
||||
if vectors.iter().any(|v| v.len() != dim) {
|
||||
return Err(bad("vectors have mixed dimensions"));
|
||||
}
|
||||
|
||||
let levels = body.get(pos..pos + n).ok_or_else(|| bad("truncated"))?;
|
||||
pos += n;
|
||||
let node_levels: Vec<usize> = levels.iter().map(|&l| l as usize).collect();
|
||||
if node_levels.iter().any(|&l| l >= num_layers)
|
||||
|| node_levels[entry_point] + 1 != num_layers
|
||||
{
|
||||
return Err(bad("levels inconsistent with layer count"));
|
||||
}
|
||||
let deleted: Vec<bool> = body
|
||||
.get(pos..pos + n)
|
||||
.ok_or_else(|| bad("truncated"))?
|
||||
.iter()
|
||||
.map(|&d| d != 0)
|
||||
.collect();
|
||||
pos += n;
|
||||
|
||||
let mut graph: Vec<Vec<Vec<usize>>> = Vec::with_capacity(num_layers);
|
||||
for layer in 0..num_layers {
|
||||
let max_conn = if layer == 0 { m_max0 } else { m };
|
||||
let mut adjacency = vec![Vec::new(); n];
|
||||
for (node, slot) in adjacency.iter_mut().enumerate() {
|
||||
if node_levels[node] < layer {
|
||||
continue;
|
||||
}
|
||||
let count = next_u32(&mut pos)?;
|
||||
if count > max_conn {
|
||||
return Err(bad("neighbour list exceeds the connection limit"));
|
||||
}
|
||||
let mut neighbors = Vec::with_capacity(count);
|
||||
for _ in 0..count {
|
||||
let id = next_u32(&mut pos)?;
|
||||
// A neighbour must exist, and exist on this layer.
|
||||
if id >= n || node_levels[id] < layer {
|
||||
return Err(bad("neighbour id out of range for its layer"));
|
||||
}
|
||||
neighbors.push(id);
|
||||
}
|
||||
*slot = neighbors;
|
||||
}
|
||||
graph.push(adjacency);
|
||||
}
|
||||
if pos != body.len() {
|
||||
return Err(bad("trailing bytes"));
|
||||
}
|
||||
|
||||
Ok(Self {
|
||||
vectors: vectors.into_iter().map(|v| prepare(v, metric)).collect(),
|
||||
graph,
|
||||
deleted,
|
||||
entry_point,
|
||||
m,
|
||||
m_max0,
|
||||
ef_construction,
|
||||
node_levels,
|
||||
metric,
|
||||
})
|
||||
}
|
||||
|
||||
/// Returns the number of vectors in the index.
|
||||
pub fn len(&self) -> usize {
|
||||
self.vectors.len()
|
||||
@@ -791,9 +964,62 @@ fn search_layer(
|
||||
distance: ep_dist,
|
||||
});
|
||||
|
||||
let mut visited = HashSet::new();
|
||||
visited.insert(ep);
|
||||
VISITED.with_borrow_mut(|visited| {
|
||||
visited.begin(vectors.len());
|
||||
visited.insert(ep);
|
||||
search_layer_visit(
|
||||
vectors, layer, query, ef, metric, visited, candidates, results,
|
||||
)
|
||||
})
|
||||
}
|
||||
|
||||
/// Which nodes a layer search has already seen. A `HashSet` allocated per call
|
||||
/// was the hottest non-arithmetic cost in both build and query; this is one
|
||||
/// `u32` stamp per node, reused across calls: a node is visited iff its stamp
|
||||
/// equals the current epoch, so "clearing" is just bumping the epoch.
|
||||
#[derive(Default)]
|
||||
struct Visited {
|
||||
stamps: Vec<u32>,
|
||||
epoch: u32,
|
||||
}
|
||||
|
||||
impl Visited {
|
||||
fn begin(&mut self, n: usize) {
|
||||
if self.stamps.len() < n {
|
||||
self.stamps.resize(n, 0);
|
||||
}
|
||||
self.epoch = self.epoch.wrapping_add(1);
|
||||
if self.epoch == 0 {
|
||||
// Wrapped: stale stamps could collide with the new epoch.
|
||||
self.stamps.iter_mut().for_each(|s| *s = 0);
|
||||
self.epoch = 1;
|
||||
}
|
||||
}
|
||||
|
||||
/// Mark `id` visited; `true` if it was not already.
|
||||
fn insert(&mut self, id: usize) -> bool {
|
||||
let seen = self.stamps[id] == self.epoch;
|
||||
self.stamps[id] = self.epoch;
|
||||
!seen
|
||||
}
|
||||
}
|
||||
|
||||
thread_local! {
|
||||
/// Per-thread scratch, so `search(&self)` stays shareable across threads.
|
||||
static VISITED: std::cell::RefCell<Visited> = std::cell::RefCell::new(Visited::default());
|
||||
}
|
||||
|
||||
#[allow(clippy::too_many_arguments)]
|
||||
fn search_layer_visit(
|
||||
vectors: &[Vec<f32>],
|
||||
layer: &[Vec<usize>],
|
||||
query: &[f32],
|
||||
ef: usize,
|
||||
metric: DistanceMetric,
|
||||
visited: &mut Visited,
|
||||
mut candidates: BinaryHeap<Candidate>,
|
||||
mut results: BinaryHeap<FarCandidate>,
|
||||
) -> Vec<Candidate> {
|
||||
while let Some(closest) = candidates.pop() {
|
||||
let furthest_dist = results.peek().map_or(f32::MAX, |f| f.distance);
|
||||
if closest.distance > furthest_dist && results.len() >= ef {
|
||||
@@ -801,10 +1027,9 @@ fn search_layer(
|
||||
}
|
||||
|
||||
for &neighbor in &layer[closest.id] {
|
||||
if visited.contains(&neighbor) {
|
||||
if !visited.insert(neighbor) {
|
||||
continue;
|
||||
}
|
||||
visited.insert(neighbor);
|
||||
|
||||
let d = compute_distance(query, &vectors[neighbor], metric);
|
||||
let furthest_dist = results.peek().map_or(f32::MAX, |f| f.distance);
|
||||
@@ -841,7 +1066,52 @@ fn search_layer(
|
||||
result
|
||||
}
|
||||
|
||||
/// Prune connections for a node to keep only the closest `max_conn` neighbors.
|
||||
/// Choose up to `max_conn` neighbours for a node from `candidates` (sorted by
|
||||
/// ascending distance to that node) — the HNSW paper's Algorithm 4 with
|
||||
/// `keepPrunedConnections`.
|
||||
///
|
||||
/// Taking the plain `max_conn` closest is what breaks the graph on clustered
|
||||
/// data: every link of a node inside a tight cluster goes to that same cluster,
|
||||
/// so clusters become islands that a search entering elsewhere can never
|
||||
/// reach, however large `ef` is. Instead a candidate is accepted only if it is
|
||||
/// closer to the node than to every neighbour already accepted, which spreads
|
||||
/// links across directions and keeps the long edges that join clusters. Any
|
||||
/// remaining slots are then filled with the closest rejected candidates, so a
|
||||
/// node is never left under-connected.
|
||||
fn select_neighbors(
|
||||
vectors: &[Vec<f32>],
|
||||
candidates: &[(usize, f32)],
|
||||
max_conn: usize,
|
||||
metric: DistanceMetric,
|
||||
) -> Vec<usize> {
|
||||
if candidates.len() <= max_conn {
|
||||
return candidates.iter().map(|&(id, _)| id).collect();
|
||||
}
|
||||
let mut selected: Vec<usize> = Vec::with_capacity(max_conn);
|
||||
let mut rejected: Vec<usize> = Vec::new();
|
||||
for &(id, dist_to_node) in candidates {
|
||||
if selected.len() >= max_conn {
|
||||
break;
|
||||
}
|
||||
let diverse = selected
|
||||
.iter()
|
||||
.all(|&s| compute_distance(&vectors[id], &vectors[s], metric) > dist_to_node);
|
||||
if diverse {
|
||||
selected.push(id);
|
||||
} else {
|
||||
rejected.push(id);
|
||||
}
|
||||
}
|
||||
for id in rejected {
|
||||
if selected.len() >= max_conn {
|
||||
break;
|
||||
}
|
||||
selected.push(id);
|
||||
}
|
||||
selected
|
||||
}
|
||||
|
||||
/// Trim `node`'s neighbour list back to `max_conn` with [`select_neighbors`].
|
||||
fn prune_connections(
|
||||
vectors: &[Vec<f32>],
|
||||
neighbors: &mut Vec<usize>,
|
||||
@@ -856,9 +1126,8 @@ fn prune_connections(
|
||||
.iter()
|
||||
.map(|&n| (n, compute_distance(&vectors[node], &vectors[n], metric)))
|
||||
.collect();
|
||||
scored.sort_by(|a, b| a.1.partial_cmp(&b.1).unwrap_or(std::cmp::Ordering::Equal));
|
||||
scored.truncate(max_conn);
|
||||
*neighbors = scored.into_iter().map(|(id, _)| id).collect();
|
||||
scored.sort_by(|a, b| a.1.total_cmp(&b.1).then(a.0.cmp(&b.0)));
|
||||
*neighbors = select_neighbors(vectors, &scored, max_conn, metric);
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
@@ -1013,11 +1282,14 @@ fn get_attr_i64(attrs: &[(String, AttrValue)], name: &str) -> Result<i64, Format
|
||||
/// Like [`get_attr_i64`] but returns `None` when the attribute is absent or not
|
||||
/// an integer, instead of erroring. Used for optional/back-compat attributes.
|
||||
fn get_attr_i64_opt(attrs: &[(String, AttrValue)], name: &str) -> Option<i64> {
|
||||
attrs.iter().find(|(n, _)| n == name).and_then(|(_, v)| match v {
|
||||
AttrValue::I64(val) => Some(*val),
|
||||
AttrValue::U64(val) => Some(*val as i64),
|
||||
_ => None,
|
||||
})
|
||||
attrs
|
||||
.iter()
|
||||
.find(|(n, _)| n == name)
|
||||
.and_then(|(_, v)| match v {
|
||||
AttrValue::I64(val) => Some(*val),
|
||||
AttrValue::U64(val) => Some(*val as i64),
|
||||
_ => None,
|
||||
})
|
||||
}
|
||||
|
||||
fn get_attr_string(attrs: &[(String, AttrValue)], name: &str) -> Result<String, FormatError> {
|
||||
@@ -1043,6 +1315,172 @@ fn get_attr_string(attrs: &[(String, AttrValue)], name: &str) -> Result<String,
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
use std::collections::HashSet;
|
||||
|
||||
/// Tight, well-separated clusters — the shape real embeddings have, and
|
||||
/// the case plain closest-M neighbour selection fails on: each cluster
|
||||
/// becomes an island, so recall is capped no matter how large `ef` is.
|
||||
fn clustered(n: usize, dim: usize, clusters: usize, seed: u64) -> Vec<Vec<f32>> {
|
||||
let mut state = seed;
|
||||
let mut next = move || {
|
||||
state = state.wrapping_add(0x9E37_79B9_7F4A_7C15);
|
||||
let mut z = state;
|
||||
z = (z ^ (z >> 30)).wrapping_mul(0xBF58_476D_1CE4_E5B9);
|
||||
z = (z ^ (z >> 27)).wrapping_mul(0x94D0_49BB_1331_11EB);
|
||||
((z ^ (z >> 31)) >> 40) as f32 / (1u64 << 24) as f32 - 0.5
|
||||
};
|
||||
let centres: Vec<Vec<f32>> = (0..clusters)
|
||||
.map(|_| (0..dim).map(|_| next() * 10.0).collect())
|
||||
.collect();
|
||||
(0..n)
|
||||
.map(|i| {
|
||||
centres[i % clusters]
|
||||
.iter()
|
||||
.map(|c| c + next() * 0.5)
|
||||
.collect()
|
||||
})
|
||||
.collect()
|
||||
}
|
||||
|
||||
fn recall_at_10(
|
||||
index: &HnswIndex,
|
||||
vectors: &[Vec<f32>],
|
||||
queries: &[Vec<f32>],
|
||||
ef: usize,
|
||||
) -> f64 {
|
||||
let mut hits = 0;
|
||||
for q in queries {
|
||||
let mut exact: Vec<(usize, f32)> = vectors
|
||||
.iter()
|
||||
.enumerate()
|
||||
.map(|(i, v)| (i, compute_distance(q, v, DistanceMetric::L2)))
|
||||
.collect();
|
||||
exact.sort_by(|a, b| a.1.total_cmp(&b.1));
|
||||
let want: Vec<usize> = exact[..10].iter().map(|e| e.0).collect();
|
||||
hits += index
|
||||
.search(q, 10, ef)
|
||||
.iter()
|
||||
.filter(|(id, _)| want.contains(id))
|
||||
.count();
|
||||
}
|
||||
hits as f64 / (10 * queries.len()) as f64
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn clustered_data_keeps_high_recall() {
|
||||
// Data and queries come from the same clusters: one draw, split.
|
||||
let mut vectors = clustered(3060, 24, 30, 1);
|
||||
let queries = vectors.split_off(3000);
|
||||
let built = HnswIndex::build_with_metric(&vectors, 8, 40, DistanceMetric::L2);
|
||||
let recall = recall_at_10(&built, &vectors, &queries, 64);
|
||||
assert!(recall >= 0.95, "bulk build recall@10 = {recall}");
|
||||
|
||||
// Incremental inserts go through the same neighbour selection.
|
||||
let mut incremental = HnswIndex::new(8, 40, DistanceMetric::L2);
|
||||
for v in &vectors {
|
||||
incremental.insert(v.clone());
|
||||
}
|
||||
let recall = recall_at_10(&incremental, &vectors, &queries, 64);
|
||||
assert!(recall >= 0.95, "incremental recall@10 = {recall}");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn graph_bytes_round_trip_gives_identical_searches() {
|
||||
let mut vectors = clustered(1260, 16, 12, 9);
|
||||
let queries = vectors.split_off(1200);
|
||||
let mut index = HnswIndex::build_with_metric(&vectors, 8, 40, DistanceMetric::L2);
|
||||
index.mark_deleted(3);
|
||||
index.mark_deleted(700);
|
||||
|
||||
let bytes = index.graph_to_bytes();
|
||||
// The graph is a small fraction of the vectors it indexes... not
|
||||
// necessarily at dim 16, but it must not embed them.
|
||||
assert!(bytes.len() < 1200 * (16 * 2 + 2) * 4);
|
||||
let restored = HnswIndex::from_graph_bytes(&bytes, vectors.clone()).unwrap();
|
||||
assert_eq!(restored.deleted_count(), 2);
|
||||
for q in &queries {
|
||||
assert_eq!(restored.search(q, 10, 50), index.search(q, 10, 50));
|
||||
}
|
||||
// A restored index keeps working incrementally.
|
||||
let mut restored = restored;
|
||||
let id = restored.insert(queries[0].clone());
|
||||
assert_eq!(restored.search(&queries[0], 1, 50)[0].0, id);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn damaged_or_mismatched_graph_bytes_are_errors() {
|
||||
let vectors = clustered(300, 8, 6, 4);
|
||||
let index = HnswIndex::build_with_metric(&vectors, 6, 30, DistanceMetric::Cosine);
|
||||
let bytes = index.graph_to_bytes();
|
||||
|
||||
// Wrong vector set.
|
||||
assert!(HnswIndex::from_graph_bytes(&bytes, vectors[..299].to_vec()).is_err());
|
||||
// Every truncation.
|
||||
for len in 0..bytes.len() {
|
||||
assert!(
|
||||
HnswIndex::from_graph_bytes(&bytes[..len], vectors.clone()).is_err(),
|
||||
"truncated to {len}"
|
||||
);
|
||||
}
|
||||
// A flipped bit anywhere.
|
||||
for i in (0..bytes.len()).step_by(7) {
|
||||
let mut damaged = bytes.clone();
|
||||
damaged[i] ^= 0x10;
|
||||
assert!(
|
||||
HnswIndex::from_graph_bytes(&damaged, vectors.clone()).is_err(),
|
||||
"bit flip at {i}"
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn structurally_invalid_graph_with_a_valid_checksum_is_rejected() {
|
||||
// The CRC only proves the bytes are what was written; a hostile or
|
||||
// buggy writer can checksum nonsense. Out-of-range neighbour ids must
|
||||
// still be caught, or search would index out of bounds.
|
||||
let vectors = clustered(50, 4, 3, 5);
|
||||
let index = HnswIndex::build_with_metric(&vectors, 4, 20, DistanceMetric::L2);
|
||||
let mut bytes = index.graph_to_bytes();
|
||||
let body_len = bytes.len() - 4;
|
||||
// First neighbour id of node 0 on layer 0 sits right after the header,
|
||||
// levels, tombstones and node 0's count.
|
||||
let at = 4 + 7 * 4 + 50 + 50 + 4;
|
||||
bytes[at..at + 4].copy_from_slice(&9999u32.to_le_bytes());
|
||||
let crc = clawhdf5_format::checksum::crc32(&bytes[..body_len]);
|
||||
bytes[body_len..].copy_from_slice(&crc.to_le_bytes());
|
||||
assert!(HnswIndex::from_graph_bytes(&bytes, vectors).is_err());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn select_neighbors_prefers_diverse_directions_and_fills_up() {
|
||||
// Node at the origin. Three candidates bunched together on the right,
|
||||
// one on the left. With room for two, plain closest-M would take two
|
||||
// from the bunch and lose the only link leftwards.
|
||||
let vectors = vec![
|
||||
vec![0.0, 0.0], // 0: the node
|
||||
vec![1.0, 0.0], // 1
|
||||
vec![1.1, 0.0], // 2
|
||||
vec![1.2, 0.0], // 3
|
||||
vec![-2.0, 0.0], // 4
|
||||
];
|
||||
let scored: Vec<(usize, f32)> = (1..5)
|
||||
.map(|i| {
|
||||
(
|
||||
i,
|
||||
compute_distance(&vectors[0], &vectors[i], DistanceMetric::L2),
|
||||
)
|
||||
})
|
||||
.collect();
|
||||
assert_eq!(
|
||||
select_neighbors(&vectors, &scored, 2, DistanceMetric::L2),
|
||||
[1, 4]
|
||||
);
|
||||
// Spare capacity is filled with the closest rejected candidates.
|
||||
assert_eq!(
|
||||
select_neighbors(&vectors, &scored, 3, DistanceMetric::L2),
|
||||
[1, 4, 2]
|
||||
);
|
||||
}
|
||||
|
||||
fn make_random_vectors(n: usize, dim: usize, seed: u64) -> Vec<Vec<f32>> {
|
||||
let mut vectors = Vec::with_capacity(n);
|
||||
@@ -1301,6 +1739,18 @@ mod tests {
|
||||
assert!((d - 1.0).abs() < 1e-6); // zero vector -> distance 1
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn cosine_near_zero_vector() {
|
||||
// Tiny-but-nonzero, identical-direction vectors: denom is well
|
||||
// below f32::EPSILON but not exactly 0.0. Must still be treated
|
||||
// as a degenerate/unreliable direction (distance 1, "maximally
|
||||
// dissimilar"), not as an exact match (distance 0).
|
||||
let a = vec![1e-4, 1e-4];
|
||||
let b = vec![1e-4, 1e-4];
|
||||
let d = compute_distance(&a, &b, DistanceMetric::Cosine);
|
||||
assert!((d - 1.0).abs() < 1e-6);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn insert_into_empty_index() {
|
||||
let mut index = HnswIndex::new(4, 16, DistanceMetric::L2);
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
[package]
|
||||
name = "clawhdf5-bench"
|
||||
version = "2.1.0"
|
||||
version = "2.4.0"
|
||||
edition = "2024"
|
||||
description = "Benchmark harnesses for clawhdf5-agent (Track 8)"
|
||||
license = "MIT"
|
||||
@@ -13,6 +13,10 @@ path = "src/bin/longmemeval_bench.rs"
|
||||
name = "memory_arena"
|
||||
path = "src/bin/memory_arena.rs"
|
||||
|
||||
[[bin]]
|
||||
name = "search_harness"
|
||||
path = "src/bin/search_harness.rs"
|
||||
|
||||
[[bin]]
|
||||
name = "footprint_bench"
|
||||
path = "src/bin/footprint_bench.rs"
|
||||
@@ -25,8 +29,57 @@ path = "src/bin/consolidation_efficiency.rs"
|
||||
name = "ephemeral_perf"
|
||||
path = "src/bin/ephemeral_perf.rs"
|
||||
|
||||
[[bin]]
|
||||
name = "mpi_io_bench"
|
||||
path = "src/bin/mpi_io_bench.rs"
|
||||
required-features = ["mpi-io"]
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# h5bench-equivalent Criterion benchmarks
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
[[bench]]
|
||||
name = "h5bench_write"
|
||||
harness = false
|
||||
|
||||
[[bench]]
|
||||
name = "h5bench_read"
|
||||
harness = false
|
||||
|
||||
[[bench]]
|
||||
name = "h5bench_meta"
|
||||
harness = false
|
||||
|
||||
[dependencies]
|
||||
clawhdf5-agent = { path = "../clawhdf5-agent" }
|
||||
serde = { version = "1", features = ["derive"] }
|
||||
clawhdf5-ann = { path = "../clawhdf5-ann" }
|
||||
clawhdf5-io = { path = "../clawhdf5-io" }
|
||||
mpi = { version = "0.8", optional = true }
|
||||
serde = { workspace = true }
|
||||
serde_json = "1"
|
||||
tempfile = "3"
|
||||
tempfile = { workspace = true }
|
||||
# Optional: libhdf5 C wrapper for side-by-side comparison (requires system libhdf5).
|
||||
# Enable with: cargo bench -p clawhdf5-bench --features libhdf5-compare
|
||||
# Uses hdf5-metno (fork of hdf5 crate) which supports HDF5 1.14.x.
|
||||
hdf5 = { version = "0.12", optional = true, package = "hdf5-metno" }
|
||||
# Optional: real sentence embeddings for the LongMemEval bench's vector stage.
|
||||
# Enable with: cargo run --release --bin longmemeval_bench --features embeddings
|
||||
# Off by default — nothing in the shipped crates depends on these.
|
||||
candle-core = { version = "0.9", optional = true }
|
||||
candle-nn = { version = "0.9", optional = true }
|
||||
candle-transformers = { version = "0.9", optional = true }
|
||||
tokenizers = { version = "0.21", optional = true }
|
||||
|
||||
[dev-dependencies]
|
||||
clawhdf5 = { path = "../clawhdf5", features = ["zstd", "pcodec"] }
|
||||
criterion = { workspace = true }
|
||||
|
||||
[features]
|
||||
# When enabled, benchmarks add matching libhdf5 variants for side-by-side comparison.
|
||||
libhdf5-compare = ["hdf5"]
|
||||
mpi-io = ["clawhdf5-io/mpi-io", "mpi"]
|
||||
# Real MiniLM embeddings for longmemeval_bench, so the vector stage is not inert.
|
||||
embeddings = ["candle-core", "candle-nn", "candle-transformers", "tokenizers"]
|
||||
# CUDA-accelerated embedding. MiniLM on a CPU takes hours over the full
|
||||
# longmemeval_s haystack; on a GPU it is minutes.
|
||||
embeddings-cuda = ["embeddings", "candle-core/cuda", "candle-nn/cuda", "candle-transformers/cuda"]
|
||||
|
||||
@@ -0,0 +1,327 @@
|
||||
//! h5bench-equivalent metadata workloads for clawhdf5.
|
||||
//!
|
||||
//! Measures attribute creation/read throughput and group traversal latency —
|
||||
//! the workloads that h5bench's `metadata` mode targets against libhdf5.
|
||||
|
||||
use clawhdf5::{AttrValue, File, FileBuilder};
|
||||
use criterion::{BenchmarkId, Criterion, Throughput, criterion_group, criterion_main};
|
||||
use tempfile::TempDir;
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Workload: metadata_attrs_write
|
||||
// Create K attributes on a single dataset.
|
||||
// Exercises attribute message allocation and compact → dense header transition.
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
fn bench_metadata_attrs_write(c: &mut Criterion) {
|
||||
let mut group = c.benchmark_group("metadata_attrs_write");
|
||||
|
||||
for &k in &[4usize, 16, 64, 128] {
|
||||
group.throughput(Throughput::Elements(k as u64));
|
||||
|
||||
group.bench_with_input(BenchmarkId::new("clawhdf5", k), &k, |b, &k| {
|
||||
let tmp = TempDir::new().unwrap();
|
||||
let path = tmp.path().join("attrs_write.h5");
|
||||
b.iter(|| {
|
||||
let mut fb = FileBuilder::new();
|
||||
let ds = fb
|
||||
.create_dataset("data")
|
||||
.with_f64_data(&[1.0, 2.0, 3.0])
|
||||
.with_shape(&[3]);
|
||||
for i in 0..k {
|
||||
ds.set_attr(&format!("attr_{i:04}"), AttrValue::I64(i as i64));
|
||||
}
|
||||
fb.write(&path).unwrap();
|
||||
});
|
||||
});
|
||||
|
||||
#[cfg(feature = "libhdf5-compare")]
|
||||
group.bench_with_input(BenchmarkId::new("libhdf5", k), &k, |b, &k| {
|
||||
let tmp = TempDir::new().unwrap();
|
||||
let path = tmp.path().join("attrs_libhdf5.h5");
|
||||
b.iter(|| {
|
||||
let file = hdf5::File::create(&path).unwrap();
|
||||
let ds = file.new_dataset::<f64>().shape([3]).create("data").unwrap();
|
||||
ds.write(&[1.0f64, 2.0, 3.0]).unwrap();
|
||||
for i in 0..k {
|
||||
ds.new_attr::<i64>()
|
||||
.create(format!("attr_{i:04}").as_str())
|
||||
.unwrap()
|
||||
.write_scalar(&(i as i64))
|
||||
.unwrap();
|
||||
}
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
group.finish();
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Workload: metadata_attrs_read
|
||||
// Open a pre-built file and read all K attributes back.
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
fn bench_metadata_attrs_read(c: &mut Criterion) {
|
||||
let mut group = c.benchmark_group("metadata_attrs_read");
|
||||
|
||||
for &k in &[4usize, 16, 64, 128] {
|
||||
// Build the reference file in memory.
|
||||
let bytes = {
|
||||
let mut fb = FileBuilder::new();
|
||||
let ds = fb
|
||||
.create_dataset("data")
|
||||
.with_f64_data(&[1.0, 2.0, 3.0])
|
||||
.with_shape(&[3]);
|
||||
for i in 0..k {
|
||||
ds.set_attr(&format!("attr_{i:04}"), AttrValue::I64(i as i64));
|
||||
}
|
||||
fb.finish().unwrap()
|
||||
};
|
||||
|
||||
group.throughput(Throughput::Elements(k as u64));
|
||||
|
||||
group.bench_with_input(BenchmarkId::new("clawhdf5", k), &bytes, |b, raw| {
|
||||
b.iter(|| {
|
||||
let file = File::from_bytes(raw.clone()).unwrap();
|
||||
let ds = file.dataset("data").unwrap();
|
||||
ds.attrs().unwrap()
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
group.finish();
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Workload: metadata_groups_create
|
||||
// Create K top-level groups (no datasets inside).
|
||||
// Measures link-storage allocation: compact → dense B-tree transition.
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
fn bench_metadata_groups_create(c: &mut Criterion) {
|
||||
let mut group = c.benchmark_group("metadata_groups_create");
|
||||
|
||||
for &k in &[4usize, 16, 32, 64] {
|
||||
group.throughput(Throughput::Elements(k as u64));
|
||||
|
||||
group.bench_with_input(BenchmarkId::new("clawhdf5", k), &k, |b, &k| {
|
||||
let tmp = TempDir::new().unwrap();
|
||||
let path = tmp.path().join("groups_create.h5");
|
||||
b.iter(|| {
|
||||
let mut fb = FileBuilder::new();
|
||||
for i in 0..k {
|
||||
let mut g = fb.create_group(&format!("group_{i:04}"));
|
||||
// Minimal dataset inside each group to make it non-trivial.
|
||||
g.create_dataset("x").with_f64_data(&[0.0]);
|
||||
let finished = g.finish();
|
||||
fb.add_group(finished);
|
||||
}
|
||||
fb.write(&path).unwrap();
|
||||
});
|
||||
});
|
||||
|
||||
#[cfg(feature = "libhdf5-compare")]
|
||||
group.bench_with_input(BenchmarkId::new("libhdf5", k), &k, |b, &k| {
|
||||
let tmp = TempDir::new().unwrap();
|
||||
let path = tmp.path().join("groups_libhdf5.h5");
|
||||
b.iter(|| {
|
||||
let file = hdf5::File::create(&path).unwrap();
|
||||
for i in 0..k {
|
||||
let g = file.create_group(&format!("group_{i:04}")).unwrap();
|
||||
g.new_dataset::<f64>()
|
||||
.shape([1])
|
||||
.create("x")
|
||||
.unwrap()
|
||||
.write(&[0.0f64])
|
||||
.unwrap();
|
||||
}
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
group.finish();
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Workload: metadata_groups_traverse
|
||||
// Open a pre-built file with K groups and traverse (list) the root group.
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
fn bench_metadata_groups_traverse(c: &mut Criterion) {
|
||||
let mut group = c.benchmark_group("metadata_groups_traverse");
|
||||
|
||||
for &k in &[4usize, 16, 32, 64] {
|
||||
// Pre-build.
|
||||
let bytes = {
|
||||
let mut fb = FileBuilder::new();
|
||||
for i in 0..k {
|
||||
let mut g = fb.create_group(&format!("group_{i:04}"));
|
||||
g.create_dataset("x").with_f64_data(&[0.0]);
|
||||
let finished = g.finish();
|
||||
fb.add_group(finished);
|
||||
}
|
||||
fb.finish().unwrap()
|
||||
};
|
||||
|
||||
group.throughput(Throughput::Elements(k as u64));
|
||||
|
||||
group.bench_with_input(BenchmarkId::new("clawhdf5", k), &bytes, |b, raw| {
|
||||
b.iter(|| {
|
||||
let file = File::from_bytes(raw.clone()).unwrap();
|
||||
let root = file.root();
|
||||
root.groups().unwrap()
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
group.finish();
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Workload: metadata_roundtrip_string_attrs
|
||||
// Write and read back K variable-length string attributes.
|
||||
// String attrs require a dedicated VL heap entry — distinct from numeric ones.
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
fn bench_metadata_string_attrs(c: &mut Criterion) {
|
||||
let mut group = c.benchmark_group("metadata_string_attrs");
|
||||
|
||||
for &k in &[4usize, 16, 32] {
|
||||
group.throughput(Throughput::Elements(k as u64));
|
||||
|
||||
group.bench_with_input(BenchmarkId::new("clawhdf5", k), &k, |b, &k| {
|
||||
b.iter(|| {
|
||||
let mut fb = FileBuilder::new();
|
||||
let ds = fb
|
||||
.create_dataset("data")
|
||||
.with_f64_data(&[1.0])
|
||||
.with_shape(&[1]);
|
||||
for i in 0..k {
|
||||
ds.set_attr(
|
||||
&format!("label_{i:04}"),
|
||||
AttrValue::String(format!("value-{i}-some-longer-string-payload")),
|
||||
);
|
||||
}
|
||||
let bytes = fb.finish().unwrap();
|
||||
|
||||
// Immediately read back to exercise both directions.
|
||||
let file = File::from_bytes(bytes).unwrap();
|
||||
let ds_r = file.dataset("data").unwrap();
|
||||
ds_r.attrs().unwrap()
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
group.finish();
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Workload: metadata_open_from_disk
|
||||
// Open a small pre-built file from disk and resolve one attribute. Both
|
||||
// sides pay the OS open()/read() cost plus header-parse cost, so this is a
|
||||
// fair, I/O-inclusive "open a file and touch its metadata" comparison — the
|
||||
// honest version of the "metadata parse" claim this benchmark replaces.
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
fn bench_metadata_open_from_disk(c: &mut Criterion) {
|
||||
let mut group = c.benchmark_group("metadata_open_from_disk");
|
||||
group.throughput(Throughput::Elements(1));
|
||||
|
||||
let tmp = TempDir::new().unwrap();
|
||||
let clawhdf5_path = tmp.path().join("open_clawhdf5.h5");
|
||||
{
|
||||
let mut fb = FileBuilder::new();
|
||||
let ds = fb
|
||||
.create_dataset("data")
|
||||
.with_f64_data(&[1.0, 2.0, 3.0])
|
||||
.with_shape(&[3]);
|
||||
ds.set_attr("label", AttrValue::I64(42));
|
||||
fb.write(&clawhdf5_path).unwrap();
|
||||
}
|
||||
|
||||
group.bench_function("clawhdf5", |b| {
|
||||
b.iter(|| {
|
||||
let raw = std::fs::read(&clawhdf5_path).unwrap();
|
||||
let file = File::from_bytes(raw).unwrap();
|
||||
let ds = file.dataset("data").unwrap();
|
||||
ds.attrs().unwrap()
|
||||
});
|
||||
});
|
||||
|
||||
#[cfg(feature = "libhdf5-compare")]
|
||||
{
|
||||
let libhdf5_path = tmp.path().join("open_libhdf5.h5");
|
||||
{
|
||||
let file = hdf5::File::create(&libhdf5_path).unwrap();
|
||||
let ds = file.new_dataset::<f64>().shape([3]).create("data").unwrap();
|
||||
ds.write(&[1.0f64, 2.0, 3.0]).unwrap();
|
||||
ds.new_attr::<i64>()
|
||||
.create("label")
|
||||
.unwrap()
|
||||
.write_scalar(&42i64)
|
||||
.unwrap();
|
||||
}
|
||||
|
||||
group.bench_function("libhdf5", |b| {
|
||||
b.iter(|| {
|
||||
let file = hdf5::File::open(&libhdf5_path).unwrap();
|
||||
let ds = file.dataset("data").unwrap();
|
||||
let _: i64 = ds.attr("label").unwrap().read_scalar().unwrap();
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
group.finish();
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Workload: metadata_parse_in_memory (clawhdf5-only)
|
||||
// Times File::from_bytes() alone on bytes already resident in memory — i.e.
|
||||
// the header-parse cost with disk I/O excluded. There is no fair libhdf5
|
||||
// equivalent (its API has no "parse from an in-memory buffer" path that
|
||||
// skips the OS open), so this is reported standalone, not as a speedup
|
||||
// multiple against libhdf5. See metadata_open_from_disk above for the
|
||||
// I/O-inclusive, directly comparable number.
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
fn bench_metadata_parse_in_memory(c: &mut Criterion) {
|
||||
let mut group = c.benchmark_group("metadata_parse_in_memory");
|
||||
group.throughput(Throughput::Elements(1));
|
||||
|
||||
let bytes = {
|
||||
let mut fb = FileBuilder::new();
|
||||
let ds = fb
|
||||
.create_dataset("data")
|
||||
.with_f64_data(&[1.0, 2.0, 3.0])
|
||||
.with_shape(&[3]);
|
||||
ds.set_attr("label", AttrValue::I64(42));
|
||||
fb.finish().unwrap()
|
||||
};
|
||||
|
||||
group.bench_with_input(
|
||||
BenchmarkId::new("clawhdf5", "in_memory"),
|
||||
&bytes,
|
||||
|b, raw| {
|
||||
b.iter(|| {
|
||||
let file = File::from_bytes(raw.clone()).unwrap();
|
||||
let ds = file.dataset("data").unwrap();
|
||||
ds.attrs().unwrap()
|
||||
});
|
||||
},
|
||||
);
|
||||
|
||||
group.finish();
|
||||
}
|
||||
|
||||
criterion_group!(
|
||||
meta_benches,
|
||||
bench_metadata_attrs_write,
|
||||
bench_metadata_attrs_read,
|
||||
bench_metadata_groups_create,
|
||||
bench_metadata_groups_traverse,
|
||||
bench_metadata_string_attrs,
|
||||
bench_metadata_open_from_disk,
|
||||
bench_metadata_parse_in_memory,
|
||||
);
|
||||
criterion_main!(meta_benches);
|
||||
@@ -0,0 +1,290 @@
|
||||
//! h5bench-equivalent read workloads for clawhdf5.
|
||||
//!
|
||||
//! Covers sequential read, hyperslab / strided access, and round-trip
|
||||
//! validation patterns mirroring the h5bench HPC read suite.
|
||||
|
||||
use clawhdf5::{File, FileBuilder};
|
||||
use criterion::{BenchmarkId, Criterion, Throughput, criterion_group, criterion_main};
|
||||
use tempfile::TempDir;
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Helpers: build reference files once per bench group.
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
/// Write a contiguous 1-D f32 dataset and return raw bytes.
|
||||
fn make_1d_contiguous_bytes(n: usize) -> Vec<u8> {
|
||||
let data: Vec<f32> = (0..n).map(|i| i as f32 * 0.001).collect();
|
||||
let mut fb = FileBuilder::new();
|
||||
fb.create_dataset("data")
|
||||
.with_f32_data(&data)
|
||||
.with_shape(&[n as u64]);
|
||||
fb.finish().unwrap()
|
||||
}
|
||||
|
||||
/// Write a contiguous 1-D f64 dataset and return raw bytes.
|
||||
fn make_1d_f64_bytes(n: usize) -> Vec<u8> {
|
||||
let data: Vec<f64> = (0..n).map(|i| i as f64 * 0.001).collect();
|
||||
let mut fb = FileBuilder::new();
|
||||
fb.create_dataset("data")
|
||||
.with_f64_data(&data)
|
||||
.with_shape(&[n as u64]);
|
||||
fb.finish().unwrap()
|
||||
}
|
||||
|
||||
/// Write a 2-D chunked f32 matrix to a temp file, return path string.
|
||||
///
|
||||
/// The temp dir is returned to keep the directory alive.
|
||||
fn make_2d_chunked_file(tmp: &TempDir, rows: usize, cols: usize) -> std::path::PathBuf {
|
||||
let data: Vec<f32> = (0..rows * cols).map(|i| i as f32).collect();
|
||||
let path = tmp.path().join("chunked.h5");
|
||||
let mut fb = FileBuilder::new();
|
||||
fb.create_dataset("matrix")
|
||||
.with_f32_data(&data)
|
||||
.with_shape(&[rows as u64, cols as u64])
|
||||
.with_chunks(&[32, cols as u64]);
|
||||
fb.write(&path).unwrap();
|
||||
path
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Workload: read_sequential
|
||||
// Read back the full 1-D contiguous f32 dataset.
|
||||
// Measures parser + byte-copy throughput.
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
fn bench_read_sequential(c: &mut Criterion) {
|
||||
let mut group = c.benchmark_group("read_sequential");
|
||||
|
||||
for &n in &[1_000usize, 10_000, 100_000] {
|
||||
let bytes = make_1d_contiguous_bytes(n);
|
||||
group.throughput(Throughput::Bytes((n * size_of::<f32>()) as u64));
|
||||
|
||||
group.bench_with_input(BenchmarkId::new("clawhdf5", n), &bytes, |b, raw| {
|
||||
b.iter(|| {
|
||||
let file = File::from_bytes(raw.clone()).unwrap();
|
||||
let ds = file.dataset("data").unwrap();
|
||||
ds.read_f32().unwrap()
|
||||
});
|
||||
});
|
||||
|
||||
#[cfg(feature = "libhdf5-compare")]
|
||||
group.bench_with_input(BenchmarkId::new("libhdf5", n), &n, |b, &nn| {
|
||||
let tmp = TempDir::new().unwrap();
|
||||
let path = tmp.path().join("seq_libhdf5.h5");
|
||||
let data: Vec<f32> = (0..nn).map(|i| i as f32 * 0.001).collect();
|
||||
{
|
||||
let lf = hdf5::File::create(&path).unwrap();
|
||||
let lds = lf.new_dataset::<f32>().shape([nn]).create("data").unwrap();
|
||||
lds.write(data.as_slice()).unwrap();
|
||||
}
|
||||
b.iter(|| {
|
||||
let file = hdf5::File::open(&path).unwrap();
|
||||
let ds = file.dataset("data").unwrap();
|
||||
ds.read_raw::<f32>().unwrap()
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
group.finish();
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Workload: read_f64_sequential
|
||||
// Same as above but for f64 — the dominant agent-embedding dtype.
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
fn bench_read_f64_sequential(c: &mut Criterion) {
|
||||
let mut group = c.benchmark_group("read_f64_sequential");
|
||||
|
||||
for &n in &[1_000usize, 10_000, 100_000] {
|
||||
let bytes = make_1d_f64_bytes(n);
|
||||
group.throughput(Throughput::Bytes((n * size_of::<f64>()) as u64));
|
||||
|
||||
group.bench_with_input(BenchmarkId::new("clawhdf5", n), &bytes, |b, raw| {
|
||||
b.iter(|| {
|
||||
let file = File::from_bytes(raw.clone()).unwrap();
|
||||
let ds = file.dataset("data").unwrap();
|
||||
ds.read_f64().unwrap()
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
group.finish();
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Workload: read_chunked_2d
|
||||
// Read back a 2-D chunked f32 matrix from disk (exercises chunk reassembly).
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
fn bench_read_chunked_2d(c: &mut Criterion) {
|
||||
let mut group = c.benchmark_group("read_chunked_2d");
|
||||
|
||||
for &(rows, cols) in &[(64usize, 64usize), (256, 256), (512, 512)] {
|
||||
let tmp = TempDir::new().unwrap();
|
||||
let path = make_2d_chunked_file(&tmp, rows, cols);
|
||||
let n = rows * cols;
|
||||
group.throughput(Throughput::Bytes((n * size_of::<f32>()) as u64));
|
||||
let label = format!("{rows}x{cols}");
|
||||
|
||||
group.bench_with_input(BenchmarkId::new("clawhdf5", &label), &path, |b, p| {
|
||||
b.iter(|| {
|
||||
let raw = std::fs::read(p).unwrap();
|
||||
let file = File::from_bytes(raw).unwrap();
|
||||
let ds = file.dataset("matrix").unwrap();
|
||||
ds.read_f32().unwrap()
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
group.finish();
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Workload: read_from_disk
|
||||
// Open file from disk (FileBuilder::write → File::open) measuring OS I/O +
|
||||
// HDF5 parse together. Simulates cold-cache reads.
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
fn bench_read_from_disk(c: &mut Criterion) {
|
||||
let mut group = c.benchmark_group("read_from_disk");
|
||||
|
||||
for &n in &[10_000usize, 100_000] {
|
||||
let tmp = TempDir::new().unwrap();
|
||||
let path = tmp.path().join("disk.h5");
|
||||
|
||||
let data: Vec<f64> = (0..n).map(|i| i as f64).collect();
|
||||
let mut fb = FileBuilder::new();
|
||||
fb.create_dataset("data")
|
||||
.with_f64_data(&data)
|
||||
.with_shape(&[n as u64]);
|
||||
fb.write(&path).unwrap();
|
||||
|
||||
group.throughput(Throughput::Bytes((n * size_of::<f64>()) as u64));
|
||||
|
||||
group.bench_with_input(BenchmarkId::new("clawhdf5", n), &path, |b, p| {
|
||||
b.iter(|| {
|
||||
let raw = std::fs::read(p).unwrap();
|
||||
let file = File::from_bytes(raw).unwrap();
|
||||
file.dataset("data").unwrap().read_f64().unwrap()
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
group.finish();
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Workload: read_hyperslab
|
||||
// Reads a subset of a 1-D dataset (simulating strided / hyperslab access).
|
||||
// Uses every-other element to stress the selection logic.
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
fn bench_read_hyperslab(c: &mut Criterion) {
|
||||
let mut group = c.benchmark_group("read_hyperslab");
|
||||
|
||||
for &n in &[10_000usize, 100_000] {
|
||||
let bytes = make_1d_f64_bytes(n);
|
||||
// Read first 10% of the dataset as a proxy for hyperslab access.
|
||||
let slice_len = n / 10;
|
||||
group.throughput(Throughput::Bytes((slice_len * size_of::<f64>()) as u64));
|
||||
|
||||
group.bench_with_input(BenchmarkId::new("clawhdf5", n), &bytes, |b, raw| {
|
||||
b.iter(|| {
|
||||
let file = File::from_bytes(raw.clone()).unwrap();
|
||||
let ds = file.dataset("data").unwrap();
|
||||
// Full read then take a slice — clawhdf5 does not yet expose
|
||||
// selection API at the high-level facade, so we read all and
|
||||
// trim (this is what the format-level selection exercises).
|
||||
let all = ds.read_f64().unwrap();
|
||||
all[..slice_len].to_vec()
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
group.finish();
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Workload: read_zerocopy_mmap
|
||||
// Opens a file from disk via `MmapFile` and reads an f64 dataset through
|
||||
// `read_f64_zerocopy()`, which returns a slice directly into the mapped
|
||||
// pages (no allocation, no copy). Compared against the regular
|
||||
// std::fs::read + File::from_bytes path (which does copy), and — with
|
||||
// libhdf5-compare — against libhdf5's own disk-backed open+read.
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
fn bench_read_zerocopy_mmap(c: &mut Criterion) {
|
||||
use clawhdf5::MmapFile;
|
||||
|
||||
let mut group = c.benchmark_group("read_zerocopy_mmap");
|
||||
|
||||
for &n in &[1_000usize, 10_000, 100_000] {
|
||||
let tmp = TempDir::new().unwrap();
|
||||
let path = tmp.path().join("mmap.h5");
|
||||
let data: Vec<f64> = (0..n).map(|i| i as f64 * 0.001).collect();
|
||||
let mut fb = FileBuilder::new();
|
||||
fb.create_dataset("data")
|
||||
.with_f64_data(&data)
|
||||
.with_shape(&[n as u64]);
|
||||
fb.write(&path).unwrap();
|
||||
|
||||
group.throughput(Throughput::Bytes((n * size_of::<f64>()) as u64));
|
||||
|
||||
group.bench_with_input(
|
||||
BenchmarkId::new("clawhdf5_mmap_zerocopy", n),
|
||||
&path,
|
||||
|b, p| {
|
||||
b.iter(|| {
|
||||
let file = MmapFile::open(p).unwrap();
|
||||
let ds = file.dataset("data").unwrap();
|
||||
let slice = ds.read_f64_zerocopy().unwrap();
|
||||
// Sum every element to force the mapped pages to actually be
|
||||
// faulted in — returning just `.len()` would measure nothing
|
||||
// but the mmap() syscall, repeating the exact "too-fast-to-
|
||||
// be-real" mistake this benchmark exists to fix.
|
||||
let sum: f64 = slice.map(|s| s.iter().sum()).unwrap_or(0.0);
|
||||
criterion::black_box(sum)
|
||||
});
|
||||
},
|
||||
);
|
||||
|
||||
group.bench_with_input(BenchmarkId::new("clawhdf5_copy", n), &path, |b, p| {
|
||||
b.iter(|| {
|
||||
let raw = std::fs::read(p).unwrap();
|
||||
let file = File::from_bytes(raw).unwrap();
|
||||
file.dataset("data").unwrap().read_f64().unwrap()
|
||||
});
|
||||
});
|
||||
|
||||
#[cfg(feature = "libhdf5-compare")]
|
||||
group.bench_with_input(BenchmarkId::new("libhdf5", n), &n, |b, &nn| {
|
||||
let tmp2 = TempDir::new().unwrap();
|
||||
let path2 = tmp2.path().join("mmap_libhdf5.h5");
|
||||
let data2: Vec<f64> = (0..nn).map(|i| i as f64 * 0.001).collect();
|
||||
{
|
||||
let lf = hdf5::File::create(&path2).unwrap();
|
||||
let lds = lf.new_dataset::<f64>().shape([nn]).create("data").unwrap();
|
||||
lds.write(data2.as_slice()).unwrap();
|
||||
}
|
||||
b.iter(|| {
|
||||
let file = hdf5::File::open(&path2).unwrap();
|
||||
let ds = file.dataset("data").unwrap();
|
||||
ds.read_raw::<f64>().unwrap()
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
group.finish();
|
||||
}
|
||||
|
||||
criterion_group!(
|
||||
read_benches,
|
||||
bench_read_sequential,
|
||||
bench_read_f64_sequential,
|
||||
bench_read_chunked_2d,
|
||||
bench_read_from_disk,
|
||||
bench_read_hyperslab,
|
||||
bench_read_zerocopy_mmap,
|
||||
);
|
||||
criterion_main!(read_benches);
|
||||
@@ -0,0 +1,330 @@
|
||||
//! h5bench-equivalent write workloads for clawhdf5.
|
||||
//!
|
||||
//! Mirrors the sequential and chunked write patterns from the h5bench HPC
|
||||
//! benchmark suite but implemented in pure Rust using Criterion for statistical
|
||||
//! rigor. The `libhdf5-compare` feature adds matching benchmarks via the `hdf5`
|
||||
//! crate (requires a system libhdf5 install).
|
||||
|
||||
use clawhdf5::{AttrValue, FileBuilder};
|
||||
use criterion::{BenchmarkId, Criterion, Throughput, criterion_group, criterion_main};
|
||||
use tempfile::TempDir;
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Workload: write_1d_contiguous
|
||||
// Write N × f32 as a single contiguous 1-D dataset.
|
||||
// Measures raw serialization + HDF5 superblock / object-header overhead.
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
fn bench_write_1d_contiguous(c: &mut Criterion) {
|
||||
let mut group = c.benchmark_group("write_1d_contiguous");
|
||||
|
||||
for &n in &[1_000usize, 10_000, 100_000] {
|
||||
let data: Vec<f32> = (0..n).map(|i| i as f32 * 0.001).collect();
|
||||
group.throughput(Throughput::Bytes((n * size_of::<f32>()) as u64));
|
||||
|
||||
group.bench_with_input(BenchmarkId::new("clawhdf5", n), &data, |b, d| {
|
||||
let tmp = TempDir::new().unwrap();
|
||||
let path = tmp.path().join("write_1d_contiguous.h5");
|
||||
b.iter(|| {
|
||||
let mut fb = FileBuilder::new();
|
||||
fb.create_dataset("data")
|
||||
.with_f32_data(d)
|
||||
.with_shape(&[n as u64]);
|
||||
fb.write(&path).unwrap();
|
||||
});
|
||||
});
|
||||
|
||||
#[cfg(feature = "libhdf5-compare")]
|
||||
group.bench_with_input(BenchmarkId::new("libhdf5", n), &data, |b, d| {
|
||||
let tmp = TempDir::new().unwrap();
|
||||
let path = tmp.path().join("write_1d_libhdf5.h5");
|
||||
b.iter(|| {
|
||||
let file = hdf5::File::create(&path).unwrap();
|
||||
let ds = file
|
||||
.new_dataset::<f32>()
|
||||
.shape([d.len()])
|
||||
.create("data")
|
||||
.unwrap();
|
||||
ds.write(d.as_slice()).unwrap();
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
group.finish();
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Workload: write_2d_chunked
|
||||
// Write an M × N f32 matrix as a chunked 2-D dataset with deflate (level 6).
|
||||
// Measures chunked layout creation + compression pipeline throughput.
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
fn bench_write_2d_chunked(c: &mut Criterion) {
|
||||
let mut group = c.benchmark_group("write_2d_chunked");
|
||||
|
||||
// (rows, cols, chunk_rows, chunk_cols)
|
||||
let configs: &[(usize, usize, u64, u64)] =
|
||||
&[(32, 32, 8, 32), (128, 128, 32, 128), (512, 512, 64, 512)];
|
||||
|
||||
for &(rows, cols, cr, cc) in configs {
|
||||
let n = rows * cols;
|
||||
let data: Vec<f32> = (0..n).map(|i| i as f32).collect();
|
||||
let label = format!("{rows}x{cols}");
|
||||
group.throughput(Throughput::Bytes((n * size_of::<f32>()) as u64));
|
||||
|
||||
group.bench_with_input(BenchmarkId::new("clawhdf5", &label), &data, |b, d| {
|
||||
let tmp = TempDir::new().unwrap();
|
||||
let path = tmp.path().join("write_2d_chunked.h5");
|
||||
b.iter(|| {
|
||||
let mut fb = FileBuilder::new();
|
||||
fb.create_dataset("matrix")
|
||||
.with_f32_data(d)
|
||||
.with_shape(&[rows as u64, cols as u64])
|
||||
.with_chunks(&[cr, cc])
|
||||
.with_deflate(6);
|
||||
fb.write(&path).unwrap();
|
||||
});
|
||||
});
|
||||
|
||||
#[cfg(feature = "libhdf5-compare")]
|
||||
group.bench_with_input(BenchmarkId::new("libhdf5", &label), &data, |b, d| {
|
||||
let tmp = TempDir::new().unwrap();
|
||||
let path = tmp.path().join("write_2d_libhdf5.h5");
|
||||
b.iter(|| {
|
||||
let file = hdf5::File::create(&path).unwrap();
|
||||
let ds = file
|
||||
.new_dataset::<f32>()
|
||||
.shape([rows, cols])
|
||||
.chunk([cr as usize, cc as usize])
|
||||
.deflate(6)
|
||||
.create("matrix")
|
||||
.unwrap();
|
||||
ds.write_raw(d.as_slice()).unwrap();
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
group.finish();
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Workload: write_2d_chunked_zstd
|
||||
// Same matrix sizes as write_2d_chunked but uses Zstd level 3.
|
||||
// Zstd level 3 typically encodes 500+ MiB/s vs deflate's ~300 MiB/s at the
|
||||
// same or better compression ratio (arXiv 2604.06221, ROOT I/O 2019).
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
fn bench_write_2d_chunked_zstd(c: &mut Criterion) {
|
||||
let mut group = c.benchmark_group("write_2d_chunked_zstd");
|
||||
|
||||
let configs: &[(usize, usize, u64, u64)] =
|
||||
&[(32, 32, 8, 32), (128, 128, 32, 128), (512, 512, 64, 512)];
|
||||
|
||||
for &(rows, cols, cr, cc) in configs {
|
||||
let n = rows * cols;
|
||||
let data: Vec<f32> = (0..n).map(|i| i as f32).collect();
|
||||
let label = format!("{rows}x{cols}");
|
||||
group.throughput(Throughput::Bytes((n * size_of::<f32>()) as u64));
|
||||
|
||||
group.bench_with_input(
|
||||
BenchmarkId::new("clawhdf5/zstd-3", &label),
|
||||
&data,
|
||||
|b, d| {
|
||||
let tmp = TempDir::new().unwrap();
|
||||
let path = tmp.path().join("write_2d_chunked_zstd.h5");
|
||||
b.iter(|| {
|
||||
let mut fb = FileBuilder::new();
|
||||
fb.create_dataset("matrix")
|
||||
.with_f32_data(d)
|
||||
.with_shape(&[rows as u64, cols as u64])
|
||||
.with_chunks(&[cr, cc])
|
||||
.with_zstd(3);
|
||||
fb.write(&path).unwrap();
|
||||
});
|
||||
},
|
||||
);
|
||||
|
||||
group.bench_with_input(
|
||||
BenchmarkId::new("clawhdf5/deflate-6", &label),
|
||||
&data,
|
||||
|b, d| {
|
||||
let tmp = TempDir::new().unwrap();
|
||||
let path = tmp.path().join("write_2d_chunked_deflate.h5");
|
||||
b.iter(|| {
|
||||
let mut fb = FileBuilder::new();
|
||||
fb.create_dataset("matrix")
|
||||
.with_f32_data(d)
|
||||
.with_shape(&[rows as u64, cols as u64])
|
||||
.with_chunks(&[cr, cc])
|
||||
.with_deflate(6);
|
||||
fb.write(&path).unwrap();
|
||||
});
|
||||
},
|
||||
);
|
||||
}
|
||||
|
||||
group.finish();
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Workload: write_2d_chunked_pcodec
|
||||
// Same matrix sizes as write_2d_chunked but uses Pcodec (arXiv:2502.06112).
|
||||
// Pcodec achieves 30–94% better compression ratio than Zstd for f32/f64 at
|
||||
// 1–5 GiB/s decompression speed via a quantile-based numerical codec.
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
fn bench_write_2d_chunked_pcodec(c: &mut Criterion) {
|
||||
let mut group = c.benchmark_group("write_2d_chunked_pcodec");
|
||||
|
||||
let configs: &[(usize, usize, u64, u64)] =
|
||||
&[(32, 32, 8, 32), (128, 128, 32, 128), (512, 512, 64, 512)];
|
||||
|
||||
for &(rows, cols, cr, cc) in configs {
|
||||
let n = rows * cols;
|
||||
let data: Vec<f32> = (0..n).map(|i| i as f32).collect();
|
||||
let label = format!("{rows}x{cols}");
|
||||
group.throughput(Throughput::Bytes((n * size_of::<f32>()) as u64));
|
||||
|
||||
group.bench_with_input(
|
||||
BenchmarkId::new("clawhdf5/pcodec", &label),
|
||||
&data,
|
||||
|b, d| {
|
||||
let tmp = TempDir::new().unwrap();
|
||||
let path = tmp.path().join("write_2d_chunked_pcodec.h5");
|
||||
b.iter(|| {
|
||||
let mut fb = FileBuilder::new();
|
||||
fb.create_dataset("matrix")
|
||||
.with_f32_data(d)
|
||||
.with_shape(&[rows as u64, cols as u64])
|
||||
.with_chunks(&[cr, cc])
|
||||
.with_pcodec();
|
||||
fb.write(&path).unwrap();
|
||||
});
|
||||
},
|
||||
);
|
||||
|
||||
group.bench_with_input(
|
||||
BenchmarkId::new("clawhdf5/zstd-3", &label),
|
||||
&data,
|
||||
|b, d| {
|
||||
let tmp = TempDir::new().unwrap();
|
||||
let path = tmp.path().join("write_2d_chunked_zstd.h5");
|
||||
b.iter(|| {
|
||||
let mut fb = FileBuilder::new();
|
||||
fb.create_dataset("matrix")
|
||||
.with_f32_data(d)
|
||||
.with_shape(&[rows as u64, cols as u64])
|
||||
.with_chunks(&[cr, cc])
|
||||
.with_zstd(3);
|
||||
fb.write(&path).unwrap();
|
||||
});
|
||||
},
|
||||
);
|
||||
}
|
||||
|
||||
group.finish();
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Workload: write_f64_batch
|
||||
// Write batches of f64 elements — simulates the clawhdf5-agent embedding
|
||||
// write path (one f64 vector per memory entry).
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
fn bench_write_f64_batch(c: &mut Criterion) {
|
||||
let mut group = c.benchmark_group("write_f64_batch");
|
||||
|
||||
for &n in &[128usize, 512, 1_024] {
|
||||
let data: Vec<f64> = (0..n).map(|i| (i as f64).sin()).collect();
|
||||
group.throughput(Throughput::Bytes((n * size_of::<f64>()) as u64));
|
||||
|
||||
group.bench_with_input(BenchmarkId::new("clawhdf5", n), &data, |b, d| {
|
||||
let tmp = TempDir::new().unwrap();
|
||||
let path = tmp.path().join("write_f64_batch.h5");
|
||||
b.iter(|| {
|
||||
let mut fb = FileBuilder::new();
|
||||
fb.create_dataset("embedding")
|
||||
.with_f64_data(d)
|
||||
.with_shape(&[n as u64]);
|
||||
fb.write(&path).unwrap();
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
group.finish();
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Workload: write_multi_dataset
|
||||
// Write K independent f32 datasets into one file — stresses the object-header
|
||||
// + link-storage path (compact → dense transition at >8 datasets).
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
fn bench_write_multi_dataset(c: &mut Criterion) {
|
||||
let mut group = c.benchmark_group("write_multi_dataset");
|
||||
|
||||
for &k in &[4usize, 16, 64] {
|
||||
let rows = 100usize;
|
||||
let data: Vec<f32> = (0..rows).map(|i| i as f32).collect();
|
||||
group.throughput(Throughput::Elements(k as u64));
|
||||
|
||||
group.bench_with_input(BenchmarkId::new("clawhdf5", k), &data, |b, d| {
|
||||
let tmp = TempDir::new().unwrap();
|
||||
let path = tmp.path().join("write_multi.h5");
|
||||
b.iter(|| {
|
||||
let mut fb = FileBuilder::new();
|
||||
for i in 0..k {
|
||||
fb.create_dataset(&format!("ds_{i:04}"))
|
||||
.with_f32_data(d)
|
||||
.with_shape(&[rows as u64]);
|
||||
}
|
||||
fb.write(&path).unwrap();
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
group.finish();
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Workload: write_with_attrs
|
||||
// Write a dataset with K attributes — exercises attribute message allocation.
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
fn bench_write_with_attrs(c: &mut Criterion) {
|
||||
let mut group = c.benchmark_group("write_with_attrs");
|
||||
|
||||
for &k in &[4usize, 16, 64] {
|
||||
group.throughput(Throughput::Elements(k as u64));
|
||||
|
||||
group.bench_with_input(BenchmarkId::new("clawhdf5", k), &k, |b, &k| {
|
||||
let tmp = TempDir::new().unwrap();
|
||||
let path = tmp.path().join("write_attrs.h5");
|
||||
b.iter(|| {
|
||||
let mut fb = FileBuilder::new();
|
||||
let ds = fb
|
||||
.create_dataset("data")
|
||||
.with_f64_data(&[1.0, 2.0, 3.0])
|
||||
.with_shape(&[3]);
|
||||
for i in 0..k {
|
||||
ds.set_attr(&format!("attr_{i}"), AttrValue::I64(i as i64));
|
||||
}
|
||||
fb.write(&path).unwrap();
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
group.finish();
|
||||
}
|
||||
|
||||
criterion_group!(
|
||||
write_benches,
|
||||
bench_write_1d_contiguous,
|
||||
bench_write_2d_chunked,
|
||||
bench_write_2d_chunked_zstd,
|
||||
bench_write_2d_chunked_pcodec,
|
||||
bench_write_f64_batch,
|
||||
bench_write_multi_dataset,
|
||||
bench_write_with_attrs,
|
||||
);
|
||||
criterion_main!(write_benches);
|
||||
@@ -0,0 +1,95 @@
|
||||
//! World-model sample-loading benchmark — clawhdf5 vs the h5py counterpart.
|
||||
//!
|
||||
//! Reproduces the access pattern of `stable-worldmodel`'s HDF5 dataloader
|
||||
//! (arXiv 2605.21800): a dataset of `(N, H, W, C)` uint8 observation frames,
|
||||
//! read one frame at a time in shuffled (dataloader) order. That paper
|
||||
//! reports generic HDF5 at 1,416–1,474 samples/s (vs Lance 4,815); this
|
||||
//! measures clawhdf5 and h5py on the **same machine and file**, so the
|
||||
//! comparison is hardware-controlled. Absolute numbers are not comparable to
|
||||
//! the paper's (different box, smaller frames, no torch/transform) — only
|
||||
//! clawhdf5-vs-h5py *here* is.
|
||||
//!
|
||||
//! clawhdf5 mmaps the file once and takes a zero-copy `&[u8]` over the
|
||||
//! contiguous observation dataset; frame `i` is a subslice, and the OS pages
|
||||
//! it in on access. Two modes, because fairness demands both:
|
||||
//! * default: sum the frame bytes through the zero-copy view — clawhdf5's
|
||||
//! real advantage, no per-frame allocation;
|
||||
//! * `--copy`: `to_vec()` each frame first, matching h5py's unavoidable
|
||||
//! per-frame numpy materialization, so the two do equal work.
|
||||
//!
|
||||
//! Usage: `... --example worldmodel_sampling -- <file.h5> [passes] [--copy]`
|
||||
|
||||
use std::hint::black_box;
|
||||
use std::time::Instant;
|
||||
|
||||
use clawhdf5::MmapFile;
|
||||
|
||||
fn main() {
|
||||
let args: Vec<String> = std::env::args().collect();
|
||||
let path = args
|
||||
.get(1)
|
||||
.expect("usage: worldmodel_sampling <file.h5> [passes] [--copy]");
|
||||
let passes: usize = args.get(2).and_then(|s| s.parse().ok()).unwrap_or(5);
|
||||
let copy = args.iter().any(|a| a == "--copy");
|
||||
|
||||
let file = MmapFile::open(path).expect("open");
|
||||
let ds = file.dataset("observation").expect("observation dataset");
|
||||
let shape = ds.shape().expect("shape");
|
||||
let n = shape[0] as usize;
|
||||
let frame_bytes: usize = shape[1..].iter().map(|&d| d as usize).product();
|
||||
let raw = ds
|
||||
.read_raw_slice()
|
||||
.expect("read_raw_slice")
|
||||
.expect("contiguous zero-copy slice");
|
||||
assert_eq!(raw.len(), n * frame_bytes, "unexpected dataset size");
|
||||
|
||||
let order = shuffled(n);
|
||||
|
||||
let touch = |slice: &[u8]| -> u64 {
|
||||
if copy {
|
||||
let owned = slice.to_vec();
|
||||
owned.iter().map(|&b| u64::from(b)).sum()
|
||||
} else {
|
||||
slice.iter().map(|&b| u64::from(b)).sum()
|
||||
}
|
||||
};
|
||||
|
||||
// Warm one pass (page-in), then time.
|
||||
let mut sink = 0u64;
|
||||
for &i in &order {
|
||||
sink = sink.wrapping_add(touch(&raw[i * frame_bytes..(i + 1) * frame_bytes]));
|
||||
}
|
||||
black_box(sink);
|
||||
|
||||
let t0 = Instant::now();
|
||||
let mut sink = 0u64;
|
||||
for _ in 0..passes {
|
||||
for &i in &order {
|
||||
sink = sink.wrapping_add(touch(&raw[i * frame_bytes..(i + 1) * frame_bytes]));
|
||||
}
|
||||
}
|
||||
black_box(sink);
|
||||
let elapsed = t0.elapsed().as_secs_f64();
|
||||
|
||||
let total = (n * passes) as f64;
|
||||
let mode = if copy {
|
||||
"materialized copy"
|
||||
} else {
|
||||
"zero-copy view"
|
||||
};
|
||||
println!("clawhdf5 ({mode}): {n} frames x {passes} passes in {elapsed:.3}s");
|
||||
println!("clawhdf5 ({mode}): {:.0} samples/sec", total / elapsed);
|
||||
}
|
||||
|
||||
fn shuffled(n: usize) -> Vec<usize> {
|
||||
let mut v: Vec<usize> = (0..n).collect();
|
||||
let mut state: u64 = 0x9E37_79B9_7F4A_7C15;
|
||||
for i in (1..n).rev() {
|
||||
state = state
|
||||
.wrapping_mul(6364136223846793005)
|
||||
.wrapping_add(1442695040888963407);
|
||||
let j = (state >> 33) as usize % (i + 1);
|
||||
v.swap(i, j);
|
||||
}
|
||||
v
|
||||
}
|
||||
@@ -22,7 +22,9 @@
|
||||
use std::time::Instant;
|
||||
|
||||
use clawhdf5_agent::bm25::BM25Index;
|
||||
use clawhdf5_agent::consolidation::{ConsolidationConfig, ConsolidationEngine, MemorySource};
|
||||
use clawhdf5_agent::consolidation::{
|
||||
ConsolidationConfig, ConsolidationEngine, TrustedSource, UntrustedSource,
|
||||
};
|
||||
use clawhdf5_agent::hybrid::hybrid_search;
|
||||
|
||||
const EMBEDDING_DIM: usize = 384;
|
||||
@@ -232,7 +234,7 @@ fn run_quality_benchmark() {
|
||||
for i in 0..SIGNAL_KEYWORDS.len() {
|
||||
let chunk = make_signal_content(i);
|
||||
let embedding = make_embedding(i * 1000);
|
||||
let id = engine.add_memory(chunk, embedding, MemorySource::Correction, now);
|
||||
let id = engine.add_trusted_memory(chunk, embedding, TrustedSource::Correction, now);
|
||||
signal_ids.push(id);
|
||||
}
|
||||
|
||||
@@ -240,7 +242,12 @@ fn run_quality_benchmark() {
|
||||
for i in 0..990 {
|
||||
let chunk = make_noise_content(i);
|
||||
let embedding = make_embedding(i + 100);
|
||||
engine.add_memory(chunk, embedding, MemorySource::System, now + i as f64 * 0.1);
|
||||
engine.add_trusted_memory(
|
||||
chunk,
|
||||
embedding,
|
||||
TrustedSource::System,
|
||||
now + i as f64 * 0.1,
|
||||
);
|
||||
}
|
||||
|
||||
println!(" → Inserted {} records total", engine.records().len());
|
||||
@@ -333,7 +340,7 @@ fn run_cycle_time_benchmark() {
|
||||
for i in 0..n {
|
||||
let chunk = make_noise_content(i);
|
||||
let embedding = make_embedding(i);
|
||||
engine.add_memory(chunk, embedding, MemorySource::User, now + i as f64);
|
||||
engine.add_memory(chunk, embedding, UntrustedSource::User, now + i as f64);
|
||||
}
|
||||
|
||||
// Warmup
|
||||
@@ -344,7 +351,7 @@ fn run_cycle_time_benchmark() {
|
||||
for i in n..(n * 2) {
|
||||
let chunk = make_noise_content(i);
|
||||
let embedding = make_embedding(i);
|
||||
engine.add_memory(chunk, embedding, MemorySource::User, now + i as f64);
|
||||
engine.add_memory(chunk, embedding, UntrustedSource::User, now + i as f64);
|
||||
}
|
||||
|
||||
// Timed consolidation
|
||||
@@ -410,13 +417,13 @@ fn run_memory_reduction_benchmark() {
|
||||
for i in 0..signal_count {
|
||||
let chunk = make_signal_content(i % SIGNAL_KEYWORDS.len());
|
||||
let emb = make_embedding(i * 999);
|
||||
let id = engine.add_memory(chunk, emb, MemorySource::Correction, now);
|
||||
let id = engine.add_trusted_memory(chunk, emb, TrustedSource::Correction, now);
|
||||
signal_ids.push(id);
|
||||
}
|
||||
for i in 0..noise_count {
|
||||
let chunk = make_noise_content(i);
|
||||
let emb = make_embedding(i + 200);
|
||||
engine.add_memory(chunk, emb, MemorySource::System, now + i as f64 * 0.1);
|
||||
engine.add_trusted_memory(chunk, emb, TrustedSource::System, now + i as f64 * 0.1);
|
||||
}
|
||||
|
||||
// Access signal records heavily
|
||||
|
||||
@@ -4,11 +4,39 @@
|
||||
//! Since no embedding model is available at bench time, all embeddings are zero vectors
|
||||
//! and `hybrid_search` operates in BM25-only mode (vector_weight=0.0, keyword_weight=1.0).
|
||||
//!
|
||||
//! This matches the MemX paper methodology: evaluate retrieval recall, not answer generation.
|
||||
//! # Scoring target (read before citing any number from this harness)
|
||||
//!
|
||||
//! - **Metric: retrieval recall.** A "hit" means the gold-labelled memory appeared in
|
||||
//! the top-k. No answer is generated and none is scored — the dataset's `answer`
|
||||
//! field is deserialized and deliberately never read. This is **not** the official
|
||||
//! LongMemEval metric, which is end-to-end QA accuracy (retrieve → generate → LLM
|
||||
//! judge). Reporting retrieval recall as QA accuracy overstates by 20–30 points.
|
||||
//! - **Dataset: whichever variant you point it at.** Both `longmemeval_oracle`
|
||||
//! (evidence sessions only — a substantially easier corpus) and the full
|
||||
//! `longmemeval_s` haystack are supported. The harness does not trust the
|
||||
//! filename: [`DatasetProfile`] measures evidence-session density from the
|
||||
//! data and labels the run from that, so a mislabelled input cannot produce a
|
||||
//! mislabelled result.
|
||||
//! - **Session-level metrics are degenerate when evidence density is high**, and
|
||||
//! the report says so per run rather than assuming it. On the oracle variant
|
||||
//! the haystack is essentially all-evidence, so any returned document is a
|
||||
//! session-level hit at rank 0 by construction; only turn-level
|
||||
//! (`has_answer == true` on the source turn) measures the retriever there. On
|
||||
//! the full haystack, session-level recall is meaningful.
|
||||
//! - **Not comparable to MemX's Hit@5=51.6% / MRR=0.380**, which is *fact-level*
|
||||
//! granularity over 220,349 records from 19,195 sessions.
|
||||
//!
|
||||
//! See `BENCHMARKS.md` § "Retracted: session-level recall and the MemX comparison".
|
||||
//!
|
||||
//! # Usage
|
||||
//! ```
|
||||
//! cargo run --release --bin longmemeval_bench [path/to/longmemeval_oracle.json]
|
||||
//! cargo run --release --bin longmemeval_bench [PATH] [--limit N]
|
||||
//!
|
||||
//! # Usage: full haystack
|
||||
//! ```
|
||||
//! cargo run --release --bin longmemeval_bench -- \
|
||||
//! benchmarks/longmemeval/longmemeval_s_cleaned.json --limit 50
|
||||
//! ```
|
||||
//! ```
|
||||
//!
|
||||
//! # WASM Note
|
||||
@@ -21,12 +49,80 @@
|
||||
use std::collections::{HashMap, HashSet};
|
||||
use std::time::{Duration, Instant};
|
||||
|
||||
// `#[path]` keeps the module beside its binary without Cargo autodiscovering it
|
||||
// as a second bin target (which a bare `src/bin/embedder.rs` would be).
|
||||
#[cfg(feature = "embeddings")]
|
||||
#[path = "longmemeval_bench/embedder.rs"]
|
||||
mod embedder;
|
||||
|
||||
use clawhdf5_agent::{AgentMemory, HDF5Memory, MemoryConfig, MemoryEntry};
|
||||
use serde::Deserialize;
|
||||
use tempfile::TempDir;
|
||||
|
||||
const EMBEDDING_DIM: usize = 384;
|
||||
|
||||
/// A retrieval configuration: how much of the score comes from each stage.
|
||||
#[derive(Clone, Copy)]
|
||||
struct Mode {
|
||||
label: &'static str,
|
||||
vector_weight: f32,
|
||||
keyword_weight: f32,
|
||||
}
|
||||
|
||||
/// The only mode available without real embeddings. Passing zero vectors with
|
||||
/// `vector_weight = 0.0` is what made the vector stage inert.
|
||||
const BM25_ONLY: Mode = Mode {
|
||||
label: "BM25 only (vector stage inert)",
|
||||
vector_weight: 0.0,
|
||||
keyword_weight: 1.0,
|
||||
};
|
||||
#[cfg(feature = "embeddings")]
|
||||
const VECTOR_ONLY: Mode = Mode {
|
||||
label: "Vector only (MiniLM + HNSW)",
|
||||
vector_weight: 1.0,
|
||||
keyword_weight: 0.0,
|
||||
};
|
||||
/// Tuned by `--sweep` over the full haystack. The former 0.7/0.3 was a
|
||||
/// documented default that had never been searched, and the sweep found it
|
||||
/// strictly dominated: 0.4/0.6 is better on Hit@1, Hit@5, Hit@10 and MRR at
|
||||
/// both granularities.
|
||||
#[cfg(feature = "embeddings")]
|
||||
const HYBRID: Mode = Mode {
|
||||
label: "Hybrid (0.4 vector / 0.6 BM25, tuned)",
|
||||
vector_weight: 0.4,
|
||||
keyword_weight: 0.6,
|
||||
};
|
||||
|
||||
/// Every 0.1 step of vector weight, keyword weight taking the remainder.
|
||||
///
|
||||
/// Labels are leaked to `&'static str` because `Mode::label` is a `&'static
|
||||
/// str` for the eleven named modes and a sweep is a short-lived process; the
|
||||
/// alternative is threading a lifetime through the whole report path for a
|
||||
/// diagnostic mode.
|
||||
#[cfg(feature = "embeddings")]
|
||||
fn sweep_modes() -> Vec<Mode> {
|
||||
(0..=10)
|
||||
.map(|i| {
|
||||
let v = i as f32 / 10.0;
|
||||
Mode {
|
||||
label: Box::leak(format!("sweep v={v:.1} / k={:.1}", 1.0 - v).into_boxed_str()),
|
||||
vector_weight: v,
|
||||
keyword_weight: 1.0 - v,
|
||||
}
|
||||
})
|
||||
.collect()
|
||||
}
|
||||
|
||||
/// Text -> embedding, built once for the whole corpus.
|
||||
type EmbeddingMap = HashMap<String, Vec<f32>>;
|
||||
|
||||
/// Look up a real embedding, falling back to zeros when running BM25-only.
|
||||
fn embedding_for(map: Option<&EmbeddingMap>, text: &str) -> Vec<f32> {
|
||||
map.and_then(|m| m.get(text))
|
||||
.cloned()
|
||||
.unwrap_or_else(|| vec![0.0f32; EMBEDDING_DIM])
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// JSON data types
|
||||
// ---------------------------------------------------------------------------
|
||||
@@ -168,7 +264,12 @@ struct EvalResult {
|
||||
latency: Duration,
|
||||
}
|
||||
|
||||
fn evaluate_question(q: &Question, top_k: usize) -> EvalResult {
|
||||
fn evaluate_question(
|
||||
q: &Question,
|
||||
top_k: usize,
|
||||
mode: Mode,
|
||||
embeddings: Option<&EmbeddingMap>,
|
||||
) -> EvalResult {
|
||||
let dir = TempDir::new().expect("failed to create temp dir");
|
||||
let mut config = MemoryConfig::new(dir.path().join("lme.h5"), "lme-bench", EMBEDDING_DIM);
|
||||
config.wal_enabled = false;
|
||||
@@ -190,7 +291,7 @@ fn evaluate_question(q: &Question, top_k: usize) -> EvalResult {
|
||||
for turn in session {
|
||||
entries.push(MemoryEntry {
|
||||
chunk: turn.content.clone(),
|
||||
embedding: vec![0.0f32; EMBEDDING_DIM],
|
||||
embedding: embedding_for(embeddings, &turn.content),
|
||||
source_channel: "longmemeval".to_string(),
|
||||
timestamp: ts,
|
||||
session_id: sess_id.to_string(),
|
||||
@@ -218,10 +319,15 @@ fn evaluate_question(q: &Question, top_k: usize) -> EvalResult {
|
||||
// Set of session IDs that contain the answer
|
||||
let answer_sess_set: HashSet<&str> = q.answer_session_ids.iter().map(String::as_str).collect();
|
||||
|
||||
// Run hybrid search (BM25-only: vector_weight=0.0, keyword_weight=1.0)
|
||||
let zero_emb = vec![0.0f32; EMBEDDING_DIM];
|
||||
let query_emb = embedding_for(embeddings, &q.question);
|
||||
let t0 = Instant::now();
|
||||
let results = memory.hybrid_search(&zero_emb, &q.question, 0.0, 1.0, top_k);
|
||||
let results = memory.hybrid_search(
|
||||
&query_emb,
|
||||
&q.question,
|
||||
mode.vector_weight,
|
||||
mode.keyword_weight,
|
||||
top_k,
|
||||
);
|
||||
let latency = t0.elapsed();
|
||||
|
||||
// Session-level recall
|
||||
@@ -286,17 +392,133 @@ fn evaluate_question(q: &Question, top_k: usize) -> EvalResult {
|
||||
// Report printing
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
fn print_report(overall: &Metrics, by_type: &HashMap<String, Metrics>) {
|
||||
// ---------------------------------------------------------------------------
|
||||
// Dataset profile — measured, not assumed
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
/// Shape of the loaded corpus, computed from the data itself.
|
||||
///
|
||||
/// The variant used to be a hardcoded `"oracle"` string in the report and the
|
||||
/// JSON summary, so pointing the harness at `longmemeval_s` would have produced
|
||||
/// full-haystack numbers labelled oracle. Everything here is derived from the
|
||||
/// questions instead, which means the label cannot drift from the corpus and a
|
||||
/// mislabelled input file cannot produce a mislabelled result.
|
||||
struct DatasetProfile {
|
||||
n_questions: usize,
|
||||
mean_sessions: f64,
|
||||
mean_turns: f64,
|
||||
/// Mean over questions of `|answer_sessions| / |haystack_sessions|`.
|
||||
///
|
||||
/// This is what actually decides whether session-level recall means
|
||||
/// anything. At ~1.0 every haystack session is an evidence session, so any
|
||||
/// returned document is a session-level hit by construction.
|
||||
evidence_density: f64,
|
||||
}
|
||||
|
||||
impl DatasetProfile {
|
||||
fn measure(questions: &[Question]) -> Self {
|
||||
let n = questions.len().max(1) as f64;
|
||||
let mut sessions = 0.0;
|
||||
let mut turns = 0.0;
|
||||
let mut density = 0.0;
|
||||
for q in questions {
|
||||
let n_sess = q.haystack_sessions.len();
|
||||
sessions += n_sess as f64;
|
||||
turns += q.haystack_sessions.iter().map(Vec::len).sum::<usize>() as f64;
|
||||
if n_sess > 0 {
|
||||
let evidence: HashSet<&str> =
|
||||
q.answer_session_ids.iter().map(String::as_str).collect();
|
||||
let hit = q
|
||||
.haystack_session_ids
|
||||
.iter()
|
||||
.filter(|id| evidence.contains(id.as_str()))
|
||||
.count();
|
||||
density += hit as f64 / n_sess as f64;
|
||||
}
|
||||
}
|
||||
Self {
|
||||
n_questions: questions.len(),
|
||||
mean_sessions: sessions / n,
|
||||
mean_turns: turns / n,
|
||||
evidence_density: density / n,
|
||||
}
|
||||
}
|
||||
|
||||
/// Above this share of evidence sessions, session-level recall is measuring
|
||||
/// the corpus shape rather than the retriever.
|
||||
const DEGENERACY_THRESHOLD: f64 = 0.9;
|
||||
|
||||
const fn session_level_degenerate(&self) -> bool {
|
||||
self.evidence_density > Self::DEGENERACY_THRESHOLD
|
||||
}
|
||||
|
||||
/// Variant name inferred from evidence density, not from the filename.
|
||||
const fn variant(&self) -> &'static str {
|
||||
if self.session_level_degenerate() {
|
||||
"oracle"
|
||||
} else {
|
||||
"full_haystack"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
fn print_report(
|
||||
overall: &Metrics,
|
||||
by_type: &HashMap<String, Metrics>,
|
||||
profile: &DatasetProfile,
|
||||
mode: Mode,
|
||||
) {
|
||||
println!("=================================================================");
|
||||
println!(" LongMemEval Benchmark (BM25-only retrieval, zero embeddings)");
|
||||
println!(" LongMemEval Benchmark — {}", mode.label);
|
||||
println!("=================================================================");
|
||||
println!();
|
||||
println!("Mode: vector_weight=0.0 / keyword_weight=1.0 (pure BM25)");
|
||||
println!("Note: MemX (arxiv:2603.16171) with full system: Hit@5=51.6%, MRR=0.380");
|
||||
println!(" BM25-only numbers are expected to be lower — honest baseline.");
|
||||
println!(
|
||||
"Mode: vector_weight={:.1} / keyword_weight={:.1}",
|
||||
mode.vector_weight, mode.keyword_weight
|
||||
);
|
||||
println!();
|
||||
println!("Scoring target: RETRIEVAL RECALL (did the gold memory land in top-k).");
|
||||
println!(" No answer is generated or scored. This is NOT the official");
|
||||
println!(" LongMemEval metric (QA accuracy via retrieve+generate+judge).");
|
||||
println!(
|
||||
"Dataset: {} — {} questions, {:.1} sessions and {:.0} turns per question,",
|
||||
profile.variant(),
|
||||
profile.n_questions,
|
||||
profile.mean_sessions,
|
||||
profile.mean_turns,
|
||||
);
|
||||
println!(
|
||||
" {:.1}% of haystack sessions are evidence sessions.",
|
||||
profile.evidence_density * 100.0
|
||||
);
|
||||
if profile.session_level_degenerate() {
|
||||
println!(" This is the evidence-only corpus, NOT the full longmemeval_s");
|
||||
println!(" haystack — a substantially easier retrieval problem.");
|
||||
} else {
|
||||
println!(" This is a full-haystack corpus: evidence sessions are a small");
|
||||
println!(" minority, so retrieval has to actually discriminate.");
|
||||
}
|
||||
println!();
|
||||
println!("Do NOT compare these to MemX's Hit@5=51.6% / MRR=0.380: that is");
|
||||
println!(" fact-level granularity over 220,349 records from 19,195 sessions.");
|
||||
println!(" Different granularity and a corpus larger by orders of magnitude.");
|
||||
println!();
|
||||
|
||||
println!("## Session-Level Recall (n={})", overall.count);
|
||||
if profile.session_level_degenerate() {
|
||||
println!(
|
||||
" [DEGENERATE — {:.1}% of haystack sessions are evidence sessions, so a",
|
||||
profile.evidence_density * 100.0
|
||||
);
|
||||
println!(" returned document is a session-level hit almost by construction.");
|
||||
println!(" This measures the corpus shape, not the retriever. Use turn-level.]");
|
||||
} else {
|
||||
println!(
|
||||
" [Meaningful on this corpus — only {:.1}% of haystack sessions are",
|
||||
profile.evidence_density * 100.0
|
||||
);
|
||||
println!(" evidence sessions, so a hit reflects the retriever's discrimination.]");
|
||||
}
|
||||
println!(
|
||||
" Hit@1: {:5.1}% Hit@5: {:5.1}% Hit@10: {:5.1}% MRR: {:.4}",
|
||||
overall.hit1_session_pct(),
|
||||
@@ -380,7 +602,26 @@ fn print_report(overall: &Metrics, by_type: &HashMap<String, Metrics>) {
|
||||
println!("```json");
|
||||
println!("{{");
|
||||
println!(" \"benchmark\": \"longmemeval\",");
|
||||
println!(" \"mode\": \"bm25_only\",");
|
||||
println!(
|
||||
" \"mode\": \"vector_{:.1}_keyword_{:.1}\",",
|
||||
mode.vector_weight, mode.keyword_weight
|
||||
);
|
||||
println!(" \"dataset_variant\": \"{}\",", profile.variant());
|
||||
println!(" \"scoring_target\": \"retrieval_recall\",");
|
||||
println!(" \"k\": 10,");
|
||||
println!(
|
||||
" \"session_level_degenerate\": {},",
|
||||
profile.session_level_degenerate()
|
||||
);
|
||||
println!(
|
||||
" \"evidence_session_density\": {:.4},",
|
||||
profile.evidence_density
|
||||
);
|
||||
println!(
|
||||
" \"mean_sessions_per_question\": {:.2},",
|
||||
profile.mean_sessions
|
||||
);
|
||||
println!(" \"mean_turns_per_question\": {:.1},", profile.mean_turns);
|
||||
println!(
|
||||
" \"total_questions\": {},",
|
||||
overall.count + overall.abstention_total
|
||||
@@ -403,10 +644,16 @@ fn print_report(overall: &Metrics, by_type: &HashMap<String, Metrics>) {
|
||||
overall.mrr_turn()
|
||||
);
|
||||
println!(" }},");
|
||||
println!(
|
||||
" \"abstention_accuracy\": {:.4},",
|
||||
overall.abstention_pct() / 100.0
|
||||
);
|
||||
// `null`, not 0.0 — a corpus with no abstention questions has no abstention
|
||||
// accuracy, and emitting 0.0 reads as total failure at a task never posed.
|
||||
if overall.abstention_total > 0 {
|
||||
println!(
|
||||
" \"abstention_accuracy\": {:.4},",
|
||||
overall.abstention_pct() / 100.0
|
||||
);
|
||||
} else {
|
||||
println!(" \"abstention_accuracy\": null,");
|
||||
}
|
||||
println!(" \"latency_us\": {{");
|
||||
println!(
|
||||
" \"avg\": {:.1}, \"p50\": {:.1}, \"p95\": {:.1}, \"p99\": {:.1}",
|
||||
@@ -425,17 +672,152 @@ fn print_report(overall: &Metrics, by_type: &HashMap<String, Metrics>) {
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
fn main() {
|
||||
let json_path = std::env::args()
|
||||
.nth(1)
|
||||
.unwrap_or_else(|| "benchmarks/longmemeval/longmemeval_oracle.json".to_string());
|
||||
let mut json_path: Option<String> = None;
|
||||
let mut limit: Option<usize> = None;
|
||||
let mut weights_dir: Option<String> = None;
|
||||
let mut sweep = false;
|
||||
let mut args = std::env::args().skip(1);
|
||||
while let Some(arg) = args.next() {
|
||||
match arg.as_str() {
|
||||
"--limit" => {
|
||||
let v = args.next().expect("--limit needs a value");
|
||||
limit = Some(v.parse().expect("--limit must be a positive integer"));
|
||||
}
|
||||
"--sweep" => sweep = true,
|
||||
"--embeddings" => {
|
||||
weights_dir = Some(args.next().expect("--embeddings needs a directory"));
|
||||
}
|
||||
"--help" | "-h" => {
|
||||
eprintln!(
|
||||
"usage: longmemeval_bench [PATH] [--limit N]\n\n\
|
||||
PATH dataset JSON; defaults to the oracle variant.\n\
|
||||
longmemeval_s works too — the harness measures which\n\
|
||||
variant it was given rather than trusting the filename.\n\
|
||||
--limit evaluate N questions, sampled evenly across the file\n\
|
||||
rather than as a prefix — the dataset is ordered by\n\
|
||||
question type, so a prefix samples one type only.\n\
|
||||
--embeddings DIR\n\
|
||||
directory holding all-MiniLM-L6-v2's model.safetensors\n\
|
||||
and tokenizer.json. Enables the vector stage and reports\n\
|
||||
BM25-only, vector-only, and hybrid separately. Requires\n\
|
||||
--features embeddings; without it the vector stage is\n\
|
||||
inert and only the BM25 row is produced.\n\
|
||||
--sweep instead of the three named modes, sweep vector_weight\n\
|
||||
from 0.0 to 1.0 in 0.1 steps. The 0.7/0.3 default was\n\
|
||||
never searched; this is what searches it."
|
||||
);
|
||||
return;
|
||||
}
|
||||
other => json_path = Some(other.to_string()),
|
||||
}
|
||||
}
|
||||
let json_path =
|
||||
json_path.unwrap_or_else(|| "benchmarks/longmemeval/longmemeval_oracle.json".to_string());
|
||||
|
||||
eprintln!("Loading: {json_path}");
|
||||
let data = std::fs::read_to_string(&json_path)
|
||||
.unwrap_or_else(|e| panic!("Failed to read {json_path}: {e}"));
|
||||
let questions: Vec<Question> = serde_json::from_str(&data).expect("Failed to parse JSON");
|
||||
let mut questions: Vec<Question> = serde_json::from_str(&data).expect("Failed to parse JSON");
|
||||
if let Some(n) = limit
|
||||
&& n < questions.len()
|
||||
{
|
||||
// Stride rather than truncate. The dataset is ordered by question type,
|
||||
// so taking a prefix samples one type: `--limit 20` on longmemeval_s
|
||||
// returns 20 `single-session-user` questions and nothing else, which
|
||||
// reads as a whole-dataset result but is not one.
|
||||
let total = questions.len();
|
||||
let step = total as f64 / n as f64;
|
||||
let keep: HashSet<usize> = (0..n)
|
||||
.map(|i| ((i as f64 * step) as usize).min(total - 1))
|
||||
.collect();
|
||||
questions = questions
|
||||
.into_iter()
|
||||
.enumerate()
|
||||
.filter(|(i, _)| keep.contains(i))
|
||||
.map(|(_, q)| q)
|
||||
.collect();
|
||||
eprintln!(
|
||||
"Sampling {} of {total} questions, evenly strided (--limit)",
|
||||
questions.len()
|
||||
);
|
||||
}
|
||||
let total = questions.len();
|
||||
eprintln!("Loaded {total} questions");
|
||||
|
||||
let profile = DatasetProfile::measure(&questions);
|
||||
eprintln!(
|
||||
"Corpus: {} variant — {:.1} sessions / {:.0} turns per question, \
|
||||
{:.1}% evidence-session density",
|
||||
profile.variant(),
|
||||
profile.mean_sessions,
|
||||
profile.mean_turns,
|
||||
profile.evidence_density * 100.0,
|
||||
);
|
||||
|
||||
// Build the embedding table once for the whole corpus, if asked for.
|
||||
let embeddings: Option<EmbeddingMap> = weights_dir
|
||||
.as_deref()
|
||||
.map(|dir| load_embeddings(dir, &questions));
|
||||
if embeddings.is_none() && weights_dir.is_some() {
|
||||
eprintln!("warning: --embeddings ignored (build with --features embeddings)");
|
||||
}
|
||||
|
||||
let modes: Vec<Mode> = if embeddings.is_some() {
|
||||
#[cfg(feature = "embeddings")]
|
||||
{
|
||||
if sweep {
|
||||
sweep_modes()
|
||||
} else {
|
||||
vec![BM25_ONLY, VECTOR_ONLY, HYBRID]
|
||||
}
|
||||
}
|
||||
#[cfg(not(feature = "embeddings"))]
|
||||
{
|
||||
vec![BM25_ONLY]
|
||||
}
|
||||
} else {
|
||||
if sweep {
|
||||
eprintln!("warning: --sweep needs --embeddings; running BM25 only");
|
||||
}
|
||||
vec![BM25_ONLY]
|
||||
};
|
||||
|
||||
for (mode_idx, mode) in modes.iter().enumerate() {
|
||||
eprintln!("[{}/{}] {}", mode_idx + 1, modes.len(), mode.label);
|
||||
run_mode(&questions, *mode, embeddings.as_ref(), &profile);
|
||||
}
|
||||
}
|
||||
|
||||
/// Load and encode the corpus. Returns `None` unless the `embeddings` feature
|
||||
/// is compiled in, so the flag degrades to a warning rather than a hard error.
|
||||
#[cfg(feature = "embeddings")]
|
||||
fn load_embeddings(dir: &str, questions: &[Question]) -> EmbeddingMap {
|
||||
let enc = embedder::Embedder::load(std::path::Path::new(dir))
|
||||
.unwrap_or_else(|e| panic!("failed to load embedder from {dir}: {e}"));
|
||||
let texts = questions.iter().flat_map(|q| {
|
||||
q.haystack_sessions
|
||||
.iter()
|
||||
.flatten()
|
||||
.map(|t| t.content.clone())
|
||||
.chain(std::iter::once(q.question.clone()))
|
||||
});
|
||||
enc.encode_unique(texts)
|
||||
.unwrap_or_else(|e| panic!("embedding failed: {e}"))
|
||||
}
|
||||
|
||||
#[cfg(not(feature = "embeddings"))]
|
||||
fn load_embeddings(_dir: &str, _questions: &[Question]) -> EmbeddingMap {
|
||||
EmbeddingMap::new()
|
||||
}
|
||||
|
||||
/// Evaluate every question under one retrieval mode and print its report.
|
||||
fn run_mode(
|
||||
questions: &[Question],
|
||||
mode: Mode,
|
||||
embeddings: Option<&EmbeddingMap>,
|
||||
profile: &DatasetProfile,
|
||||
) {
|
||||
let total = questions.len();
|
||||
let mut overall = Metrics::default();
|
||||
let mut by_type: HashMap<String, Metrics> = HashMap::new();
|
||||
|
||||
@@ -444,7 +826,7 @@ fn main() {
|
||||
eprint!("\r [{}/{}] evaluating...", i + 1, total);
|
||||
}
|
||||
|
||||
let result = evaluate_question(q, 10);
|
||||
let result = evaluate_question(q, 10, mode, embeddings);
|
||||
|
||||
let is_abs = q.question_type.ends_with("_abs");
|
||||
let base_type = if is_abs {
|
||||
@@ -509,5 +891,5 @@ fn main() {
|
||||
|
||||
eprintln!("\r [{total}/{total}] done. ");
|
||||
eprintln!();
|
||||
print_report(&overall, &by_type);
|
||||
print_report(&overall, &by_type, profile, mode);
|
||||
}
|
||||
|
||||
@@ -0,0 +1,170 @@
|
||||
//! Optional MiniLM sentence embedder for the LongMemEval bench.
|
||||
//!
|
||||
//! Compiled only under the `embeddings` feature, so the default build of a
|
||||
//! project that prides itself on having no heavyweight dependencies stays
|
||||
//! exactly as it was. Without it the bench runs BM25-only, as it always has.
|
||||
//!
|
||||
//! Loads `sentence-transformers/all-MiniLM-L6-v2` — the same checkpoint
|
||||
//! omni-cortex uses — and produces 384-d mean-pooled, L2-normalised sentence
|
||||
//! embeddings, which is the published recipe for this model (mean over token
|
||||
//! states weighted by the attention mask, *not* the `[CLS]` pooler output).
|
||||
|
||||
use std::collections::HashMap;
|
||||
use std::path::Path;
|
||||
|
||||
use candle_core::{DType, Device, Tensor};
|
||||
use candle_nn::VarBuilder;
|
||||
use candle_transformers::models::bert::{BertModel, Config, HiddenAct};
|
||||
use tokenizers::Tokenizer;
|
||||
|
||||
/// Sequences encoded per forward pass. Larger batches amortise the transformer
|
||||
/// call; 64 keeps peak memory modest while still saturating a CPU.
|
||||
const BATCH: usize = 64;
|
||||
|
||||
/// A loaded MiniLM encoder.
|
||||
pub struct Embedder {
|
||||
model: BertModel,
|
||||
tokenizer: Tokenizer,
|
||||
device: Device,
|
||||
}
|
||||
|
||||
impl Embedder {
|
||||
/// Load from a directory holding `model.safetensors` and `tokenizer.json`.
|
||||
///
|
||||
/// `config.json` is read when present; otherwise the published MiniLM-L6-v2
|
||||
/// architecture constants are used, which are pinned rather than guessed.
|
||||
pub fn load(dir: &Path) -> Result<Self, Box<dyn std::error::Error>> {
|
||||
// CUDA when the feature is on and a device is actually present; the CPU
|
||||
// path is correct but roughly two orders of magnitude slower, which is
|
||||
// the difference between minutes and most of a day on the full haystack.
|
||||
let device = match Device::new_cuda(0) {
|
||||
Ok(d) => {
|
||||
eprintln!("Embedder: CUDA device 0");
|
||||
d
|
||||
}
|
||||
Err(e) => {
|
||||
// Loud, because the CPU path is correct but ~100x slower: the
|
||||
// full longmemeval_s haystack is minutes on a GPU and most of a
|
||||
// day on 8 cores. Silently falling back looks like a hang.
|
||||
eprintln!("Embedder: CPU — CUDA unavailable ({e})");
|
||||
eprintln!(
|
||||
" WARNING: CPU embedding is roughly two orders of magnitude slower.\n Expect minutes for longmemeval_oracle and many hours for the full\n longmemeval_s haystack. For the GPU path, rebuild with\n `--features embeddings-cuda` and make sure `nvcc` is on PATH\n (it ships in /usr/local/cuda/bin, which is often not exported)."
|
||||
);
|
||||
Device::Cpu
|
||||
}
|
||||
};
|
||||
let weights = dir.join("model.safetensors");
|
||||
let tok_path = dir.join("tokenizer.json");
|
||||
|
||||
let config: Config = match std::fs::read_to_string(dir.join("config.json")) {
|
||||
Ok(raw) => serde_json::from_str(&raw)?,
|
||||
Err(_) => Config {
|
||||
vocab_size: 30_522,
|
||||
hidden_size: 384,
|
||||
num_hidden_layers: 6,
|
||||
num_attention_heads: 12,
|
||||
intermediate_size: 1_536,
|
||||
hidden_act: HiddenAct::Gelu,
|
||||
hidden_dropout_prob: 0.0,
|
||||
max_position_embeddings: 512,
|
||||
type_vocab_size: 2,
|
||||
initializer_range: 0.02,
|
||||
layer_norm_eps: 1e-12,
|
||||
pad_token_id: 0,
|
||||
position_embedding_type: Default::default(),
|
||||
use_cache: false,
|
||||
classifier_dropout: None,
|
||||
model_type: None,
|
||||
},
|
||||
};
|
||||
|
||||
let vb = unsafe { VarBuilder::from_mmaped_safetensors(&[weights], DType::F32, &device)? };
|
||||
let model = BertModel::load(vb, &config)?;
|
||||
let tokenizer = Tokenizer::from_file(&tok_path).map_err(|e| e.to_string())?;
|
||||
|
||||
Ok(Self {
|
||||
model,
|
||||
tokenizer,
|
||||
device,
|
||||
})
|
||||
}
|
||||
|
||||
/// Encode `texts` into 384-d unit vectors, in order.
|
||||
fn encode_batch(&self, texts: &[&str]) -> Result<Vec<Vec<f32>>, Box<dyn std::error::Error>> {
|
||||
let mut tk = self.tokenizer.clone();
|
||||
let tk = tk
|
||||
.with_padding(Some(tokenizers::PaddingParams::default()))
|
||||
.with_truncation(Some(tokenizers::TruncationParams {
|
||||
max_length: 512,
|
||||
..Default::default()
|
||||
}))
|
||||
.map_err(|e| e.to_string())?;
|
||||
let encodings = tk
|
||||
.encode_batch(texts.to_vec(), true)
|
||||
.map_err(|e| e.to_string())?;
|
||||
|
||||
let ids: Vec<u32> = encodings
|
||||
.iter()
|
||||
.flat_map(|e| e.get_ids().to_vec())
|
||||
.collect();
|
||||
let mask: Vec<u32> = encodings
|
||||
.iter()
|
||||
.flat_map(|e| e.get_attention_mask().to_vec())
|
||||
.collect();
|
||||
let (b, l) = (encodings.len(), encodings[0].get_ids().len());
|
||||
|
||||
let ids = Tensor::from_vec(ids, (b, l), &self.device)?;
|
||||
let mask = Tensor::from_vec(mask, (b, l), &self.device)?;
|
||||
let type_ids = ids.zeros_like()?;
|
||||
|
||||
let hidden = self.model.forward(&ids, &type_ids, Some(&mask))?;
|
||||
|
||||
// Mean-pool over real tokens only: sum(hidden * mask) / sum(mask).
|
||||
let mask_f = mask.to_dtype(DType::F32)?.unsqueeze(2)?;
|
||||
let summed = hidden.broadcast_mul(&mask_f)?.sum(1)?;
|
||||
let counts = mask_f.sum(1)?.clamp(1e-9, f32::INFINITY)?;
|
||||
let pooled = summed.broadcast_div(&counts)?;
|
||||
|
||||
// L2-normalise so cosine similarity is a plain dot product.
|
||||
let norm = pooled
|
||||
.sqr()?
|
||||
.sum_keepdim(1)?
|
||||
.sqrt()?
|
||||
.clamp(1e-12, f32::INFINITY)?;
|
||||
let normed = pooled.broadcast_div(&norm)?;
|
||||
|
||||
Ok(normed.to_vec2::<f32>()?)
|
||||
}
|
||||
|
||||
/// Encode every distinct string in `texts` once, returning a lookup map.
|
||||
///
|
||||
/// LongMemEval's haystack sessions are drawn from a shared pool, so the same
|
||||
/// turn text recurs across many questions. Deduplicating before encoding is
|
||||
/// the difference between encoding the corpus once and encoding it per
|
||||
/// question.
|
||||
pub fn encode_unique(
|
||||
&self,
|
||||
texts: impl IntoIterator<Item = String>,
|
||||
) -> Result<HashMap<String, Vec<f32>>, Box<dyn std::error::Error>> {
|
||||
let mut unique: Vec<String> = texts.into_iter().collect();
|
||||
unique.sort_unstable();
|
||||
unique.dedup();
|
||||
|
||||
let total = unique.len();
|
||||
eprintln!("Embedding {total} unique texts with MiniLM (batch {BATCH})...");
|
||||
|
||||
let mut out = HashMap::with_capacity(total);
|
||||
for (n, chunk) in unique.chunks(BATCH).enumerate() {
|
||||
let refs: Vec<&str> = chunk.iter().map(String::as_str).collect();
|
||||
let vecs = self.encode_batch(&refs)?;
|
||||
for (text, v) in chunk.iter().zip(vecs) {
|
||||
out.insert(text.clone(), v);
|
||||
}
|
||||
if n % 50 == 0 {
|
||||
eprint!("\r [{}/{}] embedded...", (n * BATCH).min(total), total);
|
||||
}
|
||||
}
|
||||
eprintln!("\r [{total}/{total}] embedded. ");
|
||||
Ok(out)
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,67 @@
|
||||
//! h5bench-equivalent MPI-IO performance benchmark.
|
||||
//!
|
||||
//! Usage: mpirun -np N cargo run -p clawhdf5-bench --features mpi-io --bin mpi_io_bench -- --size <N>
|
||||
//!
|
||||
//! Measures collective write and read throughput in MB/s for f64 arrays.
|
||||
|
||||
#[cfg(feature = "mpi-io")]
|
||||
fn main() {
|
||||
use clawhdf5_io::mpi_vol::MpiVol;
|
||||
use clawhdf5_io::vol::VirtualObjectLayer;
|
||||
use mpi::traits::*;
|
||||
use std::time::Instant;
|
||||
|
||||
let args: Vec<String> = std::env::args().collect();
|
||||
let n_elements: usize = args
|
||||
.iter()
|
||||
.position(|a| a == "--size")
|
||||
.and_then(|i| args.get(i + 1))
|
||||
.and_then(|s| s.parse().ok())
|
||||
.unwrap_or(100_000);
|
||||
|
||||
let mut vol = MpiVol::new_world().expect("MPI init failed");
|
||||
let world = vol.universe.world();
|
||||
let rank = world.rank() as usize;
|
||||
let size = world.size() as usize;
|
||||
|
||||
let path = format!("/tmp/clawhdf5_mpiio_bench_{n_elements}.h5");
|
||||
vol.open(&path).unwrap();
|
||||
|
||||
// Each rank contributes n_elements/size f64 values
|
||||
let per_rank = n_elements / size;
|
||||
let shard: Vec<f64> = (0..per_rank)
|
||||
.map(|i| (rank * per_rank + i) as f64)
|
||||
.collect();
|
||||
let shard_bytes: Vec<u8> = shard.iter().flat_map(|v| v.to_le_bytes()).collect();
|
||||
|
||||
// Collective write
|
||||
world.barrier();
|
||||
let t0 = Instant::now();
|
||||
vol.write_dataset("data", &shard_bytes, &[n_elements as u64], "f64")
|
||||
.unwrap();
|
||||
world.barrier();
|
||||
let write_elapsed = t0.elapsed().as_secs_f64();
|
||||
|
||||
// Collective read
|
||||
let t1 = Instant::now();
|
||||
let _data = vol.read_dataset("data").unwrap();
|
||||
world.barrier();
|
||||
let read_elapsed = t1.elapsed().as_secs_f64();
|
||||
|
||||
if rank == 0 {
|
||||
let total_mb = (n_elements * 8) as f64 / 1e6;
|
||||
println!("=== clawhdf5 MPI-IO Benchmark ===");
|
||||
println!("Elements : {n_elements}");
|
||||
println!("Ranks : {size}");
|
||||
println!("Total : {total_mb:.1} MB");
|
||||
println!("Write : {:.1} MB/s", total_mb / write_elapsed);
|
||||
println!("Read : {:.1} MB/s", total_mb / read_elapsed);
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(not(feature = "mpi-io"))]
|
||||
fn main() {
|
||||
eprintln!("mpi_io_bench requires the `mpi-io` feature.");
|
||||
eprintln!("Run: mpirun -np N cargo run -p clawhdf5-bench --features mpi-io --bin mpi_io_bench");
|
||||
std::process::exit(1);
|
||||
}
|
||||
@@ -0,0 +1,508 @@
|
||||
//! Search measurement harness: recall vs. speed for the HNSW index, and
|
||||
//! end-to-end `hybrid_search` latency as the store grows.
|
||||
//!
|
||||
//! Every search-path change should be justified by a before/after run of this
|
||||
//! binary. It reports, for deterministic synthetic data:
|
||||
//!
|
||||
//! * **ANN** — index build time, and for each `ef`: recall@10 against an exact
|
||||
//! brute-force scan, queries/second, and p50/p99 latency.
|
||||
//! * **End to end** — `HDF5Memory`: ingest time, checkpoint time, `open()`
|
||||
//! time, the one-off cold index build (first query ever), the first query
|
||||
//! after a reopen, and steady-state `hybrid_search` p50/p99 at each size.
|
||||
//!
|
||||
//! Data is *clustered* (points = cluster centre + noise, unit-normalised), not
|
||||
//! uniform: uniform random high-dimensional vectors are nearly equidistant,
|
||||
//! which makes recall numbers meaningless and is nothing like embeddings.
|
||||
//!
|
||||
//! ```text
|
||||
//! cargo run --release -p clawhdf5-bench --bin search_harness # 1K, 10K
|
||||
//! cargo run --release -p clawhdf5-bench --bin search_harness -- --full # + 100K
|
||||
//! cargo run --release -p clawhdf5-bench --bin search_harness -- --json out.json
|
||||
//! cargo run --release -p clawhdf5-bench --bin search_harness -- --ann-only --uniform
|
||||
//! ```
|
||||
|
||||
use std::time::{Duration, Instant};
|
||||
|
||||
use clawhdf5_agent::{AgentMemory, HDF5Memory, MemoryConfig, MemoryEntry};
|
||||
use clawhdf5_ann::{DistanceMetric, HnswIndex};
|
||||
|
||||
const DIM: usize = 384;
|
||||
const K: usize = 10;
|
||||
const N_QUERIES: usize = 200;
|
||||
const HNSW_M: usize = 16;
|
||||
const HNSW_EF_CONSTRUCTION: usize = 64;
|
||||
const EF_VALUES: [usize; 5] = [16, 32, 64, 128, 256];
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Deterministic data
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
struct Rng(u64);
|
||||
|
||||
impl Rng {
|
||||
fn next_u64(&mut self) -> u64 {
|
||||
self.0 = self.0.wrapping_add(0x9E37_79B9_7F4A_7C15);
|
||||
let mut z = self.0;
|
||||
z = (z ^ (z >> 30)).wrapping_mul(0xBF58_476D_1CE4_E5B9);
|
||||
z = (z ^ (z >> 27)).wrapping_mul(0x94D0_49BB_1331_11EB);
|
||||
z ^ (z >> 31)
|
||||
}
|
||||
|
||||
/// Uniform in [0, 1).
|
||||
fn unit(&mut self) -> f32 {
|
||||
(self.next_u64() >> 40) as f32 / (1u64 << 24) as f32
|
||||
}
|
||||
|
||||
/// Approximately standard normal (sum of uniforms).
|
||||
fn gauss(&mut self) -> f32 {
|
||||
let sum: f32 = (0..6).map(|_| self.unit()).sum();
|
||||
(sum - 3.0) * std::f32::consts::SQRT_2
|
||||
}
|
||||
|
||||
fn below(&mut self, n: usize) -> usize {
|
||||
(self.next_u64() % n as u64) as usize
|
||||
}
|
||||
}
|
||||
|
||||
fn normalize(v: &mut [f32]) {
|
||||
let norm = v.iter().map(|x| x * x).sum::<f32>().sqrt();
|
||||
if norm > 0.0 {
|
||||
v.iter_mut().for_each(|x| *x /= norm);
|
||||
}
|
||||
}
|
||||
|
||||
struct Dataset {
|
||||
vectors: Vec<Vec<f32>>,
|
||||
queries: Vec<Vec<f32>>,
|
||||
/// Cluster id of each vector (used to give records topical text).
|
||||
cluster_of: Vec<usize>,
|
||||
query_cluster: Vec<usize>,
|
||||
}
|
||||
|
||||
/// `--uniform`: isotropic random unit vectors instead of clusters. Not a
|
||||
/// realistic workload, but a useful second distribution — a recall problem
|
||||
/// that appears only on clustered data points at graph connectivity.
|
||||
static UNIFORM: std::sync::atomic::AtomicBool = std::sync::atomic::AtomicBool::new(false);
|
||||
|
||||
fn make_dataset(n: usize, seed: u64) -> Dataset {
|
||||
let mut rng = Rng(seed);
|
||||
if UNIFORM.load(std::sync::atomic::Ordering::Relaxed) {
|
||||
let random_unit = |rng: &mut Rng| {
|
||||
let mut v: Vec<f32> = (0..DIM).map(|_| rng.gauss()).collect();
|
||||
normalize(&mut v);
|
||||
v
|
||||
};
|
||||
return Dataset {
|
||||
vectors: (0..n).map(|_| random_unit(&mut rng)).collect(),
|
||||
queries: (0..N_QUERIES).map(|_| random_unit(&mut rng)).collect(),
|
||||
cluster_of: vec![0; n],
|
||||
query_cluster: vec![0; N_QUERIES],
|
||||
};
|
||||
}
|
||||
let n_clusters = (n / 100).clamp(8, 512);
|
||||
let centres: Vec<Vec<f32>> = (0..n_clusters)
|
||||
.map(|_| {
|
||||
let mut c: Vec<f32> = (0..DIM).map(|_| rng.gauss()).collect();
|
||||
normalize(&mut c);
|
||||
c
|
||||
})
|
||||
.collect();
|
||||
let point = |rng: &mut Rng, cluster: usize| {
|
||||
// Noise comparable to the centre's per-dimension magnitude, so
|
||||
// clusters overlap and the nearest neighbours are non-trivial.
|
||||
let scale = 0.6 / (DIM as f32).sqrt();
|
||||
let mut v: Vec<f32> = centres[cluster]
|
||||
.iter()
|
||||
.map(|c| c + rng.gauss() * scale)
|
||||
.collect();
|
||||
normalize(&mut v);
|
||||
v
|
||||
};
|
||||
let mut vectors = Vec::with_capacity(n);
|
||||
let mut cluster_of = Vec::with_capacity(n);
|
||||
for _ in 0..n {
|
||||
let c = rng.below(n_clusters);
|
||||
vectors.push(point(&mut rng, c));
|
||||
cluster_of.push(c);
|
||||
}
|
||||
let mut queries = Vec::with_capacity(N_QUERIES);
|
||||
let mut query_cluster = Vec::with_capacity(N_QUERIES);
|
||||
for _ in 0..N_QUERIES {
|
||||
let c = rng.below(n_clusters);
|
||||
queries.push(point(&mut rng, c));
|
||||
query_cluster.push(c);
|
||||
}
|
||||
Dataset {
|
||||
vectors,
|
||||
queries,
|
||||
cluster_of,
|
||||
query_cluster,
|
||||
}
|
||||
}
|
||||
|
||||
const WORDS: &[&str] = &[
|
||||
"deploy", "latency", "cache", "schema", "index", "vector", "memory", "agent", "kernel",
|
||||
"buffer", "socket", "thread", "tensor", "gradient", "ledger", "invoice", "meeting", "roadmap",
|
||||
"customer", "contract", "sensor", "orbit", "protein", "genome", "harbor", "bridge", "engine",
|
||||
"battery", "harvest", "weather", "museum", "recipe",
|
||||
];
|
||||
|
||||
/// Text whose vocabulary is biased by cluster, so keyword and vector signals
|
||||
/// agree the way they do for real embedded text.
|
||||
fn text_for(cluster: usize, i: usize, rng: &mut Rng) -> String {
|
||||
let topic = [
|
||||
WORDS[cluster % WORDS.len()],
|
||||
WORDS[(cluster / 7 + 3) % WORDS.len()],
|
||||
];
|
||||
let mut words = Vec::with_capacity(14);
|
||||
for j in 0..14 {
|
||||
if j % 3 == 0 {
|
||||
words.push(topic[j / 3 % 2]);
|
||||
} else {
|
||||
words.push(WORDS[rng.below(WORDS.len())]);
|
||||
}
|
||||
}
|
||||
format!("record {i}: {}", words.join(" "))
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Measurement helpers
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
fn exact_top_k(vectors: &[Vec<f32>], query: &[f32], k: usize) -> Vec<usize> {
|
||||
// Vectors are unit length, so cosine order == dot-product order.
|
||||
let mut scored: Vec<(usize, f32)> = vectors
|
||||
.iter()
|
||||
.enumerate()
|
||||
.map(|(i, v)| (i, v.iter().zip(query).map(|(a, b)| a * b).sum()))
|
||||
.collect();
|
||||
scored.sort_by(|a, b| b.1.total_cmp(&a.1).then(a.0.cmp(&b.0)));
|
||||
scored.truncate(k);
|
||||
scored.into_iter().map(|(i, _)| i).collect()
|
||||
}
|
||||
|
||||
struct Latency {
|
||||
p50: Duration,
|
||||
p99: Duration,
|
||||
qps: f64,
|
||||
}
|
||||
|
||||
fn summarize(mut samples: Vec<Duration>) -> Latency {
|
||||
samples.sort();
|
||||
let total: Duration = samples.iter().sum();
|
||||
let at = |q: f64| samples[((samples.len() - 1) as f64 * q).round() as usize];
|
||||
Latency {
|
||||
p50: at(0.50),
|
||||
p99: at(0.99),
|
||||
qps: samples.len() as f64 / total.as_secs_f64(),
|
||||
}
|
||||
}
|
||||
|
||||
fn micros(d: Duration) -> f64 {
|
||||
d.as_secs_f64() * 1e6
|
||||
}
|
||||
|
||||
fn millis(d: Duration) -> f64 {
|
||||
d.as_secs_f64() * 1e3
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// ANN: recall vs speed
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
fn bench_ann(n: usize, json: &mut Vec<serde_json::Value>) {
|
||||
let data = make_dataset(n, 0xA11CE ^ n as u64);
|
||||
let truth: Vec<Vec<usize>> = data
|
||||
.queries
|
||||
.iter()
|
||||
.map(|q| exact_top_k(&data.vectors, q, K))
|
||||
.collect();
|
||||
|
||||
let started = Instant::now();
|
||||
let index = HnswIndex::build_with_metric(
|
||||
&data.vectors,
|
||||
HNSW_M,
|
||||
HNSW_EF_CONSTRUCTION,
|
||||
DistanceMetric::Cosine,
|
||||
);
|
||||
let build = started.elapsed();
|
||||
|
||||
// Exact scan baseline, for scale.
|
||||
let exact = summarize(
|
||||
data.queries
|
||||
.iter()
|
||||
.map(|q| {
|
||||
let t = Instant::now();
|
||||
std::hint::black_box(exact_top_k(&data.vectors, q, K));
|
||||
t.elapsed()
|
||||
})
|
||||
.collect(),
|
||||
);
|
||||
|
||||
println!(
|
||||
"\n### HNSW, N = {n}, dim = {DIM}, M = {HNSW_M}, ef_construction = {HNSW_EF_CONSTRUCTION}\n"
|
||||
);
|
||||
println!(
|
||||
"build: {:.1} ms ({:.0} vectors/s) · exact scan: {:.0} QPS, p50 {:.0} µs\n",
|
||||
millis(build),
|
||||
n as f64 / build.as_secs_f64(),
|
||||
exact.qps,
|
||||
micros(exact.p50)
|
||||
);
|
||||
println!("| ef | recall@{K} | QPS | p50 µs | p99 µs |");
|
||||
println!("|---:|---:|---:|---:|---:|");
|
||||
for ef in EF_VALUES {
|
||||
let mut hits = 0usize;
|
||||
let mut samples = Vec::with_capacity(data.queries.len());
|
||||
for (q, want) in data.queries.iter().zip(&truth) {
|
||||
let t = Instant::now();
|
||||
let got = index.search(q, K, ef);
|
||||
samples.push(t.elapsed());
|
||||
hits += got.iter().filter(|(id, _)| want.contains(id)).count();
|
||||
}
|
||||
let recall = hits as f64 / (K * data.queries.len()) as f64;
|
||||
let lat = summarize(samples);
|
||||
println!(
|
||||
"| {ef} | {recall:.4} | {:.0} | {:.0} | {:.0} |",
|
||||
lat.qps,
|
||||
micros(lat.p50),
|
||||
micros(lat.p99)
|
||||
);
|
||||
json.push(serde_json::json!({
|
||||
"bench": "hnsw", "n": n, "ef": ef, "recall_at_10": recall,
|
||||
"qps": lat.qps, "p50_us": micros(lat.p50), "p99_us": micros(lat.p99),
|
||||
"build_ms": millis(build),
|
||||
}));
|
||||
}
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// End to end: HDF5Memory::hybrid_search
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
fn bench_end_to_end(n: usize, json: &mut Vec<serde_json::Value>) {
|
||||
let data = make_dataset(n, 0xE2E ^ n as u64);
|
||||
let dir = tempfile::TempDir::new().unwrap();
|
||||
let path = dir.path().join("store.h5");
|
||||
let mut rng = Rng(7);
|
||||
|
||||
let entries: Vec<MemoryEntry> = data
|
||||
.vectors
|
||||
.iter()
|
||||
.enumerate()
|
||||
.map(|(i, v)| MemoryEntry {
|
||||
chunk: text_for(data.cluster_of[i], i, &mut rng),
|
||||
embedding: v.clone(),
|
||||
source_channel: "bench".into(),
|
||||
timestamp: i as f64,
|
||||
session_id: format!("s{}", i % 50),
|
||||
tags: format!("t{i}"),
|
||||
})
|
||||
.collect();
|
||||
let query_texts: Vec<String> = data
|
||||
.query_cluster
|
||||
.iter()
|
||||
.enumerate()
|
||||
.map(|(i, c)| text_for(*c, i, &mut rng))
|
||||
.collect();
|
||||
|
||||
let mut mem = HDF5Memory::create(MemoryConfig::new(path.clone(), "bench", DIM)).unwrap();
|
||||
let t = Instant::now();
|
||||
mem.save_batch(entries).unwrap();
|
||||
let ingest = t.elapsed();
|
||||
// The very first query builds the vector and keyword indexes from
|
||||
// scratch. It happens once per store, not once per session: the checkpoint
|
||||
// below saves the vector index, so a later `open()` reloads it.
|
||||
let t = Instant::now();
|
||||
std::hint::black_box(mem.hybrid_search(&data.queries[1], &query_texts[1], 0.7, 0.3, K));
|
||||
let cold_build = t.elapsed();
|
||||
|
||||
let t = Instant::now();
|
||||
mem.flush_wal().unwrap();
|
||||
let checkpoint = t.elapsed();
|
||||
drop(mem);
|
||||
|
||||
let t = Instant::now();
|
||||
let mut mem = HDF5Memory::open(&path).unwrap();
|
||||
let open = t.elapsed();
|
||||
|
||||
// The first query after open pays for whatever is rebuilt lazily.
|
||||
let t = Instant::now();
|
||||
std::hint::black_box(mem.hybrid_search(&data.queries[0], &query_texts[0], 0.7, 0.3, K));
|
||||
let first_query = t.elapsed();
|
||||
|
||||
// Fewer steady-state samples at large N: each query is currently O(N).
|
||||
let samples_wanted = if n >= 100_000 { 20 } else { N_QUERIES.min(100) };
|
||||
let steady = summarize(
|
||||
(0..samples_wanted)
|
||||
.map(|i| {
|
||||
let t = Instant::now();
|
||||
std::hint::black_box(mem.hybrid_search(
|
||||
&data.queries[i % N_QUERIES],
|
||||
&query_texts[i % N_QUERIES],
|
||||
0.7,
|
||||
0.3,
|
||||
K,
|
||||
));
|
||||
t.elapsed()
|
||||
})
|
||||
.collect(),
|
||||
);
|
||||
|
||||
println!(
|
||||
"| {n} | {:.0} | {:.0} | {:.1} | {:.1} | {:.1} | {:.2} | {:.2} | {:.1} |",
|
||||
millis(ingest),
|
||||
millis(cold_build),
|
||||
millis(checkpoint),
|
||||
millis(open),
|
||||
millis(first_query),
|
||||
millis(steady.p50),
|
||||
millis(steady.p99),
|
||||
steady.qps
|
||||
);
|
||||
json.push(serde_json::json!({
|
||||
"bench": "hybrid_search", "n": n,
|
||||
"ingest_ms": millis(ingest), "cold_index_build_ms": millis(cold_build),
|
||||
"checkpoint_ms": millis(checkpoint),
|
||||
"open_ms": millis(open), "first_query_ms": millis(first_query),
|
||||
"p50_ms": millis(steady.p50), "p99_ms": millis(steady.p99), "qps": steady.qps,
|
||||
}));
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Fusion study: does capping the keyword candidate pool change the ranking?
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
/// `hybrid_search` min-max normalises each signal over the candidates it is
|
||||
/// given. The vector stage supplies a pool of `max(8k, 64)`; the keyword stage
|
||||
/// supplies *every* matching record, which is what now dominates query time.
|
||||
/// This compares the current fusion with one whose keyword stage is capped to
|
||||
/// a pool, reporting how often the final top-k agree and what each costs.
|
||||
fn fusion_study(n: usize) {
|
||||
use clawhdf5_agent::bm25::BM25Index;
|
||||
use clawhdf5_agent::hybrid::merge_vector_keyword;
|
||||
|
||||
let data = make_dataset(n, 0xE2E ^ n as u64);
|
||||
let mut rng = Rng(7);
|
||||
let texts: Vec<String> = (0..n)
|
||||
.map(|i| text_for(data.cluster_of[i], i, &mut rng))
|
||||
.collect();
|
||||
let query_texts: Vec<String> = data
|
||||
.query_cluster
|
||||
.iter()
|
||||
.enumerate()
|
||||
.map(|(i, c)| text_for(*c, i, &mut rng))
|
||||
.collect();
|
||||
let bm25 = BM25Index::build(&texts, &vec![0u8; n]);
|
||||
let index = HnswIndex::build_with_metric(
|
||||
&data.vectors,
|
||||
HNSW_M,
|
||||
HNSW_EF_CONSTRUCTION,
|
||||
DistanceMetric::Cosine,
|
||||
);
|
||||
|
||||
let vec_pool = (K * 8).max(64);
|
||||
println!("\n### Fusion study, N = {n} (k = {K}, weights 0.7 / 0.3, vector pool {vec_pool})\n");
|
||||
println!(
|
||||
"| keyword pool | top-{K} overlap vs full | identical top-{K} | same #1 | keyword+merge µs |"
|
||||
);
|
||||
println!("|---:|---:|---:|---:|---:|");
|
||||
|
||||
let fuse = |q: usize, kw_pool: usize| -> (Vec<usize>, Duration) {
|
||||
let vec_scores: Vec<(usize, f32)> = index
|
||||
.search(&data.queries[q], vec_pool, vec_pool)
|
||||
.into_iter()
|
||||
.map(|(id, d)| (id, 1.0 - d))
|
||||
.collect();
|
||||
let t = Instant::now();
|
||||
let kw = bm25.search(&query_texts[q], kw_pool);
|
||||
let merged = merge_vector_keyword(vec_scores, kw, 0.7, 0.3, K);
|
||||
let took = t.elapsed();
|
||||
(merged.into_iter().map(|(id, _)| id).collect(), took)
|
||||
};
|
||||
|
||||
let full: Vec<(Vec<usize>, Duration)> = (0..N_QUERIES).map(|q| fuse(q, n)).collect();
|
||||
let full_time: Duration = full.iter().map(|f| f.1).sum();
|
||||
println!(
|
||||
"| all ({n}) | 1.0000 | 100.0% | 100.0% | {:.0} |",
|
||||
micros(full_time) / N_QUERIES as f64
|
||||
);
|
||||
for pool in [vec_pool, vec_pool * 4, 1000] {
|
||||
if pool >= n {
|
||||
continue;
|
||||
}
|
||||
let (mut overlap, mut identical, mut same_first) = (0usize, 0usize, 0usize);
|
||||
let mut time = Duration::ZERO;
|
||||
for (q, (want, _)) in full.iter().enumerate() {
|
||||
let (got, took) = fuse(q, pool);
|
||||
time += took;
|
||||
overlap += got.iter().filter(|id| want.contains(id)).count();
|
||||
identical += usize::from(&got == want);
|
||||
same_first += usize::from(got.first() == want.first());
|
||||
}
|
||||
println!(
|
||||
"| {pool} | {:.4} | {:.1}% | {:.1}% | {:.0} |",
|
||||
overlap as f64 / (K * N_QUERIES) as f64,
|
||||
100.0 * identical as f64 / N_QUERIES as f64,
|
||||
100.0 * same_first as f64 / N_QUERIES as f64,
|
||||
micros(time) / N_QUERIES as f64
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
fn main() {
|
||||
let args: Vec<String> = std::env::args().skip(1).collect();
|
||||
let full = args.iter().any(|a| a == "--full");
|
||||
let ann_only = args.iter().any(|a| a == "--ann-only");
|
||||
if args.iter().any(|a| a == "--fusion-study") {
|
||||
for &n in if full {
|
||||
&[10_000, 100_000][..]
|
||||
} else {
|
||||
&[10_000][..]
|
||||
} {
|
||||
fusion_study(n);
|
||||
}
|
||||
return;
|
||||
}
|
||||
if args.iter().any(|a| a == "--uniform") {
|
||||
UNIFORM.store(true, std::sync::atomic::Ordering::Relaxed);
|
||||
println!("(uniform random data)");
|
||||
}
|
||||
let json_path = args
|
||||
.iter()
|
||||
.position(|a| a == "--json")
|
||||
.and_then(|i| args.get(i + 1))
|
||||
.cloned();
|
||||
let sizes: &[usize] = if full {
|
||||
&[1_000, 10_000, 100_000]
|
||||
} else {
|
||||
&[1_000, 10_000]
|
||||
};
|
||||
|
||||
if cfg!(debug_assertions) {
|
||||
eprintln!("warning: debug build — numbers are meaningless. Use --release.");
|
||||
}
|
||||
|
||||
let mut json = Vec::new();
|
||||
println!("## Search harness");
|
||||
for &n in sizes {
|
||||
bench_ann(n, &mut json);
|
||||
}
|
||||
|
||||
if ann_only {
|
||||
return;
|
||||
}
|
||||
println!("\n### End to end: `HDF5Memory::hybrid_search` (k = {K}, weights 0.7 / 0.3)\n");
|
||||
println!(
|
||||
"| N | ingest ms | cold index build ms | checkpoint ms | open ms | first query after open ms | p50 ms | p99 ms | QPS |"
|
||||
);
|
||||
println!("|---:|---:|---:|---:|---:|---:|---:|---:|---:|");
|
||||
for &n in sizes {
|
||||
bench_end_to_end(n, &mut json);
|
||||
}
|
||||
|
||||
if let Some(path) = json_path {
|
||||
std::fs::write(&path, serde_json::to_string_pretty(&json).unwrap()).unwrap();
|
||||
eprintln!("wrote {path}");
|
||||
}
|
||||
}
|
||||
@@ -1,10 +1,10 @@
|
||||
[package]
|
||||
name = "clawhdf5-cli"
|
||||
version = "2.1.0"
|
||||
version = "2.4.0"
|
||||
edition = "2024"
|
||||
license = "MIT"
|
||||
description = "CLI for clawhdf5 agent memory — create, save, search, recall, stats"
|
||||
repository = "https://github.com/redclawsystems/clawhdf5"
|
||||
repository = "https://git.redclaw.dev/quantumclaw/clawhdf5"
|
||||
keywords = ["hdf5", "ai", "memory", "agent", "cli"]
|
||||
categories = ["command-line-utilities", "science"]
|
||||
readme = "../../README.md"
|
||||
@@ -14,7 +14,7 @@ name = "clawhdf5"
|
||||
path = "src/main.rs"
|
||||
|
||||
[dependencies]
|
||||
clawhdf5-agent = { path = "../clawhdf5-agent", version = "2.1.0" }
|
||||
clawhdf5-agent = { path = "../clawhdf5-agent", version = "2.4.0" }
|
||||
clap = { version = "4", features = ["derive", "env"] }
|
||||
serde_json = "1"
|
||||
serde = { version = "1", features = ["derive"] }
|
||||
serde = { workspace = true }
|
||||
|
||||
@@ -146,7 +146,7 @@ fn run(cli: Cli) -> Result<(), Box<dyn std::error::Error>> {
|
||||
}
|
||||
|
||||
Commands::Recall { index } => {
|
||||
let mem = HDF5Memory::open(&cli.path)?;
|
||||
let mem = HDF5Memory::open_read_only(&cli.path)?;
|
||||
match mem.get_chunk(index) {
|
||||
Some(content) => {
|
||||
let j = serde_json::json!({ "index": index, "chunk": content });
|
||||
@@ -160,7 +160,7 @@ fn run(cli: Cli) -> Result<(), Box<dyn std::error::Error>> {
|
||||
}
|
||||
|
||||
Commands::Stats => {
|
||||
let mem = HDF5Memory::open(&cli.path)?;
|
||||
let mem = HDF5Memory::open_read_only(&cli.path)?;
|
||||
let cfg = mem.config();
|
||||
let j = serde_json::json!({
|
||||
"path": cli.path.display().to_string(),
|
||||
@@ -187,7 +187,7 @@ fn run(cli: Cli) -> Result<(), Box<dyn std::error::Error>> {
|
||||
}
|
||||
|
||||
Commands::AgentsMd { output } => {
|
||||
let mem = HDF5Memory::open(&cli.path)?;
|
||||
let mem = HDF5Memory::open_read_only(&cli.path)?;
|
||||
let md = mem.generate_agents_md();
|
||||
match output {
|
||||
Some(p) => {
|
||||
@@ -199,7 +199,7 @@ fn run(cli: Cli) -> Result<(), Box<dyn std::error::Error>> {
|
||||
}
|
||||
|
||||
Commands::Export => {
|
||||
let mem = HDF5Memory::open(&cli.path)?;
|
||||
let mem = HDF5Memory::open_read_only(&cli.path)?;
|
||||
for i in 0..mem.count() {
|
||||
if let Some(chunk) = mem.get_chunk(i) {
|
||||
let j = serde_json::json!({ "index": i, "chunk": chunk });
|
||||
|
||||
@@ -1,10 +1,10 @@
|
||||
[package]
|
||||
name = "clawhdf5-derive"
|
||||
version = "2.1.0"
|
||||
version = "2.4.0"
|
||||
edition = "2024"
|
||||
description = "Derive macros for rustyhdf5 HDF5 traits"
|
||||
license = "MIT"
|
||||
repository = "https://github.com/redclawsystems/clawhdf5"
|
||||
repository = "https://git.redclaw.dev/quantumclaw/clawhdf5"
|
||||
readme = "README.md"
|
||||
keywords = ["hdf5", "derive", "macros", "science"]
|
||||
categories = ["development-tools::procedural-macro-helpers"]
|
||||
|
||||
@@ -1,10 +1,10 @@
|
||||
[package]
|
||||
name = "clawhdf5-filters"
|
||||
version = "2.1.0"
|
||||
version = "2.4.0"
|
||||
edition = "2024"
|
||||
description = "Filter and compression pipeline for rustyhdf5"
|
||||
description = "Filter and compression pipeline for clawhdf5"
|
||||
license = "MIT"
|
||||
repository = "https://github.com/redclawsystems/clawhdf5"
|
||||
repository = "https://git.redclaw.dev/quantumclaw/clawhdf5"
|
||||
readme = "README.md"
|
||||
keywords = ["hdf5", "compression", "deflate", "filters"]
|
||||
categories = ["compression", "science"]
|
||||
@@ -14,7 +14,7 @@ flate2 = { version = "1", default-features = false, features = ["rust_backend"]
|
||||
miniz_oxide = "0.8"
|
||||
|
||||
[dev-dependencies]
|
||||
criterion = { version = "0.5", features = ["html_reports"] }
|
||||
criterion = { workspace = true }
|
||||
|
||||
[[bench]]
|
||||
name = "deflate_bench"
|
||||
|
||||
@@ -270,14 +270,29 @@ pub(crate) fn flate2_decompress_preallocated(
|
||||
Ok(output)
|
||||
}
|
||||
|
||||
/// Absolute ceiling on decompressed output when the caller has no size hint,
|
||||
/// preventing unbounded allocation from a hostile/corrupted zlib stream.
|
||||
const MAX_DECOMPRESS_SIZE: usize = 256 * 1024 * 1024;
|
||||
|
||||
/// Streaming decompress with dynamic sizing (when output size is unknown).
|
||||
///
|
||||
/// Bounded by [`MAX_DECOMPRESS_SIZE`] since there is no chunk-size hint to
|
||||
/// validate against here — an unbounded `read_to_end` would let a hostile
|
||||
/// zlib stream force arbitrarily large allocation (a "zlib bomb").
|
||||
pub(crate) fn flate2_decompress_streaming(data: &[u8]) -> Result<Vec<u8>, String> {
|
||||
use std::io::Read;
|
||||
let mut decoder = flate2::read::ZlibDecoder::new(data);
|
||||
let decoder = flate2::read::ZlibDecoder::new(data);
|
||||
let mut result = Vec::new();
|
||||
decoder
|
||||
.take(MAX_DECOMPRESS_SIZE as u64 + 1)
|
||||
.read_to_end(&mut result)
|
||||
.map_err(|e| e.to_string())?;
|
||||
if result.len() > MAX_DECOMPRESS_SIZE {
|
||||
return Err(format!(
|
||||
"decompressed output exceeds {} MiB limit",
|
||||
MAX_DECOMPRESS_SIZE / 1024 / 1024
|
||||
));
|
||||
}
|
||||
Ok(result)
|
||||
}
|
||||
|
||||
|
||||
@@ -1,16 +1,17 @@
|
||||
[package]
|
||||
name = "clawhdf5-format"
|
||||
version = "2.1.0"
|
||||
version = "2.4.0"
|
||||
edition = "2024"
|
||||
description = "Pure-Rust HDF5 binary format parsing and writing — no C dependencies"
|
||||
license = "MIT"
|
||||
repository = "https://github.com/redclawsystems/clawhdf5"
|
||||
repository = "https://git.redclaw.dev/quantumclaw/clawhdf5"
|
||||
readme = "README.md"
|
||||
keywords = ["hdf5", "science", "data", "binary", "no-std"]
|
||||
categories = ["parser-implementations", "science", "encoding", "no-std"]
|
||||
|
||||
[dependencies]
|
||||
byteorder = { version = "1", default-features = false }
|
||||
portable-atomic = { version = "1" }
|
||||
flate2 = { version = "1", default-features = false, features = ["rust_backend"], optional = true }
|
||||
sha2 = { version = "0.10", default-features = false, optional = true }
|
||||
rayon = { version = "1", optional = true }
|
||||
@@ -18,11 +19,13 @@ crc32fast = { version = "1", optional = true }
|
||||
lz4_flex = { version = "0.11", optional = true }
|
||||
zstd = { version = "0.13", optional = true }
|
||||
blake3 = { version = "1", optional = true }
|
||||
libaec-sys = { path = "../libaec-sys", version = "0.1", optional = true }
|
||||
pco = { version = "1.0", optional = true }
|
||||
|
||||
[dev-dependencies]
|
||||
serde_json = "1"
|
||||
criterion = { version = "0.5", features = ["html_reports"] }
|
||||
clawhdf5-derive = { path = "../clawhdf5-derive", version = "2.1.0" }
|
||||
criterion = { workspace = true }
|
||||
clawhdf5-derive = { path = "../clawhdf5-derive", version = "2.4.0" }
|
||||
|
||||
[[bench]]
|
||||
name = "bench"
|
||||
@@ -43,6 +46,8 @@ zlib-rs = ["flate2/zlib-rs"]
|
||||
lz4 = ["lz4_flex"]
|
||||
zstd = ["dep:zstd"]
|
||||
blake3_hash = ["blake3"]
|
||||
szip = ["libaec-sys"]
|
||||
pcodec = ["dep:pco"]
|
||||
|
||||
[[bench]]
|
||||
name = "parallel_decompress_bench"
|
||||
|
||||
@@ -14,6 +14,9 @@ libfuzzer-sys = "0.4"
|
||||
path = ".."
|
||||
features = ["std", "checksum", "deflate"]
|
||||
|
||||
[dependencies.clawhdf5]
|
||||
path = "../../clawhdf5"
|
||||
|
||||
[workspace]
|
||||
members = ["."]
|
||||
|
||||
@@ -56,3 +59,8 @@ doc = false
|
||||
name = "fuzz_full_file"
|
||||
path = "fuzz_targets/fuzz_full_file.rs"
|
||||
doc = false
|
||||
|
||||
[[bin]]
|
||||
name = "fuzz_dataset_read"
|
||||
path = "fuzz_targets/fuzz_dataset_read.rs"
|
||||
doc = false
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# Fuzz Testing for rustyhdf5-format
|
||||
# Fuzz Testing for clawhdf5-format
|
||||
|
||||
Uses [cargo-fuzz](https://github.com/rust-fuzz/cargo-fuzz) (libFuzzer) to test parser robustness against malformed inputs.
|
||||
|
||||
@@ -21,13 +21,14 @@ rustup toolchain install nightly
|
||||
| `fuzz_btree_v2` | `BTreeV2Header::parse` | B-tree v2 header parsing |
|
||||
| `fuzz_filter_pipeline` | `FilterPipeline::parse` | Filter pipeline messages (v1/v2) |
|
||||
| `fuzz_full_file` | signature + superblock + root group | End-to-end file parsing chain |
|
||||
| `fuzz_dataset_read` | `Dataset::read_*` (via `clawhdf5`) | Walks every dataset in the parsed file and exercises the contiguous/chunked/compact raw-data read paths (`chunked_read.rs`, `data_read.rs`) that `fuzz_full_file` doesn't reach |
|
||||
|
||||
## Running
|
||||
|
||||
Run a single target (runs indefinitely until stopped or a crash is found):
|
||||
|
||||
```bash
|
||||
cd crates/rustyhdf5-format
|
||||
cd crates/clawhdf5-format
|
||||
cargo +nightly fuzz run fuzz_datatype
|
||||
```
|
||||
|
||||
@@ -41,12 +42,20 @@ Run all targets for 30 seconds each:
|
||||
|
||||
```bash
|
||||
for target in fuzz_superblock fuzz_object_header fuzz_datatype fuzz_dataspace \
|
||||
fuzz_fractal_heap fuzz_btree_v2 fuzz_filter_pipeline fuzz_full_file; do
|
||||
fuzz_fractal_heap fuzz_btree_v2 fuzz_filter_pipeline fuzz_full_file \
|
||||
fuzz_dataset_read; do
|
||||
echo "=== $target ==="
|
||||
cargo +nightly fuzz run "$target" -- -max_total_time=30 -max_len=4096
|
||||
done
|
||||
```
|
||||
|
||||
## CI
|
||||
|
||||
These targets are **not** run in CI (`.gitea/workflows/ci.yml`) — cargo-fuzz
|
||||
requires nightly and each meaningful run takes minutes, which doesn't fit a
|
||||
per-PR gate. Run them manually on a schedule (e.g. before a release, or after
|
||||
touching parser code) instead.
|
||||
|
||||
## Reproducing Crashes
|
||||
|
||||
If a crash is found, the input is saved to `fuzz/artifacts/<target>/`. Reproduce with:
|
||||
|
||||
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
BIN
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
@@ -0,0 +1,45 @@
|
||||
#![no_main]
|
||||
use libfuzzer_sys::fuzz_target;
|
||||
|
||||
const MAX_WALK_DEPTH: usize = 16;
|
||||
|
||||
/// Walk groups/datasets from `group`, exercising every dataset-reading code
|
||||
/// path reachable through the public API (contiguous/chunked/compact raw
|
||||
/// reads via `chunked_read.rs`/`data_read.rs`). Depth-limited independently
|
||||
/// of any parser-level recursion guard, since this is fuzz-harness
|
||||
/// bookkeeping, not something under test.
|
||||
fn walk_group(group: &clawhdf5::Group, depth: usize) {
|
||||
if depth > MAX_WALK_DEPTH {
|
||||
return;
|
||||
}
|
||||
if let Ok(names) = group.datasets() {
|
||||
for name in names {
|
||||
if let Ok(dataset) = group.dataset(&name) {
|
||||
let _ = dataset.shape();
|
||||
let _ = dataset.max_dimensions();
|
||||
let _ = dataset.dtype();
|
||||
let _ = dataset.read_raw_ref();
|
||||
let _ = dataset.read_f64();
|
||||
let _ = dataset.read_f32();
|
||||
let _ = dataset.read_i32();
|
||||
let _ = dataset.read_i64();
|
||||
let _ = dataset.read_u64();
|
||||
let _ = dataset.read_string();
|
||||
}
|
||||
}
|
||||
}
|
||||
if let Ok(names) = group.groups() {
|
||||
for name in names {
|
||||
if let Ok(subgroup) = group.group(&name) {
|
||||
walk_group(&subgroup, depth + 1);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
fuzz_target!(|data: &[u8]| {
|
||||
let Ok(file) = clawhdf5::File::from_bytes(data.to_vec()) else {
|
||||
return;
|
||||
};
|
||||
walk_group(&file.root(), 0);
|
||||
});
|
||||
@@ -1,7 +1,9 @@
|
||||
//! HDF5 Attribute message parsing (message type 0x000C).
|
||||
|
||||
#[cfg(not(feature = "std"))]
|
||||
use alloc::{string::String, vec::Vec};
|
||||
use alloc::{borrow::Cow, string::String, vec::Vec};
|
||||
#[cfg(feature = "std")]
|
||||
use std::borrow::Cow;
|
||||
|
||||
use crate::attribute_info::AttributeInfoMessage;
|
||||
use crate::btree_v2::{BTreeV2Header, collect_btree_v2_records};
|
||||
@@ -48,17 +50,64 @@ impl AttributeMessage {
|
||||
///
|
||||
/// `length_size` is needed for dataspace dimension parsing.
|
||||
pub fn parse(data: &[u8], length_size: u8) -> Result<AttributeMessage, FormatError> {
|
||||
Self::parse_impl(data, length_size, None)
|
||||
}
|
||||
|
||||
/// [`AttributeMessage::parse`] with access to the rest of the file, which
|
||||
/// is needed when the attribute's datatype or dataspace is *shared* (v2/v3
|
||||
/// flag bits 0/1) — e.g. an attribute created with a committed datatype.
|
||||
/// In that case the embedded bytes are a reference to the real message,
|
||||
/// not the message. Without file access such an attribute is an error
|
||||
/// rather than a garbage datatype.
|
||||
pub fn parse_in_file(
|
||||
data: &[u8],
|
||||
file_data: &[u8],
|
||||
offset_size: u8,
|
||||
length_size: u8,
|
||||
) -> Result<AttributeMessage, FormatError> {
|
||||
Self::parse_impl(data, length_size, Some((file_data, offset_size)))
|
||||
}
|
||||
|
||||
fn parse_impl(
|
||||
data: &[u8],
|
||||
length_size: u8,
|
||||
file: Option<(&[u8], u8)>,
|
||||
) -> Result<AttributeMessage, FormatError> {
|
||||
ensure_len(data, 0, 2)?;
|
||||
let version = data[0];
|
||||
|
||||
match version {
|
||||
1 => Self::parse_v1(data, length_size),
|
||||
2 => Self::parse_v2(data, length_size),
|
||||
3 => Self::parse_v3(data, length_size),
|
||||
2 => Self::parse_v2(data, length_size, file),
|
||||
3 => Self::parse_v3(data, length_size, file),
|
||||
_ => Err(FormatError::InvalidAttributeVersion(version)),
|
||||
}
|
||||
}
|
||||
|
||||
/// The bytes of an embedded datatype/dataspace message, following the
|
||||
/// shared-message reference when `shared` is set.
|
||||
fn embedded_message<'a>(
|
||||
bytes: &'a [u8],
|
||||
shared: bool,
|
||||
msg_type: MessageType,
|
||||
length_size: u8,
|
||||
file: Option<(&[u8], u8)>,
|
||||
) -> Result<Cow<'a, [u8]>, FormatError> {
|
||||
if !shared {
|
||||
return Ok(Cow::Borrowed(bytes));
|
||||
}
|
||||
let (file_data, offset_size) = file.ok_or(FormatError::UnresolvedSharedMessage)?;
|
||||
let shared_ref = shared_message::parse_shared_ref(bytes, offset_size)?;
|
||||
shared_message::resolve_shared_message(
|
||||
file_data,
|
||||
&shared_ref,
|
||||
msg_type,
|
||||
offset_size,
|
||||
length_size,
|
||||
)
|
||||
.map(Cow::Owned)
|
||||
}
|
||||
|
||||
fn parse_v1(data: &[u8], length_size: u8) -> Result<AttributeMessage, FormatError> {
|
||||
// version(1) + reserved(1) + name_size(2) + datatype_size(2) + dataspace_size(2) = 8
|
||||
ensure_len(data, 0, 8)?;
|
||||
@@ -94,7 +143,13 @@ impl AttributeMessage {
|
||||
})
|
||||
}
|
||||
|
||||
fn parse_v2(data: &[u8], length_size: u8) -> Result<AttributeMessage, FormatError> {
|
||||
fn parse_v2(
|
||||
data: &[u8],
|
||||
length_size: u8,
|
||||
file: Option<(&[u8], u8)>,
|
||||
) -> Result<AttributeMessage, FormatError> {
|
||||
// Flags: bit 0 = datatype is shared, bit 1 = dataspace is shared.
|
||||
let flags = data.get(1).copied().unwrap_or(0);
|
||||
// version(1) + flags(1) + name_size(2) + datatype_size(2) + dataspace_size(2) = 8
|
||||
ensure_len(data, 0, 8)?;
|
||||
let name_size = u16::from_le_bytes([data[2], data[3]]) as usize;
|
||||
@@ -110,12 +165,26 @@ impl AttributeMessage {
|
||||
|
||||
// Datatype (NO padding)
|
||||
ensure_len(data, pos, datatype_size)?;
|
||||
let (datatype, _) = Datatype::parse(&data[pos..pos + datatype_size])?;
|
||||
let dt_bytes = Self::embedded_message(
|
||||
&data[pos..pos + datatype_size],
|
||||
flags & 0x01 != 0,
|
||||
MessageType::Datatype,
|
||||
length_size,
|
||||
file,
|
||||
)?;
|
||||
let (datatype, _) = Datatype::parse(&dt_bytes)?;
|
||||
pos += datatype_size;
|
||||
|
||||
// Dataspace (NO padding)
|
||||
ensure_len(data, pos, dataspace_size)?;
|
||||
let dataspace = Dataspace::parse(&data[pos..pos + dataspace_size], length_size)?;
|
||||
let ds_bytes = Self::embedded_message(
|
||||
&data[pos..pos + dataspace_size],
|
||||
flags & 0x02 != 0,
|
||||
MessageType::Dataspace,
|
||||
length_size,
|
||||
file,
|
||||
)?;
|
||||
let dataspace = Dataspace::parse(&ds_bytes, length_size)?;
|
||||
pos += dataspace_size;
|
||||
|
||||
let raw_data = compute_raw_data(data, pos, &dataspace, &datatype);
|
||||
@@ -128,7 +197,13 @@ impl AttributeMessage {
|
||||
})
|
||||
}
|
||||
|
||||
fn parse_v3(data: &[u8], length_size: u8) -> Result<AttributeMessage, FormatError> {
|
||||
fn parse_v3(
|
||||
data: &[u8],
|
||||
length_size: u8,
|
||||
file: Option<(&[u8], u8)>,
|
||||
) -> Result<AttributeMessage, FormatError> {
|
||||
// Flags: bit 0 = datatype is shared, bit 1 = dataspace is shared.
|
||||
let flags = data.get(1).copied().unwrap_or(0);
|
||||
// version(1) + flags(1) + name_size(2) + datatype_size(2) + dataspace_size(2) + encoding(1) = 9
|
||||
ensure_len(data, 0, 9)?;
|
||||
let name_size = u16::from_le_bytes([data[2], data[3]]) as usize;
|
||||
@@ -145,12 +220,26 @@ impl AttributeMessage {
|
||||
|
||||
// Datatype (NO padding)
|
||||
ensure_len(data, pos, datatype_size)?;
|
||||
let (datatype, _) = Datatype::parse(&data[pos..pos + datatype_size])?;
|
||||
let dt_bytes = Self::embedded_message(
|
||||
&data[pos..pos + datatype_size],
|
||||
flags & 0x01 != 0,
|
||||
MessageType::Datatype,
|
||||
length_size,
|
||||
file,
|
||||
)?;
|
||||
let (datatype, _) = Datatype::parse(&dt_bytes)?;
|
||||
pos += datatype_size;
|
||||
|
||||
// Dataspace (NO padding)
|
||||
ensure_len(data, pos, dataspace_size)?;
|
||||
let dataspace = Dataspace::parse(&data[pos..pos + dataspace_size], length_size)?;
|
||||
let ds_bytes = Self::embedded_message(
|
||||
&data[pos..pos + dataspace_size],
|
||||
flags & 0x02 != 0,
|
||||
MessageType::Dataspace,
|
||||
length_size,
|
||||
file,
|
||||
)?;
|
||||
let dataspace = Dataspace::parse(&ds_bytes, length_size)?;
|
||||
pos += dataspace_size;
|
||||
|
||||
let raw_data = compute_raw_data(data, pos, &dataspace, &datatype);
|
||||
@@ -326,10 +415,20 @@ pub fn extract_attributes_full(
|
||||
offset_size,
|
||||
length_size,
|
||||
)?;
|
||||
let attr = AttributeMessage::parse(&resolved_data, length_size)?;
|
||||
let attr = AttributeMessage::parse_in_file(
|
||||
&resolved_data,
|
||||
file_data,
|
||||
offset_size,
|
||||
length_size,
|
||||
)?;
|
||||
attrs.push(attr);
|
||||
} else {
|
||||
let attr = AttributeMessage::parse(&msg.data, length_size)?;
|
||||
let attr = AttributeMessage::parse_in_file(
|
||||
&msg.data,
|
||||
file_data,
|
||||
offset_size,
|
||||
length_size,
|
||||
)?;
|
||||
attrs.push(attr);
|
||||
}
|
||||
}
|
||||
@@ -399,7 +498,8 @@ fn extract_dense_attributes(
|
||||
let attr_data = fh.read_managed_object(file_data, id_bytes, offset_size)?;
|
||||
|
||||
// The data in the heap is a complete attribute message
|
||||
let attr = AttributeMessage::parse(&attr_data, length_size)?;
|
||||
let attr =
|
||||
AttributeMessage::parse_in_file(&attr_data, file_data, offset_size, length_size)?;
|
||||
attrs.push(attr);
|
||||
}
|
||||
|
||||
@@ -472,14 +572,13 @@ mod tests {
|
||||
|
||||
// Name padded to 8 bytes
|
||||
data.extend_from_slice(name);
|
||||
while data.len() % 8 != 0 || data.len() == 8 {
|
||||
if data.len() % 8 != 0 || data.len() == 8 {
|
||||
// Pad name to 8-byte boundary from start of name
|
||||
let name_start = 8;
|
||||
let name_padded = pad8(name_size);
|
||||
while data.len() < name_start + name_padded {
|
||||
data.push(0);
|
||||
}
|
||||
break;
|
||||
}
|
||||
|
||||
// Datatype padded to 8 bytes
|
||||
@@ -749,11 +848,11 @@ mod tests {
|
||||
data.extend_from_slice(name);
|
||||
data.extend_from_slice(&dt_bytes);
|
||||
data.extend_from_slice(&ds_bytes);
|
||||
data.extend_from_slice(&3.14f64.to_le_bytes());
|
||||
data.extend_from_slice(&3.25f64.to_le_bytes());
|
||||
|
||||
let attr = AttributeMessage::parse(&data, 8).unwrap();
|
||||
let vals = attr.read_as_f64().unwrap();
|
||||
assert_eq!(vals, vec![3.14]);
|
||||
assert_eq!(vals, vec![3.25]);
|
||||
}
|
||||
|
||||
#[test]
|
||||
|
||||
@@ -24,6 +24,21 @@ pub struct BTreeV1Node {
|
||||
pub children: Vec<u64>,
|
||||
}
|
||||
|
||||
/// Checks that `[offset, offset + needed)` fits within `data`, guarding the
|
||||
/// addition against `usize` overflow from a crafted near-`usize::MAX` offset.
|
||||
fn ensure_len(data: &[u8], offset: usize, needed: usize) -> Result<(), FormatError> {
|
||||
if offset
|
||||
.checked_add(needed)
|
||||
.is_none_or(|end| end > data.len())
|
||||
{
|
||||
return Err(FormatError::UnexpectedEof {
|
||||
expected: offset.saturating_add(needed),
|
||||
available: data.len(),
|
||||
});
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
|
||||
fn read_offset(data: &[u8], pos: usize, size: u8) -> Result<u64, FormatError> {
|
||||
let s = size as usize;
|
||||
if pos.checked_add(s).is_none_or(|end| end > data.len()) {
|
||||
@@ -45,7 +60,7 @@ fn read_offset(data: &[u8], pos: usize, size: u8) -> Result<u64, FormatError> {
|
||||
|
||||
fn is_undefined(data: &[u8], pos: usize, size: u8) -> bool {
|
||||
let s = size as usize;
|
||||
if pos + s > data.len() {
|
||||
if ensure_len(data, pos, s).is_err() {
|
||||
return false;
|
||||
}
|
||||
data[pos..pos + s].iter().all(|&b| b == 0xFF)
|
||||
@@ -65,12 +80,7 @@ impl BTreeV1Node {
|
||||
// + left_sibling(offset_size) + right_sibling(offset_size)
|
||||
let os = offset_size as usize;
|
||||
let header_size = 8 + os * 2;
|
||||
if offset + header_size > file_data.len() {
|
||||
return Err(FormatError::UnexpectedEof {
|
||||
expected: offset + header_size,
|
||||
available: file_data.len(),
|
||||
});
|
||||
}
|
||||
ensure_len(file_data, offset, header_size)?;
|
||||
|
||||
if &file_data[offset..offset + 4] != b"TREE" {
|
||||
return Err(FormatError::InvalidBTreeSignature);
|
||||
@@ -99,12 +109,7 @@ impl BTreeV1Node {
|
||||
let eu = entries_used as usize;
|
||||
let key_size = os; // For type 0, key = offset_size
|
||||
let needed = eu * (key_size + os) + key_size; // eu children + (eu+1) keys
|
||||
if pos + needed > file_data.len() {
|
||||
return Err(FormatError::UnexpectedEof {
|
||||
expected: pos + needed,
|
||||
available: file_data.len(),
|
||||
});
|
||||
}
|
||||
ensure_len(file_data, pos, needed)?;
|
||||
|
||||
let mut keys = Vec::with_capacity(eu + 1);
|
||||
let mut children = Vec::with_capacity(eu);
|
||||
@@ -241,6 +246,16 @@ mod tests {
|
||||
assert_eq!(node.right_sibling, None);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn parse_near_usize_max_offset_rejected_without_overflow() {
|
||||
let data = build_btree_node(0, 0, &[0, 5, 10], &[0x100, 0x200], None, None, 8);
|
||||
let result = BTreeV1Node::parse(&data, usize::MAX - 4, 8, 8);
|
||||
assert!(
|
||||
matches!(result, Err(FormatError::UnexpectedEof { .. })),
|
||||
"expected a clean UnexpectedEof, got {result:?}"
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn parse_with_siblings_none() {
|
||||
let data = build_btree_node(0, 0, &[0, 8], &[0x300], None, None, 8);
|
||||
|
||||
@@ -416,6 +416,7 @@ fn header_max_total_records(max_leaf_nrec: u64, depth: u16) -> u64 {
|
||||
mod tests {
|
||||
use super::*;
|
||||
|
||||
#[allow(clippy::too_many_arguments)]
|
||||
fn build_btree_v2_header(
|
||||
tree_type: u8,
|
||||
node_size: u32,
|
||||
|
||||
@@ -16,6 +16,8 @@ use core::ops::{Deref, DerefMut};
|
||||
use alloc::collections::BTreeMap;
|
||||
#[cfg(feature = "std")]
|
||||
use std::collections::HashMap;
|
||||
#[cfg(feature = "std")]
|
||||
use std::sync::Arc;
|
||||
|
||||
use crate::chunk_index::{ChunkIndex, ChunkLayout};
|
||||
use crate::chunked_read::ChunkInfo;
|
||||
@@ -64,6 +66,11 @@ pub struct CacheAlignedBuffer {
|
||||
|
||||
// SAFETY: The raw pointer is exclusively owned — no aliasing.
|
||||
unsafe impl Send for CacheAlignedBuffer {}
|
||||
// SAFETY: `CacheAlignedBuffer` exposes its contents only via `&[u8]`/`&mut
|
||||
// [u8]` through the ordinary borrow-checked `Deref`/`DerefMut` impls below —
|
||||
// the same access pattern as `Vec<u8>`, which is `Sync`. Needed so
|
||||
// `Arc<CacheAlignedBuffer>` (used by the chunk cache) is itself `Send`.
|
||||
unsafe impl Sync for CacheAlignedBuffer {}
|
||||
|
||||
impl CacheAlignedBuffer {
|
||||
/// Allocate a new cache-line-aligned buffer of exactly `len` bytes,
|
||||
@@ -223,7 +230,9 @@ pub const DEFAULT_MAX_SLOTS: usize = 521;
|
||||
#[cfg(feature = "std")]
|
||||
struct CachedChunk {
|
||||
coord: ChunkCoord,
|
||||
data: CacheAlignedBuffer,
|
||||
/// Shared so a cache hit is a refcount bump, not a copy of the whole
|
||||
/// (potentially large) decompressed chunk.
|
||||
data: Arc<CacheAlignedBuffer>,
|
||||
/// Monotonically increasing access counter for LRU ordering.
|
||||
last_access: u64,
|
||||
}
|
||||
@@ -267,6 +276,12 @@ struct CacheInner {
|
||||
/// LRU cache of decompressed chunk data.
|
||||
slots: Vec<CachedChunk>,
|
||||
|
||||
/// Coordinate -> index into `slots`, for O(1) lookup instead of a linear
|
||||
/// scan. Kept in sync with `slots` on every insert/evict/clear — in
|
||||
/// particular, `slots.swap_remove(i)` moves the last element into slot
|
||||
/// `i`, so the moved element's index entry must be updated too.
|
||||
slot_index: HashMap<ChunkCoord, usize>,
|
||||
|
||||
/// Current total bytes of cached decompressed data.
|
||||
current_bytes: usize,
|
||||
|
||||
@@ -344,6 +359,7 @@ impl ChunkCache {
|
||||
index: None,
|
||||
index_addr: None,
|
||||
slots: Vec::with_capacity(max_slots.min(64)),
|
||||
slot_index: HashMap::with_capacity(max_slots.min(64)),
|
||||
current_bytes: 0,
|
||||
max_bytes,
|
||||
max_slots,
|
||||
@@ -375,6 +391,7 @@ impl ChunkCache {
|
||||
inner.chunk_index = None;
|
||||
inner.chunk_layout = None;
|
||||
inner.slots.clear();
|
||||
inner.slot_index.clear();
|
||||
inner.current_bytes = 0;
|
||||
inner.last_coord = None;
|
||||
inner.index_addr = Some(addr);
|
||||
@@ -477,8 +494,20 @@ impl ChunkCache {
|
||||
|
||||
/// Try to get cached decompressed data for a chunk coordinate.
|
||||
///
|
||||
/// Returns a clone of the cache-line-aligned buffer.
|
||||
/// O(1) lookup. Returns an owned copy for API compatibility with callers
|
||||
/// that need a `Vec<u8>`; prefer [`Self::get_decompressed_aligned`] when
|
||||
/// an `Arc`-shared buffer works for the caller, since that avoids the
|
||||
/// copy entirely.
|
||||
pub fn get_decompressed(&self, coord: &[u64]) -> Option<Vec<u8>> {
|
||||
self.get_decompressed_aligned(coord)
|
||||
.map(|arc| arc.as_slice().to_vec())
|
||||
}
|
||||
|
||||
/// Try to get a reference-counted clone of the aligned buffer for a chunk.
|
||||
///
|
||||
/// O(1) index lookup; the clone is an `Arc` refcount bump, not a copy of
|
||||
/// the underlying decompressed data.
|
||||
pub fn get_decompressed_aligned(&self, coord: &[u64]) -> Option<Arc<CacheAlignedBuffer>> {
|
||||
let mut inner = self.inner.lock().unwrap_or_else(|e| e.into_inner());
|
||||
inner.tick += 1;
|
||||
let tick = inner.tick;
|
||||
@@ -500,36 +529,12 @@ impl ChunkCache {
|
||||
}
|
||||
inner.last_coord = Some(coord.to_vec());
|
||||
|
||||
let mut found = None;
|
||||
for slot in inner.slots.iter_mut() {
|
||||
if slot.coord.as_slice() == coord {
|
||||
slot.last_access = tick;
|
||||
found = Some(slot.data.to_vec());
|
||||
break;
|
||||
}
|
||||
}
|
||||
if let Some(ref data) = found {
|
||||
inner.stats.hits += 1;
|
||||
inner.stats.bytes_read += data.len() as u64;
|
||||
let found = if let Some(&idx) = inner.slot_index.get(coord) {
|
||||
inner.slots[idx].last_access = tick;
|
||||
Some(Arc::clone(&inner.slots[idx].data))
|
||||
} else {
|
||||
inner.stats.misses += 1;
|
||||
}
|
||||
found
|
||||
}
|
||||
|
||||
/// Try to get a reference-counted clone of the aligned buffer for a chunk.
|
||||
pub fn get_decompressed_aligned(&self, coord: &[u64]) -> Option<CacheAlignedBuffer> {
|
||||
let mut inner = self.inner.lock().unwrap_or_else(|e| e.into_inner());
|
||||
inner.tick += 1;
|
||||
let tick = inner.tick;
|
||||
let mut found = None;
|
||||
for slot in inner.slots.iter_mut() {
|
||||
if slot.coord.as_slice() == coord {
|
||||
slot.last_access = tick;
|
||||
found = Some(slot.data.clone());
|
||||
break;
|
||||
}
|
||||
}
|
||||
None
|
||||
};
|
||||
if let Some(ref data) = found {
|
||||
inner.stats.hits += 1;
|
||||
inner.stats.bytes_read += data.len() as u64;
|
||||
@@ -542,30 +547,39 @@ impl ChunkCache {
|
||||
/// Insert decompressed chunk data into the LRU cache.
|
||||
///
|
||||
/// The data is stored in a [`CacheAlignedBuffer`] so subsequent reads
|
||||
/// return cache-line-aligned memory.
|
||||
pub fn put_decompressed(&self, coord: ChunkCoord, data: Vec<u8>) {
|
||||
let aligned = CacheAlignedBuffer::from_slice(&data);
|
||||
self.put_decompressed_aligned(coord, aligned);
|
||||
/// return cache-line-aligned memory. Returns the `Arc`-shared buffer that
|
||||
/// is now cached (or already was), so the caller can reuse it directly
|
||||
/// instead of holding a separate copy of the same data.
|
||||
pub fn put_decompressed(&self, coord: ChunkCoord, data: Vec<u8>) -> Arc<CacheAlignedBuffer> {
|
||||
let aligned = CacheAlignedBuffer::from_vec(data);
|
||||
self.put_decompressed_aligned(coord, aligned)
|
||||
}
|
||||
|
||||
/// Insert an already-aligned buffer into the LRU cache.
|
||||
pub fn put_decompressed_aligned(&self, coord: ChunkCoord, data: CacheAlignedBuffer) {
|
||||
///
|
||||
/// Returns the `Arc`-shared buffer now held by the cache (the one just
|
||||
/// inserted, or the existing cached copy if `coord` was already present).
|
||||
pub fn put_decompressed_aligned(
|
||||
&self,
|
||||
coord: ChunkCoord,
|
||||
data: CacheAlignedBuffer,
|
||||
) -> Arc<CacheAlignedBuffer> {
|
||||
let data = Arc::new(data);
|
||||
let mut inner = self.inner.lock().unwrap_or_else(|e| e.into_inner());
|
||||
let data_len = data.len();
|
||||
|
||||
// Don't cache if single chunk exceeds budget
|
||||
// Don't cache if single chunk exceeds budget — still return the data
|
||||
// to the caller, just don't retain it.
|
||||
if data_len > inner.max_bytes {
|
||||
return;
|
||||
return data;
|
||||
}
|
||||
|
||||
// Check if already present
|
||||
inner.tick += 1;
|
||||
let tick = inner.tick;
|
||||
for slot in inner.slots.iter_mut() {
|
||||
if slot.coord == coord {
|
||||
slot.last_access = tick;
|
||||
return; // already cached
|
||||
}
|
||||
if let Some(&idx) = inner.slot_index.get(&coord) {
|
||||
inner.slots[idx].last_access = tick;
|
||||
return Arc::clone(&inner.slots[idx].data); // already cached
|
||||
}
|
||||
|
||||
// Evict until we have room
|
||||
@@ -581,16 +595,26 @@ impl ChunkCache {
|
||||
.map(|(i, _)| i)
|
||||
.unwrap();
|
||||
let removed = inner.slots.swap_remove(lru_idx);
|
||||
inner.slot_index.remove(&removed.coord);
|
||||
// swap_remove moved the former last element into `lru_idx` (unless
|
||||
// it *was* the last element) — fix up that element's index entry.
|
||||
if lru_idx < inner.slots.len() {
|
||||
let moved_coord = inner.slots[lru_idx].coord.clone();
|
||||
inner.slot_index.insert(moved_coord, lru_idx);
|
||||
}
|
||||
inner.current_bytes -= removed.data.len();
|
||||
inner.stats.evictions += 1;
|
||||
}
|
||||
|
||||
inner.current_bytes += data_len;
|
||||
let new_idx = inner.slots.len();
|
||||
inner.slot_index.insert(coord.clone(), new_idx);
|
||||
inner.slots.push(CachedChunk {
|
||||
coord,
|
||||
data,
|
||||
data: Arc::clone(&data),
|
||||
last_access: tick,
|
||||
});
|
||||
data
|
||||
}
|
||||
|
||||
/// Clear the entire cache (index + decompressed data).
|
||||
@@ -599,6 +623,7 @@ impl ChunkCache {
|
||||
inner.index = None;
|
||||
inner.index_addr = None;
|
||||
inner.slots.clear();
|
||||
inner.slot_index.clear();
|
||||
inner.current_bytes = 0;
|
||||
inner.tick = 0;
|
||||
inner.last_coord = None;
|
||||
@@ -607,11 +632,13 @@ impl ChunkCache {
|
||||
inner.chunk_layout = None;
|
||||
}
|
||||
|
||||
/// Hint that the given chunk coordinates will be accessed soon.
|
||||
/// Record that the given chunk coordinates are predicted to be accessed
|
||||
/// soon (bookkeeping only).
|
||||
///
|
||||
/// Pre-populates the chunk index for these coordinates so that
|
||||
/// subsequent lookups are O(1). This does NOT pre-decompress the
|
||||
/// chunks — it only ensures the index entries exist.
|
||||
/// This does **not** prefetch or pre-decompress anything — it only
|
||||
/// checks whether each coordinate is already in the chunk index and
|
||||
/// updates access-pattern stats accordingly. Real prefetching (e.g.
|
||||
/// background pre-decompression) is not implemented.
|
||||
pub fn prefetch_hint(&self, next_coords: &[ChunkCoord]) {
|
||||
let inner = self.inner.lock().unwrap_or_else(|e| e.into_inner());
|
||||
if inner.index.is_none() {
|
||||
@@ -785,6 +812,50 @@ mod tests {
|
||||
assert_eq!(cache.cached_bytes(), 3);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn slot_index_consistent_after_many_evictions() {
|
||||
// Force repeated swap_remove evictions (small slot budget, many
|
||||
// inserts) and confirm the coord -> slot index stays correct: every
|
||||
// remaining coord must still resolve to its own data, not another
|
||||
// slot's (which would happen if swap_remove's index fixup were wrong).
|
||||
let cache = ChunkCache::with_capacity(1024 * 1024, 4); // max 4 slots
|
||||
|
||||
for i in 0..50u64 {
|
||||
cache.put_decompressed(vec![i], vec![(i % 256) as u8; 8]);
|
||||
// Interleave reads of a couple of earlier coords to churn LRU
|
||||
// order (and thus which slot gets swap_remove'd) beyond simple
|
||||
// FIFO eviction.
|
||||
if i >= 2 {
|
||||
let _ = cache.get_decompressed(&[i - 2]);
|
||||
}
|
||||
}
|
||||
|
||||
// Whatever remains in the cache (at most 4 slots) must return its
|
||||
// own correct data.
|
||||
for i in 0..50u64 {
|
||||
if let Some(data) = cache.get_decompressed(&[i]) {
|
||||
assert_eq!(
|
||||
data,
|
||||
vec![(i % 256) as u8; 8],
|
||||
"coord {i} returned wrong data after eviction churn"
|
||||
);
|
||||
}
|
||||
}
|
||||
assert!(cache.cached_chunk_count() <= 4);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn get_decompressed_aligned_shares_arc_on_hit() {
|
||||
let cache = ChunkCache::new();
|
||||
cache.put_decompressed(vec![0, 0], vec![9, 9, 9, 9]);
|
||||
let a = cache.get_decompressed_aligned(&[0, 0]).unwrap();
|
||||
let b = cache.get_decompressed_aligned(&[0, 0]).unwrap();
|
||||
// A cache hit clones the Arc (refcount bump), not the underlying
|
||||
// buffer — both handles point at the same allocation.
|
||||
assert!(Arc::ptr_eq(&a, &b));
|
||||
assert_eq!(a.as_slice(), &[9, 9, 9, 9]);
|
||||
}
|
||||
|
||||
// --- CacheAlignedBuffer tests ---
|
||||
|
||||
#[test]
|
||||
|
||||
@@ -17,6 +17,8 @@ use crate::extensible_array::{ExtensibleArrayHeader, read_extensible_array_chunk
|
||||
use crate::filter_pipeline::FilterPipeline;
|
||||
use crate::filters::decompress_chunk;
|
||||
use crate::fixed_array::{FixedArrayHeader, read_fixed_array_chunks};
|
||||
#[cfg(feature = "std")]
|
||||
use std::sync::Arc;
|
||||
|
||||
#[cfg(feature = "parallel")]
|
||||
use crate::parallel_read;
|
||||
@@ -59,12 +61,7 @@ fn decompress_all_chunks(
|
||||
for chunk_info in chunks {
|
||||
let c_addr = chunk_info.address as usize;
|
||||
let size = chunk_info.chunk_size as usize;
|
||||
if c_addr + size > file_data.len() {
|
||||
return Err(FormatError::UnexpectedEof {
|
||||
expected: c_addr + size,
|
||||
available: file_data.len(),
|
||||
});
|
||||
}
|
||||
ensure_len(file_data, c_addr, size)?;
|
||||
let raw_chunk = &file_data[c_addr..c_addr + size];
|
||||
|
||||
let decompressed = if let Some(pl) = pipeline {
|
||||
@@ -120,6 +117,62 @@ pub struct ChunkInfo {
|
||||
pub address: u64,
|
||||
}
|
||||
|
||||
/// Checks that `[offset, offset + needed)` fits within `data`, guarding the
|
||||
/// addition against `usize` overflow from a crafted near-`usize::MAX` offset.
|
||||
fn ensure_len(data: &[u8], offset: usize, needed: usize) -> Result<(), FormatError> {
|
||||
if offset
|
||||
.checked_add(needed)
|
||||
.is_none_or(|end| end > data.len())
|
||||
{
|
||||
return Err(FormatError::UnexpectedEof {
|
||||
expected: offset.saturating_add(needed),
|
||||
available: data.len(),
|
||||
});
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
|
||||
/// `elements * elem_size` for sizes that come from the file. Dataspace and
|
||||
/// chunk dimensions are untrusted 64-bit fields, so a crafted file can make
|
||||
/// the plain product wrap to a small number (or to something enormous).
|
||||
pub(crate) fn checked_byte_len(elements: u64, elem_size: usize) -> Result<usize, FormatError> {
|
||||
usize::try_from(elements)
|
||||
.ok()
|
||||
.and_then(|n| n.checked_mul(elem_size))
|
||||
.ok_or_else(|| {
|
||||
FormatError::Overflow(format!(
|
||||
"{elements} elements of {elem_size} bytes exceeds the addressable size"
|
||||
))
|
||||
})
|
||||
}
|
||||
|
||||
/// Product of chunk dimensions times the element size, overflow-checked.
|
||||
pub(crate) fn checked_chunk_byte_len(
|
||||
chunk_dims: &[usize],
|
||||
elem_size: usize,
|
||||
) -> Result<usize, FormatError> {
|
||||
chunk_dims
|
||||
.iter()
|
||||
.try_fold(elem_size, |acc, &d| acc.checked_mul(d))
|
||||
.ok_or_else(|| {
|
||||
FormatError::Overflow(format!(
|
||||
"chunk dimensions {chunk_dims:?} x {elem_size} bytes exceeds the addressable size"
|
||||
))
|
||||
})
|
||||
}
|
||||
|
||||
/// A zero-filled output buffer of `len` bytes. `vec![0; len]` aborts the
|
||||
/// process when the allocation fails; a size taken from the file must surface
|
||||
/// as an error instead.
|
||||
pub(crate) fn alloc_output(len: usize) -> Result<Vec<u8>, FormatError> {
|
||||
let mut out = Vec::new();
|
||||
out.try_reserve_exact(len).map_err(|_| {
|
||||
FormatError::Overflow(format!("cannot allocate {len} bytes for dataset output"))
|
||||
})?;
|
||||
out.resize(len, 0);
|
||||
Ok(out)
|
||||
}
|
||||
|
||||
fn read_offset(data: &[u8], pos: usize, size: u8) -> Result<u64, FormatError> {
|
||||
let s = size as usize;
|
||||
if pos.checked_add(s).is_none_or(|end| end > data.len()) {
|
||||
@@ -148,19 +201,33 @@ pub fn collect_chunk_info(
|
||||
btree_address: u64,
|
||||
ndims: usize,
|
||||
offset_size: u8,
|
||||
_length_size: u8,
|
||||
length_size: u8,
|
||||
) -> Result<Vec<ChunkInfo>, FormatError> {
|
||||
collect_chunk_info_inner(file_data, btree_address, ndims, offset_size, length_size, 0)
|
||||
}
|
||||
|
||||
/// Maximum recursion depth for chunk B-tree traversal (malformed/cyclic data
|
||||
/// protection), matching `btree_v1.rs`'s `MAX_BTREE_DEPTH`.
|
||||
const MAX_CHUNK_BTREE_DEPTH: usize = 64;
|
||||
|
||||
fn collect_chunk_info_inner(
|
||||
file_data: &[u8],
|
||||
btree_address: u64,
|
||||
ndims: usize,
|
||||
offset_size: u8,
|
||||
_length_size: u8,
|
||||
depth: usize,
|
||||
) -> Result<Vec<ChunkInfo>, FormatError> {
|
||||
if depth > MAX_CHUNK_BTREE_DEPTH {
|
||||
return Err(FormatError::NestingDepthExceeded);
|
||||
}
|
||||
|
||||
let offset = btree_address as usize;
|
||||
let os = offset_size as usize;
|
||||
|
||||
// Parse B-tree v1 header
|
||||
let header_size = 8 + os * 2;
|
||||
if offset + header_size > file_data.len() {
|
||||
return Err(FormatError::UnexpectedEof {
|
||||
expected: offset + header_size,
|
||||
available: file_data.len(),
|
||||
});
|
||||
}
|
||||
ensure_len(file_data, offset, header_size)?;
|
||||
|
||||
if &file_data[offset..offset + 4] != b"TREE" {
|
||||
return Err(FormatError::InvalidBTreeSignature);
|
||||
@@ -183,12 +250,7 @@ pub fn collect_chunk_info(
|
||||
// Leaf node: keys and children interleaved
|
||||
// key[0], child[0], key[1], child[1], ..., key[N-1], child[N-1], key[N]
|
||||
let needed = entries_used * (key_size + os) + key_size;
|
||||
if pos + needed > file_data.len() {
|
||||
return Err(FormatError::UnexpectedEof {
|
||||
expected: pos + needed,
|
||||
available: file_data.len(),
|
||||
});
|
||||
}
|
||||
ensure_len(file_data, pos, needed)?;
|
||||
|
||||
let mut chunks = Vec::with_capacity(entries_used);
|
||||
for _ in 0..entries_used {
|
||||
@@ -229,12 +291,7 @@ pub fn collect_chunk_info(
|
||||
} else {
|
||||
// Internal node: recurse into children
|
||||
let needed = entries_used * (key_size + os) + key_size;
|
||||
if pos + needed > file_data.len() {
|
||||
return Err(FormatError::UnexpectedEof {
|
||||
expected: pos + needed,
|
||||
available: file_data.len(),
|
||||
});
|
||||
}
|
||||
ensure_len(file_data, pos, needed)?;
|
||||
|
||||
let mut child_addrs = Vec::with_capacity(entries_used);
|
||||
for _ in 0..entries_used {
|
||||
@@ -246,8 +303,14 @@ pub fn collect_chunk_info(
|
||||
|
||||
let mut all_chunks = Vec::new();
|
||||
for child_addr in child_addrs {
|
||||
let child_chunks =
|
||||
collect_chunk_info(file_data, child_addr, ndims, offset_size, _length_size)?;
|
||||
let child_chunks = collect_chunk_info_inner(
|
||||
file_data,
|
||||
child_addr,
|
||||
ndims,
|
||||
offset_size,
|
||||
_length_size,
|
||||
depth + 1,
|
||||
)?;
|
||||
all_chunks.extend(child_chunks);
|
||||
}
|
||||
Ok(all_chunks)
|
||||
@@ -299,15 +362,17 @@ pub fn generate_implicit_chunks(
|
||||
}
|
||||
|
||||
/// Read a chunked dataset, decompressing chunks as needed.
|
||||
pub fn read_chunked_data(
|
||||
/// Every allocated chunk of a chunked dataset, for any supported chunk index,
|
||||
/// plus the spatial chunk dimensions. Chunks the file never allocated (sparse
|
||||
/// datasets) are simply absent from the list.
|
||||
pub fn list_chunks(
|
||||
file_data: &[u8],
|
||||
layout: &DataLayout,
|
||||
dataspace: &Dataspace,
|
||||
datatype: &Datatype,
|
||||
pipeline: Option<&FilterPipeline>,
|
||||
elem_size: usize,
|
||||
offset_size: u8,
|
||||
length_size: u8,
|
||||
) -> Result<Vec<u8>, FormatError> {
|
||||
) -> Result<(Vec<ChunkInfo>, Vec<usize>), FormatError> {
|
||||
let (
|
||||
chunk_dimensions,
|
||||
version,
|
||||
@@ -341,11 +406,11 @@ pub fn read_chunked_data(
|
||||
let addr = addr_opt
|
||||
.ok_or_else(|| FormatError::ChunkedReadError("no address for chunked layout".into()))?;
|
||||
|
||||
let elem_size = datatype.type_size() as usize;
|
||||
|
||||
// Both v3 and v4 include element size as last dim (rank+1)
|
||||
let ndims = chunk_dimensions.len();
|
||||
let rank = ndims - 1;
|
||||
let rank = ndims
|
||||
.checked_sub(1)
|
||||
.ok_or_else(|| FormatError::ChunkedReadError("chunked layout has no dimensions".into()))?;
|
||||
let chunk_dims: Vec<usize> = chunk_dimensions[..rank]
|
||||
.iter()
|
||||
.map(|&d| d as usize)
|
||||
@@ -369,7 +434,7 @@ pub fn read_chunked_data(
|
||||
}
|
||||
(4, Some(1)) => {
|
||||
// Single chunk — one chunk covering the entire dataset
|
||||
let chunk_byte_size: usize = chunk_dims.iter().product::<usize>() * elem_size;
|
||||
let chunk_byte_size = checked_chunk_byte_len(&chunk_dims, elem_size)?;
|
||||
let (csize, fmask) = if let Some(fs) = single_filtered_size {
|
||||
(fs as u32, single_filter_mask.unwrap_or(0))
|
||||
} else {
|
||||
@@ -384,24 +449,24 @@ pub fn read_chunked_data(
|
||||
}
|
||||
(4, Some(2)) => {
|
||||
// Implicit index — use spatial chunk dims only
|
||||
let spatial_chunk_dims: Vec<u32> = chunk_dimensions[..rank].to_vec();
|
||||
let spatial_chunk_dims: &[u32] = &chunk_dimensions[..rank];
|
||||
generate_implicit_chunks(
|
||||
addr,
|
||||
&dataspace.dimensions,
|
||||
&spatial_chunk_dims,
|
||||
spatial_chunk_dims,
|
||||
elem_size as u32,
|
||||
)
|
||||
}
|
||||
(4, Some(3)) => {
|
||||
// Fixed Array — use spatial chunk dims only
|
||||
let spatial_chunk_dims: Vec<u32> = chunk_dimensions[..rank].to_vec();
|
||||
let spatial_chunk_dims: &[u32] = &chunk_dimensions[..rank];
|
||||
let header =
|
||||
FixedArrayHeader::parse(file_data, addr as usize, offset_size, length_size)?;
|
||||
read_fixed_array_chunks(
|
||||
file_data,
|
||||
&header,
|
||||
&dataspace.dimensions,
|
||||
&spatial_chunk_dims,
|
||||
spatial_chunk_dims,
|
||||
elem_size as u32,
|
||||
offset_size,
|
||||
length_size,
|
||||
@@ -409,14 +474,14 @@ pub fn read_chunked_data(
|
||||
}
|
||||
(4, Some(4)) => {
|
||||
// Extensible Array — use spatial chunk dims only
|
||||
let spatial_chunk_dims: Vec<u32> = chunk_dimensions[..rank].to_vec();
|
||||
let spatial_chunk_dims: &[u32] = &chunk_dimensions[..rank];
|
||||
let header =
|
||||
ExtensibleArrayHeader::parse(file_data, addr as usize, offset_size, length_size)?;
|
||||
read_extensible_array_chunks(
|
||||
file_data,
|
||||
&header,
|
||||
&dataspace.dimensions,
|
||||
&spatial_chunk_dims,
|
||||
spatial_chunk_dims,
|
||||
elem_size as u32,
|
||||
offset_size,
|
||||
length_size,
|
||||
@@ -429,10 +494,38 @@ pub fn read_chunked_data(
|
||||
}
|
||||
};
|
||||
|
||||
Ok((chunks, chunk_dims))
|
||||
}
|
||||
|
||||
pub fn read_chunked_data(
|
||||
file_data: &[u8],
|
||||
layout: &DataLayout,
|
||||
dataspace: &Dataspace,
|
||||
datatype: &Datatype,
|
||||
pipeline: Option<&FilterPipeline>,
|
||||
offset_size: u8,
|
||||
length_size: u8,
|
||||
) -> Result<Vec<u8>, FormatError> {
|
||||
let elem_size = datatype.type_size() as usize;
|
||||
let (chunks, chunk_dims) = list_chunks(
|
||||
file_data,
|
||||
layout,
|
||||
dataspace,
|
||||
elem_size,
|
||||
offset_size,
|
||||
length_size,
|
||||
)?;
|
||||
let rank = chunk_dims.len();
|
||||
let ds_dims: Vec<usize> = dataspace.dimensions.iter().map(|&d| d as usize).collect();
|
||||
|
||||
// Assemble output
|
||||
let total_elements = dataspace.num_elements() as usize;
|
||||
let total_bytes = total_elements * elem_size;
|
||||
let mut output = vec![0u8; total_bytes];
|
||||
let total_bytes = checked_byte_len(dataspace.checked_num_elements()?, elem_size)?;
|
||||
if total_bytes == 0 {
|
||||
// Also keeps the stride products below in range: with a zero-sized
|
||||
// dimension the total is 0 even if other dimensions are huge.
|
||||
return Ok(Vec::new());
|
||||
}
|
||||
let mut output = alloc_output(total_bytes)?;
|
||||
|
||||
let mut ds_strides = vec![1usize; rank];
|
||||
for i in (0..rank.saturating_sub(1)).rev() {
|
||||
@@ -444,8 +537,7 @@ pub fn read_chunked_data(
|
||||
chunk_strides[i] = chunk_strides[i + 1] * chunk_dims[i + 1];
|
||||
}
|
||||
|
||||
let chunk_total_elements: usize = chunk_dims.iter().product();
|
||||
let chunk_total_bytes = chunk_total_elements * elem_size;
|
||||
let chunk_total_bytes = checked_chunk_byte_len(&chunk_dims, elem_size)?;
|
||||
|
||||
// Fast path: no filters — copy directly from file_data without intermediate alloc
|
||||
if pipeline.is_none() {
|
||||
@@ -459,12 +551,7 @@ pub fn read_chunked_data(
|
||||
|
||||
let c_addr = chunk_info.address as usize;
|
||||
let size = chunk_info.chunk_size as usize;
|
||||
if c_addr + size > file_data.len() {
|
||||
return Err(FormatError::UnexpectedEof {
|
||||
expected: c_addr + size,
|
||||
available: file_data.len(),
|
||||
});
|
||||
}
|
||||
ensure_len(file_data, c_addr, size)?;
|
||||
let chunk_data = &file_data[c_addr..c_addr + size];
|
||||
|
||||
if rank == 0 {
|
||||
@@ -577,7 +664,9 @@ pub fn read_chunked_data_cached(
|
||||
|
||||
let elem_size = datatype.type_size() as usize;
|
||||
let ndims = chunk_dimensions.len();
|
||||
let rank = ndims - 1;
|
||||
let rank = ndims
|
||||
.checked_sub(1)
|
||||
.ok_or_else(|| FormatError::ChunkedReadError("chunked layout has no dimensions".into()))?;
|
||||
let chunk_dims: Vec<usize> = chunk_dimensions[..rank]
|
||||
.iter()
|
||||
.map(|&d| d as usize)
|
||||
@@ -602,7 +691,7 @@ pub fn read_chunked_data_cached(
|
||||
let chunks = match (version, chunk_index_type) {
|
||||
(3, _) => collect_chunk_info(file_data, addr, ndims, offset_size, length_size)?,
|
||||
(4, Some(1)) => {
|
||||
let chunk_byte_size: usize = chunk_dims.iter().product::<usize>() * elem_size;
|
||||
let chunk_byte_size = checked_chunk_byte_len(&chunk_dims, elem_size)?;
|
||||
let (csize, fmask) = if let Some(fs) = single_filtered_size {
|
||||
(fs as u32, single_filter_mask.unwrap_or(0))
|
||||
} else {
|
||||
@@ -616,30 +705,30 @@ pub fn read_chunked_data_cached(
|
||||
}]
|
||||
}
|
||||
(4, Some(2)) => {
|
||||
let spatial_chunk_dims: Vec<u32> = chunk_dimensions[..rank].to_vec();
|
||||
let spatial_chunk_dims: &[u32] = &chunk_dimensions[..rank];
|
||||
generate_implicit_chunks(
|
||||
addr,
|
||||
&dataspace.dimensions,
|
||||
&spatial_chunk_dims,
|
||||
spatial_chunk_dims,
|
||||
elem_size as u32,
|
||||
)
|
||||
}
|
||||
(4, Some(3)) => {
|
||||
let spatial_chunk_dims: Vec<u32> = chunk_dimensions[..rank].to_vec();
|
||||
let spatial_chunk_dims: &[u32] = &chunk_dimensions[..rank];
|
||||
let header =
|
||||
FixedArrayHeader::parse(file_data, addr as usize, offset_size, length_size)?;
|
||||
read_fixed_array_chunks(
|
||||
file_data,
|
||||
&header,
|
||||
&dataspace.dimensions,
|
||||
&spatial_chunk_dims,
|
||||
spatial_chunk_dims,
|
||||
elem_size as u32,
|
||||
offset_size,
|
||||
length_size,
|
||||
)?
|
||||
}
|
||||
(4, Some(4)) => {
|
||||
let spatial_chunk_dims: Vec<u32> = chunk_dimensions[..rank].to_vec();
|
||||
let spatial_chunk_dims: &[u32] = &chunk_dimensions[..rank];
|
||||
let header = ExtensibleArrayHeader::parse(
|
||||
file_data,
|
||||
addr as usize,
|
||||
@@ -650,7 +739,7 @@ pub fn read_chunked_data_cached(
|
||||
file_data,
|
||||
&header,
|
||||
&dataspace.dimensions,
|
||||
&spatial_chunk_dims,
|
||||
spatial_chunk_dims,
|
||||
elem_size as u32,
|
||||
offset_size,
|
||||
length_size,
|
||||
@@ -668,9 +757,13 @@ pub fn read_chunked_data_cached(
|
||||
let chunks = cache.all_indexed_chunks().unwrap_or_default();
|
||||
|
||||
// Assemble output
|
||||
let total_elements = dataspace.num_elements() as usize;
|
||||
let total_bytes = total_elements * elem_size;
|
||||
let mut output = vec![0u8; total_bytes];
|
||||
let total_bytes = checked_byte_len(dataspace.checked_num_elements()?, elem_size)?;
|
||||
if total_bytes == 0 {
|
||||
// Also keeps the stride products below in range: with a zero-sized
|
||||
// dimension the total is 0 even if other dimensions are huge.
|
||||
return Ok(Vec::new());
|
||||
}
|
||||
let mut output = alloc_output(total_bytes)?;
|
||||
|
||||
let mut ds_strides = vec![1usize; rank];
|
||||
for i in (0..rank.saturating_sub(1)).rev() {
|
||||
@@ -682,25 +775,19 @@ pub fn read_chunked_data_cached(
|
||||
chunk_strides[i] = chunk_strides[i + 1] * chunk_dims[i + 1];
|
||||
}
|
||||
|
||||
let chunk_total_elements: usize = chunk_dims.iter().product();
|
||||
let chunk_total_bytes = chunk_total_elements * elem_size;
|
||||
let chunk_total_bytes = checked_chunk_byte_len(&chunk_dims, elem_size)?;
|
||||
|
||||
for chunk_info in &chunks {
|
||||
let coord: Vec<u64> = chunk_info.offsets.iter().take(rank).copied().collect();
|
||||
|
||||
// Try decompressed cache first
|
||||
let decompressed = if let Some(cached) = cache.get_decompressed(&coord) {
|
||||
let decompressed = if let Some(cached) = cache.get_decompressed_aligned(&coord) {
|
||||
cached
|
||||
} else {
|
||||
// Decompress from file
|
||||
let c_addr = chunk_info.address as usize;
|
||||
let size = chunk_info.chunk_size as usize;
|
||||
if c_addr + size > file_data.len() {
|
||||
return Err(FormatError::UnexpectedEof {
|
||||
expected: c_addr + size,
|
||||
available: file_data.len(),
|
||||
});
|
||||
}
|
||||
ensure_len(file_data, c_addr, size)?;
|
||||
let raw_chunk = &file_data[c_addr..c_addr + size];
|
||||
let dec = if let Some(pl) = pipeline {
|
||||
if chunk_info.filter_mask == 0 {
|
||||
@@ -711,8 +798,7 @@ pub fn read_chunked_data_cached(
|
||||
} else {
|
||||
raw_chunk.to_vec()
|
||||
};
|
||||
cache.put_decompressed(coord, dec.clone());
|
||||
dec
|
||||
cache.put_decompressed(coord, dec)
|
||||
};
|
||||
|
||||
let chunk_offsets: Vec<usize> = chunk_info
|
||||
@@ -934,7 +1020,9 @@ pub fn read_chunked_data_sweep(
|
||||
|
||||
let elem_size = datatype.type_size() as usize;
|
||||
let ndims = chunk_dimensions.len();
|
||||
let rank = ndims - 1;
|
||||
let rank = ndims
|
||||
.checked_sub(1)
|
||||
.ok_or_else(|| FormatError::ChunkedReadError("chunked layout has no dimensions".into()))?;
|
||||
let chunk_dims: Vec<usize> = chunk_dimensions[..rank]
|
||||
.iter()
|
||||
.map(|&d| d as usize)
|
||||
@@ -959,7 +1047,7 @@ pub fn read_chunked_data_sweep(
|
||||
let chunks = match (version, chunk_index_type) {
|
||||
(3, _) => collect_chunk_info(file_data, addr, ndims, offset_size, length_size)?,
|
||||
(4, Some(1)) => {
|
||||
let chunk_byte_size: usize = chunk_dims.iter().product::<usize>() * elem_size;
|
||||
let chunk_byte_size = checked_chunk_byte_len(&chunk_dims, elem_size)?;
|
||||
let (csize, fmask) = if let Some(fs) = single_filtered_size {
|
||||
(fs as u32, single_filter_mask.unwrap_or(0))
|
||||
} else {
|
||||
@@ -973,30 +1061,30 @@ pub fn read_chunked_data_sweep(
|
||||
}]
|
||||
}
|
||||
(4, Some(2)) => {
|
||||
let spatial_chunk_dims: Vec<u32> = chunk_dimensions[..rank].to_vec();
|
||||
let spatial_chunk_dims: &[u32] = &chunk_dimensions[..rank];
|
||||
generate_implicit_chunks(
|
||||
addr,
|
||||
&dataspace.dimensions,
|
||||
&spatial_chunk_dims,
|
||||
spatial_chunk_dims,
|
||||
elem_size as u32,
|
||||
)
|
||||
}
|
||||
(4, Some(3)) => {
|
||||
let spatial_chunk_dims: Vec<u32> = chunk_dimensions[..rank].to_vec();
|
||||
let spatial_chunk_dims: &[u32] = &chunk_dimensions[..rank];
|
||||
let header =
|
||||
FixedArrayHeader::parse(file_data, addr as usize, offset_size, length_size)?;
|
||||
read_fixed_array_chunks(
|
||||
file_data,
|
||||
&header,
|
||||
&dataspace.dimensions,
|
||||
&spatial_chunk_dims,
|
||||
spatial_chunk_dims,
|
||||
elem_size as u32,
|
||||
offset_size,
|
||||
length_size,
|
||||
)?
|
||||
}
|
||||
(4, Some(4)) => {
|
||||
let spatial_chunk_dims: Vec<u32> = chunk_dimensions[..rank].to_vec();
|
||||
let spatial_chunk_dims: &[u32] = &chunk_dimensions[..rank];
|
||||
let header = ExtensibleArrayHeader::parse(
|
||||
file_data,
|
||||
addr as usize,
|
||||
@@ -1007,7 +1095,7 @@ pub fn read_chunked_data_sweep(
|
||||
file_data,
|
||||
&header,
|
||||
&dataspace.dimensions,
|
||||
&spatial_chunk_dims,
|
||||
spatial_chunk_dims,
|
||||
elem_size as u32,
|
||||
offset_size,
|
||||
length_size,
|
||||
@@ -1025,9 +1113,13 @@ pub fn read_chunked_data_sweep(
|
||||
let chunks = cache.all_indexed_chunks().unwrap_or_default();
|
||||
|
||||
// Assemble output
|
||||
let total_elements = dataspace.num_elements() as usize;
|
||||
let total_bytes = total_elements * elem_size;
|
||||
let mut output = vec![0u8; total_bytes];
|
||||
let total_bytes = checked_byte_len(dataspace.checked_num_elements()?, elem_size)?;
|
||||
if total_bytes == 0 {
|
||||
// Also keeps the stride products below in range: with a zero-sized
|
||||
// dimension the total is 0 even if other dimensions are huge.
|
||||
return Ok(Vec::new());
|
||||
}
|
||||
let mut output = alloc_output(total_bytes)?;
|
||||
|
||||
let mut ds_strides = vec![1usize; rank];
|
||||
for i in (0..rank.saturating_sub(1)).rev() {
|
||||
@@ -1039,8 +1131,7 @@ pub fn read_chunked_data_sweep(
|
||||
chunk_strides[i] = chunk_strides[i + 1] * chunk_dims[i + 1];
|
||||
}
|
||||
|
||||
let chunk_total_elements: usize = chunk_dims.iter().product();
|
||||
let chunk_total_bytes = chunk_total_elements * elem_size;
|
||||
let chunk_total_bytes = checked_chunk_byte_len(&chunk_dims, elem_size)?;
|
||||
|
||||
for chunk_info in &chunks {
|
||||
let coord: Vec<u64> = chunk_info.offsets.iter().take(rank).copied().collect();
|
||||
@@ -1055,18 +1146,13 @@ pub fn read_chunked_data_sweep(
|
||||
}
|
||||
|
||||
// Try decompressed cache first
|
||||
let decompressed = if let Some(cached) = cache.get_decompressed(&coord) {
|
||||
let decompressed = if let Some(cached) = cache.get_decompressed_aligned(&coord) {
|
||||
cached
|
||||
} else {
|
||||
// Decompress from file
|
||||
let c_addr = chunk_info.address as usize;
|
||||
let size = chunk_info.chunk_size as usize;
|
||||
if c_addr + size > file_data.len() {
|
||||
return Err(FormatError::UnexpectedEof {
|
||||
expected: c_addr + size,
|
||||
available: file_data.len(),
|
||||
});
|
||||
}
|
||||
ensure_len(file_data, c_addr, size)?;
|
||||
let raw_chunk = &file_data[c_addr..c_addr + size];
|
||||
let dec = if let Some(pl) = pipeline {
|
||||
if chunk_info.filter_mask == 0 {
|
||||
@@ -1077,8 +1163,7 @@ pub fn read_chunked_data_sweep(
|
||||
} else {
|
||||
raw_chunk.to_vec()
|
||||
};
|
||||
cache.put_decompressed(coord, dec.clone());
|
||||
dec
|
||||
cache.put_decompressed(coord, dec)
|
||||
};
|
||||
|
||||
let chunk_offsets: Vec<usize> = chunk_info
|
||||
@@ -1161,7 +1246,9 @@ pub fn read_chunked_data_indexed(
|
||||
|
||||
let elem_size = datatype.type_size() as usize;
|
||||
let ndims = chunk_dimensions.len();
|
||||
let rank = ndims - 1;
|
||||
let rank = ndims
|
||||
.checked_sub(1)
|
||||
.ok_or_else(|| FormatError::ChunkedReadError("chunked layout has no dimensions".into()))?;
|
||||
let chunk_dims: Vec<usize> = chunk_dimensions[..rank]
|
||||
.iter()
|
||||
.map(|&d| d as usize)
|
||||
@@ -1186,7 +1273,7 @@ pub fn read_chunked_data_indexed(
|
||||
let chunks = match (version, chunk_index_type) {
|
||||
(3, _) => collect_chunk_info(file_data, addr, ndims, offset_size, length_size)?,
|
||||
(4, Some(1)) => {
|
||||
let chunk_byte_size: usize = chunk_dims.iter().product::<usize>() * elem_size;
|
||||
let chunk_byte_size = checked_chunk_byte_len(&chunk_dims, elem_size)?;
|
||||
let (csize, fmask) = if let Some(fs) = single_filtered_size {
|
||||
(fs as u32, single_filter_mask.unwrap_or(0))
|
||||
} else {
|
||||
@@ -1200,30 +1287,30 @@ pub fn read_chunked_data_indexed(
|
||||
}]
|
||||
}
|
||||
(4, Some(2)) => {
|
||||
let spatial_chunk_dims: Vec<u32> = chunk_dimensions[..rank].to_vec();
|
||||
let spatial_chunk_dims: &[u32] = &chunk_dimensions[..rank];
|
||||
generate_implicit_chunks(
|
||||
addr,
|
||||
&dataspace.dimensions,
|
||||
&spatial_chunk_dims,
|
||||
spatial_chunk_dims,
|
||||
elem_size as u32,
|
||||
)
|
||||
}
|
||||
(4, Some(3)) => {
|
||||
let spatial_chunk_dims: Vec<u32> = chunk_dimensions[..rank].to_vec();
|
||||
let spatial_chunk_dims: &[u32] = &chunk_dimensions[..rank];
|
||||
let header =
|
||||
FixedArrayHeader::parse(file_data, addr as usize, offset_size, length_size)?;
|
||||
read_fixed_array_chunks(
|
||||
file_data,
|
||||
&header,
|
||||
&dataspace.dimensions,
|
||||
&spatial_chunk_dims,
|
||||
spatial_chunk_dims,
|
||||
elem_size as u32,
|
||||
offset_size,
|
||||
length_size,
|
||||
)?
|
||||
}
|
||||
(4, Some(4)) => {
|
||||
let spatial_chunk_dims: Vec<u32> = chunk_dimensions[..rank].to_vec();
|
||||
let spatial_chunk_dims: &[u32] = &chunk_dimensions[..rank];
|
||||
let header = ExtensibleArrayHeader::parse(
|
||||
file_data,
|
||||
addr as usize,
|
||||
@@ -1234,7 +1321,7 @@ pub fn read_chunked_data_indexed(
|
||||
file_data,
|
||||
&header,
|
||||
&dataspace.dimensions,
|
||||
&spatial_chunk_dims,
|
||||
spatial_chunk_dims,
|
||||
elem_size as u32,
|
||||
offset_size,
|
||||
length_size,
|
||||
@@ -1271,19 +1358,14 @@ pub fn read_chunked_data_indexed(
|
||||
.ok_or_else(|| FormatError::ChunkedReadError("chunk layout not available".into()))?;
|
||||
|
||||
// Decompress chunks (using LRU cache where possible)
|
||||
let mut chunk_buffers: Vec<CacheAlignedBuffer> = Vec::with_capacity(mappings_info.len());
|
||||
let mut chunk_buffers: Vec<Arc<CacheAlignedBuffer>> = Vec::with_capacity(mappings_info.len());
|
||||
for (coord, file_offset, file_size, filter_mask) in &mappings_info {
|
||||
if let Some(cached) = cache.get_decompressed_aligned(coord) {
|
||||
chunk_buffers.push(cached);
|
||||
} else {
|
||||
let c_addr = *file_offset as usize;
|
||||
let size = *file_size as usize;
|
||||
if c_addr + size > file_data.len() {
|
||||
return Err(FormatError::UnexpectedEof {
|
||||
expected: c_addr + size,
|
||||
available: file_data.len(),
|
||||
});
|
||||
}
|
||||
ensure_len(file_data, c_addr, size)?;
|
||||
let raw_chunk = &file_data[c_addr..c_addr + size];
|
||||
let decompressed = if let Some(pl) = pipeline {
|
||||
if *filter_mask == 0 {
|
||||
@@ -1295,8 +1377,8 @@ pub fn read_chunked_data_indexed(
|
||||
raw_chunk.to_vec()
|
||||
};
|
||||
let aligned = CacheAlignedBuffer::from_vec(decompressed);
|
||||
cache.put_decompressed_aligned(coord.clone(), aligned.clone());
|
||||
chunk_buffers.push(aligned);
|
||||
let arc = cache.put_decompressed_aligned(coord.clone(), aligned);
|
||||
chunk_buffers.push(arc);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1331,9 +1413,18 @@ fn copy_chunk_to_output(
|
||||
// Fast path for 1-D: single contiguous copy per chunk
|
||||
let global_start = chunk_offsets[0];
|
||||
let copy_len = chunk_dims[0].min(ds_dims[0].saturating_sub(global_start));
|
||||
let src_bytes = copy_len * elem_size;
|
||||
let dst_start = global_start * elem_size;
|
||||
if src_bytes > 0 && dst_start + src_bytes <= output.len() && src_bytes <= chunk_data.len() {
|
||||
let (Some(src_bytes), Some(dst_start)) = (
|
||||
copy_len.checked_mul(elem_size),
|
||||
global_start.checked_mul(elem_size),
|
||||
) else {
|
||||
return;
|
||||
};
|
||||
if src_bytes > 0
|
||||
&& dst_start
|
||||
.checked_add(src_bytes)
|
||||
.is_some_and(|end| end <= output.len())
|
||||
&& src_bytes <= chunk_data.len()
|
||||
{
|
||||
output[dst_start..dst_start + src_bytes].copy_from_slice(&chunk_data[..src_bytes]);
|
||||
}
|
||||
return;
|
||||
@@ -1343,19 +1434,29 @@ fn copy_chunk_to_output(
|
||||
let inner_dim = rank - 1;
|
||||
let inner_chunk_len =
|
||||
chunk_dims[inner_dim].min(ds_dims[inner_dim].saturating_sub(chunk_offsets[inner_dim]));
|
||||
let row_bytes = inner_chunk_len * elem_size;
|
||||
let Some(row_bytes) = inner_chunk_len.checked_mul(elem_size) else {
|
||||
return;
|
||||
};
|
||||
|
||||
if row_bytes == 0 {
|
||||
return;
|
||||
}
|
||||
|
||||
// Number of rows = product of all outer chunk dimensions
|
||||
let outer_count: usize = chunk_dims[..inner_dim].iter().product();
|
||||
let Some(outer_count) = chunk_dims[..inner_dim]
|
||||
.iter()
|
||||
.try_fold(1usize, |acc, &d| acc.checked_mul(d))
|
||||
else {
|
||||
return;
|
||||
};
|
||||
|
||||
// Outer strides for iterating chunk-local coordinates
|
||||
let mut outer_strides = vec![1usize; inner_dim];
|
||||
for i in (0..inner_dim.saturating_sub(1)).rev() {
|
||||
outer_strides[i] = outer_strides[i + 1] * chunk_dims[i + 1];
|
||||
let Some(stride) = outer_strides[i + 1].checked_mul(chunk_dims[i + 1]) else {
|
||||
return;
|
||||
};
|
||||
outer_strides[i] = stride;
|
||||
}
|
||||
|
||||
for outer_idx in 0..outer_count {
|
||||
@@ -1375,13 +1476,29 @@ fn copy_chunk_to_output(
|
||||
remaining %= outer_strides[d];
|
||||
}
|
||||
|
||||
let global_coord = chunk_offsets[d] + coord_in_chunk;
|
||||
let Some(global_coord) = chunk_offsets[d].checked_add(coord_in_chunk) else {
|
||||
out_of_bounds = true;
|
||||
break;
|
||||
};
|
||||
if global_coord >= ds_dims[d] {
|
||||
out_of_bounds = true;
|
||||
break;
|
||||
}
|
||||
ds_flat += global_coord * ds_strides[d];
|
||||
src_flat += coord_in_chunk * chunk_strides[d];
|
||||
let (Some(ds_term), Some(src_term)) = (
|
||||
global_coord.checked_mul(ds_strides[d]),
|
||||
coord_in_chunk.checked_mul(chunk_strides[d]),
|
||||
) else {
|
||||
out_of_bounds = true;
|
||||
break;
|
||||
};
|
||||
let (Some(new_ds_flat), Some(new_src_flat)) =
|
||||
(ds_flat.checked_add(ds_term), src_flat.checked_add(src_term))
|
||||
else {
|
||||
out_of_bounds = true;
|
||||
break;
|
||||
};
|
||||
ds_flat = new_ds_flat;
|
||||
src_flat = new_src_flat;
|
||||
}
|
||||
|
||||
if out_of_bounds {
|
||||
@@ -1389,12 +1506,27 @@ fn copy_chunk_to_output(
|
||||
}
|
||||
|
||||
// Add innermost dimension offset
|
||||
ds_flat += chunk_offsets[inner_dim] * ds_strides[inner_dim];
|
||||
let Some(inner_term) = chunk_offsets[inner_dim].checked_mul(ds_strides[inner_dim]) else {
|
||||
continue;
|
||||
};
|
||||
let Some(ds_flat) = ds_flat.checked_add(inner_term) else {
|
||||
continue;
|
||||
};
|
||||
|
||||
let src_start = src_flat * elem_size;
|
||||
let dst_start = ds_flat * elem_size;
|
||||
let (Some(src_start), Some(dst_start)) = (
|
||||
src_flat.checked_mul(elem_size),
|
||||
ds_flat.checked_mul(elem_size),
|
||||
) else {
|
||||
continue;
|
||||
};
|
||||
|
||||
if src_start + row_bytes <= chunk_data.len() && dst_start + row_bytes <= output.len() {
|
||||
let fits = src_start
|
||||
.checked_add(row_bytes)
|
||||
.is_some_and(|end| end <= chunk_data.len())
|
||||
&& dst_start
|
||||
.checked_add(row_bytes)
|
||||
.is_some_and(|end| end <= output.len());
|
||||
if fits {
|
||||
output[dst_start..dst_start + row_bytes]
|
||||
.copy_from_slice(&chunk_data[src_start..src_start + row_bytes]);
|
||||
}
|
||||
@@ -1405,6 +1537,64 @@ fn copy_chunk_to_output(
|
||||
mod tests {
|
||||
use super::*;
|
||||
|
||||
fn simple_space(dimensions: Vec<u64>) -> Dataspace {
|
||||
Dataspace {
|
||||
space_type: crate::dataspace::DataspaceType::Simple,
|
||||
rank: dimensions.len() as u8,
|
||||
dimensions,
|
||||
max_dimensions: None,
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn crafted_dimensions_are_errors_not_wraparound() {
|
||||
// 2^63 * 2 wraps to 0 with a plain product; 2^40 * 2^40 wraps too.
|
||||
for dims in [
|
||||
vec![1u64 << 63, 2],
|
||||
vec![1 << 40, 1 << 40],
|
||||
vec![u64::MAX, u64::MAX],
|
||||
] {
|
||||
let space = simple_space(dims.clone());
|
||||
assert!(
|
||||
matches!(space.checked_num_elements(), Err(FormatError::Overflow(_))),
|
||||
"{dims:?}"
|
||||
);
|
||||
// The infallible accessor saturates instead of wrapping.
|
||||
assert_eq!(space.num_elements(), u64::MAX, "{dims:?}");
|
||||
}
|
||||
assert_eq!(simple_space(vec![3, 4]).checked_num_elements().unwrap(), 12);
|
||||
// A zero-sized dimension makes the whole product 0, not an overflow.
|
||||
assert_eq!(
|
||||
simple_space(vec![0, 1 << 40, 1 << 40])
|
||||
.checked_num_elements()
|
||||
.unwrap(),
|
||||
0
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn byte_length_helpers_check_overflow() {
|
||||
assert_eq!(checked_byte_len(10, 8).unwrap(), 80);
|
||||
assert!(matches!(
|
||||
checked_byte_len(u64::MAX, 8),
|
||||
Err(FormatError::Overflow(_))
|
||||
));
|
||||
assert_eq!(checked_chunk_byte_len(&[10, 10], 4).unwrap(), 400);
|
||||
assert!(matches!(
|
||||
checked_chunk_byte_len(&[usize::MAX, 2], 4),
|
||||
Err(FormatError::Overflow(_))
|
||||
));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn unallocatable_output_is_an_error_not_an_abort() {
|
||||
assert_eq!(alloc_output(16).unwrap(), vec![0u8; 16]);
|
||||
assert!(matches!(
|
||||
alloc_output(usize::MAX / 2),
|
||||
Err(FormatError::Overflow(_))
|
||||
));
|
||||
}
|
||||
|
||||
fn write_offset(buf: &mut Vec<u8>, val: u64, size: u8) {
|
||||
match size {
|
||||
4 => buf.extend_from_slice(&(val as u32).to_le_bytes()),
|
||||
@@ -1599,9 +1789,9 @@ mod tests {
|
||||
let chunk_bytes = chunk_size_elems * elem_size; // full chunk allocation
|
||||
|
||||
// Write chunk data (full chunk size, padding with zeros)
|
||||
for i in start..end {
|
||||
for (i, value) in values.iter().enumerate().take(end).skip(start) {
|
||||
let byte_offset = data_offset + (i - start) * elem_size;
|
||||
file_data[byte_offset..byte_offset + 8].copy_from_slice(&values[i].to_le_bytes());
|
||||
file_data[byte_offset..byte_offset + 8].copy_from_slice(&value.to_le_bytes());
|
||||
}
|
||||
|
||||
chunk_infos.push(ChunkInfo {
|
||||
@@ -1639,6 +1829,82 @@ mod tests {
|
||||
(file_data, layout, dataspace)
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn read_chunked_data_rejects_zero_dim_chunk_layout() {
|
||||
// Found by fuzzing: chunk_dimensions.len() == 0 caused `ndims - 1` to
|
||||
// underflow. A malformed/degenerate chunked layout must error cleanly.
|
||||
let layout = DataLayout::Chunked {
|
||||
chunk_dimensions: vec![],
|
||||
btree_address: Some(0),
|
||||
version: 3,
|
||||
chunk_index_type: None,
|
||||
single_chunk_filtered_size: None,
|
||||
single_chunk_filter_mask: None,
|
||||
};
|
||||
let dataspace = Dataspace {
|
||||
space_type: DataspaceType::Simple,
|
||||
rank: 1,
|
||||
dimensions: vec![10],
|
||||
max_dimensions: None,
|
||||
};
|
||||
let datatype = make_f64_type();
|
||||
let file_data = vec![0u8; 64];
|
||||
let result = read_chunked_data(&file_data, &layout, &dataspace, &datatype, None, 8, 8);
|
||||
assert!(
|
||||
matches!(result, Err(FormatError::ChunkedReadError(_))),
|
||||
"expected a clean ChunkedReadError, got {result:?}"
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn copy_chunk_to_output_1d_rejects_overflowing_offset_without_panicking() {
|
||||
// Found by fuzzing: `global_start * elem_size` overflowed for a
|
||||
// crafted large chunk offset.
|
||||
let chunk_data = vec![1u8; 16];
|
||||
let mut output = vec![0u8; 16];
|
||||
let chunk_offsets = [usize::MAX - 1];
|
||||
let chunk_dims = [1usize];
|
||||
let ds_dims = [usize::MAX];
|
||||
let ds_strides = [1usize];
|
||||
let chunk_strides = [1usize];
|
||||
copy_chunk_to_output(
|
||||
&chunk_data,
|
||||
&mut output,
|
||||
&chunk_offsets,
|
||||
&chunk_dims,
|
||||
&ds_dims,
|
||||
&ds_strides,
|
||||
&chunk_strides,
|
||||
8,
|
||||
1,
|
||||
);
|
||||
// No panic; the out-of-range write was skipped, output left untouched.
|
||||
assert_eq!(output, vec![0u8; 16]);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn copy_chunk_to_output_nd_rejects_overflowing_offset_without_panicking() {
|
||||
let chunk_data = vec![1u8; 16];
|
||||
let mut output = vec![0u8; 16];
|
||||
let chunk_offsets = [usize::MAX - 1, 0];
|
||||
let chunk_dims = [1usize, 1usize];
|
||||
let ds_dims = [usize::MAX, usize::MAX];
|
||||
let ds_strides = [1usize, 1usize];
|
||||
let chunk_strides = [1usize, 1usize];
|
||||
copy_chunk_to_output(
|
||||
&chunk_data,
|
||||
&mut output,
|
||||
&chunk_offsets,
|
||||
&chunk_dims,
|
||||
&ds_dims,
|
||||
&ds_strides,
|
||||
&chunk_strides,
|
||||
8,
|
||||
2,
|
||||
);
|
||||
assert_eq!(output, vec![0u8; 16]);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn read_1d_two_chunks_no_compression() {
|
||||
let values: Vec<f64> = (0..20).map(|i| i as f64).collect();
|
||||
@@ -1703,8 +1969,8 @@ mod tests {
|
||||
for chunk_idx in 0..2 {
|
||||
let start = chunk_idx * chunk_elems;
|
||||
let mut chunk_bytes = Vec::new();
|
||||
for i in start..start + chunk_elems {
|
||||
chunk_bytes.extend_from_slice(&values[i].to_le_bytes());
|
||||
for value in values.iter().skip(start).take(chunk_elems) {
|
||||
chunk_bytes.extend_from_slice(&value.to_le_bytes());
|
||||
}
|
||||
let compressed = compress_chunk(&chunk_bytes, &pipeline, elem_size as u32).unwrap();
|
||||
|
||||
@@ -1851,6 +2117,54 @@ mod tests {
|
||||
assert_eq!(err, FormatError::InvalidBTreeNodeType(0));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn collect_chunk_info_rejects_near_usize_max_offset() {
|
||||
let file_data = vec![0u8; 64];
|
||||
let result = collect_chunk_info(&file_data, u64::MAX - 4, 2, 8, 8);
|
||||
assert!(
|
||||
matches!(result, Err(FormatError::UnexpectedEof { .. })),
|
||||
"expected a clean UnexpectedEof, got {result:?}"
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn collect_chunk_info_rejects_self_referencing_internal_node() {
|
||||
// A type-1 internal node (level 1) whose single child address points
|
||||
// back to itself: an infinite-recursion / cyclic B-tree attack.
|
||||
let ndims = 2;
|
||||
let os: u8 = 8;
|
||||
let mut buf = Vec::new();
|
||||
buf.extend_from_slice(b"TREE");
|
||||
buf.push(1); // node_type = 1 (raw data chunks)
|
||||
buf.push(1); // node_level = 1 (internal)
|
||||
buf.extend_from_slice(&1u16.to_le_bytes()); // entries_used = 1
|
||||
write_offset(&mut buf, u64::MAX, os); // left sibling undefined
|
||||
write_offset(&mut buf, u64::MAX, os); // right sibling undefined
|
||||
// key[0]: chunk_size(4) + filter_mask(4) + ndims offsets
|
||||
buf.extend_from_slice(&0u32.to_le_bytes());
|
||||
buf.extend_from_slice(&0u32.to_le_bytes());
|
||||
for _ in 0..ndims {
|
||||
write_offset(&mut buf, 0, os);
|
||||
}
|
||||
// child[0]: points back to offset 0 (this same node) — cyclic.
|
||||
write_offset(&mut buf, 0, os);
|
||||
// final key
|
||||
buf.extend_from_slice(&0u32.to_le_bytes());
|
||||
buf.extend_from_slice(&0u32.to_le_bytes());
|
||||
for _ in 0..ndims {
|
||||
write_offset(&mut buf, u64::MAX, os);
|
||||
}
|
||||
|
||||
let mut file_data = vec![0u8; 256];
|
||||
file_data[..buf.len()].copy_from_slice(&buf);
|
||||
|
||||
let result = collect_chunk_info(&file_data, 0, ndims, os, os);
|
||||
assert!(
|
||||
matches!(result, Err(FormatError::NestingDepthExceeded)),
|
||||
"expected a clean NestingDepthExceeded, got {result:?}"
|
||||
);
|
||||
}
|
||||
|
||||
// --- Implicit chunk generation tests ---
|
||||
|
||||
#[test]
|
||||
|
||||
@@ -11,8 +11,8 @@ use crate::chunk_cache::{CACHE_LINE_SIZE, align_to_cache_line};
|
||||
use crate::ea_writer;
|
||||
use crate::error::FormatError;
|
||||
use crate::filter_pipeline::{
|
||||
FILTER_DEFLATE, FILTER_FLETCHER32, FILTER_LZ4, FILTER_SHUFFLE, FILTER_ZSTD, FilterDescription,
|
||||
FilterPipeline,
|
||||
FILTER_DEFLATE, FILTER_FLETCHER32, FILTER_LZ4, FILTER_PCODEC, FILTER_SHUFFLE, FILTER_ZSTD,
|
||||
FilterDescription, FilterPipeline,
|
||||
};
|
||||
use crate::filters::compress_chunk;
|
||||
|
||||
@@ -34,13 +34,19 @@ pub struct ChunkOptions {
|
||||
/// Deflate compression level (0-9), None = no deflate.
|
||||
pub deflate_level: Option<u32>,
|
||||
/// Whether to apply shuffle filter before compression.
|
||||
/// If `false` AND compression is enabled AND `no_shuffle` is `false`,
|
||||
/// shuffle is auto-applied (matches h5py default behavior).
|
||||
pub shuffle: bool,
|
||||
/// Disable the automatic shuffle pre-filter. Set via `without_shuffle()`.
|
||||
pub no_shuffle: bool,
|
||||
/// Whether to apply fletcher32 checksum.
|
||||
pub fletcher32: bool,
|
||||
/// Whether to use LZ4 compression (filter ID 32004).
|
||||
pub lz4: bool,
|
||||
/// Zstandard compression level (1-22), None = no zstd. Filter ID 32015.
|
||||
pub zstd_level: Option<u32>,
|
||||
/// Pcodec lossless numerical compression. Filter ID 32023.
|
||||
pub pcodec: bool,
|
||||
}
|
||||
|
||||
impl ChunkOptions {
|
||||
@@ -52,13 +58,20 @@ impl ChunkOptions {
|
||||
|| self.fletcher32
|
||||
|| self.lz4
|
||||
|| self.zstd_level.is_some()
|
||||
|| self.pcodec
|
||||
}
|
||||
|
||||
/// Build a FilterPipeline from the options.
|
||||
pub fn build_pipeline(&self, element_size: u32) -> Option<FilterPipeline> {
|
||||
let mut filters = Vec::new();
|
||||
|
||||
if self.shuffle {
|
||||
let has_compression =
|
||||
self.deflate_level.is_some() || self.zstd_level.is_some() || self.lz4 || self.pcodec;
|
||||
|
||||
// Shuffle before compression. Applied if explicitly requested OR if compression
|
||||
// is active and the caller hasn't disabled it — matches h5py default behavior
|
||||
// and implements TDT byte-grouping (arXiv:2506.18062) for free.
|
||||
if self.shuffle || (has_compression && !self.no_shuffle) {
|
||||
filters.push(FilterDescription {
|
||||
filter_id: FILTER_SHUFFLE,
|
||||
name: None,
|
||||
@@ -67,8 +80,15 @@ impl ChunkOptions {
|
||||
});
|
||||
}
|
||||
|
||||
// Compression filters (mutually exclusive, priority: zstd > lz4 > deflate)
|
||||
if let Some(level) = self.zstd_level {
|
||||
// Compression filters (mutually exclusive, priority: pcodec > zstd > lz4 > deflate)
|
||||
if self.pcodec {
|
||||
filters.push(FilterDescription {
|
||||
filter_id: FILTER_PCODEC,
|
||||
name: Some("pcodec".into()),
|
||||
flags: 0,
|
||||
client_data: vec![element_size],
|
||||
});
|
||||
} else if let Some(level) = self.zstd_level {
|
||||
filters.push(FilterDescription {
|
||||
filter_id: FILTER_ZSTD,
|
||||
name: Some("zstd".into()),
|
||||
@@ -238,8 +258,12 @@ pub fn split_into_chunks(
|
||||
}
|
||||
|
||||
/// Parallel compression threshold: use rayon when chunk count exceeds this.
|
||||
///
|
||||
/// Lowered to 2 to enable parallel compression for typical 4-chunk workloads
|
||||
/// (e.g., 128×128 matrix with 32-row chunks = 4 chunks). Rayon's overhead is
|
||||
/// ~2 µs, worthwhile at ≥2 chunks with any real compression (arXiv:2206.14761).
|
||||
#[cfg(feature = "parallel")]
|
||||
const PARALLEL_COMPRESS_THRESHOLD: usize = 4;
|
||||
const PARALLEL_COMPRESS_THRESHOLD: usize = 2;
|
||||
|
||||
/// Compress all chunks, using parallel compression when beneficial.
|
||||
///
|
||||
@@ -545,6 +569,158 @@ pub fn build_fixed_array_at(
|
||||
combined
|
||||
}
|
||||
|
||||
/// Compressed chunks ready to be laid out at any file address.
|
||||
///
|
||||
/// Created by [`precompress_chunks`] and consumed by
|
||||
/// [`build_chunked_data_from_precompressed`]. Caching this between the two
|
||||
/// writer passes eliminates the double-compression that the two-pass layout
|
||||
/// algorithm previously performed.
|
||||
pub struct PrecompressedChunks {
|
||||
/// Per-chunk: (raw_size_bytes, compressed_bytes).
|
||||
pub chunks: Vec<(u64, Vec<u8>)>,
|
||||
pub has_filters: bool,
|
||||
pub element_size: usize,
|
||||
pub shape: Vec<u64>,
|
||||
pub chunk_dims: Vec<u64>,
|
||||
pub pipeline_message: Option<Vec<u8>>,
|
||||
}
|
||||
|
||||
/// Compress all chunks of a dataset without laying them out at a file address.
|
||||
///
|
||||
/// Call this once per dataset in Pass 1, cache the result, then call
|
||||
/// [`build_chunked_data_from_precompressed`] in both Pass 1 (dummy address
|
||||
/// for sizing) and Pass 2 (real address) to avoid re-compressing.
|
||||
pub fn precompress_chunks(
|
||||
raw_data: &[u8],
|
||||
shape: &[u64],
|
||||
chunk_dims: &[u64],
|
||||
element_size: usize,
|
||||
options: &ChunkOptions,
|
||||
) -> Result<PrecompressedChunks, FormatError> {
|
||||
let pipeline = options.build_pipeline(element_size as u32);
|
||||
let has_filters = pipeline.is_some();
|
||||
let pipeline_message = pipeline.as_ref().map(|pl| pl.serialize());
|
||||
|
||||
let raw_chunks = split_into_chunks(raw_data, shape, chunk_dims, element_size);
|
||||
let compressed = compress_all_chunks(&raw_chunks, &pipeline, element_size as u32)?;
|
||||
|
||||
let chunks = raw_chunks
|
||||
.into_iter()
|
||||
.zip(compressed)
|
||||
.map(|((_offsets, raw_bytes), c)| (raw_bytes.len() as u64, c))
|
||||
.collect();
|
||||
|
||||
Ok(PrecompressedChunks {
|
||||
chunks,
|
||||
has_filters,
|
||||
element_size,
|
||||
shape: shape.to_vec(),
|
||||
chunk_dims: chunk_dims.to_vec(),
|
||||
pipeline_message,
|
||||
})
|
||||
}
|
||||
|
||||
/// Lay out precompressed chunks at `base_address` and build index structures.
|
||||
///
|
||||
/// This is the address-dependent half of chunk writing. Call it in Pass 1
|
||||
/// with a dummy address (to get the blob size), and again in Pass 2 with the
|
||||
/// real address — both times reusing the same [`PrecompressedChunks`] so
|
||||
/// compression happens only once.
|
||||
pub fn build_chunked_data_from_precompressed(
|
||||
pre: &PrecompressedChunks,
|
||||
base_address: u64,
|
||||
maxshape: Option<&[u64]>,
|
||||
) -> ChunkedDataResult {
|
||||
let offset_size: u8 = 8;
|
||||
let length_size: u8 = 8;
|
||||
let num_chunks = pre.chunks.len();
|
||||
let element_size = pre.element_size;
|
||||
|
||||
let mut data_buf = Vec::new();
|
||||
let mut written_chunks = Vec::with_capacity(num_chunks);
|
||||
|
||||
for (raw_size, compressed) in &pre.chunks {
|
||||
let aligned_offset = align_to_cache_line(data_buf.len());
|
||||
if aligned_offset > data_buf.len() {
|
||||
data_buf.resize(aligned_offset, 0u8);
|
||||
}
|
||||
let address = base_address + data_buf.len() as u64;
|
||||
let compressed_size = compressed.len() as u64;
|
||||
data_buf.extend_from_slice(compressed);
|
||||
written_chunks.push(WrittenChunk {
|
||||
address,
|
||||
compressed_size,
|
||||
raw_size: *raw_size,
|
||||
filter_mask: 0,
|
||||
});
|
||||
}
|
||||
|
||||
let chunk_dims_u32: Vec<u32> = pre.chunk_dims.iter().map(|&d| d as u32).collect();
|
||||
let use_extensible = maxshape.is_some_and(|ms| ms.contains(&u64::MAX));
|
||||
|
||||
let aligned_idx = align_to_cache_line(data_buf.len());
|
||||
if aligned_idx > data_buf.len() {
|
||||
data_buf.resize(aligned_idx, 0u8);
|
||||
}
|
||||
|
||||
let layout_message = if use_extensible {
|
||||
let ea_address = base_address + data_buf.len() as u64;
|
||||
let ea_bytes = ea_writer::build_extensible_array_at(
|
||||
&written_chunks,
|
||||
offset_size,
|
||||
length_size,
|
||||
pre.has_filters,
|
||||
ea_address,
|
||||
);
|
||||
data_buf.extend_from_slice(&ea_bytes);
|
||||
ea_writer::serialize_v4_extensible_array(
|
||||
&chunk_dims_u32,
|
||||
ea_address,
|
||||
offset_size,
|
||||
element_size as u32,
|
||||
)
|
||||
} else if num_chunks == 1 {
|
||||
let chunk_addr = written_chunks[0].address;
|
||||
let filtered_size = if pre.has_filters {
|
||||
Some(written_chunks[0].compressed_size)
|
||||
} else {
|
||||
None
|
||||
};
|
||||
let filter_mask = if pre.has_filters { Some(0u32) } else { None };
|
||||
serialize_v4_single_chunk(
|
||||
&chunk_dims_u32,
|
||||
chunk_addr,
|
||||
filtered_size,
|
||||
filter_mask,
|
||||
offset_size,
|
||||
element_size as u32,
|
||||
)
|
||||
} else {
|
||||
let fa_address = base_address + data_buf.len() as u64;
|
||||
let fa_bytes = build_fixed_array_at(
|
||||
&written_chunks,
|
||||
offset_size,
|
||||
length_size,
|
||||
pre.has_filters,
|
||||
fa_address,
|
||||
);
|
||||
data_buf.extend_from_slice(&fa_bytes);
|
||||
serialize_v4_fixed_array(
|
||||
&chunk_dims_u32,
|
||||
fa_address,
|
||||
offset_size,
|
||||
element_size as u32,
|
||||
10, // max_nelmts_bits — matches h5py convention
|
||||
)
|
||||
};
|
||||
|
||||
ChunkedDataResult {
|
||||
data_bytes: data_buf,
|
||||
layout_message,
|
||||
pipeline_message: pre.pipeline_message.clone(),
|
||||
}
|
||||
}
|
||||
|
||||
/// Build chunked data with absolute addresses.
|
||||
/// If `maxshape` has unlimited dims, uses Extensible Array index.
|
||||
pub fn build_chunked_data_at(
|
||||
@@ -576,118 +752,12 @@ pub fn build_chunked_data_at_ext(
|
||||
base_address: u64,
|
||||
maxshape: Option<&[u64]>,
|
||||
) -> Result<ChunkedDataResult, FormatError> {
|
||||
let pipeline = options.build_pipeline(element_size as u32);
|
||||
|
||||
let chunks = split_into_chunks(raw_data, shape, chunk_dims, element_size);
|
||||
let num_chunks = chunks.len();
|
||||
let has_filters = pipeline.is_some();
|
||||
|
||||
// Compress all chunks up front (parallel under the `parallel` feature),
|
||||
// then lay them out sequentially with cache-line padding for aligned access.
|
||||
// Compression order matches chunk order, so the on-disk layout is identical
|
||||
// to the previous per-chunk sequential path.
|
||||
let compressed_chunks = compress_all_chunks(&chunks, &pipeline, element_size as u32)?;
|
||||
|
||||
let mut data_buf = Vec::new();
|
||||
let mut written_chunks = Vec::with_capacity(num_chunks);
|
||||
|
||||
for ((_offsets, chunk_bytes), compressed) in chunks.iter().zip(compressed_chunks.iter()) {
|
||||
// Pad current position to cache-line boundary
|
||||
let aligned_offset = align_to_cache_line(data_buf.len());
|
||||
if aligned_offset > data_buf.len() {
|
||||
data_buf.resize(aligned_offset, 0u8);
|
||||
}
|
||||
|
||||
let address = base_address + data_buf.len() as u64;
|
||||
let compressed_size = compressed.len() as u64;
|
||||
let raw_size = chunk_bytes.len() as u64;
|
||||
|
||||
data_buf.extend_from_slice(compressed);
|
||||
|
||||
written_chunks.push(WrittenChunk {
|
||||
address,
|
||||
compressed_size,
|
||||
raw_size,
|
||||
filter_mask: 0,
|
||||
});
|
||||
}
|
||||
|
||||
let chunk_dims_u32: Vec<u32> = chunk_dims.iter().map(|&d| d as u32).collect();
|
||||
let offset_size: u8 = 8;
|
||||
let length_size: u8 = 8;
|
||||
|
||||
// Determine if we should use Extensible Array (resizable datasets)
|
||||
let use_extensible = maxshape.is_some_and(|ms| ms.contains(&u64::MAX));
|
||||
|
||||
// Pad before index structures so they are also cache-line aligned
|
||||
let aligned_idx = align_to_cache_line(data_buf.len());
|
||||
if aligned_idx > data_buf.len() {
|
||||
data_buf.resize(aligned_idx, 0u8);
|
||||
}
|
||||
|
||||
let layout_message = if use_extensible {
|
||||
let ea_address = base_address + data_buf.len() as u64;
|
||||
|
||||
let ea_bytes = ea_writer::build_extensible_array_at(
|
||||
&written_chunks,
|
||||
offset_size,
|
||||
length_size,
|
||||
has_filters,
|
||||
ea_address,
|
||||
);
|
||||
data_buf.extend_from_slice(&ea_bytes);
|
||||
|
||||
ea_writer::serialize_v4_extensible_array(
|
||||
&chunk_dims_u32,
|
||||
ea_address,
|
||||
offset_size,
|
||||
element_size as u32,
|
||||
)
|
||||
} else if num_chunks == 1 {
|
||||
let chunk_addr = written_chunks[0].address;
|
||||
let filtered_size = if has_filters {
|
||||
Some(written_chunks[0].compressed_size)
|
||||
} else {
|
||||
None
|
||||
};
|
||||
let filter_mask = if has_filters { Some(0u32) } else { None };
|
||||
serialize_v4_single_chunk(
|
||||
&chunk_dims_u32,
|
||||
chunk_addr,
|
||||
filtered_size,
|
||||
filter_mask,
|
||||
offset_size,
|
||||
element_size as u32,
|
||||
)
|
||||
} else {
|
||||
let fa_address = base_address + data_buf.len() as u64;
|
||||
let max_bits: u8 = 10;
|
||||
|
||||
let fa_bytes = build_fixed_array_at(
|
||||
&written_chunks,
|
||||
offset_size,
|
||||
length_size,
|
||||
has_filters,
|
||||
fa_address,
|
||||
);
|
||||
data_buf.extend_from_slice(&fa_bytes);
|
||||
|
||||
serialize_v4_fixed_array(
|
||||
&chunk_dims_u32,
|
||||
fa_address,
|
||||
offset_size,
|
||||
element_size as u32,
|
||||
max_bits,
|
||||
)
|
||||
};
|
||||
|
||||
let pipeline_message = pipeline.as_ref().map(|pl| pl.serialize());
|
||||
|
||||
Ok(ChunkedDataResult {
|
||||
data_bytes: data_buf,
|
||||
layout_message,
|
||||
pipeline_message,
|
||||
})
|
||||
let pre = precompress_chunks(raw_data, shape, chunk_dims, element_size, options)?;
|
||||
Ok(build_chunked_data_from_precompressed(
|
||||
&pre,
|
||||
base_address,
|
||||
maxshape,
|
||||
))
|
||||
}
|
||||
|
||||
/// Write selected elements into an existing in-memory dataset buffer.
|
||||
@@ -1075,36 +1145,55 @@ mod tests {
|
||||
|
||||
#[test]
|
||||
fn chunk_options_pipeline_deflate() {
|
||||
// Auto-shuffle is applied before compression by default (matches h5py).
|
||||
let options = ChunkOptions {
|
||||
deflate_level: Some(6),
|
||||
..Default::default()
|
||||
};
|
||||
let pl = options.build_pipeline(8).unwrap();
|
||||
assert_eq!(pl.filters.len(), 2);
|
||||
assert_eq!(pl.filters[0].filter_id, FILTER_SHUFFLE);
|
||||
assert_eq!(pl.filters[1].filter_id, FILTER_DEFLATE);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn chunk_options_pipeline_deflate_no_shuffle() {
|
||||
// Users can opt out of auto-shuffle with no_shuffle = true.
|
||||
let options = ChunkOptions {
|
||||
deflate_level: Some(6),
|
||||
no_shuffle: true,
|
||||
..Default::default()
|
||||
};
|
||||
let pl = options.build_pipeline(8).unwrap();
|
||||
assert_eq!(pl.filters.len(), 1);
|
||||
assert_eq!(pl.filters[0].filter_id, FILTER_DEFLATE);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn chunk_options_pipeline_lz4() {
|
||||
// Auto-shuffle before LZ4.
|
||||
let options = ChunkOptions {
|
||||
lz4: true,
|
||||
..Default::default()
|
||||
};
|
||||
let pl = options.build_pipeline(8).unwrap();
|
||||
assert_eq!(pl.filters.len(), 1);
|
||||
assert_eq!(pl.filters[0].filter_id, FILTER_LZ4);
|
||||
assert_eq!(pl.filters.len(), 2);
|
||||
assert_eq!(pl.filters[0].filter_id, FILTER_SHUFFLE);
|
||||
assert_eq!(pl.filters[1].filter_id, FILTER_LZ4);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn chunk_options_pipeline_zstd() {
|
||||
// Auto-shuffle before Zstd.
|
||||
let options = ChunkOptions {
|
||||
zstd_level: Some(3),
|
||||
..Default::default()
|
||||
};
|
||||
let pl = options.build_pipeline(8).unwrap();
|
||||
assert_eq!(pl.filters.len(), 1);
|
||||
assert_eq!(pl.filters[0].filter_id, FILTER_ZSTD);
|
||||
assert_eq!(pl.filters[0].client_data, vec![3]);
|
||||
assert_eq!(pl.filters.len(), 2);
|
||||
assert_eq!(pl.filters[0].filter_id, FILTER_SHUFFLE);
|
||||
assert_eq!(pl.filters[1].filter_id, FILTER_ZSTD);
|
||||
assert_eq!(pl.filters[1].client_data, vec![3]);
|
||||
}
|
||||
|
||||
#[test]
|
||||
@@ -1115,8 +1204,10 @@ mod tests {
|
||||
..Default::default()
|
||||
};
|
||||
let pl = options.build_pipeline(8).unwrap();
|
||||
assert_eq!(pl.filters.len(), 1);
|
||||
assert_eq!(pl.filters[0].filter_id, FILTER_ZSTD);
|
||||
// shuffle + zstd (deflate is ignored when zstd wins priority)
|
||||
assert_eq!(pl.filters.len(), 2);
|
||||
assert_eq!(pl.filters[0].filter_id, FILTER_SHUFFLE);
|
||||
assert_eq!(pl.filters[1].filter_id, FILTER_ZSTD);
|
||||
}
|
||||
|
||||
#[test]
|
||||
|
||||
@@ -821,7 +821,8 @@ mod tests {
|
||||
let blob = [
|
||||
0x00u8, // block version 0
|
||||
0x01, 0, 0, 0, 0, 0, 0, 0, // nused = 1
|
||||
0x73, 0x72, 0x63, 0x5f, 0x65, 0x78, 0x74, 0x2e, 0x68, 0x35, 0x00, // "src_ext.h5\0"
|
||||
0x73, 0x72, 0x63, 0x5f, 0x65, 0x78, 0x74, 0x2e, 0x68, 0x35,
|
||||
0x00, // "src_ext.h5\0"
|
||||
0x64, 0x61, 0x74, 0x61, 0x00, // "data\0"
|
||||
0x03, 0, 0, 0, 0x01, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, // source sel = ALL
|
||||
0x03, 0, 0, 0, 0x01, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, // virtual sel = ALL
|
||||
@@ -846,7 +847,7 @@ mod tests {
|
||||
// One entry whose source selection (ALL) is truncated to 8 of 16 bytes.
|
||||
let blob = [
|
||||
0x01u8, // version 1
|
||||
0x01, 0, 0, 0, 0, 0, 0, 0, // nused = 1
|
||||
0x01, 0, 0, 0, 0, 0, 0, 0, // nused = 1
|
||||
0x04, // same-file marker
|
||||
0x78, 0x00, // "x\0"
|
||||
0x03, 0, 0, 0, 0x01, 0, 0, 0, // ALL header, truncated (8 of 16 bytes)
|
||||
|
||||
@@ -0,0 +1,200 @@
|
||||
//! Write-side helpers for VDS (Virtual Dataset Source) mapping serialization.
|
||||
//!
|
||||
//! [`serialize_vds_mappings`] produces the byte blob stored in a global heap
|
||||
//! object and referenced from a Data Layout v4 class=3 (Virtual) message.
|
||||
//! Its output is byte-compatible with what [`crate::data_layout::parse_vds_mappings`]
|
||||
//! can parse back.
|
||||
|
||||
#[cfg(not(feature = "std"))]
|
||||
use alloc::vec::Vec;
|
||||
|
||||
use crate::data_layout::VdsMapping;
|
||||
|
||||
/// Serialize a slice of [`VdsMapping`]s into the global-heap object byte format.
|
||||
///
|
||||
/// # Layout
|
||||
///
|
||||
/// ```text
|
||||
/// version(1) · nused(length_size, LE) · entry[nused]
|
||||
/// ```
|
||||
///
|
||||
/// Each entry:
|
||||
/// - **version 0** (at least one external source file): null-terminated source
|
||||
/// file name, then null-terminated source dataset name, then source selection
|
||||
/// bytes (self-describing), then virtual selection bytes (self-describing).
|
||||
/// - **version 1** (all same-file): a single `0x04` marker byte in place of the
|
||||
/// file name, then null-terminated source dataset name, then the two
|
||||
/// self-describing selection blobs.
|
||||
///
|
||||
/// The selections are written as-is from [`VdsMapping::source_selection`] and
|
||||
/// [`VdsMapping::virtual_selection`]; the caller is responsible for ensuring
|
||||
/// they are valid serialized `H5S` selections that [`crate::selection::Selection::decode_serialized`]
|
||||
/// can consume.
|
||||
///
|
||||
/// `length_size` must be 2, 4, or 8; any other value falls back to 8.
|
||||
pub fn serialize_vds_mappings(mappings: &[VdsMapping], length_size: u8) -> Vec<u8> {
|
||||
let mut buf = Vec::new();
|
||||
|
||||
// Block version 0 = at least one external (non-same-file) source;
|
||||
// block version 1 = all sources are in the same file (source_file == ".").
|
||||
let all_same_file = mappings
|
||||
.iter()
|
||||
.all(|m| m.source_file.is_empty() || m.source_file == ".");
|
||||
let version: u8 = if all_same_file { 1 } else { 0 };
|
||||
buf.push(version);
|
||||
|
||||
// nused: number of mappings, encoded as little-endian `length_size` bytes.
|
||||
write_length(&mut buf, mappings.len() as u64, length_size);
|
||||
|
||||
for m in mappings {
|
||||
if version == 0 {
|
||||
// External file: write the file name as a null-terminated string.
|
||||
buf.extend_from_slice(m.source_file.as_bytes());
|
||||
buf.push(0u8);
|
||||
} else {
|
||||
// Same-file: the marker byte that `parse_vds_mappings` recognises as
|
||||
// the same-file sentinel (0x04).
|
||||
buf.push(0x04u8);
|
||||
}
|
||||
|
||||
// Source dataset path: null-terminated string.
|
||||
buf.extend_from_slice(m.source_dataset.as_bytes());
|
||||
buf.push(0u8);
|
||||
|
||||
// Source selection: raw self-describing bytes (no separate length prefix).
|
||||
buf.extend_from_slice(&m.source_selection);
|
||||
|
||||
// Virtual selection: raw self-describing bytes (no separate length prefix).
|
||||
buf.extend_from_slice(&m.virtual_selection);
|
||||
}
|
||||
|
||||
buf
|
||||
}
|
||||
|
||||
/// Encode `val` as a little-endian integer of `size` bytes and push it into
|
||||
/// `buf`. Supported sizes: 2, 4, 8. Any other value falls back to 8 bytes.
|
||||
pub(crate) fn write_length(buf: &mut Vec<u8>, val: u64, size: u8) {
|
||||
match size {
|
||||
2 => buf.extend_from_slice(&(val as u16).to_le_bytes()),
|
||||
4 => buf.extend_from_slice(&(val as u32).to_le_bytes()),
|
||||
_ => buf.extend_from_slice(&val.to_le_bytes()),
|
||||
}
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Tests
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
use crate::data_layout::parse_vds_mappings;
|
||||
|
||||
/// A minimal, valid serialized H5S ALL selection (type=3, 16 bytes).
|
||||
///
|
||||
/// Layout: type(4 LE) + version(4 LE) + reserved(4) + length(4) = 16 bytes.
|
||||
/// `decode_serialized` consumes exactly 16 bytes for ALL/NONE.
|
||||
fn all_sel() -> Vec<u8> {
|
||||
let mut v = Vec::new();
|
||||
v.extend_from_slice(&3u32.to_le_bytes()); // type = H5S_SEL_ALL (3)
|
||||
v.extend_from_slice(&1u32.to_le_bytes()); // version = 1
|
||||
v.extend_from_slice(&[0u8; 4]); // reserved
|
||||
v.extend_from_slice(&[0u8; 4]); // length field (unused for ALL)
|
||||
v
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn roundtrip_same_file_two_mappings() {
|
||||
let sel = all_sel();
|
||||
let mappings = vec![
|
||||
VdsMapping {
|
||||
source_file: ".".into(),
|
||||
source_dataset: "/src_a".into(),
|
||||
source_selection: sel.clone(),
|
||||
virtual_selection: sel.clone(),
|
||||
},
|
||||
VdsMapping {
|
||||
source_file: ".".into(),
|
||||
source_dataset: "/src_b".into(),
|
||||
source_selection: sel.clone(),
|
||||
virtual_selection: sel.clone(),
|
||||
},
|
||||
];
|
||||
let bytes = serialize_vds_mappings(&mappings, 8);
|
||||
// Block version must be 1 (same-file).
|
||||
assert_eq!(bytes[0], 1u8);
|
||||
let parsed = parse_vds_mappings(&bytes, 8).unwrap();
|
||||
assert_eq!(parsed.len(), 2);
|
||||
assert_eq!(parsed[0].source_file, ".");
|
||||
assert_eq!(parsed[0].source_dataset, "/src_a");
|
||||
assert_eq!(parsed[1].source_file, ".");
|
||||
assert_eq!(parsed[1].source_dataset, "/src_b");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn roundtrip_external_file_mapping() {
|
||||
let sel = all_sel();
|
||||
let mappings = vec![VdsMapping {
|
||||
source_file: "source.h5".into(),
|
||||
source_dataset: "/data".into(),
|
||||
source_selection: sel.clone(),
|
||||
virtual_selection: sel.clone(),
|
||||
}];
|
||||
let bytes = serialize_vds_mappings(&mappings, 8);
|
||||
// Block version must be 0 (external file present).
|
||||
assert_eq!(bytes[0], 0u8);
|
||||
let parsed = parse_vds_mappings(&bytes, 8).unwrap();
|
||||
assert_eq!(parsed.len(), 1);
|
||||
assert_eq!(parsed[0].source_file, "source.h5");
|
||||
assert_eq!(parsed[0].source_dataset, "/data");
|
||||
assert_eq!(
|
||||
parsed[0].source_selection, sel,
|
||||
"source selection bytes must survive round-trip"
|
||||
);
|
||||
assert_eq!(
|
||||
parsed[0].virtual_selection, sel,
|
||||
"virtual selection bytes must survive round-trip"
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn empty_mappings_roundtrip() {
|
||||
// Empty slice: version 1 (vacuously all same-file), nused=0.
|
||||
let bytes = serialize_vds_mappings(&[], 8);
|
||||
let parsed = parse_vds_mappings(&bytes, 8).unwrap();
|
||||
assert!(parsed.is_empty());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn roundtrip_empty_source_file_treated_as_same_file() {
|
||||
// An empty source_file string is also treated as same-file (version 1).
|
||||
let sel = all_sel();
|
||||
let mappings = vec![VdsMapping {
|
||||
source_file: String::new(),
|
||||
source_dataset: "/ds".into(),
|
||||
source_selection: sel.clone(),
|
||||
virtual_selection: sel.clone(),
|
||||
}];
|
||||
let bytes = serialize_vds_mappings(&mappings, 8);
|
||||
assert_eq!(bytes[0], 1u8);
|
||||
let parsed = parse_vds_mappings(&bytes, 8).unwrap();
|
||||
assert_eq!(parsed.len(), 1);
|
||||
// parse_vds_mappings turns the 0x04 marker into "."
|
||||
assert_eq!(parsed[0].source_file, ".");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn roundtrip_length_size_4() {
|
||||
let sel = all_sel();
|
||||
let mappings = vec![VdsMapping {
|
||||
source_file: ".".into(),
|
||||
source_dataset: "/x".into(),
|
||||
source_selection: sel.clone(),
|
||||
virtual_selection: sel.clone(),
|
||||
}];
|
||||
let bytes = serialize_vds_mappings(&mappings, 4);
|
||||
let parsed = parse_vds_mappings(&bytes, 4).unwrap();
|
||||
assert_eq!(parsed.len(), 1);
|
||||
assert_eq!(parsed[0].source_dataset, "/x");
|
||||
}
|
||||
}
|
||||
@@ -17,6 +17,21 @@ use crate::datatype::{Datatype, DatatypeByteOrder};
|
||||
use crate::error::FormatError;
|
||||
use crate::filter_pipeline::FilterPipeline;
|
||||
|
||||
/// Checks that `[offset, offset + needed)` fits within `data`, guarding the
|
||||
/// addition against `usize` overflow from a crafted near-`usize::MAX` offset.
|
||||
fn ensure_len(data: &[u8], offset: usize, needed: usize) -> Result<(), FormatError> {
|
||||
if offset
|
||||
.checked_add(needed)
|
||||
.is_none_or(|end| end > data.len())
|
||||
{
|
||||
return Err(FormatError::UnexpectedEof {
|
||||
expected: offset.saturating_add(needed),
|
||||
available: data.len(),
|
||||
});
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
|
||||
/// Zero-copy read of contiguous raw data, returning a borrowed slice.
|
||||
///
|
||||
/// For contiguous layouts, returns a direct `&[u8]` slice into `file_data`.
|
||||
@@ -47,12 +62,7 @@ pub fn read_raw_data_zerocopy<'a>(
|
||||
actual: sz,
|
||||
});
|
||||
}
|
||||
if addr + sz > file_data.len() {
|
||||
return Err(FormatError::UnexpectedEof {
|
||||
expected: addr + sz,
|
||||
available: file_data.len(),
|
||||
});
|
||||
}
|
||||
ensure_len(file_data, addr, sz)?;
|
||||
Ok(Some(&file_data[addr..addr + sz]))
|
||||
}
|
||||
_ => Ok(None),
|
||||
@@ -94,7 +104,14 @@ pub fn read_raw_data_full(
|
||||
length_size: u8,
|
||||
) -> Result<Vec<u8>, FormatError> {
|
||||
read_raw_data_full_impl(
|
||||
file_data, layout, dataspace, datatype, pipeline, offset_size, length_size, None,
|
||||
file_data,
|
||||
layout,
|
||||
dataspace,
|
||||
datatype,
|
||||
pipeline,
|
||||
offset_size,
|
||||
length_size,
|
||||
None,
|
||||
)
|
||||
}
|
||||
|
||||
@@ -112,7 +129,14 @@ pub fn read_raw_data_full_with_resolver(
|
||||
resolver: Option<&VdsSourceResolver>,
|
||||
) -> Result<Vec<u8>, FormatError> {
|
||||
read_raw_data_full_impl(
|
||||
file_data, layout, dataspace, datatype, pipeline, offset_size, length_size, resolver,
|
||||
file_data,
|
||||
layout,
|
||||
dataspace,
|
||||
datatype,
|
||||
pipeline,
|
||||
offset_size,
|
||||
length_size,
|
||||
resolver,
|
||||
)
|
||||
}
|
||||
|
||||
@@ -155,12 +179,7 @@ fn read_raw_data_full_impl(
|
||||
actual: sz,
|
||||
});
|
||||
}
|
||||
if addr + sz > file_data.len() {
|
||||
return Err(FormatError::UnexpectedEof {
|
||||
expected: addr + sz,
|
||||
available: file_data.len(),
|
||||
});
|
||||
}
|
||||
ensure_len(file_data, addr, sz)?;
|
||||
Ok(file_data[addr..addr + sz].to_vec())
|
||||
}
|
||||
DataLayout::Chunked { .. } => read_chunked_data(
|
||||
@@ -456,8 +475,10 @@ fn read_virtual_data(
|
||||
use crate::selection::Selection;
|
||||
|
||||
let elem_size = datatype.type_size() as usize;
|
||||
let total_elems = dataspace.num_elements() as usize;
|
||||
let mut out = vec![0u8; total_elems.saturating_mul(elem_size)];
|
||||
let mut out = crate::chunked_read::alloc_output(crate::chunked_read::checked_byte_len(
|
||||
dataspace.checked_num_elements()?,
|
||||
elem_size,
|
||||
)?)?;
|
||||
|
||||
let virtual_dims = &dataspace.dimensions;
|
||||
|
||||
@@ -465,12 +486,12 @@ fn read_virtual_data(
|
||||
FormatError::ChunkedReadError("virtual dataset has no mapping global heap".into())
|
||||
})?;
|
||||
let coll = GlobalHeapCollection::parse(file_data, addr as usize, length_size)?;
|
||||
let obj = coll
|
||||
.get_object(global_heap_index as u16)
|
||||
.ok_or(FormatError::GlobalHeapObjectNotFound {
|
||||
collection_address: addr,
|
||||
index: global_heap_index as u16,
|
||||
})?;
|
||||
let obj =
|
||||
coll.get_object(global_heap_index as u16)
|
||||
.ok_or(FormatError::GlobalHeapObjectNotFound {
|
||||
collection_address: addr,
|
||||
index: global_heap_index as u16,
|
||||
})?;
|
||||
let mappings = parse_vds_mappings(&obj.data, length_size)?;
|
||||
|
||||
for m in &mappings {
|
||||
@@ -579,7 +600,7 @@ fn read_named_dataset_raw(
|
||||
}
|
||||
|
||||
/// Extract selected elements from a full dataset buffer.
|
||||
fn extract_selection_from_buffer(
|
||||
pub fn extract_selection_from_buffer(
|
||||
full_data: &[u8],
|
||||
dims: &[u64],
|
||||
elem_size: usize,
|
||||
@@ -597,12 +618,14 @@ fn extract_selection_from_buffer(
|
||||
block,
|
||||
} => {
|
||||
let rank = dims.len();
|
||||
let output_elements: usize = count
|
||||
let output_elements = count
|
||||
.iter()
|
||||
.zip(block.iter())
|
||||
.map(|(&c, &b)| (c * b) as usize)
|
||||
.product();
|
||||
let mut output = vec![0u8; output_elements * elem_size];
|
||||
.try_fold(1u64, |acc, (&c, &b)| acc.checked_mul(c.checked_mul(b)?))
|
||||
.ok_or_else(|| FormatError::Overflow("hyperslab count x block overflows".into()))?;
|
||||
let mut output = crate::chunked_read::alloc_output(
|
||||
crate::chunked_read::checked_byte_len(output_elements, elem_size)?,
|
||||
)?;
|
||||
|
||||
// Compute dataset strides (row-major)
|
||||
let mut ds_strides = vec![1usize; rank];
|
||||
@@ -1204,6 +1227,15 @@ pub fn read_compound_fields(
|
||||
for m in members {
|
||||
let field_size = m.datatype.type_size() as usize;
|
||||
let offset = m.byte_offset as usize;
|
||||
if offset
|
||||
.checked_add(field_size)
|
||||
.is_none_or(|end| end > elem_size)
|
||||
{
|
||||
return Err(FormatError::Overflow(format!(
|
||||
"compound member '{}': byte_offset({offset}) + field_size({field_size}) exceeds element size({elem_size})",
|
||||
m.name
|
||||
)));
|
||||
}
|
||||
let mut field_raw = Vec::with_capacity(count * field_size);
|
||||
for i in 0..count {
|
||||
let elem_start = i * elem_size + offset;
|
||||
@@ -1735,11 +1767,11 @@ mod tests {
|
||||
fn f16_bits(v: f32) -> u16 {
|
||||
// Encode a few exact values used by the test.
|
||||
match v {
|
||||
x if x == 0.0 => 0x0000,
|
||||
x if x == 1.0 => 0x3c00,
|
||||
x if x == -2.0 => 0xc000,
|
||||
x if x == 0.5 => 0x3800,
|
||||
x if x == 65504.0 => 0x7bff, // f16 max
|
||||
0.0 => 0x0000,
|
||||
1.0 => 0x3c00,
|
||||
-2.0 => 0xc000,
|
||||
0.5 => 0x3800,
|
||||
65504.0 => 0x7bff, // f16 max
|
||||
_ => panic!("unsupported test value {v}"),
|
||||
}
|
||||
}
|
||||
@@ -1815,13 +1847,19 @@ mod tests {
|
||||
0xff, 0xff, 0x00, 0x00, 0x64, 0x00, 0x00, 0x00, 0xe8, 0x03, 0x00, 0x00, 0x00, 0x80,
|
||||
0x00, 0x00,
|
||||
];
|
||||
assert_eq!(read_as_i32(&raw, &arr).unwrap(), vec![-1, 100, 1000, -32768]);
|
||||
assert_eq!(
|
||||
read_as_i32(&raw, &arr).unwrap(),
|
||||
vec![-1, 100, 1000, -32768]
|
||||
);
|
||||
// Nested array-of-array unwraps recursively.
|
||||
let nested = Datatype::Array {
|
||||
base_type: Box::new(arr),
|
||||
dimensions: vec![2],
|
||||
};
|
||||
assert_eq!(read_as_i32(&raw, &nested).unwrap(), vec![-1, 100, 1000, -32768]);
|
||||
assert_eq!(
|
||||
read_as_i32(&raw, &nested).unwrap(),
|
||||
vec![-1, 100, 1000, -32768]
|
||||
);
|
||||
}
|
||||
|
||||
fn make_f64_le_type() -> Datatype {
|
||||
@@ -2096,6 +2134,43 @@ mod tests {
|
||||
assert_eq!(id_vals, vec![10, 20]);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn read_compound_rejects_byte_offset_overrun() {
|
||||
use crate::datatype::CompoundMember;
|
||||
// Compound declares size=8, but the member's byte_offset(4) + its
|
||||
// field_size(8, f64) = 12 > 8 — a crafted out-of-range byte_offset.
|
||||
let dt = Datatype::Compound {
|
||||
size: 8,
|
||||
members: vec![CompoundMember {
|
||||
name: "bad".to_string(),
|
||||
byte_offset: 4,
|
||||
datatype: make_f64_le_type(),
|
||||
}],
|
||||
};
|
||||
let raw = vec![0u8; 8]; // one element, matches declared size
|
||||
let result = read_compound_fields(&raw, &dt);
|
||||
assert!(
|
||||
matches!(result, Err(FormatError::Overflow(_))),
|
||||
"expected a clean Overflow error, got {result:?}"
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn read_raw_data_zerocopy_rejects_near_usize_max_offset() {
|
||||
let file_data = vec![0u8; 64];
|
||||
let dataspace = make_simple_dataspace(&[4]);
|
||||
let datatype = make_i32_le_type();
|
||||
let layout = DataLayout::Contiguous {
|
||||
address: Some(u64::MAX - 4),
|
||||
size: 16,
|
||||
};
|
||||
let result = read_raw_data_zerocopy(&file_data, &layout, &dataspace, &datatype);
|
||||
assert!(
|
||||
matches!(result, Err(FormatError::UnexpectedEof { .. })),
|
||||
"expected a clean UnexpectedEof, got {result:?}"
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn read_compound_single_field_by_name() {
|
||||
use crate::datatype::CompoundMember;
|
||||
@@ -2115,7 +2190,7 @@ mod tests {
|
||||
],
|
||||
};
|
||||
let mut raw = Vec::new();
|
||||
raw.extend_from_slice(&3.14f64.to_le_bytes());
|
||||
raw.extend_from_slice(&3.25f64.to_le_bytes());
|
||||
raw.extend_from_slice(&42i32.to_le_bytes());
|
||||
|
||||
let field = read_compound_field(&raw, &dt, "id").unwrap();
|
||||
|
||||
@@ -1,5 +1,7 @@
|
||||
//! HDF5 Dataspace message parsing (message type 0x0001).
|
||||
|
||||
#[cfg(not(feature = "std"))]
|
||||
use alloc::format;
|
||||
#[cfg(not(feature = "std"))]
|
||||
use alloc::vec::Vec;
|
||||
|
||||
@@ -167,6 +169,27 @@ impl Dataspace {
|
||||
}
|
||||
}
|
||||
|
||||
/// [`Dataspace::num_elements`] with the product overflow-checked. The
|
||||
/// dimensions are untrusted 64-bit fields; read paths that size a buffer
|
||||
/// from them must use this one.
|
||||
pub fn checked_num_elements(&self) -> Result<u64, FormatError> {
|
||||
match self.space_type {
|
||||
DataspaceType::Null => Ok(0),
|
||||
DataspaceType::Scalar => Ok(1),
|
||||
DataspaceType::Simple if self.dimensions.is_empty() => Ok(0),
|
||||
DataspaceType::Simple => self
|
||||
.dimensions
|
||||
.iter()
|
||||
.try_fold(1u64, |acc, &d| acc.checked_mul(d))
|
||||
.ok_or_else(|| {
|
||||
FormatError::Overflow(format!(
|
||||
"dataspace dimensions {:?} overflow the element count",
|
||||
self.dimensions
|
||||
))
|
||||
}),
|
||||
}
|
||||
}
|
||||
|
||||
/// Total number of elements. Scalar = 1, Null = 0.
|
||||
pub fn num_elements(&self) -> u64 {
|
||||
match self.space_type {
|
||||
@@ -176,7 +199,12 @@ impl Dataspace {
|
||||
if self.dimensions.is_empty() {
|
||||
0
|
||||
} else {
|
||||
self.dimensions.iter().product()
|
||||
// Saturate rather than wrap: a wrapped product could
|
||||
// under-size a buffer. Size-critical callers use
|
||||
// `checked_num_elements`.
|
||||
self.dimensions
|
||||
.iter()
|
||||
.fold(1u64, |acc, &d| acc.saturating_mul(d))
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -189,11 +217,7 @@ mod tests {
|
||||
|
||||
fn build_v1_dataspace(rank: u8, flags: u8, dims: &[u64], max_dims: Option<&[u64]>) -> Vec<u8> {
|
||||
let length_size = 8u8;
|
||||
let mut buf = Vec::new();
|
||||
buf.push(1); // version
|
||||
buf.push(rank);
|
||||
buf.push(flags);
|
||||
buf.push(0); // reserved
|
||||
let mut buf = vec![1, rank, flags, 0]; // version, rank, flags, reserved
|
||||
buf.extend_from_slice(&[0u8; 4]); // reserved(4)
|
||||
for &d in dims {
|
||||
buf.extend_from_slice(&d.to_le_bytes());
|
||||
@@ -214,11 +238,7 @@ mod tests {
|
||||
dims: &[u64],
|
||||
max_dims: Option<&[u64]>,
|
||||
) -> Vec<u8> {
|
||||
let mut buf = Vec::new();
|
||||
buf.push(2); // version
|
||||
buf.push(rank);
|
||||
buf.push(flags);
|
||||
buf.push(type_byte);
|
||||
let mut buf = vec![2, rank, flags, type_byte]; // version, rank, flags, type
|
||||
for &d in dims {
|
||||
buf.extend_from_slice(&d.to_le_bytes());
|
||||
}
|
||||
@@ -298,11 +318,7 @@ mod tests {
|
||||
|
||||
#[test]
|
||||
fn v1_with_4byte_length() {
|
||||
let mut buf = Vec::new();
|
||||
buf.push(1); // version
|
||||
buf.push(1); // rank
|
||||
buf.push(0); // flags
|
||||
buf.push(0); // reserved
|
||||
let mut buf = vec![1, 1, 0, 0]; // version, rank, flags, reserved
|
||||
buf.extend_from_slice(&[0u8; 4]); // reserved(4)
|
||||
buf.extend_from_slice(&10u32.to_le_bytes()); // dim with length_size=4
|
||||
let ds = Dataspace::parse(&buf, 4).unwrap();
|
||||
|
||||
@@ -204,11 +204,25 @@ fn read_uint(data: &[u8], offset: usize, nbytes: usize) -> Result<u64, FormatErr
|
||||
})
|
||||
}
|
||||
|
||||
/// Maximum recursion depth for nested datatypes (Compound/Enumeration/
|
||||
/// VariableLength/Array). A crafted file can nest a message-size-capped
|
||||
/// (65535 byte) datatype message ~8000 levels deep, which would blow the
|
||||
/// stack — especially on the project's no_std/embedded targets where
|
||||
/// available stack is a few KB.
|
||||
const MAX_DATATYPE_DEPTH: u16 = 64;
|
||||
|
||||
impl Datatype {
|
||||
/// Parse a datatype message from raw bytes.
|
||||
///
|
||||
/// Returns `(Datatype, bytes_consumed)` for recursive parsing.
|
||||
pub fn parse(data: &[u8]) -> Result<(Datatype, usize), FormatError> {
|
||||
Self::parse_with_depth(data, 0)
|
||||
}
|
||||
|
||||
fn parse_with_depth(data: &[u8], depth: u16) -> Result<(Datatype, usize), FormatError> {
|
||||
if depth >= MAX_DATATYPE_DEPTH {
|
||||
return Err(FormatError::NestingDepthExceeded);
|
||||
}
|
||||
// Minimum header: 4 bytes (class_and_version + 3 bytes bit field) + 4 bytes size = 8
|
||||
ensure_len(data, 0, 8)?;
|
||||
|
||||
@@ -358,7 +372,8 @@ impl Datatype {
|
||||
pos += name_len;
|
||||
let byte_offset = read_uint(data, pos, ob)?;
|
||||
pos += ob;
|
||||
let (member_dt, consumed) = Datatype::parse(&data[pos..])?;
|
||||
let (member_dt, consumed) =
|
||||
Self::parse_with_depth(&data[pos..], depth + 1)?;
|
||||
pos += consumed;
|
||||
members.push(CompoundMember {
|
||||
name,
|
||||
@@ -367,24 +382,29 @@ impl Datatype {
|
||||
});
|
||||
}
|
||||
} else if version == 1 || version == 2 {
|
||||
// v1/v2: name, offset(4), dimensionality(1), reserved(3), dim_perm(4),
|
||||
// reserved_dims(up to 4*4=16), member datatype
|
||||
// v1/v2: name (null-terminated, padded to a multiple of 8
|
||||
// bytes), offset(4), member datatype. v1 additionally
|
||||
// carries the legacy per-member array fields between the
|
||||
// offset and the member datatype: dimensionality(1),
|
||||
// reserved(3), dim_perm(4), reserved(4), 4 dim sizes(16).
|
||||
// v1 is what default (non-`latest`) libver bounds emit.
|
||||
for _ in 0..num_members {
|
||||
let (name, name_len) = read_null_terminated_string(data, pos)?;
|
||||
pos += name_len;
|
||||
// v1: names padded to 8-byte boundary
|
||||
if version == 1 {
|
||||
let total_name_bytes = name_len;
|
||||
let padded = (total_name_bytes + 7) & !7;
|
||||
pos = pos - name_len + padded;
|
||||
}
|
||||
let padded = name_len.checked_add(7).ok_or(FormatError::UnexpectedEof {
|
||||
expected: usize::MAX,
|
||||
available: data.len(),
|
||||
})? & !7;
|
||||
ensure_len(data, pos, padded)?;
|
||||
pos += padded;
|
||||
ensure_len(data, pos, 4)?;
|
||||
let byte_offset = LittleEndian::read_u32(&data[pos..pos + 4]) as u64;
|
||||
pos += 4;
|
||||
// dimensionality(1) + reserved(3) + dim_perm(4) + 4 dim slots(16) = 24
|
||||
ensure_len(data, pos, 24)?;
|
||||
pos += 24;
|
||||
let (member_dt, consumed) = Datatype::parse(&data[pos..])?;
|
||||
if version == 1 {
|
||||
ensure_len(data, pos, 28)?;
|
||||
pos += 28;
|
||||
}
|
||||
let (member_dt, consumed) =
|
||||
Self::parse_with_depth(&data[pos..], depth + 1)?;
|
||||
pos += consumed;
|
||||
members.push(CompoundMember {
|
||||
name,
|
||||
@@ -415,7 +435,7 @@ impl Datatype {
|
||||
// Enumeration
|
||||
let num_members = (bf0 as u16) | ((bf1 as u16) << 8);
|
||||
// Parse base type
|
||||
let (base_type, base_consumed) = Datatype::parse(&data[pos..])?;
|
||||
let (base_type, base_consumed) = Self::parse_with_depth(&data[pos..], depth + 1)?;
|
||||
pos += base_consumed;
|
||||
let base_size = base_type.type_size();
|
||||
let mut members = Vec::with_capacity(num_members as usize);
|
||||
@@ -468,7 +488,7 @@ impl Datatype {
|
||||
} else {
|
||||
None
|
||||
};
|
||||
let (base_type, consumed) = Datatype::parse(&data[pos..])?;
|
||||
let (base_type, consumed) = Self::parse_with_depth(&data[pos..], depth + 1)?;
|
||||
pos += consumed;
|
||||
Ok((
|
||||
Datatype::VariableLength {
|
||||
@@ -494,7 +514,7 @@ impl Datatype {
|
||||
}
|
||||
// skip permutation indices
|
||||
pos += ndims * 4;
|
||||
let (base_type, consumed) = Datatype::parse(&data[pos..])?;
|
||||
let (base_type, consumed) = Self::parse_with_depth(&data[pos..], depth + 1)?;
|
||||
pos += consumed;
|
||||
Ok((
|
||||
Datatype::Array {
|
||||
@@ -515,7 +535,7 @@ impl Datatype {
|
||||
dimensions.push(LittleEndian::read_u32(&data[pos..pos + 4]));
|
||||
pos += 4;
|
||||
}
|
||||
let (base_type, consumed) = Datatype::parse(&data[pos..])?;
|
||||
let (base_type, consumed) = Self::parse_with_depth(&data[pos..], depth + 1)?;
|
||||
pos += consumed;
|
||||
Ok((
|
||||
Datatype::Array {
|
||||
@@ -532,27 +552,39 @@ impl Datatype {
|
||||
}
|
||||
}
|
||||
11 => {
|
||||
// Complex number — store as compound of two floats internally
|
||||
// Parse like compound with version 3 and 2 members
|
||||
// But actually class 11 has no special properties beyond class 6 compound.
|
||||
// It's just recognized as a separate class. For now parse the 2 members
|
||||
// as compound.
|
||||
let num_members = (bf0 as u16) | ((bf1 as u16) << 8);
|
||||
let mut members = Vec::with_capacity(num_members as usize);
|
||||
let ob = offset_bytes_for_size(size);
|
||||
for _ in 0..num_members {
|
||||
let (name, name_len) = read_null_terminated_string(data, pos)?;
|
||||
pos += name_len;
|
||||
let byte_offset = read_uint(data, pos, ob)?;
|
||||
pos += ob;
|
||||
let (member_dt, consumed) = Datatype::parse(&data[pos..])?;
|
||||
pos += consumed;
|
||||
members.push(CompoundMember {
|
||||
name,
|
||||
byte_offset,
|
||||
datatype: member_dt,
|
||||
// Complex number (HDF5 2.0, datatype version 5). The properties
|
||||
// are a single base floating-point datatype message; an element
|
||||
// is two consecutive base-type values (real, imaginary). There
|
||||
// is no member list. Surface it as the equivalent two-member
|
||||
// compound `{r, i}` — the same shape h5py writes for numpy
|
||||
// complex dtypes — so downstream compound readers work as-is.
|
||||
if version != 5 {
|
||||
return Err(FormatError::InvalidDatatypeVersion {
|
||||
class: class_id,
|
||||
version,
|
||||
});
|
||||
}
|
||||
let (base_type, consumed) = Self::parse_with_depth(&data[pos..], depth + 1)?;
|
||||
pos += consumed;
|
||||
let base_size = base_type.type_size();
|
||||
if base_size.checked_mul(2) != Some(size) {
|
||||
return Err(FormatError::DataSizeMismatch {
|
||||
expected: (base_size as usize).saturating_mul(2),
|
||||
actual: size as usize,
|
||||
});
|
||||
}
|
||||
let members = vec![
|
||||
CompoundMember {
|
||||
name: String::from("r"),
|
||||
byte_offset: 0,
|
||||
datatype: base_type.clone(),
|
||||
},
|
||||
CompoundMember {
|
||||
name: String::from("i"),
|
||||
byte_offset: base_size as u64,
|
||||
datatype: base_type,
|
||||
},
|
||||
];
|
||||
Ok((Datatype::Compound { size, members }, pos))
|
||||
}
|
||||
_ => Err(FormatError::InvalidDatatypeClass(class_id)),
|
||||
@@ -814,6 +846,39 @@ mod tests {
|
||||
buf
|
||||
}
|
||||
|
||||
/// A crafted datatype message nesting Variable-Length wrappers deeper
|
||||
/// than `MAX_DATATYPE_DEPTH` must return `NestingDepthExceeded`
|
||||
/// instead of overflowing the stack.
|
||||
#[test]
|
||||
fn nested_variable_length_exceeds_depth_limit() {
|
||||
// Each VL level is just an 8-byte header (class 9, vl_type=0 =>
|
||||
// sequence, no padding/charset fields) immediately followed by the
|
||||
// next level's bytes, terminated by a fixed-point base type.
|
||||
let levels = MAX_DATATYPE_DEPTH as usize + 10;
|
||||
let mut data = Vec::new();
|
||||
for _ in 0..levels {
|
||||
data.extend_from_slice(&build_dt_header(9, 3, [0, 0, 0], 0));
|
||||
}
|
||||
data.extend_from_slice(&build_fixed_point(4, false, false, 0, 32));
|
||||
|
||||
let result = Datatype::parse(&data);
|
||||
assert!(matches!(result, Err(FormatError::NestingDepthExceeded)));
|
||||
}
|
||||
|
||||
/// A datatype nested just within the depth limit must still parse fine.
|
||||
#[test]
|
||||
fn nested_variable_length_within_depth_limit_ok() {
|
||||
let levels = MAX_DATATYPE_DEPTH as usize - 1;
|
||||
let mut data = Vec::new();
|
||||
for _ in 0..levels {
|
||||
data.extend_from_slice(&build_dt_header(9, 3, [0, 0, 0], 0));
|
||||
}
|
||||
data.extend_from_slice(&build_fixed_point(4, false, false, 0, 32));
|
||||
|
||||
let result = Datatype::parse(&data);
|
||||
assert!(result.is_ok());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_fixed_point_u8() {
|
||||
let data = build_fixed_point(1, false, false, 0, 8);
|
||||
@@ -1030,14 +1095,8 @@ mod tests {
|
||||
Datatype::Compound { size, members } => {
|
||||
assert_eq!(size, 20);
|
||||
assert_eq!(members.len(), 3);
|
||||
assert_eq!(
|
||||
(members[0].name.as_str(), members[0].byte_offset),
|
||||
("x", 0)
|
||||
);
|
||||
assert_eq!(
|
||||
(members[1].name.as_str(), members[1].byte_offset),
|
||||
("y", 8)
|
||||
);
|
||||
assert_eq!((members[0].name.as_str(), members[0].byte_offset), ("x", 0));
|
||||
assert_eq!((members[1].name.as_str(), members[1].byte_offset), ("y", 8));
|
||||
assert_eq!(
|
||||
(members[2].name.as_str(), members[2].byte_offset),
|
||||
("id", 16)
|
||||
@@ -1076,12 +1135,165 @@ mod tests {
|
||||
dimensions,
|
||||
} => {
|
||||
assert_eq!(dimensions, vec![3]);
|
||||
assert!(matches!(*base_type, Datatype::FloatingPoint { size: 8, .. }));
|
||||
assert!(matches!(
|
||||
*base_type,
|
||||
Datatype::FloatingPoint { size: 8, .. }
|
||||
));
|
||||
}
|
||||
other => panic!("expected Array, got {other:?}"),
|
||||
}
|
||||
}
|
||||
|
||||
/// Real datatype message bytes emitted by h5py 3.16 / HDF5 2.0 with
|
||||
/// *default* libver bounds for [('x','f8'),('y','f8'),('id','i4')]:
|
||||
/// compound datatype version 1 (padded names + 28 bytes of legacy
|
||||
/// per-member array fields).
|
||||
fn compound_v1_bytes() -> Vec<u8> {
|
||||
let f64le: [u8; 20] = [
|
||||
0x11, 0x20, 0x3f, 0x00, 0x08, 0x00, 0x00, 0x00, 0x00, 0x00, 0x40, 0x00, 0x34, 0x0b,
|
||||
0x00, 0x34, 0xff, 0x03, 0x00, 0x00,
|
||||
];
|
||||
let i32le: [u8; 12] = [
|
||||
0x10, 0x08, 0x00, 0x00, 0x04, 0x00, 0x00, 0x00, 0x00, 0x00, 0x20, 0x00,
|
||||
];
|
||||
let mut b = vec![0x16, 0x03, 0x00, 0x00, 0x14, 0x00, 0x00, 0x00];
|
||||
for (name, offset, dt) in [
|
||||
(&b"x"[..], 0u32, &f64le[..]),
|
||||
(&b"y"[..], 8, &f64le[..]),
|
||||
(&b"id"[..], 16, &i32le[..]),
|
||||
] {
|
||||
let mut padded = name.to_vec();
|
||||
padded.resize((name.len() + 1 + 7) & !7, 0);
|
||||
b.extend_from_slice(&padded);
|
||||
b.extend_from_slice(&offset.to_le_bytes());
|
||||
b.extend_from_slice(&[0u8; 28]);
|
||||
b.extend_from_slice(dt);
|
||||
}
|
||||
b
|
||||
}
|
||||
|
||||
fn assert_xyid_compound(dt: Datatype) {
|
||||
match dt {
|
||||
Datatype::Compound { size, members } => {
|
||||
assert_eq!(size, 20);
|
||||
let got: Vec<(&str, u64, u32)> = members
|
||||
.iter()
|
||||
.map(|m| (m.name.as_str(), m.byte_offset, m.datatype.type_size()))
|
||||
.collect();
|
||||
assert_eq!(got, vec![("x", 0, 8), ("y", 8, 8), ("id", 16, 4)]);
|
||||
}
|
||||
other => panic!("expected Compound, got {other:?}"),
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_compound_v1_default_libver() {
|
||||
let bytes = compound_v1_bytes();
|
||||
let (dt, consumed) = Datatype::parse(&bytes).unwrap();
|
||||
assert_eq!(consumed, bytes.len());
|
||||
assert_xyid_compound(dt);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_compound_v2_padded_names_no_array_fields() {
|
||||
// v2 = v1 without the 28 bytes of per-member array fields; names are
|
||||
// still padded to a multiple of 8 (matches libhdf5's H5O decoder).
|
||||
let v1 = compound_v1_bytes();
|
||||
let mut v2 = vec![0x26, 0x03, 0x00, 0x00, 0x14, 0x00, 0x00, 0x00];
|
||||
let mut pos = 8;
|
||||
for dt_len in [20usize, 20, 12] {
|
||||
v2.extend_from_slice(&v1[pos..pos + 8 + 4]); // padded name + offset
|
||||
pos += 8 + 4 + 28;
|
||||
v2.extend_from_slice(&v1[pos..pos + dt_len]);
|
||||
pos += dt_len;
|
||||
}
|
||||
let (dt, consumed) = Datatype::parse(&v2).unwrap();
|
||||
assert_eq!(consumed, v2.len());
|
||||
assert_xyid_compound(dt);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_compound_v1_truncated_is_error_not_panic() {
|
||||
let bytes = compound_v1_bytes();
|
||||
for cut in 8..bytes.len() {
|
||||
assert!(Datatype::parse(&bytes[..cut]).is_err(), "cut at {cut}");
|
||||
}
|
||||
}
|
||||
|
||||
/// Real datatype message bytes emitted by HDF5 2.0 for the native complex
|
||||
/// type `H5T_COMPLEX_IEEE_F64LE`: class 11, version 5, size 16, followed by
|
||||
/// the base IEEE f64 datatype message.
|
||||
const COMPLEX_F64_HDF5_2_0: [u8; 28] = [
|
||||
0x5b, 0x01, 0x00, 0x00, 0x10, 0x00, 0x00, 0x00, 0x11, 0x20, 0x3f, 0x00, 0x08, 0x00, 0x00,
|
||||
0x00, 0x00, 0x00, 0x40, 0x00, 0x34, 0x0b, 0x00, 0x34, 0xff, 0x03, 0x00, 0x00,
|
||||
];
|
||||
|
||||
#[test]
|
||||
fn test_complex_v5_from_hdf5_2_0() {
|
||||
let (dt, consumed) = Datatype::parse(&COMPLEX_F64_HDF5_2_0).unwrap();
|
||||
assert_eq!(consumed, COMPLEX_F64_HDF5_2_0.len());
|
||||
match dt {
|
||||
Datatype::Compound { size, members } => {
|
||||
assert_eq!(size, 16);
|
||||
assert_eq!(members.len(), 2);
|
||||
assert_eq!((members[0].name.as_str(), members[0].byte_offset), ("r", 0));
|
||||
assert_eq!((members[1].name.as_str(), members[1].byte_offset), ("i", 8));
|
||||
for m in &members {
|
||||
assert!(matches!(
|
||||
m.datatype,
|
||||
Datatype::FloatingPoint { size: 8, .. }
|
||||
));
|
||||
}
|
||||
}
|
||||
other => panic!("expected Compound, got {other:?}"),
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_compound_with_complex_member_from_hdf5_2_0() {
|
||||
// Compound { z: complex f64 @0, k: i64 @16 } as written by HDF5 2.0.
|
||||
// Regression guard: the complex member must consume exactly its own
|
||||
// bytes so the following member parses.
|
||||
let mut bytes = vec![
|
||||
0x56, 0x02, 0x00, 0x00, 0x18, 0x00, 0x00, 0x00, b'z', 0x00, 0x00,
|
||||
];
|
||||
bytes.extend_from_slice(&COMPLEX_F64_HDF5_2_0);
|
||||
bytes.extend_from_slice(&[b'k', 0x00, 0x10]);
|
||||
bytes.extend_from_slice(&[
|
||||
0x10, 0x08, 0x00, 0x00, 0x08, 0x00, 0x00, 0x00, 0x00, 0x00, 0x40, 0x00,
|
||||
]);
|
||||
let (dt, consumed) = Datatype::parse(&bytes).unwrap();
|
||||
assert_eq!(consumed, bytes.len());
|
||||
match dt {
|
||||
Datatype::Compound { size, members } => {
|
||||
assert_eq!(size, 24);
|
||||
assert_eq!(members.len(), 2);
|
||||
assert!(matches!(
|
||||
&members[0].datatype,
|
||||
Datatype::Compound { size: 16, members } if members.len() == 2
|
||||
));
|
||||
assert_eq!(
|
||||
(members[1].name.as_str(), members[1].byte_offset),
|
||||
("k", 16)
|
||||
);
|
||||
}
|
||||
other => panic!("expected Compound, got {other:?}"),
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_complex_size_mismatch_rejected() {
|
||||
let mut bytes = COMPLEX_F64_HDF5_2_0;
|
||||
bytes[4] = 0x0c; // claims 12 bytes, base type is 8
|
||||
assert!(matches!(
|
||||
Datatype::parse(&bytes),
|
||||
Err(FormatError::DataSizeMismatch {
|
||||
expected: 16,
|
||||
actual: 12
|
||||
})
|
||||
));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_reference_object() {
|
||||
let buf = build_dt_header(7, 1, [0, 0, 0], 8);
|
||||
|
||||
@@ -20,7 +20,7 @@
|
||||
//! ```
|
||||
|
||||
#[cfg(not(feature = "std"))]
|
||||
use alloc::{string::String, vec, vec::Vec};
|
||||
use alloc::{format, string::String, vec, vec::Vec};
|
||||
|
||||
#[cfg(not(feature = "std"))]
|
||||
use alloc::collections::BTreeMap;
|
||||
|
||||
@@ -114,6 +114,20 @@ pub enum FormatError {
|
||||
InvalidAttributeInfoVersion(u8),
|
||||
/// Invalid shared message version.
|
||||
InvalidSharedMessageVersion(u8),
|
||||
/// A message is marked shared but was parsed without access to the file,
|
||||
/// so the reference to the real message could not be followed.
|
||||
UnresolvedSharedMessage,
|
||||
/// The dataset's raw data is stored in external files (External Data
|
||||
/// Files message), which this reader does not follow.
|
||||
ExternalDataFilesUnsupported,
|
||||
/// The path goes through an external link (a link into another file),
|
||||
/// which this reader does not follow.
|
||||
ExternalLinkUnsupported {
|
||||
/// The file the link points into.
|
||||
filename: String,
|
||||
/// The object path within that file.
|
||||
object_path: String,
|
||||
},
|
||||
/// Invalid SOHM table version.
|
||||
InvalidSohmTableVersion(u8),
|
||||
/// Invalid SOHM table signature (expected "SMTB").
|
||||
@@ -307,6 +321,22 @@ impl fmt::Display for FormatError {
|
||||
FormatError::InvalidSharedMessageVersion(v) => {
|
||||
write!(f, "invalid shared message version: {v}")
|
||||
}
|
||||
FormatError::ExternalLinkUnsupported {
|
||||
filename,
|
||||
object_path,
|
||||
} => write!(
|
||||
f,
|
||||
"path goes through an external link to {object_path} in {filename}, which is \
|
||||
not supported"
|
||||
),
|
||||
FormatError::ExternalDataFilesUnsupported => write!(
|
||||
f,
|
||||
"dataset raw data is stored in external file(s), which is not supported"
|
||||
),
|
||||
FormatError::UnresolvedSharedMessage => write!(
|
||||
f,
|
||||
"message is shared but no file data was available to resolve it"
|
||||
),
|
||||
FormatError::InvalidSohmTableVersion(v) => {
|
||||
write!(f, "invalid SOHM table version: {v}")
|
||||
}
|
||||
|
||||
@@ -54,6 +54,19 @@ fn read_offset(data: &[u8], pos: usize, size: u8) -> Result<u64, FormatError> {
|
||||
})
|
||||
}
|
||||
|
||||
fn ensure_len(data: &[u8], offset: usize, needed: usize) -> Result<(), FormatError> {
|
||||
if offset
|
||||
.checked_add(needed)
|
||||
.is_none_or(|end| end > data.len())
|
||||
{
|
||||
return Err(FormatError::UnexpectedEof {
|
||||
expected: offset.saturating_add(needed),
|
||||
available: data.len(),
|
||||
});
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
|
||||
fn is_undefined_addr(addr: u64, offset_size: u8) -> bool {
|
||||
match offset_size {
|
||||
2 => addr == 0xFFFF,
|
||||
@@ -98,12 +111,7 @@ impl ExtensibleArrayHeader {
|
||||
// 6 stats fields (each length_size) + index_block_address(offset_size) + checksum(4)
|
||||
let min_size =
|
||||
4 + 1 + 1 + 1 + 1 + 1 + 1 + 1 + 1 + 6 * length_size as usize + offset_size as usize + 4;
|
||||
if offset + min_size > file_data.len() {
|
||||
return Err(FormatError::UnexpectedEof {
|
||||
expected: offset + min_size,
|
||||
available: file_data.len(),
|
||||
});
|
||||
}
|
||||
ensure_len(file_data, offset, min_size)?;
|
||||
|
||||
let d = &file_data[offset..];
|
||||
if &d[0..4] != b"EAHD" {
|
||||
@@ -275,12 +283,7 @@ fn read_data_block_elements(
|
||||
) -> Result<Vec<ChunkInfo>, FormatError> {
|
||||
// AEDB: signature(4) + version(1) + client_id(1) + header_address(offset_size)
|
||||
let db_header_size = 4 + 1 + 1 + offset_size as usize;
|
||||
if db_offset + db_header_size > file_data.len() {
|
||||
return Err(FormatError::UnexpectedEof {
|
||||
expected: db_offset + db_header_size,
|
||||
available: file_data.len(),
|
||||
});
|
||||
}
|
||||
ensure_len(file_data, db_offset, db_header_size)?;
|
||||
|
||||
let d = &file_data[db_offset..];
|
||||
if &d[0..4] != b"EADB" {
|
||||
@@ -427,12 +430,7 @@ pub fn read_extensible_array_chunks(
|
||||
// Parse index block (AEIB)
|
||||
let ib_offset = header.index_block_address as usize;
|
||||
let ib_header_size = 4 + 1 + 1 + offset_size as usize; // sig + ver + client + hdr_addr
|
||||
if ib_offset + ib_header_size > file_data.len() {
|
||||
return Err(FormatError::UnexpectedEof {
|
||||
expected: ib_offset + ib_header_size,
|
||||
available: file_data.len(),
|
||||
});
|
||||
}
|
||||
ensure_len(file_data, ib_offset, ib_header_size)?;
|
||||
|
||||
let ib = &file_data[ib_offset..];
|
||||
if &ib[0..4] != b"EAIB" {
|
||||
@@ -628,12 +626,7 @@ fn read_super_block(
|
||||
|
||||
// AESB: signature(4) + version(1) + client_id(1) + header_address(offset_size)
|
||||
let sb_header_size = 4 + 1 + 1 + os;
|
||||
if sb_offset + sb_header_size > file_data.len() {
|
||||
return Err(FormatError::UnexpectedEof {
|
||||
expected: sb_offset + sb_header_size,
|
||||
available: file_data.len(),
|
||||
});
|
||||
}
|
||||
ensure_len(file_data, sb_offset, sb_header_size)?;
|
||||
|
||||
if &file_data[sb_offset..sb_offset + 4] != b"EASB" {
|
||||
return Err(FormatError::ChunkedReadError(
|
||||
@@ -759,6 +752,33 @@ mod tests {
|
||||
assert!(result.is_err());
|
||||
}
|
||||
|
||||
/// A near-`usize::MAX` offset must error cleanly, not overflow/panic.
|
||||
#[test]
|
||||
fn parse_rejects_offset_overflow() {
|
||||
let buf = vec![0u8; 64];
|
||||
let result = ExtensibleArrayHeader::parse(&buf, usize::MAX - 4, 8, 8);
|
||||
assert!(result.is_err());
|
||||
}
|
||||
|
||||
/// A near-`usize::MAX` index block address must error cleanly, not overflow/panic.
|
||||
#[test]
|
||||
fn read_rejects_index_block_offset_overflow() {
|
||||
let header = ExtensibleArrayHeader {
|
||||
client_id: 0,
|
||||
element_size: 8,
|
||||
max_nelmts_bits: 10,
|
||||
idx_blk_elmts: 2,
|
||||
min_dblk_nelmts: 4,
|
||||
super_blk_min_nelmts: 2,
|
||||
max_dblk_nelmts_bits: 8,
|
||||
num_elements: 5,
|
||||
index_block_address: (usize::MAX - 4) as u64,
|
||||
};
|
||||
let buf = vec![0u8; 64];
|
||||
let r = read_extensible_array_chunks(&buf, &header, &[100], &[20], 8, 8, 8);
|
||||
assert!(r.is_err());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn parse_header_invalid_version() {
|
||||
let mut buf = vec![0u8; 256];
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user