blob: b973dea2d6b01a6ff8f23d408e8a9dd87b5ecaec [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
Paul E. McKenneya71fca52009-09-18 10:28:19 -07002 * Read-Copy Update mechanism for mutual exclusion
Linus Torvalds1da177e2005-04-16 15:20:36 -07003 *
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation; either version 2 of the License, or
7 * (at your option) any later version.
8 *
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
13 *
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
17 *
Paul E. McKenney01c1c662008-01-25 21:08:24 +010018 * Copyright IBM Corporation, 2001
Linus Torvalds1da177e2005-04-16 15:20:36 -070019 *
20 * Author: Dipankar Sarma <dipankar@in.ibm.com>
Paul E. McKenneya71fca52009-09-18 10:28:19 -070021 *
Josh Triplett595182b2006-10-04 02:17:21 -070022 * Based on the original work by Paul McKenney <paulmck@us.ibm.com>
Linus Torvalds1da177e2005-04-16 15:20:36 -070023 * and inputs from Rusty Russell, Andrea Arcangeli and Andi Kleen.
24 * Papers:
25 * http://www.rdrop.com/users/paulmck/paper/rclockpdcsproof.pdf
26 * http://lse.sourceforge.net/locking/rclock_OLS.2001.05.01c.sc.pdf (OLS2001)
27 *
28 * For detailed explanation of Read-Copy Update mechanism see -
Paul E. McKenneya71fca52009-09-18 10:28:19 -070029 * http://lse.sourceforge.net/locking/rcupdate.html
Linus Torvalds1da177e2005-04-16 15:20:36 -070030 *
31 */
32
33#ifndef __LINUX_RCUPDATE_H
34#define __LINUX_RCUPDATE_H
35
Linus Torvalds1da177e2005-04-16 15:20:36 -070036#include <linux/cache.h>
37#include <linux/spinlock.h>
38#include <linux/threads.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070039#include <linux/cpumask.h>
40#include <linux/seqlock.h>
Peter Zijlstra851a67b2007-10-11 22:11:12 +020041#include <linux/lockdep.h>
Paul E. McKenney4446a362008-05-12 21:21:05 +020042#include <linux/completion.h>
Mathieu Desnoyers551d55a2010-04-17 08:48:42 -040043#include <linux/debugobjects.h>
Paul E. McKenneyca5ecdd2010-04-28 14:39:09 -070044#include <linux/compiler.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070045
Dave Younge5ab6772010-03-10 15:24:05 -080046#ifdef CONFIG_RCU_TORTURE_TEST
47extern int rcutorture_runnable; /* for sysctl */
48#endif /* #ifdef CONFIG_RCU_TORTURE_TEST */
49
Linus Torvalds1da177e2005-04-16 15:20:36 -070050/**
51 * struct rcu_head - callback structure for use with RCU
52 * @next: next update requests in a list
53 * @func: actual update function to call after the grace period.
54 */
55struct rcu_head {
56 struct rcu_head *next;
57 void (*func)(struct rcu_head *head);
58};
59
Paul E. McKenney03b042b2009-06-25 09:08:16 -070060/* Exported common interfaces */
Paul E. McKenney03b042b2009-06-25 09:08:16 -070061extern void rcu_barrier(void);
62extern void rcu_barrier_bh(void);
63extern void rcu_barrier_sched(void);
64extern void synchronize_sched_expedited(void);
65extern int sched_expedited_torture_stats(char *page);
66
67/* Internal to kernel */
68extern void rcu_init(void);
Paul E. McKenneya6826042009-02-25 18:03:42 -080069
Paul E. McKenneyf41d9112009-08-22 13:56:52 -070070#if defined(CONFIG_TREE_RCU) || defined(CONFIG_TREE_PREEMPT_RCU)
Paul E. McKenney64db4cf2008-12-18 21:55:32 +010071#include <linux/rcutree.h>
Paul E. McKenney2c28e242009-10-26 13:57:44 -070072#elif defined(CONFIG_TINY_RCU)
Paul E. McKenney9b1d82f2009-10-25 19:03:50 -070073#include <linux/rcutiny.h>
Paul E. McKenney64db4cf2008-12-18 21:55:32 +010074#else
75#error "Unknown RCU implementation specified to kernel configuration"
Paul E. McKenney6b3ef482009-08-22 13:56:53 -070076#endif
Paul E. McKenney01c1c662008-01-25 21:08:24 +010077
Paul E. McKenney3d76c082009-09-28 07:46:32 -070078#define RCU_HEAD_INIT { .next = NULL, .func = NULL }
Dipankar Sarma8b6490e2005-09-09 13:04:07 -070079#define RCU_HEAD(head) struct rcu_head head = RCU_HEAD_INIT
Linus Torvalds1da177e2005-04-16 15:20:36 -070080#define INIT_RCU_HEAD(ptr) do { \
81 (ptr)->next = NULL; (ptr)->func = NULL; \
82} while (0)
83
Mathieu Desnoyers551d55a2010-04-17 08:48:42 -040084/*
85 * init_rcu_head_on_stack()/destroy_rcu_head_on_stack() are needed for dynamic
86 * initialization and destruction of rcu_head on the stack. rcu_head structures
87 * allocated dynamically in the heap or defined statically don't need any
88 * initialization.
89 */
90#ifdef CONFIG_DEBUG_OBJECTS_RCU_HEAD
91extern void init_rcu_head_on_stack(struct rcu_head *head);
92extern void destroy_rcu_head_on_stack(struct rcu_head *head);
93#else /* !CONFIG_DEBUG_OBJECTS_RCU_HEAD */
Mathieu Desnoyers43760302010-04-17 08:48:39 -040094static inline void init_rcu_head_on_stack(struct rcu_head *head)
95{
96}
97
98static inline void destroy_rcu_head_on_stack(struct rcu_head *head)
99{
100}
Mathieu Desnoyers551d55a2010-04-17 08:48:42 -0400101#endif /* #else !CONFIG_DEBUG_OBJECTS_RCU_HEAD */
Mathieu Desnoyers43760302010-04-17 08:48:39 -0400102
Paul E. McKenneybc33f242009-08-22 13:56:47 -0700103#ifdef CONFIG_DEBUG_LOCK_ALLOC
Paul E. McKenney632ee202010-02-22 17:04:45 -0800104
Paul E. McKenneybc33f242009-08-22 13:56:47 -0700105extern struct lockdep_map rcu_lock_map;
Paul E. McKenney632ee202010-02-22 17:04:45 -0800106# define rcu_read_acquire() \
107 lock_acquire(&rcu_lock_map, 0, 0, 2, 1, NULL, _THIS_IP_)
Paul E. McKenneybc33f242009-08-22 13:56:47 -0700108# define rcu_read_release() lock_release(&rcu_lock_map, 1, _THIS_IP_)
Paul E. McKenney632ee202010-02-22 17:04:45 -0800109
110extern struct lockdep_map rcu_bh_lock_map;
111# define rcu_read_acquire_bh() \
112 lock_acquire(&rcu_bh_lock_map, 0, 0, 2, 1, NULL, _THIS_IP_)
113# define rcu_read_release_bh() lock_release(&rcu_bh_lock_map, 1, _THIS_IP_)
114
115extern struct lockdep_map rcu_sched_lock_map;
116# define rcu_read_acquire_sched() \
117 lock_acquire(&rcu_sched_lock_map, 0, 0, 2, 1, NULL, _THIS_IP_)
118# define rcu_read_release_sched() \
119 lock_release(&rcu_sched_lock_map, 1, _THIS_IP_)
120
Paul E. McKenneybc293d62010-04-15 12:50:39 -0700121extern int debug_lockdep_rcu_enabled(void);
Paul E. McKenney54dbf962010-03-03 07:46:57 -0800122
Paul E. McKenney632ee202010-02-22 17:04:45 -0800123/**
Paul E. McKenneyca5ecdd2010-04-28 14:39:09 -0700124 * rcu_read_lock_held() - might we be in RCU read-side critical section?
Paul E. McKenney632ee202010-02-22 17:04:45 -0800125 *
Paul E. McKenneyd20200b2010-03-30 10:52:21 -0700126 * If CONFIG_DEBUG_LOCK_ALLOC is selected, returns nonzero iff in an RCU
127 * read-side critical section. In absence of CONFIG_DEBUG_LOCK_ALLOC,
Paul E. McKenney632ee202010-02-22 17:04:45 -0800128 * this assumes we are in an RCU read-side critical section unless it can
Paul E. McKenneyca5ecdd2010-04-28 14:39:09 -0700129 * prove otherwise. This is useful for debug checks in functions that
130 * require that they be called within an RCU read-side critical section.
Paul E. McKenney54dbf962010-03-03 07:46:57 -0800131 *
Paul E. McKenneyca5ecdd2010-04-28 14:39:09 -0700132 * Checks debug_lockdep_rcu_enabled() to prevent false positives during boot
Paul E. McKenney32c141a2010-03-30 10:59:28 -0700133 * and while lockdep is disabled.
Paul E. McKenney632ee202010-02-22 17:04:45 -0800134 */
135static inline int rcu_read_lock_held(void)
136{
Paul E. McKenney54dbf962010-03-03 07:46:57 -0800137 if (!debug_lockdep_rcu_enabled())
138 return 1;
139 return lock_is_held(&rcu_lock_map);
Paul E. McKenney632ee202010-02-22 17:04:45 -0800140}
141
Paul E. McKenneye3818b82010-03-15 17:03:43 -0700142/*
143 * rcu_read_lock_bh_held() is defined out of line to avoid #include-file
144 * hell.
Paul E. McKenney632ee202010-02-22 17:04:45 -0800145 */
Paul E. McKenneye3818b82010-03-15 17:03:43 -0700146extern int rcu_read_lock_bh_held(void);
Paul E. McKenney632ee202010-02-22 17:04:45 -0800147
148/**
Paul E. McKenneyca5ecdd2010-04-28 14:39:09 -0700149 * rcu_read_lock_sched_held() - might we be in RCU-sched read-side critical section?
Paul E. McKenney632ee202010-02-22 17:04:45 -0800150 *
Paul E. McKenneyd20200b2010-03-30 10:52:21 -0700151 * If CONFIG_DEBUG_LOCK_ALLOC is selected, returns nonzero iff in an
152 * RCU-sched read-side critical section. In absence of
153 * CONFIG_DEBUG_LOCK_ALLOC, this assumes we are in an RCU-sched read-side
154 * critical section unless it can prove otherwise. Note that disabling
155 * of preemption (including disabling irqs) counts as an RCU-sched
Paul E. McKenneyca5ecdd2010-04-28 14:39:09 -0700156 * read-side critical section. This is useful for debug checks in functions
157 * that required that they be called within an RCU-sched read-side
158 * critical section.
Paul E. McKenney54dbf962010-03-03 07:46:57 -0800159 *
Paul E. McKenney32c141a2010-03-30 10:59:28 -0700160 * Check debug_lockdep_rcu_enabled() to prevent false positives during boot
161 * and while lockdep is disabled.
Paul E. McKenney632ee202010-02-22 17:04:45 -0800162 */
Paul E. McKenneye6033e32010-03-03 17:50:16 -0800163#ifdef CONFIG_PREEMPT
Paul E. McKenney632ee202010-02-22 17:04:45 -0800164static inline int rcu_read_lock_sched_held(void)
165{
166 int lockdep_opinion = 0;
167
Paul E. McKenney54dbf962010-03-03 07:46:57 -0800168 if (!debug_lockdep_rcu_enabled())
169 return 1;
Paul E. McKenney632ee202010-02-22 17:04:45 -0800170 if (debug_locks)
171 lockdep_opinion = lock_is_held(&rcu_sched_lock_map);
Lai Jiangshan0cff8102010-03-18 12:25:33 -0700172 return lockdep_opinion || preempt_count() != 0 || irqs_disabled();
Paul E. McKenney632ee202010-02-22 17:04:45 -0800173}
Paul E. McKenneye6033e32010-03-03 17:50:16 -0800174#else /* #ifdef CONFIG_PREEMPT */
175static inline int rcu_read_lock_sched_held(void)
176{
177 return 1;
178}
179#endif /* #else #ifdef CONFIG_PREEMPT */
Paul E. McKenney632ee202010-02-22 17:04:45 -0800180
181#else /* #ifdef CONFIG_DEBUG_LOCK_ALLOC */
182
183# define rcu_read_acquire() do { } while (0)
184# define rcu_read_release() do { } while (0)
185# define rcu_read_acquire_bh() do { } while (0)
186# define rcu_read_release_bh() do { } while (0)
187# define rcu_read_acquire_sched() do { } while (0)
188# define rcu_read_release_sched() do { } while (0)
189
190static inline int rcu_read_lock_held(void)
191{
192 return 1;
193}
194
195static inline int rcu_read_lock_bh_held(void)
196{
197 return 1;
198}
199
Paul E. McKenneye6033e32010-03-03 17:50:16 -0800200#ifdef CONFIG_PREEMPT
Paul E. McKenney632ee202010-02-22 17:04:45 -0800201static inline int rcu_read_lock_sched_held(void)
202{
Paul E. McKenneybbad9372010-04-02 16:17:17 -0700203 return preempt_count() != 0 || irqs_disabled();
Paul E. McKenney632ee202010-02-22 17:04:45 -0800204}
Paul E. McKenneye6033e32010-03-03 17:50:16 -0800205#else /* #ifdef CONFIG_PREEMPT */
206static inline int rcu_read_lock_sched_held(void)
207{
208 return 1;
209}
210#endif /* #else #ifdef CONFIG_PREEMPT */
Paul E. McKenney632ee202010-02-22 17:04:45 -0800211
212#endif /* #else #ifdef CONFIG_DEBUG_LOCK_ALLOC */
213
214#ifdef CONFIG_PROVE_RCU
215
Paul E. McKenneyee84b822010-05-06 09:28:41 -0700216extern int rcu_my_thread_group_empty(void);
217
Lai Jiangshan2b3fc352010-04-20 16:23:07 +0800218#define __do_rcu_dereference_check(c) \
219 do { \
220 static bool __warned; \
221 if (debug_lockdep_rcu_enabled() && !__warned && !(c)) { \
222 __warned = true; \
223 lockdep_rcu_dereference(__FILE__, __LINE__); \
224 } \
225 } while (0)
226
Paul E. McKenneyca5ecdd2010-04-28 14:39:09 -0700227#else /* #ifdef CONFIG_PROVE_RCU */
228
229#define __do_rcu_dereference_check(c) do { } while (0)
230
231#endif /* #else #ifdef CONFIG_PROVE_RCU */
232
233/*
234 * Helper functions for rcu_dereference_check(), rcu_dereference_protected()
235 * and rcu_assign_pointer(). Some of these could be folded into their
236 * callers, but they are left separate in order to ease introduction of
237 * multiple flavors of pointers to match the multiple flavors of RCU
238 * (e.g., __rcu_bh, * __rcu_sched, and __srcu), should this make sense in
239 * the future.
240 */
241#define __rcu_access_pointer(p, space) \
242 ({ \
243 typeof(*p) *_________p1 = (typeof(*p)*__force )ACCESS_ONCE(p); \
244 (void) (((typeof (*p) space *)p) == p); \
245 ((typeof(*p) __force __kernel *)(_________p1)); \
246 })
247#define __rcu_dereference_check(p, c, space) \
248 ({ \
249 typeof(*p) *_________p1 = (typeof(*p)*__force )ACCESS_ONCE(p); \
250 __do_rcu_dereference_check(c); \
251 (void) (((typeof (*p) space *)p) == p); \
252 smp_read_barrier_depends(); \
253 ((typeof(*p) __force __kernel *)(_________p1)); \
254 })
255#define __rcu_dereference_protected(p, c, space) \
256 ({ \
257 __do_rcu_dereference_check(c); \
258 (void) (((typeof (*p) space *)p) == p); \
259 ((typeof(*p) __force __kernel *)(p)); \
260 })
261
262#define __rcu_dereference_index_check(p, c) \
263 ({ \
264 typeof(p) _________p1 = ACCESS_ONCE(p); \
265 __do_rcu_dereference_check(c); \
266 smp_read_barrier_depends(); \
267 (_________p1); \
268 })
269#define __rcu_assign_pointer(p, v, space) \
270 ({ \
271 if (!__builtin_constant_p(v) || \
272 ((v) != NULL)) \
273 smp_wmb(); \
274 (p) = (typeof(*v) __force space *)(v); \
275 })
276
277
Paul E. McKenney632ee202010-02-22 17:04:45 -0800278/**
Paul E. McKenneyca5ecdd2010-04-28 14:39:09 -0700279 * rcu_access_pointer() - fetch RCU pointer with no dereferencing
280 * @p: The pointer to read
281 *
282 * Return the value of the specified RCU-protected pointer, but omit the
283 * smp_read_barrier_depends() and keep the ACCESS_ONCE(). This is useful
284 * when the value of this pointer is accessed, but the pointer is not
285 * dereferenced, for example, when testing an RCU-protected pointer against
286 * NULL. Although rcu_access_pointer() may also be used in cases where
287 * update-side locks prevent the value of the pointer from changing, you
288 * should instead use rcu_dereference_protected() for this use case.
289 */
290#define rcu_access_pointer(p) __rcu_access_pointer((p), __rcu)
291
292/**
293 * rcu_dereference_check() - rcu_dereference with debug checking
David Howellsc08c68d2010-04-09 15:39:11 -0700294 * @p: The pointer to read, prior to dereferencing
295 * @c: The conditions under which the dereference will take place
Paul E. McKenney632ee202010-02-22 17:04:45 -0800296 *
David Howellsc08c68d2010-04-09 15:39:11 -0700297 * Do an rcu_dereference(), but check that the conditions under which the
Paul E. McKenneyca5ecdd2010-04-28 14:39:09 -0700298 * dereference will take place are correct. Typically the conditions
299 * indicate the various locking conditions that should be held at that
300 * point. The check should return true if the conditions are satisfied.
301 * An implicit check for being in an RCU read-side critical section
302 * (rcu_read_lock()) is included.
David Howellsc08c68d2010-04-09 15:39:11 -0700303 *
304 * For example:
305 *
Paul E. McKenneyca5ecdd2010-04-28 14:39:09 -0700306 * bar = rcu_dereference_check(foo->bar, lockdep_is_held(&foo->lock));
David Howellsc08c68d2010-04-09 15:39:11 -0700307 *
308 * could be used to indicate to lockdep that foo->bar may only be dereferenced
Paul E. McKenneyca5ecdd2010-04-28 14:39:09 -0700309 * if either rcu_read_lock() is held, or that the lock required to replace
David Howellsc08c68d2010-04-09 15:39:11 -0700310 * the bar struct at foo->bar is held.
311 *
312 * Note that the list of conditions may also include indications of when a lock
313 * need not be held, for example during initialisation or destruction of the
314 * target struct:
315 *
Paul E. McKenneyca5ecdd2010-04-28 14:39:09 -0700316 * bar = rcu_dereference_check(foo->bar, lockdep_is_held(&foo->lock) ||
David Howellsc08c68d2010-04-09 15:39:11 -0700317 * atomic_read(&foo->usage) == 0);
Paul E. McKenneyca5ecdd2010-04-28 14:39:09 -0700318 *
319 * Inserts memory barriers on architectures that require them
320 * (currently only the Alpha), prevents the compiler from refetching
321 * (and from merging fetches), and, more importantly, documents exactly
322 * which pointers are protected by RCU and checks that the pointer is
323 * annotated as __rcu.
Paul E. McKenney632ee202010-02-22 17:04:45 -0800324 */
325#define rcu_dereference_check(p, c) \
Paul E. McKenneyca5ecdd2010-04-28 14:39:09 -0700326 __rcu_dereference_check((p), rcu_read_lock_held() || (c), __rcu)
Paul E. McKenney632ee202010-02-22 17:04:45 -0800327
Paul E. McKenneyb62730b2010-04-09 15:39:10 -0700328/**
Paul E. McKenneyca5ecdd2010-04-28 14:39:09 -0700329 * rcu_dereference_bh_check() - rcu_dereference_bh with debug checking
330 * @p: The pointer to read, prior to dereferencing
331 * @c: The conditions under which the dereference will take place
332 *
333 * This is the RCU-bh counterpart to rcu_dereference_check().
334 */
335#define rcu_dereference_bh_check(p, c) \
336 __rcu_dereference_check((p), rcu_read_lock_bh_held() || (c), __rcu)
337
338/**
339 * rcu_dereference_sched_check() - rcu_dereference_sched with debug checking
340 * @p: The pointer to read, prior to dereferencing
341 * @c: The conditions under which the dereference will take place
342 *
343 * This is the RCU-sched counterpart to rcu_dereference_check().
344 */
345#define rcu_dereference_sched_check(p, c) \
346 __rcu_dereference_check((p), rcu_read_lock_sched_held() || (c), \
347 __rcu)
348
349#define rcu_dereference_raw(p) rcu_dereference_check(p, 1) /*@@@ needed? @@@*/
350
351/**
352 * rcu_dereference_index_check() - rcu_dereference for indices with debug checking
353 * @p: The pointer to read, prior to dereferencing
354 * @c: The conditions under which the dereference will take place
355 *
356 * Similar to rcu_dereference_check(), but omits the sparse checking.
357 * This allows rcu_dereference_index_check() to be used on integers,
358 * which can then be used as array indices. Attempting to use
359 * rcu_dereference_check() on an integer will give compiler warnings
360 * because the sparse address-space mechanism relies on dereferencing
361 * the RCU-protected pointer. Dereferencing integers is not something
362 * that even gcc will put up with.
363 *
364 * Note that this function does not implicitly check for RCU read-side
365 * critical sections. If this function gains lots of uses, it might
366 * make sense to provide versions for each flavor of RCU, but it does
367 * not make sense as of early 2010.
368 */
369#define rcu_dereference_index_check(p, c) \
370 __rcu_dereference_index_check((p), (c))
371
372/**
373 * rcu_dereference_protected() - fetch RCU pointer when updates prevented
374 * @p: The pointer to read, prior to dereferencing
375 * @c: The conditions under which the dereference will take place
Paul E. McKenneyb62730b2010-04-09 15:39:10 -0700376 *
377 * Return the value of the specified RCU-protected pointer, but omit
378 * both the smp_read_barrier_depends() and the ACCESS_ONCE(). This
379 * is useful in cases where update-side locks prevent the value of the
380 * pointer from changing. Please note that this primitive does -not-
381 * prevent the compiler from repeating this reference or combining it
382 * with other references, so it should not be used without protection
383 * of appropriate locks.
Paul E. McKenneyca5ecdd2010-04-28 14:39:09 -0700384 *
385 * This function is only for update-side use. Using this function
386 * when protected only by rcu_read_lock() will result in infrequent
387 * but very ugly failures.
Paul E. McKenneyb62730b2010-04-09 15:39:10 -0700388 */
389#define rcu_dereference_protected(p, c) \
Paul E. McKenneyca5ecdd2010-04-28 14:39:09 -0700390 __rcu_dereference_protected((p), (c), __rcu)
Paul E. McKenneybc33f242009-08-22 13:56:47 -0700391
Linus Torvalds1da177e2005-04-16 15:20:36 -0700392/**
Paul E. McKenneyca5ecdd2010-04-28 14:39:09 -0700393 * rcu_dereference_bh_protected() - fetch RCU-bh pointer when updates prevented
394 * @p: The pointer to read, prior to dereferencing
395 * @c: The conditions under which the dereference will take place
Paul E. McKenneyb62730b2010-04-09 15:39:10 -0700396 *
Paul E. McKenneyca5ecdd2010-04-28 14:39:09 -0700397 * This is the RCU-bh counterpart to rcu_dereference_protected().
Paul E. McKenneyb62730b2010-04-09 15:39:10 -0700398 */
Paul E. McKenneyca5ecdd2010-04-28 14:39:09 -0700399#define rcu_dereference_bh_protected(p, c) \
400 __rcu_dereference_protected((p), (c), __rcu)
Paul E. McKenneyb62730b2010-04-09 15:39:10 -0700401
402/**
Paul E. McKenneyca5ecdd2010-04-28 14:39:09 -0700403 * rcu_dereference_sched_protected() - fetch RCU-sched pointer when updates prevented
404 * @p: The pointer to read, prior to dereferencing
405 * @c: The conditions under which the dereference will take place
406 *
407 * This is the RCU-sched counterpart to rcu_dereference_protected().
408 */
409#define rcu_dereference_sched_protected(p, c) \
410 __rcu_dereference_protected((p), (c), __rcu)
411
412
413/**
414 * rcu_dereference() - fetch RCU-protected pointer for dereferencing
415 * @p: The pointer to read, prior to dereferencing
416 *
417 * This is a simple wrapper around rcu_dereference_check().
418 */
419#define rcu_dereference(p) rcu_dereference_check(p, 0)
420
421/**
422 * rcu_dereference_bh() - fetch an RCU-bh-protected pointer for dereferencing
423 * @p: The pointer to read, prior to dereferencing
424 *
425 * Makes rcu_dereference_check() do the dirty work.
426 */
427#define rcu_dereference_bh(p) rcu_dereference_bh_check(p, 0)
428
429/**
430 * rcu_dereference_sched() - fetch RCU-sched-protected pointer for dereferencing
431 * @p: The pointer to read, prior to dereferencing
432 *
433 * Makes rcu_dereference_check() do the dirty work.
434 */
435#define rcu_dereference_sched(p) rcu_dereference_sched_check(p, 0)
436
437/**
438 * rcu_read_lock() - mark the beginning of an RCU read-side critical section
Linus Torvalds1da177e2005-04-16 15:20:36 -0700439 *
Paul E. McKenney9b06e812005-05-01 08:59:04 -0700440 * When synchronize_rcu() is invoked on one CPU while other CPUs
Linus Torvalds1da177e2005-04-16 15:20:36 -0700441 * are within RCU read-side critical sections, then the
Paul E. McKenney9b06e812005-05-01 08:59:04 -0700442 * synchronize_rcu() is guaranteed to block until after all the other
Linus Torvalds1da177e2005-04-16 15:20:36 -0700443 * CPUs exit their critical sections. Similarly, if call_rcu() is invoked
444 * on one CPU while other CPUs are within RCU read-side critical
445 * sections, invocation of the corresponding RCU callback is deferred
446 * until after the all the other CPUs exit their critical sections.
447 *
448 * Note, however, that RCU callbacks are permitted to run concurrently
449 * with RCU read-side critical sections. One way that this can happen
450 * is via the following sequence of events: (1) CPU 0 enters an RCU
451 * read-side critical section, (2) CPU 1 invokes call_rcu() to register
452 * an RCU callback, (3) CPU 0 exits the RCU read-side critical section,
453 * (4) CPU 2 enters a RCU read-side critical section, (5) the RCU
454 * callback is invoked. This is legal, because the RCU read-side critical
455 * section that was running concurrently with the call_rcu() (and which
456 * therefore might be referencing something that the corresponding RCU
457 * callback would free up) has completed before the corresponding
458 * RCU callback is invoked.
459 *
460 * RCU read-side critical sections may be nested. Any deferred actions
461 * will be deferred until the outermost RCU read-side critical section
462 * completes.
463 *
464 * It is illegal to block while in an RCU read-side critical section.
465 */
Paul E. McKenneybc33f242009-08-22 13:56:47 -0700466static inline void rcu_read_lock(void)
467{
468 __rcu_read_lock();
469 __acquire(RCU);
470 rcu_read_acquire();
471}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700472
Linus Torvalds1da177e2005-04-16 15:20:36 -0700473/*
474 * So where is rcu_write_lock()? It does not exist, as there is no
475 * way for writers to lock out RCU readers. This is a feature, not
476 * a bug -- this property is what provides RCU's performance benefits.
477 * Of course, writers must coordinate with each other. The normal
478 * spinlock primitives work well for this, but any other technique may be
479 * used as well. RCU does not care how the writers keep out of each
480 * others' way, as long as they do so.
481 */
Paul E. McKenney3d76c082009-09-28 07:46:32 -0700482
483/**
Paul E. McKenneyca5ecdd2010-04-28 14:39:09 -0700484 * rcu_read_unlock() - marks the end of an RCU read-side critical section.
Paul E. McKenney3d76c082009-09-28 07:46:32 -0700485 *
486 * See rcu_read_lock() for more information.
487 */
Paul E. McKenneybc33f242009-08-22 13:56:47 -0700488static inline void rcu_read_unlock(void)
489{
490 rcu_read_release();
491 __release(RCU);
492 __rcu_read_unlock();
493}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700494
495/**
Paul E. McKenneyca5ecdd2010-04-28 14:39:09 -0700496 * rcu_read_lock_bh() - mark the beginning of an RCU-bh critical section
Linus Torvalds1da177e2005-04-16 15:20:36 -0700497 *
498 * This is equivalent of rcu_read_lock(), but to be used when updates
Paul E. McKenneyca5ecdd2010-04-28 14:39:09 -0700499 * are being done using call_rcu_bh() or synchronize_rcu_bh(). Since
500 * both call_rcu_bh() and synchronize_rcu_bh() consider completion of a
501 * softirq handler to be a quiescent state, a process in RCU read-side
502 * critical section must be protected by disabling softirqs. Read-side
503 * critical sections in interrupt context can use just rcu_read_lock(),
504 * though this should at least be commented to avoid confusing people
505 * reading the code.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700506 */
Paul E. McKenneybc33f242009-08-22 13:56:47 -0700507static inline void rcu_read_lock_bh(void)
508{
509 __rcu_read_lock_bh();
510 __acquire(RCU_BH);
Paul E. McKenney632ee202010-02-22 17:04:45 -0800511 rcu_read_acquire_bh();
Paul E. McKenneybc33f242009-08-22 13:56:47 -0700512}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700513
514/*
515 * rcu_read_unlock_bh - marks the end of a softirq-only RCU critical section
516 *
517 * See rcu_read_lock_bh() for more information.
518 */
Paul E. McKenneybc33f242009-08-22 13:56:47 -0700519static inline void rcu_read_unlock_bh(void)
520{
Paul E. McKenney632ee202010-02-22 17:04:45 -0800521 rcu_read_release_bh();
Paul E. McKenneybc33f242009-08-22 13:56:47 -0700522 __release(RCU_BH);
523 __rcu_read_unlock_bh();
524}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700525
526/**
Paul E. McKenneyca5ecdd2010-04-28 14:39:09 -0700527 * rcu_read_lock_sched() - mark the beginning of a RCU-sched critical section
Mathieu Desnoyers1c50b722008-09-29 11:06:46 -0400528 *
Paul E. McKenneyca5ecdd2010-04-28 14:39:09 -0700529 * This is equivalent of rcu_read_lock(), but to be used when updates
530 * are being done using call_rcu_sched() or synchronize_rcu_sched().
531 * Read-side critical sections can also be introduced by anything that
532 * disables preemption, including local_irq_disable() and friends.
Mathieu Desnoyers1c50b722008-09-29 11:06:46 -0400533 */
Paul E. McKenneyd6714c22009-08-22 13:56:46 -0700534static inline void rcu_read_lock_sched(void)
535{
536 preempt_disable();
Paul E. McKenneybc33f242009-08-22 13:56:47 -0700537 __acquire(RCU_SCHED);
Paul E. McKenney632ee202010-02-22 17:04:45 -0800538 rcu_read_acquire_sched();
Paul E. McKenneyd6714c22009-08-22 13:56:46 -0700539}
Paul E. McKenney1eba8f82009-09-23 09:50:42 -0700540
541/* Used by lockdep and tracing: cannot be traced, cannot call lockdep. */
Paul E. McKenney7c614d62009-08-24 09:42:00 -0700542static inline notrace void rcu_read_lock_sched_notrace(void)
Paul E. McKenneyd6714c22009-08-22 13:56:46 -0700543{
544 preempt_disable_notrace();
Paul E. McKenneybc33f242009-08-22 13:56:47 -0700545 __acquire(RCU_SCHED);
Paul E. McKenneyd6714c22009-08-22 13:56:46 -0700546}
Mathieu Desnoyers1c50b722008-09-29 11:06:46 -0400547
548/*
549 * rcu_read_unlock_sched - marks the end of a RCU-classic critical section
550 *
551 * See rcu_read_lock_sched for more information.
552 */
Paul E. McKenneyd6714c22009-08-22 13:56:46 -0700553static inline void rcu_read_unlock_sched(void)
554{
Paul E. McKenney632ee202010-02-22 17:04:45 -0800555 rcu_read_release_sched();
Paul E. McKenneybc33f242009-08-22 13:56:47 -0700556 __release(RCU_SCHED);
Paul E. McKenneyd6714c22009-08-22 13:56:46 -0700557 preempt_enable();
558}
Paul E. McKenney1eba8f82009-09-23 09:50:42 -0700559
560/* Used by lockdep and tracing: cannot be traced, cannot call lockdep. */
Paul E. McKenney7c614d62009-08-24 09:42:00 -0700561static inline notrace void rcu_read_unlock_sched_notrace(void)
Paul E. McKenneyd6714c22009-08-22 13:56:46 -0700562{
Paul E. McKenneybc33f242009-08-22 13:56:47 -0700563 __release(RCU_SCHED);
Paul E. McKenneyd6714c22009-08-22 13:56:46 -0700564 preempt_enable_notrace();
565}
Mathieu Desnoyers1c50b722008-09-29 11:06:46 -0400566
Mathieu Desnoyers1c50b722008-09-29 11:06:46 -0400567/**
Paul E. McKenneyca5ecdd2010-04-28 14:39:09 -0700568 * rcu_assign_pointer() - assign to RCU-protected pointer
569 * @p: pointer to assign to
570 * @v: value to assign (publish)
Paul E. McKenneyc26d34a2010-02-22 17:04:46 -0800571 *
Paul E. McKenneyca5ecdd2010-04-28 14:39:09 -0700572 * Assigns the specified value to the specified RCU-protected
573 * pointer, ensuring that any concurrent RCU readers will see
574 * any prior initialization. Returns the value assigned.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700575 *
576 * Inserts memory barriers on architectures that require them
577 * (pretty much all of them other than x86), and also prevents
578 * the compiler from reordering the code that initializes the
579 * structure after the pointer assignment. More importantly, this
580 * call documents which pointers will be dereferenced by RCU read-side
581 * code.
582 */
Paul E. McKenneyd99c4f62008-02-06 01:37:25 -0800583#define rcu_assign_pointer(p, v) \
Paul E. McKenneyca5ecdd2010-04-28 14:39:09 -0700584 __rcu_assign_pointer((p), (v), __rcu)
585
586/**
587 * RCU_INIT_POINTER() - initialize an RCU protected pointer
588 *
589 * Initialize an RCU-protected pointer in such a way to avoid RCU-lockdep
590 * splats.
591 */
592#define RCU_INIT_POINTER(p, v) \
593 p = (typeof(*v) __force __rcu *)(v)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700594
Paul E. McKenney4446a362008-05-12 21:21:05 +0200595/* Infrastructure to implement the synchronize_() primitives. */
596
597struct rcu_synchronize {
598 struct rcu_head head;
599 struct completion completion;
600};
601
602extern void wakeme_after_rcu(struct rcu_head *head);
603
Paul E. McKenney9b06e812005-05-01 08:59:04 -0700604/**
Paul E. McKenneyca5ecdd2010-04-28 14:39:09 -0700605 * call_rcu() - Queue an RCU callback for invocation after a grace period.
Paul E. McKenney01c1c662008-01-25 21:08:24 +0100606 * @head: structure to be used for queueing the RCU updates.
607 * @func: actual update function to be invoked after the grace period
608 *
609 * The update function will be invoked some time after a full grace
610 * period elapses, in other words after all currently executing RCU
611 * read-side critical sections have completed. RCU read-side critical
612 * sections are delimited by rcu_read_lock() and rcu_read_unlock(),
613 * and may be nested.
614 */
615extern void call_rcu(struct rcu_head *head,
616 void (*func)(struct rcu_head *head));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700617
Paul E. McKenney01c1c662008-01-25 21:08:24 +0100618/**
Paul E. McKenneyca5ecdd2010-04-28 14:39:09 -0700619 * call_rcu_bh() - Queue an RCU for invocation after a quicker grace period.
Paul E. McKenney01c1c662008-01-25 21:08:24 +0100620 * @head: structure to be used for queueing the RCU updates.
621 * @func: actual update function to be invoked after the grace period
622 *
623 * The update function will be invoked some time after a full grace
624 * period elapses, in other words after all currently executing RCU
625 * read-side critical sections have completed. call_rcu_bh() assumes
626 * that the read-side critical sections end on completion of a softirq
627 * handler. This means that read-side critical sections in process
628 * context must not be interrupted by softirqs. This interface is to be
629 * used when most of the read-side critical sections are in softirq context.
630 * RCU read-side critical sections are delimited by :
631 * - rcu_read_lock() and rcu_read_unlock(), if in interrupt context.
632 * OR
633 * - rcu_read_lock_bh() and rcu_read_unlock_bh(), if in process context.
634 * These may be nested.
635 */
636extern void call_rcu_bh(struct rcu_head *head,
637 void (*func)(struct rcu_head *head));
638
Mathieu Desnoyers551d55a2010-04-17 08:48:42 -0400639/*
640 * debug_rcu_head_queue()/debug_rcu_head_unqueue() are used internally
641 * by call_rcu() and rcu callback execution, and are therefore not part of the
642 * RCU API. Leaving in rcupdate.h because they are used by all RCU flavors.
643 */
644
645#ifdef CONFIG_DEBUG_OBJECTS_RCU_HEAD
646# define STATE_RCU_HEAD_READY 0
647# define STATE_RCU_HEAD_QUEUED 1
648
649extern struct debug_obj_descr rcuhead_debug_descr;
650
651static inline void debug_rcu_head_queue(struct rcu_head *head)
652{
653 debug_object_activate(head, &rcuhead_debug_descr);
654 debug_object_active_state(head, &rcuhead_debug_descr,
655 STATE_RCU_HEAD_READY,
656 STATE_RCU_HEAD_QUEUED);
657}
658
659static inline void debug_rcu_head_unqueue(struct rcu_head *head)
660{
661 debug_object_active_state(head, &rcuhead_debug_descr,
662 STATE_RCU_HEAD_QUEUED,
663 STATE_RCU_HEAD_READY);
664 debug_object_deactivate(head, &rcuhead_debug_descr);
665}
666#else /* !CONFIG_DEBUG_OBJECTS_RCU_HEAD */
667static inline void debug_rcu_head_queue(struct rcu_head *head)
668{
669}
670
671static inline void debug_rcu_head_unqueue(struct rcu_head *head)
672{
673}
674#endif /* #else !CONFIG_DEBUG_OBJECTS_RCU_HEAD */
675
Linus Torvalds1da177e2005-04-16 15:20:36 -0700676#endif /* __LINUX_RCUPDATE_H */