kernel/locking/mutex.h

0001 /* SPDX-License-Identifier: GPL-2.0 */
0002 /*
0003  * Mutexes: blocking mutual exclusion locks
0004  *
0005  * started by Ingo Molnar:
0006  *
0007  *  Copyright (C) 2004, 2005, 2006 Red Hat, Inc., Ingo Molnar <mingo@redhat.com>
0008  */
0009
0010 /*
0011  * This is the control structure for tasks blocked on mutex, which resides
0012  * on the blocked task's kernel stack:
0013  */
0014 struct mutex_waiter {
0015     struct list_head    list;
0016     struct task_struct  *task;
0017     struct ww_acquire_ctx   *ww_ctx;
0018 #ifdef CONFIG_DEBUG_MUTEXES
0019     void            *magic;
0020 #endif
0021 };
0022
0023 #ifdef CONFIG_DEBUG_MUTEXES
0024 extern void debug_mutex_lock_common(struct mutex *lock,
0025                     struct mutex_waiter *waiter);
0026 extern void debug_mutex_wake_waiter(struct mutex *lock,
0027                     struct mutex_waiter *waiter);
0028 extern void debug_mutex_free_waiter(struct mutex_waiter *waiter);
0029 extern void debug_mutex_add_waiter(struct mutex *lock,
0030                    struct mutex_waiter *waiter,
0031                    struct task_struct *task);
0032 extern void debug_mutex_remove_waiter(struct mutex *lock, struct mutex_waiter *waiter,
0033                       struct task_struct *task);
0034 extern void debug_mutex_unlock(struct mutex *lock);
0035 extern void debug_mutex_init(struct mutex *lock, const char *name,
0036                  struct lock_class_key *key);
0037 #else /* CONFIG_DEBUG_MUTEXES */
0038 # define debug_mutex_lock_common(lock, waiter)      do { } while (0)
0039 # define debug_mutex_wake_waiter(lock, waiter)      do { } while (0)
0040 # define debug_mutex_free_waiter(waiter)        do { } while (0)
0041 # define debug_mutex_add_waiter(lock, waiter, ti)   do { } while (0)
0042 # define debug_mutex_remove_waiter(lock, waiter, ti)    do { } while (0)
0043 # define debug_mutex_unlock(lock)           do { } while (0)
0044 # define debug_mutex_init(lock, name, key)      do { } while (0)
0045 #endif /* !CONFIG_DEBUG_MUTEXES */