rcu: Move private definitions from include/linux/rcutree.h to kernel/rcutree.h
[linux-block.git] / kernel / rcutree.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
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 has not been tested, so there is probably some
35 * bug somewhere.
36 */
37#define MAX_RCU_LVLS 3
38#define RCU_FANOUT (CONFIG_RCU_FANOUT)
39#define RCU_FANOUT_SQ (RCU_FANOUT * RCU_FANOUT)
40#define RCU_FANOUT_CUBE (RCU_FANOUT_SQ * RCU_FANOUT)
41
42#if NR_CPUS <= RCU_FANOUT
43# define NUM_RCU_LVLS 1
44# define NUM_RCU_LVL_0 1
45# define NUM_RCU_LVL_1 (NR_CPUS)
46# define NUM_RCU_LVL_2 0
47# define NUM_RCU_LVL_3 0
48#elif NR_CPUS <= RCU_FANOUT_SQ
49# define NUM_RCU_LVLS 2
50# define NUM_RCU_LVL_0 1
51# define NUM_RCU_LVL_1 (((NR_CPUS) + RCU_FANOUT - 1) / RCU_FANOUT)
52# define NUM_RCU_LVL_2 (NR_CPUS)
53# define NUM_RCU_LVL_3 0
54#elif NR_CPUS <= RCU_FANOUT_CUBE
55# define NUM_RCU_LVLS 3
56# define NUM_RCU_LVL_0 1
57# define NUM_RCU_LVL_1 (((NR_CPUS) + RCU_FANOUT_SQ - 1) / RCU_FANOUT_SQ)
58# define NUM_RCU_LVL_2 (((NR_CPUS) + (RCU_FANOUT) - 1) / (RCU_FANOUT))
59# define NUM_RCU_LVL_3 NR_CPUS
60#else
61# error "CONFIG_RCU_FANOUT insufficient for NR_CPUS"
62#endif /* #if (NR_CPUS) <= RCU_FANOUT */
63
64#define RCU_SUM (NUM_RCU_LVL_0 + NUM_RCU_LVL_1 + NUM_RCU_LVL_2 + NUM_RCU_LVL_3)
65#define NUM_RCU_NODES (RCU_SUM - NR_CPUS)
66
67/*
68 * Dynticks per-CPU state.
69 */
70struct rcu_dynticks {
71 int dynticks_nesting; /* Track nesting level, sort of. */
72 int dynticks; /* Even value for dynticks-idle, else odd. */
73 int dynticks_nmi; /* Even value for either dynticks-idle or */
74 /* not in nmi handler, else odd. So this */
75 /* remains even for nmi from irq handler. */
76};
77
78/*
79 * Definition for node within the RCU grace-period-detection hierarchy.
80 */
81struct rcu_node {
82 spinlock_t lock;
83 unsigned long qsmask; /* CPUs or groups that need to switch in */
84 /* order for current grace period to proceed.*/
85 unsigned long qsmaskinit;
86 /* Per-GP initialization for qsmask. */
87 unsigned long grpmask; /* Mask to apply to parent qsmask. */
88 int grplo; /* lowest-numbered CPU or group here. */
89 int grphi; /* highest-numbered CPU or group here. */
90 u8 grpnum; /* CPU/group number for next level up. */
91 u8 level; /* root is at level 0. */
92 struct rcu_node *parent;
93} ____cacheline_internodealigned_in_smp;
94
95/* Index values for nxttail array in struct rcu_data. */
96#define RCU_DONE_TAIL 0 /* Also RCU_WAIT head. */
97#define RCU_WAIT_TAIL 1 /* Also RCU_NEXT_READY head. */
98#define RCU_NEXT_READY_TAIL 2 /* Also RCU_NEXT head. */
99#define RCU_NEXT_TAIL 3
100#define RCU_NEXT_SIZE 4
101
102/* Per-CPU data for read-copy update. */
103struct rcu_data {
104 /* 1) quiescent-state and grace-period handling : */
105 long completed; /* Track rsp->completed gp number */
106 /* in order to detect GP end. */
107 long gpnum; /* Highest gp number that this CPU */
108 /* is aware of having started. */
109 long passed_quiesc_completed;
110 /* Value of completed at time of qs. */
111 bool passed_quiesc; /* User-mode/idle loop etc. */
112 bool qs_pending; /* Core waits for quiesc state. */
113 bool beenonline; /* CPU online at least once. */
114 struct rcu_node *mynode; /* This CPU's leaf of hierarchy */
115 unsigned long grpmask; /* Mask to apply to leaf qsmask. */
116
117 /* 2) batch handling */
118 /*
119 * If nxtlist is not NULL, it is partitioned as follows.
120 * Any of the partitions might be empty, in which case the
121 * pointer to that partition will be equal to the pointer for
122 * the following partition. When the list is empty, all of
123 * the nxttail elements point to nxtlist, which is NULL.
124 *
125 * [*nxttail[RCU_NEXT_READY_TAIL], NULL = *nxttail[RCU_NEXT_TAIL]):
126 * Entries that might have arrived after current GP ended
127 * [*nxttail[RCU_WAIT_TAIL], *nxttail[RCU_NEXT_READY_TAIL]):
128 * Entries known to have arrived before current GP ended
129 * [*nxttail[RCU_DONE_TAIL], *nxttail[RCU_WAIT_TAIL]):
130 * Entries that batch # <= ->completed - 1: waiting for current GP
131 * [nxtlist, *nxttail[RCU_DONE_TAIL]):
132 * Entries that batch # <= ->completed
133 * The grace period for these entries has completed, and
134 * the other grace-period-completed entries may be moved
135 * here temporarily in rcu_process_callbacks().
136 */
137 struct rcu_head *nxtlist;
138 struct rcu_head **nxttail[RCU_NEXT_SIZE];
139 long qlen; /* # of queued callbacks */
140 long blimit; /* Upper limit on a processed batch */
141
142#ifdef CONFIG_NO_HZ
143 /* 3) dynticks interface. */
144 struct rcu_dynticks *dynticks; /* Shared per-CPU dynticks state. */
145 int dynticks_snap; /* Per-GP tracking for dynticks. */
146 int dynticks_nmi_snap; /* Per-GP tracking for dynticks_nmi. */
147#endif /* #ifdef CONFIG_NO_HZ */
148
149 /* 4) reasons this CPU needed to be kicked by force_quiescent_state */
150#ifdef CONFIG_NO_HZ
151 unsigned long dynticks_fqs; /* Kicked due to dynticks idle. */
152#endif /* #ifdef CONFIG_NO_HZ */
153 unsigned long offline_fqs; /* Kicked due to being offline. */
154 unsigned long resched_ipi; /* Sent a resched IPI. */
155
156 /* 5) __rcu_pending() statistics. */
157 long n_rcu_pending; /* rcu_pending() calls since boot. */
158 long n_rp_qs_pending;
159 long n_rp_cb_ready;
160 long n_rp_cpu_needs_gp;
161 long n_rp_gp_completed;
162 long n_rp_gp_started;
163 long n_rp_need_fqs;
164 long n_rp_need_nothing;
165
166 int cpu;
167};
168
169/* Values for signaled field in struct rcu_state. */
170#define RCU_GP_INIT 0 /* Grace period being initialized. */
171#define RCU_SAVE_DYNTICK 1 /* Need to scan dyntick state. */
172#define RCU_FORCE_QS 2 /* Need to force quiescent state. */
173#ifdef CONFIG_NO_HZ
174#define RCU_SIGNAL_INIT RCU_SAVE_DYNTICK
175#else /* #ifdef CONFIG_NO_HZ */
176#define RCU_SIGNAL_INIT RCU_FORCE_QS
177#endif /* #else #ifdef CONFIG_NO_HZ */
178
179#define RCU_JIFFIES_TILL_FORCE_QS 3 /* for rsp->jiffies_force_qs */
180#ifdef CONFIG_RCU_CPU_STALL_DETECTOR
181#define RCU_SECONDS_TILL_STALL_CHECK (10 * HZ) /* for rsp->jiffies_stall */
182#define RCU_SECONDS_TILL_STALL_RECHECK (30 * HZ) /* for rsp->jiffies_stall */
183#define RCU_STALL_RAT_DELAY 2 /* Allow other CPUs time */
184 /* to take at least one */
185 /* scheduling clock irq */
186 /* before ratting on them. */
187
188#endif /* #ifdef CONFIG_RCU_CPU_STALL_DETECTOR */
189
190/*
191 * RCU global state, including node hierarchy. This hierarchy is
192 * represented in "heap" form in a dense array. The root (first level)
193 * of the hierarchy is in ->node[0] (referenced by ->level[0]), the second
194 * level in ->node[1] through ->node[m] (->node[1] referenced by ->level[1]),
195 * and the third level in ->node[m+1] and following (->node[m+1] referenced
196 * by ->level[2]). The number of levels is determined by the number of
197 * CPUs and by CONFIG_RCU_FANOUT. Small systems will have a "hierarchy"
198 * consisting of a single rcu_node.
199 */
200struct rcu_state {
201 struct rcu_node node[NUM_RCU_NODES]; /* Hierarchy. */
202 struct rcu_node *level[NUM_RCU_LVLS]; /* Hierarchy levels. */
203 u32 levelcnt[MAX_RCU_LVLS + 1]; /* # nodes in each level. */
204 u8 levelspread[NUM_RCU_LVLS]; /* kids/node in each level. */
205 struct rcu_data *rda[NR_CPUS]; /* array of rdp pointers. */
206
207 /* The following fields are guarded by the root rcu_node's lock. */
208
209 u8 signaled ____cacheline_internodealigned_in_smp;
210 /* Force QS state. */
211 long gpnum; /* Current gp number. */
212 long completed; /* # of last completed gp. */
213 spinlock_t onofflock; /* exclude on/offline and */
214 /* starting new GP. */
215 spinlock_t fqslock; /* Only one task forcing */
216 /* quiescent states. */
217 unsigned long jiffies_force_qs; /* Time at which to invoke */
218 /* force_quiescent_state(). */
219 unsigned long n_force_qs; /* Number of calls to */
220 /* force_quiescent_state(). */
221 unsigned long n_force_qs_lh; /* ~Number of calls leaving */
222 /* due to lock unavailable. */
223 unsigned long n_force_qs_ngp; /* Number of calls leaving */
224 /* due to no GP active. */
225#ifdef CONFIG_RCU_CPU_STALL_DETECTOR
226 unsigned long gp_start; /* Time at which GP started, */
227 /* but in jiffies. */
228 unsigned long jiffies_stall; /* Time at which to check */
229 /* for CPU stalls. */
230#endif /* #ifdef CONFIG_RCU_CPU_STALL_DETECTOR */
231#ifdef CONFIG_NO_HZ
232 long dynticks_completed; /* Value of completed @ snap. */
233#endif /* #ifdef CONFIG_NO_HZ */
234};
235
236#ifdef RCU_TREE_NONCORE
6258c4fb
IM
237
238/*
239 * RCU implementation internal declarations:
240 */
241extern struct rcu_state rcu_state;
242DECLARE_PER_CPU(struct rcu_data, rcu_data);
243
244extern struct rcu_state rcu_bh_state;
245DECLARE_PER_CPU(struct rcu_data, rcu_bh_data);
246
9f77da9f
PM
247#endif /* #ifdef RCU_TREE_NONCORE */
248