rtmutex.c 43.5 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
 * We can speed up the acquire/release, if there's no debugging state to be
 * set up.
75
 */
76
#ifndef CONFIG_DEBUG_RT_MUTEXES
77 78 79 80 81 82 83 84 85
# 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
 * Called by sched_setscheduler() to get the priority which will be
 * effective after the change.
270
 */
271
int rt_mutex_get_effective_prio(struct task_struct *task, int newprio)
272 273
{
	if (!task_has_pi_waiters(task))
274
		return newprio;
275

276 277 278
	if (task_top_pi_waiter(task)->task->prio <= newprio)
		return task_top_pi_waiter(task)->task->prio;
	return newprio;
279 280
}

I
Ingo Molnar 已提交
281 282 283 284 285
/*
 * 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.
 */
286
static void __rt_mutex_adjust_prio(struct task_struct *task)
I
Ingo Molnar 已提交
287 288 289
{
	int prio = rt_mutex_getprio(task);

290
	if (task->prio != prio || dl_prio(prio))
I
Ingo Molnar 已提交
291 292 293 294 295 296 297 298 299 300 301 302
		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.)
 */
303
void rt_mutex_adjust_prio(struct task_struct *task)
I
Ingo Molnar 已提交
304 305 306
{
	unsigned long flags;

307
	raw_spin_lock_irqsave(&task->pi_lock, flags);
I
Ingo Molnar 已提交
308
	__rt_mutex_adjust_prio(task);
309
	raw_spin_unlock_irqrestore(&task->pi_lock, flags);
I
Ingo Molnar 已提交
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 336 337
/*
 * 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 已提交
338 339 340 341 342
/*
 * Max number of times we'll walk the boosting chain:
 */
int max_lock_depth = 1024;

343 344 345 346 347
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 已提交
348 349 350
/*
 * Adjust the priority chain. Also used for deadlock detection.
 * Decreases task's usage by one - may thus free the task.
351
 *
352 353
 * @task:	the task owning the mutex (owner) for which a chain walk is
 *		probably needed
354
 * @chwalk:	do we have to carry out deadlock detection?
355 356 357 358 359 360
 * @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.
361
 * @orig_waiter: rt_mutex_waiter struct for the task that has just donated
362 363 364 365
 *		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
366
 *
I
Ingo Molnar 已提交
367
 * Returns 0 or -EDEADLK.
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 408 409
 *
 * 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 已提交
410
 */
411
static int rt_mutex_adjust_prio_chain(struct task_struct *task,
412
				      enum rtmutex_chainwalk chwalk,
413
				      struct rt_mutex *orig_lock,
414
				      struct rt_mutex *next_lock,
415 416
				      struct rt_mutex_waiter *orig_waiter,
				      struct task_struct *top_task)
I
Ingo Molnar 已提交
417 418
{
	struct rt_mutex_waiter *waiter, *top_waiter = orig_waiter;
419
	struct rt_mutex_waiter *prerequeue_top_waiter;
420
	int ret = 0, depth = 0;
421
	struct rt_mutex *lock;
422
	bool detect_deadlock;
I
Ingo Molnar 已提交
423
	unsigned long flags;
424
	bool requeue = true;
I
Ingo Molnar 已提交
425

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

	/*
	 * 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:
435 436 437
	/*
	 * We limit the lock chain length for each invocation.
	 */
I
Ingo Molnar 已提交
438 439 440 441 442 443 444 445 446 447 448
	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,
449
			       top_task->comm, task_pid_nr(top_task));
I
Ingo Molnar 已提交
450 451 452
		}
		put_task_struct(task);

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

	/*
	 * 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 已提交
462 463
 retry:
	/*
464
	 * [1] Task cannot go away as we did a get_task() before !
I
Ingo Molnar 已提交
465
	 */
466
	raw_spin_lock_irqsave(&task->pi_lock, flags);
I
Ingo Molnar 已提交
467

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

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

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

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

492 493 494 495 496 497 498 499 500 501 502 503
	/*
	 * 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;

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

	/*
527 528 529 530 531
	 * 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 已提交
532
	 */
