Merge branch 'for-linus' of git://git.kernel.org/pub/scm/linux/kernel/git/roland...
[linux-2.6] / kernel / rcupdate.c
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  * Authors: Dipankar Sarma <dipankar@in.ibm.com>
21  *          Manfred Spraul <manfred@colorfullife.com>
22  * 
23  * Based on the original work by Paul McKenney <paulmck@us.ibm.com>
24  * and inputs from Rusty Russell, Andrea Arcangeli and Andi Kleen.
25  * Papers:
26  * http://www.rdrop.com/users/paulmck/paper/rclockpdcsproof.pdf
27  * http://lse.sourceforge.net/locking/rclock_OLS.2001.05.01c.sc.pdf (OLS2001)
28  *
29  * For detailed explanation of Read-Copy Update mechanism see -
30  *              http://lse.sourceforge.net/locking/rcupdate.html
31  *
32  */
33 #include <linux/types.h>
34 #include <linux/kernel.h>
35 #include <linux/init.h>
36 #include <linux/spinlock.h>
37 #include <linux/smp.h>
38 #include <linux/interrupt.h>
39 #include <linux/sched.h>
40 #include <asm/atomic.h>
41 #include <linux/bitops.h>
42 #include <linux/percpu.h>
43 #include <linux/notifier.h>
44 #include <linux/cpu.h>
45 #include <linux/mutex.h>
46 #include <linux/module.h>
47
48 enum rcu_barrier {
49         RCU_BARRIER_STD,
50         RCU_BARRIER_BH,
51         RCU_BARRIER_SCHED,
52 };
53
54 static DEFINE_PER_CPU(struct rcu_head, rcu_barrier_head) = {NULL};
55 static atomic_t rcu_barrier_cpu_count;
56 static DEFINE_MUTEX(rcu_barrier_mutex);
57 static struct completion rcu_barrier_completion;
58
59 /*
60  * Awaken the corresponding synchronize_rcu() instance now that a
61  * grace period has elapsed.
62  */
63 void wakeme_after_rcu(struct rcu_head  *head)
64 {
65         struct rcu_synchronize *rcu;
66
67         rcu = container_of(head, struct rcu_synchronize, head);
68         complete(&rcu->completion);
69 }
70
71 /**
72  * synchronize_rcu - wait until a grace period has elapsed.
73  *
74  * Control will return to the caller some time after a full grace
75  * period has elapsed, in other words after all currently executing RCU
76  * read-side critical sections have completed.  RCU read-side critical
77  * sections are delimited by rcu_read_lock() and rcu_read_unlock(),
78  * and may be nested.
79  */
80 synchronize_rcu_xxx(synchronize_rcu, call_rcu)
81 EXPORT_SYMBOL_GPL(synchronize_rcu);
82
83 static void rcu_barrier_callback(struct rcu_head *notused)
84 {
85         if (atomic_dec_and_test(&rcu_barrier_cpu_count))
86                 complete(&rcu_barrier_completion);
87 }
88
89 /*
90  * Called with preemption disabled, and from cross-cpu IRQ context.
91  */
92 static void rcu_barrier_func(void *type)
93 {
94         int cpu = smp_processor_id();
95         struct rcu_head *head = &per_cpu(rcu_barrier_head, cpu);
96
97         atomic_inc(&rcu_barrier_cpu_count);
98         switch ((enum rcu_barrier)type) {
99         case RCU_BARRIER_STD:
100                 call_rcu(head, rcu_barrier_callback);
101                 break;
102         case RCU_BARRIER_BH:
103                 call_rcu_bh(head, rcu_barrier_callback);
104                 break;
105         case RCU_BARRIER_SCHED:
106                 call_rcu_sched(head, rcu_barrier_callback);
107                 break;
108         }
109 }
110
111 /*
112  * Orchestrate the specified type of RCU barrier, waiting for all
113  * RCU callbacks of the specified type to complete.
114  */
115 static void _rcu_barrier(enum rcu_barrier type)
116 {
117         BUG_ON(in_interrupt());
118         /* Take cpucontrol mutex to protect against CPU hotplug */
119         mutex_lock(&rcu_barrier_mutex);
120         init_completion(&rcu_barrier_completion);
121         atomic_set(&rcu_barrier_cpu_count, 0);
122         /*
123          * The queueing of callbacks in all CPUs must be atomic with
124          * respect to RCU, otherwise one CPU may queue a callback,
125          * wait for a grace period, decrement barrier count and call
126          * complete(), while other CPUs have not yet queued anything.
127          * So, we need to make sure that grace periods cannot complete
128          * until all the callbacks are queued.
129          */
130         rcu_read_lock();
131         on_each_cpu(rcu_barrier_func, (void *)type, 1);
132         rcu_read_unlock();
133         wait_for_completion(&rcu_barrier_completion);
134         mutex_unlock(&rcu_barrier_mutex);
135 }
136
137 /**
138  * rcu_barrier - Wait until all in-flight call_rcu() callbacks complete.
139  */
140 void rcu_barrier(void)
141 {
142         _rcu_barrier(RCU_BARRIER_STD);
143 }
144 EXPORT_SYMBOL_GPL(rcu_barrier);
145
146 /**
147  * rcu_barrier_bh - Wait until all in-flight call_rcu_bh() callbacks complete.
148  */
149 void rcu_barrier_bh(void)
150 {
151         _rcu_barrier(RCU_BARRIER_BH);
152 }
153 EXPORT_SYMBOL_GPL(rcu_barrier_bh);
154
155 /**
156  * rcu_barrier_sched - Wait for in-flight call_rcu_sched() callbacks.
157  */
158 void rcu_barrier_sched(void)
159 {
160         _rcu_barrier(RCU_BARRIER_SCHED);
161 }
162 EXPORT_SYMBOL_GPL(rcu_barrier_sched);
163
164 void __init rcu_init(void)
165 {
166         __rcu_init();
167 }
168