[mirror_ubuntu-bionic-kernel.git] / arch / x86 / include / asm / rwsem.h

/* rwsem.h: R/W semaphores implemented using XADD/CMPXCHG for i486+
 *
 * Written by David Howells (dhowells@redhat.com).
 *
 * Derived from asm-x86/semaphore.h
 *
 *
 * The MSW of the count is the negated number of active writers and waiting
 * lockers, and the LSW is the total number of active locks
 *
 * The lock count is initialized to 0 (no active and no waiting lockers).
 *
 * When a writer subtracts WRITE_BIAS, it'll get 0xffff0001 for the case of an
 * uncontended lock. This can be determined because XADD returns the old value.
 * Readers increment by 1 and see a positive value when uncontended, negative
 * if there are writers (and maybe) readers waiting (in which case it goes to
 * sleep).
 *
 * The value of WAITING_BIAS supports up to 32766 waiting processes. This can
 * be extended to 65534 by manually checking the whole MSW rather than relying
 * on the S flag.
 *
 * The value of ACTIVE_BIAS supports up to 65535 active processes.
 *
 * This should be totally fair - if anything is waiting, a process that wants a
 * lock will go to the back of the queue. When the currently active lock is
 * released, if there's a writer at the front of the queue, then that and only
 * that will be woken up; if there's a bunch of consecutive readers at the
 * front, then they'll all be woken up, but no other readers will be.
 */

#ifndef _ASM_X86_RWSEM_H
#define _ASM_X86_RWSEM_H

#ifndef _LINUX_RWSEM_H
#error "please don't include asm/rwsem.h directly, use linux/rwsem.h instead"
#endif

#ifdef __KERNEL__
#include <asm/asm.h>

/*
 * The bias values and the counter type limits the number of
 * potential readers/writers to 32767 for 32 bits and 2147483647
 * for 64 bits.
 */

#ifdef CONFIG_X86_64
# define RWSEM_ACTIVE_MASK		0xffffffffL
#else
# define RWSEM_ACTIVE_MASK		0x0000ffffL
#endif

#define RWSEM_UNLOCKED_VALUE		0x00000000L
#define RWSEM_ACTIVE_BIAS		0x00000001L
#define RWSEM_WAITING_BIAS		(-RWSEM_ACTIVE_MASK-1)
#define RWSEM_ACTIVE_READ_BIAS		RWSEM_ACTIVE_BIAS
#define RWSEM_ACTIVE_WRITE_BIAS		(RWSEM_WAITING_BIAS + RWSEM_ACTIVE_BIAS)

/*
 * lock for reading
 */
static inline void __down_read(struct rw_semaphore *sem)
{
	asm volatile("# beginning down_read\n\t"
		     LOCK_PREFIX _ASM_INC "(%1)\n\t"
		     /* adds 0x00000001 */
		     "  jns        1f\n"
		     "  call call_rwsem_down_read_failed\n"
		     "1:\n\t"
		     "# ending down_read\n\t"
		     : "+m" (sem->count)
		     : "a" (sem)
		     : "memory", "cc");
}

/*
 * trylock for reading -- returns 1 if successful, 0 if contention
 */
static inline bool __down_read_trylock(struct rw_semaphore *sem)
{
	long result, tmp;
	asm volatile("# beginning __down_read_trylock\n\t"
		     "  mov          %0,%1\n\t"
		     "1:\n\t"
		     "  mov          %1,%2\n\t"
		     "  add          %3,%2\n\t"
		     "  jle	     2f\n\t"
		     LOCK_PREFIX "  cmpxchg  %2,%0\n\t"
		     "  jnz	     1b\n\t"
		     "2:\n\t"
		     "# ending __down_read_trylock\n\t"
		     : "+m" (sem->count), "=&a" (result), "=&r" (tmp)
		     : "i" (RWSEM_ACTIVE_READ_BIAS)
		     : "memory", "cc");
	return result >= 0;
}

