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
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
use super::Atomic;
use std::sync::atomic::Ordering;
#[rustfmt::skip] // rustfmt cannot properly format multi-line concat!.
macro_rules! atomic_int {
($name: ident, $int_type: ty) => {
#[doc = concat!(
" Mock implementation of `std::sync::atomic::", stringify!($name), "`.\n\n\
NOTE: Unlike `std::sync::atomic::", stringify!($name), "`, \
this type has a different in-memory representation than `",
stringify!($int_type), "`.",
)]
#[derive(Debug)]
pub struct $name(Atomic<$int_type>);
impl $name {
#[doc = concat!(" Creates a new instance of `", stringify!($name), "`.")]
#[track_caller]
pub fn new(v: $int_type) -> Self {
Self(Atomic::new(v, location!()))
}
/// Get access to a mutable reference to the inner value.
#[track_caller]
pub fn with_mut<R>(&mut self, f: impl FnOnce(&mut $int_type) -> R) -> R {
self.0.with_mut(f)
}
/// Load the value without any synchronization.
///
/// # Safety
///
/// An unsynchronized atomic load technically always has undefined behavior.
/// However, if the atomic value is not currently visible by other threads,
/// this *should* always be equivalent to a non-atomic load of an un-shared
/// integer value.
#[track_caller]
pub unsafe fn unsync_load(&self) -> $int_type {
self.0.unsync_load()
}
/// Consumes the atomic and returns the contained value.
#[track_caller]
pub fn into_inner(self) -> $int_type {
// SAFETY: ownership guarantees that no other threads are concurrently
// accessing the atomic value.
unsafe { self.unsync_load() }
}
/// Loads a value from the atomic integer.
#[track_caller]
pub fn load(&self, order: Ordering) -> $int_type {
self.0.load(order)
}
/// Stores a value into the atomic integer.
#[track_caller]
pub fn store(&self, val: $int_type, order: Ordering) {
self.0.store(val, order)
}
/// Stores a value into the atomic integer, returning the previous value.
#[track_caller]
pub fn swap(&self, val: $int_type, order: Ordering) -> $int_type {
self.0.swap(val, order)
}
/// Stores a value into the atomic integer if the current value is the same as the `current` value.
#[track_caller]
pub fn compare_and_swap(
&self,
current: $int_type,
new: $int_type,
order: Ordering,
) -> $int_type {
self.0.compare_and_swap(current, new, order)
}
/// Stores a value into the atomic if the current value is the same as the `current` value.
#[track_caller]
pub fn compare_exchange(
&self,
current: $int_type,
new: $int_type,
success: Ordering,
failure: Ordering,
) -> Result<$int_type, $int_type> {
self.0.compare_exchange(current, new, success, failure)
}
/// Stores a value into the atomic if the current value is the same as the current value.
#[track_caller]
pub fn compare_exchange_weak(
&self,
current: $int_type,
new: $int_type,
success: Ordering,
failure: Ordering,
) -> Result<$int_type, $int_type> {
self.compare_exchange(current, new, success, failure)
}
/// Adds to the current value, returning the previous value.
#[track_caller]
pub fn fetch_add(&self, val: $int_type, order: Ordering) -> $int_type {
self.0.rmw(|v| v.wrapping_add(val), order)
}
/// Subtracts from the current value, returning the previous value.
#[track_caller]
pub fn fetch_sub(&self, val: $int_type, order: Ordering) -> $int_type {
self.0.rmw(|v| v.wrapping_sub(val), order)
}
/// Bitwise "and" with the current value.
#[track_caller]
pub fn fetch_and(&self, val: $int_type, order: Ordering) -> $int_type {
self.0.rmw(|v| v & val, order)
}
/// Bitwise "nand" with the current value.
#[track_caller]
pub fn fetch_nand(&self, val: $int_type, order: Ordering) -> $int_type {
self.0.rmw(|v| !(v & val), order)
}
/// Bitwise "or" with the current value.
#[track_caller]
pub fn fetch_or(&self, val: $int_type, order: Ordering) -> $int_type {
self.0.rmw(|v| v | val, order)
}
/// Bitwise "xor" with the current value.
#[track_caller]
pub fn fetch_xor(&self, val: $int_type, order: Ordering) -> $int_type {
self.0.rmw(|v| v ^ val, order)
}
/// Stores the maximum of the current and provided value, returning the previous value
#[track_caller]
pub fn fetch_max(&self, val: $int_type, order: Ordering) -> $int_type {
self.0.rmw(|v| v.max(val), order)
}
/// Stores the minimum of the current and provided value, returning the previous value
#[track_caller]
pub fn fetch_min(&self, val: $int_type, order: Ordering) -> $int_type {
self.0.rmw(|v| v.min(val), order)
}
/// Fetches the value, and applies a function to it that returns an optional new value.
/// Returns a [`Result`] of [`Ok`]`(previous_value)` if the function returned
/// [`Some`]`(_)`, else [`Err`]`(previous_value)`.
#[track_caller]
pub fn fetch_update<F>(
&self,
set_order: Ordering,
fetch_order: Ordering,
f: F,
) -> Result<$int_type, $int_type>
where
F: FnMut($int_type) -> Option<$int_type>,
{
self.0.fetch_update(set_order, fetch_order, f)
}
}
impl Default for $name {
fn default() -> Self {
Self::new(Default::default())
}
}
impl From<$int_type> for $name {
fn from(v: $int_type) -> Self {
Self::new(v)
}
}
};
}
atomic_int!(AtomicU8, u8);
atomic_int!(AtomicU16, u16);
atomic_int!(AtomicU32, u32);
atomic_int!(AtomicUsize, usize);
atomic_int!(AtomicI8, i8);
atomic_int!(AtomicI16, i16);
atomic_int!(AtomicI32, i32);
atomic_int!(AtomicIsize, isize);
#[cfg(target_pointer_width = "64")]
atomic_int!(AtomicU64, u64);
#[cfg(target_pointer_width = "64")]
atomic_int!(AtomicI64, i64);