4 * Runtime locking correctness validator
6 * Started by Ingo Molnar:
8 * Copyright (C) 2006,2007 Red Hat, Inc., Ingo Molnar <mingo@redhat.com>
9 * Copyright (C) 2007 Red Hat, Inc., Peter Zijlstra <pzijlstr@redhat.com>
11 * this code maps all the lock dependencies as they occur in a live kernel
12 * and will warn about the following classes of locking bugs:
14 * - lock inversion scenarios
15 * - circular lock dependencies
16 * - hardirq/softirq safe/unsafe locking bugs
18 * Bugs are reported even if the current locking scenario does not cause
19 * any deadlock at this point.
21 * I.e. if anytime in the past two locks were taken in a different order,
22 * even if it happened for another task, even if those were different
23 * locks (but of the same class as this lock), this code will detect it.
25 * Thanks to Arjan van de Ven for coming up with the initial idea of
26 * mapping lock dependencies runtime.
28 #define DISABLE_BRANCH_PROFILING
29 #include <linux/mutex.h>
30 #include <linux/sched.h>
31 #include <linux/delay.h>
32 #include <linux/module.h>
33 #include <linux/proc_fs.h>
34 #include <linux/seq_file.h>
35 #include <linux/spinlock.h>
36 #include <linux/kallsyms.h>
37 #include <linux/interrupt.h>
38 #include <linux/stacktrace.h>
39 #include <linux/debug_locks.h>
40 #include <linux/irqflags.h>
41 #include <linux/utsname.h>
42 #include <linux/hash.h>
43 #include <linux/ftrace.h>
44 #include <linux/stringify.h>
45 #include <linux/bitops.h>
46 #include <linux/gfp.h>
48 #include <asm/sections.h>
50 #include "lockdep_internals.h"
52 #define CREATE_TRACE_POINTS
53 #include <trace/events/lock.h>
55 #ifdef CONFIG_PROVE_LOCKING
56 int prove_locking
= 1;
57 module_param(prove_locking
, int, 0644);
59 #define prove_locking 0
62 #ifdef CONFIG_LOCK_STAT
64 module_param(lock_stat
, int, 0644);
70 * lockdep_lock: protects the lockdep graph, the hashes and the
71 * class/list/hash allocators.
73 * This is one of the rare exceptions where it's justified
74 * to use a raw spinlock - we really dont want the spinlock
75 * code to recurse back into the lockdep code...
77 static arch_spinlock_t lockdep_lock
= (arch_spinlock_t
)__ARCH_SPIN_LOCK_UNLOCKED
;
79 static int graph_lock(void)
81 arch_spin_lock(&lockdep_lock
);
83 * Make sure that if another CPU detected a bug while
84 * walking the graph we dont change it (while the other
85 * CPU is busy printing out stuff with the graph lock
89 arch_spin_unlock(&lockdep_lock
);
92 /* prevent any recursions within lockdep from causing deadlocks */
93 current
->lockdep_recursion
++;
97 static inline int graph_unlock(void)
99 if (debug_locks
&& !arch_spin_is_locked(&lockdep_lock
)) {
101 * The lockdep graph lock isn't locked while we expect it to
102 * be, we're confused now, bye!
104 return DEBUG_LOCKS_WARN_ON(1);
107 current
->lockdep_recursion
--;
108 arch_spin_unlock(&lockdep_lock
);
113 * Turn lock debugging off and return with 0 if it was off already,
114 * and also release the graph lock:
116 static inline int debug_locks_off_graph_unlock(void)
118 int ret
= debug_locks_off();
120 arch_spin_unlock(&lockdep_lock
);
125 static int lockdep_initialized
;
127 unsigned long nr_list_entries
;
128 static struct lock_list list_entries
[MAX_LOCKDEP_ENTRIES
];
131 * All data structures here are protected by the global debug_lock.
133 * Mutex key structs only get allocated, once during bootup, and never
134 * get freed - this significantly simplifies the debugging code.
136 unsigned long nr_lock_classes
;
137 static struct lock_class lock_classes
[MAX_LOCKDEP_KEYS
];
139 static inline struct lock_class
*hlock_class(struct held_lock
*hlock
)
141 if (!hlock
->class_idx
) {
143 * Someone passed in garbage, we give up.
145 DEBUG_LOCKS_WARN_ON(1);
148 return lock_classes
+ hlock
->class_idx
- 1;
151 #ifdef CONFIG_LOCK_STAT
152 static DEFINE_PER_CPU(struct lock_class_stats
[MAX_LOCKDEP_KEYS
],
155 static inline u64
lockstat_clock(void)
157 return local_clock();
160 static int lock_point(unsigned long points
[], unsigned long ip
)
164 for (i
= 0; i
< LOCKSTAT_POINTS
; i
++) {
165 if (points
[i
] == 0) {
176 static void lock_time_inc(struct lock_time
*lt
, u64 time
)
181 if (time
< lt
->min
|| !lt
->nr
)
188 static inline void lock_time_add(struct lock_time
*src
, struct lock_time
*dst
)
193 if (src
->max
> dst
->max
)
196 if (src
->min
< dst
->min
|| !dst
->nr
)
199 dst
->total
+= src
->total
;
203 struct lock_class_stats
lock_stats(struct lock_class
*class)
205 struct lock_class_stats stats
;
208 memset(&stats
, 0, sizeof(struct lock_class_stats
));
209 for_each_possible_cpu(cpu
) {
210 struct lock_class_stats
*pcs
=
211 &per_cpu(cpu_lock_stats
, cpu
)[class - lock_classes
];
213 for (i
= 0; i
< ARRAY_SIZE(stats
.contention_point
); i
++)
214 stats
.contention_point
[i
] += pcs
->contention_point
[i
];
216 for (i
= 0; i
< ARRAY_SIZE(stats
.contending_point
); i
++)
217 stats
.contending_point
[i
] += pcs
->contending_point
[i
];
219 lock_time_add(&pcs
->read_waittime
, &stats
.read_waittime
);
220 lock_time_add(&pcs
->write_waittime
, &stats
.write_waittime
);
222 lock_time_add(&pcs
->read_holdtime
, &stats
.read_holdtime
);
223 lock_time_add(&pcs
->write_holdtime
, &stats
.write_holdtime
);
225 for (i
= 0; i
< ARRAY_SIZE(stats
.bounces
); i
++)
226 stats
.bounces
[i
] += pcs
->bounces
[i
];
232 void clear_lock_stats(struct lock_class
*class)
236 for_each_possible_cpu(cpu
) {
237 struct lock_class_stats
*cpu_stats
=
238 &per_cpu(cpu_lock_stats
, cpu
)[class - lock_classes
];
240 memset(cpu_stats
, 0, sizeof(struct lock_class_stats
));
242 memset(class->contention_point
, 0, sizeof(class->contention_point
));
243 memset(class->contending_point
, 0, sizeof(class->contending_point
));
246 static struct lock_class_stats
*get_lock_stats(struct lock_class
*class)
248 return &get_cpu_var(cpu_lock_stats
)[class - lock_classes
];
251 static void put_lock_stats(struct lock_class_stats
*stats
)
253 put_cpu_var(cpu_lock_stats
);
256 static void lock_release_holdtime(struct held_lock
*hlock
)
258 struct lock_class_stats
*stats
;
264 holdtime
= lockstat_clock() - hlock
->holdtime_stamp
;
266 stats
= get_lock_stats(hlock_class(hlock
));
268 lock_time_inc(&stats
->read_holdtime
, holdtime
);
270 lock_time_inc(&stats
->write_holdtime
, holdtime
);
271 put_lock_stats(stats
);
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 list_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 list_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 #define iterate_chain_key(key1, key2) \
314 (((key1) << MAX_LOCKDEP_KEYS_BITS) ^ \
315 ((key1) >> (64-MAX_LOCKDEP_KEYS_BITS)) ^ \
318 void lockdep_off(void)
320 current
->lockdep_recursion
++;
322 EXPORT_SYMBOL(lockdep_off
);
324 void lockdep_on(void)
326 current
->lockdep_recursion
--;
328 EXPORT_SYMBOL(lockdep_on
);
331 * Debugging switches:
335 #define VERY_VERBOSE 0
338 # define HARDIRQ_VERBOSE 1
339 # define SOFTIRQ_VERBOSE 1
340 # define RECLAIM_VERBOSE 1
342 # define HARDIRQ_VERBOSE 0
343 # define SOFTIRQ_VERBOSE 0
344 # define RECLAIM_VERBOSE 0
347 #if VERBOSE || HARDIRQ_VERBOSE || SOFTIRQ_VERBOSE || RECLAIM_VERBOSE
349 * Quick filtering for interesting events:
351 static int class_filter(struct lock_class
*class)
355 if (class->name_version
== 1 &&
356 !strcmp(class->name
, "lockname"))
358 if (class->name_version
== 1 &&
359 !strcmp(class->name
, "&struct->lockfield"))
362 /* Filter everything else. 1 would be to allow everything else */
367 static int verbose(struct lock_class
*class)
370 return class_filter(class);
376 * Stack-trace: tightly packed array of stack backtrace
377 * addresses. Protected by the graph_lock.
379 unsigned long nr_stack_trace_entries
;
380 static unsigned long stack_trace
[MAX_STACK_TRACE_ENTRIES
];
382 static int save_trace(struct stack_trace
*trace
)
384 trace
->nr_entries
= 0;
385 trace
->max_entries
= MAX_STACK_TRACE_ENTRIES
- nr_stack_trace_entries
;
386 trace
->entries
= stack_trace
+ nr_stack_trace_entries
;
390 save_stack_trace(trace
);
393 * Some daft arches put -1 at the end to indicate its a full trace.
395 * <rant> this is buggy anyway, since it takes a whole extra entry so a
396 * complete trace that maxes out the entries provided will be reported
397 * as incomplete, friggin useless </rant>
399 if (trace
->nr_entries
!= 0 &&
400 trace
->entries
[trace
->nr_entries
-1] == ULONG_MAX
)
403 trace
->max_entries
= trace
->nr_entries
;
405 nr_stack_trace_entries
+= trace
->nr_entries
;
407 if (nr_stack_trace_entries
>= MAX_STACK_TRACE_ENTRIES
-1) {
408 if (!debug_locks_off_graph_unlock())
411 printk("BUG: MAX_STACK_TRACE_ENTRIES too low!\n");
412 printk("turning off the locking correctness validator.\n");
421 unsigned int nr_hardirq_chains
;
422 unsigned int nr_softirq_chains
;
423 unsigned int nr_process_chains
;
424 unsigned int max_lockdep_depth
;
426 #ifdef CONFIG_DEBUG_LOCKDEP
428 * We cannot printk in early bootup code. Not even early_printk()
429 * might work. So we mark any initialization errors and printk
430 * about it later on, in lockdep_info().
432 static int lockdep_init_error
;
433 static unsigned long lockdep_init_trace_data
[20];
434 static struct stack_trace lockdep_init_trace
= {
435 .max_entries
= ARRAY_SIZE(lockdep_init_trace_data
),
436 .entries
= lockdep_init_trace_data
,
440 * Various lockdep statistics:
442 DEFINE_PER_CPU(struct lockdep_stats
, lockdep_stats
);
449 #define __USAGE(__STATE) \
450 [LOCK_USED_IN_##__STATE] = "IN-"__stringify(__STATE)"-W", \
451 [LOCK_ENABLED_##__STATE] = __stringify(__STATE)"-ON-W", \
452 [LOCK_USED_IN_##__STATE##_READ] = "IN-"__stringify(__STATE)"-R",\
453 [LOCK_ENABLED_##__STATE##_READ] = __stringify(__STATE)"-ON-R",
455 static const char *usage_str
[] =
457 #define LOCKDEP_STATE(__STATE) __USAGE(__STATE)
458 #include "lockdep_states.h"
460 [LOCK_USED
] = "INITIAL USE",
463 const char * __get_key_name(struct lockdep_subclass_key
*key
, char *str
)
465 return kallsyms_lookup((unsigned long)key
, NULL
, NULL
, NULL
, str
);
468 static inline unsigned long lock_flag(enum lock_usage_bit bit
)
473 static char get_usage_char(struct lock_class
*class, enum lock_usage_bit bit
)
477 if (class->usage_mask
& lock_flag(bit
+ 2))
479 if (class->usage_mask
& lock_flag(bit
)) {
481 if (class->usage_mask
& lock_flag(bit
+ 2))
488 void get_usage_chars(struct lock_class
*class, char usage
[LOCK_USAGE_CHARS
])
492 #define LOCKDEP_STATE(__STATE) \
493 usage[i++] = get_usage_char(class, LOCK_USED_IN_##__STATE); \
494 usage[i++] = get_usage_char(class, LOCK_USED_IN_##__STATE##_READ);
495 #include "lockdep_states.h"
501 static int __print_lock_name(struct lock_class
*class)
503 char str
[KSYM_NAME_LEN
];
508 name
= __get_key_name(class->key
, str
);
510 return printk("%s", name
);
513 static void print_lock_name(struct lock_class
*class)
515 char str
[KSYM_NAME_LEN
], usage
[LOCK_USAGE_CHARS
];
518 get_usage_chars(class, usage
);
522 name
= __get_key_name(class->key
, str
);
523 printk(" (%s", name
);
525 printk(" (%s", name
);
526 if (class->name_version
> 1)
527 printk("#%d", class->name_version
);
529 printk("/%d", class->subclass
);
531 printk("){%s}", usage
);
534 static void print_lockdep_cache(struct lockdep_map
*lock
)
537 char str
[KSYM_NAME_LEN
];
541 name
= __get_key_name(lock
->key
->subkeys
, str
);
546 static void print_lock(struct held_lock
*hlock
)
548 print_lock_name(hlock_class(hlock
));
550 print_ip_sym(hlock
->acquire_ip
);
553 static void lockdep_print_held_locks(struct task_struct
*curr
)
555 int i
, depth
= curr
->lockdep_depth
;
558 printk("no locks held by %s/%d.\n", curr
->comm
, task_pid_nr(curr
));
561 printk("%d lock%s held by %s/%d:\n",
562 depth
, depth
> 1 ? "s" : "", curr
->comm
, task_pid_nr(curr
));
564 for (i
= 0; i
< depth
; i
++) {
566 print_lock(curr
->held_locks
+ i
);
570 static void print_kernel_version(void)
572 printk("%s %.*s\n", init_utsname()->release
,
573 (int)strcspn(init_utsname()->version
, " "),
574 init_utsname()->version
);
577 static int very_verbose(struct lock_class
*class)
580 return class_filter(class);
586 * Is this the address of a static object:
588 static int static_obj(void *obj
)
590 unsigned long start
= (unsigned long) &_stext
,
591 end
= (unsigned long) &_end
,
592 addr
= (unsigned long) obj
;
597 if ((addr
>= start
) && (addr
< end
))
600 if (arch_is_kernel_data(addr
))
604 * in-kernel percpu var?
606 if (is_kernel_percpu_address(addr
))
610 * module static or percpu var?
612 return is_module_address(addr
) || is_module_percpu_address(addr
);
616 * To make lock name printouts unique, we calculate a unique
617 * class->name_version generation counter:
619 static int count_matching_names(struct lock_class
*new_class
)
621 struct lock_class
*class;
624 if (!new_class
->name
)
627 list_for_each_entry(class, &all_lock_classes
, lock_entry
) {
628 if (new_class
->key
- new_class
->subclass
== class->key
)
629 return class->name_version
;
630 if (class->name
&& !strcmp(class->name
, new_class
->name
))
631 count
= max(count
, class->name_version
);
638 * Register a lock's class in the hash-table, if the class is not present
639 * yet. Otherwise we look it up. We cache the result in the lock object
640 * itself, so actual lookup of the hash should be once per lock object.
642 static inline struct lock_class
*
643 look_up_lock_class(struct lockdep_map
*lock
, unsigned int subclass
)
645 struct lockdep_subclass_key
*key
;
646 struct list_head
*hash_head
;
647 struct lock_class
*class;
649 #ifdef CONFIG_DEBUG_LOCKDEP
651 * If the architecture calls into lockdep before initializing
652 * the hashes then we'll warn about it later. (we cannot printk
655 if (unlikely(!lockdep_initialized
)) {
657 lockdep_init_error
= 1;
658 save_stack_trace(&lockdep_init_trace
);
662 if (unlikely(subclass
>= MAX_LOCKDEP_SUBCLASSES
)) {
665 "BUG: looking up invalid subclass: %u\n", subclass
);
667 "turning off the locking correctness validator.\n");
673 * Static locks do not have their class-keys yet - for them the key
674 * is the lock object itself:
676 if (unlikely(!lock
->key
))
677 lock
->key
= (void *)lock
;
680 * NOTE: the class-key must be unique. For dynamic locks, a static
681 * lock_class_key variable is passed in through the mutex_init()
682 * (or spin_lock_init()) call - which acts as the key. For static
683 * locks we use the lock object itself as the key.
685 BUILD_BUG_ON(sizeof(struct lock_class_key
) >
686 sizeof(struct lockdep_map
));
688 key
= lock
->key
->subkeys
+ subclass
;
690 hash_head
= classhashentry(key
);
693 * We can walk the hash lockfree, because the hash only
694 * grows, and we are careful when adding entries to the end:
696 list_for_each_entry(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 * Register a lock's class in the hash-table, if the class is not present
712 * yet. Otherwise we look it up. We cache the result in the lock object
713 * itself, so actual lookup of the hash should be once per lock object.
715 static inline struct lock_class
*
716 register_lock_class(struct lockdep_map
*lock
, unsigned int subclass
, int force
)
718 struct lockdep_subclass_key
*key
;
719 struct list_head
*hash_head
;
720 struct lock_class
*class;
723 class = look_up_lock_class(lock
, subclass
);
728 * Debug-check: all keys must be persistent!
730 if (!static_obj(lock
->key
)) {
732 printk("INFO: trying to register non-static key.\n");
733 printk("the code is fine but needs lockdep annotation.\n");
734 printk("turning off the locking correctness validator.\n");
740 key
= lock
->key
->subkeys
+ subclass
;
741 hash_head
= classhashentry(key
);
743 raw_local_irq_save(flags
);
745 raw_local_irq_restore(flags
);
749 * We have to do the hash-walk again, to avoid races
752 list_for_each_entry(class, hash_head
, hash_entry
)
753 if (class->key
== key
)
756 * Allocate a new key from the static array, and add it to
759 if (nr_lock_classes
>= MAX_LOCKDEP_KEYS
) {
760 if (!debug_locks_off_graph_unlock()) {
761 raw_local_irq_restore(flags
);
764 raw_local_irq_restore(flags
);
766 printk("BUG: MAX_LOCKDEP_KEYS too low!\n");
767 printk("turning off the locking correctness validator.\n");
771 class = lock_classes
+ nr_lock_classes
++;
772 debug_atomic_inc(nr_unused_locks
);
774 class->name
= lock
->name
;
775 class->subclass
= subclass
;
776 INIT_LIST_HEAD(&class->lock_entry
);
777 INIT_LIST_HEAD(&class->locks_before
);
778 INIT_LIST_HEAD(&class->locks_after
);
779 class->name_version
= count_matching_names(class);
781 * We use RCU's safe list-add method to make
782 * parallel walking of the hash-list safe:
784 list_add_tail_rcu(&class->hash_entry
, hash_head
);
786 * Add it to the global list of classes:
788 list_add_tail_rcu(&class->lock_entry
, &all_lock_classes
);
790 if (verbose(class)) {
792 raw_local_irq_restore(flags
);
794 printk("\nnew class %p: %s", class->key
, class->name
);
795 if (class->name_version
> 1)
796 printk("#%d", class->name_version
);
800 raw_local_irq_save(flags
);
802 raw_local_irq_restore(flags
);
808 raw_local_irq_restore(flags
);
810 if (!subclass
|| force
)
811 lock
->class_cache
[0] = class;
812 else if (subclass
< NR_LOCKDEP_CACHING_CLASSES
)
813 lock
->class_cache
[subclass
] = class;
816 * Hash collision, did we smoke some? We found a class with a matching
817 * hash but the subclass -- which is hashed in -- didn't match.
819 if (DEBUG_LOCKS_WARN_ON(class->subclass
!= subclass
))
825 #ifdef CONFIG_PROVE_LOCKING
827 * Allocate a lockdep entry. (assumes the graph_lock held, returns
828 * with NULL on failure)
830 static struct lock_list
*alloc_list_entry(void)
832 if (nr_list_entries
>= MAX_LOCKDEP_ENTRIES
) {
833 if (!debug_locks_off_graph_unlock())
836 printk("BUG: MAX_LOCKDEP_ENTRIES too low!\n");
837 printk("turning off the locking correctness validator.\n");
841 return list_entries
+ nr_list_entries
++;
845 * Add a new dependency to the head of the list:
847 static int add_lock_to_list(struct lock_class
*class, struct lock_class
*this,
848 struct list_head
*head
, unsigned long ip
,
849 int distance
, struct stack_trace
*trace
)
851 struct lock_list
*entry
;
853 * Lock not present yet - get a new dependency struct and
854 * add it to the list:
856 entry
= alloc_list_entry();
861 entry
->distance
= distance
;
862 entry
->trace
= *trace
;
864 * Since we never remove from the dependency list, the list can
865 * be walked lockless by other CPUs, it's only allocation
866 * that must be protected by the spinlock. But this also means
867 * we must make new entries visible only once writes to the
868 * entry become visible - hence the RCU op:
870 list_add_tail_rcu(&entry
->entry
, head
);
876 * For good efficiency of modular, we use power of 2
878 #define MAX_CIRCULAR_QUEUE_SIZE 4096UL
879 #define CQ_MASK (MAX_CIRCULAR_QUEUE_SIZE-1)
882 * The circular_queue and helpers is used to implement the
883 * breadth-first search(BFS)algorithem, by which we can build
884 * the shortest path from the next lock to be acquired to the
885 * previous held lock if there is a circular between them.
887 struct circular_queue
{
888 unsigned long element
[MAX_CIRCULAR_QUEUE_SIZE
];
889 unsigned int front
, rear
;
892 static struct circular_queue lock_cq
;
894 unsigned int max_bfs_queue_depth
;
896 static unsigned int lockdep_dependency_gen_id
;
898 static inline void __cq_init(struct circular_queue
*cq
)
900 cq
->front
= cq
->rear
= 0;
901 lockdep_dependency_gen_id
++;
904 static inline int __cq_empty(struct circular_queue
*cq
)
906 return (cq
->front
== cq
->rear
);
909 static inline int __cq_full(struct circular_queue
*cq
)
911 return ((cq
->rear
+ 1) & CQ_MASK
) == cq
->front
;
914 static inline int __cq_enqueue(struct circular_queue
*cq
, unsigned long elem
)
919 cq
->element
[cq
->rear
] = elem
;
920 cq
->rear
= (cq
->rear
+ 1) & CQ_MASK
;
924 static inline int __cq_dequeue(struct circular_queue
*cq
, unsigned long *elem
)
929 *elem
= cq
->element
[cq
->front
];
930 cq
->front
= (cq
->front
+ 1) & CQ_MASK
;
934 static inline unsigned int __cq_get_elem_count(struct circular_queue
*cq
)
936 return (cq
->rear
- cq
->front
) & CQ_MASK
;
939 static inline void mark_lock_accessed(struct lock_list
*lock
,
940 struct lock_list
*parent
)
944 nr
= lock
- list_entries
;
945 WARN_ON(nr
>= nr_list_entries
); /* Out-of-bounds, input fail */
946 lock
->parent
= parent
;
947 lock
->class->dep_gen_id
= lockdep_dependency_gen_id
;
950 static inline unsigned long lock_accessed(struct lock_list
*lock
)
954 nr
= lock
- list_entries
;
955 WARN_ON(nr
>= nr_list_entries
); /* Out-of-bounds, input fail */
956 return lock
->class->dep_gen_id
== lockdep_dependency_gen_id
;
959 static inline struct lock_list
*get_lock_parent(struct lock_list
*child
)
961 return child
->parent
;
964 static inline int get_lock_depth(struct lock_list
*child
)
967 struct lock_list
*parent
;
969 while ((parent
= get_lock_parent(child
))) {
976 static int __bfs(struct lock_list
*source_entry
,
978 int (*match
)(struct lock_list
*entry
, void *data
),
979 struct lock_list
**target_entry
,
982 struct lock_list
*entry
;
983 struct list_head
*head
;
984 struct circular_queue
*cq
= &lock_cq
;
987 if (match(source_entry
, data
)) {
988 *target_entry
= source_entry
;
994 head
= &source_entry
->class->locks_after
;
996 head
= &source_entry
->class->locks_before
;
998 if (list_empty(head
))
1002 __cq_enqueue(cq
, (unsigned long)source_entry
);
1004 while (!__cq_empty(cq
)) {
1005 struct lock_list
*lock
;
1007 __cq_dequeue(cq
, (unsigned long *)&lock
);
1015 head
= &lock
->class->locks_after
;
1017 head
= &lock
->class->locks_before
;
1019 list_for_each_entry(entry
, head
, entry
) {
1020 if (!lock_accessed(entry
)) {
1021 unsigned int cq_depth
;
1022 mark_lock_accessed(entry
, lock
);
1023 if (match(entry
, data
)) {
1024 *target_entry
= entry
;
1029 if (__cq_enqueue(cq
, (unsigned long)entry
)) {
1033 cq_depth
= __cq_get_elem_count(cq
);
1034 if (max_bfs_queue_depth
< cq_depth
)
1035 max_bfs_queue_depth
= cq_depth
;
1043 static inline int __bfs_forwards(struct lock_list
*src_entry
,
1045 int (*match
)(struct lock_list
*entry
, void *data
),
1046 struct lock_list
**target_entry
)
1048 return __bfs(src_entry
, data
, match
, target_entry
, 1);
1052 static inline int __bfs_backwards(struct lock_list
*src_entry
,
1054 int (*match
)(struct lock_list
*entry
, void *data
),
1055 struct lock_list
**target_entry
)
1057 return __bfs(src_entry
, data
, match
, target_entry
, 0);
1062 * Recursive, forwards-direction lock-dependency checking, used for
1063 * both noncyclic checking and for hardirq-unsafe/softirq-unsafe
1068 * Print a dependency chain entry (this is only done when a deadlock
1069 * has been detected):
1072 print_circular_bug_entry(struct lock_list
*target
, int depth
)
1074 if (debug_locks_silent
)
1076 printk("\n-> #%u", depth
);
1077 print_lock_name(target
->class);
1079 print_stack_trace(&target
->trace
, 6);
1085 print_circular_lock_scenario(struct held_lock
*src
,
1086 struct held_lock
*tgt
,
1087 struct lock_list
*prt
)
1089 struct lock_class
*source
= hlock_class(src
);
1090 struct lock_class
*target
= hlock_class(tgt
);
1091 struct lock_class
*parent
= prt
->class;
1094 * A direct locking problem where unsafe_class lock is taken
1095 * directly by safe_class lock, then all we need to show
1096 * is the deadlock scenario, as it is obvious that the
1097 * unsafe lock is taken under the safe lock.
1099 * But if there is a chain instead, where the safe lock takes
1100 * an intermediate lock (middle_class) where this lock is
1101 * not the same as the safe lock, then the lock chain is
1102 * used to describe the problem. Otherwise we would need
1103 * to show a different CPU case for each link in the chain
1104 * from the safe_class lock to the unsafe_class lock.
1106 if (parent
!= source
) {
1107 printk("Chain exists of:\n ");
1108 __print_lock_name(source
);
1110 __print_lock_name(parent
);
1112 __print_lock_name(target
);
1116 printk(" Possible unsafe locking scenario:\n\n");
1117 printk(" CPU0 CPU1\n");
1118 printk(" ---- ----\n");
1120 __print_lock_name(target
);
1123 __print_lock_name(parent
);
1126 __print_lock_name(target
);
1129 __print_lock_name(source
);
1131 printk("\n *** DEADLOCK ***\n\n");
1135 * When a circular dependency is detected, print the
1139 print_circular_bug_header(struct lock_list
*entry
, unsigned int depth
,
1140 struct held_lock
*check_src
,
1141 struct held_lock
*check_tgt
)
1143 struct task_struct
*curr
= current
;
1145 if (debug_locks_silent
)
1149 printk("======================================================\n");
1150 printk("[ INFO: possible circular locking dependency detected ]\n");
1151 print_kernel_version();
1152 printk("-------------------------------------------------------\n");
1153 printk("%s/%d is trying to acquire lock:\n",
1154 curr
->comm
, task_pid_nr(curr
));
1155 print_lock(check_src
);
1156 printk("\nbut task is already holding lock:\n");
1157 print_lock(check_tgt
);
1158 printk("\nwhich lock already depends on the new lock.\n\n");
1159 printk("\nthe existing dependency chain (in reverse order) is:\n");
1161 print_circular_bug_entry(entry
, depth
);
1166 static inline int class_equal(struct lock_list
*entry
, void *data
)
1168 return entry
->class == data
;
1171 static noinline
int print_circular_bug(struct lock_list
*this,
1172 struct lock_list
*target
,
1173 struct held_lock
*check_src
,
1174 struct held_lock
*check_tgt
)
1176 struct task_struct
*curr
= current
;
1177 struct lock_list
*parent
;
1178 struct lock_list
*first_parent
;
1181 if (!debug_locks_off_graph_unlock() || debug_locks_silent
)
1184 if (!save_trace(&this->trace
))
1187 depth
= get_lock_depth(target
);
1189 print_circular_bug_header(target
, depth
, check_src
, check_tgt
);
1191 parent
= get_lock_parent(target
);
1192 first_parent
= parent
;
1195 print_circular_bug_entry(parent
, --depth
);
1196 parent
= get_lock_parent(parent
);
1199 printk("\nother info that might help us debug this:\n\n");
1200 print_circular_lock_scenario(check_src
, check_tgt
,
1203 lockdep_print_held_locks(curr
);
1205 printk("\nstack backtrace:\n");
1211 static noinline
int print_bfs_bug(int ret
)
1213 if (!debug_locks_off_graph_unlock())
1217 * Breadth-first-search failed, graph got corrupted?
1219 WARN(1, "lockdep bfs error:%d\n", ret
);
1224 static int noop_count(struct lock_list
*entry
, void *data
)
1226 (*(unsigned long *)data
)++;
1230 unsigned long __lockdep_count_forward_deps(struct lock_list
*this)
1232 unsigned long count
= 0;
1233 struct lock_list
*uninitialized_var(target_entry
);
1235 __bfs_forwards(this, (void *)&count
, noop_count
, &target_entry
);
1239 unsigned long lockdep_count_forward_deps(struct lock_class
*class)
1241 unsigned long ret
, flags
;
1242 struct lock_list
this;
1247 local_irq_save(flags
);
1248 arch_spin_lock(&lockdep_lock
);
1249 ret
= __lockdep_count_forward_deps(&this);
1250 arch_spin_unlock(&lockdep_lock
);
1251 local_irq_restore(flags
);
1256 unsigned long __lockdep_count_backward_deps(struct lock_list
*this)
1258 unsigned long count
= 0;
1259 struct lock_list
*uninitialized_var(target_entry
);
1261 __bfs_backwards(this, (void *)&count
, noop_count
, &target_entry
);
1266 unsigned long lockdep_count_backward_deps(struct lock_class
*class)
1268 unsigned long ret
, flags
;
1269 struct lock_list
this;
1274 local_irq_save(flags
);
1275 arch_spin_lock(&lockdep_lock
);
1276 ret
= __lockdep_count_backward_deps(&this);
1277 arch_spin_unlock(&lockdep_lock
);
1278 local_irq_restore(flags
);
1284 * Prove that the dependency graph starting at <entry> can not
1285 * lead to <target>. Print an error and return 0 if it does.
1288 check_noncircular(struct lock_list
*root
, struct lock_class
*target
,
1289 struct lock_list
**target_entry
)
1293 debug_atomic_inc(nr_cyclic_checks
);
1295 result
= __bfs_forwards(root
, target
, class_equal
, target_entry
);
1300 #if defined(CONFIG_TRACE_IRQFLAGS) && defined(CONFIG_PROVE_LOCKING)
1302 * Forwards and backwards subgraph searching, for the purposes of
1303 * proving that two subgraphs can be connected by a new dependency
1304 * without creating any illegal irq-safe -> irq-unsafe lock dependency.
1307 static inline int usage_match(struct lock_list
*entry
, void *bit
)
1309 return entry
->class->usage_mask
& (1 << (enum lock_usage_bit
)bit
);
1315 * Find a node in the forwards-direction dependency sub-graph starting
1316 * at @root->class that matches @bit.
1318 * Return 0 if such a node exists in the subgraph, and put that node
1319 * into *@target_entry.
1321 * Return 1 otherwise and keep *@target_entry unchanged.
1322 * Return <0 on error.
1325 find_usage_forwards(struct lock_list
*root
, enum lock_usage_bit bit
,
1326 struct lock_list
**target_entry
)
1330 debug_atomic_inc(nr_find_usage_forwards_checks
);
1332 result
= __bfs_forwards(root
, (void *)bit
, usage_match
, target_entry
);
1338 * Find a node in the backwards-direction dependency sub-graph starting
1339 * at @root->class that matches @bit.
1341 * Return 0 if such a node exists in the subgraph, and put that node
1342 * into *@target_entry.
1344 * Return 1 otherwise and keep *@target_entry unchanged.
1345 * Return <0 on error.
1348 find_usage_backwards(struct lock_list
*root
, enum lock_usage_bit bit
,
1349 struct lock_list
**target_entry
)
1353 debug_atomic_inc(nr_find_usage_backwards_checks
);
1355 result
= __bfs_backwards(root
, (void *)bit
, usage_match
, target_entry
);
1360 static void print_lock_class_header(struct lock_class
*class, int depth
)
1364 printk("%*s->", depth
, "");
1365 print_lock_name(class);
1366 printk(" ops: %lu", class->ops
);
1369 for (bit
= 0; bit
< LOCK_USAGE_STATES
; bit
++) {
1370 if (class->usage_mask
& (1 << bit
)) {
1373 len
+= printk("%*s %s", depth
, "", usage_str
[bit
]);
1374 len
+= printk(" at:\n");
1375 print_stack_trace(class->usage_traces
+ bit
, len
);
1378 printk("%*s }\n", depth
, "");
1380 printk("%*s ... key at: ",depth
,"");
1381 print_ip_sym((unsigned long)class->key
);
1385 * printk the shortest lock dependencies from @start to @end in reverse order:
1388 print_shortest_lock_dependencies(struct lock_list
*leaf
,
1389 struct lock_list
*root
)
1391 struct lock_list
*entry
= leaf
;
1394 /*compute depth from generated tree by BFS*/
1395 depth
= get_lock_depth(leaf
);
1398 print_lock_class_header(entry
->class, depth
);
1399 printk("%*s ... acquired at:\n", depth
, "");
1400 print_stack_trace(&entry
->trace
, 2);
1403 if (depth
== 0 && (entry
!= root
)) {
1404 printk("lockdep:%s bad path found in chain graph\n", __func__
);
1408 entry
= get_lock_parent(entry
);
1410 } while (entry
&& (depth
>= 0));
1416 print_irq_lock_scenario(struct lock_list
*safe_entry
,
1417 struct lock_list
*unsafe_entry
,
1418 struct lock_class
*prev_class
,
1419 struct lock_class
*next_class
)
1421 struct lock_class
*safe_class
= safe_entry
->class;
1422 struct lock_class
*unsafe_class
= unsafe_entry
->class;
1423 struct lock_class
*middle_class
= prev_class
;
1425 if (middle_class
== safe_class
)
1426 middle_class
= next_class
;
1429 * A direct locking problem where unsafe_class lock is taken
1430 * directly by safe_class lock, then all we need to show
1431 * is the deadlock scenario, as it is obvious that the
1432 * unsafe lock is taken under the safe lock.
1434 * But if there is a chain instead, where the safe lock takes
1435 * an intermediate lock (middle_class) where this lock is
1436 * not the same as the safe lock, then the lock chain is
1437 * used to describe the problem. Otherwise we would need
1438 * to show a different CPU case for each link in the chain
1439 * from the safe_class lock to the unsafe_class lock.
1441 if (middle_class
!= unsafe_class
) {
1442 printk("Chain exists of:\n ");
1443 __print_lock_name(safe_class
);
1445 __print_lock_name(middle_class
);
1447 __print_lock_name(unsafe_class
);
1451 printk(" Possible interrupt unsafe locking scenario:\n\n");
1452 printk(" CPU0 CPU1\n");
1453 printk(" ---- ----\n");
1455 __print_lock_name(unsafe_class
);
1457 printk(" local_irq_disable();\n");
1459 __print_lock_name(safe_class
);
1462 __print_lock_name(middle_class
);
1464 printk(" <Interrupt>\n");
1466 __print_lock_name(safe_class
);
1468 printk("\n *** DEADLOCK ***\n\n");
1472 print_bad_irq_dependency(struct task_struct
*curr
,
1473 struct lock_list
*prev_root
,
1474 struct lock_list
*next_root
,
1475 struct lock_list
*backwards_entry
,
1476 struct lock_list
*forwards_entry
,
1477 struct held_lock
*prev
,
1478 struct held_lock
*next
,
1479 enum lock_usage_bit bit1
,
1480 enum lock_usage_bit bit2
,
1481 const char *irqclass
)
1483 if (!debug_locks_off_graph_unlock() || debug_locks_silent
)
1487 printk("======================================================\n");
1488 printk("[ INFO: %s-safe -> %s-unsafe lock order detected ]\n",
1489 irqclass
, irqclass
);
1490 print_kernel_version();
1491 printk("------------------------------------------------------\n");
1492 printk("%s/%d [HC%u[%lu]:SC%u[%lu]:HE%u:SE%u] is trying to acquire:\n",
1493 curr
->comm
, task_pid_nr(curr
),
1494 curr
->hardirq_context
, hardirq_count() >> HARDIRQ_SHIFT
,
1495 curr
->softirq_context
, softirq_count() >> SOFTIRQ_SHIFT
,
1496 curr
->hardirqs_enabled
,
1497 curr
->softirqs_enabled
);
1500 printk("\nand this task is already holding:\n");
1502 printk("which would create a new lock dependency:\n");
1503 print_lock_name(hlock_class(prev
));
1505 print_lock_name(hlock_class(next
));
1508 printk("\nbut this new dependency connects a %s-irq-safe lock:\n",
1510 print_lock_name(backwards_entry
->class);
1511 printk("\n... which became %s-irq-safe at:\n", irqclass
);
1513 print_stack_trace(backwards_entry
->class->usage_traces
+ bit1
, 1);
1515 printk("\nto a %s-irq-unsafe lock:\n", irqclass
);
1516 print_lock_name(forwards_entry
->class);
1517 printk("\n... which became %s-irq-unsafe at:\n", irqclass
);
1520 print_stack_trace(forwards_entry
->class->usage_traces
+ bit2
, 1);
1522 printk("\nother info that might help us debug this:\n\n");
1523 print_irq_lock_scenario(backwards_entry
, forwards_entry
,
1524 hlock_class(prev
), hlock_class(next
));
1526 lockdep_print_held_locks(curr
);
1528 printk("\nthe dependencies between %s-irq-safe lock", irqclass
);
1529 printk(" and the holding lock:\n");
1530 if (!save_trace(&prev_root
->trace
))
1532 print_shortest_lock_dependencies(backwards_entry
, prev_root
);
1534 printk("\nthe dependencies between the lock to be acquired");
1535 printk(" and %s-irq-unsafe lock:\n", irqclass
);
1536 if (!save_trace(&next_root
->trace
))
1538 print_shortest_lock_dependencies(forwards_entry
, next_root
);
1540 printk("\nstack backtrace:\n");
1547 check_usage(struct task_struct
*curr
, struct held_lock
*prev
,
1548 struct held_lock
*next
, enum lock_usage_bit bit_backwards
,
1549 enum lock_usage_bit bit_forwards
, const char *irqclass
)
1552 struct lock_list
this, that
;
1553 struct lock_list
*uninitialized_var(target_entry
);
1554 struct lock_list
*uninitialized_var(target_entry1
);
1558 this.class = hlock_class(prev
);
1559 ret
= find_usage_backwards(&this, bit_backwards
, &target_entry
);
1561 return print_bfs_bug(ret
);
1566 that
.class = hlock_class(next
);
1567 ret
= find_usage_forwards(&that
, bit_forwards
, &target_entry1
);
1569 return print_bfs_bug(ret
);
1573 return print_bad_irq_dependency(curr
, &this, &that
,
1574 target_entry
, target_entry1
,
1576 bit_backwards
, bit_forwards
, irqclass
);
1579 static const char *state_names
[] = {
1580 #define LOCKDEP_STATE(__STATE) \
1581 __stringify(__STATE),
1582 #include "lockdep_states.h"
1583 #undef LOCKDEP_STATE
1586 static const char *state_rnames
[] = {
1587 #define LOCKDEP_STATE(__STATE) \
1588 __stringify(__STATE)"-READ",
1589 #include "lockdep_states.h"
1590 #undef LOCKDEP_STATE
1593 static inline const char *state_name(enum lock_usage_bit bit
)
1595 return (bit
& 1) ? state_rnames
[bit
>> 2] : state_names
[bit
>> 2];
1598 static int exclusive_bit(int new_bit
)
1606 * bit 0 - write/read
1607 * bit 1 - used_in/enabled
1611 int state
= new_bit
& ~3;
1612 int dir
= new_bit
& 2;
1615 * keep state, bit flip the direction and strip read.
1617 return state
| (dir
^ 2);
1620 static int check_irq_usage(struct task_struct
*curr
, struct held_lock
*prev
,
1621 struct held_lock
*next
, enum lock_usage_bit bit
)
1624 * Prove that the new dependency does not connect a hardirq-safe
1625 * lock with a hardirq-unsafe lock - to achieve this we search
1626 * the backwards-subgraph starting at <prev>, and the
1627 * forwards-subgraph starting at <next>:
1629 if (!check_usage(curr
, prev
, next
, bit
,
1630 exclusive_bit(bit
), state_name(bit
)))
1636 * Prove that the new dependency does not connect a hardirq-safe-read
1637 * lock with a hardirq-unsafe lock - to achieve this we search
1638 * the backwards-subgraph starting at <prev>, and the
1639 * forwards-subgraph starting at <next>:
1641 if (!check_usage(curr
, prev
, next
, bit
,
1642 exclusive_bit(bit
), state_name(bit
)))
1649 check_prev_add_irq(struct task_struct
*curr
, struct held_lock
*prev
,
1650 struct held_lock
*next
)
1652 #define LOCKDEP_STATE(__STATE) \
1653 if (!check_irq_usage(curr, prev, next, LOCK_USED_IN_##__STATE)) \
1655 #include "lockdep_states.h"
1656 #undef LOCKDEP_STATE
1661 static void inc_chains(void)
1663 if (current
->hardirq_context
)
1664 nr_hardirq_chains
++;
1666 if (current
->softirq_context
)
1667 nr_softirq_chains
++;
1669 nr_process_chains
++;
1676 check_prev_add_irq(struct task_struct
*curr
, struct held_lock
*prev
,
1677 struct held_lock
*next
)
1682 static inline void inc_chains(void)
1684 nr_process_chains
++;
1690 print_deadlock_scenario(struct held_lock
*nxt
,
1691 struct held_lock
*prv
)
1693 struct lock_class
*next
= hlock_class(nxt
);
1694 struct lock_class
*prev
= hlock_class(prv
);
1696 printk(" Possible unsafe locking scenario:\n\n");
1700 __print_lock_name(prev
);
1703 __print_lock_name(next
);
1705 printk("\n *** DEADLOCK ***\n\n");
1706 printk(" May be due to missing lock nesting notation\n\n");
1710 print_deadlock_bug(struct task_struct
*curr
, struct held_lock
*prev
,
1711 struct held_lock
*next
)
1713 if (!debug_locks_off_graph_unlock() || debug_locks_silent
)
1717 printk("=============================================\n");
1718 printk("[ INFO: possible recursive locking detected ]\n");
1719 print_kernel_version();
1720 printk("---------------------------------------------\n");
1721 printk("%s/%d is trying to acquire lock:\n",
1722 curr
->comm
, task_pid_nr(curr
));
1724 printk("\nbut task is already holding lock:\n");
1727 printk("\nother info that might help us debug this:\n");
1728 print_deadlock_scenario(next
, prev
);
1729 lockdep_print_held_locks(curr
);
1731 printk("\nstack backtrace:\n");
1738 * Check whether we are holding such a class already.
1740 * (Note that this has to be done separately, because the graph cannot
1741 * detect such classes of deadlocks.)
1743 * Returns: 0 on deadlock detected, 1 on OK, 2 on recursive read
1746 check_deadlock(struct task_struct
*curr
, struct held_lock
*next
,
1747 struct lockdep_map
*next_instance
, int read
)
1749 struct held_lock
*prev
;
1750 struct held_lock
*nest
= NULL
;
1753 for (i
= 0; i
< curr
->lockdep_depth
; i
++) {
1754 prev
= curr
->held_locks
+ i
;
1756 if (prev
->instance
== next
->nest_lock
)
1759 if (hlock_class(prev
) != hlock_class(next
))
1763 * Allow read-after-read recursion of the same
1764 * lock class (i.e. read_lock(lock)+read_lock(lock)):
1766 if ((read
== 2) && prev
->read
)
1770 * We're holding the nest_lock, which serializes this lock's
1771 * nesting behaviour.
1776 return print_deadlock_bug(curr
, prev
, next
);
1782 * There was a chain-cache miss, and we are about to add a new dependency
1783 * to a previous lock. We recursively validate the following rules:
1785 * - would the adding of the <prev> -> <next> dependency create a
1786 * circular dependency in the graph? [== circular deadlock]
1788 * - does the new prev->next dependency connect any hardirq-safe lock
1789 * (in the full backwards-subgraph starting at <prev>) with any
1790 * hardirq-unsafe lock (in the full forwards-subgraph starting at
1791 * <next>)? [== illegal lock inversion with hardirq contexts]
1793 * - does the new prev->next dependency connect any softirq-safe lock
1794 * (in the full backwards-subgraph starting at <prev>) with any
1795 * softirq-unsafe lock (in the full forwards-subgraph starting at
1796 * <next>)? [== illegal lock inversion with softirq contexts]
1798 * any of these scenarios could lead to a deadlock.
1800 * Then if all the validations pass, we add the forwards and backwards
1804 check_prev_add(struct task_struct
*curr
, struct held_lock
*prev
,
1805 struct held_lock
*next
, int distance
, int trylock_loop
)
1807 struct lock_list
*entry
;
1809 struct lock_list
this;
1810 struct lock_list
*uninitialized_var(target_entry
);
1812 * Static variable, serialized by the graph_lock().
1814 * We use this static variable to save the stack trace in case
1815 * we call into this function multiple times due to encountering
1816 * trylocks in the held lock stack.
1818 static struct stack_trace trace
;
1821 * Prove that the new <prev> -> <next> dependency would not
1822 * create a circular dependency in the graph. (We do this by
1823 * forward-recursing into the graph starting at <next>, and
1824 * checking whether we can reach <prev>.)
1826 * We are using global variables to control the recursion, to
1827 * keep the stackframe size of the recursive functions low:
1829 this.class = hlock_class(next
);
1831 ret
= check_noncircular(&this, hlock_class(prev
), &target_entry
);
1833 return print_circular_bug(&this, target_entry
, next
, prev
);
1834 else if (unlikely(ret
< 0))
1835 return print_bfs_bug(ret
);
1837 if (!check_prev_add_irq(curr
, prev
, next
))
1841 * For recursive read-locks we do all the dependency checks,
1842 * but we dont store read-triggered dependencies (only
1843 * write-triggered dependencies). This ensures that only the
1844 * write-side dependencies matter, and that if for example a
1845 * write-lock never takes any other locks, then the reads are
1846 * equivalent to a NOP.
1848 if (next
->read
== 2 || prev
->read
== 2)
1851 * Is the <prev> -> <next> dependency already present?
1853 * (this may occur even though this is a new chain: consider
1854 * e.g. the L1 -> L2 -> L3 -> L4 and the L5 -> L1 -> L2 -> L3
1855 * chains - the second one will be new, but L1 already has
1856 * L2 added to its dependency list, due to the first chain.)
1858 list_for_each_entry(entry
, &hlock_class(prev
)->locks_after
, entry
) {
1859 if (entry
->class == hlock_class(next
)) {
1861 entry
->distance
= 1;
1866 if (!trylock_loop
&& !save_trace(&trace
))
1870 * Ok, all validations passed, add the new lock
1871 * to the previous lock's dependency list:
1873 ret
= add_lock_to_list(hlock_class(prev
), hlock_class(next
),
1874 &hlock_class(prev
)->locks_after
,
1875 next
->acquire_ip
, distance
, &trace
);
1880 ret
= add_lock_to_list(hlock_class(next
), hlock_class(prev
),
1881 &hlock_class(next
)->locks_before
,
1882 next
->acquire_ip
, distance
, &trace
);
1887 * Debugging printouts:
1889 if (verbose(hlock_class(prev
)) || verbose(hlock_class(next
))) {
1891 printk("\n new dependency: ");
1892 print_lock_name(hlock_class(prev
));
1894 print_lock_name(hlock_class(next
));
1897 return graph_lock();
1903 * Add the dependency to all directly-previous locks that are 'relevant'.
1904 * The ones that are relevant are (in increasing distance from curr):
1905 * all consecutive trylock entries and the final non-trylock entry - or
1906 * the end of this context's lock-chain - whichever comes first.
1909 check_prevs_add(struct task_struct
*curr
, struct held_lock
*next
)
1911 int depth
= curr
->lockdep_depth
;
1912 int trylock_loop
= 0;
1913 struct held_lock
*hlock
;
1918 * Depth must not be zero for a non-head lock:
1923 * At least two relevant locks must exist for this
1926 if (curr
->held_locks
[depth
].irq_context
!=
1927 curr
->held_locks
[depth
-1].irq_context
)
1931 int distance
= curr
->lockdep_depth
- depth
+ 1;
1932 hlock
= curr
->held_locks
+ depth
-1;
1934 * Only non-recursive-read entries get new dependencies
1937 if (hlock
->read
!= 2) {
1938 if (!check_prev_add(curr
, hlock
, next
,
1939 distance
, trylock_loop
))
1942 * Stop after the first non-trylock entry,
1943 * as non-trylock entries have added their
1944 * own direct dependencies already, so this
1945 * lock is connected to them indirectly:
1947 if (!hlock
->trylock
)
1952 * End of lock-stack?
1957 * Stop the search if we cross into another context:
1959 if (curr
->held_locks
[depth
].irq_context
!=
1960 curr
->held_locks
[depth
-1].irq_context
)
1966 if (!debug_locks_off_graph_unlock())
1970 * Clearly we all shouldn't be here, but since we made it we
1971 * can reliable say we messed up our state. See the above two
1972 * gotos for reasons why we could possibly end up here.
1979 unsigned long nr_lock_chains
;
1980 struct lock_chain lock_chains
[MAX_LOCKDEP_CHAINS
];
1981 int nr_chain_hlocks
;
1982 static u16 chain_hlocks
[MAX_LOCKDEP_CHAIN_HLOCKS
];
1984 struct lock_class
*lock_chain_get_class(struct lock_chain
*chain
, int i
)
1986 return lock_classes
+ chain_hlocks
[chain
->base
+ i
];
1990 * Look up a dependency chain. If the key is not present yet then
1991 * add it and return 1 - in this case the new dependency chain is
1992 * validated. If the key is already hashed, return 0.
1993 * (On return with 1 graph_lock is held.)
1995 static inline int lookup_chain_cache(struct task_struct
*curr
,
1996 struct held_lock
*hlock
,
1999 struct lock_class
*class = hlock_class(hlock
);
2000 struct list_head
*hash_head
= chainhashentry(chain_key
);
2001 struct lock_chain
*chain
;
2002 struct held_lock
*hlock_curr
, *hlock_next
;
2006 * We might need to take the graph lock, ensure we've got IRQs
2007 * disabled to make this an IRQ-safe lock.. for recursion reasons
2008 * lockdep won't complain about its own locking errors.
2010 if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
2013 * We can walk it lock-free, because entries only get added
2016 list_for_each_entry(chain
, hash_head
, entry
) {
2017 if (chain
->chain_key
== chain_key
) {
2019 debug_atomic_inc(chain_lookup_hits
);
2020 if (very_verbose(class))
2021 printk("\nhash chain already cached, key: "
2022 "%016Lx tail class: [%p] %s\n",
2023 (unsigned long long)chain_key
,
2024 class->key
, class->name
);
2028 if (very_verbose(class))
2029 printk("\nnew hash chain, key: %016Lx tail class: [%p] %s\n",
2030 (unsigned long long)chain_key
, class->key
, class->name
);
2032 * Allocate a new chain entry from the static array, and add
2038 * We have to walk the chain again locked - to avoid duplicates:
2040 list_for_each_entry(chain
, hash_head
, entry
) {
2041 if (chain
->chain_key
== chain_key
) {
2046 if (unlikely(nr_lock_chains
>= MAX_LOCKDEP_CHAINS
)) {
2047 if (!debug_locks_off_graph_unlock())
2050 printk("BUG: MAX_LOCKDEP_CHAINS too low!\n");
2051 printk("turning off the locking correctness validator.\n");
2055 chain
= lock_chains
+ nr_lock_chains
++;
2056 chain
->chain_key
= chain_key
;
2057 chain
->irq_context
= hlock
->irq_context
;
2058 /* Find the first held_lock of current chain */
2060 for (i
= curr
->lockdep_depth
- 1; i
>= 0; i
--) {
2061 hlock_curr
= curr
->held_locks
+ i
;
2062 if (hlock_curr
->irq_context
!= hlock_next
->irq_context
)
2067 chain
->depth
= curr
->lockdep_depth
+ 1 - i
;
2068 if (likely(nr_chain_hlocks
+ chain
->depth
<= MAX_LOCKDEP_CHAIN_HLOCKS
)) {
2069 chain
->base
= nr_chain_hlocks
;
2070 nr_chain_hlocks
+= chain
->depth
;
2071 for (j
= 0; j
< chain
->depth
- 1; j
++, i
++) {
2072 int lock_id
= curr
->held_locks
[i
].class_idx
- 1;
2073 chain_hlocks
[chain
->base
+ j
] = lock_id
;
2075 chain_hlocks
[chain
->base
+ j
] = class - lock_classes
;
2077 list_add_tail_rcu(&chain
->entry
, hash_head
);
2078 debug_atomic_inc(chain_lookup_misses
);
2084 static int validate_chain(struct task_struct
*curr
, struct lockdep_map
*lock
,
2085 struct held_lock
*hlock
, int chain_head
, u64 chain_key
)
2088 * Trylock needs to maintain the stack of held locks, but it
2089 * does not add new dependencies, because trylock can be done
2092 * We look up the chain_key and do the O(N^2) check and update of
2093 * the dependencies only if this is a new dependency chain.
2094 * (If lookup_chain_cache() returns with 1 it acquires
2095 * graph_lock for us)
2097 if (!hlock
->trylock
&& (hlock
->check
== 2) &&
2098 lookup_chain_cache(curr
, hlock
, chain_key
)) {
2100 * Check whether last held lock:
2102 * - is irq-safe, if this lock is irq-unsafe
2103 * - is softirq-safe, if this lock is hardirq-unsafe
2105 * And check whether the new lock's dependency graph
2106 * could lead back to the previous lock.
2108 * any of these scenarios could lead to a deadlock. If
2111 int ret
= check_deadlock(curr
, hlock
, lock
, hlock
->read
);
2116 * Mark recursive read, as we jump over it when
2117 * building dependencies (just like we jump over
2123 * Add dependency only if this lock is not the head
2124 * of the chain, and if it's not a secondary read-lock:
2126 if (!chain_head
&& ret
!= 2)
2127 if (!check_prevs_add(curr
, hlock
))
2131 /* after lookup_chain_cache(): */
2132 if (unlikely(!debug_locks
))
2138 static inline int validate_chain(struct task_struct
*curr
,
2139 struct lockdep_map
*lock
, struct held_lock
*hlock
,
2140 int chain_head
, u64 chain_key
)
2147 * We are building curr_chain_key incrementally, so double-check
2148 * it from scratch, to make sure that it's done correctly:
2150 static void check_chain_key(struct task_struct
*curr
)
2152 #ifdef CONFIG_DEBUG_LOCKDEP
2153 struct held_lock
*hlock
, *prev_hlock
= NULL
;
2157 for (i
= 0; i
< curr
->lockdep_depth
; i
++) {
2158 hlock
= curr
->held_locks
+ i
;
2159 if (chain_key
!= hlock
->prev_chain_key
) {
2162 * We got mighty confused, our chain keys don't match
2163 * with what we expect, someone trample on our task state?
2165 WARN(1, "hm#1, depth: %u [%u], %016Lx != %016Lx\n",
2166 curr
->lockdep_depth
, i
,
2167 (unsigned long long)chain_key
,
2168 (unsigned long long)hlock
->prev_chain_key
);
2171 id
= hlock
->class_idx
- 1;
2173 * Whoops ran out of static storage again?
2175 if (DEBUG_LOCKS_WARN_ON(id
>= MAX_LOCKDEP_KEYS
))
2178 if (prev_hlock
&& (prev_hlock
->irq_context
!=
2179 hlock
->irq_context
))
2181 chain_key
= iterate_chain_key(chain_key
, id
);
2184 if (chain_key
!= curr
->curr_chain_key
) {
2187 * More smoking hash instead of calculating it, damn see these
2188 * numbers float.. I bet that a pink elephant stepped on my memory.
2190 WARN(1, "hm#2, depth: %u [%u], %016Lx != %016Lx\n",
2191 curr
->lockdep_depth
, i
,
2192 (unsigned long long)chain_key
,
2193 (unsigned long long)curr
->curr_chain_key
);
2199 print_usage_bug_scenario(struct held_lock
*lock
)
2201 struct lock_class
*class = hlock_class(lock
);
2203 printk(" Possible unsafe locking scenario:\n\n");
2207 __print_lock_name(class);
2209 printk(" <Interrupt>\n");
2211 __print_lock_name(class);
2213 printk("\n *** DEADLOCK ***\n\n");
2217 print_usage_bug(struct task_struct
*curr
, struct held_lock
*this,
2218 enum lock_usage_bit prev_bit
, enum lock_usage_bit new_bit
)
2220 if (!debug_locks_off_graph_unlock() || debug_locks_silent
)
2224 printk("=================================\n");
2225 printk("[ INFO: inconsistent lock state ]\n");
2226 print_kernel_version();
2227 printk("---------------------------------\n");
2229 printk("inconsistent {%s} -> {%s} usage.\n",
2230 usage_str
[prev_bit
], usage_str
[new_bit
]);
2232 printk("%s/%d [HC%u[%lu]:SC%u[%lu]:HE%u:SE%u] takes:\n",
2233 curr
->comm
, task_pid_nr(curr
),
2234 trace_hardirq_context(curr
), hardirq_count() >> HARDIRQ_SHIFT
,
2235 trace_softirq_context(curr
), softirq_count() >> SOFTIRQ_SHIFT
,
2236 trace_hardirqs_enabled(curr
),
2237 trace_softirqs_enabled(curr
));
2240 printk("{%s} state was registered at:\n", usage_str
[prev_bit
]);
2241 print_stack_trace(hlock_class(this)->usage_traces
+ prev_bit
, 1);
2243 print_irqtrace_events(curr
);
2244 printk("\nother info that might help us debug this:\n");
2245 print_usage_bug_scenario(this);
2247 lockdep_print_held_locks(curr
);
2249 printk("\nstack backtrace:\n");
2256 * Print out an error if an invalid bit is set:
2259 valid_state(struct task_struct
*curr
, struct held_lock
*this,
2260 enum lock_usage_bit new_bit
, enum lock_usage_bit bad_bit
)
2262 if (unlikely(hlock_class(this)->usage_mask
& (1 << bad_bit
)))
2263 return print_usage_bug(curr
, this, bad_bit
, new_bit
);
2267 static int mark_lock(struct task_struct
*curr
, struct held_lock
*this,
2268 enum lock_usage_bit new_bit
);
2270 #if defined(CONFIG_TRACE_IRQFLAGS) && defined(CONFIG_PROVE_LOCKING)
2273 * print irq inversion bug:
2276 print_irq_inversion_bug(struct task_struct
*curr
,
2277 struct lock_list
*root
, struct lock_list
*other
,
2278 struct held_lock
*this, int forwards
,
2279 const char *irqclass
)
2281 struct lock_list
*entry
= other
;
2282 struct lock_list
*middle
= NULL
;
2285 if (!debug_locks_off_graph_unlock() || debug_locks_silent
)
2289 printk("=========================================================\n");
2290 printk("[ INFO: possible irq lock inversion dependency detected ]\n");
2291 print_kernel_version();
2292 printk("---------------------------------------------------------\n");
2293 printk("%s/%d just changed the state of lock:\n",
2294 curr
->comm
, task_pid_nr(curr
));
2297 printk("but this lock took another, %s-unsafe lock in the past:\n", irqclass
);
2299 printk("but this lock was taken by another, %s-safe lock in the past:\n", irqclass
);
2300 print_lock_name(other
->class);
2301 printk("\n\nand interrupts could create inverse lock ordering between them.\n\n");
2303 printk("\nother info that might help us debug this:\n");
2305 /* Find a middle lock (if one exists) */
2306 depth
= get_lock_depth(other
);
2308 if (depth
== 0 && (entry
!= root
)) {
2309 printk("lockdep:%s bad path found in chain graph\n", __func__
);
2313 entry
= get_lock_parent(entry
);
2315 } while (entry
&& entry
!= root
&& (depth
>= 0));
2317 print_irq_lock_scenario(root
, other
,
2318 middle
? middle
->class : root
->class, other
->class);
2320 print_irq_lock_scenario(other
, root
,
2321 middle
? middle
->class : other
->class, root
->class);
2323 lockdep_print_held_locks(curr
);
2325 printk("\nthe shortest dependencies between 2nd lock and 1st lock:\n");
2326 if (!save_trace(&root
->trace
))
2328 print_shortest_lock_dependencies(other
, root
);
2330 printk("\nstack backtrace:\n");
2337 * Prove that in the forwards-direction subgraph starting at <this>
2338 * there is no lock matching <mask>:
2341 check_usage_forwards(struct task_struct
*curr
, struct held_lock
*this,
2342 enum lock_usage_bit bit
, const char *irqclass
)
2345 struct lock_list root
;
2346 struct lock_list
*uninitialized_var(target_entry
);
2349 root
.class = hlock_class(this);
2350 ret
= find_usage_forwards(&root
, bit
, &target_entry
);
2352 return print_bfs_bug(ret
);
2356 return print_irq_inversion_bug(curr
, &root
, target_entry
,
2361 * Prove that in the backwards-direction subgraph starting at <this>
2362 * there is no lock matching <mask>:
2365 check_usage_backwards(struct task_struct
*curr
, struct held_lock
*this,
2366 enum lock_usage_bit bit
, const char *irqclass
)
2369 struct lock_list root
;
2370 struct lock_list
*uninitialized_var(target_entry
);
2373 root
.class = hlock_class(this);
2374 ret
= find_usage_backwards(&root
, bit
, &target_entry
);
2376 return print_bfs_bug(ret
);
2380 return print_irq_inversion_bug(curr
, &root
, target_entry
,
2384 void print_irqtrace_events(struct task_struct
*curr
)
2386 printk("irq event stamp: %u\n", curr
->irq_events
);
2387 printk("hardirqs last enabled at (%u): ", curr
->hardirq_enable_event
);
2388 print_ip_sym(curr
->hardirq_enable_ip
);
2389 printk("hardirqs last disabled at (%u): ", curr
->hardirq_disable_event
);
2390 print_ip_sym(curr
->hardirq_disable_ip
);
2391 printk("softirqs last enabled at (%u): ", curr
->softirq_enable_event
);
2392 print_ip_sym(curr
->softirq_enable_ip
);
2393 printk("softirqs last disabled at (%u): ", curr
->softirq_disable_event
);
2394 print_ip_sym(curr
->softirq_disable_ip
);
2397 static int HARDIRQ_verbose(struct lock_class
*class)
2400 return class_filter(class);
2405 static int SOFTIRQ_verbose(struct lock_class
*class)
2408 return class_filter(class);
2413 static int RECLAIM_FS_verbose(struct lock_class
*class)
2416 return class_filter(class);
2421 #define STRICT_READ_CHECKS 1
2423 static int (*state_verbose_f
[])(struct lock_class
*class) = {
2424 #define LOCKDEP_STATE(__STATE) \
2426 #include "lockdep_states.h"
2427 #undef LOCKDEP_STATE
2430 static inline int state_verbose(enum lock_usage_bit bit
,
2431 struct lock_class
*class)
2433 return state_verbose_f
[bit
>> 2](class);
2436 typedef int (*check_usage_f
)(struct task_struct
*, struct held_lock
*,
2437 enum lock_usage_bit bit
, const char *name
);
2440 mark_lock_irq(struct task_struct
*curr
, struct held_lock
*this,
2441 enum lock_usage_bit new_bit
)
2443 int excl_bit
= exclusive_bit(new_bit
);
2444 int read
= new_bit
& 1;
2445 int dir
= new_bit
& 2;
2448 * mark USED_IN has to look forwards -- to ensure no dependency
2449 * has ENABLED state, which would allow recursion deadlocks.
2451 * mark ENABLED has to look backwards -- to ensure no dependee
2452 * has USED_IN state, which, again, would allow recursion deadlocks.
2454 check_usage_f usage
= dir
?
2455 check_usage_backwards
: check_usage_forwards
;
2458 * Validate that this particular lock does not have conflicting
2461 if (!valid_state(curr
, this, new_bit
, excl_bit
))
2465 * Validate that the lock dependencies don't have conflicting usage
2468 if ((!read
|| !dir
|| STRICT_READ_CHECKS
) &&
2469 !usage(curr
, this, excl_bit
, state_name(new_bit
& ~1)))
2473 * Check for read in write conflicts
2476 if (!valid_state(curr
, this, new_bit
, excl_bit
+ 1))
2479 if (STRICT_READ_CHECKS
&&
2480 !usage(curr
, this, excl_bit
+ 1,
2481 state_name(new_bit
+ 1)))
2485 if (state_verbose(new_bit
, hlock_class(this)))
2492 #define LOCKDEP_STATE(__STATE) __STATE,
2493 #include "lockdep_states.h"
2494 #undef LOCKDEP_STATE
2498 * Mark all held locks with a usage bit:
2501 mark_held_locks(struct task_struct
*curr
, enum mark_type mark
)
2503 enum lock_usage_bit usage_bit
;
2504 struct held_lock
*hlock
;
2507 for (i
= 0; i
< curr
->lockdep_depth
; i
++) {
2508 hlock
= curr
->held_locks
+ i
;
2510 usage_bit
= 2 + (mark
<< 2); /* ENABLED */
2512 usage_bit
+= 1; /* READ */
2514 BUG_ON(usage_bit
>= LOCK_USAGE_STATES
);
2516 if (hlock_class(hlock
)->key
== __lockdep_no_validate__
.subkeys
)
2519 if (!mark_lock(curr
, hlock
, usage_bit
))
2527 * Hardirqs will be enabled:
2529 static void __trace_hardirqs_on_caller(unsigned long ip
)
2531 struct task_struct
*curr
= current
;
2533 /* we'll do an OFF -> ON transition: */
2534 curr
->hardirqs_enabled
= 1;
2537 * We are going to turn hardirqs on, so set the
2538 * usage bit for all held locks:
2540 if (!mark_held_locks(curr
, HARDIRQ
))
2543 * If we have softirqs enabled, then set the usage
2544 * bit for all held locks. (disabled hardirqs prevented
2545 * this bit from being set before)
2547 if (curr
->softirqs_enabled
)
2548 if (!mark_held_locks(curr
, SOFTIRQ
))
2551 curr
->hardirq_enable_ip
= ip
;
2552 curr
->hardirq_enable_event
= ++curr
->irq_events
;
2553 debug_atomic_inc(hardirqs_on_events
);
2556 void trace_hardirqs_on_caller(unsigned long ip
)
2558 time_hardirqs_on(CALLER_ADDR0
, ip
);
2560 if (unlikely(!debug_locks
|| current
->lockdep_recursion
))
2563 if (unlikely(current
->hardirqs_enabled
)) {
2565 * Neither irq nor preemption are disabled here
2566 * so this is racy by nature but losing one hit
2567 * in a stat is not a big deal.
2569 __debug_atomic_inc(redundant_hardirqs_on
);
2574 * We're enabling irqs and according to our state above irqs weren't
2575 * already enabled, yet we find the hardware thinks they are in fact
2576 * enabled.. someone messed up their IRQ state tracing.
2578 if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
2582 * See the fine text that goes along with this variable definition.
2584 if (DEBUG_LOCKS_WARN_ON(unlikely(early_boot_irqs_disabled
)))
2588 * Can't allow enabling interrupts while in an interrupt handler,
2589 * that's general bad form and such. Recursion, limited stack etc..
2591 if (DEBUG_LOCKS_WARN_ON(current
->hardirq_context
))
2594 current
->lockdep_recursion
= 1;
2595 __trace_hardirqs_on_caller(ip
);
2596 current
->lockdep_recursion
= 0;
2598 EXPORT_SYMBOL(trace_hardirqs_on_caller
);
2600 void trace_hardirqs_on(void)
2602 trace_hardirqs_on_caller(CALLER_ADDR0
);
2604 EXPORT_SYMBOL(trace_hardirqs_on
);
2607 * Hardirqs were disabled:
2609 void trace_hardirqs_off_caller(unsigned long ip
)
2611 struct task_struct
*curr
= current
;
2613 time_hardirqs_off(CALLER_ADDR0
, ip
);
2615 if (unlikely(!debug_locks
|| current
->lockdep_recursion
))
2619 * So we're supposed to get called after you mask local IRQs, but for
2620 * some reason the hardware doesn't quite think you did a proper job.
2622 if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
2625 if (curr
->hardirqs_enabled
) {
2627 * We have done an ON -> OFF transition:
2629 curr
->hardirqs_enabled
= 0;
2630 curr
->hardirq_disable_ip
= ip
;
2631 curr
->hardirq_disable_event
= ++curr
->irq_events
;
2632 debug_atomic_inc(hardirqs_off_events
);
2634 debug_atomic_inc(redundant_hardirqs_off
);
2636 EXPORT_SYMBOL(trace_hardirqs_off_caller
);
2638 void trace_hardirqs_off(void)
2640 trace_hardirqs_off_caller(CALLER_ADDR0
);
2642 EXPORT_SYMBOL(trace_hardirqs_off
);
2645 * Softirqs will be enabled:
2647 void trace_softirqs_on(unsigned long ip
)
2649 struct task_struct
*curr
= current
;
2651 if (unlikely(!debug_locks
|| current
->lockdep_recursion
))
2655 * We fancy IRQs being disabled here, see softirq.c, avoids
2656 * funny state and nesting things.
2658 if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
2661 if (curr
->softirqs_enabled
) {
2662 debug_atomic_inc(redundant_softirqs_on
);
2666 current
->lockdep_recursion
= 1;
2668 * We'll do an OFF -> ON transition:
2670 curr
->softirqs_enabled
= 1;
2671 curr
->softirq_enable_ip
= ip
;
2672 curr
->softirq_enable_event
= ++curr
->irq_events
;
2673 debug_atomic_inc(softirqs_on_events
);
2675 * We are going to turn softirqs on, so set the
2676 * usage bit for all held locks, if hardirqs are
2679 if (curr
->hardirqs_enabled
)
2680 mark_held_locks(curr
, SOFTIRQ
);
2681 current
->lockdep_recursion
= 0;
2685 * Softirqs were disabled:
2687 void trace_softirqs_off(unsigned long ip
)
2689 struct task_struct
*curr
= current
;
2691 if (unlikely(!debug_locks
|| current
->lockdep_recursion
))
2695 * We fancy IRQs being disabled here, see softirq.c
2697 if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
2700 if (curr
->softirqs_enabled
) {
2702 * We have done an ON -> OFF transition:
2704 curr
->softirqs_enabled
= 0;
2705 curr
->softirq_disable_ip
= ip
;
2706 curr
->softirq_disable_event
= ++curr
->irq_events
;
2707 debug_atomic_inc(softirqs_off_events
);
2709 * Whoops, we wanted softirqs off, so why aren't they?
2711 DEBUG_LOCKS_WARN_ON(!softirq_count());
2713 debug_atomic_inc(redundant_softirqs_off
);
2716 static void __lockdep_trace_alloc(gfp_t gfp_mask
, unsigned long flags
)
2718 struct task_struct
*curr
= current
;
2720 if (unlikely(!debug_locks
))
2723 /* no reclaim without waiting on it */
2724 if (!(gfp_mask
& __GFP_WAIT
))
2727 /* this guy won't enter reclaim */
2728 if ((curr
->flags
& PF_MEMALLOC
) && !(gfp_mask
& __GFP_NOMEMALLOC
))
2731 /* We're only interested __GFP_FS allocations for now */
2732 if (!(gfp_mask
& __GFP_FS
))
2736 * Oi! Can't be having __GFP_FS allocations with IRQs disabled.
2738 if (DEBUG_LOCKS_WARN_ON(irqs_disabled_flags(flags
)))
2741 mark_held_locks(curr
, RECLAIM_FS
);
2744 static void check_flags(unsigned long flags
);
2746 void lockdep_trace_alloc(gfp_t gfp_mask
)
2748 unsigned long flags
;
2750 if (unlikely(current
->lockdep_recursion
))
2753 raw_local_irq_save(flags
);
2755 current
->lockdep_recursion
= 1;
2756 __lockdep_trace_alloc(gfp_mask
, flags
);
2757 current
->lockdep_recursion
= 0;
2758 raw_local_irq_restore(flags
);
2761 static int mark_irqflags(struct task_struct
*curr
, struct held_lock
*hlock
)
2764 * If non-trylock use in a hardirq or softirq context, then
2765 * mark the lock as used in these contexts:
2767 if (!hlock
->trylock
) {
2769 if (curr
->hardirq_context
)
2770 if (!mark_lock(curr
, hlock
,
2771 LOCK_USED_IN_HARDIRQ_READ
))
2773 if (curr
->softirq_context
)
2774 if (!mark_lock(curr
, hlock
,
2775 LOCK_USED_IN_SOFTIRQ_READ
))
2778 if (curr
->hardirq_context
)
2779 if (!mark_lock(curr
, hlock
, LOCK_USED_IN_HARDIRQ
))
2781 if (curr
->softirq_context
)
2782 if (!mark_lock(curr
, hlock
, LOCK_USED_IN_SOFTIRQ
))
2786 if (!hlock
->hardirqs_off
) {
2788 if (!mark_lock(curr
, hlock
,
2789 LOCK_ENABLED_HARDIRQ_READ
))
2791 if (curr
->softirqs_enabled
)
2792 if (!mark_lock(curr
, hlock
,
2793 LOCK_ENABLED_SOFTIRQ_READ
))
2796 if (!mark_lock(curr
, hlock
,
2797 LOCK_ENABLED_HARDIRQ
))
2799 if (curr
->softirqs_enabled
)
2800 if (!mark_lock(curr
, hlock
,
2801 LOCK_ENABLED_SOFTIRQ
))
2807 * We reuse the irq context infrastructure more broadly as a general
2808 * context checking code. This tests GFP_FS recursion (a lock taken
2809 * during reclaim for a GFP_FS allocation is held over a GFP_FS
2812 if (!hlock
->trylock
&& (curr
->lockdep_reclaim_gfp
& __GFP_FS
)) {
2814 if (!mark_lock(curr
, hlock
, LOCK_USED_IN_RECLAIM_FS_READ
))
2817 if (!mark_lock(curr
, hlock
, LOCK_USED_IN_RECLAIM_FS
))
2825 static int separate_irq_context(struct task_struct
*curr
,
2826 struct held_lock
*hlock
)
2828 unsigned int depth
= curr
->lockdep_depth
;
2831 * Keep track of points where we cross into an interrupt context:
2833 hlock
->irq_context
= 2*(curr
->hardirq_context
? 1 : 0) +
2834 curr
->softirq_context
;
2836 struct held_lock
*prev_hlock
;
2838 prev_hlock
= curr
->held_locks
+ depth
-1;
2840 * If we cross into another context, reset the
2841 * hash key (this also prevents the checking and the
2842 * adding of the dependency to 'prev'):
2844 if (prev_hlock
->irq_context
!= hlock
->irq_context
)
2850 #else /* defined(CONFIG_TRACE_IRQFLAGS) && defined(CONFIG_PROVE_LOCKING) */
2853 int mark_lock_irq(struct task_struct
*curr
, struct held_lock
*this,
2854 enum lock_usage_bit new_bit
)
2856 WARN_ON(1); /* Impossible innit? when we don't have TRACE_IRQFLAG */
2860 static inline int mark_irqflags(struct task_struct
*curr
,
2861 struct held_lock
*hlock
)
2866 static inline int separate_irq_context(struct task_struct
*curr
,
2867 struct held_lock
*hlock
)
2872 void lockdep_trace_alloc(gfp_t gfp_mask
)
2876 #endif /* defined(CONFIG_TRACE_IRQFLAGS) && defined(CONFIG_PROVE_LOCKING) */
2879 * Mark a lock with a usage bit, and validate the state transition:
2881 static int mark_lock(struct task_struct
*curr
, struct held_lock
*this,
2882 enum lock_usage_bit new_bit
)
2884 unsigned int new_mask
= 1 << new_bit
, ret
= 1;
2887 * If already set then do not dirty the cacheline,
2888 * nor do any checks:
2890 if (likely(hlock_class(this)->usage_mask
& new_mask
))
2896 * Make sure we didn't race:
2898 if (unlikely(hlock_class(this)->usage_mask
& new_mask
)) {
2903 hlock_class(this)->usage_mask
|= new_mask
;
2905 if (!save_trace(hlock_class(this)->usage_traces
+ new_bit
))
2909 #define LOCKDEP_STATE(__STATE) \
2910 case LOCK_USED_IN_##__STATE: \
2911 case LOCK_USED_IN_##__STATE##_READ: \
2912 case LOCK_ENABLED_##__STATE: \
2913 case LOCK_ENABLED_##__STATE##_READ:
2914 #include "lockdep_states.h"
2915 #undef LOCKDEP_STATE
2916 ret
= mark_lock_irq(curr
, this, new_bit
);
2921 debug_atomic_dec(nr_unused_locks
);
2924 if (!debug_locks_off_graph_unlock())
2933 * We must printk outside of the graph_lock:
2936 printk("\nmarked lock as {%s}:\n", usage_str
[new_bit
]);
2938 print_irqtrace_events(curr
);
2946 * Initialize a lock instance's lock-class mapping info:
2948 void lockdep_init_map(struct lockdep_map
*lock
, const char *name
,
2949 struct lock_class_key
*key
, int subclass
)
2951 memset(lock
, 0, sizeof(*lock
));
2953 #ifdef CONFIG_LOCK_STAT
2954 lock
->cpu
= raw_smp_processor_id();
2958 * Can't be having no nameless bastards around this place!
2960 if (DEBUG_LOCKS_WARN_ON(!name
)) {
2961 lock
->name
= "NULL";
2968 * No key, no joy, we need to hash something.
2970 if (DEBUG_LOCKS_WARN_ON(!key
))
2973 * Sanity check, the lock-class key must be persistent:
2975 if (!static_obj(key
)) {
2976 printk("BUG: key %p not in .data!\n", key
);
2978 * What it says above ^^^^^, I suggest you read it.
2980 DEBUG_LOCKS_WARN_ON(1);
2985 if (unlikely(!debug_locks
))
2989 register_lock_class(lock
, subclass
, 1);
2991 EXPORT_SYMBOL_GPL(lockdep_init_map
);
2993 struct lock_class_key __lockdep_no_validate__
;
2996 * This gets called for every mutex_lock*()/spin_lock*() operation.
2997 * We maintain the dependency maps and validate the locking attempt:
2999 static int __lock_acquire(struct lockdep_map
*lock
, unsigned int subclass
,
3000 int trylock
, int read
, int check
, int hardirqs_off
,
3001 struct lockdep_map
*nest_lock
, unsigned long ip
,
3004 struct task_struct
*curr
= current
;
3005 struct lock_class
*class = NULL
;
3006 struct held_lock
*hlock
;
3007 unsigned int depth
, id
;
3015 if (unlikely(!debug_locks
))
3019 * Lockdep should run with IRQs disabled, otherwise we could
3020 * get an interrupt which would want to take locks, which would
3021 * end up in lockdep and have you got a head-ache already?
3023 if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
3026 if (lock
->key
== &__lockdep_no_validate__
)
3029 if (subclass
< NR_LOCKDEP_CACHING_CLASSES
)
3030 class = lock
->class_cache
[subclass
];
3034 if (unlikely(!class)) {
3035 class = register_lock_class(lock
, subclass
, 0);
3039 atomic_inc((atomic_t
*)&class->ops
);
3040 if (very_verbose(class)) {
3041 printk("\nacquire class [%p] %s", class->key
, class->name
);
3042 if (class->name_version
> 1)
3043 printk("#%d", class->name_version
);
3049 * Add the lock to the list of currently held locks.
3050 * (we dont increase the depth just yet, up until the
3051 * dependency checks are done)
3053 depth
= curr
->lockdep_depth
;
3055 * Ran out of static storage for our per-task lock stack again have we?
3057 if (DEBUG_LOCKS_WARN_ON(depth
>= MAX_LOCK_DEPTH
))
3060 class_idx
= class - lock_classes
+ 1;
3063 hlock
= curr
->held_locks
+ depth
- 1;
3064 if (hlock
->class_idx
== class_idx
&& nest_lock
) {
3065 if (hlock
->references
)
3066 hlock
->references
++;
3068 hlock
->references
= 2;
3074 hlock
= curr
->held_locks
+ depth
;
3076 * Plain impossible, we just registered it and checked it weren't no
3077 * NULL like.. I bet this mushroom I ate was good!
3079 if (DEBUG_LOCKS_WARN_ON(!class))
3081 hlock
->class_idx
= class_idx
;
3082 hlock
->acquire_ip
= ip
;
3083 hlock
->instance
= lock
;
3084 hlock
->nest_lock
= nest_lock
;
3085 hlock
->trylock
= trylock
;
3087 hlock
->check
= check
;
3088 hlock
->hardirqs_off
= !!hardirqs_off
;
3089 hlock
->references
= references
;
3090 #ifdef CONFIG_LOCK_STAT
3091 hlock
->waittime_stamp
= 0;
3092 hlock
->holdtime_stamp
= lockstat_clock();
3095 if (check
== 2 && !mark_irqflags(curr
, hlock
))
3098 /* mark it as used: */
3099 if (!mark_lock(curr
, hlock
, LOCK_USED
))
3103 * Calculate the chain hash: it's the combined hash of all the
3104 * lock keys along the dependency chain. We save the hash value
3105 * at every step so that we can get the current hash easily
3106 * after unlock. The chain hash is then used to cache dependency
3109 * The 'key ID' is what is the most compact key value to drive
3110 * the hash, not class->key.
3112 id
= class - lock_classes
;
3114 * Whoops, we did it again.. ran straight out of our static allocation.
3116 if (DEBUG_LOCKS_WARN_ON(id
>= MAX_LOCKDEP_KEYS
))
3119 chain_key
= curr
->curr_chain_key
;
3122 * How can we have a chain hash when we ain't got no keys?!
3124 if (DEBUG_LOCKS_WARN_ON(chain_key
!= 0))
3129 hlock
->prev_chain_key
= chain_key
;
3130 if (separate_irq_context(curr
, hlock
)) {
3134 chain_key
= iterate_chain_key(chain_key
, id
);
3136 if (!validate_chain(curr
, lock
, hlock
, chain_head
, chain_key
))
3139 curr
->curr_chain_key
= chain_key
;
3140 curr
->lockdep_depth
++;
3141 check_chain_key(curr
);
3142 #ifdef CONFIG_DEBUG_LOCKDEP
3143 if (unlikely(!debug_locks
))
3146 if (unlikely(curr
->lockdep_depth
>= MAX_LOCK_DEPTH
)) {
3148 printk("BUG: MAX_LOCK_DEPTH too low!\n");
3149 printk("turning off the locking correctness validator.\n");
3154 if (unlikely(curr
->lockdep_depth
> max_lockdep_depth
))
3155 max_lockdep_depth
= curr
->lockdep_depth
;
3161 print_unlock_inbalance_bug(struct task_struct
*curr
, struct lockdep_map
*lock
,
3164 if (!debug_locks_off())
3166 if (debug_locks_silent
)
3170 printk("=====================================\n");
3171 printk("[ BUG: bad unlock balance detected! ]\n");
3172 printk("-------------------------------------\n");
3173 printk("%s/%d is trying to release lock (",
3174 curr
->comm
, task_pid_nr(curr
));
3175 print_lockdep_cache(lock
);
3178 printk("but there are no more locks to release!\n");
3179 printk("\nother info that might help us debug this:\n");
3180 lockdep_print_held_locks(curr
);
3182 printk("\nstack backtrace:\n");
3189 * Common debugging checks for both nested and non-nested unlock:
3191 static int check_unlock(struct task_struct
*curr
, struct lockdep_map
*lock
,
3194 if (unlikely(!debug_locks
))
3197 * Lockdep should run with IRQs disabled, recursion, head-ache, etc..
3199 if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
3202 if (curr
->lockdep_depth
<= 0)
3203 return print_unlock_inbalance_bug(curr
, lock
, ip
);
3208 static int match_held_lock(struct held_lock
*hlock
, struct lockdep_map
*lock
)
3210 if (hlock
->instance
== lock
)
3213 if (hlock
->references
) {
3214 struct lock_class
*class = lock
->class_cache
[0];
3217 class = look_up_lock_class(lock
, 0);
3220 * If look_up_lock_class() failed to find a class, we're trying
3221 * to test if we hold a lock that has never yet been acquired.
3222 * Clearly if the lock hasn't been acquired _ever_, we're not
3223 * holding it either, so report failure.
3229 * References, but not a lock we're actually ref-counting?
3230 * State got messed up, follow the sites that change ->references
3231 * and try to make sense of it.
3233 if (DEBUG_LOCKS_WARN_ON(!hlock
->nest_lock
))
3236 if (hlock
->class_idx
== class - lock_classes
+ 1)
3244 __lock_set_class(struct lockdep_map
*lock
, const char *name
,
3245 struct lock_class_key
*key
, unsigned int subclass
,
3248 struct task_struct
*curr
= current
;
3249 struct held_lock
*hlock
, *prev_hlock
;
3250 struct lock_class
*class;
3254 depth
= curr
->lockdep_depth
;
3256 * This function is about (re)setting the class of a held lock,
3257 * yet we're not actually holding any locks. Naughty user!
3259 if (DEBUG_LOCKS_WARN_ON(!depth
))
3263 for (i
= depth
-1; i
>= 0; i
--) {
3264 hlock
= curr
->held_locks
+ i
;
3266 * We must not cross into another context:
3268 if (prev_hlock
&& prev_hlock
->irq_context
!= hlock
->irq_context
)
3270 if (match_held_lock(hlock
, lock
))
3274 return print_unlock_inbalance_bug(curr
, lock
, ip
);
3277 lockdep_init_map(lock
, name
, key
, 0);
3278 class = register_lock_class(lock
, subclass
, 0);
3279 hlock
->class_idx
= class - lock_classes
+ 1;
3281 curr
->lockdep_depth
= i
;
3282 curr
->curr_chain_key
= hlock
->prev_chain_key
;
3284 for (; i
< depth
; i
++) {
3285 hlock
= curr
->held_locks
+ i
;
3286 if (!__lock_acquire(hlock
->instance
,
3287 hlock_class(hlock
)->subclass
, hlock
->trylock
,
3288 hlock
->read
, hlock
->check
, hlock
->hardirqs_off
,
3289 hlock
->nest_lock
, hlock
->acquire_ip
,
3295 * I took it apart and put it back together again, except now I have
3296 * these 'spare' parts.. where shall I put them.
3298 if (DEBUG_LOCKS_WARN_ON(curr
->lockdep_depth
!= depth
))
3304 * Remove the lock to the list of currently held locks in a
3305 * potentially non-nested (out of order) manner. This is a
3306 * relatively rare operation, as all the unlock APIs default
3307 * to nested mode (which uses lock_release()):
3310 lock_release_non_nested(struct task_struct
*curr
,
3311 struct lockdep_map
*lock
, unsigned long ip
)
3313 struct held_lock
*hlock
, *prev_hlock
;
3318 * Check whether the lock exists in the current stack
3321 depth
= curr
->lockdep_depth
;
3323 * So we're all set to release this lock.. wait what lock? We don't
3324 * own any locks, you've been drinking again?
3326 if (DEBUG_LOCKS_WARN_ON(!depth
))
3330 for (i
= depth
-1; i
>= 0; i
--) {
3331 hlock
= curr
->held_locks
+ i
;
3333 * We must not cross into another context:
3335 if (prev_hlock
&& prev_hlock
->irq_context
!= hlock
->irq_context
)
3337 if (match_held_lock(hlock
, lock
))
3341 return print_unlock_inbalance_bug(curr
, lock
, ip
);
3344 if (hlock
->instance
== lock
)
3345 lock_release_holdtime(hlock
);
3347 if (hlock
->references
) {
3348 hlock
->references
--;
3349 if (hlock
->references
) {
3351 * We had, and after removing one, still have
3352 * references, the current lock stack is still
3353 * valid. We're done!
3360 * We have the right lock to unlock, 'hlock' points to it.
3361 * Now we remove it from the stack, and add back the other
3362 * entries (if any), recalculating the hash along the way:
3365 curr
->lockdep_depth
= i
;
3366 curr
->curr_chain_key
= hlock
->prev_chain_key
;
3368 for (i
++; i
< depth
; i
++) {
3369 hlock
= curr
->held_locks
+ i
;
3370 if (!__lock_acquire(hlock
->instance
,
3371 hlock_class(hlock
)->subclass
, hlock
->trylock
,
3372 hlock
->read
, hlock
->check
, hlock
->hardirqs_off
,
3373 hlock
->nest_lock
, hlock
->acquire_ip
,
3379 * We had N bottles of beer on the wall, we drank one, but now
3380 * there's not N-1 bottles of beer left on the wall...
3382 if (DEBUG_LOCKS_WARN_ON(curr
->lockdep_depth
!= depth
- 1))
3388 * Remove the lock to the list of currently held locks - this gets
3389 * called on mutex_unlock()/spin_unlock*() (or on a failed
3390 * mutex_lock_interruptible()). This is done for unlocks that nest
3391 * perfectly. (i.e. the current top of the lock-stack is unlocked)
3393 static int lock_release_nested(struct task_struct
*curr
,
3394 struct lockdep_map
*lock
, unsigned long ip
)
3396 struct held_lock
*hlock
;
3400 * Pop off the top of the lock stack:
3402 depth
= curr
->lockdep_depth
- 1;
3403 hlock
= curr
->held_locks
+ depth
;
3406 * Is the unlock non-nested:
3408 if (hlock
->instance
!= lock
|| hlock
->references
)
3409 return lock_release_non_nested(curr
, lock
, ip
);
3410 curr
->lockdep_depth
--;
3413 * No more locks, but somehow we've got hash left over, who left it?
3415 if (DEBUG_LOCKS_WARN_ON(!depth
&& (hlock
->prev_chain_key
!= 0)))
3418 curr
->curr_chain_key
= hlock
->prev_chain_key
;
3420 lock_release_holdtime(hlock
);
3422 #ifdef CONFIG_DEBUG_LOCKDEP
3423 hlock
->prev_chain_key
= 0;
3424 hlock
->class_idx
= 0;
3425 hlock
->acquire_ip
= 0;
3426 hlock
->irq_context
= 0;
3432 * Remove the lock to the list of currently held locks - this gets
3433 * called on mutex_unlock()/spin_unlock*() (or on a failed
3434 * mutex_lock_interruptible()). This is done for unlocks that nest
3435 * perfectly. (i.e. the current top of the lock-stack is unlocked)
3438 __lock_release(struct lockdep_map
*lock
, int nested
, unsigned long ip
)
3440 struct task_struct
*curr
= current
;
3442 if (!check_unlock(curr
, lock
, ip
))
3446 if (!lock_release_nested(curr
, lock
, ip
))
3449 if (!lock_release_non_nested(curr
, lock
, ip
))
3453 check_chain_key(curr
);
3456 static int __lock_is_held(struct lockdep_map
*lock
)
3458 struct task_struct
*curr
= current
;
3461 for (i
= 0; i
< curr
->lockdep_depth
; i
++) {
3462 struct held_lock
*hlock
= curr
->held_locks
+ i
;
3464 if (match_held_lock(hlock
, lock
))
3472 * Check whether we follow the irq-flags state precisely:
3474 static void check_flags(unsigned long flags
)
3476 #if defined(CONFIG_PROVE_LOCKING) && defined(CONFIG_DEBUG_LOCKDEP) && \
3477 defined(CONFIG_TRACE_IRQFLAGS)
3481 if (irqs_disabled_flags(flags
)) {
3482 if (DEBUG_LOCKS_WARN_ON(current
->hardirqs_enabled
)) {
3483 printk("possible reason: unannotated irqs-off.\n");
3486 if (DEBUG_LOCKS_WARN_ON(!current
->hardirqs_enabled
)) {
3487 printk("possible reason: unannotated irqs-on.\n");
3492 * We dont accurately track softirq state in e.g.
3493 * hardirq contexts (such as on 4KSTACKS), so only
3494 * check if not in hardirq contexts:
3496 if (!hardirq_count()) {
3497 if (softirq_count()) {
3498 /* like the above, but with softirqs */
3499 DEBUG_LOCKS_WARN_ON(current
->softirqs_enabled
);
3501 /* lick the above, does it taste good? */
3502 DEBUG_LOCKS_WARN_ON(!current
->softirqs_enabled
);
3507 print_irqtrace_events(current
);
3511 void lock_set_class(struct lockdep_map
*lock
, const char *name
,
3512 struct lock_class_key
*key
, unsigned int subclass
,
3515 unsigned long flags
;
3517 if (unlikely(current
->lockdep_recursion
))
3520 raw_local_irq_save(flags
);
3521 current
->lockdep_recursion
= 1;
3523 if (__lock_set_class(lock
, name
, key
, subclass
, ip
))
3524 check_chain_key(current
);
3525 current
->lockdep_recursion
= 0;
3526 raw_local_irq_restore(flags
);
3528 EXPORT_SYMBOL_GPL(lock_set_class
);
3531 * We are not always called with irqs disabled - do that here,
3532 * and also avoid lockdep recursion:
3534 void lock_acquire(struct lockdep_map
*lock
, unsigned int subclass
,
3535 int trylock
, int read
, int check
,
3536 struct lockdep_map
*nest_lock
, unsigned long ip
)
3538 unsigned long flags
;
3540 if (unlikely(current
->lockdep_recursion
))
3543 raw_local_irq_save(flags
);
3546 current
->lockdep_recursion
= 1;
3547 trace_lock_acquire(lock
, subclass
, trylock
, read
, check
, nest_lock
, ip
);
3548 __lock_acquire(lock
, subclass
, trylock
, read
, check
,
3549 irqs_disabled_flags(flags
), nest_lock
, ip
, 0);
3550 current
->lockdep_recursion
= 0;
3551 raw_local_irq_restore(flags
);
3553 EXPORT_SYMBOL_GPL(lock_acquire
);
3555 void lock_release(struct lockdep_map
*lock
, int nested
,
3558 unsigned long flags
;
3560 if (unlikely(current
->lockdep_recursion
))
3563 raw_local_irq_save(flags
);
3565 current
->lockdep_recursion
= 1;
3566 trace_lock_release(lock
, ip
);
3567 __lock_release(lock
, nested
, ip
);
3568 current
->lockdep_recursion
= 0;
3569 raw_local_irq_restore(flags
);
3571 EXPORT_SYMBOL_GPL(lock_release
);
3573 int lock_is_held(struct lockdep_map
*lock
)
3575 unsigned long flags
;
3578 if (unlikely(current
->lockdep_recursion
))
3579 return 1; /* avoid false negative lockdep_assert_held() */
3581 raw_local_irq_save(flags
);
3584 current
->lockdep_recursion
= 1;
3585 ret
= __lock_is_held(lock
);
3586 current
->lockdep_recursion
= 0;
3587 raw_local_irq_restore(flags
);
3591 EXPORT_SYMBOL_GPL(lock_is_held
);
3593 void lockdep_set_current_reclaim_state(gfp_t gfp_mask
)
3595 current
->lockdep_reclaim_gfp
= gfp_mask
;
3598 void lockdep_clear_current_reclaim_state(void)
3600 current
->lockdep_reclaim_gfp
= 0;
3603 #ifdef CONFIG_LOCK_STAT
3605 print_lock_contention_bug(struct task_struct
*curr
, struct lockdep_map
*lock
,
3608 if (!debug_locks_off())
3610 if (debug_locks_silent
)
3614 printk("=================================\n");
3615 printk("[ BUG: bad contention detected! ]\n");
3616 printk("---------------------------------\n");
3617 printk("%s/%d is trying to contend lock (",
3618 curr
->comm
, task_pid_nr(curr
));
3619 print_lockdep_cache(lock
);
3622 printk("but there are no locks held!\n");
3623 printk("\nother info that might help us debug this:\n");
3624 lockdep_print_held_locks(curr
);
3626 printk("\nstack backtrace:\n");
3633 __lock_contended(struct lockdep_map
*lock
, unsigned long ip
)
3635 struct task_struct
*curr
= current
;
3636 struct held_lock
*hlock
, *prev_hlock
;
3637 struct lock_class_stats
*stats
;
3639 int i
, contention_point
, contending_point
;
3641 depth
= curr
->lockdep_depth
;
3643 * Whee, we contended on this lock, except it seems we're not
3644 * actually trying to acquire anything much at all..
3646 if (DEBUG_LOCKS_WARN_ON(!depth
))
3650 for (i
= depth
-1; i
>= 0; i
--) {
3651 hlock
= curr
->held_locks
+ i
;
3653 * We must not cross into another context:
3655 if (prev_hlock
&& prev_hlock
->irq_context
!= hlock
->irq_context
)
3657 if (match_held_lock(hlock
, lock
))
3661 print_lock_contention_bug(curr
, lock
, ip
);
3665 if (hlock
->instance
!= lock
)
3668 hlock
->waittime_stamp
= lockstat_clock();
3670 contention_point
= lock_point(hlock_class(hlock
)->contention_point
, ip
);
3671 contending_point
= lock_point(hlock_class(hlock
)->contending_point
,
3674 stats
= get_lock_stats(hlock_class(hlock
));
3675 if (contention_point
< LOCKSTAT_POINTS
)
3676 stats
->contention_point
[contention_point
]++;
3677 if (contending_point
< LOCKSTAT_POINTS
)
3678 stats
->contending_point
[contending_point
]++;
3679 if (lock
->cpu
!= smp_processor_id())
3680 stats
->bounces
[bounce_contended
+ !!hlock
->read
]++;
3681 put_lock_stats(stats
);
3685 __lock_acquired(struct lockdep_map
*lock
, unsigned long ip
)
3687 struct task_struct
*curr
= current
;
3688 struct held_lock
*hlock
, *prev_hlock
;
3689 struct lock_class_stats
*stats
;
3691 u64 now
, waittime
= 0;
3694 depth
= curr
->lockdep_depth
;
3696 * Yay, we acquired ownership of this lock we didn't try to
3697 * acquire, how the heck did that happen?
3699 if (DEBUG_LOCKS_WARN_ON(!depth
))
3703 for (i
= depth
-1; i
>= 0; i
--) {
3704 hlock
= curr
->held_locks
+ i
;
3706 * We must not cross into another context:
3708 if (prev_hlock
&& prev_hlock
->irq_context
!= hlock
->irq_context
)
3710 if (match_held_lock(hlock
, lock
))
3714 print_lock_contention_bug(curr
, lock
, _RET_IP_
);
3718 if (hlock
->instance
!= lock
)
3721 cpu
= smp_processor_id();
3722 if (hlock
->waittime_stamp
) {
3723 now
= lockstat_clock();
3724 waittime
= now
- hlock
->waittime_stamp
;
3725 hlock
->holdtime_stamp
= now
;
3728 trace_lock_acquired(lock
, ip
);
3730 stats
= get_lock_stats(hlock_class(hlock
));
3733 lock_time_inc(&stats
->read_waittime
, waittime
);
3735 lock_time_inc(&stats
->write_waittime
, waittime
);
3737 if (lock
->cpu
!= cpu
)
3738 stats
->bounces
[bounce_acquired
+ !!hlock
->read
]++;
3739 put_lock_stats(stats
);
3745 void lock_contended(struct lockdep_map
*lock
, unsigned long ip
)
3747 unsigned long flags
;
3749 if (unlikely(!lock_stat
))
3752 if (unlikely(current
->lockdep_recursion
))
3755 raw_local_irq_save(flags
);
3757 current
->lockdep_recursion
= 1;
3758 trace_lock_contended(lock
, ip
);
3759 __lock_contended(lock
, ip
);
3760 current
->lockdep_recursion
= 0;
3761 raw_local_irq_restore(flags
);
3763 EXPORT_SYMBOL_GPL(lock_contended
);
3765 void lock_acquired(struct lockdep_map
*lock
, unsigned long ip
)
3767 unsigned long flags
;
3769 if (unlikely(!lock_stat
))
3772 if (unlikely(current
->lockdep_recursion
))
3775 raw_local_irq_save(flags
);
3777 current
->lockdep_recursion
= 1;
3778 __lock_acquired(lock
, ip
);
3779 current
->lockdep_recursion
= 0;
3780 raw_local_irq_restore(flags
);
3782 EXPORT_SYMBOL_GPL(lock_acquired
);
3786 * Used by the testsuite, sanitize the validator state
3787 * after a simulated failure:
3790 void lockdep_reset(void)
3792 unsigned long flags
;
3795 raw_local_irq_save(flags
);
3796 current
->curr_chain_key
= 0;
3797 current
->lockdep_depth
= 0;
3798 current
->lockdep_recursion
= 0;
3799 memset(current
->held_locks
, 0, MAX_LOCK_DEPTH
*sizeof(struct held_lock
));
3800 nr_hardirq_chains
= 0;
3801 nr_softirq_chains
= 0;
3802 nr_process_chains
= 0;
3804 for (i
= 0; i
< CHAINHASH_SIZE
; i
++)
3805 INIT_LIST_HEAD(chainhash_table
+ i
);
3806 raw_local_irq_restore(flags
);
3809 static void zap_class(struct lock_class
*class)
3814 * Remove all dependencies this lock is
3817 for (i
= 0; i
< nr_list_entries
; i
++) {
3818 if (list_entries
[i
].class == class)
3819 list_del_rcu(&list_entries
[i
].entry
);
3822 * Unhash the class and remove it from the all_lock_classes list:
3824 list_del_rcu(&class->hash_entry
);
3825 list_del_rcu(&class->lock_entry
);
3830 static inline int within(const void *addr
, void *start
, unsigned long size
)
3832 return addr
>= start
&& addr
< start
+ size
;
3835 void lockdep_free_key_range(void *start
, unsigned long size
)
3837 struct lock_class
*class, *next
;
3838 struct list_head
*head
;
3839 unsigned long flags
;
3843 raw_local_irq_save(flags
);
3844 locked
= graph_lock();
3847 * Unhash all classes that were created by this module:
3849 for (i
= 0; i
< CLASSHASH_SIZE
; i
++) {
3850 head
= classhash_table
+ i
;
3851 if (list_empty(head
))
3853 list_for_each_entry_safe(class, next
, head
, hash_entry
) {
3854 if (within(class->key
, start
, size
))
3856 else if (within(class->name
, start
, size
))
3863 raw_local_irq_restore(flags
);
3866 void lockdep_reset_lock(struct lockdep_map
*lock
)
3868 struct lock_class
*class, *next
;
3869 struct list_head
*head
;
3870 unsigned long flags
;
3874 raw_local_irq_save(flags
);
3877 * Remove all classes this lock might have:
3879 for (j
= 0; j
< MAX_LOCKDEP_SUBCLASSES
; j
++) {
3881 * If the class exists we look it up and zap it:
3883 class = look_up_lock_class(lock
, j
);
3888 * Debug check: in the end all mapped classes should
3891 locked
= graph_lock();
3892 for (i
= 0; i
< CLASSHASH_SIZE
; i
++) {
3893 head
= classhash_table
+ i
;
3894 if (list_empty(head
))
3896 list_for_each_entry_safe(class, next
, head
, hash_entry
) {
3899 for (j
= 0; j
< NR_LOCKDEP_CACHING_CLASSES
; j
++)
3900 match
|= class == lock
->class_cache
[j
];
3902 if (unlikely(match
)) {
3903 if (debug_locks_off_graph_unlock()) {
3905 * We all just reset everything, how did it match?
3917 raw_local_irq_restore(flags
);
3920 void lockdep_init(void)
3925 * Some architectures have their own start_kernel()
3926 * code which calls lockdep_init(), while we also
3927 * call lockdep_init() from the start_kernel() itself,
3928 * and we want to initialize the hashes only once:
3930 if (lockdep_initialized
)
3933 for (i
= 0; i
< CLASSHASH_SIZE
; i
++)
3934 INIT_LIST_HEAD(classhash_table
+ i
);
3936 for (i
= 0; i
< CHAINHASH_SIZE
; i
++)
3937 INIT_LIST_HEAD(chainhash_table
+ i
);
3939 lockdep_initialized
= 1;
3942 void __init
lockdep_info(void)
3944 printk("Lock dependency validator: Copyright (c) 2006 Red Hat, Inc., Ingo Molnar\n");
3946 printk("... MAX_LOCKDEP_SUBCLASSES: %lu\n", MAX_LOCKDEP_SUBCLASSES
);
3947 printk("... MAX_LOCK_DEPTH: %lu\n", MAX_LOCK_DEPTH
);
3948 printk("... MAX_LOCKDEP_KEYS: %lu\n", MAX_LOCKDEP_KEYS
);
3949 printk("... CLASSHASH_SIZE: %lu\n", CLASSHASH_SIZE
);
3950 printk("... MAX_LOCKDEP_ENTRIES: %lu\n", MAX_LOCKDEP_ENTRIES
);
3951 printk("... MAX_LOCKDEP_CHAINS: %lu\n", MAX_LOCKDEP_CHAINS
);
3952 printk("... CHAINHASH_SIZE: %lu\n", CHAINHASH_SIZE
);
3954 printk(" memory used by lock dependency info: %lu kB\n",
3955 (sizeof(struct lock_class
) * MAX_LOCKDEP_KEYS
+
3956 sizeof(struct list_head
) * CLASSHASH_SIZE
+
3957 sizeof(struct lock_list
) * MAX_LOCKDEP_ENTRIES
+
3958 sizeof(struct lock_chain
) * MAX_LOCKDEP_CHAINS
+
3959 sizeof(struct list_head
) * CHAINHASH_SIZE
3960 #ifdef CONFIG_PROVE_LOCKING
3961 + sizeof(struct circular_queue
)
3966 printk(" per task-struct memory footprint: %lu bytes\n",
3967 sizeof(struct held_lock
) * MAX_LOCK_DEPTH
);
3969 #ifdef CONFIG_DEBUG_LOCKDEP
3970 if (lockdep_init_error
) {
3971 printk("WARNING: lockdep init error! Arch code didn't call lockdep_init() early enough?\n");
3972 printk("Call stack leading to lockdep invocation was:\n");
3973 print_stack_trace(&lockdep_init_trace
, 0);
3979 print_freed_lock_bug(struct task_struct
*curr
, const void *mem_from
,
3980 const void *mem_to
, struct held_lock
*hlock
)
3982 if (!debug_locks_off())
3984 if (debug_locks_silent
)
3988 printk("=========================\n");
3989 printk("[ BUG: held lock freed! ]\n");
3990 printk("-------------------------\n");
3991 printk("%s/%d is freeing memory %p-%p, with a lock still held there!\n",
3992 curr
->comm
, task_pid_nr(curr
), mem_from
, mem_to
-1);
3994 lockdep_print_held_locks(curr
);
3996 printk("\nstack backtrace:\n");
4000 static inline int not_in_range(const void* mem_from
, unsigned long mem_len
,
4001 const void* lock_from
, unsigned long lock_len
)
4003 return lock_from
+ lock_len
<= mem_from
||
4004 mem_from
+ mem_len
<= lock_from
;
4008 * Called when kernel memory is freed (or unmapped), or if a lock
4009 * is destroyed or reinitialized - this code checks whether there is
4010 * any held lock in the memory range of <from> to <to>:
4012 void debug_check_no_locks_freed(const void *mem_from
, unsigned long mem_len
)
4014 struct task_struct
*curr
= current
;
4015 struct held_lock
*hlock
;
4016 unsigned long flags
;
4019 if (unlikely(!debug_locks
))
4022 local_irq_save(flags
);
4023 for (i
= 0; i
< curr
->lockdep_depth
; i
++) {
4024 hlock
= curr
->held_locks
+ i
;
4026 if (not_in_range(mem_from
, mem_len
, hlock
->instance
,
4027 sizeof(*hlock
->instance
)))
4030 print_freed_lock_bug(curr
, mem_from
, mem_from
+ mem_len
, hlock
);
4033 local_irq_restore(flags
);
4035 EXPORT_SYMBOL_GPL(debug_check_no_locks_freed
);
4037 static void print_held_locks_bug(struct task_struct
*curr
)
4039 if (!debug_locks_off())
4041 if (debug_locks_silent
)
4045 printk("=====================================\n");
4046 printk("[ BUG: lock held at task exit time! ]\n");
4047 printk("-------------------------------------\n");
4048 printk("%s/%d is exiting with locks still held!\n",
4049 curr
->comm
, task_pid_nr(curr
));
4050 lockdep_print_held_locks(curr
);
4052 printk("\nstack backtrace:\n");
4056 void debug_check_no_locks_held(struct task_struct
*task
)
4058 if (unlikely(task
->lockdep_depth
> 0))
4059 print_held_locks_bug(task
);
4062 void debug_show_all_locks(void)
4064 struct task_struct
*g
, *p
;
4068 if (unlikely(!debug_locks
)) {
4069 printk("INFO: lockdep is turned off.\n");
4072 printk("\nShowing all locks held in the system:\n");
4075 * Here we try to get the tasklist_lock as hard as possible,
4076 * if not successful after 2 seconds we ignore it (but keep
4077 * trying). This is to enable a debug printout even if a
4078 * tasklist_lock-holding task deadlocks or crashes.
4081 if (!read_trylock(&tasklist_lock
)) {
4083 printk("hm, tasklist_lock locked, retrying... ");
4086 printk(" #%d", 10-count
);
4090 printk(" ignoring it.\n");
4094 printk(KERN_CONT
" locked it.\n");
4097 do_each_thread(g
, p
) {
4099 * It's not reliable to print a task's held locks
4100 * if it's not sleeping (or if it's not the current
4103 if (p
->state
== TASK_RUNNING
&& p
!= current
)
4105 if (p
->lockdep_depth
)
4106 lockdep_print_held_locks(p
);
4108 if (read_trylock(&tasklist_lock
))
4110 } while_each_thread(g
, p
);
4113 printk("=============================================\n\n");
4116 read_unlock(&tasklist_lock
);
4118 EXPORT_SYMBOL_GPL(debug_show_all_locks
);
4121 * Careful: only use this function if you are sure that
4122 * the task cannot run in parallel!
4124 void debug_show_held_locks(struct task_struct
*task
)
4126 if (unlikely(!debug_locks
)) {
4127 printk("INFO: lockdep is turned off.\n");
4130 lockdep_print_held_locks(task
);
4132 EXPORT_SYMBOL_GPL(debug_show_held_locks
);
4134 void lockdep_sys_exit(void)
4136 struct task_struct
*curr
= current
;
4138 if (unlikely(curr
->lockdep_depth
)) {
4139 if (!debug_locks_off())
4142 printk("================================================\n");
4143 printk("[ BUG: lock held when returning to user space! ]\n");
4144 printk("------------------------------------------------\n");
4145 printk("%s/%d is leaving the kernel with locks still held!\n",
4146 curr
->comm
, curr
->pid
);
4147 lockdep_print_held_locks(curr
);
4151 void lockdep_rcu_suspicious(const char *file
, const int line
, const char *s
)
4153 struct task_struct
*curr
= current
;
4155 #ifndef CONFIG_PROVE_RCU_REPEATEDLY
4156 if (!debug_locks_off())
4158 #endif /* #ifdef CONFIG_PROVE_RCU_REPEATEDLY */
4159 /* Note: the following can be executed concurrently, so be careful. */
4161 printk("===============================\n");
4162 printk("[ INFO: suspicious RCU usage. ]\n");
4163 printk("-------------------------------\n");
4164 printk("%s:%d %s!\n", file
, line
, s
);
4165 printk("\nother info that might help us debug this:\n\n");
4166 printk("\nrcu_scheduler_active = %d, debug_locks = %d\n", rcu_scheduler_active
, debug_locks
);
4167 lockdep_print_held_locks(curr
);
4168 printk("\nstack backtrace:\n");
4171 EXPORT_SYMBOL_GPL(lockdep_rcu_suspicious
);