mutex subsystem, add asm-generic/mutex-[dec|xchg|null].h implementations
PATCH 3/21 mutex subsystem, add asm-generic/mutex-[dec|xchg|null].h implementations
Add three (generic) mutex fastpath implementations.
The mutex-xchg.h implementation is atomic_xchg() based, and should work fine on every architecture.
The mutex-dec.h implementation is atomic_dec_return() based - this one too should work on every architecture, but might not perform the most optimally on architectures that have no atomic-dec/inc instructions.
The mutex-null.h implementation forces all calls into the slowpath. This is used for mutex debugging, but it can also be used on platforms that do not want (or need) a fastpath at all.
----
include/asm-generic/mutex-dec.h | 103 ++++++++++++++++++++++++++++++++++++ include/asm-generic/mutex-null.h | 24 ++++++++ include/asm-generic/mutex-xchg.h | 111 +++++++++++++++++++++++++++++++++++++++ 3 files changed, 238 insertions(+)
include/asm-generic/mutex-dec.h new file +103 -0
@@ -0,0 +1,103 @@ +/* +* asm-generic/mutex-dec.h +* +* Generic implementation of the mutex fastpath, based on atomic +* decrement/increment. +*/ +#ifndef _ASM_GENERIC_MUTEX_DEC_H +#define _ASM_GENERIC_MUTEX_DEC_H + +/** +* __mutex_fastpath_lock - try to take the lock by moving the count +* from 1 to a 0 value +* @count: pointer of type atomic_t +* @fail_fn: function to call if the original value was not 1 +* +* Change the count from 1 to a value lower than 1, and call <fail_fn> if +* it wasn't 1 originally. This function MUST leave the value lower than +* 1 even when the "1" assertion wasn't true. +*/ +#define __mutex_fastpath_lock (count, fail_fn) \ +do { \ + if (unlikely(atomic_dec_return(count) < 0)) \ + fail_fn(count); \ +} while (0) + +/** +* __mutex_fastpath_lock_retval - try to take the lock by moving the count +* from 1 to a 0 value +* @count: pointer of type atomic_t +* @fail_fn: function to call if the original value was not 1 +* +* Change the count from 1 to a value lower than 1, and call <fail_fn> if +* it wasn't 1 originally. This function returns 0 if the fastpath succeeds, +* or anything the slow path function returns. +*/ +static inline int +__mutex_fastpath_lock_retval (atomic_t *count,int (*fail_fn)(atomic_t *)) +{ +if (unlikely (atomic_dec_return (count) <0 )) +return fail_fn (count); +else +return 0 ; +} + +/** +* __mutex_fastpath_unlock - try to promote the count from 0 to 1 +* @count: pointer of type atomic_t +* @fail_fn: function to call if the original value was not 0 +* +* Try to promote the count from 0 to 1. If it wasn't 0, call <fail_fn>. +* In the failure case, this function is allowed to either set the value to +* 1, or to set it to a value lower than 1. +* +* If the implementation sets it to a value of lower than 1, then the +* __mutex_slowpath_needs_to_unlock() macro needs to return 1, it needs +* to return 0 otherwise. +*/ +#define __mutex_fastpath_unlock (count, fail_fn) \ +do { \ + if (unlikely(atomic_inc_return(count) <= 0)) \ + fail_fn(count); \ +} while (0) + +#define __mutex_slowpath_needs_to_unlock () 1 + +/** +* __mutex_fastpath_trylock - try to acquire the mutex, without waiting +* +* @count: pointer of type atomic_t +* @fail_fn: fallback function +* +* Change the count from 1 to a value lower than 1, and return 0 (failure) +* if it wasn't 1 originally, or return 1 (success) otherwise. This function +* MUST leave the value lower than 1 even when the "1" assertion wasn't true. +* Additionally, if the value was < 0 originally, this function must not leave +* it to 0 on failure. +* +* If the architecture has no effective trylock variant, it should call the +* <fail_fn> spinlock-based trylock variant unconditionally. +*/ +static inline int +__mutex_fastpath_trylock (atomic_t *count,int (*fail_fn)(atomic_t *)) +{ +/* +* We have two variants here. The cmpxchg based one is the best one +* because it never induce a false contention state. It is included +* here because architectures using the inc/dec algorithms over the +* xchg ones are much more likely to support cmpxchg natively. +* +* If not we fall back to the spinlock based variant - that is +* just as efficient (and simpler) as a 'destructive' probing of +* the mutex state would be. +*/ +#ifdef __HAVE_ARCH_CMPXCHG +if (likely (atomic_cmpxchg (count,1 ,0 )) ==1 ) +return 1 ; +return 0 ; +#else +return fail_fn (count); +#endif +} + +#endif
include/asm-generic/mutex-null.h new file +24 -0
@@ -0,0 +1,24 @@ +/* +* asm-generic/mutex-null.h +* +* Generic implementation of the mutex fastpath, based on NOP :-) +* +* This is used by the mutex-debugging infrastructure, but it can also +* be used by architectures that (for whatever reason) want to use the +* spinlock based slowpath. +*/ +#ifndef _ASM_GENERIC_MUTEX_NULL_H +#define _ASM_GENERIC_MUTEX_NULL_H + +/* extra parameter only needed for mutex debugging: */ +#ifndef __IP__ +# define __IP__ +#endif + +#define __mutex_fastpath_lock (count, fail_fn) fail_fn(count __RET_IP__) +#define __mutex_fastpath_lock_retval (count, fail_fn) fail_fn(count __RET_IP__) +#define __mutex_fastpath_unlock (count, fail_fn) fail_fn(count __RET_IP__) +#define __mutex_fastpath_trylock (count, fail_fn) fail_fn(count) +#define __mutex_slowpath_needs_to_unlock () 1 + +#endif
include/asm-generic/mutex-xchg.h new file +111 -0
111 lines not on this page · raw message
Quoted 10 lines · Ingo Molnar
Add three (generic) mutex fastpath implementations.
The
mutex-xchg.himplementation isatomic_xchg()based, and should work fine on every architecture.The
mutex-dec.himplementation isatomic_dec_return()based - this one too should work on every architecture, but might not perform the most optimally on architectures that have no atomic-dec/inc instructions.
Quoted 6 lines
The
mutex-null.himplementation forces all calls into the slowpath. This is used for mutex debugging, but it can also be used on platforms that do not want (or need) a fastpath at all.Signed-off-by Ingo Molnar <[email protected]>Signed-off-by Arjan van de Ven <[email protected]>
What about this patch that turns some macros into inline functions? It adds proper type checking as well as being more readable.
I was under the impression that, at least on ARM, the passing of a function pointer to an inline function would have caused indirect calls through that function pointer but that doesn't seem to be true.
include/asm-generic/mutex-dec.h +13 -11
@@ -17,11 +17,12 @@* it wasn't 1 originally. This function MUST leave the value lower than * 1 even when the "1" assertion wasn't true. */ -#define __mutex_fastpath_lock (count, fail_fn) \ -do { \ - if (unlikely(atomic_dec_return(count) < 0)) \ - fail_fn(count); \ -} while (0) +static inline void +__mutex_fastpath_lock(atomic_t *count, fastcall void (*fail_fn)(atomic_t *)) +{ +if (unlikely (atomic_dec_return (count) <0 )) +fail_fn (count); +}/** * __mutex_fastpath_lock_retval - try to take the lock by moving the count
@@ -34,7 +35,7 @@ do { \* or anything the slow path function returns. */ static inline int -__mutex_fastpath_lock_retval (atomic_t *count,int (*fail_fn)(atomic_t *)) +__mutex_fastpath_lock_retval(atomic_t *count, fastcall int (*fail_fn)(atomic_t *)) {if (unlikely (atomic_dec_return (count) <0 ))return fail_fn (count);
@@ -55,11 +56,12 @@ __mutex_fastpath_lock_retval(atomic_t *c* __mutex_slowpath_needs_to_unlock() macro needs to return 1, it needs * to return 0 otherwise. */ -#define __mutex_fastpath_unlock (count, fail_fn) \ -do { \ - if (unlikely(atomic_inc_return(count) <= 0)) \ - fail_fn(count); \ -} while (0) +static inline void +__mutex_fastpath_unlock(atomic_t *count, fastcall void (*fail_fn)(atomic_t *)) +{ +if (unlikely (atomic_inc_return (count) <=0 )) +fail_fn (count); +}#define __mutex_slowpath_needs_to_unlock () 1
include/asm-generic/mutex-xchg.h +13 -12
@@ -22,12 +22,12 @@* wasn't 1 originally. This function MUST leave the value lower than 1 * even when the "1" assertion wasn't true. */ -#define __mutex_fastpath_lock (count, fail_fn) \ -do { \ - if (unlikely(atomic_xchg(count, 0) != 1)) \ - fail_fn(count); \ -} while (0) - +static inline void +__mutex_fastpath_lock(atomic_t *count, fastcall void (*fail_fn)(atomic_t *)) +{ +if (unlikely (atomic_xchg (count,0 ) !=1 )) +fail_fn (count); +}/** * __mutex_fastpath_lock_retval - try to take the lock by moving the count
@@ -40,7 +40,7 @@ do { \* or anything the slow path function returns */ static inline int -__mutex_fastpath_lock_retval (atomic_t *count,int (*fail_fn)(atomic_t *)) +__mutex_fastpath_lock_retval(atomic_t *count, fastcall int (*fail_fn)(atomic_t *)) {if (unlikely (atomic_xchg (count,0 ) !=1 ))return fail_fn (count);
@@ -60,11 +60,12 @@ __mutex_fastpath_lock_retval(atomic_t *c* __mutex_slowpath_needs_to_unlock() macro needs to return 1, it needs * to return 0 otherwise. */ -#define __mutex_fastpath_unlock (count, fail_fn) \ -do { \ - if (unlikely(atomic_xchg(count, 1) != 0)) \ - fail_fn(count); \ -} while (0) +static inline void +__mutex_fastpath_unlock(atomic_t *count, fastcall void (*fail_fn)(atomic_t *)) +{ +if (unlikely (atomic_xchg (count,1 ) !=0 )) +fail_fn (count); +}#define __mutex_slowpath_needs_to_unlock () 0