rtmutex.c 42.7 KB
Newer Older
I
Ingo Molnar 已提交
1 2 3 4 5 6 7 8 9
/*
 * RT-Mutexes: simple blocking mutual exclusion locks with PI support
 *
 * started by Ingo Molnar and Thomas Gleixner.
 *
 *  Copyright (C) 2004-2006 Red Hat, Inc., Ingo Molnar <mingo@redhat.com>
 *  Copyright (C) 2005-2006 Timesys Corp., Thomas Gleixner <tglx@timesys.com>
 *  Copyright (C) 2005 Kihon Technologies Inc., Steven Rostedt
 *  Copyright (C) 2006 Esben Nielsen
10
 *
11
 *  See Documentation/locking/rt-mutex-design.txt for details.
I
Ingo Molnar 已提交
12 13
 */
#include <linux/spinlock.h>
14
#include <linux/export.h>
I
Ingo Molnar 已提交
15
#include <linux/sched.h>
16
#include <linux/sched/rt.h>
17
#include <linux/sched/deadline.h>
I
Ingo Molnar 已提交
18 19 20 21 22 23 24
#include <linux/timer.h>

#include "rtmutex_common.h"

/*
 * lock->owner state tracking:
 *
25 26
 * lock->owner holds the task_struct pointer of the owner. Bit 0
 * is used to keep track of the "lock has waiters" state.
I
Ingo Molnar 已提交
27
 *
28 29 30 31 32 33
 * owner	bit0
 * NULL		0	lock is free (fast acquire possible)
 * NULL		1	lock is free and has waiters and the top waiter
 *				is going to take the lock*
 * taskpointer	0	lock is held (fast release possible)
 * taskpointer	1	lock is held and has waiters**
I
Ingo Molnar 已提交
34 35
 *
 * The fast atomic compare exchange based acquire and release is only
36 37 38 39 40 41
 * possible when bit 0 of lock->owner is 0.
 *
 * (*) It also can be a transitional state when grabbing the lock
 * with ->wait_lock is held. To prevent any fast path cmpxchg to the lock,
 * we need to set the bit0 before looking at the lock, and the owner may be
 * NULL in this small time, hence this can be a transitional state.
I
Ingo Molnar 已提交
42
 *
43 44 45 46
 * (**) There is a small time when bit 0 is set but there are no
 * waiters. This can happen when grabbing the lock in the slow path.
 * To prevent a cmpxchg of the owner releasing the lock, we need to
 * set this bit before looking at the lock.
I
Ingo Molnar 已提交
47 48
 */

49
static void
50
rt_mutex_set_owner(struct rt_mutex *lock, struct task_struct *owner)
I
Ingo Molnar 已提交
51
{
52
	unsigned long val = (unsigned long)owner;
I
Ingo Molnar 已提交
53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71

	if (rt_mutex_has_waiters(lock))
		val |= RT_MUTEX_HAS_WAITERS;

	lock->owner = (struct task_struct *)val;
}

static inline void clear_rt_mutex_waiters(struct rt_mutex *lock)
{
	lock->owner = (struct task_struct *)
			((unsigned long)lock->owner & ~RT_MUTEX_HAS_WAITERS);
}

static void fixup_rt_mutex_waiters(struct rt_mutex *lock)
{
	if (!rt_mutex_has_waiters(lock))
		clear_rt_mutex_waiters(lock);
}

72 73 74 75 76 77 78 79 80 81 82 83 84 85
/*
 * We can speed up the acquire/release, if the architecture
 * supports cmpxchg and if there's no debugging state to be set up
 */
#if defined(__HAVE_ARCH_CMPXCHG) && !defined(CONFIG_DEBUG_RT_MUTEXES)
# define rt_mutex_cmpxchg(l,c,n)	(cmpxchg(&l->owner, c, n) == c)
static inline void mark_rt_mutex_waiters(struct rt_mutex *lock)
{
	unsigned long owner, *p = (unsigned long *) &lock->owner;

	do {
		owner = *p;
	} while (cmpxchg(p, owner, owner | RT_MUTEX_HAS_WAITERS) != owner);
}
T
Thomas Gleixner 已提交
86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126

/*
 * Safe fastpath aware unlock:
 * 1) Clear the waiters bit
 * 2) Drop lock->wait_lock
 * 3) Try to unlock the lock with cmpxchg
 */
static inline bool unlock_rt_mutex_safe(struct rt_mutex *lock)
	__releases(lock->wait_lock)
{
	struct task_struct *owner = rt_mutex_owner(lock);

	clear_rt_mutex_waiters(lock);
	raw_spin_unlock(&lock->wait_lock);
	/*
	 * If a new waiter comes in between the unlock and the cmpxchg
	 * we have two situations:
	 *
	 * unlock(wait_lock);
	 *					lock(wait_lock);
	 * cmpxchg(p, owner, 0) == owner
	 *					mark_rt_mutex_waiters(lock);
	 *					acquire(lock);
	 * or:
	 *
	 * unlock(wait_lock);
	 *					lock(wait_lock);
	 *					mark_rt_mutex_waiters(lock);
	 *
	 * cmpxchg(p, owner, 0) != owner
	 *					enqueue_waiter();
	 *					unlock(wait_lock);
	 * lock(wait_lock);
	 * wake waiter();
	 * unlock(wait_lock);
	 *					lock(wait_lock);
	 *					acquire(lock);
	 */
	return rt_mutex_cmpxchg(lock, owner, NULL);
}

127 128 129 130 131 132 133
#else
# define rt_mutex_cmpxchg(l,c,n)	(0)
static inline void mark_rt_mutex_waiters(struct rt_mutex *lock)
{
	lock->owner = (struct task_struct *)
			((unsigned long)lock->owner | RT_MUTEX_HAS_WAITERS);
}
T
Thomas Gleixner 已提交
134 135 136 137 138 139 140 141 142 143 144

/*
 * Simple slow path only version: lock->owner is protected by lock->wait_lock.
 */
static inline bool unlock_rt_mutex_safe(struct rt_mutex *lock)
	__releases(lock->wait_lock)
{
	lock->owner = NULL;
	raw_spin_unlock(&lock->wait_lock);
	return true;
}
145 146
#endif

147 148 149 150
static inline int
rt_mutex_waiter_less(struct rt_mutex_waiter *left,
		     struct rt_mutex_waiter *right)
{
151
	if (left->prio < right->prio)
152 153 154
		return 1;

	/*
155 156 157 158
	 * If both waiters have dl_prio(), we check the deadlines of the
	 * associated tasks.
	 * If left waiter has a dl_prio(), and we didn't return 1 above,
	 * then right waiter has a dl_prio() too.
159
	 */
160
	if (dl_prio(left->prio))
161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243
		return (left->task->dl.deadline < right->task->dl.deadline);

	return 0;
}

static void
rt_mutex_enqueue(struct rt_mutex *lock, struct rt_mutex_waiter *waiter)
{
	struct rb_node **link = &lock->waiters.rb_node;
	struct rb_node *parent = NULL;
	struct rt_mutex_waiter *entry;
	int leftmost = 1;

	while (*link) {
		parent = *link;
		entry = rb_entry(parent, struct rt_mutex_waiter, tree_entry);
		if (rt_mutex_waiter_less(waiter, entry)) {
			link = &parent->rb_left;
		} else {
			link = &parent->rb_right;
			leftmost = 0;
		}
	}

	if (leftmost)
		lock->waiters_leftmost = &waiter->tree_entry;

	rb_link_node(&waiter->tree_entry, parent, link);
	rb_insert_color(&waiter->tree_entry, &lock->waiters);
}

static void
rt_mutex_dequeue(struct rt_mutex *lock, struct rt_mutex_waiter *waiter)
{
	if (RB_EMPTY_NODE(&waiter->tree_entry))
		return;

	if (lock->waiters_leftmost == &waiter->tree_entry)
		lock->waiters_leftmost = rb_next(&waiter->tree_entry);

	rb_erase(&waiter->tree_entry, &lock->waiters);
	RB_CLEAR_NODE(&waiter->tree_entry);
}

