blob: ef27f98714c09864822937b34921cbd8edca3035 [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;
Waiman Long8ca2b56c2018-10-03 13:07:18 -0400141struct lock_class lock_classes[MAX_LOCKDEP_KEYS];
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700142
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);
Waiman Long8ca2b56c2018-10-03 13:07:18 -04001394#ifdef CONFIG_DEBUG_LOCKDEP
1395 printk(KERN_CONT " ops: %lu", debug_class_ops_read(class));
1396#endif
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01001397 printk(KERN_CONT " {\n");
Peter Zijlstraaf012962009-07-16 15:44:29 +02001398
1399 for (bit = 0; bit < LOCK_USAGE_STATES; bit++) {
1400 if (class->usage_mask & (1 << bit)) {
1401 int len = depth;
1402
1403 len += printk("%*s %s", depth, "", usage_str[bit]);
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01001404 len += printk(KERN_CONT " at:\n");
Peter Zijlstraaf012962009-07-16 15:44:29 +02001405 print_stack_trace(class->usage_traces + bit, len);
1406 }
1407 }
1408 printk("%*s }\n", depth, "");
1409
Borislav Petkov04860d42018-02-26 14:49:26 +01001410 printk("%*s ... key at: [<%px>] %pS\n",
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01001411 depth, "", class->key, class->key);
Peter Zijlstraaf012962009-07-16 15:44:29 +02001412}
1413
1414/*
1415 * printk the shortest lock dependencies from @start to @end in reverse order:
1416 */
1417static void __used
1418print_shortest_lock_dependencies(struct lock_list *leaf,
1419 struct lock_list *root)
1420{
1421 struct lock_list *entry = leaf;
1422 int depth;
1423
1424 /*compute depth from generated tree by BFS*/
1425 depth = get_lock_depth(leaf);
1426
1427 do {
1428 print_lock_class_header(entry->class, depth);
1429 printk("%*s ... acquired at:\n", depth, "");
1430 print_stack_trace(&entry->trace, 2);
1431 printk("\n");
1432
1433 if (depth == 0 && (entry != root)) {
Steven Rostedt6be8c392011-04-20 21:41:58 -04001434 printk("lockdep:%s bad path found in chain graph\n", __func__);
Peter Zijlstraaf012962009-07-16 15:44:29 +02001435 break;
1436 }
1437
1438 entry = get_lock_parent(entry);
1439 depth--;
1440 } while (entry && (depth >= 0));
1441
1442 return;
1443}
Ming Leid7aaba12009-07-16 15:44:29 +02001444
Steven Rostedt3003eba2011-04-20 21:41:54 -04001445static void
1446print_irq_lock_scenario(struct lock_list *safe_entry,
1447 struct lock_list *unsafe_entry,
Steven Rostedtdad3d742011-04-20 21:41:57 -04001448 struct lock_class *prev_class,
1449 struct lock_class *next_class)
Steven Rostedt3003eba2011-04-20 21:41:54 -04001450{
1451 struct lock_class *safe_class = safe_entry->class;
1452 struct lock_class *unsafe_class = unsafe_entry->class;
Steven Rostedtdad3d742011-04-20 21:41:57 -04001453 struct lock_class *middle_class = prev_class;
Steven Rostedt3003eba2011-04-20 21:41:54 -04001454
1455 if (middle_class == safe_class)
Steven Rostedtdad3d742011-04-20 21:41:57 -04001456 middle_class = next_class;
Steven Rostedt3003eba2011-04-20 21:41:54 -04001457
1458 /*
1459 * A direct locking problem where unsafe_class lock is taken
1460 * directly by safe_class lock, then all we need to show
1461 * is the deadlock scenario, as it is obvious that the
1462 * unsafe lock is taken under the safe lock.
1463 *
1464 * But if there is a chain instead, where the safe lock takes
1465 * an intermediate lock (middle_class) where this lock is
1466 * not the same as the safe lock, then the lock chain is
1467 * used to describe the problem. Otherwise we would need
1468 * to show a different CPU case for each link in the chain
1469 * from the safe_class lock to the unsafe_class lock.
1470 */
1471 if (middle_class != unsafe_class) {
1472 printk("Chain exists of:\n ");
1473 __print_lock_name(safe_class);
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01001474 printk(KERN_CONT " --> ");
Steven Rostedt3003eba2011-04-20 21:41:54 -04001475 __print_lock_name(middle_class);
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01001476 printk(KERN_CONT " --> ");
Steven Rostedt3003eba2011-04-20 21:41:54 -04001477 __print_lock_name(unsafe_class);
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01001478 printk(KERN_CONT "\n\n");
Steven Rostedt3003eba2011-04-20 21:41:54 -04001479 }
1480
1481 printk(" Possible interrupt unsafe locking scenario:\n\n");
1482 printk(" CPU0 CPU1\n");
1483 printk(" ---- ----\n");
1484 printk(" lock(");
1485 __print_lock_name(unsafe_class);
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01001486 printk(KERN_CONT ");\n");
Steven Rostedt3003eba2011-04-20 21:41:54 -04001487 printk(" local_irq_disable();\n");
1488 printk(" lock(");
1489 __print_lock_name(safe_class);
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01001490 printk(KERN_CONT ");\n");
Steven Rostedt3003eba2011-04-20 21:41:54 -04001491 printk(" lock(");
1492 __print_lock_name(middle_class);
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01001493 printk(KERN_CONT ");\n");
Steven Rostedt3003eba2011-04-20 21:41:54 -04001494 printk(" <Interrupt>\n");
1495 printk(" lock(");
1496 __print_lock_name(safe_class);
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01001497 printk(KERN_CONT ");\n");
Steven Rostedt3003eba2011-04-20 21:41:54 -04001498 printk("\n *** DEADLOCK ***\n\n");
1499}
1500
Peter Zijlstra8e182572007-07-19 01:48:54 -07001501static int
1502print_bad_irq_dependency(struct task_struct *curr,
Ming Lei24208ca2009-07-16 15:44:29 +02001503 struct lock_list *prev_root,
1504 struct lock_list *next_root,
1505 struct lock_list *backwards_entry,
1506 struct lock_list *forwards_entry,
Peter Zijlstra8e182572007-07-19 01:48:54 -07001507 struct held_lock *prev,
1508 struct held_lock *next,
1509 enum lock_usage_bit bit1,
1510 enum lock_usage_bit bit2,
1511 const char *irqclass)
1512{
1513 if (!debug_locks_off_graph_unlock() || debug_locks_silent)
1514 return 0;
1515
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001516 pr_warn("\n");
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08001517 pr_warn("=====================================================\n");
1518 pr_warn("WARNING: %s-safe -> %s-unsafe lock order detected\n",
Peter Zijlstra8e182572007-07-19 01:48:54 -07001519 irqclass, irqclass);
Ben Hutchingsfbdc4b92011-10-28 04:36:55 +01001520 print_kernel_ident();
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08001521 pr_warn("-----------------------------------------------------\n");
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001522 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 -07001523 curr->comm, task_pid_nr(curr),
Peter Zijlstra8e182572007-07-19 01:48:54 -07001524 curr->hardirq_context, hardirq_count() >> HARDIRQ_SHIFT,
1525 curr->softirq_context, softirq_count() >> SOFTIRQ_SHIFT,
1526 curr->hardirqs_enabled,
1527 curr->softirqs_enabled);
1528 print_lock(next);
1529
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001530 pr_warn("\nand this task is already holding:\n");
Peter Zijlstra8e182572007-07-19 01:48:54 -07001531 print_lock(prev);
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001532 pr_warn("which would create a new lock dependency:\n");
Dave Jonesf82b2172008-08-11 09:30:23 +02001533 print_lock_name(hlock_class(prev));
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001534 pr_cont(" ->");
Dave Jonesf82b2172008-08-11 09:30:23 +02001535 print_lock_name(hlock_class(next));
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001536 pr_cont("\n");
Peter Zijlstra8e182572007-07-19 01:48:54 -07001537
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001538 pr_warn("\nbut this new dependency connects a %s-irq-safe lock:\n",
Peter Zijlstra8e182572007-07-19 01:48:54 -07001539 irqclass);
Ming Lei24208ca2009-07-16 15:44:29 +02001540 print_lock_name(backwards_entry->class);
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001541 pr_warn("\n... which became %s-irq-safe at:\n", irqclass);
Peter Zijlstra8e182572007-07-19 01:48:54 -07001542
Ming Lei24208ca2009-07-16 15:44:29 +02001543 print_stack_trace(backwards_entry->class->usage_traces + bit1, 1);
Peter Zijlstra8e182572007-07-19 01:48:54 -07001544
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001545 pr_warn("\nto a %s-irq-unsafe lock:\n", irqclass);
Ming Lei24208ca2009-07-16 15:44:29 +02001546 print_lock_name(forwards_entry->class);
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001547 pr_warn("\n... which became %s-irq-unsafe at:\n", irqclass);
1548 pr_warn("...");
Peter Zijlstra8e182572007-07-19 01:48:54 -07001549
Ming Lei24208ca2009-07-16 15:44:29 +02001550 print_stack_trace(forwards_entry->class->usage_traces + bit2, 1);
Peter Zijlstra8e182572007-07-19 01:48:54 -07001551
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001552 pr_warn("\nother info that might help us debug this:\n\n");
Steven Rostedtdad3d742011-04-20 21:41:57 -04001553 print_irq_lock_scenario(backwards_entry, forwards_entry,
1554 hlock_class(prev), hlock_class(next));
Steven Rostedt3003eba2011-04-20 21:41:54 -04001555
Peter Zijlstra8e182572007-07-19 01:48:54 -07001556 lockdep_print_held_locks(curr);
1557
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001558 pr_warn("\nthe dependencies between %s-irq-safe lock and the holding lock:\n", irqclass);
Ming Lei24208ca2009-07-16 15:44:29 +02001559 if (!save_trace(&prev_root->trace))
1560 return 0;
1561 print_shortest_lock_dependencies(backwards_entry, prev_root);
Peter Zijlstra8e182572007-07-19 01:48:54 -07001562
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001563 pr_warn("\nthe dependencies between the lock to be acquired");
1564 pr_warn(" and %s-irq-unsafe lock:\n", irqclass);
Ming Lei24208ca2009-07-16 15:44:29 +02001565 if (!save_trace(&next_root->trace))
1566 return 0;
1567 print_shortest_lock_dependencies(forwards_entry, next_root);
Peter Zijlstra8e182572007-07-19 01:48:54 -07001568
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001569 pr_warn("\nstack backtrace:\n");
Peter Zijlstra8e182572007-07-19 01:48:54 -07001570 dump_stack();
1571
1572 return 0;
1573}
1574
1575static int
1576check_usage(struct task_struct *curr, struct held_lock *prev,
1577 struct held_lock *next, enum lock_usage_bit bit_backwards,
1578 enum lock_usage_bit bit_forwards, const char *irqclass)
1579{
1580 int ret;
Ming Lei24208ca2009-07-16 15:44:29 +02001581 struct lock_list this, that;
Ming Leid7aaba12009-07-16 15:44:29 +02001582 struct lock_list *uninitialized_var(target_entry);
Ming Lei24208ca2009-07-16 15:44:29 +02001583 struct lock_list *uninitialized_var(target_entry1);
Peter Zijlstra8e182572007-07-19 01:48:54 -07001584
Ming Leid7aaba12009-07-16 15:44:29 +02001585 this.parent = NULL;
Peter Zijlstra8e182572007-07-19 01:48:54 -07001586
Ming Leid7aaba12009-07-16 15:44:29 +02001587 this.class = hlock_class(prev);
1588 ret = find_usage_backwards(&this, bit_backwards, &target_entry);
Peter Zijlstraaf012962009-07-16 15:44:29 +02001589 if (ret < 0)
1590 return print_bfs_bug(ret);
1591 if (ret == 1)
1592 return ret;
Ming Leid7aaba12009-07-16 15:44:29 +02001593
Ming Lei24208ca2009-07-16 15:44:29 +02001594 that.parent = NULL;
1595 that.class = hlock_class(next);
1596 ret = find_usage_forwards(&that, bit_forwards, &target_entry1);
Peter Zijlstraaf012962009-07-16 15:44:29 +02001597 if (ret < 0)
1598 return print_bfs_bug(ret);
1599 if (ret == 1)
1600 return ret;
Ming Leid7aaba12009-07-16 15:44:29 +02001601
Ming Lei24208ca2009-07-16 15:44:29 +02001602 return print_bad_irq_dependency(curr, &this, &that,
1603 target_entry, target_entry1,
1604 prev, next,
Peter Zijlstra8e182572007-07-19 01:48:54 -07001605 bit_backwards, bit_forwards, irqclass);
1606}
1607
Peter Zijlstra4f367d8a2009-01-22 18:10:42 +01001608static const char *state_names[] = {
1609#define LOCKDEP_STATE(__STATE) \
Peter Zijlstrab4b136f2009-01-29 14:50:36 +01001610 __stringify(__STATE),
Peter Zijlstra4f367d8a2009-01-22 18:10:42 +01001611#include "lockdep_states.h"
1612#undef LOCKDEP_STATE
1613};
1614
1615static const char *state_rnames[] = {
1616#define LOCKDEP_STATE(__STATE) \
Peter Zijlstrab4b136f2009-01-29 14:50:36 +01001617 __stringify(__STATE)"-READ",
Peter Zijlstra4f367d8a2009-01-22 18:10:42 +01001618#include "lockdep_states.h"
1619#undef LOCKDEP_STATE
1620};
1621
1622static inline const char *state_name(enum lock_usage_bit bit)
1623{
1624 return (bit & 1) ? state_rnames[bit >> 2] : state_names[bit >> 2];
1625}
1626
1627static int exclusive_bit(int new_bit)
1628{
1629 /*
1630 * USED_IN
1631 * USED_IN_READ
1632 * ENABLED
1633 * ENABLED_READ
1634 *
1635 * bit 0 - write/read
1636 * bit 1 - used_in/enabled
1637 * bit 2+ state
1638 */
1639
1640 int state = new_bit & ~3;
1641 int dir = new_bit & 2;
1642
1643 /*
1644 * keep state, bit flip the direction and strip read.
1645 */
1646 return state | (dir ^ 2);
1647}
1648
1649static int check_irq_usage(struct task_struct *curr, struct held_lock *prev,
1650 struct held_lock *next, enum lock_usage_bit bit)
Peter Zijlstra8e182572007-07-19 01:48:54 -07001651{
1652 /*
1653 * Prove that the new dependency does not connect a hardirq-safe
1654 * lock with a hardirq-unsafe lock - to achieve this we search
1655 * the backwards-subgraph starting at <prev>, and the
1656 * forwards-subgraph starting at <next>:
1657 */
Peter Zijlstra4f367d8a2009-01-22 18:10:42 +01001658 if (!check_usage(curr, prev, next, bit,
1659 exclusive_bit(bit), state_name(bit)))
Peter Zijlstra8e182572007-07-19 01:48:54 -07001660 return 0;
1661
Peter Zijlstra4f367d8a2009-01-22 18:10:42 +01001662 bit++; /* _READ */
1663
Peter Zijlstra8e182572007-07-19 01:48:54 -07001664 /*
1665 * Prove that the new dependency does not connect a hardirq-safe-read
1666 * lock with a hardirq-unsafe lock - to achieve this we search
1667 * the backwards-subgraph starting at <prev>, and the
1668 * forwards-subgraph starting at <next>:
1669 */
Peter Zijlstra4f367d8a2009-01-22 18:10:42 +01001670 if (!check_usage(curr, prev, next, bit,
1671 exclusive_bit(bit), state_name(bit)))
Peter Zijlstra8e182572007-07-19 01:48:54 -07001672 return 0;
1673
Peter Zijlstra4f367d8a2009-01-22 18:10:42 +01001674 return 1;
1675}
Peter Zijlstra8e182572007-07-19 01:48:54 -07001676
Peter Zijlstra4f367d8a2009-01-22 18:10:42 +01001677static int
1678check_prev_add_irq(struct task_struct *curr, struct held_lock *prev,
1679 struct held_lock *next)
1680{
1681#define LOCKDEP_STATE(__STATE) \
1682 if (!check_irq_usage(curr, prev, next, LOCK_USED_IN_##__STATE)) \
Nick Piggincf40bd12009-01-21 08:12:39 +01001683 return 0;
Peter Zijlstra4f367d8a2009-01-22 18:10:42 +01001684#include "lockdep_states.h"
1685#undef LOCKDEP_STATE
Nick Piggincf40bd12009-01-21 08:12:39 +01001686
Peter Zijlstra8e182572007-07-19 01:48:54 -07001687 return 1;
1688}
1689
1690static void inc_chains(void)
1691{
1692 if (current->hardirq_context)
1693 nr_hardirq_chains++;
1694 else {
1695 if (current->softirq_context)
1696 nr_softirq_chains++;
1697 else
1698 nr_process_chains++;
1699 }
1700}
1701
1702#else
1703
1704static inline int
1705check_prev_add_irq(struct task_struct *curr, struct held_lock *prev,
1706 struct held_lock *next)
1707{
1708 return 1;
1709}
1710
1711static inline void inc_chains(void)
1712{
1713 nr_process_chains++;
1714}
1715
1716#endif
1717
Steven Rostedt48702ec2011-04-20 21:41:56 -04001718static void
1719print_deadlock_scenario(struct held_lock *nxt,
1720 struct held_lock *prv)
1721{
1722 struct lock_class *next = hlock_class(nxt);
1723 struct lock_class *prev = hlock_class(prv);
1724
1725 printk(" Possible unsafe locking scenario:\n\n");
1726 printk(" CPU0\n");
1727 printk(" ----\n");
1728 printk(" lock(");
1729 __print_lock_name(prev);
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01001730 printk(KERN_CONT ");\n");
Steven Rostedt48702ec2011-04-20 21:41:56 -04001731 printk(" lock(");
1732 __print_lock_name(next);
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01001733 printk(KERN_CONT ");\n");
Steven Rostedt48702ec2011-04-20 21:41:56 -04001734 printk("\n *** DEADLOCK ***\n\n");
1735 printk(" May be due to missing lock nesting notation\n\n");
1736}
1737
Peter Zijlstra8e182572007-07-19 01:48:54 -07001738static int
1739print_deadlock_bug(struct task_struct *curr, struct held_lock *prev,
1740 struct held_lock *next)
1741{
1742 if (!debug_locks_off_graph_unlock() || debug_locks_silent)
1743 return 0;
1744
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001745 pr_warn("\n");
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08001746 pr_warn("============================================\n");
1747 pr_warn("WARNING: possible recursive locking detected\n");
Ben Hutchingsfbdc4b92011-10-28 04:36:55 +01001748 print_kernel_ident();
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08001749 pr_warn("--------------------------------------------\n");
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001750 pr_warn("%s/%d is trying to acquire lock:\n",
Pavel Emelyanovba25f9d2007-10-18 23:40:40 -07001751 curr->comm, task_pid_nr(curr));
Peter Zijlstra8e182572007-07-19 01:48:54 -07001752 print_lock(next);
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001753 pr_warn("\nbut task is already holding lock:\n");
Peter Zijlstra8e182572007-07-19 01:48:54 -07001754 print_lock(prev);
1755
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001756 pr_warn("\nother info that might help us debug this:\n");
Steven Rostedt48702ec2011-04-20 21:41:56 -04001757 print_deadlock_scenario(next, prev);
Peter Zijlstra8e182572007-07-19 01:48:54 -07001758 lockdep_print_held_locks(curr);
1759
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001760 pr_warn("\nstack backtrace:\n");
Peter Zijlstra8e182572007-07-19 01:48:54 -07001761 dump_stack();
1762
1763 return 0;
1764}
1765
1766/*
1767 * Check whether we are holding such a class already.
1768 *
1769 * (Note that this has to be done separately, because the graph cannot
1770 * detect such classes of deadlocks.)
1771 *
1772 * Returns: 0 on deadlock detected, 1 on OK, 2 on recursive read
1773 */
1774static int
1775check_deadlock(struct task_struct *curr, struct held_lock *next,
1776 struct lockdep_map *next_instance, int read)
1777{
1778 struct held_lock *prev;
Peter Zijlstra7531e2f2008-08-11 09:30:24 +02001779 struct held_lock *nest = NULL;
Peter Zijlstra8e182572007-07-19 01:48:54 -07001780 int i;
1781
1782 for (i = 0; i < curr->lockdep_depth; i++) {
1783 prev = curr->held_locks + i;
Peter Zijlstra7531e2f2008-08-11 09:30:24 +02001784
1785 if (prev->instance == next->nest_lock)
1786 nest = prev;
1787
Dave Jonesf82b2172008-08-11 09:30:23 +02001788 if (hlock_class(prev) != hlock_class(next))
Peter Zijlstra8e182572007-07-19 01:48:54 -07001789 continue;
Peter Zijlstra7531e2f2008-08-11 09:30:24 +02001790
Peter Zijlstra8e182572007-07-19 01:48:54 -07001791 /*
1792 * Allow read-after-read recursion of the same
1793 * lock class (i.e. read_lock(lock)+read_lock(lock)):
1794 */
1795 if ((read == 2) && prev->read)
1796 return 2;
Peter Zijlstra7531e2f2008-08-11 09:30:24 +02001797
1798 /*
1799 * We're holding the nest_lock, which serializes this lock's
1800 * nesting behaviour.
1801 */
1802 if (nest)
1803 return 2;
1804
Peter Zijlstra8e182572007-07-19 01:48:54 -07001805 return print_deadlock_bug(curr, prev, next);
1806 }
1807 return 1;
1808}
1809
1810/*
1811 * There was a chain-cache miss, and we are about to add a new dependency
1812 * to a previous lock. We recursively validate the following rules:
1813 *
1814 * - would the adding of the <prev> -> <next> dependency create a
1815 * circular dependency in the graph? [== circular deadlock]
1816 *
1817 * - does the new prev->next dependency connect any hardirq-safe lock
1818 * (in the full backwards-subgraph starting at <prev>) with any
1819 * hardirq-unsafe lock (in the full forwards-subgraph starting at
1820 * <next>)? [== illegal lock inversion with hardirq contexts]
1821 *
1822 * - does the new prev->next dependency connect any softirq-safe lock
1823 * (in the full backwards-subgraph starting at <prev>) with any
1824 * softirq-unsafe lock (in the full forwards-subgraph starting at
1825 * <next>)? [== illegal lock inversion with softirq contexts]
1826 *
1827 * any of these scenarios could lead to a deadlock.
1828 *
1829 * Then if all the validations pass, we add the forwards and backwards
1830 * dependency.
1831 */
1832static int
1833check_prev_add(struct task_struct *curr, struct held_lock *prev,
Byungchul Parkce07a9412017-08-07 16:12:51 +09001834 struct held_lock *next, int distance, struct stack_trace *trace,
1835 int (*save)(struct stack_trace *trace))
Peter Zijlstra8e182572007-07-19 01:48:54 -07001836{
Ming Leidb0002a2009-07-16 15:44:29 +02001837 struct lock_list *uninitialized_var(target_entry);
Peter Zijlstra8b405d52017-10-04 11:13:37 +02001838 struct lock_list *entry;
1839 struct lock_list this;
1840 int ret;
Peter Zijlstra8e182572007-07-19 01:48:54 -07001841
1842 /*
1843 * Prove that the new <prev> -> <next> dependency would not
1844 * create a circular dependency in the graph. (We do this by
1845 * forward-recursing into the graph starting at <next>, and
1846 * checking whether we can reach <prev>.)
1847 *
1848 * We are using global variables to control the recursion, to
1849 * keep the stackframe size of the recursive functions low:
1850 */
Ming Leidb0002a2009-07-16 15:44:29 +02001851 this.class = hlock_class(next);
1852 this.parent = NULL;
1853 ret = check_noncircular(&this, hlock_class(prev), &target_entry);
Peter Zijlstra8b405d52017-10-04 11:13:37 +02001854 if (unlikely(!ret)) {
1855 if (!trace->entries) {
1856 /*
1857 * If @save fails here, the printing might trigger
1858 * a WARN but because of the !nr_entries it should
1859 * not do bad things.
1860 */
1861 save(trace);
1862 }
Byungchul Park383a4bc2017-08-07 16:12:55 +09001863 return print_circular_bug(&this, target_entry, next, prev, trace);
Peter Zijlstra8b405d52017-10-04 11:13:37 +02001864 }
Ming Leidb0002a2009-07-16 15:44:29 +02001865 else if (unlikely(ret < 0))
1866 return print_bfs_bug(ret);
Ming Leic94aa5c2009-07-16 15:44:29 +02001867
Peter Zijlstra8e182572007-07-19 01:48:54 -07001868 if (!check_prev_add_irq(curr, prev, next))
1869 return 0;
1870
1871 /*
1872 * For recursive read-locks we do all the dependency checks,
1873 * but we dont store read-triggered dependencies (only
1874 * write-triggered dependencies). This ensures that only the
1875 * write-side dependencies matter, and that if for example a
1876 * write-lock never takes any other locks, then the reads are
1877 * equivalent to a NOP.
1878 */
1879 if (next->read == 2 || prev->read == 2)
1880 return 1;
1881 /*
1882 * Is the <prev> -> <next> dependency already present?
1883 *
1884 * (this may occur even though this is a new chain: consider
1885 * e.g. the L1 -> L2 -> L3 -> L4 and the L5 -> L1 -> L2 -> L3
1886 * chains - the second one will be new, but L1 already has
1887 * L2 added to its dependency list, due to the first chain.)
1888 */
Dave Jonesf82b2172008-08-11 09:30:23 +02001889 list_for_each_entry(entry, &hlock_class(prev)->locks_after, entry) {
1890 if (entry->class == hlock_class(next)) {
Peter Zijlstra8e182572007-07-19 01:48:54 -07001891 if (distance == 1)
1892 entry->distance = 1;
Byungchul Park70911fd2017-08-07 16:12:50 +09001893 return 1;
Peter Zijlstra8e182572007-07-19 01:48:54 -07001894 }
1895 }
1896
Peter Zijlstraae813302017-03-03 10:13:38 +01001897 /*
1898 * Is the <prev> -> <next> link redundant?
1899 */
1900 this.class = hlock_class(prev);
1901 this.parent = NULL;
1902 ret = check_redundant(&this, hlock_class(next), &target_entry);
1903 if (!ret) {
1904 debug_atomic_inc(nr_redundant);
1905 return 2;
1906 }
1907 if (ret < 0)
1908 return print_bfs_bug(ret);
1909
1910
Peter Zijlstra8b405d52017-10-04 11:13:37 +02001911 if (!trace->entries && !save(trace))
Byungchul Parkce07a9412017-08-07 16:12:51 +09001912 return 0;
Yong Zhang4726f2a2010-05-04 14:16:48 +08001913
Peter Zijlstra8e182572007-07-19 01:48:54 -07001914 /*
1915 * Ok, all validations passed, add the new lock
1916 * to the previous lock's dependency list:
1917 */
Tahsin Erdogan83f06162016-11-08 00:02:07 -08001918 ret = add_lock_to_list(hlock_class(next),
Dave Jonesf82b2172008-08-11 09:30:23 +02001919 &hlock_class(prev)->locks_after,
Byungchul Parkce07a9412017-08-07 16:12:51 +09001920 next->acquire_ip, distance, trace);
Peter Zijlstra8e182572007-07-19 01:48:54 -07001921
1922 if (!ret)
1923 return 0;
1924
Tahsin Erdogan83f06162016-11-08 00:02:07 -08001925 ret = add_lock_to_list(hlock_class(prev),
Dave Jonesf82b2172008-08-11 09:30:23 +02001926 &hlock_class(next)->locks_before,
Byungchul Parkce07a9412017-08-07 16:12:51 +09001927 next->acquire_ip, distance, trace);
Peter Zijlstra8e182572007-07-19 01:48:54 -07001928 if (!ret)
1929 return 0;
1930
Byungchul Park70911fd2017-08-07 16:12:50 +09001931 return 2;
Peter Zijlstra8e182572007-07-19 01:48:54 -07001932}
1933
1934/*
1935 * Add the dependency to all directly-previous locks that are 'relevant'.
1936 * The ones that are relevant are (in increasing distance from curr):
1937 * all consecutive trylock entries and the final non-trylock entry - or
1938 * the end of this context's lock-chain - whichever comes first.
1939 */
1940static int
1941check_prevs_add(struct task_struct *curr, struct held_lock *next)
1942{
1943 int depth = curr->lockdep_depth;
1944 struct held_lock *hlock;
Peter Zijlstra8b405d52017-10-04 11:13:37 +02001945 struct stack_trace trace = {
1946 .nr_entries = 0,
1947 .max_entries = 0,
1948 .entries = NULL,
1949 .skip = 0,
1950 };
Peter Zijlstra8e182572007-07-19 01:48:54 -07001951
1952 /*
1953 * Debugging checks.
1954 *
1955 * Depth must not be zero for a non-head lock:
1956 */
1957 if (!depth)
1958 goto out_bug;
1959 /*
1960 * At least two relevant locks must exist for this
1961 * to be a head:
1962 */
1963 if (curr->held_locks[depth].irq_context !=
1964 curr->held_locks[depth-1].irq_context)
1965 goto out_bug;
1966
1967 for (;;) {
1968 int distance = curr->lockdep_depth - depth + 1;
Oleg Nesterov1b5ff812014-01-20 19:20:10 +01001969 hlock = curr->held_locks + depth - 1;
Byungchul Parkce07a9412017-08-07 16:12:51 +09001970
Ingo Molnare966eae2017-12-12 12:31:16 +01001971 /*
1972 * Only non-recursive-read entries get new dependencies
1973 * added:
1974 */
1975 if (hlock->read != 2 && hlock->check) {
1976 int ret = check_prev_add(curr, hlock, next, distance, &trace, save_trace);
1977 if (!ret)
1978 return 0;
1979
1980 /*
1981 * Stop after the first non-trylock entry,
1982 * as non-trylock entries have added their
1983 * own direct dependencies already, so this
1984 * lock is connected to them indirectly:
1985 */
1986 if (!hlock->trylock)
1987 break;
Peter Zijlstra8e182572007-07-19 01:48:54 -07001988 }
Ingo Molnare966eae2017-12-12 12:31:16 +01001989
Peter Zijlstra8e182572007-07-19 01:48:54 -07001990 depth--;
1991 /*
1992 * End of lock-stack?
1993 */
1994 if (!depth)
1995 break;
1996 /*
1997 * Stop the search if we cross into another context:
1998 */
1999 if (curr->held_locks[depth].irq_context !=
2000 curr->held_locks[depth-1].irq_context)
2001 break;
2002 }
2003 return 1;
2004out_bug:
2005 if (!debug_locks_off_graph_unlock())
2006 return 0;
2007
Peter Zijlstra0119fee2011-09-02 01:30:29 +02002008 /*
2009 * Clearly we all shouldn't be here, but since we made it we
2010 * can reliable say we messed up our state. See the above two
2011 * gotos for reasons why we could possibly end up here.
2012 */
Peter Zijlstra8e182572007-07-19 01:48:54 -07002013 WARN_ON(1);
2014
2015 return 0;
2016}
2017
2018unsigned long nr_lock_chains;
Huang, Ying443cd502008-06-20 16:39:21 +08002019struct lock_chain lock_chains[MAX_LOCKDEP_CHAINS];
Huang, Yingcd1a28e2008-06-23 11:20:54 +08002020int nr_chain_hlocks;
Huang, Ying443cd502008-06-20 16:39:21 +08002021static u16 chain_hlocks[MAX_LOCKDEP_CHAIN_HLOCKS];
2022
2023struct lock_class *lock_chain_get_class(struct lock_chain *chain, int i)
2024{
2025 return lock_classes + chain_hlocks[chain->base + i];
2026}
Peter Zijlstra8e182572007-07-19 01:48:54 -07002027
2028/*
Ingo Molnar9e4e7552016-02-29 10:03:58 +01002029 * Returns the index of the first held_lock of the current chain
2030 */
2031static inline int get_first_held_lock(struct task_struct *curr,
2032 struct held_lock *hlock)
2033{
2034 int i;
2035 struct held_lock *hlock_curr;
2036
2037 for (i = curr->lockdep_depth - 1; i >= 0; i--) {
2038 hlock_curr = curr->held_locks + i;
2039 if (hlock_curr->irq_context != hlock->irq_context)
2040 break;
2041
2042 }
2043
2044 return ++i;
2045}
2046
Borislav Petkov5c8a0102016-04-04 10:42:07 +02002047#ifdef CONFIG_DEBUG_LOCKDEP
Ingo Molnar9e4e7552016-02-29 10:03:58 +01002048/*
Alfredo Alvarez Fernandez39e2e172016-03-30 19:03:36 +02002049 * Returns the next chain_key iteration
2050 */
2051static u64 print_chain_key_iteration(int class_idx, u64 chain_key)
2052{
2053 u64 new_chain_key = iterate_chain_key(chain_key, class_idx);
2054
2055 printk(" class_idx:%d -> chain_key:%016Lx",
2056 class_idx,
2057 (unsigned long long)new_chain_key);
2058 return new_chain_key;
2059}
2060
2061static void
2062print_chain_keys_held_locks(struct task_struct *curr, struct held_lock *hlock_next)
2063{
2064 struct held_lock *hlock;
2065 u64 chain_key = 0;
2066 int depth = curr->lockdep_depth;
2067 int i;
2068
2069 printk("depth: %u\n", depth + 1);
2070 for (i = get_first_held_lock(curr, hlock_next); i < depth; i++) {
2071 hlock = curr->held_locks + i;
2072 chain_key = print_chain_key_iteration(hlock->class_idx, chain_key);
2073
2074 print_lock(hlock);
2075 }
2076
2077 print_chain_key_iteration(hlock_next->class_idx, chain_key);
2078 print_lock(hlock_next);
2079}
2080
2081static void print_chain_keys_chain(struct lock_chain *chain)
2082{
2083 int i;
2084 u64 chain_key = 0;
2085 int class_id;
2086
2087 printk("depth: %u\n", chain->depth);
2088 for (i = 0; i < chain->depth; i++) {
2089 class_id = chain_hlocks[chain->base + i];
2090 chain_key = print_chain_key_iteration(class_id + 1, chain_key);
2091
2092 print_lock_name(lock_classes + class_id);
2093 printk("\n");
2094 }
2095}
2096
2097static void print_collision(struct task_struct *curr,
2098 struct held_lock *hlock_next,
2099 struct lock_chain *chain)
2100{
Paul E. McKenney681fbec2017-05-04 15:44:38 -07002101 pr_warn("\n");
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08002102 pr_warn("============================\n");
2103 pr_warn("WARNING: chain_key collision\n");
Alfredo Alvarez Fernandez39e2e172016-03-30 19:03:36 +02002104 print_kernel_ident();
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08002105 pr_warn("----------------------------\n");
Paul E. McKenney681fbec2017-05-04 15:44:38 -07002106 pr_warn("%s/%d: ", current->comm, task_pid_nr(current));
2107 pr_warn("Hash chain already cached but the contents don't match!\n");
Alfredo Alvarez Fernandez39e2e172016-03-30 19:03:36 +02002108
Paul E. McKenney681fbec2017-05-04 15:44:38 -07002109 pr_warn("Held locks:");
Alfredo Alvarez Fernandez39e2e172016-03-30 19:03:36 +02002110 print_chain_keys_held_locks(curr, hlock_next);
2111
Paul E. McKenney681fbec2017-05-04 15:44:38 -07002112 pr_warn("Locks in cached chain:");
Alfredo Alvarez Fernandez39e2e172016-03-30 19:03:36 +02002113 print_chain_keys_chain(chain);
2114
Paul E. McKenney681fbec2017-05-04 15:44:38 -07002115 pr_warn("\nstack backtrace:\n");
Alfredo Alvarez Fernandez39e2e172016-03-30 19:03:36 +02002116 dump_stack();
2117}
Borislav Petkov5c8a0102016-04-04 10:42:07 +02002118#endif
Alfredo Alvarez Fernandez39e2e172016-03-30 19:03:36 +02002119
2120/*
Ingo Molnar9e4e7552016-02-29 10:03:58 +01002121 * Checks whether the chain and the current held locks are consistent
2122 * in depth and also in content. If they are not it most likely means
2123 * that there was a collision during the calculation of the chain_key.
2124 * Returns: 0 not passed, 1 passed
2125 */
2126static int check_no_collision(struct task_struct *curr,
2127 struct held_lock *hlock,
2128 struct lock_chain *chain)
2129{
2130#ifdef CONFIG_DEBUG_LOCKDEP
2131 int i, j, id;
2132
2133 i = get_first_held_lock(curr, hlock);
2134
Alfredo Alvarez Fernandez39e2e172016-03-30 19:03:36 +02002135 if (DEBUG_LOCKS_WARN_ON(chain->depth != curr->lockdep_depth - (i - 1))) {
2136 print_collision(curr, hlock, chain);
Ingo Molnar9e4e7552016-02-29 10:03:58 +01002137 return 0;
Alfredo Alvarez Fernandez39e2e172016-03-30 19:03:36 +02002138 }
Ingo Molnar9e4e7552016-02-29 10:03:58 +01002139
2140 for (j = 0; j < chain->depth - 1; j++, i++) {
2141 id = curr->held_locks[i].class_idx - 1;
2142
Alfredo Alvarez Fernandez39e2e172016-03-30 19:03:36 +02002143 if (DEBUG_LOCKS_WARN_ON(chain_hlocks[chain->base + j] != id)) {
2144 print_collision(curr, hlock, chain);
Ingo Molnar9e4e7552016-02-29 10:03:58 +01002145 return 0;
Alfredo Alvarez Fernandez39e2e172016-03-30 19:03:36 +02002146 }
Ingo Molnar9e4e7552016-02-29 10:03:58 +01002147 }
2148#endif
2149 return 1;
2150}
2151
2152/*
Byungchul Park545c23f2017-08-07 16:12:48 +09002153 * Adds a dependency chain into chain hashtable. And must be called with
2154 * graph_lock held.
2155 *
2156 * Return 0 if fail, and graph_lock is released.
2157 * Return 1 if succeed, with graph_lock held.
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002158 */
Byungchul Park545c23f2017-08-07 16:12:48 +09002159static inline int add_chain_cache(struct task_struct *curr,
2160 struct held_lock *hlock,
2161 u64 chain_key)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002162{
Dave Jonesf82b2172008-08-11 09:30:23 +02002163 struct lock_class *class = hlock_class(hlock);
Andrew Mortona63f38c2016-02-03 13:44:12 -08002164 struct hlist_head *hash_head = chainhashentry(chain_key);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002165 struct lock_chain *chain;
Steven Rostedte0944ee2011-04-20 21:42:00 -04002166 int i, j;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002167
Peter Zijlstra0119fee2011-09-02 01:30:29 +02002168 /*
Byungchul Park545c23f2017-08-07 16:12:48 +09002169 * Allocate a new chain entry from the static array, and add
2170 * it to the hash:
2171 */
2172
2173 /*
Peter Zijlstra0119fee2011-09-02 01:30:29 +02002174 * We might need to take the graph lock, ensure we've got IRQs
2175 * disabled to make this an IRQ-safe lock.. for recursion reasons
2176 * lockdep won't complain about its own locking errors.
2177 */
Jarek Poplawski381a2292007-02-10 01:44:58 -08002178 if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
2179 return 0;
Ingo Molnar9e4e7552016-02-29 10:03:58 +01002180
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002181 if (unlikely(nr_lock_chains >= MAX_LOCKDEP_CHAINS)) {
Ingo Molnar74c383f2006-12-13 00:34:43 -08002182 if (!debug_locks_off_graph_unlock())
2183 return 0;
2184
Dave Jones2c522832013-04-25 13:40:02 -04002185 print_lockdep_off("BUG: MAX_LOCKDEP_CHAINS too low!");
Peter Zijlstraeedeeab2009-03-18 12:38:47 +01002186 dump_stack();
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002187 return 0;
2188 }
2189 chain = lock_chains + nr_lock_chains++;
2190 chain->chain_key = chain_key;
Huang, Ying443cd502008-06-20 16:39:21 +08002191 chain->irq_context = hlock->irq_context;
Ingo Molnar9e4e7552016-02-29 10:03:58 +01002192 i = get_first_held_lock(curr, hlock);
Huang, Ying443cd502008-06-20 16:39:21 +08002193 chain->depth = curr->lockdep_depth + 1 - i;
Peter Zijlstra75dd6022016-03-30 11:36:59 +02002194
2195 BUILD_BUG_ON((1UL << 24) <= ARRAY_SIZE(chain_hlocks));
2196 BUILD_BUG_ON((1UL << 6) <= ARRAY_SIZE(curr->held_locks));
2197 BUILD_BUG_ON((1UL << 8*sizeof(chain_hlocks[0])) <= ARRAY_SIZE(lock_classes));
2198
Steven Rostedte0944ee2011-04-20 21:42:00 -04002199 if (likely(nr_chain_hlocks + chain->depth <= MAX_LOCKDEP_CHAIN_HLOCKS)) {
2200 chain->base = nr_chain_hlocks;
Huang, Ying443cd502008-06-20 16:39:21 +08002201 for (j = 0; j < chain->depth - 1; j++, i++) {
Dave Jonesf82b2172008-08-11 09:30:23 +02002202 int lock_id = curr->held_locks[i].class_idx - 1;
Huang, Ying443cd502008-06-20 16:39:21 +08002203 chain_hlocks[chain->base + j] = lock_id;
2204 }
2205 chain_hlocks[chain->base + j] = class - lock_classes;
2206 }
Peter Zijlstra75dd6022016-03-30 11:36:59 +02002207
2208 if (nr_chain_hlocks < MAX_LOCKDEP_CHAIN_HLOCKS)
2209 nr_chain_hlocks += chain->depth;
2210
2211#ifdef CONFIG_DEBUG_LOCKDEP
2212 /*
2213 * Important for check_no_collision().
2214 */
2215 if (unlikely(nr_chain_hlocks > MAX_LOCKDEP_CHAIN_HLOCKS)) {
Byungchul Parkf9af4562017-01-13 11:42:04 +09002216 if (!debug_locks_off_graph_unlock())
Peter Zijlstra75dd6022016-03-30 11:36:59 +02002217 return 0;
2218
2219 print_lockdep_off("BUG: MAX_LOCKDEP_CHAIN_HLOCKS too low!");
2220 dump_stack();
2221 return 0;
2222 }
2223#endif
2224
Andrew Mortona63f38c2016-02-03 13:44:12 -08002225 hlist_add_head_rcu(&chain->entry, hash_head);
Frederic Weisbeckerbd6d29c2010-04-06 00:10:17 +02002226 debug_atomic_inc(chain_lookup_misses);
Peter Zijlstra8e182572007-07-19 01:48:54 -07002227 inc_chains();
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002228
2229 return 1;
2230}
Peter Zijlstra8e182572007-07-19 01:48:54 -07002231
Byungchul Park545c23f2017-08-07 16:12:48 +09002232/*
2233 * Look up a dependency chain.
2234 */
2235static inline struct lock_chain *lookup_chain_cache(u64 chain_key)
2236{
2237 struct hlist_head *hash_head = chainhashentry(chain_key);
2238 struct lock_chain *chain;
2239
2240 /*
2241 * We can walk it lock-free, because entries only get added
2242 * to the hash:
2243 */
2244 hlist_for_each_entry_rcu(chain, hash_head, entry) {
2245 if (chain->chain_key == chain_key) {
2246 debug_atomic_inc(chain_lookup_hits);
2247 return chain;
2248 }
2249 }
2250 return NULL;
2251}
2252
2253/*
2254 * If the key is not present yet in dependency chain cache then
2255 * add it and return 1 - in this case the new dependency chain is
2256 * validated. If the key is already hashed, return 0.
2257 * (On return with 1 graph_lock is held.)
2258 */
2259static inline int lookup_chain_cache_add(struct task_struct *curr,
2260 struct held_lock *hlock,
2261 u64 chain_key)
2262{
2263 struct lock_class *class = hlock_class(hlock);
2264 struct lock_chain *chain = lookup_chain_cache(chain_key);
2265
2266 if (chain) {
2267cache_hit:
2268 if (!check_no_collision(curr, hlock, chain))
2269 return 0;
2270
2271 if (very_verbose(class)) {
2272 printk("\nhash chain already cached, key: "
Borislav Petkov04860d42018-02-26 14:49:26 +01002273 "%016Lx tail class: [%px] %s\n",
Byungchul Park545c23f2017-08-07 16:12:48 +09002274 (unsigned long long)chain_key,
2275 class->key, class->name);
2276 }
2277
2278 return 0;
2279 }
2280
2281 if (very_verbose(class)) {
Borislav Petkov04860d42018-02-26 14:49:26 +01002282 printk("\nnew hash chain, key: %016Lx tail class: [%px] %s\n",
Byungchul Park545c23f2017-08-07 16:12:48 +09002283 (unsigned long long)chain_key, class->key, class->name);
2284 }
2285
2286 if (!graph_lock())
2287 return 0;
2288
2289 /*
2290 * We have to walk the chain again locked - to avoid duplicates:
2291 */
2292 chain = lookup_chain_cache(chain_key);
2293 if (chain) {
2294 graph_unlock();
2295 goto cache_hit;
2296 }
2297
2298 if (!add_chain_cache(curr, hlock, chain_key))
2299 return 0;
2300
2301 return 1;
2302}
2303
Peter Zijlstra8e182572007-07-19 01:48:54 -07002304static int validate_chain(struct task_struct *curr, struct lockdep_map *lock,
Johannes Berg4e6045f2007-10-18 23:39:55 -07002305 struct held_lock *hlock, int chain_head, u64 chain_key)
Peter Zijlstra8e182572007-07-19 01:48:54 -07002306{
2307 /*
2308 * Trylock needs to maintain the stack of held locks, but it
2309 * does not add new dependencies, because trylock can be done
2310 * in any order.
2311 *
2312 * We look up the chain_key and do the O(N^2) check and update of
2313 * the dependencies only if this is a new dependency chain.
Byungchul Park545c23f2017-08-07 16:12:48 +09002314 * (If lookup_chain_cache_add() return with 1 it acquires
Peter Zijlstra8e182572007-07-19 01:48:54 -07002315 * graph_lock for us)
2316 */
Oleg Nesterovfb9edbe2014-01-20 19:20:06 +01002317 if (!hlock->trylock && hlock->check &&
Byungchul Park545c23f2017-08-07 16:12:48 +09002318 lookup_chain_cache_add(curr, hlock, chain_key)) {
Peter Zijlstra8e182572007-07-19 01:48:54 -07002319 /*
2320 * Check whether last held lock:
2321 *
2322 * - is irq-safe, if this lock is irq-unsafe
2323 * - is softirq-safe, if this lock is hardirq-unsafe
2324 *
2325 * And check whether the new lock's dependency graph
2326 * could lead back to the previous lock.
2327 *
2328 * any of these scenarios could lead to a deadlock. If
2329 * All validations
2330 */
2331 int ret = check_deadlock(curr, hlock, lock, hlock->read);
2332
2333 if (!ret)
2334 return 0;
2335 /*
2336 * Mark recursive read, as we jump over it when
2337 * building dependencies (just like we jump over
2338 * trylock entries):
2339 */
2340 if (ret == 2)
2341 hlock->read = 2;
2342 /*
2343 * Add dependency only if this lock is not the head
2344 * of the chain, and if it's not a secondary read-lock:
2345 */
Byungchul Park545c23f2017-08-07 16:12:48 +09002346 if (!chain_head && ret != 2) {
Peter Zijlstra8e182572007-07-19 01:48:54 -07002347 if (!check_prevs_add(curr, hlock))
2348 return 0;
Byungchul Park545c23f2017-08-07 16:12:48 +09002349 }
2350
Peter Zijlstra8e182572007-07-19 01:48:54 -07002351 graph_unlock();
Byungchul Park545c23f2017-08-07 16:12:48 +09002352 } else {
2353 /* after lookup_chain_cache_add(): */
Peter Zijlstra8e182572007-07-19 01:48:54 -07002354 if (unlikely(!debug_locks))
2355 return 0;
Byungchul Park545c23f2017-08-07 16:12:48 +09002356 }
Peter Zijlstra8e182572007-07-19 01:48:54 -07002357
2358 return 1;
2359}
2360#else
2361static inline int validate_chain(struct task_struct *curr,
2362 struct lockdep_map *lock, struct held_lock *hlock,
Gregory Haskins3aa416b2007-10-11 22:11:11 +02002363 int chain_head, u64 chain_key)
Peter Zijlstra8e182572007-07-19 01:48:54 -07002364{
2365 return 1;
2366}
Peter Zijlstraca58abc2007-07-19 01:48:53 -07002367#endif
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002368
2369/*
2370 * We are building curr_chain_key incrementally, so double-check
2371 * it from scratch, to make sure that it's done correctly:
2372 */
Steven Rostedt1d09daa2008-05-12 21:20:55 +02002373static void check_chain_key(struct task_struct *curr)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002374{
2375#ifdef CONFIG_DEBUG_LOCKDEP
2376 struct held_lock *hlock, *prev_hlock = NULL;
Alfredo Alvarez Fernandez5f18ab52016-02-11 00:33:32 +01002377 unsigned int i;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002378 u64 chain_key = 0;
2379
2380 for (i = 0; i < curr->lockdep_depth; i++) {
2381 hlock = curr->held_locks + i;
2382 if (chain_key != hlock->prev_chain_key) {
2383 debug_locks_off();
Peter Zijlstra0119fee2011-09-02 01:30:29 +02002384 /*
2385 * We got mighty confused, our chain keys don't match
2386 * with what we expect, someone trample on our task state?
2387 */
Arjan van de Ven2df8b1d2008-07-30 12:43:11 -07002388 WARN(1, "hm#1, depth: %u [%u], %016Lx != %016Lx\n",
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002389 curr->lockdep_depth, i,
2390 (unsigned long long)chain_key,
2391 (unsigned long long)hlock->prev_chain_key);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002392 return;
2393 }
Peter Zijlstra0119fee2011-09-02 01:30:29 +02002394 /*
2395 * Whoops ran out of static storage again?
2396 */
Alfredo Alvarez Fernandez5f18ab52016-02-11 00:33:32 +01002397 if (DEBUG_LOCKS_WARN_ON(hlock->class_idx > MAX_LOCKDEP_KEYS))
Jarek Poplawski381a2292007-02-10 01:44:58 -08002398 return;
2399
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002400 if (prev_hlock && (prev_hlock->irq_context !=
2401 hlock->irq_context))
2402 chain_key = 0;
Alfredo Alvarez Fernandez5f18ab52016-02-11 00:33:32 +01002403 chain_key = iterate_chain_key(chain_key, hlock->class_idx);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002404 prev_hlock = hlock;
2405 }
2406 if (chain_key != curr->curr_chain_key) {
2407 debug_locks_off();
Peter Zijlstra0119fee2011-09-02 01:30:29 +02002408 /*
2409 * More smoking hash instead of calculating it, damn see these
2410 * numbers float.. I bet that a pink elephant stepped on my memory.
2411 */
Arjan van de Ven2df8b1d2008-07-30 12:43:11 -07002412 WARN(1, "hm#2, depth: %u [%u], %016Lx != %016Lx\n",
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002413 curr->lockdep_depth, i,
2414 (unsigned long long)chain_key,
2415 (unsigned long long)curr->curr_chain_key);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002416 }
2417#endif
2418}
2419
Steven Rostedt282b5c22011-04-20 21:41:59 -04002420static void
2421print_usage_bug_scenario(struct held_lock *lock)
2422{
2423 struct lock_class *class = hlock_class(lock);
2424
2425 printk(" Possible unsafe locking scenario:\n\n");
2426 printk(" CPU0\n");
2427 printk(" ----\n");
2428 printk(" lock(");
2429 __print_lock_name(class);
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01002430 printk(KERN_CONT ");\n");
Steven Rostedt282b5c22011-04-20 21:41:59 -04002431 printk(" <Interrupt>\n");
2432 printk(" lock(");
2433 __print_lock_name(class);
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01002434 printk(KERN_CONT ");\n");
Steven Rostedt282b5c22011-04-20 21:41:59 -04002435 printk("\n *** DEADLOCK ***\n\n");
2436}
2437
Peter Zijlstra8e182572007-07-19 01:48:54 -07002438static int
2439print_usage_bug(struct task_struct *curr, struct held_lock *this,
2440 enum lock_usage_bit prev_bit, enum lock_usage_bit new_bit)
2441{
2442 if (!debug_locks_off_graph_unlock() || debug_locks_silent)
2443 return 0;
2444
Paul E. McKenney681fbec2017-05-04 15:44:38 -07002445 pr_warn("\n");
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08002446 pr_warn("================================\n");
2447 pr_warn("WARNING: inconsistent lock state\n");
Ben Hutchingsfbdc4b92011-10-28 04:36:55 +01002448 print_kernel_ident();
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08002449 pr_warn("--------------------------------\n");
Peter Zijlstra8e182572007-07-19 01:48:54 -07002450
Paul E. McKenney681fbec2017-05-04 15:44:38 -07002451 pr_warn("inconsistent {%s} -> {%s} usage.\n",
Peter Zijlstra8e182572007-07-19 01:48:54 -07002452 usage_str[prev_bit], usage_str[new_bit]);
2453
Paul E. McKenney681fbec2017-05-04 15:44:38 -07002454 pr_warn("%s/%d [HC%u[%lu]:SC%u[%lu]:HE%u:SE%u] takes:\n",
Pavel Emelyanovba25f9d2007-10-18 23:40:40 -07002455 curr->comm, task_pid_nr(curr),
Peter Zijlstra8e182572007-07-19 01:48:54 -07002456 trace_hardirq_context(curr), hardirq_count() >> HARDIRQ_SHIFT,
2457 trace_softirq_context(curr), softirq_count() >> SOFTIRQ_SHIFT,
2458 trace_hardirqs_enabled(curr),
2459 trace_softirqs_enabled(curr));
2460 print_lock(this);
2461
Paul E. McKenney681fbec2017-05-04 15:44:38 -07002462 pr_warn("{%s} state was registered at:\n", usage_str[prev_bit]);
Dave Jonesf82b2172008-08-11 09:30:23 +02002463 print_stack_trace(hlock_class(this)->usage_traces + prev_bit, 1);
Peter Zijlstra8e182572007-07-19 01:48:54 -07002464
2465 print_irqtrace_events(curr);
Paul E. McKenney681fbec2017-05-04 15:44:38 -07002466 pr_warn("\nother info that might help us debug this:\n");
Steven Rostedt282b5c22011-04-20 21:41:59 -04002467 print_usage_bug_scenario(this);
2468
Peter Zijlstra8e182572007-07-19 01:48:54 -07002469 lockdep_print_held_locks(curr);
2470
Paul E. McKenney681fbec2017-05-04 15:44:38 -07002471 pr_warn("\nstack backtrace:\n");
Peter Zijlstra8e182572007-07-19 01:48:54 -07002472 dump_stack();
2473
2474 return 0;
2475}
2476
2477/*
2478 * Print out an error if an invalid bit is set:
2479 */
2480static inline int
2481valid_state(struct task_struct *curr, struct held_lock *this,
2482 enum lock_usage_bit new_bit, enum lock_usage_bit bad_bit)
2483{
Dave Jonesf82b2172008-08-11 09:30:23 +02002484 if (unlikely(hlock_class(this)->usage_mask & (1 << bad_bit)))
Peter Zijlstra8e182572007-07-19 01:48:54 -07002485 return print_usage_bug(curr, this, bad_bit, new_bit);
2486 return 1;
2487}
2488
2489static int mark_lock(struct task_struct *curr, struct held_lock *this,
2490 enum lock_usage_bit new_bit);
2491
Steven Rostedt81d68a92008-05-12 21:20:42 +02002492#if defined(CONFIG_TRACE_IRQFLAGS) && defined(CONFIG_PROVE_LOCKING)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002493
2494/*
2495 * print irq inversion bug:
2496 */
2497static int
Ming Lei24208ca2009-07-16 15:44:29 +02002498print_irq_inversion_bug(struct task_struct *curr,
2499 struct lock_list *root, struct lock_list *other,
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002500 struct held_lock *this, int forwards,
2501 const char *irqclass)
2502{
Steven Rostedtdad3d742011-04-20 21:41:57 -04002503 struct lock_list *entry = other;
2504 struct lock_list *middle = NULL;
2505 int depth;
2506
Ingo Molnar74c383f2006-12-13 00:34:43 -08002507 if (!debug_locks_off_graph_unlock() || debug_locks_silent)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002508 return 0;
2509
Paul E. McKenney681fbec2017-05-04 15:44:38 -07002510 pr_warn("\n");
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08002511 pr_warn("========================================================\n");
2512 pr_warn("WARNING: possible irq lock inversion dependency detected\n");
Ben Hutchingsfbdc4b92011-10-28 04:36:55 +01002513 print_kernel_ident();
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08002514 pr_warn("--------------------------------------------------------\n");
Paul E. McKenney681fbec2017-05-04 15:44:38 -07002515 pr_warn("%s/%d just changed the state of lock:\n",
Pavel Emelyanovba25f9d2007-10-18 23:40:40 -07002516 curr->comm, task_pid_nr(curr));
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002517 print_lock(this);
2518 if (forwards)
Paul E. McKenney681fbec2017-05-04 15:44:38 -07002519 pr_warn("but this lock took another, %s-unsafe lock in the past:\n", irqclass);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002520 else
Paul E. McKenney681fbec2017-05-04 15:44:38 -07002521 pr_warn("but this lock was taken by another, %s-safe lock in the past:\n", irqclass);
Ming Lei24208ca2009-07-16 15:44:29 +02002522 print_lock_name(other->class);
Paul E. McKenney681fbec2017-05-04 15:44:38 -07002523 pr_warn("\n\nand interrupts could create inverse lock ordering between them.\n\n");
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002524
Paul E. McKenney681fbec2017-05-04 15:44:38 -07002525 pr_warn("\nother info that might help us debug this:\n");
Steven Rostedtdad3d742011-04-20 21:41:57 -04002526
2527 /* Find a middle lock (if one exists) */
2528 depth = get_lock_depth(other);
2529 do {
2530 if (depth == 0 && (entry != root)) {
Paul E. McKenney681fbec2017-05-04 15:44:38 -07002531 pr_warn("lockdep:%s bad path found in chain graph\n", __func__);
Steven Rostedtdad3d742011-04-20 21:41:57 -04002532 break;
2533 }
2534 middle = entry;
2535 entry = get_lock_parent(entry);
2536 depth--;
2537 } while (entry && entry != root && (depth >= 0));
2538 if (forwards)
2539 print_irq_lock_scenario(root, other,
2540 middle ? middle->class : root->class, other->class);
2541 else
2542 print_irq_lock_scenario(other, root,
2543 middle ? middle->class : other->class, root->class);
2544
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002545 lockdep_print_held_locks(curr);
2546
Paul E. McKenney681fbec2017-05-04 15:44:38 -07002547 pr_warn("\nthe shortest dependencies between 2nd lock and 1st lock:\n");
Ming Lei24208ca2009-07-16 15:44:29 +02002548 if (!save_trace(&root->trace))
2549 return 0;
2550 print_shortest_lock_dependencies(other, root);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002551
Paul E. McKenney681fbec2017-05-04 15:44:38 -07002552 pr_warn("\nstack backtrace:\n");
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002553 dump_stack();
2554
2555 return 0;
2556}
2557
2558/*
2559 * Prove that in the forwards-direction subgraph starting at <this>
2560 * there is no lock matching <mask>:
2561 */
2562static int
2563check_usage_forwards(struct task_struct *curr, struct held_lock *this,
2564 enum lock_usage_bit bit, const char *irqclass)
2565{
2566 int ret;
Ming Leid7aaba12009-07-16 15:44:29 +02002567 struct lock_list root;
2568 struct lock_list *uninitialized_var(target_entry);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002569
Ming Leid7aaba12009-07-16 15:44:29 +02002570 root.parent = NULL;
2571 root.class = hlock_class(this);
2572 ret = find_usage_forwards(&root, bit, &target_entry);
Peter Zijlstraaf012962009-07-16 15:44:29 +02002573 if (ret < 0)
2574 return print_bfs_bug(ret);
2575 if (ret == 1)
2576 return ret;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002577
Ming Lei24208ca2009-07-16 15:44:29 +02002578 return print_irq_inversion_bug(curr, &root, target_entry,
Ming Leid7aaba12009-07-16 15:44:29 +02002579 this, 1, irqclass);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002580}
2581
2582/*
2583 * Prove that in the backwards-direction subgraph starting at <this>
2584 * there is no lock matching <mask>:
2585 */
2586static int
2587check_usage_backwards(struct task_struct *curr, struct held_lock *this,
2588 enum lock_usage_bit bit, const char *irqclass)
2589{
2590 int ret;
Ming Leid7aaba12009-07-16 15:44:29 +02002591 struct lock_list root;
2592 struct lock_list *uninitialized_var(target_entry);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002593
Ming Leid7aaba12009-07-16 15:44:29 +02002594 root.parent = NULL;
2595 root.class = hlock_class(this);
2596 ret = find_usage_backwards(&root, bit, &target_entry);
Peter Zijlstraaf012962009-07-16 15:44:29 +02002597 if (ret < 0)
2598 return print_bfs_bug(ret);
2599 if (ret == 1)
2600 return ret;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002601
Ming Lei24208ca2009-07-16 15:44:29 +02002602 return print_irq_inversion_bug(curr, &root, target_entry,
Oleg Nesterov48d50672010-01-26 19:16:41 +01002603 this, 0, irqclass);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002604}
2605
Ingo Molnar3117df02006-12-13 00:34:43 -08002606void print_irqtrace_events(struct task_struct *curr)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002607{
2608 printk("irq event stamp: %u\n", curr->irq_events);
Borislav Petkov04860d42018-02-26 14:49:26 +01002609 printk("hardirqs last enabled at (%u): [<%px>] %pS\n",
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01002610 curr->hardirq_enable_event, (void *)curr->hardirq_enable_ip,
2611 (void *)curr->hardirq_enable_ip);
Borislav Petkov04860d42018-02-26 14:49:26 +01002612 printk("hardirqs last disabled at (%u): [<%px>] %pS\n",
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01002613 curr->hardirq_disable_event, (void *)curr->hardirq_disable_ip,
2614 (void *)curr->hardirq_disable_ip);
Borislav Petkov04860d42018-02-26 14:49:26 +01002615 printk("softirqs last enabled at (%u): [<%px>] %pS\n",
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01002616 curr->softirq_enable_event, (void *)curr->softirq_enable_ip,
2617 (void *)curr->softirq_enable_ip);
Borislav Petkov04860d42018-02-26 14:49:26 +01002618 printk("softirqs last disabled at (%u): [<%px>] %pS\n",
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01002619 curr->softirq_disable_event, (void *)curr->softirq_disable_ip,
2620 (void *)curr->softirq_disable_ip);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002621}
2622
Peter Zijlstracd953022009-01-22 16:38:21 +01002623static int HARDIRQ_verbose(struct lock_class *class)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002624{
Peter Zijlstra8e182572007-07-19 01:48:54 -07002625#if HARDIRQ_VERBOSE
2626 return class_filter(class);
2627#endif
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002628 return 0;
2629}
2630
Peter Zijlstracd953022009-01-22 16:38:21 +01002631static int SOFTIRQ_verbose(struct lock_class *class)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002632{
Peter Zijlstra8e182572007-07-19 01:48:54 -07002633#if SOFTIRQ_VERBOSE
2634 return class_filter(class);
2635#endif
2636 return 0;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002637}
2638
2639#define STRICT_READ_CHECKS 1
2640
Peter Zijlstracd953022009-01-22 16:38:21 +01002641static int (*state_verbose_f[])(struct lock_class *class) = {
2642#define LOCKDEP_STATE(__STATE) \
2643 __STATE##_verbose,
2644#include "lockdep_states.h"
2645#undef LOCKDEP_STATE
2646};
2647
2648static inline int state_verbose(enum lock_usage_bit bit,
2649 struct lock_class *class)
2650{
2651 return state_verbose_f[bit >> 2](class);
2652}
2653
Peter Zijlstra42c50d52009-01-22 16:58:16 +01002654typedef int (*check_usage_f)(struct task_struct *, struct held_lock *,
2655 enum lock_usage_bit bit, const char *name);
2656
Peter Zijlstra6a6904d2009-01-22 16:07:44 +01002657static int
Peter Zijlstra1c21f142009-03-04 13:51:13 +01002658mark_lock_irq(struct task_struct *curr, struct held_lock *this,
2659 enum lock_usage_bit new_bit)
Peter Zijlstra6a6904d2009-01-22 16:07:44 +01002660{
Peter Zijlstraf9892092009-01-22 16:09:59 +01002661 int excl_bit = exclusive_bit(new_bit);
Peter Zijlstra9d3651a2009-01-22 17:18:32 +01002662 int read = new_bit & 1;
Peter Zijlstra42c50d52009-01-22 16:58:16 +01002663 int dir = new_bit & 2;
2664
Peter Zijlstra38aa2712009-01-27 14:53:50 +01002665 /*
2666 * mark USED_IN has to look forwards -- to ensure no dependency
2667 * has ENABLED state, which would allow recursion deadlocks.
2668 *
2669 * mark ENABLED has to look backwards -- to ensure no dependee
2670 * has USED_IN state, which, again, would allow recursion deadlocks.
2671 */
Peter Zijlstra42c50d52009-01-22 16:58:16 +01002672 check_usage_f usage = dir ?
2673 check_usage_backwards : check_usage_forwards;
Peter Zijlstraf9892092009-01-22 16:09:59 +01002674
Peter Zijlstra38aa2712009-01-27 14:53:50 +01002675 /*
2676 * Validate that this particular lock does not have conflicting
2677 * usage states.
2678 */
Peter Zijlstra6a6904d2009-01-22 16:07:44 +01002679 if (!valid_state(curr, this, new_bit, excl_bit))
2680 return 0;
Peter Zijlstra9d3651a2009-01-22 17:18:32 +01002681
Peter Zijlstra38aa2712009-01-27 14:53:50 +01002682 /*
2683 * Validate that the lock dependencies don't have conflicting usage
2684 * states.
2685 */
2686 if ((!read || !dir || STRICT_READ_CHECKS) &&
Peter Zijlstra1c21f142009-03-04 13:51:13 +01002687 !usage(curr, this, excl_bit, state_name(new_bit & ~1)))
Peter Zijlstra6a6904d2009-01-22 16:07:44 +01002688 return 0;
Peter Zijlstra780e8202009-01-22 16:51:29 +01002689
Peter Zijlstra38aa2712009-01-27 14:53:50 +01002690 /*
2691 * Check for read in write conflicts
2692 */
2693 if (!read) {
2694 if (!valid_state(curr, this, new_bit, excl_bit + 1))
2695 return 0;
2696
2697 if (STRICT_READ_CHECKS &&
Peter Zijlstra4f367d8a2009-01-22 18:10:42 +01002698 !usage(curr, this, excl_bit + 1,
2699 state_name(new_bit + 1)))
Peter Zijlstra38aa2712009-01-27 14:53:50 +01002700 return 0;
2701 }
Peter Zijlstra780e8202009-01-22 16:51:29 +01002702
Peter Zijlstracd953022009-01-22 16:38:21 +01002703 if (state_verbose(new_bit, hlock_class(this)))
Peter Zijlstra6a6904d2009-01-22 16:07:44 +01002704 return 2;
2705
2706 return 1;
2707}
2708
Nick Piggincf40bd12009-01-21 08:12:39 +01002709enum mark_type {
Peter Zijlstra36bfb9b2009-01-22 14:12:41 +01002710#define LOCKDEP_STATE(__STATE) __STATE,
2711#include "lockdep_states.h"
2712#undef LOCKDEP_STATE
Nick Piggincf40bd12009-01-21 08:12:39 +01002713};
2714
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002715/*
2716 * Mark all held locks with a usage bit:
2717 */
Steven Rostedt1d09daa2008-05-12 21:20:55 +02002718static int
Nick Piggincf40bd12009-01-21 08:12:39 +01002719mark_held_locks(struct task_struct *curr, enum mark_type mark)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002720{
2721 enum lock_usage_bit usage_bit;
2722 struct held_lock *hlock;
2723 int i;
2724
2725 for (i = 0; i < curr->lockdep_depth; i++) {
2726 hlock = curr->held_locks + i;
2727
Peter Zijlstracf2ad4d2009-01-27 13:58:08 +01002728 usage_bit = 2 + (mark << 2); /* ENABLED */
2729 if (hlock->read)
2730 usage_bit += 1; /* READ */
2731
2732 BUG_ON(usage_bit >= LOCK_USAGE_STATES);
Nick Piggincf40bd12009-01-21 08:12:39 +01002733
Oleg Nesterov34d0ed52014-01-20 19:20:13 +01002734 if (!hlock->check)
Peter Zijlstraefbe2ee2011-07-07 11:39:45 +02002735 continue;
2736
Jarek Poplawski4ff773bb2007-05-08 00:31:00 -07002737 if (!mark_lock(curr, hlock, usage_bit))
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002738 return 0;
2739 }
2740
2741 return 1;
2742}
2743
2744/*
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002745 * Hardirqs will be enabled:
2746 */
Peter Zijlstradd4e5d32011-06-21 17:17:27 +02002747static void __trace_hardirqs_on_caller(unsigned long ip)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002748{
2749 struct task_struct *curr = current;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002750
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002751 /* we'll do an OFF -> ON transition: */
2752 curr->hardirqs_enabled = 1;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002753
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002754 /*
2755 * We are going to turn hardirqs on, so set the
2756 * usage bit for all held locks:
2757 */
Nick Piggincf40bd12009-01-21 08:12:39 +01002758 if (!mark_held_locks(curr, HARDIRQ))
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002759 return;
2760 /*
2761 * If we have softirqs enabled, then set the usage
2762 * bit for all held locks. (disabled hardirqs prevented
2763 * this bit from being set before)
2764 */
2765 if (curr->softirqs_enabled)
Nick Piggincf40bd12009-01-21 08:12:39 +01002766 if (!mark_held_locks(curr, SOFTIRQ))
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002767 return;
2768
2769 curr->hardirq_enable_ip = ip;
2770 curr->hardirq_enable_event = ++curr->irq_events;
Frederic Weisbeckerbd6d29c2010-04-06 00:10:17 +02002771 debug_atomic_inc(hardirqs_on_events);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002772}
Peter Zijlstradd4e5d32011-06-21 17:17:27 +02002773
Steven Rostedt (VMware)bff1b202018-08-06 15:50:58 -04002774void lockdep_hardirqs_on(unsigned long ip)
Peter Zijlstradd4e5d32011-06-21 17:17:27 +02002775{
Peter Zijlstradd4e5d32011-06-21 17:17:27 +02002776 if (unlikely(!debug_locks || current->lockdep_recursion))
2777 return;
2778
Peter Zijlstra7d36b262011-07-26 13:13:44 +02002779 if (unlikely(current->hardirqs_enabled)) {
2780 /*
2781 * Neither irq nor preemption are disabled here
2782 * so this is racy by nature but losing one hit
2783 * in a stat is not a big deal.
2784 */
2785 __debug_atomic_inc(redundant_hardirqs_on);
2786 return;
2787 }
2788
Peter Zijlstra0119fee2011-09-02 01:30:29 +02002789 /*
2790 * We're enabling irqs and according to our state above irqs weren't
2791 * already enabled, yet we find the hardware thinks they are in fact
2792 * enabled.. someone messed up their IRQ state tracing.
2793 */
Peter Zijlstradd4e5d32011-06-21 17:17:27 +02002794 if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
2795 return;
2796
Peter Zijlstra0119fee2011-09-02 01:30:29 +02002797 /*
2798 * See the fine text that goes along with this variable definition.
2799 */
Peter Zijlstra7d36b262011-07-26 13:13:44 +02002800 if (DEBUG_LOCKS_WARN_ON(unlikely(early_boot_irqs_disabled)))
2801 return;
2802
Peter Zijlstra0119fee2011-09-02 01:30:29 +02002803 /*
2804 * Can't allow enabling interrupts while in an interrupt handler,
2805 * that's general bad form and such. Recursion, limited stack etc..
2806 */
Peter Zijlstra7d36b262011-07-26 13:13:44 +02002807 if (DEBUG_LOCKS_WARN_ON(current->hardirq_context))
2808 return;
2809
Peter Zijlstradd4e5d32011-06-21 17:17:27 +02002810 current->lockdep_recursion = 1;
2811 __trace_hardirqs_on_caller(ip);
2812 current->lockdep_recursion = 0;
2813}
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002814
2815/*
2816 * Hardirqs were disabled:
2817 */
Steven Rostedt (VMware)bff1b202018-08-06 15:50:58 -04002818void lockdep_hardirqs_off(unsigned long ip)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002819{
2820 struct task_struct *curr = current;
2821
2822 if (unlikely(!debug_locks || current->lockdep_recursion))
2823 return;
2824
Peter Zijlstra0119fee2011-09-02 01:30:29 +02002825 /*
2826 * So we're supposed to get called after you mask local IRQs, but for
2827 * some reason the hardware doesn't quite think you did a proper job.
2828 */
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002829 if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
2830 return;
2831
2832 if (curr->hardirqs_enabled) {
2833 /*
2834 * We have done an ON -> OFF transition:
2835 */
2836 curr->hardirqs_enabled = 0;
Heiko Carstens6afe40b2008-10-28 11:14:58 +01002837 curr->hardirq_disable_ip = ip;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002838 curr->hardirq_disable_event = ++curr->irq_events;
Frederic Weisbeckerbd6d29c2010-04-06 00:10:17 +02002839 debug_atomic_inc(hardirqs_off_events);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002840 } else
Frederic Weisbeckerbd6d29c2010-04-06 00:10:17 +02002841 debug_atomic_inc(redundant_hardirqs_off);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002842}
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002843
2844/*
2845 * Softirqs will be enabled:
2846 */
2847void trace_softirqs_on(unsigned long ip)
2848{
2849 struct task_struct *curr = current;
2850
Peter Zijlstradd4e5d32011-06-21 17:17:27 +02002851 if (unlikely(!debug_locks || current->lockdep_recursion))
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002852 return;
2853
Peter Zijlstra0119fee2011-09-02 01:30:29 +02002854 /*
2855 * We fancy IRQs being disabled here, see softirq.c, avoids
2856 * funny state and nesting things.
2857 */
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002858 if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
2859 return;
2860
2861 if (curr->softirqs_enabled) {
Frederic Weisbeckerbd6d29c2010-04-06 00:10:17 +02002862 debug_atomic_inc(redundant_softirqs_on);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002863 return;
2864 }
2865
Peter Zijlstradd4e5d32011-06-21 17:17:27 +02002866 current->lockdep_recursion = 1;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002867 /*
2868 * We'll do an OFF -> ON transition:
2869 */
2870 curr->softirqs_enabled = 1;
2871 curr->softirq_enable_ip = ip;
2872 curr->softirq_enable_event = ++curr->irq_events;
Frederic Weisbeckerbd6d29c2010-04-06 00:10:17 +02002873 debug_atomic_inc(softirqs_on_events);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002874 /*
2875 * We are going to turn softirqs on, so set the
2876 * usage bit for all held locks, if hardirqs are
2877 * enabled too:
2878 */
2879 if (curr->hardirqs_enabled)
Nick Piggincf40bd12009-01-21 08:12:39 +01002880 mark_held_locks(curr, SOFTIRQ);
Peter Zijlstradd4e5d32011-06-21 17:17:27 +02002881 current->lockdep_recursion = 0;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002882}
2883
2884/*
2885 * Softirqs were disabled:
2886 */
2887void trace_softirqs_off(unsigned long ip)
2888{
2889 struct task_struct *curr = current;
2890
Peter Zijlstradd4e5d32011-06-21 17:17:27 +02002891 if (unlikely(!debug_locks || current->lockdep_recursion))
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002892 return;
2893
Peter Zijlstra0119fee2011-09-02 01:30:29 +02002894 /*
2895 * We fancy IRQs being disabled here, see softirq.c
2896 */
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002897 if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
2898 return;
2899
2900 if (curr->softirqs_enabled) {
2901 /*
2902 * We have done an ON -> OFF transition:
2903 */
2904 curr->softirqs_enabled = 0;
2905 curr->softirq_disable_ip = ip;
2906 curr->softirq_disable_event = ++curr->irq_events;
Frederic Weisbeckerbd6d29c2010-04-06 00:10:17 +02002907 debug_atomic_inc(softirqs_off_events);
Peter Zijlstra0119fee2011-09-02 01:30:29 +02002908 /*
2909 * Whoops, we wanted softirqs off, so why aren't they?
2910 */
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002911 DEBUG_LOCKS_WARN_ON(!softirq_count());
2912 } else
Frederic Weisbeckerbd6d29c2010-04-06 00:10:17 +02002913 debug_atomic_inc(redundant_softirqs_off);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002914}
2915
Peter Zijlstra8e182572007-07-19 01:48:54 -07002916static int mark_irqflags(struct task_struct *curr, struct held_lock *hlock)
2917{
2918 /*
2919 * If non-trylock use in a hardirq or softirq context, then
2920 * mark the lock as used in these contexts:
2921 */
2922 if (!hlock->trylock) {
2923 if (hlock->read) {
2924 if (curr->hardirq_context)
2925 if (!mark_lock(curr, hlock,
2926 LOCK_USED_IN_HARDIRQ_READ))
2927 return 0;
2928 if (curr->softirq_context)
2929 if (!mark_lock(curr, hlock,
2930 LOCK_USED_IN_SOFTIRQ_READ))
2931 return 0;
2932 } else {
2933 if (curr->hardirq_context)
2934 if (!mark_lock(curr, hlock, LOCK_USED_IN_HARDIRQ))
2935 return 0;
2936 if (curr->softirq_context)
2937 if (!mark_lock(curr, hlock, LOCK_USED_IN_SOFTIRQ))
2938 return 0;
2939 }
2940 }
2941 if (!hlock->hardirqs_off) {
2942 if (hlock->read) {
2943 if (!mark_lock(curr, hlock,
Peter Zijlstra4fc95e82009-01-22 13:10:52 +01002944 LOCK_ENABLED_HARDIRQ_READ))
Peter Zijlstra8e182572007-07-19 01:48:54 -07002945 return 0;
2946 if (curr->softirqs_enabled)
2947 if (!mark_lock(curr, hlock,
Peter Zijlstra4fc95e82009-01-22 13:10:52 +01002948 LOCK_ENABLED_SOFTIRQ_READ))
Peter Zijlstra8e182572007-07-19 01:48:54 -07002949 return 0;
2950 } else {
2951 if (!mark_lock(curr, hlock,
Peter Zijlstra4fc95e82009-01-22 13:10:52 +01002952 LOCK_ENABLED_HARDIRQ))
Peter Zijlstra8e182572007-07-19 01:48:54 -07002953 return 0;
2954 if (curr->softirqs_enabled)
2955 if (!mark_lock(curr, hlock,
Peter Zijlstra4fc95e82009-01-22 13:10:52 +01002956 LOCK_ENABLED_SOFTIRQ))
Peter Zijlstra8e182572007-07-19 01:48:54 -07002957 return 0;
2958 }
2959 }
2960
2961 return 1;
2962}
2963
Boqun Fengc2469752016-02-16 13:57:40 +08002964static inline unsigned int task_irq_context(struct task_struct *task)
2965{
2966 return 2 * !!task->hardirq_context + !!task->softirq_context;
2967}
2968
Peter Zijlstra8e182572007-07-19 01:48:54 -07002969static int separate_irq_context(struct task_struct *curr,
2970 struct held_lock *hlock)
2971{
2972 unsigned int depth = curr->lockdep_depth;
2973
2974 /*
2975 * Keep track of points where we cross into an interrupt context:
2976 */
Peter Zijlstra8e182572007-07-19 01:48:54 -07002977 if (depth) {
2978 struct held_lock *prev_hlock;
2979
2980 prev_hlock = curr->held_locks + depth-1;
2981 /*
2982 * If we cross into another context, reset the
2983 * hash key (this also prevents the checking and the
2984 * adding of the dependency to 'prev'):
2985 */
2986 if (prev_hlock->irq_context != hlock->irq_context)
2987 return 1;
2988 }
2989 return 0;
2990}
2991
Peter Zijlstra0119fee2011-09-02 01:30:29 +02002992#else /* defined(CONFIG_TRACE_IRQFLAGS) && defined(CONFIG_PROVE_LOCKING) */
Peter Zijlstra8e182572007-07-19 01:48:54 -07002993
2994static inline
2995int mark_lock_irq(struct task_struct *curr, struct held_lock *this,
2996 enum lock_usage_bit new_bit)
2997{
Peter Zijlstra0119fee2011-09-02 01:30:29 +02002998 WARN_ON(1); /* Impossible innit? when we don't have TRACE_IRQFLAG */
Peter Zijlstra8e182572007-07-19 01:48:54 -07002999 return 1;
3000}
3001
3002static inline int mark_irqflags(struct task_struct *curr,
3003 struct held_lock *hlock)
3004{
3005 return 1;
3006}
3007
Boqun Fengc2469752016-02-16 13:57:40 +08003008static inline unsigned int task_irq_context(struct task_struct *task)
3009{
3010 return 0;
3011}
3012
Peter Zijlstra8e182572007-07-19 01:48:54 -07003013static inline int separate_irq_context(struct task_struct *curr,
3014 struct held_lock *hlock)
3015{
3016 return 0;
3017}
3018
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003019#endif /* defined(CONFIG_TRACE_IRQFLAGS) && defined(CONFIG_PROVE_LOCKING) */
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003020
3021/*
Peter Zijlstra8e182572007-07-19 01:48:54 -07003022 * Mark a lock with a usage bit, and validate the state transition:
3023 */
Steven Rostedt1d09daa2008-05-12 21:20:55 +02003024static int mark_lock(struct task_struct *curr, struct held_lock *this,
Steven Rostedt0764d232008-05-12 21:20:44 +02003025 enum lock_usage_bit new_bit)
Peter Zijlstra8e182572007-07-19 01:48:54 -07003026{
3027 unsigned int new_mask = 1 << new_bit, ret = 1;
3028
3029 /*
3030 * If already set then do not dirty the cacheline,
3031 * nor do any checks:
3032 */
Dave Jonesf82b2172008-08-11 09:30:23 +02003033 if (likely(hlock_class(this)->usage_mask & new_mask))
Peter Zijlstra8e182572007-07-19 01:48:54 -07003034 return 1;
3035
3036 if (!graph_lock())
3037 return 0;
3038 /*
Lucas De Marchi25985ed2011-03-30 22:57:33 -03003039 * Make sure we didn't race:
Peter Zijlstra8e182572007-07-19 01:48:54 -07003040 */
Dave Jonesf82b2172008-08-11 09:30:23 +02003041 if (unlikely(hlock_class(this)->usage_mask & new_mask)) {
Peter Zijlstra8e182572007-07-19 01:48:54 -07003042 graph_unlock();
3043 return 1;
3044 }
3045
Dave Jonesf82b2172008-08-11 09:30:23 +02003046 hlock_class(this)->usage_mask |= new_mask;
Peter Zijlstra8e182572007-07-19 01:48:54 -07003047
Dave Jonesf82b2172008-08-11 09:30:23 +02003048 if (!save_trace(hlock_class(this)->usage_traces + new_bit))
Peter Zijlstra8e182572007-07-19 01:48:54 -07003049 return 0;
3050
3051 switch (new_bit) {
Peter Zijlstra53464172009-01-22 14:15:53 +01003052#define LOCKDEP_STATE(__STATE) \
3053 case LOCK_USED_IN_##__STATE: \
3054 case LOCK_USED_IN_##__STATE##_READ: \
3055 case LOCK_ENABLED_##__STATE: \
3056 case LOCK_ENABLED_##__STATE##_READ:
3057#include "lockdep_states.h"
3058#undef LOCKDEP_STATE
Peter Zijlstra8e182572007-07-19 01:48:54 -07003059 ret = mark_lock_irq(curr, this, new_bit);
3060 if (!ret)
3061 return 0;
3062 break;
3063 case LOCK_USED:
Frederic Weisbeckerbd6d29c2010-04-06 00:10:17 +02003064 debug_atomic_dec(nr_unused_locks);
Peter Zijlstra8e182572007-07-19 01:48:54 -07003065 break;
3066 default:
3067 if (!debug_locks_off_graph_unlock())
3068 return 0;
3069 WARN_ON(1);
3070 return 0;
3071 }
3072
3073 graph_unlock();
3074
3075 /*
3076 * We must printk outside of the graph_lock:
3077 */
3078 if (ret == 2) {
3079 printk("\nmarked lock as {%s}:\n", usage_str[new_bit]);
3080 print_lock(this);
3081 print_irqtrace_events(curr);
3082 dump_stack();
3083 }
3084
3085 return ret;
3086}
3087
3088/*
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003089 * Initialize a lock instance's lock-class mapping info:
3090 */
Byungchul Parkb09be672017-08-07 16:12:52 +09003091static void __lockdep_init_map(struct lockdep_map *lock, const char *name,
Peter Zijlstra4dfbb9d2006-10-11 01:45:14 -04003092 struct lock_class_key *key, int subclass)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003093{
Yong Zhangd3d03d42011-11-09 16:04:51 +08003094 int i;
3095
Yong Zhangd3d03d42011-11-09 16:04:51 +08003096 for (i = 0; i < NR_LOCKDEP_CACHING_CLASSES; i++)
3097 lock->class_cache[i] = NULL;
Hitoshi Mitake62016252010-10-05 18:01:51 +09003098
Peter Zijlstrac8a25002009-04-17 09:40:49 +02003099#ifdef CONFIG_LOCK_STAT
3100 lock->cpu = raw_smp_processor_id();
3101#endif
3102
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003103 /*
3104 * Can't be having no nameless bastards around this place!
3105 */
Peter Zijlstrac8a25002009-04-17 09:40:49 +02003106 if (DEBUG_LOCKS_WARN_ON(!name)) {
3107 lock->name = "NULL";
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003108 return;
Peter Zijlstrac8a25002009-04-17 09:40:49 +02003109 }
3110
3111 lock->name = name;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003112
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003113 /*
3114 * No key, no joy, we need to hash something.
3115 */
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003116 if (DEBUG_LOCKS_WARN_ON(!key))
3117 return;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003118 /*
3119 * Sanity check, the lock-class key must be persistent:
3120 */
3121 if (!static_obj(key)) {
Borislav Petkov04860d42018-02-26 14:49:26 +01003122 printk("BUG: key %px not in .data!\n", key);
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003123 /*
3124 * What it says above ^^^^^, I suggest you read it.
3125 */
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003126 DEBUG_LOCKS_WARN_ON(1);
3127 return;
3128 }
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003129 lock->key = key;
Peter Zijlstrac8a25002009-04-17 09:40:49 +02003130
3131 if (unlikely(!debug_locks))
3132 return;
3133
Peter Zijlstra35a93932015-02-26 16:23:11 +01003134 if (subclass) {
3135 unsigned long flags;
3136
3137 if (DEBUG_LOCKS_WARN_ON(current->lockdep_recursion))
3138 return;
3139
3140 raw_local_irq_save(flags);
3141 current->lockdep_recursion = 1;
Peter Zijlstra4dfbb9d2006-10-11 01:45:14 -04003142 register_lock_class(lock, subclass, 1);
Peter Zijlstra35a93932015-02-26 16:23:11 +01003143 current->lockdep_recursion = 0;
3144 raw_local_irq_restore(flags);
3145 }
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003146}
Byungchul Parkb09be672017-08-07 16:12:52 +09003147
3148void lockdep_init_map(struct lockdep_map *lock, const char *name,
3149 struct lock_class_key *key, int subclass)
3150{
Byungchul Parkb09be672017-08-07 16:12:52 +09003151 __lockdep_init_map(lock, name, key, subclass);
3152}
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003153EXPORT_SYMBOL_GPL(lockdep_init_map);
3154
Peter Zijlstra1704f472010-03-19 01:37:42 +01003155struct lock_class_key __lockdep_no_validate__;
Kent Overstreetea6749c2012-12-27 22:21:58 -08003156EXPORT_SYMBOL_GPL(__lockdep_no_validate__);
Peter Zijlstra1704f472010-03-19 01:37:42 +01003157
Maarten Lankhorstd0945952012-09-13 11:39:51 +02003158static int
3159print_lock_nested_lock_not_held(struct task_struct *curr,
3160 struct held_lock *hlock,
3161 unsigned long ip)
3162{
3163 if (!debug_locks_off())
3164 return 0;
3165 if (debug_locks_silent)
3166 return 0;
3167
Paul E. McKenney681fbec2017-05-04 15:44:38 -07003168 pr_warn("\n");
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08003169 pr_warn("==================================\n");
3170 pr_warn("WARNING: Nested lock was not taken\n");
Maarten Lankhorstd0945952012-09-13 11:39:51 +02003171 print_kernel_ident();
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08003172 pr_warn("----------------------------------\n");
Maarten Lankhorstd0945952012-09-13 11:39:51 +02003173
Paul E. McKenney681fbec2017-05-04 15:44:38 -07003174 pr_warn("%s/%d is trying to lock:\n", curr->comm, task_pid_nr(curr));
Maarten Lankhorstd0945952012-09-13 11:39:51 +02003175 print_lock(hlock);
3176
Paul E. McKenney681fbec2017-05-04 15:44:38 -07003177 pr_warn("\nbut this task is not holding:\n");
3178 pr_warn("%s\n", hlock->nest_lock->name);
Maarten Lankhorstd0945952012-09-13 11:39:51 +02003179
Paul E. McKenney681fbec2017-05-04 15:44:38 -07003180 pr_warn("\nstack backtrace:\n");
Maarten Lankhorstd0945952012-09-13 11:39:51 +02003181 dump_stack();
3182
Paul E. McKenney681fbec2017-05-04 15:44:38 -07003183 pr_warn("\nother info that might help us debug this:\n");
Maarten Lankhorstd0945952012-09-13 11:39:51 +02003184 lockdep_print_held_locks(curr);
3185
Paul E. McKenney681fbec2017-05-04 15:44:38 -07003186 pr_warn("\nstack backtrace:\n");
Maarten Lankhorstd0945952012-09-13 11:39:51 +02003187 dump_stack();
3188
3189 return 0;
3190}
3191
Matthew Wilcox08f36ff2018-01-17 07:14:13 -08003192static int __lock_is_held(const struct lockdep_map *lock, int read);
Maarten Lankhorstd0945952012-09-13 11:39:51 +02003193
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003194/*
3195 * This gets called for every mutex_lock*()/spin_lock*() operation.
3196 * We maintain the dependency maps and validate the locking attempt:
Waiman Long8ee10862018-10-02 16:19:17 -04003197 *
3198 * The callers must make sure that IRQs are disabled before calling it,
3199 * otherwise we could get an interrupt which would want to take locks,
3200 * which would end up in lockdep again.
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003201 */
3202static int __lock_acquire(struct lockdep_map *lock, unsigned int subclass,
3203 int trylock, int read, int check, int hardirqs_off,
Peter Zijlstrabb97a912009-07-20 19:15:35 +02003204 struct lockdep_map *nest_lock, unsigned long ip,
Peter Zijlstra21199f22015-09-16 16:10:40 +02003205 int references, int pin_count)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003206{
3207 struct task_struct *curr = current;
Ingo Molnard6d897c2006-07-10 04:44:04 -07003208 struct lock_class *class = NULL;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003209 struct held_lock *hlock;
Alfredo Alvarez Fernandez5f18ab52016-02-11 00:33:32 +01003210 unsigned int depth;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003211 int chain_head = 0;
Peter Zijlstrabb97a912009-07-20 19:15:35 +02003212 int class_idx;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003213 u64 chain_key;
3214
3215 if (unlikely(!debug_locks))
3216 return 0;
3217
Oleg Nesterovfb9edbe2014-01-20 19:20:06 +01003218 if (!prove_locking || lock->key == &__lockdep_no_validate__)
3219 check = 0;
Peter Zijlstra1704f472010-03-19 01:37:42 +01003220
Hitoshi Mitake62016252010-10-05 18:01:51 +09003221 if (subclass < NR_LOCKDEP_CACHING_CLASSES)
3222 class = lock->class_cache[subclass];
Ingo Molnard6d897c2006-07-10 04:44:04 -07003223 /*
Hitoshi Mitake62016252010-10-05 18:01:51 +09003224 * Not cached?
Ingo Molnard6d897c2006-07-10 04:44:04 -07003225 */
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003226 if (unlikely(!class)) {
Peter Zijlstra4dfbb9d2006-10-11 01:45:14 -04003227 class = register_lock_class(lock, subclass, 0);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003228 if (!class)
3229 return 0;
3230 }
Waiman Long8ca2b56c2018-10-03 13:07:18 -04003231
3232 debug_class_ops_inc(class);
3233
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003234 if (very_verbose(class)) {
Borislav Petkov04860d42018-02-26 14:49:26 +01003235 printk("\nacquire class [%px] %s", class->key, class->name);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003236 if (class->name_version > 1)
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01003237 printk(KERN_CONT "#%d", class->name_version);
3238 printk(KERN_CONT "\n");
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003239 dump_stack();
3240 }
3241
3242 /*
3243 * Add the lock to the list of currently held locks.
3244 * (we dont increase the depth just yet, up until the
3245 * dependency checks are done)
3246 */
3247 depth = curr->lockdep_depth;
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003248 /*
3249 * Ran out of static storage for our per-task lock stack again have we?
3250 */
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003251 if (DEBUG_LOCKS_WARN_ON(depth >= MAX_LOCK_DEPTH))
3252 return 0;
3253
Peter Zijlstrabb97a912009-07-20 19:15:35 +02003254 class_idx = class - lock_classes + 1;
3255
Ingo Molnare966eae2017-12-12 12:31:16 +01003256 if (depth) {
Peter Zijlstrabb97a912009-07-20 19:15:35 +02003257 hlock = curr->held_locks + depth - 1;
3258 if (hlock->class_idx == class_idx && nest_lock) {
Peter Zijlstra7fb4a2c2017-03-01 16:23:30 +01003259 if (hlock->references) {
3260 /*
3261 * Check: unsigned int references:12, overflow.
3262 */
3263 if (DEBUG_LOCKS_WARN_ON(hlock->references == (1 << 12)-1))
3264 return 0;
3265
Peter Zijlstrabb97a912009-07-20 19:15:35 +02003266 hlock->references++;
Peter Zijlstra7fb4a2c2017-03-01 16:23:30 +01003267 } else {
Peter Zijlstrabb97a912009-07-20 19:15:35 +02003268 hlock->references = 2;
Peter Zijlstra7fb4a2c2017-03-01 16:23:30 +01003269 }
Peter Zijlstrabb97a912009-07-20 19:15:35 +02003270
3271 return 1;
3272 }
3273 }
3274
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003275 hlock = curr->held_locks + depth;
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003276 /*
3277 * Plain impossible, we just registered it and checked it weren't no
3278 * NULL like.. I bet this mushroom I ate was good!
3279 */
Dave Jonesf82b2172008-08-11 09:30:23 +02003280 if (DEBUG_LOCKS_WARN_ON(!class))
3281 return 0;
Peter Zijlstrabb97a912009-07-20 19:15:35 +02003282 hlock->class_idx = class_idx;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003283 hlock->acquire_ip = ip;
3284 hlock->instance = lock;
Peter Zijlstra7531e2f2008-08-11 09:30:24 +02003285 hlock->nest_lock = nest_lock;
Boqun Fengc2469752016-02-16 13:57:40 +08003286 hlock->irq_context = task_irq_context(curr);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003287 hlock->trylock = trylock;
3288 hlock->read = read;
3289 hlock->check = check;
Dmitry Baryshkov6951b122008-08-18 04:26:37 +04003290 hlock->hardirqs_off = !!hardirqs_off;
Peter Zijlstrabb97a912009-07-20 19:15:35 +02003291 hlock->references = references;
Peter Zijlstraf20786f2007-07-19 01:48:56 -07003292#ifdef CONFIG_LOCK_STAT
3293 hlock->waittime_stamp = 0;
Peter Zijlstra3365e7792009-10-09 10:12:41 +02003294 hlock->holdtime_stamp = lockstat_clock();
Peter Zijlstraf20786f2007-07-19 01:48:56 -07003295#endif
Peter Zijlstra21199f22015-09-16 16:10:40 +02003296 hlock->pin_count = pin_count;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003297
Oleg Nesterovfb9edbe2014-01-20 19:20:06 +01003298 if (check && !mark_irqflags(curr, hlock))
Peter Zijlstra8e182572007-07-19 01:48:54 -07003299 return 0;
3300
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003301 /* mark it as used: */
Jarek Poplawski4ff773bb2007-05-08 00:31:00 -07003302 if (!mark_lock(curr, hlock, LOCK_USED))
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003303 return 0;
Peter Zijlstra8e182572007-07-19 01:48:54 -07003304
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003305 /*
Gautham R Shenoy17aacfb92007-10-28 20:47:01 +01003306 * Calculate the chain hash: it's the combined hash of all the
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003307 * lock keys along the dependency chain. We save the hash value
3308 * at every step so that we can get the current hash easily
3309 * after unlock. The chain hash is then used to cache dependency
3310 * results.
3311 *
3312 * The 'key ID' is what is the most compact key value to drive
3313 * the hash, not class->key.
3314 */
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003315 /*
3316 * Whoops, we did it again.. ran straight out of our static allocation.
3317 */
Alfredo Alvarez Fernandez5f18ab52016-02-11 00:33:32 +01003318 if (DEBUG_LOCKS_WARN_ON(class_idx > MAX_LOCKDEP_KEYS))
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003319 return 0;
3320
3321 chain_key = curr->curr_chain_key;
3322 if (!depth) {
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003323 /*
3324 * How can we have a chain hash when we ain't got no keys?!
3325 */
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003326 if (DEBUG_LOCKS_WARN_ON(chain_key != 0))
3327 return 0;
3328 chain_head = 1;
3329 }
3330
3331 hlock->prev_chain_key = chain_key;
Peter Zijlstra8e182572007-07-19 01:48:54 -07003332 if (separate_irq_context(curr, hlock)) {
3333 chain_key = 0;
3334 chain_head = 1;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003335 }
Alfredo Alvarez Fernandez5f18ab52016-02-11 00:33:32 +01003336 chain_key = iterate_chain_key(chain_key, class_idx);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003337
Peter Zijlstraf8319482016-11-30 14:32:25 +11003338 if (nest_lock && !__lock_is_held(nest_lock, -1))
Maarten Lankhorstd0945952012-09-13 11:39:51 +02003339 return print_lock_nested_lock_not_held(curr, hlock, ip);
3340
Gregory Haskins3aa416b2007-10-11 22:11:11 +02003341 if (!validate_chain(curr, lock, hlock, chain_head, chain_key))
Peter Zijlstra8e182572007-07-19 01:48:54 -07003342 return 0;
Jarek Poplawski381a2292007-02-10 01:44:58 -08003343
Gregory Haskins3aa416b2007-10-11 22:11:11 +02003344 curr->curr_chain_key = chain_key;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003345 curr->lockdep_depth++;
3346 check_chain_key(curr);
Jarek Poplawski60e114d2007-02-20 13:58:00 -08003347#ifdef CONFIG_DEBUG_LOCKDEP
3348 if (unlikely(!debug_locks))
3349 return 0;
3350#endif
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003351 if (unlikely(curr->lockdep_depth >= MAX_LOCK_DEPTH)) {
3352 debug_locks_off();
Dave Jones2c522832013-04-25 13:40:02 -04003353 print_lockdep_off("BUG: MAX_LOCK_DEPTH too low!");
3354 printk(KERN_DEBUG "depth: %i max: %lu!\n",
Ben Greearc0540602013-02-06 10:56:19 -08003355 curr->lockdep_depth, MAX_LOCK_DEPTH);
Ben Greearc0540602013-02-06 10:56:19 -08003356
3357 lockdep_print_held_locks(current);
3358 debug_show_all_locks();
Peter Zijlstraeedeeab2009-03-18 12:38:47 +01003359 dump_stack();
Ben Greearc0540602013-02-06 10:56:19 -08003360
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003361 return 0;
3362 }
Jarek Poplawski381a2292007-02-10 01:44:58 -08003363
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003364 if (unlikely(curr->lockdep_depth > max_lockdep_depth))
3365 max_lockdep_depth = curr->lockdep_depth;
3366
3367 return 1;
3368}
3369
3370static int
Srivatsa S. Bhatf86f7552013-01-08 18:35:58 +05303371print_unlock_imbalance_bug(struct task_struct *curr, struct lockdep_map *lock,
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003372 unsigned long ip)
3373{
3374 if (!debug_locks_off())
3375 return 0;
3376 if (debug_locks_silent)
3377 return 0;
3378
Paul E. McKenney681fbec2017-05-04 15:44:38 -07003379 pr_warn("\n");
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08003380 pr_warn("=====================================\n");
3381 pr_warn("WARNING: bad unlock balance detected!\n");
Ben Hutchingsfbdc4b92011-10-28 04:36:55 +01003382 print_kernel_ident();
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08003383 pr_warn("-------------------------------------\n");
Paul E. McKenney681fbec2017-05-04 15:44:38 -07003384 pr_warn("%s/%d is trying to release lock (",
Pavel Emelyanovba25f9d2007-10-18 23:40:40 -07003385 curr->comm, task_pid_nr(curr));
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003386 print_lockdep_cache(lock);
Paul E. McKenney681fbec2017-05-04 15:44:38 -07003387 pr_cont(") at:\n");
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003388 print_ip_sym(ip);
Paul E. McKenney681fbec2017-05-04 15:44:38 -07003389 pr_warn("but there are no more locks to release!\n");
3390 pr_warn("\nother info that might help us debug this:\n");
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003391 lockdep_print_held_locks(curr);
3392
Paul E. McKenney681fbec2017-05-04 15:44:38 -07003393 pr_warn("\nstack backtrace:\n");
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003394 dump_stack();
3395
3396 return 0;
3397}
3398
Matthew Wilcox08f36ff2018-01-17 07:14:13 -08003399static int match_held_lock(const struct held_lock *hlock,
3400 const struct lockdep_map *lock)
Peter Zijlstrabb97a912009-07-20 19:15:35 +02003401{
3402 if (hlock->instance == lock)
3403 return 1;
3404
3405 if (hlock->references) {
Matthew Wilcox08f36ff2018-01-17 07:14:13 -08003406 const struct lock_class *class = lock->class_cache[0];
Peter Zijlstrabb97a912009-07-20 19:15:35 +02003407
3408 if (!class)
3409 class = look_up_lock_class(lock, 0);
3410
Peter Zijlstra80e04012011-08-05 14:26:17 +02003411 /*
3412 * If look_up_lock_class() failed to find a class, we're trying
3413 * to test if we hold a lock that has never yet been acquired.
3414 * Clearly if the lock hasn't been acquired _ever_, we're not
3415 * holding it either, so report failure.
3416 */
Matthew Wilcox64f29d12018-01-17 07:14:12 -08003417 if (!class)
Peter Zijlstrabb97a912009-07-20 19:15:35 +02003418 return 0;
3419
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003420 /*
3421 * References, but not a lock we're actually ref-counting?
3422 * State got messed up, follow the sites that change ->references
3423 * and try to make sense of it.
3424 */
Peter Zijlstrabb97a912009-07-20 19:15:35 +02003425 if (DEBUG_LOCKS_WARN_ON(!hlock->nest_lock))
3426 return 0;
3427
3428 if (hlock->class_idx == class - lock_classes + 1)
3429 return 1;
3430 }
3431
3432 return 0;
3433}
3434
J. R. Okajima41c2c5b2017-02-03 01:38:15 +09003435/* @depth must not be zero */
3436static struct held_lock *find_held_lock(struct task_struct *curr,
3437 struct lockdep_map *lock,
3438 unsigned int depth, int *idx)
3439{
3440 struct held_lock *ret, *hlock, *prev_hlock;
3441 int i;
3442
3443 i = depth - 1;
3444 hlock = curr->held_locks + i;
3445 ret = hlock;
3446 if (match_held_lock(hlock, lock))
3447 goto out;
3448
3449 ret = NULL;
3450 for (i--, prev_hlock = hlock--;
3451 i >= 0;
3452 i--, prev_hlock = hlock--) {
3453 /*
3454 * We must not cross into another context:
3455 */
3456 if (prev_hlock->irq_context != hlock->irq_context) {
3457 ret = NULL;
3458 break;
3459 }
3460 if (match_held_lock(hlock, lock)) {
3461 ret = hlock;
3462 break;
3463 }
3464 }
3465
3466out:
3467 *idx = i;
3468 return ret;
3469}
3470
J. R. Okajimae9699702017-02-03 01:38:16 +09003471static int reacquire_held_locks(struct task_struct *curr, unsigned int depth,
3472 int idx)
3473{
3474 struct held_lock *hlock;
3475
Waiman Long8ee10862018-10-02 16:19:17 -04003476 if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
3477 return 0;
3478
J. R. Okajimae9699702017-02-03 01:38:16 +09003479 for (hlock = curr->held_locks + idx; idx < depth; idx++, hlock++) {
3480 if (!__lock_acquire(hlock->instance,
3481 hlock_class(hlock)->subclass,
3482 hlock->trylock,
3483 hlock->read, hlock->check,
3484 hlock->hardirqs_off,
3485 hlock->nest_lock, hlock->acquire_ip,
3486 hlock->references, hlock->pin_count))
3487 return 1;
3488 }
3489 return 0;
3490}
3491
Peter Zijlstra64aa3482008-08-11 09:30:21 +02003492static int
Peter Zijlstra00ef9f72008-12-04 09:00:17 +01003493__lock_set_class(struct lockdep_map *lock, const char *name,
3494 struct lock_class_key *key, unsigned int subclass,
3495 unsigned long ip)
Peter Zijlstra64aa3482008-08-11 09:30:21 +02003496{
3497 struct task_struct *curr = current;
J. R. Okajima41c2c5b2017-02-03 01:38:15 +09003498 struct held_lock *hlock;
Peter Zijlstra64aa3482008-08-11 09:30:21 +02003499 struct lock_class *class;
3500 unsigned int depth;
3501 int i;
3502
3503 depth = curr->lockdep_depth;
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003504 /*
3505 * This function is about (re)setting the class of a held lock,
3506 * yet we're not actually holding any locks. Naughty user!
3507 */
Peter Zijlstra64aa3482008-08-11 09:30:21 +02003508 if (DEBUG_LOCKS_WARN_ON(!depth))
3509 return 0;
3510
J. R. Okajima41c2c5b2017-02-03 01:38:15 +09003511 hlock = find_held_lock(curr, lock, depth, &i);
3512 if (!hlock)
3513 return print_unlock_imbalance_bug(curr, lock, ip);
Peter Zijlstra64aa3482008-08-11 09:30:21 +02003514
Peter Zijlstra00ef9f72008-12-04 09:00:17 +01003515 lockdep_init_map(lock, name, key, 0);
Peter Zijlstra64aa3482008-08-11 09:30:21 +02003516 class = register_lock_class(lock, subclass, 0);
Dave Jonesf82b2172008-08-11 09:30:23 +02003517 hlock->class_idx = class - lock_classes + 1;
Peter Zijlstra64aa3482008-08-11 09:30:21 +02003518
3519 curr->lockdep_depth = i;
3520 curr->curr_chain_key = hlock->prev_chain_key;
3521
J. R. Okajimae9699702017-02-03 01:38:16 +09003522 if (reacquire_held_locks(curr, depth, i))
3523 return 0;
Peter Zijlstra64aa3482008-08-11 09:30:21 +02003524
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003525 /*
3526 * I took it apart and put it back together again, except now I have
3527 * these 'spare' parts.. where shall I put them.
3528 */
Peter Zijlstra64aa3482008-08-11 09:30:21 +02003529 if (DEBUG_LOCKS_WARN_ON(curr->lockdep_depth != depth))
3530 return 0;
3531 return 1;
3532}
3533
J. R. Okajima6419c4a2017-02-03 01:38:17 +09003534static int __lock_downgrade(struct lockdep_map *lock, unsigned long ip)
3535{
3536 struct task_struct *curr = current;
3537 struct held_lock *hlock;
3538 unsigned int depth;
3539 int i;
3540
3541 depth = curr->lockdep_depth;
3542 /*
3543 * This function is about (re)setting the class of a held lock,
3544 * yet we're not actually holding any locks. Naughty user!
3545 */
3546 if (DEBUG_LOCKS_WARN_ON(!depth))
3547 return 0;
3548
3549 hlock = find_held_lock(curr, lock, depth, &i);
3550 if (!hlock)
3551 return print_unlock_imbalance_bug(curr, lock, ip);
3552
3553 curr->lockdep_depth = i;
3554 curr->curr_chain_key = hlock->prev_chain_key;
3555
3556 WARN(hlock->read, "downgrading a read lock");
3557 hlock->read = 1;
3558 hlock->acquire_ip = ip;
3559
3560 if (reacquire_held_locks(curr, depth, i))
3561 return 0;
3562
3563 /*
3564 * I took it apart and put it back together again, except now I have
3565 * these 'spare' parts.. where shall I put them.
3566 */
3567 if (DEBUG_LOCKS_WARN_ON(curr->lockdep_depth != depth))
3568 return 0;
3569 return 1;
3570}
3571
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003572/*
Peter Zijlstrae0f56fd2015-06-11 14:46:52 +02003573 * Remove the lock to the list of currently held locks - this gets
3574 * called on mutex_unlock()/spin_unlock*() (or on a failed
3575 * mutex_lock_interruptible()).
3576 *
3577 * @nested is an hysterical artifact, needs a tree wide cleanup.
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003578 */
3579static int
Peter Zijlstrae0f56fd2015-06-11 14:46:52 +02003580__lock_release(struct lockdep_map *lock, int nested, unsigned long ip)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003581{
Peter Zijlstrae0f56fd2015-06-11 14:46:52 +02003582 struct task_struct *curr = current;
J. R. Okajima41c2c5b2017-02-03 01:38:15 +09003583 struct held_lock *hlock;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003584 unsigned int depth;
Ingo Molnare966eae2017-12-12 12:31:16 +01003585 int i;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003586
Peter Zijlstrae0f56fd2015-06-11 14:46:52 +02003587 if (unlikely(!debug_locks))
3588 return 0;
3589
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003590 depth = curr->lockdep_depth;
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003591 /*
3592 * So we're all set to release this lock.. wait what lock? We don't
3593 * own any locks, you've been drinking again?
3594 */
Peter Zijlstrae0f56fd2015-06-11 14:46:52 +02003595 if (DEBUG_LOCKS_WARN_ON(depth <= 0))
3596 return print_unlock_imbalance_bug(curr, lock, ip);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003597
Peter Zijlstrae0f56fd2015-06-11 14:46:52 +02003598 /*
3599 * Check whether the lock exists in the current stack
3600 * of held locks:
3601 */
J. R. Okajima41c2c5b2017-02-03 01:38:15 +09003602 hlock = find_held_lock(curr, lock, depth, &i);
3603 if (!hlock)
3604 return print_unlock_imbalance_bug(curr, lock, ip);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003605
Peter Zijlstrabb97a912009-07-20 19:15:35 +02003606 if (hlock->instance == lock)
3607 lock_release_holdtime(hlock);
3608
Peter Zijlstraa24fc602015-06-11 14:46:53 +02003609 WARN(hlock->pin_count, "releasing a pinned lock\n");
3610
Peter Zijlstrabb97a912009-07-20 19:15:35 +02003611 if (hlock->references) {
3612 hlock->references--;
3613 if (hlock->references) {
3614 /*
3615 * We had, and after removing one, still have
3616 * references, the current lock stack is still
3617 * valid. We're done!
3618 */
3619 return 1;
3620 }
3621 }
Peter Zijlstraf20786f2007-07-19 01:48:56 -07003622
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003623 /*
3624 * We have the right lock to unlock, 'hlock' points to it.
3625 * Now we remove it from the stack, and add back the other
3626 * entries (if any), recalculating the hash along the way:
3627 */
Peter Zijlstrabb97a912009-07-20 19:15:35 +02003628
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003629 curr->lockdep_depth = i;
3630 curr->curr_chain_key = hlock->prev_chain_key;
3631
Waiman Longce52a182018-10-02 16:19:18 -04003632 /*
3633 * The most likely case is when the unlock is on the innermost
3634 * lock. In this case, we are done!
3635 */
3636 if (i == depth-1)
3637 return 1;
3638
J. R. Okajimae9699702017-02-03 01:38:16 +09003639 if (reacquire_held_locks(curr, depth, i + 1))
3640 return 0;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003641
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003642 /*
3643 * We had N bottles of beer on the wall, we drank one, but now
3644 * there's not N-1 bottles of beer left on the wall...
3645 */
Waiman Longce52a182018-10-02 16:19:18 -04003646 DEBUG_LOCKS_WARN_ON(curr->lockdep_depth != depth-1);
Peter Zijlstrae0f56fd2015-06-11 14:46:52 +02003647
Waiman Longce52a182018-10-02 16:19:18 -04003648 /*
3649 * Since reacquire_held_locks() would have called check_chain_key()
3650 * indirectly via __lock_acquire(), we don't need to do it again
3651 * on return.
3652 */
3653 return 0;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003654}
3655
Matthew Wilcox08f36ff2018-01-17 07:14:13 -08003656static int __lock_is_held(const struct lockdep_map *lock, int read)
Peter Zijlstraf607c662009-07-20 19:16:29 +02003657{
3658 struct task_struct *curr = current;
3659 int i;
3660
3661 for (i = 0; i < curr->lockdep_depth; i++) {
Peter Zijlstrabb97a912009-07-20 19:15:35 +02003662 struct held_lock *hlock = curr->held_locks + i;
3663
Peter Zijlstraf8319482016-11-30 14:32:25 +11003664 if (match_held_lock(hlock, lock)) {
3665 if (read == -1 || hlock->read == read)
3666 return 1;
3667
3668 return 0;
3669 }
Peter Zijlstraf607c662009-07-20 19:16:29 +02003670 }
3671
3672 return 0;
3673}
3674
Peter Zijlstrae7904a22015-08-01 19:25:08 +02003675static struct pin_cookie __lock_pin_lock(struct lockdep_map *lock)
3676{
3677 struct pin_cookie cookie = NIL_COOKIE;
3678 struct task_struct *curr = current;
3679 int i;
3680
3681 if (unlikely(!debug_locks))
3682 return cookie;
3683
3684 for (i = 0; i < curr->lockdep_depth; i++) {
3685 struct held_lock *hlock = curr->held_locks + i;
3686
3687 if (match_held_lock(hlock, lock)) {
3688 /*
3689 * Grab 16bits of randomness; this is sufficient to not
3690 * be guessable and still allows some pin nesting in
3691 * our u32 pin_count.
3692 */
3693 cookie.val = 1 + (prandom_u32() >> 16);
3694 hlock->pin_count += cookie.val;
3695 return cookie;
3696 }
3697 }
3698
3699 WARN(1, "pinning an unheld lock\n");
3700 return cookie;
3701}
3702
3703static void __lock_repin_lock(struct lockdep_map *lock, struct pin_cookie cookie)
Peter Zijlstraa24fc602015-06-11 14:46:53 +02003704{
3705 struct task_struct *curr = current;
3706 int i;
3707
3708 if (unlikely(!debug_locks))
3709 return;
3710
3711 for (i = 0; i < curr->lockdep_depth; i++) {
3712 struct held_lock *hlock = curr->held_locks + i;
3713
3714 if (match_held_lock(hlock, lock)) {
Peter Zijlstrae7904a22015-08-01 19:25:08 +02003715 hlock->pin_count += cookie.val;
Peter Zijlstraa24fc602015-06-11 14:46:53 +02003716 return;
3717 }
3718 }
3719
3720 WARN(1, "pinning an unheld lock\n");
3721}
3722
Peter Zijlstrae7904a22015-08-01 19:25:08 +02003723static void __lock_unpin_lock(struct lockdep_map *lock, struct pin_cookie cookie)
Peter Zijlstraa24fc602015-06-11 14:46:53 +02003724{
3725 struct task_struct *curr = current;
3726 int i;
3727
3728 if (unlikely(!debug_locks))
3729 return;
3730
3731 for (i = 0; i < curr->lockdep_depth; i++) {
3732 struct held_lock *hlock = curr->held_locks + i;
3733
3734 if (match_held_lock(hlock, lock)) {
3735 if (WARN(!hlock->pin_count, "unpinning an unpinned lock\n"))
3736 return;
3737
Peter Zijlstrae7904a22015-08-01 19:25:08 +02003738 hlock->pin_count -= cookie.val;
3739
3740 if (WARN((int)hlock->pin_count < 0, "pin count corrupted\n"))
3741 hlock->pin_count = 0;
3742
Peter Zijlstraa24fc602015-06-11 14:46:53 +02003743 return;
3744 }
3745 }
3746
3747 WARN(1, "unpinning an unheld lock\n");
3748}
3749
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003750/*
3751 * Check whether we follow the irq-flags state precisely:
3752 */
Steven Rostedt1d09daa2008-05-12 21:20:55 +02003753static void check_flags(unsigned long flags)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003754{
Ingo Molnar992860e2008-07-14 10:28:38 +02003755#if defined(CONFIG_PROVE_LOCKING) && defined(CONFIG_DEBUG_LOCKDEP) && \
3756 defined(CONFIG_TRACE_IRQFLAGS)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003757 if (!debug_locks)
3758 return;
3759
Ingo Molnar5f9fa8a2007-12-07 19:02:47 +01003760 if (irqs_disabled_flags(flags)) {
3761 if (DEBUG_LOCKS_WARN_ON(current->hardirqs_enabled)) {
3762 printk("possible reason: unannotated irqs-off.\n");
3763 }
3764 } else {
3765 if (DEBUG_LOCKS_WARN_ON(!current->hardirqs_enabled)) {
3766 printk("possible reason: unannotated irqs-on.\n");
3767 }
3768 }
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003769
3770 /*
3771 * We dont accurately track softirq state in e.g.
3772 * hardirq contexts (such as on 4KSTACKS), so only
3773 * check if not in hardirq contexts:
3774 */
3775 if (!hardirq_count()) {
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003776 if (softirq_count()) {
3777 /* like the above, but with softirqs */
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003778 DEBUG_LOCKS_WARN_ON(current->softirqs_enabled);
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003779 } else {
3780 /* lick the above, does it taste good? */
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003781 DEBUG_LOCKS_WARN_ON(!current->softirqs_enabled);
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003782 }
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003783 }
3784
3785 if (!debug_locks)
3786 print_irqtrace_events(current);
3787#endif
3788}
3789
Peter Zijlstra00ef9f72008-12-04 09:00:17 +01003790void lock_set_class(struct lockdep_map *lock, const char *name,
3791 struct lock_class_key *key, unsigned int subclass,
3792 unsigned long ip)
Peter Zijlstra64aa3482008-08-11 09:30:21 +02003793{
3794 unsigned long flags;
3795
3796 if (unlikely(current->lockdep_recursion))
3797 return;
3798
3799 raw_local_irq_save(flags);
3800 current->lockdep_recursion = 1;
3801 check_flags(flags);
Peter Zijlstra00ef9f72008-12-04 09:00:17 +01003802 if (__lock_set_class(lock, name, key, subclass, ip))
Peter Zijlstra64aa3482008-08-11 09:30:21 +02003803 check_chain_key(current);
3804 current->lockdep_recursion = 0;
3805 raw_local_irq_restore(flags);
3806}
Peter Zijlstra00ef9f72008-12-04 09:00:17 +01003807EXPORT_SYMBOL_GPL(lock_set_class);
Peter Zijlstra64aa3482008-08-11 09:30:21 +02003808
J. R. Okajima6419c4a2017-02-03 01:38:17 +09003809void lock_downgrade(struct lockdep_map *lock, unsigned long ip)
3810{
3811 unsigned long flags;
3812
3813 if (unlikely(current->lockdep_recursion))
3814 return;
3815
3816 raw_local_irq_save(flags);
3817 current->lockdep_recursion = 1;
3818 check_flags(flags);
3819 if (__lock_downgrade(lock, ip))
3820 check_chain_key(current);
3821 current->lockdep_recursion = 0;
3822 raw_local_irq_restore(flags);
3823}
3824EXPORT_SYMBOL_GPL(lock_downgrade);
3825
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003826/*
3827 * We are not always called with irqs disabled - do that here,
3828 * and also avoid lockdep recursion:
3829 */
Steven Rostedt1d09daa2008-05-12 21:20:55 +02003830void lock_acquire(struct lockdep_map *lock, unsigned int subclass,
Peter Zijlstra7531e2f2008-08-11 09:30:24 +02003831 int trylock, int read, int check,
3832 struct lockdep_map *nest_lock, unsigned long ip)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003833{
3834 unsigned long flags;
3835
3836 if (unlikely(current->lockdep_recursion))
3837 return;
3838
3839 raw_local_irq_save(flags);
3840 check_flags(flags);
3841
3842 current->lockdep_recursion = 1;
Frederic Weisbeckerdb2c4c72010-02-02 23:34:40 +01003843 trace_lock_acquire(lock, subclass, trylock, read, check, nest_lock, ip);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003844 __lock_acquire(lock, subclass, trylock, read, check,
Peter Zijlstra21199f22015-09-16 16:10:40 +02003845 irqs_disabled_flags(flags), nest_lock, ip, 0, 0);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003846 current->lockdep_recursion = 0;
3847 raw_local_irq_restore(flags);
3848}
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003849EXPORT_SYMBOL_GPL(lock_acquire);
3850
Steven Rostedt1d09daa2008-05-12 21:20:55 +02003851void lock_release(struct lockdep_map *lock, int nested,
Steven Rostedt0764d232008-05-12 21:20:44 +02003852 unsigned long ip)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003853{
3854 unsigned long flags;
3855
3856 if (unlikely(current->lockdep_recursion))
3857 return;
3858
3859 raw_local_irq_save(flags);
3860 check_flags(flags);
3861 current->lockdep_recursion = 1;
Frederic Weisbecker93135432010-05-08 06:24:25 +02003862 trace_lock_release(lock, ip);
Peter Zijlstrae0f56fd2015-06-11 14:46:52 +02003863 if (__lock_release(lock, nested, ip))
3864 check_chain_key(current);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003865 current->lockdep_recursion = 0;
3866 raw_local_irq_restore(flags);
3867}
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003868EXPORT_SYMBOL_GPL(lock_release);
3869
Matthew Wilcox08f36ff2018-01-17 07:14:13 -08003870int lock_is_held_type(const struct lockdep_map *lock, int read)
Peter Zijlstraf607c662009-07-20 19:16:29 +02003871{
3872 unsigned long flags;
3873 int ret = 0;
3874
3875 if (unlikely(current->lockdep_recursion))
Peter Zijlstraf2513cd2011-06-06 12:32:43 +02003876 return 1; /* avoid false negative lockdep_assert_held() */
Peter Zijlstraf607c662009-07-20 19:16:29 +02003877
3878 raw_local_irq_save(flags);
3879 check_flags(flags);
3880
3881 current->lockdep_recursion = 1;
Peter Zijlstraf8319482016-11-30 14:32:25 +11003882 ret = __lock_is_held(lock, read);
Peter Zijlstraf607c662009-07-20 19:16:29 +02003883 current->lockdep_recursion = 0;
3884 raw_local_irq_restore(flags);
3885
3886 return ret;
3887}
Peter Zijlstraf8319482016-11-30 14:32:25 +11003888EXPORT_SYMBOL_GPL(lock_is_held_type);
Peter Zijlstraf607c662009-07-20 19:16:29 +02003889
Peter Zijlstrae7904a22015-08-01 19:25:08 +02003890struct pin_cookie lock_pin_lock(struct lockdep_map *lock)
Peter Zijlstraa24fc602015-06-11 14:46:53 +02003891{
Peter Zijlstrae7904a22015-08-01 19:25:08 +02003892 struct pin_cookie cookie = NIL_COOKIE;
Peter Zijlstraa24fc602015-06-11 14:46:53 +02003893 unsigned long flags;
3894
3895 if (unlikely(current->lockdep_recursion))
Peter Zijlstrae7904a22015-08-01 19:25:08 +02003896 return cookie;
Peter Zijlstraa24fc602015-06-11 14:46:53 +02003897
3898 raw_local_irq_save(flags);
3899 check_flags(flags);
3900
3901 current->lockdep_recursion = 1;
Peter Zijlstrae7904a22015-08-01 19:25:08 +02003902 cookie = __lock_pin_lock(lock);
Peter Zijlstraa24fc602015-06-11 14:46:53 +02003903 current->lockdep_recursion = 0;
3904 raw_local_irq_restore(flags);
Peter Zijlstrae7904a22015-08-01 19:25:08 +02003905
3906 return cookie;
Peter Zijlstraa24fc602015-06-11 14:46:53 +02003907}
3908EXPORT_SYMBOL_GPL(lock_pin_lock);
3909
Peter Zijlstrae7904a22015-08-01 19:25:08 +02003910void lock_repin_lock(struct lockdep_map *lock, struct pin_cookie cookie)
Peter Zijlstraa24fc602015-06-11 14:46:53 +02003911{
3912 unsigned long flags;
3913
3914 if (unlikely(current->lockdep_recursion))
3915 return;
3916
3917 raw_local_irq_save(flags);
3918 check_flags(flags);
3919
3920 current->lockdep_recursion = 1;
Peter Zijlstrae7904a22015-08-01 19:25:08 +02003921 __lock_repin_lock(lock, cookie);
3922 current->lockdep_recursion = 0;
3923 raw_local_irq_restore(flags);
3924}
3925EXPORT_SYMBOL_GPL(lock_repin_lock);
3926
3927void lock_unpin_lock(struct lockdep_map *lock, struct pin_cookie cookie)
3928{
3929 unsigned long flags;
3930
3931 if (unlikely(current->lockdep_recursion))
3932 return;
3933
3934 raw_local_irq_save(flags);
3935 check_flags(flags);
3936
3937 current->lockdep_recursion = 1;
3938 __lock_unpin_lock(lock, cookie);
Peter Zijlstraa24fc602015-06-11 14:46:53 +02003939 current->lockdep_recursion = 0;
3940 raw_local_irq_restore(flags);
3941}
3942EXPORT_SYMBOL_GPL(lock_unpin_lock);
3943
Peter Zijlstraf20786f2007-07-19 01:48:56 -07003944#ifdef CONFIG_LOCK_STAT
3945static int
3946print_lock_contention_bug(struct task_struct *curr, struct lockdep_map *lock,
3947 unsigned long ip)
3948{
3949 if (!debug_locks_off())
3950 return 0;
3951 if (debug_locks_silent)
3952 return 0;
3953
Paul E. McKenney681fbec2017-05-04 15:44:38 -07003954 pr_warn("\n");
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08003955 pr_warn("=================================\n");
3956 pr_warn("WARNING: bad contention detected!\n");
Ben Hutchingsfbdc4b92011-10-28 04:36:55 +01003957 print_kernel_ident();
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08003958 pr_warn("---------------------------------\n");
Paul E. McKenney681fbec2017-05-04 15:44:38 -07003959 pr_warn("%s/%d is trying to contend lock (",
Pavel Emelyanovba25f9d2007-10-18 23:40:40 -07003960 curr->comm, task_pid_nr(curr));
Peter Zijlstraf20786f2007-07-19 01:48:56 -07003961 print_lockdep_cache(lock);
Paul E. McKenney681fbec2017-05-04 15:44:38 -07003962 pr_cont(") at:\n");
Peter Zijlstraf20786f2007-07-19 01:48:56 -07003963 print_ip_sym(ip);
Paul E. McKenney681fbec2017-05-04 15:44:38 -07003964 pr_warn("but there are no locks held!\n");
3965 pr_warn("\nother info that might help us debug this:\n");
Peter Zijlstraf20786f2007-07-19 01:48:56 -07003966 lockdep_print_held_locks(curr);
3967
Paul E. McKenney681fbec2017-05-04 15:44:38 -07003968 pr_warn("\nstack backtrace:\n");
Peter Zijlstraf20786f2007-07-19 01:48:56 -07003969 dump_stack();
3970
3971 return 0;
3972}
3973
3974static void
3975__lock_contended(struct lockdep_map *lock, unsigned long ip)
3976{
3977 struct task_struct *curr = current;
J. R. Okajima41c2c5b2017-02-03 01:38:15 +09003978 struct held_lock *hlock;
Peter Zijlstraf20786f2007-07-19 01:48:56 -07003979 struct lock_class_stats *stats;
3980 unsigned int depth;
Peter Zijlstrac7e78cf2008-10-16 23:17:09 +02003981 int i, contention_point, contending_point;
Peter Zijlstraf20786f2007-07-19 01:48:56 -07003982
3983 depth = curr->lockdep_depth;
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003984 /*
3985 * Whee, we contended on this lock, except it seems we're not
3986 * actually trying to acquire anything much at all..
3987 */
Peter Zijlstraf20786f2007-07-19 01:48:56 -07003988 if (DEBUG_LOCKS_WARN_ON(!depth))
3989 return;
3990
J. R. Okajima41c2c5b2017-02-03 01:38:15 +09003991 hlock = find_held_lock(curr, lock, depth, &i);
3992 if (!hlock) {
3993 print_lock_contention_bug(curr, lock, ip);
3994 return;
Peter Zijlstraf20786f2007-07-19 01:48:56 -07003995 }
Peter Zijlstraf20786f2007-07-19 01:48:56 -07003996
Peter Zijlstrabb97a912009-07-20 19:15:35 +02003997 if (hlock->instance != lock)
3998 return;
3999
Peter Zijlstra3365e7792009-10-09 10:12:41 +02004000 hlock->waittime_stamp = lockstat_clock();
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004001
Peter Zijlstrac7e78cf2008-10-16 23:17:09 +02004002 contention_point = lock_point(hlock_class(hlock)->contention_point, ip);
4003 contending_point = lock_point(hlock_class(hlock)->contending_point,
4004 lock->ip);
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004005
Dave Jonesf82b2172008-08-11 09:30:23 +02004006 stats = get_lock_stats(hlock_class(hlock));
Peter Zijlstrac7e78cf2008-10-16 23:17:09 +02004007 if (contention_point < LOCKSTAT_POINTS)
4008 stats->contention_point[contention_point]++;
4009 if (contending_point < LOCKSTAT_POINTS)
4010 stats->contending_point[contending_point]++;
Peter Zijlstra96645672007-07-19 01:49:00 -07004011 if (lock->cpu != smp_processor_id())
4012 stats->bounces[bounce_contended + !!hlock->read]++;
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004013}
4014
4015static void
Peter Zijlstrac7e78cf2008-10-16 23:17:09 +02004016__lock_acquired(struct lockdep_map *lock, unsigned long ip)
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004017{
4018 struct task_struct *curr = current;
J. R. Okajima41c2c5b2017-02-03 01:38:15 +09004019 struct held_lock *hlock;
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004020 struct lock_class_stats *stats;
4021 unsigned int depth;
Peter Zijlstra3365e7792009-10-09 10:12:41 +02004022 u64 now, waittime = 0;
Peter Zijlstra96645672007-07-19 01:49:00 -07004023 int i, cpu;
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004024
4025 depth = curr->lockdep_depth;
Peter Zijlstra0119fee2011-09-02 01:30:29 +02004026 /*
4027 * Yay, we acquired ownership of this lock we didn't try to
4028 * acquire, how the heck did that happen?
4029 */
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004030 if (DEBUG_LOCKS_WARN_ON(!depth))
4031 return;
4032
J. R. Okajima41c2c5b2017-02-03 01:38:15 +09004033 hlock = find_held_lock(curr, lock, depth, &i);
4034 if (!hlock) {
4035 print_lock_contention_bug(curr, lock, _RET_IP_);
4036 return;
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004037 }
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004038
Peter Zijlstrabb97a912009-07-20 19:15:35 +02004039 if (hlock->instance != lock)
4040 return;
4041
Peter Zijlstra96645672007-07-19 01:49:00 -07004042 cpu = smp_processor_id();
4043 if (hlock->waittime_stamp) {
Peter Zijlstra3365e7792009-10-09 10:12:41 +02004044 now = lockstat_clock();
Peter Zijlstra96645672007-07-19 01:49:00 -07004045 waittime = now - hlock->waittime_stamp;
4046 hlock->holdtime_stamp = now;
4047 }
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004048
Frederic Weisbecker883a2a32010-05-08 06:16:11 +02004049 trace_lock_acquired(lock, ip);
Frederic Weisbecker20625012009-04-06 01:49:33 +02004050
Dave Jonesf82b2172008-08-11 09:30:23 +02004051 stats = get_lock_stats(hlock_class(hlock));
Peter Zijlstra96645672007-07-19 01:49:00 -07004052 if (waittime) {
4053 if (hlock->read)
4054 lock_time_inc(&stats->read_waittime, waittime);
4055 else
4056 lock_time_inc(&stats->write_waittime, waittime);
4057 }
4058 if (lock->cpu != cpu)
4059 stats->bounces[bounce_acquired + !!hlock->read]++;
Peter Zijlstra96645672007-07-19 01:49:00 -07004060
4061 lock->cpu = cpu;
Peter Zijlstrac7e78cf2008-10-16 23:17:09 +02004062 lock->ip = ip;
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004063}
4064
4065void lock_contended(struct lockdep_map *lock, unsigned long ip)
4066{
4067 unsigned long flags;
4068
Waiman Long9506a742018-10-18 21:45:17 -04004069 if (unlikely(!lock_stat || !debug_locks))
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004070 return;
4071
4072 if (unlikely(current->lockdep_recursion))
4073 return;
4074
4075 raw_local_irq_save(flags);
4076 check_flags(flags);
4077 current->lockdep_recursion = 1;
Frederic Weisbeckerdb2c4c72010-02-02 23:34:40 +01004078 trace_lock_contended(lock, ip);
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004079 __lock_contended(lock, ip);
4080 current->lockdep_recursion = 0;
4081 raw_local_irq_restore(flags);
4082}
4083EXPORT_SYMBOL_GPL(lock_contended);
4084
Peter Zijlstrac7e78cf2008-10-16 23:17:09 +02004085void lock_acquired(struct lockdep_map *lock, unsigned long ip)
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004086{
4087 unsigned long flags;
4088
Waiman Long9506a742018-10-18 21:45:17 -04004089 if (unlikely(!lock_stat || !debug_locks))
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004090 return;
4091
4092 if (unlikely(current->lockdep_recursion))
4093 return;
4094
4095 raw_local_irq_save(flags);
4096 check_flags(flags);
4097 current->lockdep_recursion = 1;
Peter Zijlstrac7e78cf2008-10-16 23:17:09 +02004098 __lock_acquired(lock, ip);
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004099 current->lockdep_recursion = 0;
4100 raw_local_irq_restore(flags);
4101}
4102EXPORT_SYMBOL_GPL(lock_acquired);
4103#endif
4104
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004105/*
4106 * Used by the testsuite, sanitize the validator state
4107 * after a simulated failure:
4108 */
4109
4110void lockdep_reset(void)
4111{
4112 unsigned long flags;
Ingo Molnar23d95a02006-12-13 00:34:40 -08004113 int i;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004114
4115 raw_local_irq_save(flags);
4116 current->curr_chain_key = 0;
4117 current->lockdep_depth = 0;
4118 current->lockdep_recursion = 0;
4119 memset(current->held_locks, 0, MAX_LOCK_DEPTH*sizeof(struct held_lock));
4120 nr_hardirq_chains = 0;
4121 nr_softirq_chains = 0;
4122 nr_process_chains = 0;
4123 debug_locks = 1;
Ingo Molnar23d95a02006-12-13 00:34:40 -08004124 for (i = 0; i < CHAINHASH_SIZE; i++)
Andrew Mortona63f38c2016-02-03 13:44:12 -08004125 INIT_HLIST_HEAD(chainhash_table + i);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004126 raw_local_irq_restore(flags);
4127}
4128
4129static void zap_class(struct lock_class *class)
4130{
4131 int i;
4132
4133 /*
4134 * Remove all dependencies this lock is
4135 * involved in:
4136 */
4137 for (i = 0; i < nr_list_entries; i++) {
4138 if (list_entries[i].class == class)
4139 list_del_rcu(&list_entries[i].entry);
4140 }
4141 /*
4142 * Unhash the class and remove it from the all_lock_classes list:
4143 */
Andrew Mortona63f38c2016-02-03 13:44:12 -08004144 hlist_del_rcu(&class->hash_entry);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004145 list_del_rcu(&class->lock_entry);
4146
Peter Zijlstracee34d82015-06-02 12:50:13 +02004147 RCU_INIT_POINTER(class->key, NULL);
4148 RCU_INIT_POINTER(class->name, NULL);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004149}
4150
Arjan van de Venfabe8742008-01-24 07:00:45 +01004151static inline int within(const void *addr, void *start, unsigned long size)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004152{
4153 return addr >= start && addr < start + size;
4154}
4155
Peter Zijlstra35a93932015-02-26 16:23:11 +01004156/*
4157 * Used in module.c to remove lock classes from memory that is going to be
4158 * freed; and possibly re-used by other modules.
4159 *
4160 * We will have had one sync_sched() before getting here, so we're guaranteed
4161 * nobody will look up these exact classes -- they're properly dead but still
4162 * allocated.
4163 */
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004164void lockdep_free_key_range(void *start, unsigned long size)
4165{
Peter Zijlstra35a93932015-02-26 16:23:11 +01004166 struct lock_class *class;
Andrew Mortona63f38c2016-02-03 13:44:12 -08004167 struct hlist_head *head;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004168 unsigned long flags;
4169 int i;
Nick Piggin5a26db52008-01-16 09:51:58 +01004170 int locked;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004171
4172 raw_local_irq_save(flags);
Nick Piggin5a26db52008-01-16 09:51:58 +01004173 locked = graph_lock();
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004174
4175 /*
4176 * Unhash all classes that were created by this module:
4177 */
4178 for (i = 0; i < CLASSHASH_SIZE; i++) {
4179 head = classhash_table + i;
Andrew Mortona63f38c2016-02-03 13:44:12 -08004180 hlist_for_each_entry_rcu(class, head, hash_entry) {
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004181 if (within(class->key, start, size))
4182 zap_class(class);
Arjan van de Venfabe8742008-01-24 07:00:45 +01004183 else if (within(class->name, start, size))
4184 zap_class(class);
4185 }
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004186 }
4187
Nick Piggin5a26db52008-01-16 09:51:58 +01004188 if (locked)
4189 graph_unlock();
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004190 raw_local_irq_restore(flags);
Peter Zijlstra35a93932015-02-26 16:23:11 +01004191
4192 /*
4193 * Wait for any possible iterators from look_up_lock_class() to pass
4194 * before continuing to free the memory they refer to.
4195 *
4196 * sync_sched() is sufficient because the read-side is IRQ disable.
4197 */
Paul E. McKenney51959d82018-11-06 19:06:51 -08004198 synchronize_rcu();
Peter Zijlstra35a93932015-02-26 16:23:11 +01004199
4200 /*
4201 * XXX at this point we could return the resources to the pool;
4202 * instead we leak them. We would need to change to bitmap allocators
4203 * instead of the linear allocators we have now.
4204 */
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004205}
4206
4207void lockdep_reset_lock(struct lockdep_map *lock)
4208{
Peter Zijlstra35a93932015-02-26 16:23:11 +01004209 struct lock_class *class;
Andrew Mortona63f38c2016-02-03 13:44:12 -08004210 struct hlist_head *head;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004211 unsigned long flags;
4212 int i, j;
Nick Piggin5a26db52008-01-16 09:51:58 +01004213 int locked;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004214
4215 raw_local_irq_save(flags);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004216
4217 /*
Ingo Molnard6d897c2006-07-10 04:44:04 -07004218 * Remove all classes this lock might have:
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004219 */
Ingo Molnard6d897c2006-07-10 04:44:04 -07004220 for (j = 0; j < MAX_LOCKDEP_SUBCLASSES; j++) {
4221 /*
4222 * If the class exists we look it up and zap it:
4223 */
4224 class = look_up_lock_class(lock, j);
Matthew Wilcox64f29d12018-01-17 07:14:12 -08004225 if (class)
Ingo Molnard6d897c2006-07-10 04:44:04 -07004226 zap_class(class);
4227 }
4228 /*
4229 * Debug check: in the end all mapped classes should
4230 * be gone.
4231 */
Nick Piggin5a26db52008-01-16 09:51:58 +01004232 locked = graph_lock();
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004233 for (i = 0; i < CLASSHASH_SIZE; i++) {
4234 head = classhash_table + i;
Andrew Mortona63f38c2016-02-03 13:44:12 -08004235 hlist_for_each_entry_rcu(class, head, hash_entry) {
Hitoshi Mitake62016252010-10-05 18:01:51 +09004236 int match = 0;
4237
4238 for (j = 0; j < NR_LOCKDEP_CACHING_CLASSES; j++)
4239 match |= class == lock->class_cache[j];
4240
4241 if (unlikely(match)) {
Peter Zijlstra0119fee2011-09-02 01:30:29 +02004242 if (debug_locks_off_graph_unlock()) {
4243 /*
4244 * We all just reset everything, how did it match?
4245 */
Ingo Molnar74c383f2006-12-13 00:34:43 -08004246 WARN_ON(1);
Peter Zijlstra0119fee2011-09-02 01:30:29 +02004247 }
Ingo Molnard6d897c2006-07-10 04:44:04 -07004248 goto out_restore;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004249 }
4250 }
4251 }
Nick Piggin5a26db52008-01-16 09:51:58 +01004252 if (locked)
4253 graph_unlock();
Ingo Molnard6d897c2006-07-10 04:44:04 -07004254
4255out_restore:
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004256 raw_local_irq_restore(flags);
4257}
4258
Joel Fernandes (Google)c3bc8fd2018-07-30 15:24:23 -07004259void __init lockdep_init(void)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004260{
4261 printk("Lock dependency validator: Copyright (c) 2006 Red Hat, Inc., Ingo Molnar\n");
4262
Li Zefanb0788ca2008-11-21 15:57:32 +08004263 printk("... MAX_LOCKDEP_SUBCLASSES: %lu\n", MAX_LOCKDEP_SUBCLASSES);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004264 printk("... MAX_LOCK_DEPTH: %lu\n", MAX_LOCK_DEPTH);
4265 printk("... MAX_LOCKDEP_KEYS: %lu\n", MAX_LOCKDEP_KEYS);
Li Zefanb0788ca2008-11-21 15:57:32 +08004266 printk("... CLASSHASH_SIZE: %lu\n", CLASSHASH_SIZE);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004267 printk("... MAX_LOCKDEP_ENTRIES: %lu\n", MAX_LOCKDEP_ENTRIES);
4268 printk("... MAX_LOCKDEP_CHAINS: %lu\n", MAX_LOCKDEP_CHAINS);
4269 printk("... CHAINHASH_SIZE: %lu\n", CHAINHASH_SIZE);
4270
4271 printk(" memory used by lock dependency info: %lu kB\n",
4272 (sizeof(struct lock_class) * MAX_LOCKDEP_KEYS +
4273 sizeof(struct list_head) * CLASSHASH_SIZE +
4274 sizeof(struct lock_list) * MAX_LOCKDEP_ENTRIES +
4275 sizeof(struct lock_chain) * MAX_LOCKDEP_CHAINS +
Ming Lei906292092009-08-02 21:43:36 +08004276 sizeof(struct list_head) * CHAINHASH_SIZE
Ming Lei4dd861d2009-07-16 15:44:29 +02004277#ifdef CONFIG_PROVE_LOCKING
Ming Leie351b662009-07-22 22:48:09 +08004278 + sizeof(struct circular_queue)
Ming Lei4dd861d2009-07-16 15:44:29 +02004279#endif
Ming Lei906292092009-08-02 21:43:36 +08004280 ) / 1024
Ming Lei4dd861d2009-07-16 15:44:29 +02004281 );
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004282
4283 printk(" per task-struct memory footprint: %lu bytes\n",
4284 sizeof(struct held_lock) * MAX_LOCK_DEPTH);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004285}
4286
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004287static void
4288print_freed_lock_bug(struct task_struct *curr, const void *mem_from,
Arjan van de Ven55794a42006-07-10 04:44:03 -07004289 const void *mem_to, struct held_lock *hlock)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004290{
4291 if (!debug_locks_off())
4292 return;
4293 if (debug_locks_silent)
4294 return;
4295
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004296 pr_warn("\n");
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08004297 pr_warn("=========================\n");
4298 pr_warn("WARNING: held lock freed!\n");
Ben Hutchingsfbdc4b92011-10-28 04:36:55 +01004299 print_kernel_ident();
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08004300 pr_warn("-------------------------\n");
Borislav Petkov04860d42018-02-26 14:49:26 +01004301 pr_warn("%s/%d is freeing memory %px-%px, with a lock still held there!\n",
Pavel Emelyanovba25f9d2007-10-18 23:40:40 -07004302 curr->comm, task_pid_nr(curr), mem_from, mem_to-1);
Arjan van de Ven55794a42006-07-10 04:44:03 -07004303 print_lock(hlock);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004304 lockdep_print_held_locks(curr);
4305
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004306 pr_warn("\nstack backtrace:\n");
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004307 dump_stack();
4308}
4309
Oleg Nesterov54561782007-12-05 15:46:09 +01004310static inline int not_in_range(const void* mem_from, unsigned long mem_len,
4311 const void* lock_from, unsigned long lock_len)
4312{
4313 return lock_from + lock_len <= mem_from ||
4314 mem_from + mem_len <= lock_from;
4315}
4316
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004317/*
4318 * Called when kernel memory is freed (or unmapped), or if a lock
4319 * is destroyed or reinitialized - this code checks whether there is
4320 * any held lock in the memory range of <from> to <to>:
4321 */
4322void debug_check_no_locks_freed(const void *mem_from, unsigned long mem_len)
4323{
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004324 struct task_struct *curr = current;
4325 struct held_lock *hlock;
4326 unsigned long flags;
4327 int i;
4328
4329 if (unlikely(!debug_locks))
4330 return;
4331
Steven Rostedt (VMware)fcc784b2018-04-04 14:06:30 -04004332 raw_local_irq_save(flags);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004333 for (i = 0; i < curr->lockdep_depth; i++) {
4334 hlock = curr->held_locks + i;
4335
Oleg Nesterov54561782007-12-05 15:46:09 +01004336 if (not_in_range(mem_from, mem_len, hlock->instance,
4337 sizeof(*hlock->instance)))
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004338 continue;
4339
Oleg Nesterov54561782007-12-05 15:46:09 +01004340 print_freed_lock_bug(curr, mem_from, mem_from + mem_len, hlock);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004341 break;
4342 }
Steven Rostedt (VMware)fcc784b2018-04-04 14:06:30 -04004343 raw_local_irq_restore(flags);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004344}
Peter Zijlstraed075362006-12-06 20:35:24 -08004345EXPORT_SYMBOL_GPL(debug_check_no_locks_freed);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004346
Colin Cross1b1d2fb2013-05-06 23:50:08 +00004347static void print_held_locks_bug(void)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004348{
4349 if (!debug_locks_off())
4350 return;
4351 if (debug_locks_silent)
4352 return;
4353
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004354 pr_warn("\n");
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08004355 pr_warn("====================================\n");
4356 pr_warn("WARNING: %s/%d still has locks held!\n",
Colin Cross1b1d2fb2013-05-06 23:50:08 +00004357 current->comm, task_pid_nr(current));
Ben Hutchingsfbdc4b92011-10-28 04:36:55 +01004358 print_kernel_ident();
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08004359 pr_warn("------------------------------------\n");
Colin Cross1b1d2fb2013-05-06 23:50:08 +00004360 lockdep_print_held_locks(current);
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004361 pr_warn("\nstack backtrace:\n");
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004362 dump_stack();
4363}
4364
Colin Cross1b1d2fb2013-05-06 23:50:08 +00004365void debug_check_no_locks_held(void)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004366{
Colin Cross1b1d2fb2013-05-06 23:50:08 +00004367 if (unlikely(current->lockdep_depth > 0))
4368 print_held_locks_bug();
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004369}
Colin Cross1b1d2fb2013-05-06 23:50:08 +00004370EXPORT_SYMBOL_GPL(debug_check_no_locks_held);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004371
Sasha Levin8dce7a92013-06-13 18:41:16 -04004372#ifdef __KERNEL__
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004373void debug_show_all_locks(void)
4374{
4375 struct task_struct *g, *p;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004376
Jarek Poplawski9c35dd72007-03-22 00:11:28 -08004377 if (unlikely(!debug_locks)) {
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004378 pr_warn("INFO: lockdep is turned off.\n");
Jarek Poplawski9c35dd72007-03-22 00:11:28 -08004379 return;
4380 }
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004381 pr_warn("\nShowing all locks held in the system:\n");
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004382
Tetsuo Handa0f736a52018-04-06 19:41:18 +09004383 rcu_read_lock();
4384 for_each_process_thread(g, p) {
Tetsuo Handa0f736a52018-04-06 19:41:18 +09004385 if (!p->lockdep_depth)
4386 continue;
4387 lockdep_print_held_locks(p);
Tejun Heo88f1c872018-01-22 14:00:55 -08004388 touch_nmi_watchdog();
Tetsuo Handa0f736a52018-04-06 19:41:18 +09004389 touch_all_softlockup_watchdogs();
4390 }
4391 rcu_read_unlock();
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004392
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004393 pr_warn("\n");
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08004394 pr_warn("=============================================\n\n");
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004395}
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004396EXPORT_SYMBOL_GPL(debug_show_all_locks);
Sasha Levin8dce7a92013-06-13 18:41:16 -04004397#endif
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004398
Ingo Molnar82a1fcb2008-01-25 21:08:02 +01004399/*
4400 * Careful: only use this function if you are sure that
4401 * the task cannot run in parallel!
4402 */
John Kacurf1b499f2010-08-05 17:10:53 +02004403void debug_show_held_locks(struct task_struct *task)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004404{
Jarek Poplawski9c35dd72007-03-22 00:11:28 -08004405 if (unlikely(!debug_locks)) {
4406 printk("INFO: lockdep is turned off.\n");
4407 return;
4408 }
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004409 lockdep_print_held_locks(task);
4410}
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004411EXPORT_SYMBOL_GPL(debug_show_held_locks);
Peter Zijlstrab351d162007-10-11 22:11:12 +02004412
Andi Kleen722a9f92014-05-02 00:44:38 +02004413asmlinkage __visible void lockdep_sys_exit(void)
Peter Zijlstrab351d162007-10-11 22:11:12 +02004414{
4415 struct task_struct *curr = current;
4416
4417 if (unlikely(curr->lockdep_depth)) {
4418 if (!debug_locks_off())
4419 return;
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004420 pr_warn("\n");
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08004421 pr_warn("================================================\n");
4422 pr_warn("WARNING: lock held when returning to user space!\n");
Ben Hutchingsfbdc4b92011-10-28 04:36:55 +01004423 print_kernel_ident();
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08004424 pr_warn("------------------------------------------------\n");
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004425 pr_warn("%s/%d is leaving the kernel with locks still held!\n",
Peter Zijlstrab351d162007-10-11 22:11:12 +02004426 curr->comm, curr->pid);
4427 lockdep_print_held_locks(curr);
4428 }
Byungchul Parkb09be672017-08-07 16:12:52 +09004429
4430 /*
4431 * The lock history for each syscall should be independent. So wipe the
4432 * slate clean on return to userspace.
4433 */
Peter Zijlstraf52be572017-08-29 10:59:39 +02004434 lockdep_invariant_state(false);
Peter Zijlstrab351d162007-10-11 22:11:12 +02004435}
Paul E. McKenney0632eb32010-02-22 17:04:47 -08004436
Paul E. McKenneyb3fbab02011-05-24 08:31:09 -07004437void lockdep_rcu_suspicious(const char *file, const int line, const char *s)
Paul E. McKenney0632eb32010-02-22 17:04:47 -08004438{
4439 struct task_struct *curr = current;
4440
Lai Jiangshan2b3fc352010-04-20 16:23:07 +08004441 /* Note: the following can be executed concurrently, so be careful. */
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004442 pr_warn("\n");
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08004443 pr_warn("=============================\n");
4444 pr_warn("WARNING: suspicious RCU usage\n");
Ben Hutchingsfbdc4b92011-10-28 04:36:55 +01004445 print_kernel_ident();
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08004446 pr_warn("-----------------------------\n");
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004447 pr_warn("%s:%d %s!\n", file, line, s);
4448 pr_warn("\nother info that might help us debug this:\n\n");
4449 pr_warn("\n%srcu_scheduler_active = %d, debug_locks = %d\n",
Paul E. McKenneyc5fdcec2012-01-30 08:46:32 -08004450 !rcu_lockdep_current_cpu_online()
4451 ? "RCU used illegally from offline CPU!\n"
Paul E. McKenney5c173eb2013-09-13 17:20:11 -07004452 : !rcu_is_watching()
Paul E. McKenneyc5fdcec2012-01-30 08:46:32 -08004453 ? "RCU used illegally from idle CPU!\n"
4454 : "",
4455 rcu_scheduler_active, debug_locks);
Frederic Weisbecker0464e932011-10-07 18:22:01 +02004456
4457 /*
4458 * If a CPU is in the RCU-free window in idle (ie: in the section
4459 * between rcu_idle_enter() and rcu_idle_exit(), then RCU
4460 * considers that CPU to be in an "extended quiescent state",
4461 * which means that RCU will be completely ignoring that CPU.
4462 * Therefore, rcu_read_lock() and friends have absolutely no
4463 * effect on a CPU running in that state. In other words, even if
4464 * such an RCU-idle CPU has called rcu_read_lock(), RCU might well
4465 * delete data structures out from under it. RCU really has no
4466 * choice here: we need to keep an RCU-free window in idle where
4467 * the CPU may possibly enter into low power mode. This way we can
4468 * notice an extended quiescent state to other CPUs that started a grace
4469 * period. Otherwise we would delay any grace period as long as we run
4470 * in the idle task.
4471 *
4472 * So complain bitterly if someone does call rcu_read_lock(),
4473 * rcu_read_lock_bh() and so on from extended quiescent states.
4474 */
Paul E. McKenney5c173eb2013-09-13 17:20:11 -07004475 if (!rcu_is_watching())
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004476 pr_warn("RCU used illegally from extended quiescent state!\n");
Frederic Weisbecker0464e932011-10-07 18:22:01 +02004477
Paul E. McKenney0632eb32010-02-22 17:04:47 -08004478 lockdep_print_held_locks(curr);
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004479 pr_warn("\nstack backtrace:\n");
Paul E. McKenney0632eb32010-02-22 17:04:47 -08004480 dump_stack();
4481}
Paul E. McKenneyb3fbab02011-05-24 08:31:09 -07004482EXPORT_SYMBOL_GPL(lockdep_rcu_suspicious);