freebsd/sys/arm64/include/atomic.h

/*-
 * Copyright (c) 2013 Andrew Turner <andrew@freebsd.org>
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 * $FreeBSD$
 */

#ifndef	_MACHINE_ATOMIC_H_
#define	_MACHINE_ATOMIC_H_

#define	isb()  __asm __volatile("isb" : : : "memory")
#define	dsb()  __asm __volatile("dsb sy" : : : "memory")
#define	dmb()  __asm __volatile("dmb sy" : : : "memory")

#define	mb()   dmb()
#define	wmb()  dmb()
#define	rmb()  dmb()

static __inline void
atomic_add_32(volatile uint32_t *p, uint32_t val)
{
	uint32_t tmp;
	int res;

	__asm __volatile(
	    "1: ldxr	%w0, [%2]      \n"
	    "   add	%w0, %w0, %w3  \n"
	    "   stxr	%w1, %w0, [%2] \n"
            "   cbnz	%w1, 1b        \n"
	    : "=&r"(tmp), "=&r"(res), "+r" (p), "+r" (val) : : "cc"
	);
}

static __inline void
atomic_clear_32(volatile uint32_t *p, uint32_t val)
{
	uint32_t tmp;
	int res;

	__asm __volatile(
	    "1: ldxr	%w0, [%2]      \n"
	    "   bic	%w0, %w0, %w3  \n"
	    "   stxr	%w1, %w0, [%2] \n"
            "   cbnz	%w1, 1b        \n"
	    : "=&r"(tmp), "=&r"(res), "+r" (p), "+r" (val) : : "cc"
	);
}

static __inline int
atomic_cmpset_32(volatile uint32_t *p, uint32_t cmpval, uint32_t newval)
{
	uint32_t tmp;
	int res;

	__asm __volatile(
	    "1: mov	%w1, #1        \n"
	    "   ldxr	%w0, [%2]      \n"
	    "   cmp	%w0, %w3       \n"
	    "   b.ne	2f             \n"
	    "   stxr	%w1, %w4, [%2] \n"
            "   cbnz	%w1, 1b        \n"
	    "2:"
	    : "=&r"(tmp), "=&r"(res), "+r" (p), "+r" (cmpval), "+r" (newval)
	    : : "cc"
	);

	return (!res);
}

static __inline uint32_t
atomic_fetchadd_32(volatile uint32_t *p, uint32_t val)
{
	uint32_t tmp, ret;
	int res;

	__asm __volatile(
	    "1: ldxr	%w4, [%2]      \n"
	    "   add	%w0, %w4, %w3  \n"
	    "   stxr	%w1, %w0, [%2] \n"
            "   cbnz	%w1, 1b        \n"
	    : "=&r"(tmp), "=&r"(res), "+r" (p), "+r" (val), "=&r"(ret) : : "cc"
	);

	return (ret);
}

static __inline uint32_t
atomic_readandclear_32(volatile uint32_t *p)
{
	uint32_t tmp, ret;
	int res;

	__asm __volatile(
	    "   mov	%w0, #0        \n"
	    "1: ldxr	%w3, [%2]      \n"
	    "   stxr	%w1, %w0, [%2] \n"
            "   cbnz	%w1, 1b        \n"
	    : "=&r"(tmp), "=&r"(res), "+r" (p), "=&r"(ret) : : "cc"
	);

	return (ret);
}

static __inline void
atomic_set_32(volatile uint32_t *p, uint32_t val)
{
	uint32_t tmp;
	int res;

	__asm __volatile(
	    "1: ldxr	%w0, [%2]      \n"
	    "   orr	%w0, %w0, %w3  \n"
	    "   stxr	%w1, %w0, [%2] \n"
            "   cbnz	%w1, 1b        \n"
	    : "=&r"(tmp), "=&r"(res), "+r" (p), "+r" (val) : : "cc"
	);
}

static __inline void
atomic_subtract_32(volatile uint32_t *p, uint32_t val)
{
	uint32_t tmp;
	int res;

	__asm __volatile(
	    "1: ldxr	%w0, [%2]      \n"
	    "   sub	%w0, %w0, %w3  \n"
	    "   stxr	%w1, %w0, [%2] \n"
            "   cbnz	%w1, 1b        \n"
	    : "=&r"(tmp), "=&r"(res), "+r" (p), "+r" (val) : : "cc"
	);
}

#define	atomic_add_int		atomic_add_32
#define	atomic_clear_int	atomic_clear_32
#define	atomic_cmpset_int	atomic_cmpset_32
#define	atomic_fetchadd_int	atomic_fetchadd_32
#define	atomic_readandclear_int	atomic_readandclear_32
#define	atomic_set_int		atomic_set_32
#define	atomic_subtract_int	atomic_subtract_32