static void
rt_mutex_enqueue_pi(struct task_struct *task, struct rt_mutex_waiter *waiter)
{
	struct rb_node **link = &task->pi_waiters.rb_node;
	struct rb_node *parent = NULL;
	struct rt_mutex_waiter *entry;
	int leftmost = 1;

	while (*link) {
		parent = *link;
		entry = rb_entry(parent, struct rt_mutex_waiter, pi_tree_entry);
		if (rt_mutex_waiter_less(waiter, entry)) {
			link = &parent->rb_left;
		} else {
			link = &parent->rb_right;
			leftmost = 0;
		}
	}

	if (leftmost)
		task->pi_waiters_leftmost = &waiter->pi_tree_entry;

	rb_link_node(&waiter->pi_tree_entry, parent, link);
	rb_insert_color(&waiter->pi_tree_entry, &task->pi_waiters);
}

static void
rt_mutex_dequeue_pi(struct task_struct *task, struct rt_mutex_waiter *waiter)
{
	if (RB_EMPTY_NODE(&waiter->pi_tree_entry))
		return;

	if (task->pi_waiters_leftmost == &waiter->pi_tree_entry)
		task->pi_waiters_leftmost = rb_next(&waiter->pi_tree_entry);

	rb_erase(&waiter->pi_tree_entry, &task->pi_waiters);
	RB_CLEAR_NODE(&waiter->pi_tree_entry);
}

I
Ingo Molnar 已提交
244
/*
245
 * Calculate task priority from the waiter tree priority
I
Ingo Molnar 已提交
246
 *
247
 * Return task->normal_prio when the waiter tree is empty or when
I
Ingo Molnar 已提交
248 249 250 251 252 253 254
 * the waiter is not allowed to do priority boosting
 */
int rt_mutex_getprio(struct task_struct *task)
{
	if (likely(!task_has_pi_waiters(task)))
		return task->normal_prio;

255
	return min(task_top_pi_waiter(task)->prio,
I
Ingo Molnar 已提交
256 257 258
		   task->normal_prio);
}

259 260 261 262 263 264 265 266
struct task_struct *rt_mutex_get_top_task(struct task_struct *task)
{
	if (likely(!task_has_pi_waiters(task)))
		return NULL;

	return task_top_pi_waiter(task)->task;
}

267 268 269 270 271 272 273 274 275 276 277 278
/*
 * Called by sched_setscheduler() to check whether the priority change
 * is overruled by a possible priority boosting.
 */
int rt_mutex_check_prio(struct task_struct *task, int newprio)
{
	if (!task_has_pi_waiters(task))
		return 0;

	return task_top_pi_waiter(task)->task->prio <= newprio;
}

I
Ingo Molnar 已提交
279 280 281 282 283
/*
 * Adjust the priority of a task, after its pi_waiters got modified.
 *
 * This can be both boosting and unboosting. task->pi_lock must be held.
 */
284
static void __rt_mutex_adjust_prio(struct task_struct *task)
I
Ingo Molnar 已提交
285 286 287
{
	int prio = rt_mutex_getprio(task);

288
	if (task->prio != prio || dl_prio(prio))
I
Ingo Molnar 已提交
289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304
		rt_mutex_setprio(task, prio);
}

/*
 * Adjust task priority (undo boosting). Called from the exit path of
 * rt_mutex_slowunlock() and rt_mutex_slowlock().
 *
 * (Note: We do this outside of the protection of lock->wait_lock to
 * allow the lock to be taken while or before we readjust the priority
 * of task. We do not use the spin_xx_mutex() variants here as we are
 * outside of the debug path.)
 */
static void rt_mutex_adjust_prio(struct task_struct *task)
{
	unsigned long flags;

305
	raw_spin_lock_irqsave(&task->pi_lock, flags);
I
Ingo Molnar 已提交
306
	__rt_mutex_adjust_prio(task);
307
	raw_spin_unlock_irqrestore(&task->pi_lock, flags);
I
Ingo Molnar 已提交
308 309
}

310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335
/*
 * Deadlock detection is conditional:
 *
 * If CONFIG_DEBUG_RT_MUTEXES=n, deadlock detection is only conducted
 * if the detect argument is == RT_MUTEX_FULL_CHAINWALK.
 *
 * If CONFIG_DEBUG_RT_MUTEXES=y, deadlock detection is always
 * conducted independent of the detect argument.
 *
 * If the waiter argument is NULL this indicates the deboost path and
 * deadlock detection is disabled independent of the detect argument
 * and the config settings.
 */
static bool rt_mutex_cond_detect_deadlock(struct rt_mutex_waiter *waiter,
					  enum rtmutex_chainwalk chwalk)
{
	/*
	 * This is just a wrapper function for the following call,
	 * because debug_rt_mutex_detect_deadlock() smells like a magic
	 * debug feature and I wanted to keep the cond function in the
	 * main source file along with the comments instead of having
	 * two of the same in the headers.
	 */
	return debug_rt_mutex_detect_deadlock(waiter, chwalk);
}

I
Ingo Molnar 已提交
336 337 338 339 340
/*
 * Max number of times we'll walk the boosting chain:
 */
int max_lock_depth = 1024;

341 342 343 344 345
static inline struct rt_mutex *task_blocked_on_lock(struct task_struct *p)
{
	return p->pi_blocked_on ? p->pi_blocked_on->lock : NULL;
}

I
Ingo Molnar 已提交
346 347 348
/*
 * Adjust the priority chain. Also used for deadlock detection.
 * Decreases task's usage by one - may thus free the task.
349
 *
350 351
 * @task:	the task owning the mutex (owner) for which a chain walk is
 *		probably needed
352
 * @deadlock_detect: do we have to carry out deadlock detection?
353 354 355 356 357 358
 * @orig_lock:	the mutex (can be NULL if we are walking the chain to recheck
 *		things for a task that has just got its priority adjusted, and
 *		is waiting on a mutex)
 * @next_lock:	the mutex on which the owner of @orig_lock was blocked before
 *		we dropped its pi_lock. Is never dereferenced, only used for
 *		comparison to detect lock chain changes.
359
 * @orig_waiter: rt_mutex_waiter struct for the task that has just donated
360 361 362 363
 *		its priority to the mutex owner (can be NULL in the case
 *		depicted above or if the top waiter is gone away and we are
 *		actually deboosting the owner)
 * @top_task:	the current top waiter
364
 *
I
Ingo Molnar 已提交
365
 * Returns 0 or -EDEADLK.
366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407
 *
 * Chain walk basics and protection scope
 *
 * [R] refcount on task
 * [P] task->pi_lock held
 * [L] rtmutex->wait_lock held
 *
 * Step	Description				Protected by
 *	function arguments:
 *	@task					[R]
 *	@orig_lock if != NULL			@top_task is blocked on it
 *	@next_lock				Unprotected. Cannot be
 *						dereferenced. Only used for
 *						comparison.
 *	@orig_waiter if != NULL			@top_task is blocked on it
 *	@top_task				current, or in case of proxy
 *						locking protected by calling
 *						code
 *	again:
 *	  loop_sanity_check();
 *	retry:
 * [1]	  lock(task->pi_lock);			[R] acquire [P]
 * [2]	  waiter = task->pi_blocked_on;		[P]
 * [3]	  check_exit_conditions_1();		[P]
 * [4]	  lock = waiter->lock;			[P]
 * [5]	  if (!try_lock(lock->wait_lock)) {	[P] try to acquire [L]
 *	    unlock(task->pi_lock);		release [P]
 *	    goto retry;
 *	  }
 * [6]	  check_exit_conditions_2();		[P] + [L]
 * [7]	  requeue_lock_waiter(lock, waiter);	[P] + [L]
 * [8]	  unlock(task->pi_lock);		release [P]
 *	  put_task_struct(task);		release [R]
 * [9]	  check_exit_conditions_3();		[L]
 * [10]	  task = owner(lock);			[L]
 *	  get_task_struct(task);		[L] acquire [R]
 *	  lock(task->pi_lock);			[L] acquire [P]
 * [11]	  requeue_pi_waiter(tsk, waiters(lock));[P] + [L]
 * [12]	  check_exit_conditions_4();		[P] + [L]
 * [13]	  unlock(task->pi_lock);		release [P]
 *	  unlock(lock->wait_lock);		release [L]
 *	  goto again;
I
Ingo Molnar 已提交
408
 */
409
static int rt_mutex_adjust_prio_chain(struct task_struct *task,
410
				      enum rtmutex_chainwalk chwalk,
411
				      struct rt_mutex *orig_lock,
412
				      struct rt_mutex *next_lock,
413 414
				      struct rt_mutex_waiter *orig_waiter,
				      struct task_struct *top_task)
