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