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