Struct CpumaskVar

pub struct CpumaskVar { /* private fields */ }

A CPU Mask pointer.

Rust abstraction for the C struct cpumask_var_t.

Invariants

A CpumaskVar instance always corresponds to a valid C struct cpumask_var_t.

The callers must ensure that the struct cpumask_var_t is valid for access and remains valid for the lifetime of CpumaskVar.

Examples

The following example demonstrates how to create and update a CpumaskVar.

use kernel::cpu::CpuId;
use kernel::cpumask::CpumaskVar;

let mut mask = CpumaskVar::new_zero(GFP_KERNEL).unwrap();

assert!(mask.empty());
let mut count = 0;

let cpu2 = CpuId::from_u32(2);
if let Some(cpu) = cpu2 {
    mask.set(cpu);
    assert!(mask.test(cpu));
    count += 1;
}

let cpu3 = CpuId::from_u32(3);
if let Some(cpu) = cpu3 {
    mask.set(cpu);
    assert!(mask.test(cpu));
    count += 1;
}

assert_eq!(mask.weight(), count);

let mask2 = CpumaskVar::try_clone(&mask).unwrap();

if let Some(cpu) = cpu2 {
    assert!(mask2.test(cpu));
}

if let Some(cpu) = cpu3 {
    assert!(mask2.test(cpu));
}
assert_eq!(mask2.weight(), count);

Implementations

impl CpumaskVar

pub fn new_zero(_flags: Flags) -> Result<Self, AllocError>

Creates a zero-initialized instance of the CpumaskVar.

pub unsafe fn new(_flags: Flags) -> Result<Self, AllocError>

Creates an instance of the CpumaskVar.

Safety

The caller must ensure that the returned CpumaskVar is properly initialized before getting used.

pub unsafe fn as_mut_ref<'a>(ptr: *mut cpumask_var_t) -> &'a mut Self

Creates a mutable reference to an existing struct cpumask_var_t pointer.

Safety

The caller must ensure that ptr is valid for writing and remains valid for the lifetime of the returned reference.

pub unsafe fn as_ref<'a>(ptr: *const cpumask_var_t) -> &'a Self

Creates a reference to an existing struct cpumask_var_t pointer.

Safety

The caller must ensure that ptr is valid for reading and remains valid for the lifetime of the returned reference.

pub fn try_clone(cpumask: &Cpumask) -> Result<Self>

Clones cpumask.

Methods from Deref<Target = Cpumask>

pub fn as_raw(&self) -> *mut cpumask

Obtain the raw struct cpumask pointer.

pub fn set(&mut self, cpu: CpuId)

Set cpu in the cpumask.

ATTENTION: Contrary to C, this Rust set() method is non-atomic. This mismatches kernel naming convention and corresponds to the C function __cpumask_set_cpu().

pub fn clear(&mut self, cpu: CpuId)

Clear cpu in the cpumask.

ATTENTION: Contrary to C, this Rust clear() method is non-atomic. This mismatches kernel naming convention and corresponds to the C function __cpumask_clear_cpu().

pub fn test(&self, cpu: CpuId) -> bool

Test cpu in the cpumask.

Equivalent to the kernel’s cpumask_test_cpu API.

pub fn setall(&mut self)

Set all CPUs in the cpumask.

Equivalent to the kernel’s cpumask_setall API.

pub fn empty(&self) -> bool

Checks if cpumask is empty.

Equivalent to the kernel’s cpumask_empty API.

pub fn full(&self) -> bool

Checks if cpumask is full.

Equivalent to the kernel’s cpumask_full API.

pub fn weight(&self) -> u32

Get weight of the cpumask.

Equivalent to the kernel’s cpumask_weight API.

pub fn copy(&self, dstp: &mut Self)

Copy cpumask.

Equivalent to the kernel’s cpumask_copy API.

Trait Implementations

impl Deref for CpumaskVar

type Target = Cpumask

The resulting type after dereferencing.

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

Dereferences the value.

impl DerefMut for CpumaskVar

fn deref_mut(&mut self) -> &mut Cpumask

Mutably dereferences the value.

impl Drop for CpumaskVar

fn drop(&mut self)

Executes the destructor for this type.