/*
 * lock for writing
 */
#define ____down_write(sem, slow_path)			\
({							\
	long tmp;					\
	struct rw_semaphore* ret;			\
	register void *__sp asm(_ASM_SP);		\
							\
	asm volatile("# beginning down_write\n\t"	\
		     LOCK_PREFIX "  xadd      %1,(%4)\n\t"	\
		     /* adds 0xffff0001, returns the old value */ \
		     "  test " __ASM_SEL(%w1,%k1) "," __ASM_SEL(%w1,%k1) "\n\t" \
		     /* was the active mask 0 before? */\
		     "  jz        1f\n"			\
		     "  call " slow_path "\n"		\
		     "1:\n"				\
		     "# ending down_write"		\
		     : "+m" (sem->count), "=d" (tmp), "=a" (ret), "+r" (__sp) \
		     : "a" (sem), "1" (RWSEM_ACTIVE_WRITE_BIAS) \
		     : "memory", "cc");			\
	ret;						\
})

static inline void __down_write(struct rw_semaphore *sem)
{
	____down_write(sem, "call_rwsem_down_write_failed");
}

static inline int __down_write_killable(struct rw_semaphore *sem)
{
	if (IS_ERR(____down_write(sem, "call_rwsem_down_write_failed_killable")))
		return -EINTR;

	return 0;
}

/*
 * trylock for writing -- returns 1 if successful, 0 if contention
 */
static inline bool __down_write_trylock(struct rw_semaphore *sem)
{
	bool result;
	long tmp0, tmp1;
	asm volatile("# beginning __down_write_trylock\n\t"
		     "  mov          %0,%1\n\t"
		     "1:\n\t"
		     "  test " __ASM_SEL(%w1,%k1) "," __ASM_SEL(%w1,%k1) "\n\t"
		     /* was the active mask 0 before? */
		     "  jnz          2f\n\t"
		     "  mov          %1,%2\n\t"
		     "  add          %4,%2\n\t"
		     LOCK_PREFIX "  cmpxchg  %2,%0\n\t"
		     "  jnz	     1b\n\t"
		     "2:\n\t"
		     CC_SET(e)
		     "# ending __down_write_trylock\n\t"
		     : "+m" (sem->count), "=&a" (tmp0), "=&r" (tmp1),
		       CC_OUT(e) (result)
		     : "er" (RWSEM_ACTIVE_WRITE_BIAS)
		     : "memory");
	return result;
}

/*
 * unlock after reading
 */
static inline void __up_read(struct rw_semaphore *sem)
{
	long tmp;
	asm volatile("# beginning __up_read\n\t"
		     LOCK_PREFIX "  xadd      %1,(%2)\n\t"
		     /* subtracts 1, returns the old value */
		     "  jns        1f\n\t"
		     "  call call_rwsem_wake\n" /* expects old value in %edx */
		     "1:\n"
		     "# ending __up_read\n"
		     : "+m" (sem->count), "=d" (tmp)
		     : "a" (sem), "1" (-RWSEM_ACTIVE_READ_BIAS)
		     : "memory", "cc");
}

/*
 * unlock after writing
 */
static inline void __up_write(struct rw_semaphore *sem)
{
	long tmp;
	asm volatile("# beginning __up_write\n\t"
		     LOCK_PREFIX "  xadd      %1,(%2)\n\t"
		     /* subtracts 0xffff0001, returns the old value */
		     "  jns        1f\n\t"
		     "  call call_rwsem_wake\n" /* expects old value in %edx */
		     "1:\n\t"
		     "# ending __up_write\n"
		     : "+m" (sem->count), "=d" (tmp)
		     : "a" (sem), "1" (-RWSEM_ACTIVE_WRITE_BIAS)
		     : "memory", "cc");
}

/*
 * downgrade write lock to read lock
 */
