rcupdate.h 23.0 KB
Newer Older
L
Linus Torvalds 已提交
1
/*
2
 * Read-Copy Update mechanism for mutual exclusion
L
Linus Torvalds 已提交
3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 *
18
 * Copyright IBM Corporation, 2001
L
Linus Torvalds 已提交
19 20
 *
 * Author: Dipankar Sarma <dipankar@in.ibm.com>
21
 *
22
 * Based on the original work by Paul McKenney <paulmck@us.ibm.com>
L
Linus Torvalds 已提交
23 24 25 26 27 28
 * and inputs from Rusty Russell, Andrea Arcangeli and Andi Kleen.
 * Papers:
 * http://www.rdrop.com/users/paulmck/paper/rclockpdcsproof.pdf
 * http://lse.sourceforge.net/locking/rclock_OLS.2001.05.01c.sc.pdf (OLS2001)
 *
 * For detailed explanation of Read-Copy Update mechanism see -
29
 *		http://lse.sourceforge.net/locking/rcupdate.html
L
Linus Torvalds 已提交
30 31 32 33 34 35 36 37 38 39 40
 *
 */

#ifndef __LINUX_RCUPDATE_H
#define __LINUX_RCUPDATE_H

#include <linux/cache.h>
#include <linux/spinlock.h>
#include <linux/threads.h>
#include <linux/cpumask.h>
#include <linux/seqlock.h>
41
#include <linux/lockdep.h>
P
Paul E. McKenney 已提交
42
#include <linux/completion.h>
43
#include <linux/debugobjects.h>
44
#include <linux/compiler.h>
L
Linus Torvalds 已提交
45

D
Dave Young 已提交
46 47 48 49
#ifdef CONFIG_RCU_TORTURE_TEST
extern int rcutorture_runnable; /* for sysctl */
#endif /* #ifdef CONFIG_RCU_TORTURE_TEST */

L
Linus Torvalds 已提交
50 51 52 53 54 55 56 57 58 59
/**
 * struct rcu_head - callback structure for use with RCU
 * @next: next update requests in a list
 * @func: actual update function to call after the grace period.
 */
struct rcu_head {
	struct rcu_head *next;
	void (*func)(struct rcu_head *head);
};

60 61 62 63 64 65 66 67 68
/* Exported common interfaces */
extern void rcu_barrier(void);
extern void rcu_barrier_bh(void);
extern void rcu_barrier_sched(void);
extern void synchronize_sched_expedited(void);
extern int sched_expedited_torture_stats(char *page);

/* Internal to kernel */
extern void rcu_init(void);
69

70
#if defined(CONFIG_TREE_RCU) || defined(CONFIG_TREE_PREEMPT_RCU)
71
#include <linux/rcutree.h>
72
#elif defined(CONFIG_TINY_RCU)
73
#include <linux/rcutiny.h>
74 75
#else
#error "Unknown RCU implementation specified to kernel configuration"
76
#endif
77

78
#define RCU_HEAD_INIT	{ .next = NULL, .func = NULL }
79
#define RCU_HEAD(head) struct rcu_head head = RCU_HEAD_INIT
L
Linus Torvalds 已提交
80 81 82 83
#define INIT_RCU_HEAD(ptr) do { \
       (ptr)->next = NULL; (ptr)->func = NULL; \
} while (0)

84 85 86 87 88 89 90 91 92 93
/*
 * init_rcu_head_on_stack()/destroy_rcu_head_on_stack() are needed for dynamic
 * initialization and destruction of rcu_head on the stack. rcu_head structures
 * allocated dynamically in the heap or defined statically don't need any
 * initialization.
 */
#ifdef CONFIG_DEBUG_OBJECTS_RCU_HEAD
extern void init_rcu_head_on_stack(struct rcu_head *head);
extern void destroy_rcu_head_on_stack(struct rcu_head *head);
#else /* !CONFIG_DEBUG_OBJECTS_RCU_HEAD */
94 95 96 97 98 99 100
static inline void init_rcu_head_on_stack(struct rcu_head *head)
{
}

static inline void destroy_rcu_head_on_stack(struct rcu_head *head)
{
}
101
#endif	/* #else !CONFIG_DEBUG_OBJECTS_RCU_HEAD */
102

