SAFE public projects git trees. - safe/jmp/linux-2.6/blob - 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 #include <linux/kernel_stat.h>
  48
  49 #ifdef CONFIG_DEBUG_LOCK_ALLOC
  50 static struct lock_class_key rcu_lock_key;
  51 struct lockdep_map rcu_lock_map =
  52         STATIC_LOCKDEP_MAP_INIT("rcu_read_lock", &rcu_lock_key);
  53 EXPORT_SYMBOL_GPL(rcu_lock_map);
  54 #endif
  55
  56 static DEFINE_PER_CPU(struct rcu_head, rcu_barrier_head) = {NULL};
  57 static atomic_t rcu_barrier_cpu_count;
  58 static DEFINE_MUTEX(rcu_barrier_mutex);
  59 static struct completion rcu_barrier_completion;
  60 int rcu_scheduler_active __read_mostly;
  61
  62 static atomic_t rcu_migrate_type_count = ATOMIC_INIT(0);
  63 static struct rcu_head rcu_migrate_head[3];
  64 static DECLARE_WAIT_QUEUE_HEAD(rcu_migrate_wq);
  65
  66 /*
  67  * Awaken the corresponding synchronize_rcu() instance now that a
  68  * grace period has elapsed.
  69  */
  70 void wakeme_after_rcu(struct rcu_head  *head)
  71 {
  72         struct rcu_synchronize *rcu;
  73
  74         rcu = container_of(head, struct rcu_synchronize, head);
  75         complete(&rcu->completion);
  76 }
  77
  78 #ifdef CONFIG_TREE_PREEMPT_RCU
  79
  80 /**
  81  * synchronize_rcu - wait until a grace period has elapsed.
  82  *
  83  * Control will return to the caller some time after a full grace
  84  * period has elapsed, in other words after all currently executing RCU
  85  * read-side critical sections have completed.  RCU read-side critical
  86  * sections are delimited by rcu_read_lock() and rcu_read_unlock(),
  87  * and may be nested.
  88  */
  89 void synchronize_rcu(void)
  90 {
  91         struct rcu_synchronize rcu;
  92
  93         if (!rcu_scheduler_active)
  94                 return;
  95
  96         init_completion(&rcu.completion);
  97         /* Will wake me after RCU finished. */
  98         call_rcu(&rcu.head, wakeme_after_rcu);
  99         /* Wait for it. */
 100         wait_for_completion(&rcu.completion);
 101 }
 102 EXPORT_SYMBOL_GPL(synchronize_rcu);
 103
 104 #endif /* #ifdef CONFIG_TREE_PREEMPT_RCU */
 105
 106 /**
 107  * synchronize_sched - wait until an rcu-sched grace period has elapsed.
 108  *
 109  * Control will return to the caller some time after a full rcu-sched
 110  * grace period has elapsed, in other words after all currently executing
 111  * rcu-sched read-side critical sections have completed.   These read-side
 112  * critical sections are delimited by rcu_read_lock_sched() and
 113  * rcu_read_unlock_sched(), and may be nested.  Note that preempt_disable(),
 114  * local_irq_disable(), and so on may be used in place of
 115  * rcu_read_lock_sched().
 116  *
 117  * This means that all preempt_disable code sequences, including NMI and
 118  * hardware-interrupt handlers, in progress on entry will have completed
 119  * before this primitive returns.  However, this does not guarantee that
 120  * softirq handlers will have completed, since in some kernels, these
 121  * handlers can run in process context, and can block.
 122  *
 123  * This primitive provides the guarantees made by the (now removed)
 124  * synchronize_kernel() API.  In contrast, synchronize_rcu() only
 125  * guarantees that rcu_read_lock() sections will have completed.
 126  * In "classic RCU", these two guarantees happen to be one and
 127  * the same, but can differ in realtime RCU implementations.
 128  */
 129 void synchronize_sched(void)
 130 {
 131         struct rcu_synchronize rcu;
 132
 133         if (rcu_blocking_is_gp())
 134                 return;
 135
 136         init_completion(&rcu.completion);
 137         /* Will wake me after RCU finished. */
 138         call_rcu_sched(&rcu.head, wakeme_after_rcu);
 139         /* Wait for it. */
 140         wait_for_completion(&rcu.completion);
 141 }
 142 EXPORT_SYMBOL_GPL(synchronize_sched);
 143
 144 /**
 145  * synchronize_rcu_bh - wait until an rcu_bh grace period has elapsed.
 146  *
 147  * Control will return to the caller some time after a full rcu_bh grace
 148  * period has elapsed, in other words after all currently executing rcu_bh
 149  * read-side critical sections have completed.  RCU read-side critical
 150  * sections are delimited by rcu_read_lock_bh() and rcu_read_unlock_bh(),
 151  * and may be nested.
 152  */
 153 void synchronize_rcu_bh(void)
 154 {
 155         struct rcu_synchronize rcu;
 156
 157         if (rcu_blocking_is_gp())
 158                 return;
 159
 160         init_completion(&rcu.completion);
 161         /* Will wake me after RCU finished. */
 162         call_rcu_bh(&rcu.head, wakeme_after_rcu);
 163         /* Wait for it. */
 164         wait_for_completion(&rcu.completion);
 165 }
 166 EXPORT_SYMBOL_GPL(synchronize_rcu_bh);
 167
 168 static void rcu_barrier_callback(struct rcu_head *notused)
 169 {
 170         if (atomic_dec_and_test(&rcu_barrier_cpu_count))
 171                 complete(&rcu_barrier_completion);
 172 }
 173
 174 /*
 175  * Called with preemption disabled, and from cross-cpu IRQ context.
 176  */
 177 static void rcu_barrier_func(void *type)
 178 {
 179         int cpu = smp_processor_id();
 180         struct rcu_head *head = &per_cpu(rcu_barrier_head, cpu);
 181         void (*call_rcu_func)(struct rcu_head *head,
 182                               void (*func)(struct rcu_head *head));
 183
 184         atomic_inc(&rcu_barrier_cpu_count);
 185         call_rcu_func = type;
 186         call_rcu_func(head, rcu_barrier_callback);
 187 }
 188
 189 static inline void wait_migrated_callbacks(void)
 190 {
 191         wait_event(rcu_migrate_wq, !atomic_read(&rcu_migrate_type_count));
 192         smp_mb(); /* In case we didn't sleep. */
 193 }
 194
 195 /*
 196  * Orchestrate the specified type of RCU barrier, waiting for all
 197  * RCU callbacks of the specified type to complete.
 198  */
 199 static void _rcu_barrier(void (*call_rcu_func)(struct rcu_head *head,
 200                                                void (*func)(struct rcu_head *head)))
 201 {
 202         BUG_ON(in_interrupt());
 203         /* Take cpucontrol mutex to protect against CPU hotplug */
 204         mutex_lock(&rcu_barrier_mutex);
 205         init_completion(&rcu_barrier_completion);
 206         /*
 207          * Initialize rcu_barrier_cpu_count to 1, then invoke
 208          * rcu_barrier_func() on each CPU, so that each CPU also has
 209          * incremented rcu_barrier_cpu_count.  Only then is it safe to
 210          * decrement rcu_barrier_cpu_count -- otherwise the first CPU
 211          * might complete its grace period before all of the other CPUs
 212          * did their increment, causing this function to return too
 213          * early.
 214          */
 215         atomic_set(&rcu_barrier_cpu_count, 1);
 216         on_each_cpu(rcu_barrier_func, (void *)call_rcu_func, 1);
 217         if (atomic_dec_and_test(&rcu_barrier_cpu_count))
 218                 complete(&rcu_barrier_completion);
 219         wait_for_completion(&rcu_barrier_completion);
 220         mutex_unlock(&rcu_barrier_mutex);
 221         wait_migrated_callbacks();
 222 }
 223
 224 /**
 225  * rcu_barrier - Wait until all in-flight call_rcu() callbacks complete.
 226  */
 227 void rcu_barrier(void)
 228 {
 229         _rcu_barrier(call_rcu);
 230 }
 231 EXPORT_SYMBOL_GPL(rcu_barrier);
 232
 233 /**
 234  * rcu_barrier_bh - Wait until all in-flight call_rcu_bh() callbacks complete.
 235  */
 236 void rcu_barrier_bh(void)
 237 {
 238         _rcu_barrier(call_rcu_bh);
 239 }
 240 EXPORT_SYMBOL_GPL(rcu_barrier_bh);
 241
 242 /**
 243  * rcu_barrier_sched - Wait for in-flight call_rcu_sched() callbacks.
 244  */
 245 void rcu_barrier_sched(void)
 246 {
 247         _rcu_barrier(call_rcu_sched);
 248 }
 249 EXPORT_SYMBOL_GPL(rcu_barrier_sched);
 250
 251 static void rcu_migrate_callback(struct rcu_head *notused)
 252 {
 253         if (atomic_dec_and_test(&rcu_migrate_type_count))
 254                 wake_up(&rcu_migrate_wq);
 255 }
 256
 257 static int __cpuinit rcu_barrier_cpu_hotplug(struct notifier_block *self,
 258                 unsigned long action, void *hcpu)
 259 {
 260         rcu_cpu_notify(self, action, hcpu);
 261         if (action == CPU_DYING) {
 262                 /*
 263                  * preempt_disable() in on_each_cpu() prevents stop_machine(),
 264                  * so when "on_each_cpu(rcu_barrier_func, (void *)type, 1);"
 265                  * returns, all online cpus have queued rcu_barrier_func(),
 266                  * and the dead cpu(if it exist) queues rcu_migrate_callback()s.
 267                  *
 268                  * These callbacks ensure _rcu_barrier() waits for all
 269                  * RCU callbacks of the specified type to complete.
 270                  */
 271                 atomic_set(&rcu_migrate_type_count, 3);
 272                 call_rcu_bh(rcu_migrate_head, rcu_migrate_callback);
 273                 call_rcu_sched(rcu_migrate_head + 1, rcu_migrate_callback);
 274                 call_rcu(rcu_migrate_head + 2, rcu_migrate_callback);
 275         } else if (action == CPU_DOWN_PREPARE) {
 276                 /* Don't need to wait until next removal operation. */
 277                 /* rcu_migrate_head is protected by cpu_add_remove_lock */
 278                 wait_migrated_callbacks();
 279         }
 280
 281         return NOTIFY_OK;
 282 }
 283
 284 void __init rcu_init(void)
 285 {
 286         int i;
 287
 288         __rcu_init();
 289         cpu_notifier(rcu_barrier_cpu_hotplug, 0);
 290
 291         /*
 292          * We don't need protection against CPU-hotplug here because
 293          * this is called early in boot, before either interrupts
 294          * or the scheduler are operational.
 295          */
 296         for_each_online_cpu(i)
 297                 rcu_barrier_cpu_hotplug(NULL, CPU_UP_PREPARE, (void *)(long)i);
 298 }
 299
 300 void rcu_scheduler_starting(void)
 301 {
 302         WARN_ON(num_online_cpus() != 1);
 303         WARN_ON(nr_context_switches() > 0);
 304         rcu_scheduler_active = 1;
 305 }