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
68struct ww_class;
69struct ww_acquire_ctx;
70
71struct ww_mutex {
72 struct mutex base;
73 struct ww_acquire_ctx *ctx;
74#ifdef CONFIG_DEBUG_MUTEXES
75 struct ww_class *ww_class;
76#endif
77};
78
79
80
81
82
83struct mutex_waiter {
84 struct list_head list;
85 struct task_struct *task;
86 struct ww_acquire_ctx *ww_ctx;
87#ifdef CONFIG_DEBUG_MUTEXES
88 void *magic;
89#endif
90};
91
92#ifdef CONFIG_DEBUG_MUTEXES
93
94#define __DEBUG_MUTEX_INITIALIZER(lockname) \
95 , .magic = &lockname
96
97extern void mutex_destroy(struct mutex *lock);
98
99#else
100
101# define __DEBUG_MUTEX_INITIALIZER(lockname)
102
103static inline void mutex_destroy(struct mutex *lock) {}
104
105#endif
106
107
108
109
110
111
112
113
114
115#define mutex_init(mutex) \
116do { \
117 static struct lock_class_key __key; \
118 \
119 __mutex_init((mutex), #mutex, &__key); \
120} while (0)
121
122#ifdef CONFIG_DEBUG_LOCK_ALLOC
123# define __DEP_MAP_MUTEX_INITIALIZER(lockname) \
124 , .dep_map = { \
125 .name = #lockname, \
126 .wait_type_inner = LD_WAIT_SLEEP, \
127 }
128#else
129# define __DEP_MAP_MUTEX_INITIALIZER(lockname)
130#endif
131
132#define __MUTEX_INITIALIZER(lockname) \
133 { .owner = ATOMIC_LONG_INIT(0) \
134 , .wait_lock = __SPIN_LOCK_UNLOCKED(lockname.wait_lock) \
135 , .wait_list = LIST_HEAD_INIT(lockname.wait_list) \
136 __DEBUG_MUTEX_INITIALIZER(lockname) \
137 __DEP_MAP_MUTEX_INITIALIZER(lockname) }
138
139#define DEFINE_MUTEX(mutexname) \
140 struct mutex mutexname = __MUTEX_INITIALIZER(mutexname)
141
142extern void __mutex_init(struct mutex *lock, const char *name,
143 struct lock_class_key *key);
144
145
146
147
148
149
150
151extern bool mutex_is_locked(struct mutex *lock);
152
153
154
155
156
157#ifdef CONFIG_DEBUG_LOCK_ALLOC
158extern void mutex_lock_nested(struct mutex *lock, unsigned int subclass);
159extern void _mutex_lock_nest_lock(struct mutex *lock, struct lockdep_map *nest_lock);
160
161extern int __must_check mutex_lock_interruptible_nested(struct mutex *lock,
162 unsigned int subclass);
163extern int __must_check mutex_lock_killable_nested(struct mutex *lock,
164 unsigned int subclass);
165extern void mutex_lock_io_nested(struct mutex *lock, unsigned int subclass);
166
167#define mutex_lock(lock) mutex_lock_nested(lock, 0)
168#define mutex_lock_interruptible(lock) mutex_lock_interruptible_nested(lock, 0)
169#define mutex_lock_killable(lock) mutex_lock_killable_nested(lock, 0)
170#define mutex_lock_io(lock) mutex_lock_io_nested(lock, 0)
171
172#define mutex_lock_nest_lock(lock, nest_lock) \
173do { \
174 typecheck(struct lockdep_map *, &(nest_lock)->dep_map); \
175 _mutex_lock_nest_lock(lock, &(nest_lock)->dep_map); \
176} while (0)
177
178#else
179extern void mutex_lock(struct mutex *lock);
180extern int __must_check mutex_lock_interruptible(struct mutex *lock);
181extern int __must_check mutex_lock_killable(struct mutex *lock);
182extern void mutex_lock_io(struct mutex *lock);
183
184# define mutex_lock_nested(lock, subclass) mutex_lock(lock)
185# define mutex_lock_interruptible_nested(lock, subclass) mutex_lock_interruptible(lock)
186# define mutex_lock_killable_nested(lock, subclass) mutex_lock_killable(lock)
187# define mutex_lock_nest_lock(lock, nest_lock) mutex_lock(lock)
188# define mutex_lock_io_nested(lock, subclass) mutex_lock(lock)
189#endif
190
191
192
193
194
195
196
197extern int mutex_trylock(struct mutex *lock);
198extern void mutex_unlock(struct mutex *lock);
199
200extern int atomic_dec_and_mutex_lock(atomic_t *cnt, struct mutex *lock);
201
202
203
204
205
206enum mutex_trylock_recursive_enum {
207 MUTEX_TRYLOCK_FAILED = 0,
208 MUTEX_TRYLOCK_SUCCESS = 1,
209 MUTEX_TRYLOCK_RECURSIVE,
210};
211
212
213
214
215
216
217
218
219
220
221
222
223
224extern __must_check enum mutex_trylock_recursive_enum
225mutex_trylock_recursive(struct mutex *lock);
226
227#endif
228