103
#ifdef CONFIG_DEBUG_LOCK_ALLOC
104

105
extern struct lockdep_map rcu_lock_map;
106 107
# define rcu_read_acquire() \
		lock_acquire(&rcu_lock_map, 0, 0, 2, 1, NULL, _THIS_IP_)
108
# define rcu_read_release()	lock_release(&rcu_lock_map, 1, _THIS_IP_)
109 110 111 112 113 114 115 116 117 118 119 120

extern struct lockdep_map rcu_bh_lock_map;
# define rcu_read_acquire_bh() \
		lock_acquire(&rcu_bh_lock_map, 0, 0, 2, 1, NULL, _THIS_IP_)
# define rcu_read_release_bh()	lock_release(&rcu_bh_lock_map, 1, _THIS_IP_)

extern struct lockdep_map rcu_sched_lock_map;
# define rcu_read_acquire_sched() \
		lock_acquire(&rcu_sched_lock_map, 0, 0, 2, 1, NULL, _THIS_IP_)
# define rcu_read_release_sched() \
		lock_release(&rcu_sched_lock_map, 1, _THIS_IP_)

121
extern int debug_lockdep_rcu_enabled(void);
122

123
/**
124
 * rcu_read_lock_held() - might we be in RCU read-side critical section?
125
 *
126 127
 * If CONFIG_DEBUG_LOCK_ALLOC is selected, returns nonzero iff in an RCU
 * read-side critical section.  In absence of CONFIG_DEBUG_LOCK_ALLOC,
128
 * this assumes we are in an RCU read-side critical section unless it can
129 130
 * prove otherwise.  This is useful for debug checks in functions that
 * require that they be called within an RCU read-side critical section.
131
 *
132
 * Checks debug_lockdep_rcu_enabled() to prevent false positives during boot
133
 * and while lockdep is disabled.
134 135 136
 */
static inline int rcu_read_lock_held(void)
{
137 138 139
	if (!debug_lockdep_rcu_enabled())
		return 1;
	return lock_is_held(&rcu_lock_map);
140 141
}

142 143 144
/*
 * rcu_read_lock_bh_held() is defined out of line to avoid #include-file
 * hell.
145
 */
146
extern int rcu_read_lock_bh_held(void);
147 148

/**
149
 * rcu_read_lock_sched_held() - might we be in RCU-sched read-side critical section?
150
 *
151 152 153 154 155
 * If CONFIG_DEBUG_LOCK_ALLOC is selected, returns nonzero iff in an
 * RCU-sched read-side critical section.  In absence of
 * CONFIG_DEBUG_LOCK_ALLOC, this assumes we are in an RCU-sched read-side
 * critical section unless it can prove otherwise.  Note that disabling
 * of preemption (including disabling irqs) counts as an RCU-sched
156 157 158
 * read-side critical section.  This is useful for debug checks in functions
 * that required that they be called within an RCU-sched read-side
 * critical section.
159
 *
160 161
 * Check debug_lockdep_rcu_enabled() to prevent false positives during boot
 * and while lockdep is disabled.
162
 */
163
#ifdef CONFIG_PREEMPT
164 165 166 167
static inline int rcu_read_lock_sched_held(void)
{
	int lockdep_opinion = 0;

168 169
	if (!debug_lockdep_rcu_enabled())
		return 1;
170 171
	if (debug_locks)
		lockdep_opinion = lock_is_held(&rcu_sched_lock_map);
172
	return lockdep_opinion || preempt_count() != 0 || irqs_disabled();
173
}
174 175 176 177
#else /* #ifdef CONFIG_PREEMPT */
static inline int rcu_read_lock_sched_held(void)
{
	return 1;
178
}
179
#endif /* #else #ifdef CONFIG_PREEMPT */
180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199

#else /* #ifdef CONFIG_DEBUG_LOCK_ALLOC */

# define rcu_read_acquire()		do { } while (0)
# define rcu_read_release()		do { } while (0)
# define rcu_read_acquire_bh()		do { } while (0)
# define rcu_read_release_bh()		do { } while (0)
# define rcu_read_acquire_sched()	do { } while (0)
# define rcu_read_release_sched()	do { } while (0)

