blob: 023386338269c9d84d533aa891d8c644e2a63061 [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
564static void lockdep_print_held_locks(struct task_struct *curr)
565{
566 int i, depth = curr->lockdep_depth;
567
568 if (!depth) {
Pavel Emelyanovba25f9d2007-10-18 23:40:40 -0700569 printk("no locks held by %s/%d.\n", curr->comm, task_pid_nr(curr));
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700570 return;
571 }
572 printk("%d lock%s held by %s/%d:\n",
Pavel Emelyanovba25f9d2007-10-18 23:40:40 -0700573 depth, depth > 1 ? "s" : "", curr->comm, task_pid_nr(curr));
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700574
575 for (i = 0; i < depth; i++) {
576 printk(" #%d: ", i);
577 print_lock(curr->held_locks + i);
578 }
579}
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700580
Ben Hutchingsfbdc4b92011-10-28 04:36:55 +0100581static void print_kernel_ident(void)
Dave Jones99de0552006-09-29 02:00:10 -0700582{
Ben Hutchingsfbdc4b92011-10-28 04:36:55 +0100583 printk("%s %.*s %s\n", init_utsname()->release,
Serge E. Hallyn96b644b2006-10-02 02:18:13 -0700584 (int)strcspn(init_utsname()->version, " "),
Ben Hutchingsfbdc4b92011-10-28 04:36:55 +0100585 init_utsname()->version,
586 print_tainted());
Dave Jones99de0552006-09-29 02:00:10 -0700587}
588
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700589static int very_verbose(struct lock_class *class)
590{
591#if VERY_VERBOSE
592 return class_filter(class);
593#endif
594 return 0;
595}
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700596
597/*
598 * Is this the address of a static object:
599 */
Sasha Levin8dce7a92013-06-13 18:41:16 -0400600#ifdef __KERNEL__
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700601static int static_obj(void *obj)
602{
603 unsigned long start = (unsigned long) &_stext,
604 end = (unsigned long) &_end,
605 addr = (unsigned long) obj;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700606
607 /*
608 * static variable?
609 */
610 if ((addr >= start) && (addr < end))
611 return 1;
612
Mike Frysinger2a9ad182009-09-22 16:44:16 -0700613 if (arch_is_kernel_data(addr))
614 return 1;
615
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700616 /*
Tejun Heo10fad5e2010-03-10 18:57:54 +0900617 * in-kernel percpu var?
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700618 */
Tejun Heo10fad5e2010-03-10 18:57:54 +0900619 if (is_kernel_percpu_address(addr))
620 return 1;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700621
622 /*
Tejun Heo10fad5e2010-03-10 18:57:54 +0900623 * module static or percpu var?
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700624 */
Tejun Heo10fad5e2010-03-10 18:57:54 +0900625 return is_module_address(addr) || is_module_percpu_address(addr);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700626}
Sasha Levin8dce7a92013-06-13 18:41:16 -0400627#endif
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700628
629/*
630 * To make lock name printouts unique, we calculate a unique
631 * class->name_version generation counter:
632 */
633static int count_matching_names(struct lock_class *new_class)
634{
635 struct lock_class *class;
636 int count = 0;
637
638 if (!new_class->name)
639 return 0;
640
Peter Zijlstra35a93932015-02-26 16:23:11 +0100641 list_for_each_entry_rcu(class, &all_lock_classes, lock_entry) {
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700642 if (new_class->key - new_class->subclass == class->key)
643 return class->name_version;
644 if (class->name && !strcmp(class->name, new_class->name))
645 count = max(count, class->name_version);
646 }
647
648 return count + 1;
649}
650
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700651static inline struct lock_class *
Matthew Wilcox08f36ff2018-01-17 07:14:13 -0800652look_up_lock_class(const struct lockdep_map *lock, unsigned int subclass)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700653{
654 struct lockdep_subclass_key *key;
Andrew Mortona63f38c2016-02-03 13:44:12 -0800655 struct hlist_head *hash_head;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700656 struct lock_class *class;
657
Hitoshi Mitake4ba053c2010-10-13 17:30:26 +0900658 if (unlikely(subclass >= MAX_LOCKDEP_SUBCLASSES)) {
659 debug_locks_off();
660 printk(KERN_ERR
661 "BUG: looking up invalid subclass: %u\n", subclass);
662 printk(KERN_ERR
663 "turning off the locking correctness validator.\n");
664 dump_stack();
665 return NULL;
666 }
667
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700668 /*
Matthew Wilcox64f29d12018-01-17 07:14:12 -0800669 * If it is not initialised then it has never been locked,
670 * so it won't be present in the hash table.
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700671 */
Matthew Wilcox64f29d12018-01-17 07:14:12 -0800672 if (unlikely(!lock->key))
673 return NULL;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700674
675 /*
676 * NOTE: the class-key must be unique. For dynamic locks, a static
677 * lock_class_key variable is passed in through the mutex_init()
678 * (or spin_lock_init()) call - which acts as the key. For static
679 * locks we use the lock object itself as the key.
680 */
Peter Zijlstra4b32d0a2007-07-19 01:48:59 -0700681 BUILD_BUG_ON(sizeof(struct lock_class_key) >
682 sizeof(struct lockdep_map));
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700683
684 key = lock->key->subkeys + subclass;
685
686 hash_head = classhashentry(key);
687
688 /*
Peter Zijlstra35a93932015-02-26 16:23:11 +0100689 * We do an RCU walk of the hash, see lockdep_free_key_range().
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700690 */
Peter Zijlstra35a93932015-02-26 16:23:11 +0100691 if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
692 return NULL;
693
Andrew Mortona63f38c2016-02-03 13:44:12 -0800694 hlist_for_each_entry_rcu(class, hash_head, hash_entry) {
Peter Zijlstra4b32d0a2007-07-19 01:48:59 -0700695 if (class->key == key) {
Peter Zijlstra0119fee2011-09-02 01:30:29 +0200696 /*
697 * Huh! same key, different name? Did someone trample
698 * on some memory? We're most confused.
699 */
Peter Zijlstra4b32d0a2007-07-19 01:48:59 -0700700 WARN_ON_ONCE(class->name != lock->name);
Ingo Molnard6d897c2006-07-10 04:44:04 -0700701 return class;
Peter Zijlstra4b32d0a2007-07-19 01:48:59 -0700702 }
703 }
Ingo Molnard6d897c2006-07-10 04:44:04 -0700704
Matthew Wilcox64f29d12018-01-17 07:14:12 -0800705 return NULL;
706}
707
708/*
709 * Static locks do not have their class-keys yet - for them the key is
710 * the lock object itself. If the lock is in the per cpu area, the
711 * canonical address of the lock (per cpu offset removed) is used.
712 */
713static bool assign_lock_key(struct lockdep_map *lock)
714{
715 unsigned long can_addr, addr = (unsigned long)lock;
716
717 if (__is_kernel_percpu_address(addr, &can_addr))
718 lock->key = (void *)can_addr;
719 else if (__is_module_percpu_address(addr, &can_addr))
720 lock->key = (void *)can_addr;
721 else if (static_obj(lock))
722 lock->key = (void *)lock;
723 else {
724 /* Debug-check: all keys must be persistent! */
725 debug_locks_off();
726 pr_err("INFO: trying to register non-static key.\n");
727 pr_err("the code is fine but needs lockdep annotation.\n");
728 pr_err("turning off the locking correctness validator.\n");
729 dump_stack();
730 return false;
731 }
732
733 return true;
Ingo Molnard6d897c2006-07-10 04:44:04 -0700734}
735
736/*
737 * Register a lock's class in the hash-table, if the class is not present
738 * yet. Otherwise we look it up. We cache the result in the lock object
739 * itself, so actual lookup of the hash should be once per lock object.
740 */
Denys Vlasenkoc003ed92016-04-08 20:58:46 +0200741static struct lock_class *
Peter Zijlstra4dfbb9d2006-10-11 01:45:14 -0400742register_lock_class(struct lockdep_map *lock, unsigned int subclass, int force)
Ingo Molnard6d897c2006-07-10 04:44:04 -0700743{
744 struct lockdep_subclass_key *key;
Andrew Mortona63f38c2016-02-03 13:44:12 -0800745 struct hlist_head *hash_head;
Ingo Molnard6d897c2006-07-10 04:44:04 -0700746 struct lock_class *class;
Peter Zijlstra35a93932015-02-26 16:23:11 +0100747
748 DEBUG_LOCKS_WARN_ON(!irqs_disabled());
Ingo Molnard6d897c2006-07-10 04:44:04 -0700749
750 class = look_up_lock_class(lock, subclass);
Matthew Wilcox64f29d12018-01-17 07:14:12 -0800751 if (likely(class))
Yong Zhang87cdee72011-11-09 16:07:14 +0800752 goto out_set_class_cache;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700753
Matthew Wilcox64f29d12018-01-17 07:14:12 -0800754 if (!lock->key) {
755 if (!assign_lock_key(lock))
756 return NULL;
757 } else if (!static_obj(lock->key)) {
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700758 return NULL;
759 }
760
Ingo Molnard6d897c2006-07-10 04:44:04 -0700761 key = lock->key->subkeys + subclass;
762 hash_head = classhashentry(key);
763
Ingo Molnar74c383f2006-12-13 00:34:43 -0800764 if (!graph_lock()) {
Ingo Molnar74c383f2006-12-13 00:34:43 -0800765 return NULL;
766 }
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700767 /*
768 * We have to do the hash-walk again, to avoid races
769 * with another CPU:
770 */
Andrew Mortona63f38c2016-02-03 13:44:12 -0800771 hlist_for_each_entry_rcu(class, hash_head, hash_entry) {
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700772 if (class->key == key)
773 goto out_unlock_set;
Peter Zijlstra35a93932015-02-26 16:23:11 +0100774 }
775
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700776 /*
777 * Allocate a new key from the static array, and add it to
778 * the hash:
779 */
780 if (nr_lock_classes >= MAX_LOCKDEP_KEYS) {
Ingo Molnar74c383f2006-12-13 00:34:43 -0800781 if (!debug_locks_off_graph_unlock()) {
Ingo Molnar74c383f2006-12-13 00:34:43 -0800782 return NULL;
783 }
Ingo Molnar74c383f2006-12-13 00:34:43 -0800784
Dave Jones2c522832013-04-25 13:40:02 -0400785 print_lockdep_off("BUG: MAX_LOCKDEP_KEYS too low!");
Peter Zijlstraeedeeab2009-03-18 12:38:47 +0100786 dump_stack();
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700787 return NULL;
788 }
789 class = lock_classes + nr_lock_classes++;
Frederic Weisbeckerbd6d29c2010-04-06 00:10:17 +0200790 debug_atomic_inc(nr_unused_locks);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700791 class->key = key;
792 class->name = lock->name;
793 class->subclass = subclass;
794 INIT_LIST_HEAD(&class->lock_entry);
795 INIT_LIST_HEAD(&class->locks_before);
796 INIT_LIST_HEAD(&class->locks_after);
797 class->name_version = count_matching_names(class);
798 /*
799 * We use RCU's safe list-add method to make
800 * parallel walking of the hash-list safe:
801 */
Andrew Mortona63f38c2016-02-03 13:44:12 -0800802 hlist_add_head_rcu(&class->hash_entry, hash_head);
Dale Farnsworth14811972008-02-25 23:03:02 +0100803 /*
804 * Add it to the global list of classes:
805 */
806 list_add_tail_rcu(&class->lock_entry, &all_lock_classes);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700807
808 if (verbose(class)) {
Ingo Molnar74c383f2006-12-13 00:34:43 -0800809 graph_unlock();
Ingo Molnar74c383f2006-12-13 00:34:43 -0800810
Borislav Petkov04860d42018-02-26 14:49:26 +0100811 printk("\nnew class %px: %s", class->key, class->name);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700812 if (class->name_version > 1)
Dmitry Vyukovf943fe02016-11-28 15:24:43 +0100813 printk(KERN_CONT "#%d", class->name_version);
814 printk(KERN_CONT "\n");
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700815 dump_stack();
Ingo Molnar74c383f2006-12-13 00:34:43 -0800816
Ingo Molnar74c383f2006-12-13 00:34:43 -0800817 if (!graph_lock()) {
Ingo Molnar74c383f2006-12-13 00:34:43 -0800818 return NULL;
819 }
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700820 }
821out_unlock_set:
Ingo Molnar74c383f2006-12-13 00:34:43 -0800822 graph_unlock();
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700823
Yong Zhang87cdee72011-11-09 16:07:14 +0800824out_set_class_cache:
Peter Zijlstra4dfbb9d2006-10-11 01:45:14 -0400825 if (!subclass || force)
Hitoshi Mitake62016252010-10-05 18:01:51 +0900826 lock->class_cache[0] = class;
827 else if (subclass < NR_LOCKDEP_CACHING_CLASSES)
828 lock->class_cache[subclass] = class;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700829
Peter Zijlstra0119fee2011-09-02 01:30:29 +0200830 /*
831 * Hash collision, did we smoke some? We found a class with a matching
832 * hash but the subclass -- which is hashed in -- didn't match.
833 */
Jarek Poplawski381a2292007-02-10 01:44:58 -0800834 if (DEBUG_LOCKS_WARN_ON(class->subclass != subclass))
835 return NULL;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700836
837 return class;
838}
839
Peter Zijlstraca58abc2007-07-19 01:48:53 -0700840#ifdef CONFIG_PROVE_LOCKING
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700841/*
Peter Zijlstra8e182572007-07-19 01:48:54 -0700842 * Allocate a lockdep entry. (assumes the graph_lock held, returns
843 * with NULL on failure)
844 */
845static struct lock_list *alloc_list_entry(void)
846{
847 if (nr_list_entries >= MAX_LOCKDEP_ENTRIES) {
848 if (!debug_locks_off_graph_unlock())
849 return NULL;
850
Dave Jones2c522832013-04-25 13:40:02 -0400851 print_lockdep_off("BUG: MAX_LOCKDEP_ENTRIES too low!");
Peter Zijlstraeedeeab2009-03-18 12:38:47 +0100852 dump_stack();
Peter Zijlstra8e182572007-07-19 01:48:54 -0700853 return NULL;
854 }
855 return list_entries + nr_list_entries++;
856}
857
858/*
859 * Add a new dependency to the head of the list:
860 */
Tahsin Erdogan83f06162016-11-08 00:02:07 -0800861static int add_lock_to_list(struct lock_class *this, struct list_head *head,
862 unsigned long ip, int distance,
863 struct stack_trace *trace)
Peter Zijlstra8e182572007-07-19 01:48:54 -0700864{
865 struct lock_list *entry;
866 /*
867 * Lock not present yet - get a new dependency struct and
868 * add it to the list:
869 */
870 entry = alloc_list_entry();
871 if (!entry)
872 return 0;
873
Zhu Yi74870172008-08-27 14:33:00 +0800874 entry->class = this;
875 entry->distance = distance;
Yong Zhang4726f2a2010-05-04 14:16:48 +0800876 entry->trace = *trace;
Peter Zijlstra8e182572007-07-19 01:48:54 -0700877 /*
Peter Zijlstra35a93932015-02-26 16:23:11 +0100878 * Both allocation and removal are done under the graph lock; but
879 * iteration is under RCU-sched; see look_up_lock_class() and
880 * lockdep_free_key_range().
Peter Zijlstra8e182572007-07-19 01:48:54 -0700881 */
882 list_add_tail_rcu(&entry->entry, head);
883
884 return 1;
885}
886
Peter Zijlstra98c33ed2009-07-21 13:19:07 +0200887/*
888 * For good efficiency of modular, we use power of 2
889 */
Peter Zijlstraaf012962009-07-16 15:44:29 +0200890#define MAX_CIRCULAR_QUEUE_SIZE 4096UL
891#define CQ_MASK (MAX_CIRCULAR_QUEUE_SIZE-1)
892
Peter Zijlstra98c33ed2009-07-21 13:19:07 +0200893/*
894 * The circular_queue and helpers is used to implement the
Peter Zijlstraaf012962009-07-16 15:44:29 +0200895 * breadth-first search(BFS)algorithem, by which we can build
896 * the shortest path from the next lock to be acquired to the
897 * previous held lock if there is a circular between them.
Peter Zijlstra98c33ed2009-07-21 13:19:07 +0200898 */
Peter Zijlstraaf012962009-07-16 15:44:29 +0200899struct circular_queue {
900 unsigned long element[MAX_CIRCULAR_QUEUE_SIZE];
901 unsigned int front, rear;
902};
903
904static struct circular_queue lock_cq;
Peter Zijlstraaf012962009-07-16 15:44:29 +0200905
Ming Lei12f3dfd2009-07-16 15:44:29 +0200906unsigned int max_bfs_queue_depth;
Peter Zijlstraaf012962009-07-16 15:44:29 +0200907
Ming Leie351b662009-07-22 22:48:09 +0800908static unsigned int lockdep_dependency_gen_id;
909
Peter Zijlstraaf012962009-07-16 15:44:29 +0200910static inline void __cq_init(struct circular_queue *cq)
911{
912 cq->front = cq->rear = 0;
Ming Leie351b662009-07-22 22:48:09 +0800913 lockdep_dependency_gen_id++;
Peter Zijlstraaf012962009-07-16 15:44:29 +0200914}
915
916static inline int __cq_empty(struct circular_queue *cq)
917{
918 return (cq->front == cq->rear);
919}
920
921static inline int __cq_full(struct circular_queue *cq)
922{
923 return ((cq->rear + 1) & CQ_MASK) == cq->front;
924}
925
926static inline int __cq_enqueue(struct circular_queue *cq, unsigned long elem)
927{
928 if (__cq_full(cq))
929 return -1;
930
931 cq->element[cq->rear] = elem;
932 cq->rear = (cq->rear + 1) & CQ_MASK;
933 return 0;
934}
935
936static inline int __cq_dequeue(struct circular_queue *cq, unsigned long *elem)
937{
938 if (__cq_empty(cq))
939 return -1;
940
941 *elem = cq->element[cq->front];
942 cq->front = (cq->front + 1) & CQ_MASK;
943 return 0;
944}
945
946static inline unsigned int __cq_get_elem_count(struct circular_queue *cq)
947{
948 return (cq->rear - cq->front) & CQ_MASK;
949}
950
951static inline void mark_lock_accessed(struct lock_list *lock,
952 struct lock_list *parent)
953{
954 unsigned long nr;
Peter Zijlstra98c33ed2009-07-21 13:19:07 +0200955
Peter Zijlstraaf012962009-07-16 15:44:29 +0200956 nr = lock - list_entries;
Peter Zijlstra0119fee2011-09-02 01:30:29 +0200957 WARN_ON(nr >= nr_list_entries); /* Out-of-bounds, input fail */
Peter Zijlstraaf012962009-07-16 15:44:29 +0200958 lock->parent = parent;
Ming Leie351b662009-07-22 22:48:09 +0800959 lock->class->dep_gen_id = lockdep_dependency_gen_id;
Peter Zijlstraaf012962009-07-16 15:44:29 +0200960}
961
962static inline unsigned long lock_accessed(struct lock_list *lock)
963{
964 unsigned long nr;
Peter Zijlstra98c33ed2009-07-21 13:19:07 +0200965
Peter Zijlstraaf012962009-07-16 15:44:29 +0200966 nr = lock - list_entries;
Peter Zijlstra0119fee2011-09-02 01:30:29 +0200967 WARN_ON(nr >= nr_list_entries); /* Out-of-bounds, input fail */
Ming Leie351b662009-07-22 22:48:09 +0800968 return lock->class->dep_gen_id == lockdep_dependency_gen_id;
Peter Zijlstraaf012962009-07-16 15:44:29 +0200969}
970
971static inline struct lock_list *get_lock_parent(struct lock_list *child)
972{
973 return child->parent;
974}
975
976static inline int get_lock_depth(struct lock_list *child)
977{
978 int depth = 0;
979 struct lock_list *parent;
980
981 while ((parent = get_lock_parent(child))) {
982 child = parent;
983 depth++;
984 }
985 return depth;
986}
987
Ming Lei9e2d5512009-07-16 15:44:29 +0200988static int __bfs(struct lock_list *source_entry,
Peter Zijlstraaf012962009-07-16 15:44:29 +0200989 void *data,
990 int (*match)(struct lock_list *entry, void *data),
991 struct lock_list **target_entry,
992 int forward)
Ming Leic94aa5c2009-07-16 15:44:29 +0200993{
994 struct lock_list *entry;
Ming Leid588e462009-07-16 15:44:29 +0200995 struct list_head *head;
Ming Leic94aa5c2009-07-16 15:44:29 +0200996 struct circular_queue *cq = &lock_cq;
997 int ret = 1;
998
Ming Lei9e2d5512009-07-16 15:44:29 +0200999 if (match(source_entry, data)) {
Ming Leic94aa5c2009-07-16 15:44:29 +02001000 *target_entry = source_entry;
1001 ret = 0;
1002 goto exit;
1003 }
1004
Ming Leid588e462009-07-16 15:44:29 +02001005 if (forward)
1006 head = &source_entry->class->locks_after;
1007 else
1008 head = &source_entry->class->locks_before;
1009
1010 if (list_empty(head))
1011 goto exit;
1012
1013 __cq_init(cq);
Ming Leic94aa5c2009-07-16 15:44:29 +02001014 __cq_enqueue(cq, (unsigned long)source_entry);
1015
1016 while (!__cq_empty(cq)) {
1017 struct lock_list *lock;
Ming Leic94aa5c2009-07-16 15:44:29 +02001018
1019 __cq_dequeue(cq, (unsigned long *)&lock);
1020
1021 if (!lock->class) {
1022 ret = -2;
1023 goto exit;
1024 }
1025
1026 if (forward)
1027 head = &lock->class->locks_after;
1028 else
1029 head = &lock->class->locks_before;
1030
Peter Zijlstra35a93932015-02-26 16:23:11 +01001031 DEBUG_LOCKS_WARN_ON(!irqs_disabled());
1032
1033 list_for_each_entry_rcu(entry, head, entry) {
Ming Leic94aa5c2009-07-16 15:44:29 +02001034 if (!lock_accessed(entry)) {
Ming Lei12f3dfd2009-07-16 15:44:29 +02001035 unsigned int cq_depth;
Ming Leic94aa5c2009-07-16 15:44:29 +02001036 mark_lock_accessed(entry, lock);
Ming Lei9e2d5512009-07-16 15:44:29 +02001037 if (match(entry, data)) {
Ming Leic94aa5c2009-07-16 15:44:29 +02001038 *target_entry = entry;
1039 ret = 0;
1040 goto exit;
1041 }
1042
1043 if (__cq_enqueue(cq, (unsigned long)entry)) {
1044 ret = -1;
1045 goto exit;
1046 }
Ming Lei12f3dfd2009-07-16 15:44:29 +02001047 cq_depth = __cq_get_elem_count(cq);
1048 if (max_bfs_queue_depth < cq_depth)
1049 max_bfs_queue_depth = cq_depth;
Ming Leic94aa5c2009-07-16 15:44:29 +02001050 }
1051 }
1052 }
1053exit:
1054 return ret;
1055}
1056
Ming Leid7aaba12009-07-16 15:44:29 +02001057static inline int __bfs_forwards(struct lock_list *src_entry,
Ming Lei9e2d5512009-07-16 15:44:29 +02001058 void *data,
1059 int (*match)(struct lock_list *entry, void *data),
1060 struct lock_list **target_entry)
Ming Leic94aa5c2009-07-16 15:44:29 +02001061{
Ming Lei9e2d5512009-07-16 15:44:29 +02001062 return __bfs(src_entry, data, match, target_entry, 1);
Ming Leic94aa5c2009-07-16 15:44:29 +02001063
1064}
1065
Ming Leid7aaba12009-07-16 15:44:29 +02001066static inline int __bfs_backwards(struct lock_list *src_entry,
Ming Lei9e2d5512009-07-16 15:44:29 +02001067 void *data,
1068 int (*match)(struct lock_list *entry, void *data),
1069 struct lock_list **target_entry)
Ming Leic94aa5c2009-07-16 15:44:29 +02001070{
Ming Lei9e2d5512009-07-16 15:44:29 +02001071 return __bfs(src_entry, data, match, target_entry, 0);
Ming Leic94aa5c2009-07-16 15:44:29 +02001072
1073}
1074
Peter Zijlstra8e182572007-07-19 01:48:54 -07001075/*
1076 * Recursive, forwards-direction lock-dependency checking, used for
1077 * both noncyclic checking and for hardirq-unsafe/softirq-unsafe
1078 * checking.
Peter Zijlstra8e182572007-07-19 01:48:54 -07001079 */
Peter Zijlstra8e182572007-07-19 01:48:54 -07001080
1081/*
1082 * Print a dependency chain entry (this is only done when a deadlock
1083 * has been detected):
1084 */
1085static noinline int
Ming Lei24208ca2009-07-16 15:44:29 +02001086print_circular_bug_entry(struct lock_list *target, int depth)
Peter Zijlstra8e182572007-07-19 01:48:54 -07001087{
1088 if (debug_locks_silent)
1089 return 0;
1090 printk("\n-> #%u", depth);
1091 print_lock_name(target->class);
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01001092 printk(KERN_CONT ":\n");
Peter Zijlstra8e182572007-07-19 01:48:54 -07001093 print_stack_trace(&target->trace, 6);
1094
1095 return 0;
1096}
1097
Steven Rostedtf4185812011-04-20 21:41:55 -04001098static void
1099print_circular_lock_scenario(struct held_lock *src,
1100 struct held_lock *tgt,
1101 struct lock_list *prt)
1102{
1103 struct lock_class *source = hlock_class(src);
1104 struct lock_class *target = hlock_class(tgt);
1105 struct lock_class *parent = prt->class;
1106
1107 /*
1108 * A direct locking problem where unsafe_class lock is taken
1109 * directly by safe_class lock, then all we need to show
1110 * is the deadlock scenario, as it is obvious that the
1111 * unsafe lock is taken under the safe lock.
1112 *
1113 * But if there is a chain instead, where the safe lock takes
1114 * an intermediate lock (middle_class) where this lock is
1115 * not the same as the safe lock, then the lock chain is
1116 * used to describe the problem. Otherwise we would need
1117 * to show a different CPU case for each link in the chain
1118 * from the safe_class lock to the unsafe_class lock.
1119 */
1120 if (parent != source) {
1121 printk("Chain exists of:\n ");
1122 __print_lock_name(source);
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01001123 printk(KERN_CONT " --> ");
Steven Rostedtf4185812011-04-20 21:41:55 -04001124 __print_lock_name(parent);
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01001125 printk(KERN_CONT " --> ");
Steven Rostedtf4185812011-04-20 21:41:55 -04001126 __print_lock_name(target);
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01001127 printk(KERN_CONT "\n\n");
Steven Rostedtf4185812011-04-20 21:41:55 -04001128 }
1129
Ingo Molnare966eae2017-12-12 12:31:16 +01001130 printk(" Possible unsafe locking scenario:\n\n");
1131 printk(" CPU0 CPU1\n");
1132 printk(" ---- ----\n");
1133 printk(" lock(");
1134 __print_lock_name(target);
1135 printk(KERN_CONT ");\n");
1136 printk(" lock(");
1137 __print_lock_name(parent);
1138 printk(KERN_CONT ");\n");
1139 printk(" lock(");
1140 __print_lock_name(target);
1141 printk(KERN_CONT ");\n");
1142 printk(" lock(");
1143 __print_lock_name(source);
1144 printk(KERN_CONT ");\n");
1145 printk("\n *** DEADLOCK ***\n\n");
Steven Rostedtf4185812011-04-20 21:41:55 -04001146}
1147
Peter Zijlstra8e182572007-07-19 01:48:54 -07001148/*
1149 * When a circular dependency is detected, print the
1150 * header first:
1151 */
1152static noinline int
Ming Leidb0002a2009-07-16 15:44:29 +02001153print_circular_bug_header(struct lock_list *entry, unsigned int depth,
1154 struct held_lock *check_src,
1155 struct held_lock *check_tgt)
Peter Zijlstra8e182572007-07-19 01:48:54 -07001156{
1157 struct task_struct *curr = current;
1158
Ming Leic94aa5c2009-07-16 15:44:29 +02001159 if (debug_locks_silent)
Peter Zijlstra8e182572007-07-19 01:48:54 -07001160 return 0;
1161
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001162 pr_warn("\n");
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08001163 pr_warn("======================================================\n");
1164 pr_warn("WARNING: possible circular locking dependency detected\n");
Ben Hutchingsfbdc4b92011-10-28 04:36:55 +01001165 print_kernel_ident();
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08001166 pr_warn("------------------------------------------------------\n");
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001167 pr_warn("%s/%d is trying to acquire lock:\n",
Pavel Emelyanovba25f9d2007-10-18 23:40:40 -07001168 curr->comm, task_pid_nr(curr));
Ming Leidb0002a2009-07-16 15:44:29 +02001169 print_lock(check_src);
Byungchul Park383a4bc2017-08-07 16:12:55 +09001170
Ingo Molnare966eae2017-12-12 12:31:16 +01001171 pr_warn("\nbut task is already holding lock:\n");
Byungchul Park383a4bc2017-08-07 16:12:55 +09001172
Ming Leidb0002a2009-07-16 15:44:29 +02001173 print_lock(check_tgt);
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001174 pr_warn("\nwhich lock already depends on the new lock.\n\n");
1175 pr_warn("\nthe existing dependency chain (in reverse order) is:\n");
Peter Zijlstra8e182572007-07-19 01:48:54 -07001176
1177 print_circular_bug_entry(entry, depth);
1178
1179 return 0;
1180}
1181
Ming Lei9e2d5512009-07-16 15:44:29 +02001182static inline int class_equal(struct lock_list *entry, void *data)
1183{
1184 return entry->class == data;
1185}
1186
Ming Leidb0002a2009-07-16 15:44:29 +02001187static noinline int print_circular_bug(struct lock_list *this,
1188 struct lock_list *target,
1189 struct held_lock *check_src,
Byungchul Park383a4bc2017-08-07 16:12:55 +09001190 struct held_lock *check_tgt,
1191 struct stack_trace *trace)
Peter Zijlstra8e182572007-07-19 01:48:54 -07001192{
1193 struct task_struct *curr = current;
Ming Leic94aa5c2009-07-16 15:44:29 +02001194 struct lock_list *parent;
Steven Rostedtf4185812011-04-20 21:41:55 -04001195 struct lock_list *first_parent;
Ming Lei24208ca2009-07-16 15:44:29 +02001196 int depth;
Peter Zijlstra8e182572007-07-19 01:48:54 -07001197
Ming Leic94aa5c2009-07-16 15:44:29 +02001198 if (!debug_locks_off_graph_unlock() || debug_locks_silent)
Peter Zijlstra8e182572007-07-19 01:48:54 -07001199 return 0;
1200
Ingo Molnare966eae2017-12-12 12:31:16 +01001201 if (!save_trace(&this->trace))
Peter Zijlstra8e182572007-07-19 01:48:54 -07001202 return 0;
1203
Ming Leic94aa5c2009-07-16 15:44:29 +02001204 depth = get_lock_depth(target);
1205
Ming Leidb0002a2009-07-16 15:44:29 +02001206 print_circular_bug_header(target, depth, check_src, check_tgt);
Ming Leic94aa5c2009-07-16 15:44:29 +02001207
1208 parent = get_lock_parent(target);
Steven Rostedtf4185812011-04-20 21:41:55 -04001209 first_parent = parent;
Ming Leic94aa5c2009-07-16 15:44:29 +02001210
1211 while (parent) {
1212 print_circular_bug_entry(parent, --depth);
1213 parent = get_lock_parent(parent);
1214 }
Peter Zijlstra8e182572007-07-19 01:48:54 -07001215
1216 printk("\nother info that might help us debug this:\n\n");
Steven Rostedtf4185812011-04-20 21:41:55 -04001217 print_circular_lock_scenario(check_src, check_tgt,
1218 first_parent);
1219
Peter Zijlstra8e182572007-07-19 01:48:54 -07001220 lockdep_print_held_locks(curr);
1221
1222 printk("\nstack backtrace:\n");
1223 dump_stack();
1224
1225 return 0;
1226}
1227
Ming Leidb0002a2009-07-16 15:44:29 +02001228static noinline int print_bfs_bug(int ret)
1229{
1230 if (!debug_locks_off_graph_unlock())
1231 return 0;
1232
Peter Zijlstra0119fee2011-09-02 01:30:29 +02001233 /*
1234 * Breadth-first-search failed, graph got corrupted?
1235 */
Ming Leidb0002a2009-07-16 15:44:29 +02001236 WARN(1, "lockdep bfs error:%d\n", ret);
1237
1238 return 0;
1239}
1240
Ming Leief681022009-07-16 15:44:29 +02001241static int noop_count(struct lock_list *entry, void *data)
David Miller419ca3f2008-07-29 21:45:03 -07001242{
Ming Leief681022009-07-16 15:44:29 +02001243 (*(unsigned long *)data)++;
1244 return 0;
David Miller419ca3f2008-07-29 21:45:03 -07001245}
1246
Fengguang Wu5216d532013-11-09 00:55:35 +08001247static unsigned long __lockdep_count_forward_deps(struct lock_list *this)
Ming Leief681022009-07-16 15:44:29 +02001248{
1249 unsigned long count = 0;
1250 struct lock_list *uninitialized_var(target_entry);
1251
1252 __bfs_forwards(this, (void *)&count, noop_count, &target_entry);
1253
1254 return count;
1255}
David Miller419ca3f2008-07-29 21:45:03 -07001256unsigned long lockdep_count_forward_deps(struct lock_class *class)
1257{
1258 unsigned long ret, flags;
Ming Leief681022009-07-16 15:44:29 +02001259 struct lock_list this;
1260
1261 this.parent = NULL;
1262 this.class = class;
David Miller419ca3f2008-07-29 21:45:03 -07001263
1264 local_irq_save(flags);
Thomas Gleixner0199c4e2009-12-02 20:01:25 +01001265 arch_spin_lock(&lockdep_lock);
Ming Leief681022009-07-16 15:44:29 +02001266 ret = __lockdep_count_forward_deps(&this);
Thomas Gleixner0199c4e2009-12-02 20:01:25 +01001267 arch_spin_unlock(&lockdep_lock);
David Miller419ca3f2008-07-29 21:45:03 -07001268 local_irq_restore(flags);
1269
1270 return ret;
1271}
1272
Fengguang Wu5216d532013-11-09 00:55:35 +08001273static unsigned long __lockdep_count_backward_deps(struct lock_list *this)
David Miller419ca3f2008-07-29 21:45:03 -07001274{
Ming Leief681022009-07-16 15:44:29 +02001275 unsigned long count = 0;
1276 struct lock_list *uninitialized_var(target_entry);
David Miller419ca3f2008-07-29 21:45:03 -07001277
Ming Leief681022009-07-16 15:44:29 +02001278 __bfs_backwards(this, (void *)&count, noop_count, &target_entry);
David Miller419ca3f2008-07-29 21:45:03 -07001279
Ming Leief681022009-07-16 15:44:29 +02001280 return count;
David Miller419ca3f2008-07-29 21:45:03 -07001281}
1282
1283unsigned long lockdep_count_backward_deps(struct lock_class *class)
1284{
1285 unsigned long ret, flags;
Ming Leief681022009-07-16 15:44:29 +02001286 struct lock_list this;
1287
1288 this.parent = NULL;
1289 this.class = class;
David Miller419ca3f2008-07-29 21:45:03 -07001290
1291 local_irq_save(flags);
Thomas Gleixner0199c4e2009-12-02 20:01:25 +01001292 arch_spin_lock(&lockdep_lock);
Ming Leief681022009-07-16 15:44:29 +02001293 ret = __lockdep_count_backward_deps(&this);
Thomas Gleixner0199c4e2009-12-02 20:01:25 +01001294 arch_spin_unlock(&lockdep_lock);
David Miller419ca3f2008-07-29 21:45:03 -07001295 local_irq_restore(flags);
1296
1297 return ret;
1298}
1299
Peter Zijlstra8e182572007-07-19 01:48:54 -07001300/*
1301 * Prove that the dependency graph starting at <entry> can not
1302 * lead to <target>. Print an error and return 0 if it does.
1303 */
1304static noinline int
Ming Leidb0002a2009-07-16 15:44:29 +02001305check_noncircular(struct lock_list *root, struct lock_class *target,
1306 struct lock_list **target_entry)
Peter Zijlstra8e182572007-07-19 01:48:54 -07001307{
Ming Leidb0002a2009-07-16 15:44:29 +02001308 int result;
Peter Zijlstra8e182572007-07-19 01:48:54 -07001309
Frederic Weisbeckerbd6d29c2010-04-06 00:10:17 +02001310 debug_atomic_inc(nr_cyclic_checks);
David Miller419ca3f2008-07-29 21:45:03 -07001311
Ming Leid7aaba12009-07-16 15:44:29 +02001312 result = __bfs_forwards(root, target, class_equal, target_entry);
Ming Leidb0002a2009-07-16 15:44:29 +02001313
1314 return result;
Peter Zijlstra8e182572007-07-19 01:48:54 -07001315}
1316
Peter Zijlstraae813302017-03-03 10:13:38 +01001317static noinline int
1318check_redundant(struct lock_list *root, struct lock_class *target,
1319 struct lock_list **target_entry)
1320{
1321 int result;
1322
1323 debug_atomic_inc(nr_redundant_checks);
1324
1325 result = __bfs_forwards(root, target, class_equal, target_entry);
1326
1327 return result;
1328}
1329
Steven Rostedt81d68a92008-05-12 21:20:42 +02001330#if defined(CONFIG_TRACE_IRQFLAGS) && defined(CONFIG_PROVE_LOCKING)
Peter Zijlstra8e182572007-07-19 01:48:54 -07001331/*
1332 * Forwards and backwards subgraph searching, for the purposes of
1333 * proving that two subgraphs can be connected by a new dependency
1334 * without creating any illegal irq-safe -> irq-unsafe lock dependency.
1335 */
Peter Zijlstra8e182572007-07-19 01:48:54 -07001336
Ming Leid7aaba12009-07-16 15:44:29 +02001337static inline int usage_match(struct lock_list *entry, void *bit)
1338{
1339 return entry->class->usage_mask & (1 << (enum lock_usage_bit)bit);
1340}
1341
1342
1343
Peter Zijlstra8e182572007-07-19 01:48:54 -07001344/*
1345 * Find a node in the forwards-direction dependency sub-graph starting
Ming Leid7aaba12009-07-16 15:44:29 +02001346 * at @root->class that matches @bit.
Peter Zijlstra8e182572007-07-19 01:48:54 -07001347 *
Ming Leid7aaba12009-07-16 15:44:29 +02001348 * Return 0 if such a node exists in the subgraph, and put that node
1349 * into *@target_entry.
Peter Zijlstra8e182572007-07-19 01:48:54 -07001350 *
Ming Leid7aaba12009-07-16 15:44:29 +02001351 * Return 1 otherwise and keep *@target_entry unchanged.
1352 * Return <0 on error.
Peter Zijlstra8e182572007-07-19 01:48:54 -07001353 */
Ming Leid7aaba12009-07-16 15:44:29 +02001354static int
1355find_usage_forwards(struct lock_list *root, enum lock_usage_bit bit,
1356 struct lock_list **target_entry)
Peter Zijlstra8e182572007-07-19 01:48:54 -07001357{
Ming Leid7aaba12009-07-16 15:44:29 +02001358 int result;
Peter Zijlstra8e182572007-07-19 01:48:54 -07001359
Frederic Weisbeckerbd6d29c2010-04-06 00:10:17 +02001360 debug_atomic_inc(nr_find_usage_forwards_checks);
Peter Zijlstra8e182572007-07-19 01:48:54 -07001361
Ming Leid7aaba12009-07-16 15:44:29 +02001362 result = __bfs_forwards(root, (void *)bit, usage_match, target_entry);
1363
1364 return result;
Peter Zijlstra8e182572007-07-19 01:48:54 -07001365}
1366
1367/*
1368 * Find a node in the backwards-direction dependency sub-graph starting
Ming Leid7aaba12009-07-16 15:44:29 +02001369 * at @root->class that matches @bit.
Peter Zijlstra8e182572007-07-19 01:48:54 -07001370 *
Ming Leid7aaba12009-07-16 15:44:29 +02001371 * Return 0 if such a node exists in the subgraph, and put that node
1372 * into *@target_entry.
Peter Zijlstra8e182572007-07-19 01:48:54 -07001373 *
Ming Leid7aaba12009-07-16 15:44:29 +02001374 * Return 1 otherwise and keep *@target_entry unchanged.
1375 * Return <0 on error.
Peter Zijlstra8e182572007-07-19 01:48:54 -07001376 */
Ming Leid7aaba12009-07-16 15:44:29 +02001377static int
1378find_usage_backwards(struct lock_list *root, enum lock_usage_bit bit,
1379 struct lock_list **target_entry)
Peter Zijlstra8e182572007-07-19 01:48:54 -07001380{
Ming Leid7aaba12009-07-16 15:44:29 +02001381 int result;
Peter Zijlstra8e182572007-07-19 01:48:54 -07001382
Frederic Weisbeckerbd6d29c2010-04-06 00:10:17 +02001383 debug_atomic_inc(nr_find_usage_backwards_checks);
Peter Zijlstra8e182572007-07-19 01:48:54 -07001384
Ming Leid7aaba12009-07-16 15:44:29 +02001385 result = __bfs_backwards(root, (void *)bit, usage_match, target_entry);
Dave Jonesf82b2172008-08-11 09:30:23 +02001386
Ming Leid7aaba12009-07-16 15:44:29 +02001387 return result;
Peter Zijlstra8e182572007-07-19 01:48:54 -07001388}
1389
Peter Zijlstraaf012962009-07-16 15:44:29 +02001390static void print_lock_class_header(struct lock_class *class, int depth)
1391{
1392 int bit;
1393
1394 printk("%*s->", depth, "");
1395 print_lock_name(class);
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01001396 printk(KERN_CONT " ops: %lu", class->ops);
1397 printk(KERN_CONT " {\n");
Peter Zijlstraaf012962009-07-16 15:44:29 +02001398
1399 for (bit = 0; bit < LOCK_USAGE_STATES; bit++) {
1400 if (class->usage_mask & (1 << bit)) {
1401 int len = depth;
1402
1403 len += printk("%*s %s", depth, "", usage_str[bit]);
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01001404 len += printk(KERN_CONT " at:\n");
Peter Zijlstraaf012962009-07-16 15:44:29 +02001405 print_stack_trace(class->usage_traces + bit, len);
1406 }
1407 }
1408 printk("%*s }\n", depth, "");
1409
Borislav Petkov04860d42018-02-26 14:49:26 +01001410 printk("%*s ... key at: [<%px>] %pS\n",
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01001411 depth, "", class->key, class->key);
Peter Zijlstraaf012962009-07-16 15:44:29 +02001412}
1413
1414/*
1415 * printk the shortest lock dependencies from @start to @end in reverse order:
1416 */
1417static void __used
1418print_shortest_lock_dependencies(struct lock_list *leaf,
1419 struct lock_list *root)
1420{
1421 struct lock_list *entry = leaf;
1422 int depth;
1423
1424 /*compute depth from generated tree by BFS*/
1425 depth = get_lock_depth(leaf);
1426
1427 do {
1428 print_lock_class_header(entry->class, depth);
1429 printk("%*s ... acquired at:\n", depth, "");
1430 print_stack_trace(&entry->trace, 2);
1431 printk("\n");
1432
1433 if (depth == 0 && (entry != root)) {
Steven Rostedt6be8c392011-04-20 21:41:58 -04001434 printk("lockdep:%s bad path found in chain graph\n", __func__);
Peter Zijlstraaf012962009-07-16 15:44:29 +02001435 break;
1436 }
1437
1438 entry = get_lock_parent(entry);
1439 depth--;
1440 } while (entry && (depth >= 0));
1441
1442 return;
1443}
Ming Leid7aaba12009-07-16 15:44:29 +02001444
Steven Rostedt3003eba2011-04-20 21:41:54 -04001445static void
1446print_irq_lock_scenario(struct lock_list *safe_entry,
1447 struct lock_list *unsafe_entry,
Steven Rostedtdad3d742011-04-20 21:41:57 -04001448 struct lock_class *prev_class,
1449 struct lock_class *next_class)
Steven Rostedt3003eba2011-04-20 21:41:54 -04001450{
1451 struct lock_class *safe_class = safe_entry->class;
1452 struct lock_class *unsafe_class = unsafe_entry->class;
Steven Rostedtdad3d742011-04-20 21:41:57 -04001453 struct lock_class *middle_class = prev_class;
Steven Rostedt3003eba2011-04-20 21:41:54 -04001454
1455 if (middle_class == safe_class)
Steven Rostedtdad3d742011-04-20 21:41:57 -04001456 middle_class = next_class;
Steven Rostedt3003eba2011-04-20 21:41:54 -04001457
1458 /*
1459 * A direct locking problem where unsafe_class lock is taken
1460 * directly by safe_class lock, then all we need to show
1461 * is the deadlock scenario, as it is obvious that the
1462 * unsafe lock is taken under the safe lock.
1463 *
1464 * But if there is a chain instead, where the safe lock takes
1465 * an intermediate lock (middle_class) where this lock is
1466 * not the same as the safe lock, then the lock chain is
1467 * used to describe the problem. Otherwise we would need
1468 * to show a different CPU case for each link in the chain
1469 * from the safe_class lock to the unsafe_class lock.
1470 */
1471 if (middle_class != unsafe_class) {
1472 printk("Chain exists of:\n ");
1473 __print_lock_name(safe_class);
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01001474 printk(KERN_CONT " --> ");
Steven Rostedt3003eba2011-04-20 21:41:54 -04001475 __print_lock_name(middle_class);
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01001476 printk(KERN_CONT " --> ");
Steven Rostedt3003eba2011-04-20 21:41:54 -04001477 __print_lock_name(unsafe_class);
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01001478 printk(KERN_CONT "\n\n");
Steven Rostedt3003eba2011-04-20 21:41:54 -04001479 }
1480
1481 printk(" Possible interrupt unsafe locking scenario:\n\n");
1482 printk(" CPU0 CPU1\n");
1483 printk(" ---- ----\n");
1484 printk(" lock(");
1485 __print_lock_name(unsafe_class);
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01001486 printk(KERN_CONT ");\n");
Steven Rostedt3003eba2011-04-20 21:41:54 -04001487 printk(" local_irq_disable();\n");
1488 printk(" lock(");
1489 __print_lock_name(safe_class);
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01001490 printk(KERN_CONT ");\n");
Steven Rostedt3003eba2011-04-20 21:41:54 -04001491 printk(" lock(");
1492 __print_lock_name(middle_class);
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01001493 printk(KERN_CONT ");\n");
Steven Rostedt3003eba2011-04-20 21:41:54 -04001494 printk(" <Interrupt>\n");
1495 printk(" lock(");
1496 __print_lock_name(safe_class);
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01001497 printk(KERN_CONT ");\n");
Steven Rostedt3003eba2011-04-20 21:41:54 -04001498 printk("\n *** DEADLOCK ***\n\n");
1499}
1500
Peter Zijlstra8e182572007-07-19 01:48:54 -07001501static int
1502print_bad_irq_dependency(struct task_struct *curr,
Ming Lei24208ca2009-07-16 15:44:29 +02001503 struct lock_list *prev_root,
1504 struct lock_list *next_root,
1505 struct lock_list *backwards_entry,
1506 struct lock_list *forwards_entry,
Peter Zijlstra8e182572007-07-19 01:48:54 -07001507 struct held_lock *prev,
1508 struct held_lock *next,
1509 enum lock_usage_bit bit1,
1510 enum lock_usage_bit bit2,
1511 const char *irqclass)
1512{
1513 if (!debug_locks_off_graph_unlock() || debug_locks_silent)
1514 return 0;
1515
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001516 pr_warn("\n");
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08001517 pr_warn("=====================================================\n");
1518 pr_warn("WARNING: %s-safe -> %s-unsafe lock order detected\n",
Peter Zijlstra8e182572007-07-19 01:48:54 -07001519 irqclass, irqclass);
Ben Hutchingsfbdc4b92011-10-28 04:36:55 +01001520 print_kernel_ident();
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08001521 pr_warn("-----------------------------------------------------\n");
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001522 pr_warn("%s/%d [HC%u[%lu]:SC%u[%lu]:HE%u:SE%u] is trying to acquire:\n",
Pavel Emelyanovba25f9d2007-10-18 23:40:40 -07001523 curr->comm, task_pid_nr(curr),
Peter Zijlstra8e182572007-07-19 01:48:54 -07001524 curr->hardirq_context, hardirq_count() >> HARDIRQ_SHIFT,
1525 curr->softirq_context, softirq_count() >> SOFTIRQ_SHIFT,
1526 curr->hardirqs_enabled,
1527 curr->softirqs_enabled);
1528 print_lock(next);
1529
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001530 pr_warn("\nand this task is already holding:\n");
Peter Zijlstra8e182572007-07-19 01:48:54 -07001531 print_lock(prev);
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001532 pr_warn("which would create a new lock dependency:\n");
Dave Jonesf82b2172008-08-11 09:30:23 +02001533 print_lock_name(hlock_class(prev));
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001534 pr_cont(" ->");
Dave Jonesf82b2172008-08-11 09:30:23 +02001535 print_lock_name(hlock_class(next));
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001536 pr_cont("\n");
Peter Zijlstra8e182572007-07-19 01:48:54 -07001537
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001538 pr_warn("\nbut this new dependency connects a %s-irq-safe lock:\n",
Peter Zijlstra8e182572007-07-19 01:48:54 -07001539 irqclass);
Ming Lei24208ca2009-07-16 15:44:29 +02001540 print_lock_name(backwards_entry->class);
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001541 pr_warn("\n... which became %s-irq-safe at:\n", irqclass);
Peter Zijlstra8e182572007-07-19 01:48:54 -07001542
Ming Lei24208ca2009-07-16 15:44:29 +02001543 print_stack_trace(backwards_entry->class->usage_traces + bit1, 1);
Peter Zijlstra8e182572007-07-19 01:48:54 -07001544
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001545 pr_warn("\nto a %s-irq-unsafe lock:\n", irqclass);
Ming Lei24208ca2009-07-16 15:44:29 +02001546 print_lock_name(forwards_entry->class);
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001547 pr_warn("\n... which became %s-irq-unsafe at:\n", irqclass);
1548 pr_warn("...");
Peter Zijlstra8e182572007-07-19 01:48:54 -07001549
Ming Lei24208ca2009-07-16 15:44:29 +02001550 print_stack_trace(forwards_entry->class->usage_traces + bit2, 1);
Peter Zijlstra8e182572007-07-19 01:48:54 -07001551
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001552 pr_warn("\nother info that might help us debug this:\n\n");
Steven Rostedtdad3d742011-04-20 21:41:57 -04001553 print_irq_lock_scenario(backwards_entry, forwards_entry,
1554 hlock_class(prev), hlock_class(next));
Steven Rostedt3003eba2011-04-20 21:41:54 -04001555
Peter Zijlstra8e182572007-07-19 01:48:54 -07001556 lockdep_print_held_locks(curr);
1557
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001558 pr_warn("\nthe dependencies between %s-irq-safe lock and the holding lock:\n", irqclass);
Ming Lei24208ca2009-07-16 15:44:29 +02001559 if (!save_trace(&prev_root->trace))
1560 return 0;
1561 print_shortest_lock_dependencies(backwards_entry, prev_root);
Peter Zijlstra8e182572007-07-19 01:48:54 -07001562
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001563 pr_warn("\nthe dependencies between the lock to be acquired");
1564 pr_warn(" and %s-irq-unsafe lock:\n", irqclass);
Ming Lei24208ca2009-07-16 15:44:29 +02001565 if (!save_trace(&next_root->trace))
1566 return 0;
1567 print_shortest_lock_dependencies(forwards_entry, next_root);
Peter Zijlstra8e182572007-07-19 01:48:54 -07001568
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001569 pr_warn("\nstack backtrace:\n");
Peter Zijlstra8e182572007-07-19 01:48:54 -07001570 dump_stack();
1571
1572 return 0;
1573}
1574
1575static int
1576check_usage(struct task_struct *curr, struct held_lock *prev,
1577 struct held_lock *next, enum lock_usage_bit bit_backwards,
1578 enum lock_usage_bit bit_forwards, const char *irqclass)
1579{
1580 int ret;
Ming Lei24208ca2009-07-16 15:44:29 +02001581 struct lock_list this, that;
Ming Leid7aaba12009-07-16 15:44:29 +02001582 struct lock_list *uninitialized_var(target_entry);
Ming Lei24208ca2009-07-16 15:44:29 +02001583 struct lock_list *uninitialized_var(target_entry1);
Peter Zijlstra8e182572007-07-19 01:48:54 -07001584
Ming Leid7aaba12009-07-16 15:44:29 +02001585 this.parent = NULL;
Peter Zijlstra8e182572007-07-19 01:48:54 -07001586
Ming Leid7aaba12009-07-16 15:44:29 +02001587 this.class = hlock_class(prev);
1588 ret = find_usage_backwards(&this, bit_backwards, &target_entry);
Peter Zijlstraaf012962009-07-16 15:44:29 +02001589 if (ret < 0)
1590 return print_bfs_bug(ret);
1591 if (ret == 1)
1592 return ret;
Ming Leid7aaba12009-07-16 15:44:29 +02001593
Ming Lei24208ca2009-07-16 15:44:29 +02001594 that.parent = NULL;
1595 that.class = hlock_class(next);
1596 ret = find_usage_forwards(&that, bit_forwards, &target_entry1);
Peter Zijlstraaf012962009-07-16 15:44:29 +02001597 if (ret < 0)
1598 return print_bfs_bug(ret);
1599 if (ret == 1)
1600 return ret;
Ming Leid7aaba12009-07-16 15:44:29 +02001601
Ming Lei24208ca2009-07-16 15:44:29 +02001602 return print_bad_irq_dependency(curr, &this, &that,
1603 target_entry, target_entry1,
1604 prev, next,
Peter Zijlstra8e182572007-07-19 01:48:54 -07001605 bit_backwards, bit_forwards, irqclass);
1606}
1607
Peter Zijlstra4f367d8a2009-01-22 18:10:42 +01001608static const char *state_names[] = {
1609#define LOCKDEP_STATE(__STATE) \
Peter Zijlstrab4b136f2009-01-29 14:50:36 +01001610 __stringify(__STATE),
Peter Zijlstra4f367d8a2009-01-22 18:10:42 +01001611#include "lockdep_states.h"
1612#undef LOCKDEP_STATE
1613};
1614
1615static const char *state_rnames[] = {
1616#define LOCKDEP_STATE(__STATE) \
Peter Zijlstrab4b136f2009-01-29 14:50:36 +01001617 __stringify(__STATE)"-READ",
Peter Zijlstra4f367d8a2009-01-22 18:10:42 +01001618#include "lockdep_states.h"
1619#undef LOCKDEP_STATE
1620};
1621
1622static inline const char *state_name(enum lock_usage_bit bit)
1623{
1624 return (bit & 1) ? state_rnames[bit >> 2] : state_names[bit >> 2];
1625}
1626
1627static int exclusive_bit(int new_bit)
1628{
1629 /*
1630 * USED_IN
1631 * USED_IN_READ
1632 * ENABLED
1633 * ENABLED_READ
1634 *
1635 * bit 0 - write/read
1636 * bit 1 - used_in/enabled
1637 * bit 2+ state
1638 */
1639
1640 int state = new_bit & ~3;
1641 int dir = new_bit & 2;
1642
1643 /*
1644 * keep state, bit flip the direction and strip read.
1645 */
1646 return state | (dir ^ 2);
1647}
1648
1649static int check_irq_usage(struct task_struct *curr, struct held_lock *prev,
1650 struct held_lock *next, enum lock_usage_bit bit)
Peter Zijlstra8e182572007-07-19 01:48:54 -07001651{
1652 /*
1653 * Prove that the new dependency does not connect a hardirq-safe
1654 * lock with a hardirq-unsafe lock - to achieve this we search
1655 * the backwards-subgraph starting at <prev>, and the
1656 * forwards-subgraph starting at <next>:
1657 */
Peter Zijlstra4f367d8a2009-01-22 18:10:42 +01001658 if (!check_usage(curr, prev, next, bit,
1659 exclusive_bit(bit), state_name(bit)))
Peter Zijlstra8e182572007-07-19 01:48:54 -07001660 return 0;
1661
Peter Zijlstra4f367d8a2009-01-22 18:10:42 +01001662 bit++; /* _READ */
1663
Peter Zijlstra8e182572007-07-19 01:48:54 -07001664 /*
1665 * Prove that the new dependency does not connect a hardirq-safe-read
1666 * lock with a hardirq-unsafe lock - to achieve this we search
1667 * the backwards-subgraph starting at <prev>, and the
1668 * forwards-subgraph starting at <next>:
1669 */
Peter Zijlstra4f367d8a2009-01-22 18:10:42 +01001670 if (!check_usage(curr, prev, next, bit,
1671 exclusive_bit(bit), state_name(bit)))
Peter Zijlstra8e182572007-07-19 01:48:54 -07001672 return 0;
1673
Peter Zijlstra4f367d8a2009-01-22 18:10:42 +01001674 return 1;
1675}
Peter Zijlstra8e182572007-07-19 01:48:54 -07001676
Peter Zijlstra4f367d8a2009-01-22 18:10:42 +01001677static int
1678check_prev_add_irq(struct task_struct *curr, struct held_lock *prev,
1679 struct held_lock *next)
1680{
1681#define LOCKDEP_STATE(__STATE) \
1682 if (!check_irq_usage(curr, prev, next, LOCK_USED_IN_##__STATE)) \
Nick Piggincf40bd12009-01-21 08:12:39 +01001683 return 0;
Peter Zijlstra4f367d8a2009-01-22 18:10:42 +01001684#include "lockdep_states.h"
1685#undef LOCKDEP_STATE
Nick Piggincf40bd12009-01-21 08:12:39 +01001686
Peter Zijlstra8e182572007-07-19 01:48:54 -07001687 return 1;
1688}
1689
1690static void inc_chains(void)
1691{
1692 if (current->hardirq_context)
1693 nr_hardirq_chains++;
1694 else {
1695 if (current->softirq_context)
1696 nr_softirq_chains++;
1697 else
1698 nr_process_chains++;
1699 }
1700}
1701
1702#else
1703
1704static inline int
1705check_prev_add_irq(struct task_struct *curr, struct held_lock *prev,
1706 struct held_lock *next)
1707{
1708 return 1;
1709}
1710
1711static inline void inc_chains(void)
1712{
1713 nr_process_chains++;
1714}
1715
1716#endif
1717
Steven Rostedt48702ec2011-04-20 21:41:56 -04001718static void
1719print_deadlock_scenario(struct held_lock *nxt,
1720 struct held_lock *prv)
1721{
1722 struct lock_class *next = hlock_class(nxt);
1723 struct lock_class *prev = hlock_class(prv);
1724
1725 printk(" Possible unsafe locking scenario:\n\n");
1726 printk(" CPU0\n");
1727 printk(" ----\n");
1728 printk(" lock(");
1729 __print_lock_name(prev);
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01001730 printk(KERN_CONT ");\n");
Steven Rostedt48702ec2011-04-20 21:41:56 -04001731 printk(" lock(");
1732 __print_lock_name(next);
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01001733 printk(KERN_CONT ");\n");
Steven Rostedt48702ec2011-04-20 21:41:56 -04001734 printk("\n *** DEADLOCK ***\n\n");
1735 printk(" May be due to missing lock nesting notation\n\n");
1736}
1737
Peter Zijlstra8e182572007-07-19 01:48:54 -07001738static int
1739print_deadlock_bug(struct task_struct *curr, struct held_lock *prev,
1740 struct held_lock *next)
1741{
1742 if (!debug_locks_off_graph_unlock() || debug_locks_silent)
1743 return 0;
1744
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001745 pr_warn("\n");
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08001746 pr_warn("============================================\n");
1747 pr_warn("WARNING: possible recursive locking detected\n");
Ben Hutchingsfbdc4b92011-10-28 04:36:55 +01001748 print_kernel_ident();
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08001749 pr_warn("--------------------------------------------\n");
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001750 pr_warn("%s/%d is trying to acquire lock:\n",
Pavel Emelyanovba25f9d2007-10-18 23:40:40 -07001751 curr->comm, task_pid_nr(curr));
Peter Zijlstra8e182572007-07-19 01:48:54 -07001752 print_lock(next);
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001753 pr_warn("\nbut task is already holding lock:\n");
Peter Zijlstra8e182572007-07-19 01:48:54 -07001754 print_lock(prev);
1755
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001756 pr_warn("\nother info that might help us debug this:\n");
Steven Rostedt48702ec2011-04-20 21:41:56 -04001757 print_deadlock_scenario(next, prev);
Peter Zijlstra8e182572007-07-19 01:48:54 -07001758 lockdep_print_held_locks(curr);
1759
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001760 pr_warn("\nstack backtrace:\n");
Peter Zijlstra8e182572007-07-19 01:48:54 -07001761 dump_stack();
1762
1763 return 0;
1764}
1765
1766/*
1767 * Check whether we are holding such a class already.
1768 *
1769 * (Note that this has to be done separately, because the graph cannot
1770 * detect such classes of deadlocks.)
1771 *
1772 * Returns: 0 on deadlock detected, 1 on OK, 2 on recursive read
1773 */
1774static int
1775check_deadlock(struct task_struct *curr, struct held_lock *next,
1776 struct lockdep_map *next_instance, int read)
1777{
1778 struct held_lock *prev;
Peter Zijlstra7531e2f2008-08-11 09:30:24 +02001779 struct held_lock *nest = NULL;
Peter Zijlstra8e182572007-07-19 01:48:54 -07001780 int i;
1781
1782 for (i = 0; i < curr->lockdep_depth; i++) {
1783 prev = curr->held_locks + i;
Peter Zijlstra7531e2f2008-08-11 09:30:24 +02001784
1785 if (prev->instance == next->nest_lock)
1786 nest = prev;
1787
Dave Jonesf82b2172008-08-11 09:30:23 +02001788 if (hlock_class(prev) != hlock_class(next))
Peter Zijlstra8e182572007-07-19 01:48:54 -07001789 continue;
Peter Zijlstra7531e2f2008-08-11 09:30:24 +02001790
Peter Zijlstra8e182572007-07-19 01:48:54 -07001791 /*
1792 * Allow read-after-read recursion of the same
1793 * lock class (i.e. read_lock(lock)+read_lock(lock)):
1794 */
1795 if ((read == 2) && prev->read)
1796 return 2;
Peter Zijlstra7531e2f2008-08-11 09:30:24 +02001797
1798 /*
1799 * We're holding the nest_lock, which serializes this lock's
1800 * nesting behaviour.
1801 */
1802 if (nest)
1803 return 2;
1804
Peter Zijlstra8e182572007-07-19 01:48:54 -07001805 return print_deadlock_bug(curr, prev, next);
1806 }
1807 return 1;
1808}
1809
1810/*
1811 * There was a chain-cache miss, and we are about to add a new dependency
1812 * to a previous lock. We recursively validate the following rules:
1813 *
1814 * - would the adding of the <prev> -> <next> dependency create a
1815 * circular dependency in the graph? [== circular deadlock]
1816 *
1817 * - does the new prev->next dependency connect any hardirq-safe lock
1818 * (in the full backwards-subgraph starting at <prev>) with any
1819 * hardirq-unsafe lock (in the full forwards-subgraph starting at
1820 * <next>)? [== illegal lock inversion with hardirq contexts]
1821 *
1822 * - does the new prev->next dependency connect any softirq-safe lock
1823 * (in the full backwards-subgraph starting at <prev>) with any
1824 * softirq-unsafe lock (in the full forwards-subgraph starting at
1825 * <next>)? [== illegal lock inversion with softirq contexts]
1826 *
1827 * any of these scenarios could lead to a deadlock.
1828 *
1829 * Then if all the validations pass, we add the forwards and backwards
1830 * dependency.
1831 */
1832static int
1833check_prev_add(struct task_struct *curr, struct held_lock *prev,
Byungchul Parkce07a9412017-08-07 16:12:51 +09001834 struct held_lock *next, int distance, struct stack_trace *trace,
1835 int (*save)(struct stack_trace *trace))
Peter Zijlstra8e182572007-07-19 01:48:54 -07001836{
Ming Leidb0002a2009-07-16 15:44:29 +02001837 struct lock_list *uninitialized_var(target_entry);
Peter Zijlstra8b405d52017-10-04 11:13:37 +02001838 struct lock_list *entry;
1839 struct lock_list this;
1840 int ret;
Peter Zijlstra8e182572007-07-19 01:48:54 -07001841
1842 /*
1843 * Prove that the new <prev> -> <next> dependency would not
1844 * create a circular dependency in the graph. (We do this by
1845 * forward-recursing into the graph starting at <next>, and
1846 * checking whether we can reach <prev>.)
1847 *
1848 * We are using global variables to control the recursion, to
1849 * keep the stackframe size of the recursive functions low:
1850 */
Ming Leidb0002a2009-07-16 15:44:29 +02001851 this.class = hlock_class(next);
1852 this.parent = NULL;
1853 ret = check_noncircular(&this, hlock_class(prev), &target_entry);
Peter Zijlstra8b405d52017-10-04 11:13:37 +02001854 if (unlikely(!ret)) {
1855 if (!trace->entries) {
1856 /*
1857 * If @save fails here, the printing might trigger
1858 * a WARN but because of the !nr_entries it should
1859 * not do bad things.
1860 */
1861 save(trace);
1862 }
Byungchul Park383a4bc2017-08-07 16:12:55 +09001863 return print_circular_bug(&this, target_entry, next, prev, trace);
Peter Zijlstra8b405d52017-10-04 11:13:37 +02001864 }
Ming Leidb0002a2009-07-16 15:44:29 +02001865 else if (unlikely(ret < 0))
1866 return print_bfs_bug(ret);
Ming Leic94aa5c2009-07-16 15:44:29 +02001867
Peter Zijlstra8e182572007-07-19 01:48:54 -07001868 if (!check_prev_add_irq(curr, prev, next))
1869 return 0;
1870
1871 /*
1872 * For recursive read-locks we do all the dependency checks,
1873 * but we dont store read-triggered dependencies (only
1874 * write-triggered dependencies). This ensures that only the
1875 * write-side dependencies matter, and that if for example a
1876 * write-lock never takes any other locks, then the reads are
1877 * equivalent to a NOP.
1878 */
1879 if (next->read == 2 || prev->read == 2)
1880 return 1;
1881 /*
1882 * Is the <prev> -> <next> dependency already present?
1883 *
1884 * (this may occur even though this is a new chain: consider
1885 * e.g. the L1 -> L2 -> L3 -> L4 and the L5 -> L1 -> L2 -> L3
1886 * chains - the second one will be new, but L1 already has
1887 * L2 added to its dependency list, due to the first chain.)
1888 */
Dave Jonesf82b2172008-08-11 09:30:23 +02001889 list_for_each_entry(entry, &hlock_class(prev)->locks_after, entry) {
1890 if (entry->class == hlock_class(next)) {
Peter Zijlstra8e182572007-07-19 01:48:54 -07001891 if (distance == 1)
1892 entry->distance = 1;
Byungchul Park70911fd2017-08-07 16:12:50 +09001893 return 1;
Peter Zijlstra8e182572007-07-19 01:48:54 -07001894 }
1895 }
1896
Peter Zijlstraae813302017-03-03 10:13:38 +01001897 /*
1898 * Is the <prev> -> <next> link redundant?
1899 */
1900 this.class = hlock_class(prev);
1901 this.parent = NULL;
1902 ret = check_redundant(&this, hlock_class(next), &target_entry);
1903 if (!ret) {
1904 debug_atomic_inc(nr_redundant);
1905 return 2;
1906 }
1907 if (ret < 0)
1908 return print_bfs_bug(ret);
1909
1910
Peter Zijlstra8b405d52017-10-04 11:13:37 +02001911 if (!trace->entries && !save(trace))
Byungchul Parkce07a9412017-08-07 16:12:51 +09001912 return 0;
Yong Zhang4726f2a2010-05-04 14:16:48 +08001913
Peter Zijlstra8e182572007-07-19 01:48:54 -07001914 /*
1915 * Ok, all validations passed, add the new lock
1916 * to the previous lock's dependency list:
1917 */
Tahsin Erdogan83f06162016-11-08 00:02:07 -08001918 ret = add_lock_to_list(hlock_class(next),
Dave Jonesf82b2172008-08-11 09:30:23 +02001919 &hlock_class(prev)->locks_after,
Byungchul Parkce07a9412017-08-07 16:12:51 +09001920 next->acquire_ip, distance, trace);
Peter Zijlstra8e182572007-07-19 01:48:54 -07001921
1922 if (!ret)
1923 return 0;
1924
Tahsin Erdogan83f06162016-11-08 00:02:07 -08001925 ret = add_lock_to_list(hlock_class(prev),
Dave Jonesf82b2172008-08-11 09:30:23 +02001926 &hlock_class(next)->locks_before,
Byungchul Parkce07a9412017-08-07 16:12:51 +09001927 next->acquire_ip, distance, trace);
Peter Zijlstra8e182572007-07-19 01:48:54 -07001928 if (!ret)
1929 return 0;
1930
Byungchul Park70911fd2017-08-07 16:12:50 +09001931 return 2;
Peter Zijlstra8e182572007-07-19 01:48:54 -07001932}
1933
1934/*
1935 * Add the dependency to all directly-previous locks that are 'relevant'.
1936 * The ones that are relevant are (in increasing distance from curr):
1937 * all consecutive trylock entries and the final non-trylock entry - or
1938 * the end of this context's lock-chain - whichever comes first.
1939 */
1940static int
1941check_prevs_add(struct task_struct *curr, struct held_lock *next)
1942{
1943 int depth = curr->lockdep_depth;
1944 struct held_lock *hlock;
Peter Zijlstra8b405d52017-10-04 11:13:37 +02001945 struct stack_trace trace = {
1946 .nr_entries = 0,
1947 .max_entries = 0,
1948 .entries = NULL,
1949 .skip = 0,
1950 };
Peter Zijlstra8e182572007-07-19 01:48:54 -07001951
1952 /*
1953 * Debugging checks.
1954 *
1955 * Depth must not be zero for a non-head lock:
1956 */
1957 if (!depth)
1958 goto out_bug;
1959 /*
1960 * At least two relevant locks must exist for this
1961 * to be a head:
1962 */
1963 if (curr->held_locks[depth].irq_context !=
1964 curr->held_locks[depth-1].irq_context)
1965 goto out_bug;
1966
1967 for (;;) {
1968 int distance = curr->lockdep_depth - depth + 1;
Oleg Nesterov1b5ff812014-01-20 19:20:10 +01001969 hlock = curr->held_locks + depth - 1;
Byungchul Parkce07a9412017-08-07 16:12:51 +09001970
Ingo Molnare966eae2017-12-12 12:31:16 +01001971 /*
1972 * Only non-recursive-read entries get new dependencies
1973 * added:
1974 */
1975 if (hlock->read != 2 && hlock->check) {
1976 int ret = check_prev_add(curr, hlock, next, distance, &trace, save_trace);
1977 if (!ret)
1978 return 0;
1979
1980 /*
1981 * Stop after the first non-trylock entry,
1982 * as non-trylock entries have added their
1983 * own direct dependencies already, so this
1984 * lock is connected to them indirectly:
1985 */
1986 if (!hlock->trylock)
1987 break;
Peter Zijlstra8e182572007-07-19 01:48:54 -07001988 }
Ingo Molnare966eae2017-12-12 12:31:16 +01001989
Peter Zijlstra8e182572007-07-19 01:48:54 -07001990 depth--;
1991 /*
1992 * End of lock-stack?
1993 */
1994 if (!depth)
1995 break;
1996 /*
1997 * Stop the search if we cross into another context:
1998 */
1999 if (curr->held_locks[depth].irq_context !=
2000 curr->held_locks[depth-1].irq_context)
2001 break;
2002 }
2003 return 1;
2004out_bug:
2005 if (!debug_locks_off_graph_unlock())
2006 return 0;
2007
Peter Zijlstra0119fee2011-09-02 01:30:29 +02002008 /*
2009 * Clearly we all shouldn't be here, but since we made it we
2010 * can reliable say we messed up our state. See the above two
2011 * gotos for reasons why we could possibly end up here.
2012 */
Peter Zijlstra8e182572007-07-19 01:48:54 -07002013 WARN_ON(1);
2014
2015 return 0;
2016}
2017
2018unsigned long nr_lock_chains;
Huang, Ying443cd502008-06-20 16:39:21 +08002019struct lock_chain lock_chains[MAX_LOCKDEP_CHAINS];
Huang, Yingcd1a28e2008-06-23 11:20:54 +08002020int nr_chain_hlocks;
Huang, Ying443cd502008-06-20 16:39:21 +08002021static u16 chain_hlocks[MAX_LOCKDEP_CHAIN_HLOCKS];
2022
2023struct lock_class *lock_chain_get_class(struct lock_chain *chain, int i)
2024{
2025 return lock_classes + chain_hlocks[chain->base + i];
2026}
Peter Zijlstra8e182572007-07-19 01:48:54 -07002027
2028/*
Ingo Molnar9e4e7552016-02-29 10:03:58 +01002029 * Returns the index of the first held_lock of the current chain
2030 */
2031static inline int get_first_held_lock(struct task_struct *curr,
2032 struct held_lock *hlock)
2033{
2034 int i;
2035 struct held_lock *hlock_curr;
2036
2037 for (i = curr->lockdep_depth - 1; i >= 0; i--) {
2038 hlock_curr = curr->held_locks + i;
2039 if (hlock_curr->irq_context != hlock->irq_context)
2040 break;
2041
2042 }
2043
2044 return ++i;
2045}
2046
Borislav Petkov5c8a0102016-04-04 10:42:07 +02002047#ifdef CONFIG_DEBUG_LOCKDEP
Ingo Molnar9e4e7552016-02-29 10:03:58 +01002048/*
Alfredo Alvarez Fernandez39e2e172016-03-30 19:03:36 +02002049 * Returns the next chain_key iteration
2050 */
2051static u64 print_chain_key_iteration(int class_idx, u64 chain_key)
2052{
2053 u64 new_chain_key = iterate_chain_key(chain_key, class_idx);
2054
2055 printk(" class_idx:%d -> chain_key:%016Lx",
2056 class_idx,
2057 (unsigned long long)new_chain_key);
2058 return new_chain_key;
2059}
2060
2061static void
2062print_chain_keys_held_locks(struct task_struct *curr, struct held_lock *hlock_next)
2063{
2064 struct held_lock *hlock;
2065 u64 chain_key = 0;
2066 int depth = curr->lockdep_depth;
2067 int i;
2068
2069 printk("depth: %u\n", depth + 1);
2070 for (i = get_first_held_lock(curr, hlock_next); i < depth; i++) {
2071 hlock = curr->held_locks + i;
2072 chain_key = print_chain_key_iteration(hlock->class_idx, chain_key);
2073
2074 print_lock(hlock);
2075 }
2076
2077 print_chain_key_iteration(hlock_next->class_idx, chain_key);
2078 print_lock(hlock_next);
2079}
2080
2081static void print_chain_keys_chain(struct lock_chain *chain)
2082{
2083 int i;
2084 u64 chain_key = 0;
2085 int class_id;
2086
2087 printk("depth: %u\n", chain->depth);
2088 for (i = 0; i < chain->depth; i++) {
2089 class_id = chain_hlocks[chain->base + i];
2090 chain_key = print_chain_key_iteration(class_id + 1, chain_key);
2091
2092 print_lock_name(lock_classes + class_id);
2093 printk("\n");
2094 }
2095}
2096
2097static void print_collision(struct task_struct *curr,
2098 struct held_lock *hlock_next,
2099 struct lock_chain *chain)
2100{
Paul E. McKenney681fbec2017-05-04 15:44:38 -07002101 pr_warn("\n");
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08002102 pr_warn("============================\n");
2103 pr_warn("WARNING: chain_key collision\n");
Alfredo Alvarez Fernandez39e2e172016-03-30 19:03:36 +02002104 print_kernel_ident();
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08002105 pr_warn("----------------------------\n");
Paul E. McKenney681fbec2017-05-04 15:44:38 -07002106 pr_warn("%s/%d: ", current->comm, task_pid_nr(current));
2107 pr_warn("Hash chain already cached but the contents don't match!\n");
Alfredo Alvarez Fernandez39e2e172016-03-30 19:03:36 +02002108
Paul E. McKenney681fbec2017-05-04 15:44:38 -07002109 pr_warn("Held locks:");
Alfredo Alvarez Fernandez39e2e172016-03-30 19:03:36 +02002110 print_chain_keys_held_locks(curr, hlock_next);
2111
Paul E. McKenney681fbec2017-05-04 15:44:38 -07002112 pr_warn("Locks in cached chain:");
Alfredo Alvarez Fernandez39e2e172016-03-30 19:03:36 +02002113 print_chain_keys_chain(chain);
2114
Paul E. McKenney681fbec2017-05-04 15:44:38 -07002115 pr_warn("\nstack backtrace:\n");
Alfredo Alvarez Fernandez39e2e172016-03-30 19:03:36 +02002116 dump_stack();
2117}
Borislav Petkov5c8a0102016-04-04 10:42:07 +02002118#endif
Alfredo Alvarez Fernandez39e2e172016-03-30 19:03:36 +02002119
2120/*
Ingo Molnar9e4e7552016-02-29 10:03:58 +01002121 * Checks whether the chain and the current held locks are consistent
2122 * in depth and also in content. If they are not it most likely means
2123 * that there was a collision during the calculation of the chain_key.
2124 * Returns: 0 not passed, 1 passed
2125 */
2126static int check_no_collision(struct task_struct *curr,
2127 struct held_lock *hlock,
2128 struct lock_chain *chain)
2129{
2130#ifdef CONFIG_DEBUG_LOCKDEP
2131 int i, j, id;
2132
2133 i = get_first_held_lock(curr, hlock);
2134
Alfredo Alvarez Fernandez39e2e172016-03-30 19:03:36 +02002135 if (DEBUG_LOCKS_WARN_ON(chain->depth != curr->lockdep_depth - (i - 1))) {
2136 print_collision(curr, hlock, chain);
Ingo Molnar9e4e7552016-02-29 10:03:58 +01002137 return 0;
Alfredo Alvarez Fernandez39e2e172016-03-30 19:03:36 +02002138 }
Ingo Molnar9e4e7552016-02-29 10:03:58 +01002139
2140 for (j = 0; j < chain->depth - 1; j++, i++) {
2141 id = curr->held_locks[i].class_idx - 1;
2142
Alfredo Alvarez Fernandez39e2e172016-03-30 19:03:36 +02002143 if (DEBUG_LOCKS_WARN_ON(chain_hlocks[chain->base + j] != id)) {
2144 print_collision(curr, hlock, chain);
Ingo Molnar9e4e7552016-02-29 10:03:58 +01002145 return 0;
Alfredo Alvarez Fernandez39e2e172016-03-30 19:03:36 +02002146 }
Ingo Molnar9e4e7552016-02-29 10:03:58 +01002147 }
2148#endif
2149 return 1;
2150}
2151
2152/*
Byungchul Park49347a92017-08-07 16:12:49 +09002153 * This is for building a chain between just two different classes,
2154 * instead of adding a new hlock upon current, which is done by
2155 * add_chain_cache().
2156 *
2157 * This can be called in any context with two classes, while
2158 * add_chain_cache() must be done within the lock owener's context
2159 * since it uses hlock which might be racy in another context.
2160 */
2161static inline int add_chain_cache_classes(unsigned int prev,
2162 unsigned int next,
2163 unsigned int irq_context,
2164 u64 chain_key)
2165{
2166 struct hlist_head *hash_head = chainhashentry(chain_key);
2167 struct lock_chain *chain;
2168
2169 /*
2170 * Allocate a new chain entry from the static array, and add
2171 * it to the hash:
2172 */
2173
2174 /*
2175 * We might need to take the graph lock, ensure we've got IRQs
2176 * disabled to make this an IRQ-safe lock.. for recursion reasons
2177 * lockdep won't complain about its own locking errors.
2178 */
2179 if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
2180 return 0;
2181
2182 if (unlikely(nr_lock_chains >= MAX_LOCKDEP_CHAINS)) {
2183 if (!debug_locks_off_graph_unlock())
2184 return 0;
2185
2186 print_lockdep_off("BUG: MAX_LOCKDEP_CHAINS too low!");
2187 dump_stack();
2188 return 0;
2189 }
2190
2191 chain = lock_chains + nr_lock_chains++;
2192 chain->chain_key = chain_key;
2193 chain->irq_context = irq_context;
2194 chain->depth = 2;
2195 if (likely(nr_chain_hlocks + chain->depth <= MAX_LOCKDEP_CHAIN_HLOCKS)) {
2196 chain->base = nr_chain_hlocks;
2197 nr_chain_hlocks += chain->depth;
2198 chain_hlocks[chain->base] = prev - 1;
2199 chain_hlocks[chain->base + 1] = next -1;
2200 }
2201#ifdef CONFIG_DEBUG_LOCKDEP
2202 /*
2203 * Important for check_no_collision().
2204 */
2205 else {
2206 if (!debug_locks_off_graph_unlock())
2207 return 0;
2208
2209 print_lockdep_off("BUG: MAX_LOCKDEP_CHAIN_HLOCKS too low!");
2210 dump_stack();
2211 return 0;
2212 }
2213#endif
2214
2215 hlist_add_head_rcu(&chain->entry, hash_head);
2216 debug_atomic_inc(chain_lookup_misses);
2217 inc_chains();
2218
2219 return 1;
2220}
2221
2222/*
Byungchul Park545c23f2017-08-07 16:12:48 +09002223 * Adds a dependency chain into chain hashtable. And must be called with
2224 * graph_lock held.
2225 *
2226 * Return 0 if fail, and graph_lock is released.
2227 * Return 1 if succeed, with graph_lock held.
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002228 */
Byungchul Park545c23f2017-08-07 16:12:48 +09002229static inline int add_chain_cache(struct task_struct *curr,
2230 struct held_lock *hlock,
2231 u64 chain_key)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002232{
Dave Jonesf82b2172008-08-11 09:30:23 +02002233 struct lock_class *class = hlock_class(hlock);
Andrew Mortona63f38c2016-02-03 13:44:12 -08002234 struct hlist_head *hash_head = chainhashentry(chain_key);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002235 struct lock_chain *chain;
Steven Rostedte0944ee2011-04-20 21:42:00 -04002236 int i, j;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002237
Peter Zijlstra0119fee2011-09-02 01:30:29 +02002238 /*
Byungchul Park545c23f2017-08-07 16:12:48 +09002239 * Allocate a new chain entry from the static array, and add
2240 * it to the hash:
2241 */
2242
2243 /*
Peter Zijlstra0119fee2011-09-02 01:30:29 +02002244 * We might need to take the graph lock, ensure we've got IRQs
2245 * disabled to make this an IRQ-safe lock.. for recursion reasons
2246 * lockdep won't complain about its own locking errors.
2247 */
Jarek Poplawski381a2292007-02-10 01:44:58 -08002248 if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
2249 return 0;
Ingo Molnar9e4e7552016-02-29 10:03:58 +01002250
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002251 if (unlikely(nr_lock_chains >= MAX_LOCKDEP_CHAINS)) {
Ingo Molnar74c383f2006-12-13 00:34:43 -08002252 if (!debug_locks_off_graph_unlock())
2253 return 0;
2254
Dave Jones2c522832013-04-25 13:40:02 -04002255 print_lockdep_off("BUG: MAX_LOCKDEP_CHAINS too low!");
Peter Zijlstraeedeeab2009-03-18 12:38:47 +01002256 dump_stack();
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002257 return 0;
2258 }
2259 chain = lock_chains + nr_lock_chains++;
2260 chain->chain_key = chain_key;
Huang, Ying443cd502008-06-20 16:39:21 +08002261 chain->irq_context = hlock->irq_context;
Ingo Molnar9e4e7552016-02-29 10:03:58 +01002262 i = get_first_held_lock(curr, hlock);
Huang, Ying443cd502008-06-20 16:39:21 +08002263 chain->depth = curr->lockdep_depth + 1 - i;
Peter Zijlstra75dd6022016-03-30 11:36:59 +02002264
2265 BUILD_BUG_ON((1UL << 24) <= ARRAY_SIZE(chain_hlocks));
2266 BUILD_BUG_ON((1UL << 6) <= ARRAY_SIZE(curr->held_locks));
2267 BUILD_BUG_ON((1UL << 8*sizeof(chain_hlocks[0])) <= ARRAY_SIZE(lock_classes));
2268
Steven Rostedte0944ee2011-04-20 21:42:00 -04002269 if (likely(nr_chain_hlocks + chain->depth <= MAX_LOCKDEP_CHAIN_HLOCKS)) {
2270 chain->base = nr_chain_hlocks;
Huang, Ying443cd502008-06-20 16:39:21 +08002271 for (j = 0; j < chain->depth - 1; j++, i++) {
Dave Jonesf82b2172008-08-11 09:30:23 +02002272 int lock_id = curr->held_locks[i].class_idx - 1;
Huang, Ying443cd502008-06-20 16:39:21 +08002273 chain_hlocks[chain->base + j] = lock_id;
2274 }
2275 chain_hlocks[chain->base + j] = class - lock_classes;
2276 }
Peter Zijlstra75dd6022016-03-30 11:36:59 +02002277
2278 if (nr_chain_hlocks < MAX_LOCKDEP_CHAIN_HLOCKS)
2279 nr_chain_hlocks += chain->depth;
2280
2281#ifdef CONFIG_DEBUG_LOCKDEP
2282 /*
2283 * Important for check_no_collision().
2284 */
2285 if (unlikely(nr_chain_hlocks > MAX_LOCKDEP_CHAIN_HLOCKS)) {
Byungchul Parkf9af4562017-01-13 11:42:04 +09002286 if (!debug_locks_off_graph_unlock())
Peter Zijlstra75dd6022016-03-30 11:36:59 +02002287 return 0;
2288
2289 print_lockdep_off("BUG: MAX_LOCKDEP_CHAIN_HLOCKS too low!");
2290 dump_stack();
2291 return 0;
2292 }
2293#endif
2294
Andrew Mortona63f38c2016-02-03 13:44:12 -08002295 hlist_add_head_rcu(&chain->entry, hash_head);
Frederic Weisbeckerbd6d29c2010-04-06 00:10:17 +02002296 debug_atomic_inc(chain_lookup_misses);
Peter Zijlstra8e182572007-07-19 01:48:54 -07002297 inc_chains();
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002298
2299 return 1;
2300}
Peter Zijlstra8e182572007-07-19 01:48:54 -07002301
Byungchul Park545c23f2017-08-07 16:12:48 +09002302/*
2303 * Look up a dependency chain.
2304 */
2305static inline struct lock_chain *lookup_chain_cache(u64 chain_key)
2306{
2307 struct hlist_head *hash_head = chainhashentry(chain_key);
2308 struct lock_chain *chain;
2309
2310 /*
2311 * We can walk it lock-free, because entries only get added
2312 * to the hash:
2313 */
2314 hlist_for_each_entry_rcu(chain, hash_head, entry) {
2315 if (chain->chain_key == chain_key) {
2316 debug_atomic_inc(chain_lookup_hits);
2317 return chain;
2318 }
2319 }
2320 return NULL;
2321}
2322
2323/*
2324 * If the key is not present yet in dependency chain cache then
2325 * add it and return 1 - in this case the new dependency chain is
2326 * validated. If the key is already hashed, return 0.
2327 * (On return with 1 graph_lock is held.)
2328 */
2329static inline int lookup_chain_cache_add(struct task_struct *curr,
2330 struct held_lock *hlock,
2331 u64 chain_key)
2332{
2333 struct lock_class *class = hlock_class(hlock);
2334 struct lock_chain *chain = lookup_chain_cache(chain_key);
2335
2336 if (chain) {
2337cache_hit:
2338 if (!check_no_collision(curr, hlock, chain))
2339 return 0;
2340
2341 if (very_verbose(class)) {
2342 printk("\nhash chain already cached, key: "
Borislav Petkov04860d42018-02-26 14:49:26 +01002343 "%016Lx tail class: [%px] %s\n",
Byungchul Park545c23f2017-08-07 16:12:48 +09002344 (unsigned long long)chain_key,
2345 class->key, class->name);
2346 }
2347
2348 return 0;
2349 }
2350
2351 if (very_verbose(class)) {
Borislav Petkov04860d42018-02-26 14:49:26 +01002352 printk("\nnew hash chain, key: %016Lx tail class: [%px] %s\n",
Byungchul Park545c23f2017-08-07 16:12:48 +09002353 (unsigned long long)chain_key, class->key, class->name);
2354 }
2355
2356 if (!graph_lock())
2357 return 0;
2358
2359 /*
2360 * We have to walk the chain again locked - to avoid duplicates:
2361 */
2362 chain = lookup_chain_cache(chain_key);
2363 if (chain) {
2364 graph_unlock();
2365 goto cache_hit;
2366 }
2367
2368 if (!add_chain_cache(curr, hlock, chain_key))
2369 return 0;
2370
2371 return 1;
2372}
2373
Peter Zijlstra8e182572007-07-19 01:48:54 -07002374static int validate_chain(struct task_struct *curr, struct lockdep_map *lock,
Johannes Berg4e6045f2007-10-18 23:39:55 -07002375 struct held_lock *hlock, int chain_head, u64 chain_key)
Peter Zijlstra8e182572007-07-19 01:48:54 -07002376{
2377 /*
2378 * Trylock needs to maintain the stack of held locks, but it
2379 * does not add new dependencies, because trylock can be done
2380 * in any order.
2381 *
2382 * We look up the chain_key and do the O(N^2) check and update of
2383 * the dependencies only if this is a new dependency chain.
Byungchul Park545c23f2017-08-07 16:12:48 +09002384 * (If lookup_chain_cache_add() return with 1 it acquires
Peter Zijlstra8e182572007-07-19 01:48:54 -07002385 * graph_lock for us)
2386 */
Oleg Nesterovfb9edbe2014-01-20 19:20:06 +01002387 if (!hlock->trylock && hlock->check &&
Byungchul Park545c23f2017-08-07 16:12:48 +09002388 lookup_chain_cache_add(curr, hlock, chain_key)) {
Peter Zijlstra8e182572007-07-19 01:48:54 -07002389 /*
2390 * Check whether last held lock:
2391 *
2392 * - is irq-safe, if this lock is irq-unsafe
2393 * - is softirq-safe, if this lock is hardirq-unsafe
2394 *
2395 * And check whether the new lock's dependency graph
2396 * could lead back to the previous lock.
2397 *
2398 * any of these scenarios could lead to a deadlock. If
2399 * All validations
2400 */
2401 int ret = check_deadlock(curr, hlock, lock, hlock->read);
2402
2403 if (!ret)
2404 return 0;
2405 /*
2406 * Mark recursive read, as we jump over it when
2407 * building dependencies (just like we jump over
2408 * trylock entries):
2409 */
2410 if (ret == 2)
2411 hlock->read = 2;
2412 /*
2413 * Add dependency only if this lock is not the head
2414 * of the chain, and if it's not a secondary read-lock:
2415 */
Byungchul Park545c23f2017-08-07 16:12:48 +09002416 if (!chain_head && ret != 2) {
Peter Zijlstra8e182572007-07-19 01:48:54 -07002417 if (!check_prevs_add(curr, hlock))
2418 return 0;
Byungchul Park545c23f2017-08-07 16:12:48 +09002419 }
2420
Peter Zijlstra8e182572007-07-19 01:48:54 -07002421 graph_unlock();
Byungchul Park545c23f2017-08-07 16:12:48 +09002422 } else {
2423 /* after lookup_chain_cache_add(): */
Peter Zijlstra8e182572007-07-19 01:48:54 -07002424 if (unlikely(!debug_locks))
2425 return 0;
Byungchul Park545c23f2017-08-07 16:12:48 +09002426 }
Peter Zijlstra8e182572007-07-19 01:48:54 -07002427
2428 return 1;
2429}
2430#else
2431static inline int validate_chain(struct task_struct *curr,
2432 struct lockdep_map *lock, struct held_lock *hlock,
Gregory Haskins3aa416b2007-10-11 22:11:11 +02002433 int chain_head, u64 chain_key)
Peter Zijlstra8e182572007-07-19 01:48:54 -07002434{
2435 return 1;
2436}
Peter Zijlstraca58abc2007-07-19 01:48:53 -07002437#endif
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002438
2439/*
2440 * We are building curr_chain_key incrementally, so double-check
2441 * it from scratch, to make sure that it's done correctly:
2442 */
Steven Rostedt1d09daa2008-05-12 21:20:55 +02002443static void check_chain_key(struct task_struct *curr)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002444{
2445#ifdef CONFIG_DEBUG_LOCKDEP
2446 struct held_lock *hlock, *prev_hlock = NULL;
Alfredo Alvarez Fernandez5f18ab52016-02-11 00:33:32 +01002447 unsigned int i;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002448 u64 chain_key = 0;
2449
2450 for (i = 0; i < curr->lockdep_depth; i++) {
2451 hlock = curr->held_locks + i;
2452 if (chain_key != hlock->prev_chain_key) {
2453 debug_locks_off();
Peter Zijlstra0119fee2011-09-02 01:30:29 +02002454 /*
2455 * We got mighty confused, our chain keys don't match
2456 * with what we expect, someone trample on our task state?
2457 */
Arjan van de Ven2df8b1d2008-07-30 12:43:11 -07002458 WARN(1, "hm#1, depth: %u [%u], %016Lx != %016Lx\n",
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002459 curr->lockdep_depth, i,
2460 (unsigned long long)chain_key,
2461 (unsigned long long)hlock->prev_chain_key);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002462 return;
2463 }
Peter Zijlstra0119fee2011-09-02 01:30:29 +02002464 /*
2465 * Whoops ran out of static storage again?
2466 */
Alfredo Alvarez Fernandez5f18ab52016-02-11 00:33:32 +01002467 if (DEBUG_LOCKS_WARN_ON(hlock->class_idx > MAX_LOCKDEP_KEYS))
Jarek Poplawski381a2292007-02-10 01:44:58 -08002468 return;
2469
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002470 if (prev_hlock && (prev_hlock->irq_context !=
2471 hlock->irq_context))
2472 chain_key = 0;
Alfredo Alvarez Fernandez5f18ab52016-02-11 00:33:32 +01002473 chain_key = iterate_chain_key(chain_key, hlock->class_idx);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002474 prev_hlock = hlock;
2475 }
2476 if (chain_key != curr->curr_chain_key) {
2477 debug_locks_off();
Peter Zijlstra0119fee2011-09-02 01:30:29 +02002478 /*
2479 * More smoking hash instead of calculating it, damn see these
2480 * numbers float.. I bet that a pink elephant stepped on my memory.
2481 */
Arjan van de Ven2df8b1d2008-07-30 12:43:11 -07002482 WARN(1, "hm#2, depth: %u [%u], %016Lx != %016Lx\n",
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002483 curr->lockdep_depth, i,
2484 (unsigned long long)chain_key,
2485 (unsigned long long)curr->curr_chain_key);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002486 }
2487#endif
2488}
2489
Steven Rostedt282b5c22011-04-20 21:41:59 -04002490static void
2491print_usage_bug_scenario(struct held_lock *lock)
2492{
2493 struct lock_class *class = hlock_class(lock);
2494
2495 printk(" Possible unsafe locking scenario:\n\n");
2496 printk(" CPU0\n");
2497 printk(" ----\n");
2498 printk(" lock(");
2499 __print_lock_name(class);
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01002500 printk(KERN_CONT ");\n");
Steven Rostedt282b5c22011-04-20 21:41:59 -04002501 printk(" <Interrupt>\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("\n *** DEADLOCK ***\n\n");
2506}
2507
Peter Zijlstra8e182572007-07-19 01:48:54 -07002508static int
2509print_usage_bug(struct task_struct *curr, struct held_lock *this,
2510 enum lock_usage_bit prev_bit, enum lock_usage_bit new_bit)
2511{
2512 if (!debug_locks_off_graph_unlock() || debug_locks_silent)
2513 return 0;
2514
Paul E. McKenney681fbec2017-05-04 15:44:38 -07002515 pr_warn("\n");
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08002516 pr_warn("================================\n");
2517 pr_warn("WARNING: inconsistent lock state\n");
Ben Hutchingsfbdc4b92011-10-28 04:36:55 +01002518 print_kernel_ident();
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08002519 pr_warn("--------------------------------\n");
Peter Zijlstra8e182572007-07-19 01:48:54 -07002520
Paul E. McKenney681fbec2017-05-04 15:44:38 -07002521 pr_warn("inconsistent {%s} -> {%s} usage.\n",
Peter Zijlstra8e182572007-07-19 01:48:54 -07002522 usage_str[prev_bit], usage_str[new_bit]);
2523
Paul E. McKenney681fbec2017-05-04 15:44:38 -07002524 pr_warn("%s/%d [HC%u[%lu]:SC%u[%lu]:HE%u:SE%u] takes:\n",
Pavel Emelyanovba25f9d2007-10-18 23:40:40 -07002525 curr->comm, task_pid_nr(curr),
Peter Zijlstra8e182572007-07-19 01:48:54 -07002526 trace_hardirq_context(curr), hardirq_count() >> HARDIRQ_SHIFT,
2527 trace_softirq_context(curr), softirq_count() >> SOFTIRQ_SHIFT,
2528 trace_hardirqs_enabled(curr),
2529 trace_softirqs_enabled(curr));
2530 print_lock(this);
2531
Paul E. McKenney681fbec2017-05-04 15:44:38 -07002532 pr_warn("{%s} state was registered at:\n", usage_str[prev_bit]);
Dave Jonesf82b2172008-08-11 09:30:23 +02002533 print_stack_trace(hlock_class(this)->usage_traces + prev_bit, 1);
Peter Zijlstra8e182572007-07-19 01:48:54 -07002534
2535 print_irqtrace_events(curr);
Paul E. McKenney681fbec2017-05-04 15:44:38 -07002536 pr_warn("\nother info that might help us debug this:\n");
Steven Rostedt282b5c22011-04-20 21:41:59 -04002537 print_usage_bug_scenario(this);
2538
Peter Zijlstra8e182572007-07-19 01:48:54 -07002539 lockdep_print_held_locks(curr);
2540
Paul E. McKenney681fbec2017-05-04 15:44:38 -07002541 pr_warn("\nstack backtrace:\n");
Peter Zijlstra8e182572007-07-19 01:48:54 -07002542 dump_stack();
2543
2544 return 0;
2545}
2546
2547/*
2548 * Print out an error if an invalid bit is set:
2549 */
2550static inline int
2551valid_state(struct task_struct *curr, struct held_lock *this,
2552 enum lock_usage_bit new_bit, enum lock_usage_bit bad_bit)
2553{
Dave Jonesf82b2172008-08-11 09:30:23 +02002554 if (unlikely(hlock_class(this)->usage_mask & (1 << bad_bit)))
Peter Zijlstra8e182572007-07-19 01:48:54 -07002555 return print_usage_bug(curr, this, bad_bit, new_bit);
2556 return 1;
2557}
2558
2559static int mark_lock(struct task_struct *curr, struct held_lock *this,
2560 enum lock_usage_bit new_bit);
2561
Steven Rostedt81d68a92008-05-12 21:20:42 +02002562#if defined(CONFIG_TRACE_IRQFLAGS) && defined(CONFIG_PROVE_LOCKING)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002563
2564/*
2565 * print irq inversion bug:
2566 */
2567static int
Ming Lei24208ca2009-07-16 15:44:29 +02002568print_irq_inversion_bug(struct task_struct *curr,
2569 struct lock_list *root, struct lock_list *other,
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002570 struct held_lock *this, int forwards,
2571 const char *irqclass)
2572{
Steven Rostedtdad3d742011-04-20 21:41:57 -04002573 struct lock_list *entry = other;
2574 struct lock_list *middle = NULL;
2575 int depth;
2576
Ingo Molnar74c383f2006-12-13 00:34:43 -08002577 if (!debug_locks_off_graph_unlock() || debug_locks_silent)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002578 return 0;
2579
Paul E. McKenney681fbec2017-05-04 15:44:38 -07002580 pr_warn("\n");
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08002581 pr_warn("========================================================\n");
2582 pr_warn("WARNING: possible irq lock inversion dependency detected\n");
Ben Hutchingsfbdc4b92011-10-28 04:36:55 +01002583 print_kernel_ident();
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08002584 pr_warn("--------------------------------------------------------\n");
Paul E. McKenney681fbec2017-05-04 15:44:38 -07002585 pr_warn("%s/%d just changed the state of lock:\n",
Pavel Emelyanovba25f9d2007-10-18 23:40:40 -07002586 curr->comm, task_pid_nr(curr));
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002587 print_lock(this);
2588 if (forwards)
Paul E. McKenney681fbec2017-05-04 15:44:38 -07002589 pr_warn("but this lock took another, %s-unsafe lock in the past:\n", irqclass);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002590 else
Paul E. McKenney681fbec2017-05-04 15:44:38 -07002591 pr_warn("but this lock was taken by another, %s-safe lock in the past:\n", irqclass);
Ming Lei24208ca2009-07-16 15:44:29 +02002592 print_lock_name(other->class);
Paul E. McKenney681fbec2017-05-04 15:44:38 -07002593 pr_warn("\n\nand interrupts could create inverse lock ordering between them.\n\n");
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002594
Paul E. McKenney681fbec2017-05-04 15:44:38 -07002595 pr_warn("\nother info that might help us debug this:\n");
Steven Rostedtdad3d742011-04-20 21:41:57 -04002596
2597 /* Find a middle lock (if one exists) */
2598 depth = get_lock_depth(other);
2599 do {
2600 if (depth == 0 && (entry != root)) {
Paul E. McKenney681fbec2017-05-04 15:44:38 -07002601 pr_warn("lockdep:%s bad path found in chain graph\n", __func__);
Steven Rostedtdad3d742011-04-20 21:41:57 -04002602 break;
2603 }
2604 middle = entry;
2605 entry = get_lock_parent(entry);
2606 depth--;
2607 } while (entry && entry != root && (depth >= 0));
2608 if (forwards)
2609 print_irq_lock_scenario(root, other,
2610 middle ? middle->class : root->class, other->class);
2611 else
2612 print_irq_lock_scenario(other, root,
2613 middle ? middle->class : other->class, root->class);
2614
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002615 lockdep_print_held_locks(curr);
2616
Paul E. McKenney681fbec2017-05-04 15:44:38 -07002617 pr_warn("\nthe shortest dependencies between 2nd lock and 1st lock:\n");
Ming Lei24208ca2009-07-16 15:44:29 +02002618 if (!save_trace(&root->trace))
2619 return 0;
2620 print_shortest_lock_dependencies(other, root);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002621
Paul E. McKenney681fbec2017-05-04 15:44:38 -07002622 pr_warn("\nstack backtrace:\n");
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002623 dump_stack();
2624
2625 return 0;
2626}
2627
2628/*
2629 * Prove that in the forwards-direction subgraph starting at <this>
2630 * there is no lock matching <mask>:
2631 */
2632static int
2633check_usage_forwards(struct task_struct *curr, struct held_lock *this,
2634 enum lock_usage_bit bit, const char *irqclass)
2635{
2636 int ret;
Ming Leid7aaba12009-07-16 15:44:29 +02002637 struct lock_list root;
2638 struct lock_list *uninitialized_var(target_entry);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002639
Ming Leid7aaba12009-07-16 15:44:29 +02002640 root.parent = NULL;
2641 root.class = hlock_class(this);
2642 ret = find_usage_forwards(&root, bit, &target_entry);
Peter Zijlstraaf012962009-07-16 15:44:29 +02002643 if (ret < 0)
2644 return print_bfs_bug(ret);
2645 if (ret == 1)
2646 return ret;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002647
Ming Lei24208ca2009-07-16 15:44:29 +02002648 return print_irq_inversion_bug(curr, &root, target_entry,
Ming Leid7aaba12009-07-16 15:44:29 +02002649 this, 1, irqclass);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002650}
2651
2652/*
2653 * Prove that in the backwards-direction subgraph starting at <this>
2654 * there is no lock matching <mask>:
2655 */
2656static int
2657check_usage_backwards(struct task_struct *curr, struct held_lock *this,
2658 enum lock_usage_bit bit, const char *irqclass)
2659{
2660 int ret;
Ming Leid7aaba12009-07-16 15:44:29 +02002661 struct lock_list root;
2662 struct lock_list *uninitialized_var(target_entry);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002663
Ming Leid7aaba12009-07-16 15:44:29 +02002664 root.parent = NULL;
2665 root.class = hlock_class(this);
2666 ret = find_usage_backwards(&root, bit, &target_entry);
Peter Zijlstraaf012962009-07-16 15:44:29 +02002667 if (ret < 0)
2668 return print_bfs_bug(ret);
2669 if (ret == 1)
2670 return ret;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002671
Ming Lei24208ca2009-07-16 15:44:29 +02002672 return print_irq_inversion_bug(curr, &root, target_entry,
Oleg Nesterov48d50672010-01-26 19:16:41 +01002673 this, 0, irqclass);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002674}
2675
Ingo Molnar3117df02006-12-13 00:34:43 -08002676void print_irqtrace_events(struct task_struct *curr)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002677{
2678 printk("irq event stamp: %u\n", curr->irq_events);
Borislav Petkov04860d42018-02-26 14:49:26 +01002679 printk("hardirqs last enabled at (%u): [<%px>] %pS\n",
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01002680 curr->hardirq_enable_event, (void *)curr->hardirq_enable_ip,
2681 (void *)curr->hardirq_enable_ip);
Borislav Petkov04860d42018-02-26 14:49:26 +01002682 printk("hardirqs last disabled at (%u): [<%px>] %pS\n",
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01002683 curr->hardirq_disable_event, (void *)curr->hardirq_disable_ip,
2684 (void *)curr->hardirq_disable_ip);
Borislav Petkov04860d42018-02-26 14:49:26 +01002685 printk("softirqs last enabled at (%u): [<%px>] %pS\n",
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01002686 curr->softirq_enable_event, (void *)curr->softirq_enable_ip,
2687 (void *)curr->softirq_enable_ip);
Borislav Petkov04860d42018-02-26 14:49:26 +01002688 printk("softirqs last disabled at (%u): [<%px>] %pS\n",
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01002689 curr->softirq_disable_event, (void *)curr->softirq_disable_ip,
2690 (void *)curr->softirq_disable_ip);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002691}
2692
Peter Zijlstracd953022009-01-22 16:38:21 +01002693static int HARDIRQ_verbose(struct lock_class *class)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002694{
Peter Zijlstra8e182572007-07-19 01:48:54 -07002695#if HARDIRQ_VERBOSE
2696 return class_filter(class);
2697#endif
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002698 return 0;
2699}
2700
Peter Zijlstracd953022009-01-22 16:38:21 +01002701static int SOFTIRQ_verbose(struct lock_class *class)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002702{
Peter Zijlstra8e182572007-07-19 01:48:54 -07002703#if SOFTIRQ_VERBOSE
2704 return class_filter(class);
2705#endif
2706 return 0;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002707}
2708
2709#define STRICT_READ_CHECKS 1
2710
Peter Zijlstracd953022009-01-22 16:38:21 +01002711static int (*state_verbose_f[])(struct lock_class *class) = {
2712#define LOCKDEP_STATE(__STATE) \
2713 __STATE##_verbose,
2714#include "lockdep_states.h"
2715#undef LOCKDEP_STATE
2716};
2717
2718static inline int state_verbose(enum lock_usage_bit bit,
2719 struct lock_class *class)
2720{
2721 return state_verbose_f[bit >> 2](class);
2722}
2723
Peter Zijlstra42c50d52009-01-22 16:58:16 +01002724typedef int (*check_usage_f)(struct task_struct *, struct held_lock *,
2725 enum lock_usage_bit bit, const char *name);
2726
Peter Zijlstra6a6904d2009-01-22 16:07:44 +01002727static int
Peter Zijlstra1c21f142009-03-04 13:51:13 +01002728mark_lock_irq(struct task_struct *curr, struct held_lock *this,
2729 enum lock_usage_bit new_bit)
Peter Zijlstra6a6904d2009-01-22 16:07:44 +01002730{
Peter Zijlstraf9892092009-01-22 16:09:59 +01002731 int excl_bit = exclusive_bit(new_bit);
Peter Zijlstra9d3651a2009-01-22 17:18:32 +01002732 int read = new_bit & 1;
Peter Zijlstra42c50d52009-01-22 16:58:16 +01002733 int dir = new_bit & 2;
2734
Peter Zijlstra38aa2712009-01-27 14:53:50 +01002735 /*
2736 * mark USED_IN has to look forwards -- to ensure no dependency
2737 * has ENABLED state, which would allow recursion deadlocks.
2738 *
2739 * mark ENABLED has to look backwards -- to ensure no dependee
2740 * has USED_IN state, which, again, would allow recursion deadlocks.
2741 */
Peter Zijlstra42c50d52009-01-22 16:58:16 +01002742 check_usage_f usage = dir ?
2743 check_usage_backwards : check_usage_forwards;
Peter Zijlstraf9892092009-01-22 16:09:59 +01002744
Peter Zijlstra38aa2712009-01-27 14:53:50 +01002745 /*
2746 * Validate that this particular lock does not have conflicting
2747 * usage states.
2748 */
Peter Zijlstra6a6904d2009-01-22 16:07:44 +01002749 if (!valid_state(curr, this, new_bit, excl_bit))
2750 return 0;
Peter Zijlstra9d3651a2009-01-22 17:18:32 +01002751
Peter Zijlstra38aa2712009-01-27 14:53:50 +01002752 /*
2753 * Validate that the lock dependencies don't have conflicting usage
2754 * states.
2755 */
2756 if ((!read || !dir || STRICT_READ_CHECKS) &&
Peter Zijlstra1c21f142009-03-04 13:51:13 +01002757 !usage(curr, this, excl_bit, state_name(new_bit & ~1)))
Peter Zijlstra6a6904d2009-01-22 16:07:44 +01002758 return 0;
Peter Zijlstra780e8202009-01-22 16:51:29 +01002759
Peter Zijlstra38aa2712009-01-27 14:53:50 +01002760 /*
2761 * Check for read in write conflicts
2762 */
2763 if (!read) {
2764 if (!valid_state(curr, this, new_bit, excl_bit + 1))
2765 return 0;
2766
2767 if (STRICT_READ_CHECKS &&
Peter Zijlstra4f367d8a2009-01-22 18:10:42 +01002768 !usage(curr, this, excl_bit + 1,
2769 state_name(new_bit + 1)))
Peter Zijlstra38aa2712009-01-27 14:53:50 +01002770 return 0;
2771 }
Peter Zijlstra780e8202009-01-22 16:51:29 +01002772
Peter Zijlstracd953022009-01-22 16:38:21 +01002773 if (state_verbose(new_bit, hlock_class(this)))
Peter Zijlstra6a6904d2009-01-22 16:07:44 +01002774 return 2;
2775
2776 return 1;
2777}
2778
Nick Piggincf40bd12009-01-21 08:12:39 +01002779enum mark_type {
Peter Zijlstra36bfb9b2009-01-22 14:12:41 +01002780#define LOCKDEP_STATE(__STATE) __STATE,
2781#include "lockdep_states.h"
2782#undef LOCKDEP_STATE
Nick Piggincf40bd12009-01-21 08:12:39 +01002783};
2784
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002785/*
2786 * Mark all held locks with a usage bit:
2787 */
Steven Rostedt1d09daa2008-05-12 21:20:55 +02002788static int
Nick Piggincf40bd12009-01-21 08:12:39 +01002789mark_held_locks(struct task_struct *curr, enum mark_type mark)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002790{
2791 enum lock_usage_bit usage_bit;
2792 struct held_lock *hlock;
2793 int i;
2794
2795 for (i = 0; i < curr->lockdep_depth; i++) {
2796 hlock = curr->held_locks + i;
2797
Peter Zijlstracf2ad4d2009-01-27 13:58:08 +01002798 usage_bit = 2 + (mark << 2); /* ENABLED */
2799 if (hlock->read)
2800 usage_bit += 1; /* READ */
2801
2802 BUG_ON(usage_bit >= LOCK_USAGE_STATES);
Nick Piggincf40bd12009-01-21 08:12:39 +01002803
Oleg Nesterov34d0ed52014-01-20 19:20:13 +01002804 if (!hlock->check)
Peter Zijlstraefbe2ee2011-07-07 11:39:45 +02002805 continue;
2806
Jarek Poplawski4ff773bb2007-05-08 00:31:00 -07002807 if (!mark_lock(curr, hlock, usage_bit))
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002808 return 0;
2809 }
2810
2811 return 1;
2812}
2813
2814/*
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002815 * Hardirqs will be enabled:
2816 */
Peter Zijlstradd4e5d32011-06-21 17:17:27 +02002817static void __trace_hardirqs_on_caller(unsigned long ip)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002818{
2819 struct task_struct *curr = current;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002820
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002821 /* we'll do an OFF -> ON transition: */
2822 curr->hardirqs_enabled = 1;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002823
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002824 /*
2825 * We are going to turn hardirqs on, so set the
2826 * usage bit for all held locks:
2827 */
Nick Piggincf40bd12009-01-21 08:12:39 +01002828 if (!mark_held_locks(curr, HARDIRQ))
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002829 return;
2830 /*
2831 * If we have softirqs enabled, then set the usage
2832 * bit for all held locks. (disabled hardirqs prevented
2833 * this bit from being set before)
2834 */
2835 if (curr->softirqs_enabled)
Nick Piggincf40bd12009-01-21 08:12:39 +01002836 if (!mark_held_locks(curr, SOFTIRQ))
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002837 return;
2838
2839 curr->hardirq_enable_ip = ip;
2840 curr->hardirq_enable_event = ++curr->irq_events;
Frederic Weisbeckerbd6d29c2010-04-06 00:10:17 +02002841 debug_atomic_inc(hardirqs_on_events);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002842}
Peter Zijlstradd4e5d32011-06-21 17:17:27 +02002843
Andi Kleenb35f8302014-02-08 08:52:02 +01002844__visible void trace_hardirqs_on_caller(unsigned long ip)
Peter Zijlstradd4e5d32011-06-21 17:17:27 +02002845{
2846 time_hardirqs_on(CALLER_ADDR0, ip);
2847
2848 if (unlikely(!debug_locks || current->lockdep_recursion))
2849 return;
2850
Peter Zijlstra7d36b262011-07-26 13:13:44 +02002851 if (unlikely(current->hardirqs_enabled)) {
2852 /*
2853 * Neither irq nor preemption are disabled here
2854 * so this is racy by nature but losing one hit
2855 * in a stat is not a big deal.
2856 */
2857 __debug_atomic_inc(redundant_hardirqs_on);
2858 return;
2859 }
2860
Peter Zijlstra0119fee2011-09-02 01:30:29 +02002861 /*
2862 * We're enabling irqs and according to our state above irqs weren't
2863 * already enabled, yet we find the hardware thinks they are in fact
2864 * enabled.. someone messed up their IRQ state tracing.
2865 */
Peter Zijlstradd4e5d32011-06-21 17:17:27 +02002866 if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
2867 return;
2868
Peter Zijlstra0119fee2011-09-02 01:30:29 +02002869 /*
2870 * See the fine text that goes along with this variable definition.
2871 */
Peter Zijlstra7d36b262011-07-26 13:13:44 +02002872 if (DEBUG_LOCKS_WARN_ON(unlikely(early_boot_irqs_disabled)))
2873 return;
2874
Peter Zijlstra0119fee2011-09-02 01:30:29 +02002875 /*
2876 * Can't allow enabling interrupts while in an interrupt handler,
2877 * that's general bad form and such. Recursion, limited stack etc..
2878 */
Peter Zijlstra7d36b262011-07-26 13:13:44 +02002879 if (DEBUG_LOCKS_WARN_ON(current->hardirq_context))
2880 return;
2881
Peter Zijlstradd4e5d32011-06-21 17:17:27 +02002882 current->lockdep_recursion = 1;
2883 __trace_hardirqs_on_caller(ip);
2884 current->lockdep_recursion = 0;
2885}
Steven Rostedt81d68a92008-05-12 21:20:42 +02002886EXPORT_SYMBOL(trace_hardirqs_on_caller);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002887
Steven Rostedt1d09daa2008-05-12 21:20:55 +02002888void trace_hardirqs_on(void)
Steven Rostedt81d68a92008-05-12 21:20:42 +02002889{
2890 trace_hardirqs_on_caller(CALLER_ADDR0);
2891}
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002892EXPORT_SYMBOL(trace_hardirqs_on);
2893
2894/*
2895 * Hardirqs were disabled:
2896 */
Andi Kleenb35f8302014-02-08 08:52:02 +01002897__visible void trace_hardirqs_off_caller(unsigned long ip)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002898{
2899 struct task_struct *curr = current;
2900
Heiko Carstens6afe40b2008-10-28 11:14:58 +01002901 time_hardirqs_off(CALLER_ADDR0, ip);
Steven Rostedt81d68a92008-05-12 21:20:42 +02002902
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002903 if (unlikely(!debug_locks || current->lockdep_recursion))
2904 return;
2905
Peter Zijlstra0119fee2011-09-02 01:30:29 +02002906 /*
2907 * So we're supposed to get called after you mask local IRQs, but for
2908 * some reason the hardware doesn't quite think you did a proper job.
2909 */
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002910 if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
2911 return;
2912
2913 if (curr->hardirqs_enabled) {
2914 /*
2915 * We have done an ON -> OFF transition:
2916 */
2917 curr->hardirqs_enabled = 0;
Heiko Carstens6afe40b2008-10-28 11:14:58 +01002918 curr->hardirq_disable_ip = ip;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002919 curr->hardirq_disable_event = ++curr->irq_events;
Frederic Weisbeckerbd6d29c2010-04-06 00:10:17 +02002920 debug_atomic_inc(hardirqs_off_events);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002921 } else
Frederic Weisbeckerbd6d29c2010-04-06 00:10:17 +02002922 debug_atomic_inc(redundant_hardirqs_off);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002923}
Steven Rostedt81d68a92008-05-12 21:20:42 +02002924EXPORT_SYMBOL(trace_hardirqs_off_caller);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002925
Steven Rostedt1d09daa2008-05-12 21:20:55 +02002926void trace_hardirqs_off(void)
Steven Rostedt81d68a92008-05-12 21:20:42 +02002927{
2928 trace_hardirqs_off_caller(CALLER_ADDR0);
2929}
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002930EXPORT_SYMBOL(trace_hardirqs_off);
2931
2932/*
2933 * Softirqs will be enabled:
2934 */
2935void trace_softirqs_on(unsigned long ip)
2936{
2937 struct task_struct *curr = current;
2938
Peter Zijlstradd4e5d32011-06-21 17:17:27 +02002939 if (unlikely(!debug_locks || current->lockdep_recursion))
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002940 return;
2941
Peter Zijlstra0119fee2011-09-02 01:30:29 +02002942 /*
2943 * We fancy IRQs being disabled here, see softirq.c, avoids
2944 * funny state and nesting things.
2945 */
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002946 if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
2947 return;
2948
2949 if (curr->softirqs_enabled) {
Frederic Weisbeckerbd6d29c2010-04-06 00:10:17 +02002950 debug_atomic_inc(redundant_softirqs_on);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002951 return;
2952 }
2953
Peter Zijlstradd4e5d32011-06-21 17:17:27 +02002954 current->lockdep_recursion = 1;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002955 /*
2956 * We'll do an OFF -> ON transition:
2957 */
2958 curr->softirqs_enabled = 1;
2959 curr->softirq_enable_ip = ip;
2960 curr->softirq_enable_event = ++curr->irq_events;
Frederic Weisbeckerbd6d29c2010-04-06 00:10:17 +02002961 debug_atomic_inc(softirqs_on_events);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002962 /*
2963 * We are going to turn softirqs on, so set the
2964 * usage bit for all held locks, if hardirqs are
2965 * enabled too:
2966 */
2967 if (curr->hardirqs_enabled)
Nick Piggincf40bd12009-01-21 08:12:39 +01002968 mark_held_locks(curr, SOFTIRQ);
Peter Zijlstradd4e5d32011-06-21 17:17:27 +02002969 current->lockdep_recursion = 0;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002970}
2971
2972/*
2973 * Softirqs were disabled:
2974 */
2975void trace_softirqs_off(unsigned long ip)
2976{
2977 struct task_struct *curr = current;
2978
Peter Zijlstradd4e5d32011-06-21 17:17:27 +02002979 if (unlikely(!debug_locks || current->lockdep_recursion))
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002980 return;
2981
Peter Zijlstra0119fee2011-09-02 01:30:29 +02002982 /*
2983 * We fancy IRQs being disabled here, see softirq.c
2984 */
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002985 if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
2986 return;
2987
2988 if (curr->softirqs_enabled) {
2989 /*
2990 * We have done an ON -> OFF transition:
2991 */
2992 curr->softirqs_enabled = 0;
2993 curr->softirq_disable_ip = ip;
2994 curr->softirq_disable_event = ++curr->irq_events;
Frederic Weisbeckerbd6d29c2010-04-06 00:10:17 +02002995 debug_atomic_inc(softirqs_off_events);
Peter Zijlstra0119fee2011-09-02 01:30:29 +02002996 /*
2997 * Whoops, we wanted softirqs off, so why aren't they?
2998 */
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002999 DEBUG_LOCKS_WARN_ON(!softirq_count());
3000 } else
Frederic Weisbeckerbd6d29c2010-04-06 00:10:17 +02003001 debug_atomic_inc(redundant_softirqs_off);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003002}
3003
Peter Zijlstra8e182572007-07-19 01:48:54 -07003004static int mark_irqflags(struct task_struct *curr, struct held_lock *hlock)
3005{
3006 /*
3007 * If non-trylock use in a hardirq or softirq context, then
3008 * mark the lock as used in these contexts:
3009 */
3010 if (!hlock->trylock) {
3011 if (hlock->read) {
3012 if (curr->hardirq_context)
3013 if (!mark_lock(curr, hlock,
3014 LOCK_USED_IN_HARDIRQ_READ))
3015 return 0;
3016 if (curr->softirq_context)
3017 if (!mark_lock(curr, hlock,
3018 LOCK_USED_IN_SOFTIRQ_READ))
3019 return 0;
3020 } else {
3021 if (curr->hardirq_context)
3022 if (!mark_lock(curr, hlock, LOCK_USED_IN_HARDIRQ))
3023 return 0;
3024 if (curr->softirq_context)
3025 if (!mark_lock(curr, hlock, LOCK_USED_IN_SOFTIRQ))
3026 return 0;
3027 }
3028 }
3029 if (!hlock->hardirqs_off) {
3030 if (hlock->read) {
3031 if (!mark_lock(curr, hlock,
Peter Zijlstra4fc95e82009-01-22 13:10:52 +01003032 LOCK_ENABLED_HARDIRQ_READ))
Peter Zijlstra8e182572007-07-19 01:48:54 -07003033 return 0;
3034 if (curr->softirqs_enabled)
3035 if (!mark_lock(curr, hlock,
Peter Zijlstra4fc95e82009-01-22 13:10:52 +01003036 LOCK_ENABLED_SOFTIRQ_READ))
Peter Zijlstra8e182572007-07-19 01:48:54 -07003037 return 0;
3038 } else {
3039 if (!mark_lock(curr, hlock,
Peter Zijlstra4fc95e82009-01-22 13:10:52 +01003040 LOCK_ENABLED_HARDIRQ))
Peter Zijlstra8e182572007-07-19 01:48:54 -07003041 return 0;
3042 if (curr->softirqs_enabled)
3043 if (!mark_lock(curr, hlock,
Peter Zijlstra4fc95e82009-01-22 13:10:52 +01003044 LOCK_ENABLED_SOFTIRQ))
Peter Zijlstra8e182572007-07-19 01:48:54 -07003045 return 0;
3046 }
3047 }
3048
3049 return 1;
3050}
3051
Boqun Fengc2469752016-02-16 13:57:40 +08003052static inline unsigned int task_irq_context(struct task_struct *task)
3053{
3054 return 2 * !!task->hardirq_context + !!task->softirq_context;
3055}
3056
Peter Zijlstra8e182572007-07-19 01:48:54 -07003057static int separate_irq_context(struct task_struct *curr,
3058 struct held_lock *hlock)
3059{
3060 unsigned int depth = curr->lockdep_depth;
3061
3062 /*
3063 * Keep track of points where we cross into an interrupt context:
3064 */
Peter Zijlstra8e182572007-07-19 01:48:54 -07003065 if (depth) {
3066 struct held_lock *prev_hlock;
3067
3068 prev_hlock = curr->held_locks + depth-1;
3069 /*
3070 * If we cross into another context, reset the
3071 * hash key (this also prevents the checking and the
3072 * adding of the dependency to 'prev'):
3073 */
3074 if (prev_hlock->irq_context != hlock->irq_context)
3075 return 1;
3076 }
3077 return 0;
3078}
3079
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003080#else /* defined(CONFIG_TRACE_IRQFLAGS) && defined(CONFIG_PROVE_LOCKING) */
Peter Zijlstra8e182572007-07-19 01:48:54 -07003081
3082static inline
3083int mark_lock_irq(struct task_struct *curr, struct held_lock *this,
3084 enum lock_usage_bit new_bit)
3085{
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003086 WARN_ON(1); /* Impossible innit? when we don't have TRACE_IRQFLAG */
Peter Zijlstra8e182572007-07-19 01:48:54 -07003087 return 1;
3088}
3089
3090static inline int mark_irqflags(struct task_struct *curr,
3091 struct held_lock *hlock)
3092{
3093 return 1;
3094}
3095
Boqun Fengc2469752016-02-16 13:57:40 +08003096static inline unsigned int task_irq_context(struct task_struct *task)
3097{
3098 return 0;
3099}
3100
Peter Zijlstra8e182572007-07-19 01:48:54 -07003101static inline int separate_irq_context(struct task_struct *curr,
3102 struct held_lock *hlock)
3103{
3104 return 0;
3105}
3106
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003107#endif /* defined(CONFIG_TRACE_IRQFLAGS) && defined(CONFIG_PROVE_LOCKING) */
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003108
3109/*
Peter Zijlstra8e182572007-07-19 01:48:54 -07003110 * Mark a lock with a usage bit, and validate the state transition:
3111 */
Steven Rostedt1d09daa2008-05-12 21:20:55 +02003112static int mark_lock(struct task_struct *curr, struct held_lock *this,
Steven Rostedt0764d232008-05-12 21:20:44 +02003113 enum lock_usage_bit new_bit)
Peter Zijlstra8e182572007-07-19 01:48:54 -07003114{
3115 unsigned int new_mask = 1 << new_bit, ret = 1;
3116
3117 /*
3118 * If already set then do not dirty the cacheline,
3119 * nor do any checks:
3120 */
Dave Jonesf82b2172008-08-11 09:30:23 +02003121 if (likely(hlock_class(this)->usage_mask & new_mask))
Peter Zijlstra8e182572007-07-19 01:48:54 -07003122 return 1;
3123
3124 if (!graph_lock())
3125 return 0;
3126 /*
Lucas De Marchi25985ed2011-03-30 22:57:33 -03003127 * Make sure we didn't race:
Peter Zijlstra8e182572007-07-19 01:48:54 -07003128 */
Dave Jonesf82b2172008-08-11 09:30:23 +02003129 if (unlikely(hlock_class(this)->usage_mask & new_mask)) {
Peter Zijlstra8e182572007-07-19 01:48:54 -07003130 graph_unlock();
3131 return 1;
3132 }
3133
Dave Jonesf82b2172008-08-11 09:30:23 +02003134 hlock_class(this)->usage_mask |= new_mask;
Peter Zijlstra8e182572007-07-19 01:48:54 -07003135
Dave Jonesf82b2172008-08-11 09:30:23 +02003136 if (!save_trace(hlock_class(this)->usage_traces + new_bit))
Peter Zijlstra8e182572007-07-19 01:48:54 -07003137 return 0;
3138
3139 switch (new_bit) {
Peter Zijlstra53464172009-01-22 14:15:53 +01003140#define LOCKDEP_STATE(__STATE) \
3141 case LOCK_USED_IN_##__STATE: \
3142 case LOCK_USED_IN_##__STATE##_READ: \
3143 case LOCK_ENABLED_##__STATE: \
3144 case LOCK_ENABLED_##__STATE##_READ:
3145#include "lockdep_states.h"
3146#undef LOCKDEP_STATE
Peter Zijlstra8e182572007-07-19 01:48:54 -07003147 ret = mark_lock_irq(curr, this, new_bit);
3148 if (!ret)
3149 return 0;
3150 break;
3151 case LOCK_USED:
Frederic Weisbeckerbd6d29c2010-04-06 00:10:17 +02003152 debug_atomic_dec(nr_unused_locks);
Peter Zijlstra8e182572007-07-19 01:48:54 -07003153 break;
3154 default:
3155 if (!debug_locks_off_graph_unlock())
3156 return 0;
3157 WARN_ON(1);
3158 return 0;
3159 }
3160
3161 graph_unlock();
3162
3163 /*
3164 * We must printk outside of the graph_lock:
3165 */
3166 if (ret == 2) {
3167 printk("\nmarked lock as {%s}:\n", usage_str[new_bit]);
3168 print_lock(this);
3169 print_irqtrace_events(curr);
3170 dump_stack();
3171 }
3172
3173 return ret;
3174}
3175
3176/*
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003177 * Initialize a lock instance's lock-class mapping info:
3178 */
Byungchul Parkb09be672017-08-07 16:12:52 +09003179static void __lockdep_init_map(struct lockdep_map *lock, const char *name,
Peter Zijlstra4dfbb9d2006-10-11 01:45:14 -04003180 struct lock_class_key *key, int subclass)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003181{
Yong Zhangd3d03d42011-11-09 16:04:51 +08003182 int i;
3183
Yong Zhangd3d03d42011-11-09 16:04:51 +08003184 for (i = 0; i < NR_LOCKDEP_CACHING_CLASSES; i++)
3185 lock->class_cache[i] = NULL;
Hitoshi Mitake62016252010-10-05 18:01:51 +09003186
Peter Zijlstrac8a25002009-04-17 09:40:49 +02003187#ifdef CONFIG_LOCK_STAT
3188 lock->cpu = raw_smp_processor_id();
3189#endif
3190
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003191 /*
3192 * Can't be having no nameless bastards around this place!
3193 */
Peter Zijlstrac8a25002009-04-17 09:40:49 +02003194 if (DEBUG_LOCKS_WARN_ON(!name)) {
3195 lock->name = "NULL";
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003196 return;
Peter Zijlstrac8a25002009-04-17 09:40:49 +02003197 }
3198
3199 lock->name = name;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003200
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003201 /*
3202 * No key, no joy, we need to hash something.
3203 */
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003204 if (DEBUG_LOCKS_WARN_ON(!key))
3205 return;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003206 /*
3207 * Sanity check, the lock-class key must be persistent:
3208 */
3209 if (!static_obj(key)) {
Borislav Petkov04860d42018-02-26 14:49:26 +01003210 printk("BUG: key %px not in .data!\n", key);
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003211 /*
3212 * What it says above ^^^^^, I suggest you read it.
3213 */
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003214 DEBUG_LOCKS_WARN_ON(1);
3215 return;
3216 }
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003217 lock->key = key;
Peter Zijlstrac8a25002009-04-17 09:40:49 +02003218
3219 if (unlikely(!debug_locks))
3220 return;
3221
Peter Zijlstra35a93932015-02-26 16:23:11 +01003222 if (subclass) {
3223 unsigned long flags;
3224
3225 if (DEBUG_LOCKS_WARN_ON(current->lockdep_recursion))
3226 return;
3227
3228 raw_local_irq_save(flags);
3229 current->lockdep_recursion = 1;
Peter Zijlstra4dfbb9d2006-10-11 01:45:14 -04003230 register_lock_class(lock, subclass, 1);
Peter Zijlstra35a93932015-02-26 16:23:11 +01003231 current->lockdep_recursion = 0;
3232 raw_local_irq_restore(flags);
3233 }
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003234}
Byungchul Parkb09be672017-08-07 16:12:52 +09003235
3236void lockdep_init_map(struct lockdep_map *lock, const char *name,
3237 struct lock_class_key *key, int subclass)
3238{
Byungchul Parkb09be672017-08-07 16:12:52 +09003239 __lockdep_init_map(lock, name, key, subclass);
3240}
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003241EXPORT_SYMBOL_GPL(lockdep_init_map);
3242
Peter Zijlstra1704f472010-03-19 01:37:42 +01003243struct lock_class_key __lockdep_no_validate__;
Kent Overstreetea6749c2012-12-27 22:21:58 -08003244EXPORT_SYMBOL_GPL(__lockdep_no_validate__);
Peter Zijlstra1704f472010-03-19 01:37:42 +01003245
Maarten Lankhorstd0945952012-09-13 11:39:51 +02003246static int
3247print_lock_nested_lock_not_held(struct task_struct *curr,
3248 struct held_lock *hlock,
3249 unsigned long ip)
3250{
3251 if (!debug_locks_off())
3252 return 0;
3253 if (debug_locks_silent)
3254 return 0;
3255
Paul E. McKenney681fbec2017-05-04 15:44:38 -07003256 pr_warn("\n");
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08003257 pr_warn("==================================\n");
3258 pr_warn("WARNING: Nested lock was not taken\n");
Maarten Lankhorstd0945952012-09-13 11:39:51 +02003259 print_kernel_ident();
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08003260 pr_warn("----------------------------------\n");
Maarten Lankhorstd0945952012-09-13 11:39:51 +02003261
Paul E. McKenney681fbec2017-05-04 15:44:38 -07003262 pr_warn("%s/%d is trying to lock:\n", curr->comm, task_pid_nr(curr));
Maarten Lankhorstd0945952012-09-13 11:39:51 +02003263 print_lock(hlock);
3264
Paul E. McKenney681fbec2017-05-04 15:44:38 -07003265 pr_warn("\nbut this task is not holding:\n");
3266 pr_warn("%s\n", hlock->nest_lock->name);
Maarten Lankhorstd0945952012-09-13 11:39:51 +02003267
Paul E. McKenney681fbec2017-05-04 15:44:38 -07003268 pr_warn("\nstack backtrace:\n");
Maarten Lankhorstd0945952012-09-13 11:39:51 +02003269 dump_stack();
3270
Paul E. McKenney681fbec2017-05-04 15:44:38 -07003271 pr_warn("\nother info that might help us debug this:\n");
Maarten Lankhorstd0945952012-09-13 11:39:51 +02003272 lockdep_print_held_locks(curr);
3273
Paul E. McKenney681fbec2017-05-04 15:44:38 -07003274 pr_warn("\nstack backtrace:\n");
Maarten Lankhorstd0945952012-09-13 11:39:51 +02003275 dump_stack();
3276
3277 return 0;
3278}
3279
Matthew Wilcox08f36ff2018-01-17 07:14:13 -08003280static int __lock_is_held(const struct lockdep_map *lock, int read);
Maarten Lankhorstd0945952012-09-13 11:39:51 +02003281
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003282/*
3283 * This gets called for every mutex_lock*()/spin_lock*() operation.
3284 * We maintain the dependency maps and validate the locking attempt:
3285 */
3286static int __lock_acquire(struct lockdep_map *lock, unsigned int subclass,
3287 int trylock, int read, int check, int hardirqs_off,
Peter Zijlstrabb97a912009-07-20 19:15:35 +02003288 struct lockdep_map *nest_lock, unsigned long ip,
Peter Zijlstra21199f22015-09-16 16:10:40 +02003289 int references, int pin_count)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003290{
3291 struct task_struct *curr = current;
Ingo Molnard6d897c2006-07-10 04:44:04 -07003292 struct lock_class *class = NULL;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003293 struct held_lock *hlock;
Alfredo Alvarez Fernandez5f18ab52016-02-11 00:33:32 +01003294 unsigned int depth;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003295 int chain_head = 0;
Peter Zijlstrabb97a912009-07-20 19:15:35 +02003296 int class_idx;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003297 u64 chain_key;
3298
3299 if (unlikely(!debug_locks))
3300 return 0;
3301
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003302 /*
3303 * Lockdep should run with IRQs disabled, otherwise we could
3304 * get an interrupt which would want to take locks, which would
3305 * end up in lockdep and have you got a head-ache already?
3306 */
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003307 if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
3308 return 0;
3309
Oleg Nesterovfb9edbe2014-01-20 19:20:06 +01003310 if (!prove_locking || lock->key == &__lockdep_no_validate__)
3311 check = 0;
Peter Zijlstra1704f472010-03-19 01:37:42 +01003312
Hitoshi Mitake62016252010-10-05 18:01:51 +09003313 if (subclass < NR_LOCKDEP_CACHING_CLASSES)
3314 class = lock->class_cache[subclass];
Ingo Molnard6d897c2006-07-10 04:44:04 -07003315 /*
Hitoshi Mitake62016252010-10-05 18:01:51 +09003316 * Not cached?
Ingo Molnard6d897c2006-07-10 04:44:04 -07003317 */
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003318 if (unlikely(!class)) {
Peter Zijlstra4dfbb9d2006-10-11 01:45:14 -04003319 class = register_lock_class(lock, subclass, 0);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003320 if (!class)
3321 return 0;
3322 }
Frederic Weisbeckerbd6d29c2010-04-06 00:10:17 +02003323 atomic_inc((atomic_t *)&class->ops);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003324 if (very_verbose(class)) {
Borislav Petkov04860d42018-02-26 14:49:26 +01003325 printk("\nacquire class [%px] %s", class->key, class->name);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003326 if (class->name_version > 1)
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01003327 printk(KERN_CONT "#%d", class->name_version);
3328 printk(KERN_CONT "\n");
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003329 dump_stack();
3330 }
3331
3332 /*
3333 * Add the lock to the list of currently held locks.
3334 * (we dont increase the depth just yet, up until the
3335 * dependency checks are done)
3336 */
3337 depth = curr->lockdep_depth;
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003338 /*
3339 * Ran out of static storage for our per-task lock stack again have we?
3340 */
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003341 if (DEBUG_LOCKS_WARN_ON(depth >= MAX_LOCK_DEPTH))
3342 return 0;
3343
Peter Zijlstrabb97a912009-07-20 19:15:35 +02003344 class_idx = class - lock_classes + 1;
3345
Ingo Molnare966eae2017-12-12 12:31:16 +01003346 if (depth) {
Peter Zijlstrabb97a912009-07-20 19:15:35 +02003347 hlock = curr->held_locks + depth - 1;
3348 if (hlock->class_idx == class_idx && nest_lock) {
Peter Zijlstra7fb4a2c2017-03-01 16:23:30 +01003349 if (hlock->references) {
3350 /*
3351 * Check: unsigned int references:12, overflow.
3352 */
3353 if (DEBUG_LOCKS_WARN_ON(hlock->references == (1 << 12)-1))
3354 return 0;
3355
Peter Zijlstrabb97a912009-07-20 19:15:35 +02003356 hlock->references++;
Peter Zijlstra7fb4a2c2017-03-01 16:23:30 +01003357 } else {
Peter Zijlstrabb97a912009-07-20 19:15:35 +02003358 hlock->references = 2;
Peter Zijlstra7fb4a2c2017-03-01 16:23:30 +01003359 }
Peter Zijlstrabb97a912009-07-20 19:15:35 +02003360
3361 return 1;
3362 }
3363 }
3364
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003365 hlock = curr->held_locks + depth;
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003366 /*
3367 * Plain impossible, we just registered it and checked it weren't no
3368 * NULL like.. I bet this mushroom I ate was good!
3369 */
Dave Jonesf82b2172008-08-11 09:30:23 +02003370 if (DEBUG_LOCKS_WARN_ON(!class))
3371 return 0;
Peter Zijlstrabb97a912009-07-20 19:15:35 +02003372 hlock->class_idx = class_idx;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003373 hlock->acquire_ip = ip;
3374 hlock->instance = lock;
Peter Zijlstra7531e2f2008-08-11 09:30:24 +02003375 hlock->nest_lock = nest_lock;
Boqun Fengc2469752016-02-16 13:57:40 +08003376 hlock->irq_context = task_irq_context(curr);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003377 hlock->trylock = trylock;
3378 hlock->read = read;
3379 hlock->check = check;
Dmitry Baryshkov6951b122008-08-18 04:26:37 +04003380 hlock->hardirqs_off = !!hardirqs_off;
Peter Zijlstrabb97a912009-07-20 19:15:35 +02003381 hlock->references = references;
Peter Zijlstraf20786f2007-07-19 01:48:56 -07003382#ifdef CONFIG_LOCK_STAT
3383 hlock->waittime_stamp = 0;
Peter Zijlstra3365e7792009-10-09 10:12:41 +02003384 hlock->holdtime_stamp = lockstat_clock();
Peter Zijlstraf20786f2007-07-19 01:48:56 -07003385#endif
Peter Zijlstra21199f22015-09-16 16:10:40 +02003386 hlock->pin_count = pin_count;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003387
Oleg Nesterovfb9edbe2014-01-20 19:20:06 +01003388 if (check && !mark_irqflags(curr, hlock))
Peter Zijlstra8e182572007-07-19 01:48:54 -07003389 return 0;
3390
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003391 /* mark it as used: */
Jarek Poplawski4ff773bb2007-05-08 00:31:00 -07003392 if (!mark_lock(curr, hlock, LOCK_USED))
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003393 return 0;
Peter Zijlstra8e182572007-07-19 01:48:54 -07003394
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003395 /*
Gautham R Shenoy17aacfb92007-10-28 20:47:01 +01003396 * Calculate the chain hash: it's the combined hash of all the
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003397 * lock keys along the dependency chain. We save the hash value
3398 * at every step so that we can get the current hash easily
3399 * after unlock. The chain hash is then used to cache dependency
3400 * results.
3401 *
3402 * The 'key ID' is what is the most compact key value to drive
3403 * the hash, not class->key.
3404 */
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003405 /*
3406 * Whoops, we did it again.. ran straight out of our static allocation.
3407 */
Alfredo Alvarez Fernandez5f18ab52016-02-11 00:33:32 +01003408 if (DEBUG_LOCKS_WARN_ON(class_idx > MAX_LOCKDEP_KEYS))
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003409 return 0;
3410
3411 chain_key = curr->curr_chain_key;
3412 if (!depth) {
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003413 /*
3414 * How can we have a chain hash when we ain't got no keys?!
3415 */
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003416 if (DEBUG_LOCKS_WARN_ON(chain_key != 0))
3417 return 0;
3418 chain_head = 1;
3419 }
3420
3421 hlock->prev_chain_key = chain_key;
Peter Zijlstra8e182572007-07-19 01:48:54 -07003422 if (separate_irq_context(curr, hlock)) {
3423 chain_key = 0;
3424 chain_head = 1;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003425 }
Alfredo Alvarez Fernandez5f18ab52016-02-11 00:33:32 +01003426 chain_key = iterate_chain_key(chain_key, class_idx);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003427
Peter Zijlstraf8319482016-11-30 14:32:25 +11003428 if (nest_lock && !__lock_is_held(nest_lock, -1))
Maarten Lankhorstd0945952012-09-13 11:39:51 +02003429 return print_lock_nested_lock_not_held(curr, hlock, ip);
3430
Gregory Haskins3aa416b2007-10-11 22:11:11 +02003431 if (!validate_chain(curr, lock, hlock, chain_head, chain_key))
Peter Zijlstra8e182572007-07-19 01:48:54 -07003432 return 0;
Jarek Poplawski381a2292007-02-10 01:44:58 -08003433
Gregory Haskins3aa416b2007-10-11 22:11:11 +02003434 curr->curr_chain_key = chain_key;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003435 curr->lockdep_depth++;
3436 check_chain_key(curr);
Jarek Poplawski60e114d2007-02-20 13:58:00 -08003437#ifdef CONFIG_DEBUG_LOCKDEP
3438 if (unlikely(!debug_locks))
3439 return 0;
3440#endif
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003441 if (unlikely(curr->lockdep_depth >= MAX_LOCK_DEPTH)) {
3442 debug_locks_off();
Dave Jones2c522832013-04-25 13:40:02 -04003443 print_lockdep_off("BUG: MAX_LOCK_DEPTH too low!");
3444 printk(KERN_DEBUG "depth: %i max: %lu!\n",
Ben Greearc0540602013-02-06 10:56:19 -08003445 curr->lockdep_depth, MAX_LOCK_DEPTH);
Ben Greearc0540602013-02-06 10:56:19 -08003446
3447 lockdep_print_held_locks(current);
3448 debug_show_all_locks();
Peter Zijlstraeedeeab2009-03-18 12:38:47 +01003449 dump_stack();
Ben Greearc0540602013-02-06 10:56:19 -08003450
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003451 return 0;
3452 }
Jarek Poplawski381a2292007-02-10 01:44:58 -08003453
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003454 if (unlikely(curr->lockdep_depth > max_lockdep_depth))
3455 max_lockdep_depth = curr->lockdep_depth;
3456
3457 return 1;
3458}
3459
3460static int
Srivatsa S. Bhatf86f7552013-01-08 18:35:58 +05303461print_unlock_imbalance_bug(struct task_struct *curr, struct lockdep_map *lock,
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003462 unsigned long ip)
3463{
3464 if (!debug_locks_off())
3465 return 0;
3466 if (debug_locks_silent)
3467 return 0;
3468
Paul E. McKenney681fbec2017-05-04 15:44:38 -07003469 pr_warn("\n");
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08003470 pr_warn("=====================================\n");
3471 pr_warn("WARNING: bad unlock balance detected!\n");
Ben Hutchingsfbdc4b92011-10-28 04:36:55 +01003472 print_kernel_ident();
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08003473 pr_warn("-------------------------------------\n");
Paul E. McKenney681fbec2017-05-04 15:44:38 -07003474 pr_warn("%s/%d is trying to release lock (",
Pavel Emelyanovba25f9d2007-10-18 23:40:40 -07003475 curr->comm, task_pid_nr(curr));
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003476 print_lockdep_cache(lock);
Paul E. McKenney681fbec2017-05-04 15:44:38 -07003477 pr_cont(") at:\n");
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003478 print_ip_sym(ip);
Paul E. McKenney681fbec2017-05-04 15:44:38 -07003479 pr_warn("but there are no more locks to release!\n");
3480 pr_warn("\nother info that might help us debug this:\n");
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003481 lockdep_print_held_locks(curr);
3482
Paul E. McKenney681fbec2017-05-04 15:44:38 -07003483 pr_warn("\nstack backtrace:\n");
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003484 dump_stack();
3485
3486 return 0;
3487}
3488
Matthew Wilcox08f36ff2018-01-17 07:14:13 -08003489static int match_held_lock(const struct held_lock *hlock,
3490 const struct lockdep_map *lock)
Peter Zijlstrabb97a912009-07-20 19:15:35 +02003491{
3492 if (hlock->instance == lock)
3493 return 1;
3494
3495 if (hlock->references) {
Matthew Wilcox08f36ff2018-01-17 07:14:13 -08003496 const struct lock_class *class = lock->class_cache[0];
Peter Zijlstrabb97a912009-07-20 19:15:35 +02003497
3498 if (!class)
3499 class = look_up_lock_class(lock, 0);
3500
Peter Zijlstra80e04012011-08-05 14:26:17 +02003501 /*
3502 * If look_up_lock_class() failed to find a class, we're trying
3503 * to test if we hold a lock that has never yet been acquired.
3504 * Clearly if the lock hasn't been acquired _ever_, we're not
3505 * holding it either, so report failure.
3506 */
Matthew Wilcox64f29d12018-01-17 07:14:12 -08003507 if (!class)
Peter Zijlstrabb97a912009-07-20 19:15:35 +02003508 return 0;
3509
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003510 /*
3511 * References, but not a lock we're actually ref-counting?
3512 * State got messed up, follow the sites that change ->references
3513 * and try to make sense of it.
3514 */
Peter Zijlstrabb97a912009-07-20 19:15:35 +02003515 if (DEBUG_LOCKS_WARN_ON(!hlock->nest_lock))
3516 return 0;
3517
3518 if (hlock->class_idx == class - lock_classes + 1)
3519 return 1;
3520 }
3521
3522 return 0;
3523}
3524
J. R. Okajima41c2c5b2017-02-03 01:38:15 +09003525/* @depth must not be zero */
3526static struct held_lock *find_held_lock(struct task_struct *curr,
3527 struct lockdep_map *lock,
3528 unsigned int depth, int *idx)
3529{
3530 struct held_lock *ret, *hlock, *prev_hlock;
3531 int i;
3532
3533 i = depth - 1;
3534 hlock = curr->held_locks + i;
3535 ret = hlock;
3536 if (match_held_lock(hlock, lock))
3537 goto out;
3538
3539 ret = NULL;
3540 for (i--, prev_hlock = hlock--;
3541 i >= 0;
3542 i--, prev_hlock = hlock--) {
3543 /*
3544 * We must not cross into another context:
3545 */
3546 if (prev_hlock->irq_context != hlock->irq_context) {
3547 ret = NULL;
3548 break;
3549 }
3550 if (match_held_lock(hlock, lock)) {
3551 ret = hlock;
3552 break;
3553 }
3554 }
3555
3556out:
3557 *idx = i;
3558 return ret;
3559}
3560
J. R. Okajimae9699702017-02-03 01:38:16 +09003561static int reacquire_held_locks(struct task_struct *curr, unsigned int depth,
3562 int idx)
3563{
3564 struct held_lock *hlock;
3565
3566 for (hlock = curr->held_locks + idx; idx < depth; idx++, hlock++) {
3567 if (!__lock_acquire(hlock->instance,
3568 hlock_class(hlock)->subclass,
3569 hlock->trylock,
3570 hlock->read, hlock->check,
3571 hlock->hardirqs_off,
3572 hlock->nest_lock, hlock->acquire_ip,
3573 hlock->references, hlock->pin_count))
3574 return 1;
3575 }
3576 return 0;
3577}
3578
Peter Zijlstra64aa3482008-08-11 09:30:21 +02003579static int
Peter Zijlstra00ef9f72008-12-04 09:00:17 +01003580__lock_set_class(struct lockdep_map *lock, const char *name,
3581 struct lock_class_key *key, unsigned int subclass,
3582 unsigned long ip)
Peter Zijlstra64aa3482008-08-11 09:30:21 +02003583{
3584 struct task_struct *curr = current;
J. R. Okajima41c2c5b2017-02-03 01:38:15 +09003585 struct held_lock *hlock;
Peter Zijlstra64aa3482008-08-11 09:30:21 +02003586 struct lock_class *class;
3587 unsigned int depth;
3588 int i;
3589
3590 depth = curr->lockdep_depth;
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003591 /*
3592 * This function is about (re)setting the class of a held lock,
3593 * yet we're not actually holding any locks. Naughty user!
3594 */
Peter Zijlstra64aa3482008-08-11 09:30:21 +02003595 if (DEBUG_LOCKS_WARN_ON(!depth))
3596 return 0;
3597
J. R. Okajima41c2c5b2017-02-03 01:38:15 +09003598 hlock = find_held_lock(curr, lock, depth, &i);
3599 if (!hlock)
3600 return print_unlock_imbalance_bug(curr, lock, ip);
Peter Zijlstra64aa3482008-08-11 09:30:21 +02003601
Peter Zijlstra00ef9f72008-12-04 09:00:17 +01003602 lockdep_init_map(lock, name, key, 0);
Peter Zijlstra64aa3482008-08-11 09:30:21 +02003603 class = register_lock_class(lock, subclass, 0);
Dave Jonesf82b2172008-08-11 09:30:23 +02003604 hlock->class_idx = class - lock_classes + 1;
Peter Zijlstra64aa3482008-08-11 09:30:21 +02003605
3606 curr->lockdep_depth = i;
3607 curr->curr_chain_key = hlock->prev_chain_key;
3608
J. R. Okajimae9699702017-02-03 01:38:16 +09003609 if (reacquire_held_locks(curr, depth, i))
3610 return 0;
Peter Zijlstra64aa3482008-08-11 09:30:21 +02003611
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003612 /*
3613 * I took it apart and put it back together again, except now I have
3614 * these 'spare' parts.. where shall I put them.
3615 */
Peter Zijlstra64aa3482008-08-11 09:30:21 +02003616 if (DEBUG_LOCKS_WARN_ON(curr->lockdep_depth != depth))
3617 return 0;
3618 return 1;
3619}
3620
J. R. Okajima6419c4a2017-02-03 01:38:17 +09003621static int __lock_downgrade(struct lockdep_map *lock, unsigned long ip)
3622{
3623 struct task_struct *curr = current;
3624 struct held_lock *hlock;
3625 unsigned int depth;
3626 int i;
3627
3628 depth = curr->lockdep_depth;
3629 /*
3630 * This function is about (re)setting the class of a held lock,
3631 * yet we're not actually holding any locks. Naughty user!
3632 */
3633 if (DEBUG_LOCKS_WARN_ON(!depth))
3634 return 0;
3635
3636 hlock = find_held_lock(curr, lock, depth, &i);
3637 if (!hlock)
3638 return print_unlock_imbalance_bug(curr, lock, ip);
3639
3640 curr->lockdep_depth = i;
3641 curr->curr_chain_key = hlock->prev_chain_key;
3642
3643 WARN(hlock->read, "downgrading a read lock");
3644 hlock->read = 1;
3645 hlock->acquire_ip = ip;
3646
3647 if (reacquire_held_locks(curr, depth, i))
3648 return 0;
3649
3650 /*
3651 * I took it apart and put it back together again, except now I have
3652 * these 'spare' parts.. where shall I put them.
3653 */
3654 if (DEBUG_LOCKS_WARN_ON(curr->lockdep_depth != depth))
3655 return 0;
3656 return 1;
3657}
3658
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003659/*
Peter Zijlstrae0f56fd2015-06-11 14:46:52 +02003660 * Remove the lock to the list of currently held locks - this gets
3661 * called on mutex_unlock()/spin_unlock*() (or on a failed
3662 * mutex_lock_interruptible()).
3663 *
3664 * @nested is an hysterical artifact, needs a tree wide cleanup.
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003665 */
3666static int
Peter Zijlstrae0f56fd2015-06-11 14:46:52 +02003667__lock_release(struct lockdep_map *lock, int nested, unsigned long ip)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003668{
Peter Zijlstrae0f56fd2015-06-11 14:46:52 +02003669 struct task_struct *curr = current;
J. R. Okajima41c2c5b2017-02-03 01:38:15 +09003670 struct held_lock *hlock;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003671 unsigned int depth;
Ingo Molnare966eae2017-12-12 12:31:16 +01003672 int i;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003673
Peter Zijlstrae0f56fd2015-06-11 14:46:52 +02003674 if (unlikely(!debug_locks))
3675 return 0;
3676
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003677 depth = curr->lockdep_depth;
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003678 /*
3679 * So we're all set to release this lock.. wait what lock? We don't
3680 * own any locks, you've been drinking again?
3681 */
Peter Zijlstrae0f56fd2015-06-11 14:46:52 +02003682 if (DEBUG_LOCKS_WARN_ON(depth <= 0))
3683 return print_unlock_imbalance_bug(curr, lock, ip);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003684
Peter Zijlstrae0f56fd2015-06-11 14:46:52 +02003685 /*
3686 * Check whether the lock exists in the current stack
3687 * of held locks:
3688 */
J. R. Okajima41c2c5b2017-02-03 01:38:15 +09003689 hlock = find_held_lock(curr, lock, depth, &i);
3690 if (!hlock)
3691 return print_unlock_imbalance_bug(curr, lock, ip);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003692
Peter Zijlstrabb97a912009-07-20 19:15:35 +02003693 if (hlock->instance == lock)
3694 lock_release_holdtime(hlock);
3695
Peter Zijlstraa24fc602015-06-11 14:46:53 +02003696 WARN(hlock->pin_count, "releasing a pinned lock\n");
3697
Peter Zijlstrabb97a912009-07-20 19:15:35 +02003698 if (hlock->references) {
3699 hlock->references--;
3700 if (hlock->references) {
3701 /*
3702 * We had, and after removing one, still have
3703 * references, the current lock stack is still
3704 * valid. We're done!
3705 */
3706 return 1;
3707 }
3708 }
Peter Zijlstraf20786f2007-07-19 01:48:56 -07003709
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003710 /*
3711 * We have the right lock to unlock, 'hlock' points to it.
3712 * Now we remove it from the stack, and add back the other
3713 * entries (if any), recalculating the hash along the way:
3714 */
Peter Zijlstrabb97a912009-07-20 19:15:35 +02003715
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003716 curr->lockdep_depth = i;
3717 curr->curr_chain_key = hlock->prev_chain_key;
3718
J. R. Okajimae9699702017-02-03 01:38:16 +09003719 if (reacquire_held_locks(curr, depth, i + 1))
3720 return 0;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003721
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003722 /*
3723 * We had N bottles of beer on the wall, we drank one, but now
3724 * there's not N-1 bottles of beer left on the wall...
3725 */
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003726 if (DEBUG_LOCKS_WARN_ON(curr->lockdep_depth != depth - 1))
3727 return 0;
Peter Zijlstrae0f56fd2015-06-11 14:46:52 +02003728
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003729 return 1;
3730}
3731
Matthew Wilcox08f36ff2018-01-17 07:14:13 -08003732static int __lock_is_held(const struct lockdep_map *lock, int read)
Peter Zijlstraf607c662009-07-20 19:16:29 +02003733{
3734 struct task_struct *curr = current;
3735 int i;
3736
3737 for (i = 0; i < curr->lockdep_depth; i++) {
Peter Zijlstrabb97a912009-07-20 19:15:35 +02003738 struct held_lock *hlock = curr->held_locks + i;
3739
Peter Zijlstraf8319482016-11-30 14:32:25 +11003740 if (match_held_lock(hlock, lock)) {
3741 if (read == -1 || hlock->read == read)
3742 return 1;
3743
3744 return 0;
3745 }
Peter Zijlstraf607c662009-07-20 19:16:29 +02003746 }
3747
3748 return 0;
3749}
3750
Peter Zijlstrae7904a22015-08-01 19:25:08 +02003751static struct pin_cookie __lock_pin_lock(struct lockdep_map *lock)
3752{
3753 struct pin_cookie cookie = NIL_COOKIE;
3754 struct task_struct *curr = current;
3755 int i;
3756
3757 if (unlikely(!debug_locks))
3758 return cookie;
3759
3760 for (i = 0; i < curr->lockdep_depth; i++) {
3761 struct held_lock *hlock = curr->held_locks + i;
3762
3763 if (match_held_lock(hlock, lock)) {
3764 /*
3765 * Grab 16bits of randomness; this is sufficient to not
3766 * be guessable and still allows some pin nesting in
3767 * our u32 pin_count.
3768 */
3769 cookie.val = 1 + (prandom_u32() >> 16);
3770 hlock->pin_count += cookie.val;
3771 return cookie;
3772 }
3773 }
3774
3775 WARN(1, "pinning an unheld lock\n");
3776 return cookie;
3777}
3778
3779static void __lock_repin_lock(struct lockdep_map *lock, struct pin_cookie cookie)
Peter Zijlstraa24fc602015-06-11 14:46:53 +02003780{
3781 struct task_struct *curr = current;
3782 int i;
3783
3784 if (unlikely(!debug_locks))
3785 return;
3786
3787 for (i = 0; i < curr->lockdep_depth; i++) {
3788 struct held_lock *hlock = curr->held_locks + i;
3789
3790 if (match_held_lock(hlock, lock)) {
Peter Zijlstrae7904a22015-08-01 19:25:08 +02003791 hlock->pin_count += cookie.val;
Peter Zijlstraa24fc602015-06-11 14:46:53 +02003792 return;
3793 }
3794 }
3795
3796 WARN(1, "pinning an unheld lock\n");
3797}
3798
Peter Zijlstrae7904a22015-08-01 19:25:08 +02003799static void __lock_unpin_lock(struct lockdep_map *lock, struct pin_cookie cookie)
Peter Zijlstraa24fc602015-06-11 14:46:53 +02003800{
3801 struct task_struct *curr = current;
3802 int i;
3803
3804 if (unlikely(!debug_locks))
3805 return;
3806
3807 for (i = 0; i < curr->lockdep_depth; i++) {
3808 struct held_lock *hlock = curr->held_locks + i;
3809
3810 if (match_held_lock(hlock, lock)) {
3811 if (WARN(!hlock->pin_count, "unpinning an unpinned lock\n"))
3812 return;
3813
Peter Zijlstrae7904a22015-08-01 19:25:08 +02003814 hlock->pin_count -= cookie.val;
3815
3816 if (WARN((int)hlock->pin_count < 0, "pin count corrupted\n"))
3817 hlock->pin_count = 0;
3818
Peter Zijlstraa24fc602015-06-11 14:46:53 +02003819 return;
3820 }
3821 }
3822
3823 WARN(1, "unpinning an unheld lock\n");
3824}
3825
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003826/*
3827 * Check whether we follow the irq-flags state precisely:
3828 */
Steven Rostedt1d09daa2008-05-12 21:20:55 +02003829static void check_flags(unsigned long flags)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003830{
Ingo Molnar992860e2008-07-14 10:28:38 +02003831#if defined(CONFIG_PROVE_LOCKING) && defined(CONFIG_DEBUG_LOCKDEP) && \
3832 defined(CONFIG_TRACE_IRQFLAGS)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003833 if (!debug_locks)
3834 return;
3835
Ingo Molnar5f9fa8a62007-12-07 19:02:47 +01003836 if (irqs_disabled_flags(flags)) {
3837 if (DEBUG_LOCKS_WARN_ON(current->hardirqs_enabled)) {
3838 printk("possible reason: unannotated irqs-off.\n");
3839 }
3840 } else {
3841 if (DEBUG_LOCKS_WARN_ON(!current->hardirqs_enabled)) {
3842 printk("possible reason: unannotated irqs-on.\n");
3843 }
3844 }
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003845
3846 /*
3847 * We dont accurately track softirq state in e.g.
3848 * hardirq contexts (such as on 4KSTACKS), so only
3849 * check if not in hardirq contexts:
3850 */
3851 if (!hardirq_count()) {
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003852 if (softirq_count()) {
3853 /* like the above, but with softirqs */
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003854 DEBUG_LOCKS_WARN_ON(current->softirqs_enabled);
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003855 } else {
3856 /* lick the above, does it taste good? */
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003857 DEBUG_LOCKS_WARN_ON(!current->softirqs_enabled);
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003858 }
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003859 }
3860
3861 if (!debug_locks)
3862 print_irqtrace_events(current);
3863#endif
3864}
3865
Peter Zijlstra00ef9f72008-12-04 09:00:17 +01003866void lock_set_class(struct lockdep_map *lock, const char *name,
3867 struct lock_class_key *key, unsigned int subclass,
3868 unsigned long ip)
Peter Zijlstra64aa3482008-08-11 09:30:21 +02003869{
3870 unsigned long flags;
3871
3872 if (unlikely(current->lockdep_recursion))
3873 return;
3874
3875 raw_local_irq_save(flags);
3876 current->lockdep_recursion = 1;
3877 check_flags(flags);
Peter Zijlstra00ef9f72008-12-04 09:00:17 +01003878 if (__lock_set_class(lock, name, key, subclass, ip))
Peter Zijlstra64aa3482008-08-11 09:30:21 +02003879 check_chain_key(current);
3880 current->lockdep_recursion = 0;
3881 raw_local_irq_restore(flags);
3882}
Peter Zijlstra00ef9f72008-12-04 09:00:17 +01003883EXPORT_SYMBOL_GPL(lock_set_class);
Peter Zijlstra64aa3482008-08-11 09:30:21 +02003884
J. R. Okajima6419c4a2017-02-03 01:38:17 +09003885void lock_downgrade(struct lockdep_map *lock, unsigned long ip)
3886{
3887 unsigned long flags;
3888
3889 if (unlikely(current->lockdep_recursion))
3890 return;
3891
3892 raw_local_irq_save(flags);
3893 current->lockdep_recursion = 1;
3894 check_flags(flags);
3895 if (__lock_downgrade(lock, ip))
3896 check_chain_key(current);
3897 current->lockdep_recursion = 0;
3898 raw_local_irq_restore(flags);
3899}
3900EXPORT_SYMBOL_GPL(lock_downgrade);
3901
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003902/*
3903 * We are not always called with irqs disabled - do that here,
3904 * and also avoid lockdep recursion:
3905 */
Steven Rostedt1d09daa2008-05-12 21:20:55 +02003906void lock_acquire(struct lockdep_map *lock, unsigned int subclass,
Peter Zijlstra7531e2f2008-08-11 09:30:24 +02003907 int trylock, int read, int check,
3908 struct lockdep_map *nest_lock, unsigned long ip)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003909{
3910 unsigned long flags;
3911
3912 if (unlikely(current->lockdep_recursion))
3913 return;
3914
3915 raw_local_irq_save(flags);
3916 check_flags(flags);
3917
3918 current->lockdep_recursion = 1;
Frederic Weisbeckerdb2c4c72010-02-02 23:34:40 +01003919 trace_lock_acquire(lock, subclass, trylock, read, check, nest_lock, ip);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003920 __lock_acquire(lock, subclass, trylock, read, check,
Peter Zijlstra21199f22015-09-16 16:10:40 +02003921 irqs_disabled_flags(flags), nest_lock, ip, 0, 0);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003922 current->lockdep_recursion = 0;
3923 raw_local_irq_restore(flags);
3924}
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003925EXPORT_SYMBOL_GPL(lock_acquire);
3926
Steven Rostedt1d09daa2008-05-12 21:20:55 +02003927void lock_release(struct lockdep_map *lock, int nested,
Steven Rostedt0764d232008-05-12 21:20:44 +02003928 unsigned long ip)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003929{
3930 unsigned long flags;
3931
3932 if (unlikely(current->lockdep_recursion))
3933 return;
3934
3935 raw_local_irq_save(flags);
3936 check_flags(flags);
3937 current->lockdep_recursion = 1;
Frederic Weisbecker93135432010-05-08 06:24:25 +02003938 trace_lock_release(lock, ip);
Peter Zijlstrae0f56fd2015-06-11 14:46:52 +02003939 if (__lock_release(lock, nested, ip))
3940 check_chain_key(current);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003941 current->lockdep_recursion = 0;
3942 raw_local_irq_restore(flags);
3943}
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003944EXPORT_SYMBOL_GPL(lock_release);
3945
Matthew Wilcox08f36ff2018-01-17 07:14:13 -08003946int lock_is_held_type(const struct lockdep_map *lock, int read)
Peter Zijlstraf607c662009-07-20 19:16:29 +02003947{
3948 unsigned long flags;
3949 int ret = 0;
3950
3951 if (unlikely(current->lockdep_recursion))
Peter Zijlstraf2513cd2011-06-06 12:32:43 +02003952 return 1; /* avoid false negative lockdep_assert_held() */
Peter Zijlstraf607c662009-07-20 19:16:29 +02003953
3954 raw_local_irq_save(flags);
3955 check_flags(flags);
3956
3957 current->lockdep_recursion = 1;
Peter Zijlstraf8319482016-11-30 14:32:25 +11003958 ret = __lock_is_held(lock, read);
Peter Zijlstraf607c662009-07-20 19:16:29 +02003959 current->lockdep_recursion = 0;
3960 raw_local_irq_restore(flags);
3961
3962 return ret;
3963}
Peter Zijlstraf8319482016-11-30 14:32:25 +11003964EXPORT_SYMBOL_GPL(lock_is_held_type);
Peter Zijlstraf607c662009-07-20 19:16:29 +02003965
Peter Zijlstrae7904a22015-08-01 19:25:08 +02003966struct pin_cookie lock_pin_lock(struct lockdep_map *lock)
Peter Zijlstraa24fc602015-06-11 14:46:53 +02003967{
Peter Zijlstrae7904a22015-08-01 19:25:08 +02003968 struct pin_cookie cookie = NIL_COOKIE;
Peter Zijlstraa24fc602015-06-11 14:46:53 +02003969 unsigned long flags;
3970
3971 if (unlikely(current->lockdep_recursion))
Peter Zijlstrae7904a22015-08-01 19:25:08 +02003972 return cookie;
Peter Zijlstraa24fc602015-06-11 14:46:53 +02003973
3974 raw_local_irq_save(flags);
3975 check_flags(flags);
3976
3977 current->lockdep_recursion = 1;
Peter Zijlstrae7904a22015-08-01 19:25:08 +02003978 cookie = __lock_pin_lock(lock);
Peter Zijlstraa24fc602015-06-11 14:46:53 +02003979 current->lockdep_recursion = 0;
3980 raw_local_irq_restore(flags);
Peter Zijlstrae7904a22015-08-01 19:25:08 +02003981
3982 return cookie;
Peter Zijlstraa24fc602015-06-11 14:46:53 +02003983}
3984EXPORT_SYMBOL_GPL(lock_pin_lock);
3985
Peter Zijlstrae7904a22015-08-01 19:25:08 +02003986void lock_repin_lock(struct lockdep_map *lock, struct pin_cookie cookie)
Peter Zijlstraa24fc602015-06-11 14:46:53 +02003987{
3988 unsigned long flags;
3989
3990 if (unlikely(current->lockdep_recursion))
3991 return;
3992
3993 raw_local_irq_save(flags);
3994 check_flags(flags);
3995
3996 current->lockdep_recursion = 1;
Peter Zijlstrae7904a22015-08-01 19:25:08 +02003997 __lock_repin_lock(lock, cookie);
3998 current->lockdep_recursion = 0;
3999 raw_local_irq_restore(flags);
4000}
4001EXPORT_SYMBOL_GPL(lock_repin_lock);
4002
4003void lock_unpin_lock(struct lockdep_map *lock, struct pin_cookie cookie)
4004{
4005 unsigned long flags;
4006
4007 if (unlikely(current->lockdep_recursion))
4008 return;
4009
4010 raw_local_irq_save(flags);
4011 check_flags(flags);
4012
4013 current->lockdep_recursion = 1;
4014 __lock_unpin_lock(lock, cookie);
Peter Zijlstraa24fc602015-06-11 14:46:53 +02004015 current->lockdep_recursion = 0;
4016 raw_local_irq_restore(flags);
4017}
4018EXPORT_SYMBOL_GPL(lock_unpin_lock);
4019
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004020#ifdef CONFIG_LOCK_STAT
4021static int
4022print_lock_contention_bug(struct task_struct *curr, struct lockdep_map *lock,
4023 unsigned long ip)
4024{
4025 if (!debug_locks_off())
4026 return 0;
4027 if (debug_locks_silent)
4028 return 0;
4029
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004030 pr_warn("\n");
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08004031 pr_warn("=================================\n");
4032 pr_warn("WARNING: bad contention detected!\n");
Ben Hutchingsfbdc4b92011-10-28 04:36:55 +01004033 print_kernel_ident();
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08004034 pr_warn("---------------------------------\n");
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004035 pr_warn("%s/%d is trying to contend lock (",
Pavel Emelyanovba25f9d2007-10-18 23:40:40 -07004036 curr->comm, task_pid_nr(curr));
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004037 print_lockdep_cache(lock);
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004038 pr_cont(") at:\n");
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004039 print_ip_sym(ip);
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004040 pr_warn("but there are no locks held!\n");
4041 pr_warn("\nother info that might help us debug this:\n");
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004042 lockdep_print_held_locks(curr);
4043
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004044 pr_warn("\nstack backtrace:\n");
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004045 dump_stack();
4046
4047 return 0;
4048}
4049
4050static void
4051__lock_contended(struct lockdep_map *lock, unsigned long ip)
4052{
4053 struct task_struct *curr = current;
J. R. Okajima41c2c5b2017-02-03 01:38:15 +09004054 struct held_lock *hlock;
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004055 struct lock_class_stats *stats;
4056 unsigned int depth;
Peter Zijlstrac7e78cf2008-10-16 23:17:09 +02004057 int i, contention_point, contending_point;
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004058
4059 depth = curr->lockdep_depth;
Peter Zijlstra0119fee2011-09-02 01:30:29 +02004060 /*
4061 * Whee, we contended on this lock, except it seems we're not
4062 * actually trying to acquire anything much at all..
4063 */
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004064 if (DEBUG_LOCKS_WARN_ON(!depth))
4065 return;
4066
J. R. Okajima41c2c5b2017-02-03 01:38:15 +09004067 hlock = find_held_lock(curr, lock, depth, &i);
4068 if (!hlock) {
4069 print_lock_contention_bug(curr, lock, ip);
4070 return;
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004071 }
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004072
Peter Zijlstrabb97a912009-07-20 19:15:35 +02004073 if (hlock->instance != lock)
4074 return;
4075
Peter Zijlstra3365e7792009-10-09 10:12:41 +02004076 hlock->waittime_stamp = lockstat_clock();
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004077
Peter Zijlstrac7e78cf2008-10-16 23:17:09 +02004078 contention_point = lock_point(hlock_class(hlock)->contention_point, ip);
4079 contending_point = lock_point(hlock_class(hlock)->contending_point,
4080 lock->ip);
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004081
Dave Jonesf82b2172008-08-11 09:30:23 +02004082 stats = get_lock_stats(hlock_class(hlock));
Peter Zijlstrac7e78cf2008-10-16 23:17:09 +02004083 if (contention_point < LOCKSTAT_POINTS)
4084 stats->contention_point[contention_point]++;
4085 if (contending_point < LOCKSTAT_POINTS)
4086 stats->contending_point[contending_point]++;
Peter Zijlstra96645672007-07-19 01:49:00 -07004087 if (lock->cpu != smp_processor_id())
4088 stats->bounces[bounce_contended + !!hlock->read]++;
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004089 put_lock_stats(stats);
4090}
4091
4092static void
Peter Zijlstrac7e78cf2008-10-16 23:17:09 +02004093__lock_acquired(struct lockdep_map *lock, unsigned long ip)
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004094{
4095 struct task_struct *curr = current;
J. R. Okajima41c2c5b2017-02-03 01:38:15 +09004096 struct held_lock *hlock;
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004097 struct lock_class_stats *stats;
4098 unsigned int depth;
Peter Zijlstra3365e7792009-10-09 10:12:41 +02004099 u64 now, waittime = 0;
Peter Zijlstra96645672007-07-19 01:49:00 -07004100 int i, cpu;
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004101
4102 depth = curr->lockdep_depth;
Peter Zijlstra0119fee2011-09-02 01:30:29 +02004103 /*
4104 * Yay, we acquired ownership of this lock we didn't try to
4105 * acquire, how the heck did that happen?
4106 */
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004107 if (DEBUG_LOCKS_WARN_ON(!depth))
4108 return;
4109
J. R. Okajima41c2c5b2017-02-03 01:38:15 +09004110 hlock = find_held_lock(curr, lock, depth, &i);
4111 if (!hlock) {
4112 print_lock_contention_bug(curr, lock, _RET_IP_);
4113 return;
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004114 }
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004115
Peter Zijlstrabb97a912009-07-20 19:15:35 +02004116 if (hlock->instance != lock)
4117 return;
4118
Peter Zijlstra96645672007-07-19 01:49:00 -07004119 cpu = smp_processor_id();
4120 if (hlock->waittime_stamp) {
Peter Zijlstra3365e7792009-10-09 10:12:41 +02004121 now = lockstat_clock();
Peter Zijlstra96645672007-07-19 01:49:00 -07004122 waittime = now - hlock->waittime_stamp;
4123 hlock->holdtime_stamp = now;
4124 }
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004125
Frederic Weisbecker883a2a32010-05-08 06:16:11 +02004126 trace_lock_acquired(lock, ip);
Frederic Weisbecker20625012009-04-06 01:49:33 +02004127
Dave Jonesf82b2172008-08-11 09:30:23 +02004128 stats = get_lock_stats(hlock_class(hlock));
Peter Zijlstra96645672007-07-19 01:49:00 -07004129 if (waittime) {
4130 if (hlock->read)
4131 lock_time_inc(&stats->read_waittime, waittime);
4132 else
4133 lock_time_inc(&stats->write_waittime, waittime);
4134 }
4135 if (lock->cpu != cpu)
4136 stats->bounces[bounce_acquired + !!hlock->read]++;
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004137 put_lock_stats(stats);
Peter Zijlstra96645672007-07-19 01:49:00 -07004138
4139 lock->cpu = cpu;
Peter Zijlstrac7e78cf2008-10-16 23:17:09 +02004140 lock->ip = ip;
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004141}
4142
4143void lock_contended(struct lockdep_map *lock, unsigned long ip)
4144{
4145 unsigned long flags;
4146
4147 if (unlikely(!lock_stat))
4148 return;
4149
4150 if (unlikely(current->lockdep_recursion))
4151 return;
4152
4153 raw_local_irq_save(flags);
4154 check_flags(flags);
4155 current->lockdep_recursion = 1;
Frederic Weisbeckerdb2c4c72010-02-02 23:34:40 +01004156 trace_lock_contended(lock, ip);
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004157 __lock_contended(lock, ip);
4158 current->lockdep_recursion = 0;
4159 raw_local_irq_restore(flags);
4160}
4161EXPORT_SYMBOL_GPL(lock_contended);
4162
Peter Zijlstrac7e78cf2008-10-16 23:17:09 +02004163void lock_acquired(struct lockdep_map *lock, unsigned long ip)
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004164{
4165 unsigned long flags;
4166
4167 if (unlikely(!lock_stat))
4168 return;
4169
4170 if (unlikely(current->lockdep_recursion))
4171 return;
4172
4173 raw_local_irq_save(flags);
4174 check_flags(flags);
4175 current->lockdep_recursion = 1;
Peter Zijlstrac7e78cf2008-10-16 23:17:09 +02004176 __lock_acquired(lock, ip);
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004177 current->lockdep_recursion = 0;
4178 raw_local_irq_restore(flags);
4179}
4180EXPORT_SYMBOL_GPL(lock_acquired);
4181#endif
4182
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004183/*
4184 * Used by the testsuite, sanitize the validator state
4185 * after a simulated failure:
4186 */
4187
4188void lockdep_reset(void)
4189{
4190 unsigned long flags;
Ingo Molnar23d95a02006-12-13 00:34:40 -08004191 int i;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004192
4193 raw_local_irq_save(flags);
4194 current->curr_chain_key = 0;
4195 current->lockdep_depth = 0;
4196 current->lockdep_recursion = 0;
4197 memset(current->held_locks, 0, MAX_LOCK_DEPTH*sizeof(struct held_lock));
4198 nr_hardirq_chains = 0;
4199 nr_softirq_chains = 0;
4200 nr_process_chains = 0;
4201 debug_locks = 1;
Ingo Molnar23d95a02006-12-13 00:34:40 -08004202 for (i = 0; i < CHAINHASH_SIZE; i++)
Andrew Mortona63f38c2016-02-03 13:44:12 -08004203 INIT_HLIST_HEAD(chainhash_table + i);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004204 raw_local_irq_restore(flags);
4205}
4206
4207static void zap_class(struct lock_class *class)
4208{
4209 int i;
4210
4211 /*
4212 * Remove all dependencies this lock is
4213 * involved in:
4214 */
4215 for (i = 0; i < nr_list_entries; i++) {
4216 if (list_entries[i].class == class)
4217 list_del_rcu(&list_entries[i].entry);
4218 }
4219 /*
4220 * Unhash the class and remove it from the all_lock_classes list:
4221 */
Andrew Mortona63f38c2016-02-03 13:44:12 -08004222 hlist_del_rcu(&class->hash_entry);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004223 list_del_rcu(&class->lock_entry);
4224
Peter Zijlstracee34d82015-06-02 12:50:13 +02004225 RCU_INIT_POINTER(class->key, NULL);
4226 RCU_INIT_POINTER(class->name, NULL);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004227}
4228
Arjan van de Venfabe8742008-01-24 07:00:45 +01004229static inline int within(const void *addr, void *start, unsigned long size)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004230{
4231 return addr >= start && addr < start + size;
4232}
4233
Peter Zijlstra35a93932015-02-26 16:23:11 +01004234/*
4235 * Used in module.c to remove lock classes from memory that is going to be
4236 * freed; and possibly re-used by other modules.
4237 *
4238 * We will have had one sync_sched() before getting here, so we're guaranteed
4239 * nobody will look up these exact classes -- they're properly dead but still
4240 * allocated.
4241 */
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004242void lockdep_free_key_range(void *start, unsigned long size)
4243{
Peter Zijlstra35a93932015-02-26 16:23:11 +01004244 struct lock_class *class;
Andrew Mortona63f38c2016-02-03 13:44:12 -08004245 struct hlist_head *head;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004246 unsigned long flags;
4247 int i;
Nick Piggin5a26db52008-01-16 09:51:58 +01004248 int locked;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004249
4250 raw_local_irq_save(flags);
Nick Piggin5a26db52008-01-16 09:51:58 +01004251 locked = graph_lock();
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004252
4253 /*
4254 * Unhash all classes that were created by this module:
4255 */
4256 for (i = 0; i < CLASSHASH_SIZE; i++) {
4257 head = classhash_table + i;
Andrew Mortona63f38c2016-02-03 13:44:12 -08004258 hlist_for_each_entry_rcu(class, head, hash_entry) {
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004259 if (within(class->key, start, size))
4260 zap_class(class);
Arjan van de Venfabe8742008-01-24 07:00:45 +01004261 else if (within(class->name, start, size))
4262 zap_class(class);
4263 }
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004264 }
4265
Nick Piggin5a26db52008-01-16 09:51:58 +01004266 if (locked)
4267 graph_unlock();
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004268 raw_local_irq_restore(flags);
Peter Zijlstra35a93932015-02-26 16:23:11 +01004269
4270 /*
4271 * Wait for any possible iterators from look_up_lock_class() to pass
4272 * before continuing to free the memory they refer to.
4273 *
4274 * sync_sched() is sufficient because the read-side is IRQ disable.
4275 */
4276 synchronize_sched();
4277
4278 /*
4279 * XXX at this point we could return the resources to the pool;
4280 * instead we leak them. We would need to change to bitmap allocators
4281 * instead of the linear allocators we have now.
4282 */
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004283}
4284
4285void lockdep_reset_lock(struct lockdep_map *lock)
4286{
Peter Zijlstra35a93932015-02-26 16:23:11 +01004287 struct lock_class *class;
Andrew Mortona63f38c2016-02-03 13:44:12 -08004288 struct hlist_head *head;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004289 unsigned long flags;
4290 int i, j;
Nick Piggin5a26db52008-01-16 09:51:58 +01004291 int locked;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004292
4293 raw_local_irq_save(flags);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004294
4295 /*
Ingo Molnard6d897c2006-07-10 04:44:04 -07004296 * Remove all classes this lock might have:
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004297 */
Ingo Molnard6d897c2006-07-10 04:44:04 -07004298 for (j = 0; j < MAX_LOCKDEP_SUBCLASSES; j++) {
4299 /*
4300 * If the class exists we look it up and zap it:
4301 */
4302 class = look_up_lock_class(lock, j);
Matthew Wilcox64f29d12018-01-17 07:14:12 -08004303 if (class)
Ingo Molnard6d897c2006-07-10 04:44:04 -07004304 zap_class(class);
4305 }
4306 /*
4307 * Debug check: in the end all mapped classes should
4308 * be gone.
4309 */
Nick Piggin5a26db52008-01-16 09:51:58 +01004310 locked = graph_lock();
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004311 for (i = 0; i < CLASSHASH_SIZE; i++) {
4312 head = classhash_table + i;
Andrew Mortona63f38c2016-02-03 13:44:12 -08004313 hlist_for_each_entry_rcu(class, head, hash_entry) {
Hitoshi Mitake62016252010-10-05 18:01:51 +09004314 int match = 0;
4315
4316 for (j = 0; j < NR_LOCKDEP_CACHING_CLASSES; j++)
4317 match |= class == lock->class_cache[j];
4318
4319 if (unlikely(match)) {
Peter Zijlstra0119fee2011-09-02 01:30:29 +02004320 if (debug_locks_off_graph_unlock()) {
4321 /*
4322 * We all just reset everything, how did it match?
4323 */
Ingo Molnar74c383f2006-12-13 00:34:43 -08004324 WARN_ON(1);
Peter Zijlstra0119fee2011-09-02 01:30:29 +02004325 }
Ingo Molnard6d897c2006-07-10 04:44:04 -07004326 goto out_restore;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004327 }
4328 }
4329 }
Nick Piggin5a26db52008-01-16 09:51:58 +01004330 if (locked)
4331 graph_unlock();
Ingo Molnard6d897c2006-07-10 04:44:04 -07004332
4333out_restore:
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004334 raw_local_irq_restore(flags);
4335}
4336
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004337void __init lockdep_info(void)
4338{
4339 printk("Lock dependency validator: Copyright (c) 2006 Red Hat, Inc., Ingo Molnar\n");
4340
Li Zefanb0788ca2008-11-21 15:57:32 +08004341 printk("... MAX_LOCKDEP_SUBCLASSES: %lu\n", MAX_LOCKDEP_SUBCLASSES);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004342 printk("... MAX_LOCK_DEPTH: %lu\n", MAX_LOCK_DEPTH);
4343 printk("... MAX_LOCKDEP_KEYS: %lu\n", MAX_LOCKDEP_KEYS);
Li Zefanb0788ca2008-11-21 15:57:32 +08004344 printk("... CLASSHASH_SIZE: %lu\n", CLASSHASH_SIZE);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004345 printk("... MAX_LOCKDEP_ENTRIES: %lu\n", MAX_LOCKDEP_ENTRIES);
4346 printk("... MAX_LOCKDEP_CHAINS: %lu\n", MAX_LOCKDEP_CHAINS);
4347 printk("... CHAINHASH_SIZE: %lu\n", CHAINHASH_SIZE);
4348
4349 printk(" memory used by lock dependency info: %lu kB\n",
4350 (sizeof(struct lock_class) * MAX_LOCKDEP_KEYS +
4351 sizeof(struct list_head) * CLASSHASH_SIZE +
4352 sizeof(struct lock_list) * MAX_LOCKDEP_ENTRIES +
4353 sizeof(struct lock_chain) * MAX_LOCKDEP_CHAINS +
Ming Lei906292092009-08-02 21:43:36 +08004354 sizeof(struct list_head) * CHAINHASH_SIZE
Ming Lei4dd861d2009-07-16 15:44:29 +02004355#ifdef CONFIG_PROVE_LOCKING
Ming Leie351b662009-07-22 22:48:09 +08004356 + sizeof(struct circular_queue)
Ming Lei4dd861d2009-07-16 15:44:29 +02004357#endif
Ming Lei906292092009-08-02 21:43:36 +08004358 ) / 1024
Ming Lei4dd861d2009-07-16 15:44:29 +02004359 );
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004360
4361 printk(" per task-struct memory footprint: %lu bytes\n",
4362 sizeof(struct held_lock) * MAX_LOCK_DEPTH);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004363}
4364
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004365static void
4366print_freed_lock_bug(struct task_struct *curr, const void *mem_from,
Arjan van de Ven55794a42006-07-10 04:44:03 -07004367 const void *mem_to, struct held_lock *hlock)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004368{
4369 if (!debug_locks_off())
4370 return;
4371 if (debug_locks_silent)
4372 return;
4373
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004374 pr_warn("\n");
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08004375 pr_warn("=========================\n");
4376 pr_warn("WARNING: held lock freed!\n");
Ben Hutchingsfbdc4b92011-10-28 04:36:55 +01004377 print_kernel_ident();
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08004378 pr_warn("-------------------------\n");
Borislav Petkov04860d42018-02-26 14:49:26 +01004379 pr_warn("%s/%d is freeing memory %px-%px, with a lock still held there!\n",
Pavel Emelyanovba25f9d2007-10-18 23:40:40 -07004380 curr->comm, task_pid_nr(curr), mem_from, mem_to-1);
Arjan van de Ven55794a42006-07-10 04:44:03 -07004381 print_lock(hlock);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004382 lockdep_print_held_locks(curr);
4383
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004384 pr_warn("\nstack backtrace:\n");
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004385 dump_stack();
4386}
4387
Oleg Nesterov54561782007-12-05 15:46:09 +01004388static inline int not_in_range(const void* mem_from, unsigned long mem_len,
4389 const void* lock_from, unsigned long lock_len)
4390{
4391 return lock_from + lock_len <= mem_from ||
4392 mem_from + mem_len <= lock_from;
4393}
4394
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004395/*
4396 * Called when kernel memory is freed (or unmapped), or if a lock
4397 * is destroyed or reinitialized - this code checks whether there is
4398 * any held lock in the memory range of <from> to <to>:
4399 */
4400void debug_check_no_locks_freed(const void *mem_from, unsigned long mem_len)
4401{
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004402 struct task_struct *curr = current;
4403 struct held_lock *hlock;
4404 unsigned long flags;
4405 int i;
4406
4407 if (unlikely(!debug_locks))
4408 return;
4409
4410 local_irq_save(flags);
4411 for (i = 0; i < curr->lockdep_depth; i++) {
4412 hlock = curr->held_locks + i;
4413
Oleg Nesterov54561782007-12-05 15:46:09 +01004414 if (not_in_range(mem_from, mem_len, hlock->instance,
4415 sizeof(*hlock->instance)))
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004416 continue;
4417
Oleg Nesterov54561782007-12-05 15:46:09 +01004418 print_freed_lock_bug(curr, mem_from, mem_from + mem_len, hlock);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004419 break;
4420 }
4421 local_irq_restore(flags);
4422}
Peter Zijlstraed075362006-12-06 20:35:24 -08004423EXPORT_SYMBOL_GPL(debug_check_no_locks_freed);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004424
Colin Cross1b1d2fb2013-05-06 23:50:08 +00004425static void print_held_locks_bug(void)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004426{
4427 if (!debug_locks_off())
4428 return;
4429 if (debug_locks_silent)
4430 return;
4431
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004432 pr_warn("\n");
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08004433 pr_warn("====================================\n");
4434 pr_warn("WARNING: %s/%d still has locks held!\n",
Colin Cross1b1d2fb2013-05-06 23:50:08 +00004435 current->comm, task_pid_nr(current));
Ben Hutchingsfbdc4b92011-10-28 04:36:55 +01004436 print_kernel_ident();
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08004437 pr_warn("------------------------------------\n");
Colin Cross1b1d2fb2013-05-06 23:50:08 +00004438 lockdep_print_held_locks(current);
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004439 pr_warn("\nstack backtrace:\n");
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004440 dump_stack();
4441}
4442
Colin Cross1b1d2fb2013-05-06 23:50:08 +00004443void debug_check_no_locks_held(void)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004444{
Colin Cross1b1d2fb2013-05-06 23:50:08 +00004445 if (unlikely(current->lockdep_depth > 0))
4446 print_held_locks_bug();
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004447}
Colin Cross1b1d2fb2013-05-06 23:50:08 +00004448EXPORT_SYMBOL_GPL(debug_check_no_locks_held);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004449
Sasha Levin8dce7a92013-06-13 18:41:16 -04004450#ifdef __KERNEL__
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004451void debug_show_all_locks(void)
4452{
4453 struct task_struct *g, *p;
4454 int count = 10;
4455 int unlock = 1;
4456
Jarek Poplawski9c35dd72007-03-22 00:11:28 -08004457 if (unlikely(!debug_locks)) {
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004458 pr_warn("INFO: lockdep is turned off.\n");
Jarek Poplawski9c35dd72007-03-22 00:11:28 -08004459 return;
4460 }
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004461 pr_warn("\nShowing all locks held in the system:\n");
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004462
4463 /*
4464 * Here we try to get the tasklist_lock as hard as possible,
4465 * if not successful after 2 seconds we ignore it (but keep
4466 * trying). This is to enable a debug printout even if a
4467 * tasklist_lock-holding task deadlocks or crashes.
4468 */
4469retry:
4470 if (!read_trylock(&tasklist_lock)) {
4471 if (count == 10)
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004472 pr_warn("hm, tasklist_lock locked, retrying... ");
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004473 if (count) {
4474 count--;
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004475 pr_cont(" #%d", 10-count);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004476 mdelay(200);
4477 goto retry;
4478 }
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004479 pr_cont(" ignoring it.\n");
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004480 unlock = 0;
qinghuang feng46fec7a2008-10-28 17:24:28 +08004481 } else {
4482 if (count != 10)
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004483 pr_cont(" locked it.\n");
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004484 }
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004485
4486 do_each_thread(g, p) {
Ingo Molnar85684872007-12-05 15:46:09 +01004487 /*
4488 * It's not reliable to print a task's held locks
4489 * if it's not sleeping (or if it's not the current
4490 * task):
4491 */
4492 if (p->state == TASK_RUNNING && p != current)
4493 continue;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004494 if (p->lockdep_depth)
4495 lockdep_print_held_locks(p);
4496 if (!unlock)
4497 if (read_trylock(&tasklist_lock))
4498 unlock = 1;
Tejun Heo88f1c872018-01-22 14:00:55 -08004499 touch_nmi_watchdog();
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004500 } while_each_thread(g, p);
4501
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004502 pr_warn("\n");
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08004503 pr_warn("=============================================\n\n");
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004504
4505 if (unlock)
4506 read_unlock(&tasklist_lock);
4507}
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004508EXPORT_SYMBOL_GPL(debug_show_all_locks);
Sasha Levin8dce7a92013-06-13 18:41:16 -04004509#endif
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004510
Ingo Molnar82a1fcb2008-01-25 21:08:02 +01004511/*
4512 * Careful: only use this function if you are sure that
4513 * the task cannot run in parallel!
4514 */
John Kacurf1b499f2010-08-05 17:10:53 +02004515void debug_show_held_locks(struct task_struct *task)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004516{
Jarek Poplawski9c35dd72007-03-22 00:11:28 -08004517 if (unlikely(!debug_locks)) {
4518 printk("INFO: lockdep is turned off.\n");
4519 return;
4520 }
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004521 lockdep_print_held_locks(task);
4522}
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004523EXPORT_SYMBOL_GPL(debug_show_held_locks);
Peter Zijlstrab351d162007-10-11 22:11:12 +02004524
Andi Kleen722a9f92014-05-02 00:44:38 +02004525asmlinkage __visible void lockdep_sys_exit(void)
Peter Zijlstrab351d162007-10-11 22:11:12 +02004526{
4527 struct task_struct *curr = current;
4528
4529 if (unlikely(curr->lockdep_depth)) {
4530 if (!debug_locks_off())
4531 return;
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004532 pr_warn("\n");
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08004533 pr_warn("================================================\n");
4534 pr_warn("WARNING: lock held when returning to user space!\n");
Ben Hutchingsfbdc4b92011-10-28 04:36:55 +01004535 print_kernel_ident();
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08004536 pr_warn("------------------------------------------------\n");
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004537 pr_warn("%s/%d is leaving the kernel with locks still held!\n",
Peter Zijlstrab351d162007-10-11 22:11:12 +02004538 curr->comm, curr->pid);
4539 lockdep_print_held_locks(curr);
4540 }
Byungchul Parkb09be672017-08-07 16:12:52 +09004541
4542 /*
4543 * The lock history for each syscall should be independent. So wipe the
4544 * slate clean on return to userspace.
4545 */
Peter Zijlstraf52be572017-08-29 10:59:39 +02004546 lockdep_invariant_state(false);
Peter Zijlstrab351d162007-10-11 22:11:12 +02004547}
Paul E. McKenney0632eb32010-02-22 17:04:47 -08004548
Paul E. McKenneyb3fbab02011-05-24 08:31:09 -07004549void lockdep_rcu_suspicious(const char *file, const int line, const char *s)
Paul E. McKenney0632eb32010-02-22 17:04:47 -08004550{
4551 struct task_struct *curr = current;
4552
Lai Jiangshan2b3fc352010-04-20 16:23:07 +08004553 /* Note: the following can be executed concurrently, so be careful. */
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004554 pr_warn("\n");
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08004555 pr_warn("=============================\n");
4556 pr_warn("WARNING: suspicious RCU usage\n");
Ben Hutchingsfbdc4b92011-10-28 04:36:55 +01004557 print_kernel_ident();
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08004558 pr_warn("-----------------------------\n");
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004559 pr_warn("%s:%d %s!\n", file, line, s);
4560 pr_warn("\nother info that might help us debug this:\n\n");
4561 pr_warn("\n%srcu_scheduler_active = %d, debug_locks = %d\n",
Paul E. McKenneyc5fdcec2012-01-30 08:46:32 -08004562 !rcu_lockdep_current_cpu_online()
4563 ? "RCU used illegally from offline CPU!\n"
Paul E. McKenney5c173eb2013-09-13 17:20:11 -07004564 : !rcu_is_watching()
Paul E. McKenneyc5fdcec2012-01-30 08:46:32 -08004565 ? "RCU used illegally from idle CPU!\n"
4566 : "",
4567 rcu_scheduler_active, debug_locks);
Frederic Weisbecker0464e932011-10-07 18:22:01 +02004568
4569 /*
4570 * If a CPU is in the RCU-free window in idle (ie: in the section
4571 * between rcu_idle_enter() and rcu_idle_exit(), then RCU
4572 * considers that CPU to be in an "extended quiescent state",
4573 * which means that RCU will be completely ignoring that CPU.
4574 * Therefore, rcu_read_lock() and friends have absolutely no
4575 * effect on a CPU running in that state. In other words, even if
4576 * such an RCU-idle CPU has called rcu_read_lock(), RCU might well
4577 * delete data structures out from under it. RCU really has no
4578 * choice here: we need to keep an RCU-free window in idle where
4579 * the CPU may possibly enter into low power mode. This way we can
4580 * notice an extended quiescent state to other CPUs that started a grace
4581 * period. Otherwise we would delay any grace period as long as we run
4582 * in the idle task.
4583 *
4584 * So complain bitterly if someone does call rcu_read_lock(),
4585 * rcu_read_lock_bh() and so on from extended quiescent states.
4586 */
Paul E. McKenney5c173eb2013-09-13 17:20:11 -07004587 if (!rcu_is_watching())
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004588 pr_warn("RCU used illegally from extended quiescent state!\n");
Frederic Weisbecker0464e932011-10-07 18:22:01 +02004589
Paul E. McKenney0632eb32010-02-22 17:04:47 -08004590 lockdep_print_held_locks(curr);
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004591 pr_warn("\nstack backtrace:\n");
Paul E. McKenney0632eb32010-02-22 17:04:47 -08004592 dump_stack();
4593}
Paul E. McKenneyb3fbab02011-05-24 08:31:09 -07004594EXPORT_SYMBOL_GPL(lockdep_rcu_suspicious);