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