1// SPDX-License-Identifier: GPL-2.0+
2//
3// An earlier version of this file appeared in the companion webpage for
4// "Frightening small children and disconcerting grown-ups: Concurrency
5// in the Linux kernel" by Alglave, Maranget, McKenney, Parri, and Stern,
6// which appeared in ASPLOS 2018.
7
8// ONCE
9READ_ONCE(X) __load{once}(X)
10WRITE_ONCE(X,V) { __store{once}(X,V); }
11
12// Release Acquire and friends
13smp_store_release(X,V) { __store{release}(*X,V); }
14smp_load_acquire(X) __load{acquire}(*X)
15rcu_assign_pointer(X,V) { __store{release}(X,V); }
16rcu_dereference(X) __load{once}(X)
17smp_store_mb(X,V) { __store{once}(X,V); __fence{mb}; }
18
19// Fences
20smp_mb() { __fence{mb}; }
21smp_rmb() { __fence{rmb}; }
22smp_wmb() { __fence{wmb}; }
23smp_mb__before_atomic() { __fence{before-atomic}; }
24smp_mb__after_atomic() { __fence{after-atomic}; }
25smp_mb__after_spinlock() { __fence{after-spinlock}; }
26smp_mb__after_unlock_lock() { __fence{after-unlock-lock}; }
27
28// Exchange
29xchg(X,V)  __xchg{mb}(X,V)
30xchg_relaxed(X,V) __xchg{once}(X,V)
31xchg_release(X,V) __xchg{release}(X,V)
32xchg_acquire(X,V) __xchg{acquire}(X,V)
33cmpxchg(X,V,W) __cmpxchg{mb}(X,V,W)
34cmpxchg_relaxed(X,V,W) __cmpxchg{once}(X,V,W)
35cmpxchg_acquire(X,V,W) __cmpxchg{acquire}(X,V,W)
36cmpxchg_release(X,V,W) __cmpxchg{release}(X,V,W)
37
38// Spinlocks
39spin_lock(X) { __lock(X); }
40spin_unlock(X) { __unlock(X); }
41spin_trylock(X) __trylock(X)
42spin_is_locked(X) __islocked(X)
43
44// RCU
45rcu_read_lock() { __fence{rcu-lock}; }
46rcu_read_unlock() { __fence{rcu-unlock}; }
47synchronize_rcu() { __fence{sync-rcu}; }
48synchronize_rcu_expedited() { __fence{sync-rcu}; }
49
50// Atomic
51atomic_read(X) READ_ONCE(*X)
52atomic_set(X,V) { WRITE_ONCE(*X,V); }
53atomic_read_acquire(X) smp_load_acquire(X)
54atomic_set_release(X,V) { smp_store_release(X,V); }
55
56atomic_add(V,X) { __atomic_op(X,+,V); }
57atomic_sub(V,X) { __atomic_op(X,-,V); }
58atomic_inc(X)   { __atomic_op(X,+,1); }
59atomic_dec(X)   { __atomic_op(X,-,1); }
60
61atomic_add_return(V,X) __atomic_op_return{mb}(X,+,V)
62atomic_add_return_relaxed(V,X) __atomic_op_return{once}(X,+,V)
63atomic_add_return_acquire(V,X) __atomic_op_return{acquire}(X,+,V)
64atomic_add_return_release(V,X) __atomic_op_return{release}(X,+,V)
65atomic_fetch_add(V,X) __atomic_fetch_op{mb}(X,+,V)
66atomic_fetch_add_relaxed(V,X) __atomic_fetch_op{once}(X,+,V)
67atomic_fetch_add_acquire(V,X) __atomic_fetch_op{acquire}(X,+,V)
68atomic_fetch_add_release(V,X) __atomic_fetch_op{release}(X,+,V)
69
70atomic_inc_return(X) __atomic_op_return{mb}(X,+,1)
71atomic_inc_return_relaxed(X) __atomic_op_return{once}(X,+,1)
72atomic_inc_return_acquire(X) __atomic_op_return{acquire}(X,+,1)
73atomic_inc_return_release(X) __atomic_op_return{release}(X,+,1)
74atomic_fetch_inc(X) __atomic_fetch_op{mb}(X,+,1)
75atomic_fetch_inc_relaxed(X) __atomic_fetch_op{once}(X,+,1)
76atomic_fetch_inc_acquire(X) __atomic_fetch_op{acquire}(X,+,1)
77atomic_fetch_inc_release(X) __atomic_fetch_op{release}(X,+,1)
78
79atomic_sub_return(V,X) __atomic_op_return{mb}(X,-,V)
80atomic_sub_return_relaxed(V,X) __atomic_op_return{once}(X,-,V)
81atomic_sub_return_acquire(V,X) __atomic_op_return{acquire}(X,-,V)
82atomic_sub_return_release(V,X) __atomic_op_return{release}(X,-,V)
83atomic_fetch_sub(V,X) __atomic_fetch_op{mb}(X,-,V)
84atomic_fetch_sub_relaxed(V,X) __atomic_fetch_op{once}(X,-,V)
85atomic_fetch_sub_acquire(V,X) __atomic_fetch_op{acquire}(X,-,V)
86atomic_fetch_sub_release(V,X) __atomic_fetch_op{release}(X,-,V)
87
88atomic_dec_return(X) __atomic_op_return{mb}(X,-,1)
89atomic_dec_return_relaxed(X) __atomic_op_return{once}(X,-,1)
90atomic_dec_return_acquire(X) __atomic_op_return{acquire}(X,-,1)
91atomic_dec_return_release(X) __atomic_op_return{release}(X,-,1)
92atomic_fetch_dec(X) __atomic_fetch_op{mb}(X,-,1)
93atomic_fetch_dec_relaxed(X) __atomic_fetch_op{once}(X,-,1)
94atomic_fetch_dec_acquire(X) __atomic_fetch_op{acquire}(X,-,1)
95atomic_fetch_dec_release(X) __atomic_fetch_op{release}(X,-,1)
96
97atomic_xchg(X,V) __xchg{mb}(X,V)
98atomic_xchg_relaxed(X,V) __xchg{once}(X,V)
99atomic_xchg_release(X,V) __xchg{release}(X,V)
100atomic_xchg_acquire(X,V) __xchg{acquire}(X,V)
101atomic_cmpxchg(X,V,W) __cmpxchg{mb}(X,V,W)
102atomic_cmpxchg_relaxed(X,V,W) __cmpxchg{once}(X,V,W)
103atomic_cmpxchg_acquire(X,V,W) __cmpxchg{acquire}(X,V,W)
104atomic_cmpxchg_release(X,V,W) __cmpxchg{release}(X,V,W)
105
106atomic_sub_and_test(V,X) __atomic_op_return{mb}(X,-,V) == 0
107atomic_dec_and_test(X)  __atomic_op_return{mb}(X,-,1) == 0
108atomic_inc_and_test(X)  __atomic_op_return{mb}(X,+,1) == 0
109atomic_add_negative(V,X) __atomic_op_return{mb}(X,+,V) < 0
110