static inline int rcu_read_lock_held(void)
{
	return 1;
}

static inline int rcu_read_lock_bh_held(void)
{
	return 1;
}

200
#ifdef CONFIG_PREEMPT
201 202
static inline int rcu_read_lock_sched_held(void)
{
203
	return preempt_count() != 0 || irqs_disabled();
204
}
205 206 207 208
#else /* #ifdef CONFIG_PREEMPT */
static inline int rcu_read_lock_sched_held(void)
{
	return 1;
209
}
210
#endif /* #else #ifdef CONFIG_PREEMPT */
211 212 213 214 215

#endif /* #else #ifdef CONFIG_DEBUG_LOCK_ALLOC */

#ifdef CONFIG_PROVE_RCU

216 217
extern int rcu_my_thread_group_empty(void);

218 219 220 221 222
/**
 * rcu_lockdep_assert - emit lockdep splat if specified condition not met
 * @c: condition to check
 */
#define rcu_lockdep_assert(c)						\
223 224 225 226 227 228 229 230
	do {								\
		static bool __warned;					\
		if (debug_lockdep_rcu_enabled() && !__warned && !(c)) {	\
			__warned = true;				\
			lockdep_rcu_dereference(__FILE__, __LINE__);	\
		}							\
	} while (0)

231 232
#else /* #ifdef CONFIG_PROVE_RCU */

233
#define rcu_lockdep_assert(c) do { } while (0)
234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253

#endif /* #else #ifdef CONFIG_PROVE_RCU */

/*
 * Helper functions for rcu_dereference_check(), rcu_dereference_protected()
 * and rcu_assign_pointer().  Some of these could be folded into their
 * callers, but they are left separate in order to ease introduction of
 * multiple flavors of pointers to match the multiple flavors of RCU
 * (e.g., __rcu_bh, * __rcu_sched, and __srcu), should this make sense in
 * the future.
 */
#define __rcu_access_pointer(p, space) \
	({ \
		typeof(*p) *_________p1 = (typeof(*p)*__force )ACCESS_ONCE(p); \
		(void) (((typeof (*p) space *)p) == p); \
		((typeof(*p) __force __kernel *)(_________p1)); \
	})
#define __rcu_dereference_check(p, c, space) \
	({ \
		typeof(*p) *_________p1 = (typeof(*p)*__force )ACCESS_ONCE(p); \
254
		rcu_lockdep_assert(c); \
255 256 257 258 259 260
		(void) (((typeof (*p) space *)p) == p); \
		smp_read_barrier_depends(); \
		((typeof(*p) __force __kernel *)(_________p1)); \
	})
#define __rcu_dereference_protected(p, c, space) \
	({ \
261
		rcu_lockdep_assert(c); \
262 263 264 265 266 267 268
		(void) (((typeof (*p) space *)p) == p); \
		((typeof(*p) __force __kernel *)(p)); \
	})

#define __rcu_dereference_index_check(p, c) \
	({ \
		typeof(p) _________p1 = ACCESS_ONCE(p); \
269
		rcu_lockdep_assert(c); \
270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295
		smp_read_barrier_depends(); \
		(_________p1); \
	})
#define __rcu_assign_pointer(p, v, space) \
	({ \
		if (!__builtin_constant_p(v) || \
		    ((v) != NULL)) \
			smp_wmb(); \
		(p) = (typeof(*v) __force space *)(v); \
	})


/**
 * rcu_access_pointer() - fetch RCU pointer with no dereferencing
 * @p: The pointer to read
 *
 * Return the value of the specified RCU-protected pointer, but omit the
 * smp_read_barrier_depends() and keep the ACCESS_ONCE().  This is useful
 * when the value of this pointer is accessed, but the pointer is not
 * dereferenced, for example, when testing an RCU-protected pointer against
 * NULL.  Although rcu_access_pointer() may also be used in cases where
 * update-side locks prevent the value of the pointer from changing, you
 * should instead use rcu_dereference_protected() for this use case.
 */
#define rcu_access_pointer(p) __rcu_access_pointer((p), __rcu)

