blob: edcac5de7ebcdb489113800c941274d8887f9b56 [file] [log] [blame]
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07001/*
2 * kernel/lockdep.c
3 *
4 * Runtime locking correctness validator
5 *
6 * Started by Ingo Molnar:
7 *
Peter Zijlstra4b32d0a2007-07-19 01:48:59 -07008 * Copyright (C) 2006,2007 Red Hat, Inc., Ingo Molnar <mingo@redhat.com>
Peter Zijlstra90eec102015-11-16 11:08:45 +01009 * Copyright (C) 2007 Red Hat, Inc., Peter Zijlstra
Ingo Molnarfbb9ce952006-07-03 00:24:50 -070010 *
11 * this code maps all the lock dependencies as they occur in a live kernel
12 * and will warn about the following classes of locking bugs:
13 *
14 * - lock inversion scenarios
15 * - circular lock dependencies
16 * - hardirq/softirq safe/unsafe locking bugs
17 *
18 * Bugs are reported even if the current locking scenario does not cause
19 * any deadlock at this point.
20 *
21 * I.e. if anytime in the past two locks were taken in a different order,
22 * even if it happened for another task, even if those were different
23 * locks (but of the same class as this lock), this code will detect it.
24 *
25 * Thanks to Arjan van de Ven for coming up with the initial idea of
26 * mapping lock dependencies runtime.
27 */
Steven Rostedta5e25882008-12-02 15:34:05 -050028#define DISABLE_BRANCH_PROFILING
Ingo Molnarfbb9ce952006-07-03 00:24:50 -070029#include <linux/mutex.h>
30#include <linux/sched.h>
Ingo Molnare6017572017-02-01 16:36:40 +010031#include <linux/sched/clock.h>
Ingo Molnar29930022017-02-08 18:51:36 +010032#include <linux/sched/task.h>
Nikolay Borisov6d7225f2017-05-03 14:53:05 -070033#include <linux/sched/mm.h>
Ingo Molnarfbb9ce952006-07-03 00:24:50 -070034#include <linux/delay.h>
35#include <linux/module.h>
36#include <linux/proc_fs.h>
37#include <linux/seq_file.h>
38#include <linux/spinlock.h>
39#include <linux/kallsyms.h>
40#include <linux/interrupt.h>
41#include <linux/stacktrace.h>
42#include <linux/debug_locks.h>
43#include <linux/irqflags.h>
Dave Jones99de0552006-09-29 02:00:10 -070044#include <linux/utsname.h>
Peter Zijlstra4b32d0a2007-07-19 01:48:59 -070045#include <linux/hash.h>
Steven Rostedt81d68a92008-05-12 21:20:42 +020046#include <linux/ftrace.h>
Peter Zijlstrab4b136f2009-01-29 14:50:36 +010047#include <linux/stringify.h>
Ming Leid588e462009-07-16 15:44:29 +020048#include <linux/bitops.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090049#include <linux/gfp.h>
Peter Zijlstrae7904a22015-08-01 19:25:08 +020050#include <linux/random.h>
Peter Zijlstradfaaf3f2016-05-30 18:31:33 +020051#include <linux/jhash.h>
Tejun Heo88f1c872018-01-22 14:00:55 -080052#include <linux/nmi.h>
Peter Zijlstraaf012962009-07-16 15:44:29 +020053
Ingo Molnarfbb9ce952006-07-03 00:24:50 -070054#include <asm/sections.h>
55
56#include "lockdep_internals.h"
57
Steven Rostedta8d154b2009-04-10 09:36:00 -040058#define CREATE_TRACE_POINTS
Frederic Weisbecker67178762009-11-13 10:06:34 +010059#include <trace/events/lock.h>
Steven Rostedta8d154b2009-04-10 09:36:00 -040060
Peter Zijlstraf20786f2007-07-19 01:48:56 -070061#ifdef CONFIG_PROVE_LOCKING
62int prove_locking = 1;
63module_param(prove_locking, int, 0644);
64#else
65#define prove_locking 0
66#endif
67
68#ifdef CONFIG_LOCK_STAT
69int lock_stat = 1;
70module_param(lock_stat, int, 0644);
71#else
72#define lock_stat 0
73#endif
74
Ingo Molnarfbb9ce952006-07-03 00:24:50 -070075/*
Ingo Molnar74c383f2006-12-13 00:34:43 -080076 * lockdep_lock: protects the lockdep graph, the hashes and the
77 * class/list/hash allocators.
Ingo Molnarfbb9ce952006-07-03 00:24:50 -070078 *
79 * This is one of the rare exceptions where it's justified
80 * to use a raw spinlock - we really dont want the spinlock
Ingo Molnar74c383f2006-12-13 00:34:43 -080081 * code to recurse back into the lockdep code...
Ingo Molnarfbb9ce952006-07-03 00:24:50 -070082 */
Thomas Gleixneredc35bd2009-12-03 12:38:57 +010083static arch_spinlock_t lockdep_lock = (arch_spinlock_t)__ARCH_SPIN_LOCK_UNLOCKED;
Ingo Molnar74c383f2006-12-13 00:34:43 -080084
85static int graph_lock(void)
86{
Thomas Gleixner0199c4e2009-12-02 20:01:25 +010087 arch_spin_lock(&lockdep_lock);
Ingo Molnar74c383f2006-12-13 00:34:43 -080088 /*
89 * Make sure that if another CPU detected a bug while
90 * walking the graph we dont change it (while the other
91 * CPU is busy printing out stuff with the graph lock
92 * dropped already)
93 */
94 if (!debug_locks) {
Thomas Gleixner0199c4e2009-12-02 20:01:25 +010095 arch_spin_unlock(&lockdep_lock);
Ingo Molnar74c383f2006-12-13 00:34:43 -080096 return 0;
97 }
Steven Rostedtbb065af2008-05-12 21:21:00 +020098 /* prevent any recursions within lockdep from causing deadlocks */
99 current->lockdep_recursion++;
Ingo Molnar74c383f2006-12-13 00:34:43 -0800100 return 1;
101}
102
103static inline int graph_unlock(void)
104{
Peter Zijlstra0119fee2011-09-02 01:30:29 +0200105 if (debug_locks && !arch_spin_is_locked(&lockdep_lock)) {
106 /*
107 * The lockdep graph lock isn't locked while we expect it to
108 * be, we're confused now, bye!
109 */
Jarek Poplawski381a2292007-02-10 01:44:58 -0800110 return DEBUG_LOCKS_WARN_ON(1);
Peter Zijlstra0119fee2011-09-02 01:30:29 +0200111 }
Jarek Poplawski381a2292007-02-10 01:44:58 -0800112
Steven Rostedtbb065af2008-05-12 21:21:00 +0200113 current->lockdep_recursion--;
Thomas Gleixner0199c4e2009-12-02 20:01:25 +0100114 arch_spin_unlock(&lockdep_lock);
Ingo Molnar74c383f2006-12-13 00:34:43 -0800115 return 0;
116}
117
118/*
119 * Turn lock debugging off and return with 0 if it was off already,
120 * and also release the graph lock:
121 */
122static inline int debug_locks_off_graph_unlock(void)
123{
124 int ret = debug_locks_off();
125
Thomas Gleixner0199c4e2009-12-02 20:01:25 +0100126 arch_spin_unlock(&lockdep_lock);
Ingo Molnar74c383f2006-12-13 00:34:43 -0800127
128 return ret;
129}
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700130
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700131unsigned long nr_list_entries;
Peter Zijlstraaf012962009-07-16 15:44:29 +0200132static struct lock_list list_entries[MAX_LOCKDEP_ENTRIES];
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700133
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700134/*
135 * All data structures here are protected by the global debug_lock.
136 *
137 * Mutex key structs only get allocated, once during bootup, and never
138 * get freed - this significantly simplifies the debugging code.
139 */
140unsigned long nr_lock_classes;
141static struct lock_class lock_classes[MAX_LOCKDEP_KEYS];
142
Dave Jonesf82b2172008-08-11 09:30:23 +0200143static inline struct lock_class *hlock_class(struct held_lock *hlock)
144{
145 if (!hlock->class_idx) {
Peter Zijlstra0119fee2011-09-02 01:30:29 +0200146 /*
147 * Someone passed in garbage, we give up.
148 */
Dave Jonesf82b2172008-08-11 09:30:23 +0200149 DEBUG_LOCKS_WARN_ON(1);
150 return NULL;
151 }
152 return lock_classes + hlock->class_idx - 1;
153}
154
Peter Zijlstraf20786f2007-07-19 01:48:56 -0700155#ifdef CONFIG_LOCK_STAT
Peter Zijlstra25528212016-03-15 14:52:49 -0700156static DEFINE_PER_CPU(struct lock_class_stats[MAX_LOCKDEP_KEYS], cpu_lock_stats);
Peter Zijlstraf20786f2007-07-19 01:48:56 -0700157
Peter Zijlstra3365e7792009-10-09 10:12:41 +0200158static inline u64 lockstat_clock(void)
159{
Peter Zijlstrac6763292010-05-25 10:48:51 +0200160 return local_clock();
Peter Zijlstra3365e7792009-10-09 10:12:41 +0200161}
162
Peter Zijlstrac7e78cf2008-10-16 23:17:09 +0200163static int lock_point(unsigned long points[], unsigned long ip)
Peter Zijlstraf20786f2007-07-19 01:48:56 -0700164{
165 int i;
166
Peter Zijlstrac7e78cf2008-10-16 23:17:09 +0200167 for (i = 0; i < LOCKSTAT_POINTS; i++) {
168 if (points[i] == 0) {
169 points[i] = ip;
Peter Zijlstraf20786f2007-07-19 01:48:56 -0700170 break;
171 }
Peter Zijlstrac7e78cf2008-10-16 23:17:09 +0200172 if (points[i] == ip)
Peter Zijlstraf20786f2007-07-19 01:48:56 -0700173 break;
174 }
175
176 return i;
177}
178
Peter Zijlstra3365e7792009-10-09 10:12:41 +0200179static void lock_time_inc(struct lock_time *lt, u64 time)
Peter Zijlstraf20786f2007-07-19 01:48:56 -0700180{
181 if (time > lt->max)
182 lt->max = time;
183
Frank Rowand109d71c2009-11-19 13:42:06 -0800184 if (time < lt->min || !lt->nr)
Peter Zijlstraf20786f2007-07-19 01:48:56 -0700185 lt->min = time;
186
187 lt->total += time;
188 lt->nr++;
189}
190
Peter Zijlstrac46261d2007-07-19 01:48:57 -0700191static inline void lock_time_add(struct lock_time *src, struct lock_time *dst)
192{
Frank Rowand109d71c2009-11-19 13:42:06 -0800193 if (!src->nr)
194 return;
195
196 if (src->max > dst->max)
197 dst->max = src->max;
198
199 if (src->min < dst->min || !dst->nr)
200 dst->min = src->min;
201
Peter Zijlstrac46261d2007-07-19 01:48:57 -0700202 dst->total += src->total;
203 dst->nr += src->nr;
204}
205
206struct lock_class_stats lock_stats(struct lock_class *class)
207{
208 struct lock_class_stats stats;
209 int cpu, i;
210
211 memset(&stats, 0, sizeof(struct lock_class_stats));
212 for_each_possible_cpu(cpu) {
213 struct lock_class_stats *pcs =
Tejun Heo1871e522009-10-29 22:34:13 +0900214 &per_cpu(cpu_lock_stats, cpu)[class - lock_classes];
Peter Zijlstrac46261d2007-07-19 01:48:57 -0700215
216 for (i = 0; i < ARRAY_SIZE(stats.contention_point); i++)
217 stats.contention_point[i] += pcs->contention_point[i];
218
Peter Zijlstrac7e78cf2008-10-16 23:17:09 +0200219 for (i = 0; i < ARRAY_SIZE(stats.contending_point); i++)
220 stats.contending_point[i] += pcs->contending_point[i];
221
Peter Zijlstrac46261d2007-07-19 01:48:57 -0700222 lock_time_add(&pcs->read_waittime, &stats.read_waittime);
223 lock_time_add(&pcs->write_waittime, &stats.write_waittime);
224
225 lock_time_add(&pcs->read_holdtime, &stats.read_holdtime);
226 lock_time_add(&pcs->write_holdtime, &stats.write_holdtime);
Peter Zijlstra96645672007-07-19 01:49:00 -0700227
228 for (i = 0; i < ARRAY_SIZE(stats.bounces); i++)
229 stats.bounces[i] += pcs->bounces[i];
Peter Zijlstrac46261d2007-07-19 01:48:57 -0700230 }
231
232 return stats;
233}
234
235void clear_lock_stats(struct lock_class *class)
236{
237 int cpu;
238
239 for_each_possible_cpu(cpu) {
240 struct lock_class_stats *cpu_stats =
Tejun Heo1871e522009-10-29 22:34:13 +0900241 &per_cpu(cpu_lock_stats, cpu)[class - lock_classes];
Peter Zijlstrac46261d2007-07-19 01:48:57 -0700242
243 memset(cpu_stats, 0, sizeof(struct lock_class_stats));
244 }
245 memset(class->contention_point, 0, sizeof(class->contention_point));
Peter Zijlstrac7e78cf2008-10-16 23:17:09 +0200246 memset(class->contending_point, 0, sizeof(class->contending_point));
Peter Zijlstrac46261d2007-07-19 01:48:57 -0700247}
248
Peter Zijlstraf20786f2007-07-19 01:48:56 -0700249static struct lock_class_stats *get_lock_stats(struct lock_class *class)
250{
Tejun Heo1871e522009-10-29 22:34:13 +0900251 return &get_cpu_var(cpu_lock_stats)[class - lock_classes];
Peter Zijlstraf20786f2007-07-19 01:48:56 -0700252}
253
254static void put_lock_stats(struct lock_class_stats *stats)
255{
Tejun Heo1871e522009-10-29 22:34:13 +0900256 put_cpu_var(cpu_lock_stats);
Peter Zijlstraf20786f2007-07-19 01:48:56 -0700257}
258
259static void lock_release_holdtime(struct held_lock *hlock)
260{
261 struct lock_class_stats *stats;
Peter Zijlstra3365e7792009-10-09 10:12:41 +0200262 u64 holdtime;
Peter Zijlstraf20786f2007-07-19 01:48:56 -0700263
264 if (!lock_stat)
265 return;
266
Peter Zijlstra3365e7792009-10-09 10:12:41 +0200267 holdtime = lockstat_clock() - hlock->holdtime_stamp;
Peter Zijlstraf20786f2007-07-19 01:48:56 -0700268
Dave Jonesf82b2172008-08-11 09:30:23 +0200269 stats = get_lock_stats(hlock_class(hlock));
Peter Zijlstraf20786f2007-07-19 01:48:56 -0700270 if (hlock->read)
271 lock_time_inc(&stats->read_holdtime, holdtime);
272 else
273 lock_time_inc(&stats->write_holdtime, holdtime);
274 put_lock_stats(stats);
275}
276#else
277static inline void lock_release_holdtime(struct held_lock *hlock)
278{
279}
280#endif
281
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700282/*
283 * We keep a global list of all lock classes. The list only grows,
284 * never shrinks. The list is only accessed with the lockdep
285 * spinlock lock held.
286 */
287LIST_HEAD(all_lock_classes);
288
289/*
290 * The lockdep classes are in a hash-table as well, for fast lookup:
291 */
292#define CLASSHASH_BITS (MAX_LOCKDEP_KEYS_BITS - 1)
293#define CLASSHASH_SIZE (1UL << CLASSHASH_BITS)
Peter Zijlstra4b32d0a2007-07-19 01:48:59 -0700294#define __classhashfn(key) hash_long((unsigned long)key, CLASSHASH_BITS)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700295#define classhashentry(key) (classhash_table + __classhashfn((key)))
296
Andrew Mortona63f38c2016-02-03 13:44:12 -0800297static struct hlist_head classhash_table[CLASSHASH_SIZE];
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700298
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700299/*
300 * We put the lock dependency chains into a hash-table as well, to cache
301 * their existence:
302 */
303#define CHAINHASH_BITS (MAX_LOCKDEP_CHAINS_BITS-1)
304#define CHAINHASH_SIZE (1UL << CHAINHASH_BITS)
Peter Zijlstra4b32d0a2007-07-19 01:48:59 -0700305#define __chainhashfn(chain) hash_long(chain, CHAINHASH_BITS)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700306#define chainhashentry(chain) (chainhash_table + __chainhashfn((chain)))
307
Andrew Mortona63f38c2016-02-03 13:44:12 -0800308static struct hlist_head chainhash_table[CHAINHASH_SIZE];
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700309
310/*
311 * The hash key of the lock dependency chains is a hash itself too:
312 * it's a hash of all locks taken up to that lock, including that lock.
313 * It's a 64-bit hash, because it's important for the keys to be
314 * unique.
315 */
Peter Zijlstradfaaf3f2016-05-30 18:31:33 +0200316static inline u64 iterate_chain_key(u64 key, u32 idx)
317{
318 u32 k0 = key, k1 = key >> 32;
319
320 __jhash_mix(idx, k0, k1); /* Macro that modifies arguments! */
321
322 return k0 | (u64)k1 << 32;
323}
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700324
Steven Rostedt1d09daa2008-05-12 21:20:55 +0200325void lockdep_off(void)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700326{
327 current->lockdep_recursion++;
328}
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700329EXPORT_SYMBOL(lockdep_off);
330
Steven Rostedt1d09daa2008-05-12 21:20:55 +0200331void lockdep_on(void)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700332{
333 current->lockdep_recursion--;
334}
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700335EXPORT_SYMBOL(lockdep_on);
336
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700337/*
338 * Debugging switches:
339 */
340
341#define VERBOSE 0
Ingo Molnar33e94e92006-12-13 00:34:41 -0800342#define VERY_VERBOSE 0
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700343
344#if VERBOSE
345# define HARDIRQ_VERBOSE 1
346# define SOFTIRQ_VERBOSE 1
347#else
348# define HARDIRQ_VERBOSE 0
349# define SOFTIRQ_VERBOSE 0
350#endif
351
Peter Zijlstrad92a8cf2017-03-03 10:13:38 +0100352#if VERBOSE || HARDIRQ_VERBOSE || SOFTIRQ_VERBOSE
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700353/*
354 * Quick filtering for interesting events:
355 */
356static int class_filter(struct lock_class *class)
357{
Andi Kleenf9829cc2006-07-10 04:44:01 -0700358#if 0
359 /* Example */
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700360 if (class->name_version == 1 &&
Andi Kleenf9829cc2006-07-10 04:44:01 -0700361 !strcmp(class->name, "lockname"))
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700362 return 1;
363 if (class->name_version == 1 &&
Andi Kleenf9829cc2006-07-10 04:44:01 -0700364 !strcmp(class->name, "&struct->lockfield"))
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700365 return 1;
Andi Kleenf9829cc2006-07-10 04:44:01 -0700366#endif
Ingo Molnara6640892006-12-13 00:34:39 -0800367 /* Filter everything else. 1 would be to allow everything else */
368 return 0;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700369}
370#endif
371
372static int verbose(struct lock_class *class)
373{
374#if VERBOSE
375 return class_filter(class);
376#endif
377 return 0;
378}
379
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700380/*
381 * Stack-trace: tightly packed array of stack backtrace
Ingo Molnar74c383f2006-12-13 00:34:43 -0800382 * addresses. Protected by the graph_lock.
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700383 */
384unsigned long nr_stack_trace_entries;
385static unsigned long stack_trace[MAX_STACK_TRACE_ENTRIES];
386
Dave Jones2c522832013-04-25 13:40:02 -0400387static void print_lockdep_off(const char *bug_msg)
388{
389 printk(KERN_DEBUG "%s\n", bug_msg);
390 printk(KERN_DEBUG "turning off the locking correctness validator.\n");
Andreas Gruenbacheracf59372014-07-15 21:10:52 +0200391#ifdef CONFIG_LOCK_STAT
Dave Jones2c522832013-04-25 13:40:02 -0400392 printk(KERN_DEBUG "Please attach the output of /proc/lock_stat to the bug report\n");
Andreas Gruenbacheracf59372014-07-15 21:10:52 +0200393#endif
Dave Jones2c522832013-04-25 13:40:02 -0400394}
395
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700396static int save_trace(struct stack_trace *trace)
397{
398 trace->nr_entries = 0;
399 trace->max_entries = MAX_STACK_TRACE_ENTRIES - nr_stack_trace_entries;
400 trace->entries = stack_trace + nr_stack_trace_entries;
401
Andi Kleen5a1b3992006-09-26 10:52:34 +0200402 trace->skip = 3;
Andi Kleen5a1b3992006-09-26 10:52:34 +0200403
Christoph Hellwigab1b6f02007-05-08 00:23:29 -0700404 save_stack_trace(trace);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700405
Peter Zijlstra4f84f432009-07-20 15:27:04 +0200406 /*
407 * Some daft arches put -1 at the end to indicate its a full trace.
408 *
409 * <rant> this is buggy anyway, since it takes a whole extra entry so a
410 * complete trace that maxes out the entries provided will be reported
411 * as incomplete, friggin useless </rant>
412 */
Luck, Tonyea5b41f2009-12-09 14:29:36 -0800413 if (trace->nr_entries != 0 &&
414 trace->entries[trace->nr_entries-1] == ULONG_MAX)
Peter Zijlstra4f84f432009-07-20 15:27:04 +0200415 trace->nr_entries--;
416
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700417 trace->max_entries = trace->nr_entries;
418
419 nr_stack_trace_entries += trace->nr_entries;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700420
Peter Zijlstra4f84f432009-07-20 15:27:04 +0200421 if (nr_stack_trace_entries >= MAX_STACK_TRACE_ENTRIES-1) {
Ingo Molnar74c383f2006-12-13 00:34:43 -0800422 if (!debug_locks_off_graph_unlock())
423 return 0;
424
Dave Jones2c522832013-04-25 13:40:02 -0400425 print_lockdep_off("BUG: MAX_STACK_TRACE_ENTRIES too low!");
Ingo Molnar74c383f2006-12-13 00:34:43 -0800426 dump_stack();
427
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700428 return 0;
429 }
430
431 return 1;
432}
433
434unsigned int nr_hardirq_chains;
435unsigned int nr_softirq_chains;
436unsigned int nr_process_chains;
437unsigned int max_lockdep_depth;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700438
439#ifdef CONFIG_DEBUG_LOCKDEP
440/*
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700441 * Various lockdep statistics:
442 */
Frederic Weisbeckerbd6d29c2010-04-06 00:10:17 +0200443DEFINE_PER_CPU(struct lockdep_stats, lockdep_stats);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700444#endif
445
446/*
447 * Locking printouts:
448 */
449
Peter Zijlstrafabe9c42009-01-22 14:51:01 +0100450#define __USAGE(__STATE) \
Peter Zijlstrab4b136f2009-01-29 14:50:36 +0100451 [LOCK_USED_IN_##__STATE] = "IN-"__stringify(__STATE)"-W", \
452 [LOCK_ENABLED_##__STATE] = __stringify(__STATE)"-ON-W", \
453 [LOCK_USED_IN_##__STATE##_READ] = "IN-"__stringify(__STATE)"-R",\
454 [LOCK_ENABLED_##__STATE##_READ] = __stringify(__STATE)"-ON-R",
Peter Zijlstrafabe9c42009-01-22 14:51:01 +0100455
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700456static const char *usage_str[] =
457{
Peter Zijlstrafabe9c42009-01-22 14:51:01 +0100458#define LOCKDEP_STATE(__STATE) __USAGE(__STATE)
459#include "lockdep_states.h"
460#undef LOCKDEP_STATE
461 [LOCK_USED] = "INITIAL USE",
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700462};
463
464const char * __get_key_name(struct lockdep_subclass_key *key, char *str)
465{
Alexey Dobriyanffb45122007-05-08 00:28:41 -0700466 return kallsyms_lookup((unsigned long)key, NULL, NULL, NULL, str);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700467}
468
Peter Zijlstra3ff176c2009-01-22 17:40:42 +0100469static inline unsigned long lock_flag(enum lock_usage_bit bit)
470{
471 return 1UL << bit;
472}
473
474static char get_usage_char(struct lock_class *class, enum lock_usage_bit bit)
475{
476 char c = '.';
477
478 if (class->usage_mask & lock_flag(bit + 2))
479 c = '+';
480 if (class->usage_mask & lock_flag(bit)) {
481 c = '-';
482 if (class->usage_mask & lock_flag(bit + 2))
483 c = '?';
484 }
485
486 return c;
487}
488
Peter Zijlstraf510b232009-01-22 17:53:47 +0100489void get_usage_chars(struct lock_class *class, char usage[LOCK_USAGE_CHARS])
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700490{
Peter Zijlstraf510b232009-01-22 17:53:47 +0100491 int i = 0;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700492
Peter Zijlstraf510b232009-01-22 17:53:47 +0100493#define LOCKDEP_STATE(__STATE) \
494 usage[i++] = get_usage_char(class, LOCK_USED_IN_##__STATE); \
495 usage[i++] = get_usage_char(class, LOCK_USED_IN_##__STATE##_READ);
496#include "lockdep_states.h"
497#undef LOCKDEP_STATE
498
499 usage[i] = '\0';
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700500}
501
Steven Rostedte5e78d02011-11-02 20:24:16 -0400502static void __print_lock_name(struct lock_class *class)
Steven Rostedt3003eba2011-04-20 21:41:54 -0400503{
504 char str[KSYM_NAME_LEN];
505 const char *name;
506
507 name = class->name;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700508 if (!name) {
509 name = __get_key_name(class->key, str);
Dmitry Vyukovf943fe02016-11-28 15:24:43 +0100510 printk(KERN_CONT "%s", name);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700511 } else {
Dmitry Vyukovf943fe02016-11-28 15:24:43 +0100512 printk(KERN_CONT "%s", name);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700513 if (class->name_version > 1)
Dmitry Vyukovf943fe02016-11-28 15:24:43 +0100514 printk(KERN_CONT "#%d", class->name_version);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700515 if (class->subclass)
Dmitry Vyukovf943fe02016-11-28 15:24:43 +0100516 printk(KERN_CONT "/%d", class->subclass);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700517 }
Steven Rostedte5e78d02011-11-02 20:24:16 -0400518}
519
520static void print_lock_name(struct lock_class *class)
521{
522 char usage[LOCK_USAGE_CHARS];
523
524 get_usage_chars(class, usage);
525
Dmitry Vyukovf943fe02016-11-28 15:24:43 +0100526 printk(KERN_CONT " (");
Steven Rostedte5e78d02011-11-02 20:24:16 -0400527 __print_lock_name(class);
Dmitry Vyukovf943fe02016-11-28 15:24:43 +0100528 printk(KERN_CONT "){%s}", usage);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700529}
530
531static void print_lockdep_cache(struct lockdep_map *lock)
532{
533 const char *name;
Tejun Heo9281ace2007-07-17 04:03:51 -0700534 char str[KSYM_NAME_LEN];
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700535
536 name = lock->name;
537 if (!name)
538 name = __get_key_name(lock->key->subkeys, str);
539
Dmitry Vyukovf943fe02016-11-28 15:24:43 +0100540 printk(KERN_CONT "%s", name);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700541}
542
543static void print_lock(struct held_lock *hlock)
544{
Peter Zijlstrad7bc3192015-04-15 17:11:57 +0200545 /*
546 * We can be called locklessly through debug_show_all_locks() so be
547 * extra careful, the hlock might have been released and cleared.
548 */
549 unsigned int class_idx = hlock->class_idx;
550
551 /* Don't re-read hlock->class_idx, can't use READ_ONCE() on bitfields: */
552 barrier();
553
554 if (!class_idx || (class_idx - 1) >= MAX_LOCKDEP_KEYS) {
Dmitry Vyukovf943fe02016-11-28 15:24:43 +0100555 printk(KERN_CONT "<RELEASED>\n");
Peter Zijlstrad7bc3192015-04-15 17:11:57 +0200556 return;
557 }
558
Tetsuo Handab3c39752018-03-27 19:41:41 +0900559 printk(KERN_CONT "%p", hlock->instance);
Peter Zijlstrad7bc3192015-04-15 17:11:57 +0200560 print_lock_name(lock_classes + class_idx - 1);
Tetsuo Handab3c39752018-03-27 19:41:41 +0900561 printk(KERN_CONT ", at: %pS\n", (void *)hlock->acquire_ip);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700562}
563
Tetsuo Handa8cc05c712018-04-06 19:41:19 +0900564static void lockdep_print_held_locks(struct task_struct *p)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700565{
Tetsuo Handa8cc05c712018-04-06 19:41:19 +0900566 int i, depth = READ_ONCE(p->lockdep_depth);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700567
Tetsuo Handa8cc05c712018-04-06 19:41:19 +0900568 if (!depth)
569 printk("no locks held by %s/%d.\n", p->comm, task_pid_nr(p));
570 else
571 printk("%d lock%s held by %s/%d:\n", depth,
572 depth > 1 ? "s" : "", p->comm, task_pid_nr(p));
573 /*
574 * It's not reliable to print a task's held locks if it's not sleeping
575 * and it's not the current task.
576 */
577 if (p->state == TASK_RUNNING && p != current)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700578 return;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700579 for (i = 0; i < depth; i++) {
580 printk(" #%d: ", i);
Tetsuo Handa8cc05c712018-04-06 19:41:19 +0900581 print_lock(p->held_locks + i);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700582 }
583}
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700584
Ben Hutchingsfbdc4b92011-10-28 04:36:55 +0100585static void print_kernel_ident(void)
Dave Jones99de0552006-09-29 02:00:10 -0700586{
Ben Hutchingsfbdc4b92011-10-28 04:36:55 +0100587 printk("%s %.*s %s\n", init_utsname()->release,
Serge E. Hallyn96b644b2006-10-02 02:18:13 -0700588 (int)strcspn(init_utsname()->version, " "),
Ben Hutchingsfbdc4b92011-10-28 04:36:55 +0100589 init_utsname()->version,
590 print_tainted());
Dave Jones99de0552006-09-29 02:00:10 -0700591}
592
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700593static int very_verbose(struct lock_class *class)
594{
595#if VERY_VERBOSE
596 return class_filter(class);
597#endif
598 return 0;
599}
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700600
601/*
602 * Is this the address of a static object:
603 */
Sasha Levin8dce7a92013-06-13 18:41:16 -0400604#ifdef __KERNEL__
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700605static int static_obj(void *obj)
606{
607 unsigned long start = (unsigned long) &_stext,
608 end = (unsigned long) &_end,
609 addr = (unsigned long) obj;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700610
611 /*
612 * static variable?
613 */
614 if ((addr >= start) && (addr < end))
615 return 1;
616
Mike Frysinger2a9ad182009-09-22 16:44:16 -0700617 if (arch_is_kernel_data(addr))
618 return 1;
619
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700620 /*
Tejun Heo10fad5e2010-03-10 18:57:54 +0900621 * in-kernel percpu var?
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700622 */
Tejun Heo10fad5e2010-03-10 18:57:54 +0900623 if (is_kernel_percpu_address(addr))
624 return 1;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700625
626 /*
Tejun Heo10fad5e2010-03-10 18:57:54 +0900627 * module static or percpu var?
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700628 */
Tejun Heo10fad5e2010-03-10 18:57:54 +0900629 return is_module_address(addr) || is_module_percpu_address(addr);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700630}
Sasha Levin8dce7a92013-06-13 18:41:16 -0400631#endif
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700632
633/*
634 * To make lock name printouts unique, we calculate a unique
635 * class->name_version generation counter:
636 */
637static int count_matching_names(struct lock_class *new_class)
638{
639 struct lock_class *class;
640 int count = 0;
641
642 if (!new_class->name)
643 return 0;
644
Peter Zijlstra35a93932015-02-26 16:23:11 +0100645 list_for_each_entry_rcu(class, &all_lock_classes, lock_entry) {
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700646 if (new_class->key - new_class->subclass == class->key)
647 return class->name_version;
648 if (class->name && !strcmp(class->name, new_class->name))
649 count = max(count, class->name_version);
650 }
651
652 return count + 1;
653}
654
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700655static inline struct lock_class *
Matthew Wilcox08f36ff2018-01-17 07:14:13 -0800656look_up_lock_class(const struct lockdep_map *lock, unsigned int subclass)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700657{
658 struct lockdep_subclass_key *key;
Andrew Mortona63f38c2016-02-03 13:44:12 -0800659 struct hlist_head *hash_head;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700660 struct lock_class *class;
661
Hitoshi Mitake4ba053c2010-10-13 17:30:26 +0900662 if (unlikely(subclass >= MAX_LOCKDEP_SUBCLASSES)) {
663 debug_locks_off();
664 printk(KERN_ERR
665 "BUG: looking up invalid subclass: %u\n", subclass);
666 printk(KERN_ERR
667 "turning off the locking correctness validator.\n");
668 dump_stack();
669 return NULL;
670 }
671
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700672 /*
Matthew Wilcox64f29d12018-01-17 07:14:12 -0800673 * If it is not initialised then it has never been locked,
674 * so it won't be present in the hash table.
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700675 */
Matthew Wilcox64f29d12018-01-17 07:14:12 -0800676 if (unlikely(!lock->key))
677 return NULL;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700678
679 /*
680 * NOTE: the class-key must be unique. For dynamic locks, a static
681 * lock_class_key variable is passed in through the mutex_init()
682 * (or spin_lock_init()) call - which acts as the key. For static
683 * locks we use the lock object itself as the key.
684 */
Peter Zijlstra4b32d0a2007-07-19 01:48:59 -0700685 BUILD_BUG_ON(sizeof(struct lock_class_key) >
686 sizeof(struct lockdep_map));
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700687
688 key = lock->key->subkeys + subclass;
689
690 hash_head = classhashentry(key);
691
692 /*
Peter Zijlstra35a93932015-02-26 16:23:11 +0100693 * We do an RCU walk of the hash, see lockdep_free_key_range().
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700694 */
Peter Zijlstra35a93932015-02-26 16:23:11 +0100695 if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
696 return NULL;
697
Andrew Mortona63f38c2016-02-03 13:44:12 -0800698 hlist_for_each_entry_rcu(class, hash_head, hash_entry) {
Peter Zijlstra4b32d0a2007-07-19 01:48:59 -0700699 if (class->key == key) {
Peter Zijlstra0119fee2011-09-02 01:30:29 +0200700 /*
701 * Huh! same key, different name? Did someone trample
702 * on some memory? We're most confused.
703 */
Peter Zijlstra4b32d0a2007-07-19 01:48:59 -0700704 WARN_ON_ONCE(class->name != lock->name);
Ingo Molnard6d897c2006-07-10 04:44:04 -0700705 return class;
Peter Zijlstra4b32d0a2007-07-19 01:48:59 -0700706 }
707 }
Ingo Molnard6d897c2006-07-10 04:44:04 -0700708
Matthew Wilcox64f29d12018-01-17 07:14:12 -0800709 return NULL;
710}
711
712/*
713 * Static locks do not have their class-keys yet - for them the key is
714 * the lock object itself. If the lock is in the per cpu area, the
715 * canonical address of the lock (per cpu offset removed) is used.
716 */
717static bool assign_lock_key(struct lockdep_map *lock)
718{
719 unsigned long can_addr, addr = (unsigned long)lock;
720
721 if (__is_kernel_percpu_address(addr, &can_addr))
722 lock->key = (void *)can_addr;
723 else if (__is_module_percpu_address(addr, &can_addr))
724 lock->key = (void *)can_addr;
725 else if (static_obj(lock))
726 lock->key = (void *)lock;
727 else {
728 /* Debug-check: all keys must be persistent! */
729 debug_locks_off();
730 pr_err("INFO: trying to register non-static key.\n");
731 pr_err("the code is fine but needs lockdep annotation.\n");
732 pr_err("turning off the locking correctness validator.\n");
733 dump_stack();
734 return false;
735 }
736
737 return true;
Ingo Molnard6d897c2006-07-10 04:44:04 -0700738}
739
740/*
741 * Register a lock's class in the hash-table, if the class is not present
742 * yet. Otherwise we look it up. We cache the result in the lock object
743 * itself, so actual lookup of the hash should be once per lock object.
744 */
Denys Vlasenkoc003ed92016-04-08 20:58:46 +0200745static struct lock_class *
Peter Zijlstra4dfbb9d2006-10-11 01:45:14 -0400746register_lock_class(struct lockdep_map *lock, unsigned int subclass, int force)
Ingo Molnard6d897c2006-07-10 04:44:04 -0700747{
748 struct lockdep_subclass_key *key;
Andrew Mortona63f38c2016-02-03 13:44:12 -0800749 struct hlist_head *hash_head;
Ingo Molnard6d897c2006-07-10 04:44:04 -0700750 struct lock_class *class;
Peter Zijlstra35a93932015-02-26 16:23:11 +0100751
752 DEBUG_LOCKS_WARN_ON(!irqs_disabled());
Ingo Molnard6d897c2006-07-10 04:44:04 -0700753
754 class = look_up_lock_class(lock, subclass);
Matthew Wilcox64f29d12018-01-17 07:14:12 -0800755 if (likely(class))
Yong Zhang87cdee72011-11-09 16:07:14 +0800756 goto out_set_class_cache;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700757
Matthew Wilcox64f29d12018-01-17 07:14:12 -0800758 if (!lock->key) {
759 if (!assign_lock_key(lock))
760 return NULL;
761 } else if (!static_obj(lock->key)) {
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700762 return NULL;
763 }
764
Ingo Molnard6d897c2006-07-10 04:44:04 -0700765 key = lock->key->subkeys + subclass;
766 hash_head = classhashentry(key);
767
Ingo Molnar74c383f2006-12-13 00:34:43 -0800768 if (!graph_lock()) {
Ingo Molnar74c383f2006-12-13 00:34:43 -0800769 return NULL;
770 }
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700771 /*
772 * We have to do the hash-walk again, to avoid races
773 * with another CPU:
774 */
Andrew Mortona63f38c2016-02-03 13:44:12 -0800775 hlist_for_each_entry_rcu(class, hash_head, hash_entry) {
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700776 if (class->key == key)
777 goto out_unlock_set;
Peter Zijlstra35a93932015-02-26 16:23:11 +0100778 }
779
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700780 /*
781 * Allocate a new key from the static array, and add it to
782 * the hash:
783 */
784 if (nr_lock_classes >= MAX_LOCKDEP_KEYS) {
Ingo Molnar74c383f2006-12-13 00:34:43 -0800785 if (!debug_locks_off_graph_unlock()) {
Ingo Molnar74c383f2006-12-13 00:34:43 -0800786 return NULL;
787 }
Ingo Molnar74c383f2006-12-13 00:34:43 -0800788
Dave Jones2c522832013-04-25 13:40:02 -0400789 print_lockdep_off("BUG: MAX_LOCKDEP_KEYS too low!");
Peter Zijlstraeedeeab2009-03-18 12:38:47 +0100790 dump_stack();
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700791 return NULL;
792 }
793 class = lock_classes + nr_lock_classes++;
Frederic Weisbeckerbd6d29c2010-04-06 00:10:17 +0200794 debug_atomic_inc(nr_unused_locks);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700795 class->key = key;
796 class->name = lock->name;
797 class->subclass = subclass;
798 INIT_LIST_HEAD(&class->lock_entry);
799 INIT_LIST_HEAD(&class->locks_before);
800 INIT_LIST_HEAD(&class->locks_after);
801 class->name_version = count_matching_names(class);
802 /*
803 * We use RCU's safe list-add method to make
804 * parallel walking of the hash-list safe:
805 */
Andrew Mortona63f38c2016-02-03 13:44:12 -0800806 hlist_add_head_rcu(&class->hash_entry, hash_head);
Dale Farnsworth14811972008-02-25 23:03:02 +0100807 /*
808 * Add it to the global list of classes:
809 */
810 list_add_tail_rcu(&class->lock_entry, &all_lock_classes);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700811
812 if (verbose(class)) {
Ingo Molnar74c383f2006-12-13 00:34:43 -0800813 graph_unlock();
Ingo Molnar74c383f2006-12-13 00:34:43 -0800814
Borislav Petkov04860d42018-02-26 14:49:26 +0100815 printk("\nnew class %px: %s", class->key, class->name);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700816 if (class->name_version > 1)
Dmitry Vyukovf943fe02016-11-28 15:24:43 +0100817 printk(KERN_CONT "#%d", class->name_version);
818 printk(KERN_CONT "\n");
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700819 dump_stack();
Ingo Molnar74c383f2006-12-13 00:34:43 -0800820
Ingo Molnar74c383f2006-12-13 00:34:43 -0800821 if (!graph_lock()) {
Ingo Molnar74c383f2006-12-13 00:34:43 -0800822 return NULL;
823 }
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700824 }
825out_unlock_set:
Ingo Molnar74c383f2006-12-13 00:34:43 -0800826 graph_unlock();
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700827
Yong Zhang87cdee72011-11-09 16:07:14 +0800828out_set_class_cache:
Peter Zijlstra4dfbb9d2006-10-11 01:45:14 -0400829 if (!subclass || force)
Hitoshi Mitake62016252010-10-05 18:01:51 +0900830 lock->class_cache[0] = class;
831 else if (subclass < NR_LOCKDEP_CACHING_CLASSES)
832 lock->class_cache[subclass] = class;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700833
Peter Zijlstra0119fee2011-09-02 01:30:29 +0200834 /*
835 * Hash collision, did we smoke some? We found a class with a matching
836 * hash but the subclass -- which is hashed in -- didn't match.
837 */
Jarek Poplawski381a2292007-02-10 01:44:58 -0800838 if (DEBUG_LOCKS_WARN_ON(class->subclass != subclass))
839 return NULL;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700840
841 return class;
842}
843
Peter Zijlstraca58abc2007-07-19 01:48:53 -0700844#ifdef CONFIG_PROVE_LOCKING
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700845/*
Peter Zijlstra8e182572007-07-19 01:48:54 -0700846 * Allocate a lockdep entry. (assumes the graph_lock held, returns
847 * with NULL on failure)
848 */
849static struct lock_list *alloc_list_entry(void)
850{
851 if (nr_list_entries >= MAX_LOCKDEP_ENTRIES) {
852 if (!debug_locks_off_graph_unlock())
853 return NULL;
854
Dave Jones2c522832013-04-25 13:40:02 -0400855 print_lockdep_off("BUG: MAX_LOCKDEP_ENTRIES too low!");
Peter Zijlstraeedeeab2009-03-18 12:38:47 +0100856 dump_stack();
Peter Zijlstra8e182572007-07-19 01:48:54 -0700857 return NULL;
858 }
859 return list_entries + nr_list_entries++;
860}
861
862/*
863 * Add a new dependency to the head of the list:
864 */
Tahsin Erdogan83f06162016-11-08 00:02:07 -0800865static int add_lock_to_list(struct lock_class *this, struct list_head *head,
866 unsigned long ip, int distance,
867 struct stack_trace *trace)
Peter Zijlstra8e182572007-07-19 01:48:54 -0700868{
869 struct lock_list *entry;
870 /*
871 * Lock not present yet - get a new dependency struct and
872 * add it to the list:
873 */
874 entry = alloc_list_entry();
875 if (!entry)
876 return 0;
877
Zhu Yi74870172008-08-27 14:33:00 +0800878 entry->class = this;
879 entry->distance = distance;
Yong Zhang4726f2a2010-05-04 14:16:48 +0800880 entry->trace = *trace;
Peter Zijlstra8e182572007-07-19 01:48:54 -0700881 /*
Peter Zijlstra35a93932015-02-26 16:23:11 +0100882 * Both allocation and removal are done under the graph lock; but
883 * iteration is under RCU-sched; see look_up_lock_class() and
884 * lockdep_free_key_range().
Peter Zijlstra8e182572007-07-19 01:48:54 -0700885 */
886 list_add_tail_rcu(&entry->entry, head);
887
888 return 1;
889}
890
Peter Zijlstra98c33ed2009-07-21 13:19:07 +0200891/*
892 * For good efficiency of modular, we use power of 2
893 */
Peter Zijlstraaf012962009-07-16 15:44:29 +0200894#define MAX_CIRCULAR_QUEUE_SIZE 4096UL
895#define CQ_MASK (MAX_CIRCULAR_QUEUE_SIZE-1)
896
Peter Zijlstra98c33ed2009-07-21 13:19:07 +0200897/*
898 * The circular_queue and helpers is used to implement the
Peter Zijlstraaf012962009-07-16 15:44:29 +0200899 * breadth-first search(BFS)algorithem, by which we can build
900 * the shortest path from the next lock to be acquired to the
901 * previous held lock if there is a circular between them.
Peter Zijlstra98c33ed2009-07-21 13:19:07 +0200902 */
Peter Zijlstraaf012962009-07-16 15:44:29 +0200903struct circular_queue {
904 unsigned long element[MAX_CIRCULAR_QUEUE_SIZE];
905 unsigned int front, rear;
906};
907
908static struct circular_queue lock_cq;
Peter Zijlstraaf012962009-07-16 15:44:29 +0200909
Ming Lei12f3dfd2009-07-16 15:44:29 +0200910unsigned int max_bfs_queue_depth;
Peter Zijlstraaf012962009-07-16 15:44:29 +0200911
Ming Leie351b662009-07-22 22:48:09 +0800912static unsigned int lockdep_dependency_gen_id;
913
Peter Zijlstraaf012962009-07-16 15:44:29 +0200914static inline void __cq_init(struct circular_queue *cq)
915{
916 cq->front = cq->rear = 0;
Ming Leie351b662009-07-22 22:48:09 +0800917 lockdep_dependency_gen_id++;
Peter Zijlstraaf012962009-07-16 15:44:29 +0200918}
919
920static inline int __cq_empty(struct circular_queue *cq)
921{
922 return (cq->front == cq->rear);
923}
924
925static inline int __cq_full(struct circular_queue *cq)
926{
927 return ((cq->rear + 1) & CQ_MASK) == cq->front;
928}
929
930static inline int __cq_enqueue(struct circular_queue *cq, unsigned long elem)
931{
932 if (__cq_full(cq))
933 return -1;
934
935 cq->element[cq->rear] = elem;
936 cq->rear = (cq->rear + 1) & CQ_MASK;
937 return 0;
938}
939
940static inline int __cq_dequeue(struct circular_queue *cq, unsigned long *elem)
941{
942 if (__cq_empty(cq))
943 return -1;
944
945 *elem = cq->element[cq->front];
946 cq->front = (cq->front + 1) & CQ_MASK;
947 return 0;
948}
949
950static inline unsigned int __cq_get_elem_count(struct circular_queue *cq)
951{
952 return (cq->rear - cq->front) & CQ_MASK;
953}
954
955static inline void mark_lock_accessed(struct lock_list *lock,
956 struct lock_list *parent)
957{
958 unsigned long nr;
Peter Zijlstra98c33ed2009-07-21 13:19:07 +0200959
Peter Zijlstraaf012962009-07-16 15:44:29 +0200960 nr = lock - list_entries;
Peter Zijlstra0119fee2011-09-02 01:30:29 +0200961 WARN_ON(nr >= nr_list_entries); /* Out-of-bounds, input fail */
Peter Zijlstraaf012962009-07-16 15:44:29 +0200962 lock->parent = parent;
Ming Leie351b662009-07-22 22:48:09 +0800963 lock->class->dep_gen_id = lockdep_dependency_gen_id;
Peter Zijlstraaf012962009-07-16 15:44:29 +0200964}
965
966static inline unsigned long lock_accessed(struct lock_list *lock)
967{
968 unsigned long nr;
Peter Zijlstra98c33ed2009-07-21 13:19:07 +0200969
Peter Zijlstraaf012962009-07-16 15:44:29 +0200970 nr = lock - list_entries;
Peter Zijlstra0119fee2011-09-02 01:30:29 +0200971 WARN_ON(nr >= nr_list_entries); /* Out-of-bounds, input fail */
Ming Leie351b662009-07-22 22:48:09 +0800972 return lock->class->dep_gen_id == lockdep_dependency_gen_id;
Peter Zijlstraaf012962009-07-16 15:44:29 +0200973}
974
975static inline struct lock_list *get_lock_parent(struct lock_list *child)
976{
977 return child->parent;
978}
979
980static inline int get_lock_depth(struct lock_list *child)
981{
982 int depth = 0;
983 struct lock_list *parent;
984
985 while ((parent = get_lock_parent(child))) {
986 child = parent;
987 depth++;
988 }
989 return depth;
990}
991
Ming Lei9e2d5512009-07-16 15:44:29 +0200992static int __bfs(struct lock_list *source_entry,
Peter Zijlstraaf012962009-07-16 15:44:29 +0200993 void *data,
994 int (*match)(struct lock_list *entry, void *data),
995 struct lock_list **target_entry,
996 int forward)
Ming Leic94aa5c2009-07-16 15:44:29 +0200997{
998 struct lock_list *entry;
Ming Leid588e462009-07-16 15:44:29 +0200999 struct list_head *head;
Ming Leic94aa5c2009-07-16 15:44:29 +02001000 struct circular_queue *cq = &lock_cq;
1001 int ret = 1;
1002
Ming Lei9e2d5512009-07-16 15:44:29 +02001003 if (match(source_entry, data)) {
Ming Leic94aa5c2009-07-16 15:44:29 +02001004 *target_entry = source_entry;
1005 ret = 0;
1006 goto exit;
1007 }
1008
Ming Leid588e462009-07-16 15:44:29 +02001009 if (forward)
1010 head = &source_entry->class->locks_after;
1011 else
1012 head = &source_entry->class->locks_before;
1013
1014 if (list_empty(head))
1015 goto exit;
1016
1017 __cq_init(cq);
Ming Leic94aa5c2009-07-16 15:44:29 +02001018 __cq_enqueue(cq, (unsigned long)source_entry);
1019
1020 while (!__cq_empty(cq)) {
1021 struct lock_list *lock;
Ming Leic94aa5c2009-07-16 15:44:29 +02001022
1023 __cq_dequeue(cq, (unsigned long *)&lock);
1024
1025 if (!lock->class) {
1026 ret = -2;
1027 goto exit;
1028 }
1029
1030 if (forward)
1031 head = &lock->class->locks_after;
1032 else
1033 head = &lock->class->locks_before;
1034
Peter Zijlstra35a93932015-02-26 16:23:11 +01001035 DEBUG_LOCKS_WARN_ON(!irqs_disabled());
1036
1037 list_for_each_entry_rcu(entry, head, entry) {
Ming Leic94aa5c2009-07-16 15:44:29 +02001038 if (!lock_accessed(entry)) {
Ming Lei12f3dfd2009-07-16 15:44:29 +02001039 unsigned int cq_depth;
Ming Leic94aa5c2009-07-16 15:44:29 +02001040 mark_lock_accessed(entry, lock);
Ming Lei9e2d5512009-07-16 15:44:29 +02001041 if (match(entry, data)) {
Ming Leic94aa5c2009-07-16 15:44:29 +02001042 *target_entry = entry;
1043 ret = 0;
1044 goto exit;
1045 }
1046
1047 if (__cq_enqueue(cq, (unsigned long)entry)) {
1048 ret = -1;
1049 goto exit;
1050 }
Ming Lei12f3dfd2009-07-16 15:44:29 +02001051 cq_depth = __cq_get_elem_count(cq);
1052 if (max_bfs_queue_depth < cq_depth)
1053 max_bfs_queue_depth = cq_depth;
Ming Leic94aa5c2009-07-16 15:44:29 +02001054 }
1055 }
1056 }
1057exit:
1058 return ret;
1059}
1060
Ming Leid7aaba12009-07-16 15:44:29 +02001061static inline int __bfs_forwards(struct lock_list *src_entry,
Ming Lei9e2d5512009-07-16 15:44:29 +02001062 void *data,
1063 int (*match)(struct lock_list *entry, void *data),
1064 struct lock_list **target_entry)
Ming Leic94aa5c2009-07-16 15:44:29 +02001065{
Ming Lei9e2d5512009-07-16 15:44:29 +02001066 return __bfs(src_entry, data, match, target_entry, 1);
Ming Leic94aa5c2009-07-16 15:44:29 +02001067
1068}
1069
Ming Leid7aaba12009-07-16 15:44:29 +02001070static inline int __bfs_backwards(struct lock_list *src_entry,
Ming Lei9e2d5512009-07-16 15:44:29 +02001071 void *data,
1072 int (*match)(struct lock_list *entry, void *data),
1073 struct lock_list **target_entry)
Ming Leic94aa5c2009-07-16 15:44:29 +02001074{
Ming Lei9e2d5512009-07-16 15:44:29 +02001075 return __bfs(src_entry, data, match, target_entry, 0);
Ming Leic94aa5c2009-07-16 15:44:29 +02001076
1077}
1078
Peter Zijlstra8e182572007-07-19 01:48:54 -07001079/*
1080 * Recursive, forwards-direction lock-dependency checking, used for
1081 * both noncyclic checking and for hardirq-unsafe/softirq-unsafe
1082 * checking.
Peter Zijlstra8e182572007-07-19 01:48:54 -07001083 */
Peter Zijlstra8e182572007-07-19 01:48:54 -07001084
1085/*
1086 * Print a dependency chain entry (this is only done when a deadlock
1087 * has been detected):
1088 */
1089static noinline int
Ming Lei24208ca2009-07-16 15:44:29 +02001090print_circular_bug_entry(struct lock_list *target, int depth)
Peter Zijlstra8e182572007-07-19 01:48:54 -07001091{
1092 if (debug_locks_silent)
1093 return 0;
1094 printk("\n-> #%u", depth);
1095 print_lock_name(target->class);
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01001096 printk(KERN_CONT ":\n");
Peter Zijlstra8e182572007-07-19 01:48:54 -07001097 print_stack_trace(&target->trace, 6);
1098
1099 return 0;
1100}
1101
Steven Rostedtf4185812011-04-20 21:41:55 -04001102static void
1103print_circular_lock_scenario(struct held_lock *src,
1104 struct held_lock *tgt,
1105 struct lock_list *prt)
1106{
1107 struct lock_class *source = hlock_class(src);
1108 struct lock_class *target = hlock_class(tgt);
1109 struct lock_class *parent = prt->class;
1110
1111 /*
1112 * A direct locking problem where unsafe_class lock is taken
1113 * directly by safe_class lock, then all we need to show
1114 * is the deadlock scenario, as it is obvious that the
1115 * unsafe lock is taken under the safe lock.
1116 *
1117 * But if there is a chain instead, where the safe lock takes
1118 * an intermediate lock (middle_class) where this lock is
1119 * not the same as the safe lock, then the lock chain is
1120 * used to describe the problem. Otherwise we would need
1121 * to show a different CPU case for each link in the chain
1122 * from the safe_class lock to the unsafe_class lock.
1123 */
1124 if (parent != source) {
1125 printk("Chain exists of:\n ");
1126 __print_lock_name(source);
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01001127 printk(KERN_CONT " --> ");
Steven Rostedtf4185812011-04-20 21:41:55 -04001128 __print_lock_name(parent);
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01001129 printk(KERN_CONT " --> ");
Steven Rostedtf4185812011-04-20 21:41:55 -04001130 __print_lock_name(target);
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01001131 printk(KERN_CONT "\n\n");
Steven Rostedtf4185812011-04-20 21:41:55 -04001132 }
1133
Ingo Molnare966eae2017-12-12 12:31:16 +01001134 printk(" Possible unsafe locking scenario:\n\n");
1135 printk(" CPU0 CPU1\n");
1136 printk(" ---- ----\n");
1137 printk(" lock(");
1138 __print_lock_name(target);
1139 printk(KERN_CONT ");\n");
1140 printk(" lock(");
1141 __print_lock_name(parent);
1142 printk(KERN_CONT ");\n");
1143 printk(" lock(");
1144 __print_lock_name(target);
1145 printk(KERN_CONT ");\n");
1146 printk(" lock(");
1147 __print_lock_name(source);
1148 printk(KERN_CONT ");\n");
1149 printk("\n *** DEADLOCK ***\n\n");
Steven Rostedtf4185812011-04-20 21:41:55 -04001150}
1151
Peter Zijlstra8e182572007-07-19 01:48:54 -07001152/*
1153 * When a circular dependency is detected, print the
1154 * header first:
1155 */
1156static noinline int
Ming Leidb0002a2009-07-16 15:44:29 +02001157print_circular_bug_header(struct lock_list *entry, unsigned int depth,
1158 struct held_lock *check_src,
1159 struct held_lock *check_tgt)
Peter Zijlstra8e182572007-07-19 01:48:54 -07001160{
1161 struct task_struct *curr = current;
1162
Ming Leic94aa5c2009-07-16 15:44:29 +02001163 if (debug_locks_silent)
Peter Zijlstra8e182572007-07-19 01:48:54 -07001164 return 0;
1165
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001166 pr_warn("\n");
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08001167 pr_warn("======================================================\n");
1168 pr_warn("WARNING: possible circular locking dependency detected\n");
Ben Hutchingsfbdc4b92011-10-28 04:36:55 +01001169 print_kernel_ident();
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08001170 pr_warn("------------------------------------------------------\n");
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001171 pr_warn("%s/%d is trying to acquire lock:\n",
Pavel Emelyanovba25f9d2007-10-18 23:40:40 -07001172 curr->comm, task_pid_nr(curr));
Ming Leidb0002a2009-07-16 15:44:29 +02001173 print_lock(check_src);
Byungchul Park383a4bc2017-08-07 16:12:55 +09001174
Ingo Molnare966eae2017-12-12 12:31:16 +01001175 pr_warn("\nbut task is already holding lock:\n");
Byungchul Park383a4bc2017-08-07 16:12:55 +09001176
Ming Leidb0002a2009-07-16 15:44:29 +02001177 print_lock(check_tgt);
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001178 pr_warn("\nwhich lock already depends on the new lock.\n\n");
1179 pr_warn("\nthe existing dependency chain (in reverse order) is:\n");
Peter Zijlstra8e182572007-07-19 01:48:54 -07001180
1181 print_circular_bug_entry(entry, depth);
1182
1183 return 0;
1184}
1185
Ming Lei9e2d5512009-07-16 15:44:29 +02001186static inline int class_equal(struct lock_list *entry, void *data)
1187{
1188 return entry->class == data;
1189}
1190
Ming Leidb0002a2009-07-16 15:44:29 +02001191static noinline int print_circular_bug(struct lock_list *this,
1192 struct lock_list *target,
1193 struct held_lock *check_src,
Byungchul Park383a4bc2017-08-07 16:12:55 +09001194 struct held_lock *check_tgt,
1195 struct stack_trace *trace)
Peter Zijlstra8e182572007-07-19 01:48:54 -07001196{
1197 struct task_struct *curr = current;
Ming Leic94aa5c2009-07-16 15:44:29 +02001198 struct lock_list *parent;
Steven Rostedtf4185812011-04-20 21:41:55 -04001199 struct lock_list *first_parent;
Ming Lei24208ca2009-07-16 15:44:29 +02001200 int depth;
Peter Zijlstra8e182572007-07-19 01:48:54 -07001201
Ming Leic94aa5c2009-07-16 15:44:29 +02001202 if (!debug_locks_off_graph_unlock() || debug_locks_silent)
Peter Zijlstra8e182572007-07-19 01:48:54 -07001203 return 0;
1204
Ingo Molnare966eae2017-12-12 12:31:16 +01001205 if (!save_trace(&this->trace))
Peter Zijlstra8e182572007-07-19 01:48:54 -07001206 return 0;
1207
Ming Leic94aa5c2009-07-16 15:44:29 +02001208 depth = get_lock_depth(target);
1209
Ming Leidb0002a2009-07-16 15:44:29 +02001210 print_circular_bug_header(target, depth, check_src, check_tgt);
Ming Leic94aa5c2009-07-16 15:44:29 +02001211
1212 parent = get_lock_parent(target);
Steven Rostedtf4185812011-04-20 21:41:55 -04001213 first_parent = parent;
Ming Leic94aa5c2009-07-16 15:44:29 +02001214
1215 while (parent) {
1216 print_circular_bug_entry(parent, --depth);
1217 parent = get_lock_parent(parent);
1218 }
Peter Zijlstra8e182572007-07-19 01:48:54 -07001219
1220 printk("\nother info that might help us debug this:\n\n");
Steven Rostedtf4185812011-04-20 21:41:55 -04001221 print_circular_lock_scenario(check_src, check_tgt,
1222 first_parent);
1223
Peter Zijlstra8e182572007-07-19 01:48:54 -07001224 lockdep_print_held_locks(curr);
1225
1226 printk("\nstack backtrace:\n");
1227 dump_stack();
1228
1229 return 0;
1230}
1231
Ming Leidb0002a2009-07-16 15:44:29 +02001232static noinline int print_bfs_bug(int ret)
1233{
1234 if (!debug_locks_off_graph_unlock())
1235 return 0;
1236
Peter Zijlstra0119fee2011-09-02 01:30:29 +02001237 /*
1238 * Breadth-first-search failed, graph got corrupted?
1239 */
Ming Leidb0002a2009-07-16 15:44:29 +02001240 WARN(1, "lockdep bfs error:%d\n", ret);
1241
1242 return 0;
1243}
1244
Ming Leief681022009-07-16 15:44:29 +02001245static int noop_count(struct lock_list *entry, void *data)
David Miller419ca3f2008-07-29 21:45:03 -07001246{
Ming Leief681022009-07-16 15:44:29 +02001247 (*(unsigned long *)data)++;
1248 return 0;
David Miller419ca3f2008-07-29 21:45:03 -07001249}
1250
Fengguang Wu5216d532013-11-09 00:55:35 +08001251static unsigned long __lockdep_count_forward_deps(struct lock_list *this)
Ming Leief681022009-07-16 15:44:29 +02001252{
1253 unsigned long count = 0;
1254 struct lock_list *uninitialized_var(target_entry);
1255
1256 __bfs_forwards(this, (void *)&count, noop_count, &target_entry);
1257
1258 return count;
1259}
David Miller419ca3f2008-07-29 21:45:03 -07001260unsigned long lockdep_count_forward_deps(struct lock_class *class)
1261{
1262 unsigned long ret, flags;
Ming Leief681022009-07-16 15:44:29 +02001263 struct lock_list this;
1264
1265 this.parent = NULL;
1266 this.class = class;
David Miller419ca3f2008-07-29 21:45:03 -07001267
1268 local_irq_save(flags);
Thomas Gleixner0199c4e2009-12-02 20:01:25 +01001269 arch_spin_lock(&lockdep_lock);
Ming Leief681022009-07-16 15:44:29 +02001270 ret = __lockdep_count_forward_deps(&this);
Thomas Gleixner0199c4e2009-12-02 20:01:25 +01001271 arch_spin_unlock(&lockdep_lock);
David Miller419ca3f2008-07-29 21:45:03 -07001272 local_irq_restore(flags);
1273
1274 return ret;
1275}
1276
Fengguang Wu5216d532013-11-09 00:55:35 +08001277static unsigned long __lockdep_count_backward_deps(struct lock_list *this)
David Miller419ca3f2008-07-29 21:45:03 -07001278{
Ming Leief681022009-07-16 15:44:29 +02001279 unsigned long count = 0;
1280 struct lock_list *uninitialized_var(target_entry);
David Miller419ca3f2008-07-29 21:45:03 -07001281
Ming Leief681022009-07-16 15:44:29 +02001282 __bfs_backwards(this, (void *)&count, noop_count, &target_entry);
David Miller419ca3f2008-07-29 21:45:03 -07001283
Ming Leief681022009-07-16 15:44:29 +02001284 return count;
David Miller419ca3f2008-07-29 21:45:03 -07001285}
1286
1287unsigned long lockdep_count_backward_deps(struct lock_class *class)
1288{
1289 unsigned long ret, flags;
Ming Leief681022009-07-16 15:44:29 +02001290 struct lock_list this;
1291
1292 this.parent = NULL;
1293 this.class = class;
David Miller419ca3f2008-07-29 21:45:03 -07001294
1295 local_irq_save(flags);
Thomas Gleixner0199c4e2009-12-02 20:01:25 +01001296 arch_spin_lock(&lockdep_lock);
Ming Leief681022009-07-16 15:44:29 +02001297 ret = __lockdep_count_backward_deps(&this);
Thomas Gleixner0199c4e2009-12-02 20:01:25 +01001298 arch_spin_unlock(&lockdep_lock);
David Miller419ca3f2008-07-29 21:45:03 -07001299 local_irq_restore(flags);
1300
1301 return ret;
1302}
1303
Peter Zijlstra8e182572007-07-19 01:48:54 -07001304/*
1305 * Prove that the dependency graph starting at <entry> can not
1306 * lead to <target>. Print an error and return 0 if it does.
1307 */
1308static noinline int
Ming Leidb0002a2009-07-16 15:44:29 +02001309check_noncircular(struct lock_list *root, struct lock_class *target,
1310 struct lock_list **target_entry)
Peter Zijlstra8e182572007-07-19 01:48:54 -07001311{
Ming Leidb0002a2009-07-16 15:44:29 +02001312 int result;
Peter Zijlstra8e182572007-07-19 01:48:54 -07001313
Frederic Weisbeckerbd6d29c2010-04-06 00:10:17 +02001314 debug_atomic_inc(nr_cyclic_checks);
David Miller419ca3f2008-07-29 21:45:03 -07001315
Ming Leid7aaba12009-07-16 15:44:29 +02001316 result = __bfs_forwards(root, target, class_equal, target_entry);
Ming Leidb0002a2009-07-16 15:44:29 +02001317
1318 return result;
Peter Zijlstra8e182572007-07-19 01:48:54 -07001319}
1320
Peter Zijlstraae813302017-03-03 10:13:38 +01001321static noinline int
1322check_redundant(struct lock_list *root, struct lock_class *target,
1323 struct lock_list **target_entry)
1324{
1325 int result;
1326
1327 debug_atomic_inc(nr_redundant_checks);
1328
1329 result = __bfs_forwards(root, target, class_equal, target_entry);
1330
1331 return result;
1332}
1333
Steven Rostedt81d68a92008-05-12 21:20:42 +02001334#if defined(CONFIG_TRACE_IRQFLAGS) && defined(CONFIG_PROVE_LOCKING)
Peter Zijlstra8e182572007-07-19 01:48:54 -07001335/*
1336 * Forwards and backwards subgraph searching, for the purposes of
1337 * proving that two subgraphs can be connected by a new dependency
1338 * without creating any illegal irq-safe -> irq-unsafe lock dependency.
1339 */
Peter Zijlstra8e182572007-07-19 01:48:54 -07001340
Ming Leid7aaba12009-07-16 15:44:29 +02001341static inline int usage_match(struct lock_list *entry, void *bit)
1342{
1343 return entry->class->usage_mask & (1 << (enum lock_usage_bit)bit);
1344}
1345
1346
1347
Peter Zijlstra8e182572007-07-19 01:48:54 -07001348/*
1349 * Find a node in the forwards-direction dependency sub-graph starting
Ming Leid7aaba12009-07-16 15:44:29 +02001350 * at @root->class that matches @bit.
Peter Zijlstra8e182572007-07-19 01:48:54 -07001351 *
Ming Leid7aaba12009-07-16 15:44:29 +02001352 * Return 0 if such a node exists in the subgraph, and put that node
1353 * into *@target_entry.
Peter Zijlstra8e182572007-07-19 01:48:54 -07001354 *
Ming Leid7aaba12009-07-16 15:44:29 +02001355 * Return 1 otherwise and keep *@target_entry unchanged.
1356 * Return <0 on error.
Peter Zijlstra8e182572007-07-19 01:48:54 -07001357 */
Ming Leid7aaba12009-07-16 15:44:29 +02001358static int
1359find_usage_forwards(struct lock_list *root, enum lock_usage_bit bit,
1360 struct lock_list **target_entry)
Peter Zijlstra8e182572007-07-19 01:48:54 -07001361{
Ming Leid7aaba12009-07-16 15:44:29 +02001362 int result;
Peter Zijlstra8e182572007-07-19 01:48:54 -07001363
Frederic Weisbeckerbd6d29c2010-04-06 00:10:17 +02001364 debug_atomic_inc(nr_find_usage_forwards_checks);
Peter Zijlstra8e182572007-07-19 01:48:54 -07001365
Ming Leid7aaba12009-07-16 15:44:29 +02001366 result = __bfs_forwards(root, (void *)bit, usage_match, target_entry);
1367
1368 return result;
Peter Zijlstra8e182572007-07-19 01:48:54 -07001369}
1370
1371/*
1372 * Find a node in the backwards-direction dependency sub-graph starting
Ming Leid7aaba12009-07-16 15:44:29 +02001373 * at @root->class that matches @bit.
Peter Zijlstra8e182572007-07-19 01:48:54 -07001374 *
Ming Leid7aaba12009-07-16 15:44:29 +02001375 * Return 0 if such a node exists in the subgraph, and put that node
1376 * into *@target_entry.
Peter Zijlstra8e182572007-07-19 01:48:54 -07001377 *
Ming Leid7aaba12009-07-16 15:44:29 +02001378 * Return 1 otherwise and keep *@target_entry unchanged.
1379 * Return <0 on error.
Peter Zijlstra8e182572007-07-19 01:48:54 -07001380 */
Ming Leid7aaba12009-07-16 15:44:29 +02001381static int
1382find_usage_backwards(struct lock_list *root, enum lock_usage_bit bit,
1383 struct lock_list **target_entry)
Peter Zijlstra8e182572007-07-19 01:48:54 -07001384{
Ming Leid7aaba12009-07-16 15:44:29 +02001385 int result;
Peter Zijlstra8e182572007-07-19 01:48:54 -07001386
Frederic Weisbeckerbd6d29c2010-04-06 00:10:17 +02001387 debug_atomic_inc(nr_find_usage_backwards_checks);
Peter Zijlstra8e182572007-07-19 01:48:54 -07001388
Ming Leid7aaba12009-07-16 15:44:29 +02001389 result = __bfs_backwards(root, (void *)bit, usage_match, target_entry);
Dave Jonesf82b2172008-08-11 09:30:23 +02001390
Ming Leid7aaba12009-07-16 15:44:29 +02001391 return result;
Peter Zijlstra8e182572007-07-19 01:48:54 -07001392}
1393
Peter Zijlstraaf012962009-07-16 15:44:29 +02001394static void print_lock_class_header(struct lock_class *class, int depth)
1395{
1396 int bit;
1397
1398 printk("%*s->", depth, "");
1399 print_lock_name(class);
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01001400 printk(KERN_CONT " ops: %lu", class->ops);
1401 printk(KERN_CONT " {\n");
Peter Zijlstraaf012962009-07-16 15:44:29 +02001402
1403 for (bit = 0; bit < LOCK_USAGE_STATES; bit++) {
1404 if (class->usage_mask & (1 << bit)) {
1405 int len = depth;
1406
1407 len += printk("%*s %s", depth, "", usage_str[bit]);
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01001408 len += printk(KERN_CONT " at:\n");
Peter Zijlstraaf012962009-07-16 15:44:29 +02001409 print_stack_trace(class->usage_traces + bit, len);
1410 }
1411 }
1412 printk("%*s }\n", depth, "");
1413
Borislav Petkov04860d42018-02-26 14:49:26 +01001414 printk("%*s ... key at: [<%px>] %pS\n",
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01001415 depth, "", class->key, class->key);
Peter Zijlstraaf012962009-07-16 15:44:29 +02001416}
1417
1418/*
1419 * printk the shortest lock dependencies from @start to @end in reverse order:
1420 */
1421static void __used
1422print_shortest_lock_dependencies(struct lock_list *leaf,
1423 struct lock_list *root)
1424{
1425 struct lock_list *entry = leaf;
1426 int depth;
1427
1428 /*compute depth from generated tree by BFS*/
1429 depth = get_lock_depth(leaf);
1430
1431 do {
1432 print_lock_class_header(entry->class, depth);
1433 printk("%*s ... acquired at:\n", depth, "");
1434 print_stack_trace(&entry->trace, 2);
1435 printk("\n");
1436
1437 if (depth == 0 && (entry != root)) {
Steven Rostedt6be8c392011-04-20 21:41:58 -04001438 printk("lockdep:%s bad path found in chain graph\n", __func__);
Peter Zijlstraaf012962009-07-16 15:44:29 +02001439 break;
1440 }
1441
1442 entry = get_lock_parent(entry);
1443 depth--;
1444 } while (entry && (depth >= 0));
1445
1446 return;
1447}
Ming Leid7aaba12009-07-16 15:44:29 +02001448
Steven Rostedt3003eba2011-04-20 21:41:54 -04001449static void
1450print_irq_lock_scenario(struct lock_list *safe_entry,
1451 struct lock_list *unsafe_entry,
Steven Rostedtdad3d742011-04-20 21:41:57 -04001452 struct lock_class *prev_class,
1453 struct lock_class *next_class)
Steven Rostedt3003eba2011-04-20 21:41:54 -04001454{
1455 struct lock_class *safe_class = safe_entry->class;
1456 struct lock_class *unsafe_class = unsafe_entry->class;
Steven Rostedtdad3d742011-04-20 21:41:57 -04001457 struct lock_class *middle_class = prev_class;
Steven Rostedt3003eba2011-04-20 21:41:54 -04001458
1459 if (middle_class == safe_class)
Steven Rostedtdad3d742011-04-20 21:41:57 -04001460 middle_class = next_class;
Steven Rostedt3003eba2011-04-20 21:41:54 -04001461
1462 /*
1463 * A direct locking problem where unsafe_class lock is taken
1464 * directly by safe_class lock, then all we need to show
1465 * is the deadlock scenario, as it is obvious that the
1466 * unsafe lock is taken under the safe lock.
1467 *
1468 * But if there is a chain instead, where the safe lock takes
1469 * an intermediate lock (middle_class) where this lock is
1470 * not the same as the safe lock, then the lock chain is
1471 * used to describe the problem. Otherwise we would need
1472 * to show a different CPU case for each link in the chain
1473 * from the safe_class lock to the unsafe_class lock.
1474 */
1475 if (middle_class != unsafe_class) {
1476 printk("Chain exists of:\n ");
1477 __print_lock_name(safe_class);
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01001478 printk(KERN_CONT " --> ");
Steven Rostedt3003eba2011-04-20 21:41:54 -04001479 __print_lock_name(middle_class);
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01001480 printk(KERN_CONT " --> ");
Steven Rostedt3003eba2011-04-20 21:41:54 -04001481 __print_lock_name(unsafe_class);
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01001482 printk(KERN_CONT "\n\n");
Steven Rostedt3003eba2011-04-20 21:41:54 -04001483 }
1484
1485 printk(" Possible interrupt unsafe locking scenario:\n\n");
1486 printk(" CPU0 CPU1\n");
1487 printk(" ---- ----\n");
1488 printk(" lock(");
1489 __print_lock_name(unsafe_class);
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01001490 printk(KERN_CONT ");\n");
Steven Rostedt3003eba2011-04-20 21:41:54 -04001491 printk(" local_irq_disable();\n");
1492 printk(" lock(");
1493 __print_lock_name(safe_class);
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01001494 printk(KERN_CONT ");\n");
Steven Rostedt3003eba2011-04-20 21:41:54 -04001495 printk(" lock(");
1496 __print_lock_name(middle_class);
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01001497 printk(KERN_CONT ");\n");
Steven Rostedt3003eba2011-04-20 21:41:54 -04001498 printk(" <Interrupt>\n");
1499 printk(" lock(");
1500 __print_lock_name(safe_class);
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01001501 printk(KERN_CONT ");\n");
Steven Rostedt3003eba2011-04-20 21:41:54 -04001502 printk("\n *** DEADLOCK ***\n\n");
1503}
1504
Peter Zijlstra8e182572007-07-19 01:48:54 -07001505static int
1506print_bad_irq_dependency(struct task_struct *curr,
Ming Lei24208ca2009-07-16 15:44:29 +02001507 struct lock_list *prev_root,
1508 struct lock_list *next_root,
1509 struct lock_list *backwards_entry,
1510 struct lock_list *forwards_entry,
Peter Zijlstra8e182572007-07-19 01:48:54 -07001511 struct held_lock *prev,
1512 struct held_lock *next,
1513 enum lock_usage_bit bit1,
1514 enum lock_usage_bit bit2,
1515 const char *irqclass)
1516{
1517 if (!debug_locks_off_graph_unlock() || debug_locks_silent)
1518 return 0;
1519
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001520 pr_warn("\n");
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08001521 pr_warn("=====================================================\n");
1522 pr_warn("WARNING: %s-safe -> %s-unsafe lock order detected\n",
Peter Zijlstra8e182572007-07-19 01:48:54 -07001523 irqclass, irqclass);
Ben Hutchingsfbdc4b92011-10-28 04:36:55 +01001524 print_kernel_ident();
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08001525 pr_warn("-----------------------------------------------------\n");
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001526 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 -07001527 curr->comm, task_pid_nr(curr),
Peter Zijlstra8e182572007-07-19 01:48:54 -07001528 curr->hardirq_context, hardirq_count() >> HARDIRQ_SHIFT,
1529 curr->softirq_context, softirq_count() >> SOFTIRQ_SHIFT,
1530 curr->hardirqs_enabled,
1531 curr->softirqs_enabled);
1532 print_lock(next);
1533
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001534 pr_warn("\nand this task is already holding:\n");
Peter Zijlstra8e182572007-07-19 01:48:54 -07001535 print_lock(prev);
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001536 pr_warn("which would create a new lock dependency:\n");
Dave Jonesf82b2172008-08-11 09:30:23 +02001537 print_lock_name(hlock_class(prev));
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001538 pr_cont(" ->");
Dave Jonesf82b2172008-08-11 09:30:23 +02001539 print_lock_name(hlock_class(next));
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001540 pr_cont("\n");
Peter Zijlstra8e182572007-07-19 01:48:54 -07001541
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001542 pr_warn("\nbut this new dependency connects a %s-irq-safe lock:\n",
Peter Zijlstra8e182572007-07-19 01:48:54 -07001543 irqclass);
Ming Lei24208ca2009-07-16 15:44:29 +02001544 print_lock_name(backwards_entry->class);
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001545 pr_warn("\n... which became %s-irq-safe at:\n", irqclass);
Peter Zijlstra8e182572007-07-19 01:48:54 -07001546
Ming Lei24208ca2009-07-16 15:44:29 +02001547 print_stack_trace(backwards_entry->class->usage_traces + bit1, 1);
Peter Zijlstra8e182572007-07-19 01:48:54 -07001548
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001549 pr_warn("\nto a %s-irq-unsafe lock:\n", irqclass);
Ming Lei24208ca2009-07-16 15:44:29 +02001550 print_lock_name(forwards_entry->class);
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001551 pr_warn("\n... which became %s-irq-unsafe at:\n", irqclass);
1552 pr_warn("...");
Peter Zijlstra8e182572007-07-19 01:48:54 -07001553
Ming Lei24208ca2009-07-16 15:44:29 +02001554 print_stack_trace(forwards_entry->class->usage_traces + bit2, 1);
Peter Zijlstra8e182572007-07-19 01:48:54 -07001555
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001556 pr_warn("\nother info that might help us debug this:\n\n");
Steven Rostedtdad3d742011-04-20 21:41:57 -04001557 print_irq_lock_scenario(backwards_entry, forwards_entry,
1558 hlock_class(prev), hlock_class(next));
Steven Rostedt3003eba2011-04-20 21:41:54 -04001559
Peter Zijlstra8e182572007-07-19 01:48:54 -07001560 lockdep_print_held_locks(curr);
1561
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001562 pr_warn("\nthe dependencies between %s-irq-safe lock and the holding lock:\n", irqclass);
Ming Lei24208ca2009-07-16 15:44:29 +02001563 if (!save_trace(&prev_root->trace))
1564 return 0;
1565 print_shortest_lock_dependencies(backwards_entry, prev_root);
Peter Zijlstra8e182572007-07-19 01:48:54 -07001566
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001567 pr_warn("\nthe dependencies between the lock to be acquired");
1568 pr_warn(" and %s-irq-unsafe lock:\n", irqclass);
Ming Lei24208ca2009-07-16 15:44:29 +02001569 if (!save_trace(&next_root->trace))
1570 return 0;
1571 print_shortest_lock_dependencies(forwards_entry, next_root);
Peter Zijlstra8e182572007-07-19 01:48:54 -07001572
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001573 pr_warn("\nstack backtrace:\n");
Peter Zijlstra8e182572007-07-19 01:48:54 -07001574 dump_stack();
1575
1576 return 0;
1577}
1578
1579static int
1580check_usage(struct task_struct *curr, struct held_lock *prev,
1581 struct held_lock *next, enum lock_usage_bit bit_backwards,
1582 enum lock_usage_bit bit_forwards, const char *irqclass)
1583{
1584 int ret;
Ming Lei24208ca2009-07-16 15:44:29 +02001585 struct lock_list this, that;
Ming Leid7aaba12009-07-16 15:44:29 +02001586 struct lock_list *uninitialized_var(target_entry);
Ming Lei24208ca2009-07-16 15:44:29 +02001587 struct lock_list *uninitialized_var(target_entry1);
Peter Zijlstra8e182572007-07-19 01:48:54 -07001588
Ming Leid7aaba12009-07-16 15:44:29 +02001589 this.parent = NULL;
Peter Zijlstra8e182572007-07-19 01:48:54 -07001590
Ming Leid7aaba12009-07-16 15:44:29 +02001591 this.class = hlock_class(prev);
1592 ret = find_usage_backwards(&this, bit_backwards, &target_entry);
Peter Zijlstraaf012962009-07-16 15:44:29 +02001593 if (ret < 0)
1594 return print_bfs_bug(ret);
1595 if (ret == 1)
1596 return ret;
Ming Leid7aaba12009-07-16 15:44:29 +02001597
Ming Lei24208ca2009-07-16 15:44:29 +02001598 that.parent = NULL;
1599 that.class = hlock_class(next);
1600 ret = find_usage_forwards(&that, bit_forwards, &target_entry1);
Peter Zijlstraaf012962009-07-16 15:44:29 +02001601 if (ret < 0)
1602 return print_bfs_bug(ret);
1603 if (ret == 1)
1604 return ret;
Ming Leid7aaba12009-07-16 15:44:29 +02001605
Ming Lei24208ca2009-07-16 15:44:29 +02001606 return print_bad_irq_dependency(curr, &this, &that,
1607 target_entry, target_entry1,
1608 prev, next,
Peter Zijlstra8e182572007-07-19 01:48:54 -07001609 bit_backwards, bit_forwards, irqclass);
1610}
1611
Peter Zijlstra4f367d8a2009-01-22 18:10:42 +01001612static const char *state_names[] = {
1613#define LOCKDEP_STATE(__STATE) \
Peter Zijlstrab4b136f2009-01-29 14:50:36 +01001614 __stringify(__STATE),
Peter Zijlstra4f367d8a2009-01-22 18:10:42 +01001615#include "lockdep_states.h"
1616#undef LOCKDEP_STATE
1617};
1618
1619static const char *state_rnames[] = {
1620#define LOCKDEP_STATE(__STATE) \
Peter Zijlstrab4b136f2009-01-29 14:50:36 +01001621 __stringify(__STATE)"-READ",
Peter Zijlstra4f367d8a2009-01-22 18:10:42 +01001622#include "lockdep_states.h"
1623#undef LOCKDEP_STATE
1624};
1625
1626static inline const char *state_name(enum lock_usage_bit bit)
1627{
1628 return (bit & 1) ? state_rnames[bit >> 2] : state_names[bit >> 2];
1629}
1630
1631static int exclusive_bit(int new_bit)
1632{
1633 /*
1634 * USED_IN
1635 * USED_IN_READ
1636 * ENABLED
1637 * ENABLED_READ
1638 *
1639 * bit 0 - write/read
1640 * bit 1 - used_in/enabled
1641 * bit 2+ state
1642 */
1643
1644 int state = new_bit & ~3;
1645 int dir = new_bit & 2;
1646
1647 /*
1648 * keep state, bit flip the direction and strip read.
1649 */
1650 return state | (dir ^ 2);
1651}
1652
1653static int check_irq_usage(struct task_struct *curr, struct held_lock *prev,
1654 struct held_lock *next, enum lock_usage_bit bit)
Peter Zijlstra8e182572007-07-19 01:48:54 -07001655{
1656 /*
1657 * Prove that the new dependency does not connect a hardirq-safe
1658 * lock with a hardirq-unsafe lock - to achieve this we search
1659 * the backwards-subgraph starting at <prev>, and the
1660 * forwards-subgraph starting at <next>:
1661 */
Peter Zijlstra4f367d8a2009-01-22 18:10:42 +01001662 if (!check_usage(curr, prev, next, bit,
1663 exclusive_bit(bit), state_name(bit)))
Peter Zijlstra8e182572007-07-19 01:48:54 -07001664 return 0;
1665
Peter Zijlstra4f367d8a2009-01-22 18:10:42 +01001666 bit++; /* _READ */
1667
Peter Zijlstra8e182572007-07-19 01:48:54 -07001668 /*
1669 * Prove that the new dependency does not connect a hardirq-safe-read
1670 * lock with a hardirq-unsafe lock - to achieve this we search
1671 * the backwards-subgraph starting at <prev>, and the
1672 * forwards-subgraph starting at <next>:
1673 */
Peter Zijlstra4f367d8a2009-01-22 18:10:42 +01001674 if (!check_usage(curr, prev, next, bit,
1675 exclusive_bit(bit), state_name(bit)))
Peter Zijlstra8e182572007-07-19 01:48:54 -07001676 return 0;
1677
Peter Zijlstra4f367d8a2009-01-22 18:10:42 +01001678 return 1;
1679}
Peter Zijlstra8e182572007-07-19 01:48:54 -07001680
Peter Zijlstra4f367d8a2009-01-22 18:10:42 +01001681static int
1682check_prev_add_irq(struct task_struct *curr, struct held_lock *prev,
1683 struct held_lock *next)
1684{
1685#define LOCKDEP_STATE(__STATE) \
1686 if (!check_irq_usage(curr, prev, next, LOCK_USED_IN_##__STATE)) \
Nick Piggincf40bd12009-01-21 08:12:39 +01001687 return 0;
Peter Zijlstra4f367d8a2009-01-22 18:10:42 +01001688#include "lockdep_states.h"
1689#undef LOCKDEP_STATE
Nick Piggincf40bd12009-01-21 08:12:39 +01001690
Peter Zijlstra8e182572007-07-19 01:48:54 -07001691 return 1;
1692}
1693
1694static void inc_chains(void)
1695{
1696 if (current->hardirq_context)
1697 nr_hardirq_chains++;
1698 else {
1699 if (current->softirq_context)
1700 nr_softirq_chains++;
1701 else
1702 nr_process_chains++;
1703 }
1704}
1705
1706#else
1707
1708static inline int
1709check_prev_add_irq(struct task_struct *curr, struct held_lock *prev,
1710 struct held_lock *next)
1711{
1712 return 1;
1713}
1714
1715static inline void inc_chains(void)
1716{
1717 nr_process_chains++;
1718}
1719
1720#endif
1721
Steven Rostedt48702ec2011-04-20 21:41:56 -04001722static void
1723print_deadlock_scenario(struct held_lock *nxt,
1724 struct held_lock *prv)
1725{
1726 struct lock_class *next = hlock_class(nxt);
1727 struct lock_class *prev = hlock_class(prv);
1728
1729 printk(" Possible unsafe locking scenario:\n\n");
1730 printk(" CPU0\n");
1731 printk(" ----\n");
1732 printk(" lock(");
1733 __print_lock_name(prev);
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01001734 printk(KERN_CONT ");\n");
Steven Rostedt48702ec2011-04-20 21:41:56 -04001735 printk(" lock(");
1736 __print_lock_name(next);
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01001737 printk(KERN_CONT ");\n");
Steven Rostedt48702ec2011-04-20 21:41:56 -04001738 printk("\n *** DEADLOCK ***\n\n");
1739 printk(" May be due to missing lock nesting notation\n\n");
1740}
1741
Peter Zijlstra8e182572007-07-19 01:48:54 -07001742static int
1743print_deadlock_bug(struct task_struct *curr, struct held_lock *prev,
1744 struct held_lock *next)
1745{
1746 if (!debug_locks_off_graph_unlock() || debug_locks_silent)
1747 return 0;
1748
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001749 pr_warn("\n");
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08001750 pr_warn("============================================\n");
1751 pr_warn("WARNING: possible recursive locking detected\n");
Ben Hutchingsfbdc4b92011-10-28 04:36:55 +01001752 print_kernel_ident();
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08001753 pr_warn("--------------------------------------------\n");
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001754 pr_warn("%s/%d is trying to acquire lock:\n",
Pavel Emelyanovba25f9d2007-10-18 23:40:40 -07001755 curr->comm, task_pid_nr(curr));
Peter Zijlstra8e182572007-07-19 01:48:54 -07001756 print_lock(next);
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001757 pr_warn("\nbut task is already holding lock:\n");
Peter Zijlstra8e182572007-07-19 01:48:54 -07001758 print_lock(prev);
1759
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001760 pr_warn("\nother info that might help us debug this:\n");
Steven Rostedt48702ec2011-04-20 21:41:56 -04001761 print_deadlock_scenario(next, prev);
Peter Zijlstra8e182572007-07-19 01:48:54 -07001762 lockdep_print_held_locks(curr);
1763
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001764 pr_warn("\nstack backtrace:\n");
Peter Zijlstra8e182572007-07-19 01:48:54 -07001765 dump_stack();
1766
1767 return 0;
1768}
1769
1770/*
1771 * Check whether we are holding such a class already.
1772 *
1773 * (Note that this has to be done separately, because the graph cannot
1774 * detect such classes of deadlocks.)
1775 *
1776 * Returns: 0 on deadlock detected, 1 on OK, 2 on recursive read
1777 */
1778static int
1779check_deadlock(struct task_struct *curr, struct held_lock *next,
1780 struct lockdep_map *next_instance, int read)
1781{
1782 struct held_lock *prev;
Peter Zijlstra7531e2f2008-08-11 09:30:24 +02001783 struct held_lock *nest = NULL;
Peter Zijlstra8e182572007-07-19 01:48:54 -07001784 int i;
1785
1786 for (i = 0; i < curr->lockdep_depth; i++) {
1787 prev = curr->held_locks + i;
Peter Zijlstra7531e2f2008-08-11 09:30:24 +02001788
1789 if (prev->instance == next->nest_lock)
1790 nest = prev;
1791
Dave Jonesf82b2172008-08-11 09:30:23 +02001792 if (hlock_class(prev) != hlock_class(next))
Peter Zijlstra8e182572007-07-19 01:48:54 -07001793 continue;
Peter Zijlstra7531e2f2008-08-11 09:30:24 +02001794
Peter Zijlstra8e182572007-07-19 01:48:54 -07001795 /*
1796 * Allow read-after-read recursion of the same
1797 * lock class (i.e. read_lock(lock)+read_lock(lock)):
1798 */
1799 if ((read == 2) && prev->read)
1800 return 2;
Peter Zijlstra7531e2f2008-08-11 09:30:24 +02001801
1802 /*
1803 * We're holding the nest_lock, which serializes this lock's
1804 * nesting behaviour.
1805 */
1806 if (nest)
1807 return 2;
1808
Peter Zijlstra8e182572007-07-19 01:48:54 -07001809 return print_deadlock_bug(curr, prev, next);
1810 }
1811 return 1;
1812}
1813
1814/*
1815 * There was a chain-cache miss, and we are about to add a new dependency
1816 * to a previous lock. We recursively validate the following rules:
1817 *
1818 * - would the adding of the <prev> -> <next> dependency create a
1819 * circular dependency in the graph? [== circular deadlock]
1820 *
1821 * - does the new prev->next dependency connect any hardirq-safe lock
1822 * (in the full backwards-subgraph starting at <prev>) with any
1823 * hardirq-unsafe lock (in the full forwards-subgraph starting at
1824 * <next>)? [== illegal lock inversion with hardirq contexts]
1825 *
1826 * - does the new prev->next dependency connect any softirq-safe lock
1827 * (in the full backwards-subgraph starting at <prev>) with any
1828 * softirq-unsafe lock (in the full forwards-subgraph starting at
1829 * <next>)? [== illegal lock inversion with softirq contexts]
1830 *
1831 * any of these scenarios could lead to a deadlock.
1832 *
1833 * Then if all the validations pass, we add the forwards and backwards
1834 * dependency.
1835 */
1836static int
1837check_prev_add(struct task_struct *curr, struct held_lock *prev,
Byungchul Parkce07a9412017-08-07 16:12:51 +09001838 struct held_lock *next, int distance, struct stack_trace *trace,
1839 int (*save)(struct stack_trace *trace))
Peter Zijlstra8e182572007-07-19 01:48:54 -07001840{
Ming Leidb0002a2009-07-16 15:44:29 +02001841 struct lock_list *uninitialized_var(target_entry);
Peter Zijlstra8b405d52017-10-04 11:13:37 +02001842 struct lock_list *entry;
1843 struct lock_list this;
1844 int ret;
Peter Zijlstra8e182572007-07-19 01:48:54 -07001845
1846 /*
1847 * Prove that the new <prev> -> <next> dependency would not
1848 * create a circular dependency in the graph. (We do this by
1849 * forward-recursing into the graph starting at <next>, and
1850 * checking whether we can reach <prev>.)
1851 *
1852 * We are using global variables to control the recursion, to
1853 * keep the stackframe size of the recursive functions low:
1854 */
Ming Leidb0002a2009-07-16 15:44:29 +02001855 this.class = hlock_class(next);
1856 this.parent = NULL;
1857 ret = check_noncircular(&this, hlock_class(prev), &target_entry);
Peter Zijlstra8b405d52017-10-04 11:13:37 +02001858 if (unlikely(!ret)) {
1859 if (!trace->entries) {
1860 /*
1861 * If @save fails here, the printing might trigger
1862 * a WARN but because of the !nr_entries it should
1863 * not do bad things.
1864 */
1865 save(trace);
1866 }
Byungchul Park383a4bc2017-08-07 16:12:55 +09001867 return print_circular_bug(&this, target_entry, next, prev, trace);
Peter Zijlstra8b405d52017-10-04 11:13:37 +02001868 }
Ming Leidb0002a2009-07-16 15:44:29 +02001869 else if (unlikely(ret < 0))
1870 return print_bfs_bug(ret);
Ming Leic94aa5c2009-07-16 15:44:29 +02001871
Peter Zijlstra8e182572007-07-19 01:48:54 -07001872 if (!check_prev_add_irq(curr, prev, next))
1873 return 0;
1874
1875 /*
1876 * For recursive read-locks we do all the dependency checks,
1877 * but we dont store read-triggered dependencies (only
1878 * write-triggered dependencies). This ensures that only the
1879 * write-side dependencies matter, and that if for example a
1880 * write-lock never takes any other locks, then the reads are
1881 * equivalent to a NOP.
1882 */
1883 if (next->read == 2 || prev->read == 2)
1884 return 1;
1885 /*
1886 * Is the <prev> -> <next> dependency already present?
1887 *
1888 * (this may occur even though this is a new chain: consider
1889 * e.g. the L1 -> L2 -> L3 -> L4 and the L5 -> L1 -> L2 -> L3
1890 * chains - the second one will be new, but L1 already has
1891 * L2 added to its dependency list, due to the first chain.)
1892 */
Dave Jonesf82b2172008-08-11 09:30:23 +02001893 list_for_each_entry(entry, &hlock_class(prev)->locks_after, entry) {
1894 if (entry->class == hlock_class(next)) {
Peter Zijlstra8e182572007-07-19 01:48:54 -07001895 if (distance == 1)
1896 entry->distance = 1;
Byungchul Park70911fd2017-08-07 16:12:50 +09001897 return 1;
Peter Zijlstra8e182572007-07-19 01:48:54 -07001898 }
1899 }
1900
Peter Zijlstraae813302017-03-03 10:13:38 +01001901 /*
1902 * Is the <prev> -> <next> link redundant?
1903 */
1904 this.class = hlock_class(prev);
1905 this.parent = NULL;
1906 ret = check_redundant(&this, hlock_class(next), &target_entry);
1907 if (!ret) {
1908 debug_atomic_inc(nr_redundant);
1909 return 2;
1910 }
1911 if (ret < 0)
1912 return print_bfs_bug(ret);
1913
1914
Peter Zijlstra8b405d52017-10-04 11:13:37 +02001915 if (!trace->entries && !save(trace))
Byungchul Parkce07a9412017-08-07 16:12:51 +09001916 return 0;
Yong Zhang4726f2a2010-05-04 14:16:48 +08001917
Peter Zijlstra8e182572007-07-19 01:48:54 -07001918 /*
1919 * Ok, all validations passed, add the new lock
1920 * to the previous lock's dependency list:
1921 */
Tahsin Erdogan83f06162016-11-08 00:02:07 -08001922 ret = add_lock_to_list(hlock_class(next),
Dave Jonesf82b2172008-08-11 09:30:23 +02001923 &hlock_class(prev)->locks_after,
Byungchul Parkce07a9412017-08-07 16:12:51 +09001924 next->acquire_ip, distance, trace);
Peter Zijlstra8e182572007-07-19 01:48:54 -07001925
1926 if (!ret)
1927 return 0;
1928
Tahsin Erdogan83f06162016-11-08 00:02:07 -08001929 ret = add_lock_to_list(hlock_class(prev),
Dave Jonesf82b2172008-08-11 09:30:23 +02001930 &hlock_class(next)->locks_before,
Byungchul Parkce07a9412017-08-07 16:12:51 +09001931 next->acquire_ip, distance, trace);
Peter Zijlstra8e182572007-07-19 01:48:54 -07001932 if (!ret)
1933 return 0;
1934
Byungchul Park70911fd2017-08-07 16:12:50 +09001935 return 2;
Peter Zijlstra8e182572007-07-19 01:48:54 -07001936}
1937
1938/*
1939 * Add the dependency to all directly-previous locks that are 'relevant'.
1940 * The ones that are relevant are (in increasing distance from curr):
1941 * all consecutive trylock entries and the final non-trylock entry - or
1942 * the end of this context's lock-chain - whichever comes first.
1943 */
1944static int
1945check_prevs_add(struct task_struct *curr, struct held_lock *next)
1946{
1947 int depth = curr->lockdep_depth;
1948 struct held_lock *hlock;
Peter Zijlstra8b405d52017-10-04 11:13:37 +02001949 struct stack_trace trace = {
1950 .nr_entries = 0,
1951 .max_entries = 0,
1952 .entries = NULL,
1953 .skip = 0,
1954 };
Peter Zijlstra8e182572007-07-19 01:48:54 -07001955
1956 /*
1957 * Debugging checks.
1958 *
1959 * Depth must not be zero for a non-head lock:
1960 */
1961 if (!depth)
1962 goto out_bug;
1963 /*
1964 * At least two relevant locks must exist for this
1965 * to be a head:
1966 */
1967 if (curr->held_locks[depth].irq_context !=
1968 curr->held_locks[depth-1].irq_context)
1969 goto out_bug;
1970
1971 for (;;) {
1972 int distance = curr->lockdep_depth - depth + 1;
Oleg Nesterov1b5ff812014-01-20 19:20:10 +01001973 hlock = curr->held_locks + depth - 1;
Byungchul Parkce07a9412017-08-07 16:12:51 +09001974
Ingo Molnare966eae2017-12-12 12:31:16 +01001975 /*
1976 * Only non-recursive-read entries get new dependencies
1977 * added:
1978 */
1979 if (hlock->read != 2 && hlock->check) {
1980 int ret = check_prev_add(curr, hlock, next, distance, &trace, save_trace);
1981 if (!ret)
1982 return 0;
1983
1984 /*
1985 * Stop after the first non-trylock entry,
1986 * as non-trylock entries have added their
1987 * own direct dependencies already, so this
1988 * lock is connected to them indirectly:
1989 */
1990 if (!hlock->trylock)
1991 break;
Peter Zijlstra8e182572007-07-19 01:48:54 -07001992 }
Ingo Molnare966eae2017-12-12 12:31:16 +01001993
Peter Zijlstra8e182572007-07-19 01:48:54 -07001994 depth--;
1995 /*
1996 * End of lock-stack?
1997 */
1998 if (!depth)
1999 break;
2000 /*
2001 * Stop the search if we cross into another context:
2002 */
2003 if (curr->held_locks[depth].irq_context !=
2004 curr->held_locks[depth-1].irq_context)
2005 break;
2006 }
2007 return 1;
2008out_bug:
2009 if (!debug_locks_off_graph_unlock())
2010 return 0;
2011
Peter Zijlstra0119fee2011-09-02 01:30:29 +02002012 /*
2013 * Clearly we all shouldn't be here, but since we made it we
2014 * can reliable say we messed up our state. See the above two
2015 * gotos for reasons why we could possibly end up here.
2016 */
Peter Zijlstra8e182572007-07-19 01:48:54 -07002017 WARN_ON(1);
2018
2019 return 0;
2020}
2021
2022unsigned long nr_lock_chains;
Huang, Ying443cd502008-06-20 16:39:21 +08002023struct lock_chain lock_chains[MAX_LOCKDEP_CHAINS];
Huang, Yingcd1a28e2008-06-23 11:20:54 +08002024int nr_chain_hlocks;
Huang, Ying443cd502008-06-20 16:39:21 +08002025static u16 chain_hlocks[MAX_LOCKDEP_CHAIN_HLOCKS];
2026
2027struct lock_class *lock_chain_get_class(struct lock_chain *chain, int i)
2028{
2029 return lock_classes + chain_hlocks[chain->base + i];
2030}
Peter Zijlstra8e182572007-07-19 01:48:54 -07002031
2032/*
Ingo Molnar9e4e7552016-02-29 10:03:58 +01002033 * Returns the index of the first held_lock of the current chain
2034 */
2035static inline int get_first_held_lock(struct task_struct *curr,
2036 struct held_lock *hlock)
2037{
2038 int i;
2039 struct held_lock *hlock_curr;
2040
2041 for (i = curr->lockdep_depth - 1; i >= 0; i--) {
2042 hlock_curr = curr->held_locks + i;
2043 if (hlock_curr->irq_context != hlock->irq_context)
2044 break;
2045
2046 }
2047
2048 return ++i;
2049}
2050
Borislav Petkov5c8a0102016-04-04 10:42:07 +02002051#ifdef CONFIG_DEBUG_LOCKDEP
Ingo Molnar9e4e7552016-02-29 10:03:58 +01002052/*
Alfredo Alvarez Fernandez39e2e172016-03-30 19:03:36 +02002053 * Returns the next chain_key iteration
2054 */
2055static u64 print_chain_key_iteration(int class_idx, u64 chain_key)
2056{
2057 u64 new_chain_key = iterate_chain_key(chain_key, class_idx);
2058
2059 printk(" class_idx:%d -> chain_key:%016Lx",
2060 class_idx,
2061 (unsigned long long)new_chain_key);
2062 return new_chain_key;
2063}
2064
2065static void
2066print_chain_keys_held_locks(struct task_struct *curr, struct held_lock *hlock_next)
2067{
2068 struct held_lock *hlock;
2069 u64 chain_key = 0;
2070 int depth = curr->lockdep_depth;
2071 int i;
2072
2073 printk("depth: %u\n", depth + 1);
2074 for (i = get_first_held_lock(curr, hlock_next); i < depth; i++) {
2075 hlock = curr->held_locks + i;
2076 chain_key = print_chain_key_iteration(hlock->class_idx, chain_key);
2077
2078 print_lock(hlock);
2079 }
2080
2081 print_chain_key_iteration(hlock_next->class_idx, chain_key);
2082 print_lock(hlock_next);
2083}
2084
2085static void print_chain_keys_chain(struct lock_chain *chain)
2086{
2087 int i;
2088 u64 chain_key = 0;
2089 int class_id;
2090
2091 printk("depth: %u\n", chain->depth);
2092 for (i = 0; i < chain->depth; i++) {
2093 class_id = chain_hlocks[chain->base + i];
2094 chain_key = print_chain_key_iteration(class_id + 1, chain_key);
2095
2096 print_lock_name(lock_classes + class_id);
2097 printk("\n");
2098 }
2099}
2100
2101static void print_collision(struct task_struct *curr,
2102 struct held_lock *hlock_next,
2103 struct lock_chain *chain)
2104{
Paul E. McKenney681fbec2017-05-04 15:44:38 -07002105 pr_warn("\n");
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08002106 pr_warn("============================\n");
2107 pr_warn("WARNING: chain_key collision\n");
Alfredo Alvarez Fernandez39e2e172016-03-30 19:03:36 +02002108 print_kernel_ident();
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08002109 pr_warn("----------------------------\n");
Paul E. McKenney681fbec2017-05-04 15:44:38 -07002110 pr_warn("%s/%d: ", current->comm, task_pid_nr(current));
2111 pr_warn("Hash chain already cached but the contents don't match!\n");
Alfredo Alvarez Fernandez39e2e172016-03-30 19:03:36 +02002112
Paul E. McKenney681fbec2017-05-04 15:44:38 -07002113 pr_warn("Held locks:");
Alfredo Alvarez Fernandez39e2e172016-03-30 19:03:36 +02002114 print_chain_keys_held_locks(curr, hlock_next);
2115
Paul E. McKenney681fbec2017-05-04 15:44:38 -07002116 pr_warn("Locks in cached chain:");
Alfredo Alvarez Fernandez39e2e172016-03-30 19:03:36 +02002117 print_chain_keys_chain(chain);
2118
Paul E. McKenney681fbec2017-05-04 15:44:38 -07002119 pr_warn("\nstack backtrace:\n");
Alfredo Alvarez Fernandez39e2e172016-03-30 19:03:36 +02002120 dump_stack();
2121}
Borislav Petkov5c8a0102016-04-04 10:42:07 +02002122#endif
Alfredo Alvarez Fernandez39e2e172016-03-30 19:03:36 +02002123
2124/*
Ingo Molnar9e4e7552016-02-29 10:03:58 +01002125 * Checks whether the chain and the current held locks are consistent
2126 * in depth and also in content. If they are not it most likely means
2127 * that there was a collision during the calculation of the chain_key.
2128 * Returns: 0 not passed, 1 passed
2129 */
2130static int check_no_collision(struct task_struct *curr,
2131 struct held_lock *hlock,
2132 struct lock_chain *chain)
2133{
2134#ifdef CONFIG_DEBUG_LOCKDEP
2135 int i, j, id;
2136
2137 i = get_first_held_lock(curr, hlock);
2138
Alfredo Alvarez Fernandez39e2e172016-03-30 19:03:36 +02002139 if (DEBUG_LOCKS_WARN_ON(chain->depth != curr->lockdep_depth - (i - 1))) {
2140 print_collision(curr, hlock, chain);
Ingo Molnar9e4e7552016-02-29 10:03:58 +01002141 return 0;
Alfredo Alvarez Fernandez39e2e172016-03-30 19:03:36 +02002142 }
Ingo Molnar9e4e7552016-02-29 10:03:58 +01002143
2144 for (j = 0; j < chain->depth - 1; j++, i++) {
2145 id = curr->held_locks[i].class_idx - 1;
2146
Alfredo Alvarez Fernandez39e2e172016-03-30 19:03:36 +02002147 if (DEBUG_LOCKS_WARN_ON(chain_hlocks[chain->base + j] != id)) {
2148 print_collision(curr, hlock, chain);
Ingo Molnar9e4e7552016-02-29 10:03:58 +01002149 return 0;
Alfredo Alvarez Fernandez39e2e172016-03-30 19:03:36 +02002150 }
Ingo Molnar9e4e7552016-02-29 10:03:58 +01002151 }
2152#endif
2153 return 1;
2154}
2155
2156/*
Byungchul Park49347a92017-08-07 16:12:49 +09002157 * This is for building a chain between just two different classes,
2158 * instead of adding a new hlock upon current, which is done by
2159 * add_chain_cache().
2160 *
2161 * This can be called in any context with two classes, while
2162 * add_chain_cache() must be done within the lock owener's context
2163 * since it uses hlock which might be racy in another context.
2164 */
2165static inline int add_chain_cache_classes(unsigned int prev,
2166 unsigned int next,
2167 unsigned int irq_context,
2168 u64 chain_key)
2169{
2170 struct hlist_head *hash_head = chainhashentry(chain_key);
2171 struct lock_chain *chain;
2172
2173 /*
2174 * Allocate a new chain entry from the static array, and add
2175 * it to the hash:
2176 */
2177
2178 /*
2179 * We might need to take the graph lock, ensure we've got IRQs
2180 * disabled to make this an IRQ-safe lock.. for recursion reasons
2181 * lockdep won't complain about its own locking errors.
2182 */
2183 if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
2184 return 0;
2185
2186 if (unlikely(nr_lock_chains >= MAX_LOCKDEP_CHAINS)) {
2187 if (!debug_locks_off_graph_unlock())
2188 return 0;
2189
2190 print_lockdep_off("BUG: MAX_LOCKDEP_CHAINS too low!");
2191 dump_stack();
2192 return 0;
2193 }
2194
2195 chain = lock_chains + nr_lock_chains++;
2196 chain->chain_key = chain_key;
2197 chain->irq_context = irq_context;
2198 chain->depth = 2;
2199 if (likely(nr_chain_hlocks + chain->depth <= MAX_LOCKDEP_CHAIN_HLOCKS)) {
2200 chain->base = nr_chain_hlocks;
2201 nr_chain_hlocks += chain->depth;
2202 chain_hlocks[chain->base] = prev - 1;
2203 chain_hlocks[chain->base + 1] = next -1;
2204 }
2205#ifdef CONFIG_DEBUG_LOCKDEP
2206 /*
2207 * Important for check_no_collision().
2208 */
2209 else {
2210 if (!debug_locks_off_graph_unlock())
2211 return 0;
2212
2213 print_lockdep_off("BUG: MAX_LOCKDEP_CHAIN_HLOCKS too low!");
2214 dump_stack();
2215 return 0;
2216 }
2217#endif
2218
2219 hlist_add_head_rcu(&chain->entry, hash_head);
2220 debug_atomic_inc(chain_lookup_misses);
2221 inc_chains();
2222
2223 return 1;
2224}
2225
2226/*
Byungchul Park545c23f2017-08-07 16:12:48 +09002227 * Adds a dependency chain into chain hashtable. And must be called with
2228 * graph_lock held.
2229 *
2230 * Return 0 if fail, and graph_lock is released.
2231 * Return 1 if succeed, with graph_lock held.
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002232 */
Byungchul Park545c23f2017-08-07 16:12:48 +09002233static inline int add_chain_cache(struct task_struct *curr,
2234 struct held_lock *hlock,
2235 u64 chain_key)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002236{
Dave Jonesf82b2172008-08-11 09:30:23 +02002237 struct lock_class *class = hlock_class(hlock);
Andrew Mortona63f38c2016-02-03 13:44:12 -08002238 struct hlist_head *hash_head = chainhashentry(chain_key);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002239 struct lock_chain *chain;
Steven Rostedte0944ee2011-04-20 21:42:00 -04002240 int i, j;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002241
Peter Zijlstra0119fee2011-09-02 01:30:29 +02002242 /*
Byungchul Park545c23f2017-08-07 16:12:48 +09002243 * Allocate a new chain entry from the static array, and add
2244 * it to the hash:
2245 */
2246
2247 /*
Peter Zijlstra0119fee2011-09-02 01:30:29 +02002248 * We might need to take the graph lock, ensure we've got IRQs
2249 * disabled to make this an IRQ-safe lock.. for recursion reasons
2250 * lockdep won't complain about its own locking errors.
2251 */
Jarek Poplawski381a2292007-02-10 01:44:58 -08002252 if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
2253 return 0;
Ingo Molnar9e4e7552016-02-29 10:03:58 +01002254
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002255 if (unlikely(nr_lock_chains >= MAX_LOCKDEP_CHAINS)) {
Ingo Molnar74c383f2006-12-13 00:34:43 -08002256 if (!debug_locks_off_graph_unlock())
2257 return 0;
2258
Dave Jones2c522832013-04-25 13:40:02 -04002259 print_lockdep_off("BUG: MAX_LOCKDEP_CHAINS too low!");
Peter Zijlstraeedeeab2009-03-18 12:38:47 +01002260 dump_stack();
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002261 return 0;
2262 }
2263 chain = lock_chains + nr_lock_chains++;
2264 chain->chain_key = chain_key;
Huang, Ying443cd502008-06-20 16:39:21 +08002265 chain->irq_context = hlock->irq_context;
Ingo Molnar9e4e7552016-02-29 10:03:58 +01002266 i = get_first_held_lock(curr, hlock);
Huang, Ying443cd502008-06-20 16:39:21 +08002267 chain->depth = curr->lockdep_depth + 1 - i;
Peter Zijlstra75dd6022016-03-30 11:36:59 +02002268
2269 BUILD_BUG_ON((1UL << 24) <= ARRAY_SIZE(chain_hlocks));
2270 BUILD_BUG_ON((1UL << 6) <= ARRAY_SIZE(curr->held_locks));
2271 BUILD_BUG_ON((1UL << 8*sizeof(chain_hlocks[0])) <= ARRAY_SIZE(lock_classes));
2272
Steven Rostedte0944ee2011-04-20 21:42:00 -04002273 if (likely(nr_chain_hlocks + chain->depth <= MAX_LOCKDEP_CHAIN_HLOCKS)) {
2274 chain->base = nr_chain_hlocks;
Huang, Ying443cd502008-06-20 16:39:21 +08002275 for (j = 0; j < chain->depth - 1; j++, i++) {
Dave Jonesf82b2172008-08-11 09:30:23 +02002276 int lock_id = curr->held_locks[i].class_idx - 1;
Huang, Ying443cd502008-06-20 16:39:21 +08002277 chain_hlocks[chain->base + j] = lock_id;
2278 }
2279 chain_hlocks[chain->base + j] = class - lock_classes;
2280 }
Peter Zijlstra75dd6022016-03-30 11:36:59 +02002281
2282 if (nr_chain_hlocks < MAX_LOCKDEP_CHAIN_HLOCKS)
2283 nr_chain_hlocks += chain->depth;
2284
2285#ifdef CONFIG_DEBUG_LOCKDEP
2286 /*
2287 * Important for check_no_collision().
2288 */
2289 if (unlikely(nr_chain_hlocks > MAX_LOCKDEP_CHAIN_HLOCKS)) {
Byungchul Parkf9af4562017-01-13 11:42:04 +09002290 if (!debug_locks_off_graph_unlock())
Peter Zijlstra75dd6022016-03-30 11:36:59 +02002291 return 0;
2292
2293 print_lockdep_off("BUG: MAX_LOCKDEP_CHAIN_HLOCKS too low!");
2294 dump_stack();
2295 return 0;
2296 }
2297#endif
2298
Andrew Mortona63f38c2016-02-03 13:44:12 -08002299 hlist_add_head_rcu(&chain->entry, hash_head);
Frederic Weisbeckerbd6d29c2010-04-06 00:10:17 +02002300 debug_atomic_inc(chain_lookup_misses);
Peter Zijlstra8e182572007-07-19 01:48:54 -07002301 inc_chains();
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002302
2303 return 1;
2304}
Peter Zijlstra8e182572007-07-19 01:48:54 -07002305
Byungchul Park545c23f2017-08-07 16:12:48 +09002306/*
2307 * Look up a dependency chain.
2308 */
2309static inline struct lock_chain *lookup_chain_cache(u64 chain_key)
2310{
2311 struct hlist_head *hash_head = chainhashentry(chain_key);
2312 struct lock_chain *chain;
2313
2314 /*
2315 * We can walk it lock-free, because entries only get added
2316 * to the hash:
2317 */
2318 hlist_for_each_entry_rcu(chain, hash_head, entry) {
2319 if (chain->chain_key == chain_key) {
2320 debug_atomic_inc(chain_lookup_hits);
2321 return chain;
2322 }
2323 }
2324 return NULL;
2325}
2326
2327/*
2328 * If the key is not present yet in dependency chain cache then
2329 * add it and return 1 - in this case the new dependency chain is
2330 * validated. If the key is already hashed, return 0.
2331 * (On return with 1 graph_lock is held.)
2332 */
2333static inline int lookup_chain_cache_add(struct task_struct *curr,
2334 struct held_lock *hlock,
2335 u64 chain_key)
2336{
2337 struct lock_class *class = hlock_class(hlock);
2338 struct lock_chain *chain = lookup_chain_cache(chain_key);
2339
2340 if (chain) {
2341cache_hit:
2342 if (!check_no_collision(curr, hlock, chain))
2343 return 0;
2344
2345 if (very_verbose(class)) {
2346 printk("\nhash chain already cached, key: "
Borislav Petkov04860d42018-02-26 14:49:26 +01002347 "%016Lx tail class: [%px] %s\n",
Byungchul Park545c23f2017-08-07 16:12:48 +09002348 (unsigned long long)chain_key,
2349 class->key, class->name);
2350 }
2351
2352 return 0;
2353 }
2354
2355 if (very_verbose(class)) {
Borislav Petkov04860d42018-02-26 14:49:26 +01002356 printk("\nnew hash chain, key: %016Lx tail class: [%px] %s\n",
Byungchul Park545c23f2017-08-07 16:12:48 +09002357 (unsigned long long)chain_key, class->key, class->name);
2358 }
2359
2360 if (!graph_lock())
2361 return 0;
2362
2363 /*
2364 * We have to walk the chain again locked - to avoid duplicates:
2365 */
2366 chain = lookup_chain_cache(chain_key);
2367 if (chain) {
2368 graph_unlock();
2369 goto cache_hit;
2370 }
2371
2372 if (!add_chain_cache(curr, hlock, chain_key))
2373 return 0;
2374
2375 return 1;
2376}
2377
Peter Zijlstra8e182572007-07-19 01:48:54 -07002378static int validate_chain(struct task_struct *curr, struct lockdep_map *lock,
Johannes Berg4e6045f2007-10-18 23:39:55 -07002379 struct held_lock *hlock, int chain_head, u64 chain_key)
Peter Zijlstra8e182572007-07-19 01:48:54 -07002380{
2381 /*
2382 * Trylock needs to maintain the stack of held locks, but it
2383 * does not add new dependencies, because trylock can be done
2384 * in any order.
2385 *
2386 * We look up the chain_key and do the O(N^2) check and update of
2387 * the dependencies only if this is a new dependency chain.
Byungchul Park545c23f2017-08-07 16:12:48 +09002388 * (If lookup_chain_cache_add() return with 1 it acquires
Peter Zijlstra8e182572007-07-19 01:48:54 -07002389 * graph_lock for us)
2390 */
Oleg Nesterovfb9edbe2014-01-20 19:20:06 +01002391 if (!hlock->trylock && hlock->check &&
Byungchul Park545c23f2017-08-07 16:12:48 +09002392 lookup_chain_cache_add(curr, hlock, chain_key)) {
Peter Zijlstra8e182572007-07-19 01:48:54 -07002393 /*
2394 * Check whether last held lock:
2395 *
2396 * - is irq-safe, if this lock is irq-unsafe
2397 * - is softirq-safe, if this lock is hardirq-unsafe
2398 *
2399 * And check whether the new lock's dependency graph
2400 * could lead back to the previous lock.
2401 *
2402 * any of these scenarios could lead to a deadlock. If
2403 * All validations
2404 */
2405 int ret = check_deadlock(curr, hlock, lock, hlock->read);
2406
2407 if (!ret)
2408 return 0;
2409 /*
2410 * Mark recursive read, as we jump over it when
2411 * building dependencies (just like we jump over
2412 * trylock entries):
2413 */
2414 if (ret == 2)
2415 hlock->read = 2;
2416 /*
2417 * Add dependency only if this lock is not the head
2418 * of the chain, and if it's not a secondary read-lock:
2419 */
Byungchul Park545c23f2017-08-07 16:12:48 +09002420 if (!chain_head && ret != 2) {
Peter Zijlstra8e182572007-07-19 01:48:54 -07002421 if (!check_prevs_add(curr, hlock))
2422 return 0;
Byungchul Park545c23f2017-08-07 16:12:48 +09002423 }
2424
Peter Zijlstra8e182572007-07-19 01:48:54 -07002425 graph_unlock();
Byungchul Park545c23f2017-08-07 16:12:48 +09002426 } else {
2427 /* after lookup_chain_cache_add(): */
Peter Zijlstra8e182572007-07-19 01:48:54 -07002428 if (unlikely(!debug_locks))
2429 return 0;
Byungchul Park545c23f2017-08-07 16:12:48 +09002430 }
Peter Zijlstra8e182572007-07-19 01:48:54 -07002431
2432 return 1;
2433}
2434#else
2435static inline int validate_chain(struct task_struct *curr,
2436 struct lockdep_map *lock, struct held_lock *hlock,
Gregory Haskins3aa416b2007-10-11 22:11:11 +02002437 int chain_head, u64 chain_key)
Peter Zijlstra8e182572007-07-19 01:48:54 -07002438{
2439 return 1;
2440}
Peter Zijlstraca58abc2007-07-19 01:48:53 -07002441#endif
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002442
2443/*
2444 * We are building curr_chain_key incrementally, so double-check
2445 * it from scratch, to make sure that it's done correctly:
2446 */
Steven Rostedt1d09daa2008-05-12 21:20:55 +02002447static void check_chain_key(struct task_struct *curr)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002448{
2449#ifdef CONFIG_DEBUG_LOCKDEP
2450 struct held_lock *hlock, *prev_hlock = NULL;
Alfredo Alvarez Fernandez5f18ab52016-02-11 00:33:32 +01002451 unsigned int i;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002452 u64 chain_key = 0;
2453
2454 for (i = 0; i < curr->lockdep_depth; i++) {
2455 hlock = curr->held_locks + i;
2456 if (chain_key != hlock->prev_chain_key) {
2457 debug_locks_off();
Peter Zijlstra0119fee2011-09-02 01:30:29 +02002458 /*
2459 * We got mighty confused, our chain keys don't match
2460 * with what we expect, someone trample on our task state?
2461 */
Arjan van de Ven2df8b1d2008-07-30 12:43:11 -07002462 WARN(1, "hm#1, depth: %u [%u], %016Lx != %016Lx\n",
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002463 curr->lockdep_depth, i,
2464 (unsigned long long)chain_key,
2465 (unsigned long long)hlock->prev_chain_key);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002466 return;
2467 }
Peter Zijlstra0119fee2011-09-02 01:30:29 +02002468 /*
2469 * Whoops ran out of static storage again?
2470 */
Alfredo Alvarez Fernandez5f18ab52016-02-11 00:33:32 +01002471 if (DEBUG_LOCKS_WARN_ON(hlock->class_idx > MAX_LOCKDEP_KEYS))
Jarek Poplawski381a2292007-02-10 01:44:58 -08002472 return;
2473
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002474 if (prev_hlock && (prev_hlock->irq_context !=
2475 hlock->irq_context))
2476 chain_key = 0;
Alfredo Alvarez Fernandez5f18ab52016-02-11 00:33:32 +01002477 chain_key = iterate_chain_key(chain_key, hlock->class_idx);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002478 prev_hlock = hlock;
2479 }
2480 if (chain_key != curr->curr_chain_key) {
2481 debug_locks_off();
Peter Zijlstra0119fee2011-09-02 01:30:29 +02002482 /*
2483 * More smoking hash instead of calculating it, damn see these
2484 * numbers float.. I bet that a pink elephant stepped on my memory.
2485 */
Arjan van de Ven2df8b1d2008-07-30 12:43:11 -07002486 WARN(1, "hm#2, depth: %u [%u], %016Lx != %016Lx\n",
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002487 curr->lockdep_depth, i,
2488 (unsigned long long)chain_key,
2489 (unsigned long long)curr->curr_chain_key);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002490 }
2491#endif
2492}
2493
Steven Rostedt282b5c22011-04-20 21:41:59 -04002494static void
2495print_usage_bug_scenario(struct held_lock *lock)
2496{
2497 struct lock_class *class = hlock_class(lock);
2498
2499 printk(" Possible unsafe locking scenario:\n\n");
2500 printk(" CPU0\n");
2501 printk(" ----\n");
2502 printk(" lock(");
2503 __print_lock_name(class);
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01002504 printk(KERN_CONT ");\n");
Steven Rostedt282b5c22011-04-20 21:41:59 -04002505 printk(" <Interrupt>\n");
2506 printk(" lock(");
2507 __print_lock_name(class);
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01002508 printk(KERN_CONT ");\n");
Steven Rostedt282b5c22011-04-20 21:41:59 -04002509 printk("\n *** DEADLOCK ***\n\n");
2510}
2511
Peter Zijlstra8e182572007-07-19 01:48:54 -07002512static int
2513print_usage_bug(struct task_struct *curr, struct held_lock *this,
2514 enum lock_usage_bit prev_bit, enum lock_usage_bit new_bit)
2515{
2516 if (!debug_locks_off_graph_unlock() || debug_locks_silent)
2517 return 0;
2518
Paul E. McKenney681fbec2017-05-04 15:44:38 -07002519 pr_warn("\n");
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08002520 pr_warn("================================\n");
2521 pr_warn("WARNING: inconsistent lock state\n");
Ben Hutchingsfbdc4b92011-10-28 04:36:55 +01002522 print_kernel_ident();
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08002523 pr_warn("--------------------------------\n");
Peter Zijlstra8e182572007-07-19 01:48:54 -07002524
Paul E. McKenney681fbec2017-05-04 15:44:38 -07002525 pr_warn("inconsistent {%s} -> {%s} usage.\n",
Peter Zijlstra8e182572007-07-19 01:48:54 -07002526 usage_str[prev_bit], usage_str[new_bit]);
2527
Paul E. McKenney681fbec2017-05-04 15:44:38 -07002528 pr_warn("%s/%d [HC%u[%lu]:SC%u[%lu]:HE%u:SE%u] takes:\n",
Pavel Emelyanovba25f9d2007-10-18 23:40:40 -07002529 curr->comm, task_pid_nr(curr),
Peter Zijlstra8e182572007-07-19 01:48:54 -07002530 trace_hardirq_context(curr), hardirq_count() >> HARDIRQ_SHIFT,
2531 trace_softirq_context(curr), softirq_count() >> SOFTIRQ_SHIFT,
2532 trace_hardirqs_enabled(curr),
2533 trace_softirqs_enabled(curr));
2534 print_lock(this);
2535
Paul E. McKenney681fbec2017-05-04 15:44:38 -07002536 pr_warn("{%s} state was registered at:\n", usage_str[prev_bit]);
Dave Jonesf82b2172008-08-11 09:30:23 +02002537 print_stack_trace(hlock_class(this)->usage_traces + prev_bit, 1);
Peter Zijlstra8e182572007-07-19 01:48:54 -07002538
2539 print_irqtrace_events(curr);
Paul E. McKenney681fbec2017-05-04 15:44:38 -07002540 pr_warn("\nother info that might help us debug this:\n");
Steven Rostedt282b5c22011-04-20 21:41:59 -04002541 print_usage_bug_scenario(this);
2542
Peter Zijlstra8e182572007-07-19 01:48:54 -07002543 lockdep_print_held_locks(curr);
2544
Paul E. McKenney681fbec2017-05-04 15:44:38 -07002545 pr_warn("\nstack backtrace:\n");
Peter Zijlstra8e182572007-07-19 01:48:54 -07002546 dump_stack();
2547
2548 return 0;
2549}
2550
2551/*
2552 * Print out an error if an invalid bit is set:
2553 */
2554static inline int
2555valid_state(struct task_struct *curr, struct held_lock *this,
2556 enum lock_usage_bit new_bit, enum lock_usage_bit bad_bit)
2557{
Dave Jonesf82b2172008-08-11 09:30:23 +02002558 if (unlikely(hlock_class(this)->usage_mask & (1 << bad_bit)))
Peter Zijlstra8e182572007-07-19 01:48:54 -07002559 return print_usage_bug(curr, this, bad_bit, new_bit);
2560 return 1;
2561}
2562
2563static int mark_lock(struct task_struct *curr, struct held_lock *this,
2564 enum lock_usage_bit new_bit);
2565
Steven Rostedt81d68a92008-05-12 21:20:42 +02002566#if defined(CONFIG_TRACE_IRQFLAGS) && defined(CONFIG_PROVE_LOCKING)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002567
2568/*
2569 * print irq inversion bug:
2570 */
2571static int
Ming Lei24208ca2009-07-16 15:44:29 +02002572print_irq_inversion_bug(struct task_struct *curr,
2573 struct lock_list *root, struct lock_list *other,
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002574 struct held_lock *this, int forwards,
2575 const char *irqclass)
2576{
Steven Rostedtdad3d742011-04-20 21:41:57 -04002577 struct lock_list *entry = other;
2578 struct lock_list *middle = NULL;
2579 int depth;
2580
Ingo Molnar74c383f2006-12-13 00:34:43 -08002581 if (!debug_locks_off_graph_unlock() || debug_locks_silent)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002582 return 0;
2583
Paul E. McKenney681fbec2017-05-04 15:44:38 -07002584 pr_warn("\n");
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08002585 pr_warn("========================================================\n");
2586 pr_warn("WARNING: possible irq lock inversion dependency detected\n");
Ben Hutchingsfbdc4b92011-10-28 04:36:55 +01002587 print_kernel_ident();
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08002588 pr_warn("--------------------------------------------------------\n");
Paul E. McKenney681fbec2017-05-04 15:44:38 -07002589 pr_warn("%s/%d just changed the state of lock:\n",
Pavel Emelyanovba25f9d2007-10-18 23:40:40 -07002590 curr->comm, task_pid_nr(curr));
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002591 print_lock(this);
2592 if (forwards)
Paul E. McKenney681fbec2017-05-04 15:44:38 -07002593 pr_warn("but this lock took another, %s-unsafe lock in the past:\n", irqclass);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002594 else
Paul E. McKenney681fbec2017-05-04 15:44:38 -07002595 pr_warn("but this lock was taken by another, %s-safe lock in the past:\n", irqclass);
Ming Lei24208ca2009-07-16 15:44:29 +02002596 print_lock_name(other->class);
Paul E. McKenney681fbec2017-05-04 15:44:38 -07002597 pr_warn("\n\nand interrupts could create inverse lock ordering between them.\n\n");
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002598
Paul E. McKenney681fbec2017-05-04 15:44:38 -07002599 pr_warn("\nother info that might help us debug this:\n");
Steven Rostedtdad3d742011-04-20 21:41:57 -04002600
2601 /* Find a middle lock (if one exists) */
2602 depth = get_lock_depth(other);
2603 do {
2604 if (depth == 0 && (entry != root)) {
Paul E. McKenney681fbec2017-05-04 15:44:38 -07002605 pr_warn("lockdep:%s bad path found in chain graph\n", __func__);
Steven Rostedtdad3d742011-04-20 21:41:57 -04002606 break;
2607 }
2608 middle = entry;
2609 entry = get_lock_parent(entry);
2610 depth--;
2611 } while (entry && entry != root && (depth >= 0));
2612 if (forwards)
2613 print_irq_lock_scenario(root, other,
2614 middle ? middle->class : root->class, other->class);
2615 else
2616 print_irq_lock_scenario(other, root,
2617 middle ? middle->class : other->class, root->class);
2618
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002619 lockdep_print_held_locks(curr);
2620
Paul E. McKenney681fbec2017-05-04 15:44:38 -07002621 pr_warn("\nthe shortest dependencies between 2nd lock and 1st lock:\n");
Ming Lei24208ca2009-07-16 15:44:29 +02002622 if (!save_trace(&root->trace))
2623 return 0;
2624 print_shortest_lock_dependencies(other, root);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002625
Paul E. McKenney681fbec2017-05-04 15:44:38 -07002626 pr_warn("\nstack backtrace:\n");
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002627 dump_stack();
2628
2629 return 0;
2630}
2631
2632/*
2633 * Prove that in the forwards-direction subgraph starting at <this>
2634 * there is no lock matching <mask>:
2635 */
2636static int
2637check_usage_forwards(struct task_struct *curr, struct held_lock *this,
2638 enum lock_usage_bit bit, const char *irqclass)
2639{
2640 int ret;
Ming Leid7aaba12009-07-16 15:44:29 +02002641 struct lock_list root;
2642 struct lock_list *uninitialized_var(target_entry);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002643
Ming Leid7aaba12009-07-16 15:44:29 +02002644 root.parent = NULL;
2645 root.class = hlock_class(this);
2646 ret = find_usage_forwards(&root, bit, &target_entry);
Peter Zijlstraaf012962009-07-16 15:44:29 +02002647 if (ret < 0)
2648 return print_bfs_bug(ret);
2649 if (ret == 1)
2650 return ret;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002651
Ming Lei24208ca2009-07-16 15:44:29 +02002652 return print_irq_inversion_bug(curr, &root, target_entry,
Ming Leid7aaba12009-07-16 15:44:29 +02002653 this, 1, irqclass);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002654}
2655
2656/*
2657 * Prove that in the backwards-direction subgraph starting at <this>
2658 * there is no lock matching <mask>:
2659 */
2660static int
2661check_usage_backwards(struct task_struct *curr, struct held_lock *this,
2662 enum lock_usage_bit bit, const char *irqclass)
2663{
2664 int ret;
Ming Leid7aaba12009-07-16 15:44:29 +02002665 struct lock_list root;
2666 struct lock_list *uninitialized_var(target_entry);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002667
Ming Leid7aaba12009-07-16 15:44:29 +02002668 root.parent = NULL;
2669 root.class = hlock_class(this);
2670 ret = find_usage_backwards(&root, bit, &target_entry);
Peter Zijlstraaf012962009-07-16 15:44:29 +02002671 if (ret < 0)
2672 return print_bfs_bug(ret);
2673 if (ret == 1)
2674 return ret;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002675
Ming Lei24208ca2009-07-16 15:44:29 +02002676 return print_irq_inversion_bug(curr, &root, target_entry,
Oleg Nesterov48d50672010-01-26 19:16:41 +01002677 this, 0, irqclass);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002678}
2679
Ingo Molnar3117df02006-12-13 00:34:43 -08002680void print_irqtrace_events(struct task_struct *curr)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002681{
2682 printk("irq event stamp: %u\n", curr->irq_events);
Borislav Petkov04860d42018-02-26 14:49:26 +01002683 printk("hardirqs last enabled at (%u): [<%px>] %pS\n",
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01002684 curr->hardirq_enable_event, (void *)curr->hardirq_enable_ip,
2685 (void *)curr->hardirq_enable_ip);
Borislav Petkov04860d42018-02-26 14:49:26 +01002686 printk("hardirqs last disabled at (%u): [<%px>] %pS\n",
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01002687 curr->hardirq_disable_event, (void *)curr->hardirq_disable_ip,
2688 (void *)curr->hardirq_disable_ip);
Borislav Petkov04860d42018-02-26 14:49:26 +01002689 printk("softirqs last enabled at (%u): [<%px>] %pS\n",
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01002690 curr->softirq_enable_event, (void *)curr->softirq_enable_ip,
2691 (void *)curr->softirq_enable_ip);
Borislav Petkov04860d42018-02-26 14:49:26 +01002692 printk("softirqs last disabled at (%u): [<%px>] %pS\n",
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01002693 curr->softirq_disable_event, (void *)curr->softirq_disable_ip,
2694 (void *)curr->softirq_disable_ip);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002695}
2696
Peter Zijlstracd953022009-01-22 16:38:21 +01002697static int HARDIRQ_verbose(struct lock_class *class)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002698{
Peter Zijlstra8e182572007-07-19 01:48:54 -07002699#if HARDIRQ_VERBOSE
2700 return class_filter(class);
2701#endif
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002702 return 0;
2703}
2704
Peter Zijlstracd953022009-01-22 16:38:21 +01002705static int SOFTIRQ_verbose(struct lock_class *class)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002706{
Peter Zijlstra8e182572007-07-19 01:48:54 -07002707#if SOFTIRQ_VERBOSE
2708 return class_filter(class);
2709#endif
2710 return 0;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002711}
2712
2713#define STRICT_READ_CHECKS 1
2714
Peter Zijlstracd953022009-01-22 16:38:21 +01002715static int (*state_verbose_f[])(struct lock_class *class) = {
2716#define LOCKDEP_STATE(__STATE) \
2717 __STATE##_verbose,
2718#include "lockdep_states.h"
2719#undef LOCKDEP_STATE
2720};
2721
2722static inline int state_verbose(enum lock_usage_bit bit,
2723 struct lock_class *class)
2724{
2725 return state_verbose_f[bit >> 2](class);
2726}
2727
Peter Zijlstra42c50d52009-01-22 16:58:16 +01002728typedef int (*check_usage_f)(struct task_struct *, struct held_lock *,
2729 enum lock_usage_bit bit, const char *name);
2730
Peter Zijlstra6a6904d2009-01-22 16:07:44 +01002731static int
Peter Zijlstra1c21f142009-03-04 13:51:13 +01002732mark_lock_irq(struct task_struct *curr, struct held_lock *this,
2733 enum lock_usage_bit new_bit)
Peter Zijlstra6a6904d2009-01-22 16:07:44 +01002734{
Peter Zijlstraf9892092009-01-22 16:09:59 +01002735 int excl_bit = exclusive_bit(new_bit);
Peter Zijlstra9d3651a2009-01-22 17:18:32 +01002736 int read = new_bit & 1;
Peter Zijlstra42c50d52009-01-22 16:58:16 +01002737 int dir = new_bit & 2;
2738
Peter Zijlstra38aa2712009-01-27 14:53:50 +01002739 /*
2740 * mark USED_IN has to look forwards -- to ensure no dependency
2741 * has ENABLED state, which would allow recursion deadlocks.
2742 *
2743 * mark ENABLED has to look backwards -- to ensure no dependee
2744 * has USED_IN state, which, again, would allow recursion deadlocks.
2745 */
Peter Zijlstra42c50d52009-01-22 16:58:16 +01002746 check_usage_f usage = dir ?
2747 check_usage_backwards : check_usage_forwards;
Peter Zijlstraf9892092009-01-22 16:09:59 +01002748
Peter Zijlstra38aa2712009-01-27 14:53:50 +01002749 /*
2750 * Validate that this particular lock does not have conflicting
2751 * usage states.
2752 */
Peter Zijlstra6a6904d2009-01-22 16:07:44 +01002753 if (!valid_state(curr, this, new_bit, excl_bit))
2754 return 0;
Peter Zijlstra9d3651a2009-01-22 17:18:32 +01002755
Peter Zijlstra38aa2712009-01-27 14:53:50 +01002756 /*
2757 * Validate that the lock dependencies don't have conflicting usage
2758 * states.
2759 */
2760 if ((!read || !dir || STRICT_READ_CHECKS) &&
Peter Zijlstra1c21f142009-03-04 13:51:13 +01002761 !usage(curr, this, excl_bit, state_name(new_bit & ~1)))
Peter Zijlstra6a6904d2009-01-22 16:07:44 +01002762 return 0;
Peter Zijlstra780e8202009-01-22 16:51:29 +01002763
Peter Zijlstra38aa2712009-01-27 14:53:50 +01002764 /*
2765 * Check for read in write conflicts
2766 */
2767 if (!read) {
2768 if (!valid_state(curr, this, new_bit, excl_bit + 1))
2769 return 0;
2770
2771 if (STRICT_READ_CHECKS &&
Peter Zijlstra4f367d8a2009-01-22 18:10:42 +01002772 !usage(curr, this, excl_bit + 1,
2773 state_name(new_bit + 1)))
Peter Zijlstra38aa2712009-01-27 14:53:50 +01002774 return 0;
2775 }
Peter Zijlstra780e8202009-01-22 16:51:29 +01002776
Peter Zijlstracd953022009-01-22 16:38:21 +01002777 if (state_verbose(new_bit, hlock_class(this)))
Peter Zijlstra6a6904d2009-01-22 16:07:44 +01002778 return 2;
2779
2780 return 1;
2781}
2782
Nick Piggincf40bd12009-01-21 08:12:39 +01002783enum mark_type {
Peter Zijlstra36bfb9b2009-01-22 14:12:41 +01002784#define LOCKDEP_STATE(__STATE) __STATE,
2785#include "lockdep_states.h"
2786#undef LOCKDEP_STATE
Nick Piggincf40bd12009-01-21 08:12:39 +01002787};
2788
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002789/*
2790 * Mark all held locks with a usage bit:
2791 */
Steven Rostedt1d09daa2008-05-12 21:20:55 +02002792static int
Nick Piggincf40bd12009-01-21 08:12:39 +01002793mark_held_locks(struct task_struct *curr, enum mark_type mark)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002794{
2795 enum lock_usage_bit usage_bit;
2796 struct held_lock *hlock;
2797 int i;
2798
2799 for (i = 0; i < curr->lockdep_depth; i++) {
2800 hlock = curr->held_locks + i;
2801
Peter Zijlstracf2ad4d2009-01-27 13:58:08 +01002802 usage_bit = 2 + (mark << 2); /* ENABLED */
2803 if (hlock->read)
2804 usage_bit += 1; /* READ */
2805
2806 BUG_ON(usage_bit >= LOCK_USAGE_STATES);
Nick Piggincf40bd12009-01-21 08:12:39 +01002807
Oleg Nesterov34d0ed52014-01-20 19:20:13 +01002808 if (!hlock->check)
Peter Zijlstraefbe2ee2011-07-07 11:39:45 +02002809 continue;
2810
Jarek Poplawski4ff773bb2007-05-08 00:31:00 -07002811 if (!mark_lock(curr, hlock, usage_bit))
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002812 return 0;
2813 }
2814
2815 return 1;
2816}
2817
2818/*
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002819 * Hardirqs will be enabled:
2820 */
Peter Zijlstradd4e5d32011-06-21 17:17:27 +02002821static void __trace_hardirqs_on_caller(unsigned long ip)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002822{
2823 struct task_struct *curr = current;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002824
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002825 /* we'll do an OFF -> ON transition: */
2826 curr->hardirqs_enabled = 1;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002827
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002828 /*
2829 * We are going to turn hardirqs on, so set the
2830 * usage bit for all held locks:
2831 */
Nick Piggincf40bd12009-01-21 08:12:39 +01002832 if (!mark_held_locks(curr, HARDIRQ))
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002833 return;
2834 /*
2835 * If we have softirqs enabled, then set the usage
2836 * bit for all held locks. (disabled hardirqs prevented
2837 * this bit from being set before)
2838 */
2839 if (curr->softirqs_enabled)
Nick Piggincf40bd12009-01-21 08:12:39 +01002840 if (!mark_held_locks(curr, SOFTIRQ))
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002841 return;
2842
2843 curr->hardirq_enable_ip = ip;
2844 curr->hardirq_enable_event = ++curr->irq_events;
Frederic Weisbeckerbd6d29c2010-04-06 00:10:17 +02002845 debug_atomic_inc(hardirqs_on_events);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002846}
Peter Zijlstradd4e5d32011-06-21 17:17:27 +02002847
Andi Kleenb35f8302014-02-08 08:52:02 +01002848__visible void trace_hardirqs_on_caller(unsigned long ip)
Peter Zijlstradd4e5d32011-06-21 17:17:27 +02002849{
2850 time_hardirqs_on(CALLER_ADDR0, ip);
2851
2852 if (unlikely(!debug_locks || current->lockdep_recursion))
2853 return;
2854
Peter Zijlstra7d36b262011-07-26 13:13:44 +02002855 if (unlikely(current->hardirqs_enabled)) {
2856 /*
2857 * Neither irq nor preemption are disabled here
2858 * so this is racy by nature but losing one hit
2859 * in a stat is not a big deal.
2860 */
2861 __debug_atomic_inc(redundant_hardirqs_on);
2862 return;
2863 }
2864
Peter Zijlstra0119fee2011-09-02 01:30:29 +02002865 /*
2866 * We're enabling irqs and according to our state above irqs weren't
2867 * already enabled, yet we find the hardware thinks they are in fact
2868 * enabled.. someone messed up their IRQ state tracing.
2869 */
Peter Zijlstradd4e5d32011-06-21 17:17:27 +02002870 if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
2871 return;
2872
Peter Zijlstra0119fee2011-09-02 01:30:29 +02002873 /*
2874 * See the fine text that goes along with this variable definition.
2875 */
Peter Zijlstra7d36b262011-07-26 13:13:44 +02002876 if (DEBUG_LOCKS_WARN_ON(unlikely(early_boot_irqs_disabled)))
2877 return;
2878
Peter Zijlstra0119fee2011-09-02 01:30:29 +02002879 /*
2880 * Can't allow enabling interrupts while in an interrupt handler,
2881 * that's general bad form and such. Recursion, limited stack etc..
2882 */
Peter Zijlstra7d36b262011-07-26 13:13:44 +02002883 if (DEBUG_LOCKS_WARN_ON(current->hardirq_context))
2884 return;
2885
Peter Zijlstradd4e5d32011-06-21 17:17:27 +02002886 current->lockdep_recursion = 1;
2887 __trace_hardirqs_on_caller(ip);
2888 current->lockdep_recursion = 0;
2889}
Steven Rostedt81d68a92008-05-12 21:20:42 +02002890EXPORT_SYMBOL(trace_hardirqs_on_caller);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002891
Steven Rostedt1d09daa2008-05-12 21:20:55 +02002892void trace_hardirqs_on(void)
Steven Rostedt81d68a92008-05-12 21:20:42 +02002893{
2894 trace_hardirqs_on_caller(CALLER_ADDR0);
2895}
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002896EXPORT_SYMBOL(trace_hardirqs_on);
2897
2898/*
2899 * Hardirqs were disabled:
2900 */
Andi Kleenb35f8302014-02-08 08:52:02 +01002901__visible void trace_hardirqs_off_caller(unsigned long ip)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002902{
2903 struct task_struct *curr = current;
2904
Heiko Carstens6afe40b2008-10-28 11:14:58 +01002905 time_hardirqs_off(CALLER_ADDR0, ip);
Steven Rostedt81d68a92008-05-12 21:20:42 +02002906
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002907 if (unlikely(!debug_locks || current->lockdep_recursion))
2908 return;
2909
Peter Zijlstra0119fee2011-09-02 01:30:29 +02002910 /*
2911 * So we're supposed to get called after you mask local IRQs, but for
2912 * some reason the hardware doesn't quite think you did a proper job.
2913 */
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002914 if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
2915 return;
2916
2917 if (curr->hardirqs_enabled) {
2918 /*
2919 * We have done an ON -> OFF transition:
2920 */
2921 curr->hardirqs_enabled = 0;
Heiko Carstens6afe40b2008-10-28 11:14:58 +01002922 curr->hardirq_disable_ip = ip;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002923 curr->hardirq_disable_event = ++curr->irq_events;
Frederic Weisbeckerbd6d29c2010-04-06 00:10:17 +02002924 debug_atomic_inc(hardirqs_off_events);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002925 } else
Frederic Weisbeckerbd6d29c2010-04-06 00:10:17 +02002926 debug_atomic_inc(redundant_hardirqs_off);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002927}
Steven Rostedt81d68a92008-05-12 21:20:42 +02002928EXPORT_SYMBOL(trace_hardirqs_off_caller);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002929
Steven Rostedt1d09daa2008-05-12 21:20:55 +02002930void trace_hardirqs_off(void)
Steven Rostedt81d68a92008-05-12 21:20:42 +02002931{
2932 trace_hardirqs_off_caller(CALLER_ADDR0);
2933}
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002934EXPORT_SYMBOL(trace_hardirqs_off);
2935
2936/*
2937 * Softirqs will be enabled:
2938 */
2939void trace_softirqs_on(unsigned long ip)
2940{
2941 struct task_struct *curr = current;
2942
Peter Zijlstradd4e5d32011-06-21 17:17:27 +02002943 if (unlikely(!debug_locks || current->lockdep_recursion))
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002944 return;
2945
Peter Zijlstra0119fee2011-09-02 01:30:29 +02002946 /*
2947 * We fancy IRQs being disabled here, see softirq.c, avoids
2948 * funny state and nesting things.
2949 */
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002950 if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
2951 return;
2952
2953 if (curr->softirqs_enabled) {
Frederic Weisbeckerbd6d29c2010-04-06 00:10:17 +02002954 debug_atomic_inc(redundant_softirqs_on);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002955 return;
2956 }
2957
Peter Zijlstradd4e5d32011-06-21 17:17:27 +02002958 current->lockdep_recursion = 1;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002959 /*
2960 * We'll do an OFF -> ON transition:
2961 */
2962 curr->softirqs_enabled = 1;
2963 curr->softirq_enable_ip = ip;
2964 curr->softirq_enable_event = ++curr->irq_events;
Frederic Weisbeckerbd6d29c2010-04-06 00:10:17 +02002965 debug_atomic_inc(softirqs_on_events);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002966 /*
2967 * We are going to turn softirqs on, so set the
2968 * usage bit for all held locks, if hardirqs are
2969 * enabled too:
2970 */
2971 if (curr->hardirqs_enabled)
Nick Piggincf40bd12009-01-21 08:12:39 +01002972 mark_held_locks(curr, SOFTIRQ);
Peter Zijlstradd4e5d32011-06-21 17:17:27 +02002973 current->lockdep_recursion = 0;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002974}
2975
2976/*
2977 * Softirqs were disabled:
2978 */
2979void trace_softirqs_off(unsigned long ip)
2980{
2981 struct task_struct *curr = current;
2982
Peter Zijlstradd4e5d32011-06-21 17:17:27 +02002983 if (unlikely(!debug_locks || current->lockdep_recursion))
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002984 return;
2985
Peter Zijlstra0119fee2011-09-02 01:30:29 +02002986 /*
2987 * We fancy IRQs being disabled here, see softirq.c
2988 */
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002989 if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
2990 return;
2991
2992 if (curr->softirqs_enabled) {
2993 /*
2994 * We have done an ON -> OFF transition:
2995 */
2996 curr->softirqs_enabled = 0;
2997 curr->softirq_disable_ip = ip;
2998 curr->softirq_disable_event = ++curr->irq_events;
Frederic Weisbeckerbd6d29c2010-04-06 00:10:17 +02002999 debug_atomic_inc(softirqs_off_events);
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003000 /*
3001 * Whoops, we wanted softirqs off, so why aren't they?
3002 */
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003003 DEBUG_LOCKS_WARN_ON(!softirq_count());
3004 } else
Frederic Weisbeckerbd6d29c2010-04-06 00:10:17 +02003005 debug_atomic_inc(redundant_softirqs_off);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003006}
3007
Peter Zijlstra8e182572007-07-19 01:48:54 -07003008static int mark_irqflags(struct task_struct *curr, struct held_lock *hlock)
3009{
3010 /*
3011 * If non-trylock use in a hardirq or softirq context, then
3012 * mark the lock as used in these contexts:
3013 */
3014 if (!hlock->trylock) {
3015 if (hlock->read) {
3016 if (curr->hardirq_context)
3017 if (!mark_lock(curr, hlock,
3018 LOCK_USED_IN_HARDIRQ_READ))
3019 return 0;
3020 if (curr->softirq_context)
3021 if (!mark_lock(curr, hlock,
3022 LOCK_USED_IN_SOFTIRQ_READ))
3023 return 0;
3024 } else {
3025 if (curr->hardirq_context)
3026 if (!mark_lock(curr, hlock, LOCK_USED_IN_HARDIRQ))
3027 return 0;
3028 if (curr->softirq_context)
3029 if (!mark_lock(curr, hlock, LOCK_USED_IN_SOFTIRQ))
3030 return 0;
3031 }
3032 }
3033 if (!hlock->hardirqs_off) {
3034 if (hlock->read) {
3035 if (!mark_lock(curr, hlock,
Peter Zijlstra4fc95e82009-01-22 13:10:52 +01003036 LOCK_ENABLED_HARDIRQ_READ))
Peter Zijlstra8e182572007-07-19 01:48:54 -07003037 return 0;
3038 if (curr->softirqs_enabled)
3039 if (!mark_lock(curr, hlock,
Peter Zijlstra4fc95e82009-01-22 13:10:52 +01003040 LOCK_ENABLED_SOFTIRQ_READ))
Peter Zijlstra8e182572007-07-19 01:48:54 -07003041 return 0;
3042 } else {
3043 if (!mark_lock(curr, hlock,
Peter Zijlstra4fc95e82009-01-22 13:10:52 +01003044 LOCK_ENABLED_HARDIRQ))
Peter Zijlstra8e182572007-07-19 01:48:54 -07003045 return 0;
3046 if (curr->softirqs_enabled)
3047 if (!mark_lock(curr, hlock,
Peter Zijlstra4fc95e82009-01-22 13:10:52 +01003048 LOCK_ENABLED_SOFTIRQ))
Peter Zijlstra8e182572007-07-19 01:48:54 -07003049 return 0;
3050 }
3051 }
3052
3053 return 1;
3054}
3055
Boqun Fengc2469752016-02-16 13:57:40 +08003056static inline unsigned int task_irq_context(struct task_struct *task)
3057{
3058 return 2 * !!task->hardirq_context + !!task->softirq_context;
3059}
3060
Peter Zijlstra8e182572007-07-19 01:48:54 -07003061static int separate_irq_context(struct task_struct *curr,
3062 struct held_lock *hlock)
3063{
3064 unsigned int depth = curr->lockdep_depth;
3065
3066 /*
3067 * Keep track of points where we cross into an interrupt context:
3068 */
Peter Zijlstra8e182572007-07-19 01:48:54 -07003069 if (depth) {
3070 struct held_lock *prev_hlock;
3071
3072 prev_hlock = curr->held_locks + depth-1;
3073 /*
3074 * If we cross into another context, reset the
3075 * hash key (this also prevents the checking and the
3076 * adding of the dependency to 'prev'):
3077 */
3078 if (prev_hlock->irq_context != hlock->irq_context)
3079 return 1;
3080 }
3081 return 0;
3082}
3083
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003084#else /* defined(CONFIG_TRACE_IRQFLAGS) && defined(CONFIG_PROVE_LOCKING) */
Peter Zijlstra8e182572007-07-19 01:48:54 -07003085
3086static inline
3087int mark_lock_irq(struct task_struct *curr, struct held_lock *this,
3088 enum lock_usage_bit new_bit)
3089{
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003090 WARN_ON(1); /* Impossible innit? when we don't have TRACE_IRQFLAG */
Peter Zijlstra8e182572007-07-19 01:48:54 -07003091 return 1;
3092}
3093
3094static inline int mark_irqflags(struct task_struct *curr,
3095 struct held_lock *hlock)
3096{
3097 return 1;
3098}
3099
Boqun Fengc2469752016-02-16 13:57:40 +08003100static inline unsigned int task_irq_context(struct task_struct *task)
3101{
3102 return 0;
3103}
3104
Peter Zijlstra8e182572007-07-19 01:48:54 -07003105static inline int separate_irq_context(struct task_struct *curr,
3106 struct held_lock *hlock)
3107{
3108 return 0;
3109}
3110
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003111#endif /* defined(CONFIG_TRACE_IRQFLAGS) && defined(CONFIG_PROVE_LOCKING) */
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003112
3113/*
Peter Zijlstra8e182572007-07-19 01:48:54 -07003114 * Mark a lock with a usage bit, and validate the state transition:
3115 */
Steven Rostedt1d09daa2008-05-12 21:20:55 +02003116static int mark_lock(struct task_struct *curr, struct held_lock *this,
Steven Rostedt0764d232008-05-12 21:20:44 +02003117 enum lock_usage_bit new_bit)
Peter Zijlstra8e182572007-07-19 01:48:54 -07003118{
3119 unsigned int new_mask = 1 << new_bit, ret = 1;
3120
3121 /*
3122 * If already set then do not dirty the cacheline,
3123 * nor do any checks:
3124 */
Dave Jonesf82b2172008-08-11 09:30:23 +02003125 if (likely(hlock_class(this)->usage_mask & new_mask))
Peter Zijlstra8e182572007-07-19 01:48:54 -07003126 return 1;
3127
3128 if (!graph_lock())
3129 return 0;
3130 /*
Lucas De Marchi25985ed2011-03-30 22:57:33 -03003131 * Make sure we didn't race:
Peter Zijlstra8e182572007-07-19 01:48:54 -07003132 */
Dave Jonesf82b2172008-08-11 09:30:23 +02003133 if (unlikely(hlock_class(this)->usage_mask & new_mask)) {
Peter Zijlstra8e182572007-07-19 01:48:54 -07003134 graph_unlock();
3135 return 1;
3136 }
3137
Dave Jonesf82b2172008-08-11 09:30:23 +02003138 hlock_class(this)->usage_mask |= new_mask;
Peter Zijlstra8e182572007-07-19 01:48:54 -07003139
Dave Jonesf82b2172008-08-11 09:30:23 +02003140 if (!save_trace(hlock_class(this)->usage_traces + new_bit))
Peter Zijlstra8e182572007-07-19 01:48:54 -07003141 return 0;
3142
3143 switch (new_bit) {
Peter Zijlstra53464172009-01-22 14:15:53 +01003144#define LOCKDEP_STATE(__STATE) \
3145 case LOCK_USED_IN_##__STATE: \
3146 case LOCK_USED_IN_##__STATE##_READ: \
3147 case LOCK_ENABLED_##__STATE: \
3148 case LOCK_ENABLED_##__STATE##_READ:
3149#include "lockdep_states.h"
3150#undef LOCKDEP_STATE
Peter Zijlstra8e182572007-07-19 01:48:54 -07003151 ret = mark_lock_irq(curr, this, new_bit);
3152 if (!ret)
3153 return 0;
3154 break;
3155 case LOCK_USED:
Frederic Weisbeckerbd6d29c2010-04-06 00:10:17 +02003156 debug_atomic_dec(nr_unused_locks);
Peter Zijlstra8e182572007-07-19 01:48:54 -07003157 break;
3158 default:
3159 if (!debug_locks_off_graph_unlock())
3160 return 0;
3161 WARN_ON(1);
3162 return 0;
3163 }
3164
3165 graph_unlock();
3166
3167 /*
3168 * We must printk outside of the graph_lock:
3169 */
3170 if (ret == 2) {
3171 printk("\nmarked lock as {%s}:\n", usage_str[new_bit]);
3172 print_lock(this);
3173 print_irqtrace_events(curr);
3174 dump_stack();
3175 }
3176
3177 return ret;
3178}
3179
3180/*
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003181 * Initialize a lock instance's lock-class mapping info:
3182 */
Byungchul Parkb09be672017-08-07 16:12:52 +09003183static void __lockdep_init_map(struct lockdep_map *lock, const char *name,
Peter Zijlstra4dfbb9d2006-10-11 01:45:14 -04003184 struct lock_class_key *key, int subclass)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003185{
Yong Zhangd3d03d42011-11-09 16:04:51 +08003186 int i;
3187
Yong Zhangd3d03d42011-11-09 16:04:51 +08003188 for (i = 0; i < NR_LOCKDEP_CACHING_CLASSES; i++)
3189 lock->class_cache[i] = NULL;
Hitoshi Mitake62016252010-10-05 18:01:51 +09003190
Peter Zijlstrac8a25002009-04-17 09:40:49 +02003191#ifdef CONFIG_LOCK_STAT
3192 lock->cpu = raw_smp_processor_id();
3193#endif
3194
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003195 /*
3196 * Can't be having no nameless bastards around this place!
3197 */
Peter Zijlstrac8a25002009-04-17 09:40:49 +02003198 if (DEBUG_LOCKS_WARN_ON(!name)) {
3199 lock->name = "NULL";
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003200 return;
Peter Zijlstrac8a25002009-04-17 09:40:49 +02003201 }
3202
3203 lock->name = name;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003204
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003205 /*
3206 * No key, no joy, we need to hash something.
3207 */
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003208 if (DEBUG_LOCKS_WARN_ON(!key))
3209 return;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003210 /*
3211 * Sanity check, the lock-class key must be persistent:
3212 */
3213 if (!static_obj(key)) {
Borislav Petkov04860d42018-02-26 14:49:26 +01003214 printk("BUG: key %px not in .data!\n", key);
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003215 /*
3216 * What it says above ^^^^^, I suggest you read it.
3217 */
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003218 DEBUG_LOCKS_WARN_ON(1);
3219 return;
3220 }
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003221 lock->key = key;
Peter Zijlstrac8a25002009-04-17 09:40:49 +02003222
3223 if (unlikely(!debug_locks))
3224 return;
3225
Peter Zijlstra35a93932015-02-26 16:23:11 +01003226 if (subclass) {
3227 unsigned long flags;
3228
3229 if (DEBUG_LOCKS_WARN_ON(current->lockdep_recursion))
3230 return;
3231
3232 raw_local_irq_save(flags);
3233 current->lockdep_recursion = 1;
Peter Zijlstra4dfbb9d2006-10-11 01:45:14 -04003234 register_lock_class(lock, subclass, 1);
Peter Zijlstra35a93932015-02-26 16:23:11 +01003235 current->lockdep_recursion = 0;
3236 raw_local_irq_restore(flags);
3237 }
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003238}
Byungchul Parkb09be672017-08-07 16:12:52 +09003239
3240void lockdep_init_map(struct lockdep_map *lock, const char *name,
3241 struct lock_class_key *key, int subclass)
3242{
Byungchul Parkb09be672017-08-07 16:12:52 +09003243 __lockdep_init_map(lock, name, key, subclass);
3244}
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003245EXPORT_SYMBOL_GPL(lockdep_init_map);
3246
Peter Zijlstra1704f472010-03-19 01:37:42 +01003247struct lock_class_key __lockdep_no_validate__;
Kent Overstreetea6749c2012-12-27 22:21:58 -08003248EXPORT_SYMBOL_GPL(__lockdep_no_validate__);
Peter Zijlstra1704f472010-03-19 01:37:42 +01003249
Maarten Lankhorstd0945952012-09-13 11:39:51 +02003250static int
3251print_lock_nested_lock_not_held(struct task_struct *curr,
3252 struct held_lock *hlock,
3253 unsigned long ip)
3254{
3255 if (!debug_locks_off())
3256 return 0;
3257 if (debug_locks_silent)
3258 return 0;
3259
Paul E. McKenney681fbec2017-05-04 15:44:38 -07003260 pr_warn("\n");
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08003261 pr_warn("==================================\n");
3262 pr_warn("WARNING: Nested lock was not taken\n");
Maarten Lankhorstd0945952012-09-13 11:39:51 +02003263 print_kernel_ident();
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08003264 pr_warn("----------------------------------\n");
Maarten Lankhorstd0945952012-09-13 11:39:51 +02003265
Paul E. McKenney681fbec2017-05-04 15:44:38 -07003266 pr_warn("%s/%d is trying to lock:\n", curr->comm, task_pid_nr(curr));
Maarten Lankhorstd0945952012-09-13 11:39:51 +02003267 print_lock(hlock);
3268
Paul E. McKenney681fbec2017-05-04 15:44:38 -07003269 pr_warn("\nbut this task is not holding:\n");
3270 pr_warn("%s\n", hlock->nest_lock->name);
Maarten Lankhorstd0945952012-09-13 11:39:51 +02003271
Paul E. McKenney681fbec2017-05-04 15:44:38 -07003272 pr_warn("\nstack backtrace:\n");
Maarten Lankhorstd0945952012-09-13 11:39:51 +02003273 dump_stack();
3274
Paul E. McKenney681fbec2017-05-04 15:44:38 -07003275 pr_warn("\nother info that might help us debug this:\n");
Maarten Lankhorstd0945952012-09-13 11:39:51 +02003276 lockdep_print_held_locks(curr);
3277
Paul E. McKenney681fbec2017-05-04 15:44:38 -07003278 pr_warn("\nstack backtrace:\n");
Maarten Lankhorstd0945952012-09-13 11:39:51 +02003279 dump_stack();
3280
3281 return 0;
3282}
3283
Matthew Wilcox08f36ff2018-01-17 07:14:13 -08003284static int __lock_is_held(const struct lockdep_map *lock, int read);
Maarten Lankhorstd0945952012-09-13 11:39:51 +02003285
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003286/*
3287 * This gets called for every mutex_lock*()/spin_lock*() operation.
3288 * We maintain the dependency maps and validate the locking attempt:
3289 */
3290static int __lock_acquire(struct lockdep_map *lock, unsigned int subclass,
3291 int trylock, int read, int check, int hardirqs_off,
Peter Zijlstrabb97a912009-07-20 19:15:35 +02003292 struct lockdep_map *nest_lock, unsigned long ip,
Peter Zijlstra21199f22015-09-16 16:10:40 +02003293 int references, int pin_count)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003294{
3295 struct task_struct *curr = current;
Ingo Molnard6d897c2006-07-10 04:44:04 -07003296 struct lock_class *class = NULL;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003297 struct held_lock *hlock;
Alfredo Alvarez Fernandez5f18ab52016-02-11 00:33:32 +01003298 unsigned int depth;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003299 int chain_head = 0;
Peter Zijlstrabb97a912009-07-20 19:15:35 +02003300 int class_idx;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003301 u64 chain_key;
3302
3303 if (unlikely(!debug_locks))
3304 return 0;
3305
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003306 /*
3307 * Lockdep should run with IRQs disabled, otherwise we could
3308 * get an interrupt which would want to take locks, which would
3309 * end up in lockdep and have you got a head-ache already?
3310 */
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003311 if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
3312 return 0;
3313
Oleg Nesterovfb9edbe2014-01-20 19:20:06 +01003314 if (!prove_locking || lock->key == &__lockdep_no_validate__)
3315 check = 0;
Peter Zijlstra1704f472010-03-19 01:37:42 +01003316
Hitoshi Mitake62016252010-10-05 18:01:51 +09003317 if (subclass < NR_LOCKDEP_CACHING_CLASSES)
3318 class = lock->class_cache[subclass];
Ingo Molnard6d897c2006-07-10 04:44:04 -07003319 /*
Hitoshi Mitake62016252010-10-05 18:01:51 +09003320 * Not cached?
Ingo Molnard6d897c2006-07-10 04:44:04 -07003321 */
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003322 if (unlikely(!class)) {
Peter Zijlstra4dfbb9d2006-10-11 01:45:14 -04003323 class = register_lock_class(lock, subclass, 0);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003324 if (!class)
3325 return 0;
3326 }
Frederic Weisbeckerbd6d29c2010-04-06 00:10:17 +02003327 atomic_inc((atomic_t *)&class->ops);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003328 if (very_verbose(class)) {
Borislav Petkov04860d42018-02-26 14:49:26 +01003329 printk("\nacquire class [%px] %s", class->key, class->name);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003330 if (class->name_version > 1)
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01003331 printk(KERN_CONT "#%d", class->name_version);
3332 printk(KERN_CONT "\n");
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003333 dump_stack();
3334 }
3335
3336 /*
3337 * Add the lock to the list of currently held locks.
3338 * (we dont increase the depth just yet, up until the
3339 * dependency checks are done)
3340 */
3341 depth = curr->lockdep_depth;
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003342 /*
3343 * Ran out of static storage for our per-task lock stack again have we?
3344 */
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003345 if (DEBUG_LOCKS_WARN_ON(depth >= MAX_LOCK_DEPTH))
3346 return 0;
3347
Peter Zijlstrabb97a912009-07-20 19:15:35 +02003348 class_idx = class - lock_classes + 1;
3349
Ingo Molnare966eae2017-12-12 12:31:16 +01003350 if (depth) {
Peter Zijlstrabb97a912009-07-20 19:15:35 +02003351 hlock = curr->held_locks + depth - 1;
3352 if (hlock->class_idx == class_idx && nest_lock) {
Peter Zijlstra7fb4a2c2017-03-01 16:23:30 +01003353 if (hlock->references) {
3354 /*
3355 * Check: unsigned int references:12, overflow.
3356 */
3357 if (DEBUG_LOCKS_WARN_ON(hlock->references == (1 << 12)-1))
3358 return 0;
3359
Peter Zijlstrabb97a912009-07-20 19:15:35 +02003360 hlock->references++;
Peter Zijlstra7fb4a2c2017-03-01 16:23:30 +01003361 } else {
Peter Zijlstrabb97a912009-07-20 19:15:35 +02003362 hlock->references = 2;
Peter Zijlstra7fb4a2c2017-03-01 16:23:30 +01003363 }
Peter Zijlstrabb97a912009-07-20 19:15:35 +02003364
3365 return 1;
3366 }
3367 }
3368
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003369 hlock = curr->held_locks + depth;
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003370 /*
3371 * Plain impossible, we just registered it and checked it weren't no
3372 * NULL like.. I bet this mushroom I ate was good!
3373 */
Dave Jonesf82b2172008-08-11 09:30:23 +02003374 if (DEBUG_LOCKS_WARN_ON(!class))
3375 return 0;
Peter Zijlstrabb97a912009-07-20 19:15:35 +02003376 hlock->class_idx = class_idx;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003377 hlock->acquire_ip = ip;
3378 hlock->instance = lock;
Peter Zijlstra7531e2f2008-08-11 09:30:24 +02003379 hlock->nest_lock = nest_lock;
Boqun Fengc2469752016-02-16 13:57:40 +08003380 hlock->irq_context = task_irq_context(curr);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003381 hlock->trylock = trylock;
3382 hlock->read = read;
3383 hlock->check = check;
Dmitry Baryshkov6951b122008-08-18 04:26:37 +04003384 hlock->hardirqs_off = !!hardirqs_off;
Peter Zijlstrabb97a912009-07-20 19:15:35 +02003385 hlock->references = references;
Peter Zijlstraf20786f2007-07-19 01:48:56 -07003386#ifdef CONFIG_LOCK_STAT
3387 hlock->waittime_stamp = 0;
Peter Zijlstra3365e7792009-10-09 10:12:41 +02003388 hlock->holdtime_stamp = lockstat_clock();
Peter Zijlstraf20786f2007-07-19 01:48:56 -07003389#endif
Peter Zijlstra21199f22015-09-16 16:10:40 +02003390 hlock->pin_count = pin_count;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003391
Oleg Nesterovfb9edbe2014-01-20 19:20:06 +01003392 if (check && !mark_irqflags(curr, hlock))
Peter Zijlstra8e182572007-07-19 01:48:54 -07003393 return 0;
3394
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003395 /* mark it as used: */
Jarek Poplawski4ff773bb2007-05-08 00:31:00 -07003396 if (!mark_lock(curr, hlock, LOCK_USED))
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003397 return 0;
Peter Zijlstra8e182572007-07-19 01:48:54 -07003398
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003399 /*
Gautham R Shenoy17aacfb92007-10-28 20:47:01 +01003400 * Calculate the chain hash: it's the combined hash of all the
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003401 * lock keys along the dependency chain. We save the hash value
3402 * at every step so that we can get the current hash easily
3403 * after unlock. The chain hash is then used to cache dependency
3404 * results.
3405 *
3406 * The 'key ID' is what is the most compact key value to drive
3407 * the hash, not class->key.
3408 */
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003409 /*
3410 * Whoops, we did it again.. ran straight out of our static allocation.
3411 */
Alfredo Alvarez Fernandez5f18ab52016-02-11 00:33:32 +01003412 if (DEBUG_LOCKS_WARN_ON(class_idx > MAX_LOCKDEP_KEYS))
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003413 return 0;
3414
3415 chain_key = curr->curr_chain_key;
3416 if (!depth) {
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003417 /*
3418 * How can we have a chain hash when we ain't got no keys?!
3419 */
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003420 if (DEBUG_LOCKS_WARN_ON(chain_key != 0))
3421 return 0;
3422 chain_head = 1;
3423 }
3424
3425 hlock->prev_chain_key = chain_key;
Peter Zijlstra8e182572007-07-19 01:48:54 -07003426 if (separate_irq_context(curr, hlock)) {
3427 chain_key = 0;
3428 chain_head = 1;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003429 }
Alfredo Alvarez Fernandez5f18ab52016-02-11 00:33:32 +01003430 chain_key = iterate_chain_key(chain_key, class_idx);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003431
Peter Zijlstraf8319482016-11-30 14:32:25 +11003432 if (nest_lock && !__lock_is_held(nest_lock, -1))
Maarten Lankhorstd0945952012-09-13 11:39:51 +02003433 return print_lock_nested_lock_not_held(curr, hlock, ip);
3434
Gregory Haskins3aa416b2007-10-11 22:11:11 +02003435 if (!validate_chain(curr, lock, hlock, chain_head, chain_key))
Peter Zijlstra8e182572007-07-19 01:48:54 -07003436 return 0;
Jarek Poplawski381a2292007-02-10 01:44:58 -08003437
Gregory Haskins3aa416b2007-10-11 22:11:11 +02003438 curr->curr_chain_key = chain_key;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003439 curr->lockdep_depth++;
3440 check_chain_key(curr);
Jarek Poplawski60e114d2007-02-20 13:58:00 -08003441#ifdef CONFIG_DEBUG_LOCKDEP
3442 if (unlikely(!debug_locks))
3443 return 0;
3444#endif
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003445 if (unlikely(curr->lockdep_depth >= MAX_LOCK_DEPTH)) {
3446 debug_locks_off();
Dave Jones2c522832013-04-25 13:40:02 -04003447 print_lockdep_off("BUG: MAX_LOCK_DEPTH too low!");
3448 printk(KERN_DEBUG "depth: %i max: %lu!\n",
Ben Greearc0540602013-02-06 10:56:19 -08003449 curr->lockdep_depth, MAX_LOCK_DEPTH);
Ben Greearc0540602013-02-06 10:56:19 -08003450
3451 lockdep_print_held_locks(current);
3452 debug_show_all_locks();
Peter Zijlstraeedeeab2009-03-18 12:38:47 +01003453 dump_stack();
Ben Greearc0540602013-02-06 10:56:19 -08003454
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003455 return 0;
3456 }
Jarek Poplawski381a2292007-02-10 01:44:58 -08003457
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003458 if (unlikely(curr->lockdep_depth > max_lockdep_depth))
3459 max_lockdep_depth = curr->lockdep_depth;
3460
3461 return 1;
3462}
3463
3464static int
Srivatsa S. Bhatf86f7552013-01-08 18:35:58 +05303465print_unlock_imbalance_bug(struct task_struct *curr, struct lockdep_map *lock,
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003466 unsigned long ip)
3467{
3468 if (!debug_locks_off())
3469 return 0;
3470 if (debug_locks_silent)
3471 return 0;
3472
Paul E. McKenney681fbec2017-05-04 15:44:38 -07003473 pr_warn("\n");
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08003474 pr_warn("=====================================\n");
3475 pr_warn("WARNING: bad unlock balance detected!\n");
Ben Hutchingsfbdc4b92011-10-28 04:36:55 +01003476 print_kernel_ident();
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08003477 pr_warn("-------------------------------------\n");
Paul E. McKenney681fbec2017-05-04 15:44:38 -07003478 pr_warn("%s/%d is trying to release lock (",
Pavel Emelyanovba25f9d2007-10-18 23:40:40 -07003479 curr->comm, task_pid_nr(curr));
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003480 print_lockdep_cache(lock);
Paul E. McKenney681fbec2017-05-04 15:44:38 -07003481 pr_cont(") at:\n");
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003482 print_ip_sym(ip);
Paul E. McKenney681fbec2017-05-04 15:44:38 -07003483 pr_warn("but there are no more locks to release!\n");
3484 pr_warn("\nother info that might help us debug this:\n");
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003485 lockdep_print_held_locks(curr);
3486
Paul E. McKenney681fbec2017-05-04 15:44:38 -07003487 pr_warn("\nstack backtrace:\n");
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003488 dump_stack();
3489
3490 return 0;
3491}
3492
Matthew Wilcox08f36ff2018-01-17 07:14:13 -08003493static int match_held_lock(const struct held_lock *hlock,
3494 const struct lockdep_map *lock)
Peter Zijlstrabb97a912009-07-20 19:15:35 +02003495{
3496 if (hlock->instance == lock)
3497 return 1;
3498
3499 if (hlock->references) {
Matthew Wilcox08f36ff2018-01-17 07:14:13 -08003500 const struct lock_class *class = lock->class_cache[0];
Peter Zijlstrabb97a912009-07-20 19:15:35 +02003501
3502 if (!class)
3503 class = look_up_lock_class(lock, 0);
3504
Peter Zijlstra80e04012011-08-05 14:26:17 +02003505 /*
3506 * If look_up_lock_class() failed to find a class, we're trying
3507 * to test if we hold a lock that has never yet been acquired.
3508 * Clearly if the lock hasn't been acquired _ever_, we're not
3509 * holding it either, so report failure.
3510 */
Matthew Wilcox64f29d12018-01-17 07:14:12 -08003511 if (!class)
Peter Zijlstrabb97a912009-07-20 19:15:35 +02003512 return 0;
3513
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003514 /*
3515 * References, but not a lock we're actually ref-counting?
3516 * State got messed up, follow the sites that change ->references
3517 * and try to make sense of it.
3518 */
Peter Zijlstrabb97a912009-07-20 19:15:35 +02003519 if (DEBUG_LOCKS_WARN_ON(!hlock->nest_lock))
3520 return 0;
3521
3522 if (hlock->class_idx == class - lock_classes + 1)
3523 return 1;
3524 }
3525
3526 return 0;
3527}
3528
J. R. Okajima41c2c5b2017-02-03 01:38:15 +09003529/* @depth must not be zero */
3530static struct held_lock *find_held_lock(struct task_struct *curr,
3531 struct lockdep_map *lock,
3532 unsigned int depth, int *idx)
3533{
3534 struct held_lock *ret, *hlock, *prev_hlock;
3535 int i;
3536
3537 i = depth - 1;
3538 hlock = curr->held_locks + i;
3539 ret = hlock;
3540 if (match_held_lock(hlock, lock))
3541 goto out;
3542
3543 ret = NULL;
3544 for (i--, prev_hlock = hlock--;
3545 i >= 0;
3546 i--, prev_hlock = hlock--) {
3547 /*
3548 * We must not cross into another context:
3549 */
3550 if (prev_hlock->irq_context != hlock->irq_context) {
3551 ret = NULL;
3552 break;
3553 }
3554 if (match_held_lock(hlock, lock)) {
3555 ret = hlock;
3556 break;
3557 }
3558 }
3559
3560out:
3561 *idx = i;
3562 return ret;
3563}
3564
J. R. Okajimae9699702017-02-03 01:38:16 +09003565static int reacquire_held_locks(struct task_struct *curr, unsigned int depth,
3566 int idx)
3567{
3568 struct held_lock *hlock;
3569
3570 for (hlock = curr->held_locks + idx; idx < depth; idx++, hlock++) {
3571 if (!__lock_acquire(hlock->instance,
3572 hlock_class(hlock)->subclass,
3573 hlock->trylock,
3574 hlock->read, hlock->check,
3575 hlock->hardirqs_off,
3576 hlock->nest_lock, hlock->acquire_ip,
3577 hlock->references, hlock->pin_count))
3578 return 1;
3579 }
3580 return 0;
3581}
3582
Peter Zijlstra64aa3482008-08-11 09:30:21 +02003583static int
Peter Zijlstra00ef9f72008-12-04 09:00:17 +01003584__lock_set_class(struct lockdep_map *lock, const char *name,
3585 struct lock_class_key *key, unsigned int subclass,
3586 unsigned long ip)
Peter Zijlstra64aa3482008-08-11 09:30:21 +02003587{
3588 struct task_struct *curr = current;
J. R. Okajima41c2c5b2017-02-03 01:38:15 +09003589 struct held_lock *hlock;
Peter Zijlstra64aa3482008-08-11 09:30:21 +02003590 struct lock_class *class;
3591 unsigned int depth;
3592 int i;
3593
3594 depth = curr->lockdep_depth;
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003595 /*
3596 * This function is about (re)setting the class of a held lock,
3597 * yet we're not actually holding any locks. Naughty user!
3598 */
Peter Zijlstra64aa3482008-08-11 09:30:21 +02003599 if (DEBUG_LOCKS_WARN_ON(!depth))
3600 return 0;
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);
Peter Zijlstra64aa3482008-08-11 09:30:21 +02003605
Peter Zijlstra00ef9f72008-12-04 09:00:17 +01003606 lockdep_init_map(lock, name, key, 0);
Peter Zijlstra64aa3482008-08-11 09:30:21 +02003607 class = register_lock_class(lock, subclass, 0);
Dave Jonesf82b2172008-08-11 09:30:23 +02003608 hlock->class_idx = class - lock_classes + 1;
Peter Zijlstra64aa3482008-08-11 09:30:21 +02003609
3610 curr->lockdep_depth = i;
3611 curr->curr_chain_key = hlock->prev_chain_key;
3612
J. R. Okajimae9699702017-02-03 01:38:16 +09003613 if (reacquire_held_locks(curr, depth, i))
3614 return 0;
Peter Zijlstra64aa3482008-08-11 09:30:21 +02003615
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003616 /*
3617 * I took it apart and put it back together again, except now I have
3618 * these 'spare' parts.. where shall I put them.
3619 */
Peter Zijlstra64aa3482008-08-11 09:30:21 +02003620 if (DEBUG_LOCKS_WARN_ON(curr->lockdep_depth != depth))
3621 return 0;
3622 return 1;
3623}
3624
J. R. Okajima6419c4a2017-02-03 01:38:17 +09003625static int __lock_downgrade(struct lockdep_map *lock, unsigned long ip)
3626{
3627 struct task_struct *curr = current;
3628 struct held_lock *hlock;
3629 unsigned int depth;
3630 int i;
3631
3632 depth = curr->lockdep_depth;
3633 /*
3634 * This function is about (re)setting the class of a held lock,
3635 * yet we're not actually holding any locks. Naughty user!
3636 */
3637 if (DEBUG_LOCKS_WARN_ON(!depth))
3638 return 0;
3639
3640 hlock = find_held_lock(curr, lock, depth, &i);
3641 if (!hlock)
3642 return print_unlock_imbalance_bug(curr, lock, ip);
3643
3644 curr->lockdep_depth = i;
3645 curr->curr_chain_key = hlock->prev_chain_key;
3646
3647 WARN(hlock->read, "downgrading a read lock");
3648 hlock->read = 1;
3649 hlock->acquire_ip = ip;
3650
3651 if (reacquire_held_locks(curr, depth, i))
3652 return 0;
3653
3654 /*
3655 * I took it apart and put it back together again, except now I have
3656 * these 'spare' parts.. where shall I put them.
3657 */
3658 if (DEBUG_LOCKS_WARN_ON(curr->lockdep_depth != depth))
3659 return 0;
3660 return 1;
3661}
3662
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003663/*
Peter Zijlstrae0f56fd2015-06-11 14:46:52 +02003664 * Remove the lock to the list of currently held locks - this gets
3665 * called on mutex_unlock()/spin_unlock*() (or on a failed
3666 * mutex_lock_interruptible()).
3667 *
3668 * @nested is an hysterical artifact, needs a tree wide cleanup.
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003669 */
3670static int
Peter Zijlstrae0f56fd2015-06-11 14:46:52 +02003671__lock_release(struct lockdep_map *lock, int nested, unsigned long ip)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003672{
Peter Zijlstrae0f56fd2015-06-11 14:46:52 +02003673 struct task_struct *curr = current;
J. R. Okajima41c2c5b2017-02-03 01:38:15 +09003674 struct held_lock *hlock;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003675 unsigned int depth;
Ingo Molnare966eae2017-12-12 12:31:16 +01003676 int i;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003677
Peter Zijlstrae0f56fd2015-06-11 14:46:52 +02003678 if (unlikely(!debug_locks))
3679 return 0;
3680
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003681 depth = curr->lockdep_depth;
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003682 /*
3683 * So we're all set to release this lock.. wait what lock? We don't
3684 * own any locks, you've been drinking again?
3685 */
Peter Zijlstrae0f56fd2015-06-11 14:46:52 +02003686 if (DEBUG_LOCKS_WARN_ON(depth <= 0))
3687 return print_unlock_imbalance_bug(curr, lock, ip);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003688
Peter Zijlstrae0f56fd2015-06-11 14:46:52 +02003689 /*
3690 * Check whether the lock exists in the current stack
3691 * of held locks:
3692 */
J. R. Okajima41c2c5b2017-02-03 01:38:15 +09003693 hlock = find_held_lock(curr, lock, depth, &i);
3694 if (!hlock)
3695 return print_unlock_imbalance_bug(curr, lock, ip);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003696
Peter Zijlstrabb97a912009-07-20 19:15:35 +02003697 if (hlock->instance == lock)
3698 lock_release_holdtime(hlock);
3699
Peter Zijlstraa24fc602015-06-11 14:46:53 +02003700 WARN(hlock->pin_count, "releasing a pinned lock\n");
3701
Peter Zijlstrabb97a912009-07-20 19:15:35 +02003702 if (hlock->references) {
3703 hlock->references--;
3704 if (hlock->references) {
3705 /*
3706 * We had, and after removing one, still have
3707 * references, the current lock stack is still
3708 * valid. We're done!
3709 */
3710 return 1;
3711 }
3712 }
Peter Zijlstraf20786f2007-07-19 01:48:56 -07003713
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003714 /*
3715 * We have the right lock to unlock, 'hlock' points to it.
3716 * Now we remove it from the stack, and add back the other
3717 * entries (if any), recalculating the hash along the way:
3718 */
Peter Zijlstrabb97a912009-07-20 19:15:35 +02003719
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003720 curr->lockdep_depth = i;
3721 curr->curr_chain_key = hlock->prev_chain_key;
3722
J. R. Okajimae9699702017-02-03 01:38:16 +09003723 if (reacquire_held_locks(curr, depth, i + 1))
3724 return 0;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003725
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003726 /*
3727 * We had N bottles of beer on the wall, we drank one, but now
3728 * there's not N-1 bottles of beer left on the wall...
3729 */
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003730 if (DEBUG_LOCKS_WARN_ON(curr->lockdep_depth != depth - 1))
3731 return 0;
Peter Zijlstrae0f56fd2015-06-11 14:46:52 +02003732
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003733 return 1;
3734}
3735
Matthew Wilcox08f36ff2018-01-17 07:14:13 -08003736static int __lock_is_held(const struct lockdep_map *lock, int read)
Peter Zijlstraf607c662009-07-20 19:16:29 +02003737{
3738 struct task_struct *curr = current;
3739 int i;
3740
3741 for (i = 0; i < curr->lockdep_depth; i++) {
Peter Zijlstrabb97a912009-07-20 19:15:35 +02003742 struct held_lock *hlock = curr->held_locks + i;
3743
Peter Zijlstraf8319482016-11-30 14:32:25 +11003744 if (match_held_lock(hlock, lock)) {
3745 if (read == -1 || hlock->read == read)
3746 return 1;
3747
3748 return 0;
3749 }
Peter Zijlstraf607c662009-07-20 19:16:29 +02003750 }
3751
3752 return 0;
3753}
3754
Peter Zijlstrae7904a22015-08-01 19:25:08 +02003755static struct pin_cookie __lock_pin_lock(struct lockdep_map *lock)
3756{
3757 struct pin_cookie cookie = NIL_COOKIE;
3758 struct task_struct *curr = current;
3759 int i;
3760
3761 if (unlikely(!debug_locks))
3762 return cookie;
3763
3764 for (i = 0; i < curr->lockdep_depth; i++) {
3765 struct held_lock *hlock = curr->held_locks + i;
3766
3767 if (match_held_lock(hlock, lock)) {
3768 /*
3769 * Grab 16bits of randomness; this is sufficient to not
3770 * be guessable and still allows some pin nesting in
3771 * our u32 pin_count.
3772 */
3773 cookie.val = 1 + (prandom_u32() >> 16);
3774 hlock->pin_count += cookie.val;
3775 return cookie;
3776 }
3777 }
3778
3779 WARN(1, "pinning an unheld lock\n");
3780 return cookie;
3781}
3782
3783static void __lock_repin_lock(struct lockdep_map *lock, struct pin_cookie cookie)
Peter Zijlstraa24fc602015-06-11 14:46:53 +02003784{
3785 struct task_struct *curr = current;
3786 int i;
3787
3788 if (unlikely(!debug_locks))
3789 return;
3790
3791 for (i = 0; i < curr->lockdep_depth; i++) {
3792 struct held_lock *hlock = curr->held_locks + i;
3793
3794 if (match_held_lock(hlock, lock)) {
Peter Zijlstrae7904a22015-08-01 19:25:08 +02003795 hlock->pin_count += cookie.val;
Peter Zijlstraa24fc602015-06-11 14:46:53 +02003796 return;
3797 }
3798 }
3799
3800 WARN(1, "pinning an unheld lock\n");
3801}
3802
Peter Zijlstrae7904a22015-08-01 19:25:08 +02003803static void __lock_unpin_lock(struct lockdep_map *lock, struct pin_cookie cookie)
Peter Zijlstraa24fc602015-06-11 14:46:53 +02003804{
3805 struct task_struct *curr = current;
3806 int i;
3807
3808 if (unlikely(!debug_locks))
3809 return;
3810
3811 for (i = 0; i < curr->lockdep_depth; i++) {
3812 struct held_lock *hlock = curr->held_locks + i;
3813
3814 if (match_held_lock(hlock, lock)) {
3815 if (WARN(!hlock->pin_count, "unpinning an unpinned lock\n"))
3816 return;
3817
Peter Zijlstrae7904a22015-08-01 19:25:08 +02003818 hlock->pin_count -= cookie.val;
3819
3820 if (WARN((int)hlock->pin_count < 0, "pin count corrupted\n"))
3821 hlock->pin_count = 0;
3822
Peter Zijlstraa24fc602015-06-11 14:46:53 +02003823 return;
3824 }
3825 }
3826
3827 WARN(1, "unpinning an unheld lock\n");
3828}
3829
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003830/*
3831 * Check whether we follow the irq-flags state precisely:
3832 */
Steven Rostedt1d09daa2008-05-12 21:20:55 +02003833static void check_flags(unsigned long flags)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003834{
Ingo Molnar992860e2008-07-14 10:28:38 +02003835#if defined(CONFIG_PROVE_LOCKING) && defined(CONFIG_DEBUG_LOCKDEP) && \
3836 defined(CONFIG_TRACE_IRQFLAGS)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003837 if (!debug_locks)
3838 return;
3839
Ingo Molnar5f9fa8a2007-12-07 19:02:47 +01003840 if (irqs_disabled_flags(flags)) {
3841 if (DEBUG_LOCKS_WARN_ON(current->hardirqs_enabled)) {
3842 printk("possible reason: unannotated irqs-off.\n");
3843 }
3844 } else {
3845 if (DEBUG_LOCKS_WARN_ON(!current->hardirqs_enabled)) {
3846 printk("possible reason: unannotated irqs-on.\n");
3847 }
3848 }
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003849
3850 /*
3851 * We dont accurately track softirq state in e.g.
3852 * hardirq contexts (such as on 4KSTACKS), so only
3853 * check if not in hardirq contexts:
3854 */
3855 if (!hardirq_count()) {
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003856 if (softirq_count()) {
3857 /* like the above, but with softirqs */
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003858 DEBUG_LOCKS_WARN_ON(current->softirqs_enabled);
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003859 } else {
3860 /* lick the above, does it taste good? */
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003861 DEBUG_LOCKS_WARN_ON(!current->softirqs_enabled);
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003862 }
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003863 }
3864
3865 if (!debug_locks)
3866 print_irqtrace_events(current);
3867#endif
3868}
3869
Peter Zijlstra00ef9f72008-12-04 09:00:17 +01003870void lock_set_class(struct lockdep_map *lock, const char *name,
3871 struct lock_class_key *key, unsigned int subclass,
3872 unsigned long ip)
Peter Zijlstra64aa3482008-08-11 09:30:21 +02003873{
3874 unsigned long flags;
3875
3876 if (unlikely(current->lockdep_recursion))
3877 return;
3878
3879 raw_local_irq_save(flags);
3880 current->lockdep_recursion = 1;
3881 check_flags(flags);
Peter Zijlstra00ef9f72008-12-04 09:00:17 +01003882 if (__lock_set_class(lock, name, key, subclass, ip))
Peter Zijlstra64aa3482008-08-11 09:30:21 +02003883 check_chain_key(current);
3884 current->lockdep_recursion = 0;
3885 raw_local_irq_restore(flags);
3886}
Peter Zijlstra00ef9f72008-12-04 09:00:17 +01003887EXPORT_SYMBOL_GPL(lock_set_class);
Peter Zijlstra64aa3482008-08-11 09:30:21 +02003888
J. R. Okajima6419c4a2017-02-03 01:38:17 +09003889void lock_downgrade(struct lockdep_map *lock, unsigned long ip)
3890{
3891 unsigned long flags;
3892
3893 if (unlikely(current->lockdep_recursion))
3894 return;
3895
3896 raw_local_irq_save(flags);
3897 current->lockdep_recursion = 1;
3898 check_flags(flags);
3899 if (__lock_downgrade(lock, ip))
3900 check_chain_key(current);
3901 current->lockdep_recursion = 0;
3902 raw_local_irq_restore(flags);
3903}
3904EXPORT_SYMBOL_GPL(lock_downgrade);
3905
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003906/*
3907 * We are not always called with irqs disabled - do that here,
3908 * and also avoid lockdep recursion:
3909 */
Steven Rostedt1d09daa2008-05-12 21:20:55 +02003910void lock_acquire(struct lockdep_map *lock, unsigned int subclass,
Peter Zijlstra7531e2f2008-08-11 09:30:24 +02003911 int trylock, int read, int check,
3912 struct lockdep_map *nest_lock, unsigned long ip)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003913{
3914 unsigned long flags;
3915
3916 if (unlikely(current->lockdep_recursion))
3917 return;
3918
3919 raw_local_irq_save(flags);
3920 check_flags(flags);
3921
3922 current->lockdep_recursion = 1;
Frederic Weisbeckerdb2c4c72010-02-02 23:34:40 +01003923 trace_lock_acquire(lock, subclass, trylock, read, check, nest_lock, ip);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003924 __lock_acquire(lock, subclass, trylock, read, check,
Peter Zijlstra21199f22015-09-16 16:10:40 +02003925 irqs_disabled_flags(flags), nest_lock, ip, 0, 0);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003926 current->lockdep_recursion = 0;
3927 raw_local_irq_restore(flags);
3928}
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003929EXPORT_SYMBOL_GPL(lock_acquire);
3930
Steven Rostedt1d09daa2008-05-12 21:20:55 +02003931void lock_release(struct lockdep_map *lock, int nested,
Steven Rostedt0764d232008-05-12 21:20:44 +02003932 unsigned long ip)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003933{
3934 unsigned long flags;
3935
3936 if (unlikely(current->lockdep_recursion))
3937 return;
3938
3939 raw_local_irq_save(flags);
3940 check_flags(flags);
3941 current->lockdep_recursion = 1;
Frederic Weisbecker93135432010-05-08 06:24:25 +02003942 trace_lock_release(lock, ip);
Peter Zijlstrae0f56fd2015-06-11 14:46:52 +02003943 if (__lock_release(lock, nested, ip))
3944 check_chain_key(current);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003945 current->lockdep_recursion = 0;
3946 raw_local_irq_restore(flags);
3947}
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003948EXPORT_SYMBOL_GPL(lock_release);
3949
Matthew Wilcox08f36ff2018-01-17 07:14:13 -08003950int lock_is_held_type(const struct lockdep_map *lock, int read)
Peter Zijlstraf607c662009-07-20 19:16:29 +02003951{
3952 unsigned long flags;
3953 int ret = 0;
3954
3955 if (unlikely(current->lockdep_recursion))
Peter Zijlstraf2513cd2011-06-06 12:32:43 +02003956 return 1; /* avoid false negative lockdep_assert_held() */
Peter Zijlstraf607c662009-07-20 19:16:29 +02003957
3958 raw_local_irq_save(flags);
3959 check_flags(flags);
3960
3961 current->lockdep_recursion = 1;
Peter Zijlstraf8319482016-11-30 14:32:25 +11003962 ret = __lock_is_held(lock, read);
Peter Zijlstraf607c662009-07-20 19:16:29 +02003963 current->lockdep_recursion = 0;
3964 raw_local_irq_restore(flags);
3965
3966 return ret;
3967}
Peter Zijlstraf8319482016-11-30 14:32:25 +11003968EXPORT_SYMBOL_GPL(lock_is_held_type);
Peter Zijlstraf607c662009-07-20 19:16:29 +02003969
Peter Zijlstrae7904a22015-08-01 19:25:08 +02003970struct pin_cookie lock_pin_lock(struct lockdep_map *lock)
Peter Zijlstraa24fc602015-06-11 14:46:53 +02003971{
Peter Zijlstrae7904a22015-08-01 19:25:08 +02003972 struct pin_cookie cookie = NIL_COOKIE;
Peter Zijlstraa24fc602015-06-11 14:46:53 +02003973 unsigned long flags;
3974
3975 if (unlikely(current->lockdep_recursion))
Peter Zijlstrae7904a22015-08-01 19:25:08 +02003976 return cookie;
Peter Zijlstraa24fc602015-06-11 14:46:53 +02003977
3978 raw_local_irq_save(flags);
3979 check_flags(flags);
3980
3981 current->lockdep_recursion = 1;
Peter Zijlstrae7904a22015-08-01 19:25:08 +02003982 cookie = __lock_pin_lock(lock);
Peter Zijlstraa24fc602015-06-11 14:46:53 +02003983 current->lockdep_recursion = 0;
3984 raw_local_irq_restore(flags);
Peter Zijlstrae7904a22015-08-01 19:25:08 +02003985
3986 return cookie;
Peter Zijlstraa24fc602015-06-11 14:46:53 +02003987}
3988EXPORT_SYMBOL_GPL(lock_pin_lock);
3989
Peter Zijlstrae7904a22015-08-01 19:25:08 +02003990void lock_repin_lock(struct lockdep_map *lock, struct pin_cookie cookie)
Peter Zijlstraa24fc602015-06-11 14:46:53 +02003991{
3992 unsigned long flags;
3993
3994 if (unlikely(current->lockdep_recursion))
3995 return;
3996
3997 raw_local_irq_save(flags);
3998 check_flags(flags);
3999
4000 current->lockdep_recursion = 1;
Peter Zijlstrae7904a22015-08-01 19:25:08 +02004001 __lock_repin_lock(lock, cookie);
4002 current->lockdep_recursion = 0;
4003 raw_local_irq_restore(flags);
4004}
4005EXPORT_SYMBOL_GPL(lock_repin_lock);
4006
4007void lock_unpin_lock(struct lockdep_map *lock, struct pin_cookie cookie)
4008{
4009 unsigned long flags;
4010
4011 if (unlikely(current->lockdep_recursion))
4012 return;
4013
4014 raw_local_irq_save(flags);
4015 check_flags(flags);
4016
4017 current->lockdep_recursion = 1;
4018 __lock_unpin_lock(lock, cookie);
Peter Zijlstraa24fc602015-06-11 14:46:53 +02004019 current->lockdep_recursion = 0;
4020 raw_local_irq_restore(flags);
4021}
4022EXPORT_SYMBOL_GPL(lock_unpin_lock);
4023
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004024#ifdef CONFIG_LOCK_STAT
4025static int
4026print_lock_contention_bug(struct task_struct *curr, struct lockdep_map *lock,
4027 unsigned long ip)
4028{
4029 if (!debug_locks_off())
4030 return 0;
4031 if (debug_locks_silent)
4032 return 0;
4033
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004034 pr_warn("\n");
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08004035 pr_warn("=================================\n");
4036 pr_warn("WARNING: bad contention detected!\n");
Ben Hutchingsfbdc4b92011-10-28 04:36:55 +01004037 print_kernel_ident();
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08004038 pr_warn("---------------------------------\n");
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004039 pr_warn("%s/%d is trying to contend lock (",
Pavel Emelyanovba25f9d2007-10-18 23:40:40 -07004040 curr->comm, task_pid_nr(curr));
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004041 print_lockdep_cache(lock);
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004042 pr_cont(") at:\n");
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004043 print_ip_sym(ip);
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004044 pr_warn("but there are no locks held!\n");
4045 pr_warn("\nother info that might help us debug this:\n");
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004046 lockdep_print_held_locks(curr);
4047
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004048 pr_warn("\nstack backtrace:\n");
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004049 dump_stack();
4050
4051 return 0;
4052}
4053
4054static void
4055__lock_contended(struct lockdep_map *lock, unsigned long ip)
4056{
4057 struct task_struct *curr = current;
J. R. Okajima41c2c5b2017-02-03 01:38:15 +09004058 struct held_lock *hlock;
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004059 struct lock_class_stats *stats;
4060 unsigned int depth;
Peter Zijlstrac7e78cf2008-10-16 23:17:09 +02004061 int i, contention_point, contending_point;
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004062
4063 depth = curr->lockdep_depth;
Peter Zijlstra0119fee2011-09-02 01:30:29 +02004064 /*
4065 * Whee, we contended on this lock, except it seems we're not
4066 * actually trying to acquire anything much at all..
4067 */
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004068 if (DEBUG_LOCKS_WARN_ON(!depth))
4069 return;
4070
J. R. Okajima41c2c5b2017-02-03 01:38:15 +09004071 hlock = find_held_lock(curr, lock, depth, &i);
4072 if (!hlock) {
4073 print_lock_contention_bug(curr, lock, ip);
4074 return;
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004075 }
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004076
Peter Zijlstrabb97a912009-07-20 19:15:35 +02004077 if (hlock->instance != lock)
4078 return;
4079
Peter Zijlstra3365e7792009-10-09 10:12:41 +02004080 hlock->waittime_stamp = lockstat_clock();
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004081
Peter Zijlstrac7e78cf2008-10-16 23:17:09 +02004082 contention_point = lock_point(hlock_class(hlock)->contention_point, ip);
4083 contending_point = lock_point(hlock_class(hlock)->contending_point,
4084 lock->ip);
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004085
Dave Jonesf82b2172008-08-11 09:30:23 +02004086 stats = get_lock_stats(hlock_class(hlock));
Peter Zijlstrac7e78cf2008-10-16 23:17:09 +02004087 if (contention_point < LOCKSTAT_POINTS)
4088 stats->contention_point[contention_point]++;
4089 if (contending_point < LOCKSTAT_POINTS)
4090 stats->contending_point[contending_point]++;
Peter Zijlstra96645672007-07-19 01:49:00 -07004091 if (lock->cpu != smp_processor_id())
4092 stats->bounces[bounce_contended + !!hlock->read]++;
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004093 put_lock_stats(stats);
4094}
4095
4096static void
Peter Zijlstrac7e78cf2008-10-16 23:17:09 +02004097__lock_acquired(struct lockdep_map *lock, unsigned long ip)
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004098{
4099 struct task_struct *curr = current;
J. R. Okajima41c2c5b2017-02-03 01:38:15 +09004100 struct held_lock *hlock;
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004101 struct lock_class_stats *stats;
4102 unsigned int depth;
Peter Zijlstra3365e7792009-10-09 10:12:41 +02004103 u64 now, waittime = 0;
Peter Zijlstra96645672007-07-19 01:49:00 -07004104 int i, cpu;
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004105
4106 depth = curr->lockdep_depth;
Peter Zijlstra0119fee2011-09-02 01:30:29 +02004107 /*
4108 * Yay, we acquired ownership of this lock we didn't try to
4109 * acquire, how the heck did that happen?
4110 */
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004111 if (DEBUG_LOCKS_WARN_ON(!depth))
4112 return;
4113
J. R. Okajima41c2c5b2017-02-03 01:38:15 +09004114 hlock = find_held_lock(curr, lock, depth, &i);
4115 if (!hlock) {
4116 print_lock_contention_bug(curr, lock, _RET_IP_);
4117 return;
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004118 }
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004119
Peter Zijlstrabb97a912009-07-20 19:15:35 +02004120 if (hlock->instance != lock)
4121 return;
4122
Peter Zijlstra96645672007-07-19 01:49:00 -07004123 cpu = smp_processor_id();
4124 if (hlock->waittime_stamp) {
Peter Zijlstra3365e7792009-10-09 10:12:41 +02004125 now = lockstat_clock();
Peter Zijlstra96645672007-07-19 01:49:00 -07004126 waittime = now - hlock->waittime_stamp;
4127 hlock->holdtime_stamp = now;
4128 }
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004129
Frederic Weisbecker883a2a32010-05-08 06:16:11 +02004130 trace_lock_acquired(lock, ip);
Frederic Weisbecker20625012009-04-06 01:49:33 +02004131
Dave Jonesf82b2172008-08-11 09:30:23 +02004132 stats = get_lock_stats(hlock_class(hlock));
Peter Zijlstra96645672007-07-19 01:49:00 -07004133 if (waittime) {
4134 if (hlock->read)
4135 lock_time_inc(&stats->read_waittime, waittime);
4136 else
4137 lock_time_inc(&stats->write_waittime, waittime);
4138 }
4139 if (lock->cpu != cpu)
4140 stats->bounces[bounce_acquired + !!hlock->read]++;
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004141 put_lock_stats(stats);
Peter Zijlstra96645672007-07-19 01:49:00 -07004142
4143 lock->cpu = cpu;
Peter Zijlstrac7e78cf2008-10-16 23:17:09 +02004144 lock->ip = ip;
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004145}
4146
4147void lock_contended(struct lockdep_map *lock, unsigned long ip)
4148{
4149 unsigned long flags;
4150
4151 if (unlikely(!lock_stat))
4152 return;
4153
4154 if (unlikely(current->lockdep_recursion))
4155 return;
4156
4157 raw_local_irq_save(flags);
4158 check_flags(flags);
4159 current->lockdep_recursion = 1;
Frederic Weisbeckerdb2c4c72010-02-02 23:34:40 +01004160 trace_lock_contended(lock, ip);
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004161 __lock_contended(lock, ip);
4162 current->lockdep_recursion = 0;
4163 raw_local_irq_restore(flags);
4164}
4165EXPORT_SYMBOL_GPL(lock_contended);
4166
Peter Zijlstrac7e78cf2008-10-16 23:17:09 +02004167void lock_acquired(struct lockdep_map *lock, unsigned long ip)
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004168{
4169 unsigned long flags;
4170
4171 if (unlikely(!lock_stat))
4172 return;
4173
4174 if (unlikely(current->lockdep_recursion))
4175 return;
4176
4177 raw_local_irq_save(flags);
4178 check_flags(flags);
4179 current->lockdep_recursion = 1;
Peter Zijlstrac7e78cf2008-10-16 23:17:09 +02004180 __lock_acquired(lock, ip);
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004181 current->lockdep_recursion = 0;
4182 raw_local_irq_restore(flags);
4183}
4184EXPORT_SYMBOL_GPL(lock_acquired);
4185#endif
4186
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004187/*
4188 * Used by the testsuite, sanitize the validator state
4189 * after a simulated failure:
4190 */
4191
4192void lockdep_reset(void)
4193{
4194 unsigned long flags;
Ingo Molnar23d95a02006-12-13 00:34:40 -08004195 int i;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004196
4197 raw_local_irq_save(flags);
4198 current->curr_chain_key = 0;
4199 current->lockdep_depth = 0;
4200 current->lockdep_recursion = 0;
4201 memset(current->held_locks, 0, MAX_LOCK_DEPTH*sizeof(struct held_lock));
4202 nr_hardirq_chains = 0;
4203 nr_softirq_chains = 0;
4204 nr_process_chains = 0;
4205 debug_locks = 1;
Ingo Molnar23d95a02006-12-13 00:34:40 -08004206 for (i = 0; i < CHAINHASH_SIZE; i++)
Andrew Mortona63f38c2016-02-03 13:44:12 -08004207 INIT_HLIST_HEAD(chainhash_table + i);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004208 raw_local_irq_restore(flags);
4209}
4210
4211static void zap_class(struct lock_class *class)
4212{
4213 int i;
4214
4215 /*
4216 * Remove all dependencies this lock is
4217 * involved in:
4218 */
4219 for (i = 0; i < nr_list_entries; i++) {
4220 if (list_entries[i].class == class)
4221 list_del_rcu(&list_entries[i].entry);
4222 }
4223 /*
4224 * Unhash the class and remove it from the all_lock_classes list:
4225 */
Andrew Mortona63f38c2016-02-03 13:44:12 -08004226 hlist_del_rcu(&class->hash_entry);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004227 list_del_rcu(&class->lock_entry);
4228
Peter Zijlstracee34d82015-06-02 12:50:13 +02004229 RCU_INIT_POINTER(class->key, NULL);
4230 RCU_INIT_POINTER(class->name, NULL);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004231}
4232
Arjan van de Venfabe8742008-01-24 07:00:45 +01004233static inline int within(const void *addr, void *start, unsigned long size)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004234{
4235 return addr >= start && addr < start + size;
4236}
4237
Peter Zijlstra35a93932015-02-26 16:23:11 +01004238/*
4239 * Used in module.c to remove lock classes from memory that is going to be
4240 * freed; and possibly re-used by other modules.
4241 *
4242 * We will have had one sync_sched() before getting here, so we're guaranteed
4243 * nobody will look up these exact classes -- they're properly dead but still
4244 * allocated.
4245 */
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004246void lockdep_free_key_range(void *start, unsigned long size)
4247{
Peter Zijlstra35a93932015-02-26 16:23:11 +01004248 struct lock_class *class;
Andrew Mortona63f38c2016-02-03 13:44:12 -08004249 struct hlist_head *head;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004250 unsigned long flags;
4251 int i;
Nick Piggin5a26db52008-01-16 09:51:58 +01004252 int locked;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004253
4254 raw_local_irq_save(flags);
Nick Piggin5a26db52008-01-16 09:51:58 +01004255 locked = graph_lock();
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004256
4257 /*
4258 * Unhash all classes that were created by this module:
4259 */
4260 for (i = 0; i < CLASSHASH_SIZE; i++) {
4261 head = classhash_table + i;
Andrew Mortona63f38c2016-02-03 13:44:12 -08004262 hlist_for_each_entry_rcu(class, head, hash_entry) {
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004263 if (within(class->key, start, size))
4264 zap_class(class);
Arjan van de Venfabe8742008-01-24 07:00:45 +01004265 else if (within(class->name, start, size))
4266 zap_class(class);
4267 }
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004268 }
4269
Nick Piggin5a26db52008-01-16 09:51:58 +01004270 if (locked)
4271 graph_unlock();
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004272 raw_local_irq_restore(flags);
Peter Zijlstra35a93932015-02-26 16:23:11 +01004273
4274 /*
4275 * Wait for any possible iterators from look_up_lock_class() to pass
4276 * before continuing to free the memory they refer to.
4277 *
4278 * sync_sched() is sufficient because the read-side is IRQ disable.
4279 */
4280 synchronize_sched();
4281
4282 /*
4283 * XXX at this point we could return the resources to the pool;
4284 * instead we leak them. We would need to change to bitmap allocators
4285 * instead of the linear allocators we have now.
4286 */
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004287}
4288
4289void lockdep_reset_lock(struct lockdep_map *lock)
4290{
Peter Zijlstra35a93932015-02-26 16:23:11 +01004291 struct lock_class *class;
Andrew Mortona63f38c2016-02-03 13:44:12 -08004292 struct hlist_head *head;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004293 unsigned long flags;
4294 int i, j;
Nick Piggin5a26db52008-01-16 09:51:58 +01004295 int locked;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004296
4297 raw_local_irq_save(flags);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004298
4299 /*
Ingo Molnard6d897c2006-07-10 04:44:04 -07004300 * Remove all classes this lock might have:
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004301 */
Ingo Molnard6d897c2006-07-10 04:44:04 -07004302 for (j = 0; j < MAX_LOCKDEP_SUBCLASSES; j++) {
4303 /*
4304 * If the class exists we look it up and zap it:
4305 */
4306 class = look_up_lock_class(lock, j);
Matthew Wilcox64f29d12018-01-17 07:14:12 -08004307 if (class)
Ingo Molnard6d897c2006-07-10 04:44:04 -07004308 zap_class(class);
4309 }
4310 /*
4311 * Debug check: in the end all mapped classes should
4312 * be gone.
4313 */
Nick Piggin5a26db52008-01-16 09:51:58 +01004314 locked = graph_lock();
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004315 for (i = 0; i < CLASSHASH_SIZE; i++) {
4316 head = classhash_table + i;
Andrew Mortona63f38c2016-02-03 13:44:12 -08004317 hlist_for_each_entry_rcu(class, head, hash_entry) {
Hitoshi Mitake62016252010-10-05 18:01:51 +09004318 int match = 0;
4319
4320 for (j = 0; j < NR_LOCKDEP_CACHING_CLASSES; j++)
4321 match |= class == lock->class_cache[j];
4322
4323 if (unlikely(match)) {
Peter Zijlstra0119fee2011-09-02 01:30:29 +02004324 if (debug_locks_off_graph_unlock()) {
4325 /*
4326 * We all just reset everything, how did it match?
4327 */
Ingo Molnar74c383f2006-12-13 00:34:43 -08004328 WARN_ON(1);
Peter Zijlstra0119fee2011-09-02 01:30:29 +02004329 }
Ingo Molnard6d897c2006-07-10 04:44:04 -07004330 goto out_restore;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004331 }
4332 }
4333 }
Nick Piggin5a26db52008-01-16 09:51:58 +01004334 if (locked)
4335 graph_unlock();
Ingo Molnard6d897c2006-07-10 04:44:04 -07004336
4337out_restore:
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004338 raw_local_irq_restore(flags);
4339}
4340
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004341void __init lockdep_info(void)
4342{
4343 printk("Lock dependency validator: Copyright (c) 2006 Red Hat, Inc., Ingo Molnar\n");
4344
Li Zefanb0788ca2008-11-21 15:57:32 +08004345 printk("... MAX_LOCKDEP_SUBCLASSES: %lu\n", MAX_LOCKDEP_SUBCLASSES);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004346 printk("... MAX_LOCK_DEPTH: %lu\n", MAX_LOCK_DEPTH);
4347 printk("... MAX_LOCKDEP_KEYS: %lu\n", MAX_LOCKDEP_KEYS);
Li Zefanb0788ca2008-11-21 15:57:32 +08004348 printk("... CLASSHASH_SIZE: %lu\n", CLASSHASH_SIZE);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004349 printk("... MAX_LOCKDEP_ENTRIES: %lu\n", MAX_LOCKDEP_ENTRIES);
4350 printk("... MAX_LOCKDEP_CHAINS: %lu\n", MAX_LOCKDEP_CHAINS);
4351 printk("... CHAINHASH_SIZE: %lu\n", CHAINHASH_SIZE);
4352
4353 printk(" memory used by lock dependency info: %lu kB\n",
4354 (sizeof(struct lock_class) * MAX_LOCKDEP_KEYS +
4355 sizeof(struct list_head) * CLASSHASH_SIZE +
4356 sizeof(struct lock_list) * MAX_LOCKDEP_ENTRIES +
4357 sizeof(struct lock_chain) * MAX_LOCKDEP_CHAINS +
Ming Lei906292092009-08-02 21:43:36 +08004358 sizeof(struct list_head) * CHAINHASH_SIZE
Ming Lei4dd861d2009-07-16 15:44:29 +02004359#ifdef CONFIG_PROVE_LOCKING
Ming Leie351b662009-07-22 22:48:09 +08004360 + sizeof(struct circular_queue)
Ming Lei4dd861d2009-07-16 15:44:29 +02004361#endif
Ming Lei906292092009-08-02 21:43:36 +08004362 ) / 1024
Ming Lei4dd861d2009-07-16 15:44:29 +02004363 );
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004364
4365 printk(" per task-struct memory footprint: %lu bytes\n",
4366 sizeof(struct held_lock) * MAX_LOCK_DEPTH);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004367}
4368
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004369static void
4370print_freed_lock_bug(struct task_struct *curr, const void *mem_from,
Arjan van de Ven55794a42006-07-10 04:44:03 -07004371 const void *mem_to, struct held_lock *hlock)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004372{
4373 if (!debug_locks_off())
4374 return;
4375 if (debug_locks_silent)
4376 return;
4377
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004378 pr_warn("\n");
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08004379 pr_warn("=========================\n");
4380 pr_warn("WARNING: held lock freed!\n");
Ben Hutchingsfbdc4b92011-10-28 04:36:55 +01004381 print_kernel_ident();
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08004382 pr_warn("-------------------------\n");
Borislav Petkov04860d42018-02-26 14:49:26 +01004383 pr_warn("%s/%d is freeing memory %px-%px, with a lock still held there!\n",
Pavel Emelyanovba25f9d2007-10-18 23:40:40 -07004384 curr->comm, task_pid_nr(curr), mem_from, mem_to-1);
Arjan van de Ven55794a42006-07-10 04:44:03 -07004385 print_lock(hlock);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004386 lockdep_print_held_locks(curr);
4387
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004388 pr_warn("\nstack backtrace:\n");
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004389 dump_stack();
4390}
4391
Oleg Nesterov54561782007-12-05 15:46:09 +01004392static inline int not_in_range(const void* mem_from, unsigned long mem_len,
4393 const void* lock_from, unsigned long lock_len)
4394{
4395 return lock_from + lock_len <= mem_from ||
4396 mem_from + mem_len <= lock_from;
4397}
4398
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004399/*
4400 * Called when kernel memory is freed (or unmapped), or if a lock
4401 * is destroyed or reinitialized - this code checks whether there is
4402 * any held lock in the memory range of <from> to <to>:
4403 */
4404void debug_check_no_locks_freed(const void *mem_from, unsigned long mem_len)
4405{
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004406 struct task_struct *curr = current;
4407 struct held_lock *hlock;
4408 unsigned long flags;
4409 int i;
4410
4411 if (unlikely(!debug_locks))
4412 return;
4413
4414 local_irq_save(flags);
4415 for (i = 0; i < curr->lockdep_depth; i++) {
4416 hlock = curr->held_locks + i;
4417
Oleg Nesterov54561782007-12-05 15:46:09 +01004418 if (not_in_range(mem_from, mem_len, hlock->instance,
4419 sizeof(*hlock->instance)))
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004420 continue;
4421
Oleg Nesterov54561782007-12-05 15:46:09 +01004422 print_freed_lock_bug(curr, mem_from, mem_from + mem_len, hlock);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004423 break;
4424 }
4425 local_irq_restore(flags);
4426}
Peter Zijlstraed075362006-12-06 20:35:24 -08004427EXPORT_SYMBOL_GPL(debug_check_no_locks_freed);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004428
Colin Cross1b1d2fb2013-05-06 23:50:08 +00004429static void print_held_locks_bug(void)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004430{
4431 if (!debug_locks_off())
4432 return;
4433 if (debug_locks_silent)
4434 return;
4435
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004436 pr_warn("\n");
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08004437 pr_warn("====================================\n");
4438 pr_warn("WARNING: %s/%d still has locks held!\n",
Colin Cross1b1d2fb2013-05-06 23:50:08 +00004439 current->comm, task_pid_nr(current));
Ben Hutchingsfbdc4b92011-10-28 04:36:55 +01004440 print_kernel_ident();
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08004441 pr_warn("------------------------------------\n");
Colin Cross1b1d2fb2013-05-06 23:50:08 +00004442 lockdep_print_held_locks(current);
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004443 pr_warn("\nstack backtrace:\n");
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004444 dump_stack();
4445}
4446
Colin Cross1b1d2fb2013-05-06 23:50:08 +00004447void debug_check_no_locks_held(void)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004448{
Colin Cross1b1d2fb2013-05-06 23:50:08 +00004449 if (unlikely(current->lockdep_depth > 0))
4450 print_held_locks_bug();
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004451}
Colin Cross1b1d2fb2013-05-06 23:50:08 +00004452EXPORT_SYMBOL_GPL(debug_check_no_locks_held);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004453
Sasha Levin8dce7a92013-06-13 18:41:16 -04004454#ifdef __KERNEL__
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004455void debug_show_all_locks(void)
4456{
4457 struct task_struct *g, *p;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004458
Jarek Poplawski9c35dd72007-03-22 00:11:28 -08004459 if (unlikely(!debug_locks)) {
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004460 pr_warn("INFO: lockdep is turned off.\n");
Jarek Poplawski9c35dd72007-03-22 00:11:28 -08004461 return;
4462 }
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004463 pr_warn("\nShowing all locks held in the system:\n");
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004464
Tetsuo Handa0f736a52018-04-06 19:41:18 +09004465 rcu_read_lock();
4466 for_each_process_thread(g, p) {
Tetsuo Handa0f736a52018-04-06 19:41:18 +09004467 if (!p->lockdep_depth)
4468 continue;
4469 lockdep_print_held_locks(p);
Tejun Heo88f1c872018-01-22 14:00:55 -08004470 touch_nmi_watchdog();
Tetsuo Handa0f736a52018-04-06 19:41:18 +09004471 touch_all_softlockup_watchdogs();
4472 }
4473 rcu_read_unlock();
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004474
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004475 pr_warn("\n");
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08004476 pr_warn("=============================================\n\n");
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004477}
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004478EXPORT_SYMBOL_GPL(debug_show_all_locks);
Sasha Levin8dce7a92013-06-13 18:41:16 -04004479#endif
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004480
Ingo Molnar82a1fcb2008-01-25 21:08:02 +01004481/*
4482 * Careful: only use this function if you are sure that
4483 * the task cannot run in parallel!
4484 */
John Kacurf1b499f2010-08-05 17:10:53 +02004485void debug_show_held_locks(struct task_struct *task)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004486{
Jarek Poplawski9c35dd72007-03-22 00:11:28 -08004487 if (unlikely(!debug_locks)) {
4488 printk("INFO: lockdep is turned off.\n");
4489 return;
4490 }
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004491 lockdep_print_held_locks(task);
4492}
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004493EXPORT_SYMBOL_GPL(debug_show_held_locks);
Peter Zijlstrab351d162007-10-11 22:11:12 +02004494
Andi Kleen722a9f92014-05-02 00:44:38 +02004495asmlinkage __visible void lockdep_sys_exit(void)
Peter Zijlstrab351d162007-10-11 22:11:12 +02004496{
4497 struct task_struct *curr = current;
4498
4499 if (unlikely(curr->lockdep_depth)) {
4500 if (!debug_locks_off())
4501 return;
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004502 pr_warn("\n");
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08004503 pr_warn("================================================\n");
4504 pr_warn("WARNING: lock held when returning to user space!\n");
Ben Hutchingsfbdc4b92011-10-28 04:36:55 +01004505 print_kernel_ident();
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08004506 pr_warn("------------------------------------------------\n");
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004507 pr_warn("%s/%d is leaving the kernel with locks still held!\n",
Peter Zijlstrab351d162007-10-11 22:11:12 +02004508 curr->comm, curr->pid);
4509 lockdep_print_held_locks(curr);
4510 }
Byungchul Parkb09be672017-08-07 16:12:52 +09004511
4512 /*
4513 * The lock history for each syscall should be independent. So wipe the
4514 * slate clean on return to userspace.
4515 */
Peter Zijlstraf52be572017-08-29 10:59:39 +02004516 lockdep_invariant_state(false);
Peter Zijlstrab351d162007-10-11 22:11:12 +02004517}
Paul E. McKenney0632eb32010-02-22 17:04:47 -08004518
Paul E. McKenneyb3fbab02011-05-24 08:31:09 -07004519void lockdep_rcu_suspicious(const char *file, const int line, const char *s)
Paul E. McKenney0632eb32010-02-22 17:04:47 -08004520{
4521 struct task_struct *curr = current;
4522
Lai Jiangshan2b3fc352010-04-20 16:23:07 +08004523 /* Note: the following can be executed concurrently, so be careful. */
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004524 pr_warn("\n");
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08004525 pr_warn("=============================\n");
4526 pr_warn("WARNING: suspicious RCU usage\n");
Ben Hutchingsfbdc4b92011-10-28 04:36:55 +01004527 print_kernel_ident();
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08004528 pr_warn("-----------------------------\n");
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004529 pr_warn("%s:%d %s!\n", file, line, s);
4530 pr_warn("\nother info that might help us debug this:\n\n");
4531 pr_warn("\n%srcu_scheduler_active = %d, debug_locks = %d\n",
Paul E. McKenneyc5fdcec2012-01-30 08:46:32 -08004532 !rcu_lockdep_current_cpu_online()
4533 ? "RCU used illegally from offline CPU!\n"
Paul E. McKenney5c173eb2013-09-13 17:20:11 -07004534 : !rcu_is_watching()
Paul E. McKenneyc5fdcec2012-01-30 08:46:32 -08004535 ? "RCU used illegally from idle CPU!\n"
4536 : "",
4537 rcu_scheduler_active, debug_locks);
Frederic Weisbecker0464e932011-10-07 18:22:01 +02004538
4539 /*
4540 * If a CPU is in the RCU-free window in idle (ie: in the section
4541 * between rcu_idle_enter() and rcu_idle_exit(), then RCU
4542 * considers that CPU to be in an "extended quiescent state",
4543 * which means that RCU will be completely ignoring that CPU.
4544 * Therefore, rcu_read_lock() and friends have absolutely no
4545 * effect on a CPU running in that state. In other words, even if
4546 * such an RCU-idle CPU has called rcu_read_lock(), RCU might well
4547 * delete data structures out from under it. RCU really has no
4548 * choice here: we need to keep an RCU-free window in idle where
4549 * the CPU may possibly enter into low power mode. This way we can
4550 * notice an extended quiescent state to other CPUs that started a grace
4551 * period. Otherwise we would delay any grace period as long as we run
4552 * in the idle task.
4553 *
4554 * So complain bitterly if someone does call rcu_read_lock(),
4555 * rcu_read_lock_bh() and so on from extended quiescent states.
4556 */
Paul E. McKenney5c173eb2013-09-13 17:20:11 -07004557 if (!rcu_is_watching())
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004558 pr_warn("RCU used illegally from extended quiescent state!\n");
Frederic Weisbecker0464e932011-10-07 18:22:01 +02004559
Paul E. McKenney0632eb32010-02-22 17:04:47 -08004560 lockdep_print_held_locks(curr);
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004561 pr_warn("\nstack backtrace:\n");
Paul E. McKenney0632eb32010-02-22 17:04:47 -08004562 dump_stack();
4563}
Paul E. McKenneyb3fbab02011-05-24 08:31:09 -07004564EXPORT_SYMBOL_GPL(lockdep_rcu_suspicious);