[NETFILTER]: nf_conntrack: export hash allocation/destruction functions
[linux-2.6/verdex.git] / kernel / lockdep.c
blob1a5ff2211d8898076c601d4f9c639bfe34f5927c
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 * lockdep_lock: protects the lockdep graph, the hashes and the
47 * class/list/hash allocators.
49 * This is one of the rare exceptions where it's justified
50 * to use a raw spinlock - we really dont want the spinlock
51 * code to recurse back into the lockdep code...
53 static raw_spinlock_t lockdep_lock = (raw_spinlock_t)__RAW_SPIN_LOCK_UNLOCKED;
55 static int graph_lock(void)
57 __raw_spin_lock(&lockdep_lock);
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)
64 if (!debug_locks) {
65 __raw_spin_unlock(&lockdep_lock);
66 return 0;
68 return 1;
71 static inline int graph_unlock(void)
73 if (debug_locks && !__raw_spin_is_locked(&lockdep_lock))
74 return DEBUG_LOCKS_WARN_ON(1);
76 __raw_spin_unlock(&lockdep_lock);
77 return 0;
81 * Turn lock debugging off and return with 0 if it was off already,
82 * and also release the graph lock:
84 static inline int debug_locks_off_graph_unlock(void)
86 int ret = debug_locks_off();
88 __raw_spin_unlock(&lockdep_lock);
90 return ret;
93 static int lockdep_initialized;
95 unsigned long nr_list_entries;
96 static struct lock_list list_entries[MAX_LOCKDEP_ENTRIES];
99 * Allocate a lockdep entry. (assumes the graph_lock held, returns
100 * with NULL on failure)
102 static struct lock_list *alloc_list_entry(void)
104 if (nr_list_entries >= MAX_LOCKDEP_ENTRIES) {
105 if (!debug_locks_off_graph_unlock())
106 return NULL;
108 printk("BUG: MAX_LOCKDEP_ENTRIES too low!\n");
109 printk("turning off the locking correctness validator.\n");
110 return NULL;
112 return list_entries + nr_list_entries++;
116 * All data structures here are protected by the global debug_lock.
118 * Mutex key structs only get allocated, once during bootup, and never
119 * get freed - this significantly simplifies the debugging code.
121 unsigned long nr_lock_classes;
122 static struct lock_class lock_classes[MAX_LOCKDEP_KEYS];
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.
129 LIST_HEAD(all_lock_classes);
132 * The lockdep classes are in a hash-table as well, for fast lookup:
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)))
140 static struct list_head classhash_table[CLASSHASH_SIZE];
142 unsigned long nr_lock_chains;
143 static struct lock_chain lock_chains[MAX_LOCKDEP_CHAINS];
146 * We put the lock dependency chains into a hash-table as well, to cache
147 * their existence:
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)))
156 static struct list_head chainhash_table[CHAINHASH_SIZE];
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.
164 #define iterate_chain_key(key1, key2) \
165 (((key1) << MAX_LOCKDEP_KEYS_BITS) ^ \
166 ((key1) >> (64-MAX_LOCKDEP_KEYS_BITS)) ^ \
167 (key2))
169 void lockdep_off(void)
171 current->lockdep_recursion++;
174 EXPORT_SYMBOL(lockdep_off);
176 void lockdep_on(void)
178 current->lockdep_recursion--;
181 EXPORT_SYMBOL(lockdep_on);
184 * Debugging switches:
187 #define VERBOSE 0
188 #define VERY_VERBOSE 0
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
198 #if VERBOSE || HARDIRQ_VERBOSE || SOFTIRQ_VERBOSE
200 * Quick filtering for interesting events:
202 static int class_filter(struct lock_class *class)
204 #if 0
205 /* Example */
206 if (class->name_version == 1 &&
207 !strcmp(class->name, "lockname"))
208 return 1;
209 if (class->name_version == 1 &&
210 !strcmp(class->name, "&struct->lockfield"))
211 return 1;
212 #endif
213 /* Filter everything else. 1 would be to allow everything else */
214 return 0;
216 #endif
218 static int verbose(struct lock_class *class)
220 #if VERBOSE
221 return class_filter(class);
222 #endif
223 return 0;
226 #ifdef CONFIG_TRACE_IRQFLAGS
228 static int hardirq_verbose(struct lock_class *class)
230 #if HARDIRQ_VERBOSE
231 return class_filter(class);
232 #endif
233 return 0;
236 static int softirq_verbose(struct lock_class *class)
238 #if SOFTIRQ_VERBOSE
239 return class_filter(class);
240 #endif
241 return 0;
244 #endif
247 * Stack-trace: tightly packed array of stack backtrace
248 * addresses. Protected by the graph_lock.
250 unsigned long nr_stack_trace_entries;
251 static unsigned long stack_trace[MAX_STACK_TRACE_ENTRIES];
253 static int save_trace(struct stack_trace *trace)
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;
259 trace->skip = 3;
261 save_stack_trace(trace);
263 trace->max_entries = trace->nr_entries;
265 nr_stack_trace_entries += trace->nr_entries;
267 if (nr_stack_trace_entries == MAX_STACK_TRACE_ENTRIES) {
268 if (!debug_locks_off_graph_unlock())
269 return 0;
271 printk("BUG: MAX_STACK_TRACE_ENTRIES too low!\n");
272 printk("turning off the locking correctness validator.\n");
273 dump_stack();
275 return 0;
278 return 1;
281 unsigned int nr_hardirq_chains;
282 unsigned int nr_softirq_chains;
283 unsigned int nr_process_chains;
284 unsigned int max_lockdep_depth;
285 unsigned int max_recursion_depth;
287 #ifdef CONFIG_DEBUG_LOCKDEP
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().
293 static int lockdep_init_error;
296 * Various lockdep statistics:
298 atomic_t chain_lookup_hits;
299 atomic_t chain_lookup_misses;
300 atomic_t hardirqs_on_events;
301 atomic_t hardirqs_off_events;
302 atomic_t redundant_hardirqs_on;
303 atomic_t redundant_hardirqs_off;
304 atomic_t softirqs_on_events;
305 atomic_t softirqs_off_events;
306 atomic_t redundant_softirqs_on;
307 atomic_t redundant_softirqs_off;
308 atomic_t nr_unused_locks;
309 atomic_t nr_cyclic_checks;
310 atomic_t nr_cyclic_check_recursions;
311 atomic_t nr_find_usage_forwards_checks;
312 atomic_t nr_find_usage_forwards_recursions;
313 atomic_t nr_find_usage_backwards_checks;
314 atomic_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
325 * Locking printouts:
328 static const char *usage_str[] =
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",
341 const char * __get_key_name(struct lockdep_subclass_key *key, char *str)
343 return kallsyms_lookup((unsigned long)key, NULL, NULL, NULL, str);
346 void
347 get_usage_chars(struct lock_class *class, char *c1, char *c2, char *c3, char *c4)
349 *c1 = '.', *c2 = '.', *c3 = '.', *c4 = '.';
351 if (class->usage_mask & LOCKF_USED_IN_HARDIRQ)
352 *c1 = '+';
353 else
354 if (class->usage_mask & LOCKF_ENABLED_HARDIRQS)
355 *c1 = '-';
357 if (class->usage_mask & LOCKF_USED_IN_SOFTIRQ)
358 *c2 = '+';
359 else
360 if (class->usage_mask & LOCKF_ENABLED_SOFTIRQS)
361 *c2 = '-';
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 = '?';
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 = '?';
380 static void print_lock_name(struct lock_class *class)
382 char str[KSYM_NAME_LEN + 1], c1, c2, c3, c4;
383 const char *name;
385 get_usage_chars(class, &c1, &c2, &c3, &c4);
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);
398 printk("){%c%c%c%c}", c1, c2, c3, c4);
401 static void print_lockdep_cache(struct lockdep_map *lock)
403 const char *name;
404 char str[KSYM_NAME_LEN + 1];
406 name = lock->name;
407 if (!name)
408 name = __get_key_name(lock->key->subkeys, str);
410 printk("%s", name);
413 static void print_lock(struct held_lock *hlock)
415 print_lock_name(hlock->class);
416 printk(", at: ");
417 print_ip_sym(hlock->acquire_ip);
420 static void lockdep_print_held_locks(struct task_struct *curr)
422 int i, depth = curr->lockdep_depth;
424 if (!depth) {
425 printk("no locks held by %s/%d.\n", curr->comm, curr->pid);
426 return;
428 printk("%d lock%s held by %s/%d:\n",
429 depth, depth > 1 ? "s" : "", curr->comm, curr->pid);
431 for (i = 0; i < depth; i++) {
432 printk(" #%d: ", i);
433 print_lock(curr->held_locks + i);
437 static void print_lock_class_header(struct lock_class *class, int depth)
439 int bit;
441 printk("%*s->", depth, "");
442 print_lock_name(class);
443 printk(" ops: %lu", class->ops);
444 printk(" {\n");
446 for (bit = 0; bit < LOCK_USAGE_STATES; bit++) {
447 if (class->usage_mask & (1 << bit)) {
448 int len = depth;
450 len += printk("%*s %s", depth, "", usage_str[bit]);
451 len += printk(" at:\n");
452 print_stack_trace(class->usage_traces + bit, len);
455 printk("%*s }\n", depth, "");
457 printk("%*s ... key at: ",depth,"");
458 print_ip_sym((unsigned long)class->key);
462 * printk all lock dependencies starting at <entry>:
464 static void print_lock_dependencies(struct lock_class *class, int depth)
466 struct lock_list *entry;
468 if (DEBUG_LOCKS_WARN_ON(depth >= 20))
469 return;
471 print_lock_class_header(class, depth);
473 list_for_each_entry(entry, &class->locks_after, entry) {
474 if (DEBUG_LOCKS_WARN_ON(!entry->class))
475 return;
477 print_lock_dependencies(entry->class, depth + 1);
479 printk("%*s ... acquired at:\n",depth,"");
480 print_stack_trace(&entry->trace, 2);
481 printk("\n");
486 * Add a new dependency to the head of the list:
488 static int add_lock_to_list(struct lock_class *class, struct lock_class *this,
489 struct list_head *head, unsigned long ip, int distance)
491 struct lock_list *entry;
493 * Lock not present yet - get a new dependency struct and
494 * add it to the list:
496 entry = alloc_list_entry();
497 if (!entry)
498 return 0;
500 entry->class = this;
501 entry->distance = distance;
502 if (!save_trace(&entry->trace))
503 return 0;
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:
512 list_add_tail_rcu(&entry->entry, head);
514 return 1;
518 * Recursive, forwards-direction lock-dependency checking, used for
519 * both noncyclic checking and for hardirq-unsafe/softirq-unsafe
520 * checking.
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.)
526 static struct held_lock *check_source, *check_target;
529 * Print a dependency chain entry (this is only done when a deadlock
530 * has been detected):
532 static noinline int
533 print_circular_bug_entry(struct lock_list *target, unsigned int depth)
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);
542 return 0;
545 static void print_kernel_version(void)
547 printk("%s %.*s\n", init_utsname()->release,
548 (int)strcspn(init_utsname()->version, " "),
549 init_utsname()->version);
553 * When a circular dependency is detected, print the
554 * header first:
556 static noinline int
557 print_circular_bug_header(struct lock_list *entry, unsigned int depth)
559 struct task_struct *curr = current;
561 if (!debug_locks_off_graph_unlock() || debug_locks_silent)
562 return 0;
564 printk("\n=======================================================\n");
565 printk( "[ INFO: possible circular locking dependency detected ]\n");
566 print_kernel_version();
567 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");
576 print_circular_bug_entry(entry, depth);
578 return 0;
581 static noinline int print_circular_bug_tail(void)
583 struct task_struct *curr = current;
584 struct lock_list this;
586 if (debug_locks_silent)
587 return 0;
589 this.class = check_source->class;
590 if (!save_trace(&this.trace))
591 return 0;
593 print_circular_bug_entry(&this, 0);
595 printk("\nother info that might help us debug this:\n\n");
596 lockdep_print_held_locks(curr);
598 printk("\nstack backtrace:\n");
599 dump_stack();
601 return 0;
604 #define RECURSION_LIMIT 40
606 static int noinline print_infinite_recursion_bug(void)
608 if (!debug_locks_off_graph_unlock())
609 return 0;
611 WARN_ON(1);
613 return 0;
617 * Prove that the dependency graph starting at <entry> can not
618 * lead to <target>. Print an error and return 0 if it does.
620 static noinline int
621 check_noncircular(struct lock_class *source, unsigned int depth)
623 struct lock_list *entry;
625 debug_atomic_inc(&nr_cyclic_check_recursions);
626 if (depth > max_recursion_depth)
627 max_recursion_depth = depth;
628 if (depth >= RECURSION_LIMIT)
629 return print_infinite_recursion_bug();
631 * Check this lock's dependency list:
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);
640 return 1;
643 static int very_verbose(struct lock_class *class)
645 #if VERY_VERBOSE
646 return class_filter(class);
647 #endif
648 return 0;
650 #ifdef CONFIG_TRACE_IRQFLAGS
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.
657 static enum lock_usage_bit find_usage_bit;
658 static struct lock_class *forwards_match, *backwards_match;
661 * Find a node in the forwards-direction dependency sub-graph starting
662 * at <source> that matches <find_usage_bit>.
664 * Return 2 if such a node exists in the subgraph, and put that node
665 * into <forwards_match>.
667 * Return 1 otherwise and keep <forwards_match> unchanged.
668 * Return 0 on error.
670 static noinline int
671 find_usage_forwards(struct lock_class *source, unsigned int depth)
673 struct lock_list *entry;
674 int ret;
676 if (depth > max_recursion_depth)
677 max_recursion_depth = depth;
678 if (depth >= RECURSION_LIMIT)
679 return print_infinite_recursion_bug();
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;
688 * Check this lock's dependency list:
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;
696 return 1;
700 * Find a node in the backwards-direction dependency sub-graph starting
701 * at <source> that matches <find_usage_bit>.
703 * Return 2 if such a node exists in the subgraph, and put that node
704 * into <backwards_match>.
706 * Return 1 otherwise and keep <backwards_match> unchanged.
707 * Return 0 on error.
709 static noinline int
710 find_usage_backwards(struct lock_class *source, unsigned int depth)
712 struct lock_list *entry;
713 int ret;
715 if (!__raw_spin_is_locked(&lockdep_lock))
716 return DEBUG_LOCKS_WARN_ON(1);
718 if (depth > max_recursion_depth)
719 max_recursion_depth = depth;
720 if (depth >= RECURSION_LIMIT)
721 return print_infinite_recursion_bug();
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;
730 * Check this lock's dependency list:
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;
738 return 1;
741 static int
742 print_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)
749 if (!debug_locks_off_graph_unlock() || debug_locks_silent)
750 return 0;
752 printk("\n======================================================\n");
753 printk( "[ INFO: %s-safe -> %s-unsafe lock order detected ]\n",
754 irqclass, irqclass);
755 print_kernel_version();
756 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);
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");
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);
778 print_stack_trace(backwards_match->usage_traces + bit1, 1);
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("...");
785 print_stack_trace(forwards_match->usage_traces + bit2, 1);
787 printk("\nother info that might help us debug this:\n\n");
788 lockdep_print_held_locks(curr);
790 printk("\nthe %s-irq-safe lock's dependencies:\n", irqclass);
791 print_lock_dependencies(backwards_match, 0);
793 printk("\nthe %s-irq-unsafe lock's dependencies:\n", irqclass);
794 print_lock_dependencies(forwards_match, 0);
796 printk("\nstack backtrace:\n");
797 dump_stack();
799 return 0;
802 static int
803 check_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)
807 int ret;
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;
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);
824 #endif
826 static int
827 print_deadlock_bug(struct task_struct *curr, struct held_lock *prev,
828 struct held_lock *next)
830 if (!debug_locks_off_graph_unlock() || debug_locks_silent)
831 return 0;
833 printk("\n=============================================\n");
834 printk( "[ INFO: possible recursive locking detected ]\n");
835 print_kernel_version();
836 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);
843 printk("\nother info that might help us debug this:\n");
844 lockdep_print_held_locks(curr);
846 printk("\nstack backtrace:\n");
847 dump_stack();
849 return 0;
853 * Check whether we are holding such a class already.
855 * (Note that this has to be done separately, because the graph cannot
856 * detect such classes of deadlocks.)
858 * Returns: 0 on deadlock detected, 1 on OK, 2 on recursive read
860 static int
861 check_deadlock(struct task_struct *curr, struct held_lock *next,
862 struct lockdep_map *next_instance, int read)
864 struct held_lock *prev;
865 int i;
867 for (i = 0; i < curr->lockdep_depth; i++) {
868 prev = curr->held_locks + i;
869 if (prev->class != next->class)
870 continue;
872 * Allow read-after-read recursion of the same
873 * lock class (i.e. read_lock(lock)+read_lock(lock)):
875 if ((read == 2) && prev->read)
876 return 2;
877 return print_deadlock_bug(curr, prev, next);
879 return 1;
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:
886 * - would the adding of the <prev> -> <next> dependency create a
887 * circular dependency in the graph? [== circular deadlock]
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]
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]
899 * any of these scenarios could lead to a deadlock.
901 * Then if all the validations pass, we add the forwards and backwards
902 * dependency.
904 static int
905 check_prev_add(struct task_struct *curr, struct held_lock *prev,
906 struct held_lock *next, int distance)
908 struct lock_list *entry;
909 int ret;
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>.)
917 * We are using global variables to control the recursion, to
918 * keep the stackframe size of the recursive functions low:
920 check_source = next;
921 check_target = prev;
922 if (!(check_noncircular(next->class, 0)))
923 return print_circular_bug_tail();
925 #ifdef CONFIG_TRACE_IRQFLAGS
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>:
932 if (!check_usage(curr, prev, next, LOCK_USED_IN_HARDIRQ,
933 LOCK_ENABLED_HARDIRQS, "hard"))
934 return 0;
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>:
942 if (!check_usage(curr, prev, next, LOCK_USED_IN_HARDIRQ_READ,
943 LOCK_ENABLED_HARDIRQS, "hard-read"))
944 return 0;
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>:
952 if (!check_usage(curr, prev, next, LOCK_USED_IN_SOFTIRQ,
953 LOCK_ENABLED_SOFTIRQS, "soft"))
954 return 0;
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>:
961 if (!check_usage(curr, prev, next, LOCK_USED_IN_SOFTIRQ_READ,
962 LOCK_ENABLED_SOFTIRQS, "soft"))
963 return 0;
964 #endif
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.
973 if (next->read == 2 || prev->read == 2)
974 return 1;
976 * Is the <prev> -> <next> dependency already present?
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.)
983 list_for_each_entry(entry, &prev->class->locks_after, entry) {
984 if (entry->class == next->class) {
985 if (distance == 1)
986 entry->distance = 1;
987 return 2;
992 * Ok, all validations passed, add the new lock
993 * to the previous lock's dependency list:
995 ret = add_lock_to_list(prev->class, next->class,
996 &prev->class->locks_after, next->acquire_ip, distance);
998 if (!ret)
999 return 0;
1001 ret = add_lock_to_list(next->class, prev->class,
1002 &next->class->locks_before, next->acquire_ip, distance);
1003 if (!ret)
1004 return 0;
1007 * Debugging printouts:
1009 if (verbose(prev->class) || verbose(next->class)) {
1010 graph_unlock();
1011 printk("\n new dependency: ");
1012 print_lock_name(prev->class);
1013 printk(" => ");
1014 print_lock_name(next->class);
1015 printk("\n");
1016 dump_stack();
1017 return graph_lock();
1019 return 1;
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.
1028 static int
1029 check_prevs_add(struct task_struct *curr, struct held_lock *next)
1031 int depth = curr->lockdep_depth;
1032 struct held_lock *hlock;
1035 * Debugging checks.
1037 * Depth must not be zero for a non-head lock:
1039 if (!depth)
1040 goto out_bug;
1042 * At least two relevant locks must exist for this
1043 * to be a head:
1045 if (curr->held_locks[depth].irq_context !=
1046 curr->held_locks[depth-1].irq_context)
1047 goto out_bug;
1049 for (;;) {
1050 int distance = curr->lockdep_depth - depth + 1;
1051 hlock = curr->held_locks + depth-1;
1053 * Only non-recursive-read entries get new dependencies
1054 * added:
1056 if (hlock->read != 2) {
1057 if (!check_prev_add(curr, hlock, next, distance))
1058 return 0;
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:
1065 if (!hlock->trylock)
1066 break;
1068 depth--;
1070 * End of lock-stack?
1072 if (!depth)
1073 break;
1075 * Stop the search if we cross into another context:
1077 if (curr->held_locks[depth].irq_context !=
1078 curr->held_locks[depth-1].irq_context)
1079 break;
1081 return 1;
1082 out_bug:
1083 if (!debug_locks_off_graph_unlock())
1084 return 0;
1086 WARN_ON(1);
1088 return 0;
1093 * Is this the address of a static object:
1095 static int static_obj(void *obj)
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
1105 * static variable?
1107 if ((addr >= start) && (addr < end))
1108 return 1;
1110 #ifdef CONFIG_SMP
1112 * percpu var?
1114 for_each_possible_cpu(i) {
1115 start = (unsigned long) &__per_cpu_start + per_cpu_offset(i);
1116 end = (unsigned long) &__per_cpu_start + PERCPU_ENOUGH_ROOM
1117 + per_cpu_offset(i);
1119 if ((addr >= start) && (addr < end))
1120 return 1;
1122 #endif
1125 * module var?
1127 return is_module_address(addr);
1131 * To make lock name printouts unique, we calculate a unique
1132 * class->name_version generation counter:
1134 static int count_matching_names(struct lock_class *new_class)
1136 struct lock_class *class;
1137 int count = 0;
1139 if (!new_class->name)
1140 return 0;
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);
1149 return count + 1;
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.
1157 static inline struct lock_class *
1158 look_up_lock_class(struct lockdep_map *lock, unsigned int subclass)
1160 struct lockdep_subclass_key *key;
1161 struct list_head *hash_head;
1162 struct lock_class *class;
1164 #ifdef CONFIG_DEBUG_LOCKDEP
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)
1170 if (unlikely(!lockdep_initialized)) {
1171 lockdep_init();
1172 lockdep_init_error = 1;
1174 #endif
1177 * Static locks do not have their class-keys yet - for them the key
1178 * is the lock object itself:
1180 if (unlikely(!lock->key))
1181 lock->key = (void *)lock;
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.
1189 BUILD_BUG_ON(sizeof(struct lock_class_key) > sizeof(struct lock_class));
1191 key = lock->key->subkeys + subclass;
1193 hash_head = classhashentry(key);
1196 * We can walk the hash lockfree, because the hash only
1197 * grows, and we are careful when adding entries to the end:
1199 list_for_each_entry(class, hash_head, hash_entry)
1200 if (class->key == key)
1201 return class;
1203 return NULL;
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.
1211 static inline struct lock_class *
1212 register_lock_class(struct lockdep_map *lock, unsigned int subclass, int force)
1214 struct lockdep_subclass_key *key;
1215 struct list_head *hash_head;
1216 struct lock_class *class;
1217 unsigned long flags;
1219 class = look_up_lock_class(lock, subclass);
1220 if (likely(class))
1221 return class;
1224 * Debug-check: all keys must be persistent!
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();
1233 return NULL;
1236 key = lock->key->subkeys + subclass;
1237 hash_head = classhashentry(key);
1239 raw_local_irq_save(flags);
1240 if (!graph_lock()) {
1241 raw_local_irq_restore(flags);
1242 return NULL;
1245 * We have to do the hash-walk again, to avoid races
1246 * with another CPU:
1248 list_for_each_entry(class, hash_head, hash_entry)
1249 if (class->key == key)
1250 goto out_unlock_set;
1252 * Allocate a new key from the static array, and add it to
1253 * the hash:
1255 if (nr_lock_classes >= MAX_LOCKDEP_KEYS) {
1256 if (!debug_locks_off_graph_unlock()) {
1257 raw_local_irq_restore(flags);
1258 return NULL;
1260 raw_local_irq_restore(flags);
1262 printk("BUG: MAX_LOCKDEP_KEYS too low!\n");
1263 printk("turning off the locking correctness validator.\n");
1264 return NULL;
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);
1276 * We use RCU's safe list-add method to make
1277 * parallel walking of the hash-list safe:
1279 list_add_tail_rcu(&class->hash_entry, hash_head);
1281 if (verbose(class)) {
1282 graph_unlock();
1283 raw_local_irq_restore(flags);
1285 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();
1291 raw_local_irq_save(flags);
1292 if (!graph_lock()) {
1293 raw_local_irq_restore(flags);
1294 return NULL;
1297 out_unlock_set:
1298 graph_unlock();
1299 raw_local_irq_restore(flags);
1301 if (!subclass || force)
1302 lock->class_cache = class;
1304 if (DEBUG_LOCKS_WARN_ON(class->subclass != subclass))
1305 return NULL;
1307 return class;
1311 * Look up a dependency chain. If the key is not present yet then
1312 * add it and return 1 - in this case the new dependency chain is
1313 * validated. If the key is already hashed, return 0.
1314 * (On return with 1 graph_lock is held.)
1316 static inline int lookup_chain_cache(u64 chain_key, struct lock_class *class)
1318 struct list_head *hash_head = chainhashentry(chain_key);
1319 struct lock_chain *chain;
1321 if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
1322 return 0;
1324 * We can walk it lock-free, because entries only get added
1325 * to the hash:
1327 list_for_each_entry(chain, hash_head, entry) {
1328 if (chain->chain_key == chain_key) {
1329 cache_hit:
1330 debug_atomic_inc(&chain_lookup_hits);
1331 if (very_verbose(class))
1332 printk("\nhash chain already cached, key: "
1333 "%016Lx tail class: [%p] %s\n",
1334 (unsigned long long)chain_key,
1335 class->key, class->name);
1336 return 0;
1339 if (very_verbose(class))
1340 printk("\nnew hash chain, key: %016Lx tail class: [%p] %s\n",
1341 (unsigned long long)chain_key, class->key, class->name);
1343 * Allocate a new chain entry from the static array, and add
1344 * it to the hash:
1346 if (!graph_lock())
1347 return 0;
1349 * We have to walk the chain again locked - to avoid duplicates:
1351 list_for_each_entry(chain, hash_head, entry) {
1352 if (chain->chain_key == chain_key) {
1353 graph_unlock();
1354 goto cache_hit;
1357 if (unlikely(nr_lock_chains >= MAX_LOCKDEP_CHAINS)) {
1358 if (!debug_locks_off_graph_unlock())
1359 return 0;
1361 printk("BUG: MAX_LOCKDEP_CHAINS too low!\n");
1362 printk("turning off the locking correctness validator.\n");
1363 return 0;
1365 chain = lock_chains + nr_lock_chains++;
1366 chain->chain_key = chain_key;
1367 list_add_tail_rcu(&chain->entry, hash_head);
1368 debug_atomic_inc(&chain_lookup_misses);
1369 #ifdef CONFIG_TRACE_IRQFLAGS
1370 if (current->hardirq_context)
1371 nr_hardirq_chains++;
1372 else {
1373 if (current->softirq_context)
1374 nr_softirq_chains++;
1375 else
1376 nr_process_chains++;
1378 #else
1379 nr_process_chains++;
1380 #endif
1382 return 1;
1386 * We are building curr_chain_key incrementally, so double-check
1387 * it from scratch, to make sure that it's done correctly:
1389 static void check_chain_key(struct task_struct *curr)
1391 #ifdef CONFIG_DEBUG_LOCKDEP
1392 struct held_lock *hlock, *prev_hlock = NULL;
1393 unsigned int i, id;
1394 u64 chain_key = 0;
1396 for (i = 0; i < curr->lockdep_depth; i++) {
1397 hlock = curr->held_locks + i;
1398 if (chain_key != hlock->prev_chain_key) {
1399 debug_locks_off();
1400 printk("hm#1, depth: %u [%u], %016Lx != %016Lx\n",
1401 curr->lockdep_depth, i,
1402 (unsigned long long)chain_key,
1403 (unsigned long long)hlock->prev_chain_key);
1404 WARN_ON(1);
1405 return;
1407 id = hlock->class - lock_classes;
1408 if (DEBUG_LOCKS_WARN_ON(id >= MAX_LOCKDEP_KEYS))
1409 return;
1411 if (prev_hlock && (prev_hlock->irq_context !=
1412 hlock->irq_context))
1413 chain_key = 0;
1414 chain_key = iterate_chain_key(chain_key, id);
1415 prev_hlock = hlock;
1417 if (chain_key != curr->curr_chain_key) {
1418 debug_locks_off();
1419 printk("hm#2, depth: %u [%u], %016Lx != %016Lx\n",
1420 curr->lockdep_depth, i,
1421 (unsigned long long)chain_key,
1422 (unsigned long long)curr->curr_chain_key);
1423 WARN_ON(1);
1425 #endif
1428 #ifdef CONFIG_TRACE_IRQFLAGS
1431 * print irq inversion bug:
1433 static int
1434 print_irq_inversion_bug(struct task_struct *curr, struct lock_class *other,
1435 struct held_lock *this, int forwards,
1436 const char *irqclass)
1438 if (!debug_locks_off_graph_unlock() || debug_locks_silent)
1439 return 0;
1441 printk("\n=========================================================\n");
1442 printk( "[ INFO: possible irq lock inversion dependency detected ]\n");
1443 print_kernel_version();
1444 printk( "---------------------------------------------------------\n");
1445 printk("%s/%d just changed the state of lock:\n",
1446 curr->comm, curr->pid);
1447 print_lock(this);
1448 if (forwards)
1449 printk("but this lock took another, %s-irq-unsafe lock in the past:\n", irqclass);
1450 else
1451 printk("but this lock was taken by another, %s-irq-safe lock in the past:\n", irqclass);
1452 print_lock_name(other);
1453 printk("\n\nand interrupts could create inverse lock ordering between them.\n\n");
1455 printk("\nother info that might help us debug this:\n");
1456 lockdep_print_held_locks(curr);
1458 printk("\nthe first lock's dependencies:\n");
1459 print_lock_dependencies(this->class, 0);
1461 printk("\nthe second lock's dependencies:\n");
1462 print_lock_dependencies(other, 0);
1464 printk("\nstack backtrace:\n");
1465 dump_stack();
1467 return 0;
1471 * Prove that in the forwards-direction subgraph starting at <this>
1472 * there is no lock matching <mask>:
1474 static int
1475 check_usage_forwards(struct task_struct *curr, struct held_lock *this,
1476 enum lock_usage_bit bit, const char *irqclass)
1478 int ret;
1480 find_usage_bit = bit;
1481 /* fills in <forwards_match> */
1482 ret = find_usage_forwards(this->class, 0);
1483 if (!ret || ret == 1)
1484 return ret;
1486 return print_irq_inversion_bug(curr, forwards_match, this, 1, irqclass);
1490 * Prove that in the backwards-direction subgraph starting at <this>
1491 * there is no lock matching <mask>:
1493 static int
1494 check_usage_backwards(struct task_struct *curr, struct held_lock *this,
1495 enum lock_usage_bit bit, const char *irqclass)
1497 int ret;
1499 find_usage_bit = bit;
1500 /* fills in <backwards_match> */
1501 ret = find_usage_backwards(this->class, 0);
1502 if (!ret || ret == 1)
1503 return ret;
1505 return print_irq_inversion_bug(curr, backwards_match, this, 0, irqclass);
1508 void print_irqtrace_events(struct task_struct *curr)
1510 printk("irq event stamp: %u\n", curr->irq_events);
1511 printk("hardirqs last enabled at (%u): ", curr->hardirq_enable_event);
1512 print_ip_sym(curr->hardirq_enable_ip);
1513 printk("hardirqs last disabled at (%u): ", curr->hardirq_disable_event);
1514 print_ip_sym(curr->hardirq_disable_ip);
1515 printk("softirqs last enabled at (%u): ", curr->softirq_enable_event);
1516 print_ip_sym(curr->softirq_enable_ip);
1517 printk("softirqs last disabled at (%u): ", curr->softirq_disable_event);
1518 print_ip_sym(curr->softirq_disable_ip);
1521 #endif
1523 static int
1524 print_usage_bug(struct task_struct *curr, struct held_lock *this,
1525 enum lock_usage_bit prev_bit, enum lock_usage_bit new_bit)
1527 if (!debug_locks_off_graph_unlock() || debug_locks_silent)
1528 return 0;
1530 printk("\n=================================\n");
1531 printk( "[ INFO: inconsistent lock state ]\n");
1532 print_kernel_version();
1533 printk( "---------------------------------\n");
1535 printk("inconsistent {%s} -> {%s} usage.\n",
1536 usage_str[prev_bit], usage_str[new_bit]);
1538 printk("%s/%d [HC%u[%lu]:SC%u[%lu]:HE%u:SE%u] takes:\n",
1539 curr->comm, curr->pid,
1540 trace_hardirq_context(curr), hardirq_count() >> HARDIRQ_SHIFT,
1541 trace_softirq_context(curr), softirq_count() >> SOFTIRQ_SHIFT,
1542 trace_hardirqs_enabled(curr),
1543 trace_softirqs_enabled(curr));
1544 print_lock(this);
1546 printk("{%s} state was registered at:\n", usage_str[prev_bit]);
1547 print_stack_trace(this->class->usage_traces + prev_bit, 1);
1549 print_irqtrace_events(curr);
1550 printk("\nother info that might help us debug this:\n");
1551 lockdep_print_held_locks(curr);
1553 printk("\nstack backtrace:\n");
1554 dump_stack();
1556 return 0;
1560 * Print out an error if an invalid bit is set:
1562 static inline int
1563 valid_state(struct task_struct *curr, struct held_lock *this,
1564 enum lock_usage_bit new_bit, enum lock_usage_bit bad_bit)
1566 if (unlikely(this->class->usage_mask & (1 << bad_bit)))
1567 return print_usage_bug(curr, this, bad_bit, new_bit);
1568 return 1;
1571 #define STRICT_READ_CHECKS 1
1574 * Mark a lock with a usage bit, and validate the state transition:
1576 static int mark_lock(struct task_struct *curr, struct held_lock *this,
1577 enum lock_usage_bit new_bit)
1579 unsigned int new_mask = 1 << new_bit, ret = 1;
1582 * If already set then do not dirty the cacheline,
1583 * nor do any checks:
1585 if (likely(this->class->usage_mask & new_mask))
1586 return 1;
1588 if (!graph_lock())
1589 return 0;
1591 * Make sure we didnt race:
1593 if (unlikely(this->class->usage_mask & new_mask)) {
1594 graph_unlock();
1595 return 1;
1598 this->class->usage_mask |= new_mask;
1600 if (!save_trace(this->class->usage_traces + new_bit))
1601 return 0;
1603 switch (new_bit) {
1604 #ifdef CONFIG_TRACE_IRQFLAGS
1605 case LOCK_USED_IN_HARDIRQ:
1606 if (!valid_state(curr, this, new_bit, LOCK_ENABLED_HARDIRQS))
1607 return 0;
1608 if (!valid_state(curr, this, new_bit,
1609 LOCK_ENABLED_HARDIRQS_READ))
1610 return 0;
1612 * just marked it hardirq-safe, check that this lock
1613 * took no hardirq-unsafe lock in the past:
1615 if (!check_usage_forwards(curr, this,
1616 LOCK_ENABLED_HARDIRQS, "hard"))
1617 return 0;
1618 #if STRICT_READ_CHECKS
1620 * just marked it hardirq-safe, check that this lock
1621 * took no hardirq-unsafe-read lock in the past:
1623 if (!check_usage_forwards(curr, this,
1624 LOCK_ENABLED_HARDIRQS_READ, "hard-read"))
1625 return 0;
1626 #endif
1627 if (hardirq_verbose(this->class))
1628 ret = 2;
1629 break;
1630 case LOCK_USED_IN_SOFTIRQ:
1631 if (!valid_state(curr, this, new_bit, LOCK_ENABLED_SOFTIRQS))
1632 return 0;
1633 if (!valid_state(curr, this, new_bit,
1634 LOCK_ENABLED_SOFTIRQS_READ))
1635 return 0;
1637 * just marked it softirq-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 STRICT_READ_CHECKS
1645 * just marked it softirq-safe, check that this lock
1646 * took no softirq-unsafe-read lock in the past:
1648 if (!check_usage_forwards(curr, this,
1649 LOCK_ENABLED_SOFTIRQS_READ, "soft-read"))
1650 return 0;
1651 #endif
1652 if (softirq_verbose(this->class))
1653 ret = 2;
1654 break;
1655 case LOCK_USED_IN_HARDIRQ_READ:
1656 if (!valid_state(curr, this, new_bit, LOCK_ENABLED_HARDIRQS))
1657 return 0;
1659 * just marked it hardirq-read-safe, check that this lock
1660 * took no hardirq-unsafe lock in the past:
1662 if (!check_usage_forwards(curr, this,
1663 LOCK_ENABLED_HARDIRQS, "hard"))
1664 return 0;
1665 if (hardirq_verbose(this->class))
1666 ret = 2;
1667 break;
1668 case LOCK_USED_IN_SOFTIRQ_READ:
1669 if (!valid_state(curr, this, new_bit, LOCK_ENABLED_SOFTIRQS))
1670 return 0;
1672 * just marked it softirq-read-safe, check that this lock
1673 * took no softirq-unsafe lock in the past:
1675 if (!check_usage_forwards(curr, this,
1676 LOCK_ENABLED_SOFTIRQS, "soft"))
1677 return 0;
1678 if (softirq_verbose(this->class))
1679 ret = 2;
1680 break;
1681 case LOCK_ENABLED_HARDIRQS:
1682 if (!valid_state(curr, this, new_bit, LOCK_USED_IN_HARDIRQ))
1683 return 0;
1684 if (!valid_state(curr, this, new_bit,
1685 LOCK_USED_IN_HARDIRQ_READ))
1686 return 0;
1688 * just marked it hardirq-unsafe, check that no hardirq-safe
1689 * lock in the system ever took it in the past:
1691 if (!check_usage_backwards(curr, this,
1692 LOCK_USED_IN_HARDIRQ, "hard"))
1693 return 0;
1694 #if STRICT_READ_CHECKS
1696 * just marked it hardirq-unsafe, check that no
1697 * hardirq-safe-read lock in the system ever took
1698 * it in the past:
1700 if (!check_usage_backwards(curr, this,
1701 LOCK_USED_IN_HARDIRQ_READ, "hard-read"))
1702 return 0;
1703 #endif
1704 if (hardirq_verbose(this->class))
1705 ret = 2;
1706 break;
1707 case LOCK_ENABLED_SOFTIRQS:
1708 if (!valid_state(curr, this, new_bit, LOCK_USED_IN_SOFTIRQ))
1709 return 0;
1710 if (!valid_state(curr, this, new_bit,
1711 LOCK_USED_IN_SOFTIRQ_READ))
1712 return 0;
1714 * just marked it softirq-unsafe, check that no softirq-safe
1715 * lock in the system ever took it in the past:
1717 if (!check_usage_backwards(curr, this,
1718 LOCK_USED_IN_SOFTIRQ, "soft"))
1719 return 0;
1720 #if STRICT_READ_CHECKS
1722 * just marked it softirq-unsafe, check that no
1723 * softirq-safe-read lock in the system ever took
1724 * it in the past:
1726 if (!check_usage_backwards(curr, this,
1727 LOCK_USED_IN_SOFTIRQ_READ, "soft-read"))
1728 return 0;
1729 #endif
1730 if (softirq_verbose(this->class))
1731 ret = 2;
1732 break;
1733 case LOCK_ENABLED_HARDIRQS_READ:
1734 if (!valid_state(curr, this, new_bit, LOCK_USED_IN_HARDIRQ))
1735 return 0;
1736 #if STRICT_READ_CHECKS
1738 * just marked it hardirq-read-unsafe, check that no
1739 * hardirq-safe lock in the system ever took it in the past:
1741 if (!check_usage_backwards(curr, this,
1742 LOCK_USED_IN_HARDIRQ, "hard"))
1743 return 0;
1744 #endif
1745 if (hardirq_verbose(this->class))
1746 ret = 2;
1747 break;
1748 case LOCK_ENABLED_SOFTIRQS_READ:
1749 if (!valid_state(curr, this, new_bit, LOCK_USED_IN_SOFTIRQ))
1750 return 0;
1751 #if STRICT_READ_CHECKS
1753 * just marked it softirq-read-unsafe, check that no
1754 * softirq-safe lock in the system ever took it in the past:
1756 if (!check_usage_backwards(curr, this,
1757 LOCK_USED_IN_SOFTIRQ, "soft"))
1758 return 0;
1759 #endif
1760 if (softirq_verbose(this->class))
1761 ret = 2;
1762 break;
1763 #endif
1764 case LOCK_USED:
1766 * Add it to the global list of classes:
1768 list_add_tail_rcu(&this->class->lock_entry, &all_lock_classes);
1769 debug_atomic_dec(&nr_unused_locks);
1770 break;
1771 default:
1772 if (!debug_locks_off_graph_unlock())
1773 return 0;
1774 WARN_ON(1);
1775 return 0;
1778 graph_unlock();
1781 * We must printk outside of the graph_lock:
1783 if (ret == 2) {
1784 printk("\nmarked lock as {%s}:\n", usage_str[new_bit]);
1785 print_lock(this);
1786 print_irqtrace_events(curr);
1787 dump_stack();
1790 return ret;
1793 #ifdef CONFIG_TRACE_IRQFLAGS
1795 * Mark all held locks with a usage bit:
1797 static int
1798 mark_held_locks(struct task_struct *curr, int hardirq)
1800 enum lock_usage_bit usage_bit;
1801 struct held_lock *hlock;
1802 int i;
1804 for (i = 0; i < curr->lockdep_depth; i++) {
1805 hlock = curr->held_locks + i;
1807 if (hardirq) {
1808 if (hlock->read)
1809 usage_bit = LOCK_ENABLED_HARDIRQS_READ;
1810 else
1811 usage_bit = LOCK_ENABLED_HARDIRQS;
1812 } else {
1813 if (hlock->read)
1814 usage_bit = LOCK_ENABLED_SOFTIRQS_READ;
1815 else
1816 usage_bit = LOCK_ENABLED_SOFTIRQS;
1818 if (!mark_lock(curr, hlock, usage_bit))
1819 return 0;
1822 return 1;
1826 * Debugging helper: via this flag we know that we are in
1827 * 'early bootup code', and will warn about any invalid irqs-on event:
1829 static int early_boot_irqs_enabled;
1831 void early_boot_irqs_off(void)
1833 early_boot_irqs_enabled = 0;
1836 void early_boot_irqs_on(void)
1838 early_boot_irqs_enabled = 1;
1842 * Hardirqs will be enabled:
1844 void trace_hardirqs_on(void)
1846 struct task_struct *curr = current;
1847 unsigned long ip;
1849 if (unlikely(!debug_locks || current->lockdep_recursion))
1850 return;
1852 if (DEBUG_LOCKS_WARN_ON(unlikely(!early_boot_irqs_enabled)))
1853 return;
1855 if (unlikely(curr->hardirqs_enabled)) {
1856 debug_atomic_inc(&redundant_hardirqs_on);
1857 return;
1859 /* we'll do an OFF -> ON transition: */
1860 curr->hardirqs_enabled = 1;
1861 ip = (unsigned long) __builtin_return_address(0);
1863 if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
1864 return;
1865 if (DEBUG_LOCKS_WARN_ON(current->hardirq_context))
1866 return;
1868 * We are going to turn hardirqs on, so set the
1869 * usage bit for all held locks:
1871 if (!mark_held_locks(curr, 1))
1872 return;
1874 * If we have softirqs enabled, then set the usage
1875 * bit for all held locks. (disabled hardirqs prevented
1876 * this bit from being set before)
1878 if (curr->softirqs_enabled)
1879 if (!mark_held_locks(curr, 0))
1880 return;
1882 curr->hardirq_enable_ip = ip;
1883 curr->hardirq_enable_event = ++curr->irq_events;
1884 debug_atomic_inc(&hardirqs_on_events);
1887 EXPORT_SYMBOL(trace_hardirqs_on);
1890 * Hardirqs were disabled:
1892 void trace_hardirqs_off(void)
1894 struct task_struct *curr = current;
1896 if (unlikely(!debug_locks || current->lockdep_recursion))
1897 return;
1899 if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
1900 return;
1902 if (curr->hardirqs_enabled) {
1904 * We have done an ON -> OFF transition:
1906 curr->hardirqs_enabled = 0;
1907 curr->hardirq_disable_ip = _RET_IP_;
1908 curr->hardirq_disable_event = ++curr->irq_events;
1909 debug_atomic_inc(&hardirqs_off_events);
1910 } else
1911 debug_atomic_inc(&redundant_hardirqs_off);
1914 EXPORT_SYMBOL(trace_hardirqs_off);
1917 * Softirqs will be enabled:
1919 void trace_softirqs_on(unsigned long ip)
1921 struct task_struct *curr = current;
1923 if (unlikely(!debug_locks))
1924 return;
1926 if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
1927 return;
1929 if (curr->softirqs_enabled) {
1930 debug_atomic_inc(&redundant_softirqs_on);
1931 return;
1935 * We'll do an OFF -> ON transition:
1937 curr->softirqs_enabled = 1;
1938 curr->softirq_enable_ip = ip;
1939 curr->softirq_enable_event = ++curr->irq_events;
1940 debug_atomic_inc(&softirqs_on_events);
1942 * We are going to turn softirqs on, so set the
1943 * usage bit for all held locks, if hardirqs are
1944 * enabled too:
1946 if (curr->hardirqs_enabled)
1947 mark_held_locks(curr, 0);
1951 * Softirqs were disabled:
1953 void trace_softirqs_off(unsigned long ip)
1955 struct task_struct *curr = current;
1957 if (unlikely(!debug_locks))
1958 return;
1960 if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
1961 return;
1963 if (curr->softirqs_enabled) {
1965 * We have done an ON -> OFF transition:
1967 curr->softirqs_enabled = 0;
1968 curr->softirq_disable_ip = ip;
1969 curr->softirq_disable_event = ++curr->irq_events;
1970 debug_atomic_inc(&softirqs_off_events);
1971 DEBUG_LOCKS_WARN_ON(!softirq_count());
1972 } else
1973 debug_atomic_inc(&redundant_softirqs_off);
1976 #endif
1979 * Initialize a lock instance's lock-class mapping info:
1981 void lockdep_init_map(struct lockdep_map *lock, const char *name,
1982 struct lock_class_key *key, int subclass)
1984 if (unlikely(!debug_locks))
1985 return;
1987 if (DEBUG_LOCKS_WARN_ON(!key))
1988 return;
1989 if (DEBUG_LOCKS_WARN_ON(!name))
1990 return;
1992 * Sanity check, the lock-class key must be persistent:
1994 if (!static_obj(key)) {
1995 printk("BUG: key %p not in .data!\n", key);
1996 DEBUG_LOCKS_WARN_ON(1);
1997 return;
1999 lock->name = name;
2000 lock->key = key;
2001 lock->class_cache = NULL;
2002 if (subclass)
2003 register_lock_class(lock, subclass, 1);
2006 EXPORT_SYMBOL_GPL(lockdep_init_map);
2009 * This gets called for every mutex_lock*()/spin_lock*() operation.
2010 * We maintain the dependency maps and validate the locking attempt:
2012 static int __lock_acquire(struct lockdep_map *lock, unsigned int subclass,
2013 int trylock, int read, int check, int hardirqs_off,
2014 unsigned long ip)
2016 struct task_struct *curr = current;
2017 struct lock_class *class = NULL;
2018 struct held_lock *hlock;
2019 unsigned int depth, id;
2020 int chain_head = 0;
2021 u64 chain_key;
2023 if (unlikely(!debug_locks))
2024 return 0;
2026 if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
2027 return 0;
2029 if (unlikely(subclass >= MAX_LOCKDEP_SUBCLASSES)) {
2030 debug_locks_off();
2031 printk("BUG: MAX_LOCKDEP_SUBCLASSES too low!\n");
2032 printk("turning off the locking correctness validator.\n");
2033 return 0;
2036 if (!subclass)
2037 class = lock->class_cache;
2039 * Not cached yet or subclass?
2041 if (unlikely(!class)) {
2042 class = register_lock_class(lock, subclass, 0);
2043 if (!class)
2044 return 0;
2046 debug_atomic_inc((atomic_t *)&class->ops);
2047 if (very_verbose(class)) {
2048 printk("\nacquire class [%p] %s", class->key, class->name);
2049 if (class->name_version > 1)
2050 printk("#%d", class->name_version);
2051 printk("\n");
2052 dump_stack();
2056 * Add the lock to the list of currently held locks.
2057 * (we dont increase the depth just yet, up until the
2058 * dependency checks are done)
2060 depth = curr->lockdep_depth;
2061 if (DEBUG_LOCKS_WARN_ON(depth >= MAX_LOCK_DEPTH))
2062 return 0;
2064 hlock = curr->held_locks + depth;
2066 hlock->class = class;
2067 hlock->acquire_ip = ip;
2068 hlock->instance = lock;
2069 hlock->trylock = trylock;
2070 hlock->read = read;
2071 hlock->check = check;
2072 hlock->hardirqs_off = hardirqs_off;
2074 if (check != 2)
2075 goto out_calc_hash;
2076 #ifdef CONFIG_TRACE_IRQFLAGS
2078 * If non-trylock use in a hardirq or softirq context, then
2079 * mark the lock as used in these contexts:
2081 if (!trylock) {
2082 if (read) {
2083 if (curr->hardirq_context)
2084 if (!mark_lock(curr, hlock,
2085 LOCK_USED_IN_HARDIRQ_READ))
2086 return 0;
2087 if (curr->softirq_context)
2088 if (!mark_lock(curr, hlock,
2089 LOCK_USED_IN_SOFTIRQ_READ))
2090 return 0;
2091 } else {
2092 if (curr->hardirq_context)
2093 if (!mark_lock(curr, hlock, LOCK_USED_IN_HARDIRQ))
2094 return 0;
2095 if (curr->softirq_context)
2096 if (!mark_lock(curr, hlock, LOCK_USED_IN_SOFTIRQ))
2097 return 0;
2100 if (!hardirqs_off) {
2101 if (read) {
2102 if (!mark_lock(curr, hlock,
2103 LOCK_ENABLED_HARDIRQS_READ))
2104 return 0;
2105 if (curr->softirqs_enabled)
2106 if (!mark_lock(curr, hlock,
2107 LOCK_ENABLED_SOFTIRQS_READ))
2108 return 0;
2109 } else {
2110 if (!mark_lock(curr, hlock,
2111 LOCK_ENABLED_HARDIRQS))
2112 return 0;
2113 if (curr->softirqs_enabled)
2114 if (!mark_lock(curr, hlock,
2115 LOCK_ENABLED_SOFTIRQS))
2116 return 0;
2119 #endif
2120 /* mark it as used: */
2121 if (!mark_lock(curr, hlock, LOCK_USED))
2122 return 0;
2123 out_calc_hash:
2125 * Calculate the chain hash: it's the combined has of all the
2126 * lock keys along the dependency chain. We save the hash value
2127 * at every step so that we can get the current hash easily
2128 * after unlock. The chain hash is then used to cache dependency
2129 * results.
2131 * The 'key ID' is what is the most compact key value to drive
2132 * the hash, not class->key.
2134 id = class - lock_classes;
2135 if (DEBUG_LOCKS_WARN_ON(id >= MAX_LOCKDEP_KEYS))
2136 return 0;
2138 chain_key = curr->curr_chain_key;
2139 if (!depth) {
2140 if (DEBUG_LOCKS_WARN_ON(chain_key != 0))
2141 return 0;
2142 chain_head = 1;
2145 hlock->prev_chain_key = chain_key;
2147 #ifdef CONFIG_TRACE_IRQFLAGS
2149 * Keep track of points where we cross into an interrupt context:
2151 hlock->irq_context = 2*(curr->hardirq_context ? 1 : 0) +
2152 curr->softirq_context;
2153 if (depth) {
2154 struct held_lock *prev_hlock;
2156 prev_hlock = curr->held_locks + depth-1;
2158 * If we cross into another context, reset the
2159 * hash key (this also prevents the checking and the
2160 * adding of the dependency to 'prev'):
2162 if (prev_hlock->irq_context != hlock->irq_context) {
2163 chain_key = 0;
2164 chain_head = 1;
2167 #endif
2168 chain_key = iterate_chain_key(chain_key, id);
2169 curr->curr_chain_key = chain_key;
2172 * Trylock needs to maintain the stack of held locks, but it
2173 * does not add new dependencies, because trylock can be done
2174 * in any order.
2176 * We look up the chain_key and do the O(N^2) check and update of
2177 * the dependencies only if this is a new dependency chain.
2178 * (If lookup_chain_cache() returns with 1 it acquires
2179 * graph_lock for us)
2181 if (!trylock && (check == 2) && lookup_chain_cache(chain_key, class)) {
2183 * Check whether last held lock:
2185 * - is irq-safe, if this lock is irq-unsafe
2186 * - is softirq-safe, if this lock is hardirq-unsafe
2188 * And check whether the new lock's dependency graph
2189 * could lead back to the previous lock.
2191 * any of these scenarios could lead to a deadlock. If
2192 * All validations
2194 int ret = check_deadlock(curr, hlock, lock, read);
2196 if (!ret)
2197 return 0;
2199 * Mark recursive read, as we jump over it when
2200 * building dependencies (just like we jump over
2201 * trylock entries):
2203 if (ret == 2)
2204 hlock->read = 2;
2206 * Add dependency only if this lock is not the head
2207 * of the chain, and if it's not a secondary read-lock:
2209 if (!chain_head && ret != 2)
2210 if (!check_prevs_add(curr, hlock))
2211 return 0;
2212 graph_unlock();
2213 } else
2214 /* after lookup_chain_cache(): */
2215 if (unlikely(!debug_locks))
2216 return 0;
2218 curr->lockdep_depth++;
2219 check_chain_key(curr);
2220 #ifdef CONFIG_DEBUG_LOCKDEP
2221 if (unlikely(!debug_locks))
2222 return 0;
2223 #endif
2224 if (unlikely(curr->lockdep_depth >= MAX_LOCK_DEPTH)) {
2225 debug_locks_off();
2226 printk("BUG: MAX_LOCK_DEPTH too low!\n");
2227 printk("turning off the locking correctness validator.\n");
2228 return 0;
2231 if (unlikely(curr->lockdep_depth > max_lockdep_depth))
2232 max_lockdep_depth = curr->lockdep_depth;
2234 return 1;
2237 static int
2238 print_unlock_inbalance_bug(struct task_struct *curr, struct lockdep_map *lock,
2239 unsigned long ip)
2241 if (!debug_locks_off())
2242 return 0;
2243 if (debug_locks_silent)
2244 return 0;
2246 printk("\n=====================================\n");
2247 printk( "[ BUG: bad unlock balance detected! ]\n");
2248 printk( "-------------------------------------\n");
2249 printk("%s/%d is trying to release lock (",
2250 curr->comm, curr->pid);
2251 print_lockdep_cache(lock);
2252 printk(") at:\n");
2253 print_ip_sym(ip);
2254 printk("but there are no more locks to release!\n");
2255 printk("\nother info that might help us debug this:\n");
2256 lockdep_print_held_locks(curr);
2258 printk("\nstack backtrace:\n");
2259 dump_stack();
2261 return 0;
2265 * Common debugging checks for both nested and non-nested unlock:
2267 static int check_unlock(struct task_struct *curr, struct lockdep_map *lock,
2268 unsigned long ip)
2270 if (unlikely(!debug_locks))
2271 return 0;
2272 if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
2273 return 0;
2275 if (curr->lockdep_depth <= 0)
2276 return print_unlock_inbalance_bug(curr, lock, ip);
2278 return 1;
2282 * Remove the lock to the list of currently held locks in a
2283 * potentially non-nested (out of order) manner. This is a
2284 * relatively rare operation, as all the unlock APIs default
2285 * to nested mode (which uses lock_release()):
2287 static int
2288 lock_release_non_nested(struct task_struct *curr,
2289 struct lockdep_map *lock, unsigned long ip)
2291 struct held_lock *hlock, *prev_hlock;
2292 unsigned int depth;
2293 int i;
2296 * Check whether the lock exists in the current stack
2297 * of held locks:
2299 depth = curr->lockdep_depth;
2300 if (DEBUG_LOCKS_WARN_ON(!depth))
2301 return 0;
2303 prev_hlock = NULL;
2304 for (i = depth-1; i >= 0; i--) {
2305 hlock = curr->held_locks + i;
2307 * We must not cross into another context:
2309 if (prev_hlock && prev_hlock->irq_context != hlock->irq_context)
2310 break;
2311 if (hlock->instance == lock)
2312 goto found_it;
2313 prev_hlock = hlock;
2315 return print_unlock_inbalance_bug(curr, lock, ip);
2317 found_it:
2319 * We have the right lock to unlock, 'hlock' points to it.
2320 * Now we remove it from the stack, and add back the other
2321 * entries (if any), recalculating the hash along the way:
2323 curr->lockdep_depth = i;
2324 curr->curr_chain_key = hlock->prev_chain_key;
2326 for (i++; i < depth; i++) {
2327 hlock = curr->held_locks + i;
2328 if (!__lock_acquire(hlock->instance,
2329 hlock->class->subclass, hlock->trylock,
2330 hlock->read, hlock->check, hlock->hardirqs_off,
2331 hlock->acquire_ip))
2332 return 0;
2335 if (DEBUG_LOCKS_WARN_ON(curr->lockdep_depth != depth - 1))
2336 return 0;
2337 return 1;
2341 * Remove the lock to the list of currently held locks - this gets
2342 * called on mutex_unlock()/spin_unlock*() (or on a failed
2343 * mutex_lock_interruptible()). This is done for unlocks that nest
2344 * perfectly. (i.e. the current top of the lock-stack is unlocked)
2346 static int lock_release_nested(struct task_struct *curr,
2347 struct lockdep_map *lock, unsigned long ip)
2349 struct held_lock *hlock;
2350 unsigned int depth;
2353 * Pop off the top of the lock stack:
2355 depth = curr->lockdep_depth - 1;
2356 hlock = curr->held_locks + depth;
2359 * Is the unlock non-nested:
2361 if (hlock->instance != lock)
2362 return lock_release_non_nested(curr, lock, ip);
2363 curr->lockdep_depth--;
2365 if (DEBUG_LOCKS_WARN_ON(!depth && (hlock->prev_chain_key != 0)))
2366 return 0;
2368 curr->curr_chain_key = hlock->prev_chain_key;
2370 #ifdef CONFIG_DEBUG_LOCKDEP
2371 hlock->prev_chain_key = 0;
2372 hlock->class = NULL;
2373 hlock->acquire_ip = 0;
2374 hlock->irq_context = 0;
2375 #endif
2376 return 1;
2380 * Remove the lock to the list of currently held locks - this gets
2381 * called on mutex_unlock()/spin_unlock*() (or on a failed
2382 * mutex_lock_interruptible()). This is done for unlocks that nest
2383 * perfectly. (i.e. the current top of the lock-stack is unlocked)
2385 static void
2386 __lock_release(struct lockdep_map *lock, int nested, unsigned long ip)
2388 struct task_struct *curr = current;
2390 if (!check_unlock(curr, lock, ip))
2391 return;
2393 if (nested) {
2394 if (!lock_release_nested(curr, lock, ip))
2395 return;
2396 } else {
2397 if (!lock_release_non_nested(curr, lock, ip))
2398 return;
2401 check_chain_key(curr);
2405 * Check whether we follow the irq-flags state precisely:
2407 static void check_flags(unsigned long flags)
2409 #if defined(CONFIG_DEBUG_LOCKDEP) && defined(CONFIG_TRACE_IRQFLAGS)
2410 if (!debug_locks)
2411 return;
2413 if (irqs_disabled_flags(flags))
2414 DEBUG_LOCKS_WARN_ON(current->hardirqs_enabled);
2415 else
2416 DEBUG_LOCKS_WARN_ON(!current->hardirqs_enabled);
2419 * We dont accurately track softirq state in e.g.
2420 * hardirq contexts (such as on 4KSTACKS), so only
2421 * check if not in hardirq contexts:
2423 if (!hardirq_count()) {
2424 if (softirq_count())
2425 DEBUG_LOCKS_WARN_ON(current->softirqs_enabled);
2426 else
2427 DEBUG_LOCKS_WARN_ON(!current->softirqs_enabled);
2430 if (!debug_locks)
2431 print_irqtrace_events(current);
2432 #endif
2436 * We are not always called with irqs disabled - do that here,
2437 * and also avoid lockdep recursion:
2439 void lock_acquire(struct lockdep_map *lock, unsigned int subclass,
2440 int trylock, int read, int check, unsigned long ip)
2442 unsigned long flags;
2444 if (unlikely(current->lockdep_recursion))
2445 return;
2447 raw_local_irq_save(flags);
2448 check_flags(flags);
2450 current->lockdep_recursion = 1;
2451 __lock_acquire(lock, subclass, trylock, read, check,
2452 irqs_disabled_flags(flags), ip);
2453 current->lockdep_recursion = 0;
2454 raw_local_irq_restore(flags);
2457 EXPORT_SYMBOL_GPL(lock_acquire);
2459 void lock_release(struct lockdep_map *lock, int nested, unsigned long ip)
2461 unsigned long flags;
2463 if (unlikely(current->lockdep_recursion))
2464 return;
2466 raw_local_irq_save(flags);
2467 check_flags(flags);
2468 current->lockdep_recursion = 1;
2469 __lock_release(lock, nested, ip);
2470 current->lockdep_recursion = 0;
2471 raw_local_irq_restore(flags);
2474 EXPORT_SYMBOL_GPL(lock_release);
2477 * Used by the testsuite, sanitize the validator state
2478 * after a simulated failure:
2481 void lockdep_reset(void)
2483 unsigned long flags;
2484 int i;
2486 raw_local_irq_save(flags);
2487 current->curr_chain_key = 0;
2488 current->lockdep_depth = 0;
2489 current->lockdep_recursion = 0;
2490 memset(current->held_locks, 0, MAX_LOCK_DEPTH*sizeof(struct held_lock));
2491 nr_hardirq_chains = 0;
2492 nr_softirq_chains = 0;
2493 nr_process_chains = 0;
2494 debug_locks = 1;
2495 for (i = 0; i < CHAINHASH_SIZE; i++)
2496 INIT_LIST_HEAD(chainhash_table + i);
2497 raw_local_irq_restore(flags);
2500 static void zap_class(struct lock_class *class)
2502 int i;
2505 * Remove all dependencies this lock is
2506 * involved in:
2508 for (i = 0; i < nr_list_entries; i++) {
2509 if (list_entries[i].class == class)
2510 list_del_rcu(&list_entries[i].entry);
2513 * Unhash the class and remove it from the all_lock_classes list:
2515 list_del_rcu(&class->hash_entry);
2516 list_del_rcu(&class->lock_entry);
2520 static inline int within(void *addr, void *start, unsigned long size)
2522 return addr >= start && addr < start + size;
2525 void lockdep_free_key_range(void *start, unsigned long size)
2527 struct lock_class *class, *next;
2528 struct list_head *head;
2529 unsigned long flags;
2530 int i;
2532 raw_local_irq_save(flags);
2533 graph_lock();
2536 * Unhash all classes that were created by this module:
2538 for (i = 0; i < CLASSHASH_SIZE; i++) {
2539 head = classhash_table + i;
2540 if (list_empty(head))
2541 continue;
2542 list_for_each_entry_safe(class, next, head, hash_entry)
2543 if (within(class->key, start, size))
2544 zap_class(class);
2547 graph_unlock();
2548 raw_local_irq_restore(flags);
2551 void lockdep_reset_lock(struct lockdep_map *lock)
2553 struct lock_class *class, *next;
2554 struct list_head *head;
2555 unsigned long flags;
2556 int i, j;
2558 raw_local_irq_save(flags);
2561 * Remove all classes this lock might have:
2563 for (j = 0; j < MAX_LOCKDEP_SUBCLASSES; j++) {
2565 * If the class exists we look it up and zap it:
2567 class = look_up_lock_class(lock, j);
2568 if (class)
2569 zap_class(class);
2572 * Debug check: in the end all mapped classes should
2573 * be gone.
2575 graph_lock();
2576 for (i = 0; i < CLASSHASH_SIZE; i++) {
2577 head = classhash_table + i;
2578 if (list_empty(head))
2579 continue;
2580 list_for_each_entry_safe(class, next, head, hash_entry) {
2581 if (unlikely(class == lock->class_cache)) {
2582 if (debug_locks_off_graph_unlock())
2583 WARN_ON(1);
2584 goto out_restore;
2588 graph_unlock();
2590 out_restore:
2591 raw_local_irq_restore(flags);
2594 void lockdep_init(void)
2596 int i;
2599 * Some architectures have their own start_kernel()
2600 * code which calls lockdep_init(), while we also
2601 * call lockdep_init() from the start_kernel() itself,
2602 * and we want to initialize the hashes only once:
2604 if (lockdep_initialized)
2605 return;
2607 for (i = 0; i < CLASSHASH_SIZE; i++)
2608 INIT_LIST_HEAD(classhash_table + i);
2610 for (i = 0; i < CHAINHASH_SIZE; i++)
2611 INIT_LIST_HEAD(chainhash_table + i);
2613 lockdep_initialized = 1;
2616 void __init lockdep_info(void)
2618 printk("Lock dependency validator: Copyright (c) 2006 Red Hat, Inc., Ingo Molnar\n");
2620 printk("... MAX_LOCKDEP_SUBCLASSES: %lu\n", MAX_LOCKDEP_SUBCLASSES);
2621 printk("... MAX_LOCK_DEPTH: %lu\n", MAX_LOCK_DEPTH);
2622 printk("... MAX_LOCKDEP_KEYS: %lu\n", MAX_LOCKDEP_KEYS);
2623 printk("... CLASSHASH_SIZE: %lu\n", CLASSHASH_SIZE);
2624 printk("... MAX_LOCKDEP_ENTRIES: %lu\n", MAX_LOCKDEP_ENTRIES);
2625 printk("... MAX_LOCKDEP_CHAINS: %lu\n", MAX_LOCKDEP_CHAINS);
2626 printk("... CHAINHASH_SIZE: %lu\n", CHAINHASH_SIZE);
2628 printk(" memory used by lock dependency info: %lu kB\n",
2629 (sizeof(struct lock_class) * MAX_LOCKDEP_KEYS +
2630 sizeof(struct list_head) * CLASSHASH_SIZE +
2631 sizeof(struct lock_list) * MAX_LOCKDEP_ENTRIES +
2632 sizeof(struct lock_chain) * MAX_LOCKDEP_CHAINS +
2633 sizeof(struct list_head) * CHAINHASH_SIZE) / 1024);
2635 printk(" per task-struct memory footprint: %lu bytes\n",
2636 sizeof(struct held_lock) * MAX_LOCK_DEPTH);
2638 #ifdef CONFIG_DEBUG_LOCKDEP
2639 if (lockdep_init_error)
2640 printk("WARNING: lockdep init error! Arch code didnt call lockdep_init() early enough?\n");
2641 #endif
2644 static inline int in_range(const void *start, const void *addr, const void *end)
2646 return addr >= start && addr <= end;
2649 static void
2650 print_freed_lock_bug(struct task_struct *curr, const void *mem_from,
2651 const void *mem_to, struct held_lock *hlock)
2653 if (!debug_locks_off())
2654 return;
2655 if (debug_locks_silent)
2656 return;
2658 printk("\n=========================\n");
2659 printk( "[ BUG: held lock freed! ]\n");
2660 printk( "-------------------------\n");
2661 printk("%s/%d is freeing memory %p-%p, with a lock still held there!\n",
2662 curr->comm, curr->pid, mem_from, mem_to-1);
2663 print_lock(hlock);
2664 lockdep_print_held_locks(curr);
2666 printk("\nstack backtrace:\n");
2667 dump_stack();
2671 * Called when kernel memory is freed (or unmapped), or if a lock
2672 * is destroyed or reinitialized - this code checks whether there is
2673 * any held lock in the memory range of <from> to <to>:
2675 void debug_check_no_locks_freed(const void *mem_from, unsigned long mem_len)
2677 const void *mem_to = mem_from + mem_len, *lock_from, *lock_to;
2678 struct task_struct *curr = current;
2679 struct held_lock *hlock;
2680 unsigned long flags;
2681 int i;
2683 if (unlikely(!debug_locks))
2684 return;
2686 local_irq_save(flags);
2687 for (i = 0; i < curr->lockdep_depth; i++) {
2688 hlock = curr->held_locks + i;
2690 lock_from = (void *)hlock->instance;
2691 lock_to = (void *)(hlock->instance + 1);
2693 if (!in_range(mem_from, lock_from, mem_to) &&
2694 !in_range(mem_from, lock_to, mem_to))
2695 continue;
2697 print_freed_lock_bug(curr, mem_from, mem_to, hlock);
2698 break;
2700 local_irq_restore(flags);
2702 EXPORT_SYMBOL_GPL(debug_check_no_locks_freed);
2704 static void print_held_locks_bug(struct task_struct *curr)
2706 if (!debug_locks_off())
2707 return;
2708 if (debug_locks_silent)
2709 return;
2711 printk("\n=====================================\n");
2712 printk( "[ BUG: lock held at task exit time! ]\n");
2713 printk( "-------------------------------------\n");
2714 printk("%s/%d is exiting with locks still held!\n",
2715 curr->comm, curr->pid);
2716 lockdep_print_held_locks(curr);
2718 printk("\nstack backtrace:\n");
2719 dump_stack();
2722 void debug_check_no_locks_held(struct task_struct *task)
2724 if (unlikely(task->lockdep_depth > 0))
2725 print_held_locks_bug(task);
2728 void debug_show_all_locks(void)
2730 struct task_struct *g, *p;
2731 int count = 10;
2732 int unlock = 1;
2734 if (unlikely(!debug_locks)) {
2735 printk("INFO: lockdep is turned off.\n");
2736 return;
2738 printk("\nShowing all locks held in the system:\n");
2741 * Here we try to get the tasklist_lock as hard as possible,
2742 * if not successful after 2 seconds we ignore it (but keep
2743 * trying). This is to enable a debug printout even if a
2744 * tasklist_lock-holding task deadlocks or crashes.
2746 retry:
2747 if (!read_trylock(&tasklist_lock)) {
2748 if (count == 10)
2749 printk("hm, tasklist_lock locked, retrying... ");
2750 if (count) {
2751 count--;
2752 printk(" #%d", 10-count);
2753 mdelay(200);
2754 goto retry;
2756 printk(" ignoring it.\n");
2757 unlock = 0;
2759 if (count != 10)
2760 printk(" locked it.\n");
2762 do_each_thread(g, p) {
2763 if (p->lockdep_depth)
2764 lockdep_print_held_locks(p);
2765 if (!unlock)
2766 if (read_trylock(&tasklist_lock))
2767 unlock = 1;
2768 } while_each_thread(g, p);
2770 printk("\n");
2771 printk("=============================================\n\n");
2773 if (unlock)
2774 read_unlock(&tasklist_lock);
2777 EXPORT_SYMBOL_GPL(debug_show_all_locks);
2779 void debug_show_held_locks(struct task_struct *task)
2781 if (unlikely(!debug_locks)) {
2782 printk("INFO: lockdep is turned off.\n");
2783 return;
2785 lockdep_print_held_locks(task);
2788 EXPORT_SYMBOL_GPL(debug_show_held_locks);