4 * Mutexes: blocking mutual exclusion locks
6 * Started by Ingo Molnar:
8 * Copyright (C) 2004, 2005, 2006 Red Hat, Inc., Ingo Molnar <mingo@redhat.com>
10 * Many thanks to Arjan van de Ven, Thomas Gleixner, Steven Rostedt and
11 * David Howells for suggestions and improvements.
13 * Also see Documentation/mutex-design.txt.
15 #include <linux/mutex.h>
16 #include <linux/sched.h>
17 #include <linux/module.h>
18 #include <linux/spinlock.h>
19 #include <linux/interrupt.h>
20 #include <linux/debug_locks.h>
23 * In the DEBUG case we are using the "NULL fastpath" for mutexes,
24 * which forces all calls into the slowpath:
26 #ifdef CONFIG_DEBUG_MUTEXES
27 # include "mutex-debug.h"
28 # include <asm-generic/mutex-null.h>
31 # include <asm/mutex.h>
35 * mutex_init - initialize the mutex
36 * @lock: the mutex to be initialized
37 * @key: the lock_class_key for the class; used by mutex lock debugging
39 * Initialize the mutex to unlocked state.
41 * It is not allowed to initialize an already locked mutex.
44 __mutex_init(struct mutex
*lock
, const char *name
, struct lock_class_key
*key
)
46 atomic_set(&lock
->count
, 1);
47 spin_lock_init(&lock
->wait_lock
);
48 INIT_LIST_HEAD(&lock
->wait_list
);
50 debug_mutex_init(lock
, name
, key
);
53 EXPORT_SYMBOL(__mutex_init
);
55 #ifndef CONFIG_DEBUG_LOCK_ALLOC
57 * We split the mutex lock/unlock logic into separate fastpath and
58 * slowpath functions, to reduce the register pressure on the fastpath.
59 * We also put the fastpath first in the kernel image, to make sure the
60 * branch is predicted by the CPU as default-untaken.
62 static __used noinline
void __sched
63 __mutex_lock_slowpath(atomic_t
*lock_count
);
66 * mutex_lock - acquire the mutex
67 * @lock: the mutex to be acquired
69 * Lock the mutex exclusively for this task. If the mutex is not
70 * available right now, it will sleep until it can get it.
72 * The mutex must later on be released by the same task that
73 * acquired it. Recursive locking is not allowed. The task
74 * may not exit without first unlocking the mutex. Also, kernel
75 * memory where the mutex resides mutex must not be freed with
76 * the mutex still locked. The mutex must first be initialized
77 * (or statically defined) before it can be locked. memset()-ing
78 * the mutex to 0 is not allowed.
80 * ( The CONFIG_DEBUG_MUTEXES .config option turns on debugging
81 * checks that will enforce the restrictions and will also do
82 * deadlock debugging. )
84 * This function is similar to (but not equivalent to) down().
86 void inline __sched
mutex_lock(struct mutex
*lock
)
90 * The locking fastpath is the 1->0 transition from
91 * 'unlocked' into 'locked' state.
93 __mutex_fastpath_lock(&lock
->count
, __mutex_lock_slowpath
);
96 EXPORT_SYMBOL(mutex_lock
);
99 static __used noinline
void __sched
__mutex_unlock_slowpath(atomic_t
*lock_count
);
102 * mutex_unlock - release the mutex
103 * @lock: the mutex to be released
105 * Unlock a mutex that has been locked by this task previously.
107 * This function must not be used in interrupt context. Unlocking
108 * of a not locked mutex is not allowed.
110 * This function is similar to (but not equivalent to) up().
112 void __sched
mutex_unlock(struct mutex
*lock
)
115 * The unlocking fastpath is the 0->1 transition from 'locked'
116 * into 'unlocked' state:
118 __mutex_fastpath_unlock(&lock
->count
, __mutex_unlock_slowpath
);
121 EXPORT_SYMBOL(mutex_unlock
);
124 * Lock a mutex (possibly interruptible), slowpath:
126 static inline int __sched
127 __mutex_lock_common(struct mutex
*lock
, long state
, unsigned int subclass
,
130 struct task_struct
*task
= current
;
131 struct mutex_waiter waiter
;
132 unsigned int old_val
;
135 spin_lock_mutex(&lock
->wait_lock
, flags
);
137 debug_mutex_lock_common(lock
, &waiter
);
138 mutex_acquire(&lock
->dep_map
, subclass
, 0, ip
);
139 debug_mutex_add_waiter(lock
, &waiter
, task_thread_info(task
));
141 /* add waiting tasks to the end of the waitqueue (FIFO): */
142 list_add_tail(&waiter
.list
, &lock
->wait_list
);
145 old_val
= atomic_xchg(&lock
->count
, -1);
149 lock_contended(&lock
->dep_map
, ip
);
153 * Lets try to take the lock again - this is needed even if
154 * we get here for the first time (shortly after failing to
155 * acquire the lock), to make sure that we get a wakeup once
156 * it's unlocked. Later on, if we sleep, this is the
157 * operation that gives us the lock. We xchg it to -1, so
158 * that when we release the lock, we properly wake up the
161 old_val
= atomic_xchg(&lock
->count
, -1);
166 * got a signal? (This code gets eliminated in the
167 * TASK_UNINTERRUPTIBLE case.)
169 if (unlikely(signal_pending_state(state
, task
))) {
170 mutex_remove_waiter(lock
, &waiter
,
171 task_thread_info(task
));
172 mutex_release(&lock
->dep_map
, 1, ip
);
173 spin_unlock_mutex(&lock
->wait_lock
, flags
);
175 debug_mutex_free_waiter(&waiter
);
178 __set_task_state(task
, state
);
180 /* didnt get the lock, go to sleep: */
181 spin_unlock_mutex(&lock
->wait_lock
, flags
);
183 spin_lock_mutex(&lock
->wait_lock
, flags
);
187 lock_acquired(&lock
->dep_map
, ip
);
188 /* got the lock - rejoice! */
189 mutex_remove_waiter(lock
, &waiter
, task_thread_info(task
));
190 debug_mutex_set_owner(lock
, task_thread_info(task
));
192 /* set it to 0 if there are no waiters left: */
193 if (likely(list_empty(&lock
->wait_list
)))
194 atomic_set(&lock
->count
, 0);
196 spin_unlock_mutex(&lock
->wait_lock
, flags
);
198 debug_mutex_free_waiter(&waiter
);
203 #ifdef CONFIG_DEBUG_LOCK_ALLOC
205 mutex_lock_nested(struct mutex
*lock
, unsigned int subclass
)
208 __mutex_lock_common(lock
, TASK_UNINTERRUPTIBLE
, subclass
, _RET_IP_
);
211 EXPORT_SYMBOL_GPL(mutex_lock_nested
);
214 mutex_lock_killable_nested(struct mutex
*lock
, unsigned int subclass
)
217 return __mutex_lock_common(lock
, TASK_KILLABLE
, subclass
, _RET_IP_
);
219 EXPORT_SYMBOL_GPL(mutex_lock_killable_nested
);
222 mutex_lock_interruptible_nested(struct mutex
*lock
, unsigned int subclass
)
225 return __mutex_lock_common(lock
, TASK_INTERRUPTIBLE
, subclass
, _RET_IP_
);
228 EXPORT_SYMBOL_GPL(mutex_lock_interruptible_nested
);
232 * Release the lock, slowpath:
235 __mutex_unlock_common_slowpath(atomic_t
*lock_count
, int nested
)
237 struct mutex
*lock
= container_of(lock_count
, struct mutex
, count
);
240 spin_lock_mutex(&lock
->wait_lock
, flags
);
241 mutex_release(&lock
->dep_map
, nested
, _RET_IP_
);
242 debug_mutex_unlock(lock
);
245 * some architectures leave the lock unlocked in the fastpath failure
246 * case, others need to leave it locked. In the later case we have to
249 if (__mutex_slowpath_needs_to_unlock())
250 atomic_set(&lock
->count
, 1);
252 if (!list_empty(&lock
->wait_list
)) {
253 /* get the first entry from the wait-list: */
254 struct mutex_waiter
*waiter
=
255 list_entry(lock
->wait_list
.next
,
256 struct mutex_waiter
, list
);
258 debug_mutex_wake_waiter(lock
, waiter
);
260 wake_up_process(waiter
->task
);
263 debug_mutex_clear_owner(lock
);
265 spin_unlock_mutex(&lock
->wait_lock
, flags
);
269 * Release the lock, slowpath:
271 static __used noinline
void
272 __mutex_unlock_slowpath(atomic_t
*lock_count
)
274 __mutex_unlock_common_slowpath(lock_count
, 1);
277 #ifndef CONFIG_DEBUG_LOCK_ALLOC
279 * Here come the less common (and hence less performance-critical) APIs:
280 * mutex_lock_interruptible() and mutex_trylock().
282 static noinline
int __sched
283 __mutex_lock_killable_slowpath(atomic_t
*lock_count
);
285 static noinline
int __sched
286 __mutex_lock_interruptible_slowpath(atomic_t
*lock_count
);
289 * mutex_lock_interruptible - acquire the mutex, interruptable
290 * @lock: the mutex to be acquired
292 * Lock the mutex like mutex_lock(), and return 0 if the mutex has
293 * been acquired or sleep until the mutex becomes available. If a
294 * signal arrives while waiting for the lock then this function
297 * This function is similar to (but not equivalent to) down_interruptible().
299 int __sched
mutex_lock_interruptible(struct mutex
*lock
)
302 return __mutex_fastpath_lock_retval
303 (&lock
->count
, __mutex_lock_interruptible_slowpath
);
306 EXPORT_SYMBOL(mutex_lock_interruptible
);
308 int __sched
mutex_lock_killable(struct mutex
*lock
)
311 return __mutex_fastpath_lock_retval
312 (&lock
->count
, __mutex_lock_killable_slowpath
);
314 EXPORT_SYMBOL(mutex_lock_killable
);
316 static __used noinline
void __sched
317 __mutex_lock_slowpath(atomic_t
*lock_count
)
319 struct mutex
*lock
= container_of(lock_count
, struct mutex
, count
);
321 __mutex_lock_common(lock
, TASK_UNINTERRUPTIBLE
, 0, _RET_IP_
);
324 static noinline
int __sched
325 __mutex_lock_killable_slowpath(atomic_t
*lock_count
)
327 struct mutex
*lock
= container_of(lock_count
, struct mutex
, count
);
329 return __mutex_lock_common(lock
, TASK_KILLABLE
, 0, _RET_IP_
);
332 static noinline
int __sched
333 __mutex_lock_interruptible_slowpath(atomic_t
*lock_count
)
335 struct mutex
*lock
= container_of(lock_count
, struct mutex
, count
);
337 return __mutex_lock_common(lock
, TASK_INTERRUPTIBLE
, 0, _RET_IP_
);
342 * Spinlock based trylock, we take the spinlock and check whether we
345 static inline int __mutex_trylock_slowpath(atomic_t
*lock_count
)
347 struct mutex
*lock
= container_of(lock_count
, struct mutex
, count
);
351 spin_lock_mutex(&lock
->wait_lock
, flags
);
353 prev
= atomic_xchg(&lock
->count
, -1);
354 if (likely(prev
== 1)) {
355 debug_mutex_set_owner(lock
, current_thread_info());
356 mutex_acquire(&lock
->dep_map
, 0, 1, _RET_IP_
);
358 /* Set it back to 0 if there are no waiters: */
359 if (likely(list_empty(&lock
->wait_list
)))
360 atomic_set(&lock
->count
, 0);
362 spin_unlock_mutex(&lock
->wait_lock
, flags
);
368 * mutex_trylock - try acquire the mutex, without waiting
369 * @lock: the mutex to be acquired
371 * Try to acquire the mutex atomically. Returns 1 if the mutex
372 * has been acquired successfully, and 0 on contention.
374 * NOTE: this function follows the spin_trylock() convention, so
375 * it is negated to the down_trylock() return values! Be careful
376 * about this when converting semaphore users to mutexes.
378 * This function must not be used in interrupt context. The
379 * mutex must be released by the same task that acquired it.
381 int __sched
mutex_trylock(struct mutex
*lock
)
383 return __mutex_fastpath_trylock(&lock
->count
,
384 __mutex_trylock_slowpath
);
387 EXPORT_SYMBOL(mutex_trylock
);