rcu-tasks: Move synchronize_rcu_tasks_generic() down
[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
9b073de1 9#include "rcu_segcblist.h"
5873b8a9
PM
10
11////////////////////////////////////////////////////////////////////////
12//
13// Generic data structures.
14
15struct rcu_tasks;
16typedef void (*rcu_tasks_gp_func_t)(struct rcu_tasks *rtp);
e4fe5dd6
PM
17typedef void (*pregp_func_t)(void);
18typedef void (*pertask_func_t)(struct task_struct *t, struct list_head *hop);
9796e1ae 19typedef void (*postscan_func_t)(struct list_head *hop);
e4fe5dd6 20typedef void (*holdouts_func_t)(struct list_head *hop, bool ndrpt, bool *frptp);
af051ca4 21typedef void (*postgp_func_t)(struct rcu_tasks *rtp);
eacd6f04 22
07e10515 23/**
cafafd67 24 * struct rcu_tasks_percpu - Per-CPU component of definition for a Tasks-RCU-like mechanism.
9b073de1 25 * @cblist: Callback list.
381a4f3b 26 * @lock: Lock protecting per-CPU callback list.
7d13d30b
PM
27 * @rtp_jiffies: Jiffies counter value for statistics.
28 * @rtp_n_lock_retries: Rough lock-contention statistic.
d363f833 29 * @rtp_work: Work queue for invoking callbacks.
3063b33a 30 * @rtp_irq_work: IRQ work queue for deferred wakeups.
ce9b1c66
PM
31 * @barrier_q_head: RCU callback for barrier operation.
32 * @cpu: CPU number corresponding to this entry.
33 * @rtpp: Pointer to the rcu_tasks structure.
cafafd67
PM
34 */
35struct rcu_tasks_percpu {
9b073de1 36 struct rcu_segcblist cblist;
381a4f3b 37 raw_spinlock_t __private lock;
7d13d30b
PM
38 unsigned long rtp_jiffies;
39 unsigned long rtp_n_lock_retries;
d363f833 40 struct work_struct rtp_work;
3063b33a 41 struct irq_work rtp_irq_work;
ce9b1c66 42 struct rcu_head barrier_q_head;
d363f833
PM
43 int cpu;
44 struct rcu_tasks *rtpp;
cafafd67
PM
45};
46
47/**
48 * struct rcu_tasks - Definition for a Tasks-RCU-like mechanism.
88db792b 49 * @cbs_wait: RCU wait allowing a new callback to get kthread's attention.
cafafd67 50 * @cbs_gbl_lock: Lock protecting callback list.
d96225fd 51 * @tasks_gp_mutex: Mutex protecting grace period, needed during mid-boot dead zone.
07e10515 52 * @kthread_ptr: This flavor's grace-period/callback-invocation kthread.
5873b8a9 53 * @gp_func: This flavor's grace-period-wait function.
af051ca4 54 * @gp_state: Grace period's most recent state transition (debugging).
4fe192df 55 * @gp_sleep: Per-grace-period sleep to prevent CPU-bound looping.
2393a613 56 * @init_fract: Initial backoff sleep interval.
af051ca4
PM
57 * @gp_jiffies: Time of last @gp_state transition.
58 * @gp_start: Most recent grace-period start in jiffies.
b14fb4fb 59 * @tasks_gp_seq: Number of grace periods completed since boot.
238dbce3 60 * @n_ipis: Number of IPIs sent to encourage grace periods to end.
7e0669c3 61 * @n_ipis_fails: Number of IPI-send failures.
e4fe5dd6
PM
62 * @pregp_func: This flavor's pre-grace-period function (optional).
63 * @pertask_func: This flavor's per-task scan function (optional).
64 * @postscan_func: This flavor's post-task scan function (optional).
85b86994 65 * @holdouts_func: This flavor's holdout-list scan function (optional).
e4fe5dd6 66 * @postgp_func: This flavor's post-grace-period function (optional).
5873b8a9 67 * @call_func: This flavor's call_rcu()-equivalent function.
cafafd67 68 * @rtpcpu: This flavor's rcu_tasks_percpu structure.
7a30871b 69 * @percpu_enqueue_shift: Shift down CPU ID this much when enqueuing callbacks.
2cee0789
PM
70 * @percpu_enqueue_lim: Number of per-CPU callback queues in use for enqueuing.
71 * @percpu_dequeue_lim: Number of per-CPU callback queues in use for dequeuing.
fd796e41 72 * @percpu_dequeue_gpseq: RCU grace-period number to propagate enqueue limit to dequeuers.
ce9b1c66
PM
73 * @barrier_q_mutex: Serialize barrier operations.
74 * @barrier_q_count: Number of queues being waited on.
75 * @barrier_q_completion: Barrier wait/wakeup mechanism.
76 * @barrier_q_seq: Sequence number for barrier operations.
c97d12a6
PM
77 * @name: This flavor's textual name.
78 * @kname: This flavor's kthread name.
07e10515
PM
79 */
80struct rcu_tasks {
88db792b 81 struct rcuwait cbs_wait;
cafafd67 82 raw_spinlock_t cbs_gbl_lock;
d96225fd 83 struct mutex tasks_gp_mutex;
af051ca4 84 int gp_state;
4fe192df 85 int gp_sleep;
2393a613 86 int init_fract;
af051ca4 87 unsigned long gp_jiffies;
88092d0c 88 unsigned long gp_start;
b14fb4fb 89 unsigned long tasks_gp_seq;
238dbce3 90 unsigned long n_ipis;
7e0669c3 91 unsigned long n_ipis_fails;
07e10515 92 struct task_struct *kthread_ptr;
5873b8a9 93 rcu_tasks_gp_func_t gp_func;
e4fe5dd6
PM
94 pregp_func_t pregp_func;
95 pertask_func_t pertask_func;
96 postscan_func_t postscan_func;
97 holdouts_func_t holdouts_func;
98 postgp_func_t postgp_func;
5873b8a9 99 call_rcu_func_t call_func;
cafafd67 100 struct rcu_tasks_percpu __percpu *rtpcpu;
7a30871b 101 int percpu_enqueue_shift;
8dd593fd 102 int percpu_enqueue_lim;
2cee0789 103 int percpu_dequeue_lim;
fd796e41 104 unsigned long percpu_dequeue_gpseq;
ce9b1c66
PM
105 struct mutex barrier_q_mutex;
106 atomic_t barrier_q_count;
107 struct completion barrier_q_completion;
108 unsigned long barrier_q_seq;
c97d12a6
PM
109 char *name;
110 char *kname;
07e10515
PM
111};
112
3063b33a
PM
113static void call_rcu_tasks_iw_wakeup(struct irq_work *iwp);
114
cafafd67
PM
115#define DEFINE_RCU_TASKS(rt_name, gp, call, n) \
116static DEFINE_PER_CPU(struct rcu_tasks_percpu, rt_name ## __percpu) = { \
381a4f3b 117 .lock = __RAW_SPIN_LOCK_UNLOCKED(rt_name ## __percpu.cbs_pcpu_lock), \
88db792b 118 .rtp_irq_work = IRQ_WORK_INIT_HARD(call_rcu_tasks_iw_wakeup), \
cafafd67
PM
119}; \
120static struct rcu_tasks rt_name = \
121{ \
88db792b 122 .cbs_wait = __RCUWAIT_INITIALIZER(rt_name.wait), \
cafafd67 123 .cbs_gbl_lock = __RAW_SPIN_LOCK_UNLOCKED(rt_name.cbs_gbl_lock), \
d96225fd 124 .tasks_gp_mutex = __MUTEX_INITIALIZER(rt_name.tasks_gp_mutex), \
cafafd67
PM
125 .gp_func = gp, \
126 .call_func = call, \
127 .rtpcpu = &rt_name ## __percpu, \
128 .name = n, \
2bcd18e0 129 .percpu_enqueue_shift = order_base_2(CONFIG_NR_CPUS), \
8dd593fd 130 .percpu_enqueue_lim = 1, \
2cee0789 131 .percpu_dequeue_lim = 1, \
ce9b1c66
PM
132 .barrier_q_mutex = __MUTEX_INITIALIZER(rt_name.barrier_q_mutex), \
133 .barrier_q_seq = (0UL - 50UL) << RCU_SEQ_CTR_SHIFT, \
cafafd67 134 .kname = #rt_name, \
07e10515
PM
135}
136
eacd6f04
PM
137/* Track exiting tasks in order to allow them to be waited for. */
138DEFINE_STATIC_SRCU(tasks_rcu_exit_srcu);
139
b0afa0f0 140/* Avoid IPIing CPUs early in the grace period. */
574de876 141#define RCU_TASK_IPI_DELAY (IS_ENABLED(CONFIG_TASKS_TRACE_RCU_READ_MB) ? HZ / 2 : 0)
b0afa0f0
PM
142static int rcu_task_ipi_delay __read_mostly = RCU_TASK_IPI_DELAY;
143module_param(rcu_task_ipi_delay, int, 0644);
144
eacd6f04
PM
145/* Control stall timeouts. Disable with <= 0, otherwise jiffies till stall. */
146#define RCU_TASK_STALL_TIMEOUT (HZ * 60 * 10)
147static int rcu_task_stall_timeout __read_mostly = RCU_TASK_STALL_TIMEOUT;
148module_param(rcu_task_stall_timeout, int, 0644);
f2539003
PM
149#define RCU_TASK_STALL_INFO (HZ * 10)
150static int rcu_task_stall_info __read_mostly = RCU_TASK_STALL_INFO;
151module_param(rcu_task_stall_info, int, 0644);
152static int rcu_task_stall_info_mult __read_mostly = 3;
153module_param(rcu_task_stall_info_mult, int, 0444);
eacd6f04 154
8610b656
PM
155static int rcu_task_enqueue_lim __read_mostly = -1;
156module_param(rcu_task_enqueue_lim, int, 0444);
157
ab97152f
PM
158static bool rcu_task_cb_adjust;
159static int rcu_task_contend_lim __read_mostly = 100;
160module_param(rcu_task_contend_lim, int, 0444);
fd796e41
PM
161static int rcu_task_collapse_lim __read_mostly = 10;
162module_param(rcu_task_collapse_lim, int, 0444);
ab97152f 163
af051ca4
PM
164/* RCU tasks grace-period state for debugging. */
165#define RTGS_INIT 0
166#define RTGS_WAIT_WAIT_CBS 1
167#define RTGS_WAIT_GP 2
168#define RTGS_PRE_WAIT_GP 3
169#define RTGS_SCAN_TASKLIST 4
170#define RTGS_POST_SCAN_TASKLIST 5
171#define RTGS_WAIT_SCAN_HOLDOUTS 6
172#define RTGS_SCAN_HOLDOUTS 7
173#define RTGS_POST_GP 8
174#define RTGS_WAIT_READERS 9
175#define RTGS_INVOKE_CBS 10
176#define RTGS_WAIT_CBS 11
8344496e 177#ifndef CONFIG_TINY_RCU
af051ca4
PM
178static const char * const rcu_tasks_gp_state_names[] = {
179 "RTGS_INIT",
180 "RTGS_WAIT_WAIT_CBS",
181 "RTGS_WAIT_GP",
182 "RTGS_PRE_WAIT_GP",
183 "RTGS_SCAN_TASKLIST",
184 "RTGS_POST_SCAN_TASKLIST",
185 "RTGS_WAIT_SCAN_HOLDOUTS",
186 "RTGS_SCAN_HOLDOUTS",
187 "RTGS_POST_GP",
188 "RTGS_WAIT_READERS",
189 "RTGS_INVOKE_CBS",
190 "RTGS_WAIT_CBS",
191};
8344496e 192#endif /* #ifndef CONFIG_TINY_RCU */
af051ca4 193
5873b8a9
PM
194////////////////////////////////////////////////////////////////////////
195//
196// Generic code.
197
d363f833
PM
198static void rcu_tasks_invoke_cbs_wq(struct work_struct *wp);
199
af051ca4
PM
200/* Record grace-period phase and time. */
201static void set_tasks_gp_state(struct rcu_tasks *rtp, int newstate)
202{
203 rtp->gp_state = newstate;
204 rtp->gp_jiffies = jiffies;
205}
206
8344496e 207#ifndef CONFIG_TINY_RCU
af051ca4
PM
208/* Return state name. */
209static const char *tasks_gp_state_getname(struct rcu_tasks *rtp)
210{
211 int i = data_race(rtp->gp_state); // Let KCSAN detect update races
212 int j = READ_ONCE(i); // Prevent the compiler from reading twice
213
214 if (j >= ARRAY_SIZE(rcu_tasks_gp_state_names))
215 return "???";
216 return rcu_tasks_gp_state_names[j];
217}
8344496e 218#endif /* #ifndef CONFIG_TINY_RCU */
af051ca4 219
cafafd67
PM
220// Initialize per-CPU callback lists for the specified flavor of
221// Tasks RCU.
222static void cblist_init_generic(struct rcu_tasks *rtp)
223{
224 int cpu;
225 unsigned long flags;
8610b656 226 int lim;
da123016 227 int shift;
cafafd67
PM
228
229 raw_spin_lock_irqsave(&rtp->cbs_gbl_lock, flags);
ab97152f
PM
230 if (rcu_task_enqueue_lim < 0) {
231 rcu_task_enqueue_lim = 1;
232 rcu_task_cb_adjust = true;
233 pr_info("%s: Setting adjustable number of callback queues.\n", __func__);
234 } else if (rcu_task_enqueue_lim == 0) {
8610b656 235 rcu_task_enqueue_lim = 1;
ab97152f 236 }
8610b656
PM
237 lim = rcu_task_enqueue_lim;
238
239 if (lim > nr_cpu_ids)
240 lim = nr_cpu_ids;
da123016
PM
241 shift = ilog2(nr_cpu_ids / lim);
242 if (((nr_cpu_ids - 1) >> shift) >= lim)
243 shift++;
244 WRITE_ONCE(rtp->percpu_enqueue_shift, shift);
2cee0789 245 WRITE_ONCE(rtp->percpu_dequeue_lim, lim);
8610b656 246 smp_store_release(&rtp->percpu_enqueue_lim, lim);
cafafd67
PM
247 for_each_possible_cpu(cpu) {
248 struct rcu_tasks_percpu *rtpcp = per_cpu_ptr(rtp->rtpcpu, cpu);
249
250 WARN_ON_ONCE(!rtpcp);
251 if (cpu)
381a4f3b
PM
252 raw_spin_lock_init(&ACCESS_PRIVATE(rtpcp, lock));
253 raw_spin_lock_rcu_node(rtpcp); // irqs already disabled.
9b073de1
PM
254 if (rcu_segcblist_empty(&rtpcp->cblist))
255 rcu_segcblist_init(&rtpcp->cblist);
d363f833
PM
256 INIT_WORK(&rtpcp->rtp_work, rcu_tasks_invoke_cbs_wq);
257 rtpcp->cpu = cpu;
258 rtpcp->rtpp = rtp;
381a4f3b 259 raw_spin_unlock_rcu_node(rtpcp); // irqs remain disabled.
cafafd67
PM
260 }
261 raw_spin_unlock_irqrestore(&rtp->cbs_gbl_lock, flags);
8610b656 262 pr_info("%s: Setting shift to %d and lim to %d.\n", __func__, data_race(rtp->percpu_enqueue_shift), data_race(rtp->percpu_enqueue_lim));
cafafd67
PM
263}
264
3063b33a
PM
265// IRQ-work handler that does deferred wakeup for call_rcu_tasks_generic().
266static void call_rcu_tasks_iw_wakeup(struct irq_work *iwp)
267{
268 struct rcu_tasks *rtp;
269 struct rcu_tasks_percpu *rtpcp = container_of(iwp, struct rcu_tasks_percpu, rtp_irq_work);
270
271 rtp = rtpcp->rtpp;
88db792b 272 rcuwait_wake_up(&rtp->cbs_wait);
3063b33a
PM
273}
274
5873b8a9
PM
275// Enqueue a callback for the specified flavor of Tasks RCU.
276static void call_rcu_tasks_generic(struct rcu_head *rhp, rcu_callback_t func,
277 struct rcu_tasks *rtp)
eacd6f04 278{
07d95c34 279 int chosen_cpu;
eacd6f04 280 unsigned long flags;
07d95c34 281 int ideal_cpu;
7d13d30b 282 unsigned long j;
ab97152f 283 bool needadjust = false;
eacd6f04 284 bool needwake;
cafafd67 285 struct rcu_tasks_percpu *rtpcp;
eacd6f04
PM
286
287 rhp->next = NULL;
288 rhp->func = func;
cafafd67 289 local_irq_save(flags);
fd796e41 290 rcu_read_lock();
07d95c34
ED
291 ideal_cpu = smp_processor_id() >> READ_ONCE(rtp->percpu_enqueue_shift);
292 chosen_cpu = cpumask_next(ideal_cpu - 1, cpu_possible_mask);
293 rtpcp = per_cpu_ptr(rtp->rtpcpu, chosen_cpu);
7d13d30b
PM
294 if (!raw_spin_trylock_rcu_node(rtpcp)) { // irqs already disabled.
295 raw_spin_lock_rcu_node(rtpcp); // irqs already disabled.
296 j = jiffies;
297 if (rtpcp->rtp_jiffies != j) {
298 rtpcp->rtp_jiffies = j;
299 rtpcp->rtp_n_lock_retries = 0;
300 }
ab97152f
PM
301 if (rcu_task_cb_adjust && ++rtpcp->rtp_n_lock_retries > rcu_task_contend_lim &&
302 READ_ONCE(rtp->percpu_enqueue_lim) != nr_cpu_ids)
303 needadjust = true; // Defer adjustment to avoid deadlock.
7d13d30b 304 }
9b073de1 305 if (!rcu_segcblist_is_enabled(&rtpcp->cblist)) {
381a4f3b 306 raw_spin_unlock_rcu_node(rtpcp); // irqs remain disabled.
cafafd67 307 cblist_init_generic(rtp);
381a4f3b 308 raw_spin_lock_rcu_node(rtpcp); // irqs already disabled.
cafafd67 309 }
9b073de1
PM
310 needwake = rcu_segcblist_empty(&rtpcp->cblist);
311 rcu_segcblist_enqueue(&rtpcp->cblist, rhp);
381a4f3b 312 raw_spin_unlock_irqrestore_rcu_node(rtpcp, flags);
ab97152f
PM
313 if (unlikely(needadjust)) {
314 raw_spin_lock_irqsave(&rtp->cbs_gbl_lock, flags);
315 if (rtp->percpu_enqueue_lim != nr_cpu_ids) {
00a8b4b5 316 WRITE_ONCE(rtp->percpu_enqueue_shift, 0);
fd796e41 317 WRITE_ONCE(rtp->percpu_dequeue_lim, nr_cpu_ids);
ab97152f
PM
318 smp_store_release(&rtp->percpu_enqueue_lim, nr_cpu_ids);
319 pr_info("Switching %s to per-CPU callback queuing.\n", rtp->name);
320 }
321 raw_spin_unlock_irqrestore(&rtp->cbs_gbl_lock, flags);
322 }
fd796e41 323 rcu_read_unlock();
eacd6f04 324 /* We can't create the thread unless interrupts are enabled. */
07e10515 325 if (needwake && READ_ONCE(rtp->kthread_ptr))
3063b33a 326 irq_work_queue(&rtpcp->rtp_irq_work);
eacd6f04 327}
eacd6f04 328
ce9b1c66
PM
329// RCU callback function for rcu_barrier_tasks_generic().
330static void rcu_barrier_tasks_generic_cb(struct rcu_head *rhp)
331{
332 struct rcu_tasks *rtp;
333 struct rcu_tasks_percpu *rtpcp;
334
335 rtpcp = container_of(rhp, struct rcu_tasks_percpu, barrier_q_head);
336 rtp = rtpcp->rtpp;
337 if (atomic_dec_and_test(&rtp->barrier_q_count))
338 complete(&rtp->barrier_q_completion);
339}
340
341// Wait for all in-flight callbacks for the specified RCU Tasks flavor.
342// Operates in a manner similar to rcu_barrier().
343static void rcu_barrier_tasks_generic(struct rcu_tasks *rtp)
344{
345 int cpu;
346 unsigned long flags;
347 struct rcu_tasks_percpu *rtpcp;
348 unsigned long s = rcu_seq_snap(&rtp->barrier_q_seq);
349
350 mutex_lock(&rtp->barrier_q_mutex);
351 if (rcu_seq_done(&rtp->barrier_q_seq, s)) {
352 smp_mb();
353 mutex_unlock(&rtp->barrier_q_mutex);
354 return;
355 }
356 rcu_seq_start(&rtp->barrier_q_seq);
357 init_completion(&rtp->barrier_q_completion);
358 atomic_set(&rtp->barrier_q_count, 2);
359 for_each_possible_cpu(cpu) {
2cee0789 360 if (cpu >= smp_load_acquire(&rtp->percpu_dequeue_lim))
ce9b1c66
PM
361 break;
362 rtpcp = per_cpu_ptr(rtp->rtpcpu, cpu);
363 rtpcp->barrier_q_head.func = rcu_barrier_tasks_generic_cb;
364 raw_spin_lock_irqsave_rcu_node(rtpcp, flags);
365 if (rcu_segcblist_entrain(&rtpcp->cblist, &rtpcp->barrier_q_head))
366 atomic_inc(&rtp->barrier_q_count);
367 raw_spin_unlock_irqrestore_rcu_node(rtpcp, flags);
368 }
369 if (atomic_sub_and_test(2, &rtp->barrier_q_count))
370 complete(&rtp->barrier_q_completion);
371 wait_for_completion(&rtp->barrier_q_completion);
372 rcu_seq_end(&rtp->barrier_q_seq);
373 mutex_unlock(&rtp->barrier_q_mutex);
374}
375
4d1114c0
PM
376// Advance callbacks and indicate whether either a grace period or
377// callback invocation is needed.
378static int rcu_tasks_need_gpcb(struct rcu_tasks *rtp)
379{
380 int cpu;
381 unsigned long flags;
fd796e41
PM
382 long n;
383 long ncbs = 0;
384 long ncbsnz = 0;
4d1114c0
PM
385 int needgpcb = 0;
386
2cee0789 387 for (cpu = 0; cpu < smp_load_acquire(&rtp->percpu_dequeue_lim); cpu++) {
4d1114c0
PM
388 struct rcu_tasks_percpu *rtpcp = per_cpu_ptr(rtp->rtpcpu, cpu);
389
390 /* Advance and accelerate any new callbacks. */
fd796e41 391 if (!rcu_segcblist_n_cbs(&rtpcp->cblist))
4d1114c0
PM
392 continue;
393 raw_spin_lock_irqsave_rcu_node(rtpcp, flags);
fd796e41
PM
394 // Should we shrink down to a single callback queue?
395 n = rcu_segcblist_n_cbs(&rtpcp->cblist);
396 if (n) {
397 ncbs += n;
398 if (cpu > 0)
399 ncbsnz += n;
400 }
4d1114c0
PM
401 rcu_segcblist_advance(&rtpcp->cblist, rcu_seq_current(&rtp->tasks_gp_seq));
402 (void)rcu_segcblist_accelerate(&rtpcp->cblist, rcu_seq_snap(&rtp->tasks_gp_seq));
403 if (rcu_segcblist_pend_cbs(&rtpcp->cblist))
404 needgpcb |= 0x3;
405 if (!rcu_segcblist_empty(&rtpcp->cblist))
406 needgpcb |= 0x1;
407 raw_spin_unlock_irqrestore_rcu_node(rtpcp, flags);
408 }
fd796e41
PM
409
410 // Shrink down to a single callback queue if appropriate.
411 // This is done in two stages: (1) If there are no more than
412 // rcu_task_collapse_lim callbacks on CPU 0 and none on any other
413 // CPU, limit enqueueing to CPU 0. (2) After an RCU grace period,
414 // if there has not been an increase in callbacks, limit dequeuing
415 // to CPU 0. Note the matching RCU read-side critical section in
416 // call_rcu_tasks_generic().
417 if (rcu_task_cb_adjust && ncbs <= rcu_task_collapse_lim) {
418 raw_spin_lock_irqsave(&rtp->cbs_gbl_lock, flags);
419 if (rtp->percpu_enqueue_lim > 1) {
2bcd18e0 420 WRITE_ONCE(rtp->percpu_enqueue_shift, order_base_2(nr_cpu_ids));
fd796e41
PM
421 smp_store_release(&rtp->percpu_enqueue_lim, 1);
422 rtp->percpu_dequeue_gpseq = get_state_synchronize_rcu();
423 pr_info("Starting switch %s to CPU-0 callback queuing.\n", rtp->name);
424 }
425 raw_spin_unlock_irqrestore(&rtp->cbs_gbl_lock, flags);
426 }
427 if (rcu_task_cb_adjust && !ncbsnz &&
428 poll_state_synchronize_rcu(rtp->percpu_dequeue_gpseq)) {
429 raw_spin_lock_irqsave(&rtp->cbs_gbl_lock, flags);
430 if (rtp->percpu_enqueue_lim < rtp->percpu_dequeue_lim) {
431 WRITE_ONCE(rtp->percpu_dequeue_lim, 1);
432 pr_info("Completing switch %s to CPU-0 callback queuing.\n", rtp->name);
433 }
4cf0585c
PM
434 for (cpu = rtp->percpu_dequeue_lim; cpu < nr_cpu_ids; cpu++) {
435 struct rcu_tasks_percpu *rtpcp = per_cpu_ptr(rtp->rtpcpu, cpu);
436
437 WARN_ON_ONCE(rcu_segcblist_n_cbs(&rtpcp->cblist));
438 }
fd796e41
PM
439 raw_spin_unlock_irqrestore(&rtp->cbs_gbl_lock, flags);
440 }
441
4d1114c0
PM
442 return needgpcb;
443}
444
57881863 445// Advance callbacks and invoke any that are ready.
d363f833 446static void rcu_tasks_invoke_cbs(struct rcu_tasks *rtp, struct rcu_tasks_percpu *rtpcp)
eacd6f04 447{
57881863 448 int cpu;
d363f833 449 int cpunext;
eacd6f04 450 unsigned long flags;
9b073de1 451 int len;
9b073de1 452 struct rcu_head *rhp;
d363f833
PM
453 struct rcu_cblist rcl = RCU_CBLIST_INITIALIZER(rcl);
454 struct rcu_tasks_percpu *rtpcp_next;
455
456 cpu = rtpcp->cpu;
457 cpunext = cpu * 2 + 1;
2cee0789 458 if (cpunext < smp_load_acquire(&rtp->percpu_dequeue_lim)) {
d363f833
PM
459 rtpcp_next = per_cpu_ptr(rtp->rtpcpu, cpunext);
460 queue_work_on(cpunext, system_wq, &rtpcp_next->rtp_work);
461 cpunext++;
2cee0789 462 if (cpunext < smp_load_acquire(&rtp->percpu_dequeue_lim)) {
d363f833
PM
463 rtpcp_next = per_cpu_ptr(rtp->rtpcpu, cpunext);
464 queue_work_on(cpunext, system_wq, &rtpcp_next->rtp_work);
57881863 465 }
57881863 466 }
d363f833 467
ab2756ea 468 if (rcu_segcblist_empty(&rtpcp->cblist) || !cpu_possible(cpu))
d363f833
PM
469 return;
470 raw_spin_lock_irqsave_rcu_node(rtpcp, flags);
471 rcu_segcblist_advance(&rtpcp->cblist, rcu_seq_current(&rtp->tasks_gp_seq));
472 rcu_segcblist_extract_done_cbs(&rtpcp->cblist, &rcl);
473 raw_spin_unlock_irqrestore_rcu_node(rtpcp, flags);
474 len = rcl.len;
475 for (rhp = rcu_cblist_dequeue(&rcl); rhp; rhp = rcu_cblist_dequeue(&rcl)) {
476 local_bh_disable();
477 rhp->func(rhp);
478 local_bh_enable();
479 cond_resched();
480 }
481 raw_spin_lock_irqsave_rcu_node(rtpcp, flags);
482 rcu_segcblist_add_len(&rtpcp->cblist, -len);
483 (void)rcu_segcblist_accelerate(&rtpcp->cblist, rcu_seq_snap(&rtp->tasks_gp_seq));
484 raw_spin_unlock_irqrestore_rcu_node(rtpcp, flags);
485}
486
487// Workqueue flood to advance callbacks and invoke any that are ready.
488static void rcu_tasks_invoke_cbs_wq(struct work_struct *wp)
489{
490 struct rcu_tasks *rtp;
491 struct rcu_tasks_percpu *rtpcp = container_of(wp, struct rcu_tasks_percpu, rtp_work);
492
493 rtp = rtpcp->rtpp;
494 rcu_tasks_invoke_cbs(rtp, rtpcp);
57881863
PM
495}
496
d96225fd
PM
497// Wait for one grace period.
498static void rcu_tasks_one_gp(struct rcu_tasks *rtp)
57881863
PM
499{
500 int needgpcb;
d96225fd
PM
501
502 mutex_lock(&rtp->tasks_gp_mutex);
503 set_tasks_gp_state(rtp, RTGS_WAIT_CBS);
504
505 // If there were none, wait a bit and start over.
506 rcuwait_wait_event(&rtp->cbs_wait,
507 (needgpcb = rcu_tasks_need_gpcb(rtp)),
508 TASK_IDLE);
509
510 if (needgpcb & 0x2) {
511 // Wait for one grace period.
512 set_tasks_gp_state(rtp, RTGS_WAIT_GP);
513 rtp->gp_start = jiffies;
514 rcu_seq_start(&rtp->tasks_gp_seq);
515 rtp->gp_func(rtp);
516 rcu_seq_end(&rtp->tasks_gp_seq);
517 }
518
519 // Invoke callbacks.
520 set_tasks_gp_state(rtp, RTGS_INVOKE_CBS);
521 rcu_tasks_invoke_cbs(rtp, per_cpu_ptr(rtp->rtpcpu, 0));
522 mutex_unlock(&rtp->tasks_gp_mutex);
523}
524
525// RCU-tasks kthread that detects grace periods and invokes callbacks.
526static int __noreturn rcu_tasks_kthread(void *arg)
527{
07e10515 528 struct rcu_tasks *rtp = arg;
eacd6f04
PM
529
530 /* Run on housekeeping CPUs by default. Sysadm can move if desired. */
04d4e665 531 housekeeping_affine(current, HK_TYPE_RCU);
07e10515 532 WRITE_ONCE(rtp->kthread_ptr, current); // Let GPs start!
eacd6f04
PM
533
534 /*
535 * Each pass through the following loop makes one check for
536 * newly arrived callbacks, and, if there are some, waits for
537 * one RCU-tasks grace period and then invokes the callbacks.
538 * This loop is terminated by the system going down. ;-)
539 */
540 for (;;) {
d96225fd
PM
541 // Wait for one grace period and invoke any callbacks
542 // that are ready.
543 rcu_tasks_one_gp(rtp);
57881863 544
d96225fd 545 // Paranoid sleep to keep this from entering a tight loop.
4fe192df 546 schedule_timeout_idle(rtp->gp_sleep);
eacd6f04
PM
547 }
548}
549
68cb4720
PM
550// Wait for a grace period for the specified flavor of Tasks RCU.
551static void synchronize_rcu_tasks_generic(struct rcu_tasks *rtp)
552{
553 /* Complain if the scheduler has not started. */
554 RCU_LOCKDEP_WARN(rcu_scheduler_active == RCU_SCHEDULER_INACTIVE,
555 "synchronize_rcu_tasks called too soon");
556
557 /* Wait for the grace period. */
558 wait_rcu_gp(rtp->call_func);
559}
560
1b04fa99 561/* Spawn RCU-tasks grace-period kthread. */
5873b8a9 562static void __init rcu_spawn_tasks_kthread_generic(struct rcu_tasks *rtp)
eacd6f04
PM
563{
564 struct task_struct *t;
565
c97d12a6
PM
566 t = kthread_run(rcu_tasks_kthread, rtp, "%s_kthread", rtp->kname);
567 if (WARN_ONCE(IS_ERR(t), "%s: Could not start %s grace-period kthread, OOM is now expected behavior\n", __func__, rtp->name))
5873b8a9 568 return;
eacd6f04 569 smp_mb(); /* Ensure others see full kthread. */
eacd6f04 570}
eacd6f04 571
eacd6f04
PM
572#ifndef CONFIG_TINY_RCU
573
574/*
575 * Print any non-default Tasks RCU settings.
576 */
577static void __init rcu_tasks_bootup_oddness(void)
578{
d5f177d3 579#if defined(CONFIG_TASKS_RCU) || defined(CONFIG_TASKS_TRACE_RCU)
f2539003
PM
580 int rtsimc;
581
eacd6f04
PM
582 if (rcu_task_stall_timeout != RCU_TASK_STALL_TIMEOUT)
583 pr_info("\tTasks-RCU CPU stall warnings timeout set to %d (rcu_task_stall_timeout).\n", rcu_task_stall_timeout);
f2539003
PM
584 rtsimc = clamp(rcu_task_stall_info_mult, 1, 10);
585 if (rtsimc != rcu_task_stall_info_mult) {
586 pr_info("\tTasks-RCU CPU stall info multiplier clamped to %d (rcu_task_stall_info_mult).\n", rtsimc);
587 rcu_task_stall_info_mult = rtsimc;
588 }
d5f177d3
PM
589#endif /* #ifdef CONFIG_TASKS_RCU */
590#ifdef CONFIG_TASKS_RCU
591 pr_info("\tTrampoline variant of Tasks RCU enabled.\n");
eacd6f04 592#endif /* #ifdef CONFIG_TASKS_RCU */
c84aad76
PM
593#ifdef CONFIG_TASKS_RUDE_RCU
594 pr_info("\tRude variant of Tasks RCU enabled.\n");
595#endif /* #ifdef CONFIG_TASKS_RUDE_RCU */
d5f177d3
PM
596#ifdef CONFIG_TASKS_TRACE_RCU
597 pr_info("\tTracing variant of Tasks RCU enabled.\n");
598#endif /* #ifdef CONFIG_TASKS_TRACE_RCU */
eacd6f04
PM
599}
600
601#endif /* #ifndef CONFIG_TINY_RCU */
5873b8a9 602
8344496e 603#ifndef CONFIG_TINY_RCU
e21408ce
PM
604/* Dump out rcutorture-relevant state common to all RCU-tasks flavors. */
605static void show_rcu_tasks_generic_gp_kthread(struct rcu_tasks *rtp, char *s)
606{
10b3742f
PM
607 int cpu;
608 bool havecbs = false;
609
610 for_each_possible_cpu(cpu) {
611 struct rcu_tasks_percpu *rtpcp = per_cpu_ptr(rtp->rtpcpu, cpu);
612
613 if (!data_race(rcu_segcblist_empty(&rtpcp->cblist))) {
614 havecbs = true;
615 break;
616 }
617 }
7e0669c3 618 pr_info("%s: %s(%d) since %lu g:%lu i:%lu/%lu %c%c %s\n",
e21408ce 619 rtp->kname,
7e0669c3 620 tasks_gp_state_getname(rtp), data_race(rtp->gp_state),
af051ca4 621 jiffies - data_race(rtp->gp_jiffies),
b14fb4fb 622 data_race(rcu_seq_current(&rtp->tasks_gp_seq)),
7e0669c3 623 data_race(rtp->n_ipis_fails), data_race(rtp->n_ipis),
e21408ce 624 ".k"[!!data_race(rtp->kthread_ptr)],
10b3742f 625 ".C"[havecbs],
e21408ce
PM
626 s);
627}
27c0f144 628#endif // #ifndef CONFIG_TINY_RCU
e21408ce 629
25246fc8
PM
630static void exit_tasks_rcu_finish_trace(struct task_struct *t);
631
632#if defined(CONFIG_TASKS_RCU) || defined(CONFIG_TASKS_TRACE_RCU)
5873b8a9 633
d01aa263
PM
634////////////////////////////////////////////////////////////////////////
635//
636// Shared code between task-list-scanning variants of Tasks RCU.
637
638/* Wait for one RCU-tasks grace period. */
639static void rcu_tasks_wait_gp(struct rcu_tasks *rtp)
640{
f2539003 641 struct task_struct *g;
d01aa263 642 int fract;
f2539003
PM
643 LIST_HEAD(holdouts);
644 unsigned long j;
645 unsigned long lastinfo;
646 unsigned long lastreport;
647 bool reported = false;
648 int rtsi;
649 struct task_struct *t;
d01aa263 650
af051ca4 651 set_tasks_gp_state(rtp, RTGS_PRE_WAIT_GP);
d01aa263
PM
652 rtp->pregp_func();
653
654 /*
655 * There were callbacks, so we need to wait for an RCU-tasks
656 * grace period. Start off by scanning the task list for tasks
657 * that are not already voluntarily blocked. Mark these tasks
658 * and make a list of them in holdouts.
659 */
af051ca4 660 set_tasks_gp_state(rtp, RTGS_SCAN_TASKLIST);
d01aa263
PM
661 rcu_read_lock();
662 for_each_process_thread(g, t)
663 rtp->pertask_func(t, &holdouts);
664 rcu_read_unlock();
665
af051ca4 666 set_tasks_gp_state(rtp, RTGS_POST_SCAN_TASKLIST);
9796e1ae 667 rtp->postscan_func(&holdouts);
d01aa263
PM
668
669 /*
670 * Each pass through the following loop scans the list of holdout
671 * tasks, removing any that are no longer holdouts. When the list
672 * is empty, we are done.
673 */
674 lastreport = jiffies;
f2539003
PM
675 lastinfo = lastreport;
676 rtsi = READ_ONCE(rcu_task_stall_info);
d01aa263 677
2393a613
PM
678 // Start off with initial wait and slowly back off to 1 HZ wait.
679 fract = rtp->init_fract;
d01aa263 680
77dc1741 681 while (!list_empty(&holdouts)) {
777570d9 682 ktime_t exp;
d01aa263
PM
683 bool firstreport;
684 bool needreport;
685 int rtst;
686
f2539003 687 // Slowly back off waiting for holdouts
af051ca4 688 set_tasks_gp_state(rtp, RTGS_WAIT_SCAN_HOLDOUTS);
bddf7122
PM
689 if (!IS_ENABLED(CONFIG_PREEMPT_RT)) {
690 schedule_timeout_idle(fract);
691 } else {
692 exp = jiffies_to_nsecs(fract);
693 __set_current_state(TASK_IDLE);
694 schedule_hrtimeout_range(&exp, jiffies_to_nsecs(HZ / 2), HRTIMER_MODE_REL_HARD);
695 }
d01aa263 696
75dc2da5
PM
697 if (fract < HZ)
698 fract++;
d01aa263
PM
699
700 rtst = READ_ONCE(rcu_task_stall_timeout);
701 needreport = rtst > 0 && time_after(jiffies, lastreport + rtst);
f2539003 702 if (needreport) {
d01aa263 703 lastreport = jiffies;
f2539003
PM
704 reported = true;
705 }
d01aa263
PM
706 firstreport = true;
707 WARN_ON(signal_pending(current));
af051ca4 708 set_tasks_gp_state(rtp, RTGS_SCAN_HOLDOUTS);
d01aa263 709 rtp->holdouts_func(&holdouts, needreport, &firstreport);
f2539003
PM
710
711 // Print pre-stall informational messages if needed.
712 j = jiffies;
713 if (rtsi > 0 && !reported && time_after(j, lastinfo + rtsi)) {
714 lastinfo = j;
715 rtsi = rtsi * rcu_task_stall_info_mult;
716 pr_info("%s: %s grace period %lu is %lu jiffies old.\n",
717 __func__, rtp->kname, rtp->tasks_gp_seq, j - rtp->gp_start);
718 }
d01aa263
PM
719 }
720
af051ca4
PM
721 set_tasks_gp_state(rtp, RTGS_POST_GP);
722 rtp->postgp_func(rtp);
d01aa263
PM
723}
724
25246fc8
PM
725#endif /* #if defined(CONFIG_TASKS_RCU) || defined(CONFIG_TASKS_TRACE_RCU) */
726
727#ifdef CONFIG_TASKS_RCU
728
5873b8a9
PM
729////////////////////////////////////////////////////////////////////////
730//
731// Simple variant of RCU whose quiescent states are voluntary context
8af9e2c7 732// switch, cond_resched_tasks_rcu_qs(), user-space execution, and idle.
5873b8a9
PM
733// As such, grace periods can take one good long time. There are no
734// read-side primitives similar to rcu_read_lock() and rcu_read_unlock()
735// because this implementation is intended to get the system into a safe
736// state for some of the manipulations involved in tracing and the like.
737// Finally, this implementation does not support high call_rcu_tasks()
738// rates from multiple CPUs. If this is required, per-CPU callback lists
739// will be needed.
06a3ec92
PM
740//
741// The implementation uses rcu_tasks_wait_gp(), which relies on function
742// pointers in the rcu_tasks structure. The rcu_spawn_tasks_kthread()
743// function sets these function pointers up so that rcu_tasks_wait_gp()
744// invokes these functions in this order:
745//
746// rcu_tasks_pregp_step():
747// Invokes synchronize_rcu() in order to wait for all in-flight
748// t->on_rq and t->nvcsw transitions to complete. This works because
749// all such transitions are carried out with interrupts disabled.
750// rcu_tasks_pertask(), invoked on every non-idle task:
751// For every runnable non-idle task other than the current one, use
752// get_task_struct() to pin down that task, snapshot that task's
753// number of voluntary context switches, and add that task to the
754// holdout list.
755// rcu_tasks_postscan():
756// Invoke synchronize_srcu() to ensure that all tasks that were
757// in the process of exiting (and which thus might not know to
758// synchronize with this RCU Tasks grace period) have completed
759// exiting.
760// check_all_holdout_tasks(), repeatedly until holdout list is empty:
761// Scans the holdout list, attempting to identify a quiescent state
762// for each task on the list. If there is a quiescent state, the
763// corresponding task is removed from the holdout list.
764// rcu_tasks_postgp():
765// Invokes synchronize_rcu() in order to ensure that all prior
766// t->on_rq and t->nvcsw transitions are seen by all CPUs and tasks
767// to have happened before the end of this RCU Tasks grace period.
768// Again, this works because all such transitions are carried out
769// with interrupts disabled.
770//
771// For each exiting task, the exit_tasks_rcu_start() and
772// exit_tasks_rcu_finish() functions begin and end, respectively, the SRCU
773// read-side critical sections waited for by rcu_tasks_postscan().
774//
381a4f3b
PM
775// Pre-grace-period update-side code is ordered before the grace
776// via the raw_spin_lock.*rcu_node(). Pre-grace-period read-side code
777// is ordered before the grace period via synchronize_rcu() call in
778// rcu_tasks_pregp_step() and by the scheduler's locks and interrupt
06a3ec92 779// disabling.
5873b8a9 780
e4fe5dd6
PM
781/* Pre-grace-period preparation. */
782static void rcu_tasks_pregp_step(void)
783{
784 /*
785 * Wait for all pre-existing t->on_rq and t->nvcsw transitions
786 * to complete. Invoking synchronize_rcu() suffices because all
787 * these transitions occur with interrupts disabled. Without this
788 * synchronize_rcu(), a read-side critical section that started
789 * before the grace period might be incorrectly seen as having
790 * started after the grace period.
791 *
792 * This synchronize_rcu() also dispenses with the need for a
793 * memory barrier on the first store to t->rcu_tasks_holdout,
794 * as it forces the store to happen after the beginning of the
795 * grace period.
796 */
797 synchronize_rcu();
798}
799
800/* Per-task initial processing. */
801static void rcu_tasks_pertask(struct task_struct *t, struct list_head *hop)
802{
803 if (t != current && READ_ONCE(t->on_rq) && !is_idle_task(t)) {
804 get_task_struct(t);
805 t->rcu_tasks_nvcsw = READ_ONCE(t->nvcsw);
806 WRITE_ONCE(t->rcu_tasks_holdout, true);
807 list_add(&t->rcu_tasks_holdout_list, hop);
808 }
809}
810
811/* Processing between scanning taskslist and draining the holdout list. */
04a3c5aa 812static void rcu_tasks_postscan(struct list_head *hop)
e4fe5dd6
PM
813{
814 /*
815 * Wait for tasks that are in the process of exiting. This
816 * does only part of the job, ensuring that all tasks that were
817 * previously exiting reach the point where they have disabled
818 * preemption, allowing the later synchronize_rcu() to finish
819 * the job.
820 */
821 synchronize_srcu(&tasks_rcu_exit_srcu);
822}
823
5873b8a9
PM
824/* See if tasks are still holding out, complain if so. */
825static void check_holdout_task(struct task_struct *t,
826 bool needreport, bool *firstreport)
827{
828 int cpu;
829
830 if (!READ_ONCE(t->rcu_tasks_holdout) ||
831 t->rcu_tasks_nvcsw != READ_ONCE(t->nvcsw) ||
832 !READ_ONCE(t->on_rq) ||
833 (IS_ENABLED(CONFIG_NO_HZ_FULL) &&
834 !is_idle_task(t) && t->rcu_tasks_idle_cpu >= 0)) {
835 WRITE_ONCE(t->rcu_tasks_holdout, false);
836 list_del_init(&t->rcu_tasks_holdout_list);
837 put_task_struct(t);
838 return;
839 }
840 rcu_request_urgent_qs_task(t);
841 if (!needreport)
842 return;
843 if (*firstreport) {
844 pr_err("INFO: rcu_tasks detected stalls on tasks:\n");
845 *firstreport = false;
846 }
847 cpu = task_cpu(t);
848 pr_alert("%p: %c%c nvcsw: %lu/%lu holdout: %d idle_cpu: %d/%d\n",
849 t, ".I"[is_idle_task(t)],
850 "N."[cpu < 0 || !tick_nohz_full_cpu(cpu)],
851 t->rcu_tasks_nvcsw, t->nvcsw, t->rcu_tasks_holdout,
852 t->rcu_tasks_idle_cpu, cpu);
853 sched_show_task(t);
854}
855
e4fe5dd6
PM
856/* Scan the holdout lists for tasks no longer holding out. */
857static void check_all_holdout_tasks(struct list_head *hop,
858 bool needreport, bool *firstreport)
859{
860 struct task_struct *t, *t1;
861
862 list_for_each_entry_safe(t, t1, hop, rcu_tasks_holdout_list) {
863 check_holdout_task(t, needreport, firstreport);
864 cond_resched();
865 }
866}
867
868/* Finish off the Tasks-RCU grace period. */
af051ca4 869static void rcu_tasks_postgp(struct rcu_tasks *rtp)
e4fe5dd6
PM
870{
871 /*
872 * Because ->on_rq and ->nvcsw are not guaranteed to have a full
873 * memory barriers prior to them in the schedule() path, memory
874 * reordering on other CPUs could cause their RCU-tasks read-side
875 * critical sections to extend past the end of the grace period.
876 * However, because these ->nvcsw updates are carried out with
877 * interrupts disabled, we can use synchronize_rcu() to force the
878 * needed ordering on all such CPUs.
879 *
880 * This synchronize_rcu() also confines all ->rcu_tasks_holdout
881 * accesses to be within the grace period, avoiding the need for
882 * memory barriers for ->rcu_tasks_holdout accesses.
883 *
884 * In addition, this synchronize_rcu() waits for exiting tasks
885 * to complete their final preempt_disable() region of execution,
886 * cleaning up after the synchronize_srcu() above.
887 */
888 synchronize_rcu();
889}
890
5873b8a9 891void call_rcu_tasks(struct rcu_head *rhp, rcu_callback_t func);
c97d12a6 892DEFINE_RCU_TASKS(rcu_tasks, rcu_tasks_wait_gp, call_rcu_tasks, "RCU Tasks");
5873b8a9
PM
893
894/**
895 * call_rcu_tasks() - Queue an RCU for invocation task-based grace period
896 * @rhp: structure to be used for queueing the RCU updates.
897 * @func: actual callback function to be invoked after the grace period
898 *
899 * The callback function will be invoked some time after a full grace
900 * period elapses, in other words after all currently executing RCU
901 * read-side critical sections have completed. call_rcu_tasks() assumes
902 * that the read-side critical sections end at a voluntary context
8af9e2c7 903 * switch (not a preemption!), cond_resched_tasks_rcu_qs(), entry into idle,
5873b8a9
PM
904 * or transition to usermode execution. As such, there are no read-side
905 * primitives analogous to rcu_read_lock() and rcu_read_unlock() because
906 * this primitive is intended to determine that all tasks have passed
a616aec9 907 * through a safe state, not so much for data-structure synchronization.
5873b8a9
PM
908 *
909 * See the description of call_rcu() for more detailed information on
910 * memory ordering guarantees.
911 */
912void call_rcu_tasks(struct rcu_head *rhp, rcu_callback_t func)
913{
914 call_rcu_tasks_generic(rhp, func, &rcu_tasks);
915}
916EXPORT_SYMBOL_GPL(call_rcu_tasks);
917
918/**
919 * synchronize_rcu_tasks - wait until an rcu-tasks grace period has elapsed.
920 *
921 * Control will return to the caller some time after a full rcu-tasks
922 * grace period has elapsed, in other words after all currently
923 * executing rcu-tasks read-side critical sections have elapsed. These
924 * read-side critical sections are delimited by calls to schedule(),
925 * cond_resched_tasks_rcu_qs(), idle execution, userspace execution, calls
926 * to synchronize_rcu_tasks(), and (in theory, anyway) cond_resched().
927 *
928 * This is a very specialized primitive, intended only for a few uses in
929 * tracing and other situations requiring manipulation of function
930 * preambles and profiling hooks. The synchronize_rcu_tasks() function
931 * is not (yet) intended for heavy use from multiple CPUs.
932 *
933 * See the description of synchronize_rcu() for more detailed information
934 * on memory ordering guarantees.
935 */
936void synchronize_rcu_tasks(void)
937{
938 synchronize_rcu_tasks_generic(&rcu_tasks);
939}
940EXPORT_SYMBOL_GPL(synchronize_rcu_tasks);
941
942/**
943 * rcu_barrier_tasks - Wait for in-flight call_rcu_tasks() callbacks.
944 *
945 * Although the current implementation is guaranteed to wait, it is not
946 * obligated to, for example, if there are no pending callbacks.
947 */
948void rcu_barrier_tasks(void)
949{
ce9b1c66 950 rcu_barrier_tasks_generic(&rcu_tasks);
5873b8a9
PM
951}
952EXPORT_SYMBOL_GPL(rcu_barrier_tasks);
953
954static int __init rcu_spawn_tasks_kthread(void)
955{
cafafd67 956 cblist_init_generic(&rcu_tasks);
4fe192df 957 rcu_tasks.gp_sleep = HZ / 10;
75dc2da5 958 rcu_tasks.init_fract = HZ / 10;
e4fe5dd6
PM
959 rcu_tasks.pregp_func = rcu_tasks_pregp_step;
960 rcu_tasks.pertask_func = rcu_tasks_pertask;
961 rcu_tasks.postscan_func = rcu_tasks_postscan;
962 rcu_tasks.holdouts_func = check_all_holdout_tasks;
963 rcu_tasks.postgp_func = rcu_tasks_postgp;
5873b8a9
PM
964 rcu_spawn_tasks_kthread_generic(&rcu_tasks);
965 return 0;
966}
5873b8a9 967
27c0f144
PM
968#if !defined(CONFIG_TINY_RCU)
969void show_rcu_tasks_classic_gp_kthread(void)
e21408ce
PM
970{
971 show_rcu_tasks_generic_gp_kthread(&rcu_tasks, "");
972}
27c0f144
PM
973EXPORT_SYMBOL_GPL(show_rcu_tasks_classic_gp_kthread);
974#endif // !defined(CONFIG_TINY_RCU)
e21408ce 975
25246fc8
PM
976/* Do the srcu_read_lock() for the above synchronize_srcu(). */
977void exit_tasks_rcu_start(void) __acquires(&tasks_rcu_exit_srcu)
978{
979 preempt_disable();
980 current->rcu_tasks_idx = __srcu_read_lock(&tasks_rcu_exit_srcu);
981 preempt_enable();
982}
983
984/* Do the srcu_read_unlock() for the above synchronize_srcu(). */
985void exit_tasks_rcu_finish(void) __releases(&tasks_rcu_exit_srcu)
986{
987 struct task_struct *t = current;
988
989 preempt_disable();
990 __srcu_read_unlock(&tasks_rcu_exit_srcu, t->rcu_tasks_idx);
991 preempt_enable();
992 exit_tasks_rcu_finish_trace(t);
993}
994
e21408ce 995#else /* #ifdef CONFIG_TASKS_RCU */
25246fc8
PM
996void exit_tasks_rcu_start(void) { }
997void exit_tasks_rcu_finish(void) { exit_tasks_rcu_finish_trace(current); }
e21408ce 998#endif /* #else #ifdef CONFIG_TASKS_RCU */
c84aad76
PM
999
1000#ifdef CONFIG_TASKS_RUDE_RCU
1001
1002////////////////////////////////////////////////////////////////////////
1003//
1004// "Rude" variant of Tasks RCU, inspired by Steve Rostedt's trick of
1005// passing an empty function to schedule_on_each_cpu(). This approach
e4be1f44
PM
1006// provides an asynchronous call_rcu_tasks_rude() API and batching of
1007// concurrent calls to the synchronous synchronize_rcu_tasks_rude() API.
9fc98e31
PM
1008// This invokes schedule_on_each_cpu() in order to send IPIs far and wide
1009// and induces otherwise unnecessary context switches on all online CPUs,
1010// whether idle or not.
1011//
1012// Callback handling is provided by the rcu_tasks_kthread() function.
1013//
1014// Ordering is provided by the scheduler's context-switch code.
c84aad76
PM
1015
1016// Empty function to allow workqueues to force a context switch.
1017static void rcu_tasks_be_rude(struct work_struct *work)
1018{
1019}
1020
1021// Wait for one rude RCU-tasks grace period.
1022static void rcu_tasks_rude_wait_gp(struct rcu_tasks *rtp)
1023{
f75fd4b9
PS
1024 if (num_online_cpus() <= 1)
1025 return; // Fastpath for only one CPU.
1026
238dbce3 1027 rtp->n_ipis += cpumask_weight(cpu_online_mask);
c84aad76
PM
1028 schedule_on_each_cpu(rcu_tasks_be_rude);
1029}
1030
1031void call_rcu_tasks_rude(struct rcu_head *rhp, rcu_callback_t func);
c97d12a6
PM
1032DEFINE_RCU_TASKS(rcu_tasks_rude, rcu_tasks_rude_wait_gp, call_rcu_tasks_rude,
1033 "RCU Tasks Rude");
c84aad76
PM
1034
1035/**
1036 * call_rcu_tasks_rude() - Queue a callback rude task-based grace period
1037 * @rhp: structure to be used for queueing the RCU updates.
1038 * @func: actual callback function to be invoked after the grace period
1039 *
1040 * The callback function will be invoked some time after a full grace
1041 * period elapses, in other words after all currently executing RCU
1042 * read-side critical sections have completed. call_rcu_tasks_rude()
1043 * assumes that the read-side critical sections end at context switch,
8af9e2c7 1044 * cond_resched_tasks_rcu_qs(), or transition to usermode execution (as
a6517e9c
NU
1045 * usermode execution is schedulable). As such, there are no read-side
1046 * primitives analogous to rcu_read_lock() and rcu_read_unlock() because
1047 * this primitive is intended to determine that all tasks have passed
1048 * through a safe state, not so much for data-structure synchronization.
c84aad76
PM
1049 *
1050 * See the description of call_rcu() for more detailed information on
1051 * memory ordering guarantees.
1052 */
1053void call_rcu_tasks_rude(struct rcu_head *rhp, rcu_callback_t func)
1054{
1055 call_rcu_tasks_generic(rhp, func, &rcu_tasks_rude);
1056}
1057EXPORT_SYMBOL_GPL(call_rcu_tasks_rude);
1058
1059/**
1060 * synchronize_rcu_tasks_rude - wait for a rude rcu-tasks grace period
1061 *
1062 * Control will return to the caller some time after a rude rcu-tasks
1063 * grace period has elapsed, in other words after all currently
1064 * executing rcu-tasks read-side critical sections have elapsed. These
1065 * read-side critical sections are delimited by calls to schedule(),
a6517e9c
NU
1066 * cond_resched_tasks_rcu_qs(), userspace execution (which is a schedulable
1067 * context), and (in theory, anyway) cond_resched().
c84aad76
PM
1068 *
1069 * This is a very specialized primitive, intended only for a few uses in
1070 * tracing and other situations requiring manipulation of function preambles
1071 * and profiling hooks. The synchronize_rcu_tasks_rude() function is not
1072 * (yet) intended for heavy use from multiple CPUs.
1073 *
1074 * See the description of synchronize_rcu() for more detailed information
1075 * on memory ordering guarantees.
1076 */
1077void synchronize_rcu_tasks_rude(void)
1078{
1079 synchronize_rcu_tasks_generic(&rcu_tasks_rude);
1080}
1081EXPORT_SYMBOL_GPL(synchronize_rcu_tasks_rude);
1082
1083/**
1084 * rcu_barrier_tasks_rude - Wait for in-flight call_rcu_tasks_rude() callbacks.
1085 *
1086 * Although the current implementation is guaranteed to wait, it is not
1087 * obligated to, for example, if there are no pending callbacks.
1088 */
1089void rcu_barrier_tasks_rude(void)
1090{
ce9b1c66 1091 rcu_barrier_tasks_generic(&rcu_tasks_rude);
c84aad76
PM
1092}
1093EXPORT_SYMBOL_GPL(rcu_barrier_tasks_rude);
1094
1095static int __init rcu_spawn_tasks_rude_kthread(void)
1096{
cafafd67 1097 cblist_init_generic(&rcu_tasks_rude);
4fe192df 1098 rcu_tasks_rude.gp_sleep = HZ / 10;
c84aad76
PM
1099 rcu_spawn_tasks_kthread_generic(&rcu_tasks_rude);
1100 return 0;
1101}
c84aad76 1102
27c0f144
PM
1103#if !defined(CONFIG_TINY_RCU)
1104void show_rcu_tasks_rude_gp_kthread(void)
e21408ce
PM
1105{
1106 show_rcu_tasks_generic_gp_kthread(&rcu_tasks_rude, "");
1107}
27c0f144
PM
1108EXPORT_SYMBOL_GPL(show_rcu_tasks_rude_gp_kthread);
1109#endif // !defined(CONFIG_TINY_RCU)
1110#endif /* #ifdef CONFIG_TASKS_RUDE_RCU */
d5f177d3
PM
1111
1112////////////////////////////////////////////////////////////////////////
1113//
1114// Tracing variant of Tasks RCU. This variant is designed to be used
1115// to protect tracing hooks, including those of BPF. This variant
1116// therefore:
1117//
1118// 1. Has explicit read-side markers to allow finite grace periods
1119// in the face of in-kernel loops for PREEMPT=n builds.
1120//
1121// 2. Protects code in the idle loop, exception entry/exit, and
1122// CPU-hotplug code paths, similar to the capabilities of SRCU.
1123//
c4f113ac 1124// 3. Avoids expensive read-side instructions, having overhead similar
d5f177d3
PM
1125// to that of Preemptible RCU.
1126//
1127// There are of course downsides. The grace-period code can send IPIs to
1128// CPUs, even when those CPUs are in the idle loop or in nohz_full userspace.
1129// It is necessary to scan the full tasklist, much as for Tasks RCU. There
1130// is a single callback queue guarded by a single lock, again, much as for
1131// Tasks RCU. If needed, these downsides can be at least partially remedied.
1132//
1133// Perhaps most important, this variant of RCU does not affect the vanilla
1134// flavors, rcu_preempt and rcu_sched. The fact that RCU Tasks Trace
1135// readers can operate from idle, offline, and exception entry/exit in no
1136// way allows rcu_preempt and rcu_sched readers to also do so.
a434dd10
PM
1137//
1138// The implementation uses rcu_tasks_wait_gp(), which relies on function
1139// pointers in the rcu_tasks structure. The rcu_spawn_tasks_trace_kthread()
1140// function sets these function pointers up so that rcu_tasks_wait_gp()
1141// invokes these functions in this order:
1142//
1143// rcu_tasks_trace_pregp_step():
1144// Initialize the count of readers and block CPU-hotplug operations.
1145// rcu_tasks_trace_pertask(), invoked on every non-idle task:
1146// Initialize per-task state and attempt to identify an immediate
1147// quiescent state for that task, or, failing that, attempt to
1148// set that task's .need_qs flag so that task's next outermost
1149// rcu_read_unlock_trace() will report the quiescent state (in which
1150// case the count of readers is incremented). If both attempts fail,
45f4b4a2
PM
1151// the task is added to a "holdout" list. Note that IPIs are used
1152// to invoke trc_read_check_handler() in the context of running tasks
1153// in order to avoid ordering overhead on common-case shared-variable
1154// accessses.
a434dd10
PM
1155// rcu_tasks_trace_postscan():
1156// Initialize state and attempt to identify an immediate quiescent
1157// state as above (but only for idle tasks), unblock CPU-hotplug
1158// operations, and wait for an RCU grace period to avoid races with
1159// tasks that are in the process of exiting.
1160// check_all_holdout_tasks_trace(), repeatedly until holdout list is empty:
1161// Scans the holdout list, attempting to identify a quiescent state
1162// for each task on the list. If there is a quiescent state, the
1163// corresponding task is removed from the holdout list.
1164// rcu_tasks_trace_postgp():
1165// Wait for the count of readers do drop to zero, reporting any stalls.
1166// Also execute full memory barriers to maintain ordering with code
1167// executing after the grace period.
1168//
1169// The exit_tasks_rcu_finish_trace() synchronizes with exiting tasks.
1170//
1171// Pre-grace-period update-side code is ordered before the grace
1172// period via the ->cbs_lock and barriers in rcu_tasks_kthread().
1173// Pre-grace-period read-side code is ordered before the grace period by
1174// atomic_dec_and_test() of the count of readers (for IPIed readers) and by
1175// scheduler context-switch ordering (for locked-down non-running readers).
d5f177d3
PM
1176
1177// The lockdep state must be outside of #ifdef to be useful.
1178#ifdef CONFIG_DEBUG_LOCK_ALLOC
1179static struct lock_class_key rcu_lock_trace_key;
1180struct lockdep_map rcu_trace_lock_map =
1181 STATIC_LOCKDEP_MAP_INIT("rcu_read_lock_trace", &rcu_lock_trace_key);
1182EXPORT_SYMBOL_GPL(rcu_trace_lock_map);
1183#endif /* #ifdef CONFIG_DEBUG_LOCK_ALLOC */
1184
1185#ifdef CONFIG_TASKS_TRACE_RCU
1186
30d8aa51
PM
1187static atomic_t trc_n_readers_need_end; // Number of waited-for readers.
1188static DECLARE_WAIT_QUEUE_HEAD(trc_wait); // List of holdout tasks.
d5f177d3
PM
1189
1190// Record outstanding IPIs to each CPU. No point in sending two...
1191static DEFINE_PER_CPU(bool, trc_ipi_to_cpu);
1192
40471509
PM
1193// The number of detections of task quiescent state relying on
1194// heavyweight readers executing explicit memory barriers.
6731da9e
PM
1195static unsigned long n_heavy_reader_attempts;
1196static unsigned long n_heavy_reader_updates;
1197static unsigned long n_heavy_reader_ofl_updates;
40471509 1198
b0afa0f0
PM
1199void call_rcu_tasks_trace(struct rcu_head *rhp, rcu_callback_t func);
1200DEFINE_RCU_TASKS(rcu_tasks_trace, rcu_tasks_wait_gp, call_rcu_tasks_trace,
1201 "RCU Tasks Trace");
1202
b38f57c1
PM
1203/*
1204 * This irq_work handler allows rcu_read_unlock_trace() to be invoked
1205 * while the scheduler locks are held.
1206 */
1207static void rcu_read_unlock_iw(struct irq_work *iwp)
1208{
1209 wake_up(&trc_wait);
1210}
1211static DEFINE_IRQ_WORK(rcu_tasks_trace_iw, rcu_read_unlock_iw);
1212
d5f177d3 1213/* If we are the last reader, wake up the grace-period kthread. */
a5c071cc 1214void rcu_read_unlock_trace_special(struct task_struct *t)
d5f177d3 1215{
f8ab3fad 1216 int nq = READ_ONCE(t->trc_reader_special.b.need_qs);
276c4104 1217
9ae58d7b
PM
1218 if (IS_ENABLED(CONFIG_TASKS_TRACE_RCU_READ_MB) &&
1219 t->trc_reader_special.b.need_mb)
276c4104
PM
1220 smp_mb(); // Pairs with update-side barriers.
1221 // Update .need_qs before ->trc_reader_nesting for irq/NMI handlers.
1222 if (nq)
1223 WRITE_ONCE(t->trc_reader_special.b.need_qs, false);
a5c071cc 1224 WRITE_ONCE(t->trc_reader_nesting, 0);
276c4104 1225 if (nq && atomic_dec_and_test(&trc_n_readers_need_end))
b38f57c1 1226 irq_work_queue(&rcu_tasks_trace_iw);
d5f177d3
PM
1227}
1228EXPORT_SYMBOL_GPL(rcu_read_unlock_trace_special);
1229
1230/* Add a task to the holdout list, if it is not already on the list. */
1231static void trc_add_holdout(struct task_struct *t, struct list_head *bhp)
1232{
1233 if (list_empty(&t->trc_holdout_list)) {
1234 get_task_struct(t);
1235 list_add(&t->trc_holdout_list, bhp);
1236 }
1237}
1238
1239/* Remove a task from the holdout list, if it is in fact present. */
1240static void trc_del_holdout(struct task_struct *t)
1241{
1242 if (!list_empty(&t->trc_holdout_list)) {
1243 list_del_init(&t->trc_holdout_list);
1244 put_task_struct(t);
1245 }
1246}
1247
1248/* IPI handler to check task state. */
1249static void trc_read_check_handler(void *t_in)
1250{
1251 struct task_struct *t = current;
1252 struct task_struct *texp = t_in;
1253
1254 // If the task is no longer running on this CPU, leave.
1255 if (unlikely(texp != t)) {
d5f177d3
PM
1256 goto reset_ipi; // Already on holdout list, so will check later.
1257 }
1258
1259 // If the task is not in a read-side critical section, and
1260 // if this is the last reader, awaken the grace-period kthread.
bdb0cca0 1261 if (likely(!READ_ONCE(t->trc_reader_nesting))) {
d5f177d3
PM
1262 WRITE_ONCE(t->trc_reader_checked, true);
1263 goto reset_ipi;
1264 }
ba3a86e4 1265 // If we are racing with an rcu_read_unlock_trace(), try again later.
96017bf9 1266 if (unlikely(READ_ONCE(t->trc_reader_nesting) < 0))
ba3a86e4 1267 goto reset_ipi;
d5f177d3
PM
1268 WRITE_ONCE(t->trc_reader_checked, true);
1269
1270 // Get here if the task is in a read-side critical section. Set
1271 // its state so that it will awaken the grace-period kthread upon
1272 // exit from that critical section.
96017bf9 1273 atomic_inc(&trc_n_readers_need_end); // One more to wait on.
f8ab3fad 1274 WARN_ON_ONCE(READ_ONCE(t->trc_reader_special.b.need_qs));
276c4104 1275 WRITE_ONCE(t->trc_reader_special.b.need_qs, true);
d5f177d3
PM
1276
1277reset_ipi:
1278 // Allow future IPIs to be sent on CPU and for task.
1279 // Also order this IPI handler against any later manipulations of
1280 // the intended task.
8211e922 1281 smp_store_release(per_cpu_ptr(&trc_ipi_to_cpu, smp_processor_id()), false); // ^^^
d5f177d3
PM
1282 smp_store_release(&texp->trc_ipi_to_cpu, -1); // ^^^
1283}
1284
1285/* Callback function for scheduler to check locked-down task. */
9b3c4ab3 1286static int trc_inspect_reader(struct task_struct *t, void *arg)
d5f177d3 1287{
7d0c9c50 1288 int cpu = task_cpu(t);
18f08e75 1289 int nesting;
7e3b70e0 1290 bool ofl = cpu_is_offline(cpu);
7d0c9c50
PM
1291
1292 if (task_curr(t)) {
30d8aa51 1293 WARN_ON_ONCE(ofl && !is_idle_task(t));
7e3b70e0 1294
7d0c9c50 1295 // If no chance of heavyweight readers, do it the hard way.
7e3b70e0 1296 if (!ofl && !IS_ENABLED(CONFIG_TASKS_TRACE_RCU_READ_MB))
9b3c4ab3 1297 return -EINVAL;
7d0c9c50
PM
1298
1299 // If heavyweight readers are enabled on the remote task,
1300 // we can inspect its state despite its currently running.
1301 // However, we cannot safely change its state.
40471509 1302 n_heavy_reader_attempts++;
7e3b70e0
PM
1303 if (!ofl && // Check for "running" idle tasks on offline CPUs.
1304 !rcu_dynticks_zero_in_eqs(cpu, &t->trc_reader_nesting))
9b3c4ab3 1305 return -EINVAL; // No quiescent state, do it the hard way.
40471509 1306 n_heavy_reader_updates++;
edf3775f
PM
1307 if (ofl)
1308 n_heavy_reader_ofl_updates++;
18f08e75 1309 nesting = 0;
7d0c9c50 1310 } else {
bdb0cca0 1311 // The task is not running, so C-language access is safe.
18f08e75 1312 nesting = t->trc_reader_nesting;
7d0c9c50 1313 }
d5f177d3 1314
18f08e75
PM
1315 // If not exiting a read-side critical section, mark as checked
1316 // so that the grace-period kthread will remove it from the
1317 // holdout list.
1318 t->trc_reader_checked = nesting >= 0;
1319 if (nesting <= 0)
6fedc280 1320 return nesting ? -EINVAL : 0; // If in QS, done, otherwise try again later.
7d0c9c50
PM
1321
1322 // The task is in a read-side critical section, so set up its
1323 // state so that it will awaken the grace-period kthread upon exit
1324 // from that critical section.
1325 atomic_inc(&trc_n_readers_need_end); // One more to wait on.
f8ab3fad 1326 WARN_ON_ONCE(READ_ONCE(t->trc_reader_special.b.need_qs));
7d0c9c50 1327 WRITE_ONCE(t->trc_reader_special.b.need_qs, true);
9b3c4ab3 1328 return 0;
d5f177d3
PM
1329}
1330
1331/* Attempt to extract the state for the specified task. */
1332static void trc_wait_for_one_reader(struct task_struct *t,
1333 struct list_head *bhp)
1334{
1335 int cpu;
1336
1337 // If a previous IPI is still in flight, let it complete.
1338 if (smp_load_acquire(&t->trc_ipi_to_cpu) != -1) // Order IPI
1339 return;
1340
1341 // The current task had better be in a quiescent state.
1342 if (t == current) {
1343 t->trc_reader_checked = true;
bdb0cca0 1344 WARN_ON_ONCE(READ_ONCE(t->trc_reader_nesting));
d5f177d3
PM
1345 return;
1346 }
1347
1348 // Attempt to nail down the task for inspection.
1349 get_task_struct(t);
9b3c4ab3 1350 if (!task_call_func(t, trc_inspect_reader, NULL)) {
d5f177d3
PM
1351 put_task_struct(t);
1352 return;
1353 }
1354 put_task_struct(t);
1355
45f4b4a2
PM
1356 // If this task is not yet on the holdout list, then we are in
1357 // an RCU read-side critical section. Otherwise, the invocation of
d0a85858 1358 // trc_add_holdout() that added it to the list did the necessary
45f4b4a2
PM
1359 // get_task_struct(). Either way, the task cannot be freed out
1360 // from under this code.
1361
d5f177d3
PM
1362 // If currently running, send an IPI, either way, add to list.
1363 trc_add_holdout(t, bhp);
574de876
PM
1364 if (task_curr(t) &&
1365 time_after(jiffies + 1, rcu_tasks_trace.gp_start + rcu_task_ipi_delay)) {
d5f177d3
PM
1366 // The task is currently running, so try IPIing it.
1367 cpu = task_cpu(t);
1368
1369 // If there is already an IPI outstanding, let it happen.
1370 if (per_cpu(trc_ipi_to_cpu, cpu) || t->trc_ipi_to_cpu >= 0)
1371 return;
1372
d5f177d3
PM
1373 per_cpu(trc_ipi_to_cpu, cpu) = true;
1374 t->trc_ipi_to_cpu = cpu;
238dbce3 1375 rcu_tasks_trace.n_ipis++;
96017bf9 1376 if (smp_call_function_single(cpu, trc_read_check_handler, t, 0)) {
d5f177d3
PM
1377 // Just in case there is some other reason for
1378 // failure than the target CPU being offline.
46aa886c
NU
1379 WARN_ONCE(1, "%s(): smp_call_function_single() failed for CPU: %d\n",
1380 __func__, cpu);
7e0669c3 1381 rcu_tasks_trace.n_ipis_fails++;
d5f177d3 1382 per_cpu(trc_ipi_to_cpu, cpu) = false;
46aa886c 1383 t->trc_ipi_to_cpu = -1;
d5f177d3
PM
1384 }
1385 }
1386}
1387
1388/* Initialize for a new RCU-tasks-trace grace period. */
1389static void rcu_tasks_trace_pregp_step(void)
1390{
1391 int cpu;
1392
d5f177d3
PM
1393 // Allow for fast-acting IPIs.
1394 atomic_set(&trc_n_readers_need_end, 1);
1395
1396 // There shouldn't be any old IPIs, but...
1397 for_each_possible_cpu(cpu)
1398 WARN_ON_ONCE(per_cpu(trc_ipi_to_cpu, cpu));
81b4a7bc
PM
1399
1400 // Disable CPU hotplug across the tasklist scan.
1401 // This also waits for all readers in CPU-hotplug code paths.
1402 cpus_read_lock();
d5f177d3
PM
1403}
1404
1405/* Do first-round processing for the specified task. */
1406static void rcu_tasks_trace_pertask(struct task_struct *t,
1407 struct list_head *hop)
1408{
1b04fa99
URS
1409 // During early boot when there is only the one boot CPU, there
1410 // is no idle task for the other CPUs. Just return.
1411 if (unlikely(t == NULL))
1412 return;
1413
276c4104 1414 WRITE_ONCE(t->trc_reader_special.b.need_qs, false);
43766c3e 1415 WRITE_ONCE(t->trc_reader_checked, false);
d5f177d3
PM
1416 t->trc_ipi_to_cpu = -1;
1417 trc_wait_for_one_reader(t, hop);
1418}
1419
9796e1ae
PM
1420/*
1421 * Do intermediate processing between task and holdout scans and
1422 * pick up the idle tasks.
1423 */
1424static void rcu_tasks_trace_postscan(struct list_head *hop)
d5f177d3 1425{
9796e1ae
PM
1426 int cpu;
1427
1428 for_each_possible_cpu(cpu)
1429 rcu_tasks_trace_pertask(idle_task(cpu), hop);
1430
81b4a7bc
PM
1431 // Re-enable CPU hotplug now that the tasklist scan has completed.
1432 cpus_read_unlock();
1433
d5f177d3
PM
1434 // Wait for late-stage exiting tasks to finish exiting.
1435 // These might have passed the call to exit_tasks_rcu_finish().
1436 synchronize_rcu();
1437 // Any tasks that exit after this point will set ->trc_reader_checked.
1438}
1439
65b629e7
NU
1440/* Communicate task state back to the RCU tasks trace stall warning request. */
1441struct trc_stall_chk_rdr {
1442 int nesting;
1443 int ipi_to_cpu;
1444 u8 needqs;
1445};
1446
1447static int trc_check_slow_task(struct task_struct *t, void *arg)
1448{
1449 struct trc_stall_chk_rdr *trc_rdrp = arg;
1450
1451 if (task_curr(t))
1452 return false; // It is running, so decline to inspect it.
1453 trc_rdrp->nesting = READ_ONCE(t->trc_reader_nesting);
1454 trc_rdrp->ipi_to_cpu = READ_ONCE(t->trc_ipi_to_cpu);
1455 trc_rdrp->needqs = READ_ONCE(t->trc_reader_special.b.need_qs);
1456 return true;
1457}
1458
4593e772
PM
1459/* Show the state of a task stalling the current RCU tasks trace GP. */
1460static void show_stalled_task_trace(struct task_struct *t, bool *firstreport)
1461{
1462 int cpu;
65b629e7
NU
1463 struct trc_stall_chk_rdr trc_rdr;
1464 bool is_idle_tsk = is_idle_task(t);
4593e772
PM
1465
1466 if (*firstreport) {
1467 pr_err("INFO: rcu_tasks_trace detected stalls on tasks:\n");
1468 *firstreport = false;
1469 }
4593e772 1470 cpu = task_cpu(t);
65b629e7
NU
1471 if (!task_call_func(t, trc_check_slow_task, &trc_rdr))
1472 pr_alert("P%d: %c\n",
1473 t->pid,
1474 ".i"[is_idle_tsk]);
1475 else
1476 pr_alert("P%d: %c%c%c nesting: %d%c cpu: %d\n",
1477 t->pid,
1478 ".I"[trc_rdr.ipi_to_cpu >= 0],
1479 ".i"[is_idle_tsk],
1480 ".N"[cpu >= 0 && tick_nohz_full_cpu(cpu)],
1481 trc_rdr.nesting,
1482 " N"[!!trc_rdr.needqs],
1483 cpu);
4593e772
PM
1484 sched_show_task(t);
1485}
1486
1487/* List stalled IPIs for RCU tasks trace. */
1488static void show_stalled_ipi_trace(void)
1489{
1490 int cpu;
1491
1492 for_each_possible_cpu(cpu)
1493 if (per_cpu(trc_ipi_to_cpu, cpu))
1494 pr_alert("\tIPI outstanding to CPU %d\n", cpu);
1495}
1496
d5f177d3
PM
1497/* Do one scan of the holdout list. */
1498static void check_all_holdout_tasks_trace(struct list_head *hop,
4593e772 1499 bool needreport, bool *firstreport)
d5f177d3
PM
1500{
1501 struct task_struct *g, *t;
1502
81b4a7bc
PM
1503 // Disable CPU hotplug across the holdout list scan.
1504 cpus_read_lock();
1505
d5f177d3
PM
1506 list_for_each_entry_safe(t, g, hop, trc_holdout_list) {
1507 // If safe and needed, try to check the current task.
1508 if (READ_ONCE(t->trc_ipi_to_cpu) == -1 &&
1509 !READ_ONCE(t->trc_reader_checked))
1510 trc_wait_for_one_reader(t, hop);
1511
1512 // If check succeeded, remove this task from the list.
f5dbc594
PM
1513 if (smp_load_acquire(&t->trc_ipi_to_cpu) == -1 &&
1514 READ_ONCE(t->trc_reader_checked))
d5f177d3 1515 trc_del_holdout(t);
4593e772
PM
1516 else if (needreport)
1517 show_stalled_task_trace(t, firstreport);
1518 }
81b4a7bc
PM
1519
1520 // Re-enable CPU hotplug now that the holdout list scan has completed.
1521 cpus_read_unlock();
1522
4593e772 1523 if (needreport) {
89401176 1524 if (*firstreport)
4593e772
PM
1525 pr_err("INFO: rcu_tasks_trace detected stalls? (Late IPI?)\n");
1526 show_stalled_ipi_trace();
d5f177d3
PM
1527 }
1528}
1529
cbe0d8d9
PM
1530static void rcu_tasks_trace_empty_fn(void *unused)
1531{
1532}
1533
d5f177d3 1534/* Wait for grace period to complete and provide ordering. */
af051ca4 1535static void rcu_tasks_trace_postgp(struct rcu_tasks *rtp)
d5f177d3 1536{
cbe0d8d9 1537 int cpu;
4593e772
PM
1538 bool firstreport;
1539 struct task_struct *g, *t;
1540 LIST_HEAD(holdouts);
1541 long ret;
1542
cbe0d8d9
PM
1543 // Wait for any lingering IPI handlers to complete. Note that
1544 // if a CPU has gone offline or transitioned to userspace in the
1545 // meantime, all IPI handlers should have been drained beforehand.
1546 // Yes, this assumes that CPUs process IPIs in order. If that ever
1547 // changes, there will need to be a recheck and/or timed wait.
1548 for_each_online_cpu(cpu)
f5dbc594 1549 if (WARN_ON_ONCE(smp_load_acquire(per_cpu_ptr(&trc_ipi_to_cpu, cpu))))
cbe0d8d9
PM
1550 smp_call_function_single(cpu, rcu_tasks_trace_empty_fn, NULL, 1);
1551
d5f177d3
PM
1552 // Remove the safety count.
1553 smp_mb__before_atomic(); // Order vs. earlier atomics
1554 atomic_dec(&trc_n_readers_need_end);
1555 smp_mb__after_atomic(); // Order vs. later atomics
1556
1557 // Wait for readers.
af051ca4 1558 set_tasks_gp_state(rtp, RTGS_WAIT_READERS);
4593e772
PM
1559 for (;;) {
1560 ret = wait_event_idle_exclusive_timeout(
1561 trc_wait,
1562 atomic_read(&trc_n_readers_need_end) == 0,
1563 READ_ONCE(rcu_task_stall_timeout));
1564 if (ret)
1565 break; // Count reached zero.
af051ca4 1566 // Stall warning time, so make a list of the offenders.
f747c7e1 1567 rcu_read_lock();
4593e772 1568 for_each_process_thread(g, t)
276c4104 1569 if (READ_ONCE(t->trc_reader_special.b.need_qs))
4593e772 1570 trc_add_holdout(t, &holdouts);
f747c7e1 1571 rcu_read_unlock();
4593e772 1572 firstreport = true;
592031cc
PM
1573 list_for_each_entry_safe(t, g, &holdouts, trc_holdout_list) {
1574 if (READ_ONCE(t->trc_reader_special.b.need_qs))
4593e772 1575 show_stalled_task_trace(t, &firstreport);
592031cc
PM
1576 trc_del_holdout(t); // Release task_struct reference.
1577 }
4593e772
PM
1578 if (firstreport)
1579 pr_err("INFO: rcu_tasks_trace detected stalls? (Counter/taskslist mismatch?)\n");
1580 show_stalled_ipi_trace();
1581 pr_err("\t%d holdouts\n", atomic_read(&trc_n_readers_need_end));
1582 }
d5f177d3 1583 smp_mb(); // Caller's code must be ordered after wakeup.
43766c3e 1584 // Pairs with pretty much every ordering primitive.
d5f177d3
PM
1585}
1586
1587/* Report any needed quiescent state for this exiting task. */
25246fc8 1588static void exit_tasks_rcu_finish_trace(struct task_struct *t)
d5f177d3
PM
1589{
1590 WRITE_ONCE(t->trc_reader_checked, true);
bdb0cca0 1591 WARN_ON_ONCE(READ_ONCE(t->trc_reader_nesting));
d5f177d3 1592 WRITE_ONCE(t->trc_reader_nesting, 0);
276c4104 1593 if (WARN_ON_ONCE(READ_ONCE(t->trc_reader_special.b.need_qs)))
a5c071cc 1594 rcu_read_unlock_trace_special(t);
d5f177d3
PM
1595}
1596
d5f177d3
PM
1597/**
1598 * call_rcu_tasks_trace() - Queue a callback trace task-based grace period
1599 * @rhp: structure to be used for queueing the RCU updates.
1600 * @func: actual callback function to be invoked after the grace period
1601 *
ed42c380
NU
1602 * The callback function will be invoked some time after a trace rcu-tasks
1603 * grace period elapses, in other words after all currently executing
1604 * trace rcu-tasks read-side critical sections have completed. These
1605 * read-side critical sections are delimited by calls to rcu_read_lock_trace()
1606 * and rcu_read_unlock_trace().
d5f177d3
PM
1607 *
1608 * See the description of call_rcu() for more detailed information on
1609 * memory ordering guarantees.
1610 */
1611void call_rcu_tasks_trace(struct rcu_head *rhp, rcu_callback_t func)
1612{
1613 call_rcu_tasks_generic(rhp, func, &rcu_tasks_trace);
1614}
1615EXPORT_SYMBOL_GPL(call_rcu_tasks_trace);
1616
1617/**
1618 * synchronize_rcu_tasks_trace - wait for a trace rcu-tasks grace period
1619 *
1620 * Control will return to the caller some time after a trace rcu-tasks
c7dcf810 1621 * grace period has elapsed, in other words after all currently executing
ed42c380 1622 * trace rcu-tasks read-side critical sections have elapsed. These read-side
c7dcf810
PM
1623 * critical sections are delimited by calls to rcu_read_lock_trace()
1624 * and rcu_read_unlock_trace().
d5f177d3
PM
1625 *
1626 * This is a very specialized primitive, intended only for a few uses in
1627 * tracing and other situations requiring manipulation of function preambles
1628 * and profiling hooks. The synchronize_rcu_tasks_trace() function is not
1629 * (yet) intended for heavy use from multiple CPUs.
1630 *
1631 * See the description of synchronize_rcu() for more detailed information
1632 * on memory ordering guarantees.
1633 */
1634void synchronize_rcu_tasks_trace(void)
1635{
1636 RCU_LOCKDEP_WARN(lock_is_held(&rcu_trace_lock_map), "Illegal synchronize_rcu_tasks_trace() in RCU Tasks Trace read-side critical section");
1637 synchronize_rcu_tasks_generic(&rcu_tasks_trace);
1638}
1639EXPORT_SYMBOL_GPL(synchronize_rcu_tasks_trace);
1640
1641/**
1642 * rcu_barrier_tasks_trace - Wait for in-flight call_rcu_tasks_trace() callbacks.
1643 *
1644 * Although the current implementation is guaranteed to wait, it is not
1645 * obligated to, for example, if there are no pending callbacks.
1646 */
1647void rcu_barrier_tasks_trace(void)
1648{
ce9b1c66 1649 rcu_barrier_tasks_generic(&rcu_tasks_trace);
d5f177d3
PM
1650}
1651EXPORT_SYMBOL_GPL(rcu_barrier_tasks_trace);
1652
1653static int __init rcu_spawn_tasks_trace_kthread(void)
1654{
cafafd67 1655 cblist_init_generic(&rcu_tasks_trace);
2393a613 1656 if (IS_ENABLED(CONFIG_TASKS_TRACE_RCU_READ_MB)) {
4fe192df 1657 rcu_tasks_trace.gp_sleep = HZ / 10;
75dc2da5 1658 rcu_tasks_trace.init_fract = HZ / 10;
2393a613 1659 } else {
4fe192df
PM
1660 rcu_tasks_trace.gp_sleep = HZ / 200;
1661 if (rcu_tasks_trace.gp_sleep <= 0)
1662 rcu_tasks_trace.gp_sleep = 1;
75dc2da5 1663 rcu_tasks_trace.init_fract = HZ / 200;
2393a613
PM
1664 if (rcu_tasks_trace.init_fract <= 0)
1665 rcu_tasks_trace.init_fract = 1;
1666 }
d5f177d3
PM
1667 rcu_tasks_trace.pregp_func = rcu_tasks_trace_pregp_step;
1668 rcu_tasks_trace.pertask_func = rcu_tasks_trace_pertask;
1669 rcu_tasks_trace.postscan_func = rcu_tasks_trace_postscan;
1670 rcu_tasks_trace.holdouts_func = check_all_holdout_tasks_trace;
1671 rcu_tasks_trace.postgp_func = rcu_tasks_trace_postgp;
1672 rcu_spawn_tasks_kthread_generic(&rcu_tasks_trace);
1673 return 0;
1674}
d5f177d3 1675
27c0f144
PM
1676#if !defined(CONFIG_TINY_RCU)
1677void show_rcu_tasks_trace_gp_kthread(void)
e21408ce 1678{
40471509 1679 char buf[64];
e21408ce 1680
edf3775f
PM
1681 sprintf(buf, "N%d h:%lu/%lu/%lu", atomic_read(&trc_n_readers_need_end),
1682 data_race(n_heavy_reader_ofl_updates),
40471509
PM
1683 data_race(n_heavy_reader_updates),
1684 data_race(n_heavy_reader_attempts));
e21408ce
PM
1685 show_rcu_tasks_generic_gp_kthread(&rcu_tasks_trace, buf);
1686}
27c0f144
PM
1687EXPORT_SYMBOL_GPL(show_rcu_tasks_trace_gp_kthread);
1688#endif // !defined(CONFIG_TINY_RCU)
e21408ce 1689
d5f177d3 1690#else /* #ifdef CONFIG_TASKS_TRACE_RCU */
25246fc8 1691static void exit_tasks_rcu_finish_trace(struct task_struct *t) { }
d5f177d3 1692#endif /* #else #ifdef CONFIG_TASKS_TRACE_RCU */
8fd8ca38 1693
8344496e 1694#ifndef CONFIG_TINY_RCU
e21408ce
PM
1695void show_rcu_tasks_gp_kthreads(void)
1696{
1697 show_rcu_tasks_classic_gp_kthread();
1698 show_rcu_tasks_rude_gp_kthread();
1699 show_rcu_tasks_trace_gp_kthread();
1700}
8344496e 1701#endif /* #ifndef CONFIG_TINY_RCU */
e21408ce 1702
bfba7ed0
URS
1703#ifdef CONFIG_PROVE_RCU
1704struct rcu_tasks_test_desc {
1705 struct rcu_head rh;
1706 const char *name;
1707 bool notrun;
1708};
1709
1710static struct rcu_tasks_test_desc tests[] = {
1711 {
1712 .name = "call_rcu_tasks()",
1713 /* If not defined, the test is skipped. */
1714 .notrun = !IS_ENABLED(CONFIG_TASKS_RCU),
1715 },
1716 {
1717 .name = "call_rcu_tasks_rude()",
1718 /* If not defined, the test is skipped. */
1719 .notrun = !IS_ENABLED(CONFIG_TASKS_RUDE_RCU),
1720 },
1721 {
1722 .name = "call_rcu_tasks_trace()",
1723 /* If not defined, the test is skipped. */
1724 .notrun = !IS_ENABLED(CONFIG_TASKS_TRACE_RCU)
1725 }
1726};
1727
1728static void test_rcu_tasks_callback(struct rcu_head *rhp)
1729{
1730 struct rcu_tasks_test_desc *rttd =
1731 container_of(rhp, struct rcu_tasks_test_desc, rh);
1732
1733 pr_info("Callback from %s invoked.\n", rttd->name);
1734
1735 rttd->notrun = true;
1736}
1737
1738static void rcu_tasks_initiate_self_tests(void)
1739{
1740 pr_info("Running RCU-tasks wait API self tests\n");
1741#ifdef CONFIG_TASKS_RCU
1742 synchronize_rcu_tasks();
1743 call_rcu_tasks(&tests[0].rh, test_rcu_tasks_callback);
1744#endif
1745
1746#ifdef CONFIG_TASKS_RUDE_RCU
1747 synchronize_rcu_tasks_rude();
1748 call_rcu_tasks_rude(&tests[1].rh, test_rcu_tasks_callback);
1749#endif
1750
1751#ifdef CONFIG_TASKS_TRACE_RCU
1752 synchronize_rcu_tasks_trace();
1753 call_rcu_tasks_trace(&tests[2].rh, test_rcu_tasks_callback);
1754#endif
1755}
1756
1757static int rcu_tasks_verify_self_tests(void)
1758{
1759 int ret = 0;
1760 int i;
1761
1762 for (i = 0; i < ARRAY_SIZE(tests); i++) {
1763 if (!tests[i].notrun) { // still hanging.
1764 pr_err("%s has been failed.\n", tests[i].name);
1765 ret = -1;
1766 }
1767 }
1768
1769 if (ret)
1770 WARN_ON(1);
1771
1772 return ret;
1773}
1774late_initcall(rcu_tasks_verify_self_tests);
1775#else /* #ifdef CONFIG_PROVE_RCU */
1776static void rcu_tasks_initiate_self_tests(void) { }
1777#endif /* #else #ifdef CONFIG_PROVE_RCU */
1778
1b04fa99
URS
1779void __init rcu_init_tasks_generic(void)
1780{
1781#ifdef CONFIG_TASKS_RCU
1782 rcu_spawn_tasks_kthread();
1783#endif
1784
1785#ifdef CONFIG_TASKS_RUDE_RCU
1786 rcu_spawn_tasks_rude_kthread();
1787#endif
1788
1789#ifdef CONFIG_TASKS_TRACE_RCU
1790 rcu_spawn_tasks_trace_kthread();
1791#endif
bfba7ed0
URS
1792
1793 // Run the self-tests.
1794 rcu_tasks_initiate_self_tests();
1b04fa99
URS
1795}
1796
8fd8ca38
PM
1797#else /* #ifdef CONFIG_TASKS_RCU_GENERIC */
1798static inline void rcu_tasks_bootup_oddness(void) {}
1799#endif /* #else #ifdef CONFIG_TASKS_RCU_GENERIC */