blob: eabe0138eb063c22bb5618a10f23d6950ff9711f [file] [log] [blame]
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07001/*
2 * Runtime locking correctness validator
3 *
Peter Zijlstra4b32d0a2007-07-19 01:48:59 -07004 * Copyright (C) 2006,2007 Red Hat, Inc., Ingo Molnar <mingo@redhat.com>
Peter Zijlstra90eec102015-11-16 11:08:45 +01005 * Copyright (C) 2007 Red Hat, Inc., Peter Zijlstra
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07006 *
Davidlohr Bueso214e0ae2014-07-30 13:41:55 -07007 * see Documentation/locking/lockdep-design.txt for more details.
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07008 */
9#ifndef __LINUX_LOCKDEP_H
10#define __LINUX_LOCKDEP_H
11
Heiko Carstensa1e96b02007-02-12 00:52:20 -080012struct task_struct;
Peter Zijlstraf20786f2007-07-19 01:48:56 -070013struct lockdep_map;
Heiko Carstensa1e96b02007-02-12 00:52:20 -080014
Dave Young2edf5e42010-03-10 15:24:10 -080015/* for sysctl */
16extern int prove_locking;
17extern int lock_stat;
18
Michael S. Tsirkindb0b0ea2006-09-29 01:59:28 -070019#ifdef CONFIG_LOCKDEP
20
Ingo Molnarfbb9ce952006-07-03 00:24:50 -070021#include <linux/linkage.h>
22#include <linux/list.h>
23#include <linux/debug_locks.h>
24#include <linux/stacktrace.h>
25
Ingo Molnarfbb9ce952006-07-03 00:24:50 -070026/*
Peter Zijlstra98516732009-01-22 14:18:40 +010027 * We'd rather not expose kernel/lockdep_states.h this wide, but we do need
28 * the total number of states... :-(
Ingo Molnarfbb9ce952006-07-03 00:24:50 -070029 */
Peter Zijlstra98516732009-01-22 14:18:40 +010030#define XXX_LOCK_USAGE_STATES (1+3*4)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -070031
32#define MAX_LOCKDEP_SUBCLASSES 8UL
33
34/*
Hitoshi Mitake62016252010-10-05 18:01:51 +090035 * NR_LOCKDEP_CACHING_CLASSES ... Number of classes
36 * cached in the instance of lockdep_map
37 *
38 * Currently main class (subclass == 0) and signle depth subclass
39 * are cached in lockdep_map. This optimization is mainly targeting
40 * on rq->lock. double_rq_lock() acquires this highly competitive with
41 * single depth.
42 */
43#define NR_LOCKDEP_CACHING_CLASSES 2
44
45/*
Ingo Molnarfbb9ce952006-07-03 00:24:50 -070046 * Lock-classes are keyed via unique addresses, by embedding the
47 * lockclass-key into the kernel (or module) .data section. (For
48 * static locks we use the lock address itself as the key.)
49 */
50struct lockdep_subclass_key {
51 char __one_byte;
52} __attribute__ ((__packed__));
53
54struct lock_class_key {
55 struct lockdep_subclass_key subkeys[MAX_LOCKDEP_SUBCLASSES];
56};
57
Peter Zijlstra1704f472010-03-19 01:37:42 +010058extern struct lock_class_key __lockdep_no_validate__;
59
Peter Zijlstrac7e78cf2008-10-16 23:17:09 +020060#define LOCKSTAT_POINTS 4
61
Ingo Molnarfbb9ce952006-07-03 00:24:50 -070062/*
63 * The lock-class itself:
64 */
65struct lock_class {
66 /*
67 * class-hash:
68 */
Andrew Mortona63f38c2016-02-03 13:44:12 -080069 struct hlist_node hash_entry;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -070070
71 /*
72 * global list of all lock-classes:
73 */
74 struct list_head lock_entry;
75
76 struct lockdep_subclass_key *key;
77 unsigned int subclass;
Ming Leie351b662009-07-22 22:48:09 +080078 unsigned int dep_gen_id;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -070079
80 /*
81 * IRQ/softirq usage tracking bits:
82 */
83 unsigned long usage_mask;
Peter Zijlstra98516732009-01-22 14:18:40 +010084 struct stack_trace usage_traces[XXX_LOCK_USAGE_STATES];
Ingo Molnarfbb9ce952006-07-03 00:24:50 -070085
86 /*
87 * These fields represent a directed graph of lock dependencies,
88 * to every node we attach a list of "forward" and a list of
89 * "backward" graph nodes.
90 */
91 struct list_head locks_after, locks_before;
92
93 /*
94 * Generation counter, when doing certain classes of graph walking,
95 * to ensure that we check one node only once:
96 */
97 unsigned int version;
98
99 /*
100 * Statistics counter:
101 */
102 unsigned long ops;
103
104 const char *name;
105 int name_version;
Peter Zijlstraf20786f2007-07-19 01:48:56 -0700106
107#ifdef CONFIG_LOCK_STAT
Peter Zijlstrac7e78cf2008-10-16 23:17:09 +0200108 unsigned long contention_point[LOCKSTAT_POINTS];
109 unsigned long contending_point[LOCKSTAT_POINTS];
Peter Zijlstraf20786f2007-07-19 01:48:56 -0700110#endif
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700111};
112
Peter Zijlstraf20786f2007-07-19 01:48:56 -0700113#ifdef CONFIG_LOCK_STAT
114struct lock_time {
115 s64 min;
116 s64 max;
117 s64 total;
118 unsigned long nr;
119};
120
Peter Zijlstra96645672007-07-19 01:49:00 -0700121enum bounce_type {
122 bounce_acquired_write,
123 bounce_acquired_read,
124 bounce_contended_write,
125 bounce_contended_read,
126 nr_bounce_types,
127
128 bounce_acquired = bounce_acquired_write,
129 bounce_contended = bounce_contended_write,
130};
131
Peter Zijlstraf20786f2007-07-19 01:48:56 -0700132struct lock_class_stats {
George Beshers68722102015-06-18 10:25:13 -0500133 unsigned long contention_point[LOCKSTAT_POINTS];
134 unsigned long contending_point[LOCKSTAT_POINTS];
Peter Zijlstraf20786f2007-07-19 01:48:56 -0700135 struct lock_time read_waittime;
136 struct lock_time write_waittime;
137 struct lock_time read_holdtime;
138 struct lock_time write_holdtime;
Peter Zijlstra96645672007-07-19 01:49:00 -0700139 unsigned long bounces[nr_bounce_types];
Peter Zijlstraf20786f2007-07-19 01:48:56 -0700140};
141
142struct lock_class_stats lock_stats(struct lock_class *class);
143void clear_lock_stats(struct lock_class *class);
144#endif
145
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700146/*
147 * Map the lock object (the lock instance) to the lock-class object.
148 * This is embedded into specific lock instances:
149 */
150struct lockdep_map {
151 struct lock_class_key *key;
Hitoshi Mitake62016252010-10-05 18:01:51 +0900152 struct lock_class *class_cache[NR_LOCKDEP_CACHING_CLASSES];
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700153 const char *name;
Peter Zijlstra96645672007-07-19 01:49:00 -0700154#ifdef CONFIG_LOCK_STAT
155 int cpu;
Peter Zijlstrac7e78cf2008-10-16 23:17:09 +0200156 unsigned long ip;
Peter Zijlstra96645672007-07-19 01:49:00 -0700157#endif
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700158};
159
Peter Zijlstra4d82a1d2012-05-15 08:06:19 -0700160static inline void lockdep_copy_map(struct lockdep_map *to,
161 struct lockdep_map *from)
162{
163 int i;
164
165 *to = *from;
166 /*
167 * Since the class cache can be modified concurrently we could observe
168 * half pointers (64bit arch using 32bit copy insns). Therefore clear
169 * the caches and take the performance hit.
170 *
171 * XXX it doesn't work well with lockdep_set_class_and_subclass(), since
172 * that relies on cache abuse.
173 */
174 for (i = 0; i < NR_LOCKDEP_CACHING_CLASSES; i++)
175 to->class_cache[i] = NULL;
176}
177
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700178/*
179 * Every lock has a list of other locks that were taken after it.
180 * We only grow the list, never remove from it:
181 */
182struct lock_list {
183 struct list_head entry;
184 struct lock_class *class;
185 struct stack_trace trace;
Jason Baron068135e2007-02-10 01:44:59 -0800186 int distance;
Ming Leic94aa5c2009-07-16 15:44:29 +0200187
Peter Zijlstraaf012962009-07-16 15:44:29 +0200188 /*
189 * The parent field is used to implement breadth-first search, and the
190 * bit 0 is reused to indicate if the lock has been accessed in BFS.
Ming Leic94aa5c2009-07-16 15:44:29 +0200191 */
192 struct lock_list *parent;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700193};
194
195/*
196 * We record lock dependency chains, so that we can cache them:
197 */
198struct lock_chain {
Peter Zijlstra75dd6022016-03-30 11:36:59 +0200199 /* see BUILD_BUG_ON()s in lookup_chain_cache() */
200 unsigned int irq_context : 2,
201 depth : 6,
202 base : 24;
203 /* 4 byte hole */
Andrew Mortona63f38c2016-02-03 13:44:12 -0800204 struct hlist_node entry;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700205 u64 chain_key;
206};
207
Ingo Molnare5f363e32008-08-11 12:37:27 +0200208#define MAX_LOCKDEP_KEYS_BITS 13
Peter Zijlstrab42e7372008-08-11 12:34:42 +0200209/*
210 * Subtract one because we offset hlock->class_idx by 1 in order
211 * to make 0 mean no class. This avoids overflowing the class_idx
212 * bitfield and hitting the BUG in hlock_class().
213 */
214#define MAX_LOCKDEP_KEYS ((1UL << MAX_LOCKDEP_KEYS_BITS) - 1)
Dave Jonesf82b2172008-08-11 09:30:23 +0200215
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700216struct held_lock {
217 /*
218 * One-way hash of the dependency chain up to this point. We
219 * hash the hashes step by step as the dependency chain grows.
220 *
221 * We use it for dependency-caching and we skip detection
222 * passes and dependency-updates if there is a cache-hit, so
223 * it is absolutely critical for 100% coverage of the validator
224 * to have a unique key value for every unique dependency path
225 * that can occur in the system, to make a unique hash value
226 * as likely as possible - hence the 64-bit width.
227 *
228 * The task struct holds the current hash value (initialized
229 * with zero), here we store the previous hash value:
230 */
231 u64 prev_chain_key;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700232 unsigned long acquire_ip;
233 struct lockdep_map *instance;
Peter Zijlstra7531e2f2008-08-11 09:30:24 +0200234 struct lockdep_map *nest_lock;
Peter Zijlstraf20786f2007-07-19 01:48:56 -0700235#ifdef CONFIG_LOCK_STAT
236 u64 waittime_stamp;
237 u64 holdtime_stamp;
238#endif
Dave Jonesf82b2172008-08-11 09:30:23 +0200239 unsigned int class_idx:MAX_LOCKDEP_KEYS_BITS;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700240 /*
241 * The lock-stack is unified in that the lock chains of interrupt
242 * contexts nest ontop of process context chains, but we 'separate'
243 * the hashes by starting with 0 if we cross into an interrupt
244 * context, and we also keep do not add cross-context lock
245 * dependencies - the lock usage graph walking covers that area
246 * anyway, and we'd just unnecessarily increase the number of
247 * dependencies otherwise. [Note: hardirq and softirq contexts
248 * are separated from each other too.]
249 *
250 * The following field is used to detect when we cross into an
251 * interrupt context:
252 */
Dave Jonesf82b2172008-08-11 09:30:23 +0200253 unsigned int irq_context:2; /* bit 0 - soft, bit 1 - hard */
Peter Zijlstrabb97a912009-07-20 19:15:35 +0200254 unsigned int trylock:1; /* 16 bits */
255
Dave Jonesf82b2172008-08-11 09:30:23 +0200256 unsigned int read:2; /* see lock_acquire() comment */
Oleg Nesterovfb9edbe2014-01-20 19:20:06 +0100257 unsigned int check:1; /* see lock_acquire() comment */
Dave Jonesf82b2172008-08-11 09:30:23 +0200258 unsigned int hardirqs_off:1;
Oleg Nesterovfb9edbe2014-01-20 19:20:06 +0100259 unsigned int references:12; /* 32 bits */
Peter Zijlstraa24fc602015-06-11 14:46:53 +0200260 unsigned int pin_count;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700261};
262
263/*
264 * Initialization, self-test and debugging-output methods:
265 */
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700266extern void lockdep_info(void);
267extern void lockdep_reset(void);
268extern void lockdep_reset_lock(struct lockdep_map *lock);
269extern void lockdep_free_key_range(void *start, unsigned long size);
Andi Kleen63f9a7f2014-02-08 08:52:01 +0100270extern asmlinkage void lockdep_sys_exit(void);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700271
272extern void lockdep_off(void);
273extern void lockdep_on(void);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700274
275/*
276 * These methods are used by specific locking variants (spinlocks,
277 * rwlocks, mutexes and rwsems) to pass init/acquire/release events
278 * to lockdep:
279 */
280
281extern void lockdep_init_map(struct lockdep_map *lock, const char *name,
Peter Zijlstra4dfbb9d2006-10-11 01:45:14 -0400282 struct lock_class_key *key, int subclass);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700283
284/*
Peter Zijlstra851a67b2007-10-11 22:11:12 +0200285 * To initialize a lockdep_map statically use this macro.
286 * Note that _name must not be NULL.
287 */
288#define STATIC_LOCKDEP_MAP_INIT(_name, _key) \
289 { .name = (_name), .key = (void *)(_key), }
290
291/*
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700292 * Reinitialize a lock key - for cases where there is special locking or
293 * special initialization of locks so that the validator gets the scope
294 * of dependencies wrong: they are either too broad (they need a class-split)
295 * or they are too narrow (they suffer from a false class-split):
296 */
297#define lockdep_set_class(lock, key) \
Peter Zijlstra4dfbb9d2006-10-11 01:45:14 -0400298 lockdep_init_map(&(lock)->dep_map, #key, key, 0)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700299#define lockdep_set_class_and_name(lock, key, name) \
Peter Zijlstra4dfbb9d2006-10-11 01:45:14 -0400300 lockdep_init_map(&(lock)->dep_map, name, key, 0)
301#define lockdep_set_class_and_subclass(lock, key, sub) \
302 lockdep_init_map(&(lock)->dep_map, #key, key, sub)
303#define lockdep_set_subclass(lock, sub) \
304 lockdep_init_map(&(lock)->dep_map, #lock, \
305 (lock)->dep_map.key, sub)
Peter Zijlstra1704f472010-03-19 01:37:42 +0100306
307#define lockdep_set_novalidate_class(lock) \
Oleg Nesterov47be1c12014-01-20 19:20:16 +0100308 lockdep_set_class_and_name(lock, &__lockdep_no_validate__, #lock)
Jan Kara9a7aa122009-06-04 15:26:49 +0200309/*
310 * Compare locking classes
311 */
312#define lockdep_match_class(lock, key) lockdep_match_key(&(lock)->dep_map, key)
313
314static inline int lockdep_match_key(struct lockdep_map *lock,
315 struct lock_class_key *key)
316{
317 return lock->key == key;
318}
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700319
320/*
321 * Acquire a lock.
322 *
323 * Values for "read":
324 *
325 * 0: exclusive (write) acquire
326 * 1: read-acquire (no recursion allowed)
327 * 2: read-acquire with same-instance recursion allowed
328 *
329 * Values for check:
330 *
Oleg Nesterovfb9edbe2014-01-20 19:20:06 +0100331 * 0: simple checks (freeing, held-at-exit-time, etc.)
332 * 1: full validation
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700333 */
334extern void lock_acquire(struct lockdep_map *lock, unsigned int subclass,
Peter Zijlstra7531e2f2008-08-11 09:30:24 +0200335 int trylock, int read, int check,
336 struct lockdep_map *nest_lock, unsigned long ip);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700337
338extern void lock_release(struct lockdep_map *lock, int nested,
339 unsigned long ip);
340
Peter Zijlstraf607c662009-07-20 19:16:29 +0200341#define lockdep_is_held(lock) lock_is_held(&(lock)->dep_map)
342
343extern int lock_is_held(struct lockdep_map *lock);
344
Peter Zijlstra00ef9f72008-12-04 09:00:17 +0100345extern void lock_set_class(struct lockdep_map *lock, const char *name,
346 struct lock_class_key *key, unsigned int subclass,
347 unsigned long ip);
348
349static inline void lock_set_subclass(struct lockdep_map *lock,
350 unsigned int subclass, unsigned long ip)
351{
352 lock_set_class(lock, lock->name, lock->key, subclass, ip);
353}
Peter Zijlstra64aa3482008-08-11 09:30:21 +0200354
Nick Piggincf40bd12009-01-21 08:12:39 +0100355extern void lockdep_set_current_reclaim_state(gfp_t gfp_mask);
356extern void lockdep_clear_current_reclaim_state(void);
357extern void lockdep_trace_alloc(gfp_t mask);
358
Peter Zijlstrae7904a22015-08-01 19:25:08 +0200359struct pin_cookie { unsigned int val; };
360
361#define NIL_COOKIE (struct pin_cookie){ .val = 0U, }
362
363extern struct pin_cookie lock_pin_lock(struct lockdep_map *lock);
364extern void lock_repin_lock(struct lockdep_map *lock, struct pin_cookie);
365extern void lock_unpin_lock(struct lockdep_map *lock, struct pin_cookie);
Peter Zijlstraa24fc602015-06-11 14:46:53 +0200366
Nick Piggincf40bd12009-01-21 08:12:39 +0100367# define INIT_LOCKDEP .lockdep_recursion = 0, .lockdep_reclaim_gfp = 0,
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700368
Jarek Poplawskie3a55fd2007-03-22 00:11:26 -0800369#define lockdep_depth(tsk) (debug_locks ? (tsk)->lockdep_depth : 0)
Peter Zijlstrad5abe662006-12-06 20:37:26 -0800370
Johannes Bergb1ae3452013-02-21 16:42:47 -0800371#define lockdep_assert_held(l) do { \
372 WARN_ON(debug_locks && !lockdep_is_held(l)); \
373 } while (0)
Peter Zijlstraf607c662009-07-20 19:16:29 +0200374
Peter Hurley9a371102014-09-10 14:31:39 -0400375#define lockdep_assert_held_once(l) do { \
376 WARN_ON_ONCE(debug_locks && !lockdep_is_held(l)); \
377 } while (0)
378
Peter Zijlstra94d24fc2011-06-07 11:17:30 +0200379#define lockdep_recursing(tsk) ((tsk)->lockdep_recursion)
380
Peter Zijlstrae7904a22015-08-01 19:25:08 +0200381#define lockdep_pin_lock(l) lock_pin_lock(&(l)->dep_map)
382#define lockdep_repin_lock(l,c) lock_repin_lock(&(l)->dep_map, (c))
383#define lockdep_unpin_lock(l,c) lock_unpin_lock(&(l)->dep_map, (c))
Peter Zijlstraa24fc602015-06-11 14:46:53 +0200384
Michel Lespinassea51805e2013-07-08 14:23:49 -0700385#else /* !CONFIG_LOCKDEP */
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700386
387static inline void lockdep_off(void)
388{
389}
390
391static inline void lockdep_on(void)
392{
393}
394
Peter Zijlstra7531e2f2008-08-11 09:30:24 +0200395# define lock_acquire(l, s, t, r, c, n, i) do { } while (0)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700396# define lock_release(l, n, i) do { } while (0)
Peter Zijlstra00ef9f72008-12-04 09:00:17 +0100397# define lock_set_class(l, n, k, s, i) do { } while (0)
Peter Zijlstra64aa3482008-08-11 09:30:21 +0200398# define lock_set_subclass(l, s, i) do { } while (0)
Nick Piggincf40bd12009-01-21 08:12:39 +0100399# define lockdep_set_current_reclaim_state(g) do { } while (0)
400# define lockdep_clear_current_reclaim_state() do { } while (0)
401# define lockdep_trace_alloc(g) do { } while (0)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700402# define lockdep_info() do { } while (0)
Ingo Molnare25cf3d2008-10-17 15:55:07 +0200403# define lockdep_init_map(lock, name, key, sub) \
404 do { (void)(name); (void)(key); } while (0)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700405# define lockdep_set_class(lock, key) do { (void)(key); } while (0)
406# define lockdep_set_class_and_name(lock, key, name) \
Ingo Molnare25cf3d2008-10-17 15:55:07 +0200407 do { (void)(key); (void)(name); } while (0)
Peter Zijlstra4dfbb9d2006-10-11 01:45:14 -0400408#define lockdep_set_class_and_subclass(lock, key, sub) \
409 do { (void)(key); } while (0)
Andrew Morton07646e22006-10-11 23:45:23 -0400410#define lockdep_set_subclass(lock, sub) do { } while (0)
Peter Zijlstra1704f472010-03-19 01:37:42 +0100411
412#define lockdep_set_novalidate_class(lock) do { } while (0)
413
Jan Kara9a7aa122009-06-04 15:26:49 +0200414/*
415 * We don't define lockdep_match_class() and lockdep_match_key() for !LOCKDEP
416 * case since the result is not well defined and the caller should rather
417 * #ifdef the call himself.
418 */
Andrew Morton07646e22006-10-11 23:45:23 -0400419
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700420# define INIT_LOCKDEP
421# define lockdep_reset() do { debug_locks = 1; } while (0)
422# define lockdep_free_key_range(start, size) do { } while (0)
Peter Zijlstrab351d162007-10-11 22:11:12 +0200423# define lockdep_sys_exit() do { } while (0)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700424/*
425 * The class key takes no space if lockdep is disabled:
426 */
427struct lock_class_key { };
Peter Zijlstrad5abe662006-12-06 20:37:26 -0800428
429#define lockdep_depth(tsk) (0)
430
Paul Bolle5cd3f5a2013-01-24 21:53:17 +0100431#define lockdep_assert_held(l) do { (void)(l); } while (0)
Peter Hurley9a371102014-09-10 14:31:39 -0400432#define lockdep_assert_held_once(l) do { (void)(l); } while (0)
Peter Zijlstraf607c662009-07-20 19:16:29 +0200433
Peter Zijlstra94d24fc2011-06-07 11:17:30 +0200434#define lockdep_recursing(tsk) (0)
435
Peter Zijlstrae7904a22015-08-01 19:25:08 +0200436struct pin_cookie { };
437
438#define NIL_COOKIE (struct pin_cookie){ }
439
440#define lockdep_pin_lock(l) ({ struct pin_cookie cookie; cookie; })
441#define lockdep_repin_lock(l, c) do { (void)(l); (void)(c); } while (0)
442#define lockdep_unpin_lock(l, c) do { (void)(l); (void)(c); } while (0)
Peter Zijlstraa24fc602015-06-11 14:46:53 +0200443
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700444#endif /* !LOCKDEP */
445
Peter Zijlstraf20786f2007-07-19 01:48:56 -0700446#ifdef CONFIG_LOCK_STAT
447
448extern void lock_contended(struct lockdep_map *lock, unsigned long ip);
Peter Zijlstrac7e78cf2008-10-16 23:17:09 +0200449extern void lock_acquired(struct lockdep_map *lock, unsigned long ip);
Peter Zijlstraf20786f2007-07-19 01:48:56 -0700450
451#define LOCK_CONTENDED(_lock, try, lock) \
452do { \
453 if (!try(_lock)) { \
454 lock_contended(&(_lock)->dep_map, _RET_IP_); \
455 lock(_lock); \
Peter Zijlstraf20786f2007-07-19 01:48:56 -0700456 } \
Peter Zijlstrac7e78cf2008-10-16 23:17:09 +0200457 lock_acquired(&(_lock)->dep_map, _RET_IP_); \
Peter Zijlstraf20786f2007-07-19 01:48:56 -0700458} while (0)
459
Michal Hocko916633a2016-04-07 17:12:31 +0200460#define LOCK_CONTENDED_RETURN(_lock, try, lock) \
461({ \
462 int ____err = 0; \
463 if (!try(_lock)) { \
464 lock_contended(&(_lock)->dep_map, _RET_IP_); \
465 ____err = lock(_lock); \
466 } \
467 if (!____err) \
468 lock_acquired(&(_lock)->dep_map, _RET_IP_); \
469 ____err; \
470})
471
Peter Zijlstraf20786f2007-07-19 01:48:56 -0700472#else /* CONFIG_LOCK_STAT */
473
474#define lock_contended(lockdep_map, ip) do {} while (0)
Peter Zijlstrac7e78cf2008-10-16 23:17:09 +0200475#define lock_acquired(lockdep_map, ip) do {} while (0)
Peter Zijlstraf20786f2007-07-19 01:48:56 -0700476
477#define LOCK_CONTENDED(_lock, try, lock) \
478 lock(_lock)
479
Michal Hocko916633a2016-04-07 17:12:31 +0200480#define LOCK_CONTENDED_RETURN(_lock, try, lock) \
481 lock(_lock)
482
Peter Zijlstraf20786f2007-07-19 01:48:56 -0700483#endif /* CONFIG_LOCK_STAT */
484
Robin Holte8c158b2009-04-02 16:59:45 -0700485#ifdef CONFIG_LOCKDEP
486
487/*
488 * On lockdep we dont want the hand-coded irq-enable of
489 * _raw_*_lock_flags() code, because lockdep assumes
490 * that interrupts are not re-enabled during lock-acquire:
491 */
492#define LOCK_CONTENDED_FLAGS(_lock, try, lock, lockfl, flags) \
493 LOCK_CONTENDED((_lock), (try), (lock))
494
495#else /* CONFIG_LOCKDEP */
496
497#define LOCK_CONTENDED_FLAGS(_lock, try, lock, lockfl, flags) \
498 lockfl((_lock), (flags))
499
500#endif /* CONFIG_LOCKDEP */
501
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700502#ifdef CONFIG_TRACE_IRQFLAGS
Ingo Molnar3117df02006-12-13 00:34:43 -0800503extern void print_irqtrace_events(struct task_struct *curr);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700504#else
Ingo Molnar3117df02006-12-13 00:34:43 -0800505static inline void print_irqtrace_events(struct task_struct *curr)
506{
507}
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700508#endif
509
510/*
511 * For trivial one-depth nesting of a lock-class, the following
512 * global define can be used. (Subsystems with multiple levels
513 * of nesting should define their own lock-nesting subclasses.)
514 */
515#define SINGLE_DEPTH_NESTING 1
516
517/*
518 * Map the dependency ops to NOP or to real lockdep ops, depending
519 * on the per lock-class debug mode:
520 */
521
Oleg Nesterovfb9edbe2014-01-20 19:20:06 +0100522#define lock_acquire_exclusive(l, s, t, n, i) lock_acquire(l, s, t, 0, 1, n, i)
523#define lock_acquire_shared(l, s, t, n, i) lock_acquire(l, s, t, 1, 1, n, i)
524#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 -0700525
Michel Lespinassea51805e2013-07-08 14:23:49 -0700526#define spin_acquire(l, s, t, i) lock_acquire_exclusive(l, s, t, NULL, i)
527#define spin_acquire_nest(l, s, t, n, i) lock_acquire_exclusive(l, s, t, n, i)
528#define spin_release(l, n, i) lock_release(l, n, i)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700529
Michel Lespinassea51805e2013-07-08 14:23:49 -0700530#define rwlock_acquire(l, s, t, i) lock_acquire_exclusive(l, s, t, NULL, i)
531#define rwlock_acquire_read(l, s, t, i) lock_acquire_shared_recursive(l, s, t, NULL, i)
532#define rwlock_release(l, n, i) lock_release(l, n, i)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700533
John Stultz1ca7d672013-10-07 15:51:59 -0700534#define seqcount_acquire(l, s, t, i) lock_acquire_exclusive(l, s, t, NULL, i)
535#define seqcount_acquire_read(l, s, t, i) lock_acquire_shared_recursive(l, s, t, NULL, i)
536#define seqcount_release(l, n, i) lock_release(l, n, i)
537
Michel Lespinassea51805e2013-07-08 14:23:49 -0700538#define mutex_acquire(l, s, t, i) lock_acquire_exclusive(l, s, t, NULL, i)
539#define mutex_acquire_nest(l, s, t, n, i) lock_acquire_exclusive(l, s, t, n, i)
540#define mutex_release(l, n, i) lock_release(l, n, i)
541
542#define rwsem_acquire(l, s, t, i) lock_acquire_exclusive(l, s, t, NULL, i)
543#define rwsem_acquire_nest(l, s, t, n, i) lock_acquire_exclusive(l, s, t, n, i)
544#define rwsem_acquire_read(l, s, t, i) lock_acquire_shared(l, s, t, NULL, i)
John Stultz1ca7d672013-10-07 15:51:59 -0700545#define rwsem_release(l, n, i) lock_release(l, n, i)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700546
Michel Lespinassea51805e2013-07-08 14:23:49 -0700547#define lock_map_acquire(l) lock_acquire_exclusive(l, 0, 0, NULL, _THIS_IP_)
548#define lock_map_acquire_read(l) lock_acquire_shared_recursive(l, 0, 0, NULL, _THIS_IP_)
Paul E. McKenneydd56af42014-08-25 20:25:06 -0700549#define lock_map_acquire_tryread(l) lock_acquire_shared_recursive(l, 0, 1, NULL, _THIS_IP_)
John Stultz1ca7d672013-10-07 15:51:59 -0700550#define lock_map_release(l) lock_release(l, 1, _THIS_IP_)
Peter Zijlstra4f3e7522008-08-11 09:30:23 +0200551
Peter Zijlstra76b189e2008-09-10 09:57:35 +0200552#ifdef CONFIG_PROVE_LOCKING
553# define might_lock(lock) \
554do { \
555 typecheck(struct lockdep_map *, &(lock)->dep_map); \
Oleg Nesterovfb9edbe2014-01-20 19:20:06 +0100556 lock_acquire(&(lock)->dep_map, 0, 0, 0, 1, NULL, _THIS_IP_); \
Peter Zijlstra76b189e2008-09-10 09:57:35 +0200557 lock_release(&(lock)->dep_map, 0, _THIS_IP_); \
558} while (0)
559# define might_lock_read(lock) \
560do { \
561 typecheck(struct lockdep_map *, &(lock)->dep_map); \
Oleg Nesterovfb9edbe2014-01-20 19:20:06 +0100562 lock_acquire(&(lock)->dep_map, 0, 0, 1, 1, NULL, _THIS_IP_); \
Peter Zijlstra76b189e2008-09-10 09:57:35 +0200563 lock_release(&(lock)->dep_map, 0, _THIS_IP_); \
564} while (0)
565#else
566# define might_lock(lock) do { } while (0)
567# define might_lock_read(lock) do { } while (0)
568#endif
569
Paul E. McKenneyd24209bb2015-01-21 15:26:03 -0800570#ifdef CONFIG_LOCKDEP
Paul E. McKenneyb3fbab02011-05-24 08:31:09 -0700571void lockdep_rcu_suspicious(const char *file, const int line, const char *s);
Paul E. McKenneyd24209bb2015-01-21 15:26:03 -0800572#else
573static inline void
574lockdep_rcu_suspicious(const char *file, const int line, const char *s)
575{
576}
Paul E. McKenney0632eb32010-02-22 17:04:47 -0800577#endif
578
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700579#endif /* __LINUX_LOCKDEP_H */