From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id 09FB443F54; Tue, 30 Apr 2024 14:18:48 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 082F1402C6; Tue, 30 Apr 2024 14:18:37 +0200 (CEST) Received: from EUR02-DB5-obe.outbound.protection.outlook.com (mail-db5eur02on2046.outbound.protection.outlook.com [40.107.249.46]) by mails.dpdk.org (Postfix) with ESMTP id 9D7DE402AA for ; Tue, 30 Apr 2024 14:18:34 +0200 (CEST) ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=DE7Z3BeA6ZAW8lIbHh+cH56JW0LLZ5RpjfN/kFqvXbiBoAUIxhLpV1tVV5+GE+y/I13mcH8f95ChFa1qJHDO9Yj4QL2DMzCYXFMlnvQnMuDI9gP2Jkpqfsktmp8UvpZAewYVQYQFEG7qS+w6B97wC+lrn3qRYJwyudFi+PYLEZFH+IKZCkT91FZGCijGs8cBDJtJIO2OTdgVRWJVN+7WiSCir3jxzcK1zWwsTlykz6s78uNDG6L0BhLGIwuP705o2xvj2WN2ZxZQzeUQ84topsN9RUyZZEIZNjWFjYxxLwSQmAvlNr+eNN3sfAWyoyD2zV+A55LwTEqLrTc3vzDOPw== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=arcselector9901; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-AntiSpam-MessageData-ChunkCount:X-MS-Exchange-AntiSpam-MessageData-0:X-MS-Exchange-AntiSpam-MessageData-1; bh=AvPWbCvgzyOJyxa/j0ge/ILRgogIdQ9NHvtGx46yEDw=; b=XYXnaM0gd32ROnKt02XBbNvPWZj2sKyOGoBi/nyn48Bs/kbNNloxP9j4YH4xfAwchT9ax4QrliA+2SCsDfT9EOoZMTRXUzpJ25v7/UixThMTko1ak/7zlSg96rlcO3F8i9obZk957t9G8ZGmlxS1GbpXbHK375NqAVGJ3pNoyDDXh4PxktGC3K230dCJf69Nw2bSD5KHrKmdldCHDpijX3yt1YBAbPzeLtztKNFx800DA2mpk5EJir1lVtvTTJfB26ZAZ6NrP4Idi3KRciO6NsJymubmRrbsl9n2x7uSwhRIMPBm4wwNNDfPcWPsfkJzs1RWXNQiDQbuR18LyZv3IA== ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=pass (sender ip is 192.176.1.74) smtp.rcpttodomain=dpdk.org smtp.mailfrom=ericsson.com; dmarc=pass (p=reject sp=reject pct=100) action=none header.from=ericsson.com; dkim=none (message not signed); arc=none (0) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=ericsson.com; s=selector1; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=AvPWbCvgzyOJyxa/j0ge/ILRgogIdQ9NHvtGx46yEDw=; b=GhxTzfR57OMLb6lpoLvN47In+NBy0YohgLQCEj5xJCCbTyQnlHPWD6KfhmldHhE0rdFiYDXooX2ZRq7qf8st77Ff9HayVeqg1B9VoYn5Nx3djbHGPdUhHISKTmgvrfNz7SqwSpBXY+5fKHlkHTr/WHaQDkr5epSHzQu3PL1FSfLHtKe49FkmmRJZiCr/0HWqQ5mq8JOgw2EiWmNVGiwFixua4ocvH8vU/4FJjNEmGHB9vhv7cEYVX+IId0mA0Jrn+ZLqEu9A8nSFZiQ4L7fvgXaGZWhXmIWAleHBylsY00jLtHHChvdmCdYG8hEvLNvMVvzoCDCcou+1NfvSLqdmdQ== Received: from AS9PR06CA0077.eurprd06.prod.outlook.com (2603:10a6:20b:464::24) by PA4PR07MB7248.eurprd07.prod.outlook.com (2603:10a6:102:d7::7) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.7519.36; Tue, 30 Apr 2024 12:18:32 +0000 Received: from AMS0EPF00000190.eurprd05.prod.outlook.com (2603:10a6:20b:464:cafe::1) by AS9PR06CA0077.outlook.office365.com (2603:10a6:20b:464::24) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.7519.34 via Frontend Transport; Tue, 30 Apr 2024 12:18:32 +0000 X-MS-Exchange-Authentication-Results: spf=pass (sender IP is 192.176.1.74) smtp.mailfrom=ericsson.com; dkim=none (message not signed) header.d=none;dmarc=pass action=none header.from=ericsson.com; Received-SPF: Pass (protection.outlook.com: domain of ericsson.com designates 192.176.1.74 as permitted sender) receiver=protection.outlook.com; client-ip=192.176.1.74; helo=oa.msg.ericsson.com; pr=C Received: from oa.msg.ericsson.com (192.176.1.74) by AMS0EPF00000190.mail.protection.outlook.com (10.167.16.213) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.7519.19 via Frontend Transport; Tue, 30 Apr 2024 12:18:32 +0000 Received: from seliicinfr00049.seli.gic.ericsson.se (153.88.142.248) by smtp-central.internal.ericsson.com (100.87.178.69) with Microsoft SMTP Server id 15.2.1544.9; Tue, 30 Apr 2024 14:18:32 +0200 Received: from breslau.. (seliicwb00002.seli.gic.ericsson.se [10.156.25.100]) by seliicinfr00049.seli.gic.ericsson.se (Postfix) with ESMTP id 2DBDA380061; Tue, 30 Apr 2024 14:18:32 +0200 (CEST) From: =?UTF-8?q?Mattias=20R=C3=B6nnblom?= To: CC: , Heng Wang , "Stephen Hemminger" , Tyler Retzlaff , =?UTF-8?q?Morten=20Br=C3=B8rup?= , =?UTF-8?q?Mattias=20R=C3=B6nnblom?= Subject: [RFC v5 3/6] eal: add exactly-once bit access functions Date: Tue, 30 Apr 2024 14:08:07 +0200 Message-ID: <20240430120810.108928-4-mattias.ronnblom@ericsson.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20240430120810.108928-1-mattias.ronnblom@ericsson.com> References: <20240430095523.108688-2-mattias.ronnblom@ericsson.com> <20240430120810.108928-1-mattias.ronnblom@ericsson.com> MIME-Version: 1.0 Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: 8bit X-EOPAttributedMessage: 0 X-MS-PublicTrafficType: Email X-MS-TrafficTypeDiagnostic: AMS0EPF00000190:EE_|PA4PR07MB7248:EE_ X-MS-Office365-Filtering-Correlation-Id: 649f8bb2-bf90-4098-7ace-08dc690fa704 X-MS-Exchange-SenderADCheck: 1 X-MS-Exchange-AntiSpam-Relay: 0 X-Microsoft-Antispam: BCL:0; ARA:13230031|1800799015|82310400014|376005|36860700004; X-Microsoft-Antispam-Message-Info: =?utf-8?B?U2JXa0ZtTVc5bENqcG54WFpKbGIxcTJjOUVrYnNuRjVtZ1BkOEVMUFF3MXJG?= =?utf-8?B?YVZ0K2c5MVZ2V29LamVrSnZsN25ESFNtYVRSNlJYU0VVZE93dmVkNU4vM29i?= =?utf-8?B?QlFrajlLVk1KeHlaMU84RUxEMmVUdkk3a0FPYUdtZFhMZ2NHYitkSERPR2RO?= =?utf-8?B?YUhUVlhLejZjMGR1cE0zNHZqeG92YVZHTUIzSnhDQmM4K3Jhem4yVnEyVDBP?= =?utf-8?B?ZFY0TlJDWXVzWDNjMTdxZE1qS01FNThyay9aNVJYRHlxZHNYZXc1MGw0Y0k0?= =?utf-8?B?bWFrenUva0RUc2E2SStFcXJVT1FLVlhKbURwZTg2NHhPVzBKT0ZyenZvTWhV?= =?utf-8?B?L0Q5ZkFpYUFLenRaQ1RDYkgwZHdpN3k1VFNUclMvcXlaaEE3VisyVVhneEll?= =?utf-8?B?bTduVjlIVzYxWm8rMEJlMEdTZnU0VEdzWE5UZlRhOW5URFJqV3Vqdit3TE5t?= =?utf-8?B?YzZmbmNnN1dIdkpxYkozWm1iV25kZk9EVncvRkc4N08rcUkrc3R0UVR5U2Ux?= =?utf-8?B?TENsNk1kc3poTWFVd2o3SlVma3A0TEkrUTRXWVZJVnVTeC85TitSbHhNdzY1?= =?utf-8?B?blFvNjRWSlk4RmJpcEtjT1doZlNha0lxT1V2YlhmOUx2aS9QQ0VWQVFVQXhu?= =?utf-8?B?NHVKV2xRL3ordVVNOVV5WGxHR2JQRkF6WE9aU0VjUmJHY3I4L0lEb1I2RlZi?= =?utf-8?B?WkZBWDRYbUtMdGw5NXJFUHdXeDVMZGV2K1NYVjVzVWhnS3g1Z0RXS21UbDND?= =?utf-8?B?R2Jjdmcvd3M2S0lPNXJFeVFscXNqek1Ld0RHREZjTFV6L05RVHMybWE5Ri9p?= =?utf-8?B?b3gvR3RQeVdVcmZVaDRGQzdpVjc1KzJKQVoydUhmOWFybWVGYUZZUEFoaXBC?= =?utf-8?B?cGQrNWpUSE5VZ2JIeUVETndTb2o3WFZqbmtOZElnWXg0b2plNGhFcVZFUS8r?= =?utf-8?B?RWZXZ3RSS2NNSXFEdW10YW01cldoM1FGZDdkaEVnaXU0ankxZnY5Yjdyd2Jt?= =?utf-8?B?QXR2Q1c4aEVUOVlNZGxnQm1nanhjaUtTRytMQmtDVHgrUSt2MXlkbEJIZ3p3?= =?utf-8?B?a1FiQkM4clBvamFoeDJLOER2RDRjaWxnSS8yeGt1TS9xRmRoYWtwSjAxVm1Y?= =?utf-8?B?UWlxSWtRaEtNcXVLOU5MT3JiV3Fka2RXZTB6TnRFc0lGVkhQdlloNjhCbE9W?= =?utf-8?B?ZGNpUWE0MnEyNFh3ejdPUDJyV01EWDFiemFCQXk1M3BjSUxwTDNUUW02RWFh?= =?utf-8?B?aTN2cllJRjJzandBcDY2ejJGTU1JOSszTkxPb3lvTndkbXhob0VRSFZvTUdE?= =?utf-8?B?SjVMVzNsMkI0MEh1RmFLQ1dHNGNOOVhERVpydjN1ZmlBYzhZajNERGFTUVVG?= =?utf-8?B?M0ZSR2x6QWJ5L3VOUFQzRTk3QjlNQTBZWEhxcHhxMUVVbmZrVjVybUF0eWJJ?= =?utf-8?B?STM5YkZNamx6dDEyZ2h2NmJrQ2grMTlsck5iSm5YL0duQW41Ny9NQzhPMjFv?= =?utf-8?B?U2xHRnF6OFkweitoYnFIalZ5Q2w4SzhMKzZzd0xpS29KTUZHZ1k5ZTFYNnRG?= =?utf-8?B?aXh0MFdiSDZaL3ZoR2JHT3FRa3daUFNlVnBHa2dJamhsQ3BpWk84QmxmaW5T?= =?utf-8?B?Z2tGN1FWVlhvSEZYUk9pSXpCamcyazdJMDFzODZJZTQ4NUNEaVhzOGV3OXpD?= =?utf-8?B?SWVBZnFEUktSdktMS01QcXhZWWZKNGRESXZJTDJkbmh6Q1lMQW5CdEk5UVZp?= =?utf-8?B?VUsyVVhYT3RWbEp5bm9jeWJpSXBZZWl2U0RTbjdVTFEyT25QWnk1TjUwNEpS?= =?utf-8?B?MGtuKytqUFZzNXBSTkN0akZGNmVFZ1lmcnZ6MnpPMU5tOGU5bzB2bDBwL3RC?= =?utf-8?Q?aoXh/ZCA2QYKC?= X-Forefront-Antispam-Report: CIP:192.176.1.74; CTRY:SE; LANG:en; SCL:1; SRV:; IPV:NLI; SFV:NSPM; H:oa.msg.ericsson.com; PTR:office365.se.ericsson.net; CAT:NONE; SFS:(13230031)(1800799015)(82310400014)(376005)(36860700004); DIR:OUT; SFP:1101; X-OriginatorOrg: ericsson.com X-MS-Exchange-CrossTenant-OriginalArrivalTime: 30 Apr 2024 12:18:32.6813 (UTC) X-MS-Exchange-CrossTenant-Network-Message-Id: 649f8bb2-bf90-4098-7ace-08dc690fa704 X-MS-Exchange-CrossTenant-Id: 92e84ceb-fbfd-47ab-be52-080c6b87953f X-MS-Exchange-CrossTenant-OriginalAttributedTenantConnectingIp: TenantId=92e84ceb-fbfd-47ab-be52-080c6b87953f; Ip=[192.176.1.74]; Helo=[oa.msg.ericsson.com] X-MS-Exchange-CrossTenant-AuthSource: AMS0EPF00000190.eurprd05.prod.outlook.com X-MS-Exchange-CrossTenant-AuthAs: Anonymous X-MS-Exchange-CrossTenant-FromEntityHeader: HybridOnPrem X-MS-Exchange-Transport-CrossTenantHeadersStamped: PA4PR07MB7248 X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Add bit test/set/clear/assign functions which prevents certain compiler optimizations and guarantees that program-level memory loads and/or stores will actually occur. These functions are useful when interacting with memory-mapped hardware devices. The "once" family of functions does not promise atomicity and provides no memory ordering guarantees beyond the C11 relaxed memory model. RFC v3: * Work around lack of C++ support for _Generic (Tyler Retzlaff). Signed-off-by: Mattias Rönnblom Acked-by: Morten Brørup Acked-by: Tyler Retzlaff --- lib/eal/include/rte_bitops.h | 195 +++++++++++++++++++++++++++++++++++ 1 file changed, 195 insertions(+) diff --git a/lib/eal/include/rte_bitops.h b/lib/eal/include/rte_bitops.h index 9d426f1602..f77bd83e97 100644 --- a/lib/eal/include/rte_bitops.h +++ b/lib/eal/include/rte_bitops.h @@ -224,6 +224,177 @@ extern "C" { uint32_t *: __rte_bit_flip32, \ uint64_t *: __rte_bit_flip64)(addr, nr) +/** + * @warning + * @b EXPERIMENTAL: this API may change without prior notice. + * + * Generic selection macro to test exactly once the value of a bit in + * a 32-bit or 64-bit word. The type of operation depends on the type + * of the @c addr parameter. + * + * This function is guaranteed to result in exactly one memory load + * (e.g., it may not be eliminate or merged by the compiler). + * + * \code{.c} + * rte_bit_once_set(addr, 17); + * if (rte_bit_once_test(addr, 17)) { + * ... + * } + * \endcode + * + * In the above example, rte_bit_once_set() may not be removed by + * the compiler, which would be allowed in case rte_bit_set() and + * rte_bit_test() was used. + * + * \code{.c} + * while (rte_bit_once_test(addr, 17); + * ; + * \endcode + * + * In case rte_bit_test(addr, 17) was used instead, the resulting + * object code could (and in many cases would be) replaced with + * the equivalent to + * \code{.c} + * if (rte_bit_test(addr, 17)) { + * for (;;) // spin forever + * ; + * } + * \endcode + * + * rte_bit_once_test() does not give any guarantees in regards to + * memory ordering or atomicity. + * + * The regular bit set operations (e.g., rte_bit_test()) should be + * preferred over the "once" family of operations (e.g., + * rte_bit_once_test()) if possible, since the latter may prevent + * optimizations crucial for run-time performance. + * + * @param addr + * A pointer to the word to query. + * @param nr + * The index of the bit. + * @return + * Returns true if the bit is set, and false otherwise. + */ + +#define rte_bit_once_test(addr, nr) \ + _Generic((addr), \ + uint32_t *: __rte_bit_once_test32, \ + uint64_t *: __rte_bit_once_test64)(addr, nr) + +/** + * @warning + * @b EXPERIMENTAL: this API may change without prior notice. + * + * Set bit in word exactly once. + * + * Set bit specified by @c nr in the word pointed to by @c addr to '1' + * exactly once. + * + * This function is guaranteed to result in exactly one memory load + * and exactly one memory store, *or* an atomic bit set operation. + * + * See rte_bit_test_once32() for more information and uses cases for + * the "once" class of functions. + * + * This macro does not give any guarantees in regards to memory + * ordering or atomicity. + * + * @param addr + * A pointer to the word to modify. + * @param nr + * The index of the bit. + */ + +#define rte_bit_once_set(addr, nr) \ + _Generic((addr), \ + uint32_t *: __rte_bit_once_set32, \ + uint64_t *: __rte_bit_once_set64)(addr, nr) + +/** + * @warning + * @b EXPERIMENTAL: this API may change without prior notice. + * + * Clear bit in word exactly once. + * + * Set bit specified by @c nr in the word pointed to by @c addr to '0' + * exactly once. + * + * This function is guaranteed to result in exactly one memory load + * and exactly one memory store, *or* an atomic bit clear operation. + * + * See rte_bit_test_once32() for more information and uses cases for + * the "once" class of functions. + * + * This macro does not give any guarantees in regards to memory + * ordering or atomicity. + * + * @param addr + * A pointer to the word to modify. + * @param nr + * The index of the bit. + */ +#define rte_bit_once_clear(addr, nr) \ + _Generic((addr), \ + uint32_t *: __rte_bit_once_clear32, \ + uint64_t *: __rte_bit_once_clear64)(addr, nr) + +/** + * @warning + * @b EXPERIMENTAL: this API may change without prior notice. + * + * Assign a value to bit in a word exactly once. + * + * Set bit specified by @c nr in the word pointed to by @c addr to the + * value indicated by @c value exactly once. + * + * This function is guaranteed to result in exactly one memory load + * and exactly one memory store, *or* an atomic bit clear operation. + * + * This function does not give any guarantees in regards to memory + * ordering or atomicity. + * + * @param addr + * A pointer to the word to modify. + * @param nr + * The index of the bit. + * @param value + * The new value of the bit - true for '1', or false for '0'. + */ +#define rte_bit_once_assign(addr, nr, value) \ + _Generic((addr), \ + uint32_t *: __rte_bit_once_assign32, \ + uint64_t *: __rte_bit_once_assign64)(addr, nr, value) + +/** + * @warning + * @b EXPERIMENTAL: this API may change without prior notice. + * + * Flip bit in word, reading and writing exactly once. + * + * Change the value of a bit to '0' if '1' or '1' if '0' in a 32-bit + * or 64-bit word. The type of operation depends on the type of the @c + * addr parameter. + * + * This function is guaranteed to result in exactly one memory load + * and exactly one memory store, *or* an atomic bit flip operation. + * + * See rte_bit_test_once32() for more information and uses cases for + * the "once" class of functions. + * + * This macro does not give any guarantees in regards to memory + * ordering or atomicity. + * + * @param addr + * A pointer to the word to modify. + * @param nr + * The index of the bit. + */ +#define rte_bit_once_flip(addr, nr) \ + _Generic((addr), \ + uint32_t *: __rte_bit_once_flip32, \ + uint64_t *: __rte_bit_once_flip64)(addr, nr) + #define __RTE_GEN_BIT_TEST(family, fun, qualifier, size) \ __rte_experimental \ static inline bool \ @@ -296,6 +467,18 @@ __RTE_GEN_BIT_CLEAR(, clear,, 64) __RTE_GEN_BIT_ASSIGN(, assign,, 64) __RTE_GEN_BIT_FLIP(, flip,, 64) +__RTE_GEN_BIT_TEST(once_, test, volatile, 32) +__RTE_GEN_BIT_SET(once_, set, volatile, 32) +__RTE_GEN_BIT_CLEAR(once_, clear, volatile, 32) +__RTE_GEN_BIT_ASSIGN(once_, assign, volatile, 32) +__RTE_GEN_BIT_FLIP(once_, flip, volatile, 32) + +__RTE_GEN_BIT_TEST(once_, test, volatile, 64) +__RTE_GEN_BIT_SET(once_, set, volatile, 64) +__RTE_GEN_BIT_CLEAR(once_, clear, volatile, 64) +__RTE_GEN_BIT_ASSIGN(once_, assign, volatile, 64) +__RTE_GEN_BIT_FLIP(once_, flip, volatile, 64) + /*------------------------ 32-bit relaxed operations ------------------------*/ /** @@ -991,6 +1174,12 @@ rte_log2_u64(uint64_t v) #undef rte_bit_assign #undef rte_bit_flip +#undef rte_bit_once_test +#undef rte_bit_once_set +#undef rte_bit_once_clear +#undef rte_bit_once_assign +#undef rte_bit_once_flip + #define __RTE_BIT_OVERLOAD_SZ_2(fun, qualifier, size, arg1_type, arg1_name) \ static inline void \ rte_bit_ ## fun(qualifier uint ## size ## _t *addr, \ @@ -1040,6 +1229,12 @@ __RTE_BIT_OVERLOAD_2(clear,, unsigned int, nr) __RTE_BIT_OVERLOAD_3(assign,, unsigned int, nr, bool, value) __RTE_BIT_OVERLOAD_2(flip,, unsigned int, nr) +__RTE_BIT_OVERLOAD_2R(once_test, const volatile, bool, unsigned int, nr) +__RTE_BIT_OVERLOAD_2(once_set, volatile, unsigned int, nr) +__RTE_BIT_OVERLOAD_2(once_clear, volatile, unsigned int, nr) +__RTE_BIT_OVERLOAD_3(once_assign, volatile, unsigned int, nr, bool, value) +__RTE_BIT_OVERLOAD_2(once_flip, volatile, unsigned int, nr) + #endif #endif /* _RTE_BITOPS_H_ */ -- 2.34.1