memflow 0.2.4

core components of the memflow physical memory introspection framework
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
46
47

#[cfg(feature = "std")]
pub mod timed_validator;

pub mod count_validator;

#[cfg(feature = "std")]
#[doc(hidden)]
pub use timed_validator::*;

#[doc(hidden)]
pub use count_validator::*;

#[cfg(feature = "std")]
pub type DefaultCacheValidator = TimedCacheValidator;
#[cfg(not(feature = "std"))]
pub type DefaultCacheValidator = CountCacheValidator;

/// Validators are used when working with caches and determine for how long
/// a specific cache entry stays valid.
pub trait CacheValidator
where
    Self: Send,
{
    // TODO: better docs

    /// Allocate the required amount of slots used for validation
    fn allocate_slots(&mut self, slot_count: usize);

    /// Invoked once per Read/Write so internal state can be updated if necessary.
    ///
    /// This is an optimization so things like `std::time::Instant` only need to be computed once.
    fn update_validity(&mut self) {
        // no-op
    }

    /// Checks wether or not the given slot is valid.
    fn is_slot_valid(&self, slot_id: usize) -> bool;

    /// Callback from the cache implementation when a page is cached
    /// and the slot should become valid.
    fn validate_slot(&mut self, slot_id: usize);

    /// Callback from the caching implementation to mark a slot as invalid.
    ///
    /// This can happen if two different cache entries fall into the same slot id.
    fn invalidate_slot(&mut self, slot_id: usize);
}