rcu: Add rcu_access_pointer and rcu_dereference_protected
[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 #ifdef CONFIG_RCU_TORTURE_TEST
45 extern int rcutorture_runnable; /* for sysctl */
46 #endif /* #ifdef CONFIG_RCU_TORTURE_TEST */
47
48 /**
49  * struct rcu_head - callback structure for use with RCU
50  * @next: next update requests in a list
51  * @func: actual update function to call after the grace period.
52  */
53 struct rcu_head {
54         struct rcu_head *next;
55         void (*func)(struct rcu_head *head);
56 };
57
58 /* Exported common interfaces */
59 extern void synchronize_rcu_bh(void);
60 extern void synchronize_sched(void);
61 extern void rcu_barrier(void);
62 extern void rcu_barrier_bh(void);
63 extern void rcu_barrier_sched(void);
64 extern void synchronize_sched_expedited(void);
65 extern int sched_expedited_torture_stats(char *page);
66
67 /* Internal to kernel */
68 extern void rcu_init(void);
69 extern int rcu_scheduler_active;
70 extern void rcu_scheduler_starting(void);
71
72 #if defined(CONFIG_TREE_RCU) || defined(CONFIG_TREE_PREEMPT_RCU)
73 #include <linux/rcutree.h>
74 #elif defined(CONFIG_TINY_RCU)
75 #include <linux/rcutiny.h>
76 #else
77 #error "Unknown RCU implementation specified to kernel configuration"
78 #endif
79
80 #define RCU_HEAD_INIT   { .next = NULL, .func = NULL }
81 #define RCU_HEAD(head) struct rcu_head head = RCU_HEAD_INIT
82 #define INIT_RCU_HEAD(ptr) do { \
83        (ptr)->next = NULL; (ptr)->func = NULL; \
84 } while (0)
85
86 #ifdef CONFIG_DEBUG_LOCK_ALLOC
87
88 extern struct lockdep_map rcu_lock_map;
89 # define rcu_read_acquire() \
90                 lock_acquire(&rcu_lock_map, 0, 0, 2, 1, NULL, _THIS_IP_)
91 # define rcu_read_release()     lock_release(&rcu_lock_map, 1, _THIS_IP_)
92
93 extern struct lockdep_map rcu_bh_lock_map;
94 # define rcu_read_acquire_bh() \
95                 lock_acquire(&rcu_bh_lock_map, 0, 0, 2, 1, NULL, _THIS_IP_)
96 # define rcu_read_release_bh()  lock_release(&rcu_bh_lock_map, 1, _THIS_IP_)
97
98 extern struct lockdep_map rcu_sched_lock_map;
99 # define rcu_read_acquire_sched() \
100                 lock_acquire(&rcu_sched_lock_map, 0, 0, 2, 1, NULL, _THIS_IP_)
101 # define rcu_read_release_sched() \
102                 lock_release(&rcu_sched_lock_map, 1, _THIS_IP_)
103
104 static inline int debug_lockdep_rcu_enabled(void)
105 {
106         return likely(rcu_scheduler_active && debug_locks);
107 }
108
109 /**
110  * rcu_read_lock_held - might we be in RCU read-side critical section?
111  *
112  * If CONFIG_PROVE_LOCKING is selected and enabled, returns nonzero iff in
113  * an RCU read-side critical section.  In absence of CONFIG_PROVE_LOCKING,
114  * this assumes we are in an RCU read-side critical section unless it can
115  * prove otherwise.
116  *
117  * Check rcu_scheduler_active to prevent false positives during boot.
118  */
119 static inline int rcu_read_lock_held(void)
120 {
121         if (!debug_lockdep_rcu_enabled())
122                 return 1;
123         return lock_is_held(&rcu_lock_map);
124 }
125
126 /*
127  * rcu_read_lock_bh_held() is defined out of line to avoid #include-file
128  * hell.
129  */
130 extern int rcu_read_lock_bh_held(void);
131
132 /**
133  * rcu_read_lock_sched_held - might we be in RCU-sched read-side critical section?
134  *
135  * If CONFIG_PROVE_LOCKING is selected and enabled, returns nonzero iff in an
136  * RCU-sched read-side critical section.  In absence of CONFIG_PROVE_LOCKING,
137  * this assumes we are in an RCU-sched read-side critical section unless it
138  * can prove otherwise.  Note that disabling of preemption (including
139  * disabling irqs) counts as an RCU-sched read-side critical section.
140  *
141  * Check rcu_scheduler_active to prevent false positives during boot.
142  */
143 #ifdef CONFIG_PREEMPT
144 static inline int rcu_read_lock_sched_held(void)
145 {
146         int lockdep_opinion = 0;
147
148         if (!debug_lockdep_rcu_enabled())
149                 return 1;
150         if (debug_locks)
151                 lockdep_opinion = lock_is_held(&rcu_sched_lock_map);
152         return lockdep_opinion || preempt_count() != 0 || irqs_disabled();
153 }
154 #else /* #ifdef CONFIG_PREEMPT */
155 static inline int rcu_read_lock_sched_held(void)
156 {
157         return 1;
158 }
159 #endif /* #else #ifdef CONFIG_PREEMPT */
160
161 #else /* #ifdef CONFIG_DEBUG_LOCK_ALLOC */
162
163 # define rcu_read_acquire()             do { } while (0)
164 # define rcu_read_release()             do { } while (0)
165 # define rcu_read_acquire_bh()          do { } while (0)
166 # define rcu_read_release_bh()          do { } while (0)
167 # define rcu_read_acquire_sched()       do { } while (0)
168 # define rcu_read_release_sched()       do { } while (0)
169
170 static inline int rcu_read_lock_held(void)
171 {
172         return 1;
173 }
174
175 static inline int rcu_read_lock_bh_held(void)
176 {
177         return 1;
178 }
179
180 #ifdef CONFIG_PREEMPT
181 static inline int rcu_read_lock_sched_held(void)
182 {
183         return !rcu_scheduler_active || preempt_count() != 0 || irqs_disabled();
184 }
185 #else /* #ifdef CONFIG_PREEMPT */
186 static inline int rcu_read_lock_sched_held(void)
187 {
188         return 1;
189 }
190 #endif /* #else #ifdef CONFIG_PREEMPT */
191
192 #endif /* #else #ifdef CONFIG_DEBUG_LOCK_ALLOC */
193
194 #ifdef CONFIG_PROVE_RCU
195
196 /**
197  * rcu_dereference_check - rcu_dereference with debug checking
198  *
199  * Do an rcu_dereference(), but check that the context is correct.
200  * For example, rcu_dereference_check(gp, rcu_read_lock_held()) to
201  * ensure that the rcu_dereference_check() executes within an RCU
202  * read-side critical section.  It is also possible to check for
203  * locks being held, for example, by using lockdep_is_held().
204  */
205 #define rcu_dereference_check(p, c) \
206         ({ \
207                 if (debug_lockdep_rcu_enabled() && !(c)) \
208                         lockdep_rcu_dereference(__FILE__, __LINE__); \
209                 rcu_dereference_raw(p); \
210         })
211
212 /**
213  * rcu_dereference_protected - fetch RCU pointer when updates prevented
214  *
215  * Return the value of the specified RCU-protected pointer, but omit
216  * both the smp_read_barrier_depends() and the ACCESS_ONCE().  This
217  * is useful in cases where update-side locks prevent the value of the
218  * pointer from changing.  Please note that this primitive does -not-
219  * prevent the compiler from repeating this reference or combining it
220  * with other references, so it should not be used without protection
221  * of appropriate locks.
222  */
223 #define rcu_dereference_protected(p, c) \
224         ({ \
225                 if (debug_lockdep_rcu_enabled() && !(c)) \
226                         lockdep_rcu_dereference(__FILE__, __LINE__); \
227                 (p); \
228         })
229
230 #else /* #ifdef CONFIG_PROVE_RCU */
231
232 #define rcu_dereference_check(p, c)     rcu_dereference_raw(p)
233 #define rcu_dereference_protected(p, c) (p)
234
235 #endif /* #else #ifdef CONFIG_PROVE_RCU */
236
237 /**
238  * rcu_access_pointer - fetch RCU pointer with no dereferencing
239  *
240  * Return the value of the specified RCU-protected pointer, but omit the
241  * smp_read_barrier_depends() and keep the ACCESS_ONCE().  This is useful
242  * when the value of this pointer is accessed, but the pointer is not
243  * dereferenced, for example, when testing an RCU-protected pointer against
244  * NULL.  This may also be used in cases where update-side locks prevent
245  * the value of the pointer from changing, but rcu_dereference_protected()
246  * is a lighter-weight primitive for this use case.
247  */
248 #define rcu_access_pointer(p)   ACCESS_ONCE(p)
249
250 /**
251  * rcu_read_lock - mark the beginning of an RCU read-side critical section.
252  *
253  * When synchronize_rcu() is invoked on one CPU while other CPUs
254  * are within RCU read-side critical sections, then the
255  * synchronize_rcu() is guaranteed to block until after all the other
256  * CPUs exit their critical sections.  Similarly, if call_rcu() is invoked
257  * on one CPU while other CPUs are within RCU read-side critical
258  * sections, invocation of the corresponding RCU callback is deferred
259  * until after the all the other CPUs exit their critical sections.
260  *
261  * Note, however, that RCU callbacks are permitted to run concurrently
262  * with RCU read-side critical sections.  One way that this can happen
263  * is via the following sequence of events: (1) CPU 0 enters an RCU
264  * read-side critical section, (2) CPU 1 invokes call_rcu() to register
265  * an RCU callback, (3) CPU 0 exits the RCU read-side critical section,
266  * (4) CPU 2 enters a RCU read-side critical section, (5) the RCU
267  * callback is invoked.  This is legal, because the RCU read-side critical
268  * section that was running concurrently with the call_rcu() (and which
269  * therefore might be referencing something that the corresponding RCU
270  * callback would free up) has completed before the corresponding
271  * RCU callback is invoked.
272  *
273  * RCU read-side critical sections may be nested.  Any deferred actions
274  * will be deferred until the outermost RCU read-side critical section
275  * completes.
276  *
277  * It is illegal to block while in an RCU read-side critical section.
278  */
279 static inline void rcu_read_lock(void)
280 {
281         __rcu_read_lock();
282         __acquire(RCU);
283         rcu_read_acquire();
284 }
285
286 /*
287  * So where is rcu_write_lock()?  It does not exist, as there is no
288  * way for writers to lock out RCU readers.  This is a feature, not
289  * a bug -- this property is what provides RCU's performance benefits.
290  * Of course, writers must coordinate with each other.  The normal
291  * spinlock primitives work well for this, but any other technique may be
292  * used as well.  RCU does not care how the writers keep out of each
293  * others' way, as long as they do so.
294  */
295
296 /**
297  * rcu_read_unlock - marks the end of an RCU read-side critical section.
298  *
299  * See rcu_read_lock() for more information.
300  */
301 static inline void rcu_read_unlock(void)
302 {
303         rcu_read_release();
304         __release(RCU);
305         __rcu_read_unlock();
306 }
307
308 /**
309  * rcu_read_lock_bh - mark the beginning of a softirq-only RCU critical section
310  *
311  * This is equivalent of rcu_read_lock(), but to be used when updates
312  * are being done using call_rcu_bh(). Since call_rcu_bh() callbacks
313  * consider completion of a softirq handler to be a quiescent state,
314  * a process in RCU read-side critical section must be protected by
315  * disabling softirqs. Read-side critical sections in interrupt context
316  * can use just rcu_read_lock().
317  *
318  */
319 static inline void rcu_read_lock_bh(void)
320 {
321         __rcu_read_lock_bh();
322         __acquire(RCU_BH);
323         rcu_read_acquire_bh();
324 }
325
326 /*
327  * rcu_read_unlock_bh - marks the end of a softirq-only RCU critical section
328  *
329  * See rcu_read_lock_bh() for more information.
330  */
331 static inline void rcu_read_unlock_bh(void)
332 {
333         rcu_read_release_bh();
334         __release(RCU_BH);
335         __rcu_read_unlock_bh();
336 }
337
338 /**
339  * rcu_read_lock_sched - mark the beginning of a RCU-classic critical section
340  *
341  * Should be used with either
342  * - synchronize_sched()
343  * or
344  * - call_rcu_sched() and rcu_barrier_sched()
345  * on the write-side to insure proper synchronization.
346  */
347 static inline void rcu_read_lock_sched(void)
348 {
349         preempt_disable();
350         __acquire(RCU_SCHED);
351         rcu_read_acquire_sched();
352 }
353
354 /* Used by lockdep and tracing: cannot be traced, cannot call lockdep. */
355 static inline notrace void rcu_read_lock_sched_notrace(void)
356 {
357         preempt_disable_notrace();
358         __acquire(RCU_SCHED);
359 }
360
361 /*
362  * rcu_read_unlock_sched - marks the end of a RCU-classic critical section
363  *
364  * See rcu_read_lock_sched for more information.
365  */
366 static inline void rcu_read_unlock_sched(void)
367 {
368         rcu_read_release_sched();
369         __release(RCU_SCHED);
370         preempt_enable();
371 }
372
373 /* Used by lockdep and tracing: cannot be traced, cannot call lockdep. */
374 static inline notrace void rcu_read_unlock_sched_notrace(void)
375 {
376         __release(RCU_SCHED);
377         preempt_enable_notrace();
378 }
379
380
381 /**
382  * rcu_dereference_raw - fetch an RCU-protected pointer
383  *
384  * The caller must be within some flavor of RCU read-side critical
385  * section, or must be otherwise preventing the pointer from changing,
386  * for example, by holding an appropriate lock.  This pointer may later
387  * be safely dereferenced.  It is the caller's responsibility to have
388  * done the right thing, as this primitive does no checking of any kind.
389  *
390  * Inserts memory barriers on architectures that require them
391  * (currently only the Alpha), and, more importantly, documents
392  * exactly which pointers are protected by RCU.
393  */
394 #define rcu_dereference_raw(p)  ({ \
395                                 typeof(p) _________p1 = ACCESS_ONCE(p); \
396                                 smp_read_barrier_depends(); \
397                                 (_________p1); \
398                                 })
399
400 /**
401  * rcu_dereference - fetch an RCU-protected pointer, checking for RCU
402  *
403  * Makes rcu_dereference_check() do the dirty work.
404  */
405 #define rcu_dereference(p) \
406         rcu_dereference_check(p, rcu_read_lock_held())
407
408 /**
409  * rcu_dereference_bh - fetch an RCU-protected pointer, checking for RCU-bh
410  *
411  * Makes rcu_dereference_check() do the dirty work.
412  */
413 #define rcu_dereference_bh(p) \
414                 rcu_dereference_check(p, rcu_read_lock_bh_held())
415
416 /**
417  * rcu_dereference_sched - fetch RCU-protected pointer, checking for RCU-sched
418  *
419  * Makes rcu_dereference_check() do the dirty work.
420  */
421 #define rcu_dereference_sched(p) \
422                 rcu_dereference_check(p, rcu_read_lock_sched_held())
423
424 /**
425  * rcu_assign_pointer - assign (publicize) a pointer to a newly
426  * initialized structure that will be dereferenced by RCU read-side
427  * critical sections.  Returns the value assigned.
428  *
429  * Inserts memory barriers on architectures that require them
430  * (pretty much all of them other than x86), and also prevents
431  * the compiler from reordering the code that initializes the
432  * structure after the pointer assignment.  More importantly, this
433  * call documents which pointers will be dereferenced by RCU read-side
434  * code.
435  */
436
437 #define rcu_assign_pointer(p, v) \
438         ({ \
439                 if (!__builtin_constant_p(v) || \
440                     ((v) != NULL)) \
441                         smp_wmb(); \
442                 (p) = (v); \
443         })
444
445 /* Infrastructure to implement the synchronize_() primitives. */
446
447 struct rcu_synchronize {
448         struct rcu_head head;
449         struct completion completion;
450 };
451
452 extern void wakeme_after_rcu(struct rcu_head  *head);
453
454 /**
455  * call_rcu - Queue an RCU callback for invocation after a grace period.
456  * @head: structure to be used for queueing the RCU updates.
457  * @func: actual update function to be invoked after the grace period
458  *
459  * The update function will be invoked some time after a full grace
460  * period elapses, in other words after all currently executing RCU
461  * read-side critical sections have completed.  RCU read-side critical
462  * sections are delimited by rcu_read_lock() and rcu_read_unlock(),
463  * and may be nested.
464  */
465 extern void call_rcu(struct rcu_head *head,
466                               void (*func)(struct rcu_head *head));
467
468 /**
469  * call_rcu_bh - Queue an RCU for invocation after a quicker grace period.
470  * @head: structure to be used for queueing the RCU updates.
471  * @func: actual update function to be invoked after the grace period
472  *
473  * The update function will be invoked some time after a full grace
474  * period elapses, in other words after all currently executing RCU
475  * read-side critical sections have completed. call_rcu_bh() assumes
476  * that the read-side critical sections end on completion of a softirq
477  * handler. This means that read-side critical sections in process
478  * context must not be interrupted by softirqs. This interface is to be
479  * used when most of the read-side critical sections are in softirq context.
480  * RCU read-side critical sections are delimited by :
481  *  - rcu_read_lock() and  rcu_read_unlock(), if in interrupt context.
482  *  OR
483  *  - rcu_read_lock_bh() and rcu_read_unlock_bh(), if in process context.
484  *  These may be nested.
485  */
486 extern void call_rcu_bh(struct rcu_head *head,
487                         void (*func)(struct rcu_head *head));
488
489 #endif /* __LINUX_RCUPDATE_H */