Struct cgroups_rs::blkio::BlkIoController

source · [−]

pub struct BlkIoController { /* private fields */ }

Expand description

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

In essence, using the blkio controller one can limit and throttle the tasks’ usage of block devices in the control group.

Implementations

source

impl BlkIoController

source

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

Constructs a new BlkIoController with root serving as the root of the control group.

source

pub fn blkio(&self) -> BlkIo

Gathers statistics about and reports the state of the block devices used by the control group’s tasks.

source

pub fn set_leaf_weight(&self, w: u64) -> Result<()>

Set the leaf weight on the control group’s tasks, i.e., how are they weighted against the descendant control groups’ tasks.

source

pub fn set_leaf_weight_for_device(
 &self,
 major: u64,
 minor: u64,
 weight: u64
) -> Result<()>

Same as set_leaf_weight(), but settable per each block device.

source

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

Reset the statistics the kernel has gathered so far and start fresh.

source

pub fn throttle_read_bps_for_device(
 &self,
 major: u64,
 minor: u64,
 bps: u64
) -> Result<()>

Throttle the bytes per second rate of read operation affecting the block device major:minor to bps.

source

pub fn throttle_read_iops_for_device(
 &self,
 major: u64,
 minor: u64,
 iops: u64
) -> Result<()>

Throttle the I/O operations per second rate of read operation affecting the block device major:minor to bps.

source

pub fn throttle_write_bps_for_device(
 &self,
 major: u64,
 minor: u64,
 bps: u64
) -> Result<()>

Throttle the bytes per second rate of write operation affecting the block device major:minor to bps.

source

pub fn throttle_write_iops_for_device(
 &self,
 major: u64,
 minor: u64,
 iops: u64
) -> Result<()>

Throttle the I/O operations per second rate of write operation affecting the block device major:minor to bps.

source

pub fn set_weight(&self, w: u64) -> Result<()>

Set the weight of the control group’s tasks.

source

pub fn set_weight_for_device(
 &self,
 major: u64,
 minor: u64,
 weight: u64
) -> Result<()>

Same as set_weight(), but settable per each block device.

Trait Implementations

source

impl Clone for BlkIoController

source

fn clone(&self) -> BlkIoController

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

impl Debug for BlkIoController

source

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

Formats the value using the given formatter. Read more

source

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

source

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

Converts to this type from the input type.

Auto Trait Implementations

impl RefUnwindSafe for BlkIoController

impl Send for BlkIoController

impl Sync for BlkIoController

impl Unpin for BlkIoController

impl UnwindSafe for BlkIoController

Blanket Implementations

source

impl<T> Any for Twhere
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for Twhere
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> Controller for Twhere
T: ControllerInternal,

source

fn apply(&self, res: &Resources) -> Result<(), Error>

Apply a set of resources to the Controller, invoking its internal functions to pass the kernel the information.

source

fn create(&self)

Create this controller

source

fn set_notify_on_release(&self, enable: bool) -> Result<(), Error>

Set notify_on_release

source

fn set_release_agent(&self, path: &str) -> Result<(), Error>

Set release_agent

source

fn exists(&self) -> bool

Does this controller already exist?

source

fn delete(&self) -> Result<(), Error>

Delete the controller.

source

fn add_task(&self, pid: &CgroupPid) -> Result<(), Error>

Attach a task to this controller.

source

fn add_task_by_tgid(&self, pid: &CgroupPid) -> Result<(), Error>

Attach a task to this controller by thread group id.

source

fn tasks(&self) -> Vec<CgroupPid, Global>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A>where A: Allocator,`

Get the list of tasks that this controller has.

source

fn control_type(&self) -> Controllers

source

fn path(&self) -> &Path

The file system path to the controller.

source

fn v2(&self) -> bool

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for Twhere
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T> ToOwned for Twhere
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T, U> TryFrom for Twhere
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for Twhere
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct cgroups_rs::blkio::BlkIoController

Implementations

impl BlkIoController

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

pub fn blkio(&self) -> BlkIo

pub fn set_leaf_weight(&self, w: u64) -> Result<()>

pub fn set_leaf_weight_for_device( &self, major: u64, minor: u64, weight: u64) -> Result<()>

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

pub fn throttle_read_bps_for_device( &self, major: u64, minor: u64, bps: u64) -> Result<()>

pub fn throttle_read_iops_for_device( &self, major: u64, minor: u64, iops: u64) -> Result<()>

pub fn throttle_write_bps_for_device( &self, major: u64, minor: u64, bps: u64) -> Result<()>

pub fn throttle_write_iops_for_device( &self, major: u64, minor: u64, iops: u64) -> Result<()>

pub fn set_weight(&self, w: u64) -> Result<()>

pub fn set_weight_for_device( &self, major: u64, minor: u64, weight: u64) -> Result<()>

Trait Implementations

impl Clone for BlkIoController

fn clone(&self) -> BlkIoController

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

impl Debug for BlkIoController

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

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

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

Auto Trait Implementations

impl RefUnwindSafe for BlkIoController

impl Send for BlkIoController

impl Sync for BlkIoController

impl Unpin for BlkIoController

impl UnwindSafe for BlkIoController

Blanket Implementations

impl<T> Any for Twhere T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for Twhere T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for Twhere T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> Controller for Twhere T: ControllerInternal,

fn apply(&self, res: &Resources) -> Result<(), Error>

fn create(&self)

fn set_notify_on_release(&self, enable: bool) -> Result<(), Error>

fn set_release_agent(&self, path: &str) -> Result<(), Error>

fn exists(&self) -> bool

fn delete(&self) -> Result<(), Error>

fn add_task(&self, pid: &CgroupPid) -> Result<(), Error>

fn add_task_by_tgid(&self, pid: &CgroupPid) -> Result<(), Error>

fn tasks(&self) -> Vec<CgroupPid, Global>ⓘNotable traits for Vec<u8, A>impl<A> Write for Vec<u8, A>where A: Allocator,

fn control_type(&self) -> Controllers

fn path(&self) -> &Path

fn v2(&self) -> bool

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for Twhere U: From<T>,

fn into(self) -> U

impl<T> ToOwned for Twhere T: Clone,

type Owned = T

fn to_owned(&self) -> T

fn clone_into(&self, target: &mut T)

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

pub fn set_leaf_weight_for_device(
&self,
major: u64,
minor: u64,
weight: u64
) -> Result<()>

pub fn throttle_read_bps_for_device(
&self,
major: u64,
minor: u64,
bps: u64
) -> Result<()>

pub fn throttle_read_iops_for_device(
&self,
major: u64,
minor: u64,
iops: u64
) -> Result<()>

pub fn throttle_write_bps_for_device(
&self,
major: u64,
minor: u64,
bps: u64
) -> Result<()>

pub fn throttle_write_iops_for_device(
&self,
major: u64,
minor: u64,
iops: u64
) -> Result<()>

pub fn set_weight_for_device(
&self,
major: u64,
minor: u64,
weight: u64
) -> Result<()>

impl<T> Any for Twhere
T: 'static + ?Sized,

impl<T> Borrow<T> for Twhere
T: ?Sized,

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

impl<T> Controller for Twhere
T: ControllerInternal,

fn tasks(&self) -> Vec<CgroupPid, Global>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A>where A: Allocator,`

impl<T, U> Into<U> for Twhere
U: From<T>,

impl<T> ToOwned for Twhere
T: Clone,

impl<T, U> TryFrom<U> for Twhere
U: Into<T>,

impl<T, U> TryInto<U> for Twhere
U: TryFrom<T>,