kernel/include/linux/rcutree.h

   1 /*
   2  * Read-Copy Update mechanism for mutual exclusion (tree-based version)
   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, 2008
  19  *
  20  * Author: Dipankar Sarma <dipankar@in.ibm.com>
  21  *         Paul E. McKenney <paulmck@linux.vnet.ibm.com> Hierarchical algorithm
  22  *
  23  * Based on the original work by Paul McKenney <paulmck@us.ibm.com>
  24  * and inputs from Rusty Russell, Andrea Arcangeli and Andi Kleen.
  25  *
  26  * For detailed explanation of Read-Copy Update mechanism see -
  27  *      Documentation/RCU
  28  */
  29
  30 #ifndef __LINUX_RCUTREE_H
  31 #define __LINUX_RCUTREE_H
  32
  33 void rcu_note_context_switch(void);
  34 #ifndef CONFIG_RCU_NOCB_CPU_ALL
  35 int rcu_needs_cpu(unsigned long *delta_jiffies);
  36 #endif /* #ifndef CONFIG_RCU_NOCB_CPU_ALL */
  37 void rcu_cpu_stall_reset(void);
  38
  39 /*
  40  * Note a virtualization-based context switch.  This is simply a
  41  * wrapper around rcu_note_context_switch(), which allows TINY_RCU
  42  * to save a few bytes.
  43  */
  44 static inline void rcu_virt_note_context_switch(int cpu)
  45 {
  46         rcu_note_context_switch();
  47 }
  48
  49 #ifdef CONFIG_PREEMPT_RT_FULL
  50 # define synchronize_rcu_bh     synchronize_rcu
  51 #else
  52 void synchronize_rcu_bh(void);
  53 #endif
  54 void synchronize_sched_expedited(void);
  55 void synchronize_rcu_expedited(void);
  56
  57 void kfree_call_rcu(struct rcu_head *head, void (*func)(struct rcu_head *rcu));
  58
  59 /**
  60  * synchronize_rcu_bh_expedited - Brute-force RCU-bh grace period
  61  *
  62  * Wait for an RCU-bh grace period to elapse, but use a "big hammer"
  63  * approach to force the grace period to end quickly.  This consumes
  64  * significant time on all CPUs and is unfriendly to real-time workloads,
  65  * so is thus not recommended for any sort of common-case code.  In fact,
  66  * if you are using synchronize_rcu_bh_expedited() in a loop, please
  67  * restructure your code to batch your updates, and then use a single
  68  * synchronize_rcu_bh() instead.
  69  *
  70  * Note that it is illegal to call this function while holding any lock
  71  * that is acquired by a CPU-hotplug notifier.  And yes, it is also illegal
  72  * to call this function from a CPU-hotplug notifier.  Failing to observe
  73  * these restriction will result in deadlock.
  74  */
  75 static inline void synchronize_rcu_bh_expedited(void)
  76 {
  77         synchronize_sched_expedited();
  78 }
  79
  80 void rcu_barrier(void);
  81 #ifdef CONFIG_PREEMPT_RT_FULL
  82 # define rcu_barrier_bh                rcu_barrier
  83 #else
  84 void rcu_barrier_bh(void);
  85 #endif
  86 void rcu_barrier_sched(void);
  87 unsigned long get_state_synchronize_rcu(void);
  88 void cond_synchronize_rcu(unsigned long oldstate);
  89
  90 extern unsigned long rcutorture_testseq;
  91 extern unsigned long rcutorture_vernum;
  92 unsigned long rcu_batches_started(void);
  93 unsigned long rcu_batches_started_bh(void);
  94 unsigned long rcu_batches_started_sched(void);
  95 unsigned long rcu_batches_completed(void);
  96 unsigned long rcu_batches_completed_sched(void);
  97 void show_rcu_gp_kthreads(void);
  98
  99 void rcu_force_quiescent_state(void);
 100 void rcu_sched_force_quiescent_state(void);
 101
 102 void exit_rcu(void);
 103
 104 void rcu_scheduler_starting(void);
 105 extern int rcu_scheduler_active __read_mostly;
 106
 107 bool rcu_is_watching(void);
 108
 109 #ifndef CONFIG_PREEMPT_RT_FULL
 110 void rcu_bh_force_quiescent_state(void);
 111 unsigned long rcu_batches_completed_bh(void);
 112 #else
 113 # define rcu_bh_force_quiescent_state   rcu_force_quiescent_state
 114 # define rcu_batches_completed_bh       rcu_batches_completed
 115 #endif
 116
 117 void rcu_all_qs(void);
 118
 119 #endif /* __LINUX_RCUTREE_H */