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