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
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
#![forbid(unsafe_code)]
extern crate proc_macro;
use proc_macro::TokenStream;
use proc_macro2::TokenStream as TokenStream2;
use quote::{quote, quote_spanned};
use syn::{parse_macro_input, spanned::Spanned, Attribute, Ident, ItemEnum, Variant, Visibility};
fn enum_definition<'a>(
attrs: impl IntoIterator<Item = Attribute>,
vis: &Visibility,
ident: &Ident,
variants: impl IntoIterator<Item = &'a Variant>,
) -> TokenStream2 {
quote! {
#(#attrs)*
#[derive(Debug, Clone, Copy)]
#vis enum #ident {
#(#variants),*
}
}
}
fn atomic_enum_definition(vis: &Visibility, ident: &Ident, atomic_ident: &Ident) -> TokenStream2 {
let atomic_ident_docs = format!(
"A wrapper around [`{0}`] which can be safely shared between threads.
This type uses an `AtomicUsize` to store the enum value.
[`{0}`]: enum.{0}.html",
ident
);
quote! {
#[doc = #atomic_ident_docs]
#vis struct #atomic_ident(std::sync::atomic::AtomicUsize);
}
}
fn enum_to_usize(ident: &Ident) -> TokenStream2 {
quote! {
const fn to_usize(val: #ident) -> usize {
val as usize
}
}
}
fn enum_from_usize(ident: &Ident, variants: impl IntoIterator<Item = Variant>) -> TokenStream2 {
let variants_with_const_names: Vec<_> = variants
.into_iter()
.map(|v| v.ident)
.map(|id| {
let c_id = Ident::new(&format!("USIZE_{}", &id), id.span());
(id, c_id)
})
.collect();
let variant_consts = variants_with_const_names
.iter()
.map(|(id, c_id)| quote! { const #c_id: usize = #ident::#id as usize; });
let variants_back = variants_with_const_names
.iter()
.map(|(id, c_id)| quote! { #c_id => #ident::#id, });
quote! {
fn from_usize(val: usize) -> #ident {
#![allow(non_upper_case_globals)]
#(#variant_consts)*
match val {
#(#variants_back)*
_ => panic!("Invalid enum discriminant"),
}
}
}
}
fn atomic_enum_new(ident: &Ident, atomic_ident: &Ident) -> TokenStream2 {
let atomic_ident_docs = format!(
"Creates a new atomic [`{0}`].
[`{0}`]: enum.{0}.html",
ident
);
quote! {
#[doc = #atomic_ident_docs]
pub const fn new(v: #ident) -> #atomic_ident {
#atomic_ident(std::sync::atomic::AtomicUsize::new(Self::to_usize(v)))
}
}
}
fn atomic_enum_into_inner(ident: &Ident) -> TokenStream2 {
quote! {
pub fn into_inner(self) -> #ident {
Self::from_usize(self.0.into_inner())
}
}
}
fn atomic_enum_set(ident: &Ident) -> TokenStream2 {
quote! {
pub fn set(&mut self, v: #ident) {
*self.0.get_mut() = Self::to_usize(v);
}
}
}
fn atomic_enum_get(ident: &Ident) -> TokenStream2 {
quote! {
pub fn get(&mut self) -> #ident {
Self::from_usize(*self.0.get_mut())
}
}
}
fn atomic_enum_swap_mut(ident: &Ident) -> TokenStream2 {
quote! {
pub fn swap_mut(&mut self, v: #ident) -> #ident {
let r = self.get();
self.set(v);
r
}
}
}
fn atomic_enum_load(ident: &Ident) -> TokenStream2 {
quote! {
pub fn load(&self, order: std::sync::atomic::Ordering) -> #ident {
Self::from_usize(self.0.load(order))
}
}
}
fn atomic_enum_store(ident: &Ident) -> TokenStream2 {
quote! {
pub fn store(&self, val: #ident, order: std::sync::atomic::Ordering) {
self.0.store(Self::to_usize(val), order)
}
}
}
fn atomic_enum_swap(ident: &Ident) -> TokenStream2 {
quote! {
pub fn swap(&self, val: #ident, order: std::sync::atomic::Ordering) -> #ident {
Self::from_usize(self.0.swap(Self::to_usize(val), order))
}
}
}
fn atomic_enum_compare_and_swap(ident: &Ident) -> TokenStream2 {
quote! {
pub fn compare_and_swap(
&self,
current: #ident,
new: #ident,
order: std::sync::atomic::Ordering
) -> #ident {
Self::from_usize(self.0.compare_and_swap(
Self::to_usize(current),
Self::to_usize(new),
order
))
}
}
}
fn atomic_enum_compare_exchange(ident: &Ident) -> TokenStream2 {
quote! {
pub fn compare_exchange(
&self,
current: #ident,
new: #ident,
success: std::sync::atomic::Ordering,
failure: std::sync::atomic::Ordering
) -> Result<#ident, #ident> {
self.0
.compare_exchange(
Self::to_usize(current),
Self::to_usize(new),
success,
failure
)
.map(Self::from_usize)
.map_err(Self::from_usize)
}
}
}
fn atomic_enum_compare_exchange_weak(ident: &Ident) -> TokenStream2 {
quote! {
pub fn compare_exchange_weak(
&self,
current: #ident,
new: #ident,
success: std::sync::atomic::Ordering,
failure: std::sync::atomic::Ordering
) -> Result<#ident, #ident> {
self.0
.compare_exchange_weak(
Self::to_usize(current),
Self::to_usize(new),
success,
failure
)
.map(Self::from_usize)
.map_err(Self::from_usize)
}
}
}
fn from_impl(ident: &Ident, atomic_ident: &Ident) -> TokenStream2 {
quote! {
impl From<#ident> for #atomic_ident {
fn from(val: #ident) -> #atomic_ident {
#atomic_ident::new(val)
}
}
}
}
fn debug_impl(atomic_ident: &Ident) -> TokenStream2 {
quote! {
impl std::fmt::Debug for #atomic_ident {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
self.load(std::sync::atomic::Ordering::SeqCst).fmt(f)
}
}
}
}
#[proc_macro_attribute]
pub fn atomic_enum(args: TokenStream, input: TokenStream) -> TokenStream {
let ItemEnum {
attrs,
vis,
enum_token: _,
ident,
generics,
brace_token: _,
variants,
} = parse_macro_input!(input as ItemEnum);
if !generics.params.is_empty() {
let span = generics.span();
let err = quote_spanned! {span=> compile_error!("Expected an enum without generics."); };
return err.into();
}
for variant in variants.iter() {
match variant.fields {
syn::Fields::Unit => (),
_ => {
let span = variant.fields.span();
let err = quote_spanned! {span=> compile_error!("Expected a variant without fields."); };
return err.into();
}
}
}
let mut output = enum_definition(attrs, &vis, &ident, &variants);
let atomic_ident = parse_macro_input!(args as Option<Ident>)
.unwrap_or_else(|| Ident::new(&format!("Atomic{}", ident), ident.span()));
output.extend(atomic_enum_definition(&vis, &ident, &atomic_ident));
let enum_to_usize = enum_to_usize(&ident);
let enum_from_usize = enum_from_usize(&ident, variants);
let atomic_enum_new = atomic_enum_new(&ident, &atomic_ident);
let atomic_enum_into_inner = atomic_enum_into_inner(&ident);
let atomic_enum_set = atomic_enum_set(&ident);
let atomic_enum_get = atomic_enum_get(&ident);
let atomic_enum_swap_mut = atomic_enum_swap_mut(&ident);
let atomic_enum_load = atomic_enum_load(&ident);
let atomic_enum_store = atomic_enum_store(&ident);
let atomic_enum_swap = atomic_enum_swap(&ident);
let atomic_enum_compare_and_swap = atomic_enum_compare_and_swap(&ident);
let atomic_enum_compare_exchange = atomic_enum_compare_exchange(&ident);
let atomic_enum_compare_exchange_weak = atomic_enum_compare_exchange_weak(&ident);
output.extend(quote! {
impl #atomic_ident {
#enum_to_usize
#enum_from_usize
#atomic_enum_new
#atomic_enum_into_inner
#atomic_enum_set
#atomic_enum_get
#atomic_enum_swap_mut
#atomic_enum_load
#atomic_enum_store
#atomic_enum_swap
#atomic_enum_compare_and_swap
#atomic_enum_compare_exchange
#atomic_enum_compare_exchange_weak
}
});
output.extend(from_impl(&ident, &atomic_ident));
output.extend(debug_impl(&atomic_ident));
output.into()
}