1
2
3
4
5
6
7
8
9
10
11#ifndef __LINUX_MUTEX_H
12#define __LINUX_MUTEX_H
13
14#include <asm/current.h>
15#include <linux/list.h>
16#include <linux/spinlock_types.h>
17#include <linux/lockdep.h>
18#include <linux/atomic.h>
19#include <asm/processor.h>
20#include <linux/osq_lock.h>
21#include <linux/debug_locks.h>
22
23struct ww_acquire_ctx;
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53struct mutex {
54 atomic_long_t owner;
55 spinlock_t wait_lock;
56#ifdef CONFIG_MUTEX_SPIN_ON_OWNER
57 struct optimistic_spin_queue osq;
58#endif
59 struct list_head wait_list;
60#ifdef CONFIG_DEBUG_MUTEXES
61 void *magic;
62#endif
63#ifdef CONFIG_DEBUG_LOCK_ALLOC
64 struct lockdep_map dep_map;
65#endif
66};
67
68
69
70
71
72
73static inline struct task_struct *__mutex_owner(struct mutex *lock)
74{
75 return (struct task_struct *)(atomic_long_read(&lock->owner) & ~0x07);
76}
77
78
79
80
81
82struct mutex_waiter {
83 struct list_head list;
84 struct task_struct *task;
85 struct ww_acquire_ctx *ww_ctx;
86#ifdef CONFIG_DEBUG_MUTEXES
87 void *magic;
88#endif
89};
90
91#ifdef CONFIG_DEBUG_MUTEXES
92
93#define __DEBUG_MUTEX_INITIALIZER(lockname) \
94 , .magic = &lockname
95
96extern void mutex_destroy(struct mutex *lock);
97
98#else
99
100# define __DEBUG_MUTEX_INITIALIZER(lockname)
101
102static inline void mutex_destroy(struct mutex *lock) {}
103
104#endif
105
106
107
108
109
110
111
112
113
114#define mutex_init(mutex) \
115do { \
116 static struct lock_class_key __key; \
117 \
118 __mutex_init((mutex), #mutex, &__key); \
119} while (0)
120
121#ifdef CONFIG_DEBUG_LOCK_ALLOC
122# define __DEP_MAP_MUTEX_INITIALIZER(lockname) \
123 , .dep_map = { .name = #lockname }
124#else
125# define __DEP_MAP_MUTEX_INITIALIZER(lockname)
126#endif
127
128#define __MUTEX_INITIALIZER(lockname) \
129 { .owner = ATOMIC_LONG_INIT(0) \
130 , .wait_lock = __SPIN_LOCK_UNLOCKED(lockname.wait_lock) \
131 , .wait_list = LIST_HEAD_INIT(lockname.wait_list) \
132 __DEBUG_MUTEX_INITIALIZER(lockname) \
133 __DEP_MAP_MUTEX_INITIALIZER(lockname) }
134
135#define DEFINE_MUTEX(mutexname) \
136 struct mutex mutexname = __MUTEX_INITIALIZER(mutexname)
137
138extern void __mutex_init(struct mutex *lock, const char *name,
139 struct lock_class_key *key);
140
141
142
143
144
145
146
147static inline bool mutex_is_locked(struct mutex *lock)
148{
149 return __mutex_owner(lock) != NULL;
150}
151
152
153
154
155
156#ifdef CONFIG_DEBUG_LOCK_ALLOC
157extern void mutex_lock_nested(struct mutex *lock, unsigned int subclass);
158extern void _mutex_lock_nest_lock(struct mutex *lock, struct lockdep_map *nest_lock);
159
160extern int __must_check mutex_lock_interruptible_nested(struct mutex *lock,
161 unsigned int subclass);
162extern int __must_check mutex_lock_killable_nested(struct mutex *lock,
163 unsigned int subclass);
164extern void mutex_lock_io_nested(struct mutex *lock, unsigned int subclass);
165
166#define mutex_lock(lock) mutex_lock_nested(lock, 0)
167#define mutex_lock_interruptible(lock) mutex_lock_interruptible_nested(lock, 0)
168#define mutex_lock_killable(lock) mutex_lock_killable_nested(lock, 0)
169#define mutex_lock_io(lock) mutex_lock_io_nested(lock, 0)
170
171#define mutex_lock_nest_lock(lock, nest_lock) \
172do { \
173 typecheck(struct lockdep_map *, &(nest_lock)->dep_map); \
174 _mutex_lock_nest_lock(lock, &(nest_lock)->dep_map); \
175} while (0)
176
177#else
178extern void mutex_lock(struct mutex *lock);
179extern int __must_check mutex_lock_interruptible(struct mutex *lock);
180extern int __must_check mutex_lock_killable(struct mutex *lock);
181extern void mutex_lock_io(struct mutex *lock);
182
183# define mutex_lock_nested(lock, subclass) mutex_lock(lock)
184# define mutex_lock_interruptible_nested(lock, subclass) mutex_lock_interruptible(lock)
185# define mutex_lock_killable_nested(lock, subclass) mutex_lock_killable(lock)
186# define mutex_lock_nest_lock(lock, nest_lock) mutex_lock(lock)
187# define mutex_lock_io_nested(lock, subclass) mutex_lock(lock)
188#endif
189
190
191
192
193
194
195
196extern int mutex_trylock(struct mutex *lock);
197extern void mutex_unlock(struct mutex *lock);
198
199extern int atomic_dec_and_mutex_lock(atomic_t *cnt, struct mutex *lock);
200
201
202
203
204
205enum mutex_trylock_recursive_enum {
206 MUTEX_TRYLOCK_FAILED = 0,
207 MUTEX_TRYLOCK_SUCCESS = 1,
208 MUTEX_TRYLOCK_RECURSIVE,
209};
210
211
212
213
214
215
216
217
218
219
220
221
222
223static inline __must_check enum mutex_trylock_recursive_enum
224mutex_trylock_recursive(struct mutex *lock)
225{
226 if (unlikely(__mutex_owner(lock) == current))
227 return MUTEX_TRYLOCK_RECURSIVE;
228
229 return mutex_trylock(lock);
230}
231
232#endif
233