Struct CpuLocal

pub struct CpuLocal<T, S: AnyStorage<T>> {
    storage: S,
    phantom: PhantomData<T>,
}

A CPU-local variable for type T, backed by a storage of type S.

CPU-local objects are instantiated once per CPU core. They can be shared to other cores. In the context of a preemptible kernel task, when holding the reference to the inner object, the object is always the one in the original core (when the reference is created), no matter which core the code is currently running on.

Fields

storage: S

phantom: PhantomData<T>

Implementations

impl<T> CpuLocal<T, DynamicStorage<T>>

unsafe fn __new_dynamic( ptr: *mut T, init_values: &mut impl FnMut(CpuId) -> T, ) -> Self

Creates a new dynamically-allocated CPU-local object, and initializes it with init_values.

The given ptr points to the variable located on the BSP.

Please do not call this function directly. Instead, use DynCpuLocalChunk::alloc.

• The return value should be validly derived from an existing DynCpuLocalChunk.

• The return value should be valid by not overlapping with any existing CPU-local object.

impl<T: 'static> CpuLocal<T, StaticStorage<T>>

pub(crate) fn as_ptr(&self) -> *const T

Gets access to the underlying value through a raw pointer.

This method is safe, but using the returned pointer will be unsafe.

impl<T: 'static, S: AnyStorage<T>> CpuLocal<T, S>

pub fn get_with<'a>( &'a self, guard: &'a DisabledLocalIrqGuard, ) -> CpuLocalDerefGuard<'a, T, S>

Gets access to the underlying value on the current CPU with a provided IRQ guard.

By this method, you can borrow a reference to the underlying value on the current CPU even if T is not Sync.

impl<T: 'static + Sync, S: AnyStorage<T>> CpuLocal<T, S>

pub fn get_on_cpu(&self, target_cpu_id: CpuId) -> &T

Gets access to the CPU-local value on a specific CPU.

This allows the caller to access CPU-local data from a remote CPU, so the data type must be Sync.

Trait Implementations

impl<T: Sync + Debug + 'static> Debug for CpuLocal<T, DynamicStorage<T>>

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

Formats the value using the given formatter.

impl<T: 'static, S: AnyStorage<T>> !Clone for CpuLocal<T, S>

impl<T: 'static, S: AnyStorage<T>> !Copy for CpuLocal<T, S>

impl<T: Send + 'static> Send for CpuLocal<T, DynamicStorage<T>>

impl<T: 'static> !Send for CpuLocal<T, StaticStorage<T>>

impl<T: Send + 'static, S: AnyStorage<T>> Sync for CpuLocal<T, S>