I
Ingo Molnar 已提交
415 416
{
	struct rt_mutex_waiter *waiter, *top_waiter = orig_waiter;
417
	struct rt_mutex_waiter *prerequeue_top_waiter;
418
	int ret = 0, depth = 0;
419
	struct rt_mutex *lock;
420
	bool detect_deadlock;
I
Ingo Molnar 已提交
421
	unsigned long flags;
422
	bool requeue = true;
I
Ingo Molnar 已提交
423

424
	detect_deadlock = rt_mutex_cond_detect_deadlock(orig_waiter, chwalk);
I
Ingo Molnar 已提交
425 426 427 428 429 430 431 432

	/*
	 * The (de)boosting is a step by step approach with a lot of
	 * pitfalls. We want this to be preemptible and we want hold a
	 * maximum of two locks per step. So we have to check
	 * carefully whether things change under us.
	 */
 again:
433 434 435
	/*
	 * We limit the lock chain length for each invocation.
	 */
I
Ingo Molnar 已提交
436 437 438 439 440 441 442 443 444 445 446
	if (++depth > max_lock_depth) {
		static int prev_max;

		/*
		 * Print this only once. If the admin changes the limit,
		 * print a new message when reaching the limit again.
		 */
		if (prev_max != max_lock_depth) {
			prev_max = max_lock_depth;
			printk(KERN_WARNING "Maximum lock depth %d reached "
			       "task: %s (%d)\n", max_lock_depth,
447
			       top_task->comm, task_pid_nr(top_task));
I
Ingo Molnar 已提交
448 449 450
		}
		put_task_struct(task);

451
		return -EDEADLK;
I
Ingo Molnar 已提交
452
	}
453 454 455 456 457 458 459

	/*
	 * We are fully preemptible here and only hold the refcount on
	 * @task. So everything can have changed under us since the
	 * caller or our own code below (goto retry/again) dropped all
	 * locks.
	 */
I
Ingo Molnar 已提交
460 461
 retry:
	/*
462
	 * [1] Task cannot go away as we did a get_task() before !
I
Ingo Molnar 已提交
463
	 */
464
	raw_spin_lock_irqsave(&task->pi_lock, flags);
I
Ingo Molnar 已提交
465

466 467 468
	/*
	 * [2] Get the waiter on which @task is blocked on.
	 */
I
Ingo Molnar 已提交
469
	waiter = task->pi_blocked_on;
470 471 472 473 474

	/*
	 * [3] check_exit_conditions_1() protected by task->pi_lock.
	 */

I
Ingo Molnar 已提交
475 476 477 478 479
	/*
	 * Check whether the end of the boosting chain has been
	 * reached or the state of the chain has changed while we
	 * dropped the locks.
	 */
480
	if (!waiter)
I
Ingo Molnar 已提交
481 482
		goto out_unlock_pi;

483 484
	/*
	 * Check the orig_waiter state. After we dropped the locks,
485
	 * the previous owner of the lock might have released the lock.
486
	 */
487
	if (orig_waiter && !rt_mutex_owner(orig_lock))
488 489
		goto out_unlock_pi;

490 491 492 493 494 495 496 497 498 499 500 501
	/*
	 * We dropped all locks after taking a refcount on @task, so
	 * the task might have moved on in the lock chain or even left
	 * the chain completely and blocks now on an unrelated lock or
	 * on @orig_lock.
	 *
	 * We stored the lock on which @task was blocked in @next_lock,
	 * so we can detect the chain change.
	 */
	if (next_lock != waiter->lock)
		goto out_unlock_pi;

502 503 504 505 506
	/*
	 * Drop out, when the task has no waiters. Note,
	 * top_waiter can be NULL, when we are in the deboosting
	 * mode!
	 */
507 508 509 510 511
	if (top_waiter) {
		if (!task_has_pi_waiters(task))
			goto out_unlock_pi;
		/*
		 * If deadlock detection is off, we stop here if we
512 513 514
		 * are not the top pi waiter of the task. If deadlock
		 * detection is enabled we continue, but stop the
		 * requeueing in the chain walk.
515
		 */
516 517 518 519 520 521
		if (top_waiter != task_top_pi_waiter(task)) {
			if (!detect_deadlock)
				goto out_unlock_pi;
			else
				requeue = false;
		}
522
	}
I
Ingo Molnar 已提交
523 524

	/*
525 526 527 528 529
	 * If the waiter priority is the same as the task priority
	 * then there is no further priority adjustment necessary.  If
	 * deadlock detection is off, we stop the chain walk. If its
	 * enabled we continue, but stop the requeueing in the chain
	 * walk.
I
Ingo Molnar 已提交
530
	 */
531 532 533 534 535 536
	if (waiter->prio == task->prio) {
		if (!detect_deadlock)
			goto out_unlock_pi;
		else
			requeue = false;
	}
I
Ingo Molnar 已提交
537

538 539 540
	/*
	 * [4] Get the next lock
	 */
I
Ingo Molnar 已提交
541
	lock = waiter->lock;
542 543 544 545 546
	/*
	 * [5] We need to trylock here as we are holding task->pi_lock,
	 * which is the reverse lock order versus the other rtmutex
	 * operations.
	 */
547
	if (!raw_spin_trylock(&lock->wait_lock)) {
548
		raw_spin_unlock_irqrestore(&task->pi_lock, flags);
I
Ingo Molnar 已提交
549 550 551 552
		cpu_relax();
		goto retry;
	}

553
	/*
554 555 556
	 * [6] check_exit_conditions_2() protected by task->pi_lock and
	 * lock->wait_lock.
	 *
557 558 559 560 561
	 * Deadlock detection. If the lock is the same as the original
	 * lock which caused us to walk the lock chain or if the
	 * current lock is owned by the task which initiated the chain
	 * walk, we detected a deadlock.
	 */
562
	if (lock == orig_lock || rt_mutex_owner(lock) == top_task) {
563
		debug_rt_mutex_deadlock(chwalk, orig_waiter, lock);
564
		raw_spin_unlock(&lock->wait_lock);
565
		ret = -EDEADLK;
I
Ingo Molnar 已提交
566 567 568
		goto out_unlock_pi;
	}

569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617
	/*
	 * If we just follow the lock chain for deadlock detection, no
	 * need to do all the requeue operations. To avoid a truckload
	 * of conditionals around the various places below, just do the
	 * minimum chain walk checks.
	 */
	if (!requeue) {
		/*
		 * No requeue[7] here. Just release @task [8]
		 */
		raw_spin_unlock_irqrestore(&task->pi_lock, flags);
		put_task_struct(task);

		/*
		 * [9] check_exit_conditions_3 protected by lock->wait_lock.
		 * If there is no owner of the lock, end of chain.
		 */
		if (!rt_mutex_owner(lock)) {
			raw_spin_unlock(&lock->wait_lock);
			return 0;
		}

		/* [10] Grab the next task, i.e. owner of @lock */
		task = rt_mutex_owner(lock);
		get_task_struct(task);
		raw_spin_lock_irqsave(&task->pi_lock, flags);

		/*
		 * No requeue [11] here. We just do deadlock detection.
		 *
		 * [12] Store whether owner is blocked
		 * itself. Decision is made after dropping the locks
		 */
		next_lock = task_blocked_on_lock(task);
		/*
		 * Get the top waiter for the next iteration
		 */
		top_waiter = rt_mutex_top_waiter(lock);

		/* [13] Drop locks */
		raw_spin_unlock_irqrestore(&task->pi_lock, flags);
		raw_spin_unlock(&lock->wait_lock);

		/* If owner is not blocked, end of chain. */
		if (!next_lock)
			goto out_put_task;
		goto again;
	}

618 619 620 621 622 623
	/*
	 * Store the current top waiter before doing the requeue
	 * operation on @lock. We need it for the boost/deboost
	 * decision below.
	 */
	prerequeue_top_waiter = rt_mutex_top_waiter(lock);
I
Ingo Molnar 已提交
624

625
	/* [7] Requeue the waiter in the lock waiter list. */
626
	rt_mutex_dequeue(lock, waiter);
627
	waiter->prio = task->prio;
628
	rt_mutex_enqueue(lock, waiter);
I
Ingo Molnar 已提交
629

630
	/* [8] Release the task */
631
	raw_spin_unlock_irqrestore(&task->pi_lock, flags);
632 633
	put_task_struct(task);

634
	/*
635 636
	 * [9] check_exit_conditions_3 protected by lock->wait_lock.
	 *
637 638 639 640
	 * We must abort the chain walk if there is no lock owner even
	 * in the dead lock detection case, as we have nothing to
	 * follow here. This is the end of the chain we are walking.
	 */
641 642
	if (!rt_mutex_owner(lock)) {
		/*
643 644 645
		 * If the requeue [7] above changed the top waiter,
		 * then we need to wake the new top waiter up to try
		 * to get the lock.
646
		 */
647
		if (prerequeue_top_waiter != rt_mutex_top_waiter(lock))
648 649
			wake_up_process(rt_mutex_top_waiter(lock)->task);
		raw_spin_unlock(&lock->wait_lock);
650
		return 0;
651
	}
I
Ingo Molnar 已提交
652

653
	/* [10] Grab the next task, i.e. the owner of @lock */
I
Ingo Molnar 已提交
654
	task = rt_mutex_owner(lock);
655
	get_task_struct(task);
656
	raw_spin_lock_irqsave(&task->pi_lock, flags);
I
Ingo Molnar 已提交
657

658
	/* [11] requeue the pi waiters if necessary */
I
Ingo Molnar 已提交
659
	if (waiter == rt_mutex_top_waiter(lock)) {
660 661 662 663 664 665 666
		/*
		 * The waiter became the new top (highest priority)
		 * waiter on the lock. Replace the previous top waiter
		 * in the owner tasks pi waiters list with this waiter
		 * and adjust the priority of the owner.
		 */
		rt_mutex_dequeue_pi(task, prerequeue_top_waiter);
667
		rt_mutex_enqueue_pi(task, waiter);
I
Ingo Molnar 已提交
668 669
		__rt_mutex_adjust_prio(task);

670 671 672 673 674 675 676 677 678 679 680
	} else if (prerequeue_top_waiter == waiter) {
		/*
		 * The waiter was the top waiter on the lock, but is
		 * no longer the top prority waiter. Replace waiter in
		 * the owner tasks pi waiters list with the new top
		 * (highest priority) waiter and adjust the priority
		 * of the owner.
		 * The new top waiter is stored in @waiter so that
		 * @waiter == @top_waiter evaluates to true below and
		 * we continue to deboost the rest of the chain.
		 */
681
		rt_mutex_dequeue_pi(task, waiter);
I
Ingo Molnar 已提交
682
		waiter = rt_mutex_top_waiter(lock);
683
		rt_mutex_enqueue_pi(task, waiter);
I
Ingo Molnar 已提交
684
		__rt_mutex_adjust_prio(task);
685 686 687 688 689
	} else {
		/*
		 * Nothing changed. No need to do any priority
		 * adjustment.
		 */
I
Ingo Molnar 已提交
690 691
	}

692
	/*
693 694 695 696
	 * [12] check_exit_conditions_4() protected by task->pi_lock
	 * and lock->wait_lock. The actual decisions are made after we
	 * dropped the locks.
	 *
697 698 699 700 701 702
	 * Check whether the task which owns the current lock is pi
	 * blocked itself. If yes we store a pointer to the lock for
	 * the lock chain change detection above. After we dropped
	 * task->pi_lock next_lock cannot be dereferenced anymore.
	 */
	next_lock = task_blocked_on_lock(task);
703 704 705 706
	/*
	 * Store the top waiter of @lock for the end of chain walk
	 * decision below.
	 */
I
Ingo Molnar 已提交
707
	top_waiter = rt_mutex_top_waiter(lock);
708 709 710

	/* [13] Drop the locks */
	raw_spin_unlock_irqrestore(&task->pi_lock, flags);
711
	raw_spin_unlock(&lock->wait_lock);
I
Ingo Molnar 已提交
712

713
	/*
714 715 716
	 * Make the actual exit decisions [12], based on the stored
	 * values.
	 *
717 718 719 720 721 722
	 * We reached the end of the lock chain. Stop right here. No
	 * point to go back just to figure that out.
	 */
	if (!next_lock)
		goto out_put_task;

723 724 725 726 727
	/*
	 * If the current waiter is not the top waiter on the lock,
	 * then we can stop the chain walk here if we are not in full
	 * deadlock detection mode.
	 */
I
Ingo Molnar 已提交
728 729 730 731 732 733
	if (!detect_deadlock && waiter != top_waiter)
		goto out_put_task;

	goto again;

 out_unlock_pi:
734
	raw_spin_unlock_irqrestore(&task->pi_lock, flags);
I
Ingo Molnar 已提交
735 736
 out_put_task:
	put_task_struct(task);
737

I
Ingo Molnar 已提交
738 739 740 741 742 743 744
	return ret;
}

