From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <dev-bounces@dpdk.org>
Received: from dpdk.org (dpdk.org [92.243.14.124])
	by inbox.dpdk.org (Postfix) with ESMTP id 6DEACA328D
	for <public@inbox.dpdk.org>; Wed, 23 Oct 2019 04:55:37 +0200 (CEST)
Received: from [92.243.14.124] (localhost [127.0.0.1])
	by dpdk.org (Postfix) with ESMTP id E5AFB1BEC8;
	Wed, 23 Oct 2019 04:55:32 +0200 (CEST)
Received: from foss.arm.com (unknown [217.140.110.172])
 by dpdk.org (Postfix) with ESMTP id B09E91BEC8
 for <dev@dpdk.org>; Wed, 23 Oct 2019 04:55:31 +0200 (CEST)
Received: from usa-sjc-imap-foss1.foss.arm.com (unknown [10.121.207.14])
 by usa-sjc-mx-foss1.foss.arm.com (Postfix) with ESMTP id 16B3F1688;
 Tue, 22 Oct 2019 19:55:22 -0700 (PDT)
Received: from net-arm-thunderx2-01.test.ast.arm.com
 (net-arm-thunderx2-01.shanghai.arm.com [10.169.40.40])
 by usa-sjc-imap-foss1.foss.arm.com (Postfix) with ESMTPA id 971733F6C4;
 Tue, 22 Oct 2019 19:55:18 -0700 (PDT)
From: Joyce Kong <joyce.kong@arm.com>
To: dev@dpdk.org
Cc: nd@arm.com, thomas@monjalon.net, jerinj@marvell.com,
 stephen@networkplumber.org, mb@smartsharesystems.com,
 honnappa.nagarahalli@arm.com, gavin.hu@arm.com, ravi1.kumar@amd.com,
 rmody@marvell.com, shshaikh@marvell.com, xuanziyang2@huawei.com,
 cloud.wangxiaoyun@huawei.com, zhouguoyang@huawei.com
Date: Wed, 23 Oct 2019 10:54:53 +0800
Message-Id: <1571799298-18873-2-git-send-email-joyce.kong@arm.com>
X-Mailer: git-send-email 2.7.4
In-Reply-To: <1571799298-18873-1-git-send-email-joyce.kong@arm.com>
References: <1571799298-18873-1-git-send-email-joyce.kong@arm.com>
In-Reply-To: <1571125801-45773-1-git-send-email-joyce.kong@arm.com>
References: <1571125801-45773-1-git-send-email-joyce.kong@arm.com>
Subject: [dpdk-dev] [PATCH v2 1/6] lib/eal: implement the family of rte bit
	operation APIs
X-BeenThere: dev@dpdk.org
X-Mailman-Version: 2.1.15
Precedence: list
List-Id: DPDK patches and discussions <dev.dpdk.org>
List-Unsubscribe: <https://mails.dpdk.org/options/dev>,
 <mailto:dev-request@dpdk.org?subject=unsubscribe>
List-Archive: <http://mails.dpdk.org/archives/dev/>
List-Post: <mailto:dev@dpdk.org>
List-Help: <mailto:dev-request@dpdk.org?subject=help>
List-Subscribe: <https://mails.dpdk.org/listinfo/dev>,
 <mailto:dev-request@dpdk.org?subject=subscribe>
Errors-To: dev-bounces@dpdk.org
Sender: "dev" <dev-bounces@dpdk.org>

There are a lot functions of bit operations scattered and
duplicated in PMDs, consolidating them into a common API
family is necessary. Furthermore, the bit operation is
mostly applied to the IO devices, so use __ATOMIC_ACQ_REL
to ensure the ordering.

Signed-off-by: Joyce Kong <joyce.kong@arm.com>
Reviewed-by: Gavin Hu <gavin.hu@arm.com>
---
 lib/librte_eal/common/Makefile                |   1 +
 lib/librte_eal/common/include/rte_io_bitops.h | 112 ++++++++++++++++++++++++++
 lib/librte_eal/common/meson.build             |   1 +
 3 files changed, 114 insertions(+)
 create mode 100644 lib/librte_eal/common/include/rte_io_bitops.h

diff --git a/lib/librte_eal/common/Makefile b/lib/librte_eal/common/Makefile
index a00d4fc..3831313 100644
--- a/lib/librte_eal/common/Makefile
+++ b/lib/librte_eal/common/Makefile
@@ -18,6 +18,7 @@ INC += rte_malloc.h rte_keepalive.h rte_time.h
 INC += rte_service.h rte_service_component.h
 INC += rte_bitmap.h rte_vfio.h rte_hypervisor.h rte_test.h
 INC += rte_reciprocal.h rte_fbarray.h rte_uuid.h
