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>
47 #include <linux/kmemcheck.h>
49 #include <asm/sections.h>
51 #include "lockdep_internals.h"
53 #define CREATE_TRACE_POINTS
54 #include <trace/events/lock.h>
56 #ifdef CONFIG_PROVE_LOCKING
57 int prove_locking
= 1;
58 module_param(prove_locking
, int, 0644);
60 #define prove_locking 0
63 #ifdef CONFIG_LOCK_STAT
65 module_param(lock_stat
, int, 0644);
71 * lockdep_lock: protects the lockdep graph, the hashes and the
72 * class/list/hash allocators.
74 * This is one of the rare exceptions where it's justified
75 * to use a raw spinlock - we really dont want the spinlock
76 * code to recurse back into the lockdep code...
78 static arch_spinlock_t lockdep_lock
= (arch_spinlock_t
)__ARCH_SPIN_LOCK_UNLOCKED
;
80 static int graph_lock(void)
82 arch_spin_lock(&lockdep_lock
);
84 * Make sure that if another CPU detected a bug while
85 * walking the graph we dont change it (while the other
86 * CPU is busy printing out stuff with the graph lock
90 arch_spin_unlock(&lockdep_lock
);
93 /* prevent any recursions within lockdep from causing deadlocks */
94 current
->lockdep_recursion
++;
98 static inline int graph_unlock(void)
100 if (debug_locks
&& !arch_spin_is_locked(&lockdep_lock
)) {
102 * The lockdep graph lock isn't locked while we expect it to
103 * be, we're confused now, bye!
105 return DEBUG_LOCKS_WARN_ON(1);
108 current
->lockdep_recursion
--;
109 arch_spin_unlock(&lockdep_lock
);
114 * Turn lock debugging off and return with 0 if it was off already,
115 * and also release the graph lock:
117 static inline int debug_locks_off_graph_unlock(void)
119 int ret
= debug_locks_off();
121 arch_spin_unlock(&lockdep_lock
);
126 static int lockdep_initialized
;
128 unsigned long nr_list_entries
;
129 static struct lock_list list_entries
[MAX_LOCKDEP_ENTRIES
];
132 * All data structures here are protected by the global debug_lock.
134 * Mutex key structs only get allocated, once during bootup, and never
135 * get freed - this significantly simplifies the debugging code.
137 unsigned long nr_lock_classes
;
138 static struct lock_class lock_classes
[MAX_LOCKDEP_KEYS
];
140 static inline struct lock_class
*hlock_class(struct held_lock
*hlock
)
142 if (!hlock
->class_idx
) {
144 * Someone passed in garbage, we give up.
146 DEBUG_LOCKS_WARN_ON(1);
149 return lock_classes
+ hlock
->class_idx
- 1;
152 #ifdef CONFIG_LOCK_STAT
153 static DEFINE_PER_CPU(struct lock_class_stats
[MAX_LOCKDEP_KEYS
],
156 static inline u64
lockstat_clock(void)
158 return local_clock();
161 static int lock_point(unsigned long points
[], unsigned long ip
)
165 for (i
= 0; i
< LOCKSTAT_POINTS
; i
++) {
166 if (points
[i
] == 0) {
177 static void lock_time_inc(struct lock_time
*lt
, u64 time
)
182 if (time
< lt
->min
|| !lt
->nr
)
189 static inline void lock_time_add(struct lock_time
*src
, struct lock_time
*dst
)
194 if (src
->max
> dst
->max
)
197 if (src
->min
< dst
->min
|| !dst
->nr
)
200 dst
->total
+= src
->total
;
204 struct lock_class_stats
lock_stats(struct lock_class
*class)
206 struct lock_class_stats stats
;
209 memset(&stats
, 0, sizeof(struct lock_class_stats
));
210 for_each_possible_cpu(cpu
) {
211 struct lock_class_stats
*pcs
=
212 &per_cpu(cpu_lock_stats
, cpu
)[class - lock_classes
];
214 for (i
= 0; i
< ARRAY_SIZE(stats
.contention_point
); i
++)
215 stats
.contention_point
[i
] += pcs
->contention_point
[i
];
217 for (i
= 0; i
< ARRAY_SIZE(stats
.contending_point
); i
++)
218 stats
.contending_point
[i
] += pcs
->contending_point
[i
];
220 lock_time_add(&pcs
->read_waittime
, &stats
.read_waittime
);
221 lock_time_add(&pcs
->write_waittime
, &stats
.write_waittime
);
223 lock_time_add(&pcs
->read_holdtime
, &stats
.read_holdtime
);
224 lock_time_add(&pcs
->write_holdtime
, &stats
.write_holdtime
);
226 for (i
= 0; i
< ARRAY_SIZE(stats
.bounces
); i
++)
227 stats
.bounces
[i
] += pcs
->bounces
[i
];
233 void clear_lock_stats(struct lock_class
*class)
237 for_each_possible_cpu(cpu
) {
238 struct lock_class_stats
*cpu_stats
=
239 &per_cpu(cpu_lock_stats
, cpu
)[class - lock_classes
];
241 memset(cpu_stats
, 0, sizeof(struct lock_class_stats
));
243 memset(class->contention_point
, 0, sizeof(class->contention_point
));
244 memset(class->contending_point
, 0, sizeof(class->contending_point
));
247 static struct lock_class_stats
*get_lock_stats(struct lock_class
*class)
249 return &get_cpu_var(cpu_lock_stats
)[class - lock_classes
];
252 static void put_lock_stats(struct lock_class_stats
*stats
)
254 put_cpu_var(cpu_lock_stats
);
257 static void lock_release_holdtime(struct held_lock
*hlock
)
259 struct lock_class_stats
*stats
;
265 holdtime
= lockstat_clock() - hlock
->holdtime_stamp
;
267 stats
= get_lock_stats(hlock_class(hlock
));
269 lock_time_inc(&stats
->read_holdtime
, holdtime
);
271 lock_time_inc(&stats
->write_holdtime
, holdtime
);
272 put_lock_stats(stats
);
275 static inline void lock_release_holdtime(struct held_lock
*hlock
)
281 * We keep a global list of all lock classes. The list only grows,
282 * never shrinks. The list is only accessed with the lockdep
283 * spinlock lock held.
285 LIST_HEAD(all_lock_classes
);
288 * The lockdep classes are in a hash-table as well, for fast lookup:
290 #define CLASSHASH_BITS (MAX_LOCKDEP_KEYS_BITS - 1)
291 #define CLASSHASH_SIZE (1UL << CLASSHASH_BITS)
292 #define __classhashfn(key) hash_long((unsigned long)key, CLASSHASH_BITS)
293 #define classhashentry(key) (classhash_table + __classhashfn((key)))
295 static struct list_head classhash_table
[CLASSHASH_SIZE
];
298 * We put the lock dependency chains into a hash-table as well, to cache
301 #define CHAINHASH_BITS (MAX_LOCKDEP_CHAINS_BITS-1)
302 #define CHAINHASH_SIZE (1UL << CHAINHASH_BITS)
303 #define __chainhashfn(chain) hash_long(chain, CHAINHASH_BITS)
304 #define chainhashentry(chain) (chainhash_table + __chainhashfn((chain)))
306 static struct list_head chainhash_table
[CHAINHASH_SIZE
];
309 * The hash key of the lock dependency chains is a hash itself too:
310 * it's a hash of all locks taken up to that lock, including that lock.
311 * It's a 64-bit hash, because it's important for the keys to be
314 #define iterate_chain_key(key1, key2) \
315 (((key1) << MAX_LOCKDEP_KEYS_BITS) ^ \
316 ((key1) >> (64-MAX_LOCKDEP_KEYS_BITS)) ^ \
319 void lockdep_off(void)
321 current
->lockdep_recursion
++;
323 EXPORT_SYMBOL(lockdep_off
);
325 void lockdep_on(void)
327 current
->lockdep_recursion
--;
329 EXPORT_SYMBOL(lockdep_on
);
332 * Debugging switches:
336 #define VERY_VERBOSE 0
339 # define HARDIRQ_VERBOSE 1
340 # define SOFTIRQ_VERBOSE 1
341 # define RECLAIM_VERBOSE 1
343 # define HARDIRQ_VERBOSE 0
344 # define SOFTIRQ_VERBOSE 0
345 # define RECLAIM_VERBOSE 0
348 #if VERBOSE || HARDIRQ_VERBOSE || SOFTIRQ_VERBOSE || RECLAIM_VERBOSE
350 * Quick filtering for interesting events:
352 static int class_filter(struct lock_class
*class)
356 if (class->name_version
== 1 &&
357 !strcmp(class->name
, "lockname"))
359 if (class->name_version
== 1 &&
360 !strcmp(class->name
, "&struct->lockfield"))
363 /* Filter everything else. 1 would be to allow everything else */
368 static int verbose(struct lock_class
*class)
371 return class_filter(class);
377 * Stack-trace: tightly packed array of stack backtrace
378 * addresses. Protected by the graph_lock.
380 unsigned long nr_stack_trace_entries
;
381 static unsigned long stack_trace
[MAX_STACK_TRACE_ENTRIES
];
383 static int save_trace(struct stack_trace
*trace
)
385 trace
->nr_entries
= 0;
386 trace
->max_entries
= MAX_STACK_TRACE_ENTRIES
- nr_stack_trace_entries
;
387 trace
->entries
= stack_trace
+ nr_stack_trace_entries
;
391 save_stack_trace(trace
);
394 * Some daft arches put -1 at the end to indicate its a full trace.
396 * <rant> this is buggy anyway, since it takes a whole extra entry so a
397 * complete trace that maxes out the entries provided will be reported
398 * as incomplete, friggin useless </rant>
400 if (trace
->nr_entries
!= 0 &&
401 trace
->entries
[trace
->nr_entries
-1] == ULONG_MAX
)
404 trace
->max_entries
= trace
->nr_entries
;
406 nr_stack_trace_entries
+= trace
->nr_entries
;
408 if (nr_stack_trace_entries
>= MAX_STACK_TRACE_ENTRIES
-1) {
409 if (!debug_locks_off_graph_unlock())
412 printk("BUG: MAX_STACK_TRACE_ENTRIES too low!\n");
413 printk("turning off the locking correctness validator.\n");
422 unsigned int nr_hardirq_chains
;
423 unsigned int nr_softirq_chains
;
424 unsigned int nr_process_chains
;
425 unsigned int max_lockdep_depth
;
427 #ifdef CONFIG_DEBUG_LOCKDEP
429 * We cannot printk in early bootup code. Not even early_printk()
430 * might work. So we mark any initialization errors and printk
431 * about it later on, in lockdep_info().
433 static int lockdep_init_error
;
434 static const char *lock_init_error
;
435 static unsigned long lockdep_init_trace_data
[20];
436 static struct stack_trace lockdep_init_trace
= {
437 .max_entries
= ARRAY_SIZE(lockdep_init_trace_data
),
438 .entries
= lockdep_init_trace_data
,
442 * Various lockdep statistics:
444 DEFINE_PER_CPU(struct lockdep_stats
, lockdep_stats
);
451 #define __USAGE(__STATE) \
452 [LOCK_USED_IN_##__STATE] = "IN-"__stringify(__STATE)"-W", \
453 [LOCK_ENABLED_##__STATE] = __stringify(__STATE)"-ON-W", \
454 [LOCK_USED_IN_##__STATE##_READ] = "IN-"__stringify(__STATE)"-R",\
455 [LOCK_ENABLED_##__STATE##_READ] = __stringify(__STATE)"-ON-R",
457 static const char *usage_str
[] =
459 #define LOCKDEP_STATE(__STATE) __USAGE(__STATE)
460 #include "lockdep_states.h"
462 [LOCK_USED
] = "INITIAL USE",
465 const char * __get_key_name(struct lockdep_subclass_key
*key
, char *str
)
467 return kallsyms_lookup((unsigned long)key
, NULL
, NULL
, NULL
, str
);
470 static inline unsigned long lock_flag(enum lock_usage_bit bit
)
475 static char get_usage_char(struct lock_class
*class, enum lock_usage_bit bit
)
479 if (class->usage_mask
& lock_flag(bit
+ 2))
481 if (class->usage_mask
& lock_flag(bit
)) {
483 if (class->usage_mask
& lock_flag(bit
+ 2))
490 void get_usage_chars(struct lock_class
*class, char usage
[LOCK_USAGE_CHARS
])
494 #define LOCKDEP_STATE(__STATE) \
495 usage[i++] = get_usage_char(class, LOCK_USED_IN_##__STATE); \
496 usage[i++] = get_usage_char(class, LOCK_USED_IN_##__STATE##_READ);
497 #include "lockdep_states.h"
503 static void __print_lock_name(struct lock_class
*class)
505 char str
[KSYM_NAME_LEN
];
510 name
= __get_key_name(class->key
, str
);
514 if (class->name_version
> 1)
515 printk("#%d", class->name_version
);
517 printk("/%d", class->subclass
);
521 static void print_lock_name(struct lock_class
*class)
523 char usage
[LOCK_USAGE_CHARS
];
525 get_usage_chars(class, usage
);
528 __print_lock_name(class);
529 printk("){%s}", usage
);
532 static void print_lockdep_cache(struct lockdep_map
*lock
)
535 char str
[KSYM_NAME_LEN
];
539 name
= __get_key_name(lock
->key
->subkeys
, str
);
544 static void print_lock(struct held_lock
*hlock
)
546 print_lock_name(hlock_class(hlock
));
548 print_ip_sym(hlock
->acquire_ip
);
551 static void lockdep_print_held_locks(struct task_struct
*curr
)
553 int i
, depth
= curr
->lockdep_depth
;
556 printk("no locks held by %s/%d.\n", curr
->comm
, task_pid_nr(curr
));
559 printk("%d lock%s held by %s/%d:\n",
560 depth
, depth
> 1 ? "s" : "", curr
->comm
, task_pid_nr(curr
));
562 for (i
= 0; i
< depth
; i
++) {
564 print_lock(curr
->held_locks
+ i
);
568 static void print_kernel_ident(void)
570 printk("%s %.*s %s\n", init_utsname()->release
,
571 (int)strcspn(init_utsname()->version
, " "),
572 init_utsname()->version
,
576 static int very_verbose(struct lock_class
*class)
579 return class_filter(class);
585 * Is this the address of a static object:
587 static int static_obj(void *obj
)
589 unsigned long start
= (unsigned long) &_stext
,
590 end
= (unsigned long) &_end
,
591 addr
= (unsigned long) obj
;
596 if ((addr
>= start
) && (addr
< end
))
599 if (arch_is_kernel_data(addr
))
603 * in-kernel percpu var?
605 if (is_kernel_percpu_address(addr
))
609 * module static or percpu var?
611 return is_module_address(addr
) || is_module_percpu_address(addr
);
615 * To make lock name printouts unique, we calculate a unique
616 * class->name_version generation counter:
618 static int count_matching_names(struct lock_class
*new_class
)
620 struct lock_class
*class;
623 if (!new_class
->name
)
626 list_for_each_entry(class, &all_lock_classes
, lock_entry
) {
627 if (new_class
->key
- new_class
->subclass
== class->key
)
628 return class->name_version
;
629 if (class->name
&& !strcmp(class->name
, new_class
->name
))
630 count
= max(count
, class->name_version
);
637 * Register a lock's class in the hash-table, if the class is not present
638 * yet. Otherwise we look it up. We cache the result in the lock object
639 * itself, so actual lookup of the hash should be once per lock object.
641 static inline struct lock_class
*
642 look_up_lock_class(struct lockdep_map
*lock
, unsigned int subclass
)
644 struct lockdep_subclass_key
*key
;
645 struct list_head
*hash_head
;
646 struct lock_class
*class;
648 #ifdef CONFIG_DEBUG_LOCKDEP
650 * If the architecture calls into lockdep before initializing
651 * the hashes then we'll warn about it later. (we cannot printk
654 if (unlikely(!lockdep_initialized
)) {
656 lockdep_init_error
= 1;
657 lock_init_error
= lock
->name
;
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
);
725 goto out_set_class_cache
;
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
);
811 if (!subclass
|| force
)
812 lock
->class_cache
[0] = class;
813 else if (subclass
< NR_LOCKDEP_CACHING_CLASSES
)
814 lock
->class_cache
[subclass
] = class;
817 * Hash collision, did we smoke some? We found a class with a matching
818 * hash but the subclass -- which is hashed in -- didn't match.
820 if (DEBUG_LOCKS_WARN_ON(class->subclass
!= subclass
))
826 #ifdef CONFIG_PROVE_LOCKING
828 * Allocate a lockdep entry. (assumes the graph_lock held, returns
829 * with NULL on failure)
831 static struct lock_list
*alloc_list_entry(void)
833 if (nr_list_entries
>= MAX_LOCKDEP_ENTRIES
) {
834 if (!debug_locks_off_graph_unlock())
837 printk("BUG: MAX_LOCKDEP_ENTRIES too low!\n");
838 printk("turning off the locking correctness validator.\n");
842 return list_entries
+ nr_list_entries
++;
846 * Add a new dependency to the head of the list:
848 static int add_lock_to_list(struct lock_class
*class, struct lock_class
*this,
849 struct list_head
*head
, unsigned long ip
,
850 int distance
, struct stack_trace
*trace
)
852 struct lock_list
*entry
;
854 * Lock not present yet - get a new dependency struct and
855 * add it to the list:
857 entry
= alloc_list_entry();
862 entry
->distance
= distance
;
863 entry
->trace
= *trace
;
865 * Since we never remove from the dependency list, the list can
866 * be walked lockless by other CPUs, it's only allocation
867 * that must be protected by the spinlock. But this also means
868 * we must make new entries visible only once writes to the
869 * entry become visible - hence the RCU op:
871 list_add_tail_rcu(&entry
->entry
, head
);
877 * For good efficiency of modular, we use power of 2
879 #define MAX_CIRCULAR_QUEUE_SIZE 4096UL
880 #define CQ_MASK (MAX_CIRCULAR_QUEUE_SIZE-1)
883 * The circular_queue and helpers is used to implement the
884 * breadth-first search(BFS)algorithem, by which we can build
885 * the shortest path from the next lock to be acquired to the
886 * previous held lock if there is a circular between them.
888 struct circular_queue
{
889 unsigned long element
[MAX_CIRCULAR_QUEUE_SIZE
];
890 unsigned int front
, rear
;
893 static struct circular_queue lock_cq
;
895 unsigned int max_bfs_queue_depth
;
897 static unsigned int lockdep_dependency_gen_id
;
899 static inline void __cq_init(struct circular_queue
*cq
)
901 cq
->front
= cq
->rear
= 0;
902 lockdep_dependency_gen_id
++;
905 static inline int __cq_empty(struct circular_queue
*cq
)
907 return (cq
->front
== cq
->rear
);
910 static inline int __cq_full(struct circular_queue
*cq
)
912 return ((cq
->rear
+ 1) & CQ_MASK
) == cq
->front
;
915 static inline int __cq_enqueue(struct circular_queue
*cq
, unsigned long elem
)
920 cq
->element
[cq
->rear
] = elem
;
921 cq
->rear
= (cq
->rear
+ 1) & CQ_MASK
;
925 static inline int __cq_dequeue(struct circular_queue
*cq
, unsigned long *elem
)
930 *elem
= cq
->element
[cq
->front
];
931 cq
->front
= (cq
->front
+ 1) & CQ_MASK
;
935 static inline unsigned int __cq_get_elem_count(struct circular_queue
*cq
)
937 return (cq
->rear
- cq
->front
) & CQ_MASK
;
940 static inline void mark_lock_accessed(struct lock_list
*lock
,
941 struct lock_list
*parent
)
945 nr
= lock
- list_entries
;
946 WARN_ON(nr
>= nr_list_entries
); /* Out-of-bounds, input fail */
947 lock
->parent
= parent
;
948 lock
->class->dep_gen_id
= lockdep_dependency_gen_id
;
951 static inline unsigned long lock_accessed(struct lock_list
*lock
)
955 nr
= lock
- list_entries
;
956 WARN_ON(nr
>= nr_list_entries
); /* Out-of-bounds, input fail */
957 return lock
->class->dep_gen_id
== lockdep_dependency_gen_id
;
960 static inline struct lock_list
*get_lock_parent(struct lock_list
*child
)
962 return child
->parent
;
965 static inline int get_lock_depth(struct lock_list
*child
)
968 struct lock_list
*parent
;
970 while ((parent
= get_lock_parent(child
))) {
977 static int __bfs(struct lock_list
*source_entry
,
979 int (*match
)(struct lock_list
*entry
, void *data
),
980 struct lock_list
**target_entry
,
983 struct lock_list
*entry
;
984 struct list_head
*head
;
985 struct circular_queue
*cq
= &lock_cq
;
988 if (match(source_entry
, data
)) {
989 *target_entry
= source_entry
;
995 head
= &source_entry
->class->locks_after
;
997 head
= &source_entry
->class->locks_before
;
999 if (list_empty(head
))
1003 __cq_enqueue(cq
, (unsigned long)source_entry
);
1005 while (!__cq_empty(cq
)) {
1006 struct lock_list
*lock
;
1008 __cq_dequeue(cq
, (unsigned long *)&lock
);
1016 head
= &lock
->class->locks_after
;
1018 head
= &lock
->class->locks_before
;
1020 list_for_each_entry(entry
, head
, entry
) {
1021 if (!lock_accessed(entry
)) {
1022 unsigned int cq_depth
;
1023 mark_lock_accessed(entry
, lock
);
1024 if (match(entry
, data
)) {
1025 *target_entry
= entry
;
1030 if (__cq_enqueue(cq
, (unsigned long)entry
)) {
1034 cq_depth
= __cq_get_elem_count(cq
);
1035 if (max_bfs_queue_depth
< cq_depth
)
1036 max_bfs_queue_depth
= cq_depth
;
1044 static inline int __bfs_forwards(struct lock_list
*src_entry
,
1046 int (*match
)(struct lock_list
*entry
, void *data
),
1047 struct lock_list
**target_entry
)
1049 return __bfs(src_entry
, data
, match
, target_entry
, 1);
1053 static inline int __bfs_backwards(struct lock_list
*src_entry
,
1055 int (*match
)(struct lock_list
*entry
, void *data
),
1056 struct lock_list
**target_entry
)
1058 return __bfs(src_entry
, data
, match
, target_entry
, 0);
1063 * Recursive, forwards-direction lock-dependency checking, used for
1064 * both noncyclic checking and for hardirq-unsafe/softirq-unsafe
1069 * Print a dependency chain entry (this is only done when a deadlock
1070 * has been detected):
1073 print_circular_bug_entry(struct lock_list
*target
, int depth
)
1075 if (debug_locks_silent
)
1077 printk("\n-> #%u", depth
);
1078 print_lock_name(target
->class);
1080 print_stack_trace(&target
->trace
, 6);
1086 print_circular_lock_scenario(struct held_lock
*src
,
1087 struct held_lock
*tgt
,
1088 struct lock_list
*prt
)
1090 struct lock_class
*source
= hlock_class(src
);
1091 struct lock_class
*target
= hlock_class(tgt
);
1092 struct lock_class
*parent
= prt
->class;
1095 * A direct locking problem where unsafe_class lock is taken
1096 * directly by safe_class lock, then all we need to show
1097 * is the deadlock scenario, as it is obvious that the
1098 * unsafe lock is taken under the safe lock.
1100 * But if there is a chain instead, where the safe lock takes
1101 * an intermediate lock (middle_class) where this lock is
1102 * not the same as the safe lock, then the lock chain is
1103 * used to describe the problem. Otherwise we would need
1104 * to show a different CPU case for each link in the chain
1105 * from the safe_class lock to the unsafe_class lock.
1107 if (parent
!= source
) {
1108 printk("Chain exists of:\n ");
1109 __print_lock_name(source
);
1111 __print_lock_name(parent
);
1113 __print_lock_name(target
);
1117 printk(" Possible unsafe locking scenario:\n\n");
1118 printk(" CPU0 CPU1\n");
1119 printk(" ---- ----\n");
1121 __print_lock_name(target
);
1124 __print_lock_name(parent
);
1127 __print_lock_name(target
);
1130 __print_lock_name(source
);
1132 printk("\n *** DEADLOCK ***\n\n");
1136 * When a circular dependency is detected, print the
1140 print_circular_bug_header(struct lock_list
*entry
, unsigned int depth
,
1141 struct held_lock
*check_src
,
1142 struct held_lock
*check_tgt
)
1144 struct task_struct
*curr
= current
;
1146 if (debug_locks_silent
)
1150 printk("======================================================\n");
1151 printk("[ INFO: possible circular locking dependency detected ]\n");
1152 print_kernel_ident();
1153 printk("-------------------------------------------------------\n");
1154 printk("%s/%d is trying to acquire lock:\n",
1155 curr
->comm
, task_pid_nr(curr
));
1156 print_lock(check_src
);
1157 printk("\nbut task is already holding lock:\n");
1158 print_lock(check_tgt
);
1159 printk("\nwhich lock already depends on the new lock.\n\n");
1160 printk("\nthe existing dependency chain (in reverse order) is:\n");
1162 print_circular_bug_entry(entry
, depth
);
1167 static inline int class_equal(struct lock_list
*entry
, void *data
)
1169 return entry
->class == data
;
1172 static noinline
int print_circular_bug(struct lock_list
*this,
1173 struct lock_list
*target
,
1174 struct held_lock
*check_src
,
1175 struct held_lock
*check_tgt
)
1177 struct task_struct
*curr
= current
;
1178 struct lock_list
*parent
;
1179 struct lock_list
*first_parent
;
1182 if (!debug_locks_off_graph_unlock() || debug_locks_silent
)
1185 if (!save_trace(&this->trace
))
1188 depth
= get_lock_depth(target
);
1190 print_circular_bug_header(target
, depth
, check_src
, check_tgt
);
1192 parent
= get_lock_parent(target
);
1193 first_parent
= parent
;
1196 print_circular_bug_entry(parent
, --depth
);
1197 parent
= get_lock_parent(parent
);
1200 printk("\nother info that might help us debug this:\n\n");
1201 print_circular_lock_scenario(check_src
, check_tgt
,
1204 lockdep_print_held_locks(curr
);
1206 printk("\nstack backtrace:\n");
1212 static noinline
int print_bfs_bug(int ret
)
1214 if (!debug_locks_off_graph_unlock())
1218 * Breadth-first-search failed, graph got corrupted?
1220 WARN(1, "lockdep bfs error:%d\n", ret
);
1225 static int noop_count(struct lock_list
*entry
, void *data
)
1227 (*(unsigned long *)data
)++;
1231 unsigned long __lockdep_count_forward_deps(struct lock_list
*this)
1233 unsigned long count
= 0;
1234 struct lock_list
*uninitialized_var(target_entry
);
1236 __bfs_forwards(this, (void *)&count
, noop_count
, &target_entry
);
1240 unsigned long lockdep_count_forward_deps(struct lock_class
*class)
1242 unsigned long ret
, flags
;
1243 struct lock_list
this;
1248 local_irq_save(flags
);
1249 arch_spin_lock(&lockdep_lock
);
1250 ret
= __lockdep_count_forward_deps(&this);
1251 arch_spin_unlock(&lockdep_lock
);
1252 local_irq_restore(flags
);
1257 unsigned long __lockdep_count_backward_deps(struct lock_list
*this)
1259 unsigned long count
= 0;
1260 struct lock_list
*uninitialized_var(target_entry
);
1262 __bfs_backwards(this, (void *)&count
, noop_count
, &target_entry
);
1267 unsigned long lockdep_count_backward_deps(struct lock_class
*class)
1269 unsigned long ret
, flags
;
1270 struct lock_list
this;
1275 local_irq_save(flags
);
1276 arch_spin_lock(&lockdep_lock
);
1277 ret
= __lockdep_count_backward_deps(&this);
1278 arch_spin_unlock(&lockdep_lock
);
1279 local_irq_restore(flags
);
1285 * Prove that the dependency graph starting at <entry> can not
1286 * lead to <target>. Print an error and return 0 if it does.
1289 check_noncircular(struct lock_list
*root
, struct lock_class
*target
,
1290 struct lock_list
**target_entry
)
1294 debug_atomic_inc(nr_cyclic_checks
);
1296 result
= __bfs_forwards(root
, target
, class_equal
, target_entry
);
1301 #if defined(CONFIG_TRACE_IRQFLAGS) && defined(CONFIG_PROVE_LOCKING)
1303 * Forwards and backwards subgraph searching, for the purposes of
1304 * proving that two subgraphs can be connected by a new dependency
1305 * without creating any illegal irq-safe -> irq-unsafe lock dependency.
1308 static inline int usage_match(struct lock_list
*entry
, void *bit
)
1310 return entry
->class->usage_mask
& (1 << (enum lock_usage_bit
)bit
);
1316 * Find a node in the forwards-direction dependency sub-graph starting
1317 * at @root->class that matches @bit.
1319 * Return 0 if such a node exists in the subgraph, and put that node
1320 * into *@target_entry.
1322 * Return 1 otherwise and keep *@target_entry unchanged.
1323 * Return <0 on error.
1326 find_usage_forwards(struct lock_list
*root
, enum lock_usage_bit bit
,
1327 struct lock_list
**target_entry
)
1331 debug_atomic_inc(nr_find_usage_forwards_checks
);
1333 result
= __bfs_forwards(root
, (void *)bit
, usage_match
, target_entry
);
1339 * Find a node in the backwards-direction dependency sub-graph starting
1340 * at @root->class that matches @bit.
1342 * Return 0 if such a node exists in the subgraph, and put that node
1343 * into *@target_entry.
1345 * Return 1 otherwise and keep *@target_entry unchanged.
1346 * Return <0 on error.
1349 find_usage_backwards(struct lock_list
*root
, enum lock_usage_bit bit
,
1350 struct lock_list
**target_entry
)
1354 debug_atomic_inc(nr_find_usage_backwards_checks
);
1356 result
= __bfs_backwards(root
, (void *)bit
, usage_match
, target_entry
);
1361 static void print_lock_class_header(struct lock_class
*class, int depth
)
1365 printk("%*s->", depth
, "");
1366 print_lock_name(class);
1367 printk(" ops: %lu", class->ops
);
1370 for (bit
= 0; bit
< LOCK_USAGE_STATES
; bit
++) {
1371 if (class->usage_mask
& (1 << bit
)) {
1374 len
+= printk("%*s %s", depth
, "", usage_str
[bit
]);
1375 len
+= printk(" at:\n");
1376 print_stack_trace(class->usage_traces
+ bit
, len
);
1379 printk("%*s }\n", depth
, "");
1381 printk("%*s ... key at: ",depth
,"");
1382 print_ip_sym((unsigned long)class->key
);
1386 * printk the shortest lock dependencies from @start to @end in reverse order:
1389 print_shortest_lock_dependencies(struct lock_list
*leaf
,
1390 struct lock_list
*root
)
1392 struct lock_list
*entry
= leaf
;
1395 /*compute depth from generated tree by BFS*/
1396 depth
= get_lock_depth(leaf
);
1399 print_lock_class_header(entry
->class, depth
);
1400 printk("%*s ... acquired at:\n", depth
, "");
1401 print_stack_trace(&entry
->trace
, 2);
1404 if (depth
== 0 && (entry
!= root
)) {
1405 printk("lockdep:%s bad path found in chain graph\n", __func__
);
1409 entry
= get_lock_parent(entry
);
1411 } while (entry
&& (depth
>= 0));
1417 print_irq_lock_scenario(struct lock_list
*safe_entry
,
1418 struct lock_list
*unsafe_entry
,
1419 struct lock_class
*prev_class
,
1420 struct lock_class
*next_class
)
1422 struct lock_class
*safe_class
= safe_entry
->class;
1423 struct lock_class
*unsafe_class
= unsafe_entry
->class;
1424 struct lock_class
*middle_class
= prev_class
;
1426 if (middle_class
== safe_class
)
1427 middle_class
= next_class
;
1430 * A direct locking problem where unsafe_class lock is taken
1431 * directly by safe_class lock, then all we need to show
1432 * is the deadlock scenario, as it is obvious that the
1433 * unsafe lock is taken under the safe lock.
1435 * But if there is a chain instead, where the safe lock takes
1436 * an intermediate lock (middle_class) where this lock is
1437 * not the same as the safe lock, then the lock chain is
1438 * used to describe the problem. Otherwise we would need
1439 * to show a different CPU case for each link in the chain
1440 * from the safe_class lock to the unsafe_class lock.
1442 if (middle_class
!= unsafe_class
) {
1443 printk("Chain exists of:\n ");
1444 __print_lock_name(safe_class
);
1446 __print_lock_name(middle_class
);
1448 __print_lock_name(unsafe_class
);
1452 printk(" Possible interrupt unsafe locking scenario:\n\n");
1453 printk(" CPU0 CPU1\n");
1454 printk(" ---- ----\n");
1456 __print_lock_name(unsafe_class
);
1458 printk(" local_irq_disable();\n");
1460 __print_lock_name(safe_class
);
1463 __print_lock_name(middle_class
);
1465 printk(" <Interrupt>\n");
1467 __print_lock_name(safe_class
);
1469 printk("\n *** DEADLOCK ***\n\n");
1473 print_bad_irq_dependency(struct task_struct
*curr
,
1474 struct lock_list
*prev_root
,
1475 struct lock_list
*next_root
,
1476 struct lock_list
*backwards_entry
,
1477 struct lock_list
*forwards_entry
,
1478 struct held_lock
*prev
,
1479 struct held_lock
*next
,
1480 enum lock_usage_bit bit1
,
1481 enum lock_usage_bit bit2
,
1482 const char *irqclass
)
1484 if (!debug_locks_off_graph_unlock() || debug_locks_silent
)
1488 printk("======================================================\n");
1489 printk("[ INFO: %s-safe -> %s-unsafe lock order detected ]\n",
1490 irqclass
, irqclass
);
1491 print_kernel_ident();
1492 printk("------------------------------------------------------\n");
1493 printk("%s/%d [HC%u[%lu]:SC%u[%lu]:HE%u:SE%u] is trying to acquire:\n",
1494 curr
->comm
, task_pid_nr(curr
),
1495 curr
->hardirq_context
, hardirq_count() >> HARDIRQ_SHIFT
,
1496 curr
->softirq_context
, softirq_count() >> SOFTIRQ_SHIFT
,
1497 curr
->hardirqs_enabled
,
1498 curr
->softirqs_enabled
);
1501 printk("\nand this task is already holding:\n");
1503 printk("which would create a new lock dependency:\n");
1504 print_lock_name(hlock_class(prev
));
1506 print_lock_name(hlock_class(next
));
1509 printk("\nbut this new dependency connects a %s-irq-safe lock:\n",
1511 print_lock_name(backwards_entry
->class);
1512 printk("\n... which became %s-irq-safe at:\n", irqclass
);
1514 print_stack_trace(backwards_entry
->class->usage_traces
+ bit1
, 1);
1516 printk("\nto a %s-irq-unsafe lock:\n", irqclass
);
1517 print_lock_name(forwards_entry
->class);
1518 printk("\n... which became %s-irq-unsafe at:\n", irqclass
);
1521 print_stack_trace(forwards_entry
->class->usage_traces
+ bit2
, 1);
1523 printk("\nother info that might help us debug this:\n\n");
1524 print_irq_lock_scenario(backwards_entry
, forwards_entry
,
1525 hlock_class(prev
), hlock_class(next
));
1527 lockdep_print_held_locks(curr
);
1529 printk("\nthe dependencies between %s-irq-safe lock", irqclass
);
1530 printk(" and the holding lock:\n");
1531 if (!save_trace(&prev_root
->trace
))
1533 print_shortest_lock_dependencies(backwards_entry
, prev_root
);
1535 printk("\nthe dependencies between the lock to be acquired");
1536 printk(" and %s-irq-unsafe lock:\n", irqclass
);
1537 if (!save_trace(&next_root
->trace
))
1539 print_shortest_lock_dependencies(forwards_entry
, next_root
);
1541 printk("\nstack backtrace:\n");
1548 check_usage(struct task_struct
*curr
, struct held_lock
*prev
,
1549 struct held_lock
*next
, enum lock_usage_bit bit_backwards
,
1550 enum lock_usage_bit bit_forwards
, const char *irqclass
)
1553 struct lock_list
this, that
;
1554 struct lock_list
*uninitialized_var(target_entry
);
1555 struct lock_list
*uninitialized_var(target_entry1
);
1559 this.class = hlock_class(prev
);
1560 ret
= find_usage_backwards(&this, bit_backwards
, &target_entry
);
1562 return print_bfs_bug(ret
);
1567 that
.class = hlock_class(next
);
1568 ret
= find_usage_forwards(&that
, bit_forwards
, &target_entry1
);
1570 return print_bfs_bug(ret
);
1574 return print_bad_irq_dependency(curr
, &this, &that
,
1575 target_entry
, target_entry1
,
1577 bit_backwards
, bit_forwards
, irqclass
);
1580 static const char *state_names
[] = {
1581 #define LOCKDEP_STATE(__STATE) \
1582 __stringify(__STATE),
1583 #include "lockdep_states.h"
1584 #undef LOCKDEP_STATE
1587 static const char *state_rnames
[] = {
1588 #define LOCKDEP_STATE(__STATE) \
1589 __stringify(__STATE)"-READ",
1590 #include "lockdep_states.h"
1591 #undef LOCKDEP_STATE
1594 static inline const char *state_name(enum lock_usage_bit bit
)
1596 return (bit
& 1) ? state_rnames
[bit
>> 2] : state_names
[bit
>> 2];
1599 static int exclusive_bit(int new_bit
)
1607 * bit 0 - write/read
1608 * bit 1 - used_in/enabled
1612 int state
= new_bit
& ~3;
1613 int dir
= new_bit
& 2;
1616 * keep state, bit flip the direction and strip read.
1618 return state
| (dir
^ 2);
1621 static int check_irq_usage(struct task_struct
*curr
, struct held_lock
*prev
,
1622 struct held_lock
*next
, enum lock_usage_bit bit
)
1625 * Prove that the new dependency does not connect a hardirq-safe
1626 * lock with a hardirq-unsafe lock - to achieve this we search
1627 * the backwards-subgraph starting at <prev>, and the
1628 * forwards-subgraph starting at <next>:
1630 if (!check_usage(curr
, prev
, next
, bit
,
1631 exclusive_bit(bit
), state_name(bit
)))
1637 * Prove that the new dependency does not connect a hardirq-safe-read
1638 * lock with a hardirq-unsafe lock - to achieve this we search
1639 * the backwards-subgraph starting at <prev>, and the
1640 * forwards-subgraph starting at <next>:
1642 if (!check_usage(curr
, prev
, next
, bit
,
1643 exclusive_bit(bit
), state_name(bit
)))
1650 check_prev_add_irq(struct task_struct
*curr
, struct held_lock
*prev
,
1651 struct held_lock
*next
)
1653 #define LOCKDEP_STATE(__STATE) \
1654 if (!check_irq_usage(curr, prev, next, LOCK_USED_IN_##__STATE)) \
1656 #include "lockdep_states.h"
1657 #undef LOCKDEP_STATE
1662 static void inc_chains(void)
1664 if (current
->hardirq_context
)
1665 nr_hardirq_chains
++;
1667 if (current
->softirq_context
)
1668 nr_softirq_chains
++;
1670 nr_process_chains
++;
1677 check_prev_add_irq(struct task_struct
*curr
, struct held_lock
*prev
,
1678 struct held_lock
*next
)
1683 static inline void inc_chains(void)
1685 nr_process_chains
++;
1691 print_deadlock_scenario(struct held_lock
*nxt
,
1692 struct held_lock
*prv
)
1694 struct lock_class
*next
= hlock_class(nxt
);
1695 struct lock_class
*prev
= hlock_class(prv
);
1697 printk(" Possible unsafe locking scenario:\n\n");
1701 __print_lock_name(prev
);
1704 __print_lock_name(next
);
1706 printk("\n *** DEADLOCK ***\n\n");
1707 printk(" May be due to missing lock nesting notation\n\n");
1711 print_deadlock_bug(struct task_struct
*curr
, struct held_lock
*prev
,
1712 struct held_lock
*next
)
1714 if (!debug_locks_off_graph_unlock() || debug_locks_silent
)
1718 printk("=============================================\n");
1719 printk("[ INFO: possible recursive locking detected ]\n");
1720 print_kernel_ident();
1721 printk("---------------------------------------------\n");
1722 printk("%s/%d is trying to acquire lock:\n",
1723 curr
->comm
, task_pid_nr(curr
));
1725 printk("\nbut task is already holding lock:\n");
1728 printk("\nother info that might help us debug this:\n");
1729 print_deadlock_scenario(next
, prev
);
1730 lockdep_print_held_locks(curr
);
1732 printk("\nstack backtrace:\n");
1739 * Check whether we are holding such a class already.
1741 * (Note that this has to be done separately, because the graph cannot
1742 * detect such classes of deadlocks.)
1744 * Returns: 0 on deadlock detected, 1 on OK, 2 on recursive read
1747 check_deadlock(struct task_struct
*curr
, struct held_lock
*next
,
1748 struct lockdep_map
*next_instance
, int read
)
1750 struct held_lock
*prev
;
1751 struct held_lock
*nest
= NULL
;
1754 for (i
= 0; i
< curr
->lockdep_depth
; i
++) {
1755 prev
= curr
->held_locks
+ i
;
1757 if (prev
->instance
== next
->nest_lock
)
1760 if (hlock_class(prev
) != hlock_class(next
))
1764 * Allow read-after-read recursion of the same
1765 * lock class (i.e. read_lock(lock)+read_lock(lock)):
1767 if ((read
== 2) && prev
->read
)
1771 * We're holding the nest_lock, which serializes this lock's
1772 * nesting behaviour.
1777 return print_deadlock_bug(curr
, prev
, next
);
1783 * There was a chain-cache miss, and we are about to add a new dependency
1784 * to a previous lock. We recursively validate the following rules:
1786 * - would the adding of the <prev> -> <next> dependency create a
1787 * circular dependency in the graph? [== circular deadlock]
1789 * - does the new prev->next dependency connect any hardirq-safe lock
1790 * (in the full backwards-subgraph starting at <prev>) with any
1791 * hardirq-unsafe lock (in the full forwards-subgraph starting at
1792 * <next>)? [== illegal lock inversion with hardirq contexts]
1794 * - does the new prev->next dependency connect any softirq-safe lock
1795 * (in the full backwards-subgraph starting at <prev>) with any
1796 * softirq-unsafe lock (in the full forwards-subgraph starting at
1797 * <next>)? [== illegal lock inversion with softirq contexts]
1799 * any of these scenarios could lead to a deadlock.
1801 * Then if all the validations pass, we add the forwards and backwards
1805 check_prev_add(struct task_struct
*curr
, struct held_lock
*prev
,
1806 struct held_lock
*next
, int distance
, int trylock_loop
)
1808 struct lock_list
*entry
;
1810 struct lock_list
this;
1811 struct lock_list
*uninitialized_var(target_entry
);
1813 * Static variable, serialized by the graph_lock().
1815 * We use this static variable to save the stack trace in case
1816 * we call into this function multiple times due to encountering
1817 * trylocks in the held lock stack.
1819 static struct stack_trace trace
;
1822 * Prove that the new <prev> -> <next> dependency would not
1823 * create a circular dependency in the graph. (We do this by
1824 * forward-recursing into the graph starting at <next>, and
1825 * checking whether we can reach <prev>.)
1827 * We are using global variables to control the recursion, to
1828 * keep the stackframe size of the recursive functions low:
1830 this.class = hlock_class(next
);
1832 ret
= check_noncircular(&this, hlock_class(prev
), &target_entry
);
1834 return print_circular_bug(&this, target_entry
, next
, prev
);
1835 else if (unlikely(ret
< 0))
1836 return print_bfs_bug(ret
);
1838 if (!check_prev_add_irq(curr
, prev
, next
))
1842 * For recursive read-locks we do all the dependency checks,
1843 * but we dont store read-triggered dependencies (only
1844 * write-triggered dependencies). This ensures that only the
1845 * write-side dependencies matter, and that if for example a
1846 * write-lock never takes any other locks, then the reads are
1847 * equivalent to a NOP.
1849 if (next
->read
== 2 || prev
->read
== 2)
1852 * Is the <prev> -> <next> dependency already present?
1854 * (this may occur even though this is a new chain: consider
1855 * e.g. the L1 -> L2 -> L3 -> L4 and the L5 -> L1 -> L2 -> L3
1856 * chains - the second one will be new, but L1 already has
1857 * L2 added to its dependency list, due to the first chain.)
1859 list_for_each_entry(entry
, &hlock_class(prev
)->locks_after
, entry
) {
1860 if (entry
->class == hlock_class(next
)) {
1862 entry
->distance
= 1;
1867 if (!trylock_loop
&& !save_trace(&trace
))
1871 * Ok, all validations passed, add the new lock
1872 * to the previous lock's dependency list:
1874 ret
= add_lock_to_list(hlock_class(prev
), hlock_class(next
),
1875 &hlock_class(prev
)->locks_after
,
1876 next
->acquire_ip
, distance
, &trace
);
1881 ret
= add_lock_to_list(hlock_class(next
), hlock_class(prev
),
1882 &hlock_class(next
)->locks_before
,
1883 next
->acquire_ip
, distance
, &trace
);
1888 * Debugging printouts:
1890 if (verbose(hlock_class(prev
)) || verbose(hlock_class(next
))) {
1892 printk("\n new dependency: ");
1893 print_lock_name(hlock_class(prev
));
1895 print_lock_name(hlock_class(next
));
1898 return graph_lock();
1904 * Add the dependency to all directly-previous locks that are 'relevant'.
1905 * The ones that are relevant are (in increasing distance from curr):
1906 * all consecutive trylock entries and the final non-trylock entry - or
1907 * the end of this context's lock-chain - whichever comes first.
1910 check_prevs_add(struct task_struct
*curr
, struct held_lock
*next
)
1912 int depth
= curr
->lockdep_depth
;
1913 int trylock_loop
= 0;
1914 struct held_lock
*hlock
;
1919 * Depth must not be zero for a non-head lock:
1924 * At least two relevant locks must exist for this
1927 if (curr
->held_locks
[depth
].irq_context
!=
1928 curr
->held_locks
[depth
-1].irq_context
)
1932 int distance
= curr
->lockdep_depth
- depth
+ 1;
1933 hlock
= curr
->held_locks
+ depth
-1;
1935 * Only non-recursive-read entries get new dependencies
1938 if (hlock
->read
!= 2) {
1939 if (!check_prev_add(curr
, hlock
, next
,
1940 distance
, trylock_loop
))
1943 * Stop after the first non-trylock entry,
1944 * as non-trylock entries have added their
1945 * own direct dependencies already, so this
1946 * lock is connected to them indirectly:
1948 if (!hlock
->trylock
)
1953 * End of lock-stack?
1958 * Stop the search if we cross into another context:
1960 if (curr
->held_locks
[depth
].irq_context
!=
1961 curr
->held_locks
[depth
-1].irq_context
)
1967 if (!debug_locks_off_graph_unlock())
1971 * Clearly we all shouldn't be here, but since we made it we
1972 * can reliable say we messed up our state. See the above two
1973 * gotos for reasons why we could possibly end up here.
1980 unsigned long nr_lock_chains
;
1981 struct lock_chain lock_chains
[MAX_LOCKDEP_CHAINS
];
1982 int nr_chain_hlocks
;
1983 static u16 chain_hlocks
[MAX_LOCKDEP_CHAIN_HLOCKS
];
1985 struct lock_class
*lock_chain_get_class(struct lock_chain
*chain
, int i
)
1987 return lock_classes
+ chain_hlocks
[chain
->base
+ i
];
1991 * Look up a dependency chain. If the key is not present yet then
1992 * add it and return 1 - in this case the new dependency chain is
1993 * validated. If the key is already hashed, return 0.
1994 * (On return with 1 graph_lock is held.)
1996 static inline int lookup_chain_cache(struct task_struct
*curr
,
1997 struct held_lock
*hlock
,
2000 struct lock_class
*class = hlock_class(hlock
);
2001 struct list_head
*hash_head
= chainhashentry(chain_key
);
2002 struct lock_chain
*chain
;
2003 struct held_lock
*hlock_curr
, *hlock_next
;
2007 * We might need to take the graph lock, ensure we've got IRQs
2008 * disabled to make this an IRQ-safe lock.. for recursion reasons
2009 * lockdep won't complain about its own locking errors.
2011 if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
2014 * We can walk it lock-free, because entries only get added
2017 list_for_each_entry(chain
, hash_head
, entry
) {
2018 if (chain
->chain_key
== chain_key
) {
2020 debug_atomic_inc(chain_lookup_hits
);
2021 if (very_verbose(class))
2022 printk("\nhash chain already cached, key: "
2023 "%016Lx tail class: [%p] %s\n",
2024 (unsigned long long)chain_key
,
2025 class->key
, class->name
);
2029 if (very_verbose(class))
2030 printk("\nnew hash chain, key: %016Lx tail class: [%p] %s\n",
2031 (unsigned long long)chain_key
, class->key
, class->name
);
2033 * Allocate a new chain entry from the static array, and add
2039 * We have to walk the chain again locked - to avoid duplicates:
2041 list_for_each_entry(chain
, hash_head
, entry
) {
2042 if (chain
->chain_key
== chain_key
) {
2047 if (unlikely(nr_lock_chains
>= MAX_LOCKDEP_CHAINS
)) {
2048 if (!debug_locks_off_graph_unlock())
2051 printk("BUG: MAX_LOCKDEP_CHAINS too low!\n");
2052 printk("turning off the locking correctness validator.\n");
2056 chain
= lock_chains
+ nr_lock_chains
++;
2057 chain
->chain_key
= chain_key
;
2058 chain
->irq_context
= hlock
->irq_context
;
2059 /* Find the first held_lock of current chain */
2061 for (i
= curr
->lockdep_depth
- 1; i
>= 0; i
--) {
2062 hlock_curr
= curr
->held_locks
+ i
;
2063 if (hlock_curr
->irq_context
!= hlock_next
->irq_context
)
2068 chain
->depth
= curr
->lockdep_depth
+ 1 - i
;
2069 if (likely(nr_chain_hlocks
+ chain
->depth
<= MAX_LOCKDEP_CHAIN_HLOCKS
)) {
2070 chain
->base
= nr_chain_hlocks
;
2071 nr_chain_hlocks
+= chain
->depth
;
2072 for (j
= 0; j
< chain
->depth
- 1; j
++, i
++) {
2073 int lock_id
= curr
->held_locks
[i
].class_idx
- 1;
2074 chain_hlocks
[chain
->base
+ j
] = lock_id
;
2076 chain_hlocks
[chain
->base
+ j
] = class - lock_classes
;
2078 list_add_tail_rcu(&chain
->entry
, hash_head
);
2079 debug_atomic_inc(chain_lookup_misses
);
2085 static int validate_chain(struct task_struct
*curr
, struct lockdep_map
*lock
,
2086 struct held_lock
*hlock
, int chain_head
, u64 chain_key
)
2089 * Trylock needs to maintain the stack of held locks, but it
2090 * does not add new dependencies, because trylock can be done
2093 * We look up the chain_key and do the O(N^2) check and update of
2094 * the dependencies only if this is a new dependency chain.
2095 * (If lookup_chain_cache() returns with 1 it acquires
2096 * graph_lock for us)
2098 if (!hlock
->trylock
&& (hlock
->check
== 2) &&
2099 lookup_chain_cache(curr
, hlock
, chain_key
)) {
2101 * Check whether last held lock:
2103 * - is irq-safe, if this lock is irq-unsafe
2104 * - is softirq-safe, if this lock is hardirq-unsafe
2106 * And check whether the new lock's dependency graph
2107 * could lead back to the previous lock.
2109 * any of these scenarios could lead to a deadlock. If
2112 int ret
= check_deadlock(curr
, hlock
, lock
, hlock
->read
);
2117 * Mark recursive read, as we jump over it when
2118 * building dependencies (just like we jump over
2124 * Add dependency only if this lock is not the head
2125 * of the chain, and if it's not a secondary read-lock:
2127 if (!chain_head
&& ret
!= 2)
2128 if (!check_prevs_add(curr
, hlock
))
2132 /* after lookup_chain_cache(): */
2133 if (unlikely(!debug_locks
))
2139 static inline int validate_chain(struct task_struct
*curr
,
2140 struct lockdep_map
*lock
, struct held_lock
*hlock
,
2141 int chain_head
, u64 chain_key
)
2148 * We are building curr_chain_key incrementally, so double-check
2149 * it from scratch, to make sure that it's done correctly:
2151 static void check_chain_key(struct task_struct
*curr
)
2153 #ifdef CONFIG_DEBUG_LOCKDEP
2154 struct held_lock
*hlock
, *prev_hlock
= NULL
;
2158 for (i
= 0; i
< curr
->lockdep_depth
; i
++) {
2159 hlock
= curr
->held_locks
+ i
;
2160 if (chain_key
!= hlock
->prev_chain_key
) {
2163 * We got mighty confused, our chain keys don't match
2164 * with what we expect, someone trample on our task state?
2166 WARN(1, "hm#1, depth: %u [%u], %016Lx != %016Lx\n",
2167 curr
->lockdep_depth
, i
,
2168 (unsigned long long)chain_key
,
2169 (unsigned long long)hlock
->prev_chain_key
);
2172 id
= hlock
->class_idx
- 1;
2174 * Whoops ran out of static storage again?
2176 if (DEBUG_LOCKS_WARN_ON(id
>= MAX_LOCKDEP_KEYS
))
2179 if (prev_hlock
&& (prev_hlock
->irq_context
!=
2180 hlock
->irq_context
))
2182 chain_key
= iterate_chain_key(chain_key
, id
);
2185 if (chain_key
!= curr
->curr_chain_key
) {
2188 * More smoking hash instead of calculating it, damn see these
2189 * numbers float.. I bet that a pink elephant stepped on my memory.
2191 WARN(1, "hm#2, depth: %u [%u], %016Lx != %016Lx\n",
2192 curr
->lockdep_depth
, i
,
2193 (unsigned long long)chain_key
,
2194 (unsigned long long)curr
->curr_chain_key
);
2200 print_usage_bug_scenario(struct held_lock
*lock
)
2202 struct lock_class
*class = hlock_class(lock
);
2204 printk(" Possible unsafe locking scenario:\n\n");
2208 __print_lock_name(class);
2210 printk(" <Interrupt>\n");
2212 __print_lock_name(class);
2214 printk("\n *** DEADLOCK ***\n\n");
2218 print_usage_bug(struct task_struct
*curr
, struct held_lock
*this,
2219 enum lock_usage_bit prev_bit
, enum lock_usage_bit new_bit
)
2221 if (!debug_locks_off_graph_unlock() || debug_locks_silent
)
2225 printk("=================================\n");
2226 printk("[ INFO: inconsistent lock state ]\n");
2227 print_kernel_ident();
2228 printk("---------------------------------\n");
2230 printk("inconsistent {%s} -> {%s} usage.\n",
2231 usage_str
[prev_bit
], usage_str
[new_bit
]);
2233 printk("%s/%d [HC%u[%lu]:SC%u[%lu]:HE%u:SE%u] takes:\n",
2234 curr
->comm
, task_pid_nr(curr
),
2235 trace_hardirq_context(curr
), hardirq_count() >> HARDIRQ_SHIFT
,
2236 trace_softirq_context(curr
), softirq_count() >> SOFTIRQ_SHIFT
,
2237 trace_hardirqs_enabled(curr
),
2238 trace_softirqs_enabled(curr
));
2241 printk("{%s} state was registered at:\n", usage_str
[prev_bit
]);
2242 print_stack_trace(hlock_class(this)->usage_traces
+ prev_bit
, 1);
2244 print_irqtrace_events(curr
);
2245 printk("\nother info that might help us debug this:\n");
2246 print_usage_bug_scenario(this);
2248 lockdep_print_held_locks(curr
);
2250 printk("\nstack backtrace:\n");
2257 * Print out an error if an invalid bit is set:
2260 valid_state(struct task_struct
*curr
, struct held_lock
*this,
2261 enum lock_usage_bit new_bit
, enum lock_usage_bit bad_bit
)
2263 if (unlikely(hlock_class(this)->usage_mask
& (1 << bad_bit
)))
2264 return print_usage_bug(curr
, this, bad_bit
, new_bit
);
2268 static int mark_lock(struct task_struct
*curr
, struct held_lock
*this,
2269 enum lock_usage_bit new_bit
);
2271 #if defined(CONFIG_TRACE_IRQFLAGS) && defined(CONFIG_PROVE_LOCKING)
2274 * print irq inversion bug:
2277 print_irq_inversion_bug(struct task_struct
*curr
,
2278 struct lock_list
*root
, struct lock_list
*other
,
2279 struct held_lock
*this, int forwards
,
2280 const char *irqclass
)
2282 struct lock_list
*entry
= other
;
2283 struct lock_list
*middle
= NULL
;
2286 if (!debug_locks_off_graph_unlock() || debug_locks_silent
)
2290 printk("=========================================================\n");
2291 printk("[ INFO: possible irq lock inversion dependency detected ]\n");
2292 print_kernel_ident();
2293 printk("---------------------------------------------------------\n");
2294 printk("%s/%d just changed the state of lock:\n",
2295 curr
->comm
, task_pid_nr(curr
));
2298 printk("but this lock took another, %s-unsafe lock in the past:\n", irqclass
);
2300 printk("but this lock was taken by another, %s-safe lock in the past:\n", irqclass
);
2301 print_lock_name(other
->class);
2302 printk("\n\nand interrupts could create inverse lock ordering between them.\n\n");
2304 printk("\nother info that might help us debug this:\n");
2306 /* Find a middle lock (if one exists) */
2307 depth
= get_lock_depth(other
);
2309 if (depth
== 0 && (entry
!= root
)) {
2310 printk("lockdep:%s bad path found in chain graph\n", __func__
);
2314 entry
= get_lock_parent(entry
);
2316 } while (entry
&& entry
!= root
&& (depth
>= 0));
2318 print_irq_lock_scenario(root
, other
,
2319 middle
? middle
->class : root
->class, other
->class);
2321 print_irq_lock_scenario(other
, root
,
2322 middle
? middle
->class : other
->class, root
->class);
2324 lockdep_print_held_locks(curr
);
2326 printk("\nthe shortest dependencies between 2nd lock and 1st lock:\n");
2327 if (!save_trace(&root
->trace
))
2329 print_shortest_lock_dependencies(other
, root
);
2331 printk("\nstack backtrace:\n");
2338 * Prove that in the forwards-direction subgraph starting at <this>
2339 * there is no lock matching <mask>:
2342 check_usage_forwards(struct task_struct
*curr
, struct held_lock
*this,
2343 enum lock_usage_bit bit
, const char *irqclass
)
2346 struct lock_list root
;
2347 struct lock_list
*uninitialized_var(target_entry
);
2350 root
.class = hlock_class(this);
2351 ret
= find_usage_forwards(&root
, bit
, &target_entry
);
2353 return print_bfs_bug(ret
);
2357 return print_irq_inversion_bug(curr
, &root
, target_entry
,
2362 * Prove that in the backwards-direction subgraph starting at <this>
2363 * there is no lock matching <mask>:
2366 check_usage_backwards(struct task_struct
*curr
, struct held_lock
*this,
2367 enum lock_usage_bit bit
, const char *irqclass
)
2370 struct lock_list root
;
2371 struct lock_list
*uninitialized_var(target_entry
);
2374 root
.class = hlock_class(this);
2375 ret
= find_usage_backwards(&root
, bit
, &target_entry
);
2377 return print_bfs_bug(ret
);
2381 return print_irq_inversion_bug(curr
, &root
, target_entry
,
2385 void print_irqtrace_events(struct task_struct
*curr
)
2387 printk("irq event stamp: %u\n", curr
->irq_events
);
2388 printk("hardirqs last enabled at (%u): ", curr
->hardirq_enable_event
);
2389 print_ip_sym(curr
->hardirq_enable_ip
);
2390 printk("hardirqs last disabled at (%u): ", curr
->hardirq_disable_event
);
2391 print_ip_sym(curr
->hardirq_disable_ip
);
2392 printk("softirqs last enabled at (%u): ", curr
->softirq_enable_event
);
2393 print_ip_sym(curr
->softirq_enable_ip
);
2394 printk("softirqs last disabled at (%u): ", curr
->softirq_disable_event
);
2395 print_ip_sym(curr
->softirq_disable_ip
);
2398 static int HARDIRQ_verbose(struct lock_class
*class)
2401 return class_filter(class);
2406 static int SOFTIRQ_verbose(struct lock_class
*class)
2409 return class_filter(class);
2414 static int RECLAIM_FS_verbose(struct lock_class
*class)
2417 return class_filter(class);
2422 #define STRICT_READ_CHECKS 1
2424 static int (*state_verbose_f
[])(struct lock_class
*class) = {
2425 #define LOCKDEP_STATE(__STATE) \
2427 #include "lockdep_states.h"
2428 #undef LOCKDEP_STATE
2431 static inline int state_verbose(enum lock_usage_bit bit
,
2432 struct lock_class
*class)
2434 return state_verbose_f
[bit
>> 2](class);
2437 typedef int (*check_usage_f
)(struct task_struct
*, struct held_lock
*,
2438 enum lock_usage_bit bit
, const char *name
);
2441 mark_lock_irq(struct task_struct
*curr
, struct held_lock
*this,
2442 enum lock_usage_bit new_bit
)
2444 int excl_bit
= exclusive_bit(new_bit
);
2445 int read
= new_bit
& 1;
2446 int dir
= new_bit
& 2;
2449 * mark USED_IN has to look forwards -- to ensure no dependency
2450 * has ENABLED state, which would allow recursion deadlocks.
2452 * mark ENABLED has to look backwards -- to ensure no dependee
2453 * has USED_IN state, which, again, would allow recursion deadlocks.
2455 check_usage_f usage
= dir
?
2456 check_usage_backwards
: check_usage_forwards
;
2459 * Validate that this particular lock does not have conflicting
2462 if (!valid_state(curr
, this, new_bit
, excl_bit
))
2466 * Validate that the lock dependencies don't have conflicting usage
2469 if ((!read
|| !dir
|| STRICT_READ_CHECKS
) &&
2470 !usage(curr
, this, excl_bit
, state_name(new_bit
& ~1)))
2474 * Check for read in write conflicts
2477 if (!valid_state(curr
, this, new_bit
, excl_bit
+ 1))
2480 if (STRICT_READ_CHECKS
&&
2481 !usage(curr
, this, excl_bit
+ 1,
2482 state_name(new_bit
+ 1)))
2486 if (state_verbose(new_bit
, hlock_class(this)))
2493 #define LOCKDEP_STATE(__STATE) __STATE,
2494 #include "lockdep_states.h"
2495 #undef LOCKDEP_STATE
2499 * Mark all held locks with a usage bit:
2502 mark_held_locks(struct task_struct
*curr
, enum mark_type mark
)
2504 enum lock_usage_bit usage_bit
;
2505 struct held_lock
*hlock
;
2508 for (i
= 0; i
< curr
->lockdep_depth
; i
++) {
2509 hlock
= curr
->held_locks
+ i
;
2511 usage_bit
= 2 + (mark
<< 2); /* ENABLED */
2513 usage_bit
+= 1; /* READ */
2515 BUG_ON(usage_bit
>= LOCK_USAGE_STATES
);
2517 if (hlock_class(hlock
)->key
== __lockdep_no_validate__
.subkeys
)
2520 if (!mark_lock(curr
, hlock
, usage_bit
))
2528 * Hardirqs will be enabled:
2530 static void __trace_hardirqs_on_caller(unsigned long ip
)
2532 struct task_struct
*curr
= current
;
2534 /* we'll do an OFF -> ON transition: */
2535 curr
->hardirqs_enabled
= 1;
2538 * We are going to turn hardirqs on, so set the
2539 * usage bit for all held locks:
2541 if (!mark_held_locks(curr
, HARDIRQ
))
2544 * If we have softirqs enabled, then set the usage
2545 * bit for all held locks. (disabled hardirqs prevented
2546 * this bit from being set before)
2548 if (curr
->softirqs_enabled
)
2549 if (!mark_held_locks(curr
, SOFTIRQ
))
2552 curr
->hardirq_enable_ip
= ip
;
2553 curr
->hardirq_enable_event
= ++curr
->irq_events
;
2554 debug_atomic_inc(hardirqs_on_events
);
2557 void trace_hardirqs_on_caller(unsigned long ip
)
2559 time_hardirqs_on(CALLER_ADDR0
, ip
);
2561 if (unlikely(!debug_locks
|| current
->lockdep_recursion
))
2564 if (unlikely(current
->hardirqs_enabled
)) {
2566 * Neither irq nor preemption are disabled here
2567 * so this is racy by nature but losing one hit
2568 * in a stat is not a big deal.
2570 __debug_atomic_inc(redundant_hardirqs_on
);
2575 * We're enabling irqs and according to our state above irqs weren't
2576 * already enabled, yet we find the hardware thinks they are in fact
2577 * enabled.. someone messed up their IRQ state tracing.
2579 if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
2583 * See the fine text that goes along with this variable definition.
2585 if (DEBUG_LOCKS_WARN_ON(unlikely(early_boot_irqs_disabled
)))
2589 * Can't allow enabling interrupts while in an interrupt handler,
2590 * that's general bad form and such. Recursion, limited stack etc..
2592 if (DEBUG_LOCKS_WARN_ON(current
->hardirq_context
))
2595 current
->lockdep_recursion
= 1;
2596 __trace_hardirqs_on_caller(ip
);
2597 current
->lockdep_recursion
= 0;
2599 EXPORT_SYMBOL(trace_hardirqs_on_caller
);
2601 void trace_hardirqs_on(void)
2603 trace_hardirqs_on_caller(CALLER_ADDR0
);
2605 EXPORT_SYMBOL(trace_hardirqs_on
);
2608 * Hardirqs were disabled:
2610 void trace_hardirqs_off_caller(unsigned long ip
)
2612 struct task_struct
*curr
= current
;
2614 time_hardirqs_off(CALLER_ADDR0
, ip
);
2616 if (unlikely(!debug_locks
|| current
->lockdep_recursion
))
2620 * So we're supposed to get called after you mask local IRQs, but for
2621 * some reason the hardware doesn't quite think you did a proper job.
2623 if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
2626 if (curr
->hardirqs_enabled
) {
2628 * We have done an ON -> OFF transition:
2630 curr
->hardirqs_enabled
= 0;
2631 curr
->hardirq_disable_ip
= ip
;
2632 curr
->hardirq_disable_event
= ++curr
->irq_events
;
2633 debug_atomic_inc(hardirqs_off_events
);
2635 debug_atomic_inc(redundant_hardirqs_off
);
2637 EXPORT_SYMBOL(trace_hardirqs_off_caller
);
2639 void trace_hardirqs_off(void)
2641 trace_hardirqs_off_caller(CALLER_ADDR0
);
2643 EXPORT_SYMBOL(trace_hardirqs_off
);
2646 * Softirqs will be enabled:
2648 void trace_softirqs_on(unsigned long ip
)
2650 struct task_struct
*curr
= current
;
2652 if (unlikely(!debug_locks
|| current
->lockdep_recursion
))
2656 * We fancy IRQs being disabled here, see softirq.c, avoids
2657 * funny state and nesting things.
2659 if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
2662 if (curr
->softirqs_enabled
) {
2663 debug_atomic_inc(redundant_softirqs_on
);
2667 current
->lockdep_recursion
= 1;
2669 * We'll do an OFF -> ON transition:
2671 curr
->softirqs_enabled
= 1;
2672 curr
->softirq_enable_ip
= ip
;
2673 curr
->softirq_enable_event
= ++curr
->irq_events
;
2674 debug_atomic_inc(softirqs_on_events
);
2676 * We are going to turn softirqs on, so set the
2677 * usage bit for all held locks, if hardirqs are
2680 if (curr
->hardirqs_enabled
)
2681 mark_held_locks(curr
, SOFTIRQ
);
2682 current
->lockdep_recursion
= 0;
2686 * Softirqs were disabled:
2688 void trace_softirqs_off(unsigned long ip
)
2690 struct task_struct
*curr
= current
;
2692 if (unlikely(!debug_locks
|| current
->lockdep_recursion
))
2696 * We fancy IRQs being disabled here, see softirq.c
2698 if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
2701 if (curr
->softirqs_enabled
) {
2703 * We have done an ON -> OFF transition:
2705 curr
->softirqs_enabled
= 0;
2706 curr
->softirq_disable_ip
= ip
;
2707 curr
->softirq_disable_event
= ++curr
->irq_events
;
2708 debug_atomic_inc(softirqs_off_events
);
2710 * Whoops, we wanted softirqs off, so why aren't they?
2712 DEBUG_LOCKS_WARN_ON(!softirq_count());
2714 debug_atomic_inc(redundant_softirqs_off
);
2717 static void __lockdep_trace_alloc(gfp_t gfp_mask
, unsigned long flags
)
2719 struct task_struct
*curr
= current
;
2721 if (unlikely(!debug_locks
))
2724 /* no reclaim without waiting on it */
2725 if (!(gfp_mask
& __GFP_WAIT
))
2728 /* this guy won't enter reclaim */
2729 if ((curr
->flags
& PF_MEMALLOC
) && !(gfp_mask
& __GFP_NOMEMALLOC
))
2732 /* We're only interested __GFP_FS allocations for now */
2733 if (!(gfp_mask
& __GFP_FS
))
2737 * Oi! Can't be having __GFP_FS allocations with IRQs disabled.
2739 if (DEBUG_LOCKS_WARN_ON(irqs_disabled_flags(flags
)))
2742 mark_held_locks(curr
, RECLAIM_FS
);
2745 static void check_flags(unsigned long flags
);
2747 void lockdep_trace_alloc(gfp_t gfp_mask
)
2749 unsigned long flags
;
2751 if (unlikely(current
->lockdep_recursion
))
2754 raw_local_irq_save(flags
);
2756 current
->lockdep_recursion
= 1;
2757 __lockdep_trace_alloc(gfp_mask
, flags
);
2758 current
->lockdep_recursion
= 0;
2759 raw_local_irq_restore(flags
);
2762 static int mark_irqflags(struct task_struct
*curr
, struct held_lock
*hlock
)
2765 * If non-trylock use in a hardirq or softirq context, then
2766 * mark the lock as used in these contexts:
2768 if (!hlock
->trylock
) {
2770 if (curr
->hardirq_context
)
2771 if (!mark_lock(curr
, hlock
,
2772 LOCK_USED_IN_HARDIRQ_READ
))
2774 if (curr
->softirq_context
)
2775 if (!mark_lock(curr
, hlock
,
2776 LOCK_USED_IN_SOFTIRQ_READ
))
2779 if (curr
->hardirq_context
)
2780 if (!mark_lock(curr
, hlock
, LOCK_USED_IN_HARDIRQ
))
2782 if (curr
->softirq_context
)
2783 if (!mark_lock(curr
, hlock
, LOCK_USED_IN_SOFTIRQ
))
2787 if (!hlock
->hardirqs_off
) {
2789 if (!mark_lock(curr
, hlock
,
2790 LOCK_ENABLED_HARDIRQ_READ
))
2792 if (curr
->softirqs_enabled
)
2793 if (!mark_lock(curr
, hlock
,
2794 LOCK_ENABLED_SOFTIRQ_READ
))
2797 if (!mark_lock(curr
, hlock
,
2798 LOCK_ENABLED_HARDIRQ
))
2800 if (curr
->softirqs_enabled
)
2801 if (!mark_lock(curr
, hlock
,
2802 LOCK_ENABLED_SOFTIRQ
))
2808 * We reuse the irq context infrastructure more broadly as a general
2809 * context checking code. This tests GFP_FS recursion (a lock taken
2810 * during reclaim for a GFP_FS allocation is held over a GFP_FS
2813 if (!hlock
->trylock
&& (curr
->lockdep_reclaim_gfp
& __GFP_FS
)) {
2815 if (!mark_lock(curr
, hlock
, LOCK_USED_IN_RECLAIM_FS_READ
))
2818 if (!mark_lock(curr
, hlock
, LOCK_USED_IN_RECLAIM_FS
))
2826 static int separate_irq_context(struct task_struct
*curr
,
2827 struct held_lock
*hlock
)
2829 unsigned int depth
= curr
->lockdep_depth
;
2832 * Keep track of points where we cross into an interrupt context:
2834 hlock
->irq_context
= 2*(curr
->hardirq_context
? 1 : 0) +
2835 curr
->softirq_context
;
2837 struct held_lock
*prev_hlock
;
2839 prev_hlock
= curr
->held_locks
+ depth
-1;
2841 * If we cross into another context, reset the
2842 * hash key (this also prevents the checking and the
2843 * adding of the dependency to 'prev'):
2845 if (prev_hlock
->irq_context
!= hlock
->irq_context
)
2851 #else /* defined(CONFIG_TRACE_IRQFLAGS) && defined(CONFIG_PROVE_LOCKING) */
2854 int mark_lock_irq(struct task_struct
*curr
, struct held_lock
*this,
2855 enum lock_usage_bit new_bit
)
2857 WARN_ON(1); /* Impossible innit? when we don't have TRACE_IRQFLAG */
2861 static inline int mark_irqflags(struct task_struct
*curr
,
2862 struct held_lock
*hlock
)
2867 static inline int separate_irq_context(struct task_struct
*curr
,
2868 struct held_lock
*hlock
)
2873 void lockdep_trace_alloc(gfp_t gfp_mask
)
2877 #endif /* defined(CONFIG_TRACE_IRQFLAGS) && defined(CONFIG_PROVE_LOCKING) */
2880 * Mark a lock with a usage bit, and validate the state transition:
2882 static int mark_lock(struct task_struct
*curr
, struct held_lock
*this,
2883 enum lock_usage_bit new_bit
)
2885 unsigned int new_mask
= 1 << new_bit
, ret
= 1;
2888 * If already set then do not dirty the cacheline,
2889 * nor do any checks:
2891 if (likely(hlock_class(this)->usage_mask
& new_mask
))
2897 * Make sure we didn't race:
2899 if (unlikely(hlock_class(this)->usage_mask
& new_mask
)) {
2904 hlock_class(this)->usage_mask
|= new_mask
;
2906 if (!save_trace(hlock_class(this)->usage_traces
+ new_bit
))
2910 #define LOCKDEP_STATE(__STATE) \
2911 case LOCK_USED_IN_##__STATE: \
2912 case LOCK_USED_IN_##__STATE##_READ: \
2913 case LOCK_ENABLED_##__STATE: \
2914 case LOCK_ENABLED_##__STATE##_READ:
2915 #include "lockdep_states.h"
2916 #undef LOCKDEP_STATE
2917 ret
= mark_lock_irq(curr
, this, new_bit
);
2922 debug_atomic_dec(nr_unused_locks
);
2925 if (!debug_locks_off_graph_unlock())
2934 * We must printk outside of the graph_lock:
2937 printk("\nmarked lock as {%s}:\n", usage_str
[new_bit
]);
2939 print_irqtrace_events(curr
);
2947 * Initialize a lock instance's lock-class mapping info:
2949 void lockdep_init_map(struct lockdep_map
*lock
, const char *name
,
2950 struct lock_class_key
*key
, int subclass
)
2954 kmemcheck_mark_initialized(lock
, sizeof(*lock
));
2956 for (i
= 0; i
< NR_LOCKDEP_CACHING_CLASSES
; i
++)
2957 lock
->class_cache
[i
] = NULL
;
2959 #ifdef CONFIG_LOCK_STAT
2960 lock
->cpu
= raw_smp_processor_id();
2964 * Can't be having no nameless bastards around this place!
2966 if (DEBUG_LOCKS_WARN_ON(!name
)) {
2967 lock
->name
= "NULL";
2974 * No key, no joy, we need to hash something.
2976 if (DEBUG_LOCKS_WARN_ON(!key
))
2979 * Sanity check, the lock-class key must be persistent:
2981 if (!static_obj(key
)) {
2982 printk("BUG: key %p not in .data!\n", key
);
2984 * What it says above ^^^^^, I suggest you read it.
2986 DEBUG_LOCKS_WARN_ON(1);
2991 if (unlikely(!debug_locks
))
2995 register_lock_class(lock
, subclass
, 1);
2997 EXPORT_SYMBOL_GPL(lockdep_init_map
);
2999 struct lock_class_key __lockdep_no_validate__
;
3002 * This gets called for every mutex_lock*()/spin_lock*() operation.
3003 * We maintain the dependency maps and validate the locking attempt:
3005 static int __lock_acquire(struct lockdep_map
*lock
, unsigned int subclass
,
3006 int trylock
, int read
, int check
, int hardirqs_off
,
3007 struct lockdep_map
*nest_lock
, unsigned long ip
,
3010 struct task_struct
*curr
= current
;
3011 struct lock_class
*class = NULL
;
3012 struct held_lock
*hlock
;
3013 unsigned int depth
, id
;
3021 if (unlikely(!debug_locks
))
3025 * Lockdep should run with IRQs disabled, otherwise we could
3026 * get an interrupt which would want to take locks, which would
3027 * end up in lockdep and have you got a head-ache already?
3029 if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
3032 if (lock
->key
== &__lockdep_no_validate__
)
3035 if (subclass
< NR_LOCKDEP_CACHING_CLASSES
)
3036 class = lock
->class_cache
[subclass
];
3040 if (unlikely(!class)) {
3041 class = register_lock_class(lock
, subclass
, 0);
3045 atomic_inc((atomic_t
*)&class->ops
);
3046 if (very_verbose(class)) {
3047 printk("\nacquire class [%p] %s", class->key
, class->name
);
3048 if (class->name_version
> 1)
3049 printk("#%d", class->name_version
);
3055 * Add the lock to the list of currently held locks.
3056 * (we dont increase the depth just yet, up until the
3057 * dependency checks are done)
3059 depth
= curr
->lockdep_depth
;
3061 * Ran out of static storage for our per-task lock stack again have we?
3063 if (DEBUG_LOCKS_WARN_ON(depth
>= MAX_LOCK_DEPTH
))
3066 class_idx
= class - lock_classes
+ 1;
3069 hlock
= curr
->held_locks
+ depth
- 1;
3070 if (hlock
->class_idx
== class_idx
&& nest_lock
) {
3071 if (hlock
->references
)
3072 hlock
->references
++;
3074 hlock
->references
= 2;
3080 hlock
= curr
->held_locks
+ depth
;
3082 * Plain impossible, we just registered it and checked it weren't no
3083 * NULL like.. I bet this mushroom I ate was good!
3085 if (DEBUG_LOCKS_WARN_ON(!class))
3087 hlock
->class_idx
= class_idx
;
3088 hlock
->acquire_ip
= ip
;
3089 hlock
->instance
= lock
;
3090 hlock
->nest_lock
= nest_lock
;
3091 hlock
->trylock
= trylock
;
3093 hlock
->check
= check
;
3094 hlock
->hardirqs_off
= !!hardirqs_off
;
3095 hlock
->references
= references
;
3096 #ifdef CONFIG_LOCK_STAT
3097 hlock
->waittime_stamp
= 0;
3098 hlock
->holdtime_stamp
= lockstat_clock();
3101 if (check
== 2 && !mark_irqflags(curr
, hlock
))
3104 /* mark it as used: */
3105 if (!mark_lock(curr
, hlock
, LOCK_USED
))
3109 * Calculate the chain hash: it's the combined hash of all the
3110 * lock keys along the dependency chain. We save the hash value
3111 * at every step so that we can get the current hash easily
3112 * after unlock. The chain hash is then used to cache dependency
3115 * The 'key ID' is what is the most compact key value to drive
3116 * the hash, not class->key.
3118 id
= class - lock_classes
;
3120 * Whoops, we did it again.. ran straight out of our static allocation.
3122 if (DEBUG_LOCKS_WARN_ON(id
>= MAX_LOCKDEP_KEYS
))
3125 chain_key
= curr
->curr_chain_key
;
3128 * How can we have a chain hash when we ain't got no keys?!
3130 if (DEBUG_LOCKS_WARN_ON(chain_key
!= 0))
3135 hlock
->prev_chain_key
= chain_key
;
3136 if (separate_irq_context(curr
, hlock
)) {
3140 chain_key
= iterate_chain_key(chain_key
, id
);
3142 if (!validate_chain(curr
, lock
, hlock
, chain_head
, chain_key
))
3145 curr
->curr_chain_key
= chain_key
;
3146 curr
->lockdep_depth
++;
3147 check_chain_key(curr
);
3148 #ifdef CONFIG_DEBUG_LOCKDEP
3149 if (unlikely(!debug_locks
))
3152 if (unlikely(curr
->lockdep_depth
>= MAX_LOCK_DEPTH
)) {
3154 printk("BUG: MAX_LOCK_DEPTH too low!\n");
3155 printk("turning off the locking correctness validator.\n");
3160 if (unlikely(curr
->lockdep_depth
> max_lockdep_depth
))
3161 max_lockdep_depth
= curr
->lockdep_depth
;
3167 print_unlock_inbalance_bug(struct task_struct
*curr
, struct lockdep_map
*lock
,
3170 if (!debug_locks_off())
3172 if (debug_locks_silent
)
3176 printk("=====================================\n");
3177 printk("[ BUG: bad unlock balance detected! ]\n");
3178 print_kernel_ident();
3179 printk("-------------------------------------\n");
3180 printk("%s/%d is trying to release lock (",
3181 curr
->comm
, task_pid_nr(curr
));
3182 print_lockdep_cache(lock
);
3185 printk("but there are no more locks to release!\n");
3186 printk("\nother info that might help us debug this:\n");
3187 lockdep_print_held_locks(curr
);
3189 printk("\nstack backtrace:\n");
3196 * Common debugging checks for both nested and non-nested unlock:
3198 static int check_unlock(struct task_struct
*curr
, struct lockdep_map
*lock
,
3201 if (unlikely(!debug_locks
))
3204 * Lockdep should run with IRQs disabled, recursion, head-ache, etc..
3206 if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
3209 if (curr
->lockdep_depth
<= 0)
3210 return print_unlock_inbalance_bug(curr
, lock
, ip
);
3215 static int match_held_lock(struct held_lock
*hlock
, struct lockdep_map
*lock
)
3217 if (hlock
->instance
== lock
)
3220 if (hlock
->references
) {
3221 struct lock_class
*class = lock
->class_cache
[0];
3224 class = look_up_lock_class(lock
, 0);
3227 * If look_up_lock_class() failed to find a class, we're trying
3228 * to test if we hold a lock that has never yet been acquired.
3229 * Clearly if the lock hasn't been acquired _ever_, we're not
3230 * holding it either, so report failure.
3236 * References, but not a lock we're actually ref-counting?
3237 * State got messed up, follow the sites that change ->references
3238 * and try to make sense of it.
3240 if (DEBUG_LOCKS_WARN_ON(!hlock
->nest_lock
))
3243 if (hlock
->class_idx
== class - lock_classes
+ 1)
3251 __lock_set_class(struct lockdep_map
*lock
, const char *name
,
3252 struct lock_class_key
*key
, unsigned int subclass
,
3255 struct task_struct
*curr
= current
;
3256 struct held_lock
*hlock
, *prev_hlock
;
3257 struct lock_class
*class;
3261 depth
= curr
->lockdep_depth
;
3263 * This function is about (re)setting the class of a held lock,
3264 * yet we're not actually holding any locks. Naughty user!
3266 if (DEBUG_LOCKS_WARN_ON(!depth
))
3270 for (i
= depth
-1; i
>= 0; i
--) {
3271 hlock
= curr
->held_locks
+ i
;
3273 * We must not cross into another context:
3275 if (prev_hlock
&& prev_hlock
->irq_context
!= hlock
->irq_context
)
3277 if (match_held_lock(hlock
, lock
))
3281 return print_unlock_inbalance_bug(curr
, lock
, ip
);
3284 lockdep_init_map(lock
, name
, key
, 0);
3285 class = register_lock_class(lock
, subclass
, 0);
3286 hlock
->class_idx
= class - lock_classes
+ 1;
3288 curr
->lockdep_depth
= i
;
3289 curr
->curr_chain_key
= hlock
->prev_chain_key
;
3291 for (; i
< depth
; i
++) {
3292 hlock
= curr
->held_locks
+ i
;
3293 if (!__lock_acquire(hlock
->instance
,
3294 hlock_class(hlock
)->subclass
, hlock
->trylock
,
3295 hlock
->read
, hlock
->check
, hlock
->hardirqs_off
,
3296 hlock
->nest_lock
, hlock
->acquire_ip
,
3302 * I took it apart and put it back together again, except now I have
3303 * these 'spare' parts.. where shall I put them.
3305 if (DEBUG_LOCKS_WARN_ON(curr
->lockdep_depth
!= depth
))
3311 * Remove the lock to the list of currently held locks in a
3312 * potentially non-nested (out of order) manner. This is a
3313 * relatively rare operation, as all the unlock APIs default
3314 * to nested mode (which uses lock_release()):
3317 lock_release_non_nested(struct task_struct
*curr
,
3318 struct lockdep_map
*lock
, unsigned long ip
)
3320 struct held_lock
*hlock
, *prev_hlock
;
3325 * Check whether the lock exists in the current stack
3328 depth
= curr
->lockdep_depth
;
3330 * So we're all set to release this lock.. wait what lock? We don't
3331 * own any locks, you've been drinking again?
3333 if (DEBUG_LOCKS_WARN_ON(!depth
))
3337 for (i
= depth
-1; i
>= 0; i
--) {
3338 hlock
= curr
->held_locks
+ i
;
3340 * We must not cross into another context:
3342 if (prev_hlock
&& prev_hlock
->irq_context
!= hlock
->irq_context
)
3344 if (match_held_lock(hlock
, lock
))
3348 return print_unlock_inbalance_bug(curr
, lock
, ip
);
3351 if (hlock
->instance
== lock
)
3352 lock_release_holdtime(hlock
);
3354 if (hlock
->references
) {
3355 hlock
->references
--;
3356 if (hlock
->references
) {
3358 * We had, and after removing one, still have
3359 * references, the current lock stack is still
3360 * valid. We're done!
3367 * We have the right lock to unlock, 'hlock' points to it.
3368 * Now we remove it from the stack, and add back the other
3369 * entries (if any), recalculating the hash along the way:
3372 curr
->lockdep_depth
= i
;
3373 curr
->curr_chain_key
= hlock
->prev_chain_key
;
3375 for (i
++; i
< depth
; i
++) {
3376 hlock
= curr
->held_locks
+ i
;
3377 if (!__lock_acquire(hlock
->instance
,
3378 hlock_class(hlock
)->subclass
, hlock
->trylock
,
3379 hlock
->read
, hlock
->check
, hlock
->hardirqs_off
,
3380 hlock
->nest_lock
, hlock
->acquire_ip
,
3386 * We had N bottles of beer on the wall, we drank one, but now
3387 * there's not N-1 bottles of beer left on the wall...
3389 if (DEBUG_LOCKS_WARN_ON(curr
->lockdep_depth
!= depth
- 1))
3395 * Remove the lock to the list of currently held locks - this gets
3396 * called on mutex_unlock()/spin_unlock*() (or on a failed
3397 * mutex_lock_interruptible()). This is done for unlocks that nest
3398 * perfectly. (i.e. the current top of the lock-stack is unlocked)
3400 static int lock_release_nested(struct task_struct
*curr
,
3401 struct lockdep_map
*lock
, unsigned long ip
)
3403 struct held_lock
*hlock
;
3407 * Pop off the top of the lock stack:
3409 depth
= curr
->lockdep_depth
- 1;
3410 hlock
= curr
->held_locks
+ depth
;
3413 * Is the unlock non-nested:
3415 if (hlock
->instance
!= lock
|| hlock
->references
)
3416 return lock_release_non_nested(curr
, lock
, ip
);
3417 curr
->lockdep_depth
--;
3420 * No more locks, but somehow we've got hash left over, who left it?
3422 if (DEBUG_LOCKS_WARN_ON(!depth
&& (hlock
->prev_chain_key
!= 0)))
3425 curr
->curr_chain_key
= hlock
->prev_chain_key
;
3427 lock_release_holdtime(hlock
);
3429 #ifdef CONFIG_DEBUG_LOCKDEP
3430 hlock
->prev_chain_key
= 0;
3431 hlock
->class_idx
= 0;
3432 hlock
->acquire_ip
= 0;
3433 hlock
->irq_context
= 0;
3439 * Remove the lock to the list of currently held locks - this gets
3440 * called on mutex_unlock()/spin_unlock*() (or on a failed
3441 * mutex_lock_interruptible()). This is done for unlocks that nest
3442 * perfectly. (i.e. the current top of the lock-stack is unlocked)
3445 __lock_release(struct lockdep_map
*lock
, int nested
, unsigned long ip
)
3447 struct task_struct
*curr
= current
;
3449 if (!check_unlock(curr
, lock
, ip
))
3453 if (!lock_release_nested(curr
, lock
, ip
))
3456 if (!lock_release_non_nested(curr
, lock
, ip
))
3460 check_chain_key(curr
);
3463 static int __lock_is_held(struct lockdep_map
*lock
)
3465 struct task_struct
*curr
= current
;
3468 for (i
= 0; i
< curr
->lockdep_depth
; i
++) {
3469 struct held_lock
*hlock
= curr
->held_locks
+ i
;
3471 if (match_held_lock(hlock
, lock
))
3479 * Check whether we follow the irq-flags state precisely:
3481 static void check_flags(unsigned long flags
)
3483 #if defined(CONFIG_PROVE_LOCKING) && defined(CONFIG_DEBUG_LOCKDEP) && \
3484 defined(CONFIG_TRACE_IRQFLAGS)
3488 if (irqs_disabled_flags(flags
)) {
3489 if (DEBUG_LOCKS_WARN_ON(current
->hardirqs_enabled
)) {
3490 printk("possible reason: unannotated irqs-off.\n");
3493 if (DEBUG_LOCKS_WARN_ON(!current
->hardirqs_enabled
)) {
3494 printk("possible reason: unannotated irqs-on.\n");
3499 * We dont accurately track softirq state in e.g.
3500 * hardirq contexts (such as on 4KSTACKS), so only
3501 * check if not in hardirq contexts:
3503 if (!hardirq_count()) {
3504 if (softirq_count()) {
3505 /* like the above, but with softirqs */
3506 DEBUG_LOCKS_WARN_ON(current
->softirqs_enabled
);
3508 /* lick the above, does it taste good? */
3509 DEBUG_LOCKS_WARN_ON(!current
->softirqs_enabled
);
3514 print_irqtrace_events(current
);
3518 void lock_set_class(struct lockdep_map
*lock
, const char *name
,
3519 struct lock_class_key
*key
, unsigned int subclass
,
3522 unsigned long flags
;
3524 if (unlikely(current
->lockdep_recursion
))
3527 raw_local_irq_save(flags
);
3528 current
->lockdep_recursion
= 1;
3530 if (__lock_set_class(lock
, name
, key
, subclass
, ip
))
3531 check_chain_key(current
);
3532 current
->lockdep_recursion
= 0;
3533 raw_local_irq_restore(flags
);
3535 EXPORT_SYMBOL_GPL(lock_set_class
);
3538 * We are not always called with irqs disabled - do that here,
3539 * and also avoid lockdep recursion:
3541 void lock_acquire(struct lockdep_map
*lock
, unsigned int subclass
,
3542 int trylock
, int read
, int check
,
3543 struct lockdep_map
*nest_lock
, unsigned long ip
)
3545 unsigned long flags
;
3547 if (unlikely(current
->lockdep_recursion
))
3550 raw_local_irq_save(flags
);
3553 current
->lockdep_recursion
= 1;
3554 trace_lock_acquire(lock
, subclass
, trylock
, read
, check
, nest_lock
, ip
);
3555 __lock_acquire(lock
, subclass
, trylock
, read
, check
,
3556 irqs_disabled_flags(flags
), nest_lock
, ip
, 0);
3557 current
->lockdep_recursion
= 0;
3558 raw_local_irq_restore(flags
);
3560 EXPORT_SYMBOL_GPL(lock_acquire
);
3562 void lock_release(struct lockdep_map
*lock
, int nested
,
3565 unsigned long flags
;
3567 if (unlikely(current
->lockdep_recursion
))
3570 raw_local_irq_save(flags
);
3572 current
->lockdep_recursion
= 1;
3573 trace_lock_release(lock
, ip
);
3574 __lock_release(lock
, nested
, ip
);
3575 current
->lockdep_recursion
= 0;
3576 raw_local_irq_restore(flags
);
3578 EXPORT_SYMBOL_GPL(lock_release
);
3580 int lock_is_held(struct lockdep_map
*lock
)
3582 unsigned long flags
;
3585 if (unlikely(current
->lockdep_recursion
))
3586 return 1; /* avoid false negative lockdep_assert_held() */
3588 raw_local_irq_save(flags
);
3591 current
->lockdep_recursion
= 1;
3592 ret
= __lock_is_held(lock
);
3593 current
->lockdep_recursion
= 0;
3594 raw_local_irq_restore(flags
);
3598 EXPORT_SYMBOL_GPL(lock_is_held
);
3600 void lockdep_set_current_reclaim_state(gfp_t gfp_mask
)
3602 current
->lockdep_reclaim_gfp
= gfp_mask
;
3605 void lockdep_clear_current_reclaim_state(void)
3607 current
->lockdep_reclaim_gfp
= 0;
3610 #ifdef CONFIG_LOCK_STAT
3612 print_lock_contention_bug(struct task_struct
*curr
, struct lockdep_map
*lock
,
3615 if (!debug_locks_off())
3617 if (debug_locks_silent
)
3621 printk("=================================\n");
3622 printk("[ BUG: bad contention detected! ]\n");
3623 print_kernel_ident();
3624 printk("---------------------------------\n");
3625 printk("%s/%d is trying to contend lock (",
3626 curr
->comm
, task_pid_nr(curr
));
3627 print_lockdep_cache(lock
);
3630 printk("but there are no locks held!\n");
3631 printk("\nother info that might help us debug this:\n");
3632 lockdep_print_held_locks(curr
);
3634 printk("\nstack backtrace:\n");
3641 __lock_contended(struct lockdep_map
*lock
, unsigned long ip
)
3643 struct task_struct
*curr
= current
;
3644 struct held_lock
*hlock
, *prev_hlock
;
3645 struct lock_class_stats
*stats
;
3647 int i
, contention_point
, contending_point
;
3649 depth
= curr
->lockdep_depth
;
3651 * Whee, we contended on this lock, except it seems we're not
3652 * actually trying to acquire anything much at all..
3654 if (DEBUG_LOCKS_WARN_ON(!depth
))
3658 for (i
= depth
-1; i
>= 0; i
--) {
3659 hlock
= curr
->held_locks
+ i
;
3661 * We must not cross into another context:
3663 if (prev_hlock
&& prev_hlock
->irq_context
!= hlock
->irq_context
)
3665 if (match_held_lock(hlock
, lock
))
3669 print_lock_contention_bug(curr
, lock
, ip
);
3673 if (hlock
->instance
!= lock
)
3676 hlock
->waittime_stamp
= lockstat_clock();
3678 contention_point
= lock_point(hlock_class(hlock
)->contention_point
, ip
);
3679 contending_point
= lock_point(hlock_class(hlock
)->contending_point
,
3682 stats
= get_lock_stats(hlock_class(hlock
));
3683 if (contention_point
< LOCKSTAT_POINTS
)
3684 stats
->contention_point
[contention_point
]++;
3685 if (contending_point
< LOCKSTAT_POINTS
)
3686 stats
->contending_point
[contending_point
]++;
3687 if (lock
->cpu
!= smp_processor_id())
3688 stats
->bounces
[bounce_contended
+ !!hlock
->read
]++;
3689 put_lock_stats(stats
);
3693 __lock_acquired(struct lockdep_map
*lock
, unsigned long ip
)
3695 struct task_struct
*curr
= current
;
3696 struct held_lock
*hlock
, *prev_hlock
;
3697 struct lock_class_stats
*stats
;
3699 u64 now
, waittime
= 0;
3702 depth
= curr
->lockdep_depth
;
3704 * Yay, we acquired ownership of this lock we didn't try to
3705 * acquire, how the heck did that happen?
3707 if (DEBUG_LOCKS_WARN_ON(!depth
))
3711 for (i
= depth
-1; i
>= 0; i
--) {
3712 hlock
= curr
->held_locks
+ i
;
3714 * We must not cross into another context:
3716 if (prev_hlock
&& prev_hlock
->irq_context
!= hlock
->irq_context
)
3718 if (match_held_lock(hlock
, lock
))
3722 print_lock_contention_bug(curr
, lock
, _RET_IP_
);
3726 if (hlock
->instance
!= lock
)
3729 cpu
= smp_processor_id();
3730 if (hlock
->waittime_stamp
) {
3731 now
= lockstat_clock();
3732 waittime
= now
- hlock
->waittime_stamp
;
3733 hlock
->holdtime_stamp
= now
;
3736 trace_lock_acquired(lock
, ip
);
3738 stats
= get_lock_stats(hlock_class(hlock
));
3741 lock_time_inc(&stats
->read_waittime
, waittime
);
3743 lock_time_inc(&stats
->write_waittime
, waittime
);
3745 if (lock
->cpu
!= cpu
)
3746 stats
->bounces
[bounce_acquired
+ !!hlock
->read
]++;
3747 put_lock_stats(stats
);
3753 void lock_contended(struct lockdep_map
*lock
, unsigned long ip
)
3755 unsigned long flags
;
3757 if (unlikely(!lock_stat
))
3760 if (unlikely(current
->lockdep_recursion
))
3763 raw_local_irq_save(flags
);
3765 current
->lockdep_recursion
= 1;
3766 trace_lock_contended(lock
, ip
);
3767 __lock_contended(lock
, ip
);
3768 current
->lockdep_recursion
= 0;
3769 raw_local_irq_restore(flags
);
3771 EXPORT_SYMBOL_GPL(lock_contended
);
3773 void lock_acquired(struct lockdep_map
*lock
, unsigned long ip
)
3775 unsigned long flags
;
3777 if (unlikely(!lock_stat
))
3780 if (unlikely(current
->lockdep_recursion
))
3783 raw_local_irq_save(flags
);
3785 current
->lockdep_recursion
= 1;
3786 __lock_acquired(lock
, ip
);
3787 current
->lockdep_recursion
= 0;
3788 raw_local_irq_restore(flags
);
3790 EXPORT_SYMBOL_GPL(lock_acquired
);
3794 * Used by the testsuite, sanitize the validator state
3795 * after a simulated failure:
3798 void lockdep_reset(void)
3800 unsigned long flags
;
3803 raw_local_irq_save(flags
);
3804 current
->curr_chain_key
= 0;
3805 current
->lockdep_depth
= 0;
3806 current
->lockdep_recursion
= 0;
3807 memset(current
->held_locks
, 0, MAX_LOCK_DEPTH
*sizeof(struct held_lock
));
3808 nr_hardirq_chains
= 0;
3809 nr_softirq_chains
= 0;
3810 nr_process_chains
= 0;
3812 for (i
= 0; i
< CHAINHASH_SIZE
; i
++)
3813 INIT_LIST_HEAD(chainhash_table
+ i
);
3814 raw_local_irq_restore(flags
);
3817 static void zap_class(struct lock_class
*class)
3822 * Remove all dependencies this lock is
3825 for (i
= 0; i
< nr_list_entries
; i
++) {
3826 if (list_entries
[i
].class == class)
3827 list_del_rcu(&list_entries
[i
].entry
);
3830 * Unhash the class and remove it from the all_lock_classes list:
3832 list_del_rcu(&class->hash_entry
);
3833 list_del_rcu(&class->lock_entry
);
3838 static inline int within(const void *addr
, void *start
, unsigned long size
)
3840 return addr
>= start
&& addr
< start
+ size
;
3843 void lockdep_free_key_range(void *start
, unsigned long size
)
3845 struct lock_class
*class, *next
;
3846 struct list_head
*head
;
3847 unsigned long flags
;
3851 raw_local_irq_save(flags
);
3852 locked
= graph_lock();
3855 * Unhash all classes that were created by this module:
3857 for (i
= 0; i
< CLASSHASH_SIZE
; i
++) {
3858 head
= classhash_table
+ i
;
3859 if (list_empty(head
))
3861 list_for_each_entry_safe(class, next
, head
, hash_entry
) {
3862 if (within(class->key
, start
, size
))
3864 else if (within(class->name
, start
, size
))
3871 raw_local_irq_restore(flags
);
3874 void lockdep_reset_lock(struct lockdep_map
*lock
)
3876 struct lock_class
*class, *next
;
3877 struct list_head
*head
;
3878 unsigned long flags
;
3882 raw_local_irq_save(flags
);
3885 * Remove all classes this lock might have:
3887 for (j
= 0; j
< MAX_LOCKDEP_SUBCLASSES
; j
++) {
3889 * If the class exists we look it up and zap it:
3891 class = look_up_lock_class(lock
, j
);
3896 * Debug check: in the end all mapped classes should
3899 locked
= graph_lock();
3900 for (i
= 0; i
< CLASSHASH_SIZE
; i
++) {
3901 head
= classhash_table
+ i
;
3902 if (list_empty(head
))
3904 list_for_each_entry_safe(class, next
, head
, hash_entry
) {
3907 for (j
= 0; j
< NR_LOCKDEP_CACHING_CLASSES
; j
++)
3908 match
|= class == lock
->class_cache
[j
];
3910 if (unlikely(match
)) {
3911 if (debug_locks_off_graph_unlock()) {
3913 * We all just reset everything, how did it match?
3925 raw_local_irq_restore(flags
);
3928 void lockdep_init(void)
3933 * Some architectures have their own start_kernel()
3934 * code which calls lockdep_init(), while we also
3935 * call lockdep_init() from the start_kernel() itself,
3936 * and we want to initialize the hashes only once:
3938 if (lockdep_initialized
)
3941 for (i
= 0; i
< CLASSHASH_SIZE
; i
++)
3942 INIT_LIST_HEAD(classhash_table
+ i
);
3944 for (i
= 0; i
< CHAINHASH_SIZE
; i
++)
3945 INIT_LIST_HEAD(chainhash_table
+ i
);
3947 lockdep_initialized
= 1;
3950 void __init
lockdep_info(void)
3952 printk("Lock dependency validator: Copyright (c) 2006 Red Hat, Inc., Ingo Molnar\n");
3954 printk("... MAX_LOCKDEP_SUBCLASSES: %lu\n", MAX_LOCKDEP_SUBCLASSES
);
3955 printk("... MAX_LOCK_DEPTH: %lu\n", MAX_LOCK_DEPTH
);
3956 printk("... MAX_LOCKDEP_KEYS: %lu\n", MAX_LOCKDEP_KEYS
);
3957 printk("... CLASSHASH_SIZE: %lu\n", CLASSHASH_SIZE
);
3958 printk("... MAX_LOCKDEP_ENTRIES: %lu\n", MAX_LOCKDEP_ENTRIES
);
3959 printk("... MAX_LOCKDEP_CHAINS: %lu\n", MAX_LOCKDEP_CHAINS
);
3960 printk("... CHAINHASH_SIZE: %lu\n", CHAINHASH_SIZE
);
3962 printk(" memory used by lock dependency info: %lu kB\n",
3963 (sizeof(struct lock_class
) * MAX_LOCKDEP_KEYS
+
3964 sizeof(struct list_head
) * CLASSHASH_SIZE
+
3965 sizeof(struct lock_list
) * MAX_LOCKDEP_ENTRIES
+
3966 sizeof(struct lock_chain
) * MAX_LOCKDEP_CHAINS
+
3967 sizeof(struct list_head
) * CHAINHASH_SIZE
3968 #ifdef CONFIG_PROVE_LOCKING
3969 + sizeof(struct circular_queue
)
3974 printk(" per task-struct memory footprint: %lu bytes\n",
3975 sizeof(struct held_lock
) * MAX_LOCK_DEPTH
);
3977 #ifdef CONFIG_DEBUG_LOCKDEP
3978 if (lockdep_init_error
) {
3979 printk("WARNING: lockdep init error! lock-%s was acquired"
3980 "before lockdep_init\n", lock_init_error
);
3981 printk("Call stack leading to lockdep invocation was:\n");
3982 print_stack_trace(&lockdep_init_trace
, 0);
3988 print_freed_lock_bug(struct task_struct
*curr
, const void *mem_from
,
3989 const void *mem_to
, struct held_lock
*hlock
)
3991 if (!debug_locks_off())
3993 if (debug_locks_silent
)
3997 printk("=========================\n");
3998 printk("[ BUG: held lock freed! ]\n");
3999 print_kernel_ident();
4000 printk("-------------------------\n");
4001 printk("%s/%d is freeing memory %p-%p, with a lock still held there!\n",
4002 curr
->comm
, task_pid_nr(curr
), mem_from
, mem_to
-1);
4004 lockdep_print_held_locks(curr
);
4006 printk("\nstack backtrace:\n");
4010 static inline int not_in_range(const void* mem_from
, unsigned long mem_len
,
4011 const void* lock_from
, unsigned long lock_len
)
4013 return lock_from
+ lock_len
<= mem_from
||
4014 mem_from
+ mem_len
<= lock_from
;
4018 * Called when kernel memory is freed (or unmapped), or if a lock
4019 * is destroyed or reinitialized - this code checks whether there is
4020 * any held lock in the memory range of <from> to <to>:
4022 void debug_check_no_locks_freed(const void *mem_from
, unsigned long mem_len
)
4024 struct task_struct
*curr
= current
;
4025 struct held_lock
*hlock
;
4026 unsigned long flags
;
4029 if (unlikely(!debug_locks
))
4032 local_irq_save(flags
);
4033 for (i
= 0; i
< curr
->lockdep_depth
; i
++) {
4034 hlock
= curr
->held_locks
+ i
;
4036 if (not_in_range(mem_from
, mem_len
, hlock
->instance
,
4037 sizeof(*hlock
->instance
)))
4040 print_freed_lock_bug(curr
, mem_from
, mem_from
+ mem_len
, hlock
);
4043 local_irq_restore(flags
);
4045 EXPORT_SYMBOL_GPL(debug_check_no_locks_freed
);
4047 static void print_held_locks_bug(struct task_struct
*curr
)
4049 if (!debug_locks_off())
4051 if (debug_locks_silent
)
4055 printk("=====================================\n");
4056 printk("[ BUG: lock held at task exit time! ]\n");
4057 print_kernel_ident();
4058 printk("-------------------------------------\n");
4059 printk("%s/%d is exiting with locks still held!\n",
4060 curr
->comm
, task_pid_nr(curr
));
4061 lockdep_print_held_locks(curr
);
4063 printk("\nstack backtrace:\n");
4067 void debug_check_no_locks_held(struct task_struct
*task
)
4069 if (unlikely(task
->lockdep_depth
> 0))
4070 print_held_locks_bug(task
);
4073 void debug_show_all_locks(void)
4075 struct task_struct
*g
, *p
;
4079 if (unlikely(!debug_locks
)) {
4080 printk("INFO: lockdep is turned off.\n");
4083 printk("\nShowing all locks held in the system:\n");
4086 * Here we try to get the tasklist_lock as hard as possible,
4087 * if not successful after 2 seconds we ignore it (but keep
4088 * trying). This is to enable a debug printout even if a
4089 * tasklist_lock-holding task deadlocks or crashes.
4092 if (!read_trylock(&tasklist_lock
)) {
4094 printk("hm, tasklist_lock locked, retrying... ");
4097 printk(" #%d", 10-count
);
4101 printk(" ignoring it.\n");
4105 printk(KERN_CONT
" locked it.\n");
4108 do_each_thread(g
, p
) {
4110 * It's not reliable to print a task's held locks
4111 * if it's not sleeping (or if it's not the current
4114 if (p
->state
== TASK_RUNNING
&& p
!= current
)
4116 if (p
->lockdep_depth
)
4117 lockdep_print_held_locks(p
);
4119 if (read_trylock(&tasklist_lock
))
4121 } while_each_thread(g
, p
);
4124 printk("=============================================\n\n");
4127 read_unlock(&tasklist_lock
);
4129 EXPORT_SYMBOL_GPL(debug_show_all_locks
);
4132 * Careful: only use this function if you are sure that
4133 * the task cannot run in parallel!
4135 void debug_show_held_locks(struct task_struct
*task
)
4137 if (unlikely(!debug_locks
)) {
4138 printk("INFO: lockdep is turned off.\n");
4141 lockdep_print_held_locks(task
);
4143 EXPORT_SYMBOL_GPL(debug_show_held_locks
);
4145 void lockdep_sys_exit(void)
4147 struct task_struct
*curr
= current
;
4149 if (unlikely(curr
->lockdep_depth
)) {
4150 if (!debug_locks_off())
4153 printk("================================================\n");
4154 printk("[ BUG: lock held when returning to user space! ]\n");
4155 print_kernel_ident();
4156 printk("------------------------------------------------\n");
4157 printk("%s/%d is leaving the kernel with locks still held!\n",
4158 curr
->comm
, curr
->pid
);
4159 lockdep_print_held_locks(curr
);
4163 void lockdep_rcu_suspicious(const char *file
, const int line
, const char *s
)
4165 struct task_struct
*curr
= current
;
4167 #ifndef CONFIG_PROVE_RCU_REPEATEDLY
4168 if (!debug_locks_off())
4170 #endif /* #ifdef CONFIG_PROVE_RCU_REPEATEDLY */
4171 /* Note: the following can be executed concurrently, so be careful. */
4173 printk("===============================\n");
4174 printk("[ INFO: suspicious RCU usage. ]\n");
4175 print_kernel_ident();
4176 printk("-------------------------------\n");
4177 printk("%s:%d %s!\n", file
, line
, s
);
4178 printk("\nother info that might help us debug this:\n\n");
4179 printk("\nrcu_scheduler_active = %d, debug_locks = %d\n", rcu_scheduler_active
, debug_locks
);
4182 * If a CPU is in the RCU-free window in idle (ie: in the section
4183 * between rcu_idle_enter() and rcu_idle_exit(), then RCU
4184 * considers that CPU to be in an "extended quiescent state",
4185 * which means that RCU will be completely ignoring that CPU.
4186 * Therefore, rcu_read_lock() and friends have absolutely no
4187 * effect on a CPU running in that state. In other words, even if
4188 * such an RCU-idle CPU has called rcu_read_lock(), RCU might well
4189 * delete data structures out from under it. RCU really has no
4190 * choice here: we need to keep an RCU-free window in idle where
4191 * the CPU may possibly enter into low power mode. This way we can
4192 * notice an extended quiescent state to other CPUs that started a grace
4193 * period. Otherwise we would delay any grace period as long as we run
4196 * So complain bitterly if someone does call rcu_read_lock(),
4197 * rcu_read_lock_bh() and so on from extended quiescent states.
4199 if (rcu_is_cpu_idle())
4200 printk("RCU used illegally from extended quiescent state!\n");
4202 lockdep_print_held_locks(curr
);
4203 printk("\nstack backtrace:\n");
4206 EXPORT_SYMBOL_GPL(lockdep_rcu_suspicious
);