]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blob - kernel/lockdep.c
[PATCH] unwinder: Remove lockdep disabling of nested locks for unwinder
[mirror_ubuntu-bionic-kernel.git] / kernel / lockdep.c
1 /*
2 * kernel/lockdep.c
3 *
4 * Runtime locking correctness validator
5 *
6 * Started by Ingo Molnar:
7 *
8 * Copyright (C) 2006 Red Hat, Inc., Ingo Molnar <mingo@redhat.com>
9 *
10 * this code maps all the lock dependencies as they occur in a live kernel
11 * and will warn about the following classes of locking bugs:
12 *
13 * - lock inversion scenarios
14 * - circular lock dependencies
15 * - hardirq/softirq safe/unsafe locking bugs
16 *
17 * Bugs are reported even if the current locking scenario does not cause
18 * any deadlock at this point.
19 *
20 * I.e. if anytime in the past two locks were taken in a different order,
21 * even if it happened for another task, even if those were different
22 * locks (but of the same class as this lock), this code will detect it.
23 *
24 * Thanks to Arjan van de Ven for coming up with the initial idea of
25 * mapping lock dependencies runtime.
26 */
27 #include <linux/mutex.h>
28 #include <linux/sched.h>
29 #include <linux/delay.h>
30 #include <linux/module.h>
31 #include <linux/proc_fs.h>
32 #include <linux/seq_file.h>
33 #include <linux/spinlock.h>
34 #include <linux/kallsyms.h>
35 #include <linux/interrupt.h>
36 #include <linux/stacktrace.h>
37 #include <linux/debug_locks.h>
38 #include <linux/irqflags.h>
39 #include <linux/utsname.h>
40
41 #include <asm/sections.h>
42
43 #include "lockdep_internals.h"
44
45 /*
46 * hash_lock: protects the lockdep hashes and class/list/hash allocators.
47 *
48 * This is one of the rare exceptions where it's justified
49 * to use a raw spinlock - we really dont want the spinlock
50 * code to recurse back into the lockdep code.
51 */
52 static raw_spinlock_t hash_lock = (raw_spinlock_t)__RAW_SPIN_LOCK_UNLOCKED;
53
54 static int lockdep_initialized;
55
56 unsigned long nr_list_entries;
57 static struct lock_list list_entries[MAX_LOCKDEP_ENTRIES];
58
59 /*
60 * Allocate a lockdep entry. (assumes hash_lock held, returns
61 * with NULL on failure)
62 */
63 static struct lock_list *alloc_list_entry(void)
64 {
65 if (nr_list_entries >= MAX_LOCKDEP_ENTRIES) {
66 __raw_spin_unlock(&hash_lock);
67 debug_locks_off();
68 printk("BUG: MAX_LOCKDEP_ENTRIES too low!\n");
69 printk("turning off the locking correctness validator.\n");
70 return NULL;
71 }
72 return list_entries + nr_list_entries++;
73 }
74
75 /*
76 * All data structures here are protected by the global debug_lock.
77 *
78 * Mutex key structs only get allocated, once during bootup, and never
79 * get freed - this significantly simplifies the debugging code.
80 */
81 unsigned long nr_lock_classes;
82 static struct lock_class lock_classes[MAX_LOCKDEP_KEYS];
83
84 /*
85 * We keep a global list of all lock classes. The list only grows,
86 * never shrinks. The list is only accessed with the lockdep
87 * spinlock lock held.
88 */
89 LIST_HEAD(all_lock_classes);
90
91 /*
92 * The lockdep classes are in a hash-table as well, for fast lookup:
93 */
94 #define CLASSHASH_BITS (MAX_LOCKDEP_KEYS_BITS - 1)
95 #define CLASSHASH_SIZE (1UL << CLASSHASH_BITS)
96 #define CLASSHASH_MASK (CLASSHASH_SIZE - 1)
97 #define __classhashfn(key) ((((unsigned long)key >> CLASSHASH_BITS) + (unsigned long)key) & CLASSHASH_MASK)
98 #define classhashentry(key) (classhash_table + __classhashfn((key)))
99
100 static struct list_head classhash_table[CLASSHASH_SIZE];
101
102 unsigned long nr_lock_chains;
103 static struct lock_chain lock_chains[MAX_LOCKDEP_CHAINS];
104
105 /*
106 * We put the lock dependency chains into a hash-table as well, to cache
107 * their existence:
108 */
109 #define CHAINHASH_BITS (MAX_LOCKDEP_CHAINS_BITS-1)
110 #define CHAINHASH_SIZE (1UL << CHAINHASH_BITS)
111 #define CHAINHASH_MASK (CHAINHASH_SIZE - 1)
112 #define __chainhashfn(chain) \
113 (((chain >> CHAINHASH_BITS) + chain) & CHAINHASH_MASK)
114 #define chainhashentry(chain) (chainhash_table + __chainhashfn((chain)))
115
116 static struct list_head chainhash_table[CHAINHASH_SIZE];
117
118 /*
119 * The hash key of the lock dependency chains is a hash itself too:
120 * it's a hash of all locks taken up to that lock, including that lock.
121 * It's a 64-bit hash, because it's important for the keys to be
122 * unique.
123 */
124 #define iterate_chain_key(key1, key2) \
125 (((key1) << MAX_LOCKDEP_KEYS_BITS) ^ \
126 ((key1) >> (64-MAX_LOCKDEP_KEYS_BITS)) ^ \
127 (key2))
128
129 void lockdep_off(void)
130 {
131 current->lockdep_recursion++;
132 }
133
134 EXPORT_SYMBOL(lockdep_off);
135
136 void lockdep_on(void)
137 {
138 current->lockdep_recursion--;
139 }
140
141 EXPORT_SYMBOL(lockdep_on);
142
143 int lockdep_internal(void)
144 {
145 return current->lockdep_recursion != 0;
146 }
147
148 EXPORT_SYMBOL(lockdep_internal);
149
150 /*
151 * Debugging switches:
152 */
153
154 #define VERBOSE 0
155 #ifdef VERBOSE
156 # define VERY_VERBOSE 0
157 #endif
158
159 #if VERBOSE
160 # define HARDIRQ_VERBOSE 1
161 # define SOFTIRQ_VERBOSE 1
162 #else
163 # define HARDIRQ_VERBOSE 0
164 # define SOFTIRQ_VERBOSE 0
165 #endif
166
167 #if VERBOSE || HARDIRQ_VERBOSE || SOFTIRQ_VERBOSE
168 /*
169 * Quick filtering for interesting events:
170 */
171 static int class_filter(struct lock_class *class)
172 {
173 #if 0
174 /* Example */
175 if (class->name_version == 1 &&
176 !strcmp(class->name, "lockname"))
177 return 1;
178 if (class->name_version == 1 &&
179 !strcmp(class->name, "&struct->lockfield"))
180 return 1;
181 #endif
182 /* Allow everything else. 0 would be filter everything else */
183 return 1;
184 }
185 #endif
186
187 static int verbose(struct lock_class *class)
188 {
189 #if VERBOSE
190 return class_filter(class);
191 #endif
192 return 0;
193 }
194
195 #ifdef CONFIG_TRACE_IRQFLAGS
196
197 static int hardirq_verbose(struct lock_class *class)
198 {
199 #if HARDIRQ_VERBOSE
200 return class_filter(class);
201 #endif
202 return 0;
203 }
204
205 static int softirq_verbose(struct lock_class *class)
206 {
207 #if SOFTIRQ_VERBOSE
208 return class_filter(class);
209 #endif
210 return 0;
211 }
212
213 #endif
214
215 /*
216 * Stack-trace: tightly packed array of stack backtrace
217 * addresses. Protected by the hash_lock.
218 */
219 unsigned long nr_stack_trace_entries;
220 static unsigned long stack_trace[MAX_STACK_TRACE_ENTRIES];
221
222 static int save_trace(struct stack_trace *trace)
223 {
224 trace->nr_entries = 0;
225 trace->max_entries = MAX_STACK_TRACE_ENTRIES - nr_stack_trace_entries;
226 trace->entries = stack_trace + nr_stack_trace_entries;
227
228 trace->skip = 3;
229 trace->all_contexts = 0;
230
231 save_stack_trace(trace, NULL);
232
233 trace->max_entries = trace->nr_entries;
234
235 nr_stack_trace_entries += trace->nr_entries;
236 if (DEBUG_LOCKS_WARN_ON(nr_stack_trace_entries > MAX_STACK_TRACE_ENTRIES))
237 return 0;
238
239 if (nr_stack_trace_entries == MAX_STACK_TRACE_ENTRIES) {
240 __raw_spin_unlock(&hash_lock);
241 if (debug_locks_off()) {
242 printk("BUG: MAX_STACK_TRACE_ENTRIES too low!\n");
243 printk("turning off the locking correctness validator.\n");
244 dump_stack();
245 }
246 return 0;
247 }
248
249 return 1;
250 }
251
252 unsigned int nr_hardirq_chains;
253 unsigned int nr_softirq_chains;
254 unsigned int nr_process_chains;
255 unsigned int max_lockdep_depth;
256 unsigned int max_recursion_depth;
257
258 #ifdef CONFIG_DEBUG_LOCKDEP
259 /*
260 * We cannot printk in early bootup code. Not even early_printk()
261 * might work. So we mark any initialization errors and printk
262 * about it later on, in lockdep_info().
263 */
264 static int lockdep_init_error;
265
266 /*
267 * Various lockdep statistics:
268 */
269 atomic_t chain_lookup_hits;
270 atomic_t chain_lookup_misses;
271 atomic_t hardirqs_on_events;
272 atomic_t hardirqs_off_events;
273 atomic_t redundant_hardirqs_on;
274 atomic_t redundant_hardirqs_off;
275 atomic_t softirqs_on_events;
276 atomic_t softirqs_off_events;
277 atomic_t redundant_softirqs_on;
278 atomic_t redundant_softirqs_off;
279 atomic_t nr_unused_locks;
280 atomic_t nr_cyclic_checks;
281 atomic_t nr_cyclic_check_recursions;
282 atomic_t nr_find_usage_forwards_checks;
283 atomic_t nr_find_usage_forwards_recursions;
284 atomic_t nr_find_usage_backwards_checks;
285 atomic_t nr_find_usage_backwards_recursions;
286 # define debug_atomic_inc(ptr) atomic_inc(ptr)
287 # define debug_atomic_dec(ptr) atomic_dec(ptr)
288 # define debug_atomic_read(ptr) atomic_read(ptr)
289 #else
290 # define debug_atomic_inc(ptr) do { } while (0)
291 # define debug_atomic_dec(ptr) do { } while (0)
292 # define debug_atomic_read(ptr) 0
293 #endif
294
295 /*
296 * Locking printouts:
297 */
298
299 static const char *usage_str[] =
300 {
301 [LOCK_USED] = "initial-use ",
302 [LOCK_USED_IN_HARDIRQ] = "in-hardirq-W",
303 [LOCK_USED_IN_SOFTIRQ] = "in-softirq-W",
304 [LOCK_ENABLED_SOFTIRQS] = "softirq-on-W",
305 [LOCK_ENABLED_HARDIRQS] = "hardirq-on-W",
306 [LOCK_USED_IN_HARDIRQ_READ] = "in-hardirq-R",
307 [LOCK_USED_IN_SOFTIRQ_READ] = "in-softirq-R",
308 [LOCK_ENABLED_SOFTIRQS_READ] = "softirq-on-R",
309 [LOCK_ENABLED_HARDIRQS_READ] = "hardirq-on-R",
310 };
311
312 const char * __get_key_name(struct lockdep_subclass_key *key, char *str)
313 {
314 unsigned long offs, size;
315 char *modname;
316
317 return kallsyms_lookup((unsigned long)key, &size, &offs, &modname, str);
318 }
319
320 void
321 get_usage_chars(struct lock_class *class, char *c1, char *c2, char *c3, char *c4)
322 {
323 *c1 = '.', *c2 = '.', *c3 = '.', *c4 = '.';
324
325 if (class->usage_mask & LOCKF_USED_IN_HARDIRQ)
326 *c1 = '+';
327 else
328 if (class->usage_mask & LOCKF_ENABLED_HARDIRQS)
329 *c1 = '-';
330
331 if (class->usage_mask & LOCKF_USED_IN_SOFTIRQ)
332 *c2 = '+';
333 else
334 if (class->usage_mask & LOCKF_ENABLED_SOFTIRQS)
335 *c2 = '-';
336
337 if (class->usage_mask & LOCKF_ENABLED_HARDIRQS_READ)
338 *c3 = '-';
339 if (class->usage_mask & LOCKF_USED_IN_HARDIRQ_READ) {
340 *c3 = '+';
341 if (class->usage_mask & LOCKF_ENABLED_HARDIRQS_READ)
342 *c3 = '?';
343 }
344
345 if (class->usage_mask & LOCKF_ENABLED_SOFTIRQS_READ)
346 *c4 = '-';
347 if (class->usage_mask & LOCKF_USED_IN_SOFTIRQ_READ) {
348 *c4 = '+';
349 if (class->usage_mask & LOCKF_ENABLED_SOFTIRQS_READ)
350 *c4 = '?';
351 }
352 }
353
354 static void print_lock_name(struct lock_class *class)
355 {
356 char str[128], c1, c2, c3, c4;
357 const char *name;
358
359 get_usage_chars(class, &c1, &c2, &c3, &c4);
360
361 name = class->name;
362 if (!name) {
363 name = __get_key_name(class->key, str);
364 printk(" (%s", name);
365 } else {
366 printk(" (%s", name);
367 if (class->name_version > 1)
368 printk("#%d", class->name_version);
369 if (class->subclass)
370 printk("/%d", class->subclass);
371 }
372 printk("){%c%c%c%c}", c1, c2, c3, c4);
373 }
374
375 static void print_lockdep_cache(struct lockdep_map *lock)
376 {
377 const char *name;
378 char str[128];
379
380 name = lock->name;
381 if (!name)
382 name = __get_key_name(lock->key->subkeys, str);
383
384 printk("%s", name);
385 }
386
387 static void print_lock(struct held_lock *hlock)
388 {
389 print_lock_name(hlock->class);
390 printk(", at: ");
391 print_ip_sym(hlock->acquire_ip);
392 }
393
394 static void lockdep_print_held_locks(struct task_struct *curr)
395 {
396 int i, depth = curr->lockdep_depth;
397
398 if (!depth) {
399 printk("no locks held by %s/%d.\n", curr->comm, curr->pid);
400 return;
401 }
402 printk("%d lock%s held by %s/%d:\n",
403 depth, depth > 1 ? "s" : "", curr->comm, curr->pid);
404
405 for (i = 0; i < depth; i++) {
406 printk(" #%d: ", i);
407 print_lock(curr->held_locks + i);
408 }
409 }
410
411 static void print_lock_class_header(struct lock_class *class, int depth)
412 {
413 int bit;
414
415 printk("%*s->", depth, "");
416 print_lock_name(class);
417 printk(" ops: %lu", class->ops);
418 printk(" {\n");
419
420 for (bit = 0; bit < LOCK_USAGE_STATES; bit++) {
421 if (class->usage_mask & (1 << bit)) {
422 int len = depth;
423
424 len += printk("%*s %s", depth, "", usage_str[bit]);
425 len += printk(" at:\n");
426 print_stack_trace(class->usage_traces + bit, len);
427 }
428 }
429 printk("%*s }\n", depth, "");
430
431 printk("%*s ... key at: ",depth,"");
432 print_ip_sym((unsigned long)class->key);
433 }
434
435 /*
436 * printk all lock dependencies starting at <entry>:
437 */
438 static void print_lock_dependencies(struct lock_class *class, int depth)
439 {
440 struct lock_list *entry;
441
442 if (DEBUG_LOCKS_WARN_ON(depth >= 20))
443 return;
444
445 print_lock_class_header(class, depth);
446
447 list_for_each_entry(entry, &class->locks_after, entry) {
448 DEBUG_LOCKS_WARN_ON(!entry->class);
449 print_lock_dependencies(entry->class, depth + 1);
450
451 printk("%*s ... acquired at:\n",depth,"");
452 print_stack_trace(&entry->trace, 2);
453 printk("\n");
454 }
455 }
456
457 /*
458 * Add a new dependency to the head of the list:
459 */
460 static int add_lock_to_list(struct lock_class *class, struct lock_class *this,
461 struct list_head *head, unsigned long ip)
462 {
463 struct lock_list *entry;
464 /*
465 * Lock not present yet - get a new dependency struct and
466 * add it to the list:
467 */
468 entry = alloc_list_entry();
469 if (!entry)
470 return 0;
471
472 entry->class = this;
473 save_trace(&entry->trace);
474
475 /*
476 * Since we never remove from the dependency list, the list can
477 * be walked lockless by other CPUs, it's only allocation
478 * that must be protected by the spinlock. But this also means
479 * we must make new entries visible only once writes to the
480 * entry become visible - hence the RCU op:
481 */
482 list_add_tail_rcu(&entry->entry, head);
483
484 return 1;
485 }
486
487 /*
488 * Recursive, forwards-direction lock-dependency checking, used for
489 * both noncyclic checking and for hardirq-unsafe/softirq-unsafe
490 * checking.
491 *
492 * (to keep the stackframe of the recursive functions small we
493 * use these global variables, and we also mark various helper
494 * functions as noinline.)
495 */
496 static struct held_lock *check_source, *check_target;
497
498 /*
499 * Print a dependency chain entry (this is only done when a deadlock
500 * has been detected):
501 */
502 static noinline int
503 print_circular_bug_entry(struct lock_list *target, unsigned int depth)
504 {
505 if (debug_locks_silent)
506 return 0;
507 printk("\n-> #%u", depth);
508 print_lock_name(target->class);
509 printk(":\n");
510 print_stack_trace(&target->trace, 6);
511
512 return 0;
513 }
514
515 static void print_kernel_version(void)
516 {
517 printk("%s %.*s\n", init_utsname()->release,
518 (int)strcspn(init_utsname()->version, " "),
519 init_utsname()->version);
520 }
521
522 /*
523 * When a circular dependency is detected, print the
524 * header first:
525 */
526 static noinline int
527 print_circular_bug_header(struct lock_list *entry, unsigned int depth)
528 {
529 struct task_struct *curr = current;
530
531 __raw_spin_unlock(&hash_lock);
532 debug_locks_off();
533 if (debug_locks_silent)
534 return 0;
535
536 printk("\n=======================================================\n");
537 printk( "[ INFO: possible circular locking dependency detected ]\n");
538 print_kernel_version();
539 printk( "-------------------------------------------------------\n");
540 printk("%s/%d is trying to acquire lock:\n",
541 curr->comm, curr->pid);
542 print_lock(check_source);
543 printk("\nbut task is already holding lock:\n");
544 print_lock(check_target);
545 printk("\nwhich lock already depends on the new lock.\n\n");
546 printk("\nthe existing dependency chain (in reverse order) is:\n");
547
548 print_circular_bug_entry(entry, depth);
549
550 return 0;
551 }
552
553 static noinline int print_circular_bug_tail(void)
554 {
555 struct task_struct *curr = current;
556 struct lock_list this;
557
558 if (debug_locks_silent)
559 return 0;
560
561 this.class = check_source->class;
562 save_trace(&this.trace);
563 print_circular_bug_entry(&this, 0);
564
565 printk("\nother info that might help us debug this:\n\n");
566 lockdep_print_held_locks(curr);
567
568 printk("\nstack backtrace:\n");
569 dump_stack();
570
571 return 0;
572 }
573
574 #define RECURSION_LIMIT 40
575
576 static int noinline print_infinite_recursion_bug(void)
577 {
578 __raw_spin_unlock(&hash_lock);
579 DEBUG_LOCKS_WARN_ON(1);
580
581 return 0;
582 }
583
584 /*
585 * Prove that the dependency graph starting at <entry> can not
586 * lead to <target>. Print an error and return 0 if it does.
587 */
588 static noinline int
589 check_noncircular(struct lock_class *source, unsigned int depth)
590 {
591 struct lock_list *entry;
592
593 debug_atomic_inc(&nr_cyclic_check_recursions);
594 if (depth > max_recursion_depth)
595 max_recursion_depth = depth;
596 if (depth >= RECURSION_LIMIT)
597 return print_infinite_recursion_bug();
598 /*
599 * Check this lock's dependency list:
600 */
601 list_for_each_entry(entry, &source->locks_after, entry) {
602 if (entry->class == check_target->class)
603 return print_circular_bug_header(entry, depth+1);
604 debug_atomic_inc(&nr_cyclic_checks);
605 if (!check_noncircular(entry->class, depth+1))
606 return print_circular_bug_entry(entry, depth+1);
607 }
608 return 1;
609 }
610
611 static int very_verbose(struct lock_class *class)
612 {
613 #if VERY_VERBOSE
614 return class_filter(class);
615 #endif
616 return 0;
617 }
618 #ifdef CONFIG_TRACE_IRQFLAGS
619
620 /*
621 * Forwards and backwards subgraph searching, for the purposes of
622 * proving that two subgraphs can be connected by a new dependency
623 * without creating any illegal irq-safe -> irq-unsafe lock dependency.
624 */
625 static enum lock_usage_bit find_usage_bit;
626 static struct lock_class *forwards_match, *backwards_match;
627
628 /*
629 * Find a node in the forwards-direction dependency sub-graph starting
630 * at <source> that matches <find_usage_bit>.
631 *
632 * Return 2 if such a node exists in the subgraph, and put that node
633 * into <forwards_match>.
634 *
635 * Return 1 otherwise and keep <forwards_match> unchanged.
636 * Return 0 on error.
637 */
638 static noinline int
639 find_usage_forwards(struct lock_class *source, unsigned int depth)
640 {
641 struct lock_list *entry;
642 int ret;
643
644 if (depth > max_recursion_depth)
645 max_recursion_depth = depth;
646 if (depth >= RECURSION_LIMIT)
647 return print_infinite_recursion_bug();
648
649 debug_atomic_inc(&nr_find_usage_forwards_checks);
650 if (source->usage_mask & (1 << find_usage_bit)) {
651 forwards_match = source;
652 return 2;
653 }
654
655 /*
656 * Check this lock's dependency list:
657 */
658 list_for_each_entry(entry, &source->locks_after, entry) {
659 debug_atomic_inc(&nr_find_usage_forwards_recursions);
660 ret = find_usage_forwards(entry->class, depth+1);
661 if (ret == 2 || ret == 0)
662 return ret;
663 }
664 return 1;
665 }
666
667 /*
668 * Find a node in the backwards-direction dependency sub-graph starting
669 * at <source> that matches <find_usage_bit>.
670 *
671 * Return 2 if such a node exists in the subgraph, and put that node
672 * into <backwards_match>.
673 *
674 * Return 1 otherwise and keep <backwards_match> unchanged.
675 * Return 0 on error.
676 */
677 static noinline int
678 find_usage_backwards(struct lock_class *source, unsigned int depth)
679 {
680 struct lock_list *entry;
681 int ret;
682
683 if (depth > max_recursion_depth)
684 max_recursion_depth = depth;
685 if (depth >= RECURSION_LIMIT)
686 return print_infinite_recursion_bug();
687
688 debug_atomic_inc(&nr_find_usage_backwards_checks);
689 if (source->usage_mask & (1 << find_usage_bit)) {
690 backwards_match = source;
691 return 2;
692 }
693
694 /*
695 * Check this lock's dependency list:
696 */
697 list_for_each_entry(entry, &source->locks_before, entry) {
698 debug_atomic_inc(&nr_find_usage_backwards_recursions);
699 ret = find_usage_backwards(entry->class, depth+1);
700 if (ret == 2 || ret == 0)
701 return ret;
702 }
703 return 1;
704 }
705
706 static int
707 print_bad_irq_dependency(struct task_struct *curr,
708 struct held_lock *prev,
709 struct held_lock *next,
710 enum lock_usage_bit bit1,
711 enum lock_usage_bit bit2,
712 const char *irqclass)
713 {
714 __raw_spin_unlock(&hash_lock);
715 debug_locks_off();
716 if (debug_locks_silent)
717 return 0;
718
719 printk("\n======================================================\n");
720 printk( "[ INFO: %s-safe -> %s-unsafe lock order detected ]\n",
721 irqclass, irqclass);
722 print_kernel_version();
723 printk( "------------------------------------------------------\n");
724 printk("%s/%d [HC%u[%lu]:SC%u[%lu]:HE%u:SE%u] is trying to acquire:\n",
725 curr->comm, curr->pid,
726 curr->hardirq_context, hardirq_count() >> HARDIRQ_SHIFT,
727 curr->softirq_context, softirq_count() >> SOFTIRQ_SHIFT,
728 curr->hardirqs_enabled,
729 curr->softirqs_enabled);
730 print_lock(next);
731
732 printk("\nand this task is already holding:\n");
733 print_lock(prev);
734 printk("which would create a new lock dependency:\n");
735 print_lock_name(prev->class);
736 printk(" ->");
737 print_lock_name(next->class);
738 printk("\n");
739
740 printk("\nbut this new dependency connects a %s-irq-safe lock:\n",
741 irqclass);
742 print_lock_name(backwards_match);
743 printk("\n... which became %s-irq-safe at:\n", irqclass);
744
745 print_stack_trace(backwards_match->usage_traces + bit1, 1);
746
747 printk("\nto a %s-irq-unsafe lock:\n", irqclass);
748 print_lock_name(forwards_match);
749 printk("\n... which became %s-irq-unsafe at:\n", irqclass);
750 printk("...");
751
752 print_stack_trace(forwards_match->usage_traces + bit2, 1);
753
754 printk("\nother info that might help us debug this:\n\n");
755 lockdep_print_held_locks(curr);
756
757 printk("\nthe %s-irq-safe lock's dependencies:\n", irqclass);
758 print_lock_dependencies(backwards_match, 0);
759
760 printk("\nthe %s-irq-unsafe lock's dependencies:\n", irqclass);
761 print_lock_dependencies(forwards_match, 0);
762
763 printk("\nstack backtrace:\n");
764 dump_stack();
765
766 return 0;
767 }
768
769 static int
770 check_usage(struct task_struct *curr, struct held_lock *prev,
771 struct held_lock *next, enum lock_usage_bit bit_backwards,
772 enum lock_usage_bit bit_forwards, const char *irqclass)
773 {
774 int ret;
775
776 find_usage_bit = bit_backwards;
777 /* fills in <backwards_match> */
778 ret = find_usage_backwards(prev->class, 0);
779 if (!ret || ret == 1)
780 return ret;
781
782 find_usage_bit = bit_forwards;
783 ret = find_usage_forwards(next->class, 0);
784 if (!ret || ret == 1)
785 return ret;
786 /* ret == 2 */
787 return print_bad_irq_dependency(curr, prev, next,
788 bit_backwards, bit_forwards, irqclass);
789 }
790
791 #endif
792
793 static int
794 print_deadlock_bug(struct task_struct *curr, struct held_lock *prev,
795 struct held_lock *next)
796 {
797 debug_locks_off();
798 __raw_spin_unlock(&hash_lock);
799 if (debug_locks_silent)
800 return 0;
801
802 printk("\n=============================================\n");
803 printk( "[ INFO: possible recursive locking detected ]\n");
804 print_kernel_version();
805 printk( "---------------------------------------------\n");
806 printk("%s/%d is trying to acquire lock:\n",
807 curr->comm, curr->pid);
808 print_lock(next);
809 printk("\nbut task is already holding lock:\n");
810 print_lock(prev);
811
812 printk("\nother info that might help us debug this:\n");
813 lockdep_print_held_locks(curr);
814
815 printk("\nstack backtrace:\n");
816 dump_stack();
817
818 return 0;
819 }
820
821 /*
822 * Check whether we are holding such a class already.
823 *
824 * (Note that this has to be done separately, because the graph cannot
825 * detect such classes of deadlocks.)
826 *
827 * Returns: 0 on deadlock detected, 1 on OK, 2 on recursive read
828 */
829 static int
830 check_deadlock(struct task_struct *curr, struct held_lock *next,
831 struct lockdep_map *next_instance, int read)
832 {
833 struct held_lock *prev;
834 int i;
835
836 for (i = 0; i < curr->lockdep_depth; i++) {
837 prev = curr->held_locks + i;
838 if (prev->class != next->class)
839 continue;
840 /*
841 * Allow read-after-read recursion of the same
842 * lock class (i.e. read_lock(lock)+read_lock(lock)):
843 */
844 if ((read == 2) && prev->read)
845 return 2;
846 return print_deadlock_bug(curr, prev, next);
847 }
848 return 1;
849 }
850
851 /*
852 * There was a chain-cache miss, and we are about to add a new dependency
853 * to a previous lock. We recursively validate the following rules:
854 *
855 * - would the adding of the <prev> -> <next> dependency create a
856 * circular dependency in the graph? [== circular deadlock]
857 *
858 * - does the new prev->next dependency connect any hardirq-safe lock
859 * (in the full backwards-subgraph starting at <prev>) with any
860 * hardirq-unsafe lock (in the full forwards-subgraph starting at
861 * <next>)? [== illegal lock inversion with hardirq contexts]
862 *
863 * - does the new prev->next dependency connect any softirq-safe lock
864 * (in the full backwards-subgraph starting at <prev>) with any
865 * softirq-unsafe lock (in the full forwards-subgraph starting at
866 * <next>)? [== illegal lock inversion with softirq contexts]
867 *
868 * any of these scenarios could lead to a deadlock.
869 *
870 * Then if all the validations pass, we add the forwards and backwards
871 * dependency.
872 */
873 static int
874 check_prev_add(struct task_struct *curr, struct held_lock *prev,
875 struct held_lock *next)
876 {
877 struct lock_list *entry;
878 int ret;
879
880 /*
881 * Prove that the new <prev> -> <next> dependency would not
882 * create a circular dependency in the graph. (We do this by
883 * forward-recursing into the graph starting at <next>, and
884 * checking whether we can reach <prev>.)
885 *
886 * We are using global variables to control the recursion, to
887 * keep the stackframe size of the recursive functions low:
888 */
889 check_source = next;
890 check_target = prev;
891 if (!(check_noncircular(next->class, 0)))
892 return print_circular_bug_tail();
893
894 #ifdef CONFIG_TRACE_IRQFLAGS
895 /*
896 * Prove that the new dependency does not connect a hardirq-safe
897 * lock with a hardirq-unsafe lock - to achieve this we search
898 * the backwards-subgraph starting at <prev>, and the
899 * forwards-subgraph starting at <next>:
900 */
901 if (!check_usage(curr, prev, next, LOCK_USED_IN_HARDIRQ,
902 LOCK_ENABLED_HARDIRQS, "hard"))
903 return 0;
904
905 /*
906 * Prove that the new dependency does not connect a hardirq-safe-read
907 * lock with a hardirq-unsafe lock - to achieve this we search
908 * the backwards-subgraph starting at <prev>, and the
909 * forwards-subgraph starting at <next>:
910 */
911 if (!check_usage(curr, prev, next, LOCK_USED_IN_HARDIRQ_READ,
912 LOCK_ENABLED_HARDIRQS, "hard-read"))
913 return 0;
914
915 /*
916 * Prove that the new dependency does not connect a softirq-safe
917 * lock with a softirq-unsafe lock - to achieve this we search
918 * the backwards-subgraph starting at <prev>, and the
919 * forwards-subgraph starting at <next>:
920 */
921 if (!check_usage(curr, prev, next, LOCK_USED_IN_SOFTIRQ,
922 LOCK_ENABLED_SOFTIRQS, "soft"))
923 return 0;
924 /*
925 * Prove that the new dependency does not connect a softirq-safe-read
926 * lock with a softirq-unsafe lock - to achieve this we search
927 * the backwards-subgraph starting at <prev>, and the
928 * forwards-subgraph starting at <next>:
929 */
930 if (!check_usage(curr, prev, next, LOCK_USED_IN_SOFTIRQ_READ,
931 LOCK_ENABLED_SOFTIRQS, "soft"))
932 return 0;
933 #endif
934 /*
935 * For recursive read-locks we do all the dependency checks,
936 * but we dont store read-triggered dependencies (only
937 * write-triggered dependencies). This ensures that only the
938 * write-side dependencies matter, and that if for example a
939 * write-lock never takes any other locks, then the reads are
940 * equivalent to a NOP.
941 */
942 if (next->read == 2 || prev->read == 2)
943 return 1;
944 /*
945 * Is the <prev> -> <next> dependency already present?
946 *
947 * (this may occur even though this is a new chain: consider
948 * e.g. the L1 -> L2 -> L3 -> L4 and the L5 -> L1 -> L2 -> L3
949 * chains - the second one will be new, but L1 already has
950 * L2 added to its dependency list, due to the first chain.)
951 */
952 list_for_each_entry(entry, &prev->class->locks_after, entry) {
953 if (entry->class == next->class)
954 return 2;
955 }
956
957 /*
958 * Ok, all validations passed, add the new lock
959 * to the previous lock's dependency list:
960 */
961 ret = add_lock_to_list(prev->class, next->class,
962 &prev->class->locks_after, next->acquire_ip);
963 if (!ret)
964 return 0;
965 /*
966 * Return value of 2 signals 'dependency already added',
967 * in that case we dont have to add the backlink either.
968 */
969 if (ret == 2)
970 return 2;
971 ret = add_lock_to_list(next->class, prev->class,
972 &next->class->locks_before, next->acquire_ip);
973
974 /*
975 * Debugging printouts:
976 */
977 if (verbose(prev->class) || verbose(next->class)) {
978 __raw_spin_unlock(&hash_lock);
979 printk("\n new dependency: ");
980 print_lock_name(prev->class);
981 printk(" => ");
982 print_lock_name(next->class);
983 printk("\n");
984 dump_stack();
985 __raw_spin_lock(&hash_lock);
986 }
987 return 1;
988 }
989
990 /*
991 * Add the dependency to all directly-previous locks that are 'relevant'.
992 * The ones that are relevant are (in increasing distance from curr):
993 * all consecutive trylock entries and the final non-trylock entry - or
994 * the end of this context's lock-chain - whichever comes first.
995 */
996 static int
997 check_prevs_add(struct task_struct *curr, struct held_lock *next)
998 {
999 int depth = curr->lockdep_depth;
1000 struct held_lock *hlock;
1001
1002 /*
1003 * Debugging checks.
1004 *
1005 * Depth must not be zero for a non-head lock:
1006 */
1007 if (!depth)
1008 goto out_bug;
1009 /*
1010 * At least two relevant locks must exist for this
1011 * to be a head:
1012 */
1013 if (curr->held_locks[depth].irq_context !=
1014 curr->held_locks[depth-1].irq_context)
1015 goto out_bug;
1016
1017 for (;;) {
1018 hlock = curr->held_locks + depth-1;
1019 /*
1020 * Only non-recursive-read entries get new dependencies
1021 * added:
1022 */
1023 if (hlock->read != 2) {
1024 check_prev_add(curr, hlock, next);
1025 /*
1026 * Stop after the first non-trylock entry,
1027 * as non-trylock entries have added their
1028 * own direct dependencies already, so this
1029 * lock is connected to them indirectly:
1030 */
1031 if (!hlock->trylock)
1032 break;
1033 }
1034 depth--;
1035 /*
1036 * End of lock-stack?
1037 */
1038 if (!depth)
1039 break;
1040 /*
1041 * Stop the search if we cross into another context:
1042 */
1043 if (curr->held_locks[depth].irq_context !=
1044 curr->held_locks[depth-1].irq_context)
1045 break;
1046 }
1047 return 1;
1048 out_bug:
1049 __raw_spin_unlock(&hash_lock);
1050 DEBUG_LOCKS_WARN_ON(1);
1051
1052 return 0;
1053 }
1054
1055
1056 /*
1057 * Is this the address of a static object:
1058 */
1059 static int static_obj(void *obj)
1060 {
1061 unsigned long start = (unsigned long) &_stext,
1062 end = (unsigned long) &_end,
1063 addr = (unsigned long) obj;
1064 #ifdef CONFIG_SMP
1065 int i;
1066 #endif
1067
1068 /*
1069 * static variable?
1070 */
1071 if ((addr >= start) && (addr < end))
1072 return 1;
1073
1074 #ifdef CONFIG_SMP
1075 /*
1076 * percpu var?
1077 */
1078 for_each_possible_cpu(i) {
1079 start = (unsigned long) &__per_cpu_start + per_cpu_offset(i);
1080 end = (unsigned long) &__per_cpu_start + PERCPU_ENOUGH_ROOM
1081 + per_cpu_offset(i);
1082
1083 if ((addr >= start) && (addr < end))
1084 return 1;
1085 }
1086 #endif
1087
1088 /*
1089 * module var?
1090 */
1091 return is_module_address(addr);
1092 }
1093
1094 /*
1095 * To make lock name printouts unique, we calculate a unique
1096 * class->name_version generation counter:
1097 */
1098 static int count_matching_names(struct lock_class *new_class)
1099 {
1100 struct lock_class *class;
1101 int count = 0;
1102
1103 if (!new_class->name)
1104 return 0;
1105
1106 list_for_each_entry(class, &all_lock_classes, lock_entry) {
1107 if (new_class->key - new_class->subclass == class->key)
1108 return class->name_version;
1109 if (class->name && !strcmp(class->name, new_class->name))
1110 count = max(count, class->name_version);
1111 }
1112
1113 return count + 1;
1114 }
1115
1116 /*
1117 * Register a lock's class in the hash-table, if the class is not present
1118 * yet. Otherwise we look it up. We cache the result in the lock object
1119 * itself, so actual lookup of the hash should be once per lock object.
1120 */
1121 static inline struct lock_class *
1122 look_up_lock_class(struct lockdep_map *lock, unsigned int subclass)
1123 {
1124 struct lockdep_subclass_key *key;
1125 struct list_head *hash_head;
1126 struct lock_class *class;
1127
1128 #ifdef CONFIG_DEBUG_LOCKDEP
1129 /*
1130 * If the architecture calls into lockdep before initializing
1131 * the hashes then we'll warn about it later. (we cannot printk
1132 * right now)
1133 */
1134 if (unlikely(!lockdep_initialized)) {
1135 lockdep_init();
1136 lockdep_init_error = 1;
1137 }
1138 #endif
1139
1140 /*
1141 * Static locks do not have their class-keys yet - for them the key
1142 * is the lock object itself:
1143 */
1144 if (unlikely(!lock->key))
1145 lock->key = (void *)lock;
1146
1147 /*
1148 * NOTE: the class-key must be unique. For dynamic locks, a static
1149 * lock_class_key variable is passed in through the mutex_init()
1150 * (or spin_lock_init()) call - which acts as the key. For static
1151 * locks we use the lock object itself as the key.
1152 */
1153 BUILD_BUG_ON(sizeof(struct lock_class_key) > sizeof(struct lock_class));
1154
1155 key = lock->key->subkeys + subclass;
1156
1157 hash_head = classhashentry(key);
1158
1159 /*
1160 * We can walk the hash lockfree, because the hash only
1161 * grows, and we are careful when adding entries to the end:
1162 */
1163 list_for_each_entry(class, hash_head, hash_entry)
1164 if (class->key == key)
1165 return class;
1166
1167 return NULL;
1168 }
1169
1170 /*
1171 * Register a lock's class in the hash-table, if the class is not present
1172 * yet. Otherwise we look it up. We cache the result in the lock object
1173 * itself, so actual lookup of the hash should be once per lock object.
1174 */
1175 static inline struct lock_class *
1176 register_lock_class(struct lockdep_map *lock, unsigned int subclass, int force)
1177 {
1178 struct lockdep_subclass_key *key;
1179 struct list_head *hash_head;
1180 struct lock_class *class;
1181
1182 class = look_up_lock_class(lock, subclass);
1183 if (likely(class))
1184 return class;
1185
1186 /*
1187 * Debug-check: all keys must be persistent!
1188 */
1189 if (!static_obj(lock->key)) {
1190 debug_locks_off();
1191 printk("INFO: trying to register non-static key.\n");
1192 printk("the code is fine but needs lockdep annotation.\n");
1193 printk("turning off the locking correctness validator.\n");
1194 dump_stack();
1195
1196 return NULL;
1197 }
1198
1199 key = lock->key->subkeys + subclass;
1200 hash_head = classhashentry(key);
1201
1202 __raw_spin_lock(&hash_lock);
1203 /*
1204 * We have to do the hash-walk again, to avoid races
1205 * with another CPU:
1206 */
1207 list_for_each_entry(class, hash_head, hash_entry)
1208 if (class->key == key)
1209 goto out_unlock_set;
1210 /*
1211 * Allocate a new key from the static array, and add it to
1212 * the hash:
1213 */
1214 if (nr_lock_classes >= MAX_LOCKDEP_KEYS) {
1215 __raw_spin_unlock(&hash_lock);
1216 debug_locks_off();
1217 printk("BUG: MAX_LOCKDEP_KEYS too low!\n");
1218 printk("turning off the locking correctness validator.\n");
1219 return NULL;
1220 }
1221 class = lock_classes + nr_lock_classes++;
1222 debug_atomic_inc(&nr_unused_locks);
1223 class->key = key;
1224 class->name = lock->name;
1225 class->subclass = subclass;
1226 INIT_LIST_HEAD(&class->lock_entry);
1227 INIT_LIST_HEAD(&class->locks_before);
1228 INIT_LIST_HEAD(&class->locks_after);
1229 class->name_version = count_matching_names(class);
1230 /*
1231 * We use RCU's safe list-add method to make
1232 * parallel walking of the hash-list safe:
1233 */
1234 list_add_tail_rcu(&class->hash_entry, hash_head);
1235
1236 if (verbose(class)) {
1237 __raw_spin_unlock(&hash_lock);
1238 printk("\nnew class %p: %s", class->key, class->name);
1239 if (class->name_version > 1)
1240 printk("#%d", class->name_version);
1241 printk("\n");
1242 dump_stack();
1243 __raw_spin_lock(&hash_lock);
1244 }
1245 out_unlock_set:
1246 __raw_spin_unlock(&hash_lock);
1247
1248 if (!subclass || force)
1249 lock->class_cache = class;
1250
1251 DEBUG_LOCKS_WARN_ON(class->subclass != subclass);
1252
1253 return class;
1254 }
1255
1256 /*
1257 * Look up a dependency chain. If the key is not present yet then
1258 * add it and return 0 - in this case the new dependency chain is
1259 * validated. If the key is already hashed, return 1.
1260 */
1261 static inline int lookup_chain_cache(u64 chain_key)
1262 {
1263 struct list_head *hash_head = chainhashentry(chain_key);
1264 struct lock_chain *chain;
1265
1266 DEBUG_LOCKS_WARN_ON(!irqs_disabled());
1267 /*
1268 * We can walk it lock-free, because entries only get added
1269 * to the hash:
1270 */
1271 list_for_each_entry(chain, hash_head, entry) {
1272 if (chain->chain_key == chain_key) {
1273 cache_hit:
1274 debug_atomic_inc(&chain_lookup_hits);
1275 /*
1276 * In the debugging case, force redundant checking
1277 * by returning 1:
1278 */
1279 #ifdef CONFIG_DEBUG_LOCKDEP
1280 __raw_spin_lock(&hash_lock);
1281 return 1;
1282 #endif
1283 return 0;
1284 }
1285 }
1286 /*
1287 * Allocate a new chain entry from the static array, and add
1288 * it to the hash:
1289 */
1290 __raw_spin_lock(&hash_lock);
1291 /*
1292 * We have to walk the chain again locked - to avoid duplicates:
1293 */
1294 list_for_each_entry(chain, hash_head, entry) {
1295 if (chain->chain_key == chain_key) {
1296 __raw_spin_unlock(&hash_lock);
1297 goto cache_hit;
1298 }
1299 }
1300 if (unlikely(nr_lock_chains >= MAX_LOCKDEP_CHAINS)) {
1301 __raw_spin_unlock(&hash_lock);
1302 debug_locks_off();
1303 printk("BUG: MAX_LOCKDEP_CHAINS too low!\n");
1304 printk("turning off the locking correctness validator.\n");
1305 return 0;
1306 }
1307 chain = lock_chains + nr_lock_chains++;
1308 chain->chain_key = chain_key;
1309 list_add_tail_rcu(&chain->entry, hash_head);
1310 debug_atomic_inc(&chain_lookup_misses);
1311 #ifdef CONFIG_TRACE_IRQFLAGS
1312 if (current->hardirq_context)
1313 nr_hardirq_chains++;
1314 else {
1315 if (current->softirq_context)
1316 nr_softirq_chains++;
1317 else
1318 nr_process_chains++;
1319 }
1320 #else
1321 nr_process_chains++;
1322 #endif
1323
1324 return 1;
1325 }
1326
1327 /*
1328 * We are building curr_chain_key incrementally, so double-check
1329 * it from scratch, to make sure that it's done correctly:
1330 */
1331 static void check_chain_key(struct task_struct *curr)
1332 {
1333 #ifdef CONFIG_DEBUG_LOCKDEP
1334 struct held_lock *hlock, *prev_hlock = NULL;
1335 unsigned int i, id;
1336 u64 chain_key = 0;
1337
1338 for (i = 0; i < curr->lockdep_depth; i++) {
1339 hlock = curr->held_locks + i;
1340 if (chain_key != hlock->prev_chain_key) {
1341 debug_locks_off();
1342 printk("hm#1, depth: %u [%u], %016Lx != %016Lx\n",
1343 curr->lockdep_depth, i,
1344 (unsigned long long)chain_key,
1345 (unsigned long long)hlock->prev_chain_key);
1346 WARN_ON(1);
1347 return;
1348 }
1349 id = hlock->class - lock_classes;
1350 DEBUG_LOCKS_WARN_ON(id >= MAX_LOCKDEP_KEYS);
1351 if (prev_hlock && (prev_hlock->irq_context !=
1352 hlock->irq_context))
1353 chain_key = 0;
1354 chain_key = iterate_chain_key(chain_key, id);
1355 prev_hlock = hlock;
1356 }
1357 if (chain_key != curr->curr_chain_key) {
1358 debug_locks_off();
1359 printk("hm#2, depth: %u [%u], %016Lx != %016Lx\n",
1360 curr->lockdep_depth, i,
1361 (unsigned long long)chain_key,
1362 (unsigned long long)curr->curr_chain_key);
1363 WARN_ON(1);
1364 }
1365 #endif
1366 }
1367
1368 #ifdef CONFIG_TRACE_IRQFLAGS
1369
1370 /*
1371 * print irq inversion bug:
1372 */
1373 static int
1374 print_irq_inversion_bug(struct task_struct *curr, struct lock_class *other,
1375 struct held_lock *this, int forwards,
1376 const char *irqclass)
1377 {
1378 __raw_spin_unlock(&hash_lock);
1379 debug_locks_off();
1380 if (debug_locks_silent)
1381 return 0;
1382
1383 printk("\n=========================================================\n");
1384 printk( "[ INFO: possible irq lock inversion dependency detected ]\n");
1385 print_kernel_version();
1386 printk( "---------------------------------------------------------\n");
1387 printk("%s/%d just changed the state of lock:\n",
1388 curr->comm, curr->pid);
1389 print_lock(this);
1390 if (forwards)
1391 printk("but this lock took another, %s-irq-unsafe lock in the past:\n", irqclass);
1392 else
1393 printk("but this lock was taken by another, %s-irq-safe lock in the past:\n", irqclass);
1394 print_lock_name(other);
1395 printk("\n\nand interrupts could create inverse lock ordering between them.\n\n");
1396
1397 printk("\nother info that might help us debug this:\n");
1398 lockdep_print_held_locks(curr);
1399
1400 printk("\nthe first lock's dependencies:\n");
1401 print_lock_dependencies(this->class, 0);
1402
1403 printk("\nthe second lock's dependencies:\n");
1404 print_lock_dependencies(other, 0);
1405
1406 printk("\nstack backtrace:\n");
1407 dump_stack();
1408
1409 return 0;
1410 }
1411
1412 /*
1413 * Prove that in the forwards-direction subgraph starting at <this>
1414 * there is no lock matching <mask>:
1415 */
1416 static int
1417 check_usage_forwards(struct task_struct *curr, struct held_lock *this,
1418 enum lock_usage_bit bit, const char *irqclass)
1419 {
1420 int ret;
1421
1422 find_usage_bit = bit;
1423 /* fills in <forwards_match> */
1424 ret = find_usage_forwards(this->class, 0);
1425 if (!ret || ret == 1)
1426 return ret;
1427
1428 return print_irq_inversion_bug(curr, forwards_match, this, 1, irqclass);
1429 }
1430
1431 /*
1432 * Prove that in the backwards-direction subgraph starting at <this>
1433 * there is no lock matching <mask>:
1434 */
1435 static int
1436 check_usage_backwards(struct task_struct *curr, struct held_lock *this,
1437 enum lock_usage_bit bit, const char *irqclass)
1438 {
1439 int ret;
1440
1441 find_usage_bit = bit;
1442 /* fills in <backwards_match> */
1443 ret = find_usage_backwards(this->class, 0);
1444 if (!ret || ret == 1)
1445 return ret;
1446
1447 return print_irq_inversion_bug(curr, backwards_match, this, 0, irqclass);
1448 }
1449
1450 static inline void print_irqtrace_events(struct task_struct *curr)
1451 {
1452 printk("irq event stamp: %u\n", curr->irq_events);
1453 printk("hardirqs last enabled at (%u): ", curr->hardirq_enable_event);
1454 print_ip_sym(curr->hardirq_enable_ip);
1455 printk("hardirqs last disabled at (%u): ", curr->hardirq_disable_event);
1456 print_ip_sym(curr->hardirq_disable_ip);
1457 printk("softirqs last enabled at (%u): ", curr->softirq_enable_event);
1458 print_ip_sym(curr->softirq_enable_ip);
1459 printk("softirqs last disabled at (%u): ", curr->softirq_disable_event);
1460 print_ip_sym(curr->softirq_disable_ip);
1461 }
1462
1463 #else
1464 static inline void print_irqtrace_events(struct task_struct *curr)
1465 {
1466 }
1467 #endif
1468
1469 static int
1470 print_usage_bug(struct task_struct *curr, struct held_lock *this,
1471 enum lock_usage_bit prev_bit, enum lock_usage_bit new_bit)
1472 {
1473 __raw_spin_unlock(&hash_lock);
1474 debug_locks_off();
1475 if (debug_locks_silent)
1476 return 0;
1477
1478 printk("\n=================================\n");
1479 printk( "[ INFO: inconsistent lock state ]\n");
1480 print_kernel_version();
1481 printk( "---------------------------------\n");
1482
1483 printk("inconsistent {%s} -> {%s} usage.\n",
1484 usage_str[prev_bit], usage_str[new_bit]);
1485
1486 printk("%s/%d [HC%u[%lu]:SC%u[%lu]:HE%u:SE%u] takes:\n",
1487 curr->comm, curr->pid,
1488 trace_hardirq_context(curr), hardirq_count() >> HARDIRQ_SHIFT,
1489 trace_softirq_context(curr), softirq_count() >> SOFTIRQ_SHIFT,
1490 trace_hardirqs_enabled(curr),
1491 trace_softirqs_enabled(curr));
1492 print_lock(this);
1493
1494 printk("{%s} state was registered at:\n", usage_str[prev_bit]);
1495 print_stack_trace(this->class->usage_traces + prev_bit, 1);
1496
1497 print_irqtrace_events(curr);
1498 printk("\nother info that might help us debug this:\n");
1499 lockdep_print_held_locks(curr);
1500
1501 printk("\nstack backtrace:\n");
1502 dump_stack();
1503
1504 return 0;
1505 }
1506
1507 /*
1508 * Print out an error if an invalid bit is set:
1509 */
1510 static inline int
1511 valid_state(struct task_struct *curr, struct held_lock *this,
1512 enum lock_usage_bit new_bit, enum lock_usage_bit bad_bit)
1513 {
1514 if (unlikely(this->class->usage_mask & (1 << bad_bit)))
1515 return print_usage_bug(curr, this, bad_bit, new_bit);
1516 return 1;
1517 }
1518
1519 #define STRICT_READ_CHECKS 1
1520
1521 /*
1522 * Mark a lock with a usage bit, and validate the state transition:
1523 */
1524 static int mark_lock(struct task_struct *curr, struct held_lock *this,
1525 enum lock_usage_bit new_bit, unsigned long ip)
1526 {
1527 unsigned int new_mask = 1 << new_bit, ret = 1;
1528
1529 /*
1530 * If already set then do not dirty the cacheline,
1531 * nor do any checks:
1532 */
1533 if (likely(this->class->usage_mask & new_mask))
1534 return 1;
1535
1536 __raw_spin_lock(&hash_lock);
1537 /*
1538 * Make sure we didnt race:
1539 */
1540 if (unlikely(this->class->usage_mask & new_mask)) {
1541 __raw_spin_unlock(&hash_lock);
1542 return 1;
1543 }
1544
1545 this->class->usage_mask |= new_mask;
1546
1547 #ifdef CONFIG_TRACE_IRQFLAGS
1548 if (new_bit == LOCK_ENABLED_HARDIRQS ||
1549 new_bit == LOCK_ENABLED_HARDIRQS_READ)
1550 ip = curr->hardirq_enable_ip;
1551 else if (new_bit == LOCK_ENABLED_SOFTIRQS ||
1552 new_bit == LOCK_ENABLED_SOFTIRQS_READ)
1553 ip = curr->softirq_enable_ip;
1554 #endif
1555 if (!save_trace(this->class->usage_traces + new_bit))
1556 return 0;
1557
1558 switch (new_bit) {
1559 #ifdef CONFIG_TRACE_IRQFLAGS
1560 case LOCK_USED_IN_HARDIRQ:
1561 if (!valid_state(curr, this, new_bit, LOCK_ENABLED_HARDIRQS))
1562 return 0;
1563 if (!valid_state(curr, this, new_bit,
1564 LOCK_ENABLED_HARDIRQS_READ))
1565 return 0;
1566 /*
1567 * just marked it hardirq-safe, check that this lock
1568 * took no hardirq-unsafe lock in the past:
1569 */
1570 if (!check_usage_forwards(curr, this,
1571 LOCK_ENABLED_HARDIRQS, "hard"))
1572 return 0;
1573 #if STRICT_READ_CHECKS
1574 /*
1575 * just marked it hardirq-safe, check that this lock
1576 * took no hardirq-unsafe-read lock in the past:
1577 */
1578 if (!check_usage_forwards(curr, this,
1579 LOCK_ENABLED_HARDIRQS_READ, "hard-read"))
1580 return 0;
1581 #endif
1582 if (hardirq_verbose(this->class))
1583 ret = 2;
1584 break;
1585 case LOCK_USED_IN_SOFTIRQ:
1586 if (!valid_state(curr, this, new_bit, LOCK_ENABLED_SOFTIRQS))
1587 return 0;
1588 if (!valid_state(curr, this, new_bit,
1589 LOCK_ENABLED_SOFTIRQS_READ))
1590 return 0;
1591 /*
1592 * just marked it softirq-safe, check that this lock
1593 * took no softirq-unsafe lock in the past:
1594 */
1595 if (!check_usage_forwards(curr, this,
1596 LOCK_ENABLED_SOFTIRQS, "soft"))
1597 return 0;
1598 #if STRICT_READ_CHECKS
1599 /*
1600 * just marked it softirq-safe, check that this lock
1601 * took no softirq-unsafe-read lock in the past:
1602 */
1603 if (!check_usage_forwards(curr, this,
1604 LOCK_ENABLED_SOFTIRQS_READ, "soft-read"))
1605 return 0;
1606 #endif
1607 if (softirq_verbose(this->class))
1608 ret = 2;
1609 break;
1610 case LOCK_USED_IN_HARDIRQ_READ:
1611 if (!valid_state(curr, this, new_bit, LOCK_ENABLED_HARDIRQS))
1612 return 0;
1613 /*
1614 * just marked it hardirq-read-safe, check that this lock
1615 * took no hardirq-unsafe lock in the past:
1616 */
1617 if (!check_usage_forwards(curr, this,
1618 LOCK_ENABLED_HARDIRQS, "hard"))
1619 return 0;
1620 if (hardirq_verbose(this->class))
1621 ret = 2;
1622 break;
1623 case LOCK_USED_IN_SOFTIRQ_READ:
1624 if (!valid_state(curr, this, new_bit, LOCK_ENABLED_SOFTIRQS))
1625 return 0;
1626 /*
1627 * just marked it softirq-read-safe, check that this lock
1628 * took no softirq-unsafe lock in the past:
1629 */
1630 if (!check_usage_forwards(curr, this,
1631 LOCK_ENABLED_SOFTIRQS, "soft"))
1632 return 0;
1633 if (softirq_verbose(this->class))
1634 ret = 2;
1635 break;
1636 case LOCK_ENABLED_HARDIRQS:
1637 if (!valid_state(curr, this, new_bit, LOCK_USED_IN_HARDIRQ))
1638 return 0;
1639 if (!valid_state(curr, this, new_bit,
1640 LOCK_USED_IN_HARDIRQ_READ))
1641 return 0;
1642 /*
1643 * just marked it hardirq-unsafe, check that no hardirq-safe
1644 * lock in the system ever took it in the past:
1645 */
1646 if (!check_usage_backwards(curr, this,
1647 LOCK_USED_IN_HARDIRQ, "hard"))
1648 return 0;
1649 #if STRICT_READ_CHECKS
1650 /*
1651 * just marked it hardirq-unsafe, check that no
1652 * hardirq-safe-read lock in the system ever took
1653 * it in the past:
1654 */
1655 if (!check_usage_backwards(curr, this,
1656 LOCK_USED_IN_HARDIRQ_READ, "hard-read"))
1657 return 0;
1658 #endif
1659 if (hardirq_verbose(this->class))
1660 ret = 2;
1661 break;
1662 case LOCK_ENABLED_SOFTIRQS:
1663 if (!valid_state(curr, this, new_bit, LOCK_USED_IN_SOFTIRQ))
1664 return 0;
1665 if (!valid_state(curr, this, new_bit,
1666 LOCK_USED_IN_SOFTIRQ_READ))
1667 return 0;
1668 /*
1669 * just marked it softirq-unsafe, check that no softirq-safe
1670 * lock in the system ever took it in the past:
1671 */
1672 if (!check_usage_backwards(curr, this,
1673 LOCK_USED_IN_SOFTIRQ, "soft"))
1674 return 0;
1675 #if STRICT_READ_CHECKS
1676 /*
1677 * just marked it softirq-unsafe, check that no
1678 * softirq-safe-read lock in the system ever took
1679 * it in the past:
1680 */
1681 if (!check_usage_backwards(curr, this,
1682 LOCK_USED_IN_SOFTIRQ_READ, "soft-read"))
1683 return 0;
1684 #endif
1685 if (softirq_verbose(this->class))
1686 ret = 2;
1687 break;
1688 case LOCK_ENABLED_HARDIRQS_READ:
1689 if (!valid_state(curr, this, new_bit, LOCK_USED_IN_HARDIRQ))
1690 return 0;
1691 #if STRICT_READ_CHECKS
1692 /*
1693 * just marked it hardirq-read-unsafe, check that no
1694 * hardirq-safe lock in the system ever took it in the past:
1695 */
1696 if (!check_usage_backwards(curr, this,
1697 LOCK_USED_IN_HARDIRQ, "hard"))
1698 return 0;
1699 #endif
1700 if (hardirq_verbose(this->class))
1701 ret = 2;
1702 break;
1703 case LOCK_ENABLED_SOFTIRQS_READ:
1704 if (!valid_state(curr, this, new_bit, LOCK_USED_IN_SOFTIRQ))
1705 return 0;
1706 #if STRICT_READ_CHECKS
1707 /*
1708 * just marked it softirq-read-unsafe, check that no
1709 * softirq-safe lock in the system ever took it in the past:
1710 */
1711 if (!check_usage_backwards(curr, this,
1712 LOCK_USED_IN_SOFTIRQ, "soft"))
1713 return 0;
1714 #endif
1715 if (softirq_verbose(this->class))
1716 ret = 2;
1717 break;
1718 #endif
1719 case LOCK_USED:
1720 /*
1721 * Add it to the global list of classes:
1722 */
1723 list_add_tail_rcu(&this->class->lock_entry, &all_lock_classes);
1724 debug_atomic_dec(&nr_unused_locks);
1725 break;
1726 default:
1727 debug_locks_off();
1728 WARN_ON(1);
1729 return 0;
1730 }
1731
1732 __raw_spin_unlock(&hash_lock);
1733
1734 /*
1735 * We must printk outside of the hash_lock:
1736 */
1737 if (ret == 2) {
1738 printk("\nmarked lock as {%s}:\n", usage_str[new_bit]);
1739 print_lock(this);
1740 print_irqtrace_events(curr);
1741 dump_stack();
1742 }
1743
1744 return ret;
1745 }
1746
1747 #ifdef CONFIG_TRACE_IRQFLAGS
1748 /*
1749 * Mark all held locks with a usage bit:
1750 */
1751 static int
1752 mark_held_locks(struct task_struct *curr, int hardirq, unsigned long ip)
1753 {
1754 enum lock_usage_bit usage_bit;
1755 struct held_lock *hlock;
1756 int i;
1757
1758 for (i = 0; i < curr->lockdep_depth; i++) {
1759 hlock = curr->held_locks + i;
1760
1761 if (hardirq) {
1762 if (hlock->read)
1763 usage_bit = LOCK_ENABLED_HARDIRQS_READ;
1764 else
1765 usage_bit = LOCK_ENABLED_HARDIRQS;
1766 } else {
1767 if (hlock->read)
1768 usage_bit = LOCK_ENABLED_SOFTIRQS_READ;
1769 else
1770 usage_bit = LOCK_ENABLED_SOFTIRQS;
1771 }
1772 if (!mark_lock(curr, hlock, usage_bit, ip))
1773 return 0;
1774 }
1775
1776 return 1;
1777 }
1778
1779 /*
1780 * Debugging helper: via this flag we know that we are in
1781 * 'early bootup code', and will warn about any invalid irqs-on event:
1782 */
1783 static int early_boot_irqs_enabled;
1784
1785 void early_boot_irqs_off(void)
1786 {
1787 early_boot_irqs_enabled = 0;
1788 }
1789
1790 void early_boot_irqs_on(void)
1791 {
1792 early_boot_irqs_enabled = 1;
1793 }
1794
1795 /*
1796 * Hardirqs will be enabled:
1797 */
1798 void trace_hardirqs_on(void)
1799 {
1800 struct task_struct *curr = current;
1801 unsigned long ip;
1802
1803 if (unlikely(!debug_locks || current->lockdep_recursion))
1804 return;
1805
1806 if (DEBUG_LOCKS_WARN_ON(unlikely(!early_boot_irqs_enabled)))
1807 return;
1808
1809 if (unlikely(curr->hardirqs_enabled)) {
1810 debug_atomic_inc(&redundant_hardirqs_on);
1811 return;
1812 }
1813 /* we'll do an OFF -> ON transition: */
1814 curr->hardirqs_enabled = 1;
1815 ip = (unsigned long) __builtin_return_address(0);
1816
1817 if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
1818 return;
1819 if (DEBUG_LOCKS_WARN_ON(current->hardirq_context))
1820 return;
1821 /*
1822 * We are going to turn hardirqs on, so set the
1823 * usage bit for all held locks:
1824 */
1825 if (!mark_held_locks(curr, 1, ip))
1826 return;
1827 /*
1828 * If we have softirqs enabled, then set the usage
1829 * bit for all held locks. (disabled hardirqs prevented
1830 * this bit from being set before)
1831 */
1832 if (curr->softirqs_enabled)
1833 if (!mark_held_locks(curr, 0, ip))
1834 return;
1835
1836 curr->hardirq_enable_ip = ip;
1837 curr->hardirq_enable_event = ++curr->irq_events;
1838 debug_atomic_inc(&hardirqs_on_events);
1839 }
1840
1841 EXPORT_SYMBOL(trace_hardirqs_on);
1842
1843 /*
1844 * Hardirqs were disabled:
1845 */
1846 void trace_hardirqs_off(void)
1847 {
1848 struct task_struct *curr = current;
1849
1850 if (unlikely(!debug_locks || current->lockdep_recursion))
1851 return;
1852
1853 if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
1854 return;
1855
1856 if (curr->hardirqs_enabled) {
1857 /*
1858 * We have done an ON -> OFF transition:
1859 */
1860 curr->hardirqs_enabled = 0;
1861 curr->hardirq_disable_ip = _RET_IP_;
1862 curr->hardirq_disable_event = ++curr->irq_events;
1863 debug_atomic_inc(&hardirqs_off_events);
1864 } else
1865 debug_atomic_inc(&redundant_hardirqs_off);
1866 }
1867
1868 EXPORT_SYMBOL(trace_hardirqs_off);
1869
1870 /*
1871 * Softirqs will be enabled:
1872 */
1873 void trace_softirqs_on(unsigned long ip)
1874 {
1875 struct task_struct *curr = current;
1876
1877 if (unlikely(!debug_locks))
1878 return;
1879
1880 if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
1881 return;
1882
1883 if (curr->softirqs_enabled) {
1884 debug_atomic_inc(&redundant_softirqs_on);
1885 return;
1886 }
1887
1888 /*
1889 * We'll do an OFF -> ON transition:
1890 */
1891 curr->softirqs_enabled = 1;
1892 curr->softirq_enable_ip = ip;
1893 curr->softirq_enable_event = ++curr->irq_events;
1894 debug_atomic_inc(&softirqs_on_events);
1895 /*
1896 * We are going to turn softirqs on, so set the
1897 * usage bit for all held locks, if hardirqs are
1898 * enabled too:
1899 */
1900 if (curr->hardirqs_enabled)
1901 mark_held_locks(curr, 0, ip);
1902 }
1903
1904 /*
1905 * Softirqs were disabled:
1906 */
1907 void trace_softirqs_off(unsigned long ip)
1908 {
1909 struct task_struct *curr = current;
1910
1911 if (unlikely(!debug_locks))
1912 return;
1913
1914 if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
1915 return;
1916
1917 if (curr->softirqs_enabled) {
1918 /*
1919 * We have done an ON -> OFF transition:
1920 */
1921 curr->softirqs_enabled = 0;
1922 curr->softirq_disable_ip = ip;
1923 curr->softirq_disable_event = ++curr->irq_events;
1924 debug_atomic_inc(&softirqs_off_events);
1925 DEBUG_LOCKS_WARN_ON(!softirq_count());
1926 } else
1927 debug_atomic_inc(&redundant_softirqs_off);
1928 }
1929
1930 #endif
1931
1932 /*
1933 * Initialize a lock instance's lock-class mapping info:
1934 */
1935 void lockdep_init_map(struct lockdep_map *lock, const char *name,
1936 struct lock_class_key *key, int subclass)
1937 {
1938 if (unlikely(!debug_locks))
1939 return;
1940
1941 if (DEBUG_LOCKS_WARN_ON(!key))
1942 return;
1943 if (DEBUG_LOCKS_WARN_ON(!name))
1944 return;
1945 /*
1946 * Sanity check, the lock-class key must be persistent:
1947 */
1948 if (!static_obj(key)) {
1949 printk("BUG: key %p not in .data!\n", key);
1950 DEBUG_LOCKS_WARN_ON(1);
1951 return;
1952 }
1953 lock->name = name;
1954 lock->key = key;
1955 lock->class_cache = NULL;
1956 if (subclass)
1957 register_lock_class(lock, subclass, 1);
1958 }
1959
1960 EXPORT_SYMBOL_GPL(lockdep_init_map);
1961
1962 /*
1963 * This gets called for every mutex_lock*()/spin_lock*() operation.
1964 * We maintain the dependency maps and validate the locking attempt:
1965 */
1966 static int __lock_acquire(struct lockdep_map *lock, unsigned int subclass,
1967 int trylock, int read, int check, int hardirqs_off,
1968 unsigned long ip)
1969 {
1970 struct task_struct *curr = current;
1971 struct lock_class *class = NULL;
1972 struct held_lock *hlock;
1973 unsigned int depth, id;
1974 int chain_head = 0;
1975 u64 chain_key;
1976
1977 if (unlikely(!debug_locks))
1978 return 0;
1979
1980 if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
1981 return 0;
1982
1983 if (unlikely(subclass >= MAX_LOCKDEP_SUBCLASSES)) {
1984 debug_locks_off();
1985 printk("BUG: MAX_LOCKDEP_SUBCLASSES too low!\n");
1986 printk("turning off the locking correctness validator.\n");
1987 return 0;
1988 }
1989
1990 if (!subclass)
1991 class = lock->class_cache;
1992 /*
1993 * Not cached yet or subclass?
1994 */
1995 if (unlikely(!class)) {
1996 class = register_lock_class(lock, subclass, 0);
1997 if (!class)
1998 return 0;
1999 }
2000 debug_atomic_inc((atomic_t *)&class->ops);
2001 if (very_verbose(class)) {
2002 printk("\nacquire class [%p] %s", class->key, class->name);
2003 if (class->name_version > 1)
2004 printk("#%d", class->name_version);
2005 printk("\n");
2006 dump_stack();
2007 }
2008
2009 /*
2010 * Add the lock to the list of currently held locks.
2011 * (we dont increase the depth just yet, up until the
2012 * dependency checks are done)
2013 */
2014 depth = curr->lockdep_depth;
2015 if (DEBUG_LOCKS_WARN_ON(depth >= MAX_LOCK_DEPTH))
2016 return 0;
2017
2018 hlock = curr->held_locks + depth;
2019
2020 hlock->class = class;
2021 hlock->acquire_ip = ip;
2022 hlock->instance = lock;
2023 hlock->trylock = trylock;
2024 hlock->read = read;
2025 hlock->check = check;
2026 hlock->hardirqs_off = hardirqs_off;
2027
2028 if (check != 2)
2029 goto out_calc_hash;
2030 #ifdef CONFIG_TRACE_IRQFLAGS
2031 /*
2032 * If non-trylock use in a hardirq or softirq context, then
2033 * mark the lock as used in these contexts:
2034 */
2035 if (!trylock) {
2036 if (read) {
2037 if (curr->hardirq_context)
2038 if (!mark_lock(curr, hlock,
2039 LOCK_USED_IN_HARDIRQ_READ, ip))
2040 return 0;
2041 if (curr->softirq_context)
2042 if (!mark_lock(curr, hlock,
2043 LOCK_USED_IN_SOFTIRQ_READ, ip))
2044 return 0;
2045 } else {
2046 if (curr->hardirq_context)
2047 if (!mark_lock(curr, hlock, LOCK_USED_IN_HARDIRQ, ip))
2048 return 0;
2049 if (curr->softirq_context)
2050 if (!mark_lock(curr, hlock, LOCK_USED_IN_SOFTIRQ, ip))
2051 return 0;
2052 }
2053 }
2054 if (!hardirqs_off) {
2055 if (read) {
2056 if (!mark_lock(curr, hlock,
2057 LOCK_ENABLED_HARDIRQS_READ, ip))
2058 return 0;
2059 if (curr->softirqs_enabled)
2060 if (!mark_lock(curr, hlock,
2061 LOCK_ENABLED_SOFTIRQS_READ, ip))
2062 return 0;
2063 } else {
2064 if (!mark_lock(curr, hlock,
2065 LOCK_ENABLED_HARDIRQS, ip))
2066 return 0;
2067 if (curr->softirqs_enabled)
2068 if (!mark_lock(curr, hlock,
2069 LOCK_ENABLED_SOFTIRQS, ip))
2070 return 0;
2071 }
2072 }
2073 #endif
2074 /* mark it as used: */
2075 if (!mark_lock(curr, hlock, LOCK_USED, ip))
2076 return 0;
2077 out_calc_hash:
2078 /*
2079 * Calculate the chain hash: it's the combined has of all the
2080 * lock keys along the dependency chain. We save the hash value
2081 * at every step so that we can get the current hash easily
2082 * after unlock. The chain hash is then used to cache dependency
2083 * results.
2084 *
2085 * The 'key ID' is what is the most compact key value to drive
2086 * the hash, not class->key.
2087 */
2088 id = class - lock_classes;
2089 if (DEBUG_LOCKS_WARN_ON(id >= MAX_LOCKDEP_KEYS))
2090 return 0;
2091
2092 chain_key = curr->curr_chain_key;
2093 if (!depth) {
2094 if (DEBUG_LOCKS_WARN_ON(chain_key != 0))
2095 return 0;
2096 chain_head = 1;
2097 }
2098
2099 hlock->prev_chain_key = chain_key;
2100
2101 #ifdef CONFIG_TRACE_IRQFLAGS
2102 /*
2103 * Keep track of points where we cross into an interrupt context:
2104 */
2105 hlock->irq_context = 2*(curr->hardirq_context ? 1 : 0) +
2106 curr->softirq_context;
2107 if (depth) {
2108 struct held_lock *prev_hlock;
2109
2110 prev_hlock = curr->held_locks + depth-1;
2111 /*
2112 * If we cross into another context, reset the
2113 * hash key (this also prevents the checking and the
2114 * adding of the dependency to 'prev'):
2115 */
2116 if (prev_hlock->irq_context != hlock->irq_context) {
2117 chain_key = 0;
2118 chain_head = 1;
2119 }
2120 }
2121 #endif
2122 chain_key = iterate_chain_key(chain_key, id);
2123 curr->curr_chain_key = chain_key;
2124
2125 /*
2126 * Trylock needs to maintain the stack of held locks, but it
2127 * does not add new dependencies, because trylock can be done
2128 * in any order.
2129 *
2130 * We look up the chain_key and do the O(N^2) check and update of
2131 * the dependencies only if this is a new dependency chain.
2132 * (If lookup_chain_cache() returns with 1 it acquires
2133 * hash_lock for us)
2134 */
2135 if (!trylock && (check == 2) && lookup_chain_cache(chain_key)) {
2136 /*
2137 * Check whether last held lock:
2138 *
2139 * - is irq-safe, if this lock is irq-unsafe
2140 * - is softirq-safe, if this lock is hardirq-unsafe
2141 *
2142 * And check whether the new lock's dependency graph
2143 * could lead back to the previous lock.
2144 *
2145 * any of these scenarios could lead to a deadlock. If
2146 * All validations
2147 */
2148 int ret = check_deadlock(curr, hlock, lock, read);
2149
2150 if (!ret)
2151 return 0;
2152 /*
2153 * Mark recursive read, as we jump over it when
2154 * building dependencies (just like we jump over
2155 * trylock entries):
2156 */
2157 if (ret == 2)
2158 hlock->read = 2;
2159 /*
2160 * Add dependency only if this lock is not the head
2161 * of the chain, and if it's not a secondary read-lock:
2162 */
2163 if (!chain_head && ret != 2)
2164 if (!check_prevs_add(curr, hlock))
2165 return 0;
2166 __raw_spin_unlock(&hash_lock);
2167 }
2168 curr->lockdep_depth++;
2169 check_chain_key(curr);
2170 if (unlikely(curr->lockdep_depth >= MAX_LOCK_DEPTH)) {
2171 debug_locks_off();
2172 printk("BUG: MAX_LOCK_DEPTH too low!\n");
2173 printk("turning off the locking correctness validator.\n");
2174 return 0;
2175 }
2176 if (unlikely(curr->lockdep_depth > max_lockdep_depth))
2177 max_lockdep_depth = curr->lockdep_depth;
2178
2179 return 1;
2180 }
2181
2182 static int
2183 print_unlock_inbalance_bug(struct task_struct *curr, struct lockdep_map *lock,
2184 unsigned long ip)
2185 {
2186 if (!debug_locks_off())
2187 return 0;
2188 if (debug_locks_silent)
2189 return 0;
2190
2191 printk("\n=====================================\n");
2192 printk( "[ BUG: bad unlock balance detected! ]\n");
2193 printk( "-------------------------------------\n");
2194 printk("%s/%d is trying to release lock (",
2195 curr->comm, curr->pid);
2196 print_lockdep_cache(lock);
2197 printk(") at:\n");
2198 print_ip_sym(ip);
2199 printk("but there are no more locks to release!\n");
2200 printk("\nother info that might help us debug this:\n");
2201 lockdep_print_held_locks(curr);
2202
2203 printk("\nstack backtrace:\n");
2204 dump_stack();
2205
2206 return 0;
2207 }
2208
2209 /*
2210 * Common debugging checks for both nested and non-nested unlock:
2211 */
2212 static int check_unlock(struct task_struct *curr, struct lockdep_map *lock,
2213 unsigned long ip)
2214 {
2215 if (unlikely(!debug_locks))
2216 return 0;
2217 if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
2218 return 0;
2219
2220 if (curr->lockdep_depth <= 0)
2221 return print_unlock_inbalance_bug(curr, lock, ip);
2222
2223 return 1;
2224 }
2225
2226 /*
2227 * Remove the lock to the list of currently held locks in a
2228 * potentially non-nested (out of order) manner. This is a
2229 * relatively rare operation, as all the unlock APIs default
2230 * to nested mode (which uses lock_release()):
2231 */
2232 static int
2233 lock_release_non_nested(struct task_struct *curr,
2234 struct lockdep_map *lock, unsigned long ip)
2235 {
2236 struct held_lock *hlock, *prev_hlock;
2237 unsigned int depth;
2238 int i;
2239
2240 /*
2241 * Check whether the lock exists in the current stack
2242 * of held locks:
2243 */
2244 depth = curr->lockdep_depth;
2245 if (DEBUG_LOCKS_WARN_ON(!depth))
2246 return 0;
2247
2248 prev_hlock = NULL;
2249 for (i = depth-1; i >= 0; i--) {
2250 hlock = curr->held_locks + i;
2251 /*
2252 * We must not cross into another context:
2253 */
2254 if (prev_hlock && prev_hlock->irq_context != hlock->irq_context)
2255 break;
2256 if (hlock->instance == lock)
2257 goto found_it;
2258 prev_hlock = hlock;
2259 }
2260 return print_unlock_inbalance_bug(curr, lock, ip);
2261
2262 found_it:
2263 /*
2264 * We have the right lock to unlock, 'hlock' points to it.
2265 * Now we remove it from the stack, and add back the other
2266 * entries (if any), recalculating the hash along the way:
2267 */
2268 curr->lockdep_depth = i;
2269 curr->curr_chain_key = hlock->prev_chain_key;
2270
2271 for (i++; i < depth; i++) {
2272 hlock = curr->held_locks + i;
2273 if (!__lock_acquire(hlock->instance,
2274 hlock->class->subclass, hlock->trylock,
2275 hlock->read, hlock->check, hlock->hardirqs_off,
2276 hlock->acquire_ip))
2277 return 0;
2278 }
2279
2280 if (DEBUG_LOCKS_WARN_ON(curr->lockdep_depth != depth - 1))
2281 return 0;
2282 return 1;
2283 }
2284
2285 /*
2286 * Remove the lock to the list of currently held locks - this gets
2287 * called on mutex_unlock()/spin_unlock*() (or on a failed
2288 * mutex_lock_interruptible()). This is done for unlocks that nest
2289 * perfectly. (i.e. the current top of the lock-stack is unlocked)
2290 */
2291 static int lock_release_nested(struct task_struct *curr,
2292 struct lockdep_map *lock, unsigned long ip)
2293 {
2294 struct held_lock *hlock;
2295 unsigned int depth;
2296
2297 /*
2298 * Pop off the top of the lock stack:
2299 */
2300 depth = curr->lockdep_depth - 1;
2301 hlock = curr->held_locks + depth;
2302
2303 /*
2304 * Is the unlock non-nested:
2305 */
2306 if (hlock->instance != lock)
2307 return lock_release_non_nested(curr, lock, ip);
2308 curr->lockdep_depth--;
2309
2310 if (DEBUG_LOCKS_WARN_ON(!depth && (hlock->prev_chain_key != 0)))
2311 return 0;
2312
2313 curr->curr_chain_key = hlock->prev_chain_key;
2314
2315 #ifdef CONFIG_DEBUG_LOCKDEP
2316 hlock->prev_chain_key = 0;
2317 hlock->class = NULL;
2318 hlock->acquire_ip = 0;
2319 hlock->irq_context = 0;
2320 #endif
2321 return 1;
2322 }
2323
2324 /*
2325 * Remove the lock to the list of currently held locks - this gets
2326 * called on mutex_unlock()/spin_unlock*() (or on a failed
2327 * mutex_lock_interruptible()). This is done for unlocks that nest
2328 * perfectly. (i.e. the current top of the lock-stack is unlocked)
2329 */
2330 static void
2331 __lock_release(struct lockdep_map *lock, int nested, unsigned long ip)
2332 {
2333 struct task_struct *curr = current;
2334
2335 if (!check_unlock(curr, lock, ip))
2336 return;
2337
2338 if (nested) {
2339 if (!lock_release_nested(curr, lock, ip))
2340 return;
2341 } else {
2342 if (!lock_release_non_nested(curr, lock, ip))
2343 return;
2344 }
2345
2346 check_chain_key(curr);
2347 }
2348
2349 /*
2350 * Check whether we follow the irq-flags state precisely:
2351 */
2352 static void check_flags(unsigned long flags)
2353 {
2354 #if defined(CONFIG_DEBUG_LOCKDEP) && defined(CONFIG_TRACE_IRQFLAGS)
2355 if (!debug_locks)
2356 return;
2357
2358 if (irqs_disabled_flags(flags))
2359 DEBUG_LOCKS_WARN_ON(current->hardirqs_enabled);
2360 else
2361 DEBUG_LOCKS_WARN_ON(!current->hardirqs_enabled);
2362
2363 /*
2364 * We dont accurately track softirq state in e.g.
2365 * hardirq contexts (such as on 4KSTACKS), so only
2366 * check if not in hardirq contexts:
2367 */
2368 if (!hardirq_count()) {
2369 if (softirq_count())
2370 DEBUG_LOCKS_WARN_ON(current->softirqs_enabled);
2371 else
2372 DEBUG_LOCKS_WARN_ON(!current->softirqs_enabled);
2373 }
2374
2375 if (!debug_locks)
2376 print_irqtrace_events(current);
2377 #endif
2378 }
2379
2380 /*
2381 * We are not always called with irqs disabled - do that here,
2382 * and also avoid lockdep recursion:
2383 */
2384 void lock_acquire(struct lockdep_map *lock, unsigned int subclass,
2385 int trylock, int read, int check, unsigned long ip)
2386 {
2387 unsigned long flags;
2388
2389 if (unlikely(current->lockdep_recursion))
2390 return;
2391
2392 raw_local_irq_save(flags);
2393 check_flags(flags);
2394
2395 current->lockdep_recursion = 1;
2396 __lock_acquire(lock, subclass, trylock, read, check,
2397 irqs_disabled_flags(flags), ip);
2398 current->lockdep_recursion = 0;
2399 raw_local_irq_restore(flags);
2400 }
2401
2402 EXPORT_SYMBOL_GPL(lock_acquire);
2403
2404 void lock_release(struct lockdep_map *lock, int nested, unsigned long ip)
2405 {
2406 unsigned long flags;
2407
2408 if (unlikely(current->lockdep_recursion))
2409 return;
2410
2411 raw_local_irq_save(flags);
2412 check_flags(flags);
2413 current->lockdep_recursion = 1;
2414 __lock_release(lock, nested, ip);
2415 current->lockdep_recursion = 0;
2416 raw_local_irq_restore(flags);
2417 }
2418
2419 EXPORT_SYMBOL_GPL(lock_release);
2420
2421 /*
2422 * Used by the testsuite, sanitize the validator state
2423 * after a simulated failure:
2424 */
2425
2426 void lockdep_reset(void)
2427 {
2428 unsigned long flags;
2429
2430 raw_local_irq_save(flags);
2431 current->curr_chain_key = 0;
2432 current->lockdep_depth = 0;
2433 current->lockdep_recursion = 0;
2434 memset(current->held_locks, 0, MAX_LOCK_DEPTH*sizeof(struct held_lock));
2435 nr_hardirq_chains = 0;
2436 nr_softirq_chains = 0;
2437 nr_process_chains = 0;
2438 debug_locks = 1;
2439 raw_local_irq_restore(flags);
2440 }
2441
2442 static void zap_class(struct lock_class *class)
2443 {
2444 int i;
2445
2446 /*
2447 * Remove all dependencies this lock is
2448 * involved in:
2449 */
2450 for (i = 0; i < nr_list_entries; i++) {
2451 if (list_entries[i].class == class)
2452 list_del_rcu(&list_entries[i].entry);
2453 }
2454 /*
2455 * Unhash the class and remove it from the all_lock_classes list:
2456 */
2457 list_del_rcu(&class->hash_entry);
2458 list_del_rcu(&class->lock_entry);
2459
2460 }
2461
2462 static inline int within(void *addr, void *start, unsigned long size)
2463 {
2464 return addr >= start && addr < start + size;
2465 }
2466
2467 void lockdep_free_key_range(void *start, unsigned long size)
2468 {
2469 struct lock_class *class, *next;
2470 struct list_head *head;
2471 unsigned long flags;
2472 int i;
2473
2474 raw_local_irq_save(flags);
2475 __raw_spin_lock(&hash_lock);
2476
2477 /*
2478 * Unhash all classes that were created by this module:
2479 */
2480 for (i = 0; i < CLASSHASH_SIZE; i++) {
2481 head = classhash_table + i;
2482 if (list_empty(head))
2483 continue;
2484 list_for_each_entry_safe(class, next, head, hash_entry)
2485 if (within(class->key, start, size))
2486 zap_class(class);
2487 }
2488
2489 __raw_spin_unlock(&hash_lock);
2490 raw_local_irq_restore(flags);
2491 }
2492
2493 void lockdep_reset_lock(struct lockdep_map *lock)
2494 {
2495 struct lock_class *class, *next;
2496 struct list_head *head;
2497 unsigned long flags;
2498 int i, j;
2499
2500 raw_local_irq_save(flags);
2501
2502 /*
2503 * Remove all classes this lock might have:
2504 */
2505 for (j = 0; j < MAX_LOCKDEP_SUBCLASSES; j++) {
2506 /*
2507 * If the class exists we look it up and zap it:
2508 */
2509 class = look_up_lock_class(lock, j);
2510 if (class)
2511 zap_class(class);
2512 }
2513 /*
2514 * Debug check: in the end all mapped classes should
2515 * be gone.
2516 */
2517 __raw_spin_lock(&hash_lock);
2518 for (i = 0; i < CLASSHASH_SIZE; i++) {
2519 head = classhash_table + i;
2520 if (list_empty(head))
2521 continue;
2522 list_for_each_entry_safe(class, next, head, hash_entry) {
2523 if (unlikely(class == lock->class_cache)) {
2524 __raw_spin_unlock(&hash_lock);
2525 DEBUG_LOCKS_WARN_ON(1);
2526 goto out_restore;
2527 }
2528 }
2529 }
2530 __raw_spin_unlock(&hash_lock);
2531
2532 out_restore:
2533 raw_local_irq_restore(flags);
2534 }
2535
2536 void __init lockdep_init(void)
2537 {
2538 int i;
2539
2540 /*
2541 * Some architectures have their own start_kernel()
2542 * code which calls lockdep_init(), while we also
2543 * call lockdep_init() from the start_kernel() itself,
2544 * and we want to initialize the hashes only once:
2545 */
2546 if (lockdep_initialized)
2547 return;
2548
2549 for (i = 0; i < CLASSHASH_SIZE; i++)
2550 INIT_LIST_HEAD(classhash_table + i);
2551
2552 for (i = 0; i < CHAINHASH_SIZE; i++)
2553 INIT_LIST_HEAD(chainhash_table + i);
2554
2555 lockdep_initialized = 1;
2556 }
2557
2558 void __init lockdep_info(void)
2559 {
2560 printk("Lock dependency validator: Copyright (c) 2006 Red Hat, Inc., Ingo Molnar\n");
2561
2562 printk("... MAX_LOCKDEP_SUBCLASSES: %lu\n", MAX_LOCKDEP_SUBCLASSES);
2563 printk("... MAX_LOCK_DEPTH: %lu\n", MAX_LOCK_DEPTH);
2564 printk("... MAX_LOCKDEP_KEYS: %lu\n", MAX_LOCKDEP_KEYS);
2565 printk("... CLASSHASH_SIZE: %lu\n", CLASSHASH_SIZE);
2566 printk("... MAX_LOCKDEP_ENTRIES: %lu\n", MAX_LOCKDEP_ENTRIES);
2567 printk("... MAX_LOCKDEP_CHAINS: %lu\n", MAX_LOCKDEP_CHAINS);
2568 printk("... CHAINHASH_SIZE: %lu\n", CHAINHASH_SIZE);
2569
2570 printk(" memory used by lock dependency info: %lu kB\n",
2571 (sizeof(struct lock_class) * MAX_LOCKDEP_KEYS +
2572 sizeof(struct list_head) * CLASSHASH_SIZE +
2573 sizeof(struct lock_list) * MAX_LOCKDEP_ENTRIES +
2574 sizeof(struct lock_chain) * MAX_LOCKDEP_CHAINS +
2575 sizeof(struct list_head) * CHAINHASH_SIZE) / 1024);
2576
2577 printk(" per task-struct memory footprint: %lu bytes\n",
2578 sizeof(struct held_lock) * MAX_LOCK_DEPTH);
2579
2580 #ifdef CONFIG_DEBUG_LOCKDEP
2581 if (lockdep_init_error)
2582 printk("WARNING: lockdep init error! Arch code didnt call lockdep_init() early enough?\n");
2583 #endif
2584 }
2585
2586 static inline int in_range(const void *start, const void *addr, const void *end)
2587 {
2588 return addr >= start && addr <= end;
2589 }
2590
2591 static void
2592 print_freed_lock_bug(struct task_struct *curr, const void *mem_from,
2593 const void *mem_to, struct held_lock *hlock)
2594 {
2595 if (!debug_locks_off())
2596 return;
2597 if (debug_locks_silent)
2598 return;
2599
2600 printk("\n=========================\n");
2601 printk( "[ BUG: held lock freed! ]\n");
2602 printk( "-------------------------\n");
2603 printk("%s/%d is freeing memory %p-%p, with a lock still held there!\n",
2604 curr->comm, curr->pid, mem_from, mem_to-1);
2605 print_lock(hlock);
2606 lockdep_print_held_locks(curr);
2607
2608 printk("\nstack backtrace:\n");
2609 dump_stack();
2610 }
2611
2612 /*
2613 * Called when kernel memory is freed (or unmapped), or if a lock
2614 * is destroyed or reinitialized - this code checks whether there is
2615 * any held lock in the memory range of <from> to <to>:
2616 */
2617 void debug_check_no_locks_freed(const void *mem_from, unsigned long mem_len)
2618 {
2619 const void *mem_to = mem_from + mem_len, *lock_from, *lock_to;
2620 struct task_struct *curr = current;
2621 struct held_lock *hlock;
2622 unsigned long flags;
2623 int i;
2624
2625 if (unlikely(!debug_locks))
2626 return;
2627
2628 local_irq_save(flags);
2629 for (i = 0; i < curr->lockdep_depth; i++) {
2630 hlock = curr->held_locks + i;
2631
2632 lock_from = (void *)hlock->instance;
2633 lock_to = (void *)(hlock->instance + 1);
2634
2635 if (!in_range(mem_from, lock_from, mem_to) &&
2636 !in_range(mem_from, lock_to, mem_to))
2637 continue;
2638
2639 print_freed_lock_bug(curr, mem_from, mem_to, hlock);
2640 break;
2641 }
2642 local_irq_restore(flags);
2643 }
2644
2645 static void print_held_locks_bug(struct task_struct *curr)
2646 {
2647 if (!debug_locks_off())
2648 return;
2649 if (debug_locks_silent)
2650 return;
2651
2652 printk("\n=====================================\n");
2653 printk( "[ BUG: lock held at task exit time! ]\n");
2654 printk( "-------------------------------------\n");
2655 printk("%s/%d is exiting with locks still held!\n",
2656 curr->comm, curr->pid);
2657 lockdep_print_held_locks(curr);
2658
2659 printk("\nstack backtrace:\n");
2660 dump_stack();
2661 }
2662
2663 void debug_check_no_locks_held(struct task_struct *task)
2664 {
2665 if (unlikely(task->lockdep_depth > 0))
2666 print_held_locks_bug(task);
2667 }
2668
2669 void debug_show_all_locks(void)
2670 {
2671 struct task_struct *g, *p;
2672 int count = 10;
2673 int unlock = 1;
2674
2675 printk("\nShowing all locks held in the system:\n");
2676
2677 /*
2678 * Here we try to get the tasklist_lock as hard as possible,
2679 * if not successful after 2 seconds we ignore it (but keep
2680 * trying). This is to enable a debug printout even if a
2681 * tasklist_lock-holding task deadlocks or crashes.
2682 */
2683 retry:
2684 if (!read_trylock(&tasklist_lock)) {
2685 if (count == 10)
2686 printk("hm, tasklist_lock locked, retrying... ");
2687 if (count) {
2688 count--;
2689 printk(" #%d", 10-count);
2690 mdelay(200);
2691 goto retry;
2692 }
2693 printk(" ignoring it.\n");
2694 unlock = 0;
2695 }
2696 if (count != 10)
2697 printk(" locked it.\n");
2698
2699 do_each_thread(g, p) {
2700 if (p->lockdep_depth)
2701 lockdep_print_held_locks(p);
2702 if (!unlock)
2703 if (read_trylock(&tasklist_lock))
2704 unlock = 1;
2705 } while_each_thread(g, p);
2706
2707 printk("\n");
2708 printk("=============================================\n\n");
2709
2710 if (unlock)
2711 read_unlock(&tasklist_lock);
2712 }
2713
2714 EXPORT_SYMBOL_GPL(debug_show_all_locks);
2715
2716 void debug_show_held_locks(struct task_struct *task)
2717 {
2718 lockdep_print_held_locks(task);
2719 }
2720
2721 EXPORT_SYMBOL_GPL(debug_show_held_locks);
2722