Linux 5.13-rc1
[linux-2.6-block.git] / kernel / rcu / tasks.h
CommitLineData
eacd6f04
PM
1/* SPDX-License-Identifier: GPL-2.0+ */
2/*
3 * Task-based RCU implementations.
4 *
5 * Copyright (C) 2020 Paul E. McKenney
6 */
7
8fd8ca38 8#ifdef CONFIG_TASKS_RCU_GENERIC
5873b8a9
PM
9
10////////////////////////////////////////////////////////////////////////
11//
12// Generic data structures.
13
14struct rcu_tasks;
15typedef void (*rcu_tasks_gp_func_t)(struct rcu_tasks *rtp);
e4fe5dd6
PM
16typedef void (*pregp_func_t)(void);
17typedef void (*pertask_func_t)(struct task_struct *t, struct list_head *hop);
9796e1ae 18typedef void (*postscan_func_t)(struct list_head *hop);
e4fe5dd6 19typedef void (*holdouts_func_t)(struct list_head *hop, bool ndrpt, bool *frptp);
af051ca4 20typedef void (*postgp_func_t)(struct rcu_tasks *rtp);
eacd6f04 21
07e10515 22/**
85b86994 23 * struct rcu_tasks - Definition for a Tasks-RCU-like mechanism.
07e10515
PM
24 * @cbs_head: Head of callback list.
25 * @cbs_tail: Tail pointer for callback list.
26 * @cbs_wq: Wait queue allowning new callback to get kthread's attention.
27 * @cbs_lock: Lock protecting callback list.
28 * @kthread_ptr: This flavor's grace-period/callback-invocation kthread.
5873b8a9 29 * @gp_func: This flavor's grace-period-wait function.
af051ca4 30 * @gp_state: Grace period's most recent state transition (debugging).
4fe192df 31 * @gp_sleep: Per-grace-period sleep to prevent CPU-bound looping.
2393a613 32 * @init_fract: Initial backoff sleep interval.
af051ca4
PM
33 * @gp_jiffies: Time of last @gp_state transition.
34 * @gp_start: Most recent grace-period start in jiffies.
238dbce3
PM
35 * @n_gps: Number of grace periods completed since boot.
36 * @n_ipis: Number of IPIs sent to encourage grace periods to end.
7e0669c3 37 * @n_ipis_fails: Number of IPI-send failures.
e4fe5dd6
PM
38 * @pregp_func: This flavor's pre-grace-period function (optional).
39 * @pertask_func: This flavor's per-task scan function (optional).
40 * @postscan_func: This flavor's post-task scan function (optional).
85b86994 41 * @holdouts_func: This flavor's holdout-list scan function (optional).
e4fe5dd6 42 * @postgp_func: This flavor's post-grace-period function (optional).
5873b8a9 43 * @call_func: This flavor's call_rcu()-equivalent function.
c97d12a6
PM
44 * @name: This flavor's textual name.
45 * @kname: This flavor's kthread name.
07e10515
PM
46 */
47struct rcu_tasks {
48 struct rcu_head *cbs_head;
49 struct rcu_head **cbs_tail;
50 struct wait_queue_head cbs_wq;
51 raw_spinlock_t cbs_lock;
af051ca4 52 int gp_state;
4fe192df 53 int gp_sleep;
2393a613 54 int init_fract;
af051ca4 55 unsigned long gp_jiffies;
88092d0c 56 unsigned long gp_start;
238dbce3
PM
57 unsigned long n_gps;
58 unsigned long n_ipis;
7e0669c3 59 unsigned long n_ipis_fails;
07e10515 60 struct task_struct *kthread_ptr;
5873b8a9 61 rcu_tasks_gp_func_t gp_func;
e4fe5dd6
PM
62 pregp_func_t pregp_func;
63 pertask_func_t pertask_func;
64 postscan_func_t postscan_func;
65 holdouts_func_t holdouts_func;
66 postgp_func_t postgp_func;
5873b8a9 67 call_rcu_func_t call_func;
c97d12a6
PM
68 char *name;
69 char *kname;
07e10515
PM
70};
71
c97d12a6
PM
72#define DEFINE_RCU_TASKS(rt_name, gp, call, n) \
73static struct rcu_tasks rt_name = \
07e10515 74{ \
c97d12a6
PM
75 .cbs_tail = &rt_name.cbs_head, \
76 .cbs_wq = __WAIT_QUEUE_HEAD_INITIALIZER(rt_name.cbs_wq), \
77 .cbs_lock = __RAW_SPIN_LOCK_UNLOCKED(rt_name.cbs_lock), \
5873b8a9
PM
78 .gp_func = gp, \
79 .call_func = call, \
c97d12a6
PM
80 .name = n, \
81 .kname = #rt_name, \
07e10515
PM
82}
83
eacd6f04
PM
84/* Track exiting tasks in order to allow them to be waited for. */
85DEFINE_STATIC_SRCU(tasks_rcu_exit_srcu);
86
b0afa0f0 87/* Avoid IPIing CPUs early in the grace period. */
574de876 88#define RCU_TASK_IPI_DELAY (IS_ENABLED(CONFIG_TASKS_TRACE_RCU_READ_MB) ? HZ / 2 : 0)
b0afa0f0
PM
89static int rcu_task_ipi_delay __read_mostly = RCU_TASK_IPI_DELAY;
90module_param(rcu_task_ipi_delay, int, 0644);
91
eacd6f04
PM
92/* Control stall timeouts. Disable with <= 0, otherwise jiffies till stall. */
93#define RCU_TASK_STALL_TIMEOUT (HZ * 60 * 10)
94static int rcu_task_stall_timeout __read_mostly = RCU_TASK_STALL_TIMEOUT;
95module_param(rcu_task_stall_timeout, int, 0644);
96
af051ca4
PM
97/* RCU tasks grace-period state for debugging. */
98#define RTGS_INIT 0
99#define RTGS_WAIT_WAIT_CBS 1
100#define RTGS_WAIT_GP 2
101#define RTGS_PRE_WAIT_GP 3
102#define RTGS_SCAN_TASKLIST 4
103#define RTGS_POST_SCAN_TASKLIST 5
104#define RTGS_WAIT_SCAN_HOLDOUTS 6
105#define RTGS_SCAN_HOLDOUTS 7
106#define RTGS_POST_GP 8
107#define RTGS_WAIT_READERS 9
108#define RTGS_INVOKE_CBS 10
109#define RTGS_WAIT_CBS 11
8344496e 110#ifndef CONFIG_TINY_RCU
af051ca4
PM
111static const char * const rcu_tasks_gp_state_names[] = {
112 "RTGS_INIT",
113 "RTGS_WAIT_WAIT_CBS",
114 "RTGS_WAIT_GP",
115 "RTGS_PRE_WAIT_GP",
116 "RTGS_SCAN_TASKLIST",
117 "RTGS_POST_SCAN_TASKLIST",
118 "RTGS_WAIT_SCAN_HOLDOUTS",
119 "RTGS_SCAN_HOLDOUTS",
120 "RTGS_POST_GP",
121 "RTGS_WAIT_READERS",
122 "RTGS_INVOKE_CBS",
123 "RTGS_WAIT_CBS",
124};
8344496e 125#endif /* #ifndef CONFIG_TINY_RCU */
af051ca4 126
5873b8a9
PM
127////////////////////////////////////////////////////////////////////////
128//
129// Generic code.
130
af051ca4
PM
131/* Record grace-period phase and time. */
132static void set_tasks_gp_state(struct rcu_tasks *rtp, int newstate)
133{
134 rtp->gp_state = newstate;
135 rtp->gp_jiffies = jiffies;
136}
137
8344496e 138#ifndef CONFIG_TINY_RCU
af051ca4
PM
139/* Return state name. */
140static const char *tasks_gp_state_getname(struct rcu_tasks *rtp)
141{
142 int i = data_race(rtp->gp_state); // Let KCSAN detect update races
143 int j = READ_ONCE(i); // Prevent the compiler from reading twice
144
145 if (j >= ARRAY_SIZE(rcu_tasks_gp_state_names))
146 return "???";
147 return rcu_tasks_gp_state_names[j];
148}
8344496e 149#endif /* #ifndef CONFIG_TINY_RCU */
af051ca4 150
5873b8a9
PM
151// Enqueue a callback for the specified flavor of Tasks RCU.
152static void call_rcu_tasks_generic(struct rcu_head *rhp, rcu_callback_t func,
153 struct rcu_tasks *rtp)
eacd6f04
PM
154{
155 unsigned long flags;
156 bool needwake;
157
158 rhp->next = NULL;
159 rhp->func = func;
07e10515
PM
160 raw_spin_lock_irqsave(&rtp->cbs_lock, flags);
161 needwake = !rtp->cbs_head;
162 WRITE_ONCE(*rtp->cbs_tail, rhp);
163 rtp->cbs_tail = &rhp->next;
164 raw_spin_unlock_irqrestore(&rtp->cbs_lock, flags);
eacd6f04 165 /* We can't create the thread unless interrupts are enabled. */
07e10515
PM
166 if (needwake && READ_ONCE(rtp->kthread_ptr))
167 wake_up(&rtp->cbs_wq);
eacd6f04 168}
eacd6f04 169
5873b8a9
PM
170// Wait for a grace period for the specified flavor of Tasks RCU.
171static void synchronize_rcu_tasks_generic(struct rcu_tasks *rtp)
eacd6f04
PM
172{
173 /* Complain if the scheduler has not started. */
174 RCU_LOCKDEP_WARN(rcu_scheduler_active == RCU_SCHEDULER_INACTIVE,
175 "synchronize_rcu_tasks called too soon");
176
177 /* Wait for the grace period. */
5873b8a9 178 wait_rcu_gp(rtp->call_func);
eacd6f04
PM
179}
180
181/* RCU-tasks kthread that detects grace periods and invokes callbacks. */
182static int __noreturn rcu_tasks_kthread(void *arg)
183{
184 unsigned long flags;
eacd6f04
PM
185 struct rcu_head *list;
186 struct rcu_head *next;
07e10515 187 struct rcu_tasks *rtp = arg;
eacd6f04
PM
188
189 /* Run on housekeeping CPUs by default. Sysadm can move if desired. */
190 housekeeping_affine(current, HK_FLAG_RCU);
07e10515 191 WRITE_ONCE(rtp->kthread_ptr, current); // Let GPs start!
eacd6f04
PM
192
193 /*
194 * Each pass through the following loop makes one check for
195 * newly arrived callbacks, and, if there are some, waits for
196 * one RCU-tasks grace period and then invokes the callbacks.
197 * This loop is terminated by the system going down. ;-)
198 */
199 for (;;) {
200
201 /* Pick up any new callbacks. */
07e10515 202 raw_spin_lock_irqsave(&rtp->cbs_lock, flags);
43766c3e 203 smp_mb__after_spinlock(); // Order updates vs. GP.
07e10515
PM
204 list = rtp->cbs_head;
205 rtp->cbs_head = NULL;
206 rtp->cbs_tail = &rtp->cbs_head;
207 raw_spin_unlock_irqrestore(&rtp->cbs_lock, flags);
eacd6f04
PM
208
209 /* If there were none, wait a bit and start over. */
210 if (!list) {
07e10515
PM
211 wait_event_interruptible(rtp->cbs_wq,
212 READ_ONCE(rtp->cbs_head));
213 if (!rtp->cbs_head) {
eacd6f04 214 WARN_ON(signal_pending(current));
af051ca4 215 set_tasks_gp_state(rtp, RTGS_WAIT_WAIT_CBS);
ea6eed9f 216 schedule_timeout_idle(HZ/10);
eacd6f04
PM
217 }
218 continue;
219 }
220
5873b8a9 221 // Wait for one grace period.
af051ca4 222 set_tasks_gp_state(rtp, RTGS_WAIT_GP);
88092d0c 223 rtp->gp_start = jiffies;
5873b8a9 224 rtp->gp_func(rtp);
238dbce3 225 rtp->n_gps++;
eacd6f04
PM
226
227 /* Invoke the callbacks. */
af051ca4 228 set_tasks_gp_state(rtp, RTGS_INVOKE_CBS);
eacd6f04
PM
229 while (list) {
230 next = list->next;
231 local_bh_disable();
232 list->func(list);
233 local_bh_enable();
234 list = next;
235 cond_resched();
236 }
237 /* Paranoid sleep to keep this from entering a tight loop */
4fe192df 238 schedule_timeout_idle(rtp->gp_sleep);
af051ca4
PM
239
240 set_tasks_gp_state(rtp, RTGS_WAIT_CBS);
eacd6f04
PM
241 }
242}
243
1b04fa99 244/* Spawn RCU-tasks grace-period kthread. */
5873b8a9 245static void __init rcu_spawn_tasks_kthread_generic(struct rcu_tasks *rtp)
eacd6f04
PM
246{
247 struct task_struct *t;
248
c97d12a6
PM
249 t = kthread_run(rcu_tasks_kthread, rtp, "%s_kthread", rtp->kname);
250 if (WARN_ONCE(IS_ERR(t), "%s: Could not start %s grace-period kthread, OOM is now expected behavior\n", __func__, rtp->name))
5873b8a9 251 return;
eacd6f04 252 smp_mb(); /* Ensure others see full kthread. */
eacd6f04 253}
eacd6f04 254
eacd6f04
PM
255#ifndef CONFIG_TINY_RCU
256
257/*
258 * Print any non-default Tasks RCU settings.
259 */
260static void __init rcu_tasks_bootup_oddness(void)
261{
d5f177d3 262#if defined(CONFIG_TASKS_RCU) || defined(CONFIG_TASKS_TRACE_RCU)
eacd6f04
PM
263 if (rcu_task_stall_timeout != RCU_TASK_STALL_TIMEOUT)
264 pr_info("\tTasks-RCU CPU stall warnings timeout set to %d (rcu_task_stall_timeout).\n", rcu_task_stall_timeout);
d5f177d3
PM
265#endif /* #ifdef CONFIG_TASKS_RCU */
266#ifdef CONFIG_TASKS_RCU
267 pr_info("\tTrampoline variant of Tasks RCU enabled.\n");
eacd6f04 268#endif /* #ifdef CONFIG_TASKS_RCU */
c84aad76
PM
269#ifdef CONFIG_TASKS_RUDE_RCU
270 pr_info("\tRude variant of Tasks RCU enabled.\n");
271#endif /* #ifdef CONFIG_TASKS_RUDE_RCU */
d5f177d3
PM
272#ifdef CONFIG_TASKS_TRACE_RCU
273 pr_info("\tTracing variant of Tasks RCU enabled.\n");
274#endif /* #ifdef CONFIG_TASKS_TRACE_RCU */
eacd6f04
PM
275}
276
277#endif /* #ifndef CONFIG_TINY_RCU */
5873b8a9 278
8344496e 279#ifndef CONFIG_TINY_RCU
e21408ce
PM
280/* Dump out rcutorture-relevant state common to all RCU-tasks flavors. */
281static void show_rcu_tasks_generic_gp_kthread(struct rcu_tasks *rtp, char *s)
282{
7e0669c3 283 pr_info("%s: %s(%d) since %lu g:%lu i:%lu/%lu %c%c %s\n",
e21408ce 284 rtp->kname,
7e0669c3 285 tasks_gp_state_getname(rtp), data_race(rtp->gp_state),
af051ca4 286 jiffies - data_race(rtp->gp_jiffies),
7e0669c3
PM
287 data_race(rtp->n_gps),
288 data_race(rtp->n_ipis_fails), data_race(rtp->n_ipis),
e21408ce
PM
289 ".k"[!!data_race(rtp->kthread_ptr)],
290 ".C"[!!data_race(rtp->cbs_head)],
291 s);
292}
27c0f144 293#endif // #ifndef CONFIG_TINY_RCU
e21408ce 294
25246fc8
PM
295static void exit_tasks_rcu_finish_trace(struct task_struct *t);
296
297#if defined(CONFIG_TASKS_RCU) || defined(CONFIG_TASKS_TRACE_RCU)
5873b8a9 298
d01aa263
PM
299////////////////////////////////////////////////////////////////////////
300//
301// Shared code between task-list-scanning variants of Tasks RCU.
302
303/* Wait for one RCU-tasks grace period. */
304static void rcu_tasks_wait_gp(struct rcu_tasks *rtp)
305{
306 struct task_struct *g, *t;
307 unsigned long lastreport;
308 LIST_HEAD(holdouts);
309 int fract;
310
af051ca4 311 set_tasks_gp_state(rtp, RTGS_PRE_WAIT_GP);
d01aa263
PM
312 rtp->pregp_func();
313
314 /*
315 * There were callbacks, so we need to wait for an RCU-tasks
316 * grace period. Start off by scanning the task list for tasks
317 * that are not already voluntarily blocked. Mark these tasks
318 * and make a list of them in holdouts.
319 */
af051ca4 320 set_tasks_gp_state(rtp, RTGS_SCAN_TASKLIST);
d01aa263
PM
321 rcu_read_lock();
322 for_each_process_thread(g, t)
323 rtp->pertask_func(t, &holdouts);
324 rcu_read_unlock();
325
af051ca4 326 set_tasks_gp_state(rtp, RTGS_POST_SCAN_TASKLIST);
9796e1ae 327 rtp->postscan_func(&holdouts);
d01aa263
PM
328
329 /*
330 * Each pass through the following loop scans the list of holdout
331 * tasks, removing any that are no longer holdouts. When the list
332 * is empty, we are done.
333 */
334 lastreport = jiffies;
335
2393a613
PM
336 // Start off with initial wait and slowly back off to 1 HZ wait.
337 fract = rtp->init_fract;
d01aa263 338
77dc1741 339 while (!list_empty(&holdouts)) {
d01aa263
PM
340 bool firstreport;
341 bool needreport;
342 int rtst;
343
d01aa263 344 /* Slowly back off waiting for holdouts */
af051ca4 345 set_tasks_gp_state(rtp, RTGS_WAIT_SCAN_HOLDOUTS);
75dc2da5 346 schedule_timeout_idle(fract);
d01aa263 347
75dc2da5
PM
348 if (fract < HZ)
349 fract++;
d01aa263
PM
350
351 rtst = READ_ONCE(rcu_task_stall_timeout);
352 needreport = rtst > 0 && time_after(jiffies, lastreport + rtst);
353 if (needreport)
354 lastreport = jiffies;
355 firstreport = true;
356 WARN_ON(signal_pending(current));
af051ca4 357 set_tasks_gp_state(rtp, RTGS_SCAN_HOLDOUTS);
d01aa263
PM
358 rtp->holdouts_func(&holdouts, needreport, &firstreport);
359 }
360
af051ca4
PM
361 set_tasks_gp_state(rtp, RTGS_POST_GP);
362 rtp->postgp_func(rtp);
d01aa263
PM
363}
364
25246fc8
PM
365#endif /* #if defined(CONFIG_TASKS_RCU) || defined(CONFIG_TASKS_TRACE_RCU) */
366
367#ifdef CONFIG_TASKS_RCU
368
5873b8a9
PM
369////////////////////////////////////////////////////////////////////////
370//
371// Simple variant of RCU whose quiescent states are voluntary context
372// switch, cond_resched_rcu_qs(), user-space execution, and idle.
373// As such, grace periods can take one good long time. There are no
374// read-side primitives similar to rcu_read_lock() and rcu_read_unlock()
375// because this implementation is intended to get the system into a safe
376// state for some of the manipulations involved in tracing and the like.
377// Finally, this implementation does not support high call_rcu_tasks()
378// rates from multiple CPUs. If this is required, per-CPU callback lists
379// will be needed.
380
e4fe5dd6
PM
381/* Pre-grace-period preparation. */
382static void rcu_tasks_pregp_step(void)
383{
384 /*
385 * Wait for all pre-existing t->on_rq and t->nvcsw transitions
386 * to complete. Invoking synchronize_rcu() suffices because all
387 * these transitions occur with interrupts disabled. Without this
388 * synchronize_rcu(), a read-side critical section that started
389 * before the grace period might be incorrectly seen as having
390 * started after the grace period.
391 *
392 * This synchronize_rcu() also dispenses with the need for a
393 * memory barrier on the first store to t->rcu_tasks_holdout,
394 * as it forces the store to happen after the beginning of the
395 * grace period.
396 */
397 synchronize_rcu();
398}
399
400/* Per-task initial processing. */
401static void rcu_tasks_pertask(struct task_struct *t, struct list_head *hop)
402{
403 if (t != current && READ_ONCE(t->on_rq) && !is_idle_task(t)) {
404 get_task_struct(t);
405 t->rcu_tasks_nvcsw = READ_ONCE(t->nvcsw);
406 WRITE_ONCE(t->rcu_tasks_holdout, true);
407 list_add(&t->rcu_tasks_holdout_list, hop);
408 }
409}
410
411/* Processing between scanning taskslist and draining the holdout list. */
04a3c5aa 412static void rcu_tasks_postscan(struct list_head *hop)
e4fe5dd6
PM
413{
414 /*
415 * Wait for tasks that are in the process of exiting. This
416 * does only part of the job, ensuring that all tasks that were
417 * previously exiting reach the point where they have disabled
418 * preemption, allowing the later synchronize_rcu() to finish
419 * the job.
420 */
421 synchronize_srcu(&tasks_rcu_exit_srcu);
422}
423
5873b8a9
PM
424/* See if tasks are still holding out, complain if so. */
425static void check_holdout_task(struct task_struct *t,
426 bool needreport, bool *firstreport)
427{
428 int cpu;
429
430 if (!READ_ONCE(t->rcu_tasks_holdout) ||
431 t->rcu_tasks_nvcsw != READ_ONCE(t->nvcsw) ||
432 !READ_ONCE(t->on_rq) ||
433 (IS_ENABLED(CONFIG_NO_HZ_FULL) &&
434 !is_idle_task(t) && t->rcu_tasks_idle_cpu >= 0)) {
435 WRITE_ONCE(t->rcu_tasks_holdout, false);
436 list_del_init(&t->rcu_tasks_holdout_list);
437 put_task_struct(t);
438 return;
439 }
440 rcu_request_urgent_qs_task(t);
441 if (!needreport)
442 return;
443 if (*firstreport) {
444 pr_err("INFO: rcu_tasks detected stalls on tasks:\n");
445 *firstreport = false;
446 }
447 cpu = task_cpu(t);
448 pr_alert("%p: %c%c nvcsw: %lu/%lu holdout: %d idle_cpu: %d/%d\n",
449 t, ".I"[is_idle_task(t)],
450 "N."[cpu < 0 || !tick_nohz_full_cpu(cpu)],
451 t->rcu_tasks_nvcsw, t->nvcsw, t->rcu_tasks_holdout,
452 t->rcu_tasks_idle_cpu, cpu);
453 sched_show_task(t);
454}
455
e4fe5dd6
PM
456/* Scan the holdout lists for tasks no longer holding out. */
457static void check_all_holdout_tasks(struct list_head *hop,
458 bool needreport, bool *firstreport)
459{
460 struct task_struct *t, *t1;
461
462 list_for_each_entry_safe(t, t1, hop, rcu_tasks_holdout_list) {
463 check_holdout_task(t, needreport, firstreport);
464 cond_resched();
465 }
466}
467
468/* Finish off the Tasks-RCU grace period. */
af051ca4 469static void rcu_tasks_postgp(struct rcu_tasks *rtp)
e4fe5dd6
PM
470{
471 /*
472 * Because ->on_rq and ->nvcsw are not guaranteed to have a full
473 * memory barriers prior to them in the schedule() path, memory
474 * reordering on other CPUs could cause their RCU-tasks read-side
475 * critical sections to extend past the end of the grace period.
476 * However, because these ->nvcsw updates are carried out with
477 * interrupts disabled, we can use synchronize_rcu() to force the
478 * needed ordering on all such CPUs.
479 *
480 * This synchronize_rcu() also confines all ->rcu_tasks_holdout
481 * accesses to be within the grace period, avoiding the need for
482 * memory barriers for ->rcu_tasks_holdout accesses.
483 *
484 * In addition, this synchronize_rcu() waits for exiting tasks
485 * to complete their final preempt_disable() region of execution,
486 * cleaning up after the synchronize_srcu() above.
487 */
488 synchronize_rcu();
489}
490
5873b8a9 491void call_rcu_tasks(struct rcu_head *rhp, rcu_callback_t func);
c97d12a6 492DEFINE_RCU_TASKS(rcu_tasks, rcu_tasks_wait_gp, call_rcu_tasks, "RCU Tasks");
5873b8a9
PM
493
494/**
495 * call_rcu_tasks() - Queue an RCU for invocation task-based grace period
496 * @rhp: structure to be used for queueing the RCU updates.
497 * @func: actual callback function to be invoked after the grace period
498 *
499 * The callback function will be invoked some time after a full grace
500 * period elapses, in other words after all currently executing RCU
501 * read-side critical sections have completed. call_rcu_tasks() assumes
502 * that the read-side critical sections end at a voluntary context
503 * switch (not a preemption!), cond_resched_rcu_qs(), entry into idle,
504 * or transition to usermode execution. As such, there are no read-side
505 * primitives analogous to rcu_read_lock() and rcu_read_unlock() because
506 * this primitive is intended to determine that all tasks have passed
507 * through a safe state, not so much for data-strcuture synchronization.
508 *
509 * See the description of call_rcu() for more detailed information on
510 * memory ordering guarantees.
511 */
512void call_rcu_tasks(struct rcu_head *rhp, rcu_callback_t func)
513{
514 call_rcu_tasks_generic(rhp, func, &rcu_tasks);
515}
516EXPORT_SYMBOL_GPL(call_rcu_tasks);
517
518/**
519 * synchronize_rcu_tasks - wait until an rcu-tasks grace period has elapsed.
520 *
521 * Control will return to the caller some time after a full rcu-tasks
522 * grace period has elapsed, in other words after all currently
523 * executing rcu-tasks read-side critical sections have elapsed. These
524 * read-side critical sections are delimited by calls to schedule(),
525 * cond_resched_tasks_rcu_qs(), idle execution, userspace execution, calls
526 * to synchronize_rcu_tasks(), and (in theory, anyway) cond_resched().
527 *
528 * This is a very specialized primitive, intended only for a few uses in
529 * tracing and other situations requiring manipulation of function
530 * preambles and profiling hooks. The synchronize_rcu_tasks() function
531 * is not (yet) intended for heavy use from multiple CPUs.
532 *
533 * See the description of synchronize_rcu() for more detailed information
534 * on memory ordering guarantees.
535 */
536void synchronize_rcu_tasks(void)
537{
538 synchronize_rcu_tasks_generic(&rcu_tasks);
539}
540EXPORT_SYMBOL_GPL(synchronize_rcu_tasks);
541
542/**
543 * rcu_barrier_tasks - Wait for in-flight call_rcu_tasks() callbacks.
544 *
545 * Although the current implementation is guaranteed to wait, it is not
546 * obligated to, for example, if there are no pending callbacks.
547 */
548void rcu_barrier_tasks(void)
549{
550 /* There is only one callback queue, so this is easy. ;-) */
551 synchronize_rcu_tasks();
552}
553EXPORT_SYMBOL_GPL(rcu_barrier_tasks);
554
555static int __init rcu_spawn_tasks_kthread(void)
556{
4fe192df 557 rcu_tasks.gp_sleep = HZ / 10;
75dc2da5 558 rcu_tasks.init_fract = HZ / 10;
e4fe5dd6
PM
559 rcu_tasks.pregp_func = rcu_tasks_pregp_step;
560 rcu_tasks.pertask_func = rcu_tasks_pertask;
561 rcu_tasks.postscan_func = rcu_tasks_postscan;
562 rcu_tasks.holdouts_func = check_all_holdout_tasks;
563 rcu_tasks.postgp_func = rcu_tasks_postgp;
5873b8a9
PM
564 rcu_spawn_tasks_kthread_generic(&rcu_tasks);
565 return 0;
566}
5873b8a9 567
27c0f144
PM
568#if !defined(CONFIG_TINY_RCU)
569void show_rcu_tasks_classic_gp_kthread(void)
e21408ce
PM
570{
571 show_rcu_tasks_generic_gp_kthread(&rcu_tasks, "");
572}
27c0f144
PM
573EXPORT_SYMBOL_GPL(show_rcu_tasks_classic_gp_kthread);
574#endif // !defined(CONFIG_TINY_RCU)
e21408ce 575
25246fc8
PM
576/* Do the srcu_read_lock() for the above synchronize_srcu(). */
577void exit_tasks_rcu_start(void) __acquires(&tasks_rcu_exit_srcu)
578{
579 preempt_disable();
580 current->rcu_tasks_idx = __srcu_read_lock(&tasks_rcu_exit_srcu);
581 preempt_enable();
582}
583
584/* Do the srcu_read_unlock() for the above synchronize_srcu(). */
585void exit_tasks_rcu_finish(void) __releases(&tasks_rcu_exit_srcu)
586{
587 struct task_struct *t = current;
588
589 preempt_disable();
590 __srcu_read_unlock(&tasks_rcu_exit_srcu, t->rcu_tasks_idx);
591 preempt_enable();
592 exit_tasks_rcu_finish_trace(t);
593}
594
e21408ce 595#else /* #ifdef CONFIG_TASKS_RCU */
25246fc8
PM
596void exit_tasks_rcu_start(void) { }
597void exit_tasks_rcu_finish(void) { exit_tasks_rcu_finish_trace(current); }
e21408ce 598#endif /* #else #ifdef CONFIG_TASKS_RCU */
c84aad76
PM
599
600#ifdef CONFIG_TASKS_RUDE_RCU
601
602////////////////////////////////////////////////////////////////////////
603//
604// "Rude" variant of Tasks RCU, inspired by Steve Rostedt's trick of
605// passing an empty function to schedule_on_each_cpu(). This approach
606// provides an asynchronous call_rcu_tasks_rude() API and batching
607// of concurrent calls to the synchronous synchronize_rcu_rude() API.
608// This sends IPIs far and wide and induces otherwise unnecessary context
609// switches on all online CPUs, whether idle or not.
610
611// Empty function to allow workqueues to force a context switch.
612static void rcu_tasks_be_rude(struct work_struct *work)
613{
614}
615
616// Wait for one rude RCU-tasks grace period.
617static void rcu_tasks_rude_wait_gp(struct rcu_tasks *rtp)
618{
238dbce3 619 rtp->n_ipis += cpumask_weight(cpu_online_mask);
c84aad76
PM
620 schedule_on_each_cpu(rcu_tasks_be_rude);
621}
622
623void call_rcu_tasks_rude(struct rcu_head *rhp, rcu_callback_t func);
c97d12a6
PM
624DEFINE_RCU_TASKS(rcu_tasks_rude, rcu_tasks_rude_wait_gp, call_rcu_tasks_rude,
625 "RCU Tasks Rude");
c84aad76
PM
626
627/**
628 * call_rcu_tasks_rude() - Queue a callback rude task-based grace period
629 * @rhp: structure to be used for queueing the RCU updates.
630 * @func: actual callback function to be invoked after the grace period
631 *
632 * The callback function will be invoked some time after a full grace
633 * period elapses, in other words after all currently executing RCU
634 * read-side critical sections have completed. call_rcu_tasks_rude()
635 * assumes that the read-side critical sections end at context switch,
636 * cond_resched_rcu_qs(), or transition to usermode execution. As such,
637 * there are no read-side primitives analogous to rcu_read_lock() and
638 * rcu_read_unlock() because this primitive is intended to determine
639 * that all tasks have passed through a safe state, not so much for
640 * data-strcuture synchronization.
641 *
642 * See the description of call_rcu() for more detailed information on
643 * memory ordering guarantees.
644 */
645void call_rcu_tasks_rude(struct rcu_head *rhp, rcu_callback_t func)
646{
647 call_rcu_tasks_generic(rhp, func, &rcu_tasks_rude);
648}
649EXPORT_SYMBOL_GPL(call_rcu_tasks_rude);
650
651/**
652 * synchronize_rcu_tasks_rude - wait for a rude rcu-tasks grace period
653 *
654 * Control will return to the caller some time after a rude rcu-tasks
655 * grace period has elapsed, in other words after all currently
656 * executing rcu-tasks read-side critical sections have elapsed. These
657 * read-side critical sections are delimited by calls to schedule(),
658 * cond_resched_tasks_rcu_qs(), userspace execution, and (in theory,
659 * anyway) cond_resched().
660 *
661 * This is a very specialized primitive, intended only for a few uses in
662 * tracing and other situations requiring manipulation of function preambles
663 * and profiling hooks. The synchronize_rcu_tasks_rude() function is not
664 * (yet) intended for heavy use from multiple CPUs.
665 *
666 * See the description of synchronize_rcu() for more detailed information
667 * on memory ordering guarantees.
668 */
669void synchronize_rcu_tasks_rude(void)
670{
671 synchronize_rcu_tasks_generic(&rcu_tasks_rude);
672}
673EXPORT_SYMBOL_GPL(synchronize_rcu_tasks_rude);
674
675/**
676 * rcu_barrier_tasks_rude - Wait for in-flight call_rcu_tasks_rude() callbacks.
677 *
678 * Although the current implementation is guaranteed to wait, it is not
679 * obligated to, for example, if there are no pending callbacks.
680 */
681void rcu_barrier_tasks_rude(void)
682{
683 /* There is only one callback queue, so this is easy. ;-) */
684 synchronize_rcu_tasks_rude();
685}
686EXPORT_SYMBOL_GPL(rcu_barrier_tasks_rude);
687
688static int __init rcu_spawn_tasks_rude_kthread(void)
689{
4fe192df 690 rcu_tasks_rude.gp_sleep = HZ / 10;
c84aad76
PM
691 rcu_spawn_tasks_kthread_generic(&rcu_tasks_rude);
692 return 0;
693}
c84aad76 694
27c0f144
PM
695#if !defined(CONFIG_TINY_RCU)
696void show_rcu_tasks_rude_gp_kthread(void)
e21408ce
PM
697{
698 show_rcu_tasks_generic_gp_kthread(&rcu_tasks_rude, "");
699}
27c0f144
PM
700EXPORT_SYMBOL_GPL(show_rcu_tasks_rude_gp_kthread);
701#endif // !defined(CONFIG_TINY_RCU)
702#endif /* #ifdef CONFIG_TASKS_RUDE_RCU */
d5f177d3
PM
703
704////////////////////////////////////////////////////////////////////////
705//
706// Tracing variant of Tasks RCU. This variant is designed to be used
707// to protect tracing hooks, including those of BPF. This variant
708// therefore:
709//
710// 1. Has explicit read-side markers to allow finite grace periods
711// in the face of in-kernel loops for PREEMPT=n builds.
712//
713// 2. Protects code in the idle loop, exception entry/exit, and
714// CPU-hotplug code paths, similar to the capabilities of SRCU.
715//
716// 3. Avoids expensive read-side instruction, having overhead similar
717// to that of Preemptible RCU.
718//
719// There are of course downsides. The grace-period code can send IPIs to
720// CPUs, even when those CPUs are in the idle loop or in nohz_full userspace.
721// It is necessary to scan the full tasklist, much as for Tasks RCU. There
722// is a single callback queue guarded by a single lock, again, much as for
723// Tasks RCU. If needed, these downsides can be at least partially remedied.
724//
725// Perhaps most important, this variant of RCU does not affect the vanilla
726// flavors, rcu_preempt and rcu_sched. The fact that RCU Tasks Trace
727// readers can operate from idle, offline, and exception entry/exit in no
728// way allows rcu_preempt and rcu_sched readers to also do so.
a434dd10
PM
729//
730// The implementation uses rcu_tasks_wait_gp(), which relies on function
731// pointers in the rcu_tasks structure. The rcu_spawn_tasks_trace_kthread()
732// function sets these function pointers up so that rcu_tasks_wait_gp()
733// invokes these functions in this order:
734//
735// rcu_tasks_trace_pregp_step():
736// Initialize the count of readers and block CPU-hotplug operations.
737// rcu_tasks_trace_pertask(), invoked on every non-idle task:
738// Initialize per-task state and attempt to identify an immediate
739// quiescent state for that task, or, failing that, attempt to
740// set that task's .need_qs flag so that task's next outermost
741// rcu_read_unlock_trace() will report the quiescent state (in which
742// case the count of readers is incremented). If both attempts fail,
743// the task is added to a "holdout" list.
744// rcu_tasks_trace_postscan():
745// Initialize state and attempt to identify an immediate quiescent
746// state as above (but only for idle tasks), unblock CPU-hotplug
747// operations, and wait for an RCU grace period to avoid races with
748// tasks that are in the process of exiting.
749// check_all_holdout_tasks_trace(), repeatedly until holdout list is empty:
750// Scans the holdout list, attempting to identify a quiescent state
751// for each task on the list. If there is a quiescent state, the
752// corresponding task is removed from the holdout list.
753// rcu_tasks_trace_postgp():
754// Wait for the count of readers do drop to zero, reporting any stalls.
755// Also execute full memory barriers to maintain ordering with code
756// executing after the grace period.
757//
758// The exit_tasks_rcu_finish_trace() synchronizes with exiting tasks.
759//
760// Pre-grace-period update-side code is ordered before the grace
761// period via the ->cbs_lock and barriers in rcu_tasks_kthread().
762// Pre-grace-period read-side code is ordered before the grace period by
763// atomic_dec_and_test() of the count of readers (for IPIed readers) and by
764// scheduler context-switch ordering (for locked-down non-running readers).
d5f177d3
PM
765
766// The lockdep state must be outside of #ifdef to be useful.
767#ifdef CONFIG_DEBUG_LOCK_ALLOC
768static struct lock_class_key rcu_lock_trace_key;
769struct lockdep_map rcu_trace_lock_map =
770 STATIC_LOCKDEP_MAP_INIT("rcu_read_lock_trace", &rcu_lock_trace_key);
771EXPORT_SYMBOL_GPL(rcu_trace_lock_map);
772#endif /* #ifdef CONFIG_DEBUG_LOCK_ALLOC */
773
774#ifdef CONFIG_TASKS_TRACE_RCU
775
30d8aa51
PM
776static atomic_t trc_n_readers_need_end; // Number of waited-for readers.
777static DECLARE_WAIT_QUEUE_HEAD(trc_wait); // List of holdout tasks.
d5f177d3
PM
778
779// Record outstanding IPIs to each CPU. No point in sending two...
780static DEFINE_PER_CPU(bool, trc_ipi_to_cpu);
781
40471509
PM
782// The number of detections of task quiescent state relying on
783// heavyweight readers executing explicit memory barriers.
6731da9e
PM
784static unsigned long n_heavy_reader_attempts;
785static unsigned long n_heavy_reader_updates;
786static unsigned long n_heavy_reader_ofl_updates;
40471509 787
b0afa0f0
PM
788void call_rcu_tasks_trace(struct rcu_head *rhp, rcu_callback_t func);
789DEFINE_RCU_TASKS(rcu_tasks_trace, rcu_tasks_wait_gp, call_rcu_tasks_trace,
790 "RCU Tasks Trace");
791
b38f57c1
PM
792/*
793 * This irq_work handler allows rcu_read_unlock_trace() to be invoked
794 * while the scheduler locks are held.
795 */
796static void rcu_read_unlock_iw(struct irq_work *iwp)
797{
798 wake_up(&trc_wait);
799}
800static DEFINE_IRQ_WORK(rcu_tasks_trace_iw, rcu_read_unlock_iw);
801
d5f177d3 802/* If we are the last reader, wake up the grace-period kthread. */
276c4104 803void rcu_read_unlock_trace_special(struct task_struct *t, int nesting)
d5f177d3 804{
276c4104
PM
805 int nq = t->trc_reader_special.b.need_qs;
806
9ae58d7b
PM
807 if (IS_ENABLED(CONFIG_TASKS_TRACE_RCU_READ_MB) &&
808 t->trc_reader_special.b.need_mb)
276c4104
PM
809 smp_mb(); // Pairs with update-side barriers.
810 // Update .need_qs before ->trc_reader_nesting for irq/NMI handlers.
811 if (nq)
812 WRITE_ONCE(t->trc_reader_special.b.need_qs, false);
813 WRITE_ONCE(t->trc_reader_nesting, nesting);
814 if (nq && atomic_dec_and_test(&trc_n_readers_need_end))
b38f57c1 815 irq_work_queue(&rcu_tasks_trace_iw);
d5f177d3
PM
816}
817EXPORT_SYMBOL_GPL(rcu_read_unlock_trace_special);
818
819/* Add a task to the holdout list, if it is not already on the list. */
820static void trc_add_holdout(struct task_struct *t, struct list_head *bhp)
821{
822 if (list_empty(&t->trc_holdout_list)) {
823 get_task_struct(t);
824 list_add(&t->trc_holdout_list, bhp);
825 }
826}
827
828/* Remove a task from the holdout list, if it is in fact present. */
829static void trc_del_holdout(struct task_struct *t)
830{
831 if (!list_empty(&t->trc_holdout_list)) {
832 list_del_init(&t->trc_holdout_list);
833 put_task_struct(t);
834 }
835}
836
837/* IPI handler to check task state. */
838static void trc_read_check_handler(void *t_in)
839{
840 struct task_struct *t = current;
841 struct task_struct *texp = t_in;
842
843 // If the task is no longer running on this CPU, leave.
844 if (unlikely(texp != t)) {
845 if (WARN_ON_ONCE(atomic_dec_and_test(&trc_n_readers_need_end)))
846 wake_up(&trc_wait);
847 goto reset_ipi; // Already on holdout list, so will check later.
848 }
849
850 // If the task is not in a read-side critical section, and
851 // if this is the last reader, awaken the grace-period kthread.
852 if (likely(!t->trc_reader_nesting)) {
853 if (WARN_ON_ONCE(atomic_dec_and_test(&trc_n_readers_need_end)))
854 wake_up(&trc_wait);
855 // Mark as checked after decrement to avoid false
856 // positives on the above WARN_ON_ONCE().
857 WRITE_ONCE(t->trc_reader_checked, true);
858 goto reset_ipi;
859 }
ba3a86e4
PM
860 // If we are racing with an rcu_read_unlock_trace(), try again later.
861 if (unlikely(t->trc_reader_nesting < 0)) {
862 if (WARN_ON_ONCE(atomic_dec_and_test(&trc_n_readers_need_end)))
863 wake_up(&trc_wait);
864 goto reset_ipi;
865 }
d5f177d3
PM
866 WRITE_ONCE(t->trc_reader_checked, true);
867
868 // Get here if the task is in a read-side critical section. Set
869 // its state so that it will awaken the grace-period kthread upon
870 // exit from that critical section.
276c4104
PM
871 WARN_ON_ONCE(t->trc_reader_special.b.need_qs);
872 WRITE_ONCE(t->trc_reader_special.b.need_qs, true);
d5f177d3
PM
873
874reset_ipi:
875 // Allow future IPIs to be sent on CPU and for task.
876 // Also order this IPI handler against any later manipulations of
877 // the intended task.
878 smp_store_release(&per_cpu(trc_ipi_to_cpu, smp_processor_id()), false); // ^^^
879 smp_store_release(&texp->trc_ipi_to_cpu, -1); // ^^^
880}
881
882/* Callback function for scheduler to check locked-down task. */
883static bool trc_inspect_reader(struct task_struct *t, void *arg)
884{
7d0c9c50
PM
885 int cpu = task_cpu(t);
886 bool in_qs = false;
7e3b70e0 887 bool ofl = cpu_is_offline(cpu);
7d0c9c50
PM
888
889 if (task_curr(t)) {
30d8aa51 890 WARN_ON_ONCE(ofl && !is_idle_task(t));
7e3b70e0 891
7d0c9c50 892 // If no chance of heavyweight readers, do it the hard way.
7e3b70e0 893 if (!ofl && !IS_ENABLED(CONFIG_TASKS_TRACE_RCU_READ_MB))
7d0c9c50
PM
894 return false;
895
896 // If heavyweight readers are enabled on the remote task,
897 // we can inspect its state despite its currently running.
898 // However, we cannot safely change its state.
40471509 899 n_heavy_reader_attempts++;
7e3b70e0
PM
900 if (!ofl && // Check for "running" idle tasks on offline CPUs.
901 !rcu_dynticks_zero_in_eqs(cpu, &t->trc_reader_nesting))
7d0c9c50 902 return false; // No quiescent state, do it the hard way.
40471509 903 n_heavy_reader_updates++;
edf3775f
PM
904 if (ofl)
905 n_heavy_reader_ofl_updates++;
7d0c9c50
PM
906 in_qs = true;
907 } else {
908 in_qs = likely(!t->trc_reader_nesting);
909 }
d5f177d3
PM
910
911 // Mark as checked. Because this is called from the grace-period
912 // kthread, also remove the task from the holdout list.
913 t->trc_reader_checked = true;
914 trc_del_holdout(t);
915
7d0c9c50
PM
916 if (in_qs)
917 return true; // Already in quiescent state, done!!!
918
919 // The task is in a read-side critical section, so set up its
920 // state so that it will awaken the grace-period kthread upon exit
921 // from that critical section.
922 atomic_inc(&trc_n_readers_need_end); // One more to wait on.
923 WARN_ON_ONCE(t->trc_reader_special.b.need_qs);
924 WRITE_ONCE(t->trc_reader_special.b.need_qs, true);
d5f177d3
PM
925 return true;
926}
927
928/* Attempt to extract the state for the specified task. */
929static void trc_wait_for_one_reader(struct task_struct *t,
930 struct list_head *bhp)
931{
932 int cpu;
933
934 // If a previous IPI is still in flight, let it complete.
935 if (smp_load_acquire(&t->trc_ipi_to_cpu) != -1) // Order IPI
936 return;
937
938 // The current task had better be in a quiescent state.
939 if (t == current) {
940 t->trc_reader_checked = true;
941 trc_del_holdout(t);
942 WARN_ON_ONCE(t->trc_reader_nesting);
943 return;
944 }
945
946 // Attempt to nail down the task for inspection.
947 get_task_struct(t);
948 if (try_invoke_on_locked_down_task(t, trc_inspect_reader, NULL)) {
949 put_task_struct(t);
950 return;
951 }
952 put_task_struct(t);
953
954 // If currently running, send an IPI, either way, add to list.
955 trc_add_holdout(t, bhp);
574de876
PM
956 if (task_curr(t) &&
957 time_after(jiffies + 1, rcu_tasks_trace.gp_start + rcu_task_ipi_delay)) {
d5f177d3
PM
958 // The task is currently running, so try IPIing it.
959 cpu = task_cpu(t);
960
961 // If there is already an IPI outstanding, let it happen.
962 if (per_cpu(trc_ipi_to_cpu, cpu) || t->trc_ipi_to_cpu >= 0)
963 return;
964
965 atomic_inc(&trc_n_readers_need_end);
966 per_cpu(trc_ipi_to_cpu, cpu) = true;
967 t->trc_ipi_to_cpu = cpu;
238dbce3 968 rcu_tasks_trace.n_ipis++;
d5f177d3
PM
969 if (smp_call_function_single(cpu,
970 trc_read_check_handler, t, 0)) {
971 // Just in case there is some other reason for
972 // failure than the target CPU being offline.
7e0669c3 973 rcu_tasks_trace.n_ipis_fails++;
d5f177d3
PM
974 per_cpu(trc_ipi_to_cpu, cpu) = false;
975 t->trc_ipi_to_cpu = cpu;
976 if (atomic_dec_and_test(&trc_n_readers_need_end)) {
977 WARN_ON_ONCE(1);
978 wake_up(&trc_wait);
979 }
980 }
981 }
982}
983
984/* Initialize for a new RCU-tasks-trace grace period. */
985static void rcu_tasks_trace_pregp_step(void)
986{
987 int cpu;
988
d5f177d3
PM
989 // Allow for fast-acting IPIs.
990 atomic_set(&trc_n_readers_need_end, 1);
991
992 // There shouldn't be any old IPIs, but...
993 for_each_possible_cpu(cpu)
994 WARN_ON_ONCE(per_cpu(trc_ipi_to_cpu, cpu));
81b4a7bc
PM
995
996 // Disable CPU hotplug across the tasklist scan.
997 // This also waits for all readers in CPU-hotplug code paths.
998 cpus_read_lock();
d5f177d3
PM
999}
1000
1001/* Do first-round processing for the specified task. */
1002static void rcu_tasks_trace_pertask(struct task_struct *t,
1003 struct list_head *hop)
1004{
1b04fa99
URS
1005 // During early boot when there is only the one boot CPU, there
1006 // is no idle task for the other CPUs. Just return.
1007 if (unlikely(t == NULL))
1008 return;
1009
276c4104 1010 WRITE_ONCE(t->trc_reader_special.b.need_qs, false);
43766c3e 1011 WRITE_ONCE(t->trc_reader_checked, false);
d5f177d3
PM
1012 t->trc_ipi_to_cpu = -1;
1013 trc_wait_for_one_reader(t, hop);
1014}
1015
9796e1ae
PM
1016/*
1017 * Do intermediate processing between task and holdout scans and
1018 * pick up the idle tasks.
1019 */
1020static void rcu_tasks_trace_postscan(struct list_head *hop)
d5f177d3 1021{
9796e1ae
PM
1022 int cpu;
1023
1024 for_each_possible_cpu(cpu)
1025 rcu_tasks_trace_pertask(idle_task(cpu), hop);
1026
81b4a7bc
PM
1027 // Re-enable CPU hotplug now that the tasklist scan has completed.
1028 cpus_read_unlock();
1029
d5f177d3
PM
1030 // Wait for late-stage exiting tasks to finish exiting.
1031 // These might have passed the call to exit_tasks_rcu_finish().
1032 synchronize_rcu();
1033 // Any tasks that exit after this point will set ->trc_reader_checked.
1034}
1035
4593e772
PM
1036/* Show the state of a task stalling the current RCU tasks trace GP. */
1037static void show_stalled_task_trace(struct task_struct *t, bool *firstreport)
1038{
1039 int cpu;
1040
1041 if (*firstreport) {
1042 pr_err("INFO: rcu_tasks_trace detected stalls on tasks:\n");
1043 *firstreport = false;
1044 }
1045 // FIXME: This should attempt to use try_invoke_on_nonrunning_task().
1046 cpu = task_cpu(t);
1047 pr_alert("P%d: %c%c%c nesting: %d%c cpu: %d\n",
1048 t->pid,
1049 ".I"[READ_ONCE(t->trc_ipi_to_cpu) > 0],
1050 ".i"[is_idle_task(t)],
1051 ".N"[cpu > 0 && tick_nohz_full_cpu(cpu)],
1052 t->trc_reader_nesting,
276c4104 1053 " N"[!!t->trc_reader_special.b.need_qs],
4593e772
PM
1054 cpu);
1055 sched_show_task(t);
1056}
1057
1058/* List stalled IPIs for RCU tasks trace. */
1059static void show_stalled_ipi_trace(void)
1060{
1061 int cpu;
1062
1063 for_each_possible_cpu(cpu)
1064 if (per_cpu(trc_ipi_to_cpu, cpu))
1065 pr_alert("\tIPI outstanding to CPU %d\n", cpu);
1066}
1067
d5f177d3
PM
1068/* Do one scan of the holdout list. */
1069static void check_all_holdout_tasks_trace(struct list_head *hop,
4593e772 1070 bool needreport, bool *firstreport)
d5f177d3
PM
1071{
1072 struct task_struct *g, *t;
1073
81b4a7bc
PM
1074 // Disable CPU hotplug across the holdout list scan.
1075 cpus_read_lock();
1076
d5f177d3
PM
1077 list_for_each_entry_safe(t, g, hop, trc_holdout_list) {
1078 // If safe and needed, try to check the current task.
1079 if (READ_ONCE(t->trc_ipi_to_cpu) == -1 &&
1080 !READ_ONCE(t->trc_reader_checked))
1081 trc_wait_for_one_reader(t, hop);
1082
1083 // If check succeeded, remove this task from the list.
1084 if (READ_ONCE(t->trc_reader_checked))
1085 trc_del_holdout(t);
4593e772
PM
1086 else if (needreport)
1087 show_stalled_task_trace(t, firstreport);
1088 }
81b4a7bc
PM
1089
1090 // Re-enable CPU hotplug now that the holdout list scan has completed.
1091 cpus_read_unlock();
1092
4593e772
PM
1093 if (needreport) {
1094 if (firstreport)
1095 pr_err("INFO: rcu_tasks_trace detected stalls? (Late IPI?)\n");
1096 show_stalled_ipi_trace();
d5f177d3
PM
1097 }
1098}
1099
1100/* Wait for grace period to complete and provide ordering. */
af051ca4 1101static void rcu_tasks_trace_postgp(struct rcu_tasks *rtp)
d5f177d3 1102{
4593e772
PM
1103 bool firstreport;
1104 struct task_struct *g, *t;
1105 LIST_HEAD(holdouts);
1106 long ret;
1107
d5f177d3
PM
1108 // Remove the safety count.
1109 smp_mb__before_atomic(); // Order vs. earlier atomics
1110 atomic_dec(&trc_n_readers_need_end);
1111 smp_mb__after_atomic(); // Order vs. later atomics
1112
1113 // Wait for readers.
af051ca4 1114 set_tasks_gp_state(rtp, RTGS_WAIT_READERS);
4593e772
PM
1115 for (;;) {
1116 ret = wait_event_idle_exclusive_timeout(
1117 trc_wait,
1118 atomic_read(&trc_n_readers_need_end) == 0,
1119 READ_ONCE(rcu_task_stall_timeout));
1120 if (ret)
1121 break; // Count reached zero.
af051ca4 1122 // Stall warning time, so make a list of the offenders.
f747c7e1 1123 rcu_read_lock();
4593e772 1124 for_each_process_thread(g, t)
276c4104 1125 if (READ_ONCE(t->trc_reader_special.b.need_qs))
4593e772 1126 trc_add_holdout(t, &holdouts);
f747c7e1 1127 rcu_read_unlock();
4593e772 1128 firstreport = true;
592031cc
PM
1129 list_for_each_entry_safe(t, g, &holdouts, trc_holdout_list) {
1130 if (READ_ONCE(t->trc_reader_special.b.need_qs))
4593e772 1131 show_stalled_task_trace(t, &firstreport);
592031cc
PM
1132 trc_del_holdout(t); // Release task_struct reference.
1133 }
4593e772
PM
1134 if (firstreport)
1135 pr_err("INFO: rcu_tasks_trace detected stalls? (Counter/taskslist mismatch?)\n");
1136 show_stalled_ipi_trace();
1137 pr_err("\t%d holdouts\n", atomic_read(&trc_n_readers_need_end));
1138 }
d5f177d3 1139 smp_mb(); // Caller's code must be ordered after wakeup.
43766c3e 1140 // Pairs with pretty much every ordering primitive.
d5f177d3
PM
1141}
1142
1143/* Report any needed quiescent state for this exiting task. */
25246fc8 1144static void exit_tasks_rcu_finish_trace(struct task_struct *t)
d5f177d3
PM
1145{
1146 WRITE_ONCE(t->trc_reader_checked, true);
1147 WARN_ON_ONCE(t->trc_reader_nesting);
1148 WRITE_ONCE(t->trc_reader_nesting, 0);
276c4104
PM
1149 if (WARN_ON_ONCE(READ_ONCE(t->trc_reader_special.b.need_qs)))
1150 rcu_read_unlock_trace_special(t, 0);
d5f177d3
PM
1151}
1152
d5f177d3
PM
1153/**
1154 * call_rcu_tasks_trace() - Queue a callback trace task-based grace period
1155 * @rhp: structure to be used for queueing the RCU updates.
1156 * @func: actual callback function to be invoked after the grace period
1157 *
1158 * The callback function will be invoked some time after a full grace
1159 * period elapses, in other words after all currently executing RCU
1160 * read-side critical sections have completed. call_rcu_tasks_trace()
1161 * assumes that the read-side critical sections end at context switch,
1162 * cond_resched_rcu_qs(), or transition to usermode execution. As such,
1163 * there are no read-side primitives analogous to rcu_read_lock() and
1164 * rcu_read_unlock() because this primitive is intended to determine
1165 * that all tasks have passed through a safe state, not so much for
1166 * data-strcuture synchronization.
1167 *
1168 * See the description of call_rcu() for more detailed information on
1169 * memory ordering guarantees.
1170 */
1171void call_rcu_tasks_trace(struct rcu_head *rhp, rcu_callback_t func)
1172{
1173 call_rcu_tasks_generic(rhp, func, &rcu_tasks_trace);
1174}
1175EXPORT_SYMBOL_GPL(call_rcu_tasks_trace);
1176
1177/**
1178 * synchronize_rcu_tasks_trace - wait for a trace rcu-tasks grace period
1179 *
1180 * Control will return to the caller some time after a trace rcu-tasks
c7dcf810
PM
1181 * grace period has elapsed, in other words after all currently executing
1182 * rcu-tasks read-side critical sections have elapsed. These read-side
1183 * critical sections are delimited by calls to rcu_read_lock_trace()
1184 * and rcu_read_unlock_trace().
d5f177d3
PM
1185 *
1186 * This is a very specialized primitive, intended only for a few uses in
1187 * tracing and other situations requiring manipulation of function preambles
1188 * and profiling hooks. The synchronize_rcu_tasks_trace() function is not
1189 * (yet) intended for heavy use from multiple CPUs.
1190 *
1191 * See the description of synchronize_rcu() for more detailed information
1192 * on memory ordering guarantees.
1193 */
1194void synchronize_rcu_tasks_trace(void)
1195{
1196 RCU_LOCKDEP_WARN(lock_is_held(&rcu_trace_lock_map), "Illegal synchronize_rcu_tasks_trace() in RCU Tasks Trace read-side critical section");
1197 synchronize_rcu_tasks_generic(&rcu_tasks_trace);
1198}
1199EXPORT_SYMBOL_GPL(synchronize_rcu_tasks_trace);
1200
1201/**
1202 * rcu_barrier_tasks_trace - Wait for in-flight call_rcu_tasks_trace() callbacks.
1203 *
1204 * Although the current implementation is guaranteed to wait, it is not
1205 * obligated to, for example, if there are no pending callbacks.
1206 */
1207void rcu_barrier_tasks_trace(void)
1208{
1209 /* There is only one callback queue, so this is easy. ;-) */
1210 synchronize_rcu_tasks_trace();
1211}
1212EXPORT_SYMBOL_GPL(rcu_barrier_tasks_trace);
1213
1214static int __init rcu_spawn_tasks_trace_kthread(void)
1215{
2393a613 1216 if (IS_ENABLED(CONFIG_TASKS_TRACE_RCU_READ_MB)) {
4fe192df 1217 rcu_tasks_trace.gp_sleep = HZ / 10;
75dc2da5 1218 rcu_tasks_trace.init_fract = HZ / 10;
2393a613 1219 } else {
4fe192df
PM
1220 rcu_tasks_trace.gp_sleep = HZ / 200;
1221 if (rcu_tasks_trace.gp_sleep <= 0)
1222 rcu_tasks_trace.gp_sleep = 1;
75dc2da5 1223 rcu_tasks_trace.init_fract = HZ / 200;
2393a613
PM
1224 if (rcu_tasks_trace.init_fract <= 0)
1225 rcu_tasks_trace.init_fract = 1;
1226 }
d5f177d3
PM
1227 rcu_tasks_trace.pregp_func = rcu_tasks_trace_pregp_step;
1228 rcu_tasks_trace.pertask_func = rcu_tasks_trace_pertask;
1229 rcu_tasks_trace.postscan_func = rcu_tasks_trace_postscan;
1230 rcu_tasks_trace.holdouts_func = check_all_holdout_tasks_trace;
1231 rcu_tasks_trace.postgp_func = rcu_tasks_trace_postgp;
1232 rcu_spawn_tasks_kthread_generic(&rcu_tasks_trace);
1233 return 0;
1234}
d5f177d3 1235
27c0f144
PM
1236#if !defined(CONFIG_TINY_RCU)
1237void show_rcu_tasks_trace_gp_kthread(void)
e21408ce 1238{
40471509 1239 char buf[64];
e21408ce 1240
edf3775f
PM
1241 sprintf(buf, "N%d h:%lu/%lu/%lu", atomic_read(&trc_n_readers_need_end),
1242 data_race(n_heavy_reader_ofl_updates),
40471509
PM
1243 data_race(n_heavy_reader_updates),
1244 data_race(n_heavy_reader_attempts));
e21408ce
PM
1245 show_rcu_tasks_generic_gp_kthread(&rcu_tasks_trace, buf);
1246}
27c0f144
PM
1247EXPORT_SYMBOL_GPL(show_rcu_tasks_trace_gp_kthread);
1248#endif // !defined(CONFIG_TINY_RCU)
e21408ce 1249
d5f177d3 1250#else /* #ifdef CONFIG_TASKS_TRACE_RCU */
25246fc8 1251static void exit_tasks_rcu_finish_trace(struct task_struct *t) { }
d5f177d3 1252#endif /* #else #ifdef CONFIG_TASKS_TRACE_RCU */
8fd8ca38 1253
8344496e 1254#ifndef CONFIG_TINY_RCU
e21408ce
PM
1255void show_rcu_tasks_gp_kthreads(void)
1256{
1257 show_rcu_tasks_classic_gp_kthread();
1258 show_rcu_tasks_rude_gp_kthread();
1259 show_rcu_tasks_trace_gp_kthread();
1260}
8344496e 1261#endif /* #ifndef CONFIG_TINY_RCU */
e21408ce 1262
bfba7ed0
URS
1263#ifdef CONFIG_PROVE_RCU
1264struct rcu_tasks_test_desc {
1265 struct rcu_head rh;
1266 const char *name;
1267 bool notrun;
1268};
1269
1270static struct rcu_tasks_test_desc tests[] = {
1271 {
1272 .name = "call_rcu_tasks()",
1273 /* If not defined, the test is skipped. */
1274 .notrun = !IS_ENABLED(CONFIG_TASKS_RCU),
1275 },
1276 {
1277 .name = "call_rcu_tasks_rude()",
1278 /* If not defined, the test is skipped. */
1279 .notrun = !IS_ENABLED(CONFIG_TASKS_RUDE_RCU),
1280 },
1281 {
1282 .name = "call_rcu_tasks_trace()",
1283 /* If not defined, the test is skipped. */
1284 .notrun = !IS_ENABLED(CONFIG_TASKS_TRACE_RCU)
1285 }
1286};
1287
1288static void test_rcu_tasks_callback(struct rcu_head *rhp)
1289{
1290 struct rcu_tasks_test_desc *rttd =
1291 container_of(rhp, struct rcu_tasks_test_desc, rh);
1292
1293 pr_info("Callback from %s invoked.\n", rttd->name);
1294
1295 rttd->notrun = true;
1296}
1297
1298static void rcu_tasks_initiate_self_tests(void)
1299{
1300 pr_info("Running RCU-tasks wait API self tests\n");
1301#ifdef CONFIG_TASKS_RCU
1302 synchronize_rcu_tasks();
1303 call_rcu_tasks(&tests[0].rh, test_rcu_tasks_callback);
1304#endif
1305
1306#ifdef CONFIG_TASKS_RUDE_RCU
1307 synchronize_rcu_tasks_rude();
1308 call_rcu_tasks_rude(&tests[1].rh, test_rcu_tasks_callback);
1309#endif
1310
1311#ifdef CONFIG_TASKS_TRACE_RCU
1312 synchronize_rcu_tasks_trace();
1313 call_rcu_tasks_trace(&tests[2].rh, test_rcu_tasks_callback);
1314#endif
1315}
1316
1317static int rcu_tasks_verify_self_tests(void)
1318{
1319 int ret = 0;
1320 int i;
1321
1322 for (i = 0; i < ARRAY_SIZE(tests); i++) {
1323 if (!tests[i].notrun) { // still hanging.
1324 pr_err("%s has been failed.\n", tests[i].name);
1325 ret = -1;
1326 }
1327 }
1328
1329 if (ret)
1330 WARN_ON(1);
1331
1332 return ret;
1333}
1334late_initcall(rcu_tasks_verify_self_tests);
1335#else /* #ifdef CONFIG_PROVE_RCU */
1336static void rcu_tasks_initiate_self_tests(void) { }
1337#endif /* #else #ifdef CONFIG_PROVE_RCU */
1338
1b04fa99
URS
1339void __init rcu_init_tasks_generic(void)
1340{
1341#ifdef CONFIG_TASKS_RCU
1342 rcu_spawn_tasks_kthread();
1343#endif
1344
1345#ifdef CONFIG_TASKS_RUDE_RCU
1346 rcu_spawn_tasks_rude_kthread();
1347#endif
1348
1349#ifdef CONFIG_TASKS_TRACE_RCU
1350 rcu_spawn_tasks_trace_kthread();
1351#endif
bfba7ed0
URS
1352
1353 // Run the self-tests.
1354 rcu_tasks_initiate_self_tests();
1b04fa99
URS
1355}
1356
8fd8ca38
PM
1357#else /* #ifdef CONFIG_TASKS_RCU_GENERIC */
1358static inline void rcu_tasks_bootup_oddness(void) {}
e21408ce 1359void show_rcu_tasks_gp_kthreads(void) {}
8fd8ca38 1360#endif /* #else #ifdef CONFIG_TASKS_RCU_GENERIC */