rcu: Simplify arithmetic to calculate number of RCU nodes
[linux-block.git] / kernel / rcu / tree.h
CommitLineData
9f77da9f
PM
1/*
2 * Read-Copy Update mechanism for mutual exclusion (tree-based version)
3 * Internal non-public definitions.
4 *
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License
87de1cfd
PM
16 * along with this program; if not, you can access it online at
17 * http://www.gnu.org/licenses/gpl-2.0.html.
9f77da9f
PM
18 *
19 * Copyright IBM Corporation, 2008
20 *
21 * Author: Ingo Molnar <mingo@elte.hu>
22 * Paul E. McKenney <paulmck@linux.vnet.ibm.com>
23 */
24
25#include <linux/cache.h>
26#include <linux/spinlock.h>
27#include <linux/threads.h>
28#include <linux/cpumask.h>
29#include <linux/seqlock.h>
30
31/*
8932a63d
PM
32 * Define shape of hierarchy based on NR_CPUS, CONFIG_RCU_FANOUT, and
33 * CONFIG_RCU_FANOUT_LEAF.
9f77da9f 34 * In theory, it should be possible to add more levels straightforwardly.
0209f649
PM
35 * In practice, this did work well going from three levels to four.
36 * Of course, your mileage may vary.
9f77da9f 37 */
05c5df31 38
05c5df31
PM
39#ifdef CONFIG_RCU_FANOUT
40#define RCU_FANOUT CONFIG_RCU_FANOUT
41#else /* #ifdef CONFIG_RCU_FANOUT */
42# ifdef CONFIG_64BIT
43# define RCU_FANOUT 64
44# else
45# define RCU_FANOUT 32
46# endif
47#endif /* #else #ifdef CONFIG_RCU_FANOUT */
48
47d631af
PM
49#ifdef CONFIG_RCU_FANOUT_LEAF
50#define RCU_FANOUT_LEAF CONFIG_RCU_FANOUT_LEAF
51#else /* #ifdef CONFIG_RCU_FANOUT_LEAF */
52# ifdef CONFIG_64BIT
53# define RCU_FANOUT_LEAF 64
54# else
55# define RCU_FANOUT_LEAF 32
56# endif
57#endif /* #else #ifdef CONFIG_RCU_FANOUT_LEAF */
58
59#define RCU_FANOUT_1 (RCU_FANOUT_LEAF)
05c5df31
PM
60#define RCU_FANOUT_2 (RCU_FANOUT_1 * RCU_FANOUT)
61#define RCU_FANOUT_3 (RCU_FANOUT_2 * RCU_FANOUT)
62#define RCU_FANOUT_4 (RCU_FANOUT_3 * RCU_FANOUT)
9f77da9f 63
0209f649 64#if NR_CPUS <= RCU_FANOUT_1
f885b7f2 65# define RCU_NUM_LVLS 1
9f77da9f 66# define NUM_RCU_LVL_0 1
42621697 67# define NUM_RCU_NODES NUM_RCU_LVL_0
cb007102
AG
68# define NUM_RCU_LVL_INIT { NUM_RCU_LVL_0 }
69# define RCU_NODE_NAME_INIT { "rcu_node_0" }
70# define RCU_FQS_NAME_INIT { "rcu_node_fqs_0" }
0209f649 71#elif NR_CPUS <= RCU_FANOUT_2
f885b7f2 72# define RCU_NUM_LVLS 2
9f77da9f 73# define NUM_RCU_LVL_0 1
0209f649 74# define NUM_RCU_LVL_1 DIV_ROUND_UP(NR_CPUS, RCU_FANOUT_1)
42621697 75# define NUM_RCU_NODES (NUM_RCU_LVL_0 + NUM_RCU_LVL_1)
cb007102
AG
76# define NUM_RCU_LVL_INIT { NUM_RCU_LVL_0, NUM_RCU_LVL_1 }
77# define RCU_NODE_NAME_INIT { "rcu_node_0", "rcu_node_1" }
78# define RCU_FQS_NAME_INIT { "rcu_node_fqs_0", "rcu_node_fqs_1" }
0209f649 79#elif NR_CPUS <= RCU_FANOUT_3
f885b7f2 80# define RCU_NUM_LVLS 3
9f77da9f 81# define NUM_RCU_LVL_0 1
0209f649
PM
82# define NUM_RCU_LVL_1 DIV_ROUND_UP(NR_CPUS, RCU_FANOUT_2)
83# define NUM_RCU_LVL_2 DIV_ROUND_UP(NR_CPUS, RCU_FANOUT_1)
42621697 84# define NUM_RCU_NODES (NUM_RCU_LVL_0 + NUM_RCU_LVL_1 + NUM_RCU_LVL_2)
cb007102
AG
85# define NUM_RCU_LVL_INIT { NUM_RCU_LVL_0, NUM_RCU_LVL_1, NUM_RCU_LVL_2 }
86# define RCU_NODE_NAME_INIT { "rcu_node_0", "rcu_node_1", "rcu_node_2" }
87# define RCU_FQS_NAME_INIT { "rcu_node_fqs_0", "rcu_node_fqs_1", "rcu_node_fqs_2" }
0209f649 88#elif NR_CPUS <= RCU_FANOUT_4
f885b7f2 89# define RCU_NUM_LVLS 4
cf244dc0 90# define NUM_RCU_LVL_0 1
0209f649
PM
91# define NUM_RCU_LVL_1 DIV_ROUND_UP(NR_CPUS, RCU_FANOUT_3)
92# define NUM_RCU_LVL_2 DIV_ROUND_UP(NR_CPUS, RCU_FANOUT_2)
93# define NUM_RCU_LVL_3 DIV_ROUND_UP(NR_CPUS, RCU_FANOUT_1)
42621697 94# define NUM_RCU_NODES (NUM_RCU_LVL_0 + NUM_RCU_LVL_1 + NUM_RCU_LVL_2 + NUM_RCU_LVL_3)
cb007102
AG
95# define NUM_RCU_LVL_INIT { NUM_RCU_LVL_0, NUM_RCU_LVL_1, NUM_RCU_LVL_2, NUM_RCU_LVL_3 }
96# define RCU_NODE_NAME_INIT { "rcu_node_0", "rcu_node_1", "rcu_node_2", "rcu_node_3" }
97# define RCU_FQS_NAME_INIT { "rcu_node_fqs_0", "rcu_node_fqs_1", "rcu_node_fqs_2", "rcu_node_fqs_3" }
9f77da9f
PM
98#else
99# error "CONFIG_RCU_FANOUT insufficient for NR_CPUS"
0209f649 100#endif /* #if (NR_CPUS) <= RCU_FANOUT_1 */
9f77da9f 101
f885b7f2
PM
102extern int rcu_num_lvls;
103extern int rcu_num_nodes;
104
9f77da9f
PM
105/*
106 * Dynticks per-CPU state.
107 */
108struct rcu_dynticks {
9b2e4f18
PM
109 long long dynticks_nesting; /* Track irq/process nesting level. */
110 /* Process level is worth LLONG_MAX/2. */
111 int dynticks_nmi_nesting; /* Track NMI nesting level. */
112 atomic_t dynticks; /* Even value for idle, else odd. */
2333210b
PM
113#ifdef CONFIG_NO_HZ_FULL_SYSIDLE
114 long long dynticks_idle_nesting;
115 /* irq/process nesting level from idle. */
116 atomic_t dynticks_idle; /* Even value for idle, else odd. */
117 /* "Idle" excludes userspace execution. */
118 unsigned long dynticks_idle_jiffies;
119 /* End of last non-NMI non-idle period. */
120#endif /* #ifdef CONFIG_NO_HZ_FULL_SYSIDLE */
5955f7ee 121#ifdef CONFIG_RCU_FAST_NO_HZ
c0f4dfd4 122 bool all_lazy; /* Are all CPU's CBs lazy? */
5955f7ee
PM
123 unsigned long nonlazy_posted;
124 /* # times non-lazy CBs posted to CPU. */
125 unsigned long nonlazy_posted_snap;
126 /* idle-period nonlazy_posted snapshot. */
c0f4dfd4
PM
127 unsigned long last_accelerate;
128 /* Last jiffy CBs were accelerated. */
c229828c
PM
129 unsigned long last_advance_all;
130 /* Last jiffy CBs were all advanced. */
9d2ad243 131 int tick_nohz_enabled_snap; /* Previously seen value from sysfs. */
5955f7ee 132#endif /* #ifdef CONFIG_RCU_FAST_NO_HZ */
9f77da9f
PM
133};
134
d71df90e
PM
135/* RCU's kthread states for tracing. */
136#define RCU_KTHREAD_STOPPED 0
137#define RCU_KTHREAD_RUNNING 1
138#define RCU_KTHREAD_WAITING 2
15ba0ba8
PM
139#define RCU_KTHREAD_OFFCPU 3
140#define RCU_KTHREAD_YIELDING 4
141#define RCU_KTHREAD_MAX 4
d71df90e 142
9f77da9f
PM
143/*
144 * Definition for node within the RCU grace-period-detection hierarchy.
145 */
146struct rcu_node {
1304afb2 147 raw_spinlock_t lock; /* Root rcu_node's lock protects some */
1eba8f84 148 /* rcu_state fields as well as following. */
20133cfc 149 unsigned long gpnum; /* Current grace period for this node. */
86848966
PM
150 /* This will either be equal to or one */
151 /* behind the root rcu_node's gpnum. */
20133cfc 152 unsigned long completed; /* Last GP completed for this node. */
d09b62df
PM
153 /* This will either be equal to or one */
154 /* behind the root rcu_node's gpnum. */
9f77da9f
PM
155 unsigned long qsmask; /* CPUs or groups that need to switch in */
156 /* order for current grace period to proceed.*/
1eba8f84
PM
157 /* In leaf rcu_node, each bit corresponds to */
158 /* an rcu_data structure, otherwise, each */
159 /* bit corresponds to a child rcu_node */
160 /* structure. */
12f5f524 161 unsigned long expmask; /* Groups that have ->blkd_tasks */
d9a3da06
PM
162 /* elements that need to drain to allow the */
163 /* current expedited grace period to */
28f6569a 164 /* complete (only for PREEMPT_RCU). */
9f77da9f 165 unsigned long qsmaskinit;
d9a3da06 166 /* Per-GP initial value for qsmask & expmask. */
0aa04b05
PM
167 /* Initialized from ->qsmaskinitnext at the */
168 /* beginning of each grace period. */
169 unsigned long qsmaskinitnext;
170 /* Online CPUs for next grace period. */
9f77da9f 171 unsigned long grpmask; /* Mask to apply to parent qsmask. */
1eba8f84 172 /* Only one bit will be set in this mask. */
9f77da9f
PM
173 int grplo; /* lowest-numbered CPU or group here. */
174 int grphi; /* highest-numbered CPU or group here. */
175 u8 grpnum; /* CPU/group number for next level up. */
176 u8 level; /* root is at level 0. */
0aa04b05
PM
177 bool wait_blkd_tasks;/* Necessary to wait for blocked tasks to */
178 /* exit RCU read-side critical sections */
179 /* before propagating offline up the */
180 /* rcu_node tree? */
9f77da9f 181 struct rcu_node *parent;
12f5f524
PM
182 struct list_head blkd_tasks;
183 /* Tasks blocked in RCU read-side critical */
184 /* section. Tasks are placed at the head */
185 /* of this list and age towards the tail. */
186 struct list_head *gp_tasks;
187 /* Pointer to the first task blocking the */
188 /* current grace period, or NULL if there */
189 /* is no such task. */
190 struct list_head *exp_tasks;
191 /* Pointer to the first task blocking the */
192 /* current expedited grace period, or NULL */
193 /* if there is no such task. If there */
194 /* is no current expedited grace period, */
195 /* then there can cannot be any such task. */
27f4d280
PM
196 struct list_head *boost_tasks;
197 /* Pointer to first task that needs to be */
198 /* priority boosted, or NULL if no priority */
199 /* boosting is needed for this rcu_node */
200 /* structure. If there are no tasks */
201 /* queued on this rcu_node structure that */
202 /* are blocking the current grace period, */
203 /* there can be no such task. */
abaa93d9
PM
204 struct rt_mutex boost_mtx;
205 /* Used only for the priority-boosting */
206 /* side effect, not as a lock. */
27f4d280
PM
207 unsigned long boost_time;
208 /* When to start boosting (jiffies). */
209 struct task_struct *boost_kthread_task;
210 /* kthread that takes care of priority */
211 /* boosting for this rcu_node structure. */
d71df90e
PM
212 unsigned int boost_kthread_status;
213 /* State of boost_kthread_task for tracing. */
0ea1f2eb
PM
214 unsigned long n_tasks_boosted;
215 /* Total number of tasks boosted. */
216 unsigned long n_exp_boosts;
217 /* Number of tasks boosted for expedited GP. */
218 unsigned long n_normal_boosts;
219 /* Number of tasks boosted for normal GP. */
220 unsigned long n_balk_blkd_tasks;
221 /* Refused to boost: no blocked tasks. */
222 unsigned long n_balk_exp_gp_tasks;
223 /* Refused to boost: nothing blocking GP. */
224 unsigned long n_balk_boost_tasks;
225 /* Refused to boost: already boosting. */
226 unsigned long n_balk_notblocked;
227 /* Refused to boost: RCU RS CS still running. */
228 unsigned long n_balk_notyet;
229 /* Refused to boost: not yet time. */
230 unsigned long n_balk_nos;
231 /* Refused to boost: not sure why, though. */
232 /* This can happen due to race conditions. */
dae6e64d
PM
233#ifdef CONFIG_RCU_NOCB_CPU
234 wait_queue_head_t nocb_gp_wq[2];
235 /* Place for rcu_nocb_kthread() to wait GP. */
dae6e64d 236#endif /* #ifdef CONFIG_RCU_NOCB_CPU */
8b425aa8
PM
237 int need_future_gp[2];
238 /* Counts of upcoming no-CB GP requests. */
394f2769 239 raw_spinlock_t fqslock ____cacheline_internodealigned_in_smp;
9f77da9f
PM
240} ____cacheline_internodealigned_in_smp;
241
a0b6c9a7
PM
242/*
243 * Do a full breadth-first scan of the rcu_node structures for the
244 * specified rcu_state structure.
245 */
246#define rcu_for_each_node_breadth_first(rsp, rnp) \
247 for ((rnp) = &(rsp)->node[0]; \
f885b7f2 248 (rnp) < &(rsp)->node[rcu_num_nodes]; (rnp)++)
a0b6c9a7 249
d9a3da06
PM
250/*
251 * Do a breadth-first scan of the non-leaf rcu_node structures for the
252 * specified rcu_state structure. Note that if there is a singleton
253 * rcu_node tree with but one rcu_node structure, this loop is a no-op.
254 */
255#define rcu_for_each_nonleaf_node_breadth_first(rsp, rnp) \
256 for ((rnp) = &(rsp)->node[0]; \
f885b7f2 257 (rnp) < (rsp)->level[rcu_num_lvls - 1]; (rnp)++)
d9a3da06
PM
258
259/*
260 * Scan the leaves of the rcu_node hierarchy for the specified rcu_state
261 * structure. Note that if there is a singleton rcu_node tree with but
262 * one rcu_node structure, this loop -will- visit the rcu_node structure.
263 * It is still a leaf node, even if it is also the root node.
264 */
a0b6c9a7 265#define rcu_for_each_leaf_node(rsp, rnp) \
f885b7f2
PM
266 for ((rnp) = (rsp)->level[rcu_num_lvls - 1]; \
267 (rnp) < &(rsp)->node[rcu_num_nodes]; (rnp)++)
a0b6c9a7 268
9f77da9f
PM
269/* Index values for nxttail array in struct rcu_data. */
270#define RCU_DONE_TAIL 0 /* Also RCU_WAIT head. */
271#define RCU_WAIT_TAIL 1 /* Also RCU_NEXT_READY head. */
272#define RCU_NEXT_READY_TAIL 2 /* Also RCU_NEXT head. */
273#define RCU_NEXT_TAIL 3
274#define RCU_NEXT_SIZE 4
275
276/* Per-CPU data for read-copy update. */
277struct rcu_data {
278 /* 1) quiescent-state and grace-period handling : */
20133cfc 279 unsigned long completed; /* Track rsp->completed gp number */
9f77da9f 280 /* in order to detect GP end. */
20133cfc 281 unsigned long gpnum; /* Highest gp number that this CPU */
9f77da9f 282 /* is aware of having started. */
5cd37193
PM
283 unsigned long rcu_qs_ctr_snap;/* Snapshot of rcu_qs_ctr to check */
284 /* for rcu_all_qs() invocations. */
e4cc1f22 285 bool passed_quiesce; /* User-mode/idle loop etc. */
9f77da9f
PM
286 bool qs_pending; /* Core waits for quiesc state. */
287 bool beenonline; /* CPU online at least once. */
e3663b10 288 bool gpwrap; /* Possible gpnum/completed wrap. */
9f77da9f
PM
289 struct rcu_node *mynode; /* This CPU's leaf of hierarchy */
290 unsigned long grpmask; /* Mask to apply to leaf qsmask. */
a858af28
PM
291#ifdef CONFIG_RCU_CPU_STALL_INFO
292 unsigned long ticks_this_gp; /* The number of scheduling-clock */
293 /* ticks this CPU has handled */
294 /* during and after the last grace */
295 /* period it is aware of. */
296#endif /* #ifdef CONFIG_RCU_CPU_STALL_INFO */
9f77da9f
PM
297
298 /* 2) batch handling */
299 /*
300 * If nxtlist is not NULL, it is partitioned as follows.
301 * Any of the partitions might be empty, in which case the
302 * pointer to that partition will be equal to the pointer for
303 * the following partition. When the list is empty, all of
1eba8f84
PM
304 * the nxttail elements point to the ->nxtlist pointer itself,
305 * which in that case is NULL.
9f77da9f 306 *
9f77da9f
PM
307 * [nxtlist, *nxttail[RCU_DONE_TAIL]):
308 * Entries that batch # <= ->completed
309 * The grace period for these entries has completed, and
310 * the other grace-period-completed entries may be moved
311 * here temporarily in rcu_process_callbacks().
1eba8f84
PM
312 * [*nxttail[RCU_DONE_TAIL], *nxttail[RCU_WAIT_TAIL]):
313 * Entries that batch # <= ->completed - 1: waiting for current GP
314 * [*nxttail[RCU_WAIT_TAIL], *nxttail[RCU_NEXT_READY_TAIL]):
315 * Entries known to have arrived before current GP ended
316 * [*nxttail[RCU_NEXT_READY_TAIL], *nxttail[RCU_NEXT_TAIL]):
317 * Entries that might have arrived after current GP ended
318 * Note that the value of *nxttail[RCU_NEXT_TAIL] will
319 * always be NULL, as this is the end of the list.
9f77da9f
PM
320 */
321 struct rcu_head *nxtlist;
322 struct rcu_head **nxttail[RCU_NEXT_SIZE];
dc35c893
PM
323 unsigned long nxtcompleted[RCU_NEXT_SIZE];
324 /* grace periods for sublists. */
486e2593
PM
325 long qlen_lazy; /* # of lazy queued callbacks */
326 long qlen; /* # of queued callbacks, incl lazy */
37c72e56
PM
327 long qlen_last_fqs_check;
328 /* qlen at last check for QS forcing */
269dcc1c 329 unsigned long n_cbs_invoked; /* count of RCU cbs invoked. */
c635a4e1 330 unsigned long n_nocbs_invoked; /* count of no-CBs RCU cbs invoked. */
29494be7
LJ
331 unsigned long n_cbs_orphaned; /* RCU cbs orphaned by dying CPU */
332 unsigned long n_cbs_adopted; /* RCU cbs adopted from dying CPU */
37c72e56
PM
333 unsigned long n_force_qs_snap;
334 /* did other CPU force QS recently? */
9f77da9f
PM
335 long blimit; /* Upper limit on a processed batch */
336
9f77da9f
PM
337 /* 3) dynticks interface. */
338 struct rcu_dynticks *dynticks; /* Shared per-CPU dynticks state. */
339 int dynticks_snap; /* Per-GP tracking for dynticks. */
9f77da9f
PM
340
341 /* 4) reasons this CPU needed to be kicked by force_quiescent_state */
9f77da9f 342 unsigned long dynticks_fqs; /* Kicked due to dynticks idle. */
9f77da9f 343 unsigned long offline_fqs; /* Kicked due to being offline. */
4a81e832
PM
344 unsigned long cond_resched_completed;
345 /* Grace period that needs help */
346 /* from cond_resched(). */
9f77da9f
PM
347
348 /* 5) __rcu_pending() statistics. */
20133cfc
PM
349 unsigned long n_rcu_pending; /* rcu_pending() calls since boot. */
350 unsigned long n_rp_qs_pending;
d21670ac 351 unsigned long n_rp_report_qs;
20133cfc
PM
352 unsigned long n_rp_cb_ready;
353 unsigned long n_rp_cpu_needs_gp;
354 unsigned long n_rp_gp_completed;
355 unsigned long n_rp_gp_started;
96d3fd0d 356 unsigned long n_rp_nocb_defer_wakeup;
20133cfc 357 unsigned long n_rp_need_nothing;
9f77da9f 358
b626c1b6 359 /* 6) _rcu_barrier() and OOM callbacks. */
06668efa 360 struct rcu_head barrier_head;
b626c1b6
PM
361#ifdef CONFIG_RCU_FAST_NO_HZ
362 struct rcu_head oom_head;
363#endif /* #ifdef CONFIG_RCU_FAST_NO_HZ */
06668efa 364
3fbfbf7a
PM
365 /* 7) Callback offloading. */
366#ifdef CONFIG_RCU_NOCB_CPU
367 struct rcu_head *nocb_head; /* CBs waiting for kthread. */
368 struct rcu_head **nocb_tail;
41050a00
PM
369 atomic_long_t nocb_q_count; /* # CBs waiting for nocb */
370 atomic_long_t nocb_q_count_lazy; /* invocation (all stages). */
fbce7497
PM
371 struct rcu_head *nocb_follower_head; /* CBs ready to invoke. */
372 struct rcu_head **nocb_follower_tail;
3fbfbf7a
PM
373 wait_queue_head_t nocb_wq; /* For nocb kthreads to sleep on. */
374 struct task_struct *nocb_kthread;
9fdd3bc9 375 int nocb_defer_wakeup; /* Defer wakeup of nocb_kthread. */
fbce7497
PM
376
377 /* The following fields are used by the leader, hence own cacheline. */
378 struct rcu_head *nocb_gp_head ____cacheline_internodealigned_in_smp;
379 /* CBs waiting for GP. */
380 struct rcu_head **nocb_gp_tail;
11ed7f93 381 bool nocb_leader_sleep; /* Is the nocb leader thread asleep? */
fbce7497
PM
382 struct rcu_data *nocb_next_follower;
383 /* Next follower in wakeup chain. */
384
385 /* The following fields are used by the follower, hence new cachline. */
386 struct rcu_data *nocb_leader ____cacheline_internodealigned_in_smp;
387 /* Leader CPU takes GP-end wakeups. */
3fbfbf7a
PM
388#endif /* #ifdef CONFIG_RCU_NOCB_CPU */
389
6231069b
PM
390 /* 8) RCU CPU stall data. */
391#ifdef CONFIG_RCU_CPU_STALL_INFO
392 unsigned int softirq_snap; /* Snapshot of softirq activity. */
393#endif /* #ifdef CONFIG_RCU_CPU_STALL_INFO */
394
9f77da9f 395 int cpu;
d4c08f2a 396 struct rcu_state *rsp;
9f77da9f
PM
397};
398
af446b70 399/* Values for fqs_state field in struct rcu_state. */
83f5b01f
PM
400#define RCU_GP_IDLE 0 /* No grace period in progress. */
401#define RCU_GP_INIT 1 /* Grace period being initialized. */
402#define RCU_SAVE_DYNTICK 2 /* Need to scan dyntick state. */
ee47eb9f 403#define RCU_FORCE_QS 3 /* Need to force quiescent state. */
9f77da9f 404#define RCU_SIGNAL_INIT RCU_SAVE_DYNTICK
9f77da9f 405
9fdd3bc9
PM
406/* Values for nocb_defer_wakeup field in struct rcu_data. */
407#define RCU_NOGP_WAKE_NOT 0
408#define RCU_NOGP_WAKE 1
409#define RCU_NOGP_WAKE_FORCE 2
410
026ad283
PM
411#define RCU_JIFFIES_TILL_FORCE_QS (1 + (HZ > 250) + (HZ > 500))
412 /* For jiffies_till_first_fqs and */
413 /* and jiffies_till_next_fqs. */
007b0924 414
026ad283
PM
415#define RCU_JIFFIES_FQS_DIV 256 /* Very large systems need more */
416 /* delay between bouts of */
417 /* quiescent-state forcing. */
418
419#define RCU_STALL_RAT_DELAY 2 /* Allow other CPUs time to take */
420 /* at least one scheduling clock */
421 /* irq before ratting on them. */
9f77da9f 422
08bca60a
PZ
423#define rcu_wait(cond) \
424do { \
425 for (;;) { \
426 set_current_state(TASK_INTERRUPTIBLE); \
427 if (cond) \
428 break; \
429 schedule(); \
430 } \
431 __set_current_state(TASK_RUNNING); \
432} while (0)
9f77da9f
PM
433
434/*
435 * RCU global state, including node hierarchy. This hierarchy is
436 * represented in "heap" form in a dense array. The root (first level)
437 * of the hierarchy is in ->node[0] (referenced by ->level[0]), the second
438 * level in ->node[1] through ->node[m] (->node[1] referenced by ->level[1]),
439 * and the third level in ->node[m+1] and following (->node[m+1] referenced
440 * by ->level[2]). The number of levels is determined by the number of
441 * CPUs and by CONFIG_RCU_FANOUT. Small systems will have a "hierarchy"
442 * consisting of a single rcu_node.
443 */
444struct rcu_state {
445 struct rcu_node node[NUM_RCU_NODES]; /* Hierarchy. */
f885b7f2 446 struct rcu_node *level[RCU_NUM_LVLS]; /* Hierarchy levels. */
4a81e832 447 u8 flavor_mask; /* bit in flavor mask. */
394f99a9 448 struct rcu_data __percpu *rda; /* pointer of percu rcu_data. */
037b64ed
PM
449 void (*call)(struct rcu_head *head, /* call_rcu() flavor. */
450 void (*func)(struct rcu_head *head));
9f77da9f
PM
451
452 /* The following fields are guarded by the root rcu_node's lock. */
453
af446b70 454 u8 fqs_state ____cacheline_internodealigned_in_smp;
9f77da9f 455 /* Force QS state. */
a46e0899 456 u8 boost; /* Subject to priority boost. */
20133cfc
PM
457 unsigned long gpnum; /* Current gp number. */
458 unsigned long completed; /* # of last completed gp. */
b3dbec76
PM
459 struct task_struct *gp_kthread; /* Task for grace periods. */
460 wait_queue_head_t gp_wq; /* Where GP task waits. */
afea227f
PM
461 short gp_flags; /* Commands for GP task. */
462 short gp_state; /* GP kthread sleep state. */
1eba8f84 463
d9a3da06 464 /* End of fields guarded by root rcu_node's lock. */
1eba8f84 465
7b2e6011
PM
466 raw_spinlock_t orphan_lock ____cacheline_internodealigned_in_smp;
467 /* Protect following fields. */
b1420f1c
PM
468 struct rcu_head *orphan_nxtlist; /* Orphaned callbacks that */
469 /* need a grace period. */
470 struct rcu_head **orphan_nxttail; /* Tail of above. */
471 struct rcu_head *orphan_donelist; /* Orphaned callbacks that */
472 /* are ready to invoke. */
473 struct rcu_head **orphan_donetail; /* Tail of above. */
474 long qlen_lazy; /* Number of lazy callbacks. */
475 long qlen; /* Total number of callbacks. */
7b2e6011 476 /* End of fields guarded by orphan_lock. */
a4fbe35a 477
7be7f0be 478 struct mutex barrier_mutex; /* Guards barrier fields. */
24ebbca8 479 atomic_t barrier_cpu_count; /* # CPUs waiting on. */
7db74df8 480 struct completion barrier_completion; /* Wake at barrier end. */
cf3a9c48
PM
481 unsigned long n_barrier_done; /* ++ at start and end of */
482 /* _rcu_barrier(). */
a4fbe35a
PM
483 /* End of fields guarded by barrier_mutex. */
484
40694d66
PM
485 atomic_long_t expedited_start; /* Starting ticket. */
486 atomic_long_t expedited_done; /* Done ticket. */
a30489c5
PM
487 atomic_long_t expedited_wrap; /* # near-wrap incidents. */
488 atomic_long_t expedited_tryfail; /* # acquisition failures. */
489 atomic_long_t expedited_workdone1; /* # done by others #1. */
490 atomic_long_t expedited_workdone2; /* # done by others #2. */
491 atomic_long_t expedited_normal; /* # fallbacks to normal. */
492 atomic_long_t expedited_stoppedcpus; /* # successful stop_cpus. */
493 atomic_long_t expedited_done_tries; /* # tries to update _done. */
494 atomic_long_t expedited_done_lost; /* # times beaten to _done. */
495 atomic_long_t expedited_done_exit; /* # times exited _done loop. */
40694d66 496
9f77da9f
PM
497 unsigned long jiffies_force_qs; /* Time at which to invoke */
498 /* force_quiescent_state(). */
499 unsigned long n_force_qs; /* Number of calls to */
500 /* force_quiescent_state(). */
501 unsigned long n_force_qs_lh; /* ~Number of calls leaving */
502 /* due to lock unavailable. */
503 unsigned long n_force_qs_ngp; /* Number of calls leaving */
504 /* due to no GP active. */
9f77da9f
PM
505 unsigned long gp_start; /* Time at which GP started, */
506 /* but in jiffies. */
6ccd2ecd
PM
507 unsigned long gp_activity; /* Time of last GP kthread */
508 /* activity in jiffies. */
9f77da9f
PM
509 unsigned long jiffies_stall; /* Time at which to check */
510 /* for CPU stalls. */
6193c76a
PM
511 unsigned long jiffies_resched; /* Time at which to resched */
512 /* a reluctant CPU. */
fc908ed3
PM
513 unsigned long n_force_qs_gpstart; /* Snapshot of n_force_qs at */
514 /* GP start. */
15ba0ba8
PM
515 unsigned long gp_max; /* Maximum GP duration in */
516 /* jiffies. */
e66c33d5 517 const char *name; /* Name of structure. */
a4889858 518 char abbr; /* Abbreviated name. */
6ce75a23 519 struct list_head flavors; /* List of RCU flavors. */
9f77da9f
PM
520};
521
4cdfc175
PM
522/* Values for rcu_state structure's gp_flags field. */
523#define RCU_GP_FLAG_INIT 0x1 /* Need grace-period initialization. */
524#define RCU_GP_FLAG_FQS 0x2 /* Need grace-period quiescent-state forcing. */
525
afea227f
PM
526/* Values for rcu_state structure's gp_flags field. */
527#define RCU_GP_WAIT_INIT 0 /* Initial state. */
528#define RCU_GP_WAIT_GPS 1 /* Wait for grace-period start. */
319362c9
PM
529#define RCU_GP_DONE_GPS 2 /* Wait done for grace-period start. */
530#define RCU_GP_WAIT_FQS 3 /* Wait for force-quiescent-state time. */
531#define RCU_GP_DONE_FQS 4 /* Wait done for force-quiescent-state time. */
532#define RCU_GP_CLEANUP 5 /* Grace-period cleanup started. */
533#define RCU_GP_CLEANED 6 /* Grace-period cleanup complete. */
afea227f 534
6ce75a23 535extern struct list_head rcu_struct_flavors;
3fbfbf7a
PM
536
537/* Sequence through rcu_state structures for each RCU flavor. */
6ce75a23
PM
538#define for_each_rcu_flavor(rsp) \
539 list_for_each_entry((rsp), &rcu_struct_flavors, flavors)
540
6258c4fb
IM
541/*
542 * RCU implementation internal declarations:
543 */
d6714c22 544extern struct rcu_state rcu_sched_state;
6258c4fb
IM
545
546extern struct rcu_state rcu_bh_state;
6258c4fb 547
28f6569a 548#ifdef CONFIG_PREEMPT_RCU
f41d911f 549extern struct rcu_state rcu_preempt_state;
28f6569a 550#endif /* #ifdef CONFIG_PREEMPT_RCU */
f41d911f 551
eab0993c
PM
552#ifdef CONFIG_RCU_BOOST
553DECLARE_PER_CPU(unsigned int, rcu_cpu_kthread_status);
554DECLARE_PER_CPU(int, rcu_cpu_kthread_cpu);
555DECLARE_PER_CPU(unsigned int, rcu_cpu_kthread_loops);
556DECLARE_PER_CPU(char, rcu_cpu_has_work);
557#endif /* #ifdef CONFIG_RCU_BOOST */
558
017c4261 559#ifndef RCU_TREE_NONCORE
9f77da9f 560
9b2619af 561/* Forward declarations for rcutree_plugin.h */
dbe01350 562static void rcu_bootup_announce(void);
38200cf2 563static void rcu_preempt_note_context_switch(void);
27f4d280 564static int rcu_preempt_blocked_readers_cgp(struct rcu_node *rnp);
b668c9cf 565#ifdef CONFIG_HOTPLUG_CPU
8af3a5e7 566static bool rcu_preempt_has_tasks(struct rcu_node *rnp);
b668c9cf 567#endif /* #ifdef CONFIG_HOTPLUG_CPU */
1ed509a2 568static void rcu_print_detail_task_stall(struct rcu_state *rsp);
9bc8b558 569static int rcu_print_task_stall(struct rcu_node *rnp);
9b2619af 570static void rcu_preempt_check_blocked_tasks(struct rcu_node *rnp);
86aea0e6 571static void rcu_preempt_check_callbacks(void);
9b2619af 572void call_rcu(struct rcu_head *head, void (*func)(struct rcu_head *rcu));
9b2619af 573static void __init __rcu_init_preempt(void);
1217ed1b 574static void rcu_initiate_boost(struct rcu_node *rnp, unsigned long flags);
a46e0899
PM
575static void rcu_preempt_boost_start_gp(struct rcu_node *rnp);
576static void invoke_rcu_callbacks_kthread(void);
dff1672d 577static bool rcu_is_callbacks_kthread(void);
a46e0899
PM
578#ifdef CONFIG_RCU_BOOST
579static void rcu_preempt_do_callbacks(void);
49fb4c62 580static int rcu_spawn_one_boost_kthread(struct rcu_state *rsp,
5d01bbd1 581 struct rcu_node *rnp);
a46e0899 582#endif /* #ifdef CONFIG_RCU_BOOST */
9386c0b7 583static void __init rcu_spawn_boost_kthreads(void);
49fb4c62 584static void rcu_prepare_kthreads(int cpu);
8fa7845d 585static void rcu_cleanup_after_idle(void);
198bbf81 586static void rcu_prepare_for_idle(void);
c57afe80 587static void rcu_idle_count_callbacks_posted(void);
0aa04b05 588static bool rcu_preempt_has_tasks(struct rcu_node *rnp);
a858af28
PM
589static void print_cpu_stall_info_begin(void);
590static void print_cpu_stall_info(struct rcu_state *rsp, int cpu);
591static void print_cpu_stall_info_end(void);
592static void zero_cpu_stall_ticks(struct rcu_data *rdp);
593static void increment_cpu_stall_ticks(void);
d7e29933 594static bool rcu_nocb_cpu_needs_barrier(struct rcu_state *rsp, int cpu);
dae6e64d 595static void rcu_nocb_gp_set(struct rcu_node *rnp, int nrq);
0446be48 596static void rcu_nocb_gp_cleanup(struct rcu_state *rsp, struct rcu_node *rnp);
dae6e64d 597static void rcu_init_one_nocb(struct rcu_node *rnp);
3fbfbf7a 598static bool __call_rcu_nocb(struct rcu_data *rdp, struct rcu_head *rhp,
96d3fd0d 599 bool lazy, unsigned long flags);
3fbfbf7a 600static bool rcu_nocb_adopt_orphan_cbs(struct rcu_state *rsp,
96d3fd0d
PM
601 struct rcu_data *rdp,
602 unsigned long flags);
9fdd3bc9 603static int rcu_nocb_need_deferred_wakeup(struct rcu_data *rdp);
96d3fd0d 604static void do_nocb_deferred_wakeup(struct rcu_data *rdp);
3fbfbf7a 605static void rcu_boot_init_nocb_percpu_data(struct rcu_data *rdp);
35ce7f29
PM
606static void rcu_spawn_all_nocb_kthreads(int cpu);
607static void __init rcu_spawn_nocb_kthreads(void);
608#ifdef CONFIG_RCU_NOCB_CPU
609static void __init rcu_organize_nocb_kthreads(struct rcu_state *rsp);
610#endif /* #ifdef CONFIG_RCU_NOCB_CPU */
4a81e832 611static void __maybe_unused rcu_kick_nohz_cpu(int cpu);
34ed6246 612static bool init_nocb_callback_list(struct rcu_data *rdp);
28ced795
CL
613static void rcu_sysidle_enter(int irq);
614static void rcu_sysidle_exit(int irq);
0edd1b17
PM
615static void rcu_sysidle_check_cpu(struct rcu_data *rdp, bool *isidle,
616 unsigned long *maxj);
617static bool is_sysidle_rcu_state(struct rcu_state *rsp);
618static void rcu_sysidle_report_gp(struct rcu_state *rsp, int isidle,
619 unsigned long maxj);
eb75767b 620static void rcu_bind_gp_kthread(void);
2333210b 621static void rcu_sysidle_init_percpu_data(struct rcu_dynticks *rdtp);
a096932f 622static bool rcu_nohz_full_cpu(struct rcu_state *rsp);
176f8f7a
PM
623static void rcu_dynticks_task_enter(void);
624static void rcu_dynticks_task_exit(void);
9b2619af 625
017c4261 626#endif /* #ifndef RCU_TREE_NONCORE */
3fbfbf7a
PM
627
628#ifdef CONFIG_RCU_TRACE
41050a00 629/* Read out queue lengths for tracing. */
3fbfbf7a
PM
630static inline void rcu_nocb_q_lengths(struct rcu_data *rdp, long *ql, long *qll)
631{
41050a00
PM
632#ifdef CONFIG_RCU_NOCB_CPU
633 *ql = atomic_long_read(&rdp->nocb_q_count);
634 *qll = atomic_long_read(&rdp->nocb_q_count_lazy);
3fbfbf7a 635#else /* #ifdef CONFIG_RCU_NOCB_CPU */
3fbfbf7a
PM
636 *ql = 0;
637 *qll = 0;
3fbfbf7a 638#endif /* #else #ifdef CONFIG_RCU_NOCB_CPU */
41050a00 639}
3fbfbf7a 640#endif /* #ifdef CONFIG_RCU_TRACE */