Struct cgroups_fs::AutomanagedCgroup

pub struct AutomanagedCgroup { /* fields omitted */ }

An automatically managed controller of a specific cgroups subsystem.

It is a wrapper around Cgroup type which automatically creates (on init) and removes (on drop) a cgroup in a given subsystem.

Since it is a wrapper, all the methods from Cgroup type are directly available for AutomanagedCgroup instances.

Methods

impl AutomanagedCgroup

pub fn init(cgroup_name: &CgroupName, subsystem: &str) -> Result<Self>

Inits a cgroup, which means that it creates a cgroup in a given subsystem.

Notes:

• If there is an existing cgroup, it will be recreated from scratch. If that is not what you what, consider using Cgroup type instead.
• The cgroup will be automatically removed once the AutomanagedCgroup instance is dropped.

Methods from Deref<Target = Cgroup>

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

Creates a cgroups namespace.

Notes:

• Keep in mind the usual filesystem permissions (owner, group, and mode bits).

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

Removes a cgroups namespace.

Notes:

• This method will fail if there are nested cgroups.
• Keep in mind the usual filesystem permissions (owner, group, and mode bits).

pub fn set_raw_value<V>(&self, key: &str, value: V) -> Result<()> where
    V: AsRef<[u8]>, 

Sets a binary or string value to the cgroup control file.

pub fn set_value<V>(&self, key: &str, value: V) -> Result<()> where
    V: Copy + ToString, 

Sets a value to the cgroup control file.

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

Gets a string value from cgroup control file.

pub fn get_value<T>(&self, key: &str) -> Result<T> where
    T: FromStr, 

Gets a value from cgroup control file.

pub fn add_task(&self, pid: Pid) -> Result<()>

Attaches a task (thread) to the cgroup.

pub fn get_tasks(&self) -> Result<Vec<Pid>>

Lists tasks (threads) attached to the cgroup.

pub fn send_signal_to_all_tasks(&self, signal: Signal) -> Result<usize>

Sends a specified Unix Signal to all the tasks in the Cgroup.

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

Deprecated since 1.0.1:

please, use freezer cgroup to implement kill_all_tasks reliably (https://gitlab.com/dots.org.ua/ddots-runner/blob/d967ee3ba9de364dfb5a2e1a4f468586efb504f8/src/extensions/process.rs#L132-166)

Kills (SIGKILL) all the attached to the cgroup tasks.

WARNING: The naive implementation turned out to be not reliable enough for the fork-bomb use-case. To implement a reliable kill_all method, use freezer Cgroup. It is decided to move such extensions into a separate crate (to be announced).

Trait Implementations

impl Drop for AutomanagedCgroup

fn drop(&mut self)

Executes the destructor for this type.

impl AsRef<Cgroup> for AutomanagedCgroup

fn as_ref(&self) -> &Cgroup

Performs the conversion.

impl Debug for AutomanagedCgroup

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

Formats the value using the given formatter.

impl Deref for AutomanagedCgroup

type Target = Cgroup

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.