]> Git Repo - linux.git/blame - kernel/locking/lockdep.c
treewide: Remove uninitialized_var() usage
[linux.git] / kernel / locking / lockdep.c
CommitLineData
457c8996 1// SPDX-License-Identifier: GPL-2.0-only
fbb9ce95
IM
2/*
3 * kernel/lockdep.c
4 *
5 * Runtime locking correctness validator
6 *
7 * Started by Ingo Molnar:
8 *
4b32d0a4 9 * Copyright (C) 2006,2007 Red Hat, Inc., Ingo Molnar <[email protected]>
90eec103 10 * Copyright (C) 2007 Red Hat, Inc., Peter Zijlstra
fbb9ce95
IM
11 *
12 * this code maps all the lock dependencies as they occur in a live kernel
13 * and will warn about the following classes of locking bugs:
14 *
15 * - lock inversion scenarios
16 * - circular lock dependencies
17 * - hardirq/softirq safe/unsafe locking bugs
18 *
19 * Bugs are reported even if the current locking scenario does not cause
20 * any deadlock at this point.
21 *
22 * I.e. if anytime in the past two locks were taken in a different order,
23 * even if it happened for another task, even if those were different
24 * locks (but of the same class as this lock), this code will detect it.
25 *
26 * Thanks to Arjan van de Ven for coming up with the initial idea of
27 * mapping lock dependencies runtime.
28 */
a5e25883 29#define DISABLE_BRANCH_PROFILING
fbb9ce95
IM
30#include <linux/mutex.h>
31#include <linux/sched.h>
e6017571 32#include <linux/sched/clock.h>
29930025 33#include <linux/sched/task.h>
6d7225f0 34#include <linux/sched/mm.h>
fbb9ce95
IM
35#include <linux/delay.h>
36#include <linux/module.h>
37#include <linux/proc_fs.h>
38#include <linux/seq_file.h>
39#include <linux/spinlock.h>
40#include <linux/kallsyms.h>
41#include <linux/interrupt.h>
42#include <linux/stacktrace.h>
43#include <linux/debug_locks.h>
44#include <linux/irqflags.h>
99de055a 45#include <linux/utsname.h>
4b32d0a4 46#include <linux/hash.h>
81d68a96 47#include <linux/ftrace.h>
b4b136f4 48#include <linux/stringify.h>
ace35a7a 49#include <linux/bitmap.h>
d588e461 50#include <linux/bitops.h>
5a0e3ad6 51#include <linux/gfp.h>
e7904a28 52#include <linux/random.h>
dfaaf3fa 53#include <linux/jhash.h>
88f1c87d 54#include <linux/nmi.h>
a0b0fd53 55#include <linux/rcupdate.h>
2f43c602 56#include <linux/kprobes.h>
af012961 57
fbb9ce95
IM
58#include <asm/sections.h>
59
60#include "lockdep_internals.h"
61
a8d154b0 62#define CREATE_TRACE_POINTS
67178767 63#include <trace/events/lock.h>
a8d154b0 64
f20786ff
PZ
65#ifdef CONFIG_PROVE_LOCKING
66int prove_locking = 1;
67module_param(prove_locking, int, 0644);
68#else
69#define prove_locking 0
70#endif
71
72#ifdef CONFIG_LOCK_STAT
73int lock_stat = 1;
74module_param(lock_stat, int, 0644);
75#else
76#define lock_stat 0
77#endif
78
fbb9ce95 79/*
74c383f1
IM
80 * lockdep_lock: protects the lockdep graph, the hashes and the
81 * class/list/hash allocators.
fbb9ce95
IM
82 *
83 * This is one of the rare exceptions where it's justified
84 * to use a raw spinlock - we really dont want the spinlock
74c383f1 85 * code to recurse back into the lockdep code...
fbb9ce95 86 */
248efb21
PZ
87static arch_spinlock_t __lock = (arch_spinlock_t)__ARCH_SPIN_LOCK_UNLOCKED;
88static struct task_struct *__owner;
89
90static inline void lockdep_lock(void)
91{
92 DEBUG_LOCKS_WARN_ON(!irqs_disabled());
93
94 arch_spin_lock(&__lock);
95 __owner = current;
96 current->lockdep_recursion++;
97}
98
99static inline void lockdep_unlock(void)
100{
101 if (debug_locks && DEBUG_LOCKS_WARN_ON(__owner != current))
102 return;
103
104 current->lockdep_recursion--;
105 __owner = NULL;
106 arch_spin_unlock(&__lock);
107}
108
109static inline bool lockdep_assert_locked(void)
110{
111 return DEBUG_LOCKS_WARN_ON(__owner != current);
112}
113
cdc84d79 114static struct task_struct *lockdep_selftest_task_struct;
74c383f1 115
248efb21 116
74c383f1
IM
117static int graph_lock(void)
118{
248efb21 119 lockdep_lock();
74c383f1
IM
120 /*
121 * Make sure that if another CPU detected a bug while
122 * walking the graph we dont change it (while the other
123 * CPU is busy printing out stuff with the graph lock
124 * dropped already)
125 */
126 if (!debug_locks) {
248efb21 127 lockdep_unlock();
74c383f1
IM
128 return 0;
129 }
130 return 1;
131}
132
248efb21 133static inline void graph_unlock(void)
74c383f1 134{
248efb21 135 lockdep_unlock();
74c383f1
IM
136}
137
138/*
139 * Turn lock debugging off and return with 0 if it was off already,
140 * and also release the graph lock:
141 */
142static inline int debug_locks_off_graph_unlock(void)
143{
144 int ret = debug_locks_off();
145
248efb21 146 lockdep_unlock();
74c383f1
IM
147
148 return ret;
149}
fbb9ce95 150
fbb9ce95 151unsigned long nr_list_entries;
af012961 152static struct lock_list list_entries[MAX_LOCKDEP_ENTRIES];
ace35a7a 153static DECLARE_BITMAP(list_entries_in_use, MAX_LOCKDEP_ENTRIES);
fbb9ce95 154
fbb9ce95
IM
155/*
156 * All data structures here are protected by the global debug_lock.
157 *
a0b0fd53
BVA
158 * nr_lock_classes is the number of elements of lock_classes[] that is
159 * in use.
fbb9ce95 160 */
108c1485
BVA
161#define KEYHASH_BITS (MAX_LOCKDEP_KEYS_BITS - 1)
162#define KEYHASH_SIZE (1UL << KEYHASH_BITS)
163static struct hlist_head lock_keys_hash[KEYHASH_SIZE];
fbb9ce95 164unsigned long nr_lock_classes;
1d44bcb4 165unsigned long nr_zapped_classes;
1431a5d2
BVA
166#ifndef CONFIG_DEBUG_LOCKDEP
167static
168#endif
8ca2b56c 169struct lock_class lock_classes[MAX_LOCKDEP_KEYS];
01bb6f0a 170static DECLARE_BITMAP(lock_classes_in_use, MAX_LOCKDEP_KEYS);
fbb9ce95 171
f82b217e
DJ
172static inline struct lock_class *hlock_class(struct held_lock *hlock)
173{
01bb6f0a
YD
174 unsigned int class_idx = hlock->class_idx;
175
176 /* Don't re-read hlock->class_idx, can't use READ_ONCE() on bitfield */
177 barrier();
178
179 if (!test_bit(class_idx, lock_classes_in_use)) {
0119fee4
PZ
180 /*
181 * Someone passed in garbage, we give up.
182 */
f82b217e
DJ
183 DEBUG_LOCKS_WARN_ON(1);
184 return NULL;
185 }
01bb6f0a
YD
186
187 /*
188 * At this point, if the passed hlock->class_idx is still garbage,
189 * we just have to live with it
190 */
191 return lock_classes + class_idx;
f82b217e
DJ
192}
193
f20786ff 194#ifdef CONFIG_LOCK_STAT
25528213 195static DEFINE_PER_CPU(struct lock_class_stats[MAX_LOCKDEP_KEYS], cpu_lock_stats);
f20786ff 196
3365e779
PZ
197static inline u64 lockstat_clock(void)
198{
c676329a 199 return local_clock();
3365e779
PZ
200}
201
c7e78cff 202static int lock_point(unsigned long points[], unsigned long ip)
f20786ff
PZ
203{
204 int i;
205
c7e78cff
PZ
206 for (i = 0; i < LOCKSTAT_POINTS; i++) {
207 if (points[i] == 0) {
208 points[i] = ip;
f20786ff
PZ
209 break;
210 }
c7e78cff 211 if (points[i] == ip)
f20786ff
PZ
212 break;
213 }
214
215 return i;
216}
217
3365e779 218static void lock_time_inc(struct lock_time *lt, u64 time)
f20786ff
PZ
219{
220 if (time > lt->max)
221 lt->max = time;
222
109d71c6 223 if (time < lt->min || !lt->nr)
f20786ff
PZ
224 lt->min = time;
225
226 lt->total += time;
227 lt->nr++;
228}
229
c46261de
PZ
230static inline void lock_time_add(struct lock_time *src, struct lock_time *dst)
231{
109d71c6
FR
232 if (!src->nr)
233 return;
234
235 if (src->max > dst->max)
236 dst->max = src->max;
237
238 if (src->min < dst->min || !dst->nr)
239 dst->min = src->min;
240
c46261de
PZ
241 dst->total += src->total;
242 dst->nr += src->nr;
243}
244
245struct lock_class_stats lock_stats(struct lock_class *class)
246{
247 struct lock_class_stats stats;
248 int cpu, i;
249
250 memset(&stats, 0, sizeof(struct lock_class_stats));
251 for_each_possible_cpu(cpu) {
252 struct lock_class_stats *pcs =
1871e52c 253 &per_cpu(cpu_lock_stats, cpu)[class - lock_classes];
c46261de
PZ
254
255 for (i = 0; i < ARRAY_SIZE(stats.contention_point); i++)
256 stats.contention_point[i] += pcs->contention_point[i];
257
c7e78cff
PZ
258 for (i = 0; i < ARRAY_SIZE(stats.contending_point); i++)
259 stats.contending_point[i] += pcs->contending_point[i];
260
c46261de
PZ
261 lock_time_add(&pcs->read_waittime, &stats.read_waittime);
262 lock_time_add(&pcs->write_waittime, &stats.write_waittime);
263
264 lock_time_add(&pcs->read_holdtime, &stats.read_holdtime);
265 lock_time_add(&pcs->write_holdtime, &stats.write_holdtime);
96645678
PZ
266
267 for (i = 0; i < ARRAY_SIZE(stats.bounces); i++)
268 stats.bounces[i] += pcs->bounces[i];
c46261de
PZ
269 }
270
271 return stats;
272}
273
274void clear_lock_stats(struct lock_class *class)
275{
276 int cpu;
277
278 for_each_possible_cpu(cpu) {
279 struct lock_class_stats *cpu_stats =
1871e52c 280 &per_cpu(cpu_lock_stats, cpu)[class - lock_classes];
c46261de
PZ
281
282 memset(cpu_stats, 0, sizeof(struct lock_class_stats));
283 }
284 memset(class->contention_point, 0, sizeof(class->contention_point));
c7e78cff 285 memset(class->contending_point, 0, sizeof(class->contending_point));
c46261de
PZ
286}
287
f20786ff
PZ
288static struct lock_class_stats *get_lock_stats(struct lock_class *class)
289{
01f38497 290 return &this_cpu_ptr(cpu_lock_stats)[class - lock_classes];
f20786ff
PZ
291}
292
293static void lock_release_holdtime(struct held_lock *hlock)
294{
295 struct lock_class_stats *stats;
3365e779 296 u64 holdtime;
f20786ff
PZ
297
298 if (!lock_stat)
299 return;
300
3365e779 301 holdtime = lockstat_clock() - hlock->holdtime_stamp;
f20786ff 302
f82b217e 303 stats = get_lock_stats(hlock_class(hlock));
f20786ff
PZ
304 if (hlock->read)
305 lock_time_inc(&stats->read_holdtime, holdtime);
306 else
307 lock_time_inc(&stats->write_holdtime, holdtime);
f20786ff
PZ
308}
309#else
310static inline void lock_release_holdtime(struct held_lock *hlock)
311{
312}
313#endif
314
fbb9ce95 315/*
a0b0fd53
BVA
316 * We keep a global list of all lock classes. The list is only accessed with
317 * the lockdep spinlock lock held. free_lock_classes is a list with free
318 * elements. These elements are linked together by the lock_entry member in
319 * struct lock_class.
fbb9ce95
IM
320 */
321LIST_HEAD(all_lock_classes);
a0b0fd53
BVA
322static LIST_HEAD(free_lock_classes);
323
324/**
325 * struct pending_free - information about data structures about to be freed
326 * @zapped: Head of a list with struct lock_class elements.
de4643a7
BVA
327 * @lock_chains_being_freed: Bitmap that indicates which lock_chains[] elements
328 * are about to be freed.
a0b0fd53
BVA
329 */
330struct pending_free {
331 struct list_head zapped;
de4643a7 332 DECLARE_BITMAP(lock_chains_being_freed, MAX_LOCKDEP_CHAINS);
a0b0fd53
BVA
333};
334
335/**
336 * struct delayed_free - data structures used for delayed freeing
337 *
338 * A data structure for delayed freeing of data structures that may be
339 * accessed by RCU readers at the time these were freed.
340 *
341 * @rcu_head: Used to schedule an RCU callback for freeing data structures.
342 * @index: Index of @pf to which freed data structures are added.
343 * @scheduled: Whether or not an RCU callback has been scheduled.
344 * @pf: Array with information about data structures about to be freed.
345 */
346static struct delayed_free {
347 struct rcu_head rcu_head;
348 int index;
349 int scheduled;
350 struct pending_free pf[2];
351} delayed_free;
fbb9ce95
IM
352
353/*
354 * The lockdep classes are in a hash-table as well, for fast lookup:
355 */
356#define CLASSHASH_BITS (MAX_LOCKDEP_KEYS_BITS - 1)
357#define CLASSHASH_SIZE (1UL << CLASSHASH_BITS)
4b32d0a4 358#define __classhashfn(key) hash_long((unsigned long)key, CLASSHASH_BITS)
fbb9ce95
IM
359#define classhashentry(key) (classhash_table + __classhashfn((key)))
360
a63f38cc 361static struct hlist_head classhash_table[CLASSHASH_SIZE];
fbb9ce95 362
fbb9ce95
IM
363/*
364 * We put the lock dependency chains into a hash-table as well, to cache
365 * their existence:
366 */
367#define CHAINHASH_BITS (MAX_LOCKDEP_CHAINS_BITS-1)
368#define CHAINHASH_SIZE (1UL << CHAINHASH_BITS)
4b32d0a4 369#define __chainhashfn(chain) hash_long(chain, CHAINHASH_BITS)
fbb9ce95
IM
370#define chainhashentry(chain) (chainhash_table + __chainhashfn((chain)))
371
a63f38cc 372static struct hlist_head chainhash_table[CHAINHASH_SIZE];
fbb9ce95
IM
373
374/*
375 * The hash key of the lock dependency chains is a hash itself too:
376 * it's a hash of all locks taken up to that lock, including that lock.
377 * It's a 64-bit hash, because it's important for the keys to be
378 * unique.
379 */
dfaaf3fa
PZ
380static inline u64 iterate_chain_key(u64 key, u32 idx)
381{
382 u32 k0 = key, k1 = key >> 32;
383
384 __jhash_mix(idx, k0, k1); /* Macro that modifies arguments! */
385
386 return k0 | (u64)k1 << 32;
387}
fbb9ce95 388
e196e479
YD
389void lockdep_init_task(struct task_struct *task)
390{
391 task->lockdep_depth = 0; /* no locks held yet */
f6ec8829 392 task->curr_chain_key = INITIAL_CHAIN_KEY;
e196e479
YD
393 task->lockdep_recursion = 0;
394}
395
6eebad1a 396static __always_inline void lockdep_recursion_finish(void)
10476e63
PZ
397{
398 if (WARN_ON_ONCE(--current->lockdep_recursion))
399 current->lockdep_recursion = 0;
400}
401
cdc84d79
BVA
402void lockdep_set_selftest_task(struct task_struct *task)
403{
404 lockdep_selftest_task_struct = task;
405}
406
fbb9ce95
IM
407/*
408 * Debugging switches:
409 */
410
411#define VERBOSE 0
33e94e96 412#define VERY_VERBOSE 0
fbb9ce95
IM
413
414#if VERBOSE
415# define HARDIRQ_VERBOSE 1
416# define SOFTIRQ_VERBOSE 1
417#else
418# define HARDIRQ_VERBOSE 0
419# define SOFTIRQ_VERBOSE 0
420#endif
421
d92a8cfc 422#if VERBOSE || HARDIRQ_VERBOSE || SOFTIRQ_VERBOSE
fbb9ce95
IM
423/*
424 * Quick filtering for interesting events:
425 */
426static int class_filter(struct lock_class *class)
427{
f9829cce
AK
428#if 0
429 /* Example */
fbb9ce95 430 if (class->name_version == 1 &&
f9829cce 431 !strcmp(class->name, "lockname"))
fbb9ce95
IM
432 return 1;
433 if (class->name_version == 1 &&
f9829cce 434 !strcmp(class->name, "&struct->lockfield"))
fbb9ce95 435 return 1;
f9829cce 436#endif
a6640897
IM
437 /* Filter everything else. 1 would be to allow everything else */
438 return 0;
fbb9ce95
IM
439}
440#endif
441
442static int verbose(struct lock_class *class)
443{
444#if VERBOSE
445 return class_filter(class);
446#endif
447 return 0;
448}
449
2c522836
DJ
450static void print_lockdep_off(const char *bug_msg)
451{
452 printk(KERN_DEBUG "%s\n", bug_msg);
453 printk(KERN_DEBUG "turning off the locking correctness validator.\n");
acf59377 454#ifdef CONFIG_LOCK_STAT
2c522836 455 printk(KERN_DEBUG "Please attach the output of /proc/lock_stat to the bug report\n");
acf59377 456#endif
2c522836
DJ
457}
458
886532ae
AB
459unsigned long nr_stack_trace_entries;
460
30a35f79 461#ifdef CONFIG_PROVE_LOCKING
12593b74
BVA
462/**
463 * struct lock_trace - single stack backtrace
464 * @hash_entry: Entry in a stack_trace_hash[] list.
465 * @hash: jhash() of @entries.
466 * @nr_entries: Number of entries in @entries.
467 * @entries: Actual stack backtrace.
468 */
469struct lock_trace {
470 struct hlist_node hash_entry;
471 u32 hash;
472 u32 nr_entries;
db78538c 473 unsigned long entries[] __aligned(sizeof(unsigned long));
12593b74
BVA
474};
475#define LOCK_TRACE_SIZE_IN_LONGS \
476 (sizeof(struct lock_trace) / sizeof(unsigned long))
886532ae 477/*
12593b74 478 * Stack-trace: sequence of lock_trace structures. Protected by the graph_lock.
886532ae
AB
479 */
480static unsigned long stack_trace[MAX_STACK_TRACE_ENTRIES];
12593b74
BVA
481static struct hlist_head stack_trace_hash[STACK_TRACE_HASH_SIZE];
482
483static bool traces_identical(struct lock_trace *t1, struct lock_trace *t2)
484{
485 return t1->hash == t2->hash && t1->nr_entries == t2->nr_entries &&
486 memcmp(t1->entries, t2->entries,
487 t1->nr_entries * sizeof(t1->entries[0])) == 0;
488}
886532ae 489
12593b74 490static struct lock_trace *save_trace(void)
fbb9ce95 491{
12593b74
BVA
492 struct lock_trace *trace, *t2;
493 struct hlist_head *hash_head;
494 u32 hash;
d91f3057 495 int max_entries;
fbb9ce95 496
12593b74
BVA
497 BUILD_BUG_ON_NOT_POWER_OF_2(STACK_TRACE_HASH_SIZE);
498 BUILD_BUG_ON(LOCK_TRACE_SIZE_IN_LONGS >= MAX_STACK_TRACE_ENTRIES);
499
500 trace = (struct lock_trace *)(stack_trace + nr_stack_trace_entries);
501 max_entries = MAX_STACK_TRACE_ENTRIES - nr_stack_trace_entries -
502 LOCK_TRACE_SIZE_IN_LONGS;
fbb9ce95 503
d91f3057 504 if (max_entries <= 0) {
74c383f1 505 if (!debug_locks_off_graph_unlock())
12593b74 506 return NULL;
74c383f1 507
2c522836 508 print_lockdep_off("BUG: MAX_STACK_TRACE_ENTRIES too low!");
74c383f1
IM
509 dump_stack();
510
12593b74 511 return NULL;
fbb9ce95 512 }
d91f3057 513 trace->nr_entries = stack_trace_save(trace->entries, max_entries, 3);
fbb9ce95 514
12593b74
BVA
515 hash = jhash(trace->entries, trace->nr_entries *
516 sizeof(trace->entries[0]), 0);
517 trace->hash = hash;
518 hash_head = stack_trace_hash + (hash & (STACK_TRACE_HASH_SIZE - 1));
519 hlist_for_each_entry(t2, hash_head, hash_entry) {
520 if (traces_identical(trace, t2))
521 return t2;
522 }
523 nr_stack_trace_entries += LOCK_TRACE_SIZE_IN_LONGS + trace->nr_entries;
524 hlist_add_head(&trace->hash_entry, hash_head);
525
526 return trace;
fbb9ce95 527}
8c779229
BVA
528
529/* Return the number of stack traces in the stack_trace[] array. */
530u64 lockdep_stack_trace_count(void)
531{
532 struct lock_trace *trace;
533 u64 c = 0;
534 int i;
535
536 for (i = 0; i < ARRAY_SIZE(stack_trace_hash); i++) {
537 hlist_for_each_entry(trace, &stack_trace_hash[i], hash_entry) {
538 c++;
539 }
540 }
541
542 return c;
543}
544
545/* Return the number of stack hash chains that have at least one stack trace. */
546u64 lockdep_stack_hash_count(void)
547{
548 u64 c = 0;
549 int i;
550
551 for (i = 0; i < ARRAY_SIZE(stack_trace_hash); i++)
552 if (!hlist_empty(&stack_trace_hash[i]))
553 c++;
554
555 return c;
fbb9ce95 556}
886532ae 557#endif
fbb9ce95
IM
558
559unsigned int nr_hardirq_chains;
560unsigned int nr_softirq_chains;
561unsigned int nr_process_chains;
562unsigned int max_lockdep_depth;
fbb9ce95
IM
563
564#ifdef CONFIG_DEBUG_LOCKDEP
fbb9ce95
IM
565/*
566 * Various lockdep statistics:
567 */
bd6d29c2 568DEFINE_PER_CPU(struct lockdep_stats, lockdep_stats);
fbb9ce95
IM
569#endif
570
30a35f79 571#ifdef CONFIG_PROVE_LOCKING
fbb9ce95
IM
572/*
573 * Locking printouts:
574 */
575
fabe9c42 576#define __USAGE(__STATE) \
b4b136f4
PZ
577 [LOCK_USED_IN_##__STATE] = "IN-"__stringify(__STATE)"-W", \
578 [LOCK_ENABLED_##__STATE] = __stringify(__STATE)"-ON-W", \
579 [LOCK_USED_IN_##__STATE##_READ] = "IN-"__stringify(__STATE)"-R",\
580 [LOCK_ENABLED_##__STATE##_READ] = __stringify(__STATE)"-ON-R",
fabe9c42 581
fbb9ce95
IM
582static const char *usage_str[] =
583{
fabe9c42
PZ
584#define LOCKDEP_STATE(__STATE) __USAGE(__STATE)
585#include "lockdep_states.h"
586#undef LOCKDEP_STATE
587 [LOCK_USED] = "INITIAL USE",
f6f48e18 588 [LOCK_USAGE_STATES] = "IN-NMI",
fbb9ce95 589};
886532ae 590#endif
fbb9ce95 591
364f6afc 592const char *__get_key_name(const struct lockdep_subclass_key *key, char *str)
fbb9ce95 593{
ffb45122 594 return kallsyms_lookup((unsigned long)key, NULL, NULL, NULL, str);
fbb9ce95
IM
595}
596
3ff176ca 597static inline unsigned long lock_flag(enum lock_usage_bit bit)
fbb9ce95 598{
3ff176ca
PZ
599 return 1UL << bit;
600}
fbb9ce95 601
3ff176ca
PZ
602static char get_usage_char(struct lock_class *class, enum lock_usage_bit bit)
603{
c52478f4
YD
604 /*
605 * The usage character defaults to '.' (i.e., irqs disabled and not in
606 * irq context), which is the safest usage category.
607 */
3ff176ca
PZ
608 char c = '.';
609
c52478f4
YD
610 /*
611 * The order of the following usage checks matters, which will
612 * result in the outcome character as follows:
613 *
614 * - '+': irq is enabled and not in irq context
615 * - '-': in irq context and irq is disabled
616 * - '?': in irq context and irq is enabled
617 */
618 if (class->usage_mask & lock_flag(bit + LOCK_USAGE_DIR_MASK)) {
3ff176ca 619 c = '+';
c52478f4 620 if (class->usage_mask & lock_flag(bit))
3ff176ca 621 c = '?';
c52478f4
YD
622 } else if (class->usage_mask & lock_flag(bit))
623 c = '-';
fbb9ce95 624
3ff176ca
PZ
625 return c;
626}
cf40bd16 627
f510b233 628void get_usage_chars(struct lock_class *class, char usage[LOCK_USAGE_CHARS])
3ff176ca 629{
f510b233 630 int i = 0;
cf40bd16 631
f510b233
PZ
632#define LOCKDEP_STATE(__STATE) \
633 usage[i++] = get_usage_char(class, LOCK_USED_IN_##__STATE); \
634 usage[i++] = get_usage_char(class, LOCK_USED_IN_##__STATE##_READ);
635#include "lockdep_states.h"
636#undef LOCKDEP_STATE
637
638 usage[i] = '\0';
fbb9ce95
IM
639}
640
e5e78d08 641static void __print_lock_name(struct lock_class *class)
3003eba3
SR
642{
643 char str[KSYM_NAME_LEN];
644 const char *name;
645
fbb9ce95
IM
646 name = class->name;
647 if (!name) {
648 name = __get_key_name(class->key, str);
f943fe0f 649 printk(KERN_CONT "%s", name);
fbb9ce95 650 } else {
f943fe0f 651 printk(KERN_CONT "%s", name);
fbb9ce95 652 if (class->name_version > 1)
f943fe0f 653 printk(KERN_CONT "#%d", class->name_version);
fbb9ce95 654 if (class->subclass)
f943fe0f 655 printk(KERN_CONT "/%d", class->subclass);
fbb9ce95 656 }
e5e78d08
SR
657}
658
659static void print_lock_name(struct lock_class *class)
660{
661 char usage[LOCK_USAGE_CHARS];
662
663 get_usage_chars(class, usage);
664
f943fe0f 665 printk(KERN_CONT " (");
e5e78d08 666 __print_lock_name(class);
de8f5e4f
PZ
667 printk(KERN_CONT "){%s}-{%hd:%hd}", usage,
668 class->wait_type_outer ?: class->wait_type_inner,
669 class->wait_type_inner);
fbb9ce95
IM
670}
671
672static void print_lockdep_cache(struct lockdep_map *lock)
673{
674 const char *name;
9281acea 675 char str[KSYM_NAME_LEN];
fbb9ce95
IM
676
677 name = lock->name;
678 if (!name)
679 name = __get_key_name(lock->key->subkeys, str);
680
f943fe0f 681 printk(KERN_CONT "%s", name);
fbb9ce95
IM
682}
683
684static void print_lock(struct held_lock *hlock)
685{
d7bc3197
PZ
686 /*
687 * We can be called locklessly through debug_show_all_locks() so be
688 * extra careful, the hlock might have been released and cleared.
01bb6f0a
YD
689 *
690 * If this indeed happens, lets pretend it does not hurt to continue
691 * to print the lock unless the hlock class_idx does not point to a
692 * registered class. The rationale here is: since we don't attempt
693 * to distinguish whether we are in this situation, if it just
694 * happened we can't count on class_idx to tell either.
d7bc3197 695 */
01bb6f0a 696 struct lock_class *lock = hlock_class(hlock);
d7bc3197 697
01bb6f0a 698 if (!lock) {
f943fe0f 699 printk(KERN_CONT "<RELEASED>\n");
d7bc3197
PZ
700 return;
701 }
702
519248f3 703 printk(KERN_CONT "%px", hlock->instance);
01bb6f0a 704 print_lock_name(lock);
b3c39758 705 printk(KERN_CONT ", at: %pS\n", (void *)hlock->acquire_ip);
fbb9ce95
IM
706}
707
8cc05c71 708static void lockdep_print_held_locks(struct task_struct *p)
fbb9ce95 709{
8cc05c71 710 int i, depth = READ_ONCE(p->lockdep_depth);
fbb9ce95 711
8cc05c71
TH
712 if (!depth)
713 printk("no locks held by %s/%d.\n", p->comm, task_pid_nr(p));
714 else
715 printk("%d lock%s held by %s/%d:\n", depth,
716 depth > 1 ? "s" : "", p->comm, task_pid_nr(p));
717 /*
718 * It's not reliable to print a task's held locks if it's not sleeping
719 * and it's not the current task.
720 */
721 if (p->state == TASK_RUNNING && p != current)
fbb9ce95 722 return;
fbb9ce95
IM
723 for (i = 0; i < depth; i++) {
724 printk(" #%d: ", i);
8cc05c71 725 print_lock(p->held_locks + i);
fbb9ce95
IM
726 }
727}
fbb9ce95 728
fbdc4b9a 729static void print_kernel_ident(void)
8e18257d 730{
fbdc4b9a 731 printk("%s %.*s %s\n", init_utsname()->release,
8e18257d 732 (int)strcspn(init_utsname()->version, " "),
fbdc4b9a
BH
733 init_utsname()->version,
734 print_tainted());
8e18257d
PZ
735}
736
737static int very_verbose(struct lock_class *class)
738{
739#if VERY_VERBOSE
740 return class_filter(class);
741#endif
742 return 0;
743}
744
fbb9ce95 745/*
8e18257d 746 * Is this the address of a static object:
fbb9ce95 747 */
8dce7a9a 748#ifdef __KERNEL__
108c1485 749static int static_obj(const void *obj)
fbb9ce95 750{
8e18257d
PZ
751 unsigned long start = (unsigned long) &_stext,
752 end = (unsigned long) &_end,
753 addr = (unsigned long) obj;
8e18257d 754
7a5da02d
GS
755 if (arch_is_kernel_initmem_freed(addr))
756 return 0;
757
fbb9ce95 758 /*
8e18257d 759 * static variable?
fbb9ce95 760 */
8e18257d
PZ
761 if ((addr >= start) && (addr < end))
762 return 1;
fbb9ce95 763
2a9ad18d
MF
764 if (arch_is_kernel_data(addr))
765 return 1;
766
fbb9ce95 767 /*
10fad5e4 768 * in-kernel percpu var?
fbb9ce95 769 */
10fad5e4
TH
770 if (is_kernel_percpu_address(addr))
771 return 1;
fbb9ce95 772
8e18257d 773 /*
10fad5e4 774 * module static or percpu var?
8e18257d 775 */
10fad5e4 776 return is_module_address(addr) || is_module_percpu_address(addr);
99de055a 777}
8dce7a9a 778#endif
99de055a 779
fbb9ce95 780/*
8e18257d 781 * To make lock name printouts unique, we calculate a unique
fe27b0de
BVA
782 * class->name_version generation counter. The caller must hold the graph
783 * lock.
fbb9ce95 784 */
8e18257d 785static int count_matching_names(struct lock_class *new_class)
fbb9ce95 786{
8e18257d
PZ
787 struct lock_class *class;
788 int count = 0;
fbb9ce95 789
8e18257d 790 if (!new_class->name)
fbb9ce95
IM
791 return 0;
792
fe27b0de 793 list_for_each_entry(class, &all_lock_classes, lock_entry) {
8e18257d
PZ
794 if (new_class->key - new_class->subclass == class->key)
795 return class->name_version;
796 if (class->name && !strcmp(class->name, new_class->name))
797 count = max(count, class->name_version);
798 }
fbb9ce95 799
8e18257d 800 return count + 1;
fbb9ce95
IM
801}
802
f6f48e18 803/* used from NMI context -- must be lockless */
6eebad1a 804static __always_inline struct lock_class *
08f36ff6 805look_up_lock_class(const struct lockdep_map *lock, unsigned int subclass)
fbb9ce95 806{
8e18257d 807 struct lockdep_subclass_key *key;
a63f38cc 808 struct hlist_head *hash_head;
8e18257d 809 struct lock_class *class;
fbb9ce95 810
4ba053c0
HM
811 if (unlikely(subclass >= MAX_LOCKDEP_SUBCLASSES)) {
812 debug_locks_off();
813 printk(KERN_ERR
814 "BUG: looking up invalid subclass: %u\n", subclass);
815 printk(KERN_ERR
816 "turning off the locking correctness validator.\n");
817 dump_stack();
818 return NULL;
819 }
820
8e18257d 821 /*
64f29d1b
MW
822 * If it is not initialised then it has never been locked,
823 * so it won't be present in the hash table.
8e18257d 824 */
64f29d1b
MW
825 if (unlikely(!lock->key))
826 return NULL;
fbb9ce95 827
8e18257d
PZ
828 /*
829 * NOTE: the class-key must be unique. For dynamic locks, a static
830 * lock_class_key variable is passed in through the mutex_init()
831 * (or spin_lock_init()) call - which acts as the key. For static
832 * locks we use the lock object itself as the key.
833 */
4b32d0a4
PZ
834 BUILD_BUG_ON(sizeof(struct lock_class_key) >
835 sizeof(struct lockdep_map));
fbb9ce95 836
8e18257d 837 key = lock->key->subkeys + subclass;
ca268c69 838
8e18257d 839 hash_head = classhashentry(key);
74c383f1 840
8e18257d 841 /*
35a9393c 842 * We do an RCU walk of the hash, see lockdep_free_key_range().
8e18257d 843 */
35a9393c
PZ
844 if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
845 return NULL;
846
a63f38cc 847 hlist_for_each_entry_rcu(class, hash_head, hash_entry) {
4b32d0a4 848 if (class->key == key) {
0119fee4
PZ
849 /*
850 * Huh! same key, different name? Did someone trample
851 * on some memory? We're most confused.
852 */
97831546
SAS
853 WARN_ON_ONCE(class->name != lock->name &&
854 lock->key != &__lockdep_no_validate__);
8e18257d 855 return class;
4b32d0a4
PZ
856 }
857 }
fbb9ce95 858
64f29d1b
MW
859 return NULL;
860}
861
862/*
863 * Static locks do not have their class-keys yet - for them the key is
864 * the lock object itself. If the lock is in the per cpu area, the
865 * canonical address of the lock (per cpu offset removed) is used.
866 */
867static bool assign_lock_key(struct lockdep_map *lock)
868{
869 unsigned long can_addr, addr = (unsigned long)lock;
870
4bf50862
BVA
871#ifdef __KERNEL__
872 /*
873 * lockdep_free_key_range() assumes that struct lock_class_key
874 * objects do not overlap. Since we use the address of lock
875 * objects as class key for static objects, check whether the
876 * size of lock_class_key objects does not exceed the size of
877 * the smallest lock object.
878 */
879 BUILD_BUG_ON(sizeof(struct lock_class_key) > sizeof(raw_spinlock_t));
880#endif
881
64f29d1b
MW
882 if (__is_kernel_percpu_address(addr, &can_addr))
883 lock->key = (void *)can_addr;
884 else if (__is_module_percpu_address(addr, &can_addr))
885 lock->key = (void *)can_addr;
886 else if (static_obj(lock))
887 lock->key = (void *)lock;
888 else {
889 /* Debug-check: all keys must be persistent! */
890 debug_locks_off();
891 pr_err("INFO: trying to register non-static key.\n");
892 pr_err("the code is fine but needs lockdep annotation.\n");
893 pr_err("turning off the locking correctness validator.\n");
894 dump_stack();
895 return false;
896 }
897
898 return true;
fbb9ce95
IM
899}
900
72dcd505
PZ
901#ifdef CONFIG_DEBUG_LOCKDEP
902
b526b2e3
BVA
903/* Check whether element @e occurs in list @h */
904static bool in_list(struct list_head *e, struct list_head *h)
905{
906 struct list_head *f;
907
908 list_for_each(f, h) {
909 if (e == f)
910 return true;
911 }
912
913 return false;
914}
915
916/*
917 * Check whether entry @e occurs in any of the locks_after or locks_before
918 * lists.
919 */
920static bool in_any_class_list(struct list_head *e)
921{
922 struct lock_class *class;
923 int i;
924
925 for (i = 0; i < ARRAY_SIZE(lock_classes); i++) {
926 class = &lock_classes[i];
927 if (in_list(e, &class->locks_after) ||
928 in_list(e, &class->locks_before))
929 return true;
930 }
931 return false;
932}
933
934static bool class_lock_list_valid(struct lock_class *c, struct list_head *h)
935{
936 struct lock_list *e;
937
938 list_for_each_entry(e, h, entry) {
939 if (e->links_to != c) {
940 printk(KERN_INFO "class %s: mismatch for lock entry %ld; class %s <> %s",
941 c->name ? : "(?)",
942 (unsigned long)(e - list_entries),
943 e->links_to && e->links_to->name ?
944 e->links_to->name : "(?)",
945 e->class && e->class->name ? e->class->name :
946 "(?)");
947 return false;
948 }
949 }
950 return true;
951}
952
3fe7522f
AB
953#ifdef CONFIG_PROVE_LOCKING
954static u16 chain_hlocks[MAX_LOCKDEP_CHAIN_HLOCKS];
955#endif
b526b2e3
BVA
956
957static bool check_lock_chain_key(struct lock_chain *chain)
958{
959#ifdef CONFIG_PROVE_LOCKING
f6ec8829 960 u64 chain_key = INITIAL_CHAIN_KEY;
b526b2e3
BVA
961 int i;
962
963 for (i = chain->base; i < chain->base + chain->depth; i++)
01bb6f0a 964 chain_key = iterate_chain_key(chain_key, chain_hlocks[i]);
b526b2e3
BVA
965 /*
966 * The 'unsigned long long' casts avoid that a compiler warning
967 * is reported when building tools/lib/lockdep.
968 */
72dcd505 969 if (chain->chain_key != chain_key) {
b526b2e3
BVA
970 printk(KERN_INFO "chain %lld: key %#llx <> %#llx\n",
971 (unsigned long long)(chain - lock_chains),
972 (unsigned long long)chain->chain_key,
973 (unsigned long long)chain_key);
72dcd505
PZ
974 return false;
975 }
b526b2e3 976#endif
72dcd505 977 return true;
b526b2e3
BVA
978}
979
980static bool in_any_zapped_class_list(struct lock_class *class)
981{
982 struct pending_free *pf;
983 int i;
984
72dcd505 985 for (i = 0, pf = delayed_free.pf; i < ARRAY_SIZE(delayed_free.pf); i++, pf++) {
b526b2e3
BVA
986 if (in_list(&class->lock_entry, &pf->zapped))
987 return true;
72dcd505 988 }
b526b2e3
BVA
989
990 return false;
991}
992
72dcd505 993static bool __check_data_structures(void)
b526b2e3
BVA
994{
995 struct lock_class *class;
996 struct lock_chain *chain;
997 struct hlist_head *head;
998 struct lock_list *e;
999 int i;
1000
1001 /* Check whether all classes occur in a lock list. */
1002 for (i = 0; i < ARRAY_SIZE(lock_classes); i++) {
1003 class = &lock_classes[i];
1004 if (!in_list(&class->lock_entry, &all_lock_classes) &&
1005 !in_list(&class->lock_entry, &free_lock_classes) &&
1006 !in_any_zapped_class_list(class)) {
1007 printk(KERN_INFO "class %px/%s is not in any class list\n",
1008 class, class->name ? : "(?)");
1009 return false;
b526b2e3
BVA
1010 }
1011 }
1012
1013 /* Check whether all classes have valid lock lists. */
1014 for (i = 0; i < ARRAY_SIZE(lock_classes); i++) {
1015 class = &lock_classes[i];
1016 if (!class_lock_list_valid(class, &class->locks_before))
1017 return false;
1018 if (!class_lock_list_valid(class, &class->locks_after))
1019 return false;
1020 }
1021
1022 /* Check the chain_key of all lock chains. */
1023 for (i = 0; i < ARRAY_SIZE(chainhash_table); i++) {
1024 head = chainhash_table + i;
1025 hlist_for_each_entry_rcu(chain, head, entry) {
1026 if (!check_lock_chain_key(chain))
1027 return false;
1028 }
1029 }
1030
1031 /*
1032 * Check whether all list entries that are in use occur in a class
1033 * lock list.
1034 */
1035 for_each_set_bit(i, list_entries_in_use, ARRAY_SIZE(list_entries)) {
1036 e = list_entries + i;
1037 if (!in_any_class_list(&e->entry)) {
1038 printk(KERN_INFO "list entry %d is not in any class list; class %s <> %s\n",
1039 (unsigned int)(e - list_entries),
1040 e->class->name ? : "(?)",
1041 e->links_to->name ? : "(?)");
1042 return false;
1043 }
1044 }
1045
1046 /*
1047 * Check whether all list entries that are not in use do not occur in
1048 * a class lock list.
1049 */
1050 for_each_clear_bit(i, list_entries_in_use, ARRAY_SIZE(list_entries)) {
1051 e = list_entries + i;
1052 if (in_any_class_list(&e->entry)) {
1053 printk(KERN_INFO "list entry %d occurs in a class list; class %s <> %s\n",
1054 (unsigned int)(e - list_entries),
1055 e->class && e->class->name ? e->class->name :
1056 "(?)",
1057 e->links_to && e->links_to->name ?
1058 e->links_to->name : "(?)");
1059 return false;
1060 }
1061 }
1062
1063 return true;
1064}
1065
72dcd505
PZ
1066int check_consistency = 0;
1067module_param(check_consistency, int, 0644);
1068
1069static void check_data_structures(void)
1070{
1071 static bool once = false;
1072
1073 if (check_consistency && !once) {
1074 if (!__check_data_structures()) {
1075 once = true;
1076 WARN_ON(once);
1077 }
1078 }
1079}
1080
1081#else /* CONFIG_DEBUG_LOCKDEP */
1082
1083static inline void check_data_structures(void) { }
1084
1085#endif /* CONFIG_DEBUG_LOCKDEP */
1086
810507fe
WL
1087static void init_chain_block_buckets(void);
1088
feb0a386 1089/*
a0b0fd53
BVA
1090 * Initialize the lock_classes[] array elements, the free_lock_classes list
1091 * and also the delayed_free structure.
feb0a386
BVA
1092 */
1093static void init_data_structures_once(void)
1094{
810507fe 1095 static bool __read_mostly ds_initialized, rcu_head_initialized;
feb0a386
BVA
1096 int i;
1097
0126574f 1098 if (likely(rcu_head_initialized))
feb0a386
BVA
1099 return;
1100
0126574f
BVA
1101 if (system_state >= SYSTEM_SCHEDULING) {
1102 init_rcu_head(&delayed_free.rcu_head);
1103 rcu_head_initialized = true;
1104 }
1105
1106 if (ds_initialized)
1107 return;
1108
1109 ds_initialized = true;
feb0a386 1110
a0b0fd53
BVA
1111 INIT_LIST_HEAD(&delayed_free.pf[0].zapped);
1112 INIT_LIST_HEAD(&delayed_free.pf[1].zapped);
1113
feb0a386 1114 for (i = 0; i < ARRAY_SIZE(lock_classes); i++) {
a0b0fd53 1115 list_add_tail(&lock_classes[i].lock_entry, &free_lock_classes);
feb0a386
BVA
1116 INIT_LIST_HEAD(&lock_classes[i].locks_after);
1117 INIT_LIST_HEAD(&lock_classes[i].locks_before);
1118 }
810507fe 1119 init_chain_block_buckets();
feb0a386
BVA
1120}
1121
108c1485
BVA
1122static inline struct hlist_head *keyhashentry(const struct lock_class_key *key)
1123{
1124 unsigned long hash = hash_long((uintptr_t)key, KEYHASH_BITS);
1125
1126 return lock_keys_hash + hash;
1127}
1128
1129/* Register a dynamically allocated key. */
1130void lockdep_register_key(struct lock_class_key *key)
1131{
1132 struct hlist_head *hash_head;
1133 struct lock_class_key *k;
1134 unsigned long flags;
1135
1136 if (WARN_ON_ONCE(static_obj(key)))
1137 return;
1138 hash_head = keyhashentry(key);
1139
1140 raw_local_irq_save(flags);
1141 if (!graph_lock())
1142 goto restore_irqs;
1143 hlist_for_each_entry_rcu(k, hash_head, hash_entry) {
1144 if (WARN_ON_ONCE(k == key))
1145 goto out_unlock;
1146 }
1147 hlist_add_head_rcu(&key->hash_entry, hash_head);
1148out_unlock:
1149 graph_unlock();
1150restore_irqs:
1151 raw_local_irq_restore(flags);
1152}
1153EXPORT_SYMBOL_GPL(lockdep_register_key);
1154
1155/* Check whether a key has been registered as a dynamic key. */
1156static bool is_dynamic_key(const struct lock_class_key *key)
1157{
1158 struct hlist_head *hash_head;
1159 struct lock_class_key *k;
1160 bool found = false;
1161
1162 if (WARN_ON_ONCE(static_obj(key)))
1163 return false;
1164
1165 /*
1166 * If lock debugging is disabled lock_keys_hash[] may contain
1167 * pointers to memory that has already been freed. Avoid triggering
1168 * a use-after-free in that case by returning early.
1169 */
1170 if (!debug_locks)
1171 return true;
1172
1173 hash_head = keyhashentry(key);
1174
1175 rcu_read_lock();
1176 hlist_for_each_entry_rcu(k, hash_head, hash_entry) {
1177 if (k == key) {
1178 found = true;
1179 break;
1180 }
1181 }
1182 rcu_read_unlock();
1183
1184 return found;
1185}
1186
fbb9ce95 1187/*
8e18257d
PZ
1188 * Register a lock's class in the hash-table, if the class is not present
1189 * yet. Otherwise we look it up. We cache the result in the lock object
1190 * itself, so actual lookup of the hash should be once per lock object.
fbb9ce95 1191 */
c003ed92 1192static struct lock_class *
8e18257d 1193register_lock_class(struct lockdep_map *lock, unsigned int subclass, int force)
fbb9ce95 1194{
8e18257d 1195 struct lockdep_subclass_key *key;
a63f38cc 1196 struct hlist_head *hash_head;
8e18257d 1197 struct lock_class *class;
35a9393c
PZ
1198
1199 DEBUG_LOCKS_WARN_ON(!irqs_disabled());
8e18257d
PZ
1200
1201 class = look_up_lock_class(lock, subclass);
64f29d1b 1202 if (likely(class))
87cdee71 1203 goto out_set_class_cache;
8e18257d 1204
64f29d1b
MW
1205 if (!lock->key) {
1206 if (!assign_lock_key(lock))
1207 return NULL;
108c1485 1208 } else if (!static_obj(lock->key) && !is_dynamic_key(lock->key)) {
8e18257d
PZ
1209 return NULL;
1210 }
1211
1212 key = lock->key->subkeys + subclass;
1213 hash_head = classhashentry(key);
1214
8e18257d 1215 if (!graph_lock()) {
8e18257d
PZ
1216 return NULL;
1217 }
1218 /*
1219 * We have to do the hash-walk again, to avoid races
1220 * with another CPU:
1221 */
a63f38cc 1222 hlist_for_each_entry_rcu(class, hash_head, hash_entry) {
8e18257d
PZ
1223 if (class->key == key)
1224 goto out_unlock_set;
35a9393c
PZ
1225 }
1226
feb0a386
BVA
1227 init_data_structures_once();
1228
a0b0fd53
BVA
1229 /* Allocate a new lock class and add it to the hash. */
1230 class = list_first_entry_or_null(&free_lock_classes, typeof(*class),
1231 lock_entry);
1232 if (!class) {
8e18257d 1233 if (!debug_locks_off_graph_unlock()) {
8e18257d
PZ
1234 return NULL;
1235 }
8e18257d 1236
2c522836 1237 print_lockdep_off("BUG: MAX_LOCKDEP_KEYS too low!");
eedeeabd 1238 dump_stack();
8e18257d
PZ
1239 return NULL;
1240 }
a0b0fd53 1241 nr_lock_classes++;
01bb6f0a 1242 __set_bit(class - lock_classes, lock_classes_in_use);
bd6d29c2 1243 debug_atomic_inc(nr_unused_locks);
8e18257d
PZ
1244 class->key = key;
1245 class->name = lock->name;
1246 class->subclass = subclass;
feb0a386
BVA
1247 WARN_ON_ONCE(!list_empty(&class->locks_before));
1248 WARN_ON_ONCE(!list_empty(&class->locks_after));
8e18257d 1249 class->name_version = count_matching_names(class);
de8f5e4f
PZ
1250 class->wait_type_inner = lock->wait_type_inner;
1251 class->wait_type_outer = lock->wait_type_outer;
8e18257d
PZ
1252 /*
1253 * We use RCU's safe list-add method to make
1254 * parallel walking of the hash-list safe:
1255 */
a63f38cc 1256 hlist_add_head_rcu(&class->hash_entry, hash_head);
1481197b 1257 /*
a0b0fd53
BVA
1258 * Remove the class from the free list and add it to the global list
1259 * of classes.
1481197b 1260 */
a0b0fd53 1261 list_move_tail(&class->lock_entry, &all_lock_classes);
8e18257d
PZ
1262
1263 if (verbose(class)) {
1264 graph_unlock();
8e18257d 1265
04860d48 1266 printk("\nnew class %px: %s", class->key, class->name);
8e18257d 1267 if (class->name_version > 1)
f943fe0f
DV
1268 printk(KERN_CONT "#%d", class->name_version);
1269 printk(KERN_CONT "\n");
8e18257d
PZ
1270 dump_stack();
1271
8e18257d 1272 if (!graph_lock()) {
8e18257d
PZ
1273 return NULL;
1274 }
1275 }
1276out_unlock_set:
1277 graph_unlock();
8e18257d 1278
87cdee71 1279out_set_class_cache:
8e18257d 1280 if (!subclass || force)
62016250
HM
1281 lock->class_cache[0] = class;
1282 else if (subclass < NR_LOCKDEP_CACHING_CLASSES)
1283 lock->class_cache[subclass] = class;
8e18257d 1284
0119fee4
PZ
1285 /*
1286 * Hash collision, did we smoke some? We found a class with a matching
1287 * hash but the subclass -- which is hashed in -- didn't match.
1288 */
8e18257d
PZ
1289 if (DEBUG_LOCKS_WARN_ON(class->subclass != subclass))
1290 return NULL;
1291
1292 return class;
1293}
1294
1295#ifdef CONFIG_PROVE_LOCKING
1296/*
1297 * Allocate a lockdep entry. (assumes the graph_lock held, returns
1298 * with NULL on failure)
1299 */
1300static struct lock_list *alloc_list_entry(void)
1301{
ace35a7a
BVA
1302 int idx = find_first_zero_bit(list_entries_in_use,
1303 ARRAY_SIZE(list_entries));
1304
1305 if (idx >= ARRAY_SIZE(list_entries)) {
8e18257d
PZ
1306 if (!debug_locks_off_graph_unlock())
1307 return NULL;
1308
2c522836 1309 print_lockdep_off("BUG: MAX_LOCKDEP_ENTRIES too low!");
eedeeabd 1310 dump_stack();
8e18257d
PZ
1311 return NULL;
1312 }
ace35a7a
BVA
1313 nr_list_entries++;
1314 __set_bit(idx, list_entries_in_use);
1315 return list_entries + idx;
8e18257d
PZ
1316}
1317
1318/*
1319 * Add a new dependency to the head of the list:
1320 */
86cffb80
BVA
1321static int add_lock_to_list(struct lock_class *this,
1322 struct lock_class *links_to, struct list_head *head,
83f06168 1323 unsigned long ip, int distance,
12593b74 1324 const struct lock_trace *trace)
8e18257d
PZ
1325{
1326 struct lock_list *entry;
1327 /*
1328 * Lock not present yet - get a new dependency struct and
1329 * add it to the list:
1330 */
1331 entry = alloc_list_entry();
1332 if (!entry)
1333 return 0;
1334
74870172 1335 entry->class = this;
86cffb80 1336 entry->links_to = links_to;
74870172 1337 entry->distance = distance;
12593b74 1338 entry->trace = trace;
8e18257d 1339 /*
35a9393c
PZ
1340 * Both allocation and removal are done under the graph lock; but
1341 * iteration is under RCU-sched; see look_up_lock_class() and
1342 * lockdep_free_key_range().
8e18257d
PZ
1343 */
1344 list_add_tail_rcu(&entry->entry, head);
1345
1346 return 1;
1347}
1348
98c33edd
PZ
1349/*
1350 * For good efficiency of modular, we use power of 2
1351 */
af012961
PZ
1352#define MAX_CIRCULAR_QUEUE_SIZE 4096UL
1353#define CQ_MASK (MAX_CIRCULAR_QUEUE_SIZE-1)
1354
98c33edd 1355/*
aa480771
YD
1356 * The circular_queue and helpers are used to implement graph
1357 * breadth-first search (BFS) algorithm, by which we can determine
1358 * whether there is a path from a lock to another. In deadlock checks,
1359 * a path from the next lock to be acquired to a previous held lock
1360 * indicates that adding the <prev> -> <next> lock dependency will
1361 * produce a circle in the graph. Breadth-first search instead of
1362 * depth-first search is used in order to find the shortest (circular)
1363 * path.
98c33edd 1364 */
af012961 1365struct circular_queue {
aa480771 1366 struct lock_list *element[MAX_CIRCULAR_QUEUE_SIZE];
af012961
PZ
1367 unsigned int front, rear;
1368};
1369
1370static struct circular_queue lock_cq;
af012961 1371
12f3dfd0 1372unsigned int max_bfs_queue_depth;
af012961 1373
e351b660
ML
1374static unsigned int lockdep_dependency_gen_id;
1375
af012961
PZ
1376static inline void __cq_init(struct circular_queue *cq)
1377{
1378 cq->front = cq->rear = 0;
e351b660 1379 lockdep_dependency_gen_id++;
af012961
PZ
1380}
1381
1382static inline int __cq_empty(struct circular_queue *cq)
1383{
1384 return (cq->front == cq->rear);
1385}
1386
1387static inline int __cq_full(struct circular_queue *cq)
1388{
1389 return ((cq->rear + 1) & CQ_MASK) == cq->front;
1390}
1391
aa480771 1392static inline int __cq_enqueue(struct circular_queue *cq, struct lock_list *elem)
af012961
PZ
1393{
1394 if (__cq_full(cq))
1395 return -1;
1396
1397 cq->element[cq->rear] = elem;
1398 cq->rear = (cq->rear + 1) & CQ_MASK;
1399 return 0;
1400}
1401
c1661325
YD
1402/*
1403 * Dequeue an element from the circular_queue, return a lock_list if
1404 * the queue is not empty, or NULL if otherwise.
1405 */
1406static inline struct lock_list * __cq_dequeue(struct circular_queue *cq)
af012961 1407{
c1661325
YD
1408 struct lock_list * lock;
1409
af012961 1410 if (__cq_empty(cq))
c1661325 1411 return NULL;
af012961 1412
c1661325 1413 lock = cq->element[cq->front];
af012961 1414 cq->front = (cq->front + 1) & CQ_MASK;
c1661325
YD
1415
1416 return lock;
af012961
PZ
1417}
1418
1419static inline unsigned int __cq_get_elem_count(struct circular_queue *cq)
1420{
1421 return (cq->rear - cq->front) & CQ_MASK;
1422}
1423
1424static inline void mark_lock_accessed(struct lock_list *lock,
1425 struct lock_list *parent)
1426{
1427 unsigned long nr;
98c33edd 1428
af012961 1429 nr = lock - list_entries;
ace35a7a 1430 WARN_ON(nr >= ARRAY_SIZE(list_entries)); /* Out-of-bounds, input fail */
af012961 1431 lock->parent = parent;
e351b660 1432 lock->class->dep_gen_id = lockdep_dependency_gen_id;
af012961
PZ
1433}
1434
1435static inline unsigned long lock_accessed(struct lock_list *lock)
1436{
1437 unsigned long nr;
98c33edd 1438
af012961 1439 nr = lock - list_entries;
ace35a7a 1440 WARN_ON(nr >= ARRAY_SIZE(list_entries)); /* Out-of-bounds, input fail */
e351b660 1441 return lock->class->dep_gen_id == lockdep_dependency_gen_id;
af012961
PZ
1442}
1443
1444static inline struct lock_list *get_lock_parent(struct lock_list *child)
1445{
1446 return child->parent;
1447}
1448
1449static inline int get_lock_depth(struct lock_list *child)
1450{
1451 int depth = 0;
1452 struct lock_list *parent;
1453
1454 while ((parent = get_lock_parent(child))) {
1455 child = parent;
1456 depth++;
1457 }
1458 return depth;
1459}
1460
77a80692
YD
1461/*
1462 * Return the forward or backward dependency list.
1463 *
1464 * @lock: the lock_list to get its class's dependency list
1465 * @offset: the offset to struct lock_class to determine whether it is
1466 * locks_after or locks_before
1467 */
1468static inline struct list_head *get_dep_list(struct lock_list *lock, int offset)
1469{
1470 void *lock_class = lock->class;
1471
1472 return lock_class + offset;
1473}
1474
154f185e
YD
1475/*
1476 * Forward- or backward-dependency search, used for both circular dependency
1477 * checking and hardirq-unsafe/softirq-unsafe checking.
1478 */
9e2d551e 1479static int __bfs(struct lock_list *source_entry,
af012961
PZ
1480 void *data,
1481 int (*match)(struct lock_list *entry, void *data),
1482 struct lock_list **target_entry,
77a80692 1483 int offset)
c94aa5ca
ML
1484{
1485 struct lock_list *entry;
c1661325 1486 struct lock_list *lock;
d588e461 1487 struct list_head *head;
c94aa5ca
ML
1488 struct circular_queue *cq = &lock_cq;
1489 int ret = 1;
1490
248efb21
PZ
1491 lockdep_assert_locked();
1492
9e2d551e 1493 if (match(source_entry, data)) {
c94aa5ca
ML
1494 *target_entry = source_entry;
1495 ret = 0;
1496 goto exit;
1497 }
1498
77a80692 1499 head = get_dep_list(source_entry, offset);
d588e461
ML
1500 if (list_empty(head))
1501 goto exit;
1502
1503 __cq_init(cq);
aa480771 1504 __cq_enqueue(cq, source_entry);
c94aa5ca 1505
c1661325 1506 while ((lock = __cq_dequeue(cq))) {
c94aa5ca
ML
1507
1508 if (!lock->class) {
1509 ret = -2;
1510 goto exit;
1511 }
1512
77a80692 1513 head = get_dep_list(lock, offset);
c94aa5ca 1514
35a9393c 1515 list_for_each_entry_rcu(entry, head, entry) {
c94aa5ca 1516 if (!lock_accessed(entry)) {
12f3dfd0 1517 unsigned int cq_depth;
c94aa5ca 1518 mark_lock_accessed(entry, lock);
9e2d551e 1519 if (match(entry, data)) {
c94aa5ca
ML
1520 *target_entry = entry;
1521 ret = 0;
1522 goto exit;
1523 }
1524
aa480771 1525 if (__cq_enqueue(cq, entry)) {
c94aa5ca
ML
1526 ret = -1;
1527 goto exit;
1528 }
12f3dfd0
ML
1529 cq_depth = __cq_get_elem_count(cq);
1530 if (max_bfs_queue_depth < cq_depth)
1531 max_bfs_queue_depth = cq_depth;
c94aa5ca
ML
1532 }
1533 }
1534 }
1535exit:
1536 return ret;
1537}
1538
d7aaba14 1539static inline int __bfs_forwards(struct lock_list *src_entry,
9e2d551e
ML
1540 void *data,
1541 int (*match)(struct lock_list *entry, void *data),
1542 struct lock_list **target_entry)
c94aa5ca 1543{
77a80692
YD
1544 return __bfs(src_entry, data, match, target_entry,
1545 offsetof(struct lock_class, locks_after));
c94aa5ca
ML
1546
1547}
1548
d7aaba14 1549static inline int __bfs_backwards(struct lock_list *src_entry,
9e2d551e
ML
1550 void *data,
1551 int (*match)(struct lock_list *entry, void *data),
1552 struct lock_list **target_entry)
c94aa5ca 1553{
77a80692
YD
1554 return __bfs(src_entry, data, match, target_entry,
1555 offsetof(struct lock_class, locks_before));
c94aa5ca
ML
1556
1557}
1558
12593b74
BVA
1559static void print_lock_trace(const struct lock_trace *trace,
1560 unsigned int spaces)
c120bce7 1561{
12593b74 1562 stack_trace_print(trace->entries, trace->nr_entries, spaces);
c120bce7
TG
1563}
1564
8e18257d
PZ
1565/*
1566 * Print a dependency chain entry (this is only done when a deadlock
1567 * has been detected):
1568 */
f7c1c6b3 1569static noinline void
24208ca7 1570print_circular_bug_entry(struct lock_list *target, int depth)
8e18257d
PZ
1571{
1572 if (debug_locks_silent)
f7c1c6b3 1573 return;
8e18257d
PZ
1574 printk("\n-> #%u", depth);
1575 print_lock_name(target->class);
f943fe0f 1576 printk(KERN_CONT ":\n");
12593b74 1577 print_lock_trace(target->trace, 6);
8e18257d
PZ
1578}
1579
f4185812
SR
1580static void
1581print_circular_lock_scenario(struct held_lock *src,
1582 struct held_lock *tgt,
1583 struct lock_list *prt)
1584{
1585 struct lock_class *source = hlock_class(src);
1586 struct lock_class *target = hlock_class(tgt);
1587 struct lock_class *parent = prt->class;
1588
1589 /*
1590 * A direct locking problem where unsafe_class lock is taken
1591 * directly by safe_class lock, then all we need to show
1592 * is the deadlock scenario, as it is obvious that the
1593 * unsafe lock is taken under the safe lock.
1594 *
1595 * But if there is a chain instead, where the safe lock takes
1596 * an intermediate lock (middle_class) where this lock is
1597 * not the same as the safe lock, then the lock chain is
1598 * used to describe the problem. Otherwise we would need
1599 * to show a different CPU case for each link in the chain
1600 * from the safe_class lock to the unsafe_class lock.
1601 */
1602 if (parent != source) {
1603 printk("Chain exists of:\n ");
1604 __print_lock_name(source);
f943fe0f 1605 printk(KERN_CONT " --> ");
f4185812 1606 __print_lock_name(parent);
f943fe0f 1607 printk(KERN_CONT " --> ");
f4185812 1608 __print_lock_name(target);
f943fe0f 1609 printk(KERN_CONT "\n\n");
f4185812
SR
1610 }
1611
e966eaee
IM
1612 printk(" Possible unsafe locking scenario:\n\n");
1613 printk(" CPU0 CPU1\n");
1614 printk(" ---- ----\n");
1615 printk(" lock(");
1616 __print_lock_name(target);
1617 printk(KERN_CONT ");\n");
1618 printk(" lock(");
1619 __print_lock_name(parent);
1620 printk(KERN_CONT ");\n");
1621 printk(" lock(");
1622 __print_lock_name(target);
1623 printk(KERN_CONT ");\n");
1624 printk(" lock(");
1625 __print_lock_name(source);
1626 printk(KERN_CONT ");\n");
1627 printk("\n *** DEADLOCK ***\n\n");
f4185812
SR
1628}
1629
8e18257d
PZ
1630/*
1631 * When a circular dependency is detected, print the
1632 * header first:
1633 */
f7c1c6b3 1634static noinline void
db0002a3
ML
1635print_circular_bug_header(struct lock_list *entry, unsigned int depth,
1636 struct held_lock *check_src,
1637 struct held_lock *check_tgt)
8e18257d
PZ
1638{
1639 struct task_struct *curr = current;
1640
c94aa5ca 1641 if (debug_locks_silent)
f7c1c6b3 1642 return;
8e18257d 1643
681fbec8 1644 pr_warn("\n");
a5dd63ef
PM
1645 pr_warn("======================================================\n");
1646 pr_warn("WARNING: possible circular locking dependency detected\n");
fbdc4b9a 1647 print_kernel_ident();
a5dd63ef 1648 pr_warn("------------------------------------------------------\n");
681fbec8 1649 pr_warn("%s/%d is trying to acquire lock:\n",
ba25f9dc 1650 curr->comm, task_pid_nr(curr));
db0002a3 1651 print_lock(check_src);
383a4bc8 1652
e966eaee 1653 pr_warn("\nbut task is already holding lock:\n");
383a4bc8 1654
db0002a3 1655 print_lock(check_tgt);
681fbec8
PM
1656 pr_warn("\nwhich lock already depends on the new lock.\n\n");
1657 pr_warn("\nthe existing dependency chain (in reverse order) is:\n");
8e18257d
PZ
1658
1659 print_circular_bug_entry(entry, depth);
8e18257d
PZ
1660}
1661
9e2d551e
ML
1662static inline int class_equal(struct lock_list *entry, void *data)
1663{
1664 return entry->class == data;
1665}
1666
f7c1c6b3
YD
1667static noinline void print_circular_bug(struct lock_list *this,
1668 struct lock_list *target,
1669 struct held_lock *check_src,
1670 struct held_lock *check_tgt)
8e18257d
PZ
1671{
1672 struct task_struct *curr = current;
c94aa5ca 1673 struct lock_list *parent;
f4185812 1674 struct lock_list *first_parent;
24208ca7 1675 int depth;
8e18257d 1676
c94aa5ca 1677 if (!debug_locks_off_graph_unlock() || debug_locks_silent)
f7c1c6b3 1678 return;
8e18257d 1679
12593b74
BVA
1680 this->trace = save_trace();
1681 if (!this->trace)
f7c1c6b3 1682 return;
8e18257d 1683
c94aa5ca
ML
1684 depth = get_lock_depth(target);
1685
db0002a3 1686 print_circular_bug_header(target, depth, check_src, check_tgt);
c94aa5ca
ML
1687
1688 parent = get_lock_parent(target);
f4185812 1689 first_parent = parent;
c94aa5ca
ML
1690
1691 while (parent) {
1692 print_circular_bug_entry(parent, --depth);
1693 parent = get_lock_parent(parent);
1694 }
8e18257d
PZ
1695
1696 printk("\nother info that might help us debug this:\n\n");
f4185812
SR
1697 print_circular_lock_scenario(check_src, check_tgt,
1698 first_parent);
1699
8e18257d
PZ
1700 lockdep_print_held_locks(curr);
1701
1702 printk("\nstack backtrace:\n");
1703 dump_stack();
8e18257d
PZ
1704}
1705
f7c1c6b3 1706static noinline void print_bfs_bug(int ret)
db0002a3
ML
1707{
1708 if (!debug_locks_off_graph_unlock())
f7c1c6b3 1709 return;
db0002a3 1710
0119fee4
PZ
1711 /*
1712 * Breadth-first-search failed, graph got corrupted?
1713 */
db0002a3 1714 WARN(1, "lockdep bfs error:%d\n", ret);
db0002a3
ML
1715}
1716
ef681026 1717static int noop_count(struct lock_list *entry, void *data)
419ca3f1 1718{
ef681026
ML
1719 (*(unsigned long *)data)++;
1720 return 0;
1721}
419ca3f1 1722
5216d530 1723static unsigned long __lockdep_count_forward_deps(struct lock_list *this)
ef681026
ML
1724{
1725 unsigned long count = 0;
3f649ab7 1726 struct lock_list *target_entry;
419ca3f1 1727
ef681026 1728 __bfs_forwards(this, (void *)&count, noop_count, &target_entry);
419ca3f1 1729
ef681026 1730 return count;
419ca3f1 1731}
419ca3f1
DM
1732unsigned long lockdep_count_forward_deps(struct lock_class *class)
1733{
1734 unsigned long ret, flags;
ef681026
ML
1735 struct lock_list this;
1736
1737 this.parent = NULL;
1738 this.class = class;
419ca3f1 1739
fcc784be 1740 raw_local_irq_save(flags);
248efb21 1741 lockdep_lock();
ef681026 1742 ret = __lockdep_count_forward_deps(&this);
248efb21 1743 lockdep_unlock();
fcc784be 1744 raw_local_irq_restore(flags);
419ca3f1
DM
1745
1746 return ret;
1747}
1748
5216d530 1749static unsigned long __lockdep_count_backward_deps(struct lock_list *this)
419ca3f1 1750{
ef681026 1751 unsigned long count = 0;
3f649ab7 1752 struct lock_list *target_entry;
419ca3f1 1753
ef681026 1754 __bfs_backwards(this, (void *)&count, noop_count, &target_entry);
419ca3f1 1755
ef681026 1756 return count;
419ca3f1
DM
1757}
1758
1759unsigned long lockdep_count_backward_deps(struct lock_class *class)
1760{
1761 unsigned long ret, flags;
ef681026
ML
1762 struct lock_list this;
1763
1764 this.parent = NULL;
1765 this.class = class;
419ca3f1 1766
fcc784be 1767 raw_local_irq_save(flags);
248efb21 1768 lockdep_lock();
ef681026 1769 ret = __lockdep_count_backward_deps(&this);
248efb21 1770 lockdep_unlock();
fcc784be 1771 raw_local_irq_restore(flags);
419ca3f1
DM
1772
1773 return ret;
1774}
1775
8e18257d 1776/*
8c2c2b44
YD
1777 * Check that the dependency graph starting at <src> can lead to
1778 * <target> or not. Print an error and return 0 if it does.
8e18257d
PZ
1779 */
1780static noinline int
8c2c2b44
YD
1781check_path(struct lock_class *target, struct lock_list *src_entry,
1782 struct lock_list **target_entry)
8e18257d 1783{
8c2c2b44
YD
1784 int ret;
1785
1786 ret = __bfs_forwards(src_entry, (void *)target, class_equal,
1787 target_entry);
1788
1789 if (unlikely(ret < 0))
1790 print_bfs_bug(ret);
1791
1792 return ret;
1793}
1794
1795/*
1796 * Prove that the dependency graph starting at <src> can not
1797 * lead to <target>. If it can, there is a circle when adding
1798 * <target> -> <src> dependency.
1799 *
1800 * Print an error and return 0 if it does.
1801 */
1802static noinline int
1803check_noncircular(struct held_lock *src, struct held_lock *target,
12593b74 1804 struct lock_trace **const trace)
8c2c2b44
YD
1805{
1806 int ret;
3f649ab7 1807 struct lock_list *target_entry;
8c2c2b44
YD
1808 struct lock_list src_entry = {
1809 .class = hlock_class(src),
1810 .parent = NULL,
1811 };
8e18257d 1812
bd6d29c2 1813 debug_atomic_inc(nr_cyclic_checks);
419ca3f1 1814
8c2c2b44 1815 ret = check_path(hlock_class(target), &src_entry, &target_entry);
fbb9ce95 1816
8c2c2b44 1817 if (unlikely(!ret)) {
12593b74 1818 if (!*trace) {
8c2c2b44
YD
1819 /*
1820 * If save_trace fails here, the printing might
1821 * trigger a WARN but because of the !nr_entries it
1822 * should not do bad things.
1823 */
12593b74 1824 *trace = save_trace();
8c2c2b44
YD
1825 }
1826
1827 print_circular_bug(&src_entry, target_entry, src, target);
1828 }
1829
1830 return ret;
db0002a3 1831}
c94aa5ca 1832
68e9dc29 1833#ifdef CONFIG_LOCKDEP_SMALL
8c2c2b44
YD
1834/*
1835 * Check that the dependency graph starting at <src> can lead to
1836 * <target> or not. If it can, <src> -> <target> dependency is already
1837 * in the graph.
1838 *
1839 * Print an error and return 2 if it does or 1 if it does not.
1840 */
ae813308 1841static noinline int
8c2c2b44 1842check_redundant(struct held_lock *src, struct held_lock *target)
ae813308 1843{
8c2c2b44 1844 int ret;
3f649ab7 1845 struct lock_list *target_entry;
8c2c2b44
YD
1846 struct lock_list src_entry = {
1847 .class = hlock_class(src),
1848 .parent = NULL,
1849 };
ae813308
PZ
1850
1851 debug_atomic_inc(nr_redundant_checks);
1852
8c2c2b44 1853 ret = check_path(hlock_class(target), &src_entry, &target_entry);
ae813308 1854
8c2c2b44
YD
1855 if (!ret) {
1856 debug_atomic_inc(nr_redundant);
1857 ret = 2;
1858 } else if (ret < 0)
1859 ret = 0;
1860
1861 return ret;
ae813308 1862}
68e9dc29 1863#endif
ae813308 1864
e7a38f63 1865#ifdef CONFIG_TRACE_IRQFLAGS
948f8376
FW
1866
1867static inline int usage_accumulate(struct lock_list *entry, void *mask)
1868{
1869 *(unsigned long *)mask |= entry->class->usage_mask;
1870
1871 return 0;
1872}
1873
fbb9ce95
IM
1874/*
1875 * Forwards and backwards subgraph searching, for the purposes of
1876 * proving that two subgraphs can be connected by a new dependency
1877 * without creating any illegal irq-safe -> irq-unsafe lock dependency.
1878 */
fbb9ce95 1879
627f364d 1880static inline int usage_match(struct lock_list *entry, void *mask)
d7aaba14 1881{
627f364d 1882 return entry->class->usage_mask & *(unsigned long *)mask;
d7aaba14
ML
1883}
1884
fbb9ce95
IM
1885/*
1886 * Find a node in the forwards-direction dependency sub-graph starting
d7aaba14 1887 * at @root->class that matches @bit.
fbb9ce95 1888 *
d7aaba14
ML
1889 * Return 0 if such a node exists in the subgraph, and put that node
1890 * into *@target_entry.
fbb9ce95 1891 *
d7aaba14
ML
1892 * Return 1 otherwise and keep *@target_entry unchanged.
1893 * Return <0 on error.
fbb9ce95 1894 */
d7aaba14 1895static int
627f364d 1896find_usage_forwards(struct lock_list *root, unsigned long usage_mask,
d7aaba14 1897 struct lock_list **target_entry)
fbb9ce95 1898{
d7aaba14 1899 int result;
fbb9ce95 1900
bd6d29c2 1901 debug_atomic_inc(nr_find_usage_forwards_checks);
fbb9ce95 1902
627f364d 1903 result = __bfs_forwards(root, &usage_mask, usage_match, target_entry);
d7aaba14
ML
1904
1905 return result;
fbb9ce95
IM
1906}
1907
1908/*
1909 * Find a node in the backwards-direction dependency sub-graph starting
d7aaba14 1910 * at @root->class that matches @bit.
fbb9ce95 1911 *
d7aaba14
ML
1912 * Return 0 if such a node exists in the subgraph, and put that node
1913 * into *@target_entry.
fbb9ce95 1914 *
d7aaba14
ML
1915 * Return 1 otherwise and keep *@target_entry unchanged.
1916 * Return <0 on error.
fbb9ce95 1917 */
d7aaba14 1918static int
627f364d 1919find_usage_backwards(struct lock_list *root, unsigned long usage_mask,
d7aaba14 1920 struct lock_list **target_entry)
fbb9ce95 1921{
d7aaba14 1922 int result;
fbb9ce95 1923
bd6d29c2 1924 debug_atomic_inc(nr_find_usage_backwards_checks);
fbb9ce95 1925
627f364d 1926 result = __bfs_backwards(root, &usage_mask, usage_match, target_entry);
f82b217e 1927
d7aaba14 1928 return result;
fbb9ce95
IM
1929}
1930
af012961
PZ
1931static void print_lock_class_header(struct lock_class *class, int depth)
1932{
1933 int bit;
1934
1935 printk("%*s->", depth, "");
1936 print_lock_name(class);
8ca2b56c
WL
1937#ifdef CONFIG_DEBUG_LOCKDEP
1938 printk(KERN_CONT " ops: %lu", debug_class_ops_read(class));
1939#endif
f943fe0f 1940 printk(KERN_CONT " {\n");
af012961
PZ
1941
1942 for (bit = 0; bit < LOCK_USAGE_STATES; bit++) {
1943 if (class->usage_mask & (1 << bit)) {
1944 int len = depth;
1945
1946 len += printk("%*s %s", depth, "", usage_str[bit]);
f943fe0f 1947 len += printk(KERN_CONT " at:\n");
12593b74 1948 print_lock_trace(class->usage_traces[bit], len);
af012961
PZ
1949 }
1950 }
1951 printk("%*s }\n", depth, "");
1952
04860d48 1953 printk("%*s ... key at: [<%px>] %pS\n",
f943fe0f 1954 depth, "", class->key, class->key);
af012961
PZ
1955}
1956
1957/*
1958 * printk the shortest lock dependencies from @start to @end in reverse order:
1959 */
1960static void __used
1961print_shortest_lock_dependencies(struct lock_list *leaf,
f7c1c6b3 1962 struct lock_list *root)
af012961
PZ
1963{
1964 struct lock_list *entry = leaf;
1965 int depth;
1966
1967 /*compute depth from generated tree by BFS*/
1968 depth = get_lock_depth(leaf);
1969
1970 do {
1971 print_lock_class_header(entry->class, depth);
1972 printk("%*s ... acquired at:\n", depth, "");
12593b74 1973 print_lock_trace(entry->trace, 2);
af012961
PZ
1974 printk("\n");
1975
1976 if (depth == 0 && (entry != root)) {
6be8c393 1977 printk("lockdep:%s bad path found in chain graph\n", __func__);
af012961
PZ
1978 break;
1979 }
1980
1981 entry = get_lock_parent(entry);
1982 depth--;
1983 } while (entry && (depth >= 0));
af012961 1984}
d7aaba14 1985
3003eba3
SR
1986static void
1987print_irq_lock_scenario(struct lock_list *safe_entry,
1988 struct lock_list *unsafe_entry,
dad3d743
SR
1989 struct lock_class *prev_class,
1990 struct lock_class *next_class)
3003eba3
SR
1991{
1992 struct lock_class *safe_class = safe_entry->class;
1993 struct lock_class *unsafe_class = unsafe_entry->class;
dad3d743 1994 struct lock_class *middle_class = prev_class;
3003eba3
SR
1995
1996 if (middle_class == safe_class)
dad3d743 1997 middle_class = next_class;
3003eba3
SR
1998
1999 /*
2000 * A direct locking problem where unsafe_class lock is taken
2001 * directly by safe_class lock, then all we need to show
2002 * is the deadlock scenario, as it is obvious that the
2003 * unsafe lock is taken under the safe lock.
2004 *
2005 * But if there is a chain instead, where the safe lock takes
2006 * an intermediate lock (middle_class) where this lock is
2007 * not the same as the safe lock, then the lock chain is
2008 * used to describe the problem. Otherwise we would need
2009 * to show a different CPU case for each link in the chain
2010 * from the safe_class lock to the unsafe_class lock.
2011 */
2012 if (middle_class != unsafe_class) {
2013 printk("Chain exists of:\n ");
2014 __print_lock_name(safe_class);
f943fe0f 2015 printk(KERN_CONT " --> ");
3003eba3 2016 __print_lock_name(middle_class);
f943fe0f 2017 printk(KERN_CONT " --> ");
3003eba3 2018 __print_lock_name(unsafe_class);
f943fe0f 2019 printk(KERN_CONT "\n\n");
3003eba3
SR
2020 }
2021
2022 printk(" Possible interrupt unsafe locking scenario:\n\n");
2023 printk(" CPU0 CPU1\n");
2024 printk(" ---- ----\n");
2025 printk(" lock(");
2026 __print_lock_name(unsafe_class);
f943fe0f 2027 printk(KERN_CONT ");\n");
3003eba3
SR
2028 printk(" local_irq_disable();\n");
2029 printk(" lock(");
2030 __print_lock_name(safe_class);
f943fe0f 2031 printk(KERN_CONT ");\n");
3003eba3
SR
2032 printk(" lock(");
2033 __print_lock_name(middle_class);
f943fe0f 2034 printk(KERN_CONT ");\n");
3003eba3
SR
2035 printk(" <Interrupt>\n");
2036 printk(" lock(");
2037 __print_lock_name(safe_class);
f943fe0f 2038 printk(KERN_CONT ");\n");
3003eba3
SR
2039 printk("\n *** DEADLOCK ***\n\n");
2040}
2041
f7c1c6b3 2042static void
fbb9ce95 2043print_bad_irq_dependency(struct task_struct *curr,
24208ca7
ML
2044 struct lock_list *prev_root,
2045 struct lock_list *next_root,
2046 struct lock_list *backwards_entry,
2047 struct lock_list *forwards_entry,
fbb9ce95
IM
2048 struct held_lock *prev,
2049 struct held_lock *next,
2050 enum lock_usage_bit bit1,
2051 enum lock_usage_bit bit2,
2052 const char *irqclass)
2053{
74c383f1 2054 if (!debug_locks_off_graph_unlock() || debug_locks_silent)
f7c1c6b3 2055 return;
fbb9ce95 2056
681fbec8 2057 pr_warn("\n");
a5dd63ef
PM
2058 pr_warn("=====================================================\n");
2059 pr_warn("WARNING: %s-safe -> %s-unsafe lock order detected\n",
fbb9ce95 2060 irqclass, irqclass);
fbdc4b9a 2061 print_kernel_ident();
a5dd63ef 2062 pr_warn("-----------------------------------------------------\n");
681fbec8 2063 pr_warn("%s/%d [HC%u[%lu]:SC%u[%lu]:HE%u:SE%u] is trying to acquire:\n",
ba25f9dc 2064 curr->comm, task_pid_nr(curr),
fbb9ce95
IM
2065 curr->hardirq_context, hardirq_count() >> HARDIRQ_SHIFT,
2066 curr->softirq_context, softirq_count() >> SOFTIRQ_SHIFT,
2067 curr->hardirqs_enabled,
2068 curr->softirqs_enabled);
2069 print_lock(next);
2070
681fbec8 2071 pr_warn("\nand this task is already holding:\n");
fbb9ce95 2072 print_lock(prev);
681fbec8 2073 pr_warn("which would create a new lock dependency:\n");
f82b217e 2074 print_lock_name(hlock_class(prev));
681fbec8 2075 pr_cont(" ->");
f82b217e 2076 print_lock_name(hlock_class(next));
681fbec8 2077 pr_cont("\n");
fbb9ce95 2078
681fbec8 2079 pr_warn("\nbut this new dependency connects a %s-irq-safe lock:\n",
fbb9ce95 2080 irqclass);
24208ca7 2081 print_lock_name(backwards_entry->class);
681fbec8 2082 pr_warn("\n... which became %s-irq-safe at:\n", irqclass);
fbb9ce95 2083
12593b74 2084 print_lock_trace(backwards_entry->class->usage_traces[bit1], 1);
fbb9ce95 2085
681fbec8 2086 pr_warn("\nto a %s-irq-unsafe lock:\n", irqclass);
24208ca7 2087 print_lock_name(forwards_entry->class);
681fbec8
PM
2088 pr_warn("\n... which became %s-irq-unsafe at:\n", irqclass);
2089 pr_warn("...");
fbb9ce95 2090
12593b74 2091 print_lock_trace(forwards_entry->class->usage_traces[bit2], 1);
fbb9ce95 2092
681fbec8 2093 pr_warn("\nother info that might help us debug this:\n\n");
dad3d743
SR
2094 print_irq_lock_scenario(backwards_entry, forwards_entry,
2095 hlock_class(prev), hlock_class(next));
3003eba3 2096
fbb9ce95
IM
2097 lockdep_print_held_locks(curr);
2098
681fbec8 2099 pr_warn("\nthe dependencies between %s-irq-safe lock and the holding lock:\n", irqclass);
12593b74
BVA
2100 prev_root->trace = save_trace();
2101 if (!prev_root->trace)
f7c1c6b3 2102 return;
24208ca7 2103 print_shortest_lock_dependencies(backwards_entry, prev_root);
fbb9ce95 2104
681fbec8
PM
2105 pr_warn("\nthe dependencies between the lock to be acquired");
2106 pr_warn(" and %s-irq-unsafe lock:\n", irqclass);
12593b74
BVA
2107 next_root->trace = save_trace();
2108 if (!next_root->trace)
f7c1c6b3 2109 return;
24208ca7 2110 print_shortest_lock_dependencies(forwards_entry, next_root);
fbb9ce95 2111
681fbec8 2112 pr_warn("\nstack backtrace:\n");
fbb9ce95 2113 dump_stack();
fbb9ce95
IM
2114}
2115
4f367d8a
PZ
2116static const char *state_names[] = {
2117#define LOCKDEP_STATE(__STATE) \
b4b136f4 2118 __stringify(__STATE),
4f367d8a
PZ
2119#include "lockdep_states.h"
2120#undef LOCKDEP_STATE
2121};
2122
2123static const char *state_rnames[] = {
2124#define LOCKDEP_STATE(__STATE) \
b4b136f4 2125 __stringify(__STATE)"-READ",
4f367d8a
PZ
2126#include "lockdep_states.h"
2127#undef LOCKDEP_STATE
2128};
2129
2130static inline const char *state_name(enum lock_usage_bit bit)
8e18257d 2131{
c902a1e8
FW
2132 if (bit & LOCK_USAGE_READ_MASK)
2133 return state_rnames[bit >> LOCK_USAGE_DIR_MASK];
2134 else
2135 return state_names[bit >> LOCK_USAGE_DIR_MASK];
4f367d8a 2136}
8e18257d 2137
948f8376
FW
2138/*
2139 * The bit number is encoded like:
2140 *
2141 * bit0: 0 exclusive, 1 read lock
2142 * bit1: 0 used in irq, 1 irq enabled
2143 * bit2-n: state
2144 */
4f367d8a
PZ
2145static int exclusive_bit(int new_bit)
2146{
bba2a8f1
FW
2147 int state = new_bit & LOCK_USAGE_STATE_MASK;
2148 int dir = new_bit & LOCK_USAGE_DIR_MASK;
8e18257d
PZ
2149
2150 /*
4f367d8a 2151 * keep state, bit flip the direction and strip read.
8e18257d 2152 */
bba2a8f1 2153 return state | (dir ^ LOCK_USAGE_DIR_MASK);
4f367d8a
PZ
2154}
2155
948f8376
FW
2156/*
2157 * Observe that when given a bitmask where each bitnr is encoded as above, a
2158 * right shift of the mask transforms the individual bitnrs as -1 and
2159 * conversely, a left shift transforms into +1 for the individual bitnrs.
2160 *
2161 * So for all bits whose number have LOCK_ENABLED_* set (bitnr1 == 1), we can
2162 * create the mask with those bit numbers using LOCK_USED_IN_* (bitnr1 == 0)
2163 * instead by subtracting the bit number by 2, or shifting the mask right by 2.
2164 *
2165 * Similarly, bitnr1 == 0 becomes bitnr1 == 1 by adding 2, or shifting left 2.
2166 *
2167 * So split the mask (note that LOCKF_ENABLED_IRQ_ALL|LOCKF_USED_IN_IRQ_ALL is
2168 * all bits set) and recompose with bitnr1 flipped.
2169 */
2170static unsigned long invert_dir_mask(unsigned long mask)
2171{
2172 unsigned long excl = 0;
2173
2174 /* Invert dir */
2175 excl |= (mask & LOCKF_ENABLED_IRQ_ALL) >> LOCK_USAGE_DIR_MASK;
2176 excl |= (mask & LOCKF_USED_IN_IRQ_ALL) << LOCK_USAGE_DIR_MASK;
2177
2178 return excl;
2179}
2180
2181/*
2182 * As above, we clear bitnr0 (LOCK_*_READ off) with bitmask ops. First, for all
2183 * bits with bitnr0 set (LOCK_*_READ), add those with bitnr0 cleared (LOCK_*).
2184 * And then mask out all bitnr0.
2185 */
2186static unsigned long exclusive_mask(unsigned long mask)
2187{
2188 unsigned long excl = invert_dir_mask(mask);
2189
2190 /* Strip read */
2191 excl |= (excl & LOCKF_IRQ_READ) >> LOCK_USAGE_READ_MASK;
2192 excl &= ~LOCKF_IRQ_READ;
2193
2194 return excl;
2195}
2196
2197/*
2198 * Retrieve the _possible_ original mask to which @mask is
2199 * exclusive. Ie: this is the opposite of exclusive_mask().
2200 * Note that 2 possible original bits can match an exclusive
2201 * bit: one has LOCK_USAGE_READ_MASK set, the other has it
2202 * cleared. So both are returned for each exclusive bit.
2203 */
2204static unsigned long original_mask(unsigned long mask)
2205{
2206 unsigned long excl = invert_dir_mask(mask);
2207
2208 /* Include read in existing usages */
2209 excl |= (excl & LOCKF_IRQ) << LOCK_USAGE_READ_MASK;
2210
2211 return excl;
2212}
2213
2214/*
2215 * Find the first pair of bit match between an original
2216 * usage mask and an exclusive usage mask.
2217 */
2218static int find_exclusive_match(unsigned long mask,
2219 unsigned long excl_mask,
2220 enum lock_usage_bit *bitp,
2221 enum lock_usage_bit *excl_bitp)
2222{
2223 int bit, excl;
2224
2225 for_each_set_bit(bit, &mask, LOCK_USED) {
2226 excl = exclusive_bit(bit);
2227 if (excl_mask & lock_flag(excl)) {
2228 *bitp = bit;
2229 *excl_bitp = excl;
2230 return 0;
2231 }
2232 }
2233 return -1;
2234}
2235
2236/*
2237 * Prove that the new dependency does not connect a hardirq-safe(-read)
2238 * lock with a hardirq-unsafe lock - to achieve this we search
2239 * the backwards-subgraph starting at <prev>, and the
2240 * forwards-subgraph starting at <next>:
2241 */
4f367d8a 2242static int check_irq_usage(struct task_struct *curr, struct held_lock *prev,
948f8376 2243 struct held_lock *next)
4f367d8a 2244{
948f8376
FW
2245 unsigned long usage_mask = 0, forward_mask, backward_mask;
2246 enum lock_usage_bit forward_bit = 0, backward_bit = 0;
3f649ab7
KC
2247 struct lock_list *target_entry1;
2248 struct lock_list *target_entry;
948f8376
FW
2249 struct lock_list this, that;
2250 int ret;
2251
8e18257d 2252 /*
948f8376
FW
2253 * Step 1: gather all hard/soft IRQs usages backward in an
2254 * accumulated usage mask.
8e18257d 2255 */
948f8376
FW
2256 this.parent = NULL;
2257 this.class = hlock_class(prev);
8e18257d 2258
948f8376 2259 ret = __bfs_backwards(&this, &usage_mask, usage_accumulate, NULL);
f7c1c6b3
YD
2260 if (ret < 0) {
2261 print_bfs_bug(ret);
2262 return 0;
2263 }
8e18257d 2264
948f8376
FW
2265 usage_mask &= LOCKF_USED_IN_IRQ_ALL;
2266 if (!usage_mask)
2267 return 1;
4f367d8a 2268
cf40bd16 2269 /*
948f8376
FW
2270 * Step 2: find exclusive uses forward that match the previous
2271 * backward accumulated mask.
cf40bd16 2272 */
948f8376 2273 forward_mask = exclusive_mask(usage_mask);
cf40bd16 2274
948f8376
FW
2275 that.parent = NULL;
2276 that.class = hlock_class(next);
4f367d8a 2277
948f8376 2278 ret = find_usage_forwards(&that, forward_mask, &target_entry1);
f7c1c6b3
YD
2279 if (ret < 0) {
2280 print_bfs_bug(ret);
2281 return 0;
2282 }
948f8376
FW
2283 if (ret == 1)
2284 return ret;
cf40bd16 2285
948f8376
FW
2286 /*
2287 * Step 3: we found a bad match! Now retrieve a lock from the backward
2288 * list whose usage mask matches the exclusive usage mask from the
2289 * lock found on the forward list.
2290 */
2291 backward_mask = original_mask(target_entry1->class->usage_mask);
2292
2293 ret = find_usage_backwards(&this, backward_mask, &target_entry);
f7c1c6b3
YD
2294 if (ret < 0) {
2295 print_bfs_bug(ret);
2296 return 0;
2297 }
948f8376
FW
2298 if (DEBUG_LOCKS_WARN_ON(ret == 1))
2299 return 1;
2300
2301 /*
2302 * Step 4: narrow down to a pair of incompatible usage bits
2303 * and report it.
2304 */
2305 ret = find_exclusive_match(target_entry->class->usage_mask,
2306 target_entry1->class->usage_mask,
2307 &backward_bit, &forward_bit);
2308 if (DEBUG_LOCKS_WARN_ON(ret == -1))
2309 return 1;
2310
f7c1c6b3
YD
2311 print_bad_irq_dependency(curr, &this, &that,
2312 target_entry, target_entry1,
2313 prev, next,
2314 backward_bit, forward_bit,
2315 state_name(backward_bit));
2316
2317 return 0;
8e18257d
PZ
2318}
2319
8e18257d
PZ
2320#else
2321
948f8376
FW
2322static inline int check_irq_usage(struct task_struct *curr,
2323 struct held_lock *prev, struct held_lock *next)
8e18257d
PZ
2324{
2325 return 1;
2326}
b3b9c187 2327#endif /* CONFIG_TRACE_IRQFLAGS */
8e18257d 2328
b3b9c187 2329static void inc_chains(int irq_context)
8e18257d 2330{
b3b9c187
WL
2331 if (irq_context & LOCK_CHAIN_HARDIRQ_CONTEXT)
2332 nr_hardirq_chains++;
2333 else if (irq_context & LOCK_CHAIN_SOFTIRQ_CONTEXT)
2334 nr_softirq_chains++;
2335 else
2336 nr_process_chains++;
8e18257d
PZ
2337}
2338
b3b9c187
WL
2339static void dec_chains(int irq_context)
2340{
2341 if (irq_context & LOCK_CHAIN_HARDIRQ_CONTEXT)
2342 nr_hardirq_chains--;
2343 else if (irq_context & LOCK_CHAIN_SOFTIRQ_CONTEXT)
2344 nr_softirq_chains--;
2345 else
2346 nr_process_chains--;
2347}
fbb9ce95 2348
48702ecf 2349static void
f7c1c6b3 2350print_deadlock_scenario(struct held_lock *nxt, struct held_lock *prv)
48702ecf
SR
2351{
2352 struct lock_class *next = hlock_class(nxt);
2353 struct lock_class *prev = hlock_class(prv);
2354
2355 printk(" Possible unsafe locking scenario:\n\n");
2356 printk(" CPU0\n");
2357 printk(" ----\n");
2358 printk(" lock(");
2359 __print_lock_name(prev);
f943fe0f 2360 printk(KERN_CONT ");\n");
48702ecf
SR
2361 printk(" lock(");
2362 __print_lock_name(next);
f943fe0f 2363 printk(KERN_CONT ");\n");
48702ecf
SR
2364 printk("\n *** DEADLOCK ***\n\n");
2365 printk(" May be due to missing lock nesting notation\n\n");
2366}
2367
f7c1c6b3 2368static void
fbb9ce95
IM
2369print_deadlock_bug(struct task_struct *curr, struct held_lock *prev,
2370 struct held_lock *next)
2371{
74c383f1 2372 if (!debug_locks_off_graph_unlock() || debug_locks_silent)
f7c1c6b3 2373 return;
fbb9ce95 2374
681fbec8 2375 pr_warn("\n");
a5dd63ef
PM
2376 pr_warn("============================================\n");
2377 pr_warn("WARNING: possible recursive locking detected\n");
fbdc4b9a 2378 print_kernel_ident();
a5dd63ef 2379 pr_warn("--------------------------------------------\n");
681fbec8 2380 pr_warn("%s/%d is trying to acquire lock:\n",
ba25f9dc 2381 curr->comm, task_pid_nr(curr));
fbb9ce95 2382 print_lock(next);
681fbec8 2383 pr_warn("\nbut task is already holding lock:\n");
fbb9ce95
IM
2384 print_lock(prev);
2385
681fbec8 2386 pr_warn("\nother info that might help us debug this:\n");
48702ecf 2387 print_deadlock_scenario(next, prev);
fbb9ce95
IM
2388 lockdep_print_held_locks(curr);
2389
681fbec8 2390 pr_warn("\nstack backtrace:\n");
fbb9ce95 2391 dump_stack();
fbb9ce95
IM
2392}
2393
2394/*
2395 * Check whether we are holding such a class already.
2396 *
2397 * (Note that this has to be done separately, because the graph cannot
2398 * detect such classes of deadlocks.)
2399 *
2400 * Returns: 0 on deadlock detected, 1 on OK, 2 on recursive read
2401 */
2402static int
4609c4f9 2403check_deadlock(struct task_struct *curr, struct held_lock *next)
fbb9ce95
IM
2404{
2405 struct held_lock *prev;
7531e2f3 2406 struct held_lock *nest = NULL;
fbb9ce95
IM
2407 int i;
2408
2409 for (i = 0; i < curr->lockdep_depth; i++) {
2410 prev = curr->held_locks + i;
7531e2f3
PZ
2411
2412 if (prev->instance == next->nest_lock)
2413 nest = prev;
2414
f82b217e 2415 if (hlock_class(prev) != hlock_class(next))
fbb9ce95 2416 continue;
7531e2f3 2417
fbb9ce95
IM
2418 /*
2419 * Allow read-after-read recursion of the same
6c9076ec 2420 * lock class (i.e. read_lock(lock)+read_lock(lock)):
fbb9ce95 2421 */
4609c4f9 2422 if ((next->read == 2) && prev->read)
fbb9ce95 2423 return 2;
7531e2f3
PZ
2424
2425 /*
2426 * We're holding the nest_lock, which serializes this lock's
2427 * nesting behaviour.
2428 */
2429 if (nest)
2430 return 2;
2431
f7c1c6b3
YD
2432 print_deadlock_bug(curr, prev, next);
2433 return 0;
fbb9ce95
IM
2434 }
2435 return 1;
2436}
2437
2438/*
2439 * There was a chain-cache miss, and we are about to add a new dependency
154f185e 2440 * to a previous lock. We validate the following rules:
fbb9ce95
IM
2441 *
2442 * - would the adding of the <prev> -> <next> dependency create a
2443 * circular dependency in the graph? [== circular deadlock]
2444 *
2445 * - does the new prev->next dependency connect any hardirq-safe lock
2446 * (in the full backwards-subgraph starting at <prev>) with any
2447 * hardirq-unsafe lock (in the full forwards-subgraph starting at
2448 * <next>)? [== illegal lock inversion with hardirq contexts]
2449 *
2450 * - does the new prev->next dependency connect any softirq-safe lock
2451 * (in the full backwards-subgraph starting at <prev>) with any
2452 * softirq-unsafe lock (in the full forwards-subgraph starting at
2453 * <next>)? [== illegal lock inversion with softirq contexts]
2454 *
2455 * any of these scenarios could lead to a deadlock.
2456 *
2457 * Then if all the validations pass, we add the forwards and backwards
2458 * dependency.
2459 */
2460static int
2461check_prev_add(struct task_struct *curr, struct held_lock *prev,
12593b74
BVA
2462 struct held_lock *next, int distance,
2463 struct lock_trace **const trace)
fbb9ce95
IM
2464{
2465 struct lock_list *entry;
8b405d5c 2466 int ret;
fbb9ce95 2467
a0b0fd53
BVA
2468 if (!hlock_class(prev)->key || !hlock_class(next)->key) {
2469 /*
2470 * The warning statements below may trigger a use-after-free
2471 * of the class name. It is better to trigger a use-after free
2472 * and to have the class name most of the time instead of not
2473 * having the class name available.
2474 */
2475 WARN_ONCE(!debug_locks_silent && !hlock_class(prev)->key,
2476 "Detected use-after-free of lock class %px/%s\n",
2477 hlock_class(prev),
2478 hlock_class(prev)->name);
2479 WARN_ONCE(!debug_locks_silent && !hlock_class(next)->key,
2480 "Detected use-after-free of lock class %px/%s\n",
2481 hlock_class(next),
2482 hlock_class(next)->name);
2483 return 2;
2484 }
2485
fbb9ce95
IM
2486 /*
2487 * Prove that the new <prev> -> <next> dependency would not
2488 * create a circular dependency in the graph. (We do this by
154f185e
YD
2489 * a breadth-first search into the graph starting at <next>,
2490 * and check whether we can reach <prev>.)
fbb9ce95 2491 *
154f185e
YD
2492 * The search is limited by the size of the circular queue (i.e.,
2493 * MAX_CIRCULAR_QUEUE_SIZE) which keeps track of a breadth of nodes
2494 * in the graph whose neighbours are to be checked.
fbb9ce95 2495 */
8c2c2b44
YD
2496 ret = check_noncircular(next, prev, trace);
2497 if (unlikely(ret <= 0))
f7c1c6b3 2498 return 0;
c94aa5ca 2499
948f8376 2500 if (!check_irq_usage(curr, prev, next))
fbb9ce95
IM
2501 return 0;
2502
fbb9ce95
IM
2503 /*
2504 * For recursive read-locks we do all the dependency checks,
2505 * but we dont store read-triggered dependencies (only
2506 * write-triggered dependencies). This ensures that only the
2507 * write-side dependencies matter, and that if for example a
2508 * write-lock never takes any other locks, then the reads are
2509 * equivalent to a NOP.
2510 */
2511 if (next->read == 2 || prev->read == 2)
2512 return 1;
2513 /*
2514 * Is the <prev> -> <next> dependency already present?
2515 *
2516 * (this may occur even though this is a new chain: consider
2517 * e.g. the L1 -> L2 -> L3 -> L4 and the L5 -> L1 -> L2 -> L3
2518 * chains - the second one will be new, but L1 already has
2519 * L2 added to its dependency list, due to the first chain.)
2520 */
f82b217e
DJ
2521 list_for_each_entry(entry, &hlock_class(prev)->locks_after, entry) {
2522 if (entry->class == hlock_class(next)) {
068135e6
JB
2523 if (distance == 1)
2524 entry->distance = 1;
70911fdc 2525 return 1;
068135e6 2526 }
fbb9ce95
IM
2527 }
2528
68e9dc29 2529#ifdef CONFIG_LOCKDEP_SMALL
ae813308
PZ
2530 /*
2531 * Is the <prev> -> <next> link redundant?
2532 */
8c2c2b44
YD
2533 ret = check_redundant(prev, next);
2534 if (ret != 1)
2535 return ret;
68e9dc29 2536#endif
ae813308 2537
12593b74
BVA
2538 if (!*trace) {
2539 *trace = save_trace();
2540 if (!*trace)
2541 return 0;
2542 }
4726f2a6 2543
fbb9ce95
IM
2544 /*
2545 * Ok, all validations passed, add the new lock
2546 * to the previous lock's dependency list:
2547 */
86cffb80 2548 ret = add_lock_to_list(hlock_class(next), hlock_class(prev),
f82b217e 2549 &hlock_class(prev)->locks_after,
12593b74 2550 next->acquire_ip, distance, *trace);
068135e6 2551
fbb9ce95
IM
2552 if (!ret)
2553 return 0;
910b1b2e 2554
86cffb80 2555 ret = add_lock_to_list(hlock_class(prev), hlock_class(next),
f82b217e 2556 &hlock_class(next)->locks_before,
12593b74 2557 next->acquire_ip, distance, *trace);
910b1b2e
JP
2558 if (!ret)
2559 return 0;
fbb9ce95 2560
70911fdc 2561 return 2;
8e18257d 2562}
fbb9ce95 2563
8e18257d
PZ
2564/*
2565 * Add the dependency to all directly-previous locks that are 'relevant'.
2566 * The ones that are relevant are (in increasing distance from curr):
2567 * all consecutive trylock entries and the final non-trylock entry - or
2568 * the end of this context's lock-chain - whichever comes first.
2569 */
2570static int
2571check_prevs_add(struct task_struct *curr, struct held_lock *next)
2572{
12593b74 2573 struct lock_trace *trace = NULL;
8e18257d
PZ
2574 int depth = curr->lockdep_depth;
2575 struct held_lock *hlock;
d6d897ce 2576
fbb9ce95 2577 /*
8e18257d
PZ
2578 * Debugging checks.
2579 *
2580 * Depth must not be zero for a non-head lock:
fbb9ce95 2581 */
8e18257d
PZ
2582 if (!depth)
2583 goto out_bug;
fbb9ce95 2584 /*
8e18257d
PZ
2585 * At least two relevant locks must exist for this
2586 * to be a head:
fbb9ce95 2587 */
8e18257d
PZ
2588 if (curr->held_locks[depth].irq_context !=
2589 curr->held_locks[depth-1].irq_context)
2590 goto out_bug;
74c383f1 2591
8e18257d
PZ
2592 for (;;) {
2593 int distance = curr->lockdep_depth - depth + 1;
1b5ff816 2594 hlock = curr->held_locks + depth - 1;
e966eaee 2595
8e18257d 2596 /*
e966eaee
IM
2597 * Only non-recursive-read entries get new dependencies
2598 * added:
8e18257d 2599 */
e966eaee 2600 if (hlock->read != 2 && hlock->check) {
76b14436
TG
2601 int ret = check_prev_add(curr, hlock, next, distance,
2602 &trace);
e966eaee
IM
2603 if (!ret)
2604 return 0;
2605
ce07a941 2606 /*
e966eaee
IM
2607 * Stop after the first non-trylock entry,
2608 * as non-trylock entries have added their
2609 * own direct dependencies already, so this
2610 * lock is connected to them indirectly:
ce07a941 2611 */
e966eaee
IM
2612 if (!hlock->trylock)
2613 break;
74c383f1 2614 }
e966eaee 2615
8e18257d
PZ
2616 depth--;
2617 /*
2618 * End of lock-stack?
2619 */
2620 if (!depth)
2621 break;
2622 /*
2623 * Stop the search if we cross into another context:
2624 */
2625 if (curr->held_locks[depth].irq_context !=
2626 curr->held_locks[depth-1].irq_context)
2627 break;
fbb9ce95 2628 }
8e18257d
PZ
2629 return 1;
2630out_bug:
2631 if (!debug_locks_off_graph_unlock())
2632 return 0;
fbb9ce95 2633
0119fee4
PZ
2634 /*
2635 * Clearly we all shouldn't be here, but since we made it we
2636 * can reliable say we messed up our state. See the above two
2637 * gotos for reasons why we could possibly end up here.
2638 */
8e18257d 2639 WARN_ON(1);
fbb9ce95 2640
8e18257d 2641 return 0;
fbb9ce95
IM
2642}
2643
443cd507 2644struct lock_chain lock_chains[MAX_LOCKDEP_CHAINS];
de4643a7 2645static DECLARE_BITMAP(lock_chains_in_use, MAX_LOCKDEP_CHAINS);
443cd507 2646static u16 chain_hlocks[MAX_LOCKDEP_CHAIN_HLOCKS];
797b82eb 2647unsigned long nr_zapped_lock_chains;
810507fe
WL
2648unsigned int nr_free_chain_hlocks; /* Free chain_hlocks in buckets */
2649unsigned int nr_lost_chain_hlocks; /* Lost chain_hlocks */
2650unsigned int nr_large_chain_blocks; /* size > MAX_CHAIN_BUCKETS */
2651
2652/*
2653 * The first 2 chain_hlocks entries in the chain block in the bucket
2654 * list contains the following meta data:
2655 *
2656 * entry[0]:
2657 * Bit 15 - always set to 1 (it is not a class index)
2658 * Bits 0-14 - upper 15 bits of the next block index
2659 * entry[1] - lower 16 bits of next block index
2660 *
2661 * A next block index of all 1 bits means it is the end of the list.
2662 *
2663 * On the unsized bucket (bucket-0), the 3rd and 4th entries contain
2664 * the chain block size:
2665 *
2666 * entry[2] - upper 16 bits of the chain block size
2667 * entry[3] - lower 16 bits of the chain block size
2668 */
2669#define MAX_CHAIN_BUCKETS 16
2670#define CHAIN_BLK_FLAG (1U << 15)
2671#define CHAIN_BLK_LIST_END 0xFFFFU
2672
2673static int chain_block_buckets[MAX_CHAIN_BUCKETS];
2674
2675static inline int size_to_bucket(int size)
2676{
2677 if (size > MAX_CHAIN_BUCKETS)
2678 return 0;
2679
2680 return size - 1;
2681}
2682
2683/*
2684 * Iterate all the chain blocks in a bucket.
2685 */
2686#define for_each_chain_block(bucket, prev, curr) \
2687 for ((prev) = -1, (curr) = chain_block_buckets[bucket]; \
2688 (curr) >= 0; \
2689 (prev) = (curr), (curr) = chain_block_next(curr))
2690
2691/*
2692 * next block or -1
2693 */
2694static inline int chain_block_next(int offset)
2695{
2696 int next = chain_hlocks[offset];
2697
2698 WARN_ON_ONCE(!(next & CHAIN_BLK_FLAG));
2699
2700 if (next == CHAIN_BLK_LIST_END)
2701 return -1;
2702
2703 next &= ~CHAIN_BLK_FLAG;
2704 next <<= 16;
2705 next |= chain_hlocks[offset + 1];
2706
2707 return next;
2708}
2709
2710/*
2711 * bucket-0 only
2712 */
2713static inline int chain_block_size(int offset)
2714{
2715 return (chain_hlocks[offset + 2] << 16) | chain_hlocks[offset + 3];
2716}
2717
2718static inline void init_chain_block(int offset, int next, int bucket, int size)
2719{
2720 chain_hlocks[offset] = (next >> 16) | CHAIN_BLK_FLAG;
2721 chain_hlocks[offset + 1] = (u16)next;
2722
2723 if (size && !bucket) {
2724 chain_hlocks[offset + 2] = size >> 16;
2725 chain_hlocks[offset + 3] = (u16)size;
2726 }
2727}
2728
2729static inline void add_chain_block(int offset, int size)
2730{
2731 int bucket = size_to_bucket(size);
2732 int next = chain_block_buckets[bucket];
2733 int prev, curr;
2734
2735 if (unlikely(size < 2)) {
2736 /*
2737 * We can't store single entries on the freelist. Leak them.
2738 *
2739 * One possible way out would be to uniquely mark them, other
2740 * than with CHAIN_BLK_FLAG, such that we can recover them when
2741 * the block before it is re-added.
2742 */
2743 if (size)
2744 nr_lost_chain_hlocks++;
2745 return;
2746 }
2747
2748 nr_free_chain_hlocks += size;
2749 if (!bucket) {
2750 nr_large_chain_blocks++;
2751
2752 /*
2753 * Variable sized, sort large to small.
2754 */
2755 for_each_chain_block(0, prev, curr) {
2756 if (size >= chain_block_size(curr))
2757 break;
2758 }
2759 init_chain_block(offset, curr, 0, size);
2760 if (prev < 0)
2761 chain_block_buckets[0] = offset;
2762 else
2763 init_chain_block(prev, offset, 0, 0);
2764 return;
2765 }
2766 /*
2767 * Fixed size, add to head.
2768 */
2769 init_chain_block(offset, next, bucket, size);
2770 chain_block_buckets[bucket] = offset;
2771}
2772
2773/*
2774 * Only the first block in the list can be deleted.
2775 *
2776 * For the variable size bucket[0], the first block (the largest one) is
2777 * returned, broken up and put back into the pool. So if a chain block of
2778 * length > MAX_CHAIN_BUCKETS is ever used and zapped, it will just be
2779 * queued up after the primordial chain block and never be used until the
2780 * hlock entries in the primordial chain block is almost used up. That
2781 * causes fragmentation and reduce allocation efficiency. That can be
2782 * monitored by looking at the "large chain blocks" number in lockdep_stats.
2783 */
2784static inline void del_chain_block(int bucket, int size, int next)
2785{
2786 nr_free_chain_hlocks -= size;
2787 chain_block_buckets[bucket] = next;
2788
2789 if (!bucket)
2790 nr_large_chain_blocks--;
2791}
2792
2793static void init_chain_block_buckets(void)
2794{
2795 int i;
2796
2797 for (i = 0; i < MAX_CHAIN_BUCKETS; i++)
2798 chain_block_buckets[i] = -1;
2799
2800 add_chain_block(0, ARRAY_SIZE(chain_hlocks));
2801}
2802
2803/*
2804 * Return offset of a chain block of the right size or -1 if not found.
2805 *
2806 * Fairly simple worst-fit allocator with the addition of a number of size
2807 * specific free lists.
2808 */
2809static int alloc_chain_hlocks(int req)
2810{
2811 int bucket, curr, size;
2812
2813 /*
2814 * We rely on the MSB to act as an escape bit to denote freelist
2815 * pointers. Make sure this bit isn't set in 'normal' class_idx usage.
2816 */
2817 BUILD_BUG_ON((MAX_LOCKDEP_KEYS-1) & CHAIN_BLK_FLAG);
2818
2819 init_data_structures_once();
2820
2821 if (nr_free_chain_hlocks < req)
2822 return -1;
2823
2824 /*
2825 * We require a minimum of 2 (u16) entries to encode a freelist
2826 * 'pointer'.
2827 */
2828 req = max(req, 2);
2829 bucket = size_to_bucket(req);
2830 curr = chain_block_buckets[bucket];
2831
2832 if (bucket) {
2833 if (curr >= 0) {
2834 del_chain_block(bucket, req, chain_block_next(curr));
2835 return curr;
2836 }
2837 /* Try bucket 0 */
2838 curr = chain_block_buckets[0];
2839 }
2840
2841 /*
2842 * The variable sized freelist is sorted by size; the first entry is
2843 * the largest. Use it if it fits.
2844 */
2845 if (curr >= 0) {
2846 size = chain_block_size(curr);
2847 if (likely(size >= req)) {
2848 del_chain_block(0, size, chain_block_next(curr));
2849 add_chain_block(curr + req, size - req);
2850 return curr;
2851 }
2852 }
2853
2854 /*
2855 * Last resort, split a block in a larger sized bucket.
2856 */
2857 for (size = MAX_CHAIN_BUCKETS; size > req; size--) {
2858 bucket = size_to_bucket(size);
2859 curr = chain_block_buckets[bucket];
2860 if (curr < 0)
2861 continue;
2862
2863 del_chain_block(bucket, size, chain_block_next(curr));
2864 add_chain_block(curr + req, size - req);
2865 return curr;
2866 }
2867
2868 return -1;
2869}
2870
2871static inline void free_chain_hlocks(int base, int size)
2872{
2873 add_chain_block(base, max(size, 2));
2874}
443cd507
YH
2875
2876struct lock_class *lock_chain_get_class(struct lock_chain *chain, int i)
2877{
2878 return lock_classes + chain_hlocks[chain->base + i];
2879}
8e18257d 2880
9e4e7554
IM
2881/*
2882 * Returns the index of the first held_lock of the current chain
2883 */
2884static inline int get_first_held_lock(struct task_struct *curr,
2885 struct held_lock *hlock)
2886{
2887 int i;
2888 struct held_lock *hlock_curr;
2889
2890 for (i = curr->lockdep_depth - 1; i >= 0; i--) {
2891 hlock_curr = curr->held_locks + i;
2892 if (hlock_curr->irq_context != hlock->irq_context)
2893 break;
2894
2895 }
2896
2897 return ++i;
2898}
2899
5c8a010c 2900#ifdef CONFIG_DEBUG_LOCKDEP
39e2e173
AAF
2901/*
2902 * Returns the next chain_key iteration
2903 */
2904static u64 print_chain_key_iteration(int class_idx, u64 chain_key)
2905{
2906 u64 new_chain_key = iterate_chain_key(chain_key, class_idx);
2907
2908 printk(" class_idx:%d -> chain_key:%016Lx",
2909 class_idx,
2910 (unsigned long long)new_chain_key);
2911 return new_chain_key;
2912}
2913
2914static void
2915print_chain_keys_held_locks(struct task_struct *curr, struct held_lock *hlock_next)
2916{
2917 struct held_lock *hlock;
f6ec8829 2918 u64 chain_key = INITIAL_CHAIN_KEY;
39e2e173 2919 int depth = curr->lockdep_depth;
834494b2 2920 int i = get_first_held_lock(curr, hlock_next);
39e2e173 2921
834494b2
YD
2922 printk("depth: %u (irq_context %u)\n", depth - i + 1,
2923 hlock_next->irq_context);
2924 for (; i < depth; i++) {
39e2e173
AAF
2925 hlock = curr->held_locks + i;
2926 chain_key = print_chain_key_iteration(hlock->class_idx, chain_key);
2927
2928 print_lock(hlock);
2929 }
2930
2931 print_chain_key_iteration(hlock_next->class_idx, chain_key);
2932 print_lock(hlock_next);
2933}
2934
2935static void print_chain_keys_chain(struct lock_chain *chain)
2936{
2937 int i;
f6ec8829 2938 u64 chain_key = INITIAL_CHAIN_KEY;
39e2e173
AAF
2939 int class_id;
2940
2941 printk("depth: %u\n", chain->depth);
2942 for (i = 0; i < chain->depth; i++) {
2943 class_id = chain_hlocks[chain->base + i];
01bb6f0a 2944 chain_key = print_chain_key_iteration(class_id, chain_key);
39e2e173
AAF
2945
2946 print_lock_name(lock_classes + class_id);
2947 printk("\n");
2948 }
2949}
2950
2951static void print_collision(struct task_struct *curr,
2952 struct held_lock *hlock_next,
2953 struct lock_chain *chain)
2954{
681fbec8 2955 pr_warn("\n");
a5dd63ef
PM
2956 pr_warn("============================\n");
2957 pr_warn("WARNING: chain_key collision\n");
39e2e173 2958 print_kernel_ident();
a5dd63ef 2959 pr_warn("----------------------------\n");
681fbec8
PM
2960 pr_warn("%s/%d: ", current->comm, task_pid_nr(current));
2961 pr_warn("Hash chain already cached but the contents don't match!\n");
39e2e173 2962
681fbec8 2963 pr_warn("Held locks:");
39e2e173
AAF
2964 print_chain_keys_held_locks(curr, hlock_next);
2965
681fbec8 2966 pr_warn("Locks in cached chain:");
39e2e173
AAF
2967 print_chain_keys_chain(chain);
2968
681fbec8 2969 pr_warn("\nstack backtrace:\n");
39e2e173
AAF
2970 dump_stack();
2971}
5c8a010c 2972#endif
39e2e173 2973
9e4e7554
IM
2974/*
2975 * Checks whether the chain and the current held locks are consistent
2976 * in depth and also in content. If they are not it most likely means
2977 * that there was a collision during the calculation of the chain_key.
2978 * Returns: 0 not passed, 1 passed
2979 */
2980static int check_no_collision(struct task_struct *curr,
2981 struct held_lock *hlock,
2982 struct lock_chain *chain)
2983{
2984#ifdef CONFIG_DEBUG_LOCKDEP
2985 int i, j, id;
2986
2987 i = get_first_held_lock(curr, hlock);
2988
39e2e173
AAF
2989 if (DEBUG_LOCKS_WARN_ON(chain->depth != curr->lockdep_depth - (i - 1))) {
2990 print_collision(curr, hlock, chain);
9e4e7554 2991 return 0;
39e2e173 2992 }
9e4e7554
IM
2993
2994 for (j = 0; j < chain->depth - 1; j++, i++) {
01bb6f0a 2995 id = curr->held_locks[i].class_idx;
9e4e7554 2996
39e2e173
AAF
2997 if (DEBUG_LOCKS_WARN_ON(chain_hlocks[chain->base + j] != id)) {
2998 print_collision(curr, hlock, chain);
9e4e7554 2999 return 0;
39e2e173 3000 }
9e4e7554
IM
3001 }
3002#endif
3003 return 1;
3004}
3005
2212684a
BVA
3006/*
3007 * Given an index that is >= -1, return the index of the next lock chain.
3008 * Return -2 if there is no next lock chain.
3009 */
3010long lockdep_next_lockchain(long i)
3011{
de4643a7
BVA
3012 i = find_next_bit(lock_chains_in_use, ARRAY_SIZE(lock_chains), i + 1);
3013 return i < ARRAY_SIZE(lock_chains) ? i : -2;
2212684a
BVA
3014}
3015
3016unsigned long lock_chain_count(void)
3017{
de4643a7
BVA
3018 return bitmap_weight(lock_chains_in_use, ARRAY_SIZE(lock_chains));
3019}
3020
3021/* Must be called with the graph lock held. */
3022static struct lock_chain *alloc_lock_chain(void)
3023{
3024 int idx = find_first_zero_bit(lock_chains_in_use,
3025 ARRAY_SIZE(lock_chains));
3026
3027 if (unlikely(idx >= ARRAY_SIZE(lock_chains)))
3028 return NULL;
3029 __set_bit(idx, lock_chains_in_use);
3030 return lock_chains + idx;
2212684a
BVA
3031}
3032
fbb9ce95 3033/*
545c23f2
BP
3034 * Adds a dependency chain into chain hashtable. And must be called with
3035 * graph_lock held.
3036 *
3037 * Return 0 if fail, and graph_lock is released.
3038 * Return 1 if succeed, with graph_lock held.
fbb9ce95 3039 */
545c23f2
BP
3040static inline int add_chain_cache(struct task_struct *curr,
3041 struct held_lock *hlock,
3042 u64 chain_key)
fbb9ce95 3043{
f82b217e 3044 struct lock_class *class = hlock_class(hlock);
a63f38cc 3045 struct hlist_head *hash_head = chainhashentry(chain_key);
fbb9ce95 3046 struct lock_chain *chain;
e0944ee6 3047 int i, j;
fbb9ce95 3048
0119fee4 3049 /*
527af3ea 3050 * The caller must hold the graph lock, ensure we've got IRQs
0119fee4
PZ
3051 * disabled to make this an IRQ-safe lock.. for recursion reasons
3052 * lockdep won't complain about its own locking errors.
3053 */
248efb21 3054 if (lockdep_assert_locked())
381a2292 3055 return 0;
9e4e7554 3056
de4643a7
BVA
3057 chain = alloc_lock_chain();
3058 if (!chain) {
74c383f1
IM
3059 if (!debug_locks_off_graph_unlock())
3060 return 0;
3061
2c522836 3062 print_lockdep_off("BUG: MAX_LOCKDEP_CHAINS too low!");
eedeeabd 3063 dump_stack();
fbb9ce95
IM
3064 return 0;
3065 }
fbb9ce95 3066 chain->chain_key = chain_key;
443cd507 3067 chain->irq_context = hlock->irq_context;
9e4e7554 3068 i = get_first_held_lock(curr, hlock);
443cd507 3069 chain->depth = curr->lockdep_depth + 1 - i;
75dd602a
PZ
3070
3071 BUILD_BUG_ON((1UL << 24) <= ARRAY_SIZE(chain_hlocks));
3072 BUILD_BUG_ON((1UL << 6) <= ARRAY_SIZE(curr->held_locks));
3073 BUILD_BUG_ON((1UL << 8*sizeof(chain_hlocks[0])) <= ARRAY_SIZE(lock_classes));
3074
810507fe
WL
3075 j = alloc_chain_hlocks(chain->depth);
3076 if (j < 0) {
f9af456a 3077 if (!debug_locks_off_graph_unlock())
75dd602a
PZ
3078 return 0;
3079
3080 print_lockdep_off("BUG: MAX_LOCKDEP_CHAIN_HLOCKS too low!");
3081 dump_stack();
3082 return 0;
3083 }
75dd602a 3084
810507fe
WL
3085 chain->base = j;
3086 for (j = 0; j < chain->depth - 1; j++, i++) {
3087 int lock_id = curr->held_locks[i].class_idx;
3088
3089 chain_hlocks[chain->base + j] = lock_id;
3090 }
3091 chain_hlocks[chain->base + j] = class - lock_classes;
a63f38cc 3092 hlist_add_head_rcu(&chain->entry, hash_head);
bd6d29c2 3093 debug_atomic_inc(chain_lookup_misses);
b3b9c187 3094 inc_chains(chain->irq_context);
8e18257d
PZ
3095
3096 return 1;
3097}
3098
545c23f2 3099/*
a0b0fd53
BVA
3100 * Look up a dependency chain. Must be called with either the graph lock or
3101 * the RCU read lock held.
545c23f2
BP
3102 */
3103static inline struct lock_chain *lookup_chain_cache(u64 chain_key)
3104{
3105 struct hlist_head *hash_head = chainhashentry(chain_key);
3106 struct lock_chain *chain;
3107
545c23f2 3108 hlist_for_each_entry_rcu(chain, hash_head, entry) {
a0b0fd53 3109 if (READ_ONCE(chain->chain_key) == chain_key) {
545c23f2
BP
3110 debug_atomic_inc(chain_lookup_hits);
3111 return chain;
3112 }
3113 }
3114 return NULL;
3115}
3116
3117/*
3118 * If the key is not present yet in dependency chain cache then
3119 * add it and return 1 - in this case the new dependency chain is
3120 * validated. If the key is already hashed, return 0.
3121 * (On return with 1 graph_lock is held.)
3122 */
3123static inline int lookup_chain_cache_add(struct task_struct *curr,
3124 struct held_lock *hlock,
3125 u64 chain_key)
3126{
3127 struct lock_class *class = hlock_class(hlock);
3128 struct lock_chain *chain = lookup_chain_cache(chain_key);
3129
3130 if (chain) {
3131cache_hit:
3132 if (!check_no_collision(curr, hlock, chain))
3133 return 0;
3134
3135 if (very_verbose(class)) {
3136 printk("\nhash chain already cached, key: "
04860d48 3137 "%016Lx tail class: [%px] %s\n",
545c23f2
BP
3138 (unsigned long long)chain_key,
3139 class->key, class->name);
3140 }
3141
3142 return 0;
3143 }
3144
3145 if (very_verbose(class)) {
04860d48 3146 printk("\nnew hash chain, key: %016Lx tail class: [%px] %s\n",
545c23f2
BP
3147 (unsigned long long)chain_key, class->key, class->name);
3148 }
3149
3150 if (!graph_lock())
3151 return 0;
3152
3153 /*
3154 * We have to walk the chain again locked - to avoid duplicates:
3155 */
3156 chain = lookup_chain_cache(chain_key);
3157 if (chain) {
3158 graph_unlock();
3159 goto cache_hit;
3160 }
3161
3162 if (!add_chain_cache(curr, hlock, chain_key))
3163 return 0;
3164
3165 return 1;
3166}
3167
0b9fc8ec
YD
3168static int validate_chain(struct task_struct *curr,
3169 struct held_lock *hlock,
3170 int chain_head, u64 chain_key)
8e18257d
PZ
3171{
3172 /*
3173 * Trylock needs to maintain the stack of held locks, but it
3174 * does not add new dependencies, because trylock can be done
3175 * in any order.
3176 *
3177 * We look up the chain_key and do the O(N^2) check and update of
3178 * the dependencies only if this is a new dependency chain.
545c23f2 3179 * (If lookup_chain_cache_add() return with 1 it acquires
8e18257d
PZ
3180 * graph_lock for us)
3181 */
fb9edbe9 3182 if (!hlock->trylock && hlock->check &&
545c23f2 3183 lookup_chain_cache_add(curr, hlock, chain_key)) {
8e18257d
PZ
3184 /*
3185 * Check whether last held lock:
3186 *
3187 * - is irq-safe, if this lock is irq-unsafe
3188 * - is softirq-safe, if this lock is hardirq-unsafe
3189 *
3190 * And check whether the new lock's dependency graph
31a490e5 3191 * could lead back to the previous lock:
8e18257d 3192 *
31a490e5
YD
3193 * - within the current held-lock stack
3194 * - across our accumulated lock dependency records
3195 *
3196 * any of these scenarios could lead to a deadlock.
3197 */
3198 /*
3199 * The simple case: does the current hold the same lock
3200 * already?
8e18257d 3201 */
4609c4f9 3202 int ret = check_deadlock(curr, hlock);
8e18257d
PZ
3203
3204 if (!ret)
3205 return 0;
3206 /*
3207 * Mark recursive read, as we jump over it when
3208 * building dependencies (just like we jump over
3209 * trylock entries):
3210 */
3211 if (ret == 2)
3212 hlock->read = 2;
3213 /*
3214 * Add dependency only if this lock is not the head
3215 * of the chain, and if it's not a secondary read-lock:
3216 */
545c23f2 3217 if (!chain_head && ret != 2) {
8e18257d
PZ
3218 if (!check_prevs_add(curr, hlock))
3219 return 0;
545c23f2
BP
3220 }
3221
8e18257d 3222 graph_unlock();
545c23f2
BP
3223 } else {
3224 /* after lookup_chain_cache_add(): */
8e18257d
PZ
3225 if (unlikely(!debug_locks))
3226 return 0;
545c23f2 3227 }
fbb9ce95
IM
3228
3229 return 1;
3230}
8e18257d
PZ
3231#else
3232static inline int validate_chain(struct task_struct *curr,
0b9fc8ec
YD
3233 struct held_lock *hlock,
3234 int chain_head, u64 chain_key)
8e18257d
PZ
3235{
3236 return 1;
3237}
810507fe
WL
3238
3239static void init_chain_block_buckets(void) { }
e7a38f63 3240#endif /* CONFIG_PROVE_LOCKING */
fbb9ce95
IM
3241
3242/*
3243 * We are building curr_chain_key incrementally, so double-check
3244 * it from scratch, to make sure that it's done correctly:
3245 */
1d09daa5 3246static void check_chain_key(struct task_struct *curr)
fbb9ce95
IM
3247{
3248#ifdef CONFIG_DEBUG_LOCKDEP
3249 struct held_lock *hlock, *prev_hlock = NULL;
5f18ab5c 3250 unsigned int i;
f6ec8829 3251 u64 chain_key = INITIAL_CHAIN_KEY;
fbb9ce95
IM
3252
3253 for (i = 0; i < curr->lockdep_depth; i++) {
3254 hlock = curr->held_locks + i;
3255 if (chain_key != hlock->prev_chain_key) {
3256 debug_locks_off();
0119fee4
PZ
3257 /*
3258 * We got mighty confused, our chain keys don't match
3259 * with what we expect, someone trample on our task state?
3260 */
2df8b1d6 3261 WARN(1, "hm#1, depth: %u [%u], %016Lx != %016Lx\n",
fbb9ce95
IM
3262 curr->lockdep_depth, i,
3263 (unsigned long long)chain_key,
3264 (unsigned long long)hlock->prev_chain_key);
fbb9ce95
IM
3265 return;
3266 }
01bb6f0a 3267
0119fee4 3268 /*
01bb6f0a
YD
3269 * hlock->class_idx can't go beyond MAX_LOCKDEP_KEYS, but is
3270 * it registered lock class index?
0119fee4 3271 */
01bb6f0a 3272 if (DEBUG_LOCKS_WARN_ON(!test_bit(hlock->class_idx, lock_classes_in_use)))
381a2292
JP
3273 return;
3274
fbb9ce95
IM
3275 if (prev_hlock && (prev_hlock->irq_context !=
3276 hlock->irq_context))
f6ec8829 3277 chain_key = INITIAL_CHAIN_KEY;
5f18ab5c 3278 chain_key = iterate_chain_key(chain_key, hlock->class_idx);
fbb9ce95
IM
3279 prev_hlock = hlock;
3280 }
3281 if (chain_key != curr->curr_chain_key) {
3282 debug_locks_off();
0119fee4
PZ
3283 /*
3284 * More smoking hash instead of calculating it, damn see these
3285 * numbers float.. I bet that a pink elephant stepped on my memory.
3286 */
2df8b1d6 3287 WARN(1, "hm#2, depth: %u [%u], %016Lx != %016Lx\n",
fbb9ce95
IM
3288 curr->lockdep_depth, i,
3289 (unsigned long long)chain_key,
3290 (unsigned long long)curr->curr_chain_key);
fbb9ce95
IM
3291 }
3292#endif
3293}
3294
30a35f79 3295#ifdef CONFIG_PROVE_LOCKING
0d2cc3b3
FW
3296static int mark_lock(struct task_struct *curr, struct held_lock *this,
3297 enum lock_usage_bit new_bit);
3298
f7c1c6b3 3299static void print_usage_bug_scenario(struct held_lock *lock)
282b5c2f
SR
3300{
3301 struct lock_class *class = hlock_class(lock);
3302
3303 printk(" Possible unsafe locking scenario:\n\n");
3304 printk(" CPU0\n");
3305 printk(" ----\n");
3306 printk(" lock(");
3307 __print_lock_name(class);
f943fe0f 3308 printk(KERN_CONT ");\n");
282b5c2f
SR
3309 printk(" <Interrupt>\n");
3310 printk(" lock(");
3311 __print_lock_name(class);
f943fe0f 3312 printk(KERN_CONT ");\n");
282b5c2f
SR
3313 printk("\n *** DEADLOCK ***\n\n");
3314}
3315
f7c1c6b3 3316static void
8e18257d
PZ
3317print_usage_bug(struct task_struct *curr, struct held_lock *this,
3318 enum lock_usage_bit prev_bit, enum lock_usage_bit new_bit)
3319{
3320 if (!debug_locks_off_graph_unlock() || debug_locks_silent)
f7c1c6b3 3321 return;
8e18257d 3322
681fbec8 3323 pr_warn("\n");
a5dd63ef
PM
3324 pr_warn("================================\n");
3325 pr_warn("WARNING: inconsistent lock state\n");
fbdc4b9a 3326 print_kernel_ident();
a5dd63ef 3327 pr_warn("--------------------------------\n");
8e18257d 3328
681fbec8 3329 pr_warn("inconsistent {%s} -> {%s} usage.\n",
8e18257d
PZ
3330 usage_str[prev_bit], usage_str[new_bit]);
3331
681fbec8 3332 pr_warn("%s/%d [HC%u[%lu]:SC%u[%lu]:HE%u:SE%u] takes:\n",
ba25f9dc 3333 curr->comm, task_pid_nr(curr),
ef996916
PZ
3334 lockdep_hardirq_context(curr), hardirq_count() >> HARDIRQ_SHIFT,
3335 lockdep_softirq_context(curr), softirq_count() >> SOFTIRQ_SHIFT,
3336 lockdep_hardirqs_enabled(curr),
3337 lockdep_softirqs_enabled(curr));
8e18257d
PZ
3338 print_lock(this);
3339
681fbec8 3340 pr_warn("{%s} state was registered at:\n", usage_str[prev_bit]);
12593b74 3341 print_lock_trace(hlock_class(this)->usage_traces[prev_bit], 1);
8e18257d
PZ
3342
3343 print_irqtrace_events(curr);
681fbec8 3344 pr_warn("\nother info that might help us debug this:\n");
282b5c2f
SR
3345 print_usage_bug_scenario(this);
3346
8e18257d
PZ
3347 lockdep_print_held_locks(curr);
3348
681fbec8 3349 pr_warn("\nstack backtrace:\n");
8e18257d 3350 dump_stack();
8e18257d
PZ
3351}
3352
3353/*
3354 * Print out an error if an invalid bit is set:
3355 */
3356static inline int
3357valid_state(struct task_struct *curr, struct held_lock *this,
3358 enum lock_usage_bit new_bit, enum lock_usage_bit bad_bit)
3359{
f7c1c6b3
YD
3360 if (unlikely(hlock_class(this)->usage_mask & (1 << bad_bit))) {
3361 print_usage_bug(curr, this, bad_bit, new_bit);
3362 return 0;
3363 }
8e18257d
PZ
3364 return 1;
3365}
3366
fbb9ce95
IM
3367
3368/*
3369 * print irq inversion bug:
3370 */
f7c1c6b3 3371static void
24208ca7
ML
3372print_irq_inversion_bug(struct task_struct *curr,
3373 struct lock_list *root, struct lock_list *other,
fbb9ce95
IM
3374 struct held_lock *this, int forwards,
3375 const char *irqclass)
3376{
dad3d743
SR
3377 struct lock_list *entry = other;
3378 struct lock_list *middle = NULL;
3379 int depth;
3380
74c383f1 3381 if (!debug_locks_off_graph_unlock() || debug_locks_silent)
f7c1c6b3 3382 return;
fbb9ce95 3383
681fbec8 3384 pr_warn("\n");
a5dd63ef
PM
3385 pr_warn("========================================================\n");
3386 pr_warn("WARNING: possible irq lock inversion dependency detected\n");
fbdc4b9a 3387 print_kernel_ident();
a5dd63ef 3388 pr_warn("--------------------------------------------------------\n");
681fbec8 3389 pr_warn("%s/%d just changed the state of lock:\n",
ba25f9dc 3390 curr->comm, task_pid_nr(curr));
fbb9ce95
IM
3391 print_lock(this);
3392 if (forwards)
681fbec8 3393 pr_warn("but this lock took another, %s-unsafe lock in the past:\n", irqclass);
fbb9ce95 3394 else
681fbec8 3395 pr_warn("but this lock was taken by another, %s-safe lock in the past:\n", irqclass);
24208ca7 3396 print_lock_name(other->class);
681fbec8 3397 pr_warn("\n\nand interrupts could create inverse lock ordering between them.\n\n");
fbb9ce95 3398
681fbec8 3399 pr_warn("\nother info that might help us debug this:\n");
dad3d743
SR
3400
3401 /* Find a middle lock (if one exists) */
3402 depth = get_lock_depth(other);
3403 do {
3404 if (depth == 0 && (entry != root)) {
681fbec8 3405 pr_warn("lockdep:%s bad path found in chain graph\n", __func__);
dad3d743
SR
3406 break;
3407 }
3408 middle = entry;
3409 entry = get_lock_parent(entry);
3410 depth--;
3411 } while (entry && entry != root && (depth >= 0));
3412 if (forwards)
3413 print_irq_lock_scenario(root, other,
3414 middle ? middle->class : root->class, other->class);
3415 else
3416 print_irq_lock_scenario(other, root,
3417 middle ? middle->class : other->class, root->class);
3418
fbb9ce95
IM
3419 lockdep_print_held_locks(curr);
3420
681fbec8 3421 pr_warn("\nthe shortest dependencies between 2nd lock and 1st lock:\n");
12593b74
BVA
3422 root->trace = save_trace();
3423 if (!root->trace)
f7c1c6b3 3424 return;
24208ca7 3425 print_shortest_lock_dependencies(other, root);
fbb9ce95 3426
681fbec8 3427 pr_warn("\nstack backtrace:\n");
fbb9ce95 3428 dump_stack();
fbb9ce95
IM
3429}
3430
3431/*
3432 * Prove that in the forwards-direction subgraph starting at <this>
3433 * there is no lock matching <mask>:
3434 */
3435static int
3436check_usage_forwards(struct task_struct *curr, struct held_lock *this,
3437 enum lock_usage_bit bit, const char *irqclass)
3438{
3439 int ret;
d7aaba14 3440 struct lock_list root;
3f649ab7 3441 struct lock_list *target_entry;
fbb9ce95 3442
d7aaba14
ML
3443 root.parent = NULL;
3444 root.class = hlock_class(this);
627f364d 3445 ret = find_usage_forwards(&root, lock_flag(bit), &target_entry);
f7c1c6b3
YD
3446 if (ret < 0) {
3447 print_bfs_bug(ret);
3448 return 0;
3449 }
af012961
PZ
3450 if (ret == 1)
3451 return ret;
fbb9ce95 3452
f7c1c6b3
YD
3453 print_irq_inversion_bug(curr, &root, target_entry,
3454 this, 1, irqclass);
3455 return 0;
fbb9ce95
IM
3456}
3457
3458/*
3459 * Prove that in the backwards-direction subgraph starting at <this>
3460 * there is no lock matching <mask>:
3461 */
3462static int
3463check_usage_backwards(struct task_struct *curr, struct held_lock *this,
3464 enum lock_usage_bit bit, const char *irqclass)
3465{
3466 int ret;
d7aaba14 3467 struct lock_list root;
3f649ab7 3468 struct lock_list *target_entry;
fbb9ce95 3469
d7aaba14
ML
3470 root.parent = NULL;
3471 root.class = hlock_class(this);
627f364d 3472 ret = find_usage_backwards(&root, lock_flag(bit), &target_entry);
f7c1c6b3
YD
3473 if (ret < 0) {
3474 print_bfs_bug(ret);
3475 return 0;
3476 }
af012961
PZ
3477 if (ret == 1)
3478 return ret;
fbb9ce95 3479
f7c1c6b3
YD
3480 print_irq_inversion_bug(curr, &root, target_entry,
3481 this, 0, irqclass);
3482 return 0;
fbb9ce95
IM
3483}
3484
3117df04 3485void print_irqtrace_events(struct task_struct *curr)
fbb9ce95
IM
3486{
3487 printk("irq event stamp: %u\n", curr->irq_events);
04860d48 3488 printk("hardirqs last enabled at (%u): [<%px>] %pS\n",
f943fe0f
DV
3489 curr->hardirq_enable_event, (void *)curr->hardirq_enable_ip,
3490 (void *)curr->hardirq_enable_ip);
04860d48 3491 printk("hardirqs last disabled at (%u): [<%px>] %pS\n",
f943fe0f
DV
3492 curr->hardirq_disable_event, (void *)curr->hardirq_disable_ip,
3493 (void *)curr->hardirq_disable_ip);
04860d48 3494 printk("softirqs last enabled at (%u): [<%px>] %pS\n",
f943fe0f
DV
3495 curr->softirq_enable_event, (void *)curr->softirq_enable_ip,
3496 (void *)curr->softirq_enable_ip);
04860d48 3497 printk("softirqs last disabled at (%u): [<%px>] %pS\n",
f943fe0f
DV
3498 curr->softirq_disable_event, (void *)curr->softirq_disable_ip,
3499 (void *)curr->softirq_disable_ip);
fbb9ce95
IM
3500}
3501
cd95302d 3502static int HARDIRQ_verbose(struct lock_class *class)
fbb9ce95 3503{
8e18257d
PZ
3504#if HARDIRQ_VERBOSE
3505 return class_filter(class);
3506#endif
fbb9ce95
IM
3507 return 0;
3508}
3509
cd95302d 3510static int SOFTIRQ_verbose(struct lock_class *class)
fbb9ce95 3511{
8e18257d
PZ
3512#if SOFTIRQ_VERBOSE
3513 return class_filter(class);
3514#endif
3515 return 0;
fbb9ce95
IM
3516}
3517
3518#define STRICT_READ_CHECKS 1
3519
cd95302d
PZ
3520static int (*state_verbose_f[])(struct lock_class *class) = {
3521#define LOCKDEP_STATE(__STATE) \
3522 __STATE##_verbose,
3523#include "lockdep_states.h"
3524#undef LOCKDEP_STATE
3525};
3526
3527static inline int state_verbose(enum lock_usage_bit bit,
3528 struct lock_class *class)
3529{
c902a1e8 3530 return state_verbose_f[bit >> LOCK_USAGE_DIR_MASK](class);
cd95302d
PZ
3531}
3532
42c50d54
PZ
3533typedef int (*check_usage_f)(struct task_struct *, struct held_lock *,
3534 enum lock_usage_bit bit, const char *name);
3535
6a6904d3 3536static int
1c21f14e
PZ
3537mark_lock_irq(struct task_struct *curr, struct held_lock *this,
3538 enum lock_usage_bit new_bit)
6a6904d3 3539{
f989209e 3540 int excl_bit = exclusive_bit(new_bit);
bba2a8f1
FW
3541 int read = new_bit & LOCK_USAGE_READ_MASK;
3542 int dir = new_bit & LOCK_USAGE_DIR_MASK;
42c50d54 3543
38aa2714
PZ
3544 /*
3545 * mark USED_IN has to look forwards -- to ensure no dependency
3546 * has ENABLED state, which would allow recursion deadlocks.
3547 *
3548 * mark ENABLED has to look backwards -- to ensure no dependee
3549 * has USED_IN state, which, again, would allow recursion deadlocks.
3550 */
42c50d54
PZ
3551 check_usage_f usage = dir ?
3552 check_usage_backwards : check_usage_forwards;
f989209e 3553
38aa2714
PZ
3554 /*
3555 * Validate that this particular lock does not have conflicting
3556 * usage states.
3557 */
6a6904d3
PZ
3558 if (!valid_state(curr, this, new_bit, excl_bit))
3559 return 0;
42c50d54 3560
38aa2714
PZ
3561 /*
3562 * Validate that the lock dependencies don't have conflicting usage
3563 * states.
3564 */
bf998b98 3565 if ((!read || STRICT_READ_CHECKS) &&
bba2a8f1 3566 !usage(curr, this, excl_bit, state_name(new_bit & ~LOCK_USAGE_READ_MASK)))
6a6904d3 3567 return 0;
780e820b 3568
38aa2714
PZ
3569 /*
3570 * Check for read in write conflicts
3571 */
3572 if (!read) {
bba2a8f1 3573 if (!valid_state(curr, this, new_bit, excl_bit + LOCK_USAGE_READ_MASK))
38aa2714
PZ
3574 return 0;
3575
3576 if (STRICT_READ_CHECKS &&
bba2a8f1
FW
3577 !usage(curr, this, excl_bit + LOCK_USAGE_READ_MASK,
3578 state_name(new_bit + LOCK_USAGE_READ_MASK)))
38aa2714
PZ
3579 return 0;
3580 }
780e820b 3581
cd95302d 3582 if (state_verbose(new_bit, hlock_class(this)))
6a6904d3
PZ
3583 return 2;
3584
3585 return 1;
3586}
3587
fbb9ce95
IM
3588/*
3589 * Mark all held locks with a usage bit:
3590 */
1d09daa5 3591static int
436a49ae 3592mark_held_locks(struct task_struct *curr, enum lock_usage_bit base_bit)
fbb9ce95 3593{
fbb9ce95
IM
3594 struct held_lock *hlock;
3595 int i;
3596
3597 for (i = 0; i < curr->lockdep_depth; i++) {
436a49ae 3598 enum lock_usage_bit hlock_bit = base_bit;
fbb9ce95
IM
3599 hlock = curr->held_locks + i;
3600
cf2ad4d1 3601 if (hlock->read)
bba2a8f1 3602 hlock_bit += LOCK_USAGE_READ_MASK;
cf2ad4d1 3603
436a49ae 3604 BUG_ON(hlock_bit >= LOCK_USAGE_STATES);
cf40bd16 3605
34d0ed5e 3606 if (!hlock->check)
efbe2eee
PZ
3607 continue;
3608
436a49ae 3609 if (!mark_lock(curr, hlock, hlock_bit))
fbb9ce95
IM
3610 return 0;
3611 }
3612
3613 return 1;
3614}
3615
fbb9ce95
IM
3616/*
3617 * Hardirqs will be enabled:
3618 */
c86e9b98 3619static void __trace_hardirqs_on_caller(void)
fbb9ce95
IM
3620{
3621 struct task_struct *curr = current;
fbb9ce95 3622
fbb9ce95
IM
3623 /*
3624 * We are going to turn hardirqs on, so set the
3625 * usage bit for all held locks:
3626 */
436a49ae 3627 if (!mark_held_locks(curr, LOCK_ENABLED_HARDIRQ))
fbb9ce95
IM
3628 return;
3629 /*
3630 * If we have softirqs enabled, then set the usage
3631 * bit for all held locks. (disabled hardirqs prevented
3632 * this bit from being set before)
3633 */
3634 if (curr->softirqs_enabled)
c86e9b98 3635 mark_held_locks(curr, LOCK_ENABLED_SOFTIRQ);
8e18257d 3636}
dd4e5d3a 3637
c86e9b98
PZ
3638/**
3639 * lockdep_hardirqs_on_prepare - Prepare for enabling interrupts
3640 * @ip: Caller address
3641 *
3642 * Invoked before a possible transition to RCU idle from exit to user or
3643 * guest mode. This ensures that all RCU operations are done before RCU
3644 * stops watching. After the RCU transition lockdep_hardirqs_on() has to be
3645 * invoked to set the final state.
3646 */
3647void lockdep_hardirqs_on_prepare(unsigned long ip)
dd4e5d3a 3648{
dd4e5d3a
PZ
3649 if (unlikely(!debug_locks || current->lockdep_recursion))
3650 return;
3651
7d36b26b
PZ
3652 if (unlikely(current->hardirqs_enabled)) {
3653 /*
3654 * Neither irq nor preemption are disabled here
3655 * so this is racy by nature but losing one hit
3656 * in a stat is not a big deal.
3657 */
3658 __debug_atomic_inc(redundant_hardirqs_on);
3659 return;
3660 }
3661
0119fee4
PZ
3662 /*
3663 * We're enabling irqs and according to our state above irqs weren't
3664 * already enabled, yet we find the hardware thinks they are in fact
3665 * enabled.. someone messed up their IRQ state tracing.
3666 */
dd4e5d3a
PZ
3667 if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
3668 return;
3669
0119fee4
PZ
3670 /*
3671 * See the fine text that goes along with this variable definition.
3672 */
d671002b 3673 if (DEBUG_LOCKS_WARN_ON(early_boot_irqs_disabled))
7d36b26b
PZ
3674 return;
3675
0119fee4
PZ
3676 /*
3677 * Can't allow enabling interrupts while in an interrupt handler,
3678 * that's general bad form and such. Recursion, limited stack etc..
3679 */
7d36b26b
PZ
3680 if (DEBUG_LOCKS_WARN_ON(current->hardirq_context))
3681 return;
3682
c86e9b98
PZ
3683 current->hardirq_chain_key = current->curr_chain_key;
3684
10476e63 3685 current->lockdep_recursion++;
c86e9b98 3686 __trace_hardirqs_on_caller();
10476e63 3687 lockdep_recursion_finish();
dd4e5d3a 3688}
c86e9b98
PZ
3689EXPORT_SYMBOL_GPL(lockdep_hardirqs_on_prepare);
3690
3691void noinstr lockdep_hardirqs_on(unsigned long ip)
3692{
3693 struct task_struct *curr = current;
3694
3695 if (unlikely(!debug_locks || curr->lockdep_recursion))
3696 return;
3697
3698 if (curr->hardirqs_enabled) {
3699 /*
3700 * Neither irq nor preemption are disabled here
3701 * so this is racy by nature but losing one hit
3702 * in a stat is not a big deal.
3703 */
3704 __debug_atomic_inc(redundant_hardirqs_on);
3705 return;
3706 }
3707
3708 /*
3709 * We're enabling irqs and according to our state above irqs weren't
3710 * already enabled, yet we find the hardware thinks they are in fact
3711 * enabled.. someone messed up their IRQ state tracing.
3712 */
3713 if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
3714 return;
3715
3716 /*
3717 * Ensure the lock stack remained unchanged between
3718 * lockdep_hardirqs_on_prepare() and lockdep_hardirqs_on().
3719 */
3720 DEBUG_LOCKS_WARN_ON(current->hardirq_chain_key !=
3721 current->curr_chain_key);
3722
3723 /* we'll do an OFF -> ON transition: */
3724 curr->hardirqs_enabled = 1;
3725 curr->hardirq_enable_ip = ip;
3726 curr->hardirq_enable_event = ++curr->irq_events;
3727 debug_atomic_inc(hardirqs_on_events);
3728}
3729EXPORT_SYMBOL_GPL(lockdep_hardirqs_on);
8e18257d
PZ
3730
3731/*
3732 * Hardirqs were disabled:
3733 */
c86e9b98 3734void noinstr lockdep_hardirqs_off(unsigned long ip)
8e18257d
PZ
3735{
3736 struct task_struct *curr = current;
3737
c86e9b98 3738 if (unlikely(!debug_locks || curr->lockdep_recursion))
8e18257d
PZ
3739 return;
3740
0119fee4
PZ
3741 /*
3742 * So we're supposed to get called after you mask local IRQs, but for
3743 * some reason the hardware doesn't quite think you did a proper job.
3744 */
8e18257d
PZ
3745 if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
3746 return;
3747
3748 if (curr->hardirqs_enabled) {
3749 /*
3750 * We have done an ON -> OFF transition:
3751 */
3752 curr->hardirqs_enabled = 0;
6afe40b4 3753 curr->hardirq_disable_ip = ip;
8e18257d 3754 curr->hardirq_disable_event = ++curr->irq_events;
bd6d29c2 3755 debug_atomic_inc(hardirqs_off_events);
c86e9b98 3756 } else {
bd6d29c2 3757 debug_atomic_inc(redundant_hardirqs_off);
c86e9b98 3758 }
8e18257d 3759}
c86e9b98 3760EXPORT_SYMBOL_GPL(lockdep_hardirqs_off);
8e18257d
PZ
3761
3762/*
3763 * Softirqs will be enabled:
3764 */
0d38453c 3765void lockdep_softirqs_on(unsigned long ip)
8e18257d
PZ
3766{
3767 struct task_struct *curr = current;
3768
dd4e5d3a 3769 if (unlikely(!debug_locks || current->lockdep_recursion))
8e18257d
PZ
3770 return;
3771
0119fee4
PZ
3772 /*
3773 * We fancy IRQs being disabled here, see softirq.c, avoids
3774 * funny state and nesting things.
3775 */
8e18257d
PZ
3776 if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
3777 return;
3778
3779 if (curr->softirqs_enabled) {
bd6d29c2 3780 debug_atomic_inc(redundant_softirqs_on);
8e18257d
PZ
3781 return;
3782 }
3783
10476e63 3784 current->lockdep_recursion++;
8e18257d
PZ
3785 /*
3786 * We'll do an OFF -> ON transition:
3787 */
3788 curr->softirqs_enabled = 1;
3789 curr->softirq_enable_ip = ip;
3790 curr->softirq_enable_event = ++curr->irq_events;
bd6d29c2 3791 debug_atomic_inc(softirqs_on_events);
8e18257d
PZ
3792 /*
3793 * We are going to turn softirqs on, so set the
3794 * usage bit for all held locks, if hardirqs are
3795 * enabled too:
3796 */
3797 if (curr->hardirqs_enabled)
436a49ae 3798 mark_held_locks(curr, LOCK_ENABLED_SOFTIRQ);
10476e63 3799 lockdep_recursion_finish();
8e18257d
PZ
3800}
3801
3802/*
3803 * Softirqs were disabled:
3804 */
0d38453c 3805void lockdep_softirqs_off(unsigned long ip)
8e18257d
PZ
3806{
3807 struct task_struct *curr = current;
3808
dd4e5d3a 3809 if (unlikely(!debug_locks || current->lockdep_recursion))
8e18257d
PZ
3810 return;
3811
0119fee4
PZ
3812 /*
3813 * We fancy IRQs being disabled here, see softirq.c
3814 */
8e18257d
PZ
3815 if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
3816 return;
3817
3818 if (curr->softirqs_enabled) {
3819 /*
3820 * We have done an ON -> OFF transition:
3821 */
3822 curr->softirqs_enabled = 0;
3823 curr->softirq_disable_ip = ip;
3824 curr->softirq_disable_event = ++curr->irq_events;
bd6d29c2 3825 debug_atomic_inc(softirqs_off_events);
0119fee4
PZ
3826 /*
3827 * Whoops, we wanted softirqs off, so why aren't they?
3828 */
8e18257d
PZ
3829 DEBUG_LOCKS_WARN_ON(!softirq_count());
3830 } else
bd6d29c2 3831 debug_atomic_inc(redundant_softirqs_off);
8e18257d
PZ
3832}
3833
09180651
YD
3834static int
3835mark_usage(struct task_struct *curr, struct held_lock *hlock, int check)
8e18257d 3836{
09180651
YD
3837 if (!check)
3838 goto lock_used;
3839
8e18257d
PZ
3840 /*
3841 * If non-trylock use in a hardirq or softirq context, then
3842 * mark the lock as used in these contexts:
3843 */
3844 if (!hlock->trylock) {
3845 if (hlock->read) {
3846 if (curr->hardirq_context)
3847 if (!mark_lock(curr, hlock,
3848 LOCK_USED_IN_HARDIRQ_READ))
3849 return 0;
3850 if (curr->softirq_context)
3851 if (!mark_lock(curr, hlock,
3852 LOCK_USED_IN_SOFTIRQ_READ))
3853 return 0;
3854 } else {
3855 if (curr->hardirq_context)
3856 if (!mark_lock(curr, hlock, LOCK_USED_IN_HARDIRQ))
3857 return 0;
3858 if (curr->softirq_context)
3859 if (!mark_lock(curr, hlock, LOCK_USED_IN_SOFTIRQ))
3860 return 0;
3861 }
3862 }
3863 if (!hlock->hardirqs_off) {
3864 if (hlock->read) {
3865 if (!mark_lock(curr, hlock,
4fc95e86 3866 LOCK_ENABLED_HARDIRQ_READ))
8e18257d
PZ
3867 return 0;
3868 if (curr->softirqs_enabled)
3869 if (!mark_lock(curr, hlock,
4fc95e86 3870 LOCK_ENABLED_SOFTIRQ_READ))
8e18257d
PZ
3871 return 0;
3872 } else {
3873 if (!mark_lock(curr, hlock,
4fc95e86 3874 LOCK_ENABLED_HARDIRQ))
8e18257d
PZ
3875 return 0;
3876 if (curr->softirqs_enabled)
3877 if (!mark_lock(curr, hlock,
4fc95e86 3878 LOCK_ENABLED_SOFTIRQ))
8e18257d
PZ
3879 return 0;
3880 }
3881 }
3882
09180651
YD
3883lock_used:
3884 /* mark it as used: */
3885 if (!mark_lock(curr, hlock, LOCK_USED))
3886 return 0;
3887
8e18257d
PZ
3888 return 1;
3889}
3890
c2469756
BF
3891static inline unsigned int task_irq_context(struct task_struct *task)
3892{
b3b9c187
WL
3893 return LOCK_CHAIN_HARDIRQ_CONTEXT * !!task->hardirq_context +
3894 LOCK_CHAIN_SOFTIRQ_CONTEXT * !!task->softirq_context;
c2469756
BF
3895}
3896
8e18257d
PZ
3897static int separate_irq_context(struct task_struct *curr,
3898 struct held_lock *hlock)
3899{
3900 unsigned int depth = curr->lockdep_depth;
3901
3902 /*
3903 * Keep track of points where we cross into an interrupt context:
3904 */
8e18257d
PZ
3905 if (depth) {
3906 struct held_lock *prev_hlock;
3907
3908 prev_hlock = curr->held_locks + depth-1;
3909 /*
3910 * If we cross into another context, reset the
3911 * hash key (this also prevents the checking and the
3912 * adding of the dependency to 'prev'):
3913 */
3914 if (prev_hlock->irq_context != hlock->irq_context)
3915 return 1;
3916 }
3917 return 0;
fbb9ce95
IM
3918}
3919
fbb9ce95 3920/*
8e18257d 3921 * Mark a lock with a usage bit, and validate the state transition:
fbb9ce95 3922 */
1d09daa5 3923static int mark_lock(struct task_struct *curr, struct held_lock *this,
0764d23c 3924 enum lock_usage_bit new_bit)
fbb9ce95 3925{
8e18257d 3926 unsigned int new_mask = 1 << new_bit, ret = 1;
fbb9ce95 3927
4d56330d
YD
3928 if (new_bit >= LOCK_USAGE_STATES) {
3929 DEBUG_LOCKS_WARN_ON(1);
3930 return 0;
3931 }
3932
fbb9ce95 3933 /*
8e18257d
PZ
3934 * If already set then do not dirty the cacheline,
3935 * nor do any checks:
fbb9ce95 3936 */
f82b217e 3937 if (likely(hlock_class(this)->usage_mask & new_mask))
8e18257d
PZ
3938 return 1;
3939
3940 if (!graph_lock())
3941 return 0;
fbb9ce95 3942 /*
25985edc 3943 * Make sure we didn't race:
fbb9ce95 3944 */
f82b217e 3945 if (unlikely(hlock_class(this)->usage_mask & new_mask)) {
8e18257d
PZ
3946 graph_unlock();
3947 return 1;
3948 }
fbb9ce95 3949
f82b217e 3950 hlock_class(this)->usage_mask |= new_mask;
fbb9ce95 3951
12593b74 3952 if (!(hlock_class(this)->usage_traces[new_bit] = save_trace()))
8e18257d 3953 return 0;
fbb9ce95 3954
8e18257d 3955 switch (new_bit) {
8e18257d 3956 case LOCK_USED:
bd6d29c2 3957 debug_atomic_dec(nr_unused_locks);
8e18257d
PZ
3958 break;
3959 default:
4d56330d
YD
3960 ret = mark_lock_irq(curr, this, new_bit);
3961 if (!ret)
8e18257d 3962 return 0;
8e18257d 3963 }
fbb9ce95 3964
8e18257d
PZ
3965 graph_unlock();
3966
3967 /*
3968 * We must printk outside of the graph_lock:
3969 */
3970 if (ret == 2) {
3971 printk("\nmarked lock as {%s}:\n", usage_str[new_bit]);
3972 print_lock(this);
3973 print_irqtrace_events(curr);
3974 dump_stack();
3975 }
3976
3977 return ret;
3978}
fbb9ce95 3979
9a019db0
PZ
3980static inline short task_wait_context(struct task_struct *curr)
3981{
3982 /*
3983 * Set appropriate wait type for the context; for IRQs we have to take
3984 * into account force_irqthread as that is implied by PREEMPT_RT.
3985 */
3986 if (curr->hardirq_context) {
3987 /*
3988 * Check if force_irqthreads will run us threaded.
3989 */
3990 if (curr->hardirq_threaded || curr->irq_config)
3991 return LD_WAIT_CONFIG;
3992
3993 return LD_WAIT_SPIN;
3994 } else if (curr->softirq_context) {
3995 /*
3996 * Softirqs are always threaded.
3997 */
3998 return LD_WAIT_CONFIG;
3999 }
4000
4001 return LD_WAIT_MAX;
4002}
4003
de8f5e4f
PZ
4004static int
4005print_lock_invalid_wait_context(struct task_struct *curr,
4006 struct held_lock *hlock)
4007{
9a019db0
PZ
4008 short curr_inner;
4009
de8f5e4f
PZ
4010 if (!debug_locks_off())
4011 return 0;
4012 if (debug_locks_silent)
4013 return 0;
4014
4015 pr_warn("\n");
4016 pr_warn("=============================\n");
4017 pr_warn("[ BUG: Invalid wait context ]\n");
4018 print_kernel_ident();
4019 pr_warn("-----------------------------\n");
4020
4021 pr_warn("%s/%d is trying to lock:\n", curr->comm, task_pid_nr(curr));
4022 print_lock(hlock);
4023
4024 pr_warn("other info that might help us debug this:\n");
9a019db0
PZ
4025
4026 curr_inner = task_wait_context(curr);
4027 pr_warn("context-{%d:%d}\n", curr_inner, curr_inner);
4028
de8f5e4f
PZ
4029 lockdep_print_held_locks(curr);
4030
4031 pr_warn("stack backtrace:\n");
4032 dump_stack();
4033
4034 return 0;
4035}
4036
4037/*
4038 * Verify the wait_type context.
4039 *
4040 * This check validates we takes locks in the right wait-type order; that is it
4041 * ensures that we do not take mutexes inside spinlocks and do not attempt to
4042 * acquire spinlocks inside raw_spinlocks and the sort.
4043 *
4044 * The entire thing is slightly more complex because of RCU, RCU is a lock that
4045 * can be taken from (pretty much) any context but also has constraints.
4046 * However when taken in a stricter environment the RCU lock does not loosen
4047 * the constraints.
4048 *
4049 * Therefore we must look for the strictest environment in the lock stack and
4050 * compare that to the lock we're trying to acquire.
4051 */
4052static int check_wait_context(struct task_struct *curr, struct held_lock *next)
4053{
4054 short next_inner = hlock_class(next)->wait_type_inner;
4055 short next_outer = hlock_class(next)->wait_type_outer;
4056 short curr_inner;
4057 int depth;
4058
4059 if (!curr->lockdep_depth || !next_inner || next->trylock)
4060 return 0;
4061
4062 if (!next_outer)
4063 next_outer = next_inner;
4064
4065 /*
4066 * Find start of current irq_context..
4067 */
4068 for (depth = curr->lockdep_depth - 1; depth >= 0; depth--) {
4069 struct held_lock *prev = curr->held_locks + depth;
4070 if (prev->irq_context != next->irq_context)
4071 break;
4072 }
4073 depth++;
4074
9a019db0 4075 curr_inner = task_wait_context(curr);
de8f5e4f
PZ
4076
4077 for (; depth < curr->lockdep_depth; depth++) {
4078 struct held_lock *prev = curr->held_locks + depth;
4079 short prev_inner = hlock_class(prev)->wait_type_inner;
4080
4081 if (prev_inner) {
4082 /*
4083 * We can have a bigger inner than a previous one
4084 * when outer is smaller than inner, as with RCU.
4085 *
4086 * Also due to trylocks.
4087 */
4088 curr_inner = min(curr_inner, prev_inner);
4089 }
4090 }
4091
4092 if (next_outer > curr_inner)
4093 return print_lock_invalid_wait_context(curr, next);
4094
4095 return 0;
4096}
4097
30a35f79 4098#else /* CONFIG_PROVE_LOCKING */
886532ae
AB
4099
4100static inline int
4101mark_usage(struct task_struct *curr, struct held_lock *hlock, int check)
4102{
4103 return 1;
4104}
4105
4106static inline unsigned int task_irq_context(struct task_struct *task)
4107{
4108 return 0;
4109}
4110
4111static inline int separate_irq_context(struct task_struct *curr,
4112 struct held_lock *hlock)
4113{
4114 return 0;
4115}
4116
de8f5e4f
PZ
4117static inline int check_wait_context(struct task_struct *curr,
4118 struct held_lock *next)
4119{
4120 return 0;
4121}
4122
30a35f79 4123#endif /* CONFIG_PROVE_LOCKING */
886532ae 4124
fbb9ce95
IM
4125/*
4126 * Initialize a lock instance's lock-class mapping info:
4127 */
de8f5e4f
PZ
4128void lockdep_init_map_waits(struct lockdep_map *lock, const char *name,
4129 struct lock_class_key *key, int subclass,
4130 short inner, short outer)
fbb9ce95 4131{
d3d03d4f
YZ
4132 int i;
4133
d3d03d4f
YZ
4134 for (i = 0; i < NR_LOCKDEP_CACHING_CLASSES; i++)
4135 lock->class_cache[i] = NULL;
62016250 4136
c8a25005
PZ
4137#ifdef CONFIG_LOCK_STAT
4138 lock->cpu = raw_smp_processor_id();
4139#endif
4140
0119fee4
PZ
4141 /*
4142 * Can't be having no nameless bastards around this place!
4143 */
c8a25005
PZ
4144 if (DEBUG_LOCKS_WARN_ON(!name)) {
4145 lock->name = "NULL";
fbb9ce95 4146 return;
c8a25005
PZ
4147 }
4148
4149 lock->name = name;
fbb9ce95 4150
de8f5e4f
PZ
4151 lock->wait_type_outer = outer;
4152 lock->wait_type_inner = inner;
4153
0119fee4
PZ
4154 /*
4155 * No key, no joy, we need to hash something.
4156 */
fbb9ce95
IM
4157 if (DEBUG_LOCKS_WARN_ON(!key))
4158 return;
fbb9ce95 4159 /*
108c1485
BVA
4160 * Sanity check, the lock-class key must either have been allocated
4161 * statically or must have been registered as a dynamic key.
fbb9ce95 4162 */
108c1485
BVA
4163 if (!static_obj(key) && !is_dynamic_key(key)) {
4164 if (debug_locks)
4165 printk(KERN_ERR "BUG: key %px has not been registered!\n", key);
fbb9ce95
IM
4166 DEBUG_LOCKS_WARN_ON(1);
4167 return;
4168 }
fbb9ce95 4169 lock->key = key;
c8a25005
PZ
4170
4171 if (unlikely(!debug_locks))
4172 return;
4173
35a9393c
PZ
4174 if (subclass) {
4175 unsigned long flags;
4176
4177 if (DEBUG_LOCKS_WARN_ON(current->lockdep_recursion))
4178 return;
4179
4180 raw_local_irq_save(flags);
10476e63 4181 current->lockdep_recursion++;
4dfbb9d8 4182 register_lock_class(lock, subclass, 1);
10476e63 4183 lockdep_recursion_finish();
35a9393c
PZ
4184 raw_local_irq_restore(flags);
4185 }
fbb9ce95 4186}
de8f5e4f 4187EXPORT_SYMBOL_GPL(lockdep_init_map_waits);
fbb9ce95 4188
1704f47b 4189struct lock_class_key __lockdep_no_validate__;
ea6749c7 4190EXPORT_SYMBOL_GPL(__lockdep_no_validate__);
1704f47b 4191
f7c1c6b3 4192static void
d0945950
ML
4193print_lock_nested_lock_not_held(struct task_struct *curr,
4194 struct held_lock *hlock,
4195 unsigned long ip)
4196{
4197 if (!debug_locks_off())
f7c1c6b3 4198 return;
d0945950 4199 if (debug_locks_silent)
f7c1c6b3 4200 return;
d0945950 4201
681fbec8 4202 pr_warn("\n");
a5dd63ef
PM
4203 pr_warn("==================================\n");
4204 pr_warn("WARNING: Nested lock was not taken\n");
d0945950 4205 print_kernel_ident();
a5dd63ef 4206 pr_warn("----------------------------------\n");
d0945950 4207
681fbec8 4208 pr_warn("%s/%d is trying to lock:\n", curr->comm, task_pid_nr(curr));
d0945950
ML
4209 print_lock(hlock);
4210
681fbec8
PM
4211 pr_warn("\nbut this task is not holding:\n");
4212 pr_warn("%s\n", hlock->nest_lock->name);
d0945950 4213
681fbec8 4214 pr_warn("\nstack backtrace:\n");
d0945950
ML
4215 dump_stack();
4216
681fbec8 4217 pr_warn("\nother info that might help us debug this:\n");
d0945950
ML
4218 lockdep_print_held_locks(curr);
4219
681fbec8 4220 pr_warn("\nstack backtrace:\n");
d0945950 4221 dump_stack();
d0945950
ML
4222}
4223
08f36ff6 4224static int __lock_is_held(const struct lockdep_map *lock, int read);
d0945950 4225
fbb9ce95
IM
4226/*
4227 * This gets called for every mutex_lock*()/spin_lock*() operation.
4228 * We maintain the dependency maps and validate the locking attempt:
8ee10862
WL
4229 *
4230 * The callers must make sure that IRQs are disabled before calling it,
4231 * otherwise we could get an interrupt which would want to take locks,
4232 * which would end up in lockdep again.
fbb9ce95
IM
4233 */
4234static int __lock_acquire(struct lockdep_map *lock, unsigned int subclass,
4235 int trylock, int read, int check, int hardirqs_off,
bb97a91e 4236 struct lockdep_map *nest_lock, unsigned long ip,
21199f27 4237 int references, int pin_count)
fbb9ce95
IM
4238{
4239 struct task_struct *curr = current;
d6d897ce 4240 struct lock_class *class = NULL;
fbb9ce95 4241 struct held_lock *hlock;
5f18ab5c 4242 unsigned int depth;
fbb9ce95 4243 int chain_head = 0;
bb97a91e 4244 int class_idx;
fbb9ce95
IM
4245 u64 chain_key;
4246
4247 if (unlikely(!debug_locks))
4248 return 0;
4249
fb9edbe9
ON
4250 if (!prove_locking || lock->key == &__lockdep_no_validate__)
4251 check = 0;
1704f47b 4252
62016250
HM
4253 if (subclass < NR_LOCKDEP_CACHING_CLASSES)
4254 class = lock->class_cache[subclass];
d6d897ce 4255 /*
62016250 4256 * Not cached?
d6d897ce 4257 */
fbb9ce95 4258 if (unlikely(!class)) {
4dfbb9d8 4259 class = register_lock_class(lock, subclass, 0);
fbb9ce95
IM
4260 if (!class)
4261 return 0;
4262 }
8ca2b56c
WL
4263
4264 debug_class_ops_inc(class);
4265
fbb9ce95 4266 if (very_verbose(class)) {
04860d48 4267 printk("\nacquire class [%px] %s", class->key, class->name);
fbb9ce95 4268 if (class->name_version > 1)
f943fe0f
DV
4269 printk(KERN_CONT "#%d", class->name_version);
4270 printk(KERN_CONT "\n");
fbb9ce95
IM
4271 dump_stack();
4272 }
4273
4274 /*
4275 * Add the lock to the list of currently held locks.
4276 * (we dont increase the depth just yet, up until the
4277 * dependency checks are done)
4278 */
4279 depth = curr->lockdep_depth;
0119fee4
PZ
4280 /*
4281 * Ran out of static storage for our per-task lock stack again have we?
4282 */
fbb9ce95
IM
4283 if (DEBUG_LOCKS_WARN_ON(depth >= MAX_LOCK_DEPTH))
4284 return 0;
4285
01bb6f0a 4286 class_idx = class - lock_classes;
bb97a91e 4287
de8f5e4f 4288 if (depth) { /* we're holding locks */
bb97a91e
PZ
4289 hlock = curr->held_locks + depth - 1;
4290 if (hlock->class_idx == class_idx && nest_lock) {
d9349850
ID
4291 if (!references)
4292 references++;
7fb4a2ce 4293
d9349850 4294 if (!hlock->references)
bb97a91e 4295 hlock->references++;
d9349850
ID
4296
4297 hlock->references += references;
4298
4299 /* Overflow */
4300 if (DEBUG_LOCKS_WARN_ON(hlock->references < references))
4301 return 0;
bb97a91e 4302
8c8889d8 4303 return 2;
bb97a91e
PZ
4304 }
4305 }
4306
fbb9ce95 4307 hlock = curr->held_locks + depth;
0119fee4
PZ
4308 /*
4309 * Plain impossible, we just registered it and checked it weren't no
4310 * NULL like.. I bet this mushroom I ate was good!
4311 */
f82b217e
DJ
4312 if (DEBUG_LOCKS_WARN_ON(!class))
4313 return 0;
bb97a91e 4314 hlock->class_idx = class_idx;
fbb9ce95
IM
4315 hlock->acquire_ip = ip;
4316 hlock->instance = lock;
7531e2f3 4317 hlock->nest_lock = nest_lock;
c2469756 4318 hlock->irq_context = task_irq_context(curr);
fbb9ce95
IM
4319 hlock->trylock = trylock;
4320 hlock->read = read;
4321 hlock->check = check;
6951b12a 4322 hlock->hardirqs_off = !!hardirqs_off;
bb97a91e 4323 hlock->references = references;
f20786ff
PZ
4324#ifdef CONFIG_LOCK_STAT
4325 hlock->waittime_stamp = 0;
3365e779 4326 hlock->holdtime_stamp = lockstat_clock();
f20786ff 4327#endif
21199f27 4328 hlock->pin_count = pin_count;
fbb9ce95 4329
de8f5e4f
PZ
4330 if (check_wait_context(curr, hlock))
4331 return 0;
4332
09180651
YD
4333 /* Initialize the lock usage bit */
4334 if (!mark_usage(curr, hlock, check))
fbb9ce95 4335 return 0;
8e18257d 4336
fbb9ce95 4337 /*
17aacfb9 4338 * Calculate the chain hash: it's the combined hash of all the
fbb9ce95
IM
4339 * lock keys along the dependency chain. We save the hash value
4340 * at every step so that we can get the current hash easily
4341 * after unlock. The chain hash is then used to cache dependency
4342 * results.
4343 *
4344 * The 'key ID' is what is the most compact key value to drive
4345 * the hash, not class->key.
4346 */
0119fee4 4347 /*
01bb6f0a 4348 * Whoops, we did it again.. class_idx is invalid.
0119fee4 4349 */
01bb6f0a 4350 if (DEBUG_LOCKS_WARN_ON(!test_bit(class_idx, lock_classes_in_use)))
fbb9ce95
IM
4351 return 0;
4352
4353 chain_key = curr->curr_chain_key;
4354 if (!depth) {
0119fee4
PZ
4355 /*
4356 * How can we have a chain hash when we ain't got no keys?!
4357 */
f6ec8829 4358 if (DEBUG_LOCKS_WARN_ON(chain_key != INITIAL_CHAIN_KEY))
fbb9ce95
IM
4359 return 0;
4360 chain_head = 1;
4361 }
4362
4363 hlock->prev_chain_key = chain_key;
8e18257d 4364 if (separate_irq_context(curr, hlock)) {
f6ec8829 4365 chain_key = INITIAL_CHAIN_KEY;
8e18257d 4366 chain_head = 1;
fbb9ce95 4367 }
5f18ab5c 4368 chain_key = iterate_chain_key(chain_key, class_idx);
fbb9ce95 4369
f7c1c6b3
YD
4370 if (nest_lock && !__lock_is_held(nest_lock, -1)) {
4371 print_lock_nested_lock_not_held(curr, hlock, ip);
4372 return 0;
4373 }
d0945950 4374
a0b0fd53
BVA
4375 if (!debug_locks_silent) {
4376 WARN_ON_ONCE(depth && !hlock_class(hlock - 1)->key);
4377 WARN_ON_ONCE(!hlock_class(hlock)->key);
4378 }
4379
0b9fc8ec 4380 if (!validate_chain(curr, hlock, chain_head, chain_key))
8e18257d 4381 return 0;
381a2292 4382
3aa416b0 4383 curr->curr_chain_key = chain_key;
fbb9ce95
IM
4384 curr->lockdep_depth++;
4385 check_chain_key(curr);
60e114d1
JP
4386#ifdef CONFIG_DEBUG_LOCKDEP
4387 if (unlikely(!debug_locks))
4388 return 0;
4389#endif
fbb9ce95
IM
4390 if (unlikely(curr->lockdep_depth >= MAX_LOCK_DEPTH)) {
4391 debug_locks_off();
2c522836
DJ
4392 print_lockdep_off("BUG: MAX_LOCK_DEPTH too low!");
4393 printk(KERN_DEBUG "depth: %i max: %lu!\n",
c0540606 4394 curr->lockdep_depth, MAX_LOCK_DEPTH);
c0540606
BG
4395
4396 lockdep_print_held_locks(current);
4397 debug_show_all_locks();
eedeeabd 4398 dump_stack();
c0540606 4399
fbb9ce95
IM
4400 return 0;
4401 }
381a2292 4402
fbb9ce95
IM
4403 if (unlikely(curr->lockdep_depth > max_lockdep_depth))
4404 max_lockdep_depth = curr->lockdep_depth;
4405
4406 return 1;
4407}
4408
f7c1c6b3
YD
4409static void print_unlock_imbalance_bug(struct task_struct *curr,
4410 struct lockdep_map *lock,
4411 unsigned long ip)
fbb9ce95
IM
4412{
4413 if (!debug_locks_off())
f7c1c6b3 4414 return;
fbb9ce95 4415 if (debug_locks_silent)
f7c1c6b3 4416 return;
fbb9ce95 4417
681fbec8 4418 pr_warn("\n");
a5dd63ef
PM
4419 pr_warn("=====================================\n");
4420 pr_warn("WARNING: bad unlock balance detected!\n");
fbdc4b9a 4421 print_kernel_ident();
a5dd63ef 4422 pr_warn("-------------------------------------\n");
681fbec8 4423 pr_warn("%s/%d is trying to release lock (",
ba25f9dc 4424 curr->comm, task_pid_nr(curr));
fbb9ce95 4425 print_lockdep_cache(lock);
681fbec8 4426 pr_cont(") at:\n");
2062a4e8 4427 print_ip_sym(KERN_WARNING, ip);
681fbec8
PM
4428 pr_warn("but there are no more locks to release!\n");
4429 pr_warn("\nother info that might help us debug this:\n");
fbb9ce95
IM
4430 lockdep_print_held_locks(curr);
4431
681fbec8 4432 pr_warn("\nstack backtrace:\n");
fbb9ce95 4433 dump_stack();
fbb9ce95
IM
4434}
4435
c86e9b98
PZ
4436static noinstr int match_held_lock(const struct held_lock *hlock,
4437 const struct lockdep_map *lock)
bb97a91e
PZ
4438{
4439 if (hlock->instance == lock)
4440 return 1;
4441
4442 if (hlock->references) {
08f36ff6 4443 const struct lock_class *class = lock->class_cache[0];
bb97a91e
PZ
4444
4445 if (!class)
4446 class = look_up_lock_class(lock, 0);
4447
80e0401e
PZ
4448 /*
4449 * If look_up_lock_class() failed to find a class, we're trying
4450 * to test if we hold a lock that has never yet been acquired.
4451 * Clearly if the lock hasn't been acquired _ever_, we're not
4452 * holding it either, so report failure.
4453 */
64f29d1b 4454 if (!class)
bb97a91e
PZ
4455 return 0;
4456
0119fee4
PZ
4457 /*
4458 * References, but not a lock we're actually ref-counting?
4459 * State got messed up, follow the sites that change ->references
4460 * and try to make sense of it.
4461 */
bb97a91e
PZ
4462 if (DEBUG_LOCKS_WARN_ON(!hlock->nest_lock))
4463 return 0;
4464
01bb6f0a 4465 if (hlock->class_idx == class - lock_classes)
bb97a91e
PZ
4466 return 1;
4467 }
4468
4469 return 0;
4470}
4471
41c2c5b8
O
4472/* @depth must not be zero */
4473static struct held_lock *find_held_lock(struct task_struct *curr,
4474 struct lockdep_map *lock,
4475 unsigned int depth, int *idx)
4476{
4477 struct held_lock *ret, *hlock, *prev_hlock;
4478 int i;
4479
4480 i = depth - 1;
4481 hlock = curr->held_locks + i;
4482 ret = hlock;
4483 if (match_held_lock(hlock, lock))
4484 goto out;
4485
4486 ret = NULL;
4487 for (i--, prev_hlock = hlock--;
4488 i >= 0;
4489 i--, prev_hlock = hlock--) {
4490 /*
4491 * We must not cross into another context:
4492 */
4493 if (prev_hlock->irq_context != hlock->irq_context) {
4494 ret = NULL;
4495 break;
4496 }
4497 if (match_held_lock(hlock, lock)) {
4498 ret = hlock;
4499 break;
4500 }
4501 }
4502
4503out:
4504 *idx = i;
4505 return ret;
4506}
4507
e969970b 4508static int reacquire_held_locks(struct task_struct *curr, unsigned int depth,
8c8889d8 4509 int idx, unsigned int *merged)
e969970b
O
4510{
4511 struct held_lock *hlock;
8c8889d8 4512 int first_idx = idx;
e969970b 4513
8ee10862
WL
4514 if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
4515 return 0;
4516
e969970b 4517 for (hlock = curr->held_locks + idx; idx < depth; idx++, hlock++) {
8c8889d8 4518 switch (__lock_acquire(hlock->instance,
e969970b
O
4519 hlock_class(hlock)->subclass,
4520 hlock->trylock,
4521 hlock->read, hlock->check,
4522 hlock->hardirqs_off,
4523 hlock->nest_lock, hlock->acquire_ip,
8c8889d8
ID
4524 hlock->references, hlock->pin_count)) {
4525 case 0:
e969970b 4526 return 1;
8c8889d8
ID
4527 case 1:
4528 break;
4529 case 2:
4530 *merged += (idx == first_idx);
4531 break;
4532 default:
4533 WARN_ON(1);
4534 return 0;
4535 }
e969970b
O
4536 }
4537 return 0;
4538}
4539
64aa348e 4540static int
00ef9f73
PZ
4541__lock_set_class(struct lockdep_map *lock, const char *name,
4542 struct lock_class_key *key, unsigned int subclass,
4543 unsigned long ip)
64aa348e
PZ
4544{
4545 struct task_struct *curr = current;
8c8889d8 4546 unsigned int depth, merged = 0;
41c2c5b8 4547 struct held_lock *hlock;
64aa348e 4548 struct lock_class *class;
64aa348e
PZ
4549 int i;
4550
513e1073
WL
4551 if (unlikely(!debug_locks))
4552 return 0;
4553
64aa348e 4554 depth = curr->lockdep_depth;
0119fee4
PZ
4555 /*
4556 * This function is about (re)setting the class of a held lock,
4557 * yet we're not actually holding any locks. Naughty user!
4558 */
64aa348e
PZ
4559 if (DEBUG_LOCKS_WARN_ON(!depth))
4560 return 0;
4561
41c2c5b8 4562 hlock = find_held_lock(curr, lock, depth, &i);
f7c1c6b3
YD
4563 if (!hlock) {
4564 print_unlock_imbalance_bug(curr, lock, ip);
4565 return 0;
4566 }
64aa348e 4567
de8f5e4f
PZ
4568 lockdep_init_map_waits(lock, name, key, 0,
4569 lock->wait_type_inner,
4570 lock->wait_type_outer);
64aa348e 4571 class = register_lock_class(lock, subclass, 0);
01bb6f0a 4572 hlock->class_idx = class - lock_classes;
64aa348e
PZ
4573
4574 curr->lockdep_depth = i;
4575 curr->curr_chain_key = hlock->prev_chain_key;
4576
8c8889d8 4577 if (reacquire_held_locks(curr, depth, i, &merged))
e969970b 4578 return 0;
64aa348e 4579
0119fee4
PZ
4580 /*
4581 * I took it apart and put it back together again, except now I have
4582 * these 'spare' parts.. where shall I put them.
4583 */
8c8889d8 4584 if (DEBUG_LOCKS_WARN_ON(curr->lockdep_depth != depth - merged))
64aa348e
PZ
4585 return 0;
4586 return 1;
4587}
4588
6419c4af
O
4589static int __lock_downgrade(struct lockdep_map *lock, unsigned long ip)
4590{
4591 struct task_struct *curr = current;
8c8889d8 4592 unsigned int depth, merged = 0;
6419c4af 4593 struct held_lock *hlock;
6419c4af
O
4594 int i;
4595
71492580
WL
4596 if (unlikely(!debug_locks))
4597 return 0;
4598
6419c4af
O
4599 depth = curr->lockdep_depth;
4600 /*
4601 * This function is about (re)setting the class of a held lock,
4602 * yet we're not actually holding any locks. Naughty user!
4603 */
4604 if (DEBUG_LOCKS_WARN_ON(!depth))
4605 return 0;
4606
4607 hlock = find_held_lock(curr, lock, depth, &i);
f7c1c6b3
YD
4608 if (!hlock) {
4609 print_unlock_imbalance_bug(curr, lock, ip);
4610 return 0;
4611 }
6419c4af
O
4612
4613 curr->lockdep_depth = i;
4614 curr->curr_chain_key = hlock->prev_chain_key;
4615
4616 WARN(hlock->read, "downgrading a read lock");
4617 hlock->read = 1;
4618 hlock->acquire_ip = ip;
4619
8c8889d8
ID
4620 if (reacquire_held_locks(curr, depth, i, &merged))
4621 return 0;
4622
4623 /* Merging can't happen with unchanged classes.. */
4624 if (DEBUG_LOCKS_WARN_ON(merged))
6419c4af
O
4625 return 0;
4626
4627 /*
4628 * I took it apart and put it back together again, except now I have
4629 * these 'spare' parts.. where shall I put them.
4630 */
4631 if (DEBUG_LOCKS_WARN_ON(curr->lockdep_depth != depth))
4632 return 0;
8c8889d8 4633
6419c4af
O
4634 return 1;
4635}
4636
fbb9ce95 4637/*
c759bc47 4638 * Remove the lock from the list of currently held locks - this gets
e0f56fd7
PZ
4639 * called on mutex_unlock()/spin_unlock*() (or on a failed
4640 * mutex_lock_interruptible()).
fbb9ce95
IM
4641 */
4642static int
b4adfe8e 4643__lock_release(struct lockdep_map *lock, unsigned long ip)
fbb9ce95 4644{
e0f56fd7 4645 struct task_struct *curr = current;
8c8889d8 4646 unsigned int depth, merged = 1;
41c2c5b8 4647 struct held_lock *hlock;
e966eaee 4648 int i;
fbb9ce95 4649
e0f56fd7
PZ
4650 if (unlikely(!debug_locks))
4651 return 0;
4652
fbb9ce95 4653 depth = curr->lockdep_depth;
0119fee4
PZ
4654 /*
4655 * So we're all set to release this lock.. wait what lock? We don't
4656 * own any locks, you've been drinking again?
4657 */
dd471efe 4658 if (depth <= 0) {
f7c1c6b3
YD
4659 print_unlock_imbalance_bug(curr, lock, ip);
4660 return 0;
4661 }
fbb9ce95 4662
e0f56fd7
PZ
4663 /*
4664 * Check whether the lock exists in the current stack
4665 * of held locks:
4666 */
41c2c5b8 4667 hlock = find_held_lock(curr, lock, depth, &i);
f7c1c6b3
YD
4668 if (!hlock) {
4669 print_unlock_imbalance_bug(curr, lock, ip);
4670 return 0;
4671 }
fbb9ce95 4672
bb97a91e
PZ
4673 if (hlock->instance == lock)
4674 lock_release_holdtime(hlock);
4675
a24fc60d
PZ
4676 WARN(hlock->pin_count, "releasing a pinned lock\n");
4677
bb97a91e
PZ
4678 if (hlock->references) {
4679 hlock->references--;
4680 if (hlock->references) {
4681 /*
4682 * We had, and after removing one, still have
4683 * references, the current lock stack is still
4684 * valid. We're done!
4685 */
4686 return 1;
4687 }
4688 }
f20786ff 4689
fbb9ce95
IM
4690 /*
4691 * We have the right lock to unlock, 'hlock' points to it.
4692 * Now we remove it from the stack, and add back the other
4693 * entries (if any), recalculating the hash along the way:
4694 */
bb97a91e 4695
fbb9ce95
IM
4696 curr->lockdep_depth = i;
4697 curr->curr_chain_key = hlock->prev_chain_key;
4698
ce52a18d
WL
4699 /*
4700 * The most likely case is when the unlock is on the innermost
4701 * lock. In this case, we are done!
4702 */
4703 if (i == depth-1)
4704 return 1;
4705
8c8889d8 4706 if (reacquire_held_locks(curr, depth, i + 1, &merged))
e969970b 4707 return 0;
fbb9ce95 4708
0119fee4
PZ
4709 /*
4710 * We had N bottles of beer on the wall, we drank one, but now
4711 * there's not N-1 bottles of beer left on the wall...
8c8889d8 4712 * Pouring two of the bottles together is acceptable.
0119fee4 4713 */
8c8889d8 4714 DEBUG_LOCKS_WARN_ON(curr->lockdep_depth != depth - merged);
f20786ff 4715
ce52a18d
WL
4716 /*
4717 * Since reacquire_held_locks() would have called check_chain_key()
4718 * indirectly via __lock_acquire(), we don't need to do it again
4719 * on return.
4720 */
4721 return 0;
fbb9ce95
IM
4722}
4723
c86e9b98 4724static __always_inline
2f43c602 4725int __lock_is_held(const struct lockdep_map *lock, int read)
fbb9ce95 4726{
f607c668
PZ
4727 struct task_struct *curr = current;
4728 int i;
fbb9ce95 4729
f607c668 4730 for (i = 0; i < curr->lockdep_depth; i++) {
bb97a91e 4731 struct held_lock *hlock = curr->held_locks + i;
fbb9ce95 4732
f8319483
PZ
4733 if (match_held_lock(hlock, lock)) {
4734 if (read == -1 || hlock->read == read)
4735 return 1;
4736
4737 return 0;
4738 }
f607c668 4739 }
f20786ff 4740
f607c668 4741 return 0;
fbb9ce95
IM
4742}
4743
e7904a28
PZ
4744static struct pin_cookie __lock_pin_lock(struct lockdep_map *lock)
4745{
4746 struct pin_cookie cookie = NIL_COOKIE;
4747 struct task_struct *curr = current;
4748 int i;
4749
4750 if (unlikely(!debug_locks))
4751 return cookie;
4752
4753 for (i = 0; i < curr->lockdep_depth; i++) {
4754 struct held_lock *hlock = curr->held_locks + i;
4755
4756 if (match_held_lock(hlock, lock)) {
4757 /*
4758 * Grab 16bits of randomness; this is sufficient to not
4759 * be guessable and still allows some pin nesting in
4760 * our u32 pin_count.
4761 */
4762 cookie.val = 1 + (prandom_u32() >> 16);
4763 hlock->pin_count += cookie.val;
4764 return cookie;
4765 }
4766 }
4767
4768 WARN(1, "pinning an unheld lock\n");
4769 return cookie;
4770}
4771
4772static void __lock_repin_lock(struct lockdep_map *lock, struct pin_cookie cookie)
fbb9ce95
IM
4773{
4774 struct task_struct *curr = current;
a24fc60d 4775 int i;
fbb9ce95 4776
a24fc60d 4777 if (unlikely(!debug_locks))
fbb9ce95
IM
4778 return;
4779
a24fc60d
PZ
4780 for (i = 0; i < curr->lockdep_depth; i++) {
4781 struct held_lock *hlock = curr->held_locks + i;
4782
4783 if (match_held_lock(hlock, lock)) {
e7904a28 4784 hlock->pin_count += cookie.val;
fbb9ce95 4785 return;
a24fc60d 4786 }
fbb9ce95
IM
4787 }
4788
a24fc60d 4789 WARN(1, "pinning an unheld lock\n");
fbb9ce95
IM
4790}
4791
e7904a28 4792static void __lock_unpin_lock(struct lockdep_map *lock, struct pin_cookie cookie)
f607c668
PZ
4793{
4794 struct task_struct *curr = current;
4795 int i;
4796
a24fc60d
PZ
4797 if (unlikely(!debug_locks))
4798 return;
4799
f607c668 4800 for (i = 0; i < curr->lockdep_depth; i++) {
bb97a91e
PZ
4801 struct held_lock *hlock = curr->held_locks + i;
4802
a24fc60d
PZ
4803 if (match_held_lock(hlock, lock)) {
4804 if (WARN(!hlock->pin_count, "unpinning an unpinned lock\n"))
4805 return;
4806
e7904a28
PZ
4807 hlock->pin_count -= cookie.val;
4808
4809 if (WARN((int)hlock->pin_count < 0, "pin count corrupted\n"))
4810 hlock->pin_count = 0;
4811
a24fc60d
PZ
4812 return;
4813 }
f607c668
PZ
4814 }
4815
a24fc60d 4816 WARN(1, "unpinning an unheld lock\n");
f607c668
PZ
4817}
4818
fbb9ce95
IM
4819/*
4820 * Check whether we follow the irq-flags state precisely:
4821 */
1d09daa5 4822static void check_flags(unsigned long flags)
fbb9ce95 4823{
30a35f79 4824#if defined(CONFIG_PROVE_LOCKING) && defined(CONFIG_DEBUG_LOCKDEP)
fbb9ce95
IM
4825 if (!debug_locks)
4826 return;
4827
5f9fa8a6
IM
4828 if (irqs_disabled_flags(flags)) {
4829 if (DEBUG_LOCKS_WARN_ON(current->hardirqs_enabled)) {
4830 printk("possible reason: unannotated irqs-off.\n");
4831 }
4832 } else {
4833 if (DEBUG_LOCKS_WARN_ON(!current->hardirqs_enabled)) {
4834 printk("possible reason: unannotated irqs-on.\n");
4835 }
4836 }
fbb9ce95
IM
4837
4838 /*
4839 * We dont accurately track softirq state in e.g.
4840 * hardirq contexts (such as on 4KSTACKS), so only
4841 * check if not in hardirq contexts:
4842 */
4843 if (!hardirq_count()) {
0119fee4
PZ
4844 if (softirq_count()) {
4845 /* like the above, but with softirqs */
fbb9ce95 4846 DEBUG_LOCKS_WARN_ON(current->softirqs_enabled);
0119fee4
PZ
4847 } else {
4848 /* lick the above, does it taste good? */
fbb9ce95 4849 DEBUG_LOCKS_WARN_ON(!current->softirqs_enabled);
0119fee4 4850 }
fbb9ce95
IM
4851 }
4852
4853 if (!debug_locks)
4854 print_irqtrace_events(current);
4855#endif
4856}
4857
00ef9f73
PZ
4858void lock_set_class(struct lockdep_map *lock, const char *name,
4859 struct lock_class_key *key, unsigned int subclass,
4860 unsigned long ip)
64aa348e
PZ
4861{
4862 unsigned long flags;
4863
4864 if (unlikely(current->lockdep_recursion))
4865 return;
4866
4867 raw_local_irq_save(flags);
10476e63 4868 current->lockdep_recursion++;
64aa348e 4869 check_flags(flags);
00ef9f73 4870 if (__lock_set_class(lock, name, key, subclass, ip))
64aa348e 4871 check_chain_key(current);
10476e63 4872 lockdep_recursion_finish();
64aa348e
PZ
4873 raw_local_irq_restore(flags);
4874}
00ef9f73 4875EXPORT_SYMBOL_GPL(lock_set_class);
64aa348e 4876
6419c4af
O
4877void lock_downgrade(struct lockdep_map *lock, unsigned long ip)
4878{
4879 unsigned long flags;
4880
4881 if (unlikely(current->lockdep_recursion))
4882 return;
4883
4884 raw_local_irq_save(flags);
10476e63 4885 current->lockdep_recursion++;
6419c4af
O
4886 check_flags(flags);
4887 if (__lock_downgrade(lock, ip))
4888 check_chain_key(current);
10476e63 4889 lockdep_recursion_finish();
6419c4af
O
4890 raw_local_irq_restore(flags);
4891}
4892EXPORT_SYMBOL_GPL(lock_downgrade);
4893
f6f48e18
PZ
4894/* NMI context !!! */
4895static void verify_lock_unused(struct lockdep_map *lock, struct held_lock *hlock, int subclass)
4896{
4897#ifdef CONFIG_PROVE_LOCKING
4898 struct lock_class *class = look_up_lock_class(lock, subclass);
4899
4900 /* if it doesn't have a class (yet), it certainly hasn't been used yet */
4901 if (!class)
4902 return;
4903
4904 if (!(class->usage_mask & LOCK_USED))
4905 return;
4906
4907 hlock->class_idx = class - lock_classes;
4908
4909 print_usage_bug(current, hlock, LOCK_USED, LOCK_USAGE_STATES);
4910#endif
4911}
4912
4913static bool lockdep_nmi(void)
4914{
4915 if (current->lockdep_recursion & LOCKDEP_RECURSION_MASK)
4916 return false;
4917
4918 if (!in_nmi())
4919 return false;
4920
4921 return true;
4922}
4923
fbb9ce95
IM
4924/*
4925 * We are not always called with irqs disabled - do that here,
4926 * and also avoid lockdep recursion:
4927 */
1d09daa5 4928void lock_acquire(struct lockdep_map *lock, unsigned int subclass,
7531e2f3
PZ
4929 int trylock, int read, int check,
4930 struct lockdep_map *nest_lock, unsigned long ip)
fbb9ce95
IM
4931{
4932 unsigned long flags;
4933
f6f48e18
PZ
4934 if (unlikely(current->lockdep_recursion)) {
4935 /* XXX allow trylock from NMI ?!? */
4936 if (lockdep_nmi() && !trylock) {
4937 struct held_lock hlock;
4938
4939 hlock.acquire_ip = ip;
4940 hlock.instance = lock;
4941 hlock.nest_lock = nest_lock;
4942 hlock.irq_context = 2; // XXX
4943 hlock.trylock = trylock;
4944 hlock.read = read;
4945 hlock.check = check;
4946 hlock.hardirqs_off = true;
4947 hlock.references = 0;
4948
4949 verify_lock_unused(lock, &hlock, subclass);
4950 }
fbb9ce95 4951 return;
f6f48e18 4952 }
fbb9ce95
IM
4953
4954 raw_local_irq_save(flags);
4955 check_flags(flags);
4956
10476e63 4957 current->lockdep_recursion++;
db2c4c77 4958 trace_lock_acquire(lock, subclass, trylock, read, check, nest_lock, ip);
fbb9ce95 4959 __lock_acquire(lock, subclass, trylock, read, check,
21199f27 4960 irqs_disabled_flags(flags), nest_lock, ip, 0, 0);
10476e63 4961 lockdep_recursion_finish();
fbb9ce95
IM
4962 raw_local_irq_restore(flags);
4963}
fbb9ce95
IM
4964EXPORT_SYMBOL_GPL(lock_acquire);
4965
5facae4f 4966void lock_release(struct lockdep_map *lock, unsigned long ip)
fbb9ce95
IM
4967{
4968 unsigned long flags;
4969
4970 if (unlikely(current->lockdep_recursion))
4971 return;
4972
4973 raw_local_irq_save(flags);
4974 check_flags(flags);
10476e63 4975 current->lockdep_recursion++;
93135439 4976 trace_lock_release(lock, ip);
b4adfe8e 4977 if (__lock_release(lock, ip))
e0f56fd7 4978 check_chain_key(current);
10476e63 4979 lockdep_recursion_finish();
fbb9ce95
IM
4980 raw_local_irq_restore(flags);
4981}
fbb9ce95
IM
4982EXPORT_SYMBOL_GPL(lock_release);
4983
c86e9b98 4984noinstr int lock_is_held_type(const struct lockdep_map *lock, int read)
f607c668
PZ
4985{
4986 unsigned long flags;
4987 int ret = 0;
4988
4989 if (unlikely(current->lockdep_recursion))
f2513cde 4990 return 1; /* avoid false negative lockdep_assert_held() */
f607c668
PZ
4991
4992 raw_local_irq_save(flags);
4993 check_flags(flags);
4994
10476e63 4995 current->lockdep_recursion++;
f8319483 4996 ret = __lock_is_held(lock, read);
10476e63 4997 lockdep_recursion_finish();
f607c668
PZ
4998 raw_local_irq_restore(flags);
4999
5000 return ret;
5001}
f8319483 5002EXPORT_SYMBOL_GPL(lock_is_held_type);
2f43c602 5003NOKPROBE_SYMBOL(lock_is_held_type);
f607c668 5004
e7904a28 5005struct pin_cookie lock_pin_lock(struct lockdep_map *lock)
a24fc60d 5006{
e7904a28 5007 struct pin_cookie cookie = NIL_COOKIE;
a24fc60d
PZ
5008 unsigned long flags;
5009
5010 if (unlikely(current->lockdep_recursion))
e7904a28 5011 return cookie;
a24fc60d
PZ
5012
5013 raw_local_irq_save(flags);
5014 check_flags(flags);
5015
10476e63 5016 current->lockdep_recursion++;
e7904a28 5017 cookie = __lock_pin_lock(lock);
10476e63 5018 lockdep_recursion_finish();
a24fc60d 5019 raw_local_irq_restore(flags);
e7904a28
PZ
5020
5021 return cookie;
a24fc60d
PZ
5022}
5023EXPORT_SYMBOL_GPL(lock_pin_lock);
5024
e7904a28
PZ
5025void lock_repin_lock(struct lockdep_map *lock, struct pin_cookie cookie)
5026{
5027 unsigned long flags;
5028
5029 if (unlikely(current->lockdep_recursion))
5030 return;
5031
5032 raw_local_irq_save(flags);
5033 check_flags(flags);
5034
10476e63 5035 current->lockdep_recursion++;
e7904a28 5036 __lock_repin_lock(lock, cookie);
10476e63 5037 lockdep_recursion_finish();
e7904a28
PZ
5038 raw_local_irq_restore(flags);
5039}
5040EXPORT_SYMBOL_GPL(lock_repin_lock);
5041
5042void lock_unpin_lock(struct lockdep_map *lock, struct pin_cookie cookie)
a24fc60d
PZ
5043{
5044 unsigned long flags;
5045
5046 if (unlikely(current->lockdep_recursion))
5047 return;
5048
5049 raw_local_irq_save(flags);
5050 check_flags(flags);
5051
10476e63 5052 current->lockdep_recursion++;
e7904a28 5053 __lock_unpin_lock(lock, cookie);
10476e63 5054 lockdep_recursion_finish();
a24fc60d
PZ
5055 raw_local_irq_restore(flags);
5056}
5057EXPORT_SYMBOL_GPL(lock_unpin_lock);
5058
f20786ff 5059#ifdef CONFIG_LOCK_STAT
f7c1c6b3
YD
5060static void print_lock_contention_bug(struct task_struct *curr,
5061 struct lockdep_map *lock,
5062 unsigned long ip)
f20786ff
PZ
5063{
5064 if (!debug_locks_off())
f7c1c6b3 5065 return;
f20786ff 5066 if (debug_locks_silent)
f7c1c6b3 5067 return;
f20786ff 5068
681fbec8 5069 pr_warn("\n");
a5dd63ef
PM
5070 pr_warn("=================================\n");
5071 pr_warn("WARNING: bad contention detected!\n");
fbdc4b9a 5072 print_kernel_ident();
a5dd63ef 5073 pr_warn("---------------------------------\n");
681fbec8 5074 pr_warn("%s/%d is trying to contend lock (",
ba25f9dc 5075 curr->comm, task_pid_nr(curr));
f20786ff 5076 print_lockdep_cache(lock);
681fbec8 5077 pr_cont(") at:\n");
2062a4e8 5078 print_ip_sym(KERN_WARNING, ip);
681fbec8
PM
5079 pr_warn("but there are no locks held!\n");
5080 pr_warn("\nother info that might help us debug this:\n");
f20786ff
PZ
5081 lockdep_print_held_locks(curr);
5082
681fbec8 5083 pr_warn("\nstack backtrace:\n");
f20786ff 5084 dump_stack();
f20786ff
PZ
5085}
5086
5087static void
5088__lock_contended(struct lockdep_map *lock, unsigned long ip)
5089{
5090 struct task_struct *curr = current;
41c2c5b8 5091 struct held_lock *hlock;
f20786ff
PZ
5092 struct lock_class_stats *stats;
5093 unsigned int depth;
c7e78cff 5094 int i, contention_point, contending_point;
f20786ff
PZ
5095
5096 depth = curr->lockdep_depth;
0119fee4
PZ
5097 /*
5098 * Whee, we contended on this lock, except it seems we're not
5099 * actually trying to acquire anything much at all..
5100 */
f20786ff
PZ
5101 if (DEBUG_LOCKS_WARN_ON(!depth))
5102 return;
5103
41c2c5b8
O
5104 hlock = find_held_lock(curr, lock, depth, &i);
5105 if (!hlock) {
5106 print_lock_contention_bug(curr, lock, ip);
5107 return;
f20786ff 5108 }
f20786ff 5109
bb97a91e
PZ
5110 if (hlock->instance != lock)
5111 return;
5112
3365e779 5113 hlock->waittime_stamp = lockstat_clock();
f20786ff 5114
c7e78cff
PZ
5115 contention_point = lock_point(hlock_class(hlock)->contention_point, ip);
5116 contending_point = lock_point(hlock_class(hlock)->contending_point,
5117 lock->ip);
f20786ff 5118
f82b217e 5119 stats = get_lock_stats(hlock_class(hlock));
c7e78cff
PZ
5120 if (contention_point < LOCKSTAT_POINTS)
5121 stats->contention_point[contention_point]++;
5122 if (contending_point < LOCKSTAT_POINTS)
5123 stats->contending_point[contending_point]++;
96645678
PZ
5124 if (lock->cpu != smp_processor_id())
5125 stats->bounces[bounce_contended + !!hlock->read]++;
f20786ff
PZ
5126}
5127
5128static void
c7e78cff 5129__lock_acquired(struct lockdep_map *lock, unsigned long ip)
f20786ff
PZ
5130{
5131 struct task_struct *curr = current;
41c2c5b8 5132 struct held_lock *hlock;
f20786ff
PZ
5133 struct lock_class_stats *stats;
5134 unsigned int depth;
3365e779 5135 u64 now, waittime = 0;
96645678 5136 int i, cpu;
f20786ff
PZ
5137
5138 depth = curr->lockdep_depth;
0119fee4
PZ
5139 /*
5140 * Yay, we acquired ownership of this lock we didn't try to
5141 * acquire, how the heck did that happen?
5142 */
f20786ff
PZ
5143 if (DEBUG_LOCKS_WARN_ON(!depth))
5144 return;
5145
41c2c5b8
O
5146 hlock = find_held_lock(curr, lock, depth, &i);
5147 if (!hlock) {
5148 print_lock_contention_bug(curr, lock, _RET_IP_);
5149 return;
f20786ff 5150 }
f20786ff 5151
bb97a91e
PZ
5152 if (hlock->instance != lock)
5153 return;
5154
96645678
PZ
5155 cpu = smp_processor_id();
5156 if (hlock->waittime_stamp) {
3365e779 5157 now = lockstat_clock();
96645678
PZ
5158 waittime = now - hlock->waittime_stamp;
5159 hlock->holdtime_stamp = now;
5160 }
f20786ff 5161
883a2a31 5162 trace_lock_acquired(lock, ip);
2062501a 5163
f82b217e 5164 stats = get_lock_stats(hlock_class(hlock));
96645678
PZ
5165 if (waittime) {
5166 if (hlock->read)
5167 lock_time_inc(&stats->read_waittime, waittime);
5168 else
5169 lock_time_inc(&stats->write_waittime, waittime);
5170 }
5171 if (lock->cpu != cpu)
5172 stats->bounces[bounce_acquired + !!hlock->read]++;
96645678
PZ
5173
5174 lock->cpu = cpu;
c7e78cff 5175 lock->ip = ip;
f20786ff
PZ
5176}
5177
5178void lock_contended(struct lockdep_map *lock, unsigned long ip)
5179{
5180 unsigned long flags;
5181
9506a742 5182 if (unlikely(!lock_stat || !debug_locks))
f20786ff
PZ
5183 return;
5184
5185 if (unlikely(current->lockdep_recursion))
5186 return;
5187
5188 raw_local_irq_save(flags);
5189 check_flags(flags);
10476e63 5190 current->lockdep_recursion++;
db2c4c77 5191 trace_lock_contended(lock, ip);
f20786ff 5192 __lock_contended(lock, ip);
10476e63 5193 lockdep_recursion_finish();
f20786ff
PZ
5194 raw_local_irq_restore(flags);
5195}
5196EXPORT_SYMBOL_GPL(lock_contended);
5197
c7e78cff 5198void lock_acquired(struct lockdep_map *lock, unsigned long ip)
f20786ff
PZ
5199{
5200 unsigned long flags;
5201
9506a742 5202 if (unlikely(!lock_stat || !debug_locks))
f20786ff
PZ
5203 return;
5204
5205 if (unlikely(current->lockdep_recursion))
5206 return;
5207
5208 raw_local_irq_save(flags);
5209 check_flags(flags);
10476e63 5210 current->lockdep_recursion++;
c7e78cff 5211 __lock_acquired(lock, ip);
10476e63 5212 lockdep_recursion_finish();
f20786ff
PZ
5213 raw_local_irq_restore(flags);
5214}
5215EXPORT_SYMBOL_GPL(lock_acquired);
5216#endif
5217
fbb9ce95
IM
5218/*
5219 * Used by the testsuite, sanitize the validator state
5220 * after a simulated failure:
5221 */
5222
5223void lockdep_reset(void)
5224{
5225 unsigned long flags;
23d95a03 5226 int i;
fbb9ce95
IM
5227
5228 raw_local_irq_save(flags);
e196e479 5229 lockdep_init_task(current);
fbb9ce95
IM
5230 memset(current->held_locks, 0, MAX_LOCK_DEPTH*sizeof(struct held_lock));
5231 nr_hardirq_chains = 0;
5232 nr_softirq_chains = 0;
5233 nr_process_chains = 0;
5234 debug_locks = 1;
23d95a03 5235 for (i = 0; i < CHAINHASH_SIZE; i++)
a63f38cc 5236 INIT_HLIST_HEAD(chainhash_table + i);
fbb9ce95
IM
5237 raw_local_irq_restore(flags);
5238}
5239
a0b0fd53 5240/* Remove a class from a lock chain. Must be called with the graph lock held. */
de4643a7
BVA
5241static void remove_class_from_lock_chain(struct pending_free *pf,
5242 struct lock_chain *chain,
a0b0fd53
BVA
5243 struct lock_class *class)
5244{
5245#ifdef CONFIG_PROVE_LOCKING
a0b0fd53
BVA
5246 int i;
5247
5248 for (i = chain->base; i < chain->base + chain->depth; i++) {
5249 if (chain_hlocks[i] != class - lock_classes)
5250 continue;
a0b0fd53
BVA
5251 /*
5252 * Each lock class occurs at most once in a lock chain so once
5253 * we found a match we can break out of this loop.
5254 */
836bd74b 5255 goto free_lock_chain;
a0b0fd53
BVA
5256 }
5257 /* Since the chain has not been modified, return. */
5258 return;
5259
836bd74b 5260free_lock_chain:
810507fe 5261 free_chain_hlocks(chain->base, chain->depth);
a0b0fd53 5262 /* Overwrite the chain key for concurrent RCU readers. */
836bd74b 5263 WRITE_ONCE(chain->chain_key, INITIAL_CHAIN_KEY);
b3b9c187
WL
5264 dec_chains(chain->irq_context);
5265
a0b0fd53
BVA
5266 /*
5267 * Note: calling hlist_del_rcu() from inside a
5268 * hlist_for_each_entry_rcu() loop is safe.
5269 */
5270 hlist_del_rcu(&chain->entry);
de4643a7 5271 __set_bit(chain - lock_chains, pf->lock_chains_being_freed);
797b82eb 5272 nr_zapped_lock_chains++;
a0b0fd53
BVA
5273#endif
5274}
5275
5276/* Must be called with the graph lock held. */
de4643a7
BVA
5277static void remove_class_from_lock_chains(struct pending_free *pf,
5278 struct lock_class *class)
a0b0fd53
BVA
5279{
5280 struct lock_chain *chain;
5281 struct hlist_head *head;
5282 int i;
5283
5284 for (i = 0; i < ARRAY_SIZE(chainhash_table); i++) {
5285 head = chainhash_table + i;
5286 hlist_for_each_entry_rcu(chain, head, entry) {
de4643a7 5287 remove_class_from_lock_chain(pf, chain, class);
a0b0fd53
BVA
5288 }
5289 }
5290}
5291
786fa29e
BVA
5292/*
5293 * Remove all references to a lock class. The caller must hold the graph lock.
5294 */
a0b0fd53 5295static void zap_class(struct pending_free *pf, struct lock_class *class)
fbb9ce95 5296{
86cffb80 5297 struct lock_list *entry;
fbb9ce95
IM
5298 int i;
5299
a0b0fd53
BVA
5300 WARN_ON_ONCE(!class->key);
5301
fbb9ce95
IM
5302 /*
5303 * Remove all dependencies this lock is
5304 * involved in:
5305 */
ace35a7a
BVA
5306 for_each_set_bit(i, list_entries_in_use, ARRAY_SIZE(list_entries)) {
5307 entry = list_entries + i;
86cffb80
BVA
5308 if (entry->class != class && entry->links_to != class)
5309 continue;
ace35a7a
BVA
5310 __clear_bit(i, list_entries_in_use);
5311 nr_list_entries--;
86cffb80 5312 list_del_rcu(&entry->entry);
fbb9ce95 5313 }
a0b0fd53
BVA
5314 if (list_empty(&class->locks_after) &&
5315 list_empty(&class->locks_before)) {
5316 list_move_tail(&class->lock_entry, &pf->zapped);
5317 hlist_del_rcu(&class->hash_entry);
5318 WRITE_ONCE(class->key, NULL);
5319 WRITE_ONCE(class->name, NULL);
5320 nr_lock_classes--;
01bb6f0a 5321 __clear_bit(class - lock_classes, lock_classes_in_use);
a0b0fd53
BVA
5322 } else {
5323 WARN_ONCE(true, "%s() failed for class %s\n", __func__,
5324 class->name);
5325 }
fbb9ce95 5326
de4643a7 5327 remove_class_from_lock_chains(pf, class);
1d44bcb4 5328 nr_zapped_classes++;
a0b0fd53
BVA
5329}
5330
5331static void reinit_class(struct lock_class *class)
5332{
5333 void *const p = class;
5334 const unsigned int offset = offsetof(struct lock_class, key);
5335
5336 WARN_ON_ONCE(!class->lock_entry.next);
5337 WARN_ON_ONCE(!list_empty(&class->locks_after));
5338 WARN_ON_ONCE(!list_empty(&class->locks_before));
5339 memset(p + offset, 0, sizeof(*class) - offset);
5340 WARN_ON_ONCE(!class->lock_entry.next);
5341 WARN_ON_ONCE(!list_empty(&class->locks_after));
5342 WARN_ON_ONCE(!list_empty(&class->locks_before));
fbb9ce95
IM
5343}
5344
fabe874a 5345static inline int within(const void *addr, void *start, unsigned long size)
fbb9ce95
IM
5346{
5347 return addr >= start && addr < start + size;
5348}
5349
a0b0fd53
BVA
5350static bool inside_selftest(void)
5351{
5352 return current == lockdep_selftest_task_struct;
5353}
5354
5355/* The caller must hold the graph lock. */
5356static struct pending_free *get_pending_free(void)
5357{
5358 return delayed_free.pf + delayed_free.index;
5359}
5360
5361static void free_zapped_rcu(struct rcu_head *cb);
5362
5363/*
5364 * Schedule an RCU callback if no RCU callback is pending. Must be called with
5365 * the graph lock held.
5366 */
5367static void call_rcu_zapped(struct pending_free *pf)
5368{
5369 WARN_ON_ONCE(inside_selftest());
5370
5371 if (list_empty(&pf->zapped))
5372 return;
5373
5374 if (delayed_free.scheduled)
5375 return;
5376
5377 delayed_free.scheduled = true;
5378
5379 WARN_ON_ONCE(delayed_free.pf + delayed_free.index != pf);
5380 delayed_free.index ^= 1;
5381
5382 call_rcu(&delayed_free.rcu_head, free_zapped_rcu);
5383}
5384
5385/* The caller must hold the graph lock. May be called from RCU context. */
5386static void __free_zapped_classes(struct pending_free *pf)
5387{
5388 struct lock_class *class;
5389
72dcd505 5390 check_data_structures();
b526b2e3 5391
a0b0fd53
BVA
5392 list_for_each_entry(class, &pf->zapped, lock_entry)
5393 reinit_class(class);
5394
5395 list_splice_init(&pf->zapped, &free_lock_classes);
de4643a7
BVA
5396
5397#ifdef CONFIG_PROVE_LOCKING
5398 bitmap_andnot(lock_chains_in_use, lock_chains_in_use,
5399 pf->lock_chains_being_freed, ARRAY_SIZE(lock_chains));
5400 bitmap_clear(pf->lock_chains_being_freed, 0, ARRAY_SIZE(lock_chains));
5401#endif
a0b0fd53
BVA
5402}
5403
5404static void free_zapped_rcu(struct rcu_head *ch)
5405{
5406 struct pending_free *pf;
5407 unsigned long flags;
5408
5409 if (WARN_ON_ONCE(ch != &delayed_free.rcu_head))
5410 return;
5411
5412 raw_local_irq_save(flags);
248efb21 5413 lockdep_lock();
a0b0fd53
BVA
5414
5415 /* closed head */
5416 pf = delayed_free.pf + (delayed_free.index ^ 1);
5417 __free_zapped_classes(pf);
5418 delayed_free.scheduled = false;
5419
5420 /*
5421 * If there's anything on the open list, close and start a new callback.
5422 */
5423 call_rcu_zapped(delayed_free.pf + delayed_free.index);
5424
248efb21 5425 lockdep_unlock();
a0b0fd53
BVA
5426 raw_local_irq_restore(flags);
5427}
5428
5429/*
5430 * Remove all lock classes from the class hash table and from the
5431 * all_lock_classes list whose key or name is in the address range [start,
5432 * start + size). Move these lock classes to the zapped_classes list. Must
5433 * be called with the graph lock held.
5434 */
5435static void __lockdep_free_key_range(struct pending_free *pf, void *start,
5436 unsigned long size)
956f3563
BVA
5437{
5438 struct lock_class *class;
5439 struct hlist_head *head;
5440 int i;
5441
5442 /* Unhash all classes that were created by a module. */
5443 for (i = 0; i < CLASSHASH_SIZE; i++) {
5444 head = classhash_table + i;
5445 hlist_for_each_entry_rcu(class, head, hash_entry) {
5446 if (!within(class->key, start, size) &&
5447 !within(class->name, start, size))
5448 continue;
a0b0fd53 5449 zap_class(pf, class);
956f3563
BVA
5450 }
5451 }
5452}
5453
35a9393c
PZ
5454/*
5455 * Used in module.c to remove lock classes from memory that is going to be
5456 * freed; and possibly re-used by other modules.
5457 *
29fc33fb
BVA
5458 * We will have had one synchronize_rcu() before getting here, so we're
5459 * guaranteed nobody will look up these exact classes -- they're properly dead
5460 * but still allocated.
35a9393c 5461 */
a0b0fd53 5462static void lockdep_free_key_range_reg(void *start, unsigned long size)
fbb9ce95 5463{
a0b0fd53 5464 struct pending_free *pf;
fbb9ce95 5465 unsigned long flags;
fbb9ce95 5466
feb0a386
BVA
5467 init_data_structures_once();
5468
fbb9ce95 5469 raw_local_irq_save(flags);
248efb21 5470 lockdep_lock();
a0b0fd53
BVA
5471 pf = get_pending_free();
5472 __lockdep_free_key_range(pf, start, size);
5473 call_rcu_zapped(pf);
248efb21 5474 lockdep_unlock();
fbb9ce95 5475 raw_local_irq_restore(flags);
35a9393c
PZ
5476
5477 /*
5478 * Wait for any possible iterators from look_up_lock_class() to pass
5479 * before continuing to free the memory they refer to.
35a9393c 5480 */
51959d85 5481 synchronize_rcu();
a0b0fd53 5482}
35a9393c 5483
a0b0fd53
BVA
5484/*
5485 * Free all lockdep keys in the range [start, start+size). Does not sleep.
5486 * Ignores debug_locks. Must only be used by the lockdep selftests.
5487 */
5488static void lockdep_free_key_range_imm(void *start, unsigned long size)
5489{
5490 struct pending_free *pf = delayed_free.pf;
5491 unsigned long flags;
5492
5493 init_data_structures_once();
5494
5495 raw_local_irq_save(flags);
248efb21 5496 lockdep_lock();
a0b0fd53
BVA
5497 __lockdep_free_key_range(pf, start, size);
5498 __free_zapped_classes(pf);
248efb21 5499 lockdep_unlock();
a0b0fd53
BVA
5500 raw_local_irq_restore(flags);
5501}
5502
5503void lockdep_free_key_range(void *start, unsigned long size)
5504{
5505 init_data_structures_once();
5506
5507 if (inside_selftest())
5508 lockdep_free_key_range_imm(start, size);
5509 else
5510 lockdep_free_key_range_reg(start, size);
fbb9ce95
IM
5511}
5512
2904d9fa
BVA
5513/*
5514 * Check whether any element of the @lock->class_cache[] array refers to a
5515 * registered lock class. The caller must hold either the graph lock or the
5516 * RCU read lock.
5517 */
5518static bool lock_class_cache_is_registered(struct lockdep_map *lock)
fbb9ce95 5519{
35a9393c 5520 struct lock_class *class;
a63f38cc 5521 struct hlist_head *head;
fbb9ce95 5522 int i, j;
2904d9fa
BVA
5523
5524 for (i = 0; i < CLASSHASH_SIZE; i++) {
5525 head = classhash_table + i;
5526 hlist_for_each_entry_rcu(class, head, hash_entry) {
5527 for (j = 0; j < NR_LOCKDEP_CACHING_CLASSES; j++)
5528 if (lock->class_cache[j] == class)
5529 return true;
5530 }
5531 }
5532 return false;
5533}
5534
956f3563 5535/* The caller must hold the graph lock. Does not sleep. */
a0b0fd53
BVA
5536static void __lockdep_reset_lock(struct pending_free *pf,
5537 struct lockdep_map *lock)
2904d9fa
BVA
5538{
5539 struct lock_class *class;
956f3563 5540 int j;
fbb9ce95
IM
5541
5542 /*
d6d897ce
IM
5543 * Remove all classes this lock might have:
5544 */
5545 for (j = 0; j < MAX_LOCKDEP_SUBCLASSES; j++) {
5546 /*
5547 * If the class exists we look it up and zap it:
5548 */
5549 class = look_up_lock_class(lock, j);
64f29d1b 5550 if (class)
a0b0fd53 5551 zap_class(pf, class);
d6d897ce
IM
5552 }
5553 /*
5554 * Debug check: in the end all mapped classes should
5555 * be gone.
fbb9ce95 5556 */
956f3563
BVA
5557 if (WARN_ON_ONCE(lock_class_cache_is_registered(lock)))
5558 debug_locks_off();
5559}
5560
a0b0fd53
BVA
5561/*
5562 * Remove all information lockdep has about a lock if debug_locks == 1. Free
5563 * released data structures from RCU context.
5564 */
5565static void lockdep_reset_lock_reg(struct lockdep_map *lock)
956f3563 5566{
a0b0fd53 5567 struct pending_free *pf;
956f3563
BVA
5568 unsigned long flags;
5569 int locked;
5570
956f3563
BVA
5571 raw_local_irq_save(flags);
5572 locked = graph_lock();
a0b0fd53
BVA
5573 if (!locked)
5574 goto out_irq;
5575
5576 pf = get_pending_free();
5577 __lockdep_reset_lock(pf, lock);
5578 call_rcu_zapped(pf);
5579
5580 graph_unlock();
5581out_irq:
5582 raw_local_irq_restore(flags);
5583}
5584
5585/*
5586 * Reset a lock. Does not sleep. Ignores debug_locks. Must only be used by the
5587 * lockdep selftests.
5588 */
5589static void lockdep_reset_lock_imm(struct lockdep_map *lock)
5590{
5591 struct pending_free *pf = delayed_free.pf;
5592 unsigned long flags;
5593
5594 raw_local_irq_save(flags);
248efb21 5595 lockdep_lock();
a0b0fd53
BVA
5596 __lockdep_reset_lock(pf, lock);
5597 __free_zapped_classes(pf);
248efb21 5598 lockdep_unlock();
fbb9ce95
IM
5599 raw_local_irq_restore(flags);
5600}
5601
a0b0fd53
BVA
5602void lockdep_reset_lock(struct lockdep_map *lock)
5603{
5604 init_data_structures_once();
5605
5606 if (inside_selftest())
5607 lockdep_reset_lock_imm(lock);
5608 else
5609 lockdep_reset_lock_reg(lock);
5610}
5611
108c1485
BVA
5612/* Unregister a dynamically allocated key. */
5613void lockdep_unregister_key(struct lock_class_key *key)
5614{
5615 struct hlist_head *hash_head = keyhashentry(key);
5616 struct lock_class_key *k;
5617 struct pending_free *pf;
5618 unsigned long flags;
5619 bool found = false;
5620
5621 might_sleep();
5622
5623 if (WARN_ON_ONCE(static_obj(key)))
5624 return;
5625
5626 raw_local_irq_save(flags);
8b39adbe
BVA
5627 if (!graph_lock())
5628 goto out_irq;
5629
108c1485
BVA
5630 pf = get_pending_free();
5631 hlist_for_each_entry_rcu(k, hash_head, hash_entry) {
5632 if (k == key) {
5633 hlist_del_rcu(&k->hash_entry);
5634 found = true;
5635 break;
5636 }
5637 }
5638 WARN_ON_ONCE(!found);
5639 __lockdep_free_key_range(pf, key, 1);
5640 call_rcu_zapped(pf);
8b39adbe
BVA
5641 graph_unlock();
5642out_irq:
108c1485
BVA
5643 raw_local_irq_restore(flags);
5644
5645 /* Wait until is_dynamic_key() has finished accessing k->hash_entry. */
5646 synchronize_rcu();
5647}
5648EXPORT_SYMBOL_GPL(lockdep_unregister_key);
5649
c3bc8fd6 5650void __init lockdep_init(void)
fbb9ce95
IM
5651{
5652 printk("Lock dependency validator: Copyright (c) 2006 Red Hat, Inc., Ingo Molnar\n");
5653
b0788caf 5654 printk("... MAX_LOCKDEP_SUBCLASSES: %lu\n", MAX_LOCKDEP_SUBCLASSES);
fbb9ce95
IM
5655 printk("... MAX_LOCK_DEPTH: %lu\n", MAX_LOCK_DEPTH);
5656 printk("... MAX_LOCKDEP_KEYS: %lu\n", MAX_LOCKDEP_KEYS);
b0788caf 5657 printk("... CLASSHASH_SIZE: %lu\n", CLASSHASH_SIZE);
fbb9ce95
IM
5658 printk("... MAX_LOCKDEP_ENTRIES: %lu\n", MAX_LOCKDEP_ENTRIES);
5659 printk("... MAX_LOCKDEP_CHAINS: %lu\n", MAX_LOCKDEP_CHAINS);
5660 printk("... CHAINHASH_SIZE: %lu\n", CHAINHASH_SIZE);
5661
09d75ecb 5662 printk(" memory used by lock dependency info: %zu kB\n",
7ff8517e 5663 (sizeof(lock_classes) +
01bb6f0a 5664 sizeof(lock_classes_in_use) +
7ff8517e
BVA
5665 sizeof(classhash_table) +
5666 sizeof(list_entries) +
ace35a7a 5667 sizeof(list_entries_in_use) +
a0b0fd53
BVA
5668 sizeof(chainhash_table) +
5669 sizeof(delayed_free)
4dd861d6 5670#ifdef CONFIG_PROVE_LOCKING
7ff8517e 5671 + sizeof(lock_cq)
15ea86b5 5672 + sizeof(lock_chains)
de4643a7 5673 + sizeof(lock_chains_in_use)
15ea86b5 5674 + sizeof(chain_hlocks)
4dd861d6 5675#endif
90629209 5676 ) / 1024
4dd861d6 5677 );
fbb9ce95 5678
12593b74
BVA
5679#if defined(CONFIG_TRACE_IRQFLAGS) && defined(CONFIG_PROVE_LOCKING)
5680 printk(" memory used for stack traces: %zu kB\n",
5681 (sizeof(stack_trace) + sizeof(stack_trace_hash)) / 1024
5682 );
5683#endif
5684
09d75ecb 5685 printk(" per task-struct memory footprint: %zu bytes\n",
7ff8517e 5686 sizeof(((struct task_struct *)NULL)->held_locks));
fbb9ce95
IM
5687}
5688
fbb9ce95
IM
5689static void
5690print_freed_lock_bug(struct task_struct *curr, const void *mem_from,
55794a41 5691 const void *mem_to, struct held_lock *hlock)
fbb9ce95
IM
5692{
5693 if (!debug_locks_off())
5694 return;
5695 if (debug_locks_silent)
5696 return;
5697
681fbec8 5698 pr_warn("\n");
a5dd63ef
PM
5699 pr_warn("=========================\n");
5700 pr_warn("WARNING: held lock freed!\n");
fbdc4b9a 5701 print_kernel_ident();
a5dd63ef 5702 pr_warn("-------------------------\n");
04860d48 5703 pr_warn("%s/%d is freeing memory %px-%px, with a lock still held there!\n",
ba25f9dc 5704 curr->comm, task_pid_nr(curr), mem_from, mem_to-1);
55794a41 5705 print_lock(hlock);
fbb9ce95
IM
5706 lockdep_print_held_locks(curr);
5707
681fbec8 5708 pr_warn("\nstack backtrace:\n");
fbb9ce95
IM
5709 dump_stack();
5710}
5711
54561783
ON
5712static inline int not_in_range(const void* mem_from, unsigned long mem_len,
5713 const void* lock_from, unsigned long lock_len)
5714{
5715 return lock_from + lock_len <= mem_from ||
5716 mem_from + mem_len <= lock_from;
5717}
5718
fbb9ce95
IM
5719/*
5720 * Called when kernel memory is freed (or unmapped), or if a lock
5721 * is destroyed or reinitialized - this code checks whether there is
5722 * any held lock in the memory range of <from> to <to>:
5723 */
5724void debug_check_no_locks_freed(const void *mem_from, unsigned long mem_len)
5725{
fbb9ce95
IM
5726 struct task_struct *curr = current;
5727 struct held_lock *hlock;
5728 unsigned long flags;
5729 int i;
5730
5731 if (unlikely(!debug_locks))
5732 return;
5733
fcc784be 5734 raw_local_irq_save(flags);
fbb9ce95
IM
5735 for (i = 0; i < curr->lockdep_depth; i++) {
5736 hlock = curr->held_locks + i;
5737
54561783
ON
5738 if (not_in_range(mem_from, mem_len, hlock->instance,
5739 sizeof(*hlock->instance)))
fbb9ce95
IM
5740 continue;
5741
54561783 5742 print_freed_lock_bug(curr, mem_from, mem_from + mem_len, hlock);
fbb9ce95
IM
5743 break;
5744 }
fcc784be 5745 raw_local_irq_restore(flags);
fbb9ce95 5746}
ed07536e 5747EXPORT_SYMBOL_GPL(debug_check_no_locks_freed);
fbb9ce95 5748
1b1d2fb4 5749static void print_held_locks_bug(void)
fbb9ce95
IM
5750{
5751 if (!debug_locks_off())
5752 return;
5753 if (debug_locks_silent)
5754 return;
5755
681fbec8 5756 pr_warn("\n");
a5dd63ef
PM
5757 pr_warn("====================================\n");
5758 pr_warn("WARNING: %s/%d still has locks held!\n",
1b1d2fb4 5759 current->comm, task_pid_nr(current));
fbdc4b9a 5760 print_kernel_ident();
a5dd63ef 5761 pr_warn("------------------------------------\n");
1b1d2fb4 5762 lockdep_print_held_locks(current);
681fbec8 5763 pr_warn("\nstack backtrace:\n");
fbb9ce95
IM
5764 dump_stack();
5765}
5766
1b1d2fb4 5767void debug_check_no_locks_held(void)
fbb9ce95 5768{
1b1d2fb4
CC
5769 if (unlikely(current->lockdep_depth > 0))
5770 print_held_locks_bug();
fbb9ce95 5771}
1b1d2fb4 5772EXPORT_SYMBOL_GPL(debug_check_no_locks_held);
fbb9ce95 5773
8dce7a9a 5774#ifdef __KERNEL__
fbb9ce95
IM
5775void debug_show_all_locks(void)
5776{
5777 struct task_struct *g, *p;
fbb9ce95 5778
9c35dd7f 5779 if (unlikely(!debug_locks)) {
681fbec8 5780 pr_warn("INFO: lockdep is turned off.\n");
9c35dd7f
JP
5781 return;
5782 }
681fbec8 5783 pr_warn("\nShowing all locks held in the system:\n");
fbb9ce95 5784
0f736a52
TH
5785 rcu_read_lock();
5786 for_each_process_thread(g, p) {
0f736a52
TH
5787 if (!p->lockdep_depth)
5788 continue;
5789 lockdep_print_held_locks(p);
88f1c87d 5790 touch_nmi_watchdog();
0f736a52
TH
5791 touch_all_softlockup_watchdogs();
5792 }
5793 rcu_read_unlock();
fbb9ce95 5794
681fbec8 5795 pr_warn("\n");
a5dd63ef 5796 pr_warn("=============================================\n\n");
fbb9ce95 5797}
fbb9ce95 5798EXPORT_SYMBOL_GPL(debug_show_all_locks);
8dce7a9a 5799#endif
fbb9ce95 5800
82a1fcb9
IM
5801/*
5802 * Careful: only use this function if you are sure that
5803 * the task cannot run in parallel!
5804 */
f1b499f0 5805void debug_show_held_locks(struct task_struct *task)
fbb9ce95 5806{
9c35dd7f
JP
5807 if (unlikely(!debug_locks)) {
5808 printk("INFO: lockdep is turned off.\n");
5809 return;
5810 }
fbb9ce95
IM
5811 lockdep_print_held_locks(task);
5812}
fbb9ce95 5813EXPORT_SYMBOL_GPL(debug_show_held_locks);
b351d164 5814
722a9f92 5815asmlinkage __visible void lockdep_sys_exit(void)
b351d164
PZ
5816{
5817 struct task_struct *curr = current;
5818
5819 if (unlikely(curr->lockdep_depth)) {
5820 if (!debug_locks_off())
5821 return;
681fbec8 5822 pr_warn("\n");
a5dd63ef
PM
5823 pr_warn("================================================\n");
5824 pr_warn("WARNING: lock held when returning to user space!\n");
fbdc4b9a 5825 print_kernel_ident();
a5dd63ef 5826 pr_warn("------------------------------------------------\n");
681fbec8 5827 pr_warn("%s/%d is leaving the kernel with locks still held!\n",
b351d164
PZ
5828 curr->comm, curr->pid);
5829 lockdep_print_held_locks(curr);
5830 }
b09be676
BP
5831
5832 /*
5833 * The lock history for each syscall should be independent. So wipe the
5834 * slate clean on return to userspace.
5835 */
f52be570 5836 lockdep_invariant_state(false);
b351d164 5837}
0632eb3d 5838
b3fbab05 5839void lockdep_rcu_suspicious(const char *file, const int line, const char *s)
0632eb3d
PM
5840{
5841 struct task_struct *curr = current;
5842
2b3fc35f 5843 /* Note: the following can be executed concurrently, so be careful. */
681fbec8 5844 pr_warn("\n");
a5dd63ef
PM
5845 pr_warn("=============================\n");
5846 pr_warn("WARNING: suspicious RCU usage\n");
fbdc4b9a 5847 print_kernel_ident();
a5dd63ef 5848 pr_warn("-----------------------------\n");
681fbec8
PM
5849 pr_warn("%s:%d %s!\n", file, line, s);
5850 pr_warn("\nother info that might help us debug this:\n\n");
5851 pr_warn("\n%srcu_scheduler_active = %d, debug_locks = %d\n",
c5fdcec9
PM
5852 !rcu_lockdep_current_cpu_online()
5853 ? "RCU used illegally from offline CPU!\n"
5c173eb8 5854 : !rcu_is_watching()
c5fdcec9
PM
5855 ? "RCU used illegally from idle CPU!\n"
5856 : "",
5857 rcu_scheduler_active, debug_locks);
0464e937
FW
5858
5859 /*
5860 * If a CPU is in the RCU-free window in idle (ie: in the section
5861 * between rcu_idle_enter() and rcu_idle_exit(), then RCU
5862 * considers that CPU to be in an "extended quiescent state",
5863 * which means that RCU will be completely ignoring that CPU.
5864 * Therefore, rcu_read_lock() and friends have absolutely no
5865 * effect on a CPU running in that state. In other words, even if
5866 * such an RCU-idle CPU has called rcu_read_lock(), RCU might well
5867 * delete data structures out from under it. RCU really has no
5868 * choice here: we need to keep an RCU-free window in idle where
5869 * the CPU may possibly enter into low power mode. This way we can
5870 * notice an extended quiescent state to other CPUs that started a grace
5871 * period. Otherwise we would delay any grace period as long as we run
5872 * in the idle task.
5873 *
5874 * So complain bitterly if someone does call rcu_read_lock(),
5875 * rcu_read_lock_bh() and so on from extended quiescent states.
5876 */
5c173eb8 5877 if (!rcu_is_watching())
681fbec8 5878 pr_warn("RCU used illegally from extended quiescent state!\n");
0464e937 5879
0632eb3d 5880 lockdep_print_held_locks(curr);
681fbec8 5881 pr_warn("\nstack backtrace:\n");
0632eb3d
PM
5882 dump_stack();
5883}
b3fbab05 5884EXPORT_SYMBOL_GPL(lockdep_rcu_suspicious);
This page took 2.049422 seconds and 4 git commands to generate.