From patchwork Mon Jan 16 13:07:24 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?q?Morten_Br=C3=B8rup?= X-Patchwork-Id: 122101 X-Patchwork-Delegate: david.marchand@redhat.com Return-Path: X-Original-To: patchwork@inbox.dpdk.org Delivered-To: patchwork@inbox.dpdk.org Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id F1BAF423F0; Mon, 16 Jan 2023 14:07:45 +0100 (CET) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 8399942D24; Mon, 16 Jan 2023 14:07:30 +0100 (CET) Received: from smartserver.smartsharesystems.com (smartserver.smartsharesystems.com [77.243.40.215]) by mails.dpdk.org (Postfix) with ESMTP id 03C8A40E6E for ; Mon, 16 Jan 2023 14:07:26 +0100 (CET) Received: from dkrd2.smartsharesys.local ([192.168.4.12]) by smartserver.smartsharesystems.com with Microsoft SMTPSVC(6.0.3790.4675); Mon, 16 Jan 2023 14:07:26 +0100 From: =?utf-8?q?Morten_Br=C3=B8rup?= To: dev@dpdk.org, roretzla@linux.microsoft.com, rmody@marvell.com, timothy.mcdaniel@intel.com, matan@nvidia.com, viacheslavo@nvidia.com Cc: ruifeng.wang@arm.com, zhoumin@loongson.cn, drc@linux.vnet.ibm.com, kda@semihalf.com, bruce.richardson@intel.com, konstantin.v.ananyev@yandex.ru, =?utf-8?q?Morten_Br=C3=B8rup?= Subject: [PATCH v7 4/4] eal: add nonnull and access function attributes Date: Mon, 16 Jan 2023 14:07:24 +0100 Message-Id: <20230116130724.50277-4-mb@smartsharesystems.com> X-Mailer: git-send-email 2.17.1 In-Reply-To: <20230116130724.50277-1-mb@smartsharesystems.com> References: <20221202153432.131023-1-mb@smartsharesystems.com> <20230116130724.50277-1-mb@smartsharesystems.com> MIME-Version: 1.0 X-OriginalArrivalTime: 16 Jan 2023 13:07:26.0553 (UTC) FILETIME=[7B191C90:01D929AB] 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 nonnull function attribute to help the compiler detect a NULL pointer being passed to a function not accepting NULL pointers as an argument at build time. Add access function attributes to tell the compiler how a function accesses memory pointed to by its pointer arguments. Add these attributes to the rte_memcpy() function, as the first in hopefully many to come. Signed-off-by: Morten Brørup Acked-by: Tyler Retzlaff Reviewed-by: Ruifeng Wang --- v7: * Fix indentation. (checkpatch) v6: * Make this the last patch in the series, putting the fixes first. (David) * Split the generic access macro into dedicated macros per access mode. (David) v5: * No changes. v4: * No changes. v3: * No changes. v2: * Only define "nonnull" for GCC and CLANG. * Append _param/_params to prepare for possible future attributes attached directly to the individual parameters, like __rte_unused. * Use RTE_TOOLCHAIN_GCC instead of RTE_CC_GCC, to fix complaints about GCC_VERSION being undefined. * Try to fix Doxygen compliants. --- lib/eal/arm/include/rte_memcpy_32.h | 8 +++ lib/eal/arm/include/rte_memcpy_64.h | 6 +++ lib/eal/include/rte_common.h | 76 +++++++++++++++++++++++++++++ lib/eal/ppc/include/rte_memcpy.h | 3 ++ lib/eal/x86/include/rte_memcpy.h | 6 +++ 5 files changed, 99 insertions(+) diff --git a/lib/eal/arm/include/rte_memcpy_32.h b/lib/eal/arm/include/rte_memcpy_32.h index fb3245b59c..a625a91951 100644 --- a/lib/eal/arm/include/rte_memcpy_32.h +++ b/lib/eal/arm/include/rte_memcpy_32.h @@ -14,6 +14,8 @@ extern "C" { #include "generic/rte_memcpy.h" +#include + #ifdef RTE_ARCH_ARM_NEON_MEMCPY #ifndef __ARM_NEON @@ -125,6 +127,9 @@ rte_mov256(uint8_t *dst, const uint8_t *src) memcpy((dst), (src), (n)) : \ rte_memcpy_func((dst), (src), (n)); }) +__rte_nonnull_params(1, 2) +__rte_write_only_param(1, 3) +__rte_read_only_param(2, 3) static inline void * rte_memcpy_func(void *dst, const void *src, size_t n) { @@ -290,6 +295,9 @@ rte_mov256(uint8_t *dst, const uint8_t *src) memcpy(dst, src, 256); } +__rte_nonnull_params(1, 2) +__rte_write_only_param(1, 3) +__rte_read_only_param(2, 3) static inline void * rte_memcpy(void *dst, const void *src, size_t n) { diff --git a/lib/eal/arm/include/rte_memcpy_64.h b/lib/eal/arm/include/rte_memcpy_64.h index 85ad587bd3..0c86237cc9 100644 --- a/lib/eal/arm/include/rte_memcpy_64.h +++ b/lib/eal/arm/include/rte_memcpy_64.h @@ -282,6 +282,9 @@ void rte_memcpy_ge64(uint8_t *dst, const uint8_t *src, size_t n) } #if RTE_CACHE_LINE_SIZE >= 128 +__rte_nonnull_params(1, 2) +__rte_write_only_param(1, 3) +__rte_read_only_param(2, 3) static __rte_always_inline void *rte_memcpy(void *dst, const void *src, size_t n) { @@ -303,6 +306,9 @@ void *rte_memcpy(void *dst, const void *src, size_t n) } #else +__rte_nonnull_params(1, 2) +__rte_write_only_param(1, 3) +__rte_read_only_param(2, 3) static __rte_always_inline void *rte_memcpy(void *dst, const void *src, size_t n) { diff --git a/lib/eal/include/rte_common.h b/lib/eal/include/rte_common.h index 15765b408d..c9cd2c7496 100644 --- a/lib/eal/include/rte_common.h +++ b/lib/eal/include/rte_common.h @@ -149,6 +149,82 @@ typedef uint16_t unaligned_uint16_t; __attribute__((format(printf, format_index, first_arg))) #endif +/** + * Tells compiler that the pointer arguments must be non-null. + * + * @param ... + * Comma separated list of parameter indexes of pointer arguments. + */ +#if defined(RTE_CC_GCC) || defined(RTE_CC_CLANG) +#define __rte_nonnull_params(...) \ + __attribute__((nonnull(__VA_ARGS__))) +#else +#define __rte_nonnull_params(...) +#endif + +/** + * Tells compiler that the memory pointed to by a pointer argument + * is only read, not written to, by the function. + * It might not be accessed at all. + * + * @param ... + * Parameter index of pointer argument. + * Optionally followeded by comma and parameter index of size argument. + */ +#if defined(RTE_TOOLCHAIN_GCC) && (GCC_VERSION >= 100400) +#define __rte_read_only_param(...) \ + __attribute__((access(read_only, __VA_ARGS__))) +#else +#define __rte_read_only_param(...) +#endif + +/** + * Tells compiler that the memory pointed to by a pointer argument + * is only written to, not read, by the function. + * It might not be accessed at all. + * + * @param ... + * Parameter index of pointer argument. + * Optionally followeded by comma and parameter index of size argument. + */ +#if defined(RTE_TOOLCHAIN_GCC) && (GCC_VERSION >= 100400) +#define __rte_write_only_param(...) \ + __attribute__((access(write_only, __VA_ARGS__))) +#else +#define __rte_write_only_param(...) +#endif + +/** + * Tells compiler that the memory pointed to by a pointer argument + * is both read and written to by the function. + * It might not be read, written to, or accessed at all. + * + * @param ... + * Parameter index of pointer argument. + * Optionally followeded by comma and parameter index of size argument. + */ +#if defined(RTE_TOOLCHAIN_GCC) && (GCC_VERSION >= 100400) +#define __rte_read_write_param(...) \ + __attribute__((access(read_write, __VA_ARGS__))) +#else +#define __rte_read_write_param(...) +#endif + +/** + * Tells compiler that the memory pointed to by a pointer argument + * is not accessed by the function. + * + * @param ... + * Parameter index of pointer argument. + * Optionally followeded by comma and parameter index of size argument. + */ +#if defined(RTE_TOOLCHAIN_GCC) && (GCC_VERSION >= 100400) +#define __rte_no_access_param(...) \ + __attribute__((access(none, __VA_ARGS__))) +#else +#define __rte_no_access_param(...) +#endif + /** * Tells compiler that the function returns a value that points to * memory, where the size is given by the one or two arguments. diff --git a/lib/eal/ppc/include/rte_memcpy.h b/lib/eal/ppc/include/rte_memcpy.h index 6f388c0234..c36869a414 100644 --- a/lib/eal/ppc/include/rte_memcpy.h +++ b/lib/eal/ppc/include/rte_memcpy.h @@ -84,6 +84,9 @@ rte_mov256(uint8_t *dst, const uint8_t *src) memcpy((dst), (src), (n)) : \ rte_memcpy_func((dst), (src), (n)); }) +__rte_nonnull_params(1, 2) +__rte_write_only_param(1, 3) +__rte_read_only_param(2, 3) static inline void * rte_memcpy_func(void *dst, const void *src, size_t n) { diff --git a/lib/eal/x86/include/rte_memcpy.h b/lib/eal/x86/include/rte_memcpy.h index d4d7a5cfc8..ee543aa37d 100644 --- a/lib/eal/x86/include/rte_memcpy.h +++ b/lib/eal/x86/include/rte_memcpy.h @@ -42,6 +42,9 @@ extern "C" { * @return * Pointer to the destination data. */ +__rte_nonnull_params(1, 2) +__rte_write_only_param(1, 3) +__rte_read_only_param(2, 3) static __rte_always_inline void * rte_memcpy(void *dst, const void *src, size_t n); @@ -859,6 +862,9 @@ rte_memcpy_aligned(void *dst, const void *src, size_t n) return ret; } +__rte_nonnull_params(1, 2) +__rte_write_only_param(1, 3) +__rte_read_only_param(2, 3) static __rte_always_inline void * rte_memcpy(void *dst, const void *src, size_t n) {