nodedb-mem 0.0.0

Global NUMA-aware memory governor preventing subsystem OOM and cache cannibalization
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

use crate::engine::EngineId;

/// Errors produced by the memory governor.
#[derive(Debug, thiserror::Error)]
pub enum MemError {
    /// Allocation request exceeds the engine's remaining budget.
    #[error(
        "memory budget exhausted for {engine:?}: requested {requested} bytes, \
         available {available} bytes (limit: {limit} bytes)"
    )]
    BudgetExhausted {
        engine: EngineId,
        requested: usize,
        available: usize,
        limit: usize,
    },

    /// The global memory ceiling would be exceeded.
    #[error(
        "global memory ceiling exceeded: total allocated {allocated} bytes, \
         ceiling {ceiling} bytes, requested {requested} bytes"
    )]
    GlobalCeilingExceeded {
        allocated: usize,
        ceiling: usize,
        requested: usize,
    },

    /// Engine is not registered with the governor.
    #[error("unknown engine: {0:?}")]
    UnknownEngine(EngineId),

    /// jemalloc introspection error.
    #[error("jemalloc error: {0}")]
    Jemalloc(String),

    /// Overflow region error (mmap, I/O, or capacity).
    #[error("overflow region error: {0}")]
    Overflow(String),
}

pub type Result<T> = std::result::Result<T, MemError>;