[PATCH] lockdep: improve verbose messages
[linux-2.6.22.y-op.git] / kernel / lockdep.c
blob5ba2825bd46a0aed732820364f51a8e5b9e798e5
1 /*
2 * kernel/lockdep.c
4 * Runtime locking correctness validator
6 * Started by Ingo Molnar:
8 * Copyright (C) 2006 Red Hat, Inc., Ingo Molnar <mingo@redhat.com>
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:
13 * - lock inversion scenarios
14 * - circular lock dependencies
15 * - hardirq/softirq safe/unsafe locking bugs
17 * Bugs are reported even if the current locking scenario does not cause
18 * any deadlock at this point.
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.
24 * Thanks to Arjan van de Ven for coming up with the initial idea of
25 * mapping lock dependencies runtime.
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>
39 #include <linux/utsname.h>
41 #include <asm/sections.h>
43 #include "lockdep_internals.h"
46 * hash_lock: protects the lockdep hashes and class/list/hash allocators.
48 * This is one of the rare exceptions where it's justified
49 * to use a raw spinlock - we really dont want the spinlock
50 * code to recurse back into the lockdep code.
52 static raw_spinlock_t hash_lock = (raw_spinlock_t)__RAW_SPIN_LOCK_UNLOCKED;
54 static int lockdep_initialized;
56 unsigned long nr_list_entries;
57 static struct lock_list list_entries[MAX_LOCKDEP_ENTRIES];
60 * Allocate a lockdep entry. (assumes hash_lock held, returns
61 * with NULL on failure)
63 static struct lock_list *alloc_list_entry(void)
65 if (nr_list_entries >= MAX_LOCKDEP_ENTRIES) {
66 __raw_spin_unlock(&hash_lock);
67 debug_locks_off();
68 printk("BUG: MAX_LOCKDEP_ENTRIES too low!\n");
69 printk("turning off the locking correctness validator.\n");
70 return NULL;
72 return list_entries + nr_list_entries++;
76 * All data structures here are protected by the global debug_lock.
78 * Mutex key structs only get allocated, once during bootup, and never
79 * get freed - this significantly simplifies the debugging code.
81 unsigned long nr_lock_classes;
82 static struct lock_class lock_classes[MAX_LOCKDEP_KEYS];
85 * We keep a global list of all lock classes. The list only grows,
86 * never shrinks. The list is only accessed with the lockdep
87 * spinlock lock held.
89 LIST_HEAD(all_lock_classes);
92 * The lockdep classes are in a hash-table as well, for fast lookup:
94 #define CLASSHASH_BITS (MAX_LOCKDEP_KEYS_BITS - 1)
95 #define CLASSHASH_SIZE (1UL << CLASSHASH_BITS)
96 #define CLASSHASH_MASK (CLASSHASH_SIZE - 1)
97 #define __classhashfn(key) ((((unsigned long)key >> CLASSHASH_BITS) + (unsigned long)key) & CLASSHASH_MASK)
98 #define classhashentry(key) (classhash_table + __classhashfn((key)))
100 static struct list_head classhash_table[CLASSHASH_SIZE];
102 unsigned long nr_lock_chains;
103 static struct lock_chain lock_chains[MAX_LOCKDEP_CHAINS];
106 * We put the lock dependency chains into a hash-table as well, to cache
107 * their existence:
109 #define CHAINHASH_BITS (MAX_LOCKDEP_CHAINS_BITS-1)
110 #define CHAINHASH_SIZE (1UL << CHAINHASH_BITS)
111 #define CHAINHASH_MASK (CHAINHASH_SIZE - 1)
112 #define __chainhashfn(chain) \
113 (((chain >> CHAINHASH_BITS) + chain) & CHAINHASH_MASK)
114 #define chainhashentry(chain) (chainhash_table + __chainhashfn((chain)))
116 static struct list_head chainhash_table[CHAINHASH_SIZE];
119 * The hash key of the lock dependency chains is a hash itself too:
120 * it's a hash of all locks taken up to that lock, including that lock.
121 * It's a 64-bit hash, because it's important for the keys to be
122 * unique.
124 #define iterate_chain_key(key1, key2) \
125 (((key1) << MAX_LOCKDEP_KEYS_BITS) ^ \
126 ((key1) >> (64-MAX_LOCKDEP_KEYS_BITS)) ^ \
127 (key2))
129 void lockdep_off(void)
131 current->lockdep_recursion++;
134 EXPORT_SYMBOL(lockdep_off);
136 void lockdep_on(void)
138 current->lockdep_recursion--;
141 EXPORT_SYMBOL(lockdep_on);
144 * Debugging switches:
147 #define VERBOSE 0
148 #ifdef VERBOSE
149 # define VERY_VERBOSE 0
150 #endif
152 #if VERBOSE
153 # define HARDIRQ_VERBOSE 1
154 # define SOFTIRQ_VERBOSE 1
155 #else
156 # define HARDIRQ_VERBOSE 0
157 # define SOFTIRQ_VERBOSE 0
158 #endif
160 #if VERBOSE || HARDIRQ_VERBOSE || SOFTIRQ_VERBOSE
162 * Quick filtering for interesting events:
164 static int class_filter(struct lock_class *class)
166 #if 0
167 /* Example */
168 if (class->name_version == 1 &&
169 !strcmp(class->name, "lockname"))
170 return 1;
171 if (class->name_version == 1 &&
172 !strcmp(class->name, "&struct->lockfield"))
173 return 1;
174 #endif
175 /* Filter everything else. 1 would be to allow everything else */
176 return 0;
178 #endif
180 static int verbose(struct lock_class *class)
182 #if VERBOSE
183 return class_filter(class);
184 #endif
185 return 0;
188 #ifdef CONFIG_TRACE_IRQFLAGS
190 static int hardirq_verbose(struct lock_class *class)
192 #if HARDIRQ_VERBOSE
193 return class_filter(class);
194 #endif
195 return 0;
198 static int softirq_verbose(struct lock_class *class)
200 #if SOFTIRQ_VERBOSE
201 return class_filter(class);
202 #endif
203 return 0;
206 #endif
209 * Stack-trace: tightly packed array of stack backtrace
210 * addresses. Protected by the hash_lock.
212 unsigned long nr_stack_trace_entries;
213 static unsigned long stack_trace[MAX_STACK_TRACE_ENTRIES];
215 static int save_trace(struct stack_trace *trace)
217 trace->nr_entries = 0;
218 trace->max_entries = MAX_STACK_TRACE_ENTRIES - nr_stack_trace_entries;
219 trace->entries = stack_trace + nr_stack_trace_entries;
221 trace->skip = 3;
222 trace->all_contexts = 0;
224 save_stack_trace(trace, NULL);
226 trace->max_entries = trace->nr_entries;
228 nr_stack_trace_entries += trace->nr_entries;
229 if (DEBUG_LOCKS_WARN_ON(nr_stack_trace_entries > MAX_STACK_TRACE_ENTRIES)) {
230 __raw_spin_unlock(&hash_lock);
231 return 0;
234 if (nr_stack_trace_entries == MAX_STACK_TRACE_ENTRIES) {
235 __raw_spin_unlock(&hash_lock);
236 if (debug_locks_off()) {
237 printk("BUG: MAX_STACK_TRACE_ENTRIES too low!\n");
238 printk("turning off the locking correctness validator.\n");
239 dump_stack();
241 return 0;
244 return 1;
247 unsigned int nr_hardirq_chains;
248 unsigned int nr_softirq_chains;
249 unsigned int nr_process_chains;
250 unsigned int max_lockdep_depth;
251 unsigned int max_recursion_depth;
253 #ifdef CONFIG_DEBUG_LOCKDEP
255 * We cannot printk in early bootup code. Not even early_printk()
256 * might work. So we mark any initialization errors and printk
257 * about it later on, in lockdep_info().
259 static int lockdep_init_error;
262 * Various lockdep statistics:
264 atomic_t chain_lookup_hits;
265 atomic_t chain_lookup_misses;
266 atomic_t hardirqs_on_events;
267 atomic_t hardirqs_off_events;
268 atomic_t redundant_hardirqs_on;
269 atomic_t redundant_hardirqs_off;
270 atomic_t softirqs_on_events;
271 atomic_t softirqs_off_events;
272 atomic_t redundant_softirqs_on;
273 atomic_t redundant_softirqs_off;
274 atomic_t nr_unused_locks;
275 atomic_t nr_cyclic_checks;
276 atomic_t nr_cyclic_check_recursions;
277 atomic_t nr_find_usage_forwards_checks;
278 atomic_t nr_find_usage_forwards_recursions;
279 atomic_t nr_find_usage_backwards_checks;
280 atomic_t nr_find_usage_backwards_recursions;
281 # define debug_atomic_inc(ptr) atomic_inc(ptr)
282 # define debug_atomic_dec(ptr) atomic_dec(ptr)
283 # define debug_atomic_read(ptr) atomic_read(ptr)
284 #else
285 # define debug_atomic_inc(ptr) do { } while (0)
286 # define debug_atomic_dec(ptr) do { } while (0)
287 # define debug_atomic_read(ptr) 0
288 #endif
291 * Locking printouts:
294 static const char *usage_str[] =
296 [LOCK_USED] = "initial-use ",
297 [LOCK_USED_IN_HARDIRQ] = "in-hardirq-W",
298 [LOCK_USED_IN_SOFTIRQ] = "in-softirq-W",
299 [LOCK_ENABLED_SOFTIRQS] = "softirq-on-W",
300 [LOCK_ENABLED_HARDIRQS] = "hardirq-on-W",
301 [LOCK_USED_IN_HARDIRQ_READ] = "in-hardirq-R",
302 [LOCK_USED_IN_SOFTIRQ_READ] = "in-softirq-R",
303 [LOCK_ENABLED_SOFTIRQS_READ] = "softirq-on-R",
304 [LOCK_ENABLED_HARDIRQS_READ] = "hardirq-on-R",
307 const char * __get_key_name(struct lockdep_subclass_key *key, char *str)
309 unsigned long offs, size;
310 char *modname;
312 return kallsyms_lookup((unsigned long)key, &size, &offs, &modname, str);
315 void
316 get_usage_chars(struct lock_class *class, char *c1, char *c2, char *c3, char *c4)
318 *c1 = '.', *c2 = '.', *c3 = '.', *c4 = '.';
320 if (class->usage_mask & LOCKF_USED_IN_HARDIRQ)
321 *c1 = '+';
322 else
323 if (class->usage_mask & LOCKF_ENABLED_HARDIRQS)
324 *c1 = '-';
326 if (class->usage_mask & LOCKF_USED_IN_SOFTIRQ)
327 *c2 = '+';
328 else
329 if (class->usage_mask & LOCKF_ENABLED_SOFTIRQS)
330 *c2 = '-';
332 if (class->usage_mask & LOCKF_ENABLED_HARDIRQS_READ)
333 *c3 = '-';
334 if (class->usage_mask & LOCKF_USED_IN_HARDIRQ_READ) {
335 *c3 = '+';
336 if (class->usage_mask & LOCKF_ENABLED_HARDIRQS_READ)
337 *c3 = '?';
340 if (class->usage_mask & LOCKF_ENABLED_SOFTIRQS_READ)
341 *c4 = '-';
342 if (class->usage_mask & LOCKF_USED_IN_SOFTIRQ_READ) {
343 *c4 = '+';
344 if (class->usage_mask & LOCKF_ENABLED_SOFTIRQS_READ)
345 *c4 = '?';
349 static void print_lock_name(struct lock_class *class)
351 char str[KSYM_NAME_LEN + 1], c1, c2, c3, c4;
352 const char *name;
354 get_usage_chars(class, &c1, &c2, &c3, &c4);
356 name = class->name;
357 if (!name) {
358 name = __get_key_name(class->key, str);
359 printk(" (%s", name);
360 } else {
361 printk(" (%s", name);
362 if (class->name_version > 1)
363 printk("#%d", class->name_version);
364 if (class->subclass)
365 printk("/%d", class->subclass);
367 printk("){%c%c%c%c}", c1, c2, c3, c4);
370 static void print_lockdep_cache(struct lockdep_map *lock)
372 const char *name;
373 char str[KSYM_NAME_LEN + 1];
375 name = lock->name;
376 if (!name)
377 name = __get_key_name(lock->key->subkeys, str);
379 printk("%s", name);
382 static void print_lock(struct held_lock *hlock)
384 print_lock_name(hlock->class);
385 printk(", at: ");
386 print_ip_sym(hlock->acquire_ip);
389 static void lockdep_print_held_locks(struct task_struct *curr)
391 int i, depth = curr->lockdep_depth;
393 if (!depth) {
394 printk("no locks held by %s/%d.\n", curr->comm, curr->pid);
395 return;
397 printk("%d lock%s held by %s/%d:\n",
398 depth, depth > 1 ? "s" : "", curr->comm, curr->pid);
400 for (i = 0; i < depth; i++) {
401 printk(" #%d: ", i);
402 print_lock(curr->held_locks + i);
406 static void print_lock_class_header(struct lock_class *class, int depth)
408 int bit;
410 printk("%*s->", depth, "");
411 print_lock_name(class);
412 printk(" ops: %lu", class->ops);
413 printk(" {\n");
415 for (bit = 0; bit < LOCK_USAGE_STATES; bit++) {
416 if (class->usage_mask & (1 << bit)) {
417 int len = depth;
419 len += printk("%*s %s", depth, "", usage_str[bit]);
420 len += printk(" at:\n");
421 print_stack_trace(class->usage_traces + bit, len);
424 printk("%*s }\n", depth, "");
426 printk("%*s ... key at: ",depth,"");
427 print_ip_sym((unsigned long)class->key);
431 * printk all lock dependencies starting at <entry>:
433 static void print_lock_dependencies(struct lock_class *class, int depth)
435 struct lock_list *entry;
437 if (DEBUG_LOCKS_WARN_ON(depth >= 20))
438 return;
440 print_lock_class_header(class, depth);
442 list_for_each_entry(entry, &class->locks_after, entry) {
443 if (DEBUG_LOCKS_WARN_ON(!entry->class))
444 return;
446 print_lock_dependencies(entry->class, depth + 1);
448 printk("%*s ... acquired at:\n",depth,"");
449 print_stack_trace(&entry->trace, 2);
450 printk("\n");
455 * Add a new dependency to the head of the list:
457 static int add_lock_to_list(struct lock_class *class, struct lock_class *this,
458 struct list_head *head, unsigned long ip)
460 struct lock_list *entry;
462 * Lock not present yet - get a new dependency struct and
463 * add it to the list:
465 entry = alloc_list_entry();
466 if (!entry)
467 return 0;
469 entry->class = this;
470 if (!save_trace(&entry->trace))
471 return 0;
474 * Since we never remove from the dependency list, the list can
475 * be walked lockless by other CPUs, it's only allocation
476 * that must be protected by the spinlock. But this also means
477 * we must make new entries visible only once writes to the
478 * entry become visible - hence the RCU op:
480 list_add_tail_rcu(&entry->entry, head);
482 return 1;
486 * Recursive, forwards-direction lock-dependency checking, used for
487 * both noncyclic checking and for hardirq-unsafe/softirq-unsafe
488 * checking.
490 * (to keep the stackframe of the recursive functions small we
491 * use these global variables, and we also mark various helper
492 * functions as noinline.)
494 static struct held_lock *check_source, *check_target;
497 * Print a dependency chain entry (this is only done when a deadlock
498 * has been detected):
500 static noinline int
501 print_circular_bug_entry(struct lock_list *target, unsigned int depth)
503 if (debug_locks_silent)
504 return 0;
505 printk("\n-> #%u", depth);
506 print_lock_name(target->class);
507 printk(":\n");
508 print_stack_trace(&target->trace, 6);
510 return 0;
513 static void print_kernel_version(void)
515 printk("%s %.*s\n", init_utsname()->release,
516 (int)strcspn(init_utsname()->version, " "),
517 init_utsname()->version);
521 * When a circular dependency is detected, print the
522 * header first:
524 static noinline int
525 print_circular_bug_header(struct lock_list *entry, unsigned int depth)
527 struct task_struct *curr = current;
529 __raw_spin_unlock(&hash_lock);
530 debug_locks_off();
531 if (debug_locks_silent)
532 return 0;
534 printk("\n=======================================================\n");
535 printk( "[ INFO: possible circular locking dependency detected ]\n");
536 print_kernel_version();
537 printk( "-------------------------------------------------------\n");
538 printk("%s/%d is trying to acquire lock:\n",
539 curr->comm, curr->pid);
540 print_lock(check_source);
541 printk("\nbut task is already holding lock:\n");
542 print_lock(check_target);
543 printk("\nwhich lock already depends on the new lock.\n\n");
544 printk("\nthe existing dependency chain (in reverse order) is:\n");
546 print_circular_bug_entry(entry, depth);
548 return 0;
551 static noinline int print_circular_bug_tail(void)
553 struct task_struct *curr = current;
554 struct lock_list this;
556 if (debug_locks_silent)
557 return 0;
559 /* hash_lock unlocked by the header */
560 __raw_spin_lock(&hash_lock);
561 this.class = check_source->class;
562 if (!save_trace(&this.trace))
563 return 0;
564 __raw_spin_unlock(&hash_lock);
565 print_circular_bug_entry(&this, 0);
567 printk("\nother info that might help us debug this:\n\n");
568 lockdep_print_held_locks(curr);
570 printk("\nstack backtrace:\n");
571 dump_stack();
573 return 0;
576 #define RECURSION_LIMIT 40
578 static int noinline print_infinite_recursion_bug(void)
580 __raw_spin_unlock(&hash_lock);
581 DEBUG_LOCKS_WARN_ON(1);
583 return 0;
587 * Prove that the dependency graph starting at <entry> can not
588 * lead to <target>. Print an error and return 0 if it does.
590 static noinline int
591 check_noncircular(struct lock_class *source, unsigned int depth)
593 struct lock_list *entry;
595 debug_atomic_inc(&nr_cyclic_check_recursions);
596 if (depth > max_recursion_depth)
597 max_recursion_depth = depth;
598 if (depth >= RECURSION_LIMIT)
599 return print_infinite_recursion_bug();
601 * Check this lock's dependency list:
603 list_for_each_entry(entry, &source->locks_after, entry) {
604 if (entry->class == check_target->class)
605 return print_circular_bug_header(entry, depth+1);
606 debug_atomic_inc(&nr_cyclic_checks);
607 if (!check_noncircular(entry->class, depth+1))
608 return print_circular_bug_entry(entry, depth+1);
610 return 1;
613 static int very_verbose(struct lock_class *class)
615 #if VERY_VERBOSE
616 return class_filter(class);
617 #endif
618 return 0;
620 #ifdef CONFIG_TRACE_IRQFLAGS
623 * Forwards and backwards subgraph searching, for the purposes of
624 * proving that two subgraphs can be connected by a new dependency
625 * without creating any illegal irq-safe -> irq-unsafe lock dependency.
627 static enum lock_usage_bit find_usage_bit;
628 static struct lock_class *forwards_match, *backwards_match;
631 * Find a node in the forwards-direction dependency sub-graph starting
632 * at <source> that matches <find_usage_bit>.
634 * Return 2 if such a node exists in the subgraph, and put that node
635 * into <forwards_match>.
637 * Return 1 otherwise and keep <forwards_match> unchanged.
638 * Return 0 on error.
640 static noinline int
641 find_usage_forwards(struct lock_class *source, unsigned int depth)
643 struct lock_list *entry;
644 int ret;
646 if (depth > max_recursion_depth)
647 max_recursion_depth = depth;
648 if (depth >= RECURSION_LIMIT)
649 return print_infinite_recursion_bug();
651 debug_atomic_inc(&nr_find_usage_forwards_checks);
652 if (source->usage_mask & (1 << find_usage_bit)) {
653 forwards_match = source;
654 return 2;
658 * Check this lock's dependency list:
660 list_for_each_entry(entry, &source->locks_after, entry) {
661 debug_atomic_inc(&nr_find_usage_forwards_recursions);
662 ret = find_usage_forwards(entry->class, depth+1);
663 if (ret == 2 || ret == 0)
664 return ret;
666 return 1;
670 * Find a node in the backwards-direction dependency sub-graph starting
671 * at <source> that matches <find_usage_bit>.
673 * Return 2 if such a node exists in the subgraph, and put that node
674 * into <backwards_match>.
676 * Return 1 otherwise and keep <backwards_match> unchanged.
677 * Return 0 on error.
679 static noinline int
680 find_usage_backwards(struct lock_class *source, unsigned int depth)
682 struct lock_list *entry;
683 int ret;
685 if (depth > max_recursion_depth)
686 max_recursion_depth = depth;
687 if (depth >= RECURSION_LIMIT)
688 return print_infinite_recursion_bug();
690 debug_atomic_inc(&nr_find_usage_backwards_checks);
691 if (source->usage_mask & (1 << find_usage_bit)) {
692 backwards_match = source;
693 return 2;
697 * Check this lock's dependency list:
699 list_for_each_entry(entry, &source->locks_before, entry) {
700 debug_atomic_inc(&nr_find_usage_backwards_recursions);
701 ret = find_usage_backwards(entry->class, depth+1);
702 if (ret == 2 || ret == 0)
703 return ret;
705 return 1;
708 static int
709 print_bad_irq_dependency(struct task_struct *curr,
710 struct held_lock *prev,
711 struct held_lock *next,
712 enum lock_usage_bit bit1,
713 enum lock_usage_bit bit2,
714 const char *irqclass)
716 __raw_spin_unlock(&hash_lock);
717 debug_locks_off();
718 if (debug_locks_silent)
719 return 0;
721 printk("\n======================================================\n");
722 printk( "[ INFO: %s-safe -> %s-unsafe lock order detected ]\n",
723 irqclass, irqclass);
724 print_kernel_version();
725 printk( "------------------------------------------------------\n");
726 printk("%s/%d [HC%u[%lu]:SC%u[%lu]:HE%u:SE%u] is trying to acquire:\n",
727 curr->comm, curr->pid,
728 curr->hardirq_context, hardirq_count() >> HARDIRQ_SHIFT,
729 curr->softirq_context, softirq_count() >> SOFTIRQ_SHIFT,
730 curr->hardirqs_enabled,
731 curr->softirqs_enabled);
732 print_lock(next);
734 printk("\nand this task is already holding:\n");
735 print_lock(prev);
736 printk("which would create a new lock dependency:\n");
737 print_lock_name(prev->class);
738 printk(" ->");
739 print_lock_name(next->class);
740 printk("\n");
742 printk("\nbut this new dependency connects a %s-irq-safe lock:\n",
743 irqclass);
744 print_lock_name(backwards_match);
745 printk("\n... which became %s-irq-safe at:\n", irqclass);
747 print_stack_trace(backwards_match->usage_traces + bit1, 1);
749 printk("\nto a %s-irq-unsafe lock:\n", irqclass);
750 print_lock_name(forwards_match);
751 printk("\n... which became %s-irq-unsafe at:\n", irqclass);
752 printk("...");
754 print_stack_trace(forwards_match->usage_traces + bit2, 1);
756 printk("\nother info that might help us debug this:\n\n");
757 lockdep_print_held_locks(curr);
759 printk("\nthe %s-irq-safe lock's dependencies:\n", irqclass);
760 print_lock_dependencies(backwards_match, 0);
762 printk("\nthe %s-irq-unsafe lock's dependencies:\n", irqclass);
763 print_lock_dependencies(forwards_match, 0);
765 printk("\nstack backtrace:\n");
766 dump_stack();
768 return 0;
771 static int
772 check_usage(struct task_struct *curr, struct held_lock *prev,
773 struct held_lock *next, enum lock_usage_bit bit_backwards,
774 enum lock_usage_bit bit_forwards, const char *irqclass)
776 int ret;
778 find_usage_bit = bit_backwards;
779 /* fills in <backwards_match> */
780 ret = find_usage_backwards(prev->class, 0);
781 if (!ret || ret == 1)
782 return ret;
784 find_usage_bit = bit_forwards;
785 ret = find_usage_forwards(next->class, 0);
786 if (!ret || ret == 1)
787 return ret;
788 /* ret == 2 */
789 return print_bad_irq_dependency(curr, prev, next,
790 bit_backwards, bit_forwards, irqclass);
793 #endif
795 static int
796 print_deadlock_bug(struct task_struct *curr, struct held_lock *prev,
797 struct held_lock *next)
799 debug_locks_off();
800 __raw_spin_unlock(&hash_lock);
801 if (debug_locks_silent)
802 return 0;
804 printk("\n=============================================\n");
805 printk( "[ INFO: possible recursive locking detected ]\n");
806 print_kernel_version();
807 printk( "---------------------------------------------\n");
808 printk("%s/%d is trying to acquire lock:\n",
809 curr->comm, curr->pid);
810 print_lock(next);
811 printk("\nbut task is already holding lock:\n");
812 print_lock(prev);
814 printk("\nother info that might help us debug this:\n");
815 lockdep_print_held_locks(curr);
817 printk("\nstack backtrace:\n");
818 dump_stack();
820 return 0;
824 * Check whether we are holding such a class already.
826 * (Note that this has to be done separately, because the graph cannot
827 * detect such classes of deadlocks.)
829 * Returns: 0 on deadlock detected, 1 on OK, 2 on recursive read
831 static int
832 check_deadlock(struct task_struct *curr, struct held_lock *next,
833 struct lockdep_map *next_instance, int read)
835 struct held_lock *prev;
836 int i;
838 for (i = 0; i < curr->lockdep_depth; i++) {
839 prev = curr->held_locks + i;
840 if (prev->class != next->class)
841 continue;
843 * Allow read-after-read recursion of the same
844 * lock class (i.e. read_lock(lock)+read_lock(lock)):
846 if ((read == 2) && prev->read)
847 return 2;
848 return print_deadlock_bug(curr, prev, next);
850 return 1;
854 * There was a chain-cache miss, and we are about to add a new dependency
855 * to a previous lock. We recursively validate the following rules:
857 * - would the adding of the <prev> -> <next> dependency create a
858 * circular dependency in the graph? [== circular deadlock]
860 * - does the new prev->next dependency connect any hardirq-safe lock
861 * (in the full backwards-subgraph starting at <prev>) with any
862 * hardirq-unsafe lock (in the full forwards-subgraph starting at
863 * <next>)? [== illegal lock inversion with hardirq contexts]
865 * - does the new prev->next dependency connect any softirq-safe lock
866 * (in the full backwards-subgraph starting at <prev>) with any
867 * softirq-unsafe lock (in the full forwards-subgraph starting at
868 * <next>)? [== illegal lock inversion with softirq contexts]
870 * any of these scenarios could lead to a deadlock.
872 * Then if all the validations pass, we add the forwards and backwards
873 * dependency.
875 static int
876 check_prev_add(struct task_struct *curr, struct held_lock *prev,
877 struct held_lock *next)
879 struct lock_list *entry;
880 int ret;
883 * Prove that the new <prev> -> <next> dependency would not
884 * create a circular dependency in the graph. (We do this by
885 * forward-recursing into the graph starting at <next>, and
886 * checking whether we can reach <prev>.)
888 * We are using global variables to control the recursion, to
889 * keep the stackframe size of the recursive functions low:
891 check_source = next;
892 check_target = prev;
893 if (!(check_noncircular(next->class, 0)))
894 return print_circular_bug_tail();
896 #ifdef CONFIG_TRACE_IRQFLAGS
898 * Prove that the new dependency does not connect a hardirq-safe
899 * lock with a hardirq-unsafe lock - to achieve this we search
900 * the backwards-subgraph starting at <prev>, and the
901 * forwards-subgraph starting at <next>:
903 if (!check_usage(curr, prev, next, LOCK_USED_IN_HARDIRQ,
904 LOCK_ENABLED_HARDIRQS, "hard"))
905 return 0;
908 * Prove that the new dependency does not connect a hardirq-safe-read
909 * lock with a hardirq-unsafe lock - to achieve this we search
910 * the backwards-subgraph starting at <prev>, and the
911 * forwards-subgraph starting at <next>:
913 if (!check_usage(curr, prev, next, LOCK_USED_IN_HARDIRQ_READ,
914 LOCK_ENABLED_HARDIRQS, "hard-read"))
915 return 0;
918 * Prove that the new dependency does not connect a softirq-safe
919 * lock with a softirq-unsafe lock - to achieve this we search
920 * the backwards-subgraph starting at <prev>, and the
921 * forwards-subgraph starting at <next>:
923 if (!check_usage(curr, prev, next, LOCK_USED_IN_SOFTIRQ,
924 LOCK_ENABLED_SOFTIRQS, "soft"))
925 return 0;
927 * Prove that the new dependency does not connect a softirq-safe-read
928 * lock with a softirq-unsafe lock - to achieve this we search
929 * the backwards-subgraph starting at <prev>, and the
930 * forwards-subgraph starting at <next>:
932 if (!check_usage(curr, prev, next, LOCK_USED_IN_SOFTIRQ_READ,
933 LOCK_ENABLED_SOFTIRQS, "soft"))
934 return 0;
935 #endif
937 * For recursive read-locks we do all the dependency checks,
938 * but we dont store read-triggered dependencies (only
939 * write-triggered dependencies). This ensures that only the
940 * write-side dependencies matter, and that if for example a
941 * write-lock never takes any other locks, then the reads are
942 * equivalent to a NOP.
944 if (next->read == 2 || prev->read == 2)
945 return 1;
947 * Is the <prev> -> <next> dependency already present?
949 * (this may occur even though this is a new chain: consider
950 * e.g. the L1 -> L2 -> L3 -> L4 and the L5 -> L1 -> L2 -> L3
951 * chains - the second one will be new, but L1 already has
952 * L2 added to its dependency list, due to the first chain.)
954 list_for_each_entry(entry, &prev->class->locks_after, entry) {
955 if (entry->class == next->class)
956 return 2;
960 * Ok, all validations passed, add the new lock
961 * to the previous lock's dependency list:
963 ret = add_lock_to_list(prev->class, next->class,
964 &prev->class->locks_after, next->acquire_ip);
965 if (!ret)
966 return 0;
968 ret = add_lock_to_list(next->class, prev->class,
969 &next->class->locks_before, next->acquire_ip);
970 if (!ret)
971 return 0;
974 * Debugging printouts:
976 if (verbose(prev->class) || verbose(next->class)) {
977 __raw_spin_unlock(&hash_lock);
978 printk("\n new dependency: ");
979 print_lock_name(prev->class);
980 printk(" => ");
981 print_lock_name(next->class);
982 printk("\n");
983 dump_stack();
984 __raw_spin_lock(&hash_lock);
986 return 1;
990 * Add the dependency to all directly-previous locks that are 'relevant'.
991 * The ones that are relevant are (in increasing distance from curr):
992 * all consecutive trylock entries and the final non-trylock entry - or
993 * the end of this context's lock-chain - whichever comes first.
995 static int
996 check_prevs_add(struct task_struct *curr, struct held_lock *next)
998 int depth = curr->lockdep_depth;
999 struct held_lock *hlock;
1002 * Debugging checks.
1004 * Depth must not be zero for a non-head lock:
1006 if (!depth)
1007 goto out_bug;
1009 * At least two relevant locks must exist for this
1010 * to be a head:
1012 if (curr->held_locks[depth].irq_context !=
1013 curr->held_locks[depth-1].irq_context)
1014 goto out_bug;
1016 for (;;) {
1017 hlock = curr->held_locks + depth-1;
1019 * Only non-recursive-read entries get new dependencies
1020 * added:
1022 if (hlock->read != 2) {
1023 if (!check_prev_add(curr, hlock, next))
1024 return 0;
1026 * Stop after the first non-trylock entry,
1027 * as non-trylock entries have added their
1028 * own direct dependencies already, so this
1029 * lock is connected to them indirectly:
1031 if (!hlock->trylock)
1032 break;
1034 depth--;
1036 * End of lock-stack?
1038 if (!depth)
1039 break;
1041 * Stop the search if we cross into another context:
1043 if (curr->held_locks[depth].irq_context !=
1044 curr->held_locks[depth-1].irq_context)
1045 break;
1047 return 1;
1048 out_bug:
1049 __raw_spin_unlock(&hash_lock);
1050 DEBUG_LOCKS_WARN_ON(1);
1052 return 0;
1057 * Is this the address of a static object:
1059 static int static_obj(void *obj)
1061 unsigned long start = (unsigned long) &_stext,
1062 end = (unsigned long) &_end,
1063 addr = (unsigned long) obj;
1064 #ifdef CONFIG_SMP
1065 int i;
1066 #endif
1069 * static variable?
1071 if ((addr >= start) && (addr < end))
1072 return 1;
1074 #ifdef CONFIG_SMP
1076 * percpu var?
1078 for_each_possible_cpu(i) {
1079 start = (unsigned long) &__per_cpu_start + per_cpu_offset(i);
1080 end = (unsigned long) &__per_cpu_start + PERCPU_ENOUGH_ROOM
1081 + per_cpu_offset(i);
1083 if ((addr >= start) && (addr < end))
1084 return 1;
1086 #endif
1089 * module var?
1091 return is_module_address(addr);
1095 * To make lock name printouts unique, we calculate a unique
1096 * class->name_version generation counter:
1098 static int count_matching_names(struct lock_class *new_class)
1100 struct lock_class *class;
1101 int count = 0;
1103 if (!new_class->name)
1104 return 0;
1106 list_for_each_entry(class, &all_lock_classes, lock_entry) {
1107 if (new_class->key - new_class->subclass == class->key)
1108 return class->name_version;
1109 if (class->name && !strcmp(class->name, new_class->name))
1110 count = max(count, class->name_version);
1113 return count + 1;
1117 * Register a lock's class in the hash-table, if the class is not present
1118 * yet. Otherwise we look it up. We cache the result in the lock object
1119 * itself, so actual lookup of the hash should be once per lock object.
1121 static inline struct lock_class *
1122 look_up_lock_class(struct lockdep_map *lock, unsigned int subclass)
1124 struct lockdep_subclass_key *key;
1125 struct list_head *hash_head;
1126 struct lock_class *class;
1128 #ifdef CONFIG_DEBUG_LOCKDEP
1130 * If the architecture calls into lockdep before initializing
1131 * the hashes then we'll warn about it later. (we cannot printk
1132 * right now)
1134 if (unlikely(!lockdep_initialized)) {
1135 lockdep_init();
1136 lockdep_init_error = 1;
1138 #endif
1141 * Static locks do not have their class-keys yet - for them the key
1142 * is the lock object itself:
1144 if (unlikely(!lock->key))
1145 lock->key = (void *)lock;
1148 * NOTE: the class-key must be unique. For dynamic locks, a static
1149 * lock_class_key variable is passed in through the mutex_init()
1150 * (or spin_lock_init()) call - which acts as the key. For static
1151 * locks we use the lock object itself as the key.
1153 BUILD_BUG_ON(sizeof(struct lock_class_key) > sizeof(struct lock_class));
1155 key = lock->key->subkeys + subclass;
1157 hash_head = classhashentry(key);
1160 * We can walk the hash lockfree, because the hash only
1161 * grows, and we are careful when adding entries to the end:
1163 list_for_each_entry(class, hash_head, hash_entry)
1164 if (class->key == key)
1165 return class;
1167 return NULL;
1171 * Register a lock's class in the hash-table, if the class is not present
1172 * yet. Otherwise we look it up. We cache the result in the lock object
1173 * itself, so actual lookup of the hash should be once per lock object.
1175 static inline struct lock_class *
1176 register_lock_class(struct lockdep_map *lock, unsigned int subclass, int force)
1178 struct lockdep_subclass_key *key;
1179 struct list_head *hash_head;
1180 struct lock_class *class;
1181 unsigned long flags;
1183 class = look_up_lock_class(lock, subclass);
1184 if (likely(class))
1185 return class;
1188 * Debug-check: all keys must be persistent!
1190 if (!static_obj(lock->key)) {
1191 debug_locks_off();
1192 printk("INFO: trying to register non-static key.\n");
1193 printk("the code is fine but needs lockdep annotation.\n");
1194 printk("turning off the locking correctness validator.\n");
1195 dump_stack();
1197 return NULL;
1200 key = lock->key->subkeys + subclass;
1201 hash_head = classhashentry(key);
1203 raw_local_irq_save(flags);
1204 __raw_spin_lock(&hash_lock);
1206 * We have to do the hash-walk again, to avoid races
1207 * with another CPU:
1209 list_for_each_entry(class, hash_head, hash_entry)
1210 if (class->key == key)
1211 goto out_unlock_set;
1213 * Allocate a new key from the static array, and add it to
1214 * the hash:
1216 if (nr_lock_classes >= MAX_LOCKDEP_KEYS) {
1217 __raw_spin_unlock(&hash_lock);
1218 raw_local_irq_restore(flags);
1219 debug_locks_off();
1220 printk("BUG: MAX_LOCKDEP_KEYS too low!\n");
1221 printk("turning off the locking correctness validator.\n");
1222 return NULL;
1224 class = lock_classes + nr_lock_classes++;
1225 debug_atomic_inc(&nr_unused_locks);
1226 class->key = key;
1227 class->name = lock->name;
1228 class->subclass = subclass;
1229 INIT_LIST_HEAD(&class->lock_entry);
1230 INIT_LIST_HEAD(&class->locks_before);
1231 INIT_LIST_HEAD(&class->locks_after);
1232 class->name_version = count_matching_names(class);
1234 * We use RCU's safe list-add method to make
1235 * parallel walking of the hash-list safe:
1237 list_add_tail_rcu(&class->hash_entry, hash_head);
1239 if (verbose(class)) {
1240 __raw_spin_unlock(&hash_lock);
1241 raw_local_irq_restore(flags);
1242 printk("\nnew class %p: %s", class->key, class->name);
1243 if (class->name_version > 1)
1244 printk("#%d", class->name_version);
1245 printk("\n");
1246 dump_stack();
1247 raw_local_irq_save(flags);
1248 __raw_spin_lock(&hash_lock);
1250 out_unlock_set:
1251 __raw_spin_unlock(&hash_lock);
1252 raw_local_irq_restore(flags);
1254 if (!subclass || force)
1255 lock->class_cache = class;
1257 DEBUG_LOCKS_WARN_ON(class->subclass != subclass);
1259 return class;
1263 * Look up a dependency chain. If the key is not present yet then
1264 * add it and return 0 - in this case the new dependency chain is
1265 * validated. If the key is already hashed, return 1.
1267 static inline int lookup_chain_cache(u64 chain_key, struct lock_class *class)
1269 struct list_head *hash_head = chainhashentry(chain_key);
1270 struct lock_chain *chain;
1272 DEBUG_LOCKS_WARN_ON(!irqs_disabled());
1274 * We can walk it lock-free, because entries only get added
1275 * to the hash:
1277 list_for_each_entry(chain, hash_head, entry) {
1278 if (chain->chain_key == chain_key) {
1279 cache_hit:
1280 debug_atomic_inc(&chain_lookup_hits);
1282 * In the debugging case, force redundant checking
1283 * by returning 1:
1285 #ifdef CONFIG_DEBUG_LOCKDEP
1286 __raw_spin_lock(&hash_lock);
1287 return 1;
1288 #endif
1289 if (very_verbose(class))
1290 printk("\nhash chain already cached, key: %016Lx tail class: [%p] %s\n", chain_key, class->key, class->name);
1291 return 0;
1294 if (very_verbose(class))
1295 printk("\nnew hash chain, key: %016Lx tail class: [%p] %s\n", chain_key, class->key, class->name);
1297 * Allocate a new chain entry from the static array, and add
1298 * it to the hash:
1300 __raw_spin_lock(&hash_lock);
1302 * We have to walk the chain again locked - to avoid duplicates:
1304 list_for_each_entry(chain, hash_head, entry) {
1305 if (chain->chain_key == chain_key) {
1306 __raw_spin_unlock(&hash_lock);
1307 goto cache_hit;
1310 if (unlikely(nr_lock_chains >= MAX_LOCKDEP_CHAINS)) {
1311 __raw_spin_unlock(&hash_lock);
1312 debug_locks_off();
1313 printk("BUG: MAX_LOCKDEP_CHAINS too low!\n");
1314 printk("turning off the locking correctness validator.\n");
1315 return 0;
1317 chain = lock_chains + nr_lock_chains++;
1318 chain->chain_key = chain_key;
1319 list_add_tail_rcu(&chain->entry, hash_head);
1320 debug_atomic_inc(&chain_lookup_misses);
1321 #ifdef CONFIG_TRACE_IRQFLAGS
1322 if (current->hardirq_context)
1323 nr_hardirq_chains++;
1324 else {
1325 if (current->softirq_context)
1326 nr_softirq_chains++;
1327 else
1328 nr_process_chains++;
1330 #else
1331 nr_process_chains++;
1332 #endif
1334 return 1;
1338 * We are building curr_chain_key incrementally, so double-check
1339 * it from scratch, to make sure that it's done correctly:
1341 static void check_chain_key(struct task_struct *curr)
1343 #ifdef CONFIG_DEBUG_LOCKDEP
1344 struct held_lock *hlock, *prev_hlock = NULL;
1345 unsigned int i, id;
1346 u64 chain_key = 0;
1348 for (i = 0; i < curr->lockdep_depth; i++) {
1349 hlock = curr->held_locks + i;
1350 if (chain_key != hlock->prev_chain_key) {
1351 debug_locks_off();
1352 printk("hm#1, depth: %u [%u], %016Lx != %016Lx\n",
1353 curr->lockdep_depth, i,
1354 (unsigned long long)chain_key,
1355 (unsigned long long)hlock->prev_chain_key);
1356 WARN_ON(1);
1357 return;
1359 id = hlock->class - lock_classes;
1360 DEBUG_LOCKS_WARN_ON(id >= MAX_LOCKDEP_KEYS);
1361 if (prev_hlock && (prev_hlock->irq_context !=
1362 hlock->irq_context))
1363 chain_key = 0;
1364 chain_key = iterate_chain_key(chain_key, id);
1365 prev_hlock = hlock;
1367 if (chain_key != curr->curr_chain_key) {
1368 debug_locks_off();
1369 printk("hm#2, depth: %u [%u], %016Lx != %016Lx\n",
1370 curr->lockdep_depth, i,
1371 (unsigned long long)chain_key,
1372 (unsigned long long)curr->curr_chain_key);
1373 WARN_ON(1);
1375 #endif
1378 #ifdef CONFIG_TRACE_IRQFLAGS
1381 * print irq inversion bug:
1383 static int
1384 print_irq_inversion_bug(struct task_struct *curr, struct lock_class *other,
1385 struct held_lock *this, int forwards,
1386 const char *irqclass)
1388 __raw_spin_unlock(&hash_lock);
1389 debug_locks_off();
1390 if (debug_locks_silent)
1391 return 0;
1393 printk("\n=========================================================\n");
1394 printk( "[ INFO: possible irq lock inversion dependency detected ]\n");
1395 print_kernel_version();
1396 printk( "---------------------------------------------------------\n");
1397 printk("%s/%d just changed the state of lock:\n",
1398 curr->comm, curr->pid);
1399 print_lock(this);
1400 if (forwards)
1401 printk("but this lock took another, %s-irq-unsafe lock in the past:\n", irqclass);
1402 else
1403 printk("but this lock was taken by another, %s-irq-safe lock in the past:\n", irqclass);
1404 print_lock_name(other);
1405 printk("\n\nand interrupts could create inverse lock ordering between them.\n\n");
1407 printk("\nother info that might help us debug this:\n");
1408 lockdep_print_held_locks(curr);
1410 printk("\nthe first lock's dependencies:\n");
1411 print_lock_dependencies(this->class, 0);
1413 printk("\nthe second lock's dependencies:\n");
1414 print_lock_dependencies(other, 0);
1416 printk("\nstack backtrace:\n");
1417 dump_stack();
1419 return 0;
1423 * Prove that in the forwards-direction subgraph starting at <this>
1424 * there is no lock matching <mask>:
1426 static int
1427 check_usage_forwards(struct task_struct *curr, struct held_lock *this,
1428 enum lock_usage_bit bit, const char *irqclass)
1430 int ret;
1432 find_usage_bit = bit;
1433 /* fills in <forwards_match> */
1434 ret = find_usage_forwards(this->class, 0);
1435 if (!ret || ret == 1)
1436 return ret;
1438 return print_irq_inversion_bug(curr, forwards_match, this, 1, irqclass);
1442 * Prove that in the backwards-direction subgraph starting at <this>
1443 * there is no lock matching <mask>:
1445 static int
1446 check_usage_backwards(struct task_struct *curr, struct held_lock *this,
1447 enum lock_usage_bit bit, const char *irqclass)
1449 int ret;
1451 find_usage_bit = bit;
1452 /* fills in <backwards_match> */
1453 ret = find_usage_backwards(this->class, 0);
1454 if (!ret || ret == 1)
1455 return ret;
1457 return print_irq_inversion_bug(curr, backwards_match, this, 0, irqclass);
1460 static inline void print_irqtrace_events(struct task_struct *curr)
1462 printk("irq event stamp: %u\n", curr->irq_events);
1463 printk("hardirqs last enabled at (%u): ", curr->hardirq_enable_event);
1464 print_ip_sym(curr->hardirq_enable_ip);
1465 printk("hardirqs last disabled at (%u): ", curr->hardirq_disable_event);
1466 print_ip_sym(curr->hardirq_disable_ip);
1467 printk("softirqs last enabled at (%u): ", curr->softirq_enable_event);
1468 print_ip_sym(curr->softirq_enable_ip);
1469 printk("softirqs last disabled at (%u): ", curr->softirq_disable_event);
1470 print_ip_sym(curr->softirq_disable_ip);
1473 #else
1474 static inline void print_irqtrace_events(struct task_struct *curr)
1477 #endif
1479 static int
1480 print_usage_bug(struct task_struct *curr, struct held_lock *this,
1481 enum lock_usage_bit prev_bit, enum lock_usage_bit new_bit)
1483 __raw_spin_unlock(&hash_lock);
1484 debug_locks_off();
1485 if (debug_locks_silent)
1486 return 0;
1488 printk("\n=================================\n");
1489 printk( "[ INFO: inconsistent lock state ]\n");
1490 print_kernel_version();
1491 printk( "---------------------------------\n");
1493 printk("inconsistent {%s} -> {%s} usage.\n",
1494 usage_str[prev_bit], usage_str[new_bit]);
1496 printk("%s/%d [HC%u[%lu]:SC%u[%lu]:HE%u:SE%u] takes:\n",
1497 curr->comm, curr->pid,
1498 trace_hardirq_context(curr), hardirq_count() >> HARDIRQ_SHIFT,
1499 trace_softirq_context(curr), softirq_count() >> SOFTIRQ_SHIFT,
1500 trace_hardirqs_enabled(curr),
1501 trace_softirqs_enabled(curr));
1502 print_lock(this);
1504 printk("{%s} state was registered at:\n", usage_str[prev_bit]);
1505 print_stack_trace(this->class->usage_traces + prev_bit, 1);
1507 print_irqtrace_events(curr);
1508 printk("\nother info that might help us debug this:\n");
1509 lockdep_print_held_locks(curr);
1511 printk("\nstack backtrace:\n");
1512 dump_stack();
1514 return 0;
1518 * Print out an error if an invalid bit is set:
1520 static inline int
1521 valid_state(struct task_struct *curr, struct held_lock *this,
1522 enum lock_usage_bit new_bit, enum lock_usage_bit bad_bit)
1524 if (unlikely(this->class->usage_mask & (1 << bad_bit)))
1525 return print_usage_bug(curr, this, bad_bit, new_bit);
1526 return 1;
1529 #define STRICT_READ_CHECKS 1
1532 * Mark a lock with a usage bit, and validate the state transition:
1534 static int mark_lock(struct task_struct *curr, struct held_lock *this,
1535 enum lock_usage_bit new_bit, unsigned long ip)
1537 unsigned int new_mask = 1 << new_bit, ret = 1;
1540 * If already set then do not dirty the cacheline,
1541 * nor do any checks:
1543 if (likely(this->class->usage_mask & new_mask))
1544 return 1;
1546 __raw_spin_lock(&hash_lock);
1548 * Make sure we didnt race:
1550 if (unlikely(this->class->usage_mask & new_mask)) {
1551 __raw_spin_unlock(&hash_lock);
1552 return 1;
1555 this->class->usage_mask |= new_mask;
1557 #ifdef CONFIG_TRACE_IRQFLAGS
1558 if (new_bit == LOCK_ENABLED_HARDIRQS ||
1559 new_bit == LOCK_ENABLED_HARDIRQS_READ)
1560 ip = curr->hardirq_enable_ip;
1561 else if (new_bit == LOCK_ENABLED_SOFTIRQS ||
1562 new_bit == LOCK_ENABLED_SOFTIRQS_READ)
1563 ip = curr->softirq_enable_ip;
1564 #endif
1565 if (!save_trace(this->class->usage_traces + new_bit))
1566 return 0;
1568 switch (new_bit) {
1569 #ifdef CONFIG_TRACE_IRQFLAGS
1570 case LOCK_USED_IN_HARDIRQ:
1571 if (!valid_state(curr, this, new_bit, LOCK_ENABLED_HARDIRQS))
1572 return 0;
1573 if (!valid_state(curr, this, new_bit,
1574 LOCK_ENABLED_HARDIRQS_READ))
1575 return 0;
1577 * just marked it hardirq-safe, check that this lock
1578 * took no hardirq-unsafe lock in the past:
1580 if (!check_usage_forwards(curr, this,
1581 LOCK_ENABLED_HARDIRQS, "hard"))
1582 return 0;
1583 #if STRICT_READ_CHECKS
1585 * just marked it hardirq-safe, check that this lock
1586 * took no hardirq-unsafe-read lock in the past:
1588 if (!check_usage_forwards(curr, this,
1589 LOCK_ENABLED_HARDIRQS_READ, "hard-read"))
1590 return 0;
1591 #endif
1592 if (hardirq_verbose(this->class))
1593 ret = 2;
1594 break;
1595 case LOCK_USED_IN_SOFTIRQ:
1596 if (!valid_state(curr, this, new_bit, LOCK_ENABLED_SOFTIRQS))
1597 return 0;
1598 if (!valid_state(curr, this, new_bit,
1599 LOCK_ENABLED_SOFTIRQS_READ))
1600 return 0;
1602 * just marked it softirq-safe, check that this lock
1603 * took no softirq-unsafe lock in the past:
1605 if (!check_usage_forwards(curr, this,
1606 LOCK_ENABLED_SOFTIRQS, "soft"))
1607 return 0;
1608 #if STRICT_READ_CHECKS
1610 * just marked it softirq-safe, check that this lock
1611 * took no softirq-unsafe-read lock in the past:
1613 if (!check_usage_forwards(curr, this,
1614 LOCK_ENABLED_SOFTIRQS_READ, "soft-read"))
1615 return 0;
1616 #endif
1617 if (softirq_verbose(this->class))
1618 ret = 2;
1619 break;
1620 case LOCK_USED_IN_HARDIRQ_READ:
1621 if (!valid_state(curr, this, new_bit, LOCK_ENABLED_HARDIRQS))
1622 return 0;
1624 * just marked it hardirq-read-safe, check that this lock
1625 * took no hardirq-unsafe lock in the past:
1627 if (!check_usage_forwards(curr, this,
1628 LOCK_ENABLED_HARDIRQS, "hard"))
1629 return 0;
1630 if (hardirq_verbose(this->class))
1631 ret = 2;
1632 break;
1633 case LOCK_USED_IN_SOFTIRQ_READ:
1634 if (!valid_state(curr, this, new_bit, LOCK_ENABLED_SOFTIRQS))
1635 return 0;
1637 * just marked it softirq-read-safe, check that this lock
1638 * took no softirq-unsafe lock in the past:
1640 if (!check_usage_forwards(curr, this,
1641 LOCK_ENABLED_SOFTIRQS, "soft"))
1642 return 0;
1643 if (softirq_verbose(this->class))
1644 ret = 2;
1645 break;
1646 case LOCK_ENABLED_HARDIRQS:
1647 if (!valid_state(curr, this, new_bit, LOCK_USED_IN_HARDIRQ))
1648 return 0;
1649 if (!valid_state(curr, this, new_bit,
1650 LOCK_USED_IN_HARDIRQ_READ))
1651 return 0;
1653 * just marked it hardirq-unsafe, check that no hardirq-safe
1654 * lock in the system ever took it in the past:
1656 if (!check_usage_backwards(curr, this,
1657 LOCK_USED_IN_HARDIRQ, "hard"))
1658 return 0;
1659 #if STRICT_READ_CHECKS
1661 * just marked it hardirq-unsafe, check that no
1662 * hardirq-safe-read lock in the system ever took
1663 * it in the past:
1665 if (!check_usage_backwards(curr, this,
1666 LOCK_USED_IN_HARDIRQ_READ, "hard-read"))
1667 return 0;
1668 #endif
1669 if (hardirq_verbose(this->class))
1670 ret = 2;
1671 break;
1672 case LOCK_ENABLED_SOFTIRQS:
1673 if (!valid_state(curr, this, new_bit, LOCK_USED_IN_SOFTIRQ))
1674 return 0;
1675 if (!valid_state(curr, this, new_bit,
1676 LOCK_USED_IN_SOFTIRQ_READ))
1677 return 0;
1679 * just marked it softirq-unsafe, check that no softirq-safe
1680 * lock in the system ever took it in the past:
1682 if (!check_usage_backwards(curr, this,
1683 LOCK_USED_IN_SOFTIRQ, "soft"))
1684 return 0;
1685 #if STRICT_READ_CHECKS
1687 * just marked it softirq-unsafe, check that no
1688 * softirq-safe-read lock in the system ever took
1689 * it in the past:
1691 if (!check_usage_backwards(curr, this,
1692 LOCK_USED_IN_SOFTIRQ_READ, "soft-read"))
1693 return 0;
1694 #endif
1695 if (softirq_verbose(this->class))
1696 ret = 2;
1697 break;
1698 case LOCK_ENABLED_HARDIRQS_READ:
1699 if (!valid_state(curr, this, new_bit, LOCK_USED_IN_HARDIRQ))
1700 return 0;
1701 #if STRICT_READ_CHECKS
1703 * just marked it hardirq-read-unsafe, check that no
1704 * hardirq-safe lock in the system ever took it in the past:
1706 if (!check_usage_backwards(curr, this,
1707 LOCK_USED_IN_HARDIRQ, "hard"))
1708 return 0;
1709 #endif
1710 if (hardirq_verbose(this->class))
1711 ret = 2;
1712 break;
1713 case LOCK_ENABLED_SOFTIRQS_READ:
1714 if (!valid_state(curr, this, new_bit, LOCK_USED_IN_SOFTIRQ))
1715 return 0;
1716 #if STRICT_READ_CHECKS
1718 * just marked it softirq-read-unsafe, check that no
1719 * softirq-safe lock in the system ever took it in the past:
1721 if (!check_usage_backwards(curr, this,
1722 LOCK_USED_IN_SOFTIRQ, "soft"))
1723 return 0;
1724 #endif
1725 if (softirq_verbose(this->class))
1726 ret = 2;
1727 break;
1728 #endif
1729 case LOCK_USED:
1731 * Add it to the global list of classes:
1733 list_add_tail_rcu(&this->class->lock_entry, &all_lock_classes);
1734 debug_atomic_dec(&nr_unused_locks);
1735 break;
1736 default:
1737 __raw_spin_unlock(&hash_lock);
1738 debug_locks_off();
1739 WARN_ON(1);
1740 return 0;
1743 __raw_spin_unlock(&hash_lock);
1746 * We must printk outside of the hash_lock:
1748 if (ret == 2) {
1749 printk("\nmarked lock as {%s}:\n", usage_str[new_bit]);
1750 print_lock(this);
1751 print_irqtrace_events(curr);
1752 dump_stack();
1755 return ret;
1758 #ifdef CONFIG_TRACE_IRQFLAGS
1760 * Mark all held locks with a usage bit:
1762 static int
1763 mark_held_locks(struct task_struct *curr, int hardirq, unsigned long ip)
1765 enum lock_usage_bit usage_bit;
1766 struct held_lock *hlock;
1767 int i;
1769 for (i = 0; i < curr->lockdep_depth; i++) {
1770 hlock = curr->held_locks + i;
1772 if (hardirq) {
1773 if (hlock->read)
1774 usage_bit = LOCK_ENABLED_HARDIRQS_READ;
1775 else
1776 usage_bit = LOCK_ENABLED_HARDIRQS;
1777 } else {
1778 if (hlock->read)
1779 usage_bit = LOCK_ENABLED_SOFTIRQS_READ;
1780 else
1781 usage_bit = LOCK_ENABLED_SOFTIRQS;
1783 if (!mark_lock(curr, hlock, usage_bit, ip))
1784 return 0;
1787 return 1;
1791 * Debugging helper: via this flag we know that we are in
1792 * 'early bootup code', and will warn about any invalid irqs-on event:
1794 static int early_boot_irqs_enabled;
1796 void early_boot_irqs_off(void)
1798 early_boot_irqs_enabled = 0;
1801 void early_boot_irqs_on(void)
1803 early_boot_irqs_enabled = 1;
1807 * Hardirqs will be enabled:
1809 void trace_hardirqs_on(void)
1811 struct task_struct *curr = current;
1812 unsigned long ip;
1814 if (unlikely(!debug_locks || current->lockdep_recursion))
1815 return;
1817 if (DEBUG_LOCKS_WARN_ON(unlikely(!early_boot_irqs_enabled)))
1818 return;
1820 if (unlikely(curr->hardirqs_enabled)) {
1821 debug_atomic_inc(&redundant_hardirqs_on);
1822 return;
1824 /* we'll do an OFF -> ON transition: */
1825 curr->hardirqs_enabled = 1;
1826 ip = (unsigned long) __builtin_return_address(0);
1828 if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
1829 return;
1830 if (DEBUG_LOCKS_WARN_ON(current->hardirq_context))
1831 return;
1833 * We are going to turn hardirqs on, so set the
1834 * usage bit for all held locks:
1836 if (!mark_held_locks(curr, 1, ip))
1837 return;
1839 * If we have softirqs enabled, then set the usage
1840 * bit for all held locks. (disabled hardirqs prevented
1841 * this bit from being set before)
1843 if (curr->softirqs_enabled)
1844 if (!mark_held_locks(curr, 0, ip))
1845 return;
1847 curr->hardirq_enable_ip = ip;
1848 curr->hardirq_enable_event = ++curr->irq_events;
1849 debug_atomic_inc(&hardirqs_on_events);
1852 EXPORT_SYMBOL(trace_hardirqs_on);
1855 * Hardirqs were disabled:
1857 void trace_hardirqs_off(void)
1859 struct task_struct *curr = current;
1861 if (unlikely(!debug_locks || current->lockdep_recursion))
1862 return;
1864 if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
1865 return;
1867 if (curr->hardirqs_enabled) {
1869 * We have done an ON -> OFF transition:
1871 curr->hardirqs_enabled = 0;
1872 curr->hardirq_disable_ip = _RET_IP_;
1873 curr->hardirq_disable_event = ++curr->irq_events;
1874 debug_atomic_inc(&hardirqs_off_events);
1875 } else
1876 debug_atomic_inc(&redundant_hardirqs_off);
1879 EXPORT_SYMBOL(trace_hardirqs_off);
1882 * Softirqs will be enabled:
1884 void trace_softirqs_on(unsigned long ip)
1886 struct task_struct *curr = current;
1888 if (unlikely(!debug_locks))
1889 return;
1891 if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
1892 return;
1894 if (curr->softirqs_enabled) {
1895 debug_atomic_inc(&redundant_softirqs_on);
1896 return;
1900 * We'll do an OFF -> ON transition:
1902 curr->softirqs_enabled = 1;
1903 curr->softirq_enable_ip = ip;
1904 curr->softirq_enable_event = ++curr->irq_events;
1905 debug_atomic_inc(&softirqs_on_events);
1907 * We are going to turn softirqs on, so set the
1908 * usage bit for all held locks, if hardirqs are
1909 * enabled too:
1911 if (curr->hardirqs_enabled)
1912 mark_held_locks(curr, 0, ip);
1916 * Softirqs were disabled:
1918 void trace_softirqs_off(unsigned long ip)
1920 struct task_struct *curr = current;
1922 if (unlikely(!debug_locks))
1923 return;
1925 if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
1926 return;
1928 if (curr->softirqs_enabled) {
1930 * We have done an ON -> OFF transition:
1932 curr->softirqs_enabled = 0;
1933 curr->softirq_disable_ip = ip;
1934 curr->softirq_disable_event = ++curr->irq_events;
1935 debug_atomic_inc(&softirqs_off_events);
1936 DEBUG_LOCKS_WARN_ON(!softirq_count());
1937 } else
1938 debug_atomic_inc(&redundant_softirqs_off);
1941 #endif
1944 * Initialize a lock instance's lock-class mapping info:
1946 void lockdep_init_map(struct lockdep_map *lock, const char *name,
1947 struct lock_class_key *key, int subclass)
1949 if (unlikely(!debug_locks))
1950 return;
1952 if (DEBUG_LOCKS_WARN_ON(!key))
1953 return;
1954 if (DEBUG_LOCKS_WARN_ON(!name))
1955 return;
1957 * Sanity check, the lock-class key must be persistent:
1959 if (!static_obj(key)) {
1960 printk("BUG: key %p not in .data!\n", key);
1961 DEBUG_LOCKS_WARN_ON(1);
1962 return;
1964 lock->name = name;
1965 lock->key = key;
1966 lock->class_cache = NULL;
1967 if (subclass)
1968 register_lock_class(lock, subclass, 1);
1971 EXPORT_SYMBOL_GPL(lockdep_init_map);
1974 * This gets called for every mutex_lock*()/spin_lock*() operation.
1975 * We maintain the dependency maps and validate the locking attempt:
1977 static int __lock_acquire(struct lockdep_map *lock, unsigned int subclass,
1978 int trylock, int read, int check, int hardirqs_off,
1979 unsigned long ip)
1981 struct task_struct *curr = current;
1982 struct lock_class *class = NULL;
1983 struct held_lock *hlock;
1984 unsigned int depth, id;
1985 int chain_head = 0;
1986 u64 chain_key;
1988 if (unlikely(!debug_locks))
1989 return 0;
1991 if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
1992 return 0;
1994 if (unlikely(subclass >= MAX_LOCKDEP_SUBCLASSES)) {
1995 debug_locks_off();
1996 printk("BUG: MAX_LOCKDEP_SUBCLASSES too low!\n");
1997 printk("turning off the locking correctness validator.\n");
1998 return 0;
2001 if (!subclass)
2002 class = lock->class_cache;
2004 * Not cached yet or subclass?
2006 if (unlikely(!class)) {
2007 class = register_lock_class(lock, subclass, 0);
2008 if (!class)
2009 return 0;
2011 debug_atomic_inc((atomic_t *)&class->ops);
2012 if (very_verbose(class)) {
2013 printk("\nacquire class [%p] %s", class->key, class->name);
2014 if (class->name_version > 1)
2015 printk("#%d", class->name_version);
2016 printk("\n");
2017 dump_stack();
2021 * Add the lock to the list of currently held locks.
2022 * (we dont increase the depth just yet, up until the
2023 * dependency checks are done)
2025 depth = curr->lockdep_depth;
2026 if (DEBUG_LOCKS_WARN_ON(depth >= MAX_LOCK_DEPTH))
2027 return 0;
2029 hlock = curr->held_locks + depth;
2031 hlock->class = class;
2032 hlock->acquire_ip = ip;
2033 hlock->instance = lock;
2034 hlock->trylock = trylock;
2035 hlock->read = read;
2036 hlock->check = check;
2037 hlock->hardirqs_off = hardirqs_off;
2039 if (check != 2)
2040 goto out_calc_hash;
2041 #ifdef CONFIG_TRACE_IRQFLAGS
2043 * If non-trylock use in a hardirq or softirq context, then
2044 * mark the lock as used in these contexts:
2046 if (!trylock) {
2047 if (read) {
2048 if (curr->hardirq_context)
2049 if (!mark_lock(curr, hlock,
2050 LOCK_USED_IN_HARDIRQ_READ, ip))
2051 return 0;
2052 if (curr->softirq_context)
2053 if (!mark_lock(curr, hlock,
2054 LOCK_USED_IN_SOFTIRQ_READ, ip))
2055 return 0;
2056 } else {
2057 if (curr->hardirq_context)
2058 if (!mark_lock(curr, hlock, LOCK_USED_IN_HARDIRQ, ip))
2059 return 0;
2060 if (curr->softirq_context)
2061 if (!mark_lock(curr, hlock, LOCK_USED_IN_SOFTIRQ, ip))
2062 return 0;
2065 if (!hardirqs_off) {
2066 if (read) {
2067 if (!mark_lock(curr, hlock,
2068 LOCK_ENABLED_HARDIRQS_READ, ip))
2069 return 0;
2070 if (curr->softirqs_enabled)
2071 if (!mark_lock(curr, hlock,
2072 LOCK_ENABLED_SOFTIRQS_READ, ip))
2073 return 0;
2074 } else {
2075 if (!mark_lock(curr, hlock,
2076 LOCK_ENABLED_HARDIRQS, ip))
2077 return 0;
2078 if (curr->softirqs_enabled)
2079 if (!mark_lock(curr, hlock,
2080 LOCK_ENABLED_SOFTIRQS, ip))
2081 return 0;
2084 #endif
2085 /* mark it as used: */
2086 if (!mark_lock(curr, hlock, LOCK_USED, ip))
2087 return 0;
2088 out_calc_hash:
2090 * Calculate the chain hash: it's the combined has of all the
2091 * lock keys along the dependency chain. We save the hash value
2092 * at every step so that we can get the current hash easily
2093 * after unlock. The chain hash is then used to cache dependency
2094 * results.
2096 * The 'key ID' is what is the most compact key value to drive
2097 * the hash, not class->key.
2099 id = class - lock_classes;
2100 if (DEBUG_LOCKS_WARN_ON(id >= MAX_LOCKDEP_KEYS))
2101 return 0;
2103 chain_key = curr->curr_chain_key;
2104 if (!depth) {
2105 if (DEBUG_LOCKS_WARN_ON(chain_key != 0))
2106 return 0;
2107 chain_head = 1;
2110 hlock->prev_chain_key = chain_key;
2112 #ifdef CONFIG_TRACE_IRQFLAGS
2114 * Keep track of points where we cross into an interrupt context:
2116 hlock->irq_context = 2*(curr->hardirq_context ? 1 : 0) +
2117 curr->softirq_context;
2118 if (depth) {
2119 struct held_lock *prev_hlock;
2121 prev_hlock = curr->held_locks + depth-1;
2123 * If we cross into another context, reset the
2124 * hash key (this also prevents the checking and the
2125 * adding of the dependency to 'prev'):
2127 if (prev_hlock->irq_context != hlock->irq_context) {
2128 chain_key = 0;
2129 chain_head = 1;
2132 #endif
2133 chain_key = iterate_chain_key(chain_key, id);
2134 curr->curr_chain_key = chain_key;
2137 * Trylock needs to maintain the stack of held locks, but it
2138 * does not add new dependencies, because trylock can be done
2139 * in any order.
2141 * We look up the chain_key and do the O(N^2) check and update of
2142 * the dependencies only if this is a new dependency chain.
2143 * (If lookup_chain_cache() returns with 1 it acquires
2144 * hash_lock for us)
2146 if (!trylock && (check == 2) && lookup_chain_cache(chain_key, class)) {
2148 * Check whether last held lock:
2150 * - is irq-safe, if this lock is irq-unsafe
2151 * - is softirq-safe, if this lock is hardirq-unsafe
2153 * And check whether the new lock's dependency graph
2154 * could lead back to the previous lock.
2156 * any of these scenarios could lead to a deadlock. If
2157 * All validations
2159 int ret = check_deadlock(curr, hlock, lock, read);
2161 if (!ret)
2162 return 0;
2164 * Mark recursive read, as we jump over it when
2165 * building dependencies (just like we jump over
2166 * trylock entries):
2168 if (ret == 2)
2169 hlock->read = 2;
2171 * Add dependency only if this lock is not the head
2172 * of the chain, and if it's not a secondary read-lock:
2174 if (!chain_head && ret != 2)
2175 if (!check_prevs_add(curr, hlock))
2176 return 0;
2177 __raw_spin_unlock(&hash_lock);
2179 curr->lockdep_depth++;
2180 check_chain_key(curr);
2181 if (unlikely(curr->lockdep_depth >= MAX_LOCK_DEPTH)) {
2182 debug_locks_off();
2183 printk("BUG: MAX_LOCK_DEPTH too low!\n");
2184 printk("turning off the locking correctness validator.\n");
2185 return 0;
2187 if (unlikely(curr->lockdep_depth > max_lockdep_depth))
2188 max_lockdep_depth = curr->lockdep_depth;
2190 return 1;
2193 static int
2194 print_unlock_inbalance_bug(struct task_struct *curr, struct lockdep_map *lock,
2195 unsigned long ip)
2197 if (!debug_locks_off())
2198 return 0;
2199 if (debug_locks_silent)
2200 return 0;
2202 printk("\n=====================================\n");
2203 printk( "[ BUG: bad unlock balance detected! ]\n");
2204 printk( "-------------------------------------\n");
2205 printk("%s/%d is trying to release lock (",
2206 curr->comm, curr->pid);
2207 print_lockdep_cache(lock);
2208 printk(") at:\n");
2209 print_ip_sym(ip);
2210 printk("but there are no more locks to release!\n");
2211 printk("\nother info that might help us debug this:\n");
2212 lockdep_print_held_locks(curr);
2214 printk("\nstack backtrace:\n");
2215 dump_stack();
2217 return 0;
2221 * Common debugging checks for both nested and non-nested unlock:
2223 static int check_unlock(struct task_struct *curr, struct lockdep_map *lock,
2224 unsigned long ip)
2226 if (unlikely(!debug_locks))
2227 return 0;
2228 if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
2229 return 0;
2231 if (curr->lockdep_depth <= 0)
2232 return print_unlock_inbalance_bug(curr, lock, ip);
2234 return 1;
2238 * Remove the lock to the list of currently held locks in a
2239 * potentially non-nested (out of order) manner. This is a
2240 * relatively rare operation, as all the unlock APIs default
2241 * to nested mode (which uses lock_release()):
2243 static int
2244 lock_release_non_nested(struct task_struct *curr,
2245 struct lockdep_map *lock, unsigned long ip)
2247 struct held_lock *hlock, *prev_hlock;
2248 unsigned int depth;
2249 int i;
2252 * Check whether the lock exists in the current stack
2253 * of held locks:
2255 depth = curr->lockdep_depth;
2256 if (DEBUG_LOCKS_WARN_ON(!depth))
2257 return 0;
2259 prev_hlock = NULL;
2260 for (i = depth-1; i >= 0; i--) {
2261 hlock = curr->held_locks + i;
2263 * We must not cross into another context:
2265 if (prev_hlock && prev_hlock->irq_context != hlock->irq_context)
2266 break;
2267 if (hlock->instance == lock)
2268 goto found_it;
2269 prev_hlock = hlock;
2271 return print_unlock_inbalance_bug(curr, lock, ip);
2273 found_it:
2275 * We have the right lock to unlock, 'hlock' points to it.
2276 * Now we remove it from the stack, and add back the other
2277 * entries (if any), recalculating the hash along the way:
2279 curr->lockdep_depth = i;
2280 curr->curr_chain_key = hlock->prev_chain_key;
2282 for (i++; i < depth; i++) {
2283 hlock = curr->held_locks + i;
2284 if (!__lock_acquire(hlock->instance,
2285 hlock->class->subclass, hlock->trylock,
2286 hlock->read, hlock->check, hlock->hardirqs_off,
2287 hlock->acquire_ip))
2288 return 0;
2291 if (DEBUG_LOCKS_WARN_ON(curr->lockdep_depth != depth - 1))
2292 return 0;
2293 return 1;
2297 * Remove the lock to the list of currently held locks - this gets
2298 * called on mutex_unlock()/spin_unlock*() (or on a failed
2299 * mutex_lock_interruptible()). This is done for unlocks that nest
2300 * perfectly. (i.e. the current top of the lock-stack is unlocked)
2302 static int lock_release_nested(struct task_struct *curr,
2303 struct lockdep_map *lock, unsigned long ip)
2305 struct held_lock *hlock;
2306 unsigned int depth;
2309 * Pop off the top of the lock stack:
2311 depth = curr->lockdep_depth - 1;
2312 hlock = curr->held_locks + depth;
2315 * Is the unlock non-nested:
2317 if (hlock->instance != lock)
2318 return lock_release_non_nested(curr, lock, ip);
2319 curr->lockdep_depth--;
2321 if (DEBUG_LOCKS_WARN_ON(!depth && (hlock->prev_chain_key != 0)))
2322 return 0;
2324 curr->curr_chain_key = hlock->prev_chain_key;
2326 #ifdef CONFIG_DEBUG_LOCKDEP
2327 hlock->prev_chain_key = 0;
2328 hlock->class = NULL;
2329 hlock->acquire_ip = 0;
2330 hlock->irq_context = 0;
2331 #endif
2332 return 1;
2336 * Remove the lock to the list of currently held locks - this gets
2337 * called on mutex_unlock()/spin_unlock*() (or on a failed
2338 * mutex_lock_interruptible()). This is done for unlocks that nest
2339 * perfectly. (i.e. the current top of the lock-stack is unlocked)
2341 static void
2342 __lock_release(struct lockdep_map *lock, int nested, unsigned long ip)
2344 struct task_struct *curr = current;
2346 if (!check_unlock(curr, lock, ip))
2347 return;
2349 if (nested) {
2350 if (!lock_release_nested(curr, lock, ip))
2351 return;
2352 } else {
2353 if (!lock_release_non_nested(curr, lock, ip))
2354 return;
2357 check_chain_key(curr);
2361 * Check whether we follow the irq-flags state precisely:
2363 static void check_flags(unsigned long flags)
2365 #if defined(CONFIG_DEBUG_LOCKDEP) && defined(CONFIG_TRACE_IRQFLAGS)
2366 if (!debug_locks)
2367 return;
2369 if (irqs_disabled_flags(flags))
2370 DEBUG_LOCKS_WARN_ON(current->hardirqs_enabled);
2371 else
2372 DEBUG_LOCKS_WARN_ON(!current->hardirqs_enabled);
2375 * We dont accurately track softirq state in e.g.
2376 * hardirq contexts (such as on 4KSTACKS), so only
2377 * check if not in hardirq contexts:
2379 if (!hardirq_count()) {
2380 if (softirq_count())
2381 DEBUG_LOCKS_WARN_ON(current->softirqs_enabled);
2382 else
2383 DEBUG_LOCKS_WARN_ON(!current->softirqs_enabled);
2386 if (!debug_locks)
2387 print_irqtrace_events(current);
2388 #endif
2392 * We are not always called with irqs disabled - do that here,
2393 * and also avoid lockdep recursion:
2395 void lock_acquire(struct lockdep_map *lock, unsigned int subclass,
2396 int trylock, int read, int check, unsigned long ip)
2398 unsigned long flags;
2400 if (unlikely(current->lockdep_recursion))
2401 return;
2403 raw_local_irq_save(flags);
2404 check_flags(flags);
2406 current->lockdep_recursion = 1;
2407 __lock_acquire(lock, subclass, trylock, read, check,
2408 irqs_disabled_flags(flags), ip);
2409 current->lockdep_recursion = 0;
2410 raw_local_irq_restore(flags);
2413 EXPORT_SYMBOL_GPL(lock_acquire);
2415 void lock_release(struct lockdep_map *lock, int nested, unsigned long ip)
2417 unsigned long flags;
2419 if (unlikely(current->lockdep_recursion))
2420 return;
2422 raw_local_irq_save(flags);
2423 check_flags(flags);
2424 current->lockdep_recursion = 1;
2425 __lock_release(lock, nested, ip);
2426 current->lockdep_recursion = 0;
2427 raw_local_irq_restore(flags);
2430 EXPORT_SYMBOL_GPL(lock_release);
2433 * Used by the testsuite, sanitize the validator state
2434 * after a simulated failure:
2437 void lockdep_reset(void)
2439 unsigned long flags;
2441 raw_local_irq_save(flags);
2442 current->curr_chain_key = 0;
2443 current->lockdep_depth = 0;
2444 current->lockdep_recursion = 0;
2445 memset(current->held_locks, 0, MAX_LOCK_DEPTH*sizeof(struct held_lock));
2446 nr_hardirq_chains = 0;
2447 nr_softirq_chains = 0;
2448 nr_process_chains = 0;
2449 debug_locks = 1;
2450 raw_local_irq_restore(flags);
2453 static void zap_class(struct lock_class *class)
2455 int i;
2458 * Remove all dependencies this lock is
2459 * involved in:
2461 for (i = 0; i < nr_list_entries; i++) {
2462 if (list_entries[i].class == class)
2463 list_del_rcu(&list_entries[i].entry);
2466 * Unhash the class and remove it from the all_lock_classes list:
2468 list_del_rcu(&class->hash_entry);
2469 list_del_rcu(&class->lock_entry);
2473 static inline int within(void *addr, void *start, unsigned long size)
2475 return addr >= start && addr < start + size;
2478 void lockdep_free_key_range(void *start, unsigned long size)
2480 struct lock_class *class, *next;
2481 struct list_head *head;
2482 unsigned long flags;
2483 int i;
2485 raw_local_irq_save(flags);
2486 __raw_spin_lock(&hash_lock);
2489 * Unhash all classes that were created by this module:
2491 for (i = 0; i < CLASSHASH_SIZE; i++) {
2492 head = classhash_table + i;
2493 if (list_empty(head))
2494 continue;
2495 list_for_each_entry_safe(class, next, head, hash_entry)
2496 if (within(class->key, start, size))
2497 zap_class(class);
2500 __raw_spin_unlock(&hash_lock);
2501 raw_local_irq_restore(flags);
2504 void lockdep_reset_lock(struct lockdep_map *lock)
2506 struct lock_class *class, *next;
2507 struct list_head *head;
2508 unsigned long flags;
2509 int i, j;
2511 raw_local_irq_save(flags);
2514 * Remove all classes this lock might have:
2516 for (j = 0; j < MAX_LOCKDEP_SUBCLASSES; j++) {
2518 * If the class exists we look it up and zap it:
2520 class = look_up_lock_class(lock, j);
2521 if (class)
2522 zap_class(class);
2525 * Debug check: in the end all mapped classes should
2526 * be gone.
2528 __raw_spin_lock(&hash_lock);
2529 for (i = 0; i < CLASSHASH_SIZE; i++) {
2530 head = classhash_table + i;
2531 if (list_empty(head))
2532 continue;
2533 list_for_each_entry_safe(class, next, head, hash_entry) {
2534 if (unlikely(class == lock->class_cache)) {
2535 __raw_spin_unlock(&hash_lock);
2536 DEBUG_LOCKS_WARN_ON(1);
2537 goto out_restore;
2541 __raw_spin_unlock(&hash_lock);
2543 out_restore:
2544 raw_local_irq_restore(flags);
2547 void __init lockdep_init(void)
2549 int i;
2552 * Some architectures have their own start_kernel()
2553 * code which calls lockdep_init(), while we also
2554 * call lockdep_init() from the start_kernel() itself,
2555 * and we want to initialize the hashes only once:
2557 if (lockdep_initialized)
2558 return;
2560 for (i = 0; i < CLASSHASH_SIZE; i++)
2561 INIT_LIST_HEAD(classhash_table + i);
2563 for (i = 0; i < CHAINHASH_SIZE; i++)
2564 INIT_LIST_HEAD(chainhash_table + i);
2566 lockdep_initialized = 1;
2569 void __init lockdep_info(void)
2571 printk("Lock dependency validator: Copyright (c) 2006 Red Hat, Inc., Ingo Molnar\n");
2573 printk("... MAX_LOCKDEP_SUBCLASSES: %lu\n", MAX_LOCKDEP_SUBCLASSES);
2574 printk("... MAX_LOCK_DEPTH: %lu\n", MAX_LOCK_DEPTH);
2575 printk("... MAX_LOCKDEP_KEYS: %lu\n", MAX_LOCKDEP_KEYS);
2576 printk("... CLASSHASH_SIZE: %lu\n", CLASSHASH_SIZE);
2577 printk("... MAX_LOCKDEP_ENTRIES: %lu\n", MAX_LOCKDEP_ENTRIES);
2578 printk("... MAX_LOCKDEP_CHAINS: %lu\n", MAX_LOCKDEP_CHAINS);
2579 printk("... CHAINHASH_SIZE: %lu\n", CHAINHASH_SIZE);
2581 printk(" memory used by lock dependency info: %lu kB\n",
2582 (sizeof(struct lock_class) * MAX_LOCKDEP_KEYS +
2583 sizeof(struct list_head) * CLASSHASH_SIZE +
2584 sizeof(struct lock_list) * MAX_LOCKDEP_ENTRIES +
2585 sizeof(struct lock_chain) * MAX_LOCKDEP_CHAINS +
2586 sizeof(struct list_head) * CHAINHASH_SIZE) / 1024);
2588 printk(" per task-struct memory footprint: %lu bytes\n",
2589 sizeof(struct held_lock) * MAX_LOCK_DEPTH);
2591 #ifdef CONFIG_DEBUG_LOCKDEP
2592 if (lockdep_init_error)
2593 printk("WARNING: lockdep init error! Arch code didnt call lockdep_init() early enough?\n");
2594 #endif
2597 static inline int in_range(const void *start, const void *addr, const void *end)
2599 return addr >= start && addr <= end;
2602 static void
2603 print_freed_lock_bug(struct task_struct *curr, const void *mem_from,
2604 const void *mem_to, struct held_lock *hlock)
2606 if (!debug_locks_off())
2607 return;
2608 if (debug_locks_silent)
2609 return;
2611 printk("\n=========================\n");
2612 printk( "[ BUG: held lock freed! ]\n");
2613 printk( "-------------------------\n");
2614 printk("%s/%d is freeing memory %p-%p, with a lock still held there!\n",
2615 curr->comm, curr->pid, mem_from, mem_to-1);
2616 print_lock(hlock);
2617 lockdep_print_held_locks(curr);
2619 printk("\nstack backtrace:\n");
2620 dump_stack();
2624 * Called when kernel memory is freed (or unmapped), or if a lock
2625 * is destroyed or reinitialized - this code checks whether there is
2626 * any held lock in the memory range of <from> to <to>:
2628 void debug_check_no_locks_freed(const void *mem_from, unsigned long mem_len)
2630 const void *mem_to = mem_from + mem_len, *lock_from, *lock_to;
2631 struct task_struct *curr = current;
2632 struct held_lock *hlock;
2633 unsigned long flags;
2634 int i;
2636 if (unlikely(!debug_locks))
2637 return;
2639 local_irq_save(flags);
2640 for (i = 0; i < curr->lockdep_depth; i++) {
2641 hlock = curr->held_locks + i;
2643 lock_from = (void *)hlock->instance;
2644 lock_to = (void *)(hlock->instance + 1);
2646 if (!in_range(mem_from, lock_from, mem_to) &&
2647 !in_range(mem_from, lock_to, mem_to))
2648 continue;
2650 print_freed_lock_bug(curr, mem_from, mem_to, hlock);
2651 break;
2653 local_irq_restore(flags);
2655 EXPORT_SYMBOL_GPL(debug_check_no_locks_freed);
2657 static void print_held_locks_bug(struct task_struct *curr)
2659 if (!debug_locks_off())
2660 return;
2661 if (debug_locks_silent)
2662 return;
2664 printk("\n=====================================\n");
2665 printk( "[ BUG: lock held at task exit time! ]\n");
2666 printk( "-------------------------------------\n");
2667 printk("%s/%d is exiting with locks still held!\n",
2668 curr->comm, curr->pid);
2669 lockdep_print_held_locks(curr);
2671 printk("\nstack backtrace:\n");
2672 dump_stack();
2675 void debug_check_no_locks_held(struct task_struct *task)
2677 if (unlikely(task->lockdep_depth > 0))
2678 print_held_locks_bug(task);
2681 void debug_show_all_locks(void)
2683 struct task_struct *g, *p;
2684 int count = 10;
2685 int unlock = 1;
2687 printk("\nShowing all locks held in the system:\n");
2690 * Here we try to get the tasklist_lock as hard as possible,
2691 * if not successful after 2 seconds we ignore it (but keep
2692 * trying). This is to enable a debug printout even if a
2693 * tasklist_lock-holding task deadlocks or crashes.
2695 retry:
2696 if (!read_trylock(&tasklist_lock)) {
2697 if (count == 10)
2698 printk("hm, tasklist_lock locked, retrying... ");
2699 if (count) {
2700 count--;
2701 printk(" #%d", 10-count);
2702 mdelay(200);
2703 goto retry;
2705 printk(" ignoring it.\n");
2706 unlock = 0;
2708 if (count != 10)
2709 printk(" locked it.\n");
2711 do_each_thread(g, p) {
2712 if (p->lockdep_depth)
2713 lockdep_print_held_locks(p);
2714 if (!unlock)
2715 if (read_trylock(&tasklist_lock))
2716 unlock = 1;
2717 } while_each_thread(g, p);
2719 printk("\n");
2720 printk("=============================================\n\n");
2722 if (unlock)
2723 read_unlock(&tasklist_lock);
2726 EXPORT_SYMBOL_GPL(debug_show_all_locks);
2728 void debug_show_held_locks(struct task_struct *task)
2730 lockdep_print_held_locks(task);
2733 EXPORT_SYMBOL_GPL(debug_show_held_locks);