Struct crossbeam_utils::CachePadded

[+] Show declaration

pub struct CachePadded<T> { /* fields omitted */ }

[−] Expand description

Pads and aligns a value to the length of a cache line.

In concurrent programming, sometimes it is desirable to make sure commonly accessed pieces of data are not placed into the same cache line. Updating an atomic value invalides the whole cache line it belongs to, which makes the next access to the same cache line slower for other CPU cores. Use CachePadded to ensure updating one piece of data doesn't invalidate other cached data.

Cache lines are assumed to be 64 bytes on all architectures.

Size and alignment

The size of CachePadded<T> is the smallest multiple of 64 bytes large enough to accommodate a value of type T.

The alignment of CachePadded<T> is the maximum of 64 bytes and the alignment of T.

Examples

Alignment and padding:

use crossbeam_utils::CachePadded;

let array = [CachePadded::new(1i32), CachePadded::new(2i32)];
let addr1 = &*array[0] as *const i32 as usize;
let addr2 = &*array[1] as *const i32 as usize;

assert_eq!(addr2 - addr1, 64);
assert_eq!(addr1 % 64, 0);
assert_eq!(addr2 % 64, 0);

When building a concurrent queue with a head and a tail index, it is wise to place them in different cache lines so that concurrent threads pushing and popping elements don't invalidate each other's cache lines:

use crossbeam_utils::CachePadded;
use std::sync::atomic::AtomicUsize;

struct Queue<T> {
    head: CachePadded<AtomicUsize>,
    tail: CachePadded<AtomicUsize>,
    buffer: *mut T,
}

Methods

impl<T> CachePadded<T>[−]

pub fn new(t: T) -> CachePadded<T>[+]

Pads and aligns a value to the length of a cache line.

Examples

use crossbeam_utils::CachePadded;

let padded_value = CachePadded::new(1);

pub fn into_inner(self) -> T[+]

Returns the value value.

Examples

use crossbeam_utils::CachePadded;

let padded_value = CachePadded::new(7);
let value = padded_value.into_inner();
assert_eq!(value, 7);

Trait Implementations

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

impl<T: PartialEq> PartialEq<CachePadded<T>> for CachePadded<T>[+]

[+] Show hidden undocumented items

fn eq(&self, other: &CachePadded<T>) -> bool[+]

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &CachePadded<T>) -> bool[+]

This method tests for !=.

impl<T: Clone> Clone for CachePadded<T>[+]

[+] Show hidden undocumented items

fn clone(&self) -> CachePadded<T>[+]

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)[+]

Performs copy-assignment from source.

impl<T> From<T> for CachePadded<T>[+]

[+] Show hidden undocumented items

fn from(t: T) -> Self[+]

Performs the conversion.

impl<T: Eq> Eq for CachePadded<T>

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

impl<T: Copy> Copy for CachePadded<T>

impl<T: Default> Default for CachePadded<T>[+]

[+] Show hidden undocumented items

fn default() -> CachePadded<T>[+]

Returns the "default value" for a type.

impl<T> DerefMut for CachePadded<T>[+]

[+] Show hidden undocumented items

Important traits for &'_ mut R

impl<'_, R> Read for &'_ mut R where
    R: Read + ?Sized, impl<'_, W> Write for &'_ mut W where
    W: Write + ?Sized, impl<'_, I> Iterator for &'_ mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;impl<'_, F> Future for &'_ mut F where
    F: Unpin + Future + ?Sized,  type Output = <F as Future>::Output;

fn deref_mut(&mut self) -> &mut T[+]

Mutably dereferences the value.

impl<T: Debug> Debug for CachePadded<T>[+]

[+] Show hidden undocumented items

fn fmt(&self, f: &mut Formatter) -> Result[+]

Formats the value using the given formatter.

impl<T: Hash> Hash for CachePadded<T>[+]

[+] Show hidden undocumented items

fn hash<__HT: Hasher>(&self, state: &mut __HT)[+]

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, [+]

Feeds a slice of this type into the given [Hasher].

impl<T> Deref for CachePadded<T>[+]

[+] Show hidden undocumented items

type Target = T

The resulting type after dereferencing.

Important traits for &'_ mut R

impl<'_, R> Read for &'_ mut R where
    R: Read + ?Sized, impl<'_, W> Write for &'_ mut W where
    W: Write + ?Sized, impl<'_, I> Iterator for &'_ mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;impl<'_, F> Future for &'_ mut F where
    F: Unpin + Future + ?Sized,  type Output = <F as Future>::Output;

fn deref(&self) -> &T[+]

Dereferences the value.