1 /* SPDX-License-Identifier: GPL-2.0 */
3 * Runtime locking correctness validator
6 * Copyright (C) 2007 Red Hat, Inc., Peter Zijlstra
8 * see Documentation/locking/lockdep-design.rst for more details.
10 #ifndef __LINUX_LOCKDEP_H
11 #define __LINUX_LOCKDEP_H
13 #include <linux/lockdep_types.h>
14 #include <linux/smp.h>
15 #include <asm/percpu.h>
20 extern int prove_locking;
25 #include <linux/linkage.h>
26 #include <linux/list.h>
27 #include <linux/debug_locks.h>
28 #include <linux/stacktrace.h>
30 static inline void lockdep_copy_map(struct lockdep_map *to,
31 struct lockdep_map *from)
37 * Since the class cache can be modified concurrently we could observe
38 * half pointers (64bit arch using 32bit copy insns). Therefore clear
39 * the caches and take the performance hit.
41 * XXX it doesn't work well with lockdep_set_class_and_subclass(), since
42 * that relies on cache abuse.
44 for (i = 0; i < NR_LOCKDEP_CACHING_CLASSES; i++)
45 to->class_cache[i] = NULL;
49 * Every lock has a list of other locks that were taken after it.
50 * We only grow the list, never remove from it:
53 struct list_head entry;
54 struct lock_class *class;
55 struct lock_class *links_to;
56 const struct lock_trace *trace;
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.
63 struct lock_list *parent;
67 * struct lock_chain - lock dependency chain record
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
76 /* see BUILD_BUG_ON()s in add_chain_cache() */
77 unsigned int irq_context : 2,
81 struct hlist_node entry;
85 #define MAX_LOCKDEP_KEYS_BITS 13
86 #define MAX_LOCKDEP_KEYS (1UL << MAX_LOCKDEP_KEYS_BITS)
87 #define INITIAL_CHAIN_KEY -1
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.
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.
101 * The task struct holds the current hash value (initialized
102 * with zero), here we store the previous hash value:
105 unsigned long acquire_ip;
106 struct lockdep_map *instance;
107 struct lockdep_map *nest_lock;
108 #ifdef CONFIG_LOCK_STAT
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.
117 unsigned int class_idx:MAX_LOCKDEP_KEYS_BITS;
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.]
128 * The following field is used to detect when we cross into an
131 unsigned int irq_context:2; /* bit 0 - soft, bit 1 - hard */
132 unsigned int trylock:1; /* 16 bits */
134 unsigned int read:2; /* see lock_acquire() comment */
135 unsigned int check:1; /* see lock_acquire() comment */
136 unsigned int hardirqs_off:1;
137 unsigned int references:12; /* 32 bits */
138 unsigned int pin_count;
142 * Initialization, self-test and debugging-output methods:
144 extern void lockdep_init(void);
145 extern void lockdep_reset(void);
146 extern void lockdep_reset_lock(struct lockdep_map *lock);
147 extern void lockdep_free_key_range(void *start, unsigned long size);
148 extern asmlinkage void lockdep_sys_exit(void);
149 extern void lockdep_set_selftest_task(struct task_struct *task);
151 extern void lockdep_init_task(struct task_struct *task);
154 * Split the recrursion counter in two to readily detect 'off' vs recursion.
156 #define LOCKDEP_RECURSION_BITS 16
157 #define LOCKDEP_OFF (1U << LOCKDEP_RECURSION_BITS)
158 #define LOCKDEP_RECURSION_MASK (LOCKDEP_OFF - 1)
161 * lockdep_{off,on}() are macros to avoid tracing and kprobes; not inlines due
162 * to header dependencies.
165 #define lockdep_off() \
167 current->lockdep_recursion += LOCKDEP_OFF; \
170 #define lockdep_on() \
172 current->lockdep_recursion -= LOCKDEP_OFF; \
175 extern void lockdep_register_key(struct lock_class_key *key);
176 extern void lockdep_unregister_key(struct lock_class_key *key);
179 * These methods are used by specific locking variants (spinlocks,
180 * rwlocks, mutexes and rwsems) to pass init/acquire/release events
184 extern void lockdep_init_map_waits(struct lockdep_map *lock, const char *name,
185 struct lock_class_key *key, int subclass, short inner, short outer);
188 lockdep_init_map_wait(struct lockdep_map *lock, const char *name,
189 struct lock_class_key *key, int subclass, short inner)
191 lockdep_init_map_waits(lock, name, key, subclass, inner, LD_WAIT_INV);
194 static inline void lockdep_init_map(struct lockdep_map *lock, const char *name,
195 struct lock_class_key *key, int subclass)
197 lockdep_init_map_wait(lock, name, key, subclass, LD_WAIT_INV);
201 * Reinitialize a lock key - for cases where there is special locking or
202 * special initialization of locks so that the validator gets the scope
203 * of dependencies wrong: they are either too broad (they need a class-split)
204 * or they are too narrow (they suffer from a false class-split):
206 #define lockdep_set_class(lock, key) \
207 lockdep_init_map_waits(&(lock)->dep_map, #key, key, 0, \
208 (lock)->dep_map.wait_type_inner, \
209 (lock)->dep_map.wait_type_outer)
211 #define lockdep_set_class_and_name(lock, key, name) \
212 lockdep_init_map_waits(&(lock)->dep_map, name, key, 0, \
213 (lock)->dep_map.wait_type_inner, \
214 (lock)->dep_map.wait_type_outer)
216 #define lockdep_set_class_and_subclass(lock, key, sub) \
217 lockdep_init_map_waits(&(lock)->dep_map, #key, key, sub,\
218 (lock)->dep_map.wait_type_inner, \
219 (lock)->dep_map.wait_type_outer)
221 #define lockdep_set_subclass(lock, sub) \
222 lockdep_init_map_waits(&(lock)->dep_map, #lock, (lock)->dep_map.key, sub,\
223 (lock)->dep_map.wait_type_inner, \
224 (lock)->dep_map.wait_type_outer)
226 #define lockdep_set_novalidate_class(lock) \
227 lockdep_set_class_and_name(lock, &__lockdep_no_validate__, #lock)
230 * Compare locking classes
232 #define lockdep_match_class(lock, key) lockdep_match_key(&(lock)->dep_map, key)
234 static inline int lockdep_match_key(struct lockdep_map *lock,
235 struct lock_class_key *key)
237 return lock->key == key;
245 * 0: exclusive (write) acquire
246 * 1: read-acquire (no recursion allowed)
247 * 2: read-acquire with same-instance recursion allowed
251 * 0: simple checks (freeing, held-at-exit-time, etc.)
254 extern void lock_acquire(struct lockdep_map *lock, unsigned int subclass,
255 int trylock, int read, int check,
256 struct lockdep_map *nest_lock, unsigned long ip);
258 extern void lock_release(struct lockdep_map *lock, unsigned long ip);
261 * Same "read" as for lock_acquire(), except -1 means any.
263 extern int lock_is_held_type(const struct lockdep_map *lock, int read);
265 static inline int lock_is_held(const struct lockdep_map *lock)
267 return lock_is_held_type(lock, -1);
270 #define lockdep_is_held(lock) lock_is_held(&(lock)->dep_map)
271 #define lockdep_is_held_type(lock, r) lock_is_held_type(&(lock)->dep_map, (r))
273 extern void lock_set_class(struct lockdep_map *lock, const char *name,
274 struct lock_class_key *key, unsigned int subclass,
277 static inline void lock_set_subclass(struct lockdep_map *lock,
278 unsigned int subclass, unsigned long ip)
280 lock_set_class(lock, lock->name, lock->key, subclass, ip);
283 extern void lock_downgrade(struct lockdep_map *lock, unsigned long ip);
285 #define NIL_COOKIE (struct pin_cookie){ .val = 0U, }
287 extern struct pin_cookie lock_pin_lock(struct lockdep_map *lock);
288 extern void lock_repin_lock(struct lockdep_map *lock, struct pin_cookie);
289 extern void lock_unpin_lock(struct lockdep_map *lock, struct pin_cookie);
291 #define lockdep_depth(tsk) (debug_locks ? (tsk)->lockdep_depth : 0)
293 #define lockdep_assert_held(l) do { \
294 WARN_ON(debug_locks && !lockdep_is_held(l)); \
297 #define lockdep_assert_held_write(l) do { \
298 WARN_ON(debug_locks && !lockdep_is_held_type(l, 0)); \
301 #define lockdep_assert_held_read(l) do { \
302 WARN_ON(debug_locks && !lockdep_is_held_type(l, 1)); \
305 #define lockdep_assert_held_once(l) do { \
306 WARN_ON_ONCE(debug_locks && !lockdep_is_held(l)); \
309 #define lockdep_recursing(tsk) ((tsk)->lockdep_recursion)
311 #define lockdep_pin_lock(l) lock_pin_lock(&(l)->dep_map)
312 #define lockdep_repin_lock(l,c) lock_repin_lock(&(l)->dep_map, (c))
313 #define lockdep_unpin_lock(l,c) lock_unpin_lock(&(l)->dep_map, (c))
315 #else /* !CONFIG_LOCKDEP */
317 static inline void lockdep_init_task(struct task_struct *task)
321 static inline void lockdep_off(void)
325 static inline void lockdep_on(void)
329 static inline void lockdep_set_selftest_task(struct task_struct *task)
333 # define lock_acquire(l, s, t, r, c, n, i) do { } while (0)
334 # define lock_release(l, i) do { } while (0)
335 # define lock_downgrade(l, i) do { } while (0)
336 # define lock_set_class(l, n, k, s, i) do { } while (0)
337 # define lock_set_subclass(l, s, i) do { } while (0)
338 # define lockdep_init() do { } while (0)
339 # define lockdep_init_map_waits(lock, name, key, sub, inner, outer) \
340 do { (void)(name); (void)(key); } while (0)
341 # define lockdep_init_map_wait(lock, name, key, sub, inner) \
342 do { (void)(name); (void)(key); } while (0)
343 # define lockdep_init_map(lock, name, key, sub) \
344 do { (void)(name); (void)(key); } while (0)
345 # define lockdep_set_class(lock, key) do { (void)(key); } while (0)
346 # define lockdep_set_class_and_name(lock, key, name) \
347 do { (void)(key); (void)(name); } while (0)
348 #define lockdep_set_class_and_subclass(lock, key, sub) \
349 do { (void)(key); } while (0)
350 #define lockdep_set_subclass(lock, sub) do { } while (0)
352 #define lockdep_set_novalidate_class(lock) do { } while (0)
355 * We don't define lockdep_match_class() and lockdep_match_key() for !LOCKDEP
356 * case since the result is not well defined and the caller should rather
357 * #ifdef the call himself.
360 # define lockdep_reset() do { debug_locks = 1; } while (0)
361 # define lockdep_free_key_range(start, size) do { } while (0)
362 # define lockdep_sys_exit() do { } while (0)
364 static inline void lockdep_register_key(struct lock_class_key *key)
368 static inline void lockdep_unregister_key(struct lock_class_key *key)
372 #define lockdep_depth(tsk) (0)
374 #define lockdep_is_held_type(l, r) (1)
376 #define lockdep_assert_held(l) do { (void)(l); } while (0)
377 #define lockdep_assert_held_write(l) do { (void)(l); } while (0)
378 #define lockdep_assert_held_read(l) do { (void)(l); } while (0)
379 #define lockdep_assert_held_once(l) do { (void)(l); } while (0)
381 #define lockdep_recursing(tsk) (0)
383 #define NIL_COOKIE (struct pin_cookie){ }
385 #define lockdep_pin_lock(l) ({ struct pin_cookie cookie = { }; cookie; })
386 #define lockdep_repin_lock(l, c) do { (void)(l); (void)(c); } while (0)
387 #define lockdep_unpin_lock(l, c) do { (void)(l); (void)(c); } while (0)
389 #endif /* !LOCKDEP */
391 enum xhlock_context_t {
397 #define lockdep_init_map_crosslock(m, n, k, s) do {} while (0)
399 * To initialize a lockdep_map statically use this macro.
400 * Note that _name must not be NULL.
402 #define STATIC_LOCKDEP_MAP_INIT(_name, _key) \
403 { .name = (_name), .key = (void *)(_key), }
405 static inline void lockdep_invariant_state(bool force) {}
406 static inline void lockdep_free_task(struct task_struct *task) {}
408 #ifdef CONFIG_LOCK_STAT
410 extern void lock_contended(struct lockdep_map *lock, unsigned long ip);
411 extern void lock_acquired(struct lockdep_map *lock, unsigned long ip);
413 #define LOCK_CONTENDED(_lock, try, lock) \
416 lock_contended(&(_lock)->dep_map, _RET_IP_); \
419 lock_acquired(&(_lock)->dep_map, _RET_IP_); \
422 #define LOCK_CONTENDED_RETURN(_lock, try, lock) \
426 lock_contended(&(_lock)->dep_map, _RET_IP_); \
427 ____err = lock(_lock); \
430 lock_acquired(&(_lock)->dep_map, _RET_IP_); \
434 #else /* CONFIG_LOCK_STAT */
436 #define lock_contended(lockdep_map, ip) do {} while (0)
437 #define lock_acquired(lockdep_map, ip) do {} while (0)
439 #define LOCK_CONTENDED(_lock, try, lock) \
442 #define LOCK_CONTENDED_RETURN(_lock, try, lock) \
445 #endif /* CONFIG_LOCK_STAT */
447 #ifdef CONFIG_LOCKDEP
450 * On lockdep we dont want the hand-coded irq-enable of
451 * _raw_*_lock_flags() code, because lockdep assumes
452 * that interrupts are not re-enabled during lock-acquire:
454 #define LOCK_CONTENDED_FLAGS(_lock, try, lock, lockfl, flags) \
455 LOCK_CONTENDED((_lock), (try), (lock))
457 #else /* CONFIG_LOCKDEP */
459 #define LOCK_CONTENDED_FLAGS(_lock, try, lock, lockfl, flags) \
460 lockfl((_lock), (flags))
462 #endif /* CONFIG_LOCKDEP */
464 #ifdef CONFIG_PROVE_LOCKING
465 extern void print_irqtrace_events(struct task_struct *curr);
467 static inline void print_irqtrace_events(struct task_struct *curr)
473 * For trivial one-depth nesting of a lock-class, the following
474 * global define can be used. (Subsystems with multiple levels
475 * of nesting should define their own lock-nesting subclasses.)
477 #define SINGLE_DEPTH_NESTING 1
480 * Map the dependency ops to NOP or to real lockdep ops, depending
481 * on the per lock-class debug mode:
484 #define lock_acquire_exclusive(l, s, t, n, i) lock_acquire(l, s, t, 0, 1, n, i)
485 #define lock_acquire_shared(l, s, t, n, i) lock_acquire(l, s, t, 1, 1, n, i)
486 #define lock_acquire_shared_recursive(l, s, t, n, i) lock_acquire(l, s, t, 2, 1, n, i)
488 #define spin_acquire(l, s, t, i) lock_acquire_exclusive(l, s, t, NULL, i)
489 #define spin_acquire_nest(l, s, t, n, i) lock_acquire_exclusive(l, s, t, n, i)
490 #define spin_release(l, i) lock_release(l, i)
492 #define rwlock_acquire(l, s, t, i) lock_acquire_exclusive(l, s, t, NULL, i)
493 #define rwlock_acquire_read(l, s, t, i) lock_acquire_shared_recursive(l, s, t, NULL, i)
494 #define rwlock_release(l, i) lock_release(l, i)
496 #define seqcount_acquire(l, s, t, i) lock_acquire_exclusive(l, s, t, NULL, i)
497 #define seqcount_acquire_read(l, s, t, i) lock_acquire_shared_recursive(l, s, t, NULL, i)
498 #define seqcount_release(l, i) lock_release(l, i)
500 #define mutex_acquire(l, s, t, i) lock_acquire_exclusive(l, s, t, NULL, i)
501 #define mutex_acquire_nest(l, s, t, n, i) lock_acquire_exclusive(l, s, t, n, i)
502 #define mutex_release(l, i) lock_release(l, i)
504 #define rwsem_acquire(l, s, t, i) lock_acquire_exclusive(l, s, t, NULL, i)
505 #define rwsem_acquire_nest(l, s, t, n, i) lock_acquire_exclusive(l, s, t, n, i)
506 #define rwsem_acquire_read(l, s, t, i) lock_acquire_shared(l, s, t, NULL, i)
507 #define rwsem_release(l, i) lock_release(l, i)
509 #define lock_map_acquire(l) lock_acquire_exclusive(l, 0, 0, NULL, _THIS_IP_)
510 #define lock_map_acquire_read(l) lock_acquire_shared_recursive(l, 0, 0, NULL, _THIS_IP_)
511 #define lock_map_acquire_tryread(l) lock_acquire_shared_recursive(l, 0, 1, NULL, _THIS_IP_)
512 #define lock_map_release(l) lock_release(l, _THIS_IP_)
514 #ifdef CONFIG_PROVE_LOCKING
515 # define might_lock(lock) \
517 typecheck(struct lockdep_map *, &(lock)->dep_map); \
518 lock_acquire(&(lock)->dep_map, 0, 0, 0, 1, NULL, _THIS_IP_); \
519 lock_release(&(lock)->dep_map, _THIS_IP_); \
521 # define might_lock_read(lock) \
523 typecheck(struct lockdep_map *, &(lock)->dep_map); \
524 lock_acquire(&(lock)->dep_map, 0, 0, 1, 1, NULL, _THIS_IP_); \
525 lock_release(&(lock)->dep_map, _THIS_IP_); \
527 # define might_lock_nested(lock, subclass) \
529 typecheck(struct lockdep_map *, &(lock)->dep_map); \
530 lock_acquire(&(lock)->dep_map, subclass, 0, 1, 1, NULL, \
532 lock_release(&(lock)->dep_map, _THIS_IP_); \
535 DECLARE_PER_CPU(int, hardirqs_enabled);
536 DECLARE_PER_CPU(int, hardirq_context);
539 * The below lockdep_assert_*() macros use raw_cpu_read() to access the above
540 * per-cpu variables. This is required because this_cpu_read() will potentially
541 * call into preempt/irq-disable and that obviously isn't right. This is also
542 * correct because when IRQs are enabled, it doesn't matter if we accidentally
543 * read the value from our previous CPU.
546 #define lockdep_assert_irqs_enabled() \
548 WARN_ON_ONCE(debug_locks && !raw_cpu_read(hardirqs_enabled)); \
551 #define lockdep_assert_irqs_disabled() \
553 WARN_ON_ONCE(debug_locks && raw_cpu_read(hardirqs_enabled)); \
556 #define lockdep_assert_in_irq() \
558 WARN_ON_ONCE(debug_locks && !raw_cpu_read(hardirq_context)); \
561 #define lockdep_assert_preemption_enabled() \
563 WARN_ON_ONCE(IS_ENABLED(CONFIG_PREEMPT_COUNT) && \
565 (preempt_count() != 0 || \
566 !raw_cpu_read(hardirqs_enabled))); \
569 #define lockdep_assert_preemption_disabled() \
571 WARN_ON_ONCE(IS_ENABLED(CONFIG_PREEMPT_COUNT) && \
573 (preempt_count() == 0 && \
574 raw_cpu_read(hardirqs_enabled))); \
578 # define might_lock(lock) do { } while (0)
579 # define might_lock_read(lock) do { } while (0)
580 # define might_lock_nested(lock, subclass) do { } while (0)
582 # define lockdep_assert_irqs_enabled() do { } while (0)
583 # define lockdep_assert_irqs_disabled() do { } while (0)
584 # define lockdep_assert_in_irq() do { } while (0)
586 # define lockdep_assert_preemption_enabled() do { } while (0)
587 # define lockdep_assert_preemption_disabled() do { } while (0)
590 #ifdef CONFIG_PROVE_RAW_LOCK_NESTING
592 # define lockdep_assert_RT_in_threaded_ctx() do { \
593 WARN_ONCE(debug_locks && !current->lockdep_recursion && \
594 lockdep_hardirq_context() && \
595 !(current->hardirq_threaded || current->irq_config), \
596 "Not in threaded context on PREEMPT_RT as expected\n"); \
601 # define lockdep_assert_RT_in_threaded_ctx() do { } while (0)
605 #ifdef CONFIG_LOCKDEP
606 void lockdep_rcu_suspicious(const char *file, const int line, const char *s);
609 lockdep_rcu_suspicious(const char *file, const int line, const char *s)
614 #endif /* __LINUX_LOCKDEP_H */