blob: 4755b98b6dfb83b01055a1856739b7a805839466 [file] [log] [blame]
Ingo Molnarfb1c8f92005-09-10 00:25:56 -07001/*
2 * Copyright 2005, Red Hat, Inc., Ingo Molnar
3 * Released under the General Public License (GPL).
4 *
5 * This file contains the spinlock/rwlock implementations for
6 * DEBUG_SPINLOCK.
7 */
8
Ingo Molnarfb1c8f92005-09-10 00:25:56 -07009#include <linux/spinlock.h>
Andrew Mortonbb81a092006-12-07 02:14:01 +010010#include <linux/nmi.h>
Ingo Molnarfb1c8f92005-09-10 00:25:56 -070011#include <linux/interrupt.h>
Ingo Molnar9a11b49a2006-07-03 00:24:33 -070012#include <linux/debug_locks.h>
Ingo Molnarfb1c8f92005-09-10 00:25:56 -070013#include <linux/delay.h>
Ingo Molnar9a11b49a2006-07-03 00:24:33 -070014#include <linux/module.h>
Ingo Molnarfb1c8f92005-09-10 00:25:56 -070015
Thomas Gleixnerc2f21ce2009-12-02 20:02:59 +010016void __raw_spin_lock_init(raw_spinlock_t *lock, const char *name,
17 struct lock_class_key *key)
Ingo Molnar8a25d5d2006-07-03 00:24:54 -070018{
19#ifdef CONFIG_DEBUG_LOCK_ALLOC
20 /*
21 * Make sure we are not reinitializing a held lock:
22 */
23 debug_check_no_locks_freed((void *)lock, sizeof(*lock));
Peter Zijlstra4dfbb9d2006-10-11 01:45:14 -040024 lockdep_init_map(&lock->dep_map, name, key, 0);
Ingo Molnar8a25d5d2006-07-03 00:24:54 -070025#endif
Thomas Gleixneredc35bd2009-12-03 12:38:57 +010026 lock->raw_lock = (arch_spinlock_t)__ARCH_SPIN_LOCK_UNLOCKED;
Ingo Molnar8a25d5d2006-07-03 00:24:54 -070027 lock->magic = SPINLOCK_MAGIC;
28 lock->owner = SPINLOCK_OWNER_INIT;
29 lock->owner_cpu = -1;
30}
31
Thomas Gleixnerc2f21ce2009-12-02 20:02:59 +010032EXPORT_SYMBOL(__raw_spin_lock_init);
Ingo Molnar8a25d5d2006-07-03 00:24:54 -070033
34void __rwlock_init(rwlock_t *lock, const char *name,
35 struct lock_class_key *key)
36{
37#ifdef CONFIG_DEBUG_LOCK_ALLOC
38 /*
39 * Make sure we are not reinitializing a held lock:
40 */
41 debug_check_no_locks_freed((void *)lock, sizeof(*lock));
Peter Zijlstra4dfbb9d2006-10-11 01:45:14 -040042 lockdep_init_map(&lock->dep_map, name, key, 0);
Ingo Molnar8a25d5d2006-07-03 00:24:54 -070043#endif
Thomas Gleixnerfb3a6bb2009-12-03 20:01:19 +010044 lock->raw_lock = (arch_rwlock_t) __ARCH_RW_LOCK_UNLOCKED;
Ingo Molnar8a25d5d2006-07-03 00:24:54 -070045 lock->magic = RWLOCK_MAGIC;
46 lock->owner = SPINLOCK_OWNER_INIT;
47 lock->owner_cpu = -1;
48}
49
50EXPORT_SYMBOL(__rwlock_init);
51
Thomas Gleixnerc2f21ce2009-12-02 20:02:59 +010052static void spin_bug(raw_spinlock_t *lock, const char *msg)
Ingo Molnarfb1c8f92005-09-10 00:25:56 -070053{
Ingo Molnarfb1c8f92005-09-10 00:25:56 -070054 struct task_struct *owner = NULL;
55
Ingo Molnar9a11b49a2006-07-03 00:24:33 -070056 if (!debug_locks_off())
57 return;
58
59 if (lock->owner && lock->owner != SPINLOCK_OWNER_INIT)
60 owner = lock->owner;
61 printk(KERN_EMERG "BUG: spinlock %s on CPU#%d, %s/%d\n",
62 msg, raw_smp_processor_id(),
Pavel Emelyanovba25f9d2007-10-18 23:40:40 -070063 current->comm, task_pid_nr(current));
Ingo Molnar9a11b49a2006-07-03 00:24:33 -070064 printk(KERN_EMERG " lock: %p, .magic: %08x, .owner: %s/%d, "
65 ".owner_cpu: %d\n",
66 lock, lock->magic,
67 owner ? owner->comm : "<none>",
Pavel Emelyanovba25f9d2007-10-18 23:40:40 -070068 owner ? task_pid_nr(owner) : -1,
Ingo Molnar9a11b49a2006-07-03 00:24:33 -070069 lock->owner_cpu);
70 dump_stack();
Ingo Molnarfb1c8f92005-09-10 00:25:56 -070071}
72
73#define SPIN_BUG_ON(cond, lock, msg) if (unlikely(cond)) spin_bug(lock, msg)
74
Ingo Molnar9a11b49a2006-07-03 00:24:33 -070075static inline void
Thomas Gleixnerc2f21ce2009-12-02 20:02:59 +010076debug_spin_lock_before(raw_spinlock_t *lock)
Ingo Molnarfb1c8f92005-09-10 00:25:56 -070077{
78 SPIN_BUG_ON(lock->magic != SPINLOCK_MAGIC, lock, "bad magic");
79 SPIN_BUG_ON(lock->owner == current, lock, "recursion");
80 SPIN_BUG_ON(lock->owner_cpu == raw_smp_processor_id(),
81 lock, "cpu recursion");
82}
83
Thomas Gleixnerc2f21ce2009-12-02 20:02:59 +010084static inline void debug_spin_lock_after(raw_spinlock_t *lock)
Ingo Molnarfb1c8f92005-09-10 00:25:56 -070085{
86 lock->owner_cpu = raw_smp_processor_id();
87 lock->owner = current;
88}
89
Thomas Gleixnerc2f21ce2009-12-02 20:02:59 +010090static inline void debug_spin_unlock(raw_spinlock_t *lock)
Ingo Molnarfb1c8f92005-09-10 00:25:56 -070091{
92 SPIN_BUG_ON(lock->magic != SPINLOCK_MAGIC, lock, "bad magic");
Thomas Gleixnerc2f21ce2009-12-02 20:02:59 +010093 SPIN_BUG_ON(!raw_spin_is_locked(lock), lock, "already unlocked");
Ingo Molnarfb1c8f92005-09-10 00:25:56 -070094 SPIN_BUG_ON(lock->owner != current, lock, "wrong owner");
95 SPIN_BUG_ON(lock->owner_cpu != raw_smp_processor_id(),
96 lock, "wrong CPU");
97 lock->owner = SPINLOCK_OWNER_INIT;
98 lock->owner_cpu = -1;
99}
100
Thomas Gleixnerc2f21ce2009-12-02 20:02:59 +0100101static void __spin_lock_debug(raw_spinlock_t *lock)
Ingo Molnarfb1c8f92005-09-10 00:25:56 -0700102{
Ingo Molnarfb1c8f92005-09-10 00:25:56 -0700103 u64 i;
Chuck Ebbertc22f0082006-09-29 01:59:14 -0700104 u64 loops = loops_per_jiffy * HZ;
105 int print_once = 1;
Ingo Molnarfb1c8f92005-09-10 00:25:56 -0700106
107 for (;;) {
Chuck Ebbertc22f0082006-09-29 01:59:14 -0700108 for (i = 0; i < loops; i++) {
Thomas Gleixner0199c4e2009-12-02 20:01:25 +0100109 if (arch_spin_trylock(&lock->raw_lock))
Ingo Molnarfb1c8f92005-09-10 00:25:56 -0700110 return;
Ingo Molnare0a60292006-02-07 12:58:54 -0800111 __delay(1);
Ingo Molnarfb1c8f92005-09-10 00:25:56 -0700112 }
113 /* lockup suspected: */
114 if (print_once) {
115 print_once = 0;
Dave Jones51989b92006-01-09 20:51:32 -0800116 printk(KERN_EMERG "BUG: spinlock lockup on CPU#%d, "
117 "%s/%d, %p\n",
Ingo Molnarbb44f112005-12-20 11:54:17 +0100118 raw_smp_processor_id(), current->comm,
Pavel Emelyanovba25f9d2007-10-18 23:40:40 -0700119 task_pid_nr(current), lock);
Ingo Molnarfb1c8f92005-09-10 00:25:56 -0700120 dump_stack();
Andrew Mortonbb81a092006-12-07 02:14:01 +0100121#ifdef CONFIG_SMP
122 trigger_all_cpu_backtrace();
123#endif
Ingo Molnarfb1c8f92005-09-10 00:25:56 -0700124 }
125 }
126}
127
Thomas Gleixner9828ea92009-12-03 20:55:53 +0100128void do_raw_spin_lock(raw_spinlock_t *lock)
Ingo Molnarfb1c8f92005-09-10 00:25:56 -0700129{
130 debug_spin_lock_before(lock);
Thomas Gleixner0199c4e2009-12-02 20:01:25 +0100131 if (unlikely(!arch_spin_trylock(&lock->raw_lock)))
Ingo Molnarfb1c8f92005-09-10 00:25:56 -0700132 __spin_lock_debug(lock);
133 debug_spin_lock_after(lock);
134}
135
Thomas Gleixner9828ea92009-12-03 20:55:53 +0100136int do_raw_spin_trylock(raw_spinlock_t *lock)
Ingo Molnarfb1c8f92005-09-10 00:25:56 -0700137{
Thomas Gleixner0199c4e2009-12-02 20:01:25 +0100138 int ret = arch_spin_trylock(&lock->raw_lock);
Ingo Molnarfb1c8f92005-09-10 00:25:56 -0700139
140 if (ret)
141 debug_spin_lock_after(lock);
142#ifndef CONFIG_SMP
143 /*
144 * Must not happen on UP:
145 */
146 SPIN_BUG_ON(!ret, lock, "trylock failure on UP");
147#endif
148 return ret;
149}
150
Thomas Gleixner9828ea92009-12-03 20:55:53 +0100151void do_raw_spin_unlock(raw_spinlock_t *lock)
Ingo Molnarfb1c8f92005-09-10 00:25:56 -0700152{
153 debug_spin_unlock(lock);
Thomas Gleixner0199c4e2009-12-02 20:01:25 +0100154 arch_spin_unlock(&lock->raw_lock);
Ingo Molnarfb1c8f92005-09-10 00:25:56 -0700155}
156
157static void rwlock_bug(rwlock_t *lock, const char *msg)
158{
Ingo Molnar9a11b49a2006-07-03 00:24:33 -0700159 if (!debug_locks_off())
160 return;
Ingo Molnarfb1c8f92005-09-10 00:25:56 -0700161
Ingo Molnar9a11b49a2006-07-03 00:24:33 -0700162 printk(KERN_EMERG "BUG: rwlock %s on CPU#%d, %s/%d, %p\n",
163 msg, raw_smp_processor_id(), current->comm,
Pavel Emelyanovba25f9d2007-10-18 23:40:40 -0700164 task_pid_nr(current), lock);
Ingo Molnar9a11b49a2006-07-03 00:24:33 -0700165 dump_stack();
Ingo Molnarfb1c8f92005-09-10 00:25:56 -0700166}
167
168#define RWLOCK_BUG_ON(cond, lock, msg) if (unlikely(cond)) rwlock_bug(lock, msg)
169
Andrew Morton72f0b4e2006-08-05 12:13:47 -0700170#if 0 /* __write_lock_debug() can lock up - maybe this can too? */
Ingo Molnarfb1c8f92005-09-10 00:25:56 -0700171static void __read_lock_debug(rwlock_t *lock)
172{
Ingo Molnarfb1c8f92005-09-10 00:25:56 -0700173 u64 i;
Chuck Ebbertc22f0082006-09-29 01:59:14 -0700174 u64 loops = loops_per_jiffy * HZ;
175 int print_once = 1;
Ingo Molnarfb1c8f92005-09-10 00:25:56 -0700176
177 for (;;) {
Chuck Ebbertc22f0082006-09-29 01:59:14 -0700178 for (i = 0; i < loops; i++) {
Thomas Gleixnere5931942009-12-03 20:08:46 +0100179 if (arch_read_trylock(&lock->raw_lock))
Ingo Molnarfb1c8f92005-09-10 00:25:56 -0700180 return;
Ingo Molnare0a60292006-02-07 12:58:54 -0800181 __delay(1);
Ingo Molnarfb1c8f92005-09-10 00:25:56 -0700182 }
183 /* lockup suspected: */
184 if (print_once) {
185 print_once = 0;
Dave Jones51989b92006-01-09 20:51:32 -0800186 printk(KERN_EMERG "BUG: read-lock lockup on CPU#%d, "
187 "%s/%d, %p\n",
Ingo Molnarbb44f112005-12-20 11:54:17 +0100188 raw_smp_processor_id(), current->comm,
189 current->pid, lock);
Ingo Molnarfb1c8f92005-09-10 00:25:56 -0700190 dump_stack();
191 }
192 }
193}
Andrew Morton72f0b4e2006-08-05 12:13:47 -0700194#endif
Ingo Molnarfb1c8f92005-09-10 00:25:56 -0700195
Thomas Gleixner9828ea92009-12-03 20:55:53 +0100196void do_raw_read_lock(rwlock_t *lock)
Ingo Molnarfb1c8f92005-09-10 00:25:56 -0700197{
198 RWLOCK_BUG_ON(lock->magic != RWLOCK_MAGIC, lock, "bad magic");
Thomas Gleixnere5931942009-12-03 20:08:46 +0100199 arch_read_lock(&lock->raw_lock);
Ingo Molnarfb1c8f92005-09-10 00:25:56 -0700200}
201
Thomas Gleixner9828ea92009-12-03 20:55:53 +0100202int do_raw_read_trylock(rwlock_t *lock)
Ingo Molnarfb1c8f92005-09-10 00:25:56 -0700203{
Thomas Gleixnere5931942009-12-03 20:08:46 +0100204 int ret = arch_read_trylock(&lock->raw_lock);
Ingo Molnarfb1c8f92005-09-10 00:25:56 -0700205
206#ifndef CONFIG_SMP
207 /*
208 * Must not happen on UP:
209 */
210 RWLOCK_BUG_ON(!ret, lock, "trylock failure on UP");
211#endif
212 return ret;
213}
214
Thomas Gleixner9828ea92009-12-03 20:55:53 +0100215void do_raw_read_unlock(rwlock_t *lock)
Ingo Molnarfb1c8f92005-09-10 00:25:56 -0700216{
217 RWLOCK_BUG_ON(lock->magic != RWLOCK_MAGIC, lock, "bad magic");
Thomas Gleixnere5931942009-12-03 20:08:46 +0100218 arch_read_unlock(&lock->raw_lock);
Ingo Molnarfb1c8f92005-09-10 00:25:56 -0700219}
220
221static inline void debug_write_lock_before(rwlock_t *lock)
222{
223 RWLOCK_BUG_ON(lock->magic != RWLOCK_MAGIC, lock, "bad magic");
224 RWLOCK_BUG_ON(lock->owner == current, lock, "recursion");
225 RWLOCK_BUG_ON(lock->owner_cpu == raw_smp_processor_id(),
226 lock, "cpu recursion");
227}
228
229static inline void debug_write_lock_after(rwlock_t *lock)
230{
231 lock->owner_cpu = raw_smp_processor_id();
232 lock->owner = current;
233}
234
235static inline void debug_write_unlock(rwlock_t *lock)
236{
237 RWLOCK_BUG_ON(lock->magic != RWLOCK_MAGIC, lock, "bad magic");
238 RWLOCK_BUG_ON(lock->owner != current, lock, "wrong owner");
239 RWLOCK_BUG_ON(lock->owner_cpu != raw_smp_processor_id(),
240 lock, "wrong CPU");
241 lock->owner = SPINLOCK_OWNER_INIT;
242 lock->owner_cpu = -1;
243}
244
Andrew Morton72f0b4e2006-08-05 12:13:47 -0700245#if 0 /* This can cause lockups */
Ingo Molnarfb1c8f92005-09-10 00:25:56 -0700246static void __write_lock_debug(rwlock_t *lock)
247{
Ingo Molnarfb1c8f92005-09-10 00:25:56 -0700248 u64 i;
Chuck Ebbertc22f0082006-09-29 01:59:14 -0700249 u64 loops = loops_per_jiffy * HZ;
250 int print_once = 1;
Ingo Molnarfb1c8f92005-09-10 00:25:56 -0700251
252 for (;;) {
Chuck Ebbertc22f0082006-09-29 01:59:14 -0700253 for (i = 0; i < loops; i++) {
Thomas Gleixnere5931942009-12-03 20:08:46 +0100254 if (arch_write_trylock(&lock->raw_lock))
Ingo Molnarfb1c8f92005-09-10 00:25:56 -0700255 return;
Ingo Molnare0a60292006-02-07 12:58:54 -0800256 __delay(1);
Ingo Molnarfb1c8f92005-09-10 00:25:56 -0700257 }
258 /* lockup suspected: */
259 if (print_once) {
260 print_once = 0;
Dave Jones51989b92006-01-09 20:51:32 -0800261 printk(KERN_EMERG "BUG: write-lock lockup on CPU#%d, "
262 "%s/%d, %p\n",
Ingo Molnarbb44f112005-12-20 11:54:17 +0100263 raw_smp_processor_id(), current->comm,
264 current->pid, lock);
Ingo Molnarfb1c8f92005-09-10 00:25:56 -0700265 dump_stack();
266 }
267 }
268}
Andrew Morton72f0b4e2006-08-05 12:13:47 -0700269#endif
Ingo Molnarfb1c8f92005-09-10 00:25:56 -0700270
Thomas Gleixner9828ea92009-12-03 20:55:53 +0100271void do_raw_write_lock(rwlock_t *lock)
Ingo Molnarfb1c8f92005-09-10 00:25:56 -0700272{
273 debug_write_lock_before(lock);
Thomas Gleixnere5931942009-12-03 20:08:46 +0100274 arch_write_lock(&lock->raw_lock);
Ingo Molnarfb1c8f92005-09-10 00:25:56 -0700275 debug_write_lock_after(lock);
276}
277
Thomas Gleixner9828ea92009-12-03 20:55:53 +0100278int do_raw_write_trylock(rwlock_t *lock)
Ingo Molnarfb1c8f92005-09-10 00:25:56 -0700279{
Thomas Gleixnere5931942009-12-03 20:08:46 +0100280 int ret = arch_write_trylock(&lock->raw_lock);
Ingo Molnarfb1c8f92005-09-10 00:25:56 -0700281
282 if (ret)
283 debug_write_lock_after(lock);
284#ifndef CONFIG_SMP
285 /*
286 * Must not happen on UP:
287 */
288 RWLOCK_BUG_ON(!ret, lock, "trylock failure on UP");
289#endif
290 return ret;
291}
292
Thomas Gleixner9828ea92009-12-03 20:55:53 +0100293void do_raw_write_unlock(rwlock_t *lock)
Ingo Molnarfb1c8f92005-09-10 00:25:56 -0700294{
295 debug_write_unlock(lock);
Thomas Gleixnere5931942009-12-03 20:08:46 +0100296 arch_write_unlock(&lock->raw_lock);
Ingo Molnarfb1c8f92005-09-10 00:25:56 -0700297}