]>
git.proxmox.com Git - mirror_ubuntu-eoan-kernel.git/blob - include/linux/rtmutex.h
1 /* SPDX-License-Identifier: GPL-2.0 */
3 * RT Mutexes: blocking mutual exclusion locks with PI support
5 * started by Ingo Molnar and Thomas Gleixner:
7 * Copyright (C) 2004-2006 Red Hat, Inc., Ingo Molnar <mingo@redhat.com>
8 * Copyright (C) 2006, Timesys Corp., Thomas Gleixner <tglx@timesys.com>
10 * This file contains the public data structure and API definitions.
13 #ifndef __LINUX_RT_MUTEX_H
14 #define __LINUX_RT_MUTEX_H
16 #include <linux/linkage.h>
17 #include <linux/rbtree.h>
18 #include <linux/spinlock_types.h>
20 extern int max_lock_depth
; /* for sysctl */
23 * The rt_mutex structure
25 * @wait_lock: spinlock to protect the structure
26 * @waiters: rbtree root to enqueue waiters in priority order;
27 * caches top-waiter (leftmost node).
28 * @owner: the mutex owner
31 raw_spinlock_t wait_lock
;
32 struct rb_root_cached waiters
;
33 struct task_struct
*owner
;
34 #ifdef CONFIG_DEBUG_RT_MUTEXES
36 const char *name
, *file
;
40 #ifdef CONFIG_DEBUG_LOCK_ALLOC
41 struct lockdep_map dep_map
;
45 struct rt_mutex_waiter
;
46 struct hrtimer_sleeper
;
48 #ifdef CONFIG_DEBUG_RT_MUTEXES
49 extern int rt_mutex_debug_check_no_locks_freed(const void *from
,
51 extern void rt_mutex_debug_check_no_locks_held(struct task_struct
*task
);
53 static inline int rt_mutex_debug_check_no_locks_freed(const void *from
,
58 # define rt_mutex_debug_check_no_locks_held(task) do { } while (0)
61 #ifdef CONFIG_DEBUG_RT_MUTEXES
62 # define __DEBUG_RT_MUTEX_INITIALIZER(mutexname) \
63 , .name = #mutexname, .file = __FILE__, .line = __LINE__
65 # define rt_mutex_init(mutex) \
67 static struct lock_class_key __key; \
68 __rt_mutex_init(mutex, __func__, &__key); \
71 extern void rt_mutex_debug_task_free(struct task_struct
*tsk
);
73 # define __DEBUG_RT_MUTEX_INITIALIZER(mutexname)
74 # define rt_mutex_init(mutex) __rt_mutex_init(mutex, NULL, NULL)
75 # define rt_mutex_debug_task_free(t) do { } while (0)
78 #ifdef CONFIG_DEBUG_LOCK_ALLOC
79 #define __DEP_MAP_RT_MUTEX_INITIALIZER(mutexname) \
80 , .dep_map = { .name = #mutexname }
82 #define __DEP_MAP_RT_MUTEX_INITIALIZER(mutexname)
85 #define __RT_MUTEX_INITIALIZER(mutexname) \
86 { .wait_lock = __RAW_SPIN_LOCK_UNLOCKED(mutexname.wait_lock) \
87 , .waiters = RB_ROOT_CACHED \
89 __DEBUG_RT_MUTEX_INITIALIZER(mutexname) \
90 __DEP_MAP_RT_MUTEX_INITIALIZER(mutexname)}
92 #define DEFINE_RT_MUTEX(mutexname) \
93 struct rt_mutex mutexname = __RT_MUTEX_INITIALIZER(mutexname)
96 * rt_mutex_is_locked - is the mutex locked
97 * @lock: the mutex to be queried
99 * Returns 1 if the mutex is locked, 0 if unlocked.
101 static inline int rt_mutex_is_locked(struct rt_mutex
*lock
)
103 return lock
->owner
!= NULL
;
106 extern void __rt_mutex_init(struct rt_mutex
*lock
, const char *name
, struct lock_class_key
*key
);
107 extern void rt_mutex_destroy(struct rt_mutex
*lock
);
109 #ifdef CONFIG_DEBUG_LOCK_ALLOC
110 extern void rt_mutex_lock_nested(struct rt_mutex
*lock
, unsigned int subclass
);
111 #define rt_mutex_lock(lock) rt_mutex_lock_nested(lock, 0)
113 extern void rt_mutex_lock(struct rt_mutex
*lock
);
114 #define rt_mutex_lock_nested(lock, subclass) rt_mutex_lock(lock)
117 extern int rt_mutex_lock_interruptible(struct rt_mutex
*lock
);
118 extern int rt_mutex_timed_lock(struct rt_mutex
*lock
,
119 struct hrtimer_sleeper
*timeout
);
121 extern int rt_mutex_trylock(struct rt_mutex
*lock
);
123 extern void rt_mutex_unlock(struct rt_mutex
*lock
);