drivers: power: report battery voltage in AOSP compatible format
[GitHub/mt8127/android_kernel_alcatel_ttab.git] / include / linux / lockdep.h
1 /*
2 * Runtime locking correctness validator
3 *
4 * Copyright (C) 2006,2007 Red Hat, Inc., Ingo Molnar <mingo@redhat.com>
5 * Copyright (C) 2007 Red Hat, Inc., Peter Zijlstra <pzijlstr@redhat.com>
6 *
7 * see Documentation/lockdep-design.txt for more details.
8 */
9 #ifndef __LINUX_LOCKDEP_H
10 #define __LINUX_LOCKDEP_H
11
12 struct task_struct;
13 struct lockdep_map;
14
15 /* for sysctl */
16 extern int prove_locking;
17 extern int lock_stat;
18
19 #ifdef CONFIG_LOCKDEP
20
21 #include <linux/linkage.h>
22 #include <linux/list.h>
23 #include <linux/debug_locks.h>
24 #include <linux/stacktrace.h>
25
26 /*
27 * We'd rather not expose kernel/lockdep_states.h this wide, but we do need
28 * the total number of states... :-(
29 */
30 #define XXX_LOCK_USAGE_STATES (1+3*4)
31
32 #define MAX_LOCKDEP_SUBCLASSES 8UL
33
34 /*
35 * 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 /*
46 * 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 */
50 struct lockdep_subclass_key {
51 char __one_byte;
52 } __attribute__ ((__packed__));
53
54 struct lock_class_key {
55 struct lockdep_subclass_key subkeys[MAX_LOCKDEP_SUBCLASSES];
56 };
57
58 extern struct lock_class_key __lockdep_no_validate__;
59
60 #define LOCKSTAT_POINTS 4
61
62 /*
63 * The lock-class itself:
64 */
65 struct lock_class {
66 /*
67 * class-hash:
68 */
69 struct list_head hash_entry;
70
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;
78 unsigned int dep_gen_id;
79
80 /*
81 * IRQ/softirq usage tracking bits:
82 */
83 unsigned long usage_mask;
84 struct stack_trace usage_traces[XXX_LOCK_USAGE_STATES];
85
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;
106
107 #ifdef CONFIG_LOCK_STAT
108 unsigned long contention_point[LOCKSTAT_POINTS];
109 unsigned long contending_point[LOCKSTAT_POINTS];
110 #endif
111 };
112
113 #ifdef CONFIG_LOCK_STAT
114 struct lock_time {
115 s64 min;
116 s64 max;
117 s64 total;
118 unsigned long nr;
119 };
120
121 enum 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
132 struct lock_class_stats {
133 unsigned long contention_point[4];
134 unsigned long contending_point[4];
135 struct lock_time read_waittime;
136 struct lock_time write_waittime;
137 struct lock_time read_holdtime;
138 struct lock_time write_holdtime;
139 unsigned long bounces[nr_bounce_types];
140 };
141
142 struct lock_class_stats lock_stats(struct lock_class *class);
143 void clear_lock_stats(struct lock_class *class);
144 #endif
145
146 /*
147 * Map the lock object (the lock instance) to the lock-class object.
148 * This is embedded into specific lock instances:
149 */
150 struct lockdep_map {
151 struct lock_class_key *key;
152 struct lock_class *class_cache[NR_LOCKDEP_CACHING_CLASSES];
153 const char *name;
154 #ifdef CONFIG_LOCK_STAT
155 int cpu;
156 unsigned long ip;
157 #endif
158 //skip lockdep if we need it
159 int skip;
160 };
161
162 static inline void lockdep_copy_map(struct lockdep_map *to,
163 struct lockdep_map *from)
164 {
165 int i;
166
167 *to = *from;
168 /*
169 * Since the class cache can be modified concurrently we could observe
170 * half pointers (64bit arch using 32bit copy insns). Therefore clear
171 * the caches and take the performance hit.
172 *
173 * XXX it doesn't work well with lockdep_set_class_and_subclass(), since
174 * that relies on cache abuse.
175 */
176 for (i = 0; i < NR_LOCKDEP_CACHING_CLASSES; i++)
177 to->class_cache[i] = NULL;
178 }
179
180 /*
181 * Every lock has a list of other locks that were taken after it.
182 * We only grow the list, never remove from it:
183 */
184 struct lock_list {
185 struct list_head entry;
186 struct lock_class *class;
187 struct stack_trace trace;
188 int distance;
189
190 /*
191 * The parent field is used to implement breadth-first search, and the
192 * bit 0 is reused to indicate if the lock has been accessed in BFS.
193 */
194 struct lock_list *parent;
195 };
196
197 /*
198 * We record lock dependency chains, so that we can cache them:
199 */
200 struct lock_chain {
201 u8 irq_context;
202 u8 depth;
203 u16 base;
204 struct list_head entry;
205 u64 chain_key;
206 };
207
208 #define MAX_LOCKDEP_KEYS_BITS 13
209 /*
210 * Subtract one because we offset hlock->class_idx by 1 in order
211 * to make 0 mean no class. This avoids overflowing the class_idx
212 * bitfield and hitting the BUG in hlock_class().
213 */
214 #define MAX_LOCKDEP_KEYS ((1UL << MAX_LOCKDEP_KEYS_BITS) - 1)
215
216 struct held_lock {
217 /*
218 * One-way hash of the dependency chain up to this point. We
219 * hash the hashes step by step as the dependency chain grows.
220 *
221 * We use it for dependency-caching and we skip detection
222 * passes and dependency-updates if there is a cache-hit, so
223 * it is absolutely critical for 100% coverage of the validator
224 * to have a unique key value for every unique dependency path
225 * that can occur in the system, to make a unique hash value
226 * as likely as possible - hence the 64-bit width.
227 *
228 * The task struct holds the current hash value (initialized
229 * with zero), here we store the previous hash value:
230 */
231 u64 prev_chain_key;
232 unsigned long acquire_ip;
233 struct lockdep_map *instance;
234 struct lockdep_map *nest_lock;
235 #ifdef CONFIG_LOCK_STAT
236 u64 waittime_stamp;
237 u64 holdtime_stamp;
238 #endif
239 unsigned int class_idx:MAX_LOCKDEP_KEYS_BITS;
240 /*
241 * The lock-stack is unified in that the lock chains of interrupt
242 * contexts nest ontop of process context chains, but we 'separate'
243 * the hashes by starting with 0 if we cross into an interrupt
244 * context, and we also keep do not add cross-context lock
245 * dependencies - the lock usage graph walking covers that area
246 * anyway, and we'd just unnecessarily increase the number of
247 * dependencies otherwise. [Note: hardirq and softirq contexts
248 * are separated from each other too.]
249 *
250 * The following field is used to detect when we cross into an
251 * interrupt context:
252 */
253 unsigned int irq_context:2; /* bit 0 - soft, bit 1 - hard */
254 unsigned int trylock:1; /* 16 bits */
255
256 unsigned int read:2; /* see lock_acquire() comment */
257 unsigned int check:2; /* see lock_acquire() comment */
258 unsigned int hardirqs_off:1;
259 unsigned int references:11; /* 32 bits */
260 };
261
262 /*
263 * Initialization, self-test and debugging-output methods:
264 */
265 extern void lockdep_init(void);
266 extern void lockdep_info(void);
267 extern void lockdep_reset(void);
268 extern void lockdep_reset_lock(struct lockdep_map *lock);
269 extern void lockdep_free_key_range(void *start, unsigned long size);
270 extern void lockdep_sys_exit(void);
271
272 extern void lockdep_off(void);
273 extern void lockdep_on(void);
274
275 /*
276 * These methods are used by specific locking variants (spinlocks,
277 * rwlocks, mutexes and rwsems) to pass init/acquire/release events
278 * to lockdep:
279 */
280
281 extern void lockdep_init_map(struct lockdep_map *lock, const char *name,
282 struct lock_class_key *key, int subclass);
283
284 static inline void lockdep_skip_validate(struct lockdep_map *lock)
285 {
286 lock->skip = 1;
287 }
288 /*
289 * To initialize a lockdep_map statically use this macro.
290 * Note that _name must not be NULL.
291 */
292 #define STATIC_LOCKDEP_MAP_INIT(_name, _key) \
293 { .name = (_name), .key = (void *)(_key), }
294
295 /*
296 * Reinitialize a lock key - for cases where there is special locking or
297 * special initialization of locks so that the validator gets the scope
298 * of dependencies wrong: they are either too broad (they need a class-split)
299 * or they are too narrow (they suffer from a false class-split):
300 */
301 #define lockdep_set_class(lock, key) \
302 lockdep_init_map(&(lock)->dep_map, #key, key, 0)
303 #define lockdep_set_class_and_name(lock, key, name) \
304 lockdep_init_map(&(lock)->dep_map, name, key, 0)
305 #define lockdep_set_class_and_subclass(lock, key, sub) \
306 lockdep_init_map(&(lock)->dep_map, #key, key, sub)
307 #define lockdep_set_subclass(lock, sub) \
308 lockdep_init_map(&(lock)->dep_map, #lock, \
309 (lock)->dep_map.key, sub)
310
311 #define lockdep_set_novalidate_class(lock) \
312 lockdep_set_class(lock, &__lockdep_no_validate__)
313 /*
314 * Compare locking classes
315 */
316 #define lockdep_match_class(lock, key) lockdep_match_key(&(lock)->dep_map, key)
317
318 static inline int lockdep_match_key(struct lockdep_map *lock,
319 struct lock_class_key *key)
320 {
321 return lock->key == key;
322 }
323
324 /*
325 * Acquire a lock.
326 *
327 * Values for "read":
328 *
329 * 0: exclusive (write) acquire
330 * 1: read-acquire (no recursion allowed)
331 * 2: read-acquire with same-instance recursion allowed
332 *
333 * Values for check:
334 *
335 * 0: disabled
336 * 1: simple checks (freeing, held-at-exit-time, etc.)
337 * 2: full validation
338 */
339 extern void lock_acquire(struct lockdep_map *lock, unsigned int subclass,
340 int trylock, int read, int check,
341 struct lockdep_map *nest_lock, unsigned long ip);
342
343 extern void lock_release(struct lockdep_map *lock, int nested,
344 unsigned long ip);
345
346 #define lockdep_is_held(lock) lock_is_held(&(lock)->dep_map)
347
348 extern int lock_is_held(struct lockdep_map *lock);
349
350 extern void lock_set_class(struct lockdep_map *lock, const char *name,
351 struct lock_class_key *key, unsigned int subclass,
352 unsigned long ip);
353
354 static inline void lock_set_subclass(struct lockdep_map *lock,
355 unsigned int subclass, unsigned long ip)
356 {
357 lock_set_class(lock, lock->name, lock->key, subclass, ip);
358 }
359
360 extern void lockdep_set_current_reclaim_state(gfp_t gfp_mask);
361 extern void lockdep_clear_current_reclaim_state(void);
362 extern void lockdep_trace_alloc(gfp_t mask);
363
364 # define INIT_LOCKDEP .lockdep_recursion = 0, .lockdep_reclaim_gfp = 0,
365
366 #define lockdep_depth(tsk) (debug_locks ? (tsk)->lockdep_depth : 0)
367
368 #define lockdep_assert_held(l) do { \
369 WARN_ON(debug_locks && !lockdep_is_held(l)); \
370 } while (0)
371
372 #define lockdep_recursing(tsk) ((tsk)->lockdep_recursion)
373
374 #else /* !LOCKDEP */
375
376 static inline void lockdep_off(void)
377 {
378 }
379
380 static inline void lockdep_on(void)
381 {
382 }
383 static inline void lockdep_skip_validate(struct lockdep_map *lock)
384 {
385 }
386
387 # define lock_acquire(l, s, t, r, c, n, i) do { } while (0)
388 # define lock_release(l, n, i) do { } while (0)
389 # define lock_set_class(l, n, k, s, i) do { } while (0)
390 # define lock_set_subclass(l, s, i) do { } while (0)
391 # define lockdep_set_current_reclaim_state(g) do { } while (0)
392 # define lockdep_clear_current_reclaim_state() do { } while (0)
393 # define lockdep_trace_alloc(g) do { } while (0)
394 # define lockdep_init() do { } while (0)
395 # define lockdep_info() do { } while (0)
396 # define lockdep_init_map(lock, name, key, sub) \
397 do { (void)(name); (void)(key); } while (0)
398 # define lockdep_set_class(lock, key) do { (void)(key); } while (0)
399 # define lockdep_set_class_and_name(lock, key, name) \
400 do { (void)(key); (void)(name); } while (0)
401 #define lockdep_set_class_and_subclass(lock, key, sub) \
402 do { (void)(key); } while (0)
403 #define lockdep_set_subclass(lock, sub) do { } while (0)
404
405 #define lockdep_set_novalidate_class(lock) do { } while (0)
406
407 /*
408 * We don't define lockdep_match_class() and lockdep_match_key() for !LOCKDEP
409 * case since the result is not well defined and the caller should rather
410 * #ifdef the call himself.
411 */
412
413 # define INIT_LOCKDEP
414 # define lockdep_reset() do { debug_locks = 1; } while (0)
415 # define lockdep_free_key_range(start, size) do { } while (0)
416 # define lockdep_sys_exit() do { } while (0)
417 /*
418 * The class key takes no space if lockdep is disabled:
419 */
420 struct lock_class_key { };
421
422 #define lockdep_depth(tsk) (0)
423
424 #define lockdep_assert_held(l) do { (void)(l); } while (0)
425
426 #define lockdep_recursing(tsk) (0)
427
428 #endif /* !LOCKDEP */
429
430 #ifdef CONFIG_LOCK_STAT
431
432 extern void lock_contended(struct lockdep_map *lock, unsigned long ip);
433 extern void lock_acquired(struct lockdep_map *lock, unsigned long ip);
434
435 #define LOCK_CONTENDED(_lock, try, lock) \
436 do { \
437 if (!try(_lock)) { \
438 lock_contended(&(_lock)->dep_map, _RET_IP_); \
439 lock(_lock); \
440 } \
441 lock_acquired(&(_lock)->dep_map, _RET_IP_); \
442 } while (0)
443
444 #else /* CONFIG_LOCK_STAT */
445
446 #define lock_contended(lockdep_map, ip) do {} while (0)
447 #define lock_acquired(lockdep_map, ip) do {} while (0)
448
449 #define LOCK_CONTENDED(_lock, try, lock) \
450 lock(_lock)
451
452 #endif /* CONFIG_LOCK_STAT */
453
454 #ifdef CONFIG_LOCKDEP
455
456 /*
457 * On lockdep we dont want the hand-coded irq-enable of
458 * _raw_*_lock_flags() code, because lockdep assumes
459 * that interrupts are not re-enabled during lock-acquire:
460 */
461 #define LOCK_CONTENDED_FLAGS(_lock, try, lock, lockfl, flags) \
462 LOCK_CONTENDED((_lock), (try), (lock))
463
464 #else /* CONFIG_LOCKDEP */
465
466 #define LOCK_CONTENDED_FLAGS(_lock, try, lock, lockfl, flags) \
467 lockfl((_lock), (flags))
468
469 #endif /* CONFIG_LOCKDEP */
470
471 #ifdef CONFIG_TRACE_IRQFLAGS
472 extern void print_irqtrace_events(struct task_struct *curr);
473 #else
474 static inline void print_irqtrace_events(struct task_struct *curr)
475 {
476 }
477 #endif
478
479 /*
480 * For trivial one-depth nesting of a lock-class, the following
481 * global define can be used. (Subsystems with multiple levels
482 * of nesting should define their own lock-nesting subclasses.)
483 */
484 #define SINGLE_DEPTH_NESTING 1
485
486 /*
487 * Map the dependency ops to NOP or to real lockdep ops, depending
488 * on the per lock-class debug mode:
489 */
490
491 #ifdef CONFIG_DEBUG_LOCK_ALLOC
492 # ifdef CONFIG_PROVE_LOCKING
493 # define spin_acquire(l, s, t, i) lock_acquire(l, s, t, 0, 2, NULL, i)
494 # define spin_acquire_nest(l, s, t, n, i) lock_acquire(l, s, t, 0, 2, n, i)
495 # else
496 # define spin_acquire(l, s, t, i) lock_acquire(l, s, t, 0, 1, NULL, i)
497 # define spin_acquire_nest(l, s, t, n, i) lock_acquire(l, s, t, 0, 1, NULL, i)
498 # endif
499 # define spin_release(l, n, i) lock_release(l, n, i)
500 #else
501 # define spin_acquire(l, s, t, i) do { } while (0)
502 # define spin_release(l, n, i) do { } while (0)
503 #endif
504
505 #ifdef CONFIG_DEBUG_LOCK_ALLOC
506 # ifdef CONFIG_PROVE_LOCKING
507 # define rwlock_acquire(l, s, t, i) lock_acquire(l, s, t, 0, 2, NULL, i)
508 # define rwlock_acquire_read(l, s, t, i) lock_acquire(l, s, t, 2, 2, NULL, i)
509 # else
510 # define rwlock_acquire(l, s, t, i) lock_acquire(l, s, t, 0, 1, NULL, i)
511 # define rwlock_acquire_read(l, s, t, i) lock_acquire(l, s, t, 2, 1, NULL, i)
512 # endif
513 # define rwlock_release(l, n, i) lock_release(l, n, i)
514 #else
515 # define rwlock_acquire(l, s, t, i) do { } while (0)
516 # define rwlock_acquire_read(l, s, t, i) do { } while (0)
517 # define rwlock_release(l, n, i) do { } while (0)
518 #endif
519
520 #ifdef CONFIG_DEBUG_LOCK_ALLOC
521 # ifdef CONFIG_PROVE_LOCKING
522 # define mutex_acquire(l, s, t, i) lock_acquire(l, s, t, 0, 2, NULL, i)
523 # define mutex_acquire_nest(l, s, t, n, i) lock_acquire(l, s, t, 0, 2, n, i)
524 # else
525 # define mutex_acquire(l, s, t, i) lock_acquire(l, s, t, 0, 1, NULL, i)
526 # define mutex_acquire_nest(l, s, t, n, i) lock_acquire(l, s, t, 0, 1, n, i)
527 # endif
528 # define mutex_release(l, n, i) lock_release(l, n, i)
529 #else
530 # define mutex_acquire(l, s, t, i) do { } while (0)
531 # define mutex_acquire_nest(l, s, t, n, i) do { } while (0)
532 # define mutex_release(l, n, i) do { } while (0)
533 #endif
534
535 #ifdef CONFIG_DEBUG_LOCK_ALLOC
536 # ifdef CONFIG_PROVE_LOCKING
537 # define rwsem_acquire(l, s, t, i) lock_acquire(l, s, t, 0, 2, NULL, i)
538 # define rwsem_acquire_nest(l, s, t, n, i) lock_acquire(l, s, t, 0, 2, n, i)
539 # define rwsem_acquire_read(l, s, t, i) lock_acquire(l, s, t, 1, 2, NULL, i)
540 # else
541 # define rwsem_acquire(l, s, t, i) lock_acquire(l, s, t, 0, 1, NULL, i)
542 # define rwsem_acquire_nest(l, s, t, n, i) lock_acquire(l, s, t, 0, 1, n, i)
543 # define rwsem_acquire_read(l, s, t, i) lock_acquire(l, s, t, 1, 1, NULL, i)
544 # endif
545 # define rwsem_release(l, n, i) lock_release(l, n, i)
546 #else
547 # define rwsem_acquire(l, s, t, i) do { } while (0)
548 # define rwsem_acquire_nest(l, s, t, n, i) do { } while (0)
549 # define rwsem_acquire_read(l, s, t, i) do { } while (0)
550 # define rwsem_release(l, n, i) do { } while (0)
551 #endif
552
553 #ifdef CONFIG_DEBUG_LOCK_ALLOC
554 # ifdef CONFIG_PROVE_LOCKING
555 # define lock_map_acquire(l) lock_acquire(l, 0, 0, 0, 2, NULL, _THIS_IP_)
556 # define lock_map_acquire_read(l) lock_acquire(l, 0, 0, 2, 2, NULL, _THIS_IP_)
557 # else
558 # define lock_map_acquire(l) lock_acquire(l, 0, 0, 0, 1, NULL, _THIS_IP_)
559 # define lock_map_acquire_read(l) lock_acquire(l, 0, 0, 2, 1, NULL, _THIS_IP_)
560 # endif
561 # define lock_map_release(l) lock_release(l, 1, _THIS_IP_)
562 #else
563 # define lock_map_acquire(l) do { } while (0)
564 # define lock_map_acquire_read(l) do { } while (0)
565 # define lock_map_release(l) do { } while (0)
566 #endif
567
568 #ifdef CONFIG_PROVE_LOCKING
569 # define might_lock(lock) \
570 do { \
571 typecheck(struct lockdep_map *, &(lock)->dep_map); \
572 lock_acquire(&(lock)->dep_map, 0, 0, 0, 2, NULL, _THIS_IP_); \
573 lock_release(&(lock)->dep_map, 0, _THIS_IP_); \
574 } while (0)
575 # define might_lock_read(lock) \
576 do { \
577 typecheck(struct lockdep_map *, &(lock)->dep_map); \
578 lock_acquire(&(lock)->dep_map, 0, 0, 1, 2, NULL, _THIS_IP_); \
579 lock_release(&(lock)->dep_map, 0, _THIS_IP_); \
580 } while (0)
581 #else
582 # define might_lock(lock) do { } while (0)
583 # define might_lock_read(lock) do { } while (0)
584 #endif
585
586 #ifdef CONFIG_PROVE_RCU
587 void lockdep_rcu_suspicious(const char *file, const int line, const char *s);
588 #endif
589
590 #endif /* __LINUX_LOCKDEP_H */