1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
#![no_std]
extern crate alloc;
use alloc::sync::Arc;
use cache_padded::CachePadded;
use core::{
cell::UnsafeCell,
mem::{self, MaybeUninit},
sync::atomic::{AtomicUsize, Ordering},
};
pub struct RingBuffer<T, const N: usize> {
buffer: UnsafeCell<[MaybeUninit<T>; N]>,
idx_r: CachePadded<AtomicUsize>,
idx_w: CachePadded<AtomicUsize>,
}
unsafe impl<T, const N: usize> Send for RingBuffer<T, N> {}
unsafe impl<T, const N: usize> Sync for RingBuffer<T, N> {}
impl<T, const N: usize> RingBuffer<T, N> {
#[allow(clippy::new_ret_no_self)]
#[deprecated(since = "0.1.8", note = "please use `init()` instead.")]
pub fn new() -> (RingBufferWriter<T, N>, RingBufferReader<T, N>) {
Self::init()
}
pub fn init() -> (RingBufferWriter<T, N>, RingBufferReader<T, N>) {
assert!(
N.is_power_of_two(),
"RingBuffer requires the capacity to be a power of 2. {N} is not."
);
let rb = Arc::new(RingBuffer {
buffer: UnsafeCell::new(array_init::array_init(|_| MaybeUninit::uninit())),
idx_r: CachePadded::new(AtomicUsize::new(0)),
idx_w: CachePadded::new(AtomicUsize::new(0)),
});
(
RingBufferWriter {
inner: rb.clone(),
cached_idx_r: 0,
local_idx_w: 0,
},
RingBufferReader {
inner: rb,
local_idx_r: 0,
cached_idx_w: 0,
},
)
}
#[allow(clippy::mut_from_ref)]
#[inline]
unsafe fn get_mut(&self, idx: usize) -> &mut MaybeUninit<T> {
&mut (*self.buffer.get())[idx & (N - 1)]
}
}
impl<T, const N: usize> Drop for RingBuffer<T, N> {
fn drop(&mut self) {
let mut idx_r = self.idx_r.load(Ordering::Acquire);
let idx_w = self.idx_w.load(Ordering::Acquire);
while idx_r != idx_w {
let t =
unsafe { mem::replace(self.get_mut(idx_r), MaybeUninit::uninit()).assume_init() };
mem::drop(t);
idx_r = idx_r.wrapping_add(1);
}
}
}
pub struct RingBufferWriter<T, const N: usize> {
inner: Arc<RingBuffer<T, N>>,
cached_idx_r: usize,
local_idx_w: usize,
}
impl<T, const N: usize> RingBufferWriter<T, N> {
#[inline]
pub fn push(&mut self, t: T) -> Option<T> {
if self.local_idx_w.wrapping_sub(self.cached_idx_r) == N {
self.cached_idx_r = self.inner.idx_r.load(Ordering::Acquire);
if self.local_idx_w.wrapping_sub(self.cached_idx_r) == N {
return Some(t);
}
}
unsafe { mem::replace(self.inner.get_mut(self.local_idx_w), MaybeUninit::new(t)) };
self.local_idx_w = self.local_idx_w.wrapping_add(1);
self.inner.idx_w.store(self.local_idx_w, Ordering::Release);
None
}
}
pub struct RingBufferReader<T, const N: usize> {
inner: Arc<RingBuffer<T, N>>,
local_idx_r: usize,
cached_idx_w: usize,
}
impl<T, const N: usize> RingBufferReader<T, N> {
#[inline]
pub fn pull(&mut self) -> Option<T> {
if self.local_idx_r == self.cached_idx_w {
self.cached_idx_w = self.inner.idx_w.load(Ordering::Acquire);
if self.local_idx_r == self.cached_idx_w {
return None;
}
}
let t = unsafe {
mem::replace(self.inner.get_mut(self.local_idx_r), MaybeUninit::uninit()).assume_init()
};
self.local_idx_r = self.local_idx_r.wrapping_add(1);
self.inner.idx_r.store(self.local_idx_r, Ordering::Release);
Some(t)
}
}