Struct cgroups_rs::cpu::CpuController

pub struct CpuController { /* fields omitted */ }

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

In essence, it allows gathering information about how much the tasks inside the control group are using the CPU and creating rules that limit their usage. Note that this crate does not yet support managing realtime tasks.

Implementations

impl CpuController

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

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

pub fn cpu(&self) -> Cpu

Returns CPU time statistics based on the processes in the control group.

pub fn set_shares(&self, shares: u64) -> Result<()>

Configures the CPU bandwidth (in relative relation to other control groups and this control group’s parent).

For example, setting control group A’s shares to 100, and control group B’s shares to 200 ensures that control group B receives twice as much as CPU bandwidth. (Assuming both A and B are of the same parent)

pub fn shares(&self) -> Result<u64>

Retrieve the CPU bandwidth that this control group (relative to other control groups and this control group’s parent) can use.

pub fn set_cfs_period(&self, us: u64) -> Result<()>

Specify a period (when using the CFS scheduler) of time in microseconds for how often this control group’s access to the CPU should be reallocated.

pub fn cfs_period(&self) -> Result<u64>

Retrieve the period of time of how often this cgroup’s access to the CPU should be reallocated in microseconds.

pub fn set_cfs_quota(&self, us: i64) -> Result<()>

Specify a quota (when using the CFS scheduler) of time in microseconds for which all tasks in this control group can run during one period (see: set_cfs_period()).

pub fn cfs_quota(&self) -> Result<i64>

Retrieve the quota of time for which all tasks in this cgroup can run during one period, in microseconds.

pub fn set_cfs_quota_and_period(
    &self,
    quota: Option<i64>,
    period: Option<u64>
) -> Result<()>

pub fn set_rt_runtime(&self, us: i64) -> Result<()>

pub fn set_rt_period_us(&self, us: u64) -> Result<()>

Trait Implementations

impl Clone for CpuController

fn clone(&self) -> CpuController

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CpuController

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

Formats the value using the given formatter.

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

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

Performs the conversion.