clawhdf5-remote: block cache and HTTP range reads (open_url)

Range-read milestone M3, first half: a new crate with the block cache the
design makes mandatory for remote files and an HTTP backend, so
open_url("http://...") gives a clawhdf5::File over File::open_storage.

BlockCache wraps any Storage: aligned blocks (1 MiB by default, the size
docs/design/range-reads.md section 2 measured), LRU with a byte budget,
the missing blocks of one read_at/read_ranges fetched with one backend
read_ranges call as runs of consecutive blocks (a one-block gap filled to
merge runs, each request at most 8 MiB), and reads that miss more than
half the budget not kept. Thread-safe without holding the lock across a
fetch: a block being fetched is in flight, a second reader waits for it
instead of fetching it again, and a failed fetch fails its waiters and is
not cached. A backend holding the file in memory passes through.

HttpStorage (ureq, no TLS by default; `https` adds rustls with ring):
opening is one ranged GET of the first block, whose Content-Range gives
the length (the cache keeps the bytes). The file is pinned by a strong
ETag (If-Match), else Last-Modified (If-Unmodified-Since), and its length,
checked on every response: a change is RemoteError::FileChanged, never
mixed data. A server that ignores Range is refused without reading the
body unless a full download is allowed. Connection errors, timeouts,
408/429/5xx and short bodies are retried with exponential backoff;
Accept-Encoding: identity, and an encoded body is refused. read_ranges
fetches its ranges in parallel.

Tests (a std-only HTTP/1.1 server in tests/common/server.rs, also the
range_server example): every fixture read over HTTP gives File::open's
transcript (CLAWHDF5_REMOTE_CORPUS adds the conformance corpus), with
request counts per file with and without the cache; an h5py-written file
against libhdf5's values; a multi-block file fetched in whole blocks, each
once; a server ignoring Range; a file replaced mid-read (ETag,
Last-Modified, length only); truncated bodies and 503s (retried, then an
error, never cached); a slow server with 8 concurrent readers (no block
fetched twice); bad URLs, 404, encoded bodies, non-HDF5 data. The cache
has unit tests for coalescing, splitting, LRU order, large reads,
failures and concurrent in-flight dedup.

ci-test.sh: clawhdf5-remote joins the no-C default-build check, and its
https feature is linted.

Co-Authored-By: Claude Opus 5.5 (1M context) <[email protected]>
This commit is contained in:
osobh
2026-09-26 17:13:28 -05:00
co-authored by Claude Opus 5.5
parent f191dc09d5
commit db2554dd81
14 changed files with 3024 additions and 6 deletions
@@ -0,0 +1,45 @@
//! List a remote HDF5 file and read one dataset, then print what it cost.
//!
//! ```text
//! cargo run -p clawhdf5-remote --example read_url -- URL [DATASET]
//! ```
use clawhdf5::File;
use clawhdf5_remote::{Options, storage_for_url};
fn main() -> Result<(), Box<dyn std::error::Error>> {
let mut args = std::env::args().skip(1);
let url = args.next().ok_or("usage: read_url URL [DATASET]")?;
let dataset = args.next();
let storage = storage_for_url(&url, &Options::default())?;
let file = File::open_storage(storage.clone())?;
// Walk the tree.
let mut stack = vec![("/".to_string(), file.root())];
while let Some((path, group)) = stack.pop() {
for (name, addr) in group.entries()? {
let child = format!("{}/{name}", path.trim_end_matches('/'));
match file.dataset_at(addr) {
Ok(ds) => println!("{child} dataset {:?} {:?}", ds.shape()?, ds.dtype()?),
Err(_) => {
println!("{child} group");
stack.push((child, file.group_at(addr)));
}
}
}
}
if let Some(name) = dataset {
let values = file.dataset(&name)?.read_f64()?;
let shown: Vec<_> = values.iter().take(8).collect();
println!("{name}: {} values, first {shown:?}", values.len());
}
let s = storage.stats();
println!(
"{} range requests (the one at open included), {} bytes fetched, {} bytes cached",
s.requests, s.bytes_fetched, s.cached_bytes
);
Ok(())
}