Subversion Repositories Kolibri OS

Rev

Rev 6588 | Go to most recent revision | Blame | Compare with Previous | Last modification | View Log | Download | RSS feed

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