1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211
use std::{
fs::{self, OpenOptions},
io, mem,
ops::{Deref, DerefMut},
os::{fd::AsRawFd, unix::prelude::FileExt},
path::{Path, PathBuf},
ptr, slice,
};
/// Segment is a constant slice of type T that is memory mapped to disk.
///
/// It is the basic building block of memory mapped data structure.
///
/// It cannot growth / shrink.
#[derive(Debug)]
pub struct Segment<T> {
addr: *mut T,
len: usize,
capacity: usize,
path: Option<PathBuf>,
}
impl<T> Segment<T> {
/// Create a zero size segment.
pub const fn null() -> Self {
Self {
addr: std::ptr::null_mut(),
len: 0,
capacity: 0,
path: None,
}
}
/// Memory map a segment to disk.
///
/// File will be created and init with computed capacity.
pub fn open_rw<P: AsRef<Path>>(path: P, capacity: usize) -> io::Result<Self> {
if capacity == 0 {
return Ok(Self::null());
}
let file = OpenOptions::new()
.read(true)
.write(true)
.create(true)
.open(&path)?;
// Write a 0 at end of file to force its existence
let segment_size = capacity * mem::size_of::<T>();
file.write_at(&[0], (segment_size - 1) as u64)?;
// It is safe to not keep a reference to the initial file descriptor.
// See: https://stackoverflow.com/questions/17490033/do-i-need-to-keep-a-file-open-after-calling-mmap-on-it
let fd = file.as_raw_fd();
let offset = 0;
let addr = unsafe {
libc::mmap(
std::ptr::null_mut(),
segment_size as libc::size_t,
libc::PROT_READ | libc::PROT_WRITE,
libc::MAP_SHARED,
fd,
offset,
)
};
if addr == libc::MAP_FAILED {
Err(io::Error::last_os_error())
} else {
Ok(Self {
addr: addr.cast(),
len: 0,
capacity,
path: Some(path.as_ref().to_path_buf()),
})
}
}
/// Currently used segment size.
pub fn capacity(&self) -> usize {
self.capacity
}
/// Shortens the segment, keeping the first `new_len` elements and dropping
/// the rest.
pub fn truncate(&mut self, new_len: usize) {
if new_len > self.len {
return;
}
unsafe {
let remaining_len = self.len - new_len;
let items = ptr::slice_from_raw_parts_mut(self.addr.add(new_len), remaining_len);
self.set_len(new_len);
ptr::drop_in_place(items);
}
}
/// Clears the segment, removing all values.
pub fn clear(&mut self) {
unsafe {
let items = slice::from_raw_parts_mut(self.addr, self.len);
self.set_len(0);
ptr::drop_in_place(items);
}
}
/// Forces the length of the segment to `new_len`.
#[allow(clippy::missing_safety_doc)]
pub unsafe fn set_len(&mut self, new_len: usize) {
debug_assert!(new_len <= self.capacity());
self.len = new_len;
}
/// Bytes use on disk for this segment.
pub fn disk_size(&self) -> usize {
self.capacity * mem::size_of::<T>()
}
/// Try to add new element to the segment.
///
/// If the segment is already full, value will be return in `Err`.
pub fn push_within_capacity(&mut self, value: T) -> Result<(), T> {
if self.len == self.capacity {
return Err(value);
}
unsafe {
let dst = self.addr.add(self.len);
ptr::write(dst, value);
}
self.len += 1;
Ok(())
}
/// Remove last element of the segment and reduce its capacity.
///
/// Value will be return if segment is not empty.
pub fn pop(&mut self) -> Option<T> {
if self.len == 0 {
return None;
}
self.len -= 1;
unsafe {
let src = self.addr.add(self.len);
Some(ptr::read(src))
}
}
/// Erase segment content with `other` segment argument.
pub fn fill_from(&mut self, mut other: Segment<T>) {
assert!(self.len == 0, "New segment contains already some data");
assert!(
other.capacity < self.capacity,
"Copy segment size error (src: {}, dst: {})",
other.capacity,
self.capacity
);
unsafe {
ptr::copy(other.addr, self.addr, other.capacity);
self.set_len(other.len);
other.set_len(0);
};
}
}
impl<T> Deref for Segment<T> {
type Target = [T];
fn deref(&self) -> &Self::Target {
unsafe { slice::from_raw_parts(self.addr, self.len) }
}
}
impl<T> DerefMut for Segment<T> {
fn deref_mut(&mut self) -> &mut Self::Target {
unsafe { slice::from_raw_parts_mut(self.addr, self.len) }
}
}
impl<T> Drop for Segment<T> {
fn drop(&mut self) {
if self.len > 0 {
unsafe { ptr::drop_in_place(ptr::slice_from_raw_parts_mut(self.addr, self.len)) }
}
if self.capacity > 0 {
assert!(!self.addr.is_null());
unsafe {
// Just use debug assert here, if `munmap` failed, we cannot do so much more ...
debug_assert!(
libc::munmap(self.addr.cast(), self.capacity) == 0,
"munmap failed: {}",
io::Error::last_os_error()
);
}
}
if let Some(path) = &self.path {
let _ = fs::remove_file(path);
}
}
}
unsafe impl<T> Send for Segment<T> {}
unsafe impl<T> Sync for Segment<T> {}