blob: 7f573136a905d6270baaa5f0d75d000991cf9af0 [file] [log] [blame]
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07001/*
2 * kernel/lockdep.c
3 *
4 * Runtime locking correctness validator
5 *
6 * Started by Ingo Molnar:
7 *
8 * Copyright (C) 2006 Red Hat, Inc., Ingo Molnar <mingo@redhat.com>
9 *
10 * this code maps all the lock dependencies as they occur in a live kernel
11 * and will warn about the following classes of locking bugs:
12 *
13 * - lock inversion scenarios
14 * - circular lock dependencies
15 * - hardirq/softirq safe/unsafe locking bugs
16 *
17 * Bugs are reported even if the current locking scenario does not cause
18 * any deadlock at this point.
19 *
20 * I.e. if anytime in the past two locks were taken in a different order,
21 * even if it happened for another task, even if those were different
22 * locks (but of the same class as this lock), this code will detect it.
23 *
24 * Thanks to Arjan van de Ven for coming up with the initial idea of
25 * mapping lock dependencies runtime.
26 */
27#include <linux/mutex.h>
28#include <linux/sched.h>
29#include <linux/delay.h>
30#include <linux/module.h>
31#include <linux/proc_fs.h>
32#include <linux/seq_file.h>
33#include <linux/spinlock.h>
34#include <linux/kallsyms.h>
35#include <linux/interrupt.h>
36#include <linux/stacktrace.h>
37#include <linux/debug_locks.h>
38#include <linux/irqflags.h>
Dave Jones99de0552006-09-29 02:00:10 -070039#include <linux/utsname.h>
Ingo Molnarfbb9ce952006-07-03 00:24:50 -070040
41#include <asm/sections.h>
42
43#include "lockdep_internals.h"
44
45/*
Ingo Molnar74c383f2006-12-13 00:34:43 -080046 * lockdep_lock: protects the lockdep graph, the hashes and the
47 * class/list/hash allocators.
Ingo Molnarfbb9ce952006-07-03 00:24:50 -070048 *
49 * This is one of the rare exceptions where it's justified
50 * to use a raw spinlock - we really dont want the spinlock
Ingo Molnar74c383f2006-12-13 00:34:43 -080051 * code to recurse back into the lockdep code...
Ingo Molnarfbb9ce952006-07-03 00:24:50 -070052 */
Ingo Molnar74c383f2006-12-13 00:34:43 -080053static raw_spinlock_t lockdep_lock = (raw_spinlock_t)__RAW_SPIN_LOCK_UNLOCKED;
54
55static int graph_lock(void)
56{
57 __raw_spin_lock(&lockdep_lock);
58 /*
59 * Make sure that if another CPU detected a bug while
60 * walking the graph we dont change it (while the other
61 * CPU is busy printing out stuff with the graph lock
62 * dropped already)
63 */
64 if (!debug_locks) {
65 __raw_spin_unlock(&lockdep_lock);
66 return 0;
67 }
68 return 1;
69}
70
71static inline int graph_unlock(void)
72{
Jarek Poplawski381a2292007-02-10 01:44:58 -080073 if (debug_locks && !__raw_spin_is_locked(&lockdep_lock))
74 return DEBUG_LOCKS_WARN_ON(1);
75
Ingo Molnar74c383f2006-12-13 00:34:43 -080076 __raw_spin_unlock(&lockdep_lock);
77 return 0;
78}
79
80/*
81 * Turn lock debugging off and return with 0 if it was off already,
82 * and also release the graph lock:
83 */
84static inline int debug_locks_off_graph_unlock(void)
85{
86 int ret = debug_locks_off();
87
88 __raw_spin_unlock(&lockdep_lock);
89
90 return ret;
91}
Ingo Molnarfbb9ce952006-07-03 00:24:50 -070092
93static int lockdep_initialized;
94
95unsigned long nr_list_entries;
96static struct lock_list list_entries[MAX_LOCKDEP_ENTRIES];
97
98/*
Ingo Molnar74c383f2006-12-13 00:34:43 -080099 * Allocate a lockdep entry. (assumes the graph_lock held, returns
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700100 * with NULL on failure)
101 */
102static struct lock_list *alloc_list_entry(void)
103{
104 if (nr_list_entries >= MAX_LOCKDEP_ENTRIES) {
Ingo Molnar74c383f2006-12-13 00:34:43 -0800105 if (!debug_locks_off_graph_unlock())
106 return NULL;
107
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700108 printk("BUG: MAX_LOCKDEP_ENTRIES too low!\n");
109 printk("turning off the locking correctness validator.\n");
110 return NULL;
111 }
112 return list_entries + nr_list_entries++;
113}
114
115/*
116 * All data structures here are protected by the global debug_lock.
117 *
118 * Mutex key structs only get allocated, once during bootup, and never
119 * get freed - this significantly simplifies the debugging code.
120 */
121unsigned long nr_lock_classes;
122static struct lock_class lock_classes[MAX_LOCKDEP_KEYS];
123
124/*
125 * We keep a global list of all lock classes. The list only grows,
126 * never shrinks. The list is only accessed with the lockdep
127 * spinlock lock held.
128 */
129LIST_HEAD(all_lock_classes);
130
131/*
132 * The lockdep classes are in a hash-table as well, for fast lookup:
133 */
134#define CLASSHASH_BITS (MAX_LOCKDEP_KEYS_BITS - 1)
135#define CLASSHASH_SIZE (1UL << CLASSHASH_BITS)
136#define CLASSHASH_MASK (CLASSHASH_SIZE - 1)
137#define __classhashfn(key) ((((unsigned long)key >> CLASSHASH_BITS) + (unsigned long)key) & CLASSHASH_MASK)
138#define classhashentry(key) (classhash_table + __classhashfn((key)))
139
140static struct list_head classhash_table[CLASSHASH_SIZE];
141
142unsigned long nr_lock_chains;
143static struct lock_chain lock_chains[MAX_LOCKDEP_CHAINS];
144
145/*
146 * We put the lock dependency chains into a hash-table as well, to cache
147 * their existence:
148 */
149#define CHAINHASH_BITS (MAX_LOCKDEP_CHAINS_BITS-1)
150#define CHAINHASH_SIZE (1UL << CHAINHASH_BITS)
151#define CHAINHASH_MASK (CHAINHASH_SIZE - 1)
152#define __chainhashfn(chain) \
153 (((chain >> CHAINHASH_BITS) + chain) & CHAINHASH_MASK)
154#define chainhashentry(chain) (chainhash_table + __chainhashfn((chain)))
155
156static struct list_head chainhash_table[CHAINHASH_SIZE];
157
158/*
159 * The hash key of the lock dependency chains is a hash itself too:
160 * it's a hash of all locks taken up to that lock, including that lock.
161 * It's a 64-bit hash, because it's important for the keys to be
162 * unique.
163 */
164#define iterate_chain_key(key1, key2) \
Ingo Molnar03cbc352006-09-29 02:01:46 -0700165 (((key1) << MAX_LOCKDEP_KEYS_BITS) ^ \
166 ((key1) >> (64-MAX_LOCKDEP_KEYS_BITS)) ^ \
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700167 (key2))
168
169void lockdep_off(void)
170{
171 current->lockdep_recursion++;
172}
173
174EXPORT_SYMBOL(lockdep_off);
175
176void lockdep_on(void)
177{
178 current->lockdep_recursion--;
179}
180
181EXPORT_SYMBOL(lockdep_on);
182
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700183/*
184 * Debugging switches:
185 */
186
187#define VERBOSE 0
Ingo Molnar33e94e92006-12-13 00:34:41 -0800188#define VERY_VERBOSE 0
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700189
190#if VERBOSE
191# define HARDIRQ_VERBOSE 1
192# define SOFTIRQ_VERBOSE 1
193#else
194# define HARDIRQ_VERBOSE 0
195# define SOFTIRQ_VERBOSE 0
196#endif
197
198#if VERBOSE || HARDIRQ_VERBOSE || SOFTIRQ_VERBOSE
199/*
200 * Quick filtering for interesting events:
201 */
202static int class_filter(struct lock_class *class)
203{
Andi Kleenf9829cc2006-07-10 04:44:01 -0700204#if 0
205 /* Example */
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700206 if (class->name_version == 1 &&
Andi Kleenf9829cc2006-07-10 04:44:01 -0700207 !strcmp(class->name, "lockname"))
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700208 return 1;
209 if (class->name_version == 1 &&
Andi Kleenf9829cc2006-07-10 04:44:01 -0700210 !strcmp(class->name, "&struct->lockfield"))
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700211 return 1;
Andi Kleenf9829cc2006-07-10 04:44:01 -0700212#endif
Ingo Molnara6640892006-12-13 00:34:39 -0800213 /* Filter everything else. 1 would be to allow everything else */
214 return 0;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700215}
216#endif
217
218static int verbose(struct lock_class *class)
219{
220#if VERBOSE
221 return class_filter(class);
222#endif
223 return 0;
224}
225
226#ifdef CONFIG_TRACE_IRQFLAGS
227
228static int hardirq_verbose(struct lock_class *class)
229{
230#if HARDIRQ_VERBOSE
231 return class_filter(class);
232#endif
233 return 0;
234}
235
236static int softirq_verbose(struct lock_class *class)
237{
238#if SOFTIRQ_VERBOSE
239 return class_filter(class);
240#endif
241 return 0;
242}
243
244#endif
245
246/*
247 * Stack-trace: tightly packed array of stack backtrace
Ingo Molnar74c383f2006-12-13 00:34:43 -0800248 * addresses. Protected by the graph_lock.
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700249 */
250unsigned long nr_stack_trace_entries;
251static unsigned long stack_trace[MAX_STACK_TRACE_ENTRIES];
252
253static int save_trace(struct stack_trace *trace)
254{
255 trace->nr_entries = 0;
256 trace->max_entries = MAX_STACK_TRACE_ENTRIES - nr_stack_trace_entries;
257 trace->entries = stack_trace + nr_stack_trace_entries;
258
Andi Kleen5a1b3992006-09-26 10:52:34 +0200259 trace->skip = 3;
Andi Kleen5a1b3992006-09-26 10:52:34 +0200260
Christoph Hellwigab1b6f02007-05-08 00:23:29 -0700261 save_stack_trace(trace);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700262
263 trace->max_entries = trace->nr_entries;
264
265 nr_stack_trace_entries += trace->nr_entries;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700266
267 if (nr_stack_trace_entries == MAX_STACK_TRACE_ENTRIES) {
Ingo Molnar74c383f2006-12-13 00:34:43 -0800268 if (!debug_locks_off_graph_unlock())
269 return 0;
270
271 printk("BUG: MAX_STACK_TRACE_ENTRIES too low!\n");
272 printk("turning off the locking correctness validator.\n");
273 dump_stack();
274
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700275 return 0;
276 }
277
278 return 1;
279}
280
281unsigned int nr_hardirq_chains;
282unsigned int nr_softirq_chains;
283unsigned int nr_process_chains;
284unsigned int max_lockdep_depth;
285unsigned int max_recursion_depth;
286
287#ifdef CONFIG_DEBUG_LOCKDEP
288/*
289 * We cannot printk in early bootup code. Not even early_printk()
290 * might work. So we mark any initialization errors and printk
291 * about it later on, in lockdep_info().
292 */
293static int lockdep_init_error;
294
295/*
296 * Various lockdep statistics:
297 */
298atomic_t chain_lookup_hits;
299atomic_t chain_lookup_misses;
300atomic_t hardirqs_on_events;
301atomic_t hardirqs_off_events;
302atomic_t redundant_hardirqs_on;
303atomic_t redundant_hardirqs_off;
304atomic_t softirqs_on_events;
305atomic_t softirqs_off_events;
306atomic_t redundant_softirqs_on;
307atomic_t redundant_softirqs_off;
308atomic_t nr_unused_locks;
309atomic_t nr_cyclic_checks;
310atomic_t nr_cyclic_check_recursions;
311atomic_t nr_find_usage_forwards_checks;
312atomic_t nr_find_usage_forwards_recursions;
313atomic_t nr_find_usage_backwards_checks;
314atomic_t nr_find_usage_backwards_recursions;
315# define debug_atomic_inc(ptr) atomic_inc(ptr)
316# define debug_atomic_dec(ptr) atomic_dec(ptr)
317# define debug_atomic_read(ptr) atomic_read(ptr)
318#else
319# define debug_atomic_inc(ptr) do { } while (0)
320# define debug_atomic_dec(ptr) do { } while (0)
321# define debug_atomic_read(ptr) 0
322#endif
323
324/*
325 * Locking printouts:
326 */
327
328static const char *usage_str[] =
329{
330 [LOCK_USED] = "initial-use ",
331 [LOCK_USED_IN_HARDIRQ] = "in-hardirq-W",
332 [LOCK_USED_IN_SOFTIRQ] = "in-softirq-W",
333 [LOCK_ENABLED_SOFTIRQS] = "softirq-on-W",
334 [LOCK_ENABLED_HARDIRQS] = "hardirq-on-W",
335 [LOCK_USED_IN_HARDIRQ_READ] = "in-hardirq-R",
336 [LOCK_USED_IN_SOFTIRQ_READ] = "in-softirq-R",
337 [LOCK_ENABLED_SOFTIRQS_READ] = "softirq-on-R",
338 [LOCK_ENABLED_HARDIRQS_READ] = "hardirq-on-R",
339};
340
341const char * __get_key_name(struct lockdep_subclass_key *key, char *str)
342{
Alexey Dobriyanffb45122007-05-08 00:28:41 -0700343 return kallsyms_lookup((unsigned long)key, NULL, NULL, NULL, str);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700344}
345
346void
347get_usage_chars(struct lock_class *class, char *c1, char *c2, char *c3, char *c4)
348{
349 *c1 = '.', *c2 = '.', *c3 = '.', *c4 = '.';
350
351 if (class->usage_mask & LOCKF_USED_IN_HARDIRQ)
352 *c1 = '+';
353 else
354 if (class->usage_mask & LOCKF_ENABLED_HARDIRQS)
355 *c1 = '-';
356
357 if (class->usage_mask & LOCKF_USED_IN_SOFTIRQ)
358 *c2 = '+';
359 else
360 if (class->usage_mask & LOCKF_ENABLED_SOFTIRQS)
361 *c2 = '-';
362
363 if (class->usage_mask & LOCKF_ENABLED_HARDIRQS_READ)
364 *c3 = '-';
365 if (class->usage_mask & LOCKF_USED_IN_HARDIRQ_READ) {
366 *c3 = '+';
367 if (class->usage_mask & LOCKF_ENABLED_HARDIRQS_READ)
368 *c3 = '?';
369 }
370
371 if (class->usage_mask & LOCKF_ENABLED_SOFTIRQS_READ)
372 *c4 = '-';
373 if (class->usage_mask & LOCKF_USED_IN_SOFTIRQ_READ) {
374 *c4 = '+';
375 if (class->usage_mask & LOCKF_ENABLED_SOFTIRQS_READ)
376 *c4 = '?';
377 }
378}
379
380static void print_lock_name(struct lock_class *class)
381{
Jarek Poplawskib23984d2006-12-06 20:36:23 -0800382 char str[KSYM_NAME_LEN + 1], c1, c2, c3, c4;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700383 const char *name;
384
385 get_usage_chars(class, &c1, &c2, &c3, &c4);
386
387 name = class->name;
388 if (!name) {
389 name = __get_key_name(class->key, str);
390 printk(" (%s", name);
391 } else {
392 printk(" (%s", name);
393 if (class->name_version > 1)
394 printk("#%d", class->name_version);
395 if (class->subclass)
396 printk("/%d", class->subclass);
397 }
398 printk("){%c%c%c%c}", c1, c2, c3, c4);
399}
400
401static void print_lockdep_cache(struct lockdep_map *lock)
402{
403 const char *name;
Jarek Poplawskib23984d2006-12-06 20:36:23 -0800404 char str[KSYM_NAME_LEN + 1];
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700405
406 name = lock->name;
407 if (!name)
408 name = __get_key_name(lock->key->subkeys, str);
409
410 printk("%s", name);
411}
412
413static void print_lock(struct held_lock *hlock)
414{
415 print_lock_name(hlock->class);
416 printk(", at: ");
417 print_ip_sym(hlock->acquire_ip);
418}
419
420static void lockdep_print_held_locks(struct task_struct *curr)
421{
422 int i, depth = curr->lockdep_depth;
423
424 if (!depth) {
425 printk("no locks held by %s/%d.\n", curr->comm, curr->pid);
426 return;
427 }
428 printk("%d lock%s held by %s/%d:\n",
429 depth, depth > 1 ? "s" : "", curr->comm, curr->pid);
430
431 for (i = 0; i < depth; i++) {
432 printk(" #%d: ", i);
433 print_lock(curr->held_locks + i);
434 }
435}
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700436
437static void print_lock_class_header(struct lock_class *class, int depth)
438{
439 int bit;
440
Andi Kleenf9829cc2006-07-10 04:44:01 -0700441 printk("%*s->", depth, "");
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700442 print_lock_name(class);
443 printk(" ops: %lu", class->ops);
444 printk(" {\n");
445
446 for (bit = 0; bit < LOCK_USAGE_STATES; bit++) {
447 if (class->usage_mask & (1 << bit)) {
448 int len = depth;
449
Andi Kleenf9829cc2006-07-10 04:44:01 -0700450 len += printk("%*s %s", depth, "", usage_str[bit]);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700451 len += printk(" at:\n");
452 print_stack_trace(class->usage_traces + bit, len);
453 }
454 }
Andi Kleenf9829cc2006-07-10 04:44:01 -0700455 printk("%*s }\n", depth, "");
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700456
Andi Kleenf9829cc2006-07-10 04:44:01 -0700457 printk("%*s ... key at: ",depth,"");
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700458 print_ip_sym((unsigned long)class->key);
459}
460
461/*
462 * printk all lock dependencies starting at <entry>:
463 */
464static void print_lock_dependencies(struct lock_class *class, int depth)
465{
466 struct lock_list *entry;
467
468 if (DEBUG_LOCKS_WARN_ON(depth >= 20))
469 return;
470
471 print_lock_class_header(class, depth);
472
473 list_for_each_entry(entry, &class->locks_after, entry) {
Jarek Poplawskib23984d2006-12-06 20:36:23 -0800474 if (DEBUG_LOCKS_WARN_ON(!entry->class))
475 return;
476
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700477 print_lock_dependencies(entry->class, depth + 1);
478
Andi Kleenf9829cc2006-07-10 04:44:01 -0700479 printk("%*s ... acquired at:\n",depth,"");
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700480 print_stack_trace(&entry->trace, 2);
481 printk("\n");
482 }
483}
484
485/*
486 * Add a new dependency to the head of the list:
487 */
488static int add_lock_to_list(struct lock_class *class, struct lock_class *this,
Jason Baron068135e2007-02-10 01:44:59 -0800489 struct list_head *head, unsigned long ip, int distance)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700490{
491 struct lock_list *entry;
492 /*
493 * Lock not present yet - get a new dependency struct and
494 * add it to the list:
495 */
496 entry = alloc_list_entry();
497 if (!entry)
498 return 0;
499
500 entry->class = this;
Jason Baron068135e2007-02-10 01:44:59 -0800501 entry->distance = distance;
Jarek Poplawski910b1b22006-12-07 10:45:25 +0100502 if (!save_trace(&entry->trace))
503 return 0;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700504
505 /*
506 * Since we never remove from the dependency list, the list can
507 * be walked lockless by other CPUs, it's only allocation
508 * that must be protected by the spinlock. But this also means
509 * we must make new entries visible only once writes to the
510 * entry become visible - hence the RCU op:
511 */
512 list_add_tail_rcu(&entry->entry, head);
513
514 return 1;
515}
516
517/*
518 * Recursive, forwards-direction lock-dependency checking, used for
519 * both noncyclic checking and for hardirq-unsafe/softirq-unsafe
520 * checking.
521 *
522 * (to keep the stackframe of the recursive functions small we
523 * use these global variables, and we also mark various helper
524 * functions as noinline.)
525 */
526static struct held_lock *check_source, *check_target;
527
528/*
529 * Print a dependency chain entry (this is only done when a deadlock
530 * has been detected):
531 */
532static noinline int
533print_circular_bug_entry(struct lock_list *target, unsigned int depth)
534{
535 if (debug_locks_silent)
536 return 0;
537 printk("\n-> #%u", depth);
538 print_lock_name(target->class);
539 printk(":\n");
540 print_stack_trace(&target->trace, 6);
541
542 return 0;
543}
544
Dave Jones99de0552006-09-29 02:00:10 -0700545static void print_kernel_version(void)
546{
Serge E. Hallyn96b644b2006-10-02 02:18:13 -0700547 printk("%s %.*s\n", init_utsname()->release,
548 (int)strcspn(init_utsname()->version, " "),
549 init_utsname()->version);
Dave Jones99de0552006-09-29 02:00:10 -0700550}
551
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700552/*
553 * When a circular dependency is detected, print the
554 * header first:
555 */
556static noinline int
557print_circular_bug_header(struct lock_list *entry, unsigned int depth)
558{
559 struct task_struct *curr = current;
560
Ingo Molnar74c383f2006-12-13 00:34:43 -0800561 if (!debug_locks_off_graph_unlock() || debug_locks_silent)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700562 return 0;
563
564 printk("\n=======================================================\n");
565 printk( "[ INFO: possible circular locking dependency detected ]\n");
Dave Jones99de0552006-09-29 02:00:10 -0700566 print_kernel_version();
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700567 printk( "-------------------------------------------------------\n");
568 printk("%s/%d is trying to acquire lock:\n",
569 curr->comm, curr->pid);
570 print_lock(check_source);
571 printk("\nbut task is already holding lock:\n");
572 print_lock(check_target);
573 printk("\nwhich lock already depends on the new lock.\n\n");
574 printk("\nthe existing dependency chain (in reverse order) is:\n");
575
576 print_circular_bug_entry(entry, depth);
577
578 return 0;
579}
580
581static noinline int print_circular_bug_tail(void)
582{
583 struct task_struct *curr = current;
584 struct lock_list this;
585
586 if (debug_locks_silent)
587 return 0;
588
589 this.class = check_source->class;
Jarek Poplawski910b1b22006-12-07 10:45:25 +0100590 if (!save_trace(&this.trace))
591 return 0;
Ingo Molnar74c383f2006-12-13 00:34:43 -0800592
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700593 print_circular_bug_entry(&this, 0);
594
595 printk("\nother info that might help us debug this:\n\n");
596 lockdep_print_held_locks(curr);
597
598 printk("\nstack backtrace:\n");
599 dump_stack();
600
601 return 0;
602}
603
Ingo Molnarca268c62006-10-17 00:09:28 -0700604#define RECURSION_LIMIT 40
605
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700606static int noinline print_infinite_recursion_bug(void)
607{
Ingo Molnar74c383f2006-12-13 00:34:43 -0800608 if (!debug_locks_off_graph_unlock())
609 return 0;
610
611 WARN_ON(1);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700612
613 return 0;
614}
615
616/*
617 * Prove that the dependency graph starting at <entry> can not
618 * lead to <target>. Print an error and return 0 if it does.
619 */
620static noinline int
621check_noncircular(struct lock_class *source, unsigned int depth)
622{
623 struct lock_list *entry;
624
625 debug_atomic_inc(&nr_cyclic_check_recursions);
626 if (depth > max_recursion_depth)
627 max_recursion_depth = depth;
Ingo Molnarca268c62006-10-17 00:09:28 -0700628 if (depth >= RECURSION_LIMIT)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700629 return print_infinite_recursion_bug();
630 /*
631 * Check this lock's dependency list:
632 */
633 list_for_each_entry(entry, &source->locks_after, entry) {
634 if (entry->class == check_target->class)
635 return print_circular_bug_header(entry, depth+1);
636 debug_atomic_inc(&nr_cyclic_checks);
637 if (!check_noncircular(entry->class, depth+1))
638 return print_circular_bug_entry(entry, depth+1);
639 }
640 return 1;
641}
642
643static int very_verbose(struct lock_class *class)
644{
645#if VERY_VERBOSE
646 return class_filter(class);
647#endif
648 return 0;
649}
650#ifdef CONFIG_TRACE_IRQFLAGS
651
652/*
653 * Forwards and backwards subgraph searching, for the purposes of
654 * proving that two subgraphs can be connected by a new dependency
655 * without creating any illegal irq-safe -> irq-unsafe lock dependency.
656 */
657static enum lock_usage_bit find_usage_bit;
658static struct lock_class *forwards_match, *backwards_match;
659
660/*
661 * Find a node in the forwards-direction dependency sub-graph starting
662 * at <source> that matches <find_usage_bit>.
663 *
664 * Return 2 if such a node exists in the subgraph, and put that node
665 * into <forwards_match>.
666 *
667 * Return 1 otherwise and keep <forwards_match> unchanged.
668 * Return 0 on error.
669 */
670static noinline int
671find_usage_forwards(struct lock_class *source, unsigned int depth)
672{
673 struct lock_list *entry;
674 int ret;
675
676 if (depth > max_recursion_depth)
677 max_recursion_depth = depth;
Ingo Molnarca268c62006-10-17 00:09:28 -0700678 if (depth >= RECURSION_LIMIT)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700679 return print_infinite_recursion_bug();
680
681 debug_atomic_inc(&nr_find_usage_forwards_checks);
682 if (source->usage_mask & (1 << find_usage_bit)) {
683 forwards_match = source;
684 return 2;
685 }
686
687 /*
688 * Check this lock's dependency list:
689 */
690 list_for_each_entry(entry, &source->locks_after, entry) {
691 debug_atomic_inc(&nr_find_usage_forwards_recursions);
692 ret = find_usage_forwards(entry->class, depth+1);
693 if (ret == 2 || ret == 0)
694 return ret;
695 }
696 return 1;
697}
698
699/*
700 * Find a node in the backwards-direction dependency sub-graph starting
701 * at <source> that matches <find_usage_bit>.
702 *
703 * Return 2 if such a node exists in the subgraph, and put that node
704 * into <backwards_match>.
705 *
706 * Return 1 otherwise and keep <backwards_match> unchanged.
707 * Return 0 on error.
708 */
709static noinline int
710find_usage_backwards(struct lock_class *source, unsigned int depth)
711{
712 struct lock_list *entry;
713 int ret;
714
Jarek Poplawski381a2292007-02-10 01:44:58 -0800715 if (!__raw_spin_is_locked(&lockdep_lock))
716 return DEBUG_LOCKS_WARN_ON(1);
717
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700718 if (depth > max_recursion_depth)
719 max_recursion_depth = depth;
Ingo Molnarca268c62006-10-17 00:09:28 -0700720 if (depth >= RECURSION_LIMIT)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700721 return print_infinite_recursion_bug();
722
723 debug_atomic_inc(&nr_find_usage_backwards_checks);
724 if (source->usage_mask & (1 << find_usage_bit)) {
725 backwards_match = source;
726 return 2;
727 }
728
729 /*
730 * Check this lock's dependency list:
731 */
732 list_for_each_entry(entry, &source->locks_before, entry) {
733 debug_atomic_inc(&nr_find_usage_backwards_recursions);
734 ret = find_usage_backwards(entry->class, depth+1);
735 if (ret == 2 || ret == 0)
736 return ret;
737 }
738 return 1;
739}
740
741static int
742print_bad_irq_dependency(struct task_struct *curr,
743 struct held_lock *prev,
744 struct held_lock *next,
745 enum lock_usage_bit bit1,
746 enum lock_usage_bit bit2,
747 const char *irqclass)
748{
Ingo Molnar74c383f2006-12-13 00:34:43 -0800749 if (!debug_locks_off_graph_unlock() || debug_locks_silent)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700750 return 0;
751
752 printk("\n======================================================\n");
753 printk( "[ INFO: %s-safe -> %s-unsafe lock order detected ]\n",
754 irqclass, irqclass);
Dave Jones99de0552006-09-29 02:00:10 -0700755 print_kernel_version();
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700756 printk( "------------------------------------------------------\n");
757 printk("%s/%d [HC%u[%lu]:SC%u[%lu]:HE%u:SE%u] is trying to acquire:\n",
758 curr->comm, curr->pid,
759 curr->hardirq_context, hardirq_count() >> HARDIRQ_SHIFT,
760 curr->softirq_context, softirq_count() >> SOFTIRQ_SHIFT,
761 curr->hardirqs_enabled,
762 curr->softirqs_enabled);
763 print_lock(next);
764
765 printk("\nand this task is already holding:\n");
766 print_lock(prev);
767 printk("which would create a new lock dependency:\n");
768 print_lock_name(prev->class);
769 printk(" ->");
770 print_lock_name(next->class);
771 printk("\n");
772
773 printk("\nbut this new dependency connects a %s-irq-safe lock:\n",
774 irqclass);
775 print_lock_name(backwards_match);
776 printk("\n... which became %s-irq-safe at:\n", irqclass);
777
778 print_stack_trace(backwards_match->usage_traces + bit1, 1);
779
780 printk("\nto a %s-irq-unsafe lock:\n", irqclass);
781 print_lock_name(forwards_match);
782 printk("\n... which became %s-irq-unsafe at:\n", irqclass);
783 printk("...");
784
785 print_stack_trace(forwards_match->usage_traces + bit2, 1);
786
787 printk("\nother info that might help us debug this:\n\n");
788 lockdep_print_held_locks(curr);
789
790 printk("\nthe %s-irq-safe lock's dependencies:\n", irqclass);
791 print_lock_dependencies(backwards_match, 0);
792
793 printk("\nthe %s-irq-unsafe lock's dependencies:\n", irqclass);
794 print_lock_dependencies(forwards_match, 0);
795
796 printk("\nstack backtrace:\n");
797 dump_stack();
798
799 return 0;
800}
801
802static int
803check_usage(struct task_struct *curr, struct held_lock *prev,
804 struct held_lock *next, enum lock_usage_bit bit_backwards,
805 enum lock_usage_bit bit_forwards, const char *irqclass)
806{
807 int ret;
808
809 find_usage_bit = bit_backwards;
810 /* fills in <backwards_match> */
811 ret = find_usage_backwards(prev->class, 0);
812 if (!ret || ret == 1)
813 return ret;
814
815 find_usage_bit = bit_forwards;
816 ret = find_usage_forwards(next->class, 0);
817 if (!ret || ret == 1)
818 return ret;
819 /* ret == 2 */
820 return print_bad_irq_dependency(curr, prev, next,
821 bit_backwards, bit_forwards, irqclass);
822}
823
824#endif
825
826static int
827print_deadlock_bug(struct task_struct *curr, struct held_lock *prev,
828 struct held_lock *next)
829{
Ingo Molnar74c383f2006-12-13 00:34:43 -0800830 if (!debug_locks_off_graph_unlock() || debug_locks_silent)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700831 return 0;
832
833 printk("\n=============================================\n");
834 printk( "[ INFO: possible recursive locking detected ]\n");
Dave Jones99de0552006-09-29 02:00:10 -0700835 print_kernel_version();
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700836 printk( "---------------------------------------------\n");
837 printk("%s/%d is trying to acquire lock:\n",
838 curr->comm, curr->pid);
839 print_lock(next);
840 printk("\nbut task is already holding lock:\n");
841 print_lock(prev);
842
843 printk("\nother info that might help us debug this:\n");
844 lockdep_print_held_locks(curr);
845
846 printk("\nstack backtrace:\n");
847 dump_stack();
848
849 return 0;
850}
851
852/*
853 * Check whether we are holding such a class already.
854 *
855 * (Note that this has to be done separately, because the graph cannot
856 * detect such classes of deadlocks.)
857 *
858 * Returns: 0 on deadlock detected, 1 on OK, 2 on recursive read
859 */
860static int
861check_deadlock(struct task_struct *curr, struct held_lock *next,
862 struct lockdep_map *next_instance, int read)
863{
864 struct held_lock *prev;
865 int i;
866
867 for (i = 0; i < curr->lockdep_depth; i++) {
868 prev = curr->held_locks + i;
869 if (prev->class != next->class)
870 continue;
871 /*
872 * Allow read-after-read recursion of the same
Ingo Molnar6c9076e2006-07-03 00:24:51 -0700873 * lock class (i.e. read_lock(lock)+read_lock(lock)):
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700874 */
Ingo Molnar6c9076e2006-07-03 00:24:51 -0700875 if ((read == 2) && prev->read)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700876 return 2;
877 return print_deadlock_bug(curr, prev, next);
878 }
879 return 1;
880}
881
882/*
883 * There was a chain-cache miss, and we are about to add a new dependency
884 * to a previous lock. We recursively validate the following rules:
885 *
886 * - would the adding of the <prev> -> <next> dependency create a
887 * circular dependency in the graph? [== circular deadlock]
888 *
889 * - does the new prev->next dependency connect any hardirq-safe lock
890 * (in the full backwards-subgraph starting at <prev>) with any
891 * hardirq-unsafe lock (in the full forwards-subgraph starting at
892 * <next>)? [== illegal lock inversion with hardirq contexts]
893 *
894 * - does the new prev->next dependency connect any softirq-safe lock
895 * (in the full backwards-subgraph starting at <prev>) with any
896 * softirq-unsafe lock (in the full forwards-subgraph starting at
897 * <next>)? [== illegal lock inversion with softirq contexts]
898 *
899 * any of these scenarios could lead to a deadlock.
900 *
901 * Then if all the validations pass, we add the forwards and backwards
902 * dependency.
903 */
904static int
905check_prev_add(struct task_struct *curr, struct held_lock *prev,
Jason Baron068135e2007-02-10 01:44:59 -0800906 struct held_lock *next, int distance)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700907{
908 struct lock_list *entry;
909 int ret;
910
911 /*
912 * Prove that the new <prev> -> <next> dependency would not
913 * create a circular dependency in the graph. (We do this by
914 * forward-recursing into the graph starting at <next>, and
915 * checking whether we can reach <prev>.)
916 *
917 * We are using global variables to control the recursion, to
918 * keep the stackframe size of the recursive functions low:
919 */
920 check_source = next;
921 check_target = prev;
922 if (!(check_noncircular(next->class, 0)))
923 return print_circular_bug_tail();
924
925#ifdef CONFIG_TRACE_IRQFLAGS
926 /*
927 * Prove that the new dependency does not connect a hardirq-safe
928 * lock with a hardirq-unsafe lock - to achieve this we search
929 * the backwards-subgraph starting at <prev>, and the
930 * forwards-subgraph starting at <next>:
931 */
932 if (!check_usage(curr, prev, next, LOCK_USED_IN_HARDIRQ,
933 LOCK_ENABLED_HARDIRQS, "hard"))
934 return 0;
935
936 /*
937 * Prove that the new dependency does not connect a hardirq-safe-read
938 * lock with a hardirq-unsafe lock - to achieve this we search
939 * the backwards-subgraph starting at <prev>, and the
940 * forwards-subgraph starting at <next>:
941 */
942 if (!check_usage(curr, prev, next, LOCK_USED_IN_HARDIRQ_READ,
943 LOCK_ENABLED_HARDIRQS, "hard-read"))
944 return 0;
945
946 /*
947 * Prove that the new dependency does not connect a softirq-safe
948 * lock with a softirq-unsafe lock - to achieve this we search
949 * the backwards-subgraph starting at <prev>, and the
950 * forwards-subgraph starting at <next>:
951 */
952 if (!check_usage(curr, prev, next, LOCK_USED_IN_SOFTIRQ,
953 LOCK_ENABLED_SOFTIRQS, "soft"))
954 return 0;
955 /*
956 * Prove that the new dependency does not connect a softirq-safe-read
957 * lock with a softirq-unsafe lock - to achieve this we search
958 * the backwards-subgraph starting at <prev>, and the
959 * forwards-subgraph starting at <next>:
960 */
961 if (!check_usage(curr, prev, next, LOCK_USED_IN_SOFTIRQ_READ,
962 LOCK_ENABLED_SOFTIRQS, "soft"))
963 return 0;
964#endif
965 /*
966 * For recursive read-locks we do all the dependency checks,
967 * but we dont store read-triggered dependencies (only
968 * write-triggered dependencies). This ensures that only the
969 * write-side dependencies matter, and that if for example a
970 * write-lock never takes any other locks, then the reads are
971 * equivalent to a NOP.
972 */
973 if (next->read == 2 || prev->read == 2)
974 return 1;
975 /*
976 * Is the <prev> -> <next> dependency already present?
977 *
978 * (this may occur even though this is a new chain: consider
979 * e.g. the L1 -> L2 -> L3 -> L4 and the L5 -> L1 -> L2 -> L3
980 * chains - the second one will be new, but L1 already has
981 * L2 added to its dependency list, due to the first chain.)
982 */
983 list_for_each_entry(entry, &prev->class->locks_after, entry) {
Jason Baron068135e2007-02-10 01:44:59 -0800984 if (entry->class == next->class) {
985 if (distance == 1)
986 entry->distance = 1;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700987 return 2;
Jason Baron068135e2007-02-10 01:44:59 -0800988 }
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700989 }
990
991 /*
992 * Ok, all validations passed, add the new lock
993 * to the previous lock's dependency list:
994 */
995 ret = add_lock_to_list(prev->class, next->class,
Jason Baron068135e2007-02-10 01:44:59 -0800996 &prev->class->locks_after, next->acquire_ip, distance);
997
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700998 if (!ret)
999 return 0;
Jarek Poplawski910b1b22006-12-07 10:45:25 +01001000
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07001001 ret = add_lock_to_list(next->class, prev->class,
Jason Baron068135e2007-02-10 01:44:59 -08001002 &next->class->locks_before, next->acquire_ip, distance);
Jarek Poplawski910b1b22006-12-07 10:45:25 +01001003 if (!ret)
1004 return 0;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07001005
1006 /*
1007 * Debugging printouts:
1008 */
1009 if (verbose(prev->class) || verbose(next->class)) {
Ingo Molnar74c383f2006-12-13 00:34:43 -08001010 graph_unlock();
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07001011 printk("\n new dependency: ");
1012 print_lock_name(prev->class);
1013 printk(" => ");
1014 print_lock_name(next->class);
1015 printk("\n");
1016 dump_stack();
Ingo Molnar74c383f2006-12-13 00:34:43 -08001017 return graph_lock();
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07001018 }
1019 return 1;
1020}
1021
1022/*
1023 * Add the dependency to all directly-previous locks that are 'relevant'.
1024 * The ones that are relevant are (in increasing distance from curr):
1025 * all consecutive trylock entries and the final non-trylock entry - or
1026 * the end of this context's lock-chain - whichever comes first.
1027 */
1028static int
1029check_prevs_add(struct task_struct *curr, struct held_lock *next)
1030{
1031 int depth = curr->lockdep_depth;
1032 struct held_lock *hlock;
1033
1034 /*
1035 * Debugging checks.
1036 *
1037 * Depth must not be zero for a non-head lock:
1038 */
1039 if (!depth)
1040 goto out_bug;
1041 /*
1042 * At least two relevant locks must exist for this
1043 * to be a head:
1044 */
1045 if (curr->held_locks[depth].irq_context !=
1046 curr->held_locks[depth-1].irq_context)
1047 goto out_bug;
1048
1049 for (;;) {
Jason Baron068135e2007-02-10 01:44:59 -08001050 int distance = curr->lockdep_depth - depth + 1;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07001051 hlock = curr->held_locks + depth-1;
1052 /*
1053 * Only non-recursive-read entries get new dependencies
1054 * added:
1055 */
1056 if (hlock->read != 2) {
Jason Baron068135e2007-02-10 01:44:59 -08001057 if (!check_prev_add(curr, hlock, next, distance))
Jarek Poplawski910b1b22006-12-07 10:45:25 +01001058 return 0;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07001059 /*
1060 * Stop after the first non-trylock entry,
1061 * as non-trylock entries have added their
1062 * own direct dependencies already, so this
1063 * lock is connected to them indirectly:
1064 */
1065 if (!hlock->trylock)
1066 break;
1067 }
1068 depth--;
1069 /*
1070 * End of lock-stack?
1071 */
1072 if (!depth)
1073 break;
1074 /*
1075 * Stop the search if we cross into another context:
1076 */
1077 if (curr->held_locks[depth].irq_context !=
1078 curr->held_locks[depth-1].irq_context)
1079 break;
1080 }
1081 return 1;
1082out_bug:
Ingo Molnar74c383f2006-12-13 00:34:43 -08001083 if (!debug_locks_off_graph_unlock())
1084 return 0;
1085
1086 WARN_ON(1);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07001087
1088 return 0;
1089}
1090
1091
1092/*
1093 * Is this the address of a static object:
1094 */
1095static int static_obj(void *obj)
1096{
1097 unsigned long start = (unsigned long) &_stext,
1098 end = (unsigned long) &_end,
1099 addr = (unsigned long) obj;
1100#ifdef CONFIG_SMP
1101 int i;
1102#endif
1103
1104 /*
1105 * static variable?
1106 */
1107 if ((addr >= start) && (addr < end))
1108 return 1;
1109
1110#ifdef CONFIG_SMP
1111 /*
1112 * percpu var?
1113 */
1114 for_each_possible_cpu(i) {
1115 start = (unsigned long) &__per_cpu_start + per_cpu_offset(i);
Ingo Molnar1ff56832006-11-17 19:57:22 +01001116 end = (unsigned long) &__per_cpu_start + PERCPU_ENOUGH_ROOM
1117 + per_cpu_offset(i);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07001118
1119 if ((addr >= start) && (addr < end))
1120 return 1;
1121 }
1122#endif
1123
1124 /*
1125 * module var?
1126 */
1127 return is_module_address(addr);
1128}
1129
1130/*
1131 * To make lock name printouts unique, we calculate a unique
1132 * class->name_version generation counter:
1133 */
1134static int count_matching_names(struct lock_class *new_class)
1135{
1136 struct lock_class *class;
1137 int count = 0;
1138
1139 if (!new_class->name)
1140 return 0;
1141
1142 list_for_each_entry(class, &all_lock_classes, lock_entry) {
1143 if (new_class->key - new_class->subclass == class->key)
1144 return class->name_version;
1145 if (class->name && !strcmp(class->name, new_class->name))
1146 count = max(count, class->name_version);
1147 }
1148
1149 return count + 1;
1150}
1151
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07001152/*
1153 * Register a lock's class in the hash-table, if the class is not present
1154 * yet. Otherwise we look it up. We cache the result in the lock object
1155 * itself, so actual lookup of the hash should be once per lock object.
1156 */
1157static inline struct lock_class *
Ingo Molnard6d897c2006-07-10 04:44:04 -07001158look_up_lock_class(struct lockdep_map *lock, unsigned int subclass)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07001159{
1160 struct lockdep_subclass_key *key;
1161 struct list_head *hash_head;
1162 struct lock_class *class;
1163
1164#ifdef CONFIG_DEBUG_LOCKDEP
1165 /*
1166 * If the architecture calls into lockdep before initializing
1167 * the hashes then we'll warn about it later. (we cannot printk
1168 * right now)
1169 */
1170 if (unlikely(!lockdep_initialized)) {
1171 lockdep_init();
1172 lockdep_init_error = 1;
1173 }
1174#endif
1175
1176 /*
1177 * Static locks do not have their class-keys yet - for them the key
1178 * is the lock object itself:
1179 */
1180 if (unlikely(!lock->key))
1181 lock->key = (void *)lock;
1182
1183 /*
1184 * NOTE: the class-key must be unique. For dynamic locks, a static
1185 * lock_class_key variable is passed in through the mutex_init()
1186 * (or spin_lock_init()) call - which acts as the key. For static
1187 * locks we use the lock object itself as the key.
1188 */
Alexey Dobriyan3dc30992006-10-11 01:22:06 -07001189 BUILD_BUG_ON(sizeof(struct lock_class_key) > sizeof(struct lock_class));
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07001190
1191 key = lock->key->subkeys + subclass;
1192
1193 hash_head = classhashentry(key);
1194
1195 /*
1196 * We can walk the hash lockfree, because the hash only
1197 * grows, and we are careful when adding entries to the end:
1198 */
1199 list_for_each_entry(class, hash_head, hash_entry)
1200 if (class->key == key)
Ingo Molnard6d897c2006-07-10 04:44:04 -07001201 return class;
1202
1203 return NULL;
1204}
1205
1206/*
1207 * Register a lock's class in the hash-table, if the class is not present
1208 * yet. Otherwise we look it up. We cache the result in the lock object
1209 * itself, so actual lookup of the hash should be once per lock object.
1210 */
1211static inline struct lock_class *
Peter Zijlstra4dfbb9d2006-10-11 01:45:14 -04001212register_lock_class(struct lockdep_map *lock, unsigned int subclass, int force)
Ingo Molnard6d897c2006-07-10 04:44:04 -07001213{
1214 struct lockdep_subclass_key *key;
1215 struct list_head *hash_head;
1216 struct lock_class *class;
Ingo Molnar70e45062006-12-06 20:40:50 -08001217 unsigned long flags;
Ingo Molnard6d897c2006-07-10 04:44:04 -07001218
1219 class = look_up_lock_class(lock, subclass);
1220 if (likely(class))
1221 return class;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07001222
1223 /*
1224 * Debug-check: all keys must be persistent!
1225 */
1226 if (!static_obj(lock->key)) {
1227 debug_locks_off();
1228 printk("INFO: trying to register non-static key.\n");
1229 printk("the code is fine but needs lockdep annotation.\n");
1230 printk("turning off the locking correctness validator.\n");
1231 dump_stack();
1232
1233 return NULL;
1234 }
1235
Ingo Molnard6d897c2006-07-10 04:44:04 -07001236 key = lock->key->subkeys + subclass;
1237 hash_head = classhashentry(key);
1238
Ingo Molnar70e45062006-12-06 20:40:50 -08001239 raw_local_irq_save(flags);
Ingo Molnar74c383f2006-12-13 00:34:43 -08001240 if (!graph_lock()) {
1241 raw_local_irq_restore(flags);
1242 return NULL;
1243 }
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07001244 /*
1245 * We have to do the hash-walk again, to avoid races
1246 * with another CPU:
1247 */
1248 list_for_each_entry(class, hash_head, hash_entry)
1249 if (class->key == key)
1250 goto out_unlock_set;
1251 /*
1252 * Allocate a new key from the static array, and add it to
1253 * the hash:
1254 */
1255 if (nr_lock_classes >= MAX_LOCKDEP_KEYS) {
Ingo Molnar74c383f2006-12-13 00:34:43 -08001256 if (!debug_locks_off_graph_unlock()) {
1257 raw_local_irq_restore(flags);
1258 return NULL;
1259 }
Ingo Molnar70e45062006-12-06 20:40:50 -08001260 raw_local_irq_restore(flags);
Ingo Molnar74c383f2006-12-13 00:34:43 -08001261
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07001262 printk("BUG: MAX_LOCKDEP_KEYS too low!\n");
1263 printk("turning off the locking correctness validator.\n");
1264 return NULL;
1265 }
1266 class = lock_classes + nr_lock_classes++;
1267 debug_atomic_inc(&nr_unused_locks);
1268 class->key = key;
1269 class->name = lock->name;
1270 class->subclass = subclass;
1271 INIT_LIST_HEAD(&class->lock_entry);
1272 INIT_LIST_HEAD(&class->locks_before);
1273 INIT_LIST_HEAD(&class->locks_after);
1274 class->name_version = count_matching_names(class);
1275 /*
1276 * We use RCU's safe list-add method to make
1277 * parallel walking of the hash-list safe:
1278 */
1279 list_add_tail_rcu(&class->hash_entry, hash_head);
1280
1281 if (verbose(class)) {
Ingo Molnar74c383f2006-12-13 00:34:43 -08001282 graph_unlock();
Ingo Molnar70e45062006-12-06 20:40:50 -08001283 raw_local_irq_restore(flags);
Ingo Molnar74c383f2006-12-13 00:34:43 -08001284
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07001285 printk("\nnew class %p: %s", class->key, class->name);
1286 if (class->name_version > 1)
1287 printk("#%d", class->name_version);
1288 printk("\n");
1289 dump_stack();
Ingo Molnar74c383f2006-12-13 00:34:43 -08001290
Ingo Molnar70e45062006-12-06 20:40:50 -08001291 raw_local_irq_save(flags);
Ingo Molnar74c383f2006-12-13 00:34:43 -08001292 if (!graph_lock()) {
1293 raw_local_irq_restore(flags);
1294 return NULL;
1295 }
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07001296 }
1297out_unlock_set:
Ingo Molnar74c383f2006-12-13 00:34:43 -08001298 graph_unlock();
Ingo Molnar70e45062006-12-06 20:40:50 -08001299 raw_local_irq_restore(flags);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07001300
Peter Zijlstra4dfbb9d2006-10-11 01:45:14 -04001301 if (!subclass || force)
Ingo Molnard6d897c2006-07-10 04:44:04 -07001302 lock->class_cache = class;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07001303
Jarek Poplawski381a2292007-02-10 01:44:58 -08001304 if (DEBUG_LOCKS_WARN_ON(class->subclass != subclass))
1305 return NULL;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07001306
1307 return class;
1308}
1309
1310/*
1311 * Look up a dependency chain. If the key is not present yet then
1312 * add it and return 0 - in this case the new dependency chain is
1313 * validated. If the key is already hashed, return 1.
1314 */
Ingo Molnar81fc6852006-12-13 00:34:40 -08001315static inline int lookup_chain_cache(u64 chain_key, struct lock_class *class)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07001316{
1317 struct list_head *hash_head = chainhashentry(chain_key);
1318 struct lock_chain *chain;
1319
Jarek Poplawski381a2292007-02-10 01:44:58 -08001320 if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
1321 return 0;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07001322 /*
1323 * We can walk it lock-free, because entries only get added
1324 * to the hash:
1325 */
1326 list_for_each_entry(chain, hash_head, entry) {
1327 if (chain->chain_key == chain_key) {
1328cache_hit:
1329 debug_atomic_inc(&chain_lookup_hits);
Ingo Molnar81fc6852006-12-13 00:34:40 -08001330 if (very_verbose(class))
Andrew Morton755cd902006-12-29 16:49:14 -08001331 printk("\nhash chain already cached, key: "
1332 "%016Lx tail class: [%p] %s\n",
1333 (unsigned long long)chain_key,
1334 class->key, class->name);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07001335 return 0;
1336 }
1337 }
Ingo Molnar81fc6852006-12-13 00:34:40 -08001338 if (very_verbose(class))
Andrew Morton755cd902006-12-29 16:49:14 -08001339 printk("\nnew hash chain, key: %016Lx tail class: [%p] %s\n",
1340 (unsigned long long)chain_key, class->key, class->name);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07001341 /*
1342 * Allocate a new chain entry from the static array, and add
1343 * it to the hash:
1344 */
Ingo Molnar74c383f2006-12-13 00:34:43 -08001345 if (!graph_lock())
1346 return 0;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07001347 /*
1348 * We have to walk the chain again locked - to avoid duplicates:
1349 */
1350 list_for_each_entry(chain, hash_head, entry) {
1351 if (chain->chain_key == chain_key) {
Ingo Molnar74c383f2006-12-13 00:34:43 -08001352 graph_unlock();
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07001353 goto cache_hit;
1354 }
1355 }
1356 if (unlikely(nr_lock_chains >= MAX_LOCKDEP_CHAINS)) {
Ingo Molnar74c383f2006-12-13 00:34:43 -08001357 if (!debug_locks_off_graph_unlock())
1358 return 0;
1359
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07001360 printk("BUG: MAX_LOCKDEP_CHAINS too low!\n");
1361 printk("turning off the locking correctness validator.\n");
1362 return 0;
1363 }
1364 chain = lock_chains + nr_lock_chains++;
1365 chain->chain_key = chain_key;
1366 list_add_tail_rcu(&chain->entry, hash_head);
1367 debug_atomic_inc(&chain_lookup_misses);
1368#ifdef CONFIG_TRACE_IRQFLAGS
1369 if (current->hardirq_context)
1370 nr_hardirq_chains++;
1371 else {
1372 if (current->softirq_context)
1373 nr_softirq_chains++;
1374 else
1375 nr_process_chains++;
1376 }
1377#else
1378 nr_process_chains++;
1379#endif
1380
1381 return 1;
1382}
1383
1384/*
1385 * We are building curr_chain_key incrementally, so double-check
1386 * it from scratch, to make sure that it's done correctly:
1387 */
1388static void check_chain_key(struct task_struct *curr)
1389{
1390#ifdef CONFIG_DEBUG_LOCKDEP
1391 struct held_lock *hlock, *prev_hlock = NULL;
1392 unsigned int i, id;
1393 u64 chain_key = 0;
1394
1395 for (i = 0; i < curr->lockdep_depth; i++) {
1396 hlock = curr->held_locks + i;
1397 if (chain_key != hlock->prev_chain_key) {
1398 debug_locks_off();
1399 printk("hm#1, depth: %u [%u], %016Lx != %016Lx\n",
1400 curr->lockdep_depth, i,
1401 (unsigned long long)chain_key,
1402 (unsigned long long)hlock->prev_chain_key);
1403 WARN_ON(1);
1404 return;
1405 }
1406 id = hlock->class - lock_classes;
Jarek Poplawski381a2292007-02-10 01:44:58 -08001407 if (DEBUG_LOCKS_WARN_ON(id >= MAX_LOCKDEP_KEYS))
1408 return;
1409
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07001410 if (prev_hlock && (prev_hlock->irq_context !=
1411 hlock->irq_context))
1412 chain_key = 0;
1413 chain_key = iterate_chain_key(chain_key, id);
1414 prev_hlock = hlock;
1415 }
1416 if (chain_key != curr->curr_chain_key) {
1417 debug_locks_off();
1418 printk("hm#2, depth: %u [%u], %016Lx != %016Lx\n",
1419 curr->lockdep_depth, i,
1420 (unsigned long long)chain_key,
1421 (unsigned long long)curr->curr_chain_key);
1422 WARN_ON(1);
1423 }
1424#endif
1425}
1426
1427#ifdef CONFIG_TRACE_IRQFLAGS
1428
1429/*
1430 * print irq inversion bug:
1431 */
1432static int
1433print_irq_inversion_bug(struct task_struct *curr, struct lock_class *other,
1434 struct held_lock *this, int forwards,
1435 const char *irqclass)
1436{
Ingo Molnar74c383f2006-12-13 00:34:43 -08001437 if (!debug_locks_off_graph_unlock() || debug_locks_silent)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07001438 return 0;
1439
1440 printk("\n=========================================================\n");
1441 printk( "[ INFO: possible irq lock inversion dependency detected ]\n");
Dave Jones99de0552006-09-29 02:00:10 -07001442 print_kernel_version();
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07001443 printk( "---------------------------------------------------------\n");
1444 printk("%s/%d just changed the state of lock:\n",
1445 curr->comm, curr->pid);
1446 print_lock(this);
1447 if (forwards)
1448 printk("but this lock took another, %s-irq-unsafe lock in the past:\n", irqclass);
1449 else
1450 printk("but this lock was taken by another, %s-irq-safe lock in the past:\n", irqclass);
1451 print_lock_name(other);
1452 printk("\n\nand interrupts could create inverse lock ordering between them.\n\n");
1453
1454 printk("\nother info that might help us debug this:\n");
1455 lockdep_print_held_locks(curr);
1456
1457 printk("\nthe first lock's dependencies:\n");
1458 print_lock_dependencies(this->class, 0);
1459
1460 printk("\nthe second lock's dependencies:\n");
1461 print_lock_dependencies(other, 0);
1462
1463 printk("\nstack backtrace:\n");
1464 dump_stack();
1465
1466 return 0;
1467}
1468
1469/*
1470 * Prove that in the forwards-direction subgraph starting at <this>
1471 * there is no lock matching <mask>:
1472 */
1473static int
1474check_usage_forwards(struct task_struct *curr, struct held_lock *this,
1475 enum lock_usage_bit bit, const char *irqclass)
1476{
1477 int ret;
1478
1479 find_usage_bit = bit;
1480 /* fills in <forwards_match> */
1481 ret = find_usage_forwards(this->class, 0);
1482 if (!ret || ret == 1)
1483 return ret;
1484
1485 return print_irq_inversion_bug(curr, forwards_match, this, 1, irqclass);
1486}
1487
1488/*
1489 * Prove that in the backwards-direction subgraph starting at <this>
1490 * there is no lock matching <mask>:
1491 */
1492static int
1493check_usage_backwards(struct task_struct *curr, struct held_lock *this,
1494 enum lock_usage_bit bit, const char *irqclass)
1495{
1496 int ret;
1497
1498 find_usage_bit = bit;
1499 /* fills in <backwards_match> */
1500 ret = find_usage_backwards(this->class, 0);
1501 if (!ret || ret == 1)
1502 return ret;
1503
1504 return print_irq_inversion_bug(curr, backwards_match, this, 0, irqclass);
1505}
1506
Ingo Molnar3117df02006-12-13 00:34:43 -08001507void print_irqtrace_events(struct task_struct *curr)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07001508{
1509 printk("irq event stamp: %u\n", curr->irq_events);
1510 printk("hardirqs last enabled at (%u): ", curr->hardirq_enable_event);
1511 print_ip_sym(curr->hardirq_enable_ip);
1512 printk("hardirqs last disabled at (%u): ", curr->hardirq_disable_event);
1513 print_ip_sym(curr->hardirq_disable_ip);
1514 printk("softirqs last enabled at (%u): ", curr->softirq_enable_event);
1515 print_ip_sym(curr->softirq_enable_ip);
1516 printk("softirqs last disabled at (%u): ", curr->softirq_disable_event);
1517 print_ip_sym(curr->softirq_disable_ip);
1518}
1519
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07001520#endif
1521
1522static int
1523print_usage_bug(struct task_struct *curr, struct held_lock *this,
1524 enum lock_usage_bit prev_bit, enum lock_usage_bit new_bit)
1525{
Ingo Molnar74c383f2006-12-13 00:34:43 -08001526 if (!debug_locks_off_graph_unlock() || debug_locks_silent)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07001527 return 0;
1528
1529 printk("\n=================================\n");
1530 printk( "[ INFO: inconsistent lock state ]\n");
Dave Jones99de0552006-09-29 02:00:10 -07001531 print_kernel_version();
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07001532 printk( "---------------------------------\n");
1533
1534 printk("inconsistent {%s} -> {%s} usage.\n",
1535 usage_str[prev_bit], usage_str[new_bit]);
1536
1537 printk("%s/%d [HC%u[%lu]:SC%u[%lu]:HE%u:SE%u] takes:\n",
1538 curr->comm, curr->pid,
1539 trace_hardirq_context(curr), hardirq_count() >> HARDIRQ_SHIFT,
1540 trace_softirq_context(curr), softirq_count() >> SOFTIRQ_SHIFT,
1541 trace_hardirqs_enabled(curr),
1542 trace_softirqs_enabled(curr));
1543 print_lock(this);
1544
1545 printk("{%s} state was registered at:\n", usage_str[prev_bit]);
1546 print_stack_trace(this->class->usage_traces + prev_bit, 1);
1547
1548 print_irqtrace_events(curr);
1549 printk("\nother info that might help us debug this:\n");
1550 lockdep_print_held_locks(curr);
1551
1552 printk("\nstack backtrace:\n");
1553 dump_stack();
1554
1555 return 0;
1556}
1557
1558/*
1559 * Print out an error if an invalid bit is set:
1560 */
1561static inline int
1562valid_state(struct task_struct *curr, struct held_lock *this,
1563 enum lock_usage_bit new_bit, enum lock_usage_bit bad_bit)
1564{
1565 if (unlikely(this->class->usage_mask & (1 << bad_bit)))
1566 return print_usage_bug(curr, this, bad_bit, new_bit);
1567 return 1;
1568}
1569
1570#define STRICT_READ_CHECKS 1
1571
1572/*
1573 * Mark a lock with a usage bit, and validate the state transition:
1574 */
1575static int mark_lock(struct task_struct *curr, struct held_lock *this,
1576 enum lock_usage_bit new_bit, unsigned long ip)
1577{
1578 unsigned int new_mask = 1 << new_bit, ret = 1;
1579
1580 /*
1581 * If already set then do not dirty the cacheline,
1582 * nor do any checks:
1583 */
1584 if (likely(this->class->usage_mask & new_mask))
1585 return 1;
1586
Ingo Molnar74c383f2006-12-13 00:34:43 -08001587 if (!graph_lock())
1588 return 0;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07001589 /*
1590 * Make sure we didnt race:
1591 */
1592 if (unlikely(this->class->usage_mask & new_mask)) {
Ingo Molnar74c383f2006-12-13 00:34:43 -08001593 graph_unlock();
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07001594 return 1;
1595 }
1596
1597 this->class->usage_mask |= new_mask;
1598
1599#ifdef CONFIG_TRACE_IRQFLAGS
1600 if (new_bit == LOCK_ENABLED_HARDIRQS ||
1601 new_bit == LOCK_ENABLED_HARDIRQS_READ)
1602 ip = curr->hardirq_enable_ip;
1603 else if (new_bit == LOCK_ENABLED_SOFTIRQS ||
1604 new_bit == LOCK_ENABLED_SOFTIRQS_READ)
1605 ip = curr->softirq_enable_ip;
1606#endif
1607 if (!save_trace(this->class->usage_traces + new_bit))
1608 return 0;
1609
1610 switch (new_bit) {
1611#ifdef CONFIG_TRACE_IRQFLAGS
1612 case LOCK_USED_IN_HARDIRQ:
1613 if (!valid_state(curr, this, new_bit, LOCK_ENABLED_HARDIRQS))
1614 return 0;
1615 if (!valid_state(curr, this, new_bit,
1616 LOCK_ENABLED_HARDIRQS_READ))
1617 return 0;
1618 /*
1619 * just marked it hardirq-safe, check that this lock
1620 * took no hardirq-unsafe lock in the past:
1621 */
1622 if (!check_usage_forwards(curr, this,
1623 LOCK_ENABLED_HARDIRQS, "hard"))
1624 return 0;
1625#if STRICT_READ_CHECKS
1626 /*
1627 * just marked it hardirq-safe, check that this lock
1628 * took no hardirq-unsafe-read lock in the past:
1629 */
1630 if (!check_usage_forwards(curr, this,
1631 LOCK_ENABLED_HARDIRQS_READ, "hard-read"))
1632 return 0;
1633#endif
1634 if (hardirq_verbose(this->class))
1635 ret = 2;
1636 break;
1637 case LOCK_USED_IN_SOFTIRQ:
1638 if (!valid_state(curr, this, new_bit, LOCK_ENABLED_SOFTIRQS))
1639 return 0;
1640 if (!valid_state(curr, this, new_bit,
1641 LOCK_ENABLED_SOFTIRQS_READ))
1642 return 0;
1643 /*
1644 * just marked it softirq-safe, check that this lock
1645 * took no softirq-unsafe lock in the past:
1646 */
1647 if (!check_usage_forwards(curr, this,
1648 LOCK_ENABLED_SOFTIRQS, "soft"))
1649 return 0;
1650#if STRICT_READ_CHECKS
1651 /*
1652 * just marked it softirq-safe, check that this lock
1653 * took no softirq-unsafe-read lock in the past:
1654 */
1655 if (!check_usage_forwards(curr, this,
1656 LOCK_ENABLED_SOFTIRQS_READ, "soft-read"))
1657 return 0;
1658#endif
1659 if (softirq_verbose(this->class))
1660 ret = 2;
1661 break;
1662 case LOCK_USED_IN_HARDIRQ_READ:
1663 if (!valid_state(curr, this, new_bit, LOCK_ENABLED_HARDIRQS))
1664 return 0;
1665 /*
1666 * just marked it hardirq-read-safe, check that this lock
1667 * took no hardirq-unsafe lock in the past:
1668 */
1669 if (!check_usage_forwards(curr, this,
1670 LOCK_ENABLED_HARDIRQS, "hard"))
1671 return 0;
1672 if (hardirq_verbose(this->class))
1673 ret = 2;
1674 break;
1675 case LOCK_USED_IN_SOFTIRQ_READ:
1676 if (!valid_state(curr, this, new_bit, LOCK_ENABLED_SOFTIRQS))
1677 return 0;
1678 /*
1679 * just marked it softirq-read-safe, check that this lock
1680 * took no softirq-unsafe lock in the past:
1681 */
1682 if (!check_usage_forwards(curr, this,
1683 LOCK_ENABLED_SOFTIRQS, "soft"))
1684 return 0;
1685 if (softirq_verbose(this->class))
1686 ret = 2;
1687 break;
1688 case LOCK_ENABLED_HARDIRQS:
1689 if (!valid_state(curr, this, new_bit, LOCK_USED_IN_HARDIRQ))
1690 return 0;
1691 if (!valid_state(curr, this, new_bit,
1692 LOCK_USED_IN_HARDIRQ_READ))
1693 return 0;
1694 /*
1695 * just marked it hardirq-unsafe, check that no hardirq-safe
1696 * lock in the system ever took it in the past:
1697 */
1698 if (!check_usage_backwards(curr, this,
1699 LOCK_USED_IN_HARDIRQ, "hard"))
1700 return 0;
1701#if STRICT_READ_CHECKS
1702 /*
1703 * just marked it hardirq-unsafe, check that no
1704 * hardirq-safe-read lock in the system ever took
1705 * it in the past:
1706 */
1707 if (!check_usage_backwards(curr, this,
1708 LOCK_USED_IN_HARDIRQ_READ, "hard-read"))
1709 return 0;
1710#endif
1711 if (hardirq_verbose(this->class))
1712 ret = 2;
1713 break;
1714 case LOCK_ENABLED_SOFTIRQS:
1715 if (!valid_state(curr, this, new_bit, LOCK_USED_IN_SOFTIRQ))
1716 return 0;
1717 if (!valid_state(curr, this, new_bit,
1718 LOCK_USED_IN_SOFTIRQ_READ))
1719 return 0;
1720 /*
1721 * just marked it softirq-unsafe, check that no softirq-safe
1722 * lock in the system ever took it in the past:
1723 */
1724 if (!check_usage_backwards(curr, this,
1725 LOCK_USED_IN_SOFTIRQ, "soft"))
1726 return 0;
1727#if STRICT_READ_CHECKS
1728 /*
1729 * just marked it softirq-unsafe, check that no
1730 * softirq-safe-read lock in the system ever took
1731 * it in the past:
1732 */
1733 if (!check_usage_backwards(curr, this,
1734 LOCK_USED_IN_SOFTIRQ_READ, "soft-read"))
1735 return 0;
1736#endif
1737 if (softirq_verbose(this->class))
1738 ret = 2;
1739 break;
1740 case LOCK_ENABLED_HARDIRQS_READ:
1741 if (!valid_state(curr, this, new_bit, LOCK_USED_IN_HARDIRQ))
1742 return 0;
1743#if STRICT_READ_CHECKS
1744 /*
1745 * just marked it hardirq-read-unsafe, check that no
1746 * hardirq-safe lock in the system ever took it in the past:
1747 */
1748 if (!check_usage_backwards(curr, this,
1749 LOCK_USED_IN_HARDIRQ, "hard"))
1750 return 0;
1751#endif
1752 if (hardirq_verbose(this->class))
1753 ret = 2;
1754 break;
1755 case LOCK_ENABLED_SOFTIRQS_READ:
1756 if (!valid_state(curr, this, new_bit, LOCK_USED_IN_SOFTIRQ))
1757 return 0;
1758#if STRICT_READ_CHECKS
1759 /*
1760 * just marked it softirq-read-unsafe, check that no
1761 * softirq-safe lock in the system ever took it in the past:
1762 */
1763 if (!check_usage_backwards(curr, this,
1764 LOCK_USED_IN_SOFTIRQ, "soft"))
1765 return 0;
1766#endif
1767 if (softirq_verbose(this->class))
1768 ret = 2;
1769 break;
1770#endif
1771 case LOCK_USED:
1772 /*
1773 * Add it to the global list of classes:
1774 */
1775 list_add_tail_rcu(&this->class->lock_entry, &all_lock_classes);
1776 debug_atomic_dec(&nr_unused_locks);
1777 break;
1778 default:
Ingo Molnar74c383f2006-12-13 00:34:43 -08001779 if (!debug_locks_off_graph_unlock())
1780 return 0;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07001781 WARN_ON(1);
1782 return 0;
1783 }
1784
Ingo Molnar74c383f2006-12-13 00:34:43 -08001785 graph_unlock();
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07001786
1787 /*
Ingo Molnar74c383f2006-12-13 00:34:43 -08001788 * We must printk outside of the graph_lock:
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07001789 */
1790 if (ret == 2) {
1791 printk("\nmarked lock as {%s}:\n", usage_str[new_bit]);
1792 print_lock(this);
1793 print_irqtrace_events(curr);
1794 dump_stack();
1795 }
1796
1797 return ret;
1798}
1799
1800#ifdef CONFIG_TRACE_IRQFLAGS
1801/*
1802 * Mark all held locks with a usage bit:
1803 */
1804static int
1805mark_held_locks(struct task_struct *curr, int hardirq, unsigned long ip)
1806{
1807 enum lock_usage_bit usage_bit;
1808 struct held_lock *hlock;
1809 int i;
1810
1811 for (i = 0; i < curr->lockdep_depth; i++) {
1812 hlock = curr->held_locks + i;
1813
1814 if (hardirq) {
1815 if (hlock->read)
1816 usage_bit = LOCK_ENABLED_HARDIRQS_READ;
1817 else
1818 usage_bit = LOCK_ENABLED_HARDIRQS;
1819 } else {
1820 if (hlock->read)
1821 usage_bit = LOCK_ENABLED_SOFTIRQS_READ;
1822 else
1823 usage_bit = LOCK_ENABLED_SOFTIRQS;
1824 }
1825 if (!mark_lock(curr, hlock, usage_bit, ip))
1826 return 0;
1827 }
1828
1829 return 1;
1830}
1831
1832/*
1833 * Debugging helper: via this flag we know that we are in
1834 * 'early bootup code', and will warn about any invalid irqs-on event:
1835 */
1836static int early_boot_irqs_enabled;
1837
1838void early_boot_irqs_off(void)
1839{
1840 early_boot_irqs_enabled = 0;
1841}
1842
1843void early_boot_irqs_on(void)
1844{
1845 early_boot_irqs_enabled = 1;
1846}
1847
1848/*
1849 * Hardirqs will be enabled:
1850 */
1851void trace_hardirqs_on(void)
1852{
1853 struct task_struct *curr = current;
1854 unsigned long ip;
1855
1856 if (unlikely(!debug_locks || current->lockdep_recursion))
1857 return;
1858
1859 if (DEBUG_LOCKS_WARN_ON(unlikely(!early_boot_irqs_enabled)))
1860 return;
1861
1862 if (unlikely(curr->hardirqs_enabled)) {
1863 debug_atomic_inc(&redundant_hardirqs_on);
1864 return;
1865 }
1866 /* we'll do an OFF -> ON transition: */
1867 curr->hardirqs_enabled = 1;
1868 ip = (unsigned long) __builtin_return_address(0);
1869
1870 if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
1871 return;
1872 if (DEBUG_LOCKS_WARN_ON(current->hardirq_context))
1873 return;
1874 /*
1875 * We are going to turn hardirqs on, so set the
1876 * usage bit for all held locks:
1877 */
1878 if (!mark_held_locks(curr, 1, ip))
1879 return;
1880 /*
1881 * If we have softirqs enabled, then set the usage
1882 * bit for all held locks. (disabled hardirqs prevented
1883 * this bit from being set before)
1884 */
1885 if (curr->softirqs_enabled)
1886 if (!mark_held_locks(curr, 0, ip))
1887 return;
1888
1889 curr->hardirq_enable_ip = ip;
1890 curr->hardirq_enable_event = ++curr->irq_events;
1891 debug_atomic_inc(&hardirqs_on_events);
1892}
1893
1894EXPORT_SYMBOL(trace_hardirqs_on);
1895
1896/*
1897 * Hardirqs were disabled:
1898 */
1899void trace_hardirqs_off(void)
1900{
1901 struct task_struct *curr = current;
1902
1903 if (unlikely(!debug_locks || current->lockdep_recursion))
1904 return;
1905
1906 if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
1907 return;
1908
1909 if (curr->hardirqs_enabled) {
1910 /*
1911 * We have done an ON -> OFF transition:
1912 */
1913 curr->hardirqs_enabled = 0;
1914 curr->hardirq_disable_ip = _RET_IP_;
1915 curr->hardirq_disable_event = ++curr->irq_events;
1916 debug_atomic_inc(&hardirqs_off_events);
1917 } else
1918 debug_atomic_inc(&redundant_hardirqs_off);
1919}
1920
1921EXPORT_SYMBOL(trace_hardirqs_off);
1922
1923/*
1924 * Softirqs will be enabled:
1925 */
1926void trace_softirqs_on(unsigned long ip)
1927{
1928 struct task_struct *curr = current;
1929
1930 if (unlikely(!debug_locks))
1931 return;
1932
1933 if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
1934 return;
1935
1936 if (curr->softirqs_enabled) {
1937 debug_atomic_inc(&redundant_softirqs_on);
1938 return;
1939 }
1940
1941 /*
1942 * We'll do an OFF -> ON transition:
1943 */
1944 curr->softirqs_enabled = 1;
1945 curr->softirq_enable_ip = ip;
1946 curr->softirq_enable_event = ++curr->irq_events;
1947 debug_atomic_inc(&softirqs_on_events);
1948 /*
1949 * We are going to turn softirqs on, so set the
1950 * usage bit for all held locks, if hardirqs are
1951 * enabled too:
1952 */
1953 if (curr->hardirqs_enabled)
1954 mark_held_locks(curr, 0, ip);
1955}
1956
1957/*
1958 * Softirqs were disabled:
1959 */
1960void trace_softirqs_off(unsigned long ip)
1961{
1962 struct task_struct *curr = current;
1963
1964 if (unlikely(!debug_locks))
1965 return;
1966
1967 if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
1968 return;
1969
1970 if (curr->softirqs_enabled) {
1971 /*
1972 * We have done an ON -> OFF transition:
1973 */
1974 curr->softirqs_enabled = 0;
1975 curr->softirq_disable_ip = ip;
1976 curr->softirq_disable_event = ++curr->irq_events;
1977 debug_atomic_inc(&softirqs_off_events);
1978 DEBUG_LOCKS_WARN_ON(!softirq_count());
1979 } else
1980 debug_atomic_inc(&redundant_softirqs_off);
1981}
1982
1983#endif
1984
1985/*
1986 * Initialize a lock instance's lock-class mapping info:
1987 */
1988void lockdep_init_map(struct lockdep_map *lock, const char *name,
Peter Zijlstra4dfbb9d2006-10-11 01:45:14 -04001989 struct lock_class_key *key, int subclass)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07001990{
1991 if (unlikely(!debug_locks))
1992 return;
1993
1994 if (DEBUG_LOCKS_WARN_ON(!key))
1995 return;
1996 if (DEBUG_LOCKS_WARN_ON(!name))
1997 return;
1998 /*
1999 * Sanity check, the lock-class key must be persistent:
2000 */
2001 if (!static_obj(key)) {
2002 printk("BUG: key %p not in .data!\n", key);
2003 DEBUG_LOCKS_WARN_ON(1);
2004 return;
2005 }
2006 lock->name = name;
2007 lock->key = key;
Ingo Molnard6d897c2006-07-10 04:44:04 -07002008 lock->class_cache = NULL;
Peter Zijlstra4dfbb9d2006-10-11 01:45:14 -04002009 if (subclass)
2010 register_lock_class(lock, subclass, 1);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002011}
2012
2013EXPORT_SYMBOL_GPL(lockdep_init_map);
2014
2015/*
2016 * This gets called for every mutex_lock*()/spin_lock*() operation.
2017 * We maintain the dependency maps and validate the locking attempt:
2018 */
2019static int __lock_acquire(struct lockdep_map *lock, unsigned int subclass,
2020 int trylock, int read, int check, int hardirqs_off,
2021 unsigned long ip)
2022{
2023 struct task_struct *curr = current;
Ingo Molnard6d897c2006-07-10 04:44:04 -07002024 struct lock_class *class = NULL;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002025 struct held_lock *hlock;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002026 unsigned int depth, id;
2027 int chain_head = 0;
2028 u64 chain_key;
2029
2030 if (unlikely(!debug_locks))
2031 return 0;
2032
2033 if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
2034 return 0;
2035
2036 if (unlikely(subclass >= MAX_LOCKDEP_SUBCLASSES)) {
2037 debug_locks_off();
2038 printk("BUG: MAX_LOCKDEP_SUBCLASSES too low!\n");
2039 printk("turning off the locking correctness validator.\n");
2040 return 0;
2041 }
2042
Ingo Molnard6d897c2006-07-10 04:44:04 -07002043 if (!subclass)
2044 class = lock->class_cache;
2045 /*
2046 * Not cached yet or subclass?
2047 */
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002048 if (unlikely(!class)) {
Peter Zijlstra4dfbb9d2006-10-11 01:45:14 -04002049 class = register_lock_class(lock, subclass, 0);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002050 if (!class)
2051 return 0;
2052 }
2053 debug_atomic_inc((atomic_t *)&class->ops);
2054 if (very_verbose(class)) {
2055 printk("\nacquire class [%p] %s", class->key, class->name);
2056 if (class->name_version > 1)
2057 printk("#%d", class->name_version);
2058 printk("\n");
2059 dump_stack();
2060 }
2061
2062 /*
2063 * Add the lock to the list of currently held locks.
2064 * (we dont increase the depth just yet, up until the
2065 * dependency checks are done)
2066 */
2067 depth = curr->lockdep_depth;
2068 if (DEBUG_LOCKS_WARN_ON(depth >= MAX_LOCK_DEPTH))
2069 return 0;
2070
2071 hlock = curr->held_locks + depth;
2072
2073 hlock->class = class;
2074 hlock->acquire_ip = ip;
2075 hlock->instance = lock;
2076 hlock->trylock = trylock;
2077 hlock->read = read;
2078 hlock->check = check;
2079 hlock->hardirqs_off = hardirqs_off;
2080
2081 if (check != 2)
2082 goto out_calc_hash;
2083#ifdef CONFIG_TRACE_IRQFLAGS
2084 /*
2085 * If non-trylock use in a hardirq or softirq context, then
2086 * mark the lock as used in these contexts:
2087 */
2088 if (!trylock) {
2089 if (read) {
2090 if (curr->hardirq_context)
2091 if (!mark_lock(curr, hlock,
2092 LOCK_USED_IN_HARDIRQ_READ, ip))
2093 return 0;
2094 if (curr->softirq_context)
2095 if (!mark_lock(curr, hlock,
2096 LOCK_USED_IN_SOFTIRQ_READ, ip))
2097 return 0;
2098 } else {
2099 if (curr->hardirq_context)
2100 if (!mark_lock(curr, hlock, LOCK_USED_IN_HARDIRQ, ip))
2101 return 0;
2102 if (curr->softirq_context)
2103 if (!mark_lock(curr, hlock, LOCK_USED_IN_SOFTIRQ, ip))
2104 return 0;
2105 }
2106 }
2107 if (!hardirqs_off) {
2108 if (read) {
2109 if (!mark_lock(curr, hlock,
2110 LOCK_ENABLED_HARDIRQS_READ, ip))
2111 return 0;
2112 if (curr->softirqs_enabled)
2113 if (!mark_lock(curr, hlock,
2114 LOCK_ENABLED_SOFTIRQS_READ, ip))
2115 return 0;
2116 } else {
2117 if (!mark_lock(curr, hlock,
2118 LOCK_ENABLED_HARDIRQS, ip))
2119 return 0;
2120 if (curr->softirqs_enabled)
2121 if (!mark_lock(curr, hlock,
2122 LOCK_ENABLED_SOFTIRQS, ip))
2123 return 0;
2124 }
2125 }
2126#endif
2127 /* mark it as used: */
2128 if (!mark_lock(curr, hlock, LOCK_USED, ip))
2129 return 0;
2130out_calc_hash:
2131 /*
2132 * Calculate the chain hash: it's the combined has of all the
2133 * lock keys along the dependency chain. We save the hash value
2134 * at every step so that we can get the current hash easily
2135 * after unlock. The chain hash is then used to cache dependency
2136 * results.
2137 *
2138 * The 'key ID' is what is the most compact key value to drive
2139 * the hash, not class->key.
2140 */
2141 id = class - lock_classes;
2142 if (DEBUG_LOCKS_WARN_ON(id >= MAX_LOCKDEP_KEYS))
2143 return 0;
2144
2145 chain_key = curr->curr_chain_key;
2146 if (!depth) {
2147 if (DEBUG_LOCKS_WARN_ON(chain_key != 0))
2148 return 0;
2149 chain_head = 1;
2150 }
2151
2152 hlock->prev_chain_key = chain_key;
2153
2154#ifdef CONFIG_TRACE_IRQFLAGS
2155 /*
2156 * Keep track of points where we cross into an interrupt context:
2157 */
2158 hlock->irq_context = 2*(curr->hardirq_context ? 1 : 0) +
2159 curr->softirq_context;
2160 if (depth) {
2161 struct held_lock *prev_hlock;
2162
2163 prev_hlock = curr->held_locks + depth-1;
2164 /*
2165 * If we cross into another context, reset the
2166 * hash key (this also prevents the checking and the
2167 * adding of the dependency to 'prev'):
2168 */
2169 if (prev_hlock->irq_context != hlock->irq_context) {
2170 chain_key = 0;
2171 chain_head = 1;
2172 }
2173 }
2174#endif
2175 chain_key = iterate_chain_key(chain_key, id);
2176 curr->curr_chain_key = chain_key;
2177
2178 /*
2179 * Trylock needs to maintain the stack of held locks, but it
2180 * does not add new dependencies, because trylock can be done
2181 * in any order.
2182 *
2183 * We look up the chain_key and do the O(N^2) check and update of
2184 * the dependencies only if this is a new dependency chain.
2185 * (If lookup_chain_cache() returns with 1 it acquires
Ingo Molnar74c383f2006-12-13 00:34:43 -08002186 * graph_lock for us)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002187 */
Ingo Molnar81fc6852006-12-13 00:34:40 -08002188 if (!trylock && (check == 2) && lookup_chain_cache(chain_key, class)) {
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002189 /*
2190 * Check whether last held lock:
2191 *
2192 * - is irq-safe, if this lock is irq-unsafe
2193 * - is softirq-safe, if this lock is hardirq-unsafe
2194 *
2195 * And check whether the new lock's dependency graph
2196 * could lead back to the previous lock.
2197 *
2198 * any of these scenarios could lead to a deadlock. If
2199 * All validations
2200 */
2201 int ret = check_deadlock(curr, hlock, lock, read);
2202
2203 if (!ret)
2204 return 0;
2205 /*
2206 * Mark recursive read, as we jump over it when
2207 * building dependencies (just like we jump over
2208 * trylock entries):
2209 */
2210 if (ret == 2)
2211 hlock->read = 2;
2212 /*
2213 * Add dependency only if this lock is not the head
2214 * of the chain, and if it's not a secondary read-lock:
2215 */
2216 if (!chain_head && ret != 2)
2217 if (!check_prevs_add(curr, hlock))
2218 return 0;
Ingo Molnar74c383f2006-12-13 00:34:43 -08002219 graph_unlock();
Jarek Poplawski381a2292007-02-10 01:44:58 -08002220 } else
2221 /* after lookup_chain_cache(): */
2222 if (unlikely(!debug_locks))
2223 return 0;
2224
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002225 curr->lockdep_depth++;
2226 check_chain_key(curr);
Jarek Poplawski60e114d2007-02-20 13:58:00 -08002227#ifdef CONFIG_DEBUG_LOCKDEP
2228 if (unlikely(!debug_locks))
2229 return 0;
2230#endif
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002231 if (unlikely(curr->lockdep_depth >= MAX_LOCK_DEPTH)) {
2232 debug_locks_off();
2233 printk("BUG: MAX_LOCK_DEPTH too low!\n");
2234 printk("turning off the locking correctness validator.\n");
2235 return 0;
2236 }
Jarek Poplawski381a2292007-02-10 01:44:58 -08002237
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002238 if (unlikely(curr->lockdep_depth > max_lockdep_depth))
2239 max_lockdep_depth = curr->lockdep_depth;
2240
2241 return 1;
2242}
2243
2244static int
2245print_unlock_inbalance_bug(struct task_struct *curr, struct lockdep_map *lock,
2246 unsigned long ip)
2247{
2248 if (!debug_locks_off())
2249 return 0;
2250 if (debug_locks_silent)
2251 return 0;
2252
2253 printk("\n=====================================\n");
2254 printk( "[ BUG: bad unlock balance detected! ]\n");
2255 printk( "-------------------------------------\n");
2256 printk("%s/%d is trying to release lock (",
2257 curr->comm, curr->pid);
2258 print_lockdep_cache(lock);
2259 printk(") at:\n");
2260 print_ip_sym(ip);
2261 printk("but there are no more locks to release!\n");
2262 printk("\nother info that might help us debug this:\n");
2263 lockdep_print_held_locks(curr);
2264
2265 printk("\nstack backtrace:\n");
2266 dump_stack();
2267
2268 return 0;
2269}
2270
2271/*
2272 * Common debugging checks for both nested and non-nested unlock:
2273 */
2274static int check_unlock(struct task_struct *curr, struct lockdep_map *lock,
2275 unsigned long ip)
2276{
2277 if (unlikely(!debug_locks))
2278 return 0;
2279 if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
2280 return 0;
2281
2282 if (curr->lockdep_depth <= 0)
2283 return print_unlock_inbalance_bug(curr, lock, ip);
2284
2285 return 1;
2286}
2287
2288/*
2289 * Remove the lock to the list of currently held locks in a
2290 * potentially non-nested (out of order) manner. This is a
2291 * relatively rare operation, as all the unlock APIs default
2292 * to nested mode (which uses lock_release()):
2293 */
2294static int
2295lock_release_non_nested(struct task_struct *curr,
2296 struct lockdep_map *lock, unsigned long ip)
2297{
2298 struct held_lock *hlock, *prev_hlock;
2299 unsigned int depth;
2300 int i;
2301
2302 /*
2303 * Check whether the lock exists in the current stack
2304 * of held locks:
2305 */
2306 depth = curr->lockdep_depth;
2307 if (DEBUG_LOCKS_WARN_ON(!depth))
2308 return 0;
2309
2310 prev_hlock = NULL;
2311 for (i = depth-1; i >= 0; i--) {
2312 hlock = curr->held_locks + i;
2313 /*
2314 * We must not cross into another context:
2315 */
2316 if (prev_hlock && prev_hlock->irq_context != hlock->irq_context)
2317 break;
2318 if (hlock->instance == lock)
2319 goto found_it;
2320 prev_hlock = hlock;
2321 }
2322 return print_unlock_inbalance_bug(curr, lock, ip);
2323
2324found_it:
2325 /*
2326 * We have the right lock to unlock, 'hlock' points to it.
2327 * Now we remove it from the stack, and add back the other
2328 * entries (if any), recalculating the hash along the way:
2329 */
2330 curr->lockdep_depth = i;
2331 curr->curr_chain_key = hlock->prev_chain_key;
2332
2333 for (i++; i < depth; i++) {
2334 hlock = curr->held_locks + i;
2335 if (!__lock_acquire(hlock->instance,
2336 hlock->class->subclass, hlock->trylock,
2337 hlock->read, hlock->check, hlock->hardirqs_off,
2338 hlock->acquire_ip))
2339 return 0;
2340 }
2341
2342 if (DEBUG_LOCKS_WARN_ON(curr->lockdep_depth != depth - 1))
2343 return 0;
2344 return 1;
2345}
2346
2347/*
2348 * Remove the lock to the list of currently held locks - this gets
2349 * called on mutex_unlock()/spin_unlock*() (or on a failed
2350 * mutex_lock_interruptible()). This is done for unlocks that nest
2351 * perfectly. (i.e. the current top of the lock-stack is unlocked)
2352 */
2353static int lock_release_nested(struct task_struct *curr,
2354 struct lockdep_map *lock, unsigned long ip)
2355{
2356 struct held_lock *hlock;
2357 unsigned int depth;
2358
2359 /*
2360 * Pop off the top of the lock stack:
2361 */
2362 depth = curr->lockdep_depth - 1;
2363 hlock = curr->held_locks + depth;
2364
2365 /*
2366 * Is the unlock non-nested:
2367 */
2368 if (hlock->instance != lock)
2369 return lock_release_non_nested(curr, lock, ip);
2370 curr->lockdep_depth--;
2371
2372 if (DEBUG_LOCKS_WARN_ON(!depth && (hlock->prev_chain_key != 0)))
2373 return 0;
2374
2375 curr->curr_chain_key = hlock->prev_chain_key;
2376
2377#ifdef CONFIG_DEBUG_LOCKDEP
2378 hlock->prev_chain_key = 0;
2379 hlock->class = NULL;
2380 hlock->acquire_ip = 0;
2381 hlock->irq_context = 0;
2382#endif
2383 return 1;
2384}
2385
2386/*
2387 * Remove the lock to the list of currently held locks - this gets
2388 * called on mutex_unlock()/spin_unlock*() (or on a failed
2389 * mutex_lock_interruptible()). This is done for unlocks that nest
2390 * perfectly. (i.e. the current top of the lock-stack is unlocked)
2391 */
2392static void
2393__lock_release(struct lockdep_map *lock, int nested, unsigned long ip)
2394{
2395 struct task_struct *curr = current;
2396
2397 if (!check_unlock(curr, lock, ip))
2398 return;
2399
2400 if (nested) {
2401 if (!lock_release_nested(curr, lock, ip))
2402 return;
2403 } else {
2404 if (!lock_release_non_nested(curr, lock, ip))
2405 return;
2406 }
2407
2408 check_chain_key(curr);
2409}
2410
2411/*
2412 * Check whether we follow the irq-flags state precisely:
2413 */
2414static void check_flags(unsigned long flags)
2415{
2416#if defined(CONFIG_DEBUG_LOCKDEP) && defined(CONFIG_TRACE_IRQFLAGS)
2417 if (!debug_locks)
2418 return;
2419
2420 if (irqs_disabled_flags(flags))
2421 DEBUG_LOCKS_WARN_ON(current->hardirqs_enabled);
2422 else
2423 DEBUG_LOCKS_WARN_ON(!current->hardirqs_enabled);
2424
2425 /*
2426 * We dont accurately track softirq state in e.g.
2427 * hardirq contexts (such as on 4KSTACKS), so only
2428 * check if not in hardirq contexts:
2429 */
2430 if (!hardirq_count()) {
2431 if (softirq_count())
2432 DEBUG_LOCKS_WARN_ON(current->softirqs_enabled);
2433 else
2434 DEBUG_LOCKS_WARN_ON(!current->softirqs_enabled);
2435 }
2436
2437 if (!debug_locks)
2438 print_irqtrace_events(current);
2439#endif
2440}
2441
2442/*
2443 * We are not always called with irqs disabled - do that here,
2444 * and also avoid lockdep recursion:
2445 */
2446void lock_acquire(struct lockdep_map *lock, unsigned int subclass,
2447 int trylock, int read, int check, unsigned long ip)
2448{
2449 unsigned long flags;
2450
2451 if (unlikely(current->lockdep_recursion))
2452 return;
2453
2454 raw_local_irq_save(flags);
2455 check_flags(flags);
2456
2457 current->lockdep_recursion = 1;
2458 __lock_acquire(lock, subclass, trylock, read, check,
2459 irqs_disabled_flags(flags), ip);
2460 current->lockdep_recursion = 0;
2461 raw_local_irq_restore(flags);
2462}
2463
2464EXPORT_SYMBOL_GPL(lock_acquire);
2465
2466void lock_release(struct lockdep_map *lock, int nested, unsigned long ip)
2467{
2468 unsigned long flags;
2469
2470 if (unlikely(current->lockdep_recursion))
2471 return;
2472
2473 raw_local_irq_save(flags);
2474 check_flags(flags);
2475 current->lockdep_recursion = 1;
2476 __lock_release(lock, nested, ip);
2477 current->lockdep_recursion = 0;
2478 raw_local_irq_restore(flags);
2479}
2480
2481EXPORT_SYMBOL_GPL(lock_release);
2482
2483/*
2484 * Used by the testsuite, sanitize the validator state
2485 * after a simulated failure:
2486 */
2487
2488void lockdep_reset(void)
2489{
2490 unsigned long flags;
Ingo Molnar23d95a02006-12-13 00:34:40 -08002491 int i;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002492
2493 raw_local_irq_save(flags);
2494 current->curr_chain_key = 0;
2495 current->lockdep_depth = 0;
2496 current->lockdep_recursion = 0;
2497 memset(current->held_locks, 0, MAX_LOCK_DEPTH*sizeof(struct held_lock));
2498 nr_hardirq_chains = 0;
2499 nr_softirq_chains = 0;
2500 nr_process_chains = 0;
2501 debug_locks = 1;
Ingo Molnar23d95a02006-12-13 00:34:40 -08002502 for (i = 0; i < CHAINHASH_SIZE; i++)
2503 INIT_LIST_HEAD(chainhash_table + i);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002504 raw_local_irq_restore(flags);
2505}
2506
2507static void zap_class(struct lock_class *class)
2508{
2509 int i;
2510
2511 /*
2512 * Remove all dependencies this lock is
2513 * involved in:
2514 */
2515 for (i = 0; i < nr_list_entries; i++) {
2516 if (list_entries[i].class == class)
2517 list_del_rcu(&list_entries[i].entry);
2518 }
2519 /*
2520 * Unhash the class and remove it from the all_lock_classes list:
2521 */
2522 list_del_rcu(&class->hash_entry);
2523 list_del_rcu(&class->lock_entry);
2524
2525}
2526
2527static inline int within(void *addr, void *start, unsigned long size)
2528{
2529 return addr >= start && addr < start + size;
2530}
2531
2532void lockdep_free_key_range(void *start, unsigned long size)
2533{
2534 struct lock_class *class, *next;
2535 struct list_head *head;
2536 unsigned long flags;
2537 int i;
2538
2539 raw_local_irq_save(flags);
Ingo Molnar74c383f2006-12-13 00:34:43 -08002540 graph_lock();
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002541
2542 /*
2543 * Unhash all classes that were created by this module:
2544 */
2545 for (i = 0; i < CLASSHASH_SIZE; i++) {
2546 head = classhash_table + i;
2547 if (list_empty(head))
2548 continue;
2549 list_for_each_entry_safe(class, next, head, hash_entry)
2550 if (within(class->key, start, size))
2551 zap_class(class);
2552 }
2553
Ingo Molnar74c383f2006-12-13 00:34:43 -08002554 graph_unlock();
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002555 raw_local_irq_restore(flags);
2556}
2557
2558void lockdep_reset_lock(struct lockdep_map *lock)
2559{
Ingo Molnard6d897c2006-07-10 04:44:04 -07002560 struct lock_class *class, *next;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002561 struct list_head *head;
2562 unsigned long flags;
2563 int i, j;
2564
2565 raw_local_irq_save(flags);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002566
2567 /*
Ingo Molnard6d897c2006-07-10 04:44:04 -07002568 * Remove all classes this lock might have:
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002569 */
Ingo Molnard6d897c2006-07-10 04:44:04 -07002570 for (j = 0; j < MAX_LOCKDEP_SUBCLASSES; j++) {
2571 /*
2572 * If the class exists we look it up and zap it:
2573 */
2574 class = look_up_lock_class(lock, j);
2575 if (class)
2576 zap_class(class);
2577 }
2578 /*
2579 * Debug check: in the end all mapped classes should
2580 * be gone.
2581 */
Ingo Molnar74c383f2006-12-13 00:34:43 -08002582 graph_lock();
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002583 for (i = 0; i < CLASSHASH_SIZE; i++) {
2584 head = classhash_table + i;
2585 if (list_empty(head))
2586 continue;
2587 list_for_each_entry_safe(class, next, head, hash_entry) {
Ingo Molnard6d897c2006-07-10 04:44:04 -07002588 if (unlikely(class == lock->class_cache)) {
Ingo Molnar74c383f2006-12-13 00:34:43 -08002589 if (debug_locks_off_graph_unlock())
2590 WARN_ON(1);
Ingo Molnard6d897c2006-07-10 04:44:04 -07002591 goto out_restore;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002592 }
2593 }
2594 }
Ingo Molnar74c383f2006-12-13 00:34:43 -08002595 graph_unlock();
Ingo Molnard6d897c2006-07-10 04:44:04 -07002596
2597out_restore:
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002598 raw_local_irq_restore(flags);
2599}
2600
Sam Ravnborg14999932007-02-28 20:12:31 -08002601void lockdep_init(void)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002602{
2603 int i;
2604
2605 /*
2606 * Some architectures have their own start_kernel()
2607 * code which calls lockdep_init(), while we also
2608 * call lockdep_init() from the start_kernel() itself,
2609 * and we want to initialize the hashes only once:
2610 */
2611 if (lockdep_initialized)
2612 return;
2613
2614 for (i = 0; i < CLASSHASH_SIZE; i++)
2615 INIT_LIST_HEAD(classhash_table + i);
2616
2617 for (i = 0; i < CHAINHASH_SIZE; i++)
2618 INIT_LIST_HEAD(chainhash_table + i);
2619
2620 lockdep_initialized = 1;
2621}
2622
2623void __init lockdep_info(void)
2624{
2625 printk("Lock dependency validator: Copyright (c) 2006 Red Hat, Inc., Ingo Molnar\n");
2626
2627 printk("... MAX_LOCKDEP_SUBCLASSES: %lu\n", MAX_LOCKDEP_SUBCLASSES);
2628 printk("... MAX_LOCK_DEPTH: %lu\n", MAX_LOCK_DEPTH);
2629 printk("... MAX_LOCKDEP_KEYS: %lu\n", MAX_LOCKDEP_KEYS);
2630 printk("... CLASSHASH_SIZE: %lu\n", CLASSHASH_SIZE);
2631 printk("... MAX_LOCKDEP_ENTRIES: %lu\n", MAX_LOCKDEP_ENTRIES);
2632 printk("... MAX_LOCKDEP_CHAINS: %lu\n", MAX_LOCKDEP_CHAINS);
2633 printk("... CHAINHASH_SIZE: %lu\n", CHAINHASH_SIZE);
2634
2635 printk(" memory used by lock dependency info: %lu kB\n",
2636 (sizeof(struct lock_class) * MAX_LOCKDEP_KEYS +
2637 sizeof(struct list_head) * CLASSHASH_SIZE +
2638 sizeof(struct lock_list) * MAX_LOCKDEP_ENTRIES +
2639 sizeof(struct lock_chain) * MAX_LOCKDEP_CHAINS +
2640 sizeof(struct list_head) * CHAINHASH_SIZE) / 1024);
2641
2642 printk(" per task-struct memory footprint: %lu bytes\n",
2643 sizeof(struct held_lock) * MAX_LOCK_DEPTH);
2644
2645#ifdef CONFIG_DEBUG_LOCKDEP
2646 if (lockdep_init_error)
2647 printk("WARNING: lockdep init error! Arch code didnt call lockdep_init() early enough?\n");
2648#endif
2649}
2650
2651static inline int in_range(const void *start, const void *addr, const void *end)
2652{
2653 return addr >= start && addr <= end;
2654}
2655
2656static void
2657print_freed_lock_bug(struct task_struct *curr, const void *mem_from,
Arjan van de Ven55794a42006-07-10 04:44:03 -07002658 const void *mem_to, struct held_lock *hlock)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002659{
2660 if (!debug_locks_off())
2661 return;
2662 if (debug_locks_silent)
2663 return;
2664
2665 printk("\n=========================\n");
2666 printk( "[ BUG: held lock freed! ]\n");
2667 printk( "-------------------------\n");
2668 printk("%s/%d is freeing memory %p-%p, with a lock still held there!\n",
2669 curr->comm, curr->pid, mem_from, mem_to-1);
Arjan van de Ven55794a42006-07-10 04:44:03 -07002670 print_lock(hlock);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002671 lockdep_print_held_locks(curr);
2672
2673 printk("\nstack backtrace:\n");
2674 dump_stack();
2675}
2676
2677/*
2678 * Called when kernel memory is freed (or unmapped), or if a lock
2679 * is destroyed or reinitialized - this code checks whether there is
2680 * any held lock in the memory range of <from> to <to>:
2681 */
2682void debug_check_no_locks_freed(const void *mem_from, unsigned long mem_len)
2683{
2684 const void *mem_to = mem_from + mem_len, *lock_from, *lock_to;
2685 struct task_struct *curr = current;
2686 struct held_lock *hlock;
2687 unsigned long flags;
2688 int i;
2689
2690 if (unlikely(!debug_locks))
2691 return;
2692
2693 local_irq_save(flags);
2694 for (i = 0; i < curr->lockdep_depth; i++) {
2695 hlock = curr->held_locks + i;
2696
2697 lock_from = (void *)hlock->instance;
2698 lock_to = (void *)(hlock->instance + 1);
2699
2700 if (!in_range(mem_from, lock_from, mem_to) &&
2701 !in_range(mem_from, lock_to, mem_to))
2702 continue;
2703
Arjan van de Ven55794a42006-07-10 04:44:03 -07002704 print_freed_lock_bug(curr, mem_from, mem_to, hlock);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002705 break;
2706 }
2707 local_irq_restore(flags);
2708}
Peter Zijlstraed075362006-12-06 20:35:24 -08002709EXPORT_SYMBOL_GPL(debug_check_no_locks_freed);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002710
2711static void print_held_locks_bug(struct task_struct *curr)
2712{
2713 if (!debug_locks_off())
2714 return;
2715 if (debug_locks_silent)
2716 return;
2717
2718 printk("\n=====================================\n");
2719 printk( "[ BUG: lock held at task exit time! ]\n");
2720 printk( "-------------------------------------\n");
2721 printk("%s/%d is exiting with locks still held!\n",
2722 curr->comm, curr->pid);
2723 lockdep_print_held_locks(curr);
2724
2725 printk("\nstack backtrace:\n");
2726 dump_stack();
2727}
2728
2729void debug_check_no_locks_held(struct task_struct *task)
2730{
2731 if (unlikely(task->lockdep_depth > 0))
2732 print_held_locks_bug(task);
2733}
2734
2735void debug_show_all_locks(void)
2736{
2737 struct task_struct *g, *p;
2738 int count = 10;
2739 int unlock = 1;
2740
Jarek Poplawski9c35dd72007-03-22 00:11:28 -08002741 if (unlikely(!debug_locks)) {
2742 printk("INFO: lockdep is turned off.\n");
2743 return;
2744 }
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002745 printk("\nShowing all locks held in the system:\n");
2746
2747 /*
2748 * Here we try to get the tasklist_lock as hard as possible,
2749 * if not successful after 2 seconds we ignore it (but keep
2750 * trying). This is to enable a debug printout even if a
2751 * tasklist_lock-holding task deadlocks or crashes.
2752 */
2753retry:
2754 if (!read_trylock(&tasklist_lock)) {
2755 if (count == 10)
2756 printk("hm, tasklist_lock locked, retrying... ");
2757 if (count) {
2758 count--;
2759 printk(" #%d", 10-count);
2760 mdelay(200);
2761 goto retry;
2762 }
2763 printk(" ignoring it.\n");
2764 unlock = 0;
2765 }
2766 if (count != 10)
2767 printk(" locked it.\n");
2768
2769 do_each_thread(g, p) {
2770 if (p->lockdep_depth)
2771 lockdep_print_held_locks(p);
2772 if (!unlock)
2773 if (read_trylock(&tasklist_lock))
2774 unlock = 1;
2775 } while_each_thread(g, p);
2776
2777 printk("\n");
2778 printk("=============================================\n\n");
2779
2780 if (unlock)
2781 read_unlock(&tasklist_lock);
2782}
2783
2784EXPORT_SYMBOL_GPL(debug_show_all_locks);
2785
2786void debug_show_held_locks(struct task_struct *task)
2787{
Jarek Poplawski9c35dd72007-03-22 00:11:28 -08002788 if (unlikely(!debug_locks)) {
2789 printk("INFO: lockdep is turned off.\n");
2790 return;
2791 }
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002792 lockdep_print_held_locks(task);
2793}
2794
2795EXPORT_SYMBOL_GPL(debug_show_held_locks);