296
/**
297
 * rcu_dereference_check() - rcu_dereference with debug checking
298 299
 * @p: The pointer to read, prior to dereferencing
 * @c: The conditions under which the dereference will take place
300
 *
301
 * Do an rcu_dereference(), but check that the conditions under which the
302 303 304 305 306
 * dereference will take place are correct.  Typically the conditions
 * indicate the various locking conditions that should be held at that
 * point.  The check should return true if the conditions are satisfied.
 * An implicit check for being in an RCU read-side critical section
 * (rcu_read_lock()) is included.
307 308 309
 *
 * For example:
 *
310
 *	bar = rcu_dereference_check(foo->bar, lockdep_is_held(&foo->lock));
311 312
 *
 * could be used to indicate to lockdep that foo->bar may only be dereferenced
313
 * if either rcu_read_lock() is held, or that the lock required to replace
314 315 316 317 318 319
 * the bar struct at foo->bar is held.
 *
 * Note that the list of conditions may also include indications of when a lock
 * need not be held, for example during initialisation or destruction of the
 * target struct:
 *
320
 *	bar = rcu_dereference_check(foo->bar, lockdep_is_held(&foo->lock) ||
321
 *					      atomic_read(&foo->usage) == 0);
322 323 324 325 326 327
 *
 * Inserts memory barriers on architectures that require them
 * (currently only the Alpha), prevents the compiler from refetching
 * (and from merging fetches), and, more importantly, documents exactly
 * which pointers are protected by RCU and checks that the pointer is
 * annotated as __rcu.
328 329
 */
#define rcu_dereference_check(p, c) \
330 331 332 333 334 335 336 337 338 339 340
	__rcu_dereference_check((p), rcu_read_lock_held() || (c), __rcu)

/**
 * rcu_dereference_bh_check() - rcu_dereference_bh with debug checking
 * @p: The pointer to read, prior to dereferencing
 * @c: The conditions under which the dereference will take place
 *
 * This is the RCU-bh counterpart to rcu_dereference_check().
 */
#define rcu_dereference_bh_check(p, c) \
	__rcu_dereference_check((p), rcu_read_lock_bh_held() || (c), __rcu)
341

342
/**
343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379
 * rcu_dereference_sched_check() - rcu_dereference_sched with debug checking
 * @p: The pointer to read, prior to dereferencing
 * @c: The conditions under which the dereference will take place
 *
 * This is the RCU-sched counterpart to rcu_dereference_check().
 */
#define rcu_dereference_sched_check(p, c) \
	__rcu_dereference_check((p), rcu_read_lock_sched_held() || (c), \
				__rcu)

#define rcu_dereference_raw(p) rcu_dereference_check(p, 1) /*@@@ needed? @@@*/

/**
 * rcu_dereference_index_check() - rcu_dereference for indices with debug checking
 * @p: The pointer to read, prior to dereferencing
 * @c: The conditions under which the dereference will take place
 *
 * Similar to rcu_dereference_check(), but omits the sparse checking.
 * This allows rcu_dereference_index_check() to be used on integers,
 * which can then be used as array indices.  Attempting to use
 * rcu_dereference_check() on an integer will give compiler warnings
 * because the sparse address-space mechanism relies on dereferencing
 * the RCU-protected pointer.  Dereferencing integers is not something
 * that even gcc will put up with.
 *
 * Note that this function does not implicitly check for RCU read-side
 * critical sections.  If this function gains lots of uses, it might
 * make sense to provide versions for each flavor of RCU, but it does
 * not make sense as of early 2010.
 */
#define rcu_dereference_index_check(p, c) \
	__rcu_dereference_index_check((p), (c))

/**
 * rcu_dereference_protected() - fetch RCU pointer when updates prevented
 * @p: The pointer to read, prior to dereferencing
 * @c: The conditions under which the dereference will take place
380 381 382 383 384 385 386 387
 *
 * Return the value of the specified RCU-protected pointer, but omit
 * both the smp_read_barrier_depends() and the ACCESS_ONCE().  This
 * is useful in cases where update-side locks prevent the value of the
 * pointer from changing.  Please note that this primitive does -not-
 * prevent the compiler from repeating this reference or combining it
 * with other references, so it should not be used without protection
 * of appropriate locks.
388 389 390 391
 *
 * This function is only for update-side use.  Using this function
 * when protected only by rcu_read_lock() will result in infrequent
 * but very ugly failures.
392 393
 */