533 534 535 536 537 538
	if (waiter->prio == task->prio) {
		if (!detect_deadlock)
			goto out_unlock_pi;
		else
			requeue = false;
	}
I
Ingo Molnar 已提交
539

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

555
	/*
556 557 558
	 * [6] check_exit_conditions_2() protected by task->pi_lock and
	 * lock->wait_lock.
	 *
559 560 561 562 563
	 * 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.
	 */
564
	if (lock == orig_lock || rt_mutex_owner(lock) == top_task) {
565
		debug_rt_mutex_deadlock(chwalk, orig_waiter, lock);
566
		raw_spin_unlock(&lock->wait_lock);
567
		ret = -EDEADLK;
I
Ingo Molnar 已提交
568 569 570
		goto out_unlock_pi;
	}

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 618 619
	/*
	 * 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;
	}

620 621 622 623 624 625
	/*
	 * 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 已提交
626

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

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

636
	/*
637 638
	 * [9] check_exit_conditions_3 protected by lock->wait_lock.
	 *
639 640 641 642
	 * 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.
	 */
643 644
	if (!rt_mutex_owner(lock)) {
		/*
645 646 647
		 * 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.
648
		 */
649
		if (prerequeue_top_waiter != rt_mutex_top_waiter(lock))
650 651
			wake_up_process(rt_mutex_top_waiter(lock)->task);
		raw_spin_unlock(&lock->wait_lock);
652
		return 0;
653
	}
I
Ingo Molnar 已提交
654

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

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

672 673 674 675
	} 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
676
		 * the owner tasks pi waiters tree with the new top
677 678 679 680 681 682
		 * (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.
		 */
683
		rt_mutex_dequeue_pi(task, waiter);
I
Ingo Molnar 已提交
684
		waiter = rt_mutex_top_waiter(lock);
685
		rt_mutex_enqueue_pi(task, waiter);
I
Ingo Molnar 已提交
686
		__rt_mutex_adjust_prio(task);
687 688 689 690 691
	} else {
		/*
		 * Nothing changed. No need to do any priority
		 * adjustment.
		 */
I
Ingo Molnar 已提交
692 693
	}

694
	/*
695 696 697 698
	 * [12] check_exit_conditions_4() protected by task->pi_lock
	 * and lock->wait_lock. The actual decisions are made after we
	 * dropped the locks.
	 *
699 700 701 702 703 704
	 * 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);
705 706 707 708
	/*
	 * Store the top waiter of @lock for the end of chain walk
	 * decision below.
	 */
I
Ingo Molnar 已提交
709
	top_waiter = rt_mutex_top_waiter(lock);
710 711 712

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

715
	/*
716 717 718
	 * Make the actual exit decisions [12], based on the stored
	 * values.
	 *
719 720 721 722 723 724
	 * 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;

725 726 727 728 729
	/*
	 * 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 已提交
730 731 732 733 734 735
	if (!detect_deadlock && waiter != top_waiter)
		goto out_put_task;

	goto again;

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

I
Ingo Molnar 已提交
740 741 742 743 744 745 746
	return ret;
}

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

I
Ingo Molnar 已提交
758
	/*
759 760 761 762
	 * 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 已提交
763
	 *
764 765
	 * 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 已提交
766
	 *
767 768 769 770 771 772 773
	 * - 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 已提交
774 775 776
	 */
	mark_rt_mutex_waiters(lock);

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

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

796 797
		/*
		 * We can acquire the lock. Remove the waiter from the
798
		 * lock waiters tree.
799 800
		 */
		rt_mutex_dequeue(lock, waiter);
801

802
	} else {
803
		/*
804 805 806 807 808 809
		 * 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.
810 811
		 */
		if (rt_mutex_has_waiters(lock)) {
812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829
			/*
			 * 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
830
			 * pi waiters tree.
831 832
			 */
			goto takeit;
833 834 835
		}
	}

