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, you can access it online at
  16  * http://www.gnu.org/licenses/gpl-2.0.html.
  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/types.h>
  37 #include <linux/cache.h>
  38 #include <linux/spinlock.h>
  39 #include <linux/threads.h>
  40 #include <linux/cpumask.h>
  41 #include <linux/seqlock.h>
  42 #include <linux/lockdep.h>
  43 #include <linux/debugobjects.h>
  44 #include <linux/bug.h>
  45 #include <linux/compiler.h>
  46 #include <linux/ktime.h>
  47 #include <linux/irqflags.h>
  48
  49 enum rcutorture_type {
  50         RCU_FLAVOR,
  51         RCU_BH_FLAVOR,
  52         RCU_SCHED_FLAVOR,
  53         RCU_TASKS_FLAVOR,
  54         SRCU_FLAVOR,
  55         INVALID_RCU_FLAVOR
  56 };
  57
  58 #if defined(CONFIG_TREE_RCU) || defined(CONFIG_PREEMPT_RCU)
  59 void rcutorture_get_gp_data(enum rcutorture_type test_type, int *flags,
  60                             unsigned long *gpnum, unsigned long *completed);
  61 void rcutorture_record_test_transition(void);
  62 void rcutorture_record_progress(unsigned long vernum);
  63 void do_trace_rcu_torture_read(const char *rcutorturename,
  64                                struct rcu_head *rhp,
  65                                unsigned long secs,
  66                                unsigned long c_old,
  67                                unsigned long c);
  68 bool rcu_irq_enter_disabled(void);
  69 #else
  70 static inline void rcutorture_get_gp_data(enum rcutorture_type test_type,
  71                                           int *flags,
  72                                           unsigned long *gpnum,
  73                                           unsigned long *completed)
  74 {
  75         *flags = 0;
  76         *gpnum = 0;
  77         *completed = 0;
  78 }
  79 static inline void rcutorture_record_test_transition(void)
  80 {
  81 }
  82 static inline void rcutorture_record_progress(unsigned long vernum)
  83 {
  84 }
  85 static inline bool rcu_irq_enter_disabled(void)
  86 {
  87         return false;
  88 }
  89 #ifdef CONFIG_RCU_TRACE
  90 void do_trace_rcu_torture_read(const char *rcutorturename,
  91                                struct rcu_head *rhp,
  92                                unsigned long secs,
  93                                unsigned long c_old,
  94                                unsigned long c);
  95 #else
  96 #define do_trace_rcu_torture_read(rcutorturename, rhp, secs, c_old, c) \
  97         do { } while (0)
  98 #endif
  99 #endif
 100
 101 #define UINT_CMP_GE(a, b)       (UINT_MAX / 2 >= (a) - (b))
 102 #define UINT_CMP_LT(a, b)       (UINT_MAX / 2 < (a) - (b))
 103 #define ULONG_CMP_GE(a, b)      (ULONG_MAX / 2 >= (a) - (b))
 104 #define ULONG_CMP_LT(a, b)      (ULONG_MAX / 2 < (a) - (b))
 105 #define ulong2long(a)           (*(long *)(&(a)))
 106
 107 /* Exported common interfaces */
 108
 109 #ifdef CONFIG_PREEMPT_RCU
 110 void call_rcu(struct rcu_head *head, rcu_callback_t func);
 111 #else /* #ifdef CONFIG_PREEMPT_RCU */
 112 #define call_rcu        call_rcu_sched
 113 #endif /* #else #ifdef CONFIG_PREEMPT_RCU */
 114
 115 void call_rcu_bh(struct rcu_head *head, rcu_callback_t func);
 116 void call_rcu_sched(struct rcu_head *head, rcu_callback_t func);
 117 void synchronize_sched(void);
 118 void call_rcu_tasks(struct rcu_head *head, rcu_callback_t func);
 119 void synchronize_rcu_tasks(void);
 120 void rcu_barrier_tasks(void);
 121
 122 #ifdef CONFIG_PREEMPT_RCU
 123
 124 void __rcu_read_lock(void);
 125 void __rcu_read_unlock(void);
 126 void rcu_read_unlock_special(struct task_struct *t);
 127 void synchronize_rcu(void);
 128
 129 /*
 130  * Defined as a macro as it is a very low level header included from
 131  * areas that don't even know about current.  This gives the rcu_read_lock()
 132  * nesting depth, but makes sense only if CONFIG_PREEMPT_RCU -- in other
 133  * types of kernel builds, the rcu_read_lock() nesting depth is unknowable.
 134  */
 135 #define rcu_preempt_depth() (current->rcu_read_lock_nesting)
 136
 137 #else /* #ifdef CONFIG_PREEMPT_RCU */
 138
 139 static inline void __rcu_read_lock(void)
 140 {
 141         if (IS_ENABLED(CONFIG_PREEMPT_COUNT))
 142                 preempt_disable();
 143 }
 144
 145 static inline void __rcu_read_unlock(void)
 146 {
 147         if (IS_ENABLED(CONFIG_PREEMPT_COUNT))
 148                 preempt_enable();
 149 }
 150
 151 static inline void synchronize_rcu(void)
 152 {
 153         synchronize_sched();
 154 }
 155
 156 static inline int rcu_preempt_depth(void)
 157 {
 158         return 0;
 159 }
 160
 161 #endif /* #else #ifdef CONFIG_PREEMPT_RCU */
 162
 163 /* Internal to kernel */
 164 void rcu_init(void);
 165 void rcu_sched_qs(void);
 166 void rcu_bh_qs(void);
 167 void rcu_check_callbacks(int user);
 168 void rcu_report_dead(unsigned int cpu);
 169 void rcu_cpu_starting(unsigned int cpu);
 170
 171 #ifndef CONFIG_TINY_RCU
 172 void rcu_end_inkernel_boot(void);
 173 #else /* #ifndef CONFIG_TINY_RCU */
 174 static inline void rcu_end_inkernel_boot(void) { }
 175 #endif /* #ifndef CONFIG_TINY_RCU */
 176
 177 #ifdef CONFIG_RCU_STALL_COMMON
 178 void rcu_sysrq_start(void);
 179 void rcu_sysrq_end(void);
 180 #else /* #ifdef CONFIG_RCU_STALL_COMMON */
 181 static inline void rcu_sysrq_start(void)
 182 {
 183 }
 184 static inline void rcu_sysrq_end(void)
 185 {
 186 }
 187 #endif /* #else #ifdef CONFIG_RCU_STALL_COMMON */
 188
 189 #ifdef CONFIG_NO_HZ_FULL
 190 void rcu_user_enter(void);
 191 void rcu_user_exit(void);
 192 #else
 193 static inline void rcu_user_enter(void) { }
 194 static inline void rcu_user_exit(void) { }
 195 #endif /* CONFIG_NO_HZ_FULL */
 196
 197 #ifdef CONFIG_RCU_NOCB_CPU
 198 void rcu_init_nohz(void);
 199 #else /* #ifdef CONFIG_RCU_NOCB_CPU */
 200 static inline void rcu_init_nohz(void)
 201 {
 202 }
 203 #endif /* #else #ifdef CONFIG_RCU_NOCB_CPU */
 204
 205 /**
 206  * RCU_NONIDLE - Indicate idle-loop code that needs RCU readers
 207  * @a: Code that RCU needs to pay attention to.
 208  *
 209  * RCU, RCU-bh, and RCU-sched read-side critical sections are forbidden
 210  * in the inner idle loop, that is, between the rcu_idle_enter() and
 211  * the rcu_idle_exit() -- RCU will happily ignore any such read-side
 212  * critical sections.  However, things like powertop need tracepoints
 213  * in the inner idle loop.
 214  *
 215  * This macro provides the way out:  RCU_NONIDLE(do_something_with_RCU())
 216  * will tell RCU that it needs to pay attention, invoke its argument
 217  * (in this example, calling the do_something_with_RCU() function),
 218  * and then tell RCU to go back to ignoring this CPU.  It is permissible
 219  * to nest RCU_NONIDLE() wrappers, but not indefinitely (but the limit is
 220  * on the order of a million or so, even on 32-bit systems).  It is
 221  * not legal to block within RCU_NONIDLE(), nor is it permissible to
 222  * transfer control either into or out of RCU_NONIDLE()'s statement.
 223  */
 224 #define RCU_NONIDLE(a) \
 225         do { \
 226                 rcu_irq_enter_irqson(); \
 227                 do { a; } while (0); \
 228                 rcu_irq_exit_irqson(); \
 229         } while (0)
 230
 231 /*
 232  * Note a voluntary context switch for RCU-tasks benefit.  This is a
 233  * macro rather than an inline function to avoid #include hell.
 234  */
 235 #ifdef CONFIG_TASKS_RCU
 236 #define TASKS_RCU(x) x
 237 extern struct srcu_struct tasks_rcu_exit_srcu;
 238 #define rcu_note_voluntary_context_switch_lite(t) \
 239         do { \
 240                 if (READ_ONCE((t)->rcu_tasks_holdout)) \
 241                         WRITE_ONCE((t)->rcu_tasks_holdout, false); \
 242         } while (0)
 243 #define rcu_note_voluntary_context_switch(t) \
 244         do { \
 245                 rcu_all_qs(); \
 246                 rcu_note_voluntary_context_switch_lite(t); \
 247         } while (0)
 248 #else /* #ifdef CONFIG_TASKS_RCU */
 249 #define TASKS_RCU(x) do { } while (0)
 250 #define rcu_note_voluntary_context_switch_lite(t)       do { } while (0)
 251 #define rcu_note_voluntary_context_switch(t)            rcu_all_qs()
 252 #endif /* #else #ifdef CONFIG_TASKS_RCU */
 253
 254 /**
 255  * cond_resched_rcu_qs - Report potential quiescent states to RCU
 256  *
 257  * This macro resembles cond_resched(), except that it is defined to
 258  * report potential quiescent states to RCU-tasks even if the cond_resched()
 259  * machinery were to be shut off, as some advocate for PREEMPT kernels.
 260  */
 261 #define cond_resched_rcu_qs() \
 262 do { \
 263         if (!cond_resched()) \
 264                 rcu_note_voluntary_context_switch(current); \
 265 } while (0)
 266
 267 #if defined(CONFIG_DEBUG_LOCK_ALLOC) || defined(CONFIG_RCU_TRACE) || defined(CONFIG_SMP)
 268 bool __rcu_is_watching(void);
 269 #endif /* #if defined(CONFIG_DEBUG_LOCK_ALLOC) || defined(CONFIG_RCU_TRACE) || defined(CONFIG_SMP) */
 270
 271 /*
 272  * Infrastructure to implement the synchronize_() primitives in
 273  * TREE_RCU and rcu_barrier_() primitives in TINY_RCU.
 274  */
 275
 276 #if defined(CONFIG_TREE_RCU) || defined(CONFIG_PREEMPT_RCU)
 277 #include <linux/rcutree.h>
 278 #elif defined(CONFIG_TINY_RCU)
 279 #include <linux/rcutiny.h>
 280 #else
 281 #error "Unknown RCU implementation specified to kernel configuration"
 282 #endif
 283
 284 #define RCU_SCHEDULER_INACTIVE  0
 285 #define RCU_SCHEDULER_INIT      1
 286 #define RCU_SCHEDULER_RUNNING   2
 287
 288 /*
 289  * init_rcu_head_on_stack()/destroy_rcu_head_on_stack() are needed for dynamic
 290  * initialization and destruction of rcu_head on the stack. rcu_head structures
 291  * allocated dynamically in the heap or defined statically don't need any
 292  * initialization.
 293  */
 294 #ifdef CONFIG_DEBUG_OBJECTS_RCU_HEAD
 295 void init_rcu_head(struct rcu_head *head);
 296 void destroy_rcu_head(struct rcu_head *head);
 297 void init_rcu_head_on_stack(struct rcu_head *head);
 298 void destroy_rcu_head_on_stack(struct rcu_head *head);
 299 #else /* !CONFIG_DEBUG_OBJECTS_RCU_HEAD */
 300 static inline void init_rcu_head(struct rcu_head *head)
 301 {
 302 }
 303
 304 static inline void destroy_rcu_head(struct rcu_head *head)
 305 {
 306 }
 307
 308 static inline void init_rcu_head_on_stack(struct rcu_head *head)
 309 {
 310 }
 311
 312 static inline void destroy_rcu_head_on_stack(struct rcu_head *head)
 313 {
 314 }
 315 #endif  /* #else !CONFIG_DEBUG_OBJECTS_RCU_HEAD */
 316
 317 #if defined(CONFIG_HOTPLUG_CPU) && defined(CONFIG_PROVE_RCU)
 318 bool rcu_lockdep_current_cpu_online(void);
 319 #else /* #if defined(CONFIG_HOTPLUG_CPU) && defined(CONFIG_PROVE_RCU) */
 320 static inline bool rcu_lockdep_current_cpu_online(void)
 321 {
 322         return true;
 323 }
 324 #endif /* #else #if defined(CONFIG_HOTPLUG_CPU) && defined(CONFIG_PROVE_RCU) */
 325
 326 #ifdef CONFIG_DEBUG_LOCK_ALLOC
 327
 328 static inline void rcu_lock_acquire(struct lockdep_map *map)
 329 {
 330         lock_acquire(map, 0, 0, 2, 0, NULL, _THIS_IP_);
 331 }
 332
 333 static inline void rcu_lock_release(struct lockdep_map *map)
 334 {
 335         lock_release(map, 1, _THIS_IP_);
 336 }
 337
 338 extern struct lockdep_map rcu_lock_map;
 339 extern struct lockdep_map rcu_bh_lock_map;
 340 extern struct lockdep_map rcu_sched_lock_map;
 341 extern struct lockdep_map rcu_callback_map;
 342 int debug_lockdep_rcu_enabled(void);
 343 int rcu_read_lock_held(void);
 344 int rcu_read_lock_bh_held(void);
 345 int rcu_read_lock_sched_held(void);
 346
 347 #else /* #ifdef CONFIG_DEBUG_LOCK_ALLOC */
 348
 349 # define rcu_lock_acquire(a)            do { } while (0)
 350 # define rcu_lock_release(a)            do { } while (0)
 351
 352 static inline int rcu_read_lock_held(void)
 353 {
 354         return 1;
 355 }
 356
 357 static inline int rcu_read_lock_bh_held(void)
 358 {
 359         return 1;
 360 }
 361
 362 static inline int rcu_read_lock_sched_held(void)
 363 {
 364         return !preemptible();
 365 }
 366 #endif /* #else #ifdef CONFIG_DEBUG_LOCK_ALLOC */
 367
 368 #ifdef CONFIG_PROVE_RCU
 369
 370 /**
 371  * RCU_LOCKDEP_WARN - emit lockdep splat if specified condition is met
 372  * @c: condition to check
 373  * @s: informative message
 374  */
 375 #define RCU_LOCKDEP_WARN(c, s)                                          \
 376         do {                                                            \
 377                 static bool __section(.data.unlikely) __warned;         \
 378                 if (debug_lockdep_rcu_enabled() && !__warned && (c)) {  \
 379                         __warned = true;                                \
 380                         lockdep_rcu_suspicious(__FILE__, __LINE__, s);  \
 381                 }                                                       \
 382         } while (0)
 383
 384 #if defined(CONFIG_PROVE_RCU) && !defined(CONFIG_PREEMPT_RCU)
 385 static inline void rcu_preempt_sleep_check(void)
 386 {
 387         RCU_LOCKDEP_WARN(lock_is_held(&rcu_lock_map),
 388                          "Illegal context switch in RCU read-side critical section");
 389 }
 390 #else /* #ifdef CONFIG_PROVE_RCU */
 391 static inline void rcu_preempt_sleep_check(void)
 392 {
 393 }
 394 #endif /* #else #ifdef CONFIG_PROVE_RCU */
 395
 396 #define rcu_sleep_check()                                               \
 397         do {                                                            \
 398                 rcu_preempt_sleep_check();                              \
 399                 RCU_LOCKDEP_WARN(lock_is_held(&rcu_bh_lock_map),        \
 400                                  "Illegal context switch in RCU-bh read-side critical section"); \
 401                 RCU_LOCKDEP_WARN(lock_is_held(&rcu_sched_lock_map),     \
 402                                  "Illegal context switch in RCU-sched read-side critical section"); \
 403         } while (0)
 404
 405 #else /* #ifdef CONFIG_PROVE_RCU */
 406
 407 #define RCU_LOCKDEP_WARN(c, s) do { } while (0)
 408 #define rcu_sleep_check() do { } while (0)
 409
 410 #endif /* #else #ifdef CONFIG_PROVE_RCU */
 411
 412 /*
 413  * Helper functions for rcu_dereference_check(), rcu_dereference_protected()
 414  * and rcu_assign_pointer().  Some of these could be folded into their
 415  * callers, but they are left separate in order to ease introduction of
 416  * multiple flavors of pointers to match the multiple flavors of RCU
 417  * (e.g., __rcu_bh, * __rcu_sched, and __srcu), should this make sense in
 418  * the future.
 419  */
 420
 421 #ifdef __CHECKER__
 422 #define rcu_dereference_sparse(p, space) \
 423         ((void)(((typeof(*p) space *)p) == p))
 424 #else /* #ifdef __CHECKER__ */
 425 #define rcu_dereference_sparse(p, space)
 426 #endif /* #else #ifdef __CHECKER__ */
 427
 428 #define __rcu_access_pointer(p, space) \
 429 ({ \
 430         typeof(*p) *_________p1 = (typeof(*p) *__force)READ_ONCE(p); \
 431         rcu_dereference_sparse(p, space); \
 432         ((typeof(*p) __force __kernel *)(_________p1)); \
 433 })
 434 #define __rcu_dereference_check(p, c, space) \
 435 ({ \
 436         /* Dependency order vs. p above. */ \
 437         typeof(*p) *________p1 = (typeof(*p) *__force)lockless_dereference(p); \
 438         RCU_LOCKDEP_WARN(!(c), "suspicious rcu_dereference_check() usage"); \
 439         rcu_dereference_sparse(p, space); \
 440         ((typeof(*p) __force __kernel *)(________p1)); \
 441 })
 442 #define __rcu_dereference_protected(p, c, space) \
 443 ({ \
 444         RCU_LOCKDEP_WARN(!(c), "suspicious rcu_dereference_protected() usage"); \
 445         rcu_dereference_sparse(p, space); \
 446         ((typeof(*p) __force __kernel *)(p)); \
 447 })
 448 #define rcu_dereference_raw(p) \
 449 ({ \
 450         /* Dependency order vs. p above. */ \
 451         typeof(p) ________p1 = lockless_dereference(p); \
 452         ((typeof(*p) __force __kernel *)(________p1)); \
 453 })
 454
 455 /**
 456  * RCU_INITIALIZER() - statically initialize an RCU-protected global variable
 457  * @v: The value to statically initialize with.
 458  */
 459 #define RCU_INITIALIZER(v) (typeof(*(v)) __force __rcu *)(v)
 460
 461 /**
 462  * rcu_assign_pointer() - assign to RCU-protected pointer
 463  * @p: pointer to assign to
 464  * @v: value to assign (publish)
 465  *
 466  * Assigns the specified value to the specified RCU-protected
 467  * pointer, ensuring that any concurrent RCU readers will see
 468  * any prior initialization.
 469  *
 470  * Inserts memory barriers on architectures that require them
 471  * (which is most of them), and also prevents the compiler from
 472  * reordering the code that initializes the structure after the pointer
 473  * assignment.  More importantly, this call documents which pointers
 474  * will be dereferenced by RCU read-side code.
 475  *
 476  * In some special cases, you may use RCU_INIT_POINTER() instead
 477  * of rcu_assign_pointer().  RCU_INIT_POINTER() is a bit faster due
 478  * to the fact that it does not constrain either the CPU or the compiler.
 479  * That said, using RCU_INIT_POINTER() when you should have used
 480  * rcu_assign_pointer() is a very bad thing that results in
 481  * impossible-to-diagnose memory corruption.  So please be careful.
 482  * See the RCU_INIT_POINTER() comment header for details.
 483  *
 484  * Note that rcu_assign_pointer() evaluates each of its arguments only
 485  * once, appearances notwithstanding.  One of the "extra" evaluations
 486  * is in typeof() and the other visible only to sparse (__CHECKER__),
 487  * neither of which actually execute the argument.  As with most cpp
 488  * macros, this execute-arguments-only-once property is important, so
 489  * please be careful when making changes to rcu_assign_pointer() and the
 490  * other macros that it invokes.
 491  */
 492 #define rcu_assign_pointer(p, v)                                              \
 493 ({                                                                            \
 494         uintptr_t _r_a_p__v = (uintptr_t)(v);                                 \
 495                                                                               \
 496         if (__builtin_constant_p(v) && (_r_a_p__v) == (uintptr_t)NULL)        \
 497                 WRITE_ONCE((p), (typeof(p))(_r_a_p__v));                      \
 498         else                                                                  \
 499                 smp_store_release(&p, RCU_INITIALIZER((typeof(p))_r_a_p__v)); \
 500         _r_a_p__v;                                                            \
 501 })
 502
 503 /**
 504  * rcu_access_pointer() - fetch RCU pointer with no dereferencing
 505  * @p: The pointer to read
 506  *
 507  * Return the value of the specified RCU-protected pointer, but omit the
 508  * smp_read_barrier_depends() and keep the READ_ONCE().  This is useful
 509  * when the value of this pointer is accessed, but the pointer is not
 510  * dereferenced, for example, when testing an RCU-protected pointer against
 511  * NULL.  Although rcu_access_pointer() may also be used in cases where
 512  * update-side locks prevent the value of the pointer from changing, you
 513  * should instead use rcu_dereference_protected() for this use case.
 514  *
 515  * It is also permissible to use rcu_access_pointer() when read-side
 516  * access to the pointer was removed at least one grace period ago, as
 517  * is the case in the context of the RCU callback that is freeing up
 518  * the data, or after a synchronize_rcu() returns.  This can be useful
 519  * when tearing down multi-linked structures after a grace period
 520  * has elapsed.
 521  */
 522 #define rcu_access_pointer(p) __rcu_access_pointer((p), __rcu)
 523
 524 /**
 525  * rcu_dereference_check() - rcu_dereference with debug checking
 526  * @p: The pointer to read, prior to dereferencing
 527  * @c: The conditions under which the dereference will take place
 528  *
 529  * Do an rcu_dereference(), but check that the conditions under which the
 530  * dereference will take place are correct.  Typically the conditions
 531  * indicate the various locking conditions that should be held at that
 532  * point.  The check should return true if the conditions are satisfied.
 533  * An implicit check for being in an RCU read-side critical section
 534  * (rcu_read_lock()) is included.
 535  *
 536  * For example:
 537  *
 538  *      bar = rcu_dereference_check(foo->bar, lockdep_is_held(&foo->lock));
 539  *
 540  * could be used to indicate to lockdep that foo->bar may only be dereferenced
 541  * if either rcu_read_lock() is held, or that the lock required to replace
 542  * the bar struct at foo->bar is held.
 543  *
 544  * Note that the list of conditions may also include indications of when a lock
 545  * need not be held, for example during initialisation or destruction of the
 546  * target struct:
 547  *
 548  *      bar = rcu_dereference_check(foo->bar, lockdep_is_held(&foo->lock) ||
 549  *                                            atomic_read(&foo->usage) == 0);
 550  *
 551  * Inserts memory barriers on architectures that require them
 552  * (currently only the Alpha), prevents the compiler from refetching
 553  * (and from merging fetches), and, more importantly, documents exactly
 554  * which pointers are protected by RCU and checks that the pointer is
 555  * annotated as __rcu.
 556  */
 557 #define rcu_dereference_check(p, c) \
 558         __rcu_dereference_check((p), (c) || rcu_read_lock_held(), __rcu)
 559
 560 /**
 561  * rcu_dereference_bh_check() - rcu_dereference_bh with debug checking
 562  * @p: The pointer to read, prior to dereferencing
 563  * @c: The conditions under which the dereference will take place
 564  *
 565  * This is the RCU-bh counterpart to rcu_dereference_check().
 566  */
 567 #define rcu_dereference_bh_check(p, c) \
 568         __rcu_dereference_check((p), (c) || rcu_read_lock_bh_held(), __rcu)
 569
 570 /**
 571  * rcu_dereference_sched_check() - rcu_dereference_sched with debug checking
 572  * @p: The pointer to read, prior to dereferencing
 573  * @c: The conditions under which the dereference will take place
 574  *
 575  * This is the RCU-sched counterpart to rcu_dereference_check().
 576  */
 577 #define rcu_dereference_sched_check(p, c) \
 578         __rcu_dereference_check((p), (c) || rcu_read_lock_sched_held(), \
 579                                 __rcu)
 580
 581 /*
 582  * The tracing infrastructure traces RCU (we want that), but unfortunately
 583  * some of the RCU checks causes tracing to lock up the system.
 584  *
 585  * The no-tracing version of rcu_dereference_raw() must not call
 586  * rcu_read_lock_held().
 587  */
 588 #define rcu_dereference_raw_notrace(p) __rcu_dereference_check((p), 1, __rcu)
 589
 590 /**
 591  * rcu_dereference_protected() - fetch RCU pointer when updates prevented
 592  * @p: The pointer to read, prior to dereferencing
 593  * @c: The conditions under which the dereference will take place
 594  *
 595  * Return the value of the specified RCU-protected pointer, but omit
 596  * both the smp_read_barrier_depends() and the READ_ONCE().  This
 597  * is useful in cases where update-side locks prevent the value of the
 598  * pointer from changing.  Please note that this primitive does -not-
 599  * prevent the compiler from repeating this reference or combining it
 600  * with other references, so it should not be used without protection
 601  * of appropriate locks.
 602  *
 603  * This function is only for update-side use.  Using this function
 604  * when protected only by rcu_read_lock() will result in infrequent
 605  * but very ugly failures.
 606  */
 607 #define rcu_dereference_protected(p, c) \
 608         __rcu_dereference_protected((p), (c), __rcu)
 609
 610
 611 /**
 612  * rcu_dereference() - fetch RCU-protected pointer for dereferencing
 613  * @p: The pointer to read, prior to dereferencing
 614  *
 615  * This is a simple wrapper around rcu_dereference_check().
 616  */
 617 #define rcu_dereference(p) rcu_dereference_check(p, 0)
 618
 619 /**
 620  * rcu_dereference_bh() - fetch an RCU-bh-protected pointer for dereferencing
 621  * @p: The pointer to read, prior to dereferencing
 622  *
 623  * Makes rcu_dereference_check() do the dirty work.
 624  */
 625 #define rcu_dereference_bh(p) rcu_dereference_bh_check(p, 0)
 626
 627 /**
 628  * rcu_dereference_sched() - fetch RCU-sched-protected pointer for dereferencing
 629  * @p: The pointer to read, prior to dereferencing
 630  *
 631  * Makes rcu_dereference_check() do the dirty work.
 632  */
 633 #define rcu_dereference_sched(p) rcu_dereference_sched_check(p, 0)
 634
 635 /**
 636  * rcu_pointer_handoff() - Hand off a pointer from RCU to other mechanism
 637  * @p: The pointer to hand off
 638  *
 639  * This is simply an identity function, but it documents where a pointer
 640  * is handed off from RCU to some other synchronization mechanism, for
 641  * example, reference counting or locking.  In C11, it would map to
 642  * kill_dependency().  It could be used as follows:
 643  *
 644  *      rcu_read_lock();
 645  *      p = rcu_dereference(gp);
 646  *      long_lived = is_long_lived(p);
 647  *      if (long_lived) {
 648  *              if (!atomic_inc_not_zero(p->refcnt))
 649  *                      long_lived = false;
 650  *              else
 651  *                      p = rcu_pointer_handoff(p);
 652  *      }
 653  *      rcu_read_unlock();
 654  */
 655 #define rcu_pointer_handoff(p) (p)
 656
 657 /**
 658  * rcu_read_lock() - mark the beginning of an RCU read-side critical section
 659  *
 660  * When synchronize_rcu() is invoked on one CPU while other CPUs
 661  * are within RCU read-side critical sections, then the
 662  * synchronize_rcu() is guaranteed to block until after all the other
 663  * CPUs exit their critical sections.  Similarly, if call_rcu() is invoked
 664  * on one CPU while other CPUs are within RCU read-side critical
 665  * sections, invocation of the corresponding RCU callback is deferred
 666  * until after the all the other CPUs exit their critical sections.
 667  *
 668  * Note, however, that RCU callbacks are permitted to run concurrently
 669  * with new RCU read-side critical sections.  One way that this can happen
 670  * is via the following sequence of events: (1) CPU 0 enters an RCU
 671  * read-side critical section, (2) CPU 1 invokes call_rcu() to register
 672  * an RCU callback, (3) CPU 0 exits the RCU read-side critical section,
 673  * (4) CPU 2 enters a RCU read-side critical section, (5) the RCU
 674  * callback is invoked.  This is legal, because the RCU read-side critical
 675  * section that was running concurrently with the call_rcu() (and which
 676  * therefore might be referencing something that the corresponding RCU
 677  * callback would free up) has completed before the corresponding
 678  * RCU callback is invoked.
 679  *
 680  * RCU read-side critical sections may be nested.  Any deferred actions
 681  * will be deferred until the outermost RCU read-side critical section
 682  * completes.
 683  *
 684  * You can avoid reading and understanding the next paragraph by
 685  * following this rule: don't put anything in an rcu_read_lock() RCU
 686  * read-side critical section that would block in a !PREEMPT kernel.
 687  * But if you want the full story, read on!
 688  *
 689  * In non-preemptible RCU implementations (TREE_RCU and TINY_RCU),
 690  * it is illegal to block while in an RCU read-side critical section.
 691  * In preemptible RCU implementations (PREEMPT_RCU) in CONFIG_PREEMPT
 692  * kernel builds, RCU read-side critical sections may be preempted,
 693  * but explicit blocking is illegal.  Finally, in preemptible RCU
 694  * implementations in real-time (with -rt patchset) kernel builds, RCU
 695  * read-side critical sections may be preempted and they may also block, but
 696  * only when acquiring spinlocks that are subject to priority inheritance.
 697  */
 698 static inline void rcu_read_lock(void)
 699 {
 700         __rcu_read_lock();
 701         __acquire(RCU);
 702         rcu_lock_acquire(&rcu_lock_map);
 703         RCU_LOCKDEP_WARN(!rcu_is_watching(),
 704                          "rcu_read_lock() used illegally while idle");
 705 }
 706
 707 /*
 708  * So where is rcu_write_lock()?  It does not exist, as there is no
 709  * way for writers to lock out RCU readers.  This is a feature, not
 710  * a bug -- this property is what provides RCU's performance benefits.
 711  * Of course, writers must coordinate with each other.  The normal
 712  * spinlock primitives work well for this, but any other technique may be
 713  * used as well.  RCU does not care how the writers keep out of each
 714  * others' way, as long as they do so.
 715  */
 716
 717 /**
 718  * rcu_read_unlock() - marks the end of an RCU read-side critical section.
 719  *
 720  * In most situations, rcu_read_unlock() is immune from deadlock.
 721  * However, in kernels built with CONFIG_RCU_BOOST, rcu_read_unlock()
 722  * is responsible for deboosting, which it does via rt_mutex_unlock().
 723  * Unfortunately, this function acquires the scheduler's runqueue and
 724  * priority-inheritance spinlocks.  This means that deadlock could result
 725  * if the caller of rcu_read_unlock() already holds one of these locks or
 726  * any lock that is ever acquired while holding them; or any lock which
 727  * can be taken from interrupt context because rcu_boost()->rt_mutex_lock()
 728  * does not disable irqs while taking ->wait_lock.
 729  *
 730  * That said, RCU readers are never priority boosted unless they were
 731  * preempted.  Therefore, one way to avoid deadlock is to make sure
 732  * that preemption never happens within any RCU read-side critical
 733  * section whose outermost rcu_read_unlock() is called with one of
 734  * rt_mutex_unlock()'s locks held.  Such preemption can be avoided in
 735  * a number of ways, for example, by invoking preempt_disable() before
 736  * critical section's outermost rcu_read_lock().
 737  *
 738  * Given that the set of locks acquired by rt_mutex_unlock() might change
 739  * at any time, a somewhat more future-proofed approach is to make sure
 740  * that that preemption never happens within any RCU read-side critical
 741  * section whose outermost rcu_read_unlock() is called with irqs disabled.
 742  * This approach relies on the fact that rt_mutex_unlock() currently only
 743  * acquires irq-disabled locks.
 744  *
 745  * The second of these two approaches is best in most situations,
 746  * however, the first approach can also be useful, at least to those
 747  * developers willing to keep abreast of the set of locks acquired by
 748  * rt_mutex_unlock().
 749  *
 750  * See rcu_read_lock() for more information.
 751  */
 752 static inline void rcu_read_unlock(void)
 753 {
 754         RCU_LOCKDEP_WARN(!rcu_is_watching(),
 755                          "rcu_read_unlock() used illegally while idle");
 756         __release(RCU);
 757         __rcu_read_unlock();
 758         rcu_lock_release(&rcu_lock_map); /* Keep acq info for rls diags. */
 759 }
 760
 761 /**
 762  * rcu_read_lock_bh() - mark the beginning of an RCU-bh critical section
 763  *
 764  * This is equivalent of rcu_read_lock(), but to be used when updates
 765  * are being done using call_rcu_bh() or synchronize_rcu_bh(). Since
 766  * both call_rcu_bh() and synchronize_rcu_bh() consider completion of a
 767  * softirq handler to be a quiescent state, a process in RCU read-side
 768  * critical section must be protected by disabling softirqs. Read-side
 769  * critical sections in interrupt context can use just rcu_read_lock(),
 770  * though this should at least be commented to avoid confusing people
 771  * reading the code.
 772  *
 773  * Note that rcu_read_lock_bh() and the matching rcu_read_unlock_bh()
 774  * must occur in the same context, for example, it is illegal to invoke
 775  * rcu_read_unlock_bh() from one task if the matching rcu_read_lock_bh()
 776  * was invoked from some other task.
 777  */
 778 static inline void rcu_read_lock_bh(void)
 779 {
 780         local_bh_disable();
 781         __acquire(RCU_BH);
 782         rcu_lock_acquire(&rcu_bh_lock_map);
 783         RCU_LOCKDEP_WARN(!rcu_is_watching(),
 784                          "rcu_read_lock_bh() used illegally while idle");
 785 }
 786
 787 /*
 788  * rcu_read_unlock_bh - marks the end of a softirq-only RCU critical section
 789  *
 790  * See rcu_read_lock_bh() for more information.
 791  */
 792 static inline void rcu_read_unlock_bh(void)
 793 {
 794         RCU_LOCKDEP_WARN(!rcu_is_watching(),
 795                          "rcu_read_unlock_bh() used illegally while idle");
 796         rcu_lock_release(&rcu_bh_lock_map);
 797         __release(RCU_BH);
 798         local_bh_enable();
 799 }
 800
 801 /**
 802  * rcu_read_lock_sched() - mark the beginning of a RCU-sched critical section
 803  *
 804  * This is equivalent of rcu_read_lock(), but to be used when updates
 805  * are being done using call_rcu_sched() or synchronize_rcu_sched().
 806  * Read-side critical sections can also be introduced by anything that
 807  * disables preemption, including local_irq_disable() and friends.
 808  *
 809  * Note that rcu_read_lock_sched() and the matching rcu_read_unlock_sched()
 810  * must occur in the same context, for example, it is illegal to invoke
 811  * rcu_read_unlock_sched() from process context if the matching
 812  * rcu_read_lock_sched() was invoked from an NMI handler.
 813  */
 814 static inline void rcu_read_lock_sched(void)
 815 {
 816         preempt_disable();
 817         __acquire(RCU_SCHED);
 818         rcu_lock_acquire(&rcu_sched_lock_map);
 819         RCU_LOCKDEP_WARN(!rcu_is_watching(),
 820                          "rcu_read_lock_sched() used illegally while idle");
 821 }
 822
 823 /* Used by lockdep and tracing: cannot be traced, cannot call lockdep. */
 824 static inline notrace void rcu_read_lock_sched_notrace(void)
 825 {
 826         preempt_disable_notrace();
 827         __acquire(RCU_SCHED);
 828 }
 829
 830 /*
 831  * rcu_read_unlock_sched - marks the end of a RCU-classic critical section
 832  *
 833  * See rcu_read_lock_sched for more information.
 834  */
 835 static inline void rcu_read_unlock_sched(void)
 836 {
 837         RCU_LOCKDEP_WARN(!rcu_is_watching(),
 838                          "rcu_read_unlock_sched() used illegally while idle");
 839         rcu_lock_release(&rcu_sched_lock_map);
 840         __release(RCU_SCHED);
 841         preempt_enable();
 842 }
 843
 844 /* Used by lockdep and tracing: cannot be traced, cannot call lockdep. */
 845 static inline notrace void rcu_read_unlock_sched_notrace(void)
 846 {
 847         __release(RCU_SCHED);
 848         preempt_enable_notrace();
 849 }
 850
 851 /**
 852  * RCU_INIT_POINTER() - initialize an RCU protected pointer
 853  *
 854  * Initialize an RCU-protected pointer in special cases where readers
 855  * do not need ordering constraints on the CPU or the compiler.  These
 856  * special cases are:
 857  *
 858  * 1.   This use of RCU_INIT_POINTER() is NULLing out the pointer -or-
 859  * 2.   The caller has taken whatever steps are required to prevent
 860  *      RCU readers from concurrently accessing this pointer -or-
 861  * 3.   The referenced data structure has already been exposed to
 862  *      readers either at compile time or via rcu_assign_pointer() -and-
 863  *      a.      You have not made -any- reader-visible changes to
 864  *              this structure since then -or-
 865  *      b.      It is OK for readers accessing this structure from its
 866  *              new location to see the old state of the structure.  (For
 867  *              example, the changes were to statistical counters or to
 868  *              other state where exact synchronization is not required.)
 869  *
 870  * Failure to follow these rules governing use of RCU_INIT_POINTER() will
 871  * result in impossible-to-diagnose memory corruption.  As in the structures
 872  * will look OK in crash dumps, but any concurrent RCU readers might
 873  * see pre-initialized values of the referenced data structure.  So
 874  * please be very careful how you use RCU_INIT_POINTER()!!!
 875  *
 876  * If you are creating an RCU-protected linked structure that is accessed
 877  * by a single external-to-structure RCU-protected pointer, then you may
 878  * use RCU_INIT_POINTER() to initialize the internal RCU-protected
 879  * pointers, but you must use rcu_assign_pointer() to initialize the
 880  * external-to-structure pointer -after- you have completely initialized
 881  * the reader-accessible portions of the linked structure.
 882  *
 883  * Note that unlike rcu_assign_pointer(), RCU_INIT_POINTER() provides no
 884  * ordering guarantees for either the CPU or the compiler.
 885  */
 886 #define RCU_INIT_POINTER(p, v) \
 887         do { \
 888                 rcu_dereference_sparse(p, __rcu); \
 889                 WRITE_ONCE(p, RCU_INITIALIZER(v)); \
 890         } while (0)
 891
 892 /**
 893  * RCU_POINTER_INITIALIZER() - statically initialize an RCU protected pointer
 894  *
 895  * GCC-style initialization for an RCU-protected pointer in a structure field.
 896  */
 897 #define RCU_POINTER_INITIALIZER(p, v) \
 898                 .p = RCU_INITIALIZER(v)
 899
 900 /*
 901  * Does the specified offset indicate that the corresponding rcu_head
 902  * structure can be handled by kfree_rcu()?
 903  */
 904 #define __is_kfree_rcu_offset(offset) ((offset) < 4096)
 905
 906 /*
 907  * Helper macro for kfree_rcu() to prevent argument-expansion eyestrain.
 908  */
 909 #define __kfree_rcu(head, offset) \
 910         do { \
 911                 BUILD_BUG_ON(!__is_kfree_rcu_offset(offset)); \
 912                 kfree_call_rcu(head, (rcu_callback_t)(unsigned long)(offset)); \
 913         } while (0)
 914
 915 /**
 916  * kfree_rcu() - kfree an object after a grace period.
 917  * @ptr:        pointer to kfree
 918  * @rcu_head:   the name of the struct rcu_head within the type of @ptr.
 919  *
 920  * Many rcu callbacks functions just call kfree() on the base structure.
 921  * These functions are trivial, but their size adds up, and furthermore
 922  * when they are used in a kernel module, that module must invoke the
 923  * high-latency rcu_barrier() function at module-unload time.
 924  *
 925  * The kfree_rcu() function handles this issue.  Rather than encoding a
 926  * function address in the embedded rcu_head structure, kfree_rcu() instead
 927  * encodes the offset of the rcu_head structure within the base structure.
 928  * Because the functions are not allowed in the low-order 4096 bytes of
 929  * kernel virtual memory, offsets up to 4095 bytes can be accommodated.
 930  * If the offset is larger than 4095 bytes, a compile-time error will
 931  * be generated in __kfree_rcu().  If this error is triggered, you can
 932  * either fall back to use of call_rcu() or rearrange the structure to
 933  * position the rcu_head structure into the first 4096 bytes.
 934  *
 935  * Note that the allowable offset might decrease in the future, for example,
 936  * to allow something like kmem_cache_free_rcu().
 937  *
 938  * The BUILD_BUG_ON check must not involve any function calls, hence the
 939  * checks are done in macros here.
 940  */
 941 #define kfree_rcu(ptr, rcu_head)                                        \
 942         __kfree_rcu(&((ptr)->rcu_head), offsetof(typeof(*(ptr)), rcu_head))
 943
 944 #ifdef CONFIG_TINY_RCU
 945 static inline int rcu_needs_cpu(u64 basemono, u64 *nextevt)
 946 {
 947         *nextevt = KTIME_MAX;
 948         return 0;
 949 }
 950 #endif /* #ifdef CONFIG_TINY_RCU */
 951
 952 #if defined(CONFIG_RCU_NOCB_CPU_ALL)
 953 static inline bool rcu_is_nocb_cpu(int cpu) { return true; }
 954 #elif defined(CONFIG_RCU_NOCB_CPU)
 955 bool rcu_is_nocb_cpu(int cpu);
 956 #else
 957 static inline bool rcu_is_nocb_cpu(int cpu) { return false; }
 958 #endif
 959
 960
 961 /* Only for use by adaptive-ticks code. */
 962 #ifdef CONFIG_NO_HZ_FULL_SYSIDLE
 963 bool rcu_sys_is_idle(void);
 964 void rcu_sysidle_force_exit(void);
 965 #else /* #ifdef CONFIG_NO_HZ_FULL_SYSIDLE */
 966
 967 static inline bool rcu_sys_is_idle(void)
 968 {
 969         return false;
 970 }
 971
 972 static inline void rcu_sysidle_force_exit(void)
 973 {
 974 }
 975
 976 #endif /* #else #ifdef CONFIG_NO_HZ_FULL_SYSIDLE */
 977
 978
 979 /*
 980  * Dump the ftrace buffer, but only one time per callsite per boot.
 981  */
 982 #define rcu_ftrace_dump(oops_dump_mode) \
 983 do { \
 984         static atomic_t ___rfd_beenhere = ATOMIC_INIT(0); \
 985         \
 986         if (!atomic_read(&___rfd_beenhere) && \
 987             !atomic_xchg(&___rfd_beenhere, 1)) \
 988                 ftrace_dump(oops_dump_mode); \
 989 } while (0)
 990
 991 /*
 992  * Place this after a lock-acquisition primitive to guarantee that
 993  * an UNLOCK+LOCK pair acts as a full barrier.  This guarantee applies
 994  * if the UNLOCK and LOCK are executed by the same CPU or if the
 995  * UNLOCK and LOCK operate on the same lock variable.
 996  */
 997 #ifdef CONFIG_ARCH_WEAK_RELEASE_ACQUIRE
 998 #define smp_mb__after_unlock_lock()     smp_mb()  /* Full ordering for lock. */
 999 #else /* #ifdef CONFIG_ARCH_WEAK_RELEASE_ACQUIRE */
1000 #define smp_mb__after_unlock_lock()     do { } while (0)
1001 #endif /* #else #ifdef CONFIG_ARCH_WEAK_RELEASE_ACQUIRE */
1002
1003
1004 #endif /* __LINUX_RCUPDATE_H */