#define rcu_dereference_protected(p, c) \
394
	__rcu_dereference_protected((p), (c), __rcu)
395

396 397 398 399 400 401 402 403 404
/**
 * rcu_dereference_bh_protected() - fetch RCU-bh pointer when updates prevented
 * @p: The pointer to read, prior to dereferencing
 * @c: The conditions under which the dereference will take place
 *
 * This is the RCU-bh counterpart to rcu_dereference_protected().
 */
#define rcu_dereference_bh_protected(p, c) \
	__rcu_dereference_protected((p), (c), __rcu)
405

406 407 408 409 410 411 412 413 414
/**
 * rcu_dereference_sched_protected() - fetch RCU-sched pointer when updates prevented
 * @p: The pointer to read, prior to dereferencing
 * @c: The conditions under which the dereference will take place
 *
 * This is the RCU-sched counterpart to rcu_dereference_protected().
 */
#define rcu_dereference_sched_protected(p, c) \
	__rcu_dereference_protected((p), (c), __rcu)
415

416

417
/**
418 419
 * rcu_dereference() - fetch RCU-protected pointer for dereferencing
 * @p: The pointer to read, prior to dereferencing
420
 *
421
 * This is a simple wrapper around rcu_dereference_check().
422
 */
423
#define rcu_dereference(p) rcu_dereference_check(p, 0)
424

L
Linus Torvalds 已提交
425
/**
426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442
 * rcu_dereference_bh() - fetch an RCU-bh-protected pointer for dereferencing
 * @p: The pointer to read, prior to dereferencing
 *
 * Makes rcu_dereference_check() do the dirty work.
 */
#define rcu_dereference_bh(p) rcu_dereference_bh_check(p, 0)

/**
 * rcu_dereference_sched() - fetch RCU-sched-protected pointer for dereferencing
 * @p: The pointer to read, prior to dereferencing
 *
 * Makes rcu_dereference_check() do the dirty work.
 */
#define rcu_dereference_sched(p) rcu_dereference_sched_check(p, 0)

/**
 * rcu_read_lock() - mark the beginning of an RCU read-side critical section
L
Linus Torvalds 已提交
443
 *
444
 * When synchronize_rcu() is invoked on one CPU while other CPUs
L
Linus Torvalds 已提交
445
 * are within RCU read-side critical sections, then the
446
 * synchronize_rcu() is guaranteed to block until after all the other
L
Linus Torvalds 已提交
447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469
 * CPUs exit their critical sections.  Similarly, if call_rcu() is invoked
 * on one CPU while other CPUs are within RCU read-side critical
 * sections, invocation of the corresponding RCU callback is deferred
 * until after the all the other CPUs exit their critical sections.
 *
 * Note, however, that RCU callbacks are permitted to run concurrently
 * with RCU read-side critical sections.  One way that this can happen
 * is via the following sequence of events: (1) CPU 0 enters an RCU
 * read-side critical section, (2) CPU 1 invokes call_rcu() to register
 * an RCU callback, (3) CPU 0 exits the RCU read-side critical section,
 * (4) CPU 2 enters a RCU read-side critical section, (5) the RCU
 * callback is invoked.  This is legal, because the RCU read-side critical
 * section that was running concurrently with the call_rcu() (and which
 * therefore might be referencing something that the corresponding RCU
 * callback would free up) has completed before the corresponding
 * RCU callback is invoked.
 *
 * RCU read-side critical sections may be nested.  Any deferred actions
 * will be deferred until the outermost RCU read-side critical section
 * completes.
 *
 * It is illegal to block while in an RCU read-side critical section.
 */
470 471 472 473 474 475
static inline void rcu_read_lock(void)
{
	__rcu_read_lock();
	__acquire(RCU);
	rcu_read_acquire();
}
L
Linus Torvalds 已提交
476 477 478 479 480 481 482 483 484 485

