lockdep_internals.h 5.1 KB
Newer Older
1
/* SPDX-License-Identifier: GPL-2.0 */
Ingo Molnar's avatar
Ingo Molnar committed
2
3
4
5
6
7
8
9
/*
 * kernel/lockdep_internals.h
 *
 * Runtime locking correctness validator
 *
 * lockdep subsystem internal functions and variables.
 */

10
11
12
13
/*
 * Lock-class usage-state bits:
 */
enum lock_usage_bit {
14
15
16
17
18
19
20
21
#define LOCKDEP_STATE(__STATE)		\
	LOCK_USED_IN_##__STATE,		\
	LOCK_USED_IN_##__STATE##_READ,	\
	LOCK_ENABLED_##__STATE,		\
	LOCK_ENABLED_##__STATE##_READ,
#include "lockdep_states.h"
#undef LOCKDEP_STATE
	LOCK_USED,
22
23
24
25
26
27
	LOCK_USAGE_STATES
};

/*
 * Usage-state bitmasks:
 */
28
29
30
31
32
33
34
35
36
37
38
39
#define __LOCKF(__STATE)	LOCKF_##__STATE = (1 << LOCK_##__STATE),

enum {
#define LOCKDEP_STATE(__STATE)						\
	__LOCKF(USED_IN_##__STATE)					\
	__LOCKF(USED_IN_##__STATE##_READ)				\
	__LOCKF(ENABLED_##__STATE)					\
	__LOCKF(ENABLED_##__STATE##_READ)
#include "lockdep_states.h"
#undef LOCKDEP_STATE
	__LOCKF(USED)
};
40
41
42
43
44
45
46
47
48

#define LOCKF_ENABLED_IRQ (LOCKF_ENABLED_HARDIRQ | LOCKF_ENABLED_SOFTIRQ)
#define LOCKF_USED_IN_IRQ (LOCKF_USED_IN_HARDIRQ | LOCKF_USED_IN_SOFTIRQ)

#define LOCKF_ENABLED_IRQ_READ \
		(LOCKF_ENABLED_HARDIRQ_READ | LOCKF_ENABLED_SOFTIRQ_READ)
#define LOCKF_USED_IN_IRQ_READ \
		(LOCKF_USED_IN_HARDIRQ_READ | LOCKF_USED_IN_SOFTIRQ_READ)

49
/*
50
 * CONFIG_LOCKDEP_SMALL is defined for sparc. Sparc requires .text,
51
 * .data and .bss to fit in required 32MB limit for the kernel. With
52
 * CONFIG_LOCKDEP we could go over this limit and cause system boot-up problems.
53
54
55
 * So, reduce the static allocations for lockdeps related structures so that
 * everything fits in current required size limit.
 */
56
#ifdef CONFIG_LOCKDEP_SMALL
Ingo Molnar's avatar
Ingo Molnar committed
57
58
59
60
61
62
63
64
65
/*
 * MAX_LOCKDEP_ENTRIES is the maximum number of lock dependencies
 * we track.
 *
 * We use the per-lock dependency maps in two ways: we grow it by adding
 * every to-be-taken lock to all currently held lock's own dependency
 * table (if it's not there yet), and we check it for lock order
 * conflicts and deadlocks.
 */
66
67
68
69
#define MAX_LOCKDEP_ENTRIES	16384UL
#define MAX_LOCKDEP_CHAINS_BITS	15
#define MAX_STACK_TRACE_ENTRIES	262144UL
#else
70
#define MAX_LOCKDEP_ENTRIES	32768UL
Ingo Molnar's avatar
Ingo Molnar committed
71

72
#define MAX_LOCKDEP_CHAINS_BITS	16
73

Ingo Molnar's avatar
Ingo Molnar committed
74
75
76
77
/*
 * Stack-trace: tightly packed array of stack backtrace
 * addresses. Protected by the hash_lock.
 */
78
#define MAX_STACK_TRACE_ENTRIES	524288UL
79
80
81
82
83
#endif

#define MAX_LOCKDEP_CHAINS	(1UL << MAX_LOCKDEP_CHAINS_BITS)

#define MAX_LOCKDEP_CHAIN_HLOCKS (MAX_LOCKDEP_CHAINS*5)
Ingo Molnar's avatar
Ingo Molnar committed
84
85

extern struct list_head all_lock_classes;
86
extern struct lock_chain lock_chains[];
Ingo Molnar's avatar
Ingo Molnar committed
87

88
89
90
91
#define LOCK_USAGE_CHARS (1+LOCK_USAGE_STATES/2)

extern void get_usage_chars(struct lock_class *class,
			    char usage[LOCK_USAGE_CHARS]);
Ingo Molnar's avatar
Ingo Molnar committed
92
93
94

extern const char * __get_key_name(struct lockdep_subclass_key *key, char *str);

95
96
struct lock_class *lock_chain_get_class(struct lock_chain *chain, int i);

Ingo Molnar's avatar
Ingo Molnar committed
97
98
99
extern unsigned long nr_lock_classes;
extern unsigned long nr_list_entries;
extern unsigned long nr_lock_chains;
100
extern int nr_chain_hlocks;
Ingo Molnar's avatar
Ingo Molnar committed
101
102
103
104
105
106
107
108
extern unsigned long nr_stack_trace_entries;

extern unsigned int nr_hardirq_chains;
extern unsigned int nr_softirq_chains;
extern unsigned int nr_process_chains;
extern unsigned int max_lockdep_depth;
extern unsigned int max_recursion_depth;

Peter Zijlstra's avatar
Peter Zijlstra committed
109
110
extern unsigned int max_bfs_queue_depth;

Ingo Molnar's avatar
Ingo Molnar committed
111
#ifdef CONFIG_PROVE_LOCKING
112
113
extern unsigned long lockdep_count_forward_deps(struct lock_class *);
extern unsigned long lockdep_count_backward_deps(struct lock_class *);
Ingo Molnar's avatar
Ingo Molnar committed
114
115
116
117
118
119
120
121
122
123
124
125
#else
static inline unsigned long
lockdep_count_forward_deps(struct lock_class *class)
{
	return 0;
}
static inline unsigned long
lockdep_count_backward_deps(struct lock_class *class)
{
	return 0;
}
#endif
126

Ingo Molnar's avatar
Ingo Molnar committed
127
#ifdef CONFIG_DEBUG_LOCKDEP
128
129

#include <asm/local.h>
Ingo Molnar's avatar
Ingo Molnar committed
130
/*
131
132
133
 * Various lockdep statistics.
 * We want them per cpu as they are often accessed in fast path
 * and we want to avoid too much cache bouncing.
Ingo Molnar's avatar
Ingo Molnar committed
134
 */
135
136
137
138
139
140
141
142
143
144
145
146
struct lockdep_stats {
	int	chain_lookup_hits;
	int	chain_lookup_misses;
	int	hardirqs_on_events;
	int	hardirqs_off_events;
	int	redundant_hardirqs_on;
	int	redundant_hardirqs_off;
	int	softirqs_on_events;
	int	softirqs_off_events;
	int	redundant_softirqs_on;
	int	redundant_softirqs_off;
	int	nr_unused_locks;
147
148
	int	nr_redundant_checks;
	int	nr_redundant;
149
150
151
152
153
154
155
156
157
158
	int	nr_cyclic_checks;
	int	nr_cyclic_check_recursions;
	int	nr_find_usage_forwards_checks;
	int	nr_find_usage_forwards_recursions;
	int	nr_find_usage_backwards_checks;
	int	nr_find_usage_backwards_recursions;
};

DECLARE_PER_CPU(struct lockdep_stats, lockdep_stats);

159
160
161
#define __debug_atomic_inc(ptr)					\
	this_cpu_inc(lockdep_stats.ptr);

162
#define debug_atomic_inc(ptr)			{		\
163
	WARN_ON_ONCE(!hard_irqs_disabled() && !irqs_disabled()); \
164
	__this_cpu_inc(lockdep_stats.ptr);			\
165
166
167
}

#define debug_atomic_dec(ptr)			{		\
168
	WARN_ON_ONCE(!hard_irqs_disabled() && !irqs_disabled());\
169
	__this_cpu_dec(lockdep_stats.ptr);			\
170
171
172
173
174
175
176
177
178
179
180
181
}

#define debug_atomic_read(ptr)		({				\
	struct lockdep_stats *__cpu_lockdep_stats;			\
	unsigned long long __total = 0;					\
	int __cpu;							\
	for_each_possible_cpu(__cpu) {					\
		__cpu_lockdep_stats = &per_cpu(lockdep_stats, __cpu);	\
		__total += __cpu_lockdep_stats->ptr;			\
	}								\
	__total;							\
})
Ingo Molnar's avatar
Ingo Molnar committed
182
#else
183
# define __debug_atomic_inc(ptr)	do { } while (0)
Ingo Molnar's avatar
Ingo Molnar committed
184
185
186
187
# define debug_atomic_inc(ptr)		do { } while (0)
# define debug_atomic_dec(ptr)		do { } while (0)
# define debug_atomic_read(ptr)		0
#endif