rcu: Renamings to increase RCU clarity
[linux-2.6.git] / include / linux / rcupdate.h
1 /*
2  * Read-Copy Update mechanism for mutual exclusion 
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, write to the Free Software
16  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
17  *
18  * Copyright IBM Corporation, 2001
19  *
20  * Author: Dipankar Sarma <dipankar@in.ibm.com>
21  * 
22  * Based on the original work by Paul McKenney <paulmck@us.ibm.com>
23  * and inputs from Rusty Russell, Andrea Arcangeli and Andi Kleen.
24  * Papers:
25  * http://www.rdrop.com/users/paulmck/paper/rclockpdcsproof.pdf
26  * http://lse.sourceforge.net/locking/rclock_OLS.2001.05.01c.sc.pdf (OLS2001)
27  *
28  * For detailed explanation of Read-Copy Update mechanism see -
29  *              http://lse.sourceforge.net/locking/rcupdate.html
30  *
31  */
32
33 #ifndef __LINUX_RCUPDATE_H
34 #define __LINUX_RCUPDATE_H
35
36 #include <linux/cache.h>
37 #include <linux/spinlock.h>
38 #include <linux/threads.h>
39 #include <linux/cpumask.h>
40 #include <linux/seqlock.h>
41 #include <linux/lockdep.h>
42 #include <linux/completion.h>
43
44 /**
45  * struct rcu_head - callback structure for use with RCU
46  * @next: next update requests in a list
47  * @func: actual update function to call after the grace period.
48  */
49 struct rcu_head {
50         struct rcu_head *next;
51         void (*func)(struct rcu_head *head);
52 };
53
54 /* Exported common interfaces */
55 extern void synchronize_rcu(void);
56 extern void synchronize_rcu_bh(void);
57 extern void rcu_barrier(void);
58 extern void rcu_barrier_bh(void);
59 extern void rcu_barrier_sched(void);
60 extern void synchronize_sched_expedited(void);
61 extern int sched_expedited_torture_stats(char *page);
62
63 /* Internal to kernel */
64 extern void rcu_init(void);
65 extern void rcu_scheduler_starting(void);
66 extern int rcu_needs_cpu(int cpu);
67 extern int rcu_scheduler_active;
68
69 #if defined(CONFIG_TREE_RCU)
70 #include <linux/rcutree.h>
71 #elif defined(CONFIG_PREEMPT_RCU)
72 #include <linux/rcupreempt.h>
73 #else
74 #error "Unknown RCU implementation specified to kernel configuration"
75 #endif /* #else #if defined(CONFIG_CLASSIC_RCU) */
76
77 #define RCU_HEAD_INIT   { .next = NULL, .func = NULL }
78 #define RCU_HEAD(head) struct rcu_head head = RCU_HEAD_INIT
79 #define INIT_RCU_HEAD(ptr) do { \
80        (ptr)->next = NULL; (ptr)->func = NULL; \
81 } while (0)
82
83 /**
84  * rcu_read_lock - mark the beginning of an RCU read-side critical section.
85  *
86  * When synchronize_rcu() is invoked on one CPU while other CPUs
87  * are within RCU read-side critical sections, then the
88  * synchronize_rcu() is guaranteed to block until after all the other
89  * CPUs exit their critical sections.  Similarly, if call_rcu() is invoked
90  * on one CPU while other CPUs are within RCU read-side critical
91  * sections, invocation of the corresponding RCU callback is deferred
92  * until after the all the other CPUs exit their critical sections.
93  *
94  * Note, however, that RCU callbacks are permitted to run concurrently
95  * with RCU read-side critical sections.  One way that this can happen
96  * is via the following sequence of events: (1) CPU 0 enters an RCU
97  * read-side critical section, (2) CPU 1 invokes call_rcu() to register
98  * an RCU callback, (3) CPU 0 exits the RCU read-side critical section,
99  * (4) CPU 2 enters a RCU read-side critical section, (5) the RCU
100  * callback is invoked.  This is legal, because the RCU read-side critical
101  * section that was running concurrently with the call_rcu() (and which
102  * therefore might be referencing something that the corresponding RCU
103  * callback would free up) has completed before the corresponding
104  * RCU callback is invoked.
105  *
106  * RCU read-side critical sections may be nested.  Any deferred actions
107  * will be deferred until the outermost RCU read-side critical section
108  * completes.
109  *
110  * It is illegal to block while in an RCU read-side critical section.
111  */
112 #define rcu_read_lock() __rcu_read_lock()
113
114 /**
115  * rcu_read_unlock - marks the end of an RCU read-side critical section.
116  *
117  * See rcu_read_lock() for more information.
118  */
119
120 /*
121  * So where is rcu_write_lock()?  It does not exist, as there is no
122  * way for writers to lock out RCU readers.  This is a feature, not
123  * a bug -- this property is what provides RCU's performance benefits.
124  * Of course, writers must coordinate with each other.  The normal
125  * spinlock primitives work well for this, but any other technique may be
126  * used as well.  RCU does not care how the writers keep out of each
127  * others' way, as long as they do so.
128  */
129 #define rcu_read_unlock() __rcu_read_unlock()
130
131 /**
132  * rcu_read_lock_bh - mark the beginning of a softirq-only RCU critical section
133  *
134  * This is equivalent of rcu_read_lock(), but to be used when updates
135  * are being done using call_rcu_bh(). Since call_rcu_bh() callbacks
136  * consider completion of a softirq handler to be a quiescent state,
137  * a process in RCU read-side critical section must be protected by
138  * disabling softirqs. Read-side critical sections in interrupt context
139  * can use just rcu_read_lock().
140  *
141  */
142 #define rcu_read_lock_bh() __rcu_read_lock_bh()
143
144 /*
145  * rcu_read_unlock_bh - marks the end of a softirq-only RCU critical section
146  *
147  * See rcu_read_lock_bh() for more information.
148  */
149 #define rcu_read_unlock_bh() __rcu_read_unlock_bh()
150
151 /**
152  * rcu_read_lock_sched - mark the beginning of a RCU-classic critical section
153  *
154  * Should be used with either
155  * - synchronize_sched()
156  * or
157  * - call_rcu_sched() and rcu_barrier_sched()
158  * on the write-side to insure proper synchronization.
159  */
160 static inline void rcu_read_lock_sched(void)
161 {
162         preempt_disable();
163 }
164 static inline void rcu_read_lock_sched_notrace(void)
165 {
166         preempt_disable_notrace();
167 }
168
169 /*
170  * rcu_read_unlock_sched - marks the end of a RCU-classic critical section
171  *
172  * See rcu_read_lock_sched for more information.
173  */
174 static inline void rcu_read_unlock_sched(void)
175 {
176         preempt_enable();
177 }
178 static inline void rcu_read_unlock_sched_notrace(void)
179 {
180         preempt_enable_notrace();
181 }
182
183
184 /**
185  * rcu_dereference - fetch an RCU-protected pointer in an
186  * RCU read-side critical section.  This pointer may later
187  * be safely dereferenced.
188  *
189  * Inserts memory barriers on architectures that require them
190  * (currently only the Alpha), and, more importantly, documents
191  * exactly which pointers are protected by RCU.
192  */
193
194 #define rcu_dereference(p)     ({ \
195                                 typeof(p) _________p1 = ACCESS_ONCE(p); \
196                                 smp_read_barrier_depends(); \
197                                 (_________p1); \
198                                 })
199
200 /**
201  * rcu_assign_pointer - assign (publicize) a pointer to a newly
202  * initialized structure that will be dereferenced by RCU read-side
203  * critical sections.  Returns the value assigned.
204  *
205  * Inserts memory barriers on architectures that require them
206  * (pretty much all of them other than x86), and also prevents
207  * the compiler from reordering the code that initializes the
208  * structure after the pointer assignment.  More importantly, this
209  * call documents which pointers will be dereferenced by RCU read-side
210  * code.
211  */
212
213 #define rcu_assign_pointer(p, v) \
214         ({ \
215                 if (!__builtin_constant_p(v) || \
216                     ((v) != NULL)) \
217                         smp_wmb(); \
218                 (p) = (v); \
219         })
220
221 /* Infrastructure to implement the synchronize_() primitives. */
222
223 struct rcu_synchronize {
224         struct rcu_head head;
225         struct completion completion;
226 };
227
228 extern void wakeme_after_rcu(struct rcu_head  *head);
229
230 /**
231  * synchronize_sched - block until all CPUs have exited any non-preemptive
232  * kernel code sequences.
233  *
234  * This means that all preempt_disable code sequences, including NMI and
235  * hardware-interrupt handlers, in progress on entry will have completed
236  * before this primitive returns.  However, this does not guarantee that
237  * softirq handlers will have completed, since in some kernels, these
238  * handlers can run in process context, and can block.
239  *
240  * This primitive provides the guarantees made by the (now removed)
241  * synchronize_kernel() API.  In contrast, synchronize_rcu() only
242  * guarantees that rcu_read_lock() sections will have completed.
243  * In "classic RCU", these two guarantees happen to be one and
244  * the same, but can differ in realtime RCU implementations.
245  */
246 #define synchronize_sched() __synchronize_sched()
247
248 /**
249  * call_rcu - Queue an RCU callback for invocation after a grace period.
250  * @head: structure to be used for queueing the RCU updates.
251  * @func: actual update function to be invoked after the grace period
252  *
253  * The update function will be invoked some time after a full grace
254  * period elapses, in other words after all currently executing RCU
255  * read-side critical sections have completed.  RCU read-side critical
256  * sections are delimited by rcu_read_lock() and rcu_read_unlock(),
257  * and may be nested.
258  */
259 extern void call_rcu(struct rcu_head *head,
260                               void (*func)(struct rcu_head *head));
261
262 /**
263  * call_rcu_bh - Queue an RCU for invocation after a quicker grace period.
264  * @head: structure to be used for queueing the RCU updates.
265  * @func: actual update function to be invoked after the grace period
266  *
267  * The update function will be invoked some time after a full grace
268  * period elapses, in other words after all currently executing RCU
269  * read-side critical sections have completed. call_rcu_bh() assumes
270  * that the read-side critical sections end on completion of a softirq
271  * handler. This means that read-side critical sections in process
272  * context must not be interrupted by softirqs. This interface is to be
273  * used when most of the read-side critical sections are in softirq context.
274  * RCU read-side critical sections are delimited by :
275  *  - rcu_read_lock() and  rcu_read_unlock(), if in interrupt context.
276  *  OR
277  *  - rcu_read_lock_bh() and rcu_read_unlock_bh(), if in process context.
278  *  These may be nested.
279  */
280 extern void call_rcu_bh(struct rcu_head *head,
281                         void (*func)(struct rcu_head *head));
282
283 #endif /* __LINUX_RCUPDATE_H */