836 837 838 839 840 841 842 843 844 845 846
	/*
	 * 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
847
	 * waiter into @task->pi_waiters tree.
848 849 850 851 852 853
	 */
	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 已提交
854
	/* We got the lock. */
855
	debug_rt_mutex_lock(lock);
I
Ingo Molnar 已提交
856

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

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

	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 已提交
877
				   struct task_struct *task,
878
				   enum rtmutex_chainwalk chwalk)
I
Ingo Molnar 已提交
879
{
880
	struct task_struct *owner = rt_mutex_owner(lock);
I
Ingo Molnar 已提交
881
	struct rt_mutex_waiter *top_waiter = waiter;
882
	struct rt_mutex *next_lock;
883
	int chain_walk = 0, res;
884
	unsigned long flags;
I
Ingo Molnar 已提交
885

886 887 888 889 890 891 892 893 894
	/*
	 * 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.
	 */
895
	if (owner == task)
896 897
		return -EDEADLK;

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

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

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

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

913 914 915
	if (!owner)
		return 0;

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

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

928 929 930 931 932 933 934 935 936 937
	/* 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 已提交
938 939
		return 0;

940 941 942 943 944 945 946
	/*
	 * 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);

947
	raw_spin_unlock(&lock->wait_lock);
I
Ingo Molnar 已提交
948

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

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

	return res;
}

/*
958
 * Remove the top waiter from the current tasks pi waiter tree and
959
 * queue it up.
I
Ingo Molnar 已提交
960 961 962
 *
 * Called with lock->wait_lock held.
 */
963 964
static void mark_wakeup_next_waiter(struct wake_q_head *wake_q,
				    struct rt_mutex *lock)
I
Ingo Molnar 已提交
965 966 967 968
{
	struct rt_mutex_waiter *waiter;
	unsigned long flags;

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

	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.
	 */
979
	rt_mutex_dequeue_pi(current, waiter);
I
Ingo Molnar 已提交
980

T
Thomas Gleixner 已提交
981 982 983 984 985 986 987 988 989
	/*
	 * 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 已提交
990

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

993
	wake_q_add(wake_q, waiter->task);
I
Ingo Molnar 已提交
994 995 996
}

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

1010
	raw_spin_lock_irqsave(&current->pi_lock, flags);
1011
	rt_mutex_dequeue(lock, waiter);
I
Ingo Molnar 已提交
1012
	current->pi_blocked_on = NULL;
1013
	raw_spin_unlock_irqrestore(&current->pi_lock, flags);
I
Ingo Molnar 已提交
1014

1015 1016 1017 1018 1019
	/*
	 * 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)
1020 1021
		return;

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

1024
	rt_mutex_dequeue_pi(owner, waiter);
I
Ingo Molnar 已提交
1025

1026 1027
	if (rt_mutex_has_waiters(lock))
		rt_mutex_enqueue_pi(owner, rt_mutex_top_waiter(lock));
I
Ingo Molnar 已提交
1028

1029
	__rt_mutex_adjust_prio(owner);
I
Ingo Molnar 已提交
1030

1031 1032
	/* Store the lock on which owner is blocked or NULL */
	next_lock = task_blocked_on_lock(owner);
1033

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

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

1043 1044 1045
	/* gets dropped in rt_mutex_adjust_prio_chain()! */
	get_task_struct(owner);

1046
	raw_spin_unlock(&lock->wait_lock);
I
Ingo Molnar 已提交
1047

1048 1049
	rt_mutex_adjust_prio_chain(owner, RT_MUTEX_MIN_CHAINWALK, lock,
				   next_lock, NULL, current);
I
Ingo Molnar 已提交
1050

1051
	raw_spin_lock(&lock->wait_lock);
I
Ingo Molnar 已提交
1052 1053
}

1054 1055 1056 1057 1058 1059 1060 1061
/*
 * 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;
1062
	struct rt_mutex *next_lock;
1063 1064
	unsigned long flags;

1065
	raw_spin_lock_irqsave(&task->pi_lock, flags);
1066 1067

	waiter = task->pi_blocked_on;
1068 1069
	if (!waiter || (waiter->prio == task->prio &&
			!dl_prio(task->prio))) {
1070
		raw_spin_unlock_irqrestore(&task->pi_lock, flags);
1071 1072
		return;
	}
1073
	next_lock = waiter->lock;
1074
	raw_spin_unlock_irqrestore(&task->pi_lock, flags);
1075

1076 1077
	/* gets dropped in rt_mutex_adjust_prio_chain()! */
	get_task_struct(task);
1078

1079 1080
	rt_mutex_adjust_prio_chain(task, RT_MUTEX_MIN_CHAINWALK, NULL,
				   next_lock, NULL, task);
1081 1082
}

