2 * Read-Copy Update mechanism for mutual exclusion (tree-based version)
3 * Internal non-public definitions.
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.
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.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
19 * Copyright IBM Corporation, 2008
21 * Author: Ingo Molnar <mingo@elte.hu>
22 * Paul E. McKenney <paulmck@linux.vnet.ibm.com>
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>
32 * Define shape of hierarchy based on NR_CPUS, CONFIG_RCU_FANOUT, and
33 * CONFIG_RCU_FANOUT_LEAF.
34 * In theory, it should be possible to add more levels straightforwardly.
35 * In practice, this did work well going from three levels to four.
36 * Of course, your mileage may vary.
38 #define MAX_RCU_LVLS 4
39 #define RCU_FANOUT_1 (CONFIG_RCU_FANOUT_LEAF)
40 #define RCU_FANOUT_2 (RCU_FANOUT_1 * CONFIG_RCU_FANOUT)
41 #define RCU_FANOUT_3 (RCU_FANOUT_2 * CONFIG_RCU_FANOUT)
42 #define RCU_FANOUT_4 (RCU_FANOUT_3 * CONFIG_RCU_FANOUT)
44 #if NR_CPUS <= RCU_FANOUT_1
45 # define NUM_RCU_LVLS 1
46 # define NUM_RCU_LVL_0 1
47 # define NUM_RCU_LVL_1 (NR_CPUS)
48 # define NUM_RCU_LVL_2 0
49 # define NUM_RCU_LVL_3 0
50 # define NUM_RCU_LVL_4 0
51 #elif NR_CPUS <= RCU_FANOUT_2
52 # define NUM_RCU_LVLS 2
53 # define NUM_RCU_LVL_0 1
54 # define NUM_RCU_LVL_1 DIV_ROUND_UP(NR_CPUS, RCU_FANOUT_1)
55 # define NUM_RCU_LVL_2 (NR_CPUS)
56 # define NUM_RCU_LVL_3 0
57 # define NUM_RCU_LVL_4 0
58 #elif NR_CPUS <= RCU_FANOUT_3
59 # define NUM_RCU_LVLS 3
60 # define NUM_RCU_LVL_0 1
61 # define NUM_RCU_LVL_1 DIV_ROUND_UP(NR_CPUS, RCU_FANOUT_2)
62 # define NUM_RCU_LVL_2 DIV_ROUND_UP(NR_CPUS, RCU_FANOUT_1)
63 # define NUM_RCU_LVL_3 (NR_CPUS)
64 # define NUM_RCU_LVL_4 0
65 #elif NR_CPUS <= RCU_FANOUT_4
66 # define NUM_RCU_LVLS 4
67 # define NUM_RCU_LVL_0 1
68 # define NUM_RCU_LVL_1 DIV_ROUND_UP(NR_CPUS, RCU_FANOUT_3)
69 # define NUM_RCU_LVL_2 DIV_ROUND_UP(NR_CPUS, RCU_FANOUT_2)
70 # define NUM_RCU_LVL_3 DIV_ROUND_UP(NR_CPUS, RCU_FANOUT_1)
71 # define NUM_RCU_LVL_4 (NR_CPUS)
73 # error "CONFIG_RCU_FANOUT insufficient for NR_CPUS"
74 #endif /* #if (NR_CPUS) <= RCU_FANOUT_1 */
76 #define RCU_SUM (NUM_RCU_LVL_0 + NUM_RCU_LVL_1 + NUM_RCU_LVL_2 + NUM_RCU_LVL_3 + NUM_RCU_LVL_4)
77 #define NUM_RCU_NODES (RCU_SUM - NR_CPUS)
80 * Dynticks per-CPU state.
83 long long dynticks_nesting; /* Track irq/process nesting level. */
84 /* Process level is worth LLONG_MAX/2. */
85 int dynticks_nmi_nesting; /* Track NMI nesting level. */
86 atomic_t dynticks; /* Even value for idle, else odd. */
89 /* RCU's kthread states for tracing. */
90 #define RCU_KTHREAD_STOPPED 0
91 #define RCU_KTHREAD_RUNNING 1
92 #define RCU_KTHREAD_WAITING 2
93 #define RCU_KTHREAD_OFFCPU 3
94 #define RCU_KTHREAD_YIELDING 4
95 #define RCU_KTHREAD_MAX 4
98 * Definition for node within the RCU grace-period-detection hierarchy.
101 raw_spinlock_t lock; /* Root rcu_node's lock protects some */
102 /* rcu_state fields as well as following. */
103 unsigned long gpnum; /* Current grace period for this node. */
104 /* This will either be equal to or one */
105 /* behind the root rcu_node's gpnum. */
106 unsigned long completed; /* Last GP completed for this node. */
107 /* This will either be equal to or one */
108 /* behind the root rcu_node's gpnum. */
109 unsigned long qsmask; /* CPUs or groups that need to switch in */
110 /* order for current grace period to proceed.*/
111 /* In leaf rcu_node, each bit corresponds to */
112 /* an rcu_data structure, otherwise, each */
113 /* bit corresponds to a child rcu_node */
115 unsigned long expmask; /* Groups that have ->blkd_tasks */
116 /* elements that need to drain to allow the */
117 /* current expedited grace period to */
118 /* complete (only for TREE_PREEMPT_RCU). */
119 atomic_t wakemask; /* CPUs whose kthread needs to be awakened. */
120 /* Since this has meaning only for leaf */
121 /* rcu_node structures, 32 bits suffices. */
122 unsigned long qsmaskinit;
123 /* Per-GP initial value for qsmask & expmask. */
124 unsigned long grpmask; /* Mask to apply to parent qsmask. */
125 /* Only one bit will be set in this mask. */
126 int grplo; /* lowest-numbered CPU or group here. */
127 int grphi; /* highest-numbered CPU or group here. */
128 u8 grpnum; /* CPU/group number for next level up. */
129 u8 level; /* root is at level 0. */
130 struct rcu_node *parent;
131 struct list_head blkd_tasks;
132 /* Tasks blocked in RCU read-side critical */
133 /* section. Tasks are placed at the head */
134 /* of this list and age towards the tail. */
135 struct list_head *gp_tasks;
136 /* Pointer to the first task blocking the */
137 /* current grace period, or NULL if there */
138 /* is no such task. */
139 struct list_head *exp_tasks;
140 /* Pointer to the first task blocking the */
141 /* current expedited grace period, or NULL */
142 /* if there is no such task. If there */
143 /* is no current expedited grace period, */
144 /* then there can cannot be any such task. */
145 #ifdef CONFIG_RCU_BOOST
146 struct list_head *boost_tasks;
147 /* Pointer to first task that needs to be */
148 /* priority boosted, or NULL if no priority */
149 /* boosting is needed for this rcu_node */
150 /* structure. If there are no tasks */
151 /* queued on this rcu_node structure that */
152 /* are blocking the current grace period, */
153 /* there can be no such task. */
154 unsigned long boost_time;
155 /* When to start boosting (jiffies). */
156 struct task_struct *boost_kthread_task;
157 /* kthread that takes care of priority */
158 /* boosting for this rcu_node structure. */
159 unsigned int boost_kthread_status;
160 /* State of boost_kthread_task for tracing. */
161 unsigned long n_tasks_boosted;
162 /* Total number of tasks boosted. */
163 unsigned long n_exp_boosts;
164 /* Number of tasks boosted for expedited GP. */
165 unsigned long n_normal_boosts;
166 /* Number of tasks boosted for normal GP. */
167 unsigned long n_balk_blkd_tasks;
168 /* Refused to boost: no blocked tasks. */
169 unsigned long n_balk_exp_gp_tasks;
170 /* Refused to boost: nothing blocking GP. */
171 unsigned long n_balk_boost_tasks;
172 /* Refused to boost: already boosting. */
173 unsigned long n_balk_notblocked;
174 /* Refused to boost: RCU RS CS still running. */
175 unsigned long n_balk_notyet;
176 /* Refused to boost: not yet time. */
177 unsigned long n_balk_nos;
178 /* Refused to boost: not sure why, though. */
179 /* This can happen due to race conditions. */
180 #endif /* #ifdef CONFIG_RCU_BOOST */
181 struct task_struct *node_kthread_task;
182 /* kthread that takes care of this rcu_node */
183 /* structure, for example, awakening the */
184 /* per-CPU kthreads as needed. */
185 unsigned int node_kthread_status;
186 /* State of node_kthread_task for tracing. */
187 } ____cacheline_internodealigned_in_smp;
190 * Do a full breadth-first scan of the rcu_node structures for the
191 * specified rcu_state structure.
193 #define rcu_for_each_node_breadth_first(rsp, rnp) \
194 for ((rnp) = &(rsp)->node[0]; \
195 (rnp) < &(rsp)->node[NUM_RCU_NODES]; (rnp)++)
198 * Do a breadth-first scan of the non-leaf rcu_node structures for the
199 * specified rcu_state structure. Note that if there is a singleton
200 * rcu_node tree with but one rcu_node structure, this loop is a no-op.
202 #define rcu_for_each_nonleaf_node_breadth_first(rsp, rnp) \
203 for ((rnp) = &(rsp)->node[0]; \
204 (rnp) < (rsp)->level[NUM_RCU_LVLS - 1]; (rnp)++)
207 * Scan the leaves of the rcu_node hierarchy for the specified rcu_state
208 * structure. Note that if there is a singleton rcu_node tree with but
209 * one rcu_node structure, this loop -will- visit the rcu_node structure.
210 * It is still a leaf node, even if it is also the root node.
212 #define rcu_for_each_leaf_node(rsp, rnp) \
213 for ((rnp) = (rsp)->level[NUM_RCU_LVLS - 1]; \
214 (rnp) < &(rsp)->node[NUM_RCU_NODES]; (rnp)++)
216 /* Index values for nxttail array in struct rcu_data. */
217 #define RCU_DONE_TAIL 0 /* Also RCU_WAIT head. */
218 #define RCU_WAIT_TAIL 1 /* Also RCU_NEXT_READY head. */
219 #define RCU_NEXT_READY_TAIL 2 /* Also RCU_NEXT head. */
220 #define RCU_NEXT_TAIL 3
221 #define RCU_NEXT_SIZE 4
223 /* Per-CPU data for read-copy update. */
225 /* 1) quiescent-state and grace-period handling : */
226 unsigned long completed; /* Track rsp->completed gp number */
227 /* in order to detect GP end. */
228 unsigned long gpnum; /* Highest gp number that this CPU */
229 /* is aware of having started. */
230 unsigned long passed_quiesce_gpnum;
231 /* gpnum at time of quiescent state. */
232 bool passed_quiesce; /* User-mode/idle loop etc. */
233 bool qs_pending; /* Core waits for quiesc state. */
234 bool beenonline; /* CPU online at least once. */
235 bool preemptible; /* Preemptible RCU? */
236 struct rcu_node *mynode; /* This CPU's leaf of hierarchy */
237 unsigned long grpmask; /* Mask to apply to leaf qsmask. */
238 #ifdef CONFIG_RCU_CPU_STALL_INFO
239 unsigned long ticks_this_gp; /* The number of scheduling-clock */
240 /* ticks this CPU has handled */
241 /* during and after the last grace */
242 /* period it is aware of. */
243 #endif /* #ifdef CONFIG_RCU_CPU_STALL_INFO */
245 /* 2) batch handling */
247 * If nxtlist is not NULL, it is partitioned as follows.
248 * Any of the partitions might be empty, in which case the
249 * pointer to that partition will be equal to the pointer for
250 * the following partition. When the list is empty, all of
251 * the nxttail elements point to the ->nxtlist pointer itself,
252 * which in that case is NULL.
254 * [nxtlist, *nxttail[RCU_DONE_TAIL]):
255 * Entries that batch # <= ->completed
256 * The grace period for these entries has completed, and
257 * the other grace-period-completed entries may be moved
258 * here temporarily in rcu_process_callbacks().
259 * [*nxttail[RCU_DONE_TAIL], *nxttail[RCU_WAIT_TAIL]):
260 * Entries that batch # <= ->completed - 1: waiting for current GP
261 * [*nxttail[RCU_WAIT_TAIL], *nxttail[RCU_NEXT_READY_TAIL]):
262 * Entries known to have arrived before current GP ended
263 * [*nxttail[RCU_NEXT_READY_TAIL], *nxttail[RCU_NEXT_TAIL]):
264 * Entries that might have arrived after current GP ended
265 * Note that the value of *nxttail[RCU_NEXT_TAIL] will
266 * always be NULL, as this is the end of the list.
268 struct rcu_head *nxtlist;
269 struct rcu_head **nxttail[RCU_NEXT_SIZE];
270 long qlen_lazy; /* # of lazy queued callbacks */
271 long qlen; /* # of queued callbacks, incl lazy */
272 long qlen_last_fqs_check;
273 /* qlen at last check for QS forcing */
274 unsigned long n_cbs_invoked; /* count of RCU cbs invoked. */
275 unsigned long n_cbs_orphaned; /* RCU cbs orphaned by dying CPU */
276 unsigned long n_cbs_adopted; /* RCU cbs adopted from dying CPU */
277 unsigned long n_force_qs_snap;
278 /* did other CPU force QS recently? */
279 long blimit; /* Upper limit on a processed batch */
281 /* 3) dynticks interface. */
282 struct rcu_dynticks *dynticks; /* Shared per-CPU dynticks state. */
283 int dynticks_snap; /* Per-GP tracking for dynticks. */
285 /* 4) reasons this CPU needed to be kicked by force_quiescent_state */
286 unsigned long dynticks_fqs; /* Kicked due to dynticks idle. */
287 unsigned long offline_fqs; /* Kicked due to being offline. */
289 /* 5) __rcu_pending() statistics. */
290 unsigned long n_rcu_pending; /* rcu_pending() calls since boot. */
291 unsigned long n_rp_qs_pending;
292 unsigned long n_rp_report_qs;
293 unsigned long n_rp_cb_ready;
294 unsigned long n_rp_cpu_needs_gp;
295 unsigned long n_rp_gp_completed;
296 unsigned long n_rp_gp_started;
297 unsigned long n_rp_need_fqs;
298 unsigned long n_rp_need_nothing;
301 struct rcu_state *rsp;
304 /* Values for fqs_state field in struct rcu_state. */
305 #define RCU_GP_IDLE 0 /* No grace period in progress. */
306 #define RCU_GP_INIT 1 /* Grace period being initialized. */
307 #define RCU_SAVE_DYNTICK 2 /* Need to scan dyntick state. */
308 #define RCU_FORCE_QS 3 /* Need to force quiescent state. */
309 #define RCU_SIGNAL_INIT RCU_SAVE_DYNTICK
311 #define RCU_JIFFIES_TILL_FORCE_QS 3 /* for rsp->jiffies_force_qs */
313 #ifdef CONFIG_PROVE_RCU
314 #define RCU_STALL_DELAY_DELTA (5 * HZ)
316 #define RCU_STALL_DELAY_DELTA 0
318 #define RCU_STALL_RAT_DELAY 2 /* Allow other CPUs time */
319 /* to take at least one */
320 /* scheduling clock irq */
321 /* before ratting on them. */
323 #define rcu_wait(cond) \
326 set_current_state(TASK_INTERRUPTIBLE); \
331 __set_current_state(TASK_RUNNING); \
335 * RCU global state, including node hierarchy. This hierarchy is
336 * represented in "heap" form in a dense array. The root (first level)
337 * of the hierarchy is in ->node[0] (referenced by ->level[0]), the second
338 * level in ->node[1] through ->node[m] (->node[1] referenced by ->level[1]),
339 * and the third level in ->node[m+1] and following (->node[m+1] referenced
340 * by ->level[2]). The number of levels is determined by the number of
341 * CPUs and by CONFIG_RCU_FANOUT. Small systems will have a "hierarchy"
342 * consisting of a single rcu_node.
345 struct rcu_node node[NUM_RCU_NODES]; /* Hierarchy. */
346 struct rcu_node *level[NUM_RCU_LVLS]; /* Hierarchy levels. */
347 u32 levelcnt[MAX_RCU_LVLS + 1]; /* # nodes in each level. */
348 u8 levelspread[NUM_RCU_LVLS]; /* kids/node in each level. */
349 struct rcu_data __percpu *rda; /* pointer of percu rcu_data. */
351 /* The following fields are guarded by the root rcu_node's lock. */
353 u8 fqs_state ____cacheline_internodealigned_in_smp;
354 /* Force QS state. */
355 u8 fqs_active; /* force_quiescent_state() */
357 u8 fqs_need_gp; /* A CPU was prevented from */
358 /* starting a new grace */
360 /* force_quiescent_state() */
362 u8 boost; /* Subject to priority boost. */
363 unsigned long gpnum; /* Current gp number. */
364 unsigned long completed; /* # of last completed gp. */
366 /* End of fields guarded by root rcu_node's lock. */
368 raw_spinlock_t onofflock; /* exclude on/offline and */
369 /* starting new GP. */
370 struct rcu_head *orphan_nxtlist; /* Orphaned callbacks that */
371 /* need a grace period. */
372 struct rcu_head **orphan_nxttail; /* Tail of above. */
373 struct rcu_head *orphan_donelist; /* Orphaned callbacks that */
374 /* are ready to invoke. */
375 struct rcu_head **orphan_donetail; /* Tail of above. */
376 long qlen_lazy; /* Number of lazy callbacks. */
377 long qlen; /* Total number of callbacks. */
378 struct task_struct *rcu_barrier_in_progress;
379 /* Task doing rcu_barrier(), */
380 /* or NULL if no barrier. */
381 raw_spinlock_t fqslock; /* Only one task forcing */
382 /* quiescent states. */
383 unsigned long jiffies_force_qs; /* Time at which to invoke */
384 /* force_quiescent_state(). */
385 unsigned long n_force_qs; /* Number of calls to */
386 /* force_quiescent_state(). */
387 unsigned long n_force_qs_lh; /* ~Number of calls leaving */
388 /* due to lock unavailable. */
389 unsigned long n_force_qs_ngp; /* Number of calls leaving */
390 /* due to no GP active. */
391 unsigned long gp_start; /* Time at which GP started, */
392 /* but in jiffies. */
393 unsigned long jiffies_stall; /* Time at which to check */
394 /* for CPU stalls. */
395 unsigned long gp_max; /* Maximum GP duration in */
397 char *name; /* Name of structure. */
400 /* Return values for rcu_preempt_offline_tasks(). */
402 #define RCU_OFL_TASKS_NORM_GP 0x1 /* Tasks blocking normal */
403 /* GP were moved to root. */
404 #define RCU_OFL_TASKS_EXP_GP 0x2 /* Tasks blocking expedited */
405 /* GP were moved to root. */
408 * RCU implementation internal declarations:
410 extern struct rcu_state rcu_sched_state;
411 DECLARE_PER_CPU(struct rcu_data, rcu_sched_data);
413 extern struct rcu_state rcu_bh_state;
414 DECLARE_PER_CPU(struct rcu_data, rcu_bh_data);
416 #ifdef CONFIG_TREE_PREEMPT_RCU
417 extern struct rcu_state rcu_preempt_state;
418 DECLARE_PER_CPU(struct rcu_data, rcu_preempt_data);
419 #endif /* #ifdef CONFIG_TREE_PREEMPT_RCU */
421 #ifdef CONFIG_RCU_BOOST
422 DECLARE_PER_CPU(unsigned int, rcu_cpu_kthread_status);
423 DECLARE_PER_CPU(int, rcu_cpu_kthread_cpu);
424 DECLARE_PER_CPU(unsigned int, rcu_cpu_kthread_loops);
425 DECLARE_PER_CPU(char, rcu_cpu_has_work);
426 #endif /* #ifdef CONFIG_RCU_BOOST */
428 #ifndef RCU_TREE_NONCORE
430 /* Forward declarations for rcutree_plugin.h */
431 static void rcu_bootup_announce(void);
432 long rcu_batches_completed(void);
433 static int rcu_preempt_blocked_readers_cgp(struct rcu_node *rnp);
434 #ifdef CONFIG_HOTPLUG_CPU
435 static void rcu_report_unblock_qs_rnp(struct rcu_node *rnp,
436 unsigned long flags);
437 static void rcu_stop_cpu_kthread(int cpu);
438 #endif /* #ifdef CONFIG_HOTPLUG_CPU */
439 static void rcu_print_detail_task_stall(struct rcu_state *rsp);
440 static int rcu_print_task_stall(struct rcu_node *rnp);
441 static void rcu_preempt_stall_reset(void);
442 static void rcu_preempt_check_blocked_tasks(struct rcu_node *rnp);
443 #ifdef CONFIG_HOTPLUG_CPU
444 static int rcu_preempt_offline_tasks(struct rcu_state *rsp,
445 struct rcu_node *rnp,
446 struct rcu_data *rdp);
447 #endif /* #ifdef CONFIG_HOTPLUG_CPU */
448 static void rcu_preempt_cleanup_dead_cpu(int cpu);
449 static void rcu_preempt_check_callbacks(int cpu);
450 static void rcu_preempt_process_callbacks(void);
451 void call_rcu(struct rcu_head *head, void (*func)(struct rcu_head *rcu));
452 #if defined(CONFIG_HOTPLUG_CPU) || defined(CONFIG_TREE_PREEMPT_RCU)
453 static void rcu_report_exp_rnp(struct rcu_state *rsp, struct rcu_node *rnp,
455 #endif /* #if defined(CONFIG_HOTPLUG_CPU) || defined(CONFIG_TREE_PREEMPT_RCU) */
456 static int rcu_preempt_pending(int cpu);
457 static int rcu_preempt_cpu_has_callbacks(int cpu);
458 static void __cpuinit rcu_preempt_init_percpu_data(int cpu);
459 static void rcu_preempt_cleanup_dying_cpu(void);
460 static void __init __rcu_init_preempt(void);
461 static void rcu_initiate_boost(struct rcu_node *rnp, unsigned long flags);
462 static void rcu_preempt_boost_start_gp(struct rcu_node *rnp);
463 static void invoke_rcu_callbacks_kthread(void);
464 static bool rcu_is_callbacks_kthread(void);
465 #ifdef CONFIG_RCU_BOOST
466 static void rcu_preempt_do_callbacks(void);
467 static void rcu_boost_kthread_setaffinity(struct rcu_node *rnp,
469 static int __cpuinit rcu_spawn_one_boost_kthread(struct rcu_state *rsp,
470 struct rcu_node *rnp,
472 static void invoke_rcu_node_kthread(struct rcu_node *rnp);
473 static void rcu_yield(void (*f)(unsigned long), unsigned long arg);
474 #endif /* #ifdef CONFIG_RCU_BOOST */
475 static void rcu_cpu_kthread_setrt(int cpu, int to_rt);
476 static void __cpuinit rcu_prepare_kthreads(int cpu);
477 static void rcu_prepare_for_idle_init(int cpu);
478 static void rcu_cleanup_after_idle(int cpu);
479 static void rcu_prepare_for_idle(int cpu);
480 static void rcu_idle_count_callbacks_posted(void);
481 static void print_cpu_stall_info_begin(void);
482 static void print_cpu_stall_info(struct rcu_state *rsp, int cpu);
483 static void print_cpu_stall_info_end(void);
484 static void zero_cpu_stall_ticks(struct rcu_data *rdp);
485 static void increment_cpu_stall_ticks(void);
487 #endif /* #ifndef RCU_TREE_NONCORE */