rcu: Decrease memory-barrier usage based on semi-formal proof
[linux-2.6.git] / kernel / rcutree.h
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
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.
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 /*
32  * Define shape of hierarchy based on NR_CPUS and CONFIG_RCU_FANOUT.
33  * In theory, it should be possible to add more levels straightforwardly.
34  * In practice, this did work well going from three levels to four.
35  * Of course, your mileage may vary.
36  */
37 #define MAX_RCU_LVLS 4
38 #if CONFIG_RCU_FANOUT > 16
39 #define RCU_FANOUT_LEAF       16
40 #else /* #if CONFIG_RCU_FANOUT > 16 */
41 #define RCU_FANOUT_LEAF       (CONFIG_RCU_FANOUT)
42 #endif /* #else #if CONFIG_RCU_FANOUT > 16 */
43 #define RCU_FANOUT_1          (RCU_FANOUT_LEAF)
44 #define RCU_FANOUT_2          (RCU_FANOUT_1 * CONFIG_RCU_FANOUT)
45 #define RCU_FANOUT_3          (RCU_FANOUT_2 * CONFIG_RCU_FANOUT)
46 #define RCU_FANOUT_4          (RCU_FANOUT_3 * CONFIG_RCU_FANOUT)
47
48 #if NR_CPUS <= RCU_FANOUT_1
49 #  define NUM_RCU_LVLS        1
50 #  define NUM_RCU_LVL_0       1
51 #  define NUM_RCU_LVL_1       (NR_CPUS)
52 #  define NUM_RCU_LVL_2       0
53 #  define NUM_RCU_LVL_3       0
54 #  define NUM_RCU_LVL_4       0
55 #elif NR_CPUS <= RCU_FANOUT_2
56 #  define NUM_RCU_LVLS        2
57 #  define NUM_RCU_LVL_0       1
58 #  define NUM_RCU_LVL_1       DIV_ROUND_UP(NR_CPUS, RCU_FANOUT_1)
59 #  define NUM_RCU_LVL_2       (NR_CPUS)
60 #  define NUM_RCU_LVL_3       0
61 #  define NUM_RCU_LVL_4       0
62 #elif NR_CPUS <= RCU_FANOUT_3
63 #  define NUM_RCU_LVLS        3
64 #  define NUM_RCU_LVL_0       1
65 #  define NUM_RCU_LVL_1       DIV_ROUND_UP(NR_CPUS, RCU_FANOUT_2)
66 #  define NUM_RCU_LVL_2       DIV_ROUND_UP(NR_CPUS, RCU_FANOUT_1)
67 #  define NUM_RCU_LVL_3       (NR_CPUS)
68 #  define NUM_RCU_LVL_4       0
69 #elif NR_CPUS <= RCU_FANOUT_4
70 #  define NUM_RCU_LVLS        4
71 #  define NUM_RCU_LVL_0       1
72 #  define NUM_RCU_LVL_1       DIV_ROUND_UP(NR_CPUS, RCU_FANOUT_3)
73 #  define NUM_RCU_LVL_2       DIV_ROUND_UP(NR_CPUS, RCU_FANOUT_2)
74 #  define NUM_RCU_LVL_3       DIV_ROUND_UP(NR_CPUS, RCU_FANOUT_1)
75 #  define NUM_RCU_LVL_4       (NR_CPUS)
76 #else
77 # error "CONFIG_RCU_FANOUT insufficient for NR_CPUS"
78 #endif /* #if (NR_CPUS) <= RCU_FANOUT_1 */
79
80 #define RCU_SUM (NUM_RCU_LVL_0 + NUM_RCU_LVL_1 + NUM_RCU_LVL_2 + NUM_RCU_LVL_3 + NUM_RCU_LVL_4)
81 #define NUM_RCU_NODES (RCU_SUM - NR_CPUS)
82
83 /*
84  * Dynticks per-CPU state.
85  */
86 struct rcu_dynticks {
87         int dynticks_nesting;   /* Track irq/process nesting level. */
88         int dynticks_nmi_nesting; /* Track NMI nesting level. */
89         atomic_t dynticks;      /* Even value for dynticks-idle, else odd. */
90 };
91
92 /*
93  * Definition for node within the RCU grace-period-detection hierarchy.
94  */
95 struct rcu_node {
96         raw_spinlock_t lock;    /* Root rcu_node's lock protects some */
97                                 /*  rcu_state fields as well as following. */
98         unsigned long gpnum;    /* Current grace period for this node. */
99                                 /*  This will either be equal to or one */
100                                 /*  behind the root rcu_node's gpnum. */
101         unsigned long completed; /* Last GP completed for this node. */
102                                 /*  This will either be equal to or one */
103                                 /*  behind the root rcu_node's gpnum. */
104         unsigned long qsmask;   /* CPUs or groups that need to switch in */
105                                 /*  order for current grace period to proceed.*/
106                                 /*  In leaf rcu_node, each bit corresponds to */
107                                 /*  an rcu_data structure, otherwise, each */
108                                 /*  bit corresponds to a child rcu_node */
109                                 /*  structure. */
110         unsigned long expmask;  /* Groups that have ->blocked_tasks[] */
111                                 /*  elements that need to drain to allow the */
112                                 /*  current expedited grace period to */
113                                 /*  complete (only for TREE_PREEMPT_RCU). */
114         unsigned long qsmaskinit;
115                                 /* Per-GP initial value for qsmask & expmask. */
116         unsigned long grpmask;  /* Mask to apply to parent qsmask. */
117                                 /*  Only one bit will be set in this mask. */
118         int     grplo;          /* lowest-numbered CPU or group here. */
119         int     grphi;          /* highest-numbered CPU or group here. */
120         u8      grpnum;         /* CPU/group number for next level up. */
121         u8      level;          /* root is at level 0. */
122         struct rcu_node *parent;
123         struct list_head blocked_tasks[4];
124                                 /* Tasks blocked in RCU read-side critsect. */
125                                 /*  Grace period number (->gpnum) x blocked */
126                                 /*  by tasks on the (x & 0x1) element of the */
127                                 /*  blocked_tasks[] array. */
128 } ____cacheline_internodealigned_in_smp;
129
130 /*
131  * Do a full breadth-first scan of the rcu_node structures for the
132  * specified rcu_state structure.
133  */
134 #define rcu_for_each_node_breadth_first(rsp, rnp) \
135         for ((rnp) = &(rsp)->node[0]; \
136              (rnp) < &(rsp)->node[NUM_RCU_NODES]; (rnp)++)
137
138 /*
139  * Do a breadth-first scan of the non-leaf rcu_node structures for the
140  * specified rcu_state structure.  Note that if there is a singleton
141  * rcu_node tree with but one rcu_node structure, this loop is a no-op.
142  */
143 #define rcu_for_each_nonleaf_node_breadth_first(rsp, rnp) \
144         for ((rnp) = &(rsp)->node[0]; \
145              (rnp) < (rsp)->level[NUM_RCU_LVLS - 1]; (rnp)++)
146
147 /*
148  * Scan the leaves of the rcu_node hierarchy for the specified rcu_state
149  * structure.  Note that if there is a singleton rcu_node tree with but
150  * one rcu_node structure, this loop -will- visit the rcu_node structure.
151  * It is still a leaf node, even if it is also the root node.
152  */
153 #define rcu_for_each_leaf_node(rsp, rnp) \
154         for ((rnp) = (rsp)->level[NUM_RCU_LVLS - 1]; \
155              (rnp) < &(rsp)->node[NUM_RCU_NODES]; (rnp)++)
156
157 /* Index values for nxttail array in struct rcu_data. */
158 #define RCU_DONE_TAIL           0       /* Also RCU_WAIT head. */
159 #define RCU_WAIT_TAIL           1       /* Also RCU_NEXT_READY head. */
160 #define RCU_NEXT_READY_TAIL     2       /* Also RCU_NEXT head. */
161 #define RCU_NEXT_TAIL           3
162 #define RCU_NEXT_SIZE           4
163
164 /* Per-CPU data for read-copy update. */
165 struct rcu_data {
166         /* 1) quiescent-state and grace-period handling : */
167         unsigned long   completed;      /* Track rsp->completed gp number */
168                                         /*  in order to detect GP end. */
169         unsigned long   gpnum;          /* Highest gp number that this CPU */
170                                         /*  is aware of having started. */
171         unsigned long   passed_quiesc_completed;
172                                         /* Value of completed at time of qs. */
173         bool            passed_quiesc;  /* User-mode/idle loop etc. */
174         bool            qs_pending;     /* Core waits for quiesc state. */
175         bool            beenonline;     /* CPU online at least once. */
176         bool            preemptable;    /* Preemptable RCU? */
177         struct rcu_node *mynode;        /* This CPU's leaf of hierarchy */
178         unsigned long grpmask;          /* Mask to apply to leaf qsmask. */
179
180         /* 2) batch handling */
181         /*
182          * If nxtlist is not NULL, it is partitioned as follows.
183          * Any of the partitions might be empty, in which case the
184          * pointer to that partition will be equal to the pointer for
185          * the following partition.  When the list is empty, all of
186          * the nxttail elements point to the ->nxtlist pointer itself,
187          * which in that case is NULL.
188          *
189          * [nxtlist, *nxttail[RCU_DONE_TAIL]):
190          *      Entries that batch # <= ->completed
191          *      The grace period for these entries has completed, and
192          *      the other grace-period-completed entries may be moved
193          *      here temporarily in rcu_process_callbacks().
194          * [*nxttail[RCU_DONE_TAIL], *nxttail[RCU_WAIT_TAIL]):
195          *      Entries that batch # <= ->completed - 1: waiting for current GP
196          * [*nxttail[RCU_WAIT_TAIL], *nxttail[RCU_NEXT_READY_TAIL]):
197          *      Entries known to have arrived before current GP ended
198          * [*nxttail[RCU_NEXT_READY_TAIL], *nxttail[RCU_NEXT_TAIL]):
199          *      Entries that might have arrived after current GP ended
200          *      Note that the value of *nxttail[RCU_NEXT_TAIL] will
201          *      always be NULL, as this is the end of the list.
202          */
203         struct rcu_head *nxtlist;
204         struct rcu_head **nxttail[RCU_NEXT_SIZE];
205         long            qlen;           /* # of queued callbacks */
206         long            qlen_last_fqs_check;
207                                         /* qlen at last check for QS forcing */
208         unsigned long   n_cbs_invoked;  /* count of RCU cbs invoked. */
209         unsigned long   n_cbs_orphaned; /* RCU cbs orphaned by dying CPU */
210         unsigned long   n_cbs_adopted;  /* RCU cbs adopted from dying CPU */
211         unsigned long   n_force_qs_snap;
212                                         /* did other CPU force QS recently? */
213         long            blimit;         /* Upper limit on a processed batch */
214
215 #ifdef CONFIG_NO_HZ
216         /* 3) dynticks interface. */
217         struct rcu_dynticks *dynticks;  /* Shared per-CPU dynticks state. */
218         int dynticks_snap;              /* Per-GP tracking for dynticks. */
219 #endif /* #ifdef CONFIG_NO_HZ */
220
221         /* 4) reasons this CPU needed to be kicked by force_quiescent_state */
222 #ifdef CONFIG_NO_HZ
223         unsigned long dynticks_fqs;     /* Kicked due to dynticks idle. */
224 #endif /* #ifdef CONFIG_NO_HZ */
225         unsigned long offline_fqs;      /* Kicked due to being offline. */
226         unsigned long resched_ipi;      /* Sent a resched IPI. */
227
228         /* 5) __rcu_pending() statistics. */
229         unsigned long n_rcu_pending;    /* rcu_pending() calls since boot. */
230         unsigned long n_rp_qs_pending;
231         unsigned long n_rp_report_qs;
232         unsigned long n_rp_cb_ready;
233         unsigned long n_rp_cpu_needs_gp;
234         unsigned long n_rp_gp_completed;
235         unsigned long n_rp_gp_started;
236         unsigned long n_rp_need_fqs;
237         unsigned long n_rp_need_nothing;
238
239         int cpu;
240 };
241
242 /* Values for signaled field in struct rcu_state. */
243 #define RCU_GP_IDLE             0       /* No grace period in progress. */
244 #define RCU_GP_INIT             1       /* Grace period being initialized. */
245 #define RCU_SAVE_DYNTICK        2       /* Need to scan dyntick state. */
246 #define RCU_FORCE_QS            3       /* Need to force quiescent state. */
247 #ifdef CONFIG_NO_HZ
248 #define RCU_SIGNAL_INIT         RCU_SAVE_DYNTICK
249 #else /* #ifdef CONFIG_NO_HZ */
250 #define RCU_SIGNAL_INIT         RCU_FORCE_QS
251 #endif /* #else #ifdef CONFIG_NO_HZ */
252
253 #define RCU_JIFFIES_TILL_FORCE_QS        3      /* for rsp->jiffies_force_qs */
254
255 #ifdef CONFIG_PROVE_RCU
256 #define RCU_STALL_DELAY_DELTA          (5 * HZ)
257 #else
258 #define RCU_STALL_DELAY_DELTA          0
259 #endif
260
261 #define RCU_SECONDS_TILL_STALL_CHECK   (CONFIG_RCU_CPU_STALL_TIMEOUT * HZ + \
262                                         RCU_STALL_DELAY_DELTA)
263                                                 /* for rsp->jiffies_stall */
264 #define RCU_SECONDS_TILL_STALL_RECHECK (3 * RCU_SECONDS_TILL_STALL_CHECK + 30)
265                                                 /* for rsp->jiffies_stall */
266 #define RCU_STALL_RAT_DELAY             2       /* Allow other CPUs time */
267                                                 /*  to take at least one */
268                                                 /*  scheduling clock irq */
269                                                 /*  before ratting on them. */
270
271
272 /*
273  * RCU global state, including node hierarchy.  This hierarchy is
274  * represented in "heap" form in a dense array.  The root (first level)
275  * of the hierarchy is in ->node[0] (referenced by ->level[0]), the second
276  * level in ->node[1] through ->node[m] (->node[1] referenced by ->level[1]),
277  * and the third level in ->node[m+1] and following (->node[m+1] referenced
278  * by ->level[2]).  The number of levels is determined by the number of
279  * CPUs and by CONFIG_RCU_FANOUT.  Small systems will have a "hierarchy"
280  * consisting of a single rcu_node.
281  */
282 struct rcu_state {
283         struct rcu_node node[NUM_RCU_NODES];    /* Hierarchy. */
284         struct rcu_node *level[NUM_RCU_LVLS];   /* Hierarchy levels. */
285         u32 levelcnt[MAX_RCU_LVLS + 1];         /* # nodes in each level. */
286         u8 levelspread[NUM_RCU_LVLS];           /* kids/node in each level. */
287         struct rcu_data __percpu *rda;          /* pointer of percu rcu_data. */
288
289         /* The following fields are guarded by the root rcu_node's lock. */
290
291         u8      signaled ____cacheline_internodealigned_in_smp;
292                                                 /* Force QS state. */
293         u8      fqs_active;                     /* force_quiescent_state() */
294                                                 /*  is running. */
295         u8      fqs_need_gp;                    /* A CPU was prevented from */
296                                                 /*  starting a new grace */
297                                                 /*  period because */
298                                                 /*  force_quiescent_state() */
299                                                 /*  was running. */
300         unsigned long gpnum;                    /* Current gp number. */
301         unsigned long completed;                /* # of last completed gp. */
302
303         /* End of fields guarded by root rcu_node's lock. */
304
305         raw_spinlock_t onofflock;               /* exclude on/offline and */
306                                                 /*  starting new GP. */
307         raw_spinlock_t fqslock;                 /* Only one task forcing */
308                                                 /*  quiescent states. */
309         unsigned long jiffies_force_qs;         /* Time at which to invoke */
310                                                 /*  force_quiescent_state(). */
311         unsigned long n_force_qs;               /* Number of calls to */
312                                                 /*  force_quiescent_state(). */
313         unsigned long n_force_qs_lh;            /* ~Number of calls leaving */
314                                                 /*  due to lock unavailable. */
315         unsigned long n_force_qs_ngp;           /* Number of calls leaving */
316                                                 /*  due to no GP active. */
317         unsigned long gp_start;                 /* Time at which GP started, */
318                                                 /*  but in jiffies. */
319         unsigned long jiffies_stall;            /* Time at which to check */
320                                                 /*  for CPU stalls. */
321         char *name;                             /* Name of structure. */
322 };
323
324 /* Return values for rcu_preempt_offline_tasks(). */
325
326 #define RCU_OFL_TASKS_NORM_GP   0x1             /* Tasks blocking normal */
327                                                 /*  GP were moved to root. */
328 #define RCU_OFL_TASKS_EXP_GP    0x2             /* Tasks blocking expedited */
329                                                 /*  GP were moved to root. */
330
331 /*
332  * RCU implementation internal declarations:
333  */
334 extern struct rcu_state rcu_sched_state;
335 DECLARE_PER_CPU(struct rcu_data, rcu_sched_data);
336
337 extern struct rcu_state rcu_bh_state;
338 DECLARE_PER_CPU(struct rcu_data, rcu_bh_data);
339
340 #ifdef CONFIG_TREE_PREEMPT_RCU
341 extern struct rcu_state rcu_preempt_state;
342 DECLARE_PER_CPU(struct rcu_data, rcu_preempt_data);
343 #endif /* #ifdef CONFIG_TREE_PREEMPT_RCU */
344
345 #ifndef RCU_TREE_NONCORE
346
347 /* Forward declarations for rcutree_plugin.h */
348 static void rcu_bootup_announce(void);
349 long rcu_batches_completed(void);
350 static void rcu_preempt_note_context_switch(int cpu);
351 static int rcu_preempted_readers(struct rcu_node *rnp);
352 #ifdef CONFIG_HOTPLUG_CPU
353 static void rcu_report_unblock_qs_rnp(struct rcu_node *rnp,
354                                       unsigned long flags);
355 #endif /* #ifdef CONFIG_HOTPLUG_CPU */
356 static void rcu_print_detail_task_stall(struct rcu_state *rsp);
357 static void rcu_print_task_stall(struct rcu_node *rnp);
358 static void rcu_preempt_stall_reset(void);
359 static void rcu_preempt_check_blocked_tasks(struct rcu_node *rnp);
360 #ifdef CONFIG_HOTPLUG_CPU
361 static int rcu_preempt_offline_tasks(struct rcu_state *rsp,
362                                      struct rcu_node *rnp,
363                                      struct rcu_data *rdp);
364 static void rcu_preempt_offline_cpu(int cpu);
365 #endif /* #ifdef CONFIG_HOTPLUG_CPU */
366 static void rcu_preempt_check_callbacks(int cpu);
367 static void rcu_preempt_process_callbacks(void);
368 void call_rcu(struct rcu_head *head, void (*func)(struct rcu_head *rcu));
369 #if defined(CONFIG_HOTPLUG_CPU) || defined(CONFIG_TREE_PREEMPT_RCU)
370 static void rcu_report_exp_rnp(struct rcu_state *rsp, struct rcu_node *rnp);
371 #endif /* #if defined(CONFIG_HOTPLUG_CPU) || defined(CONFIG_TREE_PREEMPT_RCU) */
372 static int rcu_preempt_pending(int cpu);
373 static int rcu_preempt_needs_cpu(int cpu);
374 static void __cpuinit rcu_preempt_init_percpu_data(int cpu);
375 static void rcu_preempt_send_cbs_to_online(void);
376 static void __init __rcu_init_preempt(void);
377 static void rcu_needs_cpu_flush(void);
378
379 #endif /* #ifndef RCU_TREE_NONCORE */