/*
 * Try to take an rt-mutex
 *
 * Must be called with lock->wait_lock held.
745
 *
746 747 748 749
 * @lock:   The lock to be acquired.
 * @task:   The task which wants to acquire the lock
 * @waiter: The waiter that is queued to the lock's wait list if the
 *	    callsite called task_blocked_on_lock(), otherwise NULL
I
Ingo Molnar 已提交
750
 */
751
static int try_to_take_rt_mutex(struct rt_mutex *lock, struct task_struct *task,
752
				struct rt_mutex_waiter *waiter)
I
Ingo Molnar 已提交
753
{
754 755
	unsigned long flags;

I
Ingo Molnar 已提交
756
	/*
757 758 759 760
	 * Before testing whether we can acquire @lock, we set the
	 * RT_MUTEX_HAS_WAITERS bit in @lock->owner. This forces all
	 * other tasks which try to modify @lock into the slow path
	 * and they serialize on @lock->wait_lock.
I
Ingo Molnar 已提交
761
	 *
762 763
	 * The RT_MUTEX_HAS_WAITERS bit can have a transitional state
	 * as explained at the top of this file if and only if:
I
Ingo Molnar 已提交
764
	 *
765 766 767 768 769 770 771
	 * - There is a lock owner. The caller must fixup the
	 *   transient state if it does a trylock or leaves the lock
	 *   function due to a signal or timeout.
	 *
	 * - @task acquires the lock and there are no other
	 *   waiters. This is undone in rt_mutex_set_owner(@task) at
	 *   the end of this function.
I
Ingo Molnar 已提交
772 773 774
	 */
	mark_rt_mutex_waiters(lock);

775 776 777
	/*
	 * If @lock has an owner, give up.
	 */
778
	if (rt_mutex_owner(lock))
I
Ingo Molnar 已提交
779 780
		return 0;

781
	/*
782 783 784
	 * If @waiter != NULL, @task has already enqueued the waiter
	 * into @lock waiter list. If @waiter == NULL then this is a
	 * trylock attempt.
785
	 */
786 787 788 789 790 791 792
	if (waiter) {
		/*
		 * If waiter is not the highest priority waiter of
		 * @lock, give up.
		 */
		if (waiter != rt_mutex_top_waiter(lock))
			return 0;
793

794 795 796 797 798
		/*
		 * We can acquire the lock. Remove the waiter from the
		 * lock waiters list.
		 */
		rt_mutex_dequeue(lock, waiter);
799

800
	} else {
801
		/*
802 803 804 805 806 807
		 * If the lock has waiters already we check whether @task is
		 * eligible to take over the lock.
		 *
		 * If there are no other waiters, @task can acquire
		 * the lock.  @task->pi_blocked_on is NULL, so it does
		 * not need to be dequeued.
808 809
		 */
		if (rt_mutex_has_waiters(lock)) {
810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830
			/*
			 * If @task->prio is greater than or equal to
			 * the top waiter priority (kernel view),
			 * @task lost.
			 */
			if (task->prio >= rt_mutex_top_waiter(lock)->prio)
				return 0;

			/*
			 * The current top waiter stays enqueued. We
			 * don't have to change anything in the lock
			 * waiters order.
			 */
		} else {
			/*
			 * No waiters. Take the lock without the
			 * pi_lock dance.@task->pi_blocked_on is NULL
			 * and we have no waiters to enqueue in @task
			 * pi waiters list.
			 */
			goto takeit;
831 832 833
		}
	}

834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851
	/*
	 * Clear @task->pi_blocked_on. Requires protection by
	 * @task->pi_lock. Redundant operation for the @waiter == NULL
	 * case, but conditionals are more expensive than a redundant
	 * store.
	 */
	raw_spin_lock_irqsave(&task->pi_lock, flags);
	task->pi_blocked_on = NULL;
	/*
	 * Finish the lock acquisition. @task is the new owner. If
	 * other waiters exist we have to insert the highest priority
	 * waiter into @task->pi_waiters list.
	 */
	if (rt_mutex_has_waiters(lock))
		rt_mutex_enqueue_pi(task, rt_mutex_top_waiter(lock));
	raw_spin_unlock_irqrestore(&task->pi_lock, flags);

takeit:
I
Ingo Molnar 已提交
852
	/* We got the lock. */
853
	debug_rt_mutex_lock(lock);
I
Ingo Molnar 已提交
854

855 856 857 858
	/*
	 * This either preserves the RT_MUTEX_HAS_WAITERS bit if there
	 * are still waiters or clears it.
	 */
859
	rt_mutex_set_owner(lock, task);
I
Ingo Molnar 已提交
860

861
	rt_mutex_deadlock_account_lock(lock, task);
I
Ingo Molnar 已提交
862 863 864 865 866 867 868 869 870 871 872 873 874

	return 1;
}