/*
 * So where is rcu_write_lock()?  It does not exist, as there is no
 * way for writers to lock out RCU readers.  This is a feature, not
 * a bug -- this property is what provides RCU's performance benefits.
 * Of course, writers must coordinate with each other.  The normal
 * spinlock primitives work well for this, but any other technique may be
 * used as well.  RCU does not care how the writers keep out of each
 * others' way, as long as they do so.
 */
486 487

/**
488
 * rcu_read_unlock() - marks the end of an RCU read-side critical section.
489 490 491
 *
 * See rcu_read_lock() for more information.
 */
492 493 494 495 496 497
static inline void rcu_read_unlock(void)
{
	rcu_read_release();
	__release(RCU);
	__rcu_read_unlock();
}
L
Linus Torvalds 已提交
498 499

/**
500
 * rcu_read_lock_bh() - mark the beginning of an RCU-bh critical section
L
Linus Torvalds 已提交
501 502
 *
 * This is equivalent of rcu_read_lock(), but to be used when updates
503 504 505 506 507 508 509
 * are being done using call_rcu_bh() or synchronize_rcu_bh(). Since
 * both call_rcu_bh() and synchronize_rcu_bh() consider completion of a
 * softirq handler to be a quiescent state, a process in RCU read-side
 * critical section must be protected by disabling softirqs. Read-side
 * critical sections in interrupt context can use just rcu_read_lock(),
 * though this should at least be commented to avoid confusing people
 * reading the code.
L
Linus Torvalds 已提交
510
 */
511 512 513 514
static inline void rcu_read_lock_bh(void)
{
	__rcu_read_lock_bh();
	__acquire(RCU_BH);
515
	rcu_read_acquire_bh();
516
}
L
Linus Torvalds 已提交
517 518 519 520 521 522

/*
 * rcu_read_unlock_bh - marks the end of a softirq-only RCU critical section
 *
 * See rcu_read_lock_bh() for more information.
 */
523 524
static inline void rcu_read_unlock_bh(void)
{
525
	rcu_read_release_bh();
526 527 528
	__release(RCU_BH);
	__rcu_read_unlock_bh();
}
L
Linus Torvalds 已提交
529

530
/**
531
 * rcu_read_lock_sched() - mark the beginning of a RCU-sched critical section
532
 *
533 534 535 536
 * This is equivalent of rcu_read_lock(), but to be used when updates
 * are being done using call_rcu_sched() or synchronize_rcu_sched().
 * Read-side critical sections can also be introduced by anything that
 * disables preemption, including local_irq_disable() and friends.
537
 */
538 539 540
static inline void rcu_read_lock_sched(void)
{
	preempt_disable();
541
	__acquire(RCU_SCHED);
542
	rcu_read_acquire_sched();
543
}
544 545

/* Used by lockdep and tracing: cannot be traced, cannot call lockdep. */
546
static inline notrace void rcu_read_lock_sched_notrace(void)
547 548
{
	preempt_disable_notrace();
549
	__acquire(RCU_SCHED);
550
}
551 552 553 554 555 556

/*
 * rcu_read_unlock_sched - marks the end of a RCU-classic critical section
 *
 * See rcu_read_lock_sched for more information.
 */
557 558
static inline void rcu_read_unlock_sched(void)
{
559
	rcu_read_release_sched();
560
	__release(RCU_SCHED);
561 562
	preempt_enable();
}
563 564

/* Used by lockdep and tracing: cannot be traced, cannot call lockdep. */
565
static inline notrace void rcu_read_unlock_sched_notrace(void)
566
{
567
	__release(RCU_SCHED);
568 569
	preempt_enable_notrace();
}
570

L
Linus Torvalds 已提交
571
/**
572 573 574
 * rcu_assign_pointer() - assign to RCU-protected pointer
 * @p: pointer to assign to
 * @v: value to assign (publish)
575
 *
576 577 578
 * Assigns the specified value to the specified RCU-protected
 * pointer, ensuring that any concurrent RCU readers will see
 * any prior initialization.  Returns the value assigned.
L
Linus Torvalds 已提交
579 580 581 582 583 584 585 586
 *
 * Inserts memory barriers on architectures that require them
 * (pretty much all of them other than x86), and also prevents
 * the compiler from reordering the code that initializes the
 * structure after the pointer assignment.  More importantly, this
 * call documents which pointers will be dereferenced by RCU read-side
 * code.
 */
