From: "Mattias Rönnblom" <mattias.ronnblom@ericsson.com>
To: <dev@dpdk.org>
Cc: hofors@lysator.liu.se, "Heng Wang" <heng.wang@ericsson.com>,
"Mattias Rönnblom" <mattias.ronnblom@ericsson.com>
Subject: [RFC 1/7] eal: extend bit manipulation functions
Date: Sat, 2 Mar 2024 14:53:22 +0100 [thread overview]
Message-ID: <20240302135328.531940-2-mattias.ronnblom@ericsson.com> (raw)
In-Reply-To: <20240302135328.531940-1-mattias.ronnblom@ericsson.com>
Add functionality to test, set, clear, and assign the value to
individual bits in 32-bit or 64-bit words.
These functions have no implications on memory ordering, atomicity and
does not use volatile and thus does not prevent any compiler
optimizations.
Signed-off-by: Mattias Rönnblom <mattias.ronnblom@ericsson.com>
---
lib/eal/include/rte_bitops.h | 194 ++++++++++++++++++++++++++++++++++-
1 file changed, 192 insertions(+), 2 deletions(-)
diff --git a/lib/eal/include/rte_bitops.h b/lib/eal/include/rte_bitops.h
index 449565eeae..9a368724d5 100644
--- a/lib/eal/include/rte_bitops.h
+++ b/lib/eal/include/rte_bitops.h
@@ -2,6 +2,7 @@
* Copyright(c) 2020 Arm Limited
* Copyright(c) 2010-2019 Intel Corporation
* Copyright(c) 2023 Microsoft Corporation
+ * Copyright(c) 2024 Ericsson AB
*/
#ifndef _RTE_BITOPS_H_
@@ -11,8 +12,9 @@
* @file
* Bit Operations
*
- * This file defines a family of APIs for bit operations
- * without enforcing memory ordering.
+ * This file provides functionality for low-level, single-word
+ * arithmetic and bit-level operations, such as counting or
+ * setting individual bits.
*/
#include <stdint.h>
@@ -105,6 +107,194 @@ extern "C" {
#define RTE_FIELD_GET64(mask, reg) \
((typeof(mask))(((reg) & (mask)) >> rte_ctz64(mask)))
+/**
+ * Test if a particular bit in a 32-bit word is set.
+ *
+ * This function does not give any guarantees in regards to memory
+ * ordering or atomicity.
+ *
+ * @param addr
+ * A pointer to the 32-bit word to query.
+ * @param nr
+ * The index of the bit (0-31).
+ * @return
+ * Returns true if the bit is set, and false otherwise.
+ */
+static inline bool
+rte_bit_test32(const uint32_t *addr, unsigned int nr);
+
+/**
+ * Set bit in 32-bit word.
+ *
+ * Set bit specified by @c nr in the 32-bit word pointed to by
+ * @c addr to '1'.
+ *
+ * This function does not give any guarantees in regards to memory
+ * ordering or atomicity.
+ *
+ * @param addr
+ * A pointer to the 32-bit word to modify.
+ * @param nr
+ * The index of the bit (0-31).
+ */
+static inline void
+rte_bit_set32(uint32_t *addr, unsigned int nr);
+
+/**
+ * Clear bit in 32-bit word.
+ *
+ * Set bit specified by @c nr in the 32-bit word pointed to by
+ * @c addr to '0'.
+ *
+ * This function does not give any guarantees in regards to memory
+ * ordering or atomicity.
+ *
+ * @param addr
+ * A pointer to the 32-bit word to modify.
+ * @param nr
+ * The index of the bit (0-31).
+ */
+static inline void
+rte_bit_clear32(uint32_t *addr, unsigned int nr);
+
+/**
+ * Assign a value to bit in a 32-bit word.
+ *
+ * Set bit specified by @c nr in the 32-bit word pointed to by
+ * @c addr to the value indicated by @c value.
+ *
+ * This function does not give any guarantees in regards to memory
+ * ordering or atomicity.
+ *
+ * @param addr
+ * A pointer to the 32-bit word to modify.
+ * @param nr
+ * The index of the bit (0-31).
+ * @param value
+ * The new value of the bit - true for '1', or false for '0'.
+ */
+static inline void
+rte_bit_assign32(uint32_t *addr, unsigned int nr, bool value)
+{
+ if (value)
+ rte_bit_set32(addr, nr);
+ else
+ rte_bit_clear32(addr, nr);
+}
+
+/**
+ * Test if a particular bit in a 64-bit word is set.
+ *
+ * This function does not give any guarantees in regards to memory
+ * ordering or atomicity.
+ *
+ * @param addr
+ * A pointer to the 64-bit word to query.
+ * @param nr
+ * The index of the bit (0-63).
+ * @return
+ * Returns true if the bit is set, and false otherwise.
+ */
+static inline bool
+rte_bit_test64(const uint64_t *addr, unsigned int nr);
+
+/**
+ * Set bit in 64-bit word.
+ *
+ * Set bit specified by @c nr in the 64-bit word pointed to by
+ * @c addr to '1'.
+ *
+ * This function does not give any guarantees in regards to memory
+ * ordering or atomicity.
+ *
+ * @param addr
+ * A pointer to the 64-bit word to modify.
+ * @param nr
+ * The index of the bit (0-63).
+ */
+static inline void
+rte_bit_set64(uint64_t *addr, unsigned int nr);
+
+/**
+ * Clear bit in 64-bit word.
+ *
+ * Set bit specified by @c nr in the 64-bit word pointed to by
+ * @c addr to '0'.
+ *
+ * This function does not give any guarantees in regards to memory
+ * ordering or atomicity.
+ *
+ * @param addr
+ * A pointer to the 64-bit word to modify.
+ * @param nr
+ * The index of the bit (0-63).
+ */
+static inline void
+rte_bit_clear64(uint64_t *addr, unsigned int nr);
+
+/**
+ * Assign a value to bit in a 64-bit word.
+ *
+ * Set bit specified by @c nr in the 64-bit word pointed to by
+ * @c addr to the value indicated by @c value.
+ *
+ * This function does not give any guarantees in regards to memory
+ * ordering or atomicity.
+ *
+ * @param addr
+ * A pointer to the 64-bit word to modify.
+ * @param nr
+ * The index of the bit (0-63).
+ * @param value
+ * The new value of the bit - true for '1', or false for '0'.
+ */
+static inline void
+rte_bit_assign64(uint64_t *addr, unsigned int nr, bool value)
+{
+ if (value)
+ rte_bit_set64(addr, nr);
+ else
+ rte_bit_clear64(addr, nr);
+}
+
+#define __RTE_GEN_BIT_TEST(name, size, qualifier) \
+ static inline bool \
+ name(const qualifier uint ## size ## _t *addr, unsigned int nr) \
+ { \
+ RTE_ASSERT(nr < size); \
+ \
+ uint ## size ## _t mask = (uint ## size ## _t)1 << nr; \
+ return *addr & mask; \
+ }
+
+#define __RTE_GEN_BIT_SET(name, size, qualifier) \
+ static inline void \
+ name(qualifier uint ## size ## _t *addr, unsigned int nr) \
+ { \
+ RTE_ASSERT(nr < size); \
+ \
+ uint ## size ## _t mask = (uint ## size ## _t)1 << nr; \
+ *addr |= mask; \
+ } \
+
+#define __RTE_GEN_BIT_CLEAR(name, size, qualifier) \
+ static inline void \
+ name(qualifier uint ## size ## _t *addr, unsigned int nr) \
+ { \
+ RTE_ASSERT(nr < size); \
+ \
+ uint ## size ## _t mask = ~((uint ## size ## _t)1 << nr); \
+ (*addr) &= mask; \
+ } \
+
+__RTE_GEN_BIT_TEST(rte_bit_test32, 32,)
+__RTE_GEN_BIT_SET(rte_bit_set32, 32,)
+__RTE_GEN_BIT_CLEAR(rte_bit_clear32, 32,)
+
+__RTE_GEN_BIT_TEST(rte_bit_test64, 64,)
+__RTE_GEN_BIT_SET(rte_bit_set64, 64,)
+__RTE_GEN_BIT_CLEAR(rte_bit_clear64, 64,)
+
/*------------------------ 32-bit relaxed operations ------------------------*/
/**
--
2.34.1
next prev parent reply other threads:[~2024-03-02 14:02 UTC|newest]
Thread overview: 90+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-03-02 13:53 [RFC 0/7] Improve EAL bit operations API Mattias Rönnblom
2024-03-02 13:53 ` Mattias Rönnblom [this message]
2024-03-02 17:05 ` [RFC 1/7] eal: extend bit manipulation functions Stephen Hemminger
2024-03-03 6:26 ` Mattias Rönnblom
2024-03-04 16:34 ` Tyler Retzlaff
2024-03-05 18:01 ` Mattias Rönnblom
2024-03-05 18:06 ` Tyler Retzlaff
2024-04-25 8:58 ` [RFC v2 0/6] Improve EAL bit operations API Mattias Rönnblom
2024-04-25 8:58 ` [RFC v2 1/6] eal: extend bit manipulation functionality Mattias Rönnblom
2024-04-29 9:51 ` [RFC v3 0/6] Improve EAL bit operations API Mattias Rönnblom
2024-04-29 9:51 ` [RFC v3 1/6] eal: extend bit manipulation functionality Mattias Rönnblom
2024-04-29 11:12 ` Morten Brørup
2024-04-30 9:55 ` [RFC v4 0/6] Improve EAL bit operations API Mattias Rönnblom
2024-04-30 9:55 ` [RFC v4 1/6] eal: extend bit manipulation functionality Mattias Rönnblom
2024-04-30 12:08 ` [RFC v5 0/6] Improve EAL bit operations API Mattias Rönnblom
2024-04-30 12:08 ` [RFC v5 1/6] eal: extend bit manipulation functionality Mattias Rönnblom
2024-05-02 5:57 ` [RFC v6 0/6] Improve EAL bit operations API Mattias Rönnblom
2024-05-02 5:57 ` [RFC v6 1/6] eal: extend bit manipulation functionality Mattias Rönnblom
2024-05-05 8:37 ` [RFC v7 0/6] Improve EAL bit operations API Mattias Rönnblom
2024-05-05 8:37 ` [RFC v7 1/6] eal: extend bit manipulation functionality Mattias Rönnblom
2024-05-05 8:37 ` [RFC v7 2/6] eal: add unit tests for bit operations Mattias Rönnblom
2024-05-05 8:37 ` [RFC v7 3/6] eal: add exactly-once bit access functions Mattias Rönnblom
2024-05-07 19:17 ` Morten Brørup
2024-05-08 6:47 ` Mattias Rönnblom
2024-05-08 7:33 ` Morten Brørup
2024-05-08 8:00 ` Mattias Rönnblom
2024-05-08 8:11 ` Morten Brørup
2024-05-08 9:27 ` Mattias Rönnblom
2024-05-08 10:08 ` Morten Brørup
2024-05-08 15:15 ` Stephen Hemminger
2024-05-08 16:16 ` Morten Brørup
2024-05-05 8:37 ` [RFC v7 4/6] eal: add unit tests for " Mattias Rönnblom
2024-05-05 8:37 ` [RFC v7 5/6] eal: add atomic bit operations Mattias Rönnblom
2024-05-05 8:37 ` [RFC v7 6/6] eal: add unit tests for atomic bit access functions Mattias Rönnblom
2024-05-02 5:57 ` [RFC v6 2/6] eal: add unit tests for bit operations Mattias Rönnblom
2024-05-02 5:57 ` [RFC v6 3/6] eal: add exactly-once bit access functions Mattias Rönnblom
2024-05-02 5:57 ` [RFC v6 4/6] eal: add unit tests for " Mattias Rönnblom
2024-05-02 5:57 ` [RFC v6 5/6] eal: add atomic bit operations Mattias Rönnblom
2024-05-03 6:41 ` Mattias Rönnblom
2024-05-03 23:30 ` Tyler Retzlaff
2024-05-04 15:36 ` Mattias Rönnblom
2024-05-02 5:57 ` [RFC v6 6/6] eal: add unit tests for atomic bit access functions Mattias Rönnblom
2024-04-30 12:08 ` [RFC v5 2/6] eal: add unit tests for bit operations Mattias Rönnblom
2024-04-30 12:08 ` [RFC v5 3/6] eal: add exactly-once bit access functions Mattias Rönnblom
2024-04-30 12:08 ` [RFC v5 4/6] eal: add unit tests for " Mattias Rönnblom
2024-04-30 12:08 ` [RFC v5 5/6] eal: add atomic bit operations Mattias Rönnblom
2024-04-30 12:08 ` [RFC v5 6/6] eal: add unit tests for atomic bit access functions Mattias Rönnblom
2024-04-30 9:55 ` [RFC v4 2/6] eal: add unit tests for bit operations Mattias Rönnblom
2024-04-30 9:55 ` [RFC v4 3/6] eal: add exactly-once bit access functions Mattias Rönnblom
2024-04-30 9:55 ` [RFC v4 4/6] eal: add unit tests for " Mattias Rönnblom
2024-04-30 10:37 ` Morten Brørup
2024-04-30 11:58 ` Mattias Rönnblom
2024-04-30 9:55 ` [RFC v4 5/6] eal: add atomic bit operations Mattias Rönnblom
2024-04-30 9:55 ` [RFC v4 6/6] eal: add unit tests for atomic bit access functions Mattias Rönnblom
2024-04-29 9:51 ` [RFC v3 2/6] eal: add unit tests for bit operations Mattias Rönnblom
2024-04-29 9:51 ` [RFC v3 3/6] eal: add exactly-once bit access functions Mattias Rönnblom
2024-04-29 9:51 ` [RFC v3 4/6] eal: add unit tests for " Mattias Rönnblom
2024-04-29 9:51 ` [RFC v3 5/6] eal: add atomic bit operations Mattias Rönnblom
2024-04-29 9:51 ` [RFC v3 6/6] eal: add unit tests for atomic bit access functions Mattias Rönnblom
2024-04-25 8:58 ` [RFC v2 2/6] eal: add unit tests for bit operations Mattias Rönnblom
2024-04-25 8:58 ` [RFC v2 3/6] eal: add exactly-once bit access functions Mattias Rönnblom
2024-04-25 8:58 ` [RFC v2 4/6] eal: add unit tests for " Mattias Rönnblom
2024-04-25 8:58 ` [RFC v2 5/6] eal: add atomic bit operations Mattias Rönnblom
2024-04-25 10:25 ` Morten Brørup
2024-04-25 14:36 ` Mattias Rönnblom
2024-04-25 16:18 ` Morten Brørup
2024-04-26 9:39 ` Mattias Rönnblom
2024-04-26 12:00 ` Morten Brørup
2024-04-28 15:37 ` Mattias Rönnblom
2024-04-29 7:24 ` Morten Brørup
2024-04-30 16:52 ` Tyler Retzlaff
2024-04-25 8:58 ` [RFC v2 6/6] eal: add unit tests for atomic bit access functions Mattias Rönnblom
2024-04-25 18:05 ` [RFC v2 0/6] Improve EAL bit operations API Tyler Retzlaff
2024-04-26 11:17 ` Mattias Rönnblom
2024-04-26 21:35 ` Patrick Robb
2024-03-02 13:53 ` [RFC 2/7] eal: add generic bit manipulation macros Mattias Rönnblom
2024-03-04 8:16 ` Heng Wang
2024-03-04 15:41 ` Mattias Rönnblom
2024-03-04 16:42 ` Tyler Retzlaff
2024-03-05 18:08 ` Mattias Rönnblom
2024-03-05 18:22 ` Tyler Retzlaff
2024-03-05 20:02 ` Mattias Rönnblom
2024-03-05 20:53 ` Tyler Retzlaff
2024-03-02 13:53 ` [RFC 3/7] eal: add bit manipulation functions which read or write once Mattias Rönnblom
2024-03-02 13:53 ` [RFC 4/7] eal: add generic once-type bit operations macros Mattias Rönnblom
2024-03-02 13:53 ` [RFC 5/7] eal: add atomic bit operations Mattias Rönnblom
2024-03-02 13:53 ` [RFC 6/7] eal: add generic " Mattias Rönnblom
2024-03-02 13:53 ` [RFC 7/7] eal: deprecate relaxed family of " Mattias Rönnblom
2024-03-02 17:07 ` Stephen Hemminger
2024-03-03 6:30 ` Mattias Rönnblom
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20240302135328.531940-2-mattias.ronnblom@ericsson.com \
--to=mattias.ronnblom@ericsson.com \
--cc=dev@dpdk.org \
--cc=heng.wang@ericsson.com \
--cc=hofors@lysator.liu.se \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).