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 78036459E0; Fri, 20 Sep 2024 11:08:36 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 6203043410; Fri, 20 Sep 2024 11:08:36 +0200 (CEST) Received: from dkmailrelay1.smartsharesystems.com (smartserver.smartsharesystems.com [77.243.40.215]) by mails.dpdk.org (Postfix) with ESMTP id 53C4A4340F for ; Fri, 20 Sep 2024 11:08:35 +0200 (CEST) Received: from smartserver.smartsharesystems.com (smartserver.smartsharesys.local [192.168.4.10]) by dkmailrelay1.smartsharesystems.com (Postfix) with ESMTP id 368FC21B3B; Fri, 20 Sep 2024 11:08:35 +0200 (CEST) Received: from dkrd4.smartsharesys.local ([192.168.4.26]) by smartserver.smartsharesystems.com with Microsoft SMTPSVC(6.0.3790.4675); Fri, 20 Sep 2024 11:08:33 +0200 From: =?UTF-8?q?Morten=20Br=C3=B8rup?= To: Jerin Jacob , Sunil Kumar Kori Cc: dev@dpdk.org, =?UTF-8?q?Morten=20Br=C3=B8rup?= Subject: [PATCH v3] eal: add build-time option to omit trace Date: Fri, 20 Sep 2024 09:08:26 +0000 Message-ID: <20240920090826.571755-1-mb@smartsharesystems.com> X-Mailer: git-send-email 2.43.0 In-Reply-To: <20240918085551.231015-1-mb@smartsharesystems.com> References: <20240918085551.231015-1-mb@smartsharesystems.com> MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-OriginalArrivalTime: 20 Sep 2024 09:08:33.0003 (UTC) FILETIME=[AADBB3B0:01DB0B3C] 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 Some applications want to omit the trace feature. Either to reduce the memory footprint, to reduce the exposed attack surface, or for other reasons. This patch adds an option in rte_config.h to include or omit trace in the build. Trace is included by default. Omitting trace works by omitting all trace points. For API and ABI compatibility, the trace feature itself remains. Signed-off-by: Morten Brørup --- v3: * Simpler version with much fewer ifdefs. (Jerin Jacob) v2: * Added/modified macros required for building applications with trace omitted. --- app/test/test_trace.c | 11 ++++++++++- config/rte_config.h | 1 + lib/eal/include/rte_trace_point.h | 21 +++++++++++++++++++++ 3 files changed, 32 insertions(+), 1 deletion(-) diff --git a/app/test/test_trace.c b/app/test/test_trace.c index 00809f433b..7918cc865d 100644 --- a/app/test/test_trace.c +++ b/app/test/test_trace.c @@ -12,7 +12,16 @@ int app_dpdk_test_tp_count; -#ifdef RTE_EXEC_ENV_WINDOWS +#if !defined(RTE_TRACE) + +static int +test_trace(void) +{ + printf("trace omitted at build-time, skipping test\n"); + return TEST_SKIPPED; +} + +#elif defined(RTE_EXEC_ENV_WINDOWS) static int test_trace(void) diff --git a/config/rte_config.h b/config/rte_config.h index dd7bb0d35b..fd6f8a2f1a 100644 --- a/config/rte_config.h +++ b/config/rte_config.h @@ -49,6 +49,7 @@ #define RTE_MAX_TAILQ 32 #define RTE_LOG_DP_LEVEL RTE_LOG_INFO #define RTE_MAX_VFIO_CONTAINERS 64 +#define RTE_TRACE 1 /* bsd module defines */ #define RTE_CONTIGMEM_MAX_NUM_BUFS 64 diff --git a/lib/eal/include/rte_trace_point.h b/lib/eal/include/rte_trace_point.h index 41e2a7f99e..b80688ce89 100644 --- a/lib/eal/include/rte_trace_point.h +++ b/lib/eal/include/rte_trace_point.h @@ -212,6 +212,25 @@ bool rte_trace_point_is_enabled(rte_trace_point_t *tp); __rte_experimental rte_trace_point_t *rte_trace_point_lookup(const char *name); +/** + * @internal + * + * Test if the tracepoint compile-time option is enabled. + * + * @return + * true if tracepoint enabled, false otherwise. + */ +__rte_experimental +static __rte_always_inline bool +__rte_trace_point_generic_is_enabled(void) +{ +#ifdef RTE_TRACE + return true; +#else + return false; +#endif +} + /** * @internal * @@ -359,6 +378,8 @@ __rte_trace_point_emit_ev_header(void *mem, uint64_t in) #define __rte_trace_point_emit_header_generic(t) \ void *mem; \ do { \ + if (!__rte_trace_point_generic_is_enabled()) \ + return; \ const uint64_t val = rte_atomic_load_explicit(t, rte_memory_order_acquire); \ if (likely(!(val & __RTE_TRACE_FIELD_ENABLE_MASK))) \ return; \ -- 2.43.0