587
#define rcu_assign_pointer(p, v) \
588 589 590 591 592 593 594 595 596 597
	__rcu_assign_pointer((p), (v), __rcu)

/**
 * RCU_INIT_POINTER() - initialize an RCU protected pointer
 *
 * Initialize an RCU-protected pointer in such a way to avoid RCU-lockdep
 * splats.
 */
#define RCU_INIT_POINTER(p, v) \
		p = (typeof(*v) __force __rcu *)(v)
L
Linus Torvalds 已提交
598

P
Paul E. McKenney 已提交
599 600 601 602 603 604 605 606 607
/* Infrastructure to implement the synchronize_() primitives. */

struct rcu_synchronize {
	struct rcu_head head;
	struct completion completion;
};

extern void wakeme_after_rcu(struct rcu_head  *head);

608
/**
609
 * call_rcu() - Queue an RCU callback for invocation after a grace period.
610 611 612 613 614 615 616 617 618 619 620 621 622
 * @head: structure to be used for queueing the RCU updates.
 * @func: actual update function to be invoked after the grace period
 *
 * The update function will be invoked some time after a full grace
 * period elapses, in other words after all currently executing RCU
 * read-side critical sections have completed.  RCU read-side critical
 * sections are delimited by rcu_read_lock() and rcu_read_unlock(),
 * and may be nested.
 */
extern void call_rcu(struct rcu_head *head,
			      void (*func)(struct rcu_head *head));

/**
623
 * call_rcu_bh() - Queue an RCU for invocation after a quicker grace period.
624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642
 * @head: structure to be used for queueing the RCU updates.
 * @func: actual update function to be invoked after the grace period
 *
 * The update function will be invoked some time after a full grace
 * period elapses, in other words after all currently executing RCU
 * read-side critical sections have completed. call_rcu_bh() assumes
 * that the read-side critical sections end on completion of a softirq
 * handler. This means that read-side critical sections in process
 * context must not be interrupted by softirqs. This interface is to be
 * used when most of the read-side critical sections are in softirq context.
 * RCU read-side critical sections are delimited by :
 *  - rcu_read_lock() and  rcu_read_unlock(), if in interrupt context.
 *  OR
 *  - rcu_read_lock_bh() and rcu_read_unlock_bh(), if in process context.
 *  These may be nested.
 */
extern void call_rcu_bh(struct rcu_head *head,
			void (*func)(struct rcu_head *head));

643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679
/*
 * debug_rcu_head_queue()/debug_rcu_head_unqueue() are used internally
 * by call_rcu() and rcu callback execution, and are therefore not part of the
 * RCU API. Leaving in rcupdate.h because they are used by all RCU flavors.
 */

#ifdef CONFIG_DEBUG_OBJECTS_RCU_HEAD
# define STATE_RCU_HEAD_READY	0
# define STATE_RCU_HEAD_QUEUED	1

extern struct debug_obj_descr rcuhead_debug_descr;

static inline void debug_rcu_head_queue(struct rcu_head *head)
{
	debug_object_activate(head, &rcuhead_debug_descr);
	debug_object_active_state(head, &rcuhead_debug_descr,
				  STATE_RCU_HEAD_READY,
				  STATE_RCU_HEAD_QUEUED);
}

static inline void debug_rcu_head_unqueue(struct rcu_head *head)
{
	debug_object_active_state(head, &rcuhead_debug_descr,
				  STATE_RCU_HEAD_QUEUED,
				  STATE_RCU_HEAD_READY);
	debug_object_deactivate(head, &rcuhead_debug_descr);
}
#else	/* !CONFIG_DEBUG_OBJECTS_RCU_HEAD */
static inline void debug_rcu_head_queue(struct rcu_head *head)
{
}

static inline void debug_rcu_head_unqueue(struct rcu_head *head)
{
}
#endif	/* #else !CONFIG_DEBUG_OBJECTS_RCU_HEAD */

L
Linus Torvalds 已提交
680
#endif /* __LINUX_RCUPDATE_H */