From patchwork Wed Dec 3 14:17:29 2014 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Ola Liljedahl X-Patchwork-Id: 41843 Return-Path: X-Original-To: linaro@patches.linaro.org Delivered-To: linaro@patches.linaro.org Received: from mail-wg0-f72.google.com (mail-wg0-f72.google.com [74.125.82.72]) by ip-10-151-82-157.ec2.internal (Postfix) with ESMTPS id F040425E88 for ; Wed, 3 Dec 2014 14:18:03 +0000 (UTC) Received: by mail-wg0-f72.google.com with SMTP id y19sf9564990wgg.11 for ; Wed, 03 Dec 2014 06:18:03 -0800 (PST) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:delivered-to:from:to:date:message-id:in-reply-to :references:subject:precedence:list-id:list-unsubscribe:list-archive :list-post:list-help:list-subscribe:mime-version:content-type :content-transfer-encoding:errors-to:sender:x-original-sender :x-original-authentication-results:mailing-list; bh=1GJgsk7UCodQ0sZ/B9ywfzgmZbfEZV8hxmKosG5cHsw=; b=Xwq82+6Ro2T2qFpWJ2JNjGtfUZ46l9RRKIbvk07zQc6w3BfLSWQfKVjwx2u64H5Cu7 wDbmxnVE2+9rreee6pxEoHS6YymLg8yp5m+2+Ri6OLq36uX8g4t4J5HsOMzBFnoUJm1G N5G/vObouBiwqpIQmI7CKargXnVD+gWcrLDmo7oL+slj4lsI42a6Mmd5uStfgMqMTCNg NvzXKenGHwHwaa86zX2xLyg11ePIWJa7TjSo320gDf0lfque74m6KUMC8cRiF+fYyMQo /eXeneOgfjH143jxkoIN8IFbOWt03dJDVv0Hec3J335Cn5z2yAr7NMBajheVVuGeQmlc 2KDg== X-Gm-Message-State: ALoCoQnWtc0F1qL1gsPQvcpAyKJXWVHYj+4fENZZXQ1V5sqwVFU1N7TMWTfsXc6JTCNR4oruP7KX X-Received: by 10.152.42.196 with SMTP id q4mr580497lal.6.1417616283240; Wed, 03 Dec 2014 06:18:03 -0800 (PST) X-BeenThere: patchwork-forward@linaro.org Received: by 10.152.37.6 with SMTP id u6ls155180laj.26.gmail; Wed, 03 Dec 2014 06:18:03 -0800 (PST) X-Received: by 10.152.204.9 with SMTP id ku9mr4425323lac.55.1417616283034; Wed, 03 Dec 2014 06:18:03 -0800 (PST) Received: from mail-lb0-f176.google.com (mail-lb0-f176.google.com. [209.85.217.176]) by mx.google.com with ESMTPS id pn4si8510376lbc.33.2014.12.03.06.18.03 for (version=TLSv1 cipher=ECDHE-RSA-RC4-SHA bits=128/128); Wed, 03 Dec 2014 06:18:03 -0800 (PST) Received-SPF: pass (google.com: domain of patch+caf_=patchwork-forward=linaro.org@linaro.org designates 209.85.217.176 as permitted sender) client-ip=209.85.217.176; Received: by mail-lb0-f176.google.com with SMTP id p9so12048667lbv.7 for ; Wed, 03 Dec 2014 06:18:03 -0800 (PST) X-Received: by 10.112.38.4 with SMTP id c4mr4570611lbk.46.1417616282935; Wed, 03 Dec 2014 06:18:02 -0800 (PST) X-Forwarded-To: patchwork-forward@linaro.org X-Forwarded-For: patch@linaro.org patchwork-forward@linaro.org Delivered-To: patch@linaro.org Received: by 10.112.184.201 with SMTP id ew9csp671970lbc; Wed, 3 Dec 2014 06:18:01 -0800 (PST) X-Received: by 10.140.19.9 with SMTP id 9mr8212101qgg.98.1417616280909; Wed, 03 Dec 2014 06:18:00 -0800 (PST) Received: from ip-10-35-177-41.ec2.internal (lists.linaro.org. [54.225.227.206]) by mx.google.com with ESMTPS id y1si27977348qcq.39.2014.12.03.06.18.00 for (version=TLSv1 cipher=RC4-SHA bits=128/128); Wed, 03 Dec 2014 06:18:00 -0800 (PST) Received-SPF: none (google.com: lng-odp-bounces@lists.linaro.org does not designate permitted sender hosts) client-ip=54.225.227.206; Received: from localhost ([127.0.0.1] helo=ip-10-35-177-41.ec2.internal) by ip-10-35-177-41.ec2.internal with esmtp (Exim 4.76) (envelope-from ) id 1XwAkg-0003EK-Fi; Wed, 03 Dec 2014 14:17:58 +0000 Received: from mail-la0-f49.google.com ([209.85.215.49]) by ip-10-35-177-41.ec2.internal with esmtp (Exim 4.76) (envelope-from ) id 1XwAkT-0003BJ-Vq for lng-odp@lists.linaro.org; Wed, 03 Dec 2014 14:17:46 +0000 Received: by mail-la0-f49.google.com with SMTP id hs14so12639062lab.36 for ; Wed, 03 Dec 2014 06:17:40 -0800 (PST) X-Received: by 10.152.6.97 with SMTP id z1mr4667805laz.4.1417616260426; Wed, 03 Dec 2014 06:17:40 -0800 (PST) Received: from macmini.lan (84-217-193-77.tn.glocalnet.net. [84.217.193.77]) by mx.google.com with ESMTPSA id or5sm6483330lbb.42.2014.12.03.06.17.39 for (version=TLSv1.2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Wed, 03 Dec 2014 06:17:39 -0800 (PST) From: Ola Liljedahl To: lng-odp@lists.linaro.org Date: Wed, 3 Dec 2014 15:17:29 +0100 Message-Id: <1417616254-31760-2-git-send-email-ola.liljedahl@linaro.org> X-Mailer: git-send-email 1.9.1 In-Reply-To: <1417616254-31760-1-git-send-email-ola.liljedahl@linaro.org> References: <1417616254-31760-1-git-send-email-ola.liljedahl@linaro.org> X-Topics: patch Subject: [lng-odp] [PATCH 1/6] api:odp_atomic.h: Update doxygen comments, renaming of function params X-BeenThere: lng-odp@lists.linaro.org X-Mailman-Version: 2.1.14 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: , List-Help: , List-Subscribe: , MIME-Version: 1.0 Errors-To: lng-odp-bounces@lists.linaro.org Sender: lng-odp-bounces@lists.linaro.org X-Removed-Original-Auth: Dkim didn't pass. X-Original-Sender: ola.liljedahl@linaro.org X-Original-Authentication-Results: mx.google.com; spf=pass (google.com: domain of patch+caf_=patchwork-forward=linaro.org@linaro.org designates 209.85.217.176 as permitted sender) smtp.mail=patch+caf_=patchwork-forward=linaro.org@linaro.org Mailing-list: list patchwork-forward@linaro.org; contact patchwork-forward+owners@linaro.org X-Google-Group-Id: 836684582541 Signed-off-by: Ola Liljedahl --- Update doxygen comments, renaming of function params. platform/linux-generic/include/api/odp_atomic.h | 285 ++++++++++++------------ 1 file changed, 139 insertions(+), 146 deletions(-) diff --git a/platform/linux-generic/include/api/odp_atomic.h b/platform/linux-generic/include/api/odp_atomic.h index 9eebb86..488fa4e 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] p_atom Pointer to an atomic uint32 variable + * @param[in] 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 *p_atom, uint32_t val) { - __atomic_store_n(&ptr->v, val, __ATOMIC_RELAXED); + __atomic_store_n(&p_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[in] p_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 *p_atom) { - return __atomic_load_n(&ptr->v, __ATOMIC_RELAXED); + return __atomic_load_n(&p_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] p_atom Pointer to an atomic uint32 variable + * @param[in] 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 *p_atom, + uint32_t val) { - __atomic_store_n(&ptr->v, new_value, __ATOMIC_RELAXED); + __atomic_store_n(&p_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] p_atom Pointer to an atomic uint32 variable + * @param[in] 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 *p_atom, + uint32_t val) { - return __atomic_fetch_add(&ptr->v, value, __ATOMIC_RELAXED); + return __atomic_fetch_add(&p_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] p_atom Pointer to an atomic uint32 variable + * @param[in] 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 *p_atom, + uint32_t val) { - (void)__atomic_fetch_add(&ptr->v, value, __ATOMIC_RELAXED); + (void)__atomic_fetch_add(&p_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] p_atom Pointer to an atomic uint32 variable + * @param[in] 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 *p_atom, + uint32_t val) { - return __atomic_fetch_sub(&ptr->v, value, __ATOMIC_RELAXED); + return __atomic_fetch_sub(&p_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] p_atom Pointer to an atomic uint32 variable + * @param[in] 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 *p_atom, + uint32_t val) { - (void)__atomic_fetch_sub(&ptr->v, value, __ATOMIC_RELAXED); + (void)__atomic_fetch_sub(&p_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] p_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 *p_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" (p_atom) : + "r" (p_atom)); return ret; #else - return __atomic_fetch_add(&ptr->v, 1, __ATOMIC_RELAXED); + return __atomic_fetch_add(&p_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] p_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 *p_atom) { - (void)__atomic_fetch_add(&ptr->v, 1, __ATOMIC_RELAXED); + (void)__atomic_fetch_add(&p_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] p_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 *p_atom) { - return __atomic_fetch_sub(&ptr->v, 1, __ATOMIC_RELAXED); + return __atomic_fetch_sub(&p_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] p_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 *p_atom) { - (void)__atomic_fetch_sub(&ptr->v, 1, __ATOMIC_RELAXED); + (void)__atomic_fetch_sub(&p_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] p_atom Pointer to an atomic uint64 variable + * @param[in] 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 *p_atom, uint64_t val) { - ptr->v = val; + p_atom->v = val; #if __GCC_ATOMIC_LLONG_LOCK_FREE < 2 - __atomic_clear(&ptr->lock, __ATOMIC_RELAXED); + __atomic_clear(&p_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 expr Expression used update the variable. + * @param[in,out] p_atom Pointer to the 64-bit atomic variable + * @param[in] expr Expression used update the variable. * @return The old value of the variable. */ -#define ATOMIC_OP(ptr, expr) \ +#define ATOMIC_OP(p_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(&(p_atom)->lock, __ATOMIC_ACQUIRE)) \ (void)0; \ - old_val = (ptr)->v; \ + old_val = (p_atom)->v; \ (expr); /* Perform whatever update is desired */ \ - __atomic_clear(&(ptr)->lock, __ATOMIC_RELEASE); \ + __atomic_clear(&(p_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[in] p_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 *p_atom) { #if __GCC_ATOMIC_LLONG_LOCK_FREE < 2 - return ATOMIC_OP(ptr, (void)0); + return ATOMIC_OP(p_atom, (void)0); #else - return __atomic_load_n(&ptr->v, __ATOMIC_RELAXED); + return __atomic_load_n(&p_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] p_atom Pointer to an atomic uint64 variable + * @param[in] 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 *p_atom, + uint64_t val) { #if __GCC_ATOMIC_LLONG_LOCK_FREE < 2 - (void)ATOMIC_OP(ptr, ptr->v = new_value); + (void)ATOMIC_OP(p_atom, p_atom->v = val); #else - __atomic_store_n(&ptr->v, new_value, __ATOMIC_RELAXED); + __atomic_store_n(&p_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] p_atom Pointer to an atomic uint64 variable + * @param[in] 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 *p_atom, + uint64_t val) { #if __GCC_ATOMIC_LLONG_LOCK_FREE < 2 - return ATOMIC_OP(ptr, ptr->v += value); + return ATOMIC_OP(p_atom, p_atom->v += val); #else - return __atomic_fetch_add(&ptr->v, value, __ATOMIC_RELAXED); + return __atomic_fetch_add(&p_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] p_atom Pointer to an atomic uint64 variable + * @param[in] 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 *p_atom, uint64_t val) { #if __GCC_ATOMIC_LLONG_LOCK_FREE < 2 - (void)ATOMIC_OP(ptr, ptr->v += value); + (void)ATOMIC_OP(p_atom, p_atom->v += val); #else - (void)__atomic_fetch_add(&ptr->v, value, __ATOMIC_RELAXED); + (void)__atomic_fetch_add(&p_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] p_atom Pointer to an atomic uint64 variable + * @param[in] 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 *p_atom, + uint64_t val) { #if __GCC_ATOMIC_LLONG_LOCK_FREE < 2 - return ATOMIC_OP(ptr, ptr->v -= value); + return ATOMIC_OP(p_atom, p_atom->v -= val); #else - return __atomic_fetch_sub(&ptr->v, value, __ATOMIC_RELAXED); + return __atomic_fetch_sub(&p_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] p_atom Pointer to an atomic uint64 variable + * @param[in] 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 *p_atom, uint64_t val) { #if __GCC_ATOMIC_LLONG_LOCK_FREE < 2 - (void)ATOMIC_OP(ptr, ptr->v -= value); + (void)ATOMIC_OP(p_atom, p_atom->v -= val); #else - (void)__atomic_fetch_sub(&ptr->v, value, __ATOMIC_RELAXED); + (void)__atomic_fetch_sub(&p_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] p_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 *p_atom) { #if __GCC_ATOMIC_LLONG_LOCK_FREE < 2 - return ATOMIC_OP(ptr, ptr->v++); + return ATOMIC_OP(p_atom, p_atom->v++); #else - return __atomic_fetch_add(&ptr->v, 1, __ATOMIC_RELAXED); + return __atomic_fetch_add(&p_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] p_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 *p_atom) { #if __GCC_ATOMIC_LLONG_LOCK_FREE < 2 - (void)ATOMIC_OP(ptr, ptr->v++); + (void)ATOMIC_OP(p_atom, p_atom->v++); #else - (void)__atomic_fetch_add(&ptr->v, 1, __ATOMIC_RELAXED); + (void)__atomic_fetch_add(&p_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] p_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 *p_atom) { #if __GCC_ATOMIC_LLONG_LOCK_FREE < 2 - return ATOMIC_OP(ptr, ptr->v--); + return ATOMIC_OP(p_atom, p_atom->v--); #else - return __atomic_fetch_sub(&ptr->v, 1, __ATOMIC_RELAXED); + return __atomic_fetch_sub(&p_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] p_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 *p_atom) { #if __GCC_ATOMIC_LLONG_LOCK_FREE < 2 - (void)ATOMIC_OP(ptr, ptr->v--); + (void)ATOMIC_OP(p_atom, p_atom->v--); #else - (void)__atomic_fetch_sub(&ptr->v, 1, __ATOMIC_RELAXED); + (void)__atomic_fetch_sub(&p_atom->v, 1, __ATOMIC_RELAXED); #endif }