rcupdate.c 8.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295
  1. /*
  2. * Read-Copy Update mechanism for mutual exclusion
  3. *
  4. * This program is free software; you can redistribute it and/or modify
  5. * it under the terms of the GNU General Public License as published by
  6. * the Free Software Foundation; either version 2 of the License, or
  7. * (at your option) any later version.
  8. *
  9. * This program is distributed in the hope that it will be useful,
  10. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  12. * GNU General Public License for more details.
  13. *
  14. * You should have received a copy of the GNU General Public License
  15. * along with this program; if not, write to the Free Software
  16. * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  17. *
  18. * Copyright IBM Corporation, 2001
  19. *
  20. * Authors: Dipankar Sarma <dipankar@in.ibm.com>
  21. * Manfred Spraul <manfred@colorfullife.com>
  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. * Papers:
  26. * http://www.rdrop.com/users/paulmck/paper/rclockpdcsproof.pdf
  27. * http://lse.sourceforge.net/locking/rclock_OLS.2001.05.01c.sc.pdf (OLS2001)
  28. *
  29. * For detailed explanation of Read-Copy Update mechanism see -
  30. * http://lse.sourceforge.net/locking/rcupdate.html
  31. *
  32. */
  33. #include <linux/types.h>
  34. #include <linux/kernel.h>
  35. #include <linux/init.h>
  36. #include <linux/spinlock.h>
  37. #include <linux/smp.h>
  38. #include <linux/interrupt.h>
  39. #include <linux/sched.h>
  40. #include <asm/atomic.h>
  41. #include <linux/bitops.h>
  42. #include <linux/percpu.h>
  43. #include <linux/notifier.h>
  44. #include <linux/cpu.h>
  45. #include <linux/mutex.h>
  46. #include <linux/module.h>
  47. #include <linux/hardirq.h>
  48. #ifdef CONFIG_DEBUG_LOCK_ALLOC
  49. static struct lock_class_key rcu_lock_key;
  50. struct lockdep_map rcu_lock_map =
  51. STATIC_LOCKDEP_MAP_INIT("rcu_read_lock", &rcu_lock_key);
  52. EXPORT_SYMBOL_GPL(rcu_lock_map);
  53. static struct lock_class_key rcu_bh_lock_key;
  54. struct lockdep_map rcu_bh_lock_map =
  55. STATIC_LOCKDEP_MAP_INIT("rcu_read_lock_bh", &rcu_bh_lock_key);
  56. EXPORT_SYMBOL_GPL(rcu_bh_lock_map);
  57. static struct lock_class_key rcu_sched_lock_key;
  58. struct lockdep_map rcu_sched_lock_map =
  59. STATIC_LOCKDEP_MAP_INIT("rcu_read_lock_sched", &rcu_sched_lock_key);
  60. EXPORT_SYMBOL_GPL(rcu_sched_lock_map);
  61. #endif
  62. #ifdef CONFIG_DEBUG_LOCK_ALLOC
  63. int debug_lockdep_rcu_enabled(void)
  64. {
  65. return rcu_scheduler_active && debug_locks &&
  66. current->lockdep_recursion == 0;
  67. }
  68. EXPORT_SYMBOL_GPL(debug_lockdep_rcu_enabled);
  69. /**
  70. * rcu_read_lock_bh_held() - might we be in RCU-bh read-side critical section?
  71. *
  72. * Check for bottom half being disabled, which covers both the
  73. * CONFIG_PROVE_RCU and not cases. Note that if someone uses
  74. * rcu_read_lock_bh(), but then later enables BH, lockdep (if enabled)
  75. * will show the situation. This is useful for debug checks in functions
  76. * that require that they be called within an RCU read-side critical
  77. * section.
  78. *
  79. * Check debug_lockdep_rcu_enabled() to prevent false positives during boot.
  80. */
  81. int rcu_read_lock_bh_held(void)
  82. {
  83. if (!debug_lockdep_rcu_enabled())
  84. return 1;
  85. return in_softirq() || irqs_disabled();
  86. }
  87. EXPORT_SYMBOL_GPL(rcu_read_lock_bh_held);
  88. #endif /* #ifdef CONFIG_DEBUG_LOCK_ALLOC */
  89. /*
  90. * Awaken the corresponding synchronize_rcu() instance now that a
  91. * grace period has elapsed.
  92. */
  93. void wakeme_after_rcu(struct rcu_head *head)
  94. {
  95. struct rcu_synchronize *rcu;
  96. rcu = container_of(head, struct rcu_synchronize, head);
  97. complete(&rcu->completion);
  98. }
  99. #ifdef CONFIG_PROVE_RCU
  100. /*
  101. * wrapper function to avoid #include problems.
  102. */
  103. int rcu_my_thread_group_empty(void)
  104. {
  105. return thread_group_empty(current);
  106. }
  107. EXPORT_SYMBOL_GPL(rcu_my_thread_group_empty);
  108. #endif /* #ifdef CONFIG_PROVE_RCU */
  109. #ifdef CONFIG_DEBUG_OBJECTS_RCU_HEAD
  110. static inline void debug_init_rcu_head(struct rcu_head *head)
  111. {
  112. debug_object_init(head, &rcuhead_debug_descr);
  113. }
  114. static inline void debug_rcu_head_free(struct rcu_head *head)
  115. {
  116. debug_object_free(head, &rcuhead_debug_descr);
  117. }
  118. /*
  119. * fixup_init is called when:
  120. * - an active object is initialized
  121. */
  122. static int rcuhead_fixup_init(void *addr, enum debug_obj_state state)
  123. {
  124. struct rcu_head *head = addr;
  125. switch (state) {
  126. case ODEBUG_STATE_ACTIVE:
  127. /*
  128. * Ensure that queued callbacks are all executed.
  129. * If we detect that we are nested in a RCU read-side critical
  130. * section, we should simply fail, otherwise we would deadlock.
  131. * In !PREEMPT configurations, there is no way to tell if we are
  132. * in a RCU read-side critical section or not, so we never
  133. * attempt any fixup and just print a warning.
  134. */
  135. #ifndef CONFIG_PREEMPT
  136. WARN_ON_ONCE(1);
  137. return 0;
  138. #endif
  139. if (rcu_preempt_depth() != 0 || preempt_count() != 0 ||
  140. irqs_disabled()) {
  141. WARN_ON_ONCE(1);
  142. return 0;
  143. }
  144. rcu_barrier();
  145. rcu_barrier_sched();
  146. rcu_barrier_bh();
  147. debug_object_init(head, &rcuhead_debug_descr);
  148. return 1;
  149. default:
  150. return 0;
  151. }
  152. }
  153. /*
  154. * fixup_activate is called when:
  155. * - an active object is activated
  156. * - an unknown object is activated (might be a statically initialized object)
  157. * Activation is performed internally by call_rcu().
  158. */
  159. static int rcuhead_fixup_activate(void *addr, enum debug_obj_state state)
  160. {
  161. struct rcu_head *head = addr;
  162. switch (state) {
  163. case ODEBUG_STATE_NOTAVAILABLE:
  164. /*
  165. * This is not really a fixup. We just make sure that it is
  166. * tracked in the object tracker.
  167. */
  168. debug_object_init(head, &rcuhead_debug_descr);
  169. debug_object_activate(head, &rcuhead_debug_descr);
  170. return 0;
  171. case ODEBUG_STATE_ACTIVE:
  172. /*
  173. * Ensure that queued callbacks are all executed.
  174. * If we detect that we are nested in a RCU read-side critical
  175. * section, we should simply fail, otherwise we would deadlock.
  176. * In !PREEMPT configurations, there is no way to tell if we are
  177. * in a RCU read-side critical section or not, so we never
  178. * attempt any fixup and just print a warning.
  179. */
  180. #ifndef CONFIG_PREEMPT
  181. WARN_ON_ONCE(1);
  182. return 0;
  183. #endif
  184. if (rcu_preempt_depth() != 0 || preempt_count() != 0 ||
  185. irqs_disabled()) {
  186. WARN_ON_ONCE(1);
  187. return 0;
  188. }
  189. rcu_barrier();
  190. rcu_barrier_sched();
  191. rcu_barrier_bh();
  192. debug_object_activate(head, &rcuhead_debug_descr);
  193. return 1;
  194. default:
  195. return 0;
  196. }
  197. }
  198. /*
  199. * fixup_free is called when:
  200. * - an active object is freed
  201. */
  202. static int rcuhead_fixup_free(void *addr, enum debug_obj_state state)
  203. {
  204. struct rcu_head *head = addr;
  205. switch (state) {
  206. case ODEBUG_STATE_ACTIVE:
  207. /*
  208. * Ensure that queued callbacks are all executed.
  209. * If we detect that we are nested in a RCU read-side critical
  210. * section, we should simply fail, otherwise we would deadlock.
  211. * In !PREEMPT configurations, there is no way to tell if we are
  212. * in a RCU read-side critical section or not, so we never
  213. * attempt any fixup and just print a warning.
  214. */
  215. #ifndef CONFIG_PREEMPT
  216. WARN_ON_ONCE(1);
  217. return 0;
  218. #endif
  219. if (rcu_preempt_depth() != 0 || preempt_count() != 0 ||
  220. irqs_disabled()) {
  221. WARN_ON_ONCE(1);
  222. return 0;
  223. }
  224. rcu_barrier();
  225. rcu_barrier_sched();
  226. rcu_barrier_bh();
  227. debug_object_free(head, &rcuhead_debug_descr);
  228. return 1;
  229. default:
  230. return 0;
  231. }
  232. }
  233. /**
  234. * init_rcu_head_on_stack() - initialize on-stack rcu_head for debugobjects
  235. * @head: pointer to rcu_head structure to be initialized
  236. *
  237. * This function informs debugobjects of a new rcu_head structure that
  238. * has been allocated as an auto variable on the stack. This function
  239. * is not required for rcu_head structures that are statically defined or
  240. * that are dynamically allocated on the heap. This function has no
  241. * effect for !CONFIG_DEBUG_OBJECTS_RCU_HEAD kernel builds.
  242. */
  243. void init_rcu_head_on_stack(struct rcu_head *head)
  244. {
  245. debug_object_init_on_stack(head, &rcuhead_debug_descr);
  246. }
  247. EXPORT_SYMBOL_GPL(init_rcu_head_on_stack);
  248. /**
  249. * destroy_rcu_head_on_stack() - destroy on-stack rcu_head for debugobjects
  250. * @head: pointer to rcu_head structure to be initialized
  251. *
  252. * This function informs debugobjects that an on-stack rcu_head structure
  253. * is about to go out of scope. As with init_rcu_head_on_stack(), this
  254. * function is not required for rcu_head structures that are statically
  255. * defined or that are dynamically allocated on the heap. Also as with
  256. * init_rcu_head_on_stack(), this function has no effect for
  257. * !CONFIG_DEBUG_OBJECTS_RCU_HEAD kernel builds.
  258. */
  259. void destroy_rcu_head_on_stack(struct rcu_head *head)
  260. {
  261. debug_object_free(head, &rcuhead_debug_descr);
  262. }
  263. EXPORT_SYMBOL_GPL(destroy_rcu_head_on_stack);
  264. struct debug_obj_descr rcuhead_debug_descr = {
  265. .name = "rcu_head",
  266. .fixup_init = rcuhead_fixup_init,
  267. .fixup_activate = rcuhead_fixup_activate,
  268. .fixup_free = rcuhead_fixup_free,
  269. };
  270. EXPORT_SYMBOL_GPL(rcuhead_debug_descr);
  271. #endif /* #ifdef CONFIG_DEBUG_OBJECTS_RCU_HEAD */