blob: 19bf6fa3ee6a1ff9133bb62ecaba7fd0f082d5e1 [file] [log] [blame]
Paul E. McKenney38b4df62019-01-17 10:25:18 -08001// SPDX-License-Identifier: GPL-2.0+
Linus Torvalds1da177e2005-04-16 15:20:36 -07002/*
3 * Read-Copy Update mechanism for mutual exclusion
4 *
Paul E. McKenney01c1c662008-01-25 21:08:24 +01005 * Copyright IBM Corporation, 2001
Linus Torvalds1da177e2005-04-16 15:20:36 -07006 *
7 * Authors: Dipankar Sarma <dipankar@in.ibm.com>
8 * Manfred Spraul <manfred@colorfullife.com>
Paul E. McKenneya71fca52009-09-18 10:28:19 -07009 *
Paul E. McKenney38b4df62019-01-17 10:25:18 -080010 * Based on the original work by Paul McKenney <paulmck@linux.ibm.com>
Linus Torvalds1da177e2005-04-16 15:20:36 -070011 * and inputs from Rusty Russell, Andrea Arcangeli and Andi Kleen.
12 * Papers:
13 * http://www.rdrop.com/users/paulmck/paper/rclockpdcsproof.pdf
14 * http://lse.sourceforge.net/locking/rclock_OLS.2001.05.01c.sc.pdf (OLS2001)
15 *
16 * For detailed explanation of Read-Copy Update mechanism see -
Paul E. McKenneya71fca52009-09-18 10:28:19 -070017 * http://lse.sourceforge.net/locking/rcupdate.html
Linus Torvalds1da177e2005-04-16 15:20:36 -070018 *
19 */
20#include <linux/types.h>
21#include <linux/kernel.h>
22#include <linux/init.h>
23#include <linux/spinlock.h>
24#include <linux/smp.h>
25#include <linux/interrupt.h>
Ingo Molnar3f07c012017-02-08 18:51:30 +010026#include <linux/sched/signal.h>
Ingo Molnarb17b0152017-02-08 18:51:35 +010027#include <linux/sched/debug.h>
Arun Sharma600634972011-07-26 16:09:06 -070028#include <linux/atomic.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070029#include <linux/bitops.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070030#include <linux/percpu.h>
31#include <linux/notifier.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070032#include <linux/cpu.h>
Ingo Molnar9331b312006-03-23 03:00:19 -080033#include <linux/mutex.h>
Paul Gortmaker9984de12011-05-23 14:51:41 -040034#include <linux/export.h>
Paul E. McKenneye3818b82010-03-15 17:03:43 -070035#include <linux/hardirq.h>
Paul E. McKenneye3ebfb92012-07-02 14:42:01 -070036#include <linux/delay.h>
Paul Gortmakere77b7042016-07-15 12:19:41 -040037#include <linux/moduleparam.h>
Paul E. McKenney8315f422014-06-27 13:42:20 -070038#include <linux/kthread.h>
Paul E. McKenney4ff475e2014-08-10 19:47:12 -070039#include <linux/tick.h>
Ingo Molnarf9411eb2017-02-06 09:50:49 +010040#include <linux/rcupdate_wait.h>
Frederic Weisbecker78634062017-10-27 04:42:28 +020041#include <linux/sched/isolation.h>
Masami Hiramatsua39f15b2019-02-13 01:14:37 +090042#include <linux/kprobes.h>
Byungchul Parka35d1692019-08-05 18:22:27 -040043#include <linux/slab.h>
Paul E. McKenneyb38f57c2020-03-20 14:29:08 -070044#include <linux/irq_work.h>
Paul E. McKenney5b3cc992020-05-28 19:33:47 -070045#include <linux/rcupdate_trace.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070046
Paul E. McKenney29c00b42011-06-17 15:53:19 -070047#define CREATE_TRACE_POINTS
Paul E. McKenney29c00b42011-06-17 15:53:19 -070048
49#include "rcu.h"
50
Paul E. McKenney4102ada2013-10-08 20:23:47 -070051#ifdef MODULE_PARAM_PREFIX
52#undef MODULE_PARAM_PREFIX
53#endif
54#define MODULE_PARAM_PREFIX "rcupdate."
55
Paul E. McKenney79cfea022015-12-07 13:09:52 -080056#ifndef CONFIG_TINY_RCU
Juri Lelli1eac0072021-08-10 10:48:16 +020057module_param(rcu_expedited, int, 0444);
58module_param(rcu_normal, int, 0444);
Julia Cartwright36221e12020-12-15 15:16:47 +010059static int rcu_normal_after_boot = IS_ENABLED(CONFIG_PREEMPT_RT);
Juri Lelliebb6d302021-08-10 10:48:15 +020060#if !defined(CONFIG_PREEMPT_RT) || defined(CONFIG_NO_HZ_FULL)
Juri Lelli1eac0072021-08-10 10:48:16 +020061module_param(rcu_normal_after_boot, int, 0444);
Julia Cartwright36221e12020-12-15 15:16:47 +010062#endif
Paul E. McKenney79cfea022015-12-07 13:09:52 -080063#endif /* #ifndef CONFIG_TINY_RCU */
Paul E. McKenney3e42ec12015-11-25 18:56:00 -080064
Boqun Feng293e2422016-03-23 23:11:48 +080065#ifdef CONFIG_DEBUG_LOCK_ALLOC
Denys Vlasenkod5671f62015-05-26 17:48:34 +020066/**
Joel Fernandes (Google)28875942019-07-16 18:12:22 -040067 * rcu_read_lock_held_common() - might we be in RCU-sched read-side critical section?
68 * @ret: Best guess answer if lockdep cannot be relied on
Denys Vlasenkod5671f62015-05-26 17:48:34 +020069 *
Mauro Carvalho Chehabc28d5c02020-03-17 15:54:18 +010070 * Returns true if lockdep must be ignored, in which case ``*ret`` contains
Joel Fernandes (Google)28875942019-07-16 18:12:22 -040071 * the best guess described below. Otherwise returns false, in which
Mauro Carvalho Chehabc28d5c02020-03-17 15:54:18 +010072 * case ``*ret`` tells the caller nothing and the caller should instead
Joel Fernandes (Google)28875942019-07-16 18:12:22 -040073 * consult lockdep.
74 *
Mauro Carvalho Chehabc28d5c02020-03-17 15:54:18 +010075 * If CONFIG_DEBUG_LOCK_ALLOC is selected, set ``*ret`` to nonzero iff in an
Denys Vlasenkod5671f62015-05-26 17:48:34 +020076 * RCU-sched read-side critical section. In absence of
77 * CONFIG_DEBUG_LOCK_ALLOC, this assumes we are in an RCU-sched read-side
78 * critical section unless it can prove otherwise. Note that disabling
79 * of preemption (including disabling irqs) counts as an RCU-sched
80 * read-side critical section. This is useful for debug checks in functions
81 * that required that they be called within an RCU-sched read-side
82 * critical section.
83 *
84 * Check debug_lockdep_rcu_enabled() to prevent false positives during boot
85 * and while lockdep is disabled.
86 *
Joel Fernandes (Google)28875942019-07-16 18:12:22 -040087 * Note that if the CPU is in the idle loop from an RCU point of view (ie:
Frederic Weisbeckere67198c2022-06-08 16:40:25 +020088 * that we are in the section between ct_idle_enter() and ct_idle_exit())
Mauro Carvalho Chehabc28d5c02020-03-17 15:54:18 +010089 * then rcu_read_lock_held() sets ``*ret`` to false even if the CPU did an
Joel Fernandes (Google)28875942019-07-16 18:12:22 -040090 * rcu_read_lock(). The reason for this is that RCU ignores CPUs that are
91 * in such a section, considering these as in extended quiescent state,
92 * so such a CPU is effectively never in an RCU read-side critical section
93 * regardless of what RCU primitives it invokes. This state of affairs is
94 * required --- we need to keep an RCU-free window in idle where the CPU may
95 * possibly enter into low power mode. This way we can notice an extended
96 * quiescent state to other CPUs that started a grace period. Otherwise
97 * we would delay any grace period as long as we run in the idle task.
Denys Vlasenkod5671f62015-05-26 17:48:34 +020098 *
Joel Fernandes (Google)28875942019-07-16 18:12:22 -040099 * Similarly, we avoid claiming an RCU read lock held if the current
Denys Vlasenkod5671f62015-05-26 17:48:34 +0200100 * CPU is offline.
101 */
Joel Fernandes (Google)28875942019-07-16 18:12:22 -0400102static bool rcu_read_lock_held_common(bool *ret)
103{
104 if (!debug_lockdep_rcu_enabled()) {
Jules Irengea66dbda2020-03-27 21:23:53 +0000105 *ret = true;
Joel Fernandes (Google)28875942019-07-16 18:12:22 -0400106 return true;
107 }
108 if (!rcu_is_watching()) {
Jules Irengea66dbda2020-03-27 21:23:53 +0000109 *ret = false;
Joel Fernandes (Google)28875942019-07-16 18:12:22 -0400110 return true;
111 }
112 if (!rcu_lockdep_current_cpu_online()) {
Jules Irengea66dbda2020-03-27 21:23:53 +0000113 *ret = false;
Joel Fernandes (Google)28875942019-07-16 18:12:22 -0400114 return true;
115 }
116 return false;
117}
118
Denys Vlasenkod5671f62015-05-26 17:48:34 +0200119int rcu_read_lock_sched_held(void)
120{
Joel Fernandes (Google)28875942019-07-16 18:12:22 -0400121 bool ret;
Denys Vlasenkod5671f62015-05-26 17:48:34 +0200122
Joel Fernandes (Google)28875942019-07-16 18:12:22 -0400123 if (rcu_read_lock_held_common(&ret))
124 return ret;
Joel Fernandes (Google)91470892019-07-16 18:12:21 -0400125 return lock_is_held(&rcu_sched_lock_map) || !preemptible();
Denys Vlasenkod5671f62015-05-26 17:48:34 +0200126}
127EXPORT_SYMBOL(rcu_read_lock_sched_held);
128#endif
129
Paul E. McKenney0d394822015-02-18 12:24:30 -0800130#ifndef CONFIG_TINY_RCU
131
Paul E. McKenney5a9be7c2015-11-24 15:44:06 -0800132/*
133 * Should expedited grace-period primitives always fall back to their
134 * non-expedited counterparts? Intended for use within RCU. Note
135 * that if the user specifies both rcu_expedited and rcu_normal, then
Paul E. McKenney52d7e482017-01-10 02:28:26 -0800136 * rcu_normal wins. (Except during the time period during boot from
Paul E. McKenney900b1022017-02-10 14:32:54 -0800137 * when the first task is spawned until the rcu_set_runtime_mode()
Paul E. McKenney52d7e482017-01-10 02:28:26 -0800138 * core_initcall() is invoked, at which point everything is expedited.)
Paul E. McKenney5a9be7c2015-11-24 15:44:06 -0800139 */
140bool rcu_gp_is_normal(void)
141{
Paul E. McKenney52d7e482017-01-10 02:28:26 -0800142 return READ_ONCE(rcu_normal) &&
143 rcu_scheduler_active != RCU_SCHEDULER_INIT;
Paul E. McKenney5a9be7c2015-11-24 15:44:06 -0800144}
Paul E. McKenney4f2a8482016-01-01 13:38:12 -0800145EXPORT_SYMBOL_GPL(rcu_gp_is_normal);
Paul E. McKenney5a9be7c2015-11-24 15:44:06 -0800146
Joel Fernandes (Google)6efdda82023-01-12 00:52:22 +0000147static atomic_t rcu_async_hurry_nesting = ATOMIC_INIT(1);
148/*
149 * Should call_rcu() callbacks be processed with urgency or are
150 * they OK being executed with arbitrary delays?
151 */
152bool rcu_async_should_hurry(void)
153{
154 return !IS_ENABLED(CONFIG_RCU_LAZY) ||
155 atomic_read(&rcu_async_hurry_nesting);
156}
157EXPORT_SYMBOL_GPL(rcu_async_should_hurry);
Paul E. McKenney0d394822015-02-18 12:24:30 -0800158
Joel Fernandes (Google)6efdda82023-01-12 00:52:22 +0000159/**
160 * rcu_async_hurry - Make future async RCU callbacks not lazy.
161 *
162 * After a call to this function, future calls to call_rcu()
163 * will be processed in a timely fashion.
164 */
165void rcu_async_hurry(void)
166{
167 if (IS_ENABLED(CONFIG_RCU_LAZY))
168 atomic_inc(&rcu_async_hurry_nesting);
169}
170EXPORT_SYMBOL_GPL(rcu_async_hurry);
171
172/**
173 * rcu_async_relax - Make future async RCU callbacks lazy.
174 *
175 * After a call to this function, future calls to call_rcu()
176 * will be processed in a lazy fashion.
177 */
178void rcu_async_relax(void)
179{
180 if (IS_ENABLED(CONFIG_RCU_LAZY))
181 atomic_dec(&rcu_async_hurry_nesting);
182}
183EXPORT_SYMBOL_GPL(rcu_async_relax);
184
185static atomic_t rcu_expedited_nesting = ATOMIC_INIT(1);
Paul E. McKenney0d394822015-02-18 12:24:30 -0800186/*
187 * Should normal grace-period primitives be expedited? Intended for
188 * use within RCU. Note that this function takes the rcu_expedited
Paul E. McKenney52d7e482017-01-10 02:28:26 -0800189 * sysfs/boot variable and rcu_scheduler_active into account as well
190 * as the rcu_expedite_gp() nesting. So looping on rcu_unexpedite_gp()
191 * until rcu_gp_is_expedited() returns false is a -really- bad idea.
Paul E. McKenney0d394822015-02-18 12:24:30 -0800192 */
193bool rcu_gp_is_expedited(void)
194{
Paul E. McKenneyb823caf2019-07-05 08:05:10 -0700195 return rcu_expedited || atomic_read(&rcu_expedited_nesting);
Paul E. McKenney0d394822015-02-18 12:24:30 -0800196}
197EXPORT_SYMBOL_GPL(rcu_gp_is_expedited);
198
199/**
200 * rcu_expedite_gp - Expedite future RCU grace periods
201 *
202 * After a call to this function, future calls to synchronize_rcu() and
203 * friends act as the corresponding synchronize_rcu_expedited() function
204 * had instead been called.
205 */
206void rcu_expedite_gp(void)
207{
208 atomic_inc(&rcu_expedited_nesting);
209}
210EXPORT_SYMBOL_GPL(rcu_expedite_gp);
211
212/**
213 * rcu_unexpedite_gp - Cancel prior rcu_expedite_gp() invocation
214 *
215 * Undo a prior call to rcu_expedite_gp(). If all prior calls to
216 * rcu_expedite_gp() are undone by a subsequent call to rcu_unexpedite_gp(),
217 * and if the rcu_expedited sysfs/boot parameter is not set, then all
218 * subsequent calls to synchronize_rcu() and friends will return to
219 * their normal non-expedited behavior.
220 */
221void rcu_unexpedite_gp(void)
222{
223 atomic_dec(&rcu_expedited_nesting);
224}
225EXPORT_SYMBOL_GPL(rcu_unexpedite_gp);
226
Paul E. McKenney59ee0322019-11-28 18:54:06 -0800227static bool rcu_boot_ended __read_mostly;
228
Paul E. McKenneyee425712015-02-19 10:51:32 -0800229/*
230 * Inform RCU of the end of the in-kernel boot sequence.
231 */
232void rcu_end_inkernel_boot(void)
233{
Sebastian Andrzej Siewior7c6094d2016-11-02 17:30:02 +0100234 rcu_unexpedite_gp();
Joel Fernandes (Google)6efdda82023-01-12 00:52:22 +0000235 rcu_async_relax();
Paul E. McKenney3e42ec12015-11-25 18:56:00 -0800236 if (rcu_normal_after_boot)
237 WRITE_ONCE(rcu_normal, 1);
Jules Irengee40bb922020-06-01 19:45:49 +0100238 rcu_boot_ended = true;
Paul E. McKenneyee425712015-02-19 10:51:32 -0800239}
Paul E. McKenney0d394822015-02-18 12:24:30 -0800240
Paul E. McKenney59ee0322019-11-28 18:54:06 -0800241/*
242 * Let rcutorture know when it is OK to turn it up to eleven.
243 */
244bool rcu_inkernel_boot_has_ended(void)
245{
246 return rcu_boot_ended;
247}
248EXPORT_SYMBOL_GPL(rcu_inkernel_boot_has_ended);
249
Paul E. McKenney79cfea022015-12-07 13:09:52 -0800250#endif /* #ifndef CONFIG_TINY_RCU */
251
Paul E. McKenney900b1022017-02-10 14:32:54 -0800252/*
253 * Test each non-SRCU synchronous grace-period wait API. This is
254 * useful just after a change in mode for these primitives, and
255 * during early boot.
256 */
257void rcu_test_sync_prims(void)
258{
259 if (!IS_ENABLED(CONFIG_PROVE_RCU))
260 return;
Paul E. McKenney748bf472022-12-19 17:02:20 -0800261 pr_info("Running RCU synchronous self tests\n");
Paul E. McKenney900b1022017-02-10 14:32:54 -0800262 synchronize_rcu();
Paul E. McKenney900b1022017-02-10 14:32:54 -0800263 synchronize_rcu_expedited();
Paul E. McKenney900b1022017-02-10 14:32:54 -0800264}
265
Paul E. McKenney0cd7e352022-11-22 13:53:57 -0800266#if !defined(CONFIG_TINY_RCU)
Paul E. McKenney900b1022017-02-10 14:32:54 -0800267
268/*
269 * Switch to run-time mode once RCU has fully initialized.
270 */
271static int __init rcu_set_runtime_mode(void)
272{
273 rcu_test_sync_prims();
274 rcu_scheduler_active = RCU_SCHEDULER_RUNNING;
Byungchul Parka35d1692019-08-05 18:22:27 -0400275 kfree_rcu_scheduler_running();
Paul E. McKenney900b1022017-02-10 14:32:54 -0800276 rcu_test_sync_prims();
277 return 0;
278}
279core_initcall(rcu_set_runtime_mode);
280
Paul E. McKenney0cd7e352022-11-22 13:53:57 -0800281#endif /* #if !defined(CONFIG_TINY_RCU) */
Paul E. McKenney900b1022017-02-10 14:32:54 -0800282
Paul E. McKenney162cc272009-09-23 16:18:13 -0700283#ifdef CONFIG_DEBUG_LOCK_ALLOC
284static struct lock_class_key rcu_lock_key;
Peter Zijlstrade8f5e42020-03-21 12:26:01 +0100285struct lockdep_map rcu_lock_map = {
286 .name = "rcu_read_lock",
287 .key = &rcu_lock_key,
288 .wait_type_outer = LD_WAIT_FREE,
Zhouyi Zhoua2e05dd2021-08-11 10:59:20 +0800289 .wait_type_inner = LD_WAIT_CONFIG, /* PREEMPT_RT implies PREEMPT_RCU */
Peter Zijlstrade8f5e42020-03-21 12:26:01 +0100290};
Paul E. McKenney162cc272009-09-23 16:18:13 -0700291EXPORT_SYMBOL_GPL(rcu_lock_map);
Paul E. McKenney632ee202010-02-22 17:04:45 -0800292
293static struct lock_class_key rcu_bh_lock_key;
Peter Zijlstrade8f5e42020-03-21 12:26:01 +0100294struct lockdep_map rcu_bh_lock_map = {
295 .name = "rcu_read_lock_bh",
296 .key = &rcu_bh_lock_key,
297 .wait_type_outer = LD_WAIT_FREE,
Zhouyi Zhoua2e05dd2021-08-11 10:59:20 +0800298 .wait_type_inner = LD_WAIT_CONFIG, /* PREEMPT_RT makes BH preemptible. */
Peter Zijlstrade8f5e42020-03-21 12:26:01 +0100299};
Paul E. McKenney632ee202010-02-22 17:04:45 -0800300EXPORT_SYMBOL_GPL(rcu_bh_lock_map);
301
302static struct lock_class_key rcu_sched_lock_key;
Peter Zijlstrade8f5e42020-03-21 12:26:01 +0100303struct lockdep_map rcu_sched_lock_map = {
304 .name = "rcu_read_lock_sched",
305 .key = &rcu_sched_lock_key,
306 .wait_type_outer = LD_WAIT_FREE,
307 .wait_type_inner = LD_WAIT_SPIN,
308};
Paul E. McKenney632ee202010-02-22 17:04:45 -0800309EXPORT_SYMBOL_GPL(rcu_sched_lock_map);
Paul E. McKenneye3818b82010-03-15 17:03:43 -0700310
Paul E. McKenneyf8466f92020-05-03 19:16:09 -0700311// Tell lockdep when RCU callbacks are being invoked.
Paul E. McKenney24ef6592013-10-28 09:22:24 -0700312static struct lock_class_key rcu_callback_key;
313struct lockdep_map rcu_callback_map =
314 STATIC_LOCKDEP_MAP_INIT("rcu_callback", &rcu_callback_key);
315EXPORT_SYMBOL_GPL(rcu_callback_map);
316
Thomas Gleixnerff5c4f52020-03-13 17:32:17 +0100317noinstr int notrace debug_lockdep_rcu_enabled(void)
Paul E. McKenneybc293d62010-04-15 12:50:39 -0700318{
Paul E. McKenney30668202021-04-05 09:51:05 -0700319 return rcu_scheduler_active != RCU_SCHEDULER_INACTIVE && READ_ONCE(debug_locks) &&
Paul E. McKenneybc293d62010-04-15 12:50:39 -0700320 current->lockdep_recursion == 0;
321}
322EXPORT_SYMBOL_GPL(debug_lockdep_rcu_enabled);
323
Paul E. McKenneye3818b82010-03-15 17:03:43 -0700324/**
Oleg Nesterov85b39d32014-07-08 15:17:59 -0700325 * rcu_read_lock_held() - might we be in RCU read-side critical section?
326 *
327 * If CONFIG_DEBUG_LOCK_ALLOC is selected, returns nonzero iff in an RCU
328 * read-side critical section. In absence of CONFIG_DEBUG_LOCK_ALLOC,
329 * this assumes we are in an RCU read-side critical section unless it can
330 * prove otherwise. This is useful for debug checks in functions that
331 * require that they be called within an RCU read-side critical section.
332 *
333 * Checks debug_lockdep_rcu_enabled() to prevent false positives during boot
334 * and while lockdep is disabled.
335 *
336 * Note that rcu_read_lock() and the matching rcu_read_unlock() must
337 * occur in the same context, for example, it is illegal to invoke
338 * rcu_read_unlock() in process context if the matching rcu_read_lock()
339 * was invoked from within an irq handler.
340 *
341 * Note that rcu_read_lock() is disallowed if the CPU is either idle or
342 * offline from an RCU perspective, so check for those as well.
343 */
344int rcu_read_lock_held(void)
345{
Joel Fernandes (Google)28875942019-07-16 18:12:22 -0400346 bool ret;
347
348 if (rcu_read_lock_held_common(&ret))
349 return ret;
Oleg Nesterov85b39d32014-07-08 15:17:59 -0700350 return lock_is_held(&rcu_lock_map);
351}
352EXPORT_SYMBOL_GPL(rcu_read_lock_held);
353
354/**
Paul E. McKenneyca5ecdd2010-04-28 14:39:09 -0700355 * rcu_read_lock_bh_held() - might we be in RCU-bh read-side critical section?
Paul E. McKenneye3818b82010-03-15 17:03:43 -0700356 *
357 * Check for bottom half being disabled, which covers both the
358 * CONFIG_PROVE_RCU and not cases. Note that if someone uses
359 * rcu_read_lock_bh(), but then later enables BH, lockdep (if enabled)
Paul E. McKenneyca5ecdd2010-04-28 14:39:09 -0700360 * will show the situation. This is useful for debug checks in functions
361 * that require that they be called within an RCU read-side critical
362 * section.
Paul E. McKenneye3818b82010-03-15 17:03:43 -0700363 *
364 * Check debug_lockdep_rcu_enabled() to prevent false positives during boot.
Paul E. McKenneyc0d6d012012-01-23 12:41:26 -0800365 *
Paul E. McKenney82fcecf2018-07-02 09:04:27 -0700366 * Note that rcu_read_lock_bh() is disallowed if the CPU is either idle or
Paul E. McKenneyc0d6d012012-01-23 12:41:26 -0800367 * offline from an RCU perspective, so check for those as well.
Paul E. McKenneye3818b82010-03-15 17:03:43 -0700368 */
369int rcu_read_lock_bh_held(void)
370{
Joel Fernandes (Google)28875942019-07-16 18:12:22 -0400371 bool ret;
372
373 if (rcu_read_lock_held_common(&ret))
374 return ret;
Paul E. McKenney773e3f92010-10-05 14:03:02 -0700375 return in_softirq() || irqs_disabled();
Paul E. McKenneye3818b82010-03-15 17:03:43 -0700376}
377EXPORT_SYMBOL_GPL(rcu_read_lock_bh_held);
378
Joel Fernandes (Google)28875942019-07-16 18:12:22 -0400379int rcu_read_lock_any_held(void)
380{
381 bool ret;
382
383 if (rcu_read_lock_held_common(&ret))
384 return ret;
385 if (lock_is_held(&rcu_lock_map) ||
386 lock_is_held(&rcu_bh_lock_map) ||
387 lock_is_held(&rcu_sched_lock_map))
388 return 1;
389 return !preemptible();
390}
391EXPORT_SYMBOL_GPL(rcu_read_lock_any_held);
392
Paul E. McKenneye3818b82010-03-15 17:03:43 -0700393#endif /* #ifdef CONFIG_DEBUG_LOCK_ALLOC */
394
Paul E. McKenneyee376db2015-01-10 19:47:10 -0800395/**
396 * wakeme_after_rcu() - Callback function to awaken a task after grace period
397 * @head: Pointer to rcu_head member within rcu_synchronize structure
398 *
399 * Awaken the corresponding task now that a grace period has elapsed.
Paul E. McKenneyfbf6bfc2008-02-13 15:03:15 -0800400 */
Paul E. McKenneyee376db2015-01-10 19:47:10 -0800401void wakeme_after_rcu(struct rcu_head *head)
Dipankar Sarma21a1ea92006-03-07 21:55:33 -0800402{
Paul E. McKenney01c1c662008-01-25 21:08:24 +0100403 struct rcu_synchronize *rcu;
404
405 rcu = container_of(head, struct rcu_synchronize, head);
406 complete(&rcu->completion);
Dipankar Sarma21a1ea92006-03-07 21:55:33 -0800407}
Paul E. McKenneyec90a192015-06-10 12:53:06 -0700408EXPORT_SYMBOL_GPL(wakeme_after_rcu);
Paul E. McKenneyee84b822010-05-06 09:28:41 -0700409
Paul E. McKenneyec90a192015-06-10 12:53:06 -0700410void __wait_rcu_gp(bool checktiny, int n, call_rcu_func_t *crcu_array,
411 struct rcu_synchronize *rs_array)
Paul E. McKenney2c428182011-05-26 22:14:36 -0700412{
Paul E. McKenneyec90a192015-06-10 12:53:06 -0700413 int i;
Paul E. McKenney68ab0b42017-04-28 16:19:07 -0700414 int j;
Paul E. McKenney2c428182011-05-26 22:14:36 -0700415
Paul E. McKenney06462ef2018-07-08 10:58:37 -0700416 /* Initialize and register callbacks for each crcu_array element. */
Paul E. McKenneyec90a192015-06-10 12:53:06 -0700417 for (i = 0; i < n; i++) {
418 if (checktiny &&
Paul E. McKenney309ba852018-07-11 14:36:49 -0700419 (crcu_array[i] == call_rcu)) {
Paul E. McKenneyec90a192015-06-10 12:53:06 -0700420 might_sleep();
421 continue;
422 }
Paul E. McKenney68ab0b42017-04-28 16:19:07 -0700423 for (j = 0; j < i; j++)
424 if (crcu_array[j] == crcu_array[i])
425 break;
Wei Yang7ee880b2020-04-15 22:26:55 +0000426 if (j == i) {
427 init_rcu_head_on_stack(&rs_array[i].head);
428 init_completion(&rs_array[i].completion);
Paul E. McKenney68ab0b42017-04-28 16:19:07 -0700429 (crcu_array[i])(&rs_array[i].head, wakeme_after_rcu);
Wei Yang7ee880b2020-04-15 22:26:55 +0000430 }
Paul E. McKenneyec90a192015-06-10 12:53:06 -0700431 }
432
433 /* Wait for all callbacks to be invoked. */
434 for (i = 0; i < n; i++) {
435 if (checktiny &&
Paul E. McKenney309ba852018-07-11 14:36:49 -0700436 (crcu_array[i] == call_rcu))
Paul E. McKenneyec90a192015-06-10 12:53:06 -0700437 continue;
Paul E. McKenney68ab0b42017-04-28 16:19:07 -0700438 for (j = 0; j < i; j++)
439 if (crcu_array[j] == crcu_array[i])
440 break;
Wei Yang7ee880b2020-04-15 22:26:55 +0000441 if (j == i) {
Paul E. McKenney68ab0b42017-04-28 16:19:07 -0700442 wait_for_completion(&rs_array[i].completion);
Wei Yang7ee880b2020-04-15 22:26:55 +0000443 destroy_rcu_head_on_stack(&rs_array[i].head);
444 }
Paul E. McKenneyec90a192015-06-10 12:53:06 -0700445 }
Paul E. McKenney2c428182011-05-26 22:14:36 -0700446}
Paul E. McKenneyec90a192015-06-10 12:53:06 -0700447EXPORT_SYMBOL_GPL(__wait_rcu_gp);
Paul E. McKenney2c428182011-05-26 22:14:36 -0700448
Ingo Molnar58d42922022-01-14 16:07:28 -0800449void finish_rcuwait(struct rcuwait *w)
450{
451 rcu_assign_pointer(w->task, NULL);
452 __set_current_state(TASK_RUNNING);
453}
454EXPORT_SYMBOL_GPL(finish_rcuwait);
455
Mathieu Desnoyers551d55a2010-04-17 08:48:42 -0400456#ifdef CONFIG_DEBUG_OBJECTS_RCU_HEAD
Paul E. McKenney546a9d82014-06-19 14:57:10 -0700457void init_rcu_head(struct rcu_head *head)
Mathieu Desnoyers551d55a2010-04-17 08:48:42 -0400458{
459 debug_object_init(head, &rcuhead_debug_descr);
460}
Paul E. McKenney156baec2017-12-07 09:40:38 -0800461EXPORT_SYMBOL_GPL(init_rcu_head);
Mathieu Desnoyers551d55a2010-04-17 08:48:42 -0400462
Paul E. McKenney546a9d82014-06-19 14:57:10 -0700463void destroy_rcu_head(struct rcu_head *head)
Mathieu Desnoyers551d55a2010-04-17 08:48:42 -0400464{
465 debug_object_free(head, &rcuhead_debug_descr);
466}
Paul E. McKenney156baec2017-12-07 09:40:38 -0800467EXPORT_SYMBOL_GPL(destroy_rcu_head);
Mathieu Desnoyers551d55a2010-04-17 08:48:42 -0400468
Du, Changbinb9fdac7f2016-05-19 17:09:41 -0700469static bool rcuhead_is_static_object(void *addr)
Mathieu Desnoyers551d55a2010-04-17 08:48:42 -0400470{
Du, Changbinb9fdac7f2016-05-19 17:09:41 -0700471 return true;
Mathieu Desnoyers551d55a2010-04-17 08:48:42 -0400472}
473
474/**
475 * init_rcu_head_on_stack() - initialize on-stack rcu_head for debugobjects
476 * @head: pointer to rcu_head structure to be initialized
477 *
478 * This function informs debugobjects of a new rcu_head structure that
479 * has been allocated as an auto variable on the stack. This function
480 * is not required for rcu_head structures that are statically defined or
481 * that are dynamically allocated on the heap. This function has no
482 * effect for !CONFIG_DEBUG_OBJECTS_RCU_HEAD kernel builds.
483 */
484void init_rcu_head_on_stack(struct rcu_head *head)
485{
486 debug_object_init_on_stack(head, &rcuhead_debug_descr);
487}
488EXPORT_SYMBOL_GPL(init_rcu_head_on_stack);
489
490/**
491 * destroy_rcu_head_on_stack() - destroy on-stack rcu_head for debugobjects
492 * @head: pointer to rcu_head structure to be initialized
493 *
494 * This function informs debugobjects that an on-stack rcu_head structure
495 * is about to go out of scope. As with init_rcu_head_on_stack(), this
496 * function is not required for rcu_head structures that are statically
497 * defined or that are dynamically allocated on the heap. Also as with
498 * init_rcu_head_on_stack(), this function has no effect for
499 * !CONFIG_DEBUG_OBJECTS_RCU_HEAD kernel builds.
500 */
501void destroy_rcu_head_on_stack(struct rcu_head *head)
502{
503 debug_object_free(head, &rcuhead_debug_descr);
504}
505EXPORT_SYMBOL_GPL(destroy_rcu_head_on_stack);
506
Stephen Boydf9e62f32020-08-14 17:40:27 -0700507const struct debug_obj_descr rcuhead_debug_descr = {
Mathieu Desnoyers551d55a2010-04-17 08:48:42 -0400508 .name = "rcu_head",
Du, Changbinb9fdac7f2016-05-19 17:09:41 -0700509 .is_static_object = rcuhead_is_static_object,
Mathieu Desnoyers551d55a2010-04-17 08:48:42 -0400510};
511EXPORT_SYMBOL_GPL(rcuhead_debug_descr);
512#endif /* #ifdef CONFIG_DEBUG_OBJECTS_RCU_HEAD */
Paul E. McKenney91afaf32011-10-02 07:44:32 -0700513
Lai Jiangshanb3e627d2019-10-15 02:55:57 +0000514#if defined(CONFIG_TREE_RCU) || defined(CONFIG_RCU_TRACE)
Steven Rostedt (Red Hat)e66c33d2013-07-12 16:50:28 -0400515void do_trace_rcu_torture_read(const char *rcutorturename, struct rcu_head *rhp,
Paul E. McKenney52494532012-11-14 16:26:40 -0800516 unsigned long secs,
517 unsigned long c_old, unsigned long c)
Paul E. McKenney91afaf32011-10-02 07:44:32 -0700518{
Paul E. McKenney52494532012-11-14 16:26:40 -0800519 trace_rcu_torture_read(rcutorturename, rhp, secs, c_old, c);
Paul E. McKenney91afaf32011-10-02 07:44:32 -0700520}
521EXPORT_SYMBOL_GPL(do_trace_rcu_torture_read);
522#else
Paul E. McKenney52494532012-11-14 16:26:40 -0800523#define do_trace_rcu_torture_read(rcutorturename, rhp, secs, c_old, c) \
524 do { } while (0)
Paul E. McKenney91afaf32011-10-02 07:44:32 -0700525#endif
Paul E. McKenney6bfc09e2012-10-19 12:49:17 -0700526
Paul E. McKenneyc682db52019-04-19 07:38:27 -0700527#if IS_ENABLED(CONFIG_RCU_TORTURE_TEST) || IS_MODULE(CONFIG_RCU_TORTURE_TEST)
528/* Get rcutorture access to sched_setaffinity(). */
529long rcutorture_sched_setaffinity(pid_t pid, const struct cpumask *in_mask)
530{
531 int ret;
532
533 ret = sched_setaffinity(pid, in_mask);
534 WARN_ONCE(ret, "%s: sched_setaffinity() returned %d\n", __func__, ret);
535 return ret;
536}
537EXPORT_SYMBOL_GPL(rcutorture_sched_setaffinity);
538#endif
539
Paul E. McKenney6bfc09e2012-10-19 12:49:17 -0700540#ifdef CONFIG_RCU_STALL_COMMON
Paul E. McKenneycdc694b2019-06-13 15:30:49 -0700541int rcu_cpu_stall_ftrace_dump __read_mostly;
542module_param(rcu_cpu_stall_ftrace_dump, int, 0644);
Paul E. McKenney58c53362019-12-05 11:29:01 -0800543int rcu_cpu_stall_suppress __read_mostly; // !0 = suppress stall warnings.
Paul E. McKenneyf22ce092017-09-01 14:40:54 -0700544EXPORT_SYMBOL_GPL(rcu_cpu_stall_suppress);
Paul E. McKenney6bfc09e2012-10-19 12:49:17 -0700545module_param(rcu_cpu_stall_suppress, int, 0644);
Paul E. McKenney10462d62019-01-11 16:10:57 -0800546int rcu_cpu_stall_timeout __read_mostly = CONFIG_RCU_CPU_STALL_TIMEOUT;
Paul E. McKenney6bfc09e2012-10-19 12:49:17 -0700547module_param(rcu_cpu_stall_timeout, int, 0644);
Uladzislau Rezki28b3ae42022-02-16 14:52:09 +0100548int rcu_exp_cpu_stall_timeout __read_mostly = CONFIG_RCU_EXP_CPU_STALL_TIMEOUT;
549module_param(rcu_exp_cpu_stall_timeout, int, 0644);
Zhen Leibe42f002022-11-19 17:25:06 +0800550int rcu_cpu_stall_cputime __read_mostly = IS_ENABLED(CONFIG_RCU_CPU_STALL_CPUTIME);
551module_param(rcu_cpu_stall_cputime, int, 0644);
Paul E. McKenney92987fe2022-12-19 18:02:20 -0800552bool rcu_exp_stall_task_details __read_mostly;
553module_param(rcu_exp_stall_task_details, bool, 0644);
Paul E. McKenney6bfc09e2012-10-19 12:49:17 -0700554#endif /* #ifdef CONFIG_RCU_STALL_COMMON */
Paul E. McKenney8315f422014-06-27 13:42:20 -0700555
Paul E. McKenney58c53362019-12-05 11:29:01 -0800556// Suppress boot-time RCU CPU stall warnings and rcutorture writer stall
557// warnings. Also used by rcutorture even if stall warnings are excluded.
558int rcu_cpu_stall_suppress_at_boot __read_mostly; // !0 = suppress boot stalls.
559EXPORT_SYMBOL_GPL(rcu_cpu_stall_suppress_at_boot);
560module_param(rcu_cpu_stall_suppress_at_boot, int, 0444);
561
Paul E. McKenney414c1232022-04-13 15:17:25 -0700562/**
563 * get_completed_synchronize_rcu - Return a pre-completed polled state cookie
564 *
565 * Returns a value that will always be treated by functions like
566 * poll_state_synchronize_rcu() as a cookie whose grace period has already
567 * completed.
568 */
569unsigned long get_completed_synchronize_rcu(void)
570{
571 return RCU_GET_STATE_COMPLETED;
572}
573EXPORT_SYMBOL_GPL(get_completed_synchronize_rcu);
574
Pranith Kumaraa23c6fbc2014-09-19 11:32:29 -0400575#ifdef CONFIG_PROVE_RCU
576
577/*
Paul E. McKenney72ce30d2018-07-07 10:24:23 -0700578 * Early boot self test parameters.
Pranith Kumaraa23c6fbc2014-09-19 11:32:29 -0400579 */
580static bool rcu_self_test;
Pranith Kumaraa23c6fbc2014-09-19 11:32:29 -0400581module_param(rcu_self_test, bool, 0444);
Pranith Kumaraa23c6fbc2014-09-19 11:32:29 -0400582
583static int rcu_self_test_counter;
584
585static void test_callback(struct rcu_head *r)
586{
587 rcu_self_test_counter++;
588 pr_info("RCU test callback executed %d\n", rcu_self_test_counter);
589}
590
Paul E. McKenneye0fcba92018-08-14 08:45:54 -0700591DEFINE_STATIC_SRCU(early_srcu);
Frederic Weisbecker0a580fa2021-04-14 15:24:13 +0200592static unsigned long early_srcu_cookie;
Paul E. McKenneye0fcba92018-08-14 08:45:54 -0700593
Byungchul Parka35d1692019-08-05 18:22:27 -0400594struct early_boot_kfree_rcu {
595 struct rcu_head rh;
596};
597
Pranith Kumaraa23c6fbc2014-09-19 11:32:29 -0400598static void early_boot_test_call_rcu(void)
599{
600 static struct rcu_head head;
Paul E. McKenneyefa3c402022-11-25 08:42:02 -0800601 int idx;
Paul E. McKenneye0fcba92018-08-14 08:45:54 -0700602 static struct rcu_head shead;
Byungchul Parka35d1692019-08-05 18:22:27 -0400603 struct early_boot_kfree_rcu *rhp;
Pranith Kumaraa23c6fbc2014-09-19 11:32:29 -0400604
Paul E. McKenneyefa3c402022-11-25 08:42:02 -0800605 idx = srcu_down_read(&early_srcu);
606 srcu_up_read(&early_srcu, idx);
Pranith Kumaraa23c6fbc2014-09-19 11:32:29 -0400607 call_rcu(&head, test_callback);
Paul E. McKenney0cd7e352022-11-22 13:53:57 -0800608 early_srcu_cookie = start_poll_synchronize_srcu(&early_srcu);
609 call_srcu(&early_srcu, &shead, test_callback);
Byungchul Parka35d1692019-08-05 18:22:27 -0400610 rhp = kmalloc(sizeof(*rhp), GFP_KERNEL);
611 if (!WARN_ON_ONCE(!rhp))
612 kfree_rcu(rhp, rh);
Pranith Kumaraa23c6fbc2014-09-19 11:32:29 -0400613}
614
615void rcu_early_boot_tests(void)
616{
617 pr_info("Running RCU self tests\n");
618
619 if (rcu_self_test)
620 early_boot_test_call_rcu();
Paul E. McKenney52d7e482017-01-10 02:28:26 -0800621 rcu_test_sync_prims();
Pranith Kumaraa23c6fbc2014-09-19 11:32:29 -0400622}
623
624static int rcu_verify_early_boot_tests(void)
625{
626 int ret = 0;
627 int early_boot_test_counter = 0;
628
629 if (rcu_self_test) {
630 early_boot_test_counter++;
631 rcu_barrier();
Paul E. McKenney0cd7e352022-11-22 13:53:57 -0800632 early_boot_test_counter++;
633 srcu_barrier(&early_srcu);
634 WARN_ON_ONCE(!poll_state_synchronize_srcu(&early_srcu, early_srcu_cookie));
Zqiang66ea1022022-11-10 15:30:13 +0800635 cleanup_srcu_struct(&early_srcu);
Pranith Kumaraa23c6fbc2014-09-19 11:32:29 -0400636 }
Pranith Kumaraa23c6fbc2014-09-19 11:32:29 -0400637 if (rcu_self_test_counter != early_boot_test_counter) {
638 WARN_ON(1);
639 ret = -1;
640 }
641
642 return ret;
643}
644late_initcall(rcu_verify_early_boot_tests);
645#else
646void rcu_early_boot_tests(void) {}
647#endif /* CONFIG_PROVE_RCU */
Paul E. McKenney59d80fd2017-04-28 10:20:28 -0700648
Paul E. McKenneyeacd6f02020-03-02 11:59:20 -0800649#include "tasks.h"
650
Paul E. McKenney59d80fd2017-04-28 10:20:28 -0700651#ifndef CONFIG_TINY_RCU
652
653/*
654 * Print any significant non-default boot-time settings.
655 */
656void __init rcupdate_announce_bootup_oddness(void)
657{
658 if (rcu_normal)
659 pr_info("\tNo expedited grace period (rcu_normal).\n");
660 else if (rcu_normal_after_boot)
661 pr_info("\tNo expedited grace period (rcu_normal_after_boot).\n");
662 else if (rcu_expedited)
663 pr_info("\tAll grace periods are expedited (rcu_expedited).\n");
664 if (rcu_cpu_stall_suppress)
665 pr_info("\tRCU CPU stall warnings suppressed (rcu_cpu_stall_suppress).\n");
666 if (rcu_cpu_stall_timeout != CONFIG_RCU_CPU_STALL_TIMEOUT)
667 pr_info("\tRCU CPU stall warnings timeout set to %d (rcu_cpu_stall_timeout).\n", rcu_cpu_stall_timeout);
668 rcu_tasks_bootup_oddness();
669}
670
671#endif /* #ifndef CONFIG_TINY_RCU */