#![allow(
unsafe_code,
reason = "read-only file mapping is isolated behind an immutable slice API"
)]
use memmap2::{Mmap, MmapOptions};
use std::{fs::File, io, path::Path, sync::Arc};
#[derive(Clone, Debug)]
pub struct MappedModelFile {
bytes: Arc<Mmap>,
}
impl MappedModelFile {
pub unsafe fn open(path: &Path) -> io::Result<Self> {
let file = File::open(path)?;
if file.metadata()?.len() == 0 {
return Err(io::Error::new(
io::ErrorKind::InvalidData,
"model file must not be empty",
));
}
let bytes = Arc::new(unsafe { MmapOptions::new().map(&file)? });
Ok(Self { bytes })
}
pub fn as_bytes(&self) -> &[u8] {
&self.bytes
}
}
#[cfg(test)]
mod tests {
use super::MappedModelFile;
use std::{fs, io, path::PathBuf};
#[test]
fn maps_complete_file_contents_read_only() -> io::Result<()> {
let path = temporary_path("contents");
fs::write(&path, b"GGUF-test-bytes")?;
let mapped = unsafe { MappedModelFile::open(&path)? };
assert_eq!(mapped.as_bytes(), b"GGUF-test-bytes");
drop(mapped);
fs::remove_file(path)
}
#[test]
fn rejects_empty_model_file() -> io::Result<()> {
let path = temporary_path("empty");
fs::write(&path, [])?;
let error = unsafe { MappedModelFile::open(&path) }
.err()
.ok_or_else(|| io::Error::other("empty model file unexpectedly mapped"))?;
fs::remove_file(path)?;
assert_eq!(error.kind(), io::ErrorKind::InvalidData);
Ok(())
}
fn temporary_path(label: &str) -> PathBuf {
std::env::temp_dir().join(format!(
"ferrite-mapped-model-{label}-{}",
std::process::id()
))
}
}