Struct Budget 

pub struct Budget {
    pub slice: String,
    pub memory_max: Option<u64>,
    pub memory_in_use: u64,
    pub admission: AdmissionPolicy,
    pub held: bool,
    pub mirror_memory: u64,
    pub seed_memory: Vec<SeedMemory>,
    pub shell_memory: Vec<ShellMemory>,
    pub host: Option<HostBudget>,
    pub cpu: Option<CpuBudget>,
    pub slice_cpus: Option<u64>,
}

The memory budget runners and the mirror share, in bytes.

Fields

slice: String

The systemd slice runner containers run in.

memory_max: Option<u64>

The slice’s MemoryMax; None when it is unlimited.

memory_in_use: u64

Memory the running containers reserve: the runners’ caps, or under measured admission the larger of each runner’s predicted peak and its last sampled memory, and the caps of the seed containers, shells and the mirror.

admission: AdmissionPolicy

What a new runner must fit in beside them.

held: bool

Under measured admission, whether the slice is at the high-water mark, so no runner starts.

mirror_memory: u64

The mirror’s part of memory_in_use: its cap while it is enabled or still running, else 0.

seed_memory: Vec<SeedMemory>

The seed containers’ part of memory_in_use, one per profile that reseeds, by profile name.

shell_memory: Vec<ShellMemory>

The shells’ part of memory_in_use, one per shell open in a record, by job.

host: Option<HostBudget>

What the host’s memory leaves runners beside its other programs, from a recent reading of it; absent without one.

cpu: Option<CpuBudget>

The CPU budget, under [host] cpu_overcommit. Absent without one.

slice_cpus: Option<u64>

The CPUs the slice may use, in millicores: its AllowedCPUs or the host’s, less under a lower CPUQuota, whether or not a CPU budget admits runners. The runners’ CPU limits are quotas that may add up past it. Absent when it could not be read.

Implementations

impl Budget

pub fn memory_reading(&self) -> Reading

What is reserved of what, as every client shows it: 8G of 24G reserved in runnerd.slice, or without MemoryMax 8G reserved in runnerd.slice, which has no MemoryMax; how runners are admitted (Budget::admission_note) follows the slice.

pub fn clauses(&self) -> Vec<String>

The budget’s clauses in the order clients show them: memory (Budget::memory_reading), then CPU (CpuBudget::line) and the host (Budget::host_line) when the daemon reports them.

pub fn host_line(&self) -> Option<String>

The host’s line as clients show it, such as host: 31G of 64G available, 1.5% stalled for memory; leaves the slice 40G; when that is less room than MemoryMax leaves (Budget::host_withheld), …; leaves the slice 25G of its 46G, so 6.5G is free, and without MemoryMax, where the host alone bounds it, …; leaves the slice 25G, so 6.5G is free; while it stalls, …; stalling, so no runner starts. While the slice is held (Budget::held), nothing is free, so it says no figure of it. With programs outside the slice large enough to name, …; programs outside CI hold 30G, most java 9.3G (HostMemory::outside_line). None without a recent reading of the host.

pub fn host_withheld(&self) -> Option<u64>

What the host’s memory holds back of the room MemoryMax leaves beside what runs, in bytes: that room less what the host has to spare (HostBudget::spare), when the host leaves less. None while it leaves as much, while it stalls (its line says no runner starts), without a recent reading of it, and without MemoryMax.

pub fn line(&self) -> String

The budget as one line, its clauses joined by ; .

pub fn remaining(&self) -> Option<u64>

What MemoryMax leaves beside every running container’s reservation, in bytes: what a new runner must fit in. None without MemoryMax.

impl Budget

pub fn admission_note(&self) -> Option<&'static str>

How runners are admitted, as clients add it to the budget’s line: nothing under caps, else by predicted peaks, and why nothing starts while the slice is at the high-water mark.

Trait Implementations

impl Clone for Budget

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Budget

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Budget

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Budget

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Budget

impl PartialEq for Budget

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for Budget

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Budget