/*
 * Task blocks on lock.
 *
 * Prepare waiter and propagate pi chain
 *
 * This must be called with lock->wait_lock held.
 */
static int task_blocks_on_rt_mutex(struct rt_mutex *lock,
				   struct rt_mutex_waiter *waiter,
D
Darren Hart 已提交
875
				   struct task_struct *task,
876
				   enum rtmutex_chainwalk chwalk)
I
Ingo Molnar 已提交
877
{
878
	struct task_struct *owner = rt_mutex_owner(lock);
I
Ingo Molnar 已提交
879
	struct rt_mutex_waiter *top_waiter = waiter;
880
	struct rt_mutex *next_lock;
881
	int chain_walk = 0, res;
882
	unsigned long flags;
I
Ingo Molnar 已提交
883

884 885 886 887 888 889 890 891 892
	/*
	 * Early deadlock detection. We really don't want the task to
	 * enqueue on itself just to untangle the mess later. It's not
	 * only an optimization. We drop the locks, so another waiter
	 * can come in before the chain walk detects the deadlock. So
	 * the other will detect the deadlock and return -EDEADLOCK,
	 * which is wrong, as the other waiter is not in a deadlock
	 * situation.
	 */
893
	if (owner == task)
894 895
		return -EDEADLK;

896
	raw_spin_lock_irqsave(&task->pi_lock, flags);
D
Darren Hart 已提交
897 898
	__rt_mutex_adjust_prio(task);
	waiter->task = task;
I
Ingo Molnar 已提交
899
	waiter->lock = lock;
900
	waiter->prio = task->prio;
I
Ingo Molnar 已提交
901 902 903 904

	/* Get the top priority waiter on the lock */
	if (rt_mutex_has_waiters(lock))
		top_waiter = rt_mutex_top_waiter(lock);
905
	rt_mutex_enqueue(lock, waiter);
I
Ingo Molnar 已提交
906

D
Darren Hart 已提交
907
	task->pi_blocked_on = waiter;
I
Ingo Molnar 已提交
908

909
	raw_spin_unlock_irqrestore(&task->pi_lock, flags);
I
Ingo Molnar 已提交
910

911 912 913
	if (!owner)
		return 0;

914
	raw_spin_lock_irqsave(&owner->pi_lock, flags);
I
Ingo Molnar 已提交
915
	if (waiter == rt_mutex_top_waiter(lock)) {
916 917
		rt_mutex_dequeue_pi(owner, top_waiter);
		rt_mutex_enqueue_pi(owner, waiter);
I
Ingo Molnar 已提交
918 919

		__rt_mutex_adjust_prio(owner);
920 921
		if (owner->pi_blocked_on)
			chain_walk = 1;
922
	} else if (rt_mutex_cond_detect_deadlock(waiter, chwalk)) {
923
		chain_walk = 1;
924
	}
925

926 927 928 929 930 931 932 933 934 935
	/* Store the lock on which owner is blocked or NULL */
	next_lock = task_blocked_on_lock(owner);

	raw_spin_unlock_irqrestore(&owner->pi_lock, flags);
	/*
	 * Even if full deadlock detection is on, if the owner is not
	 * blocked itself, we can avoid finding this out in the chain
	 * walk.
	 */
	if (!chain_walk || !next_lock)
I
Ingo Molnar 已提交
936 937
		return 0;

938 939 940 941 942 943 944
	/*
	 * The owner can't disappear while holding a lock,
	 * so the owner struct is protected by wait_lock.
	 * Gets dropped in rt_mutex_adjust_prio_chain()!
	 */
	get_task_struct(owner);

945
	raw_spin_unlock(&lock->wait_lock);
I
Ingo Molnar 已提交
946

947
	res = rt_mutex_adjust_prio_chain(owner, chwalk, lock,
948
					 next_lock, waiter, task);
I
Ingo Molnar 已提交
949

950
	raw_spin_lock(&lock->wait_lock);
I
Ingo Molnar 已提交
951 952 953 954 955 956 957

	return res;
}

/*
 * Wake up the next waiter on the lock.
 *
T
Thomas Gleixner 已提交
958 959
 * Remove the top waiter from the current tasks pi waiter list and
 * wake it up.
I
Ingo Molnar 已提交
960 961 962 963 964 965 966 967
 *
 * Called with lock->wait_lock held.
 */
static void wakeup_next_waiter(struct rt_mutex *lock)
{
	struct rt_mutex_waiter *waiter;
	unsigned long flags;

968
	raw_spin_lock_irqsave(&current->pi_lock, flags);
I
Ingo Molnar 已提交
969 970 971 972 973 974 975 976 977

	waiter = rt_mutex_top_waiter(lock);

	/*
	 * Remove it from current->pi_waiters. We do not adjust a
	 * possible priority boost right now. We execute wakeup in the
	 * boosted mode and go back to normal after releasing
	 * lock->wait_lock.
	 */
978
	rt_mutex_dequeue_pi(current, waiter);
I
Ingo Molnar 已提交
979

T
Thomas Gleixner 已提交
980 981 982 983 984 985 986 987 988
	/*
	 * As we are waking up the top waiter, and the waiter stays
	 * queued on the lock until it gets the lock, this lock
	 * obviously has waiters. Just set the bit here and this has
	 * the added benefit of forcing all new tasks into the
	 * slow path making sure no task of lower priority than
	 * the top waiter can steal this lock.
	 */
	lock->owner = (void *) RT_MUTEX_HAS_WAITERS;
I
Ingo Molnar 已提交
989

990
	raw_spin_unlock_irqrestore(&current->pi_lock, flags);
I
Ingo Molnar 已提交
991

T
Thomas Gleixner 已提交
992 993 994 995 996
	/*
	 * It's safe to dereference waiter as it cannot go away as
	 * long as we hold lock->wait_lock. The waiter task needs to
	 * acquire it in order to dequeue the waiter.
	 */
997
	wake_up_process(waiter->task);
I
Ingo Molnar 已提交
998 999 1000
}

/*
1001
 * Remove a waiter from a lock and give up
I
Ingo Molnar 已提交
1002
 *
1003 1004
 * Must be called with lock->wait_lock held and
 * have just failed to try_to_take_rt_mutex().
I
Ingo Molnar 已提交
1005
 */
1006 1007
static void remove_waiter(struct rt_mutex *lock,
			  struct rt_mutex_waiter *waiter)
