include/linux/rcupdate.h

   1 /*
   2  * Read-Copy Update mechanism for mutual exclusion
   3  *
   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  *
  18  * Copyright IBM Corporation, 2001
  19  *
  20  * Author: Dipankar Sarma <dipankar@in.ibm.com>
  21  *
  22  * Based on the original work by Paul McKenney <paulmck@us.ibm.com>
  23  * 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 -
  29  *              http://lse.sourceforge.net/locking/rcupdate.html
  30  *
  31  */
  32
  33 #ifndef __LINUX_RCUPDATE_H
  34 #define __LINUX_RCUPDATE_H
  35
  36 #include <linux/cache.h>
  37 #include <linux/spinlock.h>
  38 #include <linux/threads.h>
  39 #include <linux/cpumask.h>
  40 #include <linux/seqlock.h>
  41 #include <linux/lockdep.h>
  42 #include <linux/completion.h>
  43 #include <linux/debugobjects.h>
  44 #include <linux/compiler.h>
  45
  46 #ifdef CONFIG_RCU_TORTURE_TEST
  47 extern int rcutorture_runnable; /* for sysctl */
  48 #endif /* #ifdef CONFIG_RCU_TORTURE_TEST */
  49
  50 /**
  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  */
  55 struct rcu_head {
  56         struct rcu_head *next;
  57         void (*func)(struct rcu_head *head);
  58 };
  59
  60 /* Exported common interfaces */
  61 extern void rcu_barrier(void);
  62 extern void rcu_barrier_bh(void);
  63 extern void rcu_barrier_sched(void);
  64 extern void synchronize_sched_expedited(void);
  65 extern int sched_expedited_torture_stats(char *page);
  66
  67 /* Internal to kernel */
  68 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 #else
  75 #error "Unknown RCU implementation specified to kernel configuration"
  76 #endif
  77
  78 /*
  79  * init_rcu_head_on_stack()/destroy_rcu_head_on_stack() are needed for dynamic
  80  * initialization and destruction of rcu_head on the stack. rcu_head structures
  81  * allocated dynamically in the heap or defined statically don't need any
  82  * initialization.
  83  */
  84 #ifdef CONFIG_DEBUG_OBJECTS_RCU_HEAD
  85 extern void init_rcu_head_on_stack(struct rcu_head *head);
  86 extern void destroy_rcu_head_on_stack(struct rcu_head *head);
  87 #else /* !CONFIG_DEBUG_OBJECTS_RCU_HEAD */
  88 static inline void init_rcu_head_on_stack(struct rcu_head *head)
  89 {
  90 }
  91
  92 static inline void destroy_rcu_head_on_stack(struct rcu_head *head)
  93 {
  94 }
  95 #endif  /* #else !CONFIG_DEBUG_OBJECTS_RCU_HEAD */
  96
  97 #ifdef CONFIG_DEBUG_LOCK_ALLOC
  98
  99 extern struct lockdep_map rcu_lock_map;
 100 # define rcu_read_acquire() \
 101                 lock_acquire(&rcu_lock_map, 0, 0, 2, 1, NULL, _THIS_IP_)
 102 # define rcu_read_release()     lock_release(&rcu_lock_map, 1, _THIS_IP_)
 103
 104 extern struct lockdep_map rcu_bh_lock_map;
 105 # define rcu_read_acquire_bh() \
 106                 lock_acquire(&rcu_bh_lock_map, 0, 0, 2, 1, NULL, _THIS_IP_)
 107 # define rcu_read_release_bh()  lock_release(&rcu_bh_lock_map, 1, _THIS_IP_)
 108
 109 extern struct lockdep_map rcu_sched_lock_map;
 110 # define rcu_read_acquire_sched() \
 111                 lock_acquire(&rcu_sched_lock_map, 0, 0, 2, 1, NULL, _THIS_IP_)
 112 # define rcu_read_release_sched() \
 113                 lock_release(&rcu_sched_lock_map, 1, _THIS_IP_)
 114
 115 extern int debug_lockdep_rcu_enabled(void);
 116
 117 /**
 118  * rcu_read_lock_held() - might we be in RCU read-side critical section?
 119  *
 120  * If CONFIG_DEBUG_LOCK_ALLOC is selected, returns nonzero iff in an RCU
 121  * read-side critical section.  In absence of CONFIG_DEBUG_LOCK_ALLOC,
 122  * this assumes we are in an RCU read-side critical section unless it can
 123  * prove otherwise.  This is useful for debug checks in functions that
 124  * require that they be called within an RCU read-side critical section.
 125  *
 126  * Checks debug_lockdep_rcu_enabled() to prevent false positives during boot
 127  * and while lockdep is disabled.
 128  */
 129 static inline int rcu_read_lock_held(void)
 130 {
 131         if (!debug_lockdep_rcu_enabled())
 132                 return 1;
 133         return lock_is_held(&rcu_lock_map);
 134 }
 135
 136 /*
 137  * rcu_read_lock_bh_held() is defined out of line to avoid #include-file
 138  * hell.
 139  */
 140 extern int rcu_read_lock_bh_held(void);
 141
 142 /**
 143  * rcu_read_lock_sched_held() - might we be in RCU-sched read-side critical section?
 144  *
 145  * If CONFIG_DEBUG_LOCK_ALLOC is selected, returns nonzero iff in an
 146  * RCU-sched read-side critical section.  In absence of
 147  * CONFIG_DEBUG_LOCK_ALLOC, this assumes we are in an RCU-sched read-side
 148  * critical section unless it can prove otherwise.  Note that disabling
 149  * of preemption (including disabling irqs) counts as an RCU-sched
 150  * read-side critical section.  This is useful for debug checks in functions
 151  * that required that they be called within an RCU-sched read-side
 152  * critical section.
 153  *
 154  * Check debug_lockdep_rcu_enabled() to prevent false positives during boot
 155  * and while lockdep is disabled.
 156  */
 157 #ifdef CONFIG_PREEMPT
 158 static inline int rcu_read_lock_sched_held(void)
 159 {
 160         int lockdep_opinion = 0;
 161
 162         if (!debug_lockdep_rcu_enabled())
 163                 return 1;
 164         if (debug_locks)
 165                 lockdep_opinion = lock_is_held(&rcu_sched_lock_map);
 166         return lockdep_opinion || preempt_count() != 0 || irqs_disabled();
 167 }
 168 #else /* #ifdef CONFIG_PREEMPT */
 169 static inline int rcu_read_lock_sched_held(void)
 170 {
 171         return 1;
 172 }
 173 #endif /* #else #ifdef CONFIG_PREEMPT */
 174
 175 #else /* #ifdef CONFIG_DEBUG_LOCK_ALLOC */
 176
 177 # define rcu_read_acquire()             do { } while (0)
 178 # define rcu_read_release()             do { } while (0)
 179 # define rcu_read_acquire_bh()          do { } while (0)
 180 # define rcu_read_release_bh()          do { } while (0)
 181 # define rcu_read_acquire_sched()       do { } while (0)
 182 # define rcu_read_release_sched()       do { } while (0)
 183
 184 static inline int rcu_read_lock_held(void)
 185 {
 186         return 1;
 187 }
 188
 189 static inline int rcu_read_lock_bh_held(void)
 190 {
 191         return 1;
 192 }
 193
 194 #ifdef CONFIG_PREEMPT
 195 static inline int rcu_read_lock_sched_held(void)
 196 {
 197         return preempt_count() != 0 || irqs_disabled();
 198 }
 199 #else /* #ifdef CONFIG_PREEMPT */
 200 static inline int rcu_read_lock_sched_held(void)
 201 {
 202         return 1;
 203 }
 204 #endif /* #else #ifdef CONFIG_PREEMPT */
 205
 206 #endif /* #else #ifdef CONFIG_DEBUG_LOCK_ALLOC */
 207
 208 #ifdef CONFIG_PROVE_RCU
 209
 210 extern int rcu_my_thread_group_empty(void);
 211
 212 /**
 213  * rcu_lockdep_assert - emit lockdep splat if specified condition not met
 214  * @c: condition to check
 215  */
 216 #define rcu_lockdep_assert(c)                                           \
 217         do {                                                            \
 218                 static bool __warned;                                   \
 219                 if (debug_lockdep_rcu_enabled() && !__warned && !(c)) { \
 220                         __warned = true;                                \
 221                         lockdep_rcu_dereference(__FILE__, __LINE__);    \
 222                 }                                                       \
 223         } while (0)
 224
 225 #else /* #ifdef CONFIG_PROVE_RCU */
 226
 227 #define rcu_lockdep_assert(c) do { } while (0)
 228
 229 #endif /* #else #ifdef CONFIG_PROVE_RCU */
 230
 231 /*
 232  * Helper functions for rcu_dereference_check(), rcu_dereference_protected()
 233  * and rcu_assign_pointer().  Some of these could be folded into their
 234  * callers, but they are left separate in order to ease introduction of
 235  * multiple flavors of pointers to match the multiple flavors of RCU
 236  * (e.g., __rcu_bh, * __rcu_sched, and __srcu), should this make sense in
 237  * the future.
 238  */
 239 #define __rcu_access_pointer(p, space) \
 240         ({ \
 241                 typeof(*p) *_________p1 = (typeof(*p)*__force )ACCESS_ONCE(p); \
 242                 (void) (((typeof (*p) space *)p) == p); \
 243                 ((typeof(*p) __force __kernel *)(_________p1)); \
 244         })
 245 #define __rcu_dereference_check(p, c, space) \
 246         ({ \
 247                 typeof(*p) *_________p1 = (typeof(*p)*__force )ACCESS_ONCE(p); \
 248                 rcu_lockdep_assert(c); \
 249                 (void) (((typeof (*p) space *)p) == p); \
 250                 smp_read_barrier_depends(); \
 251                 ((typeof(*p) __force __kernel *)(_________p1)); \
 252         })
 253 #define __rcu_dereference_protected(p, c, space) \
 254         ({ \
 255                 rcu_lockdep_assert(c); \
 256                 (void) (((typeof (*p) space *)p) == p); \
 257                 ((typeof(*p) __force __kernel *)(p)); \
 258         })
 259
 260 #define __rcu_dereference_index_check(p, c) \
 261         ({ \
 262                 typeof(p) _________p1 = ACCESS_ONCE(p); \
 263                 rcu_lockdep_assert(c); \
 264                 smp_read_barrier_depends(); \
 265                 (_________p1); \
 266         })
 267 #define __rcu_assign_pointer(p, v, space) \
 268         ({ \
 269                 if (!__builtin_constant_p(v) || \
 270                     ((v) != NULL)) \
 271                         smp_wmb(); \
 272                 (p) = (typeof(*v) __force space *)(v); \
 273         })
 274
 275
 276 /**
 277  * rcu_access_pointer() - fetch RCU pointer with no dereferencing
 278  * @p: The pointer to read
 279  *
 280  * Return the value of the specified RCU-protected pointer, but omit the
 281  * smp_read_barrier_depends() and keep the ACCESS_ONCE().  This is useful
 282  * when the value of this pointer is accessed, but the pointer is not
 283  * dereferenced, for example, when testing an RCU-protected pointer against
 284  * NULL.  Although rcu_access_pointer() may also be used in cases where
 285  * update-side locks prevent the value of the pointer from changing, you
 286  * should instead use rcu_dereference_protected() for this use case.
 287  */
 288 #define rcu_access_pointer(p) __rcu_access_pointer((p), __rcu)
 289
 290 /**
 291  * rcu_dereference_check() - rcu_dereference with debug checking
 292  * @p: The pointer to read, prior to dereferencing
 293  * @c: The conditions under which the dereference will take place
 294  *
 295  * Do an rcu_dereference(), but check that the conditions under which the
 296  * dereference will take place are correct.  Typically the conditions
 297  * indicate the various locking conditions that should be held at that
 298  * point.  The check should return true if the conditions are satisfied.
 299  * An implicit check for being in an RCU read-side critical section
 300  * (rcu_read_lock()) is included.
 301  *
 302  * For example:
 303  *
 304  *      bar = rcu_dereference_check(foo->bar, lockdep_is_held(&foo->lock));
 305  *
 306  * could be used to indicate to lockdep that foo->bar may only be dereferenced
 307  * if either rcu_read_lock() is held, or that the lock required to replace
 308  * the bar struct at foo->bar is held.
 309  *
 310  * Note that the list of conditions may also include indications of when a lock
 311  * need not be held, for example during initialisation or destruction of the
 312  * target struct:
 313  *
 314  *      bar = rcu_dereference_check(foo->bar, lockdep_is_held(&foo->lock) ||
 315  *                                            atomic_read(&foo->usage) == 0);
 316  *
 317  * Inserts memory barriers on architectures that require them
 318  * (currently only the Alpha), prevents the compiler from refetching
 319  * (and from merging fetches), and, more importantly, documents exactly
 320  * which pointers are protected by RCU and checks that the pointer is
 321  * annotated as __rcu.
 322  */
 323 #define rcu_dereference_check(p, c) \
 324         __rcu_dereference_check((p), rcu_read_lock_held() || (c), __rcu)
 325
 326 /**
 327  * rcu_dereference_bh_check() - rcu_dereference_bh with debug checking
 328  * @p: The pointer to read, prior to dereferencing
 329  * @c: The conditions under which the dereference will take place
 330  *
 331  * This is the RCU-bh counterpart to rcu_dereference_check().
 332  */
 333 #define rcu_dereference_bh_check(p, c) \
 334         __rcu_dereference_check((p), rcu_read_lock_bh_held() || (c), __rcu)
 335
 336 /**
 337  * rcu_dereference_sched_check() - rcu_dereference_sched with debug checking
 338  * @p: The pointer to read, prior to dereferencing
 339  * @c: The conditions under which the dereference will take place
 340  *
 341  * This is the RCU-sched counterpart to rcu_dereference_check().
 342  */
 343 #define rcu_dereference_sched_check(p, c) \
 344         __rcu_dereference_check((p), rcu_read_lock_sched_held() || (c), \
 345                                 __rcu)
 346
 347 #define rcu_dereference_raw(p) rcu_dereference_check(p, 1) /*@@@ needed? @@@*/
 348
 349 /**
 350  * rcu_dereference_index_check() - rcu_dereference for indices with debug checking
 351  * @p: The pointer to read, prior to dereferencing
 352  * @c: The conditions under which the dereference will take place
 353  *
 354  * Similar to rcu_dereference_check(), but omits the sparse checking.
 355  * This allows rcu_dereference_index_check() to be used on integers,
 356  * which can then be used as array indices.  Attempting to use
 357  * rcu_dereference_check() on an integer will give compiler warnings
 358  * because the sparse address-space mechanism relies on dereferencing
 359  * the RCU-protected pointer.  Dereferencing integers is not something
 360  * that even gcc will put up with.
 361  *
 362  * Note that this function does not implicitly check for RCU read-side
 363  * critical sections.  If this function gains lots of uses, it might
 364  * make sense to provide versions for each flavor of RCU, but it does
 365  * not make sense as of early 2010.
 366  */
 367 #define rcu_dereference_index_check(p, c) \
 368         __rcu_dereference_index_check((p), (c))
 369
 370 /**
 371  * rcu_dereference_protected() - fetch RCU pointer when updates prevented
 372  * @p: The pointer to read, prior to dereferencing
 373  * @c: The conditions under which the dereference will take place
 374  *
 375  * Return the value of the specified RCU-protected pointer, but omit
 376  * both the smp_read_barrier_depends() and the ACCESS_ONCE().  This
 377  * is useful in cases where update-side locks prevent the value of the
 378  * pointer from changing.  Please note that this primitive does -not-
 379  * prevent the compiler from repeating this reference or combining it
 380  * with other references, so it should not be used without protection
 381  * of appropriate locks.
 382  *
 383  * This function is only for update-side use.  Using this function
 384  * when protected only by rcu_read_lock() will result in infrequent
 385  * but very ugly failures.
 386  */
 387 #define rcu_dereference_protected(p, c) \
 388         __rcu_dereference_protected((p), (c), __rcu)
 389
 390 /**
 391  * rcu_dereference_bh_protected() - fetch RCU-bh pointer when updates prevented
 392  * @p: The pointer to read, prior to dereferencing
 393  * @c: The conditions under which the dereference will take place
 394  *
 395  * This is the RCU-bh counterpart to rcu_dereference_protected().
 396  */
 397 #define rcu_dereference_bh_protected(p, c) \
 398         __rcu_dereference_protected((p), (c), __rcu)
 399
 400 /**
 401  * rcu_dereference_sched_protected() - fetch RCU-sched pointer when updates prevented
 402  * @p: The pointer to read, prior to dereferencing
 403  * @c: The conditions under which the dereference will take place
 404  *
 405  * This is the RCU-sched counterpart to rcu_dereference_protected().
 406  */
 407 #define rcu_dereference_sched_protected(p, c) \
 408         __rcu_dereference_protected((p), (c), __rcu)
 409
 410
 411 /**
 412  * rcu_dereference() - fetch RCU-protected pointer for dereferencing
 413  * @p: The pointer to read, prior to dereferencing
 414  *
 415  * This is a simple wrapper around rcu_dereference_check().
 416  */
 417 #define rcu_dereference(p) rcu_dereference_check(p, 0)
 418
 419 /**
 420  * rcu_dereference_bh() - fetch an RCU-bh-protected pointer for dereferencing
 421  * @p: The pointer to read, prior to dereferencing
 422  *
 423  * Makes rcu_dereference_check() do the dirty work.
 424  */
 425 #define rcu_dereference_bh(p) rcu_dereference_bh_check(p, 0)
 426
 427 /**
 428  * rcu_dereference_sched() - fetch RCU-sched-protected pointer for dereferencing
 429  * @p: The pointer to read, prior to dereferencing
 430  *
 431  * Makes rcu_dereference_check() do the dirty work.
 432  */
 433 #define rcu_dereference_sched(p) rcu_dereference_sched_check(p, 0)
 434
 435 /**
 436  * rcu_read_lock() - mark the beginning of an RCU read-side critical section
 437  *
 438  * When synchronize_rcu() is invoked on one CPU while other CPUs
 439  * are within RCU read-side critical sections, then the
 440  * synchronize_rcu() is guaranteed to block until after all the other
 441  * CPUs exit their critical sections.  Similarly, if call_rcu() is invoked
 442  * on one CPU while other CPUs are within RCU read-side critical
 443  * sections, invocation of the corresponding RCU callback is deferred
 444  * until after the all the other CPUs exit their critical sections.
 445  *
 446  * Note, however, that RCU callbacks are permitted to run concurrently
 447  * with new RCU read-side critical sections.  One way that this can happen
 448  * is via the following sequence of events: (1) CPU 0 enters an RCU
 449  * read-side critical section, (2) CPU 1 invokes call_rcu() to register
 450  * an RCU callback, (3) CPU 0 exits the RCU read-side critical section,
 451  * (4) CPU 2 enters a RCU read-side critical section, (5) the RCU
 452  * callback is invoked.  This is legal, because the RCU read-side critical
 453  * section that was running concurrently with the call_rcu() (and which
 454  * therefore might be referencing something that the corresponding RCU
 455  * callback would free up) has completed before the corresponding
 456  * RCU callback is invoked.
 457  *
 458  * RCU read-side critical sections may be nested.  Any deferred actions
 459  * will be deferred until the outermost RCU read-side critical section
 460  * completes.
 461  *
 462  * It is illegal to block while in an RCU read-side critical section.
 463  */
 464 static inline void rcu_read_lock(void)
 465 {
 466         __rcu_read_lock();
 467         __acquire(RCU);
 468         rcu_read_acquire();
 469 }
 470
 471 /*
 472  * So where is rcu_write_lock()?  It does not exist, as there is no
 473  * way for writers to lock out RCU readers.  This is a feature, not
 474  * a bug -- this property is what provides RCU's performance benefits.
 475  * Of course, writers must coordinate with each other.  The normal
 476  * spinlock primitives work well for this, but any other technique may be
 477  * used as well.  RCU does not care how the writers keep out of each
 478  * others' way, as long as they do so.
 479  */
 480
 481 /**
 482  * rcu_read_unlock() - marks the end of an RCU read-side critical section.
 483  *
 484  * See rcu_read_lock() for more information.
 485  */
 486 static inline void rcu_read_unlock(void)
 487 {
 488         rcu_read_release();
 489         __release(RCU);
 490         __rcu_read_unlock();
 491 }
 492
 493 /**
 494  * rcu_read_lock_bh() - mark the beginning of an RCU-bh critical section
 495  *
 496  * This is equivalent of rcu_read_lock(), but to be used when updates
 497  * are being done using call_rcu_bh() or synchronize_rcu_bh(). Since
 498  * both call_rcu_bh() and synchronize_rcu_bh() consider completion of a
 499  * softirq handler to be a quiescent state, a process in RCU read-side
 500  * critical section must be protected by disabling softirqs. Read-side
 501  * critical sections in interrupt context can use just rcu_read_lock(),
 502  * though this should at least be commented to avoid confusing people
 503  * reading the code.
 504  */
 505 static inline void rcu_read_lock_bh(void)
 506 {
 507         __rcu_read_lock_bh();
 508         __acquire(RCU_BH);
 509         rcu_read_acquire_bh();
 510 }
 511
 512 /*
 513  * rcu_read_unlock_bh - marks the end of a softirq-only RCU critical section
 514  *
 515  * See rcu_read_lock_bh() for more information.
 516  */
 517 static inline void rcu_read_unlock_bh(void)
 518 {
 519         rcu_read_release_bh();
 520         __release(RCU_BH);
 521         __rcu_read_unlock_bh();
 522 }
 523
 524 /**
 525  * rcu_read_lock_sched() - mark the beginning of a RCU-sched critical section
 526  *
 527  * This is equivalent of rcu_read_lock(), but to be used when updates
 528  * are being done using call_rcu_sched() or synchronize_rcu_sched().
 529  * Read-side critical sections can also be introduced by anything that
 530  * disables preemption, including local_irq_disable() and friends.
 531  */
 532 static inline void rcu_read_lock_sched(void)
 533 {
 534         preempt_disable();
 535         __acquire(RCU_SCHED);
 536         rcu_read_acquire_sched();
 537 }
 538
 539 /* Used by lockdep and tracing: cannot be traced, cannot call lockdep. */
 540 static inline notrace void rcu_read_lock_sched_notrace(void)
 541 {
 542         preempt_disable_notrace();
 543         __acquire(RCU_SCHED);
 544 }
 545
 546 /*
 547  * rcu_read_unlock_sched - marks the end of a RCU-classic critical section
 548  *
 549  * See rcu_read_lock_sched for more information.
 550  */
 551 static inline void rcu_read_unlock_sched(void)
 552 {
 553         rcu_read_release_sched();
 554         __release(RCU_SCHED);
 555         preempt_enable();
 556 }
 557
 558 /* Used by lockdep and tracing: cannot be traced, cannot call lockdep. */
 559 static inline notrace void rcu_read_unlock_sched_notrace(void)
 560 {
 561         __release(RCU_SCHED);
 562         preempt_enable_notrace();
 563 }
 564
 565 /**
 566  * rcu_assign_pointer() - assign to RCU-protected pointer
 567  * @p: pointer to assign to
 568  * @v: value to assign (publish)
 569  *
 570  * Assigns the specified value to the specified RCU-protected
 571  * pointer, ensuring that any concurrent RCU readers will see
 572  * any prior initialization.  Returns the value assigned.
 573  *
 574  * Inserts memory barriers on architectures that require them
 575  * (pretty much all of them other than x86), and also prevents
 576  * the compiler from reordering the code that initializes the
 577  * structure after the pointer assignment.  More importantly, this
 578  * call documents which pointers will be dereferenced by RCU read-side
 579  * code.
 580  */
 581 #define rcu_assign_pointer(p, v) \
 582         __rcu_assign_pointer((p), (v), __rcu)
 583
 584 /**
 585  * RCU_INIT_POINTER() - initialize an RCU protected pointer
 586  *
 587  * Initialize an RCU-protected pointer in such a way to avoid RCU-lockdep
 588  * splats.
 589  */
 590 #define RCU_INIT_POINTER(p, v) \
 591                 p = (typeof(*v) __force __rcu *)(v)
 592
 593 /* Infrastructure to implement the synchronize_() primitives. */
 594
 595 struct rcu_synchronize {
 596         struct rcu_head head;
 597         struct completion completion;
 598 };
 599
 600 extern void wakeme_after_rcu(struct rcu_head  *head);
 601
 602 /**
 603  * call_rcu() - Queue an RCU callback for invocation after a grace period.
 604  * @head: structure to be used for queueing the RCU updates.
 605  * @func: actual callback function to be invoked after the grace period
 606  *
 607  * The callback function will be invoked some time after a full grace
 608  * period elapses, in other words after all pre-existing RCU read-side
 609  * critical sections have completed.  However, the callback function
 610  * might well execute concurrently with RCU read-side critical sections
 611  * that started after call_rcu() was invoked.  RCU read-side critical
 612  * sections are delimited by rcu_read_lock() and rcu_read_unlock(),
 613  * and may be nested.
 614  */
 615 extern void call_rcu(struct rcu_head *head,
 616                               void (*func)(struct rcu_head *head));
 617
 618 /**
 619  * call_rcu_bh() - Queue an RCU for invocation after a quicker grace period.
 620  * @head: structure to be used for queueing the RCU updates.
 621  * @func: actual callback function to be invoked after the grace period
 622  *
 623  * The callback 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  */
 636 extern void call_rcu_bh(struct rcu_head *head,
 637                         void (*func)(struct rcu_head *head));
 638
 639 /*
 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
 649 extern struct debug_obj_descr rcuhead_debug_descr;
 650
 651 static 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
 659 static 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 */
 667 static inline void debug_rcu_head_queue(struct rcu_head *head)
 668 {
 669 }
 670
 671 static inline void debug_rcu_head_unqueue(struct rcu_head *head)
 672 {
 673 }
 674 #endif  /* #else !CONFIG_DEBUG_OBJECTS_RCU_HEAD */
 675
 676 #endif /* __LINUX_RCUPDATE_H */