blob: f301d31b473c789b9f51038b9d9ac2dddace38f5 [file] [log] [blame]
Greg Kroah-Hartmanb2441312017-11-01 15:07:57 +01001/* SPDX-License-Identifier: GPL-2.0 */
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07002/*
3 * Runtime locking correctness validator
4 *
Peter Zijlstra4b32d0a2007-07-19 01:48:59 -07005 * Copyright (C) 2006,2007 Red Hat, Inc., Ingo Molnar <mingo@redhat.com>
Peter Zijlstra90eec102015-11-16 11:08:45 +01006 * Copyright (C) 2007 Red Hat, Inc., Peter Zijlstra
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07007 *
Davidlohr Bueso214e0ae2014-07-30 13:41:55 -07008 * see Documentation/locking/lockdep-design.txt for more details.
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07009 */
10#ifndef __LINUX_LOCKDEP_H
11#define __LINUX_LOCKDEP_H
12
Heiko Carstensa1e96b02007-02-12 00:52:20 -080013struct task_struct;
Peter Zijlstraf20786f2007-07-19 01:48:56 -070014struct lockdep_map;
Heiko Carstensa1e96b02007-02-12 00:52:20 -080015
Dave Young2edf5e42010-03-10 15:24:10 -080016/* for sysctl */
17extern int prove_locking;
18extern int lock_stat;
19
Bartosz Golaszewskia5ecddf2016-09-16 18:02:43 +020020#define MAX_LOCKDEP_SUBCLASSES 8UL
21
Peter Zijlstrae6f3faa2017-08-23 13:23:30 +020022#include <linux/types.h>
23
Michael S. Tsirkindb0b0ea2006-09-29 01:59:28 -070024#ifdef CONFIG_LOCKDEP
25
Ingo Molnarfbb9ce952006-07-03 00:24:50 -070026#include <linux/linkage.h>
27#include <linux/list.h>
28#include <linux/debug_locks.h>
29#include <linux/stacktrace.h>
30
Ingo Molnarfbb9ce952006-07-03 00:24:50 -070031/*
Peter Zijlstra98516732009-01-22 14:18:40 +010032 * We'd rather not expose kernel/lockdep_states.h this wide, but we do need
33 * the total number of states... :-(
Ingo Molnarfbb9ce952006-07-03 00:24:50 -070034 */
Peter Zijlstrad92a8cf2017-03-03 10:13:38 +010035#define XXX_LOCK_USAGE_STATES (1+2*4)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -070036
Ingo Molnarfbb9ce952006-07-03 00:24:50 -070037/*
Hitoshi Mitake62016252010-10-05 18:01:51 +090038 * NR_LOCKDEP_CACHING_CLASSES ... Number of classes
39 * cached in the instance of lockdep_map
40 *
41 * Currently main class (subclass == 0) and signle depth subclass
42 * are cached in lockdep_map. This optimization is mainly targeting
43 * on rq->lock. double_rq_lock() acquires this highly competitive with
44 * single depth.
45 */
46#define NR_LOCKDEP_CACHING_CLASSES 2
47
48/*
Ingo Molnarfbb9ce952006-07-03 00:24:50 -070049 * Lock-classes are keyed via unique addresses, by embedding the
50 * lockclass-key into the kernel (or module) .data section. (For
51 * static locks we use the lock address itself as the key.)
52 */
53struct lockdep_subclass_key {
54 char __one_byte;
55} __attribute__ ((__packed__));
56
57struct lock_class_key {
58 struct lockdep_subclass_key subkeys[MAX_LOCKDEP_SUBCLASSES];
59};
60
Peter Zijlstra1704f472010-03-19 01:37:42 +010061extern struct lock_class_key __lockdep_no_validate__;
62
Peter Zijlstrac7e78cf2008-10-16 23:17:09 +020063#define LOCKSTAT_POINTS 4
64
Ingo Molnarfbb9ce952006-07-03 00:24:50 -070065/*
66 * The lock-class itself:
67 */
68struct lock_class {
69 /*
70 * class-hash:
71 */
Andrew Mortona63f38c2016-02-03 13:44:12 -080072 struct hlist_node hash_entry;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -070073
74 /*
75 * global list of all lock-classes:
76 */
77 struct list_head lock_entry;
78
79 struct lockdep_subclass_key *key;
80 unsigned int subclass;
Ming Leie351b662009-07-22 22:48:09 +080081 unsigned int dep_gen_id;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -070082
83 /*
84 * IRQ/softirq usage tracking bits:
85 */
86 unsigned long usage_mask;
Peter Zijlstra98516732009-01-22 14:18:40 +010087 struct stack_trace usage_traces[XXX_LOCK_USAGE_STATES];
Ingo Molnarfbb9ce952006-07-03 00:24:50 -070088
89 /*
90 * These fields represent a directed graph of lock dependencies,
91 * to every node we attach a list of "forward" and a list of
92 * "backward" graph nodes.
93 */
94 struct list_head locks_after, locks_before;
95
96 /*
97 * Generation counter, when doing certain classes of graph walking,
98 * to ensure that we check one node only once:
99 */
100 unsigned int version;
101
102 /*
103 * Statistics counter:
104 */
105 unsigned long ops;
106
107 const char *name;
108 int name_version;
Peter Zijlstraf20786f2007-07-19 01:48:56 -0700109
110#ifdef CONFIG_LOCK_STAT
Peter Zijlstrac7e78cf2008-10-16 23:17:09 +0200111 unsigned long contention_point[LOCKSTAT_POINTS];
112 unsigned long contending_point[LOCKSTAT_POINTS];
Peter Zijlstraf20786f2007-07-19 01:48:56 -0700113#endif
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700114};
115
Peter Zijlstraf20786f2007-07-19 01:48:56 -0700116#ifdef CONFIG_LOCK_STAT
117struct lock_time {
118 s64 min;
119 s64 max;
120 s64 total;
121 unsigned long nr;
122};
123
Peter Zijlstra96645672007-07-19 01:49:00 -0700124enum bounce_type {
125 bounce_acquired_write,
126 bounce_acquired_read,
127 bounce_contended_write,
128 bounce_contended_read,
129 nr_bounce_types,
130
131 bounce_acquired = bounce_acquired_write,
132 bounce_contended = bounce_contended_write,
133};
134
Peter Zijlstraf20786f2007-07-19 01:48:56 -0700135struct lock_class_stats {
George Beshers68722102015-06-18 10:25:13 -0500136 unsigned long contention_point[LOCKSTAT_POINTS];
137 unsigned long contending_point[LOCKSTAT_POINTS];
Peter Zijlstraf20786f2007-07-19 01:48:56 -0700138 struct lock_time read_waittime;
139 struct lock_time write_waittime;
140 struct lock_time read_holdtime;
141 struct lock_time write_holdtime;
Peter Zijlstra96645672007-07-19 01:49:00 -0700142 unsigned long bounces[nr_bounce_types];
Peter Zijlstraf20786f2007-07-19 01:48:56 -0700143};
144
145struct lock_class_stats lock_stats(struct lock_class *class);
146void clear_lock_stats(struct lock_class *class);
147#endif
148
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700149/*
150 * Map the lock object (the lock instance) to the lock-class object.
151 * This is embedded into specific lock instances:
152 */
153struct lockdep_map {
154 struct lock_class_key *key;
Hitoshi Mitake62016252010-10-05 18:01:51 +0900155 struct lock_class *class_cache[NR_LOCKDEP_CACHING_CLASSES];
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700156 const char *name;
Peter Zijlstra96645672007-07-19 01:49:00 -0700157#ifdef CONFIG_LOCK_STAT
158 int cpu;
Peter Zijlstrac7e78cf2008-10-16 23:17:09 +0200159 unsigned long ip;
Peter Zijlstra96645672007-07-19 01:49:00 -0700160#endif
Byungchul Parkb09be672017-08-07 16:12:52 +0900161#ifdef CONFIG_LOCKDEP_CROSSRELEASE
162 /*
163 * Whether it's a crosslock.
164 */
165 int cross;
166#endif
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700167};
168
Peter Zijlstra4d82a1d2012-05-15 08:06:19 -0700169static inline void lockdep_copy_map(struct lockdep_map *to,
170 struct lockdep_map *from)
171{
172 int i;
173
174 *to = *from;
175 /*
176 * Since the class cache can be modified concurrently we could observe
177 * half pointers (64bit arch using 32bit copy insns). Therefore clear
178 * the caches and take the performance hit.
179 *
180 * XXX it doesn't work well with lockdep_set_class_and_subclass(), since
181 * that relies on cache abuse.
182 */
183 for (i = 0; i < NR_LOCKDEP_CACHING_CLASSES; i++)
184 to->class_cache[i] = NULL;
185}
186
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700187/*
188 * Every lock has a list of other locks that were taken after it.
189 * We only grow the list, never remove from it:
190 */
191struct lock_list {
192 struct list_head entry;
193 struct lock_class *class;
194 struct stack_trace trace;
Jason Baron068135e2007-02-10 01:44:59 -0800195 int distance;
Ming Leic94aa5c2009-07-16 15:44:29 +0200196
Peter Zijlstraaf012962009-07-16 15:44:29 +0200197 /*
198 * The parent field is used to implement breadth-first search, and the
199 * bit 0 is reused to indicate if the lock has been accessed in BFS.
Ming Leic94aa5c2009-07-16 15:44:29 +0200200 */
201 struct lock_list *parent;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700202};
203
204/*
205 * We record lock dependency chains, so that we can cache them:
206 */
207struct lock_chain {
Peter Zijlstra75dd6022016-03-30 11:36:59 +0200208 /* see BUILD_BUG_ON()s in lookup_chain_cache() */
209 unsigned int irq_context : 2,
210 depth : 6,
211 base : 24;
212 /* 4 byte hole */
Andrew Mortona63f38c2016-02-03 13:44:12 -0800213 struct hlist_node entry;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700214 u64 chain_key;
215};
216
Ingo Molnare5f363e32008-08-11 12:37:27 +0200217#define MAX_LOCKDEP_KEYS_BITS 13
Peter Zijlstrab42e7372008-08-11 12:34:42 +0200218/*
219 * Subtract one because we offset hlock->class_idx by 1 in order
220 * to make 0 mean no class. This avoids overflowing the class_idx
221 * bitfield and hitting the BUG in hlock_class().
222 */
223#define MAX_LOCKDEP_KEYS ((1UL << MAX_LOCKDEP_KEYS_BITS) - 1)
Dave Jonesf82b2172008-08-11 09:30:23 +0200224
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700225struct held_lock {
226 /*
227 * One-way hash of the dependency chain up to this point. We
228 * hash the hashes step by step as the dependency chain grows.
229 *
230 * We use it for dependency-caching and we skip detection
231 * passes and dependency-updates if there is a cache-hit, so
232 * it is absolutely critical for 100% coverage of the validator
233 * to have a unique key value for every unique dependency path
234 * that can occur in the system, to make a unique hash value
235 * as likely as possible - hence the 64-bit width.
236 *
237 * The task struct holds the current hash value (initialized
238 * with zero), here we store the previous hash value:
239 */
240 u64 prev_chain_key;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700241 unsigned long acquire_ip;
242 struct lockdep_map *instance;
Peter Zijlstra7531e2f2008-08-11 09:30:24 +0200243 struct lockdep_map *nest_lock;
Peter Zijlstraf20786f2007-07-19 01:48:56 -0700244#ifdef CONFIG_LOCK_STAT
245 u64 waittime_stamp;
246 u64 holdtime_stamp;
247#endif
Dave Jonesf82b2172008-08-11 09:30:23 +0200248 unsigned int class_idx:MAX_LOCKDEP_KEYS_BITS;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700249 /*
250 * The lock-stack is unified in that the lock chains of interrupt
251 * contexts nest ontop of process context chains, but we 'separate'
252 * the hashes by starting with 0 if we cross into an interrupt
253 * context, and we also keep do not add cross-context lock
254 * dependencies - the lock usage graph walking covers that area
255 * anyway, and we'd just unnecessarily increase the number of
256 * dependencies otherwise. [Note: hardirq and softirq contexts
257 * are separated from each other too.]
258 *
259 * The following field is used to detect when we cross into an
260 * interrupt context:
261 */
Dave Jonesf82b2172008-08-11 09:30:23 +0200262 unsigned int irq_context:2; /* bit 0 - soft, bit 1 - hard */
Peter Zijlstrabb97a912009-07-20 19:15:35 +0200263 unsigned int trylock:1; /* 16 bits */
264
Dave Jonesf82b2172008-08-11 09:30:23 +0200265 unsigned int read:2; /* see lock_acquire() comment */
Oleg Nesterovfb9edbe2014-01-20 19:20:06 +0100266 unsigned int check:1; /* see lock_acquire() comment */
Dave Jonesf82b2172008-08-11 09:30:23 +0200267 unsigned int hardirqs_off:1;
Oleg Nesterovfb9edbe2014-01-20 19:20:06 +0100268 unsigned int references:12; /* 32 bits */
Peter Zijlstraa24fc602015-06-11 14:46:53 +0200269 unsigned int pin_count;
Byungchul Parkb09be672017-08-07 16:12:52 +0900270#ifdef CONFIG_LOCKDEP_CROSSRELEASE
271 /*
272 * Generation id.
273 *
274 * A value of cross_gen_id will be stored when holding this,
275 * which is globally increased whenever each crosslock is held.
276 */
277 unsigned int gen_id;
278#endif
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700279};
280
Byungchul Parkb09be672017-08-07 16:12:52 +0900281#ifdef CONFIG_LOCKDEP_CROSSRELEASE
282#define MAX_XHLOCK_TRACE_ENTRIES 5
283
284/*
285 * This is for keeping locks waiting for commit so that true dependencies
286 * can be added at commit step.
287 */
288struct hist_lock {
289 /*
Byungchul Park23f873d2017-08-07 16:12:53 +0900290 * Id for each entry in the ring buffer. This is used to
291 * decide whether the ring buffer was overwritten or not.
292 *
293 * For example,
294 *
295 * |<----------- hist_lock ring buffer size ------->|
296 * pppppppppppppppppppppiiiiiiiiiiiiiiiiiiiiiiiiiiiii
297 * wrapped > iiiiiiiiiiiiiiiiiiiiiiiiiii.......................
298 *
299 * where 'p' represents an acquisition in process
300 * context, 'i' represents an acquisition in irq
301 * context.
302 *
303 * In this example, the ring buffer was overwritten by
304 * acquisitions in irq context, that should be detected on
305 * rollback or commit.
306 */
307 unsigned int hist_id;
308
309 /*
Byungchul Parkb09be672017-08-07 16:12:52 +0900310 * Seperate stack_trace data. This will be used at commit step.
311 */
312 struct stack_trace trace;
313 unsigned long trace_entries[MAX_XHLOCK_TRACE_ENTRIES];
314
315 /*
316 * Seperate hlock instance. This will be used at commit step.
317 *
318 * TODO: Use a smaller data structure containing only necessary
319 * data. However, we should make lockdep code able to handle the
320 * smaller one first.
321 */
322 struct held_lock hlock;
323};
324
325/*
326 * To initialize a lock as crosslock, lockdep_init_map_crosslock() should
327 * be called instead of lockdep_init_map().
328 */
329struct cross_lock {
330 /*
Byungchul Park28a903f2017-08-07 16:12:54 +0900331 * When more than one acquisition of crosslocks are overlapped,
332 * we have to perform commit for them based on cross_gen_id of
333 * the first acquisition, which allows us to add more true
334 * dependencies.
335 *
336 * Moreover, when no acquisition of a crosslock is in progress,
337 * we should not perform commit because the lock might not exist
338 * any more, which might cause incorrect memory access. So we
339 * have to track the number of acquisitions of a crosslock.
340 */
341 int nr_acquire;
342
343 /*
Byungchul Parkb09be672017-08-07 16:12:52 +0900344 * Seperate hlock instance. This will be used at commit step.
345 *
346 * TODO: Use a smaller data structure containing only necessary
347 * data. However, we should make lockdep code able to handle the
348 * smaller one first.
349 */
350 struct held_lock hlock;
351};
352
353struct lockdep_map_cross {
354 struct lockdep_map map;
355 struct cross_lock xlock;
356};
357#endif
358
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700359/*
360 * Initialization, self-test and debugging-output methods:
361 */
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700362extern void lockdep_info(void);
363extern void lockdep_reset(void);
364extern void lockdep_reset_lock(struct lockdep_map *lock);
365extern void lockdep_free_key_range(void *start, unsigned long size);
Andi Kleen63f9a7f2014-02-08 08:52:01 +0100366extern asmlinkage void lockdep_sys_exit(void);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700367
368extern void lockdep_off(void);
369extern void lockdep_on(void);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700370
371/*
372 * These methods are used by specific locking variants (spinlocks,
373 * rwlocks, mutexes and rwsems) to pass init/acquire/release events
374 * to lockdep:
375 */
376
377extern void lockdep_init_map(struct lockdep_map *lock, const char *name,
Peter Zijlstra4dfbb9d2006-10-11 01:45:14 -0400378 struct lock_class_key *key, int subclass);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700379
380/*
381 * Reinitialize a lock key - for cases where there is special locking or
382 * special initialization of locks so that the validator gets the scope
383 * of dependencies wrong: they are either too broad (they need a class-split)
384 * or they are too narrow (they suffer from a false class-split):
385 */
386#define lockdep_set_class(lock, key) \
Peter Zijlstra4dfbb9d2006-10-11 01:45:14 -0400387 lockdep_init_map(&(lock)->dep_map, #key, key, 0)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700388#define lockdep_set_class_and_name(lock, key, name) \
Peter Zijlstra4dfbb9d2006-10-11 01:45:14 -0400389 lockdep_init_map(&(lock)->dep_map, name, key, 0)
390#define lockdep_set_class_and_subclass(lock, key, sub) \
391 lockdep_init_map(&(lock)->dep_map, #key, key, sub)
392#define lockdep_set_subclass(lock, sub) \
393 lockdep_init_map(&(lock)->dep_map, #lock, \
394 (lock)->dep_map.key, sub)
Peter Zijlstra1704f472010-03-19 01:37:42 +0100395
396#define lockdep_set_novalidate_class(lock) \
Oleg Nesterov47be1c12014-01-20 19:20:16 +0100397 lockdep_set_class_and_name(lock, &__lockdep_no_validate__, #lock)
Jan Kara9a7aa122009-06-04 15:26:49 +0200398/*
399 * Compare locking classes
400 */
401#define lockdep_match_class(lock, key) lockdep_match_key(&(lock)->dep_map, key)
402
403static inline int lockdep_match_key(struct lockdep_map *lock,
404 struct lock_class_key *key)
405{
406 return lock->key == key;
407}
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700408
409/*
410 * Acquire a lock.
411 *
412 * Values for "read":
413 *
414 * 0: exclusive (write) acquire
415 * 1: read-acquire (no recursion allowed)
416 * 2: read-acquire with same-instance recursion allowed
417 *
418 * Values for check:
419 *
Oleg Nesterovfb9edbe2014-01-20 19:20:06 +0100420 * 0: simple checks (freeing, held-at-exit-time, etc.)
421 * 1: full validation
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700422 */
423extern void lock_acquire(struct lockdep_map *lock, unsigned int subclass,
Peter Zijlstra7531e2f2008-08-11 09:30:24 +0200424 int trylock, int read, int check,
425 struct lockdep_map *nest_lock, unsigned long ip);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700426
427extern void lock_release(struct lockdep_map *lock, int nested,
428 unsigned long ip);
429
Peter Zijlstraf8319482016-11-30 14:32:25 +1100430/*
431 * Same "read" as for lock_acquire(), except -1 means any.
432 */
433extern int lock_is_held_type(struct lockdep_map *lock, int read);
Peter Zijlstraf607c662009-07-20 19:16:29 +0200434
Peter Zijlstraf8319482016-11-30 14:32:25 +1100435static inline int lock_is_held(struct lockdep_map *lock)
436{
437 return lock_is_held_type(lock, -1);
438}
439
440#define lockdep_is_held(lock) lock_is_held(&(lock)->dep_map)
441#define lockdep_is_held_type(lock, r) lock_is_held_type(&(lock)->dep_map, (r))
Peter Zijlstraf607c662009-07-20 19:16:29 +0200442
Peter Zijlstra00ef9f72008-12-04 09:00:17 +0100443extern void lock_set_class(struct lockdep_map *lock, const char *name,
444 struct lock_class_key *key, unsigned int subclass,
445 unsigned long ip);
446
447static inline void lock_set_subclass(struct lockdep_map *lock,
448 unsigned int subclass, unsigned long ip)
449{
450 lock_set_class(lock, lock->name, lock->key, subclass, ip);
451}
Peter Zijlstra64aa3482008-08-11 09:30:21 +0200452
J. R. Okajima6419c4a2017-02-03 01:38:17 +0900453extern void lock_downgrade(struct lockdep_map *lock, unsigned long ip);
454
Peter Zijlstrae7904a22015-08-01 19:25:08 +0200455struct pin_cookie { unsigned int val; };
456
457#define NIL_COOKIE (struct pin_cookie){ .val = 0U, }
458
459extern struct pin_cookie lock_pin_lock(struct lockdep_map *lock);
460extern void lock_repin_lock(struct lockdep_map *lock, struct pin_cookie);
461extern void lock_unpin_lock(struct lockdep_map *lock, struct pin_cookie);
Peter Zijlstraa24fc602015-06-11 14:46:53 +0200462
Peter Zijlstrad92a8cf2017-03-03 10:13:38 +0100463# define INIT_LOCKDEP .lockdep_recursion = 0,
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700464
Jarek Poplawskie3a55fd2007-03-22 00:11:26 -0800465#define lockdep_depth(tsk) (debug_locks ? (tsk)->lockdep_depth : 0)
Peter Zijlstrad5abe662006-12-06 20:37:26 -0800466
Johannes Bergb1ae3452013-02-21 16:42:47 -0800467#define lockdep_assert_held(l) do { \
468 WARN_ON(debug_locks && !lockdep_is_held(l)); \
469 } while (0)
Peter Zijlstraf607c662009-07-20 19:16:29 +0200470
Peter Zijlstraf8319482016-11-30 14:32:25 +1100471#define lockdep_assert_held_exclusive(l) do { \
472 WARN_ON(debug_locks && !lockdep_is_held_type(l, 0)); \
473 } while (0)
474
475#define lockdep_assert_held_read(l) do { \
476 WARN_ON(debug_locks && !lockdep_is_held_type(l, 1)); \
477 } while (0)
478
Peter Hurley9a371102014-09-10 14:31:39 -0400479#define lockdep_assert_held_once(l) do { \
480 WARN_ON_ONCE(debug_locks && !lockdep_is_held(l)); \
481 } while (0)
482
Peter Zijlstra94d24fc2011-06-07 11:17:30 +0200483#define lockdep_recursing(tsk) ((tsk)->lockdep_recursion)
484
Peter Zijlstrae7904a22015-08-01 19:25:08 +0200485#define lockdep_pin_lock(l) lock_pin_lock(&(l)->dep_map)
486#define lockdep_repin_lock(l,c) lock_repin_lock(&(l)->dep_map, (c))
487#define lockdep_unpin_lock(l,c) lock_unpin_lock(&(l)->dep_map, (c))
Peter Zijlstraa24fc602015-06-11 14:46:53 +0200488
Michel Lespinassea51805e2013-07-08 14:23:49 -0700489#else /* !CONFIG_LOCKDEP */
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700490
491static inline void lockdep_off(void)
492{
493}
494
495static inline void lockdep_on(void)
496{
497}
498
Peter Zijlstra7531e2f2008-08-11 09:30:24 +0200499# define lock_acquire(l, s, t, r, c, n, i) do { } while (0)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700500# define lock_release(l, n, i) do { } while (0)
J. R. Okajima6419c4a2017-02-03 01:38:17 +0900501# define lock_downgrade(l, i) do { } while (0)
Peter Zijlstra00ef9f72008-12-04 09:00:17 +0100502# define lock_set_class(l, n, k, s, i) do { } while (0)
Peter Zijlstra64aa3482008-08-11 09:30:21 +0200503# define lock_set_subclass(l, s, i) do { } while (0)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700504# define lockdep_info() do { } while (0)
Ingo Molnare25cf3d2008-10-17 15:55:07 +0200505# define lockdep_init_map(lock, name, key, sub) \
506 do { (void)(name); (void)(key); } while (0)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700507# define lockdep_set_class(lock, key) do { (void)(key); } while (0)
508# define lockdep_set_class_and_name(lock, key, name) \
Ingo Molnare25cf3d2008-10-17 15:55:07 +0200509 do { (void)(key); (void)(name); } while (0)
Peter Zijlstra4dfbb9d2006-10-11 01:45:14 -0400510#define lockdep_set_class_and_subclass(lock, key, sub) \
511 do { (void)(key); } while (0)
Andrew Morton07646e22006-10-11 23:45:23 -0400512#define lockdep_set_subclass(lock, sub) do { } while (0)
Peter Zijlstra1704f472010-03-19 01:37:42 +0100513
514#define lockdep_set_novalidate_class(lock) do { } while (0)
515
Jan Kara9a7aa122009-06-04 15:26:49 +0200516/*
517 * We don't define lockdep_match_class() and lockdep_match_key() for !LOCKDEP
518 * case since the result is not well defined and the caller should rather
519 * #ifdef the call himself.
520 */
Andrew Morton07646e22006-10-11 23:45:23 -0400521
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700522# define INIT_LOCKDEP
523# define lockdep_reset() do { debug_locks = 1; } while (0)
524# define lockdep_free_key_range(start, size) do { } while (0)
Peter Zijlstrab351d162007-10-11 22:11:12 +0200525# define lockdep_sys_exit() do { } while (0)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700526/*
527 * The class key takes no space if lockdep is disabled:
528 */
529struct lock_class_key { };
Peter Zijlstrad5abe662006-12-06 20:37:26 -0800530
531#define lockdep_depth(tsk) (0)
532
Peter Zijlstraf8319482016-11-30 14:32:25 +1100533#define lockdep_is_held_type(l, r) (1)
534
Paul Bolle5cd3f5a2013-01-24 21:53:17 +0100535#define lockdep_assert_held(l) do { (void)(l); } while (0)
Peter Zijlstraf8319482016-11-30 14:32:25 +1100536#define lockdep_assert_held_exclusive(l) do { (void)(l); } while (0)
537#define lockdep_assert_held_read(l) do { (void)(l); } while (0)
Peter Hurley9a371102014-09-10 14:31:39 -0400538#define lockdep_assert_held_once(l) do { (void)(l); } while (0)
Peter Zijlstraf607c662009-07-20 19:16:29 +0200539
Peter Zijlstra94d24fc2011-06-07 11:17:30 +0200540#define lockdep_recursing(tsk) (0)
541
Peter Zijlstrae7904a22015-08-01 19:25:08 +0200542struct pin_cookie { };
543
544#define NIL_COOKIE (struct pin_cookie){ }
545
546#define lockdep_pin_lock(l) ({ struct pin_cookie cookie; cookie; })
547#define lockdep_repin_lock(l, c) do { (void)(l); (void)(c); } while (0)
548#define lockdep_unpin_lock(l, c) do { (void)(l); (void)(c); } while (0)
Peter Zijlstraa24fc602015-06-11 14:46:53 +0200549
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700550#endif /* !LOCKDEP */
551
Byungchul Parkb09be672017-08-07 16:12:52 +0900552enum xhlock_context_t {
553 XHLOCK_HARD,
554 XHLOCK_SOFT,
Byungchul Parkb09be672017-08-07 16:12:52 +0900555 XHLOCK_CTX_NR,
556};
557
558#ifdef CONFIG_LOCKDEP_CROSSRELEASE
559extern void lockdep_init_map_crosslock(struct lockdep_map *lock,
560 const char *name,
561 struct lock_class_key *key,
562 int subclass);
563extern void lock_commit_crosslock(struct lockdep_map *lock);
564
Byungchul Park28a903f2017-08-07 16:12:54 +0900565/*
566 * What we essencially have to initialize is 'nr_acquire'. Other members
567 * will be initialized in add_xlock().
568 */
569#define STATIC_CROSS_LOCK_INIT() \
570 { .nr_acquire = 0,}
571
Byungchul Parkb09be672017-08-07 16:12:52 +0900572#define STATIC_CROSS_LOCKDEP_MAP_INIT(_name, _key) \
573 { .map.name = (_name), .map.key = (void *)(_key), \
Byungchul Park28a903f2017-08-07 16:12:54 +0900574 .map.cross = 1, .xlock = STATIC_CROSS_LOCK_INIT(), }
Byungchul Parkb09be672017-08-07 16:12:52 +0900575
576/*
577 * To initialize a lockdep_map statically use this macro.
578 * Note that _name must not be NULL.
579 */
580#define STATIC_LOCKDEP_MAP_INIT(_name, _key) \
581 { .name = (_name), .key = (void *)(_key), .cross = 0, }
582
Peter Zijlstraf52be572017-08-29 10:59:39 +0200583extern void crossrelease_hist_start(enum xhlock_context_t c);
Byungchul Parkb09be672017-08-07 16:12:52 +0900584extern void crossrelease_hist_end(enum xhlock_context_t c);
Peter Zijlstraf52be572017-08-29 10:59:39 +0200585extern void lockdep_invariant_state(bool force);
Byungchul Parkb09be672017-08-07 16:12:52 +0900586extern void lockdep_init_task(struct task_struct *task);
587extern void lockdep_free_task(struct task_struct *task);
Peter Zijlstrae6f3faa2017-08-23 13:23:30 +0200588#else /* !CROSSRELEASE */
Boqun Feng52fa5bc2017-08-17 17:46:12 +0800589#define lockdep_init_map_crosslock(m, n, k, s) do {} while (0)
Byungchul Parkb09be672017-08-07 16:12:52 +0900590/*
591 * To initialize a lockdep_map statically use this macro.
592 * Note that _name must not be NULL.
593 */
594#define STATIC_LOCKDEP_MAP_INIT(_name, _key) \
595 { .name = (_name), .key = (void *)(_key), }
596
Peter Zijlstraf52be572017-08-29 10:59:39 +0200597static inline void crossrelease_hist_start(enum xhlock_context_t c) {}
Byungchul Parkb09be672017-08-07 16:12:52 +0900598static inline void crossrelease_hist_end(enum xhlock_context_t c) {}
Peter Zijlstraf52be572017-08-29 10:59:39 +0200599static inline void lockdep_invariant_state(bool force) {}
Byungchul Parkb09be672017-08-07 16:12:52 +0900600static inline void lockdep_init_task(struct task_struct *task) {}
601static inline void lockdep_free_task(struct task_struct *task) {}
Peter Zijlstrae6f3faa2017-08-23 13:23:30 +0200602#endif /* CROSSRELEASE */
Byungchul Parkb09be672017-08-07 16:12:52 +0900603
Peter Zijlstraf20786f2007-07-19 01:48:56 -0700604#ifdef CONFIG_LOCK_STAT
605
606extern void lock_contended(struct lockdep_map *lock, unsigned long ip);
Peter Zijlstrac7e78cf2008-10-16 23:17:09 +0200607extern void lock_acquired(struct lockdep_map *lock, unsigned long ip);
Peter Zijlstraf20786f2007-07-19 01:48:56 -0700608
609#define LOCK_CONTENDED(_lock, try, lock) \
610do { \
611 if (!try(_lock)) { \
612 lock_contended(&(_lock)->dep_map, _RET_IP_); \
613 lock(_lock); \
Peter Zijlstraf20786f2007-07-19 01:48:56 -0700614 } \
Peter Zijlstrac7e78cf2008-10-16 23:17:09 +0200615 lock_acquired(&(_lock)->dep_map, _RET_IP_); \
Peter Zijlstraf20786f2007-07-19 01:48:56 -0700616} while (0)
617
Michal Hocko916633a2016-04-07 17:12:31 +0200618#define LOCK_CONTENDED_RETURN(_lock, try, lock) \
619({ \
620 int ____err = 0; \
621 if (!try(_lock)) { \
622 lock_contended(&(_lock)->dep_map, _RET_IP_); \
623 ____err = lock(_lock); \
624 } \
625 if (!____err) \
626 lock_acquired(&(_lock)->dep_map, _RET_IP_); \
627 ____err; \
628})
629
Peter Zijlstraf20786f2007-07-19 01:48:56 -0700630#else /* CONFIG_LOCK_STAT */
631
632#define lock_contended(lockdep_map, ip) do {} while (0)
Peter Zijlstrac7e78cf2008-10-16 23:17:09 +0200633#define lock_acquired(lockdep_map, ip) do {} while (0)
Peter Zijlstraf20786f2007-07-19 01:48:56 -0700634
635#define LOCK_CONTENDED(_lock, try, lock) \
636 lock(_lock)
637
Michal Hocko916633a2016-04-07 17:12:31 +0200638#define LOCK_CONTENDED_RETURN(_lock, try, lock) \
639 lock(_lock)
640
Peter Zijlstraf20786f2007-07-19 01:48:56 -0700641#endif /* CONFIG_LOCK_STAT */
642
Robin Holte8c158b2009-04-02 16:59:45 -0700643#ifdef CONFIG_LOCKDEP
644
645/*
646 * On lockdep we dont want the hand-coded irq-enable of
647 * _raw_*_lock_flags() code, because lockdep assumes
648 * that interrupts are not re-enabled during lock-acquire:
649 */
650#define LOCK_CONTENDED_FLAGS(_lock, try, lock, lockfl, flags) \
651 LOCK_CONTENDED((_lock), (try), (lock))
652
653#else /* CONFIG_LOCKDEP */
654
655#define LOCK_CONTENDED_FLAGS(_lock, try, lock, lockfl, flags) \
656 lockfl((_lock), (flags))
657
658#endif /* CONFIG_LOCKDEP */
659
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700660#ifdef CONFIG_TRACE_IRQFLAGS
Ingo Molnar3117df02006-12-13 00:34:43 -0800661extern void print_irqtrace_events(struct task_struct *curr);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700662#else
Ingo Molnar3117df02006-12-13 00:34:43 -0800663static inline void print_irqtrace_events(struct task_struct *curr)
664{
665}
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700666#endif
667
668/*
669 * For trivial one-depth nesting of a lock-class, the following
670 * global define can be used. (Subsystems with multiple levels
671 * of nesting should define their own lock-nesting subclasses.)
672 */
673#define SINGLE_DEPTH_NESTING 1
674
675/*
676 * Map the dependency ops to NOP or to real lockdep ops, depending
677 * on the per lock-class debug mode:
678 */
679
Oleg Nesterovfb9edbe2014-01-20 19:20:06 +0100680#define lock_acquire_exclusive(l, s, t, n, i) lock_acquire(l, s, t, 0, 1, n, i)
681#define lock_acquire_shared(l, s, t, n, i) lock_acquire(l, s, t, 1, 1, n, i)
682#define lock_acquire_shared_recursive(l, s, t, n, i) lock_acquire(l, s, t, 2, 1, n, i)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700683
Michel Lespinassea51805e2013-07-08 14:23:49 -0700684#define spin_acquire(l, s, t, i) lock_acquire_exclusive(l, s, t, NULL, i)
685#define spin_acquire_nest(l, s, t, n, i) lock_acquire_exclusive(l, s, t, n, i)
686#define spin_release(l, n, i) lock_release(l, n, i)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700687
Michel Lespinassea51805e2013-07-08 14:23:49 -0700688#define rwlock_acquire(l, s, t, i) lock_acquire_exclusive(l, s, t, NULL, i)
689#define rwlock_acquire_read(l, s, t, i) lock_acquire_shared_recursive(l, s, t, NULL, i)
690#define rwlock_release(l, n, i) lock_release(l, n, i)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700691
John Stultz1ca7d672013-10-07 15:51:59 -0700692#define seqcount_acquire(l, s, t, i) lock_acquire_exclusive(l, s, t, NULL, i)
693#define seqcount_acquire_read(l, s, t, i) lock_acquire_shared_recursive(l, s, t, NULL, i)
694#define seqcount_release(l, n, i) lock_release(l, n, i)
695
Michel Lespinassea51805e2013-07-08 14:23:49 -0700696#define mutex_acquire(l, s, t, i) lock_acquire_exclusive(l, s, t, NULL, i)
697#define mutex_acquire_nest(l, s, t, n, i) lock_acquire_exclusive(l, s, t, n, i)
698#define mutex_release(l, n, i) lock_release(l, n, i)
699
700#define rwsem_acquire(l, s, t, i) lock_acquire_exclusive(l, s, t, NULL, i)
701#define rwsem_acquire_nest(l, s, t, n, i) lock_acquire_exclusive(l, s, t, n, i)
702#define rwsem_acquire_read(l, s, t, i) lock_acquire_shared(l, s, t, NULL, i)
John Stultz1ca7d672013-10-07 15:51:59 -0700703#define rwsem_release(l, n, i) lock_release(l, n, i)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700704
Michel Lespinassea51805e2013-07-08 14:23:49 -0700705#define lock_map_acquire(l) lock_acquire_exclusive(l, 0, 0, NULL, _THIS_IP_)
706#define lock_map_acquire_read(l) lock_acquire_shared_recursive(l, 0, 0, NULL, _THIS_IP_)
Paul E. McKenneydd56af42014-08-25 20:25:06 -0700707#define lock_map_acquire_tryread(l) lock_acquire_shared_recursive(l, 0, 1, NULL, _THIS_IP_)
John Stultz1ca7d672013-10-07 15:51:59 -0700708#define lock_map_release(l) lock_release(l, 1, _THIS_IP_)
Peter Zijlstra4f3e7522008-08-11 09:30:23 +0200709
Peter Zijlstra76b189e2008-09-10 09:57:35 +0200710#ifdef CONFIG_PROVE_LOCKING
711# define might_lock(lock) \
712do { \
713 typecheck(struct lockdep_map *, &(lock)->dep_map); \
Oleg Nesterovfb9edbe2014-01-20 19:20:06 +0100714 lock_acquire(&(lock)->dep_map, 0, 0, 0, 1, NULL, _THIS_IP_); \
Peter Zijlstra76b189e2008-09-10 09:57:35 +0200715 lock_release(&(lock)->dep_map, 0, _THIS_IP_); \
716} while (0)
717# define might_lock_read(lock) \
718do { \
719 typecheck(struct lockdep_map *, &(lock)->dep_map); \
Oleg Nesterovfb9edbe2014-01-20 19:20:06 +0100720 lock_acquire(&(lock)->dep_map, 0, 0, 1, 1, NULL, _THIS_IP_); \
Peter Zijlstra76b189e2008-09-10 09:57:35 +0200721 lock_release(&(lock)->dep_map, 0, _THIS_IP_); \
722} while (0)
723#else
724# define might_lock(lock) do { } while (0)
725# define might_lock_read(lock) do { } while (0)
726#endif
727
Paul E. McKenneyd24209bb2015-01-21 15:26:03 -0800728#ifdef CONFIG_LOCKDEP
Paul E. McKenneyb3fbab02011-05-24 08:31:09 -0700729void lockdep_rcu_suspicious(const char *file, const int line, const char *s);
Paul E. McKenneyd24209bb2015-01-21 15:26:03 -0800730#else
731static inline void
732lockdep_rcu_suspicious(const char *file, const int line, const char *s)
733{
734}
Paul E. McKenney0632eb32010-02-22 17:04:47 -0800735#endif
736
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700737#endif /* __LINUX_LOCKDEP_H */