I
Ingo Molnar 已提交
1008
{
1009
	bool is_top_waiter = (waiter == rt_mutex_top_waiter(lock));
1010
	struct task_struct *owner = rt_mutex_owner(lock);
1011
	struct rt_mutex *next_lock;
I
Ingo Molnar 已提交
1012 1013
	unsigned long flags;

1014
	raw_spin_lock_irqsave(&current->pi_lock, flags);
1015
	rt_mutex_dequeue(lock, waiter);
I
Ingo Molnar 已提交
1016
	current->pi_blocked_on = NULL;
1017
	raw_spin_unlock_irqrestore(&current->pi_lock, flags);
I
Ingo Molnar 已提交
1018

1019 1020 1021 1022 1023
	/*
	 * Only update priority if the waiter was the highest priority
	 * waiter of the lock and there is an owner to update.
	 */
	if (!owner || !is_top_waiter)
1024 1025
		return;

1026
	raw_spin_lock_irqsave(&owner->pi_lock, flags);
I
Ingo Molnar 已提交
1027

1028
	rt_mutex_dequeue_pi(owner, waiter);
I
Ingo Molnar 已提交
1029

1030 1031
	if (rt_mutex_has_waiters(lock))
		rt_mutex_enqueue_pi(owner, rt_mutex_top_waiter(lock));
I
Ingo Molnar 已提交
1032

1033
	__rt_mutex_adjust_prio(owner);
I
Ingo Molnar 已提交
1034

1035 1036
	/* Store the lock on which owner is blocked or NULL */
	next_lock = task_blocked_on_lock(owner);
1037

1038
	raw_spin_unlock_irqrestore(&owner->pi_lock, flags);
I
Ingo Molnar 已提交
1039

1040 1041 1042 1043
	/*
	 * Don't walk the chain, if the owner task is not blocked
	 * itself.
	 */
1044
	if (!next_lock)
I
Ingo Molnar 已提交
1045 1046
		return;

1047 1048 1049
	/* gets dropped in rt_mutex_adjust_prio_chain()! */
	get_task_struct(owner);

1050
	raw_spin_unlock(&lock->wait_lock);
I
Ingo Molnar 已提交
1051

1052 1053
	rt_mutex_adjust_prio_chain(owner, RT_MUTEX_MIN_CHAINWALK, lock,
				   next_lock, NULL, current);
I
Ingo Molnar 已提交
1054

1055
	raw_spin_lock(&lock->wait_lock);
I
Ingo Molnar 已提交
1056 1057
}

1058 1059 1060 1061 1062 1063 1064 1065
/*
 * Recheck the pi chain, in case we got a priority setting
 *
 * Called from sched_setscheduler
 */
void rt_mutex_adjust_pi(struct task_struct *task)
{
	struct rt_mutex_waiter *waiter;
1066
	struct rt_mutex *next_lock;
1067 1068
	unsigned long flags;

1069
	raw_spin_lock_irqsave(&task->pi_lock, flags);
1070 1071

	waiter = task->pi_blocked_on;
1072 1073
	if (!waiter || (waiter->prio == task->prio &&
			!dl_prio(task->prio))) {
1074
		raw_spin_unlock_irqrestore(&task->pi_lock, flags);
1075 1076
		return;
	}
1077
	next_lock = waiter->lock;
1078
	raw_spin_unlock_irqrestore(&task->pi_lock, flags);
1079

1080 1081
	/* gets dropped in rt_mutex_adjust_prio_chain()! */
	get_task_struct(task);
1082

1083 1084
	rt_mutex_adjust_prio_chain(task, RT_MUTEX_MIN_CHAINWALK, NULL,
				   next_lock, NULL, task);
1085 1086
}

D
Darren Hart 已提交
1087 1088 1089 1090 1091 1092 1093 1094 1095
/**
 * __rt_mutex_slowlock() - Perform the wait-wake-try-to-take loop
 * @lock:		 the rt_mutex to take
 * @state:		 the state the task should block in (TASK_INTERRUPTIBLE
 * 			 or TASK_UNINTERRUPTIBLE)
 * @timeout:		 the pre-initialized and started timer, or NULL for none
 * @waiter:		 the pre-initialized rt_mutex_waiter
 *
 * lock->wait_lock must be held by the caller.
I
Ingo Molnar 已提交
1096 1097
 */
static int __sched
D
Darren Hart 已提交
1098 1099
__rt_mutex_slowlock(struct rt_mutex *lock, int state,
		    struct hrtimer_sleeper *timeout,
1100
		    struct rt_mutex_waiter *waiter)
I
Ingo Molnar 已提交
1101 1102 1103 1104 1105
{
	int ret = 0;

	for (;;) {
		/* Try to acquire the lock: */
1106
		if (try_to_take_rt_mutex(lock, current, waiter))
I
Ingo Molnar 已提交
1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122
			break;

		/*
		 * TASK_INTERRUPTIBLE checks for signals and
		 * timeout. Ignored otherwise.
		 */
		if (unlikely(state == TASK_INTERRUPTIBLE)) {
			/* Signal pending? */
			if (signal_pending(current))
				ret = -EINTR;
			if (timeout && !timeout->task)
				ret = -ETIMEDOUT;
			if (ret)
				break;
		}

1123
		raw_spin_unlock(&lock->wait_lock);
I
Ingo Molnar 已提交
1124

D
Darren Hart 已提交
1125
		debug_rt_mutex_print_deadlock(waiter);
I
Ingo Molnar 已提交
1126

1127
		schedule_rt_mutex(lock);
I
Ingo Molnar 已提交
1128

1129
		raw_spin_lock(&lock->wait_lock);
I
Ingo Molnar 已提交
1130 1131 1132
		set_current_state(state);
	}

1133
	__set_current_state(TASK_RUNNING);
D
Darren Hart 已提交
1134 1135 1136
	return ret;
}

1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156
static void rt_mutex_handle_deadlock(int res, int detect_deadlock,
				     struct rt_mutex_waiter *w)
{
	/*
	 * If the result is not -EDEADLOCK or the caller requested
	 * deadlock detection, nothing to do here.
	 */
	if (res != -EDEADLOCK || detect_deadlock)
		return;

	/*
	 * Yell lowdly and stop the task right here.
	 */
	rt_mutex_print_deadlock(w);
	while (1) {
		set_current_state(TASK_INTERRUPTIBLE);
		schedule();
	}
}

D
Darren Hart 已提交
1157 1158 1159 1160 1161 1162
/*
 * Slow path lock function:
 */
static int __sched
rt_mutex_slowlock(struct rt_mutex *lock, int state,
		  struct hrtimer_sleeper *timeout,
1163
		  enum rtmutex_chainwalk chwalk)
D
Darren Hart 已提交
1164 1165 1166 1167 1168
{
	struct rt_mutex_waiter waiter;
	int ret = 0;

	debug_rt_mutex_init_waiter(&waiter);
1169 1170
	RB_CLEAR_NODE(&waiter.pi_tree_entry);
	RB_CLEAR_NODE(&waiter.tree_entry);
D
Darren Hart 已提交
1171

1172
	raw_spin_lock(&lock->wait_lock);
D
Darren Hart 已提交
1173 1174

	/* Try to acquire the lock again: */
1175
	if (try_to_take_rt_mutex(lock, current, NULL)) {
1176
		raw_spin_unlock(&lock->wait_lock);
D
Darren Hart 已提交
1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188
		return 0;
	}

	set_current_state(state);

	/* Setup the timer, when timeout != NULL */
	if (unlikely(timeout)) {
		hrtimer_start_expires(&timeout->timer, HRTIMER_MODE_ABS);
		if (!hrtimer_active(&timeout->timer))
			timeout->task = NULL;
	}

1189
	ret = task_blocks_on_rt_mutex(lock, &waiter, current, chwalk);
1190 1191

	if (likely(!ret))
1192
		/* sleep on the mutex */
1193
		ret = __rt_mutex_slowlock(lock, state, timeout, &waiter);
D
Darren Hart 已提交
1194

1195
	if (unlikely(ret)) {
1196
		remove_waiter(lock, &waiter);
1197
		rt_mutex_handle_deadlock(ret, chwalk, &waiter);
1198
	}
I
Ingo Molnar 已提交
1199 1200 1201 1202 1203 1204 1205

	/*
	 * try_to_take_rt_mutex() sets the waiter bit
	 * unconditionally. We might have to fix that up.
	 */
	fixup_rt_mutex_waiters(lock);

1206
	raw_spin_unlock(&lock->wait_lock);
I
Ingo Molnar 已提交
1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219

	/* Remove pending timer: */
	if (unlikely(timeout))
		hrtimer_cancel(&timeout->timer);

	debug_rt_mutex_free_waiter(&waiter);

	return ret;
}

/*
 * Slow path try-lock function:
 */
