Merge branch 'dp83867-impedance-control'
[linux-2.6/btrfs-unstable.git] / kernel / locking / lockdep.c
blob589d763a49b3952322f08c00286675f314a3f76c
1 /*
2 * kernel/lockdep.c
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
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 <linux/bitops.h>
46 #include <linux/gfp.h>
47 #include <linux/kmemcheck.h>
48 #include <linux/random.h>
49 #include <linux/jhash.h>
51 #include <asm/sections.h>
53 #include "lockdep_internals.h"
55 #define CREATE_TRACE_POINTS
56 #include <trace/events/lock.h>
58 #ifdef CONFIG_PROVE_LOCKING
59 int prove_locking = 1;
60 module_param(prove_locking, int, 0644);
61 #else
62 #define prove_locking 0
63 #endif
65 #ifdef CONFIG_LOCK_STAT
66 int lock_stat = 1;
67 module_param(lock_stat, int, 0644);
68 #else
69 #define lock_stat 0
70 #endif
73 * lockdep_lock: protects the lockdep graph, the hashes and the
74 * class/list/hash allocators.
76 * This is one of the rare exceptions where it's justified
77 * to use a raw spinlock - we really dont want the spinlock
78 * code to recurse back into the lockdep code...
80 static arch_spinlock_t lockdep_lock = (arch_spinlock_t)__ARCH_SPIN_LOCK_UNLOCKED;
82 static int graph_lock(void)
84 arch_spin_lock(&lockdep_lock);
86 * Make sure that if another CPU detected a bug while
87 * walking the graph we dont change it (while the other
88 * CPU is busy printing out stuff with the graph lock
89 * dropped already)
91 if (!debug_locks) {
92 arch_spin_unlock(&lockdep_lock);
93 return 0;
95 /* prevent any recursions within lockdep from causing deadlocks */
96 current->lockdep_recursion++;
97 return 1;
100 static inline int graph_unlock(void)
102 if (debug_locks && !arch_spin_is_locked(&lockdep_lock)) {
104 * The lockdep graph lock isn't locked while we expect it to
105 * be, we're confused now, bye!
107 return DEBUG_LOCKS_WARN_ON(1);
110 current->lockdep_recursion--;
111 arch_spin_unlock(&lockdep_lock);
112 return 0;
116 * Turn lock debugging off and return with 0 if it was off already,
117 * and also release the graph lock:
119 static inline int debug_locks_off_graph_unlock(void)
121 int ret = debug_locks_off();
123 arch_spin_unlock(&lockdep_lock);
125 return ret;
128 unsigned long nr_list_entries;
129 static struct lock_list list_entries[MAX_LOCKDEP_ENTRIES];
132 * All data structures here are protected by the global debug_lock.
134 * Mutex key structs only get allocated, once during bootup, and never
135 * get freed - this significantly simplifies the debugging code.
137 unsigned long nr_lock_classes;
138 static struct lock_class lock_classes[MAX_LOCKDEP_KEYS];
140 static inline struct lock_class *hlock_class(struct held_lock *hlock)
142 if (!hlock->class_idx) {
144 * Someone passed in garbage, we give up.
146 DEBUG_LOCKS_WARN_ON(1);
147 return NULL;
149 return lock_classes + hlock->class_idx - 1;
152 #ifdef CONFIG_LOCK_STAT
153 static DEFINE_PER_CPU(struct lock_class_stats[MAX_LOCKDEP_KEYS], cpu_lock_stats);
155 static inline u64 lockstat_clock(void)
157 return local_clock();
160 static int lock_point(unsigned long points[], unsigned long ip)
162 int i;
164 for (i = 0; i < LOCKSTAT_POINTS; i++) {
165 if (points[i] == 0) {
166 points[i] = ip;
167 break;
169 if (points[i] == ip)
170 break;
173 return i;
176 static void lock_time_inc(struct lock_time *lt, u64 time)
178 if (time > lt->max)
179 lt->max = time;
181 if (time < lt->min || !lt->nr)
182 lt->min = time;
184 lt->total += time;
185 lt->nr++;
188 static inline void lock_time_add(struct lock_time *src, struct lock_time *dst)
190 if (!src->nr)
191 return;
193 if (src->max > dst->max)
194 dst->max = src->max;
196 if (src->min < dst->min || !dst->nr)
197 dst->min = src->min;
199 dst->total += src->total;
200 dst->nr += src->nr;
203 struct lock_class_stats lock_stats(struct lock_class *class)
205 struct lock_class_stats stats;
206 int cpu, i;
208 memset(&stats, 0, sizeof(struct lock_class_stats));
209 for_each_possible_cpu(cpu) {
210 struct lock_class_stats *pcs =
211 &per_cpu(cpu_lock_stats, cpu)[class - lock_classes];
213 for (i = 0; i < ARRAY_SIZE(stats.contention_point); i++)
214 stats.contention_point[i] += pcs->contention_point[i];
216 for (i = 0; i < ARRAY_SIZE(stats.contending_point); i++)
217 stats.contending_point[i] += pcs->contending_point[i];
219 lock_time_add(&pcs->read_waittime, &stats.read_waittime);
220 lock_time_add(&pcs->write_waittime, &stats.write_waittime);
222 lock_time_add(&pcs->read_holdtime, &stats.read_holdtime);
223 lock_time_add(&pcs->write_holdtime, &stats.write_holdtime);
225 for (i = 0; i < ARRAY_SIZE(stats.bounces); i++)
226 stats.bounces[i] += pcs->bounces[i];
229 return stats;
232 void clear_lock_stats(struct lock_class *class)
234 int cpu;
236 for_each_possible_cpu(cpu) {
237 struct lock_class_stats *cpu_stats =
238 &per_cpu(cpu_lock_stats, cpu)[class - lock_classes];
240 memset(cpu_stats, 0, sizeof(struct lock_class_stats));
242 memset(class->contention_point, 0, sizeof(class->contention_point));
243 memset(class->contending_point, 0, sizeof(class->contending_point));
246 static struct lock_class_stats *get_lock_stats(struct lock_class *class)
248 return &get_cpu_var(cpu_lock_stats)[class - lock_classes];
251 static void put_lock_stats(struct lock_class_stats *stats)
253 put_cpu_var(cpu_lock_stats);
256 static void lock_release_holdtime(struct held_lock *hlock)
258 struct lock_class_stats *stats;
259 u64 holdtime;
261 if (!lock_stat)
262 return;
264 holdtime = lockstat_clock() - hlock->holdtime_stamp;
266 stats = get_lock_stats(hlock_class(hlock));
267 if (hlock->read)
268 lock_time_inc(&stats->read_holdtime, holdtime);
269 else
270 lock_time_inc(&stats->write_holdtime, holdtime);
271 put_lock_stats(stats);
273 #else
274 static inline void lock_release_holdtime(struct held_lock *hlock)
277 #endif
280 * We keep a global list of all lock classes. The list only grows,
281 * never shrinks. The list is only accessed with the lockdep
282 * spinlock lock held.
284 LIST_HEAD(all_lock_classes);
287 * The lockdep classes are in a hash-table as well, for fast lookup:
289 #define CLASSHASH_BITS (MAX_LOCKDEP_KEYS_BITS - 1)
290 #define CLASSHASH_SIZE (1UL << CLASSHASH_BITS)
291 #define __classhashfn(key) hash_long((unsigned long)key, CLASSHASH_BITS)
292 #define classhashentry(key) (classhash_table + __classhashfn((key)))
294 static struct hlist_head classhash_table[CLASSHASH_SIZE];
297 * We put the lock dependency chains into a hash-table as well, to cache
298 * their existence:
300 #define CHAINHASH_BITS (MAX_LOCKDEP_CHAINS_BITS-1)
301 #define CHAINHASH_SIZE (1UL << CHAINHASH_BITS)
302 #define __chainhashfn(chain) hash_long(chain, CHAINHASH_BITS)
303 #define chainhashentry(chain) (chainhash_table + __chainhashfn((chain)))
305 static struct hlist_head chainhash_table[CHAINHASH_SIZE];
308 * The hash key of the lock dependency chains is a hash itself too:
309 * it's a hash of all locks taken up to that lock, including that lock.
310 * It's a 64-bit hash, because it's important for the keys to be
311 * unique.
313 static inline u64 iterate_chain_key(u64 key, u32 idx)
315 u32 k0 = key, k1 = key >> 32;
317 __jhash_mix(idx, k0, k1); /* Macro that modifies arguments! */
319 return k0 | (u64)k1 << 32;
322 void lockdep_off(void)
324 current->lockdep_recursion++;
326 EXPORT_SYMBOL(lockdep_off);
328 void lockdep_on(void)
330 current->lockdep_recursion--;
332 EXPORT_SYMBOL(lockdep_on);
335 * Debugging switches:
338 #define VERBOSE 0
339 #define VERY_VERBOSE 0
341 #if VERBOSE
342 # define HARDIRQ_VERBOSE 1
343 # define SOFTIRQ_VERBOSE 1
344 # define RECLAIM_VERBOSE 1
345 #else
346 # define HARDIRQ_VERBOSE 0
347 # define SOFTIRQ_VERBOSE 0
348 # define RECLAIM_VERBOSE 0
349 #endif
351 #if VERBOSE || HARDIRQ_VERBOSE || SOFTIRQ_VERBOSE || RECLAIM_VERBOSE
353 * Quick filtering for interesting events:
355 static int class_filter(struct lock_class *class)
357 #if 0
358 /* Example */
359 if (class->name_version == 1 &&
360 !strcmp(class->name, "lockname"))
361 return 1;
362 if (class->name_version == 1 &&
363 !strcmp(class->name, "&struct->lockfield"))
364 return 1;
365 #endif
366 /* Filter everything else. 1 would be to allow everything else */
367 return 0;
369 #endif
371 static int verbose(struct lock_class *class)
373 #if VERBOSE
374 return class_filter(class);
375 #endif
376 return 0;
380 * Stack-trace: tightly packed array of stack backtrace
381 * addresses. Protected by the graph_lock.
383 unsigned long nr_stack_trace_entries;
384 static unsigned long stack_trace[MAX_STACK_TRACE_ENTRIES];
386 static void print_lockdep_off(const char *bug_msg)
388 printk(KERN_DEBUG "%s\n", bug_msg);
389 printk(KERN_DEBUG "turning off the locking correctness validator.\n");
390 #ifdef CONFIG_LOCK_STAT
391 printk(KERN_DEBUG "Please attach the output of /proc/lock_stat to the bug report\n");
392 #endif
395 static int save_trace(struct stack_trace *trace)
397 trace->nr_entries = 0;
398 trace->max_entries = MAX_STACK_TRACE_ENTRIES - nr_stack_trace_entries;
399 trace->entries = stack_trace + nr_stack_trace_entries;
401 trace->skip = 3;
403 save_stack_trace(trace);
406 * Some daft arches put -1 at the end to indicate its a full trace.
408 * <rant> this is buggy anyway, since it takes a whole extra entry so a
409 * complete trace that maxes out the entries provided will be reported
410 * as incomplete, friggin useless </rant>
412 if (trace->nr_entries != 0 &&
413 trace->entries[trace->nr_entries-1] == ULONG_MAX)
414 trace->nr_entries--;
416 trace->max_entries = trace->nr_entries;
418 nr_stack_trace_entries += trace->nr_entries;
420 if (nr_stack_trace_entries >= MAX_STACK_TRACE_ENTRIES-1) {
421 if (!debug_locks_off_graph_unlock())
422 return 0;
424 print_lockdep_off("BUG: MAX_STACK_TRACE_ENTRIES too low!");
425 dump_stack();
427 return 0;
430 return 1;
433 unsigned int nr_hardirq_chains;
434 unsigned int nr_softirq_chains;
435 unsigned int nr_process_chains;
436 unsigned int max_lockdep_depth;
438 #ifdef CONFIG_DEBUG_LOCKDEP
440 * Various lockdep statistics:
442 DEFINE_PER_CPU(struct lockdep_stats, lockdep_stats);
443 #endif
446 * Locking printouts:
449 #define __USAGE(__STATE) \
450 [LOCK_USED_IN_##__STATE] = "IN-"__stringify(__STATE)"-W", \
451 [LOCK_ENABLED_##__STATE] = __stringify(__STATE)"-ON-W", \
452 [LOCK_USED_IN_##__STATE##_READ] = "IN-"__stringify(__STATE)"-R",\
453 [LOCK_ENABLED_##__STATE##_READ] = __stringify(__STATE)"-ON-R",
455 static const char *usage_str[] =
457 #define LOCKDEP_STATE(__STATE) __USAGE(__STATE)
458 #include "lockdep_states.h"
459 #undef LOCKDEP_STATE
460 [LOCK_USED] = "INITIAL USE",
463 const char * __get_key_name(struct lockdep_subclass_key *key, char *str)
465 return kallsyms_lookup((unsigned long)key, NULL, NULL, NULL, str);
468 static inline unsigned long lock_flag(enum lock_usage_bit bit)
470 return 1UL << bit;
473 static char get_usage_char(struct lock_class *class, enum lock_usage_bit bit)
475 char c = '.';
477 if (class->usage_mask & lock_flag(bit + 2))
478 c = '+';
479 if (class->usage_mask & lock_flag(bit)) {
480 c = '-';
481 if (class->usage_mask & lock_flag(bit + 2))
482 c = '?';
485 return c;
488 void get_usage_chars(struct lock_class *class, char usage[LOCK_USAGE_CHARS])
490 int i = 0;
492 #define LOCKDEP_STATE(__STATE) \
493 usage[i++] = get_usage_char(class, LOCK_USED_IN_##__STATE); \
494 usage[i++] = get_usage_char(class, LOCK_USED_IN_##__STATE##_READ);
495 #include "lockdep_states.h"
496 #undef LOCKDEP_STATE
498 usage[i] = '\0';
501 static void __print_lock_name(struct lock_class *class)
503 char str[KSYM_NAME_LEN];
504 const char *name;
506 name = class->name;
507 if (!name) {
508 name = __get_key_name(class->key, str);
509 printk("%s", name);
510 } else {
511 printk("%s", name);
512 if (class->name_version > 1)
513 printk("#%d", class->name_version);
514 if (class->subclass)
515 printk("/%d", class->subclass);
519 static void print_lock_name(struct lock_class *class)
521 char usage[LOCK_USAGE_CHARS];
523 get_usage_chars(class, usage);
525 printk(" (");
526 __print_lock_name(class);
527 printk("){%s}", usage);
530 static void print_lockdep_cache(struct lockdep_map *lock)
532 const char *name;
533 char str[KSYM_NAME_LEN];
535 name = lock->name;
536 if (!name)
537 name = __get_key_name(lock->key->subkeys, str);
539 printk("%s", name);
542 static void print_lock(struct held_lock *hlock)
545 * We can be called locklessly through debug_show_all_locks() so be
546 * extra careful, the hlock might have been released and cleared.
548 unsigned int class_idx = hlock->class_idx;
550 /* Don't re-read hlock->class_idx, can't use READ_ONCE() on bitfields: */
551 barrier();
553 if (!class_idx || (class_idx - 1) >= MAX_LOCKDEP_KEYS) {
554 printk("<RELEASED>\n");
555 return;
558 print_lock_name(lock_classes + class_idx - 1);
559 printk(", at: ");
560 print_ip_sym(hlock->acquire_ip);
563 static void lockdep_print_held_locks(struct task_struct *curr)
565 int i, depth = curr->lockdep_depth;
567 if (!depth) {
568 printk("no locks held by %s/%d.\n", curr->comm, task_pid_nr(curr));
569 return;
571 printk("%d lock%s held by %s/%d:\n",
572 depth, depth > 1 ? "s" : "", curr->comm, task_pid_nr(curr));
574 for (i = 0; i < depth; i++) {
575 printk(" #%d: ", i);
576 print_lock(curr->held_locks + i);
580 static void print_kernel_ident(void)
582 printk("%s %.*s %s\n", init_utsname()->release,
583 (int)strcspn(init_utsname()->version, " "),
584 init_utsname()->version,
585 print_tainted());
588 static int very_verbose(struct lock_class *class)
590 #if VERY_VERBOSE
591 return class_filter(class);
592 #endif
593 return 0;
597 * Is this the address of a static object:
599 #ifdef __KERNEL__
600 static int static_obj(void *obj)
602 unsigned long start = (unsigned long) &_stext,
603 end = (unsigned long) &_end,
604 addr = (unsigned long) obj;
607 * static variable?
609 if ((addr >= start) && (addr < end))
610 return 1;
612 if (arch_is_kernel_data(addr))
613 return 1;
616 * in-kernel percpu var?
618 if (is_kernel_percpu_address(addr))
619 return 1;
622 * module static or percpu var?
624 return is_module_address(addr) || is_module_percpu_address(addr);
626 #endif
629 * To make lock name printouts unique, we calculate a unique
630 * class->name_version generation counter:
632 static int count_matching_names(struct lock_class *new_class)
634 struct lock_class *class;
635 int count = 0;
637 if (!new_class->name)
638 return 0;
640 list_for_each_entry_rcu(class, &all_lock_classes, lock_entry) {
641 if (new_class->key - new_class->subclass == class->key)
642 return class->name_version;
643 if (class->name && !strcmp(class->name, new_class->name))
644 count = max(count, class->name_version);
647 return count + 1;
651 * Register a lock's class in the hash-table, if the class is not present
652 * yet. Otherwise we look it up. We cache the result in the lock object
653 * itself, so actual lookup of the hash should be once per lock object.
655 static inline struct lock_class *
656 look_up_lock_class(struct lockdep_map *lock, unsigned int subclass)
658 struct lockdep_subclass_key *key;
659 struct hlist_head *hash_head;
660 struct lock_class *class;
662 if (unlikely(subclass >= MAX_LOCKDEP_SUBCLASSES)) {
663 debug_locks_off();
664 printk(KERN_ERR
665 "BUG: looking up invalid subclass: %u\n", subclass);
666 printk(KERN_ERR
667 "turning off the locking correctness validator.\n");
668 dump_stack();
669 return NULL;
673 * Static locks do not have their class-keys yet - for them the key
674 * is the lock object itself:
676 if (unlikely(!lock->key))
677 lock->key = (void *)lock;
680 * NOTE: the class-key must be unique. For dynamic locks, a static
681 * lock_class_key variable is passed in through the mutex_init()
682 * (or spin_lock_init()) call - which acts as the key. For static
683 * locks we use the lock object itself as the key.
685 BUILD_BUG_ON(sizeof(struct lock_class_key) >
686 sizeof(struct lockdep_map));
688 key = lock->key->subkeys + subclass;
690 hash_head = classhashentry(key);
693 * We do an RCU walk of the hash, see lockdep_free_key_range().
695 if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
696 return NULL;
698 hlist_for_each_entry_rcu(class, hash_head, hash_entry) {
699 if (class->key == key) {
701 * Huh! same key, different name? Did someone trample
702 * on some memory? We're most confused.
704 WARN_ON_ONCE(class->name != lock->name);
705 return class;
709 return NULL;
713 * Register a lock's class in the hash-table, if the class is not present
714 * yet. Otherwise we look it up. We cache the result in the lock object
715 * itself, so actual lookup of the hash should be once per lock object.
717 static struct lock_class *
718 register_lock_class(struct lockdep_map *lock, unsigned int subclass, int force)
720 struct lockdep_subclass_key *key;
721 struct hlist_head *hash_head;
722 struct lock_class *class;
724 DEBUG_LOCKS_WARN_ON(!irqs_disabled());
726 class = look_up_lock_class(lock, subclass);
727 if (likely(class))
728 goto out_set_class_cache;
731 * Debug-check: all keys must be persistent!
733 if (!static_obj(lock->key)) {
734 debug_locks_off();
735 printk("INFO: trying to register non-static key.\n");
736 printk("the code is fine but needs lockdep annotation.\n");
737 printk("turning off the locking correctness validator.\n");
738 dump_stack();
740 return NULL;
743 key = lock->key->subkeys + subclass;
744 hash_head = classhashentry(key);
746 if (!graph_lock()) {
747 return NULL;
750 * We have to do the hash-walk again, to avoid races
751 * with another CPU:
753 hlist_for_each_entry_rcu(class, hash_head, hash_entry) {
754 if (class->key == key)
755 goto out_unlock_set;
759 * Allocate a new key from the static array, and add it to
760 * the hash:
762 if (nr_lock_classes >= MAX_LOCKDEP_KEYS) {
763 if (!debug_locks_off_graph_unlock()) {
764 return NULL;
767 print_lockdep_off("BUG: MAX_LOCKDEP_KEYS too low!");
768 dump_stack();
769 return NULL;
771 class = lock_classes + nr_lock_classes++;
772 debug_atomic_inc(nr_unused_locks);
773 class->key = key;
774 class->name = lock->name;
775 class->subclass = subclass;
776 INIT_LIST_HEAD(&class->lock_entry);
777 INIT_LIST_HEAD(&class->locks_before);
778 INIT_LIST_HEAD(&class->locks_after);
779 class->name_version = count_matching_names(class);
781 * We use RCU's safe list-add method to make
782 * parallel walking of the hash-list safe:
784 hlist_add_head_rcu(&class->hash_entry, hash_head);
786 * Add it to the global list of classes:
788 list_add_tail_rcu(&class->lock_entry, &all_lock_classes);
790 if (verbose(class)) {
791 graph_unlock();
793 printk("\nnew class %p: %s", class->key, class->name);
794 if (class->name_version > 1)
795 printk("#%d", class->name_version);
796 printk("\n");
797 dump_stack();
799 if (!graph_lock()) {
800 return NULL;
803 out_unlock_set:
804 graph_unlock();
806 out_set_class_cache:
807 if (!subclass || force)
808 lock->class_cache[0] = class;
809 else if (subclass < NR_LOCKDEP_CACHING_CLASSES)
810 lock->class_cache[subclass] = class;
813 * Hash collision, did we smoke some? We found a class with a matching
814 * hash but the subclass -- which is hashed in -- didn't match.
816 if (DEBUG_LOCKS_WARN_ON(class->subclass != subclass))
817 return NULL;
819 return class;
822 #ifdef CONFIG_PROVE_LOCKING
824 * Allocate a lockdep entry. (assumes the graph_lock held, returns
825 * with NULL on failure)
827 static struct lock_list *alloc_list_entry(void)
829 if (nr_list_entries >= MAX_LOCKDEP_ENTRIES) {
830 if (!debug_locks_off_graph_unlock())
831 return NULL;
833 print_lockdep_off("BUG: MAX_LOCKDEP_ENTRIES too low!");
834 dump_stack();
835 return NULL;
837 return list_entries + nr_list_entries++;
841 * Add a new dependency to the head of the list:
843 static int add_lock_to_list(struct lock_class *class, struct lock_class *this,
844 struct list_head *head, unsigned long ip,
845 int distance, struct stack_trace *trace)
847 struct lock_list *entry;
849 * Lock not present yet - get a new dependency struct and
850 * add it to the list:
852 entry = alloc_list_entry();
853 if (!entry)
854 return 0;
856 entry->class = this;
857 entry->distance = distance;
858 entry->trace = *trace;
860 * Both allocation and removal are done under the graph lock; but
861 * iteration is under RCU-sched; see look_up_lock_class() and
862 * lockdep_free_key_range().
864 list_add_tail_rcu(&entry->entry, head);
866 return 1;
870 * For good efficiency of modular, we use power of 2
872 #define MAX_CIRCULAR_QUEUE_SIZE 4096UL
873 #define CQ_MASK (MAX_CIRCULAR_QUEUE_SIZE-1)
876 * The circular_queue and helpers is used to implement the
877 * breadth-first search(BFS)algorithem, by which we can build
878 * the shortest path from the next lock to be acquired to the
879 * previous held lock if there is a circular between them.
881 struct circular_queue {
882 unsigned long element[MAX_CIRCULAR_QUEUE_SIZE];
883 unsigned int front, rear;
886 static struct circular_queue lock_cq;
888 unsigned int max_bfs_queue_depth;
890 static unsigned int lockdep_dependency_gen_id;
892 static inline void __cq_init(struct circular_queue *cq)
894 cq->front = cq->rear = 0;
895 lockdep_dependency_gen_id++;
898 static inline int __cq_empty(struct circular_queue *cq)
900 return (cq->front == cq->rear);
903 static inline int __cq_full(struct circular_queue *cq)
905 return ((cq->rear + 1) & CQ_MASK) == cq->front;
908 static inline int __cq_enqueue(struct circular_queue *cq, unsigned long elem)
910 if (__cq_full(cq))
911 return -1;
913 cq->element[cq->rear] = elem;
914 cq->rear = (cq->rear + 1) & CQ_MASK;
915 return 0;
918 static inline int __cq_dequeue(struct circular_queue *cq, unsigned long *elem)
920 if (__cq_empty(cq))
921 return -1;
923 *elem = cq->element[cq->front];
924 cq->front = (cq->front + 1) & CQ_MASK;
925 return 0;
928 static inline unsigned int __cq_get_elem_count(struct circular_queue *cq)
930 return (cq->rear - cq->front) & CQ_MASK;
933 static inline void mark_lock_accessed(struct lock_list *lock,
934 struct lock_list *parent)
936 unsigned long nr;
938 nr = lock - list_entries;
939 WARN_ON(nr >= nr_list_entries); /* Out-of-bounds, input fail */
940 lock->parent = parent;
941 lock->class->dep_gen_id = lockdep_dependency_gen_id;
944 static inline unsigned long lock_accessed(struct lock_list *lock)
946 unsigned long nr;
948 nr = lock - list_entries;
949 WARN_ON(nr >= nr_list_entries); /* Out-of-bounds, input fail */
950 return lock->class->dep_gen_id == lockdep_dependency_gen_id;
953 static inline struct lock_list *get_lock_parent(struct lock_list *child)
955 return child->parent;
958 static inline int get_lock_depth(struct lock_list *child)
960 int depth = 0;
961 struct lock_list *parent;
963 while ((parent = get_lock_parent(child))) {
964 child = parent;
965 depth++;
967 return depth;
970 static int __bfs(struct lock_list *source_entry,
971 void *data,
972 int (*match)(struct lock_list *entry, void *data),
973 struct lock_list **target_entry,
974 int forward)
976 struct lock_list *entry;
977 struct list_head *head;
978 struct circular_queue *cq = &lock_cq;
979 int ret = 1;
981 if (match(source_entry, data)) {
982 *target_entry = source_entry;
983 ret = 0;
984 goto exit;
987 if (forward)
988 head = &source_entry->class->locks_after;
989 else
990 head = &source_entry->class->locks_before;
992 if (list_empty(head))
993 goto exit;
995 __cq_init(cq);
996 __cq_enqueue(cq, (unsigned long)source_entry);
998 while (!__cq_empty(cq)) {
999 struct lock_list *lock;
1001 __cq_dequeue(cq, (unsigned long *)&lock);
1003 if (!lock->class) {
1004 ret = -2;
1005 goto exit;
1008 if (forward)
1009 head = &lock->class->locks_after;
1010 else
1011 head = &lock->class->locks_before;
1013 DEBUG_LOCKS_WARN_ON(!irqs_disabled());
1015 list_for_each_entry_rcu(entry, head, entry) {
1016 if (!lock_accessed(entry)) {
1017 unsigned int cq_depth;
1018 mark_lock_accessed(entry, lock);
1019 if (match(entry, data)) {
1020 *target_entry = entry;
1021 ret = 0;
1022 goto exit;
1025 if (__cq_enqueue(cq, (unsigned long)entry)) {
1026 ret = -1;
1027 goto exit;
1029 cq_depth = __cq_get_elem_count(cq);
1030 if (max_bfs_queue_depth < cq_depth)
1031 max_bfs_queue_depth = cq_depth;
1035 exit:
1036 return ret;
1039 static inline int __bfs_forwards(struct lock_list *src_entry,
1040 void *data,
1041 int (*match)(struct lock_list *entry, void *data),
1042 struct lock_list **target_entry)
1044 return __bfs(src_entry, data, match, target_entry, 1);
1048 static inline int __bfs_backwards(struct lock_list *src_entry,
1049 void *data,
1050 int (*match)(struct lock_list *entry, void *data),
1051 struct lock_list **target_entry)
1053 return __bfs(src_entry, data, match, target_entry, 0);
1058 * Recursive, forwards-direction lock-dependency checking, used for
1059 * both noncyclic checking and for hardirq-unsafe/softirq-unsafe
1060 * checking.
1064 * Print a dependency chain entry (this is only done when a deadlock
1065 * has been detected):
1067 static noinline int
1068 print_circular_bug_entry(struct lock_list *target, int depth)
1070 if (debug_locks_silent)
1071 return 0;
1072 printk("\n-> #%u", depth);
1073 print_lock_name(target->class);
1074 printk(":\n");
1075 print_stack_trace(&target->trace, 6);
1077 return 0;
1080 static void
1081 print_circular_lock_scenario(struct held_lock *src,
1082 struct held_lock *tgt,
1083 struct lock_list *prt)
1085 struct lock_class *source = hlock_class(src);
1086 struct lock_class *target = hlock_class(tgt);
1087 struct lock_class *parent = prt->class;
1090 * A direct locking problem where unsafe_class lock is taken
1091 * directly by safe_class lock, then all we need to show
1092 * is the deadlock scenario, as it is obvious that the
1093 * unsafe lock is taken under the safe lock.
1095 * But if there is a chain instead, where the safe lock takes
1096 * an intermediate lock (middle_class) where this lock is
1097 * not the same as the safe lock, then the lock chain is
1098 * used to describe the problem. Otherwise we would need
1099 * to show a different CPU case for each link in the chain
1100 * from the safe_class lock to the unsafe_class lock.
1102 if (parent != source) {
1103 printk("Chain exists of:\n ");
1104 __print_lock_name(source);
1105 printk(" --> ");
1106 __print_lock_name(parent);
1107 printk(" --> ");
1108 __print_lock_name(target);
1109 printk("\n\n");
1112 printk(" Possible unsafe locking scenario:\n\n");
1113 printk(" CPU0 CPU1\n");
1114 printk(" ---- ----\n");
1115 printk(" lock(");
1116 __print_lock_name(target);
1117 printk(");\n");
1118 printk(" lock(");
1119 __print_lock_name(parent);
1120 printk(");\n");
1121 printk(" lock(");
1122 __print_lock_name(target);
1123 printk(");\n");
1124 printk(" lock(");
1125 __print_lock_name(source);
1126 printk(");\n");
1127 printk("\n *** DEADLOCK ***\n\n");
1131 * When a circular dependency is detected, print the
1132 * header first:
1134 static noinline int
1135 print_circular_bug_header(struct lock_list *entry, unsigned int depth,
1136 struct held_lock *check_src,
1137 struct held_lock *check_tgt)
1139 struct task_struct *curr = current;
1141 if (debug_locks_silent)
1142 return 0;
1144 printk("\n");
1145 printk("======================================================\n");
1146 printk("[ INFO: possible circular locking dependency detected ]\n");
1147 print_kernel_ident();
1148 printk("-------------------------------------------------------\n");
1149 printk("%s/%d is trying to acquire lock:\n",
1150 curr->comm, task_pid_nr(curr));
1151 print_lock(check_src);
1152 printk("\nbut task is already holding lock:\n");
1153 print_lock(check_tgt);
1154 printk("\nwhich lock already depends on the new lock.\n\n");
1155 printk("\nthe existing dependency chain (in reverse order) is:\n");
1157 print_circular_bug_entry(entry, depth);
1159 return 0;
1162 static inline int class_equal(struct lock_list *entry, void *data)
1164 return entry->class == data;
1167 static noinline int print_circular_bug(struct lock_list *this,
1168 struct lock_list *target,
1169 struct held_lock *check_src,
1170 struct held_lock *check_tgt)
1172 struct task_struct *curr = current;
1173 struct lock_list *parent;
1174 struct lock_list *first_parent;
1175 int depth;
1177 if (!debug_locks_off_graph_unlock() || debug_locks_silent)
1178 return 0;
1180 if (!save_trace(&this->trace))
1181 return 0;
1183 depth = get_lock_depth(target);
1185 print_circular_bug_header(target, depth, check_src, check_tgt);
1187 parent = get_lock_parent(target);
1188 first_parent = parent;
1190 while (parent) {
1191 print_circular_bug_entry(parent, --depth);
1192 parent = get_lock_parent(parent);
1195 printk("\nother info that might help us debug this:\n\n");
1196 print_circular_lock_scenario(check_src, check_tgt,
1197 first_parent);
1199 lockdep_print_held_locks(curr);
1201 printk("\nstack backtrace:\n");
1202 dump_stack();
1204 return 0;
1207 static noinline int print_bfs_bug(int ret)
1209 if (!debug_locks_off_graph_unlock())
1210 return 0;
1213 * Breadth-first-search failed, graph got corrupted?
1215 WARN(1, "lockdep bfs error:%d\n", ret);
1217 return 0;
1220 static int noop_count(struct lock_list *entry, void *data)
1222 (*(unsigned long *)data)++;
1223 return 0;
1226 static unsigned long __lockdep_count_forward_deps(struct lock_list *this)
1228 unsigned long count = 0;
1229 struct lock_list *uninitialized_var(target_entry);
1231 __bfs_forwards(this, (void *)&count, noop_count, &target_entry);
1233 return count;
1235 unsigned long lockdep_count_forward_deps(struct lock_class *class)
1237 unsigned long ret, flags;
1238 struct lock_list this;
1240 this.parent = NULL;
1241 this.class = class;
1243 local_irq_save(flags);
1244 arch_spin_lock(&lockdep_lock);
1245 ret = __lockdep_count_forward_deps(&this);
1246 arch_spin_unlock(&lockdep_lock);
1247 local_irq_restore(flags);
1249 return ret;
1252 static unsigned long __lockdep_count_backward_deps(struct lock_list *this)
1254 unsigned long count = 0;
1255 struct lock_list *uninitialized_var(target_entry);
1257 __bfs_backwards(this, (void *)&count, noop_count, &target_entry);
1259 return count;
1262 unsigned long lockdep_count_backward_deps(struct lock_class *class)
1264 unsigned long ret, flags;
1265 struct lock_list this;
1267 this.parent = NULL;
1268 this.class = class;
1270 local_irq_save(flags);
1271 arch_spin_lock(&lockdep_lock);
1272 ret = __lockdep_count_backward_deps(&this);
1273 arch_spin_unlock(&lockdep_lock);
1274 local_irq_restore(flags);
1276 return ret;
1280 * Prove that the dependency graph starting at <entry> can not
1281 * lead to <target>. Print an error and return 0 if it does.
1283 static noinline int
1284 check_noncircular(struct lock_list *root, struct lock_class *target,
1285 struct lock_list **target_entry)
1287 int result;
1289 debug_atomic_inc(nr_cyclic_checks);
1291 result = __bfs_forwards(root, target, class_equal, target_entry);
1293 return result;
1296 #if defined(CONFIG_TRACE_IRQFLAGS) && defined(CONFIG_PROVE_LOCKING)
1298 * Forwards and backwards subgraph searching, for the purposes of
1299 * proving that two subgraphs can be connected by a new dependency
1300 * without creating any illegal irq-safe -> irq-unsafe lock dependency.
1303 static inline int usage_match(struct lock_list *entry, void *bit)
1305 return entry->class->usage_mask & (1 << (enum lock_usage_bit)bit);
1311 * Find a node in the forwards-direction dependency sub-graph starting
1312 * at @root->class that matches @bit.
1314 * Return 0 if such a node exists in the subgraph, and put that node
1315 * into *@target_entry.
1317 * Return 1 otherwise and keep *@target_entry unchanged.
1318 * Return <0 on error.
1320 static int
1321 find_usage_forwards(struct lock_list *root, enum lock_usage_bit bit,
1322 struct lock_list **target_entry)
1324 int result;
1326 debug_atomic_inc(nr_find_usage_forwards_checks);
1328 result = __bfs_forwards(root, (void *)bit, usage_match, target_entry);
1330 return result;
1334 * Find a node in the backwards-direction dependency sub-graph starting
1335 * at @root->class that matches @bit.
1337 * Return 0 if such a node exists in the subgraph, and put that node
1338 * into *@target_entry.
1340 * Return 1 otherwise and keep *@target_entry unchanged.
1341 * Return <0 on error.
1343 static int
1344 find_usage_backwards(struct lock_list *root, enum lock_usage_bit bit,
1345 struct lock_list **target_entry)
1347 int result;
1349 debug_atomic_inc(nr_find_usage_backwards_checks);
1351 result = __bfs_backwards(root, (void *)bit, usage_match, target_entry);
1353 return result;
1356 static void print_lock_class_header(struct lock_class *class, int depth)
1358 int bit;
1360 printk("%*s->", depth, "");
1361 print_lock_name(class);
1362 printk(" ops: %lu", class->ops);
1363 printk(" {\n");
1365 for (bit = 0; bit < LOCK_USAGE_STATES; bit++) {
1366 if (class->usage_mask & (1 << bit)) {
1367 int len = depth;
1369 len += printk("%*s %s", depth, "", usage_str[bit]);
1370 len += printk(" at:\n");
1371 print_stack_trace(class->usage_traces + bit, len);
1374 printk("%*s }\n", depth, "");
1376 printk("%*s ... key at: ",depth,"");
1377 print_ip_sym((unsigned long)class->key);
1381 * printk the shortest lock dependencies from @start to @end in reverse order:
1383 static void __used
1384 print_shortest_lock_dependencies(struct lock_list *leaf,
1385 struct lock_list *root)
1387 struct lock_list *entry = leaf;
1388 int depth;
1390 /*compute depth from generated tree by BFS*/
1391 depth = get_lock_depth(leaf);
1393 do {
1394 print_lock_class_header(entry->class, depth);
1395 printk("%*s ... acquired at:\n", depth, "");
1396 print_stack_trace(&entry->trace, 2);
1397 printk("\n");
1399 if (depth == 0 && (entry != root)) {
1400 printk("lockdep:%s bad path found in chain graph\n", __func__);
1401 break;
1404 entry = get_lock_parent(entry);
1405 depth--;
1406 } while (entry && (depth >= 0));
1408 return;
1411 static void
1412 print_irq_lock_scenario(struct lock_list *safe_entry,
1413 struct lock_list *unsafe_entry,
1414 struct lock_class *prev_class,
1415 struct lock_class *next_class)
1417 struct lock_class *safe_class = safe_entry->class;
1418 struct lock_class *unsafe_class = unsafe_entry->class;
1419 struct lock_class *middle_class = prev_class;
1421 if (middle_class == safe_class)
1422 middle_class = next_class;
1425 * A direct locking problem where unsafe_class lock is taken
1426 * directly by safe_class lock, then all we need to show
1427 * is the deadlock scenario, as it is obvious that the
1428 * unsafe lock is taken under the safe lock.
1430 * But if there is a chain instead, where the safe lock takes
1431 * an intermediate lock (middle_class) where this lock is
1432 * not the same as the safe lock, then the lock chain is
1433 * used to describe the problem. Otherwise we would need
1434 * to show a different CPU case for each link in the chain
1435 * from the safe_class lock to the unsafe_class lock.
1437 if (middle_class != unsafe_class) {
1438 printk("Chain exists of:\n ");
1439 __print_lock_name(safe_class);
1440 printk(" --> ");
1441 __print_lock_name(middle_class);
1442 printk(" --> ");
1443 __print_lock_name(unsafe_class);
1444 printk("\n\n");
1447 printk(" Possible interrupt unsafe locking scenario:\n\n");
1448 printk(" CPU0 CPU1\n");
1449 printk(" ---- ----\n");
1450 printk(" lock(");
1451 __print_lock_name(unsafe_class);
1452 printk(");\n");
1453 printk(" local_irq_disable();\n");
1454 printk(" lock(");
1455 __print_lock_name(safe_class);
1456 printk(");\n");
1457 printk(" lock(");
1458 __print_lock_name(middle_class);
1459 printk(");\n");
1460 printk(" <Interrupt>\n");
1461 printk(" lock(");
1462 __print_lock_name(safe_class);
1463 printk(");\n");
1464 printk("\n *** DEADLOCK ***\n\n");
1467 static int
1468 print_bad_irq_dependency(struct task_struct *curr,
1469 struct lock_list *prev_root,
1470 struct lock_list *next_root,
1471 struct lock_list *backwards_entry,
1472 struct lock_list *forwards_entry,
1473 struct held_lock *prev,
1474 struct held_lock *next,
1475 enum lock_usage_bit bit1,
1476 enum lock_usage_bit bit2,
1477 const char *irqclass)
1479 if (!debug_locks_off_graph_unlock() || debug_locks_silent)
1480 return 0;
1482 printk("\n");
1483 printk("======================================================\n");
1484 printk("[ INFO: %s-safe -> %s-unsafe lock order detected ]\n",
1485 irqclass, irqclass);
1486 print_kernel_ident();
1487 printk("------------------------------------------------------\n");
1488 printk("%s/%d [HC%u[%lu]:SC%u[%lu]:HE%u:SE%u] is trying to acquire:\n",
1489 curr->comm, task_pid_nr(curr),
1490 curr->hardirq_context, hardirq_count() >> HARDIRQ_SHIFT,
1491 curr->softirq_context, softirq_count() >> SOFTIRQ_SHIFT,
1492 curr->hardirqs_enabled,
1493 curr->softirqs_enabled);
1494 print_lock(next);
1496 printk("\nand this task is already holding:\n");
1497 print_lock(prev);
1498 printk("which would create a new lock dependency:\n");
1499 print_lock_name(hlock_class(prev));
1500 printk(" ->");
1501 print_lock_name(hlock_class(next));
1502 printk("\n");
1504 printk("\nbut this new dependency connects a %s-irq-safe lock:\n",
1505 irqclass);
1506 print_lock_name(backwards_entry->class);
1507 printk("\n... which became %s-irq-safe at:\n", irqclass);
1509 print_stack_trace(backwards_entry->class->usage_traces + bit1, 1);
1511 printk("\nto a %s-irq-unsafe lock:\n", irqclass);
1512 print_lock_name(forwards_entry->class);
1513 printk("\n... which became %s-irq-unsafe at:\n", irqclass);
1514 printk("...");
1516 print_stack_trace(forwards_entry->class->usage_traces + bit2, 1);
1518 printk("\nother info that might help us debug this:\n\n");
1519 print_irq_lock_scenario(backwards_entry, forwards_entry,
1520 hlock_class(prev), hlock_class(next));
1522 lockdep_print_held_locks(curr);
1524 printk("\nthe dependencies between %s-irq-safe lock", irqclass);
1525 printk(" and the holding lock:\n");
1526 if (!save_trace(&prev_root->trace))
1527 return 0;
1528 print_shortest_lock_dependencies(backwards_entry, prev_root);
1530 printk("\nthe dependencies between the lock to be acquired");
1531 printk(" and %s-irq-unsafe lock:\n", irqclass);
1532 if (!save_trace(&next_root->trace))
1533 return 0;
1534 print_shortest_lock_dependencies(forwards_entry, next_root);
1536 printk("\nstack backtrace:\n");
1537 dump_stack();
1539 return 0;
1542 static int
1543 check_usage(struct task_struct *curr, struct held_lock *prev,
1544 struct held_lock *next, enum lock_usage_bit bit_backwards,
1545 enum lock_usage_bit bit_forwards, const char *irqclass)
1547 int ret;
1548 struct lock_list this, that;
1549 struct lock_list *uninitialized_var(target_entry);
1550 struct lock_list *uninitialized_var(target_entry1);
1552 this.parent = NULL;
1554 this.class = hlock_class(prev);
1555 ret = find_usage_backwards(&this, bit_backwards, &target_entry);
1556 if (ret < 0)
1557 return print_bfs_bug(ret);
1558 if (ret == 1)
1559 return ret;
1561 that.parent = NULL;
1562 that.class = hlock_class(next);
1563 ret = find_usage_forwards(&that, bit_forwards, &target_entry1);
1564 if (ret < 0)
1565 return print_bfs_bug(ret);
1566 if (ret == 1)
1567 return ret;
1569 return print_bad_irq_dependency(curr, &this, &that,
1570 target_entry, target_entry1,
1571 prev, next,
1572 bit_backwards, bit_forwards, irqclass);
1575 static const char *state_names[] = {
1576 #define LOCKDEP_STATE(__STATE) \
1577 __stringify(__STATE),
1578 #include "lockdep_states.h"
1579 #undef LOCKDEP_STATE
1582 static const char *state_rnames[] = {
1583 #define LOCKDEP_STATE(__STATE) \
1584 __stringify(__STATE)"-READ",
1585 #include "lockdep_states.h"
1586 #undef LOCKDEP_STATE
1589 static inline const char *state_name(enum lock_usage_bit bit)
1591 return (bit & 1) ? state_rnames[bit >> 2] : state_names[bit >> 2];
1594 static int exclusive_bit(int new_bit)
1597 * USED_IN
1598 * USED_IN_READ
1599 * ENABLED
1600 * ENABLED_READ
1602 * bit 0 - write/read
1603 * bit 1 - used_in/enabled
1604 * bit 2+ state
1607 int state = new_bit & ~3;
1608 int dir = new_bit & 2;
1611 * keep state, bit flip the direction and strip read.
1613 return state | (dir ^ 2);
1616 static int check_irq_usage(struct task_struct *curr, struct held_lock *prev,
1617 struct held_lock *next, enum lock_usage_bit bit)
1620 * Prove that the new dependency does not connect a hardirq-safe
1621 * lock with a hardirq-unsafe lock - to achieve this we search
1622 * the backwards-subgraph starting at <prev>, and the
1623 * forwards-subgraph starting at <next>:
1625 if (!check_usage(curr, prev, next, bit,
1626 exclusive_bit(bit), state_name(bit)))
1627 return 0;
1629 bit++; /* _READ */
1632 * Prove that the new dependency does not connect a hardirq-safe-read
1633 * lock with a hardirq-unsafe lock - to achieve this we search
1634 * the backwards-subgraph starting at <prev>, and the
1635 * forwards-subgraph starting at <next>:
1637 if (!check_usage(curr, prev, next, bit,
1638 exclusive_bit(bit), state_name(bit)))
1639 return 0;
1641 return 1;
1644 static int
1645 check_prev_add_irq(struct task_struct *curr, struct held_lock *prev,
1646 struct held_lock *next)
1648 #define LOCKDEP_STATE(__STATE) \
1649 if (!check_irq_usage(curr, prev, next, LOCK_USED_IN_##__STATE)) \
1650 return 0;
1651 #include "lockdep_states.h"
1652 #undef LOCKDEP_STATE
1654 return 1;
1657 static void inc_chains(void)
1659 if (current->hardirq_context)
1660 nr_hardirq_chains++;
1661 else {
1662 if (current->softirq_context)
1663 nr_softirq_chains++;
1664 else
1665 nr_process_chains++;
1669 #else
1671 static inline int
1672 check_prev_add_irq(struct task_struct *curr, struct held_lock *prev,
1673 struct held_lock *next)
1675 return 1;
1678 static inline void inc_chains(void)
1680 nr_process_chains++;
1683 #endif
1685 static void
1686 print_deadlock_scenario(struct held_lock *nxt,
1687 struct held_lock *prv)
1689 struct lock_class *next = hlock_class(nxt);
1690 struct lock_class *prev = hlock_class(prv);
1692 printk(" Possible unsafe locking scenario:\n\n");
1693 printk(" CPU0\n");
1694 printk(" ----\n");
1695 printk(" lock(");
1696 __print_lock_name(prev);
1697 printk(");\n");
1698 printk(" lock(");
1699 __print_lock_name(next);
1700 printk(");\n");
1701 printk("\n *** DEADLOCK ***\n\n");
1702 printk(" May be due to missing lock nesting notation\n\n");
1705 static int
1706 print_deadlock_bug(struct task_struct *curr, struct held_lock *prev,
1707 struct held_lock *next)
1709 if (!debug_locks_off_graph_unlock() || debug_locks_silent)
1710 return 0;
1712 printk("\n");
1713 printk("=============================================\n");
1714 printk("[ INFO: possible recursive locking detected ]\n");
1715 print_kernel_ident();
1716 printk("---------------------------------------------\n");
1717 printk("%s/%d is trying to acquire lock:\n",
1718 curr->comm, task_pid_nr(curr));
1719 print_lock(next);
1720 printk("\nbut task is already holding lock:\n");
1721 print_lock(prev);
1723 printk("\nother info that might help us debug this:\n");
1724 print_deadlock_scenario(next, prev);
1725 lockdep_print_held_locks(curr);
1727 printk("\nstack backtrace:\n");
1728 dump_stack();
1730 return 0;
1734 * Check whether we are holding such a class already.
1736 * (Note that this has to be done separately, because the graph cannot
1737 * detect such classes of deadlocks.)
1739 * Returns: 0 on deadlock detected, 1 on OK, 2 on recursive read
1741 static int
1742 check_deadlock(struct task_struct *curr, struct held_lock *next,
1743 struct lockdep_map *next_instance, int read)
1745 struct held_lock *prev;
1746 struct held_lock *nest = NULL;
1747 int i;
1749 for (i = 0; i < curr->lockdep_depth; i++) {
1750 prev = curr->held_locks + i;
1752 if (prev->instance == next->nest_lock)
1753 nest = prev;
1755 if (hlock_class(prev) != hlock_class(next))
1756 continue;
1759 * Allow read-after-read recursion of the same
1760 * lock class (i.e. read_lock(lock)+read_lock(lock)):
1762 if ((read == 2) && prev->read)
1763 return 2;
1766 * We're holding the nest_lock, which serializes this lock's
1767 * nesting behaviour.
1769 if (nest)
1770 return 2;
1772 return print_deadlock_bug(curr, prev, next);
1774 return 1;
1778 * There was a chain-cache miss, and we are about to add a new dependency
1779 * to a previous lock. We recursively validate the following rules:
1781 * - would the adding of the <prev> -> <next> dependency create a
1782 * circular dependency in the graph? [== circular deadlock]
1784 * - does the new prev->next dependency connect any hardirq-safe lock
1785 * (in the full backwards-subgraph starting at <prev>) with any
1786 * hardirq-unsafe lock (in the full forwards-subgraph starting at
1787 * <next>)? [== illegal lock inversion with hardirq contexts]
1789 * - does the new prev->next dependency connect any softirq-safe lock
1790 * (in the full backwards-subgraph starting at <prev>) with any
1791 * softirq-unsafe lock (in the full forwards-subgraph starting at
1792 * <next>)? [== illegal lock inversion with softirq contexts]
1794 * any of these scenarios could lead to a deadlock.
1796 * Then if all the validations pass, we add the forwards and backwards
1797 * dependency.
1799 static int
1800 check_prev_add(struct task_struct *curr, struct held_lock *prev,
1801 struct held_lock *next, int distance, int *stack_saved)
1803 struct lock_list *entry;
1804 int ret;
1805 struct lock_list this;
1806 struct lock_list *uninitialized_var(target_entry);
1808 * Static variable, serialized by the graph_lock().
1810 * We use this static variable to save the stack trace in case
1811 * we call into this function multiple times due to encountering
1812 * trylocks in the held lock stack.
1814 static struct stack_trace trace;
1817 * Prove that the new <prev> -> <next> dependency would not
1818 * create a circular dependency in the graph. (We do this by
1819 * forward-recursing into the graph starting at <next>, and
1820 * checking whether we can reach <prev>.)
1822 * We are using global variables to control the recursion, to
1823 * keep the stackframe size of the recursive functions low:
1825 this.class = hlock_class(next);
1826 this.parent = NULL;
1827 ret = check_noncircular(&this, hlock_class(prev), &target_entry);
1828 if (unlikely(!ret))
1829 return print_circular_bug(&this, target_entry, next, prev);
1830 else if (unlikely(ret < 0))
1831 return print_bfs_bug(ret);
1833 if (!check_prev_add_irq(curr, prev, next))
1834 return 0;
1837 * For recursive read-locks we do all the dependency checks,
1838 * but we dont store read-triggered dependencies (only
1839 * write-triggered dependencies). This ensures that only the
1840 * write-side dependencies matter, and that if for example a
1841 * write-lock never takes any other locks, then the reads are
1842 * equivalent to a NOP.
1844 if (next->read == 2 || prev->read == 2)
1845 return 1;
1847 * Is the <prev> -> <next> dependency already present?
1849 * (this may occur even though this is a new chain: consider
1850 * e.g. the L1 -> L2 -> L3 -> L4 and the L5 -> L1 -> L2 -> L3
1851 * chains - the second one will be new, but L1 already has
1852 * L2 added to its dependency list, due to the first chain.)
1854 list_for_each_entry(entry, &hlock_class(prev)->locks_after, entry) {
1855 if (entry->class == hlock_class(next)) {
1856 if (distance == 1)
1857 entry->distance = 1;
1858 return 2;
1862 if (!*stack_saved) {
1863 if (!save_trace(&trace))
1864 return 0;
1865 *stack_saved = 1;
1869 * Ok, all validations passed, add the new lock
1870 * to the previous lock's dependency list:
1872 ret = add_lock_to_list(hlock_class(prev), hlock_class(next),
1873 &hlock_class(prev)->locks_after,
1874 next->acquire_ip, distance, &trace);
1876 if (!ret)
1877 return 0;
1879 ret = add_lock_to_list(hlock_class(next), hlock_class(prev),
1880 &hlock_class(next)->locks_before,
1881 next->acquire_ip, distance, &trace);
1882 if (!ret)
1883 return 0;
1886 * Debugging printouts:
1888 if (verbose(hlock_class(prev)) || verbose(hlock_class(next))) {
1889 /* We drop graph lock, so another thread can overwrite trace. */
1890 *stack_saved = 0;
1891 graph_unlock();
1892 printk("\n new dependency: ");
1893 print_lock_name(hlock_class(prev));
1894 printk(" => ");
1895 print_lock_name(hlock_class(next));
1896 printk("\n");
1897 dump_stack();
1898 return graph_lock();
1900 return 1;
1904 * Add the dependency to all directly-previous locks that are 'relevant'.
1905 * The ones that are relevant are (in increasing distance from curr):
1906 * all consecutive trylock entries and the final non-trylock entry - or
1907 * the end of this context's lock-chain - whichever comes first.
1909 static int
1910 check_prevs_add(struct task_struct *curr, struct held_lock *next)
1912 int depth = curr->lockdep_depth;
1913 int stack_saved = 0;
1914 struct held_lock *hlock;
1917 * Debugging checks.
1919 * Depth must not be zero for a non-head lock:
1921 if (!depth)
1922 goto out_bug;
1924 * At least two relevant locks must exist for this
1925 * to be a head:
1927 if (curr->held_locks[depth].irq_context !=
1928 curr->held_locks[depth-1].irq_context)
1929 goto out_bug;
1931 for (;;) {
1932 int distance = curr->lockdep_depth - depth + 1;
1933 hlock = curr->held_locks + depth - 1;
1935 * Only non-recursive-read entries get new dependencies
1936 * added:
1938 if (hlock->read != 2 && hlock->check) {
1939 if (!check_prev_add(curr, hlock, next,
1940 distance, &stack_saved))
1941 return 0;
1943 * Stop after the first non-trylock entry,
1944 * as non-trylock entries have added their
1945 * own direct dependencies already, so this
1946 * lock is connected to them indirectly:
1948 if (!hlock->trylock)
1949 break;
1951 depth--;
1953 * End of lock-stack?
1955 if (!depth)
1956 break;
1958 * Stop the search if we cross into another context:
1960 if (curr->held_locks[depth].irq_context !=
1961 curr->held_locks[depth-1].irq_context)
1962 break;
1964 return 1;
1965 out_bug:
1966 if (!debug_locks_off_graph_unlock())
1967 return 0;
1970 * Clearly we all shouldn't be here, but since we made it we
1971 * can reliable say we messed up our state. See the above two
1972 * gotos for reasons why we could possibly end up here.
1974 WARN_ON(1);
1976 return 0;
1979 unsigned long nr_lock_chains;
1980 struct lock_chain lock_chains[MAX_LOCKDEP_CHAINS];
1981 int nr_chain_hlocks;
1982 static u16 chain_hlocks[MAX_LOCKDEP_CHAIN_HLOCKS];
1984 struct lock_class *lock_chain_get_class(struct lock_chain *chain, int i)
1986 return lock_classes + chain_hlocks[chain->base + i];
1990 * Returns the index of the first held_lock of the current chain
1992 static inline int get_first_held_lock(struct task_struct *curr,
1993 struct held_lock *hlock)
1995 int i;
1996 struct held_lock *hlock_curr;
1998 for (i = curr->lockdep_depth - 1; i >= 0; i--) {
1999 hlock_curr = curr->held_locks + i;
2000 if (hlock_curr->irq_context != hlock->irq_context)
2001 break;
2005 return ++i;
2008 #ifdef CONFIG_DEBUG_LOCKDEP
2010 * Returns the next chain_key iteration
2012 static u64 print_chain_key_iteration(int class_idx, u64 chain_key)
2014 u64 new_chain_key = iterate_chain_key(chain_key, class_idx);
2016 printk(" class_idx:%d -> chain_key:%016Lx",
2017 class_idx,
2018 (unsigned long long)new_chain_key);
2019 return new_chain_key;
2022 static void
2023 print_chain_keys_held_locks(struct task_struct *curr, struct held_lock *hlock_next)
2025 struct held_lock *hlock;
2026 u64 chain_key = 0;
2027 int depth = curr->lockdep_depth;
2028 int i;
2030 printk("depth: %u\n", depth + 1);
2031 for (i = get_first_held_lock(curr, hlock_next); i < depth; i++) {
2032 hlock = curr->held_locks + i;
2033 chain_key = print_chain_key_iteration(hlock->class_idx, chain_key);
2035 print_lock(hlock);
2038 print_chain_key_iteration(hlock_next->class_idx, chain_key);
2039 print_lock(hlock_next);
2042 static void print_chain_keys_chain(struct lock_chain *chain)
2044 int i;
2045 u64 chain_key = 0;
2046 int class_id;
2048 printk("depth: %u\n", chain->depth);
2049 for (i = 0; i < chain->depth; i++) {
2050 class_id = chain_hlocks[chain->base + i];
2051 chain_key = print_chain_key_iteration(class_id + 1, chain_key);
2053 print_lock_name(lock_classes + class_id);
2054 printk("\n");
2058 static void print_collision(struct task_struct *curr,
2059 struct held_lock *hlock_next,
2060 struct lock_chain *chain)
2062 printk("\n");
2063 printk("======================\n");
2064 printk("[chain_key collision ]\n");
2065 print_kernel_ident();
2066 printk("----------------------\n");
2067 printk("%s/%d: ", current->comm, task_pid_nr(current));
2068 printk("Hash chain already cached but the contents don't match!\n");
2070 printk("Held locks:");
2071 print_chain_keys_held_locks(curr, hlock_next);
2073 printk("Locks in cached chain:");
2074 print_chain_keys_chain(chain);
2076 printk("\nstack backtrace:\n");
2077 dump_stack();
2079 #endif
2082 * Checks whether the chain and the current held locks are consistent
2083 * in depth and also in content. If they are not it most likely means
2084 * that there was a collision during the calculation of the chain_key.
2085 * Returns: 0 not passed, 1 passed
2087 static int check_no_collision(struct task_struct *curr,
2088 struct held_lock *hlock,
2089 struct lock_chain *chain)
2091 #ifdef CONFIG_DEBUG_LOCKDEP
2092 int i, j, id;
2094 i = get_first_held_lock(curr, hlock);
2096 if (DEBUG_LOCKS_WARN_ON(chain->depth != curr->lockdep_depth - (i - 1))) {
2097 print_collision(curr, hlock, chain);
2098 return 0;
2101 for (j = 0; j < chain->depth - 1; j++, i++) {
2102 id = curr->held_locks[i].class_idx - 1;
2104 if (DEBUG_LOCKS_WARN_ON(chain_hlocks[chain->base + j] != id)) {
2105 print_collision(curr, hlock, chain);
2106 return 0;
2109 #endif
2110 return 1;
2114 * Look up a dependency chain. If the key is not present yet then
2115 * add it and return 1 - in this case the new dependency chain is
2116 * validated. If the key is already hashed, return 0.
2117 * (On return with 1 graph_lock is held.)
2119 static inline int lookup_chain_cache(struct task_struct *curr,
2120 struct held_lock *hlock,
2121 u64 chain_key)
2123 struct lock_class *class = hlock_class(hlock);
2124 struct hlist_head *hash_head = chainhashentry(chain_key);
2125 struct lock_chain *chain;
2126 int i, j;
2129 * We might need to take the graph lock, ensure we've got IRQs
2130 * disabled to make this an IRQ-safe lock.. for recursion reasons
2131 * lockdep won't complain about its own locking errors.
2133 if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
2134 return 0;
2136 * We can walk it lock-free, because entries only get added
2137 * to the hash:
2139 hlist_for_each_entry_rcu(chain, hash_head, entry) {
2140 if (chain->chain_key == chain_key) {
2141 cache_hit:
2142 debug_atomic_inc(chain_lookup_hits);
2143 if (!check_no_collision(curr, hlock, chain))
2144 return 0;
2146 if (very_verbose(class))
2147 printk("\nhash chain already cached, key: "
2148 "%016Lx tail class: [%p] %s\n",
2149 (unsigned long long)chain_key,
2150 class->key, class->name);
2151 return 0;
2154 if (very_verbose(class))
2155 printk("\nnew hash chain, key: %016Lx tail class: [%p] %s\n",
2156 (unsigned long long)chain_key, class->key, class->name);
2158 * Allocate a new chain entry from the static array, and add
2159 * it to the hash:
2161 if (!graph_lock())
2162 return 0;
2164 * We have to walk the chain again locked - to avoid duplicates:
2166 hlist_for_each_entry(chain, hash_head, entry) {
2167 if (chain->chain_key == chain_key) {
2168 graph_unlock();
2169 goto cache_hit;
2172 if (unlikely(nr_lock_chains >= MAX_LOCKDEP_CHAINS)) {
2173 if (!debug_locks_off_graph_unlock())
2174 return 0;
2176 print_lockdep_off("BUG: MAX_LOCKDEP_CHAINS too low!");
2177 dump_stack();
2178 return 0;
2180 chain = lock_chains + nr_lock_chains++;
2181 chain->chain_key = chain_key;
2182 chain->irq_context = hlock->irq_context;
2183 i = get_first_held_lock(curr, hlock);
2184 chain->depth = curr->lockdep_depth + 1 - i;
2186 BUILD_BUG_ON((1UL << 24) <= ARRAY_SIZE(chain_hlocks));
2187 BUILD_BUG_ON((1UL << 6) <= ARRAY_SIZE(curr->held_locks));
2188 BUILD_BUG_ON((1UL << 8*sizeof(chain_hlocks[0])) <= ARRAY_SIZE(lock_classes));
2190 if (likely(nr_chain_hlocks + chain->depth <= MAX_LOCKDEP_CHAIN_HLOCKS)) {
2191 chain->base = nr_chain_hlocks;
2192 for (j = 0; j < chain->depth - 1; j++, i++) {
2193 int lock_id = curr->held_locks[i].class_idx - 1;
2194 chain_hlocks[chain->base + j] = lock_id;
2196 chain_hlocks[chain->base + j] = class - lock_classes;
2199 if (nr_chain_hlocks < MAX_LOCKDEP_CHAIN_HLOCKS)
2200 nr_chain_hlocks += chain->depth;
2202 #ifdef CONFIG_DEBUG_LOCKDEP
2204 * Important for check_no_collision().
2206 if (unlikely(nr_chain_hlocks > MAX_LOCKDEP_CHAIN_HLOCKS)) {
2207 if (debug_locks_off_graph_unlock())
2208 return 0;
2210 print_lockdep_off("BUG: MAX_LOCKDEP_CHAIN_HLOCKS too low!");
2211 dump_stack();
2212 return 0;
2214 #endif
2216 hlist_add_head_rcu(&chain->entry, hash_head);
2217 debug_atomic_inc(chain_lookup_misses);
2218 inc_chains();
2220 return 1;
2223 static int validate_chain(struct task_struct *curr, struct lockdep_map *lock,
2224 struct held_lock *hlock, int chain_head, u64 chain_key)
2227 * Trylock needs to maintain the stack of held locks, but it
2228 * does not add new dependencies, because trylock can be done
2229 * in any order.
2231 * We look up the chain_key and do the O(N^2) check and update of
2232 * the dependencies only if this is a new dependency chain.
2233 * (If lookup_chain_cache() returns with 1 it acquires
2234 * graph_lock for us)
2236 if (!hlock->trylock && hlock->check &&
2237 lookup_chain_cache(curr, hlock, chain_key)) {
2239 * Check whether last held lock:
2241 * - is irq-safe, if this lock is irq-unsafe
2242 * - is softirq-safe, if this lock is hardirq-unsafe
2244 * And check whether the new lock's dependency graph
2245 * could lead back to the previous lock.
2247 * any of these scenarios could lead to a deadlock. If
2248 * All validations
2250 int ret = check_deadlock(curr, hlock, lock, hlock->read);
2252 if (!ret)
2253 return 0;
2255 * Mark recursive read, as we jump over it when
2256 * building dependencies (just like we jump over
2257 * trylock entries):
2259 if (ret == 2)
2260 hlock->read = 2;
2262 * Add dependency only if this lock is not the head
2263 * of the chain, and if it's not a secondary read-lock:
2265 if (!chain_head && ret != 2)
2266 if (!check_prevs_add(curr, hlock))
2267 return 0;
2268 graph_unlock();
2269 } else
2270 /* after lookup_chain_cache(): */
2271 if (unlikely(!debug_locks))
2272 return 0;
2274 return 1;
2276 #else
2277 static inline int validate_chain(struct task_struct *curr,
2278 struct lockdep_map *lock, struct held_lock *hlock,
2279 int chain_head, u64 chain_key)
2281 return 1;
2283 #endif
2286 * We are building curr_chain_key incrementally, so double-check
2287 * it from scratch, to make sure that it's done correctly:
2289 static void check_chain_key(struct task_struct *curr)
2291 #ifdef CONFIG_DEBUG_LOCKDEP
2292 struct held_lock *hlock, *prev_hlock = NULL;
2293 unsigned int i;
2294 u64 chain_key = 0;
2296 for (i = 0; i < curr->lockdep_depth; i++) {
2297 hlock = curr->held_locks + i;
2298 if (chain_key != hlock->prev_chain_key) {
2299 debug_locks_off();
2301 * We got mighty confused, our chain keys don't match
2302 * with what we expect, someone trample on our task state?
2304 WARN(1, "hm#1, depth: %u [%u], %016Lx != %016Lx\n",
2305 curr->lockdep_depth, i,
2306 (unsigned long long)chain_key,
2307 (unsigned long long)hlock->prev_chain_key);
2308 return;
2311 * Whoops ran out of static storage again?
2313 if (DEBUG_LOCKS_WARN_ON(hlock->class_idx > MAX_LOCKDEP_KEYS))
2314 return;
2316 if (prev_hlock && (prev_hlock->irq_context !=
2317 hlock->irq_context))
2318 chain_key = 0;
2319 chain_key = iterate_chain_key(chain_key, hlock->class_idx);
2320 prev_hlock = hlock;
2322 if (chain_key != curr->curr_chain_key) {
2323 debug_locks_off();
2325 * More smoking hash instead of calculating it, damn see these
2326 * numbers float.. I bet that a pink elephant stepped on my memory.
2328 WARN(1, "hm#2, depth: %u [%u], %016Lx != %016Lx\n",
2329 curr->lockdep_depth, i,
2330 (unsigned long long)chain_key,
2331 (unsigned long long)curr->curr_chain_key);
2333 #endif
2336 static void
2337 print_usage_bug_scenario(struct held_lock *lock)
2339 struct lock_class *class = hlock_class(lock);
2341 printk(" Possible unsafe locking scenario:\n\n");
2342 printk(" CPU0\n");
2343 printk(" ----\n");
2344 printk(" lock(");
2345 __print_lock_name(class);
2346 printk(");\n");
2347 printk(" <Interrupt>\n");
2348 printk(" lock(");
2349 __print_lock_name(class);
2350 printk(");\n");
2351 printk("\n *** DEADLOCK ***\n\n");
2354 static int
2355 print_usage_bug(struct task_struct *curr, struct held_lock *this,
2356 enum lock_usage_bit prev_bit, enum lock_usage_bit new_bit)
2358 if (!debug_locks_off_graph_unlock() || debug_locks_silent)
2359 return 0;
2361 printk("\n");
2362 printk("=================================\n");
2363 printk("[ INFO: inconsistent lock state ]\n");
2364 print_kernel_ident();
2365 printk("---------------------------------\n");
2367 printk("inconsistent {%s} -> {%s} usage.\n",
2368 usage_str[prev_bit], usage_str[new_bit]);
2370 printk("%s/%d [HC%u[%lu]:SC%u[%lu]:HE%u:SE%u] takes:\n",
2371 curr->comm, task_pid_nr(curr),
2372 trace_hardirq_context(curr), hardirq_count() >> HARDIRQ_SHIFT,
2373 trace_softirq_context(curr), softirq_count() >> SOFTIRQ_SHIFT,
2374 trace_hardirqs_enabled(curr),
2375 trace_softirqs_enabled(curr));
2376 print_lock(this);
2378 printk("{%s} state was registered at:\n", usage_str[prev_bit]);
2379 print_stack_trace(hlock_class(this)->usage_traces + prev_bit, 1);
2381 print_irqtrace_events(curr);
2382 printk("\nother info that might help us debug this:\n");
2383 print_usage_bug_scenario(this);
2385 lockdep_print_held_locks(curr);
2387 printk("\nstack backtrace:\n");
2388 dump_stack();
2390 return 0;
2394 * Print out an error if an invalid bit is set:
2396 static inline int
2397 valid_state(struct task_struct *curr, struct held_lock *this,
2398 enum lock_usage_bit new_bit, enum lock_usage_bit bad_bit)
2400 if (unlikely(hlock_class(this)->usage_mask & (1 << bad_bit)))
2401 return print_usage_bug(curr, this, bad_bit, new_bit);
2402 return 1;
2405 static int mark_lock(struct task_struct *curr, struct held_lock *this,
2406 enum lock_usage_bit new_bit);
2408 #if defined(CONFIG_TRACE_IRQFLAGS) && defined(CONFIG_PROVE_LOCKING)
2411 * print irq inversion bug:
2413 static int
2414 print_irq_inversion_bug(struct task_struct *curr,
2415 struct lock_list *root, struct lock_list *other,
2416 struct held_lock *this, int forwards,
2417 const char *irqclass)
2419 struct lock_list *entry = other;
2420 struct lock_list *middle = NULL;
2421 int depth;
2423 if (!debug_locks_off_graph_unlock() || debug_locks_silent)
2424 return 0;
2426 printk("\n");
2427 printk("=========================================================\n");
2428 printk("[ INFO: possible irq lock inversion dependency detected ]\n");
2429 print_kernel_ident();
2430 printk("---------------------------------------------------------\n");
2431 printk("%s/%d just changed the state of lock:\n",
2432 curr->comm, task_pid_nr(curr));
2433 print_lock(this);
2434 if (forwards)
2435 printk("but this lock took another, %s-unsafe lock in the past:\n", irqclass);
2436 else
2437 printk("but this lock was taken by another, %s-safe lock in the past:\n", irqclass);
2438 print_lock_name(other->class);
2439 printk("\n\nand interrupts could create inverse lock ordering between them.\n\n");
2441 printk("\nother info that might help us debug this:\n");
2443 /* Find a middle lock (if one exists) */
2444 depth = get_lock_depth(other);
2445 do {
2446 if (depth == 0 && (entry != root)) {
2447 printk("lockdep:%s bad path found in chain graph\n", __func__);
2448 break;
2450 middle = entry;
2451 entry = get_lock_parent(entry);
2452 depth--;
2453 } while (entry && entry != root && (depth >= 0));
2454 if (forwards)
2455 print_irq_lock_scenario(root, other,
2456 middle ? middle->class : root->class, other->class);
2457 else
2458 print_irq_lock_scenario(other, root,
2459 middle ? middle->class : other->class, root->class);
2461 lockdep_print_held_locks(curr);
2463 printk("\nthe shortest dependencies between 2nd lock and 1st lock:\n");
2464 if (!save_trace(&root->trace))
2465 return 0;
2466 print_shortest_lock_dependencies(other, root);
2468 printk("\nstack backtrace:\n");
2469 dump_stack();
2471 return 0;
2475 * Prove that in the forwards-direction subgraph starting at <this>
2476 * there is no lock matching <mask>:
2478 static int
2479 check_usage_forwards(struct task_struct *curr, struct held_lock *this,
2480 enum lock_usage_bit bit, const char *irqclass)
2482 int ret;
2483 struct lock_list root;
2484 struct lock_list *uninitialized_var(target_entry);
2486 root.parent = NULL;
2487 root.class = hlock_class(this);
2488 ret = find_usage_forwards(&root, bit, &target_entry);
2489 if (ret < 0)
2490 return print_bfs_bug(ret);
2491 if (ret == 1)
2492 return ret;
2494 return print_irq_inversion_bug(curr, &root, target_entry,
2495 this, 1, irqclass);
2499 * Prove that in the backwards-direction subgraph starting at <this>
2500 * there is no lock matching <mask>:
2502 static int
2503 check_usage_backwards(struct task_struct *curr, struct held_lock *this,
2504 enum lock_usage_bit bit, const char *irqclass)
2506 int ret;
2507 struct lock_list root;
2508 struct lock_list *uninitialized_var(target_entry);
2510 root.parent = NULL;
2511 root.class = hlock_class(this);
2512 ret = find_usage_backwards(&root, bit, &target_entry);
2513 if (ret < 0)
2514 return print_bfs_bug(ret);
2515 if (ret == 1)
2516 return ret;
2518 return print_irq_inversion_bug(curr, &root, target_entry,
2519 this, 0, irqclass);
2522 void print_irqtrace_events(struct task_struct *curr)
2524 printk("irq event stamp: %u\n", curr->irq_events);
2525 printk("hardirqs last enabled at (%u): ", curr->hardirq_enable_event);
2526 print_ip_sym(curr->hardirq_enable_ip);
2527 printk("hardirqs last disabled at (%u): ", curr->hardirq_disable_event);
2528 print_ip_sym(curr->hardirq_disable_ip);
2529 printk("softirqs last enabled at (%u): ", curr->softirq_enable_event);
2530 print_ip_sym(curr->softirq_enable_ip);
2531 printk("softirqs last disabled at (%u): ", curr->softirq_disable_event);
2532 print_ip_sym(curr->softirq_disable_ip);
2535 static int HARDIRQ_verbose(struct lock_class *class)
2537 #if HARDIRQ_VERBOSE
2538 return class_filter(class);
2539 #endif
2540 return 0;
2543 static int SOFTIRQ_verbose(struct lock_class *class)
2545 #if SOFTIRQ_VERBOSE
2546 return class_filter(class);
2547 #endif
2548 return 0;
2551 static int RECLAIM_FS_verbose(struct lock_class *class)
2553 #if RECLAIM_VERBOSE
2554 return class_filter(class);
2555 #endif
2556 return 0;
2559 #define STRICT_READ_CHECKS 1
2561 static int (*state_verbose_f[])(struct lock_class *class) = {
2562 #define LOCKDEP_STATE(__STATE) \
2563 __STATE##_verbose,
2564 #include "lockdep_states.h"
2565 #undef LOCKDEP_STATE
2568 static inline int state_verbose(enum lock_usage_bit bit,
2569 struct lock_class *class)
2571 return state_verbose_f[bit >> 2](class);
2574 typedef int (*check_usage_f)(struct task_struct *, struct held_lock *,
2575 enum lock_usage_bit bit, const char *name);
2577 static int
2578 mark_lock_irq(struct task_struct *curr, struct held_lock *this,
2579 enum lock_usage_bit new_bit)
2581 int excl_bit = exclusive_bit(new_bit);
2582 int read = new_bit & 1;
2583 int dir = new_bit & 2;
2586 * mark USED_IN has to look forwards -- to ensure no dependency
2587 * has ENABLED state, which would allow recursion deadlocks.
2589 * mark ENABLED has to look backwards -- to ensure no dependee
2590 * has USED_IN state, which, again, would allow recursion deadlocks.
2592 check_usage_f usage = dir ?
2593 check_usage_backwards : check_usage_forwards;
2596 * Validate that this particular lock does not have conflicting
2597 * usage states.
2599 if (!valid_state(curr, this, new_bit, excl_bit))
2600 return 0;
2603 * Validate that the lock dependencies don't have conflicting usage
2604 * states.
2606 if ((!read || !dir || STRICT_READ_CHECKS) &&
2607 !usage(curr, this, excl_bit, state_name(new_bit & ~1)))
2608 return 0;
2611 * Check for read in write conflicts
2613 if (!read) {
2614 if (!valid_state(curr, this, new_bit, excl_bit + 1))
2615 return 0;
2617 if (STRICT_READ_CHECKS &&
2618 !usage(curr, this, excl_bit + 1,
2619 state_name(new_bit + 1)))
2620 return 0;
2623 if (state_verbose(new_bit, hlock_class(this)))
2624 return 2;
2626 return 1;
2629 enum mark_type {
2630 #define LOCKDEP_STATE(__STATE) __STATE,
2631 #include "lockdep_states.h"
2632 #undef LOCKDEP_STATE
2636 * Mark all held locks with a usage bit:
2638 static int
2639 mark_held_locks(struct task_struct *curr, enum mark_type mark)
2641 enum lock_usage_bit usage_bit;
2642 struct held_lock *hlock;
2643 int i;
2645 for (i = 0; i < curr->lockdep_depth; i++) {
2646 hlock = curr->held_locks + i;
2648 usage_bit = 2 + (mark << 2); /* ENABLED */
2649 if (hlock->read)
2650 usage_bit += 1; /* READ */
2652 BUG_ON(usage_bit >= LOCK_USAGE_STATES);
2654 if (!hlock->check)
2655 continue;
2657 if (!mark_lock(curr, hlock, usage_bit))
2658 return 0;
2661 return 1;
2665 * Hardirqs will be enabled:
2667 static void __trace_hardirqs_on_caller(unsigned long ip)
2669 struct task_struct *curr = current;
2671 /* we'll do an OFF -> ON transition: */
2672 curr->hardirqs_enabled = 1;
2675 * We are going to turn hardirqs on, so set the
2676 * usage bit for all held locks:
2678 if (!mark_held_locks(curr, HARDIRQ))
2679 return;
2681 * If we have softirqs enabled, then set the usage
2682 * bit for all held locks. (disabled hardirqs prevented
2683 * this bit from being set before)
2685 if (curr->softirqs_enabled)
2686 if (!mark_held_locks(curr, SOFTIRQ))
2687 return;
2689 curr->hardirq_enable_ip = ip;
2690 curr->hardirq_enable_event = ++curr->irq_events;
2691 debug_atomic_inc(hardirqs_on_events);
2694 __visible void trace_hardirqs_on_caller(unsigned long ip)
2696 time_hardirqs_on(CALLER_ADDR0, ip);
2698 if (unlikely(!debug_locks || current->lockdep_recursion))
2699 return;
2701 if (unlikely(current->hardirqs_enabled)) {
2703 * Neither irq nor preemption are disabled here
2704 * so this is racy by nature but losing one hit
2705 * in a stat is not a big deal.
2707 __debug_atomic_inc(redundant_hardirqs_on);
2708 return;
2712 * We're enabling irqs and according to our state above irqs weren't
2713 * already enabled, yet we find the hardware thinks they are in fact
2714 * enabled.. someone messed up their IRQ state tracing.
2716 if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
2717 return;
2720 * See the fine text that goes along with this variable definition.
2722 if (DEBUG_LOCKS_WARN_ON(unlikely(early_boot_irqs_disabled)))
2723 return;
2726 * Can't allow enabling interrupts while in an interrupt handler,
2727 * that's general bad form and such. Recursion, limited stack etc..
2729 if (DEBUG_LOCKS_WARN_ON(current->hardirq_context))
2730 return;
2732 current->lockdep_recursion = 1;
2733 __trace_hardirqs_on_caller(ip);
2734 current->lockdep_recursion = 0;
2736 EXPORT_SYMBOL(trace_hardirqs_on_caller);
2738 void trace_hardirqs_on(void)
2740 trace_hardirqs_on_caller(CALLER_ADDR0);
2742 EXPORT_SYMBOL(trace_hardirqs_on);
2745 * Hardirqs were disabled:
2747 __visible void trace_hardirqs_off_caller(unsigned long ip)
2749 struct task_struct *curr = current;
2751 time_hardirqs_off(CALLER_ADDR0, ip);
2753 if (unlikely(!debug_locks || current->lockdep_recursion))
2754 return;
2757 * So we're supposed to get called after you mask local IRQs, but for
2758 * some reason the hardware doesn't quite think you did a proper job.
2760 if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
2761 return;
2763 if (curr->hardirqs_enabled) {
2765 * We have done an ON -> OFF transition:
2767 curr->hardirqs_enabled = 0;
2768 curr->hardirq_disable_ip = ip;
2769 curr->hardirq_disable_event = ++curr->irq_events;
2770 debug_atomic_inc(hardirqs_off_events);
2771 } else
2772 debug_atomic_inc(redundant_hardirqs_off);
2774 EXPORT_SYMBOL(trace_hardirqs_off_caller);
2776 void trace_hardirqs_off(void)
2778 trace_hardirqs_off_caller(CALLER_ADDR0);
2780 EXPORT_SYMBOL(trace_hardirqs_off);
2783 * Softirqs will be enabled:
2785 void trace_softirqs_on(unsigned long ip)
2787 struct task_struct *curr = current;
2789 if (unlikely(!debug_locks || current->lockdep_recursion))
2790 return;
2793 * We fancy IRQs being disabled here, see softirq.c, avoids
2794 * funny state and nesting things.
2796 if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
2797 return;
2799 if (curr->softirqs_enabled) {
2800 debug_atomic_inc(redundant_softirqs_on);
2801 return;
2804 current->lockdep_recursion = 1;
2806 * We'll do an OFF -> ON transition:
2808 curr->softirqs_enabled = 1;
2809 curr->softirq_enable_ip = ip;
2810 curr->softirq_enable_event = ++curr->irq_events;
2811 debug_atomic_inc(softirqs_on_events);
2813 * We are going to turn softirqs on, so set the
2814 * usage bit for all held locks, if hardirqs are
2815 * enabled too:
2817 if (curr->hardirqs_enabled)
2818 mark_held_locks(curr, SOFTIRQ);
2819 current->lockdep_recursion = 0;
2823 * Softirqs were disabled:
2825 void trace_softirqs_off(unsigned long ip)
2827 struct task_struct *curr = current;
2829 if (unlikely(!debug_locks || current->lockdep_recursion))
2830 return;
2833 * We fancy IRQs being disabled here, see softirq.c
2835 if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
2836 return;
2838 if (curr->softirqs_enabled) {
2840 * We have done an ON -> OFF transition:
2842 curr->softirqs_enabled = 0;
2843 curr->softirq_disable_ip = ip;
2844 curr->softirq_disable_event = ++curr->irq_events;
2845 debug_atomic_inc(softirqs_off_events);
2847 * Whoops, we wanted softirqs off, so why aren't they?
2849 DEBUG_LOCKS_WARN_ON(!softirq_count());
2850 } else
2851 debug_atomic_inc(redundant_softirqs_off);
2854 static void __lockdep_trace_alloc(gfp_t gfp_mask, unsigned long flags)
2856 struct task_struct *curr = current;
2858 if (unlikely(!debug_locks))
2859 return;
2861 /* no reclaim without waiting on it */
2862 if (!(gfp_mask & __GFP_DIRECT_RECLAIM))
2863 return;
2865 /* this guy won't enter reclaim */
2866 if ((curr->flags & PF_MEMALLOC) && !(gfp_mask & __GFP_NOMEMALLOC))
2867 return;
2869 /* We're only interested __GFP_FS allocations for now */
2870 if (!(gfp_mask & __GFP_FS))
2871 return;
2874 * Oi! Can't be having __GFP_FS allocations with IRQs disabled.
2876 if (DEBUG_LOCKS_WARN_ON(irqs_disabled_flags(flags)))
2877 return;
2879 mark_held_locks(curr, RECLAIM_FS);
2882 static void check_flags(unsigned long flags);
2884 void lockdep_trace_alloc(gfp_t gfp_mask)
2886 unsigned long flags;
2888 if (unlikely(current->lockdep_recursion))
2889 return;
2891 raw_local_irq_save(flags);
2892 check_flags(flags);
2893 current->lockdep_recursion = 1;
2894 __lockdep_trace_alloc(gfp_mask, flags);
2895 current->lockdep_recursion = 0;
2896 raw_local_irq_restore(flags);
2899 static int mark_irqflags(struct task_struct *curr, struct held_lock *hlock)
2902 * If non-trylock use in a hardirq or softirq context, then
2903 * mark the lock as used in these contexts:
2905 if (!hlock->trylock) {
2906 if (hlock->read) {
2907 if (curr->hardirq_context)
2908 if (!mark_lock(curr, hlock,
2909 LOCK_USED_IN_HARDIRQ_READ))
2910 return 0;
2911 if (curr->softirq_context)
2912 if (!mark_lock(curr, hlock,
2913 LOCK_USED_IN_SOFTIRQ_READ))
2914 return 0;
2915 } else {
2916 if (curr->hardirq_context)
2917 if (!mark_lock(curr, hlock, LOCK_USED_IN_HARDIRQ))
2918 return 0;
2919 if (curr->softirq_context)
2920 if (!mark_lock(curr, hlock, LOCK_USED_IN_SOFTIRQ))
2921 return 0;
2924 if (!hlock->hardirqs_off) {
2925 if (hlock->read) {
2926 if (!mark_lock(curr, hlock,
2927 LOCK_ENABLED_HARDIRQ_READ))
2928 return 0;
2929 if (curr->softirqs_enabled)
2930 if (!mark_lock(curr, hlock,
2931 LOCK_ENABLED_SOFTIRQ_READ))
2932 return 0;
2933 } else {
2934 if (!mark_lock(curr, hlock,
2935 LOCK_ENABLED_HARDIRQ))
2936 return 0;
2937 if (curr->softirqs_enabled)
2938 if (!mark_lock(curr, hlock,
2939 LOCK_ENABLED_SOFTIRQ))
2940 return 0;
2945 * We reuse the irq context infrastructure more broadly as a general
2946 * context checking code. This tests GFP_FS recursion (a lock taken
2947 * during reclaim for a GFP_FS allocation is held over a GFP_FS
2948 * allocation).
2950 if (!hlock->trylock && (curr->lockdep_reclaim_gfp & __GFP_FS)) {
2951 if (hlock->read) {
2952 if (!mark_lock(curr, hlock, LOCK_USED_IN_RECLAIM_FS_READ))
2953 return 0;
2954 } else {
2955 if (!mark_lock(curr, hlock, LOCK_USED_IN_RECLAIM_FS))
2956 return 0;
2960 return 1;
2963 static inline unsigned int task_irq_context(struct task_struct *task)
2965 return 2 * !!task->hardirq_context + !!task->softirq_context;
2968 static int separate_irq_context(struct task_struct *curr,
2969 struct held_lock *hlock)
2971 unsigned int depth = curr->lockdep_depth;
2974 * Keep track of points where we cross into an interrupt context:
2976 if (depth) {
2977 struct held_lock *prev_hlock;
2979 prev_hlock = curr->held_locks + depth-1;
2981 * If we cross into another context, reset the
2982 * hash key (this also prevents the checking and the
2983 * adding of the dependency to 'prev'):
2985 if (prev_hlock->irq_context != hlock->irq_context)
2986 return 1;
2988 return 0;
2991 #else /* defined(CONFIG_TRACE_IRQFLAGS) && defined(CONFIG_PROVE_LOCKING) */
2993 static inline
2994 int mark_lock_irq(struct task_struct *curr, struct held_lock *this,
2995 enum lock_usage_bit new_bit)
2997 WARN_ON(1); /* Impossible innit? when we don't have TRACE_IRQFLAG */
2998 return 1;
3001 static inline int mark_irqflags(struct task_struct *curr,
3002 struct held_lock *hlock)
3004 return 1;
3007 static inline unsigned int task_irq_context(struct task_struct *task)
3009 return 0;
3012 static inline int separate_irq_context(struct task_struct *curr,
3013 struct held_lock *hlock)
3015 return 0;
3018 void lockdep_trace_alloc(gfp_t gfp_mask)
3022 #endif /* defined(CONFIG_TRACE_IRQFLAGS) && defined(CONFIG_PROVE_LOCKING) */
3025 * Mark a lock with a usage bit, and validate the state transition:
3027 static int mark_lock(struct task_struct *curr, struct held_lock *this,
3028 enum lock_usage_bit new_bit)
3030 unsigned int new_mask = 1 << new_bit, ret = 1;
3033 * If already set then do not dirty the cacheline,
3034 * nor do any checks:
3036 if (likely(hlock_class(this)->usage_mask & new_mask))
3037 return 1;
3039 if (!graph_lock())
3040 return 0;
3042 * Make sure we didn't race:
3044 if (unlikely(hlock_class(this)->usage_mask & new_mask)) {
3045 graph_unlock();
3046 return 1;
3049 hlock_class(this)->usage_mask |= new_mask;
3051 if (!save_trace(hlock_class(this)->usage_traces + new_bit))
3052 return 0;
3054 switch (new_bit) {
3055 #define LOCKDEP_STATE(__STATE) \
3056 case LOCK_USED_IN_##__STATE: \
3057 case LOCK_USED_IN_##__STATE##_READ: \
3058 case LOCK_ENABLED_##__STATE: \
3059 case LOCK_ENABLED_##__STATE##_READ:
3060 #include "lockdep_states.h"
3061 #undef LOCKDEP_STATE
3062 ret = mark_lock_irq(curr, this, new_bit);
3063 if (!ret)
3064 return 0;
3065 break;
3066 case LOCK_USED:
3067 debug_atomic_dec(nr_unused_locks);
3068 break;
3069 default:
3070 if (!debug_locks_off_graph_unlock())
3071 return 0;
3072 WARN_ON(1);
3073 return 0;
3076 graph_unlock();
3079 * We must printk outside of the graph_lock:
3081 if (ret == 2) {
3082 printk("\nmarked lock as {%s}:\n", usage_str[new_bit]);
3083 print_lock(this);
3084 print_irqtrace_events(curr);
3085 dump_stack();
3088 return ret;
3092 * Initialize a lock instance's lock-class mapping info:
3094 void lockdep_init_map(struct lockdep_map *lock, const char *name,
3095 struct lock_class_key *key, int subclass)
3097 int i;
3099 kmemcheck_mark_initialized(lock, sizeof(*lock));
3101 for (i = 0; i < NR_LOCKDEP_CACHING_CLASSES; i++)
3102 lock->class_cache[i] = NULL;
3104 #ifdef CONFIG_LOCK_STAT
3105 lock->cpu = raw_smp_processor_id();
3106 #endif
3109 * Can't be having no nameless bastards around this place!
3111 if (DEBUG_LOCKS_WARN_ON(!name)) {
3112 lock->name = "NULL";
3113 return;
3116 lock->name = name;
3119 * No key, no joy, we need to hash something.
3121 if (DEBUG_LOCKS_WARN_ON(!key))
3122 return;
3124 * Sanity check, the lock-class key must be persistent:
3126 if (!static_obj(key)) {
3127 printk("BUG: key %p not in .data!\n", key);
3129 * What it says above ^^^^^, I suggest you read it.
3131 DEBUG_LOCKS_WARN_ON(1);
3132 return;
3134 lock->key = key;
3136 if (unlikely(!debug_locks))
3137 return;
3139 if (subclass) {
3140 unsigned long flags;
3142 if (DEBUG_LOCKS_WARN_ON(current->lockdep_recursion))
3143 return;
3145 raw_local_irq_save(flags);
3146 current->lockdep_recursion = 1;
3147 register_lock_class(lock, subclass, 1);
3148 current->lockdep_recursion = 0;
3149 raw_local_irq_restore(flags);
3152 EXPORT_SYMBOL_GPL(lockdep_init_map);
3154 struct lock_class_key __lockdep_no_validate__;
3155 EXPORT_SYMBOL_GPL(__lockdep_no_validate__);
3157 static int
3158 print_lock_nested_lock_not_held(struct task_struct *curr,
3159 struct held_lock *hlock,
3160 unsigned long ip)
3162 if (!debug_locks_off())
3163 return 0;
3164 if (debug_locks_silent)
3165 return 0;
3167 printk("\n");
3168 printk("==================================\n");
3169 printk("[ BUG: Nested lock was not taken ]\n");
3170 print_kernel_ident();
3171 printk("----------------------------------\n");
3173 printk("%s/%d is trying to lock:\n", curr->comm, task_pid_nr(curr));
3174 print_lock(hlock);
3176 printk("\nbut this task is not holding:\n");
3177 printk("%s\n", hlock->nest_lock->name);
3179 printk("\nstack backtrace:\n");
3180 dump_stack();
3182 printk("\nother info that might help us debug this:\n");
3183 lockdep_print_held_locks(curr);
3185 printk("\nstack backtrace:\n");
3186 dump_stack();
3188 return 0;
3191 static int __lock_is_held(struct lockdep_map *lock);
3194 * This gets called for every mutex_lock*()/spin_lock*() operation.
3195 * We maintain the dependency maps and validate the locking attempt:
3197 static int __lock_acquire(struct lockdep_map *lock, unsigned int subclass,
3198 int trylock, int read, int check, int hardirqs_off,
3199 struct lockdep_map *nest_lock, unsigned long ip,
3200 int references, int pin_count)
3202 struct task_struct *curr = current;
3203 struct lock_class *class = NULL;
3204 struct held_lock *hlock;
3205 unsigned int depth;
3206 int chain_head = 0;
3207 int class_idx;
3208 u64 chain_key;
3210 if (unlikely(!debug_locks))
3211 return 0;
3214 * Lockdep should run with IRQs disabled, otherwise we could
3215 * get an interrupt which would want to take locks, which would
3216 * end up in lockdep and have you got a head-ache already?
3218 if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
3219 return 0;
3221 if (!prove_locking || lock->key == &__lockdep_no_validate__)
3222 check = 0;
3224 if (subclass < NR_LOCKDEP_CACHING_CLASSES)
3225 class = lock->class_cache[subclass];
3227 * Not cached?
3229 if (unlikely(!class)) {
3230 class = register_lock_class(lock, subclass, 0);
3231 if (!class)
3232 return 0;
3234 atomic_inc((atomic_t *)&class->ops);
3235 if (very_verbose(class)) {
3236 printk("\nacquire class [%p] %s", class->key, class->name);
3237 if (class->name_version > 1)
3238 printk("#%d", class->name_version);
3239 printk("\n");
3240 dump_stack();
3244 * Add the lock to the list of currently held locks.
3245 * (we dont increase the depth just yet, up until the
3246 * dependency checks are done)
3248 depth = curr->lockdep_depth;
3250 * Ran out of static storage for our per-task lock stack again have we?
3252 if (DEBUG_LOCKS_WARN_ON(depth >= MAX_LOCK_DEPTH))
3253 return 0;
3255 class_idx = class - lock_classes + 1;
3257 if (depth) {
3258 hlock = curr->held_locks + depth - 1;
3259 if (hlock->class_idx == class_idx && nest_lock) {
3260 if (hlock->references)
3261 hlock->references++;
3262 else
3263 hlock->references = 2;
3265 return 1;
3269 hlock = curr->held_locks + depth;
3271 * Plain impossible, we just registered it and checked it weren't no
3272 * NULL like.. I bet this mushroom I ate was good!
3274 if (DEBUG_LOCKS_WARN_ON(!class))
3275 return 0;
3276 hlock->class_idx = class_idx;
3277 hlock->acquire_ip = ip;
3278 hlock->instance = lock;
3279 hlock->nest_lock = nest_lock;
3280 hlock->irq_context = task_irq_context(curr);
3281 hlock->trylock = trylock;
3282 hlock->read = read;
3283 hlock->check = check;
3284 hlock->hardirqs_off = !!hardirqs_off;
3285 hlock->references = references;
3286 #ifdef CONFIG_LOCK_STAT
3287 hlock->waittime_stamp = 0;
3288 hlock->holdtime_stamp = lockstat_clock();
3289 #endif
3290 hlock->pin_count = pin_count;
3292 if (check && !mark_irqflags(curr, hlock))
3293 return 0;
3295 /* mark it as used: */
3296 if (!mark_lock(curr, hlock, LOCK_USED))
3297 return 0;
3300 * Calculate the chain hash: it's the combined hash of all the
3301 * lock keys along the dependency chain. We save the hash value
3302 * at every step so that we can get the current hash easily
3303 * after unlock. The chain hash is then used to cache dependency
3304 * results.
3306 * The 'key ID' is what is the most compact key value to drive
3307 * the hash, not class->key.
3310 * Whoops, we did it again.. ran straight out of our static allocation.
3312 if (DEBUG_LOCKS_WARN_ON(class_idx > MAX_LOCKDEP_KEYS))
3313 return 0;
3315 chain_key = curr->curr_chain_key;
3316 if (!depth) {
3318 * How can we have a chain hash when we ain't got no keys?!
3320 if (DEBUG_LOCKS_WARN_ON(chain_key != 0))
3321 return 0;
3322 chain_head = 1;
3325 hlock->prev_chain_key = chain_key;
3326 if (separate_irq_context(curr, hlock)) {
3327 chain_key = 0;
3328 chain_head = 1;
3330 chain_key = iterate_chain_key(chain_key, class_idx);
3332 if (nest_lock && !__lock_is_held(nest_lock))
3333 return print_lock_nested_lock_not_held(curr, hlock, ip);
3335 if (!validate_chain(curr, lock, hlock, chain_head, chain_key))
3336 return 0;
3338 curr->curr_chain_key = chain_key;
3339 curr->lockdep_depth++;
3340 check_chain_key(curr);
3341 #ifdef CONFIG_DEBUG_LOCKDEP
3342 if (unlikely(!debug_locks))
3343 return 0;
3344 #endif
3345 if (unlikely(curr->lockdep_depth >= MAX_LOCK_DEPTH)) {
3346 debug_locks_off();
3347 print_lockdep_off("BUG: MAX_LOCK_DEPTH too low!");
3348 printk(KERN_DEBUG "depth: %i max: %lu!\n",
3349 curr->lockdep_depth, MAX_LOCK_DEPTH);
3351 lockdep_print_held_locks(current);
3352 debug_show_all_locks();
3353 dump_stack();
3355 return 0;
3358 if (unlikely(curr->lockdep_depth > max_lockdep_depth))
3359 max_lockdep_depth = curr->lockdep_depth;
3361 return 1;
3364 static int
3365 print_unlock_imbalance_bug(struct task_struct *curr, struct lockdep_map *lock,
3366 unsigned long ip)
3368 if (!debug_locks_off())
3369 return 0;
3370 if (debug_locks_silent)
3371 return 0;
3373 printk("\n");
3374 printk("=====================================\n");
3375 printk("[ BUG: bad unlock balance detected! ]\n");
3376 print_kernel_ident();
3377 printk("-------------------------------------\n");
3378 printk("%s/%d is trying to release lock (",
3379 curr->comm, task_pid_nr(curr));
3380 print_lockdep_cache(lock);
3381 printk(") at:\n");
3382 print_ip_sym(ip);
3383 printk("but there are no more locks to release!\n");
3384 printk("\nother info that might help us debug this:\n");
3385 lockdep_print_held_locks(curr);
3387 printk("\nstack backtrace:\n");
3388 dump_stack();
3390 return 0;
3393 static int match_held_lock(struct held_lock *hlock, struct lockdep_map *lock)
3395 if (hlock->instance == lock)
3396 return 1;
3398 if (hlock->references) {
3399 struct lock_class *class = lock->class_cache[0];
3401 if (!class)
3402 class = look_up_lock_class(lock, 0);
3405 * If look_up_lock_class() failed to find a class, we're trying
3406 * to test if we hold a lock that has never yet been acquired.
3407 * Clearly if the lock hasn't been acquired _ever_, we're not
3408 * holding it either, so report failure.
3410 if (!class)
3411 return 0;
3414 * References, but not a lock we're actually ref-counting?
3415 * State got messed up, follow the sites that change ->references
3416 * and try to make sense of it.
3418 if (DEBUG_LOCKS_WARN_ON(!hlock->nest_lock))
3419 return 0;
3421 if (hlock->class_idx == class - lock_classes + 1)
3422 return 1;
3425 return 0;
3428 static int
3429 __lock_set_class(struct lockdep_map *lock, const char *name,
3430 struct lock_class_key *key, unsigned int subclass,
3431 unsigned long ip)
3433 struct task_struct *curr = current;
3434 struct held_lock *hlock, *prev_hlock;
3435 struct lock_class *class;
3436 unsigned int depth;
3437 int i;
3439 depth = curr->lockdep_depth;
3441 * This function is about (re)setting the class of a held lock,
3442 * yet we're not actually holding any locks. Naughty user!
3444 if (DEBUG_LOCKS_WARN_ON(!depth))
3445 return 0;
3447 prev_hlock = NULL;
3448 for (i = depth-1; i >= 0; i--) {
3449 hlock = curr->held_locks + i;
3451 * We must not cross into another context:
3453 if (prev_hlock && prev_hlock->irq_context != hlock->irq_context)
3454 break;
3455 if (match_held_lock(hlock, lock))
3456 goto found_it;
3457 prev_hlock = hlock;
3459 return print_unlock_imbalance_bug(curr, lock, ip);
3461 found_it:
3462 lockdep_init_map(lock, name, key, 0);
3463 class = register_lock_class(lock, subclass, 0);
3464 hlock->class_idx = class - lock_classes + 1;
3466 curr->lockdep_depth = i;
3467 curr->curr_chain_key = hlock->prev_chain_key;
3469 for (; i < depth; i++) {
3470 hlock = curr->held_locks + i;
3471 if (!__lock_acquire(hlock->instance,
3472 hlock_class(hlock)->subclass, hlock->trylock,
3473 hlock->read, hlock->check, hlock->hardirqs_off,
3474 hlock->nest_lock, hlock->acquire_ip,
3475 hlock->references, hlock->pin_count))
3476 return 0;
3480 * I took it apart and put it back together again, except now I have
3481 * these 'spare' parts.. where shall I put them.
3483 if (DEBUG_LOCKS_WARN_ON(curr->lockdep_depth != depth))
3484 return 0;
3485 return 1;
3489 * Remove the lock to the list of currently held locks - this gets
3490 * called on mutex_unlock()/spin_unlock*() (or on a failed
3491 * mutex_lock_interruptible()).
3493 * @nested is an hysterical artifact, needs a tree wide cleanup.
3495 static int
3496 __lock_release(struct lockdep_map *lock, int nested, unsigned long ip)
3498 struct task_struct *curr = current;
3499 struct held_lock *hlock, *prev_hlock;
3500 unsigned int depth;
3501 int i;
3503 if (unlikely(!debug_locks))
3504 return 0;
3506 depth = curr->lockdep_depth;
3508 * So we're all set to release this lock.. wait what lock? We don't
3509 * own any locks, you've been drinking again?
3511 if (DEBUG_LOCKS_WARN_ON(depth <= 0))
3512 return print_unlock_imbalance_bug(curr, lock, ip);
3515 * Check whether the lock exists in the current stack
3516 * of held locks:
3518 prev_hlock = NULL;
3519 for (i = depth-1; i >= 0; i--) {
3520 hlock = curr->held_locks + i;
3522 * We must not cross into another context:
3524 if (prev_hlock && prev_hlock->irq_context != hlock->irq_context)
3525 break;
3526 if (match_held_lock(hlock, lock))
3527 goto found_it;
3528 prev_hlock = hlock;
3530 return print_unlock_imbalance_bug(curr, lock, ip);
3532 found_it:
3533 if (hlock->instance == lock)
3534 lock_release_holdtime(hlock);
3536 WARN(hlock->pin_count, "releasing a pinned lock\n");
3538 if (hlock->references) {
3539 hlock->references--;
3540 if (hlock->references) {
3542 * We had, and after removing one, still have
3543 * references, the current lock stack is still
3544 * valid. We're done!
3546 return 1;
3551 * We have the right lock to unlock, 'hlock' points to it.
3552 * Now we remove it from the stack, and add back the other
3553 * entries (if any), recalculating the hash along the way:
3556 curr->lockdep_depth = i;
3557 curr->curr_chain_key = hlock->prev_chain_key;
3559 for (i++; i < depth; i++) {
3560 hlock = curr->held_locks + i;
3561 if (!__lock_acquire(hlock->instance,
3562 hlock_class(hlock)->subclass, hlock->trylock,
3563 hlock->read, hlock->check, hlock->hardirqs_off,
3564 hlock->nest_lock, hlock->acquire_ip,
3565 hlock->references, hlock->pin_count))
3566 return 0;
3570 * We had N bottles of beer on the wall, we drank one, but now
3571 * there's not N-1 bottles of beer left on the wall...
3573 if (DEBUG_LOCKS_WARN_ON(curr->lockdep_depth != depth - 1))
3574 return 0;
3576 return 1;
3579 static int __lock_is_held(struct lockdep_map *lock)
3581 struct task_struct *curr = current;
3582 int i;
3584 for (i = 0; i < curr->lockdep_depth; i++) {
3585 struct held_lock *hlock = curr->held_locks + i;
3587 if (match_held_lock(hlock, lock))
3588 return 1;
3591 return 0;
3594 static struct pin_cookie __lock_pin_lock(struct lockdep_map *lock)
3596 struct pin_cookie cookie = NIL_COOKIE;
3597 struct task_struct *curr = current;
3598 int i;
3600 if (unlikely(!debug_locks))
3601 return cookie;
3603 for (i = 0; i < curr->lockdep_depth; i++) {
3604 struct held_lock *hlock = curr->held_locks + i;
3606 if (match_held_lock(hlock, lock)) {
3608 * Grab 16bits of randomness; this is sufficient to not
3609 * be guessable and still allows some pin nesting in
3610 * our u32 pin_count.
3612 cookie.val = 1 + (prandom_u32() >> 16);
3613 hlock->pin_count += cookie.val;
3614 return cookie;
3618 WARN(1, "pinning an unheld lock\n");
3619 return cookie;
3622 static void __lock_repin_lock(struct lockdep_map *lock, struct pin_cookie cookie)
3624 struct task_struct *curr = current;
3625 int i;
3627 if (unlikely(!debug_locks))
3628 return;
3630 for (i = 0; i < curr->lockdep_depth; i++) {
3631 struct held_lock *hlock = curr->held_locks + i;
3633 if (match_held_lock(hlock, lock)) {
3634 hlock->pin_count += cookie.val;
3635 return;
3639 WARN(1, "pinning an unheld lock\n");
3642 static void __lock_unpin_lock(struct lockdep_map *lock, struct pin_cookie cookie)
3644 struct task_struct *curr = current;
3645 int i;
3647 if (unlikely(!debug_locks))
3648 return;
3650 for (i = 0; i < curr->lockdep_depth; i++) {
3651 struct held_lock *hlock = curr->held_locks + i;
3653 if (match_held_lock(hlock, lock)) {
3654 if (WARN(!hlock->pin_count, "unpinning an unpinned lock\n"))
3655 return;
3657 hlock->pin_count -= cookie.val;
3659 if (WARN((int)hlock->pin_count < 0, "pin count corrupted\n"))
3660 hlock->pin_count = 0;
3662 return;
3666 WARN(1, "unpinning an unheld lock\n");
3670 * Check whether we follow the irq-flags state precisely:
3672 static void check_flags(unsigned long flags)
3674 #if defined(CONFIG_PROVE_LOCKING) && defined(CONFIG_DEBUG_LOCKDEP) && \
3675 defined(CONFIG_TRACE_IRQFLAGS)
3676 if (!debug_locks)
3677 return;
3679 if (irqs_disabled_flags(flags)) {
3680 if (DEBUG_LOCKS_WARN_ON(current->hardirqs_enabled)) {
3681 printk("possible reason: unannotated irqs-off.\n");
3683 } else {
3684 if (DEBUG_LOCKS_WARN_ON(!current->hardirqs_enabled)) {
3685 printk("possible reason: unannotated irqs-on.\n");
3690 * We dont accurately track softirq state in e.g.
3691 * hardirq contexts (such as on 4KSTACKS), so only
3692 * check if not in hardirq contexts:
3694 if (!hardirq_count()) {
3695 if (softirq_count()) {
3696 /* like the above, but with softirqs */
3697 DEBUG_LOCKS_WARN_ON(current->softirqs_enabled);
3698 } else {
3699 /* lick the above, does it taste good? */
3700 DEBUG_LOCKS_WARN_ON(!current->softirqs_enabled);
3704 if (!debug_locks)
3705 print_irqtrace_events(current);
3706 #endif
3709 void lock_set_class(struct lockdep_map *lock, const char *name,
3710 struct lock_class_key *key, unsigned int subclass,
3711 unsigned long ip)
3713 unsigned long flags;
3715 if (unlikely(current->lockdep_recursion))
3716 return;
3718 raw_local_irq_save(flags);
3719 current->lockdep_recursion = 1;
3720 check_flags(flags);
3721 if (__lock_set_class(lock, name, key, subclass, ip))
3722 check_chain_key(current);
3723 current->lockdep_recursion = 0;
3724 raw_local_irq_restore(flags);
3726 EXPORT_SYMBOL_GPL(lock_set_class);
3729 * We are not always called with irqs disabled - do that here,
3730 * and also avoid lockdep recursion:
3732 void lock_acquire(struct lockdep_map *lock, unsigned int subclass,
3733 int trylock, int read, int check,
3734 struct lockdep_map *nest_lock, unsigned long ip)
3736 unsigned long flags;
3738 if (unlikely(current->lockdep_recursion))
3739 return;
3741 raw_local_irq_save(flags);
3742 check_flags(flags);
3744 current->lockdep_recursion = 1;
3745 trace_lock_acquire(lock, subclass, trylock, read, check, nest_lock, ip);
3746 __lock_acquire(lock, subclass, trylock, read, check,
3747 irqs_disabled_flags(flags), nest_lock, ip, 0, 0);
3748 current->lockdep_recursion = 0;
3749 raw_local_irq_restore(flags);
3751 EXPORT_SYMBOL_GPL(lock_acquire);
3753 void lock_release(struct lockdep_map *lock, int nested,
3754 unsigned long ip)
3756 unsigned long flags;
3758 if (unlikely(current->lockdep_recursion))
3759 return;
3761 raw_local_irq_save(flags);
3762 check_flags(flags);
3763 current->lockdep_recursion = 1;
3764 trace_lock_release(lock, ip);
3765 if (__lock_release(lock, nested, ip))
3766 check_chain_key(current);
3767 current->lockdep_recursion = 0;
3768 raw_local_irq_restore(flags);
3770 EXPORT_SYMBOL_GPL(lock_release);
3772 int lock_is_held(struct lockdep_map *lock)
3774 unsigned long flags;
3775 int ret = 0;
3777 if (unlikely(current->lockdep_recursion))
3778 return 1; /* avoid false negative lockdep_assert_held() */
3780 raw_local_irq_save(flags);
3781 check_flags(flags);
3783 current->lockdep_recursion = 1;
3784 ret = __lock_is_held(lock);
3785 current->lockdep_recursion = 0;
3786 raw_local_irq_restore(flags);
3788 return ret;
3790 EXPORT_SYMBOL_GPL(lock_is_held);
3792 struct pin_cookie lock_pin_lock(struct lockdep_map *lock)
3794 struct pin_cookie cookie = NIL_COOKIE;
3795 unsigned long flags;
3797 if (unlikely(current->lockdep_recursion))
3798 return cookie;
3800 raw_local_irq_save(flags);
3801 check_flags(flags);
3803 current->lockdep_recursion = 1;
3804 cookie = __lock_pin_lock(lock);
3805 current->lockdep_recursion = 0;
3806 raw_local_irq_restore(flags);
3808 return cookie;
3810 EXPORT_SYMBOL_GPL(lock_pin_lock);
3812 void lock_repin_lock(struct lockdep_map *lock, struct pin_cookie cookie)
3814 unsigned long flags;
3816 if (unlikely(current->lockdep_recursion))
3817 return;
3819 raw_local_irq_save(flags);
3820 check_flags(flags);
3822 current->lockdep_recursion = 1;
3823 __lock_repin_lock(lock, cookie);
3824 current->lockdep_recursion = 0;
3825 raw_local_irq_restore(flags);
3827 EXPORT_SYMBOL_GPL(lock_repin_lock);
3829 void lock_unpin_lock(struct lockdep_map *lock, struct pin_cookie cookie)
3831 unsigned long flags;
3833 if (unlikely(current->lockdep_recursion))
3834 return;
3836 raw_local_irq_save(flags);
3837 check_flags(flags);
3839 current->lockdep_recursion = 1;
3840 __lock_unpin_lock(lock, cookie);
3841 current->lockdep_recursion = 0;
3842 raw_local_irq_restore(flags);
3844 EXPORT_SYMBOL_GPL(lock_unpin_lock);
3846 void lockdep_set_current_reclaim_state(gfp_t gfp_mask)
3848 current->lockdep_reclaim_gfp = gfp_mask;
3851 void lockdep_clear_current_reclaim_state(void)
3853 current->lockdep_reclaim_gfp = 0;
3856 #ifdef CONFIG_LOCK_STAT
3857 static int
3858 print_lock_contention_bug(struct task_struct *curr, struct lockdep_map *lock,
3859 unsigned long ip)
3861 if (!debug_locks_off())
3862 return 0;
3863 if (debug_locks_silent)
3864 return 0;
3866 printk("\n");
3867 printk("=================================\n");
3868 printk("[ BUG: bad contention detected! ]\n");
3869 print_kernel_ident();
3870 printk("---------------------------------\n");
3871 printk("%s/%d is trying to contend lock (",
3872 curr->comm, task_pid_nr(curr));
3873 print_lockdep_cache(lock);
3874 printk(") at:\n");
3875 print_ip_sym(ip);
3876 printk("but there are no locks held!\n");
3877 printk("\nother info that might help us debug this:\n");
3878 lockdep_print_held_locks(curr);
3880 printk("\nstack backtrace:\n");
3881 dump_stack();
3883 return 0;
3886 static void
3887 __lock_contended(struct lockdep_map *lock, unsigned long ip)
3889 struct task_struct *curr = current;
3890 struct held_lock *hlock, *prev_hlock;
3891 struct lock_class_stats *stats;
3892 unsigned int depth;
3893 int i, contention_point, contending_point;
3895 depth = curr->lockdep_depth;
3897 * Whee, we contended on this lock, except it seems we're not
3898 * actually trying to acquire anything much at all..
3900 if (DEBUG_LOCKS_WARN_ON(!depth))
3901 return;
3903 prev_hlock = NULL;
3904 for (i = depth-1; i >= 0; i--) {
3905 hlock = curr->held_locks + i;
3907 * We must not cross into another context:
3909 if (prev_hlock && prev_hlock->irq_context != hlock->irq_context)
3910 break;
3911 if (match_held_lock(hlock, lock))
3912 goto found_it;
3913 prev_hlock = hlock;
3915 print_lock_contention_bug(curr, lock, ip);
3916 return;
3918 found_it:
3919 if (hlock->instance != lock)
3920 return;
3922 hlock->waittime_stamp = lockstat_clock();
3924 contention_point = lock_point(hlock_class(hlock)->contention_point, ip);
3925 contending_point = lock_point(hlock_class(hlock)->contending_point,
3926 lock->ip);
3928 stats = get_lock_stats(hlock_class(hlock));
3929 if (contention_point < LOCKSTAT_POINTS)
3930 stats->contention_point[contention_point]++;
3931 if (contending_point < LOCKSTAT_POINTS)
3932 stats->contending_point[contending_point]++;
3933 if (lock->cpu != smp_processor_id())
3934 stats->bounces[bounce_contended + !!hlock->read]++;
3935 put_lock_stats(stats);
3938 static void
3939 __lock_acquired(struct lockdep_map *lock, unsigned long ip)
3941 struct task_struct *curr = current;
3942 struct held_lock *hlock, *prev_hlock;
3943 struct lock_class_stats *stats;
3944 unsigned int depth;
3945 u64 now, waittime = 0;
3946 int i, cpu;
3948 depth = curr->lockdep_depth;
3950 * Yay, we acquired ownership of this lock we didn't try to
3951 * acquire, how the heck did that happen?
3953 if (DEBUG_LOCKS_WARN_ON(!depth))
3954 return;
3956 prev_hlock = NULL;
3957 for (i = depth-1; i >= 0; i--) {
3958 hlock = curr->held_locks + i;
3960 * We must not cross into another context:
3962 if (prev_hlock && prev_hlock->irq_context != hlock->irq_context)
3963 break;
3964 if (match_held_lock(hlock, lock))
3965 goto found_it;
3966 prev_hlock = hlock;
3968 print_lock_contention_bug(curr, lock, _RET_IP_);
3969 return;
3971 found_it:
3972 if (hlock->instance != lock)
3973 return;
3975 cpu = smp_processor_id();
3976 if (hlock->waittime_stamp) {
3977 now = lockstat_clock();
3978 waittime = now - hlock->waittime_stamp;
3979 hlock->holdtime_stamp = now;
3982 trace_lock_acquired(lock, ip);
3984 stats = get_lock_stats(hlock_class(hlock));
3985 if (waittime) {
3986 if (hlock->read)
3987 lock_time_inc(&stats->read_waittime, waittime);
3988 else
3989 lock_time_inc(&stats->write_waittime, waittime);
3991 if (lock->cpu != cpu)
3992 stats->bounces[bounce_acquired + !!hlock->read]++;
3993 put_lock_stats(stats);
3995 lock->cpu = cpu;
3996 lock->ip = ip;
3999 void lock_contended(struct lockdep_map *lock, unsigned long ip)
4001 unsigned long flags;
4003 if (unlikely(!lock_stat))
4004 return;
4006 if (unlikely(current->lockdep_recursion))
4007 return;
4009 raw_local_irq_save(flags);
4010 check_flags(flags);
4011 current->lockdep_recursion = 1;
4012 trace_lock_contended(lock, ip);
4013 __lock_contended(lock, ip);
4014 current->lockdep_recursion = 0;
4015 raw_local_irq_restore(flags);
4017 EXPORT_SYMBOL_GPL(lock_contended);
4019 void lock_acquired(struct lockdep_map *lock, unsigned long ip)
4021 unsigned long flags;
4023 if (unlikely(!lock_stat))
4024 return;
4026 if (unlikely(current->lockdep_recursion))
4027 return;
4029 raw_local_irq_save(flags);
4030 check_flags(flags);
4031 current->lockdep_recursion = 1;
4032 __lock_acquired(lock, ip);
4033 current->lockdep_recursion = 0;
4034 raw_local_irq_restore(flags);
4036 EXPORT_SYMBOL_GPL(lock_acquired);
4037 #endif
4040 * Used by the testsuite, sanitize the validator state
4041 * after a simulated failure:
4044 void lockdep_reset(void)
4046 unsigned long flags;
4047 int i;
4049 raw_local_irq_save(flags);
4050 current->curr_chain_key = 0;
4051 current->lockdep_depth = 0;
4052 current->lockdep_recursion = 0;
4053 memset(current->held_locks, 0, MAX_LOCK_DEPTH*sizeof(struct held_lock));
4054 nr_hardirq_chains = 0;
4055 nr_softirq_chains = 0;
4056 nr_process_chains = 0;
4057 debug_locks = 1;
4058 for (i = 0; i < CHAINHASH_SIZE; i++)
4059 INIT_HLIST_HEAD(chainhash_table + i);
4060 raw_local_irq_restore(flags);
4063 static void zap_class(struct lock_class *class)
4065 int i;
4068 * Remove all dependencies this lock is
4069 * involved in:
4071 for (i = 0; i < nr_list_entries; i++) {
4072 if (list_entries[i].class == class)
4073 list_del_rcu(&list_entries[i].entry);
4076 * Unhash the class and remove it from the all_lock_classes list:
4078 hlist_del_rcu(&class->hash_entry);
4079 list_del_rcu(&class->lock_entry);
4081 RCU_INIT_POINTER(class->key, NULL);
4082 RCU_INIT_POINTER(class->name, NULL);
4085 static inline int within(const void *addr, void *start, unsigned long size)
4087 return addr >= start && addr < start + size;
4091 * Used in module.c to remove lock classes from memory that is going to be
4092 * freed; and possibly re-used by other modules.
4094 * We will have had one sync_sched() before getting here, so we're guaranteed
4095 * nobody will look up these exact classes -- they're properly dead but still
4096 * allocated.
4098 void lockdep_free_key_range(void *start, unsigned long size)
4100 struct lock_class *class;
4101 struct hlist_head *head;
4102 unsigned long flags;
4103 int i;
4104 int locked;
4106 raw_local_irq_save(flags);
4107 locked = graph_lock();
4110 * Unhash all classes that were created by this module:
4112 for (i = 0; i < CLASSHASH_SIZE; i++) {
4113 head = classhash_table + i;
4114 hlist_for_each_entry_rcu(class, head, hash_entry) {
4115 if (within(class->key, start, size))
4116 zap_class(class);
4117 else if (within(class->name, start, size))
4118 zap_class(class);
4122 if (locked)
4123 graph_unlock();
4124 raw_local_irq_restore(flags);
4127 * Wait for any possible iterators from look_up_lock_class() to pass
4128 * before continuing to free the memory they refer to.
4130 * sync_sched() is sufficient because the read-side is IRQ disable.
4132 synchronize_sched();
4135 * XXX at this point we could return the resources to the pool;
4136 * instead we leak them. We would need to change to bitmap allocators
4137 * instead of the linear allocators we have now.
4141 void lockdep_reset_lock(struct lockdep_map *lock)
4143 struct lock_class *class;
4144 struct hlist_head *head;
4145 unsigned long flags;
4146 int i, j;
4147 int locked;
4149 raw_local_irq_save(flags);
4152 * Remove all classes this lock might have:
4154 for (j = 0; j < MAX_LOCKDEP_SUBCLASSES; j++) {
4156 * If the class exists we look it up and zap it:
4158 class = look_up_lock_class(lock, j);
4159 if (class)
4160 zap_class(class);
4163 * Debug check: in the end all mapped classes should
4164 * be gone.
4166 locked = graph_lock();
4167 for (i = 0; i < CLASSHASH_SIZE; i++) {
4168 head = classhash_table + i;
4169 hlist_for_each_entry_rcu(class, head, hash_entry) {
4170 int match = 0;
4172 for (j = 0; j < NR_LOCKDEP_CACHING_CLASSES; j++)
4173 match |= class == lock->class_cache[j];
4175 if (unlikely(match)) {
4176 if (debug_locks_off_graph_unlock()) {
4178 * We all just reset everything, how did it match?
4180 WARN_ON(1);
4182 goto out_restore;
4186 if (locked)
4187 graph_unlock();
4189 out_restore:
4190 raw_local_irq_restore(flags);
4193 void __init lockdep_info(void)
4195 printk("Lock dependency validator: Copyright (c) 2006 Red Hat, Inc., Ingo Molnar\n");
4197 printk("... MAX_LOCKDEP_SUBCLASSES: %lu\n", MAX_LOCKDEP_SUBCLASSES);
4198 printk("... MAX_LOCK_DEPTH: %lu\n", MAX_LOCK_DEPTH);
4199 printk("... MAX_LOCKDEP_KEYS: %lu\n", MAX_LOCKDEP_KEYS);
4200 printk("... CLASSHASH_SIZE: %lu\n", CLASSHASH_SIZE);
4201 printk("... MAX_LOCKDEP_ENTRIES: %lu\n", MAX_LOCKDEP_ENTRIES);
4202 printk("... MAX_LOCKDEP_CHAINS: %lu\n", MAX_LOCKDEP_CHAINS);
4203 printk("... CHAINHASH_SIZE: %lu\n", CHAINHASH_SIZE);
4205 printk(" memory used by lock dependency info: %lu kB\n",
4206 (sizeof(struct lock_class) * MAX_LOCKDEP_KEYS +
4207 sizeof(struct list_head) * CLASSHASH_SIZE +
4208 sizeof(struct lock_list) * MAX_LOCKDEP_ENTRIES +
4209 sizeof(struct lock_chain) * MAX_LOCKDEP_CHAINS +
4210 sizeof(struct list_head) * CHAINHASH_SIZE
4211 #ifdef CONFIG_PROVE_LOCKING
4212 + sizeof(struct circular_queue)
4213 #endif
4214 ) / 1024
4217 printk(" per task-struct memory footprint: %lu bytes\n",
4218 sizeof(struct held_lock) * MAX_LOCK_DEPTH);
4221 static void
4222 print_freed_lock_bug(struct task_struct *curr, const void *mem_from,
4223 const void *mem_to, struct held_lock *hlock)
4225 if (!debug_locks_off())
4226 return;
4227 if (debug_locks_silent)
4228 return;
4230 printk("\n");
4231 printk("=========================\n");
4232 printk("[ BUG: held lock freed! ]\n");
4233 print_kernel_ident();
4234 printk("-------------------------\n");
4235 printk("%s/%d is freeing memory %p-%p, with a lock still held there!\n",
4236 curr->comm, task_pid_nr(curr), mem_from, mem_to-1);
4237 print_lock(hlock);
4238 lockdep_print_held_locks(curr);
4240 printk("\nstack backtrace:\n");
4241 dump_stack();
4244 static inline int not_in_range(const void* mem_from, unsigned long mem_len,
4245 const void* lock_from, unsigned long lock_len)
4247 return lock_from + lock_len <= mem_from ||
4248 mem_from + mem_len <= lock_from;
4252 * Called when kernel memory is freed (or unmapped), or if a lock
4253 * is destroyed or reinitialized - this code checks whether there is
4254 * any held lock in the memory range of <from> to <to>:
4256 void debug_check_no_locks_freed(const void *mem_from, unsigned long mem_len)
4258 struct task_struct *curr = current;
4259 struct held_lock *hlock;
4260 unsigned long flags;
4261 int i;
4263 if (unlikely(!debug_locks))
4264 return;
4266 local_irq_save(flags);
4267 for (i = 0; i < curr->lockdep_depth; i++) {
4268 hlock = curr->held_locks + i;
4270 if (not_in_range(mem_from, mem_len, hlock->instance,
4271 sizeof(*hlock->instance)))
4272 continue;
4274 print_freed_lock_bug(curr, mem_from, mem_from + mem_len, hlock);
4275 break;
4277 local_irq_restore(flags);
4279 EXPORT_SYMBOL_GPL(debug_check_no_locks_freed);
4281 static void print_held_locks_bug(void)
4283 if (!debug_locks_off())
4284 return;
4285 if (debug_locks_silent)
4286 return;
4288 printk("\n");
4289 printk("=====================================\n");
4290 printk("[ BUG: %s/%d still has locks held! ]\n",
4291 current->comm, task_pid_nr(current));
4292 print_kernel_ident();
4293 printk("-------------------------------------\n");
4294 lockdep_print_held_locks(current);
4295 printk("\nstack backtrace:\n");
4296 dump_stack();
4299 void debug_check_no_locks_held(void)
4301 if (unlikely(current->lockdep_depth > 0))
4302 print_held_locks_bug();
4304 EXPORT_SYMBOL_GPL(debug_check_no_locks_held);
4306 #ifdef __KERNEL__
4307 void debug_show_all_locks(void)
4309 struct task_struct *g, *p;
4310 int count = 10;
4311 int unlock = 1;
4313 if (unlikely(!debug_locks)) {
4314 printk("INFO: lockdep is turned off.\n");
4315 return;
4317 printk("\nShowing all locks held in the system:\n");
4320 * Here we try to get the tasklist_lock as hard as possible,
4321 * if not successful after 2 seconds we ignore it (but keep
4322 * trying). This is to enable a debug printout even if a
4323 * tasklist_lock-holding task deadlocks or crashes.
4325 retry:
4326 if (!read_trylock(&tasklist_lock)) {
4327 if (count == 10)
4328 printk("hm, tasklist_lock locked, retrying... ");
4329 if (count) {
4330 count--;
4331 printk(" #%d", 10-count);
4332 mdelay(200);
4333 goto retry;
4335 printk(" ignoring it.\n");
4336 unlock = 0;
4337 } else {
4338 if (count != 10)
4339 printk(KERN_CONT " locked it.\n");
4342 do_each_thread(g, p) {
4344 * It's not reliable to print a task's held locks
4345 * if it's not sleeping (or if it's not the current
4346 * task):
4348 if (p->state == TASK_RUNNING && p != current)
4349 continue;
4350 if (p->lockdep_depth)
4351 lockdep_print_held_locks(p);
4352 if (!unlock)
4353 if (read_trylock(&tasklist_lock))
4354 unlock = 1;
4355 } while_each_thread(g, p);
4357 printk("\n");
4358 printk("=============================================\n\n");
4360 if (unlock)
4361 read_unlock(&tasklist_lock);
4363 EXPORT_SYMBOL_GPL(debug_show_all_locks);
4364 #endif
4367 * Careful: only use this function if you are sure that
4368 * the task cannot run in parallel!
4370 void debug_show_held_locks(struct task_struct *task)
4372 if (unlikely(!debug_locks)) {
4373 printk("INFO: lockdep is turned off.\n");
4374 return;
4376 lockdep_print_held_locks(task);
4378 EXPORT_SYMBOL_GPL(debug_show_held_locks);
4380 asmlinkage __visible void lockdep_sys_exit(void)
4382 struct task_struct *curr = current;
4384 if (unlikely(curr->lockdep_depth)) {
4385 if (!debug_locks_off())
4386 return;
4387 printk("\n");
4388 printk("================================================\n");
4389 printk("[ BUG: lock held when returning to user space! ]\n");
4390 print_kernel_ident();
4391 printk("------------------------------------------------\n");
4392 printk("%s/%d is leaving the kernel with locks still held!\n",
4393 curr->comm, curr->pid);
4394 lockdep_print_held_locks(curr);
4398 void lockdep_rcu_suspicious(const char *file, const int line, const char *s)
4400 struct task_struct *curr = current;
4402 #ifndef CONFIG_PROVE_RCU_REPEATEDLY
4403 if (!debug_locks_off())
4404 return;
4405 #endif /* #ifdef CONFIG_PROVE_RCU_REPEATEDLY */
4406 /* Note: the following can be executed concurrently, so be careful. */
4407 printk("\n");
4408 printk("===============================\n");
4409 printk("[ INFO: suspicious RCU usage. ]\n");
4410 print_kernel_ident();
4411 printk("-------------------------------\n");
4412 printk("%s:%d %s!\n", file, line, s);
4413 printk("\nother info that might help us debug this:\n\n");
4414 printk("\n%srcu_scheduler_active = %d, debug_locks = %d\n",
4415 !rcu_lockdep_current_cpu_online()
4416 ? "RCU used illegally from offline CPU!\n"
4417 : !rcu_is_watching()
4418 ? "RCU used illegally from idle CPU!\n"
4419 : "",
4420 rcu_scheduler_active, debug_locks);
4423 * If a CPU is in the RCU-free window in idle (ie: in the section
4424 * between rcu_idle_enter() and rcu_idle_exit(), then RCU
4425 * considers that CPU to be in an "extended quiescent state",
4426 * which means that RCU will be completely ignoring that CPU.
4427 * Therefore, rcu_read_lock() and friends have absolutely no
4428 * effect on a CPU running in that state. In other words, even if
4429 * such an RCU-idle CPU has called rcu_read_lock(), RCU might well
4430 * delete data structures out from under it. RCU really has no
4431 * choice here: we need to keep an RCU-free window in idle where
4432 * the CPU may possibly enter into low power mode. This way we can
4433 * notice an extended quiescent state to other CPUs that started a grace
4434 * period. Otherwise we would delay any grace period as long as we run
4435 * in the idle task.
4437 * So complain bitterly if someone does call rcu_read_lock(),
4438 * rcu_read_lock_bh() and so on from extended quiescent states.
4440 if (!rcu_is_watching())
4441 printk("RCU used illegally from extended quiescent state!\n");
4443 lockdep_print_held_locks(curr);
4444 printk("\nstack backtrace:\n");
4445 dump_stack();
4447 EXPORT_SYMBOL_GPL(lockdep_rcu_suspicious);