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