1220
static inline int rt_mutex_slowtrylock(struct rt_mutex *lock)
I
Ingo Molnar 已提交
1221
{
1222 1223 1224 1225 1226 1227 1228 1229 1230
	int ret;

	/*
	 * If the lock already has an owner we fail to get the lock.
	 * This can be done without taking the @lock->wait_lock as
	 * it is only being read, and this is a trylock anyway.
	 */
	if (rt_mutex_owner(lock))
		return 0;
I
Ingo Molnar 已提交
1231

1232 1233 1234 1235
	/*
	 * The mutex has currently no owner. Lock the wait lock and
	 * try to acquire the lock.
	 */
1236
	raw_spin_lock(&lock->wait_lock);
I
Ingo Molnar 已提交
1237

1238
	ret = try_to_take_rt_mutex(lock, current, NULL);
I
Ingo Molnar 已提交
1239

1240 1241 1242 1243 1244
	/*
	 * try_to_take_rt_mutex() sets the lock waiters bit
	 * unconditionally. Clean this up.
	 */
	fixup_rt_mutex_waiters(lock);
I
Ingo Molnar 已提交
1245

1246
	raw_spin_unlock(&lock->wait_lock);
I
Ingo Molnar 已提交
1247 1248 1249 1250 1251 1252 1253 1254 1255 1256

	return ret;
}

/*
 * Slow path to release a rt-mutex:
 */
static void __sched
rt_mutex_slowunlock(struct rt_mutex *lock)
{
1257
	raw_spin_lock(&lock->wait_lock);
I
Ingo Molnar 已提交
1258 1259 1260 1261 1262

	debug_rt_mutex_unlock(lock);

	rt_mutex_deadlock_account_unlock(current);

T
Thomas Gleixner 已提交
1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299
	/*
	 * We must be careful here if the fast path is enabled. If we
	 * have no waiters queued we cannot set owner to NULL here
	 * because of:
	 *
	 * foo->lock->owner = NULL;
	 *			rtmutex_lock(foo->lock);   <- fast path
	 *			free = atomic_dec_and_test(foo->refcnt);
	 *			rtmutex_unlock(foo->lock); <- fast path
	 *			if (free)
	 *				kfree(foo);
	 * raw_spin_unlock(foo->lock->wait_lock);
	 *
	 * So for the fastpath enabled kernel:
	 *
	 * Nothing can set the waiters bit as long as we hold
	 * lock->wait_lock. So we do the following sequence:
	 *
	 *	owner = rt_mutex_owner(lock);
	 *	clear_rt_mutex_waiters(lock);
	 *	raw_spin_unlock(&lock->wait_lock);
	 *	if (cmpxchg(&lock->owner, owner, 0) == owner)
	 *		return;
	 *	goto retry;
	 *
	 * The fastpath disabled variant is simple as all access to
	 * lock->owner is serialized by lock->wait_lock:
	 *
	 *	lock->owner = NULL;
	 *	raw_spin_unlock(&lock->wait_lock);
	 */
	while (!rt_mutex_has_waiters(lock)) {
		/* Drops lock->wait_lock ! */
		if (unlock_rt_mutex_safe(lock) == true)
			return;
		/* Relock the rtmutex and try again */
		raw_spin_lock(&lock->wait_lock);
I
Ingo Molnar 已提交
1300 1301
	}

T
Thomas Gleixner 已提交
1302 1303 1304 1305
	/*
	 * The wakeup next waiter path does not suffer from the above
	 * race. See the comments there.
	 */
I
Ingo Molnar 已提交
1306 1307
	wakeup_next_waiter(lock);

1308
	raw_spin_unlock(&lock->wait_lock);
I
Ingo Molnar 已提交
1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323

	/* Undo pi boosting if necessary: */
	rt_mutex_adjust_prio(current);
}

/*
 * debug aware fast / slowpath lock,trylock,unlock
 *
 * The atomic acquire/release ops are compiled away, when either the
 * architecture does not support cmpxchg or when debugging is enabled.
 */
static inline int
rt_mutex_fastlock(struct rt_mutex *lock, int state,
		  int (*slowfn)(struct rt_mutex *lock, int state,
				struct hrtimer_sleeper *timeout,
1324
				enum rtmutex_chainwalk chwalk))
I
Ingo Molnar 已提交
1325
{
1326
	if (likely(rt_mutex_cmpxchg(lock, NULL, current))) {
I
Ingo Molnar 已提交
1327 1328 1329
		rt_mutex_deadlock_account_lock(lock, current);
		return 0;
	} else
1330
		return slowfn(lock, state, NULL, RT_MUTEX_MIN_CHAINWALK);
I
Ingo Molnar 已提交
1331 1332 1333 1334
}

static inline int
rt_mutex_timed_fastlock(struct rt_mutex *lock, int state,
1335 1336
			struct hrtimer_sleeper *timeout,
			enum rtmutex_chainwalk chwalk,
I
Ingo Molnar 已提交
1337 1338
			int (*slowfn)(struct rt_mutex *lock, int state,
				      struct hrtimer_sleeper *timeout,
1339
				      enum rtmutex_chainwalk chwalk))
I
Ingo Molnar 已提交
1340
{
1341 1342
	if (chwalk == RT_MUTEX_MIN_CHAINWALK &&
	    likely(rt_mutex_cmpxchg(lock, NULL, current))) {
I
Ingo Molnar 已提交
1343 1344 1345
		rt_mutex_deadlock_account_lock(lock, current);
		return 0;
	} else
1346
		return slowfn(lock, state, timeout, chwalk);
I
Ingo Molnar 已提交
1347 1348 1349 1350
}

static inline int
rt_mutex_fasttrylock(struct rt_mutex *lock,
1351
		     int (*slowfn)(struct rt_mutex *lock))
I
Ingo Molnar 已提交
1352 1353 1354 1355 1356
{
	if (likely(rt_mutex_cmpxchg(lock, NULL, current))) {
		rt_mutex_deadlock_account_lock(lock, current);
		return 1;
	}
1357
	return slowfn(lock);
I
Ingo Molnar 已提交
1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378
}

static inline void
rt_mutex_fastunlock(struct rt_mutex *lock,
		    void (*slowfn)(struct rt_mutex *lock))
{
	if (likely(rt_mutex_cmpxchg(lock, current, NULL)))
		rt_mutex_deadlock_account_unlock(current);
	else
		slowfn(lock);
}

/**
 * rt_mutex_lock - lock a rt_mutex
 *
 * @lock: the rt_mutex to be locked
 */
void __sched rt_mutex_lock(struct rt_mutex *lock)
{
	might_sleep();

1379
	rt_mutex_fastlock(lock, TASK_UNINTERRUPTIBLE, rt_mutex_slowlock);
I
Ingo Molnar 已提交
1380 1381 1382 1383 1384 1385
}
EXPORT_SYMBOL_GPL(rt_mutex_lock);

/**
 * rt_mutex_lock_interruptible - lock a rt_mutex interruptible
 *
1386
 * @lock:		the rt_mutex to be locked
I
Ingo Molnar 已提交
1387 1388
 *
 * Returns:
1389 1390
 *  0		on success
 * -EINTR	when interrupted by a signal
I
Ingo Molnar 已提交
1391
 */
1392
int __sched rt_mutex_lock_interruptible(struct rt_mutex *lock)
I
Ingo Molnar 已提交
1393 1394 1395
{
	might_sleep();

1396
	return rt_mutex_fastlock(lock, TASK_INTERRUPTIBLE, rt_mutex_slowlock);
I
Ingo Molnar 已提交
1397 1398 1399
}
EXPORT_SYMBOL_GPL(rt_mutex_lock_interruptible);

1400 1401 1402 1403 1404 1405 1406 1407
/*
 * Futex variant with full deadlock detection.
 */
int rt_mutex_timed_futex_lock(struct rt_mutex *lock,
			      struct hrtimer_sleeper *timeout)
{
	might_sleep();

1408 1409
	return rt_mutex_timed_fastlock(lock, TASK_INTERRUPTIBLE, timeout,
				       RT_MUTEX_FULL_CHAINWALK,
1410 1411 1412
				       rt_mutex_slowlock);
}

I
Ingo Molnar 已提交
1413
/**
1414 1415 1416
 * rt_mutex_timed_lock - lock a rt_mutex interruptible
 *			the timeout structure is provided
 *			by the caller
I
Ingo Molnar 已提交
1417
 *
1418
 * @lock:		the rt_mutex to be locked
I
Ingo Molnar 已提交
1419 1420 1421
 * @timeout:		timeout structure or NULL (no timeout)
 *
 * Returns:
1422 1423
 *  0		on success
 * -EINTR	when interrupted by a signal
1424
 * -ETIMEDOUT	when the timeout expired
I
Ingo Molnar 已提交
1425 1426
 */
