7 * Userspace RCU header.
9 * TO BE INCLUDED ONLY IN LGPL-COMPATIBLE CODE. See urcu.h for linking
10 * dynamically with the userspace rcu library.
12 * Copyright (c) 2009 Mathieu Desnoyers <mathieu.desnoyers@polymtl.ca>
13 * Copyright (c) 2009 Paul E. McKenney, IBM Corporation.
15 * This library is free software; you can redistribute it and/or
16 * modify it under the terms of the GNU Lesser General Public
17 * License as published by the Free Software Foundation; either
18 * version 2.1 of the License, or (at your option) any later version.
20 * This library is distributed in the hope that it will be useful,
21 * but WITHOUT ANY WARRANTY; without even the implied warranty of
22 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
23 * Lesser General Public License for more details.
25 * You should have received a copy of the GNU Lesser General Public
26 * License along with this library; if not, write to the Free Software
27 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
29 * IBM's contributions to this file may be relicensed under LGPLv2 or later.
37 #include <urcu/compiler.h>
38 #include <urcu/arch.h>
39 #include <urcu/system.h>
40 #include <urcu/uatomic_arch.h>
41 #include <urcu/list.h>
42 #include <urcu/urcu-futex.h>
49 * This code section can only be included in LGPL 2.1 compatible source code.
50 * See below for the function call wrappers which can be used in code meant to
51 * be only linked with the Userspace RCU library. This comes with a small
52 * performance degradation on the read-side due to the added function calls.
53 * This is required to permit relinking with newer versions of the library.
57 * The signal number used by the RCU library can be overridden with
58 * -DSIGRCU= when compiling the library.
61 #define SIGRCU SIGUSR1
65 * If a reader is really non-cooperative and refuses to commit its
66 * rcu_active_readers count to memory (there is no barrier in the reader
67 * per-se), kick it after a few loops waiting for it.
69 #define KICK_READER_LOOPS 10000
72 * Active attempts to check for reader Q.S. before calling futex().
74 #define RCU_QS_ACTIVE_ATTEMPTS 100
77 #define rcu_assert(args...) assert(args)
79 #define rcu_assert(args...)
88 #define YIELD_READ (1 << 0)
89 #define YIELD_WRITE (1 << 1)
92 * Updates without RCU_MB are much slower. Account this in
96 /* maximum sleep delay, in us */
99 #define MAX_SLEEP 30000
102 extern unsigned int yield_active
;
103 extern unsigned int __thread rand_yield
;
105 static inline void debug_yield_read(void)
107 if (yield_active
& YIELD_READ
)
108 if (rand_r(&rand_yield
) & 0x1)
109 usleep(rand_r(&rand_yield
) % MAX_SLEEP
);
112 static inline void debug_yield_write(void)
114 if (yield_active
& YIELD_WRITE
)
115 if (rand_r(&rand_yield
) & 0x1)
116 usleep(rand_r(&rand_yield
) % MAX_SLEEP
);
119 static inline void debug_yield_init(void)
121 rand_yield
= time(NULL
) ^ pthread_self();
124 static inline void debug_yield_read(void)
128 static inline void debug_yield_write(void)
132 static inline void debug_yield_init(void)
139 static inline void reader_barrier()
144 static inline void reader_barrier()
151 * The trick here is that RCU_GP_CTR_PHASE must be a multiple of 8 so we can use
152 * a full 8-bits, 16-bits or 32-bits bitmask for the lower order bits.
154 #define RCU_GP_COUNT (1UL << 0)
155 /* Use the amount of bits equal to half of the architecture long size */
156 #define RCU_GP_CTR_PHASE (1UL << (sizeof(long) << 2))
157 #define RCU_GP_CTR_NEST_MASK (RCU_GP_CTR_PHASE - 1)
160 * Global quiescent period counter with low-order bits unused.
161 * Using a int rather than a char to eliminate false register dependencies
162 * causing stalls on some architectures.
164 extern long rcu_gp_ctr
;
167 /* Data used by both reader and synchronize_rcu() */
170 /* Data used for registry */
171 struct list_head head
__attribute__((aligned(CACHE_LINE_SIZE
)));
175 extern struct rcu_reader __thread rcu_reader
;
180 * Wake-up waiting synchronize_rcu(). Called from many concurrent threads.
182 static inline void wake_up_gp(void)
184 if (unlikely(uatomic_read(&gp_futex
) == -1)) {
185 uatomic_set(&gp_futex
, 0);
186 futex_async(&gp_futex
, FUTEX_WAKE
, 1,
191 static inline int rcu_old_gp_ongoing(long *value
)
198 * Make sure both tests below are done on the same version of *value
199 * to insure consistency.
201 v
= LOAD_SHARED(*value
);
202 return (v
& RCU_GP_CTR_NEST_MASK
) &&
203 ((v
^ rcu_gp_ctr
) & RCU_GP_CTR_PHASE
);
206 static inline void _rcu_read_lock(void)
210 tmp
= rcu_reader
.ctr
;
213 * RCU_GP_COUNT | (~RCU_GP_CTR_PHASE or RCU_GP_CTR_PHASE)
215 if (likely(!(tmp
& RCU_GP_CTR_NEST_MASK
))) {
216 _STORE_SHARED(rcu_reader
.ctr
, _LOAD_SHARED(rcu_gp_ctr
));
218 * Set active readers count for outermost nesting level before
219 * accessing the pointer. See force_mb_all_threads().
223 _STORE_SHARED(rcu_reader
.ctr
, tmp
+ RCU_GP_COUNT
);
227 static inline void _rcu_read_unlock(void)
231 tmp
= rcu_reader
.ctr
;
233 * Finish using rcu before decrementing the pointer.
234 * See force_mb_all_threads().
236 if (likely((tmp
& RCU_GP_CTR_NEST_MASK
) == RCU_GP_COUNT
)) {
238 _STORE_SHARED(rcu_reader
.ctr
, rcu_reader
.ctr
- RCU_GP_COUNT
);
239 /* write rcu_reader.ctr before read futex */
243 _STORE_SHARED(rcu_reader
.ctr
, rcu_reader
.ctr
- RCU_GP_COUNT
);
251 #endif /* _URCU_STATIC_H */