e3c6395c9b4c9f9e1093752fe782ec41dea9bf66
[muen/linux.git] / kernel / rcu / update.c
1 // SPDX-License-Identifier: GPL-2.0+
2 /*
3  * Read-Copy Update mechanism for mutual exclusion
4  *
5  * Copyright IBM Corporation, 2001
6  *
7  * Authors: Dipankar Sarma <dipankar@in.ibm.com>
8  *          Manfred Spraul <manfred@colorfullife.com>
9  *
10  * Based on the original work by Paul McKenney <paulmck@linux.ibm.com>
11  * 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 -
17  *              http://lse.sourceforge.net/locking/rcupdate.html
18  *
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>
26 #include <linux/sched/signal.h>
27 #include <linux/sched/debug.h>
28 #include <linux/atomic.h>
29 #include <linux/bitops.h>
30 #include <linux/percpu.h>
31 #include <linux/notifier.h>
32 #include <linux/cpu.h>
33 #include <linux/mutex.h>
34 #include <linux/export.h>
35 #include <linux/hardirq.h>
36 #include <linux/delay.h>
37 #include <linux/moduleparam.h>
38 #include <linux/kthread.h>
39 #include <linux/tick.h>
40 #include <linux/rcupdate_wait.h>
41 #include <linux/sched/isolation.h>
42
43 #define CREATE_TRACE_POINTS
44
45 #include "rcu.h"
46
47 #ifdef MODULE_PARAM_PREFIX
48 #undef MODULE_PARAM_PREFIX
49 #endif
50 #define MODULE_PARAM_PREFIX "rcupdate."
51
52 #ifndef CONFIG_TINY_RCU
53 extern int rcu_expedited; /* from sysctl */
54 module_param(rcu_expedited, int, 0);
55 extern int rcu_normal; /* from sysctl */
56 module_param(rcu_normal, int, 0);
57 static int rcu_normal_after_boot;
58 module_param(rcu_normal_after_boot, int, 0);
59 #endif /* #ifndef CONFIG_TINY_RCU */
60
61 #ifdef CONFIG_DEBUG_LOCK_ALLOC
62 /**
63  * rcu_read_lock_sched_held() - might we be in RCU-sched read-side critical section?
64  *
65  * If CONFIG_DEBUG_LOCK_ALLOC is selected, returns nonzero iff in an
66  * RCU-sched read-side critical section.  In absence of
67  * CONFIG_DEBUG_LOCK_ALLOC, this assumes we are in an RCU-sched read-side
68  * critical section unless it can prove otherwise.  Note that disabling
69  * of preemption (including disabling irqs) counts as an RCU-sched
70  * read-side critical section.  This is useful for debug checks in functions
71  * that required that they be called within an RCU-sched read-side
72  * critical section.
73  *
74  * Check debug_lockdep_rcu_enabled() to prevent false positives during boot
75  * and while lockdep is disabled.
76  *
77  * Note that if the CPU is in the idle loop from an RCU point of
78  * view (ie: that we are in the section between rcu_idle_enter() and
79  * rcu_idle_exit()) then rcu_read_lock_held() returns false even if the CPU
80  * did an rcu_read_lock().  The reason for this is that RCU ignores CPUs
81  * that are in such a section, considering these as in extended quiescent
82  * state, so such a CPU is effectively never in an RCU read-side critical
83  * section regardless of what RCU primitives it invokes.  This state of
84  * affairs is required --- we need to keep an RCU-free window in idle
85  * where the CPU may possibly enter into low power mode. This way we can
86  * notice an extended quiescent state to other CPUs that started a grace
87  * period. Otherwise we would delay any grace period as long as we run in
88  * the idle task.
89  *
90  * Similarly, we avoid claiming an SRCU read lock held if the current
91  * CPU is offline.
92  */
93 int rcu_read_lock_sched_held(void)
94 {
95         int lockdep_opinion = 0;
96
97         if (!debug_lockdep_rcu_enabled())
98                 return 1;
99         if (!rcu_is_watching())
100                 return 0;
101         if (!rcu_lockdep_current_cpu_online())
102                 return 0;
103         if (debug_locks)
104                 lockdep_opinion = lock_is_held(&rcu_sched_lock_map);
105         return lockdep_opinion || !preemptible();
106 }
107 EXPORT_SYMBOL(rcu_read_lock_sched_held);
108 #endif
109
110 #ifndef CONFIG_TINY_RCU
111
112 /*
113  * Should expedited grace-period primitives always fall back to their
114  * non-expedited counterparts?  Intended for use within RCU.  Note
115  * that if the user specifies both rcu_expedited and rcu_normal, then
116  * rcu_normal wins.  (Except during the time period during boot from
117  * when the first task is spawned until the rcu_set_runtime_mode()
118  * core_initcall() is invoked, at which point everything is expedited.)
119  */
120 bool rcu_gp_is_normal(void)
121 {
122         return READ_ONCE(rcu_normal) &&
123                rcu_scheduler_active != RCU_SCHEDULER_INIT;
124 }
125 EXPORT_SYMBOL_GPL(rcu_gp_is_normal);
126
127 static atomic_t rcu_expedited_nesting = ATOMIC_INIT(1);
128
129 /*
130  * Should normal grace-period primitives be expedited?  Intended for
131  * use within RCU.  Note that this function takes the rcu_expedited
132  * sysfs/boot variable and rcu_scheduler_active into account as well
133  * as the rcu_expedite_gp() nesting.  So looping on rcu_unexpedite_gp()
134  * until rcu_gp_is_expedited() returns false is a -really- bad idea.
135  */
136 bool rcu_gp_is_expedited(void)
137 {
138         return rcu_expedited || atomic_read(&rcu_expedited_nesting) ||
139                rcu_scheduler_active == RCU_SCHEDULER_INIT;
140 }
141 EXPORT_SYMBOL_GPL(rcu_gp_is_expedited);
142
143 /**
144  * rcu_expedite_gp - Expedite future RCU grace periods
145  *
146  * After a call to this function, future calls to synchronize_rcu() and
147  * friends act as the corresponding synchronize_rcu_expedited() function
148  * had instead been called.
149  */
150 void rcu_expedite_gp(void)
151 {
152         atomic_inc(&rcu_expedited_nesting);
153 }
154 EXPORT_SYMBOL_GPL(rcu_expedite_gp);
155
156 /**
157  * rcu_unexpedite_gp - Cancel prior rcu_expedite_gp() invocation
158  *
159  * Undo a prior call to rcu_expedite_gp().  If all prior calls to
160  * rcu_expedite_gp() are undone by a subsequent call to rcu_unexpedite_gp(),
161  * and if the rcu_expedited sysfs/boot parameter is not set, then all
162  * subsequent calls to synchronize_rcu() and friends will return to
163  * their normal non-expedited behavior.
164  */
165 void rcu_unexpedite_gp(void)
166 {
167         atomic_dec(&rcu_expedited_nesting);
168 }
169 EXPORT_SYMBOL_GPL(rcu_unexpedite_gp);
170
171 /*
172  * Inform RCU of the end of the in-kernel boot sequence.
173  */
174 void rcu_end_inkernel_boot(void)
175 {
176         rcu_unexpedite_gp();
177         if (rcu_normal_after_boot)
178                 WRITE_ONCE(rcu_normal, 1);
179 }
180
181 #endif /* #ifndef CONFIG_TINY_RCU */
182
183 /*
184  * Test each non-SRCU synchronous grace-period wait API.  This is
185  * useful just after a change in mode for these primitives, and
186  * during early boot.
187  */
188 void rcu_test_sync_prims(void)
189 {
190         if (!IS_ENABLED(CONFIG_PROVE_RCU))
191                 return;
192         synchronize_rcu();
193         synchronize_rcu_expedited();
194 }
195
196 #if !defined(CONFIG_TINY_RCU) || defined(CONFIG_SRCU)
197
198 /*
199  * Switch to run-time mode once RCU has fully initialized.
200  */
201 static int __init rcu_set_runtime_mode(void)
202 {
203         rcu_test_sync_prims();
204         rcu_scheduler_active = RCU_SCHEDULER_RUNNING;
205         rcu_test_sync_prims();
206         return 0;
207 }
208 core_initcall(rcu_set_runtime_mode);
209
210 #endif /* #if !defined(CONFIG_TINY_RCU) || defined(CONFIG_SRCU) */
211
212 #ifdef CONFIG_DEBUG_LOCK_ALLOC
213 static struct lock_class_key rcu_lock_key;
214 struct lockdep_map rcu_lock_map =
215         STATIC_LOCKDEP_MAP_INIT("rcu_read_lock", &rcu_lock_key);
216 EXPORT_SYMBOL_GPL(rcu_lock_map);
217
218 static struct lock_class_key rcu_bh_lock_key;
219 struct lockdep_map rcu_bh_lock_map =
220         STATIC_LOCKDEP_MAP_INIT("rcu_read_lock_bh", &rcu_bh_lock_key);
221 EXPORT_SYMBOL_GPL(rcu_bh_lock_map);
222
223 static struct lock_class_key rcu_sched_lock_key;
224 struct lockdep_map rcu_sched_lock_map =
225         STATIC_LOCKDEP_MAP_INIT("rcu_read_lock_sched", &rcu_sched_lock_key);
226 EXPORT_SYMBOL_GPL(rcu_sched_lock_map);
227
228 static struct lock_class_key rcu_callback_key;
229 struct lockdep_map rcu_callback_map =
230         STATIC_LOCKDEP_MAP_INIT("rcu_callback", &rcu_callback_key);
231 EXPORT_SYMBOL_GPL(rcu_callback_map);
232
233 int notrace debug_lockdep_rcu_enabled(void)
234 {
235         return rcu_scheduler_active != RCU_SCHEDULER_INACTIVE && debug_locks &&
236                current->lockdep_recursion == 0;
237 }
238 EXPORT_SYMBOL_GPL(debug_lockdep_rcu_enabled);
239
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 /**
273  * rcu_read_lock_bh_held() - might we be in RCU-bh read-side critical section?
274  *
275  * Check for bottom half being disabled, which covers both the
276  * CONFIG_PROVE_RCU and not cases.  Note that if someone uses
277  * rcu_read_lock_bh(), but then later enables BH, lockdep (if enabled)
278  * will show the situation.  This is useful for debug checks in functions
279  * that require that they be called within an RCU read-side critical
280  * section.
281  *
282  * Check debug_lockdep_rcu_enabled() to prevent false positives during boot.
283  *
284  * Note that rcu_read_lock_bh() is disallowed if the CPU is either idle or
285  * offline from an RCU perspective, so check for those as well.
286  */
287 int rcu_read_lock_bh_held(void)
288 {
289         if (!debug_lockdep_rcu_enabled())
290                 return 1;
291         if (!rcu_is_watching())
292                 return 0;
293         if (!rcu_lockdep_current_cpu_online())
294                 return 0;
295         return in_softirq() || irqs_disabled();
296 }
297 EXPORT_SYMBOL_GPL(rcu_read_lock_bh_held);
298
299 #endif /* #ifdef CONFIG_DEBUG_LOCK_ALLOC */
300
301 /**
302  * wakeme_after_rcu() - Callback function to awaken a task after grace period
303  * @head: Pointer to rcu_head member within rcu_synchronize structure
304  *
305  * Awaken the corresponding task now that a grace period has elapsed.
306  */
307 void wakeme_after_rcu(struct rcu_head *head)
308 {
309         struct rcu_synchronize *rcu;
310
311         rcu = container_of(head, struct rcu_synchronize, head);
312         complete(&rcu->completion);
313 }
314 EXPORT_SYMBOL_GPL(wakeme_after_rcu);
315
316 void __wait_rcu_gp(bool checktiny, int n, call_rcu_func_t *crcu_array,
317                    struct rcu_synchronize *rs_array)
318 {
319         int i;
320         int j;
321
322         /* Initialize and register callbacks for each crcu_array element. */
323         for (i = 0; i < n; i++) {
324                 if (checktiny &&
325                     (crcu_array[i] == call_rcu)) {
326                         might_sleep();
327                         continue;
328                 }
329                 init_rcu_head_on_stack(&rs_array[i].head);
330                 init_completion(&rs_array[i].completion);
331                 for (j = 0; j < i; j++)
332                         if (crcu_array[j] == crcu_array[i])
333                                 break;
334                 if (j == i)
335                         (crcu_array[i])(&rs_array[i].head, wakeme_after_rcu);
336         }
337
338         /* Wait for all callbacks to be invoked. */
339         for (i = 0; i < n; i++) {
340                 if (checktiny &&
341                     (crcu_array[i] == call_rcu))
342                         continue;
343                 for (j = 0; j < i; j++)
344                         if (crcu_array[j] == crcu_array[i])
345                                 break;
346                 if (j == i)
347                         wait_for_completion(&rs_array[i].completion);
348                 destroy_rcu_head_on_stack(&rs_array[i].head);
349         }
350 }
351 EXPORT_SYMBOL_GPL(__wait_rcu_gp);
352
353 #ifdef CONFIG_DEBUG_OBJECTS_RCU_HEAD
354 void init_rcu_head(struct rcu_head *head)
355 {
356         debug_object_init(head, &rcuhead_debug_descr);
357 }
358 EXPORT_SYMBOL_GPL(init_rcu_head);
359
360 void destroy_rcu_head(struct rcu_head *head)
361 {
362         debug_object_free(head, &rcuhead_debug_descr);
363 }
364 EXPORT_SYMBOL_GPL(destroy_rcu_head);
365
366 static bool rcuhead_is_static_object(void *addr)
367 {
368         return true;
369 }
370
371 /**
372  * init_rcu_head_on_stack() - initialize on-stack rcu_head for debugobjects
373  * @head: pointer to rcu_head structure to be initialized
374  *
375  * This function informs debugobjects of a new rcu_head structure that
376  * has been allocated as an auto variable on the stack.  This function
377  * is not required for rcu_head structures that are statically defined or
378  * that are dynamically allocated on the heap.  This function has no
379  * effect for !CONFIG_DEBUG_OBJECTS_RCU_HEAD kernel builds.
380  */
381 void init_rcu_head_on_stack(struct rcu_head *head)
382 {
383         debug_object_init_on_stack(head, &rcuhead_debug_descr);
384 }
385 EXPORT_SYMBOL_GPL(init_rcu_head_on_stack);
386
387 /**
388  * destroy_rcu_head_on_stack() - destroy on-stack rcu_head for debugobjects
389  * @head: pointer to rcu_head structure to be initialized
390  *
391  * This function informs debugobjects that an on-stack rcu_head structure
392  * is about to go out of scope.  As with init_rcu_head_on_stack(), this
393  * function is not required for rcu_head structures that are statically
394  * defined or that are dynamically allocated on the heap.  Also as with
395  * init_rcu_head_on_stack(), this function has no effect for
396  * !CONFIG_DEBUG_OBJECTS_RCU_HEAD kernel builds.
397  */
398 void destroy_rcu_head_on_stack(struct rcu_head *head)
399 {
400         debug_object_free(head, &rcuhead_debug_descr);
401 }
402 EXPORT_SYMBOL_GPL(destroy_rcu_head_on_stack);
403
404 struct debug_obj_descr rcuhead_debug_descr = {
405         .name = "rcu_head",
406         .is_static_object = rcuhead_is_static_object,
407 };
408 EXPORT_SYMBOL_GPL(rcuhead_debug_descr);
409 #endif /* #ifdef CONFIG_DEBUG_OBJECTS_RCU_HEAD */
410
411 #if defined(CONFIG_TREE_RCU) || defined(CONFIG_PREEMPT_RCU) || defined(CONFIG_RCU_TRACE)
412 void do_trace_rcu_torture_read(const char *rcutorturename, struct rcu_head *rhp,
413                                unsigned long secs,
414                                unsigned long c_old, unsigned long c)
415 {
416         trace_rcu_torture_read(rcutorturename, rhp, secs, c_old, c);
417 }
418 EXPORT_SYMBOL_GPL(do_trace_rcu_torture_read);
419 #else
420 #define do_trace_rcu_torture_read(rcutorturename, rhp, secs, c_old, c) \
421         do { } while (0)
422 #endif
423
424 #ifdef CONFIG_RCU_STALL_COMMON
425
426 #ifdef CONFIG_PROVE_RCU
427 #define RCU_STALL_DELAY_DELTA          (5 * HZ)
428 #else
429 #define RCU_STALL_DELAY_DELTA          0
430 #endif
431
432 int rcu_cpu_stall_suppress __read_mostly; /* 1 = suppress stall warnings. */
433 EXPORT_SYMBOL_GPL(rcu_cpu_stall_suppress);
434 static int rcu_cpu_stall_timeout __read_mostly = CONFIG_RCU_CPU_STALL_TIMEOUT;
435
436 module_param(rcu_cpu_stall_suppress, int, 0644);
437 module_param(rcu_cpu_stall_timeout, int, 0644);
438
439 int rcu_jiffies_till_stall_check(void)
440 {
441         int till_stall_check = READ_ONCE(rcu_cpu_stall_timeout);
442
443         /*
444          * Limit check must be consistent with the Kconfig limits
445          * for CONFIG_RCU_CPU_STALL_TIMEOUT.
446          */
447         if (till_stall_check < 3) {
448                 WRITE_ONCE(rcu_cpu_stall_timeout, 3);
449                 till_stall_check = 3;
450         } else if (till_stall_check > 300) {
451                 WRITE_ONCE(rcu_cpu_stall_timeout, 300);
452                 till_stall_check = 300;
453         }
454         return till_stall_check * HZ + RCU_STALL_DELAY_DELTA;
455 }
456 EXPORT_SYMBOL_GPL(rcu_jiffies_till_stall_check);
457
458 void rcu_sysrq_start(void)
459 {
460         if (!rcu_cpu_stall_suppress)
461                 rcu_cpu_stall_suppress = 2;
462 }
463
464 void rcu_sysrq_end(void)
465 {
466         if (rcu_cpu_stall_suppress == 2)
467                 rcu_cpu_stall_suppress = 0;
468 }
469
470 static int rcu_panic(struct notifier_block *this, unsigned long ev, void *ptr)
471 {
472         rcu_cpu_stall_suppress = 1;
473         return NOTIFY_DONE;
474 }
475
476 static struct notifier_block rcu_panic_block = {
477         .notifier_call = rcu_panic,
478 };
479
480 static int __init check_cpu_stall_init(void)
481 {
482         atomic_notifier_chain_register(&panic_notifier_list, &rcu_panic_block);
483         return 0;
484 }
485 early_initcall(check_cpu_stall_init);
486
487 #endif /* #ifdef CONFIG_RCU_STALL_COMMON */
488
489 #ifdef CONFIG_TASKS_RCU
490
491 /*
492  * Simple variant of RCU whose quiescent states are voluntary context
493  * switch, cond_resched_rcu_qs(), user-space execution, and idle.
494  * As such, grace periods can take one good long time.  There are no
495  * read-side primitives similar to rcu_read_lock() and rcu_read_unlock()
496  * because this implementation is intended to get the system into a safe
497  * state for some of the manipulations involved in tracing and the like.
498  * Finally, this implementation does not support high call_rcu_tasks()
499  * rates from multiple CPUs.  If this is required, per-CPU callback lists
500  * will be needed.
501  */
502
503 /* Global list of callbacks and associated lock. */
504 static struct rcu_head *rcu_tasks_cbs_head;
505 static struct rcu_head **rcu_tasks_cbs_tail = &rcu_tasks_cbs_head;
506 static DECLARE_WAIT_QUEUE_HEAD(rcu_tasks_cbs_wq);
507 static DEFINE_RAW_SPINLOCK(rcu_tasks_cbs_lock);
508
509 /* Track exiting tasks in order to allow them to be waited for. */
510 DEFINE_STATIC_SRCU(tasks_rcu_exit_srcu);
511
512 /* Control stall timeouts.  Disable with <= 0, otherwise jiffies till stall. */
513 #define RCU_TASK_STALL_TIMEOUT (HZ * 60 * 10)
514 static int rcu_task_stall_timeout __read_mostly = RCU_TASK_STALL_TIMEOUT;
515 module_param(rcu_task_stall_timeout, int, 0644);
516
517 static struct task_struct *rcu_tasks_kthread_ptr;
518
519 /**
520  * call_rcu_tasks() - Queue an RCU for invocation task-based grace period
521  * @rhp: structure to be used for queueing the RCU updates.
522  * @func: actual callback function to be invoked after the grace period
523  *
524  * The callback function will be invoked some time after a full grace
525  * period elapses, in other words after all currently executing RCU
526  * read-side critical sections have completed. call_rcu_tasks() assumes
527  * that the read-side critical sections end at a voluntary context
528  * switch (not a preemption!), cond_resched_rcu_qs(), entry into idle,
529  * or transition to usermode execution.  As such, there are no read-side
530  * primitives analogous to rcu_read_lock() and rcu_read_unlock() because
531  * this primitive is intended to determine that all tasks have passed
532  * through a safe state, not so much for data-strcuture synchronization.
533  *
534  * See the description of call_rcu() for more detailed information on
535  * memory ordering guarantees.
536  */
537 void call_rcu_tasks(struct rcu_head *rhp, rcu_callback_t func)
538 {
539         unsigned long flags;
540         bool needwake;
541
542         rhp->next = NULL;
543         rhp->func = func;
544         raw_spin_lock_irqsave(&rcu_tasks_cbs_lock, flags);
545         needwake = !rcu_tasks_cbs_head;
546         *rcu_tasks_cbs_tail = rhp;
547         rcu_tasks_cbs_tail = &rhp->next;
548         raw_spin_unlock_irqrestore(&rcu_tasks_cbs_lock, flags);
549         /* We can't create the thread unless interrupts are enabled. */
550         if (needwake && READ_ONCE(rcu_tasks_kthread_ptr))
551                 wake_up(&rcu_tasks_cbs_wq);
552 }
553 EXPORT_SYMBOL_GPL(call_rcu_tasks);
554
555 /**
556  * synchronize_rcu_tasks - wait until an rcu-tasks grace period has elapsed.
557  *
558  * Control will return to the caller some time after a full rcu-tasks
559  * grace period has elapsed, in other words after all currently
560  * executing rcu-tasks read-side critical sections have elapsed.  These
561  * read-side critical sections are delimited by calls to schedule(),
562  * cond_resched_tasks_rcu_qs(), idle execution, userspace execution, calls
563  * to synchronize_rcu_tasks(), and (in theory, anyway) cond_resched().
564  *
565  * This is a very specialized primitive, intended only for a few uses in
566  * tracing and other situations requiring manipulation of function
567  * preambles and profiling hooks.  The synchronize_rcu_tasks() function
568  * is not (yet) intended for heavy use from multiple CPUs.
569  *
570  * Note that this guarantee implies further memory-ordering guarantees.
571  * On systems with more than one CPU, when synchronize_rcu_tasks() returns,
572  * each CPU is guaranteed to have executed a full memory barrier since the
573  * end of its last RCU-tasks read-side critical section whose beginning
574  * preceded the call to synchronize_rcu_tasks().  In addition, each CPU
575  * having an RCU-tasks read-side critical section that extends beyond
576  * the return from synchronize_rcu_tasks() is guaranteed to have executed
577  * a full memory barrier after the beginning of synchronize_rcu_tasks()
578  * and before the beginning of that RCU-tasks read-side critical section.
579  * Note that these guarantees include CPUs that are offline, idle, or
580  * executing in user mode, as well as CPUs that are executing in the kernel.
581  *
582  * Furthermore, if CPU A invoked synchronize_rcu_tasks(), which returned
583  * to its caller on CPU B, then both CPU A and CPU B are guaranteed
584  * to have executed a full memory barrier during the execution of
585  * synchronize_rcu_tasks() -- even if CPU A and CPU B are the same CPU
586  * (but again only if the system has more than one CPU).
587  */
588 void synchronize_rcu_tasks(void)
589 {
590         /* Complain if the scheduler has not started.  */
591         RCU_LOCKDEP_WARN(rcu_scheduler_active == RCU_SCHEDULER_INACTIVE,
592                          "synchronize_rcu_tasks called too soon");
593
594         /* Wait for the grace period. */
595         wait_rcu_gp(call_rcu_tasks);
596 }
597 EXPORT_SYMBOL_GPL(synchronize_rcu_tasks);
598
599 /**
600  * rcu_barrier_tasks - Wait for in-flight call_rcu_tasks() callbacks.
601  *
602  * Although the current implementation is guaranteed to wait, it is not
603  * obligated to, for example, if there are no pending callbacks.
604  */
605 void rcu_barrier_tasks(void)
606 {
607         /* There is only one callback queue, so this is easy.  ;-) */
608         synchronize_rcu_tasks();
609 }
610 EXPORT_SYMBOL_GPL(rcu_barrier_tasks);
611
612 /* See if tasks are still holding out, complain if so. */
613 static void check_holdout_task(struct task_struct *t,
614                                bool needreport, bool *firstreport)
615 {
616         int cpu;
617
618         if (!READ_ONCE(t->rcu_tasks_holdout) ||
619             t->rcu_tasks_nvcsw != READ_ONCE(t->nvcsw) ||
620             !READ_ONCE(t->on_rq) ||
621             (IS_ENABLED(CONFIG_NO_HZ_FULL) &&
622              !is_idle_task(t) && t->rcu_tasks_idle_cpu >= 0)) {
623                 WRITE_ONCE(t->rcu_tasks_holdout, false);
624                 list_del_init(&t->rcu_tasks_holdout_list);
625                 put_task_struct(t);
626                 return;
627         }
628         rcu_request_urgent_qs_task(t);
629         if (!needreport)
630                 return;
631         if (*firstreport) {
632                 pr_err("INFO: rcu_tasks detected stalls on tasks:\n");
633                 *firstreport = false;
634         }
635         cpu = task_cpu(t);
636         pr_alert("%p: %c%c nvcsw: %lu/%lu holdout: %d idle_cpu: %d/%d\n",
637                  t, ".I"[is_idle_task(t)],
638                  "N."[cpu < 0 || !tick_nohz_full_cpu(cpu)],
639                  t->rcu_tasks_nvcsw, t->nvcsw, t->rcu_tasks_holdout,
640                  t->rcu_tasks_idle_cpu, cpu);
641         sched_show_task(t);
642 }
643
644 /* RCU-tasks kthread that detects grace periods and invokes callbacks. */
645 static int __noreturn rcu_tasks_kthread(void *arg)
646 {
647         unsigned long flags;
648         struct task_struct *g, *t;
649         unsigned long lastreport;
650         struct rcu_head *list;
651         struct rcu_head *next;
652         LIST_HEAD(rcu_tasks_holdouts);
653         int fract;
654
655         /* Run on housekeeping CPUs by default.  Sysadm can move if desired. */
656         housekeeping_affine(current, HK_FLAG_RCU);
657
658         /*
659          * Each pass through the following loop makes one check for
660          * newly arrived callbacks, and, if there are some, waits for
661          * one RCU-tasks grace period and then invokes the callbacks.
662          * This loop is terminated by the system going down.  ;-)
663          */
664         for (;;) {
665
666                 /* Pick up any new callbacks. */
667                 raw_spin_lock_irqsave(&rcu_tasks_cbs_lock, flags);
668                 list = rcu_tasks_cbs_head;
669                 rcu_tasks_cbs_head = NULL;
670                 rcu_tasks_cbs_tail = &rcu_tasks_cbs_head;
671                 raw_spin_unlock_irqrestore(&rcu_tasks_cbs_lock, flags);
672
673                 /* If there were none, wait a bit and start over. */
674                 if (!list) {
675                         wait_event_interruptible(rcu_tasks_cbs_wq,
676                                                  rcu_tasks_cbs_head);
677                         if (!rcu_tasks_cbs_head) {
678                                 WARN_ON(signal_pending(current));
679                                 schedule_timeout_interruptible(HZ/10);
680                         }
681                         continue;
682                 }
683
684                 /*
685                  * Wait for all pre-existing t->on_rq and t->nvcsw
686                  * transitions to complete.  Invoking synchronize_rcu()
687                  * suffices because all these transitions occur with
688                  * interrupts disabled.  Without this synchronize_rcu(),
689                  * a read-side critical section that started before the
690                  * grace period might be incorrectly seen as having started
691                  * after the grace period.
692                  *
693                  * This synchronize_rcu() also dispenses with the
694                  * need for a memory barrier on the first store to
695                  * ->rcu_tasks_holdout, as it forces the store to happen
696                  * after the beginning of the grace period.
697                  */
698                 synchronize_rcu();
699
700                 /*
701                  * There were callbacks, so we need to wait for an
702                  * RCU-tasks grace period.  Start off by scanning
703                  * the task list for tasks that are not already
704                  * voluntarily blocked.  Mark these tasks and make
705                  * a list of them in rcu_tasks_holdouts.
706                  */
707                 rcu_read_lock();
708                 for_each_process_thread(g, t) {
709                         if (t != current && READ_ONCE(t->on_rq) &&
710                             !is_idle_task(t)) {
711                                 get_task_struct(t);
712                                 t->rcu_tasks_nvcsw = READ_ONCE(t->nvcsw);
713                                 WRITE_ONCE(t->rcu_tasks_holdout, true);
714                                 list_add(&t->rcu_tasks_holdout_list,
715                                          &rcu_tasks_holdouts);
716                         }
717                 }
718                 rcu_read_unlock();
719
720                 /*
721                  * Wait for tasks that are in the process of exiting.
722                  * This does only part of the job, ensuring that all
723                  * tasks that were previously exiting reach the point
724                  * where they have disabled preemption, allowing the
725                  * later synchronize_rcu() to finish the job.
726                  */
727                 synchronize_srcu(&tasks_rcu_exit_srcu);
728
729                 /*
730                  * Each pass through the following loop scans the list
731                  * of holdout tasks, removing any that are no longer
732                  * holdouts.  When the list is empty, we are done.
733                  */
734                 lastreport = jiffies;
735
736                 /* Start off with HZ/10 wait and slowly back off to 1 HZ wait*/
737                 fract = 10;
738
739                 for (;;) {
740                         bool firstreport;
741                         bool needreport;
742                         int rtst;
743                         struct task_struct *t1;
744
745                         if (list_empty(&rcu_tasks_holdouts))
746                                 break;
747
748                         /* Slowly back off waiting for holdouts */
749                         schedule_timeout_interruptible(HZ/fract);
750
751                         if (fract > 1)
752                                 fract--;
753
754                         rtst = READ_ONCE(rcu_task_stall_timeout);
755                         needreport = rtst > 0 &&
756                                      time_after(jiffies, lastreport + rtst);
757                         if (needreport)
758                                 lastreport = jiffies;
759                         firstreport = true;
760                         WARN_ON(signal_pending(current));
761                         list_for_each_entry_safe(t, t1, &rcu_tasks_holdouts,
762                                                 rcu_tasks_holdout_list) {
763                                 check_holdout_task(t, needreport, &firstreport);
764                                 cond_resched();
765                         }
766                 }
767
768                 /*
769                  * Because ->on_rq and ->nvcsw are not guaranteed
770                  * to have a full memory barriers prior to them in the
771                  * schedule() path, memory reordering on other CPUs could
772                  * cause their RCU-tasks read-side critical sections to
773                  * extend past the end of the grace period.  However,
774                  * because these ->nvcsw updates are carried out with
775                  * interrupts disabled, we can use synchronize_rcu()
776                  * to force the needed ordering on all such CPUs.
777                  *
778                  * This synchronize_rcu() also confines all
779                  * ->rcu_tasks_holdout accesses to be within the grace
780                  * period, avoiding the need for memory barriers for
781                  * ->rcu_tasks_holdout accesses.
782                  *
783                  * In addition, this synchronize_rcu() waits for exiting
784                  * tasks to complete their final preempt_disable() region
785                  * of execution, cleaning up after the synchronize_srcu()
786                  * above.
787                  */
788                 synchronize_rcu();
789
790                 /* Invoke the callbacks. */
791                 while (list) {
792                         next = list->next;
793                         local_bh_disable();
794                         list->func(list);
795                         local_bh_enable();
796                         list = next;
797                         cond_resched();
798                 }
799                 /* Paranoid sleep to keep this from entering a tight loop */
800                 schedule_timeout_uninterruptible(HZ/10);
801         }
802 }
803
804 /* Spawn rcu_tasks_kthread() at core_initcall() time. */
805 static int __init rcu_spawn_tasks_kthread(void)
806 {
807         struct task_struct *t;
808
809         t = kthread_run(rcu_tasks_kthread, NULL, "rcu_tasks_kthread");
810         if (WARN_ONCE(IS_ERR(t), "%s: Could not start Tasks-RCU grace-period kthread, OOM is now expected behavior\n", __func__))
811                 return 0;
812         smp_mb(); /* Ensure others see full kthread. */
813         WRITE_ONCE(rcu_tasks_kthread_ptr, t);
814         return 0;
815 }
816 core_initcall(rcu_spawn_tasks_kthread);
817
818 /* Do the srcu_read_lock() for the above synchronize_srcu().  */
819 void exit_tasks_rcu_start(void)
820 {
821         preempt_disable();
822         current->rcu_tasks_idx = __srcu_read_lock(&tasks_rcu_exit_srcu);
823         preempt_enable();
824 }
825
826 /* Do the srcu_read_unlock() for the above synchronize_srcu().  */
827 void exit_tasks_rcu_finish(void)
828 {
829         preempt_disable();
830         __srcu_read_unlock(&tasks_rcu_exit_srcu, current->rcu_tasks_idx);
831         preempt_enable();
832 }
833
834 #endif /* #ifdef CONFIG_TASKS_RCU */
835
836 #ifndef CONFIG_TINY_RCU
837
838 /*
839  * Print any non-default Tasks RCU settings.
840  */
841 static void __init rcu_tasks_bootup_oddness(void)
842 {
843 #ifdef CONFIG_TASKS_RCU
844         if (rcu_task_stall_timeout != RCU_TASK_STALL_TIMEOUT)
845                 pr_info("\tTasks-RCU CPU stall warnings timeout set to %d (rcu_task_stall_timeout).\n", rcu_task_stall_timeout);
846         else
847                 pr_info("\tTasks RCU enabled.\n");
848 #endif /* #ifdef CONFIG_TASKS_RCU */
849 }
850
851 #endif /* #ifndef CONFIG_TINY_RCU */
852
853 #ifdef CONFIG_PROVE_RCU
854
855 /*
856  * Early boot self test parameters.
857  */
858 static bool rcu_self_test;
859 module_param(rcu_self_test, bool, 0444);
860
861 static int rcu_self_test_counter;
862
863 static void test_callback(struct rcu_head *r)
864 {
865         rcu_self_test_counter++;
866         pr_info("RCU test callback executed %d\n", rcu_self_test_counter);
867 }
868
869 DEFINE_STATIC_SRCU(early_srcu);
870
871 static void early_boot_test_call_rcu(void)
872 {
873         static struct rcu_head head;
874         static struct rcu_head shead;
875
876         call_rcu(&head, test_callback);
877         if (IS_ENABLED(CONFIG_SRCU))
878                 call_srcu(&early_srcu, &shead, test_callback);
879 }
880
881 void rcu_early_boot_tests(void)
882 {
883         pr_info("Running RCU self tests\n");
884
885         if (rcu_self_test)
886                 early_boot_test_call_rcu();
887         rcu_test_sync_prims();
888 }
889
890 static int rcu_verify_early_boot_tests(void)
891 {
892         int ret = 0;
893         int early_boot_test_counter = 0;
894
895         if (rcu_self_test) {
896                 early_boot_test_counter++;
897                 rcu_barrier();
898                 if (IS_ENABLED(CONFIG_SRCU)) {
899                         early_boot_test_counter++;
900                         srcu_barrier(&early_srcu);
901                 }
902         }
903         if (rcu_self_test_counter != early_boot_test_counter) {
904                 WARN_ON(1);
905                 ret = -1;
906         }
907
908         return ret;
909 }
910 late_initcall(rcu_verify_early_boot_tests);
911 #else
912 void rcu_early_boot_tests(void) {}
913 #endif /* CONFIG_PROVE_RCU */
914
915 #ifndef CONFIG_TINY_RCU
916
917 /*
918  * Print any significant non-default boot-time settings.
919  */
920 void __init rcupdate_announce_bootup_oddness(void)
921 {
922         if (rcu_normal)
923                 pr_info("\tNo expedited grace period (rcu_normal).\n");
924         else if (rcu_normal_after_boot)
925                 pr_info("\tNo expedited grace period (rcu_normal_after_boot).\n");
926         else if (rcu_expedited)
927                 pr_info("\tAll grace periods are expedited (rcu_expedited).\n");
928         if (rcu_cpu_stall_suppress)
929                 pr_info("\tRCU CPU stall warnings suppressed (rcu_cpu_stall_suppress).\n");
930         if (rcu_cpu_stall_timeout != CONFIG_RCU_CPU_STALL_TIMEOUT)
931                 pr_info("\tRCU CPU stall warnings timeout set to %d (rcu_cpu_stall_timeout).\n", rcu_cpu_stall_timeout);
932         rcu_tasks_bootup_oddness();
933 }
934
935 #endif /* #ifndef CONFIG_TINY_RCU */