Struct cgroups_rs::memory::MemController

pub struct MemController { /* private fields */ }

A controller that allows controlling the memory subsystem of a Cgroup.

In essence, using the memory controller, the user can gather statistics about the memory usage of the tasks in the control group. Additonally, one can also set powerful limits on their memory usage.

Implementations

impl MemController

pub fn new(root: PathBuf, v2: bool) -> Self

Contructs a new MemController with root serving as the root of the control group.

pub fn set_mem(&self, m: SetMemory) -> Result<()>

pub fn get_mem(&self) -> Result<SetMemory>

pub fn memory_stat(&self) -> Memory

Gathers overall statistics (and the current state of) about the memory usage of the control group’s tasks.

See the individual fields for more explanation, and as always, remember to consult the kernel Documentation and/or sources.

pub fn kmem_stat(&self) -> Kmem

Gathers information about the kernel memory usage of the control group’s tasks.

pub fn kmem_tcp_stat(&self) -> Tcp

Gathers information about the control group’s kernel memory usage where said memory is TCP-related.

pub fn memswap_v2(&self) -> MemSwap

pub fn memswap(&self) -> MemSwap

Gathers information about the memory usage of the control group including the swap usage (if any).

pub fn reset_fail_count(&self) -> Result<()>

Reset the fail counter

pub fn reset_kmem_fail_count(&self) -> Result<()>

Reset the kernel memory fail counter

pub fn reset_tcp_fail_count(&self) -> Result<()>

Reset the TCP related fail counter

pub fn reset_memswap_fail_count(&self) -> Result<()>

Reset the memory+swap fail counter

pub fn reset_max_usage(&self) -> Result<()>

Reset the max memory usage recorded

pub fn set_limit(&self, limit: i64) -> Result<()>

Set the memory usage limit of the control group, in bytes.

pub fn set_kmem_limit(&self, limit: i64) -> Result<()>

Set the kernel memory limit of the control group, in bytes.

pub fn set_memswap_limit(&self, limit: i64) -> Result<()>

Set the memory+swap limit of the control group, in bytes.

pub fn set_tcp_limit(&self, limit: i64) -> Result<()>

Set how much kernel memory can be used for TCP-related buffers by the control group.

pub fn set_soft_limit(&self, limit: i64) -> Result<()>

Set the soft limit of the control group, in bytes.

This limit is enforced when the system is nearing OOM conditions. Contrast this with the hard limit, which is always enforced.

pub fn set_swappiness(&self, swp: u64) -> Result<()>

Set how likely the kernel is to swap out parts of the address space used by the control group.

Note that a value of zero does not imply that the process will not be swapped out.

pub fn disable_oom_killer(&self) -> Result<()>

pub fn register_oom_event(&self, key: &str) -> Result<Receiver<String>>

Trait Implementations

impl Clone for MemController

fn clone(&self) -> MemController

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MemController

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

Formats the value using the given formatter.

impl<'a> From<&'a Subsystem> for &'a MemController

fn from(sub: &'a Subsystem) -> &'a MemController

Converts to this type from the input type.