]> git.proxmox.com Git - mirror_ubuntu-zesty-kernel.git/blame - include/linux/lockdep.h
[PATCH] kexec: fix references to init in documentation for kexec
[mirror_ubuntu-zesty-kernel.git] / include / linux / lockdep.h
CommitLineData
fbb9ce95
IM
1/*
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
db0b0ead
MT
11#ifdef CONFIG_LOCKDEP
12
fbb9ce95
IM
13#include <linux/linkage.h>
14#include <linux/list.h>
15#include <linux/debug_locks.h>
16#include <linux/stacktrace.h>
17
fbb9ce95
IM
18/*
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;
d6d897ce 123 struct lock_class *class_cache;
fbb9ce95
IM
124 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;
068135e6 135 int distance;
fbb9ce95
IM
136};
137
138/*
139 * We record lock dependency chains, so that we can cache them:
140 */
141struct lock_chain {
142 struct list_head entry;
143 u64 chain_key;
144};
145
146struct held_lock {
147 /*
148 * One-way hash of the dependency chain up to this point. We
149 * hash the hashes step by step as the dependency chain grows.
150 *
151 * We use it for dependency-caching and we skip detection
152 * passes and dependency-updates if there is a cache-hit, so
153 * it is absolutely critical for 100% coverage of the validator
154 * to have a unique key value for every unique dependency path
155 * that can occur in the system, to make a unique hash value
156 * as likely as possible - hence the 64-bit width.
157 *
158 * The task struct holds the current hash value (initialized
159 * with zero), here we store the previous hash value:
160 */
161 u64 prev_chain_key;
162 struct lock_class *class;
163 unsigned long acquire_ip;
164 struct lockdep_map *instance;
165
166 /*
167 * The lock-stack is unified in that the lock chains of interrupt
168 * contexts nest ontop of process context chains, but we 'separate'
169 * the hashes by starting with 0 if we cross into an interrupt
170 * context, and we also keep do not add cross-context lock
171 * dependencies - the lock usage graph walking covers that area
172 * anyway, and we'd just unnecessarily increase the number of
173 * dependencies otherwise. [Note: hardirq and softirq contexts
174 * are separated from each other too.]
175 *
176 * The following field is used to detect when we cross into an
177 * interrupt context:
178 */
179 int irq_context;
180 int trylock;
181 int read;
182 int check;
183 int hardirqs_off;
184};
185
186/*
187 * Initialization, self-test and debugging-output methods:
188 */
189extern void lockdep_init(void);
190extern void lockdep_info(void);
191extern void lockdep_reset(void);
192extern void lockdep_reset_lock(struct lockdep_map *lock);
193extern void lockdep_free_key_range(void *start, unsigned long size);
194
195extern void lockdep_off(void);
196extern void lockdep_on(void);
fbb9ce95
IM
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,
4dfbb9d8 205 struct lock_class_key *key, int subclass);
fbb9ce95
IM
206
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) \
4dfbb9d8 214 lockdep_init_map(&(lock)->dep_map, #key, key, 0)
fbb9ce95 215#define lockdep_set_class_and_name(lock, key, name) \
4dfbb9d8
PZ
216 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)
fbb9ce95
IM
222
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
d5abe669
PZ
246#define lockdep_depth(tsk) ((tsk)->lockdep_depth)
247
fbb9ce95
IM
248#else /* !LOCKDEP */
249
250static inline void lockdep_off(void)
251{
252}
253
254static inline void lockdep_on(void)
255{
256}
257
fbb9ce95
IM
258# define lock_acquire(l, s, t, r, c, i) do { } while (0)
259# define lock_release(l, n, i) do { } while (0)
260# define lockdep_init() do { } while (0)
261# define lockdep_info() do { } while (0)
4dfbb9d8 262# define lockdep_init_map(lock, name, key, sub) do { (void)(key); } while (0)
fbb9ce95
IM
263# define lockdep_set_class(lock, key) do { (void)(key); } while (0)
264# define lockdep_set_class_and_name(lock, key, name) \
265 do { (void)(key); } while (0)
4dfbb9d8
PZ
266#define lockdep_set_class_and_subclass(lock, key, sub) \
267 do { (void)(key); } while (0)
07646e21
AM
268#define lockdep_set_subclass(lock, sub) do { } while (0)
269
fbb9ce95
IM
270# define INIT_LOCKDEP
271# define lockdep_reset() do { debug_locks = 1; } while (0)
272# define lockdep_free_key_range(start, size) do { } while (0)
273/*
274 * The class key takes no space if lockdep is disabled:
275 */
276struct lock_class_key { };
d5abe669
PZ
277
278#define lockdep_depth(tsk) (0)
279
fbb9ce95
IM
280#endif /* !LOCKDEP */
281
243c7621
IM
282#if defined(CONFIG_TRACE_IRQFLAGS) && defined(CONFIG_GENERIC_HARDIRQS)
283extern void early_init_irq_lock_class(void);
284#else
3117df04
IM
285static inline void early_init_irq_lock_class(void)
286{
287}
243c7621
IM
288#endif
289
fbb9ce95
IM
290#ifdef CONFIG_TRACE_IRQFLAGS
291extern void early_boot_irqs_off(void);
292extern void early_boot_irqs_on(void);
3117df04 293extern void print_irqtrace_events(struct task_struct *curr);
fbb9ce95 294#else
3117df04
IM
295static inline void early_boot_irqs_off(void)
296{
297}
298static inline void early_boot_irqs_on(void)
299{
300}
301static inline void print_irqtrace_events(struct task_struct *curr)
302{
303}
fbb9ce95
IM
304#endif
305
306/*
307 * For trivial one-depth nesting of a lock-class, the following
308 * global define can be used. (Subsystems with multiple levels
309 * of nesting should define their own lock-nesting subclasses.)
310 */
311#define SINGLE_DEPTH_NESTING 1
312
313/*
314 * Map the dependency ops to NOP or to real lockdep ops, depending
315 * on the per lock-class debug mode:
316 */
317
318#ifdef CONFIG_DEBUG_LOCK_ALLOC
319# ifdef CONFIG_PROVE_LOCKING
320# define spin_acquire(l, s, t, i) lock_acquire(l, s, t, 0, 2, i)
321# else
322# define spin_acquire(l, s, t, i) lock_acquire(l, s, t, 0, 1, i)
323# endif
324# define spin_release(l, n, i) lock_release(l, n, i)
325#else
326# define spin_acquire(l, s, t, i) do { } while (0)
327# define spin_release(l, n, i) do { } while (0)
328#endif
329
330#ifdef CONFIG_DEBUG_LOCK_ALLOC
331# ifdef CONFIG_PROVE_LOCKING
332# define rwlock_acquire(l, s, t, i) lock_acquire(l, s, t, 0, 2, i)
333# define rwlock_acquire_read(l, s, t, i) lock_acquire(l, s, t, 2, 2, i)
334# else
335# define rwlock_acquire(l, s, t, i) lock_acquire(l, s, t, 0, 1, i)
336# define rwlock_acquire_read(l, s, t, i) lock_acquire(l, s, t, 2, 1, i)
337# endif
338# define rwlock_release(l, n, i) lock_release(l, n, i)
339#else
340# define rwlock_acquire(l, s, t, i) do { } while (0)
341# define rwlock_acquire_read(l, s, t, i) do { } while (0)
342# define rwlock_release(l, n, i) do { } while (0)
343#endif
344
345#ifdef CONFIG_DEBUG_LOCK_ALLOC
346# ifdef CONFIG_PROVE_LOCKING
347# define mutex_acquire(l, s, t, i) lock_acquire(l, s, t, 0, 2, i)
348# else
349# define mutex_acquire(l, s, t, i) lock_acquire(l, s, t, 0, 1, i)
350# endif
351# define mutex_release(l, n, i) lock_release(l, n, i)
352#else
353# define mutex_acquire(l, s, t, i) do { } while (0)
354# define mutex_release(l, n, i) do { } while (0)
355#endif
356
357#ifdef CONFIG_DEBUG_LOCK_ALLOC
358# ifdef CONFIG_PROVE_LOCKING
359# define rwsem_acquire(l, s, t, i) lock_acquire(l, s, t, 0, 2, i)
360# define rwsem_acquire_read(l, s, t, i) lock_acquire(l, s, t, 1, 2, i)
361# else
362# define rwsem_acquire(l, s, t, i) lock_acquire(l, s, t, 0, 1, i)
363# define rwsem_acquire_read(l, s, t, i) lock_acquire(l, s, t, 1, 1, i)
364# endif
365# define rwsem_release(l, n, i) lock_release(l, n, i)
366#else
367# define rwsem_acquire(l, s, t, i) do { } while (0)
368# define rwsem_acquire_read(l, s, t, i) do { } while (0)
369# define rwsem_release(l, n, i) do { } while (0)
370#endif
371
372#endif /* __LINUX_LOCKDEP_H */