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
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45

use std::sync::Arc;

use memmap2::Mmap;

use crate::mincore::PageMap;

use super::touch::Touch;
use super::{FileContext, Op};
use crate::mlock;

/// Touch pages into cache, then lock them in physical memory with mlock(2).
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct Lock;

/// Holds the mmap alive after mlock — dropping this unmaps and unlocks.
#[derive(Debug)]
pub struct LockedFile {
    _mmap: Arc<Mmap>,
    pub pages_touched: usize,
}

impl Op for Lock {
    const LABEL: &str = "locked";
    const ACTION_SIGN: isize = 1;
    type Output = LockedFile;

    fn action_pages(
        output: &LockedFile,
        _total_pages: usize,
        _pages_in_core_before: Option<usize>,
        _pages_in_core_after: usize,
    ) -> usize {
        output.pages_touched
    }

    fn execute<PM: PageMap + Sync>(&self, ctx: &FileContext<'_, PM>) -> crate::Result<LockedFile> {
        let pages_touched = Touch.execute(ctx)?;
        mlock::mlock(&ctx.mmap, ctx.len)?;
        Ok(LockedFile {
            _mmap: Arc::clone(&ctx.mmap),
            pages_touched,
        })
    }
}