pagers-core 0.1.3

Core library for page cache diagnostics and control on Linux and macOS
Documentation 
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

use std::ptr::NonNull;

use memmap2::Mmap;
use nix::errno::Errno;
use nix::sys::mman::{MlockAllFlags, mlockall};

fn eperm_message(call: &str) -> std::io::Error {
    std::io::Error::new(
        std::io::ErrorKind::PermissionDenied,
        format!("{call} failed — may need SYS_IPC_LOCK capability or higher memory limits"),
    )
}

pub fn mlock(mmap: &Mmap, len: usize) -> std::io::Result<()> {
    // SAFETY: mmap.as_ptr() points to a valid memory-mapped region of at least `len` bytes.
    let addr = NonNull::new(mmap.as_ptr() as *mut std::ffi::c_void)
        .expect("mmap pointer should never be null");
    unsafe { nix::sys::mman::mlock(addr, len) }.map_err(|e| match e {
        Errno::EPERM => eperm_message("mlock"),
        other => other.into(),
    })
}

pub fn mlockall_current() -> std::io::Result<()> {
    mlockall(MlockAllFlags::MCL_CURRENT).map_err(|e| match e {
        Errno::EPERM => eperm_message("mlockall"),
        other => other.into(),
    })
}