static inline void __downgrade_write(struct rw_semaphore *sem)
{
	asm volatile("# beginning __downgrade_write\n\t"
		     LOCK_PREFIX _ASM_ADD "%2,(%1)\n\t"
		     /*
		      * transitions 0xZZZZ0001 -> 0xYYYY0001 (i386)
		      *     0xZZZZZZZZ00000001 -> 0xYYYYYYYY00000001 (x86_64)
		      */
		     "  jns       1f\n\t"
		     "  call call_rwsem_downgrade_wake\n"
		     "1:\n\t"
		     "# ending __downgrade_write\n"
		     : "+m" (sem->count)
		     : "a" (sem), "er" (-RWSEM_WAITING_BIAS)
		     : "memory", "cc");
}

#endif /* __KERNEL__ */
#endif /* _ASM_X86_RWSEM_H */
Commit	Line	Data
1da177e4 LT	1	/* rwsem.h: R/W semaphores implemented using XADD/CMPXCHG for i486+
	2	*
	3	* Written by David Howells (dhowells@redhat.com).
	4	*
99122a3f	5	* Derived from asm-x86/semaphore.h
1da177e4 LT	6	*
	7	*
	8	* The MSW of the count is the negated number of active writers and waiting
	9	* lockers, and the LSW is the total number of active locks
	10	*
	11	* The lock count is initialized to 0 (no active and no waiting lockers).
	12	*
	13	* When a writer subtracts WRITE_BIAS, it'll get 0xffff0001 for the case of an
	14	* uncontended lock. This can be determined because XADD returns the old value.
	15	* Readers increment by 1 and see a positive value when uncontended, negative
	16	* if there are writers (and maybe) readers waiting (in which case it goes to
	17	* sleep).
	18	*
	19	* The value of WAITING_BIAS supports up to 32766 waiting processes. This can
	20	* be extended to 65534 by manually checking the whole MSW rather than relying
	21	* on the S flag.
	22	*
	23	* The value of ACTIVE_BIAS supports up to 65535 active processes.
	24	*
	25	* This should be totally fair - if anything is waiting, a process that wants a
	26	* lock will go to the back of the queue. When the currently active lock is
	27	* released, if there's a writer at the front of the queue, then that and only
6a6256f9	28	* that will be woken up; if there's a bunch of consecutive readers at the
1da177e4 LT	29	* front, then they'll all be woken up, but no other readers will be.
	30	*/
	31
1965aae3 PA	32	#ifndef _ASM_X86_RWSEM_H
1965aae3 PA	33	#define _ASM_X86_RWSEM_H
1da177e4 LT	34
	35	#ifndef _LINUX_RWSEM_H
	36	#error "please don't include asm/rwsem.h directly, use linux/rwsem.h instead"
	37	#endif
	38
	39	#ifdef __KERNEL__
1838ef1d	40	#include <asm/asm.h>
1da177e4	41
1da177e4	42	/*
1838ef1d PA	43	* The bias values and the counter type limits the number of
	44	* potential readers/writers to 32767 for 32 bits and 2147483647
	45	* for 64 bits.
1da177e4	46	*/
6e5609a9	47
1838ef1d PA	48	#ifdef CONFIG_X86_64
	49	# define RWSEM_ACTIVE_MASK 0xffffffffL
	50	#else
	51	# define RWSEM_ACTIVE_MASK 0x0000ffffL
	52	#endif
	53
	54	#define RWSEM_UNLOCKED_VALUE 0x00000000L
	55	#define RWSEM_ACTIVE_BIAS 0x00000001L
	56	#define RWSEM_WAITING_BIAS (-RWSEM_ACTIVE_MASK-1)