D
Darren Hart 已提交
1083 1084 1085 1086 1087 1088 1089 1090 1091
/**
 * __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 已提交
1092 1093
 */
static int __sched
D
Darren Hart 已提交
1094 1095
__rt_mutex_slowlock(struct rt_mutex *lock, int state,
		    struct hrtimer_sleeper *timeout,
1096
		    struct rt_mutex_waiter *waiter)
I
Ingo Molnar 已提交
1097 1098 1099 1100 1101
{
	int ret = 0;

	for (;;) {
		/* Try to acquire the lock: */
1102
		if (try_to_take_rt_mutex(lock, current, waiter))
I
Ingo Molnar 已提交
1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118
			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;
		}

1119
		raw_spin_unlock(&lock->wait_lock);
I
Ingo Molnar 已提交
1120

D
Darren Hart 已提交
1121
		debug_rt_mutex_print_deadlock(waiter);
I
Ingo Molnar 已提交
1122

1123
		schedule();
I
Ingo Molnar 已提交
1124

1125
		raw_spin_lock(&lock->wait_lock);
I
Ingo Molnar 已提交
1126 1127 1128
		set_current_state(state);
	}

1129
	__set_current_state(TASK_RUNNING);
D
Darren Hart 已提交
1130 1131 1132
	return ret;
}

1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152
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 已提交
1153 1154 1155 1156 1157 1158
/*
 * Slow path lock function:
 */
static int __sched
rt_mutex_slowlock(struct rt_mutex *lock, int state,
		  struct hrtimer_sleeper *timeout,
1159
		  enum rtmutex_chainwalk chwalk)
D
Darren Hart 已提交
1160 1161 1162 1163 1164
{
	struct rt_mutex_waiter waiter;
	int ret = 0;

	debug_rt_mutex_init_waiter(&waiter);
1165 1166
	RB_CLEAR_NODE(&waiter.pi_tree_entry);
	RB_CLEAR_NODE(&waiter.tree_entry);
D
Darren Hart 已提交
1167

1168
	raw_spin_lock(&lock->wait_lock);
D
Darren Hart 已提交
1169 1170

	/* Try to acquire the lock again: */
1171
	if (try_to_take_rt_mutex(lock, current, NULL)) {
1172
		raw_spin_unlock(&lock->wait_lock);
D
Darren Hart 已提交
1173 1174 1175 1176 1177 1178
		return 0;
	}

	set_current_state(state);

	/* Setup the timer, when timeout != NULL */
1179
	if (unlikely(timeout))
D
Darren Hart 已提交
1180 1181
		hrtimer_start_expires(&timeout->timer, HRTIMER_MODE_ABS);

1182
	ret = task_blocks_on_rt_mutex(lock, &waiter, current, chwalk);
1183 1184

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

1188
	if (unlikely(ret)) {
1189
		__set_current_state(TASK_RUNNING);
1190 1191
		if (rt_mutex_has_waiters(lock))
			remove_waiter(lock, &waiter);
1192
		rt_mutex_handle_deadlock(ret, chwalk, &waiter);
1193
	}
I
Ingo Molnar 已提交
1194 1195 1196 1197 1198 1199 1200

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

1201
	raw_spin_unlock(&lock->wait_lock);
I
Ingo Molnar 已提交
1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214

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

	debug_rt_mutex_free_waiter(&waiter);

	return ret;
}

