Struct Cpumask

pub struct Cpumask(/* private fields */);

A CPU Mask.

Rust abstraction for the C struct cpumask.

Invariants

A Cpumask instance always corresponds to a valid C struct cpumask.

The callers must ensure that the struct cpumask is valid for access and remains valid for the lifetime of the returned reference.

Examples

The following example demonstrates how to update a Cpumask.

use kernel::bindings;
use kernel::cpu::CpuId;
use kernel::cpumask::Cpumask;

fn set_clear_cpu(ptr: *mut bindings::cpumask, set_cpu: CpuId, clear_cpu: CpuId) {
    // SAFETY: The `ptr` is valid for writing and remains valid for the lifetime of the
    // returned reference.
    let mask = unsafe { Cpumask::as_mut_ref(ptr) };

    mask.set(set_cpu);
    mask.clear(clear_cpu);
}

Implementations

impl Cpumask

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

Creates a mutable reference to an existing struct cpumask 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) -> &'a Self

Creates a reference to an existing struct cpumask pointer.

Safety

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

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.