mirror of
https://github.com/kata-containers/cgroups-rs.git
synced 2026-08-05 02:13:23 +00:00
c774e9e123
The tests cover the methods of `conv` mod, `FsManager`, and `SystemdManager`. Since we have to manipulate the cgroups during testing, the tests related to this part are set to be run in sequence. Signed-off-by: Xuewei Niu <niuxuewei.nxw@antgroup.com>
114 lines
3.5 KiB
Rust
114 lines
3.5 KiB
Rust
// Copyright (c) 2025 Ant Group
|
|
//
|
|
// SPDX-License-Identifier: Apache-2.0 or MIT
|
|
//
|
|
|
|
mod error;
|
|
use std::collections::HashMap;
|
|
|
|
pub use error::{Error, Result};
|
|
mod fs;
|
|
pub use fs::FsManager;
|
|
mod systemd;
|
|
pub use systemd::SystemdManager;
|
|
mod conv;
|
|
|
|
use oci_spec::runtime::LinuxResources;
|
|
|
|
use crate::systemd::SLICE_SUFFIX;
|
|
use crate::{CgroupPid, CgroupStats, FreezerState};
|
|
|
|
/// Check if the cgroups path is a systemd cgroup.
|
|
pub fn is_systemd_cgroup(cgroups_path: &str) -> bool {
|
|
let parts: Vec<&str> = cgroups_path.split(':').collect();
|
|
parts.len() == 3 && parts[0].ends_with(SLICE_SUFFIX)
|
|
}
|
|
|
|
/// Manage cgroups designed for OCI containers.
|
|
pub trait Manager: Send + Sync {
|
|
/// Add a process specified by its tgid.
|
|
fn add_proc(&mut self, tgid: CgroupPid) -> Result<()>;
|
|
|
|
/// Add a thread specified by its pid.
|
|
fn add_thread(&mut self, pid: CgroupPid) -> Result<()>;
|
|
|
|
/// Get the list of pids joint to the cgroups.
|
|
fn pids(&self) -> Result<Vec<CgroupPid>>;
|
|
|
|
/// Set the freezer cgroup to the specified state.
|
|
fn freeze(&self, state: FreezerState) -> Result<()>;
|
|
|
|
/// Remove the cgroups.
|
|
fn destroy(&mut self) -> Result<()>;
|
|
|
|
/// Set the resources to the cgroups.
|
|
fn set(&mut self, resources: &LinuxResources) -> Result<()>;
|
|
|
|
/// Get the cgroup path.
|
|
///
|
|
/// # Arguments
|
|
///
|
|
/// - `subsystem`: cgroup subsystem, for cgroup v1 the value should not
|
|
/// be empty, while for cgroup v2 the only valid value is `None`.
|
|
fn cgroup_path(&self, subsystem: Option<&str>) -> Result<String>;
|
|
|
|
/// Enable CPUs, topdown from root in cgroup hierarchy, this would be
|
|
/// useful for CPU hotplug in the guest.
|
|
///
|
|
/// The caller should update cgroup resources manually, in particular
|
|
/// cpuset, after this, in order to use the new CPUs (or avoid using
|
|
/// offline CPUs).
|
|
///
|
|
/// # Arguments
|
|
///
|
|
/// - `cpus`: online CPUs in the same format with `cat
|
|
/// /sys/devices/system/cpu/online`, e.g. "0-3,6-7".
|
|
fn enable_cpus_topdown(&self, cpus: &str) -> Result<()>;
|
|
|
|
/// Get cgroup stats.
|
|
fn stats(&self) -> CgroupStats;
|
|
|
|
/// Get the mappings of subsystems to their relative path. The full
|
|
/// path would be something like "{mountpoint}/{relative_path}". The
|
|
/// mappings of mountpoints see "mounts()".
|
|
fn paths(&self) -> &HashMap<String, String>;
|
|
|
|
/// Get the mappings of subsystems to their mountpoints. The full
|
|
/// path would be something like "{mountpoint}/{relative_path}". The
|
|
/// mappings of relative paths see "paths()".
|
|
fn mounts(&self) -> &HashMap<String, String>;
|
|
|
|
/// Indicate whether the cgroup manager is using systemd.
|
|
fn systemd(&self) -> bool;
|
|
|
|
/// Indicate whether the cgroup manager is using cgroup v2.
|
|
fn v2(&self) -> bool;
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod tests {
|
|
pub const MEMORY_512M: i64 = 512 * 1024 * 1024; // 512 MiB
|
|
pub const MEMORY_1G: i64 = 1024 * 1024 * 1024; // 1 GiB
|
|
pub const MEMORY_2G: i64 = 2 * 1024 * 1024 * 1024; // 2 GiB
|
|
|
|
#[macro_export]
|
|
macro_rules! skip_if_cgroups_v1 {
|
|
() => {
|
|
if !$crate::fs::hierarchies::is_cgroup2_unified_mode() {
|
|
eprintln!("Skipping test in cgroups v1 mode");
|
|
return;
|
|
}
|
|
};
|
|
}
|
|
|
|
#[macro_export]
|
|
macro_rules! skip_if_cgroups_v2 {
|
|
() => {
|
|
if $crate::fs::hierarchies::is_cgroup2_unified_mode() {
|
|
eprintln!("Skipping test in cgroups v2 mode");
|
|
return;
|
|
}
|
|
};
|
|
}
|
|
}
|