static __inline void
atomic_add_acq_32(volatile uint32_t *p, uint32_t val)
{
	uint32_t tmp;
	int res;

	__asm __volatile(
	    "1: ldaxr	%w0, [%2]      \n"
	    "   add	%w0, %w0, %w3  \n"
	    "   stlxr	%w1, %w0, [%2] \n"
            "   cbnz	%w1, 1b        \n"
	    "2:"
	    : "=&r"(tmp), "=&r"(res), "+r" (p), "+r" (val) : : "cc", "memory"
	);
}

static __inline void
atomic_clear_acq_32(volatile uint32_t *p, uint32_t val)
{
	uint32_t tmp;
	int res;

	__asm __volatile(
	    "1: ldaxr	%w0, [%2]      \n"
	    "   bic	%w0, %w0, %w3  \n"
	    "   stlxr	%w1, %w0, [%2] \n"
            "   cbnz	%w1, 1b        \n"
	    : "=&r"(tmp), "=&r"(res), "+r" (p), "+r" (val) : : "cc", "memory"
	);
}

static __inline int
atomic_cmpset_acq_32(volatile uint32_t *p, uint32_t cmpval, uint32_t newval)
{
	uint32_t tmp;
	int res;

	__asm __volatile(
	    "1: mov	%w1, #1        \n"
	    "   ldaxr	%w0, [%2]      \n"
	    "   cmp	%w0, %w3       \n"
	    "   b.ne	2f             \n"
	    "   stlxr	%w1, %w4, [%2] \n"
            "   cbnz	%w1, 1b        \n"
	    "2:"
	    : "=&r"(tmp), "=&r"(res), "+r" (p), "+r" (cmpval), "+r" (newval)
	    : : "cc", "memory"
	);

	return (!res);
}

static __inline uint32_t
atomic_load_acq_32(volatile uint32_t *p)
{
	uint32_t ret;

	ret = *p;
	dmb();

	return (ret);
}

static __inline void
atomic_set_acq_32(volatile uint32_t *p, uint32_t val)
{
	uint32_t tmp;
	int res;

	__asm __volatile(
	    "1: ldaxr	%w0, [%2]      \n"
	    "   orr	%w0, %w0, %w3  \n"
	    "   stlxr	%w1, %w0, [%2] \n"
            "   cbnz	%w1, 1b        \n"
	    : "=&r"(tmp), "=&r"(res), "+r" (p), "+r" (val) : : "cc", "memory"
	);
}

static __inline void
atomic_subtract_acq_32(volatile uint32_t *p, uint32_t val)
{
	uint32_t tmp;
	int res;

	__asm __volatile(
	    "1: ldaxr	%w0, [%2]      \n"
	    "   sub	%w0, %w0, %w3  \n"
	    "   stlxr	%w1, %w0, [%2] \n"
            "   cbnz	%w1, 1b        \n"
	    : "=&r"(tmp), "=&r"(res), "+r" (p), "+r" (val) : : "cc", "memory"
	);
}

static __inline void
atomic_store_rel_32(volatile uint32_t *p, uint32_t val)
{

	dmb();
	*p = val;
}

#define	atomic_add_acq_int	atomic_add_acq_32
#define	atomic_clear_acq_int	atomic_add_acq_32
#define	atomic_cmpset_acq_int	atomic_cmpset_acq_32
#define	atomic_load_acq_int	atomic_load_acq_32
#define	atomic_set_acq_int	atomic_set_acq_32
#define	atomic_subtract_acq_int	atomic_subtract_acq_32

/* The atomic functions currently are both acq and rel, we should fix this. */
#define	atomic_add_rel_32	atomic_add_acq_32
#define	atomic_clear_rel_32	atomic_add_acq_32
#define	atomic_cmpset_rel_32	atomic_cmpset_acq_32
#define	atomic_set_rel_32	atomic_set_acq_32
#define	atomic_subtract_rel_32	atomic_subtract_acq_32

#define	atomic_add_rel_int	atomic_add_rel_32
#define	atomic_clear_rel_int	atomic_add_rel_32
#define	atomic_cmpset_rel_int	atomic_cmpset_rel_32
#define	atomic_set_rel_int	atomic_set_rel_32
#define	atomic_subtract_rel_int	atomic_subtract_rel_32
#define	atomic_store_rel_int	atomic_store_rel_32


static __inline void
atomic_add_64(volatile uint64_t *p, uint64_t val)
{
	uint64_t tmp;
	int res;

	__asm __volatile(
	    "1: ldxr	%0, [%2]      \n"
	    "   add	%0, %0, %3    \n"
	    "   stxr	%w1, %0, [%2] \n"
            "   cbnz	%w1, 1b       \n"
	    : "=&r" (tmp), "=&r" (res), "+r" (p), "+r" (val) : : "cc"
	);
}

