4 * Runtime locking correctness validator
6 * Started by Ingo Molnar:
8 * Copyright (C) 2006,2007 Red Hat, Inc., Ingo Molnar <mingo@redhat.com>
9 * Copyright (C) 2007 Red Hat, Inc., Peter Zijlstra <pzijlstr@redhat.com>
11 * this code maps all the lock dependencies as they occur in a live kernel
12 * and will warn about the following classes of locking bugs:
14 * - lock inversion scenarios
15 * - circular lock dependencies
16 * - hardirq/softirq safe/unsafe locking bugs
18 * Bugs are reported even if the current locking scenario does not cause
19 * any deadlock at this point.
21 * I.e. if anytime in the past two locks were taken in a different order,
22 * even if it happened for another task, even if those were different
23 * locks (but of the same class as this lock), this code will detect it.
25 * Thanks to Arjan van de Ven for coming up with the initial idea of
26 * mapping lock dependencies runtime.
28 #define DISABLE_BRANCH_PROFILING
29 #include <linux/mutex.h>
30 #include <linux/sched.h>
31 #include <linux/delay.h>
32 #include <linux/module.h>
33 #include <linux/proc_fs.h>
34 #include <linux/seq_file.h>
35 #include <linux/spinlock.h>
36 #include <linux/kallsyms.h>
37 #include <linux/interrupt.h>
38 #include <linux/stacktrace.h>
39 #include <linux/debug_locks.h>
40 #include <linux/irqflags.h>
41 #include <linux/utsname.h>
42 #include <linux/hash.h>
43 #include <linux/ftrace.h>
44 #include <linux/stringify.h>
45 #include <trace/lockdep.h>
47 #include <asm/sections.h>
49 #include "lockdep_internals.h"
51 #ifdef CONFIG_PROVE_LOCKING
52 int prove_locking = 1;
53 module_param(prove_locking, int, 0644);
55 #define prove_locking 0
58 #ifdef CONFIG_LOCK_STAT
60 module_param(lock_stat, int, 0644);
66 * lockdep_lock: protects the lockdep graph, the hashes and the
67 * class/list/hash allocators.
69 * This is one of the rare exceptions where it's justified
70 * to use a raw spinlock - we really dont want the spinlock
71 * code to recurse back into the lockdep code...
73 static raw_spinlock_t lockdep_lock = (raw_spinlock_t)__RAW_SPIN_LOCK_UNLOCKED;
75 static int graph_lock(void)
77 __raw_spin_lock(&lockdep_lock);
79 * Make sure that if another CPU detected a bug while
80 * walking the graph we dont change it (while the other
81 * CPU is busy printing out stuff with the graph lock
85 __raw_spin_unlock(&lockdep_lock);
88 /* prevent any recursions within lockdep from causing deadlocks */
89 current->lockdep_recursion++;
93 static inline int graph_unlock(void)
95 if (debug_locks && !__raw_spin_is_locked(&lockdep_lock))
96 return DEBUG_LOCKS_WARN_ON(1);
98 current->lockdep_recursion--;
99 __raw_spin_unlock(&lockdep_lock);
104 * Turn lock debugging off and return with 0 if it was off already,
105 * and also release the graph lock:
107 static inline int debug_locks_off_graph_unlock(void)
109 int ret = debug_locks_off();
111 __raw_spin_unlock(&lockdep_lock);
116 static int lockdep_initialized;
118 unsigned long nr_list_entries;
119 static struct lock_list list_entries[MAX_LOCKDEP_ENTRIES];
122 * All data structures here are protected by the global debug_lock.
124 * Mutex key structs only get allocated, once during bootup, and never
125 * get freed - this significantly simplifies the debugging code.
127 unsigned long nr_lock_classes;
128 static struct lock_class lock_classes[MAX_LOCKDEP_KEYS];
130 static inline struct lock_class *hlock_class(struct held_lock *hlock)
132 if (!hlock->class_idx) {
133 DEBUG_LOCKS_WARN_ON(1);
136 return lock_classes + hlock->class_idx - 1;
139 #ifdef CONFIG_LOCK_STAT
140 static DEFINE_PER_CPU(struct lock_class_stats[MAX_LOCKDEP_KEYS], lock_stats);
142 static int lock_point(unsigned long points[], unsigned long ip)
146 for (i = 0; i < LOCKSTAT_POINTS; i++) {
147 if (points[i] == 0) {
158 static void lock_time_inc(struct lock_time *lt, s64 time)
163 if (time < lt->min || !lt->min)
170 static inline void lock_time_add(struct lock_time *src, struct lock_time *dst)
172 dst->min += src->min;
173 dst->max += src->max;
174 dst->total += src->total;
178 struct lock_class_stats lock_stats(struct lock_class *class)
180 struct lock_class_stats stats;
183 memset(&stats, 0, sizeof(struct lock_class_stats));
184 for_each_possible_cpu(cpu) {
185 struct lock_class_stats *pcs =
186 &per_cpu(lock_stats, cpu)[class - lock_classes];
188 for (i = 0; i < ARRAY_SIZE(stats.contention_point); i++)
189 stats.contention_point[i] += pcs->contention_point[i];
191 for (i = 0; i < ARRAY_SIZE(stats.contending_point); i++)
192 stats.contending_point[i] += pcs->contending_point[i];
194 lock_time_add(&pcs->read_waittime, &stats.read_waittime);
195 lock_time_add(&pcs->write_waittime, &stats.write_waittime);
197 lock_time_add(&pcs->read_holdtime, &stats.read_holdtime);
198 lock_time_add(&pcs->write_holdtime, &stats.write_holdtime);
200 for (i = 0; i < ARRAY_SIZE(stats.bounces); i++)
201 stats.bounces[i] += pcs->bounces[i];
207 void clear_lock_stats(struct lock_class *class)
211 for_each_possible_cpu(cpu) {
212 struct lock_class_stats *cpu_stats =
213 &per_cpu(lock_stats, cpu)[class - lock_classes];
215 memset(cpu_stats, 0, sizeof(struct lock_class_stats));
217 memset(class->contention_point, 0, sizeof(class->contention_point));
218 memset(class->contending_point, 0, sizeof(class->contending_point));
221 static struct lock_class_stats *get_lock_stats(struct lock_class *class)
223 return &get_cpu_var(lock_stats)[class - lock_classes];
226 static void put_lock_stats(struct lock_class_stats *stats)
228 put_cpu_var(lock_stats);
231 static void lock_release_holdtime(struct held_lock *hlock)
233 struct lock_class_stats *stats;
239 holdtime = sched_clock() - hlock->holdtime_stamp;
241 stats = get_lock_stats(hlock_class(hlock));
243 lock_time_inc(&stats->read_holdtime, holdtime);
245 lock_time_inc(&stats->write_holdtime, holdtime);
246 put_lock_stats(stats);
249 static inline void lock_release_holdtime(struct held_lock *hlock)
255 * We keep a global list of all lock classes. The list only grows,
256 * never shrinks. The list is only accessed with the lockdep
257 * spinlock lock held.
259 LIST_HEAD(all_lock_classes);
262 * The lockdep classes are in a hash-table as well, for fast lookup:
264 #define CLASSHASH_BITS (MAX_LOCKDEP_KEYS_BITS - 1)
265 #define CLASSHASH_SIZE (1UL << CLASSHASH_BITS)
266 #define __classhashfn(key) hash_long((unsigned long)key, CLASSHASH_BITS)
267 #define classhashentry(key) (classhash_table + __classhashfn((key)))
269 static struct list_head classhash_table[CLASSHASH_SIZE];
272 * We put the lock dependency chains into a hash-table as well, to cache
275 #define CHAINHASH_BITS (MAX_LOCKDEP_CHAINS_BITS-1)
276 #define CHAINHASH_SIZE (1UL << CHAINHASH_BITS)
277 #define __chainhashfn(chain) hash_long(chain, CHAINHASH_BITS)
278 #define chainhashentry(chain) (chainhash_table + __chainhashfn((chain)))
280 static struct list_head chainhash_table[CHAINHASH_SIZE];
283 * The hash key of the lock dependency chains is a hash itself too:
284 * it's a hash of all locks taken up to that lock, including that lock.
285 * It's a 64-bit hash, because it's important for the keys to be
288 #define iterate_chain_key(key1, key2) \
289 (((key1) << MAX_LOCKDEP_KEYS_BITS) ^ \
290 ((key1) >> (64-MAX_LOCKDEP_KEYS_BITS)) ^ \
293 void lockdep_off(void)
295 current->lockdep_recursion++;
297 EXPORT_SYMBOL(lockdep_off);
299 void lockdep_on(void)
301 current->lockdep_recursion--;
303 EXPORT_SYMBOL(lockdep_on);
306 * Debugging switches:
310 #define VERY_VERBOSE 0
313 # define HARDIRQ_VERBOSE 1
314 # define SOFTIRQ_VERBOSE 1
315 # define RECLAIM_VERBOSE 1
317 # define HARDIRQ_VERBOSE 0
318 # define SOFTIRQ_VERBOSE 0
319 # define RECLAIM_VERBOSE 0
322 #if VERBOSE || HARDIRQ_VERBOSE || SOFTIRQ_VERBOSE || RECLAIM_VERBOSE
324 * Quick filtering for interesting events:
326 static int class_filter(struct lock_class *class)
330 if (class->name_version == 1 &&
331 !strcmp(class->name, "lockname"))
333 if (class->name_version == 1 &&
334 !strcmp(class->name, "&struct->lockfield"))
337 /* Filter everything else. 1 would be to allow everything else */
342 static int verbose(struct lock_class *class)
345 return class_filter(class);
351 * Stack-trace: tightly packed array of stack backtrace
352 * addresses. Protected by the graph_lock.
354 unsigned long nr_stack_trace_entries;
355 static unsigned long stack_trace[MAX_STACK_TRACE_ENTRIES];
357 static int save_trace(struct stack_trace *trace)
359 trace->nr_entries = 0;
360 trace->max_entries = MAX_STACK_TRACE_ENTRIES - nr_stack_trace_entries;
361 trace->entries = stack_trace + nr_stack_trace_entries;
365 save_stack_trace(trace);
367 trace->max_entries = trace->nr_entries;
369 nr_stack_trace_entries += trace->nr_entries;
371 if (nr_stack_trace_entries == MAX_STACK_TRACE_ENTRIES) {
372 if (!debug_locks_off_graph_unlock())
375 printk("BUG: MAX_STACK_TRACE_ENTRIES too low!\n");
376 printk("turning off the locking correctness validator.\n");
385 unsigned int nr_hardirq_chains;
386 unsigned int nr_softirq_chains;
387 unsigned int nr_process_chains;
388 unsigned int max_lockdep_depth;
389 unsigned int max_recursion_depth;
391 static unsigned int lockdep_dependency_gen_id;
393 static bool lockdep_dependency_visit(struct lock_class *source,
397 lockdep_dependency_gen_id++;
398 if (source->dep_gen_id == lockdep_dependency_gen_id)
400 source->dep_gen_id = lockdep_dependency_gen_id;
404 #ifdef CONFIG_DEBUG_LOCKDEP
406 * We cannot printk in early bootup code. Not even early_printk()
407 * might work. So we mark any initialization errors and printk
408 * about it later on, in lockdep_info().
410 static int lockdep_init_error;
411 static unsigned long lockdep_init_trace_data[20];
412 static struct stack_trace lockdep_init_trace = {
413 .max_entries = ARRAY_SIZE(lockdep_init_trace_data),
414 .entries = lockdep_init_trace_data,
418 * Various lockdep statistics:
420 atomic_t chain_lookup_hits;
421 atomic_t chain_lookup_misses;
422 atomic_t hardirqs_on_events;
423 atomic_t hardirqs_off_events;
424 atomic_t redundant_hardirqs_on;
425 atomic_t redundant_hardirqs_off;
426 atomic_t softirqs_on_events;
427 atomic_t softirqs_off_events;
428 atomic_t redundant_softirqs_on;
429 atomic_t redundant_softirqs_off;
430 atomic_t nr_unused_locks;
431 atomic_t nr_cyclic_checks;
432 atomic_t nr_cyclic_check_recursions;
433 atomic_t nr_find_usage_forwards_checks;
434 atomic_t nr_find_usage_forwards_recursions;
435 atomic_t nr_find_usage_backwards_checks;
436 atomic_t nr_find_usage_backwards_recursions;
443 #define __USAGE(__STATE) \
444 [LOCK_USED_IN_##__STATE] = "IN-"__stringify(__STATE)"-W", \
445 [LOCK_ENABLED_##__STATE] = __stringify(__STATE)"-ON-W", \
446 [LOCK_USED_IN_##__STATE##_READ] = "IN-"__stringify(__STATE)"-R",\
447 [LOCK_ENABLED_##__STATE##_READ] = __stringify(__STATE)"-ON-R",
449 static const char *usage_str[] =
451 #define LOCKDEP_STATE(__STATE) __USAGE(__STATE)
452 #include "lockdep_states.h"
454 [LOCK_USED] = "INITIAL USE",
457 const char * __get_key_name(struct lockdep_subclass_key *key, char *str)
459 return kallsyms_lookup((unsigned long)key, NULL, NULL, NULL, str);
462 static inline unsigned long lock_flag(enum lock_usage_bit bit)
467 static char get_usage_char(struct lock_class *class, enum lock_usage_bit bit)
471 if (class->usage_mask & lock_flag(bit + 2))
473 if (class->usage_mask & lock_flag(bit)) {
475 if (class->usage_mask & lock_flag(bit + 2))
482 void get_usage_chars(struct lock_class *class, char usage[LOCK_USAGE_CHARS])
486 #define LOCKDEP_STATE(__STATE) \
487 usage[i++] = get_usage_char(class, LOCK_USED_IN_##__STATE); \
488 usage[i++] = get_usage_char(class, LOCK_USED_IN_##__STATE##_READ);
489 #include "lockdep_states.h"
495 static void print_lock_name(struct lock_class *class)
497 char str[KSYM_NAME_LEN], usage[LOCK_USAGE_CHARS];
500 get_usage_chars(class, usage);
504 name = __get_key_name(class->key, str);
505 printk(" (%s", name);
507 printk(" (%s", name);
508 if (class->name_version > 1)
509 printk("#%d", class->name_version);
511 printk("/%d", class->subclass);
513 printk("){%s}", usage);
516 static void print_lockdep_cache(struct lockdep_map *lock)
519 char str[KSYM_NAME_LEN];
523 name = __get_key_name(lock->key->subkeys, str);
528 static void print_lock(struct held_lock *hlock)
530 print_lock_name(hlock_class(hlock));
532 print_ip_sym(hlock->acquire_ip);
535 static void lockdep_print_held_locks(struct task_struct *curr)
537 int i, depth = curr->lockdep_depth;
540 printk("no locks held by %s/%d.\n", curr->comm, task_pid_nr(curr));
543 printk("%d lock%s held by %s/%d:\n",
544 depth, depth > 1 ? "s" : "", curr->comm, task_pid_nr(curr));
546 for (i = 0; i < depth; i++) {
548 print_lock(curr->held_locks + i);
552 static void print_lock_class_header(struct lock_class *class, int depth)
556 printk("%*s->", depth, "");
557 print_lock_name(class);
558 printk(" ops: %lu", class->ops);
561 for (bit = 0; bit < LOCK_USAGE_STATES; bit++) {
562 if (class->usage_mask & (1 << bit)) {
565 len += printk("%*s %s", depth, "", usage_str[bit]);
566 len += printk(" at:\n");
567 print_stack_trace(class->usage_traces + bit, len);
570 printk("%*s }\n", depth, "");
572 printk("%*s ... key at: ",depth,"");
573 print_ip_sym((unsigned long)class->key);
577 * printk all lock dependencies starting at <entry>:
580 print_lock_dependencies(struct lock_class *class, int depth)
582 struct lock_list *entry;
584 if (lockdep_dependency_visit(class, depth))
587 if (DEBUG_LOCKS_WARN_ON(depth >= 20))
590 print_lock_class_header(class, depth);
592 list_for_each_entry(entry, &class->locks_after, entry) {
593 if (DEBUG_LOCKS_WARN_ON(!entry->class))
596 print_lock_dependencies(entry->class, depth + 1);
598 printk("%*s ... acquired at:\n",depth,"");
599 print_stack_trace(&entry->trace, 2);
604 static void print_kernel_version(void)
606 printk("%s %.*s\n", init_utsname()->release,
607 (int)strcspn(init_utsname()->version, " "),
608 init_utsname()->version);
611 static int very_verbose(struct lock_class *class)
614 return class_filter(class);
620 * Is this the address of a static object:
622 static int static_obj(void *obj)
624 unsigned long start = (unsigned long) &_stext,
625 end = (unsigned long) &_end,
626 addr = (unsigned long) obj;
634 if ((addr >= start) && (addr < end))
641 for_each_possible_cpu(i) {
642 start = (unsigned long) &__per_cpu_start + per_cpu_offset(i);
643 end = (unsigned long) &__per_cpu_start + PERCPU_ENOUGH_ROOM
646 if ((addr >= start) && (addr < end))
654 return is_module_address(addr);
658 * To make lock name printouts unique, we calculate a unique
659 * class->name_version generation counter:
661 static int count_matching_names(struct lock_class *new_class)
663 struct lock_class *class;
666 if (!new_class->name)
669 list_for_each_entry(class, &all_lock_classes, lock_entry) {
670 if (new_class->key - new_class->subclass == class->key)
671 return class->name_version;
672 if (class->name && !strcmp(class->name, new_class->name))
673 count = max(count, class->name_version);
680 * Register a lock's class in the hash-table, if the class is not present
681 * yet. Otherwise we look it up. We cache the result in the lock object
682 * itself, so actual lookup of the hash should be once per lock object.
684 static inline struct lock_class *
685 look_up_lock_class(struct lockdep_map *lock, unsigned int subclass)
687 struct lockdep_subclass_key *key;
688 struct list_head *hash_head;
689 struct lock_class *class;
691 #ifdef CONFIG_DEBUG_LOCKDEP
693 * If the architecture calls into lockdep before initializing
694 * the hashes then we'll warn about it later. (we cannot printk
697 if (unlikely(!lockdep_initialized)) {
699 lockdep_init_error = 1;
700 save_stack_trace(&lockdep_init_trace);
705 * Static locks do not have their class-keys yet - for them the key
706 * is the lock object itself:
708 if (unlikely(!lock->key))
709 lock->key = (void *)lock;
712 * NOTE: the class-key must be unique. For dynamic locks, a static
713 * lock_class_key variable is passed in through the mutex_init()
714 * (or spin_lock_init()) call - which acts as the key. For static
715 * locks we use the lock object itself as the key.
717 BUILD_BUG_ON(sizeof(struct lock_class_key) >
718 sizeof(struct lockdep_map));
720 key = lock->key->subkeys + subclass;
722 hash_head = classhashentry(key);
725 * We can walk the hash lockfree, because the hash only
726 * grows, and we are careful when adding entries to the end:
728 list_for_each_entry(class, hash_head, hash_entry) {
729 if (class->key == key) {
730 WARN_ON_ONCE(class->name != lock->name);
739 * Register a lock's class in the hash-table, if the class is not present
740 * yet. Otherwise we look it up. We cache the result in the lock object
741 * itself, so actual lookup of the hash should be once per lock object.
743 static inline struct lock_class *
744 register_lock_class(struct lockdep_map *lock, unsigned int subclass, int force)
746 struct lockdep_subclass_key *key;
747 struct list_head *hash_head;
748 struct lock_class *class;
751 class = look_up_lock_class(lock, subclass);
756 * Debug-check: all keys must be persistent!
758 if (!static_obj(lock->key)) {
760 printk("INFO: trying to register non-static key.\n");
761 printk("the code is fine but needs lockdep annotation.\n");
762 printk("turning off the locking correctness validator.\n");
768 key = lock->key->subkeys + subclass;
769 hash_head = classhashentry(key);
771 raw_local_irq_save(flags);
773 raw_local_irq_restore(flags);
777 * We have to do the hash-walk again, to avoid races
780 list_for_each_entry(class, hash_head, hash_entry)
781 if (class->key == key)
784 * Allocate a new key from the static array, and add it to
787 if (nr_lock_classes >= MAX_LOCKDEP_KEYS) {
788 if (!debug_locks_off_graph_unlock()) {
789 raw_local_irq_restore(flags);
792 raw_local_irq_restore(flags);
794 printk("BUG: MAX_LOCKDEP_KEYS too low!\n");
795 printk("turning off the locking correctness validator.\n");
799 class = lock_classes + nr_lock_classes++;
800 debug_atomic_inc(&nr_unused_locks);
802 class->name = lock->name;
803 class->subclass = subclass;
804 INIT_LIST_HEAD(&class->lock_entry);
805 INIT_LIST_HEAD(&class->locks_before);
806 INIT_LIST_HEAD(&class->locks_after);
807 class->name_version = count_matching_names(class);
809 * We use RCU's safe list-add method to make
810 * parallel walking of the hash-list safe:
812 list_add_tail_rcu(&class->hash_entry, hash_head);
814 * Add it to the global list of classes:
816 list_add_tail_rcu(&class->lock_entry, &all_lock_classes);
818 if (verbose(class)) {
820 raw_local_irq_restore(flags);
822 printk("\nnew class %p: %s", class->key, class->name);
823 if (class->name_version > 1)
824 printk("#%d", class->name_version);
828 raw_local_irq_save(flags);
830 raw_local_irq_restore(flags);
836 raw_local_irq_restore(flags);
838 if (!subclass || force)
839 lock->class_cache = class;
841 if (DEBUG_LOCKS_WARN_ON(class->subclass != subclass))
847 #ifdef CONFIG_PROVE_LOCKING
849 * Allocate a lockdep entry. (assumes the graph_lock held, returns
850 * with NULL on failure)
852 static struct lock_list *alloc_list_entry(void)
854 if (nr_list_entries >= MAX_LOCKDEP_ENTRIES) {
855 if (!debug_locks_off_graph_unlock())
858 printk("BUG: MAX_LOCKDEP_ENTRIES too low!\n");
859 printk("turning off the locking correctness validator.\n");
863 return list_entries + nr_list_entries++;
867 * Add a new dependency to the head of the list:
869 static int add_lock_to_list(struct lock_class *class, struct lock_class *this,
870 struct list_head *head, unsigned long ip, int distance)
872 struct lock_list *entry;
874 * Lock not present yet - get a new dependency struct and
875 * add it to the list:
877 entry = alloc_list_entry();
881 if (!save_trace(&entry->trace))
885 entry->distance = distance;
887 * Since we never remove from the dependency list, the list can
888 * be walked lockless by other CPUs, it's only allocation
889 * that must be protected by the spinlock. But this also means
890 * we must make new entries visible only once writes to the
891 * entry become visible - hence the RCU op:
893 list_add_tail_rcu(&entry->entry, head);
899 * Recursive, forwards-direction lock-dependency checking, used for
900 * both noncyclic checking and for hardirq-unsafe/softirq-unsafe
903 * (to keep the stackframe of the recursive functions small we
904 * use these global variables, and we also mark various helper
905 * functions as noinline.)
907 static struct held_lock *check_source, *check_target;
910 * Print a dependency chain entry (this is only done when a deadlock
911 * has been detected):
914 print_circular_bug_entry(struct lock_list *target, unsigned int depth)
916 if (debug_locks_silent)
918 printk("\n-> #%u", depth);
919 print_lock_name(target->class);
921 print_stack_trace(&target->trace, 6);
927 * When a circular dependency is detected, print the
931 print_circular_bug_header(struct lock_list *entry, unsigned int depth)
933 struct task_struct *curr = current;
935 if (!debug_locks_off_graph_unlock() || debug_locks_silent)
938 printk("\n=======================================================\n");
939 printk( "[ INFO: possible circular locking dependency detected ]\n");
940 print_kernel_version();
941 printk( "-------------------------------------------------------\n");
942 printk("%s/%d is trying to acquire lock:\n",
943 curr->comm, task_pid_nr(curr));
944 print_lock(check_source);
945 printk("\nbut task is already holding lock:\n");
946 print_lock(check_target);
947 printk("\nwhich lock already depends on the new lock.\n\n");
948 printk("\nthe existing dependency chain (in reverse order) is:\n");
950 print_circular_bug_entry(entry, depth);
955 static noinline int print_circular_bug_tail(void)
957 struct task_struct *curr = current;
958 struct lock_list this;
960 if (debug_locks_silent)
963 this.class = hlock_class(check_source);
964 if (!save_trace(&this.trace))
967 print_circular_bug_entry(&this, 0);
969 printk("\nother info that might help us debug this:\n\n");
970 lockdep_print_held_locks(curr);
972 printk("\nstack backtrace:\n");
978 #define RECURSION_LIMIT 40
980 static int noinline print_infinite_recursion_bug(void)
982 if (!debug_locks_off_graph_unlock())
990 unsigned long __lockdep_count_forward_deps(struct lock_class *class,
993 struct lock_list *entry;
994 unsigned long ret = 1;
996 if (lockdep_dependency_visit(class, depth))
1000 * Recurse this class's dependency list:
1002 list_for_each_entry(entry, &class->locks_after, entry)
1003 ret += __lockdep_count_forward_deps(entry->class, depth + 1);
1008 unsigned long lockdep_count_forward_deps(struct lock_class *class)
1010 unsigned long ret, flags;
1012 local_irq_save(flags);
1013 __raw_spin_lock(&lockdep_lock);
1014 ret = __lockdep_count_forward_deps(class, 0);
1015 __raw_spin_unlock(&lockdep_lock);
1016 local_irq_restore(flags);
1021 unsigned long __lockdep_count_backward_deps(struct lock_class *class,
1024 struct lock_list *entry;
1025 unsigned long ret = 1;
1027 if (lockdep_dependency_visit(class, depth))
1030 * Recurse this class's dependency list:
1032 list_for_each_entry(entry, &class->locks_before, entry)
1033 ret += __lockdep_count_backward_deps(entry->class, depth + 1);
1038 unsigned long lockdep_count_backward_deps(struct lock_class *class)
1040 unsigned long ret, flags;
1042 local_irq_save(flags);
1043 __raw_spin_lock(&lockdep_lock);
1044 ret = __lockdep_count_backward_deps(class, 0);
1045 __raw_spin_unlock(&lockdep_lock);
1046 local_irq_restore(flags);
1052 * Prove that the dependency graph starting at <entry> can not
1053 * lead to <target>. Print an error and return 0 if it does.
1056 check_noncircular(struct lock_class *source, unsigned int depth)
1058 struct lock_list *entry;
1060 if (lockdep_dependency_visit(source, depth))
1063 debug_atomic_inc(&nr_cyclic_check_recursions);
1064 if (depth > max_recursion_depth)
1065 max_recursion_depth = depth;
1066 if (depth >= RECURSION_LIMIT)
1067 return print_infinite_recursion_bug();
1069 * Check this lock's dependency list:
1071 list_for_each_entry(entry, &source->locks_after, entry) {
1072 if (entry->class == hlock_class(check_target))
1073 return print_circular_bug_header(entry, depth+1);
1074 debug_atomic_inc(&nr_cyclic_checks);
1075 if (!check_noncircular(entry->class, depth+1))
1076 return print_circular_bug_entry(entry, depth+1);
1081 #if defined(CONFIG_TRACE_IRQFLAGS) && defined(CONFIG_PROVE_LOCKING)
1083 * Forwards and backwards subgraph searching, for the purposes of
1084 * proving that two subgraphs can be connected by a new dependency
1085 * without creating any illegal irq-safe -> irq-unsafe lock dependency.
1087 static enum lock_usage_bit find_usage_bit;
1088 static struct lock_class *forwards_match, *backwards_match;
1091 * Find a node in the forwards-direction dependency sub-graph starting
1092 * at <source> that matches <find_usage_bit>.
1094 * Return 2 if such a node exists in the subgraph, and put that node
1095 * into <forwards_match>.
1097 * Return 1 otherwise and keep <forwards_match> unchanged.
1098 * Return 0 on error.
1101 find_usage_forwards(struct lock_class *source, unsigned int depth)
1103 struct lock_list *entry;
1106 if (lockdep_dependency_visit(source, depth))
1109 if (depth > max_recursion_depth)
1110 max_recursion_depth = depth;
1111 if (depth >= RECURSION_LIMIT)
1112 return print_infinite_recursion_bug();
1114 debug_atomic_inc(&nr_find_usage_forwards_checks);
1115 if (source->usage_mask & (1 << find_usage_bit)) {
1116 forwards_match = source;
1121 * Check this lock's dependency list:
1123 list_for_each_entry(entry, &source->locks_after, entry) {
1124 debug_atomic_inc(&nr_find_usage_forwards_recursions);
1125 ret = find_usage_forwards(entry->class, depth+1);
1126 if (ret == 2 || ret == 0)
1133 * Find a node in the backwards-direction dependency sub-graph starting
1134 * at <source> that matches <find_usage_bit>.
1136 * Return 2 if such a node exists in the subgraph, and put that node
1137 * into <backwards_match>.
1139 * Return 1 otherwise and keep <backwards_match> unchanged.
1140 * Return 0 on error.
1143 find_usage_backwards(struct lock_class *source, unsigned int depth)
1145 struct lock_list *entry;
1148 if (lockdep_dependency_visit(source, depth))
1151 if (!__raw_spin_is_locked(&lockdep_lock))
1152 return DEBUG_LOCKS_WARN_ON(1);
1154 if (depth > max_recursion_depth)
1155 max_recursion_depth = depth;
1156 if (depth >= RECURSION_LIMIT)
1157 return print_infinite_recursion_bug();
1159 debug_atomic_inc(&nr_find_usage_backwards_checks);
1160 if (source->usage_mask & (1 << find_usage_bit)) {
1161 backwards_match = source;
1165 if (!source && debug_locks_off_graph_unlock()) {
1171 * Check this lock's dependency list:
1173 list_for_each_entry(entry, &source->locks_before, entry) {
1174 debug_atomic_inc(&nr_find_usage_backwards_recursions);
1175 ret = find_usage_backwards(entry->class, depth+1);
1176 if (ret == 2 || ret == 0)
1183 print_bad_irq_dependency(struct task_struct *curr,
1184 struct held_lock *prev,
1185 struct held_lock *next,
1186 enum lock_usage_bit bit1,
1187 enum lock_usage_bit bit2,
1188 const char *irqclass)
1190 if (!debug_locks_off_graph_unlock() || debug_locks_silent)
1193 printk("\n======================================================\n");
1194 printk( "[ INFO: %s-safe -> %s-unsafe lock order detected ]\n",
1195 irqclass, irqclass);
1196 print_kernel_version();
1197 printk( "------------------------------------------------------\n");
1198 printk("%s/%d [HC%u[%lu]:SC%u[%lu]:HE%u:SE%u] is trying to acquire:\n",
1199 curr->comm, task_pid_nr(curr),
1200 curr->hardirq_context, hardirq_count() >> HARDIRQ_SHIFT,
1201 curr->softirq_context, softirq_count() >> SOFTIRQ_SHIFT,
1202 curr->hardirqs_enabled,
1203 curr->softirqs_enabled);
1206 printk("\nand this task is already holding:\n");
1208 printk("which would create a new lock dependency:\n");
1209 print_lock_name(hlock_class(prev));
1211 print_lock_name(hlock_class(next));
1214 printk("\nbut this new dependency connects a %s-irq-safe lock:\n",
1216 print_lock_name(backwards_match);
1217 printk("\n... which became %s-irq-safe at:\n", irqclass);
1219 print_stack_trace(backwards_match->usage_traces + bit1, 1);
1221 printk("\nto a %s-irq-unsafe lock:\n", irqclass);
1222 print_lock_name(forwards_match);
1223 printk("\n... which became %s-irq-unsafe at:\n", irqclass);
1226 print_stack_trace(forwards_match->usage_traces + bit2, 1);
1228 printk("\nother info that might help us debug this:\n\n");
1229 lockdep_print_held_locks(curr);
1231 printk("\nthe %s-irq-safe lock's dependencies:\n", irqclass);
1232 print_lock_dependencies(backwards_match, 0);
1234 printk("\nthe %s-irq-unsafe lock's dependencies:\n", irqclass);
1235 print_lock_dependencies(forwards_match, 0);
1237 printk("\nstack backtrace:\n");
1244 check_usage(struct task_struct *curr, struct held_lock *prev,
1245 struct held_lock *next, enum lock_usage_bit bit_backwards,
1246 enum lock_usage_bit bit_forwards, const char *irqclass)
1250 find_usage_bit = bit_backwards;
1251 /* fills in <backwards_match> */
1252 ret = find_usage_backwards(hlock_class(prev), 0);
1253 if (!ret || ret == 1)
1256 find_usage_bit = bit_forwards;
1257 ret = find_usage_forwards(hlock_class(next), 0);
1258 if (!ret || ret == 1)
1261 return print_bad_irq_dependency(curr, prev, next,
1262 bit_backwards, bit_forwards, irqclass);
1265 static const char *state_names[] = {
1266 #define LOCKDEP_STATE(__STATE) \
1267 __stringify(__STATE),
1268 #include "lockdep_states.h"
1269 #undef LOCKDEP_STATE
1272 static const char *state_rnames[] = {
1273 #define LOCKDEP_STATE(__STATE) \
1274 __stringify(__STATE)"-READ",
1275 #include "lockdep_states.h"
1276 #undef LOCKDEP_STATE
1279 static inline const char *state_name(enum lock_usage_bit bit)
1281 return (bit & 1) ? state_rnames[bit >> 2] : state_names[bit >> 2];
1284 static int exclusive_bit(int new_bit)
1292 * bit 0 - write/read
1293 * bit 1 - used_in/enabled
1297 int state = new_bit & ~3;
1298 int dir = new_bit & 2;
1301 * keep state, bit flip the direction and strip read.
1303 return state | (dir ^ 2);
1306 static int check_irq_usage(struct task_struct *curr, struct held_lock *prev,
1307 struct held_lock *next, enum lock_usage_bit bit)
1310 * Prove that the new dependency does not connect a hardirq-safe
1311 * lock with a hardirq-unsafe lock - to achieve this we search
1312 * the backwards-subgraph starting at <prev>, and the
1313 * forwards-subgraph starting at <next>:
1315 if (!check_usage(curr, prev, next, bit,
1316 exclusive_bit(bit), state_name(bit)))
1322 * Prove that the new dependency does not connect a hardirq-safe-read
1323 * lock with a hardirq-unsafe lock - to achieve this we search
1324 * the backwards-subgraph starting at <prev>, and the
1325 * forwards-subgraph starting at <next>:
1327 if (!check_usage(curr, prev, next, bit,
1328 exclusive_bit(bit), state_name(bit)))
1335 check_prev_add_irq(struct task_struct *curr, struct held_lock *prev,
1336 struct held_lock *next)
1338 #define LOCKDEP_STATE(__STATE) \
1339 if (!check_irq_usage(curr, prev, next, LOCK_USED_IN_##__STATE)) \
1341 #include "lockdep_states.h"
1342 #undef LOCKDEP_STATE
1347 static void inc_chains(void)
1349 if (current->hardirq_context)
1350 nr_hardirq_chains++;
1352 if (current->softirq_context)
1353 nr_softirq_chains++;
1355 nr_process_chains++;
1362 check_prev_add_irq(struct task_struct *curr, struct held_lock *prev,
1363 struct held_lock *next)
1368 static inline void inc_chains(void)
1370 nr_process_chains++;
1376 print_deadlock_bug(struct task_struct *curr, struct held_lock *prev,
1377 struct held_lock *next)
1379 if (!debug_locks_off_graph_unlock() || debug_locks_silent)
1382 printk("\n=============================================\n");
1383 printk( "[ INFO: possible recursive locking detected ]\n");
1384 print_kernel_version();
1385 printk( "---------------------------------------------\n");
1386 printk("%s/%d is trying to acquire lock:\n",
1387 curr->comm, task_pid_nr(curr));
1389 printk("\nbut task is already holding lock:\n");
1392 printk("\nother info that might help us debug this:\n");
1393 lockdep_print_held_locks(curr);
1395 printk("\nstack backtrace:\n");
1402 * Check whether we are holding such a class already.
1404 * (Note that this has to be done separately, because the graph cannot
1405 * detect such classes of deadlocks.)
1407 * Returns: 0 on deadlock detected, 1 on OK, 2 on recursive read
1410 check_deadlock(struct task_struct *curr, struct held_lock *next,
1411 struct lockdep_map *next_instance, int read)
1413 struct held_lock *prev;
1414 struct held_lock *nest = NULL;
1417 for (i = 0; i < curr->lockdep_depth; i++) {
1418 prev = curr->held_locks + i;
1420 if (prev->instance == next->nest_lock)
1423 if (hlock_class(prev) != hlock_class(next))
1427 * Allow read-after-read recursion of the same
1428 * lock class (i.e. read_lock(lock)+read_lock(lock)):
1430 if ((read == 2) && prev->read)
1434 * We're holding the nest_lock, which serializes this lock's
1435 * nesting behaviour.
1440 return print_deadlock_bug(curr, prev, next);
1446 * There was a chain-cache miss, and we are about to add a new dependency
1447 * to a previous lock. We recursively validate the following rules:
1449 * - would the adding of the <prev> -> <next> dependency create a
1450 * circular dependency in the graph? [== circular deadlock]
1452 * - does the new prev->next dependency connect any hardirq-safe lock
1453 * (in the full backwards-subgraph starting at <prev>) with any
1454 * hardirq-unsafe lock (in the full forwards-subgraph starting at
1455 * <next>)? [== illegal lock inversion with hardirq contexts]
1457 * - does the new prev->next dependency connect any softirq-safe lock
1458 * (in the full backwards-subgraph starting at <prev>) with any
1459 * softirq-unsafe lock (in the full forwards-subgraph starting at
1460 * <next>)? [== illegal lock inversion with softirq contexts]
1462 * any of these scenarios could lead to a deadlock.
1464 * Then if all the validations pass, we add the forwards and backwards
1468 check_prev_add(struct task_struct *curr, struct held_lock *prev,
1469 struct held_lock *next, int distance)
1471 struct lock_list *entry;
1475 * Prove that the new <prev> -> <next> dependency would not
1476 * create a circular dependency in the graph. (We do this by
1477 * forward-recursing into the graph starting at <next>, and
1478 * checking whether we can reach <prev>.)
1480 * We are using global variables to control the recursion, to
1481 * keep the stackframe size of the recursive functions low:
1483 check_source = next;
1484 check_target = prev;
1485 if (!(check_noncircular(hlock_class(next), 0)))
1486 return print_circular_bug_tail();
1488 if (!check_prev_add_irq(curr, prev, next))
1492 * For recursive read-locks we do all the dependency checks,
1493 * but we dont store read-triggered dependencies (only
1494 * write-triggered dependencies). This ensures that only the
1495 * write-side dependencies matter, and that if for example a
1496 * write-lock never takes any other locks, then the reads are
1497 * equivalent to a NOP.
1499 if (next->read == 2 || prev->read == 2)
1502 * Is the <prev> -> <next> dependency already present?
1504 * (this may occur even though this is a new chain: consider
1505 * e.g. the L1 -> L2 -> L3 -> L4 and the L5 -> L1 -> L2 -> L3
1506 * chains - the second one will be new, but L1 already has
1507 * L2 added to its dependency list, due to the first chain.)
1509 list_for_each_entry(entry, &hlock_class(prev)->locks_after, entry) {
1510 if (entry->class == hlock_class(next)) {
1512 entry->distance = 1;
1518 * Ok, all validations passed, add the new lock
1519 * to the previous lock's dependency list:
1521 ret = add_lock_to_list(hlock_class(prev), hlock_class(next),
1522 &hlock_class(prev)->locks_after,
1523 next->acquire_ip, distance);
1528 ret = add_lock_to_list(hlock_class(next), hlock_class(prev),
1529 &hlock_class(next)->locks_before,
1530 next->acquire_ip, distance);
1535 * Debugging printouts:
1537 if (verbose(hlock_class(prev)) || verbose(hlock_class(next))) {
1539 printk("\n new dependency: ");
1540 print_lock_name(hlock_class(prev));
1542 print_lock_name(hlock_class(next));
1545 return graph_lock();
1551 * Add the dependency to all directly-previous locks that are 'relevant'.
1552 * The ones that are relevant are (in increasing distance from curr):
1553 * all consecutive trylock entries and the final non-trylock entry - or
1554 * the end of this context's lock-chain - whichever comes first.
1557 check_prevs_add(struct task_struct *curr, struct held_lock *next)
1559 int depth = curr->lockdep_depth;
1560 struct held_lock *hlock;
1565 * Depth must not be zero for a non-head lock:
1570 * At least two relevant locks must exist for this
1573 if (curr->held_locks[depth].irq_context !=
1574 curr->held_locks[depth-1].irq_context)
1578 int distance = curr->lockdep_depth - depth + 1;
1579 hlock = curr->held_locks + depth-1;
1581 * Only non-recursive-read entries get new dependencies
1584 if (hlock->read != 2) {
1585 if (!check_prev_add(curr, hlock, next, distance))
1588 * Stop after the first non-trylock entry,
1589 * as non-trylock entries have added their
1590 * own direct dependencies already, so this
1591 * lock is connected to them indirectly:
1593 if (!hlock->trylock)
1598 * End of lock-stack?
1603 * Stop the search if we cross into another context:
1605 if (curr->held_locks[depth].irq_context !=
1606 curr->held_locks[depth-1].irq_context)
1611 if (!debug_locks_off_graph_unlock())
1619 unsigned long nr_lock_chains;
1620 struct lock_chain lock_chains[MAX_LOCKDEP_CHAINS];
1621 int nr_chain_hlocks;
1622 static u16 chain_hlocks[MAX_LOCKDEP_CHAIN_HLOCKS];
1624 struct lock_class *lock_chain_get_class(struct lock_chain *chain, int i)
1626 return lock_classes + chain_hlocks[chain->base + i];
1630 * Look up a dependency chain. If the key is not present yet then
1631 * add it and return 1 - in this case the new dependency chain is
1632 * validated. If the key is already hashed, return 0.
1633 * (On return with 1 graph_lock is held.)
1635 static inline int lookup_chain_cache(struct task_struct *curr,
1636 struct held_lock *hlock,
1639 struct lock_class *class = hlock_class(hlock);
1640 struct list_head *hash_head = chainhashentry(chain_key);
1641 struct lock_chain *chain;
1642 struct held_lock *hlock_curr, *hlock_next;
1645 if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
1648 * We can walk it lock-free, because entries only get added
1651 list_for_each_entry(chain, hash_head, entry) {
1652 if (chain->chain_key == chain_key) {
1654 debug_atomic_inc(&chain_lookup_hits);
1655 if (very_verbose(class))
1656 printk("\nhash chain already cached, key: "
1657 "%016Lx tail class: [%p] %s\n",
1658 (unsigned long long)chain_key,
1659 class->key, class->name);
1663 if (very_verbose(class))
1664 printk("\nnew hash chain, key: %016Lx tail class: [%p] %s\n",
1665 (unsigned long long)chain_key, class->key, class->name);
1667 * Allocate a new chain entry from the static array, and add
1673 * We have to walk the chain again locked - to avoid duplicates:
1675 list_for_each_entry(chain, hash_head, entry) {
1676 if (chain->chain_key == chain_key) {
1681 if (unlikely(nr_lock_chains >= MAX_LOCKDEP_CHAINS)) {
1682 if (!debug_locks_off_graph_unlock())
1685 printk("BUG: MAX_LOCKDEP_CHAINS too low!\n");
1686 printk("turning off the locking correctness validator.\n");
1690 chain = lock_chains + nr_lock_chains++;
1691 chain->chain_key = chain_key;
1692 chain->irq_context = hlock->irq_context;
1693 /* Find the first held_lock of current chain */
1695 for (i = curr->lockdep_depth - 1; i >= 0; i--) {
1696 hlock_curr = curr->held_locks + i;
1697 if (hlock_curr->irq_context != hlock_next->irq_context)
1702 chain->depth = curr->lockdep_depth + 1 - i;
1703 cn = nr_chain_hlocks;
1704 while (cn + chain->depth <= MAX_LOCKDEP_CHAIN_HLOCKS) {
1705 n = cmpxchg(&nr_chain_hlocks, cn, cn + chain->depth);
1710 if (likely(cn + chain->depth <= MAX_LOCKDEP_CHAIN_HLOCKS)) {
1712 for (j = 0; j < chain->depth - 1; j++, i++) {
1713 int lock_id = curr->held_locks[i].class_idx - 1;
1714 chain_hlocks[chain->base + j] = lock_id;
1716 chain_hlocks[chain->base + j] = class - lock_classes;
1718 list_add_tail_rcu(&chain->entry, hash_head);
1719 debug_atomic_inc(&chain_lookup_misses);
1725 static int validate_chain(struct task_struct *curr, struct lockdep_map *lock,
1726 struct held_lock *hlock, int chain_head, u64 chain_key)
1729 * Trylock needs to maintain the stack of held locks, but it
1730 * does not add new dependencies, because trylock can be done
1733 * We look up the chain_key and do the O(N^2) check and update of
1734 * the dependencies only if this is a new dependency chain.
1735 * (If lookup_chain_cache() returns with 1 it acquires
1736 * graph_lock for us)
1738 if (!hlock->trylock && (hlock->check == 2) &&
1739 lookup_chain_cache(curr, hlock, chain_key)) {
1741 * Check whether last held lock:
1743 * - is irq-safe, if this lock is irq-unsafe
1744 * - is softirq-safe, if this lock is hardirq-unsafe
1746 * And check whether the new lock's dependency graph
1747 * could lead back to the previous lock.
1749 * any of these scenarios could lead to a deadlock. If
1752 int ret = check_deadlock(curr, hlock, lock, hlock->read);
1757 * Mark recursive read, as we jump over it when
1758 * building dependencies (just like we jump over
1764 * Add dependency only if this lock is not the head
1765 * of the chain, and if it's not a secondary read-lock:
1767 if (!chain_head && ret != 2)
1768 if (!check_prevs_add(curr, hlock))
1772 /* after lookup_chain_cache(): */
1773 if (unlikely(!debug_locks))
1779 static inline int validate_chain(struct task_struct *curr,
1780 struct lockdep_map *lock, struct held_lock *hlock,
1781 int chain_head, u64 chain_key)
1788 * We are building curr_chain_key incrementally, so double-check
1789 * it from scratch, to make sure that it's done correctly:
1791 static void check_chain_key(struct task_struct *curr)
1793 #ifdef CONFIG_DEBUG_LOCKDEP
1794 struct held_lock *hlock, *prev_hlock = NULL;
1798 for (i = 0; i < curr->lockdep_depth; i++) {
1799 hlock = curr->held_locks + i;
1800 if (chain_key != hlock->prev_chain_key) {
1802 WARN(1, "hm#1, depth: %u [%u], %016Lx != %016Lx\n",
1803 curr->lockdep_depth, i,
1804 (unsigned long long)chain_key,
1805 (unsigned long long)hlock->prev_chain_key);
1808 id = hlock->class_idx - 1;
1809 if (DEBUG_LOCKS_WARN_ON(id >= MAX_LOCKDEP_KEYS))
1812 if (prev_hlock && (prev_hlock->irq_context !=
1813 hlock->irq_context))
1815 chain_key = iterate_chain_key(chain_key, id);
1818 if (chain_key != curr->curr_chain_key) {
1820 WARN(1, "hm#2, depth: %u [%u], %016Lx != %016Lx\n",
1821 curr->lockdep_depth, i,
1822 (unsigned long long)chain_key,
1823 (unsigned long long)curr->curr_chain_key);
1829 print_usage_bug(struct task_struct *curr, struct held_lock *this,
1830 enum lock_usage_bit prev_bit, enum lock_usage_bit new_bit)
1832 if (!debug_locks_off_graph_unlock() || debug_locks_silent)
1835 printk("\n=================================\n");
1836 printk( "[ INFO: inconsistent lock state ]\n");
1837 print_kernel_version();
1838 printk( "---------------------------------\n");
1840 printk("inconsistent {%s} -> {%s} usage.\n",
1841 usage_str[prev_bit], usage_str[new_bit]);
1843 printk("%s/%d [HC%u[%lu]:SC%u[%lu]:HE%u:SE%u] takes:\n",
1844 curr->comm, task_pid_nr(curr),
1845 trace_hardirq_context(curr), hardirq_count() >> HARDIRQ_SHIFT,
1846 trace_softirq_context(curr), softirq_count() >> SOFTIRQ_SHIFT,
1847 trace_hardirqs_enabled(curr),
1848 trace_softirqs_enabled(curr));
1851 printk("{%s} state was registered at:\n", usage_str[prev_bit]);
1852 print_stack_trace(hlock_class(this)->usage_traces + prev_bit, 1);
1854 print_irqtrace_events(curr);
1855 printk("\nother info that might help us debug this:\n");
1856 lockdep_print_held_locks(curr);
1858 printk("\nstack backtrace:\n");
1865 * Print out an error if an invalid bit is set:
1868 valid_state(struct task_struct *curr, struct held_lock *this,
1869 enum lock_usage_bit new_bit, enum lock_usage_bit bad_bit)
1871 if (unlikely(hlock_class(this)->usage_mask & (1 << bad_bit)))
1872 return print_usage_bug(curr, this, bad_bit, new_bit);
1876 static int mark_lock(struct task_struct *curr, struct held_lock *this,
1877 enum lock_usage_bit new_bit);
1879 #if defined(CONFIG_TRACE_IRQFLAGS) && defined(CONFIG_PROVE_LOCKING)
1882 * print irq inversion bug:
1885 print_irq_inversion_bug(struct task_struct *curr, struct lock_class *other,
1886 struct held_lock *this, int forwards,
1887 const char *irqclass)
1889 if (!debug_locks_off_graph_unlock() || debug_locks_silent)
1892 printk("\n=========================================================\n");
1893 printk( "[ INFO: possible irq lock inversion dependency detected ]\n");
1894 print_kernel_version();
1895 printk( "---------------------------------------------------------\n");
1896 printk("%s/%d just changed the state of lock:\n",
1897 curr->comm, task_pid_nr(curr));
1900 printk("but this lock took another, %s-unsafe lock in the past:\n", irqclass);
1902 printk("but this lock was taken by another, %s-safe lock in the past:\n", irqclass);
1903 print_lock_name(other);
1904 printk("\n\nand interrupts could create inverse lock ordering between them.\n\n");
1906 printk("\nother info that might help us debug this:\n");
1907 lockdep_print_held_locks(curr);
1909 printk("\nthe first lock's dependencies:\n");
1910 print_lock_dependencies(hlock_class(this), 0);
1912 printk("\nthe second lock's dependencies:\n");
1913 print_lock_dependencies(other, 0);
1915 printk("\nstack backtrace:\n");
1922 * Prove that in the forwards-direction subgraph starting at <this>
1923 * there is no lock matching <mask>:
1926 check_usage_forwards(struct task_struct *curr, struct held_lock *this,
1927 enum lock_usage_bit bit, const char *irqclass)
1931 find_usage_bit = bit;
1932 /* fills in <forwards_match> */
1933 ret = find_usage_forwards(hlock_class(this), 0);
1934 if (!ret || ret == 1)
1937 return print_irq_inversion_bug(curr, forwards_match, this, 1, irqclass);
1941 * Prove that in the backwards-direction subgraph starting at <this>
1942 * there is no lock matching <mask>:
1945 check_usage_backwards(struct task_struct *curr, struct held_lock *this,
1946 enum lock_usage_bit bit, const char *irqclass)
1950 find_usage_bit = bit;
1951 /* fills in <backwards_match> */
1952 ret = find_usage_backwards(hlock_class(this), 0);
1953 if (!ret || ret == 1)
1956 return print_irq_inversion_bug(curr, backwards_match, this, 0, irqclass);
1959 void print_irqtrace_events(struct task_struct *curr)
1961 printk("irq event stamp: %u\n", curr->irq_events);
1962 printk("hardirqs last enabled at (%u): ", curr->hardirq_enable_event);
1963 print_ip_sym(curr->hardirq_enable_ip);
1964 printk("hardirqs last disabled at (%u): ", curr->hardirq_disable_event);
1965 print_ip_sym(curr->hardirq_disable_ip);
1966 printk("softirqs last enabled at (%u): ", curr->softirq_enable_event);
1967 print_ip_sym(curr->softirq_enable_ip);
1968 printk("softirqs last disabled at (%u): ", curr->softirq_disable_event);
1969 print_ip_sym(curr->softirq_disable_ip);
1972 static int HARDIRQ_verbose(struct lock_class *class)
1975 return class_filter(class);
1980 static int SOFTIRQ_verbose(struct lock_class *class)
1983 return class_filter(class);
1988 static int RECLAIM_FS_verbose(struct lock_class *class)
1991 return class_filter(class);
1996 #define STRICT_READ_CHECKS 1
1998 static int (*state_verbose_f[])(struct lock_class *class) = {
1999 #define LOCKDEP_STATE(__STATE) \
2001 #include "lockdep_states.h"
2002 #undef LOCKDEP_STATE
2005 static inline int state_verbose(enum lock_usage_bit bit,
2006 struct lock_class *class)
2008 return state_verbose_f[bit >> 2](class);
2011 typedef int (*check_usage_f)(struct task_struct *, struct held_lock *,
2012 enum lock_usage_bit bit, const char *name);
2015 mark_lock_irq(struct task_struct *curr, struct held_lock *this,
2016 enum lock_usage_bit new_bit)
2018 int excl_bit = exclusive_bit(new_bit);
2019 int read = new_bit & 1;
2020 int dir = new_bit & 2;
2023 * mark USED_IN has to look forwards -- to ensure no dependency
2024 * has ENABLED state, which would allow recursion deadlocks.
2026 * mark ENABLED has to look backwards -- to ensure no dependee
2027 * has USED_IN state, which, again, would allow recursion deadlocks.
2029 check_usage_f usage = dir ?
2030 check_usage_backwards : check_usage_forwards;
2033 * Validate that this particular lock does not have conflicting
2036 if (!valid_state(curr, this, new_bit, excl_bit))
2040 * Validate that the lock dependencies don't have conflicting usage
2043 if ((!read || !dir || STRICT_READ_CHECKS) &&
2044 !usage(curr, this, excl_bit, state_name(new_bit & ~1)))
2048 * Check for read in write conflicts
2051 if (!valid_state(curr, this, new_bit, excl_bit + 1))
2054 if (STRICT_READ_CHECKS &&
2055 !usage(curr, this, excl_bit + 1,
2056 state_name(new_bit + 1)))
2060 if (state_verbose(new_bit, hlock_class(this)))
2067 #define LOCKDEP_STATE(__STATE) __STATE,
2068 #include "lockdep_states.h"
2069 #undef LOCKDEP_STATE
2073 * Mark all held locks with a usage bit:
2076 mark_held_locks(struct task_struct *curr, enum mark_type mark)
2078 enum lock_usage_bit usage_bit;
2079 struct held_lock *hlock;
2082 for (i = 0; i < curr->lockdep_depth; i++) {
2083 hlock = curr->held_locks + i;
2085 usage_bit = 2 + (mark << 2); /* ENABLED */
2087 usage_bit += 1; /* READ */
2089 BUG_ON(usage_bit >= LOCK_USAGE_STATES);
2091 if (!mark_lock(curr, hlock, usage_bit))
2099 * Debugging helper: via this flag we know that we are in
2100 * 'early bootup code', and will warn about any invalid irqs-on event:
2102 static int early_boot_irqs_enabled;
2104 void early_boot_irqs_off(void)
2106 early_boot_irqs_enabled = 0;
2109 void early_boot_irqs_on(void)
2111 early_boot_irqs_enabled = 1;
2115 * Hardirqs will be enabled:
2117 void trace_hardirqs_on_caller(unsigned long ip)
2119 struct task_struct *curr = current;
2121 time_hardirqs_on(CALLER_ADDR0, ip);
2123 if (unlikely(!debug_locks || current->lockdep_recursion))
2126 if (DEBUG_LOCKS_WARN_ON(unlikely(!early_boot_irqs_enabled)))
2129 if (unlikely(curr->hardirqs_enabled)) {
2130 debug_atomic_inc(&redundant_hardirqs_on);
2133 /* we'll do an OFF -> ON transition: */
2134 curr->hardirqs_enabled = 1;
2136 if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
2138 if (DEBUG_LOCKS_WARN_ON(current->hardirq_context))
2141 * We are going to turn hardirqs on, so set the
2142 * usage bit for all held locks:
2144 if (!mark_held_locks(curr, HARDIRQ))
2147 * If we have softirqs enabled, then set the usage
2148 * bit for all held locks. (disabled hardirqs prevented
2149 * this bit from being set before)
2151 if (curr->softirqs_enabled)
2152 if (!mark_held_locks(curr, SOFTIRQ))
2155 curr->hardirq_enable_ip = ip;
2156 curr->hardirq_enable_event = ++curr->irq_events;
2157 debug_atomic_inc(&hardirqs_on_events);
2159 EXPORT_SYMBOL(trace_hardirqs_on_caller);
2161 void trace_hardirqs_on(void)
2163 trace_hardirqs_on_caller(CALLER_ADDR0);
2165 EXPORT_SYMBOL(trace_hardirqs_on);
2168 * Hardirqs were disabled:
2170 void trace_hardirqs_off_caller(unsigned long ip)
2172 struct task_struct *curr = current;
2174 time_hardirqs_off(CALLER_ADDR0, ip);
2176 if (unlikely(!debug_locks || current->lockdep_recursion))
2179 if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
2182 if (curr->hardirqs_enabled) {
2184 * We have done an ON -> OFF transition:
2186 curr->hardirqs_enabled = 0;
2187 curr->hardirq_disable_ip = ip;
2188 curr->hardirq_disable_event = ++curr->irq_events;
2189 debug_atomic_inc(&hardirqs_off_events);
2191 debug_atomic_inc(&redundant_hardirqs_off);
2193 EXPORT_SYMBOL(trace_hardirqs_off_caller);
2195 void trace_hardirqs_off(void)
2197 trace_hardirqs_off_caller(CALLER_ADDR0);
2199 EXPORT_SYMBOL(trace_hardirqs_off);
2202 * Softirqs will be enabled:
2204 void trace_softirqs_on(unsigned long ip)
2206 struct task_struct *curr = current;
2208 if (unlikely(!debug_locks))
2211 if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
2214 if (curr->softirqs_enabled) {
2215 debug_atomic_inc(&redundant_softirqs_on);
2220 * We'll do an OFF -> ON transition:
2222 curr->softirqs_enabled = 1;
2223 curr->softirq_enable_ip = ip;
2224 curr->softirq_enable_event = ++curr->irq_events;
2225 debug_atomic_inc(&softirqs_on_events);
2227 * We are going to turn softirqs on, so set the
2228 * usage bit for all held locks, if hardirqs are
2231 if (curr->hardirqs_enabled)
2232 mark_held_locks(curr, SOFTIRQ);
2236 * Softirqs were disabled:
2238 void trace_softirqs_off(unsigned long ip)
2240 struct task_struct *curr = current;
2242 if (unlikely(!debug_locks))
2245 if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
2248 if (curr->softirqs_enabled) {
2250 * We have done an ON -> OFF transition:
2252 curr->softirqs_enabled = 0;
2253 curr->softirq_disable_ip = ip;
2254 curr->softirq_disable_event = ++curr->irq_events;
2255 debug_atomic_inc(&softirqs_off_events);
2256 DEBUG_LOCKS_WARN_ON(!softirq_count());
2258 debug_atomic_inc(&redundant_softirqs_off);
2261 static void __lockdep_trace_alloc(gfp_t gfp_mask, unsigned long flags)
2263 struct task_struct *curr = current;
2265 if (unlikely(!debug_locks))
2268 /* no reclaim without waiting on it */
2269 if (!(gfp_mask & __GFP_WAIT))
2272 /* this guy won't enter reclaim */
2273 if ((curr->flags & PF_MEMALLOC) && !(gfp_mask & __GFP_NOMEMALLOC))
2276 /* We're only interested __GFP_FS allocations for now */
2277 if (!(gfp_mask & __GFP_FS))
2280 if (DEBUG_LOCKS_WARN_ON(irqs_disabled_flags(flags)))
2283 mark_held_locks(curr, RECLAIM_FS);
2286 static void check_flags(unsigned long flags);
2288 void lockdep_trace_alloc(gfp_t gfp_mask)
2290 unsigned long flags;
2292 if (unlikely(current->lockdep_recursion))
2295 raw_local_irq_save(flags);
2297 current->lockdep_recursion = 1;
2298 __lockdep_trace_alloc(gfp_mask, flags);
2299 current->lockdep_recursion = 0;
2300 raw_local_irq_restore(flags);
2303 static int mark_irqflags(struct task_struct *curr, struct held_lock *hlock)
2306 * If non-trylock use in a hardirq or softirq context, then
2307 * mark the lock as used in these contexts:
2309 if (!hlock->trylock) {
2311 if (curr->hardirq_context)
2312 if (!mark_lock(curr, hlock,
2313 LOCK_USED_IN_HARDIRQ_READ))
2315 if (curr->softirq_context)
2316 if (!mark_lock(curr, hlock,
2317 LOCK_USED_IN_SOFTIRQ_READ))
2320 if (curr->hardirq_context)
2321 if (!mark_lock(curr, hlock, LOCK_USED_IN_HARDIRQ))
2323 if (curr->softirq_context)
2324 if (!mark_lock(curr, hlock, LOCK_USED_IN_SOFTIRQ))
2328 if (!hlock->hardirqs_off) {
2330 if (!mark_lock(curr, hlock,
2331 LOCK_ENABLED_HARDIRQ_READ))
2333 if (curr->softirqs_enabled)
2334 if (!mark_lock(curr, hlock,
2335 LOCK_ENABLED_SOFTIRQ_READ))
2338 if (!mark_lock(curr, hlock,
2339 LOCK_ENABLED_HARDIRQ))
2341 if (curr->softirqs_enabled)
2342 if (!mark_lock(curr, hlock,
2343 LOCK_ENABLED_SOFTIRQ))
2349 * We reuse the irq context infrastructure more broadly as a general
2350 * context checking code. This tests GFP_FS recursion (a lock taken
2351 * during reclaim for a GFP_FS allocation is held over a GFP_FS
2354 if (!hlock->trylock && (curr->lockdep_reclaim_gfp & __GFP_FS)) {
2356 if (!mark_lock(curr, hlock, LOCK_USED_IN_RECLAIM_FS_READ))
2359 if (!mark_lock(curr, hlock, LOCK_USED_IN_RECLAIM_FS))
2367 static int separate_irq_context(struct task_struct *curr,
2368 struct held_lock *hlock)
2370 unsigned int depth = curr->lockdep_depth;
2373 * Keep track of points where we cross into an interrupt context:
2375 hlock->irq_context = 2*(curr->hardirq_context ? 1 : 0) +
2376 curr->softirq_context;
2378 struct held_lock *prev_hlock;
2380 prev_hlock = curr->held_locks + depth-1;
2382 * If we cross into another context, reset the
2383 * hash key (this also prevents the checking and the
2384 * adding of the dependency to 'prev'):
2386 if (prev_hlock->irq_context != hlock->irq_context)
2395 int mark_lock_irq(struct task_struct *curr, struct held_lock *this,
2396 enum lock_usage_bit new_bit)
2402 static inline int mark_irqflags(struct task_struct *curr,
2403 struct held_lock *hlock)
2408 static inline int separate_irq_context(struct task_struct *curr,
2409 struct held_lock *hlock)
2414 void lockdep_trace_alloc(gfp_t gfp_mask)
2421 * Mark a lock with a usage bit, and validate the state transition:
2423 static int mark_lock(struct task_struct *curr, struct held_lock *this,
2424 enum lock_usage_bit new_bit)
2426 unsigned int new_mask = 1 << new_bit, ret = 1;
2429 * If already set then do not dirty the cacheline,
2430 * nor do any checks:
2432 if (likely(hlock_class(this)->usage_mask & new_mask))
2438 * Make sure we didnt race:
2440 if (unlikely(hlock_class(this)->usage_mask & new_mask)) {
2445 hlock_class(this)->usage_mask |= new_mask;
2447 if (!save_trace(hlock_class(this)->usage_traces + new_bit))
2451 #define LOCKDEP_STATE(__STATE) \
2452 case LOCK_USED_IN_##__STATE: \
2453 case LOCK_USED_IN_##__STATE##_READ: \
2454 case LOCK_ENABLED_##__STATE: \
2455 case LOCK_ENABLED_##__STATE##_READ:
2456 #include "lockdep_states.h"
2457 #undef LOCKDEP_STATE
2458 ret = mark_lock_irq(curr, this, new_bit);
2463 debug_atomic_dec(&nr_unused_locks);
2466 if (!debug_locks_off_graph_unlock())
2475 * We must printk outside of the graph_lock:
2478 printk("\nmarked lock as {%s}:\n", usage_str[new_bit]);
2480 print_irqtrace_events(curr);
2488 * Initialize a lock instance's lock-class mapping info:
2490 void lockdep_init_map(struct lockdep_map *lock, const char *name,
2491 struct lock_class_key *key, int subclass)
2493 if (unlikely(!debug_locks))
2496 if (DEBUG_LOCKS_WARN_ON(!key))
2498 if (DEBUG_LOCKS_WARN_ON(!name))
2501 * Sanity check, the lock-class key must be persistent:
2503 if (!static_obj(key)) {
2504 printk("BUG: key %p not in .data!\n", key);
2505 DEBUG_LOCKS_WARN_ON(1);
2510 lock->class_cache = NULL;
2511 #ifdef CONFIG_LOCK_STAT
2512 lock->cpu = raw_smp_processor_id();
2515 register_lock_class(lock, subclass, 1);
2517 EXPORT_SYMBOL_GPL(lockdep_init_map);
2520 * This gets called for every mutex_lock*()/spin_lock*() operation.
2521 * We maintain the dependency maps and validate the locking attempt:
2523 static int __lock_acquire(struct lockdep_map *lock, unsigned int subclass,
2524 int trylock, int read, int check, int hardirqs_off,
2525 struct lockdep_map *nest_lock, unsigned long ip)
2527 struct task_struct *curr = current;
2528 struct lock_class *class = NULL;
2529 struct held_lock *hlock;
2530 unsigned int depth, id;
2537 if (unlikely(!debug_locks))
2540 if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
2543 if (unlikely(subclass >= MAX_LOCKDEP_SUBCLASSES)) {
2545 printk("BUG: MAX_LOCKDEP_SUBCLASSES too low!\n");
2546 printk("turning off the locking correctness validator.\n");
2552 class = lock->class_cache;
2554 * Not cached yet or subclass?
2556 if (unlikely(!class)) {
2557 class = register_lock_class(lock, subclass, 0);
2561 debug_atomic_inc((atomic_t *)&class->ops);
2562 if (very_verbose(class)) {
2563 printk("\nacquire class [%p] %s", class->key, class->name);
2564 if (class->name_version > 1)
2565 printk("#%d", class->name_version);
2571 * Add the lock to the list of currently held locks.
2572 * (we dont increase the depth just yet, up until the
2573 * dependency checks are done)
2575 depth = curr->lockdep_depth;
2576 if (DEBUG_LOCKS_WARN_ON(depth >= MAX_LOCK_DEPTH))
2579 hlock = curr->held_locks + depth;
2580 if (DEBUG_LOCKS_WARN_ON(!class))
2582 hlock->class_idx = class - lock_classes + 1;
2583 hlock->acquire_ip = ip;
2584 hlock->instance = lock;
2585 hlock->nest_lock = nest_lock;
2586 hlock->trylock = trylock;
2588 hlock->check = check;
2589 hlock->hardirqs_off = !!hardirqs_off;
2590 #ifdef CONFIG_LOCK_STAT
2591 hlock->waittime_stamp = 0;
2592 hlock->holdtime_stamp = sched_clock();
2595 if (check == 2 && !mark_irqflags(curr, hlock))
2598 /* mark it as used: */
2599 if (!mark_lock(curr, hlock, LOCK_USED))
2603 * Calculate the chain hash: it's the combined hash of all the
2604 * lock keys along the dependency chain. We save the hash value
2605 * at every step so that we can get the current hash easily
2606 * after unlock. The chain hash is then used to cache dependency
2609 * The 'key ID' is what is the most compact key value to drive
2610 * the hash, not class->key.
2612 id = class - lock_classes;
2613 if (DEBUG_LOCKS_WARN_ON(id >= MAX_LOCKDEP_KEYS))
2616 chain_key = curr->curr_chain_key;
2618 if (DEBUG_LOCKS_WARN_ON(chain_key != 0))
2623 hlock->prev_chain_key = chain_key;
2624 if (separate_irq_context(curr, hlock)) {
2628 chain_key = iterate_chain_key(chain_key, id);
2630 if (!validate_chain(curr, lock, hlock, chain_head, chain_key))
2633 curr->curr_chain_key = chain_key;
2634 curr->lockdep_depth++;
2635 check_chain_key(curr);
2636 #ifdef CONFIG_DEBUG_LOCKDEP
2637 if (unlikely(!debug_locks))
2640 if (unlikely(curr->lockdep_depth >= MAX_LOCK_DEPTH)) {
2642 printk("BUG: MAX_LOCK_DEPTH too low!\n");
2643 printk("turning off the locking correctness validator.\n");
2648 if (unlikely(curr->lockdep_depth > max_lockdep_depth))
2649 max_lockdep_depth = curr->lockdep_depth;
2655 print_unlock_inbalance_bug(struct task_struct *curr, struct lockdep_map *lock,
2658 if (!debug_locks_off())
2660 if (debug_locks_silent)
2663 printk("\n=====================================\n");
2664 printk( "[ BUG: bad unlock balance detected! ]\n");
2665 printk( "-------------------------------------\n");
2666 printk("%s/%d is trying to release lock (",
2667 curr->comm, task_pid_nr(curr));
2668 print_lockdep_cache(lock);
2671 printk("but there are no more locks to release!\n");
2672 printk("\nother info that might help us debug this:\n");
2673 lockdep_print_held_locks(curr);
2675 printk("\nstack backtrace:\n");
2682 * Common debugging checks for both nested and non-nested unlock:
2684 static int check_unlock(struct task_struct *curr, struct lockdep_map *lock,
2687 if (unlikely(!debug_locks))
2689 if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
2692 if (curr->lockdep_depth <= 0)
2693 return print_unlock_inbalance_bug(curr, lock, ip);
2699 __lock_set_class(struct lockdep_map *lock, const char *name,
2700 struct lock_class_key *key, unsigned int subclass,
2703 struct task_struct *curr = current;
2704 struct held_lock *hlock, *prev_hlock;
2705 struct lock_class *class;
2709 depth = curr->lockdep_depth;
2710 if (DEBUG_LOCKS_WARN_ON(!depth))
2714 for (i = depth-1; i >= 0; i--) {
2715 hlock = curr->held_locks + i;
2717 * We must not cross into another context:
2719 if (prev_hlock && prev_hlock->irq_context != hlock->irq_context)
2721 if (hlock->instance == lock)
2725 return print_unlock_inbalance_bug(curr, lock, ip);
2728 lockdep_init_map(lock, name, key, 0);
2729 class = register_lock_class(lock, subclass, 0);
2730 hlock->class_idx = class - lock_classes + 1;
2732 curr->lockdep_depth = i;
2733 curr->curr_chain_key = hlock->prev_chain_key;
2735 for (; i < depth; i++) {
2736 hlock = curr->held_locks + i;
2737 if (!__lock_acquire(hlock->instance,
2738 hlock_class(hlock)->subclass, hlock->trylock,
2739 hlock->read, hlock->check, hlock->hardirqs_off,
2740 hlock->nest_lock, hlock->acquire_ip))
2744 if (DEBUG_LOCKS_WARN_ON(curr->lockdep_depth != depth))
2750 * Remove the lock to the list of currently held locks in a
2751 * potentially non-nested (out of order) manner. This is a
2752 * relatively rare operation, as all the unlock APIs default
2753 * to nested mode (which uses lock_release()):
2756 lock_release_non_nested(struct task_struct *curr,
2757 struct lockdep_map *lock, unsigned long ip)
2759 struct held_lock *hlock, *prev_hlock;
2764 * Check whether the lock exists in the current stack
2767 depth = curr->lockdep_depth;
2768 if (DEBUG_LOCKS_WARN_ON(!depth))
2772 for (i = depth-1; i >= 0; i--) {
2773 hlock = curr->held_locks + i;
2775 * We must not cross into another context:
2777 if (prev_hlock && prev_hlock->irq_context != hlock->irq_context)
2779 if (hlock->instance == lock)
2783 return print_unlock_inbalance_bug(curr, lock, ip);
2786 lock_release_holdtime(hlock);
2789 * We have the right lock to unlock, 'hlock' points to it.
2790 * Now we remove it from the stack, and add back the other
2791 * entries (if any), recalculating the hash along the way:
2793 curr->lockdep_depth = i;
2794 curr->curr_chain_key = hlock->prev_chain_key;
2796 for (i++; i < depth; i++) {
2797 hlock = curr->held_locks + i;
2798 if (!__lock_acquire(hlock->instance,
2799 hlock_class(hlock)->subclass, hlock->trylock,
2800 hlock->read, hlock->check, hlock->hardirqs_off,
2801 hlock->nest_lock, hlock->acquire_ip))
2805 if (DEBUG_LOCKS_WARN_ON(curr->lockdep_depth != depth - 1))
2811 * Remove the lock to the list of currently held locks - this gets
2812 * called on mutex_unlock()/spin_unlock*() (or on a failed
2813 * mutex_lock_interruptible()). This is done for unlocks that nest
2814 * perfectly. (i.e. the current top of the lock-stack is unlocked)
2816 static int lock_release_nested(struct task_struct *curr,
2817 struct lockdep_map *lock, unsigned long ip)
2819 struct held_lock *hlock;
2823 * Pop off the top of the lock stack:
2825 depth = curr->lockdep_depth - 1;
2826 hlock = curr->held_locks + depth;
2829 * Is the unlock non-nested:
2831 if (hlock->instance != lock)
2832 return lock_release_non_nested(curr, lock, ip);
2833 curr->lockdep_depth--;
2835 if (DEBUG_LOCKS_WARN_ON(!depth && (hlock->prev_chain_key != 0)))
2838 curr->curr_chain_key = hlock->prev_chain_key;
2840 lock_release_holdtime(hlock);
2842 #ifdef CONFIG_DEBUG_LOCKDEP
2843 hlock->prev_chain_key = 0;
2844 hlock->class_idx = 0;
2845 hlock->acquire_ip = 0;
2846 hlock->irq_context = 0;
2852 * Remove the lock to the list of currently held locks - this gets
2853 * called on mutex_unlock()/spin_unlock*() (or on a failed
2854 * mutex_lock_interruptible()). This is done for unlocks that nest
2855 * perfectly. (i.e. the current top of the lock-stack is unlocked)
2858 __lock_release(struct lockdep_map *lock, int nested, unsigned long ip)
2860 struct task_struct *curr = current;
2862 if (!check_unlock(curr, lock, ip))
2866 if (!lock_release_nested(curr, lock, ip))
2869 if (!lock_release_non_nested(curr, lock, ip))
2873 check_chain_key(curr);
2877 * Check whether we follow the irq-flags state precisely:
2879 static void check_flags(unsigned long flags)
2881 #if defined(CONFIG_PROVE_LOCKING) && defined(CONFIG_DEBUG_LOCKDEP) && \
2882 defined(CONFIG_TRACE_IRQFLAGS)
2886 if (irqs_disabled_flags(flags)) {
2887 if (DEBUG_LOCKS_WARN_ON(current->hardirqs_enabled)) {
2888 printk("possible reason: unannotated irqs-off.\n");
2891 if (DEBUG_LOCKS_WARN_ON(!current->hardirqs_enabled)) {
2892 printk("possible reason: unannotated irqs-on.\n");
2897 * We dont accurately track softirq state in e.g.
2898 * hardirq contexts (such as on 4KSTACKS), so only
2899 * check if not in hardirq contexts:
2901 if (!hardirq_count()) {
2902 if (softirq_count())
2903 DEBUG_LOCKS_WARN_ON(current->softirqs_enabled);
2905 DEBUG_LOCKS_WARN_ON(!current->softirqs_enabled);
2909 print_irqtrace_events(current);
2913 void lock_set_class(struct lockdep_map *lock, const char *name,
2914 struct lock_class_key *key, unsigned int subclass,
2917 unsigned long flags;
2919 if (unlikely(current->lockdep_recursion))
2922 raw_local_irq_save(flags);
2923 current->lockdep_recursion = 1;
2925 if (__lock_set_class(lock, name, key, subclass, ip))
2926 check_chain_key(current);
2927 current->lockdep_recursion = 0;
2928 raw_local_irq_restore(flags);
2930 EXPORT_SYMBOL_GPL(lock_set_class);
2932 DEFINE_TRACE(lock_acquire);
2935 * We are not always called with irqs disabled - do that here,
2936 * and also avoid lockdep recursion:
2938 void lock_acquire(struct lockdep_map *lock, unsigned int subclass,
2939 int trylock, int read, int check,
2940 struct lockdep_map *nest_lock, unsigned long ip)
2942 unsigned long flags;
2944 trace_lock_acquire(lock, subclass, trylock, read, check, nest_lock, ip);
2946 if (unlikely(current->lockdep_recursion))
2949 raw_local_irq_save(flags);
2952 current->lockdep_recursion = 1;
2953 __lock_acquire(lock, subclass, trylock, read, check,
2954 irqs_disabled_flags(flags), nest_lock, ip);
2955 current->lockdep_recursion = 0;
2956 raw_local_irq_restore(flags);
2958 EXPORT_SYMBOL_GPL(lock_acquire);
2960 DEFINE_TRACE(lock_release);
2962 void lock_release(struct lockdep_map *lock, int nested,
2965 unsigned long flags;
2967 trace_lock_release(lock, nested, ip);
2969 if (unlikely(current->lockdep_recursion))
2972 raw_local_irq_save(flags);
2974 current->lockdep_recursion = 1;
2975 __lock_release(lock, nested, ip);
2976 current->lockdep_recursion = 0;
2977 raw_local_irq_restore(flags);
2979 EXPORT_SYMBOL_GPL(lock_release);
2981 void lockdep_set_current_reclaim_state(gfp_t gfp_mask)
2983 current->lockdep_reclaim_gfp = gfp_mask;
2986 void lockdep_clear_current_reclaim_state(void)
2988 current->lockdep_reclaim_gfp = 0;
2991 #ifdef CONFIG_LOCK_STAT
2993 print_lock_contention_bug(struct task_struct *curr, struct lockdep_map *lock,
2996 if (!debug_locks_off())
2998 if (debug_locks_silent)
3001 printk("\n=================================\n");
3002 printk( "[ BUG: bad contention detected! ]\n");
3003 printk( "---------------------------------\n");
3004 printk("%s/%d is trying to contend lock (",
3005 curr->comm, task_pid_nr(curr));
3006 print_lockdep_cache(lock);
3009 printk("but there are no locks held!\n");
3010 printk("\nother info that might help us debug this:\n");
3011 lockdep_print_held_locks(curr);
3013 printk("\nstack backtrace:\n");
3020 __lock_contended(struct lockdep_map *lock, unsigned long ip)
3022 struct task_struct *curr = current;
3023 struct held_lock *hlock, *prev_hlock;
3024 struct lock_class_stats *stats;
3026 int i, contention_point, contending_point;
3028 depth = curr->lockdep_depth;
3029 if (DEBUG_LOCKS_WARN_ON(!depth))
3033 for (i = depth-1; i >= 0; i--) {
3034 hlock = curr->held_locks + i;
3036 * We must not cross into another context:
3038 if (prev_hlock && prev_hlock->irq_context != hlock->irq_context)
3040 if (hlock->instance == lock)
3044 print_lock_contention_bug(curr, lock, ip);
3048 hlock->waittime_stamp = sched_clock();
3050 contention_point = lock_point(hlock_class(hlock)->contention_point, ip);
3051 contending_point = lock_point(hlock_class(hlock)->contending_point,
3054 stats = get_lock_stats(hlock_class(hlock));
3055 if (contention_point < LOCKSTAT_POINTS)
3056 stats->contention_point[contention_point]++;
3057 if (contending_point < LOCKSTAT_POINTS)
3058 stats->contending_point[contending_point]++;
3059 if (lock->cpu != smp_processor_id())
3060 stats->bounces[bounce_contended + !!hlock->read]++;
3061 put_lock_stats(stats);
3065 __lock_acquired(struct lockdep_map *lock, unsigned long ip)
3067 struct task_struct *curr = current;
3068 struct held_lock *hlock, *prev_hlock;
3069 struct lock_class_stats *stats;
3075 depth = curr->lockdep_depth;
3076 if (DEBUG_LOCKS_WARN_ON(!depth))
3080 for (i = depth-1; i >= 0; i--) {
3081 hlock = curr->held_locks + i;
3083 * We must not cross into another context:
3085 if (prev_hlock && prev_hlock->irq_context != hlock->irq_context)
3087 if (hlock->instance == lock)
3091 print_lock_contention_bug(curr, lock, _RET_IP_);
3095 cpu = smp_processor_id();
3096 if (hlock->waittime_stamp) {
3097 now = sched_clock();
3098 waittime = now - hlock->waittime_stamp;
3099 hlock->holdtime_stamp = now;
3102 stats = get_lock_stats(hlock_class(hlock));
3105 lock_time_inc(&stats->read_waittime, waittime);
3107 lock_time_inc(&stats->write_waittime, waittime);
3109 if (lock->cpu != cpu)
3110 stats->bounces[bounce_acquired + !!hlock->read]++;
3111 put_lock_stats(stats);
3117 DEFINE_TRACE(lock_contended);
3119 void lock_contended(struct lockdep_map *lock, unsigned long ip)
3121 unsigned long flags;
3123 trace_lock_contended(lock, ip);
3125 if (unlikely(!lock_stat))
3128 if (unlikely(current->lockdep_recursion))
3131 raw_local_irq_save(flags);
3133 current->lockdep_recursion = 1;
3134 __lock_contended(lock, ip);
3135 current->lockdep_recursion = 0;
3136 raw_local_irq_restore(flags);
3138 EXPORT_SYMBOL_GPL(lock_contended);
3140 DEFINE_TRACE(lock_acquired);
3142 void lock_acquired(struct lockdep_map *lock, unsigned long ip)
3144 unsigned long flags;
3146 trace_lock_acquired(lock, ip);
3148 if (unlikely(!lock_stat))
3151 if (unlikely(current->lockdep_recursion))
3154 raw_local_irq_save(flags);
3156 current->lockdep_recursion = 1;
3157 __lock_acquired(lock, ip);
3158 current->lockdep_recursion = 0;
3159 raw_local_irq_restore(flags);
3161 EXPORT_SYMBOL_GPL(lock_acquired);
3165 * Used by the testsuite, sanitize the validator state
3166 * after a simulated failure:
3169 void lockdep_reset(void)
3171 unsigned long flags;
3174 raw_local_irq_save(flags);
3175 current->curr_chain_key = 0;
3176 current->lockdep_depth = 0;
3177 current->lockdep_recursion = 0;
3178 memset(current->held_locks, 0, MAX_LOCK_DEPTH*sizeof(struct held_lock));
3179 nr_hardirq_chains = 0;
3180 nr_softirq_chains = 0;
3181 nr_process_chains = 0;
3183 for (i = 0; i < CHAINHASH_SIZE; i++)
3184 INIT_LIST_HEAD(chainhash_table + i);
3185 raw_local_irq_restore(flags);
3188 static void zap_class(struct lock_class *class)
3193 * Remove all dependencies this lock is
3196 for (i = 0; i < nr_list_entries; i++) {
3197 if (list_entries[i].class == class)
3198 list_del_rcu(&list_entries[i].entry);
3201 * Unhash the class and remove it from the all_lock_classes list:
3203 list_del_rcu(&class->hash_entry);
3204 list_del_rcu(&class->lock_entry);
3209 static inline int within(const void *addr, void *start, unsigned long size)
3211 return addr >= start && addr < start + size;
3214 void lockdep_free_key_range(void *start, unsigned long size)
3216 struct lock_class *class, *next;
3217 struct list_head *head;
3218 unsigned long flags;
3222 raw_local_irq_save(flags);
3223 locked = graph_lock();
3226 * Unhash all classes that were created by this module:
3228 for (i = 0; i < CLASSHASH_SIZE; i++) {
3229 head = classhash_table + i;
3230 if (list_empty(head))
3232 list_for_each_entry_safe(class, next, head, hash_entry) {
3233 if (within(class->key, start, size))
3235 else if (within(class->name, start, size))
3242 raw_local_irq_restore(flags);
3245 void lockdep_reset_lock(struct lockdep_map *lock)
3247 struct lock_class *class, *next;
3248 struct list_head *head;
3249 unsigned long flags;
3253 raw_local_irq_save(flags);
3256 * Remove all classes this lock might have:
3258 for (j = 0; j < MAX_LOCKDEP_SUBCLASSES; j++) {
3260 * If the class exists we look it up and zap it:
3262 class = look_up_lock_class(lock, j);
3267 * Debug check: in the end all mapped classes should
3270 locked = graph_lock();
3271 for (i = 0; i < CLASSHASH_SIZE; i++) {
3272 head = classhash_table + i;
3273 if (list_empty(head))
3275 list_for_each_entry_safe(class, next, head, hash_entry) {
3276 if (unlikely(class == lock->class_cache)) {
3277 if (debug_locks_off_graph_unlock())
3287 raw_local_irq_restore(flags);
3290 void lockdep_init(void)
3295 * Some architectures have their own start_kernel()
3296 * code which calls lockdep_init(), while we also
3297 * call lockdep_init() from the start_kernel() itself,
3298 * and we want to initialize the hashes only once:
3300 if (lockdep_initialized)
3303 for (i = 0; i < CLASSHASH_SIZE; i++)
3304 INIT_LIST_HEAD(classhash_table + i);
3306 for (i = 0; i < CHAINHASH_SIZE; i++)
3307 INIT_LIST_HEAD(chainhash_table + i);
3309 lockdep_initialized = 1;
3312 void __init lockdep_info(void)
3314 printk("Lock dependency validator: Copyright (c) 2006 Red Hat, Inc., Ingo Molnar\n");
3316 printk("... MAX_LOCKDEP_SUBCLASSES: %lu\n", MAX_LOCKDEP_SUBCLASSES);
3317 printk("... MAX_LOCK_DEPTH: %lu\n", MAX_LOCK_DEPTH);
3318 printk("... MAX_LOCKDEP_KEYS: %lu\n", MAX_LOCKDEP_KEYS);
3319 printk("... CLASSHASH_SIZE: %lu\n", CLASSHASH_SIZE);
3320 printk("... MAX_LOCKDEP_ENTRIES: %lu\n", MAX_LOCKDEP_ENTRIES);
3321 printk("... MAX_LOCKDEP_CHAINS: %lu\n", MAX_LOCKDEP_CHAINS);
3322 printk("... CHAINHASH_SIZE: %lu\n", CHAINHASH_SIZE);
3324 printk(" memory used by lock dependency info: %lu kB\n",
3325 (sizeof(struct lock_class) * MAX_LOCKDEP_KEYS +
3326 sizeof(struct list_head) * CLASSHASH_SIZE +
3327 sizeof(struct lock_list) * MAX_LOCKDEP_ENTRIES +
3328 sizeof(struct lock_chain) * MAX_LOCKDEP_CHAINS +
3329 sizeof(struct list_head) * CHAINHASH_SIZE) / 1024);
3331 printk(" per task-struct memory footprint: %lu bytes\n",
3332 sizeof(struct held_lock) * MAX_LOCK_DEPTH);
3334 #ifdef CONFIG_DEBUG_LOCKDEP
3335 if (lockdep_init_error) {
3336 printk("WARNING: lockdep init error! Arch code didn't call lockdep_init() early enough?\n");
3337 printk("Call stack leading to lockdep invocation was:\n");
3338 print_stack_trace(&lockdep_init_trace, 0);
3344 print_freed_lock_bug(struct task_struct *curr, const void *mem_from,
3345 const void *mem_to, struct held_lock *hlock)
3347 if (!debug_locks_off())
3349 if (debug_locks_silent)
3352 printk("\n=========================\n");
3353 printk( "[ BUG: held lock freed! ]\n");
3354 printk( "-------------------------\n");
3355 printk("%s/%d is freeing memory %p-%p, with a lock still held there!\n",
3356 curr->comm, task_pid_nr(curr), mem_from, mem_to-1);
3358 lockdep_print_held_locks(curr);
3360 printk("\nstack backtrace:\n");
3364 static inline int not_in_range(const void* mem_from, unsigned long mem_len,
3365 const void* lock_from, unsigned long lock_len)
3367 return lock_from + lock_len <= mem_from ||
3368 mem_from + mem_len <= lock_from;
3372 * Called when kernel memory is freed (or unmapped), or if a lock
3373 * is destroyed or reinitialized - this code checks whether there is
3374 * any held lock in the memory range of <from> to <to>:
3376 void debug_check_no_locks_freed(const void *mem_from, unsigned long mem_len)
3378 struct task_struct *curr = current;
3379 struct held_lock *hlock;
3380 unsigned long flags;
3383 if (unlikely(!debug_locks))
3386 local_irq_save(flags);
3387 for (i = 0; i < curr->lockdep_depth; i++) {
3388 hlock = curr->held_locks + i;
3390 if (not_in_range(mem_from, mem_len, hlock->instance,
3391 sizeof(*hlock->instance)))
3394 print_freed_lock_bug(curr, mem_from, mem_from + mem_len, hlock);
3397 local_irq_restore(flags);
3399 EXPORT_SYMBOL_GPL(debug_check_no_locks_freed);
3401 static void print_held_locks_bug(struct task_struct *curr)
3403 if (!debug_locks_off())
3405 if (debug_locks_silent)
3408 printk("\n=====================================\n");
3409 printk( "[ BUG: lock held at task exit time! ]\n");
3410 printk( "-------------------------------------\n");
3411 printk("%s/%d is exiting with locks still held!\n",
3412 curr->comm, task_pid_nr(curr));
3413 lockdep_print_held_locks(curr);
3415 printk("\nstack backtrace:\n");
3419 void debug_check_no_locks_held(struct task_struct *task)
3421 if (unlikely(task->lockdep_depth > 0))
3422 print_held_locks_bug(task);
3425 void debug_show_all_locks(void)
3427 struct task_struct *g, *p;
3431 if (unlikely(!debug_locks)) {
3432 printk("INFO: lockdep is turned off.\n");
3435 printk("\nShowing all locks held in the system:\n");
3438 * Here we try to get the tasklist_lock as hard as possible,
3439 * if not successful after 2 seconds we ignore it (but keep
3440 * trying). This is to enable a debug printout even if a
3441 * tasklist_lock-holding task deadlocks or crashes.
3444 if (!read_trylock(&tasklist_lock)) {
3446 printk("hm, tasklist_lock locked, retrying... ");
3449 printk(" #%d", 10-count);
3453 printk(" ignoring it.\n");
3457 printk(KERN_CONT " locked it.\n");
3460 do_each_thread(g, p) {
3462 * It's not reliable to print a task's held locks
3463 * if it's not sleeping (or if it's not the current
3466 if (p->state == TASK_RUNNING && p != current)
3468 if (p->lockdep_depth)
3469 lockdep_print_held_locks(p);
3471 if (read_trylock(&tasklist_lock))
3473 } while_each_thread(g, p);
3476 printk("=============================================\n\n");
3479 read_unlock(&tasklist_lock);
3481 EXPORT_SYMBOL_GPL(debug_show_all_locks);
3484 * Careful: only use this function if you are sure that
3485 * the task cannot run in parallel!
3487 void __debug_show_held_locks(struct task_struct *task)
3489 if (unlikely(!debug_locks)) {
3490 printk("INFO: lockdep is turned off.\n");
3493 lockdep_print_held_locks(task);
3495 EXPORT_SYMBOL_GPL(__debug_show_held_locks);
3497 void debug_show_held_locks(struct task_struct *task)
3499 __debug_show_held_locks(task);
3501 EXPORT_SYMBOL_GPL(debug_show_held_locks);
3503 void lockdep_sys_exit(void)
3505 struct task_struct *curr = current;
3507 if (unlikely(curr->lockdep_depth)) {
3508 if (!debug_locks_off())
3510 printk("\n================================================\n");
3511 printk( "[ BUG: lock held when returning to user space! ]\n");
3512 printk( "------------------------------------------------\n");
3513 printk("%s/%d is leaving the kernel with locks still held!\n",
3514 curr->comm, curr->pid);
3515 lockdep_print_held_locks(curr);