lockdep.c 110.7 KB
Newer Older
I
Ingo Molnar 已提交
1 2 3 4 5 6 7
/*
 * kernel/lockdep.c
 *
 * Runtime locking correctness validator
 *
 * Started by Ingo Molnar:
 *
P
Peter Zijlstra 已提交
8
 *  Copyright (C) 2006,2007 Red Hat, Inc., Ingo Molnar <mingo@redhat.com>
9
 *  Copyright (C) 2007 Red Hat, Inc., Peter Zijlstra
I
Ingo Molnar 已提交
10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27
 *
 * this code maps all the lock dependencies as they occur in a live kernel
 * and will warn about the following classes of locking bugs:
 *
 * - lock inversion scenarios
 * - circular lock dependencies
 * - hardirq/softirq safe/unsafe locking bugs
 *
 * Bugs are reported even if the current locking scenario does not cause
 * any deadlock at this point.
 *
 * I.e. if anytime in the past two locks were taken in a different order,
 * even if it happened for another task, even if those were different
 * locks (but of the same class as this lock), this code will detect it.
 *
 * Thanks to Arjan van de Ven for coming up with the initial idea of
 * mapping lock dependencies runtime.
 */
28
#define DISABLE_BRANCH_PROFILING
I
Ingo Molnar 已提交
29 30
#include <linux/mutex.h>
#include <linux/sched.h>
31
#include <linux/sched/clock.h>
32
#include <linux/sched/task.h>
33
#include <linux/sched/mm.h>
I
Ingo Molnar 已提交
34 35 36 37 38 39 40 41 42 43
#include <linux/delay.h>
#include <linux/module.h>
#include <linux/proc_fs.h>
#include <linux/seq_file.h>
#include <linux/spinlock.h>
#include <linux/kallsyms.h>
#include <linux/interrupt.h>
#include <linux/stacktrace.h>
#include <linux/debug_locks.h>
#include <linux/irqflags.h>
44
#include <linux/utsname.h>
P
Peter Zijlstra 已提交
45
#include <linux/hash.h>
46
#include <linux/ftrace.h>
P
Peter Zijlstra 已提交
47
#include <linux/stringify.h>
48
#include <linux/bitops.h>
49
#include <linux/gfp.h>
50
#include <linux/random.h>
51
#include <linux/jhash.h>
52
#include <linux/nmi.h>
P
Peter Zijlstra 已提交
53

I
Ingo Molnar 已提交
54 55 56 57
#include <asm/sections.h>

#include "lockdep_internals.h"

58
#define CREATE_TRACE_POINTS
59
#include <trace/events/lock.h>
60

P
Peter Zijlstra 已提交
61 62 63 64 65 66 67 68 69 70 71 72 73 74
#ifdef CONFIG_PROVE_LOCKING
int prove_locking = 1;
module_param(prove_locking, int, 0644);
#else
#define prove_locking 0
#endif

#ifdef CONFIG_LOCK_STAT
int lock_stat = 1;
module_param(lock_stat, int, 0644);
#else
#define lock_stat 0
#endif

I
Ingo Molnar 已提交
75
/*
76 77
 * lockdep_lock: protects the lockdep graph, the hashes and the
 *               class/list/hash allocators.
I
Ingo Molnar 已提交
78 79 80
 *
 * This is one of the rare exceptions where it's justified
 * to use a raw spinlock - we really dont want the spinlock
81
 * code to recurse back into the lockdep code...
I
Ingo Molnar 已提交
82
 */
83
static arch_spinlock_t lockdep_lock = (arch_spinlock_t)__ARCH_SPIN_LOCK_UNLOCKED;
84 85 86

static int graph_lock(void)
{
87
	arch_spin_lock(&lockdep_lock);
88 89 90 91 92 93 94
	/*
	 * Make sure that if another CPU detected a bug while
	 * walking the graph we dont change it (while the other
	 * CPU is busy printing out stuff with the graph lock
	 * dropped already)
	 */
	if (!debug_locks) {
95
		arch_spin_unlock(&lockdep_lock);
96 97
		return 0;
	}
98 99
	/* prevent any recursions within lockdep from causing deadlocks */
	current->lockdep_recursion++;
100 101 102 103 104
	return 1;
}

static inline int graph_unlock(void)
{
P
Peter Zijlstra 已提交
105 106 107 108 109
	if (debug_locks && !arch_spin_is_locked(&lockdep_lock)) {
		/*
		 * The lockdep graph lock isn't locked while we expect it to
		 * be, we're confused now, bye!
		 */
110
		return DEBUG_LOCKS_WARN_ON(1);
P
Peter Zijlstra 已提交
111
	}
112

113
	current->lockdep_recursion--;
114
	arch_spin_unlock(&lockdep_lock);
115 116 117 118 119 120 121 122 123 124 125
	return 0;
}

/*
 * Turn lock debugging off and return with 0 if it was off already,
 * and also release the graph lock:
 */
static inline int debug_locks_off_graph_unlock(void)
{
	int ret = debug_locks_off();

126
	arch_spin_unlock(&lockdep_lock);
127 128 129

	return ret;
}
I
Ingo Molnar 已提交
130 131

unsigned long nr_list_entries;
P
Peter Zijlstra 已提交
132
static struct lock_list list_entries[MAX_LOCKDEP_ENTRIES];
I
Ingo Molnar 已提交
133 134 135 136 137 138 139 140 141 142

/*
 * All data structures here are protected by the global debug_lock.
 *
 * Mutex key structs only get allocated, once during bootup, and never
 * get freed - this significantly simplifies the debugging code.
 */
unsigned long nr_lock_classes;
static struct lock_class lock_classes[MAX_LOCKDEP_KEYS];

D
Dave Jones 已提交
143 144 145
static inline struct lock_class *hlock_class(struct held_lock *hlock)
{
	if (!hlock->class_idx) {
P
Peter Zijlstra 已提交
146 147 148
		/*
		 * Someone passed in garbage, we give up.
		 */
D
Dave Jones 已提交
149 150 151 152 153 154
		DEBUG_LOCKS_WARN_ON(1);
		return NULL;
	}
	return lock_classes + hlock->class_idx - 1;
}

P
Peter Zijlstra 已提交
155
#ifdef CONFIG_LOCK_STAT
156
static DEFINE_PER_CPU(struct lock_class_stats[MAX_LOCKDEP_KEYS], cpu_lock_stats);
P
Peter Zijlstra 已提交
157

158 159
static inline u64 lockstat_clock(void)
{
160
	return local_clock();
161 162
}

P
Peter Zijlstra 已提交
163
static int lock_point(unsigned long points[], unsigned long ip)
P
Peter Zijlstra 已提交
164 165 166
{
	int i;

P
Peter Zijlstra 已提交
167 168 169
	for (i = 0; i < LOCKSTAT_POINTS; i++) {
		if (points[i] == 0) {
			points[i] = ip;
P
Peter Zijlstra 已提交
170 171
			break;
		}
P
Peter Zijlstra 已提交
172
		if (points[i] == ip)
P
Peter Zijlstra 已提交
173 174 175 176 177 178
			break;
	}

	return i;
}

179
static void lock_time_inc(struct lock_time *lt, u64 time)
P
Peter Zijlstra 已提交
180 181 182 183
{
	if (time > lt->max)
		lt->max = time;

184
	if (time < lt->min || !lt->nr)
P
Peter Zijlstra 已提交
185 186 187 188 189 190
		lt->min = time;

	lt->total += time;
	lt->nr++;
}

191 192
static inline void lock_time_add(struct lock_time *src, struct lock_time *dst)
{
193 194 195 196 197 198 199 200 201
	if (!src->nr)
		return;

	if (src->max > dst->max)
		dst->max = src->max;

	if (src->min < dst->min || !dst->nr)
		dst->min = src->min;

202 203 204 205 206 207 208 209 210 211 212 213
	dst->total += src->total;
	dst->nr += src->nr;
}

struct lock_class_stats lock_stats(struct lock_class *class)
{
	struct lock_class_stats stats;
	int cpu, i;

	memset(&stats, 0, sizeof(struct lock_class_stats));
	for_each_possible_cpu(cpu) {
		struct lock_class_stats *pcs =
214
			&per_cpu(cpu_lock_stats, cpu)[class - lock_classes];
215 216 217 218

		for (i = 0; i < ARRAY_SIZE(stats.contention_point); i++)
			stats.contention_point[i] += pcs->contention_point[i];

P
Peter Zijlstra 已提交
219 220 221
		for (i = 0; i < ARRAY_SIZE(stats.contending_point); i++)
			stats.contending_point[i] += pcs->contending_point[i];

222 223 224 225 226
		lock_time_add(&pcs->read_waittime, &stats.read_waittime);
		lock_time_add(&pcs->write_waittime, &stats.write_waittime);

		lock_time_add(&pcs->read_holdtime, &stats.read_holdtime);
		lock_time_add(&pcs->write_holdtime, &stats.write_holdtime);
P
Peter Zijlstra 已提交
227 228 229

		for (i = 0; i < ARRAY_SIZE(stats.bounces); i++)
			stats.bounces[i] += pcs->bounces[i];
230 231 232 233 234 235 236 237 238 239 240
	}

	return stats;
}

void clear_lock_stats(struct lock_class *class)
{
	int cpu;

	for_each_possible_cpu(cpu) {
		struct lock_class_stats *cpu_stats =
241
			&per_cpu(cpu_lock_stats, cpu)[class - lock_classes];
242 243 244 245

		memset(cpu_stats, 0, sizeof(struct lock_class_stats));
	}
	memset(class->contention_point, 0, sizeof(class->contention_point));
P
Peter Zijlstra 已提交
246
	memset(class->contending_point, 0, sizeof(class->contending_point));
247 248
}

P
Peter Zijlstra 已提交
249 250
static struct lock_class_stats *get_lock_stats(struct lock_class *class)
{
251
	return &get_cpu_var(cpu_lock_stats)[class - lock_classes];
P
Peter Zijlstra 已提交
252 253 254 255
}

static void put_lock_stats(struct lock_class_stats *stats)
{
256
	put_cpu_var(cpu_lock_stats);
P
Peter Zijlstra 已提交
257 258 259 260 261
}

static void lock_release_holdtime(struct held_lock *hlock)
{
	struct lock_class_stats *stats;
262
	u64 holdtime;
P
Peter Zijlstra 已提交
263 264 265 266

	if (!lock_stat)
		return;

267
	holdtime = lockstat_clock() - hlock->holdtime_stamp;
P
Peter Zijlstra 已提交
268

D
Dave Jones 已提交
269
	stats = get_lock_stats(hlock_class(hlock));
P
Peter Zijlstra 已提交
270 271 272 273 274 275 276 277 278 279 280 281
	if (hlock->read)
		lock_time_inc(&stats->read_holdtime, holdtime);
	else
		lock_time_inc(&stats->write_holdtime, holdtime);
	put_lock_stats(stats);
}
#else
static inline void lock_release_holdtime(struct held_lock *hlock)
{
}
#endif

I
Ingo Molnar 已提交
282 283 284 285 286 287 288 289 290 291 292 293
/*
 * We keep a global list of all lock classes. The list only grows,
 * never shrinks. The list is only accessed with the lockdep
 * spinlock lock held.
 */
LIST_HEAD(all_lock_classes);

/*
 * The lockdep classes are in a hash-table as well, for fast lookup:
 */
#define CLASSHASH_BITS		(MAX_LOCKDEP_KEYS_BITS - 1)
#define CLASSHASH_SIZE		(1UL << CLASSHASH_BITS)
P
Peter Zijlstra 已提交
294
#define __classhashfn(key)	hash_long((unsigned long)key, CLASSHASH_BITS)
I
Ingo Molnar 已提交
295 296
#define classhashentry(key)	(classhash_table + __classhashfn((key)))

297
static struct hlist_head classhash_table[CLASSHASH_SIZE];
I
Ingo Molnar 已提交
298 299 300 301 302 303 304

/*
 * We put the lock dependency chains into a hash-table as well, to cache
 * their existence:
 */
#define CHAINHASH_BITS		(MAX_LOCKDEP_CHAINS_BITS-1)
#define CHAINHASH_SIZE		(1UL << CHAINHASH_BITS)
P
Peter Zijlstra 已提交
305
#define __chainhashfn(chain)	hash_long(chain, CHAINHASH_BITS)
I
Ingo Molnar 已提交
306 307
#define chainhashentry(chain)	(chainhash_table + __chainhashfn((chain)))

308
static struct hlist_head chainhash_table[CHAINHASH_SIZE];
I
Ingo Molnar 已提交
309 310 311 312 313 314 315

/*
 * The hash key of the lock dependency chains is a hash itself too:
 * it's a hash of all locks taken up to that lock, including that lock.
 * It's a 64-bit hash, because it's important for the keys to be
 * unique.
 */
316 317 318 319 320 321 322 323
static inline u64 iterate_chain_key(u64 key, u32 idx)
{
	u32 k0 = key, k1 = key >> 32;

	__jhash_mix(idx, k0, k1); /* Macro that modifies arguments! */

	return k0 | (u64)k1 << 32;
}
I
Ingo Molnar 已提交
324

325
void lockdep_off(void)
I
Ingo Molnar 已提交
326 327 328 329 330
{
	current->lockdep_recursion++;
}
EXPORT_SYMBOL(lockdep_off);

331
void lockdep_on(void)
I
Ingo Molnar 已提交
332 333 334 335 336 337 338 339 340 341
{
	current->lockdep_recursion--;
}
EXPORT_SYMBOL(lockdep_on);

/*
 * Debugging switches:
 */

#define VERBOSE			0
342
#define VERY_VERBOSE		0
I
Ingo Molnar 已提交
343 344 345 346 347 348 349 350 351

#if VERBOSE
# define HARDIRQ_VERBOSE	1
# define SOFTIRQ_VERBOSE	1
#else
# define HARDIRQ_VERBOSE	0
# define SOFTIRQ_VERBOSE	0
#endif

352
#if VERBOSE || HARDIRQ_VERBOSE || SOFTIRQ_VERBOSE
I
Ingo Molnar 已提交
353 354 355 356 357
/*
 * Quick filtering for interesting events:
 */
static int class_filter(struct lock_class *class)
{
A
Andi Kleen 已提交
358 359
#if 0
	/* Example */
I
Ingo Molnar 已提交
360
	if (class->name_version == 1 &&
A
Andi Kleen 已提交
361
			!strcmp(class->name, "lockname"))
I
Ingo Molnar 已提交
362 363
		return 1;
	if (class->name_version == 1 &&
A
Andi Kleen 已提交
364
			!strcmp(class->name, "&struct->lockfield"))
I
Ingo Molnar 已提交
365
		return 1;
A
Andi Kleen 已提交
366
#endif
367 368
	/* Filter everything else. 1 would be to allow everything else */
	return 0;
I
Ingo Molnar 已提交
369 370 371 372 373 374 375 376 377 378 379 380 381
}
#endif

static int verbose(struct lock_class *class)
{
#if VERBOSE
	return class_filter(class);
#endif
	return 0;
}

/*
 * Stack-trace: tightly packed array of stack backtrace
382
 * addresses. Protected by the graph_lock.
I
Ingo Molnar 已提交
383 384 385 386
 */
unsigned long nr_stack_trace_entries;
static unsigned long stack_trace[MAX_STACK_TRACE_ENTRIES];

387 388 389 390
static void print_lockdep_off(const char *bug_msg)
{
	printk(KERN_DEBUG "%s\n", bug_msg);
	printk(KERN_DEBUG "turning off the locking correctness validator.\n");
391
#ifdef CONFIG_LOCK_STAT
392
	printk(KERN_DEBUG "Please attach the output of /proc/lock_stat to the bug report\n");
393
#endif
394 395
}

I
Ingo Molnar 已提交
396 397 398 399 400 401
static int save_trace(struct stack_trace *trace)
{
	trace->nr_entries = 0;
	trace->max_entries = MAX_STACK_TRACE_ENTRIES - nr_stack_trace_entries;
	trace->entries = stack_trace + nr_stack_trace_entries;

402 403
	trace->skip = 3;

C
Christoph Hellwig 已提交
404
	save_stack_trace(trace);
I
Ingo Molnar 已提交
405

P
Peter Zijlstra 已提交
406 407 408 409 410 411 412
	/*
	 * Some daft arches put -1 at the end to indicate its a full trace.
	 *
	 * <rant> this is buggy anyway, since it takes a whole extra entry so a
	 * complete trace that maxes out the entries provided will be reported
	 * as incomplete, friggin useless </rant>
	 */
413 414
	if (trace->nr_entries != 0 &&
	    trace->entries[trace->nr_entries-1] == ULONG_MAX)
P
Peter Zijlstra 已提交
415 416
		trace->nr_entries--;

I
Ingo Molnar 已提交
417 418 419 420
	trace->max_entries = trace->nr_entries;

	nr_stack_trace_entries += trace->nr_entries;

P
Peter Zijlstra 已提交
421
	if (nr_stack_trace_entries >= MAX_STACK_TRACE_ENTRIES-1) {
422 423 424
		if (!debug_locks_off_graph_unlock())
			return 0;

425
		print_lockdep_off("BUG: MAX_STACK_TRACE_ENTRIES too low!");
426 427
		dump_stack();

I
Ingo Molnar 已提交
428 429 430 431 432 433 434 435 436 437 438 439 440 441 442
		return 0;
	}

	return 1;
}

unsigned int nr_hardirq_chains;
unsigned int nr_softirq_chains;
unsigned int nr_process_chains;
unsigned int max_lockdep_depth;

#ifdef CONFIG_DEBUG_LOCKDEP
/*
 * Various lockdep statistics:
 */
443
DEFINE_PER_CPU(struct lockdep_stats, lockdep_stats);
I
Ingo Molnar 已提交
444 445 446 447 448 449
#endif

/*
 * Locking printouts:
 */

