xref: /linux/kernel/locking/lockdep.c (revision 42b16d3ac371a2fac9b6f08fd75f23f34ba3955a)
1457c8996SThomas Gleixner // SPDX-License-Identifier: GPL-2.0-only
28eddac3fSPeter Zijlstra /*
38eddac3fSPeter Zijlstra  * kernel/lockdep.c
48eddac3fSPeter Zijlstra  *
58eddac3fSPeter Zijlstra  * Runtime locking correctness validator
68eddac3fSPeter Zijlstra  *
78eddac3fSPeter Zijlstra  * Started by Ingo Molnar:
88eddac3fSPeter Zijlstra  *
98eddac3fSPeter Zijlstra  *  Copyright (C) 2006,2007 Red Hat, Inc., Ingo Molnar <mingo@redhat.com>
1090eec103SPeter Zijlstra  *  Copyright (C) 2007 Red Hat, Inc., Peter Zijlstra
118eddac3fSPeter Zijlstra  *
128eddac3fSPeter Zijlstra  * this code maps all the lock dependencies as they occur in a live kernel
138eddac3fSPeter Zijlstra  * and will warn about the following classes of locking bugs:
148eddac3fSPeter Zijlstra  *
158eddac3fSPeter Zijlstra  * - lock inversion scenarios
168eddac3fSPeter Zijlstra  * - circular lock dependencies
178eddac3fSPeter Zijlstra  * - hardirq/softirq safe/unsafe locking bugs
188eddac3fSPeter Zijlstra  *
198eddac3fSPeter Zijlstra  * Bugs are reported even if the current locking scenario does not cause
208eddac3fSPeter Zijlstra  * any deadlock at this point.
218eddac3fSPeter Zijlstra  *
228eddac3fSPeter Zijlstra  * I.e. if anytime in the past two locks were taken in a different order,
238eddac3fSPeter Zijlstra  * even if it happened for another task, even if those were different
248eddac3fSPeter Zijlstra  * locks (but of the same class as this lock), this code will detect it.
258eddac3fSPeter Zijlstra  *
268eddac3fSPeter Zijlstra  * Thanks to Arjan van de Ven for coming up with the initial idea of
278eddac3fSPeter Zijlstra  * mapping lock dependencies runtime.
288eddac3fSPeter Zijlstra  */
298eddac3fSPeter Zijlstra #define DISABLE_BRANCH_PROFILING
308eddac3fSPeter Zijlstra #include <linux/mutex.h>
318eddac3fSPeter Zijlstra #include <linux/sched.h>
32e6017571SIngo Molnar #include <linux/sched/clock.h>
3329930025SIngo Molnar #include <linux/sched/task.h>
346d7225f0SNikolay Borisov #include <linux/sched/mm.h>
358eddac3fSPeter Zijlstra #include <linux/delay.h>
368eddac3fSPeter Zijlstra #include <linux/module.h>
378eddac3fSPeter Zijlstra #include <linux/proc_fs.h>
388eddac3fSPeter Zijlstra #include <linux/seq_file.h>
398eddac3fSPeter Zijlstra #include <linux/spinlock.h>
408eddac3fSPeter Zijlstra #include <linux/kallsyms.h>
418eddac3fSPeter Zijlstra #include <linux/interrupt.h>
428eddac3fSPeter Zijlstra #include <linux/stacktrace.h>
438eddac3fSPeter Zijlstra #include <linux/debug_locks.h>
448eddac3fSPeter Zijlstra #include <linux/irqflags.h>
458eddac3fSPeter Zijlstra #include <linux/utsname.h>
468eddac3fSPeter Zijlstra #include <linux/hash.h>
478eddac3fSPeter Zijlstra #include <linux/ftrace.h>
488eddac3fSPeter Zijlstra #include <linux/stringify.h>
49ace35a7aSBart Van Assche #include <linux/bitmap.h>
508eddac3fSPeter Zijlstra #include <linux/bitops.h>
518eddac3fSPeter Zijlstra #include <linux/gfp.h>
52e7904a28SPeter Zijlstra #include <linux/random.h>
53dfaaf3faSPeter Zijlstra #include <linux/jhash.h>
5488f1c87dSTejun Heo #include <linux/nmi.h>
55a0b0fd53SBart Van Assche #include <linux/rcupdate.h>
562f43c602SMasami Hiramatsu #include <linux/kprobes.h>
57f8cfa466SShuah Khan #include <linux/lockdep.h>
585a5d7e9bSPeter Zijlstra #include <linux/context_tracking.h>
598eddac3fSPeter Zijlstra #include <linux/console.h>
608eddac3fSPeter Zijlstra 
618eddac3fSPeter Zijlstra #include <asm/sections.h>
628eddac3fSPeter Zijlstra 
638eddac3fSPeter Zijlstra #include "lockdep_internals.h"
648eddac3fSPeter Zijlstra 
658eddac3fSPeter Zijlstra #include <trace/events/lock.h>
668eddac3fSPeter Zijlstra 
67f79c9b8aStangmeng #ifdef CONFIG_PROVE_LOCKING
688eddac3fSPeter Zijlstra static int prove_locking = 1;
698eddac3fSPeter Zijlstra module_param(prove_locking, int, 0644);
708eddac3fSPeter Zijlstra #else
718eddac3fSPeter Zijlstra #define prove_locking 0
728eddac3fSPeter Zijlstra #endif
738eddac3fSPeter Zijlstra 
74f79c9b8aStangmeng #ifdef CONFIG_LOCK_STAT
758eddac3fSPeter Zijlstra static int lock_stat = 1;
768eddac3fSPeter Zijlstra module_param(lock_stat, int, 0644);
778eddac3fSPeter Zijlstra #else
788eddac3fSPeter Zijlstra #define lock_stat 0
798eddac3fSPeter Zijlstra #endif
80f79c9b8aStangmeng 
81f79c9b8aStangmeng #ifdef CONFIG_SYSCTL
82f79c9b8aStangmeng static struct ctl_table kern_lockdep_table[] = {
83f79c9b8aStangmeng #ifdef CONFIG_PROVE_LOCKING
84f79c9b8aStangmeng 	{
85f79c9b8aStangmeng 		.procname       = "prove_locking",
86f79c9b8aStangmeng 		.data           = &prove_locking,
87f79c9b8aStangmeng 		.maxlen         = sizeof(int),
88f79c9b8aStangmeng 		.mode           = 0644,
89f79c9b8aStangmeng 		.proc_handler   = proc_dointvec,
90f79c9b8aStangmeng 	},
91f79c9b8aStangmeng #endif /* CONFIG_PROVE_LOCKING */
92f79c9b8aStangmeng #ifdef CONFIG_LOCK_STAT
93f79c9b8aStangmeng 	{
94f79c9b8aStangmeng 		.procname       = "lock_stat",
95f79c9b8aStangmeng 		.data           = &lock_stat,
96f79c9b8aStangmeng 		.maxlen         = sizeof(int),
97f79c9b8aStangmeng 		.mode           = 0644,
98f79c9b8aStangmeng 		.proc_handler   = proc_dointvec,
99f79c9b8aStangmeng 	},
100f79c9b8aStangmeng #endif /* CONFIG_LOCK_STAT */
101f79c9b8aStangmeng };
102f79c9b8aStangmeng 
kernel_lockdep_sysctls_init(void)103f79c9b8aStangmeng static __init int kernel_lockdep_sysctls_init(void)
104f79c9b8aStangmeng {
105f79c9b8aStangmeng 	register_sysctl_init("kernel", kern_lockdep_table);
106f79c9b8aStangmeng 	return 0;
107f79c9b8aStangmeng }
108f79c9b8aStangmeng late_initcall(kernel_lockdep_sysctls_init);
109f79c9b8aStangmeng #endif /* CONFIG_SYSCTL */
1104d004099SPeter Zijlstra 
1114d004099SPeter Zijlstra DEFINE_PER_CPU(unsigned int, lockdep_recursion);
1124d004099SPeter Zijlstra EXPORT_PER_CPU_SYMBOL_GPL(lockdep_recursion);
1130afda3a8SPeter Zijlstra 
lockdep_enabled(void)1144d004099SPeter Zijlstra static __always_inline bool lockdep_enabled(void)
1154d004099SPeter Zijlstra {
1164d004099SPeter Zijlstra 	if (!debug_locks)
1174d004099SPeter Zijlstra 		return false;
118d48e3850SPeter Zijlstra 
1194d004099SPeter Zijlstra 	if (this_cpu_read(lockdep_recursion))
1204d004099SPeter Zijlstra 		return false;
1214d004099SPeter Zijlstra 
1224d004099SPeter Zijlstra 	if (current->lockdep_recursion)
1234d004099SPeter Zijlstra 		return false;
1244d004099SPeter Zijlstra 
1254d004099SPeter Zijlstra 	return true;
1264d004099SPeter Zijlstra }
1278eddac3fSPeter Zijlstra 
1288eddac3fSPeter Zijlstra /*
1298eddac3fSPeter Zijlstra  * lockdep_lock: protects the lockdep graph, the hashes and the
1308eddac3fSPeter Zijlstra  *               class/list/hash allocators.
1318eddac3fSPeter Zijlstra  *
1328eddac3fSPeter Zijlstra  * This is one of the rare exceptions where it's justified
1338eddac3fSPeter Zijlstra  * to use a raw spinlock - we really dont want the spinlock
1348eddac3fSPeter Zijlstra  * code to recurse back into the lockdep code...
135248efb21SPeter Zijlstra  */
136248efb21SPeter Zijlstra static arch_spinlock_t __lock = (arch_spinlock_t)__ARCH_SPIN_LOCK_UNLOCKED;
137248efb21SPeter Zijlstra static struct task_struct *__owner;
138248efb21SPeter Zijlstra 
lockdep_lock(void)139248efb21SPeter Zijlstra static inline void lockdep_lock(void)
140248efb21SPeter Zijlstra {
141248efb21SPeter Zijlstra 	DEBUG_LOCKS_WARN_ON(!irqs_disabled());
14243be4388SBoqun Feng 
143248efb21SPeter Zijlstra 	__this_cpu_inc(lockdep_recursion);
144248efb21SPeter Zijlstra 	arch_spin_lock(&__lock);
145248efb21SPeter Zijlstra 	__owner = current;
146248efb21SPeter Zijlstra }
147248efb21SPeter Zijlstra 
lockdep_unlock(void)148248efb21SPeter Zijlstra static inline void lockdep_unlock(void)
14943be4388SBoqun Feng {
15043be4388SBoqun Feng 	DEBUG_LOCKS_WARN_ON(!irqs_disabled());
151248efb21SPeter Zijlstra 
152248efb21SPeter Zijlstra 	if (debug_locks && DEBUG_LOCKS_WARN_ON(__owner != current))
153248efb21SPeter Zijlstra 		return;
154248efb21SPeter Zijlstra 
155248efb21SPeter Zijlstra 	__owner = NULL;
15643be4388SBoqun Feng 	arch_spin_unlock(&__lock);
157248efb21SPeter Zijlstra 	__this_cpu_dec(lockdep_recursion);
158248efb21SPeter Zijlstra }
159248efb21SPeter Zijlstra 
lockdep_assert_locked(void)160248efb21SPeter Zijlstra static inline bool lockdep_assert_locked(void)
161248efb21SPeter Zijlstra {
162248efb21SPeter Zijlstra 	return DEBUG_LOCKS_WARN_ON(__owner != current);
163248efb21SPeter Zijlstra }
164cdc84d79SBart Van Assche 
1658eddac3fSPeter Zijlstra static struct task_struct *lockdep_selftest_task_struct;
166248efb21SPeter Zijlstra 
1678eddac3fSPeter Zijlstra 
graph_lock(void)1688eddac3fSPeter Zijlstra static int graph_lock(void)
169248efb21SPeter Zijlstra {
1708eddac3fSPeter Zijlstra 	lockdep_lock();
1718eddac3fSPeter Zijlstra 	/*
1728eddac3fSPeter Zijlstra 	 * Make sure that if another CPU detected a bug while
1738eddac3fSPeter Zijlstra 	 * walking the graph we dont change it (while the other
1748eddac3fSPeter Zijlstra 	 * CPU is busy printing out stuff with the graph lock
1758eddac3fSPeter Zijlstra 	 * dropped already)
1768eddac3fSPeter Zijlstra 	 */
177248efb21SPeter Zijlstra 	if (!debug_locks) {
1788eddac3fSPeter Zijlstra 		lockdep_unlock();
1798eddac3fSPeter Zijlstra 		return 0;
1808eddac3fSPeter Zijlstra 	}
1818eddac3fSPeter Zijlstra 	return 1;
1828eddac3fSPeter Zijlstra }
183248efb21SPeter Zijlstra 
graph_unlock(void)1848eddac3fSPeter Zijlstra static inline void graph_unlock(void)
185248efb21SPeter Zijlstra {
1868eddac3fSPeter Zijlstra 	lockdep_unlock();
1878eddac3fSPeter Zijlstra }
1888eddac3fSPeter Zijlstra 
1898eddac3fSPeter Zijlstra /*
1908eddac3fSPeter Zijlstra  * Turn lock debugging off and return with 0 if it was off already,
1918eddac3fSPeter Zijlstra  * and also release the graph lock:
1928eddac3fSPeter Zijlstra  */
debug_locks_off_graph_unlock(void)1938eddac3fSPeter Zijlstra static inline int debug_locks_off_graph_unlock(void)
1948eddac3fSPeter Zijlstra {
1958eddac3fSPeter Zijlstra 	int ret = debug_locks_off();
196248efb21SPeter Zijlstra 
1978eddac3fSPeter Zijlstra 	lockdep_unlock();
1988eddac3fSPeter Zijlstra 
1998eddac3fSPeter Zijlstra 	return ret;
2008eddac3fSPeter Zijlstra }
2018eddac3fSPeter Zijlstra 
2028eddac3fSPeter Zijlstra unsigned long nr_list_entries;
203ace35a7aSBart Van Assche static struct lock_list list_entries[MAX_LOCKDEP_ENTRIES];
2048eddac3fSPeter Zijlstra static DECLARE_BITMAP(list_entries_in_use, MAX_LOCKDEP_ENTRIES);
2058eddac3fSPeter Zijlstra 
2068eddac3fSPeter Zijlstra /*
2078eddac3fSPeter Zijlstra  * All data structures here are protected by the global debug_lock.
208a0b0fd53SBart Van Assche  *
209a0b0fd53SBart Van Assche  * nr_lock_classes is the number of elements of lock_classes[] that is
2108eddac3fSPeter Zijlstra  * in use.
211108c1485SBart Van Assche  */
212108c1485SBart Van Assche #define KEYHASH_BITS		(MAX_LOCKDEP_KEYS_BITS - 1)
213108c1485SBart Van Assche #define KEYHASH_SIZE		(1UL << KEYHASH_BITS)
2148eddac3fSPeter Zijlstra static struct hlist_head lock_keys_hash[KEYHASH_SIZE];
2151d44bcb4SWaiman Long unsigned long nr_lock_classes;
216fb7275acSWaiman Long unsigned long nr_zapped_classes;
2178ca2b56cSWaiman Long unsigned long max_lock_class_idx;
218fb7275acSWaiman Long struct lock_class lock_classes[MAX_LOCKDEP_KEYS];
2198eddac3fSPeter Zijlstra DECLARE_BITMAP(lock_classes_in_use, MAX_LOCKDEP_KEYS);
2208eddac3fSPeter Zijlstra 
hlock_class(struct held_lock * hlock)2218eddac3fSPeter Zijlstra static inline struct lock_class *hlock_class(struct held_lock *hlock)
22201bb6f0aSYuyang Du {
22301bb6f0aSYuyang Du 	unsigned int class_idx = hlock->class_idx;
22401bb6f0aSYuyang Du 
22501bb6f0aSYuyang Du 	/* Don't re-read hlock->class_idx, can't use READ_ONCE() on bitfield */
22601bb6f0aSYuyang Du 	barrier();
22701bb6f0aSYuyang Du 
2288eddac3fSPeter Zijlstra 	if (!test_bit(class_idx, lock_classes_in_use)) {
2298eddac3fSPeter Zijlstra 		/*
2308eddac3fSPeter Zijlstra 		 * Someone passed in garbage, we give up.
2318eddac3fSPeter Zijlstra 		 */
2328eddac3fSPeter Zijlstra 		DEBUG_LOCKS_WARN_ON(1);
2338eddac3fSPeter Zijlstra 		return NULL;
23401bb6f0aSYuyang Du 	}
23501bb6f0aSYuyang Du 
23601bb6f0aSYuyang Du 	/*
23701bb6f0aSYuyang Du 	 * At this point, if the passed hlock->class_idx is still garbage,
23801bb6f0aSYuyang Du 	 * we just have to live with it
23901bb6f0aSYuyang Du 	 */
2408eddac3fSPeter Zijlstra 	return lock_classes + class_idx;
2418eddac3fSPeter Zijlstra }
2428eddac3fSPeter Zijlstra 
24325528213SPeter Zijlstra #ifdef CONFIG_LOCK_STAT
2448eddac3fSPeter Zijlstra static DEFINE_PER_CPU(struct lock_class_stats[MAX_LOCKDEP_KEYS], cpu_lock_stats);
2458eddac3fSPeter Zijlstra 
lockstat_clock(void)2468eddac3fSPeter Zijlstra static inline u64 lockstat_clock(void)
2478eddac3fSPeter Zijlstra {
2488eddac3fSPeter Zijlstra 	return local_clock();
2498eddac3fSPeter Zijlstra }
2508eddac3fSPeter Zijlstra 
lock_point(unsigned long points[],unsigned long ip)2518eddac3fSPeter Zijlstra static int lock_point(unsigned long points[], unsigned long ip)
2528eddac3fSPeter Zijlstra {
2538eddac3fSPeter Zijlstra 	int i;
2548eddac3fSPeter Zijlstra 
2558eddac3fSPeter Zijlstra 	for (i = 0; i < LOCKSTAT_POINTS; i++) {
2568eddac3fSPeter Zijlstra 		if (points[i] == 0) {
2578eddac3fSPeter Zijlstra 			points[i] = ip;
2588eddac3fSPeter Zijlstra 			break;
2598eddac3fSPeter Zijlstra 		}
2608eddac3fSPeter Zijlstra 		if (points[i] == ip)
2618eddac3fSPeter Zijlstra 			break;
2628eddac3fSPeter Zijlstra 	}
2638eddac3fSPeter Zijlstra 
2648eddac3fSPeter Zijlstra 	return i;
2658eddac3fSPeter Zijlstra }
2668eddac3fSPeter Zijlstra 
lock_time_inc(struct lock_time * lt,u64 time)2678eddac3fSPeter Zijlstra static void lock_time_inc(struct lock_time *lt, u64 time)
2688eddac3fSPeter Zijlstra {
2698eddac3fSPeter Zijlstra 	if (time > lt->max)
2708eddac3fSPeter Zijlstra 		lt->max = time;
2718eddac3fSPeter Zijlstra 
2728eddac3fSPeter Zijlstra 	if (time < lt->min || !lt->nr)
2738eddac3fSPeter Zijlstra 		lt->min = time;
2748eddac3fSPeter Zijlstra 
2758eddac3fSPeter Zijlstra 	lt->total += time;
2768eddac3fSPeter Zijlstra 	lt->nr++;
2778eddac3fSPeter Zijlstra }
2788eddac3fSPeter Zijlstra 
lock_time_add(struct lock_time * src,struct lock_time * dst)2798eddac3fSPeter Zijlstra static inline void lock_time_add(struct lock_time *src, struct lock_time *dst)
2808eddac3fSPeter Zijlstra {
2818eddac3fSPeter Zijlstra 	if (!src->nr)
2828eddac3fSPeter Zijlstra 		return;
2838eddac3fSPeter Zijlstra 
2848eddac3fSPeter Zijlstra 	if (src->max > dst->max)
2858eddac3fSPeter Zijlstra 		dst->max = src->max;
2868eddac3fSPeter Zijlstra 
2878eddac3fSPeter Zijlstra 	if (src->min < dst->min || !dst->nr)
2888eddac3fSPeter Zijlstra 		dst->min = src->min;
2898eddac3fSPeter Zijlstra 
2908eddac3fSPeter Zijlstra 	dst->total += src->total;
2918eddac3fSPeter Zijlstra 	dst->nr += src->nr;
2928eddac3fSPeter Zijlstra }
2938eddac3fSPeter Zijlstra 
lock_stats(struct lock_class * class)2948eddac3fSPeter Zijlstra struct lock_class_stats lock_stats(struct lock_class *class)
2958eddac3fSPeter Zijlstra {
2968eddac3fSPeter Zijlstra 	struct lock_class_stats stats;
2978eddac3fSPeter Zijlstra 	int cpu, i;
2988eddac3fSPeter Zijlstra 
2998eddac3fSPeter Zijlstra 	memset(&stats, 0, sizeof(struct lock_class_stats));
3008eddac3fSPeter Zijlstra 	for_each_possible_cpu(cpu) {
3018eddac3fSPeter Zijlstra 		struct lock_class_stats *pcs =
3028eddac3fSPeter Zijlstra 			&per_cpu(cpu_lock_stats, cpu)[class - lock_classes];
3038eddac3fSPeter Zijlstra 
3048eddac3fSPeter Zijlstra 		for (i = 0; i < ARRAY_SIZE(stats.contention_point); i++)
3058eddac3fSPeter Zijlstra 			stats.contention_point[i] += pcs->contention_point[i];
3068eddac3fSPeter Zijlstra 
3078eddac3fSPeter Zijlstra 		for (i = 0; i < ARRAY_SIZE(stats.contending_point); i++)
3088eddac3fSPeter Zijlstra 			stats.contending_point[i] += pcs->contending_point[i];
3098eddac3fSPeter Zijlstra 
3108eddac3fSPeter Zijlstra 		lock_time_add(&pcs->read_waittime, &stats.read_waittime);
3118eddac3fSPeter Zijlstra 		lock_time_add(&pcs->write_waittime, &stats.write_waittime);
3128eddac3fSPeter Zijlstra 
3138eddac3fSPeter Zijlstra 		lock_time_add(&pcs->read_holdtime, &stats.read_holdtime);
3148eddac3fSPeter Zijlstra 		lock_time_add(&pcs->write_holdtime, &stats.write_holdtime);
3158eddac3fSPeter Zijlstra 
3168eddac3fSPeter Zijlstra 		for (i = 0; i < ARRAY_SIZE(stats.bounces); i++)
3178eddac3fSPeter Zijlstra 			stats.bounces[i] += pcs->bounces[i];
3188eddac3fSPeter Zijlstra 	}
3198eddac3fSPeter Zijlstra 
3208eddac3fSPeter Zijlstra 	return stats;
3218eddac3fSPeter Zijlstra }
3228eddac3fSPeter Zijlstra 
clear_lock_stats(struct lock_class * class)3238eddac3fSPeter Zijlstra void clear_lock_stats(struct lock_class *class)
3248eddac3fSPeter Zijlstra {
3258eddac3fSPeter Zijlstra 	int cpu;
3268eddac3fSPeter Zijlstra 
3278eddac3fSPeter Zijlstra 	for_each_possible_cpu(cpu) {
3288eddac3fSPeter Zijlstra 		struct lock_class_stats *cpu_stats =
3298eddac3fSPeter Zijlstra 			&per_cpu(cpu_lock_stats, cpu)[class - lock_classes];
3308eddac3fSPeter Zijlstra 
3318eddac3fSPeter Zijlstra 		memset(cpu_stats, 0, sizeof(struct lock_class_stats));
3328eddac3fSPeter Zijlstra 	}
3338eddac3fSPeter Zijlstra 	memset(class->contention_point, 0, sizeof(class->contention_point));
3348eddac3fSPeter Zijlstra 	memset(class->contending_point, 0, sizeof(class->contending_point));
3358eddac3fSPeter Zijlstra }
3368eddac3fSPeter Zijlstra 
get_lock_stats(struct lock_class * class)3378eddac3fSPeter Zijlstra static struct lock_class_stats *get_lock_stats(struct lock_class *class)
33801f38497SJoel Fernandes (Google) {
3398eddac3fSPeter Zijlstra 	return &this_cpu_ptr(cpu_lock_stats)[class - lock_classes];
3408eddac3fSPeter Zijlstra }
3418eddac3fSPeter Zijlstra 
lock_release_holdtime(struct held_lock * hlock)3428eddac3fSPeter Zijlstra static void lock_release_holdtime(struct held_lock *hlock)
3438eddac3fSPeter Zijlstra {
3448eddac3fSPeter Zijlstra 	struct lock_class_stats *stats;
3458eddac3fSPeter Zijlstra 	u64 holdtime;
3468eddac3fSPeter Zijlstra 
3478eddac3fSPeter Zijlstra 	if (!lock_stat)
3488eddac3fSPeter Zijlstra 		return;
3498eddac3fSPeter Zijlstra 
3508eddac3fSPeter Zijlstra 	holdtime = lockstat_clock() - hlock->holdtime_stamp;
3518eddac3fSPeter Zijlstra 
3528eddac3fSPeter Zijlstra 	stats = get_lock_stats(hlock_class(hlock));
3538eddac3fSPeter Zijlstra 	if (hlock->read)
3548eddac3fSPeter Zijlstra 		lock_time_inc(&stats->read_holdtime, holdtime);
3558eddac3fSPeter Zijlstra 	else
3568eddac3fSPeter Zijlstra 		lock_time_inc(&stats->write_holdtime, holdtime);
3578eddac3fSPeter Zijlstra }
3588eddac3fSPeter Zijlstra #else
lock_release_holdtime(struct held_lock * hlock)3598eddac3fSPeter Zijlstra static inline void lock_release_holdtime(struct held_lock *hlock)
3608eddac3fSPeter Zijlstra {
3618eddac3fSPeter Zijlstra }
3628eddac3fSPeter Zijlstra #endif
3638eddac3fSPeter Zijlstra 
364a0b0fd53SBart Van Assche /*
365a0b0fd53SBart Van Assche  * We keep a global list of all lock classes. The list is only accessed with
366a0b0fd53SBart Van Assche  * the lockdep spinlock lock held. free_lock_classes is a list with free
367a0b0fd53SBart Van Assche  * elements. These elements are linked together by the lock_entry member in
3688eddac3fSPeter Zijlstra  * struct lock_class.
369fb7275acSWaiman Long  */
370a0b0fd53SBart Van Assche static LIST_HEAD(all_lock_classes);
371a0b0fd53SBart Van Assche static LIST_HEAD(free_lock_classes);
372a0b0fd53SBart Van Assche 
373a0b0fd53SBart Van Assche /**
374a0b0fd53SBart Van Assche  * struct pending_free - information about data structures about to be freed
375de4643a7SBart Van Assche  * @zapped: Head of a list with struct lock_class elements.
376de4643a7SBart Van Assche  * @lock_chains_being_freed: Bitmap that indicates which lock_chains[] elements
377a0b0fd53SBart Van Assche  *	are about to be freed.
378a0b0fd53SBart Van Assche  */
379a0b0fd53SBart Van Assche struct pending_free {
380de4643a7SBart Van Assche 	struct list_head zapped;
381a0b0fd53SBart Van Assche 	DECLARE_BITMAP(lock_chains_being_freed, MAX_LOCKDEP_CHAINS);
382a0b0fd53SBart Van Assche };
383a0b0fd53SBart Van Assche 
384a0b0fd53SBart Van Assche /**
385a0b0fd53SBart Van Assche  * struct delayed_free - data structures used for delayed freeing
386a0b0fd53SBart Van Assche  *
387a0b0fd53SBart Van Assche  * A data structure for delayed freeing of data structures that may be
388a0b0fd53SBart Van Assche  * accessed by RCU readers at the time these were freed.
389a0b0fd53SBart Van Assche  *
390a0b0fd53SBart Van Assche  * @rcu_head:  Used to schedule an RCU callback for freeing data structures.
391a0b0fd53SBart Van Assche  * @index:     Index of @pf to which freed data structures are added.
392a0b0fd53SBart Van Assche  * @scheduled: Whether or not an RCU callback has been scheduled.
393a0b0fd53SBart Van Assche  * @pf:        Array with information about data structures about to be freed.
394a0b0fd53SBart Van Assche  */
395a0b0fd53SBart Van Assche static struct delayed_free {
396a0b0fd53SBart Van Assche 	struct rcu_head		rcu_head;
397a0b0fd53SBart Van Assche 	int			index;
398a0b0fd53SBart Van Assche 	int			scheduled;
399a0b0fd53SBart Van Assche 	struct pending_free	pf[2];
4008eddac3fSPeter Zijlstra } delayed_free;
4018eddac3fSPeter Zijlstra 
4028eddac3fSPeter Zijlstra /*
4038eddac3fSPeter Zijlstra  * The lockdep classes are in a hash-table as well, for fast lookup:
4048eddac3fSPeter Zijlstra  */
4058eddac3fSPeter Zijlstra #define CLASSHASH_BITS		(MAX_LOCKDEP_KEYS_BITS - 1)
4068eddac3fSPeter Zijlstra #define CLASSHASH_SIZE		(1UL << CLASSHASH_BITS)
4078eddac3fSPeter Zijlstra #define __classhashfn(key)	hash_long((unsigned long)key, CLASSHASH_BITS)
4088eddac3fSPeter Zijlstra #define classhashentry(key)	(classhash_table + __classhashfn((key)))
409a63f38ccSAndrew Morton 
4108eddac3fSPeter Zijlstra static struct hlist_head classhash_table[CLASSHASH_SIZE];
4118eddac3fSPeter Zijlstra 
4128eddac3fSPeter Zijlstra /*
4138eddac3fSPeter Zijlstra  * We put the lock dependency chains into a hash-table as well, to cache
4148eddac3fSPeter Zijlstra  * their existence:
4158eddac3fSPeter Zijlstra  */
4168eddac3fSPeter Zijlstra #define CHAINHASH_BITS		(MAX_LOCKDEP_CHAINS_BITS-1)
4178eddac3fSPeter Zijlstra #define CHAINHASH_SIZE		(1UL << CHAINHASH_BITS)
4188eddac3fSPeter Zijlstra #define __chainhashfn(chain)	hash_long(chain, CHAINHASH_BITS)
4198eddac3fSPeter Zijlstra #define chainhashentry(chain)	(chainhash_table + __chainhashfn((chain)))
420a63f38ccSAndrew Morton 
4218eddac3fSPeter Zijlstra static struct hlist_head chainhash_table[CHAINHASH_SIZE];
4228eddac3fSPeter Zijlstra 
423f611e8cfSBoqun Feng /*
424f611e8cfSBoqun Feng  * the id of held_lock
425f611e8cfSBoqun Feng  */
hlock_id(struct held_lock * hlock)426f611e8cfSBoqun Feng static inline u16 hlock_id(struct held_lock *hlock)
427f611e8cfSBoqun Feng {
428f611e8cfSBoqun Feng 	BUILD_BUG_ON(MAX_LOCKDEP_KEYS_BITS + 2 > 16);
429f611e8cfSBoqun Feng 
430f611e8cfSBoqun Feng 	return (hlock->class_idx | (hlock->read << MAX_LOCKDEP_KEYS_BITS));
431f611e8cfSBoqun Feng }
432f611e8cfSBoqun Feng 
chain_hlock_class_idx(u16 hlock_id)433f611e8cfSBoqun Feng static inline unsigned int chain_hlock_class_idx(u16 hlock_id)
434f611e8cfSBoqun Feng {
435f611e8cfSBoqun Feng 	return hlock_id & (MAX_LOCKDEP_KEYS - 1);
436f611e8cfSBoqun Feng }
437f611e8cfSBoqun Feng 
4388eddac3fSPeter Zijlstra /*
4398eddac3fSPeter Zijlstra  * The hash key of the lock dependency chains is a hash itself too:
4408eddac3fSPeter Zijlstra  * it's a hash of all locks taken up to that lock, including that lock.
4418eddac3fSPeter Zijlstra  * It's a 64-bit hash, because it's important for the keys to be
4428eddac3fSPeter Zijlstra  * unique.
443dfaaf3faSPeter Zijlstra  */
iterate_chain_key(u64 key,u32 idx)444dfaaf3faSPeter Zijlstra static inline u64 iterate_chain_key(u64 key, u32 idx)
445dfaaf3faSPeter Zijlstra {
446dfaaf3faSPeter Zijlstra 	u32 k0 = key, k1 = key >> 32;
447dfaaf3faSPeter Zijlstra 
448dfaaf3faSPeter Zijlstra 	__jhash_mix(idx, k0, k1); /* Macro that modifies arguments! */
449dfaaf3faSPeter Zijlstra 
450dfaaf3faSPeter Zijlstra 	return k0 | (u64)k1 << 32;
4518eddac3fSPeter Zijlstra }
452e196e479SYuyang Du 
lockdep_init_task(struct task_struct * task)453e196e479SYuyang Du void lockdep_init_task(struct task_struct *task)
454e196e479SYuyang Du {
455f6ec8829SYuyang Du 	task->lockdep_depth = 0; /* no locks held yet */
456e196e479SYuyang Du 	task->curr_chain_key = INITIAL_CHAIN_KEY;
457e196e479SYuyang Du 	task->lockdep_recursion = 0;
458e196e479SYuyang Du }
4594d004099SPeter Zijlstra 
lockdep_recursion_inc(void)4604d004099SPeter Zijlstra static __always_inline void lockdep_recursion_inc(void)
4614d004099SPeter Zijlstra {
4624d004099SPeter Zijlstra 	__this_cpu_inc(lockdep_recursion);
4634d004099SPeter Zijlstra }
4646eebad1aSPeter Zijlstra 
lockdep_recursion_finish(void)46510476e63SPeter Zijlstra static __always_inline void lockdep_recursion_finish(void)
4664d004099SPeter Zijlstra {
4674d004099SPeter Zijlstra 	if (WARN_ON_ONCE(__this_cpu_dec_return(lockdep_recursion)))
46810476e63SPeter Zijlstra 		__this_cpu_write(lockdep_recursion, 0);
46910476e63SPeter Zijlstra }
470cdc84d79SBart Van Assche 
lockdep_set_selftest_task(struct task_struct * task)471cdc84d79SBart Van Assche void lockdep_set_selftest_task(struct task_struct *task)
472cdc84d79SBart Van Assche {
473cdc84d79SBart Van Assche 	lockdep_selftest_task_struct = task;
474cdc84d79SBart Van Assche }
4758eddac3fSPeter Zijlstra 
4768eddac3fSPeter Zijlstra /*
4778eddac3fSPeter Zijlstra  * Debugging switches:
4788eddac3fSPeter Zijlstra  */
4798eddac3fSPeter Zijlstra 
4808eddac3fSPeter Zijlstra #define VERBOSE			0
4818eddac3fSPeter Zijlstra #define VERY_VERBOSE		0
4828eddac3fSPeter Zijlstra 
4838eddac3fSPeter Zijlstra #if VERBOSE
4848eddac3fSPeter Zijlstra # define HARDIRQ_VERBOSE	1
4858eddac3fSPeter Zijlstra # define SOFTIRQ_VERBOSE	1
4868eddac3fSPeter Zijlstra #else
4878eddac3fSPeter Zijlstra # define HARDIRQ_VERBOSE	0
4888eddac3fSPeter Zijlstra # define SOFTIRQ_VERBOSE	0
4898eddac3fSPeter Zijlstra #endif
490d92a8cfcSPeter Zijlstra 
4918eddac3fSPeter Zijlstra #if VERBOSE || HARDIRQ_VERBOSE || SOFTIRQ_VERBOSE
4928eddac3fSPeter Zijlstra /*
4938eddac3fSPeter Zijlstra  * Quick filtering for interesting events:
4948eddac3fSPeter Zijlstra  */
class_filter(struct lock_class * class)4958eddac3fSPeter Zijlstra static int class_filter(struct lock_class *class)
4968eddac3fSPeter Zijlstra {
4978eddac3fSPeter Zijlstra #if 0
4988eddac3fSPeter Zijlstra 	/* Example */
4998eddac3fSPeter Zijlstra 	if (class->name_version == 1 &&
5008eddac3fSPeter Zijlstra 			!strcmp(class->name, "lockname"))
5018eddac3fSPeter Zijlstra 		return 1;
5028eddac3fSPeter Zijlstra 	if (class->name_version == 1 &&
5038eddac3fSPeter Zijlstra 			!strcmp(class->name, "&struct->lockfield"))
5048eddac3fSPeter Zijlstra 		return 1;
5058eddac3fSPeter Zijlstra #endif
5068eddac3fSPeter Zijlstra 	/* Filter everything else. 1 would be to allow everything else */
5078eddac3fSPeter Zijlstra 	return 0;
5088eddac3fSPeter Zijlstra }
5098eddac3fSPeter Zijlstra #endif
5108eddac3fSPeter Zijlstra 
verbose(struct lock_class * class)5118eddac3fSPeter Zijlstra static int verbose(struct lock_class *class)
5128eddac3fSPeter Zijlstra {
5138eddac3fSPeter Zijlstra #if VERBOSE
5148eddac3fSPeter Zijlstra 	return class_filter(class);
5158eddac3fSPeter Zijlstra #endif
5168eddac3fSPeter Zijlstra 	return 0;
5178eddac3fSPeter Zijlstra }
5188eddac3fSPeter Zijlstra 
print_lockdep_off(const char * bug_msg)5198eddac3fSPeter Zijlstra static void print_lockdep_off(const char *bug_msg)
5208eddac3fSPeter Zijlstra {
5218eddac3fSPeter Zijlstra 	printk(KERN_DEBUG "%s\n", bug_msg);
522acf59377SAndreas Gruenbacher 	printk(KERN_DEBUG "turning off the locking correctness validator.\n");
5238eddac3fSPeter Zijlstra #ifdef CONFIG_LOCK_STAT
524acf59377SAndreas Gruenbacher 	printk(KERN_DEBUG "Please attach the output of /proc/lock_stat to the bug report\n");
5258eddac3fSPeter Zijlstra #endif
5268eddac3fSPeter Zijlstra }
527886532aeSArnd Bergmann 
528886532aeSArnd Bergmann unsigned long nr_stack_trace_entries;
52930a35f79SArnd Bergmann 
53012593b74SBart Van Assche #ifdef CONFIG_PROVE_LOCKING
53112593b74SBart Van Assche /**
53212593b74SBart Van Assche  * struct lock_trace - single stack backtrace
53312593b74SBart Van Assche  * @hash_entry:	Entry in a stack_trace_hash[] list.
53412593b74SBart Van Assche  * @hash:	jhash() of @entries.
53512593b74SBart Van Assche  * @nr_entries:	Number of entries in @entries.
53612593b74SBart Van Assche  * @entries:	Actual stack backtrace.
53712593b74SBart Van Assche  */
53812593b74SBart Van Assche struct lock_trace {
53912593b74SBart Van Assche 	struct hlist_node	hash_entry;
54012593b74SBart Van Assche 	u32			hash;
541db78538cSGustavo A. R. Silva 	u32			nr_entries;
54212593b74SBart Van Assche 	unsigned long		entries[] __aligned(sizeof(unsigned long));
54312593b74SBart Van Assche };
54412593b74SBart Van Assche #define LOCK_TRACE_SIZE_IN_LONGS				\
545886532aeSArnd Bergmann 	(sizeof(struct lock_trace) / sizeof(unsigned long))
54612593b74SBart Van Assche /*
547886532aeSArnd Bergmann  * Stack-trace: sequence of lock_trace structures. Protected by the graph_lock.
548886532aeSArnd Bergmann  */
54912593b74SBart Van Assche static unsigned long stack_trace[MAX_STACK_TRACE_ENTRIES];
550886532aeSArnd Bergmann static struct hlist_head stack_trace_hash[STACK_TRACE_HASH_SIZE];
55112593b74SBart Van Assche 
traces_identical(struct lock_trace * t1,struct lock_trace * t2)5528eddac3fSPeter Zijlstra static bool traces_identical(struct lock_trace *t1, struct lock_trace *t2)
55312593b74SBart Van Assche {
55412593b74SBart Van Assche 	return t1->hash == t2->hash && t1->nr_entries == t2->nr_entries &&
55512593b74SBart Van Assche 		memcmp(t1->entries, t2->entries,
55612593b74SBart Van Assche 		       t1->nr_entries * sizeof(t1->entries[0])) == 0;
55712593b74SBart Van Assche }
55812593b74SBart Van Assche 
save_trace(void)55912593b74SBart Van Assche static struct lock_trace *save_trace(void)
56012593b74SBart Van Assche {
56112593b74SBart Van Assche 	struct lock_trace *trace, *t2;
56212593b74SBart Van Assche 	struct hlist_head *hash_head;
563d91f3057SWaiman Long 	u32 hash;
5648eddac3fSPeter Zijlstra 	int max_entries;
56512593b74SBart Van Assche 
56612593b74SBart Van Assche 	BUILD_BUG_ON_NOT_POWER_OF_2(STACK_TRACE_HASH_SIZE);
5678eddac3fSPeter Zijlstra 	BUILD_BUG_ON(LOCK_TRACE_SIZE_IN_LONGS >= MAX_STACK_TRACE_ENTRIES);
56812593b74SBart Van Assche 
56912593b74SBart Van Assche 	trace = (struct lock_trace *)(stack_trace + nr_stack_trace_entries);
57012593b74SBart Van Assche 	max_entries = MAX_STACK_TRACE_ENTRIES - nr_stack_trace_entries -
57112593b74SBart Van Assche 		LOCK_TRACE_SIZE_IN_LONGS;
572d91f3057SWaiman Long 
5738eddac3fSPeter Zijlstra 	if (max_entries <= 0) {
57412593b74SBart Van Assche 		if (!debug_locks_off_graph_unlock())
5758eddac3fSPeter Zijlstra 			return NULL;
5768eddac3fSPeter Zijlstra 
5778eddac3fSPeter Zijlstra 		nbcon_cpu_emergency_enter();
5788eddac3fSPeter Zijlstra 		print_lockdep_off("BUG: MAX_STACK_TRACE_ENTRIES too low!");
57912593b74SBart Van Assche 		dump_stack();
5808eddac3fSPeter Zijlstra 		nbcon_cpu_emergency_exit();
581d91f3057SWaiman Long 
5828eddac3fSPeter Zijlstra 		return NULL;
58312593b74SBart Van Assche 	}
58412593b74SBart Van Assche 	trace->nr_entries = stack_trace_save(trace->entries, max_entries, 3);
58512593b74SBart Van Assche 
58612593b74SBart Van Assche 	hash = jhash(trace->entries, trace->nr_entries *
58712593b74SBart Van Assche 		     sizeof(trace->entries[0]), 0);
58812593b74SBart Van Assche 	trace->hash = hash;
58912593b74SBart Van Assche 	hash_head = stack_trace_hash + (hash & (STACK_TRACE_HASH_SIZE - 1));
59012593b74SBart Van Assche 	hlist_for_each_entry(t2, hash_head, hash_entry) {
59112593b74SBart Van Assche 		if (traces_identical(trace, t2))
59212593b74SBart Van Assche 			return t2;
59312593b74SBart Van Assche 	}
59412593b74SBart Van Assche 	nr_stack_trace_entries += LOCK_TRACE_SIZE_IN_LONGS + trace->nr_entries;
5958eddac3fSPeter Zijlstra 	hlist_add_head(&trace->hash_entry, hash_head);
5968c779229SBart Van Assche 
5978c779229SBart Van Assche 	return trace;
5988c779229SBart Van Assche }
5998c779229SBart Van Assche 
6008c779229SBart Van Assche /* Return the number of stack traces in the stack_trace[] array. */
lockdep_stack_trace_count(void)6018c779229SBart Van Assche u64 lockdep_stack_trace_count(void)
6028c779229SBart Van Assche {
6038c779229SBart Van Assche 	struct lock_trace *trace;
6048c779229SBart Van Assche 	u64 c = 0;
6058c779229SBart Van Assche 	int i;
6068c779229SBart Van Assche 
6078c779229SBart Van Assche 	for (i = 0; i < ARRAY_SIZE(stack_trace_hash); i++) {
6088c779229SBart Van Assche 		hlist_for_each_entry(trace, &stack_trace_hash[i], hash_entry) {
6098c779229SBart Van Assche 			c++;
6108c779229SBart Van Assche 		}
6118c779229SBart Van Assche 	}
6128c779229SBart Van Assche 
6138c779229SBart Van Assche 	return c;
6148c779229SBart Van Assche }
6158c779229SBart Van Assche 
6168c779229SBart Van Assche /* Return the number of stack hash chains that have at least one stack trace. */
lockdep_stack_hash_count(void)6178c779229SBart Van Assche u64 lockdep_stack_hash_count(void)
6188c779229SBart Van Assche {
6198c779229SBart Van Assche 	u64 c = 0;
6208c779229SBart Van Assche 	int i;
6218c779229SBart Van Assche 
6228c779229SBart Van Assche 	for (i = 0; i < ARRAY_SIZE(stack_trace_hash); i++)
6238c779229SBart Van Assche 		if (!hlist_empty(&stack_trace_hash[i]))
6248eddac3fSPeter Zijlstra 			c++;
625886532aeSArnd Bergmann 
6268eddac3fSPeter Zijlstra 	return c;
6278eddac3fSPeter Zijlstra }
6288eddac3fSPeter Zijlstra #endif
6298eddac3fSPeter Zijlstra 
6308eddac3fSPeter Zijlstra unsigned int nr_hardirq_chains;
6318eddac3fSPeter Zijlstra unsigned int nr_softirq_chains;
6328eddac3fSPeter Zijlstra unsigned int nr_process_chains;
6338eddac3fSPeter Zijlstra unsigned int max_lockdep_depth;
6348eddac3fSPeter Zijlstra 
6358eddac3fSPeter Zijlstra #ifdef CONFIG_DEBUG_LOCKDEP
6368eddac3fSPeter Zijlstra /*
6378eddac3fSPeter Zijlstra  * Various lockdep statistics:
6388eddac3fSPeter Zijlstra  */
63930a35f79SArnd Bergmann DEFINE_PER_CPU(struct lockdep_stats, lockdep_stats);
6408eddac3fSPeter Zijlstra #endif
6418eddac3fSPeter Zijlstra 
6428eddac3fSPeter Zijlstra #ifdef CONFIG_PROVE_LOCKING
6438eddac3fSPeter Zijlstra /*
6448eddac3fSPeter Zijlstra  * Locking printouts:
6458eddac3fSPeter Zijlstra  */
6468eddac3fSPeter Zijlstra 
6478eddac3fSPeter Zijlstra #define __USAGE(__STATE)						\
6488eddac3fSPeter Zijlstra 	[LOCK_USED_IN_##__STATE] = "IN-"__stringify(__STATE)"-W",	\
6498eddac3fSPeter Zijlstra 	[LOCK_ENABLED_##__STATE] = __stringify(__STATE)"-ON-W",		\
6508eddac3fSPeter Zijlstra 	[LOCK_USED_IN_##__STATE##_READ] = "IN-"__stringify(__STATE)"-R",\
6518eddac3fSPeter Zijlstra 	[LOCK_ENABLED_##__STATE##_READ] = __stringify(__STATE)"-ON-R",
6528eddac3fSPeter Zijlstra 
6538eddac3fSPeter Zijlstra static const char *usage_str[] =
6548eddac3fSPeter Zijlstra {
6558eddac3fSPeter Zijlstra #define LOCKDEP_STATE(__STATE) __USAGE(__STATE)
6562bb8945bSPeter Zijlstra #include "lockdep_states.h"
6572bb8945bSPeter Zijlstra #undef LOCKDEP_STATE
658f6f48e18SPeter Zijlstra 	[LOCK_USED] = "INITIAL USE",
6598eddac3fSPeter Zijlstra 	[LOCK_USED_READ] = "INITIAL READ USE",
660886532aeSArnd Bergmann 	/* abused as string storage for verify_lock_unused() */
6618eddac3fSPeter Zijlstra 	[LOCK_USAGE_STATES] = "IN-NMI",
662364f6afcSBart Van Assche };
6638eddac3fSPeter Zijlstra #endif
6648eddac3fSPeter Zijlstra 
__get_key_name(const struct lockdep_subclass_key * key,char * str)6658eddac3fSPeter Zijlstra const char *__get_key_name(const struct lockdep_subclass_key *key, char *str)
6668eddac3fSPeter Zijlstra {
6678eddac3fSPeter Zijlstra 	return kallsyms_lookup((unsigned long)key, NULL, NULL, NULL, str);
6688eddac3fSPeter Zijlstra }
6698eddac3fSPeter Zijlstra 
lock_flag(enum lock_usage_bit bit)6708eddac3fSPeter Zijlstra static inline unsigned long lock_flag(enum lock_usage_bit bit)
6718eddac3fSPeter Zijlstra {
6728eddac3fSPeter Zijlstra 	return 1UL << bit;
6738eddac3fSPeter Zijlstra }
674c52478f4SYuyang Du 
get_usage_char(struct lock_class * class,enum lock_usage_bit bit)675c52478f4SYuyang Du static char get_usage_char(struct lock_class *class, enum lock_usage_bit bit)
676c52478f4SYuyang Du {
677c52478f4SYuyang Du 	/*
6788eddac3fSPeter Zijlstra 	 * The usage character defaults to '.' (i.e., irqs disabled and not in
6798eddac3fSPeter Zijlstra 	 * irq context), which is the safest usage category.
680c52478f4SYuyang Du 	 */
681c52478f4SYuyang Du 	char c = '.';
682c52478f4SYuyang Du 
683c52478f4SYuyang Du 	/*
684c52478f4SYuyang Du 	 * The order of the following usage checks matters, which will
685c52478f4SYuyang Du 	 * result in the outcome character as follows:
686c52478f4SYuyang Du 	 *
687c52478f4SYuyang Du 	 * - '+': irq is enabled and not in irq context
688c52478f4SYuyang Du 	 * - '-': in irq context and irq is disabled
6898eddac3fSPeter Zijlstra 	 * - '?': in irq context and irq is enabled
690c52478f4SYuyang Du 	 */
6918eddac3fSPeter Zijlstra 	if (class->usage_mask & lock_flag(bit + LOCK_USAGE_DIR_MASK)) {
692c52478f4SYuyang Du 		c = '+';
693c52478f4SYuyang Du 		if (class->usage_mask & lock_flag(bit))
6948eddac3fSPeter Zijlstra 			c = '?';
6958eddac3fSPeter Zijlstra 	} else if (class->usage_mask & lock_flag(bit))
6968eddac3fSPeter Zijlstra 		c = '-';
6978eddac3fSPeter Zijlstra 
6988eddac3fSPeter Zijlstra 	return c;
6998eddac3fSPeter Zijlstra }
7008eddac3fSPeter Zijlstra 
get_usage_chars(struct lock_class * class,char usage[LOCK_USAGE_CHARS])7018eddac3fSPeter Zijlstra void get_usage_chars(struct lock_class *class, char usage[LOCK_USAGE_CHARS])
7028eddac3fSPeter Zijlstra {
7038eddac3fSPeter Zijlstra 	int i = 0;
7048eddac3fSPeter Zijlstra 
7058eddac3fSPeter Zijlstra #define LOCKDEP_STATE(__STATE) 						\
7068eddac3fSPeter Zijlstra 	usage[i++] = get_usage_char(class, LOCK_USED_IN_##__STATE);	\
7078eddac3fSPeter Zijlstra 	usage[i++] = get_usage_char(class, LOCK_USED_IN_##__STATE##_READ);
7088eddac3fSPeter Zijlstra #include "lockdep_states.h"
7098eddac3fSPeter Zijlstra #undef LOCKDEP_STATE
7108eddac3fSPeter Zijlstra 
711eb1cfd09SKent Overstreet 	usage[i] = '\0';
7128eddac3fSPeter Zijlstra }
7138eddac3fSPeter Zijlstra 
__print_lock_name(struct held_lock * hlock,struct lock_class * class)7148eddac3fSPeter Zijlstra static void __print_lock_name(struct held_lock *hlock, struct lock_class *class)
7158eddac3fSPeter Zijlstra {
7168eddac3fSPeter Zijlstra 	char str[KSYM_NAME_LEN];
7178eddac3fSPeter Zijlstra 	const char *name;
7188eddac3fSPeter Zijlstra 
719f943fe0fSDmitry Vyukov 	name = class->name;
7208eddac3fSPeter Zijlstra 	if (!name) {
721f943fe0fSDmitry Vyukov 		name = __get_key_name(class->key, str);
7228eddac3fSPeter Zijlstra 		printk(KERN_CONT "%s", name);
723f943fe0fSDmitry Vyukov 	} else {
7248eddac3fSPeter Zijlstra 		printk(KERN_CONT "%s", name);
725f943fe0fSDmitry Vyukov 		if (class->name_version > 1)
726eb1cfd09SKent Overstreet 			printk(KERN_CONT "#%d", class->name_version);
727eb1cfd09SKent Overstreet 		if (class->subclass)
7288eddac3fSPeter Zijlstra 			printk(KERN_CONT "/%d", class->subclass);
7298eddac3fSPeter Zijlstra 		if (hlock && class->print_fn)
7308eddac3fSPeter Zijlstra 			class->print_fn(hlock->instance);
731eb1cfd09SKent Overstreet 	}
7328eddac3fSPeter Zijlstra }
7338eddac3fSPeter Zijlstra 
print_lock_name(struct held_lock * hlock,struct lock_class * class)7348eddac3fSPeter Zijlstra static void print_lock_name(struct held_lock *hlock, struct lock_class *class)
7358eddac3fSPeter Zijlstra {
7368eddac3fSPeter Zijlstra 	char usage[LOCK_USAGE_CHARS];
737f943fe0fSDmitry Vyukov 
738eb1cfd09SKent Overstreet 	get_usage_chars(class, usage);
7396d48b791SArnd Bergmann 
740de8f5e4fSPeter Zijlstra 	printk(KERN_CONT " (");
741de8f5e4fSPeter Zijlstra 	__print_lock_name(hlock, class);
7428eddac3fSPeter Zijlstra 	printk(KERN_CONT "){%s}-{%d:%d}", usage,
7438eddac3fSPeter Zijlstra 			class->wait_type_outer ?: class->wait_type_inner,
7448eddac3fSPeter Zijlstra 			class->wait_type_inner);
7458eddac3fSPeter Zijlstra }
7468eddac3fSPeter Zijlstra 
print_lockdep_cache(struct lockdep_map * lock)7478eddac3fSPeter Zijlstra static void print_lockdep_cache(struct lockdep_map *lock)
7488eddac3fSPeter Zijlstra {
7498eddac3fSPeter Zijlstra 	const char *name;
7508eddac3fSPeter Zijlstra 	char str[KSYM_NAME_LEN];
7518eddac3fSPeter Zijlstra 
7528eddac3fSPeter Zijlstra 	name = lock->name;
753f943fe0fSDmitry Vyukov 	if (!name)
7548eddac3fSPeter Zijlstra 		name = __get_key_name(lock->key->subkeys, str);
7558eddac3fSPeter Zijlstra 
7568eddac3fSPeter Zijlstra 	printk(KERN_CONT "%s", name);
7578eddac3fSPeter Zijlstra }
758d7bc3197SPeter Zijlstra 
print_lock(struct held_lock * hlock)759d7bc3197SPeter Zijlstra static void print_lock(struct held_lock *hlock)
760d7bc3197SPeter Zijlstra {
76101bb6f0aSYuyang Du 	/*
76201bb6f0aSYuyang Du 	 * We can be called locklessly through debug_show_all_locks() so be
76301bb6f0aSYuyang Du 	 * extra careful, the hlock might have been released and cleared.
76401bb6f0aSYuyang Du 	 *
76501bb6f0aSYuyang Du 	 * If this indeed happens, lets pretend it does not hurt to continue
76601bb6f0aSYuyang Du 	 * to print the lock unless the hlock class_idx does not point to a
767d7bc3197SPeter Zijlstra 	 * registered class. The rationale here is: since we don't attempt
76801bb6f0aSYuyang Du 	 * to distinguish whether we are in this situation, if it just
769d7bc3197SPeter Zijlstra 	 * happened we can't count on class_idx to tell either.
77001bb6f0aSYuyang Du 	 */
771f943fe0fSDmitry Vyukov 	struct lock_class *lock = hlock_class(hlock);
772d7bc3197SPeter Zijlstra 
773d7bc3197SPeter Zijlstra 	if (!lock) {
774d7bc3197SPeter Zijlstra 		printk(KERN_CONT "<RELEASED>\n");
775519248f3SPaul E. McKenney 		return;
776eb1cfd09SKent Overstreet 	}
777b3c39758STetsuo Handa 
7788eddac3fSPeter Zijlstra 	printk(KERN_CONT "%px", hlock->instance);
7798eddac3fSPeter Zijlstra 	print_lock_name(hlock, lock);
7808cc05c71STetsuo Handa 	printk(KERN_CONT ", at: %pS\n", (void *)hlock->acquire_ip);
7818eddac3fSPeter Zijlstra }
7828cc05c71STetsuo Handa 
lockdep_print_held_locks(struct task_struct * p)7838eddac3fSPeter Zijlstra static void lockdep_print_held_locks(struct task_struct *p)
7848cc05c71STetsuo Handa {
7858cc05c71STetsuo Handa 	int i, depth = READ_ONCE(p->lockdep_depth);
7868cc05c71STetsuo Handa 
7878cc05c71STetsuo Handa 	if (!depth)
7888cc05c71STetsuo Handa 		printk("no locks held by %s/%d.\n", p->comm, task_pid_nr(p));
7898cc05c71STetsuo Handa 	else
7908cc05c71STetsuo Handa 		printk("%d lock%s held by %s/%d:\n", depth,
7918cc05c71STetsuo Handa 		       depth > 1 ? "s" : "", p->comm, task_pid_nr(p));
7928cc05c71STetsuo Handa 	/*
793b03fbd4fSPeter Zijlstra 	 * It's not reliable to print a task's held locks if it's not sleeping
7948eddac3fSPeter Zijlstra 	 * and it's not the current task.
7958eddac3fSPeter Zijlstra 	 */
7968eddac3fSPeter Zijlstra 	if (p != current && task_is_running(p))
7978cc05c71STetsuo Handa 		return;
7988eddac3fSPeter Zijlstra 	for (i = 0; i < depth; i++) {
7998eddac3fSPeter Zijlstra 		printk(" #%d: ", i);
8008eddac3fSPeter Zijlstra 		print_lock(p->held_locks + i);
8018eddac3fSPeter Zijlstra 	}
8028eddac3fSPeter Zijlstra }
8038eddac3fSPeter Zijlstra 
print_kernel_ident(void)8048eddac3fSPeter Zijlstra static void print_kernel_ident(void)
8058eddac3fSPeter Zijlstra {
8068eddac3fSPeter Zijlstra 	printk("%s %.*s %s\n", init_utsname()->release,
8078eddac3fSPeter Zijlstra 		(int)strcspn(init_utsname()->version, " "),
8088eddac3fSPeter Zijlstra 		init_utsname()->version,
8098eddac3fSPeter Zijlstra 		print_tainted());
8108eddac3fSPeter Zijlstra }
8118eddac3fSPeter Zijlstra 
very_verbose(struct lock_class * class)8128eddac3fSPeter Zijlstra static int very_verbose(struct lock_class *class)
8138eddac3fSPeter Zijlstra {
8148eddac3fSPeter Zijlstra #if VERY_VERBOSE
8158eddac3fSPeter Zijlstra 	return class_filter(class);
8168eddac3fSPeter Zijlstra #endif
8178eddac3fSPeter Zijlstra 	return 0;
8188eddac3fSPeter Zijlstra }
8198eddac3fSPeter Zijlstra 
8208dce7a9aSSasha Levin /*
821108c1485SBart Van Assche  * Is this the address of a static object:
8228eddac3fSPeter Zijlstra  */
8230a6b58c5SHelge Deller #ifdef __KERNEL__
static_obj(const void * obj)8248eddac3fSPeter Zijlstra static int static_obj(const void *obj)
8250a6b58c5SHelge Deller {
8260a6b58c5SHelge Deller 	unsigned long addr = (unsigned long) obj;
8277a5da02dSGerald Schaefer 
8288eddac3fSPeter Zijlstra 	if (is_kernel_core_data(addr))
8290a6b58c5SHelge Deller 		return 1;
8308eddac3fSPeter Zijlstra 
8310a6b58c5SHelge Deller 	/*
8320a6b58c5SHelge Deller 	 * keys are allowed in the __ro_after_init section.
8330a6b58c5SHelge Deller 	 */
8340a6b58c5SHelge Deller 	if (is_kernel_rodata(addr))
8350a6b58c5SHelge Deller 		return 1;
8360a6b58c5SHelge Deller 
8370a6b58c5SHelge Deller 	/*
8380a6b58c5SHelge Deller 	 * in initdata section and used during bootup only?
8390a6b58c5SHelge Deller 	 * NOTE: On some platforms the initdata section is
8400a6b58c5SHelge Deller 	 * outside of the _stext ... _end range.
8418eddac3fSPeter Zijlstra 	 */
8428eddac3fSPeter Zijlstra 	if (system_state < SYSTEM_FREEING_INITMEM &&
8438eddac3fSPeter Zijlstra 		init_section_contains((void *)addr, 1))
8448eddac3fSPeter Zijlstra 		return 1;
8458eddac3fSPeter Zijlstra 
8468eddac3fSPeter Zijlstra 	/*
8478eddac3fSPeter Zijlstra 	 * in-kernel percpu var?
8488eddac3fSPeter Zijlstra 	 */
8498eddac3fSPeter Zijlstra 	if (is_kernel_percpu_address(addr))
8508eddac3fSPeter Zijlstra 		return 1;
8518eddac3fSPeter Zijlstra 
8528eddac3fSPeter Zijlstra 	/*
8538eddac3fSPeter Zijlstra 	 * module static or percpu var?
8548dce7a9aSSasha Levin 	 */
8558eddac3fSPeter Zijlstra 	return is_module_address(addr) || is_module_percpu_address(addr);
8568eddac3fSPeter Zijlstra }
8578eddac3fSPeter Zijlstra #endif
858fe27b0deSBart Van Assche 
859fe27b0deSBart Van Assche /*
8608eddac3fSPeter Zijlstra  * To make lock name printouts unique, we calculate a unique
8618eddac3fSPeter Zijlstra  * class->name_version generation counter. The caller must hold the graph
8628eddac3fSPeter Zijlstra  * lock.
8638eddac3fSPeter Zijlstra  */
count_matching_names(struct lock_class * new_class)8648eddac3fSPeter Zijlstra static int count_matching_names(struct lock_class *new_class)
8658eddac3fSPeter Zijlstra {
8668eddac3fSPeter Zijlstra 	struct lock_class *class;
8678eddac3fSPeter Zijlstra 	int count = 0;
8688eddac3fSPeter Zijlstra 
869fe27b0deSBart Van Assche 	if (!new_class->name)
8708eddac3fSPeter Zijlstra 		return 0;
8718eddac3fSPeter Zijlstra 
8728eddac3fSPeter Zijlstra 	list_for_each_entry(class, &all_lock_classes, lock_entry) {
8738eddac3fSPeter Zijlstra 		if (new_class->key - new_class->subclass == class->key)
8748eddac3fSPeter Zijlstra 			return class->name_version;
8758eddac3fSPeter Zijlstra 		if (class->name && !strcmp(class->name, new_class->name))
8768eddac3fSPeter Zijlstra 			count = max(count, class->name_version);
8778eddac3fSPeter Zijlstra 	}
8788eddac3fSPeter Zijlstra 
879f6f48e18SPeter Zijlstra 	return count + 1;
88049faa777SPeter Zijlstra }
88108f36ff6SMatthew Wilcox 
8828eddac3fSPeter Zijlstra /* used from NMI context -- must be lockless */
8838eddac3fSPeter Zijlstra static noinstr struct lock_class *
look_up_lock_class(const struct lockdep_map * lock,unsigned int subclass)884a63f38ccSAndrew Morton look_up_lock_class(const struct lockdep_map *lock, unsigned int subclass)
8858eddac3fSPeter Zijlstra {
8868eddac3fSPeter Zijlstra 	struct lockdep_subclass_key *key;
8878eddac3fSPeter Zijlstra 	struct hlist_head *hash_head;
88849faa777SPeter Zijlstra 	struct lock_class *class;
8898eddac3fSPeter Zijlstra 
8908eddac3fSPeter Zijlstra 	if (unlikely(subclass >= MAX_LOCKDEP_SUBCLASSES)) {
8918eddac3fSPeter Zijlstra 		instrumentation_begin();
8928eddac3fSPeter Zijlstra 		debug_locks_off();
8938eddac3fSPeter Zijlstra 		nbcon_cpu_emergency_enter();
8948eddac3fSPeter Zijlstra 		printk(KERN_ERR
89549faa777SPeter Zijlstra 			"BUG: looking up invalid subclass: %u\n", subclass);
8968eddac3fSPeter Zijlstra 		printk(KERN_ERR
8978eddac3fSPeter Zijlstra 			"turning off the locking correctness validator.\n");
8988eddac3fSPeter Zijlstra 		dump_stack();
8998eddac3fSPeter Zijlstra 		nbcon_cpu_emergency_exit();
90064f29d1bSMatthew Wilcox 		instrumentation_end();
90164f29d1bSMatthew Wilcox 		return NULL;
9028eddac3fSPeter Zijlstra 	}
90364f29d1bSMatthew Wilcox 
90464f29d1bSMatthew Wilcox 	/*
9058eddac3fSPeter Zijlstra 	 * If it is not initialised then it has never been locked,
9068eddac3fSPeter Zijlstra 	 * so it won't be present in the hash table.
9078eddac3fSPeter Zijlstra 	 */
9088eddac3fSPeter Zijlstra 	if (unlikely(!lock->key))
9098eddac3fSPeter Zijlstra 		return NULL;
9108eddac3fSPeter Zijlstra 
9118eddac3fSPeter Zijlstra 	/*
9128eddac3fSPeter Zijlstra 	 * NOTE: the class-key must be unique. For dynamic locks, a static
9138eddac3fSPeter Zijlstra 	 * lock_class_key variable is passed in through the mutex_init()
9148eddac3fSPeter Zijlstra 	 * (or spin_lock_init()) call - which acts as the key. For static
9158eddac3fSPeter Zijlstra 	 * locks we use the lock object itself as the key.
9168eddac3fSPeter Zijlstra 	 */
9178eddac3fSPeter Zijlstra 	BUILD_BUG_ON(sizeof(struct lock_class_key) >
9188eddac3fSPeter Zijlstra 			sizeof(struct lockdep_map));
9198eddac3fSPeter Zijlstra 
92035a9393cSPeter Zijlstra 	key = lock->key->subkeys + subclass;
9218eddac3fSPeter Zijlstra 
92235a9393cSPeter Zijlstra 	hash_head = classhashentry(key);
92335a9393cSPeter Zijlstra 
92435a9393cSPeter Zijlstra 	/*
925ce0b9c80SPeter Zijlstra 	 * We do an RCU walk of the hash, see lockdep_free_key_range().
9268eddac3fSPeter Zijlstra 	 */
9278eddac3fSPeter Zijlstra 	if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
9288eddac3fSPeter Zijlstra 		return NULL;
9298eddac3fSPeter Zijlstra 
9308eddac3fSPeter Zijlstra 	hlist_for_each_entry_rcu_notrace(class, hash_head, hash_entry) {
93176e64c73STetsuo Handa 		if (class->key == key) {
93276e64c73STetsuo Handa 			/*
93376e64c73STetsuo Handa 			 * Huh! same key, different name? Did someone trample
93476e64c73STetsuo Handa 			 * on some memory? We're most confused.
9358eddac3fSPeter Zijlstra 			 */
9368eddac3fSPeter Zijlstra 			WARN_ONCE(class->name != lock->name &&
9378eddac3fSPeter Zijlstra 				  lock->key != &__lockdep_no_validate__,
9388eddac3fSPeter Zijlstra 				  "Looking for class \"%s\" with key %ps, but found a different class \"%s\" with the same key\n",
93964f29d1bSMatthew Wilcox 				  lock->name, lock->key, class->name);
94064f29d1bSMatthew Wilcox 			return class;
94164f29d1bSMatthew Wilcox 		}
94264f29d1bSMatthew Wilcox 	}
94364f29d1bSMatthew Wilcox 
94464f29d1bSMatthew Wilcox 	return NULL;
94564f29d1bSMatthew Wilcox }
94664f29d1bSMatthew Wilcox 
94764f29d1bSMatthew Wilcox /*
94864f29d1bSMatthew Wilcox  * Static locks do not have their class-keys yet - for them the key is
94964f29d1bSMatthew Wilcox  * the lock object itself. If the lock is in the per cpu area, the
95064f29d1bSMatthew Wilcox  * canonical address of the lock (per cpu offset removed) is used.
9514bf50862SBart Van Assche  */
assign_lock_key(struct lockdep_map * lock)9524bf50862SBart Van Assche static bool assign_lock_key(struct lockdep_map *lock)
9534bf50862SBart Van Assche {
9544bf50862SBart Van Assche 	unsigned long can_addr, addr = (unsigned long)lock;
9554bf50862SBart Van Assche 
9564bf50862SBart Van Assche #ifdef __KERNEL__
9574bf50862SBart Van Assche 	/*
9584bf50862SBart Van Assche 	 * lockdep_free_key_range() assumes that struct lock_class_key
9594bf50862SBart Van Assche 	 * objects do not overlap. Since we use the address of lock
9604bf50862SBart Van Assche 	 * objects as class key for static objects, check whether the
9614bf50862SBart Van Assche 	 * size of lock_class_key objects does not exceed the size of
96264f29d1bSMatthew Wilcox 	 * the smallest lock object.
96364f29d1bSMatthew Wilcox 	 */
96464f29d1bSMatthew Wilcox 	BUILD_BUG_ON(sizeof(struct lock_class_key) > sizeof(raw_spinlock_t));
96564f29d1bSMatthew Wilcox #endif
96664f29d1bSMatthew Wilcox 
96764f29d1bSMatthew Wilcox 	if (__is_kernel_percpu_address(addr, &can_addr))
96864f29d1bSMatthew Wilcox 		lock->key = (void *)can_addr;
96964f29d1bSMatthew Wilcox 	else if (__is_module_percpu_address(addr, &can_addr))
97064f29d1bSMatthew Wilcox 		lock->key = (void *)can_addr;
97164f29d1bSMatthew Wilcox 	else if (static_obj(lock))
9723a85969eSTetsuo Handa 		lock->key = (void *)lock;
9733a85969eSTetsuo Handa 	else {
97464f29d1bSMatthew Wilcox 		/* Debug-check: all keys must be persistent! */
97564f29d1bSMatthew Wilcox 		debug_locks_off();
97664f29d1bSMatthew Wilcox 		nbcon_cpu_emergency_enter();
97764f29d1bSMatthew Wilcox 		pr_err("INFO: trying to register non-static key.\n");
97864f29d1bSMatthew Wilcox 		pr_err("The code is fine but needs lockdep annotation, or maybe\n");
97964f29d1bSMatthew Wilcox 		pr_err("you didn't initialize this object before use?\n");
9808eddac3fSPeter Zijlstra 		pr_err("turning off the locking correctness validator.\n");
9818eddac3fSPeter Zijlstra 		dump_stack();
98272dcd505SPeter Zijlstra 		nbcon_cpu_emergency_exit();
98372dcd505SPeter Zijlstra 		return false;
984b526b2e3SBart Van Assche 	}
985b526b2e3SBart Van Assche 
986b526b2e3SBart Van Assche 	return true;
987b526b2e3SBart Van Assche }
988b526b2e3SBart Van Assche 
989b526b2e3SBart Van Assche #ifdef CONFIG_DEBUG_LOCKDEP
990b526b2e3SBart Van Assche 
991b526b2e3SBart Van Assche /* Check whether element @e occurs in list @h */
in_list(struct list_head * e,struct list_head * h)992b526b2e3SBart Van Assche static bool in_list(struct list_head *e, struct list_head *h)
993b526b2e3SBart Van Assche {
994b526b2e3SBart Van Assche 	struct list_head *f;
995b526b2e3SBart Van Assche 
996b526b2e3SBart Van Assche 	list_for_each(f, h) {
997b526b2e3SBart Van Assche 		if (e == f)
998b526b2e3SBart Van Assche 			return true;
999b526b2e3SBart Van Assche 	}
1000b526b2e3SBart Van Assche 
1001b526b2e3SBart Van Assche 	return false;
1002b526b2e3SBart Van Assche }
1003b526b2e3SBart Van Assche 
1004b526b2e3SBart Van Assche /*
1005b526b2e3SBart Van Assche  * Check whether entry @e occurs in any of the locks_after or locks_before
1006b526b2e3SBart Van Assche  * lists.
1007b526b2e3SBart Van Assche  */
in_any_class_list(struct list_head * e)1008b526b2e3SBart Van Assche static bool in_any_class_list(struct list_head *e)
1009b526b2e3SBart Van Assche {
1010b526b2e3SBart Van Assche 	struct lock_class *class;
1011b526b2e3SBart Van Assche 	int i;
1012b526b2e3SBart Van Assche 
1013b526b2e3SBart Van Assche 	for (i = 0; i < ARRAY_SIZE(lock_classes); i++) {
1014b526b2e3SBart Van Assche 		class = &lock_classes[i];
1015b526b2e3SBart Van Assche 		if (in_list(e, &class->locks_after) ||
1016b526b2e3SBart Van Assche 		    in_list(e, &class->locks_before))
1017b526b2e3SBart Van Assche 			return true;
1018b526b2e3SBart Van Assche 	}
1019b526b2e3SBart Van Assche 	return false;
1020b526b2e3SBart Van Assche }
1021b526b2e3SBart Van Assche 
class_lock_list_valid(struct lock_class * c,struct list_head * h)1022b526b2e3SBart Van Assche static bool class_lock_list_valid(struct lock_class *c, struct list_head *h)
1023b526b2e3SBart Van Assche {
1024b526b2e3SBart Van Assche 	struct lock_list *e;
1025b526b2e3SBart Van Assche 
1026b526b2e3SBart Van Assche 	list_for_each_entry(e, h, entry) {
1027b526b2e3SBart Van Assche 		if (e->links_to != c) {
1028b526b2e3SBart Van Assche 			printk(KERN_INFO "class %s: mismatch for lock entry %ld; class %s <> %s",
1029b526b2e3SBart Van Assche 			       c->name ? : "(?)",
1030b526b2e3SBart Van Assche 			       (unsigned long)(e - list_entries),
1031b526b2e3SBart Van Assche 			       e->links_to && e->links_to->name ?
1032b526b2e3SBart Van Assche 			       e->links_to->name : "(?)",
1033b526b2e3SBart Van Assche 			       e->class && e->class->name ? e->class->name :
10343fe7522fSArnd Bergmann 			       "(?)");
10353fe7522fSArnd Bergmann 			return false;
10363fe7522fSArnd Bergmann 		}
1037b526b2e3SBart Van Assche 	}
1038b526b2e3SBart Van Assche 	return true;
1039b526b2e3SBart Van Assche }
1040b526b2e3SBart Van Assche 
1041f6ec8829SYuyang Du #ifdef CONFIG_PROVE_LOCKING
1042b526b2e3SBart Van Assche static u16 chain_hlocks[MAX_LOCKDEP_CHAIN_HLOCKS];
1043b526b2e3SBart Van Assche #endif
1044b526b2e3SBart Van Assche 
check_lock_chain_key(struct lock_chain * chain)104501bb6f0aSYuyang Du static bool check_lock_chain_key(struct lock_chain *chain)
1046b526b2e3SBart Van Assche {
1047b526b2e3SBart Van Assche #ifdef CONFIG_PROVE_LOCKING
1048b526b2e3SBart Van Assche 	u64 chain_key = INITIAL_CHAIN_KEY;
1049b526b2e3SBart Van Assche 	int i;
105072dcd505SPeter Zijlstra 
1051b526b2e3SBart Van Assche 	for (i = chain->base; i < chain->base + chain->depth; i++)
1052b526b2e3SBart Van Assche 		chain_key = iterate_chain_key(chain_key, chain_hlocks[i]);
1053b526b2e3SBart Van Assche 	/*
1054b526b2e3SBart Van Assche 	 * The 'unsigned long long' casts avoid that a compiler warning
105572dcd505SPeter Zijlstra 	 * is reported when building tools/lib/lockdep.
105672dcd505SPeter Zijlstra 	 */
1057b526b2e3SBart Van Assche 	if (chain->chain_key != chain_key) {
105872dcd505SPeter Zijlstra 		printk(KERN_INFO "chain %lld: key %#llx <> %#llx\n",
1059b526b2e3SBart Van Assche 		       (unsigned long long)(chain - lock_chains),
1060b526b2e3SBart Van Assche 		       (unsigned long long)chain->chain_key,
1061b526b2e3SBart Van Assche 		       (unsigned long long)chain_key);
1062b526b2e3SBart Van Assche 		return false;
1063b526b2e3SBart Van Assche 	}
1064b526b2e3SBart Van Assche #endif
1065b526b2e3SBart Van Assche 	return true;
106672dcd505SPeter Zijlstra }
1067b526b2e3SBart Van Assche 
in_any_zapped_class_list(struct lock_class * class)1068b526b2e3SBart Van Assche static bool in_any_zapped_class_list(struct lock_class *class)
106972dcd505SPeter Zijlstra {
1070b526b2e3SBart Van Assche 	struct pending_free *pf;
1071b526b2e3SBart Van Assche 	int i;
1072b526b2e3SBart Van Assche 
1073b526b2e3SBart Van Assche 	for (i = 0, pf = delayed_free.pf; i < ARRAY_SIZE(delayed_free.pf); i++, pf++) {
107472dcd505SPeter Zijlstra 		if (in_list(&class->lock_entry, &pf->zapped))
1075b526b2e3SBart Van Assche 			return true;
1076b526b2e3SBart Van Assche 	}
1077b526b2e3SBart Van Assche 
1078b526b2e3SBart Van Assche 	return false;
1079b526b2e3SBart Van Assche }
1080b526b2e3SBart Van Assche 
__check_data_structures(void)1081b526b2e3SBart Van Assche static bool __check_data_structures(void)
1082b526b2e3SBart Van Assche {
1083b526b2e3SBart Van Assche 	struct lock_class *class;
1084b526b2e3SBart Van Assche 	struct lock_chain *chain;
1085b526b2e3SBart Van Assche 	struct hlist_head *head;
1086b526b2e3SBart Van Assche 	struct lock_list *e;
1087b526b2e3SBart Van Assche 	int i;
1088b526b2e3SBart Van Assche 
1089b526b2e3SBart Van Assche 	/* Check whether all classes occur in a lock list. */
1090b526b2e3SBart Van Assche 	for (i = 0; i < ARRAY_SIZE(lock_classes); i++) {
1091b526b2e3SBart Van Assche 		class = &lock_classes[i];
1092b526b2e3SBart Van Assche 		if (!in_list(&class->lock_entry, &all_lock_classes) &&
1093b526b2e3SBart Van Assche 		    !in_list(&class->lock_entry, &free_lock_classes) &&
1094b526b2e3SBart Van Assche 		    !in_any_zapped_class_list(class)) {
1095b526b2e3SBart Van Assche 			printk(KERN_INFO "class %px/%s is not in any class list\n",
1096b526b2e3SBart Van Assche 			       class, class->name ? : "(?)");
1097b526b2e3SBart Van Assche 			return false;
1098b526b2e3SBart Van Assche 		}
1099b526b2e3SBart Van Assche 	}
1100b526b2e3SBart Van Assche 
1101b526b2e3SBart Van Assche 	/* Check whether all classes have valid lock lists. */
1102b526b2e3SBart Van Assche 	for (i = 0; i < ARRAY_SIZE(lock_classes); i++) {
1103b526b2e3SBart Van Assche 		class = &lock_classes[i];
1104b526b2e3SBart Van Assche 		if (!class_lock_list_valid(class, &class->locks_before))
1105b526b2e3SBart Van Assche 			return false;
1106b526b2e3SBart Van Assche 		if (!class_lock_list_valid(class, &class->locks_after))
1107b526b2e3SBart Van Assche 			return false;
1108b526b2e3SBart Van Assche 	}
1109b526b2e3SBart Van Assche 
1110b526b2e3SBart Van Assche 	/* Check the chain_key of all lock chains. */
1111b526b2e3SBart Van Assche 	for (i = 0; i < ARRAY_SIZE(chainhash_table); i++) {
1112b526b2e3SBart Van Assche 		head = chainhash_table + i;
1113b526b2e3SBart Van Assche 		hlist_for_each_entry_rcu(chain, head, entry) {
1114b526b2e3SBart Van Assche 			if (!check_lock_chain_key(chain))
1115b526b2e3SBart Van Assche 				return false;
1116b526b2e3SBart Van Assche 		}
1117b526b2e3SBart Van Assche 	}
1118b526b2e3SBart Van Assche 
1119b526b2e3SBart Van Assche 	/*
1120b526b2e3SBart Van Assche 	 * Check whether all list entries that are in use occur in a class
1121b526b2e3SBart Van Assche 	 * lock list.
1122b526b2e3SBart Van Assche 	 */
1123b526b2e3SBart Van Assche 	for_each_set_bit(i, list_entries_in_use, ARRAY_SIZE(list_entries)) {
1124b526b2e3SBart Van Assche 		e = list_entries + i;
1125b526b2e3SBart Van Assche 		if (!in_any_class_list(&e->entry)) {
1126b526b2e3SBart Van Assche 			printk(KERN_INFO "list entry %d is not in any class list; class %s <> %s\n",
1127b526b2e3SBart Van Assche 			       (unsigned int)(e - list_entries),
1128b526b2e3SBart Van Assche 			       e->class->name ? : "(?)",
1129b526b2e3SBart Van Assche 			       e->links_to->name ? : "(?)");
1130b526b2e3SBart Van Assche 			return false;
1131b526b2e3SBart Van Assche 		}
1132b526b2e3SBart Van Assche 	}
1133b526b2e3SBart Van Assche 
1134b526b2e3SBart Van Assche 	/*
1135b526b2e3SBart Van Assche 	 * Check whether all list entries that are not in use do not occur in
1136b526b2e3SBart Van Assche 	 * a class lock list.
1137b526b2e3SBart Van Assche 	 */
1138b526b2e3SBart Van Assche 	for_each_clear_bit(i, list_entries_in_use, ARRAY_SIZE(list_entries)) {
1139b526b2e3SBart Van Assche 		e = list_entries + i;
1140b526b2e3SBart Van Assche 		if (in_any_class_list(&e->entry)) {
1141b526b2e3SBart Van Assche 			printk(KERN_INFO "list entry %d occurs in a class list; class %s <> %s\n",
1142b526b2e3SBart Van Assche 			       (unsigned int)(e - list_entries),
1143b526b2e3SBart Van Assche 			       e->class && e->class->name ? e->class->name :
1144b526b2e3SBart Van Assche 			       "(?)",
1145b526b2e3SBart Van Assche 			       e->links_to && e->links_to->name ?
1146b526b2e3SBart Van Assche 			       e->links_to->name : "(?)");
114772dcd505SPeter Zijlstra 			return false;
114872dcd505SPeter Zijlstra 		}
114972dcd505SPeter Zijlstra 	}
115072dcd505SPeter Zijlstra 
115172dcd505SPeter Zijlstra 	return true;
115272dcd505SPeter Zijlstra }
115372dcd505SPeter Zijlstra 
115472dcd505SPeter Zijlstra int check_consistency = 0;
115572dcd505SPeter Zijlstra module_param(check_consistency, int, 0644);
115672dcd505SPeter Zijlstra 
check_data_structures(void)115772dcd505SPeter Zijlstra static void check_data_structures(void)
115872dcd505SPeter Zijlstra {
115972dcd505SPeter Zijlstra 	static bool once = false;
116072dcd505SPeter Zijlstra 
116172dcd505SPeter Zijlstra 	if (check_consistency && !once) {
116272dcd505SPeter Zijlstra 		if (!__check_data_structures()) {
116372dcd505SPeter Zijlstra 			once = true;
116472dcd505SPeter Zijlstra 			WARN_ON(once);
116572dcd505SPeter Zijlstra 		}
116672dcd505SPeter Zijlstra 	}
116772dcd505SPeter Zijlstra }
1168810507feSWaiman Long 
1169810507feSWaiman Long #else /* CONFIG_DEBUG_LOCKDEP */
11708eddac3fSPeter Zijlstra 
check_data_structures(void)1171a0b0fd53SBart Van Assche static inline void check_data_structures(void) { }
1172a0b0fd53SBart Van Assche 
1173feb0a386SBart Van Assche #endif /* CONFIG_DEBUG_LOCKDEP */
1174feb0a386SBart Van Assche 
1175feb0a386SBart Van Assche static void init_chain_block_buckets(void);
1176810507feSWaiman Long 
1177feb0a386SBart Van Assche /*
1178feb0a386SBart Van Assche  * Initialize the lock_classes[] array elements, the free_lock_classes list
11790126574fSBart Van Assche  * and also the delayed_free structure.
1180feb0a386SBart Van Assche  */
init_data_structures_once(void)1181feb0a386SBart Van Assche static void init_data_structures_once(void)
11820126574fSBart Van Assche {
1183a0b0fd53SBart Van Assche 	static bool __read_mostly ds_initialized, rcu_head_initialized;
11840126574fSBart Van Assche 	int i;
11850126574fSBart Van Assche 
11860126574fSBart Van Assche 	if (likely(rcu_head_initialized))
11870126574fSBart Van Assche 		return;
11880126574fSBart Van Assche 
11890126574fSBart Van Assche 	if (system_state >= SYSTEM_SCHEDULING) {
11900126574fSBart Van Assche 		init_rcu_head(&delayed_free.rcu_head);
11910126574fSBart Van Assche 		rcu_head_initialized = true;
1192a0b0fd53SBart Van Assche 	}
1193a0b0fd53SBart Van Assche 
1194a0b0fd53SBart Van Assche 	if (ds_initialized)
1195feb0a386SBart Van Assche 		return;
1196a0b0fd53SBart Van Assche 
1197feb0a386SBart Van Assche 	ds_initialized = true;
1198feb0a386SBart Van Assche 
1199feb0a386SBart Van Assche 	INIT_LIST_HEAD(&delayed_free.pf[0].zapped);
1200810507feSWaiman Long 	INIT_LIST_HEAD(&delayed_free.pf[1].zapped);
1201feb0a386SBart Van Assche 
1202feb0a386SBart Van Assche 	for (i = 0; i < ARRAY_SIZE(lock_classes); i++) {
1203108c1485SBart Van Assche 		list_add_tail(&lock_classes[i].lock_entry, &free_lock_classes);
1204108c1485SBart Van Assche 		INIT_LIST_HEAD(&lock_classes[i].locks_after);
1205108c1485SBart Van Assche 		INIT_LIST_HEAD(&lock_classes[i].locks_before);
1206108c1485SBart Van Assche 	}
1207108c1485SBart Van Assche 	init_chain_block_buckets();
1208108c1485SBart Van Assche }
1209108c1485SBart Van Assche 
keyhashentry(const struct lock_class_key * key)1210108c1485SBart Van Assche static inline struct hlist_head *keyhashentry(const struct lock_class_key *key)
1211108c1485SBart Van Assche {
1212108c1485SBart Van Assche 	unsigned long hash = hash_long((uintptr_t)key, KEYHASH_BITS);
1213108c1485SBart Van Assche 
1214108c1485SBart Van Assche 	return lock_keys_hash + hash;
1215108c1485SBart Van Assche }
1216108c1485SBart Van Assche 
1217108c1485SBart Van Assche /* Register a dynamically allocated key. */
lockdep_register_key(struct lock_class_key * key)1218108c1485SBart Van Assche void lockdep_register_key(struct lock_class_key *key)
1219108c1485SBart Van Assche {
1220108c1485SBart Van Assche 	struct hlist_head *hash_head;
1221108c1485SBart Van Assche 	struct lock_class_key *k;
1222108c1485SBart Van Assche 	unsigned long flags;
1223108c1485SBart Van Assche 
1224108c1485SBart Van Assche 	if (WARN_ON_ONCE(static_obj(key)))
1225108c1485SBart Van Assche 		return;
1226108c1485SBart Van Assche 	hash_head = keyhashentry(key);
1227108c1485SBart Van Assche 
1228108c1485SBart Van Assche 	raw_local_irq_save(flags);
1229108c1485SBart Van Assche 	if (!graph_lock())
1230108c1485SBart Van Assche 		goto restore_irqs;
1231108c1485SBart Van Assche 	hlist_for_each_entry_rcu(k, hash_head, hash_entry) {
1232108c1485SBart Van Assche 		if (WARN_ON_ONCE(k == key))
1233108c1485SBart Van Assche 			goto out_unlock;
1234108c1485SBart Van Assche 	}
1235108c1485SBart Van Assche 	hlist_add_head_rcu(&key->hash_entry, hash_head);
1236108c1485SBart Van Assche out_unlock:
1237108c1485SBart Van Assche 	graph_unlock();
1238108c1485SBart Van Assche restore_irqs:
1239108c1485SBart Van Assche 	raw_local_irq_restore(flags);
1240108c1485SBart Van Assche }
1241108c1485SBart Van Assche EXPORT_SYMBOL_GPL(lockdep_register_key);
1242108c1485SBart Van Assche 
1243108c1485SBart Van Assche /* Check whether a key has been registered as a dynamic key. */
is_dynamic_key(const struct lock_class_key * key)1244108c1485SBart Van Assche static bool is_dynamic_key(const struct lock_class_key *key)
1245108c1485SBart Van Assche {
1246108c1485SBart Van Assche 	struct hlist_head *hash_head;
1247108c1485SBart Van Assche 	struct lock_class_key *k;
1248108c1485SBart Van Assche 	bool found = false;
1249108c1485SBart Van Assche 
1250108c1485SBart Van Assche 	if (WARN_ON_ONCE(static_obj(key)))
1251108c1485SBart Van Assche 		return false;
1252108c1485SBart Van Assche 
1253108c1485SBart Van Assche 	/*
1254108c1485SBart Van Assche 	 * If lock debugging is disabled lock_keys_hash[] may contain
1255108c1485SBart Van Assche 	 * pointers to memory that has already been freed. Avoid triggering
1256108c1485SBart Van Assche 	 * a use-after-free in that case by returning early.
1257108c1485SBart Van Assche 	 */
1258108c1485SBart Van Assche 	if (!debug_locks)
1259108c1485SBart Van Assche 		return true;
1260108c1485SBart Van Assche 
1261108c1485SBart Van Assche 	hash_head = keyhashentry(key);
1262108c1485SBart Van Assche 
1263108c1485SBart Van Assche 	rcu_read_lock();
1264108c1485SBart Van Assche 	hlist_for_each_entry_rcu(k, hash_head, hash_entry) {
1265108c1485SBart Van Assche 		if (k == key) {
1266108c1485SBart Van Assche 			found = true;
1267108c1485SBart Van Assche 			break;
1268feb0a386SBart Van Assche 		}
12698eddac3fSPeter Zijlstra 	}
12708eddac3fSPeter Zijlstra 	rcu_read_unlock();
12718eddac3fSPeter Zijlstra 
12728eddac3fSPeter Zijlstra 	return found;
1273c003ed92SDenys Vlasenko }
12748eddac3fSPeter Zijlstra 
12758eddac3fSPeter Zijlstra /*
12768eddac3fSPeter Zijlstra  * Register a lock's class in the hash-table, if the class is not present
1277a63f38ccSAndrew Morton  * yet. Otherwise we look it up. We cache the result in the lock object
12788eddac3fSPeter Zijlstra  * itself, so actual lookup of the hash should be once per lock object.
1279fb7275acSWaiman Long  */
128035a9393cSPeter Zijlstra static struct lock_class *
register_lock_class(struct lockdep_map * lock,unsigned int subclass,int force)128135a9393cSPeter Zijlstra register_lock_class(struct lockdep_map *lock, unsigned int subclass, int force)
12828eddac3fSPeter Zijlstra {
12838eddac3fSPeter Zijlstra 	struct lockdep_subclass_key *key;
128464f29d1bSMatthew Wilcox 	struct hlist_head *hash_head;
12858eddac3fSPeter Zijlstra 	struct lock_class *class;
12868eddac3fSPeter Zijlstra 	int idx;
128764f29d1bSMatthew Wilcox 
128864f29d1bSMatthew Wilcox 	DEBUG_LOCKS_WARN_ON(!irqs_disabled());
128964f29d1bSMatthew Wilcox 
1290108c1485SBart Van Assche 	class = look_up_lock_class(lock, subclass);
12918eddac3fSPeter Zijlstra 	if (likely(class))
12928eddac3fSPeter Zijlstra 		goto out_set_class_cache;
12938eddac3fSPeter Zijlstra 
12948eddac3fSPeter Zijlstra 	if (!lock->key) {
12958eddac3fSPeter Zijlstra 		if (!assign_lock_key(lock))
12968eddac3fSPeter Zijlstra 			return NULL;
12978eddac3fSPeter Zijlstra 	} else if (!static_obj(lock->key) && !is_dynamic_key(lock->key)) {
12988eddac3fSPeter Zijlstra 		return NULL;
12998eddac3fSPeter Zijlstra 	}
13008eddac3fSPeter Zijlstra 
13018eddac3fSPeter Zijlstra 	key = lock->key->subkeys + subclass;
13028eddac3fSPeter Zijlstra 	hash_head = classhashentry(key);
13038eddac3fSPeter Zijlstra 
1304a63f38ccSAndrew Morton 	if (!graph_lock()) {
13058eddac3fSPeter Zijlstra 		return NULL;
13068eddac3fSPeter Zijlstra 	}
130735a9393cSPeter Zijlstra 	/*
130835a9393cSPeter Zijlstra 	 * We have to do the hash-walk again, to avoid races
1309feb0a386SBart Van Assche 	 * with another CPU:
1310feb0a386SBart Van Assche 	 */
1311a0b0fd53SBart Van Assche 	hlist_for_each_entry_rcu(class, hash_head, hash_entry) {
1312a0b0fd53SBart Van Assche 		if (class->key == key)
1313a0b0fd53SBart Van Assche 			goto out_unlock_set;
1314a0b0fd53SBart Van Assche 	}
13158eddac3fSPeter Zijlstra 
13168eddac3fSPeter Zijlstra 	init_data_structures_once();
13178eddac3fSPeter Zijlstra 
13188eddac3fSPeter Zijlstra 	/* Allocate a new lock class and add it to the hash. */
13198eddac3fSPeter Zijlstra 	class = list_first_entry_or_null(&free_lock_classes, typeof(*class),
13208eddac3fSPeter Zijlstra 					 lock_entry);
13218eddac3fSPeter Zijlstra 	if (!class) {
13228eddac3fSPeter Zijlstra 		if (!debug_locks_off_graph_unlock()) {
1323a0b0fd53SBart Van Assche 			return NULL;
132401bb6f0aSYuyang Du 		}
13258eddac3fSPeter Zijlstra 
13268eddac3fSPeter Zijlstra 		nbcon_cpu_emergency_enter();
13278eddac3fSPeter Zijlstra 		print_lockdep_off("BUG: MAX_LOCKDEP_KEYS too low!");
13288eddac3fSPeter Zijlstra 		dump_stack();
1329feb0a386SBart Van Assche 		nbcon_cpu_emergency_exit();
1330feb0a386SBart Van Assche 		return NULL;
13318eddac3fSPeter Zijlstra 	}
1332de8f5e4fSPeter Zijlstra 	nr_lock_classes++;
1333de8f5e4fSPeter Zijlstra 	__set_bit(class - lock_classes, lock_classes_in_use);
1334dfd5e3f5SPeter Zijlstra 	debug_atomic_inc(nr_unused_locks);
13358eddac3fSPeter Zijlstra 	class->key = key;
13368eddac3fSPeter Zijlstra 	class->name = lock->name;
13378eddac3fSPeter Zijlstra 	class->subclass = subclass;
13388eddac3fSPeter Zijlstra 	WARN_ON_ONCE(!list_empty(&class->locks_before));
1339a63f38ccSAndrew Morton 	WARN_ON_ONCE(!list_empty(&class->locks_after));
13408eddac3fSPeter Zijlstra 	class->name_version = count_matching_names(class);
1341a0b0fd53SBart Van Assche 	class->wait_type_inner = lock->wait_type_inner;
1342a0b0fd53SBart Van Assche 	class->wait_type_outer = lock->wait_type_outer;
13438eddac3fSPeter Zijlstra 	class->lock_type = lock->lock_type;
1344a0b0fd53SBart Van Assche 	/*
1345fb7275acSWaiman Long 	 * We use RCU's safe list-add method to make
1346fb7275acSWaiman Long 	 * parallel walking of the hash-list safe:
1347fb7275acSWaiman Long 	 */
13488eddac3fSPeter Zijlstra 	hlist_add_head_rcu(&class->hash_entry, hash_head);
13498eddac3fSPeter Zijlstra 	/*
13508eddac3fSPeter Zijlstra 	 * Remove the class from the free list and add it to the global list
13518eddac3fSPeter Zijlstra 	 * of classes.
135204860d48SBorislav Petkov 	 */
13538eddac3fSPeter Zijlstra 	list_move_tail(&class->lock_entry, &all_lock_classes);
1354f943fe0fSDmitry Vyukov 	idx = class - lock_classes;
1355f943fe0fSDmitry Vyukov 	if (idx > max_lock_class_idx)
13568eddac3fSPeter Zijlstra 		max_lock_class_idx = idx;
13578eddac3fSPeter Zijlstra 
13588eddac3fSPeter Zijlstra 	if (verbose(class)) {
13598eddac3fSPeter Zijlstra 		graph_unlock();
13608eddac3fSPeter Zijlstra 
13618eddac3fSPeter Zijlstra 		nbcon_cpu_emergency_enter();
13628eddac3fSPeter Zijlstra 		printk("\nnew class %px: %s", class->key, class->name);
13638eddac3fSPeter Zijlstra 		if (class->name_version > 1)
13648eddac3fSPeter Zijlstra 			printk(KERN_CONT "#%d", class->name_version);
13658eddac3fSPeter Zijlstra 		printk(KERN_CONT "\n");
13668eddac3fSPeter Zijlstra 		dump_stack();
13678eddac3fSPeter Zijlstra 		nbcon_cpu_emergency_exit();
13688eddac3fSPeter Zijlstra 
13698eddac3fSPeter Zijlstra 		if (!graph_lock()) {
13708eddac3fSPeter Zijlstra 			return NULL;
13718eddac3fSPeter Zijlstra 		}
13728eddac3fSPeter Zijlstra 	}
13738eddac3fSPeter Zijlstra out_unlock_set:
13748eddac3fSPeter Zijlstra 	graph_unlock();
13758eddac3fSPeter Zijlstra 
13768eddac3fSPeter Zijlstra out_set_class_cache:
13778eddac3fSPeter Zijlstra 	if (!subclass || force)
13788eddac3fSPeter Zijlstra 		lock->class_cache[0] = class;
13798eddac3fSPeter Zijlstra 	else if (subclass < NR_LOCKDEP_CACHING_CLASSES)
13808eddac3fSPeter Zijlstra 		lock->class_cache[subclass] = class;
13818eddac3fSPeter Zijlstra 
13828eddac3fSPeter Zijlstra 	/*
13838eddac3fSPeter Zijlstra 	 * Hash collision, did we smoke some? We found a class with a matching
13848eddac3fSPeter Zijlstra 	 * hash but the subclass -- which is hashed in -- didn't match.
13858eddac3fSPeter Zijlstra 	 */
13868eddac3fSPeter Zijlstra 	if (DEBUG_LOCKS_WARN_ON(class->subclass != subclass))
13878eddac3fSPeter Zijlstra 		return NULL;
1388ace35a7aSBart Van Assche 
1389ace35a7aSBart Van Assche 	return class;
1390ace35a7aSBart Van Assche }
1391ace35a7aSBart Van Assche 
13928eddac3fSPeter Zijlstra #ifdef CONFIG_PROVE_LOCKING
13938eddac3fSPeter Zijlstra /*
13948eddac3fSPeter Zijlstra  * Allocate a lockdep entry. (assumes the graph_lock held, returns
13958eddac3fSPeter Zijlstra  * with NULL on failure)
13968eddac3fSPeter Zijlstra  */
alloc_list_entry(void)13978eddac3fSPeter Zijlstra static struct lock_list *alloc_list_entry(void)
13988eddac3fSPeter Zijlstra {
1399ace35a7aSBart Van Assche 	int idx = find_first_zero_bit(list_entries_in_use,
1400ace35a7aSBart Van Assche 				      ARRAY_SIZE(list_entries));
1401ace35a7aSBart Van Assche 
14028eddac3fSPeter Zijlstra 	if (idx >= ARRAY_SIZE(list_entries)) {
14038eddac3fSPeter Zijlstra 		if (!debug_locks_off_graph_unlock())
14048eddac3fSPeter Zijlstra 			return NULL;
14058eddac3fSPeter Zijlstra 
14068eddac3fSPeter Zijlstra 		nbcon_cpu_emergency_enter();
140786cffb80SBart Van Assche 		print_lockdep_off("BUG: MAX_LOCKDEP_ENTRIES too low!");
140886cffb80SBart Van Assche 		dump_stack();
14098b023accSNick Desaulniers 		nbcon_cpu_emergency_exit();
141012593b74SBart Van Assche 		return NULL;
14118eddac3fSPeter Zijlstra 	}
14128eddac3fSPeter Zijlstra 	nr_list_entries++;
14138eddac3fSPeter Zijlstra 	__set_bit(idx, list_entries_in_use);
14148eddac3fSPeter Zijlstra 	return list_entries + idx;
14158eddac3fSPeter Zijlstra }
14168eddac3fSPeter Zijlstra 
14178eddac3fSPeter Zijlstra /*
14188eddac3fSPeter Zijlstra  * Add a new dependency to the head of the list:
14198eddac3fSPeter Zijlstra  */
add_lock_to_list(struct lock_class * this,struct lock_class * links_to,struct list_head * head,u16 distance,u8 dep,const struct lock_trace * trace)14208eddac3fSPeter Zijlstra static int add_lock_to_list(struct lock_class *this,
14218eddac3fSPeter Zijlstra 			    struct lock_class *links_to, struct list_head *head,
142286cffb80SBart Van Assche 			    u16 distance, u8 dep,
14233454a36dSBoqun Feng 			    const struct lock_trace *trace)
14248eddac3fSPeter Zijlstra {
142512593b74SBart Van Assche 	struct lock_list *entry;
14268eddac3fSPeter Zijlstra 	/*
142735a9393cSPeter Zijlstra 	 * Lock not present yet - get a new dependency struct and
142835a9393cSPeter Zijlstra 	 * add it to the list:
142935a9393cSPeter Zijlstra 	 */
14308eddac3fSPeter Zijlstra 	entry = alloc_list_entry();
14318eddac3fSPeter Zijlstra 	if (!entry)
14328eddac3fSPeter Zijlstra 		return 0;
14338eddac3fSPeter Zijlstra 
14348eddac3fSPeter Zijlstra 	entry->class = this;
14358eddac3fSPeter Zijlstra 	entry->links_to = links_to;
14368eddac3fSPeter Zijlstra 	entry->dep = dep;
14378eddac3fSPeter Zijlstra 	entry->distance = distance;
14388eddac3fSPeter Zijlstra 	entry->trace = trace;
14395dc33592STetsuo Handa 	/*
14408eddac3fSPeter Zijlstra 	 * Both allocation and removal are done under the graph lock; but
14418eddac3fSPeter Zijlstra 	 * iteration is under RCU-sched; see look_up_lock_class() and
14428eddac3fSPeter Zijlstra 	 * lockdep_free_key_range().
1443aa480771SYuyang Du 	 */
1444aa480771SYuyang Du 	list_add_tail_rcu(&entry->entry, head);
1445aa480771SYuyang Du 
1446aa480771SYuyang Du 	return 1;
1447aa480771SYuyang Du }
1448aa480771SYuyang Du 
1449aa480771SYuyang Du /*
1450aa480771SYuyang Du  * For good efficiency of modular, we use power of 2
14518eddac3fSPeter Zijlstra  */
14528eddac3fSPeter Zijlstra #define MAX_CIRCULAR_QUEUE_SIZE		(1UL << CONFIG_LOCKDEP_CIRCULAR_QUEUE_BITS)
1453aa480771SYuyang Du #define CQ_MASK				(MAX_CIRCULAR_QUEUE_SIZE-1)
14548eddac3fSPeter Zijlstra 
14558eddac3fSPeter Zijlstra /*
14568eddac3fSPeter Zijlstra  * The circular_queue and helpers are used to implement graph
14578eddac3fSPeter Zijlstra  * breadth-first search (BFS) algorithm, by which we can determine
14588eddac3fSPeter Zijlstra  * whether there is a path from a lock to another. In deadlock checks,
14598eddac3fSPeter Zijlstra  * a path from the next lock to be acquired to a previous held lock
14608eddac3fSPeter Zijlstra  * indicates that adding the <prev> -> <next> lock dependency will
14618eddac3fSPeter Zijlstra  * produce a circle in the graph. Breadth-first search instead of
14628eddac3fSPeter Zijlstra  * depth-first search is used in order to find the shortest (circular)
14638eddac3fSPeter Zijlstra  * path.
14648eddac3fSPeter Zijlstra  */
14658eddac3fSPeter Zijlstra struct circular_queue {
14668eddac3fSPeter Zijlstra 	struct lock_list *element[MAX_CIRCULAR_QUEUE_SIZE];
14678eddac3fSPeter Zijlstra 	unsigned int  front, rear;
14688eddac3fSPeter Zijlstra };
14698eddac3fSPeter Zijlstra 
14708eddac3fSPeter Zijlstra static struct circular_queue lock_cq;
14718eddac3fSPeter Zijlstra 
14728eddac3fSPeter Zijlstra unsigned int max_bfs_queue_depth;
14738eddac3fSPeter Zijlstra 
14748eddac3fSPeter Zijlstra static unsigned int lockdep_dependency_gen_id;
14758eddac3fSPeter Zijlstra 
__cq_init(struct circular_queue * cq)14768eddac3fSPeter Zijlstra static inline void __cq_init(struct circular_queue *cq)
14778eddac3fSPeter Zijlstra {
14788eddac3fSPeter Zijlstra 	cq->front = cq->rear = 0;
1479aa480771SYuyang Du 	lockdep_dependency_gen_id++;
14808eddac3fSPeter Zijlstra }
14818eddac3fSPeter Zijlstra 
__cq_empty(struct circular_queue * cq)14828eddac3fSPeter Zijlstra static inline int __cq_empty(struct circular_queue *cq)
14838eddac3fSPeter Zijlstra {
14848eddac3fSPeter Zijlstra 	return (cq->front == cq->rear);
14858eddac3fSPeter Zijlstra }
14868eddac3fSPeter Zijlstra 
__cq_full(struct circular_queue * cq)14878eddac3fSPeter Zijlstra static inline int __cq_full(struct circular_queue *cq)
14888eddac3fSPeter Zijlstra {
1489c1661325SYuyang Du 	return ((cq->rear + 1) & CQ_MASK) == cq->front;
1490c1661325SYuyang Du }
1491c1661325SYuyang Du 
__cq_enqueue(struct circular_queue * cq,struct lock_list * elem)1492c1661325SYuyang Du static inline int __cq_enqueue(struct circular_queue *cq, struct lock_list *elem)
1493c1661325SYuyang Du {
14948eddac3fSPeter Zijlstra 	if (__cq_full(cq))
1495c1661325SYuyang Du 		return -1;
14968eddac3fSPeter Zijlstra 
1497c1661325SYuyang Du 	cq->element[cq->rear] = elem;
1498c1661325SYuyang Du 	cq->rear = (cq->rear + 1) & CQ_MASK;
1499c1661325SYuyang Du 	return 0;
1500c1661325SYuyang Du }
15018eddac3fSPeter Zijlstra 
1502c1661325SYuyang Du /*
1503c1661325SYuyang Du  * Dequeue an element from the circular_queue, return a lock_list if
15048eddac3fSPeter Zijlstra  * the queue is not empty, or NULL if otherwise.
15058eddac3fSPeter Zijlstra  */
__cq_dequeue(struct circular_queue * cq)15068eddac3fSPeter Zijlstra static inline struct lock_list * __cq_dequeue(struct circular_queue *cq)
15078eddac3fSPeter Zijlstra {
15088eddac3fSPeter Zijlstra 	struct lock_list * lock;
15098eddac3fSPeter Zijlstra 
15108eddac3fSPeter Zijlstra 	if (__cq_empty(cq))
1511d563bc6eSBoqun Feng 		return NULL;
1512d563bc6eSBoqun Feng 
1513d563bc6eSBoqun Feng 	lock = cq->element[cq->front];
1514d563bc6eSBoqun Feng 	cq->front = (cq->front + 1) & CQ_MASK;
1515d563bc6eSBoqun Feng 
1516d563bc6eSBoqun Feng 	return lock;
15178eddac3fSPeter Zijlstra }
15188eddac3fSPeter Zijlstra 
__cq_get_elem_count(struct circular_queue * cq)15198eddac3fSPeter Zijlstra static inline unsigned int  __cq_get_elem_count(struct circular_queue *cq)
15208eddac3fSPeter Zijlstra {
15218eddac3fSPeter Zijlstra 	return (cq->rear - cq->front) & CQ_MASK;
15228eddac3fSPeter Zijlstra }
15238eddac3fSPeter Zijlstra 
mark_lock_accessed(struct lock_list * lock)15248eddac3fSPeter Zijlstra static inline void mark_lock_accessed(struct lock_list *lock)
15258eddac3fSPeter Zijlstra {
15268eddac3fSPeter Zijlstra 	lock->class->dep_gen_id = lockdep_dependency_gen_id;
15278eddac3fSPeter Zijlstra }
15288eddac3fSPeter Zijlstra 
visit_lock_entry(struct lock_list * lock,struct lock_list * parent)15298eddac3fSPeter Zijlstra static inline void visit_lock_entry(struct lock_list *lock,
15308eddac3fSPeter Zijlstra 				    struct lock_list *parent)
15318eddac3fSPeter Zijlstra {
15328eddac3fSPeter Zijlstra 	lock->parent = parent;
15338eddac3fSPeter Zijlstra }
15348eddac3fSPeter Zijlstra 
lock_accessed(struct lock_list * lock)15358eddac3fSPeter Zijlstra static inline unsigned long lock_accessed(struct lock_list *lock)
15368eddac3fSPeter Zijlstra {
15378eddac3fSPeter Zijlstra 	return lock->class->dep_gen_id == lockdep_dependency_gen_id;
15388eddac3fSPeter Zijlstra }
15398eddac3fSPeter Zijlstra 
get_lock_parent(struct lock_list * child)15408eddac3fSPeter Zijlstra static inline struct lock_list *get_lock_parent(struct lock_list *child)
15418eddac3fSPeter Zijlstra {
15428eddac3fSPeter Zijlstra 	return child->parent;
15438eddac3fSPeter Zijlstra }
154477a80692SYuyang Du 
get_lock_depth(struct lock_list * child)154577a80692SYuyang Du static inline int get_lock_depth(struct lock_list *child)
154677a80692SYuyang Du {
154777a80692SYuyang Du 	int depth = 0;
154877a80692SYuyang Du 	struct lock_list *parent;
154977a80692SYuyang Du 
155077a80692SYuyang Du 	while ((parent = get_lock_parent(child))) {
155177a80692SYuyang Du 		child = parent;
155277a80692SYuyang Du 		depth++;
155377a80692SYuyang Du 	}
155477a80692SYuyang Du 	return depth;
155577a80692SYuyang Du }
155677a80692SYuyang Du 
1557b11be024SBoqun Feng /*
1558b11be024SBoqun Feng  * Return the forward or backward dependency list.
1559b11be024SBoqun Feng  *
1560b11be024SBoqun Feng  * @lock:   the lock_list to get its class's dependency list
1561b11be024SBoqun Feng  * @offset: the offset to struct lock_class to determine whether it is
1562b11be024SBoqun Feng  *          locks_after or locks_before
1563b11be024SBoqun Feng  */
get_dep_list(struct lock_list * lock,int offset)1564b11be024SBoqun Feng static inline struct list_head *get_dep_list(struct lock_list *lock, int offset)
1565b11be024SBoqun Feng {
1566b11be024SBoqun Feng 	void *lock_class = lock->class;
1567b11be024SBoqun Feng 
1568b11be024SBoqun Feng 	return lock_class + offset;
1569b11be024SBoqun Feng }
1570b11be024SBoqun Feng /*
1571b11be024SBoqun Feng  * Return values of a bfs search:
1572b11be024SBoqun Feng  *
1573b11be024SBoqun Feng  * BFS_E* indicates an error
1574b11be024SBoqun Feng  * BFS_R* indicates a result (match or not)
1575b11be024SBoqun Feng  *
1576b11be024SBoqun Feng  * BFS_EINVALIDNODE: Find a invalid node in the graph.
1577b11be024SBoqun Feng  *
1578b11be024SBoqun Feng  * BFS_EQUEUEFULL: The queue is full while doing the bfs.
1579b11be024SBoqun Feng  *
1580b11be024SBoqun Feng  * BFS_RMATCH: Find the matched node in the graph, and put that node into
1581b11be024SBoqun Feng  *             *@target_entry.
1582b11be024SBoqun Feng  *
1583b11be024SBoqun Feng  * BFS_RNOMATCH: Haven't found the matched node and keep *@target_entry
1584b11be024SBoqun Feng  *               _unchanged_.
1585b11be024SBoqun Feng  */
1586b11be024SBoqun Feng enum bfs_result {
158777a80692SYuyang Du 	BFS_EINVALIDNODE = -2,
1588154f185eSYuyang Du 	BFS_EQUEUEFULL = -1,
15893454a36dSBoqun Feng 	BFS_RMATCH = 0,
15903454a36dSBoqun Feng 	BFS_RNOMATCH = 1,
15913454a36dSBoqun Feng };
15923454a36dSBoqun Feng 
15933454a36dSBoqun Feng /*
15943454a36dSBoqun Feng  * bfs_result < 0 means error
15953454a36dSBoqun Feng  */
bfs_error(enum bfs_result res)15963454a36dSBoqun Feng static inline bool bfs_error(enum bfs_result res)
15973454a36dSBoqun Feng {
15983454a36dSBoqun Feng 	return res < 0;
15993454a36dSBoqun Feng }
16003454a36dSBoqun Feng 
16013454a36dSBoqun Feng /*
16023454a36dSBoqun Feng  * DEP_*_BIT in lock_list::dep
16033454a36dSBoqun Feng  *
16043454a36dSBoqun Feng  * For dependency @prev -> @next:
16053454a36dSBoqun Feng  *
16063454a36dSBoqun Feng  *   SR: @prev is shared reader (->read != 0) and @next is recursive reader
16073454a36dSBoqun Feng  *       (->read == 2)
16083454a36dSBoqun Feng  *   ER: @prev is exclusive locker (->read == 0) and @next is recursive reader
16093454a36dSBoqun Feng  *   SN: @prev is shared reader and @next is non-recursive locker (->read != 2)
16103454a36dSBoqun Feng  *   EN: @prev is exclusive locker and @next is non-recursive locker
16113454a36dSBoqun Feng  *
16123454a36dSBoqun Feng  * Note that we define the value of DEP_*_BITs so that:
16133454a36dSBoqun Feng  *   bit0 is prev->read == 0
16143454a36dSBoqun Feng  *   bit1 is next->read != 2
16153454a36dSBoqun Feng  */
16163454a36dSBoqun Feng #define DEP_SR_BIT (0 + (0 << 1)) /* 0 */
16173454a36dSBoqun Feng #define DEP_ER_BIT (1 + (0 << 1)) /* 1 */
16183454a36dSBoqun Feng #define DEP_SN_BIT (0 + (1 << 1)) /* 2 */
16193454a36dSBoqun Feng #define DEP_EN_BIT (1 + (1 << 1)) /* 3 */
16203454a36dSBoqun Feng 
16213454a36dSBoqun Feng #define DEP_SR_MASK (1U << (DEP_SR_BIT))
16223454a36dSBoqun Feng #define DEP_ER_MASK (1U << (DEP_ER_BIT))
16233454a36dSBoqun Feng #define DEP_SN_MASK (1U << (DEP_SN_BIT))
16243454a36dSBoqun Feng #define DEP_EN_MASK (1U << (DEP_EN_BIT))
16253454a36dSBoqun Feng 
16263454a36dSBoqun Feng static inline unsigned int
__calc_dep_bit(struct held_lock * prev,struct held_lock * next)16273454a36dSBoqun Feng __calc_dep_bit(struct held_lock *prev, struct held_lock *next)
16283454a36dSBoqun Feng {
16293454a36dSBoqun Feng 	return (prev->read == 0) + ((next->read != 2) << 1);
16303454a36dSBoqun Feng }
16313454a36dSBoqun Feng 
calc_dep(struct held_lock * prev,struct held_lock * next)16323454a36dSBoqun Feng static inline u8 calc_dep(struct held_lock *prev, struct held_lock *next)
16333454a36dSBoqun Feng {
16343454a36dSBoqun Feng 	return 1U << __calc_dep_bit(prev, next);
16353454a36dSBoqun Feng }
16363454a36dSBoqun Feng 
16373454a36dSBoqun Feng /*
16383454a36dSBoqun Feng  * calculate the dep_bit for backwards edges. We care about whether @prev is
16393454a36dSBoqun Feng  * shared and whether @next is recursive.
16406971c0f3SBoqun Feng  */
16416971c0f3SBoqun Feng static inline unsigned int
__calc_dep_bitb(struct held_lock * prev,struct held_lock * next)16426971c0f3SBoqun Feng __calc_dep_bitb(struct held_lock *prev, struct held_lock *next)
16436971c0f3SBoqun Feng {
16446971c0f3SBoqun Feng 	return (next->read != 2) + ((prev->read == 0) << 1);
16456971c0f3SBoqun Feng }
16466971c0f3SBoqun Feng 
calc_depb(struct held_lock * prev,struct held_lock * next)16476971c0f3SBoqun Feng static inline u8 calc_depb(struct held_lock *prev, struct held_lock *next)
16486971c0f3SBoqun Feng {
16496971c0f3SBoqun Feng 	return 1U << __calc_dep_bitb(prev, next);
16506971c0f3SBoqun Feng }
16516971c0f3SBoqun Feng 
16526971c0f3SBoqun Feng /*
16536971c0f3SBoqun Feng  * Initialize a lock_list entry @lock belonging to @class as the root for a BFS
16546971c0f3SBoqun Feng  * search.
16556971c0f3SBoqun Feng  */
__bfs_init_root(struct lock_list * lock,struct lock_class * class)16566971c0f3SBoqun Feng static inline void __bfs_init_root(struct lock_list *lock,
16576971c0f3SBoqun Feng 				   struct lock_class *class)
16586971c0f3SBoqun Feng {
16596971c0f3SBoqun Feng 	lock->class = class;
16606971c0f3SBoqun Feng 	lock->parent = NULL;
16616971c0f3SBoqun Feng 	lock->only_xr = 0;
16626971c0f3SBoqun Feng }
16636971c0f3SBoqun Feng 
16646971c0f3SBoqun Feng /*
16656971c0f3SBoqun Feng  * Initialize a lock_list entry @lock based on a lock acquisition @hlock as the
16666971c0f3SBoqun Feng  * root for a BFS search.
16676971c0f3SBoqun Feng  *
16686971c0f3SBoqun Feng  * ->only_xr of the initial lock node is set to @hlock->read == 2, to make sure
16696971c0f3SBoqun Feng  * that <prev> -> @hlock and @hlock -> <whatever __bfs() found> is not -(*R)->
16706971c0f3SBoqun Feng  * and -(S*)->.
16716971c0f3SBoqun Feng  */
bfs_init_root(struct lock_list * lock,struct held_lock * hlock)16726971c0f3SBoqun Feng static inline void bfs_init_root(struct lock_list *lock,
16736971c0f3SBoqun Feng 				 struct held_lock *hlock)
16746971c0f3SBoqun Feng {
16756971c0f3SBoqun Feng 	__bfs_init_root(lock, hlock_class(hlock));
16766971c0f3SBoqun Feng 	lock->only_xr = (hlock->read == 2);
16776971c0f3SBoqun Feng }
16786971c0f3SBoqun Feng 
16796971c0f3SBoqun Feng /*
16806d1823ccSBoqun Feng  * Similar to bfs_init_root() but initialize the root for backwards BFS.
16816d1823ccSBoqun Feng  *
16826d1823ccSBoqun Feng  * ->only_xr of the initial lock node is set to @hlock->read != 0, to make sure
16836d1823ccSBoqun Feng  * that <next> -> @hlock and @hlock -> <whatever backwards BFS found> is not
16846d1823ccSBoqun Feng  * -(*S)-> and -(R*)-> (reverse order of -(*R)-> and -(S*)->).
16856d1823ccSBoqun Feng  */
bfs_init_rootb(struct lock_list * lock,struct held_lock * hlock)16866d1823ccSBoqun Feng static inline void bfs_init_rootb(struct lock_list *lock,
16876d1823ccSBoqun Feng 				  struct held_lock *hlock)
16886d1823ccSBoqun Feng {
16896971c0f3SBoqun Feng 	__bfs_init_root(lock, hlock_class(hlock));
16906971c0f3SBoqun Feng 	lock->only_xr = (hlock->read != 0);
16916971c0f3SBoqun Feng }
16926971c0f3SBoqun Feng 
__bfs_next(struct lock_list * lock,int offset)16936971c0f3SBoqun Feng static inline struct lock_list *__bfs_next(struct lock_list *lock, int offset)
16946971c0f3SBoqun Feng {
16956971c0f3SBoqun Feng 	if (!lock || !lock->parent)
16966971c0f3SBoqun Feng 		return NULL;
16976971c0f3SBoqun Feng 
16986971c0f3SBoqun Feng 	return list_next_or_null_rcu(get_dep_list(lock->parent, offset),
16996971c0f3SBoqun Feng 				     &lock->entry, struct lock_list, entry);
17006971c0f3SBoqun Feng }
17016971c0f3SBoqun Feng 
17026971c0f3SBoqun Feng /*
17036971c0f3SBoqun Feng  * Breadth-First Search to find a strong path in the dependency graph.
17046971c0f3SBoqun Feng  *
17056971c0f3SBoqun Feng  * @source_entry: the source of the path we are searching for.
17066971c0f3SBoqun Feng  * @data: data used for the second parameter of @match function
17076971c0f3SBoqun Feng  * @match: match function for the search
17086971c0f3SBoqun Feng  * @target_entry: pointer to the target of a matched path
17096971c0f3SBoqun Feng  * @offset: the offset to struct lock_class to determine whether it is
17106971c0f3SBoqun Feng  *          locks_after or locks_before
17116971c0f3SBoqun Feng  *
17126971c0f3SBoqun Feng  * We may have multiple edges (considering different kinds of dependencies,
17136971c0f3SBoqun Feng  * e.g. ER and SN) between two nodes in the dependency graph. But
17146971c0f3SBoqun Feng  * only the strong dependency path in the graph is relevant to deadlocks. A
1715154f185eSYuyang Du  * strong dependency path is a dependency path that doesn't have two adjacent
1716b11be024SBoqun Feng  * dependencies as -(*R)-> -(S*)->, please see:
17178eddac3fSPeter Zijlstra  *
171861775ed2SBoqun Feng  *         Documentation/locking/lockdep-design.rst
1719bc2dd71bSBoqun Feng  *
17208eddac3fSPeter Zijlstra  * for more explanation of the definition of strong dependency paths
172177a80692SYuyang Du  *
17228eddac3fSPeter Zijlstra  * In __bfs(), we only traverse in the strong dependency path:
17238eddac3fSPeter Zijlstra  *
17246d1823ccSBoqun Feng  *     In lock_list::only_xr, we record whether the previous dependency only
17256d1823ccSBoqun Feng  *     has -(*R)-> in the search, and if it does (prev only has -(*R)->), we
17266d1823ccSBoqun Feng  *     filter out any -(S*)-> in the current dependency and after that, the
17276d1823ccSBoqun Feng  *     ->only_xr is set according to whether we only have -(*R)-> left.
17286d1823ccSBoqun Feng  */
__bfs(struct lock_list * source_entry,void * data,bool (* match)(struct lock_list * entry,void * data),bool (* skip)(struct lock_list * entry,void * data),struct lock_list ** target_entry,int offset)17298eddac3fSPeter Zijlstra static enum bfs_result __bfs(struct lock_list *source_entry,
1730248efb21SPeter Zijlstra 			     void *data,
1731248efb21SPeter Zijlstra 			     bool (*match)(struct lock_list *entry, void *data),
17328eddac3fSPeter Zijlstra 			     bool (*skip)(struct lock_list *entry, void *data),
1733aa480771SYuyang Du 			     struct lock_list **target_entry,
17348eddac3fSPeter Zijlstra 			     int offset)
17356d1823ccSBoqun Feng {
17366d1823ccSBoqun Feng 	struct circular_queue *cq = &lock_cq;
17376d1823ccSBoqun Feng 	struct lock_list *lock = NULL;
17388eddac3fSPeter Zijlstra 	struct lock_list *entry;
1739d563bc6eSBoqun Feng 	struct list_head *head;
17406d1823ccSBoqun Feng 	unsigned int cq_depth;
17416d1823ccSBoqun Feng 	bool first;
1742d563bc6eSBoqun Feng 
1743d563bc6eSBoqun Feng 	lockdep_assert_locked();
1744d563bc6eSBoqun Feng 
1745d563bc6eSBoqun Feng 	__cq_init(cq);
1746d563bc6eSBoqun Feng 	__cq_enqueue(cq, source_entry);
1747d563bc6eSBoqun Feng 
1748d563bc6eSBoqun Feng 	while ((lock = __bfs_next(lock, offset)) || (lock = __cq_dequeue(cq))) {
1749d563bc6eSBoqun Feng 		if (!lock->class)
1750d563bc6eSBoqun Feng 			return BFS_EINVALIDNODE;
1751d563bc6eSBoqun Feng 
1752d563bc6eSBoqun Feng 		/*
17536d1823ccSBoqun Feng 		 * Step 1: check whether we already finish on this one.
17546d1823ccSBoqun Feng 		 *
17556d1823ccSBoqun Feng 		 * If we have visited all the dependencies from this @lock to
17566d1823ccSBoqun Feng 		 * others (iow, if we have visited all lock_list entries in
17576d1823ccSBoqun Feng 		 * @lock->class->locks_{after,before}) we skip, otherwise go
17586d1823ccSBoqun Feng 		 * and visit all the dependencies in the list and mark this
17596d1823ccSBoqun Feng 		 * list accessed.
17606971c0f3SBoqun Feng 		 */
17616971c0f3SBoqun Feng 		if (lock_accessed(lock))
17626971c0f3SBoqun Feng 			continue;
17636971c0f3SBoqun Feng 		else
17646971c0f3SBoqun Feng 			mark_lock_accessed(lock);
17656971c0f3SBoqun Feng 
17666971c0f3SBoqun Feng 		/*
17676971c0f3SBoqun Feng 		 * Step 2: check whether prev dependency and this form a strong
17686971c0f3SBoqun Feng 		 *         dependency path.
17696971c0f3SBoqun Feng 		 */
17706971c0f3SBoqun Feng 		if (lock->parent) { /* Parent exists, check prev dependency */
17716971c0f3SBoqun Feng 			u8 dep = lock->dep;
17726971c0f3SBoqun Feng 			bool prev_only_xr = lock->parent->only_xr;
17736971c0f3SBoqun Feng 
17746d1823ccSBoqun Feng 			/*
17756d1823ccSBoqun Feng 			 * Mask out all -(S*)-> if we only have *R in previous
1776d563bc6eSBoqun Feng 			 * step, because -(*R)-> -(S*)-> don't make up a strong
17776d1823ccSBoqun Feng 			 * dependency.
17786d1823ccSBoqun Feng 			 */
17796d1823ccSBoqun Feng 			if (prev_only_xr)
1780bc2dd71bSBoqun Feng 				dep &= ~(DEP_SR_MASK | DEP_SN_MASK);
1781bc2dd71bSBoqun Feng 
17826d1823ccSBoqun Feng 			/* If nothing left, we skip */
1783bc2dd71bSBoqun Feng 			if (!dep)
1784bc2dd71bSBoqun Feng 				continue;
1785bc2dd71bSBoqun Feng 
17866d1823ccSBoqun Feng 			/* If there are only -(*R)-> left, set that for the next step */
17876d1823ccSBoqun Feng 			lock->only_xr = !(dep & (DEP_SN_MASK | DEP_EN_MASK));
17886d1823ccSBoqun Feng 		}
17896d1823ccSBoqun Feng 
17906d1823ccSBoqun Feng 		/*
17916d1823ccSBoqun Feng 		 * Step 3: we haven't visited this and there is a strong
17926d1823ccSBoqun Feng 		 *         dependency path to this, so check with @match.
1793e2db7592SIngo Molnar 		 *         If @skip is provide and returns true, we skip this
17946d1823ccSBoqun Feng 		 *         lock (and any path this lock is in).
17956d1823ccSBoqun Feng 		 */
17966d1823ccSBoqun Feng 		if (skip && skip(lock, data))
17976d1823ccSBoqun Feng 			continue;
17986d1823ccSBoqun Feng 
1799d563bc6eSBoqun Feng 		if (match(lock, data)) {
18008eddac3fSPeter Zijlstra 			*target_entry = lock;
18016d1823ccSBoqun Feng 			return BFS_RMATCH;
18026d1823ccSBoqun Feng 		}
18036d1823ccSBoqun Feng 
18046d1823ccSBoqun Feng 		/*
18056d1823ccSBoqun Feng 		 * Step 4: if not match, expand the path by adding the
18066d1823ccSBoqun Feng 		 *         forward or backwards dependencies in the search
18076d1823ccSBoqun Feng 		 *
18086d1823ccSBoqun Feng 		 */
18096d1823ccSBoqun Feng 		first = true;
18106d1823ccSBoqun Feng 		head = get_dep_list(lock, offset);
18116d1823ccSBoqun Feng 		list_for_each_entry_rcu(entry, head, entry) {
18126d1823ccSBoqun Feng 			visit_lock_entry(entry, lock);
18136d1823ccSBoqun Feng 
18146d1823ccSBoqun Feng 			/*
18158eddac3fSPeter Zijlstra 			 * Note we only enqueue the first of the list into the
18168eddac3fSPeter Zijlstra 			 * queue, because we can always find a sibling
18178eddac3fSPeter Zijlstra 			 * dependency from one (see __bfs_next()), as a result
18188eddac3fSPeter Zijlstra 			 * the space of queue is saved.
18198eddac3fSPeter Zijlstra 			 */
18206d1823ccSBoqun Feng 			if (!first)
18216d1823ccSBoqun Feng 				continue;
18228eddac3fSPeter Zijlstra 
18238eddac3fSPeter Zijlstra 			first = false;
1824b11be024SBoqun Feng 
1825b11be024SBoqun Feng 			if (__cq_enqueue(cq, entry))
18268eddac3fSPeter Zijlstra 				return BFS_EQUEUEFULL;
182761775ed2SBoqun Feng 
1828bc2dd71bSBoqun Feng 			cq_depth = __cq_get_elem_count(cq);
18298eddac3fSPeter Zijlstra 			if (max_bfs_queue_depth < cq_depth)
18308eddac3fSPeter Zijlstra 				max_bfs_queue_depth = cq_depth;
1831bc2dd71bSBoqun Feng 		}
183277a80692SYuyang Du 	}
18338eddac3fSPeter Zijlstra 
18348eddac3fSPeter Zijlstra 	return BFS_RNOMATCH;
18358eddac3fSPeter Zijlstra }
1836b11be024SBoqun Feng 
1837b11be024SBoqun Feng static inline enum bfs_result
__bfs_forwards(struct lock_list * src_entry,void * data,bool (* match)(struct lock_list * entry,void * data),bool (* skip)(struct lock_list * entry,void * data),struct lock_list ** target_entry)18388eddac3fSPeter Zijlstra __bfs_forwards(struct lock_list *src_entry,
183961775ed2SBoqun Feng 	       void *data,
1840bc2dd71bSBoqun Feng 	       bool (*match)(struct lock_list *entry, void *data),
18418eddac3fSPeter Zijlstra 	       bool (*skip)(struct lock_list *entry, void *data),
18428eddac3fSPeter Zijlstra 	       struct lock_list **target_entry)
1843bc2dd71bSBoqun Feng {
184477a80692SYuyang Du 	return __bfs(src_entry, data, match, skip, target_entry,
18458eddac3fSPeter Zijlstra 		     offsetof(struct lock_class, locks_after));
18468eddac3fSPeter Zijlstra 
18478eddac3fSPeter Zijlstra }
184812593b74SBart Van Assche 
184912593b74SBart Van Assche static inline enum bfs_result
__bfs_backwards(struct lock_list * src_entry,void * data,bool (* match)(struct lock_list * entry,void * data),bool (* skip)(struct lock_list * entry,void * data),struct lock_list ** target_entry)1850c120bce7SThomas Gleixner __bfs_backwards(struct lock_list *src_entry,
185112593b74SBart Van Assche 		void *data,
1852c120bce7SThomas Gleixner 		bool (*match)(struct lock_list *entry, void *data),
1853c120bce7SThomas Gleixner 	       bool (*skip)(struct lock_list *entry, void *data),
18548eddac3fSPeter Zijlstra 		struct lock_list **target_entry)
18558eddac3fSPeter Zijlstra {
18568eddac3fSPeter Zijlstra 	return __bfs(src_entry, data, match, skip, target_entry,
18578eddac3fSPeter Zijlstra 		     offsetof(struct lock_class, locks_before));
1858f7c1c6b3SYuyang Du 
18598eddac3fSPeter Zijlstra }
18608eddac3fSPeter Zijlstra 
print_lock_trace(const struct lock_trace * trace,unsigned int spaces)18618eddac3fSPeter Zijlstra static void print_lock_trace(const struct lock_trace *trace,
1862f7c1c6b3SYuyang Du 			     unsigned int spaces)
18638eddac3fSPeter Zijlstra {
1864eb1cfd09SKent Overstreet 	stack_trace_print(trace->entries, trace->nr_entries, spaces);
1865f943fe0fSDmitry Vyukov }
186612593b74SBart Van Assche 
18678eddac3fSPeter Zijlstra /*
18688eddac3fSPeter Zijlstra  * Print a dependency chain entry (this is only done when a deadlock
18698eddac3fSPeter Zijlstra  * has been detected):
18708eddac3fSPeter Zijlstra  */
18718eddac3fSPeter Zijlstra static noinline void
print_circular_bug_entry(struct lock_list * target,int depth)18728eddac3fSPeter Zijlstra print_circular_bug_entry(struct lock_list *target, int depth)
18738eddac3fSPeter Zijlstra {
18748eddac3fSPeter Zijlstra 	if (debug_locks_silent)
18758eddac3fSPeter Zijlstra 		return;
18768eddac3fSPeter Zijlstra 	printk("\n-> #%u", depth);
18770471db44SBoqun Feng 	print_lock_name(NULL, target->class);
18780471db44SBoqun Feng 	printk(KERN_CONT ":\n");
18798eddac3fSPeter Zijlstra 	print_lock_trace(target->trace, 6);
18808eddac3fSPeter Zijlstra }
18818eddac3fSPeter Zijlstra 
18828eddac3fSPeter Zijlstra static void
print_circular_lock_scenario(struct held_lock * src,struct held_lock * tgt,struct lock_list * prt)18838eddac3fSPeter Zijlstra print_circular_lock_scenario(struct held_lock *src,
18848eddac3fSPeter Zijlstra 			     struct held_lock *tgt,
18858eddac3fSPeter Zijlstra 			     struct lock_list *prt)
18868eddac3fSPeter Zijlstra {
18878eddac3fSPeter Zijlstra 	struct lock_class *source = hlock_class(src);
18888eddac3fSPeter Zijlstra 	struct lock_class *target = hlock_class(tgt);
18898eddac3fSPeter Zijlstra 	struct lock_class *parent = prt->class;
18908eddac3fSPeter Zijlstra 	int src_read = src->read;
18918eddac3fSPeter Zijlstra 	int tgt_read = tgt->read;
18928eddac3fSPeter Zijlstra 
18938eddac3fSPeter Zijlstra 	/*
18948eddac3fSPeter Zijlstra 	 * A direct locking problem where unsafe_class lock is taken
1895eb1cfd09SKent Overstreet 	 * directly by safe_class lock, then all we need to show
1896f943fe0fSDmitry Vyukov 	 * is the deadlock scenario, as it is obvious that the
1897eb1cfd09SKent Overstreet 	 * unsafe lock is taken under the safe lock.
1898f943fe0fSDmitry Vyukov 	 *
1899eb1cfd09SKent Overstreet 	 * But if there is a chain instead, where the safe lock takes
1900f943fe0fSDmitry Vyukov 	 * an intermediate lock (middle_class) where this lock is
19018eddac3fSPeter Zijlstra 	 * not the same as the safe lock, then the lock chain is
19028eddac3fSPeter Zijlstra 	 * used to describe the problem. Otherwise we would need
19038eddac3fSPeter Zijlstra 	 * to show a different CPU case for each link in the chain
19048eddac3fSPeter Zijlstra 	 * from the safe_class lock to the unsafe_class lock.
19058eddac3fSPeter Zijlstra 	 */
19060471db44SBoqun Feng 	if (parent != source) {
19070471db44SBoqun Feng 		printk("Chain exists of:\n  ");
19080471db44SBoqun Feng 		__print_lock_name(src, source);
19098eddac3fSPeter Zijlstra 		printk(KERN_CONT " --> ");
1910eb1cfd09SKent Overstreet 		__print_lock_name(NULL, parent);
1911f943fe0fSDmitry Vyukov 		printk(KERN_CONT " --> ");
19128eddac3fSPeter Zijlstra 		__print_lock_name(tgt, target);
1913eb1cfd09SKent Overstreet 		printk(KERN_CONT "\n\n");
1914f943fe0fSDmitry Vyukov 	}
19158eddac3fSPeter Zijlstra 
1916eb1cfd09SKent Overstreet 	printk(" Possible unsafe locking scenario:\n\n");
1917f943fe0fSDmitry Vyukov 	printk("       CPU0                    CPU1\n");
19180471db44SBoqun Feng 	printk("       ----                    ----\n");
19190471db44SBoqun Feng 	if (tgt_read != 0)
19200471db44SBoqun Feng 		printk("  rlock(");
19210471db44SBoqun Feng 	else
19220471db44SBoqun Feng 		printk("  lock(");
19238eddac3fSPeter Zijlstra 	__print_lock_name(tgt, target);
1924eb1cfd09SKent Overstreet 	printk(KERN_CONT ");\n");
1925f943fe0fSDmitry Vyukov 	printk("                               lock(");
19268eddac3fSPeter Zijlstra 	__print_lock_name(NULL, parent);
19278eddac3fSPeter Zijlstra 	printk(KERN_CONT ");\n");
19288eddac3fSPeter Zijlstra 	printk("                               lock(");
19298eddac3fSPeter Zijlstra 	__print_lock_name(tgt, target);
19308eddac3fSPeter Zijlstra 	printk(KERN_CONT ");\n");
19318eddac3fSPeter Zijlstra 	if (src_read != 0)
19328eddac3fSPeter Zijlstra 		printk("  rlock(");
1933f7c1c6b3SYuyang Du 	else if (src->sync)
19348eddac3fSPeter Zijlstra 		printk("  sync(");
19358eddac3fSPeter Zijlstra 	else
19368eddac3fSPeter Zijlstra 		printk("  lock(");
19378eddac3fSPeter Zijlstra 	__print_lock_name(src, source);
19388eddac3fSPeter Zijlstra 	printk(KERN_CONT ");\n");
19398eddac3fSPeter Zijlstra 	printk("\n *** DEADLOCK ***\n\n");
19408eddac3fSPeter Zijlstra }
1941f7c1c6b3SYuyang Du 
19428eddac3fSPeter Zijlstra /*
1943681fbec8SPaul E. McKenney  * When a circular dependency is detected, print the
1944a5dd63efSPaul E. McKenney  * header first:
1945a5dd63efSPaul E. McKenney  */
19468eddac3fSPeter Zijlstra static noinline void
print_circular_bug_header(struct lock_list * entry,unsigned int depth,struct held_lock * check_src,struct held_lock * check_tgt)1947a5dd63efSPaul E. McKenney print_circular_bug_header(struct lock_list *entry, unsigned int depth,
1948681fbec8SPaul E. McKenney 			struct held_lock *check_src,
19498eddac3fSPeter Zijlstra 			struct held_lock *check_tgt)
19508eddac3fSPeter Zijlstra {
1951383a4bc8SByungchul Park 	struct task_struct *curr = current;
1952681fbec8SPaul E. McKenney 
1953383a4bc8SByungchul Park 	if (debug_locks_silent)
19548eddac3fSPeter Zijlstra 		return;
1955681fbec8SPaul E. McKenney 
1956681fbec8SPaul E. McKenney 	pr_warn("\n");
19578eddac3fSPeter Zijlstra 	pr_warn("======================================================\n");
19588eddac3fSPeter Zijlstra 	pr_warn("WARNING: possible circular locking dependency detected\n");
19598eddac3fSPeter Zijlstra 	print_kernel_ident();
19608eddac3fSPeter Zijlstra 	pr_warn("------------------------------------------------------\n");
196168e30567SBoqun Feng 	pr_warn("%s/%d is trying to acquire lock:\n",
196268e30567SBoqun Feng 		curr->comm, task_pid_nr(curr));
196368e30567SBoqun Feng 	print_lock(check_src);
196468e30567SBoqun Feng 
196568e30567SBoqun Feng 	pr_warn("\nbut task is already holding lock:\n");
196668e30567SBoqun Feng 
196768e30567SBoqun Feng 	print_lock(check_tgt);
196868e30567SBoqun Feng 	pr_warn("\nwhich lock already depends on the new lock.\n\n");
196968e30567SBoqun Feng 	pr_warn("\nthe existing dependency chain (in reverse order) is:\n");
197068e30567SBoqun Feng 
197168e30567SBoqun Feng 	print_circular_bug_entry(entry, depth);
1972e2db7592SIngo Molnar }
197368e30567SBoqun Feng 
197468e30567SBoqun Feng /*
197568e30567SBoqun Feng  * We are about to add A -> B into the dependency graph, and in __bfs() a
197668e30567SBoqun Feng  * strong dependency path A -> .. -> B is found: hlock_class equals
197768e30567SBoqun Feng  * entry->class.
197868e30567SBoqun Feng  *
197968e30567SBoqun Feng  * If A -> .. -> B can replace A -> B in any __bfs() search (means the former
198068e30567SBoqun Feng  * is _stronger_ than or equal to the latter), we consider A -> B as redundant.
198168e30567SBoqun Feng  * For example if A -> .. -> B is -(EN)-> (i.e. A -(E*)-> .. -(*N)-> B), and A
198268e30567SBoqun Feng  * -> B is -(ER)-> or -(EN)->, then we don't need to add A -> B into the
198368e30567SBoqun Feng  * dependency graph, as any strong path ..-> A -> B ->.. we can get with
198468e30567SBoqun Feng  * having dependency A -> B, we could already get a equivalent path ..-> A ->
198568e30567SBoqun Feng  * .. -> B -> .. with A -> .. -> B. Therefore A -> B is redundant.
198668e30567SBoqun Feng  *
198768e30567SBoqun Feng  * We need to make sure both the start and the end of A -> .. -> B is not
19888eddac3fSPeter Zijlstra  * weaker than A -> B. For the start part, please see the comment in
198968e30567SBoqun Feng  * check_redundant(). For the end part, we need:
199068e30567SBoqun Feng  *
199168e30567SBoqun Feng  * Either
199268e30567SBoqun Feng  *
199368e30567SBoqun Feng  *     a) A -> B is -(*R)-> (everything is not weaker than that)
19948eddac3fSPeter Zijlstra  *
19958eddac3fSPeter Zijlstra  * or
19969de0c9bbSBoqun Feng  *
19979de0c9bbSBoqun Feng  *     b) A -> .. -> B is -(*N)-> (nothing is stronger than this)
19989de0c9bbSBoqun Feng  *
19999de0c9bbSBoqun Feng  */
hlock_equal(struct lock_list * entry,void * data)20009de0c9bbSBoqun Feng static inline bool hlock_equal(struct lock_list *entry, void *data)
20019de0c9bbSBoqun Feng {
20029de0c9bbSBoqun Feng 	struct held_lock *hlock = (struct held_lock *)data;
20039de0c9bbSBoqun Feng 
20049de0c9bbSBoqun Feng 	return hlock_class(hlock) == entry->class && /* Found A -> .. -> B */
20059de0c9bbSBoqun Feng 	       (hlock->read == 2 ||  /* A -> B is -(*R)-> */
20069de0c9bbSBoqun Feng 		!entry->only_xr); /* A -> .. -> B is -(*N)-> */
20079de0c9bbSBoqun Feng }
20089de0c9bbSBoqun Feng 
20099de0c9bbSBoqun Feng /*
20109de0c9bbSBoqun Feng  * We are about to add B -> A into the dependency graph, and in __bfs() a
20119de0c9bbSBoqun Feng  * strong dependency path A -> .. -> B is found: hlock_class equals
20129de0c9bbSBoqun Feng  * entry->class.
20139de0c9bbSBoqun Feng  *
20149de0c9bbSBoqun Feng  * We will have a deadlock case (conflict) if A -> .. -> B -> A is a strong
20159de0c9bbSBoqun Feng  * dependency cycle, that means:
20169de0c9bbSBoqun Feng  *
20179de0c9bbSBoqun Feng  * Either
20189de0c9bbSBoqun Feng  *
20199de0c9bbSBoqun Feng  *     a) B -> A is -(E*)->
20209de0c9bbSBoqun Feng  *
20219de0c9bbSBoqun Feng  * or
20229de0c9bbSBoqun Feng  *
2023f7c1c6b3SYuyang Du  *     b) A -> .. -> B is -(*N)-> (i.e. A -> .. -(*N)-> B)
20248eddac3fSPeter Zijlstra  *
20258eddac3fSPeter Zijlstra  * as then we don't have -(*R)-> -(S*)-> in the cycle.
2026b1abe462SThomas Gleixner  */
hlock_conflict(struct lock_list * entry,void * data)20278eddac3fSPeter Zijlstra static inline bool hlock_conflict(struct lock_list *entry, void *data)
20288eddac3fSPeter Zijlstra {
20298eddac3fSPeter Zijlstra 	struct held_lock *hlock = (struct held_lock *)data;
20308eddac3fSPeter Zijlstra 
20318eddac3fSPeter Zijlstra 	return hlock_class(hlock) == entry->class && /* Found A -> .. -> B */
20328eddac3fSPeter Zijlstra 	       (hlock->read == 0 || /* B -> A is -(E*)-> */
20338eddac3fSPeter Zijlstra 		!entry->only_xr); /* A -> .. -> B is -(*N)-> */
2034f7c1c6b3SYuyang Du }
20358eddac3fSPeter Zijlstra 
print_circular_bug(struct lock_list * this,struct lock_list * target,struct held_lock * check_src,struct held_lock * check_tgt)203612593b74SBart Van Assche static noinline void print_circular_bug(struct lock_list *this,
203712593b74SBart Van Assche 				struct lock_list *target,
2038f7c1c6b3SYuyang Du 				struct held_lock *check_src,
20398eddac3fSPeter Zijlstra 				struct held_lock *check_tgt)
20408eddac3fSPeter Zijlstra {
20418eddac3fSPeter Zijlstra 	struct task_struct *curr = current;
20428eddac3fSPeter Zijlstra 	struct lock_list *parent;
20438eddac3fSPeter Zijlstra 	struct lock_list *first_parent;
20448eddac3fSPeter Zijlstra 	int depth;
20458eddac3fSPeter Zijlstra 
20468eddac3fSPeter Zijlstra 	if (!debug_locks_off_graph_unlock() || debug_locks_silent)
20478eddac3fSPeter Zijlstra 		return;
20488eddac3fSPeter Zijlstra 
20498eddac3fSPeter Zijlstra 	this->trace = save_trace();
20508eddac3fSPeter Zijlstra 	if (!this->trace)
20518eddac3fSPeter Zijlstra 		return;
20528eddac3fSPeter Zijlstra 
20538eddac3fSPeter Zijlstra 	depth = get_lock_depth(target);
20548eddac3fSPeter Zijlstra 
20558eddac3fSPeter Zijlstra 	nbcon_cpu_emergency_enter();
20568eddac3fSPeter Zijlstra 
20578eddac3fSPeter Zijlstra 	print_circular_bug_header(target, depth, check_src, check_tgt);
20588eddac3fSPeter Zijlstra 
20598eddac3fSPeter Zijlstra 	parent = get_lock_parent(target);
20608eddac3fSPeter Zijlstra 	first_parent = parent;
20618eddac3fSPeter Zijlstra 
2062f7c1c6b3SYuyang Du 	while (parent) {
20638eddac3fSPeter Zijlstra 		print_circular_bug_entry(parent, --depth);
20648eddac3fSPeter Zijlstra 		parent = get_lock_parent(parent);
2065f7c1c6b3SYuyang Du 	}
20668eddac3fSPeter Zijlstra 
20678eddac3fSPeter Zijlstra 	printk("\nother info that might help us debug this:\n\n");
20688eddac3fSPeter Zijlstra 	print_circular_lock_scenario(check_src, check_tgt,
20698eddac3fSPeter Zijlstra 				     first_parent);
20708eddac3fSPeter Zijlstra 
20718eddac3fSPeter Zijlstra 	lockdep_print_held_locks(curr);
20728eddac3fSPeter Zijlstra 
207361775ed2SBoqun Feng 	printk("\nstack backtrace:\n");
20748eddac3fSPeter Zijlstra 	dump_stack();
20758eddac3fSPeter Zijlstra 
207661775ed2SBoqun Feng 	nbcon_cpu_emergency_exit();
20778eddac3fSPeter Zijlstra }
20788eddac3fSPeter Zijlstra 
print_bfs_bug(int ret)20795216d530SFengguang Wu static noinline void print_bfs_bug(int ret)
20808eddac3fSPeter Zijlstra {
20818eddac3fSPeter Zijlstra 	if (!debug_locks_off_graph_unlock())
20823f649ab7SKees Cook 		return;
20838eddac3fSPeter Zijlstra 
2084bc2dd71bSBoqun Feng 	/*
20858eddac3fSPeter Zijlstra 	 * Breadth-first-search failed, graph got corrupted?
20868eddac3fSPeter Zijlstra 	 */
20878eddac3fSPeter Zijlstra 	WARN(1, "lockdep bfs error:%d\n", ret);
20888eddac3fSPeter Zijlstra }
20898eddac3fSPeter Zijlstra 
noop_count(struct lock_list * entry,void * data)20908eddac3fSPeter Zijlstra static bool noop_count(struct lock_list *entry, void *data)
20918eddac3fSPeter Zijlstra {
20928eddac3fSPeter Zijlstra 	(*(unsigned long *)data)++;
20936971c0f3SBoqun Feng 	return false;
20948eddac3fSPeter Zijlstra }
2095fcc784beSSteven Rostedt (VMware) 
__lockdep_count_forward_deps(struct lock_list * this)2096248efb21SPeter Zijlstra static unsigned long __lockdep_count_forward_deps(struct lock_list *this)
20978eddac3fSPeter Zijlstra {
2098248efb21SPeter Zijlstra 	unsigned long  count = 0;
2099fcc784beSSteven Rostedt (VMware) 	struct lock_list *target_entry;
21008eddac3fSPeter Zijlstra 
21018eddac3fSPeter Zijlstra 	__bfs_forwards(this, (void *)&count, noop_count, NULL, &target_entry);
21028eddac3fSPeter Zijlstra 
21038eddac3fSPeter Zijlstra 	return count;
21045216d530SFengguang Wu }
lockdep_count_forward_deps(struct lock_class * class)21058eddac3fSPeter Zijlstra unsigned long lockdep_count_forward_deps(struct lock_class *class)
21068eddac3fSPeter Zijlstra {
21073f649ab7SKees Cook 	unsigned long ret, flags;
21088eddac3fSPeter Zijlstra 	struct lock_list this;
2109bc2dd71bSBoqun Feng 
21108eddac3fSPeter Zijlstra 	__bfs_init_root(&this, class);
21118eddac3fSPeter Zijlstra 
21128eddac3fSPeter Zijlstra 	raw_local_irq_save(flags);
21138eddac3fSPeter Zijlstra 	lockdep_lock();
21148eddac3fSPeter Zijlstra 	ret = __lockdep_count_forward_deps(&this);
21158eddac3fSPeter Zijlstra 	lockdep_unlock();
21168eddac3fSPeter Zijlstra 	raw_local_irq_restore(flags);
21178eddac3fSPeter Zijlstra 
21188eddac3fSPeter Zijlstra 	return ret;
21196971c0f3SBoqun Feng }
21208eddac3fSPeter Zijlstra 
__lockdep_count_backward_deps(struct lock_list * this)2121fcc784beSSteven Rostedt (VMware) static unsigned long __lockdep_count_backward_deps(struct lock_list *this)
2122248efb21SPeter Zijlstra {
21238eddac3fSPeter Zijlstra 	unsigned long  count = 0;
2124248efb21SPeter Zijlstra 	struct lock_list *target_entry;
2125fcc784beSSteven Rostedt (VMware) 
21268eddac3fSPeter Zijlstra 	__bfs_backwards(this, (void *)&count, noop_count, NULL, &target_entry);
21278eddac3fSPeter Zijlstra 
21288eddac3fSPeter Zijlstra 	return count;
21298eddac3fSPeter Zijlstra }
21308eddac3fSPeter Zijlstra 
lockdep_count_backward_deps(struct lock_class * class)21318c2c2b44SYuyang Du unsigned long lockdep_count_backward_deps(struct lock_class *class)
2132b11be024SBoqun Feng {
21338eddac3fSPeter Zijlstra 	unsigned long ret, flags;
2134b11be024SBoqun Feng 	struct lock_list this;
21359de0c9bbSBoqun Feng 
21369de0c9bbSBoqun Feng 	__bfs_init_root(&this, class);
2137bc2dd71bSBoqun Feng 
21388eddac3fSPeter Zijlstra 	raw_local_irq_save(flags);
21398eddac3fSPeter Zijlstra 	lockdep_lock();
2140b11be024SBoqun Feng 	ret = __lockdep_count_backward_deps(&this);
21418c2c2b44SYuyang Du 	lockdep_unlock();
2142bc2dd71bSBoqun Feng 	raw_local_irq_restore(flags);
21438c2c2b44SYuyang Du 
2144b11be024SBoqun Feng 	return ret;
21458c2c2b44SYuyang Du }
21468c2c2b44SYuyang Du 
21478c2c2b44SYuyang Du /*
21488c2c2b44SYuyang Du  * Check that the dependency graph starting at <src> can lead to
21498c2c2b44SYuyang Du  * <target> or not.
2150eb1cfd09SKent Overstreet  */
2151eb1cfd09SKent Overstreet static noinline enum bfs_result
check_path(struct held_lock * target,struct lock_list * src_entry,bool (* match)(struct lock_list * entry,void * data),bool (* skip)(struct lock_list * entry,void * data),struct lock_list ** target_entry)21528c2c2b44SYuyang Du check_path(struct held_lock *target, struct lock_list *src_entry,
21538c2c2b44SYuyang Du 	   bool (*match)(struct lock_list *entry, void *data),
21548c2c2b44SYuyang Du 	   bool (*skip)(struct lock_list *entry, void *data),
21558c2c2b44SYuyang Du 	   struct lock_list **target_entry)
21568c2c2b44SYuyang Du {
2157b11be024SBoqun Feng 	enum bfs_result ret;
21588c2c2b44SYuyang Du 
2159b11be024SBoqun Feng 	ret = __bfs_forwards(src_entry, target, match, skip, target_entry);
21608c2c2b44SYuyang Du 
216112593b74SBart Van Assche 	if (unlikely(bfs_error(ret)))
21628c2c2b44SYuyang Du 		print_bfs_bug(ret);
2163b11be024SBoqun Feng 
21643f649ab7SKees Cook 	return ret;
21656971c0f3SBoqun Feng }
21666971c0f3SBoqun Feng 
21676971c0f3SBoqun Feng static void print_deadlock_bug(struct task_struct *, struct held_lock *, struct held_lock *);
21688eddac3fSPeter Zijlstra 
21698eddac3fSPeter Zijlstra /*
21708eddac3fSPeter Zijlstra  * Prove that the dependency graph starting at <src> can not
2171bc2dd71bSBoqun Feng  * lead to <target>. If it can, there is a circle when adding
21728eddac3fSPeter Zijlstra  * <target> -> <src> dependency.
2173b11be024SBoqun Feng  *
217412593b74SBart Van Assche  * Print an error and return BFS_RMATCH if it does.
21758c2c2b44SYuyang Du  */
21768c2c2b44SYuyang Du static noinline enum bfs_result
check_noncircular(struct held_lock * src,struct held_lock * target,struct lock_trace ** const trace)21778c2c2b44SYuyang Du check_noncircular(struct held_lock *src, struct held_lock *target,
21788c2c2b44SYuyang Du 		  struct lock_trace **const trace)
21798c2c2b44SYuyang Du {
218012593b74SBart Van Assche 	enum bfs_result ret;
21818eddac3fSPeter Zijlstra 	struct lock_list *target_entry;
21828eddac3fSPeter Zijlstra 	struct lock_list src_entry;
2183eb1cfd09SKent Overstreet 
2184eb1cfd09SKent Overstreet 	bfs_init_root(&src_entry, src);
2185eb1cfd09SKent Overstreet 
21868c2c2b44SYuyang Du 	debug_atomic_inc(nr_cyclic_checks);
21878c2c2b44SYuyang Du 
21888c2c2b44SYuyang Du 	ret = check_path(target, &src_entry, hlock_conflict, NULL, &target_entry);
21898c2c2b44SYuyang Du 
21908c2c2b44SYuyang Du 	if (unlikely(ret == BFS_RMATCH)) {
21918c2c2b44SYuyang Du 		if (!*trace) {
2192e7a38f63SYuyang Du 			/*
2193948f8376SFrederic Weisbecker 			 * If save_trace fails here, the printing might
2194f08e3888SBoqun Feng 			 * trigger a WARN but because of the !nr_entries it
2195f08e3888SBoqun Feng 			 * should not do bad things.
2196f08e3888SBoqun Feng 			 */
2197f08e3888SBoqun Feng 			*trace = save_trace();
2198f08e3888SBoqun Feng 		}
2199f08e3888SBoqun Feng 
2200f08e3888SBoqun Feng 		if (src->class_idx == target->class_idx)
2201f08e3888SBoqun Feng 			print_deadlock_bug(current, src, target);
2202f08e3888SBoqun Feng 		else
2203f08e3888SBoqun Feng 			print_circular_bug(&src_entry, target_entry, src, target);
2204f08e3888SBoqun Feng 	}
2205f08e3888SBoqun Feng 
2206f08e3888SBoqun Feng 	return ret;
2207f08e3888SBoqun Feng }
2208f08e3888SBoqun Feng 
2209f08e3888SBoqun Feng #ifdef CONFIG_TRACE_IRQFLAGS
2210f08e3888SBoqun Feng 
2211f08e3888SBoqun Feng /*
2212f08e3888SBoqun Feng  * Forwards and backwards subgraph searching, for the purposes of
2213f08e3888SBoqun Feng  * proving that two subgraphs can be connected by a new dependency
2214f08e3888SBoqun Feng  * without creating any illegal irq-safe -> irq-unsafe lock dependency.
2215f08e3888SBoqun Feng  *
2216f08e3888SBoqun Feng  * A irq safe->unsafe deadlock happens with the following conditions:
2217f08e3888SBoqun Feng  *
2218f08e3888SBoqun Feng  * 1) We have a strong dependency path A -> ... -> B
2219f08e3888SBoqun Feng  *
2220f08e3888SBoqun Feng  * 2) and we have ENABLED_IRQ usage of B and USED_IN_IRQ usage of A, therefore
2221f08e3888SBoqun Feng  *    irq can create a new dependency B -> A (consider the case that a holder
2222f08e3888SBoqun Feng  *    of B gets interrupted by an irq whose handler will try to acquire A).
2223f08e3888SBoqun Feng  *
2224f08e3888SBoqun Feng  * 3) the dependency circle A -> ... -> B -> A we get from 1) and 2) is a
2225f08e3888SBoqun Feng  *    strong circle:
2226f08e3888SBoqun Feng  *
2227f08e3888SBoqun Feng  *      For the usage bits of B:
2228f08e3888SBoqun Feng  *        a) if A -> B is -(*N)->, then B -> A could be any type, so any
2229f08e3888SBoqun Feng  *           ENABLED_IRQ usage suffices.
2230f08e3888SBoqun Feng  *        b) if A -> B is -(*R)->, then B -> A must be -(E*)->, so only
2231f08e3888SBoqun Feng  *           ENABLED_IRQ_*_READ usage suffices.
2232f08e3888SBoqun Feng  *
2233f08e3888SBoqun Feng  *      For the usage bits of A:
2234f08e3888SBoqun Feng  *        c) if A -> B is -(E*)->, then B -> A could be any type, so any
223561775ed2SBoqun Feng  *           USED_IN_IRQ usage suffices.
2236948f8376SFrederic Weisbecker  *        d) if A -> B is -(S*)->, then B -> A must be -(*N)->, so only
2237f08e3888SBoqun Feng  *           USED_IN_IRQ_*_READ usage suffices.
2238948f8376SFrederic Weisbecker  */
2239f08e3888SBoqun Feng 
2240f08e3888SBoqun Feng /*
2241948f8376SFrederic Weisbecker  * There is a strong dependency path in the dependency graph: A -> B, and now
224261775ed2SBoqun Feng  * we need to decide which usage bit of A should be accumulated to detect
2243948f8376SFrederic Weisbecker  * safe->unsafe bugs.
2244948f8376SFrederic Weisbecker  *
22458eddac3fSPeter Zijlstra  * Note that usage_accumulate() is used in backwards search, so ->only_xr
2246f08e3888SBoqun Feng  * stands for whether A -> B only has -(S*)-> (in this case ->only_xr is true).
2247f08e3888SBoqun Feng  *
2248f08e3888SBoqun Feng  * As above, if only_xr is false, which means A -> B has -(E*)-> dependency
2249f08e3888SBoqun Feng  * path, any usage of A should be considered. Otherwise, we should only
2250f08e3888SBoqun Feng  * consider _READ usage.
2251f08e3888SBoqun Feng  */
usage_accumulate(struct lock_list * entry,void * mask)2252f08e3888SBoqun Feng static inline bool usage_accumulate(struct lock_list *entry, void *mask)
22538eddac3fSPeter Zijlstra {
225461775ed2SBoqun Feng 	if (!entry->only_xr)
22558eddac3fSPeter Zijlstra 		*(unsigned long *)mask |= entry->class->usage_mask;
2256f08e3888SBoqun Feng 	else /* Mask out _READ usage bits */
225761775ed2SBoqun Feng 		*(unsigned long *)mask |= (entry->class->usage_mask & LOCKF_IRQ);
2258f08e3888SBoqun Feng 
2259f08e3888SBoqun Feng 	return false;
22608eddac3fSPeter Zijlstra }
22618eddac3fSPeter Zijlstra 
22625f296240SBoqun Feng /*
22635f296240SBoqun Feng  * There is a strong dependency path in the dependency graph: A -> B, and now
22640cce06baSPeter Zijlstra  * we need to decide which usage bit of B conflicts with the usage bits of A,
22650cce06baSPeter Zijlstra  * i.e. which usage bit of B may introduce safe->unsafe deadlocks.
22660cce06baSPeter Zijlstra  *
22675f296240SBoqun Feng  * As above, if only_xr is false, which means A -> B has -(*N)-> dependency
22685f296240SBoqun Feng  * path, any usage of B should be considered. Otherwise, we should only
22695f296240SBoqun Feng  * consider _READ usage.
22705f296240SBoqun Feng  */
usage_match(struct lock_list * entry,void * mask)22715f296240SBoqun Feng static inline bool usage_match(struct lock_list *entry, void *mask)
22725f296240SBoqun Feng {
22735f296240SBoqun Feng 	if (!entry->only_xr)
22745f296240SBoqun Feng 		return !!(entry->class->usage_mask & *(unsigned long *)mask);
22755f296240SBoqun Feng 	else /* Mask out _READ usage bits */
22765f296240SBoqun Feng 		return !!((entry->class->usage_mask & LOCKF_IRQ) & *(unsigned long *)mask);
22775f296240SBoqun Feng }
22785f296240SBoqun Feng 
usage_skip(struct lock_list * entry,void * mask)22795f296240SBoqun Feng static inline bool usage_skip(struct lock_list *entry, void *mask)
22805f296240SBoqun Feng {
22815f296240SBoqun Feng 	if (entry->class->lock_type == LD_LOCK_NORMAL)
22825f296240SBoqun Feng 		return false;
22835f296240SBoqun Feng 
22845f296240SBoqun Feng 	/*
22855f296240SBoqun Feng 	 * Skip local_lock() for irq inversion detection.
22865f296240SBoqun Feng 	 *
22875f296240SBoqun Feng 	 * For !RT, local_lock() is not a real lock, so it won't carry any
22885f296240SBoqun Feng 	 * dependency.
22895f296240SBoqun Feng 	 *
22905f296240SBoqun Feng 	 * For RT, an irq inversion happens when we have lock A and B, and on
22915f296240SBoqun Feng 	 * some CPU we can have:
22925f296240SBoqun Feng 	 *
22930cce06baSPeter Zijlstra 	 *	lock(A);
22940cce06baSPeter Zijlstra 	 *	<interrupted>
22955f296240SBoqun Feng 	 *	  lock(B);
22965f296240SBoqun Feng 	 *
22970cce06baSPeter Zijlstra 	 * where lock(B) cannot sleep, and we have a dependency B -> ... -> A.
22980cce06baSPeter Zijlstra 	 *
22990cce06baSPeter Zijlstra 	 * Now we prove local_lock() cannot exist in that dependency. First we
23000cce06baSPeter Zijlstra 	 * have the observation for any lock chain L1 -> ... -> Ln, for any
23010cce06baSPeter Zijlstra 	 * 1 <= i <= n, Li.inner_wait_type <= L1.inner_wait_type, otherwise
23025f296240SBoqun Feng 	 * wait context check will complain. And since B is not a sleep lock,
23035f296240SBoqun Feng 	 * therefore B.inner_wait_type >= 2, and since the inner_wait_type of
23045f296240SBoqun Feng 	 * local_lock() is 3, which is greater than 2, therefore there is no
23058eddac3fSPeter Zijlstra 	 * way the local_lock() exists in the dependency B -> ... -> A.
23068eddac3fSPeter Zijlstra 	 *
23078eddac3fSPeter Zijlstra 	 * As a result, we will skip local_lock(), when we search for irq
23088eddac3fSPeter Zijlstra 	 * inversion bugs.
2309b11be024SBoqun Feng 	 */
23108eddac3fSPeter Zijlstra 	if (entry->class->lock_type == LD_LOCK_PERCPU &&
23118eddac3fSPeter Zijlstra 	    DEBUG_LOCKS_WARN_ON(entry->class->wait_type_inner < LD_WAIT_CONFIG))
2312b11be024SBoqun Feng 		return false;
2313627f364dSFrederic Weisbecker 
23148eddac3fSPeter Zijlstra 	/*
23158eddac3fSPeter Zijlstra 	 * Skip WAIT_OVERRIDE for irq inversion detection -- it's not actually
2316b11be024SBoqun Feng 	 * a lock and only used to override the wait_type.
23178eddac3fSPeter Zijlstra 	 */
23188eddac3fSPeter Zijlstra 
23198eddac3fSPeter Zijlstra 	return true;
23205f296240SBoqun Feng }
23218eddac3fSPeter Zijlstra 
23228eddac3fSPeter Zijlstra /*
23238eddac3fSPeter Zijlstra  * Find a node in the forwards-direction dependency sub-graph starting
23248eddac3fSPeter Zijlstra  * at @root->class that matches @bit.
23258eddac3fSPeter Zijlstra  *
23268eddac3fSPeter Zijlstra  * Return BFS_MATCH if such a node exists in the subgraph, and put that node
23278eddac3fSPeter Zijlstra  * into *@target_entry.
23288eddac3fSPeter Zijlstra  */
2329b11be024SBoqun Feng static enum bfs_result
find_usage_forwards(struct lock_list * root,unsigned long usage_mask,struct lock_list ** target_entry)2330627f364dSFrederic Weisbecker find_usage_forwards(struct lock_list *root, unsigned long usage_mask,
23318eddac3fSPeter Zijlstra 			struct lock_list **target_entry)
23328eddac3fSPeter Zijlstra {
2333b11be024SBoqun Feng 	enum bfs_result result;
23348eddac3fSPeter Zijlstra 
23358eddac3fSPeter Zijlstra 	debug_atomic_inc(nr_find_usage_forwards_checks);
23368eddac3fSPeter Zijlstra 
23375f296240SBoqun Feng 	result = __bfs_forwards(root, &usage_mask, usage_match, usage_skip, target_entry);
23388eddac3fSPeter Zijlstra 
23398eddac3fSPeter Zijlstra 	return result;
23408eddac3fSPeter Zijlstra }
23418eddac3fSPeter Zijlstra 
23428eddac3fSPeter Zijlstra /*
23438eddac3fSPeter Zijlstra  * Find a node in the backwards-direction dependency sub-graph starting
23448eddac3fSPeter Zijlstra  * at @root->class that matches @bit.
23458eddac3fSPeter Zijlstra  */
23468eddac3fSPeter Zijlstra static enum bfs_result
find_usage_backwards(struct lock_list * root,unsigned long usage_mask,struct lock_list ** target_entry)2347eb1cfd09SKent Overstreet find_usage_backwards(struct lock_list *root, unsigned long usage_mask,
23488ca2b56cSWaiman Long 			struct lock_list **target_entry)
23498ca2b56cSWaiman Long {
23508ca2b56cSWaiman Long 	enum bfs_result result;
2351f943fe0fSDmitry Vyukov 
23528eddac3fSPeter Zijlstra 	debug_atomic_inc(nr_find_usage_backwards_checks);
23532bb8945bSPeter Zijlstra 
23548eddac3fSPeter Zijlstra 	result = __bfs_backwards(root, &usage_mask, usage_match, usage_skip, target_entry);
23558eddac3fSPeter Zijlstra 
23568eddac3fSPeter Zijlstra 	return result;
23578eddac3fSPeter Zijlstra }
2358f943fe0fSDmitry Vyukov 
print_lock_class_header(struct lock_class * class,int depth)235912593b74SBart Van Assche static void print_lock_class_header(struct lock_class *class, int depth)
23608eddac3fSPeter Zijlstra {
23618eddac3fSPeter Zijlstra 	int bit;
23628eddac3fSPeter Zijlstra 
23638eddac3fSPeter Zijlstra 	printk("%*s->", depth, "");
236404860d48SBorislav Petkov 	print_lock_name(NULL, class);
2365f943fe0fSDmitry Vyukov #ifdef CONFIG_DEBUG_LOCKDEP
23668eddac3fSPeter Zijlstra 	printk(KERN_CONT " ops: %lu", debug_class_ops_read(class));
23678eddac3fSPeter Zijlstra #endif
23688eddac3fSPeter Zijlstra 	printk(KERN_CONT " {\n");
236969c7a5fbSBoqun Feng 
237069c7a5fbSBoqun Feng 	for (bit = 0; bit < LOCK_TRACE_STATES; bit++) {
237169c7a5fbSBoqun Feng 		if (class->usage_mask & (1 << bit)) {
237269c7a5fbSBoqun Feng 			int len = depth;
237369c7a5fbSBoqun Feng 
237469c7a5fbSBoqun Feng 			len += printk("%*s   %s", depth, "", usage_str[bit]);
237569c7a5fbSBoqun Feng 			len += printk(KERN_CONT " at:\n");
237669c7a5fbSBoqun Feng 			print_lock_trace(class->usage_traces[bit], len);
237769c7a5fbSBoqun Feng 		}
237869c7a5fbSBoqun Feng 	}
237969c7a5fbSBoqun Feng 	printk("%*s }\n", depth, "");
238069c7a5fbSBoqun Feng 
238169c7a5fbSBoqun Feng 	printk("%*s ... key      at: [<%px>] %pS\n",
238269c7a5fbSBoqun Feng 		depth, "", class->key, class->key);
238369c7a5fbSBoqun Feng }
238469c7a5fbSBoqun Feng 
238569c7a5fbSBoqun Feng /*
238669c7a5fbSBoqun Feng  * Dependency path printing:
238769c7a5fbSBoqun Feng  *
238869c7a5fbSBoqun Feng  * After BFS we get a lock dependency path (linked via ->parent of lock_list),
238969c7a5fbSBoqun Feng  * printing out each lock in the dependency path will help on understanding how
239069c7a5fbSBoqun Feng  * the deadlock could happen. Here are some details about dependency path
239169c7a5fbSBoqun Feng  * printing:
239269c7a5fbSBoqun Feng  *
239369c7a5fbSBoqun Feng  * 1)	A lock_list can be either forwards or backwards for a lock dependency,
239469c7a5fbSBoqun Feng  * 	for a lock dependency A -> B, there are two lock_lists:
239569c7a5fbSBoqun Feng  *
239669c7a5fbSBoqun Feng  * 	a)	lock_list in the ->locks_after list of A, whose ->class is B and
239769c7a5fbSBoqun Feng  * 		->links_to is A. In this case, we can say the lock_list is
239869c7a5fbSBoqun Feng  * 		"A -> B" (forwards case).
239969c7a5fbSBoqun Feng  *
240069c7a5fbSBoqun Feng  * 	b)	lock_list in the ->locks_before list of B, whose ->class is A
240169c7a5fbSBoqun Feng  * 		and ->links_to is B. In this case, we can say the lock_list is
240269c7a5fbSBoqun Feng  * 		"B <- A" (bacwards case).
240369c7a5fbSBoqun Feng  *
240469c7a5fbSBoqun Feng  * 	The ->trace of both a) and b) point to the call trace where B was
240569c7a5fbSBoqun Feng  * 	acquired with A held.
240669c7a5fbSBoqun Feng  *
240769c7a5fbSBoqun Feng  * 2)	A "helper" lock_list is introduced during BFS, this lock_list doesn't
240869c7a5fbSBoqun Feng  * 	represent a certain lock dependency, it only provides an initial entry
240969c7a5fbSBoqun Feng  * 	for BFS. For example, BFS may introduce a "helper" lock_list whose
241069c7a5fbSBoqun Feng  * 	->class is A, as a result BFS will search all dependencies starting with
241169c7a5fbSBoqun Feng  * 	A, e.g. A -> B or A -> C.
241269c7a5fbSBoqun Feng  *
241369c7a5fbSBoqun Feng  * 	The notation of a forwards helper lock_list is like "-> A", which means
241469c7a5fbSBoqun Feng  * 	we should search the forwards dependencies starting with "A", e.g A -> B
241569c7a5fbSBoqun Feng  * 	or A -> C.
241669c7a5fbSBoqun Feng  *
241769c7a5fbSBoqun Feng  * 	The notation of a bacwards helper lock_list is like "<- B", which means
241869c7a5fbSBoqun Feng  * 	we should search the backwards dependencies ending with "B", e.g.
24198eddac3fSPeter Zijlstra  * 	B <- A or B <- C.
24208eddac3fSPeter Zijlstra  */
24218eddac3fSPeter Zijlstra 
24228eddac3fSPeter Zijlstra /*
24238eddac3fSPeter Zijlstra  * printk the shortest lock dependencies from @root to @leaf in reverse order.
24248eddac3fSPeter Zijlstra  *
24258eddac3fSPeter Zijlstra  * We have a lock dependency path as follow:
24268eddac3fSPeter Zijlstra  *
24278eddac3fSPeter Zijlstra  *    @root                                                                 @leaf
24288eddac3fSPeter Zijlstra  *      |                                                                     |
24298eddac3fSPeter Zijlstra  *      V                                                                     V
24308eddac3fSPeter Zijlstra  *	          ->parent                                   ->parent
24318eddac3fSPeter Zijlstra  * | lock_list | <--------- | lock_list | ... | lock_list  | <--------- | lock_list |
24328eddac3fSPeter Zijlstra  * |    -> L1  |            | L1 -> L2  | ... |Ln-2 -> Ln-1|            | Ln-1 -> Ln|
243312593b74SBart Van Assche  *
24348eddac3fSPeter Zijlstra  * , so it's natural that we start from @leaf and print every ->class and
24358eddac3fSPeter Zijlstra  * ->trace until we reach the @root.
24368eddac3fSPeter Zijlstra  */
24378eddac3fSPeter Zijlstra static void __used
print_shortest_lock_dependencies(struct lock_list * leaf,struct lock_list * root)24388eddac3fSPeter Zijlstra print_shortest_lock_dependencies(struct lock_list *leaf,
24398eddac3fSPeter Zijlstra 				 struct lock_list *root)
24408eddac3fSPeter Zijlstra {
24418eddac3fSPeter Zijlstra 	struct lock_list *entry = leaf;
24428eddac3fSPeter Zijlstra 	int depth;
24438eddac3fSPeter Zijlstra 
24448eddac3fSPeter Zijlstra 	/*compute depth from generated tree by BFS*/
24458eddac3fSPeter Zijlstra 	depth = get_lock_depth(leaf);
244669c7a5fbSBoqun Feng 
244769c7a5fbSBoqun Feng 	do {
244869c7a5fbSBoqun Feng 		print_lock_class_header(entry->class, depth);
244969c7a5fbSBoqun Feng 		printk("%*s ... acquired at:\n", depth, "");
245069c7a5fbSBoqun Feng 		print_lock_trace(entry->trace, 2);
245169c7a5fbSBoqun Feng 		printk("\n");
245269c7a5fbSBoqun Feng 
245369c7a5fbSBoqun Feng 		if (depth == 0 && (entry != root)) {
245469c7a5fbSBoqun Feng 			printk("lockdep:%s bad path found in chain graph\n", __func__);
245569c7a5fbSBoqun Feng 			break;
245669c7a5fbSBoqun Feng 		}
245769c7a5fbSBoqun Feng 
245869c7a5fbSBoqun Feng 		entry = get_lock_parent(entry);
245969c7a5fbSBoqun Feng 		depth--;
246069c7a5fbSBoqun Feng 	} while (entry && (depth >= 0));
246169c7a5fbSBoqun Feng }
246269c7a5fbSBoqun Feng 
246369c7a5fbSBoqun Feng /*
246469c7a5fbSBoqun Feng  * printk the shortest lock dependencies from @leaf to @root.
246569c7a5fbSBoqun Feng  *
246669c7a5fbSBoqun Feng  * We have a lock dependency path (from a backwards search) as follow:
246769c7a5fbSBoqun Feng  *
246869c7a5fbSBoqun Feng  *    @leaf                                                                 @root
246969c7a5fbSBoqun Feng  *      |                                                                     |
247069c7a5fbSBoqun Feng  *      V                                                                     V
247169c7a5fbSBoqun Feng  *	          ->parent                                   ->parent
247269c7a5fbSBoqun Feng  * | lock_list | ---------> | lock_list | ... | lock_list  | ---------> | lock_list |
247369c7a5fbSBoqun Feng  * | L2 <- L1  |            | L3 <- L2  | ... | Ln <- Ln-1 |            |    <- Ln  |
247469c7a5fbSBoqun Feng  *
247569c7a5fbSBoqun Feng  * , so when we iterate from @leaf to @root, we actually print the lock
247669c7a5fbSBoqun Feng  * dependency path L1 -> L2 -> .. -> Ln in the non-reverse order.
247769c7a5fbSBoqun Feng  *
247869c7a5fbSBoqun Feng  * Another thing to notice here is that ->class of L2 <- L1 is L1, while the
247969c7a5fbSBoqun Feng  * ->trace of L2 <- L1 is the call trace of L2, in fact we don't have the call
248069c7a5fbSBoqun Feng  * trace of L1 in the dependency path, which is alright, because most of the
248169c7a5fbSBoqun Feng  * time we can figure out where L1 is held from the call trace of L2.
248269c7a5fbSBoqun Feng  */
248369c7a5fbSBoqun Feng static void __used
print_shortest_lock_dependencies_backwards(struct lock_list * leaf,struct lock_list * root)248469c7a5fbSBoqun Feng print_shortest_lock_dependencies_backwards(struct lock_list *leaf,
248569c7a5fbSBoqun Feng 					   struct lock_list *root)
248669c7a5fbSBoqun Feng {
248769c7a5fbSBoqun Feng 	struct lock_list *entry = leaf;
248869c7a5fbSBoqun Feng 	const struct lock_trace *trace = NULL;
248969c7a5fbSBoqun Feng 	int depth;
249069c7a5fbSBoqun Feng 
249169c7a5fbSBoqun Feng 	/*compute depth from generated tree by BFS*/
249269c7a5fbSBoqun Feng 	depth = get_lock_depth(leaf);
249369c7a5fbSBoqun Feng 
249469c7a5fbSBoqun Feng 	do {
249569c7a5fbSBoqun Feng 		print_lock_class_header(entry->class, depth);
249669c7a5fbSBoqun Feng 		if (trace) {
249769c7a5fbSBoqun Feng 			printk("%*s ... acquired at:\n", depth, "");
249869c7a5fbSBoqun Feng 			print_lock_trace(trace, 2);
249969c7a5fbSBoqun Feng 			printk("\n");
250069c7a5fbSBoqun Feng 		}
25018eddac3fSPeter Zijlstra 
25028eddac3fSPeter Zijlstra 		/*
25038eddac3fSPeter Zijlstra 		 * Record the pointer to the trace for the next lock_list
25048eddac3fSPeter Zijlstra 		 * entry, see the comments for the function.
25058eddac3fSPeter Zijlstra 		 */
25068eddac3fSPeter Zijlstra 		trace = entry->trace;
25078eddac3fSPeter Zijlstra 
25088eddac3fSPeter Zijlstra 		if (depth == 0 && (entry != root)) {
25098eddac3fSPeter Zijlstra 			printk("lockdep:%s bad path found in chain graph\n", __func__);
25108eddac3fSPeter Zijlstra 			break;
25118eddac3fSPeter Zijlstra 		}
25128eddac3fSPeter Zijlstra 
25138eddac3fSPeter Zijlstra 		entry = get_lock_parent(entry);
25148eddac3fSPeter Zijlstra 		depth--;
25158eddac3fSPeter Zijlstra 	} while (entry && (depth >= 0));
25168eddac3fSPeter Zijlstra }
25178eddac3fSPeter Zijlstra 
25188eddac3fSPeter Zijlstra static void
print_irq_lock_scenario(struct lock_list * safe_entry,struct lock_list * unsafe_entry,struct lock_class * prev_class,struct lock_class * next_class)25198eddac3fSPeter Zijlstra print_irq_lock_scenario(struct lock_list *safe_entry,
25208eddac3fSPeter Zijlstra 			struct lock_list *unsafe_entry,
25218eddac3fSPeter Zijlstra 			struct lock_class *prev_class,
25228eddac3fSPeter Zijlstra 			struct lock_class *next_class)
25238eddac3fSPeter Zijlstra {
25248eddac3fSPeter Zijlstra 	struct lock_class *safe_class = safe_entry->class;
25258eddac3fSPeter Zijlstra 	struct lock_class *unsafe_class = unsafe_entry->class;
25268eddac3fSPeter Zijlstra 	struct lock_class *middle_class = prev_class;
25278eddac3fSPeter Zijlstra 
25288eddac3fSPeter Zijlstra 	if (middle_class == safe_class)
2529eb1cfd09SKent Overstreet 		middle_class = next_class;
2530f943fe0fSDmitry Vyukov 
2531eb1cfd09SKent Overstreet 	/*
2532f943fe0fSDmitry Vyukov 	 * A direct locking problem where unsafe_class lock is taken
2533eb1cfd09SKent Overstreet 	 * directly by safe_class lock, then all we need to show
2534f943fe0fSDmitry Vyukov 	 * is the deadlock scenario, as it is obvious that the
25358eddac3fSPeter Zijlstra 	 * unsafe lock is taken under the safe lock.
25368eddac3fSPeter Zijlstra 	 *
25378eddac3fSPeter Zijlstra 	 * But if there is a chain instead, where the safe lock takes
25388eddac3fSPeter Zijlstra 	 * an intermediate lock (middle_class) where this lock is
25398eddac3fSPeter Zijlstra 	 * not the same as the safe lock, then the lock chain is
25408eddac3fSPeter Zijlstra 	 * used to describe the problem. Otherwise we would need
2541eb1cfd09SKent Overstreet 	 * to show a different CPU case for each link in the chain
2542f943fe0fSDmitry Vyukov 	 * from the safe_class lock to the unsafe_class lock.
25438eddac3fSPeter Zijlstra 	 */
25448eddac3fSPeter Zijlstra 	if (middle_class != unsafe_class) {
2545eb1cfd09SKent Overstreet 		printk("Chain exists of:\n  ");
2546f943fe0fSDmitry Vyukov 		__print_lock_name(NULL, safe_class);
25478eddac3fSPeter Zijlstra 		printk(KERN_CONT " --> ");
2548eb1cfd09SKent Overstreet 		__print_lock_name(NULL, middle_class);
2549f943fe0fSDmitry Vyukov 		printk(KERN_CONT " --> ");
25508eddac3fSPeter Zijlstra 		__print_lock_name(NULL, unsafe_class);
25518eddac3fSPeter Zijlstra 		printk(KERN_CONT "\n\n");
2552eb1cfd09SKent Overstreet 	}
2553f943fe0fSDmitry Vyukov 
25548eddac3fSPeter Zijlstra 	printk(" Possible interrupt unsafe locking scenario:\n\n");
25558eddac3fSPeter Zijlstra 	printk("       CPU0                    CPU1\n");
25568eddac3fSPeter Zijlstra 	printk("       ----                    ----\n");
2557f7c1c6b3SYuyang Du 	printk("  lock(");
25588eddac3fSPeter Zijlstra 	__print_lock_name(NULL, unsafe_class);
25598eddac3fSPeter Zijlstra 	printk(KERN_CONT ");\n");
25608eddac3fSPeter Zijlstra 	printk("                               local_irq_disable();\n");
25618eddac3fSPeter Zijlstra 	printk("                               lock(");
25628eddac3fSPeter Zijlstra 	__print_lock_name(NULL, safe_class);
25638eddac3fSPeter Zijlstra 	printk(KERN_CONT ");\n");
25648eddac3fSPeter Zijlstra 	printk("                               lock(");
25658eddac3fSPeter Zijlstra 	__print_lock_name(NULL, middle_class);
25668eddac3fSPeter Zijlstra 	printk(KERN_CONT ");\n");
25678eddac3fSPeter Zijlstra 	printk("  <Interrupt>\n");
25688eddac3fSPeter Zijlstra 	printk("    lock(");
25698eddac3fSPeter Zijlstra 	__print_lock_name(NULL, safe_class);
2570f7c1c6b3SYuyang Du 	printk(KERN_CONT ");\n");
25718eddac3fSPeter Zijlstra 	printk("\n *** DEADLOCK ***\n\n");
2572681fbec8SPaul E. McKenney }
2573a5dd63efSPaul E. McKenney 
2574a5dd63efSPaul E. McKenney static void
print_bad_irq_dependency(struct task_struct * curr,struct lock_list * prev_root,struct lock_list * next_root,struct lock_list * backwards_entry,struct lock_list * forwards_entry,struct held_lock * prev,struct held_lock * next,enum lock_usage_bit bit1,enum lock_usage_bit bit2,const char * irqclass)25758eddac3fSPeter Zijlstra print_bad_irq_dependency(struct task_struct *curr,
25768eddac3fSPeter Zijlstra 			 struct lock_list *prev_root,
2577a5dd63efSPaul E. McKenney 			 struct lock_list *next_root,
2578681fbec8SPaul E. McKenney 			 struct lock_list *backwards_entry,
25798eddac3fSPeter Zijlstra 			 struct lock_list *forwards_entry,
2580f9ad4a5fSPeter Zijlstra 			 struct held_lock *prev,
25818eddac3fSPeter Zijlstra 			 struct held_lock *next,
2582f9ad4a5fSPeter Zijlstra 			 enum lock_usage_bit bit1,
25838eddac3fSPeter Zijlstra 			 enum lock_usage_bit bit2,
25848eddac3fSPeter Zijlstra 			 const char *irqclass)
25858eddac3fSPeter Zijlstra {
2586681fbec8SPaul E. McKenney 	if (!debug_locks_off_graph_unlock() || debug_locks_silent)
25878eddac3fSPeter Zijlstra 		return;
2588681fbec8SPaul E. McKenney 
2589eb1cfd09SKent Overstreet 	nbcon_cpu_emergency_enter();
2590681fbec8SPaul E. McKenney 
2591eb1cfd09SKent Overstreet 	pr_warn("\n");
2592681fbec8SPaul E. McKenney 	pr_warn("=====================================================\n");
25938eddac3fSPeter Zijlstra 	pr_warn("WARNING: %s-safe -> %s-unsafe lock order detected\n",
2594681fbec8SPaul E. McKenney 		irqclass, irqclass);
25958eddac3fSPeter Zijlstra 	print_kernel_ident();
2596eb1cfd09SKent Overstreet 	pr_warn("-----------------------------------------------------\n");
2597681fbec8SPaul E. McKenney 	pr_warn("%s/%d [HC%u[%lu]:SC%u[%lu]:HE%u:SE%u] is trying to acquire:\n",
25988eddac3fSPeter Zijlstra 		curr->comm, task_pid_nr(curr),
259912593b74SBart Van Assche 		lockdep_hardirq_context(), hardirq_count() >> HARDIRQ_SHIFT,
26008eddac3fSPeter Zijlstra 		curr->softirq_context, softirq_count() >> SOFTIRQ_SHIFT,
2601681fbec8SPaul E. McKenney 		lockdep_hardirqs_enabled(),
2602eb1cfd09SKent Overstreet 		curr->softirqs_enabled);
2603681fbec8SPaul E. McKenney 	print_lock(next);
2604681fbec8SPaul E. McKenney 
26058eddac3fSPeter Zijlstra 	pr_warn("\nand this task is already holding:\n");
260612593b74SBart Van Assche 	print_lock(prev);
26078eddac3fSPeter Zijlstra 	pr_warn("which would create a new lock dependency:\n");
2608681fbec8SPaul E. McKenney 	print_lock_name(prev, hlock_class(prev));
26098eddac3fSPeter Zijlstra 	pr_cont(" ->");
26108eddac3fSPeter Zijlstra 	print_lock_name(next, hlock_class(next));
26118eddac3fSPeter Zijlstra 	pr_cont("\n");
26128eddac3fSPeter Zijlstra 
26138eddac3fSPeter Zijlstra 	pr_warn("\nbut this new dependency connects a %s-irq-safe lock:\n",
2614681fbec8SPaul E. McKenney 		irqclass);
261569c7a5fbSBoqun Feng 	print_lock_name(NULL, backwards_entry->class);
26168eddac3fSPeter Zijlstra 	pr_warn("\n... which became %s-irq-safe at:\n", irqclass);
2617681fbec8SPaul E. McKenney 
2618681fbec8SPaul E. McKenney 	print_lock_trace(backwards_entry->class->usage_traces[bit1], 1);
261912593b74SBart Van Assche 
262012593b74SBart Van Assche 	pr_warn("\nto a %s-irq-unsafe lock:\n", irqclass);
2621f7c1c6b3SYuyang Du 	print_lock_name(NULL, forwards_entry->class);
26228eddac3fSPeter Zijlstra 	pr_warn("\n... which became %s-irq-unsafe at:\n", irqclass);
26238eddac3fSPeter Zijlstra 	pr_warn("...");
2624681fbec8SPaul E. McKenney 
26258eddac3fSPeter Zijlstra 	print_lock_trace(forwards_entry->class->usage_traces[bit2], 1);
26268eddac3fSPeter Zijlstra 
26278eddac3fSPeter Zijlstra 	pr_warn("\nother info that might help us debug this:\n\n");
26288eddac3fSPeter Zijlstra 	print_irq_lock_scenario(backwards_entry, forwards_entry,
26298eddac3fSPeter Zijlstra 				hlock_class(prev), hlock_class(next));
26308eddac3fSPeter Zijlstra 
26318eddac3fSPeter Zijlstra 	lockdep_print_held_locks(curr);
26328eddac3fSPeter Zijlstra 
26338eddac3fSPeter Zijlstra 	pr_warn("\nthe dependencies between %s-irq-safe lock and the holding lock:\n", irqclass);
26348eddac3fSPeter Zijlstra 	print_shortest_lock_dependencies_backwards(backwards_entry, prev_root);
26358eddac3fSPeter Zijlstra 
26368eddac3fSPeter Zijlstra 	pr_warn("\nthe dependencies between the lock to be acquired");
26378eddac3fSPeter Zijlstra 	pr_warn(" and %s-irq-unsafe lock:\n", irqclass);
26388eddac3fSPeter Zijlstra 	next_root->trace = save_trace();
26398eddac3fSPeter Zijlstra 	if (!next_root->trace)
26408eddac3fSPeter Zijlstra 		goto out;
26418eddac3fSPeter Zijlstra 	print_shortest_lock_dependencies(forwards_entry, next_root);
26428eddac3fSPeter Zijlstra 
26438eddac3fSPeter Zijlstra 	pr_warn("\nstack backtrace:\n");
2644c902a1e8SFrederic Weisbecker 	dump_stack();
2645c902a1e8SFrederic Weisbecker out:
2646c902a1e8SFrederic Weisbecker 	nbcon_cpu_emergency_exit();
2647c902a1e8SFrederic Weisbecker }
26488eddac3fSPeter Zijlstra 
26498eddac3fSPeter Zijlstra static const char *state_names[] = {
2650948f8376SFrederic Weisbecker #define LOCKDEP_STATE(__STATE) \
2651948f8376SFrederic Weisbecker 	__stringify(__STATE),
2652948f8376SFrederic Weisbecker #include "lockdep_states.h"
2653948f8376SFrederic Weisbecker #undef LOCKDEP_STATE
2654948f8376SFrederic Weisbecker };
2655948f8376SFrederic Weisbecker 
2656948f8376SFrederic Weisbecker static const char *state_rnames[] = {
26578eddac3fSPeter Zijlstra #define LOCKDEP_STATE(__STATE) \
26588eddac3fSPeter Zijlstra 	__stringify(__STATE)"-READ",
2659bba2a8f1SFrederic Weisbecker #include "lockdep_states.h"
2660bba2a8f1SFrederic Weisbecker #undef LOCKDEP_STATE
26618eddac3fSPeter Zijlstra };
26628eddac3fSPeter Zijlstra 
state_name(enum lock_usage_bit bit)26638eddac3fSPeter Zijlstra static inline const char *state_name(enum lock_usage_bit bit)
26648eddac3fSPeter Zijlstra {
2665bba2a8f1SFrederic Weisbecker 	if (bit & LOCK_USAGE_READ_MASK)
26668eddac3fSPeter Zijlstra 		return state_rnames[bit >> LOCK_USAGE_DIR_MASK];
26678eddac3fSPeter Zijlstra 	else
2668948f8376SFrederic Weisbecker 		return state_names[bit >> LOCK_USAGE_DIR_MASK];
2669948f8376SFrederic Weisbecker }
2670948f8376SFrederic Weisbecker 
2671948f8376SFrederic Weisbecker /*
2672948f8376SFrederic Weisbecker  * The bit number is encoded like:
2673948f8376SFrederic Weisbecker  *
2674948f8376SFrederic Weisbecker  *  bit0: 0 exclusive, 1 read lock
2675948f8376SFrederic Weisbecker  *  bit1: 0 used in irq, 1 irq enabled
2676948f8376SFrederic Weisbecker  *  bit2-n: state
2677948f8376SFrederic Weisbecker  */
exclusive_bit(int new_bit)2678948f8376SFrederic Weisbecker static int exclusive_bit(int new_bit)
2679948f8376SFrederic Weisbecker {
2680948f8376SFrederic Weisbecker 	int state = new_bit & LOCK_USAGE_STATE_MASK;
2681948f8376SFrederic Weisbecker 	int dir = new_bit & LOCK_USAGE_DIR_MASK;
2682948f8376SFrederic Weisbecker 
26838eddac3fSPeter Zijlstra 	/*
2684948f8376SFrederic Weisbecker 	 * keep state, bit flip the direction and strip read.
26858eddac3fSPeter Zijlstra 	 */
2686948f8376SFrederic Weisbecker 	return state | (dir ^ LOCK_USAGE_DIR_MASK);
2687948f8376SFrederic Weisbecker }
2688948f8376SFrederic Weisbecker 
26898eddac3fSPeter Zijlstra /*
2690948f8376SFrederic Weisbecker  * Observe that when given a bitmask where each bitnr is encoded as above, a
26918eddac3fSPeter Zijlstra  * right shift of the mask transforms the individual bitnrs as -1 and
26928eddac3fSPeter Zijlstra  * conversely, a left shift transforms into +1 for the individual bitnrs.
2693948f8376SFrederic Weisbecker  *
2694f08e3888SBoqun Feng  * So for all bits whose number have LOCK_ENABLED_* set (bitnr1 == 1), we can
2695f08e3888SBoqun Feng  * create the mask with those bit numbers using LOCK_USED_IN_* (bitnr1 == 0)
2696f08e3888SBoqun Feng  * instead by subtracting the bit number by 2, or shifting the mask right by 2.
2697f08e3888SBoqun Feng  *
2698f08e3888SBoqun Feng  * Similarly, bitnr1 == 0 becomes bitnr1 == 1 by adding 2, or shifting left 2.
2699f08e3888SBoqun Feng  *
2700f08e3888SBoqun Feng  * So split the mask (note that LOCKF_ENABLED_IRQ_ALL|LOCKF_USED_IN_IRQ_ALL is
2701f08e3888SBoqun Feng  * all bits set) and recompose with bitnr1 flipped.
2702f08e3888SBoqun Feng  */
invert_dir_mask(unsigned long mask)2703f08e3888SBoqun Feng static unsigned long invert_dir_mask(unsigned long mask)
2704f08e3888SBoqun Feng {
2705f08e3888SBoqun Feng 	unsigned long excl = 0;
2706f08e3888SBoqun Feng 
2707f08e3888SBoqun Feng 	/* Invert dir */
2708f08e3888SBoqun Feng 	excl |= (mask & LOCKF_ENABLED_IRQ_ALL) >> LOCK_USAGE_DIR_MASK;
2709f08e3888SBoqun Feng 	excl |= (mask & LOCKF_USED_IN_IRQ_ALL) << LOCK_USAGE_DIR_MASK;
2710f08e3888SBoqun Feng 
2711f08e3888SBoqun Feng 	return excl;
2712f08e3888SBoqun Feng }
2713f08e3888SBoqun Feng 
2714f08e3888SBoqun Feng /*
2715f08e3888SBoqun Feng  * Note that a LOCK_ENABLED_IRQ_*_READ usage and a LOCK_USED_IN_IRQ_*_READ
2716f08e3888SBoqun Feng  * usage may cause deadlock too, for example:
2717f08e3888SBoqun Feng  *
2718f08e3888SBoqun Feng  * P1				P2
2719f08e3888SBoqun Feng  * <irq disabled>
2720948f8376SFrederic Weisbecker  * write_lock(l1);		<irq enabled>
2721948f8376SFrederic Weisbecker  *				read_lock(l2);
2722948f8376SFrederic Weisbecker  * write_lock(l2);
2723948f8376SFrederic Weisbecker  * 				<in irq>
2724948f8376SFrederic Weisbecker  * 				read_lock(l1);
2725948f8376SFrederic Weisbecker  *
2726f08e3888SBoqun Feng  * , in above case, l1 will be marked as LOCK_USED_IN_IRQ_HARDIRQ_READ and l2
2727948f8376SFrederic Weisbecker  * will marked as LOCK_ENABLE_IRQ_HARDIRQ_READ, and this is a possible
2728948f8376SFrederic Weisbecker  * deadlock.
2729948f8376SFrederic Weisbecker  *
2730948f8376SFrederic Weisbecker  * In fact, all of the following cases may cause deadlocks:
2731948f8376SFrederic Weisbecker  *
2732948f8376SFrederic Weisbecker  * 	 LOCK_USED_IN_IRQ_* -> LOCK_ENABLED_IRQ_*
2733948f8376SFrederic Weisbecker  * 	 LOCK_USED_IN_IRQ_*_READ -> LOCK_ENABLED_IRQ_*
2734948f8376SFrederic Weisbecker  * 	 LOCK_USED_IN_IRQ_* -> LOCK_ENABLED_IRQ_*_READ
2735948f8376SFrederic Weisbecker  * 	 LOCK_USED_IN_IRQ_*_READ -> LOCK_ENABLED_IRQ_*_READ
2736948f8376SFrederic Weisbecker  *
2737948f8376SFrederic Weisbecker  * As a result, to calculate the "exclusive mask", first we invert the
2738948f8376SFrederic Weisbecker  * direction (USED_IN/ENABLED) of the original mask, and 1) for all bits with
2739948f8376SFrederic Weisbecker  * bitnr0 set (LOCK_*_READ), add those with bitnr0 cleared (LOCK_*). 2) for all
2740948f8376SFrederic Weisbecker  * bits with bitnr0 cleared (LOCK_*_READ), add those with bitnr0 set (LOCK_*).
2741948f8376SFrederic Weisbecker  */
exclusive_mask(unsigned long mask)2742948f8376SFrederic Weisbecker static unsigned long exclusive_mask(unsigned long mask)
2743f08e3888SBoqun Feng {
2744948f8376SFrederic Weisbecker 	unsigned long excl = invert_dir_mask(mask);
2745948f8376SFrederic Weisbecker 
2746948f8376SFrederic Weisbecker 	excl |= (excl & LOCKF_IRQ_READ) >> LOCK_USAGE_READ_MASK;
2747948f8376SFrederic Weisbecker 	excl |= (excl & LOCKF_IRQ) << LOCK_USAGE_READ_MASK;
2748948f8376SFrederic Weisbecker 
2749948f8376SFrederic Weisbecker 	return excl;
2750948f8376SFrederic Weisbecker }
2751948f8376SFrederic Weisbecker 
2752948f8376SFrederic Weisbecker /*
2753948f8376SFrederic Weisbecker  * Retrieve the _possible_ original mask to which @mask is
2754948f8376SFrederic Weisbecker  * exclusive. Ie: this is the opposite of exclusive_mask().
2755948f8376SFrederic Weisbecker  * Note that 2 possible original bits can match an exclusive
2756948f8376SFrederic Weisbecker  * bit: one has LOCK_USAGE_READ_MASK set, the other has it
2757948f8376SFrederic Weisbecker  * cleared. So both are returned for each exclusive bit.
2758f08e3888SBoqun Feng  */
original_mask(unsigned long mask)2759948f8376SFrederic Weisbecker static unsigned long original_mask(unsigned long mask)
2760948f8376SFrederic Weisbecker {
2761f08e3888SBoqun Feng 	unsigned long excl = invert_dir_mask(mask);
2762f08e3888SBoqun Feng 
2763f08e3888SBoqun Feng 	/* Include read in existing usages */
2764f08e3888SBoqun Feng 	excl |= (excl & LOCKF_IRQ_READ) >> LOCK_USAGE_READ_MASK;
2765f08e3888SBoqun Feng 	excl |= (excl & LOCKF_IRQ) << LOCK_USAGE_READ_MASK;
2766948f8376SFrederic Weisbecker 
2767f08e3888SBoqun Feng 	return excl;
2768948f8376SFrederic Weisbecker }
2769948f8376SFrederic Weisbecker 
2770948f8376SFrederic Weisbecker /*
2771948f8376SFrederic Weisbecker  * Find the first pair of bit match between an original
2772f08e3888SBoqun Feng  * usage mask and an exclusive usage mask.
2773f08e3888SBoqun Feng  */
find_exclusive_match(unsigned long mask,unsigned long excl_mask,enum lock_usage_bit * bitp,enum lock_usage_bit * excl_bitp)2774f08e3888SBoqun Feng static int find_exclusive_match(unsigned long mask,
2775f08e3888SBoqun Feng 				unsigned long excl_mask,
2776948f8376SFrederic Weisbecker 				enum lock_usage_bit *bitp,
2777948f8376SFrederic Weisbecker 				enum lock_usage_bit *excl_bitp)
2778948f8376SFrederic Weisbecker {
2779948f8376SFrederic Weisbecker 	int bit, excl, excl_read;
2780948f8376SFrederic Weisbecker 
2781948f8376SFrederic Weisbecker 	for_each_set_bit(bit, &mask, LOCK_USED) {
2782948f8376SFrederic Weisbecker 		/*
2783948f8376SFrederic Weisbecker 		 * exclusive_bit() strips the read bit, however,
2784948f8376SFrederic Weisbecker 		 * LOCK_ENABLED_IRQ_*_READ may cause deadlocks too, so we need
2785948f8376SFrederic Weisbecker 		 * to search excl | LOCK_USAGE_READ_MASK as well.
2786948f8376SFrederic Weisbecker 		 */
2787948f8376SFrederic Weisbecker 		excl = exclusive_bit(bit);
27888eddac3fSPeter Zijlstra 		excl_read = excl | LOCK_USAGE_READ_MASK;
27898eddac3fSPeter Zijlstra 		if (excl_mask & lock_flag(excl)) {
2790948f8376SFrederic Weisbecker 			*bitp = bit;
2791948f8376SFrederic Weisbecker 			*excl_bitp = excl;
27923f649ab7SKees Cook 			return 0;
27933f649ab7SKees Cook 		} else if (excl_mask & lock_flag(excl_read)) {
2794948f8376SFrederic Weisbecker 			*bitp = bit;
2795b11be024SBoqun Feng 			*excl_bitp = excl_read;
27968eddac3fSPeter Zijlstra 			return 0;
2797948f8376SFrederic Weisbecker 		}
2798948f8376SFrederic Weisbecker 	}
2799948f8376SFrederic Weisbecker 	return -1;
2800948f8376SFrederic Weisbecker }
2801f08e3888SBoqun Feng 
2802948f8376SFrederic Weisbecker /*
28035f296240SBoqun Feng  * Prove that the new dependency does not connect a hardirq-safe(-read)
2804b11be024SBoqun Feng  * lock with a hardirq-unsafe lock - to achieve this we search
2805f7c1c6b3SYuyang Du  * the backwards-subgraph starting at <prev>, and the
2806f7c1c6b3SYuyang Du  * forwards-subgraph starting at <next>:
2807f7c1c6b3SYuyang Du  */
check_irq_usage(struct task_struct * curr,struct held_lock * prev,struct held_lock * next)2808948f8376SFrederic Weisbecker static int check_irq_usage(struct task_struct *curr, struct held_lock *prev,
2809948f8376SFrederic Weisbecker 			   struct held_lock *next)
2810948f8376SFrederic Weisbecker {
28118eddac3fSPeter Zijlstra 	unsigned long usage_mask = 0, forward_mask, backward_mask;
2812948f8376SFrederic Weisbecker 	enum lock_usage_bit forward_bit = 0, backward_bit = 0;
2813948f8376SFrederic Weisbecker 	struct lock_list *target_entry1;
2814948f8376SFrederic Weisbecker 	struct lock_list *target_entry;
2815948f8376SFrederic Weisbecker 	struct lock_list this, that;
2816948f8376SFrederic Weisbecker 	enum bfs_result ret;
2817948f8376SFrederic Weisbecker 
2818948f8376SFrederic Weisbecker 	/*
2819f08e3888SBoqun Feng 	 * Step 1: gather all hard/soft IRQs usages backward in an
2820948f8376SFrederic Weisbecker 	 * accumulated usage mask.
2821948f8376SFrederic Weisbecker 	 */
2822b11be024SBoqun Feng 	bfs_init_rootb(&this, prev);
2823f7c1c6b3SYuyang Du 
2824f7c1c6b3SYuyang Du 	ret = __bfs_backwards(&this, &usage_mask, usage_accumulate, usage_skip, NULL);
2825f7c1c6b3SYuyang Du 	if (bfs_error(ret)) {
2826b11be024SBoqun Feng 		print_bfs_bug(ret);
2827b11be024SBoqun Feng 		return 0;
2828948f8376SFrederic Weisbecker 	}
2829948f8376SFrederic Weisbecker 
2830948f8376SFrederic Weisbecker 	usage_mask &= LOCKF_USED_IN_IRQ_ALL;
2831948f8376SFrederic Weisbecker 	if (!usage_mask)
2832948f8376SFrederic Weisbecker 		return 1;
28337b1f8c61SBoqun Feng 
28347b1f8c61SBoqun Feng 	/*
28357b1f8c61SBoqun Feng 	 * Step 2: find exclusive uses forward that match the previous
28367b1f8c61SBoqun Feng 	 * backward accumulated mask.
28377b1f8c61SBoqun Feng 	 */
28387b1f8c61SBoqun Feng 	forward_mask = exclusive_mask(usage_mask);
28397b1f8c61SBoqun Feng 
28407b1f8c61SBoqun Feng 	bfs_init_root(&that, next);
28417b1f8c61SBoqun Feng 
28427b1f8c61SBoqun Feng 	ret = find_usage_forwards(&that, forward_mask, &target_entry1);
2843948f8376SFrederic Weisbecker 	if (bfs_error(ret)) {
28447b1f8c61SBoqun Feng 		print_bfs_bug(ret);
2845948f8376SFrederic Weisbecker 		return 0;
2846948f8376SFrederic Weisbecker 	}
2847b11be024SBoqun Feng 	if (ret == BFS_RNOMATCH)
2848f7c1c6b3SYuyang Du 		return 1;
2849f7c1c6b3SYuyang Du 
2850f7c1c6b3SYuyang Du 	/*
2851b11be024SBoqun Feng 	 * Step 3: we found a bad match! Now retrieve a lock from the backward
2852948f8376SFrederic Weisbecker 	 * list whose usage mask matches the exclusive usage mask from the
2853948f8376SFrederic Weisbecker 	 * lock found on the forward list.
2854948f8376SFrederic Weisbecker 	 *
2855948f8376SFrederic Weisbecker 	 * Note, we should only keep the LOCKF_ENABLED_IRQ_ALL bits, considering
2856948f8376SFrederic Weisbecker 	 * the follow case:
2857948f8376SFrederic Weisbecker 	 *
2858948f8376SFrederic Weisbecker 	 * When trying to add A -> B to the graph, we find that there is a
2859948f8376SFrederic Weisbecker 	 * hardirq-safe L, that L -> ... -> A, and another hardirq-unsafe M,
2860948f8376SFrederic Weisbecker 	 * that B -> ... -> M. However M is **softirq-safe**, if we use exact
2861948f8376SFrederic Weisbecker 	 * invert bits of M's usage_mask, we will find another lock N that is
2862948f8376SFrederic Weisbecker 	 * **softirq-unsafe** and N -> ... -> A, however N -> .. -> M will not
2863948f8376SFrederic Weisbecker 	 * cause a inversion deadlock.
2864f7c1c6b3SYuyang Du 	 */
2865948f8376SFrederic Weisbecker 	backward_mask = original_mask(target_entry1->class->usage_mask & LOCKF_ENABLED_IRQ_ALL);
2866948f8376SFrederic Weisbecker 
2867948f8376SFrederic Weisbecker 	ret = find_usage_backwards(&this, backward_mask, &target_entry);
2868948f8376SFrederic Weisbecker 	if (bfs_error(ret)) {
2869f7c1c6b3SYuyang Du 		print_bfs_bug(ret);
2870f7c1c6b3SYuyang Du 		return 0;
28718eddac3fSPeter Zijlstra 	}
28728eddac3fSPeter Zijlstra 	if (DEBUG_LOCKS_WARN_ON(ret == BFS_RNOMATCH))
28738eddac3fSPeter Zijlstra 		return 1;
28748eddac3fSPeter Zijlstra 
2875948f8376SFrederic Weisbecker 	/*
2876948f8376SFrederic Weisbecker 	 * Step 4: narrow down to a pair of incompatible usage bits
28778eddac3fSPeter Zijlstra 	 * and report it.
28788eddac3fSPeter Zijlstra 	 */
28798eddac3fSPeter Zijlstra 	ret = find_exclusive_match(target_entry->class->usage_mask,
28805f296240SBoqun Feng 				   target_entry1->class->usage_mask,
28815f296240SBoqun Feng 				   &backward_bit, &forward_bit);
28825f296240SBoqun Feng 	if (DEBUG_LOCKS_WARN_ON(ret == -1))
28835f296240SBoqun Feng 		return 1;
28845f296240SBoqun Feng 
28855f296240SBoqun Feng 	print_bad_irq_dependency(curr, &this, &that,
2886b3b9c187SWaiman Long 				 target_entry, target_entry1,
28878eddac3fSPeter Zijlstra 				 prev, next,
2888175b1a60SPeter Zijlstra 				 backward_bit, forward_bit,
2889175b1a60SPeter Zijlstra 				 state_name(backward_bit));
2890175b1a60SPeter Zijlstra 
2891175b1a60SPeter Zijlstra 	return 0;
2892175b1a60SPeter Zijlstra }
2893175b1a60SPeter Zijlstra 
28940e8a89d4SXiongwei Song #else
2895175b1a60SPeter Zijlstra 
check_irq_usage(struct task_struct * curr,struct held_lock * prev,struct held_lock * next)2896175b1a60SPeter Zijlstra static inline int check_irq_usage(struct task_struct *curr,
2897175b1a60SPeter Zijlstra 				  struct held_lock *prev, struct held_lock *next)
2898175b1a60SPeter Zijlstra {
2899175b1a60SPeter Zijlstra 	return 1;
2900175b1a60SPeter Zijlstra }
2901175b1a60SPeter Zijlstra 
usage_skip(struct lock_list * entry,void * mask)2902175b1a60SPeter Zijlstra static inline bool usage_skip(struct lock_list *entry, void *mask)
2903175b1a60SPeter Zijlstra {
2904175b1a60SPeter Zijlstra 	return false;
2905175b1a60SPeter Zijlstra }
2906175b1a60SPeter Zijlstra 
2907175b1a60SPeter Zijlstra #endif /* CONFIG_TRACE_IRQFLAGS */
2908175b1a60SPeter Zijlstra 
2909175b1a60SPeter Zijlstra #ifdef CONFIG_LOCKDEP_SMALL
2910175b1a60SPeter Zijlstra /*
2911175b1a60SPeter Zijlstra  * Check that the dependency graph starting at <src> can lead to
2912175b1a60SPeter Zijlstra  * <target> or not. If it can, <src> -> <target> dependency is already
2913175b1a60SPeter Zijlstra  * in the graph.
2914175b1a60SPeter Zijlstra  *
2915175b1a60SPeter Zijlstra  * Return BFS_RMATCH if it does, or BFS_RNOMATCH if it does not, return BFS_E* if
2916175b1a60SPeter Zijlstra  * any error appears in the bfs search.
2917175b1a60SPeter Zijlstra  */
2918175b1a60SPeter Zijlstra static noinline enum bfs_result
check_redundant(struct held_lock * src,struct held_lock * target)29195f296240SBoqun Feng check_redundant(struct held_lock *src, struct held_lock *target)
29205f296240SBoqun Feng {
29215f296240SBoqun Feng 	enum bfs_result ret;
29225f296240SBoqun Feng 	struct lock_list *target_entry;
29235f296240SBoqun Feng 	struct lock_list src_entry;
29245f296240SBoqun Feng 
2925175b1a60SPeter Zijlstra 	bfs_init_root(&src_entry, src);
2926175b1a60SPeter Zijlstra 	/*
2927175b1a60SPeter Zijlstra 	 * Special setup for check_redundant().
2928175b1a60SPeter Zijlstra 	 *
2929175b1a60SPeter Zijlstra 	 * To report redundant, we need to find a strong dependency path that
2930175b1a60SPeter Zijlstra 	 * is equal to or stronger than <src> -> <target>. So if <src> is E,
2931175b1a60SPeter Zijlstra 	 * we need to let __bfs() only search for a path starting at a -(E*)->,
2932175b1a60SPeter Zijlstra 	 * we achieve this by setting the initial node's ->only_xr to true in
2933175b1a60SPeter Zijlstra 	 * that case. And if <prev> is S, we set initial ->only_xr to false
2934175b1a60SPeter Zijlstra 	 * because both -(S*)-> (equal) and -(E*)-> (stronger) are redundant.
2935175b1a60SPeter Zijlstra 	 */
2936175b1a60SPeter Zijlstra 	src_entry.only_xr = src->read == 0;
2937175b1a60SPeter Zijlstra 
2938175b1a60SPeter Zijlstra 	debug_atomic_inc(nr_redundant_checks);
2939175b1a60SPeter Zijlstra 
2940175b1a60SPeter Zijlstra 	/*
2941175b1a60SPeter Zijlstra 	 * Note: we skip local_lock() for redundant check, because as the
2942b3b9c187SWaiman Long 	 * comment in usage_skip(), A -> local_lock() -> B and A -> B are not
29438eddac3fSPeter Zijlstra 	 * the same.
2944b3b9c187SWaiman Long 	 */
2945b3b9c187SWaiman Long 	ret = check_path(target, &src_entry, hlock_equal, usage_skip, &target_entry);
2946b3b9c187SWaiman Long 
2947b3b9c187SWaiman Long 	if (ret == BFS_RMATCH)
2948b3b9c187SWaiman Long 		debug_atomic_inc(nr_redundant);
29498eddac3fSPeter Zijlstra 
29508eddac3fSPeter Zijlstra 	return ret;
29518eddac3fSPeter Zijlstra }
2952b3b9c187SWaiman Long 
2953b3b9c187SWaiman Long #else
2954b3b9c187SWaiman Long 
2955b3b9c187SWaiman Long static inline enum bfs_result
check_redundant(struct held_lock * src,struct held_lock * target)2956b3b9c187SWaiman Long check_redundant(struct held_lock *src, struct held_lock *target)
2957b3b9c187SWaiman Long {
2958b3b9c187SWaiman Long 	return BFS_RNOMATCH;
2959b3b9c187SWaiman Long }
2960b3b9c187SWaiman Long 
29618eddac3fSPeter Zijlstra #endif
29628eddac3fSPeter Zijlstra 
inc_chains(int irq_context)2963f7c1c6b3SYuyang Du static void inc_chains(int irq_context)
29648eddac3fSPeter Zijlstra {
29658eddac3fSPeter Zijlstra 	if (irq_context & LOCK_CHAIN_HARDIRQ_CONTEXT)
29668eddac3fSPeter Zijlstra 		nr_hardirq_chains++;
29678eddac3fSPeter Zijlstra 	else if (irq_context & LOCK_CHAIN_SOFTIRQ_CONTEXT)
29688eddac3fSPeter Zijlstra 		nr_softirq_chains++;
29698eddac3fSPeter Zijlstra 	else
29708eddac3fSPeter Zijlstra 		nr_process_chains++;
29718eddac3fSPeter Zijlstra }
2972eb1cfd09SKent Overstreet 
dec_chains(int irq_context)2973f943fe0fSDmitry Vyukov static void dec_chains(int irq_context)
29748eddac3fSPeter Zijlstra {
2975eb1cfd09SKent Overstreet 	if (irq_context & LOCK_CHAIN_HARDIRQ_CONTEXT)
2976f943fe0fSDmitry Vyukov 		nr_hardirq_chains--;
29778eddac3fSPeter Zijlstra 	else if (irq_context & LOCK_CHAIN_SOFTIRQ_CONTEXT)
29788eddac3fSPeter Zijlstra 		nr_softirq_chains--;
29798eddac3fSPeter Zijlstra 	else
29808eddac3fSPeter Zijlstra 		nr_process_chains--;
2981f7c1c6b3SYuyang Du }
29828eddac3fSPeter Zijlstra 
29838eddac3fSPeter Zijlstra static void
print_deadlock_scenario(struct held_lock * nxt,struct held_lock * prv)29848eddac3fSPeter Zijlstra print_deadlock_scenario(struct held_lock *nxt, struct held_lock *prv)
2985eb1cfd09SKent Overstreet {
2986eb1cfd09SKent Overstreet 	struct lock_class *next = hlock_class(nxt);
29878eddac3fSPeter Zijlstra 	struct lock_class *prev = hlock_class(prv);
2988f7c1c6b3SYuyang Du 
29898eddac3fSPeter Zijlstra 	printk(" Possible unsafe locking scenario:\n\n");
2990681fbec8SPaul E. McKenney 	printk("       CPU0\n");
2991a5dd63efSPaul E. McKenney 	printk("       ----\n");
2992a5dd63efSPaul E. McKenney 	printk("  lock(");
29938eddac3fSPeter Zijlstra 	__print_lock_name(prv, prev);
2994a5dd63efSPaul E. McKenney 	printk(KERN_CONT ");\n");
2995681fbec8SPaul E. McKenney 	printk("  lock(");
29968eddac3fSPeter Zijlstra 	__print_lock_name(nxt, next);
29978eddac3fSPeter Zijlstra 	printk(KERN_CONT ");\n");
2998681fbec8SPaul E. McKenney 	printk("\n *** DEADLOCK ***\n\n");
29998eddac3fSPeter Zijlstra 	printk(" May be due to missing lock nesting notation\n\n");
30008eddac3fSPeter Zijlstra }
3001eb1cfd09SKent Overstreet 
3002eb1cfd09SKent Overstreet static void
print_deadlock_bug(struct task_struct * curr,struct held_lock * prev,struct held_lock * next)3003eb1cfd09SKent Overstreet print_deadlock_bug(struct task_struct *curr, struct held_lock *prev,
3004eb1cfd09SKent Overstreet 		   struct held_lock *next)
3005eb1cfd09SKent Overstreet {
3006681fbec8SPaul E. McKenney 	struct lock_class *class = hlock_class(prev);
30078eddac3fSPeter Zijlstra 
30088eddac3fSPeter Zijlstra 	if (!debug_locks_off_graph_unlock() || debug_locks_silent)
30098eddac3fSPeter Zijlstra 		return;
3010681fbec8SPaul E. McKenney 
30118eddac3fSPeter Zijlstra 	nbcon_cpu_emergency_enter();
30128eddac3fSPeter Zijlstra 
30138eddac3fSPeter Zijlstra 	pr_warn("\n");
30148eddac3fSPeter Zijlstra 	pr_warn("============================================\n");
30158eddac3fSPeter Zijlstra 	pr_warn("WARNING: possible recursive locking detected\n");
30168eddac3fSPeter Zijlstra 	print_kernel_ident();
30178eddac3fSPeter Zijlstra 	pr_warn("--------------------------------------------\n");
30188eddac3fSPeter Zijlstra 	pr_warn("%s/%d is trying to acquire lock:\n",
30198eddac3fSPeter Zijlstra 		curr->comm, task_pid_nr(curr));
3020d61fc96aSBoqun Feng 	print_lock(next);
3021d61fc96aSBoqun Feng 	pr_warn("\nbut task is already holding lock:\n");
3022d61fc96aSBoqun Feng 	print_lock(prev);
30238eddac3fSPeter Zijlstra 
30248eddac3fSPeter Zijlstra 	if (class->cmp_fn) {
30254609c4f9SYuyang Du 		pr_warn("and the lock comparison function returns %i:\n",
30268eddac3fSPeter Zijlstra 			class->cmp_fn(prev->instance, next->instance));
3027eb1cfd09SKent Overstreet 	}
30288eddac3fSPeter Zijlstra 
30298eddac3fSPeter Zijlstra 	pr_warn("\nother info that might help us debug this:\n");
30308eddac3fSPeter Zijlstra 	print_deadlock_scenario(next, prev);
30318eddac3fSPeter Zijlstra 	lockdep_print_held_locks(curr);
30328eddac3fSPeter Zijlstra 
30338eddac3fSPeter Zijlstra 	pr_warn("\nstack backtrace:\n");
30348eddac3fSPeter Zijlstra 	dump_stack();
30358eddac3fSPeter Zijlstra 
30368eddac3fSPeter Zijlstra 	nbcon_cpu_emergency_exit();
30378eddac3fSPeter Zijlstra }
30388eddac3fSPeter Zijlstra 
30398eddac3fSPeter Zijlstra /*
30408eddac3fSPeter Zijlstra  * Check whether we are holding such a class already.
30418eddac3fSPeter Zijlstra  *
30428eddac3fSPeter Zijlstra  * (Note that this has to be done separately, because the graph cannot
30438eddac3fSPeter Zijlstra  * detect such classes of deadlocks.)
30448eddac3fSPeter Zijlstra  *
30454609c4f9SYuyang Du  * Returns: 0 on deadlock detected, 1 on OK, 2 if another lock with the same
3046d61fc96aSBoqun Feng  * lock class is held but nest_lock is also held, i.e. we rely on the
30478eddac3fSPeter Zijlstra  * nest_lock to avoid the deadlock.
3048eb1cfd09SKent Overstreet  */
3049eb1cfd09SKent Overstreet static int
check_deadlock(struct task_struct * curr,struct held_lock * next)3050eb1cfd09SKent Overstreet check_deadlock(struct task_struct *curr, struct held_lock *next)
3051eb1cfd09SKent Overstreet {
3052eb1cfd09SKent Overstreet 	struct lock_class *class;
3053eb1cfd09SKent Overstreet 	struct held_lock *prev;
30548eddac3fSPeter Zijlstra 	struct held_lock *nest = NULL;
30558eddac3fSPeter Zijlstra 	int i;
30568eddac3fSPeter Zijlstra 
30578eddac3fSPeter Zijlstra 	for (i = 0; i < curr->lockdep_depth; i++) {
30588eddac3fSPeter Zijlstra 		prev = curr->held_locks + i;
30598eddac3fSPeter Zijlstra 
30608eddac3fSPeter Zijlstra 		if (prev->instance == next->nest_lock)
3061f7c1c6b3SYuyang Du 			nest = prev;
3062f7c1c6b3SYuyang Du 
30638eddac3fSPeter Zijlstra 		if (hlock_class(prev) != hlock_class(next))
30648eddac3fSPeter Zijlstra 			continue;
30658eddac3fSPeter Zijlstra 
30668eddac3fSPeter Zijlstra 		/*
30678eddac3fSPeter Zijlstra 		 * Allow read-after-read recursion of the same
30688eddac3fSPeter Zijlstra 		 * lock class (i.e. read_lock(lock)+read_lock(lock)):
3069154f185eSYuyang Du 		 */
30708eddac3fSPeter Zijlstra 		if ((next->read == 2) && prev->read)
30718eddac3fSPeter Zijlstra 			continue;
30728eddac3fSPeter Zijlstra 
30738eddac3fSPeter Zijlstra 		class = hlock_class(prev);
30748eddac3fSPeter Zijlstra 
30758eddac3fSPeter Zijlstra 		if (class->cmp_fn &&
30768eddac3fSPeter Zijlstra 		    class->cmp_fn(prev->instance, next->instance) < 0)
30778eddac3fSPeter Zijlstra 			continue;
30788eddac3fSPeter Zijlstra 
30798eddac3fSPeter Zijlstra 		/*
30808eddac3fSPeter Zijlstra 		 * We're holding the nest_lock, which serializes this lock's
30818eddac3fSPeter Zijlstra 		 * nesting behaviour.
30828eddac3fSPeter Zijlstra 		 */
30838eddac3fSPeter Zijlstra 		if (nest)
30848eddac3fSPeter Zijlstra 			return 2;
30858eddac3fSPeter Zijlstra 
30868eddac3fSPeter Zijlstra 		print_deadlock_bug(curr, prev, next);
30878eddac3fSPeter Zijlstra 		return 0;
30888eddac3fSPeter Zijlstra 	}
30898eddac3fSPeter Zijlstra 	return 1;
30908eddac3fSPeter Zijlstra }
3091bd76eca1SBoqun Feng 
309212593b74SBart Van Assche /*
30938eddac3fSPeter Zijlstra  * There was a chain-cache miss, and we are about to add a new dependency
30948b405d5cSPeter Zijlstra  * to a previous lock. We validate the following rules:
3095b11be024SBoqun Feng  *
30968eddac3fSPeter Zijlstra  *  - would the adding of the <prev> -> <next> dependency create a
3097a0b0fd53SBart Van Assche  *    circular dependency in the graph? [== circular deadlock]
3098a0b0fd53SBart Van Assche  *
3099a0b0fd53SBart Van Assche  *  - does the new prev->next dependency connect any hardirq-safe lock
3100a0b0fd53SBart Van Assche  *    (in the full backwards-subgraph starting at <prev>) with any
3101a0b0fd53SBart Van Assche  *    hardirq-unsafe lock (in the full forwards-subgraph starting at
3102a0b0fd53SBart Van Assche  *    <next>)? [== illegal lock inversion with hardirq contexts]
3103a0b0fd53SBart Van Assche  *
3104a0b0fd53SBart Van Assche  *  - does the new prev->next dependency connect any softirq-safe lock
3105a0b0fd53SBart Van Assche  *    (in the full backwards-subgraph starting at <prev>) with any
3106a0b0fd53SBart Van Assche  *    softirq-unsafe lock (in the full forwards-subgraph starting at
3107a0b0fd53SBart Van Assche  *    <next>)? [== illegal lock inversion with softirq contexts]
3108a0b0fd53SBart Van Assche  *
3109a0b0fd53SBart Van Assche  * any of these scenarios could lead to a deadlock.
3110a0b0fd53SBart Van Assche  *
3111a0b0fd53SBart Van Assche  * Then if all the validations pass, we add the forwards and backwards
3112a0b0fd53SBart Van Assche  * dependency.
3113a0b0fd53SBart Van Assche  */
3114a0b0fd53SBart Van Assche static int
check_prev_add(struct task_struct * curr,struct held_lock * prev,struct held_lock * next,u16 distance,struct lock_trace ** const trace)3115eb1cfd09SKent Overstreet check_prev_add(struct task_struct *curr, struct held_lock *prev,
3116eb1cfd09SKent Overstreet 	       struct held_lock *next, u16 distance,
3117eb1cfd09SKent Overstreet 	       struct lock_trace **const trace)
3118eb1cfd09SKent Overstreet {
3119eb1cfd09SKent Overstreet 	struct lock_list *entry;
3120eb1cfd09SKent Overstreet 	enum bfs_result ret;
3121eb1cfd09SKent Overstreet 
3122eb1cfd09SKent Overstreet 	if (!hlock_class(prev)->key || !hlock_class(next)->key) {
31238eddac3fSPeter Zijlstra 		/*
31248eddac3fSPeter Zijlstra 		 * The warning statements below may trigger a use-after-free
31258eddac3fSPeter Zijlstra 		 * of the class name. It is better to trigger a use-after free
3126154f185eSYuyang Du 		 * and to have the class name most of the time instead of not
3127154f185eSYuyang Du 		 * having the class name available.
31288eddac3fSPeter Zijlstra 		 */
3129154f185eSYuyang Du 		WARN_ONCE(!debug_locks_silent && !hlock_class(prev)->key,
3130154f185eSYuyang Du 			  "Detected use-after-free of lock class %px/%s\n",
3131154f185eSYuyang Du 			  hlock_class(prev),
31328eddac3fSPeter Zijlstra 			  hlock_class(prev)->name);
31338c2c2b44SYuyang Du 		WARN_ONCE(!debug_locks_silent && !hlock_class(next)->key,
3134b11be024SBoqun Feng 			  "Detected use-after-free of lock class %px/%s\n",
3135f7c1c6b3SYuyang Du 			  hlock_class(next),
31368eddac3fSPeter Zijlstra 			  hlock_class(next)->name);
3137948f8376SFrederic Weisbecker 		return 2;
31388eddac3fSPeter Zijlstra 	}
31398eddac3fSPeter Zijlstra 
31408eddac3fSPeter Zijlstra 	if (prev->class_idx == next->class_idx) {
31418eddac3fSPeter Zijlstra 		struct lock_class *class = hlock_class(prev);
31428eddac3fSPeter Zijlstra 
31438eddac3fSPeter Zijlstra 		if (class->cmp_fn &&
31448eddac3fSPeter Zijlstra 		    class->cmp_fn(prev->instance, next->instance) < 0)
31458eddac3fSPeter Zijlstra 			return 2;
31468eddac3fSPeter Zijlstra 	}
31478eddac3fSPeter Zijlstra 
31488eddac3fSPeter Zijlstra 	/*
31498eddac3fSPeter Zijlstra 	 * Prove that the new <prev> -> <next> dependency would not
31508eddac3fSPeter Zijlstra 	 * create a circular dependency in the graph. (We do this by
31518eddac3fSPeter Zijlstra 	 * a breadth-first search into the graph starting at <next>,
31523454a36dSBoqun Feng 	 * and check whether we can reach <prev>.)
31533454a36dSBoqun Feng 	 *
31543454a36dSBoqun Feng 	 * The search is limited by the size of the circular queue (i.e.,
31553454a36dSBoqun Feng 	 * MAX_CIRCULAR_QUEUE_SIZE) which keeps track of a breadth of nodes
31563454a36dSBoqun Feng 	 * in the graph whose neighbours are to be checked.
31573454a36dSBoqun Feng 	 */
31583454a36dSBoqun Feng 	ret = check_noncircular(next, prev, trace);
31593454a36dSBoqun Feng 	if (unlikely(bfs_error(ret) || ret == BFS_RMATCH))
31603454a36dSBoqun Feng 		return 0;
31613454a36dSBoqun Feng 
31623454a36dSBoqun Feng 	if (!check_irq_usage(curr, prev, next))
31633454a36dSBoqun Feng 		return 0;
31643454a36dSBoqun Feng 
31653454a36dSBoqun Feng 	/*
31663454a36dSBoqun Feng 	 * Is the <prev> -> <next> dependency already present?
31673454a36dSBoqun Feng 	 *
31683454a36dSBoqun Feng 	 * (this may occur even though this is a new chain: consider
31693454a36dSBoqun Feng 	 *  e.g. the L1 -> L2 -> L3 -> L4 and the L5 -> L1 -> L2 -> L3
31703454a36dSBoqun Feng 	 *  chains - the second one will be new, but L1 already has
31713454a36dSBoqun Feng 	 *  L2 added to its dependency list, due to the first chain.)
31723454a36dSBoqun Feng 	 */
31733454a36dSBoqun Feng 	list_for_each_entry(entry, &hlock_class(prev)->locks_after, entry) {
31743454a36dSBoqun Feng 		if (entry->class == hlock_class(next)) {
317570911fdcSByungchul Park 			if (distance == 1)
31768eddac3fSPeter Zijlstra 				entry->distance = 1;
31778eddac3fSPeter Zijlstra 			entry->dep |= calc_dep(prev, next);
31788eddac3fSPeter Zijlstra 
31793454a36dSBoqun Feng 			/*
31803454a36dSBoqun Feng 			 * Also, update the reverse dependency in @next's
31813454a36dSBoqun Feng 			 * ->locks_before list.
31823454a36dSBoqun Feng 			 *
31833454a36dSBoqun Feng 			 *  Here we reuse @entry as the cursor, which is fine
3184ae813308SPeter Zijlstra 			 *  because we won't go to the next iteration of the
3185ae813308SPeter Zijlstra 			 *  outer loop:
3186ae813308SPeter Zijlstra 			 *
31878c2c2b44SYuyang Du 			 *  For normal cases, we return in the inner loop.
3188b11be024SBoqun Feng 			 *
3189b11be024SBoqun Feng 			 *  If we fail to return, we have inconsistency, i.e.
3190b11be024SBoqun Feng 			 *  <prev>::locks_after contains <next> while
3191b11be024SBoqun Feng 			 *  <next>::locks_before doesn't contain <prev>. In
3192ae813308SPeter Zijlstra 			 *  that case, we return after the inner and indicate
319312593b74SBart Van Assche 			 *  something is wrong.
319412593b74SBart Van Assche 			 */
319512593b74SBart Van Assche 			list_for_each_entry(entry, &hlock_class(next)->locks_before, entry) {
31968eddac3fSPeter Zijlstra 				if (entry->class == hlock_class(prev)) {
319712593b74SBart Van Assche 					if (distance == 1)
31988eddac3fSPeter Zijlstra 						entry->distance = 1;
31998eddac3fSPeter Zijlstra 					entry->dep |= calc_depb(prev, next);
32008eddac3fSPeter Zijlstra 					return 1;
32018eddac3fSPeter Zijlstra 				}
32028eddac3fSPeter Zijlstra 			}
320386cffb80SBart Van Assche 
32048b023accSNick Desaulniers 			/* <prev> is not found in <next>::locks_before */
32058b023accSNick Desaulniers 			return 0;
32068eddac3fSPeter Zijlstra 		}
32078eddac3fSPeter Zijlstra 	}
32088eddac3fSPeter Zijlstra 
32098eddac3fSPeter Zijlstra 	/*
321086cffb80SBart Van Assche 	 * Is the <prev> -> <next> link redundant?
32118b023accSNick Desaulniers 	 */
32128b023accSNick Desaulniers 	ret = check_redundant(prev, next);
32138eddac3fSPeter Zijlstra 	if (bfs_error(ret))
32148eddac3fSPeter Zijlstra 		return 0;
32158eddac3fSPeter Zijlstra 	else if (ret == BFS_RMATCH)
321670911fdcSByungchul Park 		return 2;
32178eddac3fSPeter Zijlstra 
32188eddac3fSPeter Zijlstra 	if (!*trace) {
32198eddac3fSPeter Zijlstra 		*trace = save_trace();
32208eddac3fSPeter Zijlstra 		if (!*trace)
32218eddac3fSPeter Zijlstra 			return 0;
32228eddac3fSPeter Zijlstra 	}
32238eddac3fSPeter Zijlstra 
32248eddac3fSPeter Zijlstra 	/*
32258eddac3fSPeter Zijlstra 	 * Ok, all validations passed, add the new lock
32268eddac3fSPeter Zijlstra 	 * to the previous lock's dependency list:
32278eddac3fSPeter Zijlstra 	 */
322812593b74SBart Van Assche 	ret = add_lock_to_list(hlock_class(next), hlock_class(prev),
32298eddac3fSPeter Zijlstra 			       &hlock_class(prev)->locks_after, distance,
32308eddac3fSPeter Zijlstra 			       calc_dep(prev, next), *trace);
32318eddac3fSPeter Zijlstra 
32328eddac3fSPeter Zijlstra 	if (!ret)
32338eddac3fSPeter Zijlstra 		return 0;
32348eddac3fSPeter Zijlstra 
32358eddac3fSPeter Zijlstra 	ret = add_lock_to_list(hlock_class(prev), hlock_class(next),
32368eddac3fSPeter Zijlstra 			       &hlock_class(next)->locks_before, distance,
32378eddac3fSPeter Zijlstra 			       calc_depb(prev, next), *trace);
32388eddac3fSPeter Zijlstra 	if (!ret)
32398eddac3fSPeter Zijlstra 		return 0;
32408eddac3fSPeter Zijlstra 
32418eddac3fSPeter Zijlstra 	return 2;
32428eddac3fSPeter Zijlstra }
32438eddac3fSPeter Zijlstra 
32448eddac3fSPeter Zijlstra /*
32458eddac3fSPeter Zijlstra  * Add the dependency to all directly-previous locks that are 'relevant'.
32468eddac3fSPeter Zijlstra  * The ones that are relevant are (in increasing distance from curr):
32478eddac3fSPeter Zijlstra  * all consecutive trylock entries and the final non-trylock entry - or
3248bd76eca1SBoqun Feng  * the end of this context's lock-chain - whichever comes first.
32498eddac3fSPeter Zijlstra  */
3250e966eaeeSIngo Molnar static int
check_prevs_add(struct task_struct * curr,struct held_lock * next)3251621c9dacSBoqun Feng check_prevs_add(struct task_struct *curr, struct held_lock *next)
3252621c9dacSBoqun Feng {
3253ce07a941SByungchul Park 	struct lock_trace *trace = NULL;
32548eddac3fSPeter Zijlstra 	int depth = curr->lockdep_depth;
3255ce07a941SByungchul Park 	struct held_lock *hlock;
3256ce07a941SByungchul Park 
32578eddac3fSPeter Zijlstra 	/*
32588eddac3fSPeter Zijlstra 	 * Debugging checks.
32598eddac3fSPeter Zijlstra 	 *
32608eddac3fSPeter Zijlstra 	 * Depth must not be zero for a non-head lock:
32618eddac3fSPeter Zijlstra 	 */
32628eddac3fSPeter Zijlstra 	if (!depth)
32638eddac3fSPeter Zijlstra 		goto out_bug;
32648eddac3fSPeter Zijlstra 	/*
3265e966eaeeSIngo Molnar 	 * At least two relevant locks must exist for this
32668eddac3fSPeter Zijlstra 	 * to be a head:
32678eddac3fSPeter Zijlstra 	 */
32688eddac3fSPeter Zijlstra 	if (curr->held_locks[depth].irq_context !=
32698eddac3fSPeter Zijlstra 			curr->held_locks[depth-1].irq_context)
32708eddac3fSPeter Zijlstra 		goto out_bug;
32718eddac3fSPeter Zijlstra 
32728eddac3fSPeter Zijlstra 	for (;;) {
32738eddac3fSPeter Zijlstra 		u16 distance = curr->lockdep_depth - depth + 1;
32748eddac3fSPeter Zijlstra 		hlock = curr->held_locks + depth - 1;
32758eddac3fSPeter Zijlstra 
32768eddac3fSPeter Zijlstra 		if (hlock->check) {
32778eddac3fSPeter Zijlstra 			int ret = check_prev_add(curr, hlock, next, distance, &trace);
32788eddac3fSPeter Zijlstra 			if (!ret)
32798eddac3fSPeter Zijlstra 				return 0;
32808eddac3fSPeter Zijlstra 
32818eddac3fSPeter Zijlstra 			/*
32828eddac3fSPeter Zijlstra 			 * Stop after the first non-trylock entry,
32838eddac3fSPeter Zijlstra 			 * as non-trylock entries have added their
32848eddac3fSPeter Zijlstra 			 * own direct dependencies already, so this
32858eddac3fSPeter Zijlstra 			 * lock is connected to them indirectly:
32868eddac3fSPeter Zijlstra 			 */
32878eddac3fSPeter Zijlstra 			if (!hlock->trylock)
32888eddac3fSPeter Zijlstra 				break;
32898eddac3fSPeter Zijlstra 		}
32908eddac3fSPeter Zijlstra 
32918eddac3fSPeter Zijlstra 		depth--;
32928eddac3fSPeter Zijlstra 		/*
32938eddac3fSPeter Zijlstra 		 * End of lock-stack?
32948eddac3fSPeter Zijlstra 		 */
3295de4643a7SBart Van Assche 		if (!depth)
32968eddac3fSPeter Zijlstra 			break;
3297797b82ebSWaiman Long 		/*
3298810507feSWaiman Long 		 * Stop the search if we cross into another context:
3299810507feSWaiman Long 		 */
3300810507feSWaiman Long 		if (curr->held_locks[depth].irq_context !=
3301810507feSWaiman Long 				curr->held_locks[depth-1].irq_context)
3302810507feSWaiman Long 			break;
3303810507feSWaiman Long 	}
3304810507feSWaiman Long 	return 1;
3305810507feSWaiman Long out_bug:
3306810507feSWaiman Long 	if (!debug_locks_off_graph_unlock())
3307810507feSWaiman Long 		return 0;
3308810507feSWaiman Long 
3309810507feSWaiman Long 	/*
3310810507feSWaiman Long 	 * Clearly we all shouldn't be here, but since we made it we
3311810507feSWaiman Long 	 * can reliable say we messed up our state. See the above two
3312810507feSWaiman Long 	 * gotos for reasons why we could possibly end up here.
3313810507feSWaiman Long 	 */
3314810507feSWaiman Long 	WARN_ON(1);
3315810507feSWaiman Long 
3316810507feSWaiman Long 	return 0;
3317810507feSWaiman Long }
3318810507feSWaiman Long 
3319810507feSWaiman Long struct lock_chain lock_chains[MAX_LOCKDEP_CHAINS];
3320810507feSWaiman Long static DECLARE_BITMAP(lock_chains_in_use, MAX_LOCKDEP_CHAINS);
3321810507feSWaiman Long static u16 chain_hlocks[MAX_LOCKDEP_CHAIN_HLOCKS];
3322810507feSWaiman Long unsigned long nr_zapped_lock_chains;
3323810507feSWaiman Long unsigned int nr_free_chain_hlocks;	/* Free chain_hlocks in buckets */
3324810507feSWaiman Long unsigned int nr_lost_chain_hlocks;	/* Lost chain_hlocks */
3325810507feSWaiman Long unsigned int nr_large_chain_blocks;	/* size > MAX_CHAIN_BUCKETS */
3326810507feSWaiman Long 
3327810507feSWaiman Long /*
3328810507feSWaiman Long  * The first 2 chain_hlocks entries in the chain block in the bucket
3329810507feSWaiman Long  * list contains the following meta data:
3330810507feSWaiman Long  *
3331810507feSWaiman Long  *   entry[0]:
3332810507feSWaiman Long  *     Bit    15 - always set to 1 (it is not a class index)
3333810507feSWaiman Long  *     Bits 0-14 - upper 15 bits of the next block index
3334810507feSWaiman Long  *   entry[1]    - lower 16 bits of next block index
3335810507feSWaiman Long  *
3336810507feSWaiman Long  * A next block index of all 1 bits means it is the end of the list.
3337810507feSWaiman Long  *
3338810507feSWaiman Long  * On the unsized bucket (bucket-0), the 3rd and 4th entries contain
3339810507feSWaiman Long  * the chain block size:
3340810507feSWaiman Long  *
3341810507feSWaiman Long  *   entry[2] - upper 16 bits of the chain block size
3342810507feSWaiman Long  *   entry[3] - lower 16 bits of the chain block size
3343810507feSWaiman Long  */
3344810507feSWaiman Long #define MAX_CHAIN_BUCKETS	16
3345810507feSWaiman Long #define CHAIN_BLK_FLAG		(1U << 15)
3346810507feSWaiman Long #define CHAIN_BLK_LIST_END	0xFFFFU
3347810507feSWaiman Long 
3348810507feSWaiman Long static int chain_block_buckets[MAX_CHAIN_BUCKETS];
3349810507feSWaiman Long 
size_to_bucket(int size)3350810507feSWaiman Long static inline int size_to_bucket(int size)
3351810507feSWaiman Long {
3352810507feSWaiman Long 	if (size > MAX_CHAIN_BUCKETS)
3353810507feSWaiman Long 		return 0;
3354810507feSWaiman Long 
3355810507feSWaiman Long 	return size - 1;
3356810507feSWaiman Long }
3357810507feSWaiman Long 
3358810507feSWaiman Long /*
3359810507feSWaiman Long  * Iterate all the chain blocks in a bucket.
3360810507feSWaiman Long  */
3361810507feSWaiman Long #define for_each_chain_block(bucket, prev, curr)		\
3362810507feSWaiman Long 	for ((prev) = -1, (curr) = chain_block_buckets[bucket];	\
3363810507feSWaiman Long 	     (curr) >= 0;					\
3364810507feSWaiman Long 	     (prev) = (curr), (curr) = chain_block_next(curr))
3365810507feSWaiman Long 
3366810507feSWaiman Long /*
3367810507feSWaiman Long  * next block or -1
3368810507feSWaiman Long  */
chain_block_next(int offset)3369810507feSWaiman Long static inline int chain_block_next(int offset)
3370810507feSWaiman Long {
3371810507feSWaiman Long 	int next = chain_hlocks[offset];
3372810507feSWaiman Long 
3373810507feSWaiman Long 	WARN_ON_ONCE(!(next & CHAIN_BLK_FLAG));
3374810507feSWaiman Long 
3375810507feSWaiman Long 	if (next == CHAIN_BLK_LIST_END)
3376810507feSWaiman Long 		return -1;
3377810507feSWaiman Long 
3378810507feSWaiman Long 	next &= ~CHAIN_BLK_FLAG;
3379810507feSWaiman Long 	next <<= 16;
3380810507feSWaiman Long 	next |= chain_hlocks[offset + 1];
3381810507feSWaiman Long 
3382810507feSWaiman Long 	return next;
3383810507feSWaiman Long }
3384810507feSWaiman Long 
3385810507feSWaiman Long /*
3386810507feSWaiman Long  * bucket-0 only
3387810507feSWaiman Long  */
chain_block_size(int offset)3388810507feSWaiman Long static inline int chain_block_size(int offset)
3389810507feSWaiman Long {
3390810507feSWaiman Long 	return (chain_hlocks[offset + 2] << 16) | chain_hlocks[offset + 3];
3391810507feSWaiman Long }
3392810507feSWaiman Long 
init_chain_block(int offset,int next,int bucket,int size)3393810507feSWaiman Long static inline void init_chain_block(int offset, int next, int bucket, int size)
3394810507feSWaiman Long {
3395810507feSWaiman Long 	chain_hlocks[offset] = (next >> 16) | CHAIN_BLK_FLAG;
3396810507feSWaiman Long 	chain_hlocks[offset + 1] = (u16)next;
3397810507feSWaiman Long 
3398810507feSWaiman Long 	if (size && !bucket) {
3399810507feSWaiman Long 		chain_hlocks[offset + 2] = size >> 16;
3400810507feSWaiman Long 		chain_hlocks[offset + 3] = (u16)size;
3401810507feSWaiman Long 	}
3402810507feSWaiman Long }
3403810507feSWaiman Long 
add_chain_block(int offset,int size)3404810507feSWaiman Long static inline void add_chain_block(int offset, int size)
3405810507feSWaiman Long {
3406810507feSWaiman Long 	int bucket = size_to_bucket(size);
3407810507feSWaiman Long 	int next = chain_block_buckets[bucket];
3408810507feSWaiman Long 	int prev, curr;
3409810507feSWaiman Long 
3410810507feSWaiman Long 	if (unlikely(size < 2)) {
3411810507feSWaiman Long 		/*
3412810507feSWaiman Long 		 * We can't store single entries on the freelist. Leak them.
3413810507feSWaiman Long 		 *
3414810507feSWaiman Long 		 * One possible way out would be to uniquely mark them, other
3415810507feSWaiman Long 		 * than with CHAIN_BLK_FLAG, such that we can recover them when
3416810507feSWaiman Long 		 * the block before it is re-added.
3417810507feSWaiman Long 		 */
3418810507feSWaiman Long 		if (size)
3419810507feSWaiman Long 			nr_lost_chain_hlocks++;
3420810507feSWaiman Long 		return;
3421810507feSWaiman Long 	}
3422810507feSWaiman Long 
3423810507feSWaiman Long 	nr_free_chain_hlocks += size;
3424810507feSWaiman Long 	if (!bucket) {
3425810507feSWaiman Long 		nr_large_chain_blocks++;
3426810507feSWaiman Long 
3427810507feSWaiman Long 		/*
3428810507feSWaiman Long 		 * Variable sized, sort large to small.
3429810507feSWaiman Long 		 */
3430810507feSWaiman Long 		for_each_chain_block(0, prev, curr) {
3431810507feSWaiman Long 			if (size >= chain_block_size(curr))
3432810507feSWaiman Long 				break;
3433810507feSWaiman Long 		}
3434810507feSWaiman Long 		init_chain_block(offset, curr, 0, size);
3435810507feSWaiman Long 		if (prev < 0)
3436810507feSWaiman Long 			chain_block_buckets[0] = offset;
3437810507feSWaiman Long 		else
3438810507feSWaiman Long 			init_chain_block(prev, offset, 0, 0);
3439810507feSWaiman Long 		return;
3440810507feSWaiman Long 	}
3441810507feSWaiman Long 	/*
3442810507feSWaiman Long 	 * Fixed size, add to head.
3443810507feSWaiman Long 	 */
3444810507feSWaiman Long 	init_chain_block(offset, next, bucket, size);
3445810507feSWaiman Long 	chain_block_buckets[bucket] = offset;
3446810507feSWaiman Long }
3447810507feSWaiman Long 
3448810507feSWaiman Long /*
3449810507feSWaiman Long  * Only the first block in the list can be deleted.
3450810507feSWaiman Long  *
3451810507feSWaiman Long  * For the variable size bucket[0], the first block (the largest one) is
3452810507feSWaiman Long  * returned, broken up and put back into the pool. So if a chain block of
3453810507feSWaiman Long  * length > MAX_CHAIN_BUCKETS is ever used and zapped, it will just be
3454810507feSWaiman Long  * queued up after the primordial chain block and never be used until the
3455810507feSWaiman Long  * hlock entries in the primordial chain block is almost used up. That
3456810507feSWaiman Long  * causes fragmentation and reduce allocation efficiency. That can be
3457810507feSWaiman Long  * monitored by looking at the "large chain blocks" number in lockdep_stats.
3458810507feSWaiman Long  */
del_chain_block(int bucket,int size,int next)3459810507feSWaiman Long static inline void del_chain_block(int bucket, int size, int next)
3460810507feSWaiman Long {
3461810507feSWaiman Long 	nr_free_chain_hlocks -= size;
3462810507feSWaiman Long 	chain_block_buckets[bucket] = next;
3463810507feSWaiman Long 
3464810507feSWaiman Long 	if (!bucket)
3465810507feSWaiman Long 		nr_large_chain_blocks--;
3466810507feSWaiman Long }
3467810507feSWaiman Long 
init_chain_block_buckets(void)3468810507feSWaiman Long static void init_chain_block_buckets(void)
3469810507feSWaiman Long {
3470810507feSWaiman Long 	int i;
3471810507feSWaiman Long 
3472810507feSWaiman Long 	for (i = 0; i < MAX_CHAIN_BUCKETS; i++)
3473810507feSWaiman Long 		chain_block_buckets[i] = -1;
3474810507feSWaiman Long 
3475810507feSWaiman Long 	add_chain_block(0, ARRAY_SIZE(chain_hlocks));
3476810507feSWaiman Long }
3477810507feSWaiman Long 
3478810507feSWaiman Long /*
3479810507feSWaiman Long  * Return offset of a chain block of the right size or -1 if not found.
3480810507feSWaiman Long  *
3481810507feSWaiman Long  * Fairly simple worst-fit allocator with the addition of a number of size
3482810507feSWaiman Long  * specific free lists.
3483810507feSWaiman Long  */
alloc_chain_hlocks(int req)3484810507feSWaiman Long static int alloc_chain_hlocks(int req)
3485810507feSWaiman Long {
3486810507feSWaiman Long 	int bucket, curr, size;
3487810507feSWaiman Long 
3488810507feSWaiman Long 	/*
3489810507feSWaiman Long 	 * We rely on the MSB to act as an escape bit to denote freelist
3490810507feSWaiman Long 	 * pointers. Make sure this bit isn't set in 'normal' class_idx usage.
3491810507feSWaiman Long 	 */
3492810507feSWaiman Long 	BUILD_BUG_ON((MAX_LOCKDEP_KEYS-1) & CHAIN_BLK_FLAG);
3493810507feSWaiman Long 
3494810507feSWaiman Long 	init_data_structures_once();
3495810507feSWaiman Long 
3496810507feSWaiman Long 	if (nr_free_chain_hlocks < req)
3497810507feSWaiman Long 		return -1;
3498810507feSWaiman Long 
3499bca4104bSPeter Zijlstra 	/*
3500810507feSWaiman Long 	 * We require a minimum of 2 (u16) entries to encode a freelist
3501810507feSWaiman Long 	 * 'pointer'.
3502810507feSWaiman Long 	 */
3503810507feSWaiman Long 	req = max(req, 2);
3504810507feSWaiman Long 	bucket = size_to_bucket(req);
3505810507feSWaiman Long 	curr = chain_block_buckets[bucket];
3506810507feSWaiman Long 
3507810507feSWaiman Long 	if (bucket) {
3508810507feSWaiman Long 		if (curr >= 0) {
3509810507feSWaiman Long 			del_chain_block(bucket, req, chain_block_next(curr));
3510810507feSWaiman Long 			return curr;
3511810507feSWaiman Long 		}
3512810507feSWaiman Long 		/* Try bucket 0 */
3513810507feSWaiman Long 		curr = chain_block_buckets[0];
3514810507feSWaiman Long 	}
3515810507feSWaiman Long 
3516810507feSWaiman Long 	/*
3517810507feSWaiman Long 	 * The variable sized freelist is sorted by size; the first entry is
3518810507feSWaiman Long 	 * the largest. Use it if it fits.
3519810507feSWaiman Long 	 */
3520810507feSWaiman Long 	if (curr >= 0) {
3521810507feSWaiman Long 		size = chain_block_size(curr);
3522810507feSWaiman Long 		if (likely(size >= req)) {
3523810507feSWaiman Long 			del_chain_block(0, size, chain_block_next(curr));
3524810507feSWaiman Long 			if (size > req)
3525810507feSWaiman Long 				add_chain_block(curr + req, size - req);
35268eddac3fSPeter Zijlstra 			return curr;
35278eddac3fSPeter Zijlstra 		}
35288eddac3fSPeter Zijlstra 	}
3529f611e8cfSBoqun Feng 
3530f611e8cfSBoqun Feng 	/*
3531f611e8cfSBoqun Feng 	 * Last resort, split a block in a larger sized bucket.
353228df029dSCheng Jui Wang 	 */
35338eddac3fSPeter Zijlstra 	for (size = MAX_CHAIN_BUCKETS; size > req; size--) {
35348eddac3fSPeter Zijlstra 		bucket = size_to_bucket(size);
35358eddac3fSPeter Zijlstra 		curr = chain_block_buckets[bucket];
35369e4e7554SIngo Molnar 		if (curr < 0)
35379e4e7554SIngo Molnar 			continue;
35389e4e7554SIngo Molnar 
35399e4e7554SIngo Molnar 		del_chain_block(bucket, size, chain_block_next(curr));
35409e4e7554SIngo Molnar 		add_chain_block(curr + req, size - req);
35419e4e7554SIngo Molnar 		return curr;
35429e4e7554SIngo Molnar 	}
35439e4e7554SIngo Molnar 
35449e4e7554SIngo Molnar 	return -1;
35459e4e7554SIngo Molnar }
35469e4e7554SIngo Molnar 
free_chain_hlocks(int base,int size)35479e4e7554SIngo Molnar static inline void free_chain_hlocks(int base, int size)
35489e4e7554SIngo Molnar {
35499e4e7554SIngo Molnar 	add_chain_block(base, max(size, 2));
35509e4e7554SIngo Molnar }
35519e4e7554SIngo Molnar 
lock_chain_get_class(struct lock_chain * chain,int i)35529e4e7554SIngo Molnar struct lock_class *lock_chain_get_class(struct lock_chain *chain, int i)
35539e4e7554SIngo Molnar {
35545c8a010cSBorislav Petkov 	u16 chain_hlock = chain_hlocks[chain->base + i];
35559e4e7554SIngo Molnar 	unsigned int class_idx = chain_hlock_class_idx(chain_hlock);
355639e2e173SAlfredo Alvarez Fernandez 
355739e2e173SAlfredo Alvarez Fernandez 	return lock_classes + class_idx;
3558f611e8cfSBoqun Feng }
355939e2e173SAlfredo Alvarez Fernandez 
3560f611e8cfSBoqun Feng /*
356139e2e173SAlfredo Alvarez Fernandez  * Returns the index of the first held_lock of the current chain
3562f611e8cfSBoqun Feng  */
get_first_held_lock(struct task_struct * curr,struct held_lock * hlock)3563f611e8cfSBoqun Feng static inline int get_first_held_lock(struct task_struct *curr,
356439e2e173SAlfredo Alvarez Fernandez 					struct held_lock *hlock)
356539e2e173SAlfredo Alvarez Fernandez {
356639e2e173SAlfredo Alvarez Fernandez 	int i;
356739e2e173SAlfredo Alvarez Fernandez 	struct held_lock *hlock_curr;
356839e2e173SAlfredo Alvarez Fernandez 
356939e2e173SAlfredo Alvarez Fernandez 	for (i = curr->lockdep_depth - 1; i >= 0; i--) {
357039e2e173SAlfredo Alvarez Fernandez 		hlock_curr = curr->held_locks + i;
357139e2e173SAlfredo Alvarez Fernandez 		if (hlock_curr->irq_context != hlock->irq_context)
3572f6ec8829SYuyang Du 			break;
357339e2e173SAlfredo Alvarez Fernandez 
3574834494b2SYuyang Du 	}
357539e2e173SAlfredo Alvarez Fernandez 
3576834494b2SYuyang Du 	return ++i;
3577834494b2SYuyang Du }
3578834494b2SYuyang Du 
357939e2e173SAlfredo Alvarez Fernandez #ifdef CONFIG_DEBUG_LOCKDEP
3580f611e8cfSBoqun Feng /*
358139e2e173SAlfredo Alvarez Fernandez  * Returns the next chain_key iteration
358239e2e173SAlfredo Alvarez Fernandez  */
print_chain_key_iteration(u16 hlock_id,u64 chain_key)358339e2e173SAlfredo Alvarez Fernandez static u64 print_chain_key_iteration(u16 hlock_id, u64 chain_key)
358439e2e173SAlfredo Alvarez Fernandez {
3585f611e8cfSBoqun Feng 	u64 new_chain_key = iterate_chain_key(chain_key, hlock_id);
358639e2e173SAlfredo Alvarez Fernandez 
358739e2e173SAlfredo Alvarez Fernandez 	printk(" hlock_id:%d -> chain_key:%016Lx",
358839e2e173SAlfredo Alvarez Fernandez 		(unsigned int)hlock_id,
358939e2e173SAlfredo Alvarez Fernandez 		(unsigned long long)new_chain_key);
359039e2e173SAlfredo Alvarez Fernandez 	return new_chain_key;
359139e2e173SAlfredo Alvarez Fernandez }
3592f6ec8829SYuyang Du 
3593f611e8cfSBoqun Feng static void
print_chain_keys_held_locks(struct task_struct * curr,struct held_lock * hlock_next)359439e2e173SAlfredo Alvarez Fernandez print_chain_keys_held_locks(struct task_struct *curr, struct held_lock *hlock_next)
359539e2e173SAlfredo Alvarez Fernandez {
359639e2e173SAlfredo Alvarez Fernandez 	struct held_lock *hlock;
3597f611e8cfSBoqun Feng 	u64 chain_key = INITIAL_CHAIN_KEY;
3598f611e8cfSBoqun Feng 	int depth = curr->lockdep_depth;
359939e2e173SAlfredo Alvarez Fernandez 	int i = get_first_held_lock(curr, hlock_next);
3600eb1cfd09SKent Overstreet 
360139e2e173SAlfredo Alvarez Fernandez 	printk("depth: %u (irq_context %u)\n", depth - i + 1,
360239e2e173SAlfredo Alvarez Fernandez 		hlock_next->irq_context);
360339e2e173SAlfredo Alvarez Fernandez 	for (; i < depth; i++) {
360439e2e173SAlfredo Alvarez Fernandez 		hlock = curr->held_locks + i;
360539e2e173SAlfredo Alvarez Fernandez 		chain_key = print_chain_key_iteration(hlock_id(hlock), chain_key);
360639e2e173SAlfredo Alvarez Fernandez 
360739e2e173SAlfredo Alvarez Fernandez 		print_lock(hlock);
360839e2e173SAlfredo Alvarez Fernandez 	}
3609681fbec8SPaul E. McKenney 
3610a5dd63efSPaul E. McKenney 	print_chain_key_iteration(hlock_id(hlock_next), chain_key);
3611a5dd63efSPaul E. McKenney 	print_lock(hlock_next);
361239e2e173SAlfredo Alvarez Fernandez }
3613a5dd63efSPaul E. McKenney 
print_chain_keys_chain(struct lock_chain * chain)3614681fbec8SPaul E. McKenney static void print_chain_keys_chain(struct lock_chain *chain)
3615681fbec8SPaul E. McKenney {
361639e2e173SAlfredo Alvarez Fernandez 	int i;
3617681fbec8SPaul E. McKenney 	u64 chain_key = INITIAL_CHAIN_KEY;
361839e2e173SAlfredo Alvarez Fernandez 	u16 hlock_id;
361939e2e173SAlfredo Alvarez Fernandez 
3620681fbec8SPaul E. McKenney 	printk("depth: %u\n", chain->depth);
362139e2e173SAlfredo Alvarez Fernandez 	for (i = 0; i < chain->depth; i++) {
362239e2e173SAlfredo Alvarez Fernandez 		hlock_id = chain_hlocks[chain->base + i];
3623681fbec8SPaul E. McKenney 		chain_key = print_chain_key_iteration(hlock_id, chain_key);
362439e2e173SAlfredo Alvarez Fernandez 
362539e2e173SAlfredo Alvarez Fernandez 		print_lock_name(NULL, lock_classes + chain_hlock_class_idx(hlock_id));
36265c8a010cSBorislav Petkov 		printk("\n");
362739e2e173SAlfredo Alvarez Fernandez 	}
362839e2e173SAlfredo Alvarez Fernandez }
36299e4e7554SIngo Molnar 
print_collision(struct task_struct * curr,struct held_lock * hlock_next,struct lock_chain * chain)36309e4e7554SIngo Molnar static void print_collision(struct task_struct *curr,
36319e4e7554SIngo Molnar 			struct held_lock *hlock_next,
36329e4e7554SIngo Molnar 			struct lock_chain *chain)
36339e4e7554SIngo Molnar {
36349e4e7554SIngo Molnar 	nbcon_cpu_emergency_enter();
36359e4e7554SIngo Molnar 
36369e4e7554SIngo Molnar 	pr_warn("\n");
36379e4e7554SIngo Molnar 	pr_warn("============================\n");
36389e4e7554SIngo Molnar 	pr_warn("WARNING: chain_key collision\n");
36399e4e7554SIngo Molnar 	print_kernel_ident();
36409e4e7554SIngo Molnar 	pr_warn("----------------------------\n");
36419e4e7554SIngo Molnar 	pr_warn("%s/%d: ", current->comm, task_pid_nr(current));
36429e4e7554SIngo Molnar 	pr_warn("Hash chain already cached but the contents don't match!\n");
364339e2e173SAlfredo Alvarez Fernandez 
364439e2e173SAlfredo Alvarez Fernandez 	pr_warn("Held locks:");
36459e4e7554SIngo Molnar 	print_chain_keys_held_locks(curr, hlock_next);
364639e2e173SAlfredo Alvarez Fernandez 
36479e4e7554SIngo Molnar 	pr_warn("Locks in cached chain:");
36489e4e7554SIngo Molnar 	print_chain_keys_chain(chain);
3649f611e8cfSBoqun Feng 
36509e4e7554SIngo Molnar 	pr_warn("\nstack backtrace:\n");
365139e2e173SAlfredo Alvarez Fernandez 	dump_stack();
365239e2e173SAlfredo Alvarez Fernandez 
36539e4e7554SIngo Molnar 	nbcon_cpu_emergency_exit();
36549e4e7554SIngo Molnar }
365539e2e173SAlfredo Alvarez Fernandez #endif
36569e4e7554SIngo Molnar 
36579e4e7554SIngo Molnar /*
36589e4e7554SIngo Molnar  * Checks whether the chain and the current held locks are consistent
36599e4e7554SIngo Molnar  * in depth and also in content. If they are not it most likely means
36609e4e7554SIngo Molnar  * that there was a collision during the calculation of the chain_key.
36612212684aSBart Van Assche  * Returns: 0 not passed, 1 passed
36622212684aSBart Van Assche  */
check_no_collision(struct task_struct * curr,struct held_lock * hlock,struct lock_chain * chain)36632212684aSBart Van Assche static int check_no_collision(struct task_struct *curr,
36642212684aSBart Van Assche 			struct held_lock *hlock,
36652212684aSBart Van Assche 			struct lock_chain *chain)
3666de4643a7SBart Van Assche {
3667de4643a7SBart Van Assche #ifdef CONFIG_DEBUG_LOCKDEP
36682212684aSBart Van Assche 	int i, j, id;
36692212684aSBart Van Assche 
36702212684aSBart Van Assche 	i = get_first_held_lock(curr, hlock);
36712212684aSBart Van Assche 
3672de4643a7SBart Van Assche 	if (DEBUG_LOCKS_WARN_ON(chain->depth != curr->lockdep_depth - (i - 1))) {
3673de4643a7SBart Van Assche 		print_collision(curr, hlock, chain);
3674de4643a7SBart Van Assche 		return 0;
3675de4643a7SBart Van Assche 	}
3676de4643a7SBart Van Assche 
3677de4643a7SBart Van Assche 	for (j = 0; j < chain->depth - 1; j++, i++) {
3678de4643a7SBart Van Assche 		id = hlock_id(&curr->held_locks[i]);
3679de4643a7SBart Van Assche 
3680de4643a7SBart Van Assche 		if (DEBUG_LOCKS_WARN_ON(chain_hlocks[chain->base + j] != id)) {
3681de4643a7SBart Van Assche 			print_collision(curr, hlock, chain);
3682de4643a7SBart Van Assche 			return 0;
3683de4643a7SBart Van Assche 		}
3684de4643a7SBart Van Assche 	}
36852212684aSBart Van Assche #endif
36862212684aSBart Van Assche 	return 1;
36872212684aSBart Van Assche }
3688545c23f2SByungchul Park 
3689545c23f2SByungchul Park /*
3690545c23f2SByungchul Park  * Given an index that is >= -1, return the index of the next lock chain.
3691545c23f2SByungchul Park  * Return -2 if there is no next lock chain.
3692545c23f2SByungchul Park  */
lockdep_next_lockchain(long i)36938eddac3fSPeter Zijlstra long lockdep_next_lockchain(long i)
3694545c23f2SByungchul Park {
36958eddac3fSPeter Zijlstra 	i = find_next_bit(lock_chains_in_use, ARRAY_SIZE(lock_chains), i + 1);
36968eddac3fSPeter Zijlstra 	return i < ARRAY_SIZE(lock_chains) ? i : -2;
36978eddac3fSPeter Zijlstra }
3698a63f38ccSAndrew Morton 
lock_chain_count(void)36998eddac3fSPeter Zijlstra unsigned long lock_chain_count(void)
37008eddac3fSPeter Zijlstra {
37018eddac3fSPeter Zijlstra 	return bitmap_weight(lock_chains_in_use, ARRAY_SIZE(lock_chains));
37028eddac3fSPeter Zijlstra }
3703527af3eaSBart Van Assche 
37048eddac3fSPeter Zijlstra /* Must be called with the graph lock held. */
alloc_lock_chain(void)37058eddac3fSPeter Zijlstra static struct lock_chain *alloc_lock_chain(void)
37068eddac3fSPeter Zijlstra {
3707248efb21SPeter Zijlstra 	int idx = find_first_zero_bit(lock_chains_in_use,
37088eddac3fSPeter Zijlstra 				      ARRAY_SIZE(lock_chains));
37099e4e7554SIngo Molnar 
3710de4643a7SBart Van Assche 	if (unlikely(idx >= ARRAY_SIZE(lock_chains)))
3711de4643a7SBart Van Assche 		return NULL;
37128eddac3fSPeter Zijlstra 	__set_bit(idx, lock_chains_in_use);
37138eddac3fSPeter Zijlstra 	return lock_chains + idx;
37148eddac3fSPeter Zijlstra }
37158eddac3fSPeter Zijlstra 
37168eddac3fSPeter Zijlstra /*
37178eddac3fSPeter Zijlstra  * Adds a dependency chain into chain hashtable. And must be called with
37188eddac3fSPeter Zijlstra  * graph_lock held.
37198eddac3fSPeter Zijlstra  *
37208eddac3fSPeter Zijlstra  * Return 0 if fail, and graph_lock is released.
37219e4e7554SIngo Molnar  * Return 1 if succeed, with graph_lock held.
37228eddac3fSPeter Zijlstra  */
add_chain_cache(struct task_struct * curr,struct held_lock * hlock,u64 chain_key)372375dd602aSPeter Zijlstra static inline int add_chain_cache(struct task_struct *curr,
372475dd602aSPeter Zijlstra 				  struct held_lock *hlock,
372575dd602aSPeter Zijlstra 				  u64 chain_key)
372675dd602aSPeter Zijlstra {
372775dd602aSPeter Zijlstra 	struct hlist_head *hash_head = chainhashentry(chain_key);
3728810507feSWaiman Long 	struct lock_chain *chain;
3729810507feSWaiman Long 	int i, j;
3730f9af456aSByungchul Park 
373175dd602aSPeter Zijlstra 	/*
373275dd602aSPeter Zijlstra 	 * The caller must hold the graph lock, ensure we've got IRQs
373375dd602aSPeter Zijlstra 	 * disabled to make this an IRQ-safe lock.. for recursion reasons
373475dd602aSPeter Zijlstra 	 * lockdep won't complain about its own locking errors.
373575dd602aSPeter Zijlstra 	 */
373675dd602aSPeter Zijlstra 	if (lockdep_assert_locked())
373775dd602aSPeter Zijlstra 		return 0;
3738810507feSWaiman Long 
3739810507feSWaiman Long 	chain = alloc_lock_chain();
3740f611e8cfSBoqun Feng 	if (!chain) {
3741810507feSWaiman Long 		if (!debug_locks_off_graph_unlock())
3742810507feSWaiman Long 			return 0;
3743810507feSWaiman Long 
3744f611e8cfSBoqun Feng 		nbcon_cpu_emergency_enter();
3745a63f38ccSAndrew Morton 		print_lockdep_off("BUG: MAX_LOCKDEP_CHAINS too low!");
37468eddac3fSPeter Zijlstra 		dump_stack();
3747b3b9c187SWaiman Long 		nbcon_cpu_emergency_exit();
37488eddac3fSPeter Zijlstra 		return 0;
37498eddac3fSPeter Zijlstra 	}
37508eddac3fSPeter Zijlstra 	chain->chain_key = chain_key;
37518eddac3fSPeter Zijlstra 	chain->irq_context = hlock->irq_context;
3752545c23f2SByungchul Park 	i = get_first_held_lock(curr, hlock);
3753a0b0fd53SBart Van Assche 	chain->depth = curr->lockdep_depth + 1 - i;
3754a0b0fd53SBart Van Assche 
3755545c23f2SByungchul Park 	BUILD_BUG_ON((1UL << 24) <= ARRAY_SIZE(chain_hlocks));
3756545c23f2SByungchul Park 	BUILD_BUG_ON((1UL << 6)  <= ARRAY_SIZE(curr->held_locks));
3757545c23f2SByungchul Park 	BUILD_BUG_ON((1UL << 8*sizeof(chain_hlocks[0])) <= ARRAY_SIZE(lock_classes));
3758545c23f2SByungchul Park 
3759545c23f2SByungchul Park 	j = alloc_chain_hlocks(chain->depth);
3760545c23f2SByungchul Park 	if (j < 0) {
3761545c23f2SByungchul Park 		if (!debug_locks_off_graph_unlock())
3762a0b0fd53SBart Van Assche 			return 0;
3763545c23f2SByungchul Park 
3764545c23f2SByungchul Park 		nbcon_cpu_emergency_enter();
3765545c23f2SByungchul Park 		print_lockdep_off("BUG: MAX_LOCKDEP_CHAIN_HLOCKS too low!");
3766545c23f2SByungchul Park 		dump_stack();
3767545c23f2SByungchul Park 		nbcon_cpu_emergency_exit();
3768545c23f2SByungchul Park 		return 0;
3769545c23f2SByungchul Park 	}
3770545c23f2SByungchul Park 
3771545c23f2SByungchul Park 	chain->base = j;
3772545c23f2SByungchul Park 	for (j = 0; j < chain->depth - 1; j++, i++) {
3773545c23f2SByungchul Park 		int lock_id = hlock_id(curr->held_locks + i);
3774545c23f2SByungchul Park 
3775545c23f2SByungchul Park 		chain_hlocks[chain->base + j] = lock_id;
3776545c23f2SByungchul Park 	}
3777545c23f2SByungchul Park 	chain_hlocks[chain->base + j] = hlock_id(hlock);
3778545c23f2SByungchul Park 	hlist_add_head_rcu(&chain->entry, hash_head);
3779545c23f2SByungchul Park 	debug_atomic_inc(chain_lookup_misses);
3780545c23f2SByungchul Park 	inc_chains(chain->irq_context);
3781545c23f2SByungchul Park 
3782545c23f2SByungchul Park 	return 1;
3783545c23f2SByungchul Park }
3784545c23f2SByungchul Park 
3785545c23f2SByungchul Park /*
3786545c23f2SByungchul Park  * Look up a dependency chain. Must be called with either the graph lock or
3787545c23f2SByungchul Park  * the RCU read lock held.
3788545c23f2SByungchul Park  */
lookup_chain_cache(u64 chain_key)3789545c23f2SByungchul Park static inline struct lock_chain *lookup_chain_cache(u64 chain_key)
379004860d48SBorislav Petkov {
3791545c23f2SByungchul Park 	struct hlist_head *hash_head = chainhashentry(chain_key);
3792545c23f2SByungchul Park 	struct lock_chain *chain;
3793545c23f2SByungchul Park 
3794545c23f2SByungchul Park 	hlist_for_each_entry_rcu(chain, hash_head, entry) {
3795545c23f2SByungchul Park 		if (READ_ONCE(chain->chain_key) == chain_key) {
3796545c23f2SByungchul Park 			debug_atomic_inc(chain_lookup_hits);
3797545c23f2SByungchul Park 			return chain;
3798545c23f2SByungchul Park 		}
379904860d48SBorislav Petkov 	}
3800545c23f2SByungchul Park 	return NULL;
3801545c23f2SByungchul Park }
3802545c23f2SByungchul Park 
3803545c23f2SByungchul Park /*
3804545c23f2SByungchul Park  * If the key is not present yet in dependency chain cache then
3805545c23f2SByungchul Park  * add it and return 1 - in this case the new dependency chain is
3806545c23f2SByungchul Park  * validated. If the key is already hashed, return 0.
3807545c23f2SByungchul Park  * (On return with 1 graph_lock is held.)
3808545c23f2SByungchul Park  */
lookup_chain_cache_add(struct task_struct * curr,struct held_lock * hlock,u64 chain_key)3809545c23f2SByungchul Park static inline int lookup_chain_cache_add(struct task_struct *curr,
3810545c23f2SByungchul Park 					 struct held_lock *hlock,
3811545c23f2SByungchul Park 					 u64 chain_key)
3812545c23f2SByungchul Park {
3813545c23f2SByungchul Park 	struct lock_class *class = hlock_class(hlock);
3814545c23f2SByungchul Park 	struct lock_chain *chain = lookup_chain_cache(chain_key);
3815545c23f2SByungchul Park 
3816545c23f2SByungchul Park 	if (chain) {
3817545c23f2SByungchul Park cache_hit:
3818545c23f2SByungchul Park 		if (!check_no_collision(curr, hlock, chain))
3819545c23f2SByungchul Park 			return 0;
3820545c23f2SByungchul Park 
38210b9fc8ecSYuyang Du 		if (very_verbose(class)) {
38220b9fc8ecSYuyang Du 			printk("\nhash chain already cached, key: "
38230b9fc8ecSYuyang Du 					"%016Lx tail class: [%px] %s\n",
38248eddac3fSPeter Zijlstra 					(unsigned long long)chain_key,
38258eddac3fSPeter Zijlstra 					class->key, class->name);
38268eddac3fSPeter Zijlstra 		}
38278eddac3fSPeter Zijlstra 
38288eddac3fSPeter Zijlstra 		return 0;
38298eddac3fSPeter Zijlstra 	}
38308eddac3fSPeter Zijlstra 
38318eddac3fSPeter Zijlstra 	if (very_verbose(class)) {
3832545c23f2SByungchul Park 		printk("\nnew hash chain, key: %016Lx tail class: [%px] %s\n",
38338eddac3fSPeter Zijlstra 			(unsigned long long)chain_key, class->key, class->name);
38348eddac3fSPeter Zijlstra 	}
3835fb9edbe9SOleg Nesterov 
3836545c23f2SByungchul Park 	if (!graph_lock())
38378eddac3fSPeter Zijlstra 		return 0;
38388eddac3fSPeter Zijlstra 
38398eddac3fSPeter Zijlstra 	/*
38408eddac3fSPeter Zijlstra 	 * We have to walk the chain again locked - to avoid duplicates:
38418eddac3fSPeter Zijlstra 	 */
38428eddac3fSPeter Zijlstra 	chain = lookup_chain_cache(chain_key);
38438eddac3fSPeter Zijlstra 	if (chain) {
384431a490e5SYuyang Du 		graph_unlock();
38458eddac3fSPeter Zijlstra 		goto cache_hit;
384631a490e5SYuyang Du 	}
384731a490e5SYuyang Du 
384831a490e5SYuyang Du 	if (!add_chain_cache(curr, hlock, chain_key))
384931a490e5SYuyang Du 		return 0;
385031a490e5SYuyang Du 
385131a490e5SYuyang Du 	return 1;
385231a490e5SYuyang Du }
385331a490e5SYuyang Du 
validate_chain(struct task_struct * curr,struct held_lock * hlock,int chain_head,u64 chain_key)38548eddac3fSPeter Zijlstra static int validate_chain(struct task_struct *curr,
38554609c4f9SYuyang Du 			  struct held_lock *hlock,
38568eddac3fSPeter Zijlstra 			  int chain_head, u64 chain_key)
38578eddac3fSPeter Zijlstra {
38588eddac3fSPeter Zijlstra 	/*
38598eddac3fSPeter Zijlstra 	 * Trylock needs to maintain the stack of held locks, but it
38608eddac3fSPeter Zijlstra 	 * does not add new dependencies, because trylock can be done
3861d61fc96aSBoqun Feng 	 * in any order.
3862d61fc96aSBoqun Feng 	 *
3863d61fc96aSBoqun Feng 	 * We look up the chain_key and do the O(N^2) check and update of
3864d61fc96aSBoqun Feng 	 * the dependencies only if this is a new dependency chain.
3865d61fc96aSBoqun Feng 	 * (If lookup_chain_cache_add() return with 1 it acquires
38668eddac3fSPeter Zijlstra 	 * graph_lock for us)
3867545c23f2SByungchul Park 	 */
38688eddac3fSPeter Zijlstra 	if (!hlock->trylock && hlock->check &&
38698eddac3fSPeter Zijlstra 	    lookup_chain_cache_add(curr, hlock, chain_key)) {
3870545c23f2SByungchul Park 		/*
3871545c23f2SByungchul Park 		 * Check whether last held lock:
38728eddac3fSPeter Zijlstra 		 *
3873545c23f2SByungchul Park 		 * - is irq-safe, if this lock is irq-unsafe
3874545c23f2SByungchul Park 		 * - is softirq-safe, if this lock is hardirq-unsafe
38758eddac3fSPeter Zijlstra 		 *
38768eddac3fSPeter Zijlstra 		 * And check whether the new lock's dependency graph
3877545c23f2SByungchul Park 		 * could lead back to the previous lock:
38788eddac3fSPeter Zijlstra 		 *
38798eddac3fSPeter Zijlstra 		 * - within the current held-lock stack
38808eddac3fSPeter Zijlstra 		 * - across our accumulated lock dependency records
38818eddac3fSPeter Zijlstra 		 *
38828eddac3fSPeter Zijlstra 		 * any of these scenarios could lead to a deadlock.
38830b9fc8ecSYuyang Du 		 */
38848eddac3fSPeter Zijlstra 		/*
38858eddac3fSPeter Zijlstra 		 * The simple case: does the current hold the same lock
38868eddac3fSPeter Zijlstra 		 * already?
38878eddac3fSPeter Zijlstra 		 */
3888810507feSWaiman Long 		int ret = check_deadlock(curr, hlock);
3889810507feSWaiman Long 
3890e7a38f63SYuyang Du 		if (!ret)
38918eddac3fSPeter Zijlstra 			return 0;
38928eddac3fSPeter Zijlstra 		/*
38938eddac3fSPeter Zijlstra 		 * Add dependency only if this lock is not the head
38948eddac3fSPeter Zijlstra 		 * of the chain, and if the new lock introduces no more
38958eddac3fSPeter Zijlstra 		 * lock dependency (because we already hold a lock with the
38968eddac3fSPeter Zijlstra 		 * same lock class) nor deadlock (because the nest_lock
38978eddac3fSPeter Zijlstra 		 * serializes nesting locks), see the comments for
38988eddac3fSPeter Zijlstra 		 * check_deadlock().
38998eddac3fSPeter Zijlstra 		 */
39005f18ab5cSAlfredo Alvarez Fernandez 		if (!chain_head && ret != 2) {
3901f6ec8829SYuyang Du 			if (!check_prevs_add(curr, hlock))
39028eddac3fSPeter Zijlstra 				return 0;
39038eddac3fSPeter Zijlstra 		}
39048eddac3fSPeter Zijlstra 
39058eddac3fSPeter Zijlstra 		graph_unlock();
39068eddac3fSPeter Zijlstra 	} else {
39078eddac3fSPeter Zijlstra 		/* after lookup_chain_cache_add(): */
39088eddac3fSPeter Zijlstra 		if (unlikely(!debug_locks))
39098eddac3fSPeter Zijlstra 			return 0;
39108eddac3fSPeter Zijlstra 	}
39118eddac3fSPeter Zijlstra 
39128eddac3fSPeter Zijlstra 	return 1;
39138eddac3fSPeter Zijlstra }
39148eddac3fSPeter Zijlstra #else
validate_chain(struct task_struct * curr,struct held_lock * hlock,int chain_head,u64 chain_key)39158eddac3fSPeter Zijlstra static inline int validate_chain(struct task_struct *curr,
39168eddac3fSPeter Zijlstra 				 struct held_lock *hlock,
391701bb6f0aSYuyang Du 				 int chain_head, u64 chain_key)
39188eddac3fSPeter Zijlstra {
391901bb6f0aSYuyang Du 	return 1;
392001bb6f0aSYuyang Du }
39218eddac3fSPeter Zijlstra 
init_chain_block_buckets(void)392201bb6f0aSYuyang Du static void init_chain_block_buckets(void)	{ }
39238eddac3fSPeter Zijlstra #endif /* CONFIG_PROVE_LOCKING */
39248eddac3fSPeter Zijlstra 
39258eddac3fSPeter Zijlstra /*
39268eddac3fSPeter Zijlstra  * We are building curr_chain_key incrementally, so double-check
3927f6ec8829SYuyang Du  * it from scratch, to make sure that it's done correctly:
3928f611e8cfSBoqun Feng  */
check_chain_key(struct task_struct * curr)39298eddac3fSPeter Zijlstra static void check_chain_key(struct task_struct *curr)
39308eddac3fSPeter Zijlstra {
39318eddac3fSPeter Zijlstra #ifdef CONFIG_DEBUG_LOCKDEP
39328eddac3fSPeter Zijlstra 	struct held_lock *hlock, *prev_hlock = NULL;
39338eddac3fSPeter Zijlstra 	unsigned int i;
39348eddac3fSPeter Zijlstra 	u64 chain_key = INITIAL_CHAIN_KEY;
39358eddac3fSPeter Zijlstra 
39368eddac3fSPeter Zijlstra 	for (i = 0; i < curr->lockdep_depth; i++) {
39378eddac3fSPeter Zijlstra 		hlock = curr->held_locks + i;
39388eddac3fSPeter Zijlstra 		if (chain_key != hlock->prev_chain_key) {
39398eddac3fSPeter Zijlstra 			debug_locks_off();
39408eddac3fSPeter Zijlstra 			/*
39418eddac3fSPeter Zijlstra 			 * We got mighty confused, our chain keys don't match
39428eddac3fSPeter Zijlstra 			 * with what we expect, someone trample on our task state?
39438eddac3fSPeter Zijlstra 			 */
39448eddac3fSPeter Zijlstra 			WARN(1, "hm#1, depth: %u [%u], %016Lx != %016Lx\n",
394530a35f79SArnd Bergmann 				curr->lockdep_depth, i,
39460d2cc3b3SFrederic Weisbecker 				(unsigned long long)chain_key,
39470d2cc3b3SFrederic Weisbecker 				(unsigned long long)hlock->prev_chain_key);
39480d2cc3b3SFrederic Weisbecker 			return;
3949f7c1c6b3SYuyang Du 		}
39508eddac3fSPeter Zijlstra 
39518eddac3fSPeter Zijlstra 		/*
39528eddac3fSPeter Zijlstra 		 * hlock->class_idx can't go beyond MAX_LOCKDEP_KEYS, but is
39538eddac3fSPeter Zijlstra 		 * it registered lock class index?
39548eddac3fSPeter Zijlstra 		 */
39558eddac3fSPeter Zijlstra 		if (DEBUG_LOCKS_WARN_ON(!test_bit(hlock->class_idx, lock_classes_in_use)))
39568eddac3fSPeter Zijlstra 			return;
3957eb1cfd09SKent Overstreet 
3958f943fe0fSDmitry Vyukov 		if (prev_hlock && (prev_hlock->irq_context !=
39598eddac3fSPeter Zijlstra 							hlock->irq_context))
39608eddac3fSPeter Zijlstra 			chain_key = INITIAL_CHAIN_KEY;
3961eb1cfd09SKent Overstreet 		chain_key = iterate_chain_key(chain_key, hlock_id(hlock));
3962f943fe0fSDmitry Vyukov 		prev_hlock = hlock;
39638eddac3fSPeter Zijlstra 	}
39648eddac3fSPeter Zijlstra 	if (chain_key != curr->curr_chain_key) {
39658eddac3fSPeter Zijlstra 		debug_locks_off();
3966f7c1c6b3SYuyang Du 		/*
39678eddac3fSPeter Zijlstra 		 * More smoking hash instead of calculating it, damn see these
39688eddac3fSPeter Zijlstra 		 * numbers float.. I bet that a pink elephant stepped on my memory.
39698eddac3fSPeter Zijlstra 		 */
39707f82e631SPeter Zijlstra 		WARN(1, "hm#2, depth: %u [%u], %016Lx != %016Lx\n",
3971f7c1c6b3SYuyang Du 			curr->lockdep_depth, i,
39728eddac3fSPeter Zijlstra 			(unsigned long long)chain_key,
3973681fbec8SPaul E. McKenney 			(unsigned long long)curr->curr_chain_key);
3974a5dd63efSPaul E. McKenney 	}
3975a5dd63efSPaul E. McKenney #endif
39768eddac3fSPeter Zijlstra }
3977a5dd63efSPaul E. McKenney 
39788eddac3fSPeter Zijlstra #ifdef CONFIG_PROVE_LOCKING
3979681fbec8SPaul E. McKenney static int mark_lock(struct task_struct *curr, struct held_lock *this,
39808eddac3fSPeter Zijlstra 		     enum lock_usage_bit new_bit);
39818eddac3fSPeter Zijlstra 
print_usage_bug_scenario(struct held_lock * lock)3982681fbec8SPaul E. McKenney static void print_usage_bug_scenario(struct held_lock *lock)
39838eddac3fSPeter Zijlstra {
3984f9ad4a5fSPeter Zijlstra 	struct lock_class *class = hlock_class(lock);
3985ef996916SPeter Zijlstra 
3986f9ad4a5fSPeter Zijlstra 	printk(" Possible unsafe locking scenario:\n\n");
3987ef996916SPeter Zijlstra 	printk("       CPU0\n");
39888eddac3fSPeter Zijlstra 	printk("       ----\n");
39898eddac3fSPeter Zijlstra 	printk("  lock(");
3990681fbec8SPaul E. McKenney 	__print_lock_name(lock, class);
399112593b74SBart Van Assche 	printk(KERN_CONT ");\n");
39928eddac3fSPeter Zijlstra 	printk("  <Interrupt>\n");
39938eddac3fSPeter Zijlstra 	printk("    lock(");
3994681fbec8SPaul E. McKenney 	__print_lock_name(lock, class);
39958eddac3fSPeter Zijlstra 	printk(KERN_CONT ");\n");
39968eddac3fSPeter Zijlstra 	printk("\n *** DEADLOCK ***\n\n");
39978eddac3fSPeter Zijlstra }
39988eddac3fSPeter Zijlstra 
3999681fbec8SPaul E. McKenney static void
print_usage_bug(struct task_struct * curr,struct held_lock * this,enum lock_usage_bit prev_bit,enum lock_usage_bit new_bit)40008eddac3fSPeter Zijlstra print_usage_bug(struct task_struct *curr, struct held_lock *this,
40018eddac3fSPeter Zijlstra 		enum lock_usage_bit prev_bit, enum lock_usage_bit new_bit)
40028eddac3fSPeter Zijlstra {
40038eddac3fSPeter Zijlstra 	if (!debug_locks_off() || debug_locks_silent)
40048eddac3fSPeter Zijlstra 		return;
40058eddac3fSPeter Zijlstra 
40068eddac3fSPeter Zijlstra 	nbcon_cpu_emergency_enter();
40078eddac3fSPeter Zijlstra 
40088eddac3fSPeter Zijlstra 	pr_warn("\n");
40098eddac3fSPeter Zijlstra 	pr_warn("================================\n");
4010f7c1c6b3SYuyang Du 	pr_warn("WARNING: inconsistent lock state\n");
40117f82e631SPeter Zijlstra 	print_kernel_ident();
4012f7c1c6b3SYuyang Du 	pr_warn("--------------------------------\n");
4013f7c1c6b3SYuyang Du 
4014f7c1c6b3SYuyang Du 	pr_warn("inconsistent {%s} -> {%s} usage.\n",
40158eddac3fSPeter Zijlstra 		usage_str[prev_bit], usage_str[new_bit]);
40168eddac3fSPeter Zijlstra 
40178eddac3fSPeter Zijlstra 	pr_warn("%s/%d [HC%u[%lu]:SC%u[%lu]:HE%u:SE%u] takes:\n",
40188eddac3fSPeter Zijlstra 		curr->comm, task_pid_nr(curr),
40198eddac3fSPeter Zijlstra 		lockdep_hardirq_context(), hardirq_count() >> HARDIRQ_SHIFT,
40208eddac3fSPeter Zijlstra 		lockdep_softirq_context(curr), softirq_count() >> SOFTIRQ_SHIFT,
40218eddac3fSPeter Zijlstra 		lockdep_hardirqs_enabled(),
4022f7c1c6b3SYuyang Du 		lockdep_softirqs_enabled(curr));
40238eddac3fSPeter Zijlstra 	print_lock(this);
40248eddac3fSPeter Zijlstra 
40258eddac3fSPeter Zijlstra 	pr_warn("{%s} state was registered at:\n", usage_str[prev_bit]);
40268eddac3fSPeter Zijlstra 	print_lock_trace(hlock_class(this)->usage_traces[prev_bit], 1);
40278eddac3fSPeter Zijlstra 
40288eddac3fSPeter Zijlstra 	print_irqtrace_events(curr);
40298eddac3fSPeter Zijlstra 	pr_warn("\nother info that might help us debug this:\n");
40308eddac3fSPeter Zijlstra 	print_usage_bug_scenario(this);
40318eddac3fSPeter Zijlstra 
40328eddac3fSPeter Zijlstra 	lockdep_print_held_locks(curr);
4033f7c1c6b3SYuyang Du 
40348eddac3fSPeter Zijlstra 	pr_warn("\nstack backtrace:\n");
4035681fbec8SPaul E. McKenney 	dump_stack();
4036a5dd63efSPaul E. McKenney 
4037a5dd63efSPaul E. McKenney 	nbcon_cpu_emergency_exit();
40388eddac3fSPeter Zijlstra }
4039a5dd63efSPaul E. McKenney 
4040681fbec8SPaul E. McKenney /*
40418eddac3fSPeter Zijlstra  * Print out an error if an invalid bit is set:
40428eddac3fSPeter Zijlstra  */
40438eddac3fSPeter Zijlstra static inline int
valid_state(struct task_struct * curr,struct held_lock * this,enum lock_usage_bit new_bit,enum lock_usage_bit bad_bit)4044681fbec8SPaul E. McKenney valid_state(struct task_struct *curr, struct held_lock *this,
40458eddac3fSPeter Zijlstra 	    enum lock_usage_bit new_bit, enum lock_usage_bit bad_bit)
4046681fbec8SPaul E. McKenney {
4047eb1cfd09SKent Overstreet 	if (unlikely(hlock_class(this)->usage_mask & (1 << bad_bit))) {
4048681fbec8SPaul E. McKenney 		graph_unlock();
40498eddac3fSPeter Zijlstra 		print_usage_bug(curr, this, bad_bit, new_bit);
4050681fbec8SPaul E. McKenney 		return 0;
40518eddac3fSPeter Zijlstra 	}
40528eddac3fSPeter Zijlstra 	return 1;
40538eddac3fSPeter Zijlstra }
40548eddac3fSPeter Zijlstra 
40558eddac3fSPeter Zijlstra 
4056681fbec8SPaul E. McKenney /*
40578eddac3fSPeter Zijlstra  * print irq inversion bug:
40588eddac3fSPeter Zijlstra  */
40598eddac3fSPeter Zijlstra static void
print_irq_inversion_bug(struct task_struct * curr,struct lock_list * root,struct lock_list * other,struct held_lock * this,int forwards,const char * irqclass)40608eddac3fSPeter Zijlstra print_irq_inversion_bug(struct task_struct *curr,
40618eddac3fSPeter Zijlstra 			struct lock_list *root, struct lock_list *other,
40628eddac3fSPeter Zijlstra 			struct held_lock *this, int forwards,
40638eddac3fSPeter Zijlstra 			const char *irqclass)
40648eddac3fSPeter Zijlstra {
40658eddac3fSPeter Zijlstra 	struct lock_list *entry = other;
40668eddac3fSPeter Zijlstra 	struct lock_list *middle = NULL;
40678eddac3fSPeter Zijlstra 	int depth;
40688eddac3fSPeter Zijlstra 
40698eddac3fSPeter Zijlstra 	if (!debug_locks_off_graph_unlock() || debug_locks_silent)
40708eddac3fSPeter Zijlstra 		return;
40718eddac3fSPeter Zijlstra 
4072681fbec8SPaul E. McKenney 	nbcon_cpu_emergency_enter();
407312593b74SBart Van Assche 
407412593b74SBart Van Assche 	pr_warn("\n");
4075f7c1c6b3SYuyang Du 	pr_warn("========================================================\n");
40768eddac3fSPeter Zijlstra 	pr_warn("WARNING: possible irq lock inversion dependency detected\n");
40778eddac3fSPeter Zijlstra 	print_kernel_ident();
4078681fbec8SPaul E. McKenney 	pr_warn("--------------------------------------------------------\n");
40798eddac3fSPeter Zijlstra 	pr_warn("%s/%d just changed the state of lock:\n",
40808eddac3fSPeter Zijlstra 		curr->comm, task_pid_nr(curr));
40818eddac3fSPeter Zijlstra 	print_lock(this);
40828eddac3fSPeter Zijlstra 	if (forwards)
40838eddac3fSPeter Zijlstra 		pr_warn("but this lock took another, %s-unsafe lock in the past:\n", irqclass);
40848eddac3fSPeter Zijlstra 	else
40858eddac3fSPeter Zijlstra 		pr_warn("but this lock was taken by another, %s-safe lock in the past:\n", irqclass);
40868eddac3fSPeter Zijlstra 	print_lock_name(NULL, other->class);
40878eddac3fSPeter Zijlstra 	pr_warn("\n\nand interrupts could create inverse lock ordering between them.\n\n");
4088f08e3888SBoqun Feng 
40898eddac3fSPeter Zijlstra 	pr_warn("\nother info that might help us debug this:\n");
4090b11be024SBoqun Feng 
40918eddac3fSPeter Zijlstra 	/* Find a middle lock (if one exists) */
40923f649ab7SKees Cook 	depth = get_lock_depth(other);
4093f08e3888SBoqun Feng 	do {
4094f08e3888SBoqun Feng 		if (depth == 0 && (entry != root)) {
40958eddac3fSPeter Zijlstra 			pr_warn("lockdep:%s bad path found in chain graph\n", __func__);
40966971c0f3SBoqun Feng 			break;
4097f08e3888SBoqun Feng 		}
4098b11be024SBoqun Feng 		middle = entry;
4099f7c1c6b3SYuyang Du 		entry = get_lock_parent(entry);
4100f7c1c6b3SYuyang Du 		depth--;
4101f7c1c6b3SYuyang Du 	} while (entry && entry != root && (depth >= 0));
4102b11be024SBoqun Feng 	if (forwards)
4103b11be024SBoqun Feng 		print_irq_lock_scenario(root, other,
41048eddac3fSPeter Zijlstra 			middle ? middle->class : root->class, other->class);
4105f08e3888SBoqun Feng 	else
4106f08e3888SBoqun Feng 		print_irq_lock_scenario(other, root,
4107f7c1c6b3SYuyang Du 			middle ? middle->class : other->class, root->class);
4108f08e3888SBoqun Feng 
4109f08e3888SBoqun Feng 	lockdep_print_held_locks(curr);
4110f08e3888SBoqun Feng 
4111f08e3888SBoqun Feng 	pr_warn("\nthe shortest dependencies between 2nd lock and 1st lock:\n");
4112f08e3888SBoqun Feng 	root->trace = save_trace();
4113f08e3888SBoqun Feng 	if (!root->trace)
4114f7c1c6b3SYuyang Du 		goto out;
41158eddac3fSPeter Zijlstra 	print_shortest_lock_dependencies(other, root);
41168eddac3fSPeter Zijlstra 
41178eddac3fSPeter Zijlstra 	pr_warn("\nstack backtrace:\n");
41188eddac3fSPeter Zijlstra 	dump_stack();
41198eddac3fSPeter Zijlstra out:
41208eddac3fSPeter Zijlstra 	nbcon_cpu_emergency_exit();
41218eddac3fSPeter Zijlstra }
41228eddac3fSPeter Zijlstra 
4123f08e3888SBoqun Feng /*
41248eddac3fSPeter Zijlstra  * Prove that in the forwards-direction subgraph starting at <this>
4125b11be024SBoqun Feng  * there is no lock matching <mask>:
41268eddac3fSPeter Zijlstra  */
41273f649ab7SKees Cook static int
check_usage_forwards(struct task_struct * curr,struct held_lock * this,enum lock_usage_bit bit)4128f08e3888SBoqun Feng check_usage_forwards(struct task_struct *curr, struct held_lock *this,
4129f08e3888SBoqun Feng 		     enum lock_usage_bit bit)
41308eddac3fSPeter Zijlstra {
41316971c0f3SBoqun Feng 	enum bfs_result ret;
4132f08e3888SBoqun Feng 	struct lock_list root;
4133b11be024SBoqun Feng 	struct lock_list *target_entry;
4134f7c1c6b3SYuyang Du 	enum lock_usage_bit read_bit = bit + LOCK_USAGE_READ_MASK;
4135f7c1c6b3SYuyang Du 	unsigned usage_mask = lock_flag(bit) | lock_flag(read_bit);
4136f7c1c6b3SYuyang Du 
4137b11be024SBoqun Feng 	bfs_init_root(&root, this);
4138b11be024SBoqun Feng 	ret = find_usage_forwards(&root, usage_mask, &target_entry);
41398eddac3fSPeter Zijlstra 	if (bfs_error(ret)) {
4140f08e3888SBoqun Feng 		print_bfs_bug(ret);
4141f08e3888SBoqun Feng 		return 0;
4142f7c1c6b3SYuyang Du 	}
4143f08e3888SBoqun Feng 	if (ret == BFS_RNOMATCH)
4144f08e3888SBoqun Feng 		return 1;
4145f08e3888SBoqun Feng 
4146f08e3888SBoqun Feng 	/* Check whether write or read usage is the match */
4147f08e3888SBoqun Feng 	if (target_entry->class->usage_mask & lock_flag(bit)) {
4148f08e3888SBoqun Feng 		print_irq_inversion_bug(curr, &root, target_entry,
4149f7c1c6b3SYuyang Du 					this, 1, state_name(bit));
41508eddac3fSPeter Zijlstra 	} else {
41518eddac3fSPeter Zijlstra 		print_irq_inversion_bug(curr, &root, target_entry,
41528eddac3fSPeter Zijlstra 					this, 1, state_name(read_bit));
41538eddac3fSPeter Zijlstra 	}
41540584df9cSMarco Elver 
41550584df9cSMarco Elver 	return 0;
41560584df9cSMarco Elver }
415704860d48SBorislav Petkov 
41580584df9cSMarco Elver /*
41590584df9cSMarco Elver  * Prove that in the backwards-direction subgraph starting at <this>
416004860d48SBorislav Petkov  * there is no lock matching <mask>:
41610584df9cSMarco Elver  */
41620584df9cSMarco Elver static int
check_usage_backwards(struct task_struct * curr,struct held_lock * this,enum lock_usage_bit bit)416304860d48SBorislav Petkov check_usage_backwards(struct task_struct *curr, struct held_lock *this,
41640584df9cSMarco Elver 		      enum lock_usage_bit bit)
41650584df9cSMarco Elver {
416604860d48SBorislav Petkov 	enum bfs_result ret;
41670584df9cSMarco Elver 	struct lock_list root;
41680584df9cSMarco Elver 	struct lock_list *target_entry;
41698eddac3fSPeter Zijlstra 	enum lock_usage_bit read_bit = bit + LOCK_USAGE_READ_MASK;
41708eddac3fSPeter Zijlstra 	unsigned usage_mask = lock_flag(bit) | lock_flag(read_bit);
41718eddac3fSPeter Zijlstra 
41728eddac3fSPeter Zijlstra 	bfs_init_rootb(&root, this);
41738eddac3fSPeter Zijlstra 	ret = find_usage_backwards(&root, usage_mask, &target_entry);
41748eddac3fSPeter Zijlstra 	if (bfs_error(ret)) {
41758eddac3fSPeter Zijlstra 		print_bfs_bug(ret);
41768eddac3fSPeter Zijlstra 		return 0;
41778eddac3fSPeter Zijlstra 	}
41788eddac3fSPeter Zijlstra 	if (ret == BFS_RNOMATCH)
41798eddac3fSPeter Zijlstra 		return 1;
41808eddac3fSPeter Zijlstra 
41818eddac3fSPeter Zijlstra 	/* Check whether write or read usage is the match */
41828eddac3fSPeter Zijlstra 	if (target_entry->class->usage_mask & lock_flag(bit)) {
41838eddac3fSPeter Zijlstra 		print_irq_inversion_bug(curr, &root, target_entry,
41848eddac3fSPeter Zijlstra 					this, 0, state_name(bit));
41858eddac3fSPeter Zijlstra 	} else {
41868eddac3fSPeter Zijlstra 		print_irq_inversion_bug(curr, &root, target_entry,
41878eddac3fSPeter Zijlstra 					this, 0, state_name(read_bit));
41888eddac3fSPeter Zijlstra 	}
41898eddac3fSPeter Zijlstra 
41908eddac3fSPeter Zijlstra 	return 0;
41918eddac3fSPeter Zijlstra }
41928eddac3fSPeter Zijlstra 
print_irqtrace_events(struct task_struct * curr)41938eddac3fSPeter Zijlstra void print_irqtrace_events(struct task_struct *curr)
41948eddac3fSPeter Zijlstra {
41958eddac3fSPeter Zijlstra 	const struct irqtrace_events *trace = &curr->irqtrace;
41968eddac3fSPeter Zijlstra 
4197c902a1e8SFrederic Weisbecker 	nbcon_cpu_emergency_enter();
41988eddac3fSPeter Zijlstra 
41998eddac3fSPeter Zijlstra 	printk("irq event stamp: %u\n", trace->irq_events);
42008eddac3fSPeter Zijlstra 	printk("hardirqs last  enabled at (%u): [<%px>] %pS\n",
42018eddac3fSPeter Zijlstra 		trace->hardirq_enable_event, (void *)trace->hardirq_enable_ip,
42028eddac3fSPeter Zijlstra 		(void *)trace->hardirq_enable_ip);
42038eddac3fSPeter Zijlstra 	printk("hardirqs last disabled at (%u): [<%px>] %pS\n",
42048eddac3fSPeter Zijlstra 		trace->hardirq_disable_event, (void *)trace->hardirq_disable_ip,
42058eddac3fSPeter Zijlstra 		(void *)trace->hardirq_disable_ip);
42068eddac3fSPeter Zijlstra 	printk("softirqs last  enabled at (%u): [<%px>] %pS\n",
42078eddac3fSPeter Zijlstra 		trace->softirq_enable_event, (void *)trace->softirq_enable_ip,
4208bba2a8f1SFrederic Weisbecker 		(void *)trace->softirq_enable_ip);
4209bba2a8f1SFrederic Weisbecker 	printk("softirqs last disabled at (%u): [<%px>] %pS\n",
42108eddac3fSPeter Zijlstra 		trace->softirq_disable_event, (void *)trace->softirq_disable_ip,
42118eddac3fSPeter Zijlstra 		(void *)trace->softirq_disable_ip);
42128eddac3fSPeter Zijlstra 
42138eddac3fSPeter Zijlstra 	nbcon_cpu_emergency_exit();
42148eddac3fSPeter Zijlstra }
42158eddac3fSPeter Zijlstra 
HARDIRQ_verbose(struct lock_class * class)42168eddac3fSPeter Zijlstra static int HARDIRQ_verbose(struct lock_class *class)
42178eddac3fSPeter Zijlstra {
42188eddac3fSPeter Zijlstra #if HARDIRQ_VERBOSE
4219f08e3888SBoqun Feng 	return class_filter(class);
4220f08e3888SBoqun Feng #endif
4221f08e3888SBoqun Feng 	return 0;
4222f08e3888SBoqun Feng }
4223f08e3888SBoqun Feng 
SOFTIRQ_verbose(struct lock_class * class)4224f08e3888SBoqun Feng static int SOFTIRQ_verbose(struct lock_class *class)
4225f08e3888SBoqun Feng {
4226f08e3888SBoqun Feng #if SOFTIRQ_VERBOSE
42278eddac3fSPeter Zijlstra 	return class_filter(class);
42288eddac3fSPeter Zijlstra #endif
42298eddac3fSPeter Zijlstra 	return 0;
4230f08e3888SBoqun Feng }
42318eddac3fSPeter Zijlstra 
4232f08e3888SBoqun Feng static int (*state_verbose_f[])(struct lock_class *class) = {
4233f08e3888SBoqun Feng #define LOCKDEP_STATE(__STATE) \
42348eddac3fSPeter Zijlstra 	__STATE##_verbose,
4235f08e3888SBoqun Feng #include "lockdep_states.h"
42368eddac3fSPeter Zijlstra #undef LOCKDEP_STATE
4237f08e3888SBoqun Feng };
4238f08e3888SBoqun Feng 
state_verbose(enum lock_usage_bit bit,struct lock_class * class)4239f08e3888SBoqun Feng static inline int state_verbose(enum lock_usage_bit bit,
4240f08e3888SBoqun Feng 				struct lock_class *class)
4241f08e3888SBoqun Feng {
4242f08e3888SBoqun Feng 	return state_verbose_f[bit >> LOCK_USAGE_DIR_MASK](class);
42438eddac3fSPeter Zijlstra }
42448eddac3fSPeter Zijlstra 
42458eddac3fSPeter Zijlstra typedef int (*check_usage_f)(struct task_struct *, struct held_lock *,
42468eddac3fSPeter Zijlstra 			     enum lock_usage_bit bit, const char *name);
42478eddac3fSPeter Zijlstra 
42488eddac3fSPeter Zijlstra static int
mark_lock_irq(struct task_struct * curr,struct held_lock * this,enum lock_usage_bit new_bit)42498eddac3fSPeter Zijlstra mark_lock_irq(struct task_struct *curr, struct held_lock *this,
42508eddac3fSPeter Zijlstra 		enum lock_usage_bit new_bit)
42518eddac3fSPeter Zijlstra {
42528eddac3fSPeter Zijlstra 	int excl_bit = exclusive_bit(new_bit);
42538eddac3fSPeter Zijlstra 	int read = new_bit & LOCK_USAGE_READ_MASK;
42548eddac3fSPeter Zijlstra 	int dir = new_bit & LOCK_USAGE_DIR_MASK;
42558eddac3fSPeter Zijlstra 
4256436a49aeSFrederic Weisbecker 	/*
42578eddac3fSPeter Zijlstra 	 * Validate that this particular lock does not have conflicting
42588eddac3fSPeter Zijlstra 	 * usage states.
42598eddac3fSPeter Zijlstra 	 */
42608eddac3fSPeter Zijlstra 	if (!valid_state(curr, this, new_bit, excl_bit))
42618eddac3fSPeter Zijlstra 		return 0;
4262436a49aeSFrederic Weisbecker 
42638eddac3fSPeter Zijlstra 	/*
42648eddac3fSPeter Zijlstra 	 * Check for read in write conflicts
42658eddac3fSPeter Zijlstra 	 */
4266bba2a8f1SFrederic Weisbecker 	if (!read && !valid_state(curr, this, new_bit,
42678eddac3fSPeter Zijlstra 				  excl_bit + LOCK_USAGE_READ_MASK))
4268436a49aeSFrederic Weisbecker 		return 0;
42698eddac3fSPeter Zijlstra 
427034d0ed5eSOleg Nesterov 
42718eddac3fSPeter Zijlstra 	/*
42728eddac3fSPeter Zijlstra 	 * Validate that the lock dependencies don't have conflicting usage
4273436a49aeSFrederic Weisbecker 	 * states.
42748eddac3fSPeter Zijlstra 	 */
42758eddac3fSPeter Zijlstra 	if (dir) {
42768eddac3fSPeter Zijlstra 		/*
42778eddac3fSPeter Zijlstra 		 * mark ENABLED has to look backwards -- to ensure no dependee
42788eddac3fSPeter Zijlstra 		 * has USED_IN state, which, again, would allow  recursion deadlocks.
42798eddac3fSPeter Zijlstra 		 */
42808eddac3fSPeter Zijlstra 		if (!check_usage_backwards(curr, this, excl_bit))
42818eddac3fSPeter Zijlstra 			return 0;
42828eddac3fSPeter Zijlstra 	} else {
4283c86e9b98SPeter Zijlstra 		/*
42848eddac3fSPeter Zijlstra 		 * mark USED_IN has to look forwards -- to ensure no dependency
42858eddac3fSPeter Zijlstra 		 * has ENABLED state, which would allow recursion deadlocks.
42868eddac3fSPeter Zijlstra 		 */
42878eddac3fSPeter Zijlstra 		if (!check_usage_forwards(curr, this, excl_bit))
42888eddac3fSPeter Zijlstra 			return 0;
42898eddac3fSPeter Zijlstra 	}
42908eddac3fSPeter Zijlstra 
4291436a49aeSFrederic Weisbecker 	if (state_verbose(new_bit, hlock_class(this)))
42928eddac3fSPeter Zijlstra 		return 2;
42938eddac3fSPeter Zijlstra 
42948eddac3fSPeter Zijlstra 	return 1;
42958eddac3fSPeter Zijlstra }
42968eddac3fSPeter Zijlstra 
42978eddac3fSPeter Zijlstra /*
42988eddac3fSPeter Zijlstra  * Mark all held locks with a usage bit:
4299c86e9b98SPeter Zijlstra  */
43008eddac3fSPeter Zijlstra static int
mark_held_locks(struct task_struct * curr,enum lock_usage_bit base_bit)43018eddac3fSPeter Zijlstra mark_held_locks(struct task_struct *curr, enum lock_usage_bit base_bit)
4302c86e9b98SPeter Zijlstra {
4303c86e9b98SPeter Zijlstra 	struct held_lock *hlock;
4304c86e9b98SPeter Zijlstra 	int i;
4305c86e9b98SPeter Zijlstra 
4306c86e9b98SPeter Zijlstra 	for (i = 0; i < curr->lockdep_depth; i++) {
4307c86e9b98SPeter Zijlstra 		enum lock_usage_bit hlock_bit = base_bit;
4308c86e9b98SPeter Zijlstra 		hlock = curr->held_locks + i;
4309c86e9b98SPeter Zijlstra 
43108b023accSNick Desaulniers 		if (hlock->read)
43118eddac3fSPeter Zijlstra 			hlock_bit += LOCK_USAGE_READ_MASK;
4312859d069eSPeter Zijlstra 
43138eddac3fSPeter Zijlstra 		BUG_ON(hlock_bit >= LOCK_USAGE_STATES);
43148eddac3fSPeter Zijlstra 
4315859d069eSPeter Zijlstra 		if (!hlock->check)
4316859d069eSPeter Zijlstra 			continue;
4317859d069eSPeter Zijlstra 
4318859d069eSPeter Zijlstra 		if (!mark_lock(curr, hlock, hlock_bit))
4319859d069eSPeter Zijlstra 			return 0;
4320859d069eSPeter Zijlstra 	}
4321f8e48a3dSPeter Zijlstra 
43228eddac3fSPeter Zijlstra 	return 1;
43238eddac3fSPeter Zijlstra }
4324f9ad4a5fSPeter Zijlstra 
43258eddac3fSPeter Zijlstra /*
43268eddac3fSPeter Zijlstra  * Hardirqs will be enabled:
43278eddac3fSPeter Zijlstra  */
__trace_hardirqs_on_caller(void)43288eddac3fSPeter Zijlstra static void __trace_hardirqs_on_caller(void)
43298eddac3fSPeter Zijlstra {
43308eddac3fSPeter Zijlstra 	struct task_struct *curr = current;
43318eddac3fSPeter Zijlstra 
43328eddac3fSPeter Zijlstra 	/*
43338eddac3fSPeter Zijlstra 	 * We are going to turn hardirqs on, so set the
43348eddac3fSPeter Zijlstra 	 * usage bit for all held locks:
43358eddac3fSPeter Zijlstra 	 */
43368eddac3fSPeter Zijlstra 	if (!mark_held_locks(curr, LOCK_ENABLED_HARDIRQ))
43378eddac3fSPeter Zijlstra 		return;
43388eddac3fSPeter Zijlstra 	/*
43398eddac3fSPeter Zijlstra 	 * If we have softirqs enabled, then set the usage
43408eddac3fSPeter Zijlstra 	 * bit for all held locks. (disabled hardirqs prevented
43418eddac3fSPeter Zijlstra 	 * this bit from being set before)
43428eddac3fSPeter Zijlstra 	 */
43438eddac3fSPeter Zijlstra 	if (curr->softirqs_enabled)
43448eddac3fSPeter Zijlstra 		mark_held_locks(curr, LOCK_ENABLED_SOFTIRQ);
4345d671002bSzhengbin }
43468eddac3fSPeter Zijlstra 
43478eddac3fSPeter Zijlstra /**
43488eddac3fSPeter Zijlstra  * lockdep_hardirqs_on_prepare - Prepare for enabling interrupts
43498eddac3fSPeter Zijlstra  *
43508eddac3fSPeter Zijlstra  * Invoked before a possible transition to RCU idle from exit to user or
43518eddac3fSPeter Zijlstra  * guest mode. This ensures that all RCU operations are done before RCU
4352f9ad4a5fSPeter Zijlstra  * stops watching. After the RCU transition lockdep_hardirqs_on() has to be
43538eddac3fSPeter Zijlstra  * invoked to set the final state.
43548eddac3fSPeter Zijlstra  */
lockdep_hardirqs_on_prepare(void)4355c86e9b98SPeter Zijlstra void lockdep_hardirqs_on_prepare(void)
4356c86e9b98SPeter Zijlstra {
43574d004099SPeter Zijlstra 	if (unlikely(!debug_locks))
4358c86e9b98SPeter Zijlstra 		return;
435910476e63SPeter Zijlstra 
43608eddac3fSPeter Zijlstra 	/*
4361c86e9b98SPeter Zijlstra 	 * NMIs do not (and cannot) track lock dependencies, nothing to do.
4362c86e9b98SPeter Zijlstra 	 */
4363c86e9b98SPeter Zijlstra 	if (unlikely(in_nmi()))
4364c86e9b98SPeter Zijlstra 		return;
43650584df9cSMarco Elver 
4366c86e9b98SPeter Zijlstra 	if (unlikely(this_cpu_read(lockdep_recursion)))
4367859d069eSPeter Zijlstra 		return;
4368c86e9b98SPeter Zijlstra 
4369c86e9b98SPeter Zijlstra 	if (unlikely(lockdep_hardirqs_enabled())) {
4370859d069eSPeter Zijlstra 		/*
4371859d069eSPeter Zijlstra 		 * Neither irq nor preemption are disabled here
4372859d069eSPeter Zijlstra 		 * so this is racy by nature but losing one hit
4373859d069eSPeter Zijlstra 		 * in a stat is not a big deal.
4374859d069eSPeter Zijlstra 		 */
4375859d069eSPeter Zijlstra 		__debug_atomic_inc(redundant_hardirqs_on);
4376859d069eSPeter Zijlstra 		return;
4377859d069eSPeter Zijlstra 	}
4378ed004953Speterz@infradead.org 
4379ed004953Speterz@infradead.org 	/*
4380ed004953Speterz@infradead.org 	 * We're enabling irqs and according to our state above irqs weren't
4381859d069eSPeter Zijlstra 	 * already enabled, yet we find the hardware thinks they are in fact
4382859d069eSPeter Zijlstra 	 * enabled.. someone messed up their IRQ state tracing.
4383859d069eSPeter Zijlstra 	 */
4384859d069eSPeter Zijlstra 	if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
4385859d069eSPeter Zijlstra 		return;
4386859d069eSPeter Zijlstra 
4387859d069eSPeter Zijlstra 	/*
4388859d069eSPeter Zijlstra 	 * See the fine text that goes along with this variable definition.
4389859d069eSPeter Zijlstra 	 */
4390f8e48a3dSPeter Zijlstra 	if (DEBUG_LOCKS_WARN_ON(early_boot_irqs_disabled))
4391c86e9b98SPeter Zijlstra 		return;
4392c86e9b98SPeter Zijlstra 
4393f9ad4a5fSPeter Zijlstra 	/*
4394c86e9b98SPeter Zijlstra 	 * Can't allow enabling interrupts while in an interrupt handler,
4395c86e9b98SPeter Zijlstra 	 * that's general bad form and such. Recursion, limited stack etc..
4396c86e9b98SPeter Zijlstra 	 */
4397c86e9b98SPeter Zijlstra 	if (DEBUG_LOCKS_WARN_ON(lockdep_hardirq_context()))
4398c86e9b98SPeter Zijlstra 		return;
4399c86e9b98SPeter Zijlstra 
4400c86e9b98SPeter Zijlstra 	current->hardirq_chain_key = current->curr_chain_key;
4401c86e9b98SPeter Zijlstra 
4402c86e9b98SPeter Zijlstra 	lockdep_recursion_inc();
4403c86e9b98SPeter Zijlstra 	__trace_hardirqs_on_caller();
4404c86e9b98SPeter Zijlstra 	lockdep_recursion_finish();
4405c86e9b98SPeter Zijlstra }
4406c86e9b98SPeter Zijlstra EXPORT_SYMBOL_GPL(lockdep_hardirqs_on_prepare);
4407c86e9b98SPeter Zijlstra 
lockdep_hardirqs_on(unsigned long ip)4408c86e9b98SPeter Zijlstra void noinstr lockdep_hardirqs_on(unsigned long ip)
4409c86e9b98SPeter Zijlstra {
4410c86e9b98SPeter Zijlstra 	struct irqtrace_events *trace = &current->irqtrace;
4411c86e9b98SPeter Zijlstra 
4412c86e9b98SPeter Zijlstra 	if (unlikely(!debug_locks))
4413c86e9b98SPeter Zijlstra 		return;
4414c86e9b98SPeter Zijlstra 
4415c86e9b98SPeter Zijlstra 	/*
4416c86e9b98SPeter Zijlstra 	 * NMIs can happen in the middle of local_irq_{en,dis}able() where the
4417c86e9b98SPeter Zijlstra 	 * tracking state and hardware state are out of sync.
4418859d069eSPeter Zijlstra 	 *
4419c86e9b98SPeter Zijlstra 	 * NMIs must save lockdep_hardirqs_enabled() to restore IRQ state from,
4420fddf9055SPeter Zijlstra 	 * and not rely on hardware state like normal interrupts.
44210584df9cSMarco Elver 	 */
44220584df9cSMarco Elver 	if (unlikely(in_nmi())) {
4423c86e9b98SPeter Zijlstra 		if (!IS_ENABLED(CONFIG_TRACE_IRQFLAGS_NMI))
4424c86e9b98SPeter Zijlstra 			return;
4425c86e9b98SPeter Zijlstra 
44268eddac3fSPeter Zijlstra 		/*
44278eddac3fSPeter Zijlstra 		 * Skip:
44288eddac3fSPeter Zijlstra 		 *  - recursion check, because NMI can hit lockdep;
44298eddac3fSPeter Zijlstra 		 *  - hardware state check, because above;
4430c86e9b98SPeter Zijlstra 		 *  - chain_key check, see lockdep_hardirqs_on_prepare().
44318eddac3fSPeter Zijlstra 		 */
4432859d069eSPeter Zijlstra 		goto skip_checks;
4433859d069eSPeter Zijlstra 	}
44348eddac3fSPeter Zijlstra 
4435859d069eSPeter Zijlstra 	if (unlikely(this_cpu_read(lockdep_recursion)))
4436859d069eSPeter Zijlstra 		return;
4437859d069eSPeter Zijlstra 
4438859d069eSPeter Zijlstra 	if (lockdep_hardirqs_enabled()) {
4439859d069eSPeter Zijlstra 		/*
4440ed004953Speterz@infradead.org 		 * Neither irq nor preemption are disabled here
4441ed004953Speterz@infradead.org 		 * so this is racy by nature but losing one hit
4442ed004953Speterz@infradead.org 		 * in a stat is not a big deal.
44434d004099SPeter Zijlstra 		 */
44448eddac3fSPeter Zijlstra 		__debug_atomic_inc(redundant_hardirqs_on);
44458eddac3fSPeter Zijlstra 		return;
44468eddac3fSPeter Zijlstra 	}
44478eddac3fSPeter Zijlstra 
44488eddac3fSPeter Zijlstra 	/*
44498eddac3fSPeter Zijlstra 	 * We're enabling irqs and according to our state above irqs weren't
44508eddac3fSPeter Zijlstra 	 * already enabled, yet we find the hardware thinks they are in fact
44518eddac3fSPeter Zijlstra 	 * enabled.. someone messed up their IRQ state tracing.
44528eddac3fSPeter Zijlstra 	 */
4453f9ad4a5fSPeter Zijlstra 	if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
44540584df9cSMarco Elver 		return;
44550584df9cSMarco Elver 
44568eddac3fSPeter Zijlstra 	/*
44578eddac3fSPeter Zijlstra 	 * Ensure the lock stack remained unchanged between
44588eddac3fSPeter Zijlstra 	 * lockdep_hardirqs_on_prepare() and lockdep_hardirqs_on().
4459fddf9055SPeter Zijlstra 	 */
44600584df9cSMarco Elver 	DEBUG_LOCKS_WARN_ON(current->hardirq_chain_key !=
44610584df9cSMarco Elver 			    current->curr_chain_key);
44628eddac3fSPeter Zijlstra 
4463c86e9b98SPeter Zijlstra skip_checks:
44648eddac3fSPeter Zijlstra 	/* we'll do an OFF -> ON transition: */
44658eddac3fSPeter Zijlstra 	__this_cpu_write(hardirqs_enabled, 1);
4466c86e9b98SPeter Zijlstra 	trace->hardirq_enable_ip = ip;
4467c86e9b98SPeter Zijlstra 	trace->hardirq_enable_event = ++trace->irq_events;
44688eddac3fSPeter Zijlstra 	debug_atomic_inc(hardirqs_on_events);
44698eddac3fSPeter Zijlstra }
44708eddac3fSPeter Zijlstra EXPORT_SYMBOL_GPL(lockdep_hardirqs_on);
44718eddac3fSPeter Zijlstra 
44720d38453cSPeter Zijlstra /*
44738eddac3fSPeter Zijlstra  * Hardirqs were disabled:
44740584df9cSMarco Elver  */
lockdep_hardirqs_off(unsigned long ip)44758eddac3fSPeter Zijlstra void noinstr lockdep_hardirqs_off(unsigned long ip)
44764d004099SPeter Zijlstra {
44778eddac3fSPeter Zijlstra 	if (unlikely(!debug_locks))
44788eddac3fSPeter Zijlstra 		return;
44798eddac3fSPeter Zijlstra 
44808eddac3fSPeter Zijlstra 	/*
44818eddac3fSPeter Zijlstra 	 * Matching lockdep_hardirqs_on(), allow NMIs in the middle of lockdep;
44828eddac3fSPeter Zijlstra 	 * they will restore the software state. This ensures the software
44838eddac3fSPeter Zijlstra 	 * state is consistent inside NMIs as well.
44848eddac3fSPeter Zijlstra 	 */
44858eddac3fSPeter Zijlstra 	if (in_nmi()) {
44860584df9cSMarco Elver 		if (!IS_ENABLED(CONFIG_TRACE_IRQFLAGS_NMI))
44878eddac3fSPeter Zijlstra 			return;
44888eddac3fSPeter Zijlstra 	} else if (__this_cpu_read(lockdep_recursion))
44898eddac3fSPeter Zijlstra 		return;
44908eddac3fSPeter Zijlstra 
44914d004099SPeter Zijlstra 	/*
44928eddac3fSPeter Zijlstra 	 * So we're supposed to get called after you mask local IRQs, but for
44938eddac3fSPeter Zijlstra 	 * some reason the hardware doesn't quite think you did a proper job.
44948eddac3fSPeter Zijlstra 	 */
44950584df9cSMarco Elver 	if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
44960584df9cSMarco Elver 		return;
44970584df9cSMarco Elver 
44988eddac3fSPeter Zijlstra 	if (lockdep_hardirqs_enabled()) {
44998eddac3fSPeter Zijlstra 		struct irqtrace_events *trace = &current->irqtrace;
45008eddac3fSPeter Zijlstra 
45018eddac3fSPeter Zijlstra 		/*
45028eddac3fSPeter Zijlstra 		 * We have done an ON -> OFF transition:
45038eddac3fSPeter Zijlstra 		 */
4504f9ad4a5fSPeter Zijlstra 		__this_cpu_write(hardirqs_enabled, 0);
45050584df9cSMarco Elver 		trace->hardirq_disable_ip = ip;
450610476e63SPeter Zijlstra 		trace->hardirq_disable_event = ++trace->irq_events;
45078eddac3fSPeter Zijlstra 		debug_atomic_inc(hardirqs_off_events);
45088eddac3fSPeter Zijlstra 	} else {
45098eddac3fSPeter Zijlstra 		debug_atomic_inc(redundant_hardirqs_off);
45108eddac3fSPeter Zijlstra 	}
45118eddac3fSPeter Zijlstra }
45120d38453cSPeter Zijlstra EXPORT_SYMBOL_GPL(lockdep_hardirqs_off);
45138eddac3fSPeter Zijlstra 
45144d004099SPeter Zijlstra /*
45158eddac3fSPeter Zijlstra  * Softirqs will be enabled:
45168eddac3fSPeter Zijlstra  */
lockdep_softirqs_on(unsigned long ip)45178eddac3fSPeter Zijlstra void lockdep_softirqs_on(unsigned long ip)
45188eddac3fSPeter Zijlstra {
45198eddac3fSPeter Zijlstra 	struct irqtrace_events *trace = &current->irqtrace;
45208eddac3fSPeter Zijlstra 
45218eddac3fSPeter Zijlstra 	if (unlikely(!lockdep_enabled()))
45228eddac3fSPeter Zijlstra 		return;
45230584df9cSMarco Elver 
45240584df9cSMarco Elver 	/*
45250584df9cSMarco Elver 	 * We fancy IRQs being disabled here, see softirq.c, avoids
45268eddac3fSPeter Zijlstra 	 * funny state and nesting things.
45278eddac3fSPeter Zijlstra 	 */
45288eddac3fSPeter Zijlstra 	if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
45290584df9cSMarco Elver 		return;
45300584df9cSMarco Elver 
45310584df9cSMarco Elver 	if (current->softirqs_enabled) {
45328eddac3fSPeter Zijlstra 		debug_atomic_inc(redundant_softirqs_on);
45338eddac3fSPeter Zijlstra 		return;
45348eddac3fSPeter Zijlstra 	}
45358eddac3fSPeter Zijlstra 
45368eddac3fSPeter Zijlstra 	lockdep_recursion_inc();
45378eddac3fSPeter Zijlstra 	/*
45388eddac3fSPeter Zijlstra 	 * We'll do an OFF -> ON transition:
45398eddac3fSPeter Zijlstra 	 */
45408eddac3fSPeter Zijlstra 	current->softirqs_enabled = 1;
454109180651SYuyang Du 	trace->softirq_enable_ip = ip;
454209180651SYuyang Du 	trace->softirq_enable_event = ++trace->irq_events;
45438eddac3fSPeter Zijlstra 	debug_atomic_inc(softirqs_on_events);
454409180651SYuyang Du 	/*
454509180651SYuyang Du 	 * We are going to turn softirqs on, so set the
454609180651SYuyang Du 	 * usage bit for all held locks, if hardirqs are
45478eddac3fSPeter Zijlstra 	 * enabled too:
45488eddac3fSPeter Zijlstra 	 */
45498eddac3fSPeter Zijlstra 	if (lockdep_hardirqs_enabled())
45508eddac3fSPeter Zijlstra 		mark_held_locks(current, LOCK_ENABLED_SOFTIRQ);
45518eddac3fSPeter Zijlstra 	lockdep_recursion_finish();
45528eddac3fSPeter Zijlstra }
4553f9ad4a5fSPeter Zijlstra 
45548eddac3fSPeter Zijlstra /*
45558eddac3fSPeter Zijlstra  * Softirqs were disabled:
45568eddac3fSPeter Zijlstra  */
lockdep_softirqs_off(unsigned long ip)45578eddac3fSPeter Zijlstra void lockdep_softirqs_off(unsigned long ip)
45588eddac3fSPeter Zijlstra {
45598eddac3fSPeter Zijlstra 	if (unlikely(!lockdep_enabled()))
45608eddac3fSPeter Zijlstra 		return;
45618eddac3fSPeter Zijlstra 
4562f9ad4a5fSPeter Zijlstra 	/*
45638eddac3fSPeter Zijlstra 	 * We fancy IRQs being disabled here, see softirq.c
45648eddac3fSPeter Zijlstra 	 */
45658eddac3fSPeter Zijlstra 	if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
45668eddac3fSPeter Zijlstra 		return;
45678eddac3fSPeter Zijlstra 
45688eddac3fSPeter Zijlstra 	if (current->softirqs_enabled) {
45698eddac3fSPeter Zijlstra 		struct irqtrace_events *trace = &current->irqtrace;
45700471db44SBoqun Feng 
45710471db44SBoqun Feng 		/*
45720471db44SBoqun Feng 		 * We have done an ON -> OFF transition:
45730471db44SBoqun Feng 		 */
45740471db44SBoqun Feng 		current->softirqs_enabled = 0;
45750471db44SBoqun Feng 		trace->softirq_disable_ip = ip;
45760471db44SBoqun Feng 		trace->softirq_disable_event = ++trace->irq_events;
45778eddac3fSPeter Zijlstra 		debug_atomic_inc(softirqs_off_events);
45788eddac3fSPeter Zijlstra 		/*
45798eddac3fSPeter Zijlstra 		 * Whoops, we wanted softirqs off, so why aren't they?
45808eddac3fSPeter Zijlstra 		 */
45818eddac3fSPeter Zijlstra 		DEBUG_LOCKS_WARN_ON(!softirq_count());
45828eddac3fSPeter Zijlstra 	} else
45838eddac3fSPeter Zijlstra 		debug_atomic_inc(redundant_softirqs_off);
45848eddac3fSPeter Zijlstra }
45858eddac3fSPeter Zijlstra 
45868eddac3fSPeter Zijlstra static int
mark_usage(struct task_struct * curr,struct held_lock * hlock,int check)45878eddac3fSPeter Zijlstra mark_usage(struct task_struct *curr, struct held_lock *hlock, int check)
45888eddac3fSPeter Zijlstra {
45898eddac3fSPeter Zijlstra 	if (!check)
45908eddac3fSPeter Zijlstra 		goto lock_used;
45918eddac3fSPeter Zijlstra 
45928eddac3fSPeter Zijlstra 	/*
45938eddac3fSPeter Zijlstra 	 * If non-trylock use in a hardirq or softirq context, then
45948eddac3fSPeter Zijlstra 	 * mark the lock as used in these contexts:
45958eddac3fSPeter Zijlstra 	 */
459609180651SYuyang Du 	if (!hlock->trylock) {
459709180651SYuyang Du 		if (hlock->read) {
459809180651SYuyang Du 			if (lockdep_hardirq_context())
459909180651SYuyang Du 				if (!mark_lock(curr, hlock,
460009180651SYuyang Du 						LOCK_USED_IN_HARDIRQ_READ))
46018eddac3fSPeter Zijlstra 					return 0;
46028eddac3fSPeter Zijlstra 			if (curr->softirq_context)
46038eddac3fSPeter Zijlstra 				if (!mark_lock(curr, hlock,
4604c2469756SBoqun Feng 						LOCK_USED_IN_SOFTIRQ_READ))
4605c2469756SBoqun Feng 					return 0;
4606f9ad4a5fSPeter Zijlstra 		} else {
4607b3b9c187SWaiman Long 			if (lockdep_hardirq_context())
4608c2469756SBoqun Feng 				if (!mark_lock(curr, hlock, LOCK_USED_IN_HARDIRQ))
4609c2469756SBoqun Feng 					return 0;
46108eddac3fSPeter Zijlstra 			if (curr->softirq_context)
46118eddac3fSPeter Zijlstra 				if (!mark_lock(curr, hlock, LOCK_USED_IN_SOFTIRQ))
46128eddac3fSPeter Zijlstra 					return 0;
46138eddac3fSPeter Zijlstra 		}
46148eddac3fSPeter Zijlstra 	}
46158eddac3fSPeter Zijlstra 
46168eddac3fSPeter Zijlstra 	/*
46178eddac3fSPeter Zijlstra 	 * For lock_sync(), don't mark the ENABLED usage, since lock_sync()
46188eddac3fSPeter Zijlstra 	 * creates no critical section and no extra dependency can be introduced
46198eddac3fSPeter Zijlstra 	 * by interrupts
46208eddac3fSPeter Zijlstra 	 */
46218eddac3fSPeter Zijlstra 	if (!hlock->hardirqs_off && !hlock->sync) {
46228eddac3fSPeter Zijlstra 		if (hlock->read) {
46238eddac3fSPeter Zijlstra 			if (!mark_lock(curr, hlock,
46248eddac3fSPeter Zijlstra 					LOCK_ENABLED_HARDIRQ_READ))
46258eddac3fSPeter Zijlstra 				return 0;
46268eddac3fSPeter Zijlstra 			if (curr->softirqs_enabled)
46278eddac3fSPeter Zijlstra 				if (!mark_lock(curr, hlock,
46288eddac3fSPeter Zijlstra 						LOCK_ENABLED_SOFTIRQ_READ))
46298eddac3fSPeter Zijlstra 					return 0;
46308eddac3fSPeter Zijlstra 		} else {
46318eddac3fSPeter Zijlstra 			if (!mark_lock(curr, hlock,
46328eddac3fSPeter Zijlstra 					LOCK_ENABLED_HARDIRQ))
46338eddac3fSPeter Zijlstra 				return 0;
46348eddac3fSPeter Zijlstra 			if (curr->softirqs_enabled)
46358eddac3fSPeter Zijlstra 				if (!mark_lock(curr, hlock,
46368eddac3fSPeter Zijlstra 						LOCK_ENABLED_SOFTIRQ))
46378eddac3fSPeter Zijlstra 					return 0;
46388eddac3fSPeter Zijlstra 		}
46392bb8945bSPeter Zijlstra 	}
46408eddac3fSPeter Zijlstra 
46414d56330dSYuyang Du lock_used:
46424d56330dSYuyang Du 	/* mark it as used: */
46434d56330dSYuyang Du 	if (!mark_lock(curr, hlock, LOCK_USED))
46444d56330dSYuyang Du 		return 0;
46454d56330dSYuyang Du 
464623870f12Speterz@infradead.org 	return 1;
464723870f12Speterz@infradead.org }
464823870f12Speterz@infradead.org 
task_irq_context(struct task_struct * task)464923870f12Speterz@infradead.org static inline unsigned int task_irq_context(struct task_struct *task)
465023870f12Speterz@infradead.org {
46518eddac3fSPeter Zijlstra 	return LOCK_CHAIN_HARDIRQ_CONTEXT * !!lockdep_hardirq_context() +
46528eddac3fSPeter Zijlstra 	       LOCK_CHAIN_SOFTIRQ_CONTEXT * !!task->softirq_context;
46538eddac3fSPeter Zijlstra }
46548eddac3fSPeter Zijlstra 
separate_irq_context(struct task_struct * curr,struct held_lock * hlock)46558eddac3fSPeter Zijlstra static int separate_irq_context(struct task_struct *curr,
46568eddac3fSPeter Zijlstra 		struct held_lock *hlock)
46578eddac3fSPeter Zijlstra {
46588eddac3fSPeter Zijlstra 	unsigned int depth = curr->lockdep_depth;
46598eddac3fSPeter Zijlstra 
46608eddac3fSPeter Zijlstra 	/*
46618eddac3fSPeter Zijlstra 	 * Keep track of points where we cross into an interrupt context:
46628eddac3fSPeter Zijlstra 	 */
466323870f12Speterz@infradead.org 	if (depth) {
466423870f12Speterz@infradead.org 		struct held_lock *prev_hlock;
46658eddac3fSPeter Zijlstra 
46661a393408SPeter Zijlstra 		prev_hlock = curr->held_locks + depth-1;
46671a393408SPeter Zijlstra 		/*
46681a393408SPeter Zijlstra 		 * If we cross into another context, reset the
46698eddac3fSPeter Zijlstra 		 * hash key (this also prevents the checking and the
46708eddac3fSPeter Zijlstra 		 * adding of the dependency to 'prev'):
46712bb8945bSPeter Zijlstra 		 */
467212593b74SBart Van Assche 		if (prev_hlock->irq_context != hlock->irq_context)
46738eddac3fSPeter Zijlstra 			return 1;
46748eddac3fSPeter Zijlstra 	}
46758eddac3fSPeter Zijlstra 	return 0;
46761a393408SPeter Zijlstra }
46778eddac3fSPeter Zijlstra 
46788eddac3fSPeter Zijlstra /*
46798eddac3fSPeter Zijlstra  * Mark a lock with a usage bit, and validate the state transition:
46808eddac3fSPeter Zijlstra  */
mark_lock(struct task_struct * curr,struct held_lock * this,enum lock_usage_bit new_bit)46818eddac3fSPeter Zijlstra static int mark_lock(struct task_struct *curr, struct held_lock *this,
468223870f12Speterz@infradead.org 			     enum lock_usage_bit new_bit)
46838eddac3fSPeter Zijlstra {
46848eddac3fSPeter Zijlstra 	unsigned int new_mask, ret = 1;
46858eddac3fSPeter Zijlstra 
46868eddac3fSPeter Zijlstra 	if (new_bit >= LOCK_USAGE_STATES) {
46878eddac3fSPeter Zijlstra 		DEBUG_LOCKS_WARN_ON(1);
46888eddac3fSPeter Zijlstra 		return 0;
46898eddac3fSPeter Zijlstra 	}
46908eddac3fSPeter Zijlstra 
46918eddac3fSPeter Zijlstra 	if (new_bit == LOCK_USED && this->read)
46928eddac3fSPeter Zijlstra 		new_bit = LOCK_USED_READ;
46938eddac3fSPeter Zijlstra 
46948eddac3fSPeter Zijlstra 	new_mask = 1 << new_bit;
46958eddac3fSPeter Zijlstra 
46968eddac3fSPeter Zijlstra 	/*
46978eddac3fSPeter Zijlstra 	 * If already set then do not dirty the cacheline,
46989a019db0SPeter Zijlstra 	 * nor do any checks:
46999a019db0SPeter Zijlstra 	 */
47009a019db0SPeter Zijlstra 	if (likely(hlock_class(this)->usage_mask & new_mask))
47019a019db0SPeter Zijlstra 		return 1;
47029a019db0SPeter Zijlstra 
47039a019db0SPeter Zijlstra 	if (!graph_lock())
4704f9ad4a5fSPeter Zijlstra 		return 0;
47059a019db0SPeter Zijlstra 	/*
47069a019db0SPeter Zijlstra 	 * Make sure we didn't race:
47079a019db0SPeter Zijlstra 	 */
47089a019db0SPeter Zijlstra 	if (unlikely(hlock_class(this)->usage_mask & new_mask))
47099a019db0SPeter Zijlstra 		goto unlock;
47109a019db0SPeter Zijlstra 
47119a019db0SPeter Zijlstra 	if (!hlock_class(this)->usage_mask)
47129a019db0SPeter Zijlstra 		debug_atomic_dec(nr_unused_locks);
47139a019db0SPeter Zijlstra 
47149a019db0SPeter Zijlstra 	hlock_class(this)->usage_mask |= new_mask;
47159a019db0SPeter Zijlstra 
47169a019db0SPeter Zijlstra 	if (new_bit < LOCK_TRACE_STATES) {
47179a019db0SPeter Zijlstra 		if (!(hlock_class(this)->usage_traces[new_bit] = save_trace()))
47189a019db0SPeter Zijlstra 			return 0;
47199a019db0SPeter Zijlstra 	}
47209a019db0SPeter Zijlstra 
47219a019db0SPeter Zijlstra 	if (new_bit < LOCK_USED) {
4722de8f5e4fSPeter Zijlstra 		ret = mark_lock_irq(curr, this, new_bit);
4723de8f5e4fSPeter Zijlstra 		if (!ret)
4724de8f5e4fSPeter Zijlstra 			return 0;
4725de8f5e4fSPeter Zijlstra 	}
47269a019db0SPeter Zijlstra 
47279a019db0SPeter Zijlstra unlock:
4728de8f5e4fSPeter Zijlstra 	graph_unlock();
4729de8f5e4fSPeter Zijlstra 
4730de8f5e4fSPeter Zijlstra 	/*
4731de8f5e4fSPeter Zijlstra 	 * We must printk outside of the graph_lock:
4732de8f5e4fSPeter Zijlstra 	 */
4733de8f5e4fSPeter Zijlstra 	if (ret == 2) {
4734de8f5e4fSPeter Zijlstra 		nbcon_cpu_emergency_enter();
4735de8f5e4fSPeter Zijlstra 		printk("\nmarked lock as {%s}:\n", usage_str[new_bit]);
4736de8f5e4fSPeter Zijlstra 		print_lock(this);
4737de8f5e4fSPeter Zijlstra 		print_irqtrace_events(curr);
4738de8f5e4fSPeter Zijlstra 		dump_stack();
4739de8f5e4fSPeter Zijlstra 		nbcon_cpu_emergency_exit();
4740de8f5e4fSPeter Zijlstra 	}
4741de8f5e4fSPeter Zijlstra 
4742de8f5e4fSPeter Zijlstra 	return ret;
47439a019db0SPeter Zijlstra }
47449a019db0SPeter Zijlstra 
task_wait_context(struct task_struct * curr)47459a019db0SPeter Zijlstra static inline short task_wait_context(struct task_struct *curr)
47469a019db0SPeter Zijlstra {
4747de8f5e4fSPeter Zijlstra 	/*
4748de8f5e4fSPeter Zijlstra 	 * Set appropriate wait type for the context; for IRQs we have to take
4749de8f5e4fSPeter Zijlstra 	 * into account force_irqthread as that is implied by PREEMPT_RT.
4750de8f5e4fSPeter Zijlstra 	 */
4751de8f5e4fSPeter Zijlstra 	if (lockdep_hardirq_context()) {
4752de8f5e4fSPeter Zijlstra 		/*
4753de8f5e4fSPeter Zijlstra 		 * Check if force_irqthreads will run us threaded.
4754de8f5e4fSPeter Zijlstra 		 */
4755de8f5e4fSPeter Zijlstra 		if (curr->hardirq_threaded || curr->irq_config)
4756de8f5e4fSPeter Zijlstra 			return LD_WAIT_CONFIG;
4757de8f5e4fSPeter Zijlstra 
4758a2e05dddSZhouyi Zhou 		return LD_WAIT_SPIN;
4759de8f5e4fSPeter Zijlstra 	} else if (curr->softirq_context) {
4760de8f5e4fSPeter Zijlstra 		/*
4761de8f5e4fSPeter Zijlstra 		 * Softirqs are always threaded.
4762de8f5e4fSPeter Zijlstra 		 */
4763de8f5e4fSPeter Zijlstra 		return LD_WAIT_CONFIG;
4764de8f5e4fSPeter Zijlstra 	}
4765de8f5e4fSPeter Zijlstra 
4766de8f5e4fSPeter Zijlstra 	return LD_WAIT_MAX;
4767de8f5e4fSPeter Zijlstra }
4768de8f5e4fSPeter Zijlstra 
4769de8f5e4fSPeter Zijlstra static int
print_lock_invalid_wait_context(struct task_struct * curr,struct held_lock * hlock)4770de8f5e4fSPeter Zijlstra print_lock_invalid_wait_context(struct task_struct *curr,
4771de8f5e4fSPeter Zijlstra 				struct held_lock *hlock)
4772dfd5e3f5SPeter Zijlstra {
4773dfd5e3f5SPeter Zijlstra 	short curr_inner;
4774dfd5e3f5SPeter Zijlstra 
4775de8f5e4fSPeter Zijlstra 	if (!debug_locks_off())
4776de8f5e4fSPeter Zijlstra 		return 0;
4777f8b298ccSPeter Zijlstra 	if (debug_locks_silent)
4778de8f5e4fSPeter Zijlstra 		return 0;
4779de8f5e4fSPeter Zijlstra 
4780de8f5e4fSPeter Zijlstra 	nbcon_cpu_emergency_enter();
4781de8f5e4fSPeter Zijlstra 
4782de8f5e4fSPeter Zijlstra 	pr_warn("\n");
4783de8f5e4fSPeter Zijlstra 	pr_warn("=============================\n");
4784de8f5e4fSPeter Zijlstra 	pr_warn("[ BUG: Invalid wait context ]\n");
4785de8f5e4fSPeter Zijlstra 	print_kernel_ident();
4786de8f5e4fSPeter Zijlstra 	pr_warn("-----------------------------\n");
4787de8f5e4fSPeter Zijlstra 
4788de8f5e4fSPeter Zijlstra 	pr_warn("%s/%d is trying to lock:\n", curr->comm, task_pid_nr(curr));
4789de8f5e4fSPeter Zijlstra 	print_lock(hlock);
4790de8f5e4fSPeter Zijlstra 
4791de8f5e4fSPeter Zijlstra 	pr_warn("other info that might help us debug this:\n");
4792de8f5e4fSPeter Zijlstra 
47939a019db0SPeter Zijlstra 	curr_inner = task_wait_context(curr);
4794de8f5e4fSPeter Zijlstra 	pr_warn("context-{%d:%d}\n", curr_inner, curr_inner);
4795de8f5e4fSPeter Zijlstra 
4796de8f5e4fSPeter Zijlstra 	lockdep_print_held_locks(curr);
47970cce06baSPeter Zijlstra 
47980cce06baSPeter Zijlstra 	pr_warn("stack backtrace:\n");
4799de8f5e4fSPeter Zijlstra 	dump_stack();
4800de8f5e4fSPeter Zijlstra 
4801de8f5e4fSPeter Zijlstra 	nbcon_cpu_emergency_exit();
4802de8f5e4fSPeter Zijlstra 
4803de8f5e4fSPeter Zijlstra 	return 0;
4804de8f5e4fSPeter Zijlstra }
4805de8f5e4fSPeter Zijlstra 
4806de8f5e4fSPeter Zijlstra /*
4807de8f5e4fSPeter Zijlstra  * Verify the wait_type context.
48080cce06baSPeter Zijlstra  *
48090cce06baSPeter Zijlstra  * This check validates we take locks in the right wait-type order; that is it
48100cce06baSPeter Zijlstra  * ensures that we do not take mutexes inside spinlocks and do not attempt to
48110cce06baSPeter Zijlstra  * acquire spinlocks inside raw_spinlocks and the sort.
48120cce06baSPeter Zijlstra  *
48130cce06baSPeter Zijlstra  * The entire thing is slightly more complex because of RCU, RCU is a lock that
48140cce06baSPeter Zijlstra  * can be taken from (pretty much) any context but also has constraints.
48150cce06baSPeter Zijlstra  * However when taken in a stricter environment the RCU lock does not loosen
4816de8f5e4fSPeter Zijlstra  * the constraints.
4817de8f5e4fSPeter Zijlstra  *
4818de8f5e4fSPeter Zijlstra  * Therefore we must look for the strictest environment in the lock stack and
4819de8f5e4fSPeter Zijlstra  * compare that to the lock we're trying to acquire.
4820de8f5e4fSPeter Zijlstra  */
check_wait_context(struct task_struct * curr,struct held_lock * next)4821de8f5e4fSPeter Zijlstra static int check_wait_context(struct task_struct *curr, struct held_lock *next)
4822de8f5e4fSPeter Zijlstra {
4823de8f5e4fSPeter Zijlstra 	u8 next_inner = hlock_class(next)->wait_type_inner;
4824de8f5e4fSPeter Zijlstra 	u8 next_outer = hlock_class(next)->wait_type_outer;
482530a35f79SArnd Bergmann 	u8 curr_inner;
4826886532aeSArnd Bergmann 	int depth;
4827886532aeSArnd Bergmann 
4828886532aeSArnd Bergmann 	if (!next_inner || next->trylock)
4829886532aeSArnd Bergmann 		return 0;
4830886532aeSArnd Bergmann 
4831886532aeSArnd Bergmann 	if (!next_outer)
4832886532aeSArnd Bergmann 		next_outer = next_inner;
4833886532aeSArnd Bergmann 
4834886532aeSArnd Bergmann 	/*
4835886532aeSArnd Bergmann 	 * Find start of current irq_context..
4836886532aeSArnd Bergmann 	 */
4837886532aeSArnd Bergmann 	for (depth = curr->lockdep_depth - 1; depth >= 0; depth--) {
4838886532aeSArnd Bergmann 		struct held_lock *prev = curr->held_locks + depth;
4839886532aeSArnd Bergmann 		if (prev->irq_context != next->irq_context)
4840886532aeSArnd Bergmann 			break;
4841886532aeSArnd Bergmann 	}
4842886532aeSArnd Bergmann 	depth++;
4843886532aeSArnd Bergmann 
4844de8f5e4fSPeter Zijlstra 	curr_inner = task_wait_context(curr);
4845de8f5e4fSPeter Zijlstra 
4846de8f5e4fSPeter Zijlstra 	for (; depth < curr->lockdep_depth; depth++) {
4847de8f5e4fSPeter Zijlstra 		struct held_lock *prev = curr->held_locks + depth;
4848de8f5e4fSPeter Zijlstra 		struct lock_class *class = hlock_class(prev);
4849de8f5e4fSPeter Zijlstra 		u8 prev_inner = class->wait_type_inner;
485030a35f79SArnd Bergmann 
4851886532aeSArnd Bergmann 		if (prev_inner) {
48528eddac3fSPeter Zijlstra 			/*
48538eddac3fSPeter Zijlstra 			 * We can have a bigger inner than a previous one
48548eddac3fSPeter Zijlstra 			 * when outer is smaller than inner, as with RCU.
4855dfd5e3f5SPeter Zijlstra 			 *
4856de8f5e4fSPeter Zijlstra 			 * Also due to trylocks.
4857dfd5e3f5SPeter Zijlstra 			 */
48588eddac3fSPeter Zijlstra 			curr_inner = min(curr_inner, prev_inner);
48598eddac3fSPeter Zijlstra 
48608eddac3fSPeter Zijlstra 			/*
48618eddac3fSPeter Zijlstra 			 * Allow override for annotations -- this is typically
48628eddac3fSPeter Zijlstra 			 * only valid/needed for code that only exists when
48638eddac3fSPeter Zijlstra 			 * CONFIG_PREEMPT_RT=n.
48648eddac3fSPeter Zijlstra 			 */
48658eddac3fSPeter Zijlstra 			if (unlikely(class->lock_type == LD_LOCK_WAIT_OVERRIDE))
48668eddac3fSPeter Zijlstra 				curr_inner = prev_inner;
48678eddac3fSPeter Zijlstra 		}
48688eddac3fSPeter Zijlstra 	}
48698eddac3fSPeter Zijlstra 
48708eddac3fSPeter Zijlstra 	if (next_outer > curr_inner)
48718eddac3fSPeter Zijlstra 		return print_lock_invalid_wait_context(curr, next);
48728eddac3fSPeter Zijlstra 
48738eddac3fSPeter Zijlstra 	return 0;
48748eddac3fSPeter Zijlstra }
48758eddac3fSPeter Zijlstra 
48768eddac3fSPeter Zijlstra #else /* CONFIG_PROVE_LOCKING */
48778eddac3fSPeter Zijlstra 
4878de8f5e4fSPeter Zijlstra static inline int
mark_usage(struct task_struct * curr,struct held_lock * hlock,int check)4879de8f5e4fSPeter Zijlstra mark_usage(struct task_struct *curr, struct held_lock *hlock, int check)
4880dfd5e3f5SPeter Zijlstra {
4881de8f5e4fSPeter Zijlstra 	return 1;
48828eddac3fSPeter Zijlstra }
48838eddac3fSPeter Zijlstra 
task_irq_context(struct task_struct * task)48848eddac3fSPeter Zijlstra static inline unsigned int task_irq_context(struct task_struct *task)
48858eddac3fSPeter Zijlstra {
48868eddac3fSPeter Zijlstra 	return 0;
48878eddac3fSPeter Zijlstra }
4888108c1485SBart Van Assche 
separate_irq_context(struct task_struct * curr,struct held_lock * hlock)4889108c1485SBart Van Assche static inline int separate_irq_context(struct task_struct *curr,
48908eddac3fSPeter Zijlstra 		struct held_lock *hlock)
4891108c1485SBart Van Assche {
4892108c1485SBart Van Assche 	return 0;
4893108c1485SBart Van Assche }
48948eddac3fSPeter Zijlstra 
check_wait_context(struct task_struct * curr,struct held_lock * next)48958eddac3fSPeter Zijlstra static inline int check_wait_context(struct task_struct *curr,
48968eddac3fSPeter Zijlstra 				     struct held_lock *next)
48978eddac3fSPeter Zijlstra {
48988eddac3fSPeter Zijlstra 	return 0;
48998eddac3fSPeter Zijlstra }
49008eddac3fSPeter Zijlstra 
49018eddac3fSPeter Zijlstra #endif /* CONFIG_PROVE_LOCKING */
490235a9393cSPeter Zijlstra 
490335a9393cSPeter Zijlstra /*
490435a9393cSPeter Zijlstra  * Initialize a lock instance's lock-class mapping info:
49054d004099SPeter Zijlstra  */
lockdep_init_map_type(struct lockdep_map * lock,const char * name,struct lock_class_key * key,int subclass,u8 inner,u8 outer,u8 lock_type)490635a9393cSPeter Zijlstra void lockdep_init_map_type(struct lockdep_map *lock, const char *name,
490735a9393cSPeter Zijlstra 			    struct lock_class_key *key, int subclass,
490835a9393cSPeter Zijlstra 			    u8 inner, u8 outer, u8 lock_type)
49094d004099SPeter Zijlstra {
49108eddac3fSPeter Zijlstra 	int i;
491110476e63SPeter Zijlstra 
491235a9393cSPeter Zijlstra 	for (i = 0; i < NR_LOCKDEP_CACHING_CLASSES; i++)
491335a9393cSPeter Zijlstra 		lock->class_cache[i] = NULL;
49148eddac3fSPeter Zijlstra 
4915dfd5e3f5SPeter Zijlstra #ifdef CONFIG_LOCK_STAT
49168eddac3fSPeter Zijlstra 	lock->cpu = raw_smp_processor_id();
49178eddac3fSPeter Zijlstra #endif
49188eddac3fSPeter Zijlstra 
49198eddac3fSPeter Zijlstra 	/*
49201a616c2fSKent Overstreet 	 * Can't be having no nameless bastards around this place!
49211a616c2fSKent Overstreet 	 */
49221a616c2fSKent Overstreet 	if (DEBUG_LOCKS_WARN_ON(!name)) {
4923eb1cfd09SKent Overstreet 		lock->name = "NULL";
4924eb1cfd09SKent Overstreet 		return;
4925eb1cfd09SKent Overstreet 	}
4926eb1cfd09SKent Overstreet 
4927eb1cfd09SKent Overstreet 	lock->name = name;
4928eb1cfd09SKent Overstreet 
4929eb1cfd09SKent Overstreet 	lock->wait_type_outer = outer;
4930eb1cfd09SKent Overstreet 	lock->wait_type_inner = inner;
4931eb1cfd09SKent Overstreet 	lock->lock_type = lock_type;
4932eb1cfd09SKent Overstreet 
4933eb1cfd09SKent Overstreet 	/*
4934eb1cfd09SKent Overstreet 	 * No key, no joy, we need to hash something.
4935eb1cfd09SKent Overstreet 	 */
4936eb1cfd09SKent Overstreet 	if (DEBUG_LOCKS_WARN_ON(!key))
4937eb1cfd09SKent Overstreet 		return;
4938eb1cfd09SKent Overstreet 	/*
4939eb1cfd09SKent Overstreet 	 * Sanity check, the lock-class key must either have been allocated
4940eb1cfd09SKent Overstreet 	 * statically or must have been registered as a dynamic key.
4941eb1cfd09SKent Overstreet 	 */
4942eb1cfd09SKent Overstreet 	if (!static_obj(key) && !is_dynamic_key(key)) {
4943eb1cfd09SKent Overstreet 		if (debug_locks)
4944eb1cfd09SKent Overstreet 			printk(KERN_ERR "BUG: key %px has not been registered!\n", key);
4945eb1cfd09SKent Overstreet 		DEBUG_LOCKS_WARN_ON(1);
4946eb1cfd09SKent Overstreet 		return;
4947eb1cfd09SKent Overstreet 	}
4948eb1cfd09SKent Overstreet 	lock->key = key;
4949eb1cfd09SKent Overstreet 
4950f7c1c6b3SYuyang Du 	if (unlikely(!debug_locks))
49518eddac3fSPeter Zijlstra 		return;
49528b023accSNick Desaulniers 
49538eddac3fSPeter Zijlstra 	if (subclass) {
49548eddac3fSPeter Zijlstra 		unsigned long flags;
4955f7c1c6b3SYuyang Du 
49568eddac3fSPeter Zijlstra 		if (DEBUG_LOCKS_WARN_ON(!lockdep_enabled()))
4957f7c1c6b3SYuyang Du 			return;
49588eddac3fSPeter Zijlstra 
4959681fbec8SPaul E. McKenney 		raw_local_irq_save(flags);
4960a5dd63efSPaul E. McKenney 		lockdep_recursion_inc();
4961a5dd63efSPaul E. McKenney 		register_lock_class(lock, subclass, 1);
49628eddac3fSPeter Zijlstra 		lockdep_recursion_finish();
4963a5dd63efSPaul E. McKenney 		raw_local_irq_restore(flags);
49648eddac3fSPeter Zijlstra 	}
4965681fbec8SPaul E. McKenney }
49668eddac3fSPeter Zijlstra EXPORT_SYMBOL_GPL(lockdep_init_map_type);
49678eddac3fSPeter Zijlstra 
4968681fbec8SPaul E. McKenney struct lock_class_key __lockdep_no_validate__;
4969681fbec8SPaul E. McKenney EXPORT_SYMBOL_GPL(__lockdep_no_validate__);
49708eddac3fSPeter Zijlstra 
4971681fbec8SPaul E. McKenney struct lock_class_key __lockdep_no_track__;
49728eddac3fSPeter Zijlstra EXPORT_SYMBOL_GPL(__lockdep_no_track__);
49738eddac3fSPeter Zijlstra 
4974681fbec8SPaul E. McKenney #ifdef CONFIG_PROVE_LOCKING
lockdep_set_lock_cmp_fn(struct lockdep_map * lock,lock_cmp_fn cmp_fn,lock_print_fn print_fn)49758eddac3fSPeter Zijlstra void lockdep_set_lock_cmp_fn(struct lockdep_map *lock, lock_cmp_fn cmp_fn,
49768eddac3fSPeter Zijlstra 			     lock_print_fn print_fn)
4977681fbec8SPaul E. McKenney {
49788eddac3fSPeter Zijlstra 	struct lock_class *class = lock->class_cache[0];
49798eddac3fSPeter Zijlstra 	unsigned long flags;
49808eddac3fSPeter Zijlstra 
498108f36ff6SMatthew Wilcox 	raw_local_irq_save(flags);
49828eddac3fSPeter Zijlstra 	lockdep_recursion_inc();
49838eddac3fSPeter Zijlstra 
49848eddac3fSPeter Zijlstra 	if (!class)
49858eddac3fSPeter Zijlstra 		class = register_lock_class(lock, 0, 0);
49868ee10862SWaiman Long 
49878ee10862SWaiman Long 	if (class) {
49888ee10862SWaiman Long 		WARN_ON(class->cmp_fn	&& class->cmp_fn != cmp_fn);
49898ee10862SWaiman Long 		WARN_ON(class->print_fn && class->print_fn != print_fn);
49908eddac3fSPeter Zijlstra 
49918eddac3fSPeter Zijlstra 		class->cmp_fn	= cmp_fn;
49928eddac3fSPeter Zijlstra 		class->print_fn = print_fn;
49938eddac3fSPeter Zijlstra 	}
49940471db44SBoqun Feng 
49958eddac3fSPeter Zijlstra 	lockdep_recursion_finish();
49968eddac3fSPeter Zijlstra 	raw_local_irq_restore(flags);
49978eddac3fSPeter Zijlstra }
49988eddac3fSPeter Zijlstra EXPORT_SYMBOL_GPL(lockdep_set_lock_cmp_fn);
49995f18ab5cSAlfredo Alvarez Fernandez #endif
50008eddac3fSPeter Zijlstra 
50018eddac3fSPeter Zijlstra static void
print_lock_nested_lock_not_held(struct task_struct * curr,struct held_lock * hlock)50028eddac3fSPeter Zijlstra print_lock_nested_lock_not_held(struct task_struct *curr,
50038eddac3fSPeter Zijlstra 				struct held_lock *hlock)
50048eddac3fSPeter Zijlstra {
50058eddac3fSPeter Zijlstra 	if (!debug_locks_off())
50068eddac3fSPeter Zijlstra 		return;
50071a616c2fSKent Overstreet 	if (debug_locks_silent)
50081a616c2fSKent Overstreet 		return;
50091a616c2fSKent Overstreet 
5010fb9edbe9SOleg Nesterov 	nbcon_cpu_emergency_enter();
5011fb9edbe9SOleg Nesterov 
50128eddac3fSPeter Zijlstra 	pr_warn("\n");
50138eddac3fSPeter Zijlstra 	pr_warn("==================================\n");
50148eddac3fSPeter Zijlstra 	pr_warn("WARNING: Nested lock was not taken\n");
50158eddac3fSPeter Zijlstra 	print_kernel_ident();
50168eddac3fSPeter Zijlstra 	pr_warn("----------------------------------\n");
50178eddac3fSPeter Zijlstra 
50188eddac3fSPeter Zijlstra 	pr_warn("%s/%d is trying to lock:\n", curr->comm, task_pid_nr(curr));
50198eddac3fSPeter Zijlstra 	print_lock(hlock);
50208eddac3fSPeter Zijlstra 
50218eddac3fSPeter Zijlstra 	pr_warn("\nbut this task is not holding:\n");
50228eddac3fSPeter Zijlstra 	pr_warn("%s\n", hlock->nest_lock->name);
50238ca2b56cSWaiman Long 
50248ca2b56cSWaiman Long 	pr_warn("\nstack backtrace:\n");
50258ca2b56cSWaiman Long 	dump_stack();
50268eddac3fSPeter Zijlstra 
502704860d48SBorislav Petkov 	pr_warn("\nother info that might help us debug this:\n");
50288eddac3fSPeter Zijlstra 	lockdep_print_held_locks(curr);
5029f943fe0fSDmitry Vyukov 
5030f943fe0fSDmitry Vyukov 	pr_warn("\nstack backtrace:\n");
50318eddac3fSPeter Zijlstra 	dump_stack();
50328eddac3fSPeter Zijlstra 
50338eddac3fSPeter Zijlstra 	nbcon_cpu_emergency_exit();
50348eddac3fSPeter Zijlstra }
50358eddac3fSPeter Zijlstra 
50368eddac3fSPeter Zijlstra static int __lock_is_held(const struct lockdep_map *lock, int read);
50378eddac3fSPeter Zijlstra 
50388eddac3fSPeter Zijlstra /*
50398eddac3fSPeter Zijlstra  * This gets called for every mutex_lock*()/spin_lock*() operation.
50408eddac3fSPeter Zijlstra  * We maintain the dependency maps and validate the locking attempt:
50418eddac3fSPeter Zijlstra  *
50428eddac3fSPeter Zijlstra  * The callers must make sure that IRQs are disabled before calling it,
50438eddac3fSPeter Zijlstra  * otherwise we could get an interrupt which would want to take locks,
50448eddac3fSPeter Zijlstra  * which would end up in lockdep again.
50458eddac3fSPeter Zijlstra  */
__lock_acquire(struct lockdep_map * lock,unsigned int subclass,int trylock,int read,int check,int hardirqs_off,struct lockdep_map * nest_lock,unsigned long ip,int references,int pin_count,int sync)504601bb6f0aSYuyang Du static int __lock_acquire(struct lockdep_map *lock, unsigned int subclass,
50478eddac3fSPeter Zijlstra 			  int trylock, int read, int check, int hardirqs_off,
50480471db44SBoqun Feng 			  struct lockdep_map *nest_lock, unsigned long ip,
50490471db44SBoqun Feng 			  int references, int pin_count, int sync)
50508eddac3fSPeter Zijlstra {
50518eddac3fSPeter Zijlstra 	struct task_struct *curr = current;
5052d9349850SImre Deak 	struct lock_class *class = NULL;
5053d9349850SImre Deak 	struct held_lock *hlock;
50547fb4a2ceSPeter Zijlstra 	unsigned int depth;
5055d9349850SImre Deak 	int chain_head = 0;
50568eddac3fSPeter Zijlstra 	int class_idx;
5057d9349850SImre Deak 	u64 chain_key;
5058d9349850SImre Deak 
5059d9349850SImre Deak 	if (unlikely(!debug_locks))
5060d9349850SImre Deak 		return 0;
5061d9349850SImre Deak 
5062d9349850SImre Deak 	if (unlikely(lock->key == &__lockdep_no_track__))
50638eddac3fSPeter Zijlstra 		return 0;
50648c8889d8SImre Deak 
50658eddac3fSPeter Zijlstra 	if (!prove_locking || lock->key == &__lockdep_no_validate__)
50668eddac3fSPeter Zijlstra 		check = 0;
50678eddac3fSPeter Zijlstra 
50688eddac3fSPeter Zijlstra 	if (subclass < NR_LOCKDEP_CACHING_CLASSES)
50698eddac3fSPeter Zijlstra 		class = lock->class_cache[subclass];
50708eddac3fSPeter Zijlstra 	/*
50718eddac3fSPeter Zijlstra 	 * Not cached?
50728eddac3fSPeter Zijlstra 	 */
50738eddac3fSPeter Zijlstra 	if (unlikely(!class)) {
50748eddac3fSPeter Zijlstra 		class = register_lock_class(lock, subclass, 0);
50758eddac3fSPeter Zijlstra 		if (!class)
50768eddac3fSPeter Zijlstra 			return 0;
50778eddac3fSPeter Zijlstra 	}
50788eddac3fSPeter Zijlstra 
5079c2469756SBoqun Feng 	debug_class_ops_inc(class);
50808eddac3fSPeter Zijlstra 
50818eddac3fSPeter Zijlstra 	if (very_verbose(class)) {
50828eddac3fSPeter Zijlstra 		nbcon_cpu_emergency_enter();
50830471db44SBoqun Feng 		printk("\nacquire class [%px] %s", class->key, class->name);
50848eddac3fSPeter Zijlstra 		if (class->name_version > 1)
50858eddac3fSPeter Zijlstra 			printk(KERN_CONT "#%d", class->name_version);
50868eddac3fSPeter Zijlstra 		printk(KERN_CONT "\n");
50878eddac3fSPeter Zijlstra 		dump_stack();
50888eddac3fSPeter Zijlstra 		nbcon_cpu_emergency_exit();
50898eddac3fSPeter Zijlstra 	}
509021199f27SPeter Zijlstra 
50918eddac3fSPeter Zijlstra 	/*
5092de8f5e4fSPeter Zijlstra 	 * Add the lock to the list of currently held locks.
5093de8f5e4fSPeter Zijlstra 	 * (we dont increase the depth just yet, up until the
5094de8f5e4fSPeter Zijlstra 	 * dependency checks are done)
509509180651SYuyang Du 	 */
509609180651SYuyang Du 	depth = curr->lockdep_depth;
50978eddac3fSPeter Zijlstra 	/*
50988eddac3fSPeter Zijlstra 	 * Ran out of static storage for our per-task lock stack again have we?
50998eddac3fSPeter Zijlstra 	 */
51008eddac3fSPeter Zijlstra 	if (DEBUG_LOCKS_WARN_ON(depth >= MAX_LOCK_DEPTH))
51018eddac3fSPeter Zijlstra 		return 0;
51028eddac3fSPeter Zijlstra 
51038eddac3fSPeter Zijlstra 	class_idx = class - lock_classes;
51048eddac3fSPeter Zijlstra 
51058eddac3fSPeter Zijlstra 	if (depth && !sync) {
51068eddac3fSPeter Zijlstra 		/* we're holding locks and the new held lock is not a sync */
51078eddac3fSPeter Zijlstra 		hlock = curr->held_locks + depth - 1;
51088eddac3fSPeter Zijlstra 		if (hlock->class_idx == class_idx && nest_lock) {
51098eddac3fSPeter Zijlstra 			if (!references)
511001bb6f0aSYuyang Du 				references++;
51118eddac3fSPeter Zijlstra 
511201bb6f0aSYuyang Du 			if (!hlock->references)
51138eddac3fSPeter Zijlstra 				hlock->references++;
51148eddac3fSPeter Zijlstra 
51158eddac3fSPeter Zijlstra 			hlock->references += references;
51168eddac3fSPeter Zijlstra 
51178eddac3fSPeter Zijlstra 			/* Overflow */
51188eddac3fSPeter Zijlstra 			if (DEBUG_LOCKS_WARN_ON(hlock->references < references))
51198eddac3fSPeter Zijlstra 				return 0;
5120f6ec8829SYuyang Du 
51218eddac3fSPeter Zijlstra 			return 2;
51228eddac3fSPeter Zijlstra 		}
51238eddac3fSPeter Zijlstra 	}
51248eddac3fSPeter Zijlstra 
51258eddac3fSPeter Zijlstra 	hlock = curr->held_locks + depth;
51268eddac3fSPeter Zijlstra 	/*
5127f6ec8829SYuyang Du 	 * Plain impossible, we just registered it and checked it weren't no
51288eddac3fSPeter Zijlstra 	 * NULL like.. I bet this mushroom I ate was good!
51298eddac3fSPeter Zijlstra 	 */
5130f611e8cfSBoqun Feng 	if (DEBUG_LOCKS_WARN_ON(!class))
51318eddac3fSPeter Zijlstra 		return 0;
5132f7c1c6b3SYuyang Du 	hlock->class_idx = class_idx;
51338b023accSNick Desaulniers 	hlock->acquire_ip = ip;
5134f7c1c6b3SYuyang Du 	hlock->instance = lock;
5135f7c1c6b3SYuyang Du 	hlock->nest_lock = nest_lock;
51368eddac3fSPeter Zijlstra 	hlock->irq_context = task_irq_context(curr);
5137a0b0fd53SBart Van Assche 	hlock->trylock = trylock;
5138a0b0fd53SBart Van Assche 	hlock->read = read;
5139a0b0fd53SBart Van Assche 	hlock->check = check;
5140a0b0fd53SBart Van Assche 	hlock->sync = !!sync;
5141a0b0fd53SBart Van Assche 	hlock->hardirqs_off = !!hardirqs_off;
51420b9fc8ecSYuyang Du 	hlock->references = references;
51438eddac3fSPeter Zijlstra #ifdef CONFIG_LOCK_STAT
51448eddac3fSPeter Zijlstra 	hlock->waittime_stamp = 0;
51450471db44SBoqun Feng 	hlock->holdtime_stamp = lockstat_clock();
51460471db44SBoqun Feng #endif
51470471db44SBoqun Feng 	hlock->pin_count = pin_count;
51480471db44SBoqun Feng 
51498eddac3fSPeter Zijlstra 	if (check_wait_context(curr, hlock))
51508eddac3fSPeter Zijlstra 		return 0;
51518eddac3fSPeter Zijlstra 
51528eddac3fSPeter Zijlstra 	/* Initialize the lock usage bit */
51538eddac3fSPeter Zijlstra 	if (!mark_usage(curr, hlock, check))
51548eddac3fSPeter Zijlstra 		return 0;
51558eddac3fSPeter Zijlstra 
51568eddac3fSPeter Zijlstra 	/*
51578eddac3fSPeter Zijlstra 	 * Calculate the chain hash: it's the combined hash of all the
51588eddac3fSPeter Zijlstra 	 * lock keys along the dependency chain. We save the hash value
51598eddac3fSPeter Zijlstra 	 * at every step so that we can get the current hash easily
51608eddac3fSPeter Zijlstra 	 * after unlock. The chain hash is then used to cache dependency
51618eddac3fSPeter Zijlstra 	 * results.
51628eddac3fSPeter Zijlstra 	 *
51638eddac3fSPeter Zijlstra 	 * The 'key ID' is what is the most compact key value to drive
51648eddac3fSPeter Zijlstra 	 * the hash, not class->key.
51658eddac3fSPeter Zijlstra 	 */
51668eddac3fSPeter Zijlstra 	/*
51678eddac3fSPeter Zijlstra 	 * Whoops, we did it again.. class_idx is invalid.
51688eddac3fSPeter Zijlstra 	 */
51698eddac3fSPeter Zijlstra 	if (DEBUG_LOCKS_WARN_ON(!test_bit(class_idx, lock_classes_in_use)))
51708eddac3fSPeter Zijlstra 		return 0;
51718eddac3fSPeter Zijlstra 
51728eddac3fSPeter Zijlstra 	chain_key = curr->curr_chain_key;
51738eddac3fSPeter Zijlstra 	if (!depth) {
51748eddac3fSPeter Zijlstra 		/*
5175f7c1c6b3SYuyang Du 		 * How can we have a chain hash when we ain't got no keys?!
5176f7c1c6b3SYuyang Du 		 */
51778eddac3fSPeter Zijlstra 		if (DEBUG_LOCKS_WARN_ON(chain_key != INITIAL_CHAIN_KEY))
51788eddac3fSPeter Zijlstra 			return 0;
51798eddac3fSPeter Zijlstra 		chain_head = 1;
5180f7c1c6b3SYuyang Du 	}
51818eddac3fSPeter Zijlstra 
5182f7c1c6b3SYuyang Du 	hlock->prev_chain_key = chain_key;
51838eddac3fSPeter Zijlstra 	if (separate_irq_context(curr, hlock)) {
5184681fbec8SPaul E. McKenney 		chain_key = INITIAL_CHAIN_KEY;
5185a5dd63efSPaul E. McKenney 		chain_head = 1;
5186a5dd63efSPaul E. McKenney 	}
51878eddac3fSPeter Zijlstra 	chain_key = iterate_chain_key(chain_key, hlock_id(hlock));
5188a5dd63efSPaul E. McKenney 
5189681fbec8SPaul E. McKenney 	if (nest_lock && !__lock_is_held(nest_lock, -1)) {
51908eddac3fSPeter Zijlstra 		print_lock_nested_lock_not_held(curr, hlock);
51918eddac3fSPeter Zijlstra 		return 0;
5192681fbec8SPaul E. McKenney 	}
51932062a4e8SDmitry Safonov 
5194681fbec8SPaul E. McKenney 	if (!debug_locks_silent) {
5195681fbec8SPaul E. McKenney 		WARN_ON_ONCE(depth && !hlock_class(hlock - 1)->key);
51968eddac3fSPeter Zijlstra 		WARN_ON_ONCE(!hlock_class(hlock)->key);
51978eddac3fSPeter Zijlstra 	}
5198681fbec8SPaul E. McKenney 
51998eddac3fSPeter Zijlstra 	if (!validate_chain(curr, hlock, chain_head, chain_key))
52008eddac3fSPeter Zijlstra 		return 0;
52018eddac3fSPeter Zijlstra 
5202c86e9b98SPeter Zijlstra 	/* For lock_sync(), we are done here since no actual critical section */
520308f36ff6SMatthew Wilcox 	if (hlock->sync)
52048eddac3fSPeter Zijlstra 		return 1;
52058eddac3fSPeter Zijlstra 
52068eddac3fSPeter Zijlstra 	curr->curr_chain_key = chain_key;
52078eddac3fSPeter Zijlstra 	curr->lockdep_depth++;
52088eddac3fSPeter Zijlstra 	check_chain_key(curr);
520908f36ff6SMatthew Wilcox #ifdef CONFIG_DEBUG_LOCKDEP
52108eddac3fSPeter Zijlstra 	if (unlikely(!debug_locks))
52118eddac3fSPeter Zijlstra 		return 0;
52128eddac3fSPeter Zijlstra #endif
52138eddac3fSPeter Zijlstra 	if (unlikely(curr->lockdep_depth >= MAX_LOCK_DEPTH)) {
52148eddac3fSPeter Zijlstra 		debug_locks_off();
52158eddac3fSPeter Zijlstra 		nbcon_cpu_emergency_enter();
52168eddac3fSPeter Zijlstra 		print_lockdep_off("BUG: MAX_LOCK_DEPTH too low!");
52178eddac3fSPeter Zijlstra 		printk(KERN_DEBUG "depth: %i  max: %lu!\n",
52188eddac3fSPeter Zijlstra 		       curr->lockdep_depth, MAX_LOCK_DEPTH);
52198eddac3fSPeter Zijlstra 
522064f29d1bSMatthew Wilcox 		lockdep_print_held_locks(current);
52218eddac3fSPeter Zijlstra 		debug_show_all_locks();
52228eddac3fSPeter Zijlstra 		dump_stack();
52238eddac3fSPeter Zijlstra 		nbcon_cpu_emergency_exit();
52248eddac3fSPeter Zijlstra 
52258eddac3fSPeter Zijlstra 		return 0;
52268eddac3fSPeter Zijlstra 	}
52278eddac3fSPeter Zijlstra 
52288eddac3fSPeter Zijlstra 	if (unlikely(curr->lockdep_depth > max_lockdep_depth))
52298eddac3fSPeter Zijlstra 		max_lockdep_depth = curr->lockdep_depth;
52308eddac3fSPeter Zijlstra 
523101bb6f0aSYuyang Du 	return 1;
52328eddac3fSPeter Zijlstra }
52338eddac3fSPeter Zijlstra 
print_unlock_imbalance_bug(struct task_struct * curr,struct lockdep_map * lock,unsigned long ip)52348eddac3fSPeter Zijlstra static void print_unlock_imbalance_bug(struct task_struct *curr,
52358eddac3fSPeter Zijlstra 				       struct lockdep_map *lock,
52368eddac3fSPeter Zijlstra 				       unsigned long ip)
52378eddac3fSPeter Zijlstra {
523841c2c5b8SJ. R. Okajima 	if (!debug_locks_off())
523941c2c5b8SJ. R. Okajima 		return;
524041c2c5b8SJ. R. Okajima 	if (debug_locks_silent)
524141c2c5b8SJ. R. Okajima 		return;
524241c2c5b8SJ. R. Okajima 
524341c2c5b8SJ. R. Okajima 	nbcon_cpu_emergency_enter();
524441c2c5b8SJ. R. Okajima 
524541c2c5b8SJ. R. Okajima 	pr_warn("\n");
524641c2c5b8SJ. R. Okajima 	pr_warn("=====================================\n");
524741c2c5b8SJ. R. Okajima 	pr_warn("WARNING: bad unlock balance detected!\n");
524841c2c5b8SJ. R. Okajima 	print_kernel_ident();
524941c2c5b8SJ. R. Okajima 	pr_warn("-------------------------------------\n");
525041c2c5b8SJ. R. Okajima 	pr_warn("%s/%d is trying to release lock (",
525141c2c5b8SJ. R. Okajima 		curr->comm, task_pid_nr(curr));
525241c2c5b8SJ. R. Okajima 	print_lockdep_cache(lock);
525341c2c5b8SJ. R. Okajima 	pr_cont(") at:\n");
525441c2c5b8SJ. R. Okajima 	print_ip_sym(KERN_WARNING, ip);
525541c2c5b8SJ. R. Okajima 	pr_warn("but there are no more locks to release!\n");
525641c2c5b8SJ. R. Okajima 	pr_warn("\nother info that might help us debug this:\n");
525741c2c5b8SJ. R. Okajima 	lockdep_print_held_locks(curr);
525841c2c5b8SJ. R. Okajima 
525941c2c5b8SJ. R. Okajima 	pr_warn("\nstack backtrace:\n");
526041c2c5b8SJ. R. Okajima 	dump_stack();
526141c2c5b8SJ. R. Okajima 
526241c2c5b8SJ. R. Okajima 	nbcon_cpu_emergency_exit();
526341c2c5b8SJ. R. Okajima }
526441c2c5b8SJ. R. Okajima 
match_held_lock(const struct held_lock * hlock,const struct lockdep_map * lock)526541c2c5b8SJ. R. Okajima static noinstr int match_held_lock(const struct held_lock *hlock,
526641c2c5b8SJ. R. Okajima 				   const struct lockdep_map *lock)
526741c2c5b8SJ. R. Okajima {
526841c2c5b8SJ. R. Okajima 	if (hlock->instance == lock)
526941c2c5b8SJ. R. Okajima 		return 1;
527041c2c5b8SJ. R. Okajima 
527141c2c5b8SJ. R. Okajima 	if (hlock->references) {
527241c2c5b8SJ. R. Okajima 		const struct lock_class *class = lock->class_cache[0];
527341c2c5b8SJ. R. Okajima 
5274e969970bSJ. R. Okajima 		if (!class)
52758c8889d8SImre Deak 			class = look_up_lock_class(lock, 0);
5276e969970bSJ. R. Okajima 
5277e969970bSJ. R. Okajima 		/*
52788c8889d8SImre Deak 		 * If look_up_lock_class() failed to find a class, we're trying
5279e969970bSJ. R. Okajima 		 * to test if we hold a lock that has never yet been acquired.
52808ee10862SWaiman Long 		 * Clearly if the lock hasn't been acquired _ever_, we're not
52818ee10862SWaiman Long 		 * holding it either, so report failure.
52828ee10862SWaiman Long 		 */
5283e969970bSJ. R. Okajima 		if (!class)
52848c8889d8SImre Deak 			return 0;
5285e969970bSJ. R. Okajima 
5286e969970bSJ. R. Okajima 		/*
5287e969970bSJ. R. Okajima 		 * References, but not a lock we're actually ref-counting?
5288e969970bSJ. R. Okajima 		 * State got messed up, follow the sites that change ->references
5289e969970bSJ. R. Okajima 		 * and try to make sense of it.
52900471db44SBoqun Feng 		 */
52918c8889d8SImre Deak 		if (DEBUG_LOCKS_WARN_ON(!hlock->nest_lock))
5292e969970bSJ. R. Okajima 			return 0;
52938c8889d8SImre Deak 
52948c8889d8SImre Deak 		if (hlock->class_idx == class - lock_classes)
52958c8889d8SImre Deak 			return 1;
52968c8889d8SImre Deak 	}
52978c8889d8SImre Deak 
52988c8889d8SImre Deak 	return 0;
52998c8889d8SImre Deak }
53008c8889d8SImre Deak 
53018c8889d8SImre Deak /* @depth must not be zero */
find_held_lock(struct task_struct * curr,struct lockdep_map * lock,unsigned int depth,int * idx)5302e969970bSJ. R. Okajima static struct held_lock *find_held_lock(struct task_struct *curr,
5303e969970bSJ. R. Okajima 					struct lockdep_map *lock,
5304e969970bSJ. R. Okajima 					unsigned int depth, int *idx)
5305e969970bSJ. R. Okajima {
53068eddac3fSPeter Zijlstra 	struct held_lock *ret, *hlock, *prev_hlock;
53078eddac3fSPeter Zijlstra 	int i;
53088eddac3fSPeter Zijlstra 
53098eddac3fSPeter Zijlstra 	i = depth - 1;
53108eddac3fSPeter Zijlstra 	hlock = curr->held_locks + i;
53118eddac3fSPeter Zijlstra 	ret = hlock;
53128c8889d8SImre Deak 	if (match_held_lock(hlock, lock))
531341c2c5b8SJ. R. Okajima 		goto out;
53148eddac3fSPeter Zijlstra 
53158eddac3fSPeter Zijlstra 	ret = NULL;
53168eddac3fSPeter Zijlstra 	for (i--, prev_hlock = hlock--;
5317513e1073SWaiman Long 	     i >= 0;
5318513e1073SWaiman Long 	     i--, prev_hlock = hlock--) {
5319513e1073SWaiman Long 		/*
53208eddac3fSPeter Zijlstra 		 * We must not cross into another context:
53218eddac3fSPeter Zijlstra 		 */
53228eddac3fSPeter Zijlstra 		if (prev_hlock->irq_context != hlock->irq_context) {
53238eddac3fSPeter Zijlstra 			ret = NULL;
53248eddac3fSPeter Zijlstra 			break;
53258eddac3fSPeter Zijlstra 		}
53268eddac3fSPeter Zijlstra 		if (match_held_lock(hlock, lock)) {
53278eddac3fSPeter Zijlstra 			ret = hlock;
532841c2c5b8SJ. R. Okajima 			break;
5329f7c1c6b3SYuyang Du 		}
5330f7c1c6b3SYuyang Du 	}
5331f7c1c6b3SYuyang Du 
5332f7c1c6b3SYuyang Du out:
53338eddac3fSPeter Zijlstra 	*idx = i;
5334eae6d58dSPeter Zijlstra 	return ret;
5335de8f5e4fSPeter Zijlstra }
5336eae6d58dSPeter Zijlstra 
reacquire_held_locks(struct task_struct * curr,unsigned int depth,int idx,unsigned int * merged)5337eae6d58dSPeter Zijlstra static int reacquire_held_locks(struct task_struct *curr, unsigned int depth,
53388eddac3fSPeter Zijlstra 				int idx, unsigned int *merged)
533901bb6f0aSYuyang Du {
53408eddac3fSPeter Zijlstra 	struct held_lock *hlock;
53418eddac3fSPeter Zijlstra 	int first_idx = idx;
53428eddac3fSPeter Zijlstra 
53438eddac3fSPeter Zijlstra 	if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
53448c8889d8SImre Deak 		return 0;
53458eddac3fSPeter Zijlstra 
53468eddac3fSPeter Zijlstra 	for (hlock = curr->held_locks + idx; idx < depth; idx++, hlock++) {
53478eddac3fSPeter Zijlstra 		switch (__lock_acquire(hlock->instance,
53488eddac3fSPeter Zijlstra 				    hlock_class(hlock)->subclass,
53498eddac3fSPeter Zijlstra 				    hlock->trylock,
53508eddac3fSPeter Zijlstra 				    hlock->read, hlock->check,
53518c8889d8SImre Deak 				    hlock->hardirqs_off,
53528eddac3fSPeter Zijlstra 				    hlock->nest_lock, hlock->acquire_ip,
53538eddac3fSPeter Zijlstra 				    hlock->references, hlock->pin_count, 0)) {
53548eddac3fSPeter Zijlstra 		case 0:
53558eddac3fSPeter Zijlstra 			return 1;
53566419c4afSJ. R. Okajima 		case 1:
53576419c4afSJ. R. Okajima 			break;
53586419c4afSJ. R. Okajima 		case 2:
53598c8889d8SImre Deak 			*merged += (idx == first_idx);
53606419c4afSJ. R. Okajima 			break;
53616419c4afSJ. R. Okajima 		default:
53626419c4afSJ. R. Okajima 			WARN_ON(1);
536371492580SWaiman Long 			return 0;
536471492580SWaiman Long 		}
536571492580SWaiman Long 	}
53666419c4afSJ. R. Okajima 	return 0;
53676419c4afSJ. R. Okajima }
53686419c4afSJ. R. Okajima 
53696419c4afSJ. R. Okajima static int
__lock_set_class(struct lockdep_map * lock,const char * name,struct lock_class_key * key,unsigned int subclass,unsigned long ip)53706419c4afSJ. R. Okajima __lock_set_class(struct lockdep_map *lock, const char *name,
53716419c4afSJ. R. Okajima 		 struct lock_class_key *key, unsigned int subclass,
53726419c4afSJ. R. Okajima 		 unsigned long ip)
53736419c4afSJ. R. Okajima {
53746419c4afSJ. R. Okajima 	struct task_struct *curr = current;
5375f7c1c6b3SYuyang Du 	unsigned int depth, merged = 0;
5376f7c1c6b3SYuyang Du 	struct held_lock *hlock;
5377f7c1c6b3SYuyang Du 	struct lock_class *class;
5378f7c1c6b3SYuyang Du 	int i;
53796419c4afSJ. R. Okajima 
53806419c4afSJ. R. Okajima 	if (unlikely(!debug_locks))
53816419c4afSJ. R. Okajima 		return 0;
53826419c4afSJ. R. Okajima 
53836419c4afSJ. R. Okajima 	depth = curr->lockdep_depth;
53846419c4afSJ. R. Okajima 	/*
53856419c4afSJ. R. Okajima 	 * This function is about (re)setting the class of a held lock,
53866419c4afSJ. R. Okajima 	 * yet we're not actually holding any locks. Naughty user!
53878c8889d8SImre Deak 	 */
53888c8889d8SImre Deak 	if (DEBUG_LOCKS_WARN_ON(!depth))
53898c8889d8SImre Deak 		return 0;
53908c8889d8SImre Deak 
53918c8889d8SImre Deak 	hlock = find_held_lock(curr, lock, depth, &i);
53926419c4afSJ. R. Okajima 	if (!hlock) {
53936419c4afSJ. R. Okajima 		print_unlock_imbalance_bug(curr, lock, ip);
53946419c4afSJ. R. Okajima 		return 0;
53956419c4afSJ. R. Okajima 	}
53966419c4afSJ. R. Okajima 
53976419c4afSJ. R. Okajima 	lockdep_init_map_type(lock, name, key, 0,
53986419c4afSJ. R. Okajima 			      lock->wait_type_inner,
53996419c4afSJ. R. Okajima 			      lock->wait_type_outer,
54008c8889d8SImre Deak 			      lock->lock_type);
54016419c4afSJ. R. Okajima 	class = register_lock_class(lock, subclass, 0);
54026419c4afSJ. R. Okajima 	hlock->class_idx = class - lock_classes;
54036419c4afSJ. R. Okajima 
54048eddac3fSPeter Zijlstra 	curr->lockdep_depth = i;
5405c759bc47SDan Carpenter 	curr->curr_chain_key = hlock->prev_chain_key;
5406e0f56fd7SPeter Zijlstra 
5407e0f56fd7SPeter Zijlstra 	if (reacquire_held_locks(curr, depth, i, &merged))
54088eddac3fSPeter Zijlstra 		return 0;
54098eddac3fSPeter Zijlstra 
5410b4adfe8eSYuyang Du 	/*
54118eddac3fSPeter Zijlstra 	 * I took it apart and put it back together again, except now I have
5412e0f56fd7SPeter Zijlstra 	 * these 'spare' parts.. where shall I put them.
54138c8889d8SImre Deak 	 */
541441c2c5b8SJ. R. Okajima 	if (DEBUG_LOCKS_WARN_ON(curr->lockdep_depth != depth - merged))
5415e966eaeeSIngo Molnar 		return 0;
54168eddac3fSPeter Zijlstra 	return 1;
5417e0f56fd7SPeter Zijlstra }
5418e0f56fd7SPeter Zijlstra 
__lock_downgrade(struct lockdep_map * lock,unsigned long ip)5419e0f56fd7SPeter Zijlstra static int __lock_downgrade(struct lockdep_map *lock, unsigned long ip)
54208eddac3fSPeter Zijlstra {
54218eddac3fSPeter Zijlstra 	struct task_struct *curr = current;
54228eddac3fSPeter Zijlstra 	unsigned int depth, merged = 0;
54238eddac3fSPeter Zijlstra 	struct held_lock *hlock;
54248eddac3fSPeter Zijlstra 	int i;
5425dd471efeSKobe Wu 
5426f7c1c6b3SYuyang Du 	if (unlikely(!debug_locks))
5427f7c1c6b3SYuyang Du 		return 0;
5428f7c1c6b3SYuyang Du 
54298eddac3fSPeter Zijlstra 	depth = curr->lockdep_depth;
5430e0f56fd7SPeter Zijlstra 	/*
5431e0f56fd7SPeter Zijlstra 	 * This function is about (re)setting the class of a held lock,
5432e0f56fd7SPeter Zijlstra 	 * yet we're not actually holding any locks. Naughty user!
5433e0f56fd7SPeter Zijlstra 	 */
543441c2c5b8SJ. R. Okajima 	if (DEBUG_LOCKS_WARN_ON(!depth))
5435f7c1c6b3SYuyang Du 		return 0;
5436f7c1c6b3SYuyang Du 
5437f7c1c6b3SYuyang Du 	hlock = find_held_lock(curr, lock, depth, &i);
5438f7c1c6b3SYuyang Du 	if (!hlock) {
54398eddac3fSPeter Zijlstra 		print_unlock_imbalance_bug(curr, lock, ip);
54408eddac3fSPeter Zijlstra 		return 0;
54418eddac3fSPeter Zijlstra 	}
54428eddac3fSPeter Zijlstra 
5443a24fc60dSPeter Zijlstra 	curr->lockdep_depth = i;
5444a24fc60dSPeter Zijlstra 	curr->curr_chain_key = hlock->prev_chain_key;
54458eddac3fSPeter Zijlstra 
54468eddac3fSPeter Zijlstra 	WARN(hlock->read, "downgrading a read lock");
54478eddac3fSPeter Zijlstra 	hlock->read = 1;
54488eddac3fSPeter Zijlstra 	hlock->acquire_ip = ip;
54498eddac3fSPeter Zijlstra 
54508eddac3fSPeter Zijlstra 	if (reacquire_held_locks(curr, depth, i, &merged))
54518eddac3fSPeter Zijlstra 		return 0;
54528eddac3fSPeter Zijlstra 
54538eddac3fSPeter Zijlstra 	/* Merging can't happen with unchanged classes.. */
54548eddac3fSPeter Zijlstra 	if (DEBUG_LOCKS_WARN_ON(merged))
54558eddac3fSPeter Zijlstra 		return 0;
54568eddac3fSPeter Zijlstra 
54578eddac3fSPeter Zijlstra 	/*
54588eddac3fSPeter Zijlstra 	 * I took it apart and put it back together again, except now I have
54598eddac3fSPeter Zijlstra 	 * these 'spare' parts.. where shall I put them.
54608eddac3fSPeter Zijlstra 	 */
54618eddac3fSPeter Zijlstra 	if (DEBUG_LOCKS_WARN_ON(curr->lockdep_depth != depth))
54628eddac3fSPeter Zijlstra 		return 0;
54638eddac3fSPeter Zijlstra 
54648eddac3fSPeter Zijlstra 	return 1;
54658eddac3fSPeter Zijlstra }
5466ce52a18dSWaiman Long 
5467ce52a18dSWaiman Long /*
5468ce52a18dSWaiman Long  * Remove the lock from the list of currently held locks - this gets
5469ce52a18dSWaiman Long  * called on mutex_unlock()/spin_unlock*() (or on a failed
5470ce52a18dSWaiman Long  * mutex_lock_interruptible()).
5471ce52a18dSWaiman Long  */
5472ce52a18dSWaiman Long static int
__lock_release(struct lockdep_map * lock,unsigned long ip)54738c8889d8SImre Deak __lock_release(struct lockdep_map *lock, unsigned long ip)
54748eddac3fSPeter Zijlstra {
54758eddac3fSPeter Zijlstra 	struct task_struct *curr = current;
54768eddac3fSPeter Zijlstra 	unsigned int depth, merged = 1;
54778eddac3fSPeter Zijlstra 	struct held_lock *hlock;
54788eddac3fSPeter Zijlstra 	int i;
54798c8889d8SImre Deak 
54808eddac3fSPeter Zijlstra 	if (unlikely(!debug_locks))
54818c8889d8SImre Deak 		return 0;
5482e0f56fd7SPeter Zijlstra 
5483ce52a18dSWaiman Long 	depth = curr->lockdep_depth;
5484ce52a18dSWaiman Long 	/*
5485ce52a18dSWaiman Long 	 * So we're all set to release this lock.. wait what lock? We don't
5486ce52a18dSWaiman Long 	 * own any locks, you've been drinking again?
5487ce52a18dSWaiman Long 	 */
5488ce52a18dSWaiman Long 	if (depth <= 0) {
54898eddac3fSPeter Zijlstra 		print_unlock_imbalance_bug(curr, lock, ip);
54908eddac3fSPeter Zijlstra 		return 0;
5491c86e9b98SPeter Zijlstra 	}
54922f43c602SMasami Hiramatsu 
54938eddac3fSPeter Zijlstra 	/*
54948eddac3fSPeter Zijlstra 	 * Check whether the lock exists in the current stack
54958eddac3fSPeter Zijlstra 	 * of held locks:
54968eddac3fSPeter Zijlstra 	 */
54978eddac3fSPeter Zijlstra 	hlock = find_held_lock(curr, lock, depth, &i);
54988eddac3fSPeter Zijlstra 	if (!hlock) {
54998eddac3fSPeter Zijlstra 		print_unlock_imbalance_bug(curr, lock, ip);
5500f8319483SPeter Zijlstra 		return 0;
55012507003aSSebastian Andrzej Siewior 	}
5502f8cfa466SShuah Khan 
5503f8319483SPeter Zijlstra 	if (hlock->instance == lock)
5504f8cfa466SShuah Khan 		lock_release_holdtime(hlock);
5505f8319483SPeter Zijlstra 
55068eddac3fSPeter Zijlstra 	WARN(hlock->pin_count, "releasing a pinned lock\n");
55078eddac3fSPeter Zijlstra 
5508f8cfa466SShuah Khan 	if (hlock->references) {
55098eddac3fSPeter Zijlstra 		hlock->references--;
55108eddac3fSPeter Zijlstra 		if (hlock->references) {
5511e7904a28SPeter Zijlstra 			/*
5512e7904a28SPeter Zijlstra 			 * We had, and after removing one, still have
5513e7904a28SPeter Zijlstra 			 * references, the current lock stack is still
5514e7904a28SPeter Zijlstra 			 * valid. We're done!
5515e7904a28SPeter Zijlstra 			 */
5516e7904a28SPeter Zijlstra 			return 1;
5517e7904a28SPeter Zijlstra 		}
5518e7904a28SPeter Zijlstra 	}
5519e7904a28SPeter Zijlstra 
5520e7904a28SPeter Zijlstra 	/*
5521e7904a28SPeter Zijlstra 	 * We have the right lock to unlock, 'hlock' points to it.
5522e7904a28SPeter Zijlstra 	 * Now we remove it from the stack, and add back the other
5523e7904a28SPeter Zijlstra 	 * entries (if any), recalculating the hash along the way:
5524e7904a28SPeter Zijlstra 	 */
5525e7904a28SPeter Zijlstra 
5526e7904a28SPeter Zijlstra 	curr->lockdep_depth = i;
5527e7904a28SPeter Zijlstra 	curr->curr_chain_key = hlock->prev_chain_key;
5528e7904a28SPeter Zijlstra 
55294051a817SSebastian Andrzej Siewior 	/*
5530e7904a28SPeter Zijlstra 	 * The most likely case is when the unlock is on the innermost
5531e7904a28SPeter Zijlstra 	 * lock. In this case, we are done!
5532e7904a28SPeter Zijlstra 	 */
5533e7904a28SPeter Zijlstra 	if (i == depth-1)
5534e7904a28SPeter Zijlstra 		return 1;
5535e7904a28SPeter Zijlstra 
5536e7904a28SPeter Zijlstra 	if (reacquire_held_locks(curr, depth, i + 1, &merged))
5537e7904a28SPeter Zijlstra 		return 0;
5538e7904a28SPeter Zijlstra 
5539e7904a28SPeter Zijlstra 	/*
5540a24fc60dSPeter Zijlstra 	 * We had N bottles of beer on the wall, we drank one, but now
5541a24fc60dSPeter Zijlstra 	 * there's not N-1 bottles of beer left on the wall...
5542a24fc60dSPeter Zijlstra 	 * Pouring two of the bottles together is acceptable.
5543a24fc60dSPeter Zijlstra 	 */
5544a24fc60dSPeter Zijlstra 	DEBUG_LOCKS_WARN_ON(curr->lockdep_depth != depth - merged);
5545a24fc60dSPeter Zijlstra 
5546a24fc60dSPeter Zijlstra 	/*
5547a24fc60dSPeter Zijlstra 	 * Since reacquire_held_locks() would have called check_chain_key()
5548a24fc60dSPeter Zijlstra 	 * indirectly via __lock_acquire(), we don't need to do it again
5549a24fc60dSPeter Zijlstra 	 * on return.
5550a24fc60dSPeter Zijlstra 	 */
5551e7904a28SPeter Zijlstra 	return 0;
5552a24fc60dSPeter Zijlstra }
5553a24fc60dSPeter Zijlstra 
5554a24fc60dSPeter Zijlstra static __always_inline
__lock_is_held(const struct lockdep_map * lock,int read)5555a24fc60dSPeter Zijlstra int __lock_is_held(const struct lockdep_map *lock, int read)
5556a24fc60dSPeter Zijlstra {
5557a24fc60dSPeter Zijlstra 	struct task_struct *curr = current;
5558a24fc60dSPeter Zijlstra 	int i;
5559e7904a28SPeter Zijlstra 
5560a24fc60dSPeter Zijlstra 	for (i = 0; i < curr->lockdep_depth; i++) {
5561a24fc60dSPeter Zijlstra 		struct held_lock *hlock = curr->held_locks + i;
5562a24fc60dSPeter Zijlstra 
5563a24fc60dSPeter Zijlstra 		if (match_held_lock(hlock, lock)) {
5564a24fc60dSPeter Zijlstra 			if (read == -1 || !!hlock->read == read)
5565a24fc60dSPeter Zijlstra 				return LOCK_STATE_HELD;
5566a24fc60dSPeter Zijlstra 
5567a24fc60dSPeter Zijlstra 			return LOCK_STATE_NOT_HELD;
5568a24fc60dSPeter Zijlstra 		}
5569a24fc60dSPeter Zijlstra 	}
5570a24fc60dSPeter Zijlstra 
5571a24fc60dSPeter Zijlstra 	return LOCK_STATE_NOT_HELD;
5572a24fc60dSPeter Zijlstra }
5573a24fc60dSPeter Zijlstra 
__lock_pin_lock(struct lockdep_map * lock)5574e7904a28SPeter Zijlstra static struct pin_cookie __lock_pin_lock(struct lockdep_map *lock)
5575e7904a28SPeter Zijlstra {
5576e7904a28SPeter Zijlstra 	struct pin_cookie cookie = NIL_COOKIE;
5577e7904a28SPeter Zijlstra 	struct task_struct *curr = current;
5578e7904a28SPeter Zijlstra 	int i;
5579a24fc60dSPeter Zijlstra 
5580a24fc60dSPeter Zijlstra 	if (unlikely(!debug_locks))
5581a24fc60dSPeter Zijlstra 		return cookie;
5582a24fc60dSPeter Zijlstra 
5583a24fc60dSPeter Zijlstra 	for (i = 0; i < curr->lockdep_depth; i++) {
5584a24fc60dSPeter Zijlstra 		struct held_lock *hlock = curr->held_locks + i;
5585a24fc60dSPeter Zijlstra 
55868eddac3fSPeter Zijlstra 		if (match_held_lock(hlock, lock)) {
55878eddac3fSPeter Zijlstra 			/*
55888eddac3fSPeter Zijlstra 			 * Grab 16bits of randomness; this is sufficient to not
558977ca93a6SPeter Zijlstra 			 * be guessable and still allows some pin nesting in
55908eddac3fSPeter Zijlstra 			 * our u32 pin_count.
559130a35f79SArnd Bergmann 			 */
55928eddac3fSPeter Zijlstra 			cookie.val = 1 + (sched_clock() & 0xffff);
55938eddac3fSPeter Zijlstra 			hlock->pin_count += cookie.val;
55948eddac3fSPeter Zijlstra 			return cookie;
559577ca93a6SPeter Zijlstra 		}
559677ca93a6SPeter Zijlstra 	}
559777ca93a6SPeter Zijlstra 
55988eddac3fSPeter Zijlstra 	WARN(1, "pinning an unheld lock\n");
5599f9ad4a5fSPeter Zijlstra 	return cookie;
56008eddac3fSPeter Zijlstra }
56018eddac3fSPeter Zijlstra 
__lock_repin_lock(struct lockdep_map * lock,struct pin_cookie cookie)56028eddac3fSPeter Zijlstra static void __lock_repin_lock(struct lockdep_map *lock, struct pin_cookie cookie)
5603f9ad4a5fSPeter Zijlstra {
56048eddac3fSPeter Zijlstra 	struct task_struct *curr = current;
56058eddac3fSPeter Zijlstra 	int i;
56068eddac3fSPeter Zijlstra 
56078eddac3fSPeter Zijlstra 	if (unlikely(!debug_locks))
56080c1d7a2cSThomas Gleixner 		return;
56098eddac3fSPeter Zijlstra 
56108eddac3fSPeter Zijlstra 	for (i = 0; i < curr->lockdep_depth; i++) {
56118eddac3fSPeter Zijlstra 		struct held_lock *hlock = curr->held_locks + i;
56128eddac3fSPeter Zijlstra 
56138eddac3fSPeter Zijlstra 		if (match_held_lock(hlock, lock)) {
56148eddac3fSPeter Zijlstra 			hlock->pin_count += cookie.val;
56158eddac3fSPeter Zijlstra 			return;
56168eddac3fSPeter Zijlstra 		}
56178eddac3fSPeter Zijlstra 	}
56188eddac3fSPeter Zijlstra 
56198eddac3fSPeter Zijlstra 	WARN(1, "pinning an unheld lock\n");
56208eddac3fSPeter Zijlstra }
56218eddac3fSPeter Zijlstra 
__lock_unpin_lock(struct lockdep_map * lock,struct pin_cookie cookie)56228eddac3fSPeter Zijlstra static void __lock_unpin_lock(struct lockdep_map *lock, struct pin_cookie cookie)
56230c1d7a2cSThomas Gleixner {
56248eddac3fSPeter Zijlstra 	struct task_struct *curr = current;
56258eddac3fSPeter Zijlstra 	int i;
56268eddac3fSPeter Zijlstra 
562777ca93a6SPeter Zijlstra 	if (unlikely(!debug_locks))
562877ca93a6SPeter Zijlstra 		return;
56298eddac3fSPeter Zijlstra 
56308eddac3fSPeter Zijlstra 	for (i = 0; i < curr->lockdep_depth; i++) {
56318eddac3fSPeter Zijlstra 		struct held_lock *hlock = curr->held_locks + i;
56328eddac3fSPeter Zijlstra 
56338eddac3fSPeter Zijlstra 		if (match_held_lock(hlock, lock)) {
56348eddac3fSPeter Zijlstra 			if (WARN(!hlock->pin_count, "unpinning an unpinned lock\n"))
56358eddac3fSPeter Zijlstra 				return;
56368eddac3fSPeter Zijlstra 
56378eddac3fSPeter Zijlstra 			hlock->pin_count -= cookie.val;
56384d004099SPeter Zijlstra 
56398eddac3fSPeter Zijlstra 			if (WARN((int)hlock->pin_count < 0, "pin count corrupted\n"))
56408eddac3fSPeter Zijlstra 				hlock->pin_count = 0;
56418eddac3fSPeter Zijlstra 
56424d004099SPeter Zijlstra 			return;
56438eddac3fSPeter Zijlstra 		}
56448eddac3fSPeter Zijlstra 	}
56458eddac3fSPeter Zijlstra 
564610476e63SPeter Zijlstra 	WARN(1, "unpinning an unheld lock\n");
56478eddac3fSPeter Zijlstra }
56488eddac3fSPeter Zijlstra 
56498eddac3fSPeter Zijlstra /*
56508eddac3fSPeter Zijlstra  * Check whether we follow the irq-flags state precisely:
56516419c4afSJ. R. Okajima  */
check_flags(unsigned long flags)56526419c4afSJ. R. Okajima static noinstr void check_flags(unsigned long flags)
56536419c4afSJ. R. Okajima {
56546419c4afSJ. R. Okajima #if defined(CONFIG_PROVE_LOCKING) && defined(CONFIG_DEBUG_LOCKDEP)
56554d004099SPeter Zijlstra 	if (!debug_locks)
56566419c4afSJ. R. Okajima 		return;
56576419c4afSJ. R. Okajima 
56586419c4afSJ. R. Okajima 	/* Get the warning out..  */
56594d004099SPeter Zijlstra 	instrumentation_begin();
56606419c4afSJ. R. Okajima 
56616419c4afSJ. R. Okajima 	if (irqs_disabled_flags(flags)) {
56626419c4afSJ. R. Okajima 		if (DEBUG_LOCKS_WARN_ON(lockdep_hardirqs_enabled())) {
566310476e63SPeter Zijlstra 			printk("possible reason: unannotated irqs-off.\n");
56646419c4afSJ. R. Okajima 		}
56656419c4afSJ. R. Okajima 	} else {
56666419c4afSJ. R. Okajima 		if (DEBUG_LOCKS_WARN_ON(!lockdep_hardirqs_enabled())) {
56676419c4afSJ. R. Okajima 			printk("possible reason: unannotated irqs-on.\n");
5668f6f48e18SPeter Zijlstra 		}
5669f6f48e18SPeter Zijlstra 	}
5670f6f48e18SPeter Zijlstra 
5671f6f48e18SPeter Zijlstra #ifndef CONFIG_PREEMPT_RT
5672f6f48e18SPeter Zijlstra 	/*
567323870f12Speterz@infradead.org 	 * We dont accurately track softirq state in e.g.
5674f6f48e18SPeter Zijlstra 	 * hardirq contexts (such as on 4KSTACKS), so only
5675f6f48e18SPeter Zijlstra 	 * check if not in hardirq contexts:
5676f6f48e18SPeter Zijlstra 	 */
5677f6f48e18SPeter Zijlstra 	if (!hardirq_count()) {
5678f6f48e18SPeter Zijlstra 		if (softirq_count()) {
567923870f12Speterz@infradead.org 			/* like the above, but with softirqs */
568023870f12Speterz@infradead.org 			DEBUG_LOCKS_WARN_ON(current->softirqs_enabled);
568123870f12Speterz@infradead.org 		} else {
568223870f12Speterz@infradead.org 			/* lick the above, does it taste good? */
568323870f12Speterz@infradead.org 			DEBUG_LOCKS_WARN_ON(!current->softirqs_enabled);
568423870f12Speterz@infradead.org 		}
568523870f12Speterz@infradead.org 	}
568623870f12Speterz@infradead.org #endif
5687f6f48e18SPeter Zijlstra 
5688f6f48e18SPeter Zijlstra 	if (!debug_locks)
5689f6f48e18SPeter Zijlstra 		print_irqtrace_events(current);
5690f6f48e18SPeter Zijlstra 
5691f6f48e18SPeter Zijlstra 	instrumentation_end();
5692f6f48e18SPeter Zijlstra #endif
5693f6f48e18SPeter Zijlstra }
5694f6f48e18SPeter Zijlstra 
lock_set_class(struct lockdep_map * lock,const char * name,struct lock_class_key * key,unsigned int subclass,unsigned long ip)5695f6f48e18SPeter Zijlstra void lock_set_class(struct lockdep_map *lock, const char *name,
5696f6f48e18SPeter Zijlstra 		    struct lock_class_key *key, unsigned int subclass,
56974d004099SPeter Zijlstra 		    unsigned long ip)
5698f6f48e18SPeter Zijlstra {
5699f6f48e18SPeter Zijlstra 	unsigned long flags;
5700f6f48e18SPeter Zijlstra 
5701f6f48e18SPeter Zijlstra 	if (unlikely(!lockdep_enabled()))
5702f6f48e18SPeter Zijlstra 		return;
5703f6f48e18SPeter Zijlstra 
5704f6f48e18SPeter Zijlstra 	raw_local_irq_save(flags);
5705f6f48e18SPeter Zijlstra 	lockdep_recursion_inc();
57068eddac3fSPeter Zijlstra 	check_flags(flags);
5707e9181886SBoqun Feng 	if (__lock_set_class(lock, name, key, subclass, ip))
5708e9181886SBoqun Feng 		check_chain_key(current);
5709e9181886SBoqun Feng 	lockdep_recursion_finish();
5710e9181886SBoqun Feng 	raw_local_irq_restore(flags);
5711e9181886SBoqun Feng }
5712e9181886SBoqun Feng EXPORT_SYMBOL_GPL(lock_set_class);
5713e9181886SBoqun Feng 
lock_downgrade(struct lockdep_map * lock,unsigned long ip)5714e9181886SBoqun Feng void lock_downgrade(struct lockdep_map *lock, unsigned long ip)
5715e9181886SBoqun Feng {
5716e9181886SBoqun Feng 	unsigned long flags;
5717e9181886SBoqun Feng 
5718e9181886SBoqun Feng 	if (unlikely(!lockdep_enabled()))
5719e9181886SBoqun Feng 		return;
5720e9181886SBoqun Feng 
57218eddac3fSPeter Zijlstra 	raw_local_irq_save(flags);
57228eddac3fSPeter Zijlstra 	lockdep_recursion_inc();
57238eddac3fSPeter Zijlstra 	check_flags(flags);
57248eddac3fSPeter Zijlstra 	if (__lock_downgrade(lock, ip))
57258eddac3fSPeter Zijlstra 		check_chain_key(current);
57268eddac3fSPeter Zijlstra 	lockdep_recursion_finish();
57278eddac3fSPeter Zijlstra 	raw_local_irq_restore(flags);
57288eddac3fSPeter Zijlstra }
57298eddac3fSPeter Zijlstra EXPORT_SYMBOL_GPL(lock_downgrade);
5730eb1f0023SPeter Zijlstra 
5731eb1f0023SPeter Zijlstra /* NMI context !!! */
verify_lock_unused(struct lockdep_map * lock,struct held_lock * hlock,int subclass)57324d004099SPeter Zijlstra static void verify_lock_unused(struct lockdep_map *lock, struct held_lock *hlock, int subclass)
57334d004099SPeter Zijlstra {
57344d004099SPeter Zijlstra #ifdef CONFIG_PROVE_LOCKING
57354d004099SPeter Zijlstra 	struct lock_class *class = look_up_lock_class(lock, subclass);
5736f6f48e18SPeter Zijlstra 	unsigned long mask = LOCKF_USED;
5737f6f48e18SPeter Zijlstra 
5738f6f48e18SPeter Zijlstra 	/* if it doesn't have a class (yet), it certainly hasn't been used yet */
5739f6f48e18SPeter Zijlstra 	if (!class)
5740f6f48e18SPeter Zijlstra 		return;
5741f6f48e18SPeter Zijlstra 
5742f6f48e18SPeter Zijlstra 	/*
5743f6f48e18SPeter Zijlstra 	 * READ locks only conflict with USED, such that if we only ever use
5744f6f48e18SPeter Zijlstra 	 * READ locks, there is no deadlock possible -- RCU.
5745f6f48e18SPeter Zijlstra 	 */
5746f6f48e18SPeter Zijlstra 	if (!hlock->read)
5747f6f48e18SPeter Zijlstra 		mask |= LOCKF_USED_READ;
5748f6f48e18SPeter Zijlstra 
5749f6f48e18SPeter Zijlstra 	if (!(class->usage_mask & mask))
5750f6f48e18SPeter Zijlstra 		return;
5751f6f48e18SPeter Zijlstra 
57528eddac3fSPeter Zijlstra 	hlock->class_idx = class - lock_classes;
5753f6f48e18SPeter Zijlstra 
57548eddac3fSPeter Zijlstra 	print_usage_bug(current, hlock, LOCK_USED, LOCK_USAGE_STATES);
57558eddac3fSPeter Zijlstra #endif
57568eddac3fSPeter Zijlstra }
57578eddac3fSPeter Zijlstra 
lockdep_nmi(void)57584d004099SPeter Zijlstra static bool lockdep_nmi(void)
57598eddac3fSPeter Zijlstra {
57600471db44SBoqun Feng 	if (raw_cpu_read(lockdep_recursion))
576110476e63SPeter Zijlstra 		return false;
57628eddac3fSPeter Zijlstra 
57638eddac3fSPeter Zijlstra 	if (!in_nmi())
57648eddac3fSPeter Zijlstra 		return false;
57658eddac3fSPeter Zijlstra 
57665facae4fSQian Cai 	return true;
57678eddac3fSPeter Zijlstra }
57688eddac3fSPeter Zijlstra 
57698eddac3fSPeter Zijlstra /*
5770eb1f0023SPeter Zijlstra  * read_lock() is recursive if:
5771eb1f0023SPeter Zijlstra  * 1. We force lockdep think this way in selftests or
57721a616c2fSKent Overstreet  * 2. The implementation is not queued read/write lock or
57731a616c2fSKent Overstreet  * 3. The locker is at an in_interrupt() context.
57748eddac3fSPeter Zijlstra  */
read_lock_is_recursive(void)57758eddac3fSPeter Zijlstra bool read_lock_is_recursive(void)
57768eddac3fSPeter Zijlstra {
57778eddac3fSPeter Zijlstra 	return force_read_lock_recursive ||
5778eb1f0023SPeter Zijlstra 	       !IS_ENABLED(CONFIG_QUEUED_RWLOCKS) ||
57794d004099SPeter Zijlstra 	       in_interrupt();
5780b4adfe8eSYuyang Du }
5781e0f56fd7SPeter Zijlstra EXPORT_SYMBOL_GPL(read_lock_is_recursive);
578210476e63SPeter Zijlstra 
57838eddac3fSPeter Zijlstra /*
57848eddac3fSPeter Zijlstra  * We are not always called with irqs disabled - do that here,
57858eddac3fSPeter Zijlstra  * and also avoid lockdep recursion:
57868eddac3fSPeter Zijlstra  */
lock_acquire(struct lockdep_map * lock,unsigned int subclass,int trylock,int read,int check,struct lockdep_map * nest_lock,unsigned long ip)57872f1f043eSBoqun Feng void lock_acquire(struct lockdep_map *lock, unsigned int subclass,
57882f1f043eSBoqun Feng 			  int trylock, int read, int check,
57892f1f043eSBoqun Feng 			  struct lockdep_map *nest_lock, unsigned long ip)
57902f1f043eSBoqun Feng {
57912f1f043eSBoqun Feng 	unsigned long flags;
57922f1f043eSBoqun Feng 
57932f1f043eSBoqun Feng 	trace_lock_acquire(lock, subclass, trylock, read, check, nest_lock, ip);
57942f1f043eSBoqun Feng 
57952f1f043eSBoqun Feng 	if (!debug_locks)
57962f1f043eSBoqun Feng 		return;
57972f1f043eSBoqun Feng 
57982f1f043eSBoqun Feng 	if (unlikely(!lockdep_enabled())) {
57992f1f043eSBoqun Feng 		/* XXX allow trylock from NMI ?!? */
58002f1f043eSBoqun Feng 		if (lockdep_nmi() && !trylock) {
58012f1f043eSBoqun Feng 			struct held_lock hlock;
58022f1f043eSBoqun Feng 
58032f1f043eSBoqun Feng 			hlock.acquire_ip = ip;
58042f1f043eSBoqun Feng 			hlock.instance = lock;
58052f1f043eSBoqun Feng 			hlock.nest_lock = nest_lock;
58062f1f043eSBoqun Feng 			hlock.irq_context = 2; // XXX
58070471db44SBoqun Feng 			hlock.trylock = trylock;
58080471db44SBoqun Feng 			hlock.read = read;
58092f1f043eSBoqun Feng 			hlock.check = check;
58102f1f043eSBoqun Feng 			hlock.hardirqs_off = true;
58112f1f043eSBoqun Feng 			hlock.references = 0;
58122f1f043eSBoqun Feng 
58132f1f043eSBoqun Feng 			verify_lock_unused(lock, &hlock, subclass);
58142f1f043eSBoqun Feng 		}
5815c86e9b98SPeter Zijlstra 		return;
58168eddac3fSPeter Zijlstra 	}
58178eddac3fSPeter Zijlstra 
5818f8cfa466SShuah Khan 	raw_local_irq_save(flags);
58198eddac3fSPeter Zijlstra 	check_flags(flags);
58203e31f947SShuah Khan 
58213e31f947SShuah Khan 	lockdep_recursion_inc();
58223e31f947SShuah Khan 	__lock_acquire(lock, subclass, trylock, read, check,
58233e31f947SShuah Khan 		       irqs_disabled_flags(flags), nest_lock, ip, 0, 0, 0);
58244d004099SPeter Zijlstra 	lockdep_recursion_finish();
5825f8cfa466SShuah Khan 	raw_local_irq_restore(flags);
58268eddac3fSPeter Zijlstra }
58278eddac3fSPeter Zijlstra EXPORT_SYMBOL_GPL(lock_acquire);
58288eddac3fSPeter Zijlstra 
lock_release(struct lockdep_map * lock,unsigned long ip)58298eddac3fSPeter Zijlstra void lock_release(struct lockdep_map *lock, unsigned long ip)
58304d004099SPeter Zijlstra {
5831f8319483SPeter Zijlstra 	unsigned long flags;
583210476e63SPeter Zijlstra 
58338eddac3fSPeter Zijlstra 	trace_lock_release(lock, ip);
58348eddac3fSPeter Zijlstra 
58358eddac3fSPeter Zijlstra 	if (unlikely(!lockdep_enabled() ||
58368eddac3fSPeter Zijlstra 		     lock->key == &__lockdep_no_track__))
5837f8319483SPeter Zijlstra 		return;
58382f43c602SMasami Hiramatsu 
58398eddac3fSPeter Zijlstra 	raw_local_irq_save(flags);
5840e7904a28SPeter Zijlstra 	check_flags(flags);
5841a24fc60dSPeter Zijlstra 
5842e7904a28SPeter Zijlstra 	lockdep_recursion_inc();
5843a24fc60dSPeter Zijlstra 	if (__lock_release(lock, ip))
5844a24fc60dSPeter Zijlstra 		check_chain_key(current);
58454d004099SPeter Zijlstra 	lockdep_recursion_finish();
5846e7904a28SPeter Zijlstra 	raw_local_irq_restore(flags);
5847a24fc60dSPeter Zijlstra }
5848a24fc60dSPeter Zijlstra EXPORT_SYMBOL_GPL(lock_release);
5849a24fc60dSPeter Zijlstra 
5850a24fc60dSPeter Zijlstra /*
58514d004099SPeter Zijlstra  * lock_sync() - A special annotation for synchronize_{s,}rcu()-like API.
5852e7904a28SPeter Zijlstra  *
585310476e63SPeter Zijlstra  * No actual critical section is created by the APIs annotated with this: these
5854a24fc60dSPeter Zijlstra  * APIs are used to wait for one or multiple critical sections (on other CPUs
5855e7904a28SPeter Zijlstra  * or threads), and it means that calling these APIs inside these critical
5856e7904a28SPeter Zijlstra  * sections is potential deadlock.
5857a24fc60dSPeter Zijlstra  */
lock_sync(struct lockdep_map * lock,unsigned subclass,int read,int check,struct lockdep_map * nest_lock,unsigned long ip)5858a24fc60dSPeter Zijlstra void lock_sync(struct lockdep_map *lock, unsigned subclass, int read,
5859a24fc60dSPeter Zijlstra 	       int check, struct lockdep_map *nest_lock, unsigned long ip)
5860e7904a28SPeter Zijlstra {
5861a24fc60dSPeter Zijlstra 	unsigned long flags;
5862a24fc60dSPeter Zijlstra 
5863a24fc60dSPeter Zijlstra 	if (unlikely(!lockdep_enabled()))
58644d004099SPeter Zijlstra 		return;
5865a24fc60dSPeter Zijlstra 
5866a24fc60dSPeter Zijlstra 	raw_local_irq_save(flags);
5867a24fc60dSPeter Zijlstra 	check_flags(flags);
5868a24fc60dSPeter Zijlstra 
5869a24fc60dSPeter Zijlstra 	lockdep_recursion_inc();
58704d004099SPeter Zijlstra 	__lock_acquire(lock, subclass, 0, read, check,
5871e7904a28SPeter Zijlstra 		       irqs_disabled_flags(flags), nest_lock, ip, 0, 0, 1);
587210476e63SPeter Zijlstra 	check_chain_key(current);
5873e7904a28SPeter Zijlstra 	lockdep_recursion_finish();
5874e7904a28SPeter Zijlstra 	raw_local_irq_restore(flags);
5875e7904a28SPeter Zijlstra }
5876e7904a28SPeter Zijlstra EXPORT_SYMBOL_GPL(lock_sync);
5877e7904a28SPeter Zijlstra 
lock_is_held_type(const struct lockdep_map * lock,int read)5878e7904a28SPeter Zijlstra noinstr int lock_is_held_type(const struct lockdep_map *lock, int read)
5879e7904a28SPeter Zijlstra {
5880e7904a28SPeter Zijlstra 	unsigned long flags;
58814d004099SPeter Zijlstra 	int ret = LOCK_STATE_NOT_HELD;
5882e7904a28SPeter Zijlstra 
5883e7904a28SPeter Zijlstra 	/*
5884e7904a28SPeter Zijlstra 	 * Avoid false negative lockdep_assert_held() and
5885e7904a28SPeter Zijlstra 	 * lockdep_assert_not_held().
5886e7904a28SPeter Zijlstra 	 */
58874d004099SPeter Zijlstra 	if (unlikely(!lockdep_enabled()))
5888e7904a28SPeter Zijlstra 		return LOCK_STATE_UNKNOWN;
588910476e63SPeter Zijlstra 
5890a24fc60dSPeter Zijlstra 	raw_local_irq_save(flags);
5891a24fc60dSPeter Zijlstra 	check_flags(flags);
5892a24fc60dSPeter Zijlstra 
5893a24fc60dSPeter Zijlstra 	lockdep_recursion_inc();
58948eddac3fSPeter Zijlstra 	ret = __lock_is_held(lock, read);
5895f7c1c6b3SYuyang Du 	lockdep_recursion_finish();
5896f7c1c6b3SYuyang Du 	raw_local_irq_restore(flags);
58978eddac3fSPeter Zijlstra 
58988eddac3fSPeter Zijlstra 	return ret;
58998eddac3fSPeter Zijlstra }
5900f7c1c6b3SYuyang Du EXPORT_SYMBOL_GPL(lock_is_held_type);
59018eddac3fSPeter Zijlstra NOKPROBE_SYMBOL(lock_is_held_type);
5902f7c1c6b3SYuyang Du 
lock_pin_lock(struct lockdep_map * lock)59038eddac3fSPeter Zijlstra struct pin_cookie lock_pin_lock(struct lockdep_map *lock)
5904681fbec8SPaul E. McKenney {
5905a5dd63efSPaul E. McKenney 	struct pin_cookie cookie = NIL_COOKIE;
5906a5dd63efSPaul E. McKenney 	unsigned long flags;
59078eddac3fSPeter Zijlstra 
5908a5dd63efSPaul E. McKenney 	if (unlikely(!lockdep_enabled()))
5909681fbec8SPaul E. McKenney 		return cookie;
59108eddac3fSPeter Zijlstra 
59118eddac3fSPeter Zijlstra 	raw_local_irq_save(flags);
5912681fbec8SPaul E. McKenney 	check_flags(flags);
59132062a4e8SDmitry Safonov 
5914681fbec8SPaul E. McKenney 	lockdep_recursion_inc();
5915681fbec8SPaul E. McKenney 	cookie = __lock_pin_lock(lock);
59168eddac3fSPeter Zijlstra 	lockdep_recursion_finish();
59178eddac3fSPeter Zijlstra 	raw_local_irq_restore(flags);
5918681fbec8SPaul E. McKenney 
59198eddac3fSPeter Zijlstra 	return cookie;
59208eddac3fSPeter Zijlstra }
59218eddac3fSPeter Zijlstra EXPORT_SYMBOL_GPL(lock_pin_lock);
59228eddac3fSPeter Zijlstra 
lock_repin_lock(struct lockdep_map * lock,struct pin_cookie cookie)59238eddac3fSPeter Zijlstra void lock_repin_lock(struct lockdep_map *lock, struct pin_cookie cookie)
59248eddac3fSPeter Zijlstra {
59258eddac3fSPeter Zijlstra 	unsigned long flags;
592641c2c5b8SJ. R. Okajima 
59278eddac3fSPeter Zijlstra 	if (unlikely(!lockdep_enabled()))
59288eddac3fSPeter Zijlstra 		return;
59298eddac3fSPeter Zijlstra 
59308eddac3fSPeter Zijlstra 	raw_local_irq_save(flags);
59318eddac3fSPeter Zijlstra 	check_flags(flags);
59328eddac3fSPeter Zijlstra 
59338eddac3fSPeter Zijlstra 	lockdep_recursion_inc();
59348eddac3fSPeter Zijlstra 	__lock_repin_lock(lock, cookie);
59358eddac3fSPeter Zijlstra 	lockdep_recursion_finish();
59368eddac3fSPeter Zijlstra 	raw_local_irq_restore(flags);
59378eddac3fSPeter Zijlstra }
59388eddac3fSPeter Zijlstra EXPORT_SYMBOL_GPL(lock_repin_lock);
5939*ff9bf4b3SKent Overstreet 
lock_unpin_lock(struct lockdep_map * lock,struct pin_cookie cookie)5940*ff9bf4b3SKent Overstreet void lock_unpin_lock(struct lockdep_map *lock, struct pin_cookie cookie)
5941*ff9bf4b3SKent Overstreet {
594241c2c5b8SJ. R. Okajima 	unsigned long flags;
594341c2c5b8SJ. R. Okajima 
59448eddac3fSPeter Zijlstra 	if (unlikely(!lockdep_enabled()))
59458eddac3fSPeter Zijlstra 		return;
594641c2c5b8SJ. R. Okajima 
59478eddac3fSPeter Zijlstra 	raw_local_irq_save(flags);
59488eddac3fSPeter Zijlstra 	check_flags(flags);
59498eddac3fSPeter Zijlstra 
59508eddac3fSPeter Zijlstra 	lockdep_recursion_inc();
59518eddac3fSPeter Zijlstra 	__lock_unpin_lock(lock, cookie);
59528eddac3fSPeter Zijlstra 	lockdep_recursion_finish();
59538eddac3fSPeter Zijlstra 	raw_local_irq_restore(flags);
59548eddac3fSPeter Zijlstra }
59558eddac3fSPeter Zijlstra EXPORT_SYMBOL_GPL(lock_unpin_lock);
59568eddac3fSPeter Zijlstra 
59578eddac3fSPeter Zijlstra #ifdef CONFIG_LOCK_STAT
print_lock_contention_bug(struct task_struct * curr,struct lockdep_map * lock,unsigned long ip)59588eddac3fSPeter Zijlstra static void print_lock_contention_bug(struct task_struct *curr,
59598eddac3fSPeter Zijlstra 				      struct lockdep_map *lock,
59608eddac3fSPeter Zijlstra 				      unsigned long ip)
59618eddac3fSPeter Zijlstra {
59628eddac3fSPeter Zijlstra 	if (!debug_locks_off())
59638eddac3fSPeter Zijlstra 		return;
59648eddac3fSPeter Zijlstra 	if (debug_locks_silent)
59658eddac3fSPeter Zijlstra 		return;
59668eddac3fSPeter Zijlstra 
59678eddac3fSPeter Zijlstra 	nbcon_cpu_emergency_enter();
59688eddac3fSPeter Zijlstra 
59698eddac3fSPeter Zijlstra 	pr_warn("\n");
597041c2c5b8SJ. R. Okajima 	pr_warn("=================================\n");
59718eddac3fSPeter Zijlstra 	pr_warn("WARNING: bad contention detected!\n");
59728eddac3fSPeter Zijlstra 	print_kernel_ident();
59738eddac3fSPeter Zijlstra 	pr_warn("---------------------------------\n");
59748eddac3fSPeter Zijlstra 	pr_warn("%s/%d is trying to contend lock (",
59758eddac3fSPeter Zijlstra 		curr->comm, task_pid_nr(curr));
59768eddac3fSPeter Zijlstra 	print_lockdep_cache(lock);
59778eddac3fSPeter Zijlstra 	pr_cont(") at:\n");
59788eddac3fSPeter Zijlstra 	print_ip_sym(KERN_WARNING, ip);
59798eddac3fSPeter Zijlstra 	pr_warn("but there are no locks held!\n");
59808eddac3fSPeter Zijlstra 	pr_warn("\nother info that might help us debug this:\n");
59818eddac3fSPeter Zijlstra 	lockdep_print_held_locks(curr);
59828eddac3fSPeter Zijlstra 
59838eddac3fSPeter Zijlstra 	pr_warn("\nstack backtrace:\n");
5984*ff9bf4b3SKent Overstreet 	dump_stack();
5985*ff9bf4b3SKent Overstreet 
5986*ff9bf4b3SKent Overstreet 	nbcon_cpu_emergency_exit();
598741c2c5b8SJ. R. Okajima }
598841c2c5b8SJ. R. Okajima 
59898eddac3fSPeter Zijlstra static void
__lock_contended(struct lockdep_map * lock,unsigned long ip)59908eddac3fSPeter Zijlstra __lock_contended(struct lockdep_map *lock, unsigned long ip)
599141c2c5b8SJ. R. Okajima {
59928eddac3fSPeter Zijlstra 	struct task_struct *curr = current;
59938eddac3fSPeter Zijlstra 	struct held_lock *hlock;
59948eddac3fSPeter Zijlstra 	struct lock_class_stats *stats;
59958eddac3fSPeter Zijlstra 	unsigned int depth;
59968eddac3fSPeter Zijlstra 	int i, contention_point, contending_point;
59978eddac3fSPeter Zijlstra 
59988eddac3fSPeter Zijlstra 	depth = curr->lockdep_depth;
59998eddac3fSPeter Zijlstra 	/*
60008eddac3fSPeter Zijlstra 	 * Whee, we contended on this lock, except it seems we're not
60018eddac3fSPeter Zijlstra 	 * actually trying to acquire anything much at all..
60028eddac3fSPeter Zijlstra 	 */
60038eddac3fSPeter Zijlstra 	if (DEBUG_LOCKS_WARN_ON(!depth))
60048eddac3fSPeter Zijlstra 		return;
60058eddac3fSPeter Zijlstra 
60068eddac3fSPeter Zijlstra 	if (unlikely(lock->key == &__lockdep_no_track__))
60078eddac3fSPeter Zijlstra 		return;
60088eddac3fSPeter Zijlstra 
60098eddac3fSPeter Zijlstra 	hlock = find_held_lock(curr, lock, depth, &i);
60108eddac3fSPeter Zijlstra 	if (!hlock) {
60118eddac3fSPeter Zijlstra 		print_lock_contention_bug(curr, lock, ip);
60128eddac3fSPeter Zijlstra 		return;
60138eddac3fSPeter Zijlstra 	}
60148eddac3fSPeter Zijlstra 
60158eddac3fSPeter Zijlstra 	if (hlock->instance != lock)
60168eddac3fSPeter Zijlstra 		return;
60178eddac3fSPeter Zijlstra 
60188eddac3fSPeter Zijlstra 	hlock->waittime_stamp = lockstat_clock();
60198eddac3fSPeter Zijlstra 
60208eddac3fSPeter Zijlstra 	contention_point = lock_point(hlock_class(hlock)->contention_point, ip);
602189e70d5cSLeo Yan 	contending_point = lock_point(hlock_class(hlock)->contending_point,
6022eb1f0023SPeter Zijlstra 				      lock->ip);
60234d004099SPeter Zijlstra 
60248eddac3fSPeter Zijlstra 	stats = get_lock_stats(hlock_class(hlock));
60258eddac3fSPeter Zijlstra 	if (contention_point < LOCKSTAT_POINTS)
60268eddac3fSPeter Zijlstra 		stats->contention_point[contention_point]++;
60278eddac3fSPeter Zijlstra 	if (contending_point < LOCKSTAT_POINTS)
60284d004099SPeter Zijlstra 		stats->contending_point[contending_point]++;
60298eddac3fSPeter Zijlstra 	if (lock->cpu != smp_processor_id())
603010476e63SPeter Zijlstra 		stats->bounces[bounce_contended + !!hlock->read]++;
60318eddac3fSPeter Zijlstra }
60328eddac3fSPeter Zijlstra 
60338eddac3fSPeter Zijlstra static void
__lock_acquired(struct lockdep_map * lock,unsigned long ip)60348eddac3fSPeter Zijlstra __lock_acquired(struct lockdep_map *lock, unsigned long ip)
60358eddac3fSPeter Zijlstra {
60368eddac3fSPeter Zijlstra 	struct task_struct *curr = current;
60378eddac3fSPeter Zijlstra 	struct held_lock *hlock;
60388eddac3fSPeter Zijlstra 	struct lock_class_stats *stats;
603989e70d5cSLeo Yan 	unsigned int depth;
6040eb1f0023SPeter Zijlstra 	u64 now, waittime = 0;
60414d004099SPeter Zijlstra 	int i, cpu;
60428eddac3fSPeter Zijlstra 
60438eddac3fSPeter Zijlstra 	depth = curr->lockdep_depth;
60448eddac3fSPeter Zijlstra 	/*
60458eddac3fSPeter Zijlstra 	 * Yay, we acquired ownership of this lock we didn't try to
60464d004099SPeter Zijlstra 	 * acquire, how the heck did that happen?
60478eddac3fSPeter Zijlstra 	 */
604810476e63SPeter Zijlstra 	if (DEBUG_LOCKS_WARN_ON(!depth))
60498eddac3fSPeter Zijlstra 		return;
60508eddac3fSPeter Zijlstra 
60518eddac3fSPeter Zijlstra 	if (unlikely(lock->key == &__lockdep_no_track__))
60528eddac3fSPeter Zijlstra 		return;
60538eddac3fSPeter Zijlstra 
60548eddac3fSPeter Zijlstra 	hlock = find_held_lock(curr, lock, depth, &i);
60558eddac3fSPeter Zijlstra 	if (!hlock) {
60568eddac3fSPeter Zijlstra 		print_lock_contention_bug(curr, lock, _RET_IP_);
60578eddac3fSPeter Zijlstra 		return;
60588eddac3fSPeter Zijlstra 	}
60598eddac3fSPeter Zijlstra 
60608eddac3fSPeter Zijlstra 	if (hlock->instance != lock)
60618eddac3fSPeter Zijlstra 		return;
60628eddac3fSPeter Zijlstra 
60638eddac3fSPeter Zijlstra 	cpu = smp_processor_id();
60648eddac3fSPeter Zijlstra 	if (hlock->waittime_stamp) {
6065e196e479SYuyang Du 		now = lockstat_clock();
60668eddac3fSPeter Zijlstra 		waittime = now - hlock->waittime_stamp;
60678eddac3fSPeter Zijlstra 		hlock->holdtime_stamp = now;
60688eddac3fSPeter Zijlstra 	}
60698eddac3fSPeter Zijlstra 
60708eddac3fSPeter Zijlstra 	stats = get_lock_stats(hlock_class(hlock));
60718eddac3fSPeter Zijlstra 	if (waittime) {
6072a63f38ccSAndrew Morton 		if (hlock->read)
60738eddac3fSPeter Zijlstra 			lock_time_inc(&stats->read_waittime, waittime);
60748eddac3fSPeter Zijlstra 		else
60758eddac3fSPeter Zijlstra 			lock_time_inc(&stats->write_waittime, waittime);
6076a0b0fd53SBart Van Assche 	}
6077de4643a7SBart Van Assche 	if (lock->cpu != cpu)
6078de4643a7SBart Van Assche 		stats->bounces[bounce_acquired + !!hlock->read]++;
6079a0b0fd53SBart Van Assche 
6080a0b0fd53SBart Van Assche 	lock->cpu = cpu;
6081a0b0fd53SBart Van Assche 	lock->ip = ip;
6082a0b0fd53SBart Van Assche }
6083a0b0fd53SBart Van Assche 
lock_contended(struct lockdep_map * lock,unsigned long ip)6084a0b0fd53SBart Van Assche void lock_contended(struct lockdep_map *lock, unsigned long ip)
6085f611e8cfSBoqun Feng {
6086a0b0fd53SBart Van Assche 	unsigned long flags;
6087a0b0fd53SBart Van Assche 
6088a0b0fd53SBart Van Assche 	trace_lock_contended(lock, ip);
6089a0b0fd53SBart Van Assche 
6090a0b0fd53SBart Van Assche 	if (unlikely(!lock_stat || !lockdep_enabled()))
6091836bd74bSWaiman Long 		return;
6092a0b0fd53SBart Van Assche 
6093a0b0fd53SBart Van Assche 	raw_local_irq_save(flags);
6094a0b0fd53SBart Van Assche 	check_flags(flags);
6095a0b0fd53SBart Van Assche 	lockdep_recursion_inc();
6096836bd74bSWaiman Long 	__lock_contended(lock, ip);
6097810507feSWaiman Long 	lockdep_recursion_finish();
6098a0b0fd53SBart Van Assche 	raw_local_irq_restore(flags);
6099836bd74bSWaiman Long }
6100b3b9c187SWaiman Long EXPORT_SYMBOL_GPL(lock_contended);
6101b3b9c187SWaiman Long 
lock_acquired(struct lockdep_map * lock,unsigned long ip)6102a0b0fd53SBart Van Assche void lock_acquired(struct lockdep_map *lock, unsigned long ip)
6103a0b0fd53SBart Van Assche {
6104a0b0fd53SBart Van Assche 	unsigned long flags;
6105a0b0fd53SBart Van Assche 
6106a0b0fd53SBart Van Assche 	trace_lock_acquired(lock, ip);
6107de4643a7SBart Van Assche 
6108797b82ebSWaiman Long 	if (unlikely(!lock_stat || !lockdep_enabled()))
6109a0b0fd53SBart Van Assche 		return;
6110a0b0fd53SBart Van Assche 
6111a0b0fd53SBart Van Assche 	raw_local_irq_save(flags);
6112a0b0fd53SBart Van Assche 	check_flags(flags);
6113de4643a7SBart Van Assche 	lockdep_recursion_inc();
6114de4643a7SBart Van Assche 	__lock_acquired(lock, ip);
6115a0b0fd53SBart Van Assche 	lockdep_recursion_finish();
6116a0b0fd53SBart Van Assche 	raw_local_irq_restore(flags);
6117a0b0fd53SBart Van Assche }
6118a0b0fd53SBart Van Assche EXPORT_SYMBOL_GPL(lock_acquired);
6119a0b0fd53SBart Van Assche #endif
6120a0b0fd53SBart Van Assche 
6121a0b0fd53SBart Van Assche /*
6122a0b0fd53SBart Van Assche  * Used by the testsuite, sanitize the validator state
6123de4643a7SBart Van Assche  * after a simulated failure:
6124a0b0fd53SBart Van Assche  */
6125a0b0fd53SBart Van Assche 
lockdep_reset(void)6126a0b0fd53SBart Van Assche void lockdep_reset(void)
6127a0b0fd53SBart Van Assche {
6128786fa29eSBart Van Assche 	unsigned long flags;
6129786fa29eSBart Van Assche 	int i;
6130786fa29eSBart Van Assche 
6131a0b0fd53SBart Van Assche 	raw_local_irq_save(flags);
61328eddac3fSPeter Zijlstra 	lockdep_init_task(current);
613386cffb80SBart Van Assche 	memset(current->held_locks, 0, MAX_LOCK_DEPTH*sizeof(struct held_lock));
61348eddac3fSPeter Zijlstra 	nr_hardirq_chains = 0;
61358eddac3fSPeter Zijlstra 	nr_softirq_chains = 0;
6136a0b0fd53SBart Van Assche 	nr_process_chains = 0;
6137a0b0fd53SBart Van Assche 	debug_locks = 1;
61388eddac3fSPeter Zijlstra 	for (i = 0; i < CHAINHASH_SIZE; i++)
61398eddac3fSPeter Zijlstra 		INIT_HLIST_HEAD(chainhash_table + i);
61408eddac3fSPeter Zijlstra 	raw_local_irq_restore(flags);
61418eddac3fSPeter Zijlstra }
6142ace35a7aSBart Van Assche 
6143ace35a7aSBart Van Assche /* Remove a class from a lock chain. Must be called with the graph lock held. */
remove_class_from_lock_chain(struct pending_free * pf,struct lock_chain * chain,struct lock_class * class)614486cffb80SBart Van Assche static void remove_class_from_lock_chain(struct pending_free *pf,
614586cffb80SBart Van Assche 					 struct lock_chain *chain,
6146ace35a7aSBart Van Assche 					 struct lock_class *class)
6147ace35a7aSBart Van Assche {
614886cffb80SBart Van Assche #ifdef CONFIG_PROVE_LOCKING
61498eddac3fSPeter Zijlstra 	int i;
6150a0b0fd53SBart Van Assche 
6151a0b0fd53SBart Van Assche 	for (i = chain->base; i < chain->base + chain->depth; i++) {
6152a0b0fd53SBart Van Assche 		if (chain_hlock_class_idx(chain_hlocks[i]) != class - lock_classes)
6153a63f38ccSAndrew Morton 			continue;
6154a0b0fd53SBart Van Assche 		/*
6155a0b0fd53SBart Van Assche 		 * Each lock class occurs at most once in a lock chain so once
6156a0b0fd53SBart Van Assche 		 * we found a match we can break out of this loop.
615701bb6f0aSYuyang Du 		 */
6158fb7275acSWaiman Long 		goto free_lock_chain;
6159fb7275acSWaiman Long 	}
6160a0b0fd53SBart Van Assche 	/* Since the chain has not been modified, return. */
6161a0b0fd53SBart Van Assche 	return;
6162a0b0fd53SBart Van Assche 
6163a0b0fd53SBart Van Assche free_lock_chain:
61648eddac3fSPeter Zijlstra 	free_chain_hlocks(chain->base, chain->depth);
6165de4643a7SBart Van Assche 	/* Overwrite the chain key for concurrent RCU readers. */
61661d44bcb4SWaiman Long 	WRITE_ONCE(chain->chain_key, INITIAL_CHAIN_KEY);
6167a0b0fd53SBart Van Assche 	dec_chains(chain->irq_context);
6168a0b0fd53SBart Van Assche 
6169a0b0fd53SBart Van Assche 	/*
6170a0b0fd53SBart Van Assche 	 * Note: calling hlist_del_rcu() from inside a
6171a0b0fd53SBart Van Assche 	 * hlist_for_each_entry_rcu() loop is safe.
6172a0b0fd53SBart Van Assche 	 */
6173a0b0fd53SBart Van Assche 	hlist_del_rcu(&chain->entry);
6174e204193bSXiu Jianfeng 	__set_bit(chain - lock_chains, pf->lock_chains_being_freed);
6175a0b0fd53SBart Van Assche 	nr_zapped_lock_chains++;
6176a0b0fd53SBart Van Assche #endif
6177a0b0fd53SBart Van Assche }
61788eddac3fSPeter Zijlstra 
61798eddac3fSPeter Zijlstra /* Must be called with the graph lock held. */
remove_class_from_lock_chains(struct pending_free * pf,struct lock_class * class)61808eddac3fSPeter Zijlstra static void remove_class_from_lock_chains(struct pending_free *pf,
61818eddac3fSPeter Zijlstra 					  struct lock_class *class)
61828eddac3fSPeter Zijlstra {
61838eddac3fSPeter Zijlstra 	struct lock_chain *chain;
61848eddac3fSPeter Zijlstra 	struct hlist_head *head;
6185a0b0fd53SBart Van Assche 	int i;
6186a0b0fd53SBart Van Assche 
6187a0b0fd53SBart Van Assche 	for (i = 0; i < ARRAY_SIZE(chainhash_table); i++) {
6188a0b0fd53SBart Van Assche 		head = chainhash_table + i;
6189a0b0fd53SBart Van Assche 		hlist_for_each_entry_rcu(chain, head, entry) {
6190a0b0fd53SBart Van Assche 			remove_class_from_lock_chain(pf, chain, class);
6191a0b0fd53SBart Van Assche 		}
6192a0b0fd53SBart Van Assche 	}
6193a0b0fd53SBart Van Assche }
6194a0b0fd53SBart Van Assche 
6195a0b0fd53SBart Van Assche /*
6196a0b0fd53SBart Van Assche  * Remove all references to a lock class. The caller must hold the graph lock.
6197a0b0fd53SBart Van Assche  */
zap_class(struct pending_free * pf,struct lock_class * class)6198a0b0fd53SBart Van Assche static void zap_class(struct pending_free *pf, struct lock_class *class)
6199a0b0fd53SBart Van Assche {
6200a0b0fd53SBart Van Assche 	struct lock_list *entry;
6201a0b0fd53SBart Van Assche 	int i;
6202a0b0fd53SBart Van Assche 
6203a0b0fd53SBart Van Assche 	WARN_ON_ONCE(!class->key);
6204a0b0fd53SBart Van Assche 
6205a0b0fd53SBart Van Assche 	/*
6206a0b0fd53SBart Van Assche 	 * Remove all dependencies this lock is
6207a0b0fd53SBart Van Assche 	 * involved in:
6208a0b0fd53SBart Van Assche 	 */
6209a0b0fd53SBart Van Assche 	for_each_set_bit(i, list_entries_in_use, ARRAY_SIZE(list_entries)) {
6210a0b0fd53SBart Van Assche 		entry = list_entries + i;
6211a0b0fd53SBart Van Assche 		if (entry->class != class && entry->links_to != class)
6212a0b0fd53SBart Van Assche 			continue;
6213a0b0fd53SBart Van Assche 		__clear_bit(i, list_entries_in_use);
6214a0b0fd53SBart Van Assche 		nr_list_entries--;
6215a0b0fd53SBart Van Assche 		list_del_rcu(&entry->entry);
6216a0b0fd53SBart Van Assche 	}
6217a0b0fd53SBart Van Assche 	if (list_empty(&class->locks_after) &&
6218a0b0fd53SBart Van Assche 	    list_empty(&class->locks_before)) {
6219a0b0fd53SBart Van Assche 		list_move_tail(&class->lock_entry, &pf->zapped);
6220a0b0fd53SBart Van Assche 		hlist_del_rcu(&class->hash_entry);
6221a0b0fd53SBart Van Assche 		WRITE_ONCE(class->key, NULL);
6222a0b0fd53SBart Van Assche 		WRITE_ONCE(class->name, NULL);
6223a0b0fd53SBart Van Assche 		nr_lock_classes--;
6224a0b0fd53SBart Van Assche 		__clear_bit(class - lock_classes, lock_classes_in_use);
622572dcd505SPeter Zijlstra 		if (class - lock_classes == max_lock_class_idx)
6226b526b2e3SBart Van Assche 			max_lock_class_idx--;
6227a0b0fd53SBart Van Assche 	} else {
6228a0b0fd53SBart Van Assche 		WARN_ONCE(true, "%s() failed for class %s\n", __func__,
6229a0b0fd53SBart Van Assche 			  class->name);
6230a0b0fd53SBart Van Assche 	}
6231de4643a7SBart Van Assche 
6232de4643a7SBart Van Assche 	remove_class_from_lock_chains(pf, class);
6233de4643a7SBart Van Assche 	nr_zapped_classes++;
6234de4643a7SBart Van Assche }
6235de4643a7SBart Van Assche 
reinit_class(struct lock_class * class)6236de4643a7SBart Van Assche static void reinit_class(struct lock_class *class)
6237a0b0fd53SBart Van Assche {
6238a0b0fd53SBart Van Assche 	WARN_ON_ONCE(!class->lock_entry.next);
6239a0b0fd53SBart Van Assche 	WARN_ON_ONCE(!list_empty(&class->locks_after));
6240a0b0fd53SBart Van Assche 	WARN_ON_ONCE(!list_empty(&class->locks_before));
6241a0b0fd53SBart Van Assche 	memset_startat(class, 0, key);
6242a0b0fd53SBart Van Assche 	WARN_ON_ONCE(!class->lock_entry.next);
6243a0b0fd53SBart Van Assche 	WARN_ON_ONCE(!list_empty(&class->locks_after));
6244a0b0fd53SBart Van Assche 	WARN_ON_ONCE(!list_empty(&class->locks_before));
6245a0b0fd53SBart Van Assche }
6246a0b0fd53SBart Van Assche 
within(const void * addr,void * start,unsigned long size)6247a0b0fd53SBart Van Assche static inline int within(const void *addr, void *start, unsigned long size)
6248248efb21SPeter Zijlstra {
6249a0b0fd53SBart Van Assche 	return addr >= start && addr < start + size;
6250a0b0fd53SBart Van Assche }
6251a0b0fd53SBart Van Assche 
inside_selftest(void)6252a0b0fd53SBart Van Assche static bool inside_selftest(void)
6253a0b0fd53SBart Van Assche {
6254a0b0fd53SBart Van Assche 	return current == lockdep_selftest_task_struct;
6255a0b0fd53SBart Van Assche }
6256a0b0fd53SBart Van Assche 
6257a0b0fd53SBart Van Assche /* The caller must hold the graph lock. */
get_pending_free(void)6258a0b0fd53SBart Van Assche static struct pending_free *get_pending_free(void)
6259a0b0fd53SBart Van Assche {
6260248efb21SPeter Zijlstra 	return delayed_free.pf + delayed_free.index;
6261a0b0fd53SBart Van Assche }
6262a0b0fd53SBart Van Assche 
6263a0b0fd53SBart Van Assche static void free_zapped_rcu(struct rcu_head *cb);
6264a0b0fd53SBart Van Assche 
6265a0b0fd53SBart Van Assche /*
6266a0b0fd53SBart Van Assche  * Schedule an RCU callback if no RCU callback is pending. Must be called with
6267a0b0fd53SBart Van Assche  * the graph lock held.
6268a0b0fd53SBart Van Assche  */
call_rcu_zapped(struct pending_free * pf)6269a0b0fd53SBart Van Assche static void call_rcu_zapped(struct pending_free *pf)
6270a0b0fd53SBart Van Assche {
6271a0b0fd53SBart Van Assche 	WARN_ON_ONCE(inside_selftest());
6272956f3563SBart Van Assche 
6273956f3563SBart Van Assche 	if (list_empty(&pf->zapped))
6274956f3563SBart Van Assche 		return;
6275956f3563SBart Van Assche 
6276956f3563SBart Van Assche 	if (delayed_free.scheduled)
6277956f3563SBart Van Assche 		return;
6278956f3563SBart Van Assche 
6279956f3563SBart Van Assche 	delayed_free.scheduled = true;
6280956f3563SBart Van Assche 
6281956f3563SBart Van Assche 	WARN_ON_ONCE(delayed_free.pf + delayed_free.index != pf);
6282956f3563SBart Van Assche 	delayed_free.index ^= 1;
6283956f3563SBart Van Assche 
6284a0b0fd53SBart Van Assche 	call_rcu(&delayed_free.rcu_head, free_zapped_rcu);
6285956f3563SBart Van Assche }
6286956f3563SBart Van Assche 
6287956f3563SBart Van Assche /* The caller must hold the graph lock. May be called from RCU context. */
__free_zapped_classes(struct pending_free * pf)6288956f3563SBart Van Assche static void __free_zapped_classes(struct pending_free *pf)
628935a9393cSPeter Zijlstra {
629035a9393cSPeter Zijlstra 	struct lock_class *class;
629135a9393cSPeter Zijlstra 
629235a9393cSPeter Zijlstra 	check_data_structures();
629329fc33fbSBart Van Assche 
629429fc33fbSBart Van Assche 	list_for_each_entry(class, &pf->zapped, lock_entry)
629529fc33fbSBart Van Assche 		reinit_class(class);
629635a9393cSPeter Zijlstra 
6297a0b0fd53SBart Van Assche 	list_splice_init(&pf->zapped, &free_lock_classes);
62988eddac3fSPeter Zijlstra 
6299a0b0fd53SBart Van Assche #ifdef CONFIG_PROVE_LOCKING
63008eddac3fSPeter Zijlstra 	bitmap_andnot(lock_chains_in_use, lock_chains_in_use,
63018eddac3fSPeter Zijlstra 		      pf->lock_chains_being_freed, ARRAY_SIZE(lock_chains));
6302feb0a386SBart Van Assche 	bitmap_clear(pf->lock_chains_being_freed, 0, ARRAY_SIZE(lock_chains));
6303feb0a386SBart Van Assche #endif
63048eddac3fSPeter Zijlstra }
6305248efb21SPeter Zijlstra 
free_zapped_rcu(struct rcu_head * ch)6306a0b0fd53SBart Van Assche static void free_zapped_rcu(struct rcu_head *ch)
6307a0b0fd53SBart Van Assche {
6308a0b0fd53SBart Van Assche 	struct pending_free *pf;
6309248efb21SPeter Zijlstra 	unsigned long flags;
63108eddac3fSPeter Zijlstra 
631135a9393cSPeter Zijlstra 	if (WARN_ON_ONCE(ch != &delayed_free.rcu_head))
631235a9393cSPeter Zijlstra 		return;
631335a9393cSPeter Zijlstra 
631435a9393cSPeter Zijlstra 	raw_local_irq_save(flags);
631535a9393cSPeter Zijlstra 	lockdep_lock();
631651959d85SPaul E. McKenney 
6317a0b0fd53SBart Van Assche 	/* closed head */
631835a9393cSPeter Zijlstra 	pf = delayed_free.pf + (delayed_free.index ^ 1);
631935a9393cSPeter Zijlstra 	__free_zapped_classes(pf);
6320a0b0fd53SBart Van Assche 	delayed_free.scheduled = false;
6321a0b0fd53SBart Van Assche 
632235a9393cSPeter Zijlstra 	/*
6323a0b0fd53SBart Van Assche 	 * If there's anything on the open list, close and start a new callback.
6324a0b0fd53SBart Van Assche 	 */
6325a0b0fd53SBart Van Assche 	call_rcu_zapped(delayed_free.pf + delayed_free.index);
6326a0b0fd53SBart Van Assche 
6327a0b0fd53SBart Van Assche 	lockdep_unlock();
6328a0b0fd53SBart Van Assche 	raw_local_irq_restore(flags);
6329a0b0fd53SBart Van Assche }
6330a0b0fd53SBart Van Assche 
6331248efb21SPeter Zijlstra /*
6332a0b0fd53SBart Van Assche  * Remove all lock classes from the class hash table and from the
6333a0b0fd53SBart Van Assche  * all_lock_classes list whose key or name is in the address range [start,
6334248efb21SPeter Zijlstra  * start + size). Move these lock classes to the zapped_classes list. Must
6335a0b0fd53SBart Van Assche  * be called with the graph lock held.
6336a0b0fd53SBart Van Assche  */
__lockdep_free_key_range(struct pending_free * pf,void * start,unsigned long size)6337a0b0fd53SBart Van Assche static void __lockdep_free_key_range(struct pending_free *pf, void *start,
6338a0b0fd53SBart Van Assche 				     unsigned long size)
6339a0b0fd53SBart Van Assche {
6340a0b0fd53SBart Van Assche 	struct lock_class *class;
6341a0b0fd53SBart Van Assche 	struct hlist_head *head;
6342a0b0fd53SBart Van Assche 	int i;
6343a0b0fd53SBart Van Assche 
6344a0b0fd53SBart Van Assche 	/* Unhash all classes that were created by a module. */
6345a0b0fd53SBart Van Assche 	for (i = 0; i < CLASSHASH_SIZE; i++) {
63468eddac3fSPeter Zijlstra 		head = classhash_table + i;
63478eddac3fSPeter Zijlstra 		hlist_for_each_entry_rcu(class, head, hash_entry) {
63482904d9faSBart Van Assche 			if (!within(class->key, start, size) &&
63492904d9faSBart Van Assche 			    !within(class->name, start, size))
63502904d9faSBart Van Assche 				continue;
63512904d9faSBart Van Assche 			zap_class(pf, class);
63522904d9faSBart Van Assche 		}
63532904d9faSBart Van Assche 	}
63548eddac3fSPeter Zijlstra }
635535a9393cSPeter Zijlstra 
6356a63f38ccSAndrew Morton /*
63578eddac3fSPeter Zijlstra  * Used in module.c to remove lock classes from memory that is going to be
63582904d9faSBart Van Assche  * freed; and possibly re-used by other modules.
63592904d9faSBart Van Assche  *
63602904d9faSBart Van Assche  * We will have had one synchronize_rcu() before getting here, so we're
63612904d9faSBart Van Assche  * guaranteed nobody will look up these exact classes -- they're properly dead
63622904d9faSBart Van Assche  * but still allocated.
63632904d9faSBart Van Assche  */
lockdep_free_key_range_reg(void * start,unsigned long size)63642904d9faSBart Van Assche static void lockdep_free_key_range_reg(void *start, unsigned long size)
63652904d9faSBart Van Assche {
63662904d9faSBart Van Assche 	struct pending_free *pf;
63672904d9faSBart Van Assche 	unsigned long flags;
63682904d9faSBart Van Assche 
63692904d9faSBart Van Assche 	init_data_structures_once();
6370956f3563SBart Van Assche 
6371a0b0fd53SBart Van Assche 	raw_local_irq_save(flags);
6372a0b0fd53SBart Van Assche 	lockdep_lock();
63732904d9faSBart Van Assche 	pf = get_pending_free();
63742904d9faSBart Van Assche 	__lockdep_free_key_range(pf, start, size);
6375956f3563SBart Van Assche 	call_rcu_zapped(pf);
63768eddac3fSPeter Zijlstra 	lockdep_unlock();
63778eddac3fSPeter Zijlstra 	raw_local_irq_restore(flags);
63788eddac3fSPeter Zijlstra 
63798eddac3fSPeter Zijlstra 	/*
63808eddac3fSPeter Zijlstra 	 * Wait for any possible iterators from look_up_lock_class() to pass
63818eddac3fSPeter Zijlstra 	 * before continuing to free the memory they refer to.
63828eddac3fSPeter Zijlstra 	 */
63838eddac3fSPeter Zijlstra 	synchronize_rcu();
63848eddac3fSPeter Zijlstra }
638564f29d1bSMatthew Wilcox 
6386a0b0fd53SBart Van Assche /*
63878eddac3fSPeter Zijlstra  * Free all lockdep keys in the range [start, start+size). Does not sleep.
63888eddac3fSPeter Zijlstra  * Ignores debug_locks. Must only be used by the lockdep selftests.
63898eddac3fSPeter Zijlstra  */
lockdep_free_key_range_imm(void * start,unsigned long size)63908eddac3fSPeter Zijlstra static void lockdep_free_key_range_imm(void *start, unsigned long size)
63918eddac3fSPeter Zijlstra {
6392956f3563SBart Van Assche 	struct pending_free *pf = delayed_free.pf;
6393956f3563SBart Van Assche 	unsigned long flags;
63948eddac3fSPeter Zijlstra 
6395956f3563SBart Van Assche 	init_data_structures_once();
6396a0b0fd53SBart Van Assche 
6397a0b0fd53SBart Van Assche 	raw_local_irq_save(flags);
6398a0b0fd53SBart Van Assche 	lockdep_lock();
6399a0b0fd53SBart Van Assche 	__lockdep_free_key_range(pf, start, size);
6400a0b0fd53SBart Van Assche 	__free_zapped_classes(pf);
6401956f3563SBart Van Assche 	lockdep_unlock();
6402a0b0fd53SBart Van Assche 	raw_local_irq_restore(flags);
6403956f3563SBart Van Assche }
6404956f3563SBart Van Assche 
lockdep_free_key_range(void * start,unsigned long size)6405956f3563SBart Van Assche void lockdep_free_key_range(void *start, unsigned long size)
6406956f3563SBart Van Assche {
6407956f3563SBart Van Assche 	init_data_structures_once();
6408a0b0fd53SBart Van Assche 
6409a0b0fd53SBart Van Assche 	if (inside_selftest())
6410a0b0fd53SBart Van Assche 		lockdep_free_key_range_imm(start, size);
6411a0b0fd53SBart Van Assche 	else
6412a0b0fd53SBart Van Assche 		lockdep_free_key_range_reg(start, size);
6413a0b0fd53SBart Van Assche }
6414a0b0fd53SBart Van Assche 
64158eddac3fSPeter Zijlstra /*
6416a0b0fd53SBart Van Assche  * Check whether any element of the @lock->class_cache[] array refers to a
64178eddac3fSPeter Zijlstra  * registered lock class. The caller must hold either the graph lock or the
64188eddac3fSPeter Zijlstra  * RCU read lock.
64198eddac3fSPeter Zijlstra  */
lock_class_cache_is_registered(struct lockdep_map * lock)6420a0b0fd53SBart Van Assche static bool lock_class_cache_is_registered(struct lockdep_map *lock)
6421a0b0fd53SBart Van Assche {
6422a0b0fd53SBart Van Assche 	struct lock_class *class;
6423a0b0fd53SBart Van Assche 	struct hlist_head *head;
6424a0b0fd53SBart Van Assche 	int i, j;
6425a0b0fd53SBart Van Assche 
6426a0b0fd53SBart Van Assche 	for (i = 0; i < CLASSHASH_SIZE; i++) {
6427a0b0fd53SBart Van Assche 		head = classhash_table + i;
6428a0b0fd53SBart Van Assche 		hlist_for_each_entry_rcu(class, head, hash_entry) {
6429a0b0fd53SBart Van Assche 			for (j = 0; j < NR_LOCKDEP_CACHING_CLASSES; j++)
6430248efb21SPeter Zijlstra 				if (lock->class_cache[j] == class)
6431a0b0fd53SBart Van Assche 					return true;
6432a0b0fd53SBart Van Assche 		}
6433248efb21SPeter Zijlstra 	}
6434a0b0fd53SBart Van Assche 	return false;
6435a0b0fd53SBart Van Assche }
6436a0b0fd53SBart Van Assche 
6437a0b0fd53SBart Van Assche /* The caller must hold the graph lock. Does not sleep. */
__lockdep_reset_lock(struct pending_free * pf,struct lockdep_map * lock)6438a0b0fd53SBart Van Assche static void __lockdep_reset_lock(struct pending_free *pf,
6439a0b0fd53SBart Van Assche 				 struct lockdep_map *lock)
6440a0b0fd53SBart Van Assche {
6441a0b0fd53SBart Van Assche 	struct lock_class *class;
6442a0b0fd53SBart Van Assche 	int j;
6443a0b0fd53SBart Van Assche 
6444a0b0fd53SBart Van Assche 	/*
6445a0b0fd53SBart Van Assche 	 * Remove all classes this lock might have:
6446a0b0fd53SBart Van Assche 	 */
644761cc4534SWaiman Long 	for (j = 0; j < MAX_LOCKDEP_SUBCLASSES; j++) {
644861cc4534SWaiman Long 		/*
644961cc4534SWaiman Long 		 * If the class exists we look it up and zap it:
645061cc4534SWaiman Long 		 */
645161cc4534SWaiman Long 		class = look_up_lock_class(lock, j);
645261cc4534SWaiman Long 		if (class)
645361cc4534SWaiman Long 			zap_class(pf, class);
6454108c1485SBart Van Assche 	}
6455108c1485SBart Van Assche 	/*
6456108c1485SBart Van Assche 	 * Debug check: in the end all mapped classes should
6457108c1485SBart Van Assche 	 * be gone.
6458108c1485SBart Van Assche 	 */
6459108c1485SBart Van Assche 	if (WARN_ON_ONCE(lock_class_cache_is_registered(lock)))
6460108c1485SBart Van Assche 		debug_locks_off();
6461108c1485SBart Van Assche }
6462108c1485SBart Van Assche 
6463108c1485SBart Van Assche /*
6464108c1485SBart Van Assche  * Remove all information lockdep has about a lock if debug_locks == 1. Free
6465108c1485SBart Van Assche  * released data structures from RCU context.
6466108c1485SBart Van Assche  */
lockdep_reset_lock_reg(struct lockdep_map * lock)6467108c1485SBart Van Assche static void lockdep_reset_lock_reg(struct lockdep_map *lock)
646861cc4534SWaiman Long {
64698b39adbeSBart Van Assche 	struct pending_free *pf;
6470108c1485SBart Van Assche 	unsigned long flags;
6471108c1485SBart Van Assche 	int locked;
6472108c1485SBart Van Assche 
6473108c1485SBart Van Assche 	raw_local_irq_save(flags);
6474108c1485SBart Van Assche 	locked = graph_lock();
6475108c1485SBart Van Assche 	if (!locked)
6476108c1485SBart Van Assche 		goto out_irq;
647761cc4534SWaiman Long 
647861cc4534SWaiman Long 	pf = get_pending_free();
647961cc4534SWaiman Long 	__lockdep_reset_lock(pf, lock);
6480108c1485SBart Van Assche 	call_rcu_zapped(pf);
6481108c1485SBart Van Assche 
648261cc4534SWaiman Long 	graph_unlock();
648361cc4534SWaiman Long out_irq:
6484108c1485SBart Van Assche 	raw_local_irq_restore(flags);
6485108c1485SBart Van Assche }
6486108c1485SBart Van Assche 
6487108c1485SBart Van Assche /*
6488108c1485SBart Van Assche  * Reset a lock. Does not sleep. Ignores debug_locks. Must only be used by the
6489108c1485SBart Van Assche  * lockdep selftests.
6490108c1485SBart Van Assche  */
lockdep_reset_lock_imm(struct lockdep_map * lock)6491c3bc8fd6SJoel Fernandes (Google) static void lockdep_reset_lock_imm(struct lockdep_map *lock)
64928eddac3fSPeter Zijlstra {
64938eddac3fSPeter Zijlstra 	struct pending_free *pf = delayed_free.pf;
64948eddac3fSPeter Zijlstra 	unsigned long flags;
64958eddac3fSPeter Zijlstra 
64968eddac3fSPeter Zijlstra 	raw_local_irq_save(flags);
64978eddac3fSPeter Zijlstra 	lockdep_lock();
64988eddac3fSPeter Zijlstra 	__lockdep_reset_lock(pf, lock);
64998eddac3fSPeter Zijlstra 	__free_zapped_classes(pf);
65008eddac3fSPeter Zijlstra 	lockdep_unlock();
65018eddac3fSPeter Zijlstra 	raw_local_irq_restore(flags);
65028eddac3fSPeter Zijlstra }
650309d75ecbSBart Van Assche 
lockdep_reset_lock(struct lockdep_map * lock)65047ff8517eSBart Van Assche void lockdep_reset_lock(struct lockdep_map *lock)
650501bb6f0aSYuyang Du {
65067ff8517eSBart Van Assche 	init_data_structures_once();
65077ff8517eSBart Van Assche 
6508ace35a7aSBart Van Assche 	if (inside_selftest())
6509a0b0fd53SBart Van Assche 		lockdep_reset_lock_imm(lock);
6510a0b0fd53SBart Van Assche 	else
65118eddac3fSPeter Zijlstra 		lockdep_reset_lock_reg(lock);
65127ff8517eSBart Van Assche }
651315ea86b5SBart Van Assche 
6514de4643a7SBart Van Assche /*
651515ea86b5SBart Van Assche  * Unregister a dynamically allocated key.
65168eddac3fSPeter Zijlstra  *
65178eddac3fSPeter Zijlstra  * Unlike lockdep_register_key(), a search is always done to find a matching
65188eddac3fSPeter Zijlstra  * key irrespective of debug_locks to avoid potential invalid access to freed
65198eddac3fSPeter Zijlstra  * memory in lock_class entry.
652012593b74SBart Van Assche  */
lockdep_unregister_key(struct lock_class_key * key)652112593b74SBart Van Assche void lockdep_unregister_key(struct lock_class_key *key)
652212593b74SBart Van Assche {
652312593b74SBart Van Assche 	struct hlist_head *hash_head = keyhashentry(key);
652412593b74SBart Van Assche 	struct lock_class_key *k;
652512593b74SBart Van Assche 	struct pending_free *pf;
652609d75ecbSBart Van Assche 	unsigned long flags;
65277ff8517eSBart Van Assche 	bool found = false;
65288eddac3fSPeter Zijlstra 
65298eddac3fSPeter Zijlstra 	might_sleep();
65308eddac3fSPeter Zijlstra 
65318eddac3fSPeter Zijlstra 	if (WARN_ON_ONCE(static_obj(key)))
65328eddac3fSPeter Zijlstra 		return;
65338eddac3fSPeter Zijlstra 
65348eddac3fSPeter Zijlstra 	raw_local_irq_save(flags);
65358eddac3fSPeter Zijlstra 	lockdep_lock();
65368eddac3fSPeter Zijlstra 
65378eddac3fSPeter Zijlstra 	hlist_for_each_entry_rcu(k, hash_head, hash_entry) {
65388eddac3fSPeter Zijlstra 		if (k == key) {
6539681fbec8SPaul E. McKenney 			hlist_del_rcu(&k->hash_entry);
6540a5dd63efSPaul E. McKenney 			found = true;
6541a5dd63efSPaul E. McKenney 			break;
65428eddac3fSPeter Zijlstra 		}
6543a5dd63efSPaul E. McKenney 	}
654404860d48SBorislav Petkov 	WARN_ON_ONCE(!found && debug_locks);
65458eddac3fSPeter Zijlstra 	if (found) {
65468eddac3fSPeter Zijlstra 		pf = get_pending_free();
65478eddac3fSPeter Zijlstra 		__lockdep_free_key_range(pf, key, 1);
65488eddac3fSPeter Zijlstra 		call_rcu_zapped(pf);
6549681fbec8SPaul E. McKenney 	}
65508eddac3fSPeter Zijlstra 	lockdep_unlock();
65518eddac3fSPeter Zijlstra 	raw_local_irq_restore(flags);
65528eddac3fSPeter Zijlstra 
65538eddac3fSPeter Zijlstra 	/* Wait until is_dynamic_key() has finished accessing k->hash_entry. */
65548eddac3fSPeter Zijlstra 	synchronize_rcu();
65558eddac3fSPeter Zijlstra }
65568eddac3fSPeter Zijlstra EXPORT_SYMBOL_GPL(lockdep_unregister_key);
65578eddac3fSPeter Zijlstra 
lockdep_init(void)65588eddac3fSPeter Zijlstra void __init lockdep_init(void)
65598eddac3fSPeter Zijlstra {
65608eddac3fSPeter Zijlstra 	printk("Lock dependency validator: Copyright (c) 2006 Red Hat, Inc., Ingo Molnar\n");
65618eddac3fSPeter Zijlstra 
65628eddac3fSPeter Zijlstra 	printk("... MAX_LOCKDEP_SUBCLASSES:  %lu\n", MAX_LOCKDEP_SUBCLASSES);
65638eddac3fSPeter Zijlstra 	printk("... MAX_LOCK_DEPTH:          %lu\n", MAX_LOCK_DEPTH);
65648eddac3fSPeter Zijlstra 	printk("... MAX_LOCKDEP_KEYS:        %lu\n", MAX_LOCKDEP_KEYS);
65658eddac3fSPeter Zijlstra 	printk("... CLASSHASH_SIZE:          %lu\n", CLASSHASH_SIZE);
65668eddac3fSPeter Zijlstra 	printk("... MAX_LOCKDEP_ENTRIES:     %lu\n", MAX_LOCKDEP_ENTRIES);
65678eddac3fSPeter Zijlstra 	printk("... MAX_LOCKDEP_CHAINS:      %lu\n", MAX_LOCKDEP_CHAINS);
65688eddac3fSPeter Zijlstra 	printk("... CHAINHASH_SIZE:          %lu\n", CHAINHASH_SIZE);
65698eddac3fSPeter Zijlstra 
65708eddac3fSPeter Zijlstra 	printk(" memory used by lock dependency info: %zu kB\n",
65718eddac3fSPeter Zijlstra 	       (sizeof(lock_classes) +
65728eddac3fSPeter Zijlstra 		sizeof(lock_classes_in_use) +
65738eddac3fSPeter Zijlstra 		sizeof(classhash_table) +
65748eddac3fSPeter Zijlstra 		sizeof(list_entries) +
6575fcc784beSSteven Rostedt (VMware) 		sizeof(list_entries_in_use) +
65768eddac3fSPeter Zijlstra 		sizeof(chainhash_table) +
65778eddac3fSPeter Zijlstra 		sizeof(delayed_free)
65788eddac3fSPeter Zijlstra #ifdef CONFIG_PROVE_LOCKING
65798eddac3fSPeter Zijlstra 		+ sizeof(lock_cq)
65808eddac3fSPeter Zijlstra 		+ sizeof(lock_chains)
65818eddac3fSPeter Zijlstra 		+ sizeof(lock_chains_in_use)
65828eddac3fSPeter Zijlstra 		+ sizeof(chain_hlocks)
65838eddac3fSPeter Zijlstra #endif
65848eddac3fSPeter Zijlstra 		) / 1024
65858eddac3fSPeter Zijlstra 		);
6586fcc784beSSteven Rostedt (VMware) 
65878eddac3fSPeter Zijlstra #if defined(CONFIG_TRACE_IRQFLAGS) && defined(CONFIG_PROVE_LOCKING)
65888eddac3fSPeter Zijlstra 	printk(" memory used for stack traces: %zu kB\n",
65898eddac3fSPeter Zijlstra 	       (sizeof(stack_trace) + sizeof(stack_trace_hash)) / 1024
65908eddac3fSPeter Zijlstra 	       );
65918eddac3fSPeter Zijlstra #endif
65928eddac3fSPeter Zijlstra 
65938eddac3fSPeter Zijlstra 	printk(" per task-struct memory footprint: %zu bytes\n",
65948eddac3fSPeter Zijlstra 	       sizeof(((struct task_struct *)NULL)->held_locks));
65958eddac3fSPeter Zijlstra }
65968eddac3fSPeter Zijlstra 
6597681fbec8SPaul E. McKenney static void
print_freed_lock_bug(struct task_struct * curr,const void * mem_from,const void * mem_to,struct held_lock * hlock)6598a5dd63efSPaul E. McKenney print_freed_lock_bug(struct task_struct *curr, const void *mem_from,
6599a5dd63efSPaul E. McKenney 		     const void *mem_to, struct held_lock *hlock)
66008eddac3fSPeter Zijlstra {
66018eddac3fSPeter Zijlstra 	if (!debug_locks_off())
6602a5dd63efSPaul E. McKenney 		return;
66038eddac3fSPeter Zijlstra 	if (debug_locks_silent)
6604681fbec8SPaul E. McKenney 		return;
66058eddac3fSPeter Zijlstra 
66068eddac3fSPeter Zijlstra 	nbcon_cpu_emergency_enter();
66078eddac3fSPeter Zijlstra 
66088eddac3fSPeter Zijlstra 	pr_warn("\n");
66098eddac3fSPeter Zijlstra 	pr_warn("=========================\n");
66108eddac3fSPeter Zijlstra 	pr_warn("WARNING: held lock freed!\n");
66118eddac3fSPeter Zijlstra 	print_kernel_ident();
66128eddac3fSPeter Zijlstra 	pr_warn("-------------------------\n");
66138eddac3fSPeter Zijlstra 	pr_warn("%s/%d is freeing memory %px-%px, with a lock still held there!\n",
66148eddac3fSPeter Zijlstra 		curr->comm, task_pid_nr(curr), mem_from, mem_to-1);
66158dce7a9aSSasha Levin 	print_lock(hlock);
66168eddac3fSPeter Zijlstra 	lockdep_print_held_locks(curr);
66178eddac3fSPeter Zijlstra 
66188eddac3fSPeter Zijlstra 	pr_warn("\nstack backtrace:\n");
66198eddac3fSPeter Zijlstra 	dump_stack();
66208eddac3fSPeter Zijlstra 
6621681fbec8SPaul E. McKenney 	nbcon_cpu_emergency_exit();
66228eddac3fSPeter Zijlstra }
66238eddac3fSPeter Zijlstra 
not_in_range(const void * mem_from,unsigned long mem_len,const void * lock_from,unsigned long lock_len)6624681fbec8SPaul E. McKenney static inline int not_in_range(const void* mem_from, unsigned long mem_len,
66258eddac3fSPeter Zijlstra 				const void* lock_from, unsigned long lock_len)
66260f736a52STetsuo Handa {
66270f736a52STetsuo Handa 	return lock_from + lock_len <= mem_from ||
66280f736a52STetsuo Handa 		mem_from + mem_len <= lock_from;
66290f736a52STetsuo Handa }
66308eddac3fSPeter Zijlstra 
663188f1c87dSTejun Heo /*
66320f736a52STetsuo Handa  * Called when kernel memory is freed (or unmapped), or if a lock
66330f736a52STetsuo Handa  * is destroyed or reinitialized - this code checks whether there is
66340f736a52STetsuo Handa  * any held lock in the memory range of <from> to <to>:
66358eddac3fSPeter Zijlstra  */
debug_check_no_locks_freed(const void * mem_from,unsigned long mem_len)6636681fbec8SPaul E. McKenney void debug_check_no_locks_freed(const void *mem_from, unsigned long mem_len)
6637a5dd63efSPaul E. McKenney {
66388eddac3fSPeter Zijlstra 	struct task_struct *curr = current;
66398eddac3fSPeter Zijlstra 	struct held_lock *hlock;
66408dce7a9aSSasha Levin 	unsigned long flags;
66418eddac3fSPeter Zijlstra 	int i;
66428eddac3fSPeter Zijlstra 
66438eddac3fSPeter Zijlstra 	if (unlikely(!debug_locks))
66448eddac3fSPeter Zijlstra 		return;
66458eddac3fSPeter Zijlstra 
66468eddac3fSPeter Zijlstra 	raw_local_irq_save(flags);
66478eddac3fSPeter Zijlstra 	for (i = 0; i < curr->lockdep_depth; i++) {
66488eddac3fSPeter Zijlstra 		hlock = curr->held_locks + i;
66498eddac3fSPeter Zijlstra 
66508eddac3fSPeter Zijlstra 		if (not_in_range(mem_from, mem_len, hlock->instance,
66518eddac3fSPeter Zijlstra 					sizeof(*hlock->instance)))
66528eddac3fSPeter Zijlstra 			continue;
66538eddac3fSPeter Zijlstra 
66548eddac3fSPeter Zijlstra 		print_freed_lock_bug(curr, mem_from, mem_from + mem_len, hlock);
66558eddac3fSPeter Zijlstra 		break;
6656722a9f92SAndi Kleen 	}
66578eddac3fSPeter Zijlstra 	raw_local_irq_restore(flags);
66588eddac3fSPeter Zijlstra }
66598eddac3fSPeter Zijlstra EXPORT_SYMBOL_GPL(debug_check_no_locks_freed);
66608eddac3fSPeter Zijlstra 
print_held_locks_bug(void)66618eddac3fSPeter Zijlstra static void print_held_locks_bug(void)
66628eddac3fSPeter Zijlstra {
6663681fbec8SPaul E. McKenney 	if (!debug_locks_off())
6664a5dd63efSPaul E. McKenney 		return;
6665a5dd63efSPaul E. McKenney 	if (debug_locks_silent)
66668eddac3fSPeter Zijlstra 		return;
6667a5dd63efSPaul E. McKenney 
6668681fbec8SPaul E. McKenney 	nbcon_cpu_emergency_enter();
66698eddac3fSPeter Zijlstra 
66708eddac3fSPeter Zijlstra 	pr_warn("\n");
66718eddac3fSPeter Zijlstra 	pr_warn("====================================\n");
6672b09be676SByungchul Park 	pr_warn("WARNING: %s/%d still has locks held!\n",
6673b09be676SByungchul Park 	       current->comm, task_pid_nr(current));
6674b09be676SByungchul Park 	print_kernel_ident();
6675b09be676SByungchul Park 	pr_warn("------------------------------------\n");
6676b09be676SByungchul Park 	lockdep_print_held_locks(current);
6677f52be570SPeter Zijlstra 	pr_warn("\nstack backtrace:\n");
66788eddac3fSPeter Zijlstra 	dump_stack();
66798eddac3fSPeter Zijlstra 
66808eddac3fSPeter Zijlstra 	nbcon_cpu_emergency_exit();
66818eddac3fSPeter Zijlstra }
66828eddac3fSPeter Zijlstra 
debug_check_no_locks_held(void)66831feb2cc8SPaul E. McKenney void debug_check_no_locks_held(void)
66845a5d7e9bSPeter Zijlstra {
66858eddac3fSPeter Zijlstra 	if (unlikely(current->lockdep_depth > 0))
66868eddac3fSPeter Zijlstra 		print_held_locks_bug();
6687681fbec8SPaul E. McKenney }
6688a5dd63efSPaul E. McKenney EXPORT_SYMBOL_GPL(debug_check_no_locks_held);
6689a5dd63efSPaul E. McKenney 
66908eddac3fSPeter Zijlstra #ifdef __KERNEL__
debug_show_all_locks(void)6691a5dd63efSPaul E. McKenney void debug_show_all_locks(void)
6692681fbec8SPaul E. McKenney {
6693681fbec8SPaul E. McKenney 	struct task_struct *g, *p;
66941feb2cc8SPaul E. McKenney 
66958eddac3fSPeter Zijlstra 	if (unlikely(!debug_locks)) {
66968eddac3fSPeter Zijlstra 		pr_warn("INFO: lockdep is turned off.\n");
66978eddac3fSPeter Zijlstra 		return;
66981feb2cc8SPaul E. McKenney 	}
66991feb2cc8SPaul E. McKenney 	pr_warn("\nShowing all locks held in the system:\n");
67008eddac3fSPeter Zijlstra 
67018eddac3fSPeter Zijlstra 	rcu_read_lock();
67028eddac3fSPeter Zijlstra 	for_each_process_thread(g, p) {
6703e67198ccSFrederic Weisbecker 		if (!p->lockdep_depth)
67048eddac3fSPeter Zijlstra 			continue;
67058eddac3fSPeter Zijlstra 		lockdep_print_held_locks(p);
67068eddac3fSPeter Zijlstra 		touch_nmi_watchdog();
67078eddac3fSPeter Zijlstra 		touch_all_softlockup_watchdogs();
67088eddac3fSPeter Zijlstra 	}
67098eddac3fSPeter Zijlstra 	rcu_read_unlock();
67108eddac3fSPeter Zijlstra 
67118eddac3fSPeter Zijlstra 	pr_warn("\n");
67128eddac3fSPeter Zijlstra 	pr_warn("=============================================\n\n");
67138eddac3fSPeter Zijlstra }
67148eddac3fSPeter Zijlstra EXPORT_SYMBOL_GPL(debug_show_all_locks);
67158eddac3fSPeter Zijlstra #endif
67168eddac3fSPeter Zijlstra 
67178eddac3fSPeter Zijlstra /*
67188eddac3fSPeter Zijlstra  * Careful: only use this function if you are sure that
67198eddac3fSPeter Zijlstra  * the task cannot run in parallel!
6720681fbec8SPaul E. McKenney  */
debug_show_held_locks(struct task_struct * task)67218eddac3fSPeter Zijlstra void debug_show_held_locks(struct task_struct *task)
67228eddac3fSPeter Zijlstra {
6723681fbec8SPaul E. McKenney 	if (unlikely(!debug_locks)) {
67248eddac3fSPeter Zijlstra 		printk("INFO: lockdep is turned off.\n");
67255a5d7e9bSPeter Zijlstra 		return;
67268eddac3fSPeter Zijlstra 	}
67278eddac3fSPeter Zijlstra 	lockdep_print_held_locks(task);
6728 }
6729 EXPORT_SYMBOL_GPL(debug_show_held_locks);
6730 
lockdep_sys_exit(void)6731 asmlinkage __visible void lockdep_sys_exit(void)
6732 {
6733 	struct task_struct *curr = current;
6734 
6735 	if (unlikely(curr->lockdep_depth)) {
6736 		if (!debug_locks_off())
6737 			return;
6738 		nbcon_cpu_emergency_enter();
6739 		pr_warn("\n");
6740 		pr_warn("================================================\n");
6741 		pr_warn("WARNING: lock held when returning to user space!\n");
6742 		print_kernel_ident();
6743 		pr_warn("------------------------------------------------\n");
6744 		pr_warn("%s/%d is leaving the kernel with locks still held!\n",
6745 				curr->comm, curr->pid);
6746 		lockdep_print_held_locks(curr);
6747 		nbcon_cpu_emergency_exit();
6748 	}
6749 
6750 	/*
6751 	 * The lock history for each syscall should be independent. So wipe the
6752 	 * slate clean on return to userspace.
6753 	 */
6754 	lockdep_invariant_state(false);
6755 }
6756 
lockdep_rcu_suspicious(const char * file,const int line,const char * s)6757 void lockdep_rcu_suspicious(const char *file, const int line, const char *s)
6758 {
6759 	struct task_struct *curr = current;
6760 	int dl = READ_ONCE(debug_locks);
6761 	bool rcu = warn_rcu_enter();
6762 
6763 	/* Note: the following can be executed concurrently, so be careful. */
6764 	nbcon_cpu_emergency_enter();
6765 	pr_warn("\n");
6766 	pr_warn("=============================\n");
6767 	pr_warn("WARNING: suspicious RCU usage\n");
6768 	print_kernel_ident();
6769 	pr_warn("-----------------------------\n");
6770 	pr_warn("%s:%d %s!\n", file, line, s);
6771 	pr_warn("\nother info that might help us debug this:\n\n");
6772 	pr_warn("\n%srcu_scheduler_active = %d, debug_locks = %d\n%s",
6773 	       !rcu_lockdep_current_cpu_online()
6774 			? "RCU used illegally from offline CPU!\n"
6775 			: "",
6776 	       rcu_scheduler_active, dl,
6777 	       dl ? "" : "Possible false positive due to lockdep disabling via debug_locks = 0\n");
6778 
6779 	/*
6780 	 * If a CPU is in the RCU-free window in idle (ie: in the section
6781 	 * between ct_idle_enter() and ct_idle_exit(), then RCU
6782 	 * considers that CPU to be in an "extended quiescent state",
6783 	 * which means that RCU will be completely ignoring that CPU.
6784 	 * Therefore, rcu_read_lock() and friends have absolutely no
6785 	 * effect on a CPU running in that state. In other words, even if
6786 	 * such an RCU-idle CPU has called rcu_read_lock(), RCU might well
6787 	 * delete data structures out from under it.  RCU really has no
6788 	 * choice here: we need to keep an RCU-free window in idle where
6789 	 * the CPU may possibly enter into low power mode. This way we can
6790 	 * notice an extended quiescent state to other CPUs that started a grace
6791 	 * period. Otherwise we would delay any grace period as long as we run
6792 	 * in the idle task.
6793 	 *
6794 	 * So complain bitterly if someone does call rcu_read_lock(),
6795 	 * rcu_read_lock_bh() and so on from extended quiescent states.
6796 	 */
6797 	if (!rcu_is_watching())
6798 		pr_warn("RCU used illegally from extended quiescent state!\n");
6799 
6800 	lockdep_print_held_locks(curr);
6801 	pr_warn("\nstack backtrace:\n");
6802 	dump_stack();
6803 	nbcon_cpu_emergency_exit();
6804 	warn_rcu_exit(rcu);
6805 }
6806 EXPORT_SYMBOL_GPL(lockdep_rcu_suspicious);
6807