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 5DAEBA04FD; Wed, 28 Dec 2022 11:27:12 +0100 (CET) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 052BC40FDF; Wed, 28 Dec 2022 11:27:12 +0100 (CET) Received: from smartserver.smartsharesystems.com (smartserver.smartsharesystems.com [77.243.40.215]) by mails.dpdk.org (Postfix) with ESMTP id 5460D40141 for ; Wed, 28 Dec 2022 11:27:10 +0100 (CET) Received: from dkrd2.smartsharesys.local ([192.168.4.12]) by smartserver.smartsharesystems.com with Microsoft SMTPSVC(6.0.3790.4675); Wed, 28 Dec 2022 11:27:09 +0100 From: =?UTF-8?q?Morten=20Br=C3=B8rup?= To: dev@dpdk.org, roretzla@linux.microsoft.com, rmody@marvell.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=20Br=C3=B8rup?= Subject: [PATCH v3 1/2] eal: add nonnull and access function attributes Date: Wed, 28 Dec 2022 11:27:07 +0100 Message-Id: <20221228102708.93208-1-mb@smartsharesystems.com> X-Mailer: git-send-email 2.17.1 In-Reply-To: <20221202153432.131023-1-mb@smartsharesystems.com> References: <20221202153432.131023-1-mb@smartsharesystems.com> MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-OriginalArrivalTime: 28 Dec 2022 10:27:09.0880 (UTC) FILETIME=[F1440380:01D91AA6] 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 attribute to tell the compiler how a function accesses its pointer arguments. Add these attributes to the rte_memcpy() function, as the first in hopefully many to come. 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. Signed-off-by: Morten Brørup Acked-by: Tyler Retzlaff Reviewed-by: Ruifeng Wang --- lib/eal/arm/include/rte_memcpy_32.h | 8 ++++++++ lib/eal/arm/include/rte_memcpy_64.h | 6 ++++++ lib/eal/include/rte_common.h | 29 +++++++++++++++++++++++++++++ lib/eal/ppc/include/rte_memcpy.h | 3 +++ lib/eal/x86/include/rte_memcpy.h | 6 ++++++ 5 files changed, 52 insertions(+) diff --git a/lib/eal/arm/include/rte_memcpy_32.h b/lib/eal/arm/include/rte_memcpy_32.h index fb3245b59c..f454c06eca 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_access_param(write_only, 1, 3) +__rte_access_param(read_only, 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_access_param(write_only, 1, 3) +__rte_access_param(read_only, 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..55cbe07733 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_access_param(write_only, 1, 3) +__rte_access_param(read_only, 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_access_param(write_only, 1, 3) +__rte_access_param(read_only, 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..6e4011aa85 100644 --- a/lib/eal/include/rte_common.h +++ b/lib/eal/include/rte_common.h @@ -149,6 +149,35 @@ typedef uint16_t unaligned_uint16_t; __attribute__((format(printf, format_index, first_arg))) #endif +/** + * Check pointer arguments at compile-time. + * + * @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 about the access mode of a pointer argument. + * + * @param access_mode + * Access mode: read_only, read_write, write_only, or none. + * @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_access_param(access_mode, ...) \ + __attribute__((access(access_mode, __VA_ARGS__))) +#else +#define __rte_access_param(access_mode, ...) +#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..59a5d86948 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_access_param(write_only, 1, 3) +__rte_access_param(read_only, 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..2e7161e4e7 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_access_param(write_only, 1, 3) +__rte_access_param(read_only, 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_access_param(write_only, 1, 3) +__rte_access_param(read_only, 2, 3) static __rte_always_inline void * rte_memcpy(void *dst, const void *src, size_t n) { -- 2.17.1