/*
 * Slow path try-lock function:
 */
1215
static inline int rt_mutex_slowtrylock(struct rt_mutex *lock)
I
Ingo Molnar 已提交
1216
{
1217 1218 1219 1220 1221 1222 1223 1224 1225
	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 已提交
1226

1227 1228 1229 1230
	/*
	 * The mutex has currently no owner. Lock the wait lock and
	 * try to acquire the lock.
	 */
1231
	raw_spin_lock(&lock->wait_lock);
I
Ingo Molnar 已提交
1232

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

1235 1236 1237 1238 1239
	/*
	 * try_to_take_rt_mutex() sets the lock waiters bit
	 * unconditionally. Clean this up.
	 */
	fixup_rt_mutex_waiters(lock);
I
Ingo Molnar 已提交
1240

1241
	raw_spin_unlock(&lock->wait_lock);
I
Ingo Molnar 已提交
1242 1243 1244 1245 1246

	return ret;
}

/*
1247 1248
 * Slow path to release a rt-mutex.
 * Return whether the current task needs to undo a potential priority boosting.
I
Ingo Molnar 已提交
1249
 */
1250 1251
static bool __sched rt_mutex_slowunlock(struct rt_mutex *lock,
					struct wake_q_head *wake_q)
I
Ingo Molnar 已提交
1252
{
1253
	raw_spin_lock(&lock->wait_lock);
I
Ingo Molnar 已提交
1254 1255 1256 1257 1258

	debug_rt_mutex_unlock(lock);

	rt_mutex_deadlock_account_unlock(current);

T
Thomas Gleixner 已提交
1259 1260 1261 1262 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
	/*
	 * 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)
1293
			return false;
T
Thomas Gleixner 已提交
1294 1295
		/* Relock the rtmutex and try again */
		raw_spin_lock(&lock->wait_lock);
I
Ingo Molnar 已提交
1296 1297
	}

T
Thomas Gleixner 已提交
1298 1299 1300
	/*
	 * The wakeup next waiter path does not suffer from the above
	 * race. See the comments there.
1301 1302
	 *
	 * Queue the next waiter for wakeup once we release the wait_lock.
T
Thomas Gleixner 已提交
1303
	 */
1304
	mark_wakeup_next_waiter(wake_q, lock);
I
Ingo Molnar 已提交
1305

1306
	raw_spin_unlock(&lock->wait_lock);
I
Ingo Molnar 已提交
1307

1308 1309
	/* check PI boosting */
	return true;
I
Ingo Molnar 已提交
1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321
}

/*
 * 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,
1322
				enum rtmutex_chainwalk chwalk))
I
Ingo Molnar 已提交
1323
{
1324
	if (likely(rt_mutex_cmpxchg(lock, NULL, current))) {
I
Ingo Molnar 已提交
1325 1326 1327
		rt_mutex_deadlock_account_lock(lock, current);
		return 0;
	} else
1328
		return slowfn(lock, state, NULL, RT_MUTEX_MIN_CHAINWALK);
I
Ingo Molnar 已提交
1329 1330 1331 1332
}

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

static inline int
rt_mutex_fasttrylock(struct rt_mutex *lock,
1349
		     int (*slowfn)(struct rt_mutex *lock))
I
Ingo Molnar 已提交
1350 1351 1352 1353 1354
{
	if (likely(rt_mutex_cmpxchg(lock, NULL, current))) {
		rt_mutex_deadlock_account_lock(lock, current);
		return 1;
	}
1355
	return slowfn(lock);
I
Ingo Molnar 已提交
1356 1357 1358 1359
}

static inline void
rt_mutex_fastunlock(struct rt_mutex *lock,
1360 1361
		    bool (*slowfn)(struct rt_mutex *lock,
				   struct wake_q_head *wqh))
I
Ingo Molnar 已提交
1362
{
1363 1364 1365
	WAKE_Q(wake_q);

	if (likely(rt_mutex_cmpxchg(lock, current, NULL))) {
I
Ingo Molnar 已提交
1366
		rt_mutex_deadlock_account_unlock(current);
1367 1368 1369 1370 1371 1372 1373 1374 1375 1376

	} else {
		bool deboost = slowfn(lock, &wake_q);

		wake_up_q(&wake_q);

		/* Undo pi boosting if necessary: */
		if (deboost)
			rt_mutex_adjust_prio(current);
	}
