lockdep: fully reduce mark_lock_irq()
[linux-2.6] / 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,2007 Red Hat, Inc., Ingo Molnar <mingo@redhat.com>
9  *  Copyright (C) 2007 Red Hat, Inc., Peter Zijlstra <pzijlstr@redhat.com>
10  *
11  * this code maps all the lock dependencies as they occur in a live kernel
12  * and will warn about the following classes of locking bugs:
13  *
14  * - lock inversion scenarios
15  * - circular lock dependencies
16  * - hardirq/softirq safe/unsafe locking bugs
17  *
18  * Bugs are reported even if the current locking scenario does not cause
19  * any deadlock at this point.
20  *
21  * I.e. if anytime in the past two locks were taken in a different order,
22  * even if it happened for another task, even if those were different
23  * locks (but of the same class as this lock), this code will detect it.
24  *
25  * Thanks to Arjan van de Ven for coming up with the initial idea of
26  * mapping lock dependencies runtime.
27  */
28 #define DISABLE_BRANCH_PROFILING
29 #include <linux/mutex.h>
30 #include <linux/sched.h>
31 #include <linux/delay.h>
32 #include <linux/module.h>
33 #include <linux/proc_fs.h>
34 #include <linux/seq_file.h>
35 #include <linux/spinlock.h>
36 #include <linux/kallsyms.h>
37 #include <linux/interrupt.h>
38 #include <linux/stacktrace.h>
39 #include <linux/debug_locks.h>
40 #include <linux/irqflags.h>
41 #include <linux/utsname.h>
42 #include <linux/hash.h>
43 #include <linux/ftrace.h>
44
45 #include <asm/sections.h>
46
47 #include "lockdep_internals.h"
48
49 #ifdef CONFIG_PROVE_LOCKING
50 int prove_locking = 1;
51 module_param(prove_locking, int, 0644);
52 #else
53 #define prove_locking 0
54 #endif
55
56 #ifdef CONFIG_LOCK_STAT
57 int lock_stat = 1;
58 module_param(lock_stat, int, 0644);
59 #else
60 #define lock_stat 0
61 #endif
62
63 /*
64  * lockdep_lock: protects the lockdep graph, the hashes and the
65  *               class/list/hash allocators.
66  *
67  * This is one of the rare exceptions where it's justified
68  * to use a raw spinlock - we really dont want the spinlock
69  * code to recurse back into the lockdep code...
70  */
71 static raw_spinlock_t lockdep_lock = (raw_spinlock_t)__RAW_SPIN_LOCK_UNLOCKED;
72
73 static int graph_lock(void)
74 {
75         __raw_spin_lock(&lockdep_lock);
76         /*
77          * Make sure that if another CPU detected a bug while
78          * walking the graph we dont change it (while the other
79          * CPU is busy printing out stuff with the graph lock
80          * dropped already)
81          */
82         if (!debug_locks) {
83                 __raw_spin_unlock(&lockdep_lock);
84                 return 0;
85         }
86         /* prevent any recursions within lockdep from causing deadlocks */
87         current->lockdep_recursion++;
88         return 1;
89 }
90
91 static inline int graph_unlock(void)
92 {
93         if (debug_locks && !__raw_spin_is_locked(&lockdep_lock))
94                 return DEBUG_LOCKS_WARN_ON(1);
95
96         current->lockdep_recursion--;
97         __raw_spin_unlock(&lockdep_lock);
98         return 0;
99 }
100
101 /*
102  * Turn lock debugging off and return with 0 if it was off already,
103  * and also release the graph lock:
104  */
105 static inline int debug_locks_off_graph_unlock(void)
106 {
107         int ret = debug_locks_off();
108
109         __raw_spin_unlock(&lockdep_lock);
110
111         return ret;
112 }
113
114 static int lockdep_initialized;
115
116 unsigned long nr_list_entries;
117 static struct lock_list list_entries[MAX_LOCKDEP_ENTRIES];
118
119 /*
120  * All data structures here are protected by the global debug_lock.
121  *
122  * Mutex key structs only get allocated, once during bootup, and never
123  * get freed - this significantly simplifies the debugging code.
124  */
125 unsigned long nr_lock_classes;
126 static struct lock_class lock_classes[MAX_LOCKDEP_KEYS];
127
128 static inline struct lock_class *hlock_class(struct held_lock *hlock)
129 {
130         if (!hlock->class_idx) {
131                 DEBUG_LOCKS_WARN_ON(1);
132                 return NULL;
133         }
134         return lock_classes + hlock->class_idx - 1;
135 }
136
137 #ifdef CONFIG_LOCK_STAT
138 static DEFINE_PER_CPU(struct lock_class_stats[MAX_LOCKDEP_KEYS], lock_stats);
139
140 static int lock_point(unsigned long points[], unsigned long ip)
141 {
142         int i;
143
144         for (i = 0; i < LOCKSTAT_POINTS; i++) {
145                 if (points[i] == 0) {
146                         points[i] = ip;
147                         break;
148                 }
149                 if (points[i] == ip)
150                         break;
151         }
152
153         return i;
154 }
155
156 static void lock_time_inc(struct lock_time *lt, s64 time)
157 {
158         if (time > lt->max)
159                 lt->max = time;
160
161         if (time < lt->min || !lt->min)
162                 lt->min = time;
163
164         lt->total += time;
165         lt->nr++;
166 }
167
168 static inline void lock_time_add(struct lock_time *src, struct lock_time *dst)
169 {
170         dst->min += src->min;
171         dst->max += src->max;
172         dst->total += src->total;
173         dst->nr += src->nr;
174 }
175
176 struct lock_class_stats lock_stats(struct lock_class *class)
177 {
178         struct lock_class_stats stats;
179         int cpu, i;
180
181         memset(&stats, 0, sizeof(struct lock_class_stats));
182         for_each_possible_cpu(cpu) {
183                 struct lock_class_stats *pcs =
184                         &per_cpu(lock_stats, cpu)[class - lock_classes];
185
186                 for (i = 0; i < ARRAY_SIZE(stats.contention_point); i++)
187                         stats.contention_point[i] += pcs->contention_point[i];
188
189                 for (i = 0; i < ARRAY_SIZE(stats.contending_point); i++)
190                         stats.contending_point[i] += pcs->contending_point[i];
191
192                 lock_time_add(&pcs->read_waittime, &stats.read_waittime);
193                 lock_time_add(&pcs->write_waittime, &stats.write_waittime);
194
195                 lock_time_add(&pcs->read_holdtime, &stats.read_holdtime);
196                 lock_time_add(&pcs->write_holdtime, &stats.write_holdtime);
197
198                 for (i = 0; i < ARRAY_SIZE(stats.bounces); i++)
199                         stats.bounces[i] += pcs->bounces[i];
200         }
201
202         return stats;
203 }
204
205 void clear_lock_stats(struct lock_class *class)
206 {
207         int cpu;
208
209         for_each_possible_cpu(cpu) {
210                 struct lock_class_stats *cpu_stats =
211                         &per_cpu(lock_stats, cpu)[class - lock_classes];
212
213                 memset(cpu_stats, 0, sizeof(struct lock_class_stats));
214         }
215         memset(class->contention_point, 0, sizeof(class->contention_point));
216         memset(class->contending_point, 0, sizeof(class->contending_point));
217 }
218
219 static struct lock_class_stats *get_lock_stats(struct lock_class *class)
220 {
221         return &get_cpu_var(lock_stats)[class - lock_classes];
222 }
223
224 static void put_lock_stats(struct lock_class_stats *stats)
225 {
226         put_cpu_var(lock_stats);
227 }
228
229 static void lock_release_holdtime(struct held_lock *hlock)
230 {
231         struct lock_class_stats *stats;
232         s64 holdtime;
233
234         if (!lock_stat)
235                 return;
236
237         holdtime = sched_clock() - hlock->holdtime_stamp;
238
239         stats = get_lock_stats(hlock_class(hlock));
240         if (hlock->read)
241                 lock_time_inc(&stats->read_holdtime, holdtime);
242         else
243                 lock_time_inc(&stats->write_holdtime, holdtime);
244         put_lock_stats(stats);
245 }
246 #else
247 static inline void lock_release_holdtime(struct held_lock *hlock)
248 {
249 }
250 #endif
251
252 /*
253  * We keep a global list of all lock classes. The list only grows,
254  * never shrinks. The list is only accessed with the lockdep
255  * spinlock lock held.
256  */
257 LIST_HEAD(all_lock_classes);
258
259 /*
260  * The lockdep classes are in a hash-table as well, for fast lookup:
261  */
262 #define CLASSHASH_BITS          (MAX_LOCKDEP_KEYS_BITS - 1)
263 #define CLASSHASH_SIZE          (1UL << CLASSHASH_BITS)
264 #define __classhashfn(key)      hash_long((unsigned long)key, CLASSHASH_BITS)
265 #define classhashentry(key)     (classhash_table + __classhashfn((key)))
266
267 static struct list_head classhash_table[CLASSHASH_SIZE];
268
269 /*
270  * We put the lock dependency chains into a hash-table as well, to cache
271  * their existence:
272  */
273 #define CHAINHASH_BITS          (MAX_LOCKDEP_CHAINS_BITS-1)
274 #define CHAINHASH_SIZE          (1UL << CHAINHASH_BITS)
275 #define __chainhashfn(chain)    hash_long(chain, CHAINHASH_BITS)
276 #define chainhashentry(chain)   (chainhash_table + __chainhashfn((chain)))
277
278 static struct list_head chainhash_table[CHAINHASH_SIZE];
279
280 /*
281  * The hash key of the lock dependency chains is a hash itself too:
282  * it's a hash of all locks taken up to that lock, including that lock.
283  * It's a 64-bit hash, because it's important for the keys to be
284  * unique.
285  */
286 #define iterate_chain_key(key1, key2) \
287         (((key1) << MAX_LOCKDEP_KEYS_BITS) ^ \
288         ((key1) >> (64-MAX_LOCKDEP_KEYS_BITS)) ^ \
289         (key2))
290
291 void lockdep_off(void)
292 {
293         current->lockdep_recursion++;
294 }
295 EXPORT_SYMBOL(lockdep_off);
296
297 void lockdep_on(void)
298 {
299         current->lockdep_recursion--;
300 }
301 EXPORT_SYMBOL(lockdep_on);
302
303 /*
304  * Debugging switches:
305  */
306
307 #define VERBOSE                 0
308 #define VERY_VERBOSE            0
309
310 #if VERBOSE
311 # define HARDIRQ_VERBOSE        1
312 # define SOFTIRQ_VERBOSE        1
313 # define RECLAIM_VERBOSE        1
314 #else
315 # define HARDIRQ_VERBOSE        0
316 # define SOFTIRQ_VERBOSE        0
317 # define RECLAIM_VERBOSE        0
318 #endif
319
320 #if VERBOSE || HARDIRQ_VERBOSE || SOFTIRQ_VERBOSE || RECLAIM_VERBOSE
321 /*
322  * Quick filtering for interesting events:
323  */
324 static int class_filter(struct lock_class *class)
325 {
326 #if 0
327         /* Example */
328         if (class->name_version == 1 &&
329                         !strcmp(class->name, "lockname"))
330                 return 1;
331         if (class->name_version == 1 &&
332                         !strcmp(class->name, "&struct->lockfield"))
333                 return 1;
334 #endif
335         /* Filter everything else. 1 would be to allow everything else */
336         return 0;
337 }
338 #endif
339
340 static int verbose(struct lock_class *class)
341 {
342 #if VERBOSE
343         return class_filter(class);
344 #endif
345         return 0;
346 }
347
348 /*
349  * Stack-trace: tightly packed array of stack backtrace
350  * addresses. Protected by the graph_lock.
351  */
352 unsigned long nr_stack_trace_entries;
353 static unsigned long stack_trace[MAX_STACK_TRACE_ENTRIES];
354
355 static int save_trace(struct stack_trace *trace)
356 {
357         trace->nr_entries = 0;
358         trace->max_entries = MAX_STACK_TRACE_ENTRIES - nr_stack_trace_entries;
359         trace->entries = stack_trace + nr_stack_trace_entries;
360
361         trace->skip = 3;
362
363         save_stack_trace(trace);
364
365         trace->max_entries = trace->nr_entries;
366
367         nr_stack_trace_entries += trace->nr_entries;
368
369         if (nr_stack_trace_entries == MAX_STACK_TRACE_ENTRIES) {
370                 if (!debug_locks_off_graph_unlock())
371                         return 0;
372
373                 printk("BUG: MAX_STACK_TRACE_ENTRIES too low!\n");
374                 printk("turning off the locking correctness validator.\n");
375                 dump_stack();
376
377                 return 0;
378         }
379
380         return 1;
381 }
382
383 unsigned int nr_hardirq_chains;
384 unsigned int nr_softirq_chains;
385 unsigned int nr_process_chains;
386 unsigned int max_lockdep_depth;
387 unsigned int max_recursion_depth;
388
389 static unsigned int lockdep_dependency_gen_id;
390
391 static bool lockdep_dependency_visit(struct lock_class *source,
392                                      unsigned int depth)
393 {
394         if (!depth)
395                 lockdep_dependency_gen_id++;
396         if (source->dep_gen_id == lockdep_dependency_gen_id)
397                 return true;
398         source->dep_gen_id = lockdep_dependency_gen_id;
399         return false;
400 }
401
402 #ifdef CONFIG_DEBUG_LOCKDEP
403 /*
404  * We cannot printk in early bootup code. Not even early_printk()
405  * might work. So we mark any initialization errors and printk
406  * about it later on, in lockdep_info().
407  */
408 static int lockdep_init_error;
409 static unsigned long lockdep_init_trace_data[20];
410 static struct stack_trace lockdep_init_trace = {
411         .max_entries = ARRAY_SIZE(lockdep_init_trace_data),
412         .entries = lockdep_init_trace_data,
413 };
414
415 /*
416  * Various lockdep statistics:
417  */
418 atomic_t chain_lookup_hits;
419 atomic_t chain_lookup_misses;
420 atomic_t hardirqs_on_events;
421 atomic_t hardirqs_off_events;
422 atomic_t redundant_hardirqs_on;
423 atomic_t redundant_hardirqs_off;
424 atomic_t softirqs_on_events;
425 atomic_t softirqs_off_events;
426 atomic_t redundant_softirqs_on;
427 atomic_t redundant_softirqs_off;
428 atomic_t nr_unused_locks;
429 atomic_t nr_cyclic_checks;
430 atomic_t nr_cyclic_check_recursions;
431 atomic_t nr_find_usage_forwards_checks;
432 atomic_t nr_find_usage_forwards_recursions;
433 atomic_t nr_find_usage_backwards_checks;
434 atomic_t nr_find_usage_backwards_recursions;
435 # define debug_atomic_inc(ptr)          atomic_inc(ptr)
436 # define debug_atomic_dec(ptr)          atomic_dec(ptr)
437 # define debug_atomic_read(ptr)         atomic_read(ptr)
438 #else
439 # define debug_atomic_inc(ptr)          do { } while (0)
440 # define debug_atomic_dec(ptr)          do { } while (0)
441 # define debug_atomic_read(ptr)         0
442 #endif
443
444 /*
445  * Locking printouts:
446  */
447
448 #define __STR(foo)      #foo
449 #define STR(foo)        __STR(foo)
450
451 #define __USAGE(__STATE)                                                \
452         [LOCK_USED_IN_##__STATE] = "IN-"STR(__STATE)"-W",               \
453         [LOCK_ENABLED_##__STATE] = STR(__STATE)"-ON-W",                 \
454         [LOCK_USED_IN_##__STATE##_READ] = "IN-"STR(__STATE)"-R",        \
455         [LOCK_ENABLED_##__STATE##_READ] = STR(__STATE)"-ON-R",
456
457 static const char *usage_str[] =
458 {
459 #define LOCKDEP_STATE(__STATE) __USAGE(__STATE)
460 #include "lockdep_states.h"
461 #undef LOCKDEP_STATE
462         [LOCK_USED] = "INITIAL USE",
463 };
464
465 const char * __get_key_name(struct lockdep_subclass_key *key, char *str)
466 {
467         return kallsyms_lookup((unsigned long)key, NULL, NULL, NULL, str);
468 }
469
470 void
471 get_usage_chars(struct lock_class *class, char *c1, char *c2, char *c3,
472                                         char *c4, char *c5, char *c6)
473 {
474         *c1 = '.', *c2 = '.', *c3 = '.', *c4 = '.', *c5 = '.', *c6 = '.';
475
476         if (class->usage_mask & LOCKF_USED_IN_HARDIRQ)
477                 *c1 = '+';
478         else
479                 if (class->usage_mask & LOCKF_ENABLED_HARDIRQ)
480                         *c1 = '-';
481
482         if (class->usage_mask & LOCKF_USED_IN_SOFTIRQ)
483                 *c2 = '+';
484         else
485                 if (class->usage_mask & LOCKF_ENABLED_SOFTIRQ)
486                         *c2 = '-';
487
488         if (class->usage_mask & LOCKF_ENABLED_HARDIRQ_READ)
489                 *c3 = '-';
490         if (class->usage_mask & LOCKF_USED_IN_HARDIRQ_READ) {
491                 *c3 = '+';
492                 if (class->usage_mask & LOCKF_ENABLED_HARDIRQ_READ)
493                         *c3 = '?';
494         }
495
496         if (class->usage_mask & LOCKF_ENABLED_SOFTIRQ_READ)
497                 *c4 = '-';
498         if (class->usage_mask & LOCKF_USED_IN_SOFTIRQ_READ) {
499                 *c4 = '+';
500                 if (class->usage_mask & LOCKF_ENABLED_SOFTIRQ_READ)
501                         *c4 = '?';
502         }
503
504         if (class->usage_mask & LOCKF_USED_IN_RECLAIM_FS)
505                 *c5 = '+';
506         else
507                 if (class->usage_mask & LOCKF_ENABLED_RECLAIM_FS)
508                         *c5 = '-';
509
510         if (class->usage_mask & LOCKF_ENABLED_RECLAIM_FS_READ)
511                 *c6 = '-';
512         if (class->usage_mask & LOCKF_USED_IN_RECLAIM_FS_READ) {
513                 *c6 = '+';
514                 if (class->usage_mask & LOCKF_ENABLED_RECLAIM_FS_READ)
515                         *c6 = '?';
516         }
517
518 }
519
520 static void print_lock_name(struct lock_class *class)
521 {
522         char str[KSYM_NAME_LEN], c1, c2, c3, c4, c5, c6;
523         const char *name;
524
525         get_usage_chars(class, &c1, &c2, &c3, &c4, &c5, &c6);
526
527         name = class->name;
528         if (!name) {
529                 name = __get_key_name(class->key, str);
530                 printk(" (%s", name);
531         } else {
532                 printk(" (%s", name);
533                 if (class->name_version > 1)
534                         printk("#%d", class->name_version);
535                 if (class->subclass)
536                         printk("/%d", class->subclass);
537         }
538         printk("){%c%c%c%c%c%c}", c1, c2, c3, c4, c5, c6);
539 }
540
541 static void print_lockdep_cache(struct lockdep_map *lock)
542 {
543         const char *name;
544         char str[KSYM_NAME_LEN];
545
546         name = lock->name;
547         if (!name)
548                 name = __get_key_name(lock->key->subkeys, str);
549
550         printk("%s", name);
551 }
552
553 static void print_lock(struct held_lock *hlock)
554 {
555         print_lock_name(hlock_class(hlock));
556         printk(", at: ");
557         print_ip_sym(hlock->acquire_ip);
558 }
559
560 static void lockdep_print_held_locks(struct task_struct *curr)
561 {
562         int i, depth = curr->lockdep_depth;
563
564         if (!depth) {
565                 printk("no locks held by %s/%d.\n", curr->comm, task_pid_nr(curr));
566                 return;
567         }
568         printk("%d lock%s held by %s/%d:\n",
569                 depth, depth > 1 ? "s" : "", curr->comm, task_pid_nr(curr));
570
571         for (i = 0; i < depth; i++) {
572                 printk(" #%d: ", i);
573                 print_lock(curr->held_locks + i);
574         }
575 }
576
577 static void print_lock_class_header(struct lock_class *class, int depth)
578 {
579         int bit;
580
581         printk("%*s->", depth, "");
582         print_lock_name(class);
583         printk(" ops: %lu", class->ops);
584         printk(" {\n");
585
586         for (bit = 0; bit < LOCK_USAGE_STATES; bit++) {
587                 if (class->usage_mask & (1 << bit)) {
588                         int len = depth;
589
590                         len += printk("%*s   %s", depth, "", usage_str[bit]);
591                         len += printk(" at:\n");
592                         print_stack_trace(class->usage_traces + bit, len);
593                 }
594         }
595         printk("%*s }\n", depth, "");
596
597         printk("%*s ... key      at: ",depth,"");
598         print_ip_sym((unsigned long)class->key);
599 }
600
601 /*
602  * printk all lock dependencies starting at <entry>:
603  */
604 static void __used
605 print_lock_dependencies(struct lock_class *class, int depth)
606 {
607         struct lock_list *entry;
608
609         if (lockdep_dependency_visit(class, depth))
610                 return;
611
612         if (DEBUG_LOCKS_WARN_ON(depth >= 20))
613                 return;
614
615         print_lock_class_header(class, depth);
616
617         list_for_each_entry(entry, &class->locks_after, entry) {
618                 if (DEBUG_LOCKS_WARN_ON(!entry->class))
619                         return;
620
621                 print_lock_dependencies(entry->class, depth + 1);
622
623                 printk("%*s ... acquired at:\n",depth,"");
624                 print_stack_trace(&entry->trace, 2);
625                 printk("\n");
626         }
627 }
628
629 static void print_kernel_version(void)
630 {
631         printk("%s %.*s\n", init_utsname()->release,
632                 (int)strcspn(init_utsname()->version, " "),
633                 init_utsname()->version);
634 }
635
636 static int very_verbose(struct lock_class *class)
637 {
638 #if VERY_VERBOSE
639         return class_filter(class);
640 #endif
641         return 0;
642 }
643
644 /*
645  * Is this the address of a static object:
646  */
647 static int static_obj(void *obj)
648 {
649         unsigned long start = (unsigned long) &_stext,
650                       end   = (unsigned long) &_end,
651                       addr  = (unsigned long) obj;
652 #ifdef CONFIG_SMP
653         int i;
654 #endif
655
656         /*
657          * static variable?
658          */
659         if ((addr >= start) && (addr < end))
660                 return 1;
661
662 #ifdef CONFIG_SMP
663         /*
664          * percpu var?
665          */
666         for_each_possible_cpu(i) {
667                 start = (unsigned long) &__per_cpu_start + per_cpu_offset(i);
668                 end   = (unsigned long) &__per_cpu_start + PERCPU_ENOUGH_ROOM
669                                         + per_cpu_offset(i);
670
671                 if ((addr >= start) && (addr < end))
672                         return 1;
673         }
674 #endif
675
676         /*
677          * module var?
678          */
679         return is_module_address(addr);
680 }
681
682 /*
683  * To make lock name printouts unique, we calculate a unique
684  * class->name_version generation counter:
685  */
686 static int count_matching_names(struct lock_class *new_class)
687 {
688         struct lock_class *class;
689         int count = 0;
690
691         if (!new_class->name)
692                 return 0;
693
694         list_for_each_entry(class, &all_lock_classes, lock_entry) {
695                 if (new_class->key - new_class->subclass == class->key)
696                         return class->name_version;
697                 if (class->name && !strcmp(class->name, new_class->name))
698                         count = max(count, class->name_version);
699         }
700
701         return count + 1;
702 }
703
704 /*
705  * Register a lock's class in the hash-table, if the class is not present
706  * yet. Otherwise we look it up. We cache the result in the lock object
707  * itself, so actual lookup of the hash should be once per lock object.
708  */
709 static inline struct lock_class *
710 look_up_lock_class(struct lockdep_map *lock, unsigned int subclass)
711 {
712         struct lockdep_subclass_key *key;
713         struct list_head *hash_head;
714         struct lock_class *class;
715
716 #ifdef CONFIG_DEBUG_LOCKDEP
717         /*
718          * If the architecture calls into lockdep before initializing
719          * the hashes then we'll warn about it later. (we cannot printk
720          * right now)
721          */
722         if (unlikely(!lockdep_initialized)) {
723                 lockdep_init();
724                 lockdep_init_error = 1;
725                 save_stack_trace(&lockdep_init_trace);
726         }
727 #endif
728
729         /*
730          * Static locks do not have their class-keys yet - for them the key
731          * is the lock object itself:
732          */
733         if (unlikely(!lock->key))
734                 lock->key = (void *)lock;
735
736         /*
737          * NOTE: the class-key must be unique. For dynamic locks, a static
738          * lock_class_key variable is passed in through the mutex_init()
739          * (or spin_lock_init()) call - which acts as the key. For static
740          * locks we use the lock object itself as the key.
741          */
742         BUILD_BUG_ON(sizeof(struct lock_class_key) >
743                         sizeof(struct lockdep_map));
744
745         key = lock->key->subkeys + subclass;
746
747         hash_head = classhashentry(key);
748
749         /*
750          * We can walk the hash lockfree, because the hash only
751          * grows, and we are careful when adding entries to the end:
752          */
753         list_for_each_entry(class, hash_head, hash_entry) {
754                 if (class->key == key) {
755                         WARN_ON_ONCE(class->name != lock->name);
756                         return class;
757                 }
758         }
759
760         return NULL;
761 }
762
763 /*
764  * Register a lock's class in the hash-table, if the class is not present
765  * yet. Otherwise we look it up. We cache the result in the lock object
766  * itself, so actual lookup of the hash should be once per lock object.
767  */
768 static inline struct lock_class *
769 register_lock_class(struct lockdep_map *lock, unsigned int subclass, int force)
770 {
771         struct lockdep_subclass_key *key;
772         struct list_head *hash_head;
773         struct lock_class *class;
774         unsigned long flags;
775
776         class = look_up_lock_class(lock, subclass);
777         if (likely(class))
778                 return class;
779
780         /*
781          * Debug-check: all keys must be persistent!
782          */
783         if (!static_obj(lock->key)) {
784                 debug_locks_off();
785                 printk("INFO: trying to register non-static key.\n");
786                 printk("the code is fine but needs lockdep annotation.\n");
787                 printk("turning off the locking correctness validator.\n");
788                 dump_stack();
789
790                 return NULL;
791         }
792
793         key = lock->key->subkeys + subclass;
794         hash_head = classhashentry(key);
795
796         raw_local_irq_save(flags);
797         if (!graph_lock()) {
798                 raw_local_irq_restore(flags);
799                 return NULL;
800         }
801         /*
802          * We have to do the hash-walk again, to avoid races
803          * with another CPU:
804          */
805         list_for_each_entry(class, hash_head, hash_entry)
806                 if (class->key == key)
807                         goto out_unlock_set;
808         /*
809          * Allocate a new key from the static array, and add it to
810          * the hash:
811          */
812         if (nr_lock_classes >= MAX_LOCKDEP_KEYS) {
813                 if (!debug_locks_off_graph_unlock()) {
814                         raw_local_irq_restore(flags);
815                         return NULL;
816                 }
817                 raw_local_irq_restore(flags);
818
819                 printk("BUG: MAX_LOCKDEP_KEYS too low!\n");
820                 printk("turning off the locking correctness validator.\n");
821                 return NULL;
822         }
823         class = lock_classes + nr_lock_classes++;
824         debug_atomic_inc(&nr_unused_locks);
825         class->key = key;
826         class->name = lock->name;
827         class->subclass = subclass;
828         INIT_LIST_HEAD(&class->lock_entry);
829         INIT_LIST_HEAD(&class->locks_before);
830         INIT_LIST_HEAD(&class->locks_after);
831         class->name_version = count_matching_names(class);
832         /*
833          * We use RCU's safe list-add method to make
834          * parallel walking of the hash-list safe:
835          */
836         list_add_tail_rcu(&class->hash_entry, hash_head);
837         /*
838          * Add it to the global list of classes:
839          */
840         list_add_tail_rcu(&class->lock_entry, &all_lock_classes);
841
842         if (verbose(class)) {
843                 graph_unlock();
844                 raw_local_irq_restore(flags);
845
846                 printk("\nnew class %p: %s", class->key, class->name);
847                 if (class->name_version > 1)
848                         printk("#%d", class->name_version);
849                 printk("\n");
850                 dump_stack();
851
852                 raw_local_irq_save(flags);
853                 if (!graph_lock()) {
854                         raw_local_irq_restore(flags);
855                         return NULL;
856                 }
857         }
858 out_unlock_set:
859         graph_unlock();
860         raw_local_irq_restore(flags);
861
862         if (!subclass || force)
863                 lock->class_cache = class;
864
865         if (DEBUG_LOCKS_WARN_ON(class->subclass != subclass))
866                 return NULL;
867
868         return class;
869 }
870
871 #ifdef CONFIG_PROVE_LOCKING
872 /*
873  * Allocate a lockdep entry. (assumes the graph_lock held, returns
874  * with NULL on failure)
875  */
876 static struct lock_list *alloc_list_entry(void)
877 {
878         if (nr_list_entries >= MAX_LOCKDEP_ENTRIES) {
879                 if (!debug_locks_off_graph_unlock())
880                         return NULL;
881
882                 printk("BUG: MAX_LOCKDEP_ENTRIES too low!\n");
883                 printk("turning off the locking correctness validator.\n");
884                 return NULL;
885         }
886         return list_entries + nr_list_entries++;
887 }
888
889 /*
890  * Add a new dependency to the head of the list:
891  */
892 static int add_lock_to_list(struct lock_class *class, struct lock_class *this,
893                             struct list_head *head, unsigned long ip, int distance)
894 {
895         struct lock_list *entry;
896         /*
897          * Lock not present yet - get a new dependency struct and
898          * add it to the list:
899          */
900         entry = alloc_list_entry();
901         if (!entry)
902                 return 0;
903
904         if (!save_trace(&entry->trace))
905                 return 0;
906
907         entry->class = this;
908         entry->distance = distance;
909         /*
910          * Since we never remove from the dependency list, the list can
911          * be walked lockless by other CPUs, it's only allocation
912          * that must be protected by the spinlock. But this also means
913          * we must make new entries visible only once writes to the
914          * entry become visible - hence the RCU op:
915          */
916         list_add_tail_rcu(&entry->entry, head);
917
918         return 1;
919 }
920
921 /*
922  * Recursive, forwards-direction lock-dependency checking, used for
923  * both noncyclic checking and for hardirq-unsafe/softirq-unsafe
924  * checking.
925  *
926  * (to keep the stackframe of the recursive functions small we
927  *  use these global variables, and we also mark various helper
928  *  functions as noinline.)
929  */
930 static struct held_lock *check_source, *check_target;
931
932 /*
933  * Print a dependency chain entry (this is only done when a deadlock
934  * has been detected):
935  */
936 static noinline int
937 print_circular_bug_entry(struct lock_list *target, unsigned int depth)
938 {
939         if (debug_locks_silent)
940                 return 0;
941         printk("\n-> #%u", depth);
942         print_lock_name(target->class);
943         printk(":\n");
944         print_stack_trace(&target->trace, 6);
945
946         return 0;
947 }
948
949 /*
950  * When a circular dependency is detected, print the
951  * header first:
952  */
953 static noinline int
954 print_circular_bug_header(struct lock_list *entry, unsigned int depth)
955 {
956         struct task_struct *curr = current;
957
958         if (!debug_locks_off_graph_unlock() || debug_locks_silent)
959                 return 0;
960
961         printk("\n=======================================================\n");
962         printk(  "[ INFO: possible circular locking dependency detected ]\n");
963         print_kernel_version();
964         printk(  "-------------------------------------------------------\n");
965         printk("%s/%d is trying to acquire lock:\n",
966                 curr->comm, task_pid_nr(curr));
967         print_lock(check_source);
968         printk("\nbut task is already holding lock:\n");
969         print_lock(check_target);
970         printk("\nwhich lock already depends on the new lock.\n\n");
971         printk("\nthe existing dependency chain (in reverse order) is:\n");
972
973         print_circular_bug_entry(entry, depth);
974
975         return 0;
976 }
977
978 static noinline int print_circular_bug_tail(void)
979 {
980         struct task_struct *curr = current;
981         struct lock_list this;
982
983         if (debug_locks_silent)
984                 return 0;
985
986         this.class = hlock_class(check_source);
987         if (!save_trace(&this.trace))
988                 return 0;
989
990         print_circular_bug_entry(&this, 0);
991
992         printk("\nother info that might help us debug this:\n\n");
993         lockdep_print_held_locks(curr);
994
995         printk("\nstack backtrace:\n");
996         dump_stack();
997
998         return 0;
999 }
1000
1001 #define RECURSION_LIMIT 40
1002
1003 static int noinline print_infinite_recursion_bug(void)
1004 {
1005         if (!debug_locks_off_graph_unlock())
1006                 return 0;
1007
1008         WARN_ON(1);
1009
1010         return 0;
1011 }
1012
1013 unsigned long __lockdep_count_forward_deps(struct lock_class *class,
1014                                            unsigned int depth)
1015 {
1016         struct lock_list *entry;
1017         unsigned long ret = 1;
1018
1019         if (lockdep_dependency_visit(class, depth))
1020                 return 0;
1021
1022         /*
1023          * Recurse this class's dependency list:
1024          */
1025         list_for_each_entry(entry, &class->locks_after, entry)
1026                 ret += __lockdep_count_forward_deps(entry->class, depth + 1);
1027
1028         return ret;
1029 }
1030
1031 unsigned long lockdep_count_forward_deps(struct lock_class *class)
1032 {
1033         unsigned long ret, flags;
1034
1035         local_irq_save(flags);
1036         __raw_spin_lock(&lockdep_lock);
1037         ret = __lockdep_count_forward_deps(class, 0);
1038         __raw_spin_unlock(&lockdep_lock);
1039         local_irq_restore(flags);
1040
1041         return ret;
1042 }
1043
1044 unsigned long __lockdep_count_backward_deps(struct lock_class *class,
1045                                             unsigned int depth)
1046 {
1047         struct lock_list *entry;
1048         unsigned long ret = 1;
1049
1050         if (lockdep_dependency_visit(class, depth))
1051                 return 0;
1052         /*
1053          * Recurse this class's dependency list:
1054          */
1055         list_for_each_entry(entry, &class->locks_before, entry)
1056                 ret += __lockdep_count_backward_deps(entry->class, depth + 1);
1057
1058         return ret;
1059 }
1060
1061 unsigned long lockdep_count_backward_deps(struct lock_class *class)
1062 {
1063         unsigned long ret, flags;
1064
1065         local_irq_save(flags);
1066         __raw_spin_lock(&lockdep_lock);
1067         ret = __lockdep_count_backward_deps(class, 0);
1068         __raw_spin_unlock(&lockdep_lock);
1069         local_irq_restore(flags);
1070
1071         return ret;
1072 }
1073
1074 /*
1075  * Prove that the dependency graph starting at <entry> can not
1076  * lead to <target>. Print an error and return 0 if it does.
1077  */
1078 static noinline int
1079 check_noncircular(struct lock_class *source, unsigned int depth)
1080 {
1081         struct lock_list *entry;
1082
1083         if (lockdep_dependency_visit(source, depth))
1084                 return 1;
1085
1086         debug_atomic_inc(&nr_cyclic_check_recursions);
1087         if (depth > max_recursion_depth)
1088                 max_recursion_depth = depth;
1089         if (depth >= RECURSION_LIMIT)
1090                 return print_infinite_recursion_bug();
1091         /*
1092          * Check this lock's dependency list:
1093          */
1094         list_for_each_entry(entry, &source->locks_after, entry) {
1095                 if (entry->class == hlock_class(check_target))
1096                         return print_circular_bug_header(entry, depth+1);
1097                 debug_atomic_inc(&nr_cyclic_checks);
1098                 if (!check_noncircular(entry->class, depth+1))
1099                         return print_circular_bug_entry(entry, depth+1);
1100         }
1101         return 1;
1102 }
1103
1104 #if defined(CONFIG_TRACE_IRQFLAGS) && defined(CONFIG_PROVE_LOCKING)
1105 /*
1106  * Forwards and backwards subgraph searching, for the purposes of
1107  * proving that two subgraphs can be connected by a new dependency
1108  * without creating any illegal irq-safe -> irq-unsafe lock dependency.
1109  */
1110 static enum lock_usage_bit find_usage_bit;
1111 static struct lock_class *forwards_match, *backwards_match;
1112
1113 /*
1114  * Find a node in the forwards-direction dependency sub-graph starting
1115  * at <source> that matches <find_usage_bit>.
1116  *
1117  * Return 2 if such a node exists in the subgraph, and put that node
1118  * into <forwards_match>.
1119  *
1120  * Return 1 otherwise and keep <forwards_match> unchanged.
1121  * Return 0 on error.
1122  */
1123 static noinline int
1124 find_usage_forwards(struct lock_class *source, unsigned int depth)
1125 {
1126         struct lock_list *entry;
1127         int ret;
1128
1129         if (lockdep_dependency_visit(source, depth))
1130                 return 1;
1131
1132         if (depth > max_recursion_depth)
1133                 max_recursion_depth = depth;
1134         if (depth >= RECURSION_LIMIT)
1135                 return print_infinite_recursion_bug();
1136
1137         debug_atomic_inc(&nr_find_usage_forwards_checks);
1138         if (source->usage_mask & (1 << find_usage_bit)) {
1139                 forwards_match = source;
1140                 return 2;
1141         }
1142
1143         /*
1144          * Check this lock's dependency list:
1145          */
1146         list_for_each_entry(entry, &source->locks_after, entry) {
1147                 debug_atomic_inc(&nr_find_usage_forwards_recursions);
1148                 ret = find_usage_forwards(entry->class, depth+1);
1149                 if (ret == 2 || ret == 0)
1150                         return ret;
1151         }
1152         return 1;
1153 }
1154
1155 /*
1156  * Find a node in the backwards-direction dependency sub-graph starting
1157  * at <source> that matches <find_usage_bit>.
1158  *
1159  * Return 2 if such a node exists in the subgraph, and put that node
1160  * into <backwards_match>.
1161  *
1162  * Return 1 otherwise and keep <backwards_match> unchanged.
1163  * Return 0 on error.
1164  */
1165 static noinline int
1166 find_usage_backwards(struct lock_class *source, unsigned int depth)
1167 {
1168         struct lock_list *entry;
1169         int ret;
1170
1171         if (lockdep_dependency_visit(source, depth))
1172                 return 1;
1173
1174         if (!__raw_spin_is_locked(&lockdep_lock))
1175                 return DEBUG_LOCKS_WARN_ON(1);
1176
1177         if (depth > max_recursion_depth)
1178                 max_recursion_depth = depth;
1179         if (depth >= RECURSION_LIMIT)
1180                 return print_infinite_recursion_bug();
1181
1182         debug_atomic_inc(&nr_find_usage_backwards_checks);
1183         if (source->usage_mask & (1 << find_usage_bit)) {
1184                 backwards_match = source;
1185                 return 2;
1186         }
1187
1188         if (!source && debug_locks_off_graph_unlock()) {
1189                 WARN_ON(1);
1190                 return 0;
1191         }
1192
1193         /*
1194          * Check this lock's dependency list:
1195          */
1196         list_for_each_entry(entry, &source->locks_before, entry) {
1197                 debug_atomic_inc(&nr_find_usage_backwards_recursions);
1198                 ret = find_usage_backwards(entry->class, depth+1);
1199                 if (ret == 2 || ret == 0)
1200                         return ret;
1201         }
1202         return 1;
1203 }
1204
1205 static int
1206 print_bad_irq_dependency(struct task_struct *curr,
1207                          struct held_lock *prev,
1208                          struct held_lock *next,
1209                          enum lock_usage_bit bit1,
1210                          enum lock_usage_bit bit2,
1211                          const char *irqclass)
1212 {
1213         if (!debug_locks_off_graph_unlock() || debug_locks_silent)
1214                 return 0;
1215
1216         printk("\n======================================================\n");
1217         printk(  "[ INFO: %s-safe -> %s-unsafe lock order detected ]\n",
1218                 irqclass, irqclass);
1219         print_kernel_version();
1220         printk(  "------------------------------------------------------\n");
1221         printk("%s/%d [HC%u[%lu]:SC%u[%lu]:HE%u:SE%u] is trying to acquire:\n",
1222                 curr->comm, task_pid_nr(curr),
1223                 curr->hardirq_context, hardirq_count() >> HARDIRQ_SHIFT,
1224                 curr->softirq_context, softirq_count() >> SOFTIRQ_SHIFT,
1225                 curr->hardirqs_enabled,
1226                 curr->softirqs_enabled);
1227         print_lock(next);
1228
1229         printk("\nand this task is already holding:\n");
1230         print_lock(prev);
1231         printk("which would create a new lock dependency:\n");
1232         print_lock_name(hlock_class(prev));
1233         printk(" ->");
1234         print_lock_name(hlock_class(next));
1235         printk("\n");
1236
1237         printk("\nbut this new dependency connects a %s-irq-safe lock:\n",
1238                 irqclass);
1239         print_lock_name(backwards_match);
1240         printk("\n... which became %s-irq-safe at:\n", irqclass);
1241
1242         print_stack_trace(backwards_match->usage_traces + bit1, 1);
1243
1244         printk("\nto a %s-irq-unsafe lock:\n", irqclass);
1245         print_lock_name(forwards_match);
1246         printk("\n... which became %s-irq-unsafe at:\n", irqclass);
1247         printk("...");
1248
1249         print_stack_trace(forwards_match->usage_traces + bit2, 1);
1250
1251         printk("\nother info that might help us debug this:\n\n");
1252         lockdep_print_held_locks(curr);
1253
1254         printk("\nthe %s-irq-safe lock's dependencies:\n", irqclass);
1255         print_lock_dependencies(backwards_match, 0);
1256
1257         printk("\nthe %s-irq-unsafe lock's dependencies:\n", irqclass);
1258         print_lock_dependencies(forwards_match, 0);
1259
1260         printk("\nstack backtrace:\n");
1261         dump_stack();
1262
1263         return 0;
1264 }
1265
1266 static int
1267 check_usage(struct task_struct *curr, struct held_lock *prev,
1268             struct held_lock *next, enum lock_usage_bit bit_backwards,
1269             enum lock_usage_bit bit_forwards, const char *irqclass)
1270 {
1271         int ret;
1272
1273         find_usage_bit = bit_backwards;
1274         /* fills in <backwards_match> */
1275         ret = find_usage_backwards(hlock_class(prev), 0);
1276         if (!ret || ret == 1)
1277                 return ret;
1278
1279         find_usage_bit = bit_forwards;
1280         ret = find_usage_forwards(hlock_class(next), 0);
1281         if (!ret || ret == 1)
1282                 return ret;
1283         /* ret == 2 */
1284         return print_bad_irq_dependency(curr, prev, next,
1285                         bit_backwards, bit_forwards, irqclass);
1286 }
1287
1288 static int
1289 check_prev_add_irq(struct task_struct *curr, struct held_lock *prev,
1290                 struct held_lock *next)
1291 {
1292         /*
1293          * Prove that the new dependency does not connect a hardirq-safe
1294          * lock with a hardirq-unsafe lock - to achieve this we search
1295          * the backwards-subgraph starting at <prev>, and the
1296          * forwards-subgraph starting at <next>:
1297          */
1298         if (!check_usage(curr, prev, next, LOCK_USED_IN_HARDIRQ,
1299                                         LOCK_ENABLED_HARDIRQ, "hard"))
1300                 return 0;
1301
1302         /*
1303          * Prove that the new dependency does not connect a hardirq-safe-read
1304          * lock with a hardirq-unsafe lock - to achieve this we search
1305          * the backwards-subgraph starting at <prev>, and the
1306          * forwards-subgraph starting at <next>:
1307          */
1308         if (!check_usage(curr, prev, next, LOCK_USED_IN_HARDIRQ_READ,
1309                                         LOCK_ENABLED_HARDIRQ, "hard-read"))
1310                 return 0;
1311
1312         /*
1313          * Prove that the new dependency does not connect a softirq-safe
1314          * lock with a softirq-unsafe lock - to achieve this we search
1315          * the backwards-subgraph starting at <prev>, and the
1316          * forwards-subgraph starting at <next>:
1317          */
1318         if (!check_usage(curr, prev, next, LOCK_USED_IN_SOFTIRQ,
1319                                         LOCK_ENABLED_SOFTIRQ, "soft"))
1320                 return 0;
1321         /*
1322          * Prove that the new dependency does not connect a softirq-safe-read
1323          * lock with a softirq-unsafe lock - to achieve this we search
1324          * the backwards-subgraph starting at <prev>, and the
1325          * forwards-subgraph starting at <next>:
1326          */
1327         if (!check_usage(curr, prev, next, LOCK_USED_IN_SOFTIRQ_READ,
1328                                         LOCK_ENABLED_SOFTIRQ, "soft"))
1329                 return 0;
1330
1331         /*
1332          * Prove that the new dependency does not connect a reclaim-fs-safe
1333          * lock with a reclaim-fs-unsafe lock - to achieve this we search
1334          * the backwards-subgraph starting at <prev>, and the
1335          * forwards-subgraph starting at <next>:
1336          */
1337         if (!check_usage(curr, prev, next, LOCK_USED_IN_RECLAIM_FS,
1338                                         LOCK_ENABLED_RECLAIM_FS, "reclaim-fs"))
1339                 return 0;
1340
1341         /*
1342          * Prove that the new dependency does not connect a reclaim-fs-safe-read
1343          * lock with a reclaim-fs-unsafe lock - to achieve this we search
1344          * the backwards-subgraph starting at <prev>, and the
1345          * forwards-subgraph starting at <next>:
1346          */
1347         if (!check_usage(curr, prev, next, LOCK_USED_IN_RECLAIM_FS_READ,
1348                                         LOCK_ENABLED_RECLAIM_FS, "reclaim-fs-read"))
1349                 return 0;
1350
1351         return 1;
1352 }
1353
1354 static void inc_chains(void)
1355 {
1356         if (current->hardirq_context)
1357                 nr_hardirq_chains++;
1358         else {
1359                 if (current->softirq_context)
1360                         nr_softirq_chains++;
1361                 else
1362                         nr_process_chains++;
1363         }
1364 }
1365
1366 #else
1367
1368 static inline int
1369 check_prev_add_irq(struct task_struct *curr, struct held_lock *prev,
1370                 struct held_lock *next)
1371 {
1372         return 1;
1373 }
1374
1375 static inline void inc_chains(void)
1376 {
1377         nr_process_chains++;
1378 }
1379
1380 #endif
1381
1382 static int
1383 print_deadlock_bug(struct task_struct *curr, struct held_lock *prev,
1384                    struct held_lock *next)
1385 {
1386         if (!debug_locks_off_graph_unlock() || debug_locks_silent)
1387                 return 0;
1388
1389         printk("\n=============================================\n");
1390         printk(  "[ INFO: possible recursive locking detected ]\n");
1391         print_kernel_version();
1392         printk(  "---------------------------------------------\n");
1393         printk("%s/%d is trying to acquire lock:\n",
1394                 curr->comm, task_pid_nr(curr));
1395         print_lock(next);
1396         printk("\nbut task is already holding lock:\n");
1397         print_lock(prev);
1398
1399         printk("\nother info that might help us debug this:\n");
1400         lockdep_print_held_locks(curr);
1401
1402         printk("\nstack backtrace:\n");
1403         dump_stack();
1404
1405         return 0;
1406 }
1407
1408 /*
1409  * Check whether we are holding such a class already.
1410  *
1411  * (Note that this has to be done separately, because the graph cannot
1412  * detect such classes of deadlocks.)
1413  *
1414  * Returns: 0 on deadlock detected, 1 on OK, 2 on recursive read
1415  */
1416 static int
1417 check_deadlock(struct task_struct *curr, struct held_lock *next,
1418                struct lockdep_map *next_instance, int read)
1419 {
1420         struct held_lock *prev;
1421         struct held_lock *nest = NULL;
1422         int i;
1423
1424         for (i = 0; i < curr->lockdep_depth; i++) {
1425                 prev = curr->held_locks + i;
1426
1427                 if (prev->instance == next->nest_lock)
1428                         nest = prev;
1429
1430                 if (hlock_class(prev) != hlock_class(next))
1431                         continue;
1432
1433                 /*
1434                  * Allow read-after-read recursion of the same
1435                  * lock class (i.e. read_lock(lock)+read_lock(lock)):
1436                  */
1437                 if ((read == 2) && prev->read)
1438                         return 2;
1439
1440                 /*
1441                  * We're holding the nest_lock, which serializes this lock's
1442                  * nesting behaviour.
1443                  */
1444                 if (nest)
1445                         return 2;
1446
1447                 return print_deadlock_bug(curr, prev, next);
1448         }
1449         return 1;
1450 }
1451
1452 /*
1453  * There was a chain-cache miss, and we are about to add a new dependency
1454  * to a previous lock. We recursively validate the following rules:
1455  *
1456  *  - would the adding of the <prev> -> <next> dependency create a
1457  *    circular dependency in the graph? [== circular deadlock]
1458  *
1459  *  - does the new prev->next dependency connect any hardirq-safe lock
1460  *    (in the full backwards-subgraph starting at <prev>) with any
1461  *    hardirq-unsafe lock (in the full forwards-subgraph starting at
1462  *    <next>)? [== illegal lock inversion with hardirq contexts]
1463  *
1464  *  - does the new prev->next dependency connect any softirq-safe lock
1465  *    (in the full backwards-subgraph starting at <prev>) with any
1466  *    softirq-unsafe lock (in the full forwards-subgraph starting at
1467  *    <next>)? [== illegal lock inversion with softirq contexts]
1468  *
1469  * any of these scenarios could lead to a deadlock.
1470  *
1471  * Then if all the validations pass, we add the forwards and backwards
1472  * dependency.
1473  */
1474 static int
1475 check_prev_add(struct task_struct *curr, struct held_lock *prev,
1476                struct held_lock *next, int distance)
1477 {
1478         struct lock_list *entry;
1479         int ret;
1480
1481         /*
1482          * Prove that the new <prev> -> <next> dependency would not
1483          * create a circular dependency in the graph. (We do this by
1484          * forward-recursing into the graph starting at <next>, and
1485          * checking whether we can reach <prev>.)
1486          *
1487          * We are using global variables to control the recursion, to
1488          * keep the stackframe size of the recursive functions low:
1489          */
1490         check_source = next;
1491         check_target = prev;
1492         if (!(check_noncircular(hlock_class(next), 0)))
1493                 return print_circular_bug_tail();
1494
1495         if (!check_prev_add_irq(curr, prev, next))
1496                 return 0;
1497
1498         /*
1499          * For recursive read-locks we do all the dependency checks,
1500          * but we dont store read-triggered dependencies (only
1501          * write-triggered dependencies). This ensures that only the
1502          * write-side dependencies matter, and that if for example a
1503          * write-lock never takes any other locks, then the reads are
1504          * equivalent to a NOP.
1505          */
1506         if (next->read == 2 || prev->read == 2)
1507                 return 1;
1508         /*
1509          * Is the <prev> -> <next> dependency already present?
1510          *
1511          * (this may occur even though this is a new chain: consider
1512          *  e.g. the L1 -> L2 -> L3 -> L4 and the L5 -> L1 -> L2 -> L3
1513          *  chains - the second one will be new, but L1 already has
1514          *  L2 added to its dependency list, due to the first chain.)
1515          */
1516         list_for_each_entry(entry, &hlock_class(prev)->locks_after, entry) {
1517                 if (entry->class == hlock_class(next)) {
1518                         if (distance == 1)
1519                                 entry->distance = 1;
1520                         return 2;
1521                 }
1522         }
1523
1524         /*
1525          * Ok, all validations passed, add the new lock
1526          * to the previous lock's dependency list:
1527          */
1528         ret = add_lock_to_list(hlock_class(prev), hlock_class(next),
1529                                &hlock_class(prev)->locks_after,
1530                                next->acquire_ip, distance);
1531
1532         if (!ret)
1533                 return 0;
1534
1535         ret = add_lock_to_list(hlock_class(next), hlock_class(prev),
1536                                &hlock_class(next)->locks_before,
1537                                next->acquire_ip, distance);
1538         if (!ret)
1539                 return 0;
1540
1541         /*
1542          * Debugging printouts:
1543          */
1544         if (verbose(hlock_class(prev)) || verbose(hlock_class(next))) {
1545                 graph_unlock();
1546                 printk("\n new dependency: ");
1547                 print_lock_name(hlock_class(prev));
1548                 printk(" => ");
1549                 print_lock_name(hlock_class(next));
1550                 printk("\n");
1551                 dump_stack();
1552                 return graph_lock();
1553         }
1554         return 1;
1555 }
1556
1557 /*
1558  * Add the dependency to all directly-previous locks that are 'relevant'.
1559  * The ones that are relevant are (in increasing distance from curr):
1560  * all consecutive trylock entries and the final non-trylock entry - or
1561  * the end of this context's lock-chain - whichever comes first.
1562  */
1563 static int
1564 check_prevs_add(struct task_struct *curr, struct held_lock *next)
1565 {
1566         int depth = curr->lockdep_depth;
1567         struct held_lock *hlock;
1568
1569         /*
1570          * Debugging checks.
1571          *
1572          * Depth must not be zero for a non-head lock:
1573          */
1574         if (!depth)
1575                 goto out_bug;
1576         /*
1577          * At least two relevant locks must exist for this
1578          * to be a head:
1579          */
1580         if (curr->held_locks[depth].irq_context !=
1581                         curr->held_locks[depth-1].irq_context)
1582                 goto out_bug;
1583
1584         for (;;) {
1585                 int distance = curr->lockdep_depth - depth + 1;
1586                 hlock = curr->held_locks + depth-1;
1587                 /*
1588                  * Only non-recursive-read entries get new dependencies
1589                  * added:
1590                  */
1591                 if (hlock->read != 2) {
1592                         if (!check_prev_add(curr, hlock, next, distance))
1593                                 return 0;
1594                         /*
1595                          * Stop after the first non-trylock entry,
1596                          * as non-trylock entries have added their
1597                          * own direct dependencies already, so this
1598                          * lock is connected to them indirectly:
1599                          */
1600                         if (!hlock->trylock)
1601                                 break;
1602                 }
1603                 depth--;
1604                 /*
1605                  * End of lock-stack?
1606                  */
1607                 if (!depth)
1608                         break;
1609                 /*
1610                  * Stop the search if we cross into another context:
1611                  */
1612                 if (curr->held_locks[depth].irq_context !=
1613                                 curr->held_locks[depth-1].irq_context)
1614                         break;
1615         }
1616         return 1;
1617 out_bug:
1618         if (!debug_locks_off_graph_unlock())
1619                 return 0;
1620
1621         WARN_ON(1);
1622
1623         return 0;
1624 }
1625
1626 unsigned long nr_lock_chains;
1627 struct lock_chain lock_chains[MAX_LOCKDEP_CHAINS];
1628 int nr_chain_hlocks;
1629 static u16 chain_hlocks[MAX_LOCKDEP_CHAIN_HLOCKS];
1630
1631 struct lock_class *lock_chain_get_class(struct lock_chain *chain, int i)
1632 {
1633         return lock_classes + chain_hlocks[chain->base + i];
1634 }
1635
1636 /*
1637  * Look up a dependency chain. If the key is not present yet then
1638  * add it and return 1 - in this case the new dependency chain is
1639  * validated. If the key is already hashed, return 0.
1640  * (On return with 1 graph_lock is held.)
1641  */
1642 static inline int lookup_chain_cache(struct task_struct *curr,
1643                                      struct held_lock *hlock,
1644                                      u64 chain_key)
1645 {
1646         struct lock_class *class = hlock_class(hlock);
1647         struct list_head *hash_head = chainhashentry(chain_key);
1648         struct lock_chain *chain;
1649         struct held_lock *hlock_curr, *hlock_next;
1650         int i, j, n, cn;
1651
1652         if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
1653                 return 0;
1654         /*
1655          * We can walk it lock-free, because entries only get added
1656          * to the hash:
1657          */
1658         list_for_each_entry(chain, hash_head, entry) {
1659                 if (chain->chain_key == chain_key) {
1660 cache_hit:
1661                         debug_atomic_inc(&chain_lookup_hits);
1662                         if (very_verbose(class))
1663                                 printk("\nhash chain already cached, key: "
1664                                         "%016Lx tail class: [%p] %s\n",
1665                                         (unsigned long long)chain_key,
1666                                         class->key, class->name);
1667                         return 0;
1668                 }
1669         }
1670         if (very_verbose(class))
1671                 printk("\nnew hash chain, key: %016Lx tail class: [%p] %s\n",
1672                         (unsigned long long)chain_key, class->key, class->name);
1673         /*
1674          * Allocate a new chain entry from the static array, and add
1675          * it to the hash:
1676          */
1677         if (!graph_lock())
1678                 return 0;
1679         /*
1680          * We have to walk the chain again locked - to avoid duplicates:
1681          */
1682         list_for_each_entry(chain, hash_head, entry) {
1683                 if (chain->chain_key == chain_key) {
1684                         graph_unlock();
1685                         goto cache_hit;
1686                 }
1687         }
1688         if (unlikely(nr_lock_chains >= MAX_LOCKDEP_CHAINS)) {
1689                 if (!debug_locks_off_graph_unlock())
1690                         return 0;
1691
1692                 printk("BUG: MAX_LOCKDEP_CHAINS too low!\n");
1693                 printk("turning off the locking correctness validator.\n");
1694                 return 0;
1695         }
1696         chain = lock_chains + nr_lock_chains++;
1697         chain->chain_key = chain_key;
1698         chain->irq_context = hlock->irq_context;
1699         /* Find the first held_lock of current chain */
1700         hlock_next = hlock;
1701         for (i = curr->lockdep_depth - 1; i >= 0; i--) {
1702                 hlock_curr = curr->held_locks + i;
1703                 if (hlock_curr->irq_context != hlock_next->irq_context)
1704                         break;
1705                 hlock_next = hlock;
1706         }
1707         i++;
1708         chain->depth = curr->lockdep_depth + 1 - i;
1709         cn = nr_chain_hlocks;
1710         while (cn + chain->depth <= MAX_LOCKDEP_CHAIN_HLOCKS) {
1711                 n = cmpxchg(&nr_chain_hlocks, cn, cn + chain->depth);
1712                 if (n == cn)
1713                         break;
1714                 cn = n;
1715         }
1716         if (likely(cn + chain->depth <= MAX_LOCKDEP_CHAIN_HLOCKS)) {
1717                 chain->base = cn;
1718                 for (j = 0; j < chain->depth - 1; j++, i++) {
1719                         int lock_id = curr->held_locks[i].class_idx - 1;
1720                         chain_hlocks[chain->base + j] = lock_id;
1721                 }
1722                 chain_hlocks[chain->base + j] = class - lock_classes;
1723         }
1724         list_add_tail_rcu(&chain->entry, hash_head);
1725         debug_atomic_inc(&chain_lookup_misses);
1726         inc_chains();
1727
1728         return 1;
1729 }
1730
1731 static int validate_chain(struct task_struct *curr, struct lockdep_map *lock,
1732                 struct held_lock *hlock, int chain_head, u64 chain_key)
1733 {
1734         /*
1735          * Trylock needs to maintain the stack of held locks, but it
1736          * does not add new dependencies, because trylock can be done
1737          * in any order.
1738          *
1739          * We look up the chain_key and do the O(N^2) check and update of
1740          * the dependencies only if this is a new dependency chain.
1741          * (If lookup_chain_cache() returns with 1 it acquires
1742          * graph_lock for us)
1743          */
1744         if (!hlock->trylock && (hlock->check == 2) &&
1745             lookup_chain_cache(curr, hlock, chain_key)) {
1746                 /*
1747                  * Check whether last held lock:
1748                  *
1749                  * - is irq-safe, if this lock is irq-unsafe
1750                  * - is softirq-safe, if this lock is hardirq-unsafe
1751                  *
1752                  * And check whether the new lock's dependency graph
1753                  * could lead back to the previous lock.
1754                  *
1755                  * any of these scenarios could lead to a deadlock. If
1756                  * All validations
1757                  */
1758                 int ret = check_deadlock(curr, hlock, lock, hlock->read);
1759
1760                 if (!ret)
1761                         return 0;
1762                 /*
1763                  * Mark recursive read, as we jump over it when
1764                  * building dependencies (just like we jump over
1765                  * trylock entries):
1766                  */
1767                 if (ret == 2)
1768                         hlock->read = 2;
1769                 /*
1770                  * Add dependency only if this lock is not the head
1771                  * of the chain, and if it's not a secondary read-lock:
1772                  */
1773                 if (!chain_head && ret != 2)
1774                         if (!check_prevs_add(curr, hlock))
1775                                 return 0;
1776                 graph_unlock();
1777         } else
1778                 /* after lookup_chain_cache(): */
1779                 if (unlikely(!debug_locks))
1780                         return 0;
1781
1782         return 1;
1783 }
1784 #else
1785 static inline int validate_chain(struct task_struct *curr,
1786                 struct lockdep_map *lock, struct held_lock *hlock,
1787                 int chain_head, u64 chain_key)
1788 {
1789         return 1;
1790 }
1791 #endif
1792
1793 /*
1794  * We are building curr_chain_key incrementally, so double-check
1795  * it from scratch, to make sure that it's done correctly:
1796  */
1797 static void check_chain_key(struct task_struct *curr)
1798 {
1799 #ifdef CONFIG_DEBUG_LOCKDEP
1800         struct held_lock *hlock, *prev_hlock = NULL;
1801         unsigned int i, id;
1802         u64 chain_key = 0;
1803
1804         for (i = 0; i < curr->lockdep_depth; i++) {
1805                 hlock = curr->held_locks + i;
1806                 if (chain_key != hlock->prev_chain_key) {
1807                         debug_locks_off();
1808                         WARN(1, "hm#1, depth: %u [%u], %016Lx != %016Lx\n",
1809                                 curr->lockdep_depth, i,
1810                                 (unsigned long long)chain_key,
1811                                 (unsigned long long)hlock->prev_chain_key);
1812                         return;
1813                 }
1814                 id = hlock->class_idx - 1;
1815                 if (DEBUG_LOCKS_WARN_ON(id >= MAX_LOCKDEP_KEYS))
1816                         return;
1817
1818                 if (prev_hlock && (prev_hlock->irq_context !=
1819                                                         hlock->irq_context))
1820                         chain_key = 0;
1821                 chain_key = iterate_chain_key(chain_key, id);
1822                 prev_hlock = hlock;
1823         }
1824         if (chain_key != curr->curr_chain_key) {
1825                 debug_locks_off();
1826                 WARN(1, "hm#2, depth: %u [%u], %016Lx != %016Lx\n",
1827                         curr->lockdep_depth, i,
1828                         (unsigned long long)chain_key,
1829                         (unsigned long long)curr->curr_chain_key);
1830         }
1831 #endif
1832 }
1833
1834 static int
1835 print_usage_bug(struct task_struct *curr, struct held_lock *this,
1836                 enum lock_usage_bit prev_bit, enum lock_usage_bit new_bit)
1837 {
1838         if (!debug_locks_off_graph_unlock() || debug_locks_silent)
1839                 return 0;
1840
1841         printk("\n=================================\n");
1842         printk(  "[ INFO: inconsistent lock state ]\n");
1843         print_kernel_version();
1844         printk(  "---------------------------------\n");
1845
1846         printk("inconsistent {%s} -> {%s} usage.\n",
1847                 usage_str[prev_bit], usage_str[new_bit]);
1848
1849         printk("%s/%d [HC%u[%lu]:SC%u[%lu]:HE%u:SE%u] takes:\n",
1850                 curr->comm, task_pid_nr(curr),
1851                 trace_hardirq_context(curr), hardirq_count() >> HARDIRQ_SHIFT,
1852                 trace_softirq_context(curr), softirq_count() >> SOFTIRQ_SHIFT,
1853                 trace_hardirqs_enabled(curr),
1854                 trace_softirqs_enabled(curr));
1855         print_lock(this);
1856
1857         printk("{%s} state was registered at:\n", usage_str[prev_bit]);
1858         print_stack_trace(hlock_class(this)->usage_traces + prev_bit, 1);
1859
1860         print_irqtrace_events(curr);
1861         printk("\nother info that might help us debug this:\n");
1862         lockdep_print_held_locks(curr);
1863
1864         printk("\nstack backtrace:\n");
1865         dump_stack();
1866
1867         return 0;
1868 }
1869
1870 /*
1871  * Print out an error if an invalid bit is set:
1872  */
1873 static inline int
1874 valid_state(struct task_struct *curr, struct held_lock *this,
1875             enum lock_usage_bit new_bit, enum lock_usage_bit bad_bit)
1876 {
1877         if (unlikely(hlock_class(this)->usage_mask & (1 << bad_bit)))
1878                 return print_usage_bug(curr, this, bad_bit, new_bit);
1879         return 1;
1880 }
1881
1882 static int mark_lock(struct task_struct *curr, struct held_lock *this,
1883                      enum lock_usage_bit new_bit);
1884
1885 #if defined(CONFIG_TRACE_IRQFLAGS) && defined(CONFIG_PROVE_LOCKING)
1886
1887 /*
1888  * print irq inversion bug:
1889  */
1890 static int
1891 print_irq_inversion_bug(struct task_struct *curr, struct lock_class *other,
1892                         struct held_lock *this, int forwards,
1893                         const char *irqclass)
1894 {
1895         if (!debug_locks_off_graph_unlock() || debug_locks_silent)
1896                 return 0;
1897
1898         printk("\n=========================================================\n");
1899         printk(  "[ INFO: possible irq lock inversion dependency detected ]\n");
1900         print_kernel_version();
1901         printk(  "---------------------------------------------------------\n");
1902         printk("%s/%d just changed the state of lock:\n",
1903                 curr->comm, task_pid_nr(curr));
1904         print_lock(this);
1905         if (forwards)
1906                 printk("but this lock took another, %s-irq-unsafe lock in the past:\n", irqclass);
1907         else
1908                 printk("but this lock was taken by another, %s-irq-safe lock in the past:\n", irqclass);
1909         print_lock_name(other);
1910         printk("\n\nand interrupts could create inverse lock ordering between them.\n\n");
1911
1912         printk("\nother info that might help us debug this:\n");
1913         lockdep_print_held_locks(curr);
1914
1915         printk("\nthe first lock's dependencies:\n");
1916         print_lock_dependencies(hlock_class(this), 0);
1917
1918         printk("\nthe second lock's dependencies:\n");
1919         print_lock_dependencies(other, 0);
1920
1921         printk("\nstack backtrace:\n");
1922         dump_stack();
1923
1924         return 0;
1925 }
1926
1927 /*
1928  * Prove that in the forwards-direction subgraph starting at <this>
1929  * there is no lock matching <mask>:
1930  */
1931 static int
1932 check_usage_forwards(struct task_struct *curr, struct held_lock *this,
1933                      enum lock_usage_bit bit, const char *irqclass)
1934 {
1935         int ret;
1936
1937         find_usage_bit = bit;
1938         /* fills in <forwards_match> */
1939         ret = find_usage_forwards(hlock_class(this), 0);
1940         if (!ret || ret == 1)
1941                 return ret;
1942
1943         return print_irq_inversion_bug(curr, forwards_match, this, 1, irqclass);
1944 }
1945
1946 /*
1947  * Prove that in the backwards-direction subgraph starting at <this>
1948  * there is no lock matching <mask>:
1949  */
1950 static int
1951 check_usage_backwards(struct task_struct *curr, struct held_lock *this,
1952                       enum lock_usage_bit bit, const char *irqclass)
1953 {
1954         int ret;
1955
1956         find_usage_bit = bit;
1957         /* fills in <backwards_match> */
1958         ret = find_usage_backwards(hlock_class(this), 0);
1959         if (!ret || ret == 1)
1960                 return ret;
1961
1962         return print_irq_inversion_bug(curr, backwards_match, this, 0, irqclass);
1963 }
1964
1965 void print_irqtrace_events(struct task_struct *curr)
1966 {
1967         printk("irq event stamp: %u\n", curr->irq_events);
1968         printk("hardirqs last  enabled at (%u): ", curr->hardirq_enable_event);
1969         print_ip_sym(curr->hardirq_enable_ip);
1970         printk("hardirqs last disabled at (%u): ", curr->hardirq_disable_event);
1971         print_ip_sym(curr->hardirq_disable_ip);
1972         printk("softirqs last  enabled at (%u): ", curr->softirq_enable_event);
1973         print_ip_sym(curr->softirq_enable_ip);
1974         printk("softirqs last disabled at (%u): ", curr->softirq_disable_event);
1975         print_ip_sym(curr->softirq_disable_ip);
1976 }
1977
1978 static int HARDIRQ_verbose(struct lock_class *class)
1979 {
1980 #if HARDIRQ_VERBOSE
1981         return class_filter(class);
1982 #endif
1983         return 0;
1984 }
1985
1986 static int SOFTIRQ_verbose(struct lock_class *class)
1987 {
1988 #if SOFTIRQ_VERBOSE
1989         return class_filter(class);
1990 #endif
1991         return 0;
1992 }
1993
1994 static int RECLAIM_FS_verbose(struct lock_class *class)
1995 {
1996 #if RECLAIM_VERBOSE
1997         return class_filter(class);
1998 #endif
1999         return 0;
2000 }
2001
2002 #define STRICT_READ_CHECKS      1
2003
2004 static const char *state_names[] = {
2005 #define LOCKDEP_STATE(__STATE) \
2006         STR(__STATE),
2007 #include "lockdep_states.h"
2008 #undef LOCKDEP_STATE
2009 };
2010
2011 static inline const char *state_name(enum lock_usage_bit bit)
2012 {
2013         return state_names[bit >> 2];
2014 }
2015
2016 static const char *state_rnames[] = {
2017 #define LOCKDEP_STATE(__STATE) \
2018         STR(__STATE)"-READ",
2019 #include "lockdep_states.h"
2020 #undef LOCKDEP_STATE
2021 };
2022
2023 static inline const char *state_rname(enum lock_usage_bit bit)
2024 {
2025         return state_rnames[bit >> 2];
2026 }
2027
2028 static int (*state_verbose_f[])(struct lock_class *class) = {
2029 #define LOCKDEP_STATE(__STATE) \
2030         __STATE##_verbose,
2031 #include "lockdep_states.h"
2032 #undef LOCKDEP_STATE
2033 };
2034
2035 static inline int state_verbose(enum lock_usage_bit bit,
2036                                 struct lock_class *class)
2037 {
2038         return state_verbose_f[bit >> 2](class);
2039 }
2040
2041 static int exclusive_bit(int new_bit)
2042 {
2043         /*
2044          * USED_IN
2045          * USED_IN_READ
2046          * ENABLED
2047          * ENABLED_READ
2048          *
2049          * bit 0 - write/read
2050          * bit 1 - used_in/enabled
2051          * bit 2+  state
2052          */
2053
2054         int state = new_bit & ~3;
2055         int dir = new_bit & 2;
2056
2057         return state | (dir ^ 2);
2058 }
2059
2060 typedef int (*check_usage_f)(struct task_struct *, struct held_lock *,
2061                              enum lock_usage_bit bit, const char *name);
2062
2063 static int
2064 mark_lock_irq(struct task_struct *curr, struct held_lock *this, int new_bit)
2065 {
2066         const char *name = state_name(new_bit);
2067         const char *rname = state_rname(new_bit);
2068
2069         int excl_bit = exclusive_bit(new_bit);
2070         int read = new_bit & 1;
2071         int dir = new_bit & 2;
2072
2073         check_usage_f usage = dir ?
2074                 check_usage_backwards : check_usage_forwards;
2075
2076         if (!valid_state(curr, this, new_bit, excl_bit))
2077                 return 0;
2078
2079         if (!read && !valid_state(curr, this, new_bit, excl_bit + 1))
2080                 return 0;
2081
2082         if ((!read || (!dir || STRICT_READ_CHECKS)) &&
2083                         !usage(curr, this, excl_bit, name))
2084                 return 0;
2085
2086         if ((!read && STRICT_READ_CHECKS) &&
2087                         !usage(curr, this, excl_bit + 1, rname))
2088                 return 0;
2089
2090         if (state_verbose(new_bit, hlock_class(this)))
2091                 return 2;
2092
2093         return 1;
2094 }
2095
2096 enum mark_type {
2097 #define LOCKDEP_STATE(__STATE)  __STATE,
2098 #include "lockdep_states.h"
2099 #undef LOCKDEP_STATE
2100 };
2101
2102 #define MARK_HELD_CASE(__STATE)                                         \
2103         case __STATE:                                                   \
2104                 if (hlock->read)                                        \
2105                         usage_bit = LOCK_ENABLED_##__STATE##_READ;      \
2106                 else                                                    \
2107                         usage_bit = LOCK_ENABLED_##__STATE;             \
2108                 break;
2109
2110 /*
2111  * Mark all held locks with a usage bit:
2112  */
2113 static int
2114 mark_held_locks(struct task_struct *curr, enum mark_type mark)
2115 {
2116         enum lock_usage_bit usage_bit;
2117         struct held_lock *hlock;
2118         int i;
2119
2120         for (i = 0; i < curr->lockdep_depth; i++) {
2121                 hlock = curr->held_locks + i;
2122
2123                 switch (mark) {
2124 #define LOCKDEP_STATE(__STATE) MARK_HELD_CASE(__STATE)
2125 #include "lockdep_states.h"
2126 #undef LOCKDEP_STATE
2127                 default:
2128                         BUG();
2129                 }
2130
2131                 if (!mark_lock(curr, hlock, usage_bit))
2132                         return 0;
2133         }
2134
2135         return 1;
2136 }
2137
2138 /*
2139  * Debugging helper: via this flag we know that we are in
2140  * 'early bootup code', and will warn about any invalid irqs-on event:
2141  */
2142 static int early_boot_irqs_enabled;
2143
2144 void early_boot_irqs_off(void)
2145 {
2146         early_boot_irqs_enabled = 0;
2147 }
2148
2149 void early_boot_irqs_on(void)
2150 {
2151         early_boot_irqs_enabled = 1;
2152 }
2153
2154 /*
2155  * Hardirqs will be enabled:
2156  */
2157 void trace_hardirqs_on_caller(unsigned long ip)
2158 {
2159         struct task_struct *curr = current;
2160
2161         time_hardirqs_on(CALLER_ADDR0, ip);
2162
2163         if (unlikely(!debug_locks || current->lockdep_recursion))
2164                 return;
2165
2166         if (DEBUG_LOCKS_WARN_ON(unlikely(!early_boot_irqs_enabled)))
2167                 return;
2168
2169         if (unlikely(curr->hardirqs_enabled)) {
2170                 debug_atomic_inc(&redundant_hardirqs_on);
2171                 return;
2172         }
2173         /* we'll do an OFF -> ON transition: */
2174         curr->hardirqs_enabled = 1;
2175
2176         if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
2177                 return;
2178         if (DEBUG_LOCKS_WARN_ON(current->hardirq_context))
2179                 return;
2180         /*
2181          * We are going to turn hardirqs on, so set the
2182          * usage bit for all held locks:
2183          */
2184         if (!mark_held_locks(curr, HARDIRQ))
2185                 return;
2186         /*
2187          * If we have softirqs enabled, then set the usage
2188          * bit for all held locks. (disabled hardirqs prevented
2189          * this bit from being set before)
2190          */
2191         if (curr->softirqs_enabled)
2192                 if (!mark_held_locks(curr, SOFTIRQ))
2193                         return;
2194
2195         curr->hardirq_enable_ip = ip;
2196         curr->hardirq_enable_event = ++curr->irq_events;
2197         debug_atomic_inc(&hardirqs_on_events);
2198 }
2199 EXPORT_SYMBOL(trace_hardirqs_on_caller);
2200
2201 void trace_hardirqs_on(void)
2202 {
2203         trace_hardirqs_on_caller(CALLER_ADDR0);
2204 }
2205 EXPORT_SYMBOL(trace_hardirqs_on);
2206
2207 /*
2208  * Hardirqs were disabled:
2209  */
2210 void trace_hardirqs_off_caller(unsigned long ip)
2211 {
2212         struct task_struct *curr = current;
2213
2214         time_hardirqs_off(CALLER_ADDR0, ip);
2215
2216         if (unlikely(!debug_locks || current->lockdep_recursion))
2217                 return;
2218
2219         if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
2220                 return;
2221
2222         if (curr->hardirqs_enabled) {
2223                 /*
2224                  * We have done an ON -> OFF transition:
2225                  */
2226                 curr->hardirqs_enabled = 0;
2227                 curr->hardirq_disable_ip = ip;
2228                 curr->hardirq_disable_event = ++curr->irq_events;
2229                 debug_atomic_inc(&hardirqs_off_events);
2230         } else
2231                 debug_atomic_inc(&redundant_hardirqs_off);
2232 }
2233 EXPORT_SYMBOL(trace_hardirqs_off_caller);
2234
2235 void trace_hardirqs_off(void)
2236 {
2237         trace_hardirqs_off_caller(CALLER_ADDR0);
2238 }
2239 EXPORT_SYMBOL(trace_hardirqs_off);
2240
2241 /*
2242  * Softirqs will be enabled:
2243  */
2244 void trace_softirqs_on(unsigned long ip)
2245 {
2246         struct task_struct *curr = current;
2247
2248         if (unlikely(!debug_locks))
2249                 return;
2250
2251         if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
2252                 return;
2253
2254         if (curr->softirqs_enabled) {
2255                 debug_atomic_inc(&redundant_softirqs_on);
2256                 return;
2257         }
2258
2259         /*
2260          * We'll do an OFF -> ON transition:
2261          */
2262         curr->softirqs_enabled = 1;
2263         curr->softirq_enable_ip = ip;
2264         curr->softirq_enable_event = ++curr->irq_events;
2265         debug_atomic_inc(&softirqs_on_events);
2266         /*
2267          * We are going to turn softirqs on, so set the
2268          * usage bit for all held locks, if hardirqs are
2269          * enabled too:
2270          */
2271         if (curr->hardirqs_enabled)
2272                 mark_held_locks(curr, SOFTIRQ);
2273 }
2274
2275 /*
2276  * Softirqs were disabled:
2277  */
2278 void trace_softirqs_off(unsigned long ip)
2279 {
2280         struct task_struct *curr = current;
2281
2282         if (unlikely(!debug_locks))
2283                 return;
2284
2285         if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
2286                 return;
2287
2288         if (curr->softirqs_enabled) {
2289                 /*
2290                  * We have done an ON -> OFF transition:
2291                  */
2292                 curr->softirqs_enabled = 0;
2293                 curr->softirq_disable_ip = ip;
2294                 curr->softirq_disable_event = ++curr->irq_events;
2295                 debug_atomic_inc(&softirqs_off_events);
2296                 DEBUG_LOCKS_WARN_ON(!softirq_count());
2297         } else
2298                 debug_atomic_inc(&redundant_softirqs_off);
2299 }
2300
2301 void lockdep_trace_alloc(gfp_t gfp_mask)
2302 {
2303         struct task_struct *curr = current;
2304
2305         if (unlikely(!debug_locks))
2306                 return;
2307
2308         /* no reclaim without waiting on it */
2309         if (!(gfp_mask & __GFP_WAIT))
2310                 return;
2311
2312         /* this guy won't enter reclaim */
2313         if ((curr->flags & PF_MEMALLOC) && !(gfp_mask & __GFP_NOMEMALLOC))
2314                 return;
2315
2316         /* We're only interested __GFP_FS allocations for now */
2317         if (!(gfp_mask & __GFP_FS))
2318                 return;
2319
2320         if (DEBUG_LOCKS_WARN_ON(irqs_disabled()))
2321                 return;
2322
2323         mark_held_locks(curr, RECLAIM_FS);
2324 }
2325
2326 static int mark_irqflags(struct task_struct *curr, struct held_lock *hlock)
2327 {
2328         /*
2329          * If non-trylock use in a hardirq or softirq context, then
2330          * mark the lock as used in these contexts:
2331          */
2332         if (!hlock->trylock) {
2333                 if (hlock->read) {
2334                         if (curr->hardirq_context)
2335                                 if (!mark_lock(curr, hlock,
2336                                                 LOCK_USED_IN_HARDIRQ_READ))
2337                                         return 0;
2338                         if (curr->softirq_context)
2339                                 if (!mark_lock(curr, hlock,
2340                                                 LOCK_USED_IN_SOFTIRQ_READ))
2341                                         return 0;
2342                 } else {
2343                         if (curr->hardirq_context)
2344                                 if (!mark_lock(curr, hlock, LOCK_USED_IN_HARDIRQ))
2345                                         return 0;
2346                         if (curr->softirq_context)
2347                                 if (!mark_lock(curr, hlock, LOCK_USED_IN_SOFTIRQ))
2348                                         return 0;
2349                 }
2350         }
2351         if (!hlock->hardirqs_off) {
2352                 if (hlock->read) {
2353                         if (!mark_lock(curr, hlock,
2354                                         LOCK_ENABLED_HARDIRQ_READ))
2355                                 return 0;
2356                         if (curr->softirqs_enabled)
2357                                 if (!mark_lock(curr, hlock,
2358                                                 LOCK_ENABLED_SOFTIRQ_READ))
2359                                         return 0;
2360                 } else {
2361                         if (!mark_lock(curr, hlock,
2362                                         LOCK_ENABLED_HARDIRQ))
2363                                 return 0;
2364                         if (curr->softirqs_enabled)
2365                                 if (!mark_lock(curr, hlock,
2366                                                 LOCK_ENABLED_SOFTIRQ))
2367                                         return 0;
2368                 }
2369         }
2370
2371         /*
2372          * We reuse the irq context infrastructure more broadly as a general
2373          * context checking code. This tests GFP_FS recursion (a lock taken
2374          * during reclaim for a GFP_FS allocation is held over a GFP_FS
2375          * allocation).
2376          */
2377         if (!hlock->trylock && (curr->lockdep_reclaim_gfp & __GFP_FS)) {
2378                 if (hlock->read) {
2379                         if (!mark_lock(curr, hlock, LOCK_USED_IN_RECLAIM_FS_READ))
2380                                         return 0;
2381                 } else {
2382                         if (!mark_lock(curr, hlock, LOCK_USED_IN_RECLAIM_FS))
2383                                         return 0;
2384                 }
2385         }
2386
2387         return 1;
2388 }
2389
2390 static int separate_irq_context(struct task_struct *curr,
2391                 struct held_lock *hlock)
2392 {
2393         unsigned int depth = curr->lockdep_depth;
2394
2395         /*
2396          * Keep track of points where we cross into an interrupt context:
2397          */
2398         hlock->irq_context = 2*(curr->hardirq_context ? 1 : 0) +
2399                                 curr->softirq_context;
2400         if (depth) {
2401                 struct held_lock *prev_hlock;
2402
2403                 prev_hlock = curr->held_locks + depth-1;
2404                 /*
2405                  * If we cross into another context, reset the
2406                  * hash key (this also prevents the checking and the
2407                  * adding of the dependency to 'prev'):
2408                  */
2409                 if (prev_hlock->irq_context != hlock->irq_context)
2410                         return 1;
2411         }
2412         return 0;
2413 }
2414
2415 #else
2416
2417 static inline
2418 int mark_lock_irq(struct task_struct *curr, struct held_lock *this,
2419                 enum lock_usage_bit new_bit)
2420 {
2421         WARN_ON(1);
2422         return 1;
2423 }
2424
2425 static inline int mark_irqflags(struct task_struct *curr,
2426                 struct held_lock *hlock)
2427 {
2428         return 1;
2429 }
2430
2431 static inline int separate_irq_context(struct task_struct *curr,
2432                 struct held_lock *hlock)
2433 {
2434         return 0;
2435 }
2436
2437 #endif
2438
2439 /*
2440  * Mark a lock with a usage bit, and validate the state transition:
2441  */
2442 static int mark_lock(struct task_struct *curr, struct held_lock *this,
2443                              enum lock_usage_bit new_bit)
2444 {
2445         unsigned int new_mask = 1 << new_bit, ret = 1;
2446
2447         /*
2448          * If already set then do not dirty the cacheline,
2449          * nor do any checks:
2450          */
2451         if (likely(hlock_class(this)->usage_mask & new_mask))
2452                 return 1;
2453
2454         if (!graph_lock())
2455                 return 0;
2456         /*
2457          * Make sure we didnt race:
2458          */
2459         if (unlikely(hlock_class(this)->usage_mask & new_mask)) {
2460                 graph_unlock();
2461                 return 1;
2462         }
2463
2464         hlock_class(this)->usage_mask |= new_mask;
2465
2466         if (!save_trace(hlock_class(this)->usage_traces + new_bit))
2467                 return 0;
2468
2469         switch (new_bit) {
2470 #define LOCKDEP_STATE(__STATE)                  \
2471         case LOCK_USED_IN_##__STATE:            \
2472         case LOCK_USED_IN_##__STATE##_READ:     \
2473         case LOCK_ENABLED_##__STATE:            \
2474         case LOCK_ENABLED_##__STATE##_READ:
2475 #include "lockdep_states.h"
2476 #undef LOCKDEP_STATE
2477                 ret = mark_lock_irq(curr, this, new_bit);
2478                 if (!ret)
2479                         return 0;
2480                 break;
2481         case LOCK_USED:
2482                 debug_atomic_dec(&nr_unused_locks);
2483                 break;
2484         default:
2485                 if (!debug_locks_off_graph_unlock())
2486                         return 0;
2487                 WARN_ON(1);
2488                 return 0;
2489         }
2490
2491         graph_unlock();
2492
2493         /*
2494          * We must printk outside of the graph_lock:
2495          */
2496         if (ret == 2) {
2497                 printk("\nmarked lock as {%s}:\n", usage_str[new_bit]);
2498                 print_lock(this);
2499                 print_irqtrace_events(curr);
2500                 dump_stack();
2501         }
2502
2503         return ret;
2504 }
2505
2506 /*
2507  * Initialize a lock instance's lock-class mapping info:
2508  */
2509 void lockdep_init_map(struct lockdep_map *lock, const char *name,
2510                       struct lock_class_key *key, int subclass)
2511 {
2512         if (unlikely(!debug_locks))
2513                 return;
2514
2515         if (DEBUG_LOCKS_WARN_ON(!key))
2516                 return;
2517         if (DEBUG_LOCKS_WARN_ON(!name))
2518                 return;
2519         /*
2520          * Sanity check, the lock-class key must be persistent:
2521          */
2522         if (!static_obj(key)) {
2523                 printk("BUG: key %p not in .data!\n", key);
2524                 DEBUG_LOCKS_WARN_ON(1);
2525                 return;
2526         }
2527         lock->name = name;
2528         lock->key = key;
2529         lock->class_cache = NULL;
2530 #ifdef CONFIG_LOCK_STAT
2531         lock->cpu = raw_smp_processor_id();
2532 #endif
2533         if (subclass)
2534                 register_lock_class(lock, subclass, 1);
2535 }
2536 EXPORT_SYMBOL_GPL(lockdep_init_map);
2537
2538 /*
2539  * This gets called for every mutex_lock*()/spin_lock*() operation.
2540  * We maintain the dependency maps and validate the locking attempt:
2541  */
2542 static int __lock_acquire(struct lockdep_map *lock, unsigned int subclass,
2543                           int trylock, int read, int check, int hardirqs_off,
2544                           struct lockdep_map *nest_lock, unsigned long ip)
2545 {
2546         struct task_struct *curr = current;
2547         struct lock_class *class = NULL;
2548         struct held_lock *hlock;
2549         unsigned int depth, id;
2550         int chain_head = 0;
2551         u64 chain_key;
2552
2553         if (!prove_locking)
2554                 check = 1;
2555
2556         if (unlikely(!debug_locks))
2557                 return 0;
2558
2559         if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
2560                 return 0;
2561
2562         if (unlikely(subclass >= MAX_LOCKDEP_SUBCLASSES)) {
2563                 debug_locks_off();
2564                 printk("BUG: MAX_LOCKDEP_SUBCLASSES too low!\n");
2565                 printk("turning off the locking correctness validator.\n");
2566                 return 0;
2567         }
2568
2569         if (!subclass)
2570                 class = lock->class_cache;
2571         /*
2572          * Not cached yet or subclass?
2573          */
2574         if (unlikely(!class)) {
2575                 class = register_lock_class(lock, subclass, 0);
2576                 if (!class)
2577                         return 0;
2578         }
2579         debug_atomic_inc((atomic_t *)&class->ops);
2580         if (very_verbose(class)) {
2581                 printk("\nacquire class [%p] %s", class->key, class->name);
2582                 if (class->name_version > 1)
2583                         printk("#%d", class->name_version);
2584                 printk("\n");
2585                 dump_stack();
2586         }
2587
2588         /*
2589          * Add the lock to the list of currently held locks.
2590          * (we dont increase the depth just yet, up until the
2591          * dependency checks are done)
2592          */
2593         depth = curr->lockdep_depth;
2594         if (DEBUG_LOCKS_WARN_ON(depth >= MAX_LOCK_DEPTH))
2595                 return 0;
2596
2597         hlock = curr->held_locks + depth;
2598         if (DEBUG_LOCKS_WARN_ON(!class))
2599                 return 0;
2600         hlock->class_idx = class - lock_classes + 1;
2601         hlock->acquire_ip = ip;
2602         hlock->instance = lock;
2603         hlock->nest_lock = nest_lock;
2604         hlock->trylock = trylock;
2605         hlock->read = read;
2606         hlock->check = check;
2607         hlock->hardirqs_off = !!hardirqs_off;
2608 #ifdef CONFIG_LOCK_STAT
2609         hlock->waittime_stamp = 0;
2610         hlock->holdtime_stamp = sched_clock();
2611 #endif
2612
2613         if (check == 2 && !mark_irqflags(curr, hlock))
2614                 return 0;
2615
2616         /* mark it as used: */
2617         if (!mark_lock(curr, hlock, LOCK_USED))
2618                 return 0;
2619
2620         /*
2621          * Calculate the chain hash: it's the combined hash of all the
2622          * lock keys along the dependency chain. We save the hash value
2623          * at every step so that we can get the current hash easily
2624          * after unlock. The chain hash is then used to cache dependency
2625          * results.
2626          *
2627          * The 'key ID' is what is the most compact key value to drive
2628          * the hash, not class->key.
2629          */
2630         id = class - lock_classes;
2631         if (DEBUG_LOCKS_WARN_ON(id >= MAX_LOCKDEP_KEYS))
2632                 return 0;
2633
2634         chain_key = curr->curr_chain_key;
2635         if (!depth) {
2636                 if (DEBUG_LOCKS_WARN_ON(chain_key != 0))
2637                         return 0;
2638                 chain_head = 1;
2639         }
2640
2641         hlock->prev_chain_key = chain_key;
2642         if (separate_irq_context(curr, hlock)) {
2643                 chain_key = 0;
2644                 chain_head = 1;
2645         }
2646         chain_key = iterate_chain_key(chain_key, id);
2647
2648         if (!validate_chain(curr, lock, hlock, chain_head, chain_key))
2649                 return 0;
2650
2651         curr->curr_chain_key = chain_key;
2652         curr->lockdep_depth++;
2653         check_chain_key(curr);
2654 #ifdef CONFIG_DEBUG_LOCKDEP
2655         if (unlikely(!debug_locks))
2656                 return 0;
2657 #endif
2658         if (unlikely(curr->lockdep_depth >= MAX_LOCK_DEPTH)) {
2659                 debug_locks_off();
2660                 printk("BUG: MAX_LOCK_DEPTH too low!\n");
2661                 printk("turning off the locking correctness validator.\n");
2662                 return 0;
2663         }
2664
2665         if (unlikely(curr->lockdep_depth > max_lockdep_depth))
2666                 max_lockdep_depth = curr->lockdep_depth;
2667
2668         return 1;
2669 }
2670
2671 static int
2672 print_unlock_inbalance_bug(struct task_struct *curr, struct lockdep_map *lock,
2673                            unsigned long ip)
2674 {
2675         if (!debug_locks_off())
2676                 return 0;
2677         if (debug_locks_silent)
2678                 return 0;
2679
2680         printk("\n=====================================\n");
2681         printk(  "[ BUG: bad unlock balance detected! ]\n");
2682         printk(  "-------------------------------------\n");
2683         printk("%s/%d is trying to release lock (",
2684                 curr->comm, task_pid_nr(curr));
2685         print_lockdep_cache(lock);
2686         printk(") at:\n");
2687         print_ip_sym(ip);
2688         printk("but there are no more locks to release!\n");
2689         printk("\nother info that might help us debug this:\n");
2690         lockdep_print_held_locks(curr);
2691
2692         printk("\nstack backtrace:\n");
2693         dump_stack();
2694
2695         return 0;
2696 }
2697
2698 /*
2699  * Common debugging checks for both nested and non-nested unlock:
2700  */
2701 static int check_unlock(struct task_struct *curr, struct lockdep_map *lock,
2702                         unsigned long ip)
2703 {
2704         if (unlikely(!debug_locks))
2705                 return 0;
2706         if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
2707                 return 0;
2708
2709         if (curr->lockdep_depth <= 0)
2710                 return print_unlock_inbalance_bug(curr, lock, ip);
2711
2712         return 1;
2713 }
2714
2715 static int
2716 __lock_set_class(struct lockdep_map *lock, const char *name,
2717                  struct lock_class_key *key, unsigned int subclass,
2718                  unsigned long ip)
2719 {
2720         struct task_struct *curr = current;
2721         struct held_lock *hlock, *prev_hlock;
2722         struct lock_class *class;
2723         unsigned int depth;
2724         int i;
2725
2726         depth = curr->lockdep_depth;
2727         if (DEBUG_LOCKS_WARN_ON(!depth))
2728                 return 0;
2729
2730         prev_hlock = NULL;
2731         for (i = depth-1; i >= 0; i--) {
2732                 hlock = curr->held_locks + i;
2733                 /*
2734                  * We must not cross into another context:
2735                  */
2736                 if (prev_hlock && prev_hlock->irq_context != hlock->irq_context)
2737                         break;
2738                 if (hlock->instance == lock)
2739                         goto found_it;
2740                 prev_hlock = hlock;
2741         }
2742         return print_unlock_inbalance_bug(curr, lock, ip);
2743
2744 found_it:
2745         lockdep_init_map(lock, name, key, 0);
2746         class = register_lock_class(lock, subclass, 0);
2747         hlock->class_idx = class - lock_classes + 1;
2748
2749         curr->lockdep_depth = i;
2750         curr->curr_chain_key = hlock->prev_chain_key;
2751
2752         for (; i < depth; i++) {
2753                 hlock = curr->held_locks + i;
2754                 if (!__lock_acquire(hlock->instance,
2755                         hlock_class(hlock)->subclass, hlock->trylock,
2756                                 hlock->read, hlock->check, hlock->hardirqs_off,
2757                                 hlock->nest_lock, hlock->acquire_ip))
2758                         return 0;
2759         }
2760
2761         if (DEBUG_LOCKS_WARN_ON(curr->lockdep_depth != depth))
2762                 return 0;
2763         return 1;
2764 }
2765
2766 /*
2767  * Remove the lock to the list of currently held locks in a
2768  * potentially non-nested (out of order) manner. This is a
2769  * relatively rare operation, as all the unlock APIs default
2770  * to nested mode (which uses lock_release()):
2771  */
2772 static int
2773 lock_release_non_nested(struct task_struct *curr,
2774                         struct lockdep_map *lock, unsigned long ip)
2775 {
2776         struct held_lock *hlock, *prev_hlock;
2777         unsigned int depth;
2778         int i;
2779
2780         /*
2781          * Check whether the lock exists in the current stack
2782          * of held locks:
2783          */
2784         depth = curr->lockdep_depth;
2785         if (DEBUG_LOCKS_WARN_ON(!depth))
2786                 return 0;
2787
2788         prev_hlock = NULL;
2789         for (i = depth-1; i >= 0; i--) {
2790                 hlock = curr->held_locks + i;
2791                 /*
2792                  * We must not cross into another context:
2793                  */
2794                 if (prev_hlock && prev_hlock->irq_context != hlock->irq_context)
2795                         break;
2796                 if (hlock->instance == lock)
2797                         goto found_it;
2798                 prev_hlock = hlock;
2799         }
2800         return print_unlock_inbalance_bug(curr, lock, ip);
2801
2802 found_it:
2803         lock_release_holdtime(hlock);
2804
2805         /*
2806          * We have the right lock to unlock, 'hlock' points to it.
2807          * Now we remove it from the stack, and add back the other
2808          * entries (if any), recalculating the hash along the way:
2809          */
2810         curr->lockdep_depth = i;
2811         curr->curr_chain_key = hlock->prev_chain_key;
2812
2813         for (i++; i < depth; i++) {
2814                 hlock = curr->held_locks + i;
2815                 if (!__lock_acquire(hlock->instance,
2816                         hlock_class(hlock)->subclass, hlock->trylock,
2817                                 hlock->read, hlock->check, hlock->hardirqs_off,
2818                                 hlock->nest_lock, hlock->acquire_ip))
2819                         return 0;
2820         }
2821
2822         if (DEBUG_LOCKS_WARN_ON(curr->lockdep_depth != depth - 1))
2823                 return 0;
2824         return 1;
2825 }
2826
2827 /*
2828  * Remove the lock to the list of currently held locks - this gets
2829  * called on mutex_unlock()/spin_unlock*() (or on a failed
2830  * mutex_lock_interruptible()). This is done for unlocks that nest
2831  * perfectly. (i.e. the current top of the lock-stack is unlocked)
2832  */
2833 static int lock_release_nested(struct task_struct *curr,
2834                                struct lockdep_map *lock, unsigned long ip)
2835 {
2836         struct held_lock *hlock;
2837         unsigned int depth;
2838
2839         /*
2840          * Pop off the top of the lock stack:
2841          */
2842         depth = curr->lockdep_depth - 1;
2843         hlock = curr->held_locks + depth;
2844
2845         /*
2846          * Is the unlock non-nested:
2847          */
2848         if (hlock->instance != lock)
2849                 return lock_release_non_nested(curr, lock, ip);
2850         curr->lockdep_depth--;
2851
2852         if (DEBUG_LOCKS_WARN_ON(!depth && (hlock->prev_chain_key != 0)))
2853                 return 0;
2854
2855         curr->curr_chain_key = hlock->prev_chain_key;
2856
2857         lock_release_holdtime(hlock);
2858
2859 #ifdef CONFIG_DEBUG_LOCKDEP
2860         hlock->prev_chain_key = 0;
2861         hlock->class_idx = 0;
2862         hlock->acquire_ip = 0;
2863         hlock->irq_context = 0;
2864 #endif
2865         return 1;
2866 }
2867
2868 /*
2869  * Remove the lock to the list of currently held locks - this gets
2870  * called on mutex_unlock()/spin_unlock*() (or on a failed
2871  * mutex_lock_interruptible()). This is done for unlocks that nest
2872  * perfectly. (i.e. the current top of the lock-stack is unlocked)
2873  */
2874 static void
2875 __lock_release(struct lockdep_map *lock, int nested, unsigned long ip)
2876 {
2877         struct task_struct *curr = current;
2878
2879         if (!check_unlock(curr, lock, ip))
2880                 return;
2881
2882         if (nested) {
2883                 if (!lock_release_nested(curr, lock, ip))
2884                         return;
2885         } else {
2886                 if (!lock_release_non_nested(curr, lock, ip))
2887                         return;
2888         }
2889
2890         check_chain_key(curr);
2891 }
2892
2893 /*
2894  * Check whether we follow the irq-flags state precisely:
2895  */
2896 static void check_flags(unsigned long flags)
2897 {
2898 #if defined(CONFIG_PROVE_LOCKING) && defined(CONFIG_DEBUG_LOCKDEP) && \
2899     defined(CONFIG_TRACE_IRQFLAGS)
2900         if (!debug_locks)
2901                 return;
2902
2903         if (irqs_disabled_flags(flags)) {
2904                 if (DEBUG_LOCKS_WARN_ON(current->hardirqs_enabled)) {
2905                         printk("possible reason: unannotated irqs-off.\n");
2906                 }
2907         } else {
2908                 if (DEBUG_LOCKS_WARN_ON(!current->hardirqs_enabled)) {
2909                         printk("possible reason: unannotated irqs-on.\n");
2910                 }
2911         }
2912
2913         /*
2914          * We dont accurately track softirq state in e.g.
2915          * hardirq contexts (such as on 4KSTACKS), so only
2916          * check if not in hardirq contexts:
2917          */
2918         if (!hardirq_count()) {
2919                 if (softirq_count())
2920                         DEBUG_LOCKS_WARN_ON(current->softirqs_enabled);
2921                 else
2922                         DEBUG_LOCKS_WARN_ON(!current->softirqs_enabled);
2923         }
2924
2925         if (!debug_locks)
2926                 print_irqtrace_events(current);
2927 #endif
2928 }
2929
2930 void lock_set_class(struct lockdep_map *lock, const char *name,
2931                     struct lock_class_key *key, unsigned int subclass,
2932                     unsigned long ip)
2933 {
2934         unsigned long flags;
2935
2936         if (unlikely(current->lockdep_recursion))
2937                 return;
2938
2939         raw_local_irq_save(flags);
2940         current->lockdep_recursion = 1;
2941         check_flags(flags);
2942         if (__lock_set_class(lock, name, key, subclass, ip))
2943                 check_chain_key(current);
2944         current->lockdep_recursion = 0;
2945         raw_local_irq_restore(flags);
2946 }
2947 EXPORT_SYMBOL_GPL(lock_set_class);
2948
2949 /*
2950  * We are not always called with irqs disabled - do that here,
2951  * and also avoid lockdep recursion:
2952  */
2953 void lock_acquire(struct lockdep_map *lock, unsigned int subclass,
2954                           int trylock, int read, int check,
2955                           struct lockdep_map *nest_lock, unsigned long ip)
2956 {
2957         unsigned long flags;
2958
2959         if (unlikely(current->lockdep_recursion))
2960                 return;
2961
2962         raw_local_irq_save(flags);
2963         check_flags(flags);
2964
2965         current->lockdep_recursion = 1;
2966         __lock_acquire(lock, subclass, trylock, read, check,
2967                        irqs_disabled_flags(flags), nest_lock, ip);
2968         current->lockdep_recursion = 0;
2969         raw_local_irq_restore(flags);
2970 }
2971 EXPORT_SYMBOL_GPL(lock_acquire);
2972
2973 void lock_release(struct lockdep_map *lock, int nested,
2974                           unsigned long ip)
2975 {
2976         unsigned long flags;
2977
2978         if (unlikely(current->lockdep_recursion))
2979                 return;
2980
2981         raw_local_irq_save(flags);
2982         check_flags(flags);
2983         current->lockdep_recursion = 1;
2984         __lock_release(lock, nested, ip);
2985         current->lockdep_recursion = 0;
2986         raw_local_irq_restore(flags);
2987 }
2988 EXPORT_SYMBOL_GPL(lock_release);
2989
2990 void lockdep_set_current_reclaim_state(gfp_t gfp_mask)
2991 {
2992         current->lockdep_reclaim_gfp = gfp_mask;
2993 }
2994
2995 void lockdep_clear_current_reclaim_state(void)
2996 {
2997         current->lockdep_reclaim_gfp = 0;
2998 }
2999
3000 #ifdef CONFIG_LOCK_STAT
3001 static int
3002 print_lock_contention_bug(struct task_struct *curr, struct lockdep_map *lock,
3003                            unsigned long ip)
3004 {
3005         if (!debug_locks_off())
3006                 return 0;
3007         if (debug_locks_silent)
3008                 return 0;
3009
3010         printk("\n=================================\n");
3011         printk(  "[ BUG: bad contention detected! ]\n");
3012         printk(  "---------------------------------\n");
3013         printk("%s/%d is trying to contend lock (",
3014                 curr->comm, task_pid_nr(curr));
3015         print_lockdep_cache(lock);
3016         printk(") at:\n");
3017         print_ip_sym(ip);
3018         printk("but there are no locks held!\n");
3019         printk("\nother info that might help us debug this:\n");
3020         lockdep_print_held_locks(curr);
3021
3022         printk("\nstack backtrace:\n");
3023         dump_stack();
3024
3025         return 0;
3026 }
3027
3028 static void
3029 __lock_contended(struct lockdep_map *lock, unsigned long ip)
3030 {
3031         struct task_struct *curr = current;
3032         struct held_lock *hlock, *prev_hlock;
3033         struct lock_class_stats *stats;
3034         unsigned int depth;
3035         int i, contention_point, contending_point;
3036
3037         depth = curr->lockdep_depth;
3038         if (DEBUG_LOCKS_WARN_ON(!depth))
3039                 return;
3040
3041         prev_hlock = NULL;
3042         for (i = depth-1; i >= 0; i--) {
3043                 hlock = curr->held_locks + i;
3044                 /*
3045                  * We must not cross into another context:
3046                  */
3047                 if (prev_hlock && prev_hlock->irq_context != hlock->irq_context)
3048                         break;
3049                 if (hlock->instance == lock)
3050                         goto found_it;
3051                 prev_hlock = hlock;
3052         }
3053         print_lock_contention_bug(curr, lock, ip);
3054         return;
3055
3056 found_it:
3057         hlock->waittime_stamp = sched_clock();
3058
3059         contention_point = lock_point(hlock_class(hlock)->contention_point, ip);
3060         contending_point = lock_point(hlock_class(hlock)->contending_point,
3061                                       lock->ip);
3062
3063         stats = get_lock_stats(hlock_class(hlock));
3064         if (contention_point < LOCKSTAT_POINTS)
3065                 stats->contention_point[contention_point]++;
3066         if (contending_point < LOCKSTAT_POINTS)
3067                 stats->contending_point[contending_point]++;
3068         if (lock->cpu != smp_processor_id())
3069                 stats->bounces[bounce_contended + !!hlock->read]++;
3070         put_lock_stats(stats);
3071 }
3072
3073 static void
3074 __lock_acquired(struct lockdep_map *lock, unsigned long ip)
3075 {
3076         struct task_struct *curr = current;
3077         struct held_lock *hlock, *prev_hlock;
3078         struct lock_class_stats *stats;
3079         unsigned int depth;
3080         u64 now;
3081         s64 waittime = 0;
3082         int i, cpu;
3083
3084         depth = curr->lockdep_depth;
3085         if (DEBUG_LOCKS_WARN_ON(!depth))
3086                 return;
3087
3088         prev_hlock = NULL;
3089         for (i = depth-1; i >= 0; i--) {
3090                 hlock = curr->held_locks + i;
3091                 /*
3092                  * We must not cross into another context:
3093                  */
3094                 if (prev_hlock && prev_hlock->irq_context != hlock->irq_context)
3095                         break;
3096                 if (hlock->instance == lock)
3097                         goto found_it;
3098                 prev_hlock = hlock;
3099         }
3100         print_lock_contention_bug(curr, lock, _RET_IP_);
3101         return;
3102
3103 found_it:
3104         cpu = smp_processor_id();
3105         if (hlock->waittime_stamp) {
3106                 now = sched_clock();
3107                 waittime = now - hlock->waittime_stamp;
3108                 hlock->holdtime_stamp = now;
3109         }
3110
3111         stats = get_lock_stats(hlock_class(hlock));
3112         if (waittime) {
3113                 if (hlock->read)
3114                         lock_time_inc(&stats->read_waittime, waittime);
3115                 else
3116                         lock_time_inc(&stats->write_waittime, waittime);
3117         }
3118         if (lock->cpu != cpu)
3119                 stats->bounces[bounce_acquired + !!hlock->read]++;
3120         put_lock_stats(stats);
3121
3122         lock->cpu = cpu;
3123         lock->ip = ip;
3124 }
3125
3126 void lock_contended(struct lockdep_map *lock, unsigned long ip)
3127 {
3128         unsigned long flags;
3129
3130         if (unlikely(!lock_stat))
3131                 return;
3132
3133         if (unlikely(current->lockdep_recursion))
3134                 return;
3135
3136         raw_local_irq_save(flags);
3137         check_flags(flags);
3138         current->lockdep_recursion = 1;
3139         __lock_contended(lock, ip);
3140         current->lockdep_recursion = 0;
3141         raw_local_irq_restore(flags);
3142 }
3143 EXPORT_SYMBOL_GPL(lock_contended);
3144
3145 void lock_acquired(struct lockdep_map *lock, unsigned long ip)
3146 {
3147         unsigned long flags;
3148
3149         if (unlikely(!lock_stat))
3150                 return;
3151
3152         if (unlikely(current->lockdep_recursion))
3153                 return;
3154
3155         raw_local_irq_save(flags);
3156         check_flags(flags);
3157         current->lockdep_recursion = 1;
3158         __lock_acquired(lock, ip);
3159         current->lockdep_recursion = 0;
3160         raw_local_irq_restore(flags);
3161 }
3162 EXPORT_SYMBOL_GPL(lock_acquired);
3163 #endif
3164
3165 /*
3166  * Used by the testsuite, sanitize the validator state
3167  * after a simulated failure:
3168  */
3169
3170 void lockdep_reset(void)
3171 {
3172         unsigned long flags;
3173         int i;
3174
3175         raw_local_irq_save(flags);
3176         current->curr_chain_key = 0;
3177         current->lockdep_depth = 0;
3178         current->lockdep_recursion = 0;
3179         memset(current->held_locks, 0, MAX_LOCK_DEPTH*sizeof(struct held_lock));
3180         nr_hardirq_chains = 0;
3181         nr_softirq_chains = 0;
3182         nr_process_chains = 0;
3183         debug_locks = 1;
3184         for (i = 0; i < CHAINHASH_SIZE; i++)
3185                 INIT_LIST_HEAD(chainhash_table + i);
3186         raw_local_irq_restore(flags);
3187 }
3188
3189 static void zap_class(struct lock_class *class)
3190 {
3191         int i;
3192
3193         /*
3194          * Remove all dependencies this lock is
3195          * involved in:
3196          */
3197         for (i = 0; i < nr_list_entries; i++) {
3198                 if (list_entries[i].class == class)
3199                         list_del_rcu(&list_entries[i].entry);
3200         }
3201         /*
3202          * Unhash the class and remove it from the all_lock_classes list:
3203          */
3204         list_del_rcu(&class->hash_entry);
3205         list_del_rcu(&class->lock_entry);
3206
3207         class->key = NULL;
3208 }
3209
3210 static inline int within(const void *addr, void *start, unsigned long size)
3211 {
3212         return addr >= start && addr < start + size;
3213 }
3214
3215 void lockdep_free_key_range(void *start, unsigned long size)
3216 {
3217         struct lock_class *class, *next;
3218         struct list_head *head;
3219         unsigned long flags;
3220         int i;
3221         int locked;
3222
3223         raw_local_irq_save(flags);
3224         locked = graph_lock();
3225
3226         /*
3227          * Unhash all classes that were created by this module:
3228          */
3229         for (i = 0; i < CLASSHASH_SIZE; i++) {
3230                 head = classhash_table + i;
3231                 if (list_empty(head))
3232                         continue;
3233                 list_for_each_entry_safe(class, next, head, hash_entry) {
3234                         if (within(class->key, start, size))
3235                                 zap_class(class);
3236                         else if (within(class->name, start, size))
3237                                 zap_class(class);
3238                 }
3239         }
3240
3241         if (locked)
3242                 graph_unlock();
3243         raw_local_irq_restore(flags);
3244 }
3245
3246 void lockdep_reset_lock(struct lockdep_map *lock)
3247 {
3248         struct lock_class *class, *next;
3249         struct list_head *head;
3250         unsigned long flags;
3251         int i, j;
3252         int locked;
3253
3254         raw_local_irq_save(flags);
3255
3256         /*
3257          * Remove all classes this lock might have:
3258          */
3259         for (j = 0; j < MAX_LOCKDEP_SUBCLASSES; j++) {
3260                 /*
3261                  * If the class exists we look it up and zap it:
3262                  */
3263                 class = look_up_lock_class(lock, j);
3264                 if (class)
3265                         zap_class(class);
3266         }
3267         /*
3268          * Debug check: in the end all mapped classes should
3269          * be gone.
3270          */
3271         locked = graph_lock();
3272         for (i = 0; i < CLASSHASH_SIZE; i++) {
3273                 head = classhash_table + i;
3274                 if (list_empty(head))
3275                         continue;
3276                 list_for_each_entry_safe(class, next, head, hash_entry) {
3277                         if (unlikely(class == lock->class_cache)) {
3278                                 if (debug_locks_off_graph_unlock())
3279                                         WARN_ON(1);
3280                                 goto out_restore;
3281                         }
3282                 }
3283         }
3284         if (locked)
3285                 graph_unlock();
3286
3287 out_restore:
3288         raw_local_irq_restore(flags);
3289 }
3290
3291 void lockdep_init(void)
3292 {
3293         int i;
3294
3295         /*
3296          * Some architectures have their own start_kernel()
3297          * code which calls lockdep_init(), while we also
3298          * call lockdep_init() from the start_kernel() itself,
3299          * and we want to initialize the hashes only once:
3300          */
3301         if (lockdep_initialized)
3302                 return;
3303
3304         for (i = 0; i < CLASSHASH_SIZE; i++)
3305                 INIT_LIST_HEAD(classhash_table + i);
3306
3307         for (i = 0; i < CHAINHASH_SIZE; i++)
3308                 INIT_LIST_HEAD(chainhash_table + i);
3309
3310         lockdep_initialized = 1;
3311 }
3312
3313 void __init lockdep_info(void)
3314 {
3315         printk("Lock dependency validator: Copyright (c) 2006 Red Hat, Inc., Ingo Molnar\n");
3316
3317         printk("... MAX_LOCKDEP_SUBCLASSES:  %lu\n", MAX_LOCKDEP_SUBCLASSES);
3318         printk("... MAX_LOCK_DEPTH:          %lu\n", MAX_LOCK_DEPTH);
3319         printk("... MAX_LOCKDEP_KEYS:        %lu\n", MAX_LOCKDEP_KEYS);
3320         printk("... CLASSHASH_SIZE:          %lu\n", CLASSHASH_SIZE);
3321         printk("... MAX_LOCKDEP_ENTRIES:     %lu\n", MAX_LOCKDEP_ENTRIES);
3322         printk("... MAX_LOCKDEP_CHAINS:      %lu\n", MAX_LOCKDEP_CHAINS);
3323         printk("... CHAINHASH_SIZE:          %lu\n", CHAINHASH_SIZE);
3324
3325         printk(" memory used by lock dependency info: %lu kB\n",
3326                 (sizeof(struct lock_class) * MAX_LOCKDEP_KEYS +
3327                 sizeof(struct list_head) * CLASSHASH_SIZE +
3328                 sizeof(struct lock_list) * MAX_LOCKDEP_ENTRIES +
3329                 sizeof(struct lock_chain) * MAX_LOCKDEP_CHAINS +
3330                 sizeof(struct list_head) * CHAINHASH_SIZE) / 1024);
3331
3332         printk(" per task-struct memory footprint: %lu bytes\n",
3333                 sizeof(struct held_lock) * MAX_LOCK_DEPTH);
3334
3335 #ifdef CONFIG_DEBUG_LOCKDEP
3336         if (lockdep_init_error) {
3337                 printk("WARNING: lockdep init error! Arch code didn't call lockdep_init() early enough?\n");
3338                 printk("Call stack leading to lockdep invocation was:\n");
3339                 print_stack_trace(&lockdep_init_trace, 0);
3340         }
3341 #endif
3342 }
3343
3344 static void
3345 print_freed_lock_bug(struct task_struct *curr, const void *mem_from,
3346                      const void *mem_to, struct held_lock *hlock)
3347 {
3348         if (!debug_locks_off())
3349                 return;
3350         if (debug_locks_silent)
3351                 return;
3352
3353         printk("\n=========================\n");
3354         printk(  "[ BUG: held lock freed! ]\n");
3355         printk(  "-------------------------\n");
3356         printk("%s/%d is freeing memory %p-%p, with a lock still held there!\n",
3357                 curr->comm, task_pid_nr(curr), mem_from, mem_to-1);
3358         print_lock(hlock);
3359         lockdep_print_held_locks(curr);
3360
3361         printk("\nstack backtrace:\n");
3362         dump_stack();
3363 }
3364
3365 static inline int not_in_range(const void* mem_from, unsigned long mem_len,
3366                                 const void* lock_from, unsigned long lock_len)
3367 {
3368         return lock_from + lock_len <= mem_from ||
3369                 mem_from + mem_len <= lock_from;
3370 }
3371
3372 /*
3373  * Called when kernel memory is freed (or unmapped), or if a lock
3374  * is destroyed or reinitialized - this code checks whether there is
3375  * any held lock in the memory range of <from> to <to>:
3376  */
3377 void debug_check_no_locks_freed(const void *mem_from, unsigned long mem_len)
3378 {
3379         struct task_struct *curr = current;
3380         struct held_lock *hlock;
3381         unsigned long flags;
3382         int i;
3383
3384         if (unlikely(!debug_locks))
3385                 return;
3386
3387         local_irq_save(flags);
3388         for (i = 0; i < curr->lockdep_depth; i++) {
3389                 hlock = curr->held_locks + i;
3390
3391                 if (not_in_range(mem_from, mem_len, hlock->instance,
3392                                         sizeof(*hlock->instance)))
3393                         continue;
3394
3395                 print_freed_lock_bug(curr, mem_from, mem_from + mem_len, hlock);
3396                 break;
3397         }
3398         local_irq_restore(flags);
3399 }
3400 EXPORT_SYMBOL_GPL(debug_check_no_locks_freed);
3401
3402 static void print_held_locks_bug(struct task_struct *curr)
3403 {
3404         if (!debug_locks_off())
3405                 return;
3406         if (debug_locks_silent)
3407                 return;
3408
3409         printk("\n=====================================\n");
3410         printk(  "[ BUG: lock held at task exit time! ]\n");
3411         printk(  "-------------------------------------\n");
3412         printk("%s/%d is exiting with locks still held!\n",
3413                 curr->comm, task_pid_nr(curr));
3414         lockdep_print_held_locks(curr);
3415
3416         printk("\nstack backtrace:\n");
3417         dump_stack();
3418 }
3419
3420 void debug_check_no_locks_held(struct task_struct *task)
3421 {
3422         if (unlikely(task->lockdep_depth > 0))
3423                 print_held_locks_bug(task);
3424 }
3425
3426 void debug_show_all_locks(void)
3427 {
3428         struct task_struct *g, *p;
3429         int count = 10;
3430         int unlock = 1;
3431
3432         if (unlikely(!debug_locks)) {
3433                 printk("INFO: lockdep is turned off.\n");
3434                 return;
3435         }
3436         printk("\nShowing all locks held in the system:\n");
3437
3438         /*
3439          * Here we try to get the tasklist_lock as hard as possible,
3440          * if not successful after 2 seconds we ignore it (but keep
3441          * trying). This is to enable a debug printout even if a
3442          * tasklist_lock-holding task deadlocks or crashes.
3443          */
3444 retry:
3445         if (!read_trylock(&tasklist_lock)) {
3446                 if (count == 10)
3447                         printk("hm, tasklist_lock locked, retrying... ");
3448                 if (count) {
3449                         count--;
3450                         printk(" #%d", 10-count);
3451                         mdelay(200);
3452                         goto retry;
3453                 }
3454                 printk(" ignoring it.\n");
3455                 unlock = 0;
3456         } else {
3457                 if (count != 10)
3458                         printk(KERN_CONT " locked it.\n");
3459         }
3460
3461         do_each_thread(g, p) {
3462                 /*
3463                  * It's not reliable to print a task's held locks
3464                  * if it's not sleeping (or if it's not the current
3465                  * task):
3466                  */
3467                 if (p->state == TASK_RUNNING && p != current)
3468                         continue;
3469                 if (p->lockdep_depth)
3470                         lockdep_print_held_locks(p);
3471                 if (!unlock)
3472                         if (read_trylock(&tasklist_lock))
3473                                 unlock = 1;
3474         } while_each_thread(g, p);
3475
3476         printk("\n");
3477         printk("=============================================\n\n");
3478
3479         if (unlock)
3480                 read_unlock(&tasklist_lock);
3481 }
3482 EXPORT_SYMBOL_GPL(debug_show_all_locks);
3483
3484 /*
3485  * Careful: only use this function if you are sure that
3486  * the task cannot run in parallel!
3487  */
3488 void __debug_show_held_locks(struct task_struct *task)
3489 {
3490         if (unlikely(!debug_locks)) {
3491                 printk("INFO: lockdep is turned off.\n");
3492                 return;
3493         }
3494         lockdep_print_held_locks(task);
3495 }
3496 EXPORT_SYMBOL_GPL(__debug_show_held_locks);
3497
3498 void debug_show_held_locks(struct task_struct *task)
3499 {
3500                 __debug_show_held_locks(task);
3501 }
3502 EXPORT_SYMBOL_GPL(debug_show_held_locks);
3503
3504 void lockdep_sys_exit(void)
3505 {
3506         struct task_struct *curr = current;
3507
3508         if (unlikely(curr->lockdep_depth)) {
3509                 if (!debug_locks_off())
3510                         return;
3511                 printk("\n================================================\n");
3512                 printk(  "[ BUG: lock held when returning to user space! ]\n");
3513                 printk(  "------------------------------------------------\n");
3514                 printk("%s/%d is leaving the kernel with locks still held!\n",
3515                                 curr->comm, curr->pid);
3516                 lockdep_print_held_locks(curr);
3517         }
3518 }