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