#cache #padding #lock-free #atomic

no-std cache-padded

Prevent false sharing by padding and aligning to the length of a cache line

4 stable releases

1.2.0 Dec 19, 2021
1.1.1 Jul 7, 2020
1.1.0 May 31, 2020
1.0.0 May 25, 2020

#31 in Concurrency

Download history 139582/week @ 2022-01-25 141584/week @ 2022-02-01 152849/week @ 2022-02-08 146826/week @ 2022-02-15 144111/week @ 2022-02-22 158440/week @ 2022-03-01 156258/week @ 2022-03-08 156282/week @ 2022-03-15 163012/week @ 2022-03-22 172179/week @ 2022-03-29 172297/week @ 2022-04-05 157878/week @ 2022-04-12 174601/week @ 2022-04-19 177007/week @ 2022-04-26 167775/week @ 2022-05-03 137900/week @ 2022-05-10

680,095 downloads per month
Used in 2,464 crates (11 directly)

Apache-2.0 OR MIT

10KB
67 lines

cache-padded

Build License Cargo Documentation

Prevent false sharing by padding and aligning to the length of a cache line.

In concurrent programming, sometimes it is desirable to make sure commonly accessed shared data is not all 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.

Size and alignment

Cache lines are assumed to be N bytes long, depending on the architecture:

  • On x86-64 and aarch64, N = 128.
  • On all others, N = 64.

Note that N is just a reasonable guess and is not guaranteed to match the actual cache line length of the machine the program is running on.

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

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

Examples

Alignment and padding:

use cache_padded::CachePadded;

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

assert!(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 indices in different cache lines so that concurrent threads pushing and popping elements don't invalidate each other's cache lines:

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

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

License

Licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

No runtime deps