blob: 03a7ea1579f614f6c24ef16384cfe253b9d94918 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
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 *
Paul E. McKenney01c1c662008-01-25 21:08:24 +010018 * Copyright IBM Corporation, 2001
Linus Torvalds1da177e2005-04-16 15:20:36 -070019 *
20 * Authors: Dipankar Sarma <dipankar@in.ibm.com>
21 * Manfred Spraul <manfred@colorfullife.com>
Paul E. McKenneya71fca52009-09-18 10:28:19 -070022 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070023 * 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 -
Paul E. McKenneya71fca52009-09-18 10:28:19 -070030 * http://lse.sourceforge.net/locking/rcupdate.html
Linus Torvalds1da177e2005-04-16 15:20:36 -070031 *
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>
Linus Torvalds1da177e2005-04-16 15:20:36 -070042#include <linux/percpu.h>
43#include <linux/notifier.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070044#include <linux/cpu.h>
Ingo Molnar9331b312006-03-23 03:00:19 -080045#include <linux/mutex.h>
Paul E. McKenney01c1c662008-01-25 21:08:24 +010046#include <linux/module.h>
Paul E. McKenneyd9f1bb62010-02-25 14:06:47 -080047#include <linux/kernel_stat.h>
Paul E. McKenneye3818b82010-03-15 17:03:43 -070048#include <linux/hardirq.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070049
Paul E. McKenney162cc272009-09-23 16:18:13 -070050#ifdef CONFIG_DEBUG_LOCK_ALLOC
51static struct lock_class_key rcu_lock_key;
52struct lockdep_map rcu_lock_map =
53 STATIC_LOCKDEP_MAP_INIT("rcu_read_lock", &rcu_lock_key);
54EXPORT_SYMBOL_GPL(rcu_lock_map);
Paul E. McKenney632ee202010-02-22 17:04:45 -080055
56static struct lock_class_key rcu_bh_lock_key;
57struct lockdep_map rcu_bh_lock_map =
58 STATIC_LOCKDEP_MAP_INIT("rcu_read_lock_bh", &rcu_bh_lock_key);
59EXPORT_SYMBOL_GPL(rcu_bh_lock_map);
60
61static struct lock_class_key rcu_sched_lock_key;
62struct lockdep_map rcu_sched_lock_map =
63 STATIC_LOCKDEP_MAP_INIT("rcu_read_lock_sched", &rcu_sched_lock_key);
64EXPORT_SYMBOL_GPL(rcu_sched_lock_map);
Paul E. McKenney162cc272009-09-23 16:18:13 -070065#endif
66
Paul E. McKenneyd9f1bb62010-02-25 14:06:47 -080067int rcu_scheduler_active __read_mostly;
Paul E. McKenneyf5f65402010-02-25 19:02:30 -080068EXPORT_SYMBOL_GPL(rcu_scheduler_active);
Paul E. McKenneyd9f1bb62010-02-25 14:06:47 -080069
Paul E. McKenneye3818b82010-03-15 17:03:43 -070070#ifdef CONFIG_DEBUG_LOCK_ALLOC
71
Paul E. McKenneybc293d62010-04-15 12:50:39 -070072int debug_lockdep_rcu_enabled(void)
73{
74 return rcu_scheduler_active && debug_locks &&
75 current->lockdep_recursion == 0;
76}
77EXPORT_SYMBOL_GPL(debug_lockdep_rcu_enabled);
78
Paul E. McKenneye3818b82010-03-15 17:03:43 -070079/**
80 * rcu_read_lock_bh_held - might we be in RCU-bh read-side critical section?
81 *
82 * Check for bottom half being disabled, which covers both the
83 * CONFIG_PROVE_RCU and not cases. Note that if someone uses
84 * rcu_read_lock_bh(), but then later enables BH, lockdep (if enabled)
85 * will show the situation.
86 *
87 * Check debug_lockdep_rcu_enabled() to prevent false positives during boot.
88 */
89int rcu_read_lock_bh_held(void)
90{
91 if (!debug_lockdep_rcu_enabled())
92 return 1;
93 return in_softirq();
94}
95EXPORT_SYMBOL_GPL(rcu_read_lock_bh_held);
96
97#endif /* #ifdef CONFIG_DEBUG_LOCK_ALLOC */
98
Paul E. McKenneyd9f1bb62010-02-25 14:06:47 -080099/*
100 * This function is invoked towards the end of the scheduler's initialization
101 * process. Before this is called, the idle task might contain
102 * RCU read-side critical sections (during which time, this idle
103 * task is booting the system). After this function is called, the
104 * idle tasks are prohibited from containing RCU read-side critical
105 * sections.
106 */
107void rcu_scheduler_starting(void)
108{
109 WARN_ON(num_online_cpus() != 1);
110 WARN_ON(nr_context_switches() > 0);
111 rcu_scheduler_active = 1;
112}
113
Paul E. McKenneyfbf6bfc2008-02-13 15:03:15 -0800114/*
115 * Awaken the corresponding synchronize_rcu() instance now that a
116 * grace period has elapsed.
117 */
Paul E. McKenney4446a362008-05-12 21:21:05 +0200118void wakeme_after_rcu(struct rcu_head *head)
Dipankar Sarma21a1ea92006-03-07 21:55:33 -0800119{
Paul E. McKenney01c1c662008-01-25 21:08:24 +0100120 struct rcu_synchronize *rcu;
121
122 rcu = container_of(head, struct rcu_synchronize, head);
123 complete(&rcu->completion);
Dipankar Sarma21a1ea92006-03-07 21:55:33 -0800124}