blob: fbbb79d5cfa0a94d64d7836d486e5f10deef43dc [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;
141static struct lock_class lock_classes[MAX_LOCKDEP_KEYS];
142
Dave Jonesf82b2172008-08-11 09:30:23 +0200143static inline struct lock_class *hlock_class(struct held_lock *hlock)
144{
145 if (!hlock->class_idx) {
Peter Zijlstra0119fee2011-09-02 01:30:29 +0200146 /*
147 * Someone passed in garbage, we give up.
148 */
Dave Jonesf82b2172008-08-11 09:30:23 +0200149 DEBUG_LOCKS_WARN_ON(1);
150 return NULL;
151 }
152 return lock_classes + hlock->class_idx - 1;
153}
154
Peter Zijlstraf20786f2007-07-19 01:48:56 -0700155#ifdef CONFIG_LOCK_STAT
Peter Zijlstra25528212016-03-15 14:52:49 -0700156static DEFINE_PER_CPU(struct lock_class_stats[MAX_LOCKDEP_KEYS], cpu_lock_stats);
Peter Zijlstraf20786f2007-07-19 01:48:56 -0700157
Peter Zijlstra3365e7792009-10-09 10:12:41 +0200158static inline u64 lockstat_clock(void)
159{
Peter Zijlstrac6763292010-05-25 10:48:51 +0200160 return local_clock();
Peter Zijlstra3365e7792009-10-09 10:12:41 +0200161}
162
Peter Zijlstrac7e78cf2008-10-16 23:17:09 +0200163static int lock_point(unsigned long points[], unsigned long ip)
Peter Zijlstraf20786f2007-07-19 01:48:56 -0700164{
165 int i;
166
Peter Zijlstrac7e78cf2008-10-16 23:17:09 +0200167 for (i = 0; i < LOCKSTAT_POINTS; i++) {
168 if (points[i] == 0) {
169 points[i] = ip;
Peter Zijlstraf20786f2007-07-19 01:48:56 -0700170 break;
171 }
Peter Zijlstrac7e78cf2008-10-16 23:17:09 +0200172 if (points[i] == ip)
Peter Zijlstraf20786f2007-07-19 01:48:56 -0700173 break;
174 }
175
176 return i;
177}
178
Peter Zijlstra3365e7792009-10-09 10:12:41 +0200179static void lock_time_inc(struct lock_time *lt, u64 time)
Peter Zijlstraf20786f2007-07-19 01:48:56 -0700180{
181 if (time > lt->max)
182 lt->max = time;
183
Frank Rowand109d71c2009-11-19 13:42:06 -0800184 if (time < lt->min || !lt->nr)
Peter Zijlstraf20786f2007-07-19 01:48:56 -0700185 lt->min = time;
186
187 lt->total += time;
188 lt->nr++;
189}
190
Peter Zijlstrac46261d2007-07-19 01:48:57 -0700191static inline void lock_time_add(struct lock_time *src, struct lock_time *dst)
192{
Frank Rowand109d71c2009-11-19 13:42:06 -0800193 if (!src->nr)
194 return;
195
196 if (src->max > dst->max)
197 dst->max = src->max;
198
199 if (src->min < dst->min || !dst->nr)
200 dst->min = src->min;
201
Peter Zijlstrac46261d2007-07-19 01:48:57 -0700202 dst->total += src->total;
203 dst->nr += src->nr;
204}
205
206struct lock_class_stats lock_stats(struct lock_class *class)
207{
208 struct lock_class_stats stats;
209 int cpu, i;
210
211 memset(&stats, 0, sizeof(struct lock_class_stats));
212 for_each_possible_cpu(cpu) {
213 struct lock_class_stats *pcs =
Tejun Heo1871e522009-10-29 22:34:13 +0900214 &per_cpu(cpu_lock_stats, cpu)[class - lock_classes];
Peter Zijlstrac46261d2007-07-19 01:48:57 -0700215
216 for (i = 0; i < ARRAY_SIZE(stats.contention_point); i++)
217 stats.contention_point[i] += pcs->contention_point[i];
218
Peter Zijlstrac7e78cf2008-10-16 23:17:09 +0200219 for (i = 0; i < ARRAY_SIZE(stats.contending_point); i++)
220 stats.contending_point[i] += pcs->contending_point[i];
221
Peter Zijlstrac46261d2007-07-19 01:48:57 -0700222 lock_time_add(&pcs->read_waittime, &stats.read_waittime);
223 lock_time_add(&pcs->write_waittime, &stats.write_waittime);
224
225 lock_time_add(&pcs->read_holdtime, &stats.read_holdtime);
226 lock_time_add(&pcs->write_holdtime, &stats.write_holdtime);
Peter Zijlstra96645672007-07-19 01:49:00 -0700227
228 for (i = 0; i < ARRAY_SIZE(stats.bounces); i++)
229 stats.bounces[i] += pcs->bounces[i];
Peter Zijlstrac46261d2007-07-19 01:48:57 -0700230 }
231
232 return stats;
233}
234
235void clear_lock_stats(struct lock_class *class)
236{
237 int cpu;
238
239 for_each_possible_cpu(cpu) {
240 struct lock_class_stats *cpu_stats =
Tejun Heo1871e522009-10-29 22:34:13 +0900241 &per_cpu(cpu_lock_stats, cpu)[class - lock_classes];
Peter Zijlstrac46261d2007-07-19 01:48:57 -0700242
243 memset(cpu_stats, 0, sizeof(struct lock_class_stats));
244 }
245 memset(class->contention_point, 0, sizeof(class->contention_point));
Peter Zijlstrac7e78cf2008-10-16 23:17:09 +0200246 memset(class->contending_point, 0, sizeof(class->contending_point));
Peter Zijlstrac46261d2007-07-19 01:48:57 -0700247}
248
Peter Zijlstraf20786f2007-07-19 01:48:56 -0700249static struct lock_class_stats *get_lock_stats(struct lock_class *class)
250{
Joel Fernandes (Google)01f38492018-07-30 15:24:21 -0700251 return &this_cpu_ptr(cpu_lock_stats)[class - lock_classes];
Peter Zijlstraf20786f2007-07-19 01:48:56 -0700252}
253
254static void lock_release_holdtime(struct held_lock *hlock)
255{
256 struct lock_class_stats *stats;
Peter Zijlstra3365e7792009-10-09 10:12:41 +0200257 u64 holdtime;
Peter Zijlstraf20786f2007-07-19 01:48:56 -0700258
259 if (!lock_stat)
260 return;
261
Peter Zijlstra3365e7792009-10-09 10:12:41 +0200262 holdtime = lockstat_clock() - hlock->holdtime_stamp;
Peter Zijlstraf20786f2007-07-19 01:48:56 -0700263
Dave Jonesf82b2172008-08-11 09:30:23 +0200264 stats = get_lock_stats(hlock_class(hlock));
Peter Zijlstraf20786f2007-07-19 01:48:56 -0700265 if (hlock->read)
266 lock_time_inc(&stats->read_holdtime, holdtime);
267 else
268 lock_time_inc(&stats->write_holdtime, holdtime);
Peter Zijlstraf20786f2007-07-19 01:48:56 -0700269}
270#else
271static inline void lock_release_holdtime(struct held_lock *hlock)
272{
273}
274#endif
275
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700276/*
277 * We keep a global list of all lock classes. The list only grows,
278 * never shrinks. The list is only accessed with the lockdep
279 * spinlock lock held.
280 */
281LIST_HEAD(all_lock_classes);
282
283/*
284 * The lockdep classes are in a hash-table as well, for fast lookup:
285 */
286#define CLASSHASH_BITS (MAX_LOCKDEP_KEYS_BITS - 1)
287#define CLASSHASH_SIZE (1UL << CLASSHASH_BITS)
Peter Zijlstra4b32d0a2007-07-19 01:48:59 -0700288#define __classhashfn(key) hash_long((unsigned long)key, CLASSHASH_BITS)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700289#define classhashentry(key) (classhash_table + __classhashfn((key)))
290
Andrew Mortona63f38c2016-02-03 13:44:12 -0800291static struct hlist_head classhash_table[CLASSHASH_SIZE];
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700292
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700293/*
294 * We put the lock dependency chains into a hash-table as well, to cache
295 * their existence:
296 */
297#define CHAINHASH_BITS (MAX_LOCKDEP_CHAINS_BITS-1)
298#define CHAINHASH_SIZE (1UL << CHAINHASH_BITS)
Peter Zijlstra4b32d0a2007-07-19 01:48:59 -0700299#define __chainhashfn(chain) hash_long(chain, CHAINHASH_BITS)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700300#define chainhashentry(chain) (chainhash_table + __chainhashfn((chain)))
301
Andrew Mortona63f38c2016-02-03 13:44:12 -0800302static struct hlist_head chainhash_table[CHAINHASH_SIZE];
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700303
304/*
305 * The hash key of the lock dependency chains is a hash itself too:
306 * it's a hash of all locks taken up to that lock, including that lock.
307 * It's a 64-bit hash, because it's important for the keys to be
308 * unique.
309 */
Peter Zijlstradfaaf3f2016-05-30 18:31:33 +0200310static inline u64 iterate_chain_key(u64 key, u32 idx)
311{
312 u32 k0 = key, k1 = key >> 32;
313
314 __jhash_mix(idx, k0, k1); /* Macro that modifies arguments! */
315
316 return k0 | (u64)k1 << 32;
317}
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700318
Steven Rostedt1d09daa2008-05-12 21:20:55 +0200319void lockdep_off(void)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700320{
321 current->lockdep_recursion++;
322}
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700323EXPORT_SYMBOL(lockdep_off);
324
Steven Rostedt1d09daa2008-05-12 21:20:55 +0200325void lockdep_on(void)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700326{
327 current->lockdep_recursion--;
328}
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700329EXPORT_SYMBOL(lockdep_on);
330
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700331/*
332 * Debugging switches:
333 */
334
335#define VERBOSE 0
Ingo Molnar33e94e92006-12-13 00:34:41 -0800336#define VERY_VERBOSE 0
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700337
338#if VERBOSE
339# define HARDIRQ_VERBOSE 1
340# define SOFTIRQ_VERBOSE 1
341#else
342# define HARDIRQ_VERBOSE 0
343# define SOFTIRQ_VERBOSE 0
344#endif
345
Peter Zijlstrad92a8cf2017-03-03 10:13:38 +0100346#if VERBOSE || HARDIRQ_VERBOSE || SOFTIRQ_VERBOSE
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700347/*
348 * Quick filtering for interesting events:
349 */
350static int class_filter(struct lock_class *class)
351{
Andi Kleenf9829cc2006-07-10 04:44:01 -0700352#if 0
353 /* Example */
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700354 if (class->name_version == 1 &&
Andi Kleenf9829cc2006-07-10 04:44:01 -0700355 !strcmp(class->name, "lockname"))
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700356 return 1;
357 if (class->name_version == 1 &&
Andi Kleenf9829cc2006-07-10 04:44:01 -0700358 !strcmp(class->name, "&struct->lockfield"))
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700359 return 1;
Andi Kleenf9829cc2006-07-10 04:44:01 -0700360#endif
Ingo Molnara6640892006-12-13 00:34:39 -0800361 /* Filter everything else. 1 would be to allow everything else */
362 return 0;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700363}
364#endif
365
366static int verbose(struct lock_class *class)
367{
368#if VERBOSE
369 return class_filter(class);
370#endif
371 return 0;
372}
373
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700374/*
375 * Stack-trace: tightly packed array of stack backtrace
Ingo Molnar74c383f2006-12-13 00:34:43 -0800376 * addresses. Protected by the graph_lock.
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700377 */
378unsigned long nr_stack_trace_entries;
379static unsigned long stack_trace[MAX_STACK_TRACE_ENTRIES];
380
Dave Jones2c522832013-04-25 13:40:02 -0400381static void print_lockdep_off(const char *bug_msg)
382{
383 printk(KERN_DEBUG "%s\n", bug_msg);
384 printk(KERN_DEBUG "turning off the locking correctness validator.\n");
Andreas Gruenbacheracf59372014-07-15 21:10:52 +0200385#ifdef CONFIG_LOCK_STAT
Dave Jones2c522832013-04-25 13:40:02 -0400386 printk(KERN_DEBUG "Please attach the output of /proc/lock_stat to the bug report\n");
Andreas Gruenbacheracf59372014-07-15 21:10:52 +0200387#endif
Dave Jones2c522832013-04-25 13:40:02 -0400388}
389
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700390static int save_trace(struct stack_trace *trace)
391{
392 trace->nr_entries = 0;
393 trace->max_entries = MAX_STACK_TRACE_ENTRIES - nr_stack_trace_entries;
394 trace->entries = stack_trace + nr_stack_trace_entries;
395
Andi Kleen5a1b3992006-09-26 10:52:34 +0200396 trace->skip = 3;
Andi Kleen5a1b3992006-09-26 10:52:34 +0200397
Christoph Hellwigab1b6f02007-05-08 00:23:29 -0700398 save_stack_trace(trace);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700399
Peter Zijlstra4f84f432009-07-20 15:27:04 +0200400 /*
401 * Some daft arches put -1 at the end to indicate its a full trace.
402 *
403 * <rant> this is buggy anyway, since it takes a whole extra entry so a
404 * complete trace that maxes out the entries provided will be reported
405 * as incomplete, friggin useless </rant>
406 */
Luck, Tonyea5b41f2009-12-09 14:29:36 -0800407 if (trace->nr_entries != 0 &&
408 trace->entries[trace->nr_entries-1] == ULONG_MAX)
Peter Zijlstra4f84f432009-07-20 15:27:04 +0200409 trace->nr_entries--;
410
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700411 trace->max_entries = trace->nr_entries;
412
413 nr_stack_trace_entries += trace->nr_entries;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700414
Peter Zijlstra4f84f432009-07-20 15:27:04 +0200415 if (nr_stack_trace_entries >= MAX_STACK_TRACE_ENTRIES-1) {
Ingo Molnar74c383f2006-12-13 00:34:43 -0800416 if (!debug_locks_off_graph_unlock())
417 return 0;
418
Dave Jones2c522832013-04-25 13:40:02 -0400419 print_lockdep_off("BUG: MAX_STACK_TRACE_ENTRIES too low!");
Ingo Molnar74c383f2006-12-13 00:34:43 -0800420 dump_stack();
421
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700422 return 0;
423 }
424
425 return 1;
426}
427
428unsigned int nr_hardirq_chains;
429unsigned int nr_softirq_chains;
430unsigned int nr_process_chains;
431unsigned int max_lockdep_depth;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700432
433#ifdef CONFIG_DEBUG_LOCKDEP
434/*
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700435 * Various lockdep statistics:
436 */
Frederic Weisbeckerbd6d29c2010-04-06 00:10:17 +0200437DEFINE_PER_CPU(struct lockdep_stats, lockdep_stats);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700438#endif
439
440/*
441 * Locking printouts:
442 */
443
Peter Zijlstrafabe9c42009-01-22 14:51:01 +0100444#define __USAGE(__STATE) \
Peter Zijlstrab4b136f2009-01-29 14:50:36 +0100445 [LOCK_USED_IN_##__STATE] = "IN-"__stringify(__STATE)"-W", \
446 [LOCK_ENABLED_##__STATE] = __stringify(__STATE)"-ON-W", \
447 [LOCK_USED_IN_##__STATE##_READ] = "IN-"__stringify(__STATE)"-R",\
448 [LOCK_ENABLED_##__STATE##_READ] = __stringify(__STATE)"-ON-R",
Peter Zijlstrafabe9c42009-01-22 14:51:01 +0100449
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700450static const char *usage_str[] =
451{
Peter Zijlstrafabe9c42009-01-22 14:51:01 +0100452#define LOCKDEP_STATE(__STATE) __USAGE(__STATE)
453#include "lockdep_states.h"
454#undef LOCKDEP_STATE
455 [LOCK_USED] = "INITIAL USE",
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700456};
457
458const char * __get_key_name(struct lockdep_subclass_key *key, char *str)
459{
Alexey Dobriyanffb45122007-05-08 00:28:41 -0700460 return kallsyms_lookup((unsigned long)key, NULL, NULL, NULL, str);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700461}
462
Peter Zijlstra3ff176c2009-01-22 17:40:42 +0100463static inline unsigned long lock_flag(enum lock_usage_bit bit)
464{
465 return 1UL << bit;
466}
467
468static char get_usage_char(struct lock_class *class, enum lock_usage_bit bit)
469{
470 char c = '.';
471
472 if (class->usage_mask & lock_flag(bit + 2))
473 c = '+';
474 if (class->usage_mask & lock_flag(bit)) {
475 c = '-';
476 if (class->usage_mask & lock_flag(bit + 2))
477 c = '?';
478 }
479
480 return c;
481}
482
Peter Zijlstraf510b232009-01-22 17:53:47 +0100483void get_usage_chars(struct lock_class *class, char usage[LOCK_USAGE_CHARS])
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700484{
Peter Zijlstraf510b232009-01-22 17:53:47 +0100485 int i = 0;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700486
Peter Zijlstraf510b232009-01-22 17:53:47 +0100487#define LOCKDEP_STATE(__STATE) \
488 usage[i++] = get_usage_char(class, LOCK_USED_IN_##__STATE); \
489 usage[i++] = get_usage_char(class, LOCK_USED_IN_##__STATE##_READ);
490#include "lockdep_states.h"
491#undef LOCKDEP_STATE
492
493 usage[i] = '\0';
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700494}
495
Steven Rostedte5e78d02011-11-02 20:24:16 -0400496static void __print_lock_name(struct lock_class *class)
Steven Rostedt3003eba2011-04-20 21:41:54 -0400497{
498 char str[KSYM_NAME_LEN];
499 const char *name;
500
501 name = class->name;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700502 if (!name) {
503 name = __get_key_name(class->key, str);
Dmitry Vyukovf943fe02016-11-28 15:24:43 +0100504 printk(KERN_CONT "%s", name);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700505 } else {
Dmitry Vyukovf943fe02016-11-28 15:24:43 +0100506 printk(KERN_CONT "%s", name);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700507 if (class->name_version > 1)
Dmitry Vyukovf943fe02016-11-28 15:24:43 +0100508 printk(KERN_CONT "#%d", class->name_version);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700509 if (class->subclass)
Dmitry Vyukovf943fe02016-11-28 15:24:43 +0100510 printk(KERN_CONT "/%d", class->subclass);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700511 }
Steven Rostedte5e78d02011-11-02 20:24:16 -0400512}
513
514static void print_lock_name(struct lock_class *class)
515{
516 char usage[LOCK_USAGE_CHARS];
517
518 get_usage_chars(class, usage);
519
Dmitry Vyukovf943fe02016-11-28 15:24:43 +0100520 printk(KERN_CONT " (");
Steven Rostedte5e78d02011-11-02 20:24:16 -0400521 __print_lock_name(class);
Dmitry Vyukovf943fe02016-11-28 15:24:43 +0100522 printk(KERN_CONT "){%s}", usage);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700523}
524
525static void print_lockdep_cache(struct lockdep_map *lock)
526{
527 const char *name;
Tejun Heo9281ace2007-07-17 04:03:51 -0700528 char str[KSYM_NAME_LEN];
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700529
530 name = lock->name;
531 if (!name)
532 name = __get_key_name(lock->key->subkeys, str);
533
Dmitry Vyukovf943fe02016-11-28 15:24:43 +0100534 printk(KERN_CONT "%s", name);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700535}
536
537static void print_lock(struct held_lock *hlock)
538{
Peter Zijlstrad7bc3192015-04-15 17:11:57 +0200539 /*
540 * We can be called locklessly through debug_show_all_locks() so be
541 * extra careful, the hlock might have been released and cleared.
542 */
543 unsigned int class_idx = hlock->class_idx;
544
545 /* Don't re-read hlock->class_idx, can't use READ_ONCE() on bitfields: */
546 barrier();
547
548 if (!class_idx || (class_idx - 1) >= MAX_LOCKDEP_KEYS) {
Dmitry Vyukovf943fe02016-11-28 15:24:43 +0100549 printk(KERN_CONT "<RELEASED>\n");
Peter Zijlstrad7bc3192015-04-15 17:11:57 +0200550 return;
551 }
552
Tetsuo Handab3c39752018-03-27 19:41:41 +0900553 printk(KERN_CONT "%p", hlock->instance);
Peter Zijlstrad7bc3192015-04-15 17:11:57 +0200554 print_lock_name(lock_classes + class_idx - 1);
Tetsuo Handab3c39752018-03-27 19:41:41 +0900555 printk(KERN_CONT ", at: %pS\n", (void *)hlock->acquire_ip);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700556}
557
Tetsuo Handa8cc05c712018-04-06 19:41:19 +0900558static void lockdep_print_held_locks(struct task_struct *p)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700559{
Tetsuo Handa8cc05c712018-04-06 19:41:19 +0900560 int i, depth = READ_ONCE(p->lockdep_depth);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700561
Tetsuo Handa8cc05c712018-04-06 19:41:19 +0900562 if (!depth)
563 printk("no locks held by %s/%d.\n", p->comm, task_pid_nr(p));
564 else
565 printk("%d lock%s held by %s/%d:\n", depth,
566 depth > 1 ? "s" : "", p->comm, task_pid_nr(p));
567 /*
568 * It's not reliable to print a task's held locks if it's not sleeping
569 * and it's not the current task.
570 */
571 if (p->state == TASK_RUNNING && p != current)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700572 return;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700573 for (i = 0; i < depth; i++) {
574 printk(" #%d: ", i);
Tetsuo Handa8cc05c712018-04-06 19:41:19 +0900575 print_lock(p->held_locks + i);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700576 }
577}
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700578
Ben Hutchingsfbdc4b92011-10-28 04:36:55 +0100579static void print_kernel_ident(void)
Dave Jones99de0552006-09-29 02:00:10 -0700580{
Ben Hutchingsfbdc4b92011-10-28 04:36:55 +0100581 printk("%s %.*s %s\n", init_utsname()->release,
Serge E. Hallyn96b644b2006-10-02 02:18:13 -0700582 (int)strcspn(init_utsname()->version, " "),
Ben Hutchingsfbdc4b92011-10-28 04:36:55 +0100583 init_utsname()->version,
584 print_tainted());
Dave Jones99de0552006-09-29 02:00:10 -0700585}
586
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700587static int very_verbose(struct lock_class *class)
588{
589#if VERY_VERBOSE
590 return class_filter(class);
591#endif
592 return 0;
593}
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700594
595/*
596 * Is this the address of a static object:
597 */
Sasha Levin8dce7a92013-06-13 18:41:16 -0400598#ifdef __KERNEL__
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700599static int static_obj(void *obj)
600{
601 unsigned long start = (unsigned long) &_stext,
602 end = (unsigned long) &_end,
603 addr = (unsigned long) obj;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700604
605 /*
606 * static variable?
607 */
608 if ((addr >= start) && (addr < end))
609 return 1;
610
Mike Frysinger2a9ad182009-09-22 16:44:16 -0700611 if (arch_is_kernel_data(addr))
612 return 1;
613
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700614 /*
Tejun Heo10fad5e2010-03-10 18:57:54 +0900615 * in-kernel percpu var?
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700616 */
Tejun Heo10fad5e2010-03-10 18:57:54 +0900617 if (is_kernel_percpu_address(addr))
618 return 1;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700619
620 /*
Tejun Heo10fad5e2010-03-10 18:57:54 +0900621 * module static or percpu var?
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700622 */
Tejun Heo10fad5e2010-03-10 18:57:54 +0900623 return is_module_address(addr) || is_module_percpu_address(addr);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700624}
Sasha Levin8dce7a92013-06-13 18:41:16 -0400625#endif
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700626
627/*
628 * To make lock name printouts unique, we calculate a unique
629 * class->name_version generation counter:
630 */
631static int count_matching_names(struct lock_class *new_class)
632{
633 struct lock_class *class;
634 int count = 0;
635
636 if (!new_class->name)
637 return 0;
638
Peter Zijlstra35a93932015-02-26 16:23:11 +0100639 list_for_each_entry_rcu(class, &all_lock_classes, lock_entry) {
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700640 if (new_class->key - new_class->subclass == class->key)
641 return class->name_version;
642 if (class->name && !strcmp(class->name, new_class->name))
643 count = max(count, class->name_version);
644 }
645
646 return count + 1;
647}
648
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700649static inline struct lock_class *
Matthew Wilcox08f36ff2018-01-17 07:14:13 -0800650look_up_lock_class(const struct lockdep_map *lock, unsigned int subclass)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700651{
652 struct lockdep_subclass_key *key;
Andrew Mortona63f38c2016-02-03 13:44:12 -0800653 struct hlist_head *hash_head;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700654 struct lock_class *class;
655
Hitoshi Mitake4ba053c2010-10-13 17:30:26 +0900656 if (unlikely(subclass >= MAX_LOCKDEP_SUBCLASSES)) {
657 debug_locks_off();
658 printk(KERN_ERR
659 "BUG: looking up invalid subclass: %u\n", subclass);
660 printk(KERN_ERR
661 "turning off the locking correctness validator.\n");
662 dump_stack();
663 return NULL;
664 }
665
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700666 /*
Matthew Wilcox64f29d12018-01-17 07:14:12 -0800667 * If it is not initialised then it has never been locked,
668 * so it won't be present in the hash table.
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700669 */
Matthew Wilcox64f29d12018-01-17 07:14:12 -0800670 if (unlikely(!lock->key))
671 return NULL;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700672
673 /*
674 * NOTE: the class-key must be unique. For dynamic locks, a static
675 * lock_class_key variable is passed in through the mutex_init()
676 * (or spin_lock_init()) call - which acts as the key. For static
677 * locks we use the lock object itself as the key.
678 */
Peter Zijlstra4b32d0a2007-07-19 01:48:59 -0700679 BUILD_BUG_ON(sizeof(struct lock_class_key) >
680 sizeof(struct lockdep_map));
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700681
682 key = lock->key->subkeys + subclass;
683
684 hash_head = classhashentry(key);
685
686 /*
Peter Zijlstra35a93932015-02-26 16:23:11 +0100687 * We do an RCU walk of the hash, see lockdep_free_key_range().
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700688 */
Peter Zijlstra35a93932015-02-26 16:23:11 +0100689 if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
690 return NULL;
691
Andrew Mortona63f38c2016-02-03 13:44:12 -0800692 hlist_for_each_entry_rcu(class, hash_head, hash_entry) {
Peter Zijlstra4b32d0a2007-07-19 01:48:59 -0700693 if (class->key == key) {
Peter Zijlstra0119fee2011-09-02 01:30:29 +0200694 /*
695 * Huh! same key, different name? Did someone trample
696 * on some memory? We're most confused.
697 */
Peter Zijlstra4b32d0a2007-07-19 01:48:59 -0700698 WARN_ON_ONCE(class->name != lock->name);
Ingo Molnard6d897c2006-07-10 04:44:04 -0700699 return class;
Peter Zijlstra4b32d0a2007-07-19 01:48:59 -0700700 }
701 }
Ingo Molnard6d897c2006-07-10 04:44:04 -0700702
Matthew Wilcox64f29d12018-01-17 07:14:12 -0800703 return NULL;
704}
705
706/*
707 * Static locks do not have their class-keys yet - for them the key is
708 * the lock object itself. If the lock is in the per cpu area, the
709 * canonical address of the lock (per cpu offset removed) is used.
710 */
711static bool assign_lock_key(struct lockdep_map *lock)
712{
713 unsigned long can_addr, addr = (unsigned long)lock;
714
715 if (__is_kernel_percpu_address(addr, &can_addr))
716 lock->key = (void *)can_addr;
717 else if (__is_module_percpu_address(addr, &can_addr))
718 lock->key = (void *)can_addr;
719 else if (static_obj(lock))
720 lock->key = (void *)lock;
721 else {
722 /* Debug-check: all keys must be persistent! */
723 debug_locks_off();
724 pr_err("INFO: trying to register non-static key.\n");
725 pr_err("the code is fine but needs lockdep annotation.\n");
726 pr_err("turning off the locking correctness validator.\n");
727 dump_stack();
728 return false;
729 }
730
731 return true;
Ingo Molnard6d897c2006-07-10 04:44:04 -0700732}
733
734/*
735 * Register a lock's class in the hash-table, if the class is not present
736 * yet. Otherwise we look it up. We cache the result in the lock object
737 * itself, so actual lookup of the hash should be once per lock object.
738 */
Denys Vlasenkoc003ed92016-04-08 20:58:46 +0200739static struct lock_class *
Peter Zijlstra4dfbb9d2006-10-11 01:45:14 -0400740register_lock_class(struct lockdep_map *lock, unsigned int subclass, int force)
Ingo Molnard6d897c2006-07-10 04:44:04 -0700741{
742 struct lockdep_subclass_key *key;
Andrew Mortona63f38c2016-02-03 13:44:12 -0800743 struct hlist_head *hash_head;
Ingo Molnard6d897c2006-07-10 04:44:04 -0700744 struct lock_class *class;
Peter Zijlstra35a93932015-02-26 16:23:11 +0100745
746 DEBUG_LOCKS_WARN_ON(!irqs_disabled());
Ingo Molnard6d897c2006-07-10 04:44:04 -0700747
748 class = look_up_lock_class(lock, subclass);
Matthew Wilcox64f29d12018-01-17 07:14:12 -0800749 if (likely(class))
Yong Zhang87cdee72011-11-09 16:07:14 +0800750 goto out_set_class_cache;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700751
Matthew Wilcox64f29d12018-01-17 07:14:12 -0800752 if (!lock->key) {
753 if (!assign_lock_key(lock))
754 return NULL;
755 } else if (!static_obj(lock->key)) {
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700756 return NULL;
757 }
758
Ingo Molnard6d897c2006-07-10 04:44:04 -0700759 key = lock->key->subkeys + subclass;
760 hash_head = classhashentry(key);
761
Ingo Molnar74c383f2006-12-13 00:34:43 -0800762 if (!graph_lock()) {
Ingo Molnar74c383f2006-12-13 00:34:43 -0800763 return NULL;
764 }
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700765 /*
766 * We have to do the hash-walk again, to avoid races
767 * with another CPU:
768 */
Andrew Mortona63f38c2016-02-03 13:44:12 -0800769 hlist_for_each_entry_rcu(class, hash_head, hash_entry) {
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700770 if (class->key == key)
771 goto out_unlock_set;
Peter Zijlstra35a93932015-02-26 16:23:11 +0100772 }
773
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700774 /*
775 * Allocate a new key from the static array, and add it to
776 * the hash:
777 */
778 if (nr_lock_classes >= MAX_LOCKDEP_KEYS) {
Ingo Molnar74c383f2006-12-13 00:34:43 -0800779 if (!debug_locks_off_graph_unlock()) {
Ingo Molnar74c383f2006-12-13 00:34:43 -0800780 return NULL;
781 }
Ingo Molnar74c383f2006-12-13 00:34:43 -0800782
Dave Jones2c522832013-04-25 13:40:02 -0400783 print_lockdep_off("BUG: MAX_LOCKDEP_KEYS too low!");
Peter Zijlstraeedeeab2009-03-18 12:38:47 +0100784 dump_stack();
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700785 return NULL;
786 }
787 class = lock_classes + nr_lock_classes++;
Frederic Weisbeckerbd6d29c2010-04-06 00:10:17 +0200788 debug_atomic_inc(nr_unused_locks);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700789 class->key = key;
790 class->name = lock->name;
791 class->subclass = subclass;
792 INIT_LIST_HEAD(&class->lock_entry);
793 INIT_LIST_HEAD(&class->locks_before);
794 INIT_LIST_HEAD(&class->locks_after);
795 class->name_version = count_matching_names(class);
796 /*
797 * We use RCU's safe list-add method to make
798 * parallel walking of the hash-list safe:
799 */
Andrew Mortona63f38c2016-02-03 13:44:12 -0800800 hlist_add_head_rcu(&class->hash_entry, hash_head);
Dale Farnsworth14811972008-02-25 23:03:02 +0100801 /*
802 * Add it to the global list of classes:
803 */
804 list_add_tail_rcu(&class->lock_entry, &all_lock_classes);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700805
806 if (verbose(class)) {
Ingo Molnar74c383f2006-12-13 00:34:43 -0800807 graph_unlock();
Ingo Molnar74c383f2006-12-13 00:34:43 -0800808
Borislav Petkov04860d42018-02-26 14:49:26 +0100809 printk("\nnew class %px: %s", class->key, class->name);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700810 if (class->name_version > 1)
Dmitry Vyukovf943fe02016-11-28 15:24:43 +0100811 printk(KERN_CONT "#%d", class->name_version);
812 printk(KERN_CONT "\n");
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700813 dump_stack();
Ingo Molnar74c383f2006-12-13 00:34:43 -0800814
Ingo Molnar74c383f2006-12-13 00:34:43 -0800815 if (!graph_lock()) {
Ingo Molnar74c383f2006-12-13 00:34:43 -0800816 return NULL;
817 }
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700818 }
819out_unlock_set:
Ingo Molnar74c383f2006-12-13 00:34:43 -0800820 graph_unlock();
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700821
Yong Zhang87cdee72011-11-09 16:07:14 +0800822out_set_class_cache:
Peter Zijlstra4dfbb9d2006-10-11 01:45:14 -0400823 if (!subclass || force)
Hitoshi Mitake62016252010-10-05 18:01:51 +0900824 lock->class_cache[0] = class;
825 else if (subclass < NR_LOCKDEP_CACHING_CLASSES)
826 lock->class_cache[subclass] = class;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700827
Peter Zijlstra0119fee2011-09-02 01:30:29 +0200828 /*
829 * Hash collision, did we smoke some? We found a class with a matching
830 * hash but the subclass -- which is hashed in -- didn't match.
831 */
Jarek Poplawski381a2292007-02-10 01:44:58 -0800832 if (DEBUG_LOCKS_WARN_ON(class->subclass != subclass))
833 return NULL;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700834
835 return class;
836}
837
Peter Zijlstraca58abc2007-07-19 01:48:53 -0700838#ifdef CONFIG_PROVE_LOCKING
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700839/*
Peter Zijlstra8e182572007-07-19 01:48:54 -0700840 * Allocate a lockdep entry. (assumes the graph_lock held, returns
841 * with NULL on failure)
842 */
843static struct lock_list *alloc_list_entry(void)
844{
845 if (nr_list_entries >= MAX_LOCKDEP_ENTRIES) {
846 if (!debug_locks_off_graph_unlock())
847 return NULL;
848
Dave Jones2c522832013-04-25 13:40:02 -0400849 print_lockdep_off("BUG: MAX_LOCKDEP_ENTRIES too low!");
Peter Zijlstraeedeeab2009-03-18 12:38:47 +0100850 dump_stack();
Peter Zijlstra8e182572007-07-19 01:48:54 -0700851 return NULL;
852 }
853 return list_entries + nr_list_entries++;
854}
855
856/*
857 * Add a new dependency to the head of the list:
858 */
Tahsin Erdogan83f06162016-11-08 00:02:07 -0800859static int add_lock_to_list(struct lock_class *this, struct list_head *head,
860 unsigned long ip, int distance,
861 struct stack_trace *trace)
Peter Zijlstra8e182572007-07-19 01:48:54 -0700862{
863 struct lock_list *entry;
864 /*
865 * Lock not present yet - get a new dependency struct and
866 * add it to the list:
867 */
868 entry = alloc_list_entry();
869 if (!entry)
870 return 0;
871
Zhu Yi74870172008-08-27 14:33:00 +0800872 entry->class = this;
873 entry->distance = distance;
Yong Zhang4726f2a2010-05-04 14:16:48 +0800874 entry->trace = *trace;
Peter Zijlstra8e182572007-07-19 01:48:54 -0700875 /*
Peter Zijlstra35a93932015-02-26 16:23:11 +0100876 * Both allocation and removal are done under the graph lock; but
877 * iteration is under RCU-sched; see look_up_lock_class() and
878 * lockdep_free_key_range().
Peter Zijlstra8e182572007-07-19 01:48:54 -0700879 */
880 list_add_tail_rcu(&entry->entry, head);
881
882 return 1;
883}
884
Peter Zijlstra98c33ed2009-07-21 13:19:07 +0200885/*
886 * For good efficiency of modular, we use power of 2
887 */
Peter Zijlstraaf012962009-07-16 15:44:29 +0200888#define MAX_CIRCULAR_QUEUE_SIZE 4096UL
889#define CQ_MASK (MAX_CIRCULAR_QUEUE_SIZE-1)
890
Peter Zijlstra98c33ed2009-07-21 13:19:07 +0200891/*
892 * The circular_queue and helpers is used to implement the
Peter Zijlstraaf012962009-07-16 15:44:29 +0200893 * breadth-first search(BFS)algorithem, by which we can build
894 * the shortest path from the next lock to be acquired to the
895 * previous held lock if there is a circular between them.
Peter Zijlstra98c33ed2009-07-21 13:19:07 +0200896 */
Peter Zijlstraaf012962009-07-16 15:44:29 +0200897struct circular_queue {
898 unsigned long element[MAX_CIRCULAR_QUEUE_SIZE];
899 unsigned int front, rear;
900};
901
902static struct circular_queue lock_cq;
Peter Zijlstraaf012962009-07-16 15:44:29 +0200903
Ming Lei12f3dfd2009-07-16 15:44:29 +0200904unsigned int max_bfs_queue_depth;
Peter Zijlstraaf012962009-07-16 15:44:29 +0200905
Ming Leie351b662009-07-22 22:48:09 +0800906static unsigned int lockdep_dependency_gen_id;
907
Peter Zijlstraaf012962009-07-16 15:44:29 +0200908static inline void __cq_init(struct circular_queue *cq)
909{
910 cq->front = cq->rear = 0;
Ming Leie351b662009-07-22 22:48:09 +0800911 lockdep_dependency_gen_id++;
Peter Zijlstraaf012962009-07-16 15:44:29 +0200912}
913
914static inline int __cq_empty(struct circular_queue *cq)
915{
916 return (cq->front == cq->rear);
917}
918
919static inline int __cq_full(struct circular_queue *cq)
920{
921 return ((cq->rear + 1) & CQ_MASK) == cq->front;
922}
923
924static inline int __cq_enqueue(struct circular_queue *cq, unsigned long elem)
925{
926 if (__cq_full(cq))
927 return -1;
928
929 cq->element[cq->rear] = elem;
930 cq->rear = (cq->rear + 1) & CQ_MASK;
931 return 0;
932}
933
934static inline int __cq_dequeue(struct circular_queue *cq, unsigned long *elem)
935{
936 if (__cq_empty(cq))
937 return -1;
938
939 *elem = cq->element[cq->front];
940 cq->front = (cq->front + 1) & CQ_MASK;
941 return 0;
942}
943
944static inline unsigned int __cq_get_elem_count(struct circular_queue *cq)
945{
946 return (cq->rear - cq->front) & CQ_MASK;
947}
948
949static inline void mark_lock_accessed(struct lock_list *lock,
950 struct lock_list *parent)
951{
952 unsigned long nr;
Peter Zijlstra98c33ed2009-07-21 13:19:07 +0200953
Peter Zijlstraaf012962009-07-16 15:44:29 +0200954 nr = lock - list_entries;
Peter Zijlstra0119fee2011-09-02 01:30:29 +0200955 WARN_ON(nr >= nr_list_entries); /* Out-of-bounds, input fail */
Peter Zijlstraaf012962009-07-16 15:44:29 +0200956 lock->parent = parent;
Ming Leie351b662009-07-22 22:48:09 +0800957 lock->class->dep_gen_id = lockdep_dependency_gen_id;
Peter Zijlstraaf012962009-07-16 15:44:29 +0200958}
959
960static inline unsigned long lock_accessed(struct lock_list *lock)
961{
962 unsigned long nr;
Peter Zijlstra98c33ed2009-07-21 13:19:07 +0200963
Peter Zijlstraaf012962009-07-16 15:44:29 +0200964 nr = lock - list_entries;
Peter Zijlstra0119fee2011-09-02 01:30:29 +0200965 WARN_ON(nr >= nr_list_entries); /* Out-of-bounds, input fail */
Ming Leie351b662009-07-22 22:48:09 +0800966 return lock->class->dep_gen_id == lockdep_dependency_gen_id;
Peter Zijlstraaf012962009-07-16 15:44:29 +0200967}
968
969static inline struct lock_list *get_lock_parent(struct lock_list *child)
970{
971 return child->parent;
972}
973
974static inline int get_lock_depth(struct lock_list *child)
975{
976 int depth = 0;
977 struct lock_list *parent;
978
979 while ((parent = get_lock_parent(child))) {
980 child = parent;
981 depth++;
982 }
983 return depth;
984}
985
Ming Lei9e2d5512009-07-16 15:44:29 +0200986static int __bfs(struct lock_list *source_entry,
Peter Zijlstraaf012962009-07-16 15:44:29 +0200987 void *data,
988 int (*match)(struct lock_list *entry, void *data),
989 struct lock_list **target_entry,
990 int forward)
Ming Leic94aa5c2009-07-16 15:44:29 +0200991{
992 struct lock_list *entry;
Ming Leid588e462009-07-16 15:44:29 +0200993 struct list_head *head;
Ming Leic94aa5c2009-07-16 15:44:29 +0200994 struct circular_queue *cq = &lock_cq;
995 int ret = 1;
996
Ming Lei9e2d5512009-07-16 15:44:29 +0200997 if (match(source_entry, data)) {
Ming Leic94aa5c2009-07-16 15:44:29 +0200998 *target_entry = source_entry;
999 ret = 0;
1000 goto exit;
1001 }
1002
Ming Leid588e462009-07-16 15:44:29 +02001003 if (forward)
1004 head = &source_entry->class->locks_after;
1005 else
1006 head = &source_entry->class->locks_before;
1007
1008 if (list_empty(head))
1009 goto exit;
1010
1011 __cq_init(cq);
Ming Leic94aa5c2009-07-16 15:44:29 +02001012 __cq_enqueue(cq, (unsigned long)source_entry);
1013
1014 while (!__cq_empty(cq)) {
1015 struct lock_list *lock;
Ming Leic94aa5c2009-07-16 15:44:29 +02001016
1017 __cq_dequeue(cq, (unsigned long *)&lock);
1018
1019 if (!lock->class) {
1020 ret = -2;
1021 goto exit;
1022 }
1023
1024 if (forward)
1025 head = &lock->class->locks_after;
1026 else
1027 head = &lock->class->locks_before;
1028
Peter Zijlstra35a93932015-02-26 16:23:11 +01001029 DEBUG_LOCKS_WARN_ON(!irqs_disabled());
1030
1031 list_for_each_entry_rcu(entry, head, entry) {
Ming Leic94aa5c2009-07-16 15:44:29 +02001032 if (!lock_accessed(entry)) {
Ming Lei12f3dfd2009-07-16 15:44:29 +02001033 unsigned int cq_depth;
Ming Leic94aa5c2009-07-16 15:44:29 +02001034 mark_lock_accessed(entry, lock);
Ming Lei9e2d5512009-07-16 15:44:29 +02001035 if (match(entry, data)) {
Ming Leic94aa5c2009-07-16 15:44:29 +02001036 *target_entry = entry;
1037 ret = 0;
1038 goto exit;
1039 }
1040
1041 if (__cq_enqueue(cq, (unsigned long)entry)) {
1042 ret = -1;
1043 goto exit;
1044 }
Ming Lei12f3dfd2009-07-16 15:44:29 +02001045 cq_depth = __cq_get_elem_count(cq);
1046 if (max_bfs_queue_depth < cq_depth)
1047 max_bfs_queue_depth = cq_depth;
Ming Leic94aa5c2009-07-16 15:44:29 +02001048 }
1049 }
1050 }
1051exit:
1052 return ret;
1053}
1054
Ming Leid7aaba12009-07-16 15:44:29 +02001055static inline int __bfs_forwards(struct lock_list *src_entry,
Ming Lei9e2d5512009-07-16 15:44:29 +02001056 void *data,
1057 int (*match)(struct lock_list *entry, void *data),
1058 struct lock_list **target_entry)
Ming Leic94aa5c2009-07-16 15:44:29 +02001059{
Ming Lei9e2d5512009-07-16 15:44:29 +02001060 return __bfs(src_entry, data, match, target_entry, 1);
Ming Leic94aa5c2009-07-16 15:44:29 +02001061
1062}
1063
Ming Leid7aaba12009-07-16 15:44:29 +02001064static inline int __bfs_backwards(struct lock_list *src_entry,
Ming Lei9e2d5512009-07-16 15:44:29 +02001065 void *data,
1066 int (*match)(struct lock_list *entry, void *data),
1067 struct lock_list **target_entry)
Ming Leic94aa5c2009-07-16 15:44:29 +02001068{
Ming Lei9e2d5512009-07-16 15:44:29 +02001069 return __bfs(src_entry, data, match, target_entry, 0);
Ming Leic94aa5c2009-07-16 15:44:29 +02001070
1071}
1072
Peter Zijlstra8e182572007-07-19 01:48:54 -07001073/*
1074 * Recursive, forwards-direction lock-dependency checking, used for
1075 * both noncyclic checking and for hardirq-unsafe/softirq-unsafe
1076 * checking.
Peter Zijlstra8e182572007-07-19 01:48:54 -07001077 */
Peter Zijlstra8e182572007-07-19 01:48:54 -07001078
1079/*
1080 * Print a dependency chain entry (this is only done when a deadlock
1081 * has been detected):
1082 */
1083static noinline int
Ming Lei24208ca2009-07-16 15:44:29 +02001084print_circular_bug_entry(struct lock_list *target, int depth)
Peter Zijlstra8e182572007-07-19 01:48:54 -07001085{
1086 if (debug_locks_silent)
1087 return 0;
1088 printk("\n-> #%u", depth);
1089 print_lock_name(target->class);
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01001090 printk(KERN_CONT ":\n");
Peter Zijlstra8e182572007-07-19 01:48:54 -07001091 print_stack_trace(&target->trace, 6);
1092
1093 return 0;
1094}
1095
Steven Rostedtf4185812011-04-20 21:41:55 -04001096static void
1097print_circular_lock_scenario(struct held_lock *src,
1098 struct held_lock *tgt,
1099 struct lock_list *prt)
1100{
1101 struct lock_class *source = hlock_class(src);
1102 struct lock_class *target = hlock_class(tgt);
1103 struct lock_class *parent = prt->class;
1104
1105 /*
1106 * A direct locking problem where unsafe_class lock is taken
1107 * directly by safe_class lock, then all we need to show
1108 * is the deadlock scenario, as it is obvious that the
1109 * unsafe lock is taken under the safe lock.
1110 *
1111 * But if there is a chain instead, where the safe lock takes
1112 * an intermediate lock (middle_class) where this lock is
1113 * not the same as the safe lock, then the lock chain is
1114 * used to describe the problem. Otherwise we would need
1115 * to show a different CPU case for each link in the chain
1116 * from the safe_class lock to the unsafe_class lock.
1117 */
1118 if (parent != source) {
1119 printk("Chain exists of:\n ");
1120 __print_lock_name(source);
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01001121 printk(KERN_CONT " --> ");
Steven Rostedtf4185812011-04-20 21:41:55 -04001122 __print_lock_name(parent);
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01001123 printk(KERN_CONT " --> ");
Steven Rostedtf4185812011-04-20 21:41:55 -04001124 __print_lock_name(target);
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01001125 printk(KERN_CONT "\n\n");
Steven Rostedtf4185812011-04-20 21:41:55 -04001126 }
1127
Ingo Molnare966eae2017-12-12 12:31:16 +01001128 printk(" Possible unsafe locking scenario:\n\n");
1129 printk(" CPU0 CPU1\n");
1130 printk(" ---- ----\n");
1131 printk(" lock(");
1132 __print_lock_name(target);
1133 printk(KERN_CONT ");\n");
1134 printk(" lock(");
1135 __print_lock_name(parent);
1136 printk(KERN_CONT ");\n");
1137 printk(" lock(");
1138 __print_lock_name(target);
1139 printk(KERN_CONT ");\n");
1140 printk(" lock(");
1141 __print_lock_name(source);
1142 printk(KERN_CONT ");\n");
1143 printk("\n *** DEADLOCK ***\n\n");
Steven Rostedtf4185812011-04-20 21:41:55 -04001144}
1145
Peter Zijlstra8e182572007-07-19 01:48:54 -07001146/*
1147 * When a circular dependency is detected, print the
1148 * header first:
1149 */
1150static noinline int
Ming Leidb0002a2009-07-16 15:44:29 +02001151print_circular_bug_header(struct lock_list *entry, unsigned int depth,
1152 struct held_lock *check_src,
1153 struct held_lock *check_tgt)
Peter Zijlstra8e182572007-07-19 01:48:54 -07001154{
1155 struct task_struct *curr = current;
1156
Ming Leic94aa5c2009-07-16 15:44:29 +02001157 if (debug_locks_silent)
Peter Zijlstra8e182572007-07-19 01:48:54 -07001158 return 0;
1159
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001160 pr_warn("\n");
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08001161 pr_warn("======================================================\n");
1162 pr_warn("WARNING: possible circular locking dependency detected\n");
Ben Hutchingsfbdc4b92011-10-28 04:36:55 +01001163 print_kernel_ident();
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08001164 pr_warn("------------------------------------------------------\n");
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001165 pr_warn("%s/%d is trying to acquire lock:\n",
Pavel Emelyanovba25f9d2007-10-18 23:40:40 -07001166 curr->comm, task_pid_nr(curr));
Ming Leidb0002a2009-07-16 15:44:29 +02001167 print_lock(check_src);
Byungchul Park383a4bc2017-08-07 16:12:55 +09001168
Ingo Molnare966eae2017-12-12 12:31:16 +01001169 pr_warn("\nbut task is already holding lock:\n");
Byungchul Park383a4bc2017-08-07 16:12:55 +09001170
Ming Leidb0002a2009-07-16 15:44:29 +02001171 print_lock(check_tgt);
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001172 pr_warn("\nwhich lock already depends on the new lock.\n\n");
1173 pr_warn("\nthe existing dependency chain (in reverse order) is:\n");
Peter Zijlstra8e182572007-07-19 01:48:54 -07001174
1175 print_circular_bug_entry(entry, depth);
1176
1177 return 0;
1178}
1179
Ming Lei9e2d5512009-07-16 15:44:29 +02001180static inline int class_equal(struct lock_list *entry, void *data)
1181{
1182 return entry->class == data;
1183}
1184
Ming Leidb0002a2009-07-16 15:44:29 +02001185static noinline int print_circular_bug(struct lock_list *this,
1186 struct lock_list *target,
1187 struct held_lock *check_src,
Byungchul Park383a4bc2017-08-07 16:12:55 +09001188 struct held_lock *check_tgt,
1189 struct stack_trace *trace)
Peter Zijlstra8e182572007-07-19 01:48:54 -07001190{
1191 struct task_struct *curr = current;
Ming Leic94aa5c2009-07-16 15:44:29 +02001192 struct lock_list *parent;
Steven Rostedtf4185812011-04-20 21:41:55 -04001193 struct lock_list *first_parent;
Ming Lei24208ca2009-07-16 15:44:29 +02001194 int depth;
Peter Zijlstra8e182572007-07-19 01:48:54 -07001195
Ming Leic94aa5c2009-07-16 15:44:29 +02001196 if (!debug_locks_off_graph_unlock() || debug_locks_silent)
Peter Zijlstra8e182572007-07-19 01:48:54 -07001197 return 0;
1198
Ingo Molnare966eae2017-12-12 12:31:16 +01001199 if (!save_trace(&this->trace))
Peter Zijlstra8e182572007-07-19 01:48:54 -07001200 return 0;
1201
Ming Leic94aa5c2009-07-16 15:44:29 +02001202 depth = get_lock_depth(target);
1203
Ming Leidb0002a2009-07-16 15:44:29 +02001204 print_circular_bug_header(target, depth, check_src, check_tgt);
Ming Leic94aa5c2009-07-16 15:44:29 +02001205
1206 parent = get_lock_parent(target);
Steven Rostedtf4185812011-04-20 21:41:55 -04001207 first_parent = parent;
Ming Leic94aa5c2009-07-16 15:44:29 +02001208
1209 while (parent) {
1210 print_circular_bug_entry(parent, --depth);
1211 parent = get_lock_parent(parent);
1212 }
Peter Zijlstra8e182572007-07-19 01:48:54 -07001213
1214 printk("\nother info that might help us debug this:\n\n");
Steven Rostedtf4185812011-04-20 21:41:55 -04001215 print_circular_lock_scenario(check_src, check_tgt,
1216 first_parent);
1217
Peter Zijlstra8e182572007-07-19 01:48:54 -07001218 lockdep_print_held_locks(curr);
1219
1220 printk("\nstack backtrace:\n");
1221 dump_stack();
1222
1223 return 0;
1224}
1225
Ming Leidb0002a2009-07-16 15:44:29 +02001226static noinline int print_bfs_bug(int ret)
1227{
1228 if (!debug_locks_off_graph_unlock())
1229 return 0;
1230
Peter Zijlstra0119fee2011-09-02 01:30:29 +02001231 /*
1232 * Breadth-first-search failed, graph got corrupted?
1233 */
Ming Leidb0002a2009-07-16 15:44:29 +02001234 WARN(1, "lockdep bfs error:%d\n", ret);
1235
1236 return 0;
1237}
1238
Ming Leief681022009-07-16 15:44:29 +02001239static int noop_count(struct lock_list *entry, void *data)
David Miller419ca3f2008-07-29 21:45:03 -07001240{
Ming Leief681022009-07-16 15:44:29 +02001241 (*(unsigned long *)data)++;
1242 return 0;
David Miller419ca3f2008-07-29 21:45:03 -07001243}
1244
Fengguang Wu5216d532013-11-09 00:55:35 +08001245static unsigned long __lockdep_count_forward_deps(struct lock_list *this)
Ming Leief681022009-07-16 15:44:29 +02001246{
1247 unsigned long count = 0;
1248 struct lock_list *uninitialized_var(target_entry);
1249
1250 __bfs_forwards(this, (void *)&count, noop_count, &target_entry);
1251
1252 return count;
1253}
David Miller419ca3f2008-07-29 21:45:03 -07001254unsigned long lockdep_count_forward_deps(struct lock_class *class)
1255{
1256 unsigned long ret, flags;
Ming Leief681022009-07-16 15:44:29 +02001257 struct lock_list this;
1258
1259 this.parent = NULL;
1260 this.class = class;
David Miller419ca3f2008-07-29 21:45:03 -07001261
Steven Rostedt (VMware)fcc784b2018-04-04 14:06:30 -04001262 raw_local_irq_save(flags);
Thomas Gleixner0199c4e2009-12-02 20:01:25 +01001263 arch_spin_lock(&lockdep_lock);
Ming Leief681022009-07-16 15:44:29 +02001264 ret = __lockdep_count_forward_deps(&this);
Thomas Gleixner0199c4e2009-12-02 20:01:25 +01001265 arch_spin_unlock(&lockdep_lock);
Steven Rostedt (VMware)fcc784b2018-04-04 14:06:30 -04001266 raw_local_irq_restore(flags);
David Miller419ca3f2008-07-29 21:45:03 -07001267
1268 return ret;
1269}
1270
Fengguang Wu5216d532013-11-09 00:55:35 +08001271static unsigned long __lockdep_count_backward_deps(struct lock_list *this)
David Miller419ca3f2008-07-29 21:45:03 -07001272{
Ming Leief681022009-07-16 15:44:29 +02001273 unsigned long count = 0;
1274 struct lock_list *uninitialized_var(target_entry);
David Miller419ca3f2008-07-29 21:45:03 -07001275
Ming Leief681022009-07-16 15:44:29 +02001276 __bfs_backwards(this, (void *)&count, noop_count, &target_entry);
David Miller419ca3f2008-07-29 21:45:03 -07001277
Ming Leief681022009-07-16 15:44:29 +02001278 return count;
David Miller419ca3f2008-07-29 21:45:03 -07001279}
1280
1281unsigned long lockdep_count_backward_deps(struct lock_class *class)
1282{
1283 unsigned long ret, flags;
Ming Leief681022009-07-16 15:44:29 +02001284 struct lock_list this;
1285
1286 this.parent = NULL;
1287 this.class = class;
David Miller419ca3f2008-07-29 21:45:03 -07001288
Steven Rostedt (VMware)fcc784b2018-04-04 14:06:30 -04001289 raw_local_irq_save(flags);
Thomas Gleixner0199c4e2009-12-02 20:01:25 +01001290 arch_spin_lock(&lockdep_lock);
Ming Leief681022009-07-16 15:44:29 +02001291 ret = __lockdep_count_backward_deps(&this);
Thomas Gleixner0199c4e2009-12-02 20:01:25 +01001292 arch_spin_unlock(&lockdep_lock);
Steven Rostedt (VMware)fcc784b2018-04-04 14:06:30 -04001293 raw_local_irq_restore(flags);
David Miller419ca3f2008-07-29 21:45:03 -07001294
1295 return ret;
1296}
1297
Peter Zijlstra8e182572007-07-19 01:48:54 -07001298/*
1299 * Prove that the dependency graph starting at <entry> can not
1300 * lead to <target>. Print an error and return 0 if it does.
1301 */
1302static noinline int
Ming Leidb0002a2009-07-16 15:44:29 +02001303check_noncircular(struct lock_list *root, struct lock_class *target,
1304 struct lock_list **target_entry)
Peter Zijlstra8e182572007-07-19 01:48:54 -07001305{
Ming Leidb0002a2009-07-16 15:44:29 +02001306 int result;
Peter Zijlstra8e182572007-07-19 01:48:54 -07001307
Frederic Weisbeckerbd6d29c2010-04-06 00:10:17 +02001308 debug_atomic_inc(nr_cyclic_checks);
David Miller419ca3f2008-07-29 21:45:03 -07001309
Ming Leid7aaba12009-07-16 15:44:29 +02001310 result = __bfs_forwards(root, target, class_equal, target_entry);
Ming Leidb0002a2009-07-16 15:44:29 +02001311
1312 return result;
Peter Zijlstra8e182572007-07-19 01:48:54 -07001313}
1314
Peter Zijlstraae813302017-03-03 10:13:38 +01001315static noinline int
1316check_redundant(struct lock_list *root, struct lock_class *target,
1317 struct lock_list **target_entry)
1318{
1319 int result;
1320
1321 debug_atomic_inc(nr_redundant_checks);
1322
1323 result = __bfs_forwards(root, target, class_equal, target_entry);
1324
1325 return result;
1326}
1327
Steven Rostedt81d68a92008-05-12 21:20:42 +02001328#if defined(CONFIG_TRACE_IRQFLAGS) && defined(CONFIG_PROVE_LOCKING)
Peter Zijlstra8e182572007-07-19 01:48:54 -07001329/*
1330 * Forwards and backwards subgraph searching, for the purposes of
1331 * proving that two subgraphs can be connected by a new dependency
1332 * without creating any illegal irq-safe -> irq-unsafe lock dependency.
1333 */
Peter Zijlstra8e182572007-07-19 01:48:54 -07001334
Ming Leid7aaba12009-07-16 15:44:29 +02001335static inline int usage_match(struct lock_list *entry, void *bit)
1336{
1337 return entry->class->usage_mask & (1 << (enum lock_usage_bit)bit);
1338}
1339
1340
1341
Peter Zijlstra8e182572007-07-19 01:48:54 -07001342/*
1343 * Find a node in the forwards-direction dependency sub-graph starting
Ming Leid7aaba12009-07-16 15:44:29 +02001344 * at @root->class that matches @bit.
Peter Zijlstra8e182572007-07-19 01:48:54 -07001345 *
Ming Leid7aaba12009-07-16 15:44:29 +02001346 * Return 0 if such a node exists in the subgraph, and put that node
1347 * into *@target_entry.
Peter Zijlstra8e182572007-07-19 01:48:54 -07001348 *
Ming Leid7aaba12009-07-16 15:44:29 +02001349 * Return 1 otherwise and keep *@target_entry unchanged.
1350 * Return <0 on error.
Peter Zijlstra8e182572007-07-19 01:48:54 -07001351 */
Ming Leid7aaba12009-07-16 15:44:29 +02001352static int
1353find_usage_forwards(struct lock_list *root, enum lock_usage_bit bit,
1354 struct lock_list **target_entry)
Peter Zijlstra8e182572007-07-19 01:48:54 -07001355{
Ming Leid7aaba12009-07-16 15:44:29 +02001356 int result;
Peter Zijlstra8e182572007-07-19 01:48:54 -07001357
Frederic Weisbeckerbd6d29c2010-04-06 00:10:17 +02001358 debug_atomic_inc(nr_find_usage_forwards_checks);
Peter Zijlstra8e182572007-07-19 01:48:54 -07001359
Ming Leid7aaba12009-07-16 15:44:29 +02001360 result = __bfs_forwards(root, (void *)bit, usage_match, target_entry);
1361
1362 return result;
Peter Zijlstra8e182572007-07-19 01:48:54 -07001363}
1364
1365/*
1366 * Find a node in the backwards-direction dependency sub-graph starting
Ming Leid7aaba12009-07-16 15:44:29 +02001367 * at @root->class that matches @bit.
Peter Zijlstra8e182572007-07-19 01:48:54 -07001368 *
Ming Leid7aaba12009-07-16 15:44:29 +02001369 * Return 0 if such a node exists in the subgraph, and put that node
1370 * into *@target_entry.
Peter Zijlstra8e182572007-07-19 01:48:54 -07001371 *
Ming Leid7aaba12009-07-16 15:44:29 +02001372 * Return 1 otherwise and keep *@target_entry unchanged.
1373 * Return <0 on error.
Peter Zijlstra8e182572007-07-19 01:48:54 -07001374 */
Ming Leid7aaba12009-07-16 15:44:29 +02001375static int
1376find_usage_backwards(struct lock_list *root, enum lock_usage_bit bit,
1377 struct lock_list **target_entry)
Peter Zijlstra8e182572007-07-19 01:48:54 -07001378{
Ming Leid7aaba12009-07-16 15:44:29 +02001379 int result;
Peter Zijlstra8e182572007-07-19 01:48:54 -07001380
Frederic Weisbeckerbd6d29c2010-04-06 00:10:17 +02001381 debug_atomic_inc(nr_find_usage_backwards_checks);
Peter Zijlstra8e182572007-07-19 01:48:54 -07001382
Ming Leid7aaba12009-07-16 15:44:29 +02001383 result = __bfs_backwards(root, (void *)bit, usage_match, target_entry);
Dave Jonesf82b2172008-08-11 09:30:23 +02001384
Ming Leid7aaba12009-07-16 15:44:29 +02001385 return result;
Peter Zijlstra8e182572007-07-19 01:48:54 -07001386}
1387
Peter Zijlstraaf012962009-07-16 15:44:29 +02001388static void print_lock_class_header(struct lock_class *class, int depth)
1389{
1390 int bit;
1391
1392 printk("%*s->", depth, "");
1393 print_lock_name(class);
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01001394 printk(KERN_CONT " ops: %lu", class->ops);
1395 printk(KERN_CONT " {\n");
Peter Zijlstraaf012962009-07-16 15:44:29 +02001396
1397 for (bit = 0; bit < LOCK_USAGE_STATES; bit++) {
1398 if (class->usage_mask & (1 << bit)) {
1399 int len = depth;
1400
1401 len += printk("%*s %s", depth, "", usage_str[bit]);
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01001402 len += printk(KERN_CONT " at:\n");
Peter Zijlstraaf012962009-07-16 15:44:29 +02001403 print_stack_trace(class->usage_traces + bit, len);
1404 }
1405 }
1406 printk("%*s }\n", depth, "");
1407
Borislav Petkov04860d42018-02-26 14:49:26 +01001408 printk("%*s ... key at: [<%px>] %pS\n",
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01001409 depth, "", class->key, class->key);
Peter Zijlstraaf012962009-07-16 15:44:29 +02001410}
1411
1412/*
1413 * printk the shortest lock dependencies from @start to @end in reverse order:
1414 */
1415static void __used
1416print_shortest_lock_dependencies(struct lock_list *leaf,
1417 struct lock_list *root)
1418{
1419 struct lock_list *entry = leaf;
1420 int depth;
1421
1422 /*compute depth from generated tree by BFS*/
1423 depth = get_lock_depth(leaf);
1424
1425 do {
1426 print_lock_class_header(entry->class, depth);
1427 printk("%*s ... acquired at:\n", depth, "");
1428 print_stack_trace(&entry->trace, 2);
1429 printk("\n");
1430
1431 if (depth == 0 && (entry != root)) {
Steven Rostedt6be8c392011-04-20 21:41:58 -04001432 printk("lockdep:%s bad path found in chain graph\n", __func__);
Peter Zijlstraaf012962009-07-16 15:44:29 +02001433 break;
1434 }
1435
1436 entry = get_lock_parent(entry);
1437 depth--;
1438 } while (entry && (depth >= 0));
1439
1440 return;
1441}
Ming Leid7aaba12009-07-16 15:44:29 +02001442
Steven Rostedt3003eba2011-04-20 21:41:54 -04001443static void
1444print_irq_lock_scenario(struct lock_list *safe_entry,
1445 struct lock_list *unsafe_entry,
Steven Rostedtdad3d742011-04-20 21:41:57 -04001446 struct lock_class *prev_class,
1447 struct lock_class *next_class)
Steven Rostedt3003eba2011-04-20 21:41:54 -04001448{
1449 struct lock_class *safe_class = safe_entry->class;
1450 struct lock_class *unsafe_class = unsafe_entry->class;
Steven Rostedtdad3d742011-04-20 21:41:57 -04001451 struct lock_class *middle_class = prev_class;
Steven Rostedt3003eba2011-04-20 21:41:54 -04001452
1453 if (middle_class == safe_class)
Steven Rostedtdad3d742011-04-20 21:41:57 -04001454 middle_class = next_class;
Steven Rostedt3003eba2011-04-20 21:41:54 -04001455
1456 /*
1457 * A direct locking problem where unsafe_class lock is taken
1458 * directly by safe_class lock, then all we need to show
1459 * is the deadlock scenario, as it is obvious that the
1460 * unsafe lock is taken under the safe lock.
1461 *
1462 * But if there is a chain instead, where the safe lock takes
1463 * an intermediate lock (middle_class) where this lock is
1464 * not the same as the safe lock, then the lock chain is
1465 * used to describe the problem. Otherwise we would need
1466 * to show a different CPU case for each link in the chain
1467 * from the safe_class lock to the unsafe_class lock.
1468 */
1469 if (middle_class != unsafe_class) {
1470 printk("Chain exists of:\n ");
1471 __print_lock_name(safe_class);
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01001472 printk(KERN_CONT " --> ");
Steven Rostedt3003eba2011-04-20 21:41:54 -04001473 __print_lock_name(middle_class);
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01001474 printk(KERN_CONT " --> ");
Steven Rostedt3003eba2011-04-20 21:41:54 -04001475 __print_lock_name(unsafe_class);
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01001476 printk(KERN_CONT "\n\n");
Steven Rostedt3003eba2011-04-20 21:41:54 -04001477 }
1478
1479 printk(" Possible interrupt unsafe locking scenario:\n\n");
1480 printk(" CPU0 CPU1\n");
1481 printk(" ---- ----\n");
1482 printk(" lock(");
1483 __print_lock_name(unsafe_class);
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01001484 printk(KERN_CONT ");\n");
Steven Rostedt3003eba2011-04-20 21:41:54 -04001485 printk(" local_irq_disable();\n");
1486 printk(" lock(");
1487 __print_lock_name(safe_class);
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01001488 printk(KERN_CONT ");\n");
Steven Rostedt3003eba2011-04-20 21:41:54 -04001489 printk(" lock(");
1490 __print_lock_name(middle_class);
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01001491 printk(KERN_CONT ");\n");
Steven Rostedt3003eba2011-04-20 21:41:54 -04001492 printk(" <Interrupt>\n");
1493 printk(" lock(");
1494 __print_lock_name(safe_class);
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01001495 printk(KERN_CONT ");\n");
Steven Rostedt3003eba2011-04-20 21:41:54 -04001496 printk("\n *** DEADLOCK ***\n\n");
1497}
1498
Peter Zijlstra8e182572007-07-19 01:48:54 -07001499static int
1500print_bad_irq_dependency(struct task_struct *curr,
Ming Lei24208ca2009-07-16 15:44:29 +02001501 struct lock_list *prev_root,
1502 struct lock_list *next_root,
1503 struct lock_list *backwards_entry,
1504 struct lock_list *forwards_entry,
Peter Zijlstra8e182572007-07-19 01:48:54 -07001505 struct held_lock *prev,
1506 struct held_lock *next,
1507 enum lock_usage_bit bit1,
1508 enum lock_usage_bit bit2,
1509 const char *irqclass)
1510{
1511 if (!debug_locks_off_graph_unlock() || debug_locks_silent)
1512 return 0;
1513
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001514 pr_warn("\n");
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08001515 pr_warn("=====================================================\n");
1516 pr_warn("WARNING: %s-safe -> %s-unsafe lock order detected\n",
Peter Zijlstra8e182572007-07-19 01:48:54 -07001517 irqclass, irqclass);
Ben Hutchingsfbdc4b92011-10-28 04:36:55 +01001518 print_kernel_ident();
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08001519 pr_warn("-----------------------------------------------------\n");
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001520 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 -07001521 curr->comm, task_pid_nr(curr),
Peter Zijlstra8e182572007-07-19 01:48:54 -07001522 curr->hardirq_context, hardirq_count() >> HARDIRQ_SHIFT,
1523 curr->softirq_context, softirq_count() >> SOFTIRQ_SHIFT,
1524 curr->hardirqs_enabled,
1525 curr->softirqs_enabled);
1526 print_lock(next);
1527
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001528 pr_warn("\nand this task is already holding:\n");
Peter Zijlstra8e182572007-07-19 01:48:54 -07001529 print_lock(prev);
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001530 pr_warn("which would create a new lock dependency:\n");
Dave Jonesf82b2172008-08-11 09:30:23 +02001531 print_lock_name(hlock_class(prev));
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001532 pr_cont(" ->");
Dave Jonesf82b2172008-08-11 09:30:23 +02001533 print_lock_name(hlock_class(next));
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001534 pr_cont("\n");
Peter Zijlstra8e182572007-07-19 01:48:54 -07001535
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001536 pr_warn("\nbut this new dependency connects a %s-irq-safe lock:\n",
Peter Zijlstra8e182572007-07-19 01:48:54 -07001537 irqclass);
Ming Lei24208ca2009-07-16 15:44:29 +02001538 print_lock_name(backwards_entry->class);
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001539 pr_warn("\n... which became %s-irq-safe at:\n", irqclass);
Peter Zijlstra8e182572007-07-19 01:48:54 -07001540
Ming Lei24208ca2009-07-16 15:44:29 +02001541 print_stack_trace(backwards_entry->class->usage_traces + bit1, 1);
Peter Zijlstra8e182572007-07-19 01:48:54 -07001542
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001543 pr_warn("\nto a %s-irq-unsafe lock:\n", irqclass);
Ming Lei24208ca2009-07-16 15:44:29 +02001544 print_lock_name(forwards_entry->class);
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001545 pr_warn("\n... which became %s-irq-unsafe at:\n", irqclass);
1546 pr_warn("...");
Peter Zijlstra8e182572007-07-19 01:48:54 -07001547
Ming Lei24208ca2009-07-16 15:44:29 +02001548 print_stack_trace(forwards_entry->class->usage_traces + bit2, 1);
Peter Zijlstra8e182572007-07-19 01:48:54 -07001549
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001550 pr_warn("\nother info that might help us debug this:\n\n");
Steven Rostedtdad3d742011-04-20 21:41:57 -04001551 print_irq_lock_scenario(backwards_entry, forwards_entry,
1552 hlock_class(prev), hlock_class(next));
Steven Rostedt3003eba2011-04-20 21:41:54 -04001553
Peter Zijlstra8e182572007-07-19 01:48:54 -07001554 lockdep_print_held_locks(curr);
1555
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001556 pr_warn("\nthe dependencies between %s-irq-safe lock and the holding lock:\n", irqclass);
Ming Lei24208ca2009-07-16 15:44:29 +02001557 if (!save_trace(&prev_root->trace))
1558 return 0;
1559 print_shortest_lock_dependencies(backwards_entry, prev_root);
Peter Zijlstra8e182572007-07-19 01:48:54 -07001560
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001561 pr_warn("\nthe dependencies between the lock to be acquired");
1562 pr_warn(" and %s-irq-unsafe lock:\n", irqclass);
Ming Lei24208ca2009-07-16 15:44:29 +02001563 if (!save_trace(&next_root->trace))
1564 return 0;
1565 print_shortest_lock_dependencies(forwards_entry, next_root);
Peter Zijlstra8e182572007-07-19 01:48:54 -07001566
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001567 pr_warn("\nstack backtrace:\n");
Peter Zijlstra8e182572007-07-19 01:48:54 -07001568 dump_stack();
1569
1570 return 0;
1571}
1572
1573static int
1574check_usage(struct task_struct *curr, struct held_lock *prev,
1575 struct held_lock *next, enum lock_usage_bit bit_backwards,
1576 enum lock_usage_bit bit_forwards, const char *irqclass)
1577{
1578 int ret;
Ming Lei24208ca2009-07-16 15:44:29 +02001579 struct lock_list this, that;
Ming Leid7aaba12009-07-16 15:44:29 +02001580 struct lock_list *uninitialized_var(target_entry);
Ming Lei24208ca2009-07-16 15:44:29 +02001581 struct lock_list *uninitialized_var(target_entry1);
Peter Zijlstra8e182572007-07-19 01:48:54 -07001582
Ming Leid7aaba12009-07-16 15:44:29 +02001583 this.parent = NULL;
Peter Zijlstra8e182572007-07-19 01:48:54 -07001584
Ming Leid7aaba12009-07-16 15:44:29 +02001585 this.class = hlock_class(prev);
1586 ret = find_usage_backwards(&this, bit_backwards, &target_entry);
Peter Zijlstraaf012962009-07-16 15:44:29 +02001587 if (ret < 0)
1588 return print_bfs_bug(ret);
1589 if (ret == 1)
1590 return ret;
Ming Leid7aaba12009-07-16 15:44:29 +02001591
Ming Lei24208ca2009-07-16 15:44:29 +02001592 that.parent = NULL;
1593 that.class = hlock_class(next);
1594 ret = find_usage_forwards(&that, bit_forwards, &target_entry1);
Peter Zijlstraaf012962009-07-16 15:44:29 +02001595 if (ret < 0)
1596 return print_bfs_bug(ret);
1597 if (ret == 1)
1598 return ret;
Ming Leid7aaba12009-07-16 15:44:29 +02001599
Ming Lei24208ca2009-07-16 15:44:29 +02001600 return print_bad_irq_dependency(curr, &this, &that,
1601 target_entry, target_entry1,
1602 prev, next,
Peter Zijlstra8e182572007-07-19 01:48:54 -07001603 bit_backwards, bit_forwards, irqclass);
1604}
1605
Peter Zijlstra4f367d8a2009-01-22 18:10:42 +01001606static const char *state_names[] = {
1607#define LOCKDEP_STATE(__STATE) \
Peter Zijlstrab4b136f2009-01-29 14:50:36 +01001608 __stringify(__STATE),
Peter Zijlstra4f367d8a2009-01-22 18:10:42 +01001609#include "lockdep_states.h"
1610#undef LOCKDEP_STATE
1611};
1612
1613static const char *state_rnames[] = {
1614#define LOCKDEP_STATE(__STATE) \
Peter Zijlstrab4b136f2009-01-29 14:50:36 +01001615 __stringify(__STATE)"-READ",
Peter Zijlstra4f367d8a2009-01-22 18:10:42 +01001616#include "lockdep_states.h"
1617#undef LOCKDEP_STATE
1618};
1619
1620static inline const char *state_name(enum lock_usage_bit bit)
1621{
1622 return (bit & 1) ? state_rnames[bit >> 2] : state_names[bit >> 2];
1623}
1624
1625static int exclusive_bit(int new_bit)
1626{
1627 /*
1628 * USED_IN
1629 * USED_IN_READ
1630 * ENABLED
1631 * ENABLED_READ
1632 *
1633 * bit 0 - write/read
1634 * bit 1 - used_in/enabled
1635 * bit 2+ state
1636 */
1637
1638 int state = new_bit & ~3;
1639 int dir = new_bit & 2;
1640
1641 /*
1642 * keep state, bit flip the direction and strip read.
1643 */
1644 return state | (dir ^ 2);
1645}
1646
1647static int check_irq_usage(struct task_struct *curr, struct held_lock *prev,
1648 struct held_lock *next, enum lock_usage_bit bit)
Peter Zijlstra8e182572007-07-19 01:48:54 -07001649{
1650 /*
1651 * Prove that the new dependency does not connect a hardirq-safe
1652 * lock with a hardirq-unsafe lock - to achieve this we search
1653 * the backwards-subgraph starting at <prev>, and the
1654 * forwards-subgraph starting at <next>:
1655 */
Peter Zijlstra4f367d8a2009-01-22 18:10:42 +01001656 if (!check_usage(curr, prev, next, bit,
1657 exclusive_bit(bit), state_name(bit)))
Peter Zijlstra8e182572007-07-19 01:48:54 -07001658 return 0;
1659
Peter Zijlstra4f367d8a2009-01-22 18:10:42 +01001660 bit++; /* _READ */
1661
Peter Zijlstra8e182572007-07-19 01:48:54 -07001662 /*
1663 * Prove that the new dependency does not connect a hardirq-safe-read
1664 * lock with a hardirq-unsafe lock - to achieve this we search
1665 * the backwards-subgraph starting at <prev>, and the
1666 * forwards-subgraph starting at <next>:
1667 */
Peter Zijlstra4f367d8a2009-01-22 18:10:42 +01001668 if (!check_usage(curr, prev, next, bit,
1669 exclusive_bit(bit), state_name(bit)))
Peter Zijlstra8e182572007-07-19 01:48:54 -07001670 return 0;
1671
Peter Zijlstra4f367d8a2009-01-22 18:10:42 +01001672 return 1;
1673}
Peter Zijlstra8e182572007-07-19 01:48:54 -07001674
Peter Zijlstra4f367d8a2009-01-22 18:10:42 +01001675static int
1676check_prev_add_irq(struct task_struct *curr, struct held_lock *prev,
1677 struct held_lock *next)
1678{
1679#define LOCKDEP_STATE(__STATE) \
1680 if (!check_irq_usage(curr, prev, next, LOCK_USED_IN_##__STATE)) \
Nick Piggincf40bd12009-01-21 08:12:39 +01001681 return 0;
Peter Zijlstra4f367d8a2009-01-22 18:10:42 +01001682#include "lockdep_states.h"
1683#undef LOCKDEP_STATE
Nick Piggincf40bd12009-01-21 08:12:39 +01001684
Peter Zijlstra8e182572007-07-19 01:48:54 -07001685 return 1;
1686}
1687
1688static void inc_chains(void)
1689{
1690 if (current->hardirq_context)
1691 nr_hardirq_chains++;
1692 else {
1693 if (current->softirq_context)
1694 nr_softirq_chains++;
1695 else
1696 nr_process_chains++;
1697 }
1698}
1699
1700#else
1701
1702static inline int
1703check_prev_add_irq(struct task_struct *curr, struct held_lock *prev,
1704 struct held_lock *next)
1705{
1706 return 1;
1707}
1708
1709static inline void inc_chains(void)
1710{
1711 nr_process_chains++;
1712}
1713
1714#endif
1715
Steven Rostedt48702ec2011-04-20 21:41:56 -04001716static void
1717print_deadlock_scenario(struct held_lock *nxt,
1718 struct held_lock *prv)
1719{
1720 struct lock_class *next = hlock_class(nxt);
1721 struct lock_class *prev = hlock_class(prv);
1722
1723 printk(" Possible unsafe locking scenario:\n\n");
1724 printk(" CPU0\n");
1725 printk(" ----\n");
1726 printk(" lock(");
1727 __print_lock_name(prev);
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01001728 printk(KERN_CONT ");\n");
Steven Rostedt48702ec2011-04-20 21:41:56 -04001729 printk(" lock(");
1730 __print_lock_name(next);
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01001731 printk(KERN_CONT ");\n");
Steven Rostedt48702ec2011-04-20 21:41:56 -04001732 printk("\n *** DEADLOCK ***\n\n");
1733 printk(" May be due to missing lock nesting notation\n\n");
1734}
1735
Peter Zijlstra8e182572007-07-19 01:48:54 -07001736static int
1737print_deadlock_bug(struct task_struct *curr, struct held_lock *prev,
1738 struct held_lock *next)
1739{
1740 if (!debug_locks_off_graph_unlock() || debug_locks_silent)
1741 return 0;
1742
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001743 pr_warn("\n");
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08001744 pr_warn("============================================\n");
1745 pr_warn("WARNING: possible recursive locking detected\n");
Ben Hutchingsfbdc4b92011-10-28 04:36:55 +01001746 print_kernel_ident();
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08001747 pr_warn("--------------------------------------------\n");
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001748 pr_warn("%s/%d is trying to acquire lock:\n",
Pavel Emelyanovba25f9d2007-10-18 23:40:40 -07001749 curr->comm, task_pid_nr(curr));
Peter Zijlstra8e182572007-07-19 01:48:54 -07001750 print_lock(next);
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001751 pr_warn("\nbut task is already holding lock:\n");
Peter Zijlstra8e182572007-07-19 01:48:54 -07001752 print_lock(prev);
1753
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001754 pr_warn("\nother info that might help us debug this:\n");
Steven Rostedt48702ec2011-04-20 21:41:56 -04001755 print_deadlock_scenario(next, prev);
Peter Zijlstra8e182572007-07-19 01:48:54 -07001756 lockdep_print_held_locks(curr);
1757
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001758 pr_warn("\nstack backtrace:\n");
Peter Zijlstra8e182572007-07-19 01:48:54 -07001759 dump_stack();
1760
1761 return 0;
1762}
1763
1764/*
1765 * Check whether we are holding such a class already.
1766 *
1767 * (Note that this has to be done separately, because the graph cannot
1768 * detect such classes of deadlocks.)
1769 *
1770 * Returns: 0 on deadlock detected, 1 on OK, 2 on recursive read
1771 */
1772static int
1773check_deadlock(struct task_struct *curr, struct held_lock *next,
1774 struct lockdep_map *next_instance, int read)
1775{
1776 struct held_lock *prev;
Peter Zijlstra7531e2f2008-08-11 09:30:24 +02001777 struct held_lock *nest = NULL;
Peter Zijlstra8e182572007-07-19 01:48:54 -07001778 int i;
1779
1780 for (i = 0; i < curr->lockdep_depth; i++) {
1781 prev = curr->held_locks + i;
Peter Zijlstra7531e2f2008-08-11 09:30:24 +02001782
1783 if (prev->instance == next->nest_lock)
1784 nest = prev;
1785
Dave Jonesf82b2172008-08-11 09:30:23 +02001786 if (hlock_class(prev) != hlock_class(next))
Peter Zijlstra8e182572007-07-19 01:48:54 -07001787 continue;
Peter Zijlstra7531e2f2008-08-11 09:30:24 +02001788
Peter Zijlstra8e182572007-07-19 01:48:54 -07001789 /*
1790 * Allow read-after-read recursion of the same
1791 * lock class (i.e. read_lock(lock)+read_lock(lock)):
1792 */
1793 if ((read == 2) && prev->read)
1794 return 2;
Peter Zijlstra7531e2f2008-08-11 09:30:24 +02001795
1796 /*
1797 * We're holding the nest_lock, which serializes this lock's
1798 * nesting behaviour.
1799 */
1800 if (nest)
1801 return 2;
1802
Peter Zijlstra8e182572007-07-19 01:48:54 -07001803 return print_deadlock_bug(curr, prev, next);
1804 }
1805 return 1;
1806}
1807
1808/*
1809 * There was a chain-cache miss, and we are about to add a new dependency
1810 * to a previous lock. We recursively validate the following rules:
1811 *
1812 * - would the adding of the <prev> -> <next> dependency create a
1813 * circular dependency in the graph? [== circular deadlock]
1814 *
1815 * - does the new prev->next dependency connect any hardirq-safe lock
1816 * (in the full backwards-subgraph starting at <prev>) with any
1817 * hardirq-unsafe lock (in the full forwards-subgraph starting at
1818 * <next>)? [== illegal lock inversion with hardirq contexts]
1819 *
1820 * - does the new prev->next dependency connect any softirq-safe lock
1821 * (in the full backwards-subgraph starting at <prev>) with any
1822 * softirq-unsafe lock (in the full forwards-subgraph starting at
1823 * <next>)? [== illegal lock inversion with softirq contexts]
1824 *
1825 * any of these scenarios could lead to a deadlock.
1826 *
1827 * Then if all the validations pass, we add the forwards and backwards
1828 * dependency.
1829 */
1830static int
1831check_prev_add(struct task_struct *curr, struct held_lock *prev,
Byungchul Parkce07a9412017-08-07 16:12:51 +09001832 struct held_lock *next, int distance, struct stack_trace *trace,
1833 int (*save)(struct stack_trace *trace))
Peter Zijlstra8e182572007-07-19 01:48:54 -07001834{
Ming Leidb0002a2009-07-16 15:44:29 +02001835 struct lock_list *uninitialized_var(target_entry);
Peter Zijlstra8b405d52017-10-04 11:13:37 +02001836 struct lock_list *entry;
1837 struct lock_list this;
1838 int ret;
Peter Zijlstra8e182572007-07-19 01:48:54 -07001839
1840 /*
1841 * Prove that the new <prev> -> <next> dependency would not
1842 * create a circular dependency in the graph. (We do this by
1843 * forward-recursing into the graph starting at <next>, and
1844 * checking whether we can reach <prev>.)
1845 *
1846 * We are using global variables to control the recursion, to
1847 * keep the stackframe size of the recursive functions low:
1848 */
Ming Leidb0002a2009-07-16 15:44:29 +02001849 this.class = hlock_class(next);
1850 this.parent = NULL;
1851 ret = check_noncircular(&this, hlock_class(prev), &target_entry);
Peter Zijlstra8b405d52017-10-04 11:13:37 +02001852 if (unlikely(!ret)) {
1853 if (!trace->entries) {
1854 /*
1855 * If @save fails here, the printing might trigger
1856 * a WARN but because of the !nr_entries it should
1857 * not do bad things.
1858 */
1859 save(trace);
1860 }
Byungchul Park383a4bc2017-08-07 16:12:55 +09001861 return print_circular_bug(&this, target_entry, next, prev, trace);
Peter Zijlstra8b405d52017-10-04 11:13:37 +02001862 }
Ming Leidb0002a2009-07-16 15:44:29 +02001863 else if (unlikely(ret < 0))
1864 return print_bfs_bug(ret);
Ming Leic94aa5c2009-07-16 15:44:29 +02001865
Peter Zijlstra8e182572007-07-19 01:48:54 -07001866 if (!check_prev_add_irq(curr, prev, next))
1867 return 0;
1868
1869 /*
1870 * For recursive read-locks we do all the dependency checks,
1871 * but we dont store read-triggered dependencies (only
1872 * write-triggered dependencies). This ensures that only the
1873 * write-side dependencies matter, and that if for example a
1874 * write-lock never takes any other locks, then the reads are
1875 * equivalent to a NOP.
1876 */
1877 if (next->read == 2 || prev->read == 2)
1878 return 1;
1879 /*
1880 * Is the <prev> -> <next> dependency already present?
1881 *
1882 * (this may occur even though this is a new chain: consider
1883 * e.g. the L1 -> L2 -> L3 -> L4 and the L5 -> L1 -> L2 -> L3
1884 * chains - the second one will be new, but L1 already has
1885 * L2 added to its dependency list, due to the first chain.)
1886 */
Dave Jonesf82b2172008-08-11 09:30:23 +02001887 list_for_each_entry(entry, &hlock_class(prev)->locks_after, entry) {
1888 if (entry->class == hlock_class(next)) {
Peter Zijlstra8e182572007-07-19 01:48:54 -07001889 if (distance == 1)
1890 entry->distance = 1;
Byungchul Park70911fd2017-08-07 16:12:50 +09001891 return 1;
Peter Zijlstra8e182572007-07-19 01:48:54 -07001892 }
1893 }
1894
Peter Zijlstraae813302017-03-03 10:13:38 +01001895 /*
1896 * Is the <prev> -> <next> link redundant?
1897 */
1898 this.class = hlock_class(prev);
1899 this.parent = NULL;
1900 ret = check_redundant(&this, hlock_class(next), &target_entry);
1901 if (!ret) {
1902 debug_atomic_inc(nr_redundant);
1903 return 2;
1904 }
1905 if (ret < 0)
1906 return print_bfs_bug(ret);
1907
1908
Peter Zijlstra8b405d52017-10-04 11:13:37 +02001909 if (!trace->entries && !save(trace))
Byungchul Parkce07a9412017-08-07 16:12:51 +09001910 return 0;
Yong Zhang4726f2a2010-05-04 14:16:48 +08001911
Peter Zijlstra8e182572007-07-19 01:48:54 -07001912 /*
1913 * Ok, all validations passed, add the new lock
1914 * to the previous lock's dependency list:
1915 */
Tahsin Erdogan83f06162016-11-08 00:02:07 -08001916 ret = add_lock_to_list(hlock_class(next),
Dave Jonesf82b2172008-08-11 09:30:23 +02001917 &hlock_class(prev)->locks_after,
Byungchul Parkce07a9412017-08-07 16:12:51 +09001918 next->acquire_ip, distance, trace);
Peter Zijlstra8e182572007-07-19 01:48:54 -07001919
1920 if (!ret)
1921 return 0;
1922
Tahsin Erdogan83f06162016-11-08 00:02:07 -08001923 ret = add_lock_to_list(hlock_class(prev),
Dave Jonesf82b2172008-08-11 09:30:23 +02001924 &hlock_class(next)->locks_before,
Byungchul Parkce07a9412017-08-07 16:12:51 +09001925 next->acquire_ip, distance, trace);
Peter Zijlstra8e182572007-07-19 01:48:54 -07001926 if (!ret)
1927 return 0;
1928
Byungchul Park70911fd2017-08-07 16:12:50 +09001929 return 2;
Peter Zijlstra8e182572007-07-19 01:48:54 -07001930}
1931
1932/*
1933 * Add the dependency to all directly-previous locks that are 'relevant'.
1934 * The ones that are relevant are (in increasing distance from curr):
1935 * all consecutive trylock entries and the final non-trylock entry - or
1936 * the end of this context's lock-chain - whichever comes first.
1937 */
1938static int
1939check_prevs_add(struct task_struct *curr, struct held_lock *next)
1940{
1941 int depth = curr->lockdep_depth;
1942 struct held_lock *hlock;
Peter Zijlstra8b405d52017-10-04 11:13:37 +02001943 struct stack_trace trace = {
1944 .nr_entries = 0,
1945 .max_entries = 0,
1946 .entries = NULL,
1947 .skip = 0,
1948 };
Peter Zijlstra8e182572007-07-19 01:48:54 -07001949
1950 /*
1951 * Debugging checks.
1952 *
1953 * Depth must not be zero for a non-head lock:
1954 */
1955 if (!depth)
1956 goto out_bug;
1957 /*
1958 * At least two relevant locks must exist for this
1959 * to be a head:
1960 */
1961 if (curr->held_locks[depth].irq_context !=
1962 curr->held_locks[depth-1].irq_context)
1963 goto out_bug;
1964
1965 for (;;) {
1966 int distance = curr->lockdep_depth - depth + 1;
Oleg Nesterov1b5ff812014-01-20 19:20:10 +01001967 hlock = curr->held_locks + depth - 1;
Byungchul Parkce07a9412017-08-07 16:12:51 +09001968
Ingo Molnare966eae2017-12-12 12:31:16 +01001969 /*
1970 * Only non-recursive-read entries get new dependencies
1971 * added:
1972 */
1973 if (hlock->read != 2 && hlock->check) {
1974 int ret = check_prev_add(curr, hlock, next, distance, &trace, save_trace);
1975 if (!ret)
1976 return 0;
1977
1978 /*
1979 * Stop after the first non-trylock entry,
1980 * as non-trylock entries have added their
1981 * own direct dependencies already, so this
1982 * lock is connected to them indirectly:
1983 */
1984 if (!hlock->trylock)
1985 break;
Peter Zijlstra8e182572007-07-19 01:48:54 -07001986 }
Ingo Molnare966eae2017-12-12 12:31:16 +01001987
Peter Zijlstra8e182572007-07-19 01:48:54 -07001988 depth--;
1989 /*
1990 * End of lock-stack?
1991 */
1992 if (!depth)
1993 break;
1994 /*
1995 * Stop the search if we cross into another context:
1996 */
1997 if (curr->held_locks[depth].irq_context !=
1998 curr->held_locks[depth-1].irq_context)
1999 break;
2000 }
2001 return 1;
2002out_bug:
2003 if (!debug_locks_off_graph_unlock())
2004 return 0;
2005
Peter Zijlstra0119fee2011-09-02 01:30:29 +02002006 /*
2007 * Clearly we all shouldn't be here, but since we made it we
2008 * can reliable say we messed up our state. See the above two
2009 * gotos for reasons why we could possibly end up here.
2010 */
Peter Zijlstra8e182572007-07-19 01:48:54 -07002011 WARN_ON(1);
2012
2013 return 0;
2014}
2015
2016unsigned long nr_lock_chains;
Huang, Ying443cd502008-06-20 16:39:21 +08002017struct lock_chain lock_chains[MAX_LOCKDEP_CHAINS];
Huang, Yingcd1a28e2008-06-23 11:20:54 +08002018int nr_chain_hlocks;
Huang, Ying443cd502008-06-20 16:39:21 +08002019static u16 chain_hlocks[MAX_LOCKDEP_CHAIN_HLOCKS];
2020
2021struct lock_class *lock_chain_get_class(struct lock_chain *chain, int i)
2022{
2023 return lock_classes + chain_hlocks[chain->base + i];
2024}
Peter Zijlstra8e182572007-07-19 01:48:54 -07002025
2026/*
Ingo Molnar9e4e7552016-02-29 10:03:58 +01002027 * Returns the index of the first held_lock of the current chain
2028 */
2029static inline int get_first_held_lock(struct task_struct *curr,
2030 struct held_lock *hlock)
2031{
2032 int i;
2033 struct held_lock *hlock_curr;
2034
2035 for (i = curr->lockdep_depth - 1; i >= 0; i--) {
2036 hlock_curr = curr->held_locks + i;
2037 if (hlock_curr->irq_context != hlock->irq_context)
2038 break;
2039
2040 }
2041
2042 return ++i;
2043}
2044
Borislav Petkov5c8a0102016-04-04 10:42:07 +02002045#ifdef CONFIG_DEBUG_LOCKDEP
Ingo Molnar9e4e7552016-02-29 10:03:58 +01002046/*
Alfredo Alvarez Fernandez39e2e172016-03-30 19:03:36 +02002047 * Returns the next chain_key iteration
2048 */
2049static u64 print_chain_key_iteration(int class_idx, u64 chain_key)
2050{
2051 u64 new_chain_key = iterate_chain_key(chain_key, class_idx);
2052
2053 printk(" class_idx:%d -> chain_key:%016Lx",
2054 class_idx,
2055 (unsigned long long)new_chain_key);
2056 return new_chain_key;
2057}
2058
2059static void
2060print_chain_keys_held_locks(struct task_struct *curr, struct held_lock *hlock_next)
2061{
2062 struct held_lock *hlock;
2063 u64 chain_key = 0;
2064 int depth = curr->lockdep_depth;
2065 int i;
2066
2067 printk("depth: %u\n", depth + 1);
2068 for (i = get_first_held_lock(curr, hlock_next); i < depth; i++) {
2069 hlock = curr->held_locks + i;
2070 chain_key = print_chain_key_iteration(hlock->class_idx, chain_key);
2071
2072 print_lock(hlock);
2073 }
2074
2075 print_chain_key_iteration(hlock_next->class_idx, chain_key);
2076 print_lock(hlock_next);
2077}
2078
2079static void print_chain_keys_chain(struct lock_chain *chain)
2080{
2081 int i;
2082 u64 chain_key = 0;
2083 int class_id;
2084
2085 printk("depth: %u\n", chain->depth);
2086 for (i = 0; i < chain->depth; i++) {
2087 class_id = chain_hlocks[chain->base + i];
2088 chain_key = print_chain_key_iteration(class_id + 1, chain_key);
2089
2090 print_lock_name(lock_classes + class_id);
2091 printk("\n");
2092 }
2093}
2094
2095static void print_collision(struct task_struct *curr,
2096 struct held_lock *hlock_next,
2097 struct lock_chain *chain)
2098{
Paul E. McKenney681fbec2017-05-04 15:44:38 -07002099 pr_warn("\n");
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08002100 pr_warn("============================\n");
2101 pr_warn("WARNING: chain_key collision\n");
Alfredo Alvarez Fernandez39e2e172016-03-30 19:03:36 +02002102 print_kernel_ident();
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08002103 pr_warn("----------------------------\n");
Paul E. McKenney681fbec2017-05-04 15:44:38 -07002104 pr_warn("%s/%d: ", current->comm, task_pid_nr(current));
2105 pr_warn("Hash chain already cached but the contents don't match!\n");
Alfredo Alvarez Fernandez39e2e172016-03-30 19:03:36 +02002106
Paul E. McKenney681fbec2017-05-04 15:44:38 -07002107 pr_warn("Held locks:");
Alfredo Alvarez Fernandez39e2e172016-03-30 19:03:36 +02002108 print_chain_keys_held_locks(curr, hlock_next);
2109
Paul E. McKenney681fbec2017-05-04 15:44:38 -07002110 pr_warn("Locks in cached chain:");
Alfredo Alvarez Fernandez39e2e172016-03-30 19:03:36 +02002111 print_chain_keys_chain(chain);
2112
Paul E. McKenney681fbec2017-05-04 15:44:38 -07002113 pr_warn("\nstack backtrace:\n");
Alfredo Alvarez Fernandez39e2e172016-03-30 19:03:36 +02002114 dump_stack();
2115}
Borislav Petkov5c8a0102016-04-04 10:42:07 +02002116#endif
Alfredo Alvarez Fernandez39e2e172016-03-30 19:03:36 +02002117
2118/*
Ingo Molnar9e4e7552016-02-29 10:03:58 +01002119 * Checks whether the chain and the current held locks are consistent
2120 * in depth and also in content. If they are not it most likely means
2121 * that there was a collision during the calculation of the chain_key.
2122 * Returns: 0 not passed, 1 passed
2123 */
2124static int check_no_collision(struct task_struct *curr,
2125 struct held_lock *hlock,
2126 struct lock_chain *chain)
2127{
2128#ifdef CONFIG_DEBUG_LOCKDEP
2129 int i, j, id;
2130
2131 i = get_first_held_lock(curr, hlock);
2132
Alfredo Alvarez Fernandez39e2e172016-03-30 19:03:36 +02002133 if (DEBUG_LOCKS_WARN_ON(chain->depth != curr->lockdep_depth - (i - 1))) {
2134 print_collision(curr, hlock, chain);
Ingo Molnar9e4e7552016-02-29 10:03:58 +01002135 return 0;
Alfredo Alvarez Fernandez39e2e172016-03-30 19:03:36 +02002136 }
Ingo Molnar9e4e7552016-02-29 10:03:58 +01002137
2138 for (j = 0; j < chain->depth - 1; j++, i++) {
2139 id = curr->held_locks[i].class_idx - 1;
2140
Alfredo Alvarez Fernandez39e2e172016-03-30 19:03:36 +02002141 if (DEBUG_LOCKS_WARN_ON(chain_hlocks[chain->base + j] != id)) {
2142 print_collision(curr, hlock, chain);
Ingo Molnar9e4e7552016-02-29 10:03:58 +01002143 return 0;
Alfredo Alvarez Fernandez39e2e172016-03-30 19:03:36 +02002144 }
Ingo Molnar9e4e7552016-02-29 10:03:58 +01002145 }
2146#endif
2147 return 1;
2148}
2149
2150/*
Byungchul Park49347a92017-08-07 16:12:49 +09002151 * This is for building a chain between just two different classes,
2152 * instead of adding a new hlock upon current, which is done by
2153 * add_chain_cache().
2154 *
2155 * This can be called in any context with two classes, while
2156 * add_chain_cache() must be done within the lock owener's context
2157 * since it uses hlock which might be racy in another context.
2158 */
2159static inline int add_chain_cache_classes(unsigned int prev,
2160 unsigned int next,
2161 unsigned int irq_context,
2162 u64 chain_key)
2163{
2164 struct hlist_head *hash_head = chainhashentry(chain_key);
2165 struct lock_chain *chain;
2166
2167 /*
2168 * Allocate a new chain entry from the static array, and add
2169 * it to the hash:
2170 */
2171
2172 /*
2173 * We might need to take the graph lock, ensure we've got IRQs
2174 * disabled to make this an IRQ-safe lock.. for recursion reasons
2175 * lockdep won't complain about its own locking errors.
2176 */
2177 if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
2178 return 0;
2179
2180 if (unlikely(nr_lock_chains >= MAX_LOCKDEP_CHAINS)) {
2181 if (!debug_locks_off_graph_unlock())
2182 return 0;
2183
2184 print_lockdep_off("BUG: MAX_LOCKDEP_CHAINS too low!");
2185 dump_stack();
2186 return 0;
2187 }
2188
2189 chain = lock_chains + nr_lock_chains++;
2190 chain->chain_key = chain_key;
2191 chain->irq_context = irq_context;
2192 chain->depth = 2;
2193 if (likely(nr_chain_hlocks + chain->depth <= MAX_LOCKDEP_CHAIN_HLOCKS)) {
2194 chain->base = nr_chain_hlocks;
2195 nr_chain_hlocks += chain->depth;
2196 chain_hlocks[chain->base] = prev - 1;
2197 chain_hlocks[chain->base + 1] = next -1;
2198 }
2199#ifdef CONFIG_DEBUG_LOCKDEP
2200 /*
2201 * Important for check_no_collision().
2202 */
2203 else {
2204 if (!debug_locks_off_graph_unlock())
2205 return 0;
2206
2207 print_lockdep_off("BUG: MAX_LOCKDEP_CHAIN_HLOCKS too low!");
2208 dump_stack();
2209 return 0;
2210 }
2211#endif
2212
2213 hlist_add_head_rcu(&chain->entry, hash_head);
2214 debug_atomic_inc(chain_lookup_misses);
2215 inc_chains();
2216
2217 return 1;
2218}
2219
2220/*
Byungchul Park545c23f2017-08-07 16:12:48 +09002221 * Adds a dependency chain into chain hashtable. And must be called with
2222 * graph_lock held.
2223 *
2224 * Return 0 if fail, and graph_lock is released.
2225 * Return 1 if succeed, with graph_lock held.
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002226 */
Byungchul Park545c23f2017-08-07 16:12:48 +09002227static inline int add_chain_cache(struct task_struct *curr,
2228 struct held_lock *hlock,
2229 u64 chain_key)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002230{
Dave Jonesf82b2172008-08-11 09:30:23 +02002231 struct lock_class *class = hlock_class(hlock);
Andrew Mortona63f38c2016-02-03 13:44:12 -08002232 struct hlist_head *hash_head = chainhashentry(chain_key);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002233 struct lock_chain *chain;
Steven Rostedte0944ee2011-04-20 21:42:00 -04002234 int i, j;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002235
Peter Zijlstra0119fee2011-09-02 01:30:29 +02002236 /*
Byungchul Park545c23f2017-08-07 16:12:48 +09002237 * Allocate a new chain entry from the static array, and add
2238 * it to the hash:
2239 */
2240
2241 /*
Peter Zijlstra0119fee2011-09-02 01:30:29 +02002242 * We might need to take the graph lock, ensure we've got IRQs
2243 * disabled to make this an IRQ-safe lock.. for recursion reasons
2244 * lockdep won't complain about its own locking errors.
2245 */
Jarek Poplawski381a2292007-02-10 01:44:58 -08002246 if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
2247 return 0;
Ingo Molnar9e4e7552016-02-29 10:03:58 +01002248
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002249 if (unlikely(nr_lock_chains >= MAX_LOCKDEP_CHAINS)) {
Ingo Molnar74c383f2006-12-13 00:34:43 -08002250 if (!debug_locks_off_graph_unlock())
2251 return 0;
2252
Dave Jones2c522832013-04-25 13:40:02 -04002253 print_lockdep_off("BUG: MAX_LOCKDEP_CHAINS too low!");
Peter Zijlstraeedeeab2009-03-18 12:38:47 +01002254 dump_stack();
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002255 return 0;
2256 }
2257 chain = lock_chains + nr_lock_chains++;
2258 chain->chain_key = chain_key;
Huang, Ying443cd502008-06-20 16:39:21 +08002259 chain->irq_context = hlock->irq_context;
Ingo Molnar9e4e7552016-02-29 10:03:58 +01002260 i = get_first_held_lock(curr, hlock);
Huang, Ying443cd502008-06-20 16:39:21 +08002261 chain->depth = curr->lockdep_depth + 1 - i;
Peter Zijlstra75dd6022016-03-30 11:36:59 +02002262
2263 BUILD_BUG_ON((1UL << 24) <= ARRAY_SIZE(chain_hlocks));
2264 BUILD_BUG_ON((1UL << 6) <= ARRAY_SIZE(curr->held_locks));
2265 BUILD_BUG_ON((1UL << 8*sizeof(chain_hlocks[0])) <= ARRAY_SIZE(lock_classes));
2266
Steven Rostedte0944ee2011-04-20 21:42:00 -04002267 if (likely(nr_chain_hlocks + chain->depth <= MAX_LOCKDEP_CHAIN_HLOCKS)) {
2268 chain->base = nr_chain_hlocks;
Huang, Ying443cd502008-06-20 16:39:21 +08002269 for (j = 0; j < chain->depth - 1; j++, i++) {
Dave Jonesf82b2172008-08-11 09:30:23 +02002270 int lock_id = curr->held_locks[i].class_idx - 1;
Huang, Ying443cd502008-06-20 16:39:21 +08002271 chain_hlocks[chain->base + j] = lock_id;
2272 }
2273 chain_hlocks[chain->base + j] = class - lock_classes;
2274 }
Peter Zijlstra75dd6022016-03-30 11:36:59 +02002275
2276 if (nr_chain_hlocks < MAX_LOCKDEP_CHAIN_HLOCKS)
2277 nr_chain_hlocks += chain->depth;
2278
2279#ifdef CONFIG_DEBUG_LOCKDEP
2280 /*
2281 * Important for check_no_collision().
2282 */
2283 if (unlikely(nr_chain_hlocks > MAX_LOCKDEP_CHAIN_HLOCKS)) {
Byungchul Parkf9af4562017-01-13 11:42:04 +09002284 if (!debug_locks_off_graph_unlock())
Peter Zijlstra75dd6022016-03-30 11:36:59 +02002285 return 0;
2286
2287 print_lockdep_off("BUG: MAX_LOCKDEP_CHAIN_HLOCKS too low!");
2288 dump_stack();
2289 return 0;
2290 }
2291#endif
2292
Andrew Mortona63f38c2016-02-03 13:44:12 -08002293 hlist_add_head_rcu(&chain->entry, hash_head);
Frederic Weisbeckerbd6d29c2010-04-06 00:10:17 +02002294 debug_atomic_inc(chain_lookup_misses);
Peter Zijlstra8e182572007-07-19 01:48:54 -07002295 inc_chains();
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002296
2297 return 1;
2298}
Peter Zijlstra8e182572007-07-19 01:48:54 -07002299
Byungchul Park545c23f2017-08-07 16:12:48 +09002300/*
2301 * Look up a dependency chain.
2302 */
2303static inline struct lock_chain *lookup_chain_cache(u64 chain_key)
2304{
2305 struct hlist_head *hash_head = chainhashentry(chain_key);
2306 struct lock_chain *chain;
2307
2308 /*
2309 * We can walk it lock-free, because entries only get added
2310 * to the hash:
2311 */
2312 hlist_for_each_entry_rcu(chain, hash_head, entry) {
2313 if (chain->chain_key == chain_key) {
2314 debug_atomic_inc(chain_lookup_hits);
2315 return chain;
2316 }
2317 }
2318 return NULL;
2319}
2320
2321/*
2322 * If the key is not present yet in dependency chain cache then
2323 * add it and return 1 - in this case the new dependency chain is
2324 * validated. If the key is already hashed, return 0.
2325 * (On return with 1 graph_lock is held.)
2326 */
2327static inline int lookup_chain_cache_add(struct task_struct *curr,
2328 struct held_lock *hlock,
2329 u64 chain_key)
2330{
2331 struct lock_class *class = hlock_class(hlock);
2332 struct lock_chain *chain = lookup_chain_cache(chain_key);
2333
2334 if (chain) {
2335cache_hit:
2336 if (!check_no_collision(curr, hlock, chain))
2337 return 0;
2338
2339 if (very_verbose(class)) {
2340 printk("\nhash chain already cached, key: "
Borislav Petkov04860d42018-02-26 14:49:26 +01002341 "%016Lx tail class: [%px] %s\n",
Byungchul Park545c23f2017-08-07 16:12:48 +09002342 (unsigned long long)chain_key,
2343 class->key, class->name);
2344 }
2345
2346 return 0;
2347 }
2348
2349 if (very_verbose(class)) {
Borislav Petkov04860d42018-02-26 14:49:26 +01002350 printk("\nnew hash chain, key: %016Lx tail class: [%px] %s\n",
Byungchul Park545c23f2017-08-07 16:12:48 +09002351 (unsigned long long)chain_key, class->key, class->name);
2352 }
2353
2354 if (!graph_lock())
2355 return 0;
2356
2357 /*
2358 * We have to walk the chain again locked - to avoid duplicates:
2359 */
2360 chain = lookup_chain_cache(chain_key);
2361 if (chain) {
2362 graph_unlock();
2363 goto cache_hit;
2364 }
2365
2366 if (!add_chain_cache(curr, hlock, chain_key))
2367 return 0;
2368
2369 return 1;
2370}
2371
Peter Zijlstra8e182572007-07-19 01:48:54 -07002372static int validate_chain(struct task_struct *curr, struct lockdep_map *lock,
Johannes Berg4e6045f2007-10-18 23:39:55 -07002373 struct held_lock *hlock, int chain_head, u64 chain_key)
Peter Zijlstra8e182572007-07-19 01:48:54 -07002374{
2375 /*
2376 * Trylock needs to maintain the stack of held locks, but it
2377 * does not add new dependencies, because trylock can be done
2378 * in any order.
2379 *
2380 * We look up the chain_key and do the O(N^2) check and update of
2381 * the dependencies only if this is a new dependency chain.
Byungchul Park545c23f2017-08-07 16:12:48 +09002382 * (If lookup_chain_cache_add() return with 1 it acquires
Peter Zijlstra8e182572007-07-19 01:48:54 -07002383 * graph_lock for us)
2384 */
Oleg Nesterovfb9edbe2014-01-20 19:20:06 +01002385 if (!hlock->trylock && hlock->check &&
Byungchul Park545c23f2017-08-07 16:12:48 +09002386 lookup_chain_cache_add(curr, hlock, chain_key)) {
Peter Zijlstra8e182572007-07-19 01:48:54 -07002387 /*
2388 * Check whether last held lock:
2389 *
2390 * - is irq-safe, if this lock is irq-unsafe
2391 * - is softirq-safe, if this lock is hardirq-unsafe
2392 *
2393 * And check whether the new lock's dependency graph
2394 * could lead back to the previous lock.
2395 *
2396 * any of these scenarios could lead to a deadlock. If
2397 * All validations
2398 */
2399 int ret = check_deadlock(curr, hlock, lock, hlock->read);
2400
2401 if (!ret)
2402 return 0;
2403 /*
2404 * Mark recursive read, as we jump over it when
2405 * building dependencies (just like we jump over
2406 * trylock entries):
2407 */
2408 if (ret == 2)
2409 hlock->read = 2;
2410 /*
2411 * Add dependency only if this lock is not the head
2412 * of the chain, and if it's not a secondary read-lock:
2413 */
Byungchul Park545c23f2017-08-07 16:12:48 +09002414 if (!chain_head && ret != 2) {
Peter Zijlstra8e182572007-07-19 01:48:54 -07002415 if (!check_prevs_add(curr, hlock))
2416 return 0;
Byungchul Park545c23f2017-08-07 16:12:48 +09002417 }
2418
Peter Zijlstra8e182572007-07-19 01:48:54 -07002419 graph_unlock();
Byungchul Park545c23f2017-08-07 16:12:48 +09002420 } else {
2421 /* after lookup_chain_cache_add(): */
Peter Zijlstra8e182572007-07-19 01:48:54 -07002422 if (unlikely(!debug_locks))
2423 return 0;
Byungchul Park545c23f2017-08-07 16:12:48 +09002424 }
Peter Zijlstra8e182572007-07-19 01:48:54 -07002425
2426 return 1;
2427}
2428#else
2429static inline int validate_chain(struct task_struct *curr,
2430 struct lockdep_map *lock, struct held_lock *hlock,
Gregory Haskins3aa416b2007-10-11 22:11:11 +02002431 int chain_head, u64 chain_key)
Peter Zijlstra8e182572007-07-19 01:48:54 -07002432{
2433 return 1;
2434}
Peter Zijlstraca58abc2007-07-19 01:48:53 -07002435#endif
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002436
2437/*
2438 * We are building curr_chain_key incrementally, so double-check
2439 * it from scratch, to make sure that it's done correctly:
2440 */
Steven Rostedt1d09daa2008-05-12 21:20:55 +02002441static void check_chain_key(struct task_struct *curr)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002442{
2443#ifdef CONFIG_DEBUG_LOCKDEP
2444 struct held_lock *hlock, *prev_hlock = NULL;
Alfredo Alvarez Fernandez5f18ab52016-02-11 00:33:32 +01002445 unsigned int i;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002446 u64 chain_key = 0;
2447
2448 for (i = 0; i < curr->lockdep_depth; i++) {
2449 hlock = curr->held_locks + i;
2450 if (chain_key != hlock->prev_chain_key) {
2451 debug_locks_off();
Peter Zijlstra0119fee2011-09-02 01:30:29 +02002452 /*
2453 * We got mighty confused, our chain keys don't match
2454 * with what we expect, someone trample on our task state?
2455 */
Arjan van de Ven2df8b1d2008-07-30 12:43:11 -07002456 WARN(1, "hm#1, depth: %u [%u], %016Lx != %016Lx\n",
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002457 curr->lockdep_depth, i,
2458 (unsigned long long)chain_key,
2459 (unsigned long long)hlock->prev_chain_key);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002460 return;
2461 }
Peter Zijlstra0119fee2011-09-02 01:30:29 +02002462 /*
2463 * Whoops ran out of static storage again?
2464 */
Alfredo Alvarez Fernandez5f18ab52016-02-11 00:33:32 +01002465 if (DEBUG_LOCKS_WARN_ON(hlock->class_idx > MAX_LOCKDEP_KEYS))
Jarek Poplawski381a2292007-02-10 01:44:58 -08002466 return;
2467
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002468 if (prev_hlock && (prev_hlock->irq_context !=
2469 hlock->irq_context))
2470 chain_key = 0;
Alfredo Alvarez Fernandez5f18ab52016-02-11 00:33:32 +01002471 chain_key = iterate_chain_key(chain_key, hlock->class_idx);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002472 prev_hlock = hlock;
2473 }
2474 if (chain_key != curr->curr_chain_key) {
2475 debug_locks_off();
Peter Zijlstra0119fee2011-09-02 01:30:29 +02002476 /*
2477 * More smoking hash instead of calculating it, damn see these
2478 * numbers float.. I bet that a pink elephant stepped on my memory.
2479 */
Arjan van de Ven2df8b1d2008-07-30 12:43:11 -07002480 WARN(1, "hm#2, depth: %u [%u], %016Lx != %016Lx\n",
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002481 curr->lockdep_depth, i,
2482 (unsigned long long)chain_key,
2483 (unsigned long long)curr->curr_chain_key);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002484 }
2485#endif
2486}
2487
Steven Rostedt282b5c22011-04-20 21:41:59 -04002488static void
2489print_usage_bug_scenario(struct held_lock *lock)
2490{
2491 struct lock_class *class = hlock_class(lock);
2492
2493 printk(" Possible unsafe locking scenario:\n\n");
2494 printk(" CPU0\n");
2495 printk(" ----\n");
2496 printk(" lock(");
2497 __print_lock_name(class);
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01002498 printk(KERN_CONT ");\n");
Steven Rostedt282b5c22011-04-20 21:41:59 -04002499 printk(" <Interrupt>\n");
2500 printk(" lock(");
2501 __print_lock_name(class);
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01002502 printk(KERN_CONT ");\n");
Steven Rostedt282b5c22011-04-20 21:41:59 -04002503 printk("\n *** DEADLOCK ***\n\n");
2504}
2505
Peter Zijlstra8e182572007-07-19 01:48:54 -07002506static int
2507print_usage_bug(struct task_struct *curr, struct held_lock *this,
2508 enum lock_usage_bit prev_bit, enum lock_usage_bit new_bit)
2509{
2510 if (!debug_locks_off_graph_unlock() || debug_locks_silent)
2511 return 0;
2512
Paul E. McKenney681fbec2017-05-04 15:44:38 -07002513 pr_warn("\n");
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08002514 pr_warn("================================\n");
2515 pr_warn("WARNING: inconsistent lock state\n");
Ben Hutchingsfbdc4b92011-10-28 04:36:55 +01002516 print_kernel_ident();
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08002517 pr_warn("--------------------------------\n");
Peter Zijlstra8e182572007-07-19 01:48:54 -07002518
Paul E. McKenney681fbec2017-05-04 15:44:38 -07002519 pr_warn("inconsistent {%s} -> {%s} usage.\n",
Peter Zijlstra8e182572007-07-19 01:48:54 -07002520 usage_str[prev_bit], usage_str[new_bit]);
2521
Paul E. McKenney681fbec2017-05-04 15:44:38 -07002522 pr_warn("%s/%d [HC%u[%lu]:SC%u[%lu]:HE%u:SE%u] takes:\n",
Pavel Emelyanovba25f9d2007-10-18 23:40:40 -07002523 curr->comm, task_pid_nr(curr),
Peter Zijlstra8e182572007-07-19 01:48:54 -07002524 trace_hardirq_context(curr), hardirq_count() >> HARDIRQ_SHIFT,
2525 trace_softirq_context(curr), softirq_count() >> SOFTIRQ_SHIFT,
2526 trace_hardirqs_enabled(curr),
2527 trace_softirqs_enabled(curr));
2528 print_lock(this);
2529
Paul E. McKenney681fbec2017-05-04 15:44:38 -07002530 pr_warn("{%s} state was registered at:\n", usage_str[prev_bit]);
Dave Jonesf82b2172008-08-11 09:30:23 +02002531 print_stack_trace(hlock_class(this)->usage_traces + prev_bit, 1);
Peter Zijlstra8e182572007-07-19 01:48:54 -07002532
2533 print_irqtrace_events(curr);
Paul E. McKenney681fbec2017-05-04 15:44:38 -07002534 pr_warn("\nother info that might help us debug this:\n");
Steven Rostedt282b5c22011-04-20 21:41:59 -04002535 print_usage_bug_scenario(this);
2536
Peter Zijlstra8e182572007-07-19 01:48:54 -07002537 lockdep_print_held_locks(curr);
2538
Paul E. McKenney681fbec2017-05-04 15:44:38 -07002539 pr_warn("\nstack backtrace:\n");
Peter Zijlstra8e182572007-07-19 01:48:54 -07002540 dump_stack();
2541
2542 return 0;
2543}
2544
2545/*
2546 * Print out an error if an invalid bit is set:
2547 */
2548static inline int
2549valid_state(struct task_struct *curr, struct held_lock *this,
2550 enum lock_usage_bit new_bit, enum lock_usage_bit bad_bit)
2551{
Dave Jonesf82b2172008-08-11 09:30:23 +02002552 if (unlikely(hlock_class(this)->usage_mask & (1 << bad_bit)))
Peter Zijlstra8e182572007-07-19 01:48:54 -07002553 return print_usage_bug(curr, this, bad_bit, new_bit);
2554 return 1;
2555}
2556
2557static int mark_lock(struct task_struct *curr, struct held_lock *this,
2558 enum lock_usage_bit new_bit);
2559
Steven Rostedt81d68a92008-05-12 21:20:42 +02002560#if defined(CONFIG_TRACE_IRQFLAGS) && defined(CONFIG_PROVE_LOCKING)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002561
2562/*
2563 * print irq inversion bug:
2564 */
2565static int
Ming Lei24208ca2009-07-16 15:44:29 +02002566print_irq_inversion_bug(struct task_struct *curr,
2567 struct lock_list *root, struct lock_list *other,
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002568 struct held_lock *this, int forwards,
2569 const char *irqclass)
2570{
Steven Rostedtdad3d742011-04-20 21:41:57 -04002571 struct lock_list *entry = other;
2572 struct lock_list *middle = NULL;
2573 int depth;
2574
Ingo Molnar74c383f2006-12-13 00:34:43 -08002575 if (!debug_locks_off_graph_unlock() || debug_locks_silent)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002576 return 0;
2577
Paul E. McKenney681fbec2017-05-04 15:44:38 -07002578 pr_warn("\n");
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08002579 pr_warn("========================================================\n");
2580 pr_warn("WARNING: possible irq lock inversion dependency detected\n");
Ben Hutchingsfbdc4b92011-10-28 04:36:55 +01002581 print_kernel_ident();
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08002582 pr_warn("--------------------------------------------------------\n");
Paul E. McKenney681fbec2017-05-04 15:44:38 -07002583 pr_warn("%s/%d just changed the state of lock:\n",
Pavel Emelyanovba25f9d2007-10-18 23:40:40 -07002584 curr->comm, task_pid_nr(curr));
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002585 print_lock(this);
2586 if (forwards)
Paul E. McKenney681fbec2017-05-04 15:44:38 -07002587 pr_warn("but this lock took another, %s-unsafe lock in the past:\n", irqclass);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002588 else
Paul E. McKenney681fbec2017-05-04 15:44:38 -07002589 pr_warn("but this lock was taken by another, %s-safe lock in the past:\n", irqclass);
Ming Lei24208ca2009-07-16 15:44:29 +02002590 print_lock_name(other->class);
Paul E. McKenney681fbec2017-05-04 15:44:38 -07002591 pr_warn("\n\nand interrupts could create inverse lock ordering between them.\n\n");
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002592
Paul E. McKenney681fbec2017-05-04 15:44:38 -07002593 pr_warn("\nother info that might help us debug this:\n");
Steven Rostedtdad3d742011-04-20 21:41:57 -04002594
2595 /* Find a middle lock (if one exists) */
2596 depth = get_lock_depth(other);
2597 do {
2598 if (depth == 0 && (entry != root)) {
Paul E. McKenney681fbec2017-05-04 15:44:38 -07002599 pr_warn("lockdep:%s bad path found in chain graph\n", __func__);
Steven Rostedtdad3d742011-04-20 21:41:57 -04002600 break;
2601 }
2602 middle = entry;
2603 entry = get_lock_parent(entry);
2604 depth--;
2605 } while (entry && entry != root && (depth >= 0));
2606 if (forwards)
2607 print_irq_lock_scenario(root, other,
2608 middle ? middle->class : root->class, other->class);
2609 else
2610 print_irq_lock_scenario(other, root,
2611 middle ? middle->class : other->class, root->class);
2612
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002613 lockdep_print_held_locks(curr);
2614
Paul E. McKenney681fbec2017-05-04 15:44:38 -07002615 pr_warn("\nthe shortest dependencies between 2nd lock and 1st lock:\n");
Ming Lei24208ca2009-07-16 15:44:29 +02002616 if (!save_trace(&root->trace))
2617 return 0;
2618 print_shortest_lock_dependencies(other, root);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002619
Paul E. McKenney681fbec2017-05-04 15:44:38 -07002620 pr_warn("\nstack backtrace:\n");
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002621 dump_stack();
2622
2623 return 0;
2624}
2625
2626/*
2627 * Prove that in the forwards-direction subgraph starting at <this>
2628 * there is no lock matching <mask>:
2629 */
2630static int
2631check_usage_forwards(struct task_struct *curr, struct held_lock *this,
2632 enum lock_usage_bit bit, const char *irqclass)
2633{
2634 int ret;
Ming Leid7aaba12009-07-16 15:44:29 +02002635 struct lock_list root;
2636 struct lock_list *uninitialized_var(target_entry);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002637
Ming Leid7aaba12009-07-16 15:44:29 +02002638 root.parent = NULL;
2639 root.class = hlock_class(this);
2640 ret = find_usage_forwards(&root, bit, &target_entry);
Peter Zijlstraaf012962009-07-16 15:44:29 +02002641 if (ret < 0)
2642 return print_bfs_bug(ret);
2643 if (ret == 1)
2644 return ret;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002645
Ming Lei24208ca2009-07-16 15:44:29 +02002646 return print_irq_inversion_bug(curr, &root, target_entry,
Ming Leid7aaba12009-07-16 15:44:29 +02002647 this, 1, irqclass);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002648}
2649
2650/*
2651 * Prove that in the backwards-direction subgraph starting at <this>
2652 * there is no lock matching <mask>:
2653 */
2654static int
2655check_usage_backwards(struct task_struct *curr, struct held_lock *this,
2656 enum lock_usage_bit bit, const char *irqclass)
2657{
2658 int ret;
Ming Leid7aaba12009-07-16 15:44:29 +02002659 struct lock_list root;
2660 struct lock_list *uninitialized_var(target_entry);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002661
Ming Leid7aaba12009-07-16 15:44:29 +02002662 root.parent = NULL;
2663 root.class = hlock_class(this);
2664 ret = find_usage_backwards(&root, bit, &target_entry);
Peter Zijlstraaf012962009-07-16 15:44:29 +02002665 if (ret < 0)
2666 return print_bfs_bug(ret);
2667 if (ret == 1)
2668 return ret;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002669
Ming Lei24208ca2009-07-16 15:44:29 +02002670 return print_irq_inversion_bug(curr, &root, target_entry,
Oleg Nesterov48d50672010-01-26 19:16:41 +01002671 this, 0, irqclass);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002672}
2673
Ingo Molnar3117df02006-12-13 00:34:43 -08002674void print_irqtrace_events(struct task_struct *curr)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002675{
2676 printk("irq event stamp: %u\n", curr->irq_events);
Borislav Petkov04860d42018-02-26 14:49:26 +01002677 printk("hardirqs last enabled at (%u): [<%px>] %pS\n",
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01002678 curr->hardirq_enable_event, (void *)curr->hardirq_enable_ip,
2679 (void *)curr->hardirq_enable_ip);
Borislav Petkov04860d42018-02-26 14:49:26 +01002680 printk("hardirqs last disabled at (%u): [<%px>] %pS\n",
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01002681 curr->hardirq_disable_event, (void *)curr->hardirq_disable_ip,
2682 (void *)curr->hardirq_disable_ip);
Borislav Petkov04860d42018-02-26 14:49:26 +01002683 printk("softirqs last enabled at (%u): [<%px>] %pS\n",
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01002684 curr->softirq_enable_event, (void *)curr->softirq_enable_ip,
2685 (void *)curr->softirq_enable_ip);
Borislav Petkov04860d42018-02-26 14:49:26 +01002686 printk("softirqs last disabled at (%u): [<%px>] %pS\n",
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01002687 curr->softirq_disable_event, (void *)curr->softirq_disable_ip,
2688 (void *)curr->softirq_disable_ip);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002689}
2690
Peter Zijlstracd953022009-01-22 16:38:21 +01002691static int HARDIRQ_verbose(struct lock_class *class)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002692{
Peter Zijlstra8e182572007-07-19 01:48:54 -07002693#if HARDIRQ_VERBOSE
2694 return class_filter(class);
2695#endif
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002696 return 0;
2697}
2698
Peter Zijlstracd953022009-01-22 16:38:21 +01002699static int SOFTIRQ_verbose(struct lock_class *class)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002700{
Peter Zijlstra8e182572007-07-19 01:48:54 -07002701#if SOFTIRQ_VERBOSE
2702 return class_filter(class);
2703#endif
2704 return 0;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002705}
2706
2707#define STRICT_READ_CHECKS 1
2708
Peter Zijlstracd953022009-01-22 16:38:21 +01002709static int (*state_verbose_f[])(struct lock_class *class) = {
2710#define LOCKDEP_STATE(__STATE) \
2711 __STATE##_verbose,
2712#include "lockdep_states.h"
2713#undef LOCKDEP_STATE
2714};
2715
2716static inline int state_verbose(enum lock_usage_bit bit,
2717 struct lock_class *class)
2718{
2719 return state_verbose_f[bit >> 2](class);
2720}
2721
Peter Zijlstra42c50d52009-01-22 16:58:16 +01002722typedef int (*check_usage_f)(struct task_struct *, struct held_lock *,
2723 enum lock_usage_bit bit, const char *name);
2724
Peter Zijlstra6a6904d2009-01-22 16:07:44 +01002725static int
Peter Zijlstra1c21f142009-03-04 13:51:13 +01002726mark_lock_irq(struct task_struct *curr, struct held_lock *this,
2727 enum lock_usage_bit new_bit)
Peter Zijlstra6a6904d2009-01-22 16:07:44 +01002728{
Peter Zijlstraf9892092009-01-22 16:09:59 +01002729 int excl_bit = exclusive_bit(new_bit);
Peter Zijlstra9d3651a2009-01-22 17:18:32 +01002730 int read = new_bit & 1;
Peter Zijlstra42c50d52009-01-22 16:58:16 +01002731 int dir = new_bit & 2;
2732
Peter Zijlstra38aa2712009-01-27 14:53:50 +01002733 /*
2734 * mark USED_IN has to look forwards -- to ensure no dependency
2735 * has ENABLED state, which would allow recursion deadlocks.
2736 *
2737 * mark ENABLED has to look backwards -- to ensure no dependee
2738 * has USED_IN state, which, again, would allow recursion deadlocks.
2739 */
Peter Zijlstra42c50d52009-01-22 16:58:16 +01002740 check_usage_f usage = dir ?
2741 check_usage_backwards : check_usage_forwards;
Peter Zijlstraf9892092009-01-22 16:09:59 +01002742
Peter Zijlstra38aa2712009-01-27 14:53:50 +01002743 /*
2744 * Validate that this particular lock does not have conflicting
2745 * usage states.
2746 */
Peter Zijlstra6a6904d2009-01-22 16:07:44 +01002747 if (!valid_state(curr, this, new_bit, excl_bit))
2748 return 0;
Peter Zijlstra9d3651a2009-01-22 17:18:32 +01002749
Peter Zijlstra38aa2712009-01-27 14:53:50 +01002750 /*
2751 * Validate that the lock dependencies don't have conflicting usage
2752 * states.
2753 */
2754 if ((!read || !dir || STRICT_READ_CHECKS) &&
Peter Zijlstra1c21f142009-03-04 13:51:13 +01002755 !usage(curr, this, excl_bit, state_name(new_bit & ~1)))
Peter Zijlstra6a6904d2009-01-22 16:07:44 +01002756 return 0;
Peter Zijlstra780e8202009-01-22 16:51:29 +01002757
Peter Zijlstra38aa2712009-01-27 14:53:50 +01002758 /*
2759 * Check for read in write conflicts
2760 */
2761 if (!read) {
2762 if (!valid_state(curr, this, new_bit, excl_bit + 1))
2763 return 0;
2764
2765 if (STRICT_READ_CHECKS &&
Peter Zijlstra4f367d8a2009-01-22 18:10:42 +01002766 !usage(curr, this, excl_bit + 1,
2767 state_name(new_bit + 1)))
Peter Zijlstra38aa2712009-01-27 14:53:50 +01002768 return 0;
2769 }
Peter Zijlstra780e8202009-01-22 16:51:29 +01002770
Peter Zijlstracd953022009-01-22 16:38:21 +01002771 if (state_verbose(new_bit, hlock_class(this)))
Peter Zijlstra6a6904d2009-01-22 16:07:44 +01002772 return 2;
2773
2774 return 1;
2775}
2776
Nick Piggincf40bd12009-01-21 08:12:39 +01002777enum mark_type {
Peter Zijlstra36bfb9b2009-01-22 14:12:41 +01002778#define LOCKDEP_STATE(__STATE) __STATE,
2779#include "lockdep_states.h"
2780#undef LOCKDEP_STATE
Nick Piggincf40bd12009-01-21 08:12:39 +01002781};
2782
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002783/*
2784 * Mark all held locks with a usage bit:
2785 */
Steven Rostedt1d09daa2008-05-12 21:20:55 +02002786static int
Nick Piggincf40bd12009-01-21 08:12:39 +01002787mark_held_locks(struct task_struct *curr, enum mark_type mark)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002788{
2789 enum lock_usage_bit usage_bit;
2790 struct held_lock *hlock;
2791 int i;
2792
2793 for (i = 0; i < curr->lockdep_depth; i++) {
2794 hlock = curr->held_locks + i;
2795
Peter Zijlstracf2ad4d2009-01-27 13:58:08 +01002796 usage_bit = 2 + (mark << 2); /* ENABLED */
2797 if (hlock->read)
2798 usage_bit += 1; /* READ */
2799
2800 BUG_ON(usage_bit >= LOCK_USAGE_STATES);
Nick Piggincf40bd12009-01-21 08:12:39 +01002801
Oleg Nesterov34d0ed52014-01-20 19:20:13 +01002802 if (!hlock->check)
Peter Zijlstraefbe2ee2011-07-07 11:39:45 +02002803 continue;
2804
Jarek Poplawski4ff773bb2007-05-08 00:31:00 -07002805 if (!mark_lock(curr, hlock, usage_bit))
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002806 return 0;
2807 }
2808
2809 return 1;
2810}
2811
2812/*
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002813 * Hardirqs will be enabled:
2814 */
Peter Zijlstradd4e5d32011-06-21 17:17:27 +02002815static void __trace_hardirqs_on_caller(unsigned long ip)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002816{
2817 struct task_struct *curr = current;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002818
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002819 /* we'll do an OFF -> ON transition: */
2820 curr->hardirqs_enabled = 1;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002821
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002822 /*
2823 * We are going to turn hardirqs on, so set the
2824 * usage bit for all held locks:
2825 */
Nick Piggincf40bd12009-01-21 08:12:39 +01002826 if (!mark_held_locks(curr, HARDIRQ))
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002827 return;
2828 /*
2829 * If we have softirqs enabled, then set the usage
2830 * bit for all held locks. (disabled hardirqs prevented
2831 * this bit from being set before)
2832 */
2833 if (curr->softirqs_enabled)
Nick Piggincf40bd12009-01-21 08:12:39 +01002834 if (!mark_held_locks(curr, SOFTIRQ))
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002835 return;
2836
2837 curr->hardirq_enable_ip = ip;
2838 curr->hardirq_enable_event = ++curr->irq_events;
Frederic Weisbeckerbd6d29c2010-04-06 00:10:17 +02002839 debug_atomic_inc(hardirqs_on_events);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002840}
Peter Zijlstradd4e5d32011-06-21 17:17:27 +02002841
Andi Kleenb35f8302014-02-08 08:52:02 +01002842__visible void trace_hardirqs_on_caller(unsigned long ip)
Peter Zijlstradd4e5d32011-06-21 17:17:27 +02002843{
2844 time_hardirqs_on(CALLER_ADDR0, ip);
2845
2846 if (unlikely(!debug_locks || current->lockdep_recursion))
2847 return;
2848
Peter Zijlstra7d36b262011-07-26 13:13:44 +02002849 if (unlikely(current->hardirqs_enabled)) {
2850 /*
2851 * Neither irq nor preemption are disabled here
2852 * so this is racy by nature but losing one hit
2853 * in a stat is not a big deal.
2854 */
2855 __debug_atomic_inc(redundant_hardirqs_on);
2856 return;
2857 }
2858
Peter Zijlstra0119fee2011-09-02 01:30:29 +02002859 /*
2860 * We're enabling irqs and according to our state above irqs weren't
2861 * already enabled, yet we find the hardware thinks they are in fact
2862 * enabled.. someone messed up their IRQ state tracing.
2863 */
Peter Zijlstradd4e5d32011-06-21 17:17:27 +02002864 if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
2865 return;
2866
Peter Zijlstra0119fee2011-09-02 01:30:29 +02002867 /*
2868 * See the fine text that goes along with this variable definition.
2869 */
Peter Zijlstra7d36b262011-07-26 13:13:44 +02002870 if (DEBUG_LOCKS_WARN_ON(unlikely(early_boot_irqs_disabled)))
2871 return;
2872
Peter Zijlstra0119fee2011-09-02 01:30:29 +02002873 /*
2874 * Can't allow enabling interrupts while in an interrupt handler,
2875 * that's general bad form and such. Recursion, limited stack etc..
2876 */
Peter Zijlstra7d36b262011-07-26 13:13:44 +02002877 if (DEBUG_LOCKS_WARN_ON(current->hardirq_context))
2878 return;
2879
Peter Zijlstradd4e5d32011-06-21 17:17:27 +02002880 current->lockdep_recursion = 1;
2881 __trace_hardirqs_on_caller(ip);
2882 current->lockdep_recursion = 0;
2883}
Steven Rostedt81d68a92008-05-12 21:20:42 +02002884EXPORT_SYMBOL(trace_hardirqs_on_caller);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002885
Steven Rostedt1d09daa2008-05-12 21:20:55 +02002886void trace_hardirqs_on(void)
Steven Rostedt81d68a92008-05-12 21:20:42 +02002887{
2888 trace_hardirqs_on_caller(CALLER_ADDR0);
2889}
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002890EXPORT_SYMBOL(trace_hardirqs_on);
2891
2892/*
2893 * Hardirqs were disabled:
2894 */
Andi Kleenb35f8302014-02-08 08:52:02 +01002895__visible void trace_hardirqs_off_caller(unsigned long ip)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002896{
2897 struct task_struct *curr = current;
2898
Heiko Carstens6afe40b2008-10-28 11:14:58 +01002899 time_hardirqs_off(CALLER_ADDR0, ip);
Steven Rostedt81d68a92008-05-12 21:20:42 +02002900
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002901 if (unlikely(!debug_locks || current->lockdep_recursion))
2902 return;
2903
Peter Zijlstra0119fee2011-09-02 01:30:29 +02002904 /*
2905 * So we're supposed to get called after you mask local IRQs, but for
2906 * some reason the hardware doesn't quite think you did a proper job.
2907 */
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002908 if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
2909 return;
2910
2911 if (curr->hardirqs_enabled) {
2912 /*
2913 * We have done an ON -> OFF transition:
2914 */
2915 curr->hardirqs_enabled = 0;
Heiko Carstens6afe40b2008-10-28 11:14:58 +01002916 curr->hardirq_disable_ip = ip;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002917 curr->hardirq_disable_event = ++curr->irq_events;
Frederic Weisbeckerbd6d29c2010-04-06 00:10:17 +02002918 debug_atomic_inc(hardirqs_off_events);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002919 } else
Frederic Weisbeckerbd6d29c2010-04-06 00:10:17 +02002920 debug_atomic_inc(redundant_hardirqs_off);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002921}
Steven Rostedt81d68a92008-05-12 21:20:42 +02002922EXPORT_SYMBOL(trace_hardirqs_off_caller);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002923
Steven Rostedt1d09daa2008-05-12 21:20:55 +02002924void trace_hardirqs_off(void)
Steven Rostedt81d68a92008-05-12 21:20:42 +02002925{
2926 trace_hardirqs_off_caller(CALLER_ADDR0);
2927}
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002928EXPORT_SYMBOL(trace_hardirqs_off);
2929
2930/*
2931 * Softirqs will be enabled:
2932 */
2933void trace_softirqs_on(unsigned long ip)
2934{
2935 struct task_struct *curr = current;
2936
Peter Zijlstradd4e5d32011-06-21 17:17:27 +02002937 if (unlikely(!debug_locks || current->lockdep_recursion))
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002938 return;
2939
Peter Zijlstra0119fee2011-09-02 01:30:29 +02002940 /*
2941 * We fancy IRQs being disabled here, see softirq.c, avoids
2942 * funny state and nesting things.
2943 */
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002944 if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
2945 return;
2946
2947 if (curr->softirqs_enabled) {
Frederic Weisbeckerbd6d29c2010-04-06 00:10:17 +02002948 debug_atomic_inc(redundant_softirqs_on);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002949 return;
2950 }
2951
Peter Zijlstradd4e5d32011-06-21 17:17:27 +02002952 current->lockdep_recursion = 1;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002953 /*
2954 * We'll do an OFF -> ON transition:
2955 */
2956 curr->softirqs_enabled = 1;
2957 curr->softirq_enable_ip = ip;
2958 curr->softirq_enable_event = ++curr->irq_events;
Frederic Weisbeckerbd6d29c2010-04-06 00:10:17 +02002959 debug_atomic_inc(softirqs_on_events);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002960 /*
2961 * We are going to turn softirqs on, so set the
2962 * usage bit for all held locks, if hardirqs are
2963 * enabled too:
2964 */
2965 if (curr->hardirqs_enabled)
Nick Piggincf40bd12009-01-21 08:12:39 +01002966 mark_held_locks(curr, SOFTIRQ);
Peter Zijlstradd4e5d32011-06-21 17:17:27 +02002967 current->lockdep_recursion = 0;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002968}
2969
2970/*
2971 * Softirqs were disabled:
2972 */
2973void trace_softirqs_off(unsigned long ip)
2974{
2975 struct task_struct *curr = current;
2976
Peter Zijlstradd4e5d32011-06-21 17:17:27 +02002977 if (unlikely(!debug_locks || current->lockdep_recursion))
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002978 return;
2979
Peter Zijlstra0119fee2011-09-02 01:30:29 +02002980 /*
2981 * We fancy IRQs being disabled here, see softirq.c
2982 */
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002983 if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
2984 return;
2985
2986 if (curr->softirqs_enabled) {
2987 /*
2988 * We have done an ON -> OFF transition:
2989 */
2990 curr->softirqs_enabled = 0;
2991 curr->softirq_disable_ip = ip;
2992 curr->softirq_disable_event = ++curr->irq_events;
Frederic Weisbeckerbd6d29c2010-04-06 00:10:17 +02002993 debug_atomic_inc(softirqs_off_events);
Peter Zijlstra0119fee2011-09-02 01:30:29 +02002994 /*
2995 * Whoops, we wanted softirqs off, so why aren't they?
2996 */
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002997 DEBUG_LOCKS_WARN_ON(!softirq_count());
2998 } else
Frederic Weisbeckerbd6d29c2010-04-06 00:10:17 +02002999 debug_atomic_inc(redundant_softirqs_off);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003000}
3001
Peter Zijlstra8e182572007-07-19 01:48:54 -07003002static int mark_irqflags(struct task_struct *curr, struct held_lock *hlock)
3003{
3004 /*
3005 * If non-trylock use in a hardirq or softirq context, then
3006 * mark the lock as used in these contexts:
3007 */
3008 if (!hlock->trylock) {
3009 if (hlock->read) {
3010 if (curr->hardirq_context)
3011 if (!mark_lock(curr, hlock,
3012 LOCK_USED_IN_HARDIRQ_READ))
3013 return 0;
3014 if (curr->softirq_context)
3015 if (!mark_lock(curr, hlock,
3016 LOCK_USED_IN_SOFTIRQ_READ))
3017 return 0;
3018 } else {
3019 if (curr->hardirq_context)
3020 if (!mark_lock(curr, hlock, LOCK_USED_IN_HARDIRQ))
3021 return 0;
3022 if (curr->softirq_context)
3023 if (!mark_lock(curr, hlock, LOCK_USED_IN_SOFTIRQ))
3024 return 0;
3025 }
3026 }
3027 if (!hlock->hardirqs_off) {
3028 if (hlock->read) {
3029 if (!mark_lock(curr, hlock,
Peter Zijlstra4fc95e82009-01-22 13:10:52 +01003030 LOCK_ENABLED_HARDIRQ_READ))
Peter Zijlstra8e182572007-07-19 01:48:54 -07003031 return 0;
3032 if (curr->softirqs_enabled)
3033 if (!mark_lock(curr, hlock,
Peter Zijlstra4fc95e82009-01-22 13:10:52 +01003034 LOCK_ENABLED_SOFTIRQ_READ))
Peter Zijlstra8e182572007-07-19 01:48:54 -07003035 return 0;
3036 } else {
3037 if (!mark_lock(curr, hlock,
Peter Zijlstra4fc95e82009-01-22 13:10:52 +01003038 LOCK_ENABLED_HARDIRQ))
Peter Zijlstra8e182572007-07-19 01:48:54 -07003039 return 0;
3040 if (curr->softirqs_enabled)
3041 if (!mark_lock(curr, hlock,
Peter Zijlstra4fc95e82009-01-22 13:10:52 +01003042 LOCK_ENABLED_SOFTIRQ))
Peter Zijlstra8e182572007-07-19 01:48:54 -07003043 return 0;
3044 }
3045 }
3046
3047 return 1;
3048}
3049
Boqun Fengc2469752016-02-16 13:57:40 +08003050static inline unsigned int task_irq_context(struct task_struct *task)
3051{
3052 return 2 * !!task->hardirq_context + !!task->softirq_context;
3053}
3054
Peter Zijlstra8e182572007-07-19 01:48:54 -07003055static int separate_irq_context(struct task_struct *curr,
3056 struct held_lock *hlock)
3057{
3058 unsigned int depth = curr->lockdep_depth;
3059
3060 /*
3061 * Keep track of points where we cross into an interrupt context:
3062 */
Peter Zijlstra8e182572007-07-19 01:48:54 -07003063 if (depth) {
3064 struct held_lock *prev_hlock;
3065
3066 prev_hlock = curr->held_locks + depth-1;
3067 /*
3068 * If we cross into another context, reset the
3069 * hash key (this also prevents the checking and the
3070 * adding of the dependency to 'prev'):
3071 */
3072 if (prev_hlock->irq_context != hlock->irq_context)
3073 return 1;
3074 }
3075 return 0;
3076}
3077
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003078#else /* defined(CONFIG_TRACE_IRQFLAGS) && defined(CONFIG_PROVE_LOCKING) */
Peter Zijlstra8e182572007-07-19 01:48:54 -07003079
3080static inline
3081int mark_lock_irq(struct task_struct *curr, struct held_lock *this,
3082 enum lock_usage_bit new_bit)
3083{
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003084 WARN_ON(1); /* Impossible innit? when we don't have TRACE_IRQFLAG */
Peter Zijlstra8e182572007-07-19 01:48:54 -07003085 return 1;
3086}
3087
3088static inline int mark_irqflags(struct task_struct *curr,
3089 struct held_lock *hlock)
3090{
3091 return 1;
3092}
3093
Boqun Fengc2469752016-02-16 13:57:40 +08003094static inline unsigned int task_irq_context(struct task_struct *task)
3095{
3096 return 0;
3097}
3098
Peter Zijlstra8e182572007-07-19 01:48:54 -07003099static inline int separate_irq_context(struct task_struct *curr,
3100 struct held_lock *hlock)
3101{
3102 return 0;
3103}
3104
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003105#endif /* defined(CONFIG_TRACE_IRQFLAGS) && defined(CONFIG_PROVE_LOCKING) */
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003106
3107/*
Peter Zijlstra8e182572007-07-19 01:48:54 -07003108 * Mark a lock with a usage bit, and validate the state transition:
3109 */
Steven Rostedt1d09daa2008-05-12 21:20:55 +02003110static int mark_lock(struct task_struct *curr, struct held_lock *this,
Steven Rostedt0764d232008-05-12 21:20:44 +02003111 enum lock_usage_bit new_bit)
Peter Zijlstra8e182572007-07-19 01:48:54 -07003112{
3113 unsigned int new_mask = 1 << new_bit, ret = 1;
3114
3115 /*
3116 * If already set then do not dirty the cacheline,
3117 * nor do any checks:
3118 */
Dave Jonesf82b2172008-08-11 09:30:23 +02003119 if (likely(hlock_class(this)->usage_mask & new_mask))
Peter Zijlstra8e182572007-07-19 01:48:54 -07003120 return 1;
3121
3122 if (!graph_lock())
3123 return 0;
3124 /*
Lucas De Marchi25985ed2011-03-30 22:57:33 -03003125 * Make sure we didn't race:
Peter Zijlstra8e182572007-07-19 01:48:54 -07003126 */
Dave Jonesf82b2172008-08-11 09:30:23 +02003127 if (unlikely(hlock_class(this)->usage_mask & new_mask)) {
Peter Zijlstra8e182572007-07-19 01:48:54 -07003128 graph_unlock();
3129 return 1;
3130 }
3131
Dave Jonesf82b2172008-08-11 09:30:23 +02003132 hlock_class(this)->usage_mask |= new_mask;
Peter Zijlstra8e182572007-07-19 01:48:54 -07003133
Dave Jonesf82b2172008-08-11 09:30:23 +02003134 if (!save_trace(hlock_class(this)->usage_traces + new_bit))
Peter Zijlstra8e182572007-07-19 01:48:54 -07003135 return 0;
3136
3137 switch (new_bit) {
Peter Zijlstra53464172009-01-22 14:15:53 +01003138#define LOCKDEP_STATE(__STATE) \
3139 case LOCK_USED_IN_##__STATE: \
3140 case LOCK_USED_IN_##__STATE##_READ: \
3141 case LOCK_ENABLED_##__STATE: \
3142 case LOCK_ENABLED_##__STATE##_READ:
3143#include "lockdep_states.h"
3144#undef LOCKDEP_STATE
Peter Zijlstra8e182572007-07-19 01:48:54 -07003145 ret = mark_lock_irq(curr, this, new_bit);
3146 if (!ret)
3147 return 0;
3148 break;
3149 case LOCK_USED:
Frederic Weisbeckerbd6d29c2010-04-06 00:10:17 +02003150 debug_atomic_dec(nr_unused_locks);
Peter Zijlstra8e182572007-07-19 01:48:54 -07003151 break;
3152 default:
3153 if (!debug_locks_off_graph_unlock())
3154 return 0;
3155 WARN_ON(1);
3156 return 0;
3157 }
3158
3159 graph_unlock();
3160
3161 /*
3162 * We must printk outside of the graph_lock:
3163 */
3164 if (ret == 2) {
3165 printk("\nmarked lock as {%s}:\n", usage_str[new_bit]);
3166 print_lock(this);
3167 print_irqtrace_events(curr);
3168 dump_stack();
3169 }
3170
3171 return ret;
3172}
3173
3174/*
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003175 * Initialize a lock instance's lock-class mapping info:
3176 */
Byungchul Parkb09be672017-08-07 16:12:52 +09003177static void __lockdep_init_map(struct lockdep_map *lock, const char *name,
Peter Zijlstra4dfbb9d2006-10-11 01:45:14 -04003178 struct lock_class_key *key, int subclass)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003179{
Yong Zhangd3d03d42011-11-09 16:04:51 +08003180 int i;
3181
Yong Zhangd3d03d42011-11-09 16:04:51 +08003182 for (i = 0; i < NR_LOCKDEP_CACHING_CLASSES; i++)
3183 lock->class_cache[i] = NULL;
Hitoshi Mitake62016252010-10-05 18:01:51 +09003184
Peter Zijlstrac8a25002009-04-17 09:40:49 +02003185#ifdef CONFIG_LOCK_STAT
3186 lock->cpu = raw_smp_processor_id();
3187#endif
3188
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003189 /*
3190 * Can't be having no nameless bastards around this place!
3191 */
Peter Zijlstrac8a25002009-04-17 09:40:49 +02003192 if (DEBUG_LOCKS_WARN_ON(!name)) {
3193 lock->name = "NULL";
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003194 return;
Peter Zijlstrac8a25002009-04-17 09:40:49 +02003195 }
3196
3197 lock->name = name;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003198
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003199 /*
3200 * No key, no joy, we need to hash something.
3201 */
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003202 if (DEBUG_LOCKS_WARN_ON(!key))
3203 return;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003204 /*
3205 * Sanity check, the lock-class key must be persistent:
3206 */
3207 if (!static_obj(key)) {
Borislav Petkov04860d42018-02-26 14:49:26 +01003208 printk("BUG: key %px not in .data!\n", key);
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003209 /*
3210 * What it says above ^^^^^, I suggest you read it.
3211 */
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003212 DEBUG_LOCKS_WARN_ON(1);
3213 return;
3214 }
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003215 lock->key = key;
Peter Zijlstrac8a25002009-04-17 09:40:49 +02003216
3217 if (unlikely(!debug_locks))
3218 return;
3219
Peter Zijlstra35a93932015-02-26 16:23:11 +01003220 if (subclass) {
3221 unsigned long flags;
3222
3223 if (DEBUG_LOCKS_WARN_ON(current->lockdep_recursion))
3224 return;
3225
3226 raw_local_irq_save(flags);
3227 current->lockdep_recursion = 1;
Peter Zijlstra4dfbb9d2006-10-11 01:45:14 -04003228 register_lock_class(lock, subclass, 1);
Peter Zijlstra35a93932015-02-26 16:23:11 +01003229 current->lockdep_recursion = 0;
3230 raw_local_irq_restore(flags);
3231 }
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003232}
Byungchul Parkb09be672017-08-07 16:12:52 +09003233
3234void lockdep_init_map(struct lockdep_map *lock, const char *name,
3235 struct lock_class_key *key, int subclass)
3236{
Byungchul Parkb09be672017-08-07 16:12:52 +09003237 __lockdep_init_map(lock, name, key, subclass);
3238}
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003239EXPORT_SYMBOL_GPL(lockdep_init_map);
3240
Peter Zijlstra1704f472010-03-19 01:37:42 +01003241struct lock_class_key __lockdep_no_validate__;
Kent Overstreetea6749c2012-12-27 22:21:58 -08003242EXPORT_SYMBOL_GPL(__lockdep_no_validate__);
Peter Zijlstra1704f472010-03-19 01:37:42 +01003243
Maarten Lankhorstd0945952012-09-13 11:39:51 +02003244static int
3245print_lock_nested_lock_not_held(struct task_struct *curr,
3246 struct held_lock *hlock,
3247 unsigned long ip)
3248{
3249 if (!debug_locks_off())
3250 return 0;
3251 if (debug_locks_silent)
3252 return 0;
3253
Paul E. McKenney681fbec2017-05-04 15:44:38 -07003254 pr_warn("\n");
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08003255 pr_warn("==================================\n");
3256 pr_warn("WARNING: Nested lock was not taken\n");
Maarten Lankhorstd0945952012-09-13 11:39:51 +02003257 print_kernel_ident();
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08003258 pr_warn("----------------------------------\n");
Maarten Lankhorstd0945952012-09-13 11:39:51 +02003259
Paul E. McKenney681fbec2017-05-04 15:44:38 -07003260 pr_warn("%s/%d is trying to lock:\n", curr->comm, task_pid_nr(curr));
Maarten Lankhorstd0945952012-09-13 11:39:51 +02003261 print_lock(hlock);
3262
Paul E. McKenney681fbec2017-05-04 15:44:38 -07003263 pr_warn("\nbut this task is not holding:\n");
3264 pr_warn("%s\n", hlock->nest_lock->name);
Maarten Lankhorstd0945952012-09-13 11:39:51 +02003265
Paul E. McKenney681fbec2017-05-04 15:44:38 -07003266 pr_warn("\nstack backtrace:\n");
Maarten Lankhorstd0945952012-09-13 11:39:51 +02003267 dump_stack();
3268
Paul E. McKenney681fbec2017-05-04 15:44:38 -07003269 pr_warn("\nother info that might help us debug this:\n");
Maarten Lankhorstd0945952012-09-13 11:39:51 +02003270 lockdep_print_held_locks(curr);
3271
Paul E. McKenney681fbec2017-05-04 15:44:38 -07003272 pr_warn("\nstack backtrace:\n");
Maarten Lankhorstd0945952012-09-13 11:39:51 +02003273 dump_stack();
3274
3275 return 0;
3276}
3277
Matthew Wilcox08f36ff2018-01-17 07:14:13 -08003278static int __lock_is_held(const struct lockdep_map *lock, int read);
Maarten Lankhorstd0945952012-09-13 11:39:51 +02003279
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003280/*
3281 * This gets called for every mutex_lock*()/spin_lock*() operation.
3282 * We maintain the dependency maps and validate the locking attempt:
3283 */
3284static int __lock_acquire(struct lockdep_map *lock, unsigned int subclass,
3285 int trylock, int read, int check, int hardirqs_off,
Peter Zijlstrabb97a912009-07-20 19:15:35 +02003286 struct lockdep_map *nest_lock, unsigned long ip,
Peter Zijlstra21199f22015-09-16 16:10:40 +02003287 int references, int pin_count)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003288{
3289 struct task_struct *curr = current;
Ingo Molnard6d897c2006-07-10 04:44:04 -07003290 struct lock_class *class = NULL;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003291 struct held_lock *hlock;
Alfredo Alvarez Fernandez5f18ab52016-02-11 00:33:32 +01003292 unsigned int depth;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003293 int chain_head = 0;
Peter Zijlstrabb97a912009-07-20 19:15:35 +02003294 int class_idx;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003295 u64 chain_key;
3296
3297 if (unlikely(!debug_locks))
3298 return 0;
3299
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003300 /*
3301 * Lockdep should run with IRQs disabled, otherwise we could
3302 * get an interrupt which would want to take locks, which would
3303 * end up in lockdep and have you got a head-ache already?
3304 */
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003305 if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
3306 return 0;
3307
Oleg Nesterovfb9edbe2014-01-20 19:20:06 +01003308 if (!prove_locking || lock->key == &__lockdep_no_validate__)
3309 check = 0;
Peter Zijlstra1704f472010-03-19 01:37:42 +01003310
Hitoshi Mitake62016252010-10-05 18:01:51 +09003311 if (subclass < NR_LOCKDEP_CACHING_CLASSES)
3312 class = lock->class_cache[subclass];
Ingo Molnard6d897c2006-07-10 04:44:04 -07003313 /*
Hitoshi Mitake62016252010-10-05 18:01:51 +09003314 * Not cached?
Ingo Molnard6d897c2006-07-10 04:44:04 -07003315 */
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003316 if (unlikely(!class)) {
Peter Zijlstra4dfbb9d2006-10-11 01:45:14 -04003317 class = register_lock_class(lock, subclass, 0);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003318 if (!class)
3319 return 0;
3320 }
Frederic Weisbeckerbd6d29c2010-04-06 00:10:17 +02003321 atomic_inc((atomic_t *)&class->ops);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003322 if (very_verbose(class)) {
Borislav Petkov04860d42018-02-26 14:49:26 +01003323 printk("\nacquire class [%px] %s", class->key, class->name);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003324 if (class->name_version > 1)
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01003325 printk(KERN_CONT "#%d", class->name_version);
3326 printk(KERN_CONT "\n");
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003327 dump_stack();
3328 }
3329
3330 /*
3331 * Add the lock to the list of currently held locks.
3332 * (we dont increase the depth just yet, up until the
3333 * dependency checks are done)
3334 */
3335 depth = curr->lockdep_depth;
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003336 /*
3337 * Ran out of static storage for our per-task lock stack again have we?
3338 */
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003339 if (DEBUG_LOCKS_WARN_ON(depth >= MAX_LOCK_DEPTH))
3340 return 0;
3341
Peter Zijlstrabb97a912009-07-20 19:15:35 +02003342 class_idx = class - lock_classes + 1;
3343
Ingo Molnare966eae2017-12-12 12:31:16 +01003344 if (depth) {
Peter Zijlstrabb97a912009-07-20 19:15:35 +02003345 hlock = curr->held_locks + depth - 1;
3346 if (hlock->class_idx == class_idx && nest_lock) {
Peter Zijlstra7fb4a2c2017-03-01 16:23:30 +01003347 if (hlock->references) {
3348 /*
3349 * Check: unsigned int references:12, overflow.
3350 */
3351 if (DEBUG_LOCKS_WARN_ON(hlock->references == (1 << 12)-1))
3352 return 0;
3353
Peter Zijlstrabb97a912009-07-20 19:15:35 +02003354 hlock->references++;
Peter Zijlstra7fb4a2c2017-03-01 16:23:30 +01003355 } else {
Peter Zijlstrabb97a912009-07-20 19:15:35 +02003356 hlock->references = 2;
Peter Zijlstra7fb4a2c2017-03-01 16:23:30 +01003357 }
Peter Zijlstrabb97a912009-07-20 19:15:35 +02003358
3359 return 1;
3360 }
3361 }
3362
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003363 hlock = curr->held_locks + depth;
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003364 /*
3365 * Plain impossible, we just registered it and checked it weren't no
3366 * NULL like.. I bet this mushroom I ate was good!
3367 */
Dave Jonesf82b2172008-08-11 09:30:23 +02003368 if (DEBUG_LOCKS_WARN_ON(!class))
3369 return 0;
Peter Zijlstrabb97a912009-07-20 19:15:35 +02003370 hlock->class_idx = class_idx;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003371 hlock->acquire_ip = ip;
3372 hlock->instance = lock;
Peter Zijlstra7531e2f2008-08-11 09:30:24 +02003373 hlock->nest_lock = nest_lock;
Boqun Fengc2469752016-02-16 13:57:40 +08003374 hlock->irq_context = task_irq_context(curr);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003375 hlock->trylock = trylock;
3376 hlock->read = read;
3377 hlock->check = check;
Dmitry Baryshkov6951b122008-08-18 04:26:37 +04003378 hlock->hardirqs_off = !!hardirqs_off;
Peter Zijlstrabb97a912009-07-20 19:15:35 +02003379 hlock->references = references;
Peter Zijlstraf20786f2007-07-19 01:48:56 -07003380#ifdef CONFIG_LOCK_STAT
3381 hlock->waittime_stamp = 0;
Peter Zijlstra3365e7792009-10-09 10:12:41 +02003382 hlock->holdtime_stamp = lockstat_clock();
Peter Zijlstraf20786f2007-07-19 01:48:56 -07003383#endif
Peter Zijlstra21199f22015-09-16 16:10:40 +02003384 hlock->pin_count = pin_count;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003385
Oleg Nesterovfb9edbe2014-01-20 19:20:06 +01003386 if (check && !mark_irqflags(curr, hlock))
Peter Zijlstra8e182572007-07-19 01:48:54 -07003387 return 0;
3388
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003389 /* mark it as used: */
Jarek Poplawski4ff773bb2007-05-08 00:31:00 -07003390 if (!mark_lock(curr, hlock, LOCK_USED))
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003391 return 0;
Peter Zijlstra8e182572007-07-19 01:48:54 -07003392
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003393 /*
Gautham R Shenoy17aacfb92007-10-28 20:47:01 +01003394 * Calculate the chain hash: it's the combined hash of all the
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003395 * lock keys along the dependency chain. We save the hash value
3396 * at every step so that we can get the current hash easily
3397 * after unlock. The chain hash is then used to cache dependency
3398 * results.
3399 *
3400 * The 'key ID' is what is the most compact key value to drive
3401 * the hash, not class->key.
3402 */
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003403 /*
3404 * Whoops, we did it again.. ran straight out of our static allocation.
3405 */
Alfredo Alvarez Fernandez5f18ab52016-02-11 00:33:32 +01003406 if (DEBUG_LOCKS_WARN_ON(class_idx > MAX_LOCKDEP_KEYS))
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003407 return 0;
3408
3409 chain_key = curr->curr_chain_key;
3410 if (!depth) {
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003411 /*
3412 * How can we have a chain hash when we ain't got no keys?!
3413 */
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003414 if (DEBUG_LOCKS_WARN_ON(chain_key != 0))
3415 return 0;
3416 chain_head = 1;
3417 }
3418
3419 hlock->prev_chain_key = chain_key;
Peter Zijlstra8e182572007-07-19 01:48:54 -07003420 if (separate_irq_context(curr, hlock)) {
3421 chain_key = 0;
3422 chain_head = 1;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003423 }
Alfredo Alvarez Fernandez5f18ab52016-02-11 00:33:32 +01003424 chain_key = iterate_chain_key(chain_key, class_idx);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003425
Peter Zijlstraf8319482016-11-30 14:32:25 +11003426 if (nest_lock && !__lock_is_held(nest_lock, -1))
Maarten Lankhorstd0945952012-09-13 11:39:51 +02003427 return print_lock_nested_lock_not_held(curr, hlock, ip);
3428
Gregory Haskins3aa416b2007-10-11 22:11:11 +02003429 if (!validate_chain(curr, lock, hlock, chain_head, chain_key))
Peter Zijlstra8e182572007-07-19 01:48:54 -07003430 return 0;
Jarek Poplawski381a2292007-02-10 01:44:58 -08003431
Gregory Haskins3aa416b2007-10-11 22:11:11 +02003432 curr->curr_chain_key = chain_key;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003433 curr->lockdep_depth++;
3434 check_chain_key(curr);
Jarek Poplawski60e114d2007-02-20 13:58:00 -08003435#ifdef CONFIG_DEBUG_LOCKDEP
3436 if (unlikely(!debug_locks))
3437 return 0;
3438#endif
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003439 if (unlikely(curr->lockdep_depth >= MAX_LOCK_DEPTH)) {
3440 debug_locks_off();
Dave Jones2c522832013-04-25 13:40:02 -04003441 print_lockdep_off("BUG: MAX_LOCK_DEPTH too low!");
3442 printk(KERN_DEBUG "depth: %i max: %lu!\n",
Ben Greearc0540602013-02-06 10:56:19 -08003443 curr->lockdep_depth, MAX_LOCK_DEPTH);
Ben Greearc0540602013-02-06 10:56:19 -08003444
3445 lockdep_print_held_locks(current);
3446 debug_show_all_locks();
Peter Zijlstraeedeeab2009-03-18 12:38:47 +01003447 dump_stack();
Ben Greearc0540602013-02-06 10:56:19 -08003448
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003449 return 0;
3450 }
Jarek Poplawski381a2292007-02-10 01:44:58 -08003451
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003452 if (unlikely(curr->lockdep_depth > max_lockdep_depth))
3453 max_lockdep_depth = curr->lockdep_depth;
3454
3455 return 1;
3456}
3457
3458static int
Srivatsa S. Bhatf86f7552013-01-08 18:35:58 +05303459print_unlock_imbalance_bug(struct task_struct *curr, struct lockdep_map *lock,
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003460 unsigned long ip)
3461{
3462 if (!debug_locks_off())
3463 return 0;
3464 if (debug_locks_silent)
3465 return 0;
3466
Paul E. McKenney681fbec2017-05-04 15:44:38 -07003467 pr_warn("\n");
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08003468 pr_warn("=====================================\n");
3469 pr_warn("WARNING: bad unlock balance detected!\n");
Ben Hutchingsfbdc4b92011-10-28 04:36:55 +01003470 print_kernel_ident();
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08003471 pr_warn("-------------------------------------\n");
Paul E. McKenney681fbec2017-05-04 15:44:38 -07003472 pr_warn("%s/%d is trying to release lock (",
Pavel Emelyanovba25f9d2007-10-18 23:40:40 -07003473 curr->comm, task_pid_nr(curr));
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003474 print_lockdep_cache(lock);
Paul E. McKenney681fbec2017-05-04 15:44:38 -07003475 pr_cont(") at:\n");
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003476 print_ip_sym(ip);
Paul E. McKenney681fbec2017-05-04 15:44:38 -07003477 pr_warn("but there are no more locks to release!\n");
3478 pr_warn("\nother info that might help us debug this:\n");
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003479 lockdep_print_held_locks(curr);
3480
Paul E. McKenney681fbec2017-05-04 15:44:38 -07003481 pr_warn("\nstack backtrace:\n");
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003482 dump_stack();
3483
3484 return 0;
3485}
3486
Matthew Wilcox08f36ff2018-01-17 07:14:13 -08003487static int match_held_lock(const struct held_lock *hlock,
3488 const struct lockdep_map *lock)
Peter Zijlstrabb97a912009-07-20 19:15:35 +02003489{
3490 if (hlock->instance == lock)
3491 return 1;
3492
3493 if (hlock->references) {
Matthew Wilcox08f36ff2018-01-17 07:14:13 -08003494 const struct lock_class *class = lock->class_cache[0];
Peter Zijlstrabb97a912009-07-20 19:15:35 +02003495
3496 if (!class)
3497 class = look_up_lock_class(lock, 0);
3498
Peter Zijlstra80e04012011-08-05 14:26:17 +02003499 /*
3500 * If look_up_lock_class() failed to find a class, we're trying
3501 * to test if we hold a lock that has never yet been acquired.
3502 * Clearly if the lock hasn't been acquired _ever_, we're not
3503 * holding it either, so report failure.
3504 */
Matthew Wilcox64f29d12018-01-17 07:14:12 -08003505 if (!class)
Peter Zijlstrabb97a912009-07-20 19:15:35 +02003506 return 0;
3507
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003508 /*
3509 * References, but not a lock we're actually ref-counting?
3510 * State got messed up, follow the sites that change ->references
3511 * and try to make sense of it.
3512 */
Peter Zijlstrabb97a912009-07-20 19:15:35 +02003513 if (DEBUG_LOCKS_WARN_ON(!hlock->nest_lock))
3514 return 0;
3515
3516 if (hlock->class_idx == class - lock_classes + 1)
3517 return 1;
3518 }
3519
3520 return 0;
3521}
3522
J. R. Okajima41c2c5b2017-02-03 01:38:15 +09003523/* @depth must not be zero */
3524static struct held_lock *find_held_lock(struct task_struct *curr,
3525 struct lockdep_map *lock,
3526 unsigned int depth, int *idx)
3527{
3528 struct held_lock *ret, *hlock, *prev_hlock;
3529 int i;
3530
3531 i = depth - 1;
3532 hlock = curr->held_locks + i;
3533 ret = hlock;
3534 if (match_held_lock(hlock, lock))
3535 goto out;
3536
3537 ret = NULL;
3538 for (i--, prev_hlock = hlock--;
3539 i >= 0;
3540 i--, prev_hlock = hlock--) {
3541 /*
3542 * We must not cross into another context:
3543 */
3544 if (prev_hlock->irq_context != hlock->irq_context) {
3545 ret = NULL;
3546 break;
3547 }
3548 if (match_held_lock(hlock, lock)) {
3549 ret = hlock;
3550 break;
3551 }
3552 }
3553
3554out:
3555 *idx = i;
3556 return ret;
3557}
3558
J. R. Okajimae9699702017-02-03 01:38:16 +09003559static int reacquire_held_locks(struct task_struct *curr, unsigned int depth,
3560 int idx)
3561{
3562 struct held_lock *hlock;
3563
3564 for (hlock = curr->held_locks + idx; idx < depth; idx++, hlock++) {
3565 if (!__lock_acquire(hlock->instance,
3566 hlock_class(hlock)->subclass,
3567 hlock->trylock,
3568 hlock->read, hlock->check,
3569 hlock->hardirqs_off,
3570 hlock->nest_lock, hlock->acquire_ip,
3571 hlock->references, hlock->pin_count))
3572 return 1;
3573 }
3574 return 0;
3575}
3576
Peter Zijlstra64aa3482008-08-11 09:30:21 +02003577static int
Peter Zijlstra00ef9f72008-12-04 09:00:17 +01003578__lock_set_class(struct lockdep_map *lock, const char *name,
3579 struct lock_class_key *key, unsigned int subclass,
3580 unsigned long ip)
Peter Zijlstra64aa3482008-08-11 09:30:21 +02003581{
3582 struct task_struct *curr = current;
J. R. Okajima41c2c5b2017-02-03 01:38:15 +09003583 struct held_lock *hlock;
Peter Zijlstra64aa3482008-08-11 09:30:21 +02003584 struct lock_class *class;
3585 unsigned int depth;
3586 int i;
3587
3588 depth = curr->lockdep_depth;
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003589 /*
3590 * This function is about (re)setting the class of a held lock,
3591 * yet we're not actually holding any locks. Naughty user!
3592 */
Peter Zijlstra64aa3482008-08-11 09:30:21 +02003593 if (DEBUG_LOCKS_WARN_ON(!depth))
3594 return 0;
3595
J. R. Okajima41c2c5b2017-02-03 01:38:15 +09003596 hlock = find_held_lock(curr, lock, depth, &i);
3597 if (!hlock)
3598 return print_unlock_imbalance_bug(curr, lock, ip);
Peter Zijlstra64aa3482008-08-11 09:30:21 +02003599
Peter Zijlstra00ef9f72008-12-04 09:00:17 +01003600 lockdep_init_map(lock, name, key, 0);
Peter Zijlstra64aa3482008-08-11 09:30:21 +02003601 class = register_lock_class(lock, subclass, 0);
Dave Jonesf82b2172008-08-11 09:30:23 +02003602 hlock->class_idx = class - lock_classes + 1;
Peter Zijlstra64aa3482008-08-11 09:30:21 +02003603
3604 curr->lockdep_depth = i;
3605 curr->curr_chain_key = hlock->prev_chain_key;
3606
J. R. Okajimae9699702017-02-03 01:38:16 +09003607 if (reacquire_held_locks(curr, depth, i))
3608 return 0;
Peter Zijlstra64aa3482008-08-11 09:30:21 +02003609
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003610 /*
3611 * I took it apart and put it back together again, except now I have
3612 * these 'spare' parts.. where shall I put them.
3613 */
Peter Zijlstra64aa3482008-08-11 09:30:21 +02003614 if (DEBUG_LOCKS_WARN_ON(curr->lockdep_depth != depth))
3615 return 0;
3616 return 1;
3617}
3618
J. R. Okajima6419c4a2017-02-03 01:38:17 +09003619static int __lock_downgrade(struct lockdep_map *lock, unsigned long ip)
3620{
3621 struct task_struct *curr = current;
3622 struct held_lock *hlock;
3623 unsigned int depth;
3624 int i;
3625
3626 depth = curr->lockdep_depth;
3627 /*
3628 * This function is about (re)setting the class of a held lock,
3629 * yet we're not actually holding any locks. Naughty user!
3630 */
3631 if (DEBUG_LOCKS_WARN_ON(!depth))
3632 return 0;
3633
3634 hlock = find_held_lock(curr, lock, depth, &i);
3635 if (!hlock)
3636 return print_unlock_imbalance_bug(curr, lock, ip);
3637
3638 curr->lockdep_depth = i;
3639 curr->curr_chain_key = hlock->prev_chain_key;
3640
3641 WARN(hlock->read, "downgrading a read lock");
3642 hlock->read = 1;
3643 hlock->acquire_ip = ip;
3644
3645 if (reacquire_held_locks(curr, depth, i))
3646 return 0;
3647
3648 /*
3649 * I took it apart and put it back together again, except now I have
3650 * these 'spare' parts.. where shall I put them.
3651 */
3652 if (DEBUG_LOCKS_WARN_ON(curr->lockdep_depth != depth))
3653 return 0;
3654 return 1;
3655}
3656
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003657/*
Peter Zijlstrae0f56fd2015-06-11 14:46:52 +02003658 * Remove the lock to the list of currently held locks - this gets
3659 * called on mutex_unlock()/spin_unlock*() (or on a failed
3660 * mutex_lock_interruptible()).
3661 *
3662 * @nested is an hysterical artifact, needs a tree wide cleanup.
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003663 */
3664static int
Peter Zijlstrae0f56fd2015-06-11 14:46:52 +02003665__lock_release(struct lockdep_map *lock, int nested, unsigned long ip)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003666{
Peter Zijlstrae0f56fd2015-06-11 14:46:52 +02003667 struct task_struct *curr = current;
J. R. Okajima41c2c5b2017-02-03 01:38:15 +09003668 struct held_lock *hlock;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003669 unsigned int depth;
Ingo Molnare966eae2017-12-12 12:31:16 +01003670 int i;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003671
Peter Zijlstrae0f56fd2015-06-11 14:46:52 +02003672 if (unlikely(!debug_locks))
3673 return 0;
3674
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003675 depth = curr->lockdep_depth;
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003676 /*
3677 * So we're all set to release this lock.. wait what lock? We don't
3678 * own any locks, you've been drinking again?
3679 */
Peter Zijlstrae0f56fd2015-06-11 14:46:52 +02003680 if (DEBUG_LOCKS_WARN_ON(depth <= 0))
3681 return print_unlock_imbalance_bug(curr, lock, ip);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003682
Peter Zijlstrae0f56fd2015-06-11 14:46:52 +02003683 /*
3684 * Check whether the lock exists in the current stack
3685 * of held locks:
3686 */
J. R. Okajima41c2c5b2017-02-03 01:38:15 +09003687 hlock = find_held_lock(curr, lock, depth, &i);
3688 if (!hlock)
3689 return print_unlock_imbalance_bug(curr, lock, ip);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003690
Peter Zijlstrabb97a912009-07-20 19:15:35 +02003691 if (hlock->instance == lock)
3692 lock_release_holdtime(hlock);
3693
Peter Zijlstraa24fc602015-06-11 14:46:53 +02003694 WARN(hlock->pin_count, "releasing a pinned lock\n");
3695
Peter Zijlstrabb97a912009-07-20 19:15:35 +02003696 if (hlock->references) {
3697 hlock->references--;
3698 if (hlock->references) {
3699 /*
3700 * We had, and after removing one, still have
3701 * references, the current lock stack is still
3702 * valid. We're done!
3703 */
3704 return 1;
3705 }
3706 }
Peter Zijlstraf20786f2007-07-19 01:48:56 -07003707
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003708 /*
3709 * We have the right lock to unlock, 'hlock' points to it.
3710 * Now we remove it from the stack, and add back the other
3711 * entries (if any), recalculating the hash along the way:
3712 */
Peter Zijlstrabb97a912009-07-20 19:15:35 +02003713
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003714 curr->lockdep_depth = i;
3715 curr->curr_chain_key = hlock->prev_chain_key;
3716
J. R. Okajimae9699702017-02-03 01:38:16 +09003717 if (reacquire_held_locks(curr, depth, i + 1))
3718 return 0;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003719
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003720 /*
3721 * We had N bottles of beer on the wall, we drank one, but now
3722 * there's not N-1 bottles of beer left on the wall...
3723 */
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003724 if (DEBUG_LOCKS_WARN_ON(curr->lockdep_depth != depth - 1))
3725 return 0;
Peter Zijlstrae0f56fd2015-06-11 14:46:52 +02003726
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003727 return 1;
3728}
3729
Matthew Wilcox08f36ff2018-01-17 07:14:13 -08003730static int __lock_is_held(const struct lockdep_map *lock, int read)
Peter Zijlstraf607c662009-07-20 19:16:29 +02003731{
3732 struct task_struct *curr = current;
3733 int i;
3734
3735 for (i = 0; i < curr->lockdep_depth; i++) {
Peter Zijlstrabb97a912009-07-20 19:15:35 +02003736 struct held_lock *hlock = curr->held_locks + i;
3737
Peter Zijlstraf8319482016-11-30 14:32:25 +11003738 if (match_held_lock(hlock, lock)) {
3739 if (read == -1 || hlock->read == read)
3740 return 1;
3741
3742 return 0;
3743 }
Peter Zijlstraf607c662009-07-20 19:16:29 +02003744 }
3745
3746 return 0;
3747}
3748
Peter Zijlstrae7904a22015-08-01 19:25:08 +02003749static struct pin_cookie __lock_pin_lock(struct lockdep_map *lock)
3750{
3751 struct pin_cookie cookie = NIL_COOKIE;
3752 struct task_struct *curr = current;
3753 int i;
3754
3755 if (unlikely(!debug_locks))
3756 return cookie;
3757
3758 for (i = 0; i < curr->lockdep_depth; i++) {
3759 struct held_lock *hlock = curr->held_locks + i;
3760
3761 if (match_held_lock(hlock, lock)) {
3762 /*
3763 * Grab 16bits of randomness; this is sufficient to not
3764 * be guessable and still allows some pin nesting in
3765 * our u32 pin_count.
3766 */
3767 cookie.val = 1 + (prandom_u32() >> 16);
3768 hlock->pin_count += cookie.val;
3769 return cookie;
3770 }
3771 }
3772
3773 WARN(1, "pinning an unheld lock\n");
3774 return cookie;
3775}
3776
3777static void __lock_repin_lock(struct lockdep_map *lock, struct pin_cookie cookie)
Peter Zijlstraa24fc602015-06-11 14:46:53 +02003778{
3779 struct task_struct *curr = current;
3780 int i;
3781
3782 if (unlikely(!debug_locks))
3783 return;
3784
3785 for (i = 0; i < curr->lockdep_depth; i++) {
3786 struct held_lock *hlock = curr->held_locks + i;
3787
3788 if (match_held_lock(hlock, lock)) {
Peter Zijlstrae7904a22015-08-01 19:25:08 +02003789 hlock->pin_count += cookie.val;
Peter Zijlstraa24fc602015-06-11 14:46:53 +02003790 return;
3791 }
3792 }
3793
3794 WARN(1, "pinning an unheld lock\n");
3795}
3796
Peter Zijlstrae7904a22015-08-01 19:25:08 +02003797static void __lock_unpin_lock(struct lockdep_map *lock, struct pin_cookie cookie)
Peter Zijlstraa24fc602015-06-11 14:46:53 +02003798{
3799 struct task_struct *curr = current;
3800 int i;
3801
3802 if (unlikely(!debug_locks))
3803 return;
3804
3805 for (i = 0; i < curr->lockdep_depth; i++) {
3806 struct held_lock *hlock = curr->held_locks + i;
3807
3808 if (match_held_lock(hlock, lock)) {
3809 if (WARN(!hlock->pin_count, "unpinning an unpinned lock\n"))
3810 return;
3811
Peter Zijlstrae7904a22015-08-01 19:25:08 +02003812 hlock->pin_count -= cookie.val;
3813
3814 if (WARN((int)hlock->pin_count < 0, "pin count corrupted\n"))
3815 hlock->pin_count = 0;
3816
Peter Zijlstraa24fc602015-06-11 14:46:53 +02003817 return;
3818 }
3819 }
3820
3821 WARN(1, "unpinning an unheld lock\n");
3822}
3823
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003824/*
3825 * Check whether we follow the irq-flags state precisely:
3826 */
Steven Rostedt1d09daa2008-05-12 21:20:55 +02003827static void check_flags(unsigned long flags)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003828{
Ingo Molnar992860e2008-07-14 10:28:38 +02003829#if defined(CONFIG_PROVE_LOCKING) && defined(CONFIG_DEBUG_LOCKDEP) && \
3830 defined(CONFIG_TRACE_IRQFLAGS)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003831 if (!debug_locks)
3832 return;
3833
Ingo Molnar5f9fa8a2007-12-07 19:02:47 +01003834 if (irqs_disabled_flags(flags)) {
3835 if (DEBUG_LOCKS_WARN_ON(current->hardirqs_enabled)) {
3836 printk("possible reason: unannotated irqs-off.\n");
3837 }
3838 } else {
3839 if (DEBUG_LOCKS_WARN_ON(!current->hardirqs_enabled)) {
3840 printk("possible reason: unannotated irqs-on.\n");
3841 }
3842 }
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003843
3844 /*
3845 * We dont accurately track softirq state in e.g.
3846 * hardirq contexts (such as on 4KSTACKS), so only
3847 * check if not in hardirq contexts:
3848 */
3849 if (!hardirq_count()) {
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003850 if (softirq_count()) {
3851 /* like the above, but with softirqs */
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003852 DEBUG_LOCKS_WARN_ON(current->softirqs_enabled);
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003853 } else {
3854 /* lick the above, does it taste good? */
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003855 DEBUG_LOCKS_WARN_ON(!current->softirqs_enabled);
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003856 }
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003857 }
3858
3859 if (!debug_locks)
3860 print_irqtrace_events(current);
3861#endif
3862}
3863
Peter Zijlstra00ef9f72008-12-04 09:00:17 +01003864void lock_set_class(struct lockdep_map *lock, const char *name,
3865 struct lock_class_key *key, unsigned int subclass,
3866 unsigned long ip)
Peter Zijlstra64aa3482008-08-11 09:30:21 +02003867{
3868 unsigned long flags;
3869
3870 if (unlikely(current->lockdep_recursion))
3871 return;
3872
3873 raw_local_irq_save(flags);
3874 current->lockdep_recursion = 1;
3875 check_flags(flags);
Peter Zijlstra00ef9f72008-12-04 09:00:17 +01003876 if (__lock_set_class(lock, name, key, subclass, ip))
Peter Zijlstra64aa3482008-08-11 09:30:21 +02003877 check_chain_key(current);
3878 current->lockdep_recursion = 0;
3879 raw_local_irq_restore(flags);
3880}
Peter Zijlstra00ef9f72008-12-04 09:00:17 +01003881EXPORT_SYMBOL_GPL(lock_set_class);
Peter Zijlstra64aa3482008-08-11 09:30:21 +02003882
J. R. Okajima6419c4a2017-02-03 01:38:17 +09003883void lock_downgrade(struct lockdep_map *lock, unsigned long ip)
3884{
3885 unsigned long flags;
3886
3887 if (unlikely(current->lockdep_recursion))
3888 return;
3889
3890 raw_local_irq_save(flags);
3891 current->lockdep_recursion = 1;
3892 check_flags(flags);
3893 if (__lock_downgrade(lock, ip))
3894 check_chain_key(current);
3895 current->lockdep_recursion = 0;
3896 raw_local_irq_restore(flags);
3897}
3898EXPORT_SYMBOL_GPL(lock_downgrade);
3899
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003900/*
3901 * We are not always called with irqs disabled - do that here,
3902 * and also avoid lockdep recursion:
3903 */
Steven Rostedt1d09daa2008-05-12 21:20:55 +02003904void lock_acquire(struct lockdep_map *lock, unsigned int subclass,
Peter Zijlstra7531e2f2008-08-11 09:30:24 +02003905 int trylock, int read, int check,
3906 struct lockdep_map *nest_lock, unsigned long ip)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003907{
3908 unsigned long flags;
3909
3910 if (unlikely(current->lockdep_recursion))
3911 return;
3912
3913 raw_local_irq_save(flags);
3914 check_flags(flags);
3915
3916 current->lockdep_recursion = 1;
Frederic Weisbeckerdb2c4c72010-02-02 23:34:40 +01003917 trace_lock_acquire(lock, subclass, trylock, read, check, nest_lock, ip);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003918 __lock_acquire(lock, subclass, trylock, read, check,
Peter Zijlstra21199f22015-09-16 16:10:40 +02003919 irqs_disabled_flags(flags), nest_lock, ip, 0, 0);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003920 current->lockdep_recursion = 0;
3921 raw_local_irq_restore(flags);
3922}
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003923EXPORT_SYMBOL_GPL(lock_acquire);
3924
Steven Rostedt1d09daa2008-05-12 21:20:55 +02003925void lock_release(struct lockdep_map *lock, int nested,
Steven Rostedt0764d232008-05-12 21:20:44 +02003926 unsigned long ip)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003927{
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 current->lockdep_recursion = 1;
Frederic Weisbecker93135432010-05-08 06:24:25 +02003936 trace_lock_release(lock, ip);
Peter Zijlstrae0f56fd2015-06-11 14:46:52 +02003937 if (__lock_release(lock, nested, ip))
3938 check_chain_key(current);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003939 current->lockdep_recursion = 0;
3940 raw_local_irq_restore(flags);
3941}
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003942EXPORT_SYMBOL_GPL(lock_release);
3943
Matthew Wilcox08f36ff2018-01-17 07:14:13 -08003944int lock_is_held_type(const struct lockdep_map *lock, int read)
Peter Zijlstraf607c662009-07-20 19:16:29 +02003945{
3946 unsigned long flags;
3947 int ret = 0;
3948
3949 if (unlikely(current->lockdep_recursion))
Peter Zijlstraf2513cd2011-06-06 12:32:43 +02003950 return 1; /* avoid false negative lockdep_assert_held() */
Peter Zijlstraf607c662009-07-20 19:16:29 +02003951
3952 raw_local_irq_save(flags);
3953 check_flags(flags);
3954
3955 current->lockdep_recursion = 1;
Peter Zijlstraf8319482016-11-30 14:32:25 +11003956 ret = __lock_is_held(lock, read);
Peter Zijlstraf607c662009-07-20 19:16:29 +02003957 current->lockdep_recursion = 0;
3958 raw_local_irq_restore(flags);
3959
3960 return ret;
3961}
Peter Zijlstraf8319482016-11-30 14:32:25 +11003962EXPORT_SYMBOL_GPL(lock_is_held_type);
Peter Zijlstraf607c662009-07-20 19:16:29 +02003963
Peter Zijlstrae7904a22015-08-01 19:25:08 +02003964struct pin_cookie lock_pin_lock(struct lockdep_map *lock)
Peter Zijlstraa24fc602015-06-11 14:46:53 +02003965{
Peter Zijlstrae7904a22015-08-01 19:25:08 +02003966 struct pin_cookie cookie = NIL_COOKIE;
Peter Zijlstraa24fc602015-06-11 14:46:53 +02003967 unsigned long flags;
3968
3969 if (unlikely(current->lockdep_recursion))
Peter Zijlstrae7904a22015-08-01 19:25:08 +02003970 return cookie;
Peter Zijlstraa24fc602015-06-11 14:46:53 +02003971
3972 raw_local_irq_save(flags);
3973 check_flags(flags);
3974
3975 current->lockdep_recursion = 1;
Peter Zijlstrae7904a22015-08-01 19:25:08 +02003976 cookie = __lock_pin_lock(lock);
Peter Zijlstraa24fc602015-06-11 14:46:53 +02003977 current->lockdep_recursion = 0;
3978 raw_local_irq_restore(flags);
Peter Zijlstrae7904a22015-08-01 19:25:08 +02003979
3980 return cookie;
Peter Zijlstraa24fc602015-06-11 14:46:53 +02003981}
3982EXPORT_SYMBOL_GPL(lock_pin_lock);
3983
Peter Zijlstrae7904a22015-08-01 19:25:08 +02003984void lock_repin_lock(struct lockdep_map *lock, struct pin_cookie cookie)
Peter Zijlstraa24fc602015-06-11 14:46:53 +02003985{
3986 unsigned long flags;
3987
3988 if (unlikely(current->lockdep_recursion))
3989 return;
3990
3991 raw_local_irq_save(flags);
3992 check_flags(flags);
3993
3994 current->lockdep_recursion = 1;
Peter Zijlstrae7904a22015-08-01 19:25:08 +02003995 __lock_repin_lock(lock, cookie);
3996 current->lockdep_recursion = 0;
3997 raw_local_irq_restore(flags);
3998}
3999EXPORT_SYMBOL_GPL(lock_repin_lock);
4000
4001void lock_unpin_lock(struct lockdep_map *lock, struct pin_cookie cookie)
4002{
4003 unsigned long flags;
4004
4005 if (unlikely(current->lockdep_recursion))
4006 return;
4007
4008 raw_local_irq_save(flags);
4009 check_flags(flags);
4010
4011 current->lockdep_recursion = 1;
4012 __lock_unpin_lock(lock, cookie);
Peter Zijlstraa24fc602015-06-11 14:46:53 +02004013 current->lockdep_recursion = 0;
4014 raw_local_irq_restore(flags);
4015}
4016EXPORT_SYMBOL_GPL(lock_unpin_lock);
4017
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004018#ifdef CONFIG_LOCK_STAT
4019static int
4020print_lock_contention_bug(struct task_struct *curr, struct lockdep_map *lock,
4021 unsigned long ip)
4022{
4023 if (!debug_locks_off())
4024 return 0;
4025 if (debug_locks_silent)
4026 return 0;
4027
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004028 pr_warn("\n");
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08004029 pr_warn("=================================\n");
4030 pr_warn("WARNING: bad contention detected!\n");
Ben Hutchingsfbdc4b92011-10-28 04:36:55 +01004031 print_kernel_ident();
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08004032 pr_warn("---------------------------------\n");
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004033 pr_warn("%s/%d is trying to contend lock (",
Pavel Emelyanovba25f9d2007-10-18 23:40:40 -07004034 curr->comm, task_pid_nr(curr));
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004035 print_lockdep_cache(lock);
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004036 pr_cont(") at:\n");
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004037 print_ip_sym(ip);
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004038 pr_warn("but there are no locks held!\n");
4039 pr_warn("\nother info that might help us debug this:\n");
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004040 lockdep_print_held_locks(curr);
4041
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004042 pr_warn("\nstack backtrace:\n");
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004043 dump_stack();
4044
4045 return 0;
4046}
4047
4048static void
4049__lock_contended(struct lockdep_map *lock, unsigned long ip)
4050{
4051 struct task_struct *curr = current;
J. R. Okajima41c2c5b2017-02-03 01:38:15 +09004052 struct held_lock *hlock;
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004053 struct lock_class_stats *stats;
4054 unsigned int depth;
Peter Zijlstrac7e78cf2008-10-16 23:17:09 +02004055 int i, contention_point, contending_point;
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004056
4057 depth = curr->lockdep_depth;
Peter Zijlstra0119fee2011-09-02 01:30:29 +02004058 /*
4059 * Whee, we contended on this lock, except it seems we're not
4060 * actually trying to acquire anything much at all..
4061 */
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004062 if (DEBUG_LOCKS_WARN_ON(!depth))
4063 return;
4064
J. R. Okajima41c2c5b2017-02-03 01:38:15 +09004065 hlock = find_held_lock(curr, lock, depth, &i);
4066 if (!hlock) {
4067 print_lock_contention_bug(curr, lock, ip);
4068 return;
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004069 }
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004070
Peter Zijlstrabb97a912009-07-20 19:15:35 +02004071 if (hlock->instance != lock)
4072 return;
4073
Peter Zijlstra3365e7792009-10-09 10:12:41 +02004074 hlock->waittime_stamp = lockstat_clock();
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004075
Peter Zijlstrac7e78cf2008-10-16 23:17:09 +02004076 contention_point = lock_point(hlock_class(hlock)->contention_point, ip);
4077 contending_point = lock_point(hlock_class(hlock)->contending_point,
4078 lock->ip);
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004079
Dave Jonesf82b2172008-08-11 09:30:23 +02004080 stats = get_lock_stats(hlock_class(hlock));
Peter Zijlstrac7e78cf2008-10-16 23:17:09 +02004081 if (contention_point < LOCKSTAT_POINTS)
4082 stats->contention_point[contention_point]++;
4083 if (contending_point < LOCKSTAT_POINTS)
4084 stats->contending_point[contending_point]++;
Peter Zijlstra96645672007-07-19 01:49:00 -07004085 if (lock->cpu != smp_processor_id())
4086 stats->bounces[bounce_contended + !!hlock->read]++;
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004087}
4088
4089static void
Peter Zijlstrac7e78cf2008-10-16 23:17:09 +02004090__lock_acquired(struct lockdep_map *lock, unsigned long ip)
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004091{
4092 struct task_struct *curr = current;
J. R. Okajima41c2c5b2017-02-03 01:38:15 +09004093 struct held_lock *hlock;
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004094 struct lock_class_stats *stats;
4095 unsigned int depth;
Peter Zijlstra3365e7792009-10-09 10:12:41 +02004096 u64 now, waittime = 0;
Peter Zijlstra96645672007-07-19 01:49:00 -07004097 int i, cpu;
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004098
4099 depth = curr->lockdep_depth;
Peter Zijlstra0119fee2011-09-02 01:30:29 +02004100 /*
4101 * Yay, we acquired ownership of this lock we didn't try to
4102 * acquire, how the heck did that happen?
4103 */
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004104 if (DEBUG_LOCKS_WARN_ON(!depth))
4105 return;
4106
J. R. Okajima41c2c5b2017-02-03 01:38:15 +09004107 hlock = find_held_lock(curr, lock, depth, &i);
4108 if (!hlock) {
4109 print_lock_contention_bug(curr, lock, _RET_IP_);
4110 return;
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004111 }
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004112
Peter Zijlstrabb97a912009-07-20 19:15:35 +02004113 if (hlock->instance != lock)
4114 return;
4115
Peter Zijlstra96645672007-07-19 01:49:00 -07004116 cpu = smp_processor_id();
4117 if (hlock->waittime_stamp) {
Peter Zijlstra3365e7792009-10-09 10:12:41 +02004118 now = lockstat_clock();
Peter Zijlstra96645672007-07-19 01:49:00 -07004119 waittime = now - hlock->waittime_stamp;
4120 hlock->holdtime_stamp = now;
4121 }
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004122
Frederic Weisbecker883a2a32010-05-08 06:16:11 +02004123 trace_lock_acquired(lock, ip);
Frederic Weisbecker20625012009-04-06 01:49:33 +02004124
Dave Jonesf82b2172008-08-11 09:30:23 +02004125 stats = get_lock_stats(hlock_class(hlock));
Peter Zijlstra96645672007-07-19 01:49:00 -07004126 if (waittime) {
4127 if (hlock->read)
4128 lock_time_inc(&stats->read_waittime, waittime);
4129 else
4130 lock_time_inc(&stats->write_waittime, waittime);
4131 }
4132 if (lock->cpu != cpu)
4133 stats->bounces[bounce_acquired + !!hlock->read]++;
Peter Zijlstra96645672007-07-19 01:49:00 -07004134
4135 lock->cpu = cpu;
Peter Zijlstrac7e78cf2008-10-16 23:17:09 +02004136 lock->ip = ip;
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004137}
4138
4139void lock_contended(struct lockdep_map *lock, unsigned long ip)
4140{
4141 unsigned long flags;
4142
4143 if (unlikely(!lock_stat))
4144 return;
4145
4146 if (unlikely(current->lockdep_recursion))
4147 return;
4148
4149 raw_local_irq_save(flags);
4150 check_flags(flags);
4151 current->lockdep_recursion = 1;
Frederic Weisbeckerdb2c4c72010-02-02 23:34:40 +01004152 trace_lock_contended(lock, ip);
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004153 __lock_contended(lock, ip);
4154 current->lockdep_recursion = 0;
4155 raw_local_irq_restore(flags);
4156}
4157EXPORT_SYMBOL_GPL(lock_contended);
4158
Peter Zijlstrac7e78cf2008-10-16 23:17:09 +02004159void lock_acquired(struct lockdep_map *lock, unsigned long ip)
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004160{
4161 unsigned long flags;
4162
4163 if (unlikely(!lock_stat))
4164 return;
4165
4166 if (unlikely(current->lockdep_recursion))
4167 return;
4168
4169 raw_local_irq_save(flags);
4170 check_flags(flags);
4171 current->lockdep_recursion = 1;
Peter Zijlstrac7e78cf2008-10-16 23:17:09 +02004172 __lock_acquired(lock, ip);
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004173 current->lockdep_recursion = 0;
4174 raw_local_irq_restore(flags);
4175}
4176EXPORT_SYMBOL_GPL(lock_acquired);
4177#endif
4178
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004179/*
4180 * Used by the testsuite, sanitize the validator state
4181 * after a simulated failure:
4182 */
4183
4184void lockdep_reset(void)
4185{
4186 unsigned long flags;
Ingo Molnar23d95a02006-12-13 00:34:40 -08004187 int i;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004188
4189 raw_local_irq_save(flags);
4190 current->curr_chain_key = 0;
4191 current->lockdep_depth = 0;
4192 current->lockdep_recursion = 0;
4193 memset(current->held_locks, 0, MAX_LOCK_DEPTH*sizeof(struct held_lock));
4194 nr_hardirq_chains = 0;
4195 nr_softirq_chains = 0;
4196 nr_process_chains = 0;
4197 debug_locks = 1;
Ingo Molnar23d95a02006-12-13 00:34:40 -08004198 for (i = 0; i < CHAINHASH_SIZE; i++)
Andrew Mortona63f38c2016-02-03 13:44:12 -08004199 INIT_HLIST_HEAD(chainhash_table + i);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004200 raw_local_irq_restore(flags);
4201}
4202
4203static void zap_class(struct lock_class *class)
4204{
4205 int i;
4206
4207 /*
4208 * Remove all dependencies this lock is
4209 * involved in:
4210 */
4211 for (i = 0; i < nr_list_entries; i++) {
4212 if (list_entries[i].class == class)
4213 list_del_rcu(&list_entries[i].entry);
4214 }
4215 /*
4216 * Unhash the class and remove it from the all_lock_classes list:
4217 */
Andrew Mortona63f38c2016-02-03 13:44:12 -08004218 hlist_del_rcu(&class->hash_entry);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004219 list_del_rcu(&class->lock_entry);
4220
Peter Zijlstracee34d82015-06-02 12:50:13 +02004221 RCU_INIT_POINTER(class->key, NULL);
4222 RCU_INIT_POINTER(class->name, NULL);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004223}
4224
Arjan van de Venfabe8742008-01-24 07:00:45 +01004225static inline int within(const void *addr, void *start, unsigned long size)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004226{
4227 return addr >= start && addr < start + size;
4228}
4229
Peter Zijlstra35a93932015-02-26 16:23:11 +01004230/*
4231 * Used in module.c to remove lock classes from memory that is going to be
4232 * freed; and possibly re-used by other modules.
4233 *
4234 * We will have had one sync_sched() before getting here, so we're guaranteed
4235 * nobody will look up these exact classes -- they're properly dead but still
4236 * allocated.
4237 */
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004238void lockdep_free_key_range(void *start, unsigned long size)
4239{
Peter Zijlstra35a93932015-02-26 16:23:11 +01004240 struct lock_class *class;
Andrew Mortona63f38c2016-02-03 13:44:12 -08004241 struct hlist_head *head;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004242 unsigned long flags;
4243 int i;
Nick Piggin5a26db52008-01-16 09:51:58 +01004244 int locked;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004245
4246 raw_local_irq_save(flags);
Nick Piggin5a26db52008-01-16 09:51:58 +01004247 locked = graph_lock();
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004248
4249 /*
4250 * Unhash all classes that were created by this module:
4251 */
4252 for (i = 0; i < CLASSHASH_SIZE; i++) {
4253 head = classhash_table + i;
Andrew Mortona63f38c2016-02-03 13:44:12 -08004254 hlist_for_each_entry_rcu(class, head, hash_entry) {
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004255 if (within(class->key, start, size))
4256 zap_class(class);
Arjan van de Venfabe8742008-01-24 07:00:45 +01004257 else if (within(class->name, start, size))
4258 zap_class(class);
4259 }
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004260 }
4261
Nick Piggin5a26db52008-01-16 09:51:58 +01004262 if (locked)
4263 graph_unlock();
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004264 raw_local_irq_restore(flags);
Peter Zijlstra35a93932015-02-26 16:23:11 +01004265
4266 /*
4267 * Wait for any possible iterators from look_up_lock_class() to pass
4268 * before continuing to free the memory they refer to.
4269 *
4270 * sync_sched() is sufficient because the read-side is IRQ disable.
4271 */
4272 synchronize_sched();
4273
4274 /*
4275 * XXX at this point we could return the resources to the pool;
4276 * instead we leak them. We would need to change to bitmap allocators
4277 * instead of the linear allocators we have now.
4278 */
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004279}
4280
4281void lockdep_reset_lock(struct lockdep_map *lock)
4282{
Peter Zijlstra35a93932015-02-26 16:23:11 +01004283 struct lock_class *class;
Andrew Mortona63f38c2016-02-03 13:44:12 -08004284 struct hlist_head *head;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004285 unsigned long flags;
4286 int i, j;
Nick Piggin5a26db52008-01-16 09:51:58 +01004287 int locked;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004288
4289 raw_local_irq_save(flags);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004290
4291 /*
Ingo Molnard6d897c2006-07-10 04:44:04 -07004292 * Remove all classes this lock might have:
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004293 */
Ingo Molnard6d897c2006-07-10 04:44:04 -07004294 for (j = 0; j < MAX_LOCKDEP_SUBCLASSES; j++) {
4295 /*
4296 * If the class exists we look it up and zap it:
4297 */
4298 class = look_up_lock_class(lock, j);
Matthew Wilcox64f29d12018-01-17 07:14:12 -08004299 if (class)
Ingo Molnard6d897c2006-07-10 04:44:04 -07004300 zap_class(class);
4301 }
4302 /*
4303 * Debug check: in the end all mapped classes should
4304 * be gone.
4305 */
Nick Piggin5a26db52008-01-16 09:51:58 +01004306 locked = graph_lock();
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004307 for (i = 0; i < CLASSHASH_SIZE; i++) {
4308 head = classhash_table + i;
Andrew Mortona63f38c2016-02-03 13:44:12 -08004309 hlist_for_each_entry_rcu(class, head, hash_entry) {
Hitoshi Mitake62016252010-10-05 18:01:51 +09004310 int match = 0;
4311
4312 for (j = 0; j < NR_LOCKDEP_CACHING_CLASSES; j++)
4313 match |= class == lock->class_cache[j];
4314
4315 if (unlikely(match)) {
Peter Zijlstra0119fee2011-09-02 01:30:29 +02004316 if (debug_locks_off_graph_unlock()) {
4317 /*
4318 * We all just reset everything, how did it match?
4319 */
Ingo Molnar74c383f2006-12-13 00:34:43 -08004320 WARN_ON(1);
Peter Zijlstra0119fee2011-09-02 01:30:29 +02004321 }
Ingo Molnard6d897c2006-07-10 04:44:04 -07004322 goto out_restore;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004323 }
4324 }
4325 }
Nick Piggin5a26db52008-01-16 09:51:58 +01004326 if (locked)
4327 graph_unlock();
Ingo Molnard6d897c2006-07-10 04:44:04 -07004328
4329out_restore:
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004330 raw_local_irq_restore(flags);
4331}
4332
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004333void __init lockdep_info(void)
4334{
4335 printk("Lock dependency validator: Copyright (c) 2006 Red Hat, Inc., Ingo Molnar\n");
4336
Li Zefanb0788ca2008-11-21 15:57:32 +08004337 printk("... MAX_LOCKDEP_SUBCLASSES: %lu\n", MAX_LOCKDEP_SUBCLASSES);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004338 printk("... MAX_LOCK_DEPTH: %lu\n", MAX_LOCK_DEPTH);
4339 printk("... MAX_LOCKDEP_KEYS: %lu\n", MAX_LOCKDEP_KEYS);
Li Zefanb0788ca2008-11-21 15:57:32 +08004340 printk("... CLASSHASH_SIZE: %lu\n", CLASSHASH_SIZE);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004341 printk("... MAX_LOCKDEP_ENTRIES: %lu\n", MAX_LOCKDEP_ENTRIES);
4342 printk("... MAX_LOCKDEP_CHAINS: %lu\n", MAX_LOCKDEP_CHAINS);
4343 printk("... CHAINHASH_SIZE: %lu\n", CHAINHASH_SIZE);
4344
4345 printk(" memory used by lock dependency info: %lu kB\n",
4346 (sizeof(struct lock_class) * MAX_LOCKDEP_KEYS +
4347 sizeof(struct list_head) * CLASSHASH_SIZE +
4348 sizeof(struct lock_list) * MAX_LOCKDEP_ENTRIES +
4349 sizeof(struct lock_chain) * MAX_LOCKDEP_CHAINS +
Ming Lei906292092009-08-02 21:43:36 +08004350 sizeof(struct list_head) * CHAINHASH_SIZE
Ming Lei4dd861d2009-07-16 15:44:29 +02004351#ifdef CONFIG_PROVE_LOCKING
Ming Leie351b662009-07-22 22:48:09 +08004352 + sizeof(struct circular_queue)
Ming Lei4dd861d2009-07-16 15:44:29 +02004353#endif
Ming Lei906292092009-08-02 21:43:36 +08004354 ) / 1024
Ming Lei4dd861d2009-07-16 15:44:29 +02004355 );
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004356
4357 printk(" per task-struct memory footprint: %lu bytes\n",
4358 sizeof(struct held_lock) * MAX_LOCK_DEPTH);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004359}
4360
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004361static void
4362print_freed_lock_bug(struct task_struct *curr, const void *mem_from,
Arjan van de Ven55794a42006-07-10 04:44:03 -07004363 const void *mem_to, struct held_lock *hlock)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004364{
4365 if (!debug_locks_off())
4366 return;
4367 if (debug_locks_silent)
4368 return;
4369
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004370 pr_warn("\n");
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08004371 pr_warn("=========================\n");
4372 pr_warn("WARNING: held lock freed!\n");
Ben Hutchingsfbdc4b92011-10-28 04:36:55 +01004373 print_kernel_ident();
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08004374 pr_warn("-------------------------\n");
Borislav Petkov04860d42018-02-26 14:49:26 +01004375 pr_warn("%s/%d is freeing memory %px-%px, with a lock still held there!\n",
Pavel Emelyanovba25f9d2007-10-18 23:40:40 -07004376 curr->comm, task_pid_nr(curr), mem_from, mem_to-1);
Arjan van de Ven55794a42006-07-10 04:44:03 -07004377 print_lock(hlock);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004378 lockdep_print_held_locks(curr);
4379
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004380 pr_warn("\nstack backtrace:\n");
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004381 dump_stack();
4382}
4383
Oleg Nesterov54561782007-12-05 15:46:09 +01004384static inline int not_in_range(const void* mem_from, unsigned long mem_len,
4385 const void* lock_from, unsigned long lock_len)
4386{
4387 return lock_from + lock_len <= mem_from ||
4388 mem_from + mem_len <= lock_from;
4389}
4390
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004391/*
4392 * Called when kernel memory is freed (or unmapped), or if a lock
4393 * is destroyed or reinitialized - this code checks whether there is
4394 * any held lock in the memory range of <from> to <to>:
4395 */
4396void debug_check_no_locks_freed(const void *mem_from, unsigned long mem_len)
4397{
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004398 struct task_struct *curr = current;
4399 struct held_lock *hlock;
4400 unsigned long flags;
4401 int i;
4402
4403 if (unlikely(!debug_locks))
4404 return;
4405
Steven Rostedt (VMware)fcc784b2018-04-04 14:06:30 -04004406 raw_local_irq_save(flags);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004407 for (i = 0; i < curr->lockdep_depth; i++) {
4408 hlock = curr->held_locks + i;
4409
Oleg Nesterov54561782007-12-05 15:46:09 +01004410 if (not_in_range(mem_from, mem_len, hlock->instance,
4411 sizeof(*hlock->instance)))
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004412 continue;
4413
Oleg Nesterov54561782007-12-05 15:46:09 +01004414 print_freed_lock_bug(curr, mem_from, mem_from + mem_len, hlock);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004415 break;
4416 }
Steven Rostedt (VMware)fcc784b2018-04-04 14:06:30 -04004417 raw_local_irq_restore(flags);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004418}
Peter Zijlstraed075362006-12-06 20:35:24 -08004419EXPORT_SYMBOL_GPL(debug_check_no_locks_freed);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004420
Colin Cross1b1d2fb2013-05-06 23:50:08 +00004421static void print_held_locks_bug(void)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004422{
4423 if (!debug_locks_off())
4424 return;
4425 if (debug_locks_silent)
4426 return;
4427
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004428 pr_warn("\n");
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08004429 pr_warn("====================================\n");
4430 pr_warn("WARNING: %s/%d still has locks held!\n",
Colin Cross1b1d2fb2013-05-06 23:50:08 +00004431 current->comm, task_pid_nr(current));
Ben Hutchingsfbdc4b92011-10-28 04:36:55 +01004432 print_kernel_ident();
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08004433 pr_warn("------------------------------------\n");
Colin Cross1b1d2fb2013-05-06 23:50:08 +00004434 lockdep_print_held_locks(current);
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004435 pr_warn("\nstack backtrace:\n");
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004436 dump_stack();
4437}
4438
Colin Cross1b1d2fb2013-05-06 23:50:08 +00004439void debug_check_no_locks_held(void)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004440{
Colin Cross1b1d2fb2013-05-06 23:50:08 +00004441 if (unlikely(current->lockdep_depth > 0))
4442 print_held_locks_bug();
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004443}
Colin Cross1b1d2fb2013-05-06 23:50:08 +00004444EXPORT_SYMBOL_GPL(debug_check_no_locks_held);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004445
Sasha Levin8dce7a92013-06-13 18:41:16 -04004446#ifdef __KERNEL__
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004447void debug_show_all_locks(void)
4448{
4449 struct task_struct *g, *p;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004450
Jarek Poplawski9c35dd72007-03-22 00:11:28 -08004451 if (unlikely(!debug_locks)) {
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004452 pr_warn("INFO: lockdep is turned off.\n");
Jarek Poplawski9c35dd72007-03-22 00:11:28 -08004453 return;
4454 }
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004455 pr_warn("\nShowing all locks held in the system:\n");
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004456
Tetsuo Handa0f736a52018-04-06 19:41:18 +09004457 rcu_read_lock();
4458 for_each_process_thread(g, p) {
Tetsuo Handa0f736a52018-04-06 19:41:18 +09004459 if (!p->lockdep_depth)
4460 continue;
4461 lockdep_print_held_locks(p);
Tejun Heo88f1c872018-01-22 14:00:55 -08004462 touch_nmi_watchdog();
Tetsuo Handa0f736a52018-04-06 19:41:18 +09004463 touch_all_softlockup_watchdogs();
4464 }
4465 rcu_read_unlock();
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004466
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004467 pr_warn("\n");
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08004468 pr_warn("=============================================\n\n");
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004469}
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004470EXPORT_SYMBOL_GPL(debug_show_all_locks);
Sasha Levin8dce7a92013-06-13 18:41:16 -04004471#endif
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004472
Ingo Molnar82a1fcb2008-01-25 21:08:02 +01004473/*
4474 * Careful: only use this function if you are sure that
4475 * the task cannot run in parallel!
4476 */
John Kacurf1b499f2010-08-05 17:10:53 +02004477void debug_show_held_locks(struct task_struct *task)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004478{
Jarek Poplawski9c35dd72007-03-22 00:11:28 -08004479 if (unlikely(!debug_locks)) {
4480 printk("INFO: lockdep is turned off.\n");
4481 return;
4482 }
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004483 lockdep_print_held_locks(task);
4484}
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004485EXPORT_SYMBOL_GPL(debug_show_held_locks);
Peter Zijlstrab351d162007-10-11 22:11:12 +02004486
Andi Kleen722a9f92014-05-02 00:44:38 +02004487asmlinkage __visible void lockdep_sys_exit(void)
Peter Zijlstrab351d162007-10-11 22:11:12 +02004488{
4489 struct task_struct *curr = current;
4490
4491 if (unlikely(curr->lockdep_depth)) {
4492 if (!debug_locks_off())
4493 return;
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004494 pr_warn("\n");
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08004495 pr_warn("================================================\n");
4496 pr_warn("WARNING: lock held when returning to user space!\n");
Ben Hutchingsfbdc4b92011-10-28 04:36:55 +01004497 print_kernel_ident();
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08004498 pr_warn("------------------------------------------------\n");
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004499 pr_warn("%s/%d is leaving the kernel with locks still held!\n",
Peter Zijlstrab351d162007-10-11 22:11:12 +02004500 curr->comm, curr->pid);
4501 lockdep_print_held_locks(curr);
4502 }
Byungchul Parkb09be672017-08-07 16:12:52 +09004503
4504 /*
4505 * The lock history for each syscall should be independent. So wipe the
4506 * slate clean on return to userspace.
4507 */
Peter Zijlstraf52be572017-08-29 10:59:39 +02004508 lockdep_invariant_state(false);
Peter Zijlstrab351d162007-10-11 22:11:12 +02004509}
Paul E. McKenney0632eb32010-02-22 17:04:47 -08004510
Paul E. McKenneyb3fbab02011-05-24 08:31:09 -07004511void lockdep_rcu_suspicious(const char *file, const int line, const char *s)
Paul E. McKenney0632eb32010-02-22 17:04:47 -08004512{
4513 struct task_struct *curr = current;
4514
Lai Jiangshan2b3fc352010-04-20 16:23:07 +08004515 /* Note: the following can be executed concurrently, so be careful. */
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004516 pr_warn("\n");
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08004517 pr_warn("=============================\n");
4518 pr_warn("WARNING: suspicious RCU usage\n");
Ben Hutchingsfbdc4b92011-10-28 04:36:55 +01004519 print_kernel_ident();
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08004520 pr_warn("-----------------------------\n");
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004521 pr_warn("%s:%d %s!\n", file, line, s);
4522 pr_warn("\nother info that might help us debug this:\n\n");
4523 pr_warn("\n%srcu_scheduler_active = %d, debug_locks = %d\n",
Paul E. McKenneyc5fdcec2012-01-30 08:46:32 -08004524 !rcu_lockdep_current_cpu_online()
4525 ? "RCU used illegally from offline CPU!\n"
Paul E. McKenney5c173eb2013-09-13 17:20:11 -07004526 : !rcu_is_watching()
Paul E. McKenneyc5fdcec2012-01-30 08:46:32 -08004527 ? "RCU used illegally from idle CPU!\n"
4528 : "",
4529 rcu_scheduler_active, debug_locks);
Frederic Weisbecker0464e932011-10-07 18:22:01 +02004530
4531 /*
4532 * If a CPU is in the RCU-free window in idle (ie: in the section
4533 * between rcu_idle_enter() and rcu_idle_exit(), then RCU
4534 * considers that CPU to be in an "extended quiescent state",
4535 * which means that RCU will be completely ignoring that CPU.
4536 * Therefore, rcu_read_lock() and friends have absolutely no
4537 * effect on a CPU running in that state. In other words, even if
4538 * such an RCU-idle CPU has called rcu_read_lock(), RCU might well
4539 * delete data structures out from under it. RCU really has no
4540 * choice here: we need to keep an RCU-free window in idle where
4541 * the CPU may possibly enter into low power mode. This way we can
4542 * notice an extended quiescent state to other CPUs that started a grace
4543 * period. Otherwise we would delay any grace period as long as we run
4544 * in the idle task.
4545 *
4546 * So complain bitterly if someone does call rcu_read_lock(),
4547 * rcu_read_lock_bh() and so on from extended quiescent states.
4548 */
Paul E. McKenney5c173eb2013-09-13 17:20:11 -07004549 if (!rcu_is_watching())
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004550 pr_warn("RCU used illegally from extended quiescent state!\n");
Frederic Weisbecker0464e932011-10-07 18:22:01 +02004551
Paul E. McKenney0632eb32010-02-22 17:04:47 -08004552 lockdep_print_held_locks(curr);
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004553 pr_warn("\nstack backtrace:\n");
Paul E. McKenney0632eb32010-02-22 17:04:47 -08004554 dump_stack();
4555}
Paul E. McKenneyb3fbab02011-05-24 08:31:09 -07004556EXPORT_SYMBOL_GPL(lockdep_rcu_suspicious);