static __inline void
atomic_clear_64(volatile uint64_t *p, uint64_t val)
{
	uint64_t tmp;
	int res;

	__asm __volatile(
	    "1: ldxr	%0, [%2]      \n"
	    "   bic	%0, %0, %3    \n"
	    "   stxr	%w1, %0, [%2] \n"
            "   cbnz	%w1, 1b       \n"
	    : "=&r"(tmp), "=&r"(res), "+r" (p), "+r" (val) : : "cc"
	);
}

static __inline int
atomic_cmpset_64(volatile uint64_t *p, uint64_t cmpval, uint64_t newval)
{
	uint64_t tmp;
	int res;

	__asm __volatile(
	    "1: mov	%w1, #1       \n"
	    "   ldxr	%0, [%2]      \n"
	    "   cmp	%0, %3        \n"
	    "   b.ne	2f            \n"
	    "   stxr	%w1, %4, [%2] \n"
            "   cbnz	%w1, 1b       \n"
	    "2:"
	    : "=&r" (tmp), "=&r"(res), "+r" (p), "+r" (cmpval), "+r" (newval)
	    : : "cc", "memory"
	);

	return (!res);
}

static __inline uint64_t
atomic_fetchadd_64(volatile uint64_t *p, uint64_t val)
{
	uint64_t tmp, ret;
	int res;

	__asm __volatile(
	    "1: ldxr	%4, [%2]      \n"
	    "   add	%0, %4, %3    \n"
	    "   stxr	%w1, %0, [%2] \n"
            "   cbnz	%w1, 1b       \n"
	    : "=&r"(tmp), "=&r"(res), "+r" (p), "+r" (val), "=&r"(ret) : : "cc"
	);

	return (ret);
}

static __inline uint64_t
atomic_readandclear_64(volatile uint64_t *p)
{
	uint64_t tmp, ret;
	int res;

	__asm __volatile(
	    "   mov	%0, #0        \n"
	    "1: ldxr	%3, [%2]      \n"
	    "   stxr	%w1, %0, [%2] \n"
            "   cbnz	%w1, 1b       \n"
	    : "=&r"(tmp), "=&r"(res), "+r" (p), "=&r"(ret) : : "cc"
	);

	return (ret);
}

static __inline void
atomic_set_64(volatile uint64_t *p, uint64_t val)
{
	uint64_t tmp;
	int res;

	__asm __volatile(
	    "1: ldxr	%0, [%2]      \n"
	    "   orr	%0, %0, %3    \n"
	    "   stxr	%w1, %0, [%2] \n"
            "   cbnz	%w1, 1b       \n"
	    : "=&r"(tmp), "=&r"(res), "+r" (p), "+r" (val) : : "cc"
	);
}

static __inline void
atomic_subtract_64(volatile uint64_t *p, uint64_t val)
{
	uint64_t tmp;
	int res;

	__asm __volatile(
	    "1: ldxr	%0, [%2]      \n"
	    "   sub	%0, %0, %3    \n"
	    "   stxr	%w1, %0, [%2] \n"
            "   cbnz	%w1, 1b       \n"
	    : "=&r"(tmp), "=&r"(res), "+r" (p), "+r" (val) : : "cc"
	);
}

static __inline uint64_t
atomic_swap_64(volatile uint64_t *p, uint64_t val)
{
	uint64_t old;
	int res;

	__asm __volatile(
	    "1: ldxr	%0, [%2]      \n"
	    "   stxr	%w1, %3, [%2] \n"
            "   cbnz	%w1, 1b       \n"
	    : "=&r"(old), "=&r"(res), "+r" (p), "+r" (val) : : "cc", "memory"
	);

	return (old);
}

#define	atomic_add_long			atomic_add_64
#define	atomic_clear_long		atomic_clear_64
#define	atomic_cmpset_long		atomic_cmpset_64
#define	atomic_fetchadd_long		atomic_fetchadd_64
#define	atomic_readandclear_long	atomic_readandclear_64
#define	atomic_set_long			atomic_set_64
#define	atomic_subtract_long		atomic_subtract_64

#define	atomic_add_ptr			atomic_add_64
#define	atomic_clear_ptr		atomic_clear_64
#define	atomic_cmpset_ptr		atomic_cmpset_64
#define	atomic_fetchadd_ptr		atomic_fetchadd_64
#define	atomic_readandclear_ptr		atomic_readandclear_64
#define	atomic_set_ptr			atomic_set_64
#define	atomic_subtract_ptr		atomic_subtract_64

static __inline void
atomic_add_acq_64(volatile uint64_t *p, uint64_t val)
{
	uint64_t tmp;
	int res;

	__asm __volatile(
	    "1: ldaxr	%0, [%2]      \n"
	    "   add	%0, %0, %3    \n"
	    "   stlxr	%w1, %0, [%2] \n"
            "   cbnz	%w1, 1b       \n"
	    "2:"
	    : "=&r"(tmp), "=&r"(res), "+r" (p), "+r" (val) : : "cc", "memory"
	);
}

