4 * Runtime locking correctness validator
6 * Started by Ingo Molnar:
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/sched/clock.h>
32 #include <linux/sched/task.h>
33 #include <linux/sched/mm.h>
34 #include <linux/delay.h>
35 #include <linux/module.h>
36 #include <linux/proc_fs.h>
37 #include <linux/seq_file.h>
38 #include <linux/spinlock.h>
39 #include <linux/kallsyms.h>
40 #include <linux/interrupt.h>
41 #include <linux/stacktrace.h>
42 #include <linux/debug_locks.h>
43 #include <linux/irqflags.h>
44 #include <linux/utsname.h>
45 #include <linux/hash.h>
46 #include <linux/ftrace.h>
47 #include <linux/stringify.h>
48 #include <linux/bitops.h>
49 #include <linux/gfp.h>
50 #include <linux/random.h>
51 #include <linux/jhash.h>
52 #include <linux/nmi.h>
54 #include <asm/sections.h>
56 #include "lockdep_internals.h"
58 #define CREATE_TRACE_POINTS
59 #include <trace/events/lock.h>
61 #ifdef CONFIG_PROVE_LOCKING
62 int prove_locking = 1;
63 module_param(prove_locking, int, 0644);
65 #define prove_locking 0
68 #ifdef CONFIG_LOCK_STAT
70 module_param(lock_stat, int, 0644);
76 * lockdep_lock: protects the lockdep graph, the hashes and the
77 * class/list/hash allocators.
79 * This is one of the rare exceptions where it's justified
80 * to use a raw spinlock - we really dont want the spinlock
81 * code to recurse back into the lockdep code...
83 static arch_spinlock_t lockdep_lock = (arch_spinlock_t)__ARCH_SPIN_LOCK_UNLOCKED;
85 static int graph_lock(void)
87 arch_spin_lock(&lockdep_lock);
89 * Make sure that if another CPU detected a bug while
90 * walking the graph we dont change it (while the other
91 * CPU is busy printing out stuff with the graph lock
95 arch_spin_unlock(&lockdep_lock);
98 /* prevent any recursions within lockdep from causing deadlocks */
99 current->lockdep_recursion++;
103 static inline int graph_unlock(void)
105 if (debug_locks && !arch_spin_is_locked(&lockdep_lock)) {
107 * The lockdep graph lock isn't locked while we expect it to
108 * be, we're confused now, bye!
110 return DEBUG_LOCKS_WARN_ON(1);
113 current->lockdep_recursion--;
114 arch_spin_unlock(&lockdep_lock);
119 * Turn lock debugging off and return with 0 if it was off already,
120 * and also release the graph lock:
122 static inline int debug_locks_off_graph_unlock(void)
124 int ret = debug_locks_off();
126 arch_spin_unlock(&lockdep_lock);
131 unsigned long nr_list_entries;
132 static struct lock_list list_entries[MAX_LOCKDEP_ENTRIES];
135 * All data structures here are protected by the global debug_lock.
137 * Mutex key structs only get allocated, once during bootup, and never
138 * get freed - this significantly simplifies the debugging code.
140 unsigned long nr_lock_classes;
141 #ifndef CONFIG_DEBUG_LOCKDEP
144 struct lock_class lock_classes[MAX_LOCKDEP_KEYS];
146 static inline struct lock_class *hlock_class(struct held_lock *hlock)
148 if (!hlock->class_idx) {
150 * Someone passed in garbage, we give up.
152 DEBUG_LOCKS_WARN_ON(1);
155 return lock_classes + hlock->class_idx - 1;
158 #ifdef CONFIG_LOCK_STAT
159 static DEFINE_PER_CPU(struct lock_class_stats[MAX_LOCKDEP_KEYS], cpu_lock_stats);
161 static inline u64 lockstat_clock(void)
163 return local_clock();
166 static int lock_point(unsigned long points[], unsigned long ip)
170 for (i = 0; i < LOCKSTAT_POINTS; i++) {
171 if (points[i] == 0) {
182 static void lock_time_inc(struct lock_time *lt, u64 time)
187 if (time < lt->min || !lt->nr)
194 static inline void lock_time_add(struct lock_time *src, struct lock_time *dst)
199 if (src->max > dst->max)
202 if (src->min < dst->min || !dst->nr)
205 dst->total += src->total;
209 struct lock_class_stats lock_stats(struct lock_class *class)
211 struct lock_class_stats stats;
214 memset(&stats, 0, sizeof(struct lock_class_stats));
215 for_each_possible_cpu(cpu) {
216 struct lock_class_stats *pcs =
217 &per_cpu(cpu_lock_stats, cpu)[class - lock_classes];
219 for (i = 0; i < ARRAY_SIZE(stats.contention_point); i++)
220 stats.contention_point[i] += pcs->contention_point[i];
222 for (i = 0; i < ARRAY_SIZE(stats.contending_point); i++)
223 stats.contending_point[i] += pcs->contending_point[i];
225 lock_time_add(&pcs->read_waittime, &stats.read_waittime);
226 lock_time_add(&pcs->write_waittime, &stats.write_waittime);
228 lock_time_add(&pcs->read_holdtime, &stats.read_holdtime);
229 lock_time_add(&pcs->write_holdtime, &stats.write_holdtime);
231 for (i = 0; i < ARRAY_SIZE(stats.bounces); i++)
232 stats.bounces[i] += pcs->bounces[i];
238 void clear_lock_stats(struct lock_class *class)
242 for_each_possible_cpu(cpu) {
243 struct lock_class_stats *cpu_stats =
244 &per_cpu(cpu_lock_stats, cpu)[class - lock_classes];
246 memset(cpu_stats, 0, sizeof(struct lock_class_stats));
248 memset(class->contention_point, 0, sizeof(class->contention_point));
249 memset(class->contending_point, 0, sizeof(class->contending_point));
252 static struct lock_class_stats *get_lock_stats(struct lock_class *class)
254 return &this_cpu_ptr(cpu_lock_stats)[class - lock_classes];
257 static void lock_release_holdtime(struct held_lock *hlock)
259 struct lock_class_stats *stats;
265 holdtime = lockstat_clock() - hlock->holdtime_stamp;
267 stats = get_lock_stats(hlock_class(hlock));
269 lock_time_inc(&stats->read_holdtime, holdtime);
271 lock_time_inc(&stats->write_holdtime, holdtime);
274 static inline void lock_release_holdtime(struct held_lock *hlock)
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
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
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:
339 #define VERY_VERBOSE 0
342 # define HARDIRQ_VERBOSE 1
343 # define SOFTIRQ_VERBOSE 1
345 # define HARDIRQ_VERBOSE 0
346 # define SOFTIRQ_VERBOSE 0
349 #if VERBOSE || HARDIRQ_VERBOSE || SOFTIRQ_VERBOSE
351 * Quick filtering for interesting events:
353 static int class_filter(struct lock_class *class)
357 if (class->name_version == 1 &&
358 !strcmp(class->name, "lockname"))
360 if (class->name_version == 1 &&
361 !strcmp(class->name, "&struct->lockfield"))
364 /* Filter everything else. 1 would be to allow everything else */
369 static int verbose(struct lock_class *class)
372 return class_filter(class);
378 * Stack-trace: tightly packed array of stack backtrace
379 * addresses. Protected by the graph_lock.
381 unsigned long nr_stack_trace_entries;
382 static unsigned long stack_trace[MAX_STACK_TRACE_ENTRIES];
384 static void print_lockdep_off(const char *bug_msg)
386 printk(KERN_DEBUG "%s\n", bug_msg);
387 printk(KERN_DEBUG "turning off the locking correctness validator.\n");
388 #ifdef CONFIG_LOCK_STAT
389 printk(KERN_DEBUG "Please attach the output of /proc/lock_stat to the bug report\n");
393 static int save_trace(struct stack_trace *trace)
395 trace->nr_entries = 0;
396 trace->max_entries = MAX_STACK_TRACE_ENTRIES - nr_stack_trace_entries;
397 trace->entries = stack_trace + nr_stack_trace_entries;
401 save_stack_trace(trace);
404 * Some daft arches put -1 at the end to indicate its a full trace.
406 * <rant> this is buggy anyway, since it takes a whole extra entry so a
407 * complete trace that maxes out the entries provided will be reported
408 * as incomplete, friggin useless </rant>
410 if (trace->nr_entries != 0 &&
411 trace->entries[trace->nr_entries-1] == ULONG_MAX)
414 trace->max_entries = trace->nr_entries;
416 nr_stack_trace_entries += trace->nr_entries;
418 if (nr_stack_trace_entries >= MAX_STACK_TRACE_ENTRIES-1) {
419 if (!debug_locks_off_graph_unlock())
422 print_lockdep_off("BUG: MAX_STACK_TRACE_ENTRIES too low!");
431 unsigned int nr_hardirq_chains;
432 unsigned int nr_softirq_chains;
433 unsigned int nr_process_chains;
434 unsigned int max_lockdep_depth;
436 #ifdef CONFIG_DEBUG_LOCKDEP
438 * Various lockdep statistics:
440 DEFINE_PER_CPU(struct lockdep_stats, lockdep_stats);
447 #define __USAGE(__STATE) \
448 [LOCK_USED_IN_##__STATE] = "IN-"__stringify(__STATE)"-W", \
449 [LOCK_ENABLED_##__STATE] = __stringify(__STATE)"-ON-W", \
450 [LOCK_USED_IN_##__STATE##_READ] = "IN-"__stringify(__STATE)"-R",\
451 [LOCK_ENABLED_##__STATE##_READ] = __stringify(__STATE)"-ON-R",
453 static const char *usage_str[] =
455 #define LOCKDEP_STATE(__STATE) __USAGE(__STATE)
456 #include "lockdep_states.h"
458 [LOCK_USED] = "INITIAL USE",
461 const char * __get_key_name(struct lockdep_subclass_key *key, char *str)
463 return kallsyms_lookup((unsigned long)key, NULL, NULL, NULL, str);
466 static inline unsigned long lock_flag(enum lock_usage_bit bit)
471 static char get_usage_char(struct lock_class *class, enum lock_usage_bit bit)
475 if (class->usage_mask & lock_flag(bit + 2))
477 if (class->usage_mask & lock_flag(bit)) {
479 if (class->usage_mask & lock_flag(bit + 2))
486 void get_usage_chars(struct lock_class *class, char usage[LOCK_USAGE_CHARS])
490 #define LOCKDEP_STATE(__STATE) \
491 usage[i++] = get_usage_char(class, LOCK_USED_IN_##__STATE); \
492 usage[i++] = get_usage_char(class, LOCK_USED_IN_##__STATE##_READ);
493 #include "lockdep_states.h"
499 static void __print_lock_name(struct lock_class *class)
501 char str[KSYM_NAME_LEN];
506 name = __get_key_name(class->key, str);
507 printk(KERN_CONT "%s", name);
509 printk(KERN_CONT "%s", name);
510 if (class->name_version > 1)
511 printk(KERN_CONT "#%d", class->name_version);
513 printk(KERN_CONT "/%d", class->subclass);
517 static void print_lock_name(struct lock_class *class)
519 char usage[LOCK_USAGE_CHARS];
521 get_usage_chars(class, usage);
523 printk(KERN_CONT " (");
524 __print_lock_name(class);
525 printk(KERN_CONT "){%s}", usage);
528 static void print_lockdep_cache(struct lockdep_map *lock)
531 char str[KSYM_NAME_LEN];
535 name = __get_key_name(lock->key->subkeys, str);
537 printk(KERN_CONT "%s", name);
540 static void print_lock(struct held_lock *hlock)
543 * We can be called locklessly through debug_show_all_locks() so be
544 * extra careful, the hlock might have been released and cleared.
546 unsigned int class_idx = hlock->class_idx;
548 /* Don't re-read hlock->class_idx, can't use READ_ONCE() on bitfields: */
551 if (!class_idx || (class_idx - 1) >= MAX_LOCKDEP_KEYS) {
552 printk(KERN_CONT "<RELEASED>\n");
556 printk(KERN_CONT "%p", hlock->instance);
557 print_lock_name(lock_classes + class_idx - 1);
558 printk(KERN_CONT ", at: %pS\n", (void *)hlock->acquire_ip);
561 static void lockdep_print_held_locks(struct task_struct *p)
563 int i, depth = READ_ONCE(p->lockdep_depth);
566 printk("no locks held by %s/%d.\n", p->comm, task_pid_nr(p));
568 printk("%d lock%s held by %s/%d:\n", depth,
569 depth > 1 ? "s" : "", p->comm, task_pid_nr(p));
571 * It's not reliable to print a task's held locks if it's not sleeping
572 * and it's not the current task.
574 if (p->state == TASK_RUNNING && p != current)
576 for (i = 0; i < depth; i++) {
578 print_lock(p->held_locks + i);
582 static void print_kernel_ident(void)
584 printk("%s %.*s %s\n", init_utsname()->release,
585 (int)strcspn(init_utsname()->version, " "),
586 init_utsname()->version,
590 static int very_verbose(struct lock_class *class)
593 return class_filter(class);
599 * Is this the address of a static object:
602 static int static_obj(void *obj)
604 unsigned long start = (unsigned long) &_stext,
605 end = (unsigned long) &_end,
606 addr = (unsigned long) obj;
611 if ((addr >= start) && (addr < end))
614 if (arch_is_kernel_data(addr))
618 * in-kernel percpu var?
620 if (is_kernel_percpu_address(addr))
624 * module static or percpu var?
626 return is_module_address(addr) || is_module_percpu_address(addr);
631 * To make lock name printouts unique, we calculate a unique
632 * class->name_version generation counter. The caller must hold the graph
635 static int count_matching_names(struct lock_class *new_class)
637 struct lock_class *class;
640 if (!new_class->name)
643 list_for_each_entry(class, &all_lock_classes, lock_entry) {
644 if (new_class->key - new_class->subclass == class->key)
645 return class->name_version;
646 if (class->name && !strcmp(class->name, new_class->name))
647 count = max(count, class->name_version);
653 static inline struct lock_class *
654 look_up_lock_class(const struct lockdep_map *lock, unsigned int subclass)
656 struct lockdep_subclass_key *key;
657 struct hlist_head *hash_head;
658 struct lock_class *class;
660 if (unlikely(subclass >= MAX_LOCKDEP_SUBCLASSES)) {
663 "BUG: looking up invalid subclass: %u\n", subclass);
665 "turning off the locking correctness validator.\n");
671 * If it is not initialised then it has never been locked,
672 * so it won't be present in the hash table.
674 if (unlikely(!lock->key))
678 * NOTE: the class-key must be unique. For dynamic locks, a static
679 * lock_class_key variable is passed in through the mutex_init()
680 * (or spin_lock_init()) call - which acts as the key. For static
681 * locks we use the lock object itself as the key.
683 BUILD_BUG_ON(sizeof(struct lock_class_key) >
684 sizeof(struct lockdep_map));
686 key = lock->key->subkeys + subclass;
688 hash_head = classhashentry(key);
691 * We do an RCU walk of the hash, see lockdep_free_key_range().
693 if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
696 hlist_for_each_entry_rcu(class, hash_head, hash_entry) {
697 if (class->key == key) {
699 * Huh! same key, different name? Did someone trample
700 * on some memory? We're most confused.
702 WARN_ON_ONCE(class->name != lock->name);
711 * Static locks do not have their class-keys yet - for them the key is
712 * the lock object itself. If the lock is in the per cpu area, the
713 * canonical address of the lock (per cpu offset removed) is used.
715 static bool assign_lock_key(struct lockdep_map *lock)
717 unsigned long can_addr, addr = (unsigned long)lock;
719 if (__is_kernel_percpu_address(addr, &can_addr))
720 lock->key = (void *)can_addr;
721 else if (__is_module_percpu_address(addr, &can_addr))
722 lock->key = (void *)can_addr;
723 else if (static_obj(lock))
724 lock->key = (void *)lock;
726 /* Debug-check: all keys must be persistent! */
728 pr_err("INFO: trying to register non-static key.\n");
729 pr_err("the code is fine but needs lockdep annotation.\n");
730 pr_err("turning off the locking correctness validator.\n");
739 * Register a lock's class in the hash-table, if the class is not present
740 * yet. Otherwise we look it up. We cache the result in the lock object
741 * itself, so actual lookup of the hash should be once per lock object.
743 static struct lock_class *
744 register_lock_class(struct lockdep_map *lock, unsigned int subclass, int force)
746 struct lockdep_subclass_key *key;
747 struct hlist_head *hash_head;
748 struct lock_class *class;
750 DEBUG_LOCKS_WARN_ON(!irqs_disabled());
752 class = look_up_lock_class(lock, subclass);
754 goto out_set_class_cache;
757 if (!assign_lock_key(lock))
759 } else if (!static_obj(lock->key)) {
763 key = lock->key->subkeys + subclass;
764 hash_head = classhashentry(key);
770 * We have to do the hash-walk again, to avoid races
773 hlist_for_each_entry_rcu(class, hash_head, hash_entry) {
774 if (class->key == key)
779 * Allocate a new key from the static array, and add it to
782 if (nr_lock_classes >= MAX_LOCKDEP_KEYS) {
783 if (!debug_locks_off_graph_unlock()) {
787 print_lockdep_off("BUG: MAX_LOCKDEP_KEYS too low!");
791 class = lock_classes + nr_lock_classes++;
792 debug_atomic_inc(nr_unused_locks);
794 class->name = lock->name;
795 class->subclass = subclass;
796 INIT_LIST_HEAD(&class->locks_before);
797 INIT_LIST_HEAD(&class->locks_after);
798 class->name_version = count_matching_names(class);
800 * We use RCU's safe list-add method to make
801 * parallel walking of the hash-list safe:
803 hlist_add_head_rcu(&class->hash_entry, hash_head);
805 * Add it to the global list of classes:
807 list_add_tail(&class->lock_entry, &all_lock_classes);
809 if (verbose(class)) {
812 printk("\nnew class %px: %s", class->key, class->name);
813 if (class->name_version > 1)
814 printk(KERN_CONT "#%d", class->name_version);
815 printk(KERN_CONT "\n");
826 if (!subclass || force)
827 lock->class_cache[0] = class;
828 else if (subclass < NR_LOCKDEP_CACHING_CLASSES)
829 lock->class_cache[subclass] = class;
832 * Hash collision, did we smoke some? We found a class with a matching
833 * hash but the subclass -- which is hashed in -- didn't match.
835 if (DEBUG_LOCKS_WARN_ON(class->subclass != subclass))
841 #ifdef CONFIG_PROVE_LOCKING
843 * Allocate a lockdep entry. (assumes the graph_lock held, returns
844 * with NULL on failure)
846 static struct lock_list *alloc_list_entry(void)
848 if (nr_list_entries >= MAX_LOCKDEP_ENTRIES) {
849 if (!debug_locks_off_graph_unlock())
852 print_lockdep_off("BUG: MAX_LOCKDEP_ENTRIES too low!");
856 return list_entries + nr_list_entries++;
860 * Add a new dependency to the head of the list:
862 static int add_lock_to_list(struct lock_class *this, struct list_head *head,
863 unsigned long ip, int distance,
864 struct stack_trace *trace)
866 struct lock_list *entry;
868 * Lock not present yet - get a new dependency struct and
869 * add it to the list:
871 entry = alloc_list_entry();
876 entry->distance = distance;
877 entry->trace = *trace;
879 * Both allocation and removal are done under the graph lock; but
880 * iteration is under RCU-sched; see look_up_lock_class() and
881 * lockdep_free_key_range().
883 list_add_tail_rcu(&entry->entry, head);
889 * For good efficiency of modular, we use power of 2
891 #define MAX_CIRCULAR_QUEUE_SIZE 4096UL
892 #define CQ_MASK (MAX_CIRCULAR_QUEUE_SIZE-1)
895 * The circular_queue and helpers is used to implement the
896 * breadth-first search(BFS)algorithem, by which we can build
897 * the shortest path from the next lock to be acquired to the
898 * previous held lock if there is a circular between them.
900 struct circular_queue {
901 unsigned long element[MAX_CIRCULAR_QUEUE_SIZE];
902 unsigned int front, rear;
905 static struct circular_queue lock_cq;
907 unsigned int max_bfs_queue_depth;
909 static unsigned int lockdep_dependency_gen_id;
911 static inline void __cq_init(struct circular_queue *cq)
913 cq->front = cq->rear = 0;
914 lockdep_dependency_gen_id++;
917 static inline int __cq_empty(struct circular_queue *cq)
919 return (cq->front == cq->rear);
922 static inline int __cq_full(struct circular_queue *cq)
924 return ((cq->rear + 1) & CQ_MASK) == cq->front;
927 static inline int __cq_enqueue(struct circular_queue *cq, unsigned long elem)
932 cq->element[cq->rear] = elem;
933 cq->rear = (cq->rear + 1) & CQ_MASK;
937 static inline int __cq_dequeue(struct circular_queue *cq, unsigned long *elem)
942 *elem = cq->element[cq->front];
943 cq->front = (cq->front + 1) & CQ_MASK;
947 static inline unsigned int __cq_get_elem_count(struct circular_queue *cq)
949 return (cq->rear - cq->front) & CQ_MASK;
952 static inline void mark_lock_accessed(struct lock_list *lock,
953 struct lock_list *parent)
957 nr = lock - list_entries;
958 WARN_ON(nr >= nr_list_entries); /* Out-of-bounds, input fail */
959 lock->parent = parent;
960 lock->class->dep_gen_id = lockdep_dependency_gen_id;
963 static inline unsigned long lock_accessed(struct lock_list *lock)
967 nr = lock - list_entries;
968 WARN_ON(nr >= nr_list_entries); /* Out-of-bounds, input fail */
969 return lock->class->dep_gen_id == lockdep_dependency_gen_id;
972 static inline struct lock_list *get_lock_parent(struct lock_list *child)
974 return child->parent;
977 static inline int get_lock_depth(struct lock_list *child)
980 struct lock_list *parent;
982 while ((parent = get_lock_parent(child))) {
989 static int __bfs(struct lock_list *source_entry,
991 int (*match)(struct lock_list *entry, void *data),
992 struct lock_list **target_entry,
995 struct lock_list *entry;
996 struct list_head *head;
997 struct circular_queue *cq = &lock_cq;
1000 if (match(source_entry, data)) {
1001 *target_entry = source_entry;
1007 head = &source_entry->class->locks_after;
1009 head = &source_entry->class->locks_before;
1011 if (list_empty(head))
1015 __cq_enqueue(cq, (unsigned long)source_entry);
1017 while (!__cq_empty(cq)) {
1018 struct lock_list *lock;
1020 __cq_dequeue(cq, (unsigned long *)&lock);
1028 head = &lock->class->locks_after;
1030 head = &lock->class->locks_before;
1032 DEBUG_LOCKS_WARN_ON(!irqs_disabled());
1034 list_for_each_entry_rcu(entry, head, entry) {
1035 if (!lock_accessed(entry)) {
1036 unsigned int cq_depth;
1037 mark_lock_accessed(entry, lock);
1038 if (match(entry, data)) {
1039 *target_entry = entry;
1044 if (__cq_enqueue(cq, (unsigned long)entry)) {
1048 cq_depth = __cq_get_elem_count(cq);
1049 if (max_bfs_queue_depth < cq_depth)
1050 max_bfs_queue_depth = cq_depth;
1058 static inline int __bfs_forwards(struct lock_list *src_entry,
1060 int (*match)(struct lock_list *entry, void *data),
1061 struct lock_list **target_entry)
1063 return __bfs(src_entry, data, match, target_entry, 1);
1067 static inline int __bfs_backwards(struct lock_list *src_entry,
1069 int (*match)(struct lock_list *entry, void *data),
1070 struct lock_list **target_entry)
1072 return __bfs(src_entry, data, match, target_entry, 0);
1077 * Recursive, forwards-direction lock-dependency checking, used for
1078 * both noncyclic checking and for hardirq-unsafe/softirq-unsafe
1083 * Print a dependency chain entry (this is only done when a deadlock
1084 * has been detected):
1087 print_circular_bug_entry(struct lock_list *target, int depth)
1089 if (debug_locks_silent)
1091 printk("\n-> #%u", depth);
1092 print_lock_name(target->class);
1093 printk(KERN_CONT ":\n");
1094 print_stack_trace(&target->trace, 6);
1100 print_circular_lock_scenario(struct held_lock *src,
1101 struct held_lock *tgt,
1102 struct lock_list *prt)
1104 struct lock_class *source = hlock_class(src);
1105 struct lock_class *target = hlock_class(tgt);
1106 struct lock_class *parent = prt->class;
1109 * A direct locking problem where unsafe_class lock is taken
1110 * directly by safe_class lock, then all we need to show
1111 * is the deadlock scenario, as it is obvious that the
1112 * unsafe lock is taken under the safe lock.
1114 * But if there is a chain instead, where the safe lock takes
1115 * an intermediate lock (middle_class) where this lock is
1116 * not the same as the safe lock, then the lock chain is
1117 * used to describe the problem. Otherwise we would need
1118 * to show a different CPU case for each link in the chain
1119 * from the safe_class lock to the unsafe_class lock.
1121 if (parent != source) {
1122 printk("Chain exists of:\n ");
1123 __print_lock_name(source);
1124 printk(KERN_CONT " --> ");
1125 __print_lock_name(parent);
1126 printk(KERN_CONT " --> ");
1127 __print_lock_name(target);
1128 printk(KERN_CONT "\n\n");
1131 printk(" Possible unsafe locking scenario:\n\n");
1132 printk(" CPU0 CPU1\n");
1133 printk(" ---- ----\n");
1135 __print_lock_name(target);
1136 printk(KERN_CONT ");\n");
1138 __print_lock_name(parent);
1139 printk(KERN_CONT ");\n");
1141 __print_lock_name(target);
1142 printk(KERN_CONT ");\n");
1144 __print_lock_name(source);
1145 printk(KERN_CONT ");\n");
1146 printk("\n *** DEADLOCK ***\n\n");
1150 * When a circular dependency is detected, print the
1154 print_circular_bug_header(struct lock_list *entry, unsigned int depth,
1155 struct held_lock *check_src,
1156 struct held_lock *check_tgt)
1158 struct task_struct *curr = current;
1160 if (debug_locks_silent)
1164 pr_warn("======================================================\n");
1165 pr_warn("WARNING: possible circular locking dependency detected\n");
1166 print_kernel_ident();
1167 pr_warn("------------------------------------------------------\n");
1168 pr_warn("%s/%d is trying to acquire lock:\n",
1169 curr->comm, task_pid_nr(curr));
1170 print_lock(check_src);
1172 pr_warn("\nbut task is already holding lock:\n");
1174 print_lock(check_tgt);
1175 pr_warn("\nwhich lock already depends on the new lock.\n\n");
1176 pr_warn("\nthe existing dependency chain (in reverse order) is:\n");
1178 print_circular_bug_entry(entry, depth);
1183 static inline int class_equal(struct lock_list *entry, void *data)
1185 return entry->class == data;
1188 static noinline int print_circular_bug(struct lock_list *this,
1189 struct lock_list *target,
1190 struct held_lock *check_src,
1191 struct held_lock *check_tgt,
1192 struct stack_trace *trace)
1194 struct task_struct *curr = current;
1195 struct lock_list *parent;
1196 struct lock_list *first_parent;
1199 if (!debug_locks_off_graph_unlock() || debug_locks_silent)
1202 if (!save_trace(&this->trace))
1205 depth = get_lock_depth(target);
1207 print_circular_bug_header(target, depth, check_src, check_tgt);
1209 parent = get_lock_parent(target);
1210 first_parent = parent;
1213 print_circular_bug_entry(parent, --depth);
1214 parent = get_lock_parent(parent);
1217 printk("\nother info that might help us debug this:\n\n");
1218 print_circular_lock_scenario(check_src, check_tgt,
1221 lockdep_print_held_locks(curr);
1223 printk("\nstack backtrace:\n");
1229 static noinline int print_bfs_bug(int ret)
1231 if (!debug_locks_off_graph_unlock())
1235 * Breadth-first-search failed, graph got corrupted?
1237 WARN(1, "lockdep bfs error:%d\n", ret);
1242 static int noop_count(struct lock_list *entry, void *data)
1244 (*(unsigned long *)data)++;
1248 static unsigned long __lockdep_count_forward_deps(struct lock_list *this)
1250 unsigned long count = 0;
1251 struct lock_list *uninitialized_var(target_entry);
1253 __bfs_forwards(this, (void *)&count, noop_count, &target_entry);
1257 unsigned long lockdep_count_forward_deps(struct lock_class *class)
1259 unsigned long ret, flags;
1260 struct lock_list this;
1265 raw_local_irq_save(flags);
1266 arch_spin_lock(&lockdep_lock);
1267 ret = __lockdep_count_forward_deps(&this);
1268 arch_spin_unlock(&lockdep_lock);
1269 raw_local_irq_restore(flags);
1274 static unsigned long __lockdep_count_backward_deps(struct lock_list *this)
1276 unsigned long count = 0;
1277 struct lock_list *uninitialized_var(target_entry);
1279 __bfs_backwards(this, (void *)&count, noop_count, &target_entry);
1284 unsigned long lockdep_count_backward_deps(struct lock_class *class)
1286 unsigned long ret, flags;
1287 struct lock_list this;
1292 raw_local_irq_save(flags);
1293 arch_spin_lock(&lockdep_lock);
1294 ret = __lockdep_count_backward_deps(&this);
1295 arch_spin_unlock(&lockdep_lock);
1296 raw_local_irq_restore(flags);
1302 * Prove that the dependency graph starting at <entry> can not
1303 * lead to <target>. Print an error and return 0 if it does.
1306 check_noncircular(struct lock_list *root, struct lock_class *target,
1307 struct lock_list **target_entry)
1311 debug_atomic_inc(nr_cyclic_checks);
1313 result = __bfs_forwards(root, target, class_equal, target_entry);
1319 check_redundant(struct lock_list *root, struct lock_class *target,
1320 struct lock_list **target_entry)
1324 debug_atomic_inc(nr_redundant_checks);
1326 result = __bfs_forwards(root, target, class_equal, target_entry);
1331 #if defined(CONFIG_TRACE_IRQFLAGS) && defined(CONFIG_PROVE_LOCKING)
1333 * Forwards and backwards subgraph searching, for the purposes of
1334 * proving that two subgraphs can be connected by a new dependency
1335 * without creating any illegal irq-safe -> irq-unsafe lock dependency.
1338 static inline int usage_match(struct lock_list *entry, void *bit)
1340 return entry->class->usage_mask & (1 << (enum lock_usage_bit)bit);
1346 * Find a node in the forwards-direction dependency sub-graph starting
1347 * at @root->class that matches @bit.
1349 * Return 0 if such a node exists in the subgraph, and put that node
1350 * into *@target_entry.
1352 * Return 1 otherwise and keep *@target_entry unchanged.
1353 * Return <0 on error.
1356 find_usage_forwards(struct lock_list *root, enum lock_usage_bit bit,
1357 struct lock_list **target_entry)
1361 debug_atomic_inc(nr_find_usage_forwards_checks);
1363 result = __bfs_forwards(root, (void *)bit, usage_match, target_entry);
1369 * Find a node in the backwards-direction dependency sub-graph starting
1370 * at @root->class that matches @bit.
1372 * Return 0 if such a node exists in the subgraph, and put that node
1373 * into *@target_entry.
1375 * Return 1 otherwise and keep *@target_entry unchanged.
1376 * Return <0 on error.
1379 find_usage_backwards(struct lock_list *root, enum lock_usage_bit bit,
1380 struct lock_list **target_entry)
1384 debug_atomic_inc(nr_find_usage_backwards_checks);
1386 result = __bfs_backwards(root, (void *)bit, usage_match, target_entry);
1391 static void print_lock_class_header(struct lock_class *class, int depth)
1395 printk("%*s->", depth, "");
1396 print_lock_name(class);
1397 #ifdef CONFIG_DEBUG_LOCKDEP
1398 printk(KERN_CONT " ops: %lu", debug_class_ops_read(class));
1400 printk(KERN_CONT " {\n");
1402 for (bit = 0; bit < LOCK_USAGE_STATES; bit++) {
1403 if (class->usage_mask & (1 << bit)) {
1406 len += printk("%*s %s", depth, "", usage_str[bit]);
1407 len += printk(KERN_CONT " at:\n");
1408 print_stack_trace(class->usage_traces + bit, len);
1411 printk("%*s }\n", depth, "");
1413 printk("%*s ... key at: [<%px>] %pS\n",
1414 depth, "", class->key, class->key);
1418 * printk the shortest lock dependencies from @start to @end in reverse order:
1421 print_shortest_lock_dependencies(struct lock_list *leaf,
1422 struct lock_list *root)
1424 struct lock_list *entry = leaf;
1427 /*compute depth from generated tree by BFS*/
1428 depth = get_lock_depth(leaf);
1431 print_lock_class_header(entry->class, depth);
1432 printk("%*s ... acquired at:\n", depth, "");
1433 print_stack_trace(&entry->trace, 2);
1436 if (depth == 0 && (entry != root)) {
1437 printk("lockdep:%s bad path found in chain graph\n", __func__);
1441 entry = get_lock_parent(entry);
1443 } while (entry && (depth >= 0));
1449 print_irq_lock_scenario(struct lock_list *safe_entry,
1450 struct lock_list *unsafe_entry,
1451 struct lock_class *prev_class,
1452 struct lock_class *next_class)
1454 struct lock_class *safe_class = safe_entry->class;
1455 struct lock_class *unsafe_class = unsafe_entry->class;
1456 struct lock_class *middle_class = prev_class;
1458 if (middle_class == safe_class)
1459 middle_class = next_class;
1462 * A direct locking problem where unsafe_class lock is taken
1463 * directly by safe_class lock, then all we need to show
1464 * is the deadlock scenario, as it is obvious that the
1465 * unsafe lock is taken under the safe lock.
1467 * But if there is a chain instead, where the safe lock takes
1468 * an intermediate lock (middle_class) where this lock is
1469 * not the same as the safe lock, then the lock chain is
1470 * used to describe the problem. Otherwise we would need
1471 * to show a different CPU case for each link in the chain
1472 * from the safe_class lock to the unsafe_class lock.
1474 if (middle_class != unsafe_class) {
1475 printk("Chain exists of:\n ");
1476 __print_lock_name(safe_class);
1477 printk(KERN_CONT " --> ");
1478 __print_lock_name(middle_class);
1479 printk(KERN_CONT " --> ");
1480 __print_lock_name(unsafe_class);
1481 printk(KERN_CONT "\n\n");
1484 printk(" Possible interrupt unsafe locking scenario:\n\n");
1485 printk(" CPU0 CPU1\n");
1486 printk(" ---- ----\n");
1488 __print_lock_name(unsafe_class);
1489 printk(KERN_CONT ");\n");
1490 printk(" local_irq_disable();\n");
1492 __print_lock_name(safe_class);
1493 printk(KERN_CONT ");\n");
1495 __print_lock_name(middle_class);
1496 printk(KERN_CONT ");\n");
1497 printk(" <Interrupt>\n");
1499 __print_lock_name(safe_class);
1500 printk(KERN_CONT ");\n");
1501 printk("\n *** DEADLOCK ***\n\n");
1505 print_bad_irq_dependency(struct task_struct *curr,
1506 struct lock_list *prev_root,
1507 struct lock_list *next_root,
1508 struct lock_list *backwards_entry,
1509 struct lock_list *forwards_entry,
1510 struct held_lock *prev,
1511 struct held_lock *next,
1512 enum lock_usage_bit bit1,
1513 enum lock_usage_bit bit2,
1514 const char *irqclass)
1516 if (!debug_locks_off_graph_unlock() || debug_locks_silent)
1520 pr_warn("=====================================================\n");
1521 pr_warn("WARNING: %s-safe -> %s-unsafe lock order detected\n",
1522 irqclass, irqclass);
1523 print_kernel_ident();
1524 pr_warn("-----------------------------------------------------\n");
1525 pr_warn("%s/%d [HC%u[%lu]:SC%u[%lu]:HE%u:SE%u] is trying to acquire:\n",
1526 curr->comm, task_pid_nr(curr),
1527 curr->hardirq_context, hardirq_count() >> HARDIRQ_SHIFT,
1528 curr->softirq_context, softirq_count() >> SOFTIRQ_SHIFT,
1529 curr->hardirqs_enabled,
1530 curr->softirqs_enabled);
1533 pr_warn("\nand this task is already holding:\n");
1535 pr_warn("which would create a new lock dependency:\n");
1536 print_lock_name(hlock_class(prev));
1538 print_lock_name(hlock_class(next));
1541 pr_warn("\nbut this new dependency connects a %s-irq-safe lock:\n",
1543 print_lock_name(backwards_entry->class);
1544 pr_warn("\n... which became %s-irq-safe at:\n", irqclass);
1546 print_stack_trace(backwards_entry->class->usage_traces + bit1, 1);
1548 pr_warn("\nto a %s-irq-unsafe lock:\n", irqclass);
1549 print_lock_name(forwards_entry->class);
1550 pr_warn("\n... which became %s-irq-unsafe at:\n", irqclass);
1553 print_stack_trace(forwards_entry->class->usage_traces + bit2, 1);
1555 pr_warn("\nother info that might help us debug this:\n\n");
1556 print_irq_lock_scenario(backwards_entry, forwards_entry,
1557 hlock_class(prev), hlock_class(next));
1559 lockdep_print_held_locks(curr);
1561 pr_warn("\nthe dependencies between %s-irq-safe lock and the holding lock:\n", irqclass);
1562 if (!save_trace(&prev_root->trace))
1564 print_shortest_lock_dependencies(backwards_entry, prev_root);
1566 pr_warn("\nthe dependencies between the lock to be acquired");
1567 pr_warn(" and %s-irq-unsafe lock:\n", irqclass);
1568 if (!save_trace(&next_root->trace))
1570 print_shortest_lock_dependencies(forwards_entry, next_root);
1572 pr_warn("\nstack backtrace:\n");
1579 check_usage(struct task_struct *curr, struct held_lock *prev,
1580 struct held_lock *next, enum lock_usage_bit bit_backwards,
1581 enum lock_usage_bit bit_forwards, const char *irqclass)
1584 struct lock_list this, that;
1585 struct lock_list *uninitialized_var(target_entry);
1586 struct lock_list *uninitialized_var(target_entry1);
1590 this.class = hlock_class(prev);
1591 ret = find_usage_backwards(&this, bit_backwards, &target_entry);
1593 return print_bfs_bug(ret);
1598 that.class = hlock_class(next);
1599 ret = find_usage_forwards(&that, bit_forwards, &target_entry1);
1601 return print_bfs_bug(ret);
1605 return print_bad_irq_dependency(curr, &this, &that,
1606 target_entry, target_entry1,
1608 bit_backwards, bit_forwards, irqclass);
1611 static const char *state_names[] = {
1612 #define LOCKDEP_STATE(__STATE) \
1613 __stringify(__STATE),
1614 #include "lockdep_states.h"
1615 #undef LOCKDEP_STATE
1618 static const char *state_rnames[] = {
1619 #define LOCKDEP_STATE(__STATE) \
1620 __stringify(__STATE)"-READ",
1621 #include "lockdep_states.h"
1622 #undef LOCKDEP_STATE
1625 static inline const char *state_name(enum lock_usage_bit bit)
1627 return (bit & 1) ? state_rnames[bit >> 2] : state_names[bit >> 2];
1630 static int exclusive_bit(int new_bit)
1638 * bit 0 - write/read
1639 * bit 1 - used_in/enabled
1643 int state = new_bit & ~3;
1644 int dir = new_bit & 2;
1647 * keep state, bit flip the direction and strip read.
1649 return state | (dir ^ 2);
1652 static int check_irq_usage(struct task_struct *curr, struct held_lock *prev,
1653 struct held_lock *next, enum lock_usage_bit bit)
1656 * Prove that the new dependency does not connect a hardirq-safe
1657 * lock with a hardirq-unsafe lock - to achieve this we search
1658 * the backwards-subgraph starting at <prev>, and the
1659 * forwards-subgraph starting at <next>:
1661 if (!check_usage(curr, prev, next, bit,
1662 exclusive_bit(bit), state_name(bit)))
1668 * Prove that the new dependency does not connect a hardirq-safe-read
1669 * lock with a hardirq-unsafe lock - to achieve this we search
1670 * the backwards-subgraph starting at <prev>, and the
1671 * forwards-subgraph starting at <next>:
1673 if (!check_usage(curr, prev, next, bit,
1674 exclusive_bit(bit), state_name(bit)))
1681 check_prev_add_irq(struct task_struct *curr, struct held_lock *prev,
1682 struct held_lock *next)
1684 #define LOCKDEP_STATE(__STATE) \
1685 if (!check_irq_usage(curr, prev, next, LOCK_USED_IN_##__STATE)) \
1687 #include "lockdep_states.h"
1688 #undef LOCKDEP_STATE
1693 static void inc_chains(void)
1695 if (current->hardirq_context)
1696 nr_hardirq_chains++;
1698 if (current->softirq_context)
1699 nr_softirq_chains++;
1701 nr_process_chains++;
1708 check_prev_add_irq(struct task_struct *curr, struct held_lock *prev,
1709 struct held_lock *next)
1714 static inline void inc_chains(void)
1716 nr_process_chains++;
1722 print_deadlock_scenario(struct held_lock *nxt,
1723 struct held_lock *prv)
1725 struct lock_class *next = hlock_class(nxt);
1726 struct lock_class *prev = hlock_class(prv);
1728 printk(" Possible unsafe locking scenario:\n\n");
1732 __print_lock_name(prev);
1733 printk(KERN_CONT ");\n");
1735 __print_lock_name(next);
1736 printk(KERN_CONT ");\n");
1737 printk("\n *** DEADLOCK ***\n\n");
1738 printk(" May be due to missing lock nesting notation\n\n");
1742 print_deadlock_bug(struct task_struct *curr, struct held_lock *prev,
1743 struct held_lock *next)
1745 if (!debug_locks_off_graph_unlock() || debug_locks_silent)
1749 pr_warn("============================================\n");
1750 pr_warn("WARNING: possible recursive locking detected\n");
1751 print_kernel_ident();
1752 pr_warn("--------------------------------------------\n");
1753 pr_warn("%s/%d is trying to acquire lock:\n",
1754 curr->comm, task_pid_nr(curr));
1756 pr_warn("\nbut task is already holding lock:\n");
1759 pr_warn("\nother info that might help us debug this:\n");
1760 print_deadlock_scenario(next, prev);
1761 lockdep_print_held_locks(curr);
1763 pr_warn("\nstack backtrace:\n");
1770 * Check whether we are holding such a class already.
1772 * (Note that this has to be done separately, because the graph cannot
1773 * detect such classes of deadlocks.)
1775 * Returns: 0 on deadlock detected, 1 on OK, 2 on recursive read
1778 check_deadlock(struct task_struct *curr, struct held_lock *next,
1779 struct lockdep_map *next_instance, int read)
1781 struct held_lock *prev;
1782 struct held_lock *nest = NULL;
1785 for (i = 0; i < curr->lockdep_depth; i++) {
1786 prev = curr->held_locks + i;
1788 if (prev->instance == next->nest_lock)
1791 if (hlock_class(prev) != hlock_class(next))
1795 * Allow read-after-read recursion of the same
1796 * lock class (i.e. read_lock(lock)+read_lock(lock)):
1798 if ((read == 2) && prev->read)
1802 * We're holding the nest_lock, which serializes this lock's
1803 * nesting behaviour.
1808 return print_deadlock_bug(curr, prev, next);
1814 * There was a chain-cache miss, and we are about to add a new dependency
1815 * to a previous lock. We recursively validate the following rules:
1817 * - would the adding of the <prev> -> <next> dependency create a
1818 * circular dependency in the graph? [== circular deadlock]
1820 * - does the new prev->next dependency connect any hardirq-safe lock
1821 * (in the full backwards-subgraph starting at <prev>) with any
1822 * hardirq-unsafe lock (in the full forwards-subgraph starting at
1823 * <next>)? [== illegal lock inversion with hardirq contexts]
1825 * - does the new prev->next dependency connect any softirq-safe lock
1826 * (in the full backwards-subgraph starting at <prev>) with any
1827 * softirq-unsafe lock (in the full forwards-subgraph starting at
1828 * <next>)? [== illegal lock inversion with softirq contexts]
1830 * any of these scenarios could lead to a deadlock.
1832 * Then if all the validations pass, we add the forwards and backwards
1836 check_prev_add(struct task_struct *curr, struct held_lock *prev,
1837 struct held_lock *next, int distance, struct stack_trace *trace,
1838 int (*save)(struct stack_trace *trace))
1840 struct lock_list *uninitialized_var(target_entry);
1841 struct lock_list *entry;
1842 struct lock_list this;
1846 * Prove that the new <prev> -> <next> dependency would not
1847 * create a circular dependency in the graph. (We do this by
1848 * forward-recursing into the graph starting at <next>, and
1849 * checking whether we can reach <prev>.)
1851 * We are using global variables to control the recursion, to
1852 * keep the stackframe size of the recursive functions low:
1854 this.class = hlock_class(next);
1856 ret = check_noncircular(&this, hlock_class(prev), &target_entry);
1857 if (unlikely(!ret)) {
1858 if (!trace->entries) {
1860 * If @save fails here, the printing might trigger
1861 * a WARN but because of the !nr_entries it should
1862 * not do bad things.
1866 return print_circular_bug(&this, target_entry, next, prev, trace);
1868 else if (unlikely(ret < 0))
1869 return print_bfs_bug(ret);
1871 if (!check_prev_add_irq(curr, prev, next))
1875 * For recursive read-locks we do all the dependency checks,
1876 * but we dont store read-triggered dependencies (only
1877 * write-triggered dependencies). This ensures that only the
1878 * write-side dependencies matter, and that if for example a
1879 * write-lock never takes any other locks, then the reads are
1880 * equivalent to a NOP.
1882 if (next->read == 2 || prev->read == 2)
1885 * Is the <prev> -> <next> dependency already present?
1887 * (this may occur even though this is a new chain: consider
1888 * e.g. the L1 -> L2 -> L3 -> L4 and the L5 -> L1 -> L2 -> L3
1889 * chains - the second one will be new, but L1 already has
1890 * L2 added to its dependency list, due to the first chain.)
1892 list_for_each_entry(entry, &hlock_class(prev)->locks_after, entry) {
1893 if (entry->class == hlock_class(next)) {
1895 entry->distance = 1;
1901 * Is the <prev> -> <next> link redundant?
1903 this.class = hlock_class(prev);
1905 ret = check_redundant(&this, hlock_class(next), &target_entry);
1907 debug_atomic_inc(nr_redundant);
1911 return print_bfs_bug(ret);
1914 if (!trace->entries && !save(trace))
1918 * Ok, all validations passed, add the new lock
1919 * to the previous lock's dependency list:
1921 ret = add_lock_to_list(hlock_class(next),
1922 &hlock_class(prev)->locks_after,
1923 next->acquire_ip, distance, trace);
1928 ret = add_lock_to_list(hlock_class(prev),
1929 &hlock_class(next)->locks_before,
1930 next->acquire_ip, distance, trace);
1938 * Add the dependency to all directly-previous locks that are 'relevant'.
1939 * The ones that are relevant are (in increasing distance from curr):
1940 * all consecutive trylock entries and the final non-trylock entry - or
1941 * the end of this context's lock-chain - whichever comes first.
1944 check_prevs_add(struct task_struct *curr, struct held_lock *next)
1946 int depth = curr->lockdep_depth;
1947 struct held_lock *hlock;
1948 struct stack_trace trace = {
1958 * Depth must not be zero for a non-head lock:
1963 * At least two relevant locks must exist for this
1966 if (curr->held_locks[depth].irq_context !=
1967 curr->held_locks[depth-1].irq_context)
1971 int distance = curr->lockdep_depth - depth + 1;
1972 hlock = curr->held_locks + depth - 1;
1975 * Only non-recursive-read entries get new dependencies
1978 if (hlock->read != 2 && hlock->check) {
1979 int ret = check_prev_add(curr, hlock, next, distance, &trace, save_trace);
1984 * Stop after the first non-trylock entry,
1985 * as non-trylock entries have added their
1986 * own direct dependencies already, so this
1987 * lock is connected to them indirectly:
1989 if (!hlock->trylock)
1995 * End of lock-stack?
2000 * Stop the search if we cross into another context:
2002 if (curr->held_locks[depth].irq_context !=
2003 curr->held_locks[depth-1].irq_context)
2008 if (!debug_locks_off_graph_unlock())
2012 * Clearly we all shouldn't be here, but since we made it we
2013 * can reliable say we messed up our state. See the above two
2014 * gotos for reasons why we could possibly end up here.
2021 unsigned long nr_lock_chains;
2022 struct lock_chain lock_chains[MAX_LOCKDEP_CHAINS];
2023 int nr_chain_hlocks;
2024 static u16 chain_hlocks[MAX_LOCKDEP_CHAIN_HLOCKS];
2026 struct lock_class *lock_chain_get_class(struct lock_chain *chain, int i)
2028 return lock_classes + chain_hlocks[chain->base + i];
2032 * Returns the index of the first held_lock of the current chain
2034 static inline int get_first_held_lock(struct task_struct *curr,
2035 struct held_lock *hlock)
2038 struct held_lock *hlock_curr;
2040 for (i = curr->lockdep_depth - 1; i >= 0; i--) {
2041 hlock_curr = curr->held_locks + i;
2042 if (hlock_curr->irq_context != hlock->irq_context)
2050 #ifdef CONFIG_DEBUG_LOCKDEP
2052 * Returns the next chain_key iteration
2054 static u64 print_chain_key_iteration(int class_idx, u64 chain_key)
2056 u64 new_chain_key = iterate_chain_key(chain_key, class_idx);
2058 printk(" class_idx:%d -> chain_key:%016Lx",
2060 (unsigned long long)new_chain_key);
2061 return new_chain_key;
2065 print_chain_keys_held_locks(struct task_struct *curr, struct held_lock *hlock_next)
2067 struct held_lock *hlock;
2069 int depth = curr->lockdep_depth;
2072 printk("depth: %u\n", depth + 1);
2073 for (i = get_first_held_lock(curr, hlock_next); i < depth; i++) {
2074 hlock = curr->held_locks + i;
2075 chain_key = print_chain_key_iteration(hlock->class_idx, chain_key);
2080 print_chain_key_iteration(hlock_next->class_idx, chain_key);
2081 print_lock(hlock_next);
2084 static void print_chain_keys_chain(struct lock_chain *chain)
2090 printk("depth: %u\n", chain->depth);
2091 for (i = 0; i < chain->depth; i++) {
2092 class_id = chain_hlocks[chain->base + i];
2093 chain_key = print_chain_key_iteration(class_id + 1, chain_key);
2095 print_lock_name(lock_classes + class_id);
2100 static void print_collision(struct task_struct *curr,
2101 struct held_lock *hlock_next,
2102 struct lock_chain *chain)
2105 pr_warn("============================\n");
2106 pr_warn("WARNING: chain_key collision\n");
2107 print_kernel_ident();
2108 pr_warn("----------------------------\n");
2109 pr_warn("%s/%d: ", current->comm, task_pid_nr(current));
2110 pr_warn("Hash chain already cached but the contents don't match!\n");
2112 pr_warn("Held locks:");
2113 print_chain_keys_held_locks(curr, hlock_next);
2115 pr_warn("Locks in cached chain:");
2116 print_chain_keys_chain(chain);
2118 pr_warn("\nstack backtrace:\n");
2124 * Checks whether the chain and the current held locks are consistent
2125 * in depth and also in content. If they are not it most likely means
2126 * that there was a collision during the calculation of the chain_key.
2127 * Returns: 0 not passed, 1 passed
2129 static int check_no_collision(struct task_struct *curr,
2130 struct held_lock *hlock,
2131 struct lock_chain *chain)
2133 #ifdef CONFIG_DEBUG_LOCKDEP
2136 i = get_first_held_lock(curr, hlock);
2138 if (DEBUG_LOCKS_WARN_ON(chain->depth != curr->lockdep_depth - (i - 1))) {
2139 print_collision(curr, hlock, chain);
2143 for (j = 0; j < chain->depth - 1; j++, i++) {
2144 id = curr->held_locks[i].class_idx - 1;
2146 if (DEBUG_LOCKS_WARN_ON(chain_hlocks[chain->base + j] != id)) {
2147 print_collision(curr, hlock, chain);
2156 * Adds a dependency chain into chain hashtable. And must be called with
2159 * Return 0 if fail, and graph_lock is released.
2160 * Return 1 if succeed, with graph_lock held.
2162 static inline int add_chain_cache(struct task_struct *curr,
2163 struct held_lock *hlock,
2166 struct lock_class *class = hlock_class(hlock);
2167 struct hlist_head *hash_head = chainhashentry(chain_key);
2168 struct lock_chain *chain;
2172 * Allocate a new chain entry from the static array, and add
2177 * We might need to take the graph lock, ensure we've got IRQs
2178 * disabled to make this an IRQ-safe lock.. for recursion reasons
2179 * lockdep won't complain about its own locking errors.
2181 if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
2184 if (unlikely(nr_lock_chains >= MAX_LOCKDEP_CHAINS)) {
2185 if (!debug_locks_off_graph_unlock())
2188 print_lockdep_off("BUG: MAX_LOCKDEP_CHAINS too low!");
2192 chain = lock_chains + nr_lock_chains++;
2193 chain->chain_key = chain_key;
2194 chain->irq_context = hlock->irq_context;
2195 i = get_first_held_lock(curr, hlock);
2196 chain->depth = curr->lockdep_depth + 1 - i;
2198 BUILD_BUG_ON((1UL << 24) <= ARRAY_SIZE(chain_hlocks));
2199 BUILD_BUG_ON((1UL << 6) <= ARRAY_SIZE(curr->held_locks));
2200 BUILD_BUG_ON((1UL << 8*sizeof(chain_hlocks[0])) <= ARRAY_SIZE(lock_classes));
2202 if (likely(nr_chain_hlocks + chain->depth <= MAX_LOCKDEP_CHAIN_HLOCKS)) {
2203 chain->base = nr_chain_hlocks;
2204 for (j = 0; j < chain->depth - 1; j++, i++) {
2205 int lock_id = curr->held_locks[i].class_idx - 1;
2206 chain_hlocks[chain->base + j] = lock_id;
2208 chain_hlocks[chain->base + j] = class - lock_classes;
2211 if (nr_chain_hlocks < MAX_LOCKDEP_CHAIN_HLOCKS)
2212 nr_chain_hlocks += chain->depth;
2214 #ifdef CONFIG_DEBUG_LOCKDEP
2216 * Important for check_no_collision().
2218 if (unlikely(nr_chain_hlocks > MAX_LOCKDEP_CHAIN_HLOCKS)) {
2219 if (!debug_locks_off_graph_unlock())
2222 print_lockdep_off("BUG: MAX_LOCKDEP_CHAIN_HLOCKS too low!");
2228 hlist_add_head_rcu(&chain->entry, hash_head);
2229 debug_atomic_inc(chain_lookup_misses);
2236 * Look up a dependency chain.
2238 static inline struct lock_chain *lookup_chain_cache(u64 chain_key)
2240 struct hlist_head *hash_head = chainhashentry(chain_key);
2241 struct lock_chain *chain;
2244 * We can walk it lock-free, because entries only get added
2247 hlist_for_each_entry_rcu(chain, hash_head, entry) {
2248 if (chain->chain_key == chain_key) {
2249 debug_atomic_inc(chain_lookup_hits);
2257 * If the key is not present yet in dependency chain cache then
2258 * add it and return 1 - in this case the new dependency chain is
2259 * validated. If the key is already hashed, return 0.
2260 * (On return with 1 graph_lock is held.)
2262 static inline int lookup_chain_cache_add(struct task_struct *curr,
2263 struct held_lock *hlock,
2266 struct lock_class *class = hlock_class(hlock);
2267 struct lock_chain *chain = lookup_chain_cache(chain_key);
2271 if (!check_no_collision(curr, hlock, chain))
2274 if (very_verbose(class)) {
2275 printk("\nhash chain already cached, key: "
2276 "%016Lx tail class: [%px] %s\n",
2277 (unsigned long long)chain_key,
2278 class->key, class->name);
2284 if (very_verbose(class)) {
2285 printk("\nnew hash chain, key: %016Lx tail class: [%px] %s\n",
2286 (unsigned long long)chain_key, class->key, class->name);
2293 * We have to walk the chain again locked - to avoid duplicates:
2295 chain = lookup_chain_cache(chain_key);
2301 if (!add_chain_cache(curr, hlock, chain_key))
2307 static int validate_chain(struct task_struct *curr, struct lockdep_map *lock,
2308 struct held_lock *hlock, int chain_head, u64 chain_key)
2311 * Trylock needs to maintain the stack of held locks, but it
2312 * does not add new dependencies, because trylock can be done
2315 * We look up the chain_key and do the O(N^2) check and update of
2316 * the dependencies only if this is a new dependency chain.
2317 * (If lookup_chain_cache_add() return with 1 it acquires
2318 * graph_lock for us)
2320 if (!hlock->trylock && hlock->check &&
2321 lookup_chain_cache_add(curr, hlock, chain_key)) {
2323 * Check whether last held lock:
2325 * - is irq-safe, if this lock is irq-unsafe
2326 * - is softirq-safe, if this lock is hardirq-unsafe
2328 * And check whether the new lock's dependency graph
2329 * could lead back to the previous lock.
2331 * any of these scenarios could lead to a deadlock. If
2334 int ret = check_deadlock(curr, hlock, lock, hlock->read);
2339 * Mark recursive read, as we jump over it when
2340 * building dependencies (just like we jump over
2346 * Add dependency only if this lock is not the head
2347 * of the chain, and if it's not a secondary read-lock:
2349 if (!chain_head && ret != 2) {
2350 if (!check_prevs_add(curr, hlock))
2356 /* after lookup_chain_cache_add(): */
2357 if (unlikely(!debug_locks))
2364 static inline int validate_chain(struct task_struct *curr,
2365 struct lockdep_map *lock, struct held_lock *hlock,
2366 int chain_head, u64 chain_key)
2373 * We are building curr_chain_key incrementally, so double-check
2374 * it from scratch, to make sure that it's done correctly:
2376 static void check_chain_key(struct task_struct *curr)
2378 #ifdef CONFIG_DEBUG_LOCKDEP
2379 struct held_lock *hlock, *prev_hlock = NULL;
2383 for (i = 0; i < curr->lockdep_depth; i++) {
2384 hlock = curr->held_locks + i;
2385 if (chain_key != hlock->prev_chain_key) {
2388 * We got mighty confused, our chain keys don't match
2389 * with what we expect, someone trample on our task state?
2391 WARN(1, "hm#1, depth: %u [%u], %016Lx != %016Lx\n",
2392 curr->lockdep_depth, i,
2393 (unsigned long long)chain_key,
2394 (unsigned long long)hlock->prev_chain_key);
2398 * Whoops ran out of static storage again?
2400 if (DEBUG_LOCKS_WARN_ON(hlock->class_idx > MAX_LOCKDEP_KEYS))
2403 if (prev_hlock && (prev_hlock->irq_context !=
2404 hlock->irq_context))
2406 chain_key = iterate_chain_key(chain_key, hlock->class_idx);
2409 if (chain_key != curr->curr_chain_key) {
2412 * More smoking hash instead of calculating it, damn see these
2413 * numbers float.. I bet that a pink elephant stepped on my memory.
2415 WARN(1, "hm#2, depth: %u [%u], %016Lx != %016Lx\n",
2416 curr->lockdep_depth, i,
2417 (unsigned long long)chain_key,
2418 (unsigned long long)curr->curr_chain_key);
2424 print_usage_bug_scenario(struct held_lock *lock)
2426 struct lock_class *class = hlock_class(lock);
2428 printk(" Possible unsafe locking scenario:\n\n");
2432 __print_lock_name(class);
2433 printk(KERN_CONT ");\n");
2434 printk(" <Interrupt>\n");
2436 __print_lock_name(class);
2437 printk(KERN_CONT ");\n");
2438 printk("\n *** DEADLOCK ***\n\n");
2442 print_usage_bug(struct task_struct *curr, struct held_lock *this,
2443 enum lock_usage_bit prev_bit, enum lock_usage_bit new_bit)
2445 if (!debug_locks_off_graph_unlock() || debug_locks_silent)
2449 pr_warn("================================\n");
2450 pr_warn("WARNING: inconsistent lock state\n");
2451 print_kernel_ident();
2452 pr_warn("--------------------------------\n");
2454 pr_warn("inconsistent {%s} -> {%s} usage.\n",
2455 usage_str[prev_bit], usage_str[new_bit]);
2457 pr_warn("%s/%d [HC%u[%lu]:SC%u[%lu]:HE%u:SE%u] takes:\n",
2458 curr->comm, task_pid_nr(curr),
2459 trace_hardirq_context(curr), hardirq_count() >> HARDIRQ_SHIFT,
2460 trace_softirq_context(curr), softirq_count() >> SOFTIRQ_SHIFT,
2461 trace_hardirqs_enabled(curr),
2462 trace_softirqs_enabled(curr));
2465 pr_warn("{%s} state was registered at:\n", usage_str[prev_bit]);
2466 print_stack_trace(hlock_class(this)->usage_traces + prev_bit, 1);
2468 print_irqtrace_events(curr);
2469 pr_warn("\nother info that might help us debug this:\n");
2470 print_usage_bug_scenario(this);
2472 lockdep_print_held_locks(curr);
2474 pr_warn("\nstack backtrace:\n");
2481 * Print out an error if an invalid bit is set:
2484 valid_state(struct task_struct *curr, struct held_lock *this,
2485 enum lock_usage_bit new_bit, enum lock_usage_bit bad_bit)
2487 if (unlikely(hlock_class(this)->usage_mask & (1 << bad_bit)))
2488 return print_usage_bug(curr, this, bad_bit, new_bit);
2492 static int mark_lock(struct task_struct *curr, struct held_lock *this,
2493 enum lock_usage_bit new_bit);
2495 #if defined(CONFIG_TRACE_IRQFLAGS) && defined(CONFIG_PROVE_LOCKING)
2498 * print irq inversion bug:
2501 print_irq_inversion_bug(struct task_struct *curr,
2502 struct lock_list *root, struct lock_list *other,
2503 struct held_lock *this, int forwards,
2504 const char *irqclass)
2506 struct lock_list *entry = other;
2507 struct lock_list *middle = NULL;
2510 if (!debug_locks_off_graph_unlock() || debug_locks_silent)
2514 pr_warn("========================================================\n");
2515 pr_warn("WARNING: possible irq lock inversion dependency detected\n");
2516 print_kernel_ident();
2517 pr_warn("--------------------------------------------------------\n");
2518 pr_warn("%s/%d just changed the state of lock:\n",
2519 curr->comm, task_pid_nr(curr));
2522 pr_warn("but this lock took another, %s-unsafe lock in the past:\n", irqclass);
2524 pr_warn("but this lock was taken by another, %s-safe lock in the past:\n", irqclass);
2525 print_lock_name(other->class);
2526 pr_warn("\n\nand interrupts could create inverse lock ordering between them.\n\n");
2528 pr_warn("\nother info that might help us debug this:\n");
2530 /* Find a middle lock (if one exists) */
2531 depth = get_lock_depth(other);
2533 if (depth == 0 && (entry != root)) {
2534 pr_warn("lockdep:%s bad path found in chain graph\n", __func__);
2538 entry = get_lock_parent(entry);
2540 } while (entry && entry != root && (depth >= 0));
2542 print_irq_lock_scenario(root, other,
2543 middle ? middle->class : root->class, other->class);
2545 print_irq_lock_scenario(other, root,
2546 middle ? middle->class : other->class, root->class);
2548 lockdep_print_held_locks(curr);
2550 pr_warn("\nthe shortest dependencies between 2nd lock and 1st lock:\n");
2551 if (!save_trace(&root->trace))
2553 print_shortest_lock_dependencies(other, root);
2555 pr_warn("\nstack backtrace:\n");
2562 * Prove that in the forwards-direction subgraph starting at <this>
2563 * there is no lock matching <mask>:
2566 check_usage_forwards(struct task_struct *curr, struct held_lock *this,
2567 enum lock_usage_bit bit, const char *irqclass)
2570 struct lock_list root;
2571 struct lock_list *uninitialized_var(target_entry);
2574 root.class = hlock_class(this);
2575 ret = find_usage_forwards(&root, bit, &target_entry);
2577 return print_bfs_bug(ret);
2581 return print_irq_inversion_bug(curr, &root, target_entry,
2586 * Prove that in the backwards-direction subgraph starting at <this>
2587 * there is no lock matching <mask>:
2590 check_usage_backwards(struct task_struct *curr, struct held_lock *this,
2591 enum lock_usage_bit bit, const char *irqclass)
2594 struct lock_list root;
2595 struct lock_list *uninitialized_var(target_entry);
2598 root.class = hlock_class(this);
2599 ret = find_usage_backwards(&root, bit, &target_entry);
2601 return print_bfs_bug(ret);
2605 return print_irq_inversion_bug(curr, &root, target_entry,
2609 void print_irqtrace_events(struct task_struct *curr)
2611 printk("irq event stamp: %u\n", curr->irq_events);
2612 printk("hardirqs last enabled at (%u): [<%px>] %pS\n",
2613 curr->hardirq_enable_event, (void *)curr->hardirq_enable_ip,
2614 (void *)curr->hardirq_enable_ip);
2615 printk("hardirqs last disabled at (%u): [<%px>] %pS\n",
2616 curr->hardirq_disable_event, (void *)curr->hardirq_disable_ip,
2617 (void *)curr->hardirq_disable_ip);
2618 printk("softirqs last enabled at (%u): [<%px>] %pS\n",
2619 curr->softirq_enable_event, (void *)curr->softirq_enable_ip,
2620 (void *)curr->softirq_enable_ip);
2621 printk("softirqs last disabled at (%u): [<%px>] %pS\n",
2622 curr->softirq_disable_event, (void *)curr->softirq_disable_ip,
2623 (void *)curr->softirq_disable_ip);
2626 static int HARDIRQ_verbose(struct lock_class *class)
2629 return class_filter(class);
2634 static int SOFTIRQ_verbose(struct lock_class *class)
2637 return class_filter(class);
2642 #define STRICT_READ_CHECKS 1
2644 static int (*state_verbose_f[])(struct lock_class *class) = {
2645 #define LOCKDEP_STATE(__STATE) \
2647 #include "lockdep_states.h"
2648 #undef LOCKDEP_STATE
2651 static inline int state_verbose(enum lock_usage_bit bit,
2652 struct lock_class *class)
2654 return state_verbose_f[bit >> 2](class);
2657 typedef int (*check_usage_f)(struct task_struct *, struct held_lock *,
2658 enum lock_usage_bit bit, const char *name);
2661 mark_lock_irq(struct task_struct *curr, struct held_lock *this,
2662 enum lock_usage_bit new_bit)
2664 int excl_bit = exclusive_bit(new_bit);
2665 int read = new_bit & 1;
2666 int dir = new_bit & 2;
2669 * mark USED_IN has to look forwards -- to ensure no dependency
2670 * has ENABLED state, which would allow recursion deadlocks.
2672 * mark ENABLED has to look backwards -- to ensure no dependee
2673 * has USED_IN state, which, again, would allow recursion deadlocks.
2675 check_usage_f usage = dir ?
2676 check_usage_backwards : check_usage_forwards;
2679 * Validate that this particular lock does not have conflicting
2682 if (!valid_state(curr, this, new_bit, excl_bit))
2686 * Validate that the lock dependencies don't have conflicting usage
2689 if ((!read || !dir || STRICT_READ_CHECKS) &&
2690 !usage(curr, this, excl_bit, state_name(new_bit & ~1)))
2694 * Check for read in write conflicts
2697 if (!valid_state(curr, this, new_bit, excl_bit + 1))
2700 if (STRICT_READ_CHECKS &&
2701 !usage(curr, this, excl_bit + 1,
2702 state_name(new_bit + 1)))
2706 if (state_verbose(new_bit, hlock_class(this)))
2713 #define LOCKDEP_STATE(__STATE) __STATE,
2714 #include "lockdep_states.h"
2715 #undef LOCKDEP_STATE
2719 * Mark all held locks with a usage bit:
2722 mark_held_locks(struct task_struct *curr, enum mark_type mark)
2724 enum lock_usage_bit usage_bit;
2725 struct held_lock *hlock;
2728 for (i = 0; i < curr->lockdep_depth; i++) {
2729 hlock = curr->held_locks + i;
2731 usage_bit = 2 + (mark << 2); /* ENABLED */
2733 usage_bit += 1; /* READ */
2735 BUG_ON(usage_bit >= LOCK_USAGE_STATES);
2740 if (!mark_lock(curr, hlock, usage_bit))
2748 * Hardirqs will be enabled:
2750 static void __trace_hardirqs_on_caller(unsigned long ip)
2752 struct task_struct *curr = current;
2754 /* we'll do an OFF -> ON transition: */
2755 curr->hardirqs_enabled = 1;
2758 * We are going to turn hardirqs on, so set the
2759 * usage bit for all held locks:
2761 if (!mark_held_locks(curr, HARDIRQ))
2764 * If we have softirqs enabled, then set the usage
2765 * bit for all held locks. (disabled hardirqs prevented
2766 * this bit from being set before)
2768 if (curr->softirqs_enabled)
2769 if (!mark_held_locks(curr, SOFTIRQ))
2772 curr->hardirq_enable_ip = ip;
2773 curr->hardirq_enable_event = ++curr->irq_events;
2774 debug_atomic_inc(hardirqs_on_events);
2777 void lockdep_hardirqs_on(unsigned long ip)
2779 if (unlikely(!debug_locks || current->lockdep_recursion))
2782 if (unlikely(current->hardirqs_enabled)) {
2784 * Neither irq nor preemption are disabled here
2785 * so this is racy by nature but losing one hit
2786 * in a stat is not a big deal.
2788 __debug_atomic_inc(redundant_hardirqs_on);
2793 * We're enabling irqs and according to our state above irqs weren't
2794 * already enabled, yet we find the hardware thinks they are in fact
2795 * enabled.. someone messed up their IRQ state tracing.
2797 if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
2801 * See the fine text that goes along with this variable definition.
2803 if (DEBUG_LOCKS_WARN_ON(unlikely(early_boot_irqs_disabled)))
2807 * Can't allow enabling interrupts while in an interrupt handler,
2808 * that's general bad form and such. Recursion, limited stack etc..
2810 if (DEBUG_LOCKS_WARN_ON(current->hardirq_context))
2813 current->lockdep_recursion = 1;
2814 __trace_hardirqs_on_caller(ip);
2815 current->lockdep_recursion = 0;
2819 * Hardirqs were disabled:
2821 void lockdep_hardirqs_off(unsigned long ip)
2823 struct task_struct *curr = current;
2825 if (unlikely(!debug_locks || current->lockdep_recursion))
2829 * So we're supposed to get called after you mask local IRQs, but for
2830 * some reason the hardware doesn't quite think you did a proper job.
2832 if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
2835 if (curr->hardirqs_enabled) {
2837 * We have done an ON -> OFF transition:
2839 curr->hardirqs_enabled = 0;
2840 curr->hardirq_disable_ip = ip;
2841 curr->hardirq_disable_event = ++curr->irq_events;
2842 debug_atomic_inc(hardirqs_off_events);
2844 debug_atomic_inc(redundant_hardirqs_off);
2848 * Softirqs will be enabled:
2850 void trace_softirqs_on(unsigned long ip)
2852 struct task_struct *curr = current;
2854 if (unlikely(!debug_locks || current->lockdep_recursion))
2858 * We fancy IRQs being disabled here, see softirq.c, avoids
2859 * funny state and nesting things.
2861 if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
2864 if (curr->softirqs_enabled) {
2865 debug_atomic_inc(redundant_softirqs_on);
2869 current->lockdep_recursion = 1;
2871 * We'll do an OFF -> ON transition:
2873 curr->softirqs_enabled = 1;
2874 curr->softirq_enable_ip = ip;
2875 curr->softirq_enable_event = ++curr->irq_events;
2876 debug_atomic_inc(softirqs_on_events);
2878 * We are going to turn softirqs on, so set the
2879 * usage bit for all held locks, if hardirqs are
2882 if (curr->hardirqs_enabled)
2883 mark_held_locks(curr, SOFTIRQ);
2884 current->lockdep_recursion = 0;
2888 * Softirqs were disabled:
2890 void trace_softirqs_off(unsigned long ip)
2892 struct task_struct *curr = current;
2894 if (unlikely(!debug_locks || current->lockdep_recursion))
2898 * We fancy IRQs being disabled here, see softirq.c
2900 if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
2903 if (curr->softirqs_enabled) {
2905 * We have done an ON -> OFF transition:
2907 curr->softirqs_enabled = 0;
2908 curr->softirq_disable_ip = ip;
2909 curr->softirq_disable_event = ++curr->irq_events;
2910 debug_atomic_inc(softirqs_off_events);
2912 * Whoops, we wanted softirqs off, so why aren't they?
2914 DEBUG_LOCKS_WARN_ON(!softirq_count());
2916 debug_atomic_inc(redundant_softirqs_off);
2919 static int mark_irqflags(struct task_struct *curr, struct held_lock *hlock)
2922 * If non-trylock use in a hardirq or softirq context, then
2923 * mark the lock as used in these contexts:
2925 if (!hlock->trylock) {
2927 if (curr->hardirq_context)
2928 if (!mark_lock(curr, hlock,
2929 LOCK_USED_IN_HARDIRQ_READ))
2931 if (curr->softirq_context)
2932 if (!mark_lock(curr, hlock,
2933 LOCK_USED_IN_SOFTIRQ_READ))
2936 if (curr->hardirq_context)
2937 if (!mark_lock(curr, hlock, LOCK_USED_IN_HARDIRQ))
2939 if (curr->softirq_context)
2940 if (!mark_lock(curr, hlock, LOCK_USED_IN_SOFTIRQ))
2944 if (!hlock->hardirqs_off) {
2946 if (!mark_lock(curr, hlock,
2947 LOCK_ENABLED_HARDIRQ_READ))
2949 if (curr->softirqs_enabled)
2950 if (!mark_lock(curr, hlock,
2951 LOCK_ENABLED_SOFTIRQ_READ))
2954 if (!mark_lock(curr, hlock,
2955 LOCK_ENABLED_HARDIRQ))
2957 if (curr->softirqs_enabled)
2958 if (!mark_lock(curr, hlock,
2959 LOCK_ENABLED_SOFTIRQ))
2967 static inline unsigned int task_irq_context(struct task_struct *task)
2969 return 2 * !!task->hardirq_context + !!task->softirq_context;
2972 static int separate_irq_context(struct task_struct *curr,
2973 struct held_lock *hlock)
2975 unsigned int depth = curr->lockdep_depth;
2978 * Keep track of points where we cross into an interrupt context:
2981 struct held_lock *prev_hlock;
2983 prev_hlock = curr->held_locks + depth-1;
2985 * If we cross into another context, reset the
2986 * hash key (this also prevents the checking and the
2987 * adding of the dependency to 'prev'):
2989 if (prev_hlock->irq_context != hlock->irq_context)
2995 #else /* defined(CONFIG_TRACE_IRQFLAGS) && defined(CONFIG_PROVE_LOCKING) */
2998 int mark_lock_irq(struct task_struct *curr, struct held_lock *this,
2999 enum lock_usage_bit new_bit)
3001 WARN_ON(1); /* Impossible innit? when we don't have TRACE_IRQFLAG */
3005 static inline int mark_irqflags(struct task_struct *curr,
3006 struct held_lock *hlock)
3011 static inline unsigned int task_irq_context(struct task_struct *task)
3016 static inline int separate_irq_context(struct task_struct *curr,
3017 struct held_lock *hlock)
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))
3042 * Make sure we didn't race:
3044 if (unlikely(hlock_class(this)->usage_mask & new_mask)) {
3049 hlock_class(this)->usage_mask |= new_mask;
3051 if (!save_trace(hlock_class(this)->usage_traces + 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);
3067 debug_atomic_dec(nr_unused_locks);
3070 if (!debug_locks_off_graph_unlock())
3079 * We must printk outside of the graph_lock:
3082 printk("\nmarked lock as {%s}:\n", usage_str[new_bit]);
3084 print_irqtrace_events(curr);
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)
3099 for (i = 0; i < NR_LOCKDEP_CACHING_CLASSES; i++)
3100 lock->class_cache[i] = NULL;
3102 #ifdef CONFIG_LOCK_STAT
3103 lock->cpu = raw_smp_processor_id();
3107 * Can't be having no nameless bastards around this place!
3109 if (DEBUG_LOCKS_WARN_ON(!name)) {
3110 lock->name = "NULL";
3117 * No key, no joy, we need to hash something.
3119 if (DEBUG_LOCKS_WARN_ON(!key))
3122 * Sanity check, the lock-class key must be persistent:
3124 if (!static_obj(key)) {
3125 printk("BUG: key %px not in .data!\n", key);
3127 * What it says above ^^^^^, I suggest you read it.
3129 DEBUG_LOCKS_WARN_ON(1);
3134 if (unlikely(!debug_locks))
3138 unsigned long flags;
3140 if (DEBUG_LOCKS_WARN_ON(current->lockdep_recursion))
3143 raw_local_irq_save(flags);
3144 current->lockdep_recursion = 1;
3145 register_lock_class(lock, subclass, 1);
3146 current->lockdep_recursion = 0;
3147 raw_local_irq_restore(flags);
3150 EXPORT_SYMBOL_GPL(lockdep_init_map);
3152 struct lock_class_key __lockdep_no_validate__;
3153 EXPORT_SYMBOL_GPL(__lockdep_no_validate__);
3156 print_lock_nested_lock_not_held(struct task_struct *curr,
3157 struct held_lock *hlock,
3160 if (!debug_locks_off())
3162 if (debug_locks_silent)
3166 pr_warn("==================================\n");
3167 pr_warn("WARNING: Nested lock was not taken\n");
3168 print_kernel_ident();
3169 pr_warn("----------------------------------\n");
3171 pr_warn("%s/%d is trying to lock:\n", curr->comm, task_pid_nr(curr));
3174 pr_warn("\nbut this task is not holding:\n");
3175 pr_warn("%s\n", hlock->nest_lock->name);
3177 pr_warn("\nstack backtrace:\n");
3180 pr_warn("\nother info that might help us debug this:\n");
3181 lockdep_print_held_locks(curr);
3183 pr_warn("\nstack backtrace:\n");
3189 static int __lock_is_held(const struct lockdep_map *lock, int read);
3192 * This gets called for every mutex_lock*()/spin_lock*() operation.
3193 * We maintain the dependency maps and validate the locking attempt:
3195 * The callers must make sure that IRQs are disabled before calling it,
3196 * otherwise we could get an interrupt which would want to take locks,
3197 * which would end up in lockdep again.
3199 static int __lock_acquire(struct lockdep_map *lock, unsigned int subclass,
3200 int trylock, int read, int check, int hardirqs_off,
3201 struct lockdep_map *nest_lock, unsigned long ip,
3202 int references, int pin_count)
3204 struct task_struct *curr = current;
3205 struct lock_class *class = NULL;
3206 struct held_lock *hlock;
3212 if (unlikely(!debug_locks))
3215 if (!prove_locking || lock->key == &__lockdep_no_validate__)
3218 if (subclass < NR_LOCKDEP_CACHING_CLASSES)
3219 class = lock->class_cache[subclass];
3223 if (unlikely(!class)) {
3224 class = register_lock_class(lock, subclass, 0);
3229 debug_class_ops_inc(class);
3231 if (very_verbose(class)) {
3232 printk("\nacquire class [%px] %s", class->key, class->name);
3233 if (class->name_version > 1)
3234 printk(KERN_CONT "#%d", class->name_version);
3235 printk(KERN_CONT "\n");
3240 * Add the lock to the list of currently held locks.
3241 * (we dont increase the depth just yet, up until the
3242 * dependency checks are done)
3244 depth = curr->lockdep_depth;
3246 * Ran out of static storage for our per-task lock stack again have we?
3248 if (DEBUG_LOCKS_WARN_ON(depth >= MAX_LOCK_DEPTH))
3251 class_idx = class - lock_classes + 1;
3254 hlock = curr->held_locks + depth - 1;
3255 if (hlock->class_idx == class_idx && nest_lock) {
3256 if (hlock->references) {
3258 * Check: unsigned int references:12, overflow.
3260 if (DEBUG_LOCKS_WARN_ON(hlock->references == (1 << 12)-1))
3263 hlock->references++;
3265 hlock->references = 2;
3272 hlock = curr->held_locks + depth;
3274 * Plain impossible, we just registered it and checked it weren't no
3275 * NULL like.. I bet this mushroom I ate was good!
3277 if (DEBUG_LOCKS_WARN_ON(!class))
3279 hlock->class_idx = class_idx;
3280 hlock->acquire_ip = ip;
3281 hlock->instance = lock;
3282 hlock->nest_lock = nest_lock;
3283 hlock->irq_context = task_irq_context(curr);
3284 hlock->trylock = trylock;
3286 hlock->check = check;
3287 hlock->hardirqs_off = !!hardirqs_off;
3288 hlock->references = references;
3289 #ifdef CONFIG_LOCK_STAT
3290 hlock->waittime_stamp = 0;
3291 hlock->holdtime_stamp = lockstat_clock();
3293 hlock->pin_count = pin_count;
3295 if (check && !mark_irqflags(curr, hlock))
3298 /* mark it as used: */
3299 if (!mark_lock(curr, hlock, LOCK_USED))
3303 * Calculate the chain hash: it's the combined hash of all the
3304 * lock keys along the dependency chain. We save the hash value
3305 * at every step so that we can get the current hash easily
3306 * after unlock. The chain hash is then used to cache dependency
3309 * The 'key ID' is what is the most compact key value to drive
3310 * the hash, not class->key.
3313 * Whoops, we did it again.. ran straight out of our static allocation.
3315 if (DEBUG_LOCKS_WARN_ON(class_idx > MAX_LOCKDEP_KEYS))
3318 chain_key = curr->curr_chain_key;
3321 * How can we have a chain hash when we ain't got no keys?!
3323 if (DEBUG_LOCKS_WARN_ON(chain_key != 0))
3328 hlock->prev_chain_key = chain_key;
3329 if (separate_irq_context(curr, hlock)) {
3333 chain_key = iterate_chain_key(chain_key, class_idx);
3335 if (nest_lock && !__lock_is_held(nest_lock, -1))
3336 return print_lock_nested_lock_not_held(curr, hlock, ip);
3338 if (!validate_chain(curr, lock, hlock, chain_head, chain_key))
3341 curr->curr_chain_key = chain_key;
3342 curr->lockdep_depth++;
3343 check_chain_key(curr);
3344 #ifdef CONFIG_DEBUG_LOCKDEP
3345 if (unlikely(!debug_locks))
3348 if (unlikely(curr->lockdep_depth >= MAX_LOCK_DEPTH)) {
3350 print_lockdep_off("BUG: MAX_LOCK_DEPTH too low!");
3351 printk(KERN_DEBUG "depth: %i max: %lu!\n",
3352 curr->lockdep_depth, MAX_LOCK_DEPTH);
3354 lockdep_print_held_locks(current);
3355 debug_show_all_locks();
3361 if (unlikely(curr->lockdep_depth > max_lockdep_depth))
3362 max_lockdep_depth = curr->lockdep_depth;
3368 print_unlock_imbalance_bug(struct task_struct *curr, struct lockdep_map *lock,
3371 if (!debug_locks_off())
3373 if (debug_locks_silent)
3377 pr_warn("=====================================\n");
3378 pr_warn("WARNING: bad unlock balance detected!\n");
3379 print_kernel_ident();
3380 pr_warn("-------------------------------------\n");
3381 pr_warn("%s/%d is trying to release lock (",
3382 curr->comm, task_pid_nr(curr));
3383 print_lockdep_cache(lock);
3386 pr_warn("but there are no more locks to release!\n");
3387 pr_warn("\nother info that might help us debug this:\n");
3388 lockdep_print_held_locks(curr);
3390 pr_warn("\nstack backtrace:\n");
3396 static int match_held_lock(const struct held_lock *hlock,
3397 const struct lockdep_map *lock)
3399 if (hlock->instance == lock)
3402 if (hlock->references) {
3403 const struct lock_class *class = lock->class_cache[0];
3406 class = look_up_lock_class(lock, 0);
3409 * If look_up_lock_class() failed to find a class, we're trying
3410 * to test if we hold a lock that has never yet been acquired.
3411 * Clearly if the lock hasn't been acquired _ever_, we're not
3412 * holding it either, so report failure.
3418 * References, but not a lock we're actually ref-counting?
3419 * State got messed up, follow the sites that change ->references
3420 * and try to make sense of it.
3422 if (DEBUG_LOCKS_WARN_ON(!hlock->nest_lock))
3425 if (hlock->class_idx == class - lock_classes + 1)
3432 /* @depth must not be zero */
3433 static struct held_lock *find_held_lock(struct task_struct *curr,
3434 struct lockdep_map *lock,
3435 unsigned int depth, int *idx)
3437 struct held_lock *ret, *hlock, *prev_hlock;
3441 hlock = curr->held_locks + i;
3443 if (match_held_lock(hlock, lock))
3447 for (i--, prev_hlock = hlock--;
3449 i--, prev_hlock = hlock--) {
3451 * We must not cross into another context:
3453 if (prev_hlock->irq_context != hlock->irq_context) {
3457 if (match_held_lock(hlock, lock)) {
3468 static int reacquire_held_locks(struct task_struct *curr, unsigned int depth,
3471 struct held_lock *hlock;
3473 if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
3476 for (hlock = curr->held_locks + idx; idx < depth; idx++, hlock++) {
3477 if (!__lock_acquire(hlock->instance,
3478 hlock_class(hlock)->subclass,
3480 hlock->read, hlock->check,
3481 hlock->hardirqs_off,
3482 hlock->nest_lock, hlock->acquire_ip,
3483 hlock->references, hlock->pin_count))
3490 __lock_set_class(struct lockdep_map *lock, const char *name,
3491 struct lock_class_key *key, unsigned int subclass,
3494 struct task_struct *curr = current;
3495 struct held_lock *hlock;
3496 struct lock_class *class;
3500 depth = curr->lockdep_depth;
3502 * This function is about (re)setting the class of a held lock,
3503 * yet we're not actually holding any locks. Naughty user!
3505 if (DEBUG_LOCKS_WARN_ON(!depth))
3508 hlock = find_held_lock(curr, lock, depth, &i);
3510 return print_unlock_imbalance_bug(curr, lock, ip);
3512 lockdep_init_map(lock, name, key, 0);
3513 class = register_lock_class(lock, subclass, 0);
3514 hlock->class_idx = class - lock_classes + 1;
3516 curr->lockdep_depth = i;
3517 curr->curr_chain_key = hlock->prev_chain_key;
3519 if (reacquire_held_locks(curr, depth, i))
3523 * I took it apart and put it back together again, except now I have
3524 * these 'spare' parts.. where shall I put them.
3526 if (DEBUG_LOCKS_WARN_ON(curr->lockdep_depth != depth))
3531 static int __lock_downgrade(struct lockdep_map *lock, unsigned long ip)
3533 struct task_struct *curr = current;
3534 struct held_lock *hlock;
3538 depth = curr->lockdep_depth;
3540 * This function is about (re)setting the class of a held lock,
3541 * yet we're not actually holding any locks. Naughty user!
3543 if (DEBUG_LOCKS_WARN_ON(!depth))
3546 hlock = find_held_lock(curr, lock, depth, &i);
3548 return print_unlock_imbalance_bug(curr, lock, ip);
3550 curr->lockdep_depth = i;
3551 curr->curr_chain_key = hlock->prev_chain_key;
3553 WARN(hlock->read, "downgrading a read lock");
3555 hlock->acquire_ip = ip;
3557 if (reacquire_held_locks(curr, depth, i))
3561 * I took it apart and put it back together again, except now I have
3562 * these 'spare' parts.. where shall I put them.
3564 if (DEBUG_LOCKS_WARN_ON(curr->lockdep_depth != depth))
3570 * Remove the lock to the list of currently held locks - this gets
3571 * called on mutex_unlock()/spin_unlock*() (or on a failed
3572 * mutex_lock_interruptible()).
3574 * @nested is an hysterical artifact, needs a tree wide cleanup.
3577 __lock_release(struct lockdep_map *lock, int nested, unsigned long ip)
3579 struct task_struct *curr = current;
3580 struct held_lock *hlock;
3584 if (unlikely(!debug_locks))
3587 depth = curr->lockdep_depth;
3589 * So we're all set to release this lock.. wait what lock? We don't
3590 * own any locks, you've been drinking again?
3592 if (DEBUG_LOCKS_WARN_ON(depth <= 0))
3593 return print_unlock_imbalance_bug(curr, lock, ip);
3596 * Check whether the lock exists in the current stack
3599 hlock = find_held_lock(curr, lock, depth, &i);
3601 return print_unlock_imbalance_bug(curr, lock, ip);
3603 if (hlock->instance == lock)
3604 lock_release_holdtime(hlock);
3606 WARN(hlock->pin_count, "releasing a pinned lock\n");
3608 if (hlock->references) {
3609 hlock->references--;
3610 if (hlock->references) {
3612 * We had, and after removing one, still have
3613 * references, the current lock stack is still
3614 * valid. We're done!
3621 * We have the right lock to unlock, 'hlock' points to it.
3622 * Now we remove it from the stack, and add back the other
3623 * entries (if any), recalculating the hash along the way:
3626 curr->lockdep_depth = i;
3627 curr->curr_chain_key = hlock->prev_chain_key;
3630 * The most likely case is when the unlock is on the innermost
3631 * lock. In this case, we are done!
3636 if (reacquire_held_locks(curr, depth, i + 1))
3640 * We had N bottles of beer on the wall, we drank one, but now
3641 * there's not N-1 bottles of beer left on the wall...
3643 DEBUG_LOCKS_WARN_ON(curr->lockdep_depth != depth-1);
3646 * Since reacquire_held_locks() would have called check_chain_key()
3647 * indirectly via __lock_acquire(), we don't need to do it again
3653 static int __lock_is_held(const struct lockdep_map *lock, int read)
3655 struct task_struct *curr = current;
3658 for (i = 0; i < curr->lockdep_depth; i++) {
3659 struct held_lock *hlock = curr->held_locks + i;
3661 if (match_held_lock(hlock, lock)) {
3662 if (read == -1 || hlock->read == read)
3672 static struct pin_cookie __lock_pin_lock(struct lockdep_map *lock)
3674 struct pin_cookie cookie = NIL_COOKIE;
3675 struct task_struct *curr = current;
3678 if (unlikely(!debug_locks))
3681 for (i = 0; i < curr->lockdep_depth; i++) {
3682 struct held_lock *hlock = curr->held_locks + i;
3684 if (match_held_lock(hlock, lock)) {
3686 * Grab 16bits of randomness; this is sufficient to not
3687 * be guessable and still allows some pin nesting in
3688 * our u32 pin_count.
3690 cookie.val = 1 + (prandom_u32() >> 16);
3691 hlock->pin_count += cookie.val;
3696 WARN(1, "pinning an unheld lock\n");
3700 static void __lock_repin_lock(struct lockdep_map *lock, struct pin_cookie cookie)
3702 struct task_struct *curr = current;
3705 if (unlikely(!debug_locks))
3708 for (i = 0; i < curr->lockdep_depth; i++) {
3709 struct held_lock *hlock = curr->held_locks + i;
3711 if (match_held_lock(hlock, lock)) {
3712 hlock->pin_count += cookie.val;
3717 WARN(1, "pinning an unheld lock\n");
3720 static void __lock_unpin_lock(struct lockdep_map *lock, struct pin_cookie cookie)
3722 struct task_struct *curr = current;
3725 if (unlikely(!debug_locks))
3728 for (i = 0; i < curr->lockdep_depth; i++) {
3729 struct held_lock *hlock = curr->held_locks + i;
3731 if (match_held_lock(hlock, lock)) {
3732 if (WARN(!hlock->pin_count, "unpinning an unpinned lock\n"))
3735 hlock->pin_count -= cookie.val;
3737 if (WARN((int)hlock->pin_count < 0, "pin count corrupted\n"))
3738 hlock->pin_count = 0;
3744 WARN(1, "unpinning an unheld lock\n");
3748 * Check whether we follow the irq-flags state precisely:
3750 static void check_flags(unsigned long flags)
3752 #if defined(CONFIG_PROVE_LOCKING) && defined(CONFIG_DEBUG_LOCKDEP) && \
3753 defined(CONFIG_TRACE_IRQFLAGS)
3757 if (irqs_disabled_flags(flags)) {
3758 if (DEBUG_LOCKS_WARN_ON(current->hardirqs_enabled)) {
3759 printk("possible reason: unannotated irqs-off.\n");
3762 if (DEBUG_LOCKS_WARN_ON(!current->hardirqs_enabled)) {
3763 printk("possible reason: unannotated irqs-on.\n");
3768 * We dont accurately track softirq state in e.g.
3769 * hardirq contexts (such as on 4KSTACKS), so only
3770 * check if not in hardirq contexts:
3772 if (!hardirq_count()) {
3773 if (softirq_count()) {
3774 /* like the above, but with softirqs */
3775 DEBUG_LOCKS_WARN_ON(current->softirqs_enabled);
3777 /* lick the above, does it taste good? */
3778 DEBUG_LOCKS_WARN_ON(!current->softirqs_enabled);
3783 print_irqtrace_events(current);
3787 void lock_set_class(struct lockdep_map *lock, const char *name,
3788 struct lock_class_key *key, unsigned int subclass,
3791 unsigned long flags;
3793 if (unlikely(current->lockdep_recursion))
3796 raw_local_irq_save(flags);
3797 current->lockdep_recursion = 1;
3799 if (__lock_set_class(lock, name, key, subclass, ip))
3800 check_chain_key(current);
3801 current->lockdep_recursion = 0;
3802 raw_local_irq_restore(flags);
3804 EXPORT_SYMBOL_GPL(lock_set_class);
3806 void lock_downgrade(struct lockdep_map *lock, unsigned long ip)
3808 unsigned long flags;
3810 if (unlikely(current->lockdep_recursion))
3813 raw_local_irq_save(flags);
3814 current->lockdep_recursion = 1;
3816 if (__lock_downgrade(lock, ip))
3817 check_chain_key(current);
3818 current->lockdep_recursion = 0;
3819 raw_local_irq_restore(flags);
3821 EXPORT_SYMBOL_GPL(lock_downgrade);
3824 * We are not always called with irqs disabled - do that here,
3825 * and also avoid lockdep recursion:
3827 void lock_acquire(struct lockdep_map *lock, unsigned int subclass,
3828 int trylock, int read, int check,
3829 struct lockdep_map *nest_lock, unsigned long ip)
3831 unsigned long flags;
3833 if (unlikely(current->lockdep_recursion))
3836 raw_local_irq_save(flags);
3839 current->lockdep_recursion = 1;
3840 trace_lock_acquire(lock, subclass, trylock, read, check, nest_lock, ip);
3841 __lock_acquire(lock, subclass, trylock, read, check,
3842 irqs_disabled_flags(flags), nest_lock, ip, 0, 0);
3843 current->lockdep_recursion = 0;
3844 raw_local_irq_restore(flags);
3846 EXPORT_SYMBOL_GPL(lock_acquire);
3848 void lock_release(struct lockdep_map *lock, int nested,
3851 unsigned long flags;
3853 if (unlikely(current->lockdep_recursion))
3856 raw_local_irq_save(flags);
3858 current->lockdep_recursion = 1;
3859 trace_lock_release(lock, ip);
3860 if (__lock_release(lock, nested, ip))
3861 check_chain_key(current);
3862 current->lockdep_recursion = 0;
3863 raw_local_irq_restore(flags);
3865 EXPORT_SYMBOL_GPL(lock_release);
3867 int lock_is_held_type(const struct lockdep_map *lock, int read)
3869 unsigned long flags;
3872 if (unlikely(current->lockdep_recursion))
3873 return 1; /* avoid false negative lockdep_assert_held() */
3875 raw_local_irq_save(flags);
3878 current->lockdep_recursion = 1;
3879 ret = __lock_is_held(lock, read);
3880 current->lockdep_recursion = 0;
3881 raw_local_irq_restore(flags);
3885 EXPORT_SYMBOL_GPL(lock_is_held_type);
3887 struct pin_cookie lock_pin_lock(struct lockdep_map *lock)
3889 struct pin_cookie cookie = NIL_COOKIE;
3890 unsigned long flags;
3892 if (unlikely(current->lockdep_recursion))
3895 raw_local_irq_save(flags);
3898 current->lockdep_recursion = 1;
3899 cookie = __lock_pin_lock(lock);
3900 current->lockdep_recursion = 0;
3901 raw_local_irq_restore(flags);
3905 EXPORT_SYMBOL_GPL(lock_pin_lock);
3907 void lock_repin_lock(struct lockdep_map *lock, struct pin_cookie cookie)
3909 unsigned long flags;
3911 if (unlikely(current->lockdep_recursion))
3914 raw_local_irq_save(flags);
3917 current->lockdep_recursion = 1;
3918 __lock_repin_lock(lock, cookie);
3919 current->lockdep_recursion = 0;
3920 raw_local_irq_restore(flags);
3922 EXPORT_SYMBOL_GPL(lock_repin_lock);
3924 void lock_unpin_lock(struct lockdep_map *lock, struct pin_cookie cookie)
3926 unsigned long flags;
3928 if (unlikely(current->lockdep_recursion))
3931 raw_local_irq_save(flags);
3934 current->lockdep_recursion = 1;
3935 __lock_unpin_lock(lock, cookie);
3936 current->lockdep_recursion = 0;
3937 raw_local_irq_restore(flags);
3939 EXPORT_SYMBOL_GPL(lock_unpin_lock);
3941 #ifdef CONFIG_LOCK_STAT
3943 print_lock_contention_bug(struct task_struct *curr, struct lockdep_map *lock,
3946 if (!debug_locks_off())
3948 if (debug_locks_silent)
3952 pr_warn("=================================\n");
3953 pr_warn("WARNING: bad contention detected!\n");
3954 print_kernel_ident();
3955 pr_warn("---------------------------------\n");
3956 pr_warn("%s/%d is trying to contend lock (",
3957 curr->comm, task_pid_nr(curr));
3958 print_lockdep_cache(lock);
3961 pr_warn("but there are no locks held!\n");
3962 pr_warn("\nother info that might help us debug this:\n");
3963 lockdep_print_held_locks(curr);
3965 pr_warn("\nstack backtrace:\n");
3972 __lock_contended(struct lockdep_map *lock, unsigned long ip)
3974 struct task_struct *curr = current;
3975 struct held_lock *hlock;
3976 struct lock_class_stats *stats;
3978 int i, contention_point, contending_point;
3980 depth = curr->lockdep_depth;
3982 * Whee, we contended on this lock, except it seems we're not
3983 * actually trying to acquire anything much at all..
3985 if (DEBUG_LOCKS_WARN_ON(!depth))
3988 hlock = find_held_lock(curr, lock, depth, &i);
3990 print_lock_contention_bug(curr, lock, ip);
3994 if (hlock->instance != lock)
3997 hlock->waittime_stamp = lockstat_clock();
3999 contention_point = lock_point(hlock_class(hlock)->contention_point, ip);
4000 contending_point = lock_point(hlock_class(hlock)->contending_point,
4003 stats = get_lock_stats(hlock_class(hlock));
4004 if (contention_point < LOCKSTAT_POINTS)
4005 stats->contention_point[contention_point]++;
4006 if (contending_point < LOCKSTAT_POINTS)
4007 stats->contending_point[contending_point]++;
4008 if (lock->cpu != smp_processor_id())
4009 stats->bounces[bounce_contended + !!hlock->read]++;
4013 __lock_acquired(struct lockdep_map *lock, unsigned long ip)
4015 struct task_struct *curr = current;
4016 struct held_lock *hlock;
4017 struct lock_class_stats *stats;
4019 u64 now, waittime = 0;
4022 depth = curr->lockdep_depth;
4024 * Yay, we acquired ownership of this lock we didn't try to
4025 * acquire, how the heck did that happen?
4027 if (DEBUG_LOCKS_WARN_ON(!depth))
4030 hlock = find_held_lock(curr, lock, depth, &i);
4032 print_lock_contention_bug(curr, lock, _RET_IP_);
4036 if (hlock->instance != lock)
4039 cpu = smp_processor_id();
4040 if (hlock->waittime_stamp) {
4041 now = lockstat_clock();
4042 waittime = now - hlock->waittime_stamp;
4043 hlock->holdtime_stamp = now;
4046 trace_lock_acquired(lock, ip);
4048 stats = get_lock_stats(hlock_class(hlock));
4051 lock_time_inc(&stats->read_waittime, waittime);
4053 lock_time_inc(&stats->write_waittime, waittime);
4055 if (lock->cpu != cpu)
4056 stats->bounces[bounce_acquired + !!hlock->read]++;
4062 void lock_contended(struct lockdep_map *lock, unsigned long ip)
4064 unsigned long flags;
4066 if (unlikely(!lock_stat || !debug_locks))
4069 if (unlikely(current->lockdep_recursion))
4072 raw_local_irq_save(flags);
4074 current->lockdep_recursion = 1;
4075 trace_lock_contended(lock, ip);
4076 __lock_contended(lock, ip);
4077 current->lockdep_recursion = 0;
4078 raw_local_irq_restore(flags);
4080 EXPORT_SYMBOL_GPL(lock_contended);
4082 void lock_acquired(struct lockdep_map *lock, unsigned long ip)
4084 unsigned long flags;
4086 if (unlikely(!lock_stat || !debug_locks))
4089 if (unlikely(current->lockdep_recursion))
4092 raw_local_irq_save(flags);
4094 current->lockdep_recursion = 1;
4095 __lock_acquired(lock, ip);
4096 current->lockdep_recursion = 0;
4097 raw_local_irq_restore(flags);
4099 EXPORT_SYMBOL_GPL(lock_acquired);
4103 * Used by the testsuite, sanitize the validator state
4104 * after a simulated failure:
4107 void lockdep_reset(void)
4109 unsigned long flags;
4112 raw_local_irq_save(flags);
4113 current->curr_chain_key = 0;
4114 current->lockdep_depth = 0;
4115 current->lockdep_recursion = 0;
4116 memset(current->held_locks, 0, MAX_LOCK_DEPTH*sizeof(struct held_lock));
4117 nr_hardirq_chains = 0;
4118 nr_softirq_chains = 0;
4119 nr_process_chains = 0;
4121 for (i = 0; i < CHAINHASH_SIZE; i++)
4122 INIT_HLIST_HEAD(chainhash_table + i);
4123 raw_local_irq_restore(flags);
4127 * Remove all references to a lock class. The caller must hold the graph lock.
4129 static void zap_class(struct lock_class *class)
4134 * Remove all dependencies this lock is
4137 for (i = 0; i < nr_list_entries; i++) {
4138 if (list_entries[i].class == class)
4139 list_del_rcu(&list_entries[i].entry);
4142 * Unhash the class and remove it from the all_lock_classes list:
4144 hlist_del_rcu(&class->hash_entry);
4145 list_del(&class->lock_entry);
4147 RCU_INIT_POINTER(class->key, NULL);
4148 RCU_INIT_POINTER(class->name, NULL);
4151 static inline int within(const void *addr, void *start, unsigned long size)
4153 return addr >= start && addr < start + size;
4157 * Used in module.c to remove lock classes from memory that is going to be
4158 * freed; and possibly re-used by other modules.
4160 * We will have had one sync_sched() before getting here, so we're guaranteed
4161 * nobody will look up these exact classes -- they're properly dead but still
4164 void lockdep_free_key_range(void *start, unsigned long size)
4166 struct lock_class *class;
4167 struct hlist_head *head;
4168 unsigned long flags;
4172 raw_local_irq_save(flags);
4173 locked = graph_lock();
4176 * Unhash all classes that were created by this module:
4178 for (i = 0; i < CLASSHASH_SIZE; i++) {
4179 head = classhash_table + i;
4180 hlist_for_each_entry_rcu(class, head, hash_entry) {
4181 if (within(class->key, start, size))
4183 else if (within(class->name, start, size))
4190 raw_local_irq_restore(flags);
4193 * Wait for any possible iterators from look_up_lock_class() to pass
4194 * before continuing to free the memory they refer to.
4196 * sync_sched() is sufficient because the read-side is IRQ disable.
4201 * XXX at this point we could return the resources to the pool;
4202 * instead we leak them. We would need to change to bitmap allocators
4203 * instead of the linear allocators we have now.
4208 * Check whether any element of the @lock->class_cache[] array refers to a
4209 * registered lock class. The caller must hold either the graph lock or the
4212 static bool lock_class_cache_is_registered(struct lockdep_map *lock)
4214 struct lock_class *class;
4215 struct hlist_head *head;
4218 for (i = 0; i < CLASSHASH_SIZE; i++) {
4219 head = classhash_table + i;
4220 hlist_for_each_entry_rcu(class, head, hash_entry) {
4221 for (j = 0; j < NR_LOCKDEP_CACHING_CLASSES; j++)
4222 if (lock->class_cache[j] == class)
4229 void lockdep_reset_lock(struct lockdep_map *lock)
4231 struct lock_class *class;
4232 unsigned long flags;
4235 raw_local_irq_save(flags);
4236 locked = graph_lock();
4239 * Remove all classes this lock might have:
4241 for (j = 0; j < MAX_LOCKDEP_SUBCLASSES; j++) {
4243 * If the class exists we look it up and zap it:
4245 class = look_up_lock_class(lock, j);
4250 * Debug check: in the end all mapped classes should
4253 if (unlikely(lock_class_cache_is_registered(lock))) {
4254 if (debug_locks_off_graph_unlock()) {
4256 * We all just reset everything, how did it match?
4266 raw_local_irq_restore(flags);
4269 void __init lockdep_init(void)
4271 printk("Lock dependency validator: Copyright (c) 2006 Red Hat, Inc., Ingo Molnar\n");
4273 printk("... MAX_LOCKDEP_SUBCLASSES: %lu\n", MAX_LOCKDEP_SUBCLASSES);
4274 printk("... MAX_LOCK_DEPTH: %lu\n", MAX_LOCK_DEPTH);
4275 printk("... MAX_LOCKDEP_KEYS: %lu\n", MAX_LOCKDEP_KEYS);
4276 printk("... CLASSHASH_SIZE: %lu\n", CLASSHASH_SIZE);
4277 printk("... MAX_LOCKDEP_ENTRIES: %lu\n", MAX_LOCKDEP_ENTRIES);
4278 printk("... MAX_LOCKDEP_CHAINS: %lu\n", MAX_LOCKDEP_CHAINS);
4279 printk("... CHAINHASH_SIZE: %lu\n", CHAINHASH_SIZE);
4281 printk(" memory used by lock dependency info: %lu kB\n",
4282 (sizeof(struct lock_class) * MAX_LOCKDEP_KEYS +
4283 sizeof(struct list_head) * CLASSHASH_SIZE +
4284 sizeof(struct lock_list) * MAX_LOCKDEP_ENTRIES +
4285 sizeof(struct lock_chain) * MAX_LOCKDEP_CHAINS +
4286 sizeof(struct list_head) * CHAINHASH_SIZE
4287 #ifdef CONFIG_PROVE_LOCKING
4288 + sizeof(struct circular_queue)
4293 printk(" per task-struct memory footprint: %lu bytes\n",
4294 sizeof(struct held_lock) * MAX_LOCK_DEPTH);
4298 print_freed_lock_bug(struct task_struct *curr, const void *mem_from,
4299 const void *mem_to, struct held_lock *hlock)
4301 if (!debug_locks_off())
4303 if (debug_locks_silent)
4307 pr_warn("=========================\n");
4308 pr_warn("WARNING: held lock freed!\n");
4309 print_kernel_ident();
4310 pr_warn("-------------------------\n");
4311 pr_warn("%s/%d is freeing memory %px-%px, with a lock still held there!\n",
4312 curr->comm, task_pid_nr(curr), mem_from, mem_to-1);
4314 lockdep_print_held_locks(curr);
4316 pr_warn("\nstack backtrace:\n");
4320 static inline int not_in_range(const void* mem_from, unsigned long mem_len,
4321 const void* lock_from, unsigned long lock_len)
4323 return lock_from + lock_len <= mem_from ||
4324 mem_from + mem_len <= lock_from;
4328 * Called when kernel memory is freed (or unmapped), or if a lock
4329 * is destroyed or reinitialized - this code checks whether there is
4330 * any held lock in the memory range of <from> to <to>:
4332 void debug_check_no_locks_freed(const void *mem_from, unsigned long mem_len)
4334 struct task_struct *curr = current;
4335 struct held_lock *hlock;
4336 unsigned long flags;
4339 if (unlikely(!debug_locks))
4342 raw_local_irq_save(flags);
4343 for (i = 0; i < curr->lockdep_depth; i++) {
4344 hlock = curr->held_locks + i;
4346 if (not_in_range(mem_from, mem_len, hlock->instance,
4347 sizeof(*hlock->instance)))
4350 print_freed_lock_bug(curr, mem_from, mem_from + mem_len, hlock);
4353 raw_local_irq_restore(flags);
4355 EXPORT_SYMBOL_GPL(debug_check_no_locks_freed);
4357 static void print_held_locks_bug(void)
4359 if (!debug_locks_off())
4361 if (debug_locks_silent)
4365 pr_warn("====================================\n");
4366 pr_warn("WARNING: %s/%d still has locks held!\n",
4367 current->comm, task_pid_nr(current));
4368 print_kernel_ident();
4369 pr_warn("------------------------------------\n");
4370 lockdep_print_held_locks(current);
4371 pr_warn("\nstack backtrace:\n");
4375 void debug_check_no_locks_held(void)
4377 if (unlikely(current->lockdep_depth > 0))
4378 print_held_locks_bug();
4380 EXPORT_SYMBOL_GPL(debug_check_no_locks_held);
4383 void debug_show_all_locks(void)
4385 struct task_struct *g, *p;
4387 if (unlikely(!debug_locks)) {
4388 pr_warn("INFO: lockdep is turned off.\n");
4391 pr_warn("\nShowing all locks held in the system:\n");
4394 for_each_process_thread(g, p) {
4395 if (!p->lockdep_depth)
4397 lockdep_print_held_locks(p);
4398 touch_nmi_watchdog();
4399 touch_all_softlockup_watchdogs();
4404 pr_warn("=============================================\n\n");
4406 EXPORT_SYMBOL_GPL(debug_show_all_locks);
4410 * Careful: only use this function if you are sure that
4411 * the task cannot run in parallel!
4413 void debug_show_held_locks(struct task_struct *task)
4415 if (unlikely(!debug_locks)) {
4416 printk("INFO: lockdep is turned off.\n");
4419 lockdep_print_held_locks(task);
4421 EXPORT_SYMBOL_GPL(debug_show_held_locks);
4423 asmlinkage __visible void lockdep_sys_exit(void)
4425 struct task_struct *curr = current;
4427 if (unlikely(curr->lockdep_depth)) {
4428 if (!debug_locks_off())
4431 pr_warn("================================================\n");
4432 pr_warn("WARNING: lock held when returning to user space!\n");
4433 print_kernel_ident();
4434 pr_warn("------------------------------------------------\n");
4435 pr_warn("%s/%d is leaving the kernel with locks still held!\n",
4436 curr->comm, curr->pid);
4437 lockdep_print_held_locks(curr);
4441 * The lock history for each syscall should be independent. So wipe the
4442 * slate clean on return to userspace.
4444 lockdep_invariant_state(false);
4447 void lockdep_rcu_suspicious(const char *file, const int line, const char *s)
4449 struct task_struct *curr = current;
4451 /* Note: the following can be executed concurrently, so be careful. */
4453 pr_warn("=============================\n");
4454 pr_warn("WARNING: suspicious RCU usage\n");
4455 print_kernel_ident();
4456 pr_warn("-----------------------------\n");
4457 pr_warn("%s:%d %s!\n", file, line, s);
4458 pr_warn("\nother info that might help us debug this:\n\n");
4459 pr_warn("\n%srcu_scheduler_active = %d, debug_locks = %d\n",
4460 !rcu_lockdep_current_cpu_online()
4461 ? "RCU used illegally from offline CPU!\n"
4462 : !rcu_is_watching()
4463 ? "RCU used illegally from idle CPU!\n"
4465 rcu_scheduler_active, debug_locks);
4468 * If a CPU is in the RCU-free window in idle (ie: in the section
4469 * between rcu_idle_enter() and rcu_idle_exit(), then RCU
4470 * considers that CPU to be in an "extended quiescent state",
4471 * which means that RCU will be completely ignoring that CPU.
4472 * Therefore, rcu_read_lock() and friends have absolutely no
4473 * effect on a CPU running in that state. In other words, even if
4474 * such an RCU-idle CPU has called rcu_read_lock(), RCU might well
4475 * delete data structures out from under it. RCU really has no
4476 * choice here: we need to keep an RCU-free window in idle where
4477 * the CPU may possibly enter into low power mode. This way we can
4478 * notice an extended quiescent state to other CPUs that started a grace
4479 * period. Otherwise we would delay any grace period as long as we run
4482 * So complain bitterly if someone does call rcu_read_lock(),
4483 * rcu_read_lock_bh() and so on from extended quiescent states.
4485 if (!rcu_is_watching())
4486 pr_warn("RCU used illegally from extended quiescent state!\n");
4488 lockdep_print_held_locks(curr);
4489 pr_warn("\nstack backtrace:\n");
4492 EXPORT_SYMBOL_GPL(lockdep_rcu_suspicious);