Commit b7e4aade authored May 14, 2018 by Andrea Parri Committed by Ingo Molnar May 15, 2018

locking/spinlocks: Document the semantics of spin_is_locked()

There appeared to be a certain, recurrent uncertainty concerning the
semantics of spin_is_locked(), likely a consequence of the fact that
this semantics remains undocumented or that it has been historically
linked to the (likewise unclear) semantics of spin_unlock_wait().

A recent auditing [1] of the callers of the primitive confirmed that
none of them are relying on particular ordering guarantees; document
this semantics by adding a docbook header to spin_is_locked(). Also,
describe behaviors specific to certain CONFIG_SMP=n builds.

[1] https://marc.info/?l=linux-kernel&m=151981440005264&w=2
    https://marc.info/?l=linux-kernel&m=152042843808540&w=2
    https://marc.info/?l=linux-kernel&m=152043346110262&w=2



Co-Developed-by: Andrea Parri <andrea.parri@amarulasolutions.com>
Co-Developed-by: Alan Stern <stern@rowland.harvard.edu>
Co-Developed-by: David Howells <dhowells@redhat.com>
Signed-off-by: Andrea Parri <andrea.parri@amarulasolutions.com>
Signed-off-by: Alan Stern <stern@rowland.harvard.edu>
Signed-off-by: David Howells <dhowells@redhat.com>
Signed-off-by: Paul E. McKenney <paulmck@linux.vnet.ibm.com>
Acked-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Akira Yokosawa <akiyks@gmail.com>
Cc: Andrew Morton <akpm@linux-foundation.org>
Cc: Boqun Feng <boqun.feng@gmail.com>
Cc: Jade Alglave <j.alglave@ucl.ac.uk>
Cc: Linus Torvalds <torvalds@linux-foundation.org>
Cc: Luc Maranget <luc.maranget@inria.fr>
Cc: Nicholas Piggin <npiggin@gmail.com>
Cc: Peter Zijlstra <peterz@infradead.org>
Cc: Thomas Gleixner <tglx@linutronix.de>
Cc: Will Deacon <will.deacon@arm.com>
Cc: linux-arch@vger.kernel.org
Cc: parri.andrea@gmail.com
Link: http://lkml.kernel.org/r/1526338889-7003-1-git-send-email-paulmck@linux.vnet.ibm.com


Signed-off-by: Ingo Molnar <mingo@kernel.org>

parent 173af261

include/linux/spinlock.h

+18 −0

Original line number	Diff line number	Diff line
		@@ -380,6 +380,24 @@ static __always_inline int spin_trylock_irq(spinlock_t *lock)
		raw_spin_trylock_irqsave(spinlock_check(lock), flags); \
		})

		/**
		* spin_is_locked() - Check whether a spinlock is locked.
		* @lock: Pointer to the spinlock.
		*
		* This function is NOT required to provide any memory ordering
		* guarantees; it could be used for debugging purposes or, when
		* additional synchronization is needed, accompanied with other
		* constructs (memory barriers) enforcing the synchronization.
		*
		* Returns: 1 if @lock is locked, 0 otherwise.
		*
		* Note that the function only tells you that the spinlock is
		* seen to be locked, not that it is locked on your CPU.
		*
		* Further, on CONFIG_SMP=n builds with CONFIG_DEBUG_SPINLOCK=n,
		* the return value is always 0 (see include/linux/spinlock_up.h).
		* Therefore you should not rely heavily on the return value.
		*/
		static __always_inline int spin_is_locked(spinlock_t *lock)
		{
		return raw_spin_is_locked(&lock->rlock);

Admin message