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