blob: 2d4c21a02546ea52e81acc2c77b788c532c11db6 [file] [log] [blame]
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07001/*
2 * kernel/lockdep.c
3 *
4 * Runtime locking correctness validator
5 *
6 * Started by Ingo Molnar:
7 *
Peter Zijlstra4b32d0a2007-07-19 01:48:59 -07008 * Copyright (C) 2006,2007 Red Hat, Inc., Ingo Molnar <mingo@redhat.com>
Peter Zijlstra90eec102015-11-16 11:08:45 +01009 * Copyright (C) 2007 Red Hat, Inc., Peter Zijlstra
Ingo Molnarfbb9ce952006-07-03 00:24:50 -070010 *
11 * this code maps all the lock dependencies as they occur in a live kernel
12 * and will warn about the following classes of locking bugs:
13 *
14 * - lock inversion scenarios
15 * - circular lock dependencies
16 * - hardirq/softirq safe/unsafe locking bugs
17 *
18 * Bugs are reported even if the current locking scenario does not cause
19 * any deadlock at this point.
20 *
21 * I.e. if anytime in the past two locks were taken in a different order,
22 * even if it happened for another task, even if those were different
23 * locks (but of the same class as this lock), this code will detect it.
24 *
25 * Thanks to Arjan van de Ven for coming up with the initial idea of
26 * mapping lock dependencies runtime.
27 */
Steven Rostedta5e25882008-12-02 15:34:05 -050028#define DISABLE_BRANCH_PROFILING
Ingo Molnarfbb9ce952006-07-03 00:24:50 -070029#include <linux/mutex.h>
30#include <linux/sched.h>
Ingo Molnare6017572017-02-01 16:36:40 +010031#include <linux/sched/clock.h>
Ingo Molnar29930022017-02-08 18:51:36 +010032#include <linux/sched/task.h>
Nikolay Borisov6d7225f2017-05-03 14:53:05 -070033#include <linux/sched/mm.h>
Ingo Molnarfbb9ce952006-07-03 00:24:50 -070034#include <linux/delay.h>
35#include <linux/module.h>
36#include <linux/proc_fs.h>
37#include <linux/seq_file.h>
38#include <linux/spinlock.h>
39#include <linux/kallsyms.h>
40#include <linux/interrupt.h>
41#include <linux/stacktrace.h>
42#include <linux/debug_locks.h>
43#include <linux/irqflags.h>
Dave Jones99de0552006-09-29 02:00:10 -070044#include <linux/utsname.h>
Peter Zijlstra4b32d0a2007-07-19 01:48:59 -070045#include <linux/hash.h>
Steven Rostedt81d68a92008-05-12 21:20:42 +020046#include <linux/ftrace.h>
Peter Zijlstrab4b136f2009-01-29 14:50:36 +010047#include <linux/stringify.h>
Ming Leid588e462009-07-16 15:44:29 +020048#include <linux/bitops.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090049#include <linux/gfp.h>
Peter Zijlstrae7904a22015-08-01 19:25:08 +020050#include <linux/random.h>
Peter Zijlstradfaaf3f2016-05-30 18:31:33 +020051#include <linux/jhash.h>
Tejun Heo88f1c872018-01-22 14:00:55 -080052#include <linux/nmi.h>
Peter Zijlstraaf012962009-07-16 15:44:29 +020053
Ingo Molnarfbb9ce952006-07-03 00:24:50 -070054#include <asm/sections.h>
55
56#include "lockdep_internals.h"
57
Steven Rostedta8d154b2009-04-10 09:36:00 -040058#define CREATE_TRACE_POINTS
Frederic Weisbecker67178762009-11-13 10:06:34 +010059#include <trace/events/lock.h>
Steven Rostedta8d154b2009-04-10 09:36:00 -040060
Peter Zijlstraf20786f2007-07-19 01:48:56 -070061#ifdef CONFIG_PROVE_LOCKING
62int prove_locking = 1;
63module_param(prove_locking, int, 0644);
64#else
65#define prove_locking 0
66#endif
67
68#ifdef CONFIG_LOCK_STAT
69int lock_stat = 1;
70module_param(lock_stat, int, 0644);
71#else
72#define lock_stat 0
73#endif
74
Ingo Molnarfbb9ce952006-07-03 00:24:50 -070075/*
Ingo Molnar74c383f2006-12-13 00:34:43 -080076 * lockdep_lock: protects the lockdep graph, the hashes and the
77 * class/list/hash allocators.
Ingo Molnarfbb9ce952006-07-03 00:24:50 -070078 *
79 * This is one of the rare exceptions where it's justified
80 * to use a raw spinlock - we really dont want the spinlock
Ingo Molnar74c383f2006-12-13 00:34:43 -080081 * code to recurse back into the lockdep code...
Ingo Molnarfbb9ce952006-07-03 00:24:50 -070082 */
Thomas Gleixneredc35bd2009-12-03 12:38:57 +010083static arch_spinlock_t lockdep_lock = (arch_spinlock_t)__ARCH_SPIN_LOCK_UNLOCKED;
Ingo Molnar74c383f2006-12-13 00:34:43 -080084
85static int graph_lock(void)
86{
Thomas Gleixner0199c4e2009-12-02 20:01:25 +010087 arch_spin_lock(&lockdep_lock);
Ingo Molnar74c383f2006-12-13 00:34:43 -080088 /*
89 * Make sure that if another CPU detected a bug while
90 * walking the graph we dont change it (while the other
91 * CPU is busy printing out stuff with the graph lock
92 * dropped already)
93 */
94 if (!debug_locks) {
Thomas Gleixner0199c4e2009-12-02 20:01:25 +010095 arch_spin_unlock(&lockdep_lock);
Ingo Molnar74c383f2006-12-13 00:34:43 -080096 return 0;
97 }
Steven Rostedtbb065af2008-05-12 21:21:00 +020098 /* prevent any recursions within lockdep from causing deadlocks */
99 current->lockdep_recursion++;
Ingo Molnar74c383f2006-12-13 00:34:43 -0800100 return 1;
101}
102
103static inline int graph_unlock(void)
104{
Peter Zijlstra0119fee2011-09-02 01:30:29 +0200105 if (debug_locks && !arch_spin_is_locked(&lockdep_lock)) {
106 /*
107 * The lockdep graph lock isn't locked while we expect it to
108 * be, we're confused now, bye!
109 */
Jarek Poplawski381a2292007-02-10 01:44:58 -0800110 return DEBUG_LOCKS_WARN_ON(1);
Peter Zijlstra0119fee2011-09-02 01:30:29 +0200111 }
Jarek Poplawski381a2292007-02-10 01:44:58 -0800112
Steven Rostedtbb065af2008-05-12 21:21:00 +0200113 current->lockdep_recursion--;
Thomas Gleixner0199c4e2009-12-02 20:01:25 +0100114 arch_spin_unlock(&lockdep_lock);
Ingo Molnar74c383f2006-12-13 00:34:43 -0800115 return 0;
116}
117
118/*
119 * Turn lock debugging off and return with 0 if it was off already,
120 * and also release the graph lock:
121 */
122static inline int debug_locks_off_graph_unlock(void)
123{
124 int ret = debug_locks_off();
125
Thomas Gleixner0199c4e2009-12-02 20:01:25 +0100126 arch_spin_unlock(&lockdep_lock);
Ingo Molnar74c383f2006-12-13 00:34:43 -0800127
128 return ret;
129}
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700130
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700131unsigned long nr_list_entries;
Peter Zijlstraaf012962009-07-16 15:44:29 +0200132static struct lock_list list_entries[MAX_LOCKDEP_ENTRIES];
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700133
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700134/*
135 * All data structures here are protected by the global debug_lock.
136 *
137 * Mutex key structs only get allocated, once during bootup, and never
138 * get freed - this significantly simplifies the debugging code.
139 */
140unsigned long nr_lock_classes;
Bart Van Assche1431a5d2018-12-06 17:11:32 -0800141#ifndef CONFIG_DEBUG_LOCKDEP
142static
143#endif
Waiman Long8ca2b56c2018-10-03 13:07:18 -0400144struct lock_class lock_classes[MAX_LOCKDEP_KEYS];
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700145
Dave Jonesf82b2172008-08-11 09:30:23 +0200146static inline struct lock_class *hlock_class(struct held_lock *hlock)
147{
148 if (!hlock->class_idx) {
Peter Zijlstra0119fee2011-09-02 01:30:29 +0200149 /*
150 * Someone passed in garbage, we give up.
151 */
Dave Jonesf82b2172008-08-11 09:30:23 +0200152 DEBUG_LOCKS_WARN_ON(1);
153 return NULL;
154 }
155 return lock_classes + hlock->class_idx - 1;
156}
157
Peter Zijlstraf20786f2007-07-19 01:48:56 -0700158#ifdef CONFIG_LOCK_STAT
Peter Zijlstra25528212016-03-15 14:52:49 -0700159static DEFINE_PER_CPU(struct lock_class_stats[MAX_LOCKDEP_KEYS], cpu_lock_stats);
Peter Zijlstraf20786f2007-07-19 01:48:56 -0700160
Peter Zijlstra3365e7792009-10-09 10:12:41 +0200161static inline u64 lockstat_clock(void)
162{
Peter Zijlstrac6763292010-05-25 10:48:51 +0200163 return local_clock();
Peter Zijlstra3365e7792009-10-09 10:12:41 +0200164}
165
Peter Zijlstrac7e78cf2008-10-16 23:17:09 +0200166static int lock_point(unsigned long points[], unsigned long ip)
Peter Zijlstraf20786f2007-07-19 01:48:56 -0700167{
168 int i;
169
Peter Zijlstrac7e78cf2008-10-16 23:17:09 +0200170 for (i = 0; i < LOCKSTAT_POINTS; i++) {
171 if (points[i] == 0) {
172 points[i] = ip;
Peter Zijlstraf20786f2007-07-19 01:48:56 -0700173 break;
174 }
Peter Zijlstrac7e78cf2008-10-16 23:17:09 +0200175 if (points[i] == ip)
Peter Zijlstraf20786f2007-07-19 01:48:56 -0700176 break;
177 }
178
179 return i;
180}
181
Peter Zijlstra3365e7792009-10-09 10:12:41 +0200182static void lock_time_inc(struct lock_time *lt, u64 time)
Peter Zijlstraf20786f2007-07-19 01:48:56 -0700183{
184 if (time > lt->max)
185 lt->max = time;
186
Frank Rowand109d71c2009-11-19 13:42:06 -0800187 if (time < lt->min || !lt->nr)
Peter Zijlstraf20786f2007-07-19 01:48:56 -0700188 lt->min = time;
189
190 lt->total += time;
191 lt->nr++;
192}
193
Peter Zijlstrac46261d2007-07-19 01:48:57 -0700194static inline void lock_time_add(struct lock_time *src, struct lock_time *dst)
195{
Frank Rowand109d71c2009-11-19 13:42:06 -0800196 if (!src->nr)
197 return;
198
199 if (src->max > dst->max)
200 dst->max = src->max;
201
202 if (src->min < dst->min || !dst->nr)
203 dst->min = src->min;
204
Peter Zijlstrac46261d2007-07-19 01:48:57 -0700205 dst->total += src->total;
206 dst->nr += src->nr;
207}
208
209struct lock_class_stats lock_stats(struct lock_class *class)
210{
211 struct lock_class_stats stats;
212 int cpu, i;
213
214 memset(&stats, 0, sizeof(struct lock_class_stats));
215 for_each_possible_cpu(cpu) {
216 struct lock_class_stats *pcs =
Tejun Heo1871e522009-10-29 22:34:13 +0900217 &per_cpu(cpu_lock_stats, cpu)[class - lock_classes];
Peter Zijlstrac46261d2007-07-19 01:48:57 -0700218
219 for (i = 0; i < ARRAY_SIZE(stats.contention_point); i++)
220 stats.contention_point[i] += pcs->contention_point[i];
221
Peter Zijlstrac7e78cf2008-10-16 23:17:09 +0200222 for (i = 0; i < ARRAY_SIZE(stats.contending_point); i++)
223 stats.contending_point[i] += pcs->contending_point[i];
224
Peter Zijlstrac46261d2007-07-19 01:48:57 -0700225 lock_time_add(&pcs->read_waittime, &stats.read_waittime);
226 lock_time_add(&pcs->write_waittime, &stats.write_waittime);
227
228 lock_time_add(&pcs->read_holdtime, &stats.read_holdtime);
229 lock_time_add(&pcs->write_holdtime, &stats.write_holdtime);
Peter Zijlstra96645672007-07-19 01:49:00 -0700230
231 for (i = 0; i < ARRAY_SIZE(stats.bounces); i++)
232 stats.bounces[i] += pcs->bounces[i];
Peter Zijlstrac46261d2007-07-19 01:48:57 -0700233 }
234
235 return stats;
236}
237
238void clear_lock_stats(struct lock_class *class)
239{
240 int cpu;
241
242 for_each_possible_cpu(cpu) {
243 struct lock_class_stats *cpu_stats =
Tejun Heo1871e522009-10-29 22:34:13 +0900244 &per_cpu(cpu_lock_stats, cpu)[class - lock_classes];
Peter Zijlstrac46261d2007-07-19 01:48:57 -0700245
246 memset(cpu_stats, 0, sizeof(struct lock_class_stats));
247 }
248 memset(class->contention_point, 0, sizeof(class->contention_point));
Peter Zijlstrac7e78cf2008-10-16 23:17:09 +0200249 memset(class->contending_point, 0, sizeof(class->contending_point));
Peter Zijlstrac46261d2007-07-19 01:48:57 -0700250}
251
Peter Zijlstraf20786f2007-07-19 01:48:56 -0700252static struct lock_class_stats *get_lock_stats(struct lock_class *class)
253{
Joel Fernandes (Google)01f38492018-07-30 15:24:21 -0700254 return &this_cpu_ptr(cpu_lock_stats)[class - lock_classes];
Peter Zijlstraf20786f2007-07-19 01:48:56 -0700255}
256
257static void lock_release_holdtime(struct held_lock *hlock)
258{
259 struct lock_class_stats *stats;
Peter Zijlstra3365e7792009-10-09 10:12:41 +0200260 u64 holdtime;
Peter Zijlstraf20786f2007-07-19 01:48:56 -0700261
262 if (!lock_stat)
263 return;
264
Peter Zijlstra3365e7792009-10-09 10:12:41 +0200265 holdtime = lockstat_clock() - hlock->holdtime_stamp;
Peter Zijlstraf20786f2007-07-19 01:48:56 -0700266
Dave Jonesf82b2172008-08-11 09:30:23 +0200267 stats = get_lock_stats(hlock_class(hlock));
Peter Zijlstraf20786f2007-07-19 01:48:56 -0700268 if (hlock->read)
269 lock_time_inc(&stats->read_holdtime, holdtime);
270 else
271 lock_time_inc(&stats->write_holdtime, holdtime);
Peter Zijlstraf20786f2007-07-19 01:48:56 -0700272}
273#else
274static inline void lock_release_holdtime(struct held_lock *hlock)
275{
276}
277#endif
278
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700279/*
280 * We keep a global list of all lock classes. The list only grows,
281 * never shrinks. The list is only accessed with the lockdep
282 * spinlock lock held.
283 */
284LIST_HEAD(all_lock_classes);
285
286/*
287 * The lockdep classes are in a hash-table as well, for fast lookup:
288 */
289#define CLASSHASH_BITS (MAX_LOCKDEP_KEYS_BITS - 1)
290#define CLASSHASH_SIZE (1UL << CLASSHASH_BITS)
Peter Zijlstra4b32d0a2007-07-19 01:48:59 -0700291#define __classhashfn(key) hash_long((unsigned long)key, CLASSHASH_BITS)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700292#define classhashentry(key) (classhash_table + __classhashfn((key)))
293
Andrew Mortona63f38c2016-02-03 13:44:12 -0800294static struct hlist_head classhash_table[CLASSHASH_SIZE];
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700295
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700296/*
297 * We put the lock dependency chains into a hash-table as well, to cache
298 * their existence:
299 */
300#define CHAINHASH_BITS (MAX_LOCKDEP_CHAINS_BITS-1)
301#define CHAINHASH_SIZE (1UL << CHAINHASH_BITS)
Peter Zijlstra4b32d0a2007-07-19 01:48:59 -0700302#define __chainhashfn(chain) hash_long(chain, CHAINHASH_BITS)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700303#define chainhashentry(chain) (chainhash_table + __chainhashfn((chain)))
304
Andrew Mortona63f38c2016-02-03 13:44:12 -0800305static struct hlist_head chainhash_table[CHAINHASH_SIZE];
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700306
307/*
308 * The hash key of the lock dependency chains is a hash itself too:
309 * it's a hash of all locks taken up to that lock, including that lock.
310 * It's a 64-bit hash, because it's important for the keys to be
311 * unique.
312 */
Peter Zijlstradfaaf3f2016-05-30 18:31:33 +0200313static inline u64 iterate_chain_key(u64 key, u32 idx)
314{
315 u32 k0 = key, k1 = key >> 32;
316
317 __jhash_mix(idx, k0, k1); /* Macro that modifies arguments! */
318
319 return k0 | (u64)k1 << 32;
320}
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700321
Steven Rostedt1d09daa2008-05-12 21:20:55 +0200322void lockdep_off(void)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700323{
324 current->lockdep_recursion++;
325}
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700326EXPORT_SYMBOL(lockdep_off);
327
Steven Rostedt1d09daa2008-05-12 21:20:55 +0200328void lockdep_on(void)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700329{
330 current->lockdep_recursion--;
331}
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700332EXPORT_SYMBOL(lockdep_on);
333
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700334/*
335 * Debugging switches:
336 */
337
338#define VERBOSE 0
Ingo Molnar33e94e92006-12-13 00:34:41 -0800339#define VERY_VERBOSE 0
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700340
341#if VERBOSE
342# define HARDIRQ_VERBOSE 1
343# define SOFTIRQ_VERBOSE 1
344#else
345# define HARDIRQ_VERBOSE 0
346# define SOFTIRQ_VERBOSE 0
347#endif
348
Peter Zijlstrad92a8cf2017-03-03 10:13:38 +0100349#if VERBOSE || HARDIRQ_VERBOSE || SOFTIRQ_VERBOSE
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700350/*
351 * Quick filtering for interesting events:
352 */
353static int class_filter(struct lock_class *class)
354{
Andi Kleenf9829cc2006-07-10 04:44:01 -0700355#if 0
356 /* Example */
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700357 if (class->name_version == 1 &&
Andi Kleenf9829cc2006-07-10 04:44:01 -0700358 !strcmp(class->name, "lockname"))
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700359 return 1;
360 if (class->name_version == 1 &&
Andi Kleenf9829cc2006-07-10 04:44:01 -0700361 !strcmp(class->name, "&struct->lockfield"))
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700362 return 1;
Andi Kleenf9829cc2006-07-10 04:44:01 -0700363#endif
Ingo Molnara6640892006-12-13 00:34:39 -0800364 /* Filter everything else. 1 would be to allow everything else */
365 return 0;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700366}
367#endif
368
369static int verbose(struct lock_class *class)
370{
371#if VERBOSE
372 return class_filter(class);
373#endif
374 return 0;
375}
376
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700377/*
378 * Stack-trace: tightly packed array of stack backtrace
Ingo Molnar74c383f2006-12-13 00:34:43 -0800379 * addresses. Protected by the graph_lock.
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700380 */
381unsigned long nr_stack_trace_entries;
382static unsigned long stack_trace[MAX_STACK_TRACE_ENTRIES];
383
Dave Jones2c522832013-04-25 13:40:02 -0400384static void print_lockdep_off(const char *bug_msg)
385{
386 printk(KERN_DEBUG "%s\n", bug_msg);
387 printk(KERN_DEBUG "turning off the locking correctness validator.\n");
Andreas Gruenbacheracf59372014-07-15 21:10:52 +0200388#ifdef CONFIG_LOCK_STAT
Dave Jones2c522832013-04-25 13:40:02 -0400389 printk(KERN_DEBUG "Please attach the output of /proc/lock_stat to the bug report\n");
Andreas Gruenbacheracf59372014-07-15 21:10:52 +0200390#endif
Dave Jones2c522832013-04-25 13:40:02 -0400391}
392
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700393static int save_trace(struct stack_trace *trace)
394{
395 trace->nr_entries = 0;
396 trace->max_entries = MAX_STACK_TRACE_ENTRIES - nr_stack_trace_entries;
397 trace->entries = stack_trace + nr_stack_trace_entries;
398
Andi Kleen5a1b3992006-09-26 10:52:34 +0200399 trace->skip = 3;
Andi Kleen5a1b3992006-09-26 10:52:34 +0200400
Christoph Hellwigab1b6f02007-05-08 00:23:29 -0700401 save_stack_trace(trace);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700402
Peter Zijlstra4f84f432009-07-20 15:27:04 +0200403 /*
404 * Some daft arches put -1 at the end to indicate its a full trace.
405 *
406 * <rant> this is buggy anyway, since it takes a whole extra entry so a
407 * complete trace that maxes out the entries provided will be reported
408 * as incomplete, friggin useless </rant>
409 */
Luck, Tonyea5b41f2009-12-09 14:29:36 -0800410 if (trace->nr_entries != 0 &&
411 trace->entries[trace->nr_entries-1] == ULONG_MAX)
Peter Zijlstra4f84f432009-07-20 15:27:04 +0200412 trace->nr_entries--;
413
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700414 trace->max_entries = trace->nr_entries;
415
416 nr_stack_trace_entries += trace->nr_entries;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700417
Peter Zijlstra4f84f432009-07-20 15:27:04 +0200418 if (nr_stack_trace_entries >= MAX_STACK_TRACE_ENTRIES-1) {
Ingo Molnar74c383f2006-12-13 00:34:43 -0800419 if (!debug_locks_off_graph_unlock())
420 return 0;
421
Dave Jones2c522832013-04-25 13:40:02 -0400422 print_lockdep_off("BUG: MAX_STACK_TRACE_ENTRIES too low!");
Ingo Molnar74c383f2006-12-13 00:34:43 -0800423 dump_stack();
424
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700425 return 0;
426 }
427
428 return 1;
429}
430
431unsigned int nr_hardirq_chains;
432unsigned int nr_softirq_chains;
433unsigned int nr_process_chains;
434unsigned int max_lockdep_depth;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700435
436#ifdef CONFIG_DEBUG_LOCKDEP
437/*
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700438 * Various lockdep statistics:
439 */
Frederic Weisbeckerbd6d29c2010-04-06 00:10:17 +0200440DEFINE_PER_CPU(struct lockdep_stats, lockdep_stats);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700441#endif
442
443/*
444 * Locking printouts:
445 */
446
Peter Zijlstrafabe9c42009-01-22 14:51:01 +0100447#define __USAGE(__STATE) \
Peter Zijlstrab4b136f2009-01-29 14:50:36 +0100448 [LOCK_USED_IN_##__STATE] = "IN-"__stringify(__STATE)"-W", \
449 [LOCK_ENABLED_##__STATE] = __stringify(__STATE)"-ON-W", \
450 [LOCK_USED_IN_##__STATE##_READ] = "IN-"__stringify(__STATE)"-R",\
451 [LOCK_ENABLED_##__STATE##_READ] = __stringify(__STATE)"-ON-R",
Peter Zijlstrafabe9c42009-01-22 14:51:01 +0100452
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700453static const char *usage_str[] =
454{
Peter Zijlstrafabe9c42009-01-22 14:51:01 +0100455#define LOCKDEP_STATE(__STATE) __USAGE(__STATE)
456#include "lockdep_states.h"
457#undef LOCKDEP_STATE
458 [LOCK_USED] = "INITIAL USE",
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700459};
460
461const char * __get_key_name(struct lockdep_subclass_key *key, char *str)
462{
Alexey Dobriyanffb45122007-05-08 00:28:41 -0700463 return kallsyms_lookup((unsigned long)key, NULL, NULL, NULL, str);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700464}
465
Peter Zijlstra3ff176c2009-01-22 17:40:42 +0100466static inline unsigned long lock_flag(enum lock_usage_bit bit)
467{
468 return 1UL << bit;
469}
470
471static char get_usage_char(struct lock_class *class, enum lock_usage_bit bit)
472{
473 char c = '.';
474
475 if (class->usage_mask & lock_flag(bit + 2))
476 c = '+';
477 if (class->usage_mask & lock_flag(bit)) {
478 c = '-';
479 if (class->usage_mask & lock_flag(bit + 2))
480 c = '?';
481 }
482
483 return c;
484}
485
Peter Zijlstraf510b232009-01-22 17:53:47 +0100486void get_usage_chars(struct lock_class *class, char usage[LOCK_USAGE_CHARS])
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700487{
Peter Zijlstraf510b232009-01-22 17:53:47 +0100488 int i = 0;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700489
Peter Zijlstraf510b232009-01-22 17:53:47 +0100490#define LOCKDEP_STATE(__STATE) \
491 usage[i++] = get_usage_char(class, LOCK_USED_IN_##__STATE); \
492 usage[i++] = get_usage_char(class, LOCK_USED_IN_##__STATE##_READ);
493#include "lockdep_states.h"
494#undef LOCKDEP_STATE
495
496 usage[i] = '\0';
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700497}
498
Steven Rostedte5e78d02011-11-02 20:24:16 -0400499static void __print_lock_name(struct lock_class *class)
Steven Rostedt3003eba2011-04-20 21:41:54 -0400500{
501 char str[KSYM_NAME_LEN];
502 const char *name;
503
504 name = class->name;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700505 if (!name) {
506 name = __get_key_name(class->key, str);
Dmitry Vyukovf943fe02016-11-28 15:24:43 +0100507 printk(KERN_CONT "%s", name);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700508 } else {
Dmitry Vyukovf943fe02016-11-28 15:24:43 +0100509 printk(KERN_CONT "%s", name);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700510 if (class->name_version > 1)
Dmitry Vyukovf943fe02016-11-28 15:24:43 +0100511 printk(KERN_CONT "#%d", class->name_version);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700512 if (class->subclass)
Dmitry Vyukovf943fe02016-11-28 15:24:43 +0100513 printk(KERN_CONT "/%d", class->subclass);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700514 }
Steven Rostedte5e78d02011-11-02 20:24:16 -0400515}
516
517static void print_lock_name(struct lock_class *class)
518{
519 char usage[LOCK_USAGE_CHARS];
520
521 get_usage_chars(class, usage);
522
Dmitry Vyukovf943fe02016-11-28 15:24:43 +0100523 printk(KERN_CONT " (");
Steven Rostedte5e78d02011-11-02 20:24:16 -0400524 __print_lock_name(class);
Dmitry Vyukovf943fe02016-11-28 15:24:43 +0100525 printk(KERN_CONT "){%s}", usage);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700526}
527
528static void print_lockdep_cache(struct lockdep_map *lock)
529{
530 const char *name;
Tejun Heo9281ace2007-07-17 04:03:51 -0700531 char str[KSYM_NAME_LEN];
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700532
533 name = lock->name;
534 if (!name)
535 name = __get_key_name(lock->key->subkeys, str);
536
Dmitry Vyukovf943fe02016-11-28 15:24:43 +0100537 printk(KERN_CONT "%s", name);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700538}
539
540static void print_lock(struct held_lock *hlock)
541{
Peter Zijlstrad7bc3192015-04-15 17:11:57 +0200542 /*
543 * We can be called locklessly through debug_show_all_locks() so be
544 * extra careful, the hlock might have been released and cleared.
545 */
546 unsigned int class_idx = hlock->class_idx;
547
548 /* Don't re-read hlock->class_idx, can't use READ_ONCE() on bitfields: */
549 barrier();
550
551 if (!class_idx || (class_idx - 1) >= MAX_LOCKDEP_KEYS) {
Dmitry Vyukovf943fe02016-11-28 15:24:43 +0100552 printk(KERN_CONT "<RELEASED>\n");
Peter Zijlstrad7bc3192015-04-15 17:11:57 +0200553 return;
554 }
555
Tetsuo Handab3c39752018-03-27 19:41:41 +0900556 printk(KERN_CONT "%p", hlock->instance);
Peter Zijlstrad7bc3192015-04-15 17:11:57 +0200557 print_lock_name(lock_classes + class_idx - 1);
Tetsuo Handab3c39752018-03-27 19:41:41 +0900558 printk(KERN_CONT ", at: %pS\n", (void *)hlock->acquire_ip);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700559}
560
Tetsuo Handa8cc05c712018-04-06 19:41:19 +0900561static void lockdep_print_held_locks(struct task_struct *p)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700562{
Tetsuo Handa8cc05c712018-04-06 19:41:19 +0900563 int i, depth = READ_ONCE(p->lockdep_depth);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700564
Tetsuo Handa8cc05c712018-04-06 19:41:19 +0900565 if (!depth)
566 printk("no locks held by %s/%d.\n", p->comm, task_pid_nr(p));
567 else
568 printk("%d lock%s held by %s/%d:\n", depth,
569 depth > 1 ? "s" : "", p->comm, task_pid_nr(p));
570 /*
571 * It's not reliable to print a task's held locks if it's not sleeping
572 * and it's not the current task.
573 */
574 if (p->state == TASK_RUNNING && p != current)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700575 return;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700576 for (i = 0; i < depth; i++) {
577 printk(" #%d: ", i);
Tetsuo Handa8cc05c712018-04-06 19:41:19 +0900578 print_lock(p->held_locks + i);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700579 }
580}
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700581
Ben Hutchingsfbdc4b92011-10-28 04:36:55 +0100582static void print_kernel_ident(void)
Dave Jones99de0552006-09-29 02:00:10 -0700583{
Ben Hutchingsfbdc4b92011-10-28 04:36:55 +0100584 printk("%s %.*s %s\n", init_utsname()->release,
Serge E. Hallyn96b644b2006-10-02 02:18:13 -0700585 (int)strcspn(init_utsname()->version, " "),
Ben Hutchingsfbdc4b92011-10-28 04:36:55 +0100586 init_utsname()->version,
587 print_tainted());
Dave Jones99de0552006-09-29 02:00:10 -0700588}
589
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700590static int very_verbose(struct lock_class *class)
591{
592#if VERY_VERBOSE
593 return class_filter(class);
594#endif
595 return 0;
596}
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700597
598/*
599 * Is this the address of a static object:
600 */
Sasha Levin8dce7a92013-06-13 18:41:16 -0400601#ifdef __KERNEL__
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700602static int static_obj(void *obj)
603{
604 unsigned long start = (unsigned long) &_stext,
605 end = (unsigned long) &_end,
606 addr = (unsigned long) obj;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700607
608 /*
609 * static variable?
610 */
611 if ((addr >= start) && (addr < end))
612 return 1;
613
Mike Frysinger2a9ad182009-09-22 16:44:16 -0700614 if (arch_is_kernel_data(addr))
615 return 1;
616
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700617 /*
Tejun Heo10fad5e2010-03-10 18:57:54 +0900618 * in-kernel percpu var?
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700619 */
Tejun Heo10fad5e2010-03-10 18:57:54 +0900620 if (is_kernel_percpu_address(addr))
621 return 1;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700622
623 /*
Tejun Heo10fad5e2010-03-10 18:57:54 +0900624 * module static or percpu var?
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700625 */
Tejun Heo10fad5e2010-03-10 18:57:54 +0900626 return is_module_address(addr) || is_module_percpu_address(addr);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700627}
Sasha Levin8dce7a92013-06-13 18:41:16 -0400628#endif
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700629
630/*
631 * To make lock name printouts unique, we calculate a unique
Bart Van Asschefe27b0d2018-12-06 17:11:37 -0800632 * class->name_version generation counter. The caller must hold the graph
633 * lock.
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700634 */
635static int count_matching_names(struct lock_class *new_class)
636{
637 struct lock_class *class;
638 int count = 0;
639
640 if (!new_class->name)
641 return 0;
642
Bart Van Asschefe27b0d2018-12-06 17:11:37 -0800643 list_for_each_entry(class, &all_lock_classes, lock_entry) {
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700644 if (new_class->key - new_class->subclass == class->key)
645 return class->name_version;
646 if (class->name && !strcmp(class->name, new_class->name))
647 count = max(count, class->name_version);
648 }
649
650 return count + 1;
651}
652
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700653static inline struct lock_class *
Matthew Wilcox08f36ff2018-01-17 07:14:13 -0800654look_up_lock_class(const struct lockdep_map *lock, unsigned int subclass)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700655{
656 struct lockdep_subclass_key *key;
Andrew Mortona63f38c2016-02-03 13:44:12 -0800657 struct hlist_head *hash_head;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700658 struct lock_class *class;
659
Hitoshi Mitake4ba053c2010-10-13 17:30:26 +0900660 if (unlikely(subclass >= MAX_LOCKDEP_SUBCLASSES)) {
661 debug_locks_off();
662 printk(KERN_ERR
663 "BUG: looking up invalid subclass: %u\n", subclass);
664 printk(KERN_ERR
665 "turning off the locking correctness validator.\n");
666 dump_stack();
667 return NULL;
668 }
669
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700670 /*
Matthew Wilcox64f29d12018-01-17 07:14:12 -0800671 * If it is not initialised then it has never been locked,
672 * so it won't be present in the hash table.
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700673 */
Matthew Wilcox64f29d12018-01-17 07:14:12 -0800674 if (unlikely(!lock->key))
675 return NULL;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700676
677 /*
678 * NOTE: the class-key must be unique. For dynamic locks, a static
679 * lock_class_key variable is passed in through the mutex_init()
680 * (or spin_lock_init()) call - which acts as the key. For static
681 * locks we use the lock object itself as the key.
682 */
Peter Zijlstra4b32d0a2007-07-19 01:48:59 -0700683 BUILD_BUG_ON(sizeof(struct lock_class_key) >
684 sizeof(struct lockdep_map));
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700685
686 key = lock->key->subkeys + subclass;
687
688 hash_head = classhashentry(key);
689
690 /*
Peter Zijlstra35a93932015-02-26 16:23:11 +0100691 * We do an RCU walk of the hash, see lockdep_free_key_range().
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700692 */
Peter Zijlstra35a93932015-02-26 16:23:11 +0100693 if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
694 return NULL;
695
Andrew Mortona63f38c2016-02-03 13:44:12 -0800696 hlist_for_each_entry_rcu(class, hash_head, hash_entry) {
Peter Zijlstra4b32d0a2007-07-19 01:48:59 -0700697 if (class->key == key) {
Peter Zijlstra0119fee2011-09-02 01:30:29 +0200698 /*
699 * Huh! same key, different name? Did someone trample
700 * on some memory? We're most confused.
701 */
Peter Zijlstra4b32d0a2007-07-19 01:48:59 -0700702 WARN_ON_ONCE(class->name != lock->name);
Ingo Molnard6d897c2006-07-10 04:44:04 -0700703 return class;
Peter Zijlstra4b32d0a2007-07-19 01:48:59 -0700704 }
705 }
Ingo Molnard6d897c2006-07-10 04:44:04 -0700706
Matthew Wilcox64f29d12018-01-17 07:14:12 -0800707 return NULL;
708}
709
710/*
711 * Static locks do not have their class-keys yet - for them the key is
712 * the lock object itself. If the lock is in the per cpu area, the
713 * canonical address of the lock (per cpu offset removed) is used.
714 */
715static bool assign_lock_key(struct lockdep_map *lock)
716{
717 unsigned long can_addr, addr = (unsigned long)lock;
718
719 if (__is_kernel_percpu_address(addr, &can_addr))
720 lock->key = (void *)can_addr;
721 else if (__is_module_percpu_address(addr, &can_addr))
722 lock->key = (void *)can_addr;
723 else if (static_obj(lock))
724 lock->key = (void *)lock;
725 else {
726 /* Debug-check: all keys must be persistent! */
727 debug_locks_off();
728 pr_err("INFO: trying to register non-static key.\n");
729 pr_err("the code is fine but needs lockdep annotation.\n");
730 pr_err("turning off the locking correctness validator.\n");
731 dump_stack();
732 return false;
733 }
734
735 return true;
Ingo Molnard6d897c2006-07-10 04:44:04 -0700736}
737
738/*
Bart Van Asschefeb0a382019-02-14 15:00:42 -0800739 * Initialize the lock_classes[] array elements.
740 */
741static void init_data_structures_once(void)
742{
743 static bool initialization_happened;
744 int i;
745
746 if (likely(initialization_happened))
747 return;
748
749 initialization_happened = true;
750
751 for (i = 0; i < ARRAY_SIZE(lock_classes); i++) {
752 INIT_LIST_HEAD(&lock_classes[i].locks_after);
753 INIT_LIST_HEAD(&lock_classes[i].locks_before);
754 }
755}
756
757/*
Ingo Molnard6d897c2006-07-10 04:44:04 -0700758 * Register a lock's class in the hash-table, if the class is not present
759 * yet. Otherwise we look it up. We cache the result in the lock object
760 * itself, so actual lookup of the hash should be once per lock object.
761 */
Denys Vlasenkoc003ed92016-04-08 20:58:46 +0200762static struct lock_class *
Peter Zijlstra4dfbb9d2006-10-11 01:45:14 -0400763register_lock_class(struct lockdep_map *lock, unsigned int subclass, int force)
Ingo Molnard6d897c2006-07-10 04:44:04 -0700764{
765 struct lockdep_subclass_key *key;
Andrew Mortona63f38c2016-02-03 13:44:12 -0800766 struct hlist_head *hash_head;
Ingo Molnard6d897c2006-07-10 04:44:04 -0700767 struct lock_class *class;
Peter Zijlstra35a93932015-02-26 16:23:11 +0100768
769 DEBUG_LOCKS_WARN_ON(!irqs_disabled());
Ingo Molnard6d897c2006-07-10 04:44:04 -0700770
771 class = look_up_lock_class(lock, subclass);
Matthew Wilcox64f29d12018-01-17 07:14:12 -0800772 if (likely(class))
Yong Zhang87cdee72011-11-09 16:07:14 +0800773 goto out_set_class_cache;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700774
Matthew Wilcox64f29d12018-01-17 07:14:12 -0800775 if (!lock->key) {
776 if (!assign_lock_key(lock))
777 return NULL;
778 } else if (!static_obj(lock->key)) {
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700779 return NULL;
780 }
781
Ingo Molnard6d897c2006-07-10 04:44:04 -0700782 key = lock->key->subkeys + subclass;
783 hash_head = classhashentry(key);
784
Ingo Molnar74c383f2006-12-13 00:34:43 -0800785 if (!graph_lock()) {
Ingo Molnar74c383f2006-12-13 00:34:43 -0800786 return NULL;
787 }
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700788 /*
789 * We have to do the hash-walk again, to avoid races
790 * with another CPU:
791 */
Andrew Mortona63f38c2016-02-03 13:44:12 -0800792 hlist_for_each_entry_rcu(class, hash_head, hash_entry) {
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700793 if (class->key == key)
794 goto out_unlock_set;
Peter Zijlstra35a93932015-02-26 16:23:11 +0100795 }
796
Bart Van Asschefeb0a382019-02-14 15:00:42 -0800797 init_data_structures_once();
798
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700799 /*
800 * Allocate a new key from the static array, and add it to
801 * the hash:
802 */
803 if (nr_lock_classes >= MAX_LOCKDEP_KEYS) {
Ingo Molnar74c383f2006-12-13 00:34:43 -0800804 if (!debug_locks_off_graph_unlock()) {
Ingo Molnar74c383f2006-12-13 00:34:43 -0800805 return NULL;
806 }
Ingo Molnar74c383f2006-12-13 00:34:43 -0800807
Dave Jones2c522832013-04-25 13:40:02 -0400808 print_lockdep_off("BUG: MAX_LOCKDEP_KEYS too low!");
Peter Zijlstraeedeeab2009-03-18 12:38:47 +0100809 dump_stack();
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700810 return NULL;
811 }
812 class = lock_classes + nr_lock_classes++;
Frederic Weisbeckerbd6d29c2010-04-06 00:10:17 +0200813 debug_atomic_inc(nr_unused_locks);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700814 class->key = key;
815 class->name = lock->name;
816 class->subclass = subclass;
Bart Van Asschefeb0a382019-02-14 15:00:42 -0800817 WARN_ON_ONCE(!list_empty(&class->locks_before));
818 WARN_ON_ONCE(!list_empty(&class->locks_after));
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700819 class->name_version = count_matching_names(class);
820 /*
821 * We use RCU's safe list-add method to make
822 * parallel walking of the hash-list safe:
823 */
Andrew Mortona63f38c2016-02-03 13:44:12 -0800824 hlist_add_head_rcu(&class->hash_entry, hash_head);
Dale Farnsworth14811972008-02-25 23:03:02 +0100825 /*
826 * Add it to the global list of classes:
827 */
Bart Van Asschefe27b0d2018-12-06 17:11:37 -0800828 list_add_tail(&class->lock_entry, &all_lock_classes);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700829
830 if (verbose(class)) {
Ingo Molnar74c383f2006-12-13 00:34:43 -0800831 graph_unlock();
Ingo Molnar74c383f2006-12-13 00:34:43 -0800832
Borislav Petkov04860d42018-02-26 14:49:26 +0100833 printk("\nnew class %px: %s", class->key, class->name);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700834 if (class->name_version > 1)
Dmitry Vyukovf943fe02016-11-28 15:24:43 +0100835 printk(KERN_CONT "#%d", class->name_version);
836 printk(KERN_CONT "\n");
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700837 dump_stack();
Ingo Molnar74c383f2006-12-13 00:34:43 -0800838
Ingo Molnar74c383f2006-12-13 00:34:43 -0800839 if (!graph_lock()) {
Ingo Molnar74c383f2006-12-13 00:34:43 -0800840 return NULL;
841 }
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700842 }
843out_unlock_set:
Ingo Molnar74c383f2006-12-13 00:34:43 -0800844 graph_unlock();
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700845
Yong Zhang87cdee72011-11-09 16:07:14 +0800846out_set_class_cache:
Peter Zijlstra4dfbb9d2006-10-11 01:45:14 -0400847 if (!subclass || force)
Hitoshi Mitake62016252010-10-05 18:01:51 +0900848 lock->class_cache[0] = class;
849 else if (subclass < NR_LOCKDEP_CACHING_CLASSES)
850 lock->class_cache[subclass] = class;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700851
Peter Zijlstra0119fee2011-09-02 01:30:29 +0200852 /*
853 * Hash collision, did we smoke some? We found a class with a matching
854 * hash but the subclass -- which is hashed in -- didn't match.
855 */
Jarek Poplawski381a2292007-02-10 01:44:58 -0800856 if (DEBUG_LOCKS_WARN_ON(class->subclass != subclass))
857 return NULL;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700858
859 return class;
860}
861
Peter Zijlstraca58abc2007-07-19 01:48:53 -0700862#ifdef CONFIG_PROVE_LOCKING
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700863/*
Peter Zijlstra8e182572007-07-19 01:48:54 -0700864 * Allocate a lockdep entry. (assumes the graph_lock held, returns
865 * with NULL on failure)
866 */
867static struct lock_list *alloc_list_entry(void)
868{
869 if (nr_list_entries >= MAX_LOCKDEP_ENTRIES) {
870 if (!debug_locks_off_graph_unlock())
871 return NULL;
872
Dave Jones2c522832013-04-25 13:40:02 -0400873 print_lockdep_off("BUG: MAX_LOCKDEP_ENTRIES too low!");
Peter Zijlstraeedeeab2009-03-18 12:38:47 +0100874 dump_stack();
Peter Zijlstra8e182572007-07-19 01:48:54 -0700875 return NULL;
876 }
877 return list_entries + nr_list_entries++;
878}
879
880/*
881 * Add a new dependency to the head of the list:
882 */
Bart Van Assche86cffb82019-02-14 15:00:41 -0800883static int add_lock_to_list(struct lock_class *this,
884 struct lock_class *links_to, struct list_head *head,
Tahsin Erdogan83f06162016-11-08 00:02:07 -0800885 unsigned long ip, int distance,
886 struct stack_trace *trace)
Peter Zijlstra8e182572007-07-19 01:48:54 -0700887{
888 struct lock_list *entry;
889 /*
890 * Lock not present yet - get a new dependency struct and
891 * add it to the list:
892 */
893 entry = alloc_list_entry();
894 if (!entry)
895 return 0;
896
Zhu Yi74870172008-08-27 14:33:00 +0800897 entry->class = this;
Bart Van Assche86cffb82019-02-14 15:00:41 -0800898 entry->links_to = links_to;
Zhu Yi74870172008-08-27 14:33:00 +0800899 entry->distance = distance;
Yong Zhang4726f2a2010-05-04 14:16:48 +0800900 entry->trace = *trace;
Peter Zijlstra8e182572007-07-19 01:48:54 -0700901 /*
Peter Zijlstra35a93932015-02-26 16:23:11 +0100902 * Both allocation and removal are done under the graph lock; but
903 * iteration is under RCU-sched; see look_up_lock_class() and
904 * lockdep_free_key_range().
Peter Zijlstra8e182572007-07-19 01:48:54 -0700905 */
906 list_add_tail_rcu(&entry->entry, head);
907
908 return 1;
909}
910
Peter Zijlstra98c33ed2009-07-21 13:19:07 +0200911/*
912 * For good efficiency of modular, we use power of 2
913 */
Peter Zijlstraaf012962009-07-16 15:44:29 +0200914#define MAX_CIRCULAR_QUEUE_SIZE 4096UL
915#define CQ_MASK (MAX_CIRCULAR_QUEUE_SIZE-1)
916
Peter Zijlstra98c33ed2009-07-21 13:19:07 +0200917/*
918 * The circular_queue and helpers is used to implement the
Peter Zijlstraaf012962009-07-16 15:44:29 +0200919 * breadth-first search(BFS)algorithem, by which we can build
920 * the shortest path from the next lock to be acquired to the
921 * previous held lock if there is a circular between them.
Peter Zijlstra98c33ed2009-07-21 13:19:07 +0200922 */
Peter Zijlstraaf012962009-07-16 15:44:29 +0200923struct circular_queue {
924 unsigned long element[MAX_CIRCULAR_QUEUE_SIZE];
925 unsigned int front, rear;
926};
927
928static struct circular_queue lock_cq;
Peter Zijlstraaf012962009-07-16 15:44:29 +0200929
Ming Lei12f3dfd2009-07-16 15:44:29 +0200930unsigned int max_bfs_queue_depth;
Peter Zijlstraaf012962009-07-16 15:44:29 +0200931
Ming Leie351b662009-07-22 22:48:09 +0800932static unsigned int lockdep_dependency_gen_id;
933
Peter Zijlstraaf012962009-07-16 15:44:29 +0200934static inline void __cq_init(struct circular_queue *cq)
935{
936 cq->front = cq->rear = 0;
Ming Leie351b662009-07-22 22:48:09 +0800937 lockdep_dependency_gen_id++;
Peter Zijlstraaf012962009-07-16 15:44:29 +0200938}
939
940static inline int __cq_empty(struct circular_queue *cq)
941{
942 return (cq->front == cq->rear);
943}
944
945static inline int __cq_full(struct circular_queue *cq)
946{
947 return ((cq->rear + 1) & CQ_MASK) == cq->front;
948}
949
950static inline int __cq_enqueue(struct circular_queue *cq, unsigned long elem)
951{
952 if (__cq_full(cq))
953 return -1;
954
955 cq->element[cq->rear] = elem;
956 cq->rear = (cq->rear + 1) & CQ_MASK;
957 return 0;
958}
959
960static inline int __cq_dequeue(struct circular_queue *cq, unsigned long *elem)
961{
962 if (__cq_empty(cq))
963 return -1;
964
965 *elem = cq->element[cq->front];
966 cq->front = (cq->front + 1) & CQ_MASK;
967 return 0;
968}
969
970static inline unsigned int __cq_get_elem_count(struct circular_queue *cq)
971{
972 return (cq->rear - cq->front) & CQ_MASK;
973}
974
975static inline void mark_lock_accessed(struct lock_list *lock,
976 struct lock_list *parent)
977{
978 unsigned long nr;
Peter Zijlstra98c33ed2009-07-21 13:19:07 +0200979
Peter Zijlstraaf012962009-07-16 15:44:29 +0200980 nr = lock - list_entries;
Peter Zijlstra0119fee2011-09-02 01:30:29 +0200981 WARN_ON(nr >= nr_list_entries); /* Out-of-bounds, input fail */
Peter Zijlstraaf012962009-07-16 15:44:29 +0200982 lock->parent = parent;
Ming Leie351b662009-07-22 22:48:09 +0800983 lock->class->dep_gen_id = lockdep_dependency_gen_id;
Peter Zijlstraaf012962009-07-16 15:44:29 +0200984}
985
986static inline unsigned long lock_accessed(struct lock_list *lock)
987{
988 unsigned long nr;
Peter Zijlstra98c33ed2009-07-21 13:19:07 +0200989
Peter Zijlstraaf012962009-07-16 15:44:29 +0200990 nr = lock - list_entries;
Peter Zijlstra0119fee2011-09-02 01:30:29 +0200991 WARN_ON(nr >= nr_list_entries); /* Out-of-bounds, input fail */
Ming Leie351b662009-07-22 22:48:09 +0800992 return lock->class->dep_gen_id == lockdep_dependency_gen_id;
Peter Zijlstraaf012962009-07-16 15:44:29 +0200993}
994
995static inline struct lock_list *get_lock_parent(struct lock_list *child)
996{
997 return child->parent;
998}
999
1000static inline int get_lock_depth(struct lock_list *child)
1001{
1002 int depth = 0;
1003 struct lock_list *parent;
1004
1005 while ((parent = get_lock_parent(child))) {
1006 child = parent;
1007 depth++;
1008 }
1009 return depth;
1010}
1011
Ming Lei9e2d5512009-07-16 15:44:29 +02001012static int __bfs(struct lock_list *source_entry,
Peter Zijlstraaf012962009-07-16 15:44:29 +02001013 void *data,
1014 int (*match)(struct lock_list *entry, void *data),
1015 struct lock_list **target_entry,
1016 int forward)
Ming Leic94aa5c2009-07-16 15:44:29 +02001017{
1018 struct lock_list *entry;
Ming Leid588e462009-07-16 15:44:29 +02001019 struct list_head *head;
Ming Leic94aa5c2009-07-16 15:44:29 +02001020 struct circular_queue *cq = &lock_cq;
1021 int ret = 1;
1022
Ming Lei9e2d5512009-07-16 15:44:29 +02001023 if (match(source_entry, data)) {
Ming Leic94aa5c2009-07-16 15:44:29 +02001024 *target_entry = source_entry;
1025 ret = 0;
1026 goto exit;
1027 }
1028
Ming Leid588e462009-07-16 15:44:29 +02001029 if (forward)
1030 head = &source_entry->class->locks_after;
1031 else
1032 head = &source_entry->class->locks_before;
1033
1034 if (list_empty(head))
1035 goto exit;
1036
1037 __cq_init(cq);
Ming Leic94aa5c2009-07-16 15:44:29 +02001038 __cq_enqueue(cq, (unsigned long)source_entry);
1039
1040 while (!__cq_empty(cq)) {
1041 struct lock_list *lock;
Ming Leic94aa5c2009-07-16 15:44:29 +02001042
1043 __cq_dequeue(cq, (unsigned long *)&lock);
1044
1045 if (!lock->class) {
1046 ret = -2;
1047 goto exit;
1048 }
1049
1050 if (forward)
1051 head = &lock->class->locks_after;
1052 else
1053 head = &lock->class->locks_before;
1054
Peter Zijlstra35a93932015-02-26 16:23:11 +01001055 DEBUG_LOCKS_WARN_ON(!irqs_disabled());
1056
1057 list_for_each_entry_rcu(entry, head, entry) {
Ming Leic94aa5c2009-07-16 15:44:29 +02001058 if (!lock_accessed(entry)) {
Ming Lei12f3dfd2009-07-16 15:44:29 +02001059 unsigned int cq_depth;
Ming Leic94aa5c2009-07-16 15:44:29 +02001060 mark_lock_accessed(entry, lock);
Ming Lei9e2d5512009-07-16 15:44:29 +02001061 if (match(entry, data)) {
Ming Leic94aa5c2009-07-16 15:44:29 +02001062 *target_entry = entry;
1063 ret = 0;
1064 goto exit;
1065 }
1066
1067 if (__cq_enqueue(cq, (unsigned long)entry)) {
1068 ret = -1;
1069 goto exit;
1070 }
Ming Lei12f3dfd2009-07-16 15:44:29 +02001071 cq_depth = __cq_get_elem_count(cq);
1072 if (max_bfs_queue_depth < cq_depth)
1073 max_bfs_queue_depth = cq_depth;
Ming Leic94aa5c2009-07-16 15:44:29 +02001074 }
1075 }
1076 }
1077exit:
1078 return ret;
1079}
1080
Ming Leid7aaba12009-07-16 15:44:29 +02001081static inline int __bfs_forwards(struct lock_list *src_entry,
Ming Lei9e2d5512009-07-16 15:44:29 +02001082 void *data,
1083 int (*match)(struct lock_list *entry, void *data),
1084 struct lock_list **target_entry)
Ming Leic94aa5c2009-07-16 15:44:29 +02001085{
Ming Lei9e2d5512009-07-16 15:44:29 +02001086 return __bfs(src_entry, data, match, target_entry, 1);
Ming Leic94aa5c2009-07-16 15:44:29 +02001087
1088}
1089
Ming Leid7aaba12009-07-16 15:44:29 +02001090static inline int __bfs_backwards(struct lock_list *src_entry,
Ming Lei9e2d5512009-07-16 15:44:29 +02001091 void *data,
1092 int (*match)(struct lock_list *entry, void *data),
1093 struct lock_list **target_entry)
Ming Leic94aa5c2009-07-16 15:44:29 +02001094{
Ming Lei9e2d5512009-07-16 15:44:29 +02001095 return __bfs(src_entry, data, match, target_entry, 0);
Ming Leic94aa5c2009-07-16 15:44:29 +02001096
1097}
1098
Peter Zijlstra8e182572007-07-19 01:48:54 -07001099/*
1100 * Recursive, forwards-direction lock-dependency checking, used for
1101 * both noncyclic checking and for hardirq-unsafe/softirq-unsafe
1102 * checking.
Peter Zijlstra8e182572007-07-19 01:48:54 -07001103 */
Peter Zijlstra8e182572007-07-19 01:48:54 -07001104
1105/*
1106 * Print a dependency chain entry (this is only done when a deadlock
1107 * has been detected):
1108 */
1109static noinline int
Ming Lei24208ca2009-07-16 15:44:29 +02001110print_circular_bug_entry(struct lock_list *target, int depth)
Peter Zijlstra8e182572007-07-19 01:48:54 -07001111{
1112 if (debug_locks_silent)
1113 return 0;
1114 printk("\n-> #%u", depth);
1115 print_lock_name(target->class);
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01001116 printk(KERN_CONT ":\n");
Peter Zijlstra8e182572007-07-19 01:48:54 -07001117 print_stack_trace(&target->trace, 6);
1118
1119 return 0;
1120}
1121
Steven Rostedtf4185812011-04-20 21:41:55 -04001122static void
1123print_circular_lock_scenario(struct held_lock *src,
1124 struct held_lock *tgt,
1125 struct lock_list *prt)
1126{
1127 struct lock_class *source = hlock_class(src);
1128 struct lock_class *target = hlock_class(tgt);
1129 struct lock_class *parent = prt->class;
1130
1131 /*
1132 * A direct locking problem where unsafe_class lock is taken
1133 * directly by safe_class lock, then all we need to show
1134 * is the deadlock scenario, as it is obvious that the
1135 * unsafe lock is taken under the safe lock.
1136 *
1137 * But if there is a chain instead, where the safe lock takes
1138 * an intermediate lock (middle_class) where this lock is
1139 * not the same as the safe lock, then the lock chain is
1140 * used to describe the problem. Otherwise we would need
1141 * to show a different CPU case for each link in the chain
1142 * from the safe_class lock to the unsafe_class lock.
1143 */
1144 if (parent != source) {
1145 printk("Chain exists of:\n ");
1146 __print_lock_name(source);
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01001147 printk(KERN_CONT " --> ");
Steven Rostedtf4185812011-04-20 21:41:55 -04001148 __print_lock_name(parent);
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01001149 printk(KERN_CONT " --> ");
Steven Rostedtf4185812011-04-20 21:41:55 -04001150 __print_lock_name(target);
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01001151 printk(KERN_CONT "\n\n");
Steven Rostedtf4185812011-04-20 21:41:55 -04001152 }
1153
Ingo Molnare966eae2017-12-12 12:31:16 +01001154 printk(" Possible unsafe locking scenario:\n\n");
1155 printk(" CPU0 CPU1\n");
1156 printk(" ---- ----\n");
1157 printk(" lock(");
1158 __print_lock_name(target);
1159 printk(KERN_CONT ");\n");
1160 printk(" lock(");
1161 __print_lock_name(parent);
1162 printk(KERN_CONT ");\n");
1163 printk(" lock(");
1164 __print_lock_name(target);
1165 printk(KERN_CONT ");\n");
1166 printk(" lock(");
1167 __print_lock_name(source);
1168 printk(KERN_CONT ");\n");
1169 printk("\n *** DEADLOCK ***\n\n");
Steven Rostedtf4185812011-04-20 21:41:55 -04001170}
1171
Peter Zijlstra8e182572007-07-19 01:48:54 -07001172/*
1173 * When a circular dependency is detected, print the
1174 * header first:
1175 */
1176static noinline int
Ming Leidb0002a2009-07-16 15:44:29 +02001177print_circular_bug_header(struct lock_list *entry, unsigned int depth,
1178 struct held_lock *check_src,
1179 struct held_lock *check_tgt)
Peter Zijlstra8e182572007-07-19 01:48:54 -07001180{
1181 struct task_struct *curr = current;
1182
Ming Leic94aa5c2009-07-16 15:44:29 +02001183 if (debug_locks_silent)
Peter Zijlstra8e182572007-07-19 01:48:54 -07001184 return 0;
1185
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001186 pr_warn("\n");
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08001187 pr_warn("======================================================\n");
1188 pr_warn("WARNING: possible circular locking dependency detected\n");
Ben Hutchingsfbdc4b92011-10-28 04:36:55 +01001189 print_kernel_ident();
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08001190 pr_warn("------------------------------------------------------\n");
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001191 pr_warn("%s/%d is trying to acquire lock:\n",
Pavel Emelyanovba25f9d2007-10-18 23:40:40 -07001192 curr->comm, task_pid_nr(curr));
Ming Leidb0002a2009-07-16 15:44:29 +02001193 print_lock(check_src);
Byungchul Park383a4bc2017-08-07 16:12:55 +09001194
Ingo Molnare966eae2017-12-12 12:31:16 +01001195 pr_warn("\nbut task is already holding lock:\n");
Byungchul Park383a4bc2017-08-07 16:12:55 +09001196
Ming Leidb0002a2009-07-16 15:44:29 +02001197 print_lock(check_tgt);
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001198 pr_warn("\nwhich lock already depends on the new lock.\n\n");
1199 pr_warn("\nthe existing dependency chain (in reverse order) is:\n");
Peter Zijlstra8e182572007-07-19 01:48:54 -07001200
1201 print_circular_bug_entry(entry, depth);
1202
1203 return 0;
1204}
1205
Ming Lei9e2d5512009-07-16 15:44:29 +02001206static inline int class_equal(struct lock_list *entry, void *data)
1207{
1208 return entry->class == data;
1209}
1210
Ming Leidb0002a2009-07-16 15:44:29 +02001211static noinline int print_circular_bug(struct lock_list *this,
1212 struct lock_list *target,
1213 struct held_lock *check_src,
Byungchul Park383a4bc2017-08-07 16:12:55 +09001214 struct held_lock *check_tgt,
1215 struct stack_trace *trace)
Peter Zijlstra8e182572007-07-19 01:48:54 -07001216{
1217 struct task_struct *curr = current;
Ming Leic94aa5c2009-07-16 15:44:29 +02001218 struct lock_list *parent;
Steven Rostedtf4185812011-04-20 21:41:55 -04001219 struct lock_list *first_parent;
Ming Lei24208ca2009-07-16 15:44:29 +02001220 int depth;
Peter Zijlstra8e182572007-07-19 01:48:54 -07001221
Ming Leic94aa5c2009-07-16 15:44:29 +02001222 if (!debug_locks_off_graph_unlock() || debug_locks_silent)
Peter Zijlstra8e182572007-07-19 01:48:54 -07001223 return 0;
1224
Ingo Molnare966eae2017-12-12 12:31:16 +01001225 if (!save_trace(&this->trace))
Peter Zijlstra8e182572007-07-19 01:48:54 -07001226 return 0;
1227
Ming Leic94aa5c2009-07-16 15:44:29 +02001228 depth = get_lock_depth(target);
1229
Ming Leidb0002a2009-07-16 15:44:29 +02001230 print_circular_bug_header(target, depth, check_src, check_tgt);
Ming Leic94aa5c2009-07-16 15:44:29 +02001231
1232 parent = get_lock_parent(target);
Steven Rostedtf4185812011-04-20 21:41:55 -04001233 first_parent = parent;
Ming Leic94aa5c2009-07-16 15:44:29 +02001234
1235 while (parent) {
1236 print_circular_bug_entry(parent, --depth);
1237 parent = get_lock_parent(parent);
1238 }
Peter Zijlstra8e182572007-07-19 01:48:54 -07001239
1240 printk("\nother info that might help us debug this:\n\n");
Steven Rostedtf4185812011-04-20 21:41:55 -04001241 print_circular_lock_scenario(check_src, check_tgt,
1242 first_parent);
1243
Peter Zijlstra8e182572007-07-19 01:48:54 -07001244 lockdep_print_held_locks(curr);
1245
1246 printk("\nstack backtrace:\n");
1247 dump_stack();
1248
1249 return 0;
1250}
1251
Ming Leidb0002a2009-07-16 15:44:29 +02001252static noinline int print_bfs_bug(int ret)
1253{
1254 if (!debug_locks_off_graph_unlock())
1255 return 0;
1256
Peter Zijlstra0119fee2011-09-02 01:30:29 +02001257 /*
1258 * Breadth-first-search failed, graph got corrupted?
1259 */
Ming Leidb0002a2009-07-16 15:44:29 +02001260 WARN(1, "lockdep bfs error:%d\n", ret);
1261
1262 return 0;
1263}
1264
Ming Leief681022009-07-16 15:44:29 +02001265static int noop_count(struct lock_list *entry, void *data)
David Miller419ca3f2008-07-29 21:45:03 -07001266{
Ming Leief681022009-07-16 15:44:29 +02001267 (*(unsigned long *)data)++;
1268 return 0;
David Miller419ca3f2008-07-29 21:45:03 -07001269}
1270
Fengguang Wu5216d532013-11-09 00:55:35 +08001271static unsigned long __lockdep_count_forward_deps(struct lock_list *this)
Ming Leief681022009-07-16 15:44:29 +02001272{
1273 unsigned long count = 0;
1274 struct lock_list *uninitialized_var(target_entry);
1275
1276 __bfs_forwards(this, (void *)&count, noop_count, &target_entry);
1277
1278 return count;
1279}
David Miller419ca3f2008-07-29 21:45:03 -07001280unsigned long lockdep_count_forward_deps(struct lock_class *class)
1281{
1282 unsigned long ret, flags;
Ming Leief681022009-07-16 15:44:29 +02001283 struct lock_list this;
1284
1285 this.parent = NULL;
1286 this.class = class;
David Miller419ca3f2008-07-29 21:45:03 -07001287
Steven Rostedt (VMware)fcc784b2018-04-04 14:06:30 -04001288 raw_local_irq_save(flags);
Thomas Gleixner0199c4e2009-12-02 20:01:25 +01001289 arch_spin_lock(&lockdep_lock);
Ming Leief681022009-07-16 15:44:29 +02001290 ret = __lockdep_count_forward_deps(&this);
Thomas Gleixner0199c4e2009-12-02 20:01:25 +01001291 arch_spin_unlock(&lockdep_lock);
Steven Rostedt (VMware)fcc784b2018-04-04 14:06:30 -04001292 raw_local_irq_restore(flags);
David Miller419ca3f2008-07-29 21:45:03 -07001293
1294 return ret;
1295}
1296
Fengguang Wu5216d532013-11-09 00:55:35 +08001297static unsigned long __lockdep_count_backward_deps(struct lock_list *this)
David Miller419ca3f2008-07-29 21:45:03 -07001298{
Ming Leief681022009-07-16 15:44:29 +02001299 unsigned long count = 0;
1300 struct lock_list *uninitialized_var(target_entry);
David Miller419ca3f2008-07-29 21:45:03 -07001301
Ming Leief681022009-07-16 15:44:29 +02001302 __bfs_backwards(this, (void *)&count, noop_count, &target_entry);
David Miller419ca3f2008-07-29 21:45:03 -07001303
Ming Leief681022009-07-16 15:44:29 +02001304 return count;
David Miller419ca3f2008-07-29 21:45:03 -07001305}
1306
1307unsigned long lockdep_count_backward_deps(struct lock_class *class)
1308{
1309 unsigned long ret, flags;
Ming Leief681022009-07-16 15:44:29 +02001310 struct lock_list this;
1311
1312 this.parent = NULL;
1313 this.class = class;
David Miller419ca3f2008-07-29 21:45:03 -07001314
Steven Rostedt (VMware)fcc784b2018-04-04 14:06:30 -04001315 raw_local_irq_save(flags);
Thomas Gleixner0199c4e2009-12-02 20:01:25 +01001316 arch_spin_lock(&lockdep_lock);
Ming Leief681022009-07-16 15:44:29 +02001317 ret = __lockdep_count_backward_deps(&this);
Thomas Gleixner0199c4e2009-12-02 20:01:25 +01001318 arch_spin_unlock(&lockdep_lock);
Steven Rostedt (VMware)fcc784b2018-04-04 14:06:30 -04001319 raw_local_irq_restore(flags);
David Miller419ca3f2008-07-29 21:45:03 -07001320
1321 return ret;
1322}
1323
Peter Zijlstra8e182572007-07-19 01:48:54 -07001324/*
1325 * Prove that the dependency graph starting at <entry> can not
1326 * lead to <target>. Print an error and return 0 if it does.
1327 */
1328static noinline int
Ming Leidb0002a2009-07-16 15:44:29 +02001329check_noncircular(struct lock_list *root, struct lock_class *target,
1330 struct lock_list **target_entry)
Peter Zijlstra8e182572007-07-19 01:48:54 -07001331{
Ming Leidb0002a2009-07-16 15:44:29 +02001332 int result;
Peter Zijlstra8e182572007-07-19 01:48:54 -07001333
Frederic Weisbeckerbd6d29c2010-04-06 00:10:17 +02001334 debug_atomic_inc(nr_cyclic_checks);
David Miller419ca3f2008-07-29 21:45:03 -07001335
Ming Leid7aaba12009-07-16 15:44:29 +02001336 result = __bfs_forwards(root, target, class_equal, target_entry);
Ming Leidb0002a2009-07-16 15:44:29 +02001337
1338 return result;
Peter Zijlstra8e182572007-07-19 01:48:54 -07001339}
1340
Peter Zijlstraae813302017-03-03 10:13:38 +01001341static noinline int
1342check_redundant(struct lock_list *root, struct lock_class *target,
1343 struct lock_list **target_entry)
1344{
1345 int result;
1346
1347 debug_atomic_inc(nr_redundant_checks);
1348
1349 result = __bfs_forwards(root, target, class_equal, target_entry);
1350
1351 return result;
1352}
1353
Steven Rostedt81d68a92008-05-12 21:20:42 +02001354#if defined(CONFIG_TRACE_IRQFLAGS) && defined(CONFIG_PROVE_LOCKING)
Peter Zijlstra8e182572007-07-19 01:48:54 -07001355/*
1356 * Forwards and backwards subgraph searching, for the purposes of
1357 * proving that two subgraphs can be connected by a new dependency
1358 * without creating any illegal irq-safe -> irq-unsafe lock dependency.
1359 */
Peter Zijlstra8e182572007-07-19 01:48:54 -07001360
Ming Leid7aaba12009-07-16 15:44:29 +02001361static inline int usage_match(struct lock_list *entry, void *bit)
1362{
1363 return entry->class->usage_mask & (1 << (enum lock_usage_bit)bit);
1364}
1365
1366
1367
Peter Zijlstra8e182572007-07-19 01:48:54 -07001368/*
1369 * Find a node in the forwards-direction dependency sub-graph starting
Ming Leid7aaba12009-07-16 15:44:29 +02001370 * at @root->class that matches @bit.
Peter Zijlstra8e182572007-07-19 01:48:54 -07001371 *
Ming Leid7aaba12009-07-16 15:44:29 +02001372 * Return 0 if such a node exists in the subgraph, and put that node
1373 * into *@target_entry.
Peter Zijlstra8e182572007-07-19 01:48:54 -07001374 *
Ming Leid7aaba12009-07-16 15:44:29 +02001375 * Return 1 otherwise and keep *@target_entry unchanged.
1376 * Return <0 on error.
Peter Zijlstra8e182572007-07-19 01:48:54 -07001377 */
Ming Leid7aaba12009-07-16 15:44:29 +02001378static int
1379find_usage_forwards(struct lock_list *root, enum lock_usage_bit bit,
1380 struct lock_list **target_entry)
Peter Zijlstra8e182572007-07-19 01:48:54 -07001381{
Ming Leid7aaba12009-07-16 15:44:29 +02001382 int result;
Peter Zijlstra8e182572007-07-19 01:48:54 -07001383
Frederic Weisbeckerbd6d29c2010-04-06 00:10:17 +02001384 debug_atomic_inc(nr_find_usage_forwards_checks);
Peter Zijlstra8e182572007-07-19 01:48:54 -07001385
Ming Leid7aaba12009-07-16 15:44:29 +02001386 result = __bfs_forwards(root, (void *)bit, usage_match, target_entry);
1387
1388 return result;
Peter Zijlstra8e182572007-07-19 01:48:54 -07001389}
1390
1391/*
1392 * Find a node in the backwards-direction dependency sub-graph starting
Ming Leid7aaba12009-07-16 15:44:29 +02001393 * at @root->class that matches @bit.
Peter Zijlstra8e182572007-07-19 01:48:54 -07001394 *
Ming Leid7aaba12009-07-16 15:44:29 +02001395 * Return 0 if such a node exists in the subgraph, and put that node
1396 * into *@target_entry.
Peter Zijlstra8e182572007-07-19 01:48:54 -07001397 *
Ming Leid7aaba12009-07-16 15:44:29 +02001398 * Return 1 otherwise and keep *@target_entry unchanged.
1399 * Return <0 on error.
Peter Zijlstra8e182572007-07-19 01:48:54 -07001400 */
Ming Leid7aaba12009-07-16 15:44:29 +02001401static int
1402find_usage_backwards(struct lock_list *root, enum lock_usage_bit bit,
1403 struct lock_list **target_entry)
Peter Zijlstra8e182572007-07-19 01:48:54 -07001404{
Ming Leid7aaba12009-07-16 15:44:29 +02001405 int result;
Peter Zijlstra8e182572007-07-19 01:48:54 -07001406
Frederic Weisbeckerbd6d29c2010-04-06 00:10:17 +02001407 debug_atomic_inc(nr_find_usage_backwards_checks);
Peter Zijlstra8e182572007-07-19 01:48:54 -07001408
Ming Leid7aaba12009-07-16 15:44:29 +02001409 result = __bfs_backwards(root, (void *)bit, usage_match, target_entry);
Dave Jonesf82b2172008-08-11 09:30:23 +02001410
Ming Leid7aaba12009-07-16 15:44:29 +02001411 return result;
Peter Zijlstra8e182572007-07-19 01:48:54 -07001412}
1413
Peter Zijlstraaf012962009-07-16 15:44:29 +02001414static void print_lock_class_header(struct lock_class *class, int depth)
1415{
1416 int bit;
1417
1418 printk("%*s->", depth, "");
1419 print_lock_name(class);
Waiman Long8ca2b56c2018-10-03 13:07:18 -04001420#ifdef CONFIG_DEBUG_LOCKDEP
1421 printk(KERN_CONT " ops: %lu", debug_class_ops_read(class));
1422#endif
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01001423 printk(KERN_CONT " {\n");
Peter Zijlstraaf012962009-07-16 15:44:29 +02001424
1425 for (bit = 0; bit < LOCK_USAGE_STATES; bit++) {
1426 if (class->usage_mask & (1 << bit)) {
1427 int len = depth;
1428
1429 len += printk("%*s %s", depth, "", usage_str[bit]);
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01001430 len += printk(KERN_CONT " at:\n");
Peter Zijlstraaf012962009-07-16 15:44:29 +02001431 print_stack_trace(class->usage_traces + bit, len);
1432 }
1433 }
1434 printk("%*s }\n", depth, "");
1435
Borislav Petkov04860d42018-02-26 14:49:26 +01001436 printk("%*s ... key at: [<%px>] %pS\n",
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01001437 depth, "", class->key, class->key);
Peter Zijlstraaf012962009-07-16 15:44:29 +02001438}
1439
1440/*
1441 * printk the shortest lock dependencies from @start to @end in reverse order:
1442 */
1443static void __used
1444print_shortest_lock_dependencies(struct lock_list *leaf,
1445 struct lock_list *root)
1446{
1447 struct lock_list *entry = leaf;
1448 int depth;
1449
1450 /*compute depth from generated tree by BFS*/
1451 depth = get_lock_depth(leaf);
1452
1453 do {
1454 print_lock_class_header(entry->class, depth);
1455 printk("%*s ... acquired at:\n", depth, "");
1456 print_stack_trace(&entry->trace, 2);
1457 printk("\n");
1458
1459 if (depth == 0 && (entry != root)) {
Steven Rostedt6be8c392011-04-20 21:41:58 -04001460 printk("lockdep:%s bad path found in chain graph\n", __func__);
Peter Zijlstraaf012962009-07-16 15:44:29 +02001461 break;
1462 }
1463
1464 entry = get_lock_parent(entry);
1465 depth--;
1466 } while (entry && (depth >= 0));
1467
1468 return;
1469}
Ming Leid7aaba12009-07-16 15:44:29 +02001470
Steven Rostedt3003eba2011-04-20 21:41:54 -04001471static void
1472print_irq_lock_scenario(struct lock_list *safe_entry,
1473 struct lock_list *unsafe_entry,
Steven Rostedtdad3d742011-04-20 21:41:57 -04001474 struct lock_class *prev_class,
1475 struct lock_class *next_class)
Steven Rostedt3003eba2011-04-20 21:41:54 -04001476{
1477 struct lock_class *safe_class = safe_entry->class;
1478 struct lock_class *unsafe_class = unsafe_entry->class;
Steven Rostedtdad3d742011-04-20 21:41:57 -04001479 struct lock_class *middle_class = prev_class;
Steven Rostedt3003eba2011-04-20 21:41:54 -04001480
1481 if (middle_class == safe_class)
Steven Rostedtdad3d742011-04-20 21:41:57 -04001482 middle_class = next_class;
Steven Rostedt3003eba2011-04-20 21:41:54 -04001483
1484 /*
1485 * A direct locking problem where unsafe_class lock is taken
1486 * directly by safe_class lock, then all we need to show
1487 * is the deadlock scenario, as it is obvious that the
1488 * unsafe lock is taken under the safe lock.
1489 *
1490 * But if there is a chain instead, where the safe lock takes
1491 * an intermediate lock (middle_class) where this lock is
1492 * not the same as the safe lock, then the lock chain is
1493 * used to describe the problem. Otherwise we would need
1494 * to show a different CPU case for each link in the chain
1495 * from the safe_class lock to the unsafe_class lock.
1496 */
1497 if (middle_class != unsafe_class) {
1498 printk("Chain exists of:\n ");
1499 __print_lock_name(safe_class);
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01001500 printk(KERN_CONT " --> ");
Steven Rostedt3003eba2011-04-20 21:41:54 -04001501 __print_lock_name(middle_class);
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01001502 printk(KERN_CONT " --> ");
Steven Rostedt3003eba2011-04-20 21:41:54 -04001503 __print_lock_name(unsafe_class);
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01001504 printk(KERN_CONT "\n\n");
Steven Rostedt3003eba2011-04-20 21:41:54 -04001505 }
1506
1507 printk(" Possible interrupt unsafe locking scenario:\n\n");
1508 printk(" CPU0 CPU1\n");
1509 printk(" ---- ----\n");
1510 printk(" lock(");
1511 __print_lock_name(unsafe_class);
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01001512 printk(KERN_CONT ");\n");
Steven Rostedt3003eba2011-04-20 21:41:54 -04001513 printk(" local_irq_disable();\n");
1514 printk(" lock(");
1515 __print_lock_name(safe_class);
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01001516 printk(KERN_CONT ");\n");
Steven Rostedt3003eba2011-04-20 21:41:54 -04001517 printk(" lock(");
1518 __print_lock_name(middle_class);
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01001519 printk(KERN_CONT ");\n");
Steven Rostedt3003eba2011-04-20 21:41:54 -04001520 printk(" <Interrupt>\n");
1521 printk(" lock(");
1522 __print_lock_name(safe_class);
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01001523 printk(KERN_CONT ");\n");
Steven Rostedt3003eba2011-04-20 21:41:54 -04001524 printk("\n *** DEADLOCK ***\n\n");
1525}
1526
Peter Zijlstra8e182572007-07-19 01:48:54 -07001527static int
1528print_bad_irq_dependency(struct task_struct *curr,
Ming Lei24208ca2009-07-16 15:44:29 +02001529 struct lock_list *prev_root,
1530 struct lock_list *next_root,
1531 struct lock_list *backwards_entry,
1532 struct lock_list *forwards_entry,
Peter Zijlstra8e182572007-07-19 01:48:54 -07001533 struct held_lock *prev,
1534 struct held_lock *next,
1535 enum lock_usage_bit bit1,
1536 enum lock_usage_bit bit2,
1537 const char *irqclass)
1538{
1539 if (!debug_locks_off_graph_unlock() || debug_locks_silent)
1540 return 0;
1541
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001542 pr_warn("\n");
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08001543 pr_warn("=====================================================\n");
1544 pr_warn("WARNING: %s-safe -> %s-unsafe lock order detected\n",
Peter Zijlstra8e182572007-07-19 01:48:54 -07001545 irqclass, irqclass);
Ben Hutchingsfbdc4b92011-10-28 04:36:55 +01001546 print_kernel_ident();
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08001547 pr_warn("-----------------------------------------------------\n");
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001548 pr_warn("%s/%d [HC%u[%lu]:SC%u[%lu]:HE%u:SE%u] is trying to acquire:\n",
Pavel Emelyanovba25f9d2007-10-18 23:40:40 -07001549 curr->comm, task_pid_nr(curr),
Peter Zijlstra8e182572007-07-19 01:48:54 -07001550 curr->hardirq_context, hardirq_count() >> HARDIRQ_SHIFT,
1551 curr->softirq_context, softirq_count() >> SOFTIRQ_SHIFT,
1552 curr->hardirqs_enabled,
1553 curr->softirqs_enabled);
1554 print_lock(next);
1555
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001556 pr_warn("\nand this task is already holding:\n");
Peter Zijlstra8e182572007-07-19 01:48:54 -07001557 print_lock(prev);
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001558 pr_warn("which would create a new lock dependency:\n");
Dave Jonesf82b2172008-08-11 09:30:23 +02001559 print_lock_name(hlock_class(prev));
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001560 pr_cont(" ->");
Dave Jonesf82b2172008-08-11 09:30:23 +02001561 print_lock_name(hlock_class(next));
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001562 pr_cont("\n");
Peter Zijlstra8e182572007-07-19 01:48:54 -07001563
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001564 pr_warn("\nbut this new dependency connects a %s-irq-safe lock:\n",
Peter Zijlstra8e182572007-07-19 01:48:54 -07001565 irqclass);
Ming Lei24208ca2009-07-16 15:44:29 +02001566 print_lock_name(backwards_entry->class);
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001567 pr_warn("\n... which became %s-irq-safe at:\n", irqclass);
Peter Zijlstra8e182572007-07-19 01:48:54 -07001568
Ming Lei24208ca2009-07-16 15:44:29 +02001569 print_stack_trace(backwards_entry->class->usage_traces + bit1, 1);
Peter Zijlstra8e182572007-07-19 01:48:54 -07001570
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001571 pr_warn("\nto a %s-irq-unsafe lock:\n", irqclass);
Ming Lei24208ca2009-07-16 15:44:29 +02001572 print_lock_name(forwards_entry->class);
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001573 pr_warn("\n... which became %s-irq-unsafe at:\n", irqclass);
1574 pr_warn("...");
Peter Zijlstra8e182572007-07-19 01:48:54 -07001575
Ming Lei24208ca2009-07-16 15:44:29 +02001576 print_stack_trace(forwards_entry->class->usage_traces + bit2, 1);
Peter Zijlstra8e182572007-07-19 01:48:54 -07001577
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001578 pr_warn("\nother info that might help us debug this:\n\n");
Steven Rostedtdad3d742011-04-20 21:41:57 -04001579 print_irq_lock_scenario(backwards_entry, forwards_entry,
1580 hlock_class(prev), hlock_class(next));
Steven Rostedt3003eba2011-04-20 21:41:54 -04001581
Peter Zijlstra8e182572007-07-19 01:48:54 -07001582 lockdep_print_held_locks(curr);
1583
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001584 pr_warn("\nthe dependencies between %s-irq-safe lock and the holding lock:\n", irqclass);
Ming Lei24208ca2009-07-16 15:44:29 +02001585 if (!save_trace(&prev_root->trace))
1586 return 0;
1587 print_shortest_lock_dependencies(backwards_entry, prev_root);
Peter Zijlstra8e182572007-07-19 01:48:54 -07001588
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001589 pr_warn("\nthe dependencies between the lock to be acquired");
1590 pr_warn(" and %s-irq-unsafe lock:\n", irqclass);
Ming Lei24208ca2009-07-16 15:44:29 +02001591 if (!save_trace(&next_root->trace))
1592 return 0;
1593 print_shortest_lock_dependencies(forwards_entry, next_root);
Peter Zijlstra8e182572007-07-19 01:48:54 -07001594
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001595 pr_warn("\nstack backtrace:\n");
Peter Zijlstra8e182572007-07-19 01:48:54 -07001596 dump_stack();
1597
1598 return 0;
1599}
1600
1601static int
1602check_usage(struct task_struct *curr, struct held_lock *prev,
1603 struct held_lock *next, enum lock_usage_bit bit_backwards,
1604 enum lock_usage_bit bit_forwards, const char *irqclass)
1605{
1606 int ret;
Ming Lei24208ca2009-07-16 15:44:29 +02001607 struct lock_list this, that;
Ming Leid7aaba12009-07-16 15:44:29 +02001608 struct lock_list *uninitialized_var(target_entry);
Ming Lei24208ca2009-07-16 15:44:29 +02001609 struct lock_list *uninitialized_var(target_entry1);
Peter Zijlstra8e182572007-07-19 01:48:54 -07001610
Ming Leid7aaba12009-07-16 15:44:29 +02001611 this.parent = NULL;
Peter Zijlstra8e182572007-07-19 01:48:54 -07001612
Ming Leid7aaba12009-07-16 15:44:29 +02001613 this.class = hlock_class(prev);
1614 ret = find_usage_backwards(&this, bit_backwards, &target_entry);
Peter Zijlstraaf012962009-07-16 15:44:29 +02001615 if (ret < 0)
1616 return print_bfs_bug(ret);
1617 if (ret == 1)
1618 return ret;
Ming Leid7aaba12009-07-16 15:44:29 +02001619
Ming Lei24208ca2009-07-16 15:44:29 +02001620 that.parent = NULL;
1621 that.class = hlock_class(next);
1622 ret = find_usage_forwards(&that, bit_forwards, &target_entry1);
Peter Zijlstraaf012962009-07-16 15:44:29 +02001623 if (ret < 0)
1624 return print_bfs_bug(ret);
1625 if (ret == 1)
1626 return ret;
Ming Leid7aaba12009-07-16 15:44:29 +02001627
Ming Lei24208ca2009-07-16 15:44:29 +02001628 return print_bad_irq_dependency(curr, &this, &that,
1629 target_entry, target_entry1,
1630 prev, next,
Peter Zijlstra8e182572007-07-19 01:48:54 -07001631 bit_backwards, bit_forwards, irqclass);
1632}
1633
Peter Zijlstra4f367d8a2009-01-22 18:10:42 +01001634static const char *state_names[] = {
1635#define LOCKDEP_STATE(__STATE) \
Peter Zijlstrab4b136f2009-01-29 14:50:36 +01001636 __stringify(__STATE),
Peter Zijlstra4f367d8a2009-01-22 18:10:42 +01001637#include "lockdep_states.h"
1638#undef LOCKDEP_STATE
1639};
1640
1641static const char *state_rnames[] = {
1642#define LOCKDEP_STATE(__STATE) \
Peter Zijlstrab4b136f2009-01-29 14:50:36 +01001643 __stringify(__STATE)"-READ",
Peter Zijlstra4f367d8a2009-01-22 18:10:42 +01001644#include "lockdep_states.h"
1645#undef LOCKDEP_STATE
1646};
1647
1648static inline const char *state_name(enum lock_usage_bit bit)
1649{
Frederic Weisbeckerbba2a8f2018-12-28 06:02:01 +01001650 return (bit & LOCK_USAGE_READ_MASK) ? state_rnames[bit >> 2] : state_names[bit >> 2];
Peter Zijlstra4f367d8a2009-01-22 18:10:42 +01001651}
1652
1653static int exclusive_bit(int new_bit)
1654{
Frederic Weisbeckerbba2a8f2018-12-28 06:02:01 +01001655 int state = new_bit & LOCK_USAGE_STATE_MASK;
1656 int dir = new_bit & LOCK_USAGE_DIR_MASK;
Peter Zijlstra4f367d8a2009-01-22 18:10:42 +01001657
1658 /*
1659 * keep state, bit flip the direction and strip read.
1660 */
Frederic Weisbeckerbba2a8f2018-12-28 06:02:01 +01001661 return state | (dir ^ LOCK_USAGE_DIR_MASK);
Peter Zijlstra4f367d8a2009-01-22 18:10:42 +01001662}
1663
1664static int check_irq_usage(struct task_struct *curr, struct held_lock *prev,
1665 struct held_lock *next, enum lock_usage_bit bit)
Peter Zijlstra8e182572007-07-19 01:48:54 -07001666{
1667 /*
1668 * Prove that the new dependency does not connect a hardirq-safe
1669 * lock with a hardirq-unsafe lock - to achieve this we search
1670 * the backwards-subgraph starting at <prev>, and the
1671 * forwards-subgraph starting at <next>:
1672 */
Peter Zijlstra4f367d8a2009-01-22 18:10:42 +01001673 if (!check_usage(curr, prev, next, bit,
1674 exclusive_bit(bit), state_name(bit)))
Peter Zijlstra8e182572007-07-19 01:48:54 -07001675 return 0;
1676
Peter Zijlstra4f367d8a2009-01-22 18:10:42 +01001677 bit++; /* _READ */
1678
Peter Zijlstra8e182572007-07-19 01:48:54 -07001679 /*
1680 * Prove that the new dependency does not connect a hardirq-safe-read
1681 * lock with a hardirq-unsafe lock - to achieve this we search
1682 * the backwards-subgraph starting at <prev>, and the
1683 * forwards-subgraph starting at <next>:
1684 */
Peter Zijlstra4f367d8a2009-01-22 18:10:42 +01001685 if (!check_usage(curr, prev, next, bit,
1686 exclusive_bit(bit), state_name(bit)))
Peter Zijlstra8e182572007-07-19 01:48:54 -07001687 return 0;
1688
Peter Zijlstra4f367d8a2009-01-22 18:10:42 +01001689 return 1;
1690}
Peter Zijlstra8e182572007-07-19 01:48:54 -07001691
Peter Zijlstra4f367d8a2009-01-22 18:10:42 +01001692static int
1693check_prev_add_irq(struct task_struct *curr, struct held_lock *prev,
1694 struct held_lock *next)
1695{
1696#define LOCKDEP_STATE(__STATE) \
1697 if (!check_irq_usage(curr, prev, next, LOCK_USED_IN_##__STATE)) \
Nick Piggincf40bd12009-01-21 08:12:39 +01001698 return 0;
Peter Zijlstra4f367d8a2009-01-22 18:10:42 +01001699#include "lockdep_states.h"
1700#undef LOCKDEP_STATE
Nick Piggincf40bd12009-01-21 08:12:39 +01001701
Peter Zijlstra8e182572007-07-19 01:48:54 -07001702 return 1;
1703}
1704
1705static void inc_chains(void)
1706{
1707 if (current->hardirq_context)
1708 nr_hardirq_chains++;
1709 else {
1710 if (current->softirq_context)
1711 nr_softirq_chains++;
1712 else
1713 nr_process_chains++;
1714 }
1715}
1716
1717#else
1718
1719static inline int
1720check_prev_add_irq(struct task_struct *curr, struct held_lock *prev,
1721 struct held_lock *next)
1722{
1723 return 1;
1724}
1725
1726static inline void inc_chains(void)
1727{
1728 nr_process_chains++;
1729}
1730
1731#endif
1732
Steven Rostedt48702ec2011-04-20 21:41:56 -04001733static void
1734print_deadlock_scenario(struct held_lock *nxt,
1735 struct held_lock *prv)
1736{
1737 struct lock_class *next = hlock_class(nxt);
1738 struct lock_class *prev = hlock_class(prv);
1739
1740 printk(" Possible unsafe locking scenario:\n\n");
1741 printk(" CPU0\n");
1742 printk(" ----\n");
1743 printk(" lock(");
1744 __print_lock_name(prev);
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01001745 printk(KERN_CONT ");\n");
Steven Rostedt48702ec2011-04-20 21:41:56 -04001746 printk(" lock(");
1747 __print_lock_name(next);
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01001748 printk(KERN_CONT ");\n");
Steven Rostedt48702ec2011-04-20 21:41:56 -04001749 printk("\n *** DEADLOCK ***\n\n");
1750 printk(" May be due to missing lock nesting notation\n\n");
1751}
1752
Peter Zijlstra8e182572007-07-19 01:48:54 -07001753static int
1754print_deadlock_bug(struct task_struct *curr, struct held_lock *prev,
1755 struct held_lock *next)
1756{
1757 if (!debug_locks_off_graph_unlock() || debug_locks_silent)
1758 return 0;
1759
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001760 pr_warn("\n");
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08001761 pr_warn("============================================\n");
1762 pr_warn("WARNING: possible recursive locking detected\n");
Ben Hutchingsfbdc4b92011-10-28 04:36:55 +01001763 print_kernel_ident();
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08001764 pr_warn("--------------------------------------------\n");
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001765 pr_warn("%s/%d is trying to acquire lock:\n",
Pavel Emelyanovba25f9d2007-10-18 23:40:40 -07001766 curr->comm, task_pid_nr(curr));
Peter Zijlstra8e182572007-07-19 01:48:54 -07001767 print_lock(next);
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001768 pr_warn("\nbut task is already holding lock:\n");
Peter Zijlstra8e182572007-07-19 01:48:54 -07001769 print_lock(prev);
1770
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001771 pr_warn("\nother info that might help us debug this:\n");
Steven Rostedt48702ec2011-04-20 21:41:56 -04001772 print_deadlock_scenario(next, prev);
Peter Zijlstra8e182572007-07-19 01:48:54 -07001773 lockdep_print_held_locks(curr);
1774
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001775 pr_warn("\nstack backtrace:\n");
Peter Zijlstra8e182572007-07-19 01:48:54 -07001776 dump_stack();
1777
1778 return 0;
1779}
1780
1781/*
1782 * Check whether we are holding such a class already.
1783 *
1784 * (Note that this has to be done separately, because the graph cannot
1785 * detect such classes of deadlocks.)
1786 *
1787 * Returns: 0 on deadlock detected, 1 on OK, 2 on recursive read
1788 */
1789static int
1790check_deadlock(struct task_struct *curr, struct held_lock *next,
1791 struct lockdep_map *next_instance, int read)
1792{
1793 struct held_lock *prev;
Peter Zijlstra7531e2f2008-08-11 09:30:24 +02001794 struct held_lock *nest = NULL;
Peter Zijlstra8e182572007-07-19 01:48:54 -07001795 int i;
1796
1797 for (i = 0; i < curr->lockdep_depth; i++) {
1798 prev = curr->held_locks + i;
Peter Zijlstra7531e2f2008-08-11 09:30:24 +02001799
1800 if (prev->instance == next->nest_lock)
1801 nest = prev;
1802
Dave Jonesf82b2172008-08-11 09:30:23 +02001803 if (hlock_class(prev) != hlock_class(next))
Peter Zijlstra8e182572007-07-19 01:48:54 -07001804 continue;
Peter Zijlstra7531e2f2008-08-11 09:30:24 +02001805
Peter Zijlstra8e182572007-07-19 01:48:54 -07001806 /*
1807 * Allow read-after-read recursion of the same
1808 * lock class (i.e. read_lock(lock)+read_lock(lock)):
1809 */
1810 if ((read == 2) && prev->read)
1811 return 2;
Peter Zijlstra7531e2f2008-08-11 09:30:24 +02001812
1813 /*
1814 * We're holding the nest_lock, which serializes this lock's
1815 * nesting behaviour.
1816 */
1817 if (nest)
1818 return 2;
1819
Peter Zijlstra8e182572007-07-19 01:48:54 -07001820 return print_deadlock_bug(curr, prev, next);
1821 }
1822 return 1;
1823}
1824
1825/*
1826 * There was a chain-cache miss, and we are about to add a new dependency
1827 * to a previous lock. We recursively validate the following rules:
1828 *
1829 * - would the adding of the <prev> -> <next> dependency create a
1830 * circular dependency in the graph? [== circular deadlock]
1831 *
1832 * - does the new prev->next dependency connect any hardirq-safe lock
1833 * (in the full backwards-subgraph starting at <prev>) with any
1834 * hardirq-unsafe lock (in the full forwards-subgraph starting at
1835 * <next>)? [== illegal lock inversion with hardirq contexts]
1836 *
1837 * - does the new prev->next dependency connect any softirq-safe lock
1838 * (in the full backwards-subgraph starting at <prev>) with any
1839 * softirq-unsafe lock (in the full forwards-subgraph starting at
1840 * <next>)? [== illegal lock inversion with softirq contexts]
1841 *
1842 * any of these scenarios could lead to a deadlock.
1843 *
1844 * Then if all the validations pass, we add the forwards and backwards
1845 * dependency.
1846 */
1847static int
1848check_prev_add(struct task_struct *curr, struct held_lock *prev,
Byungchul Parkce07a9412017-08-07 16:12:51 +09001849 struct held_lock *next, int distance, struct stack_trace *trace,
1850 int (*save)(struct stack_trace *trace))
Peter Zijlstra8e182572007-07-19 01:48:54 -07001851{
Ming Leidb0002a2009-07-16 15:44:29 +02001852 struct lock_list *uninitialized_var(target_entry);
Peter Zijlstra8b405d52017-10-04 11:13:37 +02001853 struct lock_list *entry;
1854 struct lock_list this;
1855 int ret;
Peter Zijlstra8e182572007-07-19 01:48:54 -07001856
1857 /*
1858 * Prove that the new <prev> -> <next> dependency would not
1859 * create a circular dependency in the graph. (We do this by
1860 * forward-recursing into the graph starting at <next>, and
1861 * checking whether we can reach <prev>.)
1862 *
1863 * We are using global variables to control the recursion, to
1864 * keep the stackframe size of the recursive functions low:
1865 */
Ming Leidb0002a2009-07-16 15:44:29 +02001866 this.class = hlock_class(next);
1867 this.parent = NULL;
1868 ret = check_noncircular(&this, hlock_class(prev), &target_entry);
Peter Zijlstra8b405d52017-10-04 11:13:37 +02001869 if (unlikely(!ret)) {
1870 if (!trace->entries) {
1871 /*
1872 * If @save fails here, the printing might trigger
1873 * a WARN but because of the !nr_entries it should
1874 * not do bad things.
1875 */
1876 save(trace);
1877 }
Byungchul Park383a4bc2017-08-07 16:12:55 +09001878 return print_circular_bug(&this, target_entry, next, prev, trace);
Peter Zijlstra8b405d52017-10-04 11:13:37 +02001879 }
Ming Leidb0002a2009-07-16 15:44:29 +02001880 else if (unlikely(ret < 0))
1881 return print_bfs_bug(ret);
Ming Leic94aa5c2009-07-16 15:44:29 +02001882
Peter Zijlstra8e182572007-07-19 01:48:54 -07001883 if (!check_prev_add_irq(curr, prev, next))
1884 return 0;
1885
1886 /*
1887 * For recursive read-locks we do all the dependency checks,
1888 * but we dont store read-triggered dependencies (only
1889 * write-triggered dependencies). This ensures that only the
1890 * write-side dependencies matter, and that if for example a
1891 * write-lock never takes any other locks, then the reads are
1892 * equivalent to a NOP.
1893 */
1894 if (next->read == 2 || prev->read == 2)
1895 return 1;
1896 /*
1897 * Is the <prev> -> <next> dependency already present?
1898 *
1899 * (this may occur even though this is a new chain: consider
1900 * e.g. the L1 -> L2 -> L3 -> L4 and the L5 -> L1 -> L2 -> L3
1901 * chains - the second one will be new, but L1 already has
1902 * L2 added to its dependency list, due to the first chain.)
1903 */
Dave Jonesf82b2172008-08-11 09:30:23 +02001904 list_for_each_entry(entry, &hlock_class(prev)->locks_after, entry) {
1905 if (entry->class == hlock_class(next)) {
Peter Zijlstra8e182572007-07-19 01:48:54 -07001906 if (distance == 1)
1907 entry->distance = 1;
Byungchul Park70911fd2017-08-07 16:12:50 +09001908 return 1;
Peter Zijlstra8e182572007-07-19 01:48:54 -07001909 }
1910 }
1911
Peter Zijlstraae813302017-03-03 10:13:38 +01001912 /*
1913 * Is the <prev> -> <next> link redundant?
1914 */
1915 this.class = hlock_class(prev);
1916 this.parent = NULL;
1917 ret = check_redundant(&this, hlock_class(next), &target_entry);
1918 if (!ret) {
1919 debug_atomic_inc(nr_redundant);
1920 return 2;
1921 }
1922 if (ret < 0)
1923 return print_bfs_bug(ret);
1924
1925
Peter Zijlstra8b405d52017-10-04 11:13:37 +02001926 if (!trace->entries && !save(trace))
Byungchul Parkce07a9412017-08-07 16:12:51 +09001927 return 0;
Yong Zhang4726f2a2010-05-04 14:16:48 +08001928
Peter Zijlstra8e182572007-07-19 01:48:54 -07001929 /*
1930 * Ok, all validations passed, add the new lock
1931 * to the previous lock's dependency list:
1932 */
Bart Van Assche86cffb82019-02-14 15:00:41 -08001933 ret = add_lock_to_list(hlock_class(next), hlock_class(prev),
Dave Jonesf82b2172008-08-11 09:30:23 +02001934 &hlock_class(prev)->locks_after,
Byungchul Parkce07a9412017-08-07 16:12:51 +09001935 next->acquire_ip, distance, trace);
Peter Zijlstra8e182572007-07-19 01:48:54 -07001936
1937 if (!ret)
1938 return 0;
1939
Bart Van Assche86cffb82019-02-14 15:00:41 -08001940 ret = add_lock_to_list(hlock_class(prev), hlock_class(next),
Dave Jonesf82b2172008-08-11 09:30:23 +02001941 &hlock_class(next)->locks_before,
Byungchul Parkce07a9412017-08-07 16:12:51 +09001942 next->acquire_ip, distance, trace);
Peter Zijlstra8e182572007-07-19 01:48:54 -07001943 if (!ret)
1944 return 0;
1945
Byungchul Park70911fd2017-08-07 16:12:50 +09001946 return 2;
Peter Zijlstra8e182572007-07-19 01:48:54 -07001947}
1948
1949/*
1950 * Add the dependency to all directly-previous locks that are 'relevant'.
1951 * The ones that are relevant are (in increasing distance from curr):
1952 * all consecutive trylock entries and the final non-trylock entry - or
1953 * the end of this context's lock-chain - whichever comes first.
1954 */
1955static int
1956check_prevs_add(struct task_struct *curr, struct held_lock *next)
1957{
1958 int depth = curr->lockdep_depth;
1959 struct held_lock *hlock;
Peter Zijlstra8b405d52017-10-04 11:13:37 +02001960 struct stack_trace trace = {
1961 .nr_entries = 0,
1962 .max_entries = 0,
1963 .entries = NULL,
1964 .skip = 0,
1965 };
Peter Zijlstra8e182572007-07-19 01:48:54 -07001966
1967 /*
1968 * Debugging checks.
1969 *
1970 * Depth must not be zero for a non-head lock:
1971 */
1972 if (!depth)
1973 goto out_bug;
1974 /*
1975 * At least two relevant locks must exist for this
1976 * to be a head:
1977 */
1978 if (curr->held_locks[depth].irq_context !=
1979 curr->held_locks[depth-1].irq_context)
1980 goto out_bug;
1981
1982 for (;;) {
1983 int distance = curr->lockdep_depth - depth + 1;
Oleg Nesterov1b5ff812014-01-20 19:20:10 +01001984 hlock = curr->held_locks + depth - 1;
Byungchul Parkce07a9412017-08-07 16:12:51 +09001985
Ingo Molnare966eae2017-12-12 12:31:16 +01001986 /*
1987 * Only non-recursive-read entries get new dependencies
1988 * added:
1989 */
1990 if (hlock->read != 2 && hlock->check) {
1991 int ret = check_prev_add(curr, hlock, next, distance, &trace, save_trace);
1992 if (!ret)
1993 return 0;
1994
1995 /*
1996 * Stop after the first non-trylock entry,
1997 * as non-trylock entries have added their
1998 * own direct dependencies already, so this
1999 * lock is connected to them indirectly:
2000 */
2001 if (!hlock->trylock)
2002 break;
Peter Zijlstra8e182572007-07-19 01:48:54 -07002003 }
Ingo Molnare966eae2017-12-12 12:31:16 +01002004
Peter Zijlstra8e182572007-07-19 01:48:54 -07002005 depth--;
2006 /*
2007 * End of lock-stack?
2008 */
2009 if (!depth)
2010 break;
2011 /*
2012 * Stop the search if we cross into another context:
2013 */
2014 if (curr->held_locks[depth].irq_context !=
2015 curr->held_locks[depth-1].irq_context)
2016 break;
2017 }
2018 return 1;
2019out_bug:
2020 if (!debug_locks_off_graph_unlock())
2021 return 0;
2022
Peter Zijlstra0119fee2011-09-02 01:30:29 +02002023 /*
2024 * Clearly we all shouldn't be here, but since we made it we
2025 * can reliable say we messed up our state. See the above two
2026 * gotos for reasons why we could possibly end up here.
2027 */
Peter Zijlstra8e182572007-07-19 01:48:54 -07002028 WARN_ON(1);
2029
2030 return 0;
2031}
2032
2033unsigned long nr_lock_chains;
Huang, Ying443cd502008-06-20 16:39:21 +08002034struct lock_chain lock_chains[MAX_LOCKDEP_CHAINS];
Huang, Yingcd1a28e2008-06-23 11:20:54 +08002035int nr_chain_hlocks;
Huang, Ying443cd502008-06-20 16:39:21 +08002036static u16 chain_hlocks[MAX_LOCKDEP_CHAIN_HLOCKS];
2037
2038struct lock_class *lock_chain_get_class(struct lock_chain *chain, int i)
2039{
2040 return lock_classes + chain_hlocks[chain->base + i];
2041}
Peter Zijlstra8e182572007-07-19 01:48:54 -07002042
2043/*
Ingo Molnar9e4e7552016-02-29 10:03:58 +01002044 * Returns the index of the first held_lock of the current chain
2045 */
2046static inline int get_first_held_lock(struct task_struct *curr,
2047 struct held_lock *hlock)
2048{
2049 int i;
2050 struct held_lock *hlock_curr;
2051
2052 for (i = curr->lockdep_depth - 1; i >= 0; i--) {
2053 hlock_curr = curr->held_locks + i;
2054 if (hlock_curr->irq_context != hlock->irq_context)
2055 break;
2056
2057 }
2058
2059 return ++i;
2060}
2061
Borislav Petkov5c8a0102016-04-04 10:42:07 +02002062#ifdef CONFIG_DEBUG_LOCKDEP
Ingo Molnar9e4e7552016-02-29 10:03:58 +01002063/*
Alfredo Alvarez Fernandez39e2e172016-03-30 19:03:36 +02002064 * Returns the next chain_key iteration
2065 */
2066static u64 print_chain_key_iteration(int class_idx, u64 chain_key)
2067{
2068 u64 new_chain_key = iterate_chain_key(chain_key, class_idx);
2069
2070 printk(" class_idx:%d -> chain_key:%016Lx",
2071 class_idx,
2072 (unsigned long long)new_chain_key);
2073 return new_chain_key;
2074}
2075
2076static void
2077print_chain_keys_held_locks(struct task_struct *curr, struct held_lock *hlock_next)
2078{
2079 struct held_lock *hlock;
2080 u64 chain_key = 0;
2081 int depth = curr->lockdep_depth;
2082 int i;
2083
2084 printk("depth: %u\n", depth + 1);
2085 for (i = get_first_held_lock(curr, hlock_next); i < depth; i++) {
2086 hlock = curr->held_locks + i;
2087 chain_key = print_chain_key_iteration(hlock->class_idx, chain_key);
2088
2089 print_lock(hlock);
2090 }
2091
2092 print_chain_key_iteration(hlock_next->class_idx, chain_key);
2093 print_lock(hlock_next);
2094}
2095
2096static void print_chain_keys_chain(struct lock_chain *chain)
2097{
2098 int i;
2099 u64 chain_key = 0;
2100 int class_id;
2101
2102 printk("depth: %u\n", chain->depth);
2103 for (i = 0; i < chain->depth; i++) {
2104 class_id = chain_hlocks[chain->base + i];
2105 chain_key = print_chain_key_iteration(class_id + 1, chain_key);
2106
2107 print_lock_name(lock_classes + class_id);
2108 printk("\n");
2109 }
2110}
2111
2112static void print_collision(struct task_struct *curr,
2113 struct held_lock *hlock_next,
2114 struct lock_chain *chain)
2115{
Paul E. McKenney681fbec2017-05-04 15:44:38 -07002116 pr_warn("\n");
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08002117 pr_warn("============================\n");
2118 pr_warn("WARNING: chain_key collision\n");
Alfredo Alvarez Fernandez39e2e172016-03-30 19:03:36 +02002119 print_kernel_ident();
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08002120 pr_warn("----------------------------\n");
Paul E. McKenney681fbec2017-05-04 15:44:38 -07002121 pr_warn("%s/%d: ", current->comm, task_pid_nr(current));
2122 pr_warn("Hash chain already cached but the contents don't match!\n");
Alfredo Alvarez Fernandez39e2e172016-03-30 19:03:36 +02002123
Paul E. McKenney681fbec2017-05-04 15:44:38 -07002124 pr_warn("Held locks:");
Alfredo Alvarez Fernandez39e2e172016-03-30 19:03:36 +02002125 print_chain_keys_held_locks(curr, hlock_next);
2126
Paul E. McKenney681fbec2017-05-04 15:44:38 -07002127 pr_warn("Locks in cached chain:");
Alfredo Alvarez Fernandez39e2e172016-03-30 19:03:36 +02002128 print_chain_keys_chain(chain);
2129
Paul E. McKenney681fbec2017-05-04 15:44:38 -07002130 pr_warn("\nstack backtrace:\n");
Alfredo Alvarez Fernandez39e2e172016-03-30 19:03:36 +02002131 dump_stack();
2132}
Borislav Petkov5c8a0102016-04-04 10:42:07 +02002133#endif
Alfredo Alvarez Fernandez39e2e172016-03-30 19:03:36 +02002134
2135/*
Ingo Molnar9e4e7552016-02-29 10:03:58 +01002136 * Checks whether the chain and the current held locks are consistent
2137 * in depth and also in content. If they are not it most likely means
2138 * that there was a collision during the calculation of the chain_key.
2139 * Returns: 0 not passed, 1 passed
2140 */
2141static int check_no_collision(struct task_struct *curr,
2142 struct held_lock *hlock,
2143 struct lock_chain *chain)
2144{
2145#ifdef CONFIG_DEBUG_LOCKDEP
2146 int i, j, id;
2147
2148 i = get_first_held_lock(curr, hlock);
2149
Alfredo Alvarez Fernandez39e2e172016-03-30 19:03:36 +02002150 if (DEBUG_LOCKS_WARN_ON(chain->depth != curr->lockdep_depth - (i - 1))) {
2151 print_collision(curr, hlock, chain);
Ingo Molnar9e4e7552016-02-29 10:03:58 +01002152 return 0;
Alfredo Alvarez Fernandez39e2e172016-03-30 19:03:36 +02002153 }
Ingo Molnar9e4e7552016-02-29 10:03:58 +01002154
2155 for (j = 0; j < chain->depth - 1; j++, i++) {
2156 id = curr->held_locks[i].class_idx - 1;
2157
Alfredo Alvarez Fernandez39e2e172016-03-30 19:03:36 +02002158 if (DEBUG_LOCKS_WARN_ON(chain_hlocks[chain->base + j] != id)) {
2159 print_collision(curr, hlock, chain);
Ingo Molnar9e4e7552016-02-29 10:03:58 +01002160 return 0;
Alfredo Alvarez Fernandez39e2e172016-03-30 19:03:36 +02002161 }
Ingo Molnar9e4e7552016-02-29 10:03:58 +01002162 }
2163#endif
2164 return 1;
2165}
2166
2167/*
Byungchul Park545c23f2017-08-07 16:12:48 +09002168 * Adds a dependency chain into chain hashtable. And must be called with
2169 * graph_lock held.
2170 *
2171 * Return 0 if fail, and graph_lock is released.
2172 * Return 1 if succeed, with graph_lock held.
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002173 */
Byungchul Park545c23f2017-08-07 16:12:48 +09002174static inline int add_chain_cache(struct task_struct *curr,
2175 struct held_lock *hlock,
2176 u64 chain_key)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002177{
Dave Jonesf82b2172008-08-11 09:30:23 +02002178 struct lock_class *class = hlock_class(hlock);
Andrew Mortona63f38c2016-02-03 13:44:12 -08002179 struct hlist_head *hash_head = chainhashentry(chain_key);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002180 struct lock_chain *chain;
Steven Rostedte0944ee2011-04-20 21:42:00 -04002181 int i, j;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002182
Peter Zijlstra0119fee2011-09-02 01:30:29 +02002183 /*
Byungchul Park545c23f2017-08-07 16:12:48 +09002184 * Allocate a new chain entry from the static array, and add
2185 * it to the hash:
2186 */
2187
2188 /*
Peter Zijlstra0119fee2011-09-02 01:30:29 +02002189 * We might need to take the graph lock, ensure we've got IRQs
2190 * disabled to make this an IRQ-safe lock.. for recursion reasons
2191 * lockdep won't complain about its own locking errors.
2192 */
Jarek Poplawski381a2292007-02-10 01:44:58 -08002193 if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
2194 return 0;
Ingo Molnar9e4e7552016-02-29 10:03:58 +01002195
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002196 if (unlikely(nr_lock_chains >= MAX_LOCKDEP_CHAINS)) {
Ingo Molnar74c383f2006-12-13 00:34:43 -08002197 if (!debug_locks_off_graph_unlock())
2198 return 0;
2199
Dave Jones2c522832013-04-25 13:40:02 -04002200 print_lockdep_off("BUG: MAX_LOCKDEP_CHAINS too low!");
Peter Zijlstraeedeeab2009-03-18 12:38:47 +01002201 dump_stack();
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002202 return 0;
2203 }
2204 chain = lock_chains + nr_lock_chains++;
2205 chain->chain_key = chain_key;
Huang, Ying443cd502008-06-20 16:39:21 +08002206 chain->irq_context = hlock->irq_context;
Ingo Molnar9e4e7552016-02-29 10:03:58 +01002207 i = get_first_held_lock(curr, hlock);
Huang, Ying443cd502008-06-20 16:39:21 +08002208 chain->depth = curr->lockdep_depth + 1 - i;
Peter Zijlstra75dd6022016-03-30 11:36:59 +02002209
2210 BUILD_BUG_ON((1UL << 24) <= ARRAY_SIZE(chain_hlocks));
2211 BUILD_BUG_ON((1UL << 6) <= ARRAY_SIZE(curr->held_locks));
2212 BUILD_BUG_ON((1UL << 8*sizeof(chain_hlocks[0])) <= ARRAY_SIZE(lock_classes));
2213
Steven Rostedte0944ee2011-04-20 21:42:00 -04002214 if (likely(nr_chain_hlocks + chain->depth <= MAX_LOCKDEP_CHAIN_HLOCKS)) {
2215 chain->base = nr_chain_hlocks;
Huang, Ying443cd502008-06-20 16:39:21 +08002216 for (j = 0; j < chain->depth - 1; j++, i++) {
Dave Jonesf82b2172008-08-11 09:30:23 +02002217 int lock_id = curr->held_locks[i].class_idx - 1;
Huang, Ying443cd502008-06-20 16:39:21 +08002218 chain_hlocks[chain->base + j] = lock_id;
2219 }
2220 chain_hlocks[chain->base + j] = class - lock_classes;
Peter Zijlstra75dd6022016-03-30 11:36:59 +02002221 nr_chain_hlocks += chain->depth;
Bart Van Assche523b1132019-02-14 15:00:39 -08002222 } else {
Byungchul Parkf9af4562017-01-13 11:42:04 +09002223 if (!debug_locks_off_graph_unlock())
Peter Zijlstra75dd6022016-03-30 11:36:59 +02002224 return 0;
2225
2226 print_lockdep_off("BUG: MAX_LOCKDEP_CHAIN_HLOCKS too low!");
2227 dump_stack();
2228 return 0;
2229 }
Peter Zijlstra75dd6022016-03-30 11:36:59 +02002230
Andrew Mortona63f38c2016-02-03 13:44:12 -08002231 hlist_add_head_rcu(&chain->entry, hash_head);
Frederic Weisbeckerbd6d29c2010-04-06 00:10:17 +02002232 debug_atomic_inc(chain_lookup_misses);
Peter Zijlstra8e182572007-07-19 01:48:54 -07002233 inc_chains();
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002234
2235 return 1;
2236}
Peter Zijlstra8e182572007-07-19 01:48:54 -07002237
Byungchul Park545c23f2017-08-07 16:12:48 +09002238/*
2239 * Look up a dependency chain.
2240 */
2241static inline struct lock_chain *lookup_chain_cache(u64 chain_key)
2242{
2243 struct hlist_head *hash_head = chainhashentry(chain_key);
2244 struct lock_chain *chain;
2245
2246 /*
2247 * We can walk it lock-free, because entries only get added
2248 * to the hash:
2249 */
2250 hlist_for_each_entry_rcu(chain, hash_head, entry) {
2251 if (chain->chain_key == chain_key) {
2252 debug_atomic_inc(chain_lookup_hits);
2253 return chain;
2254 }
2255 }
2256 return NULL;
2257}
2258
2259/*
2260 * If the key is not present yet in dependency chain cache then
2261 * add it and return 1 - in this case the new dependency chain is
2262 * validated. If the key is already hashed, return 0.
2263 * (On return with 1 graph_lock is held.)
2264 */
2265static inline int lookup_chain_cache_add(struct task_struct *curr,
2266 struct held_lock *hlock,
2267 u64 chain_key)
2268{
2269 struct lock_class *class = hlock_class(hlock);
2270 struct lock_chain *chain = lookup_chain_cache(chain_key);
2271
2272 if (chain) {
2273cache_hit:
2274 if (!check_no_collision(curr, hlock, chain))
2275 return 0;
2276
2277 if (very_verbose(class)) {
2278 printk("\nhash chain already cached, key: "
Borislav Petkov04860d42018-02-26 14:49:26 +01002279 "%016Lx tail class: [%px] %s\n",
Byungchul Park545c23f2017-08-07 16:12:48 +09002280 (unsigned long long)chain_key,
2281 class->key, class->name);
2282 }
2283
2284 return 0;
2285 }
2286
2287 if (very_verbose(class)) {
Borislav Petkov04860d42018-02-26 14:49:26 +01002288 printk("\nnew hash chain, key: %016Lx tail class: [%px] %s\n",
Byungchul Park545c23f2017-08-07 16:12:48 +09002289 (unsigned long long)chain_key, class->key, class->name);
2290 }
2291
2292 if (!graph_lock())
2293 return 0;
2294
2295 /*
2296 * We have to walk the chain again locked - to avoid duplicates:
2297 */
2298 chain = lookup_chain_cache(chain_key);
2299 if (chain) {
2300 graph_unlock();
2301 goto cache_hit;
2302 }
2303
2304 if (!add_chain_cache(curr, hlock, chain_key))
2305 return 0;
2306
2307 return 1;
2308}
2309
Peter Zijlstra8e182572007-07-19 01:48:54 -07002310static int validate_chain(struct task_struct *curr, struct lockdep_map *lock,
Johannes Berg4e6045f2007-10-18 23:39:55 -07002311 struct held_lock *hlock, int chain_head, u64 chain_key)
Peter Zijlstra8e182572007-07-19 01:48:54 -07002312{
2313 /*
2314 * Trylock needs to maintain the stack of held locks, but it
2315 * does not add new dependencies, because trylock can be done
2316 * in any order.
2317 *
2318 * We look up the chain_key and do the O(N^2) check and update of
2319 * the dependencies only if this is a new dependency chain.
Byungchul Park545c23f2017-08-07 16:12:48 +09002320 * (If lookup_chain_cache_add() return with 1 it acquires
Peter Zijlstra8e182572007-07-19 01:48:54 -07002321 * graph_lock for us)
2322 */
Oleg Nesterovfb9edbe2014-01-20 19:20:06 +01002323 if (!hlock->trylock && hlock->check &&
Byungchul Park545c23f2017-08-07 16:12:48 +09002324 lookup_chain_cache_add(curr, hlock, chain_key)) {
Peter Zijlstra8e182572007-07-19 01:48:54 -07002325 /*
2326 * Check whether last held lock:
2327 *
2328 * - is irq-safe, if this lock is irq-unsafe
2329 * - is softirq-safe, if this lock is hardirq-unsafe
2330 *
2331 * And check whether the new lock's dependency graph
2332 * could lead back to the previous lock.
2333 *
2334 * any of these scenarios could lead to a deadlock. If
2335 * All validations
2336 */
2337 int ret = check_deadlock(curr, hlock, lock, hlock->read);
2338
2339 if (!ret)
2340 return 0;
2341 /*
2342 * Mark recursive read, as we jump over it when
2343 * building dependencies (just like we jump over
2344 * trylock entries):
2345 */
2346 if (ret == 2)
2347 hlock->read = 2;
2348 /*
2349 * Add dependency only if this lock is not the head
2350 * of the chain, and if it's not a secondary read-lock:
2351 */
Byungchul Park545c23f2017-08-07 16:12:48 +09002352 if (!chain_head && ret != 2) {
Peter Zijlstra8e182572007-07-19 01:48:54 -07002353 if (!check_prevs_add(curr, hlock))
2354 return 0;
Byungchul Park545c23f2017-08-07 16:12:48 +09002355 }
2356
Peter Zijlstra8e182572007-07-19 01:48:54 -07002357 graph_unlock();
Byungchul Park545c23f2017-08-07 16:12:48 +09002358 } else {
2359 /* after lookup_chain_cache_add(): */
Peter Zijlstra8e182572007-07-19 01:48:54 -07002360 if (unlikely(!debug_locks))
2361 return 0;
Byungchul Park545c23f2017-08-07 16:12:48 +09002362 }
Peter Zijlstra8e182572007-07-19 01:48:54 -07002363
2364 return 1;
2365}
2366#else
2367static inline int validate_chain(struct task_struct *curr,
2368 struct lockdep_map *lock, struct held_lock *hlock,
Gregory Haskins3aa416b2007-10-11 22:11:11 +02002369 int chain_head, u64 chain_key)
Peter Zijlstra8e182572007-07-19 01:48:54 -07002370{
2371 return 1;
2372}
Peter Zijlstraca58abc2007-07-19 01:48:53 -07002373#endif
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002374
2375/*
2376 * We are building curr_chain_key incrementally, so double-check
2377 * it from scratch, to make sure that it's done correctly:
2378 */
Steven Rostedt1d09daa2008-05-12 21:20:55 +02002379static void check_chain_key(struct task_struct *curr)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002380{
2381#ifdef CONFIG_DEBUG_LOCKDEP
2382 struct held_lock *hlock, *prev_hlock = NULL;
Alfredo Alvarez Fernandez5f18ab52016-02-11 00:33:32 +01002383 unsigned int i;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002384 u64 chain_key = 0;
2385
2386 for (i = 0; i < curr->lockdep_depth; i++) {
2387 hlock = curr->held_locks + i;
2388 if (chain_key != hlock->prev_chain_key) {
2389 debug_locks_off();
Peter Zijlstra0119fee2011-09-02 01:30:29 +02002390 /*
2391 * We got mighty confused, our chain keys don't match
2392 * with what we expect, someone trample on our task state?
2393 */
Arjan van de Ven2df8b1d2008-07-30 12:43:11 -07002394 WARN(1, "hm#1, depth: %u [%u], %016Lx != %016Lx\n",
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002395 curr->lockdep_depth, i,
2396 (unsigned long long)chain_key,
2397 (unsigned long long)hlock->prev_chain_key);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002398 return;
2399 }
Peter Zijlstra0119fee2011-09-02 01:30:29 +02002400 /*
2401 * Whoops ran out of static storage again?
2402 */
Alfredo Alvarez Fernandez5f18ab52016-02-11 00:33:32 +01002403 if (DEBUG_LOCKS_WARN_ON(hlock->class_idx > MAX_LOCKDEP_KEYS))
Jarek Poplawski381a2292007-02-10 01:44:58 -08002404 return;
2405
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002406 if (prev_hlock && (prev_hlock->irq_context !=
2407 hlock->irq_context))
2408 chain_key = 0;
Alfredo Alvarez Fernandez5f18ab52016-02-11 00:33:32 +01002409 chain_key = iterate_chain_key(chain_key, hlock->class_idx);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002410 prev_hlock = hlock;
2411 }
2412 if (chain_key != curr->curr_chain_key) {
2413 debug_locks_off();
Peter Zijlstra0119fee2011-09-02 01:30:29 +02002414 /*
2415 * More smoking hash instead of calculating it, damn see these
2416 * numbers float.. I bet that a pink elephant stepped on my memory.
2417 */
Arjan van de Ven2df8b1d2008-07-30 12:43:11 -07002418 WARN(1, "hm#2, depth: %u [%u], %016Lx != %016Lx\n",
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002419 curr->lockdep_depth, i,
2420 (unsigned long long)chain_key,
2421 (unsigned long long)curr->curr_chain_key);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002422 }
2423#endif
2424}
2425
Steven Rostedt282b5c22011-04-20 21:41:59 -04002426static void
2427print_usage_bug_scenario(struct held_lock *lock)
2428{
2429 struct lock_class *class = hlock_class(lock);
2430
2431 printk(" Possible unsafe locking scenario:\n\n");
2432 printk(" CPU0\n");
2433 printk(" ----\n");
2434 printk(" lock(");
2435 __print_lock_name(class);
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01002436 printk(KERN_CONT ");\n");
Steven Rostedt282b5c22011-04-20 21:41:59 -04002437 printk(" <Interrupt>\n");
2438 printk(" lock(");
2439 __print_lock_name(class);
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01002440 printk(KERN_CONT ");\n");
Steven Rostedt282b5c22011-04-20 21:41:59 -04002441 printk("\n *** DEADLOCK ***\n\n");
2442}
2443
Peter Zijlstra8e182572007-07-19 01:48:54 -07002444static int
2445print_usage_bug(struct task_struct *curr, struct held_lock *this,
2446 enum lock_usage_bit prev_bit, enum lock_usage_bit new_bit)
2447{
2448 if (!debug_locks_off_graph_unlock() || debug_locks_silent)
2449 return 0;
2450
Paul E. McKenney681fbec2017-05-04 15:44:38 -07002451 pr_warn("\n");
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08002452 pr_warn("================================\n");
2453 pr_warn("WARNING: inconsistent lock state\n");
Ben Hutchingsfbdc4b92011-10-28 04:36:55 +01002454 print_kernel_ident();
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08002455 pr_warn("--------------------------------\n");
Peter Zijlstra8e182572007-07-19 01:48:54 -07002456
Paul E. McKenney681fbec2017-05-04 15:44:38 -07002457 pr_warn("inconsistent {%s} -> {%s} usage.\n",
Peter Zijlstra8e182572007-07-19 01:48:54 -07002458 usage_str[prev_bit], usage_str[new_bit]);
2459
Paul E. McKenney681fbec2017-05-04 15:44:38 -07002460 pr_warn("%s/%d [HC%u[%lu]:SC%u[%lu]:HE%u:SE%u] takes:\n",
Pavel Emelyanovba25f9d2007-10-18 23:40:40 -07002461 curr->comm, task_pid_nr(curr),
Peter Zijlstra8e182572007-07-19 01:48:54 -07002462 trace_hardirq_context(curr), hardirq_count() >> HARDIRQ_SHIFT,
2463 trace_softirq_context(curr), softirq_count() >> SOFTIRQ_SHIFT,
2464 trace_hardirqs_enabled(curr),
2465 trace_softirqs_enabled(curr));
2466 print_lock(this);
2467
Paul E. McKenney681fbec2017-05-04 15:44:38 -07002468 pr_warn("{%s} state was registered at:\n", usage_str[prev_bit]);
Dave Jonesf82b2172008-08-11 09:30:23 +02002469 print_stack_trace(hlock_class(this)->usage_traces + prev_bit, 1);
Peter Zijlstra8e182572007-07-19 01:48:54 -07002470
2471 print_irqtrace_events(curr);
Paul E. McKenney681fbec2017-05-04 15:44:38 -07002472 pr_warn("\nother info that might help us debug this:\n");
Steven Rostedt282b5c22011-04-20 21:41:59 -04002473 print_usage_bug_scenario(this);
2474
Peter Zijlstra8e182572007-07-19 01:48:54 -07002475 lockdep_print_held_locks(curr);
2476
Paul E. McKenney681fbec2017-05-04 15:44:38 -07002477 pr_warn("\nstack backtrace:\n");
Peter Zijlstra8e182572007-07-19 01:48:54 -07002478 dump_stack();
2479
2480 return 0;
2481}
2482
2483/*
2484 * Print out an error if an invalid bit is set:
2485 */
2486static inline int
2487valid_state(struct task_struct *curr, struct held_lock *this,
2488 enum lock_usage_bit new_bit, enum lock_usage_bit bad_bit)
2489{
Dave Jonesf82b2172008-08-11 09:30:23 +02002490 if (unlikely(hlock_class(this)->usage_mask & (1 << bad_bit)))
Peter Zijlstra8e182572007-07-19 01:48:54 -07002491 return print_usage_bug(curr, this, bad_bit, new_bit);
2492 return 1;
2493}
2494
2495static int mark_lock(struct task_struct *curr, struct held_lock *this,
2496 enum lock_usage_bit new_bit);
2497
Steven Rostedt81d68a92008-05-12 21:20:42 +02002498#if defined(CONFIG_TRACE_IRQFLAGS) && defined(CONFIG_PROVE_LOCKING)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002499
2500/*
2501 * print irq inversion bug:
2502 */
2503static int
Ming Lei24208ca2009-07-16 15:44:29 +02002504print_irq_inversion_bug(struct task_struct *curr,
2505 struct lock_list *root, struct lock_list *other,
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002506 struct held_lock *this, int forwards,
2507 const char *irqclass)
2508{
Steven Rostedtdad3d742011-04-20 21:41:57 -04002509 struct lock_list *entry = other;
2510 struct lock_list *middle = NULL;
2511 int depth;
2512
Ingo Molnar74c383f2006-12-13 00:34:43 -08002513 if (!debug_locks_off_graph_unlock() || debug_locks_silent)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002514 return 0;
2515
Paul E. McKenney681fbec2017-05-04 15:44:38 -07002516 pr_warn("\n");
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08002517 pr_warn("========================================================\n");
2518 pr_warn("WARNING: possible irq lock inversion dependency detected\n");
Ben Hutchingsfbdc4b92011-10-28 04:36:55 +01002519 print_kernel_ident();
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08002520 pr_warn("--------------------------------------------------------\n");
Paul E. McKenney681fbec2017-05-04 15:44:38 -07002521 pr_warn("%s/%d just changed the state of lock:\n",
Pavel Emelyanovba25f9d2007-10-18 23:40:40 -07002522 curr->comm, task_pid_nr(curr));
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002523 print_lock(this);
2524 if (forwards)
Paul E. McKenney681fbec2017-05-04 15:44:38 -07002525 pr_warn("but this lock took another, %s-unsafe lock in the past:\n", irqclass);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002526 else
Paul E. McKenney681fbec2017-05-04 15:44:38 -07002527 pr_warn("but this lock was taken by another, %s-safe lock in the past:\n", irqclass);
Ming Lei24208ca2009-07-16 15:44:29 +02002528 print_lock_name(other->class);
Paul E. McKenney681fbec2017-05-04 15:44:38 -07002529 pr_warn("\n\nand interrupts could create inverse lock ordering between them.\n\n");
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002530
Paul E. McKenney681fbec2017-05-04 15:44:38 -07002531 pr_warn("\nother info that might help us debug this:\n");
Steven Rostedtdad3d742011-04-20 21:41:57 -04002532
2533 /* Find a middle lock (if one exists) */
2534 depth = get_lock_depth(other);
2535 do {
2536 if (depth == 0 && (entry != root)) {
Paul E. McKenney681fbec2017-05-04 15:44:38 -07002537 pr_warn("lockdep:%s bad path found in chain graph\n", __func__);
Steven Rostedtdad3d742011-04-20 21:41:57 -04002538 break;
2539 }
2540 middle = entry;
2541 entry = get_lock_parent(entry);
2542 depth--;
2543 } while (entry && entry != root && (depth >= 0));
2544 if (forwards)
2545 print_irq_lock_scenario(root, other,
2546 middle ? middle->class : root->class, other->class);
2547 else
2548 print_irq_lock_scenario(other, root,
2549 middle ? middle->class : other->class, root->class);
2550
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002551 lockdep_print_held_locks(curr);
2552
Paul E. McKenney681fbec2017-05-04 15:44:38 -07002553 pr_warn("\nthe shortest dependencies between 2nd lock and 1st lock:\n");
Ming Lei24208ca2009-07-16 15:44:29 +02002554 if (!save_trace(&root->trace))
2555 return 0;
2556 print_shortest_lock_dependencies(other, root);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002557
Paul E. McKenney681fbec2017-05-04 15:44:38 -07002558 pr_warn("\nstack backtrace:\n");
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002559 dump_stack();
2560
2561 return 0;
2562}
2563
2564/*
2565 * Prove that in the forwards-direction subgraph starting at <this>
2566 * there is no lock matching <mask>:
2567 */
2568static int
2569check_usage_forwards(struct task_struct *curr, struct held_lock *this,
2570 enum lock_usage_bit bit, const char *irqclass)
2571{
2572 int ret;
Ming Leid7aaba12009-07-16 15:44:29 +02002573 struct lock_list root;
2574 struct lock_list *uninitialized_var(target_entry);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002575
Ming Leid7aaba12009-07-16 15:44:29 +02002576 root.parent = NULL;
2577 root.class = hlock_class(this);
2578 ret = find_usage_forwards(&root, bit, &target_entry);
Peter Zijlstraaf012962009-07-16 15:44:29 +02002579 if (ret < 0)
2580 return print_bfs_bug(ret);
2581 if (ret == 1)
2582 return ret;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002583
Ming Lei24208ca2009-07-16 15:44:29 +02002584 return print_irq_inversion_bug(curr, &root, target_entry,
Ming Leid7aaba12009-07-16 15:44:29 +02002585 this, 1, irqclass);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002586}
2587
2588/*
2589 * Prove that in the backwards-direction subgraph starting at <this>
2590 * there is no lock matching <mask>:
2591 */
2592static int
2593check_usage_backwards(struct task_struct *curr, struct held_lock *this,
2594 enum lock_usage_bit bit, const char *irqclass)
2595{
2596 int ret;
Ming Leid7aaba12009-07-16 15:44:29 +02002597 struct lock_list root;
2598 struct lock_list *uninitialized_var(target_entry);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002599
Ming Leid7aaba12009-07-16 15:44:29 +02002600 root.parent = NULL;
2601 root.class = hlock_class(this);
2602 ret = find_usage_backwards(&root, bit, &target_entry);
Peter Zijlstraaf012962009-07-16 15:44:29 +02002603 if (ret < 0)
2604 return print_bfs_bug(ret);
2605 if (ret == 1)
2606 return ret;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002607
Ming Lei24208ca2009-07-16 15:44:29 +02002608 return print_irq_inversion_bug(curr, &root, target_entry,
Oleg Nesterov48d50672010-01-26 19:16:41 +01002609 this, 0, irqclass);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002610}
2611
Ingo Molnar3117df02006-12-13 00:34:43 -08002612void print_irqtrace_events(struct task_struct *curr)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002613{
2614 printk("irq event stamp: %u\n", curr->irq_events);
Borislav Petkov04860d42018-02-26 14:49:26 +01002615 printk("hardirqs last enabled at (%u): [<%px>] %pS\n",
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01002616 curr->hardirq_enable_event, (void *)curr->hardirq_enable_ip,
2617 (void *)curr->hardirq_enable_ip);
Borislav Petkov04860d42018-02-26 14:49:26 +01002618 printk("hardirqs last disabled at (%u): [<%px>] %pS\n",
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01002619 curr->hardirq_disable_event, (void *)curr->hardirq_disable_ip,
2620 (void *)curr->hardirq_disable_ip);
Borislav Petkov04860d42018-02-26 14:49:26 +01002621 printk("softirqs last enabled at (%u): [<%px>] %pS\n",
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01002622 curr->softirq_enable_event, (void *)curr->softirq_enable_ip,
2623 (void *)curr->softirq_enable_ip);
Borislav Petkov04860d42018-02-26 14:49:26 +01002624 printk("softirqs last disabled at (%u): [<%px>] %pS\n",
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01002625 curr->softirq_disable_event, (void *)curr->softirq_disable_ip,
2626 (void *)curr->softirq_disable_ip);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002627}
2628
Peter Zijlstracd953022009-01-22 16:38:21 +01002629static int HARDIRQ_verbose(struct lock_class *class)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002630{
Peter Zijlstra8e182572007-07-19 01:48:54 -07002631#if HARDIRQ_VERBOSE
2632 return class_filter(class);
2633#endif
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002634 return 0;
2635}
2636
Peter Zijlstracd953022009-01-22 16:38:21 +01002637static int SOFTIRQ_verbose(struct lock_class *class)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002638{
Peter Zijlstra8e182572007-07-19 01:48:54 -07002639#if SOFTIRQ_VERBOSE
2640 return class_filter(class);
2641#endif
2642 return 0;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002643}
2644
2645#define STRICT_READ_CHECKS 1
2646
Peter Zijlstracd953022009-01-22 16:38:21 +01002647static int (*state_verbose_f[])(struct lock_class *class) = {
2648#define LOCKDEP_STATE(__STATE) \
2649 __STATE##_verbose,
2650#include "lockdep_states.h"
2651#undef LOCKDEP_STATE
2652};
2653
2654static inline int state_verbose(enum lock_usage_bit bit,
2655 struct lock_class *class)
2656{
2657 return state_verbose_f[bit >> 2](class);
2658}
2659
Peter Zijlstra42c50d52009-01-22 16:58:16 +01002660typedef int (*check_usage_f)(struct task_struct *, struct held_lock *,
2661 enum lock_usage_bit bit, const char *name);
2662
Peter Zijlstra6a6904d2009-01-22 16:07:44 +01002663static int
Peter Zijlstra1c21f142009-03-04 13:51:13 +01002664mark_lock_irq(struct task_struct *curr, struct held_lock *this,
2665 enum lock_usage_bit new_bit)
Peter Zijlstra6a6904d2009-01-22 16:07:44 +01002666{
Peter Zijlstraf9892092009-01-22 16:09:59 +01002667 int excl_bit = exclusive_bit(new_bit);
Frederic Weisbeckerbba2a8f2018-12-28 06:02:01 +01002668 int read = new_bit & LOCK_USAGE_READ_MASK;
2669 int dir = new_bit & LOCK_USAGE_DIR_MASK;
Peter Zijlstra42c50d52009-01-22 16:58:16 +01002670
Peter Zijlstra38aa2712009-01-27 14:53:50 +01002671 /*
2672 * mark USED_IN has to look forwards -- to ensure no dependency
2673 * has ENABLED state, which would allow recursion deadlocks.
2674 *
2675 * mark ENABLED has to look backwards -- to ensure no dependee
2676 * has USED_IN state, which, again, would allow recursion deadlocks.
2677 */
Peter Zijlstra42c50d52009-01-22 16:58:16 +01002678 check_usage_f usage = dir ?
2679 check_usage_backwards : check_usage_forwards;
Peter Zijlstraf9892092009-01-22 16:09:59 +01002680
Peter Zijlstra38aa2712009-01-27 14:53:50 +01002681 /*
2682 * Validate that this particular lock does not have conflicting
2683 * usage states.
2684 */
Peter Zijlstra6a6904d2009-01-22 16:07:44 +01002685 if (!valid_state(curr, this, new_bit, excl_bit))
2686 return 0;
Peter Zijlstra9d3651a2009-01-22 17:18:32 +01002687
Peter Zijlstra38aa2712009-01-27 14:53:50 +01002688 /*
2689 * Validate that the lock dependencies don't have conflicting usage
2690 * states.
2691 */
2692 if ((!read || !dir || STRICT_READ_CHECKS) &&
Frederic Weisbeckerbba2a8f2018-12-28 06:02:01 +01002693 !usage(curr, this, excl_bit, state_name(new_bit & ~LOCK_USAGE_READ_MASK)))
Peter Zijlstra6a6904d2009-01-22 16:07:44 +01002694 return 0;
Peter Zijlstra780e8202009-01-22 16:51:29 +01002695
Peter Zijlstra38aa2712009-01-27 14:53:50 +01002696 /*
2697 * Check for read in write conflicts
2698 */
2699 if (!read) {
Frederic Weisbeckerbba2a8f2018-12-28 06:02:01 +01002700 if (!valid_state(curr, this, new_bit, excl_bit + LOCK_USAGE_READ_MASK))
Peter Zijlstra38aa2712009-01-27 14:53:50 +01002701 return 0;
2702
2703 if (STRICT_READ_CHECKS &&
Frederic Weisbeckerbba2a8f2018-12-28 06:02:01 +01002704 !usage(curr, this, excl_bit + LOCK_USAGE_READ_MASK,
2705 state_name(new_bit + LOCK_USAGE_READ_MASK)))
Peter Zijlstra38aa2712009-01-27 14:53:50 +01002706 return 0;
2707 }
Peter Zijlstra780e8202009-01-22 16:51:29 +01002708
Peter Zijlstracd953022009-01-22 16:38:21 +01002709 if (state_verbose(new_bit, hlock_class(this)))
Peter Zijlstra6a6904d2009-01-22 16:07:44 +01002710 return 2;
2711
2712 return 1;
2713}
2714
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002715/*
2716 * Mark all held locks with a usage bit:
2717 */
Steven Rostedt1d09daa2008-05-12 21:20:55 +02002718static int
Frederic Weisbecker436a49a2018-12-28 06:02:00 +01002719mark_held_locks(struct task_struct *curr, enum lock_usage_bit base_bit)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002720{
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002721 struct held_lock *hlock;
2722 int i;
2723
2724 for (i = 0; i < curr->lockdep_depth; i++) {
Frederic Weisbecker436a49a2018-12-28 06:02:00 +01002725 enum lock_usage_bit hlock_bit = base_bit;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002726 hlock = curr->held_locks + i;
2727
Peter Zijlstracf2ad4d2009-01-27 13:58:08 +01002728 if (hlock->read)
Frederic Weisbeckerbba2a8f2018-12-28 06:02:01 +01002729 hlock_bit += LOCK_USAGE_READ_MASK;
Peter Zijlstracf2ad4d2009-01-27 13:58:08 +01002730
Frederic Weisbecker436a49a2018-12-28 06:02:00 +01002731 BUG_ON(hlock_bit >= LOCK_USAGE_STATES);
Nick Piggincf40bd12009-01-21 08:12:39 +01002732
Oleg Nesterov34d0ed52014-01-20 19:20:13 +01002733 if (!hlock->check)
Peter Zijlstraefbe2ee2011-07-07 11:39:45 +02002734 continue;
2735
Frederic Weisbecker436a49a2018-12-28 06:02:00 +01002736 if (!mark_lock(curr, hlock, hlock_bit))
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002737 return 0;
2738 }
2739
2740 return 1;
2741}
2742
2743/*
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002744 * Hardirqs will be enabled:
2745 */
Peter Zijlstradd4e5d32011-06-21 17:17:27 +02002746static void __trace_hardirqs_on_caller(unsigned long ip)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002747{
2748 struct task_struct *curr = current;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002749
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002750 /* we'll do an OFF -> ON transition: */
2751 curr->hardirqs_enabled = 1;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002752
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002753 /*
2754 * We are going to turn hardirqs on, so set the
2755 * usage bit for all held locks:
2756 */
Frederic Weisbecker436a49a2018-12-28 06:02:00 +01002757 if (!mark_held_locks(curr, LOCK_ENABLED_HARDIRQ))
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002758 return;
2759 /*
2760 * If we have softirqs enabled, then set the usage
2761 * bit for all held locks. (disabled hardirqs prevented
2762 * this bit from being set before)
2763 */
2764 if (curr->softirqs_enabled)
Frederic Weisbecker436a49a2018-12-28 06:02:00 +01002765 if (!mark_held_locks(curr, LOCK_ENABLED_SOFTIRQ))
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002766 return;
2767
2768 curr->hardirq_enable_ip = ip;
2769 curr->hardirq_enable_event = ++curr->irq_events;
Frederic Weisbeckerbd6d29c2010-04-06 00:10:17 +02002770 debug_atomic_inc(hardirqs_on_events);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002771}
Peter Zijlstradd4e5d32011-06-21 17:17:27 +02002772
Steven Rostedt (VMware)bff1b202018-08-06 15:50:58 -04002773void lockdep_hardirqs_on(unsigned long ip)
Peter Zijlstradd4e5d32011-06-21 17:17:27 +02002774{
Peter Zijlstradd4e5d32011-06-21 17:17:27 +02002775 if (unlikely(!debug_locks || current->lockdep_recursion))
2776 return;
2777
Peter Zijlstra7d36b262011-07-26 13:13:44 +02002778 if (unlikely(current->hardirqs_enabled)) {
2779 /*
2780 * Neither irq nor preemption are disabled here
2781 * so this is racy by nature but losing one hit
2782 * in a stat is not a big deal.
2783 */
2784 __debug_atomic_inc(redundant_hardirqs_on);
2785 return;
2786 }
2787
Peter Zijlstra0119fee2011-09-02 01:30:29 +02002788 /*
2789 * We're enabling irqs and according to our state above irqs weren't
2790 * already enabled, yet we find the hardware thinks they are in fact
2791 * enabled.. someone messed up their IRQ state tracing.
2792 */
Peter Zijlstradd4e5d32011-06-21 17:17:27 +02002793 if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
2794 return;
2795
Peter Zijlstra0119fee2011-09-02 01:30:29 +02002796 /*
2797 * See the fine text that goes along with this variable definition.
2798 */
Peter Zijlstra7d36b262011-07-26 13:13:44 +02002799 if (DEBUG_LOCKS_WARN_ON(unlikely(early_boot_irqs_disabled)))
2800 return;
2801
Peter Zijlstra0119fee2011-09-02 01:30:29 +02002802 /*
2803 * Can't allow enabling interrupts while in an interrupt handler,
2804 * that's general bad form and such. Recursion, limited stack etc..
2805 */
Peter Zijlstra7d36b262011-07-26 13:13:44 +02002806 if (DEBUG_LOCKS_WARN_ON(current->hardirq_context))
2807 return;
2808
Peter Zijlstradd4e5d32011-06-21 17:17:27 +02002809 current->lockdep_recursion = 1;
2810 __trace_hardirqs_on_caller(ip);
2811 current->lockdep_recursion = 0;
2812}
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002813
2814/*
2815 * Hardirqs were disabled:
2816 */
Steven Rostedt (VMware)bff1b202018-08-06 15:50:58 -04002817void lockdep_hardirqs_off(unsigned long ip)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002818{
2819 struct task_struct *curr = current;
2820
2821 if (unlikely(!debug_locks || current->lockdep_recursion))
2822 return;
2823
Peter Zijlstra0119fee2011-09-02 01:30:29 +02002824 /*
2825 * So we're supposed to get called after you mask local IRQs, but for
2826 * some reason the hardware doesn't quite think you did a proper job.
2827 */
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002828 if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
2829 return;
2830
2831 if (curr->hardirqs_enabled) {
2832 /*
2833 * We have done an ON -> OFF transition:
2834 */
2835 curr->hardirqs_enabled = 0;
Heiko Carstens6afe40b2008-10-28 11:14:58 +01002836 curr->hardirq_disable_ip = ip;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002837 curr->hardirq_disable_event = ++curr->irq_events;
Frederic Weisbeckerbd6d29c2010-04-06 00:10:17 +02002838 debug_atomic_inc(hardirqs_off_events);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002839 } else
Frederic Weisbeckerbd6d29c2010-04-06 00:10:17 +02002840 debug_atomic_inc(redundant_hardirqs_off);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002841}
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002842
2843/*
2844 * Softirqs will be enabled:
2845 */
2846void trace_softirqs_on(unsigned long ip)
2847{
2848 struct task_struct *curr = current;
2849
Peter Zijlstradd4e5d32011-06-21 17:17:27 +02002850 if (unlikely(!debug_locks || current->lockdep_recursion))
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002851 return;
2852
Peter Zijlstra0119fee2011-09-02 01:30:29 +02002853 /*
2854 * We fancy IRQs being disabled here, see softirq.c, avoids
2855 * funny state and nesting things.
2856 */
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002857 if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
2858 return;
2859
2860 if (curr->softirqs_enabled) {
Frederic Weisbeckerbd6d29c2010-04-06 00:10:17 +02002861 debug_atomic_inc(redundant_softirqs_on);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002862 return;
2863 }
2864
Peter Zijlstradd4e5d32011-06-21 17:17:27 +02002865 current->lockdep_recursion = 1;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002866 /*
2867 * We'll do an OFF -> ON transition:
2868 */
2869 curr->softirqs_enabled = 1;
2870 curr->softirq_enable_ip = ip;
2871 curr->softirq_enable_event = ++curr->irq_events;
Frederic Weisbeckerbd6d29c2010-04-06 00:10:17 +02002872 debug_atomic_inc(softirqs_on_events);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002873 /*
2874 * We are going to turn softirqs on, so set the
2875 * usage bit for all held locks, if hardirqs are
2876 * enabled too:
2877 */
2878 if (curr->hardirqs_enabled)
Frederic Weisbecker436a49a2018-12-28 06:02:00 +01002879 mark_held_locks(curr, LOCK_ENABLED_SOFTIRQ);
Peter Zijlstradd4e5d32011-06-21 17:17:27 +02002880 current->lockdep_recursion = 0;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002881}
2882
2883/*
2884 * Softirqs were disabled:
2885 */
2886void trace_softirqs_off(unsigned long ip)
2887{
2888 struct task_struct *curr = current;
2889
Peter Zijlstradd4e5d32011-06-21 17:17:27 +02002890 if (unlikely(!debug_locks || current->lockdep_recursion))
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002891 return;
2892
Peter Zijlstra0119fee2011-09-02 01:30:29 +02002893 /*
2894 * We fancy IRQs being disabled here, see softirq.c
2895 */
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002896 if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
2897 return;
2898
2899 if (curr->softirqs_enabled) {
2900 /*
2901 * We have done an ON -> OFF transition:
2902 */
2903 curr->softirqs_enabled = 0;
2904 curr->softirq_disable_ip = ip;
2905 curr->softirq_disable_event = ++curr->irq_events;
Frederic Weisbeckerbd6d29c2010-04-06 00:10:17 +02002906 debug_atomic_inc(softirqs_off_events);
Peter Zijlstra0119fee2011-09-02 01:30:29 +02002907 /*
2908 * Whoops, we wanted softirqs off, so why aren't they?
2909 */
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002910 DEBUG_LOCKS_WARN_ON(!softirq_count());
2911 } else
Frederic Weisbeckerbd6d29c2010-04-06 00:10:17 +02002912 debug_atomic_inc(redundant_softirqs_off);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002913}
2914
Peter Zijlstra8e182572007-07-19 01:48:54 -07002915static int mark_irqflags(struct task_struct *curr, struct held_lock *hlock)
2916{
2917 /*
2918 * If non-trylock use in a hardirq or softirq context, then
2919 * mark the lock as used in these contexts:
2920 */
2921 if (!hlock->trylock) {
2922 if (hlock->read) {
2923 if (curr->hardirq_context)
2924 if (!mark_lock(curr, hlock,
2925 LOCK_USED_IN_HARDIRQ_READ))
2926 return 0;
2927 if (curr->softirq_context)
2928 if (!mark_lock(curr, hlock,
2929 LOCK_USED_IN_SOFTIRQ_READ))
2930 return 0;
2931 } else {
2932 if (curr->hardirq_context)
2933 if (!mark_lock(curr, hlock, LOCK_USED_IN_HARDIRQ))
2934 return 0;
2935 if (curr->softirq_context)
2936 if (!mark_lock(curr, hlock, LOCK_USED_IN_SOFTIRQ))
2937 return 0;
2938 }
2939 }
2940 if (!hlock->hardirqs_off) {
2941 if (hlock->read) {
2942 if (!mark_lock(curr, hlock,
Peter Zijlstra4fc95e82009-01-22 13:10:52 +01002943 LOCK_ENABLED_HARDIRQ_READ))
Peter Zijlstra8e182572007-07-19 01:48:54 -07002944 return 0;
2945 if (curr->softirqs_enabled)
2946 if (!mark_lock(curr, hlock,
Peter Zijlstra4fc95e82009-01-22 13:10:52 +01002947 LOCK_ENABLED_SOFTIRQ_READ))
Peter Zijlstra8e182572007-07-19 01:48:54 -07002948 return 0;
2949 } else {
2950 if (!mark_lock(curr, hlock,
Peter Zijlstra4fc95e82009-01-22 13:10:52 +01002951 LOCK_ENABLED_HARDIRQ))
Peter Zijlstra8e182572007-07-19 01:48:54 -07002952 return 0;
2953 if (curr->softirqs_enabled)
2954 if (!mark_lock(curr, hlock,
Peter Zijlstra4fc95e82009-01-22 13:10:52 +01002955 LOCK_ENABLED_SOFTIRQ))
Peter Zijlstra8e182572007-07-19 01:48:54 -07002956 return 0;
2957 }
2958 }
2959
2960 return 1;
2961}
2962
Boqun Fengc2469752016-02-16 13:57:40 +08002963static inline unsigned int task_irq_context(struct task_struct *task)
2964{
2965 return 2 * !!task->hardirq_context + !!task->softirq_context;
2966}
2967
Peter Zijlstra8e182572007-07-19 01:48:54 -07002968static int separate_irq_context(struct task_struct *curr,
2969 struct held_lock *hlock)
2970{
2971 unsigned int depth = curr->lockdep_depth;
2972
2973 /*
2974 * Keep track of points where we cross into an interrupt context:
2975 */
Peter Zijlstra8e182572007-07-19 01:48:54 -07002976 if (depth) {
2977 struct held_lock *prev_hlock;
2978
2979 prev_hlock = curr->held_locks + depth-1;
2980 /*
2981 * If we cross into another context, reset the
2982 * hash key (this also prevents the checking and the
2983 * adding of the dependency to 'prev'):
2984 */
2985 if (prev_hlock->irq_context != hlock->irq_context)
2986 return 1;
2987 }
2988 return 0;
2989}
2990
Peter Zijlstra0119fee2011-09-02 01:30:29 +02002991#else /* defined(CONFIG_TRACE_IRQFLAGS) && defined(CONFIG_PROVE_LOCKING) */
Peter Zijlstra8e182572007-07-19 01:48:54 -07002992
2993static inline
2994int mark_lock_irq(struct task_struct *curr, struct held_lock *this,
2995 enum lock_usage_bit new_bit)
2996{
Peter Zijlstra0119fee2011-09-02 01:30:29 +02002997 WARN_ON(1); /* Impossible innit? when we don't have TRACE_IRQFLAG */
Peter Zijlstra8e182572007-07-19 01:48:54 -07002998 return 1;
2999}
3000
3001static inline int mark_irqflags(struct task_struct *curr,
3002 struct held_lock *hlock)
3003{
3004 return 1;
3005}
3006
Boqun Fengc2469752016-02-16 13:57:40 +08003007static inline unsigned int task_irq_context(struct task_struct *task)
3008{
3009 return 0;
3010}
3011
Peter Zijlstra8e182572007-07-19 01:48:54 -07003012static inline int separate_irq_context(struct task_struct *curr,
3013 struct held_lock *hlock)
3014{
3015 return 0;
3016}
3017
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003018#endif /* defined(CONFIG_TRACE_IRQFLAGS) && defined(CONFIG_PROVE_LOCKING) */
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003019
3020/*
Peter Zijlstra8e182572007-07-19 01:48:54 -07003021 * Mark a lock with a usage bit, and validate the state transition:
3022 */
Steven Rostedt1d09daa2008-05-12 21:20:55 +02003023static int mark_lock(struct task_struct *curr, struct held_lock *this,
Steven Rostedt0764d232008-05-12 21:20:44 +02003024 enum lock_usage_bit new_bit)
Peter Zijlstra8e182572007-07-19 01:48:54 -07003025{
3026 unsigned int new_mask = 1 << new_bit, ret = 1;
3027
3028 /*
3029 * If already set then do not dirty the cacheline,
3030 * nor do any checks:
3031 */
Dave Jonesf82b2172008-08-11 09:30:23 +02003032 if (likely(hlock_class(this)->usage_mask & new_mask))
Peter Zijlstra8e182572007-07-19 01:48:54 -07003033 return 1;
3034
3035 if (!graph_lock())
3036 return 0;
3037 /*
Lucas De Marchi25985ed2011-03-30 22:57:33 -03003038 * Make sure we didn't race:
Peter Zijlstra8e182572007-07-19 01:48:54 -07003039 */
Dave Jonesf82b2172008-08-11 09:30:23 +02003040 if (unlikely(hlock_class(this)->usage_mask & new_mask)) {
Peter Zijlstra8e182572007-07-19 01:48:54 -07003041 graph_unlock();
3042 return 1;
3043 }
3044
Dave Jonesf82b2172008-08-11 09:30:23 +02003045 hlock_class(this)->usage_mask |= new_mask;
Peter Zijlstra8e182572007-07-19 01:48:54 -07003046
Dave Jonesf82b2172008-08-11 09:30:23 +02003047 if (!save_trace(hlock_class(this)->usage_traces + new_bit))
Peter Zijlstra8e182572007-07-19 01:48:54 -07003048 return 0;
3049
3050 switch (new_bit) {
Peter Zijlstra53464172009-01-22 14:15:53 +01003051#define LOCKDEP_STATE(__STATE) \
3052 case LOCK_USED_IN_##__STATE: \
3053 case LOCK_USED_IN_##__STATE##_READ: \
3054 case LOCK_ENABLED_##__STATE: \
3055 case LOCK_ENABLED_##__STATE##_READ:
3056#include "lockdep_states.h"
3057#undef LOCKDEP_STATE
Peter Zijlstra8e182572007-07-19 01:48:54 -07003058 ret = mark_lock_irq(curr, this, new_bit);
3059 if (!ret)
3060 return 0;
3061 break;
3062 case LOCK_USED:
Frederic Weisbeckerbd6d29c2010-04-06 00:10:17 +02003063 debug_atomic_dec(nr_unused_locks);
Peter Zijlstra8e182572007-07-19 01:48:54 -07003064 break;
3065 default:
3066 if (!debug_locks_off_graph_unlock())
3067 return 0;
3068 WARN_ON(1);
3069 return 0;
3070 }
3071
3072 graph_unlock();
3073
3074 /*
3075 * We must printk outside of the graph_lock:
3076 */
3077 if (ret == 2) {
3078 printk("\nmarked lock as {%s}:\n", usage_str[new_bit]);
3079 print_lock(this);
3080 print_irqtrace_events(curr);
3081 dump_stack();
3082 }
3083
3084 return ret;
3085}
3086
3087/*
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003088 * Initialize a lock instance's lock-class mapping info:
3089 */
Bart Van Assched35568b2018-12-06 17:11:33 -08003090void lockdep_init_map(struct lockdep_map *lock, const char *name,
Peter Zijlstra4dfbb9d2006-10-11 01:45:14 -04003091 struct lock_class_key *key, int subclass)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003092{
Yong Zhangd3d03d42011-11-09 16:04:51 +08003093 int i;
3094
Yong Zhangd3d03d42011-11-09 16:04:51 +08003095 for (i = 0; i < NR_LOCKDEP_CACHING_CLASSES; i++)
3096 lock->class_cache[i] = NULL;
Hitoshi Mitake62016252010-10-05 18:01:51 +09003097
Peter Zijlstrac8a25002009-04-17 09:40:49 +02003098#ifdef CONFIG_LOCK_STAT
3099 lock->cpu = raw_smp_processor_id();
3100#endif
3101
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003102 /*
3103 * Can't be having no nameless bastards around this place!
3104 */
Peter Zijlstrac8a25002009-04-17 09:40:49 +02003105 if (DEBUG_LOCKS_WARN_ON(!name)) {
3106 lock->name = "NULL";
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003107 return;
Peter Zijlstrac8a25002009-04-17 09:40:49 +02003108 }
3109
3110 lock->name = name;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003111
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003112 /*
3113 * No key, no joy, we need to hash something.
3114 */
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003115 if (DEBUG_LOCKS_WARN_ON(!key))
3116 return;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003117 /*
3118 * Sanity check, the lock-class key must be persistent:
3119 */
3120 if (!static_obj(key)) {
Borislav Petkov04860d42018-02-26 14:49:26 +01003121 printk("BUG: key %px not in .data!\n", key);
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003122 /*
3123 * What it says above ^^^^^, I suggest you read it.
3124 */
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003125 DEBUG_LOCKS_WARN_ON(1);
3126 return;
3127 }
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003128 lock->key = key;
Peter Zijlstrac8a25002009-04-17 09:40:49 +02003129
3130 if (unlikely(!debug_locks))
3131 return;
3132
Peter Zijlstra35a93932015-02-26 16:23:11 +01003133 if (subclass) {
3134 unsigned long flags;
3135
3136 if (DEBUG_LOCKS_WARN_ON(current->lockdep_recursion))
3137 return;
3138
3139 raw_local_irq_save(flags);
3140 current->lockdep_recursion = 1;
Peter Zijlstra4dfbb9d2006-10-11 01:45:14 -04003141 register_lock_class(lock, subclass, 1);
Peter Zijlstra35a93932015-02-26 16:23:11 +01003142 current->lockdep_recursion = 0;
3143 raw_local_irq_restore(flags);
3144 }
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003145}
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003146EXPORT_SYMBOL_GPL(lockdep_init_map);
3147
Peter Zijlstra1704f472010-03-19 01:37:42 +01003148struct lock_class_key __lockdep_no_validate__;
Kent Overstreetea6749c2012-12-27 22:21:58 -08003149EXPORT_SYMBOL_GPL(__lockdep_no_validate__);
Peter Zijlstra1704f472010-03-19 01:37:42 +01003150
Maarten Lankhorstd0945952012-09-13 11:39:51 +02003151static int
3152print_lock_nested_lock_not_held(struct task_struct *curr,
3153 struct held_lock *hlock,
3154 unsigned long ip)
3155{
3156 if (!debug_locks_off())
3157 return 0;
3158 if (debug_locks_silent)
3159 return 0;
3160
Paul E. McKenney681fbec2017-05-04 15:44:38 -07003161 pr_warn("\n");
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08003162 pr_warn("==================================\n");
3163 pr_warn("WARNING: Nested lock was not taken\n");
Maarten Lankhorstd0945952012-09-13 11:39:51 +02003164 print_kernel_ident();
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08003165 pr_warn("----------------------------------\n");
Maarten Lankhorstd0945952012-09-13 11:39:51 +02003166
Paul E. McKenney681fbec2017-05-04 15:44:38 -07003167 pr_warn("%s/%d is trying to lock:\n", curr->comm, task_pid_nr(curr));
Maarten Lankhorstd0945952012-09-13 11:39:51 +02003168 print_lock(hlock);
3169
Paul E. McKenney681fbec2017-05-04 15:44:38 -07003170 pr_warn("\nbut this task is not holding:\n");
3171 pr_warn("%s\n", hlock->nest_lock->name);
Maarten Lankhorstd0945952012-09-13 11:39:51 +02003172
Paul E. McKenney681fbec2017-05-04 15:44:38 -07003173 pr_warn("\nstack backtrace:\n");
Maarten Lankhorstd0945952012-09-13 11:39:51 +02003174 dump_stack();
3175
Paul E. McKenney681fbec2017-05-04 15:44:38 -07003176 pr_warn("\nother info that might help us debug this:\n");
Maarten Lankhorstd0945952012-09-13 11:39:51 +02003177 lockdep_print_held_locks(curr);
3178
Paul E. McKenney681fbec2017-05-04 15:44:38 -07003179 pr_warn("\nstack backtrace:\n");
Maarten Lankhorstd0945952012-09-13 11:39:51 +02003180 dump_stack();
3181
3182 return 0;
3183}
3184
Matthew Wilcox08f36ff2018-01-17 07:14:13 -08003185static int __lock_is_held(const struct lockdep_map *lock, int read);
Maarten Lankhorstd0945952012-09-13 11:39:51 +02003186
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003187/*
3188 * This gets called for every mutex_lock*()/spin_lock*() operation.
3189 * We maintain the dependency maps and validate the locking attempt:
Waiman Long8ee10862018-10-02 16:19:17 -04003190 *
3191 * The callers must make sure that IRQs are disabled before calling it,
3192 * otherwise we could get an interrupt which would want to take locks,
3193 * which would end up in lockdep again.
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003194 */
3195static int __lock_acquire(struct lockdep_map *lock, unsigned int subclass,
3196 int trylock, int read, int check, int hardirqs_off,
Peter Zijlstrabb97a912009-07-20 19:15:35 +02003197 struct lockdep_map *nest_lock, unsigned long ip,
Peter Zijlstra21199f22015-09-16 16:10:40 +02003198 int references, int pin_count)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003199{
3200 struct task_struct *curr = current;
Ingo Molnard6d897c2006-07-10 04:44:04 -07003201 struct lock_class *class = NULL;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003202 struct held_lock *hlock;
Alfredo Alvarez Fernandez5f18ab52016-02-11 00:33:32 +01003203 unsigned int depth;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003204 int chain_head = 0;
Peter Zijlstrabb97a912009-07-20 19:15:35 +02003205 int class_idx;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003206 u64 chain_key;
3207
3208 if (unlikely(!debug_locks))
3209 return 0;
3210
Oleg Nesterovfb9edbe2014-01-20 19:20:06 +01003211 if (!prove_locking || lock->key == &__lockdep_no_validate__)
3212 check = 0;
Peter Zijlstra1704f472010-03-19 01:37:42 +01003213
Hitoshi Mitake62016252010-10-05 18:01:51 +09003214 if (subclass < NR_LOCKDEP_CACHING_CLASSES)
3215 class = lock->class_cache[subclass];
Ingo Molnard6d897c2006-07-10 04:44:04 -07003216 /*
Hitoshi Mitake62016252010-10-05 18:01:51 +09003217 * Not cached?
Ingo Molnard6d897c2006-07-10 04:44:04 -07003218 */
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003219 if (unlikely(!class)) {
Peter Zijlstra4dfbb9d2006-10-11 01:45:14 -04003220 class = register_lock_class(lock, subclass, 0);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003221 if (!class)
3222 return 0;
3223 }
Waiman Long8ca2b56c2018-10-03 13:07:18 -04003224
3225 debug_class_ops_inc(class);
3226
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003227 if (very_verbose(class)) {
Borislav Petkov04860d42018-02-26 14:49:26 +01003228 printk("\nacquire class [%px] %s", class->key, class->name);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003229 if (class->name_version > 1)
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01003230 printk(KERN_CONT "#%d", class->name_version);
3231 printk(KERN_CONT "\n");
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003232 dump_stack();
3233 }
3234
3235 /*
3236 * Add the lock to the list of currently held locks.
3237 * (we dont increase the depth just yet, up until the
3238 * dependency checks are done)
3239 */
3240 depth = curr->lockdep_depth;
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003241 /*
3242 * Ran out of static storage for our per-task lock stack again have we?
3243 */
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003244 if (DEBUG_LOCKS_WARN_ON(depth >= MAX_LOCK_DEPTH))
3245 return 0;
3246
Peter Zijlstrabb97a912009-07-20 19:15:35 +02003247 class_idx = class - lock_classes + 1;
3248
Ingo Molnare966eae2017-12-12 12:31:16 +01003249 if (depth) {
Peter Zijlstrabb97a912009-07-20 19:15:35 +02003250 hlock = curr->held_locks + depth - 1;
3251 if (hlock->class_idx == class_idx && nest_lock) {
Peter Zijlstra7fb4a2c2017-03-01 16:23:30 +01003252 if (hlock->references) {
3253 /*
3254 * Check: unsigned int references:12, overflow.
3255 */
3256 if (DEBUG_LOCKS_WARN_ON(hlock->references == (1 << 12)-1))
3257 return 0;
3258
Peter Zijlstrabb97a912009-07-20 19:15:35 +02003259 hlock->references++;
Peter Zijlstra7fb4a2c2017-03-01 16:23:30 +01003260 } else {
Peter Zijlstrabb97a912009-07-20 19:15:35 +02003261 hlock->references = 2;
Peter Zijlstra7fb4a2c2017-03-01 16:23:30 +01003262 }
Peter Zijlstrabb97a912009-07-20 19:15:35 +02003263
3264 return 1;
3265 }
3266 }
3267
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003268 hlock = curr->held_locks + depth;
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003269 /*
3270 * Plain impossible, we just registered it and checked it weren't no
3271 * NULL like.. I bet this mushroom I ate was good!
3272 */
Dave Jonesf82b2172008-08-11 09:30:23 +02003273 if (DEBUG_LOCKS_WARN_ON(!class))
3274 return 0;
Peter Zijlstrabb97a912009-07-20 19:15:35 +02003275 hlock->class_idx = class_idx;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003276 hlock->acquire_ip = ip;
3277 hlock->instance = lock;
Peter Zijlstra7531e2f2008-08-11 09:30:24 +02003278 hlock->nest_lock = nest_lock;
Boqun Fengc2469752016-02-16 13:57:40 +08003279 hlock->irq_context = task_irq_context(curr);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003280 hlock->trylock = trylock;
3281 hlock->read = read;
3282 hlock->check = check;
Dmitry Baryshkov6951b122008-08-18 04:26:37 +04003283 hlock->hardirqs_off = !!hardirqs_off;
Peter Zijlstrabb97a912009-07-20 19:15:35 +02003284 hlock->references = references;
Peter Zijlstraf20786f2007-07-19 01:48:56 -07003285#ifdef CONFIG_LOCK_STAT
3286 hlock->waittime_stamp = 0;
Peter Zijlstra3365e7792009-10-09 10:12:41 +02003287 hlock->holdtime_stamp = lockstat_clock();
Peter Zijlstraf20786f2007-07-19 01:48:56 -07003288#endif
Peter Zijlstra21199f22015-09-16 16:10:40 +02003289 hlock->pin_count = pin_count;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003290
Oleg Nesterovfb9edbe2014-01-20 19:20:06 +01003291 if (check && !mark_irqflags(curr, hlock))
Peter Zijlstra8e182572007-07-19 01:48:54 -07003292 return 0;
3293
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003294 /* mark it as used: */
Jarek Poplawski4ff773bb2007-05-08 00:31:00 -07003295 if (!mark_lock(curr, hlock, LOCK_USED))
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003296 return 0;
Peter Zijlstra8e182572007-07-19 01:48:54 -07003297
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003298 /*
Gautham R Shenoy17aacfb92007-10-28 20:47:01 +01003299 * Calculate the chain hash: it's the combined hash of all the
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003300 * lock keys along the dependency chain. We save the hash value
3301 * at every step so that we can get the current hash easily
3302 * after unlock. The chain hash is then used to cache dependency
3303 * results.
3304 *
3305 * The 'key ID' is what is the most compact key value to drive
3306 * the hash, not class->key.
3307 */
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003308 /*
3309 * Whoops, we did it again.. ran straight out of our static allocation.
3310 */
Alfredo Alvarez Fernandez5f18ab52016-02-11 00:33:32 +01003311 if (DEBUG_LOCKS_WARN_ON(class_idx > MAX_LOCKDEP_KEYS))
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003312 return 0;
3313
3314 chain_key = curr->curr_chain_key;
3315 if (!depth) {
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003316 /*
3317 * How can we have a chain hash when we ain't got no keys?!
3318 */
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003319 if (DEBUG_LOCKS_WARN_ON(chain_key != 0))
3320 return 0;
3321 chain_head = 1;
3322 }
3323
3324 hlock->prev_chain_key = chain_key;
Peter Zijlstra8e182572007-07-19 01:48:54 -07003325 if (separate_irq_context(curr, hlock)) {
3326 chain_key = 0;
3327 chain_head = 1;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003328 }
Alfredo Alvarez Fernandez5f18ab52016-02-11 00:33:32 +01003329 chain_key = iterate_chain_key(chain_key, class_idx);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003330
Peter Zijlstraf8319482016-11-30 14:32:25 +11003331 if (nest_lock && !__lock_is_held(nest_lock, -1))
Maarten Lankhorstd0945952012-09-13 11:39:51 +02003332 return print_lock_nested_lock_not_held(curr, hlock, ip);
3333
Gregory Haskins3aa416b2007-10-11 22:11:11 +02003334 if (!validate_chain(curr, lock, hlock, chain_head, chain_key))
Peter Zijlstra8e182572007-07-19 01:48:54 -07003335 return 0;
Jarek Poplawski381a2292007-02-10 01:44:58 -08003336
Gregory Haskins3aa416b2007-10-11 22:11:11 +02003337 curr->curr_chain_key = chain_key;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003338 curr->lockdep_depth++;
3339 check_chain_key(curr);
Jarek Poplawski60e114d2007-02-20 13:58:00 -08003340#ifdef CONFIG_DEBUG_LOCKDEP
3341 if (unlikely(!debug_locks))
3342 return 0;
3343#endif
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003344 if (unlikely(curr->lockdep_depth >= MAX_LOCK_DEPTH)) {
3345 debug_locks_off();
Dave Jones2c522832013-04-25 13:40:02 -04003346 print_lockdep_off("BUG: MAX_LOCK_DEPTH too low!");
3347 printk(KERN_DEBUG "depth: %i max: %lu!\n",
Ben Greearc0540602013-02-06 10:56:19 -08003348 curr->lockdep_depth, MAX_LOCK_DEPTH);
Ben Greearc0540602013-02-06 10:56:19 -08003349
3350 lockdep_print_held_locks(current);
3351 debug_show_all_locks();
Peter Zijlstraeedeeab2009-03-18 12:38:47 +01003352 dump_stack();
Ben Greearc0540602013-02-06 10:56:19 -08003353
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003354 return 0;
3355 }
Jarek Poplawski381a2292007-02-10 01:44:58 -08003356
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003357 if (unlikely(curr->lockdep_depth > max_lockdep_depth))
3358 max_lockdep_depth = curr->lockdep_depth;
3359
3360 return 1;
3361}
3362
3363static int
Srivatsa S. Bhatf86f7552013-01-08 18:35:58 +05303364print_unlock_imbalance_bug(struct task_struct *curr, struct lockdep_map *lock,
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003365 unsigned long ip)
3366{
3367 if (!debug_locks_off())
3368 return 0;
3369 if (debug_locks_silent)
3370 return 0;
3371
Paul E. McKenney681fbec2017-05-04 15:44:38 -07003372 pr_warn("\n");
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08003373 pr_warn("=====================================\n");
3374 pr_warn("WARNING: bad unlock balance detected!\n");
Ben Hutchingsfbdc4b92011-10-28 04:36:55 +01003375 print_kernel_ident();
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08003376 pr_warn("-------------------------------------\n");
Paul E. McKenney681fbec2017-05-04 15:44:38 -07003377 pr_warn("%s/%d is trying to release lock (",
Pavel Emelyanovba25f9d2007-10-18 23:40:40 -07003378 curr->comm, task_pid_nr(curr));
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003379 print_lockdep_cache(lock);
Paul E. McKenney681fbec2017-05-04 15:44:38 -07003380 pr_cont(") at:\n");
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003381 print_ip_sym(ip);
Paul E. McKenney681fbec2017-05-04 15:44:38 -07003382 pr_warn("but there are no more locks to release!\n");
3383 pr_warn("\nother info that might help us debug this:\n");
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003384 lockdep_print_held_locks(curr);
3385
Paul E. McKenney681fbec2017-05-04 15:44:38 -07003386 pr_warn("\nstack backtrace:\n");
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003387 dump_stack();
3388
3389 return 0;
3390}
3391
Matthew Wilcox08f36ff2018-01-17 07:14:13 -08003392static int match_held_lock(const struct held_lock *hlock,
3393 const struct lockdep_map *lock)
Peter Zijlstrabb97a912009-07-20 19:15:35 +02003394{
3395 if (hlock->instance == lock)
3396 return 1;
3397
3398 if (hlock->references) {
Matthew Wilcox08f36ff2018-01-17 07:14:13 -08003399 const struct lock_class *class = lock->class_cache[0];
Peter Zijlstrabb97a912009-07-20 19:15:35 +02003400
3401 if (!class)
3402 class = look_up_lock_class(lock, 0);
3403
Peter Zijlstra80e04012011-08-05 14:26:17 +02003404 /*
3405 * If look_up_lock_class() failed to find a class, we're trying
3406 * to test if we hold a lock that has never yet been acquired.
3407 * Clearly if the lock hasn't been acquired _ever_, we're not
3408 * holding it either, so report failure.
3409 */
Matthew Wilcox64f29d12018-01-17 07:14:12 -08003410 if (!class)
Peter Zijlstrabb97a912009-07-20 19:15:35 +02003411 return 0;
3412
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003413 /*
3414 * References, but not a lock we're actually ref-counting?
3415 * State got messed up, follow the sites that change ->references
3416 * and try to make sense of it.
3417 */
Peter Zijlstrabb97a912009-07-20 19:15:35 +02003418 if (DEBUG_LOCKS_WARN_ON(!hlock->nest_lock))
3419 return 0;
3420
3421 if (hlock->class_idx == class - lock_classes + 1)
3422 return 1;
3423 }
3424
3425 return 0;
3426}
3427
J. R. Okajima41c2c5b2017-02-03 01:38:15 +09003428/* @depth must not be zero */
3429static struct held_lock *find_held_lock(struct task_struct *curr,
3430 struct lockdep_map *lock,
3431 unsigned int depth, int *idx)
3432{
3433 struct held_lock *ret, *hlock, *prev_hlock;
3434 int i;
3435
3436 i = depth - 1;
3437 hlock = curr->held_locks + i;
3438 ret = hlock;
3439 if (match_held_lock(hlock, lock))
3440 goto out;
3441
3442 ret = NULL;
3443 for (i--, prev_hlock = hlock--;
3444 i >= 0;
3445 i--, prev_hlock = hlock--) {
3446 /*
3447 * We must not cross into another context:
3448 */
3449 if (prev_hlock->irq_context != hlock->irq_context) {
3450 ret = NULL;
3451 break;
3452 }
3453 if (match_held_lock(hlock, lock)) {
3454 ret = hlock;
3455 break;
3456 }
3457 }
3458
3459out:
3460 *idx = i;
3461 return ret;
3462}
3463
J. R. Okajimae9699702017-02-03 01:38:16 +09003464static int reacquire_held_locks(struct task_struct *curr, unsigned int depth,
3465 int idx)
3466{
3467 struct held_lock *hlock;
3468
Waiman Long8ee10862018-10-02 16:19:17 -04003469 if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
3470 return 0;
3471
J. R. Okajimae9699702017-02-03 01:38:16 +09003472 for (hlock = curr->held_locks + idx; idx < depth; idx++, hlock++) {
3473 if (!__lock_acquire(hlock->instance,
3474 hlock_class(hlock)->subclass,
3475 hlock->trylock,
3476 hlock->read, hlock->check,
3477 hlock->hardirqs_off,
3478 hlock->nest_lock, hlock->acquire_ip,
3479 hlock->references, hlock->pin_count))
3480 return 1;
3481 }
3482 return 0;
3483}
3484
Peter Zijlstra64aa3482008-08-11 09:30:21 +02003485static int
Peter Zijlstra00ef9f72008-12-04 09:00:17 +01003486__lock_set_class(struct lockdep_map *lock, const char *name,
3487 struct lock_class_key *key, unsigned int subclass,
3488 unsigned long ip)
Peter Zijlstra64aa3482008-08-11 09:30:21 +02003489{
3490 struct task_struct *curr = current;
J. R. Okajima41c2c5b2017-02-03 01:38:15 +09003491 struct held_lock *hlock;
Peter Zijlstra64aa3482008-08-11 09:30:21 +02003492 struct lock_class *class;
3493 unsigned int depth;
3494 int i;
3495
Waiman Long513e1072019-01-09 23:03:25 -05003496 if (unlikely(!debug_locks))
3497 return 0;
3498
Peter Zijlstra64aa3482008-08-11 09:30:21 +02003499 depth = curr->lockdep_depth;
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003500 /*
3501 * This function is about (re)setting the class of a held lock,
3502 * yet we're not actually holding any locks. Naughty user!
3503 */
Peter Zijlstra64aa3482008-08-11 09:30:21 +02003504 if (DEBUG_LOCKS_WARN_ON(!depth))
3505 return 0;
3506
J. R. Okajima41c2c5b2017-02-03 01:38:15 +09003507 hlock = find_held_lock(curr, lock, depth, &i);
3508 if (!hlock)
3509 return print_unlock_imbalance_bug(curr, lock, ip);
Peter Zijlstra64aa3482008-08-11 09:30:21 +02003510
Peter Zijlstra00ef9f72008-12-04 09:00:17 +01003511 lockdep_init_map(lock, name, key, 0);
Peter Zijlstra64aa3482008-08-11 09:30:21 +02003512 class = register_lock_class(lock, subclass, 0);
Dave Jonesf82b2172008-08-11 09:30:23 +02003513 hlock->class_idx = class - lock_classes + 1;
Peter Zijlstra64aa3482008-08-11 09:30:21 +02003514
3515 curr->lockdep_depth = i;
3516 curr->curr_chain_key = hlock->prev_chain_key;
3517
J. R. Okajimae9699702017-02-03 01:38:16 +09003518 if (reacquire_held_locks(curr, depth, i))
3519 return 0;
Peter Zijlstra64aa3482008-08-11 09:30:21 +02003520
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003521 /*
3522 * I took it apart and put it back together again, except now I have
3523 * these 'spare' parts.. where shall I put them.
3524 */
Peter Zijlstra64aa3482008-08-11 09:30:21 +02003525 if (DEBUG_LOCKS_WARN_ON(curr->lockdep_depth != depth))
3526 return 0;
3527 return 1;
3528}
3529
J. R. Okajima6419c4a2017-02-03 01:38:17 +09003530static int __lock_downgrade(struct lockdep_map *lock, unsigned long ip)
3531{
3532 struct task_struct *curr = current;
3533 struct held_lock *hlock;
3534 unsigned int depth;
3535 int i;
3536
Waiman Long71492582019-01-09 23:03:25 -05003537 if (unlikely(!debug_locks))
3538 return 0;
3539
J. R. Okajima6419c4a2017-02-03 01:38:17 +09003540 depth = curr->lockdep_depth;
3541 /*
3542 * This function is about (re)setting the class of a held lock,
3543 * yet we're not actually holding any locks. Naughty user!
3544 */
3545 if (DEBUG_LOCKS_WARN_ON(!depth))
3546 return 0;
3547
3548 hlock = find_held_lock(curr, lock, depth, &i);
3549 if (!hlock)
3550 return print_unlock_imbalance_bug(curr, lock, ip);
3551
3552 curr->lockdep_depth = i;
3553 curr->curr_chain_key = hlock->prev_chain_key;
3554
3555 WARN(hlock->read, "downgrading a read lock");
3556 hlock->read = 1;
3557 hlock->acquire_ip = ip;
3558
3559 if (reacquire_held_locks(curr, depth, i))
3560 return 0;
3561
3562 /*
3563 * I took it apart and put it back together again, except now I have
3564 * these 'spare' parts.. where shall I put them.
3565 */
3566 if (DEBUG_LOCKS_WARN_ON(curr->lockdep_depth != depth))
3567 return 0;
3568 return 1;
3569}
3570
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003571/*
Peter Zijlstrae0f56fd2015-06-11 14:46:52 +02003572 * Remove the lock to the list of currently held locks - this gets
3573 * called on mutex_unlock()/spin_unlock*() (or on a failed
3574 * mutex_lock_interruptible()).
3575 *
3576 * @nested is an hysterical artifact, needs a tree wide cleanup.
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003577 */
3578static int
Peter Zijlstrae0f56fd2015-06-11 14:46:52 +02003579__lock_release(struct lockdep_map *lock, int nested, unsigned long ip)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003580{
Peter Zijlstrae0f56fd2015-06-11 14:46:52 +02003581 struct task_struct *curr = current;
J. R. Okajima41c2c5b2017-02-03 01:38:15 +09003582 struct held_lock *hlock;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003583 unsigned int depth;
Ingo Molnare966eae2017-12-12 12:31:16 +01003584 int i;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003585
Peter Zijlstrae0f56fd2015-06-11 14:46:52 +02003586 if (unlikely(!debug_locks))
3587 return 0;
3588
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003589 depth = curr->lockdep_depth;
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003590 /*
3591 * So we're all set to release this lock.. wait what lock? We don't
3592 * own any locks, you've been drinking again?
3593 */
Peter Zijlstrae0f56fd2015-06-11 14:46:52 +02003594 if (DEBUG_LOCKS_WARN_ON(depth <= 0))
3595 return print_unlock_imbalance_bug(curr, lock, ip);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003596
Peter Zijlstrae0f56fd2015-06-11 14:46:52 +02003597 /*
3598 * Check whether the lock exists in the current stack
3599 * of held locks:
3600 */
J. R. Okajima41c2c5b2017-02-03 01:38:15 +09003601 hlock = find_held_lock(curr, lock, depth, &i);
3602 if (!hlock)
3603 return print_unlock_imbalance_bug(curr, lock, ip);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003604
Peter Zijlstrabb97a912009-07-20 19:15:35 +02003605 if (hlock->instance == lock)
3606 lock_release_holdtime(hlock);
3607
Peter Zijlstraa24fc602015-06-11 14:46:53 +02003608 WARN(hlock->pin_count, "releasing a pinned lock\n");
3609
Peter Zijlstrabb97a912009-07-20 19:15:35 +02003610 if (hlock->references) {
3611 hlock->references--;
3612 if (hlock->references) {
3613 /*
3614 * We had, and after removing one, still have
3615 * references, the current lock stack is still
3616 * valid. We're done!
3617 */
3618 return 1;
3619 }
3620 }
Peter Zijlstraf20786f2007-07-19 01:48:56 -07003621
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003622 /*
3623 * We have the right lock to unlock, 'hlock' points to it.
3624 * Now we remove it from the stack, and add back the other
3625 * entries (if any), recalculating the hash along the way:
3626 */
Peter Zijlstrabb97a912009-07-20 19:15:35 +02003627
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003628 curr->lockdep_depth = i;
3629 curr->curr_chain_key = hlock->prev_chain_key;
3630
Waiman Longce52a182018-10-02 16:19:18 -04003631 /*
3632 * The most likely case is when the unlock is on the innermost
3633 * lock. In this case, we are done!
3634 */
3635 if (i == depth-1)
3636 return 1;
3637
J. R. Okajimae9699702017-02-03 01:38:16 +09003638 if (reacquire_held_locks(curr, depth, i + 1))
3639 return 0;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003640
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003641 /*
3642 * We had N bottles of beer on the wall, we drank one, but now
3643 * there's not N-1 bottles of beer left on the wall...
3644 */
Waiman Longce52a182018-10-02 16:19:18 -04003645 DEBUG_LOCKS_WARN_ON(curr->lockdep_depth != depth-1);
Peter Zijlstrae0f56fd2015-06-11 14:46:52 +02003646
Waiman Longce52a182018-10-02 16:19:18 -04003647 /*
3648 * Since reacquire_held_locks() would have called check_chain_key()
3649 * indirectly via __lock_acquire(), we don't need to do it again
3650 * on return.
3651 */
3652 return 0;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003653}
3654
Matthew Wilcox08f36ff2018-01-17 07:14:13 -08003655static int __lock_is_held(const struct lockdep_map *lock, int read)
Peter Zijlstraf607c662009-07-20 19:16:29 +02003656{
3657 struct task_struct *curr = current;
3658 int i;
3659
3660 for (i = 0; i < curr->lockdep_depth; i++) {
Peter Zijlstrabb97a912009-07-20 19:15:35 +02003661 struct held_lock *hlock = curr->held_locks + i;
3662
Peter Zijlstraf8319482016-11-30 14:32:25 +11003663 if (match_held_lock(hlock, lock)) {
3664 if (read == -1 || hlock->read == read)
3665 return 1;
3666
3667 return 0;
3668 }
Peter Zijlstraf607c662009-07-20 19:16:29 +02003669 }
3670
3671 return 0;
3672}
3673
Peter Zijlstrae7904a22015-08-01 19:25:08 +02003674static struct pin_cookie __lock_pin_lock(struct lockdep_map *lock)
3675{
3676 struct pin_cookie cookie = NIL_COOKIE;
3677 struct task_struct *curr = current;
3678 int i;
3679
3680 if (unlikely(!debug_locks))
3681 return cookie;
3682
3683 for (i = 0; i < curr->lockdep_depth; i++) {
3684 struct held_lock *hlock = curr->held_locks + i;
3685
3686 if (match_held_lock(hlock, lock)) {
3687 /*
3688 * Grab 16bits of randomness; this is sufficient to not
3689 * be guessable and still allows some pin nesting in
3690 * our u32 pin_count.
3691 */
3692 cookie.val = 1 + (prandom_u32() >> 16);
3693 hlock->pin_count += cookie.val;
3694 return cookie;
3695 }
3696 }
3697
3698 WARN(1, "pinning an unheld lock\n");
3699 return cookie;
3700}
3701
3702static void __lock_repin_lock(struct lockdep_map *lock, struct pin_cookie cookie)
Peter Zijlstraa24fc602015-06-11 14:46:53 +02003703{
3704 struct task_struct *curr = current;
3705 int i;
3706
3707 if (unlikely(!debug_locks))
3708 return;
3709
3710 for (i = 0; i < curr->lockdep_depth; i++) {
3711 struct held_lock *hlock = curr->held_locks + i;
3712
3713 if (match_held_lock(hlock, lock)) {
Peter Zijlstrae7904a22015-08-01 19:25:08 +02003714 hlock->pin_count += cookie.val;
Peter Zijlstraa24fc602015-06-11 14:46:53 +02003715 return;
3716 }
3717 }
3718
3719 WARN(1, "pinning an unheld lock\n");
3720}
3721
Peter Zijlstrae7904a22015-08-01 19:25:08 +02003722static void __lock_unpin_lock(struct lockdep_map *lock, struct pin_cookie cookie)
Peter Zijlstraa24fc602015-06-11 14:46:53 +02003723{
3724 struct task_struct *curr = current;
3725 int i;
3726
3727 if (unlikely(!debug_locks))
3728 return;
3729
3730 for (i = 0; i < curr->lockdep_depth; i++) {
3731 struct held_lock *hlock = curr->held_locks + i;
3732
3733 if (match_held_lock(hlock, lock)) {
3734 if (WARN(!hlock->pin_count, "unpinning an unpinned lock\n"))
3735 return;
3736
Peter Zijlstrae7904a22015-08-01 19:25:08 +02003737 hlock->pin_count -= cookie.val;
3738
3739 if (WARN((int)hlock->pin_count < 0, "pin count corrupted\n"))
3740 hlock->pin_count = 0;
3741
Peter Zijlstraa24fc602015-06-11 14:46:53 +02003742 return;
3743 }
3744 }
3745
3746 WARN(1, "unpinning an unheld lock\n");
3747}
3748
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003749/*
3750 * Check whether we follow the irq-flags state precisely:
3751 */
Steven Rostedt1d09daa2008-05-12 21:20:55 +02003752static void check_flags(unsigned long flags)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003753{
Ingo Molnar992860e2008-07-14 10:28:38 +02003754#if defined(CONFIG_PROVE_LOCKING) && defined(CONFIG_DEBUG_LOCKDEP) && \
3755 defined(CONFIG_TRACE_IRQFLAGS)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003756 if (!debug_locks)
3757 return;
3758
Ingo Molnar5f9fa8a2007-12-07 19:02:47 +01003759 if (irqs_disabled_flags(flags)) {
3760 if (DEBUG_LOCKS_WARN_ON(current->hardirqs_enabled)) {
3761 printk("possible reason: unannotated irqs-off.\n");
3762 }
3763 } else {
3764 if (DEBUG_LOCKS_WARN_ON(!current->hardirqs_enabled)) {
3765 printk("possible reason: unannotated irqs-on.\n");
3766 }
3767 }
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003768
3769 /*
3770 * We dont accurately track softirq state in e.g.
3771 * hardirq contexts (such as on 4KSTACKS), so only
3772 * check if not in hardirq contexts:
3773 */
3774 if (!hardirq_count()) {
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003775 if (softirq_count()) {
3776 /* like the above, but with softirqs */
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003777 DEBUG_LOCKS_WARN_ON(current->softirqs_enabled);
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003778 } else {
3779 /* lick the above, does it taste good? */
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003780 DEBUG_LOCKS_WARN_ON(!current->softirqs_enabled);
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003781 }
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003782 }
3783
3784 if (!debug_locks)
3785 print_irqtrace_events(current);
3786#endif
3787}
3788
Peter Zijlstra00ef9f72008-12-04 09:00:17 +01003789void lock_set_class(struct lockdep_map *lock, const char *name,
3790 struct lock_class_key *key, unsigned int subclass,
3791 unsigned long ip)
Peter Zijlstra64aa3482008-08-11 09:30:21 +02003792{
3793 unsigned long flags;
3794
3795 if (unlikely(current->lockdep_recursion))
3796 return;
3797
3798 raw_local_irq_save(flags);
3799 current->lockdep_recursion = 1;
3800 check_flags(flags);
Peter Zijlstra00ef9f72008-12-04 09:00:17 +01003801 if (__lock_set_class(lock, name, key, subclass, ip))
Peter Zijlstra64aa3482008-08-11 09:30:21 +02003802 check_chain_key(current);
3803 current->lockdep_recursion = 0;
3804 raw_local_irq_restore(flags);
3805}
Peter Zijlstra00ef9f72008-12-04 09:00:17 +01003806EXPORT_SYMBOL_GPL(lock_set_class);
Peter Zijlstra64aa3482008-08-11 09:30:21 +02003807
J. R. Okajima6419c4a2017-02-03 01:38:17 +09003808void lock_downgrade(struct lockdep_map *lock, unsigned long ip)
3809{
3810 unsigned long flags;
3811
3812 if (unlikely(current->lockdep_recursion))
3813 return;
3814
3815 raw_local_irq_save(flags);
3816 current->lockdep_recursion = 1;
3817 check_flags(flags);
3818 if (__lock_downgrade(lock, ip))
3819 check_chain_key(current);
3820 current->lockdep_recursion = 0;
3821 raw_local_irq_restore(flags);
3822}
3823EXPORT_SYMBOL_GPL(lock_downgrade);
3824
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003825/*
3826 * We are not always called with irqs disabled - do that here,
3827 * and also avoid lockdep recursion:
3828 */
Steven Rostedt1d09daa2008-05-12 21:20:55 +02003829void lock_acquire(struct lockdep_map *lock, unsigned int subclass,
Peter Zijlstra7531e2f2008-08-11 09:30:24 +02003830 int trylock, int read, int check,
3831 struct lockdep_map *nest_lock, unsigned long ip)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003832{
3833 unsigned long flags;
3834
3835 if (unlikely(current->lockdep_recursion))
3836 return;
3837
3838 raw_local_irq_save(flags);
3839 check_flags(flags);
3840
3841 current->lockdep_recursion = 1;
Frederic Weisbeckerdb2c4c72010-02-02 23:34:40 +01003842 trace_lock_acquire(lock, subclass, trylock, read, check, nest_lock, ip);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003843 __lock_acquire(lock, subclass, trylock, read, check,
Peter Zijlstra21199f22015-09-16 16:10:40 +02003844 irqs_disabled_flags(flags), nest_lock, ip, 0, 0);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003845 current->lockdep_recursion = 0;
3846 raw_local_irq_restore(flags);
3847}
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003848EXPORT_SYMBOL_GPL(lock_acquire);
3849
Steven Rostedt1d09daa2008-05-12 21:20:55 +02003850void lock_release(struct lockdep_map *lock, int nested,
Steven Rostedt0764d232008-05-12 21:20:44 +02003851 unsigned long ip)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003852{
3853 unsigned long flags;
3854
3855 if (unlikely(current->lockdep_recursion))
3856 return;
3857
3858 raw_local_irq_save(flags);
3859 check_flags(flags);
3860 current->lockdep_recursion = 1;
Frederic Weisbecker93135432010-05-08 06:24:25 +02003861 trace_lock_release(lock, ip);
Peter Zijlstrae0f56fd2015-06-11 14:46:52 +02003862 if (__lock_release(lock, nested, ip))
3863 check_chain_key(current);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003864 current->lockdep_recursion = 0;
3865 raw_local_irq_restore(flags);
3866}
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003867EXPORT_SYMBOL_GPL(lock_release);
3868
Matthew Wilcox08f36ff2018-01-17 07:14:13 -08003869int lock_is_held_type(const struct lockdep_map *lock, int read)
Peter Zijlstraf607c662009-07-20 19:16:29 +02003870{
3871 unsigned long flags;
3872 int ret = 0;
3873
3874 if (unlikely(current->lockdep_recursion))
Peter Zijlstraf2513cd2011-06-06 12:32:43 +02003875 return 1; /* avoid false negative lockdep_assert_held() */
Peter Zijlstraf607c662009-07-20 19:16:29 +02003876
3877 raw_local_irq_save(flags);
3878 check_flags(flags);
3879
3880 current->lockdep_recursion = 1;
Peter Zijlstraf8319482016-11-30 14:32:25 +11003881 ret = __lock_is_held(lock, read);
Peter Zijlstraf607c662009-07-20 19:16:29 +02003882 current->lockdep_recursion = 0;
3883 raw_local_irq_restore(flags);
3884
3885 return ret;
3886}
Peter Zijlstraf8319482016-11-30 14:32:25 +11003887EXPORT_SYMBOL_GPL(lock_is_held_type);
Peter Zijlstraf607c662009-07-20 19:16:29 +02003888
Peter Zijlstrae7904a22015-08-01 19:25:08 +02003889struct pin_cookie lock_pin_lock(struct lockdep_map *lock)
Peter Zijlstraa24fc602015-06-11 14:46:53 +02003890{
Peter Zijlstrae7904a22015-08-01 19:25:08 +02003891 struct pin_cookie cookie = NIL_COOKIE;
Peter Zijlstraa24fc602015-06-11 14:46:53 +02003892 unsigned long flags;
3893
3894 if (unlikely(current->lockdep_recursion))
Peter Zijlstrae7904a22015-08-01 19:25:08 +02003895 return cookie;
Peter Zijlstraa24fc602015-06-11 14:46:53 +02003896
3897 raw_local_irq_save(flags);
3898 check_flags(flags);
3899
3900 current->lockdep_recursion = 1;
Peter Zijlstrae7904a22015-08-01 19:25:08 +02003901 cookie = __lock_pin_lock(lock);
Peter Zijlstraa24fc602015-06-11 14:46:53 +02003902 current->lockdep_recursion = 0;
3903 raw_local_irq_restore(flags);
Peter Zijlstrae7904a22015-08-01 19:25:08 +02003904
3905 return cookie;
Peter Zijlstraa24fc602015-06-11 14:46:53 +02003906}
3907EXPORT_SYMBOL_GPL(lock_pin_lock);
3908
Peter Zijlstrae7904a22015-08-01 19:25:08 +02003909void lock_repin_lock(struct lockdep_map *lock, struct pin_cookie cookie)
Peter Zijlstraa24fc602015-06-11 14:46:53 +02003910{
3911 unsigned long flags;
3912
3913 if (unlikely(current->lockdep_recursion))
3914 return;
3915
3916 raw_local_irq_save(flags);
3917 check_flags(flags);
3918
3919 current->lockdep_recursion = 1;
Peter Zijlstrae7904a22015-08-01 19:25:08 +02003920 __lock_repin_lock(lock, cookie);
3921 current->lockdep_recursion = 0;
3922 raw_local_irq_restore(flags);
3923}
3924EXPORT_SYMBOL_GPL(lock_repin_lock);
3925
3926void lock_unpin_lock(struct lockdep_map *lock, struct pin_cookie cookie)
3927{
3928 unsigned long flags;
3929
3930 if (unlikely(current->lockdep_recursion))
3931 return;
3932
3933 raw_local_irq_save(flags);
3934 check_flags(flags);
3935
3936 current->lockdep_recursion = 1;
3937 __lock_unpin_lock(lock, cookie);
Peter Zijlstraa24fc602015-06-11 14:46:53 +02003938 current->lockdep_recursion = 0;
3939 raw_local_irq_restore(flags);
3940}
3941EXPORT_SYMBOL_GPL(lock_unpin_lock);
3942
Peter Zijlstraf20786f2007-07-19 01:48:56 -07003943#ifdef CONFIG_LOCK_STAT
3944static int
3945print_lock_contention_bug(struct task_struct *curr, struct lockdep_map *lock,
3946 unsigned long ip)
3947{
3948 if (!debug_locks_off())
3949 return 0;
3950 if (debug_locks_silent)
3951 return 0;
3952
Paul E. McKenney681fbec2017-05-04 15:44:38 -07003953 pr_warn("\n");
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08003954 pr_warn("=================================\n");
3955 pr_warn("WARNING: bad contention detected!\n");
Ben Hutchingsfbdc4b92011-10-28 04:36:55 +01003956 print_kernel_ident();
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08003957 pr_warn("---------------------------------\n");
Paul E. McKenney681fbec2017-05-04 15:44:38 -07003958 pr_warn("%s/%d is trying to contend lock (",
Pavel Emelyanovba25f9d2007-10-18 23:40:40 -07003959 curr->comm, task_pid_nr(curr));
Peter Zijlstraf20786f2007-07-19 01:48:56 -07003960 print_lockdep_cache(lock);
Paul E. McKenney681fbec2017-05-04 15:44:38 -07003961 pr_cont(") at:\n");
Peter Zijlstraf20786f2007-07-19 01:48:56 -07003962 print_ip_sym(ip);
Paul E. McKenney681fbec2017-05-04 15:44:38 -07003963 pr_warn("but there are no locks held!\n");
3964 pr_warn("\nother info that might help us debug this:\n");
Peter Zijlstraf20786f2007-07-19 01:48:56 -07003965 lockdep_print_held_locks(curr);
3966
Paul E. McKenney681fbec2017-05-04 15:44:38 -07003967 pr_warn("\nstack backtrace:\n");
Peter Zijlstraf20786f2007-07-19 01:48:56 -07003968 dump_stack();
3969
3970 return 0;
3971}
3972
3973static void
3974__lock_contended(struct lockdep_map *lock, unsigned long ip)
3975{
3976 struct task_struct *curr = current;
J. R. Okajima41c2c5b2017-02-03 01:38:15 +09003977 struct held_lock *hlock;
Peter Zijlstraf20786f2007-07-19 01:48:56 -07003978 struct lock_class_stats *stats;
3979 unsigned int depth;
Peter Zijlstrac7e78cf2008-10-16 23:17:09 +02003980 int i, contention_point, contending_point;
Peter Zijlstraf20786f2007-07-19 01:48:56 -07003981
3982 depth = curr->lockdep_depth;
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003983 /*
3984 * Whee, we contended on this lock, except it seems we're not
3985 * actually trying to acquire anything much at all..
3986 */
Peter Zijlstraf20786f2007-07-19 01:48:56 -07003987 if (DEBUG_LOCKS_WARN_ON(!depth))
3988 return;
3989
J. R. Okajima41c2c5b2017-02-03 01:38:15 +09003990 hlock = find_held_lock(curr, lock, depth, &i);
3991 if (!hlock) {
3992 print_lock_contention_bug(curr, lock, ip);
3993 return;
Peter Zijlstraf20786f2007-07-19 01:48:56 -07003994 }
Peter Zijlstraf20786f2007-07-19 01:48:56 -07003995
Peter Zijlstrabb97a912009-07-20 19:15:35 +02003996 if (hlock->instance != lock)
3997 return;
3998
Peter Zijlstra3365e7792009-10-09 10:12:41 +02003999 hlock->waittime_stamp = lockstat_clock();
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004000
Peter Zijlstrac7e78cf2008-10-16 23:17:09 +02004001 contention_point = lock_point(hlock_class(hlock)->contention_point, ip);
4002 contending_point = lock_point(hlock_class(hlock)->contending_point,
4003 lock->ip);
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004004
Dave Jonesf82b2172008-08-11 09:30:23 +02004005 stats = get_lock_stats(hlock_class(hlock));
Peter Zijlstrac7e78cf2008-10-16 23:17:09 +02004006 if (contention_point < LOCKSTAT_POINTS)
4007 stats->contention_point[contention_point]++;
4008 if (contending_point < LOCKSTAT_POINTS)
4009 stats->contending_point[contending_point]++;
Peter Zijlstra96645672007-07-19 01:49:00 -07004010 if (lock->cpu != smp_processor_id())
4011 stats->bounces[bounce_contended + !!hlock->read]++;
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004012}
4013
4014static void
Peter Zijlstrac7e78cf2008-10-16 23:17:09 +02004015__lock_acquired(struct lockdep_map *lock, unsigned long ip)
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004016{
4017 struct task_struct *curr = current;
J. R. Okajima41c2c5b2017-02-03 01:38:15 +09004018 struct held_lock *hlock;
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004019 struct lock_class_stats *stats;
4020 unsigned int depth;
Peter Zijlstra3365e7792009-10-09 10:12:41 +02004021 u64 now, waittime = 0;
Peter Zijlstra96645672007-07-19 01:49:00 -07004022 int i, cpu;
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004023
4024 depth = curr->lockdep_depth;
Peter Zijlstra0119fee2011-09-02 01:30:29 +02004025 /*
4026 * Yay, we acquired ownership of this lock we didn't try to
4027 * acquire, how the heck did that happen?
4028 */
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004029 if (DEBUG_LOCKS_WARN_ON(!depth))
4030 return;
4031
J. R. Okajima41c2c5b2017-02-03 01:38:15 +09004032 hlock = find_held_lock(curr, lock, depth, &i);
4033 if (!hlock) {
4034 print_lock_contention_bug(curr, lock, _RET_IP_);
4035 return;
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004036 }
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004037
Peter Zijlstrabb97a912009-07-20 19:15:35 +02004038 if (hlock->instance != lock)
4039 return;
4040
Peter Zijlstra96645672007-07-19 01:49:00 -07004041 cpu = smp_processor_id();
4042 if (hlock->waittime_stamp) {
Peter Zijlstra3365e7792009-10-09 10:12:41 +02004043 now = lockstat_clock();
Peter Zijlstra96645672007-07-19 01:49:00 -07004044 waittime = now - hlock->waittime_stamp;
4045 hlock->holdtime_stamp = now;
4046 }
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004047
Frederic Weisbecker883a2a32010-05-08 06:16:11 +02004048 trace_lock_acquired(lock, ip);
Frederic Weisbecker20625012009-04-06 01:49:33 +02004049
Dave Jonesf82b2172008-08-11 09:30:23 +02004050 stats = get_lock_stats(hlock_class(hlock));
Peter Zijlstra96645672007-07-19 01:49:00 -07004051 if (waittime) {
4052 if (hlock->read)
4053 lock_time_inc(&stats->read_waittime, waittime);
4054 else
4055 lock_time_inc(&stats->write_waittime, waittime);
4056 }
4057 if (lock->cpu != cpu)
4058 stats->bounces[bounce_acquired + !!hlock->read]++;
Peter Zijlstra96645672007-07-19 01:49:00 -07004059
4060 lock->cpu = cpu;
Peter Zijlstrac7e78cf2008-10-16 23:17:09 +02004061 lock->ip = ip;
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004062}
4063
4064void lock_contended(struct lockdep_map *lock, unsigned long ip)
4065{
4066 unsigned long flags;
4067
Waiman Long9506a742018-10-18 21:45:17 -04004068 if (unlikely(!lock_stat || !debug_locks))
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004069 return;
4070
4071 if (unlikely(current->lockdep_recursion))
4072 return;
4073
4074 raw_local_irq_save(flags);
4075 check_flags(flags);
4076 current->lockdep_recursion = 1;
Frederic Weisbeckerdb2c4c72010-02-02 23:34:40 +01004077 trace_lock_contended(lock, ip);
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004078 __lock_contended(lock, ip);
4079 current->lockdep_recursion = 0;
4080 raw_local_irq_restore(flags);
4081}
4082EXPORT_SYMBOL_GPL(lock_contended);
4083
Peter Zijlstrac7e78cf2008-10-16 23:17:09 +02004084void lock_acquired(struct lockdep_map *lock, unsigned long ip)
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004085{
4086 unsigned long flags;
4087
Waiman Long9506a742018-10-18 21:45:17 -04004088 if (unlikely(!lock_stat || !debug_locks))
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004089 return;
4090
4091 if (unlikely(current->lockdep_recursion))
4092 return;
4093
4094 raw_local_irq_save(flags);
4095 check_flags(flags);
4096 current->lockdep_recursion = 1;
Peter Zijlstrac7e78cf2008-10-16 23:17:09 +02004097 __lock_acquired(lock, ip);
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004098 current->lockdep_recursion = 0;
4099 raw_local_irq_restore(flags);
4100}
4101EXPORT_SYMBOL_GPL(lock_acquired);
4102#endif
4103
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004104/*
4105 * Used by the testsuite, sanitize the validator state
4106 * after a simulated failure:
4107 */
4108
4109void lockdep_reset(void)
4110{
4111 unsigned long flags;
Ingo Molnar23d95a02006-12-13 00:34:40 -08004112 int i;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004113
4114 raw_local_irq_save(flags);
4115 current->curr_chain_key = 0;
4116 current->lockdep_depth = 0;
4117 current->lockdep_recursion = 0;
4118 memset(current->held_locks, 0, MAX_LOCK_DEPTH*sizeof(struct held_lock));
4119 nr_hardirq_chains = 0;
4120 nr_softirq_chains = 0;
4121 nr_process_chains = 0;
4122 debug_locks = 1;
Ingo Molnar23d95a02006-12-13 00:34:40 -08004123 for (i = 0; i < CHAINHASH_SIZE; i++)
Andrew Mortona63f38c2016-02-03 13:44:12 -08004124 INIT_HLIST_HEAD(chainhash_table + i);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004125 raw_local_irq_restore(flags);
4126}
4127
Bart Van Assche786fa292018-12-06 17:11:36 -08004128/*
4129 * Remove all references to a lock class. The caller must hold the graph lock.
4130 */
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004131static void zap_class(struct lock_class *class)
4132{
Bart Van Assche86cffb82019-02-14 15:00:41 -08004133 struct lock_list *entry;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004134 int i;
4135
4136 /*
4137 * Remove all dependencies this lock is
4138 * involved in:
4139 */
Bart Van Assche86cffb82019-02-14 15:00:41 -08004140 for (i = 0, entry = list_entries; i < nr_list_entries; i++, entry++) {
4141 if (entry->class != class && entry->links_to != class)
4142 continue;
4143 list_del_rcu(&entry->entry);
4144 /* Clear .class and .links_to to avoid double removal. */
4145 WRITE_ONCE(entry->class, NULL);
4146 WRITE_ONCE(entry->links_to, NULL);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004147 }
4148 /*
4149 * Unhash the class and remove it from the all_lock_classes list:
4150 */
Andrew Mortona63f38c2016-02-03 13:44:12 -08004151 hlist_del_rcu(&class->hash_entry);
Bart Van Asschefe27b0d2018-12-06 17:11:37 -08004152 list_del(&class->lock_entry);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004153
Peter Zijlstracee34d82015-06-02 12:50:13 +02004154 RCU_INIT_POINTER(class->key, NULL);
4155 RCU_INIT_POINTER(class->name, NULL);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004156}
4157
Arjan van de Venfabe8742008-01-24 07:00:45 +01004158static inline int within(const void *addr, void *start, unsigned long size)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004159{
4160 return addr >= start && addr < start + size;
4161}
4162
Bart Van Assche956f3562019-02-14 15:00:43 -08004163static void __lockdep_free_key_range(void *start, unsigned long size)
4164{
4165 struct lock_class *class;
4166 struct hlist_head *head;
4167 int i;
4168
4169 /* Unhash all classes that were created by a module. */
4170 for (i = 0; i < CLASSHASH_SIZE; i++) {
4171 head = classhash_table + i;
4172 hlist_for_each_entry_rcu(class, head, hash_entry) {
4173 if (!within(class->key, start, size) &&
4174 !within(class->name, start, size))
4175 continue;
4176 zap_class(class);
4177 }
4178 }
4179}
4180
Peter Zijlstra35a93932015-02-26 16:23:11 +01004181/*
4182 * Used in module.c to remove lock classes from memory that is going to be
4183 * freed; and possibly re-used by other modules.
4184 *
4185 * We will have had one sync_sched() before getting here, so we're guaranteed
4186 * nobody will look up these exact classes -- they're properly dead but still
4187 * allocated.
4188 */
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004189void lockdep_free_key_range(void *start, unsigned long size)
4190{
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004191 unsigned long flags;
Nick Piggin5a26db52008-01-16 09:51:58 +01004192 int locked;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004193
Bart Van Asschefeb0a382019-02-14 15:00:42 -08004194 init_data_structures_once();
4195
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004196 raw_local_irq_save(flags);
Nick Piggin5a26db52008-01-16 09:51:58 +01004197 locked = graph_lock();
Bart Van Assche956f3562019-02-14 15:00:43 -08004198 __lockdep_free_key_range(start, size);
Nick Piggin5a26db52008-01-16 09:51:58 +01004199 if (locked)
4200 graph_unlock();
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004201 raw_local_irq_restore(flags);
Peter Zijlstra35a93932015-02-26 16:23:11 +01004202
4203 /*
4204 * Wait for any possible iterators from look_up_lock_class() to pass
4205 * before continuing to free the memory they refer to.
4206 *
4207 * sync_sched() is sufficient because the read-side is IRQ disable.
4208 */
Paul E. McKenney51959d82018-11-06 19:06:51 -08004209 synchronize_rcu();
Peter Zijlstra35a93932015-02-26 16:23:11 +01004210
4211 /*
4212 * XXX at this point we could return the resources to the pool;
4213 * instead we leak them. We would need to change to bitmap allocators
4214 * instead of the linear allocators we have now.
4215 */
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004216}
4217
Bart Van Assche2904d9f2018-12-06 17:11:34 -08004218/*
4219 * Check whether any element of the @lock->class_cache[] array refers to a
4220 * registered lock class. The caller must hold either the graph lock or the
4221 * RCU read lock.
4222 */
4223static bool lock_class_cache_is_registered(struct lockdep_map *lock)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004224{
Peter Zijlstra35a93932015-02-26 16:23:11 +01004225 struct lock_class *class;
Andrew Mortona63f38c2016-02-03 13:44:12 -08004226 struct hlist_head *head;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004227 int i, j;
Bart Van Assche2904d9f2018-12-06 17:11:34 -08004228
4229 for (i = 0; i < CLASSHASH_SIZE; i++) {
4230 head = classhash_table + i;
4231 hlist_for_each_entry_rcu(class, head, hash_entry) {
4232 for (j = 0; j < NR_LOCKDEP_CACHING_CLASSES; j++)
4233 if (lock->class_cache[j] == class)
4234 return true;
4235 }
4236 }
4237 return false;
4238}
4239
Bart Van Assche956f3562019-02-14 15:00:43 -08004240/* The caller must hold the graph lock. Does not sleep. */
4241static void __lockdep_reset_lock(struct lockdep_map *lock)
Bart Van Assche2904d9f2018-12-06 17:11:34 -08004242{
4243 struct lock_class *class;
Bart Van Assche956f3562019-02-14 15:00:43 -08004244 int j;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004245
4246 /*
Ingo Molnard6d897c2006-07-10 04:44:04 -07004247 * Remove all classes this lock might have:
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004248 */
Ingo Molnard6d897c2006-07-10 04:44:04 -07004249 for (j = 0; j < MAX_LOCKDEP_SUBCLASSES; j++) {
4250 /*
4251 * If the class exists we look it up and zap it:
4252 */
4253 class = look_up_lock_class(lock, j);
Matthew Wilcox64f29d12018-01-17 07:14:12 -08004254 if (class)
Ingo Molnard6d897c2006-07-10 04:44:04 -07004255 zap_class(class);
4256 }
4257 /*
4258 * Debug check: in the end all mapped classes should
4259 * be gone.
4260 */
Bart Van Assche956f3562019-02-14 15:00:43 -08004261 if (WARN_ON_ONCE(lock_class_cache_is_registered(lock)))
4262 debug_locks_off();
4263}
4264
4265void lockdep_reset_lock(struct lockdep_map *lock)
4266{
4267 unsigned long flags;
4268 int locked;
4269
4270 init_data_structures_once();
4271
4272 raw_local_irq_save(flags);
4273 locked = graph_lock();
4274 __lockdep_reset_lock(lock);
Nick Piggin5a26db52008-01-16 09:51:58 +01004275 if (locked)
4276 graph_unlock();
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004277 raw_local_irq_restore(flags);
4278}
4279
Joel Fernandes (Google)c3bc8fd2018-07-30 15:24:23 -07004280void __init lockdep_init(void)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004281{
4282 printk("Lock dependency validator: Copyright (c) 2006 Red Hat, Inc., Ingo Molnar\n");
4283
Li Zefanb0788ca2008-11-21 15:57:32 +08004284 printk("... MAX_LOCKDEP_SUBCLASSES: %lu\n", MAX_LOCKDEP_SUBCLASSES);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004285 printk("... MAX_LOCK_DEPTH: %lu\n", MAX_LOCK_DEPTH);
4286 printk("... MAX_LOCKDEP_KEYS: %lu\n", MAX_LOCKDEP_KEYS);
Li Zefanb0788ca2008-11-21 15:57:32 +08004287 printk("... CLASSHASH_SIZE: %lu\n", CLASSHASH_SIZE);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004288 printk("... MAX_LOCKDEP_ENTRIES: %lu\n", MAX_LOCKDEP_ENTRIES);
4289 printk("... MAX_LOCKDEP_CHAINS: %lu\n", MAX_LOCKDEP_CHAINS);
4290 printk("... CHAINHASH_SIZE: %lu\n", CHAINHASH_SIZE);
4291
Bart Van Assche09d75ec2019-02-14 15:00:36 -08004292 printk(" memory used by lock dependency info: %zu kB\n",
Bart Van Assche7ff85172019-02-14 15:00:37 -08004293 (sizeof(lock_classes) +
4294 sizeof(classhash_table) +
4295 sizeof(list_entries) +
Bart Van Assche7ff85172019-02-14 15:00:37 -08004296 sizeof(chainhash_table)
Ming Lei4dd861d2009-07-16 15:44:29 +02004297#ifdef CONFIG_PROVE_LOCKING
Bart Van Assche7ff85172019-02-14 15:00:37 -08004298 + sizeof(lock_cq)
Bart Van Assche15ea86b2019-02-14 15:00:38 -08004299 + sizeof(lock_chains)
4300 + sizeof(chain_hlocks)
Ming Lei4dd861d2009-07-16 15:44:29 +02004301#endif
Ming Lei906292092009-08-02 21:43:36 +08004302 ) / 1024
Ming Lei4dd861d2009-07-16 15:44:29 +02004303 );
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004304
Bart Van Assche09d75ec2019-02-14 15:00:36 -08004305 printk(" per task-struct memory footprint: %zu bytes\n",
Bart Van Assche7ff85172019-02-14 15:00:37 -08004306 sizeof(((struct task_struct *)NULL)->held_locks));
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004307}
4308
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004309static void
4310print_freed_lock_bug(struct task_struct *curr, const void *mem_from,
Arjan van de Ven55794a42006-07-10 04:44:03 -07004311 const void *mem_to, struct held_lock *hlock)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004312{
4313 if (!debug_locks_off())
4314 return;
4315 if (debug_locks_silent)
4316 return;
4317
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004318 pr_warn("\n");
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08004319 pr_warn("=========================\n");
4320 pr_warn("WARNING: held lock freed!\n");
Ben Hutchingsfbdc4b92011-10-28 04:36:55 +01004321 print_kernel_ident();
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08004322 pr_warn("-------------------------\n");
Borislav Petkov04860d42018-02-26 14:49:26 +01004323 pr_warn("%s/%d is freeing memory %px-%px, with a lock still held there!\n",
Pavel Emelyanovba25f9d2007-10-18 23:40:40 -07004324 curr->comm, task_pid_nr(curr), mem_from, mem_to-1);
Arjan van de Ven55794a42006-07-10 04:44:03 -07004325 print_lock(hlock);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004326 lockdep_print_held_locks(curr);
4327
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004328 pr_warn("\nstack backtrace:\n");
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004329 dump_stack();
4330}
4331
Oleg Nesterov54561782007-12-05 15:46:09 +01004332static inline int not_in_range(const void* mem_from, unsigned long mem_len,
4333 const void* lock_from, unsigned long lock_len)
4334{
4335 return lock_from + lock_len <= mem_from ||
4336 mem_from + mem_len <= lock_from;
4337}
4338
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004339/*
4340 * Called when kernel memory is freed (or unmapped), or if a lock
4341 * is destroyed or reinitialized - this code checks whether there is
4342 * any held lock in the memory range of <from> to <to>:
4343 */
4344void debug_check_no_locks_freed(const void *mem_from, unsigned long mem_len)
4345{
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004346 struct task_struct *curr = current;
4347 struct held_lock *hlock;
4348 unsigned long flags;
4349 int i;
4350
4351 if (unlikely(!debug_locks))
4352 return;
4353
Steven Rostedt (VMware)fcc784b2018-04-04 14:06:30 -04004354 raw_local_irq_save(flags);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004355 for (i = 0; i < curr->lockdep_depth; i++) {
4356 hlock = curr->held_locks + i;
4357
Oleg Nesterov54561782007-12-05 15:46:09 +01004358 if (not_in_range(mem_from, mem_len, hlock->instance,
4359 sizeof(*hlock->instance)))
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004360 continue;
4361
Oleg Nesterov54561782007-12-05 15:46:09 +01004362 print_freed_lock_bug(curr, mem_from, mem_from + mem_len, hlock);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004363 break;
4364 }
Steven Rostedt (VMware)fcc784b2018-04-04 14:06:30 -04004365 raw_local_irq_restore(flags);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004366}
Peter Zijlstraed075362006-12-06 20:35:24 -08004367EXPORT_SYMBOL_GPL(debug_check_no_locks_freed);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004368
Colin Cross1b1d2fb2013-05-06 23:50:08 +00004369static void print_held_locks_bug(void)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004370{
4371 if (!debug_locks_off())
4372 return;
4373 if (debug_locks_silent)
4374 return;
4375
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004376 pr_warn("\n");
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08004377 pr_warn("====================================\n");
4378 pr_warn("WARNING: %s/%d still has locks held!\n",
Colin Cross1b1d2fb2013-05-06 23:50:08 +00004379 current->comm, task_pid_nr(current));
Ben Hutchingsfbdc4b92011-10-28 04:36:55 +01004380 print_kernel_ident();
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08004381 pr_warn("------------------------------------\n");
Colin Cross1b1d2fb2013-05-06 23:50:08 +00004382 lockdep_print_held_locks(current);
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004383 pr_warn("\nstack backtrace:\n");
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004384 dump_stack();
4385}
4386
Colin Cross1b1d2fb2013-05-06 23:50:08 +00004387void debug_check_no_locks_held(void)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004388{
Colin Cross1b1d2fb2013-05-06 23:50:08 +00004389 if (unlikely(current->lockdep_depth > 0))
4390 print_held_locks_bug();
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004391}
Colin Cross1b1d2fb2013-05-06 23:50:08 +00004392EXPORT_SYMBOL_GPL(debug_check_no_locks_held);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004393
Sasha Levin8dce7a92013-06-13 18:41:16 -04004394#ifdef __KERNEL__
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004395void debug_show_all_locks(void)
4396{
4397 struct task_struct *g, *p;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004398
Jarek Poplawski9c35dd72007-03-22 00:11:28 -08004399 if (unlikely(!debug_locks)) {
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004400 pr_warn("INFO: lockdep is turned off.\n");
Jarek Poplawski9c35dd72007-03-22 00:11:28 -08004401 return;
4402 }
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004403 pr_warn("\nShowing all locks held in the system:\n");
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004404
Tetsuo Handa0f736a52018-04-06 19:41:18 +09004405 rcu_read_lock();
4406 for_each_process_thread(g, p) {
Tetsuo Handa0f736a52018-04-06 19:41:18 +09004407 if (!p->lockdep_depth)
4408 continue;
4409 lockdep_print_held_locks(p);
Tejun Heo88f1c872018-01-22 14:00:55 -08004410 touch_nmi_watchdog();
Tetsuo Handa0f736a52018-04-06 19:41:18 +09004411 touch_all_softlockup_watchdogs();
4412 }
4413 rcu_read_unlock();
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004414
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004415 pr_warn("\n");
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08004416 pr_warn("=============================================\n\n");
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004417}
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004418EXPORT_SYMBOL_GPL(debug_show_all_locks);
Sasha Levin8dce7a92013-06-13 18:41:16 -04004419#endif
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004420
Ingo Molnar82a1fcb2008-01-25 21:08:02 +01004421/*
4422 * Careful: only use this function if you are sure that
4423 * the task cannot run in parallel!
4424 */
John Kacurf1b499f2010-08-05 17:10:53 +02004425void debug_show_held_locks(struct task_struct *task)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004426{
Jarek Poplawski9c35dd72007-03-22 00:11:28 -08004427 if (unlikely(!debug_locks)) {
4428 printk("INFO: lockdep is turned off.\n");
4429 return;
4430 }
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004431 lockdep_print_held_locks(task);
4432}
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004433EXPORT_SYMBOL_GPL(debug_show_held_locks);
Peter Zijlstrab351d162007-10-11 22:11:12 +02004434
Andi Kleen722a9f92014-05-02 00:44:38 +02004435asmlinkage __visible void lockdep_sys_exit(void)
Peter Zijlstrab351d162007-10-11 22:11:12 +02004436{
4437 struct task_struct *curr = current;
4438
4439 if (unlikely(curr->lockdep_depth)) {
4440 if (!debug_locks_off())
4441 return;
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004442 pr_warn("\n");
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08004443 pr_warn("================================================\n");
4444 pr_warn("WARNING: lock held when returning to user space!\n");
Ben Hutchingsfbdc4b92011-10-28 04:36:55 +01004445 print_kernel_ident();
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08004446 pr_warn("------------------------------------------------\n");
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004447 pr_warn("%s/%d is leaving the kernel with locks still held!\n",
Peter Zijlstrab351d162007-10-11 22:11:12 +02004448 curr->comm, curr->pid);
4449 lockdep_print_held_locks(curr);
4450 }
Byungchul Parkb09be672017-08-07 16:12:52 +09004451
4452 /*
4453 * The lock history for each syscall should be independent. So wipe the
4454 * slate clean on return to userspace.
4455 */
Peter Zijlstraf52be572017-08-29 10:59:39 +02004456 lockdep_invariant_state(false);
Peter Zijlstrab351d162007-10-11 22:11:12 +02004457}
Paul E. McKenney0632eb32010-02-22 17:04:47 -08004458
Paul E. McKenneyb3fbab02011-05-24 08:31:09 -07004459void lockdep_rcu_suspicious(const char *file, const int line, const char *s)
Paul E. McKenney0632eb32010-02-22 17:04:47 -08004460{
4461 struct task_struct *curr = current;
4462
Lai Jiangshan2b3fc352010-04-20 16:23:07 +08004463 /* Note: the following can be executed concurrently, so be careful. */
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004464 pr_warn("\n");
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08004465 pr_warn("=============================\n");
4466 pr_warn("WARNING: suspicious RCU usage\n");
Ben Hutchingsfbdc4b92011-10-28 04:36:55 +01004467 print_kernel_ident();
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08004468 pr_warn("-----------------------------\n");
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004469 pr_warn("%s:%d %s!\n", file, line, s);
4470 pr_warn("\nother info that might help us debug this:\n\n");
4471 pr_warn("\n%srcu_scheduler_active = %d, debug_locks = %d\n",
Paul E. McKenneyc5fdcec2012-01-30 08:46:32 -08004472 !rcu_lockdep_current_cpu_online()
4473 ? "RCU used illegally from offline CPU!\n"
Paul E. McKenney5c173eb2013-09-13 17:20:11 -07004474 : !rcu_is_watching()
Paul E. McKenneyc5fdcec2012-01-30 08:46:32 -08004475 ? "RCU used illegally from idle CPU!\n"
4476 : "",
4477 rcu_scheduler_active, debug_locks);
Frederic Weisbecker0464e932011-10-07 18:22:01 +02004478
4479 /*
4480 * If a CPU is in the RCU-free window in idle (ie: in the section
4481 * between rcu_idle_enter() and rcu_idle_exit(), then RCU
4482 * considers that CPU to be in an "extended quiescent state",
4483 * which means that RCU will be completely ignoring that CPU.
4484 * Therefore, rcu_read_lock() and friends have absolutely no
4485 * effect on a CPU running in that state. In other words, even if
4486 * such an RCU-idle CPU has called rcu_read_lock(), RCU might well
4487 * delete data structures out from under it. RCU really has no
4488 * choice here: we need to keep an RCU-free window in idle where
4489 * the CPU may possibly enter into low power mode. This way we can
4490 * notice an extended quiescent state to other CPUs that started a grace
4491 * period. Otherwise we would delay any grace period as long as we run
4492 * in the idle task.
4493 *
4494 * So complain bitterly if someone does call rcu_read_lock(),
4495 * rcu_read_lock_bh() and so on from extended quiescent states.
4496 */
Paul E. McKenney5c173eb2013-09-13 17:20:11 -07004497 if (!rcu_is_watching())
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004498 pr_warn("RCU used illegally from extended quiescent state!\n");
Frederic Weisbecker0464e932011-10-07 18:22:01 +02004499
Paul E. McKenney0632eb32010-02-22 17:04:47 -08004500 lockdep_print_held_locks(curr);
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004501 pr_warn("\nstack backtrace:\n");
Paul E. McKenney0632eb32010-02-22 17:04:47 -08004502 dump_stack();
4503}
Paul E. McKenneyb3fbab02011-05-24 08:31:09 -07004504EXPORT_SYMBOL_GPL(lockdep_rcu_suspicious);