lockdep_internals.h 6.15 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
	LOCK_USAGE_STATES
};

25 26 27 28
#define LOCK_USAGE_READ_MASK 1
#define LOCK_USAGE_DIR_MASK  2
#define LOCK_USAGE_STATE_MASK (~(LOCK_USAGE_READ_MASK | LOCK_USAGE_DIR_MASK))

29 30 31
/*
 * Usage-state bitmasks:
 */
32 33 34 35 36 37 38 39 40 41 42 43
#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)
};
44

45 46 47 48 49 50 51 52 53 54 55
#define LOCKDEP_STATE(__STATE)	LOCKF_ENABLED_##__STATE |
static const unsigned long LOCKF_ENABLED_IRQ =
#include "lockdep_states.h"
	0;
#undef LOCKDEP_STATE

#define LOCKDEP_STATE(__STATE)	LOCKF_USED_IN_##__STATE |
static const unsigned long LOCKF_USED_IN_IRQ =
#include "lockdep_states.h"
	0;
#undef LOCKDEP_STATE
56

57 58 59 60 61 62 63 64 65 66 67
#define LOCKDEP_STATE(__STATE)	LOCKF_ENABLED_##__STATE##_READ |
static const unsigned long LOCKF_ENABLED_IRQ_READ =
#include "lockdep_states.h"
	0;
#undef LOCKDEP_STATE

#define LOCKDEP_STATE(__STATE)	LOCKF_USED_IN_##__STATE##_READ |
static const unsigned long LOCKF_USED_IN_IRQ_READ =
#include "lockdep_states.h"
	0;
#undef LOCKDEP_STATE
68

69
/*
70
 * CONFIG_LOCKDEP_SMALL is defined for sparc. Sparc requires .text,
71
 * .data and .bss to fit in required 32MB limit for the kernel. With
72
 * CONFIG_LOCKDEP we could go over this limit and cause system boot-up problems.
73 74 75
 * So, reduce the static allocations for lockdeps related structures so that
 * everything fits in current required size limit.
 */
76
#ifdef CONFIG_LOCKDEP_SMALL
Ingo Molnar's avatar
Ingo Molnar committed
77 78 79 80 81 82 83 84 85
/*
 * 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.
 */
86 87 88 89
#define MAX_LOCKDEP_ENTRIES	16384UL
#define MAX_LOCKDEP_CHAINS_BITS	15
#define MAX_STACK_TRACE_ENTRIES	262144UL
#else
90
#define MAX_LOCKDEP_ENTRIES	32768UL
Ingo Molnar's avatar
Ingo Molnar committed
91

92
#define MAX_LOCKDEP_CHAINS_BITS	16
93

Ingo Molnar's avatar
Ingo Molnar committed
94 95 96 97
/*
 * Stack-trace: tightly packed array of stack backtrace
 * addresses. Protected by the hash_lock.
 */
98
#define MAX_STACK_TRACE_ENTRIES	524288UL
99 100 101 102 103
#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
104 105

extern struct list_head all_lock_classes;
106
extern struct lock_chain lock_chains[];
Ingo Molnar's avatar
Ingo Molnar committed
107

108 109 110 111
#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
112 113 114

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

115 116
struct lock_class *lock_chain_get_class(struct lock_chain *chain, int i);

Ingo Molnar's avatar
Ingo Molnar committed
117 118
extern unsigned long nr_lock_classes;
extern unsigned long nr_list_entries;
119 120
long lockdep_next_lockchain(long i);
unsigned long lock_chain_count(void);
121
extern int nr_chain_hlocks;
Ingo Molnar's avatar
Ingo Molnar committed
122 123 124 125 126 127 128 129
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
130 131
extern unsigned int max_bfs_queue_depth;

Ingo Molnar's avatar
Ingo Molnar committed
132
#ifdef CONFIG_PROVE_LOCKING
133 134
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
135 136 137 138 139 140 141 142 143 144 145 146
#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
147

Ingo Molnar's avatar
Ingo Molnar committed
148
#ifdef CONFIG_DEBUG_LOCKDEP
149 150

#include <asm/local.h>
Ingo Molnar's avatar
Ingo Molnar committed
151
/*
152 153 154
 * 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
155
 */
156 157 158 159 160 161 162 163 164 165 166 167
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;
168 169
	int	nr_redundant_checks;
	int	nr_redundant;
170 171 172 173 174 175
	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;
176 177 178 179 180

	/*
	 * Per lock class locking operation stat counts
	 */
	unsigned long lock_class_ops[MAX_LOCKDEP_KEYS];
181 182 183
};

DECLARE_PER_CPU(struct lockdep_stats, lockdep_stats);
184
extern struct lock_class lock_classes[MAX_LOCKDEP_KEYS];
185

186 187 188
#define __debug_atomic_inc(ptr)					\
	this_cpu_inc(lockdep_stats.ptr);

189 190
#define debug_atomic_inc(ptr)			{		\
	WARN_ON_ONCE(!irqs_disabled());				\
191
	__this_cpu_inc(lockdep_stats.ptr);			\
192 193 194 195
}

#define debug_atomic_dec(ptr)			{		\
	WARN_ON_ONCE(!irqs_disabled());				\
196
	__this_cpu_dec(lockdep_stats.ptr);			\
197 198 199 200 201 202 203 204 205 206 207 208
}

#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;							\
})
209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228

static inline void debug_class_ops_inc(struct lock_class *class)
{
	int idx;

	idx = class - lock_classes;
	__debug_atomic_inc(lock_class_ops[idx]);
}

static inline unsigned long debug_class_ops_read(struct lock_class *class)
{
	int idx, cpu;
	unsigned long ops = 0;

	idx = class - lock_classes;
	for_each_possible_cpu(cpu)
		ops += per_cpu(lockdep_stats.lock_class_ops[idx], cpu);
	return ops;
}

Ingo Molnar's avatar
Ingo Molnar committed
229
#else
230
# define __debug_atomic_inc(ptr)	do { } while (0)
Ingo Molnar's avatar
Ingo Molnar committed
231 232 233
# define debug_atomic_inc(ptr)		do { } while (0)
# define debug_atomic_dec(ptr)		do { } while (0)
# define debug_atomic_read(ptr)		0
234
# define debug_class_ops_inc(ptr)	do { } while (0)
Ingo Molnar's avatar
Ingo Molnar committed
235
#endif