blob: 651cc61af0413d42564ccedd50aed4cf2d2f1793 [file] [log] [blame]
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07001/*
2 * Runtime locking correctness validator
3 *
Peter Zijlstra4b32d0a2007-07-19 01:48:59 -07004 * Copyright (C) 2006,2007 Red Hat, Inc., Ingo Molnar <mingo@redhat.com>
Peter Zijlstra90eec102015-11-16 11:08:45 +01005 * Copyright (C) 2007 Red Hat, Inc., Peter Zijlstra
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07006 *
Davidlohr Bueso214e0ae2014-07-30 13:41:55 -07007 * see Documentation/locking/lockdep-design.txt for more details.
Ingo Molnarfbb9ce952006-07-03 00:24:50 -07008 */
9#ifndef __LINUX_LOCKDEP_H
10#define __LINUX_LOCKDEP_H
11
Heiko Carstensa1e96b02007-02-12 00:52:20 -080012struct task_struct;
Peter Zijlstraf20786f2007-07-19 01:48:56 -070013struct lockdep_map;
Heiko Carstensa1e96b02007-02-12 00:52:20 -080014
Dave Young2edf5e42010-03-10 15:24:10 -080015/* for sysctl */
16extern int prove_locking;
17extern int lock_stat;
18
Bartosz Golaszewskia5ecddf2016-09-16 18:02:43 +020019#define MAX_LOCKDEP_SUBCLASSES 8UL
20
Michael S. Tsirkindb0b0ea2006-09-29 01:59:28 -070021#ifdef CONFIG_LOCKDEP
22
Ingo Molnarfbb9ce952006-07-03 00:24:50 -070023#include <linux/linkage.h>
24#include <linux/list.h>
25#include <linux/debug_locks.h>
26#include <linux/stacktrace.h>
27
Ingo Molnarfbb9ce952006-07-03 00:24:50 -070028/*
Peter Zijlstra98516732009-01-22 14:18:40 +010029 * We'd rather not expose kernel/lockdep_states.h this wide, but we do need
30 * the total number of states... :-(
Ingo Molnarfbb9ce952006-07-03 00:24:50 -070031 */
Peter Zijlstrad92a8cf2017-03-03 10:13:38 +010032#define XXX_LOCK_USAGE_STATES (1+2*4)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -070033
Ingo Molnarfbb9ce952006-07-03 00:24:50 -070034/*
Hitoshi Mitake62016252010-10-05 18:01:51 +090035 * NR_LOCKDEP_CACHING_CLASSES ... Number of classes
36 * cached in the instance of lockdep_map
37 *
38 * Currently main class (subclass == 0) and signle depth subclass
39 * are cached in lockdep_map. This optimization is mainly targeting
40 * on rq->lock. double_rq_lock() acquires this highly competitive with
41 * single depth.
42 */
43#define NR_LOCKDEP_CACHING_CLASSES 2
44
45/*
Ingo Molnarfbb9ce952006-07-03 00:24:50 -070046 * Lock-classes are keyed via unique addresses, by embedding the
47 * lockclass-key into the kernel (or module) .data section. (For
48 * static locks we use the lock address itself as the key.)
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
Peter Zijlstra1704f472010-03-19 01:37:42 +010058extern struct lock_class_key __lockdep_no_validate__;
59
Peter Zijlstrac7e78cf2008-10-16 23:17:09 +020060#define LOCKSTAT_POINTS 4
61
Ingo Molnarfbb9ce952006-07-03 00:24:50 -070062/*
63 * The lock-class itself:
64 */
65struct lock_class {
66 /*
67 * class-hash:
68 */
Andrew Mortona63f38c2016-02-03 13:44:12 -080069 struct hlist_node hash_entry;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -070070
71 /*
72 * global list of all lock-classes:
73 */
74 struct list_head lock_entry;
75
76 struct lockdep_subclass_key *key;
77 unsigned int subclass;
Ming Leie351b662009-07-22 22:48:09 +080078 unsigned int dep_gen_id;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -070079
80 /*
81 * IRQ/softirq usage tracking bits:
82 */
83 unsigned long usage_mask;
Peter Zijlstra98516732009-01-22 14:18:40 +010084 struct stack_trace usage_traces[XXX_LOCK_USAGE_STATES];
Ingo Molnarfbb9ce952006-07-03 00:24:50 -070085
86 /*
87 * These fields represent a directed graph of lock dependencies,
88 * to every node we attach a list of "forward" and a list of
89 * "backward" graph nodes.
90 */
91 struct list_head locks_after, locks_before;
92
93 /*
94 * Generation counter, when doing certain classes of graph walking,
95 * to ensure that we check one node only once:
96 */
97 unsigned int version;
98
99 /*
100 * Statistics counter:
101 */
102 unsigned long ops;
103
104 const char *name;
105 int name_version;
Peter Zijlstraf20786f2007-07-19 01:48:56 -0700106
107#ifdef CONFIG_LOCK_STAT
Peter Zijlstrac7e78cf2008-10-16 23:17:09 +0200108 unsigned long contention_point[LOCKSTAT_POINTS];
109 unsigned long contending_point[LOCKSTAT_POINTS];
Peter Zijlstraf20786f2007-07-19 01:48:56 -0700110#endif
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700111};
112
Peter Zijlstraf20786f2007-07-19 01:48:56 -0700113#ifdef CONFIG_LOCK_STAT
114struct lock_time {
115 s64 min;
116 s64 max;
117 s64 total;
118 unsigned long nr;
119};
120
Peter Zijlstra96645672007-07-19 01:49:00 -0700121enum 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
Peter Zijlstraf20786f2007-07-19 01:48:56 -0700132struct lock_class_stats {
George Beshers68722102015-06-18 10:25:13 -0500133 unsigned long contention_point[LOCKSTAT_POINTS];
134 unsigned long contending_point[LOCKSTAT_POINTS];
Peter Zijlstraf20786f2007-07-19 01:48:56 -0700135 struct lock_time read_waittime;
136 struct lock_time write_waittime;
137 struct lock_time read_holdtime;
138 struct lock_time write_holdtime;
Peter Zijlstra96645672007-07-19 01:49:00 -0700139 unsigned long bounces[nr_bounce_types];
Peter Zijlstraf20786f2007-07-19 01:48:56 -0700140};
141
142struct lock_class_stats lock_stats(struct lock_class *class);
143void clear_lock_stats(struct lock_class *class);
144#endif
145
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700146/*
147 * Map the lock object (the lock instance) to the lock-class object.
148 * This is embedded into specific lock instances:
149 */
150struct lockdep_map {
151 struct lock_class_key *key;
Hitoshi Mitake62016252010-10-05 18:01:51 +0900152 struct lock_class *class_cache[NR_LOCKDEP_CACHING_CLASSES];
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700153 const char *name;
Peter Zijlstra96645672007-07-19 01:49:00 -0700154#ifdef CONFIG_LOCK_STAT
155 int cpu;
Peter Zijlstrac7e78cf2008-10-16 23:17:09 +0200156 unsigned long ip;
Peter Zijlstra96645672007-07-19 01:49:00 -0700157#endif
Byungchul Parkb09be672017-08-07 16:12:52 +0900158#ifdef CONFIG_LOCKDEP_CROSSRELEASE
159 /*
160 * Whether it's a crosslock.
161 */
162 int cross;
163#endif
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700164};
165
Peter Zijlstra4d82a1d2012-05-15 08:06:19 -0700166static inline void lockdep_copy_map(struct lockdep_map *to,
167 struct lockdep_map *from)
168{
169 int i;
170
171 *to = *from;
172 /*
173 * Since the class cache can be modified concurrently we could observe
174 * half pointers (64bit arch using 32bit copy insns). Therefore clear
175 * the caches and take the performance hit.
176 *
177 * XXX it doesn't work well with lockdep_set_class_and_subclass(), since
178 * that relies on cache abuse.
179 */
180 for (i = 0; i < NR_LOCKDEP_CACHING_CLASSES; i++)
181 to->class_cache[i] = NULL;
182}
183
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700184/*
185 * Every lock has a list of other locks that were taken after it.
186 * We only grow the list, never remove from it:
187 */
188struct lock_list {
189 struct list_head entry;
190 struct lock_class *class;
191 struct stack_trace trace;
Jason Baron068135e2007-02-10 01:44:59 -0800192 int distance;
Ming Leic94aa5c2009-07-16 15:44:29 +0200193
Peter Zijlstraaf012962009-07-16 15:44:29 +0200194 /*
195 * The parent field is used to implement breadth-first search, and the
196 * bit 0 is reused to indicate if the lock has been accessed in BFS.
Ming Leic94aa5c2009-07-16 15:44:29 +0200197 */
198 struct lock_list *parent;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700199};
200
201/*
202 * We record lock dependency chains, so that we can cache them:
203 */
204struct lock_chain {
Peter Zijlstra75dd6022016-03-30 11:36:59 +0200205 /* see BUILD_BUG_ON()s in lookup_chain_cache() */
206 unsigned int irq_context : 2,
207 depth : 6,
208 base : 24;
209 /* 4 byte hole */
Andrew Mortona63f38c2016-02-03 13:44:12 -0800210 struct hlist_node entry;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700211 u64 chain_key;
212};
213
Ingo Molnare5f363e32008-08-11 12:37:27 +0200214#define MAX_LOCKDEP_KEYS_BITS 13
Peter Zijlstrab42e7372008-08-11 12:34:42 +0200215/*
216 * Subtract one because we offset hlock->class_idx by 1 in order
217 * to make 0 mean no class. This avoids overflowing the class_idx
218 * bitfield and hitting the BUG in hlock_class().
219 */
220#define MAX_LOCKDEP_KEYS ((1UL << MAX_LOCKDEP_KEYS_BITS) - 1)
Dave Jonesf82b2172008-08-11 09:30:23 +0200221
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700222struct held_lock {
223 /*
224 * One-way hash of the dependency chain up to this point. We
225 * hash the hashes step by step as the dependency chain grows.
226 *
227 * We use it for dependency-caching and we skip detection
228 * passes and dependency-updates if there is a cache-hit, so
229 * it is absolutely critical for 100% coverage of the validator
230 * to have a unique key value for every unique dependency path
231 * that can occur in the system, to make a unique hash value
232 * as likely as possible - hence the 64-bit width.
233 *
234 * The task struct holds the current hash value (initialized
235 * with zero), here we store the previous hash value:
236 */
237 u64 prev_chain_key;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700238 unsigned long acquire_ip;
239 struct lockdep_map *instance;
Peter Zijlstra7531e2f2008-08-11 09:30:24 +0200240 struct lockdep_map *nest_lock;
Peter Zijlstraf20786f2007-07-19 01:48:56 -0700241#ifdef CONFIG_LOCK_STAT
242 u64 waittime_stamp;
243 u64 holdtime_stamp;
244#endif
Dave Jonesf82b2172008-08-11 09:30:23 +0200245 unsigned int class_idx:MAX_LOCKDEP_KEYS_BITS;
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700246 /*
247 * The lock-stack is unified in that the lock chains of interrupt
248 * contexts nest ontop of process context chains, but we 'separate'
249 * the hashes by starting with 0 if we cross into an interrupt
250 * context, and we also keep do not add cross-context lock
251 * dependencies - the lock usage graph walking covers that area
252 * anyway, and we'd just unnecessarily increase the number of
253 * dependencies otherwise. [Note: hardirq and softirq contexts
254 * are separated from each other too.]
255 *
256 * The following field is used to detect when we cross into an
257 * interrupt context:
258 */
Dave Jonesf82b2172008-08-11 09:30:23 +0200259 unsigned int irq_context:2; /* bit 0 - soft, bit 1 - hard */
Peter Zijlstrabb97a912009-07-20 19:15:35 +0200260 unsigned int trylock:1; /* 16 bits */
261
Dave Jonesf82b2172008-08-11 09:30:23 +0200262 unsigned int read:2; /* see lock_acquire() comment */
Oleg Nesterovfb9edbe2014-01-20 19:20:06 +0100263 unsigned int check:1; /* see lock_acquire() comment */
Dave Jonesf82b2172008-08-11 09:30:23 +0200264 unsigned int hardirqs_off:1;
Oleg Nesterovfb9edbe2014-01-20 19:20:06 +0100265 unsigned int references:12; /* 32 bits */
Peter Zijlstraa24fc602015-06-11 14:46:53 +0200266 unsigned int pin_count;
Byungchul Parkb09be672017-08-07 16:12:52 +0900267#ifdef CONFIG_LOCKDEP_CROSSRELEASE
268 /*
269 * Generation id.
270 *
271 * A value of cross_gen_id will be stored when holding this,
272 * which is globally increased whenever each crosslock is held.
273 */
274 unsigned int gen_id;
275#endif
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700276};
277
Byungchul Parkb09be672017-08-07 16:12:52 +0900278#ifdef CONFIG_LOCKDEP_CROSSRELEASE
279#define MAX_XHLOCK_TRACE_ENTRIES 5
280
281/*
282 * This is for keeping locks waiting for commit so that true dependencies
283 * can be added at commit step.
284 */
285struct hist_lock {
286 /*
Byungchul Park23f873d2017-08-07 16:12:53 +0900287 * Id for each entry in the ring buffer. This is used to
288 * decide whether the ring buffer was overwritten or not.
289 *
290 * For example,
291 *
292 * |<----------- hist_lock ring buffer size ------->|
293 * pppppppppppppppppppppiiiiiiiiiiiiiiiiiiiiiiiiiiiii
294 * wrapped > iiiiiiiiiiiiiiiiiiiiiiiiiii.......................
295 *
296 * where 'p' represents an acquisition in process
297 * context, 'i' represents an acquisition in irq
298 * context.
299 *
300 * In this example, the ring buffer was overwritten by
301 * acquisitions in irq context, that should be detected on
302 * rollback or commit.
303 */
304 unsigned int hist_id;
305
306 /*
Byungchul Parkb09be672017-08-07 16:12:52 +0900307 * Seperate stack_trace data. This will be used at commit step.
308 */
309 struct stack_trace trace;
310 unsigned long trace_entries[MAX_XHLOCK_TRACE_ENTRIES];
311
312 /*
313 * Seperate hlock instance. This will be used at commit step.
314 *
315 * TODO: Use a smaller data structure containing only necessary
316 * data. However, we should make lockdep code able to handle the
317 * smaller one first.
318 */
319 struct held_lock hlock;
320};
321
322/*
323 * To initialize a lock as crosslock, lockdep_init_map_crosslock() should
324 * be called instead of lockdep_init_map().
325 */
326struct cross_lock {
327 /*
Byungchul Park28a903f2017-08-07 16:12:54 +0900328 * When more than one acquisition of crosslocks are overlapped,
329 * we have to perform commit for them based on cross_gen_id of
330 * the first acquisition, which allows us to add more true
331 * dependencies.
332 *
333 * Moreover, when no acquisition of a crosslock is in progress,
334 * we should not perform commit because the lock might not exist
335 * any more, which might cause incorrect memory access. So we
336 * have to track the number of acquisitions of a crosslock.
337 */
338 int nr_acquire;
339
340 /*
Byungchul Parkb09be672017-08-07 16:12:52 +0900341 * Seperate hlock instance. This will be used at commit step.
342 *
343 * TODO: Use a smaller data structure containing only necessary
344 * data. However, we should make lockdep code able to handle the
345 * smaller one first.
346 */
347 struct held_lock hlock;
348};
349
350struct lockdep_map_cross {
351 struct lockdep_map map;
352 struct cross_lock xlock;
353};
354#endif
355
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700356/*
357 * Initialization, self-test and debugging-output methods:
358 */
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700359extern void lockdep_info(void);
360extern void lockdep_reset(void);
361extern void lockdep_reset_lock(struct lockdep_map *lock);
362extern void lockdep_free_key_range(void *start, unsigned long size);
Andi Kleen63f9a7f2014-02-08 08:52:01 +0100363extern asmlinkage void lockdep_sys_exit(void);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700364
365extern void lockdep_off(void);
366extern void lockdep_on(void);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700367
368/*
369 * These methods are used by specific locking variants (spinlocks,
370 * rwlocks, mutexes and rwsems) to pass init/acquire/release events
371 * to lockdep:
372 */
373
374extern void lockdep_init_map(struct lockdep_map *lock, const char *name,
Peter Zijlstra4dfbb9d2006-10-11 01:45:14 -0400375 struct lock_class_key *key, int subclass);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700376
377/*
378 * Reinitialize a lock key - for cases where there is special locking or
379 * special initialization of locks so that the validator gets the scope
380 * of dependencies wrong: they are either too broad (they need a class-split)
381 * or they are too narrow (they suffer from a false class-split):
382 */
383#define lockdep_set_class(lock, key) \
Peter Zijlstra4dfbb9d2006-10-11 01:45:14 -0400384 lockdep_init_map(&(lock)->dep_map, #key, key, 0)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700385#define lockdep_set_class_and_name(lock, key, name) \
Peter Zijlstra4dfbb9d2006-10-11 01:45:14 -0400386 lockdep_init_map(&(lock)->dep_map, name, key, 0)
387#define lockdep_set_class_and_subclass(lock, key, sub) \
388 lockdep_init_map(&(lock)->dep_map, #key, key, sub)
389#define lockdep_set_subclass(lock, sub) \
390 lockdep_init_map(&(lock)->dep_map, #lock, \
391 (lock)->dep_map.key, sub)
Peter Zijlstra1704f472010-03-19 01:37:42 +0100392
393#define lockdep_set_novalidate_class(lock) \
Oleg Nesterov47be1c12014-01-20 19:20:16 +0100394 lockdep_set_class_and_name(lock, &__lockdep_no_validate__, #lock)
Jan Kara9a7aa122009-06-04 15:26:49 +0200395/*
396 * Compare locking classes
397 */
398#define lockdep_match_class(lock, key) lockdep_match_key(&(lock)->dep_map, key)
399
400static inline int lockdep_match_key(struct lockdep_map *lock,
401 struct lock_class_key *key)
402{
403 return lock->key == key;
404}
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700405
406/*
407 * Acquire a lock.
408 *
409 * Values for "read":
410 *
411 * 0: exclusive (write) acquire
412 * 1: read-acquire (no recursion allowed)
413 * 2: read-acquire with same-instance recursion allowed
414 *
415 * Values for check:
416 *
Oleg Nesterovfb9edbe2014-01-20 19:20:06 +0100417 * 0: simple checks (freeing, held-at-exit-time, etc.)
418 * 1: full validation
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700419 */
420extern void lock_acquire(struct lockdep_map *lock, unsigned int subclass,
Peter Zijlstra7531e2f2008-08-11 09:30:24 +0200421 int trylock, int read, int check,
422 struct lockdep_map *nest_lock, unsigned long ip);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700423
424extern void lock_release(struct lockdep_map *lock, int nested,
425 unsigned long ip);
426
Peter Zijlstraf8319482016-11-30 14:32:25 +1100427/*
428 * Same "read" as for lock_acquire(), except -1 means any.
429 */
430extern int lock_is_held_type(struct lockdep_map *lock, int read);
Peter Zijlstraf607c662009-07-20 19:16:29 +0200431
Peter Zijlstraf8319482016-11-30 14:32:25 +1100432static inline int lock_is_held(struct lockdep_map *lock)
433{
434 return lock_is_held_type(lock, -1);
435}
436
437#define lockdep_is_held(lock) lock_is_held(&(lock)->dep_map)
438#define lockdep_is_held_type(lock, r) lock_is_held_type(&(lock)->dep_map, (r))
Peter Zijlstraf607c662009-07-20 19:16:29 +0200439
Peter Zijlstra00ef9f72008-12-04 09:00:17 +0100440extern void lock_set_class(struct lockdep_map *lock, const char *name,
441 struct lock_class_key *key, unsigned int subclass,
442 unsigned long ip);
443
444static inline void lock_set_subclass(struct lockdep_map *lock,
445 unsigned int subclass, unsigned long ip)
446{
447 lock_set_class(lock, lock->name, lock->key, subclass, ip);
448}
Peter Zijlstra64aa3482008-08-11 09:30:21 +0200449
J. R. Okajima6419c4a2017-02-03 01:38:17 +0900450extern void lock_downgrade(struct lockdep_map *lock, unsigned long ip);
451
Peter Zijlstrae7904a22015-08-01 19:25:08 +0200452struct pin_cookie { unsigned int val; };
453
454#define NIL_COOKIE (struct pin_cookie){ .val = 0U, }
455
456extern struct pin_cookie lock_pin_lock(struct lockdep_map *lock);
457extern void lock_repin_lock(struct lockdep_map *lock, struct pin_cookie);
458extern void lock_unpin_lock(struct lockdep_map *lock, struct pin_cookie);
Peter Zijlstraa24fc602015-06-11 14:46:53 +0200459
Peter Zijlstrad92a8cf2017-03-03 10:13:38 +0100460# define INIT_LOCKDEP .lockdep_recursion = 0,
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700461
Jarek Poplawskie3a55fd2007-03-22 00:11:26 -0800462#define lockdep_depth(tsk) (debug_locks ? (tsk)->lockdep_depth : 0)
Peter Zijlstrad5abe662006-12-06 20:37:26 -0800463
Johannes Bergb1ae3452013-02-21 16:42:47 -0800464#define lockdep_assert_held(l) do { \
465 WARN_ON(debug_locks && !lockdep_is_held(l)); \
466 } while (0)
Peter Zijlstraf607c662009-07-20 19:16:29 +0200467
Peter Zijlstraf8319482016-11-30 14:32:25 +1100468#define lockdep_assert_held_exclusive(l) do { \
469 WARN_ON(debug_locks && !lockdep_is_held_type(l, 0)); \
470 } while (0)
471
472#define lockdep_assert_held_read(l) do { \
473 WARN_ON(debug_locks && !lockdep_is_held_type(l, 1)); \
474 } while (0)
475
Peter Hurley9a371102014-09-10 14:31:39 -0400476#define lockdep_assert_held_once(l) do { \
477 WARN_ON_ONCE(debug_locks && !lockdep_is_held(l)); \
478 } while (0)
479
Peter Zijlstra94d24fc2011-06-07 11:17:30 +0200480#define lockdep_recursing(tsk) ((tsk)->lockdep_recursion)
481
Peter Zijlstrae7904a22015-08-01 19:25:08 +0200482#define lockdep_pin_lock(l) lock_pin_lock(&(l)->dep_map)
483#define lockdep_repin_lock(l,c) lock_repin_lock(&(l)->dep_map, (c))
484#define lockdep_unpin_lock(l,c) lock_unpin_lock(&(l)->dep_map, (c))
Peter Zijlstraa24fc602015-06-11 14:46:53 +0200485
Michel Lespinassea51805e2013-07-08 14:23:49 -0700486#else /* !CONFIG_LOCKDEP */
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700487
488static inline void lockdep_off(void)
489{
490}
491
492static inline void lockdep_on(void)
493{
494}
495
Peter Zijlstra7531e2f2008-08-11 09:30:24 +0200496# define lock_acquire(l, s, t, r, c, n, i) do { } while (0)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700497# define lock_release(l, n, i) do { } while (0)
J. R. Okajima6419c4a2017-02-03 01:38:17 +0900498# define lock_downgrade(l, i) do { } while (0)
Peter Zijlstra00ef9f72008-12-04 09:00:17 +0100499# define lock_set_class(l, n, k, s, i) do { } while (0)
Peter Zijlstra64aa3482008-08-11 09:30:21 +0200500# define lock_set_subclass(l, s, i) do { } while (0)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700501# define lockdep_info() do { } while (0)
Ingo Molnare25cf3d2008-10-17 15:55:07 +0200502# define lockdep_init_map(lock, name, key, sub) \
503 do { (void)(name); (void)(key); } while (0)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700504# define lockdep_set_class(lock, key) do { (void)(key); } while (0)
505# define lockdep_set_class_and_name(lock, key, name) \
Ingo Molnare25cf3d2008-10-17 15:55:07 +0200506 do { (void)(key); (void)(name); } while (0)
Peter Zijlstra4dfbb9d2006-10-11 01:45:14 -0400507#define lockdep_set_class_and_subclass(lock, key, sub) \
508 do { (void)(key); } while (0)
Andrew Morton07646e22006-10-11 23:45:23 -0400509#define lockdep_set_subclass(lock, sub) do { } while (0)
Peter Zijlstra1704f472010-03-19 01:37:42 +0100510
511#define lockdep_set_novalidate_class(lock) do { } while (0)
512
Jan Kara9a7aa122009-06-04 15:26:49 +0200513/*
514 * We don't define lockdep_match_class() and lockdep_match_key() for !LOCKDEP
515 * case since the result is not well defined and the caller should rather
516 * #ifdef the call himself.
517 */
Andrew Morton07646e22006-10-11 23:45:23 -0400518
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700519# define INIT_LOCKDEP
520# define lockdep_reset() do { debug_locks = 1; } while (0)
521# define lockdep_free_key_range(start, size) do { } while (0)
Peter Zijlstrab351d162007-10-11 22:11:12 +0200522# define lockdep_sys_exit() do { } while (0)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700523/*
524 * The class key takes no space if lockdep is disabled:
525 */
526struct lock_class_key { };
Peter Zijlstrad5abe662006-12-06 20:37:26 -0800527
528#define lockdep_depth(tsk) (0)
529
Peter Zijlstraf8319482016-11-30 14:32:25 +1100530#define lockdep_is_held_type(l, r) (1)
531
Paul Bolle5cd3f5a2013-01-24 21:53:17 +0100532#define lockdep_assert_held(l) do { (void)(l); } while (0)
Peter Zijlstraf8319482016-11-30 14:32:25 +1100533#define lockdep_assert_held_exclusive(l) do { (void)(l); } while (0)
534#define lockdep_assert_held_read(l) do { (void)(l); } while (0)
Peter Hurley9a371102014-09-10 14:31:39 -0400535#define lockdep_assert_held_once(l) do { (void)(l); } while (0)
Peter Zijlstraf607c662009-07-20 19:16:29 +0200536
Peter Zijlstra94d24fc2011-06-07 11:17:30 +0200537#define lockdep_recursing(tsk) (0)
538
Peter Zijlstrae7904a22015-08-01 19:25:08 +0200539struct pin_cookie { };
540
541#define NIL_COOKIE (struct pin_cookie){ }
542
543#define lockdep_pin_lock(l) ({ struct pin_cookie cookie; cookie; })
544#define lockdep_repin_lock(l, c) do { (void)(l); (void)(c); } while (0)
545#define lockdep_unpin_lock(l, c) do { (void)(l); (void)(c); } while (0)
Peter Zijlstraa24fc602015-06-11 14:46:53 +0200546
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700547#endif /* !LOCKDEP */
548
Byungchul Parkb09be672017-08-07 16:12:52 +0900549enum xhlock_context_t {
550 XHLOCK_HARD,
551 XHLOCK_SOFT,
552 XHLOCK_PROC,
553 XHLOCK_CTX_NR,
554};
555
556#ifdef CONFIG_LOCKDEP_CROSSRELEASE
557extern void lockdep_init_map_crosslock(struct lockdep_map *lock,
558 const char *name,
559 struct lock_class_key *key,
560 int subclass);
561extern void lock_commit_crosslock(struct lockdep_map *lock);
562
Byungchul Park28a903f2017-08-07 16:12:54 +0900563/*
564 * What we essencially have to initialize is 'nr_acquire'. Other members
565 * will be initialized in add_xlock().
566 */
567#define STATIC_CROSS_LOCK_INIT() \
568 { .nr_acquire = 0,}
569
Byungchul Parkb09be672017-08-07 16:12:52 +0900570#define STATIC_CROSS_LOCKDEP_MAP_INIT(_name, _key) \
571 { .map.name = (_name), .map.key = (void *)(_key), \
Byungchul Park28a903f2017-08-07 16:12:54 +0900572 .map.cross = 1, .xlock = STATIC_CROSS_LOCK_INIT(), }
Byungchul Parkb09be672017-08-07 16:12:52 +0900573
574/*
575 * To initialize a lockdep_map statically use this macro.
576 * Note that _name must not be NULL.
577 */
578#define STATIC_LOCKDEP_MAP_INIT(_name, _key) \
579 { .name = (_name), .key = (void *)(_key), .cross = 0, }
580
581extern void crossrelease_hist_start(enum xhlock_context_t c);
582extern void crossrelease_hist_end(enum xhlock_context_t c);
583extern void lockdep_init_task(struct task_struct *task);
584extern void lockdep_free_task(struct task_struct *task);
585#else
586/*
587 * To initialize a lockdep_map statically use this macro.
588 * Note that _name must not be NULL.
589 */
590#define STATIC_LOCKDEP_MAP_INIT(_name, _key) \
591 { .name = (_name), .key = (void *)(_key), }
592
593static inline void crossrelease_hist_start(enum xhlock_context_t c) {}
594static inline void crossrelease_hist_end(enum xhlock_context_t c) {}
595static inline void lockdep_init_task(struct task_struct *task) {}
596static inline void lockdep_free_task(struct task_struct *task) {}
597#endif
598
Peter Zijlstraf20786f2007-07-19 01:48:56 -0700599#ifdef CONFIG_LOCK_STAT
600
601extern void lock_contended(struct lockdep_map *lock, unsigned long ip);
Peter Zijlstrac7e78cf2008-10-16 23:17:09 +0200602extern void lock_acquired(struct lockdep_map *lock, unsigned long ip);
Peter Zijlstraf20786f2007-07-19 01:48:56 -0700603
604#define LOCK_CONTENDED(_lock, try, lock) \
605do { \
606 if (!try(_lock)) { \
607 lock_contended(&(_lock)->dep_map, _RET_IP_); \
608 lock(_lock); \
Peter Zijlstraf20786f2007-07-19 01:48:56 -0700609 } \
Peter Zijlstrac7e78cf2008-10-16 23:17:09 +0200610 lock_acquired(&(_lock)->dep_map, _RET_IP_); \
Peter Zijlstraf20786f2007-07-19 01:48:56 -0700611} while (0)
612
Michal Hocko916633a2016-04-07 17:12:31 +0200613#define LOCK_CONTENDED_RETURN(_lock, try, lock) \
614({ \
615 int ____err = 0; \
616 if (!try(_lock)) { \
617 lock_contended(&(_lock)->dep_map, _RET_IP_); \
618 ____err = lock(_lock); \
619 } \
620 if (!____err) \
621 lock_acquired(&(_lock)->dep_map, _RET_IP_); \
622 ____err; \
623})
624
Peter Zijlstraf20786f2007-07-19 01:48:56 -0700625#else /* CONFIG_LOCK_STAT */
626
627#define lock_contended(lockdep_map, ip) do {} while (0)
Peter Zijlstrac7e78cf2008-10-16 23:17:09 +0200628#define lock_acquired(lockdep_map, ip) do {} while (0)
Peter Zijlstraf20786f2007-07-19 01:48:56 -0700629
630#define LOCK_CONTENDED(_lock, try, lock) \
631 lock(_lock)
632
Michal Hocko916633a2016-04-07 17:12:31 +0200633#define LOCK_CONTENDED_RETURN(_lock, try, lock) \
634 lock(_lock)
635
Peter Zijlstraf20786f2007-07-19 01:48:56 -0700636#endif /* CONFIG_LOCK_STAT */
637
Robin Holte8c158b2009-04-02 16:59:45 -0700638#ifdef CONFIG_LOCKDEP
639
640/*
641 * On lockdep we dont want the hand-coded irq-enable of
642 * _raw_*_lock_flags() code, because lockdep assumes
643 * that interrupts are not re-enabled during lock-acquire:
644 */
645#define LOCK_CONTENDED_FLAGS(_lock, try, lock, lockfl, flags) \
646 LOCK_CONTENDED((_lock), (try), (lock))
647
648#else /* CONFIG_LOCKDEP */
649
650#define LOCK_CONTENDED_FLAGS(_lock, try, lock, lockfl, flags) \
651 lockfl((_lock), (flags))
652
653#endif /* CONFIG_LOCKDEP */
654
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700655#ifdef CONFIG_TRACE_IRQFLAGS
Ingo Molnar3117df02006-12-13 00:34:43 -0800656extern void print_irqtrace_events(struct task_struct *curr);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700657#else
Ingo Molnar3117df02006-12-13 00:34:43 -0800658static inline void print_irqtrace_events(struct task_struct *curr)
659{
660}
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700661#endif
662
663/*
664 * For trivial one-depth nesting of a lock-class, the following
665 * global define can be used. (Subsystems with multiple levels
666 * of nesting should define their own lock-nesting subclasses.)
667 */
668#define SINGLE_DEPTH_NESTING 1
669
670/*
671 * Map the dependency ops to NOP or to real lockdep ops, depending
672 * on the per lock-class debug mode:
673 */
674
Oleg Nesterovfb9edbe2014-01-20 19:20:06 +0100675#define lock_acquire_exclusive(l, s, t, n, i) lock_acquire(l, s, t, 0, 1, n, i)
676#define lock_acquire_shared(l, s, t, n, i) lock_acquire(l, s, t, 1, 1, n, i)
677#define lock_acquire_shared_recursive(l, s, t, n, i) lock_acquire(l, s, t, 2, 1, n, i)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700678
Michel Lespinassea51805e2013-07-08 14:23:49 -0700679#define spin_acquire(l, s, t, i) lock_acquire_exclusive(l, s, t, NULL, i)
680#define spin_acquire_nest(l, s, t, n, i) lock_acquire_exclusive(l, s, t, n, i)
681#define spin_release(l, n, i) lock_release(l, n, i)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700682
Michel Lespinassea51805e2013-07-08 14:23:49 -0700683#define rwlock_acquire(l, s, t, i) lock_acquire_exclusive(l, s, t, NULL, i)
684#define rwlock_acquire_read(l, s, t, i) lock_acquire_shared_recursive(l, s, t, NULL, i)
685#define rwlock_release(l, n, i) lock_release(l, n, i)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700686
John Stultz1ca7d672013-10-07 15:51:59 -0700687#define seqcount_acquire(l, s, t, i) lock_acquire_exclusive(l, s, t, NULL, i)
688#define seqcount_acquire_read(l, s, t, i) lock_acquire_shared_recursive(l, s, t, NULL, i)
689#define seqcount_release(l, n, i) lock_release(l, n, i)
690
Michel Lespinassea51805e2013-07-08 14:23:49 -0700691#define mutex_acquire(l, s, t, i) lock_acquire_exclusive(l, s, t, NULL, i)
692#define mutex_acquire_nest(l, s, t, n, i) lock_acquire_exclusive(l, s, t, n, i)
693#define mutex_release(l, n, i) lock_release(l, n, i)
694
695#define rwsem_acquire(l, s, t, i) lock_acquire_exclusive(l, s, t, NULL, i)
696#define rwsem_acquire_nest(l, s, t, n, i) lock_acquire_exclusive(l, s, t, n, i)
697#define rwsem_acquire_read(l, s, t, i) lock_acquire_shared(l, s, t, NULL, i)
John Stultz1ca7d672013-10-07 15:51:59 -0700698#define rwsem_release(l, n, i) lock_release(l, n, i)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700699
Michel Lespinassea51805e2013-07-08 14:23:49 -0700700#define lock_map_acquire(l) lock_acquire_exclusive(l, 0, 0, NULL, _THIS_IP_)
701#define lock_map_acquire_read(l) lock_acquire_shared_recursive(l, 0, 0, NULL, _THIS_IP_)
Paul E. McKenneydd56af42014-08-25 20:25:06 -0700702#define lock_map_acquire_tryread(l) lock_acquire_shared_recursive(l, 0, 1, NULL, _THIS_IP_)
John Stultz1ca7d672013-10-07 15:51:59 -0700703#define lock_map_release(l) lock_release(l, 1, _THIS_IP_)
Peter Zijlstra4f3e7522008-08-11 09:30:23 +0200704
Peter Zijlstra76b189e2008-09-10 09:57:35 +0200705#ifdef CONFIG_PROVE_LOCKING
706# define might_lock(lock) \
707do { \
708 typecheck(struct lockdep_map *, &(lock)->dep_map); \
Oleg Nesterovfb9edbe2014-01-20 19:20:06 +0100709 lock_acquire(&(lock)->dep_map, 0, 0, 0, 1, NULL, _THIS_IP_); \
Peter Zijlstra76b189e2008-09-10 09:57:35 +0200710 lock_release(&(lock)->dep_map, 0, _THIS_IP_); \
711} while (0)
712# define might_lock_read(lock) \
713do { \
714 typecheck(struct lockdep_map *, &(lock)->dep_map); \
Oleg Nesterovfb9edbe2014-01-20 19:20:06 +0100715 lock_acquire(&(lock)->dep_map, 0, 0, 1, 1, NULL, _THIS_IP_); \
Peter Zijlstra76b189e2008-09-10 09:57:35 +0200716 lock_release(&(lock)->dep_map, 0, _THIS_IP_); \
717} while (0)
718#else
719# define might_lock(lock) do { } while (0)
720# define might_lock_read(lock) do { } while (0)
721#endif
722
Paul E. McKenneyd24209bb2015-01-21 15:26:03 -0800723#ifdef CONFIG_LOCKDEP
Paul E. McKenneyb3fbab02011-05-24 08:31:09 -0700724void lockdep_rcu_suspicious(const char *file, const int line, const char *s);
Paul E. McKenneyd24209bb2015-01-21 15:26:03 -0800725#else
726static inline void
727lockdep_rcu_suspicious(const char *file, const int line, const char *s)
728{
729}
Paul E. McKenney0632eb32010-02-22 17:04:47 -0800730#endif
731
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700732#endif /* __LINUX_LOCKDEP_H */