Merge tag 'mm-hotfixes-stable-2023-05-03-16-27' of git://git.kernel.org/pub/scm/linux...
[linux-block.git] / include / linux / lockdep.h
CommitLineData
b2441318 1/* SPDX-License-Identifier: GPL-2.0 */
fbb9ce95
IM
2/*
3 * Runtime locking correctness validator
4 *
4b32d0a4 5 * Copyright (C) 2006,2007 Red Hat, Inc., Ingo Molnar <mingo@redhat.com>
90eec103 6 * Copyright (C) 2007 Red Hat, Inc., Peter Zijlstra
fbb9ce95 7 *
387b1468 8 * see Documentation/locking/lockdep-design.rst for more details.
fbb9ce95
IM
9 */
10#ifndef __LINUX_LOCKDEP_H
11#define __LINUX_LOCKDEP_H
12
c935cd62 13#include <linux/lockdep_types.h>
0cd39f46 14#include <linux/smp.h>
a21ee605 15#include <asm/percpu.h>
c935cd62 16
a1e96b03
HC
17struct task_struct;
18
db0b0ead
MT
19#ifdef CONFIG_LOCKDEP
20
fbb9ce95 21#include <linux/linkage.h>
5be542e9 22#include <linux/list.h>
fbb9ce95
IM
23#include <linux/debug_locks.h>
24#include <linux/stacktrace.h>
25
4d82a1de
PZ
26static inline void lockdep_copy_map(struct lockdep_map *to,
27 struct lockdep_map *from)
28{
29 int i;
30
31 *to = *from;
32 /*
33 * Since the class cache can be modified concurrently we could observe
34 * half pointers (64bit arch using 32bit copy insns). Therefore clear
35 * the caches and take the performance hit.
36 *
37 * XXX it doesn't work well with lockdep_set_class_and_subclass(), since
38 * that relies on cache abuse.
39 */
40 for (i = 0; i < NR_LOCKDEP_CACHING_CLASSES; i++)
41 to->class_cache[i] = NULL;
42}
43
fbb9ce95
IM
44/*
45 * Every lock has a list of other locks that were taken after it.
46 * We only grow the list, never remove from it:
47 */
48struct lock_list {
49 struct list_head entry;
50 struct lock_class *class;
86cffb80 51 struct lock_class *links_to;
12593b74 52 const struct lock_trace *trace;
bd76eca1 53 u16 distance;
3454a36d
BF
54 /* bitmap of different dependencies from head to this */
55 u8 dep;
6971c0f3
BF
56 /* used by BFS to record whether "prev -> this" only has -(*R)-> */
57 u8 only_xr;
c94aa5ca 58
af012961
PZ
59 /*
60 * The parent field is used to implement breadth-first search, and the
61 * bit 0 is reused to indicate if the lock has been accessed in BFS.
c94aa5ca
ML
62 */
63 struct lock_list *parent;
fbb9ce95
IM
64};
65
d16dbd1b
YD
66/**
67 * struct lock_chain - lock dependency chain record
68 *
69 * @irq_context: the same as irq_context in held_lock below
70 * @depth: the number of held locks in this chain
71 * @base: the index in chain_hlocks for this chain
72 * @entry: the collided lock chains in lock_chain hash list
73 * @chain_key: the hash key of this lock_chain
fbb9ce95
IM
74 */
75struct lock_chain {
d16dbd1b 76 /* see BUILD_BUG_ON()s in add_chain_cache() */
75dd602a
PZ
77 unsigned int irq_context : 2,
78 depth : 6,
79 base : 24;
80 /* 4 byte hole */
a63f38cc 81 struct hlist_node entry;
fbb9ce95
IM
82 u64 chain_key;
83};
84
e5f363e3 85#define MAX_LOCKDEP_KEYS_BITS 13
01bb6f0a
YD
86#define MAX_LOCKDEP_KEYS (1UL << MAX_LOCKDEP_KEYS_BITS)
87#define INITIAL_CHAIN_KEY -1
f82b217e 88
fbb9ce95
IM
89struct held_lock {
90 /*
91 * One-way hash of the dependency chain up to this point. We
92 * hash the hashes step by step as the dependency chain grows.
93 *
94 * We use it for dependency-caching and we skip detection
95 * passes and dependency-updates if there is a cache-hit, so
96 * it is absolutely critical for 100% coverage of the validator
97 * to have a unique key value for every unique dependency path
98 * that can occur in the system, to make a unique hash value
99 * as likely as possible - hence the 64-bit width.
100 *
101 * The task struct holds the current hash value (initialized
102 * with zero), here we store the previous hash value:
103 */
104 u64 prev_chain_key;
fbb9ce95
IM
105 unsigned long acquire_ip;
106 struct lockdep_map *instance;
7531e2f3 107 struct lockdep_map *nest_lock;
f20786ff
PZ
108#ifdef CONFIG_LOCK_STAT
109 u64 waittime_stamp;
110 u64 holdtime_stamp;
111#endif
01bb6f0a
YD
112 /*
113 * class_idx is zero-indexed; it points to the element in
114 * lock_classes this held lock instance belongs to. class_idx is in
115 * the range from 0 to (MAX_LOCKDEP_KEYS-1) inclusive.
116 */
f82b217e 117 unsigned int class_idx:MAX_LOCKDEP_KEYS_BITS;
fbb9ce95
IM
118 /*
119 * The lock-stack is unified in that the lock chains of interrupt
120 * contexts nest ontop of process context chains, but we 'separate'
121 * the hashes by starting with 0 if we cross into an interrupt
122 * context, and we also keep do not add cross-context lock
123 * dependencies - the lock usage graph walking covers that area
124 * anyway, and we'd just unnecessarily increase the number of
125 * dependencies otherwise. [Note: hardirq and softirq contexts
126 * are separated from each other too.]
127 *
128 * The following field is used to detect when we cross into an
129 * interrupt context:
130 */
f82b217e 131 unsigned int irq_context:2; /* bit 0 - soft, bit 1 - hard */
bb97a91e
PZ
132 unsigned int trylock:1; /* 16 bits */
133
f82b217e 134 unsigned int read:2; /* see lock_acquire() comment */
fb9edbe9 135 unsigned int check:1; /* see lock_acquire() comment */
f82b217e 136 unsigned int hardirqs_off:1;
0471db44
BF
137 unsigned int sync:1;
138 unsigned int references:11; /* 32 bits */
a24fc60d 139 unsigned int pin_count;
b09be676
BP
140};
141
fbb9ce95
IM
142/*
143 * Initialization, self-test and debugging-output methods:
144 */
c3bc8fd6 145extern void lockdep_init(void);
fbb9ce95
IM
146extern void lockdep_reset(void);
147extern void lockdep_reset_lock(struct lockdep_map *lock);
148extern void lockdep_free_key_range(void *start, unsigned long size);
63f9a7fd 149extern asmlinkage void lockdep_sys_exit(void);
cdc84d79 150extern void lockdep_set_selftest_task(struct task_struct *task);
fbb9ce95 151
e196e479
YD
152extern void lockdep_init_task(struct task_struct *task);
153
e616cb8d 154/*
e2db7592 155 * Split the recursion counter in two to readily detect 'off' vs recursion.
e616cb8d
PZ
156 */
157#define LOCKDEP_RECURSION_BITS 16
158#define LOCKDEP_OFF (1U << LOCKDEP_RECURSION_BITS)
159#define LOCKDEP_RECURSION_MASK (LOCKDEP_OFF - 1)
160
161/*
162 * lockdep_{off,on}() are macros to avoid tracing and kprobes; not inlines due
163 * to header dependencies.
164 */
165
166#define lockdep_off() \
167do { \
168 current->lockdep_recursion += LOCKDEP_OFF; \
169} while (0)
170
171#define lockdep_on() \
172do { \
173 current->lockdep_recursion -= LOCKDEP_OFF; \
174} while (0)
fbb9ce95 175
108c1485
BVA
176extern void lockdep_register_key(struct lock_class_key *key);
177extern void lockdep_unregister_key(struct lock_class_key *key);
178
fbb9ce95
IM
179/*
180 * These methods are used by specific locking variants (spinlocks,
181 * rwlocks, mutexes and rwsems) to pass init/acquire/release events
182 * to lockdep:
183 */
184
dfd5e3f5
PZ
185extern void lockdep_init_map_type(struct lockdep_map *lock, const char *name,
186 struct lock_class_key *key, int subclass, u8 inner, u8 outer, u8 lock_type);
187
188static inline void
189lockdep_init_map_waits(struct lockdep_map *lock, const char *name,
190 struct lock_class_key *key, int subclass, u8 inner, u8 outer)
191{
eae6d58d 192 lockdep_init_map_type(lock, name, key, subclass, inner, outer, LD_LOCK_NORMAL);
dfd5e3f5 193}
de8f5e4f
PZ
194
195static inline void
196lockdep_init_map_wait(struct lockdep_map *lock, const char *name,
dfd5e3f5 197 struct lock_class_key *key, int subclass, u8 inner)
de8f5e4f
PZ
198{
199 lockdep_init_map_waits(lock, name, key, subclass, inner, LD_WAIT_INV);
200}
201
202static inline void lockdep_init_map(struct lockdep_map *lock, const char *name,
203 struct lock_class_key *key, int subclass)
204{
205 lockdep_init_map_wait(lock, name, key, subclass, LD_WAIT_INV);
206}
fbb9ce95
IM
207
208/*
209 * Reinitialize a lock key - for cases where there is special locking or
210 * special initialization of locks so that the validator gets the scope
211 * of dependencies wrong: they are either too broad (they need a class-split)
212 * or they are too narrow (they suffer from a false class-split):
213 */
de8f5e4f 214#define lockdep_set_class(lock, key) \
eae6d58d
PZ
215 lockdep_init_map_type(&(lock)->dep_map, #key, key, 0, \
216 (lock)->dep_map.wait_type_inner, \
217 (lock)->dep_map.wait_type_outer, \
218 (lock)->dep_map.lock_type)
de8f5e4f
PZ
219
220#define lockdep_set_class_and_name(lock, key, name) \
eae6d58d
PZ
221 lockdep_init_map_type(&(lock)->dep_map, name, key, 0, \
222 (lock)->dep_map.wait_type_inner, \
223 (lock)->dep_map.wait_type_outer, \
224 (lock)->dep_map.lock_type)
de8f5e4f
PZ
225
226#define lockdep_set_class_and_subclass(lock, key, sub) \
eae6d58d
PZ
227 lockdep_init_map_type(&(lock)->dep_map, #key, key, sub, \
228 (lock)->dep_map.wait_type_inner, \
229 (lock)->dep_map.wait_type_outer, \
230 (lock)->dep_map.lock_type)
de8f5e4f
PZ
231
232#define lockdep_set_subclass(lock, sub) \
eae6d58d
PZ
233 lockdep_init_map_type(&(lock)->dep_map, #lock, (lock)->dep_map.key, sub,\
234 (lock)->dep_map.wait_type_inner, \
235 (lock)->dep_map.wait_type_outer, \
236 (lock)->dep_map.lock_type)
1704f47b
PZ
237
238#define lockdep_set_novalidate_class(lock) \
47be1c1a 239 lockdep_set_class_and_name(lock, &__lockdep_no_validate__, #lock)
de8f5e4f 240
9a7aa12f
JK
241/*
242 * Compare locking classes
243 */
244#define lockdep_match_class(lock, key) lockdep_match_key(&(lock)->dep_map, key)
245
246static inline int lockdep_match_key(struct lockdep_map *lock,
247 struct lock_class_key *key)
248{
249 return lock->key == key;
250}
fbb9ce95
IM
251
252/*
253 * Acquire a lock.
254 *
255 * Values for "read":
256 *
257 * 0: exclusive (write) acquire
258 * 1: read-acquire (no recursion allowed)
259 * 2: read-acquire with same-instance recursion allowed
260 *
261 * Values for check:
262 *
fb9edbe9
ON
263 * 0: simple checks (freeing, held-at-exit-time, etc.)
264 * 1: full validation
fbb9ce95
IM
265 */
266extern void lock_acquire(struct lockdep_map *lock, unsigned int subclass,
7531e2f3
PZ
267 int trylock, int read, int check,
268 struct lockdep_map *nest_lock, unsigned long ip);
fbb9ce95 269
5facae4f 270extern void lock_release(struct lockdep_map *lock, unsigned long ip);
fbb9ce95 271
2f1f043e
BF
272extern void lock_sync(struct lockdep_map *lock, unsigned int subclass,
273 int read, int check, struct lockdep_map *nest_lock,
274 unsigned long ip);
275
f8cfa466
SK
276/* lock_is_held_type() returns */
277#define LOCK_STATE_UNKNOWN -1
278#define LOCK_STATE_NOT_HELD 0
279#define LOCK_STATE_HELD 1
280
f8319483
PZ
281/*
282 * Same "read" as for lock_acquire(), except -1 means any.
283 */
08f36ff6 284extern int lock_is_held_type(const struct lockdep_map *lock, int read);
f8319483 285
08f36ff6 286static inline int lock_is_held(const struct lockdep_map *lock)
f8319483
PZ
287{
288 return lock_is_held_type(lock, -1);
289}
f607c668 290
f8319483
PZ
291#define lockdep_is_held(lock) lock_is_held(&(lock)->dep_map)
292#define lockdep_is_held_type(lock, r) lock_is_held_type(&(lock)->dep_map, (r))
f607c668 293
00ef9f73
PZ
294extern void lock_set_class(struct lockdep_map *lock, const char *name,
295 struct lock_class_key *key, unsigned int subclass,
296 unsigned long ip);
297
d864b8ea
DW
298#define lock_set_novalidate_class(l, n, i) \
299 lock_set_class(l, n, &__lockdep_no_validate__, 0, i)
300
00ef9f73
PZ
301static inline void lock_set_subclass(struct lockdep_map *lock,
302 unsigned int subclass, unsigned long ip)
303{
304 lock_set_class(lock, lock->name, lock->key, subclass, ip);
305}
64aa348e 306
6419c4af
O
307extern void lock_downgrade(struct lockdep_map *lock, unsigned long ip);
308
e7904a28
PZ
309#define NIL_COOKIE (struct pin_cookie){ .val = 0U, }
310
311extern struct pin_cookie lock_pin_lock(struct lockdep_map *lock);
312extern void lock_repin_lock(struct lockdep_map *lock, struct pin_cookie);
313extern void lock_unpin_lock(struct lockdep_map *lock, struct pin_cookie);
a24fc60d 314
e3a55fd1 315#define lockdep_depth(tsk) (debug_locks ? (tsk)->lockdep_depth : 0)
d5abe669 316
d19c8137
PZ
317#define lockdep_assert(cond) \
318 do { WARN_ON(debug_locks && !(cond)); } while (0)
3e31f947 319
d19c8137
PZ
320#define lockdep_assert_once(cond) \
321 do { WARN_ON_ONCE(debug_locks && !(cond)); } while (0)
f607c668 322
d19c8137
PZ
323#define lockdep_assert_held(l) \
324 lockdep_assert(lockdep_is_held(l) != LOCK_STATE_NOT_HELD)
f8319483 325
d19c8137
PZ
326#define lockdep_assert_not_held(l) \
327 lockdep_assert(lockdep_is_held(l) != LOCK_STATE_HELD)
f8319483 328
d19c8137
PZ
329#define lockdep_assert_held_write(l) \
330 lockdep_assert(lockdep_is_held_type(l, 0))
9a37110d 331
d19c8137
PZ
332#define lockdep_assert_held_read(l) \
333 lockdep_assert(lockdep_is_held_type(l, 1))
334
335#define lockdep_assert_held_once(l) \
336 lockdep_assert_once(lockdep_is_held(l) != LOCK_STATE_NOT_HELD)
337
338#define lockdep_assert_none_held_once() \
339 lockdep_assert_once(!current->lockdep_depth)
7621350c 340
94d24fc4
PZ
341#define lockdep_recursing(tsk) ((tsk)->lockdep_recursion)
342
e7904a28
PZ
343#define lockdep_pin_lock(l) lock_pin_lock(&(l)->dep_map)
344#define lockdep_repin_lock(l,c) lock_repin_lock(&(l)->dep_map, (c))
345#define lockdep_unpin_lock(l,c) lock_unpin_lock(&(l)->dep_map, (c))
a24fc60d 346
a51805ef 347#else /* !CONFIG_LOCKDEP */
fbb9ce95 348
e196e479
YD
349static inline void lockdep_init_task(struct task_struct *task)
350{
351}
352
fbb9ce95
IM
353static inline void lockdep_off(void)
354{
355}
356
357static inline void lockdep_on(void)
358{
359}
360
cdc84d79
BVA
361static inline void lockdep_set_selftest_task(struct task_struct *task)
362{
363}
364
7531e2f3 365# define lock_acquire(l, s, t, r, c, n, i) do { } while (0)
5facae4f 366# define lock_release(l, i) do { } while (0)
6419c4af 367# define lock_downgrade(l, i) do { } while (0)
d864b8ea
DW
368# define lock_set_class(l, n, key, s, i) do { (void)(key); } while (0)
369# define lock_set_novalidate_class(l, n, i) do { } while (0)
64aa348e 370# define lock_set_subclass(l, s, i) do { } while (0)
c3bc8fd6 371# define lockdep_init() do { } while (0)
dfd5e3f5
PZ
372# define lockdep_init_map_type(lock, name, key, sub, inner, outer, type) \
373 do { (void)(name); (void)(key); } while (0)
de8f5e4f
PZ
374# define lockdep_init_map_waits(lock, name, key, sub, inner, outer) \
375 do { (void)(name); (void)(key); } while (0)
376# define lockdep_init_map_wait(lock, name, key, sub, inner) \
377 do { (void)(name); (void)(key); } while (0)
e25cf3db
IM
378# define lockdep_init_map(lock, name, key, sub) \
379 do { (void)(name); (void)(key); } while (0)
fbb9ce95
IM
380# define lockdep_set_class(lock, key) do { (void)(key); } while (0)
381# define lockdep_set_class_and_name(lock, key, name) \
e25cf3db 382 do { (void)(key); (void)(name); } while (0)
4dfbb9d8
PZ
383#define lockdep_set_class_and_subclass(lock, key, sub) \
384 do { (void)(key); } while (0)
07646e21 385#define lockdep_set_subclass(lock, sub) do { } while (0)
1704f47b
PZ
386
387#define lockdep_set_novalidate_class(lock) do { } while (0)
388
9a7aa12f
JK
389/*
390 * We don't define lockdep_match_class() and lockdep_match_key() for !LOCKDEP
391 * case since the result is not well defined and the caller should rather
392 * #ifdef the call himself.
393 */
07646e21 394
fbb9ce95
IM
395# define lockdep_reset() do { debug_locks = 1; } while (0)
396# define lockdep_free_key_range(start, size) do { } while (0)
b351d164 397# define lockdep_sys_exit() do { } while (0)
d5abe669 398
108c1485
BVA
399static inline void lockdep_register_key(struct lock_class_key *key)
400{
401}
402
403static inline void lockdep_unregister_key(struct lock_class_key *key)
404{
405}
406
d5abe669
PZ
407#define lockdep_depth(tsk) (0)
408
cd539cff
JK
409/*
410 * Dummy forward declarations, allow users to write less ifdef-y code
411 * and depend on dead code elimination.
412 */
413extern int lock_is_held(const void *);
414extern int lockdep_is_held(const void *);
f8319483
PZ
415#define lockdep_is_held_type(l, r) (1)
416
d19c8137
PZ
417#define lockdep_assert(c) do { } while (0)
418#define lockdep_assert_once(c) do { } while (0)
419
5cd3f5af 420#define lockdep_assert_held(l) do { (void)(l); } while (0)
3e31f947
SK
421#define lockdep_assert_not_held(l) do { (void)(l); } while (0)
422#define lockdep_assert_held_write(l) do { (void)(l); } while (0)
f8319483 423#define lockdep_assert_held_read(l) do { (void)(l); } while (0)
9a37110d 424#define lockdep_assert_held_once(l) do { (void)(l); } while (0)
7621350c 425#define lockdep_assert_none_held_once() do { } while (0)
f607c668 426
94d24fc4
PZ
427#define lockdep_recursing(tsk) (0)
428
e7904a28
PZ
429#define NIL_COOKIE (struct pin_cookie){ }
430
3771b0fe 431#define lockdep_pin_lock(l) ({ struct pin_cookie cookie = { }; cookie; })
e7904a28
PZ
432#define lockdep_repin_lock(l, c) do { (void)(l); (void)(c); } while (0)
433#define lockdep_unpin_lock(l, c) do { (void)(l); (void)(c); } while (0)
a24fc60d 434
fbb9ce95
IM
435#endif /* !LOCKDEP */
436
b09be676
BP
437enum xhlock_context_t {
438 XHLOCK_HARD,
439 XHLOCK_SOFT,
b09be676
BP
440 XHLOCK_CTX_NR,
441};
442
b09be676
BP
443/*
444 * To initialize a lockdep_map statically use this macro.
445 * Note that _name must not be NULL.
446 */
447#define STATIC_LOCKDEP_MAP_INIT(_name, _key) \
448 { .name = (_name), .key = (void *)(_key), }
449
f52be570 450static inline void lockdep_invariant_state(bool force) {}
b09be676 451static inline void lockdep_free_task(struct task_struct *task) {}
b09be676 452
f20786ff
PZ
453#ifdef CONFIG_LOCK_STAT
454
455extern void lock_contended(struct lockdep_map *lock, unsigned long ip);
c7e78cff 456extern void lock_acquired(struct lockdep_map *lock, unsigned long ip);
f20786ff
PZ
457
458#define LOCK_CONTENDED(_lock, try, lock) \
459do { \
460 if (!try(_lock)) { \
461 lock_contended(&(_lock)->dep_map, _RET_IP_); \
462 lock(_lock); \
f20786ff 463 } \
c7e78cff 464 lock_acquired(&(_lock)->dep_map, _RET_IP_); \
f20786ff
PZ
465} while (0)
466
916633a4
MH
467#define LOCK_CONTENDED_RETURN(_lock, try, lock) \
468({ \
469 int ____err = 0; \
470 if (!try(_lock)) { \
471 lock_contended(&(_lock)->dep_map, _RET_IP_); \
472 ____err = lock(_lock); \
473 } \
474 if (!____err) \
475 lock_acquired(&(_lock)->dep_map, _RET_IP_); \
476 ____err; \
477})
478
f20786ff
PZ
479#else /* CONFIG_LOCK_STAT */
480
481#define lock_contended(lockdep_map, ip) do {} while (0)
c7e78cff 482#define lock_acquired(lockdep_map, ip) do {} while (0)
f20786ff
PZ
483
484#define LOCK_CONTENDED(_lock, try, lock) \
485 lock(_lock)
486
916633a4
MH
487#define LOCK_CONTENDED_RETURN(_lock, try, lock) \
488 lock(_lock)
489
f20786ff
PZ
490#endif /* CONFIG_LOCK_STAT */
491
c3bc8fd6 492#ifdef CONFIG_PROVE_LOCKING
3117df04 493extern void print_irqtrace_events(struct task_struct *curr);
fbb9ce95 494#else
3117df04
IM
495static inline void print_irqtrace_events(struct task_struct *curr)
496{
497}
fbb9ce95
IM
498#endif
499
e9181886
BF
500/* Variable used to make lockdep treat read_lock() as recursive in selftests */
501#ifdef CONFIG_DEBUG_LOCKING_API_SELFTESTS
502extern unsigned int force_read_lock_recursive;
503#else /* CONFIG_DEBUG_LOCKING_API_SELFTESTS */
504#define force_read_lock_recursive 0
505#endif /* CONFIG_DEBUG_LOCKING_API_SELFTESTS */
506
507#ifdef CONFIG_LOCKDEP
508extern bool read_lock_is_recursive(void);
509#else /* CONFIG_LOCKDEP */
510/* If !LOCKDEP, the value is meaningless */
511#define read_lock_is_recursive() 0
512#endif
513
fbb9ce95
IM
514/*
515 * For trivial one-depth nesting of a lock-class, the following
516 * global define can be used. (Subsystems with multiple levels
517 * of nesting should define their own lock-nesting subclasses.)
518 */
519#define SINGLE_DEPTH_NESTING 1
520
521/*
522 * Map the dependency ops to NOP or to real lockdep ops, depending
523 * on the per lock-class debug mode:
524 */
525
fb9edbe9
ON
526#define lock_acquire_exclusive(l, s, t, n, i) lock_acquire(l, s, t, 0, 1, n, i)
527#define lock_acquire_shared(l, s, t, n, i) lock_acquire(l, s, t, 1, 1, n, i)
528#define lock_acquire_shared_recursive(l, s, t, n, i) lock_acquire(l, s, t, 2, 1, n, i)
fbb9ce95 529
a51805ef
ML
530#define spin_acquire(l, s, t, i) lock_acquire_exclusive(l, s, t, NULL, i)
531#define spin_acquire_nest(l, s, t, n, i) lock_acquire_exclusive(l, s, t, n, i)
5facae4f 532#define spin_release(l, i) lock_release(l, i)
fbb9ce95 533
a51805ef 534#define rwlock_acquire(l, s, t, i) lock_acquire_exclusive(l, s, t, NULL, i)
e9181886
BF
535#define rwlock_acquire_read(l, s, t, i) \
536do { \
537 if (read_lock_is_recursive()) \
538 lock_acquire_shared_recursive(l, s, t, NULL, i); \
539 else \
540 lock_acquire_shared(l, s, t, NULL, i); \
541} while (0)
542
5facae4f 543#define rwlock_release(l, i) lock_release(l, i)
fbb9ce95 544
1ca7d67c
JS
545#define seqcount_acquire(l, s, t, i) lock_acquire_exclusive(l, s, t, NULL, i)
546#define seqcount_acquire_read(l, s, t, i) lock_acquire_shared_recursive(l, s, t, NULL, i)
5facae4f 547#define seqcount_release(l, i) lock_release(l, i)
1ca7d67c 548
a51805ef
ML
549#define mutex_acquire(l, s, t, i) lock_acquire_exclusive(l, s, t, NULL, i)
550#define mutex_acquire_nest(l, s, t, n, i) lock_acquire_exclusive(l, s, t, n, i)
5facae4f 551#define mutex_release(l, i) lock_release(l, i)
a51805ef
ML
552
553#define rwsem_acquire(l, s, t, i) lock_acquire_exclusive(l, s, t, NULL, i)
554#define rwsem_acquire_nest(l, s, t, n, i) lock_acquire_exclusive(l, s, t, n, i)
555#define rwsem_acquire_read(l, s, t, i) lock_acquire_shared(l, s, t, NULL, i)
5facae4f 556#define rwsem_release(l, i) lock_release(l, i)
fbb9ce95 557
a51805ef
ML
558#define lock_map_acquire(l) lock_acquire_exclusive(l, 0, 0, NULL, _THIS_IP_)
559#define lock_map_acquire_read(l) lock_acquire_shared_recursive(l, 0, 0, NULL, _THIS_IP_)
dd56af42 560#define lock_map_acquire_tryread(l) lock_acquire_shared_recursive(l, 0, 1, NULL, _THIS_IP_)
5facae4f 561#define lock_map_release(l) lock_release(l, _THIS_IP_)
2f1f043e 562#define lock_map_sync(l) lock_sync(l, 0, 0, 1, NULL, _THIS_IP_)
4f3e7524 563
76b189e9 564#ifdef CONFIG_PROVE_LOCKING
baffd723 565# define might_lock(lock) \
76b189e9
PZ
566do { \
567 typecheck(struct lockdep_map *, &(lock)->dep_map); \
fb9edbe9 568 lock_acquire(&(lock)->dep_map, 0, 0, 0, 1, NULL, _THIS_IP_); \
5facae4f 569 lock_release(&(lock)->dep_map, _THIS_IP_); \
76b189e9 570} while (0)
baffd723 571# define might_lock_read(lock) \
76b189e9
PZ
572do { \
573 typecheck(struct lockdep_map *, &(lock)->dep_map); \
fb9edbe9 574 lock_acquire(&(lock)->dep_map, 0, 0, 1, 1, NULL, _THIS_IP_); \
5facae4f 575 lock_release(&(lock)->dep_map, _THIS_IP_); \
76b189e9 576} while (0)
baffd723 577# define might_lock_nested(lock, subclass) \
e692b402
DV
578do { \
579 typecheck(struct lockdep_map *, &(lock)->dep_map); \
580 lock_acquire(&(lock)->dep_map, subclass, 0, 1, 1, NULL, \
581 _THIS_IP_); \
023265ed 582 lock_release(&(lock)->dep_map, _THIS_IP_); \
e692b402 583} while (0)
f54bb2ec 584
a21ee605
PZ
585DECLARE_PER_CPU(int, hardirqs_enabled);
586DECLARE_PER_CPU(int, hardirq_context);
4d004099 587DECLARE_PER_CPU(unsigned int, lockdep_recursion);
f54bb2ec 588
baffd723 589#define __lockdep_enabled (debug_locks && !this_cpu_read(lockdep_recursion))
fddf9055 590
a21ee605
PZ
591#define lockdep_assert_irqs_enabled() \
592do { \
baffd723 593 WARN_ON_ONCE(__lockdep_enabled && !this_cpu_read(hardirqs_enabled)); \
a21ee605 594} while (0)
f54bb2ec 595
a21ee605
PZ
596#define lockdep_assert_irqs_disabled() \
597do { \
baffd723 598 WARN_ON_ONCE(__lockdep_enabled && this_cpu_read(hardirqs_enabled)); \
a21ee605
PZ
599} while (0)
600
601#define lockdep_assert_in_irq() \
602do { \
baffd723 603 WARN_ON_ONCE(__lockdep_enabled && !this_cpu_read(hardirq_context)); \
a21ee605 604} while (0)
71d8d153 605
8fd8ad5c
AD
606#define lockdep_assert_preemption_enabled() \
607do { \
608 WARN_ON_ONCE(IS_ENABLED(CONFIG_PREEMPT_COUNT) && \
4d004099 609 __lockdep_enabled && \
8fd8ad5c 610 (preempt_count() != 0 || \
baffd723 611 !this_cpu_read(hardirqs_enabled))); \
8fd8ad5c
AD
612} while (0)
613
614#define lockdep_assert_preemption_disabled() \
615do { \
616 WARN_ON_ONCE(IS_ENABLED(CONFIG_PREEMPT_COUNT) && \
4d004099 617 __lockdep_enabled && \
8fd8ad5c 618 (preempt_count() == 0 && \
baffd723 619 this_cpu_read(hardirqs_enabled))); \
8fd8ad5c
AD
620} while (0)
621
8b5536ad
YL
622/*
623 * Acceptable for protecting per-CPU resources accessed from BH.
624 * Much like in_softirq() - semantics are ambiguous, use carefully.
625 */
626#define lockdep_assert_in_softirq() \
627do { \
628 WARN_ON_ONCE(__lockdep_enabled && \
629 (!in_softirq() || in_irq() || in_nmi())); \
630} while (0)
631
76b189e9
PZ
632#else
633# define might_lock(lock) do { } while (0)
634# define might_lock_read(lock) do { } while (0)
e692b402 635# define might_lock_nested(lock, subclass) do { } while (0)
a21ee605 636
f54bb2ec
FW
637# define lockdep_assert_irqs_enabled() do { } while (0)
638# define lockdep_assert_irqs_disabled() do { } while (0)
71d8d153 639# define lockdep_assert_in_irq() do { } while (0)
8fd8ad5c
AD
640
641# define lockdep_assert_preemption_enabled() do { } while (0)
642# define lockdep_assert_preemption_disabled() do { } while (0)
8b5536ad 643# define lockdep_assert_in_softirq() do { } while (0)
76b189e9
PZ
644#endif
645
8bf6c677
SS
646#ifdef CONFIG_PROVE_RAW_LOCK_NESTING
647
648# define lockdep_assert_RT_in_threaded_ctx() do { \
649 WARN_ONCE(debug_locks && !current->lockdep_recursion && \
f9ad4a5f 650 lockdep_hardirq_context() && \
8bf6c677
SS
651 !(current->hardirq_threaded || current->irq_config), \
652 "Not in threaded context on PREEMPT_RT as expected\n"); \
653} while (0)
654
655#else
656
657# define lockdep_assert_RT_in_threaded_ctx() do { } while (0)
658
659#endif
660
d24209bb 661#ifdef CONFIG_LOCKDEP
b3fbab05 662void lockdep_rcu_suspicious(const char *file, const int line, const char *s);
d24209bb
PM
663#else
664static inline void
665lockdep_rcu_suspicious(const char *file, const int line, const char *s)
666{
667}
0632eb3d
PM
668#endif
669
fbb9ce95 670#endif /* __LINUX_LOCKDEP_H */