// SPDX-License-Identifier: GPL-2.0-only/* * kernel/locking/mutex.c * * Mutexes: blocking mutual exclusion locks * * Started by Ingo Molnar: * *  Copyright (C) 2004, 2005, 2006 Red Hat, Inc., Ingo Molnar <mingo@redhat.com> * * Many thanks to Arjan van de Ven, Thomas Gleixner, Steven Rostedt and * David Howells for suggestions and improvements. * *  - Adaptive spinning for mutexes by Peter Zijlstra. (Ported to mainline *    from the -rt tree, where it was originally implemented for rtmutexes *    by Steven Rostedt, based on work by Gregory Haskins, Peter Morreale *    and Sven Dietrich. * * Also see Documentation/locking/mutex-design.rst. */#include <linux/mutex.h>#include <linux/ww_mutex.h>#include <linux/sched/signal.h>#include <linux/sched/rt.h>#include <linux/sched/wake_q.h>#include <linux/sched/debug.h>#include <linux/export.h>#include <linux/spinlock.h>#include <linux/interrupt.h>#include <linux/debug_locks.h>#include <linux/osq_lock.h> #ifdef CONFIG_DEBUG_MUTEXES# include "mutex-debug.h"#else# include "mutex.h"#endif void__mutex_init(struct mutex *lock, const char *name, struct lock_class_key *key){	atomic_long_set(&lock->owner, 0);	spin_lock_init(&lock->wait_lock);	INIT_LIST_HEAD(&lock->wait_list);#ifdef CONFIG_MUTEX_SPIN_ON_OWNER	osq_lock_init(&lock->osq);#endif 	debug_mutex_init(lock, name, key);}EXPORT_SYMBOL(__mutex_init); /* * @owner: contains: 'struct task_struct *' to the current lock owner, * NULL means not owned. Since task_struct pointers are aligned at * at least L1_CACHE_BYTES, we have low bits to store extra state. * * Bit0 indicates a non-empty waiter list; unlock must issue a wakeup. * Bit1 indicates unlock needs to hand the lock to the top-waiter * Bit2 indicates handoff has been done and we're waiting for pickup. */#define MUTEX_FLAG_WAITERS	0x01#define MUTEX_FLAG_HANDOFF	0x02#define MUTEX_FLAG_PICKUP	0x04 #define MUTEX_FLAGS		0x07 /* * Internal helper function; C doesn't allow us to hide it :/ * * DO NOT USE (outside of mutex code). */static inline struct task_struct *__mutex_owner(struct mutex *lock){	return (struct task_struct *)(atomic_long_read(&lock->owner) & ~MUTEX_FLAGS);} static inline struct task_struct *__owner_task(unsigned long owner){	return (struct task_struct *)(owner & ~MUTEX_FLAGS);} bool mutex_is_locked(struct mutex *lock){	return __mutex_owner(lock) != NULL;}EXPORT_SYMBOL(mutex_is_locked); static inline unsigned long __owner_flags(unsigned long owner){	return owner & MUTEX_FLAGS;} /* * Trylock variant that retuns the owning task on failure. */static inline struct task_struct *__mutex_trylock_or_owner(struct mutex *lock){	unsigned long owner, curr = (unsigned long)current; 	owner = atomic_long_read(&lock->owner);	for (;;) { /* must loop, can race against a flag */		unsigned long old, flags = __owner_flags(owner);		unsigned long task = owner & ~MUTEX_FLAGS; 		if (task) {			if (likely(task != curr))				break; 			if (likely(!(flags & MUTEX_FLAG_PICKUP)))				break; 			flags &= ~MUTEX_FLAG_PICKUP;		} else {#ifdef CONFIG_DEBUG_MUTEXES			DEBUG_LOCKS_WARN_ON(flags & MUTEX_FLAG_PICKUP);#endif		} 		/*		 * We set the HANDOFF bit, we must make sure it doesn't live		 * past the point where we acquire it. This would be possible		 * if we (accidentally) set the bit on an unlocked mutex.		 */		flags &= ~MUTEX_FLAG_HANDOFF; 		old = atomic_long_cmpxchg_acquire(&lock->owner, owner, curr | flags);		if (old == owner)			return NULL; 		owner = old;	} 	return __owner_task(owner);} /* * Actual trylock that will work on any unlocked state. */static inline bool __mutex_trylock(struct mutex *lock){	return !__mutex_trylock_or_owner(lock);} #ifndef CONFIG_DEBUG_LOCK_ALLOC/* * Lockdep annotations are contained to the slow paths for simplicity. * There is nothing that would stop spreading the lockdep annotations outwards * except more code. */ /* * Optimistic trylock that only works in the uncontended case. Make sure to * follow with a __mutex_trylock() before failing. */static __always_inline bool __mutex_trylock_fast(struct mutex *lock){	unsigned long curr = (unsigned long)current;	unsigned long zero = 0UL; 	if (atomic_long_try_cmpxchg_acquire(&lock->owner, &zero, curr))		return true; 	return false;} static __always_inline bool __mutex_unlock_fast(struct mutex *lock){	unsigned long curr = (unsigned long)current; 	if (atomic_long_cmpxchg_release(&lock->owner, curr, 0UL) == curr)		return true; 	return false;}#endif static inline void __mutex_set_flag(struct mutex *lock, unsigned long flag){	atomic_long_or(flag, &lock->owner);} static inline void __mutex_clear_flag(struct mutex *lock, unsigned long flag){	atomic_long_andnot(flag, &lock->owner);} static inline bool __mutex_waiter_is_first(struct mutex *lock, struct mutex_waiter *waiter){	return list_first_entry(&lock->wait_list, struct mutex_waiter, list) == waiter;} /* * Add @waiter to a given location in the lock wait_list and set the * FLAG_WAITERS flag if it's the first waiter. */static void __sched__mutex_add_waiter(struct mutex *lock, struct mutex_waiter *waiter,		   struct list_head *list){	debug_mutex_add_waiter(lock, waiter, current); 	list_add_tail(&waiter->list, list);	if (__mutex_waiter_is_first(lock, waiter))		__mutex_set_flag(lock, MUTEX_FLAG_WAITERS);} /* * Give up ownership to a specific task, when @task = NULL, this is equivalent * to a regular unlock. Sets PICKUP on a handoff, clears HANDOF, preserves * WAITERS. Provides RELEASE semantics like a regular unlock, the * __mutex_trylock() provides a matching ACQUIRE semantics for the handoff. */static void __mutex_handoff(struct mutex *lock, struct task_struct *task){	unsigned long owner = atomic_long_read(&lock->owner); 	for (;;) {		unsigned long old, new; #ifdef CONFIG_DEBUG_MUTEXES		DEBUG_LOCKS_WARN_ON(__owner_task(owner) != current);		DEBUG_LOCKS_WARN_ON(owner & MUTEX_FLAG_PICKUP);#endif 		new = (owner & MUTEX_FLAG_WAITERS);		new |= (unsigned long)task;		if (task)			new |= MUTEX_FLAG_PICKUP; 		old = atomic_long_cmpxchg_release(&lock->owner, owner, new);		if (old == owner)			break; 		owner = old;	}} #ifndef CONFIG_DEBUG_LOCK_ALLOC/* * We split the mutex lock/unlock logic into separate fastpath and * slowpath functions, to reduce the register pressure on the fastpath. * We also put the fastpath first in the kernel image, to make sure the * branch is predicted by the CPU as default-untaken. */static void __sched __mutex_lock_slowpath(struct mutex *lock); /** * mutex_lock - acquire the mutex * @lock: the mutex to be acquired * * Lock the mutex exclusively for this task. If the mutex is not * available right now, it will sleep until it can get it. * * The mutex must later on be released by the same task that * acquired it. Recursive locking is not allowed. The task * may not exit without first unlocking the mutex. Also, kernel * memory where the mutex resides must not be freed with * the mutex still locked. The mutex must first be initialized * (or statically defined) before it can be locked. memset()-ing * the mutex to 0 is not allowed. * * (The CONFIG_DEBUG_MUTEXES .config option turns on debugging * checks that will enforce the restrictions and will also do * deadlock debugging) * * This function is similar to (but not equivalent to) down(). */void __sched mutex_lock(struct mutex *lock){	might_sleep(); 	if (!__mutex_trylock_fast(lock))		__mutex_lock_slowpath(lock);}EXPORT_SYMBOL(mutex_lock);#endif /* * Wait-Die: *   The newer transactions are killed when: *     It (the new transaction) makes a request for a lock being held *     by an older transaction. * * Wound-Wait: *   The newer transactions are wounded when: *     An older transaction makes a request for a lock being held by *     the newer transaction. */ /* * Associate the ww_mutex @ww with the context @ww_ctx under which we acquired * it. */static __always_inline voidww_mutex_lock_acquired(struct ww_mutex *ww, struct ww_acquire_ctx *ww_ctx){#ifdef CONFIG_DEBUG_MUTEXES	/*	 * If this WARN_ON triggers, you used ww_mutex_lock to acquire,	 * but released with a normal mutex_unlock in this call.	 *	 * This should never happen, always use ww_mutex_unlock.	 */	DEBUG_LOCKS_WARN_ON(ww->ctx); 	/*	 * Not quite done after calling ww_acquire_done() ?	 */	DEBUG_LOCKS_WARN_ON(ww_ctx->done_acquire); 	if (ww_ctx->contending_lock) {		/*		 * After -EDEADLK you tried to		 * acquire a different ww_mutex? Bad!		 */		DEBUG_LOCKS_WARN_ON(ww_ctx->contending_lock != ww); 		/*		 * You called ww_mutex_lock after receiving -EDEADLK,		 * but 'forgot' to unlock everything else first?		 */		DEBUG_LOCKS_WARN_ON(ww_ctx->acquired > 0);		ww_ctx->contending_lock = NULL;	} 	/*	 * Naughty, using a different class will lead to undefined behavior!	 */	DEBUG_LOCKS_WARN_ON(ww_ctx->ww_class != ww->ww_class);#endif	ww_ctx->acquired++;	ww->ctx = ww_ctx;} /* * Determine if context @a is 'after' context @b. IOW, @a is a younger * transaction than @b and depending on algorithm either needs to wait for * @b or die. */static inline bool __sched__ww_ctx_stamp_after(struct ww_acquire_ctx *a, struct ww_acquire_ctx *b){ 	return (signed long)(a->stamp - b->stamp) > 0;} /* * Wait-Die; wake a younger waiter context (when locks held) such that it can * die. * * Among waiters with context, only the first one can have other locks acquired * already (ctx->acquired > 0), because __ww_mutex_add_waiter() and * __ww_mutex_check_kill() wake any but the earliest context. */static bool __sched__ww_mutex_die(struct mutex *lock, struct mutex_waiter *waiter,	       struct ww_acquire_ctx *ww_ctx){	if (!ww_ctx->is_wait_die)		return false; 	if (waiter->ww_ctx->acquired > 0 &&			__ww_ctx_stamp_after(waiter->ww_ctx, ww_ctx)) {		debug_mutex_wake_waiter(lock, waiter);		wake_up_process(waiter->task);	} 	return true;} /* * Wound-Wait; wound a younger @hold_ctx if it holds the lock. * * Wound the lock holder if there are waiters with older transactions than * the lock holders. Even if multiple waiters may wound the lock holder, * it's sufficient that only one does. */static bool __ww_mutex_wound(struct mutex *lock,			     struct ww_acquire_ctx *ww_ctx,			     struct ww_acquire_ctx *hold_ctx){	struct task_struct *owner = __mutex_owner(lock); 	lockdep_assert_held(&lock->wait_lock); 	/*	 * Possible through __ww_mutex_add_waiter() when we race with	 * ww_mutex_set_context_fastpath(). In that case we'll get here again	 * through __ww_mutex_check_waiters().	 */	if (!hold_ctx)		return false; 	/*	 * Can have !owner because of __mutex_unlock_slowpath(), but if owner,	 * it cannot go away because we'll have FLAG_WAITERS set and hold	 * wait_lock.	 */	if (!owner)		return false; 	if (ww_ctx->acquired > 0 && __ww_ctx_stamp_after(hold_ctx, ww_ctx)) {		hold_ctx->wounded = 1; 		/*		 * wake_up_process() paired with set_current_state()		 * inserts sufficient barriers to make sure @owner either sees		 * it's wounded in __ww_mutex_check_kill() or has a		 * wakeup pending to re-read the wounded state.		 */		if (owner != current)			wake_up_process(owner); 		return true;	} 	return false;} /* * We just acquired @lock under @ww_ctx, if there are later contexts waiting * behind us on the wait-list, check if they need to die, or wound us. * * See __ww_mutex_add_waiter() for the list-order construction; basically the * list is ordered by stamp, smallest (oldest) first. * * This relies on never mixing wait-die/wound-wait on the same wait-list; * which is currently ensured by that being a ww_class property. * * The current task must not be on the wait list. */static void __sched__ww_mutex_check_waiters(struct mutex *lock, struct ww_acquire_ctx *ww_ctx){	struct mutex_waiter *cur; 	lockdep_assert_held(&lock->wait_lock); 	list_for_each_entry(cur, &lock->wait_list, list) {		if (!cur->ww_ctx)			continue; 		if (__ww_mutex_die(lock, cur, ww_ctx) ||		    __ww_mutex_wound(lock, cur->ww_ctx, ww_ctx))			break;	}} /* * After acquiring lock with fastpath, where we do not hold wait_lock, set ctx * and wake up any waiters so they can recheck. */static __always_inline voidww_mutex_set_context_fastpath(struct ww_mutex *lock, struct ww_acquire_ctx *ctx){	ww_mutex_lock_acquired(lock, ctx); 	/*	 * The lock->ctx update should be visible on all cores before	 * the WAITERS check is done, otherwise contended waiters might be	 * missed. The contended waiters will either see ww_ctx == NULL	 * and keep spinning, or it will acquire wait_lock, add itself	 * to waiter list and sleep.	 */	smp_mb(); /* See comments above and below. */ 	/*	 * [W] ww->ctx = ctx	    [W] MUTEX_FLAG_WAITERS	 *     MB		        MB	 * [R] MUTEX_FLAG_WAITERS   [R] ww->ctx	 *	 * The memory barrier above pairs with the memory barrier in	 * __ww_mutex_add_waiter() and makes sure we either observe ww->ctx	 * and/or !empty list.	 */	if (likely(!(atomic_long_read(&lock->base.owner) & MUTEX_FLAG_WAITERS)))		return; 	/*	 * Uh oh, we raced in fastpath, check if any of the waiters need to	 * die or wound us.	 */	spin_lock(&lock->base.wait_lock);	__ww_mutex_check_waiters(&lock->base, ctx);	spin_unlock(&lock->base.wait_lock);} #ifdef CONFIG_MUTEX_SPIN_ON_OWNER static inlinebool ww_mutex_spin_on_owner(struct mutex *lock, struct ww_acquire_ctx *ww_ctx,			    struct mutex_waiter *waiter){	struct ww_mutex *ww; 	ww = container_of(lock, struct ww_mutex, base); 	/*	 * If ww->ctx is set the contents are undefined, only

Lines 1–500 of 1474. Load more