Skip to main content

CachePadded

Struct CachePadded 

Source
pub struct CachePadded<T>(/* private fields */);
Expand description

Wraps a value so it occupies a whole cache line, preventing the neighboring fields in a struct from being invalidated when the wrapped atomic is written by another core.

CachePadded<T> has the same size as T rounded up to the target’s cache-line size; for an AtomicUsize on x86_64 / AArch64 that means the wrapped value occupies 128 bytes total. Deref / DerefMut hide the padding from call sites so existing code reading padded.load(...) stays unchanged.

§Example

use forge_alloc_core::CachePadded;
use core::sync::atomic::{AtomicUsize, Ordering};

struct Stats {
    hits: CachePadded<AtomicUsize>,
    misses: CachePadded<AtomicUsize>,
}

let s = Stats {
    hits: CachePadded::new(AtomicUsize::new(0)),
    misses: CachePadded::new(AtomicUsize::new(0)),
};
s.hits.fetch_add(1, Ordering::Relaxed);

Implementations§

Source§

impl<T> CachePadded<T>

Source

pub const fn new(v: T) -> CachePadded<T>

Wrap a value with cache-line alignment padding.

Source

pub fn into_inner(self) -> T

Unwrap, returning the inner value.

Trait Implementations§

Source§

impl<T> Debug for CachePadded<T>
where T: Debug,

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<T> Default for CachePadded<T>
where T: Default,

Source§

fn default() -> CachePadded<T>

Returns the “default value” for a type. Read more
Source§

impl<T> Deref for CachePadded<T>

Source§

type Target = T

The resulting type after dereferencing.
Source§

fn deref(&self) -> &T

Dereferences the value.
Source§

impl<T> DerefMut for CachePadded<T>

Source§

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

Mutably dereferences the value.

Auto Trait Implementations§

§

impl<T> Freeze for CachePadded<T>
where T: Freeze,

§

impl<T> RefUnwindSafe for CachePadded<T>
where T: RefUnwindSafe,

§

impl<T> Send for CachePadded<T>
where T: Send,

§

impl<T> Sync for CachePadded<T>
where T: Sync,

§

impl<T> Unpin for CachePadded<T>
where T: Unpin,

§

impl<T> UnsafeUnpin for CachePadded<T>
where T: UnsafeUnpin,

§

impl<T> UnwindSafe for CachePadded<T>
where T: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

Source§

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)
The target type on which the method may be called.
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.