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