rcutree.h 3.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100
  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, write to the Free Software
  16. * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  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. #ifndef __LINUX_RCUTREE_H
  30. #define __LINUX_RCUTREE_H
  31. extern void rcu_init(void);
  32. extern void rcu_note_context_switch(int cpu);
  33. extern int rcu_needs_cpu(int cpu, unsigned long *delta_jiffies);
  34. extern void rcu_cpu_stall_reset(void);
  35. /*
  36. * Note a virtualization-based context switch. This is simply a
  37. * wrapper around rcu_note_context_switch(), which allows TINY_RCU
  38. * to save a few bytes.
  39. */
  40. static inline void rcu_virt_note_context_switch(int cpu)
  41. {
  42. rcu_note_context_switch(cpu);
  43. }
  44. extern void synchronize_rcu_bh(void);
  45. extern void synchronize_sched_expedited(void);
  46. extern void synchronize_rcu_expedited(void);
  47. void kfree_call_rcu(struct rcu_head *head, void (*func)(struct rcu_head *rcu));
  48. /**
  49. * synchronize_rcu_bh_expedited - Brute-force RCU-bh grace period
  50. *
  51. * Wait for an RCU-bh grace period to elapse, but use a "big hammer"
  52. * approach to force the grace period to end quickly. This consumes
  53. * significant time on all CPUs and is unfriendly to real-time workloads,
  54. * so is thus not recommended for any sort of common-case code. In fact,
  55. * if you are using synchronize_rcu_bh_expedited() in a loop, please
  56. * restructure your code to batch your updates, and then use a single
  57. * synchronize_rcu_bh() instead.
  58. *
  59. * Note that it is illegal to call this function while holding any lock
  60. * that is acquired by a CPU-hotplug notifier. And yes, it is also illegal
  61. * to call this function from a CPU-hotplug notifier. Failing to observe
  62. * these restriction will result in deadlock.
  63. */
  64. static inline void synchronize_rcu_bh_expedited(void)
  65. {
  66. synchronize_sched_expedited();
  67. }
  68. extern void rcu_barrier(void);
  69. extern void rcu_barrier_bh(void);
  70. extern void rcu_barrier_sched(void);
  71. extern unsigned long rcutorture_testseq;
  72. extern unsigned long rcutorture_vernum;
  73. extern long rcu_batches_completed(void);
  74. extern long rcu_batches_completed_bh(void);
  75. extern long rcu_batches_completed_sched(void);
  76. extern void rcu_force_quiescent_state(void);
  77. extern void rcu_bh_force_quiescent_state(void);
  78. extern void rcu_sched_force_quiescent_state(void);
  79. /* A context switch is a grace period for RCU-sched and RCU-bh. */
  80. static inline int rcu_blocking_is_gp(void)
  81. {
  82. might_sleep(); /* Check for RCU read-side critical section. */
  83. return num_online_cpus() == 1;
  84. }
  85. extern void rcu_scheduler_starting(void);
  86. extern int rcu_scheduler_active __read_mostly;
  87. #endif /* __LINUX_RCUTREE_H */