]>
Commit | Line | Data |
---|---|---|
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 | ||
a1e96b03 | 13 | struct task_struct; |
f20786ff | 14 | struct lockdep_map; |
a1e96b03 | 15 | |
2edf5e49 DY |
16 | /* for sysctl */ |
17 | extern int prove_locking; | |
18 | extern int lock_stat; | |
19 | ||
a5ecddfe BG |
20 | #define MAX_LOCKDEP_SUBCLASSES 8UL |
21 | ||
e6f3faa7 PZ |
22 | #include <linux/types.h> |
23 | ||
db0b0ead MT |
24 | #ifdef CONFIG_LOCKDEP |
25 | ||
fbb9ce95 IM |
26 | #include <linux/linkage.h> |
27 | #include <linux/list.h> | |
28 | #include <linux/debug_locks.h> | |
29 | #include <linux/stacktrace.h> | |
30 | ||
fbb9ce95 | 31 | /* |
9851673b PZ |
32 | * We'd rather not expose kernel/lockdep_states.h this wide, but we do need |
33 | * the total number of states... :-( | |
fbb9ce95 | 34 | */ |
d92a8cfc | 35 | #define XXX_LOCK_USAGE_STATES (1+2*4) |
fbb9ce95 | 36 | |
62016250 HM |
37 | /* |
38 | * 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 | ||
fbb9ce95 | 48 | /* |
108c1485 BVA |
49 | * A lockdep key is associated with each lock object. For static locks we use |
50 | * the lock address itself as the key. Dynamically allocated lock objects can | |
51 | * have a statically or dynamically allocated key. Dynamically allocated lock | |
52 | * keys must be registered before being used and must be unregistered before | |
53 | * the key memory is freed. | |
fbb9ce95 IM |
54 | */ |
55 | struct lockdep_subclass_key { | |
56 | char __one_byte; | |
57 | } __attribute__ ((__packed__)); | |
58 | ||
108c1485 | 59 | /* hash_entry is used to keep track of dynamically allocated keys. */ |
fbb9ce95 | 60 | struct lock_class_key { |
28d49e28 PZ |
61 | union { |
62 | struct hlist_node hash_entry; | |
63 | struct lockdep_subclass_key subkeys[MAX_LOCKDEP_SUBCLASSES]; | |
64 | }; | |
fbb9ce95 IM |
65 | }; |
66 | ||
1704f47b PZ |
67 | extern struct lock_class_key __lockdep_no_validate__; |
68 | ||
12593b74 | 69 | struct lock_trace; |
c120bce7 | 70 | |
c7e78cff PZ |
71 | #define LOCKSTAT_POINTS 4 |
72 | ||
fbb9ce95 | 73 | /* |
a0b0fd53 BVA |
74 | * The lock-class itself. The order of the structure members matters. |
75 | * reinit_class() zeroes the key member and all subsequent members. | |
fbb9ce95 IM |
76 | */ |
77 | struct lock_class { | |
78 | /* | |
79 | * class-hash: | |
80 | */ | |
a63f38cc | 81 | struct hlist_node hash_entry; |
fbb9ce95 IM |
82 | |
83 | /* | |
a0b0fd53 BVA |
84 | * Entry in all_lock_classes when in use. Entry in free_lock_classes |
85 | * when not in use. Instances that are being freed are on one of the | |
86 | * zapped_classes lists. | |
fbb9ce95 IM |
87 | */ |
88 | struct list_head lock_entry; | |
89 | ||
09329d1c BVA |
90 | /* |
91 | * These fields represent a directed graph of lock dependencies, | |
92 | * to every node we attach a list of "forward" and a list of | |
93 | * "backward" graph nodes. | |
94 | */ | |
95 | struct list_head locks_after, locks_before; | |
96 | ||
364f6afc | 97 | const struct lockdep_subclass_key *key; |
fbb9ce95 | 98 | unsigned int subclass; |
e351b660 | 99 | unsigned int dep_gen_id; |
fbb9ce95 IM |
100 | |
101 | /* | |
102 | * IRQ/softirq usage tracking bits: | |
103 | */ | |
104 | unsigned long usage_mask; | |
12593b74 | 105 | const struct lock_trace *usage_traces[XXX_LOCK_USAGE_STATES]; |
fbb9ce95 | 106 | |
fbb9ce95 IM |
107 | /* |
108 | * Generation counter, when doing certain classes of graph walking, | |
109 | * to ensure that we check one node only once: | |
110 | */ | |
fbb9ce95 | 111 | int name_version; |
8ca2b56c | 112 | const char *name; |
f20786ff PZ |
113 | |
114 | #ifdef CONFIG_LOCK_STAT | |
c7e78cff PZ |
115 | unsigned long contention_point[LOCKSTAT_POINTS]; |
116 | unsigned long contending_point[LOCKSTAT_POINTS]; | |
f20786ff | 117 | #endif |
a0b0fd53 | 118 | } __no_randomize_layout; |
f20786ff PZ |
119 | |
120 | #ifdef CONFIG_LOCK_STAT | |
121 | struct lock_time { | |
122 | s64 min; | |
123 | s64 max; | |
124 | s64 total; | |
125 | unsigned long nr; | |
fbb9ce95 IM |
126 | }; |
127 | ||
96645678 PZ |
128 | enum bounce_type { |
129 | bounce_acquired_write, | |
130 | bounce_acquired_read, | |
131 | bounce_contended_write, | |
132 | bounce_contended_read, | |
133 | nr_bounce_types, | |
134 | ||
135 | bounce_acquired = bounce_acquired_write, | |
136 | bounce_contended = bounce_contended_write, | |
137 | }; | |
138 | ||
f20786ff | 139 | struct lock_class_stats { |
68722101 GB |
140 | unsigned long contention_point[LOCKSTAT_POINTS]; |
141 | unsigned long contending_point[LOCKSTAT_POINTS]; | |
f20786ff PZ |
142 | struct lock_time read_waittime; |
143 | struct lock_time write_waittime; | |
144 | struct lock_time read_holdtime; | |
145 | struct lock_time write_holdtime; | |
96645678 | 146 | unsigned long bounces[nr_bounce_types]; |
f20786ff PZ |
147 | }; |
148 | ||
149 | struct lock_class_stats lock_stats(struct lock_class *class); | |
150 | void clear_lock_stats(struct lock_class *class); | |
151 | #endif | |
152 | ||
fbb9ce95 IM |
153 | /* |
154 | * Map the lock object (the lock instance) to the lock-class object. | |
155 | * This is embedded into specific lock instances: | |
156 | */ | |
157 | struct lockdep_map { | |
158 | struct lock_class_key *key; | |
62016250 | 159 | struct lock_class *class_cache[NR_LOCKDEP_CACHING_CLASSES]; |
fbb9ce95 | 160 | const char *name; |
96645678 PZ |
161 | #ifdef CONFIG_LOCK_STAT |
162 | int cpu; | |
c7e78cff | 163 | unsigned long ip; |
96645678 | 164 | #endif |
fbb9ce95 IM |
165 | }; |
166 | ||
4d82a1de PZ |
167 | static inline void lockdep_copy_map(struct lockdep_map *to, |
168 | struct lockdep_map *from) | |
169 | { | |
170 | int i; | |
171 | ||
172 | *to = *from; | |
173 | /* | |
174 | * Since the class cache can be modified concurrently we could observe | |
175 | * half pointers (64bit arch using 32bit copy insns). Therefore clear | |
176 | * the caches and take the performance hit. | |
177 | * | |
178 | * XXX it doesn't work well with lockdep_set_class_and_subclass(), since | |
179 | * that relies on cache abuse. | |
180 | */ | |
181 | for (i = 0; i < NR_LOCKDEP_CACHING_CLASSES; i++) | |
182 | to->class_cache[i] = NULL; | |
183 | } | |
184 | ||
fbb9ce95 IM |
185 | /* |
186 | * Every lock has a list of other locks that were taken after it. | |
187 | * We only grow the list, never remove from it: | |
188 | */ | |
189 | struct lock_list { | |
190 | struct list_head entry; | |
191 | struct lock_class *class; | |
86cffb80 | 192 | struct lock_class *links_to; |
12593b74 | 193 | const struct lock_trace *trace; |
068135e6 | 194 | int distance; |
c94aa5ca | 195 | |
af012961 PZ |
196 | /* |
197 | * The parent field is used to implement breadth-first search, and the | |
198 | * bit 0 is reused to indicate if the lock has been accessed in BFS. | |
c94aa5ca ML |
199 | */ |
200 | struct lock_list *parent; | |
fbb9ce95 IM |
201 | }; |
202 | ||
d16dbd1b YD |
203 | /** |
204 | * struct lock_chain - lock dependency chain record | |
205 | * | |
206 | * @irq_context: the same as irq_context in held_lock below | |
207 | * @depth: the number of held locks in this chain | |
208 | * @base: the index in chain_hlocks for this chain | |
209 | * @entry: the collided lock chains in lock_chain hash list | |
210 | * @chain_key: the hash key of this lock_chain | |
fbb9ce95 IM |
211 | */ |
212 | struct lock_chain { | |
d16dbd1b | 213 | /* see BUILD_BUG_ON()s in add_chain_cache() */ |
75dd602a PZ |
214 | unsigned int irq_context : 2, |
215 | depth : 6, | |
216 | base : 24; | |
217 | /* 4 byte hole */ | |
a63f38cc | 218 | struct hlist_node entry; |
fbb9ce95 IM |
219 | u64 chain_key; |
220 | }; | |
221 | ||
e5f363e3 | 222 | #define MAX_LOCKDEP_KEYS_BITS 13 |
01bb6f0a YD |
223 | #define MAX_LOCKDEP_KEYS (1UL << MAX_LOCKDEP_KEYS_BITS) |
224 | #define INITIAL_CHAIN_KEY -1 | |
f82b217e | 225 | |
fbb9ce95 IM |
226 | struct held_lock { |
227 | /* | |
228 | * One-way hash of the dependency chain up to this point. We | |
229 | * hash the hashes step by step as the dependency chain grows. | |
230 | * | |
231 | * We use it for dependency-caching and we skip detection | |
232 | * passes and dependency-updates if there is a cache-hit, so | |
233 | * it is absolutely critical for 100% coverage of the validator | |
234 | * to have a unique key value for every unique dependency path | |
235 | * that can occur in the system, to make a unique hash value | |
236 | * as likely as possible - hence the 64-bit width. | |
237 | * | |
238 | * The task struct holds the current hash value (initialized | |
239 | * with zero), here we store the previous hash value: | |
240 | */ | |
241 | u64 prev_chain_key; | |
fbb9ce95 IM |
242 | unsigned long acquire_ip; |
243 | struct lockdep_map *instance; | |
7531e2f3 | 244 | struct lockdep_map *nest_lock; |
f20786ff PZ |
245 | #ifdef CONFIG_LOCK_STAT |
246 | u64 waittime_stamp; | |
247 | u64 holdtime_stamp; | |
248 | #endif | |
01bb6f0a YD |
249 | /* |
250 | * class_idx is zero-indexed; it points to the element in | |
251 | * lock_classes this held lock instance belongs to. class_idx is in | |
252 | * the range from 0 to (MAX_LOCKDEP_KEYS-1) inclusive. | |
253 | */ | |
f82b217e | 254 | unsigned int class_idx:MAX_LOCKDEP_KEYS_BITS; |
fbb9ce95 IM |
255 | /* |
256 | * The lock-stack is unified in that the lock chains of interrupt | |
257 | * contexts nest ontop of process context chains, but we 'separate' | |
258 | * the hashes by starting with 0 if we cross into an interrupt | |
259 | * context, and we also keep do not add cross-context lock | |
260 | * dependencies - the lock usage graph walking covers that area | |
261 | * anyway, and we'd just unnecessarily increase the number of | |
262 | * dependencies otherwise. [Note: hardirq and softirq contexts | |
263 | * are separated from each other too.] | |
264 | * | |
265 | * The following field is used to detect when we cross into an | |
266 | * interrupt context: | |
267 | */ | |
f82b217e | 268 | unsigned int irq_context:2; /* bit 0 - soft, bit 1 - hard */ |
bb97a91e PZ |
269 | unsigned int trylock:1; /* 16 bits */ |
270 | ||
f82b217e | 271 | unsigned int read:2; /* see lock_acquire() comment */ |
fb9edbe9 | 272 | unsigned int check:1; /* see lock_acquire() comment */ |
f82b217e | 273 | unsigned int hardirqs_off:1; |
fb9edbe9 | 274 | unsigned int references:12; /* 32 bits */ |
a24fc60d | 275 | unsigned int pin_count; |
b09be676 BP |
276 | }; |
277 | ||
fbb9ce95 IM |
278 | /* |
279 | * Initialization, self-test and debugging-output methods: | |
280 | */ | |
c3bc8fd6 | 281 | extern void lockdep_init(void); |
fbb9ce95 IM |
282 | extern void lockdep_reset(void); |
283 | extern void lockdep_reset_lock(struct lockdep_map *lock); | |
284 | extern void lockdep_free_key_range(void *start, unsigned long size); | |
63f9a7fd | 285 | extern asmlinkage void lockdep_sys_exit(void); |
cdc84d79 | 286 | extern void lockdep_set_selftest_task(struct task_struct *task); |
fbb9ce95 | 287 | |
e196e479 YD |
288 | extern void lockdep_init_task(struct task_struct *task); |
289 | ||
fbb9ce95 IM |
290 | extern void lockdep_off(void); |
291 | extern void lockdep_on(void); | |
fbb9ce95 | 292 | |
108c1485 BVA |
293 | extern void lockdep_register_key(struct lock_class_key *key); |
294 | extern void lockdep_unregister_key(struct lock_class_key *key); | |
295 | ||
fbb9ce95 IM |
296 | /* |
297 | * These methods are used by specific locking variants (spinlocks, | |
298 | * rwlocks, mutexes and rwsems) to pass init/acquire/release events | |
299 | * to lockdep: | |
300 | */ | |
301 | ||
302 | extern void lockdep_init_map(struct lockdep_map *lock, const char *name, | |
4dfbb9d8 | 303 | struct lock_class_key *key, int subclass); |
fbb9ce95 IM |
304 | |
305 | /* | |
306 | * Reinitialize a lock key - for cases where there is special locking or | |
307 | * special initialization of locks so that the validator gets the scope | |
308 | * of dependencies wrong: they are either too broad (they need a class-split) | |
309 | * or they are too narrow (they suffer from a false class-split): | |
310 | */ | |
311 | #define lockdep_set_class(lock, key) \ | |
4dfbb9d8 | 312 | lockdep_init_map(&(lock)->dep_map, #key, key, 0) |
fbb9ce95 | 313 | #define lockdep_set_class_and_name(lock, key, name) \ |
4dfbb9d8 PZ |
314 | lockdep_init_map(&(lock)->dep_map, name, key, 0) |
315 | #define lockdep_set_class_and_subclass(lock, key, sub) \ | |
316 | lockdep_init_map(&(lock)->dep_map, #key, key, sub) | |
317 | #define lockdep_set_subclass(lock, sub) \ | |
318 | lockdep_init_map(&(lock)->dep_map, #lock, \ | |
319 | (lock)->dep_map.key, sub) | |
1704f47b PZ |
320 | |
321 | #define lockdep_set_novalidate_class(lock) \ | |
47be1c1a | 322 | lockdep_set_class_and_name(lock, &__lockdep_no_validate__, #lock) |
9a7aa12f JK |
323 | /* |
324 | * Compare locking classes | |
325 | */ | |
326 | #define lockdep_match_class(lock, key) lockdep_match_key(&(lock)->dep_map, key) | |
327 | ||
328 | static inline int lockdep_match_key(struct lockdep_map *lock, | |
329 | struct lock_class_key *key) | |
330 | { | |
331 | return lock->key == key; | |
332 | } | |
fbb9ce95 IM |
333 | |
334 | /* | |
335 | * Acquire a lock. | |
336 | * | |
337 | * Values for "read": | |
338 | * | |
339 | * 0: exclusive (write) acquire | |
340 | * 1: read-acquire (no recursion allowed) | |
341 | * 2: read-acquire with same-instance recursion allowed | |
342 | * | |
343 | * Values for check: | |
344 | * | |
fb9edbe9 ON |
345 | * 0: simple checks (freeing, held-at-exit-time, etc.) |
346 | * 1: full validation | |
fbb9ce95 IM |
347 | */ |
348 | extern void lock_acquire(struct lockdep_map *lock, unsigned int subclass, | |
7531e2f3 PZ |
349 | int trylock, int read, int check, |
350 | struct lockdep_map *nest_lock, unsigned long ip); | |
fbb9ce95 | 351 | |
5facae4f | 352 | extern void lock_release(struct lockdep_map *lock, unsigned long ip); |
fbb9ce95 | 353 | |
f8319483 PZ |
354 | /* |
355 | * Same "read" as for lock_acquire(), except -1 means any. | |
356 | */ | |
08f36ff6 | 357 | extern int lock_is_held_type(const struct lockdep_map *lock, int read); |
f8319483 | 358 | |
08f36ff6 | 359 | static inline int lock_is_held(const struct lockdep_map *lock) |
f8319483 PZ |
360 | { |
361 | return lock_is_held_type(lock, -1); | |
362 | } | |
f607c668 | 363 | |
f8319483 PZ |
364 | #define lockdep_is_held(lock) lock_is_held(&(lock)->dep_map) |
365 | #define lockdep_is_held_type(lock, r) lock_is_held_type(&(lock)->dep_map, (r)) | |
f607c668 | 366 | |
00ef9f73 PZ |
367 | extern void lock_set_class(struct lockdep_map *lock, const char *name, |
368 | struct lock_class_key *key, unsigned int subclass, | |
369 | unsigned long ip); | |
370 | ||
371 | static inline void lock_set_subclass(struct lockdep_map *lock, | |
372 | unsigned int subclass, unsigned long ip) | |
373 | { | |
374 | lock_set_class(lock, lock->name, lock->key, subclass, ip); | |
375 | } | |
64aa348e | 376 | |
6419c4af O |
377 | extern void lock_downgrade(struct lockdep_map *lock, unsigned long ip); |
378 | ||
e7904a28 PZ |
379 | struct pin_cookie { unsigned int val; }; |
380 | ||
381 | #define NIL_COOKIE (struct pin_cookie){ .val = 0U, } | |
382 | ||
383 | extern struct pin_cookie lock_pin_lock(struct lockdep_map *lock); | |
384 | extern void lock_repin_lock(struct lockdep_map *lock, struct pin_cookie); | |
385 | extern void lock_unpin_lock(struct lockdep_map *lock, struct pin_cookie); | |
a24fc60d | 386 | |
e3a55fd1 | 387 | #define lockdep_depth(tsk) (debug_locks ? (tsk)->lockdep_depth : 0) |
d5abe669 | 388 | |
b1ae345d JB |
389 | #define lockdep_assert_held(l) do { \ |
390 | WARN_ON(debug_locks && !lockdep_is_held(l)); \ | |
391 | } while (0) | |
f607c668 | 392 | |
9ffbe8ac | 393 | #define lockdep_assert_held_write(l) do { \ |
f8319483 PZ |
394 | WARN_ON(debug_locks && !lockdep_is_held_type(l, 0)); \ |
395 | } while (0) | |
396 | ||
397 | #define lockdep_assert_held_read(l) do { \ | |
398 | WARN_ON(debug_locks && !lockdep_is_held_type(l, 1)); \ | |
399 | } while (0) | |
400 | ||
9a37110d PH |
401 | #define lockdep_assert_held_once(l) do { \ |
402 | WARN_ON_ONCE(debug_locks && !lockdep_is_held(l)); \ | |
403 | } while (0) | |
404 | ||
94d24fc4 PZ |
405 | #define lockdep_recursing(tsk) ((tsk)->lockdep_recursion) |
406 | ||
e7904a28 PZ |
407 | #define lockdep_pin_lock(l) lock_pin_lock(&(l)->dep_map) |
408 | #define lockdep_repin_lock(l,c) lock_repin_lock(&(l)->dep_map, (c)) | |
409 | #define lockdep_unpin_lock(l,c) lock_unpin_lock(&(l)->dep_map, (c)) | |
a24fc60d | 410 | |
a51805ef | 411 | #else /* !CONFIG_LOCKDEP */ |
fbb9ce95 | 412 | |
e196e479 YD |
413 | static inline void lockdep_init_task(struct task_struct *task) |
414 | { | |
415 | } | |
416 | ||
fbb9ce95 IM |
417 | static inline void lockdep_off(void) |
418 | { | |
419 | } | |
420 | ||
421 | static inline void lockdep_on(void) | |
422 | { | |
423 | } | |
424 | ||
cdc84d79 BVA |
425 | static inline void lockdep_set_selftest_task(struct task_struct *task) |
426 | { | |
427 | } | |
428 | ||
7531e2f3 | 429 | # define lock_acquire(l, s, t, r, c, n, i) do { } while (0) |
5facae4f | 430 | # define lock_release(l, i) do { } while (0) |
6419c4af | 431 | # define lock_downgrade(l, i) do { } while (0) |
00ef9f73 | 432 | # define lock_set_class(l, n, k, s, i) do { } while (0) |
64aa348e | 433 | # define lock_set_subclass(l, s, i) do { } while (0) |
c3bc8fd6 | 434 | # define lockdep_init() do { } while (0) |
e25cf3db IM |
435 | # define lockdep_init_map(lock, name, key, sub) \ |
436 | do { (void)(name); (void)(key); } while (0) | |
fbb9ce95 IM |
437 | # define lockdep_set_class(lock, key) do { (void)(key); } while (0) |
438 | # define lockdep_set_class_and_name(lock, key, name) \ | |
e25cf3db | 439 | do { (void)(key); (void)(name); } while (0) |
4dfbb9d8 PZ |
440 | #define lockdep_set_class_and_subclass(lock, key, sub) \ |
441 | do { (void)(key); } while (0) | |
07646e21 | 442 | #define lockdep_set_subclass(lock, sub) do { } while (0) |
1704f47b PZ |
443 | |
444 | #define lockdep_set_novalidate_class(lock) do { } while (0) | |
445 | ||
9a7aa12f JK |
446 | /* |
447 | * We don't define lockdep_match_class() and lockdep_match_key() for !LOCKDEP | |
448 | * case since the result is not well defined and the caller should rather | |
449 | * #ifdef the call himself. | |
450 | */ | |
07646e21 | 451 | |
fbb9ce95 IM |
452 | # define lockdep_reset() do { debug_locks = 1; } while (0) |
453 | # define lockdep_free_key_range(start, size) do { } while (0) | |
b351d164 | 454 | # define lockdep_sys_exit() do { } while (0) |
fbb9ce95 IM |
455 | /* |
456 | * The class key takes no space if lockdep is disabled: | |
457 | */ | |
458 | struct lock_class_key { }; | |
d5abe669 | 459 | |
108c1485 BVA |
460 | static inline void lockdep_register_key(struct lock_class_key *key) |
461 | { | |
462 | } | |
463 | ||
464 | static inline void lockdep_unregister_key(struct lock_class_key *key) | |
465 | { | |
466 | } | |
467 | ||
6f0397d7 BP |
468 | /* |
469 | * The lockdep_map takes no space if lockdep is disabled: | |
470 | */ | |
471 | struct lockdep_map { }; | |
472 | ||
d5abe669 PZ |
473 | #define lockdep_depth(tsk) (0) |
474 | ||
f8319483 PZ |
475 | #define lockdep_is_held_type(l, r) (1) |
476 | ||
5cd3f5af | 477 | #define lockdep_assert_held(l) do { (void)(l); } while (0) |
9ffbe8ac | 478 | #define lockdep_assert_held_write(l) do { (void)(l); } while (0) |
f8319483 | 479 | #define lockdep_assert_held_read(l) do { (void)(l); } while (0) |
9a37110d | 480 | #define lockdep_assert_held_once(l) do { (void)(l); } while (0) |
f607c668 | 481 | |
94d24fc4 PZ |
482 | #define lockdep_recursing(tsk) (0) |
483 | ||
e7904a28 PZ |
484 | struct pin_cookie { }; |
485 | ||
486 | #define NIL_COOKIE (struct pin_cookie){ } | |
487 | ||
3771b0fe | 488 | #define lockdep_pin_lock(l) ({ struct pin_cookie cookie = { }; cookie; }) |
e7904a28 PZ |
489 | #define lockdep_repin_lock(l, c) do { (void)(l); (void)(c); } while (0) |
490 | #define lockdep_unpin_lock(l, c) do { (void)(l); (void)(c); } while (0) | |
a24fc60d | 491 | |
fbb9ce95 IM |
492 | #endif /* !LOCKDEP */ |
493 | ||
b09be676 BP |
494 | enum xhlock_context_t { |
495 | XHLOCK_HARD, | |
496 | XHLOCK_SOFT, | |
b09be676 BP |
497 | XHLOCK_CTX_NR, |
498 | }; | |
499 | ||
52fa5bc5 | 500 | #define lockdep_init_map_crosslock(m, n, k, s) do {} while (0) |
b09be676 BP |
501 | /* |
502 | * To initialize a lockdep_map statically use this macro. | |
503 | * Note that _name must not be NULL. | |
504 | */ | |
505 | #define STATIC_LOCKDEP_MAP_INIT(_name, _key) \ | |
506 | { .name = (_name), .key = (void *)(_key), } | |
507 | ||
f52be570 | 508 | static inline void lockdep_invariant_state(bool force) {} |
b09be676 | 509 | static inline void lockdep_free_task(struct task_struct *task) {} |
b09be676 | 510 | |
f20786ff PZ |
511 | #ifdef CONFIG_LOCK_STAT |
512 | ||
513 | extern void lock_contended(struct lockdep_map *lock, unsigned long ip); | |
c7e78cff | 514 | extern void lock_acquired(struct lockdep_map *lock, unsigned long ip); |
f20786ff PZ |
515 | |
516 | #define LOCK_CONTENDED(_lock, try, lock) \ | |
517 | do { \ | |
518 | if (!try(_lock)) { \ | |
519 | lock_contended(&(_lock)->dep_map, _RET_IP_); \ | |
520 | lock(_lock); \ | |
f20786ff | 521 | } \ |
c7e78cff | 522 | lock_acquired(&(_lock)->dep_map, _RET_IP_); \ |
f20786ff PZ |
523 | } while (0) |
524 | ||
916633a4 MH |
525 | #define LOCK_CONTENDED_RETURN(_lock, try, lock) \ |
526 | ({ \ | |
527 | int ____err = 0; \ | |
528 | if (!try(_lock)) { \ | |
529 | lock_contended(&(_lock)->dep_map, _RET_IP_); \ | |
530 | ____err = lock(_lock); \ | |
531 | } \ | |
532 | if (!____err) \ | |
533 | lock_acquired(&(_lock)->dep_map, _RET_IP_); \ | |
534 | ____err; \ | |
535 | }) | |
536 | ||
f20786ff PZ |
537 | #else /* CONFIG_LOCK_STAT */ |
538 | ||
539 | #define lock_contended(lockdep_map, ip) do {} while (0) | |
c7e78cff | 540 | #define lock_acquired(lockdep_map, ip) do {} while (0) |
f20786ff PZ |
541 | |
542 | #define LOCK_CONTENDED(_lock, try, lock) \ | |
543 | lock(_lock) | |
544 | ||
916633a4 MH |
545 | #define LOCK_CONTENDED_RETURN(_lock, try, lock) \ |
546 | lock(_lock) | |
547 | ||
f20786ff PZ |
548 | #endif /* CONFIG_LOCK_STAT */ |
549 | ||
e8c158bb RH |
550 | #ifdef CONFIG_LOCKDEP |
551 | ||
552 | /* | |
553 | * On lockdep we dont want the hand-coded irq-enable of | |
554 | * _raw_*_lock_flags() code, because lockdep assumes | |
555 | * that interrupts are not re-enabled during lock-acquire: | |
556 | */ | |
557 | #define LOCK_CONTENDED_FLAGS(_lock, try, lock, lockfl, flags) \ | |
558 | LOCK_CONTENDED((_lock), (try), (lock)) | |
559 | ||
560 | #else /* CONFIG_LOCKDEP */ | |
561 | ||
562 | #define LOCK_CONTENDED_FLAGS(_lock, try, lock, lockfl, flags) \ | |
563 | lockfl((_lock), (flags)) | |
564 | ||
565 | #endif /* CONFIG_LOCKDEP */ | |
566 | ||
c3bc8fd6 | 567 | #ifdef CONFIG_PROVE_LOCKING |
3117df04 | 568 | extern void print_irqtrace_events(struct task_struct *curr); |
fbb9ce95 | 569 | #else |
3117df04 IM |
570 | static inline void print_irqtrace_events(struct task_struct *curr) |
571 | { | |
572 | } | |
fbb9ce95 IM |
573 | #endif |
574 | ||
575 | /* | |
576 | * For trivial one-depth nesting of a lock-class, the following | |
577 | * global define can be used. (Subsystems with multiple levels | |
578 | * of nesting should define their own lock-nesting subclasses.) | |
579 | */ | |
580 | #define SINGLE_DEPTH_NESTING 1 | |
581 | ||
582 | /* | |
583 | * Map the dependency ops to NOP or to real lockdep ops, depending | |
584 | * on the per lock-class debug mode: | |
585 | */ | |
586 | ||
fb9edbe9 ON |
587 | #define lock_acquire_exclusive(l, s, t, n, i) lock_acquire(l, s, t, 0, 1, n, i) |
588 | #define lock_acquire_shared(l, s, t, n, i) lock_acquire(l, s, t, 1, 1, n, i) | |
589 | #define lock_acquire_shared_recursive(l, s, t, n, i) lock_acquire(l, s, t, 2, 1, n, i) | |
fbb9ce95 | 590 | |
a51805ef ML |
591 | #define spin_acquire(l, s, t, i) lock_acquire_exclusive(l, s, t, NULL, i) |
592 | #define spin_acquire_nest(l, s, t, n, i) lock_acquire_exclusive(l, s, t, n, i) | |
5facae4f | 593 | #define spin_release(l, i) lock_release(l, i) |
fbb9ce95 | 594 | |
a51805ef ML |
595 | #define rwlock_acquire(l, s, t, i) lock_acquire_exclusive(l, s, t, NULL, i) |
596 | #define rwlock_acquire_read(l, s, t, i) lock_acquire_shared_recursive(l, s, t, NULL, i) | |
5facae4f | 597 | #define rwlock_release(l, i) lock_release(l, i) |
fbb9ce95 | 598 | |
1ca7d67c JS |
599 | #define seqcount_acquire(l, s, t, i) lock_acquire_exclusive(l, s, t, NULL, i) |
600 | #define seqcount_acquire_read(l, s, t, i) lock_acquire_shared_recursive(l, s, t, NULL, i) | |
5facae4f | 601 | #define seqcount_release(l, i) lock_release(l, i) |
1ca7d67c | 602 | |
a51805ef ML |
603 | #define mutex_acquire(l, s, t, i) lock_acquire_exclusive(l, s, t, NULL, i) |
604 | #define mutex_acquire_nest(l, s, t, n, i) lock_acquire_exclusive(l, s, t, n, i) | |
5facae4f | 605 | #define mutex_release(l, i) lock_release(l, i) |
a51805ef ML |
606 | |
607 | #define rwsem_acquire(l, s, t, i) lock_acquire_exclusive(l, s, t, NULL, i) | |
608 | #define rwsem_acquire_nest(l, s, t, n, i) lock_acquire_exclusive(l, s, t, n, i) | |
609 | #define rwsem_acquire_read(l, s, t, i) lock_acquire_shared(l, s, t, NULL, i) | |
5facae4f | 610 | #define rwsem_release(l, i) lock_release(l, i) |
fbb9ce95 | 611 | |
a51805ef ML |
612 | #define lock_map_acquire(l) lock_acquire_exclusive(l, 0, 0, NULL, _THIS_IP_) |
613 | #define lock_map_acquire_read(l) lock_acquire_shared_recursive(l, 0, 0, NULL, _THIS_IP_) | |
dd56af42 | 614 | #define lock_map_acquire_tryread(l) lock_acquire_shared_recursive(l, 0, 1, NULL, _THIS_IP_) |
5facae4f | 615 | #define lock_map_release(l) lock_release(l, _THIS_IP_) |
4f3e7524 | 616 | |
76b189e9 PZ |
617 | #ifdef CONFIG_PROVE_LOCKING |
618 | # define might_lock(lock) \ | |
619 | do { \ | |
620 | typecheck(struct lockdep_map *, &(lock)->dep_map); \ | |
fb9edbe9 | 621 | lock_acquire(&(lock)->dep_map, 0, 0, 0, 1, NULL, _THIS_IP_); \ |
5facae4f | 622 | lock_release(&(lock)->dep_map, _THIS_IP_); \ |
76b189e9 PZ |
623 | } while (0) |
624 | # define might_lock_read(lock) \ | |
625 | do { \ | |
626 | typecheck(struct lockdep_map *, &(lock)->dep_map); \ | |
fb9edbe9 | 627 | lock_acquire(&(lock)->dep_map, 0, 0, 1, 1, NULL, _THIS_IP_); \ |
5facae4f | 628 | lock_release(&(lock)->dep_map, _THIS_IP_); \ |
76b189e9 | 629 | } while (0) |
f54bb2ec FW |
630 | |
631 | #define lockdep_assert_irqs_enabled() do { \ | |
632 | WARN_ONCE(debug_locks && !current->lockdep_recursion && \ | |
633 | !current->hardirqs_enabled, \ | |
634 | "IRQs not enabled as expected\n"); \ | |
635 | } while (0) | |
636 | ||
637 | #define lockdep_assert_irqs_disabled() do { \ | |
638 | WARN_ONCE(debug_locks && !current->lockdep_recursion && \ | |
639 | current->hardirqs_enabled, \ | |
640 | "IRQs not disabled as expected\n"); \ | |
641 | } while (0) | |
642 | ||
71d8d153 JFG |
643 | #define lockdep_assert_in_irq() do { \ |
644 | WARN_ONCE(debug_locks && !current->lockdep_recursion && \ | |
645 | !current->hardirq_context, \ | |
646 | "Not in hardirq as expected\n"); \ | |
647 | } while (0) | |
648 | ||
76b189e9 PZ |
649 | #else |
650 | # define might_lock(lock) do { } while (0) | |
651 | # define might_lock_read(lock) do { } while (0) | |
f54bb2ec FW |
652 | # define lockdep_assert_irqs_enabled() do { } while (0) |
653 | # define lockdep_assert_irqs_disabled() do { } while (0) | |
71d8d153 | 654 | # define lockdep_assert_in_irq() do { } while (0) |
76b189e9 PZ |
655 | #endif |
656 | ||
d24209bb | 657 | #ifdef CONFIG_LOCKDEP |
b3fbab05 | 658 | void lockdep_rcu_suspicious(const char *file, const int line, const char *s); |
d24209bb PM |
659 | #else |
660 | static inline void | |
661 | lockdep_rcu_suspicious(const char *file, const int line, const char *s) | |
662 | { | |
663 | } | |
0632eb3d PM |
664 | #endif |
665 | ||
fbb9ce95 | 666 | #endif /* __LINUX_LOCKDEP_H */ |