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 * Lock-classes are keyed via unique addresses, by embedding the
50 * lockclass-key into the kernel (or module) .data section. (For
51 * static locks we use the lock address itself as the key.)
53 struct lockdep_subclass_key {
55 } __attribute__ ((__packed__));
57 struct lock_class_key {
58 struct lockdep_subclass_key subkeys[MAX_LOCKDEP_SUBCLASSES];
61 extern struct lock_class_key __lockdep_no_validate__;
63 #define LOCKSTAT_POINTS 4
66 * The lock-class itself:
72 struct hlist_node hash_entry;
75 * global list of all lock-classes:
77 struct list_head lock_entry;
79 struct lockdep_subclass_key *key;
80 unsigned int subclass;
81 unsigned int dep_gen_id;
84 * IRQ/softirq usage tracking bits:
86 unsigned long usage_mask;
87 struct stack_trace usage_traces[XXX_LOCK_USAGE_STATES];
90 * These fields represent a directed graph of lock dependencies,
91 * to every node we attach a list of "forward" and a list of
92 * "backward" graph nodes.
94 struct list_head locks_after, locks_before;
97 * Generation counter, when doing certain classes of graph walking,
98 * to ensure that we check one node only once:
100 unsigned int version;
105 #ifdef CONFIG_LOCK_STAT
106 unsigned long contention_point[LOCKSTAT_POINTS];
107 unsigned long contending_point[LOCKSTAT_POINTS];
111 #ifdef CONFIG_LOCK_STAT
120 bounce_acquired_write,
121 bounce_acquired_read,
122 bounce_contended_write,
123 bounce_contended_read,
126 bounce_acquired = bounce_acquired_write,
127 bounce_contended = bounce_contended_write,
130 struct lock_class_stats {
131 unsigned long contention_point[LOCKSTAT_POINTS];
132 unsigned long contending_point[LOCKSTAT_POINTS];
133 struct lock_time read_waittime;
134 struct lock_time write_waittime;
135 struct lock_time read_holdtime;
136 struct lock_time write_holdtime;
137 unsigned long bounces[nr_bounce_types];
140 struct lock_class_stats lock_stats(struct lock_class *class);
141 void clear_lock_stats(struct lock_class *class);
145 * Map the lock object (the lock instance) to the lock-class object.
146 * This is embedded into specific lock instances:
149 struct lock_class_key *key;
150 struct lock_class *class_cache[NR_LOCKDEP_CACHING_CLASSES];
152 #ifdef CONFIG_LOCK_STAT
158 static inline void lockdep_copy_map(struct lockdep_map *to,
159 struct lockdep_map *from)
165 * Since the class cache can be modified concurrently we could observe
166 * half pointers (64bit arch using 32bit copy insns). Therefore clear
167 * the caches and take the performance hit.
169 * XXX it doesn't work well with lockdep_set_class_and_subclass(), since
170 * that relies on cache abuse.
172 for (i = 0; i < NR_LOCKDEP_CACHING_CLASSES; i++)
173 to->class_cache[i] = NULL;
177 * Every lock has a list of other locks that were taken after it.
178 * We only grow the list, never remove from it:
181 struct list_head entry;
182 struct lock_class *class;
183 struct stack_trace trace;
187 * The parent field is used to implement breadth-first search, and the
188 * bit 0 is reused to indicate if the lock has been accessed in BFS.
190 struct lock_list *parent;
194 * We record lock dependency chains, so that we can cache them:
197 /* see BUILD_BUG_ON()s in lookup_chain_cache() */
198 unsigned int irq_context : 2,
202 struct hlist_node entry;
206 #define MAX_LOCKDEP_KEYS_BITS 13
208 * Subtract one because we offset hlock->class_idx by 1 in order
209 * to make 0 mean no class. This avoids overflowing the class_idx
210 * bitfield and hitting the BUG in hlock_class().
212 #define MAX_LOCKDEP_KEYS ((1UL << MAX_LOCKDEP_KEYS_BITS) - 1)
216 * One-way hash of the dependency chain up to this point. We
217 * hash the hashes step by step as the dependency chain grows.
219 * We use it for dependency-caching and we skip detection
220 * passes and dependency-updates if there is a cache-hit, so
221 * it is absolutely critical for 100% coverage of the validator
222 * to have a unique key value for every unique dependency path
223 * that can occur in the system, to make a unique hash value
224 * as likely as possible - hence the 64-bit width.
226 * The task struct holds the current hash value (initialized
227 * with zero), here we store the previous hash value:
230 unsigned long acquire_ip;
231 struct lockdep_map *instance;
232 struct lockdep_map *nest_lock;
233 #ifdef CONFIG_LOCK_STAT
237 unsigned int class_idx:MAX_LOCKDEP_KEYS_BITS;
239 * The lock-stack is unified in that the lock chains of interrupt
240 * contexts nest ontop of process context chains, but we 'separate'
241 * the hashes by starting with 0 if we cross into an interrupt
242 * context, and we also keep do not add cross-context lock
243 * dependencies - the lock usage graph walking covers that area
244 * anyway, and we'd just unnecessarily increase the number of
245 * dependencies otherwise. [Note: hardirq and softirq contexts
246 * are separated from each other too.]
248 * The following field is used to detect when we cross into an
251 unsigned int irq_context:2; /* bit 0 - soft, bit 1 - hard */
252 unsigned int trylock:1; /* 16 bits */
254 unsigned int read:2; /* see lock_acquire() comment */
255 unsigned int check:1; /* see lock_acquire() comment */
256 unsigned int hardirqs_off:1;
257 unsigned int references:12; /* 32 bits */
258 unsigned int pin_count;
262 * Initialization, self-test and debugging-output methods:
264 extern void lockdep_init(void);
265 extern void lockdep_reset(void);
266 extern void lockdep_reset_lock(struct lockdep_map *lock);
267 extern void lockdep_free_key_range(void *start, unsigned long size);
268 extern asmlinkage void lockdep_sys_exit(void);
270 extern void lockdep_off(void);
271 extern void lockdep_on(void);
274 * These methods are used by specific locking variants (spinlocks,
275 * rwlocks, mutexes and rwsems) to pass init/acquire/release events
279 extern void lockdep_init_map(struct lockdep_map *lock, const char *name,
280 struct lock_class_key *key, int subclass);
283 * Reinitialize a lock key - for cases where there is special locking or
284 * special initialization of locks so that the validator gets the scope
285 * of dependencies wrong: they are either too broad (they need a class-split)
286 * or they are too narrow (they suffer from a false class-split):
288 #define lockdep_set_class(lock, key) \
289 lockdep_init_map(&(lock)->dep_map, #key, key, 0)
290 #define lockdep_set_class_and_name(lock, key, name) \
291 lockdep_init_map(&(lock)->dep_map, name, key, 0)
292 #define lockdep_set_class_and_subclass(lock, key, sub) \
293 lockdep_init_map(&(lock)->dep_map, #key, key, sub)
294 #define lockdep_set_subclass(lock, sub) \
295 lockdep_init_map(&(lock)->dep_map, #lock, \
296 (lock)->dep_map.key, sub)
298 #define lockdep_set_novalidate_class(lock) \
299 lockdep_set_class_and_name(lock, &__lockdep_no_validate__, #lock)
301 * Compare locking classes
303 #define lockdep_match_class(lock, key) lockdep_match_key(&(lock)->dep_map, key)
305 static inline int lockdep_match_key(struct lockdep_map *lock,
306 struct lock_class_key *key)
308 return lock->key == key;
316 * 0: exclusive (write) acquire
317 * 1: read-acquire (no recursion allowed)
318 * 2: read-acquire with same-instance recursion allowed
322 * 0: simple checks (freeing, held-at-exit-time, etc.)
325 extern void lock_acquire(struct lockdep_map *lock, unsigned int subclass,
326 int trylock, int read, int check,
327 struct lockdep_map *nest_lock, unsigned long ip);
329 extern void lock_release(struct lockdep_map *lock, int nested,
333 * Same "read" as for lock_acquire(), except -1 means any.
335 extern int lock_is_held_type(const struct lockdep_map *lock, int read);
337 static inline int lock_is_held(const struct lockdep_map *lock)
339 return lock_is_held_type(lock, -1);
342 #define lockdep_is_held(lock) lock_is_held(&(lock)->dep_map)
343 #define lockdep_is_held_type(lock, r) lock_is_held_type(&(lock)->dep_map, (r))
345 extern void lock_set_class(struct lockdep_map *lock, const char *name,
346 struct lock_class_key *key, unsigned int subclass,
349 static inline void lock_set_subclass(struct lockdep_map *lock,
350 unsigned int subclass, unsigned long ip)
352 lock_set_class(lock, lock->name, lock->key, subclass, ip);
355 extern void lock_downgrade(struct lockdep_map *lock, unsigned long ip);
357 struct pin_cookie { unsigned int val; };
359 #define NIL_COOKIE (struct pin_cookie){ .val = 0U, }
361 extern struct pin_cookie lock_pin_lock(struct lockdep_map *lock);
362 extern void lock_repin_lock(struct lockdep_map *lock, struct pin_cookie);
363 extern void lock_unpin_lock(struct lockdep_map *lock, struct pin_cookie);
365 #define lockdep_depth(tsk) (debug_locks ? (tsk)->lockdep_depth : 0)
367 #define lockdep_assert_held(l) do { \
368 WARN_ON(debug_locks && !lockdep_is_held(l)); \
371 #define lockdep_assert_held_exclusive(l) do { \
372 WARN_ON(debug_locks && !lockdep_is_held_type(l, 0)); \
375 #define lockdep_assert_held_read(l) do { \
376 WARN_ON(debug_locks && !lockdep_is_held_type(l, 1)); \
379 #define lockdep_assert_held_once(l) do { \
380 WARN_ON_ONCE(debug_locks && !lockdep_is_held(l)); \
383 #define lockdep_recursing(tsk) ((tsk)->lockdep_recursion)
385 #define lockdep_pin_lock(l) lock_pin_lock(&(l)->dep_map)
386 #define lockdep_repin_lock(l,c) lock_repin_lock(&(l)->dep_map, (c))
387 #define lockdep_unpin_lock(l,c) lock_unpin_lock(&(l)->dep_map, (c))
389 #else /* !CONFIG_LOCKDEP */
391 static inline void lockdep_off(void)
395 static inline void lockdep_on(void)
399 # define lock_acquire(l, s, t, r, c, n, i) do { } while (0)
400 # define lock_release(l, n, i) do { } while (0)
401 # define lock_downgrade(l, i) do { } while (0)
402 # define lock_set_class(l, n, k, s, i) do { } while (0)
403 # define lock_set_subclass(l, s, i) do { } while (0)
404 # define lockdep_init() do { } while (0)
405 # define lockdep_init_map(lock, name, key, sub) \
406 do { (void)(name); (void)(key); } while (0)
407 # define lockdep_set_class(lock, key) do { (void)(key); } while (0)
408 # define lockdep_set_class_and_name(lock, key, name) \
409 do { (void)(key); (void)(name); } while (0)
410 #define lockdep_set_class_and_subclass(lock, key, sub) \
411 do { (void)(key); } while (0)
412 #define lockdep_set_subclass(lock, sub) do { } while (0)
414 #define lockdep_set_novalidate_class(lock) do { } while (0)
417 * We don't define lockdep_match_class() and lockdep_match_key() for !LOCKDEP
418 * case since the result is not well defined and the caller should rather
419 * #ifdef the call himself.
422 # define lockdep_reset() do { debug_locks = 1; } while (0)
423 # define lockdep_free_key_range(start, size) do { } while (0)
424 # define lockdep_sys_exit() do { } while (0)
426 * The class key takes no space if lockdep is disabled:
428 struct lock_class_key { };
431 * The lockdep_map takes no space if lockdep is disabled:
433 struct lockdep_map { };
435 #define lockdep_depth(tsk) (0)
437 #define lockdep_is_held_type(l, r) (1)
439 #define lockdep_assert_held(l) do { (void)(l); } while (0)
440 #define lockdep_assert_held_exclusive(l) do { (void)(l); } while (0)
441 #define lockdep_assert_held_read(l) do { (void)(l); } while (0)
442 #define lockdep_assert_held_once(l) do { (void)(l); } while (0)
444 #define lockdep_recursing(tsk) (0)
446 struct pin_cookie { };
448 #define NIL_COOKIE (struct pin_cookie){ }
450 #define lockdep_pin_lock(l) ({ struct pin_cookie cookie; cookie; })
451 #define lockdep_repin_lock(l, c) do { (void)(l); (void)(c); } while (0)
452 #define lockdep_unpin_lock(l, c) do { (void)(l); (void)(c); } while (0)
454 #endif /* !LOCKDEP */
456 enum xhlock_context_t {
462 #define lockdep_init_map_crosslock(m, n, k, s) do {} while (0)
464 * To initialize a lockdep_map statically use this macro.
465 * Note that _name must not be NULL.
467 #define STATIC_LOCKDEP_MAP_INIT(_name, _key) \
468 { .name = (_name), .key = (void *)(_key), }
470 static inline void lockdep_invariant_state(bool force) {}
471 static inline void lockdep_init_task(struct task_struct *task) {}
472 static inline void lockdep_free_task(struct task_struct *task) {}
474 #ifdef CONFIG_LOCK_STAT
476 extern void lock_contended(struct lockdep_map *lock, unsigned long ip);
477 extern void lock_acquired(struct lockdep_map *lock, unsigned long ip);
479 #define LOCK_CONTENDED(_lock, try, lock) \
482 lock_contended(&(_lock)->dep_map, _RET_IP_); \
485 lock_acquired(&(_lock)->dep_map, _RET_IP_); \
488 #define LOCK_CONTENDED_RETURN(_lock, try, lock) \
492 lock_contended(&(_lock)->dep_map, _RET_IP_); \
493 ____err = lock(_lock); \
496 lock_acquired(&(_lock)->dep_map, _RET_IP_); \
500 #else /* CONFIG_LOCK_STAT */
502 #define lock_contended(lockdep_map, ip) do {} while (0)
503 #define lock_acquired(lockdep_map, ip) do {} while (0)
505 #define LOCK_CONTENDED(_lock, try, lock) \
508 #define LOCK_CONTENDED_RETURN(_lock, try, lock) \
511 #endif /* CONFIG_LOCK_STAT */
513 #ifdef CONFIG_LOCKDEP
516 * On lockdep we dont want the hand-coded irq-enable of
517 * _raw_*_lock_flags() code, because lockdep assumes
518 * that interrupts are not re-enabled during lock-acquire:
520 #define LOCK_CONTENDED_FLAGS(_lock, try, lock, lockfl, flags) \
521 LOCK_CONTENDED((_lock), (try), (lock))
523 #else /* CONFIG_LOCKDEP */
525 #define LOCK_CONTENDED_FLAGS(_lock, try, lock, lockfl, flags) \
526 lockfl((_lock), (flags))
528 #endif /* CONFIG_LOCKDEP */
530 #ifdef CONFIG_PROVE_LOCKING
531 extern void print_irqtrace_events(struct task_struct *curr);
533 static inline void print_irqtrace_events(struct task_struct *curr)
539 * For trivial one-depth nesting of a lock-class, the following
540 * global define can be used. (Subsystems with multiple levels
541 * of nesting should define their own lock-nesting subclasses.)
543 #define SINGLE_DEPTH_NESTING 1
546 * Map the dependency ops to NOP or to real lockdep ops, depending
547 * on the per lock-class debug mode:
550 #define lock_acquire_exclusive(l, s, t, n, i) lock_acquire(l, s, t, 0, 1, n, i)
551 #define lock_acquire_shared(l, s, t, n, i) lock_acquire(l, s, t, 1, 1, n, i)
552 #define lock_acquire_shared_recursive(l, s, t, n, i) lock_acquire(l, s, t, 2, 1, n, i)
554 #define spin_acquire(l, s, t, i) lock_acquire_exclusive(l, s, t, NULL, i)
555 #define spin_acquire_nest(l, s, t, n, i) lock_acquire_exclusive(l, s, t, n, i)
556 #define spin_release(l, n, i) lock_release(l, n, i)
558 #define rwlock_acquire(l, s, t, i) lock_acquire_exclusive(l, s, t, NULL, i)
559 #define rwlock_acquire_read(l, s, t, i) lock_acquire_shared_recursive(l, s, t, NULL, i)
560 #define rwlock_release(l, n, i) lock_release(l, n, i)
562 #define seqcount_acquire(l, s, t, i) lock_acquire_exclusive(l, s, t, NULL, i)
563 #define seqcount_acquire_read(l, s, t, i) lock_acquire_shared_recursive(l, s, t, NULL, i)
564 #define seqcount_release(l, n, i) lock_release(l, n, i)
566 #define mutex_acquire(l, s, t, i) lock_acquire_exclusive(l, s, t, NULL, i)
567 #define mutex_acquire_nest(l, s, t, n, i) lock_acquire_exclusive(l, s, t, n, i)
568 #define mutex_release(l, n, i) lock_release(l, n, i)
570 #define rwsem_acquire(l, s, t, i) lock_acquire_exclusive(l, s, t, NULL, i)
571 #define rwsem_acquire_nest(l, s, t, n, i) lock_acquire_exclusive(l, s, t, n, i)
572 #define rwsem_acquire_read(l, s, t, i) lock_acquire_shared(l, s, t, NULL, i)
573 #define rwsem_release(l, n, i) lock_release(l, n, i)
575 #define lock_map_acquire(l) lock_acquire_exclusive(l, 0, 0, NULL, _THIS_IP_)
576 #define lock_map_acquire_read(l) lock_acquire_shared_recursive(l, 0, 0, NULL, _THIS_IP_)
577 #define lock_map_acquire_tryread(l) lock_acquire_shared_recursive(l, 0, 1, NULL, _THIS_IP_)
578 #define lock_map_release(l) lock_release(l, 1, _THIS_IP_)
580 #ifdef CONFIG_PROVE_LOCKING
581 # define might_lock(lock) \
583 typecheck(struct lockdep_map *, &(lock)->dep_map); \
584 lock_acquire(&(lock)->dep_map, 0, 0, 0, 1, NULL, _THIS_IP_); \
585 lock_release(&(lock)->dep_map, 0, _THIS_IP_); \
587 # define might_lock_read(lock) \
589 typecheck(struct lockdep_map *, &(lock)->dep_map); \
590 lock_acquire(&(lock)->dep_map, 0, 0, 1, 1, NULL, _THIS_IP_); \
591 lock_release(&(lock)->dep_map, 0, _THIS_IP_); \
594 #define lockdep_assert_irqs_enabled() do { \
595 WARN_ONCE(debug_locks && !current->lockdep_recursion && \
596 !current->hardirqs_enabled, \
597 "IRQs not enabled as expected\n"); \
600 #define lockdep_assert_irqs_disabled() do { \
601 WARN_ONCE(debug_locks && !current->lockdep_recursion && \
602 current->hardirqs_enabled, \
603 "IRQs not disabled as expected\n"); \
607 # define might_lock(lock) do { } while (0)
608 # define might_lock_read(lock) do { } while (0)
609 # define lockdep_assert_irqs_enabled() do { } while (0)
610 # define lockdep_assert_irqs_disabled() do { } while (0)
613 #ifdef CONFIG_LOCKDEP
614 void lockdep_rcu_suspicious(const char *file, const int line, const char *s);
617 lockdep_rcu_suspicious(const char *file, const int line, const char *s)
622 #endif /* __LINUX_LOCKDEP_H */