2 * RT-Mutexes: simple blocking mutual exclusion locks with PI support
4 * started by Ingo Molnar and Thomas Gleixner.
6 * Copyright (C) 2004-2006 Red Hat, Inc., Ingo Molnar <mingo@redhat.com>
7 * Copyright (C) 2005-2006 Timesys Corp., Thomas Gleixner <tglx@timesys.com>
8 * Copyright (C) 2005 Kihon Technologies Inc., Steven Rostedt
9 * Copyright (C) 2006 Esben Nielsen
11 * See Documentation/rt-mutex-design.txt for details.
13 #include <linux/spinlock.h>
14 #include <linux/module.h>
15 #include <linux/sched.h>
16 #include <linux/timer.h>
18 #include "rtmutex_common.h"
21 * lock->owner state tracking:
23 * lock->owner holds the task_struct pointer of the owner. Bit 0
24 * is used to keep track of the "lock has waiters" state.
27 * NULL 0 lock is free (fast acquire possible)
28 * NULL 1 lock is free and has waiters and the top waiter
29 * is going to take the lock*
30 * taskpointer 0 lock is held (fast release possible)
31 * taskpointer 1 lock is held and has waiters**
33 * The fast atomic compare exchange based acquire and release is only
34 * possible when bit 0 of lock->owner is 0.
36 * (*) It also can be a transitional state when grabbing the lock
37 * with ->wait_lock is held. To prevent any fast path cmpxchg to the lock,
38 * we need to set the bit0 before looking at the lock, and the owner may be
39 * NULL in this small time, hence this can be a transitional state.
41 * (**) There is a small time when bit 0 is set but there are no
42 * waiters. This can happen when grabbing the lock in the slow path.
43 * To prevent a cmpxchg of the owner releasing the lock, we need to
44 * set this bit before looking at the lock.
48 rt_mutex_set_owner(struct rt_mutex
*lock
, struct task_struct
*owner
)
50 unsigned long val
= (unsigned long)owner
;
52 if (rt_mutex_has_waiters(lock
))
53 val
|= RT_MUTEX_HAS_WAITERS
;
55 lock
->owner
= (struct task_struct
*)val
;
58 static inline void clear_rt_mutex_waiters(struct rt_mutex
*lock
)
60 lock
->owner
= (struct task_struct
*)
61 ((unsigned long)lock
->owner
& ~RT_MUTEX_HAS_WAITERS
);
64 static void fixup_rt_mutex_waiters(struct rt_mutex
*lock
)
66 if (!rt_mutex_has_waiters(lock
))
67 clear_rt_mutex_waiters(lock
);
71 * We can speed up the acquire/release, if the architecture
72 * supports cmpxchg and if there's no debugging state to be set up
74 #if defined(__HAVE_ARCH_CMPXCHG) && !defined(CONFIG_DEBUG_RT_MUTEXES)
75 # define rt_mutex_cmpxchg(l,c,n) (cmpxchg(&l->owner, c, n) == c)
76 static inline void mark_rt_mutex_waiters(struct rt_mutex
*lock
)
78 unsigned long owner
, *p
= (unsigned long *) &lock
->owner
;
82 } while (cmpxchg(p
, owner
, owner
| RT_MUTEX_HAS_WAITERS
) != owner
);
85 # define rt_mutex_cmpxchg(l,c,n) (0)
86 static inline void mark_rt_mutex_waiters(struct rt_mutex
*lock
)
88 lock
->owner
= (struct task_struct
*)
89 ((unsigned long)lock
->owner
| RT_MUTEX_HAS_WAITERS
);
94 * Calculate task priority from the waiter list priority
96 * Return task->normal_prio when the waiter list is empty or when
97 * the waiter is not allowed to do priority boosting
99 int rt_mutex_getprio(struct task_struct
*task
)
101 if (likely(!task_has_pi_waiters(task
)))
102 return task
->normal_prio
;
104 return min(task_top_pi_waiter(task
)->pi_list_entry
.prio
,
109 * Adjust the priority of a task, after its pi_waiters got modified.
111 * This can be both boosting and unboosting. task->pi_lock must be held.
113 static void __rt_mutex_adjust_prio(struct task_struct
*task
)
115 int prio
= rt_mutex_getprio(task
);
117 if (task
->prio
!= prio
)
118 rt_mutex_setprio(task
, prio
);
122 * Adjust task priority (undo boosting). Called from the exit path of
123 * rt_mutex_slowunlock() and rt_mutex_slowlock().
125 * (Note: We do this outside of the protection of lock->wait_lock to
126 * allow the lock to be taken while or before we readjust the priority
127 * of task. We do not use the spin_xx_mutex() variants here as we are
128 * outside of the debug path.)
130 static void rt_mutex_adjust_prio(struct task_struct
*task
)
134 raw_spin_lock_irqsave(&task
->pi_lock
, flags
);
135 __rt_mutex_adjust_prio(task
);
136 raw_spin_unlock_irqrestore(&task
->pi_lock
, flags
);
140 * Max number of times we'll walk the boosting chain:
142 int max_lock_depth
= 1024;
145 * Adjust the priority chain. Also used for deadlock detection.
146 * Decreases task's usage by one - may thus free the task.
147 * Returns 0 or -EDEADLK.
149 static int rt_mutex_adjust_prio_chain(struct task_struct
*task
,
151 struct rt_mutex
*orig_lock
,
152 struct rt_mutex_waiter
*orig_waiter
,
153 struct task_struct
*top_task
)
155 struct rt_mutex
*lock
;
156 struct rt_mutex_waiter
*waiter
, *top_waiter
= orig_waiter
;
157 int detect_deadlock
, ret
= 0, depth
= 0;
160 detect_deadlock
= debug_rt_mutex_detect_deadlock(orig_waiter
,
164 * The (de)boosting is a step by step approach with a lot of
165 * pitfalls. We want this to be preemptible and we want hold a
166 * maximum of two locks per step. So we have to check
167 * carefully whether things change under us.
170 if (++depth
> max_lock_depth
) {
174 * Print this only once. If the admin changes the limit,
175 * print a new message when reaching the limit again.
177 if (prev_max
!= max_lock_depth
) {
178 prev_max
= max_lock_depth
;
179 printk(KERN_WARNING
"Maximum lock depth %d reached "
180 "task: %s (%d)\n", max_lock_depth
,
181 top_task
->comm
, task_pid_nr(top_task
));
183 put_task_struct(task
);
185 return deadlock_detect
? -EDEADLK
: 0;
189 * Task can not go away as we did a get_task() before !
191 raw_spin_lock_irqsave(&task
->pi_lock
, flags
);
193 waiter
= task
->pi_blocked_on
;
195 * Check whether the end of the boosting chain has been
196 * reached or the state of the chain has changed while we
203 * Check the orig_waiter state. After we dropped the locks,
204 * the previous owner of the lock might have released the lock.
206 if (orig_waiter
&& !rt_mutex_owner(orig_lock
))
210 * Drop out, when the task has no waiters. Note,
211 * top_waiter can be NULL, when we are in the deboosting
214 if (top_waiter
&& (!task_has_pi_waiters(task
) ||
215 top_waiter
!= task_top_pi_waiter(task
)))
219 * When deadlock detection is off then we check, if further
220 * priority adjustment is necessary.
222 if (!detect_deadlock
&& waiter
->list_entry
.prio
== task
->prio
)
226 if (!raw_spin_trylock(&lock
->wait_lock
)) {
227 raw_spin_unlock_irqrestore(&task
->pi_lock
, flags
);
232 /* Deadlock detection */
233 if (lock
== orig_lock
|| rt_mutex_owner(lock
) == top_task
) {
234 debug_rt_mutex_deadlock(deadlock_detect
, orig_waiter
, lock
);
235 raw_spin_unlock(&lock
->wait_lock
);
236 ret
= deadlock_detect
? -EDEADLK
: 0;
240 top_waiter
= rt_mutex_top_waiter(lock
);
242 /* Requeue the waiter */
243 plist_del(&waiter
->list_entry
, &lock
->wait_list
);
244 waiter
->list_entry
.prio
= task
->prio
;
245 plist_add(&waiter
->list_entry
, &lock
->wait_list
);
247 /* Release the task */
248 raw_spin_unlock_irqrestore(&task
->pi_lock
, flags
);
249 if (!rt_mutex_owner(lock
)) {
251 * If the requeue above changed the top waiter, then we need
252 * to wake the new top waiter up to try to get the lock.
255 if (top_waiter
!= rt_mutex_top_waiter(lock
))
256 wake_up_process(rt_mutex_top_waiter(lock
)->task
);
257 raw_spin_unlock(&lock
->wait_lock
);
260 put_task_struct(task
);
262 /* Grab the next task */
263 task
= rt_mutex_owner(lock
);
264 get_task_struct(task
);
265 raw_spin_lock_irqsave(&task
->pi_lock
, flags
);
267 if (waiter
== rt_mutex_top_waiter(lock
)) {
268 /* Boost the owner */
269 plist_del(&top_waiter
->pi_list_entry
, &task
->pi_waiters
);
270 waiter
->pi_list_entry
.prio
= waiter
->list_entry
.prio
;
271 plist_add(&waiter
->pi_list_entry
, &task
->pi_waiters
);
272 __rt_mutex_adjust_prio(task
);
274 } else if (top_waiter
== waiter
) {
275 /* Deboost the owner */
276 plist_del(&waiter
->pi_list_entry
, &task
->pi_waiters
);
277 waiter
= rt_mutex_top_waiter(lock
);
278 waiter
->pi_list_entry
.prio
= waiter
->list_entry
.prio
;
279 plist_add(&waiter
->pi_list_entry
, &task
->pi_waiters
);
280 __rt_mutex_adjust_prio(task
);
283 raw_spin_unlock_irqrestore(&task
->pi_lock
, flags
);
285 top_waiter
= rt_mutex_top_waiter(lock
);
286 raw_spin_unlock(&lock
->wait_lock
);
288 if (!detect_deadlock
&& waiter
!= top_waiter
)
294 raw_spin_unlock_irqrestore(&task
->pi_lock
, flags
);
296 put_task_struct(task
);
302 * Try to take an rt-mutex
304 * Must be called with lock->wait_lock held.
306 * @lock: the lock to be acquired.
307 * @task: the task which wants to acquire the lock
308 * @waiter: the waiter that is queued to the lock's wait list. (could be NULL)
310 static int try_to_take_rt_mutex(struct rt_mutex
*lock
, struct task_struct
*task
,
311 struct rt_mutex_waiter
*waiter
)
314 * We have to be careful here if the atomic speedups are
315 * enabled, such that, when
316 * - no other waiter is on the lock
317 * - the lock has been released since we did the cmpxchg
318 * the lock can be released or taken while we are doing the
319 * checks and marking the lock with RT_MUTEX_HAS_WAITERS.
321 * The atomic acquire/release aware variant of
322 * mark_rt_mutex_waiters uses a cmpxchg loop. After setting
323 * the WAITERS bit, the atomic release / acquire can not
324 * happen anymore and lock->wait_lock protects us from the
327 * Note, that this might set lock->owner =
328 * RT_MUTEX_HAS_WAITERS in the case the lock is not contended
329 * any more. This is fixed up when we take the ownership.
330 * This is the transitional state explained at the top of this file.
332 mark_rt_mutex_waiters(lock
);
334 if (rt_mutex_owner(lock
))
338 * It will get the lock because of one of these conditions:
339 * 1) there is no waiter
340 * 2) higher priority than waiters
341 * 3) it is top waiter
343 if (rt_mutex_has_waiters(lock
)) {
344 if (task
->prio
>= rt_mutex_top_waiter(lock
)->list_entry
.prio
) {
345 if (!waiter
|| waiter
!= rt_mutex_top_waiter(lock
))
350 if (waiter
|| rt_mutex_has_waiters(lock
)) {
352 struct rt_mutex_waiter
*top
;
354 raw_spin_lock_irqsave(&task
->pi_lock
, flags
);
356 /* remove the queued waiter. */
358 plist_del(&waiter
->list_entry
, &lock
->wait_list
);
359 task
->pi_blocked_on
= NULL
;
363 * We have to enqueue the top waiter(if it exists) into
364 * task->pi_waiters list.
366 if (rt_mutex_has_waiters(lock
)) {
367 top
= rt_mutex_top_waiter(lock
);
368 top
->pi_list_entry
.prio
= top
->list_entry
.prio
;
369 plist_add(&top
->pi_list_entry
, &task
->pi_waiters
);
371 raw_spin_unlock_irqrestore(&task
->pi_lock
, flags
);
374 /* We got the lock. */
375 debug_rt_mutex_lock(lock
);
377 rt_mutex_set_owner(lock
, task
);
379 rt_mutex_deadlock_account_lock(lock
, task
);
385 * Task blocks on lock.
387 * Prepare waiter and propagate pi chain
389 * This must be called with lock->wait_lock held.
391 static int task_blocks_on_rt_mutex(struct rt_mutex
*lock
,
392 struct rt_mutex_waiter
*waiter
,
393 struct task_struct
*task
,
396 struct task_struct
*owner
= rt_mutex_owner(lock
);
397 struct rt_mutex_waiter
*top_waiter
= waiter
;
399 int chain_walk
= 0, res
;
401 raw_spin_lock_irqsave(&task
->pi_lock
, flags
);
402 __rt_mutex_adjust_prio(task
);
405 plist_node_init(&waiter
->list_entry
, task
->prio
);
406 plist_node_init(&waiter
->pi_list_entry
, task
->prio
);
408 /* Get the top priority waiter on the lock */
409 if (rt_mutex_has_waiters(lock
))
410 top_waiter
= rt_mutex_top_waiter(lock
);
411 plist_add(&waiter
->list_entry
, &lock
->wait_list
);
413 task
->pi_blocked_on
= waiter
;
415 raw_spin_unlock_irqrestore(&task
->pi_lock
, flags
);
420 if (waiter
== rt_mutex_top_waiter(lock
)) {
421 raw_spin_lock_irqsave(&owner
->pi_lock
, flags
);
422 plist_del(&top_waiter
->pi_list_entry
, &owner
->pi_waiters
);
423 plist_add(&waiter
->pi_list_entry
, &owner
->pi_waiters
);
425 __rt_mutex_adjust_prio(owner
);
426 if (owner
->pi_blocked_on
)
428 raw_spin_unlock_irqrestore(&owner
->pi_lock
, flags
);
430 else if (debug_rt_mutex_detect_deadlock(waiter
, detect_deadlock
))
437 * The owner can't disappear while holding a lock,
438 * so the owner struct is protected by wait_lock.
439 * Gets dropped in rt_mutex_adjust_prio_chain()!
441 get_task_struct(owner
);
443 raw_spin_unlock(&lock
->wait_lock
);
445 res
= rt_mutex_adjust_prio_chain(owner
, detect_deadlock
, lock
, waiter
,
448 raw_spin_lock(&lock
->wait_lock
);
454 * Wake up the next waiter on the lock.
456 * Remove the top waiter from the current tasks waiter list and wake it up.
458 * Called with lock->wait_lock held.
460 static void wakeup_next_waiter(struct rt_mutex
*lock
)
462 struct rt_mutex_waiter
*waiter
;
465 raw_spin_lock_irqsave(¤t
->pi_lock
, flags
);
467 waiter
= rt_mutex_top_waiter(lock
);
470 * Remove it from current->pi_waiters. We do not adjust a
471 * possible priority boost right now. We execute wakeup in the
472 * boosted mode and go back to normal after releasing
475 plist_del(&waiter
->pi_list_entry
, ¤t
->pi_waiters
);
477 rt_mutex_set_owner(lock
, NULL
);
479 raw_spin_unlock_irqrestore(¤t
->pi_lock
, flags
);
481 wake_up_process(waiter
->task
);
485 * Remove a waiter from a lock and give up
487 * Must be called with lock->wait_lock held and
488 * have just failed to try_to_take_rt_mutex().
490 static void remove_waiter(struct rt_mutex
*lock
,
491 struct rt_mutex_waiter
*waiter
)
493 int first
= (waiter
== rt_mutex_top_waiter(lock
));
494 struct task_struct
*owner
= rt_mutex_owner(lock
);
498 raw_spin_lock_irqsave(¤t
->pi_lock
, flags
);
499 plist_del(&waiter
->list_entry
, &lock
->wait_list
);
500 current
->pi_blocked_on
= NULL
;
501 raw_spin_unlock_irqrestore(¤t
->pi_lock
, flags
);
508 raw_spin_lock_irqsave(&owner
->pi_lock
, flags
);
510 plist_del(&waiter
->pi_list_entry
, &owner
->pi_waiters
);
512 if (rt_mutex_has_waiters(lock
)) {
513 struct rt_mutex_waiter
*next
;
515 next
= rt_mutex_top_waiter(lock
);
516 plist_add(&next
->pi_list_entry
, &owner
->pi_waiters
);
518 __rt_mutex_adjust_prio(owner
);
520 if (owner
->pi_blocked_on
)
523 raw_spin_unlock_irqrestore(&owner
->pi_lock
, flags
);
526 WARN_ON(!plist_node_empty(&waiter
->pi_list_entry
));
531 /* gets dropped in rt_mutex_adjust_prio_chain()! */
532 get_task_struct(owner
);
534 raw_spin_unlock(&lock
->wait_lock
);
536 rt_mutex_adjust_prio_chain(owner
, 0, lock
, NULL
, current
);
538 raw_spin_lock(&lock
->wait_lock
);
542 * Recheck the pi chain, in case we got a priority setting
544 * Called from sched_setscheduler
546 void rt_mutex_adjust_pi(struct task_struct
*task
)
548 struct rt_mutex_waiter
*waiter
;
551 raw_spin_lock_irqsave(&task
->pi_lock
, flags
);
553 waiter
= task
->pi_blocked_on
;
554 if (!waiter
|| waiter
->list_entry
.prio
== task
->prio
) {
555 raw_spin_unlock_irqrestore(&task
->pi_lock
, flags
);
559 raw_spin_unlock_irqrestore(&task
->pi_lock
, flags
);
561 /* gets dropped in rt_mutex_adjust_prio_chain()! */
562 get_task_struct(task
);
563 rt_mutex_adjust_prio_chain(task
, 0, NULL
, NULL
, task
);
567 * __rt_mutex_slowlock() - Perform the wait-wake-try-to-take loop
568 * @lock: the rt_mutex to take
569 * @state: the state the task should block in (TASK_INTERRUPTIBLE
570 * or TASK_UNINTERRUPTIBLE)
571 * @timeout: the pre-initialized and started timer, or NULL for none
572 * @waiter: the pre-initialized rt_mutex_waiter
574 * lock->wait_lock must be held by the caller.
577 __rt_mutex_slowlock(struct rt_mutex
*lock
, int state
,
578 struct hrtimer_sleeper
*timeout
,
579 struct rt_mutex_waiter
*waiter
)
585 /* Try to acquire the lock: */
586 if (try_to_take_rt_mutex(lock
, current
, waiter
))
590 * TASK_INTERRUPTIBLE checks for signals and
591 * timeout. Ignored otherwise.
593 if (unlikely(state
== TASK_INTERRUPTIBLE
)) {
594 /* Signal pending? */
595 if (signal_pending(current
))
597 if (timeout
&& !timeout
->task
)
603 raw_spin_unlock(&lock
->wait_lock
);
605 was_disabled
= irqs_disabled();
609 debug_rt_mutex_print_deadlock(waiter
);
611 schedule_rt_mutex(lock
);
616 raw_spin_lock(&lock
->wait_lock
);
617 set_current_state(state
);
624 * Slow path lock function:
627 rt_mutex_slowlock(struct rt_mutex
*lock
, int state
,
628 struct hrtimer_sleeper
*timeout
,
631 struct rt_mutex_waiter waiter
;
634 debug_rt_mutex_init_waiter(&waiter
);
636 raw_spin_lock(&lock
->wait_lock
);
638 /* Try to acquire the lock again: */
639 if (try_to_take_rt_mutex(lock
, current
, NULL
)) {
640 raw_spin_unlock(&lock
->wait_lock
);
644 set_current_state(state
);
646 /* Setup the timer, when timeout != NULL */
647 if (unlikely(timeout
)) {
648 hrtimer_start_expires(&timeout
->timer
, HRTIMER_MODE_ABS
);
649 if (!hrtimer_active(&timeout
->timer
))
650 timeout
->task
= NULL
;
653 ret
= task_blocks_on_rt_mutex(lock
, &waiter
, current
, detect_deadlock
);
656 ret
= __rt_mutex_slowlock(lock
, state
, timeout
, &waiter
);
658 set_current_state(TASK_RUNNING
);
661 remove_waiter(lock
, &waiter
);
664 * try_to_take_rt_mutex() sets the waiter bit
665 * unconditionally. We might have to fix that up.
667 fixup_rt_mutex_waiters(lock
);
669 raw_spin_unlock(&lock
->wait_lock
);
671 /* Remove pending timer: */
672 if (unlikely(timeout
))
673 hrtimer_cancel(&timeout
->timer
);
675 debug_rt_mutex_free_waiter(&waiter
);
681 * Slow path try-lock function:
684 rt_mutex_slowtrylock(struct rt_mutex
*lock
)
688 raw_spin_lock(&lock
->wait_lock
);
690 if (likely(rt_mutex_owner(lock
) != current
)) {
692 ret
= try_to_take_rt_mutex(lock
, current
, NULL
);
694 * try_to_take_rt_mutex() sets the lock waiters
695 * bit unconditionally. Clean this up.
697 fixup_rt_mutex_waiters(lock
);
700 raw_spin_unlock(&lock
->wait_lock
);
706 * Slow path to release a rt-mutex:
709 rt_mutex_slowunlock(struct rt_mutex
*lock
)
711 raw_spin_lock(&lock
->wait_lock
);
713 debug_rt_mutex_unlock(lock
);
715 rt_mutex_deadlock_account_unlock(current
);
717 if (!rt_mutex_has_waiters(lock
)) {
719 raw_spin_unlock(&lock
->wait_lock
);
723 wakeup_next_waiter(lock
);
725 raw_spin_unlock(&lock
->wait_lock
);
727 /* Undo pi boosting if necessary: */
728 rt_mutex_adjust_prio(current
);
732 * debug aware fast / slowpath lock,trylock,unlock
734 * The atomic acquire/release ops are compiled away, when either the
735 * architecture does not support cmpxchg or when debugging is enabled.
738 rt_mutex_fastlock(struct rt_mutex
*lock
, int state
,
740 int (*slowfn
)(struct rt_mutex
*lock
, int state
,
741 struct hrtimer_sleeper
*timeout
,
742 int detect_deadlock
))
744 if (!detect_deadlock
&& likely(rt_mutex_cmpxchg(lock
, NULL
, current
))) {
745 rt_mutex_deadlock_account_lock(lock
, current
);
748 return slowfn(lock
, state
, NULL
, detect_deadlock
);
752 rt_mutex_timed_fastlock(struct rt_mutex
*lock
, int state
,
753 struct hrtimer_sleeper
*timeout
, int detect_deadlock
,
754 int (*slowfn
)(struct rt_mutex
*lock
, int state
,
755 struct hrtimer_sleeper
*timeout
,
756 int detect_deadlock
))
758 if (!detect_deadlock
&& likely(rt_mutex_cmpxchg(lock
, NULL
, current
))) {
759 rt_mutex_deadlock_account_lock(lock
, current
);
762 return slowfn(lock
, state
, timeout
, detect_deadlock
);
766 rt_mutex_fasttrylock(struct rt_mutex
*lock
,
767 int (*slowfn
)(struct rt_mutex
*lock
))
769 if (likely(rt_mutex_cmpxchg(lock
, NULL
, current
))) {
770 rt_mutex_deadlock_account_lock(lock
, current
);
777 rt_mutex_fastunlock(struct rt_mutex
*lock
,
778 void (*slowfn
)(struct rt_mutex
*lock
))
780 if (likely(rt_mutex_cmpxchg(lock
, current
, NULL
)))
781 rt_mutex_deadlock_account_unlock(current
);
787 * rt_mutex_lock - lock a rt_mutex
789 * @lock: the rt_mutex to be locked
791 void __sched
rt_mutex_lock(struct rt_mutex
*lock
)
795 rt_mutex_fastlock(lock
, TASK_UNINTERRUPTIBLE
, 0, rt_mutex_slowlock
);
797 EXPORT_SYMBOL_GPL(rt_mutex_lock
);
800 * rt_mutex_lock_interruptible - lock a rt_mutex interruptible
802 * @lock: the rt_mutex to be locked
803 * @detect_deadlock: deadlock detection on/off
807 * -EINTR when interrupted by a signal
808 * -EDEADLK when the lock would deadlock (when deadlock detection is on)
810 int __sched
rt_mutex_lock_interruptible(struct rt_mutex
*lock
,
815 return rt_mutex_fastlock(lock
, TASK_INTERRUPTIBLE
,
816 detect_deadlock
, rt_mutex_slowlock
);
818 EXPORT_SYMBOL_GPL(rt_mutex_lock_interruptible
);
821 * rt_mutex_timed_lock - lock a rt_mutex interruptible
822 * the timeout structure is provided
825 * @lock: the rt_mutex to be locked
826 * @timeout: timeout structure or NULL (no timeout)
827 * @detect_deadlock: deadlock detection on/off
831 * -EINTR when interrupted by a signal
832 * -ETIMEDOUT when the timeout expired
833 * -EDEADLK when the lock would deadlock (when deadlock detection is on)
836 rt_mutex_timed_lock(struct rt_mutex
*lock
, struct hrtimer_sleeper
*timeout
,
841 return rt_mutex_timed_fastlock(lock
, TASK_INTERRUPTIBLE
, timeout
,
842 detect_deadlock
, rt_mutex_slowlock
);
844 EXPORT_SYMBOL_GPL(rt_mutex_timed_lock
);
847 * rt_mutex_trylock - try to lock a rt_mutex
849 * @lock: the rt_mutex to be locked
851 * Returns 1 on success and 0 on contention
853 int __sched
rt_mutex_trylock(struct rt_mutex
*lock
)
855 return rt_mutex_fasttrylock(lock
, rt_mutex_slowtrylock
);
857 EXPORT_SYMBOL_GPL(rt_mutex_trylock
);
860 * rt_mutex_unlock - unlock a rt_mutex
862 * @lock: the rt_mutex to be unlocked
864 void __sched
rt_mutex_unlock(struct rt_mutex
*lock
)
866 rt_mutex_fastunlock(lock
, rt_mutex_slowunlock
);
868 EXPORT_SYMBOL_GPL(rt_mutex_unlock
);
871 * rt_mutex_destroy - mark a mutex unusable
872 * @lock: the mutex to be destroyed
874 * This function marks the mutex uninitialized, and any subsequent
875 * use of the mutex is forbidden. The mutex must not be locked when
876 * this function is called.
878 void rt_mutex_destroy(struct rt_mutex
*lock
)
880 WARN_ON(rt_mutex_is_locked(lock
));
881 #ifdef CONFIG_DEBUG_RT_MUTEXES
886 EXPORT_SYMBOL_GPL(rt_mutex_destroy
);
889 * __rt_mutex_init - initialize the rt lock
891 * @lock: the rt lock to be initialized
893 * Initialize the rt lock to unlocked state.
895 * Initializing of a locked rt lock is not allowed
897 void __rt_mutex_init(struct rt_mutex
*lock
, const char *name
)
900 raw_spin_lock_init(&lock
->wait_lock
);
901 plist_head_init(&lock
->wait_list
);
903 debug_rt_mutex_init(lock
, name
);
905 EXPORT_SYMBOL_GPL(__rt_mutex_init
);
908 * rt_mutex_init_proxy_locked - initialize and lock a rt_mutex on behalf of a
911 * @lock: the rt_mutex to be locked
912 * @proxy_owner:the task to set as owner
914 * No locking. Caller has to do serializing itself
915 * Special API call for PI-futex support
917 void rt_mutex_init_proxy_locked(struct rt_mutex
*lock
,
918 struct task_struct
*proxy_owner
)
920 __rt_mutex_init(lock
, NULL
);
921 debug_rt_mutex_proxy_lock(lock
, proxy_owner
);
922 rt_mutex_set_owner(lock
, proxy_owner
);
923 rt_mutex_deadlock_account_lock(lock
, proxy_owner
);
927 * rt_mutex_proxy_unlock - release a lock on behalf of owner
929 * @lock: the rt_mutex to be locked
931 * No locking. Caller has to do serializing itself
932 * Special API call for PI-futex support
934 void rt_mutex_proxy_unlock(struct rt_mutex
*lock
,
935 struct task_struct
*proxy_owner
)
937 debug_rt_mutex_proxy_unlock(lock
);
938 rt_mutex_set_owner(lock
, NULL
);
939 rt_mutex_deadlock_account_unlock(proxy_owner
);
943 * rt_mutex_start_proxy_lock() - Start lock acquisition for another task
944 * @lock: the rt_mutex to take
945 * @waiter: the pre-initialized rt_mutex_waiter
946 * @task: the task to prepare
947 * @detect_deadlock: perform deadlock detection (1) or not (0)
950 * 0 - task blocked on lock
951 * 1 - acquired the lock for task, caller should wake it up
954 * Special API call for FUTEX_REQUEUE_PI support.
956 int rt_mutex_start_proxy_lock(struct rt_mutex
*lock
,
957 struct rt_mutex_waiter
*waiter
,
958 struct task_struct
*task
, int detect_deadlock
)
962 raw_spin_lock(&lock
->wait_lock
);
964 if (try_to_take_rt_mutex(lock
, task
, NULL
)) {
965 raw_spin_unlock(&lock
->wait_lock
);
969 ret
= task_blocks_on_rt_mutex(lock
, waiter
, task
, detect_deadlock
);
971 if (ret
&& !rt_mutex_owner(lock
)) {
973 * Reset the return value. We might have
974 * returned with -EDEADLK and the owner
975 * released the lock while we were walking the
976 * pi chain. Let the waiter sort it out.
982 remove_waiter(lock
, waiter
);
984 raw_spin_unlock(&lock
->wait_lock
);
986 debug_rt_mutex_print_deadlock(waiter
);
992 * rt_mutex_next_owner - return the next owner of the lock
994 * @lock: the rt lock query
996 * Returns the next owner of the lock or NULL
998 * Caller has to serialize against other accessors to the lock
1001 * Special API call for PI-futex support
1003 struct task_struct
*rt_mutex_next_owner(struct rt_mutex
*lock
)
1005 if (!rt_mutex_has_waiters(lock
))
1008 return rt_mutex_top_waiter(lock
)->task
;
1012 * rt_mutex_finish_proxy_lock() - Complete lock acquisition
1013 * @lock: the rt_mutex we were woken on
1014 * @to: the timeout, null if none. hrtimer should already have
1016 * @waiter: the pre-initialized rt_mutex_waiter
1017 * @detect_deadlock: perform deadlock detection (1) or not (0)
1019 * Complete the lock acquisition started our behalf by another thread.
1023 * <0 - error, one of -EINTR, -ETIMEDOUT, or -EDEADLK
1025 * Special API call for PI-futex requeue support
1027 int rt_mutex_finish_proxy_lock(struct rt_mutex
*lock
,
1028 struct hrtimer_sleeper
*to
,
1029 struct rt_mutex_waiter
*waiter
,
1030 int detect_deadlock
)
1034 raw_spin_lock(&lock
->wait_lock
);
1036 set_current_state(TASK_INTERRUPTIBLE
);
1038 ret
= __rt_mutex_slowlock(lock
, TASK_INTERRUPTIBLE
, to
, waiter
);
1040 set_current_state(TASK_RUNNING
);
1043 remove_waiter(lock
, waiter
);
1046 * try_to_take_rt_mutex() sets the waiter bit unconditionally. We might
1047 * have to fix that up.
1049 fixup_rt_mutex_waiters(lock
);
1051 raw_spin_unlock(&lock
->wait_lock
);