blob: e029f2f3b8dc449569b6cecacdeddf4e520eb669 [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,
Dmitry Vyukov8a5fd562016-02-04 14:40:40 +01001827 struct held_lock *next, int distance, int *stack_saved)
Peter Zijlstra8e182572007-07-19 01:48:54 -07001828{
1829 struct lock_list *entry;
1830 int ret;
Ming Leidb0002a2009-07-16 15:44:29 +02001831 struct lock_list this;
1832 struct lock_list *uninitialized_var(target_entry);
Yong Zhang4726f2a2010-05-04 14:16:48 +08001833 /*
1834 * Static variable, serialized by the graph_lock().
1835 *
1836 * We use this static variable to save the stack trace in case
1837 * we call into this function multiple times due to encountering
1838 * trylocks in the held lock stack.
1839 */
1840 static struct stack_trace trace;
Peter Zijlstra8e182572007-07-19 01:48:54 -07001841
1842 /*
1843 * Prove that the new <prev> -> <next> dependency would not
1844 * create a circular dependency in the graph. (We do this by
1845 * forward-recursing into the graph starting at <next>, and
1846 * checking whether we can reach <prev>.)
1847 *
1848 * We are using global variables to control the recursion, to
1849 * keep the stackframe size of the recursive functions low:
1850 */
Ming Leidb0002a2009-07-16 15:44:29 +02001851 this.class = hlock_class(next);
1852 this.parent = NULL;
1853 ret = check_noncircular(&this, hlock_class(prev), &target_entry);
1854 if (unlikely(!ret))
1855 return print_circular_bug(&this, target_entry, next, prev);
1856 else if (unlikely(ret < 0))
1857 return print_bfs_bug(ret);
Ming Leic94aa5c2009-07-16 15:44:29 +02001858
Peter Zijlstra8e182572007-07-19 01:48:54 -07001859 if (!check_prev_add_irq(curr, prev, next))
1860 return 0;
1861
1862 /*
1863 * For recursive read-locks we do all the dependency checks,
1864 * but we dont store read-triggered dependencies (only
1865 * write-triggered dependencies). This ensures that only the
1866 * write-side dependencies matter, and that if for example a
1867 * write-lock never takes any other locks, then the reads are
1868 * equivalent to a NOP.
1869 */
1870 if (next->read == 2 || prev->read == 2)
1871 return 1;
1872 /*
1873 * Is the <prev> -> <next> dependency already present?
1874 *
1875 * (this may occur even though this is a new chain: consider
1876 * e.g. the L1 -> L2 -> L3 -> L4 and the L5 -> L1 -> L2 -> L3
1877 * chains - the second one will be new, but L1 already has
1878 * L2 added to its dependency list, due to the first chain.)
1879 */
Dave Jonesf82b2172008-08-11 09:30:23 +02001880 list_for_each_entry(entry, &hlock_class(prev)->locks_after, entry) {
1881 if (entry->class == hlock_class(next)) {
Peter Zijlstra8e182572007-07-19 01:48:54 -07001882 if (distance == 1)
1883 entry->distance = 1;
1884 return 2;
1885 }
1886 }
1887
Peter Zijlstraae813302017-03-03 10:13:38 +01001888 /*
1889 * Is the <prev> -> <next> link redundant?
1890 */
1891 this.class = hlock_class(prev);
1892 this.parent = NULL;
1893 ret = check_redundant(&this, hlock_class(next), &target_entry);
1894 if (!ret) {
1895 debug_atomic_inc(nr_redundant);
1896 return 2;
1897 }
1898 if (ret < 0)
1899 return print_bfs_bug(ret);
1900
1901
Dmitry Vyukov8a5fd562016-02-04 14:40:40 +01001902 if (!*stack_saved) {
1903 if (!save_trace(&trace))
1904 return 0;
1905 *stack_saved = 1;
1906 }
Yong Zhang4726f2a2010-05-04 14:16:48 +08001907
Peter Zijlstra8e182572007-07-19 01:48:54 -07001908 /*
1909 * Ok, all validations passed, add the new lock
1910 * to the previous lock's dependency list:
1911 */
Tahsin Erdogan83f06162016-11-08 00:02:07 -08001912 ret = add_lock_to_list(hlock_class(next),
Dave Jonesf82b2172008-08-11 09:30:23 +02001913 &hlock_class(prev)->locks_after,
Yong Zhang4726f2a2010-05-04 14:16:48 +08001914 next->acquire_ip, distance, &trace);
Peter Zijlstra8e182572007-07-19 01:48:54 -07001915
1916 if (!ret)
1917 return 0;
1918
Tahsin Erdogan83f06162016-11-08 00:02:07 -08001919 ret = add_lock_to_list(hlock_class(prev),
Dave Jonesf82b2172008-08-11 09:30:23 +02001920 &hlock_class(next)->locks_before,
Yong Zhang4726f2a2010-05-04 14:16:48 +08001921 next->acquire_ip, distance, &trace);
Peter Zijlstra8e182572007-07-19 01:48:54 -07001922 if (!ret)
1923 return 0;
1924
1925 /*
1926 * Debugging printouts:
1927 */
Dave Jonesf82b2172008-08-11 09:30:23 +02001928 if (verbose(hlock_class(prev)) || verbose(hlock_class(next))) {
Dmitry Vyukov8a5fd562016-02-04 14:40:40 +01001929 /* We drop graph lock, so another thread can overwrite trace. */
1930 *stack_saved = 0;
Peter Zijlstra8e182572007-07-19 01:48:54 -07001931 graph_unlock();
1932 printk("\n new dependency: ");
Dave Jonesf82b2172008-08-11 09:30:23 +02001933 print_lock_name(hlock_class(prev));
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01001934 printk(KERN_CONT " => ");
Dave Jonesf82b2172008-08-11 09:30:23 +02001935 print_lock_name(hlock_class(next));
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01001936 printk(KERN_CONT "\n");
Peter Zijlstra8e182572007-07-19 01:48:54 -07001937 dump_stack();
1938 return graph_lock();
1939 }
1940 return 1;
1941}
1942
1943/*
1944 * Add the dependency to all directly-previous locks that are 'relevant'.
1945 * The ones that are relevant are (in increasing distance from curr):
1946 * all consecutive trylock entries and the final non-trylock entry - or
1947 * the end of this context's lock-chain - whichever comes first.
1948 */
1949static int
1950check_prevs_add(struct task_struct *curr, struct held_lock *next)
1951{
1952 int depth = curr->lockdep_depth;
Dmitry Vyukov8a5fd562016-02-04 14:40:40 +01001953 int stack_saved = 0;
Peter Zijlstra8e182572007-07-19 01:48:54 -07001954 struct held_lock *hlock;
1955
1956 /*
1957 * Debugging checks.
1958 *
1959 * Depth must not be zero for a non-head lock:
1960 */
1961 if (!depth)
1962 goto out_bug;
1963 /*
1964 * At least two relevant locks must exist for this
1965 * to be a head:
1966 */
1967 if (curr->held_locks[depth].irq_context !=
1968 curr->held_locks[depth-1].irq_context)
1969 goto out_bug;
1970
1971 for (;;) {
1972 int distance = curr->lockdep_depth - depth + 1;
Oleg Nesterov1b5ff812014-01-20 19:20:10 +01001973 hlock = curr->held_locks + depth - 1;
Peter Zijlstra8e182572007-07-19 01:48:54 -07001974 /*
1975 * Only non-recursive-read entries get new dependencies
1976 * added:
1977 */
Oleg Nesterov1b5ff812014-01-20 19:20:10 +01001978 if (hlock->read != 2 && hlock->check) {
Yong Zhang4726f2a2010-05-04 14:16:48 +08001979 if (!check_prev_add(curr, hlock, next,
Dmitry Vyukov8a5fd562016-02-04 14:40:40 +01001980 distance, &stack_saved))
Peter Zijlstra8e182572007-07-19 01:48:54 -07001981 return 0;
1982 /*
1983 * Stop after the first non-trylock entry,
1984 * as non-trylock entries have added their
1985 * own direct dependencies already, so this
1986 * lock is connected to them indirectly:
1987 */
1988 if (!hlock->trylock)
1989 break;
1990 }
1991 depth--;
1992 /*
1993 * End of lock-stack?
1994 */
1995 if (!depth)
1996 break;
1997 /*
1998 * Stop the search if we cross into another context:
1999 */
2000 if (curr->held_locks[depth].irq_context !=
2001 curr->held_locks[depth-1].irq_context)
2002 break;
2003 }
2004 return 1;
2005out_bug:
2006 if (!debug_locks_off_graph_unlock())
2007 return 0;
2008
Peter Zijlstra0119fee2011-09-02 01:30:29 +02002009 /*
2010 * Clearly we all shouldn't be here, but since we made it we
2011 * can reliable say we messed up our state. See the above two
2012 * gotos for reasons why we could possibly end up here.
2013 */
Peter Zijlstra8e182572007-07-19 01:48:54 -07002014 WARN_ON(1);
2015
2016 return 0;
2017}
2018
2019unsigned long nr_lock_chains;
Huang, Ying443cd502008-06-20 16:39:21 +08002020struct lock_chain lock_chains[MAX_LOCKDEP_CHAINS];
Huang, Yingcd1a28e2008-06-23 11:20:54 +08002021int nr_chain_hlocks;
Huang, Ying443cd502008-06-20 16:39:21 +08002022static u16 chain_hlocks[MAX_LOCKDEP_CHAIN_HLOCKS];
2023
2024struct lock_class *lock_chain_get_class(struct lock_chain *chain, int i)
2025{
2026 return lock_classes + chain_hlocks[chain->base + i];
2027}
Peter Zijlstra8e182572007-07-19 01:48:54 -07002028
2029/*
Ingo Molnar9e4e7552016-02-29 10:03:58 +01002030 * Returns the index of the first held_lock of the current chain
2031 */
2032static inline int get_first_held_lock(struct task_struct *curr,
2033 struct held_lock *hlock)
2034{
2035 int i;
2036 struct held_lock *hlock_curr;
2037
2038 for (i = curr->lockdep_depth - 1; i >= 0; i--) {
2039 hlock_curr = curr->held_locks + i;
2040 if (hlock_curr->irq_context != hlock->irq_context)
2041 break;
2042
2043 }
2044
2045 return ++i;
2046}
2047
Borislav Petkov5c8a0102016-04-04 10:42:07 +02002048#ifdef CONFIG_DEBUG_LOCKDEP
Ingo Molnar9e4e7552016-02-29 10:03:58 +01002049/*
Alfredo Alvarez Fernandez39e2e172016-03-30 19:03:36 +02002050 * Returns the next chain_key iteration
2051 */
2052static u64 print_chain_key_iteration(int class_idx, u64 chain_key)
2053{
2054 u64 new_chain_key = iterate_chain_key(chain_key, class_idx);
2055
2056 printk(" class_idx:%d -> chain_key:%016Lx",
2057 class_idx,
2058 (unsigned long long)new_chain_key);
2059 return new_chain_key;
2060}
2061
2062static void
2063print_chain_keys_held_locks(struct task_struct *curr, struct held_lock *hlock_next)
2064{
2065 struct held_lock *hlock;
2066 u64 chain_key = 0;
2067 int depth = curr->lockdep_depth;
2068 int i;
2069
2070 printk("depth: %u\n", depth + 1);
2071 for (i = get_first_held_lock(curr, hlock_next); i < depth; i++) {
2072 hlock = curr->held_locks + i;
2073 chain_key = print_chain_key_iteration(hlock->class_idx, chain_key);
2074
2075 print_lock(hlock);
2076 }
2077
2078 print_chain_key_iteration(hlock_next->class_idx, chain_key);
2079 print_lock(hlock_next);
2080}
2081
2082static void print_chain_keys_chain(struct lock_chain *chain)
2083{
2084 int i;
2085 u64 chain_key = 0;
2086 int class_id;
2087
2088 printk("depth: %u\n", chain->depth);
2089 for (i = 0; i < chain->depth; i++) {
2090 class_id = chain_hlocks[chain->base + i];
2091 chain_key = print_chain_key_iteration(class_id + 1, chain_key);
2092
2093 print_lock_name(lock_classes + class_id);
2094 printk("\n");
2095 }
2096}
2097
2098static void print_collision(struct task_struct *curr,
2099 struct held_lock *hlock_next,
2100 struct lock_chain *chain)
2101{
Paul E. McKenney681fbec2017-05-04 15:44:38 -07002102 pr_warn("\n");
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08002103 pr_warn("============================\n");
2104 pr_warn("WARNING: chain_key collision\n");
Alfredo Alvarez Fernandez39e2e172016-03-30 19:03:36 +02002105 print_kernel_ident();
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08002106 pr_warn("----------------------------\n");
Paul E. McKenney681fbec2017-05-04 15:44:38 -07002107 pr_warn("%s/%d: ", current->comm, task_pid_nr(current));
2108 pr_warn("Hash chain already cached but the contents don't match!\n");
Alfredo Alvarez Fernandez39e2e172016-03-30 19:03:36 +02002109
Paul E. McKenney681fbec2017-05-04 15:44:38 -07002110 pr_warn("Held locks:");
Alfredo Alvarez Fernandez39e2e172016-03-30 19:03:36 +02002111 print_chain_keys_held_locks(curr, hlock_next);
2112
Paul E. McKenney681fbec2017-05-04 15:44:38 -07002113 pr_warn("Locks in cached chain:");
Alfredo Alvarez Fernandez39e2e172016-03-30 19:03:36 +02002114 print_chain_keys_chain(chain);
2115
Paul E. McKenney681fbec2017-05-04 15:44:38 -07002116 pr_warn("\nstack backtrace:\n");
Alfredo Alvarez Fernandez39e2e172016-03-30 19:03:36 +02002117 dump_stack();
2118}
Borislav Petkov5c8a0102016-04-04 10:42:07 +02002119#endif
Alfredo Alvarez Fernandez39e2e172016-03-30 19:03:36 +02002120
2121/*
Ingo Molnar9e4e7552016-02-29 10:03:58 +01002122 * Checks whether the chain and the current held locks are consistent
2123 * in depth and also in content. If they are not it most likely means
2124 * that there was a collision during the calculation of the chain_key.
2125 * Returns: 0 not passed, 1 passed
2126 */
2127static int check_no_collision(struct task_struct *curr,
2128 struct held_lock *hlock,
2129 struct lock_chain *chain)
2130{
2131#ifdef CONFIG_DEBUG_LOCKDEP
2132 int i, j, id;
2133
2134 i = get_first_held_lock(curr, hlock);
2135
Alfredo Alvarez Fernandez39e2e172016-03-30 19:03:36 +02002136 if (DEBUG_LOCKS_WARN_ON(chain->depth != curr->lockdep_depth - (i - 1))) {
2137 print_collision(curr, hlock, chain);
Ingo Molnar9e4e7552016-02-29 10:03:58 +01002138 return 0;
Alfredo Alvarez Fernandez39e2e172016-03-30 19:03:36 +02002139 }
Ingo Molnar9e4e7552016-02-29 10:03:58 +01002140
2141 for (j = 0; j < chain->depth - 1; j++, i++) {
2142 id = curr->held_locks[i].class_idx - 1;
2143
Alfredo Alvarez Fernandez39e2e172016-03-30 19:03:36 +02002144 if (DEBUG_LOCKS_WARN_ON(chain_hlocks[chain->base + j] != id)) {
2145 print_collision(curr, hlock, chain);
Ingo Molnar9e4e7552016-02-29 10:03:58 +01002146 return 0;
Alfredo Alvarez Fernandez39e2e172016-03-30 19:03:36 +02002147 }
Ingo Molnar9e4e7552016-02-29 10:03:58 +01002148 }
2149#endif
2150 return 1;
2151}
2152
2153/*
Byungchul Park545c23f2017-08-07 16:12:48 +09002154 * Adds a dependency chain into chain hashtable. And must be called with
2155 * graph_lock held.
2156 *
2157 * Return 0 if fail, and graph_lock is released.
2158 * Return 1 if succeed, with graph_lock held.
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002159 */
Byungchul Park545c23f2017-08-07 16:12:48 +09002160static inline int add_chain_cache(struct task_struct *curr,
2161 struct held_lock *hlock,
2162 u64 chain_key)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002163{
Dave Jonesf82b2172008-08-11 09:30:23 +02002164 struct lock_class *class = hlock_class(hlock);
Andrew Mortona63f38c2016-02-03 13:44:12 -08002165 struct hlist_head *hash_head = chainhashentry(chain_key);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002166 struct lock_chain *chain;
Steven Rostedte0944ee2011-04-20 21:42:00 -04002167 int i, j;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002168
Peter Zijlstra0119fee2011-09-02 01:30:29 +02002169 /*
Byungchul Park545c23f2017-08-07 16:12:48 +09002170 * Allocate a new chain entry from the static array, and add
2171 * it to the hash:
2172 */
2173
2174 /*
Peter Zijlstra0119fee2011-09-02 01:30:29 +02002175 * 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 */
Jarek Poplawski381a2292007-02-10 01:44:58 -08002179 if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
2180 return 0;
Ingo Molnar9e4e7552016-02-29 10:03:58 +01002181
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002182 if (unlikely(nr_lock_chains >= MAX_LOCKDEP_CHAINS)) {
Ingo Molnar74c383f2006-12-13 00:34:43 -08002183 if (!debug_locks_off_graph_unlock())
2184 return 0;
2185
Dave Jones2c522832013-04-25 13:40:02 -04002186 print_lockdep_off("BUG: MAX_LOCKDEP_CHAINS too low!");
Peter Zijlstraeedeeab2009-03-18 12:38:47 +01002187 dump_stack();
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002188 return 0;
2189 }
2190 chain = lock_chains + nr_lock_chains++;
2191 chain->chain_key = chain_key;
Huang, Ying443cd502008-06-20 16:39:21 +08002192 chain->irq_context = hlock->irq_context;
Ingo Molnar9e4e7552016-02-29 10:03:58 +01002193 i = get_first_held_lock(curr, hlock);
Huang, Ying443cd502008-06-20 16:39:21 +08002194 chain->depth = curr->lockdep_depth + 1 - i;
Peter Zijlstra75dd6022016-03-30 11:36:59 +02002195
2196 BUILD_BUG_ON((1UL << 24) <= ARRAY_SIZE(chain_hlocks));
2197 BUILD_BUG_ON((1UL << 6) <= ARRAY_SIZE(curr->held_locks));
2198 BUILD_BUG_ON((1UL << 8*sizeof(chain_hlocks[0])) <= ARRAY_SIZE(lock_classes));
2199
Steven Rostedte0944ee2011-04-20 21:42:00 -04002200 if (likely(nr_chain_hlocks + chain->depth <= MAX_LOCKDEP_CHAIN_HLOCKS)) {
2201 chain->base = nr_chain_hlocks;
Huang, Ying443cd502008-06-20 16:39:21 +08002202 for (j = 0; j < chain->depth - 1; j++, i++) {
Dave Jonesf82b2172008-08-11 09:30:23 +02002203 int lock_id = curr->held_locks[i].class_idx - 1;
Huang, Ying443cd502008-06-20 16:39:21 +08002204 chain_hlocks[chain->base + j] = lock_id;
2205 }
2206 chain_hlocks[chain->base + j] = class - lock_classes;
2207 }
Peter Zijlstra75dd6022016-03-30 11:36:59 +02002208
2209 if (nr_chain_hlocks < MAX_LOCKDEP_CHAIN_HLOCKS)
2210 nr_chain_hlocks += chain->depth;
2211
2212#ifdef CONFIG_DEBUG_LOCKDEP
2213 /*
2214 * Important for check_no_collision().
2215 */
2216 if (unlikely(nr_chain_hlocks > MAX_LOCKDEP_CHAIN_HLOCKS)) {
Byungchul Parkf9af4562017-01-13 11:42:04 +09002217 if (!debug_locks_off_graph_unlock())
Peter Zijlstra75dd6022016-03-30 11:36:59 +02002218 return 0;
2219
2220 print_lockdep_off("BUG: MAX_LOCKDEP_CHAIN_HLOCKS too low!");
2221 dump_stack();
2222 return 0;
2223 }
2224#endif
2225
Andrew Mortona63f38c2016-02-03 13:44:12 -08002226 hlist_add_head_rcu(&chain->entry, hash_head);
Frederic Weisbeckerbd6d29c2010-04-06 00:10:17 +02002227 debug_atomic_inc(chain_lookup_misses);
Peter Zijlstra8e182572007-07-19 01:48:54 -07002228 inc_chains();
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002229
2230 return 1;
2231}
Peter Zijlstra8e182572007-07-19 01:48:54 -07002232
Byungchul Park545c23f2017-08-07 16:12:48 +09002233/*
2234 * Look up a dependency chain.
2235 */
2236static inline struct lock_chain *lookup_chain_cache(u64 chain_key)
2237{
2238 struct hlist_head *hash_head = chainhashentry(chain_key);
2239 struct lock_chain *chain;
2240
2241 /*
2242 * We can walk it lock-free, because entries only get added
2243 * to the hash:
2244 */
2245 hlist_for_each_entry_rcu(chain, hash_head, entry) {
2246 if (chain->chain_key == chain_key) {
2247 debug_atomic_inc(chain_lookup_hits);
2248 return chain;
2249 }
2250 }
2251 return NULL;
2252}
2253
2254/*
2255 * If the key is not present yet in dependency chain cache then
2256 * add it and return 1 - in this case the new dependency chain is
2257 * validated. If the key is already hashed, return 0.
2258 * (On return with 1 graph_lock is held.)
2259 */
2260static inline int lookup_chain_cache_add(struct task_struct *curr,
2261 struct held_lock *hlock,
2262 u64 chain_key)
2263{
2264 struct lock_class *class = hlock_class(hlock);
2265 struct lock_chain *chain = lookup_chain_cache(chain_key);
2266
2267 if (chain) {
2268cache_hit:
2269 if (!check_no_collision(curr, hlock, chain))
2270 return 0;
2271
2272 if (very_verbose(class)) {
2273 printk("\nhash chain already cached, key: "
2274 "%016Lx tail class: [%p] %s\n",
2275 (unsigned long long)chain_key,
2276 class->key, class->name);
2277 }
2278
2279 return 0;
2280 }
2281
2282 if (very_verbose(class)) {
2283 printk("\nnew hash chain, key: %016Lx tail class: [%p] %s\n",
2284 (unsigned long long)chain_key, class->key, class->name);
2285 }
2286
2287 if (!graph_lock())
2288 return 0;
2289
2290 /*
2291 * We have to walk the chain again locked - to avoid duplicates:
2292 */
2293 chain = lookup_chain_cache(chain_key);
2294 if (chain) {
2295 graph_unlock();
2296 goto cache_hit;
2297 }
2298
2299 if (!add_chain_cache(curr, hlock, chain_key))
2300 return 0;
2301
2302 return 1;
2303}
2304
Peter Zijlstra8e182572007-07-19 01:48:54 -07002305static int validate_chain(struct task_struct *curr, struct lockdep_map *lock,
Johannes Berg4e6045f2007-10-18 23:39:55 -07002306 struct held_lock *hlock, int chain_head, u64 chain_key)
Peter Zijlstra8e182572007-07-19 01:48:54 -07002307{
2308 /*
2309 * Trylock needs to maintain the stack of held locks, but it
2310 * does not add new dependencies, because trylock can be done
2311 * in any order.
2312 *
2313 * We look up the chain_key and do the O(N^2) check and update of
2314 * the dependencies only if this is a new dependency chain.
Byungchul Park545c23f2017-08-07 16:12:48 +09002315 * (If lookup_chain_cache_add() return with 1 it acquires
Peter Zijlstra8e182572007-07-19 01:48:54 -07002316 * graph_lock for us)
2317 */
Oleg Nesterovfb9edbe2014-01-20 19:20:06 +01002318 if (!hlock->trylock && hlock->check &&
Byungchul Park545c23f2017-08-07 16:12:48 +09002319 lookup_chain_cache_add(curr, hlock, chain_key)) {
Peter Zijlstra8e182572007-07-19 01:48:54 -07002320 /*
2321 * Check whether last held lock:
2322 *
2323 * - is irq-safe, if this lock is irq-unsafe
2324 * - is softirq-safe, if this lock is hardirq-unsafe
2325 *
2326 * And check whether the new lock's dependency graph
2327 * could lead back to the previous lock.
2328 *
2329 * any of these scenarios could lead to a deadlock. If
2330 * All validations
2331 */
2332 int ret = check_deadlock(curr, hlock, lock, hlock->read);
2333
2334 if (!ret)
2335 return 0;
2336 /*
2337 * Mark recursive read, as we jump over it when
2338 * building dependencies (just like we jump over
2339 * trylock entries):
2340 */
2341 if (ret == 2)
2342 hlock->read = 2;
2343 /*
2344 * Add dependency only if this lock is not the head
2345 * of the chain, and if it's not a secondary read-lock:
2346 */
Byungchul Park545c23f2017-08-07 16:12:48 +09002347 if (!chain_head && ret != 2) {
Peter Zijlstra8e182572007-07-19 01:48:54 -07002348 if (!check_prevs_add(curr, hlock))
2349 return 0;
Byungchul Park545c23f2017-08-07 16:12:48 +09002350 }
2351
Peter Zijlstra8e182572007-07-19 01:48:54 -07002352 graph_unlock();
Byungchul Park545c23f2017-08-07 16:12:48 +09002353 } else {
2354 /* after lookup_chain_cache_add(): */
Peter Zijlstra8e182572007-07-19 01:48:54 -07002355 if (unlikely(!debug_locks))
2356 return 0;
Byungchul Park545c23f2017-08-07 16:12:48 +09002357 }
Peter Zijlstra8e182572007-07-19 01:48:54 -07002358
2359 return 1;
2360}
2361#else
2362static inline int validate_chain(struct task_struct *curr,
2363 struct lockdep_map *lock, struct held_lock *hlock,
Gregory Haskins3aa416b2007-10-11 22:11:11 +02002364 int chain_head, u64 chain_key)
Peter Zijlstra8e182572007-07-19 01:48:54 -07002365{
2366 return 1;
2367}
Peter Zijlstraca58abc2007-07-19 01:48:53 -07002368#endif
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002369
2370/*
2371 * We are building curr_chain_key incrementally, so double-check
2372 * it from scratch, to make sure that it's done correctly:
2373 */
Steven Rostedt1d09daa2008-05-12 21:20:55 +02002374static void check_chain_key(struct task_struct *curr)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002375{
2376#ifdef CONFIG_DEBUG_LOCKDEP
2377 struct held_lock *hlock, *prev_hlock = NULL;
Alfredo Alvarez Fernandez5f18ab52016-02-11 00:33:32 +01002378 unsigned int i;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002379 u64 chain_key = 0;
2380
2381 for (i = 0; i < curr->lockdep_depth; i++) {
2382 hlock = curr->held_locks + i;
2383 if (chain_key != hlock->prev_chain_key) {
2384 debug_locks_off();
Peter Zijlstra0119fee2011-09-02 01:30:29 +02002385 /*
2386 * We got mighty confused, our chain keys don't match
2387 * with what we expect, someone trample on our task state?
2388 */
Arjan van de Ven2df8b1d2008-07-30 12:43:11 -07002389 WARN(1, "hm#1, depth: %u [%u], %016Lx != %016Lx\n",
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002390 curr->lockdep_depth, i,
2391 (unsigned long long)chain_key,
2392 (unsigned long long)hlock->prev_chain_key);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002393 return;
2394 }
Peter Zijlstra0119fee2011-09-02 01:30:29 +02002395 /*
2396 * Whoops ran out of static storage again?
2397 */
Alfredo Alvarez Fernandez5f18ab52016-02-11 00:33:32 +01002398 if (DEBUG_LOCKS_WARN_ON(hlock->class_idx > MAX_LOCKDEP_KEYS))
Jarek Poplawski381a2292007-02-10 01:44:58 -08002399 return;
2400
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002401 if (prev_hlock && (prev_hlock->irq_context !=
2402 hlock->irq_context))
2403 chain_key = 0;
Alfredo Alvarez Fernandez5f18ab52016-02-11 00:33:32 +01002404 chain_key = iterate_chain_key(chain_key, hlock->class_idx);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002405 prev_hlock = hlock;
2406 }
2407 if (chain_key != curr->curr_chain_key) {
2408 debug_locks_off();
Peter Zijlstra0119fee2011-09-02 01:30:29 +02002409 /*
2410 * More smoking hash instead of calculating it, damn see these
2411 * numbers float.. I bet that a pink elephant stepped on my memory.
2412 */
Arjan van de Ven2df8b1d2008-07-30 12:43:11 -07002413 WARN(1, "hm#2, depth: %u [%u], %016Lx != %016Lx\n",
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002414 curr->lockdep_depth, i,
2415 (unsigned long long)chain_key,
2416 (unsigned long long)curr->curr_chain_key);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002417 }
2418#endif
2419}
2420
Steven Rostedt282b5c22011-04-20 21:41:59 -04002421static void
2422print_usage_bug_scenario(struct held_lock *lock)
2423{
2424 struct lock_class *class = hlock_class(lock);
2425
2426 printk(" Possible unsafe locking scenario:\n\n");
2427 printk(" CPU0\n");
2428 printk(" ----\n");
2429 printk(" lock(");
2430 __print_lock_name(class);
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01002431 printk(KERN_CONT ");\n");
Steven Rostedt282b5c22011-04-20 21:41:59 -04002432 printk(" <Interrupt>\n");
2433 printk(" lock(");
2434 __print_lock_name(class);
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01002435 printk(KERN_CONT ");\n");
Steven Rostedt282b5c22011-04-20 21:41:59 -04002436 printk("\n *** DEADLOCK ***\n\n");
2437}
2438
Peter Zijlstra8e182572007-07-19 01:48:54 -07002439static int
2440print_usage_bug(struct task_struct *curr, struct held_lock *this,
2441 enum lock_usage_bit prev_bit, enum lock_usage_bit new_bit)
2442{
2443 if (!debug_locks_off_graph_unlock() || debug_locks_silent)
2444 return 0;
2445
Paul E. McKenney681fbec2017-05-04 15:44:38 -07002446 pr_warn("\n");
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08002447 pr_warn("================================\n");
2448 pr_warn("WARNING: inconsistent lock state\n");
Ben Hutchingsfbdc4b92011-10-28 04:36:55 +01002449 print_kernel_ident();
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08002450 pr_warn("--------------------------------\n");
Peter Zijlstra8e182572007-07-19 01:48:54 -07002451
Paul E. McKenney681fbec2017-05-04 15:44:38 -07002452 pr_warn("inconsistent {%s} -> {%s} usage.\n",
Peter Zijlstra8e182572007-07-19 01:48:54 -07002453 usage_str[prev_bit], usage_str[new_bit]);
2454
Paul E. McKenney681fbec2017-05-04 15:44:38 -07002455 pr_warn("%s/%d [HC%u[%lu]:SC%u[%lu]:HE%u:SE%u] takes:\n",
Pavel Emelyanovba25f9d2007-10-18 23:40:40 -07002456 curr->comm, task_pid_nr(curr),
Peter Zijlstra8e182572007-07-19 01:48:54 -07002457 trace_hardirq_context(curr), hardirq_count() >> HARDIRQ_SHIFT,
2458 trace_softirq_context(curr), softirq_count() >> SOFTIRQ_SHIFT,
2459 trace_hardirqs_enabled(curr),
2460 trace_softirqs_enabled(curr));
2461 print_lock(this);
2462
Paul E. McKenney681fbec2017-05-04 15:44:38 -07002463 pr_warn("{%s} state was registered at:\n", usage_str[prev_bit]);
Dave Jonesf82b2172008-08-11 09:30:23 +02002464 print_stack_trace(hlock_class(this)->usage_traces + prev_bit, 1);
Peter Zijlstra8e182572007-07-19 01:48:54 -07002465
2466 print_irqtrace_events(curr);
Paul E. McKenney681fbec2017-05-04 15:44:38 -07002467 pr_warn("\nother info that might help us debug this:\n");
Steven Rostedt282b5c22011-04-20 21:41:59 -04002468 print_usage_bug_scenario(this);
2469
Peter Zijlstra8e182572007-07-19 01:48:54 -07002470 lockdep_print_held_locks(curr);
2471
Paul E. McKenney681fbec2017-05-04 15:44:38 -07002472 pr_warn("\nstack backtrace:\n");
Peter Zijlstra8e182572007-07-19 01:48:54 -07002473 dump_stack();
2474
2475 return 0;
2476}
2477
2478/*
2479 * Print out an error if an invalid bit is set:
2480 */
2481static inline int
2482valid_state(struct task_struct *curr, struct held_lock *this,
2483 enum lock_usage_bit new_bit, enum lock_usage_bit bad_bit)
2484{
Dave Jonesf82b2172008-08-11 09:30:23 +02002485 if (unlikely(hlock_class(this)->usage_mask & (1 << bad_bit)))
Peter Zijlstra8e182572007-07-19 01:48:54 -07002486 return print_usage_bug(curr, this, bad_bit, new_bit);
2487 return 1;
2488}
2489
2490static int mark_lock(struct task_struct *curr, struct held_lock *this,
2491 enum lock_usage_bit new_bit);
2492
Steven Rostedt81d68a92008-05-12 21:20:42 +02002493#if defined(CONFIG_TRACE_IRQFLAGS) && defined(CONFIG_PROVE_LOCKING)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002494
2495/*
2496 * print irq inversion bug:
2497 */
2498static int
Ming Lei24208ca2009-07-16 15:44:29 +02002499print_irq_inversion_bug(struct task_struct *curr,
2500 struct lock_list *root, struct lock_list *other,
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002501 struct held_lock *this, int forwards,
2502 const char *irqclass)
2503{
Steven Rostedtdad3d742011-04-20 21:41:57 -04002504 struct lock_list *entry = other;
2505 struct lock_list *middle = NULL;
2506 int depth;
2507
Ingo Molnar74c383f2006-12-13 00:34:43 -08002508 if (!debug_locks_off_graph_unlock() || debug_locks_silent)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002509 return 0;
2510
Paul E. McKenney681fbec2017-05-04 15:44:38 -07002511 pr_warn("\n");
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08002512 pr_warn("========================================================\n");
2513 pr_warn("WARNING: possible irq lock inversion dependency detected\n");
Ben Hutchingsfbdc4b92011-10-28 04:36:55 +01002514 print_kernel_ident();
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08002515 pr_warn("--------------------------------------------------------\n");
Paul E. McKenney681fbec2017-05-04 15:44:38 -07002516 pr_warn("%s/%d just changed the state of lock:\n",
Pavel Emelyanovba25f9d2007-10-18 23:40:40 -07002517 curr->comm, task_pid_nr(curr));
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002518 print_lock(this);
2519 if (forwards)
Paul E. McKenney681fbec2017-05-04 15:44:38 -07002520 pr_warn("but this lock took another, %s-unsafe lock in the past:\n", irqclass);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002521 else
Paul E. McKenney681fbec2017-05-04 15:44:38 -07002522 pr_warn("but this lock was taken by another, %s-safe lock in the past:\n", irqclass);
Ming Lei24208ca2009-07-16 15:44:29 +02002523 print_lock_name(other->class);
Paul E. McKenney681fbec2017-05-04 15:44:38 -07002524 pr_warn("\n\nand interrupts could create inverse lock ordering between them.\n\n");
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002525
Paul E. McKenney681fbec2017-05-04 15:44:38 -07002526 pr_warn("\nother info that might help us debug this:\n");
Steven Rostedtdad3d742011-04-20 21:41:57 -04002527
2528 /* Find a middle lock (if one exists) */
2529 depth = get_lock_depth(other);
2530 do {
2531 if (depth == 0 && (entry != root)) {
Paul E. McKenney681fbec2017-05-04 15:44:38 -07002532 pr_warn("lockdep:%s bad path found in chain graph\n", __func__);
Steven Rostedtdad3d742011-04-20 21:41:57 -04002533 break;
2534 }
2535 middle = entry;
2536 entry = get_lock_parent(entry);
2537 depth--;
2538 } while (entry && entry != root && (depth >= 0));
2539 if (forwards)
2540 print_irq_lock_scenario(root, other,
2541 middle ? middle->class : root->class, other->class);
2542 else
2543 print_irq_lock_scenario(other, root,
2544 middle ? middle->class : other->class, root->class);
2545
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002546 lockdep_print_held_locks(curr);
2547
Paul E. McKenney681fbec2017-05-04 15:44:38 -07002548 pr_warn("\nthe shortest dependencies between 2nd lock and 1st lock:\n");
Ming Lei24208ca2009-07-16 15:44:29 +02002549 if (!save_trace(&root->trace))
2550 return 0;
2551 print_shortest_lock_dependencies(other, root);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002552
Paul E. McKenney681fbec2017-05-04 15:44:38 -07002553 pr_warn("\nstack backtrace:\n");
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002554 dump_stack();
2555
2556 return 0;
2557}
2558
2559/*
2560 * Prove that in the forwards-direction subgraph starting at <this>
2561 * there is no lock matching <mask>:
2562 */
2563static int
2564check_usage_forwards(struct task_struct *curr, struct held_lock *this,
2565 enum lock_usage_bit bit, const char *irqclass)
2566{
2567 int ret;
Ming Leid7aaba12009-07-16 15:44:29 +02002568 struct lock_list root;
2569 struct lock_list *uninitialized_var(target_entry);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002570
Ming Leid7aaba12009-07-16 15:44:29 +02002571 root.parent = NULL;
2572 root.class = hlock_class(this);
2573 ret = find_usage_forwards(&root, bit, &target_entry);
Peter Zijlstraaf012962009-07-16 15:44:29 +02002574 if (ret < 0)
2575 return print_bfs_bug(ret);
2576 if (ret == 1)
2577 return ret;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002578
Ming Lei24208ca2009-07-16 15:44:29 +02002579 return print_irq_inversion_bug(curr, &root, target_entry,
Ming Leid7aaba12009-07-16 15:44:29 +02002580 this, 1, irqclass);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002581}
2582
2583/*
2584 * Prove that in the backwards-direction subgraph starting at <this>
2585 * there is no lock matching <mask>:
2586 */
2587static int
2588check_usage_backwards(struct task_struct *curr, struct held_lock *this,
2589 enum lock_usage_bit bit, const char *irqclass)
2590{
2591 int ret;
Ming Leid7aaba12009-07-16 15:44:29 +02002592 struct lock_list root;
2593 struct lock_list *uninitialized_var(target_entry);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002594
Ming Leid7aaba12009-07-16 15:44:29 +02002595 root.parent = NULL;
2596 root.class = hlock_class(this);
2597 ret = find_usage_backwards(&root, bit, &target_entry);
Peter Zijlstraaf012962009-07-16 15:44:29 +02002598 if (ret < 0)
2599 return print_bfs_bug(ret);
2600 if (ret == 1)
2601 return ret;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002602
Ming Lei24208ca2009-07-16 15:44:29 +02002603 return print_irq_inversion_bug(curr, &root, target_entry,
Oleg Nesterov48d50672010-01-26 19:16:41 +01002604 this, 0, irqclass);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002605}
2606
Ingo Molnar3117df02006-12-13 00:34:43 -08002607void print_irqtrace_events(struct task_struct *curr)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002608{
2609 printk("irq event stamp: %u\n", curr->irq_events);
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01002610 printk("hardirqs last enabled at (%u): [<%p>] %pS\n",
2611 curr->hardirq_enable_event, (void *)curr->hardirq_enable_ip,
2612 (void *)curr->hardirq_enable_ip);
2613 printk("hardirqs last disabled at (%u): [<%p>] %pS\n",
2614 curr->hardirq_disable_event, (void *)curr->hardirq_disable_ip,
2615 (void *)curr->hardirq_disable_ip);
2616 printk("softirqs last enabled at (%u): [<%p>] %pS\n",
2617 curr->softirq_enable_event, (void *)curr->softirq_enable_ip,
2618 (void *)curr->softirq_enable_ip);
2619 printk("softirqs last disabled at (%u): [<%p>] %pS\n",
2620 curr->softirq_disable_event, (void *)curr->softirq_disable_ip,
2621 (void *)curr->softirq_disable_ip);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002622}
2623
Peter Zijlstracd953022009-01-22 16:38:21 +01002624static int HARDIRQ_verbose(struct lock_class *class)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002625{
Peter Zijlstra8e182572007-07-19 01:48:54 -07002626#if HARDIRQ_VERBOSE
2627 return class_filter(class);
2628#endif
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002629 return 0;
2630}
2631
Peter Zijlstracd953022009-01-22 16:38:21 +01002632static int SOFTIRQ_verbose(struct lock_class *class)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002633{
Peter Zijlstra8e182572007-07-19 01:48:54 -07002634#if SOFTIRQ_VERBOSE
2635 return class_filter(class);
2636#endif
2637 return 0;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002638}
2639
2640#define STRICT_READ_CHECKS 1
2641
Peter Zijlstracd953022009-01-22 16:38:21 +01002642static int (*state_verbose_f[])(struct lock_class *class) = {
2643#define LOCKDEP_STATE(__STATE) \
2644 __STATE##_verbose,
2645#include "lockdep_states.h"
2646#undef LOCKDEP_STATE
2647};
2648
2649static inline int state_verbose(enum lock_usage_bit bit,
2650 struct lock_class *class)
2651{
2652 return state_verbose_f[bit >> 2](class);
2653}
2654
Peter Zijlstra42c50d52009-01-22 16:58:16 +01002655typedef int (*check_usage_f)(struct task_struct *, struct held_lock *,
2656 enum lock_usage_bit bit, const char *name);
2657
Peter Zijlstra6a6904d2009-01-22 16:07:44 +01002658static int
Peter Zijlstra1c21f142009-03-04 13:51:13 +01002659mark_lock_irq(struct task_struct *curr, struct held_lock *this,
2660 enum lock_usage_bit new_bit)
Peter Zijlstra6a6904d2009-01-22 16:07:44 +01002661{
Peter Zijlstraf9892092009-01-22 16:09:59 +01002662 int excl_bit = exclusive_bit(new_bit);
Peter Zijlstra9d3651a2009-01-22 17:18:32 +01002663 int read = new_bit & 1;
Peter Zijlstra42c50d52009-01-22 16:58:16 +01002664 int dir = new_bit & 2;
2665
Peter Zijlstra38aa2712009-01-27 14:53:50 +01002666 /*
2667 * mark USED_IN has to look forwards -- to ensure no dependency
2668 * has ENABLED state, which would allow recursion deadlocks.
2669 *
2670 * mark ENABLED has to look backwards -- to ensure no dependee
2671 * has USED_IN state, which, again, would allow recursion deadlocks.
2672 */
Peter Zijlstra42c50d52009-01-22 16:58:16 +01002673 check_usage_f usage = dir ?
2674 check_usage_backwards : check_usage_forwards;
Peter Zijlstraf9892092009-01-22 16:09:59 +01002675
Peter Zijlstra38aa2712009-01-27 14:53:50 +01002676 /*
2677 * Validate that this particular lock does not have conflicting
2678 * usage states.
2679 */
Peter Zijlstra6a6904d2009-01-22 16:07:44 +01002680 if (!valid_state(curr, this, new_bit, excl_bit))
2681 return 0;
Peter Zijlstra9d3651a2009-01-22 17:18:32 +01002682
Peter Zijlstra38aa2712009-01-27 14:53:50 +01002683 /*
2684 * Validate that the lock dependencies don't have conflicting usage
2685 * states.
2686 */
2687 if ((!read || !dir || STRICT_READ_CHECKS) &&
Peter Zijlstra1c21f142009-03-04 13:51:13 +01002688 !usage(curr, this, excl_bit, state_name(new_bit & ~1)))
Peter Zijlstra6a6904d2009-01-22 16:07:44 +01002689 return 0;
Peter Zijlstra780e8202009-01-22 16:51:29 +01002690
Peter Zijlstra38aa2712009-01-27 14:53:50 +01002691 /*
2692 * Check for read in write conflicts
2693 */
2694 if (!read) {
2695 if (!valid_state(curr, this, new_bit, excl_bit + 1))
2696 return 0;
2697
2698 if (STRICT_READ_CHECKS &&
Peter Zijlstra4f367d8a2009-01-22 18:10:42 +01002699 !usage(curr, this, excl_bit + 1,
2700 state_name(new_bit + 1)))
Peter Zijlstra38aa2712009-01-27 14:53:50 +01002701 return 0;
2702 }
Peter Zijlstra780e8202009-01-22 16:51:29 +01002703
Peter Zijlstracd953022009-01-22 16:38:21 +01002704 if (state_verbose(new_bit, hlock_class(this)))
Peter Zijlstra6a6904d2009-01-22 16:07:44 +01002705 return 2;
2706
2707 return 1;
2708}
2709
Nick Piggincf40bd12009-01-21 08:12:39 +01002710enum mark_type {
Peter Zijlstra36bfb9b2009-01-22 14:12:41 +01002711#define LOCKDEP_STATE(__STATE) __STATE,
2712#include "lockdep_states.h"
2713#undef LOCKDEP_STATE
Nick Piggincf40bd12009-01-21 08:12:39 +01002714};
2715
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002716/*
2717 * Mark all held locks with a usage bit:
2718 */
Steven Rostedt1d09daa2008-05-12 21:20:55 +02002719static int
Nick Piggincf40bd12009-01-21 08:12:39 +01002720mark_held_locks(struct task_struct *curr, enum mark_type mark)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002721{
2722 enum lock_usage_bit usage_bit;
2723 struct held_lock *hlock;
2724 int i;
2725
2726 for (i = 0; i < curr->lockdep_depth; i++) {
2727 hlock = curr->held_locks + i;
2728
Peter Zijlstracf2ad4d2009-01-27 13:58:08 +01002729 usage_bit = 2 + (mark << 2); /* ENABLED */
2730 if (hlock->read)
2731 usage_bit += 1; /* READ */
2732
2733 BUG_ON(usage_bit >= LOCK_USAGE_STATES);
Nick Piggincf40bd12009-01-21 08:12:39 +01002734
Oleg Nesterov34d0ed52014-01-20 19:20:13 +01002735 if (!hlock->check)
Peter Zijlstraefbe2ee2011-07-07 11:39:45 +02002736 continue;
2737
Jarek Poplawski4ff773bb2007-05-08 00:31:00 -07002738 if (!mark_lock(curr, hlock, usage_bit))
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002739 return 0;
2740 }
2741
2742 return 1;
2743}
2744
2745/*
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002746 * Hardirqs will be enabled:
2747 */
Peter Zijlstradd4e5d32011-06-21 17:17:27 +02002748static void __trace_hardirqs_on_caller(unsigned long ip)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002749{
2750 struct task_struct *curr = current;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002751
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002752 /* we'll do an OFF -> ON transition: */
2753 curr->hardirqs_enabled = 1;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002754
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002755 /*
2756 * We are going to turn hardirqs on, so set the
2757 * usage bit for all held locks:
2758 */
Nick Piggincf40bd12009-01-21 08:12:39 +01002759 if (!mark_held_locks(curr, HARDIRQ))
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002760 return;
2761 /*
2762 * If we have softirqs enabled, then set the usage
2763 * bit for all held locks. (disabled hardirqs prevented
2764 * this bit from being set before)
2765 */
2766 if (curr->softirqs_enabled)
Nick Piggincf40bd12009-01-21 08:12:39 +01002767 if (!mark_held_locks(curr, SOFTIRQ))
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002768 return;
2769
2770 curr->hardirq_enable_ip = ip;
2771 curr->hardirq_enable_event = ++curr->irq_events;
Frederic Weisbeckerbd6d29c2010-04-06 00:10:17 +02002772 debug_atomic_inc(hardirqs_on_events);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002773}
Peter Zijlstradd4e5d32011-06-21 17:17:27 +02002774
Andi Kleenb35f8302014-02-08 08:52:02 +01002775__visible void trace_hardirqs_on_caller(unsigned long ip)
Peter Zijlstradd4e5d32011-06-21 17:17:27 +02002776{
2777 time_hardirqs_on(CALLER_ADDR0, ip);
2778
2779 if (unlikely(!debug_locks || current->lockdep_recursion))
2780 return;
2781
Peter Zijlstra7d36b262011-07-26 13:13:44 +02002782 if (unlikely(current->hardirqs_enabled)) {
2783 /*
2784 * Neither irq nor preemption are disabled here
2785 * so this is racy by nature but losing one hit
2786 * in a stat is not a big deal.
2787 */
2788 __debug_atomic_inc(redundant_hardirqs_on);
2789 return;
2790 }
2791
Peter Zijlstra0119fee2011-09-02 01:30:29 +02002792 /*
2793 * We're enabling irqs and according to our state above irqs weren't
2794 * already enabled, yet we find the hardware thinks they are in fact
2795 * enabled.. someone messed up their IRQ state tracing.
2796 */
Peter Zijlstradd4e5d32011-06-21 17:17:27 +02002797 if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
2798 return;
2799
Peter Zijlstra0119fee2011-09-02 01:30:29 +02002800 /*
2801 * See the fine text that goes along with this variable definition.
2802 */
Peter Zijlstra7d36b262011-07-26 13:13:44 +02002803 if (DEBUG_LOCKS_WARN_ON(unlikely(early_boot_irqs_disabled)))
2804 return;
2805
Peter Zijlstra0119fee2011-09-02 01:30:29 +02002806 /*
2807 * Can't allow enabling interrupts while in an interrupt handler,
2808 * that's general bad form and such. Recursion, limited stack etc..
2809 */
Peter Zijlstra7d36b262011-07-26 13:13:44 +02002810 if (DEBUG_LOCKS_WARN_ON(current->hardirq_context))
2811 return;
2812
Peter Zijlstradd4e5d32011-06-21 17:17:27 +02002813 current->lockdep_recursion = 1;
2814 __trace_hardirqs_on_caller(ip);
2815 current->lockdep_recursion = 0;
2816}
Steven Rostedt81d68a92008-05-12 21:20:42 +02002817EXPORT_SYMBOL(trace_hardirqs_on_caller);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002818
Steven Rostedt1d09daa2008-05-12 21:20:55 +02002819void trace_hardirqs_on(void)
Steven Rostedt81d68a92008-05-12 21:20:42 +02002820{
2821 trace_hardirqs_on_caller(CALLER_ADDR0);
2822}
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002823EXPORT_SYMBOL(trace_hardirqs_on);
2824
2825/*
2826 * Hardirqs were disabled:
2827 */
Andi Kleenb35f8302014-02-08 08:52:02 +01002828__visible void trace_hardirqs_off_caller(unsigned long ip)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002829{
2830 struct task_struct *curr = current;
2831
Heiko Carstens6afe40b2008-10-28 11:14:58 +01002832 time_hardirqs_off(CALLER_ADDR0, ip);
Steven Rostedt81d68a92008-05-12 21:20:42 +02002833
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002834 if (unlikely(!debug_locks || current->lockdep_recursion))
2835 return;
2836
Peter Zijlstra0119fee2011-09-02 01:30:29 +02002837 /*
2838 * So we're supposed to get called after you mask local IRQs, but for
2839 * some reason the hardware doesn't quite think you did a proper job.
2840 */
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002841 if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
2842 return;
2843
2844 if (curr->hardirqs_enabled) {
2845 /*
2846 * We have done an ON -> OFF transition:
2847 */
2848 curr->hardirqs_enabled = 0;
Heiko Carstens6afe40b2008-10-28 11:14:58 +01002849 curr->hardirq_disable_ip = ip;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002850 curr->hardirq_disable_event = ++curr->irq_events;
Frederic Weisbeckerbd6d29c2010-04-06 00:10:17 +02002851 debug_atomic_inc(hardirqs_off_events);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002852 } else
Frederic Weisbeckerbd6d29c2010-04-06 00:10:17 +02002853 debug_atomic_inc(redundant_hardirqs_off);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002854}
Steven Rostedt81d68a92008-05-12 21:20:42 +02002855EXPORT_SYMBOL(trace_hardirqs_off_caller);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002856
Steven Rostedt1d09daa2008-05-12 21:20:55 +02002857void trace_hardirqs_off(void)
Steven Rostedt81d68a92008-05-12 21:20:42 +02002858{
2859 trace_hardirqs_off_caller(CALLER_ADDR0);
2860}
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002861EXPORT_SYMBOL(trace_hardirqs_off);
2862
2863/*
2864 * Softirqs will be enabled:
2865 */
2866void trace_softirqs_on(unsigned long ip)
2867{
2868 struct task_struct *curr = current;
2869
Peter Zijlstradd4e5d32011-06-21 17:17:27 +02002870 if (unlikely(!debug_locks || current->lockdep_recursion))
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002871 return;
2872
Peter Zijlstra0119fee2011-09-02 01:30:29 +02002873 /*
2874 * We fancy IRQs being disabled here, see softirq.c, avoids
2875 * funny state and nesting things.
2876 */
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002877 if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
2878 return;
2879
2880 if (curr->softirqs_enabled) {
Frederic Weisbeckerbd6d29c2010-04-06 00:10:17 +02002881 debug_atomic_inc(redundant_softirqs_on);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002882 return;
2883 }
2884
Peter Zijlstradd4e5d32011-06-21 17:17:27 +02002885 current->lockdep_recursion = 1;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002886 /*
2887 * We'll do an OFF -> ON transition:
2888 */
2889 curr->softirqs_enabled = 1;
2890 curr->softirq_enable_ip = ip;
2891 curr->softirq_enable_event = ++curr->irq_events;
Frederic Weisbeckerbd6d29c2010-04-06 00:10:17 +02002892 debug_atomic_inc(softirqs_on_events);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002893 /*
2894 * We are going to turn softirqs on, so set the
2895 * usage bit for all held locks, if hardirqs are
2896 * enabled too:
2897 */
2898 if (curr->hardirqs_enabled)
Nick Piggincf40bd12009-01-21 08:12:39 +01002899 mark_held_locks(curr, SOFTIRQ);
Peter Zijlstradd4e5d32011-06-21 17:17:27 +02002900 current->lockdep_recursion = 0;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002901}
2902
2903/*
2904 * Softirqs were disabled:
2905 */
2906void trace_softirqs_off(unsigned long ip)
2907{
2908 struct task_struct *curr = current;
2909
Peter Zijlstradd4e5d32011-06-21 17:17:27 +02002910 if (unlikely(!debug_locks || current->lockdep_recursion))
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002911 return;
2912
Peter Zijlstra0119fee2011-09-02 01:30:29 +02002913 /*
2914 * We fancy IRQs being disabled here, see softirq.c
2915 */
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002916 if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
2917 return;
2918
2919 if (curr->softirqs_enabled) {
2920 /*
2921 * We have done an ON -> OFF transition:
2922 */
2923 curr->softirqs_enabled = 0;
2924 curr->softirq_disable_ip = ip;
2925 curr->softirq_disable_event = ++curr->irq_events;
Frederic Weisbeckerbd6d29c2010-04-06 00:10:17 +02002926 debug_atomic_inc(softirqs_off_events);
Peter Zijlstra0119fee2011-09-02 01:30:29 +02002927 /*
2928 * Whoops, we wanted softirqs off, so why aren't they?
2929 */
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002930 DEBUG_LOCKS_WARN_ON(!softirq_count());
2931 } else
Frederic Weisbeckerbd6d29c2010-04-06 00:10:17 +02002932 debug_atomic_inc(redundant_softirqs_off);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002933}
2934
Peter Zijlstra8e182572007-07-19 01:48:54 -07002935static int mark_irqflags(struct task_struct *curr, struct held_lock *hlock)
2936{
2937 /*
2938 * If non-trylock use in a hardirq or softirq context, then
2939 * mark the lock as used in these contexts:
2940 */
2941 if (!hlock->trylock) {
2942 if (hlock->read) {
2943 if (curr->hardirq_context)
2944 if (!mark_lock(curr, hlock,
2945 LOCK_USED_IN_HARDIRQ_READ))
2946 return 0;
2947 if (curr->softirq_context)
2948 if (!mark_lock(curr, hlock,
2949 LOCK_USED_IN_SOFTIRQ_READ))
2950 return 0;
2951 } else {
2952 if (curr->hardirq_context)
2953 if (!mark_lock(curr, hlock, LOCK_USED_IN_HARDIRQ))
2954 return 0;
2955 if (curr->softirq_context)
2956 if (!mark_lock(curr, hlock, LOCK_USED_IN_SOFTIRQ))
2957 return 0;
2958 }
2959 }
2960 if (!hlock->hardirqs_off) {
2961 if (hlock->read) {
2962 if (!mark_lock(curr, hlock,
Peter Zijlstra4fc95e82009-01-22 13:10:52 +01002963 LOCK_ENABLED_HARDIRQ_READ))
Peter Zijlstra8e182572007-07-19 01:48:54 -07002964 return 0;
2965 if (curr->softirqs_enabled)
2966 if (!mark_lock(curr, hlock,
Peter Zijlstra4fc95e82009-01-22 13:10:52 +01002967 LOCK_ENABLED_SOFTIRQ_READ))
Peter Zijlstra8e182572007-07-19 01:48:54 -07002968 return 0;
2969 } else {
2970 if (!mark_lock(curr, hlock,
Peter Zijlstra4fc95e82009-01-22 13:10:52 +01002971 LOCK_ENABLED_HARDIRQ))
Peter Zijlstra8e182572007-07-19 01:48:54 -07002972 return 0;
2973 if (curr->softirqs_enabled)
2974 if (!mark_lock(curr, hlock,
Peter Zijlstra4fc95e82009-01-22 13:10:52 +01002975 LOCK_ENABLED_SOFTIRQ))
Peter Zijlstra8e182572007-07-19 01:48:54 -07002976 return 0;
2977 }
2978 }
2979
2980 return 1;
2981}
2982
Boqun Fengc2469752016-02-16 13:57:40 +08002983static inline unsigned int task_irq_context(struct task_struct *task)
2984{
2985 return 2 * !!task->hardirq_context + !!task->softirq_context;
2986}
2987
Peter Zijlstra8e182572007-07-19 01:48:54 -07002988static int separate_irq_context(struct task_struct *curr,
2989 struct held_lock *hlock)
2990{
2991 unsigned int depth = curr->lockdep_depth;
2992
2993 /*
2994 * Keep track of points where we cross into an interrupt context:
2995 */
Peter Zijlstra8e182572007-07-19 01:48:54 -07002996 if (depth) {
2997 struct held_lock *prev_hlock;
2998
2999 prev_hlock = curr->held_locks + depth-1;
3000 /*
3001 * If we cross into another context, reset the
3002 * hash key (this also prevents the checking and the
3003 * adding of the dependency to 'prev'):
3004 */
3005 if (prev_hlock->irq_context != hlock->irq_context)
3006 return 1;
3007 }
3008 return 0;
3009}
3010
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003011#else /* defined(CONFIG_TRACE_IRQFLAGS) && defined(CONFIG_PROVE_LOCKING) */
Peter Zijlstra8e182572007-07-19 01:48:54 -07003012
3013static inline
3014int mark_lock_irq(struct task_struct *curr, struct held_lock *this,
3015 enum lock_usage_bit new_bit)
3016{
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003017 WARN_ON(1); /* Impossible innit? when we don't have TRACE_IRQFLAG */
Peter Zijlstra8e182572007-07-19 01:48:54 -07003018 return 1;
3019}
3020
3021static inline int mark_irqflags(struct task_struct *curr,
3022 struct held_lock *hlock)
3023{
3024 return 1;
3025}
3026
Boqun Fengc2469752016-02-16 13:57:40 +08003027static inline unsigned int task_irq_context(struct task_struct *task)
3028{
3029 return 0;
3030}
3031
Peter Zijlstra8e182572007-07-19 01:48:54 -07003032static inline int separate_irq_context(struct task_struct *curr,
3033 struct held_lock *hlock)
3034{
3035 return 0;
3036}
3037
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003038#endif /* defined(CONFIG_TRACE_IRQFLAGS) && defined(CONFIG_PROVE_LOCKING) */
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003039
3040/*
Peter Zijlstra8e182572007-07-19 01:48:54 -07003041 * Mark a lock with a usage bit, and validate the state transition:
3042 */
Steven Rostedt1d09daa2008-05-12 21:20:55 +02003043static int mark_lock(struct task_struct *curr, struct held_lock *this,
Steven Rostedt0764d232008-05-12 21:20:44 +02003044 enum lock_usage_bit new_bit)
Peter Zijlstra8e182572007-07-19 01:48:54 -07003045{
3046 unsigned int new_mask = 1 << new_bit, ret = 1;
3047
3048 /*
3049 * If already set then do not dirty the cacheline,
3050 * nor do any checks:
3051 */
Dave Jonesf82b2172008-08-11 09:30:23 +02003052 if (likely(hlock_class(this)->usage_mask & new_mask))
Peter Zijlstra8e182572007-07-19 01:48:54 -07003053 return 1;
3054
3055 if (!graph_lock())
3056 return 0;
3057 /*
Lucas De Marchi25985ed2011-03-30 22:57:33 -03003058 * Make sure we didn't race:
Peter Zijlstra8e182572007-07-19 01:48:54 -07003059 */
Dave Jonesf82b2172008-08-11 09:30:23 +02003060 if (unlikely(hlock_class(this)->usage_mask & new_mask)) {
Peter Zijlstra8e182572007-07-19 01:48:54 -07003061 graph_unlock();
3062 return 1;
3063 }
3064
Dave Jonesf82b2172008-08-11 09:30:23 +02003065 hlock_class(this)->usage_mask |= new_mask;
Peter Zijlstra8e182572007-07-19 01:48:54 -07003066
Dave Jonesf82b2172008-08-11 09:30:23 +02003067 if (!save_trace(hlock_class(this)->usage_traces + new_bit))
Peter Zijlstra8e182572007-07-19 01:48:54 -07003068 return 0;
3069
3070 switch (new_bit) {
Peter Zijlstra53464172009-01-22 14:15:53 +01003071#define LOCKDEP_STATE(__STATE) \
3072 case LOCK_USED_IN_##__STATE: \
3073 case LOCK_USED_IN_##__STATE##_READ: \
3074 case LOCK_ENABLED_##__STATE: \
3075 case LOCK_ENABLED_##__STATE##_READ:
3076#include "lockdep_states.h"
3077#undef LOCKDEP_STATE
Peter Zijlstra8e182572007-07-19 01:48:54 -07003078 ret = mark_lock_irq(curr, this, new_bit);
3079 if (!ret)
3080 return 0;
3081 break;
3082 case LOCK_USED:
Frederic Weisbeckerbd6d29c2010-04-06 00:10:17 +02003083 debug_atomic_dec(nr_unused_locks);
Peter Zijlstra8e182572007-07-19 01:48:54 -07003084 break;
3085 default:
3086 if (!debug_locks_off_graph_unlock())
3087 return 0;
3088 WARN_ON(1);
3089 return 0;
3090 }
3091
3092 graph_unlock();
3093
3094 /*
3095 * We must printk outside of the graph_lock:
3096 */
3097 if (ret == 2) {
3098 printk("\nmarked lock as {%s}:\n", usage_str[new_bit]);
3099 print_lock(this);
3100 print_irqtrace_events(curr);
3101 dump_stack();
3102 }
3103
3104 return ret;
3105}
3106
3107/*
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003108 * Initialize a lock instance's lock-class mapping info:
3109 */
3110void lockdep_init_map(struct lockdep_map *lock, const char *name,
Peter Zijlstra4dfbb9d2006-10-11 01:45:14 -04003111 struct lock_class_key *key, int subclass)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003112{
Yong Zhangd3d03d42011-11-09 16:04:51 +08003113 int i;
3114
3115 kmemcheck_mark_initialized(lock, sizeof(*lock));
3116
3117 for (i = 0; i < NR_LOCKDEP_CACHING_CLASSES; i++)
3118 lock->class_cache[i] = NULL;
Hitoshi Mitake62016252010-10-05 18:01:51 +09003119
Peter Zijlstrac8a25002009-04-17 09:40:49 +02003120#ifdef CONFIG_LOCK_STAT
3121 lock->cpu = raw_smp_processor_id();
3122#endif
3123
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003124 /*
3125 * Can't be having no nameless bastards around this place!
3126 */
Peter Zijlstrac8a25002009-04-17 09:40:49 +02003127 if (DEBUG_LOCKS_WARN_ON(!name)) {
3128 lock->name = "NULL";
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003129 return;
Peter Zijlstrac8a25002009-04-17 09:40:49 +02003130 }
3131
3132 lock->name = name;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003133
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003134 /*
3135 * No key, no joy, we need to hash something.
3136 */
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003137 if (DEBUG_LOCKS_WARN_ON(!key))
3138 return;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003139 /*
3140 * Sanity check, the lock-class key must be persistent:
3141 */
3142 if (!static_obj(key)) {
3143 printk("BUG: key %p not in .data!\n", key);
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003144 /*
3145 * What it says above ^^^^^, I suggest you read it.
3146 */
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003147 DEBUG_LOCKS_WARN_ON(1);
3148 return;
3149 }
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003150 lock->key = key;
Peter Zijlstrac8a25002009-04-17 09:40:49 +02003151
3152 if (unlikely(!debug_locks))
3153 return;
3154
Peter Zijlstra35a93932015-02-26 16:23:11 +01003155 if (subclass) {
3156 unsigned long flags;
3157
3158 if (DEBUG_LOCKS_WARN_ON(current->lockdep_recursion))
3159 return;
3160
3161 raw_local_irq_save(flags);
3162 current->lockdep_recursion = 1;
Peter Zijlstra4dfbb9d2006-10-11 01:45:14 -04003163 register_lock_class(lock, subclass, 1);
Peter Zijlstra35a93932015-02-26 16:23:11 +01003164 current->lockdep_recursion = 0;
3165 raw_local_irq_restore(flags);
3166 }
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003167}
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003168EXPORT_SYMBOL_GPL(lockdep_init_map);
3169
Peter Zijlstra1704f472010-03-19 01:37:42 +01003170struct lock_class_key __lockdep_no_validate__;
Kent Overstreetea6749c2012-12-27 22:21:58 -08003171EXPORT_SYMBOL_GPL(__lockdep_no_validate__);
Peter Zijlstra1704f472010-03-19 01:37:42 +01003172
Maarten Lankhorstd0945952012-09-13 11:39:51 +02003173static int
3174print_lock_nested_lock_not_held(struct task_struct *curr,
3175 struct held_lock *hlock,
3176 unsigned long ip)
3177{
3178 if (!debug_locks_off())
3179 return 0;
3180 if (debug_locks_silent)
3181 return 0;
3182
Paul E. McKenney681fbec2017-05-04 15:44:38 -07003183 pr_warn("\n");
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08003184 pr_warn("==================================\n");
3185 pr_warn("WARNING: Nested lock was not taken\n");
Maarten Lankhorstd0945952012-09-13 11:39:51 +02003186 print_kernel_ident();
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08003187 pr_warn("----------------------------------\n");
Maarten Lankhorstd0945952012-09-13 11:39:51 +02003188
Paul E. McKenney681fbec2017-05-04 15:44:38 -07003189 pr_warn("%s/%d is trying to lock:\n", curr->comm, task_pid_nr(curr));
Maarten Lankhorstd0945952012-09-13 11:39:51 +02003190 print_lock(hlock);
3191
Paul E. McKenney681fbec2017-05-04 15:44:38 -07003192 pr_warn("\nbut this task is not holding:\n");
3193 pr_warn("%s\n", hlock->nest_lock->name);
Maarten Lankhorstd0945952012-09-13 11:39:51 +02003194
Paul E. McKenney681fbec2017-05-04 15:44:38 -07003195 pr_warn("\nstack backtrace:\n");
Maarten Lankhorstd0945952012-09-13 11:39:51 +02003196 dump_stack();
3197
Paul E. McKenney681fbec2017-05-04 15:44:38 -07003198 pr_warn("\nother info that might help us debug this:\n");
Maarten Lankhorstd0945952012-09-13 11:39:51 +02003199 lockdep_print_held_locks(curr);
3200
Paul E. McKenney681fbec2017-05-04 15:44:38 -07003201 pr_warn("\nstack backtrace:\n");
Maarten Lankhorstd0945952012-09-13 11:39:51 +02003202 dump_stack();
3203
3204 return 0;
3205}
3206
Peter Zijlstraf8319482016-11-30 14:32:25 +11003207static int __lock_is_held(struct lockdep_map *lock, int read);
Maarten Lankhorstd0945952012-09-13 11:39:51 +02003208
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003209/*
3210 * This gets called for every mutex_lock*()/spin_lock*() operation.
3211 * We maintain the dependency maps and validate the locking attempt:
3212 */
3213static int __lock_acquire(struct lockdep_map *lock, unsigned int subclass,
3214 int trylock, int read, int check, int hardirqs_off,
Peter Zijlstrabb97a912009-07-20 19:15:35 +02003215 struct lockdep_map *nest_lock, unsigned long ip,
Peter Zijlstra21199f22015-09-16 16:10:40 +02003216 int references, int pin_count)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003217{
3218 struct task_struct *curr = current;
Ingo Molnard6d897c2006-07-10 04:44:04 -07003219 struct lock_class *class = NULL;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003220 struct held_lock *hlock;
Alfredo Alvarez Fernandez5f18ab52016-02-11 00:33:32 +01003221 unsigned int depth;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003222 int chain_head = 0;
Peter Zijlstrabb97a912009-07-20 19:15:35 +02003223 int class_idx;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003224 u64 chain_key;
3225
3226 if (unlikely(!debug_locks))
3227 return 0;
3228
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003229 /*
3230 * Lockdep should run with IRQs disabled, otherwise we could
3231 * get an interrupt which would want to take locks, which would
3232 * end up in lockdep and have you got a head-ache already?
3233 */
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003234 if (DEBUG_LOCKS_WARN_ON(!irqs_disabled()))
3235 return 0;
3236
Oleg Nesterovfb9edbe2014-01-20 19:20:06 +01003237 if (!prove_locking || lock->key == &__lockdep_no_validate__)
3238 check = 0;
Peter Zijlstra1704f472010-03-19 01:37:42 +01003239
Hitoshi Mitake62016252010-10-05 18:01:51 +09003240 if (subclass < NR_LOCKDEP_CACHING_CLASSES)
3241 class = lock->class_cache[subclass];
Ingo Molnard6d897c2006-07-10 04:44:04 -07003242 /*
Hitoshi Mitake62016252010-10-05 18:01:51 +09003243 * Not cached?
Ingo Molnard6d897c2006-07-10 04:44:04 -07003244 */
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003245 if (unlikely(!class)) {
Peter Zijlstra4dfbb9d2006-10-11 01:45:14 -04003246 class = register_lock_class(lock, subclass, 0);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003247 if (!class)
3248 return 0;
3249 }
Frederic Weisbeckerbd6d29c2010-04-06 00:10:17 +02003250 atomic_inc((atomic_t *)&class->ops);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003251 if (very_verbose(class)) {
3252 printk("\nacquire class [%p] %s", class->key, class->name);
3253 if (class->name_version > 1)
Dmitry Vyukovf943fe02016-11-28 15:24:43 +01003254 printk(KERN_CONT "#%d", class->name_version);
3255 printk(KERN_CONT "\n");
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003256 dump_stack();
3257 }
3258
3259 /*
3260 * Add the lock to the list of currently held locks.
3261 * (we dont increase the depth just yet, up until the
3262 * dependency checks are done)
3263 */
3264 depth = curr->lockdep_depth;
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003265 /*
3266 * Ran out of static storage for our per-task lock stack again have we?
3267 */
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003268 if (DEBUG_LOCKS_WARN_ON(depth >= MAX_LOCK_DEPTH))
3269 return 0;
3270
Peter Zijlstrabb97a912009-07-20 19:15:35 +02003271 class_idx = class - lock_classes + 1;
3272
3273 if (depth) {
3274 hlock = curr->held_locks + depth - 1;
3275 if (hlock->class_idx == class_idx && nest_lock) {
Peter Zijlstra7fb4a2c2017-03-01 16:23:30 +01003276 if (hlock->references) {
3277 /*
3278 * Check: unsigned int references:12, overflow.
3279 */
3280 if (DEBUG_LOCKS_WARN_ON(hlock->references == (1 << 12)-1))
3281 return 0;
3282
Peter Zijlstrabb97a912009-07-20 19:15:35 +02003283 hlock->references++;
Peter Zijlstra7fb4a2c2017-03-01 16:23:30 +01003284 } else {
Peter Zijlstrabb97a912009-07-20 19:15:35 +02003285 hlock->references = 2;
Peter Zijlstra7fb4a2c2017-03-01 16:23:30 +01003286 }
Peter Zijlstrabb97a912009-07-20 19:15:35 +02003287
3288 return 1;
3289 }
3290 }
3291
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003292 hlock = curr->held_locks + depth;
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003293 /*
3294 * Plain impossible, we just registered it and checked it weren't no
3295 * NULL like.. I bet this mushroom I ate was good!
3296 */
Dave Jonesf82b2172008-08-11 09:30:23 +02003297 if (DEBUG_LOCKS_WARN_ON(!class))
3298 return 0;
Peter Zijlstrabb97a912009-07-20 19:15:35 +02003299 hlock->class_idx = class_idx;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003300 hlock->acquire_ip = ip;
3301 hlock->instance = lock;
Peter Zijlstra7531e2f2008-08-11 09:30:24 +02003302 hlock->nest_lock = nest_lock;
Boqun Fengc2469752016-02-16 13:57:40 +08003303 hlock->irq_context = task_irq_context(curr);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003304 hlock->trylock = trylock;
3305 hlock->read = read;
3306 hlock->check = check;
Dmitry Baryshkov6951b122008-08-18 04:26:37 +04003307 hlock->hardirqs_off = !!hardirqs_off;
Peter Zijlstrabb97a912009-07-20 19:15:35 +02003308 hlock->references = references;
Peter Zijlstraf20786f2007-07-19 01:48:56 -07003309#ifdef CONFIG_LOCK_STAT
3310 hlock->waittime_stamp = 0;
Peter Zijlstra3365e7792009-10-09 10:12:41 +02003311 hlock->holdtime_stamp = lockstat_clock();
Peter Zijlstraf20786f2007-07-19 01:48:56 -07003312#endif
Peter Zijlstra21199f22015-09-16 16:10:40 +02003313 hlock->pin_count = pin_count;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003314
Oleg Nesterovfb9edbe2014-01-20 19:20:06 +01003315 if (check && !mark_irqflags(curr, hlock))
Peter Zijlstra8e182572007-07-19 01:48:54 -07003316 return 0;
3317
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003318 /* mark it as used: */
Jarek Poplawski4ff773bb2007-05-08 00:31:00 -07003319 if (!mark_lock(curr, hlock, LOCK_USED))
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003320 return 0;
Peter Zijlstra8e182572007-07-19 01:48:54 -07003321
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003322 /*
Gautham R Shenoy17aacfb92007-10-28 20:47:01 +01003323 * Calculate the chain hash: it's the combined hash of all the
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003324 * lock keys along the dependency chain. We save the hash value
3325 * at every step so that we can get the current hash easily
3326 * after unlock. The chain hash is then used to cache dependency
3327 * results.
3328 *
3329 * The 'key ID' is what is the most compact key value to drive
3330 * the hash, not class->key.
3331 */
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003332 /*
3333 * Whoops, we did it again.. ran straight out of our static allocation.
3334 */
Alfredo Alvarez Fernandez5f18ab52016-02-11 00:33:32 +01003335 if (DEBUG_LOCKS_WARN_ON(class_idx > MAX_LOCKDEP_KEYS))
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003336 return 0;
3337
3338 chain_key = curr->curr_chain_key;
3339 if (!depth) {
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003340 /*
3341 * How can we have a chain hash when we ain't got no keys?!
3342 */
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003343 if (DEBUG_LOCKS_WARN_ON(chain_key != 0))
3344 return 0;
3345 chain_head = 1;
3346 }
3347
3348 hlock->prev_chain_key = chain_key;
Peter Zijlstra8e182572007-07-19 01:48:54 -07003349 if (separate_irq_context(curr, hlock)) {
3350 chain_key = 0;
3351 chain_head = 1;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003352 }
Alfredo Alvarez Fernandez5f18ab52016-02-11 00:33:32 +01003353 chain_key = iterate_chain_key(chain_key, class_idx);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003354
Peter Zijlstraf8319482016-11-30 14:32:25 +11003355 if (nest_lock && !__lock_is_held(nest_lock, -1))
Maarten Lankhorstd0945952012-09-13 11:39:51 +02003356 return print_lock_nested_lock_not_held(curr, hlock, ip);
3357
Gregory Haskins3aa416b2007-10-11 22:11:11 +02003358 if (!validate_chain(curr, lock, hlock, chain_head, chain_key))
Peter Zijlstra8e182572007-07-19 01:48:54 -07003359 return 0;
Jarek Poplawski381a2292007-02-10 01:44:58 -08003360
Gregory Haskins3aa416b2007-10-11 22:11:11 +02003361 curr->curr_chain_key = chain_key;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003362 curr->lockdep_depth++;
3363 check_chain_key(curr);
Jarek Poplawski60e114d2007-02-20 13:58:00 -08003364#ifdef CONFIG_DEBUG_LOCKDEP
3365 if (unlikely(!debug_locks))
3366 return 0;
3367#endif
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003368 if (unlikely(curr->lockdep_depth >= MAX_LOCK_DEPTH)) {
3369 debug_locks_off();
Dave Jones2c522832013-04-25 13:40:02 -04003370 print_lockdep_off("BUG: MAX_LOCK_DEPTH too low!");
3371 printk(KERN_DEBUG "depth: %i max: %lu!\n",
Ben Greearc0540602013-02-06 10:56:19 -08003372 curr->lockdep_depth, MAX_LOCK_DEPTH);
Ben Greearc0540602013-02-06 10:56:19 -08003373
3374 lockdep_print_held_locks(current);
3375 debug_show_all_locks();
Peter Zijlstraeedeeab2009-03-18 12:38:47 +01003376 dump_stack();
Ben Greearc0540602013-02-06 10:56:19 -08003377
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003378 return 0;
3379 }
Jarek Poplawski381a2292007-02-10 01:44:58 -08003380
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003381 if (unlikely(curr->lockdep_depth > max_lockdep_depth))
3382 max_lockdep_depth = curr->lockdep_depth;
3383
3384 return 1;
3385}
3386
3387static int
Srivatsa S. Bhatf86f7552013-01-08 18:35:58 +05303388print_unlock_imbalance_bug(struct task_struct *curr, struct lockdep_map *lock,
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003389 unsigned long ip)
3390{
3391 if (!debug_locks_off())
3392 return 0;
3393 if (debug_locks_silent)
3394 return 0;
3395
Paul E. McKenney681fbec2017-05-04 15:44:38 -07003396 pr_warn("\n");
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08003397 pr_warn("=====================================\n");
3398 pr_warn("WARNING: bad unlock balance detected!\n");
Ben Hutchingsfbdc4b92011-10-28 04:36:55 +01003399 print_kernel_ident();
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08003400 pr_warn("-------------------------------------\n");
Paul E. McKenney681fbec2017-05-04 15:44:38 -07003401 pr_warn("%s/%d is trying to release lock (",
Pavel Emelyanovba25f9d2007-10-18 23:40:40 -07003402 curr->comm, task_pid_nr(curr));
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003403 print_lockdep_cache(lock);
Paul E. McKenney681fbec2017-05-04 15:44:38 -07003404 pr_cont(") at:\n");
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003405 print_ip_sym(ip);
Paul E. McKenney681fbec2017-05-04 15:44:38 -07003406 pr_warn("but there are no more locks to release!\n");
3407 pr_warn("\nother info that might help us debug this:\n");
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003408 lockdep_print_held_locks(curr);
3409
Paul E. McKenney681fbec2017-05-04 15:44:38 -07003410 pr_warn("\nstack backtrace:\n");
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003411 dump_stack();
3412
3413 return 0;
3414}
3415
Peter Zijlstrabb97a912009-07-20 19:15:35 +02003416static int match_held_lock(struct held_lock *hlock, struct lockdep_map *lock)
3417{
3418 if (hlock->instance == lock)
3419 return 1;
3420
3421 if (hlock->references) {
Hitoshi Mitake62016252010-10-05 18:01:51 +09003422 struct lock_class *class = lock->class_cache[0];
Peter Zijlstrabb97a912009-07-20 19:15:35 +02003423
3424 if (!class)
3425 class = look_up_lock_class(lock, 0);
3426
Peter Zijlstra80e04012011-08-05 14:26:17 +02003427 /*
3428 * If look_up_lock_class() failed to find a class, we're trying
3429 * to test if we hold a lock that has never yet been acquired.
3430 * Clearly if the lock hasn't been acquired _ever_, we're not
3431 * holding it either, so report failure.
3432 */
Thomas Gleixner383776f2017-02-27 15:37:36 +01003433 if (IS_ERR_OR_NULL(class))
Peter Zijlstrabb97a912009-07-20 19:15:35 +02003434 return 0;
3435
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003436 /*
3437 * References, but not a lock we're actually ref-counting?
3438 * State got messed up, follow the sites that change ->references
3439 * and try to make sense of it.
3440 */
Peter Zijlstrabb97a912009-07-20 19:15:35 +02003441 if (DEBUG_LOCKS_WARN_ON(!hlock->nest_lock))
3442 return 0;
3443
3444 if (hlock->class_idx == class - lock_classes + 1)
3445 return 1;
3446 }
3447
3448 return 0;
3449}
3450
J. R. Okajima41c2c5b2017-02-03 01:38:15 +09003451/* @depth must not be zero */
3452static struct held_lock *find_held_lock(struct task_struct *curr,
3453 struct lockdep_map *lock,
3454 unsigned int depth, int *idx)
3455{
3456 struct held_lock *ret, *hlock, *prev_hlock;
3457 int i;
3458
3459 i = depth - 1;
3460 hlock = curr->held_locks + i;
3461 ret = hlock;
3462 if (match_held_lock(hlock, lock))
3463 goto out;
3464
3465 ret = NULL;
3466 for (i--, prev_hlock = hlock--;
3467 i >= 0;
3468 i--, prev_hlock = hlock--) {
3469 /*
3470 * We must not cross into another context:
3471 */
3472 if (prev_hlock->irq_context != hlock->irq_context) {
3473 ret = NULL;
3474 break;
3475 }
3476 if (match_held_lock(hlock, lock)) {
3477 ret = hlock;
3478 break;
3479 }
3480 }
3481
3482out:
3483 *idx = i;
3484 return ret;
3485}
3486
J. R. Okajimae9699702017-02-03 01:38:16 +09003487static int reacquire_held_locks(struct task_struct *curr, unsigned int depth,
3488 int idx)
3489{
3490 struct held_lock *hlock;
3491
3492 for (hlock = curr->held_locks + idx; idx < depth; idx++, hlock++) {
3493 if (!__lock_acquire(hlock->instance,
3494 hlock_class(hlock)->subclass,
3495 hlock->trylock,
3496 hlock->read, hlock->check,
3497 hlock->hardirqs_off,
3498 hlock->nest_lock, hlock->acquire_ip,
3499 hlock->references, hlock->pin_count))
3500 return 1;
3501 }
3502 return 0;
3503}
3504
Peter Zijlstra64aa3482008-08-11 09:30:21 +02003505static int
Peter Zijlstra00ef9f72008-12-04 09:00:17 +01003506__lock_set_class(struct lockdep_map *lock, const char *name,
3507 struct lock_class_key *key, unsigned int subclass,
3508 unsigned long ip)
Peter Zijlstra64aa3482008-08-11 09:30:21 +02003509{
3510 struct task_struct *curr = current;
J. R. Okajima41c2c5b2017-02-03 01:38:15 +09003511 struct held_lock *hlock;
Peter Zijlstra64aa3482008-08-11 09:30:21 +02003512 struct lock_class *class;
3513 unsigned int depth;
3514 int i;
3515
3516 depth = curr->lockdep_depth;
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003517 /*
3518 * This function is about (re)setting the class of a held lock,
3519 * yet we're not actually holding any locks. Naughty user!
3520 */
Peter Zijlstra64aa3482008-08-11 09:30:21 +02003521 if (DEBUG_LOCKS_WARN_ON(!depth))
3522 return 0;
3523
J. R. Okajima41c2c5b2017-02-03 01:38:15 +09003524 hlock = find_held_lock(curr, lock, depth, &i);
3525 if (!hlock)
3526 return print_unlock_imbalance_bug(curr, lock, ip);
Peter Zijlstra64aa3482008-08-11 09:30:21 +02003527
Peter Zijlstra00ef9f72008-12-04 09:00:17 +01003528 lockdep_init_map(lock, name, key, 0);
Peter Zijlstra64aa3482008-08-11 09:30:21 +02003529 class = register_lock_class(lock, subclass, 0);
Dave Jonesf82b2172008-08-11 09:30:23 +02003530 hlock->class_idx = class - lock_classes + 1;
Peter Zijlstra64aa3482008-08-11 09:30:21 +02003531
3532 curr->lockdep_depth = i;
3533 curr->curr_chain_key = hlock->prev_chain_key;
3534
J. R. Okajimae9699702017-02-03 01:38:16 +09003535 if (reacquire_held_locks(curr, depth, i))
3536 return 0;
Peter Zijlstra64aa3482008-08-11 09:30:21 +02003537
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003538 /*
3539 * I took it apart and put it back together again, except now I have
3540 * these 'spare' parts.. where shall I put them.
3541 */
Peter Zijlstra64aa3482008-08-11 09:30:21 +02003542 if (DEBUG_LOCKS_WARN_ON(curr->lockdep_depth != depth))
3543 return 0;
3544 return 1;
3545}
3546
J. R. Okajima6419c4a2017-02-03 01:38:17 +09003547static int __lock_downgrade(struct lockdep_map *lock, unsigned long ip)
3548{
3549 struct task_struct *curr = current;
3550 struct held_lock *hlock;
3551 unsigned int depth;
3552 int i;
3553
3554 depth = curr->lockdep_depth;
3555 /*
3556 * This function is about (re)setting the class of a held lock,
3557 * yet we're not actually holding any locks. Naughty user!
3558 */
3559 if (DEBUG_LOCKS_WARN_ON(!depth))
3560 return 0;
3561
3562 hlock = find_held_lock(curr, lock, depth, &i);
3563 if (!hlock)
3564 return print_unlock_imbalance_bug(curr, lock, ip);
3565
3566 curr->lockdep_depth = i;
3567 curr->curr_chain_key = hlock->prev_chain_key;
3568
3569 WARN(hlock->read, "downgrading a read lock");
3570 hlock->read = 1;
3571 hlock->acquire_ip = ip;
3572
3573 if (reacquire_held_locks(curr, depth, i))
3574 return 0;
3575
3576 /*
3577 * I took it apart and put it back together again, except now I have
3578 * these 'spare' parts.. where shall I put them.
3579 */
3580 if (DEBUG_LOCKS_WARN_ON(curr->lockdep_depth != depth))
3581 return 0;
3582 return 1;
3583}
3584
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003585/*
Peter Zijlstrae0f56fd2015-06-11 14:46:52 +02003586 * Remove the lock to the list of currently held locks - this gets
3587 * called on mutex_unlock()/spin_unlock*() (or on a failed
3588 * mutex_lock_interruptible()).
3589 *
3590 * @nested is an hysterical artifact, needs a tree wide cleanup.
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003591 */
3592static int
Peter Zijlstrae0f56fd2015-06-11 14:46:52 +02003593__lock_release(struct lockdep_map *lock, int nested, unsigned long ip)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003594{
Peter Zijlstrae0f56fd2015-06-11 14:46:52 +02003595 struct task_struct *curr = current;
J. R. Okajima41c2c5b2017-02-03 01:38:15 +09003596 struct held_lock *hlock;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003597 unsigned int depth;
3598 int i;
3599
Peter Zijlstrae0f56fd2015-06-11 14:46:52 +02003600 if (unlikely(!debug_locks))
3601 return 0;
3602
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003603 depth = curr->lockdep_depth;
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003604 /*
3605 * So we're all set to release this lock.. wait what lock? We don't
3606 * own any locks, you've been drinking again?
3607 */
Peter Zijlstrae0f56fd2015-06-11 14:46:52 +02003608 if (DEBUG_LOCKS_WARN_ON(depth <= 0))
3609 return print_unlock_imbalance_bug(curr, lock, ip);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003610
Peter Zijlstrae0f56fd2015-06-11 14:46:52 +02003611 /*
3612 * Check whether the lock exists in the current stack
3613 * of held locks:
3614 */
J. R. Okajima41c2c5b2017-02-03 01:38:15 +09003615 hlock = find_held_lock(curr, lock, depth, &i);
3616 if (!hlock)
3617 return print_unlock_imbalance_bug(curr, lock, ip);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003618
Peter Zijlstrabb97a912009-07-20 19:15:35 +02003619 if (hlock->instance == lock)
3620 lock_release_holdtime(hlock);
3621
Peter Zijlstraa24fc602015-06-11 14:46:53 +02003622 WARN(hlock->pin_count, "releasing a pinned lock\n");
3623
Peter Zijlstrabb97a912009-07-20 19:15:35 +02003624 if (hlock->references) {
3625 hlock->references--;
3626 if (hlock->references) {
3627 /*
3628 * We had, and after removing one, still have
3629 * references, the current lock stack is still
3630 * valid. We're done!
3631 */
3632 return 1;
3633 }
3634 }
Peter Zijlstraf20786f2007-07-19 01:48:56 -07003635
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003636 /*
3637 * We have the right lock to unlock, 'hlock' points to it.
3638 * Now we remove it from the stack, and add back the other
3639 * entries (if any), recalculating the hash along the way:
3640 */
Peter Zijlstrabb97a912009-07-20 19:15:35 +02003641
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003642 curr->lockdep_depth = i;
3643 curr->curr_chain_key = hlock->prev_chain_key;
3644
J. R. Okajimae9699702017-02-03 01:38:16 +09003645 if (reacquire_held_locks(curr, depth, i + 1))
3646 return 0;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003647
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003648 /*
3649 * We had N bottles of beer on the wall, we drank one, but now
3650 * there's not N-1 bottles of beer left on the wall...
3651 */
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003652 if (DEBUG_LOCKS_WARN_ON(curr->lockdep_depth != depth - 1))
3653 return 0;
Peter Zijlstrae0f56fd2015-06-11 14:46:52 +02003654
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003655 return 1;
3656}
3657
Peter Zijlstraf8319482016-11-30 14:32:25 +11003658static int __lock_is_held(struct lockdep_map *lock, int read)
Peter Zijlstraf607c662009-07-20 19:16:29 +02003659{
3660 struct task_struct *curr = current;
3661 int i;
3662
3663 for (i = 0; i < curr->lockdep_depth; i++) {
Peter Zijlstrabb97a912009-07-20 19:15:35 +02003664 struct held_lock *hlock = curr->held_locks + i;
3665
Peter Zijlstraf8319482016-11-30 14:32:25 +11003666 if (match_held_lock(hlock, lock)) {
3667 if (read == -1 || hlock->read == read)
3668 return 1;
3669
3670 return 0;
3671 }
Peter Zijlstraf607c662009-07-20 19:16:29 +02003672 }
3673
3674 return 0;
3675}
3676
Peter Zijlstrae7904a22015-08-01 19:25:08 +02003677static struct pin_cookie __lock_pin_lock(struct lockdep_map *lock)
3678{
3679 struct pin_cookie cookie = NIL_COOKIE;
3680 struct task_struct *curr = current;
3681 int i;
3682
3683 if (unlikely(!debug_locks))
3684 return cookie;
3685
3686 for (i = 0; i < curr->lockdep_depth; i++) {
3687 struct held_lock *hlock = curr->held_locks + i;
3688
3689 if (match_held_lock(hlock, lock)) {
3690 /*
3691 * Grab 16bits of randomness; this is sufficient to not
3692 * be guessable and still allows some pin nesting in
3693 * our u32 pin_count.
3694 */
3695 cookie.val = 1 + (prandom_u32() >> 16);
3696 hlock->pin_count += cookie.val;
3697 return cookie;
3698 }
3699 }
3700
3701 WARN(1, "pinning an unheld lock\n");
3702 return cookie;
3703}
3704
3705static void __lock_repin_lock(struct lockdep_map *lock, struct pin_cookie cookie)
Peter Zijlstraa24fc602015-06-11 14:46:53 +02003706{
3707 struct task_struct *curr = current;
3708 int i;
3709
3710 if (unlikely(!debug_locks))
3711 return;
3712
3713 for (i = 0; i < curr->lockdep_depth; i++) {
3714 struct held_lock *hlock = curr->held_locks + i;
3715
3716 if (match_held_lock(hlock, lock)) {
Peter Zijlstrae7904a22015-08-01 19:25:08 +02003717 hlock->pin_count += cookie.val;
Peter Zijlstraa24fc602015-06-11 14:46:53 +02003718 return;
3719 }
3720 }
3721
3722 WARN(1, "pinning an unheld lock\n");
3723}
3724
Peter Zijlstrae7904a22015-08-01 19:25:08 +02003725static void __lock_unpin_lock(struct lockdep_map *lock, struct pin_cookie cookie)
Peter Zijlstraa24fc602015-06-11 14:46:53 +02003726{
3727 struct task_struct *curr = current;
3728 int i;
3729
3730 if (unlikely(!debug_locks))
3731 return;
3732
3733 for (i = 0; i < curr->lockdep_depth; i++) {
3734 struct held_lock *hlock = curr->held_locks + i;
3735
3736 if (match_held_lock(hlock, lock)) {
3737 if (WARN(!hlock->pin_count, "unpinning an unpinned lock\n"))
3738 return;
3739
Peter Zijlstrae7904a22015-08-01 19:25:08 +02003740 hlock->pin_count -= cookie.val;
3741
3742 if (WARN((int)hlock->pin_count < 0, "pin count corrupted\n"))
3743 hlock->pin_count = 0;
3744
Peter Zijlstraa24fc602015-06-11 14:46:53 +02003745 return;
3746 }
3747 }
3748
3749 WARN(1, "unpinning an unheld lock\n");
3750}
3751
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003752/*
3753 * Check whether we follow the irq-flags state precisely:
3754 */
Steven Rostedt1d09daa2008-05-12 21:20:55 +02003755static void check_flags(unsigned long flags)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003756{
Ingo Molnar992860e2008-07-14 10:28:38 +02003757#if defined(CONFIG_PROVE_LOCKING) && defined(CONFIG_DEBUG_LOCKDEP) && \
3758 defined(CONFIG_TRACE_IRQFLAGS)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003759 if (!debug_locks)
3760 return;
3761
Ingo Molnar5f9fa8a62007-12-07 19:02:47 +01003762 if (irqs_disabled_flags(flags)) {
3763 if (DEBUG_LOCKS_WARN_ON(current->hardirqs_enabled)) {
3764 printk("possible reason: unannotated irqs-off.\n");
3765 }
3766 } else {
3767 if (DEBUG_LOCKS_WARN_ON(!current->hardirqs_enabled)) {
3768 printk("possible reason: unannotated irqs-on.\n");
3769 }
3770 }
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003771
3772 /*
3773 * We dont accurately track softirq state in e.g.
3774 * hardirq contexts (such as on 4KSTACKS), so only
3775 * check if not in hardirq contexts:
3776 */
3777 if (!hardirq_count()) {
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003778 if (softirq_count()) {
3779 /* like the above, but with softirqs */
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003780 DEBUG_LOCKS_WARN_ON(current->softirqs_enabled);
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003781 } else {
3782 /* lick the above, does it taste good? */
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003783 DEBUG_LOCKS_WARN_ON(!current->softirqs_enabled);
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003784 }
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003785 }
3786
3787 if (!debug_locks)
3788 print_irqtrace_events(current);
3789#endif
3790}
3791
Peter Zijlstra00ef9f72008-12-04 09:00:17 +01003792void lock_set_class(struct lockdep_map *lock, const char *name,
3793 struct lock_class_key *key, unsigned int subclass,
3794 unsigned long ip)
Peter Zijlstra64aa3482008-08-11 09:30:21 +02003795{
3796 unsigned long flags;
3797
3798 if (unlikely(current->lockdep_recursion))
3799 return;
3800
3801 raw_local_irq_save(flags);
3802 current->lockdep_recursion = 1;
3803 check_flags(flags);
Peter Zijlstra00ef9f72008-12-04 09:00:17 +01003804 if (__lock_set_class(lock, name, key, subclass, ip))
Peter Zijlstra64aa3482008-08-11 09:30:21 +02003805 check_chain_key(current);
3806 current->lockdep_recursion = 0;
3807 raw_local_irq_restore(flags);
3808}
Peter Zijlstra00ef9f72008-12-04 09:00:17 +01003809EXPORT_SYMBOL_GPL(lock_set_class);
Peter Zijlstra64aa3482008-08-11 09:30:21 +02003810
J. R. Okajima6419c4a2017-02-03 01:38:17 +09003811void lock_downgrade(struct lockdep_map *lock, unsigned long ip)
3812{
3813 unsigned long flags;
3814
3815 if (unlikely(current->lockdep_recursion))
3816 return;
3817
3818 raw_local_irq_save(flags);
3819 current->lockdep_recursion = 1;
3820 check_flags(flags);
3821 if (__lock_downgrade(lock, ip))
3822 check_chain_key(current);
3823 current->lockdep_recursion = 0;
3824 raw_local_irq_restore(flags);
3825}
3826EXPORT_SYMBOL_GPL(lock_downgrade);
3827
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003828/*
3829 * We are not always called with irqs disabled - do that here,
3830 * and also avoid lockdep recursion:
3831 */
Steven Rostedt1d09daa2008-05-12 21:20:55 +02003832void lock_acquire(struct lockdep_map *lock, unsigned int subclass,
Peter Zijlstra7531e2f2008-08-11 09:30:24 +02003833 int trylock, int read, int check,
3834 struct lockdep_map *nest_lock, unsigned long ip)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003835{
3836 unsigned long flags;
3837
3838 if (unlikely(current->lockdep_recursion))
3839 return;
3840
3841 raw_local_irq_save(flags);
3842 check_flags(flags);
3843
3844 current->lockdep_recursion = 1;
Frederic Weisbeckerdb2c4c72010-02-02 23:34:40 +01003845 trace_lock_acquire(lock, subclass, trylock, read, check, nest_lock, ip);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003846 __lock_acquire(lock, subclass, trylock, read, check,
Peter Zijlstra21199f22015-09-16 16:10:40 +02003847 irqs_disabled_flags(flags), nest_lock, ip, 0, 0);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003848 current->lockdep_recursion = 0;
3849 raw_local_irq_restore(flags);
3850}
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003851EXPORT_SYMBOL_GPL(lock_acquire);
3852
Steven Rostedt1d09daa2008-05-12 21:20:55 +02003853void lock_release(struct lockdep_map *lock, int nested,
Steven Rostedt0764d232008-05-12 21:20:44 +02003854 unsigned long ip)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003855{
3856 unsigned long flags;
3857
3858 if (unlikely(current->lockdep_recursion))
3859 return;
3860
3861 raw_local_irq_save(flags);
3862 check_flags(flags);
3863 current->lockdep_recursion = 1;
Frederic Weisbecker93135432010-05-08 06:24:25 +02003864 trace_lock_release(lock, ip);
Peter Zijlstrae0f56fd2015-06-11 14:46:52 +02003865 if (__lock_release(lock, nested, ip))
3866 check_chain_key(current);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003867 current->lockdep_recursion = 0;
3868 raw_local_irq_restore(flags);
3869}
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07003870EXPORT_SYMBOL_GPL(lock_release);
3871
Peter Zijlstraf8319482016-11-30 14:32:25 +11003872int lock_is_held_type(struct lockdep_map *lock, int read)
Peter Zijlstraf607c662009-07-20 19:16:29 +02003873{
3874 unsigned long flags;
3875 int ret = 0;
3876
3877 if (unlikely(current->lockdep_recursion))
Peter Zijlstraf2513cd2011-06-06 12:32:43 +02003878 return 1; /* avoid false negative lockdep_assert_held() */
Peter Zijlstraf607c662009-07-20 19:16:29 +02003879
3880 raw_local_irq_save(flags);
3881 check_flags(flags);
3882
3883 current->lockdep_recursion = 1;
Peter Zijlstraf8319482016-11-30 14:32:25 +11003884 ret = __lock_is_held(lock, read);
Peter Zijlstraf607c662009-07-20 19:16:29 +02003885 current->lockdep_recursion = 0;
3886 raw_local_irq_restore(flags);
3887
3888 return ret;
3889}
Peter Zijlstraf8319482016-11-30 14:32:25 +11003890EXPORT_SYMBOL_GPL(lock_is_held_type);
Peter Zijlstraf607c662009-07-20 19:16:29 +02003891
Peter Zijlstrae7904a22015-08-01 19:25:08 +02003892struct pin_cookie lock_pin_lock(struct lockdep_map *lock)
Peter Zijlstraa24fc602015-06-11 14:46:53 +02003893{
Peter Zijlstrae7904a22015-08-01 19:25:08 +02003894 struct pin_cookie cookie = NIL_COOKIE;
Peter Zijlstraa24fc602015-06-11 14:46:53 +02003895 unsigned long flags;
3896
3897 if (unlikely(current->lockdep_recursion))
Peter Zijlstrae7904a22015-08-01 19:25:08 +02003898 return cookie;
Peter Zijlstraa24fc602015-06-11 14:46:53 +02003899
3900 raw_local_irq_save(flags);
3901 check_flags(flags);
3902
3903 current->lockdep_recursion = 1;
Peter Zijlstrae7904a22015-08-01 19:25:08 +02003904 cookie = __lock_pin_lock(lock);
Peter Zijlstraa24fc602015-06-11 14:46:53 +02003905 current->lockdep_recursion = 0;
3906 raw_local_irq_restore(flags);
Peter Zijlstrae7904a22015-08-01 19:25:08 +02003907
3908 return cookie;
Peter Zijlstraa24fc602015-06-11 14:46:53 +02003909}
3910EXPORT_SYMBOL_GPL(lock_pin_lock);
3911
Peter Zijlstrae7904a22015-08-01 19:25:08 +02003912void lock_repin_lock(struct lockdep_map *lock, struct pin_cookie cookie)
Peter Zijlstraa24fc602015-06-11 14:46:53 +02003913{
3914 unsigned long flags;
3915
3916 if (unlikely(current->lockdep_recursion))
3917 return;
3918
3919 raw_local_irq_save(flags);
3920 check_flags(flags);
3921
3922 current->lockdep_recursion = 1;
Peter Zijlstrae7904a22015-08-01 19:25:08 +02003923 __lock_repin_lock(lock, cookie);
3924 current->lockdep_recursion = 0;
3925 raw_local_irq_restore(flags);
3926}
3927EXPORT_SYMBOL_GPL(lock_repin_lock);
3928
3929void lock_unpin_lock(struct lockdep_map *lock, struct pin_cookie cookie)
3930{
3931 unsigned long flags;
3932
3933 if (unlikely(current->lockdep_recursion))
3934 return;
3935
3936 raw_local_irq_save(flags);
3937 check_flags(flags);
3938
3939 current->lockdep_recursion = 1;
3940 __lock_unpin_lock(lock, cookie);
Peter Zijlstraa24fc602015-06-11 14:46:53 +02003941 current->lockdep_recursion = 0;
3942 raw_local_irq_restore(flags);
3943}
3944EXPORT_SYMBOL_GPL(lock_unpin_lock);
3945
Peter Zijlstraf20786f2007-07-19 01:48:56 -07003946#ifdef CONFIG_LOCK_STAT
3947static int
3948print_lock_contention_bug(struct task_struct *curr, struct lockdep_map *lock,
3949 unsigned long ip)
3950{
3951 if (!debug_locks_off())
3952 return 0;
3953 if (debug_locks_silent)
3954 return 0;
3955
Paul E. McKenney681fbec2017-05-04 15:44:38 -07003956 pr_warn("\n");
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08003957 pr_warn("=================================\n");
3958 pr_warn("WARNING: bad contention detected!\n");
Ben Hutchingsfbdc4b92011-10-28 04:36:55 +01003959 print_kernel_ident();
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08003960 pr_warn("---------------------------------\n");
Paul E. McKenney681fbec2017-05-04 15:44:38 -07003961 pr_warn("%s/%d is trying to contend lock (",
Pavel Emelyanovba25f9d2007-10-18 23:40:40 -07003962 curr->comm, task_pid_nr(curr));
Peter Zijlstraf20786f2007-07-19 01:48:56 -07003963 print_lockdep_cache(lock);
Paul E. McKenney681fbec2017-05-04 15:44:38 -07003964 pr_cont(") at:\n");
Peter Zijlstraf20786f2007-07-19 01:48:56 -07003965 print_ip_sym(ip);
Paul E. McKenney681fbec2017-05-04 15:44:38 -07003966 pr_warn("but there are no locks held!\n");
3967 pr_warn("\nother info that might help us debug this:\n");
Peter Zijlstraf20786f2007-07-19 01:48:56 -07003968 lockdep_print_held_locks(curr);
3969
Paul E. McKenney681fbec2017-05-04 15:44:38 -07003970 pr_warn("\nstack backtrace:\n");
Peter Zijlstraf20786f2007-07-19 01:48:56 -07003971 dump_stack();
3972
3973 return 0;
3974}
3975
3976static void
3977__lock_contended(struct lockdep_map *lock, unsigned long ip)
3978{
3979 struct task_struct *curr = current;
J. R. Okajima41c2c5b2017-02-03 01:38:15 +09003980 struct held_lock *hlock;
Peter Zijlstraf20786f2007-07-19 01:48:56 -07003981 struct lock_class_stats *stats;
3982 unsigned int depth;
Peter Zijlstrac7e78cf2008-10-16 23:17:09 +02003983 int i, contention_point, contending_point;
Peter Zijlstraf20786f2007-07-19 01:48:56 -07003984
3985 depth = curr->lockdep_depth;
Peter Zijlstra0119fee2011-09-02 01:30:29 +02003986 /*
3987 * Whee, we contended on this lock, except it seems we're not
3988 * actually trying to acquire anything much at all..
3989 */
Peter Zijlstraf20786f2007-07-19 01:48:56 -07003990 if (DEBUG_LOCKS_WARN_ON(!depth))
3991 return;
3992
J. R. Okajima41c2c5b2017-02-03 01:38:15 +09003993 hlock = find_held_lock(curr, lock, depth, &i);
3994 if (!hlock) {
3995 print_lock_contention_bug(curr, lock, ip);
3996 return;
Peter Zijlstraf20786f2007-07-19 01:48:56 -07003997 }
Peter Zijlstraf20786f2007-07-19 01:48:56 -07003998
Peter Zijlstrabb97a912009-07-20 19:15:35 +02003999 if (hlock->instance != lock)
4000 return;
4001
Peter Zijlstra3365e7792009-10-09 10:12:41 +02004002 hlock->waittime_stamp = lockstat_clock();
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004003
Peter Zijlstrac7e78cf2008-10-16 23:17:09 +02004004 contention_point = lock_point(hlock_class(hlock)->contention_point, ip);
4005 contending_point = lock_point(hlock_class(hlock)->contending_point,
4006 lock->ip);
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004007
Dave Jonesf82b2172008-08-11 09:30:23 +02004008 stats = get_lock_stats(hlock_class(hlock));
Peter Zijlstrac7e78cf2008-10-16 23:17:09 +02004009 if (contention_point < LOCKSTAT_POINTS)
4010 stats->contention_point[contention_point]++;
4011 if (contending_point < LOCKSTAT_POINTS)
4012 stats->contending_point[contending_point]++;
Peter Zijlstra96645672007-07-19 01:49:00 -07004013 if (lock->cpu != smp_processor_id())
4014 stats->bounces[bounce_contended + !!hlock->read]++;
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004015 put_lock_stats(stats);
4016}
4017
4018static void
Peter Zijlstrac7e78cf2008-10-16 23:17:09 +02004019__lock_acquired(struct lockdep_map *lock, unsigned long ip)
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004020{
4021 struct task_struct *curr = current;
J. R. Okajima41c2c5b2017-02-03 01:38:15 +09004022 struct held_lock *hlock;
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004023 struct lock_class_stats *stats;
4024 unsigned int depth;
Peter Zijlstra3365e7792009-10-09 10:12:41 +02004025 u64 now, waittime = 0;
Peter Zijlstra96645672007-07-19 01:49:00 -07004026 int i, cpu;
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004027
4028 depth = curr->lockdep_depth;
Peter Zijlstra0119fee2011-09-02 01:30:29 +02004029 /*
4030 * Yay, we acquired ownership of this lock we didn't try to
4031 * acquire, how the heck did that happen?
4032 */
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004033 if (DEBUG_LOCKS_WARN_ON(!depth))
4034 return;
4035
J. R. Okajima41c2c5b2017-02-03 01:38:15 +09004036 hlock = find_held_lock(curr, lock, depth, &i);
4037 if (!hlock) {
4038 print_lock_contention_bug(curr, lock, _RET_IP_);
4039 return;
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004040 }
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004041
Peter Zijlstrabb97a912009-07-20 19:15:35 +02004042 if (hlock->instance != lock)
4043 return;
4044
Peter Zijlstra96645672007-07-19 01:49:00 -07004045 cpu = smp_processor_id();
4046 if (hlock->waittime_stamp) {
Peter Zijlstra3365e7792009-10-09 10:12:41 +02004047 now = lockstat_clock();
Peter Zijlstra96645672007-07-19 01:49:00 -07004048 waittime = now - hlock->waittime_stamp;
4049 hlock->holdtime_stamp = now;
4050 }
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004051
Frederic Weisbecker883a2a32010-05-08 06:16:11 +02004052 trace_lock_acquired(lock, ip);
Frederic Weisbecker20625012009-04-06 01:49:33 +02004053
Dave Jonesf82b2172008-08-11 09:30:23 +02004054 stats = get_lock_stats(hlock_class(hlock));
Peter Zijlstra96645672007-07-19 01:49:00 -07004055 if (waittime) {
4056 if (hlock->read)
4057 lock_time_inc(&stats->read_waittime, waittime);
4058 else
4059 lock_time_inc(&stats->write_waittime, waittime);
4060 }
4061 if (lock->cpu != cpu)
4062 stats->bounces[bounce_acquired + !!hlock->read]++;
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004063 put_lock_stats(stats);
Peter Zijlstra96645672007-07-19 01:49:00 -07004064
4065 lock->cpu = cpu;
Peter Zijlstrac7e78cf2008-10-16 23:17:09 +02004066 lock->ip = ip;
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004067}
4068
4069void lock_contended(struct lockdep_map *lock, unsigned long ip)
4070{
4071 unsigned long flags;
4072
4073 if (unlikely(!lock_stat))
4074 return;
4075
4076 if (unlikely(current->lockdep_recursion))
4077 return;
4078
4079 raw_local_irq_save(flags);
4080 check_flags(flags);
4081 current->lockdep_recursion = 1;
Frederic Weisbeckerdb2c4c72010-02-02 23:34:40 +01004082 trace_lock_contended(lock, ip);
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004083 __lock_contended(lock, ip);
4084 current->lockdep_recursion = 0;
4085 raw_local_irq_restore(flags);
4086}
4087EXPORT_SYMBOL_GPL(lock_contended);
4088
Peter Zijlstrac7e78cf2008-10-16 23:17:09 +02004089void lock_acquired(struct lockdep_map *lock, unsigned long ip)
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004090{
4091 unsigned long flags;
4092
4093 if (unlikely(!lock_stat))
4094 return;
4095
4096 if (unlikely(current->lockdep_recursion))
4097 return;
4098
4099 raw_local_irq_save(flags);
4100 check_flags(flags);
4101 current->lockdep_recursion = 1;
Peter Zijlstrac7e78cf2008-10-16 23:17:09 +02004102 __lock_acquired(lock, ip);
Peter Zijlstraf20786f2007-07-19 01:48:56 -07004103 current->lockdep_recursion = 0;
4104 raw_local_irq_restore(flags);
4105}
4106EXPORT_SYMBOL_GPL(lock_acquired);
4107#endif
4108
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004109/*
4110 * Used by the testsuite, sanitize the validator state
4111 * after a simulated failure:
4112 */
4113
4114void lockdep_reset(void)
4115{
4116 unsigned long flags;
Ingo Molnar23d95a02006-12-13 00:34:40 -08004117 int i;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004118
4119 raw_local_irq_save(flags);
4120 current->curr_chain_key = 0;
4121 current->lockdep_depth = 0;
4122 current->lockdep_recursion = 0;
4123 memset(current->held_locks, 0, MAX_LOCK_DEPTH*sizeof(struct held_lock));
4124 nr_hardirq_chains = 0;
4125 nr_softirq_chains = 0;
4126 nr_process_chains = 0;
4127 debug_locks = 1;
Ingo Molnar23d95a02006-12-13 00:34:40 -08004128 for (i = 0; i < CHAINHASH_SIZE; i++)
Andrew Mortona63f38c2016-02-03 13:44:12 -08004129 INIT_HLIST_HEAD(chainhash_table + i);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004130 raw_local_irq_restore(flags);
4131}
4132
4133static void zap_class(struct lock_class *class)
4134{
4135 int i;
4136
4137 /*
4138 * Remove all dependencies this lock is
4139 * involved in:
4140 */
4141 for (i = 0; i < nr_list_entries; i++) {
4142 if (list_entries[i].class == class)
4143 list_del_rcu(&list_entries[i].entry);
4144 }
4145 /*
4146 * Unhash the class and remove it from the all_lock_classes list:
4147 */
Andrew Mortona63f38c2016-02-03 13:44:12 -08004148 hlist_del_rcu(&class->hash_entry);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004149 list_del_rcu(&class->lock_entry);
4150
Peter Zijlstracee34d82015-06-02 12:50:13 +02004151 RCU_INIT_POINTER(class->key, NULL);
4152 RCU_INIT_POINTER(class->name, NULL);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004153}
4154
Arjan van de Venfabe8742008-01-24 07:00:45 +01004155static inline int within(const void *addr, void *start, unsigned long size)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004156{
4157 return addr >= start && addr < start + size;
4158}
4159
Peter Zijlstra35a93932015-02-26 16:23:11 +01004160/*
4161 * Used in module.c to remove lock classes from memory that is going to be
4162 * freed; and possibly re-used by other modules.
4163 *
4164 * We will have had one sync_sched() before getting here, so we're guaranteed
4165 * nobody will look up these exact classes -- they're properly dead but still
4166 * allocated.
4167 */
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004168void lockdep_free_key_range(void *start, unsigned long size)
4169{
Peter Zijlstra35a93932015-02-26 16:23:11 +01004170 struct lock_class *class;
Andrew Mortona63f38c2016-02-03 13:44:12 -08004171 struct hlist_head *head;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004172 unsigned long flags;
4173 int i;
Nick Piggin5a26db52008-01-16 09:51:58 +01004174 int locked;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004175
4176 raw_local_irq_save(flags);
Nick Piggin5a26db52008-01-16 09:51:58 +01004177 locked = graph_lock();
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004178
4179 /*
4180 * Unhash all classes that were created by this module:
4181 */
4182 for (i = 0; i < CLASSHASH_SIZE; i++) {
4183 head = classhash_table + i;
Andrew Mortona63f38c2016-02-03 13:44:12 -08004184 hlist_for_each_entry_rcu(class, head, hash_entry) {
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004185 if (within(class->key, start, size))
4186 zap_class(class);
Arjan van de Venfabe8742008-01-24 07:00:45 +01004187 else if (within(class->name, start, size))
4188 zap_class(class);
4189 }
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004190 }
4191
Nick Piggin5a26db52008-01-16 09:51:58 +01004192 if (locked)
4193 graph_unlock();
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004194 raw_local_irq_restore(flags);
Peter Zijlstra35a93932015-02-26 16:23:11 +01004195
4196 /*
4197 * Wait for any possible iterators from look_up_lock_class() to pass
4198 * before continuing to free the memory they refer to.
4199 *
4200 * sync_sched() is sufficient because the read-side is IRQ disable.
4201 */
4202 synchronize_sched();
4203
4204 /*
4205 * XXX at this point we could return the resources to the pool;
4206 * instead we leak them. We would need to change to bitmap allocators
4207 * instead of the linear allocators we have now.
4208 */
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004209}
4210
4211void lockdep_reset_lock(struct lockdep_map *lock)
4212{
Peter Zijlstra35a93932015-02-26 16:23:11 +01004213 struct lock_class *class;
Andrew Mortona63f38c2016-02-03 13:44:12 -08004214 struct hlist_head *head;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004215 unsigned long flags;
4216 int i, j;
Nick Piggin5a26db52008-01-16 09:51:58 +01004217 int locked;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004218
4219 raw_local_irq_save(flags);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004220
4221 /*
Ingo Molnard6d897c2006-07-10 04:44:04 -07004222 * Remove all classes this lock might have:
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004223 */
Ingo Molnard6d897c2006-07-10 04:44:04 -07004224 for (j = 0; j < MAX_LOCKDEP_SUBCLASSES; j++) {
4225 /*
4226 * If the class exists we look it up and zap it:
4227 */
4228 class = look_up_lock_class(lock, j);
Thomas Gleixner383776f2017-02-27 15:37:36 +01004229 if (!IS_ERR_OR_NULL(class))
Ingo Molnard6d897c2006-07-10 04:44:04 -07004230 zap_class(class);
4231 }
4232 /*
4233 * Debug check: in the end all mapped classes should
4234 * be gone.
4235 */
Nick Piggin5a26db52008-01-16 09:51:58 +01004236 locked = graph_lock();
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004237 for (i = 0; i < CLASSHASH_SIZE; i++) {
4238 head = classhash_table + i;
Andrew Mortona63f38c2016-02-03 13:44:12 -08004239 hlist_for_each_entry_rcu(class, head, hash_entry) {
Hitoshi Mitake62016252010-10-05 18:01:51 +09004240 int match = 0;
4241
4242 for (j = 0; j < NR_LOCKDEP_CACHING_CLASSES; j++)
4243 match |= class == lock->class_cache[j];
4244
4245 if (unlikely(match)) {
Peter Zijlstra0119fee2011-09-02 01:30:29 +02004246 if (debug_locks_off_graph_unlock()) {
4247 /*
4248 * We all just reset everything, how did it match?
4249 */
Ingo Molnar74c383f2006-12-13 00:34:43 -08004250 WARN_ON(1);
Peter Zijlstra0119fee2011-09-02 01:30:29 +02004251 }
Ingo Molnard6d897c2006-07-10 04:44:04 -07004252 goto out_restore;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004253 }
4254 }
4255 }
Nick Piggin5a26db52008-01-16 09:51:58 +01004256 if (locked)
4257 graph_unlock();
Ingo Molnard6d897c2006-07-10 04:44:04 -07004258
4259out_restore:
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004260 raw_local_irq_restore(flags);
4261}
4262
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004263void __init lockdep_info(void)
4264{
4265 printk("Lock dependency validator: Copyright (c) 2006 Red Hat, Inc., Ingo Molnar\n");
4266
Li Zefanb0788ca2008-11-21 15:57:32 +08004267 printk("... MAX_LOCKDEP_SUBCLASSES: %lu\n", MAX_LOCKDEP_SUBCLASSES);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004268 printk("... MAX_LOCK_DEPTH: %lu\n", MAX_LOCK_DEPTH);
4269 printk("... MAX_LOCKDEP_KEYS: %lu\n", MAX_LOCKDEP_KEYS);
Li Zefanb0788ca2008-11-21 15:57:32 +08004270 printk("... CLASSHASH_SIZE: %lu\n", CLASSHASH_SIZE);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004271 printk("... MAX_LOCKDEP_ENTRIES: %lu\n", MAX_LOCKDEP_ENTRIES);
4272 printk("... MAX_LOCKDEP_CHAINS: %lu\n", MAX_LOCKDEP_CHAINS);
4273 printk("... CHAINHASH_SIZE: %lu\n", CHAINHASH_SIZE);
4274
4275 printk(" memory used by lock dependency info: %lu kB\n",
4276 (sizeof(struct lock_class) * MAX_LOCKDEP_KEYS +
4277 sizeof(struct list_head) * CLASSHASH_SIZE +
4278 sizeof(struct lock_list) * MAX_LOCKDEP_ENTRIES +
4279 sizeof(struct lock_chain) * MAX_LOCKDEP_CHAINS +
Ming Lei906292092009-08-02 21:43:36 +08004280 sizeof(struct list_head) * CHAINHASH_SIZE
Ming Lei4dd861d2009-07-16 15:44:29 +02004281#ifdef CONFIG_PROVE_LOCKING
Ming Leie351b662009-07-22 22:48:09 +08004282 + sizeof(struct circular_queue)
Ming Lei4dd861d2009-07-16 15:44:29 +02004283#endif
Ming Lei906292092009-08-02 21:43:36 +08004284 ) / 1024
Ming Lei4dd861d2009-07-16 15:44:29 +02004285 );
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004286
4287 printk(" per task-struct memory footprint: %lu bytes\n",
4288 sizeof(struct held_lock) * MAX_LOCK_DEPTH);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004289}
4290
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004291static void
4292print_freed_lock_bug(struct task_struct *curr, const void *mem_from,
Arjan van de Ven55794a42006-07-10 04:44:03 -07004293 const void *mem_to, struct held_lock *hlock)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004294{
4295 if (!debug_locks_off())
4296 return;
4297 if (debug_locks_silent)
4298 return;
4299
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004300 pr_warn("\n");
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08004301 pr_warn("=========================\n");
4302 pr_warn("WARNING: held lock freed!\n");
Ben Hutchingsfbdc4b92011-10-28 04:36:55 +01004303 print_kernel_ident();
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08004304 pr_warn("-------------------------\n");
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004305 pr_warn("%s/%d is freeing memory %p-%p, with a lock still held there!\n",
Pavel Emelyanovba25f9d2007-10-18 23:40:40 -07004306 curr->comm, task_pid_nr(curr), mem_from, mem_to-1);
Arjan van de Ven55794a42006-07-10 04:44:03 -07004307 print_lock(hlock);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004308 lockdep_print_held_locks(curr);
4309
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004310 pr_warn("\nstack backtrace:\n");
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004311 dump_stack();
4312}
4313
Oleg Nesterov54561782007-12-05 15:46:09 +01004314static inline int not_in_range(const void* mem_from, unsigned long mem_len,
4315 const void* lock_from, unsigned long lock_len)
4316{
4317 return lock_from + lock_len <= mem_from ||
4318 mem_from + mem_len <= lock_from;
4319}
4320
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004321/*
4322 * Called when kernel memory is freed (or unmapped), or if a lock
4323 * is destroyed or reinitialized - this code checks whether there is
4324 * any held lock in the memory range of <from> to <to>:
4325 */
4326void debug_check_no_locks_freed(const void *mem_from, unsigned long mem_len)
4327{
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004328 struct task_struct *curr = current;
4329 struct held_lock *hlock;
4330 unsigned long flags;
4331 int i;
4332
4333 if (unlikely(!debug_locks))
4334 return;
4335
4336 local_irq_save(flags);
4337 for (i = 0; i < curr->lockdep_depth; i++) {
4338 hlock = curr->held_locks + i;
4339
Oleg Nesterov54561782007-12-05 15:46:09 +01004340 if (not_in_range(mem_from, mem_len, hlock->instance,
4341 sizeof(*hlock->instance)))
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004342 continue;
4343
Oleg Nesterov54561782007-12-05 15:46:09 +01004344 print_freed_lock_bug(curr, mem_from, mem_from + mem_len, hlock);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004345 break;
4346 }
4347 local_irq_restore(flags);
4348}
Peter Zijlstraed075362006-12-06 20:35:24 -08004349EXPORT_SYMBOL_GPL(debug_check_no_locks_freed);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004350
Colin Cross1b1d2fb2013-05-06 23:50:08 +00004351static void print_held_locks_bug(void)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004352{
4353 if (!debug_locks_off())
4354 return;
4355 if (debug_locks_silent)
4356 return;
4357
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004358 pr_warn("\n");
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08004359 pr_warn("====================================\n");
4360 pr_warn("WARNING: %s/%d still has locks held!\n",
Colin Cross1b1d2fb2013-05-06 23:50:08 +00004361 current->comm, task_pid_nr(current));
Ben Hutchingsfbdc4b92011-10-28 04:36:55 +01004362 print_kernel_ident();
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08004363 pr_warn("------------------------------------\n");
Colin Cross1b1d2fb2013-05-06 23:50:08 +00004364 lockdep_print_held_locks(current);
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004365 pr_warn("\nstack backtrace:\n");
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004366 dump_stack();
4367}
4368
Colin Cross1b1d2fb2013-05-06 23:50:08 +00004369void debug_check_no_locks_held(void)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004370{
Colin Cross1b1d2fb2013-05-06 23:50:08 +00004371 if (unlikely(current->lockdep_depth > 0))
4372 print_held_locks_bug();
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004373}
Colin Cross1b1d2fb2013-05-06 23:50:08 +00004374EXPORT_SYMBOL_GPL(debug_check_no_locks_held);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004375
Sasha Levin8dce7a92013-06-13 18:41:16 -04004376#ifdef __KERNEL__
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004377void debug_show_all_locks(void)
4378{
4379 struct task_struct *g, *p;
4380 int count = 10;
4381 int unlock = 1;
4382
Jarek Poplawski9c35dd72007-03-22 00:11:28 -08004383 if (unlikely(!debug_locks)) {
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004384 pr_warn("INFO: lockdep is turned off.\n");
Jarek Poplawski9c35dd72007-03-22 00:11:28 -08004385 return;
4386 }
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004387 pr_warn("\nShowing all locks held in the system:\n");
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004388
4389 /*
4390 * Here we try to get the tasklist_lock as hard as possible,
4391 * if not successful after 2 seconds we ignore it (but keep
4392 * trying). This is to enable a debug printout even if a
4393 * tasklist_lock-holding task deadlocks or crashes.
4394 */
4395retry:
4396 if (!read_trylock(&tasklist_lock)) {
4397 if (count == 10)
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004398 pr_warn("hm, tasklist_lock locked, retrying... ");
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004399 if (count) {
4400 count--;
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004401 pr_cont(" #%d", 10-count);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004402 mdelay(200);
4403 goto retry;
4404 }
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004405 pr_cont(" ignoring it.\n");
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004406 unlock = 0;
qinghuang feng46fec7a2008-10-28 17:24:28 +08004407 } else {
4408 if (count != 10)
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004409 pr_cont(" locked it.\n");
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004410 }
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004411
4412 do_each_thread(g, p) {
Ingo Molnar85684872007-12-05 15:46:09 +01004413 /*
4414 * It's not reliable to print a task's held locks
4415 * if it's not sleeping (or if it's not the current
4416 * task):
4417 */
4418 if (p->state == TASK_RUNNING && p != current)
4419 continue;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004420 if (p->lockdep_depth)
4421 lockdep_print_held_locks(p);
4422 if (!unlock)
4423 if (read_trylock(&tasklist_lock))
4424 unlock = 1;
4425 } while_each_thread(g, p);
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\n");
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004429
4430 if (unlock)
4431 read_unlock(&tasklist_lock);
4432}
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004433EXPORT_SYMBOL_GPL(debug_show_all_locks);
Sasha Levin8dce7a92013-06-13 18:41:16 -04004434#endif
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004435
Ingo Molnar82a1fcb2008-01-25 21:08:02 +01004436/*
4437 * Careful: only use this function if you are sure that
4438 * the task cannot run in parallel!
4439 */
John Kacurf1b499f2010-08-05 17:10:53 +02004440void debug_show_held_locks(struct task_struct *task)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004441{
Jarek Poplawski9c35dd72007-03-22 00:11:28 -08004442 if (unlikely(!debug_locks)) {
4443 printk("INFO: lockdep is turned off.\n");
4444 return;
4445 }
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004446 lockdep_print_held_locks(task);
4447}
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07004448EXPORT_SYMBOL_GPL(debug_show_held_locks);
Peter Zijlstrab351d162007-10-11 22:11:12 +02004449
Andi Kleen722a9f92014-05-02 00:44:38 +02004450asmlinkage __visible void lockdep_sys_exit(void)
Peter Zijlstrab351d162007-10-11 22:11:12 +02004451{
4452 struct task_struct *curr = current;
4453
4454 if (unlikely(curr->lockdep_depth)) {
4455 if (!debug_locks_off())
4456 return;
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004457 pr_warn("\n");
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08004458 pr_warn("================================================\n");
4459 pr_warn("WARNING: lock held when returning to user space!\n");
Ben Hutchingsfbdc4b92011-10-28 04:36:55 +01004460 print_kernel_ident();
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08004461 pr_warn("------------------------------------------------\n");
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004462 pr_warn("%s/%d is leaving the kernel with locks still held!\n",
Peter Zijlstrab351d162007-10-11 22:11:12 +02004463 curr->comm, curr->pid);
4464 lockdep_print_held_locks(curr);
4465 }
4466}
Paul E. McKenney0632eb32010-02-22 17:04:47 -08004467
Paul E. McKenneyb3fbab02011-05-24 08:31:09 -07004468void lockdep_rcu_suspicious(const char *file, const int line, const char *s)
Paul E. McKenney0632eb32010-02-22 17:04:47 -08004469{
4470 struct task_struct *curr = current;
4471
Lai Jiangshan2b3fc352010-04-20 16:23:07 +08004472 /* Note: the following can be executed concurrently, so be careful. */
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004473 pr_warn("\n");
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08004474 pr_warn("=============================\n");
4475 pr_warn("WARNING: suspicious RCU usage\n");
Ben Hutchingsfbdc4b92011-10-28 04:36:55 +01004476 print_kernel_ident();
Paul E. McKenneya5dd63e2017-01-31 07:45:13 -08004477 pr_warn("-----------------------------\n");
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004478 pr_warn("%s:%d %s!\n", file, line, s);
4479 pr_warn("\nother info that might help us debug this:\n\n");
4480 pr_warn("\n%srcu_scheduler_active = %d, debug_locks = %d\n",
Paul E. McKenneyc5fdcec2012-01-30 08:46:32 -08004481 !rcu_lockdep_current_cpu_online()
4482 ? "RCU used illegally from offline CPU!\n"
Paul E. McKenney5c173eb2013-09-13 17:20:11 -07004483 : !rcu_is_watching()
Paul E. McKenneyc5fdcec2012-01-30 08:46:32 -08004484 ? "RCU used illegally from idle CPU!\n"
4485 : "",
4486 rcu_scheduler_active, debug_locks);
Frederic Weisbecker0464e932011-10-07 18:22:01 +02004487
4488 /*
4489 * If a CPU is in the RCU-free window in idle (ie: in the section
4490 * between rcu_idle_enter() and rcu_idle_exit(), then RCU
4491 * considers that CPU to be in an "extended quiescent state",
4492 * which means that RCU will be completely ignoring that CPU.
4493 * Therefore, rcu_read_lock() and friends have absolutely no
4494 * effect on a CPU running in that state. In other words, even if
4495 * such an RCU-idle CPU has called rcu_read_lock(), RCU might well
4496 * delete data structures out from under it. RCU really has no
4497 * choice here: we need to keep an RCU-free window in idle where
4498 * the CPU may possibly enter into low power mode. This way we can
4499 * notice an extended quiescent state to other CPUs that started a grace
4500 * period. Otherwise we would delay any grace period as long as we run
4501 * in the idle task.
4502 *
4503 * So complain bitterly if someone does call rcu_read_lock(),
4504 * rcu_read_lock_bh() and so on from extended quiescent states.
4505 */
Paul E. McKenney5c173eb2013-09-13 17:20:11 -07004506 if (!rcu_is_watching())
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004507 pr_warn("RCU used illegally from extended quiescent state!\n");
Frederic Weisbecker0464e932011-10-07 18:22:01 +02004508
Paul E. McKenney0632eb32010-02-22 17:04:47 -08004509 lockdep_print_held_locks(curr);
Paul E. McKenney681fbec2017-05-04 15:44:38 -07004510 pr_warn("\nstack backtrace:\n");
Paul E. McKenney0632eb32010-02-22 17:04:47 -08004511 dump_stack();
4512}
Paul E. McKenneyb3fbab02011-05-24 08:31:09 -07004513EXPORT_SYMBOL_GPL(lockdep_rcu_suspicious);