ferrite_model/
model_file.rs1#![allow(
3 unsafe_code,
4 reason = "read-only file mapping is isolated behind an immutable slice API"
5)]
6
7use memmap2::{Mmap, MmapOptions};
8use std::{fs::File, io, path::Path, sync::Arc};
9
10#[derive(Clone, Debug)]
16pub struct MappedModelFile {
17 bytes: Arc<Mmap>,
18}
19
20impl MappedModelFile {
21 pub unsafe fn open(path: &Path) -> io::Result<Self> {
34 let file = File::open(path)?;
35 if file.metadata()?.len() == 0 {
36 return Err(io::Error::new(
37 io::ErrorKind::InvalidData,
38 "model file must not be empty",
39 ));
40 }
41 let bytes = Arc::new(unsafe { MmapOptions::new().map(&file)? });
45 Ok(Self { bytes })
46 }
47
48 pub fn as_bytes(&self) -> &[u8] {
50 &self.bytes
51 }
52}
53
54#[cfg(test)]
55mod tests {
56 use super::MappedModelFile;
57 use std::{fs, io, path::PathBuf};
58
59 #[test]
60 fn maps_complete_file_contents_read_only() -> io::Result<()> {
61 let path = temporary_path("contents");
62 fs::write(&path, b"GGUF-test-bytes")?;
63
64 let mapped = unsafe { MappedModelFile::open(&path)? };
67 assert_eq!(mapped.as_bytes(), b"GGUF-test-bytes");
68
69 drop(mapped);
70 fs::remove_file(path)
71 }
72
73 #[test]
74 fn rejects_empty_model_file() -> io::Result<()> {
75 let path = temporary_path("empty");
76 fs::write(&path, [])?;
77
78 let error = unsafe { MappedModelFile::open(&path) }
81 .err()
82 .ok_or_else(|| io::Error::other("empty model file unexpectedly mapped"))?;
83
84 fs::remove_file(path)?;
85 assert_eq!(error.kind(), io::ErrorKind::InvalidData);
86 Ok(())
87 }
88
89 fn temporary_path(label: &str) -> PathBuf {
90 std::env::temp_dir().join(format!(
91 "ferrite-mapped-model-{label}-{}",
92 std::process::id()
93 ))
94 }
95}