Struct CpuId

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

The CPU ID.

Represents a CPU identifier as a wrapper around an u32.

Invariants

The CPU ID lies within the range [0, nr_cpu_ids()).

Examples

use kernel::cpu::CpuId;

let cpu = 0;

// SAFETY: 0 is always a valid CPU number.
let id = unsafe { CpuId::from_u32_unchecked(cpu) };

assert_eq!(id.as_u32(), cpu);
assert!(CpuId::from_i32(0).is_some());
assert!(CpuId::from_i32(-1).is_none());

Implementations

impl CpuId

pub unsafe fn from_i32_unchecked(id: i32) -> Self

Creates a new CpuId from the given id without checking bounds.

Safety

The caller must ensure that id is a valid CPU ID (i.e., 0 <= id < nr_cpu_ids()).

pub fn from_i32(id: i32) -> Option<Self>

Creates a new CpuId from the given id, checking that it is valid.

pub unsafe fn from_u32_unchecked(id: u32) -> Self

Creates a new CpuId from the given id without checking bounds.

Safety

The caller must ensure that id is a valid CPU ID (i.e., 0 <= id < nr_cpu_ids()).

pub fn from_u32(id: u32) -> Option<Self>

Creates a new CpuId from the given id, checking that it is valid.

pub fn as_u32(&self) -> u32

Returns CPU number.

pub fn current() -> Self

Returns the ID of the CPU the code is currently running on.

The returned value is considered unstable because it may change unexpectedly due to preemption or CPU migration. It should only be used when the context ensures that the task remains on the same CPU or the users could use a stale (yet valid) CPU ID.

Trait Implementations

impl Clone for CpuId

fn clone(&self) -> CpuId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CpuId

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

Formats the value using the given formatter.

impl From<CpuId> for i32

fn from(id: CpuId) -> Self

Converts to this type from the input type.

impl From<CpuId> for u32

fn from(id: CpuId) -> Self

Converts to this type from the input type.

impl PartialEq for CpuId

fn eq(&self, other: &CpuId) -> 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 Copy for CpuId

impl Eq for CpuId

impl StructuralPartialEq for CpuId