blob: a2cc7e9a6e841b9e955709b9139cd96b3d803f2e [file] [log] [blame]
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07001/*
2 * kernel/lockdep_internals.h
3 *
4 * Runtime locking correctness validator
5 *
6 * lockdep subsystem internal functions and variables.
7 */
8
9/*
Peter Zijlstra98516732009-01-22 14:18:40 +010010 * Lock-class usage-state bits:
11 */
12enum lock_usage_bit {
Peter Zijlstrad7b1b022009-01-22 14:38:38 +010013#define LOCKDEP_STATE(__STATE) \
14 LOCK_USED_IN_##__STATE, \
15 LOCK_USED_IN_##__STATE##_READ, \
16 LOCK_ENABLED_##__STATE, \
17 LOCK_ENABLED_##__STATE##_READ,
18#include "lockdep_states.h"
19#undef LOCKDEP_STATE
20 LOCK_USED,
Peter Zijlstra98516732009-01-22 14:18:40 +010021 LOCK_USAGE_STATES
22};
23
24/*
25 * Usage-state bitmasks:
26 */
Peter Zijlstrad7b1b022009-01-22 14:38:38 +010027#define __LOCKF(__STATE) LOCKF_##__STATE = (1 << LOCK_##__STATE),
28
29enum {
30#define LOCKDEP_STATE(__STATE) \
31 __LOCKF(USED_IN_##__STATE) \
32 __LOCKF(USED_IN_##__STATE##_READ) \
33 __LOCKF(ENABLED_##__STATE) \
34 __LOCKF(ENABLED_##__STATE##_READ)
35#include "lockdep_states.h"
36#undef LOCKDEP_STATE
37 __LOCKF(USED)
38};
Peter Zijlstra98516732009-01-22 14:18:40 +010039
40#define LOCKF_ENABLED_IRQ (LOCKF_ENABLED_HARDIRQ | LOCKF_ENABLED_SOFTIRQ)
41#define LOCKF_USED_IN_IRQ (LOCKF_USED_IN_HARDIRQ | LOCKF_USED_IN_SOFTIRQ)
42
Peter Zijlstra98516732009-01-22 14:18:40 +010043#define LOCKF_ENABLED_IRQ_READ \
44 (LOCKF_ENABLED_HARDIRQ_READ | LOCKF_ENABLED_SOFTIRQ_READ)
45#define LOCKF_USED_IN_IRQ_READ \
46 (LOCKF_USED_IN_HARDIRQ_READ | LOCKF_USED_IN_SOFTIRQ_READ)
47
48/*
Ingo Molnarfbb9ce952006-07-03 00:24:50 -070049 * MAX_LOCKDEP_ENTRIES is the maximum number of lock dependencies
50 * we track.
51 *
52 * We use the per-lock dependency maps in two ways: we grow it by adding
53 * every to-be-taken lock to all currently held lock's own dependency
54 * table (if it's not there yet), and we check it for lock order
55 * conflicts and deadlocks.
56 */
57#define MAX_LOCKDEP_ENTRIES 8192UL
58
Ingo Molnar50cc6702006-12-06 20:39:30 -080059#define MAX_LOCKDEP_CHAINS_BITS 14
Ingo Molnarfbb9ce952006-07-03 00:24:50 -070060#define MAX_LOCKDEP_CHAINS (1UL << MAX_LOCKDEP_CHAINS_BITS)
61
Huang, Ying443cd502008-06-20 16:39:21 +080062#define MAX_LOCKDEP_CHAIN_HLOCKS (MAX_LOCKDEP_CHAINS*5)
63
Ingo Molnarfbb9ce952006-07-03 00:24:50 -070064/*
65 * Stack-trace: tightly packed array of stack backtrace
66 * addresses. Protected by the hash_lock.
67 */
Ingo Molnar9bb25bf2006-09-12 20:35:50 -070068#define MAX_STACK_TRACE_ENTRIES 262144UL
Ingo Molnarfbb9ce952006-07-03 00:24:50 -070069
70extern struct list_head all_lock_classes;
Huang, Ying443cd502008-06-20 16:39:21 +080071extern struct lock_chain lock_chains[];
Ingo Molnarfbb9ce952006-07-03 00:24:50 -070072
Peter Zijlstraf510b232009-01-22 17:53:47 +010073#define LOCK_USAGE_CHARS (1+LOCK_USAGE_STATES/2)
74
75extern void get_usage_chars(struct lock_class *class,
76 char usage[LOCK_USAGE_CHARS]);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -070077
78extern const char * __get_key_name(struct lockdep_subclass_key *key, char *str);
79
Huang, Ying443cd502008-06-20 16:39:21 +080080struct lock_class *lock_chain_get_class(struct lock_chain *chain, int i);
81
Ingo Molnarfbb9ce952006-07-03 00:24:50 -070082extern unsigned long nr_lock_classes;
83extern unsigned long nr_list_entries;
84extern unsigned long nr_lock_chains;
Huang, Yingcd1a28e2008-06-23 11:20:54 +080085extern int nr_chain_hlocks;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -070086extern unsigned long nr_stack_trace_entries;
87
88extern unsigned int nr_hardirq_chains;
89extern unsigned int nr_softirq_chains;
90extern unsigned int nr_process_chains;
91extern unsigned int max_lockdep_depth;
92extern unsigned int max_recursion_depth;
93
Ingo Molnard6672c52008-08-01 11:23:50 +020094#ifdef CONFIG_PROVE_LOCKING
David Miller419ca3f2008-07-29 21:45:03 -070095extern unsigned long lockdep_count_forward_deps(struct lock_class *);
96extern unsigned long lockdep_count_backward_deps(struct lock_class *);
Ingo Molnard6672c52008-08-01 11:23:50 +020097#else
98static inline unsigned long
99lockdep_count_forward_deps(struct lock_class *class)
100{
101 return 0;
102}
103static inline unsigned long
104lockdep_count_backward_deps(struct lock_class *class)
105{
106 return 0;
107}
108#endif
David Miller419ca3f2008-07-29 21:45:03 -0700109
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700110#ifdef CONFIG_DEBUG_LOCKDEP
111/*
112 * Various lockdep statistics:
113 */
114extern atomic_t chain_lookup_hits;
115extern atomic_t chain_lookup_misses;
116extern atomic_t hardirqs_on_events;
117extern atomic_t hardirqs_off_events;
118extern atomic_t redundant_hardirqs_on;
119extern atomic_t redundant_hardirqs_off;
120extern atomic_t softirqs_on_events;
121extern atomic_t softirqs_off_events;
122extern atomic_t redundant_softirqs_on;
123extern atomic_t redundant_softirqs_off;
124extern atomic_t nr_unused_locks;
125extern atomic_t nr_cyclic_checks;
126extern atomic_t nr_cyclic_check_recursions;
127extern atomic_t nr_find_usage_forwards_checks;
128extern atomic_t nr_find_usage_forwards_recursions;
129extern atomic_t nr_find_usage_backwards_checks;
130extern atomic_t nr_find_usage_backwards_recursions;
131# define debug_atomic_inc(ptr) atomic_inc(ptr)
132# define debug_atomic_dec(ptr) atomic_dec(ptr)
133# define debug_atomic_read(ptr) atomic_read(ptr)
134#else
135# define debug_atomic_inc(ptr) do { } while (0)
136# define debug_atomic_dec(ptr) do { } while (0)
137# define debug_atomic_read(ptr) 0
138#endif