2f1bc42a3b820e2d27beab785a76564d0e47ed49
[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 #ifdef CONFIG_TREE_PREEMPT_RCU
56 extern void synchronize_rcu(void);
57 #else /* #ifdef CONFIG_TREE_PREEMPT_RCU */
58 #define synchronize_rcu synchronize_sched
59 #endif /* #else #ifdef CONFIG_TREE_PREEMPT_RCU */
60 extern void synchronize_rcu_bh(void);
61 extern void synchronize_sched(void);
62 extern void rcu_barrier(void);
63 extern void rcu_barrier_bh(void);
64 extern void rcu_barrier_sched(void);
65 extern void synchronize_sched_expedited(void);
66 extern int sched_expedited_torture_stats(char *page);
67
68 /* Internal to kernel */
69 extern void rcu_init(void);
70 extern void rcu_scheduler_starting(void);
71 #ifndef CONFIG_TINY_RCU
72 extern int rcu_needs_cpu(int cpu);
73 #else
74 static inline int rcu_needs_cpu(int cpu) { return 0; }
75 #endif
76 extern int rcu_scheduler_active;
77
78 #if defined(CONFIG_TREE_RCU) || defined(CONFIG_TREE_PREEMPT_RCU)
79 #include <linux/rcutree.h>
80 #elif defined(CONFIG_TINY_RCU)
81 #include <linux/rcutiny.h>
82 #else
83 #error "Unknown RCU implementation specified to kernel configuration"
84 #endif
85
86 #define RCU_HEAD_INIT   { .next = NULL, .func = NULL }
87 #define RCU_HEAD(head) struct rcu_head head = RCU_HEAD_INIT
88 #define INIT_RCU_HEAD(ptr) do { \
89        (ptr)->next = NULL; (ptr)->func = NULL; \
90 } while (0)
91
92 #ifdef CONFIG_DEBUG_LOCK_ALLOC
93 extern struct lockdep_map rcu_lock_map;
94 # define rcu_read_acquire()     \
95                         lock_acquire(&rcu_lock_map, 0, 0, 2, 1, NULL, _THIS_IP_)
96 # define rcu_read_release()     lock_release(&rcu_lock_map, 1, _THIS_IP_)
97 #else
98 # define rcu_read_acquire()     do { } while (0)
99 # define rcu_read_release()     do { } while (0)
100 #endif
101
102 /**
103  * rcu_read_lock - mark the beginning of an RCU read-side critical section.
104  *
105  * When synchronize_rcu() is invoked on one CPU while other CPUs
106  * are within RCU read-side critical sections, then the
107  * synchronize_rcu() is guaranteed to block until after all the other
108  * CPUs exit their critical sections.  Similarly, if call_rcu() is invoked
109  * on one CPU while other CPUs are within RCU read-side critical
110  * sections, invocation of the corresponding RCU callback is deferred
111  * until after the all the other CPUs exit their critical sections.
112  *
113  * Note, however, that RCU callbacks are permitted to run concurrently
114  * with RCU read-side critical sections.  One way that this can happen
115  * is via the following sequence of events: (1) CPU 0 enters an RCU
116  * read-side critical section, (2) CPU 1 invokes call_rcu() to register
117  * an RCU callback, (3) CPU 0 exits the RCU read-side critical section,
118  * (4) CPU 2 enters a RCU read-side critical section, (5) the RCU
119  * callback is invoked.  This is legal, because the RCU read-side critical
120  * section that was running concurrently with the call_rcu() (and which
121  * therefore might be referencing something that the corresponding RCU
122  * callback would free up) has completed before the corresponding
123  * RCU callback is invoked.
124  *
125  * RCU read-side critical sections may be nested.  Any deferred actions
126  * will be deferred until the outermost RCU read-side critical section
127  * completes.
128  *
129  * It is illegal to block while in an RCU read-side critical section.
130  */
131 static inline void rcu_read_lock(void)
132 {
133         __rcu_read_lock();
134         __acquire(RCU);
135         rcu_read_acquire();
136 }
137
138 /*
139  * So where is rcu_write_lock()?  It does not exist, as there is no
140  * way for writers to lock out RCU readers.  This is a feature, not
141  * a bug -- this property is what provides RCU's performance benefits.
142  * Of course, writers must coordinate with each other.  The normal
143  * spinlock primitives work well for this, but any other technique may be
144  * used as well.  RCU does not care how the writers keep out of each
145  * others' way, as long as they do so.
146  */
147
148 /**
149  * rcu_read_unlock - marks the end of an RCU read-side critical section.
150  *
151  * See rcu_read_lock() for more information.
152  */
153 static inline void rcu_read_unlock(void)
154 {
155         rcu_read_release();
156         __release(RCU);
157         __rcu_read_unlock();
158 }
159
160 /**
161  * rcu_read_lock_bh - mark the beginning of a softirq-only RCU critical section
162  *
163  * This is equivalent of rcu_read_lock(), but to be used when updates
164  * are being done using call_rcu_bh(). Since call_rcu_bh() callbacks
165  * consider completion of a softirq handler to be a quiescent state,
166  * a process in RCU read-side critical section must be protected by
167  * disabling softirqs. Read-side critical sections in interrupt context
168  * can use just rcu_read_lock().
169  *
170  */
171 static inline void rcu_read_lock_bh(void)
172 {
173         __rcu_read_lock_bh();
174         __acquire(RCU_BH);
175         rcu_read_acquire();
176 }
177
178 /*
179  * rcu_read_unlock_bh - marks the end of a softirq-only RCU critical section
180  *
181  * See rcu_read_lock_bh() for more information.
182  */
183 static inline void rcu_read_unlock_bh(void)
184 {
185         rcu_read_release();
186         __release(RCU_BH);
187         __rcu_read_unlock_bh();
188 }
189
190 /**
191  * rcu_read_lock_sched - mark the beginning of a RCU-classic critical section
192  *
193  * Should be used with either
194  * - synchronize_sched()
195  * or
196  * - call_rcu_sched() and rcu_barrier_sched()
197  * on the write-side to insure proper synchronization.
198  */
199 static inline void rcu_read_lock_sched(void)
200 {
201         preempt_disable();
202         __acquire(RCU_SCHED);
203         rcu_read_acquire();
204 }
205
206 /* Used by lockdep and tracing: cannot be traced, cannot call lockdep. */
207 static inline notrace void rcu_read_lock_sched_notrace(void)
208 {
209         preempt_disable_notrace();
210         __acquire(RCU_SCHED);
211 }
212
213 /*
214  * rcu_read_unlock_sched - marks the end of a RCU-classic critical section
215  *
216  * See rcu_read_lock_sched for more information.
217  */
218 static inline void rcu_read_unlock_sched(void)
219 {
220         rcu_read_release();
221         __release(RCU_SCHED);
222         preempt_enable();
223 }
224
225 /* Used by lockdep and tracing: cannot be traced, cannot call lockdep. */
226 static inline notrace void rcu_read_unlock_sched_notrace(void)
227 {
228         __release(RCU_SCHED);
229         preempt_enable_notrace();
230 }
231
232
233 /**
234  * rcu_dereference - fetch an RCU-protected pointer in an
235  * RCU read-side critical section.  This pointer may later
236  * be safely dereferenced.
237  *
238  * Inserts memory barriers on architectures that require them
239  * (currently only the Alpha), and, more importantly, documents
240  * exactly which pointers are protected by RCU.
241  */
242
243 #define rcu_dereference(p)     ({ \
244                                 typeof(p) _________p1 = ACCESS_ONCE(p); \
245                                 smp_read_barrier_depends(); \
246                                 (_________p1); \
247                                 })
248
249 /**
250  * rcu_assign_pointer - assign (publicize) a pointer to a newly
251  * initialized structure that will be dereferenced by RCU read-side
252  * critical sections.  Returns the value assigned.
253  *
254  * Inserts memory barriers on architectures that require them
255  * (pretty much all of them other than x86), and also prevents
256  * the compiler from reordering the code that initializes the
257  * structure after the pointer assignment.  More importantly, this
258  * call documents which pointers will be dereferenced by RCU read-side
259  * code.
260  */
261
262 #define rcu_assign_pointer(p, v) \
263         ({ \
264                 if (!__builtin_constant_p(v) || \
265                     ((v) != NULL)) \
266                         smp_wmb(); \
267                 (p) = (v); \
268         })
269
270 /* Infrastructure to implement the synchronize_() primitives. */
271
272 struct rcu_synchronize {
273         struct rcu_head head;
274         struct completion completion;
275 };
276
277 extern void wakeme_after_rcu(struct rcu_head  *head);
278
279 /**
280  * call_rcu - Queue an RCU callback for invocation after a grace period.
281  * @head: structure to be used for queueing the RCU updates.
282  * @func: actual update function to be invoked after the grace period
283  *
284  * The update function will be invoked some time after a full grace
285  * period elapses, in other words after all currently executing RCU
286  * read-side critical sections have completed.  RCU read-side critical
287  * sections are delimited by rcu_read_lock() and rcu_read_unlock(),
288  * and may be nested.
289  */
290 extern void call_rcu(struct rcu_head *head,
291                               void (*func)(struct rcu_head *head));
292
293 /**
294  * call_rcu_bh - Queue an RCU for invocation after a quicker grace period.
295  * @head: structure to be used for queueing the RCU updates.
296  * @func: actual update function to be invoked after the grace period
297  *
298  * The update function will be invoked some time after a full grace
299  * period elapses, in other words after all currently executing RCU
300  * read-side critical sections have completed. call_rcu_bh() assumes
301  * that the read-side critical sections end on completion of a softirq
302  * handler. This means that read-side critical sections in process
303  * context must not be interrupted by softirqs. This interface is to be
304  * used when most of the read-side critical sections are in softirq context.
305  * RCU read-side critical sections are delimited by :
306  *  - rcu_read_lock() and  rcu_read_unlock(), if in interrupt context.
307  *  OR
308  *  - rcu_read_lock_bh() and rcu_read_unlock_bh(), if in process context.
309  *  These may be nested.
310  */
311 extern void call_rcu_bh(struct rcu_head *head,
312                         void (*func)(struct rcu_head *head));
313
314 #endif /* __LINUX_RCUPDATE_H */