4 * Runtime locking correctness validator
6 * Started by Ingo Molnar:
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>
47 #include <asm/sections.h>
49 #include "lockdep_internals.h"
51 #define CREATE_TRACE_POINTS
52 #include <trace/events/lockdep.h>
54 #ifdef CONFIG_PROVE_LOCKING
55 int prove_locking = 1;
56 module_param(prove_locking, int, 0644);
58 #define prove_locking 0
61 #ifdef CONFIG_LOCK_STAT
63 module_param(lock_stat, int, 0644);
69 * lockdep_lock: protects the lockdep graph, the hashes and the
70 * class/list/hash allocators.
72 * This is one of the rare exceptions where it's justified
73 * to use a raw spinlock - we really dont want the spinlock
74 * code to recurse back into the lockdep code...
76 static raw_spinlock_t lockdep_lock = (raw_spinlock_t)__RAW_SPIN_LOCK_UNLOCKED;
78 static int graph_lock(void)
80 __raw_spin_lock(&lockdep_lock);
82 * Make sure that if another CPU detected a bug while
83 * walking the graph we dont change it (while the other
84 * CPU is busy printing out stuff with the graph lock
88 __raw_spin_unlock(&lockdep_lock);
91 /* prevent any recursions within lockdep from causing deadlocks */
92 current->lockdep_recursion++;
96 static inline int graph_unlock(void)
98 if (debug_locks && !__raw_spin_is_locked(&lockdep_lock))
99 return DEBUG_LOCKS_WARN_ON(1);
101 current->lockdep_recursion--;
102 __raw_spin_unlock(&lockdep_lock);
107 * Turn lock debugging off and return with 0 if it was off already,
108 * and also release the graph lock:
110 static inline int debug_locks_off_graph_unlock(void)
112 int ret = debug_locks_off();
114 __raw_spin_unlock(&lockdep_lock);
119 static int lockdep_initialized;
121 unsigned long nr_list_entries;
122 static struct lock_list list_entries[MAX_LOCKDEP_ENTRIES];
125 * All data structures here are protected by the global debug_lock.
127 * Mutex key structs only get allocated, once during bootup, and never
128 * get freed - this significantly simplifies the debugging code.
130 unsigned long nr_lock_classes;
131 static struct lock_class lock_classes[MAX_LOCKDEP_KEYS];
133 static inline struct lock_class *hlock_class(struct held_lock *hlock)
135 if (!hlock->class_idx) {
136 DEBUG_LOCKS_WARN_ON(1);
139 return lock_classes + hlock->class_idx - 1;
142 #ifdef CONFIG_LOCK_STAT
143 static DEFINE_PER_CPU(struct lock_class_stats[MAX_LOCKDEP_KEYS], lock_stats);
145 static int lock_point(unsigned long points[], unsigned long ip)
149 for (i = 0; i < LOCKSTAT_POINTS; i++) {
150 if (points[i] == 0) {
161 static void lock_time_inc(struct lock_time *lt, s64 time)
166 if (time < lt->min || !lt->min)
173 static inline void lock_time_add(struct lock_time *src, struct lock_time *dst)
175 dst->min += src->min;
176 dst->max += src->max;
177 dst->total += src->total;
181 struct lock_class_stats lock_stats(struct lock_class *class)
183 struct lock_class_stats stats;
186 memset(&stats, 0, sizeof(struct lock_class_stats));
187 for_each_possible_cpu(cpu) {
188 struct lock_class_stats *pcs =
189 &per_cpu(lock_stats, cpu)[class - lock_classes];
191 for (i = 0; i < ARRAY_SIZE(stats.contention_point); i++)
192 stats.contention_point[i] += pcs->contention_point[i];
194 for (i = 0; i < ARRAY_SIZE(stats.contending_point); i++)
195 stats.contending_point[i] += pcs->contending_point[i];
197 lock_time_add(&pcs->read_waittime, &stats.read_waittime);
198 lock_time_add(&pcs->write_waittime, &stats.write_waittime);
200 lock_time_add(&pcs->read_holdtime, &stats.read_holdtime);
201 lock_time_add(&pcs->write_holdtime, &stats.write_holdtime);
203 for (i = 0; i < ARRAY_SIZE(stats.bounces); i++)
204 stats.bounces[i] += pcs->bounces[i];
210 void clear_lock_stats(struct lock_class *class)
214 for_each_possible_cpu(cpu) {
215 struct lock_class_stats *cpu_stats =
216 &per_cpu(lock_stats, cpu)[class - lock_classes];
218 memset(cpu_stats, 0, sizeof(struct lock_class_stats));
220 memset(class->contention_point, 0, sizeof(class->contention_point));
221 memset(class->contending_point, 0, sizeof(class->contending_point));
224 static struct lock_class_stats *get_lock_stats(struct lock_class *class)
226 return &get_cpu_var(lock_stats)[class - lock_classes];
229 static void put_lock_stats(struct lock_class_stats *stats)
231 put_cpu_var(lock_stats);
234 static void lock_release_holdtime(struct held_lock *hlock)
236 struct lock_class_stats *stats;
242 holdtime = sched_clock() - hlock->holdtime_stamp;
244 stats = get_lock_stats(hlock_class(hlock));
246 lock_time_inc(&stats->read_holdtime, holdtime);
248 lock_time_inc(&stats->write_holdtime, holdtime);
249 put_lock_stats(stats);
252 static inline void lock_release_holdtime(struct held_lock *hlock)
258 * We keep a global list of all lock classes. The list only grows,
259 * never shrinks. The list is only accessed with the lockdep
260 * spinlock lock held.
262 LIST_HEAD(all_lock_classes);
265 * The lockdep classes are in a hash-table as well, for fast lookup:
267 #define CLASSHASH_BITS (MAX_LOCKDEP_KEYS_BITS - 1)
268 #define CLASSHASH_SIZE (1UL << CLASSHASH_BITS)
269 #define __classhashfn(key) hash_long((unsigned long)key, CLASSHASH_BITS)
270 #define classhashentry(key) (classhash_table + __classhashfn((key)))
272 static struct list_head classhash_table[CLASSHASH_SIZE];
275 * We put the lock dependency chains into a hash-table as well, to cache
278 #define CHAINHASH_BITS (MAX_LOCKDEP_CHAINS_BITS-1)
279 #define CHAINHASH_SIZE (1UL << CHAINHASH_BITS)
280 #define __chainhashfn(chain) hash_long(chain, CHAINHASH_BITS)
281 #define chainhashentry(chain) (chainhash_table + __chainhashfn((chain)))
283 static struct list_head chainhash_table[CHAINHASH_SIZE];
286 * The hash key of the lock dependency chains is a hash itself too:
287 * it's a hash of all locks taken up to that lock, including that lock.
288 * It's a 64-bit hash, because it's important for the keys to be
291 #define iterate_chain_key(key1, key2) \
292 (((key1) << MAX_LOCKDEP_KEYS_BITS) ^ \
293 ((key1) >> (64-MAX_LOCKDEP_KEYS_BITS)) ^ \
296 void lockdep_off(void)
298 current->lockdep_recursion++;
300 EXPORT_SYMBOL(lockdep_off);
302 void lockdep_on(void)
304 current->lockdep_recursion--;
306 EXPORT_SYMBOL(lockdep_on);
309 * Debugging switches:
313 #define VERY_VERBOSE 0
316 # define HARDIRQ_VERBOSE 1
317 # define SOFTIRQ_VERBOSE 1
318 # define RECLAIM_VERBOSE 1
320 # define HARDIRQ_VERBOSE 0
321 # define SOFTIRQ_VERBOSE 0
322 # define RECLAIM_VERBOSE 0
325 #if VERBOSE || HARDIRQ_VERBOSE || SOFTIRQ_VERBOSE || RECLAIM_VERBOSE
327 * Quick filtering for interesting events:
329 static int class_filter(struct lock_class *class)
333 if (class->name_version == 1 &&
334 !strcmp(class->name, "lockname"))
336 if (class->name_version == 1 &&
337 !strcmp(class->name, "&struct->lockfield"))
340 /* Filter everything else. 1 would be to allow everything else */
345 static int verbose(struct lock_class *class)
348 return class_filter(class);
354 * Stack-trace: tightly packed array of stack backtrace
355 * addresses. Protected by the graph_lock.
357 unsigned long nr_stack_trace_entries;
358 static unsigned long stack_trace[MAX_STACK_TRACE_ENTRIES];
360 static int save_trace(struct stack_trace *trace)
362 trace->nr_entries = 0;
363 trace->max_entries = MAX_STACK_TRACE_ENTRIES - nr_stack_trace_entries;
364 trace->entries = stack_trace + nr_stack_trace_entries;
368 save_stack_trace(trace);
371 * Some daft arches put -1 at the end to indicate its a full trace.
373 * <rant> this is buggy anyway, since it takes a whole extra entry so a
374 * complete trace that maxes out the entries provided will be reported
375 * as incomplete, friggin useless </rant>
377 if (trace->entries[trace->nr_entries-1] == ULONG_MAX)
380 trace->max_entries = trace->nr_entries;
382 nr_stack_trace_entries += trace->nr_entries;
384 if (nr_stack_trace_entries >= MAX_STACK_TRACE_ENTRIES-1) {
385 if (!debug_locks_off_graph_unlock())
388 printk("BUG: MAX_STACK_TRACE_ENTRIES too low!\n");
389 printk("turning off the locking correctness validator.\n");
398 unsigned int nr_hardirq_chains;
399 unsigned int nr_softirq_chains;
400 unsigned int nr_process_chains;
401 unsigned int max_lockdep_depth;
403 #ifdef CONFIG_DEBUG_LOCKDEP
405 * We cannot printk in early bootup code. Not even early_printk()
406 * might work. So we mark any initialization errors and printk
407 * about it later on, in lockdep_info().
409 static int lockdep_init_error;
410 static unsigned long lockdep_init_trace_data[20];
411 static struct stack_trace lockdep_init_trace = {
412 .max_entries = ARRAY_SIZE(lockdep_init_trace_data),
413 .entries = lockdep_init_trace_data,
417 * Various lockdep statistics:
419 atomic_t chain_lookup_hits;
420 atomic_t chain_lookup_misses;
421 atomic_t hardirqs_on_events;
422 atomic_t hardirqs_off_events;
423 atomic_t redundant_hardirqs_on;
424 atomic_t redundant_hardirqs_off;
425 atomic_t softirqs_on_events;
426 atomic_t softirqs_off_events;
427 atomic_t redundant_softirqs_on;
428 atomic_t redundant_softirqs_off;
429 atomic_t nr_unused_locks;
430 atomic_t nr_cyclic_checks;
431 atomic_t nr_find_usage_forwards_checks;
432 atomic_t nr_find_usage_backwards_checks;
439 #define __USAGE(__STATE) \
440 [LOCK_USED_IN_##__STATE] = "IN-"__stringify(__STATE)"-W", \
441 [LOCK_ENABLED_##__STATE] = __stringify(__STATE)"-ON-W", \
442 [LOCK_USED_IN_##__STATE##_READ] = "IN-"__stringify(__STATE)"-R",\
443 [LOCK_ENABLED_##__STATE##_READ] = __stringify(__STATE)"-ON-R",
445 static const char *usage_str[] =
447 #define LOCKDEP_STATE(__STATE) __USAGE(__STATE)
448 #include "lockdep_states.h"
450 [LOCK_USED] = "INITIAL USE",
453 const char * __get_key_name(struct lockdep_subclass_key *key, char *str)
455 return kallsyms_lookup((unsigned long)key, NULL, NULL, NULL, str);
458 static inline unsigned long lock_flag(enum lock_usage_bit bit)
463 static char get_usage_char(struct lock_class *class, enum lock_usage_bit bit)
467 if (class->usage_mask & lock_flag(bit + 2))
469 if (class->usage_mask & lock_flag(bit)) {
471 if (class->usage_mask & lock_flag(bit + 2))
478 void get_usage_chars(struct lock_class *class, char usage[LOCK_USAGE_CHARS])
482 #define LOCKDEP_STATE(__STATE) \
483 usage[i++] = get_usage_char(class, LOCK_USED_IN_##__STATE); \
484 usage[i++] = get_usage_char(class, LOCK_USED_IN_##__STATE##_READ);
485 #include "lockdep_states.h"
491 static void print_lock_name(struct lock_class *class)
493 char str[KSYM_NAME_LEN], usage[LOCK_USAGE_CHARS];
496 get_usage_chars(class, usage);
500 name = __get_key_name(class->key, str);
501 printk(" (%s", name);
503 printk(" (%s", name);
504 if (class->name_version > 1)
505 printk("#%d", class->name_version);
507 printk("/%d", class->subclass);
509 printk("){%s}", usage);
512 static void print_lockdep_cache(struct lockdep_map *lock)
515 char str[KSYM_NAME_LEN];
519 name = __get_key_name(lock->key->subkeys, str);
524 static void print_lock(struct held_lock *hlock)
526 print_lock_name(hlock_class(hlock));
528 print_ip_sym(hlock->acquire_ip);
531 static void lockdep_print_held_locks(struct task_struct *curr)
533 int i, depth = curr->lockdep_depth;
536 printk("no locks held by %s/%d.\n", curr->comm, task_pid_nr(curr));
539 printk("%d lock%s held by %s/%d:\n",
540 depth, depth > 1 ? "s" : "", curr->comm, task_pid_nr(curr));
542 for (i = 0; i < depth; i++) {
544 print_lock(curr->held_locks + i);
548 static void print_kernel_version(void)
550 printk("%s %.*s\n", init_utsname()->release,
551 (int)strcspn(init_utsname()->version, " "),
552 init_utsname()->version);
555 static int very_verbose(struct lock_class *class)
558 return class_filter(class);
564 * Is this the address of a static object:
566 static int static_obj(void *obj)
568 unsigned long start = (unsigned long) &_stext,
569 end = (unsigned long) &_end,
570 addr = (unsigned long) obj;
578 if ((addr >= start) && (addr < end))
581 if (arch_is_kernel_data(addr))
588 for_each_possible_cpu(i) {
589 start = (unsigned long) &__per_cpu_start + per_cpu_offset(i);
590 end = (unsigned long) &__per_cpu_start + PERCPU_ENOUGH_ROOM
593 if ((addr >= start) && (addr < end))
601 return is_module_address(addr);
605 * To make lock name printouts unique, we calculate a unique
606 * class->name_version generation counter:
608 static int count_matching_names(struct lock_class *new_class)
610 struct lock_class *class;
613 if (!new_class->name)
616 list_for_each_entry(class, &all_lock_classes, lock_entry) {
617 if (new_class->key - new_class->subclass == class->key)
618 return class->name_version;
619 if (class->name && !strcmp(class->name, new_class->name))
620 count = max(count, class->name_version);
627 * Register a lock's class in the hash-table, if the class is not present
628 * yet. Otherwise we look it up. We cache the result in the lock object
629 * itself, so actual lookup of the hash should be once per lock object.
631 static inline struct lock_class *
632 look_up_lock_class(struct lockdep_map *lock, unsigned int subclass)
634 struct lockdep_subclass_key *key;
635 struct list_head *hash_head;
636 struct lock_class *class;
638 #ifdef CONFIG_DEBUG_LOCKDEP
640 * If the architecture calls into lockdep before initializing
641 * the hashes then we'll warn about it later. (we cannot printk
644 if (unlikely(!lockdep_initialized)) {
646 lockdep_init_error = 1;
647 save_stack_trace(&lockdep_init_trace);
652 * Static locks do not have their class-keys yet - for them the key
653 * is the lock object itself:
655 if (unlikely(!lock->key))
656 lock->key = (void *)lock;
659 * NOTE: the class-key must be unique. For dynamic locks, a static
660 * lock_class_key variable is passed in through the mutex_init()
661 * (or spin_lock_init()) call - which acts as the key. For static
662 * locks we use the lock object itself as the key.
664 BUILD_BUG_ON(sizeof(struct lock_class_key) >
665 sizeof(struct lockdep_map));
667 key = lock->key->subkeys + subclass;
669 hash_head = classhashentry(key);
672 * We can walk the hash lockfree, because the hash only
673 * grows, and we are careful when adding entries to the end:
675 list_for_each_entry(class, hash_head, hash_entry) {
676 if (class->key == key) {
677 WARN_ON_ONCE(class->name != lock->name);
686 * Register a lock's class in the hash-table, if the class is not present
687 * yet. Otherwise we look it up. We cache the result in the lock object
688 * itself, so actual lookup of the hash should be once per lock object.
690 static inline struct lock_class *
691 register_lock_class(struct lockdep_map *lock, unsigned int subclass, int force)
693 struct lockdep_subclass_key *key;
694 struct list_head *hash_head;
695 struct lock_class *class;
698 class = look_up_lock_class(lock, subclass);
703 * Debug-check: all keys must be persistent!
705 if (!static_obj(lock->key)) {
707 printk("INFO: trying to register non-static key.\n");
708 printk("the code is fine but needs lockdep annotation.\n");
709 printk("turning off the locking correctness validator.\n");
715 key = lock->key->subkeys + subclass;
716 hash_head = classhashentry(key);
718 raw_local_irq_save(flags);
720 raw_local_irq_restore(flags);
724 * We have to do the hash-walk again, to avoid races
727 list_for_each_entry(class, hash_head, hash_entry)
728 if (class->key == key)
731 * Allocate a new key from the static array, and add it to
734 if (nr_lock_classes >= MAX_LOCKDEP_KEYS) {
735 if (!debug_locks_off_graph_unlock()) {
736 raw_local_irq_restore(flags);
739 raw_local_irq_restore(flags);
741 printk("BUG: MAX_LOCKDEP_KEYS too low!\n");
742 printk("turning off the locking correctness validator.\n");
746 class = lock_classes + nr_lock_classes++;
747 debug_atomic_inc(&nr_unused_locks);
749 class->name = lock->name;
750 class->subclass = subclass;
751 INIT_LIST_HEAD(&class->lock_entry);
752 INIT_LIST_HEAD(&class->locks_before);
753 INIT_LIST_HEAD(&class->locks_after);
754 class->name_version = count_matching_names(class);
756 * We use RCU's safe list-add method to make
757 * parallel walking of the hash-list safe:
759 list_add_tail_rcu(&class->hash_entry, hash_head);
761 * Add it to the global list of classes:
763 list_add_tail_rcu(&class->lock_entry, &all_lock_classes);
765 if (verbose(class)) {
767 raw_local_irq_restore(flags);
769 printk("\nnew class %p: %s", class->key, class->name);
770 if (class->name_version > 1)
771 printk("#%d", class->name_version);
775 raw_local_irq_save(flags);
777 raw_local_irq_restore(flags);
783 raw_local_irq_restore(flags);
785 if (!subclass || force)
786 lock->class_cache = class;
788 if (DEBUG_LOCKS_WARN_ON(class->subclass != subclass))
794 #ifdef CONFIG_PROVE_LOCKING
796 * Allocate a lockdep entry. (assumes the graph_lock held, returns
797 * with NULL on failure)
799 static struct lock_list *alloc_list_entry(void)
801 if (nr_list_entries >= MAX_LOCKDEP_ENTRIES) {
802 if (!debug_locks_off_graph_unlock())
805 printk("BUG: MAX_LOCKDEP_ENTRIES too low!\n");
806 printk("turning off the locking correctness validator.\n");
810 return list_entries + nr_list_entries++;
814 * Add a new dependency to the head of the list:
816 static int add_lock_to_list(struct lock_class *class, struct lock_class *this,
817 struct list_head *head, unsigned long ip, int distance)
819 struct lock_list *entry;
821 * Lock not present yet - get a new dependency struct and
822 * add it to the list:
824 entry = alloc_list_entry();
828 if (!save_trace(&entry->trace))
832 entry->distance = distance;
834 * Since we never remove from the dependency list, the list can
835 * be walked lockless by other CPUs, it's only allocation
836 * that must be protected by the spinlock. But this also means
837 * we must make new entries visible only once writes to the
838 * entry become visible - hence the RCU op:
840 list_add_tail_rcu(&entry->entry, head);
846 * For good efficiency of modular, we use power of 2
848 #define MAX_CIRCULAR_QUEUE_SIZE 4096UL
849 #define CQ_MASK (MAX_CIRCULAR_QUEUE_SIZE-1)
852 * The circular_queue and helpers is used to implement the
853 * breadth-first search(BFS)algorithem, by which we can build
854 * the shortest path from the next lock to be acquired to the
855 * previous held lock if there is a circular between them.
857 struct circular_queue {
858 unsigned long element[MAX_CIRCULAR_QUEUE_SIZE];
859 unsigned int front, rear;
862 static struct circular_queue lock_cq;
864 unsigned int max_bfs_queue_depth;
866 static unsigned int lockdep_dependency_gen_id;
868 static inline void __cq_init(struct circular_queue *cq)
870 cq->front = cq->rear = 0;
871 lockdep_dependency_gen_id++;
874 static inline int __cq_empty(struct circular_queue *cq)
876 return (cq->front == cq->rear);
879 static inline int __cq_full(struct circular_queue *cq)
881 return ((cq->rear + 1) & CQ_MASK) == cq->front;
884 static inline int __cq_enqueue(struct circular_queue *cq, unsigned long elem)
889 cq->element[cq->rear] = elem;
890 cq->rear = (cq->rear + 1) & CQ_MASK;
894 static inline int __cq_dequeue(struct circular_queue *cq, unsigned long *elem)
899 *elem = cq->element[cq->front];
900 cq->front = (cq->front + 1) & CQ_MASK;
904 static inline unsigned int __cq_get_elem_count(struct circular_queue *cq)
906 return (cq->rear - cq->front) & CQ_MASK;
909 static inline void mark_lock_accessed(struct lock_list *lock,
910 struct lock_list *parent)
914 nr = lock - list_entries;
915 WARN_ON(nr >= nr_list_entries);
916 lock->parent = parent;
917 lock->class->dep_gen_id = lockdep_dependency_gen_id;
920 static inline unsigned long lock_accessed(struct lock_list *lock)
924 nr = lock - list_entries;
925 WARN_ON(nr >= nr_list_entries);
926 return lock->class->dep_gen_id == lockdep_dependency_gen_id;
929 static inline struct lock_list *get_lock_parent(struct lock_list *child)
931 return child->parent;
934 static inline int get_lock_depth(struct lock_list *child)
937 struct lock_list *parent;
939 while ((parent = get_lock_parent(child))) {
946 static int __bfs(struct lock_list *source_entry,
948 int (*match)(struct lock_list *entry, void *data),
949 struct lock_list **target_entry,
952 struct lock_list *entry;
953 struct list_head *head;
954 struct circular_queue *cq = &lock_cq;
957 if (match(source_entry, data)) {
958 *target_entry = source_entry;
964 head = &source_entry->class->locks_after;
966 head = &source_entry->class->locks_before;
968 if (list_empty(head))
972 __cq_enqueue(cq, (unsigned long)source_entry);
974 while (!__cq_empty(cq)) {
975 struct lock_list *lock;
977 __cq_dequeue(cq, (unsigned long *)&lock);
985 head = &lock->class->locks_after;
987 head = &lock->class->locks_before;
989 list_for_each_entry(entry, head, entry) {
990 if (!lock_accessed(entry)) {
991 unsigned int cq_depth;
992 mark_lock_accessed(entry, lock);
993 if (match(entry, data)) {
994 *target_entry = entry;
999 if (__cq_enqueue(cq, (unsigned long)entry)) {
1003 cq_depth = __cq_get_elem_count(cq);
1004 if (max_bfs_queue_depth < cq_depth)
1005 max_bfs_queue_depth = cq_depth;
1013 static inline int __bfs_forwards(struct lock_list *src_entry,
1015 int (*match)(struct lock_list *entry, void *data),
1016 struct lock_list **target_entry)
1018 return __bfs(src_entry, data, match, target_entry, 1);
1022 static inline int __bfs_backwards(struct lock_list *src_entry,
1024 int (*match)(struct lock_list *entry, void *data),
1025 struct lock_list **target_entry)
1027 return __bfs(src_entry, data, match, target_entry, 0);
1032 * Recursive, forwards-direction lock-dependency checking, used for
1033 * both noncyclic checking and for hardirq-unsafe/softirq-unsafe
1038 * Print a dependency chain entry (this is only done when a deadlock
1039 * has been detected):
1042 print_circular_bug_entry(struct lock_list *target, int depth)
1044 if (debug_locks_silent)
1046 printk("\n-> #%u", depth);
1047 print_lock_name(target->class);
1049 print_stack_trace(&target->trace, 6);
1055 * When a circular dependency is detected, print the
1059 print_circular_bug_header(struct lock_list *entry, unsigned int depth,
1060 struct held_lock *check_src,
1061 struct held_lock *check_tgt)
1063 struct task_struct *curr = current;
1065 if (debug_locks_silent)
1068 printk("\n=======================================================\n");
1069 printk( "[ INFO: possible circular locking dependency detected ]\n");
1070 print_kernel_version();
1071 printk( "-------------------------------------------------------\n");
1072 printk("%s/%d is trying to acquire lock:\n",
1073 curr->comm, task_pid_nr(curr));
1074 print_lock(check_src);
1075 printk("\nbut task is already holding lock:\n");
1076 print_lock(check_tgt);
1077 printk("\nwhich lock already depends on the new lock.\n\n");
1078 printk("\nthe existing dependency chain (in reverse order) is:\n");
1080 print_circular_bug_entry(entry, depth);
1085 static inline int class_equal(struct lock_list *entry, void *data)
1087 return entry->class == data;
1090 static noinline int print_circular_bug(struct lock_list *this,
1091 struct lock_list *target,
1092 struct held_lock *check_src,
1093 struct held_lock *check_tgt)
1095 struct task_struct *curr = current;
1096 struct lock_list *parent;
1099 if (!debug_locks_off_graph_unlock() || debug_locks_silent)
1102 if (!save_trace(&this->trace))
1105 depth = get_lock_depth(target);
1107 print_circular_bug_header(target, depth, check_src, check_tgt);
1109 parent = get_lock_parent(target);
1112 print_circular_bug_entry(parent, --depth);
1113 parent = get_lock_parent(parent);
1116 printk("\nother info that might help us debug this:\n\n");
1117 lockdep_print_held_locks(curr);
1119 printk("\nstack backtrace:\n");
1125 static noinline int print_bfs_bug(int ret)
1127 if (!debug_locks_off_graph_unlock())
1130 WARN(1, "lockdep bfs error:%d\n", ret);
1135 static int noop_count(struct lock_list *entry, void *data)
1137 (*(unsigned long *)data)++;
1141 unsigned long __lockdep_count_forward_deps(struct lock_list *this)
1143 unsigned long count = 0;
1144 struct lock_list *uninitialized_var(target_entry);
1146 __bfs_forwards(this, (void *)&count, noop_count, &target_entry);
1150 unsigned long lockdep_count_forward_deps(struct lock_class *class)
1152 unsigned long ret, flags;
1153 struct lock_list this;
1158 local_irq_save(flags);
1159 __raw_spin_lock(&lockdep_lock);
1160 ret = __lockdep_count_forward_deps(&this);
1161 __raw_spin_unlock(&lockdep_lock);
1162 local_irq_restore(flags);
1167 unsigned long __lockdep_count_backward_deps(struct lock_list *this)
1169 unsigned long count = 0;
1170 struct lock_list *uninitialized_var(target_entry);
1172 __bfs_backwards(this, (void *)&count, noop_count, &target_entry);
1177 unsigned long lockdep_count_backward_deps(struct lock_class *class)
1179 unsigned long ret, flags;
1180 struct lock_list this;
1185 local_irq_save(flags);
1186 __raw_spin_lock(&lockdep_lock);
1187 ret = __lockdep_count_backward_deps(&this);
1188 __raw_spin_unlock(&lockdep_lock);
1189 local_irq_restore(flags);
1195 * Prove that the dependency graph starting at <entry> can not
1196 * lead to <target>. Print an error and return 0 if it does.
1199 check_noncircular(struct lock_list *root, struct lock_class *target,
1200 struct lock_list **target_entry)
1204 debug_atomic_inc(&nr_cyclic_checks);
1206 result = __bfs_forwards(root, target, class_equal, target_entry);
1211 #if defined(CONFIG_TRACE_IRQFLAGS) && defined(CONFIG_PROVE_LOCKING)
1213 * Forwards and backwards subgraph searching, for the purposes of
1214 * proving that two subgraphs can be connected by a new dependency
1215 * without creating any illegal irq-safe -> irq-unsafe lock dependency.
1218 static inline int usage_match(struct lock_list *entry, void *bit)
1220 return entry->class->usage_mask & (1 << (enum lock_usage_bit)bit);
1226 * Find a node in the forwards-direction dependency sub-graph starting
1227 * at @root->class that matches @bit.
1229 * Return 0 if such a node exists in the subgraph, and put that node
1230 * into *@target_entry.
1232 * Return 1 otherwise and keep *@target_entry unchanged.
1233 * Return <0 on error.
1236 find_usage_forwards(struct lock_list *root, enum lock_usage_bit bit,
1237 struct lock_list **target_entry)
1241 debug_atomic_inc(&nr_find_usage_forwards_checks);
1243 result = __bfs_forwards(root, (void *)bit, usage_match, target_entry);
1249 * Find a node in the backwards-direction dependency sub-graph starting
1250 * at @root->class that matches @bit.
1252 * Return 0 if such a node exists in the subgraph, and put that node
1253 * into *@target_entry.
1255 * Return 1 otherwise and keep *@target_entry unchanged.
1256 * Return <0 on error.
1259 find_usage_backwards(struct lock_list *root, enum lock_usage_bit bit,
1260 struct lock_list **target_entry)
1264 debug_atomic_inc(&nr_find_usage_backwards_checks);
1266 result = __bfs_backwards(root, (void *)bit, usage_match, target_entry);
1271 static void print_lock_class_header(struct lock_class *class, int depth)
1275 printk("%*s->", depth, "");
1276 print_lock_name(class);
1277 printk(" ops: %lu", class->ops);
1280 for (bit = 0; bit < LOCK_USAGE_STATES; bit++) {
1281 if (class->usage_mask & (1 << bit)) {
1284 len += printk("%*s %s", depth, "", usage_str[bit]);
1285 len += printk(" at:\n");
1286 print_stack_trace(class->usage_traces + bit, len);
1289 printk("%*s }\n", depth, "");
1291 printk("%*s ... key at: ",depth,"");
1292 print_ip_sym((unsigned long)class->key);
1296 * printk the shortest lock dependencies from @start to @end in reverse order:
1299 print_shortest_lock_dependencies(struct lock_list *leaf,
1300 struct lock_list *root)
1302 struct lock_list *entry = leaf;
1305 /*compute depth from generated tree by BFS*/
1306 depth = get_lock_depth(leaf);
1309 print_lock_class_header(entry->class, depth);
1310 printk("%*s ... acquired at:\n", depth, "");
1311 print_stack_trace(&entry->trace, 2);
1314 if (depth == 0 && (entry != root)) {
1315 printk("lockdep:%s bad BFS generated tree\n", __func__);
1319 entry = get_lock_parent(entry);
1321 } while (entry && (depth >= 0));
1327 print_bad_irq_dependency(struct task_struct *curr,
1328 struct lock_list *prev_root,
1329 struct lock_list *next_root,
1330 struct lock_list *backwards_entry,
1331 struct lock_list *forwards_entry,
1332 struct held_lock *prev,
1333 struct held_lock *next,
1334 enum lock_usage_bit bit1,
1335 enum lock_usage_bit bit2,
1336 const char *irqclass)
1338 if (!debug_locks_off_graph_unlock() || debug_locks_silent)
1341 printk("\n======================================================\n");
1342 printk( "[ INFO: %s-safe -> %s-unsafe lock order detected ]\n",
1343 irqclass, irqclass);
1344 print_kernel_version();
1345 printk( "------------------------------------------------------\n");
1346 printk("%s/%d [HC%u[%lu]:SC%u[%lu]:HE%u:SE%u] is trying to acquire:\n",
1347 curr->comm, task_pid_nr(curr),
1348 curr->hardirq_context, hardirq_count() >> HARDIRQ_SHIFT,
1349 curr->softirq_context, softirq_count() >> SOFTIRQ_SHIFT,
1350 curr->hardirqs_enabled,
1351 curr->softirqs_enabled);
1354 printk("\nand this task is already holding:\n");
1356 printk("which would create a new lock dependency:\n");
1357 print_lock_name(hlock_class(prev));
1359 print_lock_name(hlock_class(next));
1362 printk("\nbut this new dependency connects a %s-irq-safe lock:\n",
1364 print_lock_name(backwards_entry->class);
1365 printk("\n... which became %s-irq-safe at:\n", irqclass);
1367 print_stack_trace(backwards_entry->class->usage_traces + bit1, 1);
1369 printk("\nto a %s-irq-unsafe lock:\n", irqclass);
1370 print_lock_name(forwards_entry->class);
1371 printk("\n... which became %s-irq-unsafe at:\n", irqclass);
1374 print_stack_trace(forwards_entry->class->usage_traces + bit2, 1);
1376 printk("\nother info that might help us debug this:\n\n");
1377 lockdep_print_held_locks(curr);
1379 printk("\nthe dependencies between %s-irq-safe lock", irqclass);
1380 printk(" and the holding lock:\n");
1381 if (!save_trace(&prev_root->trace))
1383 print_shortest_lock_dependencies(backwards_entry, prev_root);
1385 printk("\nthe dependencies between the lock to be acquired");
1386 printk(" and %s-irq-unsafe lock:\n", irqclass);
1387 if (!save_trace(&next_root->trace))
1389 print_shortest_lock_dependencies(forwards_entry, next_root);
1391 printk("\nstack backtrace:\n");
1398 check_usage(struct task_struct *curr, struct held_lock *prev,
1399 struct held_lock *next, enum lock_usage_bit bit_backwards,
1400 enum lock_usage_bit bit_forwards, const char *irqclass)
1403 struct lock_list this, that;
1404 struct lock_list *uninitialized_var(target_entry);
1405 struct lock_list *uninitialized_var(target_entry1);
1409 this.class = hlock_class(prev);
1410 ret = find_usage_backwards(&this, bit_backwards, &target_entry);
1412 return print_bfs_bug(ret);
1417 that.class = hlock_class(next);
1418 ret = find_usage_forwards(&that, bit_forwards, &target_entry1);
1420 return print_bfs_bug(ret);
1424 return print_bad_irq_dependency(curr, &this, &that,
1425 target_entry, target_entry1,
1427 bit_backwards, bit_forwards, irqclass);
1430 static const char *state_names[] = {
1431 #define LOCKDEP_STATE(__STATE) \
1432 __stringify(__STATE),
1433 #include "lockdep_states.h"
1434 #undef LOCKDEP_STATE
1437 static const char *state_rnames[] = {
1438 #define LOCKDEP_STATE(__STATE) \
1439 __stringify(__STATE)"-READ",
1440 #include "lockdep_states.h"
1441 #undef LOCKDEP_STATE
1444 static inline const char *state_name(enum lock_usage_bit bit)
1446 return (bit & 1) ? state_rnames[bit >> 2] : state_names[bit >> 2];
1449 static int exclusive_bit(int new_bit)
1457 * bit 0 - write/read
1458 * bit 1 - used_in/enabled
1462 int state = new_bit & ~3;
1463 int dir = new_bit & 2;
1466 * keep state, bit flip the direction and strip read.
1468 return state | (dir ^ 2);
1471 static int check_irq_usage(struct task_struct *curr, struct held_lock *prev,
1472 struct held_lock *next, enum lock_usage_bit bit)
1475 * Prove that the new dependency does not connect a hardirq-safe
1476 * lock with a hardirq-unsafe lock - to achieve this we search
1477 * the backwards-subgraph starting at <prev>, and the
1478 * forwards-subgraph starting at <next>:
1480 if (!check_usage(curr, prev, next, bit,
1481 exclusive_bit(bit), state_name(bit)))
1487 * Prove that the new dependency does not connect a hardirq-safe-read
1488 * lock with a hardirq-unsafe lock - to achieve this we search
1489 * the backwards-subgraph starting at <prev>, and the
1490 * forwards-subgraph starting at <next>:
1492 if (!check_usage(curr, prev, next, bit,
1493 exclusive_bit(bit), state_name(bit)))
1500 check_prev_add_irq(struct task_struct *curr, struct held_lock *prev,
1501 struct held_lock *next)
1503 #define LOCKDEP_STATE(__STATE) \
1504 if (!check_irq_usage(curr, prev, next, LOCK_USED_IN_##__STATE)) \
1506 #include "lockdep_states.h"
1507 #undef LOCKDEP_STATE
1512 static void inc_chains(void)
1514 if (current->hardirq_context)
1515 nr_hardirq_chains++;
1517 if (current->softirq_context)
1518 nr_softirq_chains++;
1520 nr_process_chains++;
1527 check_prev_add_irq(struct task_struct *curr, struct held_lock *prev,
1528 struct held_lock *next)
1533 static inline void inc_chains(void)
1535 nr_process_chains++;
1541 print_deadlock_bug(struct task_struct *curr, struct held_lock *prev,
1542 struct held_lock *next)
1544 if (!debug_locks_off_graph_unlock() || debug_locks_silent)
1547 printk("\n=============================================\n");
1548 printk( "[ INFO: possible recursive locking detected ]\n");
1549 print_kernel_version();
1550 printk( "---------------------------------------------\n");
1551 printk("%s/%d is trying to acquire lock:\n",
1552 curr->comm, task_pid_nr(curr));
1554 printk("\nbut task is already holding lock:\n");
1557 printk("\nother info that might help us debug this:\n");
1558 lockdep_print_held_locks(curr);
1560 printk("\nstack backtrace:\n");
1567 * Check whether we are holding such a class already.
1569 * (Note that this has to be done separately, because the graph cannot
1570 * detect such classes of deadlocks.)
1572 * Returns: 0 on deadlock detected, 1 on OK, 2 on recursive read
1575 check_deadlock(struct task_struct *curr, struct held_lock *next,
1576 struct lockdep_map *next_instance, int read)
1578 struct held_lock *prev;
1579 struct held_lock *nest = NULL;
1582 for (i = 0; i < curr->lockdep_depth; i++) {
1583 prev = curr->held_locks + i;
1585 if (prev->instance == next->nest_lock)
1588 if (hlock_class(prev) != hlock_class(next))
1592 * Allow read-after-read recursion of the same
1593 * lock class (i.e. read_lock(lock)+read_lock(lock)):
1595 if ((read == 2) && prev->read)
1599 * We're holding the nest_lock, which serializes this lock's
1600 * nesting behaviour.
1605 return print_deadlock_bug(curr, prev, next);
1611 * There was a chain-cache miss, and we are about to add a new dependency
1612 * to a previous lock. We recursively validate the following rules:
1614 * - would the adding of the <prev> -> <next> dependency create a
1615 * circular dependency in the graph? [== circular deadlock]
1617 * - does the new prev->next dependency connect any hardirq-safe lock
1618 * (in the full backwards-subgraph starting at <prev>) with any
1619 * hardirq-unsafe lock (in the full forwards-subgraph starting at
1620 * <next>)? [== illegal lock inversion with hardirq contexts]
1622 * - does the new prev->next dependency connect any softirq-safe lock
1623 * (in the full backwards-subgraph starting at <prev>) with any
1624 * softirq-unsafe lock (in the full forwards-subgraph starting at
1625 * <next>)? [== illegal lock inversion with softirq contexts]
1627 * any of these scenarios could lead to a deadlock.
1629 * Then if all the validations pass, we add the forwards and backwards
1633 check_prev_add(struct task_struct *curr, struct held_lock *prev,
1634 struct held_lock *next, int distance)
1636 struct lock_list *entry;
1638 struct lock_list this;
1639 struct lock_list *uninitialized_var(target_entry);
1642 * Prove that the new <prev> -> <next> dependency would not
1643 * create a circular dependency in the graph. (We do this by
1644 * forward-recursing into the graph starting at <next>, and
1645 * checking whether we can reach <prev>.)
1647 * We are using global variables to control the recursion, to
1648 * keep the stackframe size of the recursive functions low:
1650 this.class = hlock_class(next);
1652 ret = check_noncircular(&this, hlock_class(prev), &target_entry);
1654 return print_circular_bug(&this, target_entry, next, prev);
1655 else if (unlikely(ret < 0))
1656 return print_bfs_bug(ret);
1658 if (!check_prev_add_irq(curr, prev, next))
1662 * For recursive read-locks we do all the dependency checks,
1663 * but we dont store read-triggered dependencies (only
1664 * write-triggered dependencies). This ensures that only the
1665 * write-side dependencies matter, and that if for example a
1666 * write-lock never takes any other locks, then the reads are
1667 * equivalent to a NOP.
1669 if (next->read == 2 || prev->read == 2)
1672 * Is the <prev> -> <next> dependency already present?
1674 * (this may occur even though this is a new chain: consider
1675 * e.g. the L1 -> L2 -> L3 -> L4 and the L5 -> L1 -> L2 -> L3
1676 * chains - the second one will be new, but L1 already has
1677 * L2 added to its dependency list, due to the first chain.)
1679 list_for_each_entry(entry, &hlock_class(prev)->locks_after, entry) {
1680 if (entry->class == hlock_class(next)) {
1682 entry->distance = 1;
1688 * Ok, all validations passed, add the new lock
1689 * to the previous lock's dependency list:
1691 ret = add_lock_to_list(hlock_class(prev), hlock_class(next),
1692 &hlock_class(prev)->locks_after,
1693 next->acquire_ip, distance);
1698 ret = add_lock_to_list(hlock_class(next), hlock_class(prev),
1699 &hlock_class(next)->locks_before,
1700 next->acquire_ip, distance);
1705 * Debugging printouts:
1707 if (verbose(hlock_class(prev)) || verbose(hlock_class(next))) {
1709 printk("\n new dependency: ");
1710 print_lock_name(hlock_class(prev));
1712 print_lock_name(hlock_class(next));
1715 return graph_lock();
1721 * Add the dependency to all directly-previous locks that are 'relevant'.
1722 * The ones that are relevant are (in increasing distance from curr):
1723 * all consecutive trylock entries and the final non-trylock entry - or
1724 * the end of this context's lock-chain - whichever comes first.
1727 check_prevs_add(struct task_struct *curr, struct held_lock *next)
1729 int depth = curr->lockdep_depth;
1730 struct held_lock *hlock;
1735 * Depth must not be zero for a non-head lock:
1740 * At least two relevant locks must exist for this
1743 if (curr->held_locks[depth].irq_context !=
1744 curr->held_locks[depth-1].irq_context)
1748 int distance = curr->lockdep_depth - depth + 1;
1749 hlock = curr->held_locks + depth-1;
1751 * Only non-recursive-read entries get new dependencies
1754 if (hlock->read != 2) {
1755 if (!check_prev_add(curr, hlock, next, distance))
1758 * Stop after the first non-trylock entry,
1759 * as non-trylock entries have added their
1760 * own direct dependencies already, so this
1761 * lock is connected to them indirectly:
1763 if (!hlock->trylock)
1768 * End of lock-stack?
1773 * Stop the search if we cross into another context:
1775 if (curr->held_locks[depth].irq_context !=
1776 curr->held_locks[depth-1].irq_context)
1781 if (!debug_locks_off_graph_unlock())
1789 unsigned long nr_lock_chains;
1790 struct lock_chain lock_chains[MAX_LOCKDEP_CHAINS];
1791 int nr_chain_hlocks;
1792 static u16 chain_hlocks[MAX_LOCKDEP_CHAIN_HLOCKS];
1794 struct lock_class *lock_chain_get_class(struct lock_chain *chain, int i)
1796 return lock_classes + chain_hlocks[chain->base + i];
1800 * Look up a dependency chain. If the key is not present yet then
1801 * add it and return 1 - in this case the new dependency chain is
1802 * validated. If the key is already hashed, return 0.
1803 * (On return with 1 graph_lock is held.)
1805 static inline int lookup_chain_cache(struct task_struct *curr,
1806 struct held_lock *hlock,
1809 struct lock_class *class = hlock_class(hlock);
1810 struct list_head *hash_head = chainhashentry(chain_key);
1811 struct lock_chain *chain;
1812 struct held_lock *hlock_curr, *hlock_next;
1815 if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
1818 * We can walk it lock-free, because entries only get added
1821 list_for_each_entry(chain, hash_head, entry) {
1822 if (chain->chain_key == chain_key) {
1824 debug_atomic_inc(&chain_lookup_hits);
1825 if (very_verbose(class))
1826 printk("\nhash chain already cached, key: "
1827 "%016Lx tail class: [%p] %s\n",
1828 (unsigned long long)chain_key,
1829 class->key, class->name);
1833 if (very_verbose(class))
1834 printk("\nnew hash chain, key: %016Lx tail class: [%p] %s\n",
1835 (unsigned long long)chain_key, class->key, class->name);
1837 * Allocate a new chain entry from the static array, and add
1843 * We have to walk the chain again locked - to avoid duplicates:
1845 list_for_each_entry(chain, hash_head, entry) {
1846 if (chain->chain_key == chain_key) {
1851 if (unlikely(nr_lock_chains >= MAX_LOCKDEP_CHAINS)) {
1852 if (!debug_locks_off_graph_unlock())
1855 printk("BUG: MAX_LOCKDEP_CHAINS too low!\n");
1856 printk("turning off the locking correctness validator.\n");
1860 chain = lock_chains + nr_lock_chains++;
1861 chain->chain_key = chain_key;
1862 chain->irq_context = hlock->irq_context;
1863 /* Find the first held_lock of current chain */
1865 for (i = curr->lockdep_depth - 1; i >= 0; i--) {
1866 hlock_curr = curr->held_locks + i;
1867 if (hlock_curr->irq_context != hlock_next->irq_context)
1872 chain->depth = curr->lockdep_depth + 1 - i;
1873 cn = nr_chain_hlocks;
1874 while (cn + chain->depth <= MAX_LOCKDEP_CHAIN_HLOCKS) {
1875 n = cmpxchg(&nr_chain_hlocks, cn, cn + chain->depth);
1880 if (likely(cn + chain->depth <= MAX_LOCKDEP_CHAIN_HLOCKS)) {
1882 for (j = 0; j < chain->depth - 1; j++, i++) {
1883 int lock_id = curr->held_locks[i].class_idx - 1;
1884 chain_hlocks[chain->base + j] = lock_id;
1886 chain_hlocks[chain->base + j] = class - lock_classes;
1888 list_add_tail_rcu(&chain->entry, hash_head);
1889 debug_atomic_inc(&chain_lookup_misses);
1895 static int validate_chain(struct task_struct *curr, struct lockdep_map *lock,
1896 struct held_lock *hlock, int chain_head, u64 chain_key)
1899 * Trylock needs to maintain the stack of held locks, but it
1900 * does not add new dependencies, because trylock can be done
1903 * We look up the chain_key and do the O(N^2) check and update of
1904 * the dependencies only if this is a new dependency chain.
1905 * (If lookup_chain_cache() returns with 1 it acquires
1906 * graph_lock for us)
1908 if (!hlock->trylock && (hlock->check == 2) &&
1909 lookup_chain_cache(curr, hlock, chain_key)) {
1911 * Check whether last held lock:
1913 * - is irq-safe, if this lock is irq-unsafe
1914 * - is softirq-safe, if this lock is hardirq-unsafe
1916 * And check whether the new lock's dependency graph
1917 * could lead back to the previous lock.
1919 * any of these scenarios could lead to a deadlock. If
1922 int ret = check_deadlock(curr, hlock, lock, hlock->read);
1927 * Mark recursive read, as we jump over it when
1928 * building dependencies (just like we jump over
1934 * Add dependency only if this lock is not the head
1935 * of the chain, and if it's not a secondary read-lock:
1937 if (!chain_head && ret != 2)
1938 if (!check_prevs_add(curr, hlock))
1942 /* after lookup_chain_cache(): */
1943 if (unlikely(!debug_locks))
1949 static inline int validate_chain(struct task_struct *curr,
1950 struct lockdep_map *lock, struct held_lock *hlock,
1951 int chain_head, u64 chain_key)
1958 * We are building curr_chain_key incrementally, so double-check
1959 * it from scratch, to make sure that it's done correctly:
1961 static void check_chain_key(struct task_struct *curr)
1963 #ifdef CONFIG_DEBUG_LOCKDEP
1964 struct held_lock *hlock, *prev_hlock = NULL;
1968 for (i = 0; i < curr->lockdep_depth; i++) {
1969 hlock = curr->held_locks + i;
1970 if (chain_key != hlock->prev_chain_key) {
1972 WARN(1, "hm#1, depth: %u [%u], %016Lx != %016Lx\n",
1973 curr->lockdep_depth, i,
1974 (unsigned long long)chain_key,
1975 (unsigned long long)hlock->prev_chain_key);
1978 id = hlock->class_idx - 1;
1979 if (DEBUG_LOCKS_WARN_ON(id >= MAX_LOCKDEP_KEYS))
1982 if (prev_hlock && (prev_hlock->irq_context !=
1983 hlock->irq_context))
1985 chain_key = iterate_chain_key(chain_key, id);
1988 if (chain_key != curr->curr_chain_key) {
1990 WARN(1, "hm#2, depth: %u [%u], %016Lx != %016Lx\n",
1991 curr->lockdep_depth, i,
1992 (unsigned long long)chain_key,
1993 (unsigned long long)curr->curr_chain_key);
1999 print_usage_bug(struct task_struct *curr, struct held_lock *this,
2000 enum lock_usage_bit prev_bit, enum lock_usage_bit new_bit)
2002 if (!debug_locks_off_graph_unlock() || debug_locks_silent)
2005 printk("\n=================================\n");
2006 printk( "[ INFO: inconsistent lock state ]\n");
2007 print_kernel_version();
2008 printk( "---------------------------------\n");
2010 printk("inconsistent {%s} -> {%s} usage.\n",
2011 usage_str[prev_bit], usage_str[new_bit]);
2013 printk("%s/%d [HC%u[%lu]:SC%u[%lu]:HE%u:SE%u] takes:\n",
2014 curr->comm, task_pid_nr(curr),
2015 trace_hardirq_context(curr), hardirq_count() >> HARDIRQ_SHIFT,
2016 trace_softirq_context(curr), softirq_count() >> SOFTIRQ_SHIFT,
2017 trace_hardirqs_enabled(curr),
2018 trace_softirqs_enabled(curr));
2021 printk("{%s} state was registered at:\n", usage_str[prev_bit]);
2022 print_stack_trace(hlock_class(this)->usage_traces + prev_bit, 1);
2024 print_irqtrace_events(curr);
2025 printk("\nother info that might help us debug this:\n");
2026 lockdep_print_held_locks(curr);
2028 printk("\nstack backtrace:\n");
2035 * Print out an error if an invalid bit is set:
2038 valid_state(struct task_struct *curr, struct held_lock *this,
2039 enum lock_usage_bit new_bit, enum lock_usage_bit bad_bit)
2041 if (unlikely(hlock_class(this)->usage_mask & (1 << bad_bit)))
2042 return print_usage_bug(curr, this, bad_bit, new_bit);
2046 static int mark_lock(struct task_struct *curr, struct held_lock *this,
2047 enum lock_usage_bit new_bit);
2049 #if defined(CONFIG_TRACE_IRQFLAGS) && defined(CONFIG_PROVE_LOCKING)
2052 * print irq inversion bug:
2055 print_irq_inversion_bug(struct task_struct *curr,
2056 struct lock_list *root, struct lock_list *other,
2057 struct held_lock *this, int forwards,
2058 const char *irqclass)
2060 if (!debug_locks_off_graph_unlock() || debug_locks_silent)
2063 printk("\n=========================================================\n");
2064 printk( "[ INFO: possible irq lock inversion dependency detected ]\n");
2065 print_kernel_version();
2066 printk( "---------------------------------------------------------\n");
2067 printk("%s/%d just changed the state of lock:\n",
2068 curr->comm, task_pid_nr(curr));
2071 printk("but this lock took another, %s-unsafe lock in the past:\n", irqclass);
2073 printk("but this lock was taken by another, %s-safe lock in the past:\n", irqclass);
2074 print_lock_name(other->class);
2075 printk("\n\nand interrupts could create inverse lock ordering between them.\n\n");
2077 printk("\nother info that might help us debug this:\n");
2078 lockdep_print_held_locks(curr);
2080 printk("\nthe shortest dependencies between 2nd lock and 1st lock:\n");
2081 if (!save_trace(&root->trace))
2083 print_shortest_lock_dependencies(other, root);
2085 printk("\nstack backtrace:\n");
2092 * Prove that in the forwards-direction subgraph starting at <this>
2093 * there is no lock matching <mask>:
2096 check_usage_forwards(struct task_struct *curr, struct held_lock *this,
2097 enum lock_usage_bit bit, const char *irqclass)
2100 struct lock_list root;
2101 struct lock_list *uninitialized_var(target_entry);
2104 root.class = hlock_class(this);
2105 ret = find_usage_forwards(&root, bit, &target_entry);
2107 return print_bfs_bug(ret);
2111 return print_irq_inversion_bug(curr, &root, target_entry,
2116 * Prove that in the backwards-direction subgraph starting at <this>
2117 * there is no lock matching <mask>:
2120 check_usage_backwards(struct task_struct *curr, struct held_lock *this,
2121 enum lock_usage_bit bit, const char *irqclass)
2124 struct lock_list root;
2125 struct lock_list *uninitialized_var(target_entry);
2128 root.class = hlock_class(this);
2129 ret = find_usage_backwards(&root, bit, &target_entry);
2131 return print_bfs_bug(ret);
2135 return print_irq_inversion_bug(curr, &root, target_entry,
2139 void print_irqtrace_events(struct task_struct *curr)
2141 printk("irq event stamp: %u\n", curr->irq_events);
2142 printk("hardirqs last enabled at (%u): ", curr->hardirq_enable_event);
2143 print_ip_sym(curr->hardirq_enable_ip);
2144 printk("hardirqs last disabled at (%u): ", curr->hardirq_disable_event);
2145 print_ip_sym(curr->hardirq_disable_ip);
2146 printk("softirqs last enabled at (%u): ", curr->softirq_enable_event);
2147 print_ip_sym(curr->softirq_enable_ip);
2148 printk("softirqs last disabled at (%u): ", curr->softirq_disable_event);
2149 print_ip_sym(curr->softirq_disable_ip);
2152 static int HARDIRQ_verbose(struct lock_class *class)
2155 return class_filter(class);
2160 static int SOFTIRQ_verbose(struct lock_class *class)
2163 return class_filter(class);
2168 static int RECLAIM_FS_verbose(struct lock_class *class)
2171 return class_filter(class);
2176 #define STRICT_READ_CHECKS 1
2178 static int (*state_verbose_f[])(struct lock_class *class) = {
2179 #define LOCKDEP_STATE(__STATE) \
2181 #include "lockdep_states.h"
2182 #undef LOCKDEP_STATE
2185 static inline int state_verbose(enum lock_usage_bit bit,
2186 struct lock_class *class)
2188 return state_verbose_f[bit >> 2](class);
2191 typedef int (*check_usage_f)(struct task_struct *, struct held_lock *,
2192 enum lock_usage_bit bit, const char *name);
2195 mark_lock_irq(struct task_struct *curr, struct held_lock *this,
2196 enum lock_usage_bit new_bit)
2198 int excl_bit = exclusive_bit(new_bit);
2199 int read = new_bit & 1;
2200 int dir = new_bit & 2;
2203 * mark USED_IN has to look forwards -- to ensure no dependency
2204 * has ENABLED state, which would allow recursion deadlocks.
2206 * mark ENABLED has to look backwards -- to ensure no dependee
2207 * has USED_IN state, which, again, would allow recursion deadlocks.
2209 check_usage_f usage = dir ?
2210 check_usage_backwards : check_usage_forwards;
2213 * Validate that this particular lock does not have conflicting
2216 if (!valid_state(curr, this, new_bit, excl_bit))
2220 * Validate that the lock dependencies don't have conflicting usage
2223 if ((!read || !dir || STRICT_READ_CHECKS) &&
2224 !usage(curr, this, excl_bit, state_name(new_bit & ~1)))
2228 * Check for read in write conflicts
2231 if (!valid_state(curr, this, new_bit, excl_bit + 1))
2234 if (STRICT_READ_CHECKS &&
2235 !usage(curr, this, excl_bit + 1,
2236 state_name(new_bit + 1)))
2240 if (state_verbose(new_bit, hlock_class(this)))
2247 #define LOCKDEP_STATE(__STATE) __STATE,
2248 #include "lockdep_states.h"
2249 #undef LOCKDEP_STATE
2253 * Mark all held locks with a usage bit:
2256 mark_held_locks(struct task_struct *curr, enum mark_type mark)
2258 enum lock_usage_bit usage_bit;
2259 struct held_lock *hlock;
2262 for (i = 0; i < curr->lockdep_depth; i++) {
2263 hlock = curr->held_locks + i;
2265 usage_bit = 2 + (mark << 2); /* ENABLED */
2267 usage_bit += 1; /* READ */
2269 BUG_ON(usage_bit >= LOCK_USAGE_STATES);
2271 if (!mark_lock(curr, hlock, usage_bit))
2279 * Debugging helper: via this flag we know that we are in
2280 * 'early bootup code', and will warn about any invalid irqs-on event:
2282 static int early_boot_irqs_enabled;
2284 void early_boot_irqs_off(void)
2286 early_boot_irqs_enabled = 0;
2289 void early_boot_irqs_on(void)
2291 early_boot_irqs_enabled = 1;
2295 * Hardirqs will be enabled:
2297 void trace_hardirqs_on_caller(unsigned long ip)
2299 struct task_struct *curr = current;
2301 time_hardirqs_on(CALLER_ADDR0, ip);
2303 if (unlikely(!debug_locks || current->lockdep_recursion))
2306 if (DEBUG_LOCKS_WARN_ON(unlikely(!early_boot_irqs_enabled)))
2309 if (unlikely(curr->hardirqs_enabled)) {
2310 debug_atomic_inc(&redundant_hardirqs_on);
2313 /* we'll do an OFF -> ON transition: */
2314 curr->hardirqs_enabled = 1;
2316 if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
2318 if (DEBUG_LOCKS_WARN_ON(current->hardirq_context))
2321 * We are going to turn hardirqs on, so set the
2322 * usage bit for all held locks:
2324 if (!mark_held_locks(curr, HARDIRQ))
2327 * If we have softirqs enabled, then set the usage
2328 * bit for all held locks. (disabled hardirqs prevented
2329 * this bit from being set before)
2331 if (curr->softirqs_enabled)
2332 if (!mark_held_locks(curr, SOFTIRQ))
2335 curr->hardirq_enable_ip = ip;
2336 curr->hardirq_enable_event = ++curr->irq_events;
2337 debug_atomic_inc(&hardirqs_on_events);
2339 EXPORT_SYMBOL(trace_hardirqs_on_caller);
2341 void trace_hardirqs_on(void)
2343 trace_hardirqs_on_caller(CALLER_ADDR0);
2345 EXPORT_SYMBOL(trace_hardirqs_on);
2348 * Hardirqs were disabled:
2350 void trace_hardirqs_off_caller(unsigned long ip)
2352 struct task_struct *curr = current;
2354 time_hardirqs_off(CALLER_ADDR0, ip);
2356 if (unlikely(!debug_locks || current->lockdep_recursion))
2359 if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
2362 if (curr->hardirqs_enabled) {
2364 * We have done an ON -> OFF transition:
2366 curr->hardirqs_enabled = 0;
2367 curr->hardirq_disable_ip = ip;
2368 curr->hardirq_disable_event = ++curr->irq_events;
2369 debug_atomic_inc(&hardirqs_off_events);
2371 debug_atomic_inc(&redundant_hardirqs_off);
2373 EXPORT_SYMBOL(trace_hardirqs_off_caller);
2375 void trace_hardirqs_off(void)
2377 trace_hardirqs_off_caller(CALLER_ADDR0);
2379 EXPORT_SYMBOL(trace_hardirqs_off);
2382 * Softirqs will be enabled:
2384 void trace_softirqs_on(unsigned long ip)
2386 struct task_struct *curr = current;
2388 if (unlikely(!debug_locks))
2391 if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
2394 if (curr->softirqs_enabled) {
2395 debug_atomic_inc(&redundant_softirqs_on);
2400 * We'll do an OFF -> ON transition:
2402 curr->softirqs_enabled = 1;
2403 curr->softirq_enable_ip = ip;
2404 curr->softirq_enable_event = ++curr->irq_events;
2405 debug_atomic_inc(&softirqs_on_events);
2407 * We are going to turn softirqs on, so set the
2408 * usage bit for all held locks, if hardirqs are
2411 if (curr->hardirqs_enabled)
2412 mark_held_locks(curr, SOFTIRQ);
2416 * Softirqs were disabled:
2418 void trace_softirqs_off(unsigned long ip)
2420 struct task_struct *curr = current;
2422 if (unlikely(!debug_locks))
2425 if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
2428 if (curr->softirqs_enabled) {
2430 * We have done an ON -> OFF transition:
2432 curr->softirqs_enabled = 0;
2433 curr->softirq_disable_ip = ip;
2434 curr->softirq_disable_event = ++curr->irq_events;
2435 debug_atomic_inc(&softirqs_off_events);
2436 DEBUG_LOCKS_WARN_ON(!softirq_count());
2438 debug_atomic_inc(&redundant_softirqs_off);
2441 static void __lockdep_trace_alloc(gfp_t gfp_mask, unsigned long flags)
2443 struct task_struct *curr = current;
2445 if (unlikely(!debug_locks))
2448 /* no reclaim without waiting on it */
2449 if (!(gfp_mask & __GFP_WAIT))
2452 /* this guy won't enter reclaim */
2453 if ((curr->flags & PF_MEMALLOC) && !(gfp_mask & __GFP_NOMEMALLOC))
2456 /* We're only interested __GFP_FS allocations for now */
2457 if (!(gfp_mask & __GFP_FS))
2460 if (DEBUG_LOCKS_WARN_ON(irqs_disabled_flags(flags)))
2463 mark_held_locks(curr, RECLAIM_FS);
2466 static void check_flags(unsigned long flags);
2468 void lockdep_trace_alloc(gfp_t gfp_mask)
2470 unsigned long flags;
2472 if (unlikely(current->lockdep_recursion))
2475 raw_local_irq_save(flags);
2477 current->lockdep_recursion = 1;
2478 __lockdep_trace_alloc(gfp_mask, flags);
2479 current->lockdep_recursion = 0;
2480 raw_local_irq_restore(flags);
2483 static int mark_irqflags(struct task_struct *curr, struct held_lock *hlock)
2486 * If non-trylock use in a hardirq or softirq context, then
2487 * mark the lock as used in these contexts:
2489 if (!hlock->trylock) {
2491 if (curr->hardirq_context)
2492 if (!mark_lock(curr, hlock,
2493 LOCK_USED_IN_HARDIRQ_READ))
2495 if (curr->softirq_context)
2496 if (!mark_lock(curr, hlock,
2497 LOCK_USED_IN_SOFTIRQ_READ))
2500 if (curr->hardirq_context)
2501 if (!mark_lock(curr, hlock, LOCK_USED_IN_HARDIRQ))
2503 if (curr->softirq_context)
2504 if (!mark_lock(curr, hlock, LOCK_USED_IN_SOFTIRQ))
2508 if (!hlock->hardirqs_off) {
2510 if (!mark_lock(curr, hlock,
2511 LOCK_ENABLED_HARDIRQ_READ))
2513 if (curr->softirqs_enabled)
2514 if (!mark_lock(curr, hlock,
2515 LOCK_ENABLED_SOFTIRQ_READ))
2518 if (!mark_lock(curr, hlock,
2519 LOCK_ENABLED_HARDIRQ))
2521 if (curr->softirqs_enabled)
2522 if (!mark_lock(curr, hlock,
2523 LOCK_ENABLED_SOFTIRQ))
2529 * We reuse the irq context infrastructure more broadly as a general
2530 * context checking code. This tests GFP_FS recursion (a lock taken
2531 * during reclaim for a GFP_FS allocation is held over a GFP_FS
2534 if (!hlock->trylock && (curr->lockdep_reclaim_gfp & __GFP_FS)) {
2536 if (!mark_lock(curr, hlock, LOCK_USED_IN_RECLAIM_FS_READ))
2539 if (!mark_lock(curr, hlock, LOCK_USED_IN_RECLAIM_FS))
2547 static int separate_irq_context(struct task_struct *curr,
2548 struct held_lock *hlock)
2550 unsigned int depth = curr->lockdep_depth;
2553 * Keep track of points where we cross into an interrupt context:
2555 hlock->irq_context = 2*(curr->hardirq_context ? 1 : 0) +
2556 curr->softirq_context;
2558 struct held_lock *prev_hlock;
2560 prev_hlock = curr->held_locks + depth-1;
2562 * If we cross into another context, reset the
2563 * hash key (this also prevents the checking and the
2564 * adding of the dependency to 'prev'):
2566 if (prev_hlock->irq_context != hlock->irq_context)
2575 int mark_lock_irq(struct task_struct *curr, struct held_lock *this,
2576 enum lock_usage_bit new_bit)
2582 static inline int mark_irqflags(struct task_struct *curr,
2583 struct held_lock *hlock)
2588 static inline int separate_irq_context(struct task_struct *curr,
2589 struct held_lock *hlock)
2594 void lockdep_trace_alloc(gfp_t gfp_mask)
2601 * Mark a lock with a usage bit, and validate the state transition:
2603 static int mark_lock(struct task_struct *curr, struct held_lock *this,
2604 enum lock_usage_bit new_bit)
2606 unsigned int new_mask = 1 << new_bit, ret = 1;
2609 * If already set then do not dirty the cacheline,
2610 * nor do any checks:
2612 if (likely(hlock_class(this)->usage_mask & new_mask))
2618 * Make sure we didnt race:
2620 if (unlikely(hlock_class(this)->usage_mask & new_mask)) {
2625 hlock_class(this)->usage_mask |= new_mask;
2627 if (!save_trace(hlock_class(this)->usage_traces + new_bit))
2631 #define LOCKDEP_STATE(__STATE) \
2632 case LOCK_USED_IN_##__STATE: \
2633 case LOCK_USED_IN_##__STATE##_READ: \
2634 case LOCK_ENABLED_##__STATE: \
2635 case LOCK_ENABLED_##__STATE##_READ:
2636 #include "lockdep_states.h"
2637 #undef LOCKDEP_STATE
2638 ret = mark_lock_irq(curr, this, new_bit);
2643 debug_atomic_dec(&nr_unused_locks);
2646 if (!debug_locks_off_graph_unlock())
2655 * We must printk outside of the graph_lock:
2658 printk("\nmarked lock as {%s}:\n", usage_str[new_bit]);
2660 print_irqtrace_events(curr);
2668 * Initialize a lock instance's lock-class mapping info:
2670 void lockdep_init_map(struct lockdep_map *lock, const char *name,
2671 struct lock_class_key *key, int subclass)
2673 lock->class_cache = NULL;
2674 #ifdef CONFIG_LOCK_STAT
2675 lock->cpu = raw_smp_processor_id();
2678 if (DEBUG_LOCKS_WARN_ON(!name)) {
2679 lock->name = "NULL";
2685 if (DEBUG_LOCKS_WARN_ON(!key))
2688 * Sanity check, the lock-class key must be persistent:
2690 if (!static_obj(key)) {
2691 printk("BUG: key %p not in .data!\n", key);
2692 DEBUG_LOCKS_WARN_ON(1);
2697 if (unlikely(!debug_locks))
2701 register_lock_class(lock, subclass, 1);
2703 EXPORT_SYMBOL_GPL(lockdep_init_map);
2706 * This gets called for every mutex_lock*()/spin_lock*() operation.
2707 * We maintain the dependency maps and validate the locking attempt:
2709 static int __lock_acquire(struct lockdep_map *lock, unsigned int subclass,
2710 int trylock, int read, int check, int hardirqs_off,
2711 struct lockdep_map *nest_lock, unsigned long ip,
2714 struct task_struct *curr = current;
2715 struct lock_class *class = NULL;
2716 struct held_lock *hlock;
2717 unsigned int depth, id;
2725 if (unlikely(!debug_locks))
2728 if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
2731 if (unlikely(subclass >= MAX_LOCKDEP_SUBCLASSES)) {
2733 printk("BUG: MAX_LOCKDEP_SUBCLASSES too low!\n");
2734 printk("turning off the locking correctness validator.\n");
2740 class = lock->class_cache;
2742 * Not cached yet or subclass?
2744 if (unlikely(!class)) {
2745 class = register_lock_class(lock, subclass, 0);
2749 debug_atomic_inc((atomic_t *)&class->ops);
2750 if (very_verbose(class)) {
2751 printk("\nacquire class [%p] %s", class->key, class->name);
2752 if (class->name_version > 1)
2753 printk("#%d", class->name_version);
2759 * Add the lock to the list of currently held locks.
2760 * (we dont increase the depth just yet, up until the
2761 * dependency checks are done)
2763 depth = curr->lockdep_depth;
2764 if (DEBUG_LOCKS_WARN_ON(depth >= MAX_LOCK_DEPTH))
2767 class_idx = class - lock_classes + 1;
2770 hlock = curr->held_locks + depth - 1;
2771 if (hlock->class_idx == class_idx && nest_lock) {
2772 if (hlock->references)
2773 hlock->references++;
2775 hlock->references = 2;
2781 hlock = curr->held_locks + depth;
2782 if (DEBUG_LOCKS_WARN_ON(!class))
2784 hlock->class_idx = class_idx;
2785 hlock->acquire_ip = ip;
2786 hlock->instance = lock;
2787 hlock->nest_lock = nest_lock;
2788 hlock->trylock = trylock;
2790 hlock->check = check;
2791 hlock->hardirqs_off = !!hardirqs_off;
2792 hlock->references = references;
2793 #ifdef CONFIG_LOCK_STAT
2794 hlock->waittime_stamp = 0;
2795 hlock->holdtime_stamp = sched_clock();
2798 if (check == 2 && !mark_irqflags(curr, hlock))
2801 /* mark it as used: */
2802 if (!mark_lock(curr, hlock, LOCK_USED))
2806 * Calculate the chain hash: it's the combined hash of all the
2807 * lock keys along the dependency chain. We save the hash value
2808 * at every step so that we can get the current hash easily
2809 * after unlock. The chain hash is then used to cache dependency
2812 * The 'key ID' is what is the most compact key value to drive
2813 * the hash, not class->key.
2815 id = class - lock_classes;
2816 if (DEBUG_LOCKS_WARN_ON(id >= MAX_LOCKDEP_KEYS))
2819 chain_key = curr->curr_chain_key;
2821 if (DEBUG_LOCKS_WARN_ON(chain_key != 0))
2826 hlock->prev_chain_key = chain_key;
2827 if (separate_irq_context(curr, hlock)) {
2831 chain_key = iterate_chain_key(chain_key, id);
2833 if (!validate_chain(curr, lock, hlock, chain_head, chain_key))
2836 curr->curr_chain_key = chain_key;
2837 curr->lockdep_depth++;
2838 check_chain_key(curr);
2839 #ifdef CONFIG_DEBUG_LOCKDEP
2840 if (unlikely(!debug_locks))
2843 if (unlikely(curr->lockdep_depth >= MAX_LOCK_DEPTH)) {
2845 printk("BUG: MAX_LOCK_DEPTH too low!\n");
2846 printk("turning off the locking correctness validator.\n");
2851 if (unlikely(curr->lockdep_depth > max_lockdep_depth))
2852 max_lockdep_depth = curr->lockdep_depth;
2858 print_unlock_inbalance_bug(struct task_struct *curr, struct lockdep_map *lock,
2861 if (!debug_locks_off())
2863 if (debug_locks_silent)
2866 printk("\n=====================================\n");
2867 printk( "[ BUG: bad unlock balance detected! ]\n");
2868 printk( "-------------------------------------\n");
2869 printk("%s/%d is trying to release lock (",
2870 curr->comm, task_pid_nr(curr));
2871 print_lockdep_cache(lock);
2874 printk("but there are no more locks to release!\n");
2875 printk("\nother info that might help us debug this:\n");
2876 lockdep_print_held_locks(curr);
2878 printk("\nstack backtrace:\n");
2885 * Common debugging checks for both nested and non-nested unlock:
2887 static int check_unlock(struct task_struct *curr, struct lockdep_map *lock,
2890 if (unlikely(!debug_locks))
2892 if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
2895 if (curr->lockdep_depth <= 0)
2896 return print_unlock_inbalance_bug(curr, lock, ip);
2901 static int match_held_lock(struct held_lock *hlock, struct lockdep_map *lock)
2903 if (hlock->instance == lock)
2906 if (hlock->references) {
2907 struct lock_class *class = lock->class_cache;
2910 class = look_up_lock_class(lock, 0);
2912 if (DEBUG_LOCKS_WARN_ON(!class))
2915 if (DEBUG_LOCKS_WARN_ON(!hlock->nest_lock))
2918 if (hlock->class_idx == class - lock_classes + 1)
2926 __lock_set_class(struct lockdep_map *lock, const char *name,
2927 struct lock_class_key *key, unsigned int subclass,
2930 struct task_struct *curr = current;
2931 struct held_lock *hlock, *prev_hlock;
2932 struct lock_class *class;
2936 depth = curr->lockdep_depth;
2937 if (DEBUG_LOCKS_WARN_ON(!depth))
2941 for (i = depth-1; i >= 0; i--) {
2942 hlock = curr->held_locks + i;
2944 * We must not cross into another context:
2946 if (prev_hlock && prev_hlock->irq_context != hlock->irq_context)
2948 if (match_held_lock(hlock, lock))
2952 return print_unlock_inbalance_bug(curr, lock, ip);
2955 lockdep_init_map(lock, name, key, 0);
2956 class = register_lock_class(lock, subclass, 0);
2957 hlock->class_idx = class - lock_classes + 1;
2959 curr->lockdep_depth = i;
2960 curr->curr_chain_key = hlock->prev_chain_key;
2962 for (; i < depth; i++) {
2963 hlock = curr->held_locks + i;
2964 if (!__lock_acquire(hlock->instance,
2965 hlock_class(hlock)->subclass, hlock->trylock,
2966 hlock->read, hlock->check, hlock->hardirqs_off,
2967 hlock->nest_lock, hlock->acquire_ip,
2972 if (DEBUG_LOCKS_WARN_ON(curr->lockdep_depth != depth))
2978 * Remove the lock to the list of currently held locks in a
2979 * potentially non-nested (out of order) manner. This is a
2980 * relatively rare operation, as all the unlock APIs default
2981 * to nested mode (which uses lock_release()):
2984 lock_release_non_nested(struct task_struct *curr,
2985 struct lockdep_map *lock, unsigned long ip)
2987 struct held_lock *hlock, *prev_hlock;
2992 * Check whether the lock exists in the current stack
2995 depth = curr->lockdep_depth;
2996 if (DEBUG_LOCKS_WARN_ON(!depth))
3000 for (i = depth-1; i >= 0; i--) {
3001 hlock = curr->held_locks + i;
3003 * We must not cross into another context:
3005 if (prev_hlock && prev_hlock->irq_context != hlock->irq_context)
3007 if (match_held_lock(hlock, lock))
3011 return print_unlock_inbalance_bug(curr, lock, ip);
3014 if (hlock->instance == lock)
3015 lock_release_holdtime(hlock);
3017 if (hlock->references) {
3018 hlock->references--;
3019 if (hlock->references) {
3021 * We had, and after removing one, still have
3022 * references, the current lock stack is still
3023 * valid. We're done!
3030 * We have the right lock to unlock, 'hlock' points to it.
3031 * Now we remove it from the stack, and add back the other
3032 * entries (if any), recalculating the hash along the way:
3035 curr->lockdep_depth = i;
3036 curr->curr_chain_key = hlock->prev_chain_key;
3038 for (i++; i < depth; i++) {
3039 hlock = curr->held_locks + i;
3040 if (!__lock_acquire(hlock->instance,
3041 hlock_class(hlock)->subclass, hlock->trylock,
3042 hlock->read, hlock->check, hlock->hardirqs_off,
3043 hlock->nest_lock, hlock->acquire_ip,
3048 if (DEBUG_LOCKS_WARN_ON(curr->lockdep_depth != depth - 1))
3054 * Remove the lock to the list of currently held locks - this gets
3055 * called on mutex_unlock()/spin_unlock*() (or on a failed
3056 * mutex_lock_interruptible()). This is done for unlocks that nest
3057 * perfectly. (i.e. the current top of the lock-stack is unlocked)
3059 static int lock_release_nested(struct task_struct *curr,
3060 struct lockdep_map *lock, unsigned long ip)
3062 struct held_lock *hlock;
3066 * Pop off the top of the lock stack:
3068 depth = curr->lockdep_depth - 1;
3069 hlock = curr->held_locks + depth;
3072 * Is the unlock non-nested:
3074 if (hlock->instance != lock || hlock->references)
3075 return lock_release_non_nested(curr, lock, ip);
3076 curr->lockdep_depth--;
3078 if (DEBUG_LOCKS_WARN_ON(!depth && (hlock->prev_chain_key != 0)))
3081 curr->curr_chain_key = hlock->prev_chain_key;
3083 lock_release_holdtime(hlock);
3085 #ifdef CONFIG_DEBUG_LOCKDEP
3086 hlock->prev_chain_key = 0;
3087 hlock->class_idx = 0;
3088 hlock->acquire_ip = 0;
3089 hlock->irq_context = 0;
3095 * Remove the lock to the list of currently held locks - this gets
3096 * called on mutex_unlock()/spin_unlock*() (or on a failed
3097 * mutex_lock_interruptible()). This is done for unlocks that nest
3098 * perfectly. (i.e. the current top of the lock-stack is unlocked)
3101 __lock_release(struct lockdep_map *lock, int nested, unsigned long ip)
3103 struct task_struct *curr = current;
3105 if (!check_unlock(curr, lock, ip))
3109 if (!lock_release_nested(curr, lock, ip))
3112 if (!lock_release_non_nested(curr, lock, ip))
3116 check_chain_key(curr);
3119 static int __lock_is_held(struct lockdep_map *lock)
3121 struct task_struct *curr = current;
3124 for (i = 0; i < curr->lockdep_depth; i++) {
3125 struct held_lock *hlock = curr->held_locks + i;
3127 if (match_held_lock(hlock, lock))
3135 * Check whether we follow the irq-flags state precisely:
3137 static void check_flags(unsigned long flags)
3139 #if defined(CONFIG_PROVE_LOCKING) && defined(CONFIG_DEBUG_LOCKDEP) && \
3140 defined(CONFIG_TRACE_IRQFLAGS)
3144 if (irqs_disabled_flags(flags)) {
3145 if (DEBUG_LOCKS_WARN_ON(current->hardirqs_enabled)) {
3146 printk("possible reason: unannotated irqs-off.\n");
3149 if (DEBUG_LOCKS_WARN_ON(!current->hardirqs_enabled)) {
3150 printk("possible reason: unannotated irqs-on.\n");
3155 * We dont accurately track softirq state in e.g.
3156 * hardirq contexts (such as on 4KSTACKS), so only
3157 * check if not in hardirq contexts:
3159 if (!hardirq_count()) {
3160 if (softirq_count())
3161 DEBUG_LOCKS_WARN_ON(current->softirqs_enabled);
3163 DEBUG_LOCKS_WARN_ON(!current->softirqs_enabled);
3167 print_irqtrace_events(current);
3171 void lock_set_class(struct lockdep_map *lock, const char *name,
3172 struct lock_class_key *key, unsigned int subclass,
3175 unsigned long flags;
3177 if (unlikely(current->lockdep_recursion))
3180 raw_local_irq_save(flags);
3181 current->lockdep_recursion = 1;
3183 if (__lock_set_class(lock, name, key, subclass, ip))
3184 check_chain_key(current);
3185 current->lockdep_recursion = 0;
3186 raw_local_irq_restore(flags);
3188 EXPORT_SYMBOL_GPL(lock_set_class);
3191 * We are not always called with irqs disabled - do that here,
3192 * and also avoid lockdep recursion:
3194 void lock_acquire(struct lockdep_map *lock, unsigned int subclass,
3195 int trylock, int read, int check,
3196 struct lockdep_map *nest_lock, unsigned long ip)
3198 unsigned long flags;
3200 trace_lock_acquire(lock, subclass, trylock, read, check, nest_lock, ip);
3202 if (unlikely(current->lockdep_recursion))
3205 raw_local_irq_save(flags);
3208 current->lockdep_recursion = 1;
3209 __lock_acquire(lock, subclass, trylock, read, check,
3210 irqs_disabled_flags(flags), nest_lock, ip, 0);
3211 current->lockdep_recursion = 0;
3212 raw_local_irq_restore(flags);
3214 EXPORT_SYMBOL_GPL(lock_acquire);
3216 void lock_release(struct lockdep_map *lock, int nested,
3219 unsigned long flags;
3221 trace_lock_release(lock, nested, ip);
3223 if (unlikely(current->lockdep_recursion))
3226 raw_local_irq_save(flags);
3228 current->lockdep_recursion = 1;
3229 __lock_release(lock, nested, ip);
3230 current->lockdep_recursion = 0;
3231 raw_local_irq_restore(flags);
3233 EXPORT_SYMBOL_GPL(lock_release);
3235 int lock_is_held(struct lockdep_map *lock)
3237 unsigned long flags;
3240 if (unlikely(current->lockdep_recursion))
3243 raw_local_irq_save(flags);
3246 current->lockdep_recursion = 1;
3247 ret = __lock_is_held(lock);
3248 current->lockdep_recursion = 0;
3249 raw_local_irq_restore(flags);
3253 EXPORT_SYMBOL_GPL(lock_is_held);
3255 void lockdep_set_current_reclaim_state(gfp_t gfp_mask)
3257 current->lockdep_reclaim_gfp = gfp_mask;
3260 void lockdep_clear_current_reclaim_state(void)
3262 current->lockdep_reclaim_gfp = 0;
3265 #ifdef CONFIG_LOCK_STAT
3267 print_lock_contention_bug(struct task_struct *curr, struct lockdep_map *lock,
3270 if (!debug_locks_off())
3272 if (debug_locks_silent)
3275 printk("\n=================================\n");
3276 printk( "[ BUG: bad contention detected! ]\n");
3277 printk( "---------------------------------\n");
3278 printk("%s/%d is trying to contend lock (",
3279 curr->comm, task_pid_nr(curr));
3280 print_lockdep_cache(lock);
3283 printk("but there are no locks held!\n");
3284 printk("\nother info that might help us debug this:\n");
3285 lockdep_print_held_locks(curr);
3287 printk("\nstack backtrace:\n");
3294 __lock_contended(struct lockdep_map *lock, unsigned long ip)
3296 struct task_struct *curr = current;
3297 struct held_lock *hlock, *prev_hlock;
3298 struct lock_class_stats *stats;
3300 int i, contention_point, contending_point;
3302 depth = curr->lockdep_depth;
3303 if (DEBUG_LOCKS_WARN_ON(!depth))
3307 for (i = depth-1; i >= 0; i--) {
3308 hlock = curr->held_locks + i;
3310 * We must not cross into another context:
3312 if (prev_hlock && prev_hlock->irq_context != hlock->irq_context)
3314 if (match_held_lock(hlock, lock))
3318 print_lock_contention_bug(curr, lock, ip);
3322 if (hlock->instance != lock)
3325 hlock->waittime_stamp = sched_clock();
3327 contention_point = lock_point(hlock_class(hlock)->contention_point, ip);
3328 contending_point = lock_point(hlock_class(hlock)->contending_point,
3331 stats = get_lock_stats(hlock_class(hlock));
3332 if (contention_point < LOCKSTAT_POINTS)
3333 stats->contention_point[contention_point]++;
3334 if (contending_point < LOCKSTAT_POINTS)
3335 stats->contending_point[contending_point]++;
3336 if (lock->cpu != smp_processor_id())
3337 stats->bounces[bounce_contended + !!hlock->read]++;
3338 put_lock_stats(stats);
3342 __lock_acquired(struct lockdep_map *lock, unsigned long ip)
3344 struct task_struct *curr = current;
3345 struct held_lock *hlock, *prev_hlock;
3346 struct lock_class_stats *stats;
3352 depth = curr->lockdep_depth;
3353 if (DEBUG_LOCKS_WARN_ON(!depth))
3357 for (i = depth-1; i >= 0; i--) {
3358 hlock = curr->held_locks + i;
3360 * We must not cross into another context:
3362 if (prev_hlock && prev_hlock->irq_context != hlock->irq_context)
3364 if (match_held_lock(hlock, lock))
3368 print_lock_contention_bug(curr, lock, _RET_IP_);
3372 if (hlock->instance != lock)
3375 cpu = smp_processor_id();
3376 if (hlock->waittime_stamp) {
3377 now = sched_clock();
3378 waittime = now - hlock->waittime_stamp;
3379 hlock->holdtime_stamp = now;
3382 trace_lock_acquired(lock, ip, waittime);
3384 stats = get_lock_stats(hlock_class(hlock));
3387 lock_time_inc(&stats->read_waittime, waittime);
3389 lock_time_inc(&stats->write_waittime, waittime);
3391 if (lock->cpu != cpu)
3392 stats->bounces[bounce_acquired + !!hlock->read]++;
3393 put_lock_stats(stats);
3399 void lock_contended(struct lockdep_map *lock, unsigned long ip)
3401 unsigned long flags;
3403 trace_lock_contended(lock, ip);
3405 if (unlikely(!lock_stat))
3408 if (unlikely(current->lockdep_recursion))
3411 raw_local_irq_save(flags);
3413 current->lockdep_recursion = 1;
3414 __lock_contended(lock, ip);
3415 current->lockdep_recursion = 0;
3416 raw_local_irq_restore(flags);
3418 EXPORT_SYMBOL_GPL(lock_contended);
3420 void lock_acquired(struct lockdep_map *lock, unsigned long ip)
3422 unsigned long flags;
3424 if (unlikely(!lock_stat))
3427 if (unlikely(current->lockdep_recursion))
3430 raw_local_irq_save(flags);
3432 current->lockdep_recursion = 1;
3433 __lock_acquired(lock, ip);
3434 current->lockdep_recursion = 0;
3435 raw_local_irq_restore(flags);
3437 EXPORT_SYMBOL_GPL(lock_acquired);
3441 * Used by the testsuite, sanitize the validator state
3442 * after a simulated failure:
3445 void lockdep_reset(void)
3447 unsigned long flags;
3450 raw_local_irq_save(flags);
3451 current->curr_chain_key = 0;
3452 current->lockdep_depth = 0;
3453 current->lockdep_recursion = 0;
3454 memset(current->held_locks, 0, MAX_LOCK_DEPTH*sizeof(struct held_lock));
3455 nr_hardirq_chains = 0;
3456 nr_softirq_chains = 0;
3457 nr_process_chains = 0;
3459 for (i = 0; i < CHAINHASH_SIZE; i++)
3460 INIT_LIST_HEAD(chainhash_table + i);
3461 raw_local_irq_restore(flags);
3464 static void zap_class(struct lock_class *class)
3469 * Remove all dependencies this lock is
3472 for (i = 0; i < nr_list_entries; i++) {
3473 if (list_entries[i].class == class)
3474 list_del_rcu(&list_entries[i].entry);
3477 * Unhash the class and remove it from the all_lock_classes list:
3479 list_del_rcu(&class->hash_entry);
3480 list_del_rcu(&class->lock_entry);
3485 static inline int within(const void *addr, void *start, unsigned long size)
3487 return addr >= start && addr < start + size;
3490 void lockdep_free_key_range(void *start, unsigned long size)
3492 struct lock_class *class, *next;
3493 struct list_head *head;
3494 unsigned long flags;
3498 raw_local_irq_save(flags);
3499 locked = graph_lock();
3502 * Unhash all classes that were created by this module:
3504 for (i = 0; i < CLASSHASH_SIZE; i++) {
3505 head = classhash_table + i;
3506 if (list_empty(head))
3508 list_for_each_entry_safe(class, next, head, hash_entry) {
3509 if (within(class->key, start, size))
3511 else if (within(class->name, start, size))
3518 raw_local_irq_restore(flags);
3521 void lockdep_reset_lock(struct lockdep_map *lock)
3523 struct lock_class *class, *next;
3524 struct list_head *head;
3525 unsigned long flags;
3529 raw_local_irq_save(flags);
3532 * Remove all classes this lock might have:
3534 for (j = 0; j < MAX_LOCKDEP_SUBCLASSES; j++) {
3536 * If the class exists we look it up and zap it:
3538 class = look_up_lock_class(lock, j);
3543 * Debug check: in the end all mapped classes should
3546 locked = graph_lock();
3547 for (i = 0; i < CLASSHASH_SIZE; i++) {
3548 head = classhash_table + i;
3549 if (list_empty(head))
3551 list_for_each_entry_safe(class, next, head, hash_entry) {
3552 if (unlikely(class == lock->class_cache)) {
3553 if (debug_locks_off_graph_unlock())
3563 raw_local_irq_restore(flags);
3566 void lockdep_init(void)
3571 * Some architectures have their own start_kernel()
3572 * code which calls lockdep_init(), while we also
3573 * call lockdep_init() from the start_kernel() itself,
3574 * and we want to initialize the hashes only once:
3576 if (lockdep_initialized)
3579 for (i = 0; i < CLASSHASH_SIZE; i++)
3580 INIT_LIST_HEAD(classhash_table + i);
3582 for (i = 0; i < CHAINHASH_SIZE; i++)
3583 INIT_LIST_HEAD(chainhash_table + i);
3585 lockdep_initialized = 1;
3588 void __init lockdep_info(void)
3590 printk("Lock dependency validator: Copyright (c) 2006 Red Hat, Inc., Ingo Molnar\n");
3592 printk("... MAX_LOCKDEP_SUBCLASSES: %lu\n", MAX_LOCKDEP_SUBCLASSES);
3593 printk("... MAX_LOCK_DEPTH: %lu\n", MAX_LOCK_DEPTH);
3594 printk("... MAX_LOCKDEP_KEYS: %lu\n", MAX_LOCKDEP_KEYS);
3595 printk("... CLASSHASH_SIZE: %lu\n", CLASSHASH_SIZE);
3596 printk("... MAX_LOCKDEP_ENTRIES: %lu\n", MAX_LOCKDEP_ENTRIES);
3597 printk("... MAX_LOCKDEP_CHAINS: %lu\n", MAX_LOCKDEP_CHAINS);
3598 printk("... CHAINHASH_SIZE: %lu\n", CHAINHASH_SIZE);
3600 printk(" memory used by lock dependency info: %lu kB\n",
3601 (sizeof(struct lock_class) * MAX_LOCKDEP_KEYS +
3602 sizeof(struct list_head) * CLASSHASH_SIZE +
3603 sizeof(struct lock_list) * MAX_LOCKDEP_ENTRIES +
3604 sizeof(struct lock_chain) * MAX_LOCKDEP_CHAINS +
3605 sizeof(struct list_head) * CHAINHASH_SIZE
3606 #ifdef CONFIG_PROVE_LOCKING
3607 + sizeof(struct circular_queue)
3612 printk(" per task-struct memory footprint: %lu bytes\n",
3613 sizeof(struct held_lock) * MAX_LOCK_DEPTH);
3615 #ifdef CONFIG_DEBUG_LOCKDEP
3616 if (lockdep_init_error) {
3617 printk("WARNING: lockdep init error! Arch code didn't call lockdep_init() early enough?\n");
3618 printk("Call stack leading to lockdep invocation was:\n");
3619 print_stack_trace(&lockdep_init_trace, 0);
3625 print_freed_lock_bug(struct task_struct *curr, const void *mem_from,
3626 const void *mem_to, struct held_lock *hlock)
3628 if (!debug_locks_off())
3630 if (debug_locks_silent)
3633 printk("\n=========================\n");
3634 printk( "[ BUG: held lock freed! ]\n");
3635 printk( "-------------------------\n");
3636 printk("%s/%d is freeing memory %p-%p, with a lock still held there!\n",
3637 curr->comm, task_pid_nr(curr), mem_from, mem_to-1);
3639 lockdep_print_held_locks(curr);
3641 printk("\nstack backtrace:\n");
3645 static inline int not_in_range(const void* mem_from, unsigned long mem_len,
3646 const void* lock_from, unsigned long lock_len)
3648 return lock_from + lock_len <= mem_from ||
3649 mem_from + mem_len <= lock_from;
3653 * Called when kernel memory is freed (or unmapped), or if a lock
3654 * is destroyed or reinitialized - this code checks whether there is
3655 * any held lock in the memory range of <from> to <to>:
3657 void debug_check_no_locks_freed(const void *mem_from, unsigned long mem_len)
3659 struct task_struct *curr = current;
3660 struct held_lock *hlock;
3661 unsigned long flags;
3664 if (unlikely(!debug_locks))
3667 local_irq_save(flags);
3668 for (i = 0; i < curr->lockdep_depth; i++) {
3669 hlock = curr->held_locks + i;
3671 if (not_in_range(mem_from, mem_len, hlock->instance,
3672 sizeof(*hlock->instance)))
3675 print_freed_lock_bug(curr, mem_from, mem_from + mem_len, hlock);
3678 local_irq_restore(flags);
3680 EXPORT_SYMBOL_GPL(debug_check_no_locks_freed);
3682 static void print_held_locks_bug(struct task_struct *curr)
3684 if (!debug_locks_off())
3686 if (debug_locks_silent)
3689 printk("\n=====================================\n");
3690 printk( "[ BUG: lock held at task exit time! ]\n");
3691 printk( "-------------------------------------\n");
3692 printk("%s/%d is exiting with locks still held!\n",
3693 curr->comm, task_pid_nr(curr));
3694 lockdep_print_held_locks(curr);
3696 printk("\nstack backtrace:\n");
3700 void debug_check_no_locks_held(struct task_struct *task)
3702 if (unlikely(task->lockdep_depth > 0))
3703 print_held_locks_bug(task);
3706 void debug_show_all_locks(void)
3708 struct task_struct *g, *p;
3712 if (unlikely(!debug_locks)) {
3713 printk("INFO: lockdep is turned off.\n");
3716 printk("\nShowing all locks held in the system:\n");
3719 * Here we try to get the tasklist_lock as hard as possible,
3720 * if not successful after 2 seconds we ignore it (but keep
3721 * trying). This is to enable a debug printout even if a
3722 * tasklist_lock-holding task deadlocks or crashes.
3725 if (!read_trylock(&tasklist_lock)) {
3727 printk("hm, tasklist_lock locked, retrying... ");
3730 printk(" #%d", 10-count);
3734 printk(" ignoring it.\n");
3738 printk(KERN_CONT " locked it.\n");
3741 do_each_thread(g, p) {
3743 * It's not reliable to print a task's held locks
3744 * if it's not sleeping (or if it's not the current
3747 if (p->state == TASK_RUNNING && p != current)
3749 if (p->lockdep_depth)
3750 lockdep_print_held_locks(p);
3752 if (read_trylock(&tasklist_lock))
3754 } while_each_thread(g, p);
3757 printk("=============================================\n\n");
3760 read_unlock(&tasklist_lock);
3762 EXPORT_SYMBOL_GPL(debug_show_all_locks);
3765 * Careful: only use this function if you are sure that
3766 * the task cannot run in parallel!
3768 void __debug_show_held_locks(struct task_struct *task)
3770 if (unlikely(!debug_locks)) {
3771 printk("INFO: lockdep is turned off.\n");
3774 lockdep_print_held_locks(task);
3776 EXPORT_SYMBOL_GPL(__debug_show_held_locks);
3778 void debug_show_held_locks(struct task_struct *task)
3780 __debug_show_held_locks(task);
3782 EXPORT_SYMBOL_GPL(debug_show_held_locks);
3784 void lockdep_sys_exit(void)
3786 struct task_struct *curr = current;
3788 if (unlikely(curr->lockdep_depth)) {
3789 if (!debug_locks_off())
3791 printk("\n================================================\n");
3792 printk( "[ BUG: lock held when returning to user space! ]\n");
3793 printk( "------------------------------------------------\n");
3794 printk("%s/%d is leaving the kernel with locks still held!\n",
3795 curr->comm, curr->pid);
3796 lockdep_print_held_locks(curr);