P
Peter Zijlstra 已提交
450
#define __USAGE(__STATE)						\
P
Peter Zijlstra 已提交
451 452 453 454
	[LOCK_USED_IN_##__STATE] = "IN-"__stringify(__STATE)"-W",	\
	[LOCK_ENABLED_##__STATE] = __stringify(__STATE)"-ON-W",		\
	[LOCK_USED_IN_##__STATE##_READ] = "IN-"__stringify(__STATE)"-R",\
	[LOCK_ENABLED_##__STATE##_READ] = __stringify(__STATE)"-ON-R",
P
Peter Zijlstra 已提交
455

I
Ingo Molnar 已提交
456 457
static const char *usage_str[] =
{
P
Peter Zijlstra 已提交
458 459 460 461
#define LOCKDEP_STATE(__STATE) __USAGE(__STATE)
#include "lockdep_states.h"
#undef LOCKDEP_STATE
	[LOCK_USED] = "INITIAL USE",
I
Ingo Molnar 已提交
462 463 464 465
};

const char * __get_key_name(struct lockdep_subclass_key *key, char *str)
{
A
Alexey Dobriyan 已提交
466
	return kallsyms_lookup((unsigned long)key, NULL, NULL, NULL, str);
I
Ingo Molnar 已提交
467 468
}

469
static inline unsigned long lock_flag(enum lock_usage_bit bit)
I
Ingo Molnar 已提交
470
{
471 472
	return 1UL << bit;
}
I
Ingo Molnar 已提交
473

474 475 476 477 478 479 480 481 482 483
static char get_usage_char(struct lock_class *class, enum lock_usage_bit bit)
{
	char c = '.';

	if (class->usage_mask & lock_flag(bit + 2))
		c = '+';
	if (class->usage_mask & lock_flag(bit)) {
		c = '-';
		if (class->usage_mask & lock_flag(bit + 2))
			c = '?';
I
Ingo Molnar 已提交
484 485
	}

486 487
	return c;
}
488

P
Peter Zijlstra 已提交
489
void get_usage_chars(struct lock_class *class, char usage[LOCK_USAGE_CHARS])
490
{
P
Peter Zijlstra 已提交
491
	int i = 0;
492

P
Peter Zijlstra 已提交
493 494 495 496 497 498 499
#define LOCKDEP_STATE(__STATE) 						\
	usage[i++] = get_usage_char(class, LOCK_USED_IN_##__STATE);	\
	usage[i++] = get_usage_char(class, LOCK_USED_IN_##__STATE##_READ);
#include "lockdep_states.h"
#undef LOCKDEP_STATE

	usage[i] = '\0';
I
Ingo Molnar 已提交
500 501
}

502
static void __print_lock_name(struct lock_class *class)
503 504 505 506
{
	char str[KSYM_NAME_LEN];
	const char *name;

I
Ingo Molnar 已提交
507 508 509
	name = class->name;
	if (!name) {
		name = __get_key_name(class->key, str);
D
Dmitry Vyukov 已提交
510
		printk(KERN_CONT "%s", name);
I
Ingo Molnar 已提交
511
	} else {
D
Dmitry Vyukov 已提交
512
		printk(KERN_CONT "%s", name);
I
Ingo Molnar 已提交
513
		if (class->name_version > 1)
D
Dmitry Vyukov 已提交
514
			printk(KERN_CONT "#%d", class->name_version);
I
Ingo Molnar 已提交
515
		if (class->subclass)
D
Dmitry Vyukov 已提交
516
			printk(KERN_CONT "/%d", class->subclass);
I
Ingo Molnar 已提交
517
	}
518 519 520 521 522 523 524 525
}

static void print_lock_name(struct lock_class *class)
{
	char usage[LOCK_USAGE_CHARS];

	get_usage_chars(class, usage);

D
Dmitry Vyukov 已提交
526
	printk(KERN_CONT " (");
527
	__print_lock_name(class);
D
Dmitry Vyukov 已提交
528
	printk(KERN_CONT "){%s}", usage);
I
Ingo Molnar 已提交
529 530 531 532 533
}

static void print_lockdep_cache(struct lockdep_map *lock)
{
	const char *name;
534
	char str[KSYM_NAME_LEN];
I
Ingo Molnar 已提交
535 536 537 538 539

	name = lock->name;
	if (!name)
		name = __get_key_name(lock->key->subkeys, str);

D
Dmitry Vyukov 已提交
540
	printk(KERN_CONT "%s", name);
I
Ingo Molnar 已提交
541 542 543 544
}

static void print_lock(struct held_lock *hlock)
{
545 546 547 548 549 550 551 552 553 554
	/*
	 * We can be called locklessly through debug_show_all_locks() so be
	 * extra careful, the hlock might have been released and cleared.
	 */
	unsigned int class_idx = hlock->class_idx;

	/* Don't re-read hlock->class_idx, can't use READ_ONCE() on bitfields: */
	barrier();

	if (!class_idx || (class_idx - 1) >= MAX_LOCKDEP_KEYS) {
D
Dmitry Vyukov 已提交
555
		printk(KERN_CONT "<RELEASED>\n");
556 557 558
		return;
	}

559
	printk(KERN_CONT "%p", hlock->instance);
560
	print_lock_name(lock_classes + class_idx - 1);
561
	printk(KERN_CONT ", at: %pS\n", (void *)hlock->acquire_ip);
I
Ingo Molnar 已提交
562 563
}

564
static void lockdep_print_held_locks(struct task_struct *p)
I
Ingo Molnar 已提交
565
{
566
	int i, depth = READ_ONCE(p->lockdep_depth);
I
Ingo Molnar 已提交
567

568 569 570 571 572 573 574 575 576 577
	if (!depth)
		printk("no locks held by %s/%d.\n", p->comm, task_pid_nr(p));
	else
		printk("%d lock%s held by %s/%d:\n", depth,
		       depth > 1 ? "s" : "", p->comm, task_pid_nr(p));
	/*
	 * It's not reliable to print a task's held locks if it's not sleeping
	 * and it's not the current task.
	 */
	if (p->state == TASK_RUNNING && p != current)
I
Ingo Molnar 已提交
578 579 580
		return;
	for (i = 0; i < depth; i++) {
		printk(" #%d: ", i);
581
		print_lock(p->held_locks + i);
I
Ingo Molnar 已提交
582 583 584
	}
}

585
static void print_kernel_ident(void)
P
Peter Zijlstra 已提交
586
{
587
	printk("%s %.*s %s\n", init_utsname()->release,
P
Peter Zijlstra 已提交
588
		(int)strcspn(init_utsname()->version, " "),
589 590
		init_utsname()->version,
		print_tainted());
P
Peter Zijlstra 已提交
591 592 593 594 595 596 597 598 599 600
}

static int very_verbose(struct lock_class *class)
{
#if VERY_VERBOSE
	return class_filter(class);
#endif
	return 0;
}

I
Ingo Molnar 已提交
601
/*
P
Peter Zijlstra 已提交
602
 * Is this the address of a static object:
I
Ingo Molnar 已提交
603
 */
604
#ifdef __KERNEL__
P
Peter Zijlstra 已提交
605
static int static_obj(void *obj)
I
Ingo Molnar 已提交
606
{
P
Peter Zijlstra 已提交
607 608 609 610
	unsigned long start = (unsigned long) &_stext,
		      end   = (unsigned long) &_end,
		      addr  = (unsigned long) obj;

I
Ingo Molnar 已提交
611
	/*
P
Peter Zijlstra 已提交
612
	 * static variable?
I
Ingo Molnar 已提交
613
	 */
P
Peter Zijlstra 已提交
614 615
	if ((addr >= start) && (addr < end))
		return 1;
I
Ingo Molnar 已提交
616

617 618 619
	if (arch_is_kernel_data(addr))
		return 1;

I
Ingo Molnar 已提交
620
	/*
621
	 * in-kernel percpu var?
I
Ingo Molnar 已提交
622
	 */
623 624
	if (is_kernel_percpu_address(addr))
		return 1;
I
Ingo Molnar 已提交
625

P
Peter Zijlstra 已提交
626
	/*
627
	 * module static or percpu var?
P
Peter Zijlstra 已提交
628
	 */
629
	return is_module_address(addr) || is_module_percpu_address(addr);
630
}
631
#endif
632

I
Ingo Molnar 已提交
633
/*
P
Peter Zijlstra 已提交
634 635
 * To make lock name printouts unique, we calculate a unique
 * class->name_version generation counter:
I
Ingo Molnar 已提交
636
 */
P
Peter Zijlstra 已提交
637
static int count_matching_names(struct lock_class *new_class)
I
Ingo Molnar 已提交
638
{
P
Peter Zijlstra 已提交
639 640
	struct lock_class *class;
	int count = 0;
I
Ingo Molnar 已提交
641

P
Peter Zijlstra 已提交
642
	if (!new_class->name)
I
Ingo Molnar 已提交
643 644
		return 0;

645
	list_for_each_entry_rcu(class, &all_lock_classes, lock_entry) {
P
Peter Zijlstra 已提交
646 647 648 649 650
		if (new_class->key - new_class->subclass == class->key)
			return class->name_version;
		if (class->name && !strcmp(class->name, new_class->name))
			count = max(count, class->name_version);
	}
I
Ingo Molnar 已提交
651

P
Peter Zijlstra 已提交
652
	return count + 1;
I
Ingo Molnar 已提交
653 654
}

P
Peter Zijlstra 已提交
655
static inline struct lock_class *
656
look_up_lock_class(const struct lockdep_map *lock, unsigned int subclass)
I
Ingo Molnar 已提交
657
{
P
Peter Zijlstra 已提交
658
	struct lockdep_subclass_key *key;
659
	struct hlist_head *hash_head;
P
Peter Zijlstra 已提交
660
	struct lock_class *class;
I
Ingo Molnar 已提交
661

662 663 664 665 666 667 668 669 670 671
	if (unlikely(subclass >= MAX_LOCKDEP_SUBCLASSES)) {
		debug_locks_off();
		printk(KERN_ERR
			"BUG: looking up invalid subclass: %u\n", subclass);
		printk(KERN_ERR
			"turning off the locking correctness validator.\n");
		dump_stack();
		return NULL;
	}

P
Peter Zijlstra 已提交
672
	/*
673 674
	 * If it is not initialised then it has never been locked,
	 * so it won't be present in the hash table.
P
Peter Zijlstra 已提交
675
	 */
676 677
	if (unlikely(!lock->key))
		return NULL;
I
Ingo Molnar 已提交
678

P
Peter Zijlstra 已提交
679 680 681 682 683 684
	/*
	 * NOTE: the class-key must be unique. For dynamic locks, a static
	 * lock_class_key variable is passed in through the mutex_init()
	 * (or spin_lock_init()) call - which acts as the key. For static
	 * locks we use the lock object itself as the key.
	 */
P
Peter Zijlstra 已提交
685 686
	BUILD_BUG_ON(sizeof(struct lock_class_key) >
			sizeof(struct lockdep_map));
I
Ingo Molnar 已提交
687

P
Peter Zijlstra 已提交
688
	key = lock->key->subkeys + subclass;
689

P
Peter Zijlstra 已提交
690
	hash_head = classhashentry(key);
691

P
Peter Zijlstra 已提交
692
	/*
693
	 * We do an RCU walk of the hash, see lockdep_free_key_range().
P
Peter Zijlstra 已提交
694
	 */
695 696 697
	if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
		return NULL;

698
	hlist_for_each_entry_rcu(class, hash_head, hash_entry) {
P
Peter Zijlstra 已提交
699
		if (class->key == key) {
P
Peter Zijlstra 已提交
700 701 702 703
			/*
			 * Huh! same key, different name? Did someone trample
			 * on some memory? We're most confused.
			 */
P
Peter Zijlstra 已提交
704
			WARN_ON_ONCE(class->name != lock->name);
P
Peter Zijlstra 已提交
705
			return class;
P
Peter Zijlstra 已提交
706 707
		}
	}
I
Ingo Molnar 已提交
708

709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737
	return NULL;
}

/*
 * Static locks do not have their class-keys yet - for them the key is
 * the lock object itself. If the lock is in the per cpu area, the
 * canonical address of the lock (per cpu offset removed) is used.
 */
static bool assign_lock_key(struct lockdep_map *lock)
{
	unsigned long can_addr, addr = (unsigned long)lock;

	if (__is_kernel_percpu_address(addr, &can_addr))
		lock->key = (void *)can_addr;
	else if (__is_module_percpu_address(addr, &can_addr))
		lock->key = (void *)can_addr;
	else if (static_obj(lock))
		lock->key = (void *)lock;
	else {
		/* Debug-check: all keys must be persistent! */
		debug_locks_off();
		pr_err("INFO: trying to register non-static key.\n");
		pr_err("the code is fine but needs lockdep annotation.\n");
		pr_err("turning off the locking correctness validator.\n");
		dump_stack();
		return false;
	}

	return true;
I
Ingo Molnar 已提交
738 739 740
}

/*
P
Peter Zijlstra 已提交
741 742 743
 * Register a lock's class in the hash-table, if the class is not present
 * yet. Otherwise we look it up. We cache the result in the lock object
 * itself, so actual lookup of the hash should be once per lock object.
I
Ingo Molnar 已提交
744
 */
745
static struct lock_class *
P
Peter Zijlstra 已提交
746
register_lock_class(struct lockdep_map *lock, unsigned int subclass, int force)
I
Ingo Molnar 已提交
747
{
P
Peter Zijlstra 已提交
748
	struct lockdep_subclass_key *key;
749
	struct hlist_head *hash_head;
P
Peter Zijlstra 已提交
750
	struct lock_class *class;
751 752

	DEBUG_LOCKS_WARN_ON(!irqs_disabled());
P
Peter Zijlstra 已提交
753 754

	class = look_up_lock_class(lock, subclass);
755
	if (likely(class))
756
		goto out_set_class_cache;
P
Peter Zijlstra 已提交
757

758 759 760 761
	if (!lock->key) {
		if (!assign_lock_key(lock))
			return NULL;
	} else if (!static_obj(lock->key)) {
P
Peter Zijlstra 已提交
762 763 764 765 766 767 768 769 770 771 772 773 774
		return NULL;
	}

	key = lock->key->subkeys + subclass;
	hash_head = classhashentry(key);

	if (!graph_lock()) {
		return NULL;
	}
	/*
	 * We have to do the hash-walk again, to avoid races
	 * with another CPU:
	 */
775
	hlist_for_each_entry_rcu(class, hash_head, hash_entry) {
P
Peter Zijlstra 已提交
776 777
		if (class->key == key)
			goto out_unlock_set;
778 779
	}

P
Peter Zijlstra 已提交
780 781 782 783 784 785 786 787 788
	/*
	 * Allocate a new key from the static array, and add it to
	 * the hash:
	 */
	if (nr_lock_classes >= MAX_LOCKDEP_KEYS) {
		if (!debug_locks_off_graph_unlock()) {
			return NULL;
		}

789
		print_lockdep_off("BUG: MAX_LOCKDEP_KEYS too low!");
790
		dump_stack();
P
Peter Zijlstra 已提交
791 792 793
		return NULL;
	}
	class = lock_classes + nr_lock_classes++;
794
	debug_atomic_inc(nr_unused_locks);
P
Peter Zijlstra 已提交
795 796 797 798 799 800 801 802 803 804 805
	class->key = key;
	class->name = lock->name;
	class->subclass = subclass;
	INIT_LIST_HEAD(&class->lock_entry);
	INIT_LIST_HEAD(&class->locks_before);
	INIT_LIST_HEAD(&class->locks_after);
	class->name_version = count_matching_names(class);
	/*
	 * We use RCU's safe list-add method to make
	 * parallel walking of the hash-list safe:
	 */
806
	hlist_add_head_rcu(&class->hash_entry, hash_head);
807 808 809 810
	/*
	 * Add it to the global list of classes:
	 */
	list_add_tail_rcu(&class->lock_entry, &all_lock_classes);
P
Peter Zijlstra 已提交
811 812 813 814

	if (verbose(class)) {
		graph_unlock();

815
		printk("\nnew class %px: %s", class->key, class->name);
P
Peter Zijlstra 已提交
816
		if (class->name_version > 1)
D
Dmitry Vyukov 已提交
817 818
			printk(KERN_CONT "#%d", class->name_version);
		printk(KERN_CONT "\n");
P
Peter Zijlstra 已提交
819 820 821 822 823 824 825 826 827
		dump_stack();

		if (!graph_lock()) {
			return NULL;
		}
	}
out_unlock_set:
	graph_unlock();

828
out_set_class_cache:
P
Peter Zijlstra 已提交
829
	if (!subclass || force)
830 831 832
		lock->class_cache[0] = class;
	else if (subclass < NR_LOCKDEP_CACHING_CLASSES)
		lock->class_cache[subclass] = class;
P
Peter Zijlstra 已提交
833

P
Peter Zijlstra 已提交
834 835 836 837
	/*
	 * Hash collision, did we smoke some? We found a class with a matching
	 * hash but the subclass -- which is hashed in -- didn't match.
	 */
P
Peter Zijlstra 已提交
838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854
	if (DEBUG_LOCKS_WARN_ON(class->subclass != subclass))
		return NULL;

	return class;
}

#ifdef CONFIG_PROVE_LOCKING
/*
 * Allocate a lockdep entry. (assumes the graph_lock held, returns
 * with NULL on failure)
 */
static struct lock_list *alloc_list_entry(void)
{
	if (nr_list_entries >= MAX_LOCKDEP_ENTRIES) {
		if (!debug_locks_off_graph_unlock())
			return NULL;

855
		print_lockdep_off("BUG: MAX_LOCKDEP_ENTRIES too low!");
856
		dump_stack();
P
Peter Zijlstra 已提交
857 858 859 860 861 862 863 864
		return NULL;
	}
	return list_entries + nr_list_entries++;
}

/*
 * Add a new dependency to the head of the list:
 */
865 866 867
static int add_lock_to_list(struct lock_class *this, struct list_head *head,
			    unsigned long ip, int distance,
			    struct stack_trace *trace)
P
Peter Zijlstra 已提交
868 869 870 871 872 873 874 875 876 877
{
	struct lock_list *entry;
	/*
	 * Lock not present yet - get a new dependency struct and
	 * add it to the list:
	 */
	entry = alloc_list_entry();
	if (!entry)
		return 0;

878 879
	entry->class = this;
	entry->distance = distance;
Y
Yong Zhang 已提交
880
	entry->trace = *trace;
P
Peter Zijlstra 已提交
881
	/*
882 883 884
	 * Both allocation and removal are done under the graph lock; but
	 * iteration is under RCU-sched; see look_up_lock_class() and
	 * lockdep_free_key_range().
P
Peter Zijlstra 已提交
885 886 887 888 889 890
	 */
	list_add_tail_rcu(&entry->entry, head);

	return 1;
}

P
Peter Zijlstra 已提交
891 892 893
/*
 * For good efficiency of modular, we use power of 2
 */
P
Peter Zijlstra 已提交
894 895 896
#define MAX_CIRCULAR_QUEUE_SIZE		4096UL
#define CQ_MASK				(MAX_CIRCULAR_QUEUE_SIZE-1)

P
Peter Zijlstra 已提交
897 898
/*
 * The circular_queue and helpers is used to implement the
P
Peter Zijlstra 已提交
899 900 901
 * breadth-first search(BFS)algorithem, by which we can build
 * the shortest path from the next lock to be acquired to the
 * previous held lock if there is a circular between them.
P
Peter Zijlstra 已提交
902
 */
P
Peter Zijlstra 已提交
903 904 905 906 907 908 909
struct circular_queue {
	unsigned long element[MAX_CIRCULAR_QUEUE_SIZE];
	unsigned int  front, rear;
};

static struct circular_queue lock_cq;

910
unsigned int max_bfs_queue_depth;
P
Peter Zijlstra 已提交
911

912 913
static unsigned int lockdep_dependency_gen_id;

P
Peter Zijlstra 已提交
914 915 916
static inline void __cq_init(struct circular_queue *cq)
{
	cq->front = cq->rear = 0;
917
	lockdep_dependency_gen_id++;
P
Peter Zijlstra 已提交
918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958
}

static inline int __cq_empty(struct circular_queue *cq)
{
	return (cq->front == cq->rear);
}

static inline int __cq_full(struct circular_queue *cq)
{
	return ((cq->rear + 1) & CQ_MASK) == cq->front;
}

static inline int __cq_enqueue(struct circular_queue *cq, unsigned long elem)
{
	if (__cq_full(cq))
		return -1;

	cq->element[cq->rear] = elem;
	cq->rear = (cq->rear + 1) & CQ_MASK;
	return 0;
}

static inline int __cq_dequeue(struct circular_queue *cq, unsigned long *elem)
{
	if (__cq_empty(cq))
		return -1;

	*elem = cq->element[cq->front];
	cq->front = (cq->front + 1) & CQ_MASK;
	return 0;
}

static inline unsigned int  __cq_get_elem_count(struct circular_queue *cq)
{
	return (cq->rear - cq->front) & CQ_MASK;
}

static inline void mark_lock_accessed(struct lock_list *lock,
					struct lock_list *parent)
{
	unsigned long nr;
P
Peter Zijlstra 已提交
959

P
Peter Zijlstra 已提交
960
	nr = lock - list_entries;
P
Peter Zijlstra 已提交
961
	WARN_ON(nr >= nr_list_entries); /* Out-of-bounds, input fail */
P
Peter Zijlstra 已提交
962
	lock->parent = parent;
963
	lock->class->dep_gen_id = lockdep_dependency_gen_id;
P
Peter Zijlstra 已提交
964 965 966 967 968
}

static inline unsigned long lock_accessed(struct lock_list *lock)
{
	unsigned long nr;
P
Peter Zijlstra 已提交
969

P
Peter Zijlstra 已提交
970
	nr = lock - list_entries;
P
Peter Zijlstra 已提交
971
	WARN_ON(nr >= nr_list_entries); /* Out-of-bounds, input fail */
972
	return lock->class->dep_gen_id == lockdep_dependency_gen_id;
P
Peter Zijlstra 已提交
973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991
}

static inline struct lock_list *get_lock_parent(struct lock_list *child)
{
	return child->parent;
}

static inline int get_lock_depth(struct lock_list *child)
{
	int depth = 0;
	struct lock_list *parent;

	while ((parent = get_lock_parent(child))) {
		child = parent;
		depth++;
	}
	return depth;
}

992
static int __bfs(struct lock_list *source_entry,
P
Peter Zijlstra 已提交
993 994 995 996
		 void *data,
		 int (*match)(struct lock_list *entry, void *data),
		 struct lock_list **target_entry,
		 int forward)
997 998
{
	struct lock_list *entry;
999
	struct list_head *head;
1000 1001 1002
	struct circular_queue *cq = &lock_cq;
	int ret = 1;

1003
	if (match(source_entry, data)) {
1004 1005 1006 1007 1008
		*target_entry = source_entry;
		ret = 0;
		goto exit;
	}

1009 1010 1011 1012 1013 1014 1015 1016 1017
	if (forward)
		head = &source_entry->class->locks_after;
	else
		head = &source_entry->class->locks_before;

	if (list_empty(head))
		goto exit;

	__cq_init(cq);
1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034
	__cq_enqueue(cq, (unsigned long)source_entry);

	while (!__cq_empty(cq)) {
		struct lock_list *lock;

		__cq_dequeue(cq, (unsigned long *)&lock);

		if (!lock->class) {
			ret = -2;
			goto exit;
		}

		if (forward)
			head = &lock->class->locks_after;
		else
			head = &lock->class->locks_before;

1035 1036 1037
		DEBUG_LOCKS_WARN_ON(!irqs_disabled());

		list_for_each_entry_rcu(entry, head, entry) {
1038
			if (!lock_accessed(entry)) {
1039
				unsigned int cq_depth;
1040
				mark_lock_accessed(entry, lock);
1041
				if (match(entry, data)) {
1042 1043 1044 1045 1046 1047 1048 1049 1050
					*target_entry = entry;
					ret = 0;
					goto exit;
				}

				if (__cq_enqueue(cq, (unsigned long)entry)) {
					ret = -1;
					goto exit;
				}
1051 1052 1053
				cq_depth = __cq_get_elem_count(cq);
				if (max_bfs_queue_depth < cq_depth)
					max_bfs_queue_depth = cq_depth;
1054 1055 1056 1057 1058 1059 1060
			}
		}
	}
exit:
	return ret;
}

1061
static inline int __bfs_forwards(struct lock_list *src_entry,
1062 1063 1064
			void *data,
			int (*match)(struct lock_list *entry, void *data),
			struct lock_list **target_entry)
1065
{
1066
	return __bfs(src_entry, data, match, target_entry, 1);
1067 1068 1069

}

1070
static inline int __bfs_backwards(struct lock_list *src_entry,
1071 1072 1073
			void *data,
			int (*match)(struct lock_list *entry, void *data),
			struct lock_list **target_entry)
1074
{
1075
	return __bfs(src_entry, data, match, target_entry, 0);
1076 1077 1078

}

P
Peter Zijlstra 已提交
1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089
/*
 * Recursive, forwards-direction lock-dependency checking, used for
 * both noncyclic checking and for hardirq-unsafe/softirq-unsafe
 * checking.
 */

/*
 * Print a dependency chain entry (this is only done when a deadlock
 * has been detected):
 */
static noinline int
1090
print_circular_bug_entry(struct lock_list *target, int depth)
P
Peter Zijlstra 已提交
1091 1092 1093 1094 1095
{
	if (debug_locks_silent)
		return 0;
	printk("\n-> #%u", depth);
	print_lock_name(target->class);
D
Dmitry Vyukov 已提交
1096
	printk(KERN_CONT ":\n");
P
Peter Zijlstra 已提交
1097 1098 1099 1100 1101
	print_stack_trace(&target->trace, 6);

	return 0;
}

1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126
static void
print_circular_lock_scenario(struct held_lock *src,
			     struct held_lock *tgt,
			     struct lock_list *prt)
{
	struct lock_class *source = hlock_class(src);
	struct lock_class *target = hlock_class(tgt);
	struct lock_class *parent = prt->class;

	/*
	 * A direct locking problem where unsafe_class lock is taken
	 * directly by safe_class lock, then all we need to show
	 * is the deadlock scenario, as it is obvious that the
	 * unsafe lock is taken under the safe lock.
	 *
	 * But if there is a chain instead, where the safe lock takes
	 * an intermediate lock (middle_class) where this lock is
	 * not the same as the safe lock, then the lock chain is
	 * used to describe the problem. Otherwise we would need
	 * to show a different CPU case for each link in the chain
	 * from the safe_class lock to the unsafe_class lock.
	 */
	if (parent != source) {
		printk("Chain exists of:\n  ");
		__print_lock_name(source);
D
Dmitry Vyukov 已提交
1127
		printk(KERN_CONT " --> ");
1128
		__print_lock_name(parent);
D
Dmitry Vyukov 已提交
1129
		printk(KERN_CONT " --> ");
1130
		__print_lock_name(target);
D
Dmitry Vyukov 已提交
1131
		printk(KERN_CONT "\n\n");
1132 1133
	}

1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149
	printk(" Possible unsafe locking scenario:\n\n");
	printk("       CPU0                    CPU1\n");
	printk("       ----                    ----\n");
	printk("  lock(");
	__print_lock_name(target);
	printk(KERN_CONT ");\n");
	printk("                               lock(");
	__print_lock_name(parent);
	printk(KERN_CONT ");\n");
	printk("                               lock(");
	__print_lock_name(target);
	printk(KERN_CONT ");\n");
	printk("  lock(");
	__print_lock_name(source);
	printk(KERN_CONT ");\n");
	printk("\n *** DEADLOCK ***\n\n");
1150 1151
}

P
Peter Zijlstra 已提交
1152 1153 1154 1155 1156
/*
 * When a circular dependency is detected, print the
 * header first:
 */
static noinline int
1157 1158 1159
print_circular_bug_header(struct lock_list *entry, unsigned int depth,
			struct held_lock *check_src,
			struct held_lock *check_tgt)
P
Peter Zijlstra 已提交
1160 1161 1162
{
	struct task_struct *curr = current;

1163
	if (debug_locks_silent)
P
Peter Zijlstra 已提交
1164 1165
		return 0;

1166
	pr_warn("\n");
1167 1168
	pr_warn("======================================================\n");
	pr_warn("WARNING: possible circular locking dependency detected\n");
1169
	print_kernel_ident();
1170
	pr_warn("------------------------------------------------------\n");
1171
	pr_warn("%s/%d is trying to acquire lock:\n",
1172
		curr->comm, task_pid_nr(curr));
1173
	print_lock(check_src);
1174

1175
	pr_warn("\nbut task is already holding lock:\n");
1176

1177
	print_lock(check_tgt);
1178 1179
	pr_warn("\nwhich lock already depends on the new lock.\n\n");
	pr_warn("\nthe existing dependency chain (in reverse order) is:\n");
P
Peter Zijlstra 已提交
1180 1181 1182 1183 1184 1185

	print_circular_bug_entry(entry, depth);

	return 0;
}

1186 1187 1188 1189 1190
static inline int class_equal(struct lock_list *entry, void *data)
{
	return entry->class == data;
}

1191 1192 1193
static noinline int print_circular_bug(struct lock_list *this,
				struct lock_list *target,
				struct held_lock *check_src,
1194 1195
				struct held_lock *check_tgt,
				struct stack_trace *trace)
P
Peter Zijlstra 已提交
1196 1197
{
	struct task_struct *curr = current;
1198
	struct lock_list *parent;
1199
	struct lock_list *first_parent;
1200
	int depth;
P
Peter Zijlstra 已提交
1201

1202
	if (!debug_locks_off_graph_unlock() || debug_locks_silent)
P
Peter Zijlstra 已提交
1203 1204
		return 0;

1205
	if (!save_trace(&this->trace))
P
Peter Zijlstra 已提交
1206 1207
		return 0;

1208 1209
	depth = get_lock_depth(target);

1210
	print_circular_bug_header(target, depth, check_src, check_tgt);
1211 1212

	parent = get_lock_parent(target);
1213
	first_parent = parent;
1214 1215 1216 1217 1218

	while (parent) {
		print_circular_bug_entry(parent, --depth);
		parent = get_lock_parent(parent);
	}
P
Peter Zijlstra 已提交
1219 1220

	printk("\nother info that might help us debug this:\n\n");
1221 1222 1223
	print_circular_lock_scenario(check_src, check_tgt,
				     first_parent);

P
Peter Zijlstra 已提交
1224 1225 1226 1227 1228 1229 1230 1231
	lockdep_print_held_locks(curr);

	printk("\nstack backtrace:\n");
	dump_stack();

	return 0;
}

1232 1233 1234 1235 1236
static noinline int print_bfs_bug(int ret)
{
	if (!debug_locks_off_graph_unlock())
		return 0;

P
Peter Zijlstra 已提交
1237 1238 1239
	/*
	 * Breadth-first-search failed, graph got corrupted?
	 */
1240 1241 1242 1243 1244
	WARN(1, "lockdep bfs error:%d\n", ret);

	return 0;
}

1245
static int noop_count(struct lock_list *entry, void *data)
1246
{
1247 1248 1249
	(*(unsigned long *)data)++;
	return 0;
}
1250

1251
static unsigned long __lockdep_count_forward_deps(struct lock_list *this)
1252 1253 1254
{
	unsigned long  count = 0;
	struct lock_list *uninitialized_var(target_entry);
1255

1256
	__bfs_forwards(this, (void *)&count, noop_count, &target_entry);
1257

1258
	return count;
1259 1260 1261 1262
}
unsigned long lockdep_count_forward_deps(struct lock_class *class)
{
	unsigned long ret, flags;
1263 1264 1265 1266
	struct lock_list this;

	this.parent = NULL;
	this.class = class;
1267

1268
	raw_local_irq_save(flags);
1269
	arch_spin_lock(&lockdep_lock);
1270
	ret = __lockdep_count_forward_deps(&this);
1271
	arch_spin_unlock(&lockdep_lock);
1272
	raw_local_irq_restore(flags);
1273 1274 1275 1276

	return ret;
}

1277
static unsigned long __lockdep_count_backward_deps(struct lock_list *this)
1278
{
1279 1280
	unsigned long  count = 0;
	struct lock_list *uninitialized_var(target_entry);
1281

1282
	__bfs_backwards(this, (void *)&count, noop_count, &target_entry);
1283

1284
	return count;
1285 1286 1287 1288 1289
}

unsigned long lockdep_count_backward_deps(struct lock_class *class)
{
	unsigned long ret, flags;
1290 1291 1292 1293
	struct lock_list this;

	this.parent = NULL;
	this.class = class;
1294

1295
	raw_local_irq_save(flags);
1296
	arch_spin_lock(&lockdep_lock);
1297
	ret = __lockdep_count_backward_deps(&this);
1298
	arch_spin_unlock(&lockdep_lock);
1299
	raw_local_irq_restore(flags);
1300 1301 1302 1303

	return ret;
}

P
Peter Zijlstra 已提交
1304 1305 1306 1307 1308
/*
 * Prove that the dependency graph starting at <entry> can not
 * lead to <target>. Print an error and return 0 if it does.
 */
static noinline int
1309 1310
check_noncircular(struct lock_list *root, struct lock_class *target,
		struct lock_list **target_entry)
P
Peter Zijlstra 已提交
1311
{
1312
	int result;
P
Peter Zijlstra 已提交
1313

1314
	debug_atomic_inc(nr_cyclic_checks);
1315

1316
	result = __bfs_forwards(root, target, class_equal, target_entry);
I
Ingo Molnar 已提交
1317

1318 1319
	return result;
}
1320

1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333
static noinline int
check_redundant(struct lock_list *root, struct lock_class *target,
		struct lock_list **target_entry)
{
	int result;

	debug_atomic_inc(nr_redundant_checks);

	result = __bfs_forwards(root, target, class_equal, target_entry);

	return result;
}

1334
#if defined(CONFIG_TRACE_IRQFLAGS) && defined(CONFIG_PROVE_LOCKING)
I
Ingo Molnar 已提交
1335 1336 1337 1338 1339 1340
/*
 * Forwards and backwards subgraph searching, for the purposes of
 * proving that two subgraphs can be connected by a new dependency
 * without creating any illegal irq-safe -> irq-unsafe lock dependency.
 */

1341 1342 1343 1344 1345 1346 1347
static inline int usage_match(struct lock_list *entry, void *bit)
{
	return entry->class->usage_mask & (1 << (enum lock_usage_bit)bit);
}



I
Ingo Molnar 已提交
1348 1349
/*
 * Find a node in the forwards-direction dependency sub-graph starting
1350
 * at @root->class that matches @bit.
I
Ingo Molnar 已提交
1351
 *
1352 1353
 * Return 0 if such a node exists in the subgraph, and put that node
 * into *@target_entry.
I
Ingo Molnar 已提交
1354
 *
1355 1356
 * Return 1 otherwise and keep *@target_entry unchanged.
 * Return <0 on error.
I
Ingo Molnar 已提交
1357
 */
1358 1359 1360
static int
find_usage_forwards(struct lock_list *root, enum lock_usage_bit bit,
			struct lock_list **target_entry)
I
Ingo Molnar 已提交
1361
{
1362
	int result;
I
Ingo Molnar 已提交
1363

1364
	debug_atomic_inc(nr_find_usage_forwards_checks);
I
Ingo Molnar 已提交
1365

1366 1367 1368
	result = __bfs_forwards(root, (void *)bit, usage_match, target_entry);

	return result;
I
Ingo Molnar 已提交
1369 1370 1371 1372
}

/*
 * Find a node in the backwards-direction dependency sub-graph starting
1373
 * at @root->class that matches @bit.
I
Ingo Molnar 已提交
1374
 *
1375 1376
 * Return 0 if such a node exists in the subgraph, and put that node
 * into *@target_entry.
I
Ingo Molnar 已提交
1377
 *
1378 1379
 * Return 1 otherwise and keep *@target_entry unchanged.
 * Return <0 on error.
I
Ingo Molnar 已提交
1380
 */
1381 1382 1383
static int
find_usage_backwards(struct lock_list *root, enum lock_usage_bit bit,
			struct lock_list **target_entry)
I
Ingo Molnar 已提交
1384
{
1385
	int result;
I
Ingo Molnar 已提交
1386

1387
	debug_atomic_inc(nr_find_usage_backwards_checks);
I
Ingo Molnar 已提交
1388

1389
	result = __bfs_backwards(root, (void *)bit, usage_match, target_entry);
D
Dave Jones 已提交
1390

1391
	return result;
I
Ingo Molnar 已提交
1392 1393
}

P
Peter Zijlstra 已提交
1394 1395 1396 1397 1398 1399
static void print_lock_class_header(struct lock_class *class, int depth)
{
	int bit;

	printk("%*s->", depth, "");
	print_lock_name(class);
D
Dmitry Vyukov 已提交
1400 1401
	printk(KERN_CONT " ops: %lu", class->ops);
	printk(KERN_CONT " {\n");
P
Peter Zijlstra 已提交
1402 1403 1404 1405 1406 1407

	for (bit = 0; bit < LOCK_USAGE_STATES; bit++) {
		if (class->usage_mask & (1 << bit)) {
			int len = depth;

			len += printk("%*s   %s", depth, "", usage_str[bit]);
D
Dmitry Vyukov 已提交
1408
			len += printk(KERN_CONT " at:\n");
P
Peter Zijlstra 已提交
1409 1410 1411 1412 1413
			print_stack_trace(class->usage_traces + bit, len);
		}
	}
	printk("%*s }\n", depth, "");

1414
	printk("%*s ... key      at: [<%px>] %pS\n",
D
Dmitry Vyukov 已提交
1415
		depth, "", class->key, class->key);
P
Peter Zijlstra 已提交
1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437
}

/*
 * printk the shortest lock dependencies from @start to @end in reverse order:
 */
static void __used
print_shortest_lock_dependencies(struct lock_list *leaf,
				struct lock_list *root)
{
	struct lock_list *entry = leaf;
	int depth;

	/*compute depth from generated tree by BFS*/
	depth = get_lock_depth(leaf);

	do {
		print_lock_class_header(entry->class, depth);
		printk("%*s ... acquired at:\n", depth, "");
		print_stack_trace(&entry->trace, 2);
		printk("\n");

		if (depth == 0 && (entry != root)) {
1438
			printk("lockdep:%s bad path found in chain graph\n", __func__);
P
Peter Zijlstra 已提交
1439 1440 1441 1442 1443 1444 1445 1446 1447
			break;
		}

		entry = get_lock_parent(entry);
		depth--;
	} while (entry && (depth >= 0));

	return;
}
1448

1449 1450 1451
static void
print_irq_lock_scenario(struct lock_list *safe_entry,
			struct lock_list *unsafe_entry,
1452 1453
			struct lock_class *prev_class,
			struct lock_class *next_class)
1454 1455 1456
{
	struct lock_class *safe_class = safe_entry->class;
	struct lock_class *unsafe_class = unsafe_entry->class;
1457
	struct lock_class *middle_class = prev_class;
1458 1459

	if (middle_class == safe_class)
1460
		middle_class = next_class;
1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477

	/*
	 * A direct locking problem where unsafe_class lock is taken
	 * directly by safe_class lock, then all we need to show
	 * is the deadlock scenario, as it is obvious that the
	 * unsafe lock is taken under the safe lock.
	 *
	 * But if there is a chain instead, where the safe lock takes
	 * an intermediate lock (middle_class) where this lock is
	 * not the same as the safe lock, then the lock chain is
	 * used to describe the problem. Otherwise we would need
	 * to show a different CPU case for each link in the chain
	 * from the safe_class lock to the unsafe_class lock.
	 */
	if (middle_class != unsafe_class) {
		printk("Chain exists of:\n  ");
		__print_lock_name(safe_class);
D
Dmitry Vyukov 已提交
1478
		printk(KERN_CONT " --> ");
1479
		__print_lock_name(middle_class);
D
Dmitry Vyukov 已提交
1480
		printk(KERN_CONT " --> ");
1481
		__print_lock_name(unsafe_class);
D
Dmitry Vyukov 已提交
1482
		printk(KERN_CONT "\n\n");
1483 1484 1485 1486 1487 1488 1489
	}

	printk(" Possible interrupt unsafe locking scenario:\n\n");
	printk("       CPU0                    CPU1\n");
	printk("       ----                    ----\n");
	printk("  lock(");
	__print_lock_name(unsafe_class);
D
Dmitry Vyukov 已提交
1490
	printk(KERN_CONT ");\n");
1491 1492 1493
	printk("                               local_irq_disable();\n");
	printk("                               lock(");
	__print_lock_name(safe_class);
D
Dmitry Vyukov 已提交
1494
	printk(KERN_CONT ");\n");
1495 1496
	printk("                               lock(");
	__print_lock_name(middle_class);
D
Dmitry Vyukov 已提交
1497
	printk(KERN_CONT ");\n");
1498 1499 1500
	printk("  <Interrupt>\n");
	printk("    lock(");
	__print_lock_name(safe_class);
D
Dmitry Vyukov 已提交
1501
	printk(KERN_CONT ");\n");
1502 1503 1504
	printk("\n *** DEADLOCK ***\n\n");
}

I
Ingo Molnar 已提交
1505 1506
static int
print_bad_irq_dependency(struct task_struct *curr,
1507 1508 1509 1510
			 struct lock_list *prev_root,
			 struct lock_list *next_root,
			 struct lock_list *backwards_entry,
			 struct lock_list *forwards_entry,
I
Ingo Molnar 已提交
1511 1512 1513 1514 1515 1516
			 struct held_lock *prev,
			 struct held_lock *next,
			 enum lock_usage_bit bit1,
			 enum lock_usage_bit bit2,
			 const char *irqclass)
{
1517
	if (!debug_locks_off_graph_unlock() || debug_locks_silent)
I
Ingo Molnar 已提交
1518 1519
		return 0;

1520
	pr_warn("\n");
1521 1522
	pr_warn("=====================================================\n");
	pr_warn("WARNING: %s-safe -> %s-unsafe lock order detected\n",
I
Ingo Molnar 已提交
1523
		irqclass, irqclass);
1524
	print_kernel_ident();
1525
	pr_warn("-----------------------------------------------------\n");
1526
	pr_warn("%s/%d [HC%u[%lu]:SC%u[%lu]:HE%u:SE%u] is trying to acquire:\n",
1527
		curr->comm, task_pid_nr(curr),
I
Ingo Molnar 已提交
1528 1529 1530 1531 1532 1533
		curr->hardirq_context, hardirq_count() >> HARDIRQ_SHIFT,
		curr->softirq_context, softirq_count() >> SOFTIRQ_SHIFT,
		curr->hardirqs_enabled,
		curr->softirqs_enabled);
	print_lock(next);

1534
	pr_warn("\nand this task is already holding:\n");
I
Ingo Molnar 已提交
1535
	print_lock(prev);
1536
	pr_warn("which would create a new lock dependency:\n");
D
Dave Jones 已提交
1537
	print_lock_name(hlock_class(prev));
1538
	pr_cont(" ->");
D
Dave Jones 已提交
1539
	print_lock_name(hlock_class(next));
1540
	pr_cont("\n");
I
Ingo Molnar 已提交
1541

1542
	pr_warn("\nbut this new dependency connects a %s-irq-safe lock:\n",
I
Ingo Molnar 已提交
1543
		irqclass);
1544
	print_lock_name(backwards_entry->class);
1545
	pr_warn("\n... which became %s-irq-safe at:\n", irqclass);
I
Ingo Molnar 已提交
1546

1547
	print_stack_trace(backwards_entry->class->usage_traces + bit1, 1);
I
Ingo Molnar 已提交
1548

1549
	pr_warn("\nto a %s-irq-unsafe lock:\n", irqclass);
1550
	print_lock_name(forwards_entry->class);
1551 1552
	pr_warn("\n... which became %s-irq-unsafe at:\n", irqclass);
	pr_warn("...");
I
Ingo Molnar 已提交
1553

1554
	print_stack_trace(forwards_entry->class->usage_traces + bit2, 1);
I
Ingo Molnar 已提交
1555

1556
	pr_warn("\nother info that might help us debug this:\n\n");
1557 1558
	print_irq_lock_scenario(backwards_entry, forwards_entry,
				hlock_class(prev), hlock_class(next));
1559

I
Ingo Molnar 已提交
1560 1561
	lockdep_print_held_locks(curr);

1562
	pr_warn("\nthe dependencies between %s-irq-safe lock and the holding lock:\n", irqclass);
1563 1564 1565
	if (!save_trace(&prev_root->trace))
		return 0;
	print_shortest_lock_dependencies(backwards_entry, prev_root);
I
Ingo Molnar 已提交
1566

1567 1568
	pr_warn("\nthe dependencies between the lock to be acquired");
	pr_warn(" and %s-irq-unsafe lock:\n", irqclass);
1569 1570 1571
	if (!save_trace(&next_root->trace))
		return 0;
	print_shortest_lock_dependencies(forwards_entry, next_root);
I
Ingo Molnar 已提交
1572

1573
	pr_warn("\nstack backtrace:\n");
I
Ingo Molnar 已提交
1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584
	dump_stack();

	return 0;
}

static int
check_usage(struct task_struct *curr, struct held_lock *prev,
	    struct held_lock *next, enum lock_usage_bit bit_backwards,
	    enum lock_usage_bit bit_forwards, const char *irqclass)
{
	int ret;
1585
	struct lock_list this, that;
1586
	struct lock_list *uninitialized_var(target_entry);
1587
	struct lock_list *uninitialized_var(target_entry1);
1588 1589 1590 1591 1592

	this.parent = NULL;

	this.class = hlock_class(prev);
	ret = find_usage_backwards(&this, bit_backwards, &target_entry);
P
Peter Zijlstra 已提交
1593 1594 1595 1596
	if (ret < 0)
		return print_bfs_bug(ret);
	if (ret == 1)
		return ret;
1597

1598 1599 1600
	that.parent = NULL;
	that.class = hlock_class(next);
	ret = find_usage_forwards(&that, bit_forwards, &target_entry1);
P
Peter Zijlstra 已提交
1601 1602 1603 1604
	if (ret < 0)
		return print_bfs_bug(ret);
	if (ret == 1)
		return ret;
I
Ingo Molnar 已提交
1605

1606 1607 1608
	return print_bad_irq_dependency(curr, &this, &that,
			target_entry, target_entry1,
			prev, next,
I
Ingo Molnar 已提交
1609 1610 1611
			bit_backwards, bit_forwards, irqclass);
}

1612 1613
static const char *state_names[] = {
#define LOCKDEP_STATE(__STATE) \
P
Peter Zijlstra 已提交
1614
	__stringify(__STATE),
1615 1616 1617 1618 1619 1620
#include "lockdep_states.h"
#undef LOCKDEP_STATE
};

static const char *state_rnames[] = {
#define LOCKDEP_STATE(__STATE) \
P
Peter Zijlstra 已提交
1621
	__stringify(__STATE)"-READ",
1622 1623 1624 1625 1626
#include "lockdep_states.h"
#undef LOCKDEP_STATE
};

static inline const char *state_name(enum lock_usage_bit bit)
P
Peter Zijlstra 已提交
1627
{
1628 1629
	return (bit & 1) ? state_rnames[bit >> 2] : state_names[bit >> 2];
}
P
Peter Zijlstra 已提交
1630

1631 1632
static int exclusive_bit(int new_bit)
{
P
Peter Zijlstra 已提交
1633
	/*
1634 1635 1636 1637 1638 1639 1640 1641
	 * USED_IN
	 * USED_IN_READ
	 * ENABLED
	 * ENABLED_READ
	 *
	 * bit 0 - write/read
	 * bit 1 - used_in/enabled
	 * bit 2+  state
P
Peter Zijlstra 已提交
1642
	 */
1643 1644 1645

	int state = new_bit & ~3;
	int dir = new_bit & 2;
P
Peter Zijlstra 已提交
1646 1647

	/*
1648
	 * keep state, bit flip the direction and strip read.
P
Peter Zijlstra 已提交
1649
	 */
1650 1651 1652 1653 1654 1655
	return state | (dir ^ 2);
}

static int check_irq_usage(struct task_struct *curr, struct held_lock *prev,
			   struct held_lock *next, enum lock_usage_bit bit)
{
P
Peter Zijlstra 已提交
1656
	/*
1657 1658
	 * Prove that the new dependency does not connect a hardirq-safe
	 * lock with a hardirq-unsafe lock - to achieve this we search
P
Peter Zijlstra 已提交
1659 1660 1661
	 * the backwards-subgraph starting at <prev>, and the
	 * forwards-subgraph starting at <next>:
	 */
1662 1663
	if (!check_usage(curr, prev, next, bit,
			   exclusive_bit(bit), state_name(bit)))
P
Peter Zijlstra 已提交
1664 1665
		return 0;

1666 1667
	bit++; /* _READ */

1668
	/*
1669 1670
	 * Prove that the new dependency does not connect a hardirq-safe-read
	 * lock with a hardirq-unsafe lock - to achieve this we search
1671 1672 1673
	 * the backwards-subgraph starting at <prev>, and the
	 * forwards-subgraph starting at <next>:
	 */
1674 1675
	if (!check_usage(curr, prev, next, bit,
			   exclusive_bit(bit), state_name(bit)))
1676 1677
		return 0;

1678 1679 1680 1681 1682 1683 1684 1685 1686
	return 1;
}

static int
check_prev_add_irq(struct task_struct *curr, struct held_lock *prev,
		struct held_lock *next)
{
#define LOCKDEP_STATE(__STATE)						\
	if (!check_irq_usage(curr, prev, next, LOCK_USED_IN_##__STATE))	\
1687
		return 0;
1688 1689
#include "lockdep_states.h"
#undef LOCKDEP_STATE
1690

P
Peter Zijlstra 已提交
1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719
	return 1;
}

static void inc_chains(void)
{
	if (current->hardirq_context)
		nr_hardirq_chains++;
	else {
		if (current->softirq_context)
			nr_softirq_chains++;
		else
			nr_process_chains++;
	}
}

#else

static inline int
check_prev_add_irq(struct task_struct *curr, struct held_lock *prev,
		struct held_lock *next)
{
	return 1;
}

static inline void inc_chains(void)
{
	nr_process_chains++;
}

I
Ingo Molnar 已提交
1720 1721
#endif

1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733
static void
print_deadlock_scenario(struct held_lock *nxt,
			     struct held_lock *prv)
{
	struct lock_class *next = hlock_class(nxt);
	struct lock_class *prev = hlock_class(prv);

	printk(" Possible unsafe locking scenario:\n\n");
	printk("       CPU0\n");
	printk("       ----\n");
	printk("  lock(");
	__print_lock_name(prev);
D
Dmitry Vyukov 已提交
1734
	printk(KERN_CONT ");\n");
1735 1736
	printk("  lock(");
	__print_lock_name(next);
D
Dmitry Vyukov 已提交
1737
	printk(KERN_CONT ");\n");
1738 1739 1740 1741
	printk("\n *** DEADLOCK ***\n\n");
	printk(" May be due to missing lock nesting notation\n\n");
}

I
Ingo Molnar 已提交
1742 1743 1744 1745
static int
print_deadlock_bug(struct task_struct *curr, struct held_lock *prev,
		   struct held_lock *next)
{
1746
	if (!debug_locks_off_graph_unlock() || debug_locks_silent)
I
Ingo Molnar 已提交
1747 1748
		return 0;

1749
	pr_warn("\n");
1750 1751
	pr_warn("============================================\n");
	pr_warn("WARNING: possible recursive locking detected\n");
1752
	print_kernel_ident();
1753
	pr_warn("--------------------------------------------\n");
1754
	pr_warn("%s/%d is trying to acquire lock:\n",
1755
		curr->comm, task_pid_nr(curr));
I
Ingo Molnar 已提交
1756
	print_lock(next);
1757
	pr_warn("\nbut task is already holding lock:\n");
I
Ingo Molnar 已提交
1758 1759
	print_lock(prev);

1760
	pr_warn("\nother info that might help us debug this:\n");
1761
	print_deadlock_scenario(next, prev);
I
Ingo Molnar 已提交
1762 1763
	lockdep_print_held_locks(curr);

1764
	pr_warn("\nstack backtrace:\n");
I
Ingo Molnar 已提交
1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782
	dump_stack();

	return 0;
}

/*
 * Check whether we are holding such a class already.
 *
 * (Note that this has to be done separately, because the graph cannot
 * detect such classes of deadlocks.)
 *
 * Returns: 0 on deadlock detected, 1 on OK, 2 on recursive read
 */
static int
check_deadlock(struct task_struct *curr, struct held_lock *next,
	       struct lockdep_map *next_instance, int read)
{
	struct held_lock *prev;
P
Peter Zijlstra 已提交
1783
	struct held_lock *nest = NULL;
I
Ingo Molnar 已提交
1784 1785 1786 1787
	int i;

	for (i = 0; i < curr->lockdep_depth; i++) {
		prev = curr->held_locks + i;
P
Peter Zijlstra 已提交
1788 1789 1790 1791

		if (prev->instance == next->nest_lock)
			nest = prev;

D
Dave Jones 已提交
1792
		if (hlock_class(prev) != hlock_class(next))
I
Ingo Molnar 已提交
1793
			continue;
P
Peter Zijlstra 已提交
1794

I
Ingo Molnar 已提交
1795 1796
		/*
		 * Allow read-after-read recursion of the same
1797
		 * lock class (i.e. read_lock(lock)+read_lock(lock)):
I
Ingo Molnar 已提交
1798
		 */
1799
		if ((read == 2) && prev->read)
I
Ingo Molnar 已提交
1800
			return 2;
P
Peter Zijlstra 已提交
1801 1802 1803 1804 1805 1806 1807 1808

		/*
		 * We're holding the nest_lock, which serializes this lock's
		 * nesting behaviour.
		 */
		if (nest)
			return 2;

I
Ingo Molnar 已提交
1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837
		return print_deadlock_bug(curr, prev, next);
	}
	return 1;
}

/*
 * There was a chain-cache miss, and we are about to add a new dependency
 * to a previous lock. We recursively validate the following rules:
 *
 *  - would the adding of the <prev> -> <next> dependency create a
 *    circular dependency in the graph? [== circular deadlock]
 *
 *  - does the new prev->next dependency connect any hardirq-safe lock
 *    (in the full backwards-subgraph starting at <prev>) with any
 *    hardirq-unsafe lock (in the full forwards-subgraph starting at
 *    <next>)? [== illegal lock inversion with hardirq contexts]
 *
 *  - does the new prev->next dependency connect any softirq-safe lock
 *    (in the full backwards-subgraph starting at <prev>) with any
 *    softirq-unsafe lock (in the full forwards-subgraph starting at
 *    <next>)? [== illegal lock inversion with softirq contexts]
 *
 * any of these scenarios could lead to a deadlock.
 *
 * Then if all the validations pass, we add the forwards and backwards
 * dependency.
 */
static int
check_prev_add(struct task_struct *curr, struct held_lock *prev,
1838 1839
	       struct held_lock *next, int distance, struct stack_trace *trace,
	       int (*save)(struct stack_trace *trace))
I
Ingo Molnar 已提交
1840
{
1841
	struct lock_list *uninitialized_var(target_entry);
I
Ingo Molnar 已提交
1842
	struct lock_list *entry;
1843
	struct lock_list this;
1844
	int ret;
I
Ingo Molnar 已提交
1845 1846 1847 1848 1849 1850 1851 1852 1853 1854

	/*
	 * Prove that the new <prev> -> <next> dependency would not
	 * create a circular dependency in the graph. (We do this by
	 * forward-recursing into the graph starting at <next>, and
	 * checking whether we can reach <prev>.)
	 *
	 * We are using global variables to control the recursion, to
	 * keep the stackframe size of the recursive functions low:
	 */
1855 1856 1857
	this.class = hlock_class(next);
	this.parent = NULL;
	ret = check_noncircular(&this, hlock_class(prev), &target_entry);
1858 1859 1860 1861 1862 1863 1864 1865 1866
	if (unlikely(!ret)) {
		if (!trace->entries) {
			/*
			 * If @save fails here, the printing might trigger
			 * a WARN but because of the !nr_entries it should
			 * not do bad things.
			 */
			save(trace);
		}
1867
		return print_circular_bug(&this, target_entry, next, prev, trace);
1868
	}
1869 1870
	else if (unlikely(ret < 0))
		return print_bfs_bug(ret);
1871

P
Peter Zijlstra 已提交
1872
	if (!check_prev_add_irq(curr, prev, next))
I
Ingo Molnar 已提交
1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892
		return 0;

	/*
	 * For recursive read-locks we do all the dependency checks,
	 * but we dont store read-triggered dependencies (only
	 * write-triggered dependencies). This ensures that only the
	 * write-side dependencies matter, and that if for example a
	 * write-lock never takes any other locks, then the reads are
	 * equivalent to a NOP.
	 */
	if (next->read == 2 || prev->read == 2)
		return 1;
	/*
	 * Is the <prev> -> <next> dependency already present?
	 *
	 * (this may occur even though this is a new chain: consider
	 *  e.g. the L1 -> L2 -> L3 -> L4 and the L5 -> L1 -> L2 -> L3
	 *  chains - the second one will be new, but L1 already has
	 *  L2 added to its dependency list, due to the first chain.)
	 */
D
Dave Jones 已提交
1893 1894
	list_for_each_entry(entry, &hlock_class(prev)->locks_after, entry) {
		if (entry->class == hlock_class(next)) {
1895 1896
			if (distance == 1)
				entry->distance = 1;
1897
			return 1;
1898
		}
I
Ingo Molnar 已提交
1899 1900
	}

1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914
	/*
	 * Is the <prev> -> <next> link redundant?
	 */
	this.class = hlock_class(prev);
	this.parent = NULL;
	ret = check_redundant(&this, hlock_class(next), &target_entry);
	if (!ret) {
		debug_atomic_inc(nr_redundant);
		return 2;
	}
	if (ret < 0)
		return print_bfs_bug(ret);


1915
	if (!trace->entries && !save(trace))
1916
		return 0;
Y
Yong Zhang 已提交
1917

I
Ingo Molnar 已提交
1918 1919 1920 1921
	/*
	 * Ok, all validations passed, add the new lock
	 * to the previous lock's dependency list:
	 */
1922
	ret = add_lock_to_list(hlock_class(next),
D
Dave Jones 已提交
1923
			       &hlock_class(prev)->locks_after,
1924
			       next->acquire_ip, distance, trace);
1925

I
Ingo Molnar 已提交
1926 1927
	if (!ret)
		return 0;
1928

1929
	ret = add_lock_to_list(hlock_class(prev),
D
Dave Jones 已提交
1930
			       &hlock_class(next)->locks_before,
1931
			       next->acquire_ip, distance, trace);
1932 1933
	if (!ret)
		return 0;
I
Ingo Molnar 已提交
1934

1935
	return 2;
P
Peter Zijlstra 已提交
1936
}
I
Ingo Molnar 已提交
1937

P
Peter Zijlstra 已提交
1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948
/*
 * Add the dependency to all directly-previous locks that are 'relevant'.
 * The ones that are relevant are (in increasing distance from curr):
 * all consecutive trylock entries and the final non-trylock entry - or
 * the end of this context's lock-chain - whichever comes first.
 */
static int
check_prevs_add(struct task_struct *curr, struct held_lock *next)
{
	int depth = curr->lockdep_depth;
	struct held_lock *hlock;
1949 1950 1951 1952 1953 1954
	struct stack_trace trace = {
		.nr_entries = 0,
		.max_entries = 0,
		.entries = NULL,
		.skip = 0,
	};
1955

I
Ingo Molnar 已提交
1956
	/*
P
Peter Zijlstra 已提交
1957 1958 1959
	 * Debugging checks.
	 *
	 * Depth must not be zero for a non-head lock:
I
Ingo Molnar 已提交
1960
	 */
P
Peter Zijlstra 已提交
1961 1962
	if (!depth)
		goto out_bug;
I
Ingo Molnar 已提交
1963
	/*
P
Peter Zijlstra 已提交
1964 1965
	 * At least two relevant locks must exist for this
	 * to be a head:
I
Ingo Molnar 已提交
1966
	 */
P
Peter Zijlstra 已提交
1967 1968 1969
	if (curr->held_locks[depth].irq_context !=
			curr->held_locks[depth-1].irq_context)
		goto out_bug;
1970

P
Peter Zijlstra 已提交
1971 1972
	for (;;) {
		int distance = curr->lockdep_depth - depth + 1;
1973
		hlock = curr->held_locks + depth - 1;
1974

P
Peter Zijlstra 已提交
1975
		/*
1976 1977
		 * Only non-recursive-read entries get new dependencies
		 * added:
P
Peter Zijlstra 已提交
1978
		 */
1979 1980 1981 1982 1983
		if (hlock->read != 2 && hlock->check) {
			int ret = check_prev_add(curr, hlock, next, distance, &trace, save_trace);
			if (!ret)
				return 0;

1984
			/*
1985 1986 1987 1988
			 * Stop after the first non-trylock entry,
			 * as non-trylock entries have added their
			 * own direct dependencies already, so this
			 * lock is connected to them indirectly:
1989
			 */
1990 1991
			if (!hlock->trylock)
				break;
1992
		}
1993

P
Peter Zijlstra 已提交
1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005
		depth--;
		/*
		 * End of lock-stack?
		 */
		if (!depth)
			break;
		/*
		 * Stop the search if we cross into another context:
		 */
		if (curr->held_locks[depth].irq_context !=
				curr->held_locks[depth-1].irq_context)
			break;
I
Ingo Molnar 已提交
2006
	}
P
Peter Zijlstra 已提交
2007 2008 2009 2010
	return 1;
out_bug:
	if (!debug_locks_off_graph_unlock())
		return 0;
I
Ingo Molnar 已提交
2011

P
Peter Zijlstra 已提交
2012 2013 2014 2015 2016
	/*
	 * Clearly we all shouldn't be here, but since we made it we
	 * can reliable say we messed up our state. See the above two
	 * gotos for reasons why we could possibly end up here.
	 */
P
Peter Zijlstra 已提交
2017
	WARN_ON(1);
I
Ingo Molnar 已提交
2018

P
Peter Zijlstra 已提交
2019
	return 0;
I
Ingo Molnar 已提交
2020 2021
}

P
Peter Zijlstra 已提交
2022
unsigned long nr_lock_chains;
2023
struct lock_chain lock_chains[MAX_LOCKDEP_CHAINS];
2024
int nr_chain_hlocks;
2025 2026 2027 2028 2029 2030
static u16 chain_hlocks[MAX_LOCKDEP_CHAIN_HLOCKS];

struct lock_class *lock_chain_get_class(struct lock_chain *chain, int i)
{
	return lock_classes + chain_hlocks[chain->base + i];
}
P
Peter Zijlstra 已提交
2031

2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050
/*
 * Returns the index of the first held_lock of the current chain
 */
static inline int get_first_held_lock(struct task_struct *curr,
					struct held_lock *hlock)
{
	int i;
	struct held_lock *hlock_curr;

	for (i = curr->lockdep_depth - 1; i >= 0; i--) {
		hlock_curr = curr->held_locks + i;
		if (hlock_curr->irq_context != hlock->irq_context)
			break;

	}

	return ++i;
}

2051
#ifdef CONFIG_DEBUG_LOCKDEP
2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104
/*
 * Returns the next chain_key iteration
 */
static u64 print_chain_key_iteration(int class_idx, u64 chain_key)
{
	u64 new_chain_key = iterate_chain_key(chain_key, class_idx);

	printk(" class_idx:%d -> chain_key:%016Lx",
		class_idx,
		(unsigned long long)new_chain_key);
	return new_chain_key;
}

static void
print_chain_keys_held_locks(struct task_struct *curr, struct held_lock *hlock_next)
{
	struct held_lock *hlock;
	u64 chain_key = 0;
	int depth = curr->lockdep_depth;
	int i;

	printk("depth: %u\n", depth + 1);
	for (i = get_first_held_lock(curr, hlock_next); i < depth; i++) {
		hlock = curr->held_locks + i;
		chain_key = print_chain_key_iteration(hlock->class_idx, chain_key);

		print_lock(hlock);
	}

	print_chain_key_iteration(hlock_next->class_idx, chain_key);
	print_lock(hlock_next);
}

static void print_chain_keys_chain(struct lock_chain *chain)
{
	int i;
	u64 chain_key = 0;
	int class_id;

	printk("depth: %u\n", chain->depth);
	for (i = 0; i < chain->depth; i++) {
		class_id = chain_hlocks[chain->base + i];
		chain_key = print_chain_key_iteration(class_id + 1, chain_key);

		print_lock_name(lock_classes + class_id);
		printk("\n");
	}
}

static void print_collision(struct task_struct *curr,
			struct held_lock *hlock_next,
			struct lock_chain *chain)
{
2105
	pr_warn("\n");
2106 2107
	pr_warn("============================\n");
	pr_warn("WARNING: chain_key collision\n");
2108
	print_kernel_ident();
2109
	pr_warn("----------------------------\n");
2110 2111
	pr_warn("%s/%d: ", current->comm, task_pid_nr(current));
	pr_warn("Hash chain already cached but the contents don't match!\n");
2112

2113
	pr_warn("Held locks:");
2114 2115
	print_chain_keys_held_locks(curr, hlock_next);

2116
	pr_warn("Locks in cached chain:");
2117 2118
	print_chain_keys_chain(chain);

2119
	pr_warn("\nstack backtrace:\n");
2120 2121
	dump_stack();
}
2122
#endif
2123

2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138
/*
 * Checks whether the chain and the current held locks are consistent
 * in depth and also in content. If they are not it most likely means
 * that there was a collision during the calculation of the chain_key.
 * Returns: 0 not passed, 1 passed
 */
static int check_no_collision(struct task_struct *curr,
			struct held_lock *hlock,
			struct lock_chain *chain)
{
#ifdef CONFIG_DEBUG_LOCKDEP
	int i, j, id;

	i = get_first_held_lock(curr, hlock);

2139 2140
	if (DEBUG_LOCKS_WARN_ON(chain->depth != curr->lockdep_depth - (i - 1))) {
		print_collision(curr, hlock, chain);
2141
		return 0;
2142
	}
2143 2144 2145 2146

	for (j = 0; j < chain->depth - 1; j++, i++) {
		id = curr->held_locks[i].class_idx - 1;

2147 2148
		if (DEBUG_LOCKS_WARN_ON(chain_hlocks[chain->base + j] != id)) {
			print_collision(curr, hlock, chain);
2149
			return 0;
2150
		}
2151 2152 2153 2154 2155
	}
#endif
	return 1;
}

2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225
/*
 * This is for building a chain between just two different classes,
 * instead of adding a new hlock upon current, which is done by
 * add_chain_cache().
 *
 * This can be called in any context with two classes, while
 * add_chain_cache() must be done within the lock owener's context
 * since it uses hlock which might be racy in another context.
 */
static inline int add_chain_cache_classes(unsigned int prev,
					  unsigned int next,
					  unsigned int irq_context,
					  u64 chain_key)
{
	struct hlist_head *hash_head = chainhashentry(chain_key);
	struct lock_chain *chain;

	/*
	 * Allocate a new chain entry from the static array, and add
	 * it to the hash:
	 */

	/*
	 * We might need to take the graph lock, ensure we've got IRQs
	 * disabled to make this an IRQ-safe lock.. for recursion reasons
	 * lockdep won't complain about its own locking errors.
	 */
	if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
		return 0;

	if (unlikely(nr_lock_chains >= MAX_LOCKDEP_CHAINS)) {
		if (!debug_locks_off_graph_unlock())
			return 0;

		print_lockdep_off("BUG: MAX_LOCKDEP_CHAINS too low!");
		dump_stack();
		return 0;
	}

	chain = lock_chains + nr_lock_chains++;
	chain->chain_key = chain_key;
	chain->irq_context = irq_context;
	chain->depth = 2;
	if (likely(nr_chain_hlocks + chain->depth <= MAX_LOCKDEP_CHAIN_HLOCKS)) {
		chain->base = nr_chain_hlocks;
		nr_chain_hlocks += chain->depth;
		chain_hlocks[chain->base] = prev - 1;
		chain_hlocks[chain->base + 1] = next -1;
	}
#ifdef CONFIG_DEBUG_LOCKDEP
	/*
	 * Important for check_no_collision().
	 */
	else {
		if (!debug_locks_off_graph_unlock())
			return 0;

		print_lockdep_off("BUG: MAX_LOCKDEP_CHAIN_HLOCKS too low!");
		dump_stack();
		return 0;
	}
#endif

	hlist_add_head_rcu(&chain->entry, hash_head);
	debug_atomic_inc(chain_lookup_misses);
	inc_chains();

	return 1;
}

I
Ingo Molnar 已提交
2226
/*
2227 2228 2229 2230 2231
 * Adds a dependency chain into chain hashtable. And must be called with
 * graph_lock held.
 *
 * Return 0 if fail, and graph_lock is released.
 * Return 1 if succeed, with graph_lock held.
I
Ingo Molnar 已提交
2232
 */
2233 2234 2235
static inline int add_chain_cache(struct task_struct *curr,
				  struct held_lock *hlock,
				  u64 chain_key)
I
Ingo Molnar 已提交
2236
{
D
Dave Jones 已提交
2237
	struct lock_class *class = hlock_class(hlock);
2238
	struct hlist_head *hash_head = chainhashentry(chain_key);
I
Ingo Molnar 已提交
2239
	struct lock_chain *chain;
2240
	int i, j;
I
Ingo Molnar 已提交
2241

2242 2243 2244 2245 2246
	/*
	 * Allocate a new chain entry from the static array, and add
	 * it to the hash:
	 */

P
Peter Zijlstra 已提交
2247 2248 2249 2250 2251
	/*
	 * We might need to take the graph lock, ensure we've got IRQs
	 * disabled to make this an IRQ-safe lock.. for recursion reasons
	 * lockdep won't complain about its own locking errors.
	 */
2252 2253
	if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
		return 0;
2254

I
Ingo Molnar 已提交
2255
	if (unlikely(nr_lock_chains >= MAX_LOCKDEP_CHAINS)) {
2256 2257 2258
		if (!debug_locks_off_graph_unlock())
			return 0;

2259
		print_lockdep_off("BUG: MAX_LOCKDEP_CHAINS too low!");
2260
		dump_stack();
I
Ingo Molnar 已提交
2261 2262 2263 2264
		return 0;
	}
	chain = lock_chains + nr_lock_chains++;
	chain->chain_key = chain_key;
2265
	chain->irq_context = hlock->irq_context;
2266
	i = get_first_held_lock(curr, hlock);
2267
	chain->depth = curr->lockdep_depth + 1 - i;
2268 2269 2270 2271 2272

	BUILD_BUG_ON((1UL << 24) <= ARRAY_SIZE(chain_hlocks));
	BUILD_BUG_ON((1UL << 6)  <= ARRAY_SIZE(curr->held_locks));
	BUILD_BUG_ON((1UL << 8*sizeof(chain_hlocks[0])) <= ARRAY_SIZE(lock_classes));

2273 2274
	if (likely(nr_chain_hlocks + chain->depth <= MAX_LOCKDEP_CHAIN_HLOCKS)) {
		chain->base = nr_chain_hlocks;
2275
		for (j = 0; j < chain->depth - 1; j++, i++) {
D
Dave Jones 已提交
2276
			int lock_id = curr->held_locks[i].class_idx - 1;
2277 2278 2279 2280
			chain_hlocks[chain->base + j] = lock_id;
		}
		chain_hlocks[chain->base + j] = class - lock_classes;
	}
2281 2282 2283 2284 2285 2286 2287 2288 2289

	if (nr_chain_hlocks < MAX_LOCKDEP_CHAIN_HLOCKS)
		nr_chain_hlocks += chain->depth;

#ifdef CONFIG_DEBUG_LOCKDEP
	/*
	 * Important for check_no_collision().
	 */
	if (unlikely(nr_chain_hlocks > MAX_LOCKDEP_CHAIN_HLOCKS)) {
2290
		if (!debug_locks_off_graph_unlock())
2291 2292 2293 2294 2295 2296 2297 2298
			return 0;

		print_lockdep_off("BUG: MAX_LOCKDEP_CHAIN_HLOCKS too low!");
		dump_stack();
		return 0;
	}
#endif

2299
	hlist_add_head_rcu(&chain->entry, hash_head);
2300
	debug_atomic_inc(chain_lookup_misses);
P
Peter Zijlstra 已提交
2301 2302 2303 2304 2305
	inc_chains();

	return 1;
}

2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346
/*
 * Look up a dependency chain.
 */
static inline struct lock_chain *lookup_chain_cache(u64 chain_key)
{
	struct hlist_head *hash_head = chainhashentry(chain_key);
	struct lock_chain *chain;

	/*
	 * We can walk it lock-free, because entries only get added
	 * to the hash:
	 */
	hlist_for_each_entry_rcu(chain, hash_head, entry) {
		if (chain->chain_key == chain_key) {
			debug_atomic_inc(chain_lookup_hits);
			return chain;
		}
	}
	return NULL;
}

/*
 * If the key is not present yet in dependency chain cache then
 * add it and return 1 - in this case the new dependency chain is
 * validated. If the key is already hashed, return 0.
 * (On return with 1 graph_lock is held.)
 */
static inline int lookup_chain_cache_add(struct task_struct *curr,
					 struct held_lock *hlock,
					 u64 chain_key)
{
	struct lock_class *class = hlock_class(hlock);
	struct lock_chain *chain = lookup_chain_cache(chain_key);

	if (chain) {
cache_hit:
		if (!check_no_collision(curr, hlock, chain))
			return 0;

		if (very_verbose(class)) {
			printk("\nhash chain already cached, key: "
2347
					"%016Lx tail class: [%px] %s\n",
2348 2349 2350 2351 2352 2353 2354 2355
					(unsigned long long)chain_key,
					class->key, class->name);
		}

		return 0;
	}

	if (very_verbose(class)) {
2356
		printk("\nnew hash chain, key: %016Lx tail class: [%px] %s\n",
2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377
			(unsigned long long)chain_key, class->key, class->name);
	}

	if (!graph_lock())
		return 0;

	/*
	 * We have to walk the chain again locked - to avoid duplicates:
	 */
	chain = lookup_chain_cache(chain_key);
	if (chain) {
		graph_unlock();
		goto cache_hit;
	}

	if (!add_chain_cache(curr, hlock, chain_key))
		return 0;

	return 1;
}

P
Peter Zijlstra 已提交
2378
static int validate_chain(struct task_struct *curr, struct lockdep_map *lock,
2379
		struct held_lock *hlock, int chain_head, u64 chain_key)
P
Peter Zijlstra 已提交
2380 2381 2382 2383 2384 2385 2386 2387
{
	/*
	 * Trylock needs to maintain the stack of held locks, but it
	 * does not add new dependencies, because trylock can be done
	 * in any order.
	 *
	 * We look up the chain_key and do the O(N^2) check and update of
	 * the dependencies only if this is a new dependency chain.
2388
	 * (If lookup_chain_cache_add() return with 1 it acquires
P
Peter Zijlstra 已提交
2389 2390
	 * graph_lock for us)
	 */
2391
	if (!hlock->trylock && hlock->check &&
2392
	    lookup_chain_cache_add(curr, hlock, chain_key)) {
P
Peter Zijlstra 已提交
2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419
		/*
		 * Check whether last held lock:
		 *
		 * - is irq-safe, if this lock is irq-unsafe
		 * - is softirq-safe, if this lock is hardirq-unsafe
		 *
		 * And check whether the new lock's dependency graph
		 * could lead back to the previous lock.
		 *
		 * any of these scenarios could lead to a deadlock. If
		 * All validations
		 */
		int ret = check_deadlock(curr, hlock, lock, hlock->read);

		if (!ret)
			return 0;
		/*
		 * Mark recursive read, as we jump over it when
		 * building dependencies (just like we jump over
		 * trylock entries):
		 */
		if (ret == 2)
			hlock->read = 2;
		/*
		 * Add dependency only if this lock is not the head
		 * of the chain, and if it's not a secondary read-lock:
		 */
2420
		if (!chain_head && ret != 2) {
P
Peter Zijlstra 已提交
2421 2422
			if (!check_prevs_add(curr, hlock))
				return 0;
2423 2424
		}

P
Peter Zijlstra 已提交
2425
		graph_unlock();
2426 2427
	} else {
		/* after lookup_chain_cache_add(): */
P
Peter Zijlstra 已提交
2428 2429
		if (unlikely(!debug_locks))
			return 0;
2430
	}
I
Ingo Molnar 已提交
2431 2432 2433

	return 1;
}
P
Peter Zijlstra 已提交
2434 2435 2436
#else
static inline int validate_chain(struct task_struct *curr,
	       	struct lockdep_map *lock, struct held_lock *hlock,
2437
		int chain_head, u64 chain_key)
P
Peter Zijlstra 已提交
2438 2439 2440
{
	return 1;
}
2441
#endif
I
Ingo Molnar 已提交
2442 2443 2444 2445 2446

/*
 * We are building curr_chain_key incrementally, so double-check
 * it from scratch, to make sure that it's done correctly:
 */
2447
static void check_chain_key(struct task_struct *curr)
I
Ingo Molnar 已提交
2448 2449 2450
{
#ifdef CONFIG_DEBUG_LOCKDEP
	struct held_lock *hlock, *prev_hlock = NULL;
2451
	unsigned int i;
I
Ingo Molnar 已提交
2452 2453 2454 2455 2456 2457
	u64 chain_key = 0;

	for (i = 0; i < curr->lockdep_depth; i++) {
		hlock = curr->held_locks + i;
		if (chain_key != hlock->prev_chain_key) {
			debug_locks_off();
P
Peter Zijlstra 已提交
2458 2459 2460 2461
			/*
			 * We got mighty confused, our chain keys don't match
			 * with what we expect, someone trample on our task state?
			 */
2462
			WARN(1, "hm#1, depth: %u [%u], %016Lx != %016Lx\n",
I
Ingo Molnar 已提交
2463 2464 2465 2466 2467
				curr->lockdep_depth, i,
				(unsigned long long)chain_key,
				(unsigned long long)hlock->prev_chain_key);
			return;
		}
P
Peter Zijlstra 已提交
2468 2469 2470
		/*
		 * Whoops ran out of static storage again?
		 */
2471
		if (DEBUG_LOCKS_WARN_ON(hlock->class_idx > MAX_LOCKDEP_KEYS))
2472 2473
			return;

I
Ingo Molnar 已提交
2474 2475 2476
		if (prev_hlock && (prev_hlock->irq_context !=
							hlock->irq_context))
			chain_key = 0;
2477
		chain_key = iterate_chain_key(chain_key, hlock->class_idx);
I
Ingo Molnar 已提交
2478 2479 2480 2481
		prev_hlock = hlock;
	}
	if (chain_key != curr->curr_chain_key) {
		debug_locks_off();
P
Peter Zijlstra 已提交
2482 2483 2484 2485
		/*
		 * More smoking hash instead of calculating it, damn see these
		 * numbers float.. I bet that a pink elephant stepped on my memory.
		 */
2486
		WARN(1, "hm#2, depth: %u [%u], %016Lx != %016Lx\n",
I
Ingo Molnar 已提交
2487 2488 2489 2490 2491 2492 2493
			curr->lockdep_depth, i,
			(unsigned long long)chain_key,
			(unsigned long long)curr->curr_chain_key);
	}
#endif
}

2494 2495 2496 2497 2498 2499 2500 2501 2502 2503
static void
print_usage_bug_scenario(struct held_lock *lock)
{
	struct lock_class *class = hlock_class(lock);

	printk(" Possible unsafe locking scenario:\n\n");
	printk("       CPU0\n");
	printk("       ----\n");
	printk("  lock(");
	__print_lock_name(class);
D
Dmitry Vyukov 已提交
2504
	printk(KERN_CONT ");\n");
2505 2506 2507
	printk("  <Interrupt>\n");
	printk("    lock(");
	__print_lock_name(class);
D
Dmitry Vyukov 已提交
2508
	printk(KERN_CONT ");\n");
2509 2510 2511
	printk("\n *** DEADLOCK ***\n\n");
}

P
Peter Zijlstra 已提交
2512 2513 2514 2515 2516 2517 2518
static int
print_usage_bug(struct task_struct *curr, struct held_lock *this,
		enum lock_usage_bit prev_bit, enum lock_usage_bit new_bit)
{
	if (!debug_locks_off_graph_unlock() || debug_locks_silent)
		return 0;

2519
	pr_warn("\n");
2520 2521
	pr_warn("================================\n");
	pr_warn("WARNING: inconsistent lock state\n");
2522
	print_kernel_ident();
2523
	pr_warn("--------------------------------\n");
P
Peter Zijlstra 已提交
2524

2525
	pr_warn("inconsistent {%s} -> {%s} usage.\n",
P
Peter Zijlstra 已提交
2526 2527
		usage_str[prev_bit], usage_str[new_bit]);

2528
	pr_warn("%s/%d [HC%u[%lu]:SC%u[%lu]:HE%u:SE%u] takes:\n",
2529
		curr->comm, task_pid_nr(curr),
P
Peter Zijlstra 已提交
2530 2531 2532 2533 2534 2535
		trace_hardirq_context(curr), hardirq_count() >> HARDIRQ_SHIFT,
		trace_softirq_context(curr), softirq_count() >> SOFTIRQ_SHIFT,
		trace_hardirqs_enabled(curr),
		trace_softirqs_enabled(curr));
	print_lock(this);

2536
	pr_warn("{%s} state was registered at:\n", usage_str[prev_bit]);
D
Dave Jones 已提交
2537
	print_stack_trace(hlock_class(this)->usage_traces + prev_bit, 1);
P
Peter Zijlstra 已提交
2538 2539

	print_irqtrace_events(curr);
2540
	pr_warn("\nother info that might help us debug this:\n");
2541 2542
	print_usage_bug_scenario(this);

P
Peter Zijlstra 已提交
2543 2544
	lockdep_print_held_locks(curr);

2545
	pr_warn("\nstack backtrace:\n");
P
Peter Zijlstra 已提交
2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557
	dump_stack();

	return 0;
}

/*
 * Print out an error if an invalid bit is set:
 */
static inline int
valid_state(struct task_struct *curr, struct held_lock *this,
	    enum lock_usage_bit new_bit, enum lock_usage_bit bad_bit)
{
D
Dave Jones 已提交
2558
	if (unlikely(hlock_class(this)->usage_mask & (1 << bad_bit)))
P
Peter Zijlstra 已提交
2559 2560 2561 2562 2563 2564 2565
		return print_usage_bug(curr, this, bad_bit, new_bit);
	return 1;
}

static int mark_lock(struct task_struct *curr, struct held_lock *this,
		     enum lock_usage_bit new_bit);

2566
#if defined(CONFIG_TRACE_IRQFLAGS) && defined(CONFIG_PROVE_LOCKING)
I
Ingo Molnar 已提交
2567 2568 2569 2570 2571

/*
 * print irq inversion bug:
 */
static int
2572 2573
print_irq_inversion_bug(struct task_struct *curr,
			struct lock_list *root, struct lock_list *other,
I
Ingo Molnar 已提交
2574 2575 2576
			struct held_lock *this, int forwards,
			const char *irqclass)
{
2577 2578 2579 2580
	struct lock_list *entry = other;
	struct lock_list *middle = NULL;
	int depth;

2581
	if (!debug_locks_off_graph_unlock() || debug_locks_silent)
I
Ingo Molnar 已提交
2582 2583
		return 0;

2584
	pr_warn("\n");
2585 2586
	pr_warn("========================================================\n");
	pr_warn("WARNING: possible irq lock inversion dependency detected\n");
2587
	print_kernel_ident();
2588
	pr_warn("--------------------------------------------------------\n");
2589
	pr_warn("%s/%d just changed the state of lock:\n",
2590
		curr->comm, task_pid_nr(curr));
I
Ingo Molnar 已提交
2591 2592
	print_lock(this);
	if (forwards)
2593
		pr_warn("but this lock took another, %s-unsafe lock in the past:\n", irqclass);
I
Ingo Molnar 已提交
2594
	else
2595
		pr_warn("but this lock was taken by another, %s-safe lock in the past:\n", irqclass);
2596
	print_lock_name(other->class);
2597
	pr_warn("\n\nand interrupts could create inverse lock ordering between them.\n\n");
I
Ingo Molnar 已提交
2598

2599
	pr_warn("\nother info that might help us debug this:\n");
2600 2601 2602 2603 2604

	/* Find a middle lock (if one exists) */
	depth = get_lock_depth(other);
	do {
		if (depth == 0 && (entry != root)) {
2605
			pr_warn("lockdep:%s bad path found in chain graph\n", __func__);
2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618
			break;
		}
		middle = entry;
		entry = get_lock_parent(entry);
		depth--;
	} while (entry && entry != root && (depth >= 0));
	if (forwards)
		print_irq_lock_scenario(root, other,
			middle ? middle->class : root->class, other->class);
	else
		print_irq_lock_scenario(other, root,
			middle ? middle->class : other->class, root->class);

I
Ingo Molnar 已提交
2619 2620
	lockdep_print_held_locks(curr);

2621
	pr_warn("\nthe shortest dependencies between 2nd lock and 1st lock:\n");
2622 2623 2624
	if (!save_trace(&root->trace))
		return 0;
	print_shortest_lock_dependencies(other, root);
I
Ingo Molnar 已提交
2625

2626
	pr_warn("\nstack backtrace:\n");
I
Ingo Molnar 已提交
2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640
	dump_stack();

	return 0;
}

/*
 * Prove that in the forwards-direction subgraph starting at <this>
 * there is no lock matching <mask>:
 */
static int
check_usage_forwards(struct task_struct *curr, struct held_lock *this,
		     enum lock_usage_bit bit, const char *irqclass)
{
	int ret;
2641 2642
	struct lock_list root;
	struct lock_list *uninitialized_var(target_entry);
I
Ingo Molnar 已提交
2643

2644 2645 2646
	root.parent = NULL;
	root.class = hlock_class(this);
	ret = find_usage_forwards(&root, bit, &target_entry);
P
Peter Zijlstra 已提交
2647 2648 2649 2650
	if (ret < 0)
		return print_bfs_bug(ret);
	if (ret == 1)
		return ret;
I
Ingo Molnar 已提交
2651

2652
	return print_irq_inversion_bug(curr, &root, target_entry,
2653
					this, 1, irqclass);
I
Ingo Molnar 已提交
2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664
}

/*
 * Prove that in the backwards-direction subgraph starting at <this>
 * there is no lock matching <mask>:
 */
static int
check_usage_backwards(struct task_struct *curr, struct held_lock *this,
		      enum lock_usage_bit bit, const char *irqclass)
{
	int ret;
2665 2666
	struct lock_list root;
	struct lock_list *uninitialized_var(target_entry);
I
Ingo Molnar 已提交
2667

2668 2669 2670
	root.parent = NULL;
	root.class = hlock_class(this);
	ret = find_usage_backwards(&root, bit, &target_entry);
P
Peter Zijlstra 已提交
2671 2672 2673 2674
	if (ret < 0)
		return print_bfs_bug(ret);
	if (ret == 1)
		return ret;
I
Ingo Molnar 已提交
2675

2676
	return print_irq_inversion_bug(curr, &root, target_entry,
2677
					this, 0, irqclass);
I
Ingo Molnar 已提交
2678 2679
}

2680
void print_irqtrace_events(struct task_struct *curr)
I
Ingo Molnar 已提交
2681 2682
{
	printk("irq event stamp: %u\n", curr->irq_events);
2683
	printk("hardirqs last  enabled at (%u): [<%px>] %pS\n",
D
Dmitry Vyukov 已提交
2684 2685
		curr->hardirq_enable_event, (void *)curr->hardirq_enable_ip,
		(void *)curr->hardirq_enable_ip);
2686
	printk("hardirqs last disabled at (%u): [<%px>] %pS\n",
D
Dmitry Vyukov 已提交
2687 2688
		curr->hardirq_disable_event, (void *)curr->hardirq_disable_ip,
		(void *)curr->hardirq_disable_ip);
2689
	printk("softirqs last  enabled at (%u): [<%px>] %pS\n",
D
Dmitry Vyukov 已提交
2690 2691
		curr->softirq_enable_event, (void *)curr->softirq_enable_ip,
		(void *)curr->softirq_enable_ip);
2692
	printk("softirqs last disabled at (%u): [<%px>] %pS\n",
D
Dmitry Vyukov 已提交
2693 2694
		curr->softirq_disable_event, (void *)curr->softirq_disable_ip,
		(void *)curr->softirq_disable_ip);
I
Ingo Molnar 已提交
2695 2696
}

2697
static int HARDIRQ_verbose(struct lock_class *class)
I
Ingo Molnar 已提交
2698
{
P
Peter Zijlstra 已提交
2699 2700 2701
#if HARDIRQ_VERBOSE
	return class_filter(class);
#endif
I
Ingo Molnar 已提交
2702 2703 2704
	return 0;
}

2705
static int SOFTIRQ_verbose(struct lock_class *class)
I
Ingo Molnar 已提交
2706
{
P
Peter Zijlstra 已提交
2707 2708 2709 2710
#if SOFTIRQ_VERBOSE
	return class_filter(class);
#endif
	return 0;
I
Ingo Molnar 已提交
2711 2712 2713 2714
}

#define STRICT_READ_CHECKS	1

2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727
static int (*state_verbose_f[])(struct lock_class *class) = {
#define LOCKDEP_STATE(__STATE) \
	__STATE##_verbose,
#include "lockdep_states.h"
#undef LOCKDEP_STATE
};

static inline int state_verbose(enum lock_usage_bit bit,
				struct lock_class *class)
{
	return state_verbose_f[bit >> 2](class);
}

2728 2729 2730
typedef int (*check_usage_f)(struct task_struct *, struct held_lock *,
			     enum lock_usage_bit bit, const char *name);

2731
static int
2732 2733
mark_lock_irq(struct task_struct *curr, struct held_lock *this,
		enum lock_usage_bit new_bit)
2734
{
2735
	int excl_bit = exclusive_bit(new_bit);
2736
	int read = new_bit & 1;
2737 2738
	int dir = new_bit & 2;

2739 2740 2741 2742 2743 2744 2745
	/*
	 * mark USED_IN has to look forwards -- to ensure no dependency
	 * has ENABLED state, which would allow recursion deadlocks.
	 *
	 * mark ENABLED has to look backwards -- to ensure no dependee
	 * has USED_IN state, which, again, would allow  recursion deadlocks.
	 */
2746 2747
	check_usage_f usage = dir ?
		check_usage_backwards : check_usage_forwards;
2748

2749 2750 2751 2752
	/*
	 * Validate that this particular lock does not have conflicting
	 * usage states.
	 */
2753 2754
	if (!valid_state(curr, this, new_bit, excl_bit))
		return 0;
2755

2756 2757 2758 2759 2760
	/*
	 * Validate that the lock dependencies don't have conflicting usage
	 * states.
	 */
	if ((!read || !dir || STRICT_READ_CHECKS) &&
2761
			!usage(curr, this, excl_bit, state_name(new_bit & ~1)))
2762
		return 0;
2763

2764 2765 2766 2767 2768 2769 2770 2771
	/*
	 * Check for read in write conflicts
	 */
	if (!read) {
		if (!valid_state(curr, this, new_bit, excl_bit + 1))
			return 0;

		if (STRICT_READ_CHECKS &&
2772 2773
			!usage(curr, this, excl_bit + 1,
				state_name(new_bit + 1)))
2774 2775
			return 0;
	}
2776

2777
	if (state_verbose(new_bit, hlock_class(this)))
2778 2779 2780 2781 2782
		return 2;

	return 1;
}

2783
enum mark_type {
2784 2785 2786
#define LOCKDEP_STATE(__STATE)	__STATE,
#include "lockdep_states.h"
#undef LOCKDEP_STATE
2787 2788
};

I
Ingo Molnar 已提交
2789 2790 2791
/*
 * Mark all held locks with a usage bit:
 */
2792
static int
2793
mark_held_locks(struct task_struct *curr, enum mark_type mark)
I
Ingo Molnar 已提交
2794 2795 2796 2797 2798 2799 2800 2801
{
	enum lock_usage_bit usage_bit;
	struct held_lock *hlock;
	int i;

	for (i = 0; i < curr->lockdep_depth; i++) {
		hlock = curr->held_locks + i;

2802 2803 2804 2805 2806
		usage_bit = 2 + (mark << 2); /* ENABLED */
		if (hlock->read)
			usage_bit += 1; /* READ */

		BUG_ON(usage_bit >= LOCK_USAGE_STATES);
2807

2808
		if (!hlock->check)
2809 2810
			continue;

2811
		if (!mark_lock(curr, hlock, usage_bit))
I
Ingo Molnar 已提交
2812 2813 2814 2815 2816 2817 2818 2819 2820
			return 0;
	}

	return 1;
}

/*
 * Hardirqs will be enabled:
 */
2821
static void __trace_hardirqs_on_caller(unsigned long ip)
I
Ingo Molnar 已提交
2822 2823 2824 2825 2826 2827 2828 2829 2830 2831
{
	struct task_struct *curr = current;

	/* we'll do an OFF -> ON transition: */
	curr->hardirqs_enabled = 1;

	/*
	 * We are going to turn hardirqs on, so set the
	 * usage bit for all held locks:
	 */
2832
	if (!mark_held_locks(curr, HARDIRQ))
I
Ingo Molnar 已提交
2833 2834 2835 2836 2837 2838 2839
		return;
	/*
	 * If we have softirqs enabled, then set the usage
	 * bit for all held locks. (disabled hardirqs prevented
	 * this bit from being set before)
	 */
	if (curr->softirqs_enabled)
2840
		if (!mark_held_locks(curr, SOFTIRQ))
I
Ingo Molnar 已提交
2841 2842
			return;

P
Peter Zijlstra 已提交
2843 2844
	curr->hardirq_enable_ip = ip;
	curr->hardirq_enable_event = ++curr->irq_events;
2845
	debug_atomic_inc(hardirqs_on_events);
P
Peter Zijlstra 已提交
2846
}
2847

2848
__visible void trace_hardirqs_on_caller(unsigned long ip)
2849 2850 2851 2852 2853 2854
{
	time_hardirqs_on(CALLER_ADDR0, ip);

	if (unlikely(!debug_locks || current->lockdep_recursion))
		return;

2855 2856 2857 2858 2859 2860 2861 2862 2863 2864
	if (unlikely(current->hardirqs_enabled)) {
		/*
		 * Neither irq nor preemption are disabled here
		 * so this is racy by nature but losing one hit
		 * in a stat is not a big deal.
		 */
		__debug_atomic_inc(redundant_hardirqs_on);
		return;
	}

P
Peter Zijlstra 已提交
2865 2866 2867 2868 2869
	/*
	 * We're enabling irqs and according to our state above irqs weren't
	 * already enabled, yet we find the hardware thinks they are in fact
	 * enabled.. someone messed up their IRQ state tracing.
	 */
2870 2871 2872
	if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
		return;

P
Peter Zijlstra 已提交
2873 2874 2875
	/*
	 * See the fine text that goes along with this variable definition.
	 */
2876 2877 2878
	if (DEBUG_LOCKS_WARN_ON(unlikely(early_boot_irqs_disabled)))
		return;

P
Peter Zijlstra 已提交
2879 2880 2881 2882
	/*
	 * Can't allow enabling interrupts while in an interrupt handler,
	 * that's general bad form and such. Recursion, limited stack etc..
	 */
2883 2884 2885
	if (DEBUG_LOCKS_WARN_ON(current->hardirq_context))
		return;

2886 2887 2888 2889
	current->lockdep_recursion = 1;
	__trace_hardirqs_on_caller(ip);
	current->lockdep_recursion = 0;
}
2890
EXPORT_SYMBOL(trace_hardirqs_on_caller);
P
Peter Zijlstra 已提交
2891

2892
void trace_hardirqs_on(void)
2893 2894 2895
{
	trace_hardirqs_on_caller(CALLER_ADDR0);
}
P
Peter Zijlstra 已提交
2896 2897 2898 2899 2900
EXPORT_SYMBOL(trace_hardirqs_on);

/*
 * Hardirqs were disabled:
 */
2901
__visible void trace_hardirqs_off_caller(unsigned long ip)
P
Peter Zijlstra 已提交
2902 2903 2904
{
	struct task_struct *curr = current;

2905
	time_hardirqs_off(CALLER_ADDR0, ip);
2906

P
Peter Zijlstra 已提交
2907 2908 2909
	if (unlikely(!debug_locks || current->lockdep_recursion))
		return;

P
Peter Zijlstra 已提交
2910 2911 2912 2913
	/*
	 * So we're supposed to get called after you mask local IRQs, but for
	 * some reason the hardware doesn't quite think you did a proper job.
	 */
P
Peter Zijlstra 已提交
2914 2915 2916 2917 2918 2919 2920 2921
	if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
		return;

	if (curr->hardirqs_enabled) {
		/*
		 * We have done an ON -> OFF transition:
		 */
		curr->hardirqs_enabled = 0;
2922
		curr->hardirq_disable_ip = ip;
P
Peter Zijlstra 已提交
2923
		curr->hardirq_disable_event = ++curr->irq_events;
2924
		debug_atomic_inc(hardirqs_off_events);
P
Peter Zijlstra 已提交
2925
	} else
2926
		debug_atomic_inc(redundant_hardirqs_off);
P
Peter Zijlstra 已提交
2927
}
2928
EXPORT_SYMBOL(trace_hardirqs_off_caller);
P
Peter Zijlstra 已提交
2929

2930
void trace_hardirqs_off(void)
2931 2932 2933
{
	trace_hardirqs_off_caller(CALLER_ADDR0);
}
P
Peter Zijlstra 已提交
2934 2935 2936 2937 2938 2939 2940 2941 2942
EXPORT_SYMBOL(trace_hardirqs_off);

/*
 * Softirqs will be enabled:
 */
void trace_softirqs_on(unsigned long ip)
{
	struct task_struct *curr = current;

2943
	if (unlikely(!debug_locks || current->lockdep_recursion))
P
Peter Zijlstra 已提交
2944 2945
		return;

P
Peter Zijlstra 已提交
2946 2947 2948 2949
	/*
	 * We fancy IRQs being disabled here, see softirq.c, avoids
	 * funny state and nesting things.
	 */
P
Peter Zijlstra 已提交
2950 2951 2952 2953
	if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
		return;

	if (curr->softirqs_enabled) {
2954
		debug_atomic_inc(redundant_softirqs_on);
P
Peter Zijlstra 已提交
2955 2956 2957
		return;
	}

2958
	current->lockdep_recursion = 1;
P
Peter Zijlstra 已提交
2959 2960 2961 2962 2963 2964
	/*
	 * We'll do an OFF -> ON transition:
	 */
	curr->softirqs_enabled = 1;
	curr->softirq_enable_ip = ip;
	curr->softirq_enable_event = ++curr->irq_events;
2965
	debug_atomic_inc(softirqs_on_events);
P
Peter Zijlstra 已提交
2966 2967 2968 2969 2970 2971
	/*
	 * We are going to turn softirqs on, so set the
	 * usage bit for all held locks, if hardirqs are
	 * enabled too:
	 */
	if (curr->hardirqs_enabled)
2972
		mark_held_locks(curr, SOFTIRQ);
2973
	current->lockdep_recursion = 0;
P
Peter Zijlstra 已提交
2974 2975 2976 2977 2978 2979 2980 2981 2982
}

/*
 * Softirqs were disabled:
 */
void trace_softirqs_off(unsigned long ip)
{
	struct task_struct *curr = current;

2983
	if (unlikely(!debug_locks || current->lockdep_recursion))
P
Peter Zijlstra 已提交
2984 2985
		return;

P
Peter Zijlstra 已提交
2986 2987 2988
	/*
	 * We fancy IRQs being disabled here, see softirq.c
	 */
P
Peter Zijlstra 已提交
2989 2990 2991 2992 2993 2994 2995 2996 2997 2998
	if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
		return;

	if (curr->softirqs_enabled) {
		/*
		 * We have done an ON -> OFF transition:
		 */
		curr->softirqs_enabled = 0;
		curr->softirq_disable_ip = ip;
		curr->softirq_disable_event = ++curr->irq_events;
2999
		debug_atomic_inc(softirqs_off_events);
P
Peter Zijlstra 已提交
3000 3001 3002
		/*
		 * Whoops, we wanted softirqs off, so why aren't they?
		 */
P
Peter Zijlstra 已提交
3003 3004
		DEBUG_LOCKS_WARN_ON(!softirq_count());
	} else
3005
		debug_atomic_inc(redundant_softirqs_off);
P
Peter Zijlstra 已提交
3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035
}

static int mark_irqflags(struct task_struct *curr, struct held_lock *hlock)
{
	/*
	 * If non-trylock use in a hardirq or softirq context, then
	 * mark the lock as used in these contexts:
	 */
	if (!hlock->trylock) {
		if (hlock->read) {
			if (curr->hardirq_context)
				if (!mark_lock(curr, hlock,
						LOCK_USED_IN_HARDIRQ_READ))
					return 0;
			if (curr->softirq_context)
				if (!mark_lock(curr, hlock,
						LOCK_USED_IN_SOFTIRQ_READ))
					return 0;
		} else {
			if (curr->hardirq_context)
				if (!mark_lock(curr, hlock, LOCK_USED_IN_HARDIRQ))
					return 0;
			if (curr->softirq_context)
				if (!mark_lock(curr, hlock, LOCK_USED_IN_SOFTIRQ))
					return 0;
		}
	}
	if (!hlock->hardirqs_off) {
		if (hlock->read) {
			if (!mark_lock(curr, hlock,
P
Peter Zijlstra 已提交
3036
					LOCK_ENABLED_HARDIRQ_READ))
P
Peter Zijlstra 已提交
3037 3038 3039
				return 0;
			if (curr->softirqs_enabled)
				if (!mark_lock(curr, hlock,
P
Peter Zijlstra 已提交
3040
						LOCK_ENABLED_SOFTIRQ_READ))
P
Peter Zijlstra 已提交
3041 3042 3043
					return 0;
		} else {
			if (!mark_lock(curr, hlock,
P
Peter Zijlstra 已提交
3044
					LOCK_ENABLED_HARDIRQ))
P
Peter Zijlstra 已提交
3045 3046 3047
				return 0;
			if (curr->softirqs_enabled)
				if (!mark_lock(curr, hlock,
P
Peter Zijlstra 已提交
3048
						LOCK_ENABLED_SOFTIRQ))
P
Peter Zijlstra 已提交
3049 3050 3051 3052 3053 3054 3055
					return 0;
		}
	}

	return 1;
}

3056 3057 3058 3059 3060
static inline unsigned int task_irq_context(struct task_struct *task)
{
	return 2 * !!task->hardirq_context + !!task->softirq_context;
}

P
Peter Zijlstra 已提交
3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081
static int separate_irq_context(struct task_struct *curr,
		struct held_lock *hlock)
{
	unsigned int depth = curr->lockdep_depth;

	/*
	 * Keep track of points where we cross into an interrupt context:
	 */
	if (depth) {
		struct held_lock *prev_hlock;

		prev_hlock = curr->held_locks + depth-1;
		/*
		 * If we cross into another context, reset the
		 * hash key (this also prevents the checking and the
		 * adding of the dependency to 'prev'):
		 */
		if (prev_hlock->irq_context != hlock->irq_context)
			return 1;
	}
	return 0;
I
Ingo Molnar 已提交
3082 3083
}

P
Peter Zijlstra 已提交
3084
#else /* defined(CONFIG_TRACE_IRQFLAGS) && defined(CONFIG_PROVE_LOCKING) */
I
Ingo Molnar 已提交
3085

P
Peter Zijlstra 已提交
3086 3087 3088
static inline
int mark_lock_irq(struct task_struct *curr, struct held_lock *this,
		enum lock_usage_bit new_bit)
I
Ingo Molnar 已提交
3089
{
P
Peter Zijlstra 已提交
3090
	WARN_ON(1); /* Impossible innit? when we don't have TRACE_IRQFLAG */
P
Peter Zijlstra 已提交
3091 3092
	return 1;
}
I
Ingo Molnar 已提交
3093

P
Peter Zijlstra 已提交
3094 3095 3096 3097 3098
static inline int mark_irqflags(struct task_struct *curr,
		struct held_lock *hlock)
{
	return 1;
}
I
Ingo Molnar 已提交
3099

3100 3101 3102 3103 3104
static inline unsigned int task_irq_context(struct task_struct *task)
{
	return 0;
}

P
Peter Zijlstra 已提交
3105 3106 3107 3108
static inline int separate_irq_context(struct task_struct *curr,
		struct held_lock *hlock)
{
	return 0;
I
Ingo Molnar 已提交
3109 3110
}

P
Peter Zijlstra 已提交
3111
#endif /* defined(CONFIG_TRACE_IRQFLAGS) && defined(CONFIG_PROVE_LOCKING) */
I
Ingo Molnar 已提交
3112 3113

/*
P
Peter Zijlstra 已提交
3114
 * Mark a lock with a usage bit, and validate the state transition:
I
Ingo Molnar 已提交
3115
 */
3116
static int mark_lock(struct task_struct *curr, struct held_lock *this,
3117
			     enum lock_usage_bit new_bit)
I
Ingo Molnar 已提交
3118
{
P
Peter Zijlstra 已提交
3119
	unsigned int new_mask = 1 << new_bit, ret = 1;
I
Ingo Molnar 已提交
3120 3121

	/*
P
Peter Zijlstra 已提交
3122 3123
	 * If already set then do not dirty the cacheline,
	 * nor do any checks:
I
Ingo Molnar 已提交
3124
	 */
D
Dave Jones 已提交
3125
	if (likely(hlock_class(this)->usage_mask & new_mask))
P
Peter Zijlstra 已提交
3126 3127 3128 3129
		return 1;

	if (!graph_lock())
		return 0;
I
Ingo Molnar 已提交
3130
	/*
L
Lucas De Marchi 已提交
3131
	 * Make sure we didn't race:
I
Ingo Molnar 已提交
3132
	 */
D
Dave Jones 已提交
3133
	if (unlikely(hlock_class(this)->usage_mask & new_mask)) {
P
Peter Zijlstra 已提交
3134 3135 3136
		graph_unlock();
		return 1;
	}
I
Ingo Molnar 已提交
3137

D
Dave Jones 已提交
3138
	hlock_class(this)->usage_mask |= new_mask;
I
Ingo Molnar 已提交
3139

D
Dave Jones 已提交
3140
	if (!save_trace(hlock_class(this)->usage_traces + new_bit))
P
Peter Zijlstra 已提交
3141
		return 0;
I
Ingo Molnar 已提交
3142

P
Peter Zijlstra 已提交
3143
	switch (new_bit) {
P
Peter Zijlstra 已提交
3144 3145 3146 3147 3148 3149 3150
#define LOCKDEP_STATE(__STATE)			\
	case LOCK_USED_IN_##__STATE:		\
	case LOCK_USED_IN_##__STATE##_READ:	\
	case LOCK_ENABLED_##__STATE:		\
	case LOCK_ENABLED_##__STATE##_READ:
#include "lockdep_states.h"
#undef LOCKDEP_STATE
P
Peter Zijlstra 已提交
3151 3152 3153 3154 3155
		ret = mark_lock_irq(curr, this, new_bit);
		if (!ret)
			return 0;
		break;
	case LOCK_USED:
3156
		debug_atomic_dec(nr_unused_locks);
P
Peter Zijlstra 已提交
3157 3158 3159 3160 3161 3162 3163
		break;
	default:
		if (!debug_locks_off_graph_unlock())
			return 0;
		WARN_ON(1);
		return 0;
	}
I
Ingo Molnar 已提交
3164

P
Peter Zijlstra 已提交
3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178
	graph_unlock();

	/*
	 * We must printk outside of the graph_lock:
	 */
	if (ret == 2) {
		printk("\nmarked lock as {%s}:\n", usage_str[new_bit]);
		print_lock(this);
		print_irqtrace_events(curr);
		dump_stack();
	}

	return ret;
}
I
Ingo Molnar 已提交
3179 3180 3181 3182

/*
 * Initialize a lock instance's lock-class mapping info:
 */
3183
static void __lockdep_init_map(struct lockdep_map *lock, const char *name,
3184
		      struct lock_class_key *key, int subclass)
I
Ingo Molnar 已提交
3185
{
3186 3187 3188 3189
	int i;

	for (i = 0; i < NR_LOCKDEP_CACHING_CLASSES; i++)
		lock->class_cache[i] = NULL;
3190

3191 3192 3193 3194
#ifdef CONFIG_LOCK_STAT
	lock->cpu = raw_smp_processor_id();
#endif

P
Peter Zijlstra 已提交
3195 3196 3197
	/*
	 * Can't be having no nameless bastards around this place!
	 */
3198 3199
	if (DEBUG_LOCKS_WARN_ON(!name)) {
		lock->name = "NULL";
I
Ingo Molnar 已提交
3200
		return;
3201 3202 3203
	}

	lock->name = name;
I
Ingo Molnar 已提交
3204

P
Peter Zijlstra 已提交
3205 3206 3207
	/*
	 * No key, no joy, we need to hash something.
	 */
I
Ingo Molnar 已提交
3208 3209 3210 3211 3212 3213
	if (DEBUG_LOCKS_WARN_ON(!key))
		return;
	/*
	 * Sanity check, the lock-class key must be persistent:
	 */
	if (!static_obj(key)) {
3214
		printk("BUG: key %px not in .data!\n", key);
P
Peter Zijlstra 已提交
3215 3216 3217
		/*
		 * What it says above ^^^^^, I suggest you read it.
		 */
I
Ingo Molnar 已提交
3218 3219 3220 3221
		DEBUG_LOCKS_WARN_ON(1);
		return;
	}
	lock->key = key;
3222 3223 3224 3225

	if (unlikely(!debug_locks))
		return;

3226 3227 3228 3229 3230 3231 3232 3233
	if (subclass) {
		unsigned long flags;

		if (DEBUG_LOCKS_WARN_ON(current->lockdep_recursion))
			return;

		raw_local_irq_save(flags);
		current->lockdep_recursion = 1;
3234
		register_lock_class(lock, subclass, 1);
3235 3236 3237
		current->lockdep_recursion = 0;
		raw_local_irq_restore(flags);
	}
I
Ingo Molnar 已提交
3238
}
3239 3240 3241 3242 3243 3244

void lockdep_init_map(struct lockdep_map *lock, const char *name,
		      struct lock_class_key *key, int subclass)
{
	__lockdep_init_map(lock, name, key, subclass);
}
I
Ingo Molnar 已提交
3245 3246
EXPORT_SYMBOL_GPL(lockdep_init_map);

3247
struct lock_class_key __lockdep_no_validate__;
K
Kent Overstreet 已提交
3248
EXPORT_SYMBOL_GPL(__lockdep_no_validate__);
3249

3250 3251 3252 3253 3254 3255 3256 3257 3258 3259
static int
print_lock_nested_lock_not_held(struct task_struct *curr,
				struct held_lock *hlock,
				unsigned long ip)
{
	if (!debug_locks_off())
		return 0;
	if (debug_locks_silent)
		return 0;

3260
	pr_warn("\n");
3261 3262
	pr_warn("==================================\n");
	pr_warn("WARNING: Nested lock was not taken\n");
3263
	print_kernel_ident();
3264
	pr_warn("----------------------------------\n");
3265

3266
	pr_warn("%s/%d is trying to lock:\n", curr->comm, task_pid_nr(curr));
3267 3268
	print_lock(hlock);

3269 3270
	pr_warn("\nbut this task is not holding:\n");
	pr_warn("%s\n", hlock->nest_lock->name);
3271

3272
	pr_warn("\nstack backtrace:\n");
3273 3274
	dump_stack();

3275
	pr_warn("\nother info that might help us debug this:\n");
3276 3277
	lockdep_print_held_locks(curr);

3278
	pr_warn("\nstack backtrace:\n");
3279 3280 3281 3282 3283
	dump_stack();

	return 0;
}

3284
static int __lock_is_held(const struct lockdep_map *lock, int read);
3285

I
Ingo Molnar 已提交
3286 3287 3288 3289 3290 3291
/*
 * This gets called for every mutex_lock*()/spin_lock*() operation.
 * We maintain the dependency maps and validate the locking attempt:
 */
static int __lock_acquire(struct lockdep_map *lock, unsigned int subclass,
			  int trylock, int read, int check, int hardirqs_off,
3292
			  struct lockdep_map *nest_lock, unsigned long ip,
3293
			  int references, int pin_count)
I
Ingo Molnar 已提交
3294 3295
{
	struct task_struct *curr = current;
3296
	struct lock_class *class = NULL;
I
Ingo Molnar 已提交
3297
	struct held_lock *hlock;
3298
	unsigned int depth;
I
Ingo Molnar 已提交
3299
	int chain_head = 0;
3300
	int class_idx;
I
Ingo Molnar 已提交
3301 3302 3303 3304 3305
	u64 chain_key;

	if (unlikely(!debug_locks))
		return 0;

P
Peter Zijlstra 已提交
3306 3307 3308 3309 3310
	/*
	 * Lockdep should run with IRQs disabled, otherwise we could
	 * get an interrupt which would want to take locks, which would
	 * end up in lockdep and have you got a head-ache already?
	 */
I
Ingo Molnar 已提交
3311 3312 3313
	if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
		return 0;

3314 3315
	if (!prove_locking || lock->key == &__lockdep_no_validate__)
		check = 0;
3316

3317 3318
	if (subclass < NR_LOCKDEP_CACHING_CLASSES)
		class = lock->class_cache[subclass];
3319
	/*
3320
	 * Not cached?
3321
	 */
I
Ingo Molnar 已提交
3322
	if (unlikely(!class)) {
3323
		class = register_lock_class(lock, subclass, 0);
I
Ingo Molnar 已提交
3324 3325 3326
		if (!class)
			return 0;
	}
3327
	atomic_inc((atomic_t *)&class->ops);
I
Ingo Molnar 已提交
3328
	if (very_verbose(class)) {
3329
		printk("\nacquire class [%px] %s", class->key, class->name);
I
Ingo Molnar 已提交
3330
		if (class->name_version > 1)
D
Dmitry Vyukov 已提交
3331 3332
			printk(KERN_CONT "#%d", class->name_version);
		printk(KERN_CONT "\n");
I
Ingo Molnar 已提交
3333 3334 3335 3336 3337 3338 3339 3340 3341
		dump_stack();
	}

	/*
	 * Add the lock to the list of currently held locks.
	 * (we dont increase the depth just yet, up until the
	 * dependency checks are done)
	 */
	depth = curr->lockdep_depth;
P
Peter Zijlstra 已提交
3342 3343 3344
	/*
	 * Ran out of static storage for our per-task lock stack again have we?
	 */
I
Ingo Molnar 已提交
3345 3346 3347
	if (DEBUG_LOCKS_WARN_ON(depth >= MAX_LOCK_DEPTH))
		return 0;

3348 3349
	class_idx = class - lock_classes + 1;

3350
	if (depth) {
3351 3352
		hlock = curr->held_locks + depth - 1;
		if (hlock->class_idx == class_idx && nest_lock) {
3353 3354 3355 3356 3357 3358 3359
			if (hlock->references) {
				/*
				 * Check: unsigned int references:12, overflow.
				 */
				if (DEBUG_LOCKS_WARN_ON(hlock->references == (1 << 12)-1))
					return 0;

3360
				hlock->references++;
3361
			} else {
3362
				hlock->references = 2;
3363
			}
3364 3365 3366 3367 3368

			return 1;
		}
	}

I
Ingo Molnar 已提交
3369
	hlock = curr->held_locks + depth;
P
Peter Zijlstra 已提交
3370 3371 3372 3373
	/*
	 * Plain impossible, we just registered it and checked it weren't no
	 * NULL like.. I bet this mushroom I ate was good!
	 */
D
Dave Jones 已提交
3374 3375
	if (DEBUG_LOCKS_WARN_ON(!class))
		return 0;
3376
	hlock->class_idx = class_idx;
I
Ingo Molnar 已提交
3377 3378
	hlock->acquire_ip = ip;
	hlock->instance = lock;
P
Peter Zijlstra 已提交
3379
	hlock->nest_lock = nest_lock;
3380
	hlock->irq_context = task_irq_context(curr);
I
Ingo Molnar 已提交
3381 3382 3383
	hlock->trylock = trylock;
	hlock->read = read;
	hlock->check = check;
3384
	hlock->hardirqs_off = !!hardirqs_off;
3385
	hlock->references = references;
P
Peter Zijlstra 已提交
3386 3387
#ifdef CONFIG_LOCK_STAT
	hlock->waittime_stamp = 0;
3388
	hlock->holdtime_stamp = lockstat_clock();
P
Peter Zijlstra 已提交
3389
#endif
3390
	hlock->pin_count = pin_count;
I
Ingo Molnar 已提交
3391

3392
	if (check && !mark_irqflags(curr, hlock))
P
Peter Zijlstra 已提交
3393 3394
		return 0;

I
Ingo Molnar 已提交
3395
	/* mark it as used: */
3396
	if (!mark_lock(curr, hlock, LOCK_USED))
I
Ingo Molnar 已提交
3397
		return 0;
P
Peter Zijlstra 已提交
3398

I
Ingo Molnar 已提交
3399
	/*
3400
	 * Calculate the chain hash: it's the combined hash of all the
I
Ingo Molnar 已提交
3401 3402 3403 3404 3405 3406 3407 3408
	 * lock keys along the dependency chain. We save the hash value
	 * at every step so that we can get the current hash easily
	 * after unlock. The chain hash is then used to cache dependency
	 * results.
	 *
	 * The 'key ID' is what is the most compact key value to drive
	 * the hash, not class->key.
	 */
P
Peter Zijlstra 已提交
3409 3410 3411
	/*
	 * Whoops, we did it again.. ran straight out of our static allocation.
	 */
3412
	if (DEBUG_LOCKS_WARN_ON(class_idx > MAX_LOCKDEP_KEYS))
I
Ingo Molnar 已提交
3413 3414 3415 3416
		return 0;

	chain_key = curr->curr_chain_key;
	if (!depth) {
P
Peter Zijlstra 已提交
3417 3418 3419
		/*
		 * How can we have a chain hash when we ain't got no keys?!
		 */
I
Ingo Molnar 已提交
3420 3421 3422 3423 3424 3425
		if (DEBUG_LOCKS_WARN_ON(chain_key != 0))
			return 0;
		chain_head = 1;
	}

	hlock->prev_chain_key = chain_key;
P
Peter Zijlstra 已提交
3426 3427 3428
	if (separate_irq_context(curr, hlock)) {
		chain_key = 0;
		chain_head = 1;
I
Ingo Molnar 已提交
3429
	}
3430
	chain_key = iterate_chain_key(chain_key, class_idx);
I
Ingo Molnar 已提交
3431

3432
	if (nest_lock && !__lock_is_held(nest_lock, -1))
3433 3434
		return print_lock_nested_lock_not_held(curr, hlock, ip);

3435
	if (!validate_chain(curr, lock, hlock, chain_head, chain_key))
P
Peter Zijlstra 已提交
3436
		return 0;
3437

3438
	curr->curr_chain_key = chain_key;
I
Ingo Molnar 已提交
3439 3440
	curr->lockdep_depth++;
	check_chain_key(curr);
3441 3442 3443 3444
#ifdef CONFIG_DEBUG_LOCKDEP
	if (unlikely(!debug_locks))
		return 0;
#endif
I
Ingo Molnar 已提交
3445 3446
	if (unlikely(curr->lockdep_depth >= MAX_LOCK_DEPTH)) {
		debug_locks_off();
3447 3448
		print_lockdep_off("BUG: MAX_LOCK_DEPTH too low!");
		printk(KERN_DEBUG "depth: %i  max: %lu!\n",
3449 3450 3451 3452
		       curr->lockdep_depth, MAX_LOCK_DEPTH);

		lockdep_print_held_locks(current);
		debug_show_all_locks();
3453
		dump_stack();
3454

I
Ingo Molnar 已提交
3455 3456
		return 0;
	}
3457

I
Ingo Molnar 已提交
3458 3459 3460 3461 3462 3463 3464
	if (unlikely(curr->lockdep_depth > max_lockdep_depth))
		max_lockdep_depth = curr->lockdep_depth;

	return 1;
}

static int
3465
print_unlock_imbalance_bug(struct task_struct *curr, struct lockdep_map *lock,
I
Ingo Molnar 已提交
3466 3467 3468 3469 3470 3471 3472
			   unsigned long ip)
{
	if (!debug_locks_off())
		return 0;
	if (debug_locks_silent)
		return 0;

3473
	pr_warn("\n");
3474 3475
	pr_warn("=====================================\n");
	pr_warn("WARNING: bad unlock balance detected!\n");
3476
	print_kernel_ident();
3477
	pr_warn("-------------------------------------\n");
3478
	pr_warn("%s/%d is trying to release lock (",
3479
		curr->comm, task_pid_nr(curr));
I
Ingo Molnar 已提交
3480
	print_lockdep_cache(lock);
3481
	pr_cont(") at:\n");
I
Ingo Molnar 已提交
3482
	print_ip_sym(ip);
3483 3484
	pr_warn("but there are no more locks to release!\n");
	pr_warn("\nother info that might help us debug this:\n");
I
Ingo Molnar 已提交
3485 3486
	lockdep_print_held_locks(curr);

3487
	pr_warn("\nstack backtrace:\n");
I
Ingo Molnar 已提交
3488 3489 3490 3491 3492
	dump_stack();

	return 0;
}

3493 3494
static int match_held_lock(const struct held_lock *hlock,
					const struct lockdep_map *lock)
3495 3496 3497 3498 3499
{
	if (hlock->instance == lock)
		return 1;

	if (hlock->references) {
3500
		const struct lock_class *class = lock->class_cache[0];
3501 3502 3503 3504

		if (!class)
			class = look_up_lock_class(lock, 0);

3505 3506 3507 3508 3509 3510
		/*
		 * If look_up_lock_class() failed to find a class, we're trying
		 * to test if we hold a lock that has never yet been acquired.
		 * Clearly if the lock hasn't been acquired _ever_, we're not
		 * holding it either, so report failure.
		 */
3511
		if (!class)
3512 3513
			return 0;

P
Peter Zijlstra 已提交
3514 3515 3516 3517 3518
		/*
		 * References, but not a lock we're actually ref-counting?
		 * State got messed up, follow the sites that change ->references
		 * and try to make sense of it.
		 */
3519 3520 3521 3522 3523 3524 3525 3526 3527 3528
		if (DEBUG_LOCKS_WARN_ON(!hlock->nest_lock))
			return 0;

		if (hlock->class_idx == class - lock_classes + 1)
			return 1;
	}

	return 0;
}

3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564
/* @depth must not be zero */
static struct held_lock *find_held_lock(struct task_struct *curr,
					struct lockdep_map *lock,
					unsigned int depth, int *idx)
{
	struct held_lock *ret, *hlock, *prev_hlock;
	int i;

	i = depth - 1;
	hlock = curr->held_locks + i;
	ret = hlock;
	if (match_held_lock(hlock, lock))
		goto out;

	ret = NULL;
	for (i--, prev_hlock = hlock--;
	     i >= 0;
	     i--, prev_hlock = hlock--) {
		/*
		 * We must not cross into another context:
		 */
		if (prev_hlock->irq_context != hlock->irq_context) {
			ret = NULL;
			break;
		}
		if (match_held_lock(hlock, lock)) {
			ret = hlock;
			break;
		}
	}

out:
	*idx = i;
	return ret;
}

3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582
static int reacquire_held_locks(struct task_struct *curr, unsigned int depth,
			      int idx)
{
	struct held_lock *hlock;

	for (hlock = curr->held_locks + idx; idx < depth; idx++, hlock++) {
		if (!__lock_acquire(hlock->instance,
				    hlock_class(hlock)->subclass,
				    hlock->trylock,
				    hlock->read, hlock->check,
				    hlock->hardirqs_off,
				    hlock->nest_lock, hlock->acquire_ip,
				    hlock->references, hlock->pin_count))
			return 1;
	}
	return 0;
}

3583
static int
3584 3585 3586
__lock_set_class(struct lockdep_map *lock, const char *name,
		 struct lock_class_key *key, unsigned int subclass,
		 unsigned long ip)
3587 3588
{
	struct task_struct *curr = current;
3589
	struct held_lock *hlock;
3590 3591 3592 3593 3594
	struct lock_class *class;
	unsigned int depth;
	int i;

	depth = curr->lockdep_depth;
P
Peter Zijlstra 已提交
3595 3596 3597 3598
	/*
	 * This function is about (re)setting the class of a held lock,
	 * yet we're not actually holding any locks. Naughty user!
	 */
3599 3600 3601
	if (DEBUG_LOCKS_WARN_ON(!depth))
		return 0;

3602 3603 3604
	hlock = find_held_lock(curr, lock, depth, &i);
	if (!hlock)
		return print_unlock_imbalance_bug(curr, lock, ip);
3605

3606
	lockdep_init_map(lock, name, key, 0);
3607
	class = register_lock_class(lock, subclass, 0);
D
Dave Jones 已提交
3608
	hlock->class_idx = class - lock_classes + 1;
3609 3610 3611 3612

	curr->lockdep_depth = i;
	curr->curr_chain_key = hlock->prev_chain_key;

3613 3614
	if (reacquire_held_locks(curr, depth, i))
		return 0;
3615

P
Peter Zijlstra 已提交
3616 3617 3618 3619
	/*
	 * I took it apart and put it back together again, except now I have
	 * these 'spare' parts.. where shall I put them.
	 */
3620 3621 3622 3623 3624
	if (DEBUG_LOCKS_WARN_ON(curr->lockdep_depth != depth))
		return 0;
	return 1;
}

3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662
static int __lock_downgrade(struct lockdep_map *lock, unsigned long ip)
{
	struct task_struct *curr = current;
	struct held_lock *hlock;
	unsigned int depth;
	int i;

	depth = curr->lockdep_depth;
	/*
	 * This function is about (re)setting the class of a held lock,
	 * yet we're not actually holding any locks. Naughty user!
	 */
	if (DEBUG_LOCKS_WARN_ON(!depth))
		return 0;

	hlock = find_held_lock(curr, lock, depth, &i);
	if (!hlock)
		return print_unlock_imbalance_bug(curr, lock, ip);

	curr->lockdep_depth = i;
	curr->curr_chain_key = hlock->prev_chain_key;

	WARN(hlock->read, "downgrading a read lock");
	hlock->read = 1;
	hlock->acquire_ip = ip;

	if (reacquire_held_locks(curr, depth, i))
		return 0;

	/*
	 * I took it apart and put it back together again, except now I have
	 * these 'spare' parts.. where shall I put them.
	 */
	if (DEBUG_LOCKS_WARN_ON(curr->lockdep_depth != depth))
		return 0;
	return 1;
}

I
Ingo Molnar 已提交
3663
/*
3664 3665 3666 3667 3668
 * Remove the lock to the list of currently held locks - this gets
 * called on mutex_unlock()/spin_unlock*() (or on a failed
 * mutex_lock_interruptible()).
 *
 * @nested is an hysterical artifact, needs a tree wide cleanup.
I
Ingo Molnar 已提交
3669 3670
 */
static int
3671
__lock_release(struct lockdep_map *lock, int nested, unsigned long ip)
I
Ingo Molnar 已提交
3672
{
3673
	struct task_struct *curr = current;
3674
	struct held_lock *hlock;
I
Ingo Molnar 已提交
3675
	unsigned int depth;
3676
	int i;
I
Ingo Molnar 已提交
3677

3678 3679 3680
	if (unlikely(!debug_locks))
		return 0;

I
Ingo Molnar 已提交
3681
	depth = curr->lockdep_depth;
P
Peter Zijlstra 已提交
3682 3683 3684 3685
	/*
	 * So we're all set to release this lock.. wait what lock? We don't
	 * own any locks, you've been drinking again?
	 */
3686 3687
	if (DEBUG_LOCKS_WARN_ON(depth <= 0))
		 return print_unlock_imbalance_bug(curr, lock, ip);
I
Ingo Molnar 已提交
3688

3689 3690 3691 3692
	/*
	 * Check whether the lock exists in the current stack
	 * of held locks:
	 */
3693 3694 3695
	hlock = find_held_lock(curr, lock, depth, &i);
	if (!hlock)
		return print_unlock_imbalance_bug(curr, lock, ip);
I
Ingo Molnar 已提交
3696

3697 3698 3699
	if (hlock->instance == lock)
		lock_release_holdtime(hlock);

P
Peter Zijlstra 已提交
3700 3701
	WARN(hlock->pin_count, "releasing a pinned lock\n");

3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712
	if (hlock->references) {
		hlock->references--;
		if (hlock->references) {
			/*
			 * We had, and after removing one, still have
			 * references, the current lock stack is still
			 * valid. We're done!
			 */
			return 1;
		}
	}
P
Peter Zijlstra 已提交
3713

I
Ingo Molnar 已提交
3714 3715 3716 3717 3718
	/*
	 * We have the right lock to unlock, 'hlock' points to it.
	 * Now we remove it from the stack, and add back the other
	 * entries (if any), recalculating the hash along the way:
	 */
3719

I
Ingo Molnar 已提交
3720 3721 3722
	curr->lockdep_depth = i;
	curr->curr_chain_key = hlock->prev_chain_key;

3723 3724
	if (reacquire_held_locks(curr, depth, i + 1))
		return 0;
I
Ingo Molnar 已提交
3725

P
Peter Zijlstra 已提交
3726 3727 3728 3729
	/*
	 * We had N bottles of beer on the wall, we drank one, but now
	 * there's not N-1 bottles of beer left on the wall...
	 */
I
Ingo Molnar 已提交
3730 3731
	if (DEBUG_LOCKS_WARN_ON(curr->lockdep_depth != depth - 1))
		return 0;
P
Peter Zijlstra 已提交
3732

I
Ingo Molnar 已提交
3733 3734 3735
	return 1;
}

3736
static int __lock_is_held(const struct lockdep_map *lock, int read)
I
Ingo Molnar 已提交
3737
{
3738 3739
	struct task_struct *curr = current;
	int i;
I
Ingo Molnar 已提交
3740

3741
	for (i = 0; i < curr->lockdep_depth; i++) {
3742
		struct held_lock *hlock = curr->held_locks + i;
I
Ingo Molnar 已提交
3743

3744 3745 3746 3747 3748 3749
		if (match_held_lock(hlock, lock)) {
			if (read == -1 || hlock->read == read)
				return 1;

			return 0;
		}
3750
	}
P
Peter Zijlstra 已提交
3751

3752
	return 0;
I
Ingo Molnar 已提交
3753 3754
}

3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783
static struct pin_cookie __lock_pin_lock(struct lockdep_map *lock)
{
	struct pin_cookie cookie = NIL_COOKIE;
	struct task_struct *curr = current;
	int i;

	if (unlikely(!debug_locks))
		return cookie;

	for (i = 0; i < curr->lockdep_depth; i++) {
		struct held_lock *hlock = curr->held_locks + i;

		if (match_held_lock(hlock, lock)) {
			/*
			 * Grab 16bits of randomness; this is sufficient to not
			 * be guessable and still allows some pin nesting in
			 * our u32 pin_count.
			 */
			cookie.val = 1 + (prandom_u32() >> 16);
			hlock->pin_count += cookie.val;
			return cookie;
		}
	}

	WARN(1, "pinning an unheld lock\n");
	return cookie;
}

static void __lock_repin_lock(struct lockdep_map *lock, struct pin_cookie cookie)
I
Ingo Molnar 已提交
3784 3785
{
	struct task_struct *curr = current;
P
Peter Zijlstra 已提交
3786
	int i;
I
Ingo Molnar 已提交
3787

P
Peter Zijlstra 已提交
3788
	if (unlikely(!debug_locks))
I
Ingo Molnar 已提交
3789 3790
		return;

P
Peter Zijlstra 已提交
3791 3792 3793 3794
	for (i = 0; i < curr->lockdep_depth; i++) {
		struct held_lock *hlock = curr->held_locks + i;

		if (match_held_lock(hlock, lock)) {
3795
			hlock->pin_count += cookie.val;
I
Ingo Molnar 已提交
3796
			return;
P
Peter Zijlstra 已提交
3797
		}
I
Ingo Molnar 已提交
3798 3799
	}

P
Peter Zijlstra 已提交
3800
	WARN(1, "pinning an unheld lock\n");
I
Ingo Molnar 已提交
3801 3802
}

3803
static void __lock_unpin_lock(struct lockdep_map *lock, struct pin_cookie cookie)
3804 3805 3806 3807
{
	struct task_struct *curr = current;
	int i;

P
Peter Zijlstra 已提交
3808 3809 3810
	if (unlikely(!debug_locks))
		return;

3811
	for (i = 0; i < curr->lockdep_depth; i++) {
3812 3813
		struct held_lock *hlock = curr->held_locks + i;

P
Peter Zijlstra 已提交
3814 3815 3816 3817
		if (match_held_lock(hlock, lock)) {
			if (WARN(!hlock->pin_count, "unpinning an unpinned lock\n"))
				return;

3818 3819 3820 3821 3822
			hlock->pin_count -= cookie.val;

			if (WARN((int)hlock->pin_count < 0, "pin count corrupted\n"))
				hlock->pin_count = 0;

P
Peter Zijlstra 已提交
3823 3824
			return;
		}
3825 3826
	}

P
Peter Zijlstra 已提交
3827
	WARN(1, "unpinning an unheld lock\n");
3828 3829
}

I
Ingo Molnar 已提交
3830 3831 3832
/*
 * Check whether we follow the irq-flags state precisely:
 */
3833
static void check_flags(unsigned long flags)
I
Ingo Molnar 已提交
3834
{
3835 3836
#if defined(CONFIG_PROVE_LOCKING) && defined(CONFIG_DEBUG_LOCKDEP) && \
    defined(CONFIG_TRACE_IRQFLAGS)
I
Ingo Molnar 已提交
3837 3838 3839
	if (!debug_locks)
		return;

3840 3841 3842 3843 3844 3845 3846 3847 3848
	if (irqs_disabled_flags(flags)) {
		if (DEBUG_LOCKS_WARN_ON(current->hardirqs_enabled)) {
			printk("possible reason: unannotated irqs-off.\n");
		}
	} else {
		if (DEBUG_LOCKS_WARN_ON(!current->hardirqs_enabled)) {
			printk("possible reason: unannotated irqs-on.\n");
		}
	}
I
Ingo Molnar 已提交
3849 3850 3851 3852 3853 3854 3855

	/*
	 * We dont accurately track softirq state in e.g.
	 * hardirq contexts (such as on 4KSTACKS), so only
	 * check if not in hardirq contexts:
	 */
	if (!hardirq_count()) {
P
Peter Zijlstra 已提交
3856 3857
		if (softirq_count()) {
			/* like the above, but with softirqs */
I
Ingo Molnar 已提交
3858
			DEBUG_LOCKS_WARN_ON(current->softirqs_enabled);
P
Peter Zijlstra 已提交
3859 3860
		} else {
			/* lick the above, does it taste good? */
I
Ingo Molnar 已提交
3861
			DEBUG_LOCKS_WARN_ON(!current->softirqs_enabled);
P
Peter Zijlstra 已提交
3862
		}
I
Ingo Molnar 已提交
3863 3864 3865 3866 3867 3868 3869
	}

	if (!debug_locks)
		print_irqtrace_events(current);
#endif
}

3870 3871 3872
void lock_set_class(struct lockdep_map *lock, const char *name,
		    struct lock_class_key *key, unsigned int subclass,
		    unsigned long ip)
3873 3874 3875 3876 3877 3878 3879 3880 3881
{
	unsigned long flags;

	if (unlikely(current->lockdep_recursion))
		return;

	raw_local_irq_save(flags);
	current->lockdep_recursion = 1;
	check_flags(flags);
3882
	if (__lock_set_class(lock, name, key, subclass, ip))
3883 3884 3885 3886
		check_chain_key(current);
	current->lockdep_recursion = 0;
	raw_local_irq_restore(flags);
}
3887
EXPORT_SYMBOL_GPL(lock_set_class);
3888

3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905
void lock_downgrade(struct lockdep_map *lock, unsigned long ip)
{
	unsigned long flags;

	if (unlikely(current->lockdep_recursion))
		return;

	raw_local_irq_save(flags);
	current->lockdep_recursion = 1;
	check_flags(flags);
	if (__lock_downgrade(lock, ip))
		check_chain_key(current);
	current->lockdep_recursion = 0;
	raw_local_irq_restore(flags);
}
EXPORT_SYMBOL_GPL(lock_downgrade);

I
Ingo Molnar 已提交
3906 3907 3908 3909
/*
 * We are not always called with irqs disabled - do that here,
 * and also avoid lockdep recursion:
 */
3910
void lock_acquire(struct lockdep_map *lock, unsigned int subclass,
P
Peter Zijlstra 已提交
3911 3912
			  int trylock, int read, int check,
			  struct lockdep_map *nest_lock, unsigned long ip)
I
Ingo Molnar 已提交
3913 3914 3915 3916 3917 3918 3919 3920 3921 3922
{
	unsigned long flags;

	if (unlikely(current->lockdep_recursion))
		return;

	raw_local_irq_save(flags);
	check_flags(flags);

	current->lockdep_recursion = 1;
3923
	trace_lock_acquire(lock, subclass, trylock, read, check, nest_lock, ip);
I
Ingo Molnar 已提交
3924
	__lock_acquire(lock, subclass, trylock, read, check,
3925
		       irqs_disabled_flags(flags), nest_lock, ip, 0, 0);
I
Ingo Molnar 已提交
3926 3927 3928 3929 3930
	current->lockdep_recursion = 0;
	raw_local_irq_restore(flags);
}
EXPORT_SYMBOL_GPL(lock_acquire);

3931
void lock_release(struct lockdep_map *lock, int nested,
3932
			  unsigned long ip)
I
Ingo Molnar 已提交
3933 3934 3935 3936 3937 3938 3939 3940 3941
{
	unsigned long flags;

	if (unlikely(current->lockdep_recursion))
		return;

	raw_local_irq_save(flags);
	check_flags(flags);
	current->lockdep_recursion = 1;
3942
	trace_lock_release(lock, ip);
3943 3944
	if (__lock_release(lock, nested, ip))
		check_chain_key(current);
I
Ingo Molnar 已提交
3945 3946 3947 3948 3949
	current->lockdep_recursion = 0;
	raw_local_irq_restore(flags);
}
EXPORT_SYMBOL_GPL(lock_release);

3950
int lock_is_held_type(const struct lockdep_map *lock, int read)
3951 3952 3953 3954 3955
{
	unsigned long flags;
	int ret = 0;

	if (unlikely(current->lockdep_recursion))
3956
		return 1; /* avoid false negative lockdep_assert_held() */
3957 3958 3959 3960 3961

	raw_local_irq_save(flags);
	check_flags(flags);

	current->lockdep_recursion = 1;
3962
	ret = __lock_is_held(lock, read);
3963 3964 3965 3966 3967
	current->lockdep_recursion = 0;
	raw_local_irq_restore(flags);

	return ret;
}
3968
EXPORT_SYMBOL_GPL(lock_is_held_type);
3969

3970
struct pin_cookie lock_pin_lock(struct lockdep_map *lock)
P
Peter Zijlstra 已提交
3971
{
3972
	struct pin_cookie cookie = NIL_COOKIE;
P
Peter Zijlstra 已提交
3973 3974 3975
	unsigned long flags;

	if (unlikely(current->lockdep_recursion))
3976
		return cookie;
P
Peter Zijlstra 已提交
3977 3978 3979 3980 3981

	raw_local_irq_save(flags);
	check_flags(flags);

	current->lockdep_recursion = 1;
3982
	cookie = __lock_pin_lock(lock);
P
Peter Zijlstra 已提交
3983 3984
	current->lockdep_recursion = 0;
	raw_local_irq_restore(flags);
3985 3986

	return cookie;
P
Peter Zijlstra 已提交
3987 3988 3989
}
EXPORT_SYMBOL_GPL(lock_pin_lock);

3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007
void lock_repin_lock(struct lockdep_map *lock, struct pin_cookie cookie)
{
	unsigned long flags;

	if (unlikely(current->lockdep_recursion))
		return;

	raw_local_irq_save(flags);
	check_flags(flags);

	current->lockdep_recursion = 1;
	__lock_repin_lock(lock, cookie);
	current->lockdep_recursion = 0;
	raw_local_irq_restore(flags);
}
EXPORT_SYMBOL_GPL(lock_repin_lock);

void lock_unpin_lock(struct lockdep_map *lock, struct pin_cookie cookie)
P
Peter Zijlstra 已提交
4008 4009 4010 4011 4012 4013 4014 4015 4016 4017
{
	unsigned long flags;

	if (unlikely(current->lockdep_recursion))
		return;

	raw_local_irq_save(flags);
	check_flags(flags);

	current->lockdep_recursion = 1;
4018
	__lock_unpin_lock(lock, cookie);
P
Peter Zijlstra 已提交
4019 4020 4021 4022 4023
	current->lockdep_recursion = 0;
	raw_local_irq_restore(flags);
}
EXPORT_SYMBOL_GPL(lock_unpin_lock);

P
Peter Zijlstra 已提交
4024 4025 4026 4027 4028 4029 4030 4031 4032 4033
#ifdef CONFIG_LOCK_STAT
static int
print_lock_contention_bug(struct task_struct *curr, struct lockdep_map *lock,
			   unsigned long ip)
{
	if (!debug_locks_off())
		return 0;
	if (debug_locks_silent)
		return 0;

4034
	pr_warn("\n");
4035 4036
	pr_warn("=================================\n");
	pr_warn("WARNING: bad contention detected!\n");
4037
	print_kernel_ident();
4038
	pr_warn("---------------------------------\n");
4039
	pr_warn("%s/%d is trying to contend lock (",
4040
		curr->comm, task_pid_nr(curr));
P
Peter Zijlstra 已提交
4041
	print_lockdep_cache(lock);
4042
	pr_cont(") at:\n");
P
Peter Zijlstra 已提交
4043
	print_ip_sym(ip);
4044 4045
	pr_warn("but there are no locks held!\n");
	pr_warn("\nother info that might help us debug this:\n");
P
Peter Zijlstra 已提交
4046 4047
	lockdep_print_held_locks(curr);

4048
	pr_warn("\nstack backtrace:\n");
P
Peter Zijlstra 已提交
4049 4050 4051 4052 4053 4054 4055 4056 4057
	dump_stack();

	return 0;
}

static void
__lock_contended(struct lockdep_map *lock, unsigned long ip)
{
	struct task_struct *curr = current;
4058
	struct held_lock *hlock;
P
Peter Zijlstra 已提交
4059 4060
	struct lock_class_stats *stats;
	unsigned int depth;
P
Peter Zijlstra 已提交
4061
	int i, contention_point, contending_point;
P
Peter Zijlstra 已提交
4062 4063

	depth = curr->lockdep_depth;
P
Peter Zijlstra 已提交
4064 4065 4066 4067
	/*
	 * Whee, we contended on this lock, except it seems we're not
	 * actually trying to acquire anything much at all..
	 */
P
Peter Zijlstra 已提交
4068 4069 4070
	if (DEBUG_LOCKS_WARN_ON(!depth))
		return;

4071 4072 4073 4074
	hlock = find_held_lock(curr, lock, depth, &i);
	if (!hlock) {
		print_lock_contention_bug(curr, lock, ip);
		return;
P
Peter Zijlstra 已提交
4075 4076
	}

4077 4078 4079
	if (hlock->instance != lock)
		return;

4080
	hlock->waittime_stamp = lockstat_clock();
P
Peter Zijlstra 已提交
4081

P
Peter Zijlstra 已提交
4082 4083 4084
	contention_point = lock_point(hlock_class(hlock)->contention_point, ip);
	contending_point = lock_point(hlock_class(hlock)->contending_point,
				      lock->ip);
P
Peter Zijlstra 已提交
4085

D
Dave Jones 已提交
4086
	stats = get_lock_stats(hlock_class(hlock));
P
Peter Zijlstra 已提交
4087 4088 4089 4090
	if (contention_point < LOCKSTAT_POINTS)
		stats->contention_point[contention_point]++;
	if (contending_point < LOCKSTAT_POINTS)
		stats->contending_point[contending_point]++;
P
Peter Zijlstra 已提交
4091 4092
	if (lock->cpu != smp_processor_id())
		stats->bounces[bounce_contended + !!hlock->read]++;
P
Peter Zijlstra 已提交
4093 4094 4095 4096
	put_lock_stats(stats);
}

static void
P
Peter Zijlstra 已提交
4097
__lock_acquired(struct lockdep_map *lock, unsigned long ip)
P
Peter Zijlstra 已提交
4098 4099
{
	struct task_struct *curr = current;
4100
	struct held_lock *hlock;
P
Peter Zijlstra 已提交
4101 4102
	struct lock_class_stats *stats;
	unsigned int depth;
4103
	u64 now, waittime = 0;
P
Peter Zijlstra 已提交
4104
	int i, cpu;
P
Peter Zijlstra 已提交
4105 4106

	depth = curr->lockdep_depth;
P
Peter Zijlstra 已提交
4107 4108 4109 4110
	/*
	 * Yay, we acquired ownership of this lock we didn't try to
	 * acquire, how the heck did that happen?
	 */
P
Peter Zijlstra 已提交
4111 4112 4113
	if (DEBUG_LOCKS_WARN_ON(!depth))
		return;

4114 4115 4116 4117
	hlock = find_held_lock(curr, lock, depth, &i);
	if (!hlock) {
		print_lock_contention_bug(curr, lock, _RET_IP_);
		return;
P
Peter Zijlstra 已提交
4118 4119
	}

4120 4121 4122
	if (hlock->instance != lock)
		return;

P
Peter Zijlstra 已提交
4123 4124
	cpu = smp_processor_id();
	if (hlock->waittime_stamp) {
4125
		now = lockstat_clock();
P
Peter Zijlstra 已提交
4126 4127 4128
		waittime = now - hlock->waittime_stamp;
		hlock->holdtime_stamp = now;
	}
P
Peter Zijlstra 已提交
4129

4130
	trace_lock_acquired(lock, ip);
4131

D
Dave Jones 已提交
4132
	stats = get_lock_stats(hlock_class(hlock));
P
Peter Zijlstra 已提交
4133 4134 4135 4136 4137 4138 4139 4140
	if (waittime) {
		if (hlock->read)
			lock_time_inc(&stats->read_waittime, waittime);
		else
			lock_time_inc(&stats->write_waittime, waittime);
	}
	if (lock->cpu != cpu)
		stats->bounces[bounce_acquired + !!hlock->read]++;
P
Peter Zijlstra 已提交
4141
	put_lock_stats(stats);
P
Peter Zijlstra 已提交
4142 4143

	lock->cpu = cpu;
P
Peter Zijlstra 已提交
4144
	lock->ip = ip;
P
Peter Zijlstra 已提交
4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 4159
}

void lock_contended(struct lockdep_map *lock, unsigned long ip)
{
	unsigned long flags;

	if (unlikely(!lock_stat))
		return;

	if (unlikely(current->lockdep_recursion))
		return;

	raw_local_irq_save(flags);
	check_flags(flags);
	current->lockdep_recursion = 1;
4160
	trace_lock_contended(lock, ip);
P
Peter Zijlstra 已提交
4161 4162 4163 4164 4165 4166
	__lock_contended(lock, ip);
	current->lockdep_recursion = 0;
	raw_local_irq_restore(flags);
}
EXPORT_SYMBOL_GPL(lock_contended);

P
Peter Zijlstra 已提交
4167
void lock_acquired(struct lockdep_map *lock, unsigned long ip)
P
Peter Zijlstra 已提交
4168 4169 4170 4171 4172 4173 4174 4175 4176 4177 4178 4179
{
	unsigned long flags;

	if (unlikely(!lock_stat))
		return;

	if (unlikely(current->lockdep_recursion))
		return;

	raw_local_irq_save(flags);
	check_flags(flags);
	current->lockdep_recursion = 1;
P
Peter Zijlstra 已提交
4180
	__lock_acquired(lock, ip);
P
Peter Zijlstra 已提交
4181 4182 4183 4184 4185 4186
	current->lockdep_recursion = 0;
	raw_local_irq_restore(flags);
}
EXPORT_SYMBOL_GPL(lock_acquired);
#endif

I
Ingo Molnar 已提交
4187 4188 4189 4190 4191 4192 4193 4194
/*
 * Used by the testsuite, sanitize the validator state
 * after a simulated failure:
 */

void lockdep_reset(void)
{
	unsigned long flags;
4195
	int i;
I
Ingo Molnar 已提交
4196 4197 4198 4199 4200 4201 4202 4203 4204 4205

	raw_local_irq_save(flags);
	current->curr_chain_key = 0;
	current->lockdep_depth = 0;
	current->lockdep_recursion = 0;
	memset(current->held_locks, 0, MAX_LOCK_DEPTH*sizeof(struct held_lock));
	nr_hardirq_chains = 0;
	nr_softirq_chains = 0;
	nr_process_chains = 0;
	debug_locks = 1;
4206
	for (i = 0; i < CHAINHASH_SIZE; i++)
4207
		INIT_HLIST_HEAD(chainhash_table + i);
I
Ingo Molnar 已提交
4208 4209 4210 4211 4212 4213 4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225
	raw_local_irq_restore(flags);
}

static void zap_class(struct lock_class *class)
{
	int i;

	/*
	 * Remove all dependencies this lock is
	 * involved in:
	 */
	for (i = 0; i < nr_list_entries; i++) {
		if (list_entries[i].class == class)
			list_del_rcu(&list_entries[i].entry);
	}
	/*
	 * Unhash the class and remove it from the all_lock_classes list:
	 */
4226
	hlist_del_rcu(&class->hash_entry);
I
Ingo Molnar 已提交
4227 4228
	list_del_rcu(&class->lock_entry);

4229 4230
	RCU_INIT_POINTER(class->key, NULL);
	RCU_INIT_POINTER(class->name, NULL);
I
Ingo Molnar 已提交
4231 4232
}

4233
static inline int within(const void *addr, void *start, unsigned long size)
I
Ingo Molnar 已提交
4234 4235 4236 4237
{
	return addr >= start && addr < start + size;
}

4238 4239 4240 4241 4242 4243 4244 4245
/*
 * Used in module.c to remove lock classes from memory that is going to be
 * freed; and possibly re-used by other modules.
 *
 * We will have had one sync_sched() before getting here, so we're guaranteed
 * nobody will look up these exact classes -- they're properly dead but still
 * allocated.
 */
I
Ingo Molnar 已提交
4246 4247
void lockdep_free_key_range(void *start, unsigned long size)
{
4248
	struct lock_class *class;
4249
	struct hlist_head *head;
I
Ingo Molnar 已提交
4250 4251
	unsigned long flags;
	int i;
4252
	int locked;
I
Ingo Molnar 已提交
4253 4254

	raw_local_irq_save(flags);
4255
	locked = graph_lock();
I
Ingo Molnar 已提交
4256 4257 4258 4259 4260 4261

	/*
	 * Unhash all classes that were created by this module:
	 */
	for (i = 0; i < CLASSHASH_SIZE; i++) {
		head = classhash_table + i;
4262
		hlist_for_each_entry_rcu(class, head, hash_entry) {
I
Ingo Molnar 已提交
4263 4264
			if (within(class->key, start, size))
				zap_class(class);
4265 4266 4267
			else if (within(class->name, start, size))
				zap_class(class);
		}
I
Ingo Molnar 已提交
4268 4269
	}

4270 4271
	if (locked)
		graph_unlock();
I
Ingo Molnar 已提交
4272
	raw_local_irq_restore(flags);
4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283 4284 4285 4286

	/*
	 * Wait for any possible iterators from look_up_lock_class() to pass
	 * before continuing to free the memory they refer to.
	 *
	 * sync_sched() is sufficient because the read-side is IRQ disable.
	 */
	synchronize_sched();

	/*
	 * XXX at this point we could return the resources to the pool;
	 * instead we leak them. We would need to change to bitmap allocators
	 * instead of the linear allocators we have now.
	 */
I
Ingo Molnar 已提交
4287 4288 4289 4290
}

void lockdep_reset_lock(struct lockdep_map *lock)
{
4291
	struct lock_class *class;
4292
	struct hlist_head *head;
I
Ingo Molnar 已提交
4293 4294
	unsigned long flags;
	int i, j;
4295
	int locked;
I
Ingo Molnar 已提交
4296 4297 4298 4299

	raw_local_irq_save(flags);

	/*
4300 4301 4302 4303 4304 4305 4306
	 * Remove all classes this lock might have:
	 */
	for (j = 0; j < MAX_LOCKDEP_SUBCLASSES; j++) {
		/*
		 * If the class exists we look it up and zap it:
		 */
		class = look_up_lock_class(lock, j);
4307
		if (class)
4308 4309 4310 4311 4312
			zap_class(class);
	}
	/*
	 * Debug check: in the end all mapped classes should
	 * be gone.
I
Ingo Molnar 已提交
4313
	 */
4314
	locked = graph_lock();
I
Ingo Molnar 已提交
4315 4316
	for (i = 0; i < CLASSHASH_SIZE; i++) {
		head = classhash_table + i;
4317
		hlist_for_each_entry_rcu(class, head, hash_entry) {
4318 4319 4320 4321 4322 4323
			int match = 0;

			for (j = 0; j < NR_LOCKDEP_CACHING_CLASSES; j++)
				match |= class == lock->class_cache[j];

			if (unlikely(match)) {
P
Peter Zijlstra 已提交
4324 4325 4326 4327
				if (debug_locks_off_graph_unlock()) {
					/*
					 * We all just reset everything, how did it match?
					 */
4328
					WARN_ON(1);
P
Peter Zijlstra 已提交
4329
				}
4330
				goto out_restore;
I
Ingo Molnar 已提交
4331 4332 4333
			}
		}
	}
4334 4335
	if (locked)
		graph_unlock();
4336 4337

out_restore:
I
Ingo Molnar 已提交
4338 4339 4340 4341 4342 4343 4344
	raw_local_irq_restore(flags);
}

void __init lockdep_info(void)
{
	printk("Lock dependency validator: Copyright (c) 2006 Red Hat, Inc., Ingo Molnar\n");

4345
	printk("... MAX_LOCKDEP_SUBCLASSES:  %lu\n", MAX_LOCKDEP_SUBCLASSES);
I
Ingo Molnar 已提交
4346 4347
	printk("... MAX_LOCK_DEPTH:          %lu\n", MAX_LOCK_DEPTH);
	printk("... MAX_LOCKDEP_KEYS:        %lu\n", MAX_LOCKDEP_KEYS);
4348
	printk("... CLASSHASH_SIZE:          %lu\n", CLASSHASH_SIZE);
I
Ingo Molnar 已提交
4349 4350 4351 4352 4353 4354 4355 4356 4357
	printk("... MAX_LOCKDEP_ENTRIES:     %lu\n", MAX_LOCKDEP_ENTRIES);
	printk("... MAX_LOCKDEP_CHAINS:      %lu\n", MAX_LOCKDEP_CHAINS);
	printk("... CHAINHASH_SIZE:          %lu\n", CHAINHASH_SIZE);

	printk(" memory used by lock dependency info: %lu kB\n",
		(sizeof(struct lock_class) * MAX_LOCKDEP_KEYS +
		sizeof(struct list_head) * CLASSHASH_SIZE +
		sizeof(struct lock_list) * MAX_LOCKDEP_ENTRIES +
		sizeof(struct lock_chain) * MAX_LOCKDEP_CHAINS +
M
Ming Lei 已提交
4358
		sizeof(struct list_head) * CHAINHASH_SIZE
4359
#ifdef CONFIG_PROVE_LOCKING
4360
		+ sizeof(struct circular_queue)
4361
#endif
M
Ming Lei 已提交
4362
		) / 1024
4363
		);
I
Ingo Molnar 已提交
4364 4365 4366 4367 4368 4369 4370

	printk(" per task-struct memory footprint: %lu bytes\n",
		sizeof(struct held_lock) * MAX_LOCK_DEPTH);
}

static void
print_freed_lock_bug(struct task_struct *curr, const void *mem_from,
4371
		     const void *mem_to, struct held_lock *hlock)
I
Ingo Molnar 已提交
4372 4373 4374 4375 4376 4377
{
	if (!debug_locks_off())
		return;
	if (debug_locks_silent)
		return;

4378
	pr_warn("\n");
4379 4380
	pr_warn("=========================\n");
	pr_warn("WARNING: held lock freed!\n");
4381
	print_kernel_ident();
4382
	pr_warn("-------------------------\n");
4383
	pr_warn("%s/%d is freeing memory %px-%px, with a lock still held there!\n",
4384
		curr->comm, task_pid_nr(curr), mem_from, mem_to-1);
4385
	print_lock(hlock);
I
Ingo Molnar 已提交
4386 4387
	lockdep_print_held_locks(curr);

4388
	pr_warn("\nstack backtrace:\n");
I
Ingo Molnar 已提交
4389 4390 4391
	dump_stack();
}

O
Oleg Nesterov 已提交
4392 4393 4394 4395 4396 4397 4398
static inline int not_in_range(const void* mem_from, unsigned long mem_len,
				const void* lock_from, unsigned long lock_len)
{
	return lock_from + lock_len <= mem_from ||
		mem_from + mem_len <= lock_from;
}

I
Ingo Molnar 已提交
4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413
/*
 * Called when kernel memory is freed (or unmapped), or if a lock
 * is destroyed or reinitialized - this code checks whether there is
 * any held lock in the memory range of <from> to <to>:
 */
void debug_check_no_locks_freed(const void *mem_from, unsigned long mem_len)
{
	struct task_struct *curr = current;
	struct held_lock *hlock;
	unsigned long flags;
	int i;

	if (unlikely(!debug_locks))
		return;

4414
	raw_local_irq_save(flags);
I
Ingo Molnar 已提交
4415 4416 4417
	for (i = 0; i < curr->lockdep_depth; i++) {
		hlock = curr->held_locks + i;

O
Oleg Nesterov 已提交
4418 4419
		if (not_in_range(mem_from, mem_len, hlock->instance,
					sizeof(*hlock->instance)))
I
Ingo Molnar 已提交
4420 4421
			continue;

O
Oleg Nesterov 已提交
4422
		print_freed_lock_bug(curr, mem_from, mem_from + mem_len, hlock);
I
Ingo Molnar 已提交
4423 4424
		break;
	}
4425
	raw_local_irq_restore(flags);
I
Ingo Molnar 已提交
4426
}
4427
EXPORT_SYMBOL_GPL(debug_check_no_locks_freed);
I
Ingo Molnar 已提交
4428

4429
static void print_held_locks_bug(void)
I
Ingo Molnar 已提交
4430 4431 4432 4433 4434 4435
{
	if (!debug_locks_off())
		return;
	if (debug_locks_silent)
		return;

4436
	pr_warn("\n");
4437 4438
	pr_warn("====================================\n");
	pr_warn("WARNING: %s/%d still has locks held!\n",
4439
	       current->comm, task_pid_nr(current));
4440
	print_kernel_ident();
4441
	pr_warn("------------------------------------\n");
4442
	lockdep_print_held_locks(current);
4443
	pr_warn("\nstack backtrace:\n");
I
Ingo Molnar 已提交
4444 4445 4446
	dump_stack();
}

4447
void debug_check_no_locks_held(void)
I
Ingo Molnar 已提交
4448
{
4449 4450
	if (unlikely(current->lockdep_depth > 0))
		print_held_locks_bug();
I
Ingo Molnar 已提交
4451
}
4452
EXPORT_SYMBOL_GPL(debug_check_no_locks_held);
I
Ingo Molnar 已提交
4453

4454
#ifdef __KERNEL__
I
Ingo Molnar 已提交
4455 4456 4457 4458
void debug_show_all_locks(void)
{
	struct task_struct *g, *p;

4459
	if (unlikely(!debug_locks)) {
4460
		pr_warn("INFO: lockdep is turned off.\n");
4461 4462
		return;
	}
4463
	pr_warn("\nShowing all locks held in the system:\n");
I
Ingo Molnar 已提交
4464

4465 4466 4467 4468 4469
	rcu_read_lock();
	for_each_process_thread(g, p) {
		if (!p->lockdep_depth)
			continue;
		lockdep_print_held_locks(p);
4470
		touch_nmi_watchdog();
4471 4472 4473
		touch_all_softlockup_watchdogs();
	}
	rcu_read_unlock();
I
Ingo Molnar 已提交
4474

4475
	pr_warn("\n");
4476
	pr_warn("=============================================\n\n");
I
Ingo Molnar 已提交
4477 4478
}
EXPORT_SYMBOL_GPL(debug_show_all_locks);
4479
#endif
I
Ingo Molnar 已提交
4480

4481 4482 4483 4484
/*
 * Careful: only use this function if you are sure that
 * the task cannot run in parallel!
 */
4485
void debug_show_held_locks(struct task_struct *task)
I
Ingo Molnar 已提交
4486
{
4487 4488 4489 4490
	if (unlikely(!debug_locks)) {
		printk("INFO: lockdep is turned off.\n");
		return;
	}
I
Ingo Molnar 已提交
4491 4492 4493
	lockdep_print_held_locks(task);
}
EXPORT_SYMBOL_GPL(debug_show_held_locks);
P
Peter Zijlstra 已提交
4494

4495
asmlinkage __visible void lockdep_sys_exit(void)
P
Peter Zijlstra 已提交
4496 4497 4498 4499 4500 4501
{
	struct task_struct *curr = current;

	if (unlikely(curr->lockdep_depth)) {
		if (!debug_locks_off())
			return;
4502
		pr_warn("\n");
4503 4504
		pr_warn("================================================\n");
		pr_warn("WARNING: lock held when returning to user space!\n");
4505
		print_kernel_ident();
4506
		pr_warn("------------------------------------------------\n");
4507
		pr_warn("%s/%d is leaving the kernel with locks still held!\n",
P
Peter Zijlstra 已提交
4508 4509 4510
				curr->comm, curr->pid);
		lockdep_print_held_locks(curr);
	}
4511 4512 4513 4514 4515

	/*
	 * The lock history for each syscall should be independent. So wipe the
	 * slate clean on return to userspace.
	 */
4516
	lockdep_invariant_state(false);
P
Peter Zijlstra 已提交
4517
}
4518

4519
void lockdep_rcu_suspicious(const char *file, const int line, const char *s)
4520 4521 4522
{
	struct task_struct *curr = current;

4523
	/* Note: the following can be executed concurrently, so be careful. */
4524
	pr_warn("\n");
4525 4526
	pr_warn("=============================\n");
	pr_warn("WARNING: suspicious RCU usage\n");
4527
	print_kernel_ident();
4528
	pr_warn("-----------------------------\n");
4529 4530 4531
	pr_warn("%s:%d %s!\n", file, line, s);
	pr_warn("\nother info that might help us debug this:\n\n");
	pr_warn("\n%srcu_scheduler_active = %d, debug_locks = %d\n",
4532 4533
	       !rcu_lockdep_current_cpu_online()
			? "RCU used illegally from offline CPU!\n"
4534
			: !rcu_is_watching()
4535 4536 4537
				? "RCU used illegally from idle CPU!\n"
				: "",
	       rcu_scheduler_active, debug_locks);
4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556

	/*
	 * If a CPU is in the RCU-free window in idle (ie: in the section
	 * between rcu_idle_enter() and rcu_idle_exit(), then RCU
	 * considers that CPU to be in an "extended quiescent state",
	 * which means that RCU will be completely ignoring that CPU.
	 * Therefore, rcu_read_lock() and friends have absolutely no
	 * effect on a CPU running in that state. In other words, even if
	 * such an RCU-idle CPU has called rcu_read_lock(), RCU might well
	 * delete data structures out from under it.  RCU really has no
	 * choice here: we need to keep an RCU-free window in idle where
	 * the CPU may possibly enter into low power mode. This way we can
	 * notice an extended quiescent state to other CPUs that started a grace
	 * period. Otherwise we would delay any grace period as long as we run
	 * in the idle task.
	 *
	 * So complain bitterly if someone does call rcu_read_lock(),
	 * rcu_read_lock_bh() and so on from extended quiescent states.
	 */
4557
	if (!rcu_is_watching())
4558
		pr_warn("RCU used illegally from extended quiescent state!\n");
4559

4560
	lockdep_print_held_locks(curr);
4561
	pr_warn("\nstack backtrace:\n");
4562 4563
	dump_stack();
}
4564
EXPORT_SYMBOL_GPL(lockdep_rcu_suspicious);