blob: c75eedd55af539dc8c7d907b1cac94d529108815 [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 /*
328 * Seperate hlock instance. This will be used at commit step.
329 *
330 * TODO: Use a smaller data structure containing only necessary
331 * data. However, we should make lockdep code able to handle the
332 * smaller one first.
333 */
334 struct held_lock hlock;
335};
336
337struct lockdep_map_cross {
338 struct lockdep_map map;
339 struct cross_lock xlock;
340};
341#endif
342
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700343/*
344 * Initialization, self-test and debugging-output methods:
345 */
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700346extern void lockdep_info(void);
347extern void lockdep_reset(void);
348extern void lockdep_reset_lock(struct lockdep_map *lock);
349extern void lockdep_free_key_range(void *start, unsigned long size);
Andi Kleen63f9a7f2014-02-08 08:52:01 +0100350extern asmlinkage void lockdep_sys_exit(void);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700351
352extern void lockdep_off(void);
353extern void lockdep_on(void);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700354
355/*
356 * These methods are used by specific locking variants (spinlocks,
357 * rwlocks, mutexes and rwsems) to pass init/acquire/release events
358 * to lockdep:
359 */
360
361extern void lockdep_init_map(struct lockdep_map *lock, const char *name,
Peter Zijlstra4dfbb9d2006-10-11 01:45:14 -0400362 struct lock_class_key *key, int subclass);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700363
364/*
365 * Reinitialize a lock key - for cases where there is special locking or
366 * special initialization of locks so that the validator gets the scope
367 * of dependencies wrong: they are either too broad (they need a class-split)
368 * or they are too narrow (they suffer from a false class-split):
369 */
370#define lockdep_set_class(lock, key) \
Peter Zijlstra4dfbb9d2006-10-11 01:45:14 -0400371 lockdep_init_map(&(lock)->dep_map, #key, key, 0)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700372#define lockdep_set_class_and_name(lock, key, name) \
Peter Zijlstra4dfbb9d2006-10-11 01:45:14 -0400373 lockdep_init_map(&(lock)->dep_map, name, key, 0)
374#define lockdep_set_class_and_subclass(lock, key, sub) \
375 lockdep_init_map(&(lock)->dep_map, #key, key, sub)
376#define lockdep_set_subclass(lock, sub) \
377 lockdep_init_map(&(lock)->dep_map, #lock, \
378 (lock)->dep_map.key, sub)
Peter Zijlstra1704f472010-03-19 01:37:42 +0100379
380#define lockdep_set_novalidate_class(lock) \
Oleg Nesterov47be1c12014-01-20 19:20:16 +0100381 lockdep_set_class_and_name(lock, &__lockdep_no_validate__, #lock)
Jan Kara9a7aa122009-06-04 15:26:49 +0200382/*
383 * Compare locking classes
384 */
385#define lockdep_match_class(lock, key) lockdep_match_key(&(lock)->dep_map, key)
386
387static inline int lockdep_match_key(struct lockdep_map *lock,
388 struct lock_class_key *key)
389{
390 return lock->key == key;
391}
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700392
393/*
394 * Acquire a lock.
395 *
396 * Values for "read":
397 *
398 * 0: exclusive (write) acquire
399 * 1: read-acquire (no recursion allowed)
400 * 2: read-acquire with same-instance recursion allowed
401 *
402 * Values for check:
403 *
Oleg Nesterovfb9edbe2014-01-20 19:20:06 +0100404 * 0: simple checks (freeing, held-at-exit-time, etc.)
405 * 1: full validation
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700406 */
407extern void lock_acquire(struct lockdep_map *lock, unsigned int subclass,
Peter Zijlstra7531e2f2008-08-11 09:30:24 +0200408 int trylock, int read, int check,
409 struct lockdep_map *nest_lock, unsigned long ip);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700410
411extern void lock_release(struct lockdep_map *lock, int nested,
412 unsigned long ip);
413
Peter Zijlstraf8319482016-11-30 14:32:25 +1100414/*
415 * Same "read" as for lock_acquire(), except -1 means any.
416 */
417extern int lock_is_held_type(struct lockdep_map *lock, int read);
Peter Zijlstraf607c662009-07-20 19:16:29 +0200418
Peter Zijlstraf8319482016-11-30 14:32:25 +1100419static inline int lock_is_held(struct lockdep_map *lock)
420{
421 return lock_is_held_type(lock, -1);
422}
423
424#define lockdep_is_held(lock) lock_is_held(&(lock)->dep_map)
425#define lockdep_is_held_type(lock, r) lock_is_held_type(&(lock)->dep_map, (r))
Peter Zijlstraf607c662009-07-20 19:16:29 +0200426
Peter Zijlstra00ef9f72008-12-04 09:00:17 +0100427extern void lock_set_class(struct lockdep_map *lock, const char *name,
428 struct lock_class_key *key, unsigned int subclass,
429 unsigned long ip);
430
431static inline void lock_set_subclass(struct lockdep_map *lock,
432 unsigned int subclass, unsigned long ip)
433{
434 lock_set_class(lock, lock->name, lock->key, subclass, ip);
435}
Peter Zijlstra64aa3482008-08-11 09:30:21 +0200436
J. R. Okajima6419c4a2017-02-03 01:38:17 +0900437extern void lock_downgrade(struct lockdep_map *lock, unsigned long ip);
438
Peter Zijlstrae7904a22015-08-01 19:25:08 +0200439struct pin_cookie { unsigned int val; };
440
441#define NIL_COOKIE (struct pin_cookie){ .val = 0U, }
442
443extern struct pin_cookie lock_pin_lock(struct lockdep_map *lock);
444extern void lock_repin_lock(struct lockdep_map *lock, struct pin_cookie);
445extern void lock_unpin_lock(struct lockdep_map *lock, struct pin_cookie);
Peter Zijlstraa24fc602015-06-11 14:46:53 +0200446
Peter Zijlstrad92a8cf2017-03-03 10:13:38 +0100447# define INIT_LOCKDEP .lockdep_recursion = 0,
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700448
Jarek Poplawskie3a55fd2007-03-22 00:11:26 -0800449#define lockdep_depth(tsk) (debug_locks ? (tsk)->lockdep_depth : 0)
Peter Zijlstrad5abe662006-12-06 20:37:26 -0800450
Johannes Bergb1ae3452013-02-21 16:42:47 -0800451#define lockdep_assert_held(l) do { \
452 WARN_ON(debug_locks && !lockdep_is_held(l)); \
453 } while (0)
Peter Zijlstraf607c662009-07-20 19:16:29 +0200454
Peter Zijlstraf8319482016-11-30 14:32:25 +1100455#define lockdep_assert_held_exclusive(l) do { \
456 WARN_ON(debug_locks && !lockdep_is_held_type(l, 0)); \
457 } while (0)
458
459#define lockdep_assert_held_read(l) do { \
460 WARN_ON(debug_locks && !lockdep_is_held_type(l, 1)); \
461 } while (0)
462
Peter Hurley9a371102014-09-10 14:31:39 -0400463#define lockdep_assert_held_once(l) do { \
464 WARN_ON_ONCE(debug_locks && !lockdep_is_held(l)); \
465 } while (0)
466
Peter Zijlstra94d24fc2011-06-07 11:17:30 +0200467#define lockdep_recursing(tsk) ((tsk)->lockdep_recursion)
468
Peter Zijlstrae7904a22015-08-01 19:25:08 +0200469#define lockdep_pin_lock(l) lock_pin_lock(&(l)->dep_map)
470#define lockdep_repin_lock(l,c) lock_repin_lock(&(l)->dep_map, (c))
471#define lockdep_unpin_lock(l,c) lock_unpin_lock(&(l)->dep_map, (c))
Peter Zijlstraa24fc602015-06-11 14:46:53 +0200472
Michel Lespinassea51805e2013-07-08 14:23:49 -0700473#else /* !CONFIG_LOCKDEP */
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700474
475static inline void lockdep_off(void)
476{
477}
478
479static inline void lockdep_on(void)
480{
481}
482
Peter Zijlstra7531e2f2008-08-11 09:30:24 +0200483# define lock_acquire(l, s, t, r, c, n, i) do { } while (0)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700484# define lock_release(l, n, i) do { } while (0)
J. R. Okajima6419c4a2017-02-03 01:38:17 +0900485# define lock_downgrade(l, i) do { } while (0)
Peter Zijlstra00ef9f72008-12-04 09:00:17 +0100486# define lock_set_class(l, n, k, s, i) do { } while (0)
Peter Zijlstra64aa3482008-08-11 09:30:21 +0200487# define lock_set_subclass(l, s, i) do { } while (0)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700488# define lockdep_info() do { } while (0)
Ingo Molnare25cf3d2008-10-17 15:55:07 +0200489# define lockdep_init_map(lock, name, key, sub) \
490 do { (void)(name); (void)(key); } while (0)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700491# define lockdep_set_class(lock, key) do { (void)(key); } while (0)
492# define lockdep_set_class_and_name(lock, key, name) \
Ingo Molnare25cf3d2008-10-17 15:55:07 +0200493 do { (void)(key); (void)(name); } while (0)
Peter Zijlstra4dfbb9d2006-10-11 01:45:14 -0400494#define lockdep_set_class_and_subclass(lock, key, sub) \
495 do { (void)(key); } while (0)
Andrew Morton07646e22006-10-11 23:45:23 -0400496#define lockdep_set_subclass(lock, sub) do { } while (0)
Peter Zijlstra1704f472010-03-19 01:37:42 +0100497
498#define lockdep_set_novalidate_class(lock) do { } while (0)
499
Jan Kara9a7aa122009-06-04 15:26:49 +0200500/*
501 * We don't define lockdep_match_class() and lockdep_match_key() for !LOCKDEP
502 * case since the result is not well defined and the caller should rather
503 * #ifdef the call himself.
504 */
Andrew Morton07646e22006-10-11 23:45:23 -0400505
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700506# define INIT_LOCKDEP
507# define lockdep_reset() do { debug_locks = 1; } while (0)
508# define lockdep_free_key_range(start, size) do { } while (0)
Peter Zijlstrab351d162007-10-11 22:11:12 +0200509# define lockdep_sys_exit() do { } while (0)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700510/*
511 * The class key takes no space if lockdep is disabled:
512 */
513struct lock_class_key { };
Peter Zijlstrad5abe662006-12-06 20:37:26 -0800514
515#define lockdep_depth(tsk) (0)
516
Peter Zijlstraf8319482016-11-30 14:32:25 +1100517#define lockdep_is_held_type(l, r) (1)
518
Paul Bolle5cd3f5a2013-01-24 21:53:17 +0100519#define lockdep_assert_held(l) do { (void)(l); } while (0)
Peter Zijlstraf8319482016-11-30 14:32:25 +1100520#define lockdep_assert_held_exclusive(l) do { (void)(l); } while (0)
521#define lockdep_assert_held_read(l) do { (void)(l); } while (0)
Peter Hurley9a371102014-09-10 14:31:39 -0400522#define lockdep_assert_held_once(l) do { (void)(l); } while (0)
Peter Zijlstraf607c662009-07-20 19:16:29 +0200523
Peter Zijlstra94d24fc2011-06-07 11:17:30 +0200524#define lockdep_recursing(tsk) (0)
525
Peter Zijlstrae7904a22015-08-01 19:25:08 +0200526struct pin_cookie { };
527
528#define NIL_COOKIE (struct pin_cookie){ }
529
530#define lockdep_pin_lock(l) ({ struct pin_cookie cookie; cookie; })
531#define lockdep_repin_lock(l, c) do { (void)(l); (void)(c); } while (0)
532#define lockdep_unpin_lock(l, c) do { (void)(l); (void)(c); } while (0)
Peter Zijlstraa24fc602015-06-11 14:46:53 +0200533
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700534#endif /* !LOCKDEP */
535
Byungchul Parkb09be672017-08-07 16:12:52 +0900536enum xhlock_context_t {
537 XHLOCK_HARD,
538 XHLOCK_SOFT,
539 XHLOCK_PROC,
540 XHLOCK_CTX_NR,
541};
542
543#ifdef CONFIG_LOCKDEP_CROSSRELEASE
544extern void lockdep_init_map_crosslock(struct lockdep_map *lock,
545 const char *name,
546 struct lock_class_key *key,
547 int subclass);
548extern void lock_commit_crosslock(struct lockdep_map *lock);
549
550#define STATIC_CROSS_LOCKDEP_MAP_INIT(_name, _key) \
551 { .map.name = (_name), .map.key = (void *)(_key), \
552 .map.cross = 1, }
553
554/*
555 * To initialize a lockdep_map statically use this macro.
556 * Note that _name must not be NULL.
557 */
558#define STATIC_LOCKDEP_MAP_INIT(_name, _key) \
559 { .name = (_name), .key = (void *)(_key), .cross = 0, }
560
561extern void crossrelease_hist_start(enum xhlock_context_t c);
562extern void crossrelease_hist_end(enum xhlock_context_t c);
563extern void lockdep_init_task(struct task_struct *task);
564extern void lockdep_free_task(struct task_struct *task);
565#else
566/*
567 * To initialize a lockdep_map statically use this macro.
568 * Note that _name must not be NULL.
569 */
570#define STATIC_LOCKDEP_MAP_INIT(_name, _key) \
571 { .name = (_name), .key = (void *)(_key), }
572
573static inline void crossrelease_hist_start(enum xhlock_context_t c) {}
574static inline void crossrelease_hist_end(enum xhlock_context_t c) {}
575static inline void lockdep_init_task(struct task_struct *task) {}
576static inline void lockdep_free_task(struct task_struct *task) {}
577#endif
578
Peter Zijlstraf20786f2007-07-19 01:48:56 -0700579#ifdef CONFIG_LOCK_STAT
580
581extern void lock_contended(struct lockdep_map *lock, unsigned long ip);
Peter Zijlstrac7e78cf2008-10-16 23:17:09 +0200582extern void lock_acquired(struct lockdep_map *lock, unsigned long ip);
Peter Zijlstraf20786f2007-07-19 01:48:56 -0700583
584#define LOCK_CONTENDED(_lock, try, lock) \
585do { \
586 if (!try(_lock)) { \
587 lock_contended(&(_lock)->dep_map, _RET_IP_); \
588 lock(_lock); \
Peter Zijlstraf20786f2007-07-19 01:48:56 -0700589 } \
Peter Zijlstrac7e78cf2008-10-16 23:17:09 +0200590 lock_acquired(&(_lock)->dep_map, _RET_IP_); \
Peter Zijlstraf20786f2007-07-19 01:48:56 -0700591} while (0)
592
Michal Hocko916633a2016-04-07 17:12:31 +0200593#define LOCK_CONTENDED_RETURN(_lock, try, lock) \
594({ \
595 int ____err = 0; \
596 if (!try(_lock)) { \
597 lock_contended(&(_lock)->dep_map, _RET_IP_); \
598 ____err = lock(_lock); \
599 } \
600 if (!____err) \
601 lock_acquired(&(_lock)->dep_map, _RET_IP_); \
602 ____err; \
603})
604
Peter Zijlstraf20786f2007-07-19 01:48:56 -0700605#else /* CONFIG_LOCK_STAT */
606
607#define lock_contended(lockdep_map, ip) do {} while (0)
Peter Zijlstrac7e78cf2008-10-16 23:17:09 +0200608#define lock_acquired(lockdep_map, ip) do {} while (0)
Peter Zijlstraf20786f2007-07-19 01:48:56 -0700609
610#define LOCK_CONTENDED(_lock, try, lock) \
611 lock(_lock)
612
Michal Hocko916633a2016-04-07 17:12:31 +0200613#define LOCK_CONTENDED_RETURN(_lock, try, lock) \
614 lock(_lock)
615
Peter Zijlstraf20786f2007-07-19 01:48:56 -0700616#endif /* CONFIG_LOCK_STAT */
617
Robin Holte8c158b2009-04-02 16:59:45 -0700618#ifdef CONFIG_LOCKDEP
619
620/*
621 * On lockdep we dont want the hand-coded irq-enable of
622 * _raw_*_lock_flags() code, because lockdep assumes
623 * that interrupts are not re-enabled during lock-acquire:
624 */
625#define LOCK_CONTENDED_FLAGS(_lock, try, lock, lockfl, flags) \
626 LOCK_CONTENDED((_lock), (try), (lock))
627
628#else /* CONFIG_LOCKDEP */
629
630#define LOCK_CONTENDED_FLAGS(_lock, try, lock, lockfl, flags) \
631 lockfl((_lock), (flags))
632
633#endif /* CONFIG_LOCKDEP */
634
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700635#ifdef CONFIG_TRACE_IRQFLAGS
Ingo Molnar3117df02006-12-13 00:34:43 -0800636extern void print_irqtrace_events(struct task_struct *curr);
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700637#else
Ingo Molnar3117df02006-12-13 00:34:43 -0800638static inline void print_irqtrace_events(struct task_struct *curr)
639{
640}
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700641#endif
642
643/*
644 * For trivial one-depth nesting of a lock-class, the following
645 * global define can be used. (Subsystems with multiple levels
646 * of nesting should define their own lock-nesting subclasses.)
647 */
648#define SINGLE_DEPTH_NESTING 1
649
650/*
651 * Map the dependency ops to NOP or to real lockdep ops, depending
652 * on the per lock-class debug mode:
653 */
654
Oleg Nesterovfb9edbe2014-01-20 19:20:06 +0100655#define lock_acquire_exclusive(l, s, t, n, i) lock_acquire(l, s, t, 0, 1, n, i)
656#define lock_acquire_shared(l, s, t, n, i) lock_acquire(l, s, t, 1, 1, n, i)
657#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 -0700658
Michel Lespinassea51805e2013-07-08 14:23:49 -0700659#define spin_acquire(l, s, t, i) lock_acquire_exclusive(l, s, t, NULL, i)
660#define spin_acquire_nest(l, s, t, n, i) lock_acquire_exclusive(l, s, t, n, i)
661#define spin_release(l, n, i) lock_release(l, n, i)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700662
Michel Lespinassea51805e2013-07-08 14:23:49 -0700663#define rwlock_acquire(l, s, t, i) lock_acquire_exclusive(l, s, t, NULL, i)
664#define rwlock_acquire_read(l, s, t, i) lock_acquire_shared_recursive(l, s, t, NULL, i)
665#define rwlock_release(l, n, i) lock_release(l, n, i)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700666
John Stultz1ca7d672013-10-07 15:51:59 -0700667#define seqcount_acquire(l, s, t, i) lock_acquire_exclusive(l, s, t, NULL, i)
668#define seqcount_acquire_read(l, s, t, i) lock_acquire_shared_recursive(l, s, t, NULL, i)
669#define seqcount_release(l, n, i) lock_release(l, n, i)
670
Michel Lespinassea51805e2013-07-08 14:23:49 -0700671#define mutex_acquire(l, s, t, i) lock_acquire_exclusive(l, s, t, NULL, i)
672#define mutex_acquire_nest(l, s, t, n, i) lock_acquire_exclusive(l, s, t, n, i)
673#define mutex_release(l, n, i) lock_release(l, n, i)
674
675#define rwsem_acquire(l, s, t, i) lock_acquire_exclusive(l, s, t, NULL, i)
676#define rwsem_acquire_nest(l, s, t, n, i) lock_acquire_exclusive(l, s, t, n, i)
677#define rwsem_acquire_read(l, s, t, i) lock_acquire_shared(l, s, t, NULL, i)
John Stultz1ca7d672013-10-07 15:51:59 -0700678#define rwsem_release(l, n, i) lock_release(l, n, i)
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700679
Michel Lespinassea51805e2013-07-08 14:23:49 -0700680#define lock_map_acquire(l) lock_acquire_exclusive(l, 0, 0, NULL, _THIS_IP_)
681#define lock_map_acquire_read(l) lock_acquire_shared_recursive(l, 0, 0, NULL, _THIS_IP_)
Paul E. McKenneydd56af42014-08-25 20:25:06 -0700682#define lock_map_acquire_tryread(l) lock_acquire_shared_recursive(l, 0, 1, NULL, _THIS_IP_)
John Stultz1ca7d672013-10-07 15:51:59 -0700683#define lock_map_release(l) lock_release(l, 1, _THIS_IP_)
Peter Zijlstra4f3e7522008-08-11 09:30:23 +0200684
Peter Zijlstra76b189e2008-09-10 09:57:35 +0200685#ifdef CONFIG_PROVE_LOCKING
686# define might_lock(lock) \
687do { \
688 typecheck(struct lockdep_map *, &(lock)->dep_map); \
Oleg Nesterovfb9edbe2014-01-20 19:20:06 +0100689 lock_acquire(&(lock)->dep_map, 0, 0, 0, 1, NULL, _THIS_IP_); \
Peter Zijlstra76b189e2008-09-10 09:57:35 +0200690 lock_release(&(lock)->dep_map, 0, _THIS_IP_); \
691} while (0)
692# define might_lock_read(lock) \
693do { \
694 typecheck(struct lockdep_map *, &(lock)->dep_map); \
Oleg Nesterovfb9edbe2014-01-20 19:20:06 +0100695 lock_acquire(&(lock)->dep_map, 0, 0, 1, 1, NULL, _THIS_IP_); \
Peter Zijlstra76b189e2008-09-10 09:57:35 +0200696 lock_release(&(lock)->dep_map, 0, _THIS_IP_); \
697} while (0)
698#else
699# define might_lock(lock) do { } while (0)
700# define might_lock_read(lock) do { } while (0)
701#endif
702
Paul E. McKenneyd24209bb2015-01-21 15:26:03 -0800703#ifdef CONFIG_LOCKDEP
Paul E. McKenneyb3fbab02011-05-24 08:31:09 -0700704void lockdep_rcu_suspicious(const char *file, const int line, const char *s);
Paul E. McKenneyd24209bb2015-01-21 15:26:03 -0800705#else
706static inline void
707lockdep_rcu_suspicious(const char *file, const int line, const char *s)
708{
709}
Paul E. McKenney0632eb32010-02-22 17:04:47 -0800710#endif
711
Ingo Molnarfbb9ce952006-07-03 00:24:50 -0700712#endif /* __LINUX_LOCKDEP_H */