lockdep: move state bit definitions around
[linux-3.10.git] / kernel / lockdep_internals.h
1 /*
2  * kernel/lockdep_internals.h
3  *
4  * Runtime locking correctness validator
5  *
6  * lockdep subsystem internal functions and variables.
7  */
8
9 /*
10  * Lock-class usage-state bits:
11  */
12 enum lock_usage_bit {
13         LOCK_USED = 0,
14         LOCK_USED_IN_HARDIRQ,
15         LOCK_USED_IN_SOFTIRQ,
16         LOCK_USED_IN_RECLAIM_FS,
17         LOCK_ENABLED_SOFTIRQ,
18         LOCK_ENABLED_HARDIRQ,
19         LOCK_ENABLED_RECLAIM_FS,
20         LOCK_USED_IN_HARDIRQ_READ,
21         LOCK_USED_IN_SOFTIRQ_READ,
22         LOCK_USED_IN_RECLAIM_FS_READ,
23         LOCK_ENABLED_SOFTIRQ_READ,
24         LOCK_ENABLED_HARDIRQ_READ,
25         LOCK_ENABLED_RECLAIM_FS_READ,
26         LOCK_USAGE_STATES
27 };
28
29 /*
30  * Usage-state bitmasks:
31  */
32 #define LOCKF_USED                      (1 << LOCK_USED)
33 #define LOCKF_USED_IN_HARDIRQ           (1 << LOCK_USED_IN_HARDIRQ)
34 #define LOCKF_USED_IN_SOFTIRQ           (1 << LOCK_USED_IN_SOFTIRQ)
35 #define LOCKF_USED_IN_RECLAIM_FS        (1 << LOCK_USED_IN_RECLAIM_FS)
36 #define LOCKF_ENABLED_HARDIRQ           (1 << LOCK_ENABLED_HARDIRQ)
37 #define LOCKF_ENABLED_SOFTIRQ           (1 << LOCK_ENABLED_SOFTIRQ)
38 #define LOCKF_ENABLED_RECLAIM_FS        (1 << LOCK_ENABLED_RECLAIM_FS)
39
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
43 #define LOCKF_USED_IN_HARDIRQ_READ      (1 << LOCK_USED_IN_HARDIRQ_READ)
44 #define LOCKF_USED_IN_SOFTIRQ_READ      (1 << LOCK_USED_IN_SOFTIRQ_READ)
45 #define LOCKF_USED_IN_RECLAIM_FS_READ   (1 << LOCK_USED_IN_RECLAIM_FS_READ)
46 #define LOCKF_ENABLED_HARDIRQ_READ      (1 << LOCK_ENABLED_HARDIRQ_READ)
47 #define LOCKF_ENABLED_SOFTIRQ_READ      (1 << LOCK_ENABLED_SOFTIRQ_READ)
48 #define LOCKF_ENABLED_RECLAIM_FS_READ   (1 << LOCK_ENABLED_RECLAIM_FS_READ)
49
50 #define LOCKF_ENABLED_IRQ_READ \
51                 (LOCKF_ENABLED_HARDIRQ_READ | LOCKF_ENABLED_SOFTIRQ_READ)
52 #define LOCKF_USED_IN_IRQ_READ \
53                 (LOCKF_USED_IN_HARDIRQ_READ | LOCKF_USED_IN_SOFTIRQ_READ)
54
55 /*
56  * MAX_LOCKDEP_ENTRIES is the maximum number of lock dependencies
57  * we track.
58  *
59  * We use the per-lock dependency maps in two ways: we grow it by adding
60  * every to-be-taken lock to all currently held lock's own dependency
61  * table (if it's not there yet), and we check it for lock order
62  * conflicts and deadlocks.
63  */
64 #define MAX_LOCKDEP_ENTRIES     8192UL
65
66 #define MAX_LOCKDEP_CHAINS_BITS 14
67 #define MAX_LOCKDEP_CHAINS      (1UL << MAX_LOCKDEP_CHAINS_BITS)
68
69 #define MAX_LOCKDEP_CHAIN_HLOCKS (MAX_LOCKDEP_CHAINS*5)
70
71 /*
72  * Stack-trace: tightly packed array of stack backtrace
73  * addresses. Protected by the hash_lock.
74  */
75 #define MAX_STACK_TRACE_ENTRIES 262144UL
76
77 extern struct list_head all_lock_classes;
78 extern struct lock_chain lock_chains[];
79
80 extern void
81 get_usage_chars(struct lock_class *class, char *c1, char *c2, char *c3,
82                                         char *c4, char *c5, char *c6);
83
84 extern const char * __get_key_name(struct lockdep_subclass_key *key, char *str);
85
86 struct lock_class *lock_chain_get_class(struct lock_chain *chain, int i);
87
88 extern unsigned long nr_lock_classes;
89 extern unsigned long nr_list_entries;
90 extern unsigned long nr_lock_chains;
91 extern int nr_chain_hlocks;
92 extern unsigned long nr_stack_trace_entries;
93
94 extern unsigned int nr_hardirq_chains;
95 extern unsigned int nr_softirq_chains;
96 extern unsigned int nr_process_chains;
97 extern unsigned int max_lockdep_depth;
98 extern unsigned int max_recursion_depth;
99
100 #ifdef CONFIG_PROVE_LOCKING
101 extern unsigned long lockdep_count_forward_deps(struct lock_class *);
102 extern unsigned long lockdep_count_backward_deps(struct lock_class *);
103 #else
104 static inline unsigned long
105 lockdep_count_forward_deps(struct lock_class *class)
106 {
107         return 0;
108 }
109 static inline unsigned long
110 lockdep_count_backward_deps(struct lock_class *class)
111 {
112         return 0;
113 }
114 #endif
115
116 #ifdef CONFIG_DEBUG_LOCKDEP
117 /*
118  * Various lockdep statistics:
119  */
120 extern atomic_t chain_lookup_hits;
121 extern atomic_t chain_lookup_misses;
122 extern atomic_t hardirqs_on_events;
123 extern atomic_t hardirqs_off_events;
124 extern atomic_t redundant_hardirqs_on;
125 extern atomic_t redundant_hardirqs_off;
126 extern atomic_t softirqs_on_events;
127 extern atomic_t softirqs_off_events;
128 extern atomic_t redundant_softirqs_on;
129 extern atomic_t redundant_softirqs_off;
130 extern atomic_t nr_unused_locks;
131 extern atomic_t nr_cyclic_checks;
132 extern atomic_t nr_cyclic_check_recursions;
133 extern atomic_t nr_find_usage_forwards_checks;
134 extern atomic_t nr_find_usage_forwards_recursions;
135 extern atomic_t nr_find_usage_backwards_checks;
136 extern atomic_t nr_find_usage_backwards_recursions;
137 # define debug_atomic_inc(ptr)          atomic_inc(ptr)
138 # define debug_atomic_dec(ptr)          atomic_dec(ptr)
139 # define debug_atomic_read(ptr)         atomic_read(ptr)
140 #else
141 # define debug_atomic_inc(ptr)          do { } while (0)
142 # define debug_atomic_dec(ptr)          do { } while (0)
143 # define debug_atomic_read(ptr)         0
144 #endif