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