fix: apply a metadata cache image without copying the file
apply_cache_image returned a copy of the whole file with the image's
entries written in, and File (mmap by default), MmapFile and LazyFile
used that copy for every read: opening a 1 GiB sparse file with an image
needed 2 GB of memory, and an 8 GiB one aborted the process, where
de2a53f (which ignored the image) opened them in a few MB.
The metadata parsers read one contiguous slice, so the image still has
to be laid over the file's bytes; it is now laid over a private copy
that costs only the pages it touches:
- clawhdf5_format::superblock_ext::CacheImage decodes the image into an
entry list (address, offset in the block, length) and applies it to
any destination; cache_image_state tells an opener whether the file
has no image, a loadable one, or one libhdf5 cannot load;
apply_cache_image_in_place is for readers that own their buffer.
apply_cache_image and metadata_view (which copied) are gone.
- clawhdf5_io::HDF5Read::private_copy returns a writable private copy
of a reader's bytes: MmapReader gives a MAP_PRIVATE copy-on-write
mapping (memmap2 map_copy), so only the pages the entries land on are
copied; the default copies the bytes (in-memory readers).
- File, MmapFile and LazyFile write the image into that mapping
(crate::cache_image). File::from_bytes / open_buffered patch their own
buffer in place, copying only the image block, as libhdf5 does. A
file without an image is read straight from the mapping, unchanged.
An image entry that runs past the end of file is now refused: libhdf5
checks only that it starts inside the file, and the images libhdf5
writes never do this, but those bytes have nowhere to go in a view of
the file.
Tests: tests/cache_image_memory.rs has libhdf5 (through ctypes) add an
image to a 1 GiB sparse file and bounds resident-memory growth for all
three openers at 256 MiB; it fails on the previous commit (File::open
grew 2,148,720,640 bytes). reader.rs zero_copy_tests check that a file
without an image is read from the mapping itself and that an image goes
into a copy-on-write mapping, not a heap copy; clawhdf5-io checks that
private_copy writes never reach the reader or the file.
Co-Authored-By: Claude Opus 5.5 (1M context) <[email protected]>
This commit is contained in:
@@ -87,6 +87,19 @@ impl HDF5Read for MmapReader {
|
||||
fn as_bytes(&self) -> &[u8] {
|
||||
&self.mmap
|
||||
}
|
||||
|
||||
/// A private copy-on-write mapping of the file (`MAP_PRIVATE`): only the
|
||||
/// pages written to are copied.
|
||||
fn private_copy(&self) -> io::Result<crate::PrivateCopy> {
|
||||
if self.mmap.is_empty() {
|
||||
return Ok(crate::PrivateCopy::Owned(Vec::new()));
|
||||
}
|
||||
// SAFETY: as for `open`: the caller keeps the file from being
|
||||
// modified while the mapping is alive. Writes to a private mapping
|
||||
// never reach the file.
|
||||
let map = unsafe { memmap2::MmapOptions::new().map_copy(&self._file)? };
|
||||
Ok(crate::PrivateCopy::Mapped(map))
|
||||
}
|
||||
}
|
||||
|
||||
/// Writable memory-mapped file for read-write HDF5 access.
|
||||
@@ -218,6 +231,22 @@ mod tests {
|
||||
fs::remove_file(&path).ok();
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn private_copy_is_a_copy_on_write_mapping() {
|
||||
let dir = tempfile::tempdir().unwrap();
|
||||
let path = dir.path().join("cow.bin");
|
||||
fs::write(&path, [1u8, 2, 3, 4]).unwrap();
|
||||
let reader = MmapReader::open(&path).unwrap();
|
||||
let mut copy = reader.private_copy().unwrap();
|
||||
assert!(copy.is_mapped());
|
||||
copy[1] = 99;
|
||||
assert_eq!(©[..], &[1, 99, 3, 4]);
|
||||
// Neither the reader's mapping nor the file sees the write.
|
||||
assert_eq!(reader.as_bytes(), &[1, 2, 3, 4]);
|
||||
drop(copy);
|
||||
assert_eq!(fs::read(&path).unwrap(), [1, 2, 3, 4]);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn mmap_reader_read_at() {
|
||||
let dir = std::env::temp_dir();
|
||||
|
||||
Reference in New Issue
Block a user