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.
39 * Identify a shared load. A smp_rmc() or smp_mc() should come before the load.
41 #define _LOAD_SHARED(p) ACCESS_ONCE(p)
44 * Load a data from shared memory, doing a cache flush if required.
46 #define LOAD_SHARED(p) \
53 * Identify a shared store. A smp_wmc() or smp_mc() should follow the store.
55 #define _STORE_SHARED(x, v) ({ ACCESS_ONCE(x) = (v); })
58 * Store v into x, where x is located in shared memory. Performs the required
59 * cache flush after writing. Returns v.
61 #define STORE_SHARED(x, v) \
63 _STORE_SHARED(x, v); \
69 * _rcu_dereference - reads (copy) a RCU-protected pointer to a local variable
70 * into a RCU read-side critical section. The pointer can later be safely
71 * dereferenced within the critical section.
73 * This ensures that the pointer copy is invariant thorough the whole critical
76 * Inserts memory barriers on architectures that require them (currently only
77 * Alpha) and documents which pointers are protected by RCU.
79 * Should match rcu_assign_pointer() or rcu_xchg_pointer().
82 #define _rcu_dereference(p) ({ \
83 typeof(p) _________p1 = LOAD_SHARED(p); \
84 smp_read_barrier_depends(); \
89 * This code section can only be included in LGPL 2.1 compatible source code.
90 * See below for the function call wrappers which can be used in code meant to
91 * be only linked with the Userspace RCU library. This comes with a small
92 * performance degradation on the read-side due to the added function calls.
93 * This is required to permit relinking with newer versions of the library.
97 * The signal number used by the RCU library can be overridden with
98 * -DSIGURCU= when compiling the library.
101 #define SIGURCU SIGUSR1
105 * If a reader is really non-cooperative and refuses to commit its
106 * rcu_reader_qs_gp count to memory (there is no barrier in the reader
107 * per-se), kick it after a few loops waiting for it.
109 #define KICK_READER_LOOPS 10000
117 #define YIELD_READ (1 << 0)
118 #define YIELD_WRITE (1 << 1)
120 /* maximum sleep delay, in us */
123 extern unsigned int yield_active
;
124 extern unsigned int __thread rand_yield
;
126 static inline void debug_yield_read(void)
128 if (yield_active
& YIELD_READ
)
129 if (rand_r(&rand_yield
) & 0x1)
130 usleep(rand_r(&rand_yield
) % MAX_SLEEP
);
133 static inline void debug_yield_write(void)
135 if (yield_active
& YIELD_WRITE
)
136 if (rand_r(&rand_yield
) & 0x1)
137 usleep(rand_r(&rand_yield
) % MAX_SLEEP
);
140 static inline void debug_yield_init(void)
142 rand_yield
= time(NULL
) ^ pthread_self();
145 static inline void debug_yield_read(void)
149 static inline void debug_yield_write(void)
153 static inline void debug_yield_init(void)
159 static inline void reader_barrier()
165 * Global quiescent period counter with low-order bits unused.
166 * Using a int rather than a char to eliminate false register dependencies
167 * causing stalls on some architectures.
169 extern long urcu_gp_ctr
;
171 extern long __thread rcu_reader_qs_gp
;
173 static inline int rcu_gp_ongoing(long *value
)
178 return LOAD_SHARED(*value
) & 1;
181 static inline void _rcu_read_lock(void)
185 static inline void _rcu_read_unlock(void)
189 static inline void _rcu_quiescent_state(void)
192 rcu_reader_qs_gp
= ACCESS_ONCE(urcu_gp_ctr
) + 1;
196 static inline void _rcu_thread_offline(void)
199 rcu_reader_qs_gp
= ACCESS_ONCE(urcu_gp_ctr
);
202 static inline void _rcu_thread_online(void)
204 rcu_reader_qs_gp
= ACCESS_ONCE(urcu_gp_ctr
) + 1;
209 * _rcu_assign_pointer - assign (publicize) a pointer to a new data structure
210 * meant to be read by RCU read-side critical sections. Returns the assigned
213 * Documents which pointers will be dereferenced by RCU read-side critical
214 * sections and adds the required memory barriers on architectures requiring
215 * them. It also makes sure the compiler does not reorder code initializing the
216 * data structure before its publication.
218 * Should match rcu_dereference_pointer().
221 #define _rcu_assign_pointer(p, v) \
223 if (!__builtin_constant_p(v) || \
226 STORE_SHARED(p, v); \
230 * _rcu_xchg_pointer - same as rcu_assign_pointer, but returns the previous
231 * pointer to the data structure, which can be safely freed after waiting for a
232 * quiescent state using synchronize_rcu().
235 #define _rcu_xchg_pointer(p, v) \
237 if (!__builtin_constant_p(v) || \
244 * Exchanges the pointer and waits for quiescent state.
245 * The pointer returned can be freed.
247 #define _rcu_publish_content(p, v) \
250 oldptr = _rcu_xchg_pointer(p, v); \
255 extern void synchronize_rcu(void);
258 * Reader thread registration.
260 extern void rcu_register_thread(void);
261 extern void rcu_unregister_thread(void);
263 #endif /* _URCU_QSBR_H */