1 #ifndef _URCU_QSBR_STATIC_H
2 #define _URCU_QSBR_STATIC_H
7 * Userspace RCU QSBR header.
9 * TO BE INCLUDED ONLY IN LGPL-COMPATIBLE CODE. See urcu-qsbr.h for linking
10 * dynamically with the userspace rcu QSBR 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.
39 #include <urcu/compiler.h>
40 #include <urcu/arch.h>
41 #include <urcu/list.h>
44 * Identify a shared load. A smp_rmc() or smp_mc() should come before the load.
46 #define _LOAD_SHARED(p) ACCESS_ONCE(p)
49 * Load a data from shared memory, doing a cache flush if required.
51 #define LOAD_SHARED(p) \
58 * Identify a shared store. A smp_wmc() or smp_mc() should follow the store.
60 #define _STORE_SHARED(x, v) ({ ACCESS_ONCE(x) = (v); })
63 * Store v into x, where x is located in shared memory. Performs the required
64 * cache flush after writing. Returns v.
66 #define STORE_SHARED(x, v) \
68 _STORE_SHARED(x, v); \
74 * _rcu_dereference - reads (copy) a RCU-protected pointer to a local variable
75 * into a RCU read-side critical section. The pointer can later be safely
76 * dereferenced within the critical section.
78 * This ensures that the pointer copy is invariant thorough the whole critical
81 * Inserts memory barriers on architectures that require them (currently only
82 * Alpha) and documents which pointers are protected by RCU.
84 * Should match rcu_assign_pointer() or rcu_xchg_pointer().
87 #define _rcu_dereference(p) ({ \
88 typeof(p) _________p1 = LOAD_SHARED(p); \
89 smp_read_barrier_depends(); \
93 #define futex(...) syscall(__NR_futex, __VA_ARGS__)
98 * This code section can only be included in LGPL 2.1 compatible source code.
99 * See below for the function call wrappers which can be used in code meant to
100 * be only linked with the Userspace RCU library. This comes with a small
101 * performance degradation on the read-side due to the added function calls.
102 * This is required to permit relinking with newer versions of the library.
106 * If a reader is really non-cooperative and refuses to commit its
107 * urcu_reader.ctr count to memory (there is no barrier in the reader
108 * per-se), kick it after a few loops waiting for it.
110 #define KICK_READER_LOOPS 10000
113 * Active attempts to check for reader Q.S. before calling futex().
115 #define RCU_QS_ACTIVE_ATTEMPTS 100
118 #define rcu_assert(args...) assert(args)
120 #define rcu_assert(args...)
129 #define YIELD_READ (1 << 0)
130 #define YIELD_WRITE (1 << 1)
132 /* maximum sleep delay, in us */
135 extern unsigned int yield_active
;
136 extern unsigned int __thread rand_yield
;
138 static inline void debug_yield_read(void)
140 if (yield_active
& YIELD_READ
)
141 if (rand_r(&rand_yield
) & 0x1)
142 usleep(rand_r(&rand_yield
) % MAX_SLEEP
);
145 static inline void debug_yield_write(void)
147 if (yield_active
& YIELD_WRITE
)
148 if (rand_r(&rand_yield
) & 0x1)
149 usleep(rand_r(&rand_yield
) % MAX_SLEEP
);
152 static inline void debug_yield_init(void)
154 rand_yield
= time(NULL
) ^ pthread_self();
157 static inline void debug_yield_read(void)
161 static inline void debug_yield_write(void)
165 static inline void debug_yield_init(void)
171 static inline void reader_barrier()
176 #define RCU_GP_ONLINE (1UL << 0)
177 #define RCU_GP_CTR (1UL << 1)
180 * Global quiescent period counter with low-order bits unused.
181 * Using a int rather than a char to eliminate false register dependencies
182 * causing stalls on some architectures.
184 extern unsigned long urcu_gp_ctr
;
187 /* Data used by both reader and synchronize_rcu() */
189 /* Data used for registry */
190 struct list_head head
__attribute__((aligned(CACHE_LINE_SIZE
)));
194 extern struct urcu_reader __thread urcu_reader
;
199 * Wake-up waiting synchronize_rcu(). Called from many concurrent threads.
201 static inline void wake_up_gp(void)
203 if (unlikely(uatomic_read(&gp_futex
) == -1)) {
204 uatomic_set(&gp_futex
, 0);
205 futex(&gp_futex
, FUTEX_WAKE
, 1,
210 #if (BITS_PER_LONG < 64)
211 static inline int rcu_gp_ongoing(unsigned long *value
)
213 unsigned long reader_gp
;
217 reader_gp
= LOAD_SHARED(*value
);
218 return reader_gp
&& ((reader_gp
^ urcu_gp_ctr
) & RCU_GP_CTR
);
220 #else /* !(BITS_PER_LONG < 64) */
221 static inline int rcu_gp_ongoing(unsigned long *value
)
223 unsigned long reader_gp
;
227 reader_gp
= LOAD_SHARED(*value
);
228 return reader_gp
&& (reader_gp
- urcu_gp_ctr
> ULONG_MAX
/ 2);
230 #endif /* !(BITS_PER_LONG < 64) */
232 static inline void _rcu_read_lock(void)
234 rcu_assert(urcu_reader
.ctr
);
237 static inline void _rcu_read_unlock(void)
241 static inline void _rcu_quiescent_state(void)
244 _STORE_SHARED(urcu_reader
.ctr
, _LOAD_SHARED(urcu_gp_ctr
));
245 smp_mb(); /* write urcu_reader.ctr before read futex */
250 static inline void _rcu_thread_offline(void)
253 STORE_SHARED(urcu_reader
.ctr
, 0);
254 smp_mb(); /* write urcu_reader.ctr before read futex */
258 static inline void _rcu_thread_online(void)
260 _STORE_SHARED(urcu_reader
.ctr
, LOAD_SHARED(urcu_gp_ctr
));
265 * _rcu_assign_pointer - assign (publicize) a pointer to a new data structure
266 * meant to be read by RCU read-side critical sections. Returns the assigned
269 * Documents which pointers will be dereferenced by RCU read-side critical
270 * sections and adds the required memory barriers on architectures requiring
271 * them. It also makes sure the compiler does not reorder code initializing the
272 * data structure before its publication.
274 * Should match rcu_dereference_pointer().
277 #define _rcu_assign_pointer(p, v) \
279 if (!__builtin_constant_p(v) || \
282 STORE_SHARED(p, v); \
286 * _rcu_cmpxchg_pointer - same as rcu_assign_pointer, but tests if the pointer
287 * is as expected by "old". If succeeds, returns the previous pointer to the
288 * data structure, which can be safely freed after waiting for a quiescent state
289 * using synchronize_rcu(). If fails (unexpected value), returns old (which
290 * should not be freed !).
293 #define _rcu_cmpxchg_pointer(p, old, _new) \
295 if (!__builtin_constant_p(_new) || \
298 uatomic_cmpxchg(p, old, _new); \
302 * _rcu_xchg_pointer - same as rcu_assign_pointer, but returns the previous
303 * pointer to the data structure, which can be safely freed after waiting for a
304 * quiescent state using synchronize_rcu().
307 #define _rcu_xchg_pointer(p, v) \
309 if (!__builtin_constant_p(v) || \
312 uatomic_xchg(p, v); \
316 * Exchanges the pointer and waits for quiescent state.
317 * The pointer returned can be freed.
319 #define _rcu_publish_content(p, v) \
322 oldptr = _rcu_xchg_pointer(p, v); \
327 #endif /* _URCU_QSBR_STATIC_H */