I
Ingo Molnar 已提交
1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387
}

/**
 * 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();

1388
	rt_mutex_fastlock(lock, TASK_UNINTERRUPTIBLE, rt_mutex_slowlock);
I
Ingo Molnar 已提交
1389 1390 1391 1392 1393 1394
}
EXPORT_SYMBOL_GPL(rt_mutex_lock);

/**
 * rt_mutex_lock_interruptible - lock a rt_mutex interruptible
 *
1395
 * @lock:		the rt_mutex to be locked
I
Ingo Molnar 已提交
1396 1397
 *
 * Returns:
1398 1399
 *  0		on success
 * -EINTR	when interrupted by a signal
I
Ingo Molnar 已提交
1400
 */
1401
int __sched rt_mutex_lock_interruptible(struct rt_mutex *lock)
I
Ingo Molnar 已提交
1402 1403 1404
{
	might_sleep();

1405
	return rt_mutex_fastlock(lock, TASK_INTERRUPTIBLE, rt_mutex_slowlock);
I
Ingo Molnar 已提交
1406 1407 1408
}
EXPORT_SYMBOL_GPL(rt_mutex_lock_interruptible);

1409 1410 1411 1412 1413 1414 1415 1416
/*
 * Futex variant with full deadlock detection.
 */
int rt_mutex_timed_futex_lock(struct rt_mutex *lock,
			      struct hrtimer_sleeper *timeout)
{
	might_sleep();

1417 1418
	return rt_mutex_timed_fastlock(lock, TASK_INTERRUPTIBLE, timeout,
				       RT_MUTEX_FULL_CHAINWALK,
1419 1420 1421
				       rt_mutex_slowlock);
}

I
Ingo Molnar 已提交
1422
/**
1423 1424 1425
 * rt_mutex_timed_lock - lock a rt_mutex interruptible
 *			the timeout structure is provided
 *			by the caller
I
Ingo Molnar 已提交
1426
 *
1427
 * @lock:		the rt_mutex to be locked
I
Ingo Molnar 已提交
1428 1429 1430
 * @timeout:		timeout structure or NULL (no timeout)
 *
 * Returns:
1431 1432
 *  0		on success
 * -EINTR	when interrupted by a signal
1433
 * -ETIMEDOUT	when the timeout expired
I
Ingo Molnar 已提交
1434 1435
 */
int
1436
rt_mutex_timed_lock(struct rt_mutex *lock, struct hrtimer_sleeper *timeout)
I
Ingo Molnar 已提交
1437 1438 1439
{
	might_sleep();

1440 1441
	return rt_mutex_timed_fastlock(lock, TASK_INTERRUPTIBLE, timeout,
				       RT_MUTEX_MIN_CHAINWALK,
1442
				       rt_mutex_slowlock);
I
Ingo Molnar 已提交
1443 1444 1445 1446 1447 1448 1449 1450
}
EXPORT_SYMBOL_GPL(rt_mutex_timed_lock);

/**
 * rt_mutex_trylock - try to lock a rt_mutex
 *
 * @lock:	the rt_mutex to be locked
 *
1451 1452 1453 1454
 * This function can only be called in thread context. It's safe to
 * call it from atomic regions, but not from hard interrupt or soft
 * interrupt context.
 *
I
Ingo Molnar 已提交
1455 1456 1457 1458
 * Returns 1 on success and 0 on contention
 */
int __sched rt_mutex_trylock(struct rt_mutex *lock)
{
1459 1460 1461
	if (WARN_ON(in_irq() || in_nmi() || in_serving_softirq()))
		return 0;

I
Ingo Molnar 已提交
1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476
	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);

