x86: Try to fix MP table I/O interrupt assignment entries
[akaros.git] / kern / include / rcu_helper.h
1 /*
2  * Read-Copy Update definitions shared among RCU implementations.
3  *
4  * This program is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License as published by
6  * the Free Software Foundation; either version 2 of the License, or
7  * (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, you can access it online at
16  * http://www.gnu.org/licenses/gpl-2.0.html.
17  *
18  * Copyright IBM Corporation, 2011
19  *
20  * Author: Paul E. McKenney <paulmck@linux.vnet.ibm.com>
21  */
22
23 #ifndef __LINUX_RCU_H
24 #define __LINUX_RCU_H
25
26 /*
27  * Grace-period counter management.
28  */
29
30 #define RCU_SEQ_CTR_SHIFT       2
31 #define RCU_SEQ_STATE_MASK      ((1 << RCU_SEQ_CTR_SHIFT) - 1)
32
33 /*
34  * Return the counter portion of a sequence number previously returned
35  * by rcu_seq_snap() or rcu_seq_current().
36  */
37 static inline unsigned long rcu_seq_ctr(unsigned long s)
38 {
39         return s >> RCU_SEQ_CTR_SHIFT;
40 }
41
42 /*
43  * Return the state portion of a sequence number previously returned
44  * by rcu_seq_snap() or rcu_seq_current().
45  */
46 static inline int rcu_seq_state(unsigned long s)
47 {
48         return s & RCU_SEQ_STATE_MASK;
49 }
50
51 /*
52  * Set the state portion of the pointed-to sequence number.
53  * The caller is responsible for preventing conflicting updates.
54  */
55 static inline void rcu_seq_set_state(unsigned long *sp, int newstate)
56 {
57         warn_on_once(newstate & ~RCU_SEQ_STATE_MASK);
58         WRITE_ONCE(*sp, (*sp & ~RCU_SEQ_STATE_MASK) + newstate);
59 }
60
61 /* Adjust sequence number for start of update-side operation. */
62 static inline void rcu_seq_start(unsigned long *sp)
63 {
64         WRITE_ONCE(*sp, *sp + 1);
65         mb(); /* Ensure update-side operation after counter increment. */
66         warn_on_once(rcu_seq_state(*sp) != 1);
67 }
68
69 /* Adjust sequence number for end of update-side operation. */
70 static inline void rcu_seq_end(unsigned long *sp)
71 {
72         mb(); /* Ensure update-side operation before counter increment. */
73         warn_on_once(!rcu_seq_state(*sp));
74         WRITE_ONCE(*sp, (*sp | RCU_SEQ_STATE_MASK) + 1);
75 }
76
77 /* Take a snapshot of the update side's sequence number. */
78 static inline unsigned long rcu_seq_snap(unsigned long *sp)
79 {
80         unsigned long s;
81
82         s = (READ_ONCE(*sp) + 2 * RCU_SEQ_STATE_MASK + 1) & ~RCU_SEQ_STATE_MASK;
83         mb(); /* Above access must not bleed into critical section. */
84         return s;
85 }
86
87 /* Return the current value the update side's sequence number, no ordering. */
88 static inline unsigned long rcu_seq_current(unsigned long *sp)
89 {
90         return READ_ONCE(*sp);
91 }
92
93 /*
94  * Given a snapshot from rcu_seq_snap(), determine whether or not a
95  * full update-side operation has occurred.
96  */
97 static inline bool rcu_seq_done(unsigned long *sp, unsigned long s)
98 {
99         return ULONG_CMP_GE(READ_ONCE(*sp), s);
100 }
101
102 #include <rcu_node_tree.h>
103
104 extern int rcu_num_lvls;
105 extern int num_rcu_lvl[];
106 extern int rcu_num_nodes;
107 extern bool rcu_fanout_exact;
108 extern int rcu_fanout_leaf;
109 extern int rcu_num_cores;
110
111 /*
112  * Compute the per-level fanout, either using the exact fanout specified
113  * or balancing the tree, depending on the rcu_fanout_exact boot parameter.
114  */
115 static inline void rcu_init_levelspread(int *levelspread, const int *levelcnt)
116 {
117         int i;
118
119         if (rcu_fanout_exact) {
120                 levelspread[rcu_num_lvls - 1] = rcu_fanout_leaf;
121                 for (i = rcu_num_lvls - 2; i >= 0; i--)
122                         levelspread[i] = RCU_FANOUT;
123         } else {
124                 int ccur;
125                 int cprv;
126
127                 cprv = rcu_num_cores;
128                 for (i = rcu_num_lvls - 1; i >= 0; i--) {
129                         ccur = levelcnt[i];
130                         levelspread[i] = (cprv + ccur - 1) / ccur;
131                         cprv = ccur;
132                 }
133         }
134 }
135
136 /*
137  * Do a full breadth-first scan of the rcu_node structures for the
138  * specified rcu_state structure.
139  */
140 #define rcu_for_each_node_breadth_first(rsp, rnp) \
141         for ((rnp) = &(rsp)->node[0]; \
142              (rnp) < &(rsp)->node[rcu_num_nodes]; (rnp)++)
143
144 /*
145  * Do a breadth-first scan of the non-leaf rcu_node structures for the
146  * specified rcu_state structure.  Note that if there is a singleton
147  * rcu_node tree with but one rcu_node structure, this loop is a no-op.
148  */
149 #define rcu_for_each_nonleaf_node_breadth_first(rsp, rnp) \
150         for ((rnp) = &(rsp)->node[0]; \
151              (rnp) < (rsp)->level[rcu_num_lvls - 1]; (rnp)++)
152
153 /*
154  * Scan the leaves of the rcu_node hierarchy for the specified rcu_state
155  * structure.  Note that if there is a singleton rcu_node tree with but
156  * one rcu_node structure, this loop -will- visit the rcu_node structure.
157  * It is still a leaf node, even if it is also the root node.
158  */
159 #define rcu_for_each_leaf_node(rsp, rnp) \
160         for ((rnp) = (rsp)->level[rcu_num_lvls - 1]; \
161              (rnp) < &(rsp)->node[rcu_num_nodes]; (rnp)++)
162
163 /*
164  * Iterate over all possible CPUs in a leaf RCU node.
165  */
166 #define for_each_leaf_node_possible_cpu(rnp, cpu) \
167         for ((cpu) = cpumask_next(rnp->grplo - 1, cpu_possible_mask); \
168              cpu <= rnp->grphi; \
169              cpu = cpumask_next((cpu), cpu_possible_mask))
170
171 /*
172  * Wrappers for the rcu_node::lock acquire and release.
173  *
174  * Because the rcu_nodes form a tree, the tree traversal locking will observe
175  * different lock values, this in turn means that an UNLOCK of one level
176  * followed by a LOCK of another level does not imply a full memory barrier;
177  * and most importantly transitivity is lost.
178  *
179  * In order to restore full ordering between tree levels, augment the regular
180  * lock acquire functions with smp_mb__after_unlock_lock().
181  *
182  * As ->lock of struct rcu_node is a __private field, therefore one should use
183  * these wrappers rather than directly call raw_spin_{lock,unlock}* on ->lock.
184  */
185 #define raw_spin_lock_rcu_node(p)                                       \
186 do {                                                                    \
187         raw_spin_lock(&ACCESS_PRIVATE(p, lock));                        \
188         smp_mb__after_unlock_lock();                                    \
189 } while (0)
190
191 #define raw_spin_unlock_rcu_node(p) raw_spin_unlock(&ACCESS_PRIVATE(p, lock))
192
193 #define raw_spin_lock_irq_rcu_node(p)                                   \
194 do {                                                                    \
195         raw_spin_lock_irq(&ACCESS_PRIVATE(p, lock));                    \
196         smp_mb__after_unlock_lock();                                    \
197 } while (0)
198
199 #define raw_spin_unlock_irq_rcu_node(p)                                 \
200         raw_spin_unlock_irq(&ACCESS_PRIVATE(p, lock))
201
202 #define raw_spin_lock_irqsave_rcu_node(p, flags)                        \
203 do {                                                                    \
204         raw_spin_lock_irqsave(&ACCESS_PRIVATE(p, lock), flags); \
205         smp_mb__after_unlock_lock();                                    \
206 } while (0)
207
208 #define raw_spin_unlock_irqrestore_rcu_node(p, flags)                   \
209         raw_spin_unlock_irqrestore(&ACCESS_PRIVATE(p, lock), flags)     \
210
211 #define raw_spin_trylock_rcu_node(p)                                    \
212 ({                                                                      \
213         bool ___locked = raw_spin_trylock(&ACCESS_PRIVATE(p, lock));    \
214                                                                         \
215         if (___locked)                                                  \
216                 smp_mb__after_unlock_lock();                            \
217         ___locked;                                                      \
218 })
219
220 #define RCU_SCHEDULER_INACTIVE  0
221 #define RCU_SCHEDULER_INIT      1
222 #define RCU_SCHEDULER_RUNNING   2
223
224 enum rcutorture_type {
225         RCU_FLAVOR,
226         RCU_BH_FLAVOR,
227         RCU_SCHED_FLAVOR,
228         RCU_TASKS_FLAVOR,
229         SRCU_FLAVOR,
230         INVALID_RCU_FLAVOR
231 };
232
233 void rcutorture_get_gp_data(enum rcutorture_type test_type, int *flags,
234                             unsigned long *gpnum, unsigned long *completed);
235 void rcutorture_record_test_transition(void);
236 void rcutorture_record_progress(unsigned long vernum);
237 void do_trace_rcu_torture_read(const char *rcutorturename,
238                                struct rcu_head *rhp,
239                                unsigned long secs,
240                                unsigned long c_old,
241                                unsigned long c);
242
243 #endif /* __LINUX_RCU_H */