1da177e4 LT	57	#define RWSEM_ACTIVE_READ_BIAS RWSEM_ACTIVE_BIAS
1da177e4 LT	58	#define RWSEM_ACTIVE_WRITE_BIAS (RWSEM_WAITING_BIAS + RWSEM_ACTIVE_BIAS)
6e5609a9	59
1da177e4 LT	60	/*
	61	* lock for reading
	62	*/
	63	static inline void __down_read(struct rw_semaphore *sem)
	64	{
6e5609a9	65	asm volatile("# beginning down_read\n\t"
1838ef1d	66	LOCK_PREFIX _ASM_INC "(%1)\n\t"
b4bcb4c2	67	/* adds 0x00000001 */
6e5609a9 JP	68	" jns 1f\n"
	69	" call call_rwsem_down_read_failed\n"
	70	"1:\n\t"
	71	"# ending down_read\n\t"
	72	: "+m" (sem->count)
	73	: "a" (sem)
	74	: "memory", "cc");
1da177e4 LT	75	}
	76
	77	/*
	78	* trylock for reading -- returns 1 if successful, 0 if contention
	79	*/
117780ee	80	static inline bool __down_read_trylock(struct rw_semaphore *sem)
1da177e4	81	{
bde11efb	82	long result, tmp;
6e5609a9	83	asm volatile("# beginning __down_read_trylock\n\t"
59c33fa7	84	" mov %0,%1\n\t"
6e5609a9	85	"1:\n\t"
59c33fa7 LT	86	" mov %1,%2\n\t"
59c33fa7 LT	87	" add %3,%2\n\t"
6e5609a9	88	" jle 2f\n\t"
59c33fa7	89	LOCK_PREFIX " cmpxchg %2,%0\n\t"
6e5609a9 JP	90	" jnz 1b\n\t"
	91	"2:\n\t"
	92	"# ending __down_read_trylock\n\t"
	93	: "+m" (sem->count), "=&a" (result), "=&r" (tmp)
	94	: "i" (RWSEM_ACTIVE_READ_BIAS)
	95	: "memory", "cc");
117780ee	96	return result >= 0;
1da177e4 LT	97	}
	98
	99	/*
	100	* lock for writing
	101	*/
664b4e24 MH	102	#define ____down_write(sem, slow_path) \
	103	({ \
	104	long tmp; \
916633a4	105	struct rw_semaphore* ret; \
55a76b59 JP	106	register void *__sp asm(_ASM_SP); \
55a76b59 JP	107	\
664b4e24	108	asm volatile("# beginning down_write\n\t" \
55a76b59	109	LOCK_PREFIX " xadd %1,(%4)\n\t" \
664b4e24 MH	110	/* adds 0xffff0001, returns the old value */ \
	111	" test " __ASM_SEL(%w1,%k1) "," __ASM_SEL(%w1,%k1) "\n\t" \
	112	/* was the active mask 0 before? */\
	113	" jz 1f\n" \
	114	" call " slow_path "\n" \
	115	"1:\n" \
	116	"# ending down_write" \
55a76b59	117	: "+m" (sem->count), "=d" (tmp), "=a" (ret), "+r" (__sp) \
664b4e24 MH	118	: "a" (sem), "1" (RWSEM_ACTIVE_WRITE_BIAS) \
	119	: "memory", "cc"); \
	120	ret; \
	121	})
	122
f8e04d85	123	static inline void __down_write(struct rw_semaphore *sem)
1da177e4	124	{
664b4e24 MH	125	____down_write(sem, "call_rwsem_down_write_failed");
	126	}
	127
	128	static inline int __down_write_killable(struct rw_semaphore *sem)
	129	{
	130	if (IS_ERR(____down_write(sem, "call_rwsem_down_write_failed_killable")))
	131	return -EINTR;
	132
	133	return 0;
1da177e4 LT	134	}
	135
	136	/*
	137	* trylock for writing -- returns 1 if successful, 0 if contention
	138	*/
