Struct Cpumask

pub struct Cpumask {
    mask: BitVec<u64, Lsb0>,
}

Fields

mask: BitVec<u64, Lsb0>

Implementations

impl Cpumask

fn check_cpu(&self, cpu: usize) -> Result<()>

pub fn new() -> Cpumask

Build a new empty Cpumask object.

pub fn from_str(cpumask: &str) -> Result<Cpumask>

Build a Cpumask object from a hexadecimal string.

pub fn from_cpulist(cpulist: &str) -> Result<Cpumask>

pub fn from_vec(vec: Vec<u64>) -> Self

pub fn from_bitvec(bitvec: BitVec<u64, Lsb0>) -> Self

pub fn as_raw_slice(&self) -> &[u64]

Return a slice of u64’s whose bits reflect the Cpumask.

pub fn as_raw_bitvec_mut(&mut self) -> &mut BitVec<u64, Lsb0>

Return the mutable raw BitVec object backing the Cpumask.

pub fn as_raw_bitvec(&self) -> &BitVec<u64, Lsb0>

Return the raw BitVec object backing the Cpumask.

pub fn set_all(&mut self)

Set all bits in the Cpumask to 1

pub fn clear_all(&mut self)

Set all bits in the Cpumask to 0

pub fn set_cpu(&mut self, cpu: usize) -> Result<()>

Set a bit in the Cpumask. Returns an error if the specified CPU exceeds the size of the Cpumask.

pub fn clear_cpu(&mut self, cpu: usize) -> Result<()>

Clear a bit from the Cpumask. Returns an error if the specified CPU exceeds the size of the Cpumask.

pub fn test_cpu(&self, cpu: usize) -> bool

Test whether the specified CPU bit is set in the Cpumask. If the CPU exceeds the number of possible CPUs on the host, false is returned.

pub fn weight(&self) -> usize

Count the number of bits set in the Cpumask.

pub fn is_empty(&self) -> bool

Return true if the Cpumask has no bit set, false otherwise.

pub fn is_full(&self) -> bool

Return true if the Cpumask has all bits set, false otherwise.

pub fn len(&self) -> usize

The total size of the cpumask.

pub fn not(&self) -> Cpumask

Create a Cpumask that is the negation of the current Cpumask.

pub fn and(&self, other: &Cpumask) -> Cpumask

Create a Cpumask that is the AND of the current Cpumask and another.

pub fn or(&self, other: &Cpumask) -> Cpumask

Create a Cpumask that is the OR of the current Cpumask and another.

pub fn xor(&self, other: &Cpumask) -> Cpumask

Create a Cpumask that is the XOR of the current Cpumask and another.

pub fn iter(&self) -> CpumaskIterator<'_>

Iterate over each element of a Cpumask, and return the indices with bits set.

Examples

use log::info;
use scx_utils::Cpumask;
let str = String::from("all");
let mask = Cpumask::from_str(&str).unwrap();
for cpu in mask.iter() {
    info!("cpu {} was set", cpu);
}

pub unsafe fn write_to_ptr(&self, bpfptr: *mut u64, len: usize) -> Result<()>

Write out a CPU mask to a raw memory pointer. We normally use this as part of updating the CPU masks on the BPF side.

SAFETY: The caller must enforce that the bpfptr is valid and points to a valid region of writable BPF memory that represents a CPU mask. This function is not thread safe.

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

Trait Implementations

impl BitAndAssign<&Cpumask> for Cpumask

fn bitand_assign(&mut self, rhs: &Self)

Performs the &= operation.

impl BitOrAssign<&Cpumask> for Cpumask

fn bitor_assign(&mut self, rhs: &Self)

Performs the |= operation.

impl BitXorAssign<&Cpumask> for Cpumask

fn bitxor_assign(&mut self, rhs: &Self)

Performs the ^= operation.

impl Clone for Cpumask

fn clone(&self) -> Cpumask

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Cpumask

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

Formats the value using the given formatter.

impl Display for Cpumask

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

Formats the value using the given formatter.

impl Hash for Cpumask

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl LowerHex for Cpumask

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

Formats the value using the given formatter.

impl Ord for Cpumask

fn cmp(&self, other: &Cpumask) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Cpumask

fn eq(&self, other: &Cpumask) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Cpumask

fn partial_cmp(&self, other: &Cpumask) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl UpperHex for Cpumask

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

Formats the value using the given formatter.

impl Eq for Cpumask

impl StructuralPartialEq for Cpumask