source: mainline/kernel/arch/amd64/include/atomic.h@ b17518e

/*
 * Copyright (c) 2001-2004 Jakub Jermar
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * - Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 * - 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.
 * - The name of the author may not be used to endorse or promote products
 *   derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``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 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.
 */

/** @addtogroup amd64
 * @{
 */
/** @file
 */

#ifndef KERN_amd64_ATOMIC_H_
#define KERN_amd64_ATOMIC_H_

#include <typedefs.h>
#include <arch/barrier.h>
#include <preemption.h>
#include <trace.h>

NO_TRACE static inline void atomic_inc(atomic_t *val)
{
#ifdef CONFIG_SMP
        asm volatile (
                "lock incq %[count]\n"
                : [count] "+m" (val->count)
        );
#else
        asm volatile (
                "incq %[count]\n"
                : [count] "+m" (val->count)
        );
#endif /* CONFIG_SMP */
}

NO_TRACE static inline void atomic_dec(atomic_t *val)
{
#ifdef CONFIG_SMP
        asm volatile (
                "lock decq %[count]\n"
                : [count] "+m" (val->count)
        );
#else
        asm volatile (
                "decq %[count]\n"
                : [count] "+m" (val->count)
        );
#endif /* CONFIG_SMP */
}

NO_TRACE static inline atomic_count_t atomic_postinc(atomic_t *val)
{
        atomic_count_t r = 1;
        
        asm volatile (
                "lock xaddq %[r], %[count]\n"
                : [count] "+m" (val->count),
                  [r] "+r" (r)
        );
        
        return r;
}

NO_TRACE static inline atomic_count_t atomic_postdec(atomic_t *val)
{
        atomic_count_t r = -1;
        
        asm volatile (
                "lock xaddq %[r], %[count]\n"
                : [count] "+m" (val->count),
                  [r] "+r" (r)
        );
        
        return r;
}

#define atomic_preinc(val)  (atomic_postinc(val) + 1)
#define atomic_predec(val)  (atomic_postdec(val) - 1)

NO_TRACE static inline atomic_count_t test_and_set(atomic_t *val)
{
        atomic_count_t v = 1;
        
        asm volatile (
                "xchgq %[v], %[count]\n"
                : [v] "+r" (v),
                  [count] "+m" (val->count)
        );
        
        return v;
}

/** amd64 specific fast spinlock */
NO_TRACE static inline void atomic_lock_arch(atomic_t *val)
{
        atomic_count_t tmp;
        
        preemption_disable();
        asm volatile (
                "0:\n"
                "       pause\n"
                "       mov %[count], %[tmp]\n"
                "       testq %[tmp], %[tmp]\n"
                "       jnz 0b\n"       /* lightweight looping on locked spinlock */
                
                "       incq %[tmp]\n"  /* now use the atomic operation */
                "       xchgq %[count], %[tmp]\n"
                "       testq %[tmp], %[tmp]\n"
                "       jnz 0b\n"
                : [count] "+m" (val->count),
                  [tmp] "=&r" (tmp)
        );
        
        /*
         * Prevent critical section code from bleeding out this way up.
         */
        CS_ENTER_BARRIER();
}


#define _atomic_cas_impl(pptr, exp_val, new_val, old_val, prefix) \
        asm volatile ( \
                prefix " cmpxchgq %[newval], %[ptr]\n" \
                : /* Output operands. */ \
                /* Old/current value is returned in eax. */ \
                [oldval] "=a" (old_val), \
                /* (*ptr) will be read and written to, hence "+" */ \
                [ptr] "+m" (*pptr) \
                : /* Input operands. */ \
                /* Expected value must be in eax. */ \
                [expval] "a" (exp_val), \
                /* The new value may be in any register. */ \
                [newval] "r" (new_val) \
                : "memory" \
        )
        
/** Atomically compares and swaps the pointer at pptr. */
NO_TRACE static inline void * atomic_cas_ptr(void **pptr, 
        void *exp_val, void *new_val)
{
        void *old_val;
        _atomic_cas_impl(pptr, exp_val, new_val, old_val, "lock\n");
        return old_val;
}

/** Compare-and-swap of a pointer that is atomic wrt to local cpu's interrupts.
 * 
 * This function is NOT smp safe and is not atomic with respect to other cpus.
 */
NO_TRACE static inline void * atomic_cas_ptr_local(void **pptr, 
        void *exp_val, void *new_val)
{
        void *old_val;
        _atomic_cas_impl(pptr, exp_val, new_val, old_val, "");
        return old_val;
}


#define _atomic_swap_impl(pptr, new_val) \
({ \
        typeof(*(pptr)) new_in_old_out = new_val; \
        asm volatile ( \
                "xchgq %[val], %[p_ptr]\n" \
                : [val] "+r" (new_in_old_out), \
                  [p_ptr] "+m" (*pptr) \
        ); \
        \
        new_in_old_out; \
})

/* 
 * Issuing a xchg instruction always implies lock prefix semantics.
 * Therefore, it is cheaper to use a cmpxchg without a lock prefix 
 * in a loop.
 */
#define _atomic_swap_local_impl(pptr, new_val) \
({ \
        typeof(*(pptr)) exp_val; \
        typeof(*(pptr)) old_val; \
        \
        do { \
                exp_val = *pptr; \
                _atomic_cas_impl(pptr, exp_val, new_val, old_val, ""); \
        } while (old_val != exp_val); \
        \
        old_val; \
})


/** Atomicaly sets *ptr to val and returns the previous value. */
NO_TRACE static inline void * atomic_set_return_ptr(void **pptr, void *val)
{
        return _atomic_swap_impl(pptr, val);
}

/** Sets *ptr to new_val and returns the previous value. NOT smp safe.
 * 
 * This function is only atomic wrt to local interrupts and it is
 * NOT atomic wrt to other cpus.
 */
NO_TRACE static inline void * atomic_set_return_ptr_local(
        void **pptr, void *new_val)
{
        return _atomic_swap_local_impl(pptr, new_val);
}

/** Atomicaly sets *ptr to val and returns the previous value. */
NO_TRACE static inline native_t atomic_set_return_native_t(
        native_t *p, native_t val)
{
        return _atomic_swap_impl(p, val);
}

/** Sets *ptr to new_val and returns the previous value. NOT smp safe.
 * 
 * This function is only atomic wrt to local interrupts and it is
 * NOT atomic wrt to other cpus.
 */
NO_TRACE static inline native_t atomic_set_return_native_t_local(
        native_t *p, native_t new_val)
{
        return _atomic_swap_local_impl(p, new_val);
}


#undef _atomic_cas_ptr_impl
#undef _atomic_swap_impl
#undef _atomic_swap_local_impl

#endif

/** @}
 */