1 /* SPDX-License-Identifier: GPL-2.0+ */
3 * Read-Copy Update mechanism for mutual exclusion (tree-based version)
4 * Internal non-public definitions.
6 * Copyright IBM Corporation, 2008
8 * Author: Ingo Molnar <mingo@elte.hu>
9 * Paul E. McKenney <paulmck@linux.ibm.com>
12 #include <linux/cache.h>
13 #include <linux/spinlock.h>
14 #include <linux/rtmutex.h>
15 #include <linux/threads.h>
16 #include <linux/cpumask.h>
17 #include <linux/seqlock.h>
18 #include <linux/swait.h>
19 #include <linux/stop_machine.h>
20 #include <linux/rcu_node_tree.h>
22 #include "rcu_segcblist.h"
24 /* Communicate arguments to a workqueue handler. */
27 struct work_struct rew_work
;
30 /* RCU's kthread states for tracing. */
31 #define RCU_KTHREAD_STOPPED 0
32 #define RCU_KTHREAD_RUNNING 1
33 #define RCU_KTHREAD_WAITING 2
34 #define RCU_KTHREAD_OFFCPU 3
35 #define RCU_KTHREAD_YIELDING 4
36 #define RCU_KTHREAD_MAX 4
39 * Definition for node within the RCU grace-period-detection hierarchy.
42 raw_spinlock_t __private lock
; /* Root rcu_node's lock protects */
43 /* some rcu_state fields as well as */
45 unsigned long gp_seq
; /* Track rsp->rcu_gp_seq. */
46 unsigned long gp_seq_needed
; /* Track furthest future GP request. */
47 unsigned long completedqs
; /* All QSes done for this node. */
48 unsigned long qsmask
; /* CPUs or groups that need to switch in */
49 /* order for current grace period to proceed.*/
50 /* In leaf rcu_node, each bit corresponds to */
51 /* an rcu_data structure, otherwise, each */
52 /* bit corresponds to a child rcu_node */
54 unsigned long rcu_gp_init_mask
; /* Mask of offline CPUs at GP init. */
55 unsigned long qsmaskinit
;
56 /* Per-GP initial value for qsmask. */
57 /* Initialized from ->qsmaskinitnext at the */
58 /* beginning of each grace period. */
59 unsigned long qsmaskinitnext
;
60 /* Online CPUs for next grace period. */
61 unsigned long expmask
; /* CPUs or groups that need to check in */
62 /* to allow the current expedited GP */
64 unsigned long expmaskinit
;
65 /* Per-GP initial values for expmask. */
66 /* Initialized from ->expmaskinitnext at the */
67 /* beginning of each expedited GP. */
68 unsigned long expmaskinitnext
;
69 /* Online CPUs for next expedited GP. */
70 /* Any CPU that has ever been online will */
71 /* have its bit set. */
72 unsigned long ffmask
; /* Fully functional CPUs. */
73 unsigned long grpmask
; /* Mask to apply to parent qsmask. */
74 /* Only one bit will be set in this mask. */
75 int grplo
; /* lowest-numbered CPU or group here. */
76 int grphi
; /* highest-numbered CPU or group here. */
77 u8 grpnum
; /* CPU/group number for next level up. */
78 u8 level
; /* root is at level 0. */
79 bool wait_blkd_tasks
;/* Necessary to wait for blocked tasks to */
80 /* exit RCU read-side critical sections */
81 /* before propagating offline up the */
83 struct rcu_node
*parent
;
84 struct list_head blkd_tasks
;
85 /* Tasks blocked in RCU read-side critical */
86 /* section. Tasks are placed at the head */
87 /* of this list and age towards the tail. */
88 struct list_head
*gp_tasks
;
89 /* Pointer to the first task blocking the */
90 /* current grace period, or NULL if there */
91 /* is no such task. */
92 struct list_head
*exp_tasks
;
93 /* Pointer to the first task blocking the */
94 /* current expedited grace period, or NULL */
95 /* if there is no such task. If there */
96 /* is no current expedited grace period, */
97 /* then there can cannot be any such task. */
98 struct list_head
*boost_tasks
;
99 /* Pointer to first task that needs to be */
100 /* priority boosted, or NULL if no priority */
101 /* boosting is needed for this rcu_node */
102 /* structure. If there are no tasks */
103 /* queued on this rcu_node structure that */
104 /* are blocking the current grace period, */
105 /* there can be no such task. */
106 struct rt_mutex boost_mtx
;
107 /* Used only for the priority-boosting */
108 /* side effect, not as a lock. */
109 unsigned long boost_time
;
110 /* When to start boosting (jiffies). */
111 struct task_struct
*boost_kthread_task
;
112 /* kthread that takes care of priority */
113 /* boosting for this rcu_node structure. */
114 unsigned int boost_kthread_status
;
115 /* State of boost_kthread_task for tracing. */
116 #ifdef CONFIG_RCU_NOCB_CPU
117 struct swait_queue_head nocb_gp_wq
[2];
118 /* Place for rcu_nocb_kthread() to wait GP. */
119 #endif /* #ifdef CONFIG_RCU_NOCB_CPU */
120 raw_spinlock_t fqslock ____cacheline_internodealigned_in_smp
;
122 spinlock_t exp_lock ____cacheline_internodealigned_in_smp
;
123 unsigned long exp_seq_rq
;
124 wait_queue_head_t exp_wq
[4];
125 struct rcu_exp_work rew
;
126 bool exp_need_flush
; /* Need to flush workitem? */
127 } ____cacheline_internodealigned_in_smp
;
130 * Bitmasks in an rcu_node cover the interval [grplo, grphi] of CPU IDs, and
131 * are indexed relative to this interval rather than the global CPU ID space.
132 * This generates the bit for a CPU in node-local masks.
134 #define leaf_node_cpu_bit(rnp, cpu) (BIT((cpu) - (rnp)->grplo))
137 * Union to allow "aggregate OR" operation on the need for a quiescent
138 * state by the normal and expedited grace periods.
145 u16 s
; /* Set of bits, aggregate OR here. */
148 /* Per-CPU data for read-copy update. */
150 /* 1) quiescent-state and grace-period handling : */
151 unsigned long gp_seq
; /* Track rsp->rcu_gp_seq counter. */
152 unsigned long gp_seq_needed
; /* Track furthest future GP request. */
153 union rcu_noqs cpu_no_qs
; /* No QSes yet for this CPU. */
154 bool core_needs_qs
; /* Core waits for quiesc state. */
155 bool beenonline
; /* CPU online at least once. */
156 bool gpwrap
; /* Possible ->gp_seq wrap. */
157 bool exp_deferred_qs
; /* This CPU awaiting a deferred QS? */
158 struct rcu_node
*mynode
; /* This CPU's leaf of hierarchy */
159 unsigned long grpmask
; /* Mask to apply to leaf qsmask. */
160 unsigned long ticks_this_gp
; /* The number of scheduling-clock */
161 /* ticks this CPU has handled */
162 /* during and after the last grace */
163 /* period it is aware of. */
164 struct irq_work defer_qs_iw
; /* Obtain later scheduler attention. */
165 bool defer_qs_iw_pending
; /* Scheduler attention pending? */
167 /* 2) batch handling */
168 struct rcu_segcblist cblist
; /* Segmented callback list, with */
169 /* different callbacks waiting for */
170 /* different grace periods. */
171 long qlen_last_fqs_check
;
172 /* qlen at last check for QS forcing */
173 unsigned long n_force_qs_snap
;
174 /* did other CPU force QS recently? */
175 long blimit
; /* Upper limit on a processed batch */
177 /* 3) dynticks interface. */
178 int dynticks_snap
; /* Per-GP tracking for dynticks. */
179 long dynticks_nesting
; /* Track process nesting level. */
180 long dynticks_nmi_nesting
; /* Track irq/NMI nesting level. */
181 atomic_t dynticks
; /* Even value for idle, else odd. */
182 bool rcu_need_heavy_qs
; /* GP old, so heavy quiescent state! */
183 bool rcu_urgent_qs
; /* GP old need light quiescent state. */
184 #ifdef CONFIG_RCU_FAST_NO_HZ
185 bool all_lazy
; /* All CPU's CBs lazy at idle start? */
186 unsigned long last_accelerate
; /* Last jiffy CBs were accelerated. */
187 unsigned long last_advance_all
; /* Last jiffy CBs were all advanced. */
188 int tick_nohz_enabled_snap
; /* Previously seen value from sysfs. */
189 #endif /* #ifdef CONFIG_RCU_FAST_NO_HZ */
191 /* 4) rcu_barrier(), OOM callbacks, and expediting. */
192 struct rcu_head barrier_head
;
193 int exp_dynticks_snap
; /* Double-check need for IPI. */
195 /* 5) Callback offloading. */
196 #ifdef CONFIG_RCU_NOCB_CPU
197 struct rcu_head
*nocb_head
; /* CBs waiting for kthread. */
198 struct rcu_head
**nocb_tail
;
199 atomic_long_t nocb_q_count
; /* # CBs waiting for nocb */
200 atomic_long_t nocb_q_count_lazy
; /* invocation (all stages). */
201 struct rcu_head
*nocb_follower_head
; /* CBs ready to invoke. */
202 struct rcu_head
**nocb_follower_tail
;
203 struct swait_queue_head nocb_wq
; /* For nocb kthreads to sleep on. */
204 struct task_struct
*nocb_kthread
;
205 raw_spinlock_t nocb_lock
; /* Guard following pair of fields. */
206 int nocb_defer_wakeup
; /* Defer wakeup of nocb_kthread. */
207 struct timer_list nocb_timer
; /* Enforce finite deferral. */
209 /* The following fields are used by the leader, hence own cacheline. */
210 struct rcu_head
*nocb_gp_head ____cacheline_internodealigned_in_smp
;
211 /* CBs waiting for GP. */
212 struct rcu_head
**nocb_gp_tail
;
213 bool nocb_leader_sleep
; /* Is the nocb leader thread asleep? */
214 struct rcu_data
*nocb_next_follower
;
215 /* Next follower in wakeup chain. */
217 /* The following fields are used by the follower, hence new cachline. */
218 struct rcu_data
*nocb_leader ____cacheline_internodealigned_in_smp
;
219 /* Leader CPU takes GP-end wakeups. */
220 #endif /* #ifdef CONFIG_RCU_NOCB_CPU */
222 /* 6) RCU priority boosting. */
223 struct task_struct
*rcu_cpu_kthread_task
;
224 /* rcuc per-CPU kthread or NULL. */
225 unsigned int rcu_cpu_kthread_status
;
226 char rcu_cpu_has_work
;
228 /* 7) Diagnostic data, including RCU CPU stall warnings. */
229 unsigned int softirq_snap
; /* Snapshot of softirq activity. */
230 /* ->rcu_iw* fields protected by leaf rcu_node ->lock. */
231 struct irq_work rcu_iw
; /* Check for non-irq activity. */
232 bool rcu_iw_pending
; /* Is ->rcu_iw pending? */
233 unsigned long rcu_iw_gp_seq
; /* ->gp_seq associated with ->rcu_iw. */
234 unsigned long rcu_ofl_gp_seq
; /* ->gp_seq at last offline. */
235 short rcu_ofl_gp_flags
; /* ->gp_flags at last offline. */
236 unsigned long rcu_onl_gp_seq
; /* ->gp_seq at last online. */
237 short rcu_onl_gp_flags
; /* ->gp_flags at last online. */
238 unsigned long last_fqs_resched
; /* Time of last rcu_resched(). */
243 /* Values for nocb_defer_wakeup field in struct rcu_data. */
244 #define RCU_NOCB_WAKE_NOT 0
245 #define RCU_NOCB_WAKE 1
246 #define RCU_NOCB_WAKE_FORCE 2
248 #define RCU_JIFFIES_TILL_FORCE_QS (1 + (HZ > 250) + (HZ > 500))
249 /* For jiffies_till_first_fqs and */
250 /* and jiffies_till_next_fqs. */
252 #define RCU_JIFFIES_FQS_DIV 256 /* Very large systems need more */
253 /* delay between bouts of */
254 /* quiescent-state forcing. */
256 #define RCU_STALL_RAT_DELAY 2 /* Allow other CPUs time to take */
257 /* at least one scheduling clock */
258 /* irq before ratting on them. */
260 #define rcu_wait(cond) \
263 set_current_state(TASK_INTERRUPTIBLE); \
268 __set_current_state(TASK_RUNNING); \
272 * RCU global state, including node hierarchy. This hierarchy is
273 * represented in "heap" form in a dense array. The root (first level)
274 * of the hierarchy is in ->node[0] (referenced by ->level[0]), the second
275 * level in ->node[1] through ->node[m] (->node[1] referenced by ->level[1]),
276 * and the third level in ->node[m+1] and following (->node[m+1] referenced
277 * by ->level[2]). The number of levels is determined by the number of
278 * CPUs and by CONFIG_RCU_FANOUT. Small systems will have a "hierarchy"
279 * consisting of a single rcu_node.
282 struct rcu_node node
[NUM_RCU_NODES
]; /* Hierarchy. */
283 struct rcu_node
*level
[RCU_NUM_LVLS
+ 1];
284 /* Hierarchy levels (+1 to */
285 /* shut bogus gcc warning) */
286 int ncpus
; /* # CPUs seen so far. */
288 /* The following fields are guarded by the root rcu_node's lock. */
290 u8 boost ____cacheline_internodealigned_in_smp
;
291 /* Subject to priority boost. */
292 unsigned long gp_seq
; /* Grace-period sequence #. */
293 struct task_struct
*gp_kthread
; /* Task for grace periods. */
294 struct swait_queue_head gp_wq
; /* Where GP task waits. */
295 short gp_flags
; /* Commands for GP task. */
296 short gp_state
; /* GP kthread sleep state. */
297 unsigned long gp_wake_time
; /* Last GP kthread wake. */
298 unsigned long gp_wake_seq
; /* ->gp_seq at ^^^. */
300 /* End of fields guarded by root rcu_node's lock. */
302 struct mutex barrier_mutex
; /* Guards barrier fields. */
303 atomic_t barrier_cpu_count
; /* # CPUs waiting on. */
304 struct completion barrier_completion
; /* Wake at barrier end. */
305 unsigned long barrier_sequence
; /* ++ at start and end of */
307 /* End of fields guarded by barrier_mutex. */
309 struct mutex exp_mutex
; /* Serialize expedited GP. */
310 struct mutex exp_wake_mutex
; /* Serialize wakeup. */
311 unsigned long expedited_sequence
; /* Take a ticket. */
312 atomic_t expedited_need_qs
; /* # CPUs left to check in. */
313 struct swait_queue_head expedited_wq
; /* Wait for check-ins. */
314 int ncpus_snap
; /* # CPUs seen last time. */
316 unsigned long jiffies_force_qs
; /* Time at which to invoke */
317 /* force_quiescent_state(). */
318 unsigned long jiffies_kick_kthreads
; /* Time at which to kick */
319 /* kthreads, if configured. */
320 unsigned long n_force_qs
; /* Number of calls to */
321 /* force_quiescent_state(). */
322 unsigned long gp_start
; /* Time at which GP started, */
323 /* but in jiffies. */
324 unsigned long gp_end
; /* Time last GP ended, again */
326 unsigned long gp_activity
; /* Time of last GP kthread */
327 /* activity in jiffies. */
328 unsigned long gp_req_activity
; /* Time of last GP request */
330 unsigned long jiffies_stall
; /* Time at which to check */
331 /* for CPU stalls. */
332 unsigned long jiffies_resched
; /* Time at which to resched */
333 /* a reluctant CPU. */
334 unsigned long n_force_qs_gpstart
; /* Snapshot of n_force_qs at */
336 unsigned long gp_max
; /* Maximum GP duration in */
338 const char *name
; /* Name of structure. */
339 char abbr
; /* Abbreviated name. */
341 raw_spinlock_t ofl_lock ____cacheline_internodealigned_in_smp
;
342 /* Synchronize offline with */
343 /* GP pre-initialization. */
346 /* Values for rcu_state structure's gp_flags field. */
347 #define RCU_GP_FLAG_INIT 0x1 /* Need grace-period initialization. */
348 #define RCU_GP_FLAG_FQS 0x2 /* Need grace-period quiescent-state forcing. */
350 /* Values for rcu_state structure's gp_state field. */
351 #define RCU_GP_IDLE 0 /* Initial state and no GP in progress. */
352 #define RCU_GP_WAIT_GPS 1 /* Wait for grace-period start. */
353 #define RCU_GP_DONE_GPS 2 /* Wait done for grace-period start. */
354 #define RCU_GP_ONOFF 3 /* Grace-period initialization hotplug. */
355 #define RCU_GP_INIT 4 /* Grace-period initialization. */
356 #define RCU_GP_WAIT_FQS 5 /* Wait for force-quiescent-state time. */
357 #define RCU_GP_DOING_FQS 6 /* Wait done for force-quiescent-state time. */
358 #define RCU_GP_CLEANUP 7 /* Grace-period cleanup started. */
359 #define RCU_GP_CLEANED 8 /* Grace-period cleanup complete. */
361 static const char * const gp_state_names
[] = {
374 * In order to export the rcu_state name to the tracing tools, it
375 * needs to be added in the __tracepoint_string section.
376 * This requires defining a separate variable tp_<sname>_varname
377 * that points to the string being used, and this will allow
378 * the tracing userspace tools to be able to decipher the string
379 * address to the matching string.
381 #ifdef CONFIG_PREEMPT_RCU
383 #define RCU_NAME_RAW "rcu_preempt"
384 #else /* #ifdef CONFIG_PREEMPT_RCU */
386 #define RCU_NAME_RAW "rcu_sched"
387 #endif /* #else #ifdef CONFIG_PREEMPT_RCU */
388 #ifndef CONFIG_TRACING
389 #define RCU_NAME RCU_NAME_RAW
390 #else /* #ifdef CONFIG_TRACING */
391 static char rcu_name
[] = RCU_NAME_RAW
;
392 static const char *tp_rcu_varname __used __tracepoint_string
= rcu_name
;
393 #define RCU_NAME rcu_name
394 #endif /* #else #ifdef CONFIG_TRACING */
396 int rcu_dynticks_snap(struct rcu_data
*rdp
);
398 /* Forward declarations for tree_plugin.h */
399 static void rcu_bootup_announce(void);
400 static void rcu_qs(void);
401 static int rcu_preempt_blocked_readers_cgp(struct rcu_node
*rnp
);
402 #ifdef CONFIG_HOTPLUG_CPU
403 static bool rcu_preempt_has_tasks(struct rcu_node
*rnp
);
404 #endif /* #ifdef CONFIG_HOTPLUG_CPU */
405 static int rcu_print_task_exp_stall(struct rcu_node
*rnp
);
406 static void rcu_preempt_check_blocked_tasks(struct rcu_node
*rnp
);
407 static void rcu_flavor_sched_clock_irq(int user
);
408 void call_rcu(struct rcu_head
*head
, rcu_callback_t func
);
409 static void dump_blkd_tasks(struct rcu_node
*rnp
, int ncheck
);
410 static void rcu_initiate_boost(struct rcu_node
*rnp
, unsigned long flags
);
411 static void rcu_preempt_boost_start_gp(struct rcu_node
*rnp
);
412 static bool rcu_is_callbacks_kthread(void);
413 static void rcu_cpu_kthread_setup(unsigned int cpu
);
414 static void __init
rcu_spawn_boost_kthreads(void);
415 static void rcu_prepare_kthreads(int cpu
);
416 static void rcu_cleanup_after_idle(void);
417 static void rcu_prepare_for_idle(void);
418 static bool rcu_preempt_has_tasks(struct rcu_node
*rnp
);
419 static bool rcu_preempt_need_deferred_qs(struct task_struct
*t
);
420 static void rcu_preempt_deferred_qs(struct task_struct
*t
);
421 static void zero_cpu_stall_ticks(struct rcu_data
*rdp
);
422 static bool rcu_nocb_cpu_needs_barrier(int cpu
);
423 static struct swait_queue_head
*rcu_nocb_gp_get(struct rcu_node
*rnp
);
424 static void rcu_nocb_gp_cleanup(struct swait_queue_head
*sq
);
425 static void rcu_init_one_nocb(struct rcu_node
*rnp
);
426 static bool __call_rcu_nocb(struct rcu_data
*rdp
, struct rcu_head
*rhp
,
427 bool lazy
, unsigned long flags
);
428 static bool rcu_nocb_adopt_orphan_cbs(struct rcu_data
*my_rdp
,
429 struct rcu_data
*rdp
,
430 unsigned long flags
);
431 static int rcu_nocb_need_deferred_wakeup(struct rcu_data
*rdp
);
432 static void do_nocb_deferred_wakeup(struct rcu_data
*rdp
);
433 static void rcu_boot_init_nocb_percpu_data(struct rcu_data
*rdp
);
434 static void rcu_spawn_cpu_nocb_kthread(int cpu
);
435 static void __init
rcu_spawn_nocb_kthreads(void);
436 #ifdef CONFIG_RCU_NOCB_CPU
437 static void __init
rcu_organize_nocb_kthreads(void);
438 #endif /* #ifdef CONFIG_RCU_NOCB_CPU */
439 static bool init_nocb_callback_list(struct rcu_data
*rdp
);
440 static unsigned long rcu_get_n_cbs_nocb_cpu(struct rcu_data
*rdp
);
441 static void rcu_bind_gp_kthread(void);
442 static bool rcu_nohz_full_cpu(void);
443 static void rcu_dynticks_task_enter(void);
444 static void rcu_dynticks_task_exit(void);
446 /* Forward declarations for tree_stall.h */
447 static void record_gp_stall_check_time(void);
448 static void rcu_iw_handler(struct irq_work
*iwp
);
449 static void check_cpu_stall(struct rcu_data
*rdp
);
450 static void rcu_check_gp_start_stall(struct rcu_node
*rnp
, struct rcu_data
*rdp
,
451 const unsigned long gpssdelay
);