int
1427
rt_mutex_timed_lock(struct rt_mutex *lock, struct hrtimer_sleeper *timeout)
I
Ingo Molnar 已提交
1428 1429 1430
{
	might_sleep();

1431 1432
	return rt_mutex_timed_fastlock(lock, TASK_INTERRUPTIBLE, timeout,
				       RT_MUTEX_MIN_CHAINWALK,
1433
				       rt_mutex_slowlock);
I
Ingo Molnar 已提交
1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460
}
EXPORT_SYMBOL_GPL(rt_mutex_timed_lock);

/**
 * rt_mutex_trylock - try to lock a rt_mutex
 *
 * @lock:	the rt_mutex to be locked
 *
 * Returns 1 on success and 0 on contention
 */
int __sched rt_mutex_trylock(struct rt_mutex *lock)
{
	return rt_mutex_fasttrylock(lock, rt_mutex_slowtrylock);
}
EXPORT_SYMBOL_GPL(rt_mutex_trylock);

/**
 * rt_mutex_unlock - unlock a rt_mutex
 *
 * @lock: the rt_mutex to be unlocked
 */
void __sched rt_mutex_unlock(struct rt_mutex *lock)
{
	rt_mutex_fastunlock(lock, rt_mutex_slowunlock);
}
EXPORT_SYMBOL_GPL(rt_mutex_unlock);

1461
/**
I
Ingo Molnar 已提交
1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490
 * rt_mutex_destroy - mark a mutex unusable
 * @lock: the mutex to be destroyed
 *
 * This function marks the mutex uninitialized, and any subsequent
 * use of the mutex is forbidden. The mutex must not be locked when
 * this function is called.
 */
void rt_mutex_destroy(struct rt_mutex *lock)
{
	WARN_ON(rt_mutex_is_locked(lock));
#ifdef CONFIG_DEBUG_RT_MUTEXES
	lock->magic = NULL;
#endif
}

EXPORT_SYMBOL_GPL(rt_mutex_destroy);

/**
 * __rt_mutex_init - initialize the rt lock
 *
 * @lock: the rt lock to be initialized
 *
 * Initialize the rt lock to unlocked state.
 *
 * Initializing of a locked rt lock is not allowed
 */
void __rt_mutex_init(struct rt_mutex *lock, const char *name)
{
	lock->owner = NULL;
1491
	raw_spin_lock_init(&lock->wait_lock);
1492 1493
	lock->waiters = RB_ROOT;
	lock->waiters_leftmost = NULL;
I
Ingo Molnar 已提交
1494 1495 1496 1497

	debug_rt_mutex_init(lock, name);
}
EXPORT_SYMBOL_GPL(__rt_mutex_init);
1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512

/**
 * rt_mutex_init_proxy_locked - initialize and lock a rt_mutex on behalf of a
 *				proxy owner
 *
 * @lock: 	the rt_mutex to be locked
 * @proxy_owner:the task to set as owner
 *
 * No locking. Caller has to do serializing itself
 * Special API call for PI-futex support
 */
void rt_mutex_init_proxy_locked(struct rt_mutex *lock,
				struct task_struct *proxy_owner)
{
	__rt_mutex_init(lock, NULL);
1513
	debug_rt_mutex_proxy_lock(lock, proxy_owner);
1514
	rt_mutex_set_owner(lock, proxy_owner);
1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529
	rt_mutex_deadlock_account_lock(lock, proxy_owner);
}

/**
 * rt_mutex_proxy_unlock - release a lock on behalf of owner
 *
 * @lock: 	the rt_mutex to be locked
 *
 * No locking. Caller has to do serializing itself
 * Special API call for PI-futex support
 */
void rt_mutex_proxy_unlock(struct rt_mutex *lock,
			   struct task_struct *proxy_owner)
{
	debug_rt_mutex_proxy_unlock(lock);
1530
	rt_mutex_set_owner(lock, NULL);
1531 1532 1533
	rt_mutex_deadlock_account_unlock(proxy_owner);
}

D
Darren Hart 已提交
1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548
/**
 * rt_mutex_start_proxy_lock() - Start lock acquisition for another task
 * @lock:		the rt_mutex to take
 * @waiter:		the pre-initialized rt_mutex_waiter
 * @task:		the task to prepare
 *
 * Returns:
 *  0 - task blocked on lock
 *  1 - acquired the lock for task, caller should wake it up
 * <0 - error
 *
 * Special API call for FUTEX_REQUEUE_PI support.
 */
int rt_mutex_start_proxy_lock(struct rt_mutex *lock,
			      struct rt_mutex_waiter *waiter,
1549
			      struct task_struct *task)
D
Darren Hart 已提交
1550 1551 1552
{
	int ret;

1553
	raw_spin_lock(&lock->wait_lock);
D
Darren Hart 已提交
1554

1555
	if (try_to_take_rt_mutex(lock, task, NULL)) {
1556
		raw_spin_unlock(&lock->wait_lock);
D
Darren Hart 已提交
1557 1558 1559
		return 1;
	}

1560
	/* We enforce deadlock detection for futexes */
1561 1562
	ret = task_blocks_on_rt_mutex(lock, waiter, task,
				      RT_MUTEX_FULL_CHAINWALK);
D
Darren Hart 已提交
1563

1564
	if (ret && !rt_mutex_owner(lock)) {
D
Darren Hart 已提交
1565 1566 1567 1568 1569 1570 1571 1572
		/*
		 * Reset the return value. We might have
		 * returned with -EDEADLK and the owner
		 * released the lock while we were walking the
		 * pi chain.  Let the waiter sort it out.
		 */
		ret = 0;
	}
1573 1574 1575 1576

	if (unlikely(ret))
		remove_waiter(lock, waiter);

1577
	raw_spin_unlock(&lock->wait_lock);
D
Darren Hart 已提交
1578 1579 1580 1581 1582 1583

	debug_rt_mutex_print_deadlock(waiter);

	return ret;
}

1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602
/**
 * rt_mutex_next_owner - return the next owner of the lock
 *
 * @lock: the rt lock query
 *
 * Returns the next owner of the lock or NULL
 *
 * Caller has to serialize against other accessors to the lock
 * itself.
 *
 * Special API call for PI-futex support
 */
struct task_struct *rt_mutex_next_owner(struct rt_mutex *lock)
{
	if (!rt_mutex_has_waiters(lock))
		return NULL;

	return rt_mutex_top_waiter(lock)->task;
}
D
Darren Hart 已提交
1603 1604 1605 1606 1607

/**
 * rt_mutex_finish_proxy_lock() - Complete lock acquisition
 * @lock:		the rt_mutex we were woken on
 * @to:			the timeout, null if none. hrtimer should already have
1608
 *			been started.
D
Darren Hart 已提交
1609 1610 1611 1612 1613 1614
 * @waiter:		the pre-initialized rt_mutex_waiter
 *
 * Complete the lock acquisition started our behalf by another thread.
 *
 * Returns:
 *  0 - success
1615
 * <0 - error, one of -EINTR, -ETIMEDOUT
D
Darren Hart 已提交
1616 1617 1618 1619 1620
 *
 * Special API call for PI-futex requeue support
 */
int rt_mutex_finish_proxy_lock(struct rt_mutex *lock,
			       struct hrtimer_sleeper *to,
1621
			       struct rt_mutex_waiter *waiter)
D
Darren Hart 已提交
1622 1623 1624
{
	int ret;

1625
	raw_spin_lock(&lock->wait_lock);
D
Darren Hart 已提交
1626 1627 1628

	set_current_state(TASK_INTERRUPTIBLE);

1629
	/* sleep on the mutex */
1630
	ret = __rt_mutex_slowlock(lock, TASK_INTERRUPTIBLE, to, waiter);
D
Darren Hart 已提交
1631

1632
	if (unlikely(ret))
D
Darren Hart 已提交
1633 1634 1635 1636 1637 1638 1639 1640
		remove_waiter(lock, waiter);

	/*
	 * try_to_take_rt_mutex() sets the waiter bit unconditionally. We might
	 * have to fix that up.
	 */
	fixup_rt_mutex_waiters(lock);

1641
	raw_spin_unlock(&lock->wait_lock);
D
Darren Hart 已提交
1642 1643 1644

	return ret;
}