blob: 841828ba35b968e6cd99a4ec9c1cb6961f181441 [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>
Yong Zhangd3d03d42011-11-09 16:04:51 +080050#include <linux/kmemcheck.h>
Peter Zijlstrae7904a22015-08-01 19:25:08 +020051#include <linux/random.h>
Peter Zijlstradfaaf3f2016-05-30 18:31:33 +020052#include <linux/jhash.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
559 print_lock_name(lock_classes + class_idx - 1);
Dmitry Vyukovf943fe02016-11-28 15:24:43 +0100560 printk(KERN_CONT ", at: [<%p>] %pS\n",
561 (void *)hlock->acquire_ip, (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 -0700651/*
652 * Register a lock's class in the hash-table, if the class is not present
653 * yet. Otherwise we look it up. We cache the result in the lock object
654 * itself, so actual lookup of the hash should be once per lock object.
655 */
656static inline struct lock_class *
Ingo Molnard6d897c2006-07-10 04:44:04 -0700657look_up_lock_class(struct lockdep_map *lock, unsigned int subclass)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700658{
659 struct lockdep_subclass_key *key;
Andrew Mortona63f38c2016-02-03 13:44:12 -0800660 struct hlist_head *hash_head;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700661 struct lock_class *class;
Thomas Gleixner383776f2017-02-27 15:37:36 +0100662 bool is_static = false;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700663
Hitoshi Mitake4ba053c2010-10-13 17:30:26 +0900664 if (unlikely(subclass >= MAX_LOCKDEP_SUBCLASSES)) {
665 debug_locks_off();
666 printk(KERN_ERR
667 "BUG: looking up invalid subclass: %u\n", subclass);
668 printk(KERN_ERR
669 "turning off the locking correctness validator.\n");
670 dump_stack();
671 return NULL;
672 }
673
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700674 /*
675 * Static locks do not have their class-keys yet - for them the key
Thomas Gleixner383776f2017-02-27 15:37:36 +0100676 * is the lock object itself. If the lock is in the per cpu area,
677 * the canonical address of the lock (per cpu offset removed) is
678 * used.
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700679 */
Thomas Gleixner383776f2017-02-27 15:37:36 +0100680 if (unlikely(!lock->key)) {
681 unsigned long can_addr, addr = (unsigned long)lock;
682
683 if (__is_kernel_percpu_address(addr, &can_addr))
684 lock->key = (void *)can_addr;
685 else if (__is_module_percpu_address(addr, &can_addr))
686 lock->key = (void *)can_addr;
687 else if (static_obj(lock))
688 lock->key = (void *)lock;
689 else
690 return ERR_PTR(-EINVAL);
691 is_static = true;
692 }
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700693
694 /*
695 * NOTE: the class-key must be unique. For dynamic locks, a static
696 * lock_class_key variable is passed in through the mutex_init()
697 * (or spin_lock_init()) call - which acts as the key. For static
698 * locks we use the lock object itself as the key.
699 */
Peter Zijlstra4b32d0a2007-07-19 01:48:59 -0700700 BUILD_BUG_ON(sizeof(struct lock_class_key) >
701 sizeof(struct lockdep_map));
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700702
703 key = lock->key->subkeys + subclass;
704
705 hash_head = classhashentry(key);
706
707 /*
Peter Zijlstra35a93932015-02-26 16:23:11 +0100708 * We do an RCU walk of the hash, see lockdep_free_key_range().
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700709 */
Peter Zijlstra35a93932015-02-26 16:23:11 +0100710 if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
711 return NULL;
712
Andrew Mortona63f38c2016-02-03 13:44:12 -0800713 hlist_for_each_entry_rcu(class, hash_head, hash_entry) {
Peter Zijlstra4b32d0a2007-07-19 01:48:59 -0700714 if (class->key == key) {
Peter Zijlstra0119fee2011-09-02 01:30:29 +0200715 /*
716 * Huh! same key, different name? Did someone trample
717 * on some memory? We're most confused.
718 */
Peter Zijlstra4b32d0a2007-07-19 01:48:59 -0700719 WARN_ON_ONCE(class->name != lock->name);
Ingo Molnard6d897c2006-07-10 04:44:04 -0700720 return class;
Peter Zijlstra4b32d0a2007-07-19 01:48:59 -0700721 }
722 }
Ingo Molnard6d897c2006-07-10 04:44:04 -0700723
Thomas Gleixner383776f2017-02-27 15:37:36 +0100724 return is_static || static_obj(lock->key) ? NULL : ERR_PTR(-EINVAL);
Ingo Molnard6d897c2006-07-10 04:44:04 -0700725}
726
727/*
728 * Register a lock's class in the hash-table, if the class is not present
729 * yet. Otherwise we look it up. We cache the result in the lock object
730 * itself, so actual lookup of the hash should be once per lock object.
731 */
Denys Vlasenkoc003ed92016-04-08 20:58:46 +0200732static struct lock_class *
Peter Zijlstra4dfbb9d2006-10-11 01:45:14 -0400733register_lock_class(struct lockdep_map *lock, unsigned int subclass, int force)
Ingo Molnard6d897c2006-07-10 04:44:04 -0700734{
735 struct lockdep_subclass_key *key;
Andrew Mortona63f38c2016-02-03 13:44:12 -0800736 struct hlist_head *hash_head;
Ingo Molnard6d897c2006-07-10 04:44:04 -0700737 struct lock_class *class;
Peter Zijlstra35a93932015-02-26 16:23:11 +0100738
739 DEBUG_LOCKS_WARN_ON(!irqs_disabled());
Ingo Molnard6d897c2006-07-10 04:44:04 -0700740
741 class = look_up_lock_class(lock, subclass);
Thomas Gleixner383776f2017-02-27 15:37:36 +0100742 if (likely(!IS_ERR_OR_NULL(class)))
Yong Zhang87cdee72011-11-09 16:07:14 +0800743 goto out_set_class_cache;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700744
745 /*
746 * Debug-check: all keys must be persistent!
Thomas Gleixner383776f2017-02-27 15:37:36 +0100747 */
748 if (IS_ERR(class)) {
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700749 debug_locks_off();
750 printk("INFO: trying to register non-static key.\n");
751 printk("the code is fine but needs lockdep annotation.\n");
752 printk("turning off the locking correctness validator.\n");
753 dump_stack();
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700754 return NULL;
755 }
756
Ingo Molnard6d897c2006-07-10 04:44:04 -0700757 key = lock->key->subkeys + subclass;
758 hash_head = classhashentry(key);
759
Ingo Molnar74c383f2006-12-13 00:34:43 -0800760 if (!graph_lock()) {
Ingo Molnar74c383f2006-12-13 00:34:43 -0800761 return NULL;
762 }
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700763 /*
764 * We have to do the hash-walk again, to avoid races
765 * with another CPU:
766 */
Andrew Mortona63f38c2016-02-03 13:44:12 -0800767 hlist_for_each_entry_rcu(class, hash_head, hash_entry) {
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700768 if (class->key == key)
769 goto out_unlock_set;
Peter Zijlstra35a93932015-02-26 16:23:11 +0100770 }
771
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700772 /*
773 * Allocate a new key from the static array, and add it to
774 * the hash:
775 */
776 if (nr_lock_classes >= MAX_LOCKDEP_KEYS) {
Ingo Molnar74c383f2006-12-13 00:34:43 -0800777 if (!debug_locks_off_graph_unlock()) {
Ingo Molnar74c383f2006-12-13 00:34:43 -0800778 return NULL;
779 }
Ingo Molnar74c383f2006-12-13 00:34:43 -0800780
Dave Jones2c522832013-04-25 13:40:02 -0400781 print_lockdep_off("BUG: MAX_LOCKDEP_KEYS too low!");
Peter Zijlstraeedeeab2009-03-18 12:38:47 +0100782 dump_stack();
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700783 return NULL;
784 }
785 class = lock_classes + nr_lock_classes++;
Frederic Weisbeckerbd6d29c2010-04-06 00:10:17 +0200786 debug_atomic_inc(nr_unused_locks);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700787 class->key = key;
788 class->name = lock->name;
789 class->subclass = subclass;
790 INIT_LIST_HEAD(&class->lock_entry);
791 INIT_LIST_HEAD(&class->locks_before);
792 INIT_LIST_HEAD(&class->locks_after);
793 class->name_version = count_matching_names(class);
794 /*
795 * We use RCU's safe list-add method to make
796 * parallel walking of the hash-list safe:
797 */
Andrew Mortona63f38c2016-02-03 13:44:12 -0800798 hlist_add_head_rcu(&class->hash_entry, hash_head);
Dale Farnsworth14811972008-02-25 23:03:02 +0100799 /*
800 * Add it to the global list of classes:
801 */
802 list_add_tail_rcu(&class->lock_entry, &all_lock_classes);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700803
804 if (verbose(class)) {
Ingo Molnar74c383f2006-12-13 00:34:43 -0800805 graph_unlock();
Ingo Molnar74c383f2006-12-13 00:34:43 -0800806
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700807 printk("\nnew class %p: %s", class->key, class->name);
808 if (class->name_version > 1)
Dmitry Vyukovf943fe02016-11-28 15:24:43 +0100809 printk(KERN_CONT "#%d", class->name_version);
810 printk(KERN_CONT "\n");
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700811 dump_stack();
Ingo Molnar74c383f2006-12-13 00:34:43 -0800812
Ingo Molnar74c383f2006-12-13 00:34:43 -0800813 if (!graph_lock()) {
Ingo Molnar74c383f2006-12-13 00:34:43 -0800814 return NULL;
815 }
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700816 }
817out_unlock_set:
Ingo Molnar74c383f2006-12-13 00:34:43 -0800818 graph_unlock();
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700819
Yong Zhang87cdee72011-11-09 16:07:14 +0800820out_set_class_cache:
Peter Zijlstra4dfbb9d2006-10-11 01:45:14 -0400821 if (!subclass || force)
Hitoshi Mitake62016252010-10-05 18:01:51 +0900822 lock->class_cache[0] = class;
823 else if (subclass < NR_LOCKDEP_CACHING_CLASSES)
824 lock->class_cache[subclass] = class;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700825
Peter Zijlstra0119fee2011-09-02 01:30:29 +0200826 /*
827 * Hash collision, did we smoke some? We found a class with a matching
828 * hash but the subclass -- which is hashed in -- didn't match.
829 */
Jarek Poplawski381a2292007-02-10 01:44:58 -0800830 if (DEBUG_LOCKS_WARN_ON(class->subclass != subclass))
831 return NULL;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700832
833 return class;
834}
835
Peter Zijlstraca58abc2007-07-19 01:48:53 -0700836#ifdef CONFIG_PROVE_LOCKING
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700837/*
Peter Zijlstra8e182572007-07-19 01:48:54 -0700838 * Allocate a lockdep entry. (assumes the graph_lock held, returns
839 * with NULL on failure)
840 */
841static struct lock_list *alloc_list_entry(void)
842{
843 if (nr_list_entries >= MAX_LOCKDEP_ENTRIES) {
844 if (!debug_locks_off_graph_unlock())
845 return NULL;
846
Dave Jones2c522832013-04-25 13:40:02 -0400847 print_lockdep_off("BUG: MAX_LOCKDEP_ENTRIES too low!");
Peter Zijlstraeedeeab2009-03-18 12:38:47 +0100848 dump_stack();
Peter Zijlstra8e182572007-07-19 01:48:54 -0700849 return NULL;
850 }
851 return list_entries + nr_list_entries++;
852}
853
854/*
855 * Add a new dependency to the head of the list:
856 */
Tahsin Erdogan83f06162016-11-08 00:02:07 -0800857static int add_lock_to_list(struct lock_class *this, struct list_head *head,
858 unsigned long ip, int distance,
859 struct stack_trace *trace)
Peter Zijlstra8e182572007-07-19 01:48:54 -0700860{
861 struct lock_list *entry;
862 /*
863 * Lock not present yet - get a new dependency struct and
864 * add it to the list:
865 */
866 entry = alloc_list_entry();
867 if (!entry)
868 return 0;
869
Zhu Yi74870172008-08-27 14:33:00 +0800870 entry->class = this;
871 entry->distance = distance;
Yong Zhang4726f2a2010-05-04 14:16:48 +0800872 entry->trace = *trace;
Peter Zijlstra8e182572007-07-19 01:48:54 -0700873 /*
Peter Zijlstra35a93932015-02-26 16:23:11 +0100874 * Both allocation and removal are done under the graph lock; but
875 * iteration is under RCU-sched; see look_up_lock_class() and
876 * lockdep_free_key_range().
Peter Zijlstra8e182572007-07-19 01:48:54 -0700877 */
878 list_add_tail_rcu(&entry->entry, head);
879
880 return 1;
881}
882
Peter Zijlstra98c33ed2009-07-21 13:19:07 +0200883/*
884 * For good efficiency of modular, we use power of 2
885 */
Peter Zijlstraaf012962009-07-16 15:44:29 +0200886#define MAX_CIRCULAR_QUEUE_SIZE 4096UL
887#define CQ_MASK (MAX_CIRCULAR_QUEUE_SIZE-1)
888
Peter Zijlstra98c33ed2009-07-21 13:19:07 +0200889/*
890 * The circular_queue and helpers is used to implement the
Peter Zijlstraaf012962009-07-16 15:44:29 +0200891 * breadth-first search(BFS)algorithem, by which we can build
892 * the shortest path from the next lock to be acquired to the
893 * previous held lock if there is a circular between them.
Peter Zijlstra98c33ed2009-07-21 13:19:07 +0200894 */
Peter Zijlstraaf012962009-07-16 15:44:29 +0200895struct circular_queue {
896 unsigned long element[MAX_CIRCULAR_QUEUE_SIZE];
897 unsigned int front, rear;
898};
899
900static struct circular_queue lock_cq;
Peter Zijlstraaf012962009-07-16 15:44:29 +0200901
Ming Lei12f3dfd2009-07-16 15:44:29 +0200902unsigned int max_bfs_queue_depth;
Peter Zijlstraaf012962009-07-16 15:44:29 +0200903
Ming Leie351b662009-07-22 22:48:09 +0800904static unsigned int lockdep_dependency_gen_id;
905
Peter Zijlstraaf012962009-07-16 15:44:29 +0200906static inline void __cq_init(struct circular_queue *cq)
907{
908 cq->front = cq->rear = 0;
Ming Leie351b662009-07-22 22:48:09 +0800909 lockdep_dependency_gen_id++;
Peter Zijlstraaf012962009-07-16 15:44:29 +0200910}
911
912static inline int __cq_empty(struct circular_queue *cq)
913{
914 return (cq->front == cq->rear);
915}
916
917static inline int __cq_full(struct circular_queue *cq)
918{
919 return ((cq->rear + 1) & CQ_MASK) == cq->front;
920}
921
922static inline int __cq_enqueue(struct circular_queue *cq, unsigned long elem)
923{
924 if (__cq_full(cq))
925 return -1;
926
927 cq->element[cq->rear] = elem;
928 cq->rear = (cq->rear + 1) & CQ_MASK;
929 return 0;
930}
931
932static inline int __cq_dequeue(struct circular_queue *cq, unsigned long *elem)
933{
934 if (__cq_empty(cq))
935 return -1;
936
937 *elem = cq->element[cq->front];
938 cq->front = (cq->front + 1) & CQ_MASK;
939 return 0;
940}
941
942static inline unsigned int __cq_get_elem_count(struct circular_queue *cq)
943{
944 return (cq->rear - cq->front) & CQ_MASK;
945}
946
947static inline void mark_lock_accessed(struct lock_list *lock,
948 struct lock_list *parent)
949{
950 unsigned long nr;
Peter Zijlstra98c33ed2009-07-21 13:19:07 +0200951
Peter Zijlstraaf012962009-07-16 15:44:29 +0200952 nr = lock - list_entries;
Peter Zijlstra0119fee2011-09-02 01:30:29 +0200953 WARN_ON(nr >= nr_list_entries); /* Out-of-bounds, input fail */
Peter Zijlstraaf012962009-07-16 15:44:29 +0200954 lock->parent = parent;
Ming Leie351b662009-07-22 22:48:09 +0800955 lock->class->dep_gen_id = lockdep_dependency_gen_id;
Peter Zijlstraaf012962009-07-16 15:44:29 +0200956}
957
958static inline unsigned long lock_accessed(struct lock_list *lock)
959{
960 unsigned long nr;
Peter Zijlstra98c33ed2009-07-21 13:19:07 +0200961
Peter Zijlstraaf012962009-07-16 15:44:29 +0200962 nr = lock - list_entries;
Peter Zijlstra0119fee2011-09-02 01:30:29 +0200963 WARN_ON(nr >= nr_list_entries); /* Out-of-bounds, input fail */
Ming Leie351b662009-07-22 22:48:09 +0800964 return lock->class->dep_gen_id == lockdep_dependency_gen_id;
Peter Zijlstraaf012962009-07-16 15:44:29 +0200965}
966
967static inline struct lock_list *get_lock_parent(struct lock_list *child)
968{
969 return child->parent;
970}
971
972static inline int get_lock_depth(struct lock_list *child)
973{
974 int depth = 0;
975 struct lock_list *parent;
976
977 while ((parent = get_lock_parent(child))) {
978 child = parent;
979 depth++;
980 }
981 return depth;
982}
983
Ming Lei9e2d5512009-07-16 15:44:29 +0200984static int __bfs(struct lock_list *source_entry,
Peter Zijlstraaf012962009-07-16 15:44:29 +0200985 void *data,
986 int (*match)(struct lock_list *entry, void *data),
987 struct lock_list **target_entry,
988 int forward)
Ming Leic94aa5c2009-07-16 15:44:29 +0200989{
990 struct lock_list *entry;
Ming Leid588e462009-07-16 15:44:29 +0200991 struct list_head *head;
Ming Leic94aa5c2009-07-16 15:44:29 +0200992 struct circular_queue *cq = &lock_cq;
993 int ret = 1;
994
Ming Lei9e2d5512009-07-16 15:44:29 +0200995 if (match(source_entry, data)) {
Ming Leic94aa5c2009-07-16 15:44:29 +0200996 *target_entry = source_entry;
997 ret = 0;
998 goto exit;
999 }
1000
Ming Leid588e462009-07-16 15:44:29 +02001001 if (forward)
1002 head = &source_entry->class->locks_after;
1003 else
1004 head = &source_entry->class->locks_before;
1005
1006 if (list_empty(head))
1007 goto exit;
1008
1009 __cq_init(cq);
Ming Leic94aa5c2009-07-16 15:44:29 +02001010 __cq_enqueue(cq, (unsigned long)source_entry);
1011
1012 while (!__cq_empty(cq)) {
1013 struct lock_list *lock;
Ming Leic94aa5c2009-07-16 15:44:29 +02001014
1015 __cq_dequeue(cq, (unsigned long *)&lock);
1016
1017 if (!lock->class) {
1018 ret = -2;
1019 goto exit;
1020 }
1021
1022 if (forward)
1023 head = &lock->class->locks_after;
1024 else
1025 head = &lock->class->locks_before;
1026
Peter Zijlstra35a93932015-02-26 16:23:11 +01001027 DEBUG_LOCKS_WARN_ON(!irqs_disabled());
1028
1029 list_for_each_entry_rcu(entry, head, entry) {
Ming Leic94aa5c2009-07-16 15:44:29 +02001030 if (!lock_accessed(entry)) {
Ming Lei12f3dfd2009-07-16 15:44:29 +02001031 unsigned int cq_depth;
Ming Leic94aa5c2009-07-16 15:44:29 +02001032 mark_lock_accessed(entry, lock);
Ming Lei9e2d5512009-07-16 15:44:29 +02001033 if (match(entry, data)) {
Ming Leic94aa5c2009-07-16 15:44:29 +02001034 *target_entry = entry;
1035 ret = 0;
1036 goto exit;
1037 }
1038
1039 if (__cq_enqueue(cq, (unsigned long)entry)) {
1040 ret = -1;
1041 goto exit;
1042 }
Ming Lei12f3dfd2009-07-16 15:44:29 +02001043 cq_depth = __cq_get_elem_count(cq);
1044 if (max_bfs_queue_depth < cq_depth)
1045 max_bfs_queue_depth = cq_depth;
Ming Leic94aa5c2009-07-16 15:44:29 +02001046 }
1047 }
1048 }
1049exit:
1050 return ret;
1051}
1052
Ming Leid7aaba12009-07-16 15:44:29 +02001053static inline int __bfs_forwards(struct lock_list *src_entry,
Ming Lei9e2d5512009-07-16 15:44:29 +02001054 void *data,
1055 int (*match)(struct lock_list *entry, void *data),
1056 struct lock_list **target_entry)
Ming Leic94aa5c2009-07-16 15:44:29 +02001057{
Ming Lei9e2d5512009-07-16 15:44:29 +02001058 return __bfs(src_entry, data, match, target_entry, 1);
Ming Leic94aa5c2009-07-16 15:44:29 +02001059
1060}
1061
Ming Leid7aaba12009-07-16 15:44:29 +02001062static inline int __bfs_backwards(struct lock_list *src_entry,
Ming Lei9e2d5512009-07-16 15:44:29 +02001063 void *data,
1064 int (*match)(struct lock_list *entry, void *data),
1065 struct lock_list **target_entry)
Ming Leic94aa5c2009-07-16 15:44:29 +02001066{
Ming Lei9e2d5512009-07-16 15:44:29 +02001067 return __bfs(src_entry, data, match, target_entry, 0);
Ming Leic94aa5c2009-07-16 15:44:29 +02001068
1069}
1070
Peter Zijlstra8e182572007-07-19 01:48:54 -07001071/*
1072 * Recursive, forwards-direction lock-dependency checking, used for
1073 * both noncyclic checking and for hardirq-unsafe/softirq-unsafe
1074 * checking.
Peter Zijlstra8e182572007-07-19 01:48:54 -07001075 */
Peter Zijlstra8e182572007-07-19 01:48:54 -07001076
1077/*
1078 * Print a dependency chain entry (this is only done when a deadlock
1079 * has been detected):
1080 */
1081static noinline int
Ming Lei24208ca2009-07-16 15:44:29 +02001082print_circular_bug_entry(struct lock_list *target, int depth)
Peter Zijlstra8e182572007-07-19 01:48:54 -07001083{
1084 if (debug_locks_silent)
1085 return 0;
1086 printk("\n-> #%u", depth);
1087 print_lock_name(target->class);
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01001088 printk(KERN_CONT ":\n");
Peter Zijlstra8e182572007-07-19 01:48:54 -07001089 print_stack_trace(&target->trace, 6);
1090
1091 return 0;
1092}
1093
Steven Rostedtf4185812011-04-20 21:41:55 -04001094static void
1095print_circular_lock_scenario(struct held_lock *src,
1096 struct held_lock *tgt,
1097 struct lock_list *prt)
1098{
1099 struct lock_class *source = hlock_class(src);
1100 struct lock_class *target = hlock_class(tgt);
1101 struct lock_class *parent = prt->class;
1102
1103 /*
1104 * A direct locking problem where unsafe_class lock is taken
1105 * directly by safe_class lock, then all we need to show
1106 * is the deadlock scenario, as it is obvious that the
1107 * unsafe lock is taken under the safe lock.
1108 *
1109 * But if there is a chain instead, where the safe lock takes
1110 * an intermediate lock (middle_class) where this lock is
1111 * not the same as the safe lock, then the lock chain is
1112 * used to describe the problem. Otherwise we would need
1113 * to show a different CPU case for each link in the chain
1114 * from the safe_class lock to the unsafe_class lock.
1115 */
1116 if (parent != source) {
1117 printk("Chain exists of:\n ");
1118 __print_lock_name(source);
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01001119 printk(KERN_CONT " --> ");
Steven Rostedtf4185812011-04-20 21:41:55 -04001120 __print_lock_name(parent);
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01001121 printk(KERN_CONT " --> ");
Steven Rostedtf4185812011-04-20 21:41:55 -04001122 __print_lock_name(target);
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01001123 printk(KERN_CONT "\n\n");
Steven Rostedtf4185812011-04-20 21:41:55 -04001124 }
1125
1126 printk(" Possible unsafe locking scenario:\n\n");
1127 printk(" CPU0 CPU1\n");
1128 printk(" ---- ----\n");
1129 printk(" lock(");
1130 __print_lock_name(target);
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01001131 printk(KERN_CONT ");\n");
Steven Rostedtf4185812011-04-20 21:41:55 -04001132 printk(" lock(");
1133 __print_lock_name(parent);
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01001134 printk(KERN_CONT ");\n");
Steven Rostedtf4185812011-04-20 21:41:55 -04001135 printk(" lock(");
1136 __print_lock_name(target);
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01001137 printk(KERN_CONT ");\n");
Steven Rostedtf4185812011-04-20 21:41:55 -04001138 printk(" lock(");
1139 __print_lock_name(source);
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01001140 printk(KERN_CONT ");\n");
Steven Rostedtf4185812011-04-20 21:41:55 -04001141 printk("\n *** DEADLOCK ***\n\n");
1142}
1143
Peter Zijlstra8e182572007-07-19 01:48:54 -07001144/*
1145 * When a circular dependency is detected, print the
1146 * header first:
1147 */
1148static noinline int
Ming Leidb0002a2009-07-16 15:44:29 +02001149print_circular_bug_header(struct lock_list *entry, unsigned int depth,
1150 struct held_lock *check_src,
1151 struct held_lock *check_tgt)
Peter Zijlstra8e182572007-07-19 01:48:54 -07001152{
1153 struct task_struct *curr = current;
1154
Ming Leic94aa5c2009-07-16 15:44:29 +02001155 if (debug_locks_silent)
Peter Zijlstra8e182572007-07-19 01:48:54 -07001156 return 0;
1157
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001158 pr_warn("\n");
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08001159 pr_warn("======================================================\n");
1160 pr_warn("WARNING: possible circular locking dependency detected\n");
Ben Hutchingsfbdc4b92011-10-28 04:36:55 +01001161 print_kernel_ident();
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08001162 pr_warn("------------------------------------------------------\n");
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001163 pr_warn("%s/%d is trying to acquire lock:\n",
Pavel Emelyanovba25f9d2007-10-18 23:40:40 -07001164 curr->comm, task_pid_nr(curr));
Ming Leidb0002a2009-07-16 15:44:29 +02001165 print_lock(check_src);
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001166 pr_warn("\nbut task is already holding lock:\n");
Ming Leidb0002a2009-07-16 15:44:29 +02001167 print_lock(check_tgt);
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001168 pr_warn("\nwhich lock already depends on the new lock.\n\n");
1169 pr_warn("\nthe existing dependency chain (in reverse order) is:\n");
Peter Zijlstra8e182572007-07-19 01:48:54 -07001170
1171 print_circular_bug_entry(entry, depth);
1172
1173 return 0;
1174}
1175
Ming Lei9e2d5512009-07-16 15:44:29 +02001176static inline int class_equal(struct lock_list *entry, void *data)
1177{
1178 return entry->class == data;
1179}
1180
Ming Leidb0002a2009-07-16 15:44:29 +02001181static noinline int print_circular_bug(struct lock_list *this,
1182 struct lock_list *target,
1183 struct held_lock *check_src,
1184 struct held_lock *check_tgt)
Peter Zijlstra8e182572007-07-19 01:48:54 -07001185{
1186 struct task_struct *curr = current;
Ming Leic94aa5c2009-07-16 15:44:29 +02001187 struct lock_list *parent;
Steven Rostedtf4185812011-04-20 21:41:55 -04001188 struct lock_list *first_parent;
Ming Lei24208ca2009-07-16 15:44:29 +02001189 int depth;
Peter Zijlstra8e182572007-07-19 01:48:54 -07001190
Ming Leic94aa5c2009-07-16 15:44:29 +02001191 if (!debug_locks_off_graph_unlock() || debug_locks_silent)
Peter Zijlstra8e182572007-07-19 01:48:54 -07001192 return 0;
1193
Ming Leidb0002a2009-07-16 15:44:29 +02001194 if (!save_trace(&this->trace))
Peter Zijlstra8e182572007-07-19 01:48:54 -07001195 return 0;
1196
Ming Leic94aa5c2009-07-16 15:44:29 +02001197 depth = get_lock_depth(target);
1198
Ming Leidb0002a2009-07-16 15:44:29 +02001199 print_circular_bug_header(target, depth, check_src, check_tgt);
Ming Leic94aa5c2009-07-16 15:44:29 +02001200
1201 parent = get_lock_parent(target);
Steven Rostedtf4185812011-04-20 21:41:55 -04001202 first_parent = parent;
Ming Leic94aa5c2009-07-16 15:44:29 +02001203
1204 while (parent) {
1205 print_circular_bug_entry(parent, --depth);
1206 parent = get_lock_parent(parent);
1207 }
Peter Zijlstra8e182572007-07-19 01:48:54 -07001208
1209 printk("\nother info that might help us debug this:\n\n");
Steven Rostedtf4185812011-04-20 21:41:55 -04001210 print_circular_lock_scenario(check_src, check_tgt,
1211 first_parent);
1212
Peter Zijlstra8e182572007-07-19 01:48:54 -07001213 lockdep_print_held_locks(curr);
1214
1215 printk("\nstack backtrace:\n");
1216 dump_stack();
1217
1218 return 0;
1219}
1220
Ming Leidb0002a2009-07-16 15:44:29 +02001221static noinline int print_bfs_bug(int ret)
1222{
1223 if (!debug_locks_off_graph_unlock())
1224 return 0;
1225
Peter Zijlstra0119fee2011-09-02 01:30:29 +02001226 /*
1227 * Breadth-first-search failed, graph got corrupted?
1228 */
Ming Leidb0002a2009-07-16 15:44:29 +02001229 WARN(1, "lockdep bfs error:%d\n", ret);
1230
1231 return 0;
1232}
1233
Ming Leief681022009-07-16 15:44:29 +02001234static int noop_count(struct lock_list *entry, void *data)
David Miller419ca3f2008-07-29 21:45:03 -07001235{
Ming Leief681022009-07-16 15:44:29 +02001236 (*(unsigned long *)data)++;
1237 return 0;
David Miller419ca3f2008-07-29 21:45:03 -07001238}
1239
Fengguang Wu5216d532013-11-09 00:55:35 +08001240static unsigned long __lockdep_count_forward_deps(struct lock_list *this)
Ming Leief681022009-07-16 15:44:29 +02001241{
1242 unsigned long count = 0;
1243 struct lock_list *uninitialized_var(target_entry);
1244
1245 __bfs_forwards(this, (void *)&count, noop_count, &target_entry);
1246
1247 return count;
1248}
David Miller419ca3f2008-07-29 21:45:03 -07001249unsigned long lockdep_count_forward_deps(struct lock_class *class)
1250{
1251 unsigned long ret, flags;
Ming Leief681022009-07-16 15:44:29 +02001252 struct lock_list this;
1253
1254 this.parent = NULL;
1255 this.class = class;
David Miller419ca3f2008-07-29 21:45:03 -07001256
1257 local_irq_save(flags);
Thomas Gleixner0199c4e2009-12-02 20:01:25 +01001258 arch_spin_lock(&lockdep_lock);
Ming Leief681022009-07-16 15:44:29 +02001259 ret = __lockdep_count_forward_deps(&this);
Thomas Gleixner0199c4e2009-12-02 20:01:25 +01001260 arch_spin_unlock(&lockdep_lock);
David Miller419ca3f2008-07-29 21:45:03 -07001261 local_irq_restore(flags);
1262
1263 return ret;
1264}
1265
Fengguang Wu5216d532013-11-09 00:55:35 +08001266static unsigned long __lockdep_count_backward_deps(struct lock_list *this)
David Miller419ca3f2008-07-29 21:45:03 -07001267{
Ming Leief681022009-07-16 15:44:29 +02001268 unsigned long count = 0;
1269 struct lock_list *uninitialized_var(target_entry);
David Miller419ca3f2008-07-29 21:45:03 -07001270
Ming Leief681022009-07-16 15:44:29 +02001271 __bfs_backwards(this, (void *)&count, noop_count, &target_entry);
David Miller419ca3f2008-07-29 21:45:03 -07001272
Ming Leief681022009-07-16 15:44:29 +02001273 return count;
David Miller419ca3f2008-07-29 21:45:03 -07001274}
1275
1276unsigned long lockdep_count_backward_deps(struct lock_class *class)
1277{
1278 unsigned long ret, flags;
Ming Leief681022009-07-16 15:44:29 +02001279 struct lock_list this;
1280
1281 this.parent = NULL;
1282 this.class = class;
David Miller419ca3f2008-07-29 21:45:03 -07001283
1284 local_irq_save(flags);
Thomas Gleixner0199c4e2009-12-02 20:01:25 +01001285 arch_spin_lock(&lockdep_lock);
Ming Leief681022009-07-16 15:44:29 +02001286 ret = __lockdep_count_backward_deps(&this);
Thomas Gleixner0199c4e2009-12-02 20:01:25 +01001287 arch_spin_unlock(&lockdep_lock);
David Miller419ca3f2008-07-29 21:45:03 -07001288 local_irq_restore(flags);
1289
1290 return ret;
1291}
1292
Peter Zijlstra8e182572007-07-19 01:48:54 -07001293/*
1294 * Prove that the dependency graph starting at <entry> can not
1295 * lead to <target>. Print an error and return 0 if it does.
1296 */
1297static noinline int
Ming Leidb0002a2009-07-16 15:44:29 +02001298check_noncircular(struct lock_list *root, struct lock_class *target,
1299 struct lock_list **target_entry)
Peter Zijlstra8e182572007-07-19 01:48:54 -07001300{
Ming Leidb0002a2009-07-16 15:44:29 +02001301 int result;
Peter Zijlstra8e182572007-07-19 01:48:54 -07001302
Frederic Weisbeckerbd6d29c2010-04-06 00:10:17 +02001303 debug_atomic_inc(nr_cyclic_checks);
David Miller419ca3f2008-07-29 21:45:03 -07001304
Ming Leid7aaba12009-07-16 15:44:29 +02001305 result = __bfs_forwards(root, target, class_equal, target_entry);
Ming Leidb0002a2009-07-16 15:44:29 +02001306
1307 return result;
Peter Zijlstra8e182572007-07-19 01:48:54 -07001308}
1309
Peter Zijlstraae813302017-03-03 10:13:38 +01001310static noinline int
1311check_redundant(struct lock_list *root, struct lock_class *target,
1312 struct lock_list **target_entry)
1313{
1314 int result;
1315
1316 debug_atomic_inc(nr_redundant_checks);
1317
1318 result = __bfs_forwards(root, target, class_equal, target_entry);
1319
1320 return result;
1321}
1322
Steven Rostedt81d68a92008-05-12 21:20:42 +02001323#if defined(CONFIG_TRACE_IRQFLAGS) && defined(CONFIG_PROVE_LOCKING)
Peter Zijlstra8e182572007-07-19 01:48:54 -07001324/*
1325 * Forwards and backwards subgraph searching, for the purposes of
1326 * proving that two subgraphs can be connected by a new dependency
1327 * without creating any illegal irq-safe -> irq-unsafe lock dependency.
1328 */
Peter Zijlstra8e182572007-07-19 01:48:54 -07001329
Ming Leid7aaba12009-07-16 15:44:29 +02001330static inline int usage_match(struct lock_list *entry, void *bit)
1331{
1332 return entry->class->usage_mask & (1 << (enum lock_usage_bit)bit);
1333}
1334
1335
1336
Peter Zijlstra8e182572007-07-19 01:48:54 -07001337/*
1338 * Find a node in the forwards-direction dependency sub-graph starting
Ming Leid7aaba12009-07-16 15:44:29 +02001339 * at @root->class that matches @bit.
Peter Zijlstra8e182572007-07-19 01:48:54 -07001340 *
Ming Leid7aaba12009-07-16 15:44:29 +02001341 * Return 0 if such a node exists in the subgraph, and put that node
1342 * into *@target_entry.
Peter Zijlstra8e182572007-07-19 01:48:54 -07001343 *
Ming Leid7aaba12009-07-16 15:44:29 +02001344 * Return 1 otherwise and keep *@target_entry unchanged.
1345 * Return <0 on error.
Peter Zijlstra8e182572007-07-19 01:48:54 -07001346 */
Ming Leid7aaba12009-07-16 15:44:29 +02001347static int
1348find_usage_forwards(struct lock_list *root, enum lock_usage_bit bit,
1349 struct lock_list **target_entry)
Peter Zijlstra8e182572007-07-19 01:48:54 -07001350{
Ming Leid7aaba12009-07-16 15:44:29 +02001351 int result;
Peter Zijlstra8e182572007-07-19 01:48:54 -07001352
Frederic Weisbeckerbd6d29c2010-04-06 00:10:17 +02001353 debug_atomic_inc(nr_find_usage_forwards_checks);
Peter Zijlstra8e182572007-07-19 01:48:54 -07001354
Ming Leid7aaba12009-07-16 15:44:29 +02001355 result = __bfs_forwards(root, (void *)bit, usage_match, target_entry);
1356
1357 return result;
Peter Zijlstra8e182572007-07-19 01:48:54 -07001358}
1359
1360/*
1361 * Find a node in the backwards-direction dependency sub-graph starting
Ming Leid7aaba12009-07-16 15:44:29 +02001362 * at @root->class that matches @bit.
Peter Zijlstra8e182572007-07-19 01:48:54 -07001363 *
Ming Leid7aaba12009-07-16 15:44:29 +02001364 * Return 0 if such a node exists in the subgraph, and put that node
1365 * into *@target_entry.
Peter Zijlstra8e182572007-07-19 01:48:54 -07001366 *
Ming Leid7aaba12009-07-16 15:44:29 +02001367 * Return 1 otherwise and keep *@target_entry unchanged.
1368 * Return <0 on error.
Peter Zijlstra8e182572007-07-19 01:48:54 -07001369 */
Ming Leid7aaba12009-07-16 15:44:29 +02001370static int
1371find_usage_backwards(struct lock_list *root, enum lock_usage_bit bit,
1372 struct lock_list **target_entry)
Peter Zijlstra8e182572007-07-19 01:48:54 -07001373{
Ming Leid7aaba12009-07-16 15:44:29 +02001374 int result;
Peter Zijlstra8e182572007-07-19 01:48:54 -07001375
Frederic Weisbeckerbd6d29c2010-04-06 00:10:17 +02001376 debug_atomic_inc(nr_find_usage_backwards_checks);
Peter Zijlstra8e182572007-07-19 01:48:54 -07001377
Ming Leid7aaba12009-07-16 15:44:29 +02001378 result = __bfs_backwards(root, (void *)bit, usage_match, target_entry);
Dave Jonesf82b2172008-08-11 09:30:23 +02001379
Ming Leid7aaba12009-07-16 15:44:29 +02001380 return result;
Peter Zijlstra8e182572007-07-19 01:48:54 -07001381}
1382
Peter Zijlstraaf012962009-07-16 15:44:29 +02001383static void print_lock_class_header(struct lock_class *class, int depth)
1384{
1385 int bit;
1386
1387 printk("%*s->", depth, "");
1388 print_lock_name(class);
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01001389 printk(KERN_CONT " ops: %lu", class->ops);
1390 printk(KERN_CONT " {\n");
Peter Zijlstraaf012962009-07-16 15:44:29 +02001391
1392 for (bit = 0; bit < LOCK_USAGE_STATES; bit++) {
1393 if (class->usage_mask & (1 << bit)) {
1394 int len = depth;
1395
1396 len += printk("%*s %s", depth, "", usage_str[bit]);
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01001397 len += printk(KERN_CONT " at:\n");
Peter Zijlstraaf012962009-07-16 15:44:29 +02001398 print_stack_trace(class->usage_traces + bit, len);
1399 }
1400 }
1401 printk("%*s }\n", depth, "");
1402
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01001403 printk("%*s ... key at: [<%p>] %pS\n",
1404 depth, "", class->key, class->key);
Peter Zijlstraaf012962009-07-16 15:44:29 +02001405}
1406
1407/*
1408 * printk the shortest lock dependencies from @start to @end in reverse order:
1409 */
1410static void __used
1411print_shortest_lock_dependencies(struct lock_list *leaf,
1412 struct lock_list *root)
1413{
1414 struct lock_list *entry = leaf;
1415 int depth;
1416
1417 /*compute depth from generated tree by BFS*/
1418 depth = get_lock_depth(leaf);
1419
1420 do {
1421 print_lock_class_header(entry->class, depth);
1422 printk("%*s ... acquired at:\n", depth, "");
1423 print_stack_trace(&entry->trace, 2);
1424 printk("\n");
1425
1426 if (depth == 0 && (entry != root)) {
Steven Rostedt6be8c392011-04-20 21:41:58 -04001427 printk("lockdep:%s bad path found in chain graph\n", __func__);
Peter Zijlstraaf012962009-07-16 15:44:29 +02001428 break;
1429 }
1430
1431 entry = get_lock_parent(entry);
1432 depth--;
1433 } while (entry && (depth >= 0));
1434
1435 return;
1436}
Ming Leid7aaba12009-07-16 15:44:29 +02001437
Steven Rostedt3003eba2011-04-20 21:41:54 -04001438static void
1439print_irq_lock_scenario(struct lock_list *safe_entry,
1440 struct lock_list *unsafe_entry,
Steven Rostedtdad3d742011-04-20 21:41:57 -04001441 struct lock_class *prev_class,
1442 struct lock_class *next_class)
Steven Rostedt3003eba2011-04-20 21:41:54 -04001443{
1444 struct lock_class *safe_class = safe_entry->class;
1445 struct lock_class *unsafe_class = unsafe_entry->class;
Steven Rostedtdad3d742011-04-20 21:41:57 -04001446 struct lock_class *middle_class = prev_class;
Steven Rostedt3003eba2011-04-20 21:41:54 -04001447
1448 if (middle_class == safe_class)
Steven Rostedtdad3d742011-04-20 21:41:57 -04001449 middle_class = next_class;
Steven Rostedt3003eba2011-04-20 21:41:54 -04001450
1451 /*
1452 * A direct locking problem where unsafe_class lock is taken
1453 * directly by safe_class lock, then all we need to show
1454 * is the deadlock scenario, as it is obvious that the
1455 * unsafe lock is taken under the safe lock.
1456 *
1457 * But if there is a chain instead, where the safe lock takes
1458 * an intermediate lock (middle_class) where this lock is
1459 * not the same as the safe lock, then the lock chain is
1460 * used to describe the problem. Otherwise we would need
1461 * to show a different CPU case for each link in the chain
1462 * from the safe_class lock to the unsafe_class lock.
1463 */
1464 if (middle_class != unsafe_class) {
1465 printk("Chain exists of:\n ");
1466 __print_lock_name(safe_class);
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01001467 printk(KERN_CONT " --> ");
Steven Rostedt3003eba2011-04-20 21:41:54 -04001468 __print_lock_name(middle_class);
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01001469 printk(KERN_CONT " --> ");
Steven Rostedt3003eba2011-04-20 21:41:54 -04001470 __print_lock_name(unsafe_class);
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01001471 printk(KERN_CONT "\n\n");
Steven Rostedt3003eba2011-04-20 21:41:54 -04001472 }
1473
1474 printk(" Possible interrupt unsafe locking scenario:\n\n");
1475 printk(" CPU0 CPU1\n");
1476 printk(" ---- ----\n");
1477 printk(" lock(");
1478 __print_lock_name(unsafe_class);
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01001479 printk(KERN_CONT ");\n");
Steven Rostedt3003eba2011-04-20 21:41:54 -04001480 printk(" local_irq_disable();\n");
1481 printk(" lock(");
1482 __print_lock_name(safe_class);
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01001483 printk(KERN_CONT ");\n");
Steven Rostedt3003eba2011-04-20 21:41:54 -04001484 printk(" lock(");
1485 __print_lock_name(middle_class);
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01001486 printk(KERN_CONT ");\n");
Steven Rostedt3003eba2011-04-20 21:41:54 -04001487 printk(" <Interrupt>\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("\n *** DEADLOCK ***\n\n");
1492}
1493
Peter Zijlstra8e182572007-07-19 01:48:54 -07001494static int
1495print_bad_irq_dependency(struct task_struct *curr,
Ming Lei24208ca2009-07-16 15:44:29 +02001496 struct lock_list *prev_root,
1497 struct lock_list *next_root,
1498 struct lock_list *backwards_entry,
1499 struct lock_list *forwards_entry,
Peter Zijlstra8e182572007-07-19 01:48:54 -07001500 struct held_lock *prev,
1501 struct held_lock *next,
1502 enum lock_usage_bit bit1,
1503 enum lock_usage_bit bit2,
1504 const char *irqclass)
1505{
1506 if (!debug_locks_off_graph_unlock() || debug_locks_silent)
1507 return 0;
1508
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001509 pr_warn("\n");
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08001510 pr_warn("=====================================================\n");
1511 pr_warn("WARNING: %s-safe -> %s-unsafe lock order detected\n",
Peter Zijlstra8e182572007-07-19 01:48:54 -07001512 irqclass, irqclass);
Ben Hutchingsfbdc4b92011-10-28 04:36:55 +01001513 print_kernel_ident();
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08001514 pr_warn("-----------------------------------------------------\n");
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001515 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 -07001516 curr->comm, task_pid_nr(curr),
Peter Zijlstra8e182572007-07-19 01:48:54 -07001517 curr->hardirq_context, hardirq_count() >> HARDIRQ_SHIFT,
1518 curr->softirq_context, softirq_count() >> SOFTIRQ_SHIFT,
1519 curr->hardirqs_enabled,
1520 curr->softirqs_enabled);
1521 print_lock(next);
1522
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001523 pr_warn("\nand this task is already holding:\n");
Peter Zijlstra8e182572007-07-19 01:48:54 -07001524 print_lock(prev);
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001525 pr_warn("which would create a new lock dependency:\n");
Dave Jonesf82b2172008-08-11 09:30:23 +02001526 print_lock_name(hlock_class(prev));
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001527 pr_cont(" ->");
Dave Jonesf82b2172008-08-11 09:30:23 +02001528 print_lock_name(hlock_class(next));
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001529 pr_cont("\n");
Peter Zijlstra8e182572007-07-19 01:48:54 -07001530
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001531 pr_warn("\nbut this new dependency connects a %s-irq-safe lock:\n",
Peter Zijlstra8e182572007-07-19 01:48:54 -07001532 irqclass);
Ming Lei24208ca2009-07-16 15:44:29 +02001533 print_lock_name(backwards_entry->class);
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001534 pr_warn("\n... which became %s-irq-safe at:\n", irqclass);
Peter Zijlstra8e182572007-07-19 01:48:54 -07001535
Ming Lei24208ca2009-07-16 15:44:29 +02001536 print_stack_trace(backwards_entry->class->usage_traces + bit1, 1);
Peter Zijlstra8e182572007-07-19 01:48:54 -07001537
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001538 pr_warn("\nto a %s-irq-unsafe lock:\n", irqclass);
Ming Lei24208ca2009-07-16 15:44:29 +02001539 print_lock_name(forwards_entry->class);
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001540 pr_warn("\n... which became %s-irq-unsafe at:\n", irqclass);
1541 pr_warn("...");
Peter Zijlstra8e182572007-07-19 01:48:54 -07001542
Ming Lei24208ca2009-07-16 15:44:29 +02001543 print_stack_trace(forwards_entry->class->usage_traces + bit2, 1);
Peter Zijlstra8e182572007-07-19 01:48:54 -07001544
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001545 pr_warn("\nother info that might help us debug this:\n\n");
Steven Rostedtdad3d742011-04-20 21:41:57 -04001546 print_irq_lock_scenario(backwards_entry, forwards_entry,
1547 hlock_class(prev), hlock_class(next));
Steven Rostedt3003eba2011-04-20 21:41:54 -04001548
Peter Zijlstra8e182572007-07-19 01:48:54 -07001549 lockdep_print_held_locks(curr);
1550
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001551 pr_warn("\nthe dependencies between %s-irq-safe lock and the holding lock:\n", irqclass);
Ming Lei24208ca2009-07-16 15:44:29 +02001552 if (!save_trace(&prev_root->trace))
1553 return 0;
1554 print_shortest_lock_dependencies(backwards_entry, prev_root);
Peter Zijlstra8e182572007-07-19 01:48:54 -07001555
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001556 pr_warn("\nthe dependencies between the lock to be acquired");
1557 pr_warn(" and %s-irq-unsafe lock:\n", irqclass);
Ming Lei24208ca2009-07-16 15:44:29 +02001558 if (!save_trace(&next_root->trace))
1559 return 0;
1560 print_shortest_lock_dependencies(forwards_entry, next_root);
Peter Zijlstra8e182572007-07-19 01:48:54 -07001561
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001562 pr_warn("\nstack backtrace:\n");
Peter Zijlstra8e182572007-07-19 01:48:54 -07001563 dump_stack();
1564
1565 return 0;
1566}
1567
1568static int
1569check_usage(struct task_struct *curr, struct held_lock *prev,
1570 struct held_lock *next, enum lock_usage_bit bit_backwards,
1571 enum lock_usage_bit bit_forwards, const char *irqclass)
1572{
1573 int ret;
Ming Lei24208ca2009-07-16 15:44:29 +02001574 struct lock_list this, that;
Ming Leid7aaba12009-07-16 15:44:29 +02001575 struct lock_list *uninitialized_var(target_entry);
Ming Lei24208ca2009-07-16 15:44:29 +02001576 struct lock_list *uninitialized_var(target_entry1);
Peter Zijlstra8e182572007-07-19 01:48:54 -07001577
Ming Leid7aaba12009-07-16 15:44:29 +02001578 this.parent = NULL;
Peter Zijlstra8e182572007-07-19 01:48:54 -07001579
Ming Leid7aaba12009-07-16 15:44:29 +02001580 this.class = hlock_class(prev);
1581 ret = find_usage_backwards(&this, bit_backwards, &target_entry);
Peter Zijlstraaf012962009-07-16 15:44:29 +02001582 if (ret < 0)
1583 return print_bfs_bug(ret);
1584 if (ret == 1)
1585 return ret;
Ming Leid7aaba12009-07-16 15:44:29 +02001586
Ming Lei24208ca2009-07-16 15:44:29 +02001587 that.parent = NULL;
1588 that.class = hlock_class(next);
1589 ret = find_usage_forwards(&that, bit_forwards, &target_entry1);
Peter Zijlstraaf012962009-07-16 15:44:29 +02001590 if (ret < 0)
1591 return print_bfs_bug(ret);
1592 if (ret == 1)
1593 return ret;
Ming Leid7aaba12009-07-16 15:44:29 +02001594
Ming Lei24208ca2009-07-16 15:44:29 +02001595 return print_bad_irq_dependency(curr, &this, &that,
1596 target_entry, target_entry1,
1597 prev, next,
Peter Zijlstra8e182572007-07-19 01:48:54 -07001598 bit_backwards, bit_forwards, irqclass);
1599}
1600
Peter Zijlstra4f367d8a2009-01-22 18:10:42 +01001601static const char *state_names[] = {
1602#define LOCKDEP_STATE(__STATE) \
Peter Zijlstrab4b136f2009-01-29 14:50:36 +01001603 __stringify(__STATE),
Peter Zijlstra4f367d8a2009-01-22 18:10:42 +01001604#include "lockdep_states.h"
1605#undef LOCKDEP_STATE
1606};
1607
1608static const char *state_rnames[] = {
1609#define LOCKDEP_STATE(__STATE) \
Peter Zijlstrab4b136f2009-01-29 14:50:36 +01001610 __stringify(__STATE)"-READ",
Peter Zijlstra4f367d8a2009-01-22 18:10:42 +01001611#include "lockdep_states.h"
1612#undef LOCKDEP_STATE
1613};
1614
1615static inline const char *state_name(enum lock_usage_bit bit)
1616{
1617 return (bit & 1) ? state_rnames[bit >> 2] : state_names[bit >> 2];
1618}
1619
1620static int exclusive_bit(int new_bit)
1621{
1622 /*
1623 * USED_IN
1624 * USED_IN_READ
1625 * ENABLED
1626 * ENABLED_READ
1627 *
1628 * bit 0 - write/read
1629 * bit 1 - used_in/enabled
1630 * bit 2+ state
1631 */
1632
1633 int state = new_bit & ~3;
1634 int dir = new_bit & 2;
1635
1636 /*
1637 * keep state, bit flip the direction and strip read.
1638 */
1639 return state | (dir ^ 2);
1640}
1641
1642static int check_irq_usage(struct task_struct *curr, struct held_lock *prev,
1643 struct held_lock *next, enum lock_usage_bit bit)
Peter Zijlstra8e182572007-07-19 01:48:54 -07001644{
1645 /*
1646 * Prove that the new dependency does not connect a hardirq-safe
1647 * lock with a hardirq-unsafe lock - to achieve this we search
1648 * the backwards-subgraph starting at <prev>, and the
1649 * forwards-subgraph starting at <next>:
1650 */
Peter Zijlstra4f367d8a2009-01-22 18:10:42 +01001651 if (!check_usage(curr, prev, next, bit,
1652 exclusive_bit(bit), state_name(bit)))
Peter Zijlstra8e182572007-07-19 01:48:54 -07001653 return 0;
1654
Peter Zijlstra4f367d8a2009-01-22 18:10:42 +01001655 bit++; /* _READ */
1656
Peter Zijlstra8e182572007-07-19 01:48:54 -07001657 /*
1658 * Prove that the new dependency does not connect a hardirq-safe-read
1659 * lock with a hardirq-unsafe lock - to achieve this we search
1660 * the backwards-subgraph starting at <prev>, and the
1661 * forwards-subgraph starting at <next>:
1662 */
Peter Zijlstra4f367d8a2009-01-22 18:10:42 +01001663 if (!check_usage(curr, prev, next, bit,
1664 exclusive_bit(bit), state_name(bit)))
Peter Zijlstra8e182572007-07-19 01:48:54 -07001665 return 0;
1666
Peter Zijlstra4f367d8a2009-01-22 18:10:42 +01001667 return 1;
1668}
Peter Zijlstra8e182572007-07-19 01:48:54 -07001669
Peter Zijlstra4f367d8a2009-01-22 18:10:42 +01001670static int
1671check_prev_add_irq(struct task_struct *curr, struct held_lock *prev,
1672 struct held_lock *next)
1673{
1674#define LOCKDEP_STATE(__STATE) \
1675 if (!check_irq_usage(curr, prev, next, LOCK_USED_IN_##__STATE)) \
Nick Piggincf40bd12009-01-21 08:12:39 +01001676 return 0;
Peter Zijlstra4f367d8a2009-01-22 18:10:42 +01001677#include "lockdep_states.h"
1678#undef LOCKDEP_STATE
Nick Piggincf40bd12009-01-21 08:12:39 +01001679
Peter Zijlstra8e182572007-07-19 01:48:54 -07001680 return 1;
1681}
1682
1683static void inc_chains(void)
1684{
1685 if (current->hardirq_context)
1686 nr_hardirq_chains++;
1687 else {
1688 if (current->softirq_context)
1689 nr_softirq_chains++;
1690 else
1691 nr_process_chains++;
1692 }
1693}
1694
1695#else
1696
1697static inline int
1698check_prev_add_irq(struct task_struct *curr, struct held_lock *prev,
1699 struct held_lock *next)
1700{
1701 return 1;
1702}
1703
1704static inline void inc_chains(void)
1705{
1706 nr_process_chains++;
1707}
1708
1709#endif
1710
Steven Rostedt48702ec2011-04-20 21:41:56 -04001711static void
1712print_deadlock_scenario(struct held_lock *nxt,
1713 struct held_lock *prv)
1714{
1715 struct lock_class *next = hlock_class(nxt);
1716 struct lock_class *prev = hlock_class(prv);
1717
1718 printk(" Possible unsafe locking scenario:\n\n");
1719 printk(" CPU0\n");
1720 printk(" ----\n");
1721 printk(" lock(");
1722 __print_lock_name(prev);
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01001723 printk(KERN_CONT ");\n");
Steven Rostedt48702ec2011-04-20 21:41:56 -04001724 printk(" lock(");
1725 __print_lock_name(next);
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01001726 printk(KERN_CONT ");\n");
Steven Rostedt48702ec2011-04-20 21:41:56 -04001727 printk("\n *** DEADLOCK ***\n\n");
1728 printk(" May be due to missing lock nesting notation\n\n");
1729}
1730
Peter Zijlstra8e182572007-07-19 01:48:54 -07001731static int
1732print_deadlock_bug(struct task_struct *curr, struct held_lock *prev,
1733 struct held_lock *next)
1734{
1735 if (!debug_locks_off_graph_unlock() || debug_locks_silent)
1736 return 0;
1737
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001738 pr_warn("\n");
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08001739 pr_warn("============================================\n");
1740 pr_warn("WARNING: possible recursive locking detected\n");
Ben Hutchingsfbdc4b92011-10-28 04:36:55 +01001741 print_kernel_ident();
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08001742 pr_warn("--------------------------------------------\n");
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001743 pr_warn("%s/%d is trying to acquire lock:\n",
Pavel Emelyanovba25f9d2007-10-18 23:40:40 -07001744 curr->comm, task_pid_nr(curr));
Peter Zijlstra8e182572007-07-19 01:48:54 -07001745 print_lock(next);
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001746 pr_warn("\nbut task is already holding lock:\n");
Peter Zijlstra8e182572007-07-19 01:48:54 -07001747 print_lock(prev);
1748
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001749 pr_warn("\nother info that might help us debug this:\n");
Steven Rostedt48702ec2011-04-20 21:41:56 -04001750 print_deadlock_scenario(next, prev);
Peter Zijlstra8e182572007-07-19 01:48:54 -07001751 lockdep_print_held_locks(curr);
1752
Paul E. McKenney681fbec2017-05-04 15:44:38 -07001753 pr_warn("\nstack backtrace:\n");
Peter Zijlstra8e182572007-07-19 01:48:54 -07001754 dump_stack();
1755
1756 return 0;
1757}
1758
1759/*
1760 * Check whether we are holding such a class already.
1761 *
1762 * (Note that this has to be done separately, because the graph cannot
1763 * detect such classes of deadlocks.)
1764 *
1765 * Returns: 0 on deadlock detected, 1 on OK, 2 on recursive read
1766 */
1767static int
1768check_deadlock(struct task_struct *curr, struct held_lock *next,
1769 struct lockdep_map *next_instance, int read)
1770{
1771 struct held_lock *prev;
Peter Zijlstra7531e2f2008-08-11 09:30:24 +02001772 struct held_lock *nest = NULL;
Peter Zijlstra8e182572007-07-19 01:48:54 -07001773 int i;
1774
1775 for (i = 0; i < curr->lockdep_depth; i++) {
1776 prev = curr->held_locks + i;
Peter Zijlstra7531e2f2008-08-11 09:30:24 +02001777
1778 if (prev->instance == next->nest_lock)
1779 nest = prev;
1780
Dave Jonesf82b2172008-08-11 09:30:23 +02001781 if (hlock_class(prev) != hlock_class(next))
Peter Zijlstra8e182572007-07-19 01:48:54 -07001782 continue;
Peter Zijlstra7531e2f2008-08-11 09:30:24 +02001783
Peter Zijlstra8e182572007-07-19 01:48:54 -07001784 /*
1785 * Allow read-after-read recursion of the same
1786 * lock class (i.e. read_lock(lock)+read_lock(lock)):
1787 */
1788 if ((read == 2) && prev->read)
1789 return 2;
Peter Zijlstra7531e2f2008-08-11 09:30:24 +02001790
1791 /*
1792 * We're holding the nest_lock, which serializes this lock's
1793 * nesting behaviour.
1794 */
1795 if (nest)
1796 return 2;
1797
Peter Zijlstra8e182572007-07-19 01:48:54 -07001798 return print_deadlock_bug(curr, prev, next);
1799 }
1800 return 1;
1801}
1802
1803/*
1804 * There was a chain-cache miss, and we are about to add a new dependency
1805 * to a previous lock. We recursively validate the following rules:
1806 *
1807 * - would the adding of the <prev> -> <next> dependency create a
1808 * circular dependency in the graph? [== circular deadlock]
1809 *
1810 * - does the new prev->next dependency connect any hardirq-safe lock
1811 * (in the full backwards-subgraph starting at <prev>) with any
1812 * hardirq-unsafe lock (in the full forwards-subgraph starting at
1813 * <next>)? [== illegal lock inversion with hardirq contexts]
1814 *
1815 * - does the new prev->next dependency connect any softirq-safe lock
1816 * (in the full backwards-subgraph starting at <prev>) with any
1817 * softirq-unsafe lock (in the full forwards-subgraph starting at
1818 * <next>)? [== illegal lock inversion with softirq contexts]
1819 *
1820 * any of these scenarios could lead to a deadlock.
1821 *
1822 * Then if all the validations pass, we add the forwards and backwards
1823 * dependency.
1824 */
1825static int
1826check_prev_add(struct task_struct *curr, struct held_lock *prev,
Byungchul Parkce07a9412017-08-07 16:12:51 +09001827 struct held_lock *next, int distance, struct stack_trace *trace,
1828 int (*save)(struct stack_trace *trace))
Peter Zijlstra8e182572007-07-19 01:48:54 -07001829{
1830 struct lock_list *entry;
1831 int ret;
Ming Leidb0002a2009-07-16 15:44:29 +02001832 struct lock_list this;
1833 struct lock_list *uninitialized_var(target_entry);
Peter Zijlstra8e182572007-07-19 01:48:54 -07001834
1835 /*
1836 * Prove that the new <prev> -> <next> dependency would not
1837 * create a circular dependency in the graph. (We do this by
1838 * forward-recursing into the graph starting at <next>, and
1839 * checking whether we can reach <prev>.)
1840 *
1841 * We are using global variables to control the recursion, to
1842 * keep the stackframe size of the recursive functions low:
1843 */
Ming Leidb0002a2009-07-16 15:44:29 +02001844 this.class = hlock_class(next);
1845 this.parent = NULL;
1846 ret = check_noncircular(&this, hlock_class(prev), &target_entry);
1847 if (unlikely(!ret))
1848 return print_circular_bug(&this, target_entry, next, prev);
1849 else if (unlikely(ret < 0))
1850 return print_bfs_bug(ret);
Ming Leic94aa5c2009-07-16 15:44:29 +02001851
Peter Zijlstra8e182572007-07-19 01:48:54 -07001852 if (!check_prev_add_irq(curr, prev, next))
1853 return 0;
1854
1855 /*
1856 * For recursive read-locks we do all the dependency checks,
1857 * but we dont store read-triggered dependencies (only
1858 * write-triggered dependencies). This ensures that only the
1859 * write-side dependencies matter, and that if for example a
1860 * write-lock never takes any other locks, then the reads are
1861 * equivalent to a NOP.
1862 */
1863 if (next->read == 2 || prev->read == 2)
1864 return 1;
1865 /*
1866 * Is the <prev> -> <next> dependency already present?
1867 *
1868 * (this may occur even though this is a new chain: consider
1869 * e.g. the L1 -> L2 -> L3 -> L4 and the L5 -> L1 -> L2 -> L3
1870 * chains - the second one will be new, but L1 already has
1871 * L2 added to its dependency list, due to the first chain.)
1872 */
Dave Jonesf82b2172008-08-11 09:30:23 +02001873 list_for_each_entry(entry, &hlock_class(prev)->locks_after, entry) {
1874 if (entry->class == hlock_class(next)) {
Peter Zijlstra8e182572007-07-19 01:48:54 -07001875 if (distance == 1)
1876 entry->distance = 1;
Byungchul Park70911fd2017-08-07 16:12:50 +09001877 return 1;
Peter Zijlstra8e182572007-07-19 01:48:54 -07001878 }
1879 }
1880
Peter Zijlstraae813302017-03-03 10:13:38 +01001881 /*
1882 * Is the <prev> -> <next> link redundant?
1883 */
1884 this.class = hlock_class(prev);
1885 this.parent = NULL;
1886 ret = check_redundant(&this, hlock_class(next), &target_entry);
1887 if (!ret) {
1888 debug_atomic_inc(nr_redundant);
1889 return 2;
1890 }
1891 if (ret < 0)
1892 return print_bfs_bug(ret);
1893
1894
Byungchul Parkce07a9412017-08-07 16:12:51 +09001895 if (save && !save(trace))
1896 return 0;
Yong Zhang4726f2a2010-05-04 14:16:48 +08001897
Peter Zijlstra8e182572007-07-19 01:48:54 -07001898 /*
1899 * Ok, all validations passed, add the new lock
1900 * to the previous lock's dependency list:
1901 */
Tahsin Erdogan83f06162016-11-08 00:02:07 -08001902 ret = add_lock_to_list(hlock_class(next),
Dave Jonesf82b2172008-08-11 09:30:23 +02001903 &hlock_class(prev)->locks_after,
Byungchul Parkce07a9412017-08-07 16:12:51 +09001904 next->acquire_ip, distance, trace);
Peter Zijlstra8e182572007-07-19 01:48:54 -07001905
1906 if (!ret)
1907 return 0;
1908
Tahsin Erdogan83f06162016-11-08 00:02:07 -08001909 ret = add_lock_to_list(hlock_class(prev),
Dave Jonesf82b2172008-08-11 09:30:23 +02001910 &hlock_class(next)->locks_before,
Byungchul Parkce07a9412017-08-07 16:12:51 +09001911 next->acquire_ip, distance, trace);
Peter Zijlstra8e182572007-07-19 01:48:54 -07001912 if (!ret)
1913 return 0;
1914
1915 /*
1916 * Debugging printouts:
1917 */
Dave Jonesf82b2172008-08-11 09:30:23 +02001918 if (verbose(hlock_class(prev)) || verbose(hlock_class(next))) {
Peter Zijlstra8e182572007-07-19 01:48:54 -07001919 graph_unlock();
1920 printk("\n new dependency: ");
Dave Jonesf82b2172008-08-11 09:30:23 +02001921 print_lock_name(hlock_class(prev));
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01001922 printk(KERN_CONT " => ");
Dave Jonesf82b2172008-08-11 09:30:23 +02001923 print_lock_name(hlock_class(next));
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01001924 printk(KERN_CONT "\n");
Peter Zijlstra8e182572007-07-19 01:48:54 -07001925 dump_stack();
Byungchul Park70911fd2017-08-07 16:12:50 +09001926 if (!graph_lock())
1927 return 0;
Peter Zijlstra8e182572007-07-19 01:48:54 -07001928 }
Byungchul Park70911fd2017-08-07 16:12:50 +09001929 return 2;
Peter Zijlstra8e182572007-07-19 01:48:54 -07001930}
1931
1932/*
1933 * Add the dependency to all directly-previous locks that are 'relevant'.
1934 * The ones that are relevant are (in increasing distance from curr):
1935 * all consecutive trylock entries and the final non-trylock entry - or
1936 * the end of this context's lock-chain - whichever comes first.
1937 */
1938static int
1939check_prevs_add(struct task_struct *curr, struct held_lock *next)
1940{
1941 int depth = curr->lockdep_depth;
1942 struct held_lock *hlock;
Byungchul Parkce07a9412017-08-07 16:12:51 +09001943 struct stack_trace trace;
1944 int (*save)(struct stack_trace *trace) = save_trace;
Peter Zijlstra8e182572007-07-19 01:48:54 -07001945
1946 /*
1947 * Debugging checks.
1948 *
1949 * Depth must not be zero for a non-head lock:
1950 */
1951 if (!depth)
1952 goto out_bug;
1953 /*
1954 * At least two relevant locks must exist for this
1955 * to be a head:
1956 */
1957 if (curr->held_locks[depth].irq_context !=
1958 curr->held_locks[depth-1].irq_context)
1959 goto out_bug;
1960
1961 for (;;) {
1962 int distance = curr->lockdep_depth - depth + 1;
Oleg Nesterov1b5ff812014-01-20 19:20:10 +01001963 hlock = curr->held_locks + depth - 1;
Peter Zijlstra8e182572007-07-19 01:48:54 -07001964 /*
1965 * Only non-recursive-read entries get new dependencies
1966 * added:
1967 */
Oleg Nesterov1b5ff812014-01-20 19:20:10 +01001968 if (hlock->read != 2 && hlock->check) {
Byungchul Parkce07a9412017-08-07 16:12:51 +09001969 int ret = check_prev_add(curr, hlock, next,
1970 distance, &trace, save);
1971 if (!ret)
Peter Zijlstra8e182572007-07-19 01:48:54 -07001972 return 0;
Byungchul Parkce07a9412017-08-07 16:12:51 +09001973
1974 /*
1975 * Stop saving stack_trace if save_trace() was
1976 * called at least once:
1977 */
1978 if (save && ret == 2)
1979 save = NULL;
1980
Peter Zijlstra8e182572007-07-19 01:48:54 -07001981 /*
1982 * Stop after the first non-trylock entry,
1983 * as non-trylock entries have added their
1984 * own direct dependencies already, so this
1985 * lock is connected to them indirectly:
1986 */
1987 if (!hlock->trylock)
1988 break;
1989 }
1990 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: "
2343 "%016Lx tail class: [%p] %s\n",
2344 (unsigned long long)chain_key,
2345 class->key, class->name);
2346 }
2347
2348 return 0;
2349 }
2350
2351 if (very_verbose(class)) {
2352 printk("\nnew hash chain, key: %016Lx tail class: [%p] %s\n",
2353 (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);
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01002679 printk("hardirqs last enabled at (%u): [<%p>] %pS\n",
2680 curr->hardirq_enable_event, (void *)curr->hardirq_enable_ip,
2681 (void *)curr->hardirq_enable_ip);
2682 printk("hardirqs last disabled at (%u): [<%p>] %pS\n",
2683 curr->hardirq_disable_event, (void *)curr->hardirq_disable_ip,
2684 (void *)curr->hardirq_disable_ip);
2685 printk("softirqs last enabled at (%u): [<%p>] %pS\n",
2686 curr->softirq_enable_event, (void *)curr->softirq_enable_ip,
2687 (void *)curr->softirq_enable_ip);
2688 printk("softirqs last disabled at (%u): [<%p>] %pS\n",
2689 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 */
3179void 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
3184 kmemcheck_mark_initialized(lock, sizeof(*lock));
3185
3186 for (i = 0; i < NR_LOCKDEP_CACHING_CLASSES; i++)
3187 lock->class_cache[i] = NULL;
Hitoshi Mitake62016252010-10-05 18:01:51 +09003188
Peter Zijlstrac8a25002009-04-17 09:40:49 +02003189#ifdef CONFIG_LOCK_STAT
3190 lock->cpu = raw_smp_processor_id();
3191#endif
3192
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003193 /*
3194 * Can't be having no nameless bastards around this place!
3195 */
Peter Zijlstrac8a25002009-04-17 09:40:49 +02003196 if (DEBUG_LOCKS_WARN_ON(!name)) {
3197 lock->name = "NULL";
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003198 return;
Peter Zijlstrac8a25002009-04-17 09:40:49 +02003199 }
3200
3201 lock->name = name;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003202
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003203 /*
3204 * No key, no joy, we need to hash something.
3205 */
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003206 if (DEBUG_LOCKS_WARN_ON(!key))
3207 return;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003208 /*
3209 * Sanity check, the lock-class key must be persistent:
3210 */
3211 if (!static_obj(key)) {
3212 printk("BUG: key %p not in .data!\n", key);
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003213 /*
3214 * What it says above ^^^^^, I suggest you read it.
3215 */
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003216 DEBUG_LOCKS_WARN_ON(1);
3217 return;
3218 }
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003219 lock->key = key;
Peter Zijlstrac8a25002009-04-17 09:40:49 +02003220
3221 if (unlikely(!debug_locks))
3222 return;
3223
Peter Zijlstra35a93932015-02-26 16:23:11 +01003224 if (subclass) {
3225 unsigned long flags;
3226
3227 if (DEBUG_LOCKS_WARN_ON(current->lockdep_recursion))
3228 return;
3229
3230 raw_local_irq_save(flags);
3231 current->lockdep_recursion = 1;
Peter Zijlstra4dfbb9d2006-10-11 01:45:14 -04003232 register_lock_class(lock, subclass, 1);
Peter Zijlstra35a93932015-02-26 16:23:11 +01003233 current->lockdep_recursion = 0;
3234 raw_local_irq_restore(flags);
3235 }
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003236}
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003237EXPORT_SYMBOL_GPL(lockdep_init_map);
3238
Peter Zijlstra1704f472010-03-19 01:37:42 +01003239struct lock_class_key __lockdep_no_validate__;
Kent Overstreetea6749c2012-12-27 22:21:58 -08003240EXPORT_SYMBOL_GPL(__lockdep_no_validate__);
Peter Zijlstra1704f472010-03-19 01:37:42 +01003241
Maarten Lankhorstd0945952012-09-13 11:39:51 +02003242static int
3243print_lock_nested_lock_not_held(struct task_struct *curr,
3244 struct held_lock *hlock,
3245 unsigned long ip)
3246{
3247 if (!debug_locks_off())
3248 return 0;
3249 if (debug_locks_silent)
3250 return 0;
3251
Paul E. McKenney681fbec2017-05-04 15:44:38 -07003252 pr_warn("\n");
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08003253 pr_warn("==================================\n");
3254 pr_warn("WARNING: Nested lock was not taken\n");
Maarten Lankhorstd0945952012-09-13 11:39:51 +02003255 print_kernel_ident();
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08003256 pr_warn("----------------------------------\n");
Maarten Lankhorstd0945952012-09-13 11:39:51 +02003257
Paul E. McKenney681fbec2017-05-04 15:44:38 -07003258 pr_warn("%s/%d is trying to lock:\n", curr->comm, task_pid_nr(curr));
Maarten Lankhorstd0945952012-09-13 11:39:51 +02003259 print_lock(hlock);
3260
Paul E. McKenney681fbec2017-05-04 15:44:38 -07003261 pr_warn("\nbut this task is not holding:\n");
3262 pr_warn("%s\n", hlock->nest_lock->name);
Maarten Lankhorstd0945952012-09-13 11:39:51 +02003263
Paul E. McKenney681fbec2017-05-04 15:44:38 -07003264 pr_warn("\nstack backtrace:\n");
Maarten Lankhorstd0945952012-09-13 11:39:51 +02003265 dump_stack();
3266
Paul E. McKenney681fbec2017-05-04 15:44:38 -07003267 pr_warn("\nother info that might help us debug this:\n");
Maarten Lankhorstd0945952012-09-13 11:39:51 +02003268 lockdep_print_held_locks(curr);
3269
Paul E. McKenney681fbec2017-05-04 15:44:38 -07003270 pr_warn("\nstack backtrace:\n");
Maarten Lankhorstd0945952012-09-13 11:39:51 +02003271 dump_stack();
3272
3273 return 0;
3274}
3275
Peter Zijlstraf8319482016-11-30 14:32:25 +11003276static int __lock_is_held(struct lockdep_map *lock, int read);
Maarten Lankhorstd0945952012-09-13 11:39:51 +02003277
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003278/*
3279 * This gets called for every mutex_lock*()/spin_lock*() operation.
3280 * We maintain the dependency maps and validate the locking attempt:
3281 */
3282static int __lock_acquire(struct lockdep_map *lock, unsigned int subclass,
3283 int trylock, int read, int check, int hardirqs_off,
Peter Zijlstrabb97a912009-07-20 19:15:35 +02003284 struct lockdep_map *nest_lock, unsigned long ip,
Peter Zijlstra21199f22015-09-16 16:10:40 +02003285 int references, int pin_count)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003286{
3287 struct task_struct *curr = current;
Ingo Molnard6d897c2006-07-10 04:44:04 -07003288 struct lock_class *class = NULL;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003289 struct held_lock *hlock;
Alfredo Alvarez Fernandez5f18ab52016-02-11 00:33:32 +01003290 unsigned int depth;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003291 int chain_head = 0;
Peter Zijlstrabb97a912009-07-20 19:15:35 +02003292 int class_idx;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003293 u64 chain_key;
3294
3295 if (unlikely(!debug_locks))
3296 return 0;
3297
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003298 /*
3299 * Lockdep should run with IRQs disabled, otherwise we could
3300 * get an interrupt which would want to take locks, which would
3301 * end up in lockdep and have you got a head-ache already?
3302 */
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003303 if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
3304 return 0;
3305
Oleg Nesterovfb9edbe2014-01-20 19:20:06 +01003306 if (!prove_locking || lock->key == &__lockdep_no_validate__)
3307 check = 0;
Peter Zijlstra1704f472010-03-19 01:37:42 +01003308
Hitoshi Mitake62016252010-10-05 18:01:51 +09003309 if (subclass < NR_LOCKDEP_CACHING_CLASSES)
3310 class = lock->class_cache[subclass];
Ingo Molnard6d897c2006-07-10 04:44:04 -07003311 /*
Hitoshi Mitake62016252010-10-05 18:01:51 +09003312 * Not cached?
Ingo Molnard6d897c2006-07-10 04:44:04 -07003313 */
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003314 if (unlikely(!class)) {
Peter Zijlstra4dfbb9d2006-10-11 01:45:14 -04003315 class = register_lock_class(lock, subclass, 0);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003316 if (!class)
3317 return 0;
3318 }
Frederic Weisbeckerbd6d29c2010-04-06 00:10:17 +02003319 atomic_inc((atomic_t *)&class->ops);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003320 if (very_verbose(class)) {
3321 printk("\nacquire class [%p] %s", class->key, class->name);
3322 if (class->name_version > 1)
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01003323 printk(KERN_CONT "#%d", class->name_version);
3324 printk(KERN_CONT "\n");
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003325 dump_stack();
3326 }
3327
3328 /*
3329 * Add the lock to the list of currently held locks.
3330 * (we dont increase the depth just yet, up until the
3331 * dependency checks are done)
3332 */
3333 depth = curr->lockdep_depth;
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003334 /*
3335 * Ran out of static storage for our per-task lock stack again have we?
3336 */
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003337 if (DEBUG_LOCKS_WARN_ON(depth >= MAX_LOCK_DEPTH))
3338 return 0;
3339
Peter Zijlstrabb97a912009-07-20 19:15:35 +02003340 class_idx = class - lock_classes + 1;
3341
3342 if (depth) {
3343 hlock = curr->held_locks + depth - 1;
3344 if (hlock->class_idx == class_idx && nest_lock) {
Peter Zijlstra7fb4a2c2017-03-01 16:23:30 +01003345 if (hlock->references) {
3346 /*
3347 * Check: unsigned int references:12, overflow.
3348 */
3349 if (DEBUG_LOCKS_WARN_ON(hlock->references == (1 << 12)-1))
3350 return 0;
3351
Peter Zijlstrabb97a912009-07-20 19:15:35 +02003352 hlock->references++;
Peter Zijlstra7fb4a2c2017-03-01 16:23:30 +01003353 } else {
Peter Zijlstrabb97a912009-07-20 19:15:35 +02003354 hlock->references = 2;
Peter Zijlstra7fb4a2c2017-03-01 16:23:30 +01003355 }
Peter Zijlstrabb97a912009-07-20 19:15:35 +02003356
3357 return 1;
3358 }
3359 }
3360
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003361 hlock = curr->held_locks + depth;
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003362 /*
3363 * Plain impossible, we just registered it and checked it weren't no
3364 * NULL like.. I bet this mushroom I ate was good!
3365 */
Dave Jonesf82b2172008-08-11 09:30:23 +02003366 if (DEBUG_LOCKS_WARN_ON(!class))
3367 return 0;
Peter Zijlstrabb97a912009-07-20 19:15:35 +02003368 hlock->class_idx = class_idx;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003369 hlock->acquire_ip = ip;
3370 hlock->instance = lock;
Peter Zijlstra7531e2f2008-08-11 09:30:24 +02003371 hlock->nest_lock = nest_lock;
Boqun Fengc2469752016-02-16 13:57:40 +08003372 hlock->irq_context = task_irq_context(curr);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003373 hlock->trylock = trylock;
3374 hlock->read = read;
3375 hlock->check = check;
Dmitry Baryshkov6951b122008-08-18 04:26:37 +04003376 hlock->hardirqs_off = !!hardirqs_off;
Peter Zijlstrabb97a912009-07-20 19:15:35 +02003377 hlock->references = references;
Peter Zijlstraf20786f2007-07-19 01:48:56 -07003378#ifdef CONFIG_LOCK_STAT
3379 hlock->waittime_stamp = 0;
Peter Zijlstra3365e7792009-10-09 10:12:41 +02003380 hlock->holdtime_stamp = lockstat_clock();
Peter Zijlstraf20786f2007-07-19 01:48:56 -07003381#endif
Peter Zijlstra21199f22015-09-16 16:10:40 +02003382 hlock->pin_count = pin_count;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003383
Oleg Nesterovfb9edbe2014-01-20 19:20:06 +01003384 if (check && !mark_irqflags(curr, hlock))
Peter Zijlstra8e182572007-07-19 01:48:54 -07003385 return 0;
3386
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003387 /* mark it as used: */
Jarek Poplawski4ff773bb2007-05-08 00:31:00 -07003388 if (!mark_lock(curr, hlock, LOCK_USED))
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003389 return 0;
Peter Zijlstra8e182572007-07-19 01:48:54 -07003390
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003391 /*
Gautham R Shenoy17aacfb92007-10-28 20:47:01 +01003392 * Calculate the chain hash: it's the combined hash of all the
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003393 * lock keys along the dependency chain. We save the hash value
3394 * at every step so that we can get the current hash easily
3395 * after unlock. The chain hash is then used to cache dependency
3396 * results.
3397 *
3398 * The 'key ID' is what is the most compact key value to drive
3399 * the hash, not class->key.
3400 */
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003401 /*
3402 * Whoops, we did it again.. ran straight out of our static allocation.
3403 */
Alfredo Alvarez Fernandez5f18ab52016-02-11 00:33:32 +01003404 if (DEBUG_LOCKS_WARN_ON(class_idx > MAX_LOCKDEP_KEYS))
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003405 return 0;
3406
3407 chain_key = curr->curr_chain_key;
3408 if (!depth) {
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003409 /*
3410 * How can we have a chain hash when we ain't got no keys?!
3411 */
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003412 if (DEBUG_LOCKS_WARN_ON(chain_key != 0))
3413 return 0;
3414 chain_head = 1;
3415 }
3416
3417 hlock->prev_chain_key = chain_key;
Peter Zijlstra8e182572007-07-19 01:48:54 -07003418 if (separate_irq_context(curr, hlock)) {
3419 chain_key = 0;
3420 chain_head = 1;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003421 }
Alfredo Alvarez Fernandez5f18ab52016-02-11 00:33:32 +01003422 chain_key = iterate_chain_key(chain_key, class_idx);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003423
Peter Zijlstraf8319482016-11-30 14:32:25 +11003424 if (nest_lock && !__lock_is_held(nest_lock, -1))
Maarten Lankhorstd0945952012-09-13 11:39:51 +02003425 return print_lock_nested_lock_not_held(curr, hlock, ip);
3426
Gregory Haskins3aa416b2007-10-11 22:11:11 +02003427 if (!validate_chain(curr, lock, hlock, chain_head, chain_key))
Peter Zijlstra8e182572007-07-19 01:48:54 -07003428 return 0;
Jarek Poplawski381a2292007-02-10 01:44:58 -08003429
Gregory Haskins3aa416b2007-10-11 22:11:11 +02003430 curr->curr_chain_key = chain_key;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003431 curr->lockdep_depth++;
3432 check_chain_key(curr);
Jarek Poplawski60e114d2007-02-20 13:58:00 -08003433#ifdef CONFIG_DEBUG_LOCKDEP
3434 if (unlikely(!debug_locks))
3435 return 0;
3436#endif
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003437 if (unlikely(curr->lockdep_depth >= MAX_LOCK_DEPTH)) {
3438 debug_locks_off();
Dave Jones2c522832013-04-25 13:40:02 -04003439 print_lockdep_off("BUG: MAX_LOCK_DEPTH too low!");
3440 printk(KERN_DEBUG "depth: %i max: %lu!\n",
Ben Greearc0540602013-02-06 10:56:19 -08003441 curr->lockdep_depth, MAX_LOCK_DEPTH);
Ben Greearc0540602013-02-06 10:56:19 -08003442
3443 lockdep_print_held_locks(current);
3444 debug_show_all_locks();
Peter Zijlstraeedeeab2009-03-18 12:38:47 +01003445 dump_stack();
Ben Greearc0540602013-02-06 10:56:19 -08003446
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003447 return 0;
3448 }
Jarek Poplawski381a2292007-02-10 01:44:58 -08003449
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003450 if (unlikely(curr->lockdep_depth > max_lockdep_depth))
3451 max_lockdep_depth = curr->lockdep_depth;
3452
3453 return 1;
3454}
3455
3456static int
Srivatsa S. Bhatf86f7552013-01-08 18:35:58 +05303457print_unlock_imbalance_bug(struct task_struct *curr, struct lockdep_map *lock,
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003458 unsigned long ip)
3459{
3460 if (!debug_locks_off())
3461 return 0;
3462 if (debug_locks_silent)
3463 return 0;
3464
Paul E. McKenney681fbec2017-05-04 15:44:38 -07003465 pr_warn("\n");
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08003466 pr_warn("=====================================\n");
3467 pr_warn("WARNING: bad unlock balance detected!\n");
Ben Hutchingsfbdc4b92011-10-28 04:36:55 +01003468 print_kernel_ident();
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08003469 pr_warn("-------------------------------------\n");
Paul E. McKenney681fbec2017-05-04 15:44:38 -07003470 pr_warn("%s/%d is trying to release lock (",
Pavel Emelyanovba25f9d2007-10-18 23:40:40 -07003471 curr->comm, task_pid_nr(curr));
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003472 print_lockdep_cache(lock);
Paul E. McKenney681fbec2017-05-04 15:44:38 -07003473 pr_cont(") at:\n");
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003474 print_ip_sym(ip);
Paul E. McKenney681fbec2017-05-04 15:44:38 -07003475 pr_warn("but there are no more locks to release!\n");
3476 pr_warn("\nother info that might help us debug this:\n");
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003477 lockdep_print_held_locks(curr);
3478
Paul E. McKenney681fbec2017-05-04 15:44:38 -07003479 pr_warn("\nstack backtrace:\n");
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003480 dump_stack();
3481
3482 return 0;
3483}
3484
Peter Zijlstrabb97a912009-07-20 19:15:35 +02003485static int match_held_lock(struct held_lock *hlock, struct lockdep_map *lock)
3486{
3487 if (hlock->instance == lock)
3488 return 1;
3489
3490 if (hlock->references) {
Hitoshi Mitake62016252010-10-05 18:01:51 +09003491 struct lock_class *class = lock->class_cache[0];
Peter Zijlstrabb97a912009-07-20 19:15:35 +02003492
3493 if (!class)
3494 class = look_up_lock_class(lock, 0);
3495
Peter Zijlstra80e04012011-08-05 14:26:17 +02003496 /*
3497 * If look_up_lock_class() failed to find a class, we're trying
3498 * to test if we hold a lock that has never yet been acquired.
3499 * Clearly if the lock hasn't been acquired _ever_, we're not
3500 * holding it either, so report failure.
3501 */
Thomas Gleixner383776f2017-02-27 15:37:36 +01003502 if (IS_ERR_OR_NULL(class))
Peter Zijlstrabb97a912009-07-20 19:15:35 +02003503 return 0;
3504
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003505 /*
3506 * References, but not a lock we're actually ref-counting?
3507 * State got messed up, follow the sites that change ->references
3508 * and try to make sense of it.
3509 */
Peter Zijlstrabb97a912009-07-20 19:15:35 +02003510 if (DEBUG_LOCKS_WARN_ON(!hlock->nest_lock))
3511 return 0;
3512
3513 if (hlock->class_idx == class - lock_classes + 1)
3514 return 1;
3515 }
3516
3517 return 0;
3518}
3519
J. R. Okajima41c2c5b2017-02-03 01:38:15 +09003520/* @depth must not be zero */
3521static struct held_lock *find_held_lock(struct task_struct *curr,
3522 struct lockdep_map *lock,
3523 unsigned int depth, int *idx)
3524{
3525 struct held_lock *ret, *hlock, *prev_hlock;
3526 int i;
3527
3528 i = depth - 1;
3529 hlock = curr->held_locks + i;
3530 ret = hlock;
3531 if (match_held_lock(hlock, lock))
3532 goto out;
3533
3534 ret = NULL;
3535 for (i--, prev_hlock = hlock--;
3536 i >= 0;
3537 i--, prev_hlock = hlock--) {
3538 /*
3539 * We must not cross into another context:
3540 */
3541 if (prev_hlock->irq_context != hlock->irq_context) {
3542 ret = NULL;
3543 break;
3544 }
3545 if (match_held_lock(hlock, lock)) {
3546 ret = hlock;
3547 break;
3548 }
3549 }
3550
3551out:
3552 *idx = i;
3553 return ret;
3554}
3555
J. R. Okajimae9699702017-02-03 01:38:16 +09003556static int reacquire_held_locks(struct task_struct *curr, unsigned int depth,
3557 int idx)
3558{
3559 struct held_lock *hlock;
3560
3561 for (hlock = curr->held_locks + idx; idx < depth; idx++, hlock++) {
3562 if (!__lock_acquire(hlock->instance,
3563 hlock_class(hlock)->subclass,
3564 hlock->trylock,
3565 hlock->read, hlock->check,
3566 hlock->hardirqs_off,
3567 hlock->nest_lock, hlock->acquire_ip,
3568 hlock->references, hlock->pin_count))
3569 return 1;
3570 }
3571 return 0;
3572}
3573
Peter Zijlstra64aa3482008-08-11 09:30:21 +02003574static int
Peter Zijlstra00ef9f72008-12-04 09:00:17 +01003575__lock_set_class(struct lockdep_map *lock, const char *name,
3576 struct lock_class_key *key, unsigned int subclass,
3577 unsigned long ip)
Peter Zijlstra64aa3482008-08-11 09:30:21 +02003578{
3579 struct task_struct *curr = current;
J. R. Okajima41c2c5b2017-02-03 01:38:15 +09003580 struct held_lock *hlock;
Peter Zijlstra64aa3482008-08-11 09:30:21 +02003581 struct lock_class *class;
3582 unsigned int depth;
3583 int i;
3584
3585 depth = curr->lockdep_depth;
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003586 /*
3587 * This function is about (re)setting the class of a held lock,
3588 * yet we're not actually holding any locks. Naughty user!
3589 */
Peter Zijlstra64aa3482008-08-11 09:30:21 +02003590 if (DEBUG_LOCKS_WARN_ON(!depth))
3591 return 0;
3592
J. R. Okajima41c2c5b2017-02-03 01:38:15 +09003593 hlock = find_held_lock(curr, lock, depth, &i);
3594 if (!hlock)
3595 return print_unlock_imbalance_bug(curr, lock, ip);
Peter Zijlstra64aa3482008-08-11 09:30:21 +02003596
Peter Zijlstra00ef9f72008-12-04 09:00:17 +01003597 lockdep_init_map(lock, name, key, 0);
Peter Zijlstra64aa3482008-08-11 09:30:21 +02003598 class = register_lock_class(lock, subclass, 0);
Dave Jonesf82b2172008-08-11 09:30:23 +02003599 hlock->class_idx = class - lock_classes + 1;
Peter Zijlstra64aa3482008-08-11 09:30:21 +02003600
3601 curr->lockdep_depth = i;
3602 curr->curr_chain_key = hlock->prev_chain_key;
3603
J. R. Okajimae9699702017-02-03 01:38:16 +09003604 if (reacquire_held_locks(curr, depth, i))
3605 return 0;
Peter Zijlstra64aa3482008-08-11 09:30:21 +02003606
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003607 /*
3608 * I took it apart and put it back together again, except now I have
3609 * these 'spare' parts.. where shall I put them.
3610 */
Peter Zijlstra64aa3482008-08-11 09:30:21 +02003611 if (DEBUG_LOCKS_WARN_ON(curr->lockdep_depth != depth))
3612 return 0;
3613 return 1;
3614}
3615
J. R. Okajima6419c4a2017-02-03 01:38:17 +09003616static int __lock_downgrade(struct lockdep_map *lock, unsigned long ip)
3617{
3618 struct task_struct *curr = current;
3619 struct held_lock *hlock;
3620 unsigned int depth;
3621 int i;
3622
3623 depth = curr->lockdep_depth;
3624 /*
3625 * This function is about (re)setting the class of a held lock,
3626 * yet we're not actually holding any locks. Naughty user!
3627 */
3628 if (DEBUG_LOCKS_WARN_ON(!depth))
3629 return 0;
3630
3631 hlock = find_held_lock(curr, lock, depth, &i);
3632 if (!hlock)
3633 return print_unlock_imbalance_bug(curr, lock, ip);
3634
3635 curr->lockdep_depth = i;
3636 curr->curr_chain_key = hlock->prev_chain_key;
3637
3638 WARN(hlock->read, "downgrading a read lock");
3639 hlock->read = 1;
3640 hlock->acquire_ip = ip;
3641
3642 if (reacquire_held_locks(curr, depth, i))
3643 return 0;
3644
3645 /*
3646 * I took it apart and put it back together again, except now I have
3647 * these 'spare' parts.. where shall I put them.
3648 */
3649 if (DEBUG_LOCKS_WARN_ON(curr->lockdep_depth != depth))
3650 return 0;
3651 return 1;
3652}
3653
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003654/*
Peter Zijlstrae0f56fd2015-06-11 14:46:52 +02003655 * Remove the lock to the list of currently held locks - this gets
3656 * called on mutex_unlock()/spin_unlock*() (or on a failed
3657 * mutex_lock_interruptible()).
3658 *
3659 * @nested is an hysterical artifact, needs a tree wide cleanup.
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003660 */
3661static int
Peter Zijlstrae0f56fd2015-06-11 14:46:52 +02003662__lock_release(struct lockdep_map *lock, int nested, unsigned long ip)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003663{
Peter Zijlstrae0f56fd2015-06-11 14:46:52 +02003664 struct task_struct *curr = current;
J. R. Okajima41c2c5b2017-02-03 01:38:15 +09003665 struct held_lock *hlock;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003666 unsigned int depth;
3667 int i;
3668
Peter Zijlstrae0f56fd2015-06-11 14:46:52 +02003669 if (unlikely(!debug_locks))
3670 return 0;
3671
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003672 depth = curr->lockdep_depth;
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003673 /*
3674 * So we're all set to release this lock.. wait what lock? We don't
3675 * own any locks, you've been drinking again?
3676 */
Peter Zijlstrae0f56fd2015-06-11 14:46:52 +02003677 if (DEBUG_LOCKS_WARN_ON(depth <= 0))
3678 return print_unlock_imbalance_bug(curr, lock, ip);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003679
Peter Zijlstrae0f56fd2015-06-11 14:46:52 +02003680 /*
3681 * Check whether the lock exists in the current stack
3682 * of held locks:
3683 */
J. R. Okajima41c2c5b2017-02-03 01:38:15 +09003684 hlock = find_held_lock(curr, lock, depth, &i);
3685 if (!hlock)
3686 return print_unlock_imbalance_bug(curr, lock, ip);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003687
Peter Zijlstrabb97a912009-07-20 19:15:35 +02003688 if (hlock->instance == lock)
3689 lock_release_holdtime(hlock);
3690
Peter Zijlstraa24fc602015-06-11 14:46:53 +02003691 WARN(hlock->pin_count, "releasing a pinned lock\n");
3692
Peter Zijlstrabb97a912009-07-20 19:15:35 +02003693 if (hlock->references) {
3694 hlock->references--;
3695 if (hlock->references) {
3696 /*
3697 * We had, and after removing one, still have
3698 * references, the current lock stack is still
3699 * valid. We're done!
3700 */
3701 return 1;
3702 }
3703 }
Peter Zijlstraf20786f2007-07-19 01:48:56 -07003704
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003705 /*
3706 * We have the right lock to unlock, 'hlock' points to it.
3707 * Now we remove it from the stack, and add back the other
3708 * entries (if any), recalculating the hash along the way:
3709 */
Peter Zijlstrabb97a912009-07-20 19:15:35 +02003710
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003711 curr->lockdep_depth = i;
3712 curr->curr_chain_key = hlock->prev_chain_key;
3713
J. R. Okajimae9699702017-02-03 01:38:16 +09003714 if (reacquire_held_locks(curr, depth, i + 1))
3715 return 0;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003716
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003717 /*
3718 * We had N bottles of beer on the wall, we drank one, but now
3719 * there's not N-1 bottles of beer left on the wall...
3720 */
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003721 if (DEBUG_LOCKS_WARN_ON(curr->lockdep_depth != depth - 1))
3722 return 0;
Peter Zijlstrae0f56fd2015-06-11 14:46:52 +02003723
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003724 return 1;
3725}
3726
Peter Zijlstraf8319482016-11-30 14:32:25 +11003727static int __lock_is_held(struct lockdep_map *lock, int read)
Peter Zijlstraf607c662009-07-20 19:16:29 +02003728{
3729 struct task_struct *curr = current;
3730 int i;
3731
3732 for (i = 0; i < curr->lockdep_depth; i++) {
Peter Zijlstrabb97a912009-07-20 19:15:35 +02003733 struct held_lock *hlock = curr->held_locks + i;
3734
Peter Zijlstraf8319482016-11-30 14:32:25 +11003735 if (match_held_lock(hlock, lock)) {
3736 if (read == -1 || hlock->read == read)
3737 return 1;
3738
3739 return 0;
3740 }
Peter Zijlstraf607c662009-07-20 19:16:29 +02003741 }
3742
3743 return 0;
3744}
3745
Peter Zijlstrae7904a22015-08-01 19:25:08 +02003746static struct pin_cookie __lock_pin_lock(struct lockdep_map *lock)
3747{
3748 struct pin_cookie cookie = NIL_COOKIE;
3749 struct task_struct *curr = current;
3750 int i;
3751
3752 if (unlikely(!debug_locks))
3753 return cookie;
3754
3755 for (i = 0; i < curr->lockdep_depth; i++) {
3756 struct held_lock *hlock = curr->held_locks + i;
3757
3758 if (match_held_lock(hlock, lock)) {
3759 /*
3760 * Grab 16bits of randomness; this is sufficient to not
3761 * be guessable and still allows some pin nesting in
3762 * our u32 pin_count.
3763 */
3764 cookie.val = 1 + (prandom_u32() >> 16);
3765 hlock->pin_count += cookie.val;
3766 return cookie;
3767 }
3768 }
3769
3770 WARN(1, "pinning an unheld lock\n");
3771 return cookie;
3772}
3773
3774static void __lock_repin_lock(struct lockdep_map *lock, struct pin_cookie cookie)
Peter Zijlstraa24fc602015-06-11 14:46:53 +02003775{
3776 struct task_struct *curr = current;
3777 int i;
3778
3779 if (unlikely(!debug_locks))
3780 return;
3781
3782 for (i = 0; i < curr->lockdep_depth; i++) {
3783 struct held_lock *hlock = curr->held_locks + i;
3784
3785 if (match_held_lock(hlock, lock)) {
Peter Zijlstrae7904a22015-08-01 19:25:08 +02003786 hlock->pin_count += cookie.val;
Peter Zijlstraa24fc602015-06-11 14:46:53 +02003787 return;
3788 }
3789 }
3790
3791 WARN(1, "pinning an unheld lock\n");
3792}
3793
Peter Zijlstrae7904a22015-08-01 19:25:08 +02003794static void __lock_unpin_lock(struct lockdep_map *lock, struct pin_cookie cookie)
Peter Zijlstraa24fc602015-06-11 14:46:53 +02003795{
3796 struct task_struct *curr = current;
3797 int i;
3798
3799 if (unlikely(!debug_locks))
3800 return;
3801
3802 for (i = 0; i < curr->lockdep_depth; i++) {
3803 struct held_lock *hlock = curr->held_locks + i;
3804
3805 if (match_held_lock(hlock, lock)) {
3806 if (WARN(!hlock->pin_count, "unpinning an unpinned lock\n"))
3807 return;
3808
Peter Zijlstrae7904a22015-08-01 19:25:08 +02003809 hlock->pin_count -= cookie.val;
3810
3811 if (WARN((int)hlock->pin_count < 0, "pin count corrupted\n"))
3812 hlock->pin_count = 0;
3813
Peter Zijlstraa24fc602015-06-11 14:46:53 +02003814 return;
3815 }
3816 }
3817
3818 WARN(1, "unpinning an unheld lock\n");
3819}
3820
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003821/*
3822 * Check whether we follow the irq-flags state precisely:
3823 */
Steven Rostedt1d09daa2008-05-12 21:20:55 +02003824static void check_flags(unsigned long flags)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003825{
Ingo Molnar992860e2008-07-14 10:28:38 +02003826#if defined(CONFIG_PROVE_LOCKING) && defined(CONFIG_DEBUG_LOCKDEP) && \
3827 defined(CONFIG_TRACE_IRQFLAGS)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003828 if (!debug_locks)
3829 return;
3830
Ingo Molnar5f9fa8a2007-12-07 19:02:47 +01003831 if (irqs_disabled_flags(flags)) {
3832 if (DEBUG_LOCKS_WARN_ON(current->hardirqs_enabled)) {
3833 printk("possible reason: unannotated irqs-off.\n");
3834 }
3835 } else {
3836 if (DEBUG_LOCKS_WARN_ON(!current->hardirqs_enabled)) {
3837 printk("possible reason: unannotated irqs-on.\n");
3838 }
3839 }
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003840
3841 /*
3842 * We dont accurately track softirq state in e.g.
3843 * hardirq contexts (such as on 4KSTACKS), so only
3844 * check if not in hardirq contexts:
3845 */
3846 if (!hardirq_count()) {
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003847 if (softirq_count()) {
3848 /* like the above, but with softirqs */
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003849 DEBUG_LOCKS_WARN_ON(current->softirqs_enabled);
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003850 } else {
3851 /* lick the above, does it taste good? */
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003852 DEBUG_LOCKS_WARN_ON(!current->softirqs_enabled);
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003853 }
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003854 }
3855
3856 if (!debug_locks)
3857 print_irqtrace_events(current);
3858#endif
3859}
3860
Peter Zijlstra00ef9f72008-12-04 09:00:17 +01003861void lock_set_class(struct lockdep_map *lock, const char *name,
3862 struct lock_class_key *key, unsigned int subclass,
3863 unsigned long ip)
Peter Zijlstra64aa3482008-08-11 09:30:21 +02003864{
3865 unsigned long flags;
3866
3867 if (unlikely(current->lockdep_recursion))
3868 return;
3869
3870 raw_local_irq_save(flags);
3871 current->lockdep_recursion = 1;
3872 check_flags(flags);
Peter Zijlstra00ef9f72008-12-04 09:00:17 +01003873 if (__lock_set_class(lock, name, key, subclass, ip))
Peter Zijlstra64aa3482008-08-11 09:30:21 +02003874 check_chain_key(current);
3875 current->lockdep_recursion = 0;
3876 raw_local_irq_restore(flags);
3877}
Peter Zijlstra00ef9f72008-12-04 09:00:17 +01003878EXPORT_SYMBOL_GPL(lock_set_class);
Peter Zijlstra64aa3482008-08-11 09:30:21 +02003879
J. R. Okajima6419c4a2017-02-03 01:38:17 +09003880void lock_downgrade(struct lockdep_map *lock, unsigned long ip)
3881{
3882 unsigned long flags;
3883
3884 if (unlikely(current->lockdep_recursion))
3885 return;
3886
3887 raw_local_irq_save(flags);
3888 current->lockdep_recursion = 1;
3889 check_flags(flags);
3890 if (__lock_downgrade(lock, ip))
3891 check_chain_key(current);
3892 current->lockdep_recursion = 0;
3893 raw_local_irq_restore(flags);
3894}
3895EXPORT_SYMBOL_GPL(lock_downgrade);
3896
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003897/*
3898 * We are not always called with irqs disabled - do that here,
3899 * and also avoid lockdep recursion:
3900 */
Steven Rostedt1d09daa2008-05-12 21:20:55 +02003901void lock_acquire(struct lockdep_map *lock, unsigned int subclass,
Peter Zijlstra7531e2f2008-08-11 09:30:24 +02003902 int trylock, int read, int check,
3903 struct lockdep_map *nest_lock, unsigned long ip)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003904{
3905 unsigned long flags;
3906
3907 if (unlikely(current->lockdep_recursion))
3908 return;
3909
3910 raw_local_irq_save(flags);
3911 check_flags(flags);
3912
3913 current->lockdep_recursion = 1;
Frederic Weisbeckerdb2c4c72010-02-02 23:34:40 +01003914 trace_lock_acquire(lock, subclass, trylock, read, check, nest_lock, ip);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003915 __lock_acquire(lock, subclass, trylock, read, check,
Peter Zijlstra21199f22015-09-16 16:10:40 +02003916 irqs_disabled_flags(flags), nest_lock, ip, 0, 0);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003917 current->lockdep_recursion = 0;
3918 raw_local_irq_restore(flags);
3919}
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003920EXPORT_SYMBOL_GPL(lock_acquire);
3921
Steven Rostedt1d09daa2008-05-12 21:20:55 +02003922void lock_release(struct lockdep_map *lock, int nested,
Steven Rostedt0764d232008-05-12 21:20:44 +02003923 unsigned long ip)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003924{
3925 unsigned long flags;
3926
3927 if (unlikely(current->lockdep_recursion))
3928 return;
3929
3930 raw_local_irq_save(flags);
3931 check_flags(flags);
3932 current->lockdep_recursion = 1;
Frederic Weisbecker93135432010-05-08 06:24:25 +02003933 trace_lock_release(lock, ip);
Peter Zijlstrae0f56fd2015-06-11 14:46:52 +02003934 if (__lock_release(lock, nested, ip))
3935 check_chain_key(current);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003936 current->lockdep_recursion = 0;
3937 raw_local_irq_restore(flags);
3938}
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003939EXPORT_SYMBOL_GPL(lock_release);
3940
Peter Zijlstraf8319482016-11-30 14:32:25 +11003941int lock_is_held_type(struct lockdep_map *lock, int read)
Peter Zijlstraf607c662009-07-20 19:16:29 +02003942{
3943 unsigned long flags;
3944 int ret = 0;
3945
3946 if (unlikely(current->lockdep_recursion))
Peter Zijlstraf2513cd2011-06-06 12:32:43 +02003947 return 1; /* avoid false negative lockdep_assert_held() */
Peter Zijlstraf607c662009-07-20 19:16:29 +02003948
3949 raw_local_irq_save(flags);
3950 check_flags(flags);
3951
3952 current->lockdep_recursion = 1;
Peter Zijlstraf8319482016-11-30 14:32:25 +11003953 ret = __lock_is_held(lock, read);
Peter Zijlstraf607c662009-07-20 19:16:29 +02003954 current->lockdep_recursion = 0;
3955 raw_local_irq_restore(flags);
3956
3957 return ret;
3958}
Peter Zijlstraf8319482016-11-30 14:32:25 +11003959EXPORT_SYMBOL_GPL(lock_is_held_type);
Peter Zijlstraf607c662009-07-20 19:16:29 +02003960
Peter Zijlstrae7904a22015-08-01 19:25:08 +02003961struct pin_cookie lock_pin_lock(struct lockdep_map *lock)
Peter Zijlstraa24fc602015-06-11 14:46:53 +02003962{
Peter Zijlstrae7904a22015-08-01 19:25:08 +02003963 struct pin_cookie cookie = NIL_COOKIE;
Peter Zijlstraa24fc602015-06-11 14:46:53 +02003964 unsigned long flags;
3965
3966 if (unlikely(current->lockdep_recursion))
Peter Zijlstrae7904a22015-08-01 19:25:08 +02003967 return cookie;
Peter Zijlstraa24fc602015-06-11 14:46:53 +02003968
3969 raw_local_irq_save(flags);
3970 check_flags(flags);
3971
3972 current->lockdep_recursion = 1;
Peter Zijlstrae7904a22015-08-01 19:25:08 +02003973 cookie = __lock_pin_lock(lock);
Peter Zijlstraa24fc602015-06-11 14:46:53 +02003974 current->lockdep_recursion = 0;
3975 raw_local_irq_restore(flags);
Peter Zijlstrae7904a22015-08-01 19:25:08 +02003976
3977 return cookie;
Peter Zijlstraa24fc602015-06-11 14:46:53 +02003978}
3979EXPORT_SYMBOL_GPL(lock_pin_lock);
3980
Peter Zijlstrae7904a22015-08-01 19:25:08 +02003981void lock_repin_lock(struct lockdep_map *lock, struct pin_cookie cookie)
Peter Zijlstraa24fc602015-06-11 14:46:53 +02003982{
3983 unsigned long flags;
3984
3985 if (unlikely(current->lockdep_recursion))
3986 return;
3987
3988 raw_local_irq_save(flags);
3989 check_flags(flags);
3990
3991 current->lockdep_recursion = 1;
Peter Zijlstrae7904a22015-08-01 19:25:08 +02003992 __lock_repin_lock(lock, cookie);
3993 current->lockdep_recursion = 0;
3994 raw_local_irq_restore(flags);
3995}
3996EXPORT_SYMBOL_GPL(lock_repin_lock);
3997
3998void lock_unpin_lock(struct lockdep_map *lock, struct pin_cookie cookie)
3999{
4000 unsigned long flags;
4001
4002 if (unlikely(current->lockdep_recursion))
4003 return;
4004
4005 raw_local_irq_save(flags);
4006 check_flags(flags);
4007
4008 current->lockdep_recursion = 1;
4009 __lock_unpin_lock(lock, cookie);
Peter Zijlstraa24fc602015-06-11 14:46:53 +02004010 current->lockdep_recursion = 0;
4011 raw_local_irq_restore(flags);
4012}
4013EXPORT_SYMBOL_GPL(lock_unpin_lock);
4014
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004015#ifdef CONFIG_LOCK_STAT
4016static int
4017print_lock_contention_bug(struct task_struct *curr, struct lockdep_map *lock,
4018 unsigned long ip)
4019{
4020 if (!debug_locks_off())
4021 return 0;
4022 if (debug_locks_silent)
4023 return 0;
4024
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004025 pr_warn("\n");
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08004026 pr_warn("=================================\n");
4027 pr_warn("WARNING: bad contention detected!\n");
Ben Hutchingsfbdc4b92011-10-28 04:36:55 +01004028 print_kernel_ident();
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08004029 pr_warn("---------------------------------\n");
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004030 pr_warn("%s/%d is trying to contend lock (",
Pavel Emelyanovba25f9d2007-10-18 23:40:40 -07004031 curr->comm, task_pid_nr(curr));
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004032 print_lockdep_cache(lock);
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004033 pr_cont(") at:\n");
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004034 print_ip_sym(ip);
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004035 pr_warn("but there are no locks held!\n");
4036 pr_warn("\nother info that might help us debug this:\n");
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004037 lockdep_print_held_locks(curr);
4038
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004039 pr_warn("\nstack backtrace:\n");
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004040 dump_stack();
4041
4042 return 0;
4043}
4044
4045static void
4046__lock_contended(struct lockdep_map *lock, unsigned long ip)
4047{
4048 struct task_struct *curr = current;
J. R. Okajima41c2c5b2017-02-03 01:38:15 +09004049 struct held_lock *hlock;
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004050 struct lock_class_stats *stats;
4051 unsigned int depth;
Peter Zijlstrac7e78cf2008-10-16 23:17:09 +02004052 int i, contention_point, contending_point;
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004053
4054 depth = curr->lockdep_depth;
Peter Zijlstra0119fee2011-09-02 01:30:29 +02004055 /*
4056 * Whee, we contended on this lock, except it seems we're not
4057 * actually trying to acquire anything much at all..
4058 */
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004059 if (DEBUG_LOCKS_WARN_ON(!depth))
4060 return;
4061
J. R. Okajima41c2c5b2017-02-03 01:38:15 +09004062 hlock = find_held_lock(curr, lock, depth, &i);
4063 if (!hlock) {
4064 print_lock_contention_bug(curr, lock, ip);
4065 return;
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004066 }
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004067
Peter Zijlstrabb97a912009-07-20 19:15:35 +02004068 if (hlock->instance != lock)
4069 return;
4070
Peter Zijlstra3365e7792009-10-09 10:12:41 +02004071 hlock->waittime_stamp = lockstat_clock();
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004072
Peter Zijlstrac7e78cf2008-10-16 23:17:09 +02004073 contention_point = lock_point(hlock_class(hlock)->contention_point, ip);
4074 contending_point = lock_point(hlock_class(hlock)->contending_point,
4075 lock->ip);
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004076
Dave Jonesf82b2172008-08-11 09:30:23 +02004077 stats = get_lock_stats(hlock_class(hlock));
Peter Zijlstrac7e78cf2008-10-16 23:17:09 +02004078 if (contention_point < LOCKSTAT_POINTS)
4079 stats->contention_point[contention_point]++;
4080 if (contending_point < LOCKSTAT_POINTS)
4081 stats->contending_point[contending_point]++;
Peter Zijlstra96645672007-07-19 01:49:00 -07004082 if (lock->cpu != smp_processor_id())
4083 stats->bounces[bounce_contended + !!hlock->read]++;
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004084 put_lock_stats(stats);
4085}
4086
4087static void
Peter Zijlstrac7e78cf2008-10-16 23:17:09 +02004088__lock_acquired(struct lockdep_map *lock, unsigned long ip)
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004089{
4090 struct task_struct *curr = current;
J. R. Okajima41c2c5b2017-02-03 01:38:15 +09004091 struct held_lock *hlock;
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004092 struct lock_class_stats *stats;
4093 unsigned int depth;
Peter Zijlstra3365e7792009-10-09 10:12:41 +02004094 u64 now, waittime = 0;
Peter Zijlstra96645672007-07-19 01:49:00 -07004095 int i, cpu;
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004096
4097 depth = curr->lockdep_depth;
Peter Zijlstra0119fee2011-09-02 01:30:29 +02004098 /*
4099 * Yay, we acquired ownership of this lock we didn't try to
4100 * acquire, how the heck did that happen?
4101 */
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004102 if (DEBUG_LOCKS_WARN_ON(!depth))
4103 return;
4104
J. R. Okajima41c2c5b2017-02-03 01:38:15 +09004105 hlock = find_held_lock(curr, lock, depth, &i);
4106 if (!hlock) {
4107 print_lock_contention_bug(curr, lock, _RET_IP_);
4108 return;
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004109 }
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004110
Peter Zijlstrabb97a912009-07-20 19:15:35 +02004111 if (hlock->instance != lock)
4112 return;
4113
Peter Zijlstra96645672007-07-19 01:49:00 -07004114 cpu = smp_processor_id();
4115 if (hlock->waittime_stamp) {
Peter Zijlstra3365e7792009-10-09 10:12:41 +02004116 now = lockstat_clock();
Peter Zijlstra96645672007-07-19 01:49:00 -07004117 waittime = now - hlock->waittime_stamp;
4118 hlock->holdtime_stamp = now;
4119 }
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004120
Frederic Weisbecker883a2a32010-05-08 06:16:11 +02004121 trace_lock_acquired(lock, ip);
Frederic Weisbecker20625012009-04-06 01:49:33 +02004122
Dave Jonesf82b2172008-08-11 09:30:23 +02004123 stats = get_lock_stats(hlock_class(hlock));
Peter Zijlstra96645672007-07-19 01:49:00 -07004124 if (waittime) {
4125 if (hlock->read)
4126 lock_time_inc(&stats->read_waittime, waittime);
4127 else
4128 lock_time_inc(&stats->write_waittime, waittime);
4129 }
4130 if (lock->cpu != cpu)
4131 stats->bounces[bounce_acquired + !!hlock->read]++;
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004132 put_lock_stats(stats);
Peter Zijlstra96645672007-07-19 01:49:00 -07004133
4134 lock->cpu = cpu;
Peter Zijlstrac7e78cf2008-10-16 23:17:09 +02004135 lock->ip = ip;
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004136}
4137
4138void lock_contended(struct lockdep_map *lock, unsigned long ip)
4139{
4140 unsigned long flags;
4141
4142 if (unlikely(!lock_stat))
4143 return;
4144
4145 if (unlikely(current->lockdep_recursion))
4146 return;
4147
4148 raw_local_irq_save(flags);
4149 check_flags(flags);
4150 current->lockdep_recursion = 1;
Frederic Weisbeckerdb2c4c72010-02-02 23:34:40 +01004151 trace_lock_contended(lock, ip);
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004152 __lock_contended(lock, ip);
4153 current->lockdep_recursion = 0;
4154 raw_local_irq_restore(flags);
4155}
4156EXPORT_SYMBOL_GPL(lock_contended);
4157
Peter Zijlstrac7e78cf2008-10-16 23:17:09 +02004158void lock_acquired(struct lockdep_map *lock, unsigned long ip)
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004159{
4160 unsigned long flags;
4161
4162 if (unlikely(!lock_stat))
4163 return;
4164
4165 if (unlikely(current->lockdep_recursion))
4166 return;
4167
4168 raw_local_irq_save(flags);
4169 check_flags(flags);
4170 current->lockdep_recursion = 1;
Peter Zijlstrac7e78cf2008-10-16 23:17:09 +02004171 __lock_acquired(lock, ip);
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004172 current->lockdep_recursion = 0;
4173 raw_local_irq_restore(flags);
4174}
4175EXPORT_SYMBOL_GPL(lock_acquired);
4176#endif
4177
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004178/*
4179 * Used by the testsuite, sanitize the validator state
4180 * after a simulated failure:
4181 */
4182
4183void lockdep_reset(void)
4184{
4185 unsigned long flags;
Ingo Molnar23d95a02006-12-13 00:34:40 -08004186 int i;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004187
4188 raw_local_irq_save(flags);
4189 current->curr_chain_key = 0;
4190 current->lockdep_depth = 0;
4191 current->lockdep_recursion = 0;
4192 memset(current->held_locks, 0, MAX_LOCK_DEPTH*sizeof(struct held_lock));
4193 nr_hardirq_chains = 0;
4194 nr_softirq_chains = 0;
4195 nr_process_chains = 0;
4196 debug_locks = 1;
Ingo Molnar23d95a02006-12-13 00:34:40 -08004197 for (i = 0; i < CHAINHASH_SIZE; i++)
Andrew Mortona63f38c2016-02-03 13:44:12 -08004198 INIT_HLIST_HEAD(chainhash_table + i);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004199 raw_local_irq_restore(flags);
4200}
4201
4202static void zap_class(struct lock_class *class)
4203{
4204 int i;
4205
4206 /*
4207 * Remove all dependencies this lock is
4208 * involved in:
4209 */
4210 for (i = 0; i < nr_list_entries; i++) {
4211 if (list_entries[i].class == class)
4212 list_del_rcu(&list_entries[i].entry);
4213 }
4214 /*
4215 * Unhash the class and remove it from the all_lock_classes list:
4216 */
Andrew Mortona63f38c2016-02-03 13:44:12 -08004217 hlist_del_rcu(&class->hash_entry);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004218 list_del_rcu(&class->lock_entry);
4219
Peter Zijlstracee34d82015-06-02 12:50:13 +02004220 RCU_INIT_POINTER(class->key, NULL);
4221 RCU_INIT_POINTER(class->name, NULL);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004222}
4223
Arjan van de Venfabe8742008-01-24 07:00:45 +01004224static inline int within(const void *addr, void *start, unsigned long size)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004225{
4226 return addr >= start && addr < start + size;
4227}
4228
Peter Zijlstra35a93932015-02-26 16:23:11 +01004229/*
4230 * Used in module.c to remove lock classes from memory that is going to be
4231 * freed; and possibly re-used by other modules.
4232 *
4233 * We will have had one sync_sched() before getting here, so we're guaranteed
4234 * nobody will look up these exact classes -- they're properly dead but still
4235 * allocated.
4236 */
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004237void lockdep_free_key_range(void *start, unsigned long size)
4238{
Peter Zijlstra35a93932015-02-26 16:23:11 +01004239 struct lock_class *class;
Andrew Mortona63f38c2016-02-03 13:44:12 -08004240 struct hlist_head *head;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004241 unsigned long flags;
4242 int i;
Nick Piggin5a26db52008-01-16 09:51:58 +01004243 int locked;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004244
4245 raw_local_irq_save(flags);
Nick Piggin5a26db52008-01-16 09:51:58 +01004246 locked = graph_lock();
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004247
4248 /*
4249 * Unhash all classes that were created by this module:
4250 */
4251 for (i = 0; i < CLASSHASH_SIZE; i++) {
4252 head = classhash_table + i;
Andrew Mortona63f38c2016-02-03 13:44:12 -08004253 hlist_for_each_entry_rcu(class, head, hash_entry) {
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004254 if (within(class->key, start, size))
4255 zap_class(class);
Arjan van de Venfabe8742008-01-24 07:00:45 +01004256 else if (within(class->name, start, size))
4257 zap_class(class);
4258 }
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004259 }
4260
Nick Piggin5a26db52008-01-16 09:51:58 +01004261 if (locked)
4262 graph_unlock();
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004263 raw_local_irq_restore(flags);
Peter Zijlstra35a93932015-02-26 16:23:11 +01004264
4265 /*
4266 * Wait for any possible iterators from look_up_lock_class() to pass
4267 * before continuing to free the memory they refer to.
4268 *
4269 * sync_sched() is sufficient because the read-side is IRQ disable.
4270 */
4271 synchronize_sched();
4272
4273 /*
4274 * XXX at this point we could return the resources to the pool;
4275 * instead we leak them. We would need to change to bitmap allocators
4276 * instead of the linear allocators we have now.
4277 */
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004278}
4279
4280void lockdep_reset_lock(struct lockdep_map *lock)
4281{
Peter Zijlstra35a93932015-02-26 16:23:11 +01004282 struct lock_class *class;
Andrew Mortona63f38c2016-02-03 13:44:12 -08004283 struct hlist_head *head;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004284 unsigned long flags;
4285 int i, j;
Nick Piggin5a26db52008-01-16 09:51:58 +01004286 int locked;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004287
4288 raw_local_irq_save(flags);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004289
4290 /*
Ingo Molnard6d897c2006-07-10 04:44:04 -07004291 * Remove all classes this lock might have:
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004292 */
Ingo Molnard6d897c2006-07-10 04:44:04 -07004293 for (j = 0; j < MAX_LOCKDEP_SUBCLASSES; j++) {
4294 /*
4295 * If the class exists we look it up and zap it:
4296 */
4297 class = look_up_lock_class(lock, j);
Thomas Gleixner383776f2017-02-27 15:37:36 +01004298 if (!IS_ERR_OR_NULL(class))
Ingo Molnard6d897c2006-07-10 04:44:04 -07004299 zap_class(class);
4300 }
4301 /*
4302 * Debug check: in the end all mapped classes should
4303 * be gone.
4304 */
Nick Piggin5a26db52008-01-16 09:51:58 +01004305 locked = graph_lock();
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004306 for (i = 0; i < CLASSHASH_SIZE; i++) {
4307 head = classhash_table + i;
Andrew Mortona63f38c2016-02-03 13:44:12 -08004308 hlist_for_each_entry_rcu(class, head, hash_entry) {
Hitoshi Mitake62016252010-10-05 18:01:51 +09004309 int match = 0;
4310
4311 for (j = 0; j < NR_LOCKDEP_CACHING_CLASSES; j++)
4312 match |= class == lock->class_cache[j];
4313
4314 if (unlikely(match)) {
Peter Zijlstra0119fee2011-09-02 01:30:29 +02004315 if (debug_locks_off_graph_unlock()) {
4316 /*
4317 * We all just reset everything, how did it match?
4318 */
Ingo Molnar74c383f2006-12-13 00:34:43 -08004319 WARN_ON(1);
Peter Zijlstra0119fee2011-09-02 01:30:29 +02004320 }
Ingo Molnard6d897c2006-07-10 04:44:04 -07004321 goto out_restore;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004322 }
4323 }
4324 }
Nick Piggin5a26db52008-01-16 09:51:58 +01004325 if (locked)
4326 graph_unlock();
Ingo Molnard6d897c2006-07-10 04:44:04 -07004327
4328out_restore:
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004329 raw_local_irq_restore(flags);
4330}
4331
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004332void __init lockdep_info(void)
4333{
4334 printk("Lock dependency validator: Copyright (c) 2006 Red Hat, Inc., Ingo Molnar\n");
4335
Li Zefanb0788ca2008-11-21 15:57:32 +08004336 printk("... MAX_LOCKDEP_SUBCLASSES: %lu\n", MAX_LOCKDEP_SUBCLASSES);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004337 printk("... MAX_LOCK_DEPTH: %lu\n", MAX_LOCK_DEPTH);
4338 printk("... MAX_LOCKDEP_KEYS: %lu\n", MAX_LOCKDEP_KEYS);
Li Zefanb0788ca2008-11-21 15:57:32 +08004339 printk("... CLASSHASH_SIZE: %lu\n", CLASSHASH_SIZE);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004340 printk("... MAX_LOCKDEP_ENTRIES: %lu\n", MAX_LOCKDEP_ENTRIES);
4341 printk("... MAX_LOCKDEP_CHAINS: %lu\n", MAX_LOCKDEP_CHAINS);
4342 printk("... CHAINHASH_SIZE: %lu\n", CHAINHASH_SIZE);
4343
4344 printk(" memory used by lock dependency info: %lu kB\n",
4345 (sizeof(struct lock_class) * MAX_LOCKDEP_KEYS +
4346 sizeof(struct list_head) * CLASSHASH_SIZE +
4347 sizeof(struct lock_list) * MAX_LOCKDEP_ENTRIES +
4348 sizeof(struct lock_chain) * MAX_LOCKDEP_CHAINS +
Ming Lei906292092009-08-02 21:43:36 +08004349 sizeof(struct list_head) * CHAINHASH_SIZE
Ming Lei4dd861d2009-07-16 15:44:29 +02004350#ifdef CONFIG_PROVE_LOCKING
Ming Leie351b662009-07-22 22:48:09 +08004351 + sizeof(struct circular_queue)
Ming Lei4dd861d2009-07-16 15:44:29 +02004352#endif
Ming Lei906292092009-08-02 21:43:36 +08004353 ) / 1024
Ming Lei4dd861d2009-07-16 15:44:29 +02004354 );
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004355
4356 printk(" per task-struct memory footprint: %lu bytes\n",
4357 sizeof(struct held_lock) * MAX_LOCK_DEPTH);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004358}
4359
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004360static void
4361print_freed_lock_bug(struct task_struct *curr, const void *mem_from,
Arjan van de Ven55794a42006-07-10 04:44:03 -07004362 const void *mem_to, struct held_lock *hlock)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004363{
4364 if (!debug_locks_off())
4365 return;
4366 if (debug_locks_silent)
4367 return;
4368
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004369 pr_warn("\n");
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08004370 pr_warn("=========================\n");
4371 pr_warn("WARNING: held lock freed!\n");
Ben Hutchingsfbdc4b92011-10-28 04:36:55 +01004372 print_kernel_ident();
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08004373 pr_warn("-------------------------\n");
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004374 pr_warn("%s/%d is freeing memory %p-%p, with a lock still held there!\n",
Pavel Emelyanovba25f9d2007-10-18 23:40:40 -07004375 curr->comm, task_pid_nr(curr), mem_from, mem_to-1);
Arjan van de Ven55794a42006-07-10 04:44:03 -07004376 print_lock(hlock);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004377 lockdep_print_held_locks(curr);
4378
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004379 pr_warn("\nstack backtrace:\n");
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004380 dump_stack();
4381}
4382
Oleg Nesterov54561782007-12-05 15:46:09 +01004383static inline int not_in_range(const void* mem_from, unsigned long mem_len,
4384 const void* lock_from, unsigned long lock_len)
4385{
4386 return lock_from + lock_len <= mem_from ||
4387 mem_from + mem_len <= lock_from;
4388}
4389
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004390/*
4391 * Called when kernel memory is freed (or unmapped), or if a lock
4392 * is destroyed or reinitialized - this code checks whether there is
4393 * any held lock in the memory range of <from> to <to>:
4394 */
4395void debug_check_no_locks_freed(const void *mem_from, unsigned long mem_len)
4396{
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004397 struct task_struct *curr = current;
4398 struct held_lock *hlock;
4399 unsigned long flags;
4400 int i;
4401
4402 if (unlikely(!debug_locks))
4403 return;
4404
4405 local_irq_save(flags);
4406 for (i = 0; i < curr->lockdep_depth; i++) {
4407 hlock = curr->held_locks + i;
4408
Oleg Nesterov54561782007-12-05 15:46:09 +01004409 if (not_in_range(mem_from, mem_len, hlock->instance,
4410 sizeof(*hlock->instance)))
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004411 continue;
4412
Oleg Nesterov54561782007-12-05 15:46:09 +01004413 print_freed_lock_bug(curr, mem_from, mem_from + mem_len, hlock);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004414 break;
4415 }
4416 local_irq_restore(flags);
4417}
Peter Zijlstraed075362006-12-06 20:35:24 -08004418EXPORT_SYMBOL_GPL(debug_check_no_locks_freed);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004419
Colin Cross1b1d2fb2013-05-06 23:50:08 +00004420static void print_held_locks_bug(void)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004421{
4422 if (!debug_locks_off())
4423 return;
4424 if (debug_locks_silent)
4425 return;
4426
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004427 pr_warn("\n");
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08004428 pr_warn("====================================\n");
4429 pr_warn("WARNING: %s/%d still has locks held!\n",
Colin Cross1b1d2fb2013-05-06 23:50:08 +00004430 current->comm, task_pid_nr(current));
Ben Hutchingsfbdc4b92011-10-28 04:36:55 +01004431 print_kernel_ident();
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08004432 pr_warn("------------------------------------\n");
Colin Cross1b1d2fb2013-05-06 23:50:08 +00004433 lockdep_print_held_locks(current);
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004434 pr_warn("\nstack backtrace:\n");
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004435 dump_stack();
4436}
4437
Colin Cross1b1d2fb2013-05-06 23:50:08 +00004438void debug_check_no_locks_held(void)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004439{
Colin Cross1b1d2fb2013-05-06 23:50:08 +00004440 if (unlikely(current->lockdep_depth > 0))
4441 print_held_locks_bug();
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004442}
Colin Cross1b1d2fb2013-05-06 23:50:08 +00004443EXPORT_SYMBOL_GPL(debug_check_no_locks_held);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004444
Sasha Levin8dce7a92013-06-13 18:41:16 -04004445#ifdef __KERNEL__
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004446void debug_show_all_locks(void)
4447{
4448 struct task_struct *g, *p;
4449 int count = 10;
4450 int unlock = 1;
4451
Jarek Poplawski9c35dd72007-03-22 00:11:28 -08004452 if (unlikely(!debug_locks)) {
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004453 pr_warn("INFO: lockdep is turned off.\n");
Jarek Poplawski9c35dd72007-03-22 00:11:28 -08004454 return;
4455 }
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004456 pr_warn("\nShowing all locks held in the system:\n");
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004457
4458 /*
4459 * Here we try to get the tasklist_lock as hard as possible,
4460 * if not successful after 2 seconds we ignore it (but keep
4461 * trying). This is to enable a debug printout even if a
4462 * tasklist_lock-holding task deadlocks or crashes.
4463 */
4464retry:
4465 if (!read_trylock(&tasklist_lock)) {
4466 if (count == 10)
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004467 pr_warn("hm, tasklist_lock locked, retrying... ");
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004468 if (count) {
4469 count--;
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004470 pr_cont(" #%d", 10-count);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004471 mdelay(200);
4472 goto retry;
4473 }
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004474 pr_cont(" ignoring it.\n");
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004475 unlock = 0;
qinghuang feng46fec7a2008-10-28 17:24:28 +08004476 } else {
4477 if (count != 10)
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004478 pr_cont(" locked it.\n");
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004479 }
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004480
4481 do_each_thread(g, p) {
Ingo Molnar85684872007-12-05 15:46:09 +01004482 /*
4483 * It's not reliable to print a task's held locks
4484 * if it's not sleeping (or if it's not the current
4485 * task):
4486 */
4487 if (p->state == TASK_RUNNING && p != current)
4488 continue;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004489 if (p->lockdep_depth)
4490 lockdep_print_held_locks(p);
4491 if (!unlock)
4492 if (read_trylock(&tasklist_lock))
4493 unlock = 1;
4494 } while_each_thread(g, p);
4495
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004496 pr_warn("\n");
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08004497 pr_warn("=============================================\n\n");
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004498
4499 if (unlock)
4500 read_unlock(&tasklist_lock);
4501}
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004502EXPORT_SYMBOL_GPL(debug_show_all_locks);
Sasha Levin8dce7a92013-06-13 18:41:16 -04004503#endif
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004504
Ingo Molnar82a1fcb2008-01-25 21:08:02 +01004505/*
4506 * Careful: only use this function if you are sure that
4507 * the task cannot run in parallel!
4508 */
John Kacurf1b499f2010-08-05 17:10:53 +02004509void debug_show_held_locks(struct task_struct *task)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004510{
Jarek Poplawski9c35dd72007-03-22 00:11:28 -08004511 if (unlikely(!debug_locks)) {
4512 printk("INFO: lockdep is turned off.\n");
4513 return;
4514 }
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004515 lockdep_print_held_locks(task);
4516}
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004517EXPORT_SYMBOL_GPL(debug_show_held_locks);
Peter Zijlstrab351d162007-10-11 22:11:12 +02004518
Andi Kleen722a9f92014-05-02 00:44:38 +02004519asmlinkage __visible void lockdep_sys_exit(void)
Peter Zijlstrab351d162007-10-11 22:11:12 +02004520{
4521 struct task_struct *curr = current;
4522
4523 if (unlikely(curr->lockdep_depth)) {
4524 if (!debug_locks_off())
4525 return;
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004526 pr_warn("\n");
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08004527 pr_warn("================================================\n");
4528 pr_warn("WARNING: lock held when returning to user space!\n");
Ben Hutchingsfbdc4b92011-10-28 04:36:55 +01004529 print_kernel_ident();
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08004530 pr_warn("------------------------------------------------\n");
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004531 pr_warn("%s/%d is leaving the kernel with locks still held!\n",
Peter Zijlstrab351d162007-10-11 22:11:12 +02004532 curr->comm, curr->pid);
4533 lockdep_print_held_locks(curr);
4534 }
4535}
Paul E. McKenney0632eb32010-02-22 17:04:47 -08004536
Paul E. McKenneyb3fbab02011-05-24 08:31:09 -07004537void lockdep_rcu_suspicious(const char *file, const int line, const char *s)
Paul E. McKenney0632eb32010-02-22 17:04:47 -08004538{
4539 struct task_struct *curr = current;
4540
Lai Jiangshan2b3fc352010-04-20 16:23:07 +08004541 /* Note: the following can be executed concurrently, so be careful. */
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004542 pr_warn("\n");
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08004543 pr_warn("=============================\n");
4544 pr_warn("WARNING: suspicious RCU usage\n");
Ben Hutchingsfbdc4b92011-10-28 04:36:55 +01004545 print_kernel_ident();
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08004546 pr_warn("-----------------------------\n");
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004547 pr_warn("%s:%d %s!\n", file, line, s);
4548 pr_warn("\nother info that might help us debug this:\n\n");
4549 pr_warn("\n%srcu_scheduler_active = %d, debug_locks = %d\n",
Paul E. McKenneyc5fdcec2012-01-30 08:46:32 -08004550 !rcu_lockdep_current_cpu_online()
4551 ? "RCU used illegally from offline CPU!\n"
Paul E. McKenney5c173eb2013-09-13 17:20:11 -07004552 : !rcu_is_watching()
Paul E. McKenneyc5fdcec2012-01-30 08:46:32 -08004553 ? "RCU used illegally from idle CPU!\n"
4554 : "",
4555 rcu_scheduler_active, debug_locks);
Frederic Weisbecker0464e932011-10-07 18:22:01 +02004556
4557 /*
4558 * If a CPU is in the RCU-free window in idle (ie: in the section
4559 * between rcu_idle_enter() and rcu_idle_exit(), then RCU
4560 * considers that CPU to be in an "extended quiescent state",
4561 * which means that RCU will be completely ignoring that CPU.
4562 * Therefore, rcu_read_lock() and friends have absolutely no
4563 * effect on a CPU running in that state. In other words, even if
4564 * such an RCU-idle CPU has called rcu_read_lock(), RCU might well
4565 * delete data structures out from under it. RCU really has no
4566 * choice here: we need to keep an RCU-free window in idle where
4567 * the CPU may possibly enter into low power mode. This way we can
4568 * notice an extended quiescent state to other CPUs that started a grace
4569 * period. Otherwise we would delay any grace period as long as we run
4570 * in the idle task.
4571 *
4572 * So complain bitterly if someone does call rcu_read_lock(),
4573 * rcu_read_lock_bh() and so on from extended quiescent states.
4574 */
Paul E. McKenney5c173eb2013-09-13 17:20:11 -07004575 if (!rcu_is_watching())
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004576 pr_warn("RCU used illegally from extended quiescent state!\n");
Frederic Weisbecker0464e932011-10-07 18:22:01 +02004577
Paul E. McKenney0632eb32010-02-22 17:04:47 -08004578 lockdep_print_held_locks(curr);
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004579 pr_warn("\nstack backtrace:\n");
Paul E. McKenney0632eb32010-02-22 17:04:47 -08004580 dump_stack();
4581}
Paul E. McKenneyb3fbab02011-05-24 08:31:09 -07004582EXPORT_SYMBOL_GPL(lockdep_rcu_suspicious);