1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493
/**
 * rt_mutex_futex_unlock - Futex variant of rt_mutex_unlock
 * @lock: the rt_mutex to be unlocked
 *
 * Returns: true/false indicating whether priority adjustment is
 * required or not.
 */
bool __sched rt_mutex_futex_unlock(struct rt_mutex *lock,
				   struct wake_q_head *wqh)
{
	if (likely(rt_mutex_cmpxchg(lock, current, NULL))) {
		rt_mutex_deadlock_account_unlock(current);
		return false;
	}
	return rt_mutex_slowunlock(lock, wqh);
}

1494
/**
I
Ingo Molnar 已提交
1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523
 * 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;
1524
	raw_spin_lock_init(&lock->wait_lock);
1525 1526
	lock->waiters = RB_ROOT;
	lock->waiters_leftmost = NULL;
I
Ingo Molnar 已提交
1527 1528 1529 1530

	debug_rt_mutex_init(lock, name);
}
EXPORT_SYMBOL_GPL(__rt_mutex_init);
1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545

/**
 * 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);
1546
	debug_rt_mutex_proxy_lock(lock, proxy_owner);
1547
	rt_mutex_set_owner(lock, proxy_owner);
1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562
	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);
1563
	rt_mutex_set_owner(lock, NULL);
1564 1565 1566
	rt_mutex_deadlock_account_unlock(proxy_owner);
}

D
Darren Hart 已提交
1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581
/**
 * 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,
1582
			      struct task_struct *task)
D
Darren Hart 已提交
1583 1584 1585
{
	int ret;

1586
	raw_spin_lock(&lock->wait_lock);
D
Darren Hart 已提交
1587

1588
	if (try_to_take_rt_mutex(lock, task, NULL)) {
1589
		raw_spin_unlock(&lock->wait_lock);
D
Darren Hart 已提交
1590 1591 1592
		return 1;
	}

1593
	/* We enforce deadlock detection for futexes */
1594 1595
	ret = task_blocks_on_rt_mutex(lock, waiter, task,
				      RT_MUTEX_FULL_CHAINWALK);
D
Darren Hart 已提交
1596

1597
	if (ret && !rt_mutex_owner(lock)) {
D
Darren Hart 已提交
1598 1599 1600 1601 1602 1603 1604 1605
		/*
		 * 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;
	}
1606 1607 1608 1609

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

1610
	raw_spin_unlock(&lock->wait_lock);
D
Darren Hart 已提交
1611 1612 1613 1614 1615 1616

	debug_rt_mutex_print_deadlock(waiter);

	return ret;
}

1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635
/**
 * 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 已提交
1636 1637 1638 1639 1640

/**
 * 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
1641
 *			been started.
D
Darren Hart 已提交
1642 1643 1644 1645 1646 1647
 * @waiter:		the pre-initialized rt_mutex_waiter
 *
 * Complete the lock acquisition started our behalf by another thread.
 *
 * Returns:
 *  0 - success
1648
 * <0 - error, one of -EINTR, -ETIMEDOUT
D
Darren Hart 已提交
1649 1650 1651 1652 1653
 *
 * Special API call for PI-futex requeue support
 */
int rt_mutex_finish_proxy_lock(struct rt_mutex *lock,
			       struct hrtimer_sleeper *to,
1654
			       struct rt_mutex_waiter *waiter)
D
Darren Hart 已提交
1655 1656 1657
{
	int ret;

1658
	raw_spin_lock(&lock->wait_lock);
D
Darren Hart 已提交
1659 1660 1661

	set_current_state(TASK_INTERRUPTIBLE);

1662
	/* sleep on the mutex */
1663
	ret = __rt_mutex_slowlock(lock, TASK_INTERRUPTIBLE, to, waiter);
D
Darren Hart 已提交
1664

1665
	if (unlikely(ret))
D
Darren Hart 已提交
1666 1667 1668 1669 1670 1671 1672 1673
		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);

1674
	raw_spin_unlock(&lock->wait_lock);
D
Darren Hart 已提交
1675 1676 1677

	return ret;
}