blob: 819f08f1310db878f753e7656da2ce32590a5a69 [file] [log] [blame]
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07001/*
2 * Runtime locking correctness validator
3 *
4 * Copyright (C) 2006 Red Hat, Inc., Ingo Molnar <mingo@redhat.com>
5 *
6 * see Documentation/lockdep-design.txt for more details.
7 */
8#ifndef __LINUX_LOCKDEP_H
9#define __LINUX_LOCKDEP_H
10
Michael S. Tsirkindb0b0ea2006-09-29 01:59:28 -070011#ifdef CONFIG_LOCKDEP
12
Ingo Molnarfbb9ce952006-07-03 00:24:50 -070013#include <linux/linkage.h>
14#include <linux/list.h>
15#include <linux/debug_locks.h>
16#include <linux/stacktrace.h>
17
Ingo Molnarfbb9ce952006-07-03 00:24:50 -070018/*
19 * Lock-class usage-state bits:
20 */
21enum lock_usage_bit
22{
23 LOCK_USED = 0,
24 LOCK_USED_IN_HARDIRQ,
25 LOCK_USED_IN_SOFTIRQ,
26 LOCK_ENABLED_SOFTIRQS,
27 LOCK_ENABLED_HARDIRQS,
28 LOCK_USED_IN_HARDIRQ_READ,
29 LOCK_USED_IN_SOFTIRQ_READ,
30 LOCK_ENABLED_SOFTIRQS_READ,
31 LOCK_ENABLED_HARDIRQS_READ,
32 LOCK_USAGE_STATES
33};
34
35/*
36 * Usage-state bitmasks:
37 */
38#define LOCKF_USED (1 << LOCK_USED)
39#define LOCKF_USED_IN_HARDIRQ (1 << LOCK_USED_IN_HARDIRQ)
40#define LOCKF_USED_IN_SOFTIRQ (1 << LOCK_USED_IN_SOFTIRQ)
41#define LOCKF_ENABLED_HARDIRQS (1 << LOCK_ENABLED_HARDIRQS)
42#define LOCKF_ENABLED_SOFTIRQS (1 << LOCK_ENABLED_SOFTIRQS)
43
44#define LOCKF_ENABLED_IRQS (LOCKF_ENABLED_HARDIRQS | LOCKF_ENABLED_SOFTIRQS)
45#define LOCKF_USED_IN_IRQ (LOCKF_USED_IN_HARDIRQ | LOCKF_USED_IN_SOFTIRQ)
46
47#define LOCKF_USED_IN_HARDIRQ_READ (1 << LOCK_USED_IN_HARDIRQ_READ)
48#define LOCKF_USED_IN_SOFTIRQ_READ (1 << LOCK_USED_IN_SOFTIRQ_READ)
49#define LOCKF_ENABLED_HARDIRQS_READ (1 << LOCK_ENABLED_HARDIRQS_READ)
50#define LOCKF_ENABLED_SOFTIRQS_READ (1 << LOCK_ENABLED_SOFTIRQS_READ)
51
52#define LOCKF_ENABLED_IRQS_READ \
53 (LOCKF_ENABLED_HARDIRQS_READ | LOCKF_ENABLED_SOFTIRQS_READ)
54#define LOCKF_USED_IN_IRQ_READ \
55 (LOCKF_USED_IN_HARDIRQ_READ | LOCKF_USED_IN_SOFTIRQ_READ)
56
57#define MAX_LOCKDEP_SUBCLASSES 8UL
58
59/*
60 * Lock-classes are keyed via unique addresses, by embedding the
61 * lockclass-key into the kernel (or module) .data section. (For
62 * static locks we use the lock address itself as the key.)
63 */
64struct lockdep_subclass_key {
65 char __one_byte;
66} __attribute__ ((__packed__));
67
68struct lock_class_key {
69 struct lockdep_subclass_key subkeys[MAX_LOCKDEP_SUBCLASSES];
70};
71
72/*
73 * The lock-class itself:
74 */
75struct lock_class {
76 /*
77 * class-hash:
78 */
79 struct list_head hash_entry;
80
81 /*
82 * global list of all lock-classes:
83 */
84 struct list_head lock_entry;
85
86 struct lockdep_subclass_key *key;
87 unsigned int subclass;
88
89 /*
90 * IRQ/softirq usage tracking bits:
91 */
92 unsigned long usage_mask;
93 struct stack_trace usage_traces[LOCK_USAGE_STATES];
94
95 /*
96 * These fields represent a directed graph of lock dependencies,
97 * to every node we attach a list of "forward" and a list of
98 * "backward" graph nodes.
99 */
100 struct list_head locks_after, locks_before;
101
102 /*
103 * Generation counter, when doing certain classes of graph walking,
104 * to ensure that we check one node only once:
105 */
106 unsigned int version;
107
108 /*
109 * Statistics counter:
110 */
111 unsigned long ops;
112
113 const char *name;
114 int name_version;
115};
116
117/*
118 * Map the lock object (the lock instance) to the lock-class object.
119 * This is embedded into specific lock instances:
120 */
121struct lockdep_map {
122 struct lock_class_key *key;
Ingo Molnard6d897c2006-07-10 04:44:04 -0700123 struct lock_class *class_cache;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700124 const char *name;
125};
126
127/*
128 * Every lock has a list of other locks that were taken after it.
129 * We only grow the list, never remove from it:
130 */
131struct lock_list {
132 struct list_head entry;
133 struct lock_class *class;
134 struct stack_trace trace;
135};
136
137/*
138 * We record lock dependency chains, so that we can cache them:
139 */
140struct lock_chain {
141 struct list_head entry;
142 u64 chain_key;
143};
144
145struct held_lock {
146 /*
147 * One-way hash of the dependency chain up to this point. We
148 * hash the hashes step by step as the dependency chain grows.
149 *
150 * We use it for dependency-caching and we skip detection
151 * passes and dependency-updates if there is a cache-hit, so
152 * it is absolutely critical for 100% coverage of the validator
153 * to have a unique key value for every unique dependency path
154 * that can occur in the system, to make a unique hash value
155 * as likely as possible - hence the 64-bit width.
156 *
157 * The task struct holds the current hash value (initialized
158 * with zero), here we store the previous hash value:
159 */
160 u64 prev_chain_key;
161 struct lock_class *class;
162 unsigned long acquire_ip;
163 struct lockdep_map *instance;
164
165 /*
166 * The lock-stack is unified in that the lock chains of interrupt
167 * contexts nest ontop of process context chains, but we 'separate'
168 * the hashes by starting with 0 if we cross into an interrupt
169 * context, and we also keep do not add cross-context lock
170 * dependencies - the lock usage graph walking covers that area
171 * anyway, and we'd just unnecessarily increase the number of
172 * dependencies otherwise. [Note: hardirq and softirq contexts
173 * are separated from each other too.]
174 *
175 * The following field is used to detect when we cross into an
176 * interrupt context:
177 */
178 int irq_context;
179 int trylock;
180 int read;
181 int check;
182 int hardirqs_off;
183};
184
185/*
186 * Initialization, self-test and debugging-output methods:
187 */
188extern void lockdep_init(void);
189extern void lockdep_info(void);
190extern void lockdep_reset(void);
191extern void lockdep_reset_lock(struct lockdep_map *lock);
192extern void lockdep_free_key_range(void *start, unsigned long size);
193
194extern void lockdep_off(void);
195extern void lockdep_on(void);
196extern int lockdep_internal(void);
197
198/*
199 * These methods are used by specific locking variants (spinlocks,
200 * rwlocks, mutexes and rwsems) to pass init/acquire/release events
201 * to lockdep:
202 */
203
204extern void lockdep_init_map(struct lockdep_map *lock, const char *name,
Peter Zijlstra4dfbb9d2006-10-11 01:45:14 -0400205 struct lock_class_key *key, int subclass);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700206
207/*
208 * Reinitialize a lock key - for cases where there is special locking or
209 * special initialization of locks so that the validator gets the scope
210 * of dependencies wrong: they are either too broad (they need a class-split)
211 * or they are too narrow (they suffer from a false class-split):
212 */
213#define lockdep_set_class(lock, key) \
Peter Zijlstra4dfbb9d2006-10-11 01:45:14 -0400214 lockdep_init_map(&(lock)->dep_map, #key, key, 0)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700215#define lockdep_set_class_and_name(lock, key, name) \
Peter Zijlstra4dfbb9d2006-10-11 01:45:14 -0400216 lockdep_init_map(&(lock)->dep_map, name, key, 0)
217#define lockdep_set_class_and_subclass(lock, key, sub) \
218 lockdep_init_map(&(lock)->dep_map, #key, key, sub)
219#define lockdep_set_subclass(lock, sub) \
220 lockdep_init_map(&(lock)->dep_map, #lock, \
221 (lock)->dep_map.key, sub)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700222
223/*
224 * Acquire a lock.
225 *
226 * Values for "read":
227 *
228 * 0: exclusive (write) acquire
229 * 1: read-acquire (no recursion allowed)
230 * 2: read-acquire with same-instance recursion allowed
231 *
232 * Values for check:
233 *
234 * 0: disabled
235 * 1: simple checks (freeing, held-at-exit-time, etc.)
236 * 2: full validation
237 */
238extern void lock_acquire(struct lockdep_map *lock, unsigned int subclass,
239 int trylock, int read, int check, unsigned long ip);
240
241extern void lock_release(struct lockdep_map *lock, int nested,
242 unsigned long ip);
243
244# define INIT_LOCKDEP .lockdep_recursion = 0,
245
246#else /* !LOCKDEP */
247
248static inline void lockdep_off(void)
249{
250}
251
252static inline void lockdep_on(void)
253{
254}
255
256static inline int lockdep_internal(void)
257{
258 return 0;
259}
260
261# define lock_acquire(l, s, t, r, c, i) do { } while (0)
262# define lock_release(l, n, i) do { } while (0)
263# define lockdep_init() do { } while (0)
264# define lockdep_info() do { } while (0)
Peter Zijlstra4dfbb9d2006-10-11 01:45:14 -0400265# define lockdep_init_map(lock, name, key, sub) do { (void)(key); } while (0)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700266# define lockdep_set_class(lock, key) do { (void)(key); } while (0)
267# define lockdep_set_class_and_name(lock, key, name) \
268 do { (void)(key); } while (0)
Peter Zijlstra4dfbb9d2006-10-11 01:45:14 -0400269#define lockdep_set_class_and_subclass(lock, key, sub) \
270 do { (void)(key); } while (0)
Andrew Morton07646e22006-10-11 23:45:23 -0400271#define lockdep_set_subclass(lock, sub) do { } while (0)
272
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700273# define INIT_LOCKDEP
274# define lockdep_reset() do { debug_locks = 1; } while (0)
275# define lockdep_free_key_range(start, size) do { } while (0)
276/*
277 * The class key takes no space if lockdep is disabled:
278 */
279struct lock_class_key { };
280#endif /* !LOCKDEP */
281
Ingo Molnar243c7622006-07-03 00:25:06 -0700282#if defined(CONFIG_TRACE_IRQFLAGS) && defined(CONFIG_GENERIC_HARDIRQS)
283extern void early_init_irq_lock_class(void);
284#else
285# define early_init_irq_lock_class() do { } while (0)
286#endif
287
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700288#ifdef CONFIG_TRACE_IRQFLAGS
289extern void early_boot_irqs_off(void);
290extern void early_boot_irqs_on(void);
291#else
292# define early_boot_irqs_off() do { } while (0)
293# define early_boot_irqs_on() do { } while (0)
294#endif
295
296/*
297 * For trivial one-depth nesting of a lock-class, the following
298 * global define can be used. (Subsystems with multiple levels
299 * of nesting should define their own lock-nesting subclasses.)
300 */
301#define SINGLE_DEPTH_NESTING 1
302
303/*
304 * Map the dependency ops to NOP or to real lockdep ops, depending
305 * on the per lock-class debug mode:
306 */
307
308#ifdef CONFIG_DEBUG_LOCK_ALLOC
309# ifdef CONFIG_PROVE_LOCKING
310# define spin_acquire(l, s, t, i) lock_acquire(l, s, t, 0, 2, i)
311# else
312# define spin_acquire(l, s, t, i) lock_acquire(l, s, t, 0, 1, i)
313# endif
314# define spin_release(l, n, i) lock_release(l, n, i)
315#else
316# define spin_acquire(l, s, t, i) do { } while (0)
317# define spin_release(l, n, i) do { } while (0)
318#endif
319
320#ifdef CONFIG_DEBUG_LOCK_ALLOC
321# ifdef CONFIG_PROVE_LOCKING
322# define rwlock_acquire(l, s, t, i) lock_acquire(l, s, t, 0, 2, i)
323# define rwlock_acquire_read(l, s, t, i) lock_acquire(l, s, t, 2, 2, i)
324# else
325# define rwlock_acquire(l, s, t, i) lock_acquire(l, s, t, 0, 1, i)
326# define rwlock_acquire_read(l, s, t, i) lock_acquire(l, s, t, 2, 1, i)
327# endif
328# define rwlock_release(l, n, i) lock_release(l, n, i)
329#else
330# define rwlock_acquire(l, s, t, i) do { } while (0)
331# define rwlock_acquire_read(l, s, t, i) do { } while (0)
332# define rwlock_release(l, n, i) do { } while (0)
333#endif
334
335#ifdef CONFIG_DEBUG_LOCK_ALLOC
336# ifdef CONFIG_PROVE_LOCKING
337# define mutex_acquire(l, s, t, i) lock_acquire(l, s, t, 0, 2, i)
338# else
339# define mutex_acquire(l, s, t, i) lock_acquire(l, s, t, 0, 1, i)
340# endif
341# define mutex_release(l, n, i) lock_release(l, n, i)
342#else
343# define mutex_acquire(l, s, t, i) do { } while (0)
344# define mutex_release(l, n, i) do { } while (0)
345#endif
346
347#ifdef CONFIG_DEBUG_LOCK_ALLOC
348# ifdef CONFIG_PROVE_LOCKING
349# define rwsem_acquire(l, s, t, i) lock_acquire(l, s, t, 0, 2, i)
350# define rwsem_acquire_read(l, s, t, i) lock_acquire(l, s, t, 1, 2, i)
351# else
352# define rwsem_acquire(l, s, t, i) lock_acquire(l, s, t, 0, 1, i)
353# define rwsem_acquire_read(l, s, t, i) lock_acquire(l, s, t, 1, 1, i)
354# endif
355# define rwsem_release(l, n, i) lock_release(l, n, i)
356#else
357# define rwsem_acquire(l, s, t, i) do { } while (0)
358# define rwsem_acquire_read(l, s, t, i) do { } while (0)
359# define rwsem_release(l, n, i) do { } while (0)
360#endif
361
362#endif /* __LINUX_LOCKDEP_H */