On Thu, Dec 4, 2014 at 9:38 AM, Ola Liljedahl <[email protected]> wrote:
> Signed-off-by: Ola Liljedahl <[email protected]> > Reviewed-by: Bill Fischofer <[email protected]> > --- > (This code contribution is provided under the terms of agreement > LES-LTM-21309) > Update and unify doxygen comments and function parameter names. > > platform/linux-generic/include/api/odp_atomic.h | 283 > ++++++++++++------------ > 1 file changed, 138 insertions(+), 145 deletions(-) > > diff --git a/platform/linux-generic/include/api/odp_atomic.h > b/platform/linux-generic/include/api/odp_atomic.h > index 9eebb86..4a5b0b2 100644 > --- a/platform/linux-generic/include/api/odp_atomic.h > +++ b/platform/linux-generic/include/api/odp_atomic.h > @@ -29,21 +29,21 @@ extern "C" { > > > /** > - * Atomic unsigned integer 64 bits > + * Atomic 64-bit unsigned integer > */ > typedef struct { > uint64_t v; /**< Actual storage for the atomic variable */ > #if __GCC_ATOMIC_LLONG_LOCK_FREE < 2 > /* Some architectures do not support lock-free operations on 64-bit > * data types. We use a spin lock to ensure atomicity. */ > - char lock; /**< Spin lock used to ensure atomic access */ > + char lock; /**< Spin lock (if needed) used to ensure atomic access > */ > #endif > } odp_atomic_u64_t > ODP_ALIGNED(sizeof(uint64_t)); /* Enforce alignement! */ > > > /** > - * Atomic unsigned integer 32 bits > + * Atomic 32-bit unsigned integer > */ > typedef struct { > uint32_t v; /**< Actual storage for the atomic variable */ > @@ -52,170 +52,168 @@ ODP_ALIGNED(sizeof(uint32_t)); /* Enforce > alignement! */ > > > /** > - * Initialize atomic uint32 > + * Initialize atomic uint32 variable > * @note Relaxed memory order, cannot be used for synchronization > * > - * @param ptr An atomic variable > - * @param val Value to initialize the variable with > + * @param[out] atom Pointer to an atomic uint32 variable > + * @param val Value to initialize the variable with > */ > -static inline void odp_atomic_init_u32(odp_atomic_u32_t *ptr, uint32_t > val) > +static inline void odp_atomic_init_u32(odp_atomic_u32_t *atom, uint32_t > val) > { > - __atomic_store_n(&ptr->v, val, __ATOMIC_RELAXED); > + __atomic_store_n(&atom->v, val, __ATOMIC_RELAXED); > } > > /** > - * Load value of atomic uint32 > + * Load value of atomic uint32 variable > * @note Relaxed memory order, cannot be used for synchronization > * > - * @param ptr An atomic variable > + * @param atom Pointer to an atomic uint32 variable > * > * @return Value of the variable > */ > -static inline uint32_t odp_atomic_load_u32(odp_atomic_u32_t *ptr) > +static inline uint32_t odp_atomic_load_u32(odp_atomic_u32_t *atom) > { > - return __atomic_load_n(&ptr->v, __ATOMIC_RELAXED); > + return __atomic_load_n(&atom->v, __ATOMIC_RELAXED); > } > > /** > - * Store value to atomic uint32 > + * Store value to atomic uint32 variable > * @note Relaxed memory order, cannot be used for synchronization > * > - * @param ptr An atomic variable > - * @param new_value Store new_value to a variable > + * @param[out] atom Pointer to an atomic uint32 variable > + * @param val Value to store in the variable > */ > -static inline void odp_atomic_store_u32(odp_atomic_u32_t *ptr, > - uint32_t new_value) > +static inline void odp_atomic_store_u32(odp_atomic_u32_t *atom, > + uint32_t val) > { > - __atomic_store_n(&ptr->v, new_value, __ATOMIC_RELAXED); > + __atomic_store_n(&atom->v, val, __ATOMIC_RELAXED); > } > > /** > - * Fetch and add atomic uint32 > + * Fetch and add to atomic uint32 variable > * @note Relaxed memory order, cannot be used for synchronization > * > - * @param ptr An atomic variable > - * @param value A value to be added to the variable > + * @param[in,out] atom Pointer to an atomic uint32 variable > + * @param val Value to be added to the variable > * > - * @return Value of the variable before the operation > + * @return Value of the variable before the addition > */ > -static inline uint32_t odp_atomic_fetch_add_u32(odp_atomic_u32_t *ptr, > - uint32_t value) > +static inline uint32_t odp_atomic_fetch_add_u32(odp_atomic_u32_t *atom, > + uint32_t val) > { > - return __atomic_fetch_add(&ptr->v, value, __ATOMIC_RELAXED); > + return __atomic_fetch_add(&atom->v, val, __ATOMIC_RELAXED); > } > > /** > - * Add atomic uint32 > + * Add to atomic uint32 variable > * @note Relaxed memory order, cannot be used for synchronization > * > - * @param ptr An atomic variable > - * @param value A value to be added to the variable > + * @param[in,out] atom Pointer to an atomic uint32 variable > + * @param val A value to be added to the variable > */ > -static inline void odp_atomic_add_u32(odp_atomic_u32_t *ptr, > - uint32_t value) > +static inline void odp_atomic_add_u32(odp_atomic_u32_t *atom, > + uint32_t val) > { > - (void)__atomic_fetch_add(&ptr->v, value, __ATOMIC_RELAXED); > + (void)__atomic_fetch_add(&atom->v, val, __ATOMIC_RELAXED); > } > > /** > - * Fetch and subtract uint32 > + * Fetch and subtract from atomic uint32 variable > * @note Relaxed memory order, cannot be used for synchronization > * > - * @param ptr An atomic variable > - * @param value A value to be sub to the variable > + * @param[in,out] atom Pointer to an atomic uint32 variable > + * @param val A value to be subracted from the variable > * > - * @return Value of the variable before the operation > + * @return Value of the variable before the subtraction > */ > -static inline uint32_t odp_atomic_fetch_sub_u32(odp_atomic_u32_t *ptr, > - uint32_t value) > +static inline uint32_t odp_atomic_fetch_sub_u32(odp_atomic_u32_t *atom, > + uint32_t val) > { > - return __atomic_fetch_sub(&ptr->v, value, __ATOMIC_RELAXED); > + return __atomic_fetch_sub(&atom->v, val, __ATOMIC_RELAXED); > } > > /** > - * Subtract uint32 > + * Subtract from atomic uint32 variable > * @note Relaxed memory order, cannot be used for synchronization > * > - * @param ptr An atomic variable > - * @param value A value to be subtract from the variable > + * @param[in,out] atom Pointer to an atomic uint32 variable > + * @param val Value to be subtracted from the variable > */ > -static inline void odp_atomic_sub_u32(odp_atomic_u32_t *ptr, > - uint32_t value) > +static inline void odp_atomic_sub_u32(odp_atomic_u32_t *atom, > + uint32_t val) > { > - (void)__atomic_fetch_sub(&ptr->v, value, __ATOMIC_RELAXED); > + (void)__atomic_fetch_sub(&atom->v, val, __ATOMIC_RELAXED); > } > > /** > - * Fetch and increment atomic uint32 by 1 > + * Fetch and increment atomic uint32 variable > * @note Relaxed memory order, cannot be used for synchronization > * > - * @param ptr An atomic variable > + * @param[in,out] atom Pointer to an atomic uint32 variable > * > - * @return Value of the variable before the operation > + * @return Value of the variable before the increment > */ > > -static inline uint32_t odp_atomic_fetch_inc_u32(odp_atomic_u32_t *ptr) > +static inline uint32_t odp_atomic_fetch_inc_u32(odp_atomic_u32_t *atom) > { > #if defined __OCTEON__ > uint32_t ret; > __asm__ __volatile__ ("syncws"); > - __asm__ __volatile__ ("lai %0,(%2)" : "=r" (ret), "+m" (ptr) : > - "r" (ptr)); > + __asm__ __volatile__ ("lai %0,(%2)" : "=r" (ret), "+m" (atom) : > + "r" (atom)); > return ret; > #else > - return __atomic_fetch_add(&ptr->v, 1, __ATOMIC_RELAXED); > + return __atomic_fetch_add(&atom->v, 1, __ATOMIC_RELAXED); > #endif > } > > /** > - * Increment atomic uint32 by 1 > + * Increment atomic uint32 variable > * @note Relaxed memory order, cannot be used for synchronization > * > - * @param ptr An atomic variable > - * > + * @param[in,out] atom Pointer to an atomic uint32 variable > */ > -static inline void odp_atomic_inc_u32(odp_atomic_u32_t *ptr) > +static inline void odp_atomic_inc_u32(odp_atomic_u32_t *atom) > { > - (void)__atomic_fetch_add(&ptr->v, 1, __ATOMIC_RELAXED); > + (void)__atomic_fetch_add(&atom->v, 1, __ATOMIC_RELAXED); > } > > /** > - * Fetch and decrement uint32 by 1 > + * Fetch and decrement atomic uint32 variable > * @note Relaxed memory order, cannot be used for synchronization > * > - * @param ptr An atomic variable > + * @param[in,out] atom Pointer to an atomic uint32 variable > * > - * @return Value of the variable before the operation > + * @return Value of the variable before the subtraction > */ > -static inline uint32_t odp_atomic_fetch_dec_u32(odp_atomic_u32_t *ptr) > +static inline uint32_t odp_atomic_fetch_dec_u32(odp_atomic_u32_t *atom) > { > - return __atomic_fetch_sub(&ptr->v, 1, __ATOMIC_RELAXED); > + return __atomic_fetch_sub(&atom->v, 1, __ATOMIC_RELAXED); > } > > /** > - * Decrement atomic uint32 by 1 > + * Decrement atomic uint32 variable > * @note Relaxed memory order, cannot be used for synchronization > * > - * @param ptr An atomic variable > - * > + * @param[in,out] atom Pointer to an atomic uint32 variable > */ > -static inline void odp_atomic_dec_u32(odp_atomic_u32_t *ptr) > +static inline void odp_atomic_dec_u32(odp_atomic_u32_t *atom) > { > - (void)__atomic_fetch_sub(&ptr->v, 1, __ATOMIC_RELAXED); > + (void)__atomic_fetch_sub(&atom->v, 1, __ATOMIC_RELAXED); > } > > /** > - * Initialize atomic uint64 > + * Initialize atomic uint64 variable > * @note Relaxed memory order, cannot be used for synchronization > * > - * @param ptr An atomic variable > - * @param val Value to initialize the variable with > + * @param[out] atom Pointer to an atomic uint64 variable > + * @param val Value to initialize the variable with > */ > -static inline void odp_atomic_init_u64(odp_atomic_u64_t *ptr, uint64_t > val) > +static inline void odp_atomic_init_u64(odp_atomic_u64_t *atom, uint64_t > val) > { > - ptr->v = val; > + atom->v = val; > #if __GCC_ATOMIC_LLONG_LOCK_FREE < 2 > - __atomic_clear(&ptr->lock, __ATOMIC_RELAXED); > + __atomic_clear(&atom->lock, __ATOMIC_RELAXED); > #endif > } > > @@ -223,195 +221,190 @@ static inline void > odp_atomic_init_u64(odp_atomic_u64_t *ptr, uint64_t val) > /** > * @internal > * Helper macro for lock-based atomic operations on 64-bit integers > - * @param ptr Pointer to the 64-bit atomic variable > + * @param[in,out] atom Pointer to the 64-bit atomic variable > * @param expr Expression used update the variable. > * @return The old value of the variable. > */ > -#define ATOMIC_OP(ptr, expr) \ > +#define ATOMIC_OP(atom, expr) \ > ({ \ > uint64_t old_val; \ > /* Loop while lock is already taken, stop when lock becomes clear > */ \ > - while (__atomic_test_and_set(&(ptr)->lock, __ATOMIC_ACQUIRE)) \ > + while (__atomic_test_and_set(&(atom)->lock, __ATOMIC_ACQUIRE)) \ > (void)0; \ > - old_val = (ptr)->v; \ > + old_val = (atom)->v; \ > (expr); /* Perform whatever update is desired */ \ > - __atomic_clear(&(ptr)->lock, __ATOMIC_RELEASE); \ > + __atomic_clear(&(atom)->lock, __ATOMIC_RELEASE); \ > old_val; /* Return old value */ \ > }) > #endif > > /** > - * Load value of atomic uint64 > + * Load value of atomic uint64 variable > * @note Relaxed memory order, cannot be used for synchronization > * > - * @param ptr An atomic variable > + * @param atom Pointer to an atomic uint64 variable > * > - * @return atomic uint64 value > + * @return Value of the variable > */ > -static inline uint64_t odp_atomic_load_u64(odp_atomic_u64_t *ptr) > +static inline uint64_t odp_atomic_load_u64(odp_atomic_u64_t *atom) > { > #if __GCC_ATOMIC_LLONG_LOCK_FREE < 2 > - return ATOMIC_OP(ptr, (void)0); > + return ATOMIC_OP(atom, (void)0); > #else > - return __atomic_load_n(&ptr->v, __ATOMIC_RELAXED); > + return __atomic_load_n(&atom->v, __ATOMIC_RELAXED); > #endif > } > > /** > - * Store value to atomic uint64 > + * Store value to atomic uint64 variable > * @note Relaxed memory order, cannot be used for synchronization > * > - * @param ptr An atomic variable > - * @param new_value Store new_value to a variable > - * > - * @note The operation is not synchronized with other threads > + * @param[out] atom Pointer to an atomic uint64 variable > + * @param val Value to store in the variable > */ > -static inline void odp_atomic_store_u64(odp_atomic_u64_t *ptr, > - uint64_t new_value) > +static inline void odp_atomic_store_u64(odp_atomic_u64_t *atom, > + uint64_t val) > { > #if __GCC_ATOMIC_LLONG_LOCK_FREE < 2 > - (void)ATOMIC_OP(ptr, ptr->v = new_value); > + (void)ATOMIC_OP(atom, atom->v = val); > #else > - __atomic_store_n(&ptr->v, new_value, __ATOMIC_RELAXED); > + __atomic_store_n(&atom->v, val, __ATOMIC_RELAXED); > #endif > } > > /** > - * Fetch and add atomic uint64 > + * Fetch and add to atomic uint64 variable > * @note Relaxed memory order, cannot be used for synchronization > * > - * @param ptr An atomic variable > - * @param value A value to be added to the variable > + * @param[in,out] atom Pointer to an atomic uint64 variable > + * @param val Value to be added to the variable > * > - * @return Value of the variable before the operation > + * @return Value of the variable before the addition > */ > > -static inline uint64_t odp_atomic_fetch_add_u64(odp_atomic_u64_t *ptr, > - uint64_t value) > +static inline uint64_t odp_atomic_fetch_add_u64(odp_atomic_u64_t *atom, > + uint64_t val) > { > #if __GCC_ATOMIC_LLONG_LOCK_FREE < 2 > - return ATOMIC_OP(ptr, ptr->v += value); > + return ATOMIC_OP(atom, atom->v += val); > #else > - return __atomic_fetch_add(&ptr->v, value, __ATOMIC_RELAXED); > + return __atomic_fetch_add(&atom->v, val, __ATOMIC_RELAXED); > #endif > } > > /** > - * Add atomic uint64 > + * Add to atomic uint64 variable > * @note Relaxed memory order, cannot be used for synchronization > * > - * @param ptr An atomic variable > - * @param value A value to be added to the variable > + * @param[in,out] atom Pointer to an atomic uint64 variable > + * @param val Value to be added to the variable > * > */ > -static inline void odp_atomic_add_u64(odp_atomic_u64_t *ptr, uint64_t > value) > +static inline void odp_atomic_add_u64(odp_atomic_u64_t *atom, uint64_t > val) > { > #if __GCC_ATOMIC_LLONG_LOCK_FREE < 2 > - (void)ATOMIC_OP(ptr, ptr->v += value); > + (void)ATOMIC_OP(atom, atom->v += val); > #else > - (void)__atomic_fetch_add(&ptr->v, value, __ATOMIC_RELAXED); > + (void)__atomic_fetch_add(&atom->v, val, __ATOMIC_RELAXED); > #endif > } > > /** > - * Fetch and subtract atomic uint64 > + * Fetch and subtract from atomic uint64 variable > * @note Relaxed memory order, cannot be used for synchronization > * > - * @param ptr An atomic variable > - * @param value A value to be subtracted from the variable > + * @param[in,out] atom Pointer to an atomic uint64 variable > + * @param val Value to be subtracted from the variable > * > - * @return Value of the variable before the operation > + * @return Value of the variable before the subtraction > */ > -static inline uint64_t odp_atomic_fetch_sub_u64(odp_atomic_u64_t *ptr, > - uint64_t value) > +static inline uint64_t odp_atomic_fetch_sub_u64(odp_atomic_u64_t *atom, > + uint64_t val) > { > #if __GCC_ATOMIC_LLONG_LOCK_FREE < 2 > - return ATOMIC_OP(ptr, ptr->v -= value); > + return ATOMIC_OP(atom, atom->v -= val); > #else > - return __atomic_fetch_sub(&ptr->v, value, __ATOMIC_RELAXED); > + return __atomic_fetch_sub(&atom->v, val, __ATOMIC_RELAXED); > #endif > } > > /** > - * Subtract atomic uint64 > + * Subtract from atomic uint64 variable > * @note Relaxed memory order, cannot be used for synchronization > * > - * @param ptr An atomic variable > - * @param value A value to be subtracted from the variable > - * > + * @param[in,out] atom Pointer to an atomic uint64 variable > + * @param val Value to be subtracted from the variable > */ > -static inline void odp_atomic_sub_u64(odp_atomic_u64_t *ptr, uint64_t > value) > +static inline void odp_atomic_sub_u64(odp_atomic_u64_t *atom, uint64_t > val) > { > #if __GCC_ATOMIC_LLONG_LOCK_FREE < 2 > - (void)ATOMIC_OP(ptr, ptr->v -= value); > + (void)ATOMIC_OP(atom, atom->v -= val); > #else > - (void)__atomic_fetch_sub(&ptr->v, value, __ATOMIC_RELAXED); > + (void)__atomic_fetch_sub(&atom->v, val, __ATOMIC_RELAXED); > #endif > } > > /** > - * Fetch and increment atomic uint64 by 1 > + * Fetch and increment atomic uint64 variable > * @note Relaxed memory order, cannot be used for synchronization > * > - * @param ptr An atomic variable > + * @param[in,out] atom Pointer to an atomic uint64 variable > * > - * @return Value of the variable before the operation > + * @return Value of the variable before the increment > */ > -static inline uint64_t odp_atomic_fetch_inc_u64(odp_atomic_u64_t *ptr) > +static inline uint64_t odp_atomic_fetch_inc_u64(odp_atomic_u64_t *atom) > { > #if __GCC_ATOMIC_LLONG_LOCK_FREE < 2 > - return ATOMIC_OP(ptr, ptr->v++); > + return ATOMIC_OP(atom, atom->v++); > #else > - return __atomic_fetch_add(&ptr->v, 1, __ATOMIC_RELAXED); > + return __atomic_fetch_add(&atom->v, 1, __ATOMIC_RELAXED); > #endif > } > > /** > - * Increment atomic uint64 by 1 > + * Increment atomic uint64 variable > * @note Relaxed memory order, cannot be used for synchronization > * > - * @param ptr An atomic variable > - * > + * @param[in,out] atom Pointer to an atomic uint64 variable > */ > -static inline void odp_atomic_inc_u64(odp_atomic_u64_t *ptr) > +static inline void odp_atomic_inc_u64(odp_atomic_u64_t *atom) > { > #if __GCC_ATOMIC_LLONG_LOCK_FREE < 2 > - (void)ATOMIC_OP(ptr, ptr->v++); > + (void)ATOMIC_OP(atom, atom->v++); > #else > - (void)__atomic_fetch_add(&ptr->v, 1, __ATOMIC_RELAXED); > + (void)__atomic_fetch_add(&atom->v, 1, __ATOMIC_RELAXED); > #endif > } > > /** > - * Fetch and decrement atomic uint64 by 1 > + * Fetch and decrement atomic uint64 variable > * @note Relaxed memory order, cannot be used for synchronization > * > - * @param ptr An atomic variable > + * @param[in,out] atom Pointer to an atomic uint64 variable > * > - * @return Value of the variable before the operation > + * @return Value of the variable before the decrement > */ > -static inline uint64_t odp_atomic_fetch_dec_u64(odp_atomic_u64_t *ptr) > +static inline uint64_t odp_atomic_fetch_dec_u64(odp_atomic_u64_t *atom) > { > #if __GCC_ATOMIC_LLONG_LOCK_FREE < 2 > - return ATOMIC_OP(ptr, ptr->v--); > + return ATOMIC_OP(atom, atom->v--); > #else > - return __atomic_fetch_sub(&ptr->v, 1, __ATOMIC_RELAXED); > + return __atomic_fetch_sub(&atom->v, 1, __ATOMIC_RELAXED); > #endif > } > > /** > - * Decrement atomic uint64 by 1 > + * Decrement atomic uint64 variable > * @note Relaxed memory order, cannot be used for synchronization > * > - * @param ptr An atomic variable > - * > + * @param[in,out] atom Pointer to an atomic uint64 variable > */ > -static inline void odp_atomic_dec_u64(odp_atomic_u64_t *ptr) > +static inline void odp_atomic_dec_u64(odp_atomic_u64_t *atom) > { > #if __GCC_ATOMIC_LLONG_LOCK_FREE < 2 > - (void)ATOMIC_OP(ptr, ptr->v--); > + (void)ATOMIC_OP(atom, atom->v--); > #else > - (void)__atomic_fetch_sub(&ptr->v, 1, __ATOMIC_RELAXED); > + (void)__atomic_fetch_sub(&atom->v, 1, __ATOMIC_RELAXED); > #endif > } > > -- > 1.9.1 > > > _______________________________________________ > lng-odp mailing list > [email protected] > http://lists.linaro.org/mailman/listinfo/lng-odp >
_______________________________________________ lng-odp mailing list [email protected] http://lists.linaro.org/mailman/listinfo/lng-odp
