1
2
3
4
5
6
7
8
9#ifndef __LINUX_LOCKDEP_H
10#define __LINUX_LOCKDEP_H
11
12struct task_struct;
13struct lockdep_map;
14
15
16extern int prove_locking;
17extern int lock_stat;
18
19#ifdef CONFIG_LOCKDEP
20
21#include <linux/linkage.h>
22#include <linux/list.h>
23#include <linux/debug_locks.h>
24#include <linux/stacktrace.h>
25
26
27
28
29
30#define XXX_LOCK_USAGE_STATES (1+3*4)
31
32#define MAX_LOCKDEP_SUBCLASSES 8UL
33
34
35
36
37
38
39
40
41
42
43#define NR_LOCKDEP_CACHING_CLASSES 2
44
45
46
47
48
49
50struct lockdep_subclass_key {
51 char __one_byte;
52} __attribute__ ((__packed__));
53
54struct lock_class_key {
55 struct lockdep_subclass_key subkeys[MAX_LOCKDEP_SUBCLASSES];
56};
57
58extern struct lock_class_key __lockdep_no_validate__;
59
60#define LOCKSTAT_POINTS 4
61
62
63
64
65struct lock_class {
66
67
68
69 struct hlist_node hash_entry;
70
71
72
73
74 struct list_head lock_entry;
75
76 struct lockdep_subclass_key *key;
77 unsigned int subclass;
78 unsigned int dep_gen_id;
79
80
81
82
83 unsigned long usage_mask;
84 struct stack_trace usage_traces[XXX_LOCK_USAGE_STATES];
85
86
87
88
89
90
91 struct list_head locks_after, locks_before;
92
93
94
95
96
97 unsigned int version;
98
99
100
101
102 unsigned long ops;
103
104 const char *name;
105 int name_version;
106
107#ifdef CONFIG_LOCK_STAT
108 unsigned long contention_point[LOCKSTAT_POINTS];
109 unsigned long contending_point[LOCKSTAT_POINTS];
110#endif
111};
112
113#ifdef CONFIG_LOCK_STAT
114struct lock_time {
115 s64 min;
116 s64 max;
117 s64 total;
118 unsigned long nr;
119};
120
121enum bounce_type {
122 bounce_acquired_write,
123 bounce_acquired_read,
124 bounce_contended_write,
125 bounce_contended_read,
126 nr_bounce_types,
127
128 bounce_acquired = bounce_acquired_write,
129 bounce_contended = bounce_contended_write,
130};
131
132struct lock_class_stats {
133 unsigned long contention_point[LOCKSTAT_POINTS];
134 unsigned long contending_point[LOCKSTAT_POINTS];
135 struct lock_time read_waittime;
136 struct lock_time write_waittime;
137 struct lock_time read_holdtime;
138 struct lock_time write_holdtime;
139 unsigned long bounces[nr_bounce_types];
140};
141
142struct lock_class_stats lock_stats(struct lock_class *class);
143void clear_lock_stats(struct lock_class *class);
144#endif
145
146
147
148
149
150struct lockdep_map {
151 struct lock_class_key *key;
152 struct lock_class *class_cache[NR_LOCKDEP_CACHING_CLASSES];
153 const char *name;
154#ifdef CONFIG_LOCK_STAT
155 int cpu;
156 unsigned long ip;
157#endif
158};
159
160static inline void lockdep_copy_map(struct lockdep_map *to,
161 struct lockdep_map *from)
162{
163 int i;
164
165 *to = *from;
166
167
168
169
170
171
172
173
174 for (i = 0; i < NR_LOCKDEP_CACHING_CLASSES; i++)
175 to->class_cache[i] = NULL;
176}
177
178
179
180
181
182struct lock_list {
183 struct list_head entry;
184 struct lock_class *class;
185 struct stack_trace trace;
186 int distance;
187
188
189
190
191
192 struct lock_list *parent;
193};
194
195
196
197
198struct lock_chain {
199
200 unsigned int irq_context : 2,
201 depth : 6,
202 base : 24;
203
204 struct hlist_node entry;
205 u64 chain_key;
206};
207
208#define MAX_LOCKDEP_KEYS_BITS 13
209
210
211
212
213
214#define MAX_LOCKDEP_KEYS ((1UL << MAX_LOCKDEP_KEYS_BITS) - 1)
215
216struct held_lock {
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231 u64 prev_chain_key;
232 unsigned long acquire_ip;
233 struct lockdep_map *instance;
234 struct lockdep_map *nest_lock;
235#ifdef CONFIG_LOCK_STAT
236 u64 waittime_stamp;
237 u64 holdtime_stamp;
238#endif
239 unsigned int class_idx:MAX_LOCKDEP_KEYS_BITS;
240
241
242
243
244
245
246
247
248
249
250
251
252
253 unsigned int irq_context:2;
254 unsigned int trylock:1;
255
256 unsigned int read:2;
257 unsigned int check:1;
258 unsigned int hardirqs_off:1;
259 unsigned int references:12;
260 unsigned int pin_count;
261};
262
263
264
265
266extern void lockdep_info(void);
267extern void lockdep_reset(void);
268extern void lockdep_reset_lock(struct lockdep_map *lock);
269extern void lockdep_free_key_range(void *start, unsigned long size);
270extern asmlinkage void lockdep_sys_exit(void);
271
272extern void lockdep_off(void);
273extern void lockdep_on(void);
274
275
276
277
278
279
280
281extern void lockdep_init_map(struct lockdep_map *lock, const char *name,
282 struct lock_class_key *key, int subclass);
283
284
285
286
287
288#define STATIC_LOCKDEP_MAP_INIT(_name, _key) \
289 { .name = (_name), .key = (void *)(_key), }
290
291
292
293
294
295
296
297#define lockdep_set_class(lock, key) \
298 lockdep_init_map(&(lock)->dep_map, #key, key, 0)
299#define lockdep_set_class_and_name(lock, key, name) \
300 lockdep_init_map(&(lock)->dep_map, name, key, 0)
301#define lockdep_set_class_and_subclass(lock, key, sub) \
302 lockdep_init_map(&(lock)->dep_map, #key, key, sub)
303#define lockdep_set_subclass(lock, sub) \
304 lockdep_init_map(&(lock)->dep_map, #lock, \
305 (lock)->dep_map.key, sub)
306
307#define lockdep_set_novalidate_class(lock) \
308 lockdep_set_class_and_name(lock, &__lockdep_no_validate__, #lock)
309
310
311
312#define lockdep_match_class(lock, key) lockdep_match_key(&(lock)->dep_map, key)
313
314static inline int lockdep_match_key(struct lockdep_map *lock,
315 struct lock_class_key *key)
316{
317 return lock->key == key;
318}
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334extern void lock_acquire(struct lockdep_map *lock, unsigned int subclass,
335 int trylock, int read, int check,
336 struct lockdep_map *nest_lock, unsigned long ip);
337
338extern void lock_release(struct lockdep_map *lock, int nested,
339 unsigned long ip);
340
341#define lockdep_is_held(lock) lock_is_held(&(lock)->dep_map)
342
343extern int lock_is_held(struct lockdep_map *lock);
344
345extern void lock_set_class(struct lockdep_map *lock, const char *name,
346 struct lock_class_key *key, unsigned int subclass,
347 unsigned long ip);
348
349static inline void lock_set_subclass(struct lockdep_map *lock,
350 unsigned int subclass, unsigned long ip)
351{
352 lock_set_class(lock, lock->name, lock->key, subclass, ip);
353}
354
355extern void lockdep_set_current_reclaim_state(gfp_t gfp_mask);
356extern void lockdep_clear_current_reclaim_state(void);
357extern void lockdep_trace_alloc(gfp_t mask);
358
359extern void lock_pin_lock(struct lockdep_map *lock);
360extern void lock_unpin_lock(struct lockdep_map *lock);
361
362# define INIT_LOCKDEP .lockdep_recursion = 0, .lockdep_reclaim_gfp = 0,
363
364#define lockdep_depth(tsk) (debug_locks ? (tsk)->lockdep_depth : 0)
365
366#define lockdep_assert_held(l) do { \
367 WARN_ON(debug_locks && !lockdep_is_held(l)); \
368 } while (0)
369
370#define lockdep_assert_held_once(l) do { \
371 WARN_ON_ONCE(debug_locks && !lockdep_is_held(l)); \
372 } while (0)
373
374#define lockdep_recursing(tsk) ((tsk)->lockdep_recursion)
375
376#define lockdep_pin_lock(l) lock_pin_lock(&(l)->dep_map)
377#define lockdep_unpin_lock(l) lock_unpin_lock(&(l)->dep_map)
378
379#else
380
381static inline void lockdep_off(void)
382{
383}
384
385static inline void lockdep_on(void)
386{
387}
388
389# define lock_acquire(l, s, t, r, c, n, i) do { } while (0)
390# define lock_release(l, n, i) do { } while (0)
391# define lock_set_class(l, n, k, s, i) do { } while (0)
392# define lock_set_subclass(l, s, i) do { } while (0)
393# define lockdep_set_current_reclaim_state(g) do { } while (0)
394# define lockdep_clear_current_reclaim_state() do { } while (0)
395# define lockdep_trace_alloc(g) do { } while (0)
396# define lockdep_info() do { } while (0)
397# define lockdep_init_map(lock, name, key, sub) \
398 do { (void)(name); (void)(key); } while (0)
399# define lockdep_set_class(lock, key) do { (void)(key); } while (0)
400# define lockdep_set_class_and_name(lock, key, name) \
401 do { (void)(key); (void)(name); } while (0)
402#define lockdep_set_class_and_subclass(lock, key, sub) \
403 do { (void)(key); } while (0)
404#define lockdep_set_subclass(lock, sub) do { } while (0)
405
406#define lockdep_set_novalidate_class(lock) do { } while (0)
407
408
409
410
411
412
413
414# define INIT_LOCKDEP
415# define lockdep_reset() do { debug_locks = 1; } while (0)
416# define lockdep_free_key_range(start, size) do { } while (0)
417# define lockdep_sys_exit() do { } while (0)
418
419
420
421struct lock_class_key { };
422
423#define lockdep_depth(tsk) (0)
424
425#define lockdep_assert_held(l) do { (void)(l); } while (0)
426#define lockdep_assert_held_once(l) do { (void)(l); } while (0)
427
428#define lockdep_recursing(tsk) (0)
429
430#define lockdep_pin_lock(l) do { (void)(l); } while (0)
431#define lockdep_unpin_lock(l) do { (void)(l); } while (0)
432
433#endif
434
435#ifdef CONFIG_LOCK_STAT
436
437extern void lock_contended(struct lockdep_map *lock, unsigned long ip);
438extern void lock_acquired(struct lockdep_map *lock, unsigned long ip);
439
440#define LOCK_CONTENDED(_lock, try, lock) \
441do { \
442 if (!try(_lock)) { \
443 lock_contended(&(_lock)->dep_map, _RET_IP_); \
444 lock(_lock); \
445 } \
446 lock_acquired(&(_lock)->dep_map, _RET_IP_); \
447} while (0)
448
449#else
450
451#define lock_contended(lockdep_map, ip) do {} while (0)
452#define lock_acquired(lockdep_map, ip) do {} while (0)
453
454#define LOCK_CONTENDED(_lock, try, lock) \
455 lock(_lock)
456
457#endif
458
459#ifdef CONFIG_LOCKDEP
460
461
462
463
464
465
466#define LOCK_CONTENDED_FLAGS(_lock, try, lock, lockfl, flags) \
467 LOCK_CONTENDED((_lock), (try), (lock))
468
469#else
470
471#define LOCK_CONTENDED_FLAGS(_lock, try, lock, lockfl, flags) \
472 lockfl((_lock), (flags))
473
474#endif
475
476#ifdef CONFIG_TRACE_IRQFLAGS
477extern void print_irqtrace_events(struct task_struct *curr);
478#else
479static inline void print_irqtrace_events(struct task_struct *curr)
480{
481}
482#endif
483
484
485
486
487
488
489#define SINGLE_DEPTH_NESTING 1
490
491
492
493
494
495
496#define lock_acquire_exclusive(l, s, t, n, i) lock_acquire(l, s, t, 0, 1, n, i)
497#define lock_acquire_shared(l, s, t, n, i) lock_acquire(l, s, t, 1, 1, n, i)
498#define lock_acquire_shared_recursive(l, s, t, n, i) lock_acquire(l, s, t, 2, 1, n, i)
499
500#define spin_acquire(l, s, t, i) lock_acquire_exclusive(l, s, t, NULL, i)
501#define spin_acquire_nest(l, s, t, n, i) lock_acquire_exclusive(l, s, t, n, i)
502#define spin_release(l, n, i) lock_release(l, n, i)
503
504#define rwlock_acquire(l, s, t, i) lock_acquire_exclusive(l, s, t, NULL, i)
505#define rwlock_acquire_read(l, s, t, i) lock_acquire_shared_recursive(l, s, t, NULL, i)
506#define rwlock_release(l, n, i) lock_release(l, n, i)
507
508#define seqcount_acquire(l, s, t, i) lock_acquire_exclusive(l, s, t, NULL, i)
509#define seqcount_acquire_read(l, s, t, i) lock_acquire_shared_recursive(l, s, t, NULL, i)
510#define seqcount_release(l, n, i) lock_release(l, n, i)
511
512#define mutex_acquire(l, s, t, i) lock_acquire_exclusive(l, s, t, NULL, i)
513#define mutex_acquire_nest(l, s, t, n, i) lock_acquire_exclusive(l, s, t, n, i)
514#define mutex_release(l, n, i) lock_release(l, n, i)
515
516#define rwsem_acquire(l, s, t, i) lock_acquire_exclusive(l, s, t, NULL, i)
517#define rwsem_acquire_nest(l, s, t, n, i) lock_acquire_exclusive(l, s, t, n, i)
518#define rwsem_acquire_read(l, s, t, i) lock_acquire_shared(l, s, t, NULL, i)
519#define rwsem_release(l, n, i) lock_release(l, n, i)
520
521#define lock_map_acquire(l) lock_acquire_exclusive(l, 0, 0, NULL, _THIS_IP_)
522#define lock_map_acquire_read(l) lock_acquire_shared_recursive(l, 0, 0, NULL, _THIS_IP_)
523#define lock_map_acquire_tryread(l) lock_acquire_shared_recursive(l, 0, 1, NULL, _THIS_IP_)
524#define lock_map_release(l) lock_release(l, 1, _THIS_IP_)
525
526#ifdef CONFIG_PROVE_LOCKING
527# define might_lock(lock) \
528do { \
529 typecheck(struct lockdep_map *, &(lock)->dep_map); \
530 lock_acquire(&(lock)->dep_map, 0, 0, 0, 1, NULL, _THIS_IP_); \
531 lock_release(&(lock)->dep_map, 0, _THIS_IP_); \
532} while (0)
533# define might_lock_read(lock) \
534do { \
535 typecheck(struct lockdep_map *, &(lock)->dep_map); \
536 lock_acquire(&(lock)->dep_map, 0, 0, 1, 1, NULL, _THIS_IP_); \
537 lock_release(&(lock)->dep_map, 0, _THIS_IP_); \
538} while (0)
539#else
540# define might_lock(lock) do { } while (0)
541# define might_lock_read(lock) do { } while (0)
542#endif
543
544#ifdef CONFIG_LOCKDEP
545void lockdep_rcu_suspicious(const char *file, const int line, const char *s);
546#else
547static inline void
548lockdep_rcu_suspicious(const char *file, const int line, const char *s)
549{
550}
551#endif
552
553#endif
554