static __inline void
atomic_clear_acq_64(volatile uint64_t *p, uint64_t val)
{
	uint64_t tmp;
	int res;

	__asm __volatile(
	    "1: ldaxr	%0, [%2]      \n"
	    "   bic	%0, %0, %3    \n"
	    "   stlxr	%w1, %0, [%2] \n"
            "   cbnz	%w1, 1b       \n"
	    : "=&r"(tmp), "=&r"(res), "+r" (p), "+r" (val) : : "cc", "memory"
	);
}

static __inline int
atomic_cmpset_acq_64(volatile uint64_t *p, uint64_t cmpval, uint64_t newval)
{
	uint64_t tmp;
	int res;

	__asm __volatile(
	    "1: mov	%w1, #1       \n"
	    "   ldaxr	%0, [%2]      \n"
	    "   cmp	%0, %3        \n"
	    "   b.ne	2f            \n"
	    "   stlxr	%w1, %4, [%2] \n"
            "   cbnz	%w1, 1b       \n"
	    "2:"
	    : "=&r" (tmp), "=&r" (res), "+r" (p), "+r" (cmpval), "+r" (newval)
	    : : "cc", "memory"
	);

	return (!res);
}

static __inline uint64_t
atomic_load_acq_64(volatile uint64_t *p)
{
	uint64_t ret;

	ret = *p;
	dmb();

	return (ret);
}

static __inline void
atomic_set_acq_64(volatile uint64_t *p, uint64_t val)
{
	uint64_t tmp;
	int res;

	__asm __volatile(
	    "1: ldaxr	%0, [%2]      \n"
	    "   orr	%0, %0, %3    \n"
	    "   stlxr	%w1, %0, [%2] \n"
            "   cbnz	%w1, 1b       \n"
	    : "=&r"(tmp), "=&r"(res), "+r" (p), "+r" (val) : : "cc", "memory"
	);
}

static __inline void
atomic_subtract_acq_64(volatile uint64_t *p, uint64_t val)
{
	uint64_t tmp;
	int res;

	__asm __volatile(
	    "1: ldaxr	%0, [%2]      \n"
	    "   sub	%0, %0, %3    \n"
	    "   stlxr	%w1, %0, [%2] \n"
            "   cbnz	%w1, 1b       \n"
	    : "=&r"(tmp), "=&r"(res), "+r" (p), "+r" (val) : : "cc", "memory"
	);
}

static __inline void
atomic_store_rel_64(volatile uint64_t *p, uint64_t val)
{

	dmb();
	*p = val;
}

#define	atomic_add_acq_long		atomic_add_acq_64
#define	atomic_clear_acq_long		atomic_add_acq_64
#define	atomic_cmpset_acq_long		atomic_cmpset_acq_64
#define	atomic_load_acq_long		atomic_load_acq_64
#define	atomic_set_acq_long		atomic_set_acq_64
#define	atomic_subtract_acq_long	atomic_subtract_acq_64

#define	atomic_add_acq_ptr		atomic_add_acq_64
#define	atomic_clear_acq_ptr		atomic_add_acq_64
#define	atomic_cmpset_acq_ptr		atomic_cmpset_acq_64
#define	atomic_load_acq_ptr		atomic_load_acq_64
#define	atomic_set_acq_ptr		atomic_set_acq_64
#define	atomic_subtract_acq_ptr		atomic_subtract_acq_64

/*
 * TODO: The atomic functions currently are both acq and rel, we should fix
 * this.
 */
#define	atomic_add_rel_64		atomic_add_acq_64
#define	atomic_clear_rel_64		atomic_add_acq_64
#define	atomic_cmpset_rel_64		atomic_cmpset_acq_64
#define	atomic_set_rel_64		atomic_set_acq_64
#define	atomic_subtract_rel_64		atomic_subtract_acq_64

#define	atomic_add_rel_long		atomic_add_rel_64
#define	atomic_clear_rel_long		atomic_add_rel_64
#define	atomic_cmpset_rel_long		atomic_cmpset_rel_64
#define	atomic_set_rel_long		atomic_set_rel_64
#define	atomic_subtract_rel_long	atomic_subtract_rel_64
#define	atomic_store_rel_long		atomic_store_rel_64

#define	atomic_add_rel_ptr		atomic_add_rel_64
#define	atomic_clear_rel_ptr		atomic_add_rel_64
#define	atomic_cmpset_rel_ptr		atomic_cmpset_rel_64
#define	atomic_set_rel_ptr		atomic_set_rel_64
#define	atomic_subtract_rel_ptr		atomic_subtract_rel_64
#define	atomic_store_rel_ptr		atomic_store_rel_64

#endif /* _MACHINE_ATOMIC_H_ */