update.c 28 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916
  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. * 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 <linux/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/export.h>
  47. #include <linux/hardirq.h>
  48. #include <linux/delay.h>
  49. #include <linux/module.h>
  50. #include <linux/kthread.h>
  51. #include <linux/tick.h>
  52. #define CREATE_TRACE_POINTS
  53. #include "rcu.h"
  54. MODULE_ALIAS("rcupdate");
  55. #ifdef MODULE_PARAM_PREFIX
  56. #undef MODULE_PARAM_PREFIX
  57. #endif
  58. #define MODULE_PARAM_PREFIX "rcupdate."
  59. #ifndef CONFIG_TINY_RCU
  60. module_param(rcu_expedited, int, 0);
  61. module_param(rcu_normal, int, 0);
  62. static int rcu_normal_after_boot;
  63. module_param(rcu_normal_after_boot, int, 0);
  64. #endif /* #ifndef CONFIG_TINY_RCU */
  65. #if defined(CONFIG_DEBUG_LOCK_ALLOC) && defined(CONFIG_PREEMPT_COUNT)
  66. /**
  67. * rcu_read_lock_sched_held() - might we be in RCU-sched read-side critical section?
  68. *
  69. * If CONFIG_DEBUG_LOCK_ALLOC is selected, returns nonzero iff in an
  70. * RCU-sched read-side critical section. In absence of
  71. * CONFIG_DEBUG_LOCK_ALLOC, this assumes we are in an RCU-sched read-side
  72. * critical section unless it can prove otherwise. Note that disabling
  73. * of preemption (including disabling irqs) counts as an RCU-sched
  74. * read-side critical section. This is useful for debug checks in functions
  75. * that required that they be called within an RCU-sched read-side
  76. * critical section.
  77. *
  78. * Check debug_lockdep_rcu_enabled() to prevent false positives during boot
  79. * and while lockdep is disabled.
  80. *
  81. * Note that if the CPU is in the idle loop from an RCU point of
  82. * view (ie: that we are in the section between rcu_idle_enter() and
  83. * rcu_idle_exit()) then rcu_read_lock_held() returns false even if the CPU
  84. * did an rcu_read_lock(). The reason for this is that RCU ignores CPUs
  85. * that are in such a section, considering these as in extended quiescent
  86. * state, so such a CPU is effectively never in an RCU read-side critical
  87. * section regardless of what RCU primitives it invokes. This state of
  88. * affairs is required --- we need to keep an RCU-free window in idle
  89. * where the CPU may possibly enter into low power mode. This way we can
  90. * notice an extended quiescent state to other CPUs that started a grace
  91. * period. Otherwise we would delay any grace period as long as we run in
  92. * the idle task.
  93. *
  94. * Similarly, we avoid claiming an SRCU read lock held if the current
  95. * CPU is offline.
  96. */
  97. int rcu_read_lock_sched_held(void)
  98. {
  99. int lockdep_opinion = 0;
  100. if (!debug_lockdep_rcu_enabled())
  101. return 1;
  102. if (!rcu_is_watching())
  103. return 0;
  104. if (!rcu_lockdep_current_cpu_online())
  105. return 0;
  106. if (debug_locks)
  107. lockdep_opinion = lock_is_held(&rcu_sched_lock_map);
  108. return lockdep_opinion || preempt_count() != 0 || irqs_disabled();
  109. }
  110. EXPORT_SYMBOL(rcu_read_lock_sched_held);
  111. #endif
  112. #ifndef CONFIG_TINY_RCU
  113. /*
  114. * Should expedited grace-period primitives always fall back to their
  115. * non-expedited counterparts? Intended for use within RCU. Note
  116. * that if the user specifies both rcu_expedited and rcu_normal, then
  117. * rcu_normal wins.
  118. */
  119. bool rcu_gp_is_normal(void)
  120. {
  121. return READ_ONCE(rcu_normal);
  122. }
  123. EXPORT_SYMBOL_GPL(rcu_gp_is_normal);
  124. static atomic_t rcu_expedited_nesting =
  125. ATOMIC_INIT(IS_ENABLED(CONFIG_RCU_EXPEDITE_BOOT) ? 1 : 0);
  126. /*
  127. * Should normal grace-period primitives be expedited? Intended for
  128. * use within RCU. Note that this function takes the rcu_expedited
  129. * sysfs/boot variable into account as well as the rcu_expedite_gp()
  130. * nesting. So looping on rcu_unexpedite_gp() until rcu_gp_is_expedited()
  131. * returns false is a -really- bad idea.
  132. */
  133. bool rcu_gp_is_expedited(void)
  134. {
  135. return rcu_expedited || atomic_read(&rcu_expedited_nesting);
  136. }
  137. EXPORT_SYMBOL_GPL(rcu_gp_is_expedited);
  138. /**
  139. * rcu_expedite_gp - Expedite future RCU grace periods
  140. *
  141. * After a call to this function, future calls to synchronize_rcu() and
  142. * friends act as the corresponding synchronize_rcu_expedited() function
  143. * had instead been called.
  144. */
  145. void rcu_expedite_gp(void)
  146. {
  147. atomic_inc(&rcu_expedited_nesting);
  148. }
  149. EXPORT_SYMBOL_GPL(rcu_expedite_gp);
  150. /**
  151. * rcu_unexpedite_gp - Cancel prior rcu_expedite_gp() invocation
  152. *
  153. * Undo a prior call to rcu_expedite_gp(). If all prior calls to
  154. * rcu_expedite_gp() are undone by a subsequent call to rcu_unexpedite_gp(),
  155. * and if the rcu_expedited sysfs/boot parameter is not set, then all
  156. * subsequent calls to synchronize_rcu() and friends will return to
  157. * their normal non-expedited behavior.
  158. */
  159. void rcu_unexpedite_gp(void)
  160. {
  161. atomic_dec(&rcu_expedited_nesting);
  162. }
  163. EXPORT_SYMBOL_GPL(rcu_unexpedite_gp);
  164. /*
  165. * Inform RCU of the end of the in-kernel boot sequence.
  166. */
  167. void rcu_end_inkernel_boot(void)
  168. {
  169. if (IS_ENABLED(CONFIG_RCU_EXPEDITE_BOOT))
  170. rcu_unexpedite_gp();
  171. if (rcu_normal_after_boot)
  172. WRITE_ONCE(rcu_normal, 1);
  173. }
  174. #endif /* #ifndef CONFIG_TINY_RCU */
  175. #ifdef CONFIG_PREEMPT_RCU
  176. /*
  177. * Preemptible RCU implementation for rcu_read_lock().
  178. * Just increment ->rcu_read_lock_nesting, shared state will be updated
  179. * if we block.
  180. */
  181. void __rcu_read_lock(void)
  182. {
  183. current->rcu_read_lock_nesting++;
  184. barrier(); /* critical section after entry code. */
  185. }
  186. EXPORT_SYMBOL_GPL(__rcu_read_lock);
  187. /*
  188. * Preemptible RCU implementation for rcu_read_unlock().
  189. * Decrement ->rcu_read_lock_nesting. If the result is zero (outermost
  190. * rcu_read_unlock()) and ->rcu_read_unlock_special is non-zero, then
  191. * invoke rcu_read_unlock_special() to clean up after a context switch
  192. * in an RCU read-side critical section and other special cases.
  193. */
  194. void __rcu_read_unlock(void)
  195. {
  196. struct task_struct *t = current;
  197. if (t->rcu_read_lock_nesting != 1) {
  198. --t->rcu_read_lock_nesting;
  199. } else {
  200. barrier(); /* critical section before exit code. */
  201. t->rcu_read_lock_nesting = INT_MIN;
  202. barrier(); /* assign before ->rcu_read_unlock_special load */
  203. if (unlikely(READ_ONCE(t->rcu_read_unlock_special.s)))
  204. rcu_read_unlock_special(t);
  205. barrier(); /* ->rcu_read_unlock_special load before assign */
  206. t->rcu_read_lock_nesting = 0;
  207. }
  208. #ifdef CONFIG_PROVE_LOCKING
  209. {
  210. int rrln = READ_ONCE(t->rcu_read_lock_nesting);
  211. WARN_ON_ONCE(rrln < 0 && rrln > INT_MIN / 2);
  212. }
  213. #endif /* #ifdef CONFIG_PROVE_LOCKING */
  214. }
  215. EXPORT_SYMBOL_GPL(__rcu_read_unlock);
  216. #endif /* #ifdef CONFIG_PREEMPT_RCU */
  217. #ifdef CONFIG_DEBUG_LOCK_ALLOC
  218. static struct lock_class_key rcu_lock_key;
  219. struct lockdep_map rcu_lock_map =
  220. STATIC_LOCKDEP_MAP_INIT("rcu_read_lock", &rcu_lock_key);
  221. EXPORT_SYMBOL_GPL(rcu_lock_map);
  222. static struct lock_class_key rcu_bh_lock_key;
  223. struct lockdep_map rcu_bh_lock_map =
  224. STATIC_LOCKDEP_MAP_INIT("rcu_read_lock_bh", &rcu_bh_lock_key);
  225. EXPORT_SYMBOL_GPL(rcu_bh_lock_map);
  226. static struct lock_class_key rcu_sched_lock_key;
  227. struct lockdep_map rcu_sched_lock_map =
  228. STATIC_LOCKDEP_MAP_INIT("rcu_read_lock_sched", &rcu_sched_lock_key);
  229. EXPORT_SYMBOL_GPL(rcu_sched_lock_map);
  230. static struct lock_class_key rcu_callback_key;
  231. struct lockdep_map rcu_callback_map =
  232. STATIC_LOCKDEP_MAP_INIT("rcu_callback", &rcu_callback_key);
  233. EXPORT_SYMBOL_GPL(rcu_callback_map);
  234. int notrace debug_lockdep_rcu_enabled(void)
  235. {
  236. return rcu_scheduler_active && debug_locks &&
  237. current->lockdep_recursion == 0;
  238. }
  239. EXPORT_SYMBOL_GPL(debug_lockdep_rcu_enabled);
  240. /**
  241. * rcu_read_lock_held() - might we be in RCU read-side critical section?
  242. *
  243. * If CONFIG_DEBUG_LOCK_ALLOC is selected, returns nonzero iff in an RCU
  244. * read-side critical section. In absence of CONFIG_DEBUG_LOCK_ALLOC,
  245. * this assumes we are in an RCU read-side critical section unless it can
  246. * prove otherwise. This is useful for debug checks in functions that
  247. * require that they be called within an RCU read-side critical section.
  248. *
  249. * Checks debug_lockdep_rcu_enabled() to prevent false positives during boot
  250. * and while lockdep is disabled.
  251. *
  252. * Note that rcu_read_lock() and the matching rcu_read_unlock() must
  253. * occur in the same context, for example, it is illegal to invoke
  254. * rcu_read_unlock() in process context if the matching rcu_read_lock()
  255. * was invoked from within an irq handler.
  256. *
  257. * Note that rcu_read_lock() is disallowed if the CPU is either idle or
  258. * offline from an RCU perspective, so check for those as well.
  259. */
  260. int rcu_read_lock_held(void)
  261. {
  262. if (!debug_lockdep_rcu_enabled())
  263. return 1;
  264. if (!rcu_is_watching())
  265. return 0;
  266. if (!rcu_lockdep_current_cpu_online())
  267. return 0;
  268. return lock_is_held(&rcu_lock_map);
  269. }
  270. EXPORT_SYMBOL_GPL(rcu_read_lock_held);
  271. /**
  272. * rcu_read_lock_bh_held() - might we be in RCU-bh read-side critical section?
  273. *
  274. * Check for bottom half being disabled, which covers both the
  275. * CONFIG_PROVE_RCU and not cases. Note that if someone uses
  276. * rcu_read_lock_bh(), but then later enables BH, lockdep (if enabled)
  277. * will show the situation. This is useful for debug checks in functions
  278. * that require that they be called within an RCU read-side critical
  279. * section.
  280. *
  281. * Check debug_lockdep_rcu_enabled() to prevent false positives during boot.
  282. *
  283. * Note that rcu_read_lock() is disallowed if the CPU is either idle or
  284. * offline from an RCU perspective, so check for those as well.
  285. */
  286. int rcu_read_lock_bh_held(void)
  287. {
  288. if (!debug_lockdep_rcu_enabled())
  289. return 1;
  290. if (!rcu_is_watching())
  291. return 0;
  292. if (!rcu_lockdep_current_cpu_online())
  293. return 0;
  294. return in_softirq() || irqs_disabled();
  295. }
  296. EXPORT_SYMBOL_GPL(rcu_read_lock_bh_held);
  297. #endif /* #ifdef CONFIG_DEBUG_LOCK_ALLOC */
  298. /**
  299. * wakeme_after_rcu() - Callback function to awaken a task after grace period
  300. * @head: Pointer to rcu_head member within rcu_synchronize structure
  301. *
  302. * Awaken the corresponding task now that a grace period has elapsed.
  303. */
  304. void wakeme_after_rcu(struct rcu_head *head)
  305. {
  306. struct rcu_synchronize *rcu;
  307. rcu = container_of(head, struct rcu_synchronize, head);
  308. complete(&rcu->completion);
  309. }
  310. EXPORT_SYMBOL_GPL(wakeme_after_rcu);
  311. void __wait_rcu_gp(bool checktiny, int n, call_rcu_func_t *crcu_array,
  312. struct rcu_synchronize *rs_array)
  313. {
  314. int i;
  315. /* Initialize and register callbacks for each flavor specified. */
  316. for (i = 0; i < n; i++) {
  317. if (checktiny &&
  318. (crcu_array[i] == call_rcu ||
  319. crcu_array[i] == call_rcu_bh)) {
  320. might_sleep();
  321. continue;
  322. }
  323. init_rcu_head_on_stack(&rs_array[i].head);
  324. init_completion(&rs_array[i].completion);
  325. (crcu_array[i])(&rs_array[i].head, wakeme_after_rcu);
  326. }
  327. /* Wait for all callbacks to be invoked. */
  328. for (i = 0; i < n; i++) {
  329. if (checktiny &&
  330. (crcu_array[i] == call_rcu ||
  331. crcu_array[i] == call_rcu_bh))
  332. continue;
  333. wait_for_completion(&rs_array[i].completion);
  334. destroy_rcu_head_on_stack(&rs_array[i].head);
  335. }
  336. }
  337. EXPORT_SYMBOL_GPL(__wait_rcu_gp);
  338. #ifdef CONFIG_DEBUG_OBJECTS_RCU_HEAD
  339. void init_rcu_head(struct rcu_head *head)
  340. {
  341. debug_object_init(head, &rcuhead_debug_descr);
  342. }
  343. void destroy_rcu_head(struct rcu_head *head)
  344. {
  345. debug_object_free(head, &rcuhead_debug_descr);
  346. }
  347. /*
  348. * fixup_activate is called when:
  349. * - an active object is activated
  350. * - an unknown object is activated (might be a statically initialized object)
  351. * Activation is performed internally by call_rcu().
  352. */
  353. static int rcuhead_fixup_activate(void *addr, enum debug_obj_state state)
  354. {
  355. struct rcu_head *head = addr;
  356. switch (state) {
  357. case ODEBUG_STATE_NOTAVAILABLE:
  358. /*
  359. * This is not really a fixup. We just make sure that it is
  360. * tracked in the object tracker.
  361. */
  362. debug_object_init(head, &rcuhead_debug_descr);
  363. debug_object_activate(head, &rcuhead_debug_descr);
  364. return 0;
  365. default:
  366. return 1;
  367. }
  368. }
  369. /**
  370. * init_rcu_head_on_stack() - initialize on-stack rcu_head for debugobjects
  371. * @head: pointer to rcu_head structure to be initialized
  372. *
  373. * This function informs debugobjects of a new rcu_head structure that
  374. * has been allocated as an auto variable on the stack. This function
  375. * is not required for rcu_head structures that are statically defined or
  376. * that are dynamically allocated on the heap. This function has no
  377. * effect for !CONFIG_DEBUG_OBJECTS_RCU_HEAD kernel builds.
  378. */
  379. void init_rcu_head_on_stack(struct rcu_head *head)
  380. {
  381. debug_object_init_on_stack(head, &rcuhead_debug_descr);
  382. }
  383. EXPORT_SYMBOL_GPL(init_rcu_head_on_stack);
  384. /**
  385. * destroy_rcu_head_on_stack() - destroy on-stack rcu_head for debugobjects
  386. * @head: pointer to rcu_head structure to be initialized
  387. *
  388. * This function informs debugobjects that an on-stack rcu_head structure
  389. * is about to go out of scope. As with init_rcu_head_on_stack(), this
  390. * function is not required for rcu_head structures that are statically
  391. * defined or that are dynamically allocated on the heap. Also as with
  392. * init_rcu_head_on_stack(), this function has no effect for
  393. * !CONFIG_DEBUG_OBJECTS_RCU_HEAD kernel builds.
  394. */
  395. void destroy_rcu_head_on_stack(struct rcu_head *head)
  396. {
  397. debug_object_free(head, &rcuhead_debug_descr);
  398. }
  399. EXPORT_SYMBOL_GPL(destroy_rcu_head_on_stack);
  400. struct debug_obj_descr rcuhead_debug_descr = {
  401. .name = "rcu_head",
  402. .fixup_activate = rcuhead_fixup_activate,
  403. };
  404. EXPORT_SYMBOL_GPL(rcuhead_debug_descr);
  405. #endif /* #ifdef CONFIG_DEBUG_OBJECTS_RCU_HEAD */
  406. #if defined(CONFIG_TREE_RCU) || defined(CONFIG_PREEMPT_RCU) || defined(CONFIG_RCU_TRACE)
  407. void do_trace_rcu_torture_read(const char *rcutorturename, struct rcu_head *rhp,
  408. unsigned long secs,
  409. unsigned long c_old, unsigned long c)
  410. {
  411. trace_rcu_torture_read(rcutorturename, rhp, secs, c_old, c);
  412. }
  413. EXPORT_SYMBOL_GPL(do_trace_rcu_torture_read);
  414. #else
  415. #define do_trace_rcu_torture_read(rcutorturename, rhp, secs, c_old, c) \
  416. do { } while (0)
  417. #endif
  418. #ifdef CONFIG_RCU_STALL_COMMON
  419. #ifdef CONFIG_PROVE_RCU
  420. #define RCU_STALL_DELAY_DELTA (5 * HZ)
  421. #else
  422. #define RCU_STALL_DELAY_DELTA 0
  423. #endif
  424. int rcu_cpu_stall_suppress __read_mostly; /* 1 = suppress stall warnings. */
  425. static int rcu_cpu_stall_timeout __read_mostly = CONFIG_RCU_CPU_STALL_TIMEOUT;
  426. module_param(rcu_cpu_stall_suppress, int, 0644);
  427. module_param(rcu_cpu_stall_timeout, int, 0644);
  428. int rcu_jiffies_till_stall_check(void)
  429. {
  430. int till_stall_check = READ_ONCE(rcu_cpu_stall_timeout);
  431. /*
  432. * Limit check must be consistent with the Kconfig limits
  433. * for CONFIG_RCU_CPU_STALL_TIMEOUT.
  434. */
  435. if (till_stall_check < 3) {
  436. WRITE_ONCE(rcu_cpu_stall_timeout, 3);
  437. till_stall_check = 3;
  438. } else if (till_stall_check > 300) {
  439. WRITE_ONCE(rcu_cpu_stall_timeout, 300);
  440. till_stall_check = 300;
  441. }
  442. return till_stall_check * HZ + RCU_STALL_DELAY_DELTA;
  443. }
  444. void rcu_sysrq_start(void)
  445. {
  446. if (!rcu_cpu_stall_suppress)
  447. rcu_cpu_stall_suppress = 2;
  448. }
  449. void rcu_sysrq_end(void)
  450. {
  451. if (rcu_cpu_stall_suppress == 2)
  452. rcu_cpu_stall_suppress = 0;
  453. }
  454. static int rcu_panic(struct notifier_block *this, unsigned long ev, void *ptr)
  455. {
  456. rcu_cpu_stall_suppress = 1;
  457. return NOTIFY_DONE;
  458. }
  459. static struct notifier_block rcu_panic_block = {
  460. .notifier_call = rcu_panic,
  461. };
  462. static int __init check_cpu_stall_init(void)
  463. {
  464. atomic_notifier_chain_register(&panic_notifier_list, &rcu_panic_block);
  465. return 0;
  466. }
  467. early_initcall(check_cpu_stall_init);
  468. #endif /* #ifdef CONFIG_RCU_STALL_COMMON */
  469. #ifdef CONFIG_TASKS_RCU
  470. /*
  471. * Simple variant of RCU whose quiescent states are voluntary context switch,
  472. * user-space execution, and idle. As such, grace periods can take one good
  473. * long time. There are no read-side primitives similar to rcu_read_lock()
  474. * and rcu_read_unlock() because this implementation is intended to get
  475. * the system into a safe state for some of the manipulations involved in
  476. * tracing and the like. Finally, this implementation does not support
  477. * high call_rcu_tasks() rates from multiple CPUs. If this is required,
  478. * per-CPU callback lists will be needed.
  479. */
  480. /* Global list of callbacks and associated lock. */
  481. static struct rcu_head *rcu_tasks_cbs_head;
  482. static struct rcu_head **rcu_tasks_cbs_tail = &rcu_tasks_cbs_head;
  483. static DECLARE_WAIT_QUEUE_HEAD(rcu_tasks_cbs_wq);
  484. static DEFINE_RAW_SPINLOCK(rcu_tasks_cbs_lock);
  485. /* Track exiting tasks in order to allow them to be waited for. */
  486. DEFINE_SRCU(tasks_rcu_exit_srcu);
  487. /* Control stall timeouts. Disable with <= 0, otherwise jiffies till stall. */
  488. static int rcu_task_stall_timeout __read_mostly = HZ * 60 * 10;
  489. module_param(rcu_task_stall_timeout, int, 0644);
  490. static void rcu_spawn_tasks_kthread(void);
  491. /*
  492. * Post an RCU-tasks callback. First call must be from process context
  493. * after the scheduler if fully operational.
  494. */
  495. void call_rcu_tasks(struct rcu_head *rhp, rcu_callback_t func)
  496. {
  497. unsigned long flags;
  498. bool needwake;
  499. rhp->next = NULL;
  500. rhp->func = func;
  501. raw_spin_lock_irqsave(&rcu_tasks_cbs_lock, flags);
  502. needwake = !rcu_tasks_cbs_head;
  503. *rcu_tasks_cbs_tail = rhp;
  504. rcu_tasks_cbs_tail = &rhp->next;
  505. raw_spin_unlock_irqrestore(&rcu_tasks_cbs_lock, flags);
  506. if (needwake) {
  507. rcu_spawn_tasks_kthread();
  508. wake_up(&rcu_tasks_cbs_wq);
  509. }
  510. }
  511. EXPORT_SYMBOL_GPL(call_rcu_tasks);
  512. /**
  513. * synchronize_rcu_tasks - wait until an rcu-tasks grace period has elapsed.
  514. *
  515. * Control will return to the caller some time after a full rcu-tasks
  516. * grace period has elapsed, in other words after all currently
  517. * executing rcu-tasks read-side critical sections have elapsed. These
  518. * read-side critical sections are delimited by calls to schedule(),
  519. * cond_resched_rcu_qs(), idle execution, userspace execution, calls
  520. * to synchronize_rcu_tasks(), and (in theory, anyway) cond_resched().
  521. *
  522. * This is a very specialized primitive, intended only for a few uses in
  523. * tracing and other situations requiring manipulation of function
  524. * preambles and profiling hooks. The synchronize_rcu_tasks() function
  525. * is not (yet) intended for heavy use from multiple CPUs.
  526. *
  527. * Note that this guarantee implies further memory-ordering guarantees.
  528. * On systems with more than one CPU, when synchronize_rcu_tasks() returns,
  529. * each CPU is guaranteed to have executed a full memory barrier since the
  530. * end of its last RCU-tasks read-side critical section whose beginning
  531. * preceded the call to synchronize_rcu_tasks(). In addition, each CPU
  532. * having an RCU-tasks read-side critical section that extends beyond
  533. * the return from synchronize_rcu_tasks() is guaranteed to have executed
  534. * a full memory barrier after the beginning of synchronize_rcu_tasks()
  535. * and before the beginning of that RCU-tasks read-side critical section.
  536. * Note that these guarantees include CPUs that are offline, idle, or
  537. * executing in user mode, as well as CPUs that are executing in the kernel.
  538. *
  539. * Furthermore, if CPU A invoked synchronize_rcu_tasks(), which returned
  540. * to its caller on CPU B, then both CPU A and CPU B are guaranteed
  541. * to have executed a full memory barrier during the execution of
  542. * synchronize_rcu_tasks() -- even if CPU A and CPU B are the same CPU
  543. * (but again only if the system has more than one CPU).
  544. */
  545. void synchronize_rcu_tasks(void)
  546. {
  547. /* Complain if the scheduler has not started. */
  548. RCU_LOCKDEP_WARN(!rcu_scheduler_active,
  549. "synchronize_rcu_tasks called too soon");
  550. /* Wait for the grace period. */
  551. wait_rcu_gp(call_rcu_tasks);
  552. }
  553. EXPORT_SYMBOL_GPL(synchronize_rcu_tasks);
  554. /**
  555. * rcu_barrier_tasks - Wait for in-flight call_rcu_tasks() callbacks.
  556. *
  557. * Although the current implementation is guaranteed to wait, it is not
  558. * obligated to, for example, if there are no pending callbacks.
  559. */
  560. void rcu_barrier_tasks(void)
  561. {
  562. /* There is only one callback queue, so this is easy. ;-) */
  563. synchronize_rcu_tasks();
  564. }
  565. EXPORT_SYMBOL_GPL(rcu_barrier_tasks);
  566. /* See if tasks are still holding out, complain if so. */
  567. static void check_holdout_task(struct task_struct *t,
  568. bool needreport, bool *firstreport)
  569. {
  570. int cpu;
  571. if (!READ_ONCE(t->rcu_tasks_holdout) ||
  572. t->rcu_tasks_nvcsw != READ_ONCE(t->nvcsw) ||
  573. !READ_ONCE(t->on_rq) ||
  574. (IS_ENABLED(CONFIG_NO_HZ_FULL) &&
  575. !is_idle_task(t) && t->rcu_tasks_idle_cpu >= 0)) {
  576. WRITE_ONCE(t->rcu_tasks_holdout, false);
  577. list_del_init(&t->rcu_tasks_holdout_list);
  578. put_task_struct(t);
  579. return;
  580. }
  581. if (!needreport)
  582. return;
  583. if (*firstreport) {
  584. pr_err("INFO: rcu_tasks detected stalls on tasks:\n");
  585. *firstreport = false;
  586. }
  587. cpu = task_cpu(t);
  588. pr_alert("%p: %c%c nvcsw: %lu/%lu holdout: %d idle_cpu: %d/%d\n",
  589. t, ".I"[is_idle_task(t)],
  590. "N."[cpu < 0 || !tick_nohz_full_cpu(cpu)],
  591. t->rcu_tasks_nvcsw, t->nvcsw, t->rcu_tasks_holdout,
  592. t->rcu_tasks_idle_cpu, cpu);
  593. sched_show_task(t);
  594. }
  595. /* RCU-tasks kthread that detects grace periods and invokes callbacks. */
  596. static int __noreturn rcu_tasks_kthread(void *arg)
  597. {
  598. unsigned long flags;
  599. struct task_struct *g, *t;
  600. unsigned long lastreport;
  601. struct rcu_head *list;
  602. struct rcu_head *next;
  603. LIST_HEAD(rcu_tasks_holdouts);
  604. /* Run on housekeeping CPUs by default. Sysadm can move if desired. */
  605. housekeeping_affine(current);
  606. /*
  607. * Each pass through the following loop makes one check for
  608. * newly arrived callbacks, and, if there are some, waits for
  609. * one RCU-tasks grace period and then invokes the callbacks.
  610. * This loop is terminated by the system going down. ;-)
  611. */
  612. for (;;) {
  613. /* Pick up any new callbacks. */
  614. raw_spin_lock_irqsave(&rcu_tasks_cbs_lock, flags);
  615. list = rcu_tasks_cbs_head;
  616. rcu_tasks_cbs_head = NULL;
  617. rcu_tasks_cbs_tail = &rcu_tasks_cbs_head;
  618. raw_spin_unlock_irqrestore(&rcu_tasks_cbs_lock, flags);
  619. /* If there were none, wait a bit and start over. */
  620. if (!list) {
  621. wait_event_interruptible(rcu_tasks_cbs_wq,
  622. rcu_tasks_cbs_head);
  623. if (!rcu_tasks_cbs_head) {
  624. WARN_ON(signal_pending(current));
  625. schedule_timeout_interruptible(HZ/10);
  626. }
  627. continue;
  628. }
  629. /*
  630. * Wait for all pre-existing t->on_rq and t->nvcsw
  631. * transitions to complete. Invoking synchronize_sched()
  632. * suffices because all these transitions occur with
  633. * interrupts disabled. Without this synchronize_sched(),
  634. * a read-side critical section that started before the
  635. * grace period might be incorrectly seen as having started
  636. * after the grace period.
  637. *
  638. * This synchronize_sched() also dispenses with the
  639. * need for a memory barrier on the first store to
  640. * ->rcu_tasks_holdout, as it forces the store to happen
  641. * after the beginning of the grace period.
  642. */
  643. synchronize_sched();
  644. /*
  645. * There were callbacks, so we need to wait for an
  646. * RCU-tasks grace period. Start off by scanning
  647. * the task list for tasks that are not already
  648. * voluntarily blocked. Mark these tasks and make
  649. * a list of them in rcu_tasks_holdouts.
  650. */
  651. rcu_read_lock();
  652. for_each_process_thread(g, t) {
  653. if (t != current && READ_ONCE(t->on_rq) &&
  654. !is_idle_task(t)) {
  655. get_task_struct(t);
  656. t->rcu_tasks_nvcsw = READ_ONCE(t->nvcsw);
  657. WRITE_ONCE(t->rcu_tasks_holdout, true);
  658. list_add(&t->rcu_tasks_holdout_list,
  659. &rcu_tasks_holdouts);
  660. }
  661. }
  662. rcu_read_unlock();
  663. /*
  664. * Wait for tasks that are in the process of exiting.
  665. * This does only part of the job, ensuring that all
  666. * tasks that were previously exiting reach the point
  667. * where they have disabled preemption, allowing the
  668. * later synchronize_sched() to finish the job.
  669. */
  670. synchronize_srcu(&tasks_rcu_exit_srcu);
  671. /*
  672. * Each pass through the following loop scans the list
  673. * of holdout tasks, removing any that are no longer
  674. * holdouts. When the list is empty, we are done.
  675. */
  676. lastreport = jiffies;
  677. while (!list_empty(&rcu_tasks_holdouts)) {
  678. bool firstreport;
  679. bool needreport;
  680. int rtst;
  681. struct task_struct *t1;
  682. schedule_timeout_interruptible(HZ);
  683. rtst = READ_ONCE(rcu_task_stall_timeout);
  684. needreport = rtst > 0 &&
  685. time_after(jiffies, lastreport + rtst);
  686. if (needreport)
  687. lastreport = jiffies;
  688. firstreport = true;
  689. WARN_ON(signal_pending(current));
  690. list_for_each_entry_safe(t, t1, &rcu_tasks_holdouts,
  691. rcu_tasks_holdout_list) {
  692. check_holdout_task(t, needreport, &firstreport);
  693. cond_resched();
  694. }
  695. }
  696. /*
  697. * Because ->on_rq and ->nvcsw are not guaranteed
  698. * to have a full memory barriers prior to them in the
  699. * schedule() path, memory reordering on other CPUs could
  700. * cause their RCU-tasks read-side critical sections to
  701. * extend past the end of the grace period. However,
  702. * because these ->nvcsw updates are carried out with
  703. * interrupts disabled, we can use synchronize_sched()
  704. * to force the needed ordering on all such CPUs.
  705. *
  706. * This synchronize_sched() also confines all
  707. * ->rcu_tasks_holdout accesses to be within the grace
  708. * period, avoiding the need for memory barriers for
  709. * ->rcu_tasks_holdout accesses.
  710. *
  711. * In addition, this synchronize_sched() waits for exiting
  712. * tasks to complete their final preempt_disable() region
  713. * of execution, cleaning up after the synchronize_srcu()
  714. * above.
  715. */
  716. synchronize_sched();
  717. /* Invoke the callbacks. */
  718. while (list) {
  719. next = list->next;
  720. local_bh_disable();
  721. list->func(list);
  722. local_bh_enable();
  723. list = next;
  724. cond_resched();
  725. }
  726. schedule_timeout_uninterruptible(HZ/10);
  727. }
  728. }
  729. /* Spawn rcu_tasks_kthread() at first call to call_rcu_tasks(). */
  730. static void rcu_spawn_tasks_kthread(void)
  731. {
  732. static DEFINE_MUTEX(rcu_tasks_kthread_mutex);
  733. static struct task_struct *rcu_tasks_kthread_ptr;
  734. struct task_struct *t;
  735. if (READ_ONCE(rcu_tasks_kthread_ptr)) {
  736. smp_mb(); /* Ensure caller sees full kthread. */
  737. return;
  738. }
  739. mutex_lock(&rcu_tasks_kthread_mutex);
  740. if (rcu_tasks_kthread_ptr) {
  741. mutex_unlock(&rcu_tasks_kthread_mutex);
  742. return;
  743. }
  744. t = kthread_run(rcu_tasks_kthread, NULL, "rcu_tasks_kthread");
  745. BUG_ON(IS_ERR(t));
  746. smp_mb(); /* Ensure others see full kthread. */
  747. WRITE_ONCE(rcu_tasks_kthread_ptr, t);
  748. mutex_unlock(&rcu_tasks_kthread_mutex);
  749. }
  750. #endif /* #ifdef CONFIG_TASKS_RCU */
  751. #ifdef CONFIG_PROVE_RCU
  752. /*
  753. * Early boot self test parameters, one for each flavor
  754. */
  755. static bool rcu_self_test;
  756. static bool rcu_self_test_bh;
  757. static bool rcu_self_test_sched;
  758. module_param(rcu_self_test, bool, 0444);
  759. module_param(rcu_self_test_bh, bool, 0444);
  760. module_param(rcu_self_test_sched, bool, 0444);
  761. static int rcu_self_test_counter;
  762. static void test_callback(struct rcu_head *r)
  763. {
  764. rcu_self_test_counter++;
  765. pr_info("RCU test callback executed %d\n", rcu_self_test_counter);
  766. }
  767. static void early_boot_test_call_rcu(void)
  768. {
  769. static struct rcu_head head;
  770. call_rcu(&head, test_callback);
  771. }
  772. static void early_boot_test_call_rcu_bh(void)
  773. {
  774. static struct rcu_head head;
  775. call_rcu_bh(&head, test_callback);
  776. }
  777. static void early_boot_test_call_rcu_sched(void)
  778. {
  779. static struct rcu_head head;
  780. call_rcu_sched(&head, test_callback);
  781. }
  782. void rcu_early_boot_tests(void)
  783. {
  784. pr_info("Running RCU self tests\n");
  785. if (rcu_self_test)
  786. early_boot_test_call_rcu();
  787. if (rcu_self_test_bh)
  788. early_boot_test_call_rcu_bh();
  789. if (rcu_self_test_sched)
  790. early_boot_test_call_rcu_sched();
  791. }
  792. static int rcu_verify_early_boot_tests(void)
  793. {
  794. int ret = 0;
  795. int early_boot_test_counter = 0;
  796. if (rcu_self_test) {
  797. early_boot_test_counter++;
  798. rcu_barrier();
  799. }
  800. if (rcu_self_test_bh) {
  801. early_boot_test_counter++;
  802. rcu_barrier_bh();
  803. }
  804. if (rcu_self_test_sched) {
  805. early_boot_test_counter++;
  806. rcu_barrier_sched();
  807. }
  808. if (rcu_self_test_counter != early_boot_test_counter) {
  809. WARN_ON(1);
  810. ret = -1;
  811. }
  812. return ret;
  813. }
  814. late_initcall(rcu_verify_early_boot_tests);
  815. #else
  816. void rcu_early_boot_tests(void) {}
  817. #endif /* CONFIG_PROVE_RCU */