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.txt for more details.
10 #ifndef __LINUX_LOCKDEP_H
11 #define __LINUX_LOCKDEP_H
17 extern int prove_locking;
20 #define MAX_LOCKDEP_SUBCLASSES 8UL
22 #include <linux/types.h>
26 #include <linux/linkage.h>
27 #include <linux/list.h>
28 #include <linux/debug_locks.h>
29 #include <linux/stacktrace.h>
32 * We'd rather not expose kernel/lockdep_states.h this wide, but we do need
33 * the total number of states... :-(
35 #define XXX_LOCK_USAGE_STATES (1+2*4)
38 * NR_LOCKDEP_CACHING_CLASSES ... Number of classes
39 * cached in the instance of lockdep_map
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
46 #define NR_LOCKDEP_CACHING_CLASSES 2
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.
55 struct lockdep_subclass_key {
57 } __attribute__ ((__packed__));
59 /* hash_entry is used to keep track of dynamically allocated keys. */
60 struct lock_class_key {
62 struct hlist_node hash_entry;
63 struct lockdep_subclass_key subkeys[MAX_LOCKDEP_SUBCLASSES];
67 extern struct lock_class_key __lockdep_no_validate__;
70 unsigned int nr_entries;
74 #define LOCKSTAT_POINTS 4
77 * The lock-class itself. The order of the structure members matters.
78 * reinit_class() zeroes the key member and all subsequent members.
84 struct hlist_node hash_entry;
87 * Entry in all_lock_classes when in use. Entry in free_lock_classes
88 * when not in use. Instances that are being freed are on one of the
89 * zapped_classes lists.
91 struct list_head lock_entry;
94 * These fields represent a directed graph of lock dependencies,
95 * to every node we attach a list of "forward" and a list of
96 * "backward" graph nodes.
98 struct list_head locks_after, locks_before;
100 struct lockdep_subclass_key *key;
101 unsigned int subclass;
102 unsigned int dep_gen_id;
105 * IRQ/softirq usage tracking bits:
107 unsigned long usage_mask;
108 struct lock_trace usage_traces[XXX_LOCK_USAGE_STATES];
111 * Generation counter, when doing certain classes of graph walking,
112 * to ensure that we check one node only once:
117 #ifdef CONFIG_LOCK_STAT
118 unsigned long contention_point[LOCKSTAT_POINTS];
119 unsigned long contending_point[LOCKSTAT_POINTS];
121 } __no_randomize_layout;
123 #ifdef CONFIG_LOCK_STAT
132 bounce_acquired_write,
133 bounce_acquired_read,
134 bounce_contended_write,
135 bounce_contended_read,
138 bounce_acquired = bounce_acquired_write,
139 bounce_contended = bounce_contended_write,
142 struct lock_class_stats {
143 unsigned long contention_point[LOCKSTAT_POINTS];
144 unsigned long contending_point[LOCKSTAT_POINTS];
145 struct lock_time read_waittime;
146 struct lock_time write_waittime;
147 struct lock_time read_holdtime;
148 struct lock_time write_holdtime;
149 unsigned long bounces[nr_bounce_types];
152 struct lock_class_stats lock_stats(struct lock_class *class);
153 void clear_lock_stats(struct lock_class *class);
157 * Map the lock object (the lock instance) to the lock-class object.
158 * This is embedded into specific lock instances:
161 struct lock_class_key *key;
162 struct lock_class *class_cache[NR_LOCKDEP_CACHING_CLASSES];
164 #ifdef CONFIG_LOCK_STAT
170 static inline void lockdep_copy_map(struct lockdep_map *to,
171 struct lockdep_map *from)
177 * Since the class cache can be modified concurrently we could observe
178 * half pointers (64bit arch using 32bit copy insns). Therefore clear
179 * the caches and take the performance hit.
181 * XXX it doesn't work well with lockdep_set_class_and_subclass(), since
182 * that relies on cache abuse.
184 for (i = 0; i < NR_LOCKDEP_CACHING_CLASSES; i++)
185 to->class_cache[i] = NULL;
189 * Every lock has a list of other locks that were taken after it.
190 * We only grow the list, never remove from it:
193 struct list_head entry;
194 struct lock_class *class;
195 struct lock_class *links_to;
196 struct lock_trace trace;
200 * The parent field is used to implement breadth-first search, and the
201 * bit 0 is reused to indicate if the lock has been accessed in BFS.
203 struct lock_list *parent;
207 * We record lock dependency chains, so that we can cache them:
210 /* see BUILD_BUG_ON()s in lookup_chain_cache() */
211 unsigned int irq_context : 2,
215 struct hlist_node entry;
219 #define MAX_LOCKDEP_KEYS_BITS 13
221 * Subtract one because we offset hlock->class_idx by 1 in order
222 * to make 0 mean no class. This avoids overflowing the class_idx
223 * bitfield and hitting the BUG in hlock_class().
225 #define MAX_LOCKDEP_KEYS ((1UL << MAX_LOCKDEP_KEYS_BITS) - 1)
229 * One-way hash of the dependency chain up to this point. We
230 * hash the hashes step by step as the dependency chain grows.
232 * We use it for dependency-caching and we skip detection
233 * passes and dependency-updates if there is a cache-hit, so
234 * it is absolutely critical for 100% coverage of the validator
235 * to have a unique key value for every unique dependency path
236 * that can occur in the system, to make a unique hash value
237 * as likely as possible - hence the 64-bit width.
239 * The task struct holds the current hash value (initialized
240 * with zero), here we store the previous hash value:
243 unsigned long acquire_ip;
244 struct lockdep_map *instance;
245 struct lockdep_map *nest_lock;
246 #ifdef CONFIG_LOCK_STAT
250 unsigned int class_idx:MAX_LOCKDEP_KEYS_BITS;
252 * The lock-stack is unified in that the lock chains of interrupt
253 * contexts nest ontop of process context chains, but we 'separate'
254 * the hashes by starting with 0 if we cross into an interrupt
255 * context, and we also keep do not add cross-context lock
256 * dependencies - the lock usage graph walking covers that area
257 * anyway, and we'd just unnecessarily increase the number of
258 * dependencies otherwise. [Note: hardirq and softirq contexts
259 * are separated from each other too.]
261 * The following field is used to detect when we cross into an
264 unsigned int irq_context:2; /* bit 0 - soft, bit 1 - hard */
265 unsigned int trylock:1; /* 16 bits */
267 unsigned int read:2; /* see lock_acquire() comment */
268 unsigned int check:1; /* see lock_acquire() comment */
269 unsigned int hardirqs_off:1;
270 unsigned int references:12; /* 32 bits */
271 unsigned int pin_count;
275 * Initialization, self-test and debugging-output methods:
277 extern void lockdep_init(void);
278 extern void lockdep_reset(void);
279 extern void lockdep_reset_lock(struct lockdep_map *lock);
280 extern void lockdep_free_key_range(void *start, unsigned long size);
281 extern asmlinkage void lockdep_sys_exit(void);
282 extern void lockdep_set_selftest_task(struct task_struct *task);
284 extern void lockdep_off(void);
285 extern void lockdep_on(void);
287 extern void lockdep_register_key(struct lock_class_key *key);
288 extern void lockdep_unregister_key(struct lock_class_key *key);
291 * These methods are used by specific locking variants (spinlocks,
292 * rwlocks, mutexes and rwsems) to pass init/acquire/release events
296 extern void lockdep_init_map(struct lockdep_map *lock, const char *name,
297 struct lock_class_key *key, int subclass);
300 * Reinitialize a lock key - for cases where there is special locking or
301 * special initialization of locks so that the validator gets the scope
302 * of dependencies wrong: they are either too broad (they need a class-split)
303 * or they are too narrow (they suffer from a false class-split):
305 #define lockdep_set_class(lock, key) \
306 lockdep_init_map(&(lock)->dep_map, #key, key, 0)
307 #define lockdep_set_class_and_name(lock, key, name) \
308 lockdep_init_map(&(lock)->dep_map, name, key, 0)
309 #define lockdep_set_class_and_subclass(lock, key, sub) \
310 lockdep_init_map(&(lock)->dep_map, #key, key, sub)
311 #define lockdep_set_subclass(lock, sub) \
312 lockdep_init_map(&(lock)->dep_map, #lock, \
313 (lock)->dep_map.key, sub)
315 #define lockdep_set_novalidate_class(lock) \
316 lockdep_set_class_and_name(lock, &__lockdep_no_validate__, #lock)
318 * Compare locking classes
320 #define lockdep_match_class(lock, key) lockdep_match_key(&(lock)->dep_map, key)
322 static inline int lockdep_match_key(struct lockdep_map *lock,
323 struct lock_class_key *key)
325 return lock->key == key;
333 * 0: exclusive (write) acquire
334 * 1: read-acquire (no recursion allowed)
335 * 2: read-acquire with same-instance recursion allowed
339 * 0: simple checks (freeing, held-at-exit-time, etc.)
342 extern void lock_acquire(struct lockdep_map *lock, unsigned int subclass,
343 int trylock, int read, int check,
344 struct lockdep_map *nest_lock, unsigned long ip);
346 extern void lock_release(struct lockdep_map *lock, int nested,
350 * Same "read" as for lock_acquire(), except -1 means any.
352 extern int lock_is_held_type(const struct lockdep_map *lock, int read);
354 static inline int lock_is_held(const struct lockdep_map *lock)
356 return lock_is_held_type(lock, -1);
359 #define lockdep_is_held(lock) lock_is_held(&(lock)->dep_map)
360 #define lockdep_is_held_type(lock, r) lock_is_held_type(&(lock)->dep_map, (r))
362 extern void lock_set_class(struct lockdep_map *lock, const char *name,
363 struct lock_class_key *key, unsigned int subclass,
366 static inline void lock_set_subclass(struct lockdep_map *lock,
367 unsigned int subclass, unsigned long ip)
369 lock_set_class(lock, lock->name, lock->key, subclass, ip);
372 extern void lock_downgrade(struct lockdep_map *lock, unsigned long ip);
374 struct pin_cookie { unsigned int val; };
376 #define NIL_COOKIE (struct pin_cookie){ .val = 0U, }
378 extern struct pin_cookie lock_pin_lock(struct lockdep_map *lock);
379 extern void lock_repin_lock(struct lockdep_map *lock, struct pin_cookie);
380 extern void lock_unpin_lock(struct lockdep_map *lock, struct pin_cookie);
382 #define lockdep_depth(tsk) (debug_locks ? (tsk)->lockdep_depth : 0)
384 #define lockdep_assert_held(l) do { \
385 WARN_ON(debug_locks && !lockdep_is_held(l)); \
388 #define lockdep_assert_held_exclusive(l) do { \
389 WARN_ON(debug_locks && !lockdep_is_held_type(l, 0)); \
392 #define lockdep_assert_held_read(l) do { \
393 WARN_ON(debug_locks && !lockdep_is_held_type(l, 1)); \
396 #define lockdep_assert_held_once(l) do { \
397 WARN_ON_ONCE(debug_locks && !lockdep_is_held(l)); \
400 #define lockdep_recursing(tsk) ((tsk)->lockdep_recursion)
402 #define lockdep_pin_lock(l) lock_pin_lock(&(l)->dep_map)
403 #define lockdep_repin_lock(l,c) lock_repin_lock(&(l)->dep_map, (c))
404 #define lockdep_unpin_lock(l,c) lock_unpin_lock(&(l)->dep_map, (c))
406 #else /* !CONFIG_LOCKDEP */
408 static inline void lockdep_off(void)
412 static inline void lockdep_on(void)
416 static inline void lockdep_set_selftest_task(struct task_struct *task)
420 # define lock_acquire(l, s, t, r, c, n, i) do { } while (0)
421 # define lock_release(l, n, i) do { } while (0)
422 # define lock_downgrade(l, i) do { } while (0)
423 # define lock_set_class(l, n, k, s, i) do { } while (0)
424 # define lock_set_subclass(l, s, i) do { } while (0)
425 # define lockdep_init() do { } while (0)
426 # define lockdep_init_map(lock, name, key, sub) \
427 do { (void)(name); (void)(key); } while (0)
428 # define lockdep_set_class(lock, key) do { (void)(key); } while (0)
429 # define lockdep_set_class_and_name(lock, key, name) \
430 do { (void)(key); (void)(name); } while (0)
431 #define lockdep_set_class_and_subclass(lock, key, sub) \
432 do { (void)(key); } while (0)
433 #define lockdep_set_subclass(lock, sub) do { } while (0)
435 #define lockdep_set_novalidate_class(lock) do { } while (0)
438 * We don't define lockdep_match_class() and lockdep_match_key() for !LOCKDEP
439 * case since the result is not well defined and the caller should rather
440 * #ifdef the call himself.
443 # define lockdep_reset() do { debug_locks = 1; } while (0)
444 # define lockdep_free_key_range(start, size) do { } while (0)
445 # define lockdep_sys_exit() do { } while (0)
447 * The class key takes no space if lockdep is disabled:
449 struct lock_class_key { };
451 static inline void lockdep_register_key(struct lock_class_key *key)
455 static inline void lockdep_unregister_key(struct lock_class_key *key)
460 * The lockdep_map takes no space if lockdep is disabled:
462 struct lockdep_map { };
464 #define lockdep_depth(tsk) (0)
466 #define lockdep_is_held_type(l, r) (1)
468 #define lockdep_assert_held(l) do { (void)(l); } while (0)
469 #define lockdep_assert_held_exclusive(l) do { (void)(l); } while (0)
470 #define lockdep_assert_held_read(l) do { (void)(l); } while (0)
471 #define lockdep_assert_held_once(l) do { (void)(l); } while (0)
473 #define lockdep_recursing(tsk) (0)
475 struct pin_cookie { };
477 #define NIL_COOKIE (struct pin_cookie){ }
479 #define lockdep_pin_lock(l) ({ struct pin_cookie cookie = { }; cookie; })
480 #define lockdep_repin_lock(l, c) do { (void)(l); (void)(c); } while (0)
481 #define lockdep_unpin_lock(l, c) do { (void)(l); (void)(c); } while (0)
483 #endif /* !LOCKDEP */
485 enum xhlock_context_t {
491 #define lockdep_init_map_crosslock(m, n, k, s) do {} while (0)
493 * To initialize a lockdep_map statically use this macro.
494 * Note that _name must not be NULL.
496 #define STATIC_LOCKDEP_MAP_INIT(_name, _key) \
497 { .name = (_name), .key = (void *)(_key), }
499 static inline void lockdep_invariant_state(bool force) {}
500 static inline void lockdep_init_task(struct task_struct *task) {}
501 static inline void lockdep_free_task(struct task_struct *task) {}
503 #ifdef CONFIG_LOCK_STAT
505 extern void lock_contended(struct lockdep_map *lock, unsigned long ip);
506 extern void lock_acquired(struct lockdep_map *lock, unsigned long ip);
508 #define LOCK_CONTENDED(_lock, try, lock) \
511 lock_contended(&(_lock)->dep_map, _RET_IP_); \
514 lock_acquired(&(_lock)->dep_map, _RET_IP_); \
517 #define LOCK_CONTENDED_RETURN(_lock, try, lock) \
521 lock_contended(&(_lock)->dep_map, _RET_IP_); \
522 ____err = lock(_lock); \
525 lock_acquired(&(_lock)->dep_map, _RET_IP_); \
529 #else /* CONFIG_LOCK_STAT */
531 #define lock_contended(lockdep_map, ip) do {} while (0)
532 #define lock_acquired(lockdep_map, ip) do {} while (0)
534 #define LOCK_CONTENDED(_lock, try, lock) \
537 #define LOCK_CONTENDED_RETURN(_lock, try, lock) \
540 #endif /* CONFIG_LOCK_STAT */
542 #ifdef CONFIG_LOCKDEP
545 * On lockdep we dont want the hand-coded irq-enable of
546 * _raw_*_lock_flags() code, because lockdep assumes
547 * that interrupts are not re-enabled during lock-acquire:
549 #define LOCK_CONTENDED_FLAGS(_lock, try, lock, lockfl, flags) \
550 LOCK_CONTENDED((_lock), (try), (lock))
552 #else /* CONFIG_LOCKDEP */
554 #define LOCK_CONTENDED_FLAGS(_lock, try, lock, lockfl, flags) \
555 lockfl((_lock), (flags))
557 #endif /* CONFIG_LOCKDEP */
559 #ifdef CONFIG_PROVE_LOCKING
560 extern void print_irqtrace_events(struct task_struct *curr);
562 static inline void print_irqtrace_events(struct task_struct *curr)
568 * For trivial one-depth nesting of a lock-class, the following
569 * global define can be used. (Subsystems with multiple levels
570 * of nesting should define their own lock-nesting subclasses.)
572 #define SINGLE_DEPTH_NESTING 1
575 * Map the dependency ops to NOP or to real lockdep ops, depending
576 * on the per lock-class debug mode:
579 #define lock_acquire_exclusive(l, s, t, n, i) lock_acquire(l, s, t, 0, 1, n, i)
580 #define lock_acquire_shared(l, s, t, n, i) lock_acquire(l, s, t, 1, 1, n, i)
581 #define lock_acquire_shared_recursive(l, s, t, n, i) lock_acquire(l, s, t, 2, 1, n, i)
583 #define spin_acquire(l, s, t, i) lock_acquire_exclusive(l, s, t, NULL, i)
584 #define spin_acquire_nest(l, s, t, n, i) lock_acquire_exclusive(l, s, t, n, i)
585 #define spin_release(l, n, i) lock_release(l, n, i)
587 #define rwlock_acquire(l, s, t, i) lock_acquire_exclusive(l, s, t, NULL, i)
588 #define rwlock_acquire_read(l, s, t, i) lock_acquire_shared_recursive(l, s, t, NULL, i)
589 #define rwlock_release(l, n, i) lock_release(l, n, i)
591 #define seqcount_acquire(l, s, t, i) lock_acquire_exclusive(l, s, t, NULL, i)
592 #define seqcount_acquire_read(l, s, t, i) lock_acquire_shared_recursive(l, s, t, NULL, i)
593 #define seqcount_release(l, n, i) lock_release(l, n, i)
595 #define mutex_acquire(l, s, t, i) lock_acquire_exclusive(l, s, t, NULL, i)
596 #define mutex_acquire_nest(l, s, t, n, i) lock_acquire_exclusive(l, s, t, n, i)
597 #define mutex_release(l, n, i) lock_release(l, n, i)
599 #define rwsem_acquire(l, s, t, i) lock_acquire_exclusive(l, s, t, NULL, i)
600 #define rwsem_acquire_nest(l, s, t, n, i) lock_acquire_exclusive(l, s, t, n, i)
601 #define rwsem_acquire_read(l, s, t, i) lock_acquire_shared(l, s, t, NULL, i)
602 #define rwsem_release(l, n, i) lock_release(l, n, i)
604 #define lock_map_acquire(l) lock_acquire_exclusive(l, 0, 0, NULL, _THIS_IP_)
605 #define lock_map_acquire_read(l) lock_acquire_shared_recursive(l, 0, 0, NULL, _THIS_IP_)
606 #define lock_map_acquire_tryread(l) lock_acquire_shared_recursive(l, 0, 1, NULL, _THIS_IP_)
607 #define lock_map_release(l) lock_release(l, 1, _THIS_IP_)
609 #ifdef CONFIG_PROVE_LOCKING
610 # define might_lock(lock) \
612 typecheck(struct lockdep_map *, &(lock)->dep_map); \
613 lock_acquire(&(lock)->dep_map, 0, 0, 0, 1, NULL, _THIS_IP_); \
614 lock_release(&(lock)->dep_map, 0, _THIS_IP_); \
616 # define might_lock_read(lock) \
618 typecheck(struct lockdep_map *, &(lock)->dep_map); \
619 lock_acquire(&(lock)->dep_map, 0, 0, 1, 1, NULL, _THIS_IP_); \
620 lock_release(&(lock)->dep_map, 0, _THIS_IP_); \
623 #define lockdep_assert_irqs_enabled() do { \
624 WARN_ONCE(debug_locks && !current->lockdep_recursion && \
625 !current->hardirqs_enabled, \
626 "IRQs not enabled as expected\n"); \
629 #define lockdep_assert_irqs_disabled() do { \
630 WARN_ONCE(debug_locks && !current->lockdep_recursion && \
631 current->hardirqs_enabled, \
632 "IRQs not disabled as expected\n"); \
636 # define might_lock(lock) do { } while (0)
637 # define might_lock_read(lock) do { } while (0)
638 # define lockdep_assert_irqs_enabled() do { } while (0)
639 # define lockdep_assert_irqs_disabled() do { } while (0)
642 #ifdef CONFIG_LOCKDEP
643 void lockdep_rcu_suspicious(const char *file, const int line, const char *s);
646 lockdep_rcu_suspicious(const char *file, const int line, const char *s)
651 #endif /* __LINUX_LOCKDEP_H */