+INC += rte_io_bitops.h
 
 GENERIC_INC := rte_atomic.h rte_byteorder.h rte_cycles.h rte_prefetch.h
 GENERIC_INC += rte_memcpy.h rte_cpuflags.h
diff --git a/lib/librte_eal/common/include/rte_io_bitops.h b/lib/librte_eal/common/include/rte_io_bitops.h
new file mode 100644
index 0000000..5f778b8
--- /dev/null
+++ b/lib/librte_eal/common/include/rte_io_bitops.h
@@ -0,0 +1,112 @@
+/* SPDX-License-Identifier: BSD-3-Clause
+ * Copyright(c) 2019 Arm Limited
+ */
+
+#ifndef _RTE_IO_BITOPS_H_
+#define _RTE_IO_BITOPS_H_
+
+/**
+ * @file
+ * Bit Operations
+ *
+ * This file defines a generic API for bit operations.
+ */
+
+#include <rte_lcore.h>
+
+/**
+ * Get a bit.
+ *
+ * @param nr
+ *   The bit to get.
+ * @param addr
+ *   The address to count from.
+ * @return
+ *   The value of the bit.
+ */
+static inline int32_t
+rte_io_get_bit(uint32_t nr, uint64_t *addr)
+{
+	return __atomic_load_n(addr, __ATOMIC_ACQUIRE) & (1UL << nr);
+}
+
+/**
+ * Set a bit to 1.
+ *
+ * @param nr
+ *   The bit to set.
+ * @param addr
+ *   The address to count from.
+ */
+static inline void
+rte_io_set_bit(uint32_t nr, uint64_t *addr)
+{
+	__atomic_fetch_or(addr, (1UL << nr), __ATOMIC_ACQ_REL);
+}
+
+/**
+ * Set a bit to 0.
+ *
+ * @param nr
+ *   The bit to set.
+ * @param addr
+ *   The address to count from.
+ */
+static inline void
+rte_io_clear_bit(int32_t nr, uint64_t *addr)
+{
+	__atomic_fetch_and(addr, ~(1UL << nr), __ATOMIC_ACQ_REL);
+}
+
+/**
+ * Test if a bit is 1.
+ *
+ * @param nr
+ *   The bit to test.
+ * @param addr
+ *   The address to count from.
+ * @return
+ *   1 if the bit is 1; else 0.
+ */
+static inline int32_t
+rte_io_test_bit(int32_t nr, uint64_t *addr)
+{
+	return (__atomic_load_n(addr, __ATOMIC_ACQUIRE) & (1UL << nr)) != 0;
+}
+
+/**
+ * Set a bit to 1 and return its old value.
+ *
+ * @param nr
+ *   The bit to set.
+ * @param addr
+ *   The address to count from.
+ * @return
+ *   The old value of the bit.
+ */
+static inline int32_t
+rte_io_test_and_set_bit(int32_t nr, uint64_t *addr)
+{
+	unsigned long mask = (1UL << nr);
+
+	return __atomic_fetch_or(addr, mask, __ATOMIC_ACQ_REL) & mask;
+}
+
+/**
+ * Set a bit to 0 and return its old value.
+ *
+ * @param nr
+ *   The bit to set.
+ * @param addr
+ *   The address to count from.
+ * @return
+ *   The old value of the bit.
+ */
+static inline int32_t
+rte_io_test_and_clear_bit(int32_t nr, uint64_t *addr)
+{
+	unsigned long mask = (1UL << nr);
+
+	return __atomic_fetch_and(addr, ~mask, __ATOMIC_ACQ_REL) & mask;
+}
+#endif /* _RTE_IO_BITOPS_H_ */
diff --git a/lib/librte_eal/common/meson.build b/lib/librte_eal/common/meson.build
index 386577c..0a65d04 100644
--- a/lib/librte_eal/common/meson.build
+++ b/lib/librte_eal/common/meson.build
@@ -52,6 +52,7 @@ common_headers = files(
 	'include/rte_alarm.h',
 	'include/rte_branch_prediction.h',
 	'include/rte_bus.h',
+	'include/rte_io_bitops.h',
 	'include/rte_bitmap.h',
 	'include/rte_class.h',
 	'include/rte_common.h',
-- 
2.7.4