117780ee	139	static inline bool __down_write_trylock(struct rw_semaphore *sem)
1da177e4	140	{
117780ee PA	141	bool result;
117780ee PA	142	long tmp0, tmp1;
a31a369b ML	143	asm volatile("# beginning __down_write_trylock\n\t"
	144	" mov %0,%1\n\t"
	145	"1:\n\t"
	146	" test " __ASM_SEL(%w1,%k1) "," __ASM_SEL(%w1,%k1) "\n\t"
	147	/* was the active mask 0 before? */
	148	" jnz 2f\n\t"
	149	" mov %1,%2\n\t"
117780ee	150	" add %4,%2\n\t"
a31a369b ML	151	LOCK_PREFIX " cmpxchg %2,%0\n\t"
	152	" jnz 1b\n\t"
	153	"2:\n\t"
35ccfb71	154	CC_SET(e)
a31a369b	155	"# ending __down_write_trylock\n\t"
117780ee	156	: "+m" (sem->count), "=&a" (tmp0), "=&r" (tmp1),
35ccfb71	157	CC_OUT(e) (result)
a31a369b	158	: "er" (RWSEM_ACTIVE_WRITE_BIAS)
c907420f	159	: "memory");
a31a369b	160	return result;
1da177e4 LT	161	}
	162
	163	/*
	164	* unlock after reading
	165	*/
	166	static inline void __up_read(struct rw_semaphore *sem)
	167	{
bde11efb	168	long tmp;
6e5609a9	169	asm volatile("# beginning __up_read\n\t"
59c33fa7	170	LOCK_PREFIX " xadd %1,(%2)\n\t"
6e5609a9 JP	171	/* subtracts 1, returns the old value */
6e5609a9 JP	172	" jns 1f\n\t"
b4bcb4c2	173	" call call_rwsem_wake\n" /* expects old value in %edx */
6e5609a9 JP	174	"1:\n"
	175	"# ending __up_read\n"
	176	: "+m" (sem->count), "=d" (tmp)
b4bcb4c2	177	: "a" (sem), "1" (-RWSEM_ACTIVE_READ_BIAS)
6e5609a9	178	: "memory", "cc");
1da177e4 LT	179	}
	180
	181	/*
	182	* unlock after writing
	183	*/
	184	static inline void __up_write(struct rw_semaphore *sem)
	185	{
bde11efb	186	long tmp;
6e5609a9	187	asm volatile("# beginning __up_write\n\t"
59c33fa7	188	LOCK_PREFIX " xadd %1,(%2)\n\t"
a751bd85 ML	189	/* subtracts 0xffff0001, returns the old value */
a751bd85 ML	190	" jns 1f\n\t"
b4bcb4c2	191	" call call_rwsem_wake\n" /* expects old value in %edx */
6e5609a9 JP	192	"1:\n\t"
6e5609a9 JP	193	"# ending __up_write\n"
59c33fa7 LT	194	: "+m" (sem->count), "=d" (tmp)
	195	: "a" (sem), "1" (-RWSEM_ACTIVE_WRITE_BIAS)
	196	: "memory", "cc");
1da177e4 LT	197	}
	198
	199	/*
	200	* downgrade write lock to read lock
	201	*/
	202	static inline void __downgrade_write(struct rw_semaphore *sem)
	203	{
6e5609a9	204	asm volatile("# beginning __downgrade_write\n\t"
1838ef1d	205	LOCK_PREFIX _ASM_ADD "%2,(%1)\n\t"
0d1622d7 AK	206	/*
	207	* transitions 0xZZZZ0001 -> 0xYYYY0001 (i386)
	208	* 0xZZZZZZZZ00000001 -> 0xYYYYYYYY00000001 (x86_64)
	209	*/
6e5609a9 JP	210	" jns 1f\n\t"
	211	" call call_rwsem_downgrade_wake\n"
	212	"1:\n\t"
	213	"# ending __downgrade_write\n"
	214	: "+m" (sem->count)
0d1622d7	215	: "a" (sem), "er" (-RWSEM_WAITING_BIAS)
6e5609a9	216	: "memory", "cc");
1da177e4 LT	217	}
1da177e4 LT	218
1da177e4	219	#endif /* __KERNEL__ */
1965aae3	220	#endif /* _ASM_X86_RWSEM_H */