From patchwork Mon Oct 7 11:46:01 2024 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: 145299 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 B5CD845AD7; Mon, 7 Oct 2024 13:46:09 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 8E9DB402EA; Mon, 7 Oct 2024 13:46:09 +0200 (CEST) Received: from dkmailrelay1.smartsharesystems.com (smartserver.smartsharesystems.com [77.243.40.215]) by mails.dpdk.org (Postfix) with ESMTP id E1DD54026C for ; Mon, 7 Oct 2024 13:46:08 +0200 (CEST) Received: from smartserver.smartsharesystems.com (smartserver.smartsharesys.local [192.168.4.10]) by dkmailrelay1.smartsharesystems.com (Postfix) with ESMTP id 77BE420AD7; Mon, 7 Oct 2024 13:46:08 +0200 (CEST) Received: from dkrd4.smartsharesys.local ([192.168.4.26]) by smartserver.smartsharesystems.com with Microsoft SMTPSVC(6.0.3790.4675); Mon, 7 Oct 2024 13:46:08 +0200 From: =?utf-8?q?Morten_Br=C3=B8rup?= To: Jerin Jacob , Sunil Kumar Kori Cc: dev@dpdk.org, =?utf-8?q?Morten_Br=C3=B8rup?= , Stephen Hemminger Subject: [PATCH v9] eal: add build-time option to omit trace Date: Mon, 7 Oct 2024 11:46:01 +0000 Message-ID: <20241007114601.2921507-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 X-OriginalArrivalTime: 07 Oct 2024 11:46:08.0240 (UTC) FILETIME=[7FA41F00:01DB18AE] 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. Furthermore, a public function to determine if trace is build time enabled is added; mainly for the benefit of the dpdk-test application. Signed-off-by: Morten Brørup Acked-by: Stephen Hemminger Acked-by: Jerin Jacob Tested-by: Morten Brørup --- v9: * Assume library and application are built with same rte_config.h. * Renamed internal function __rte_trace_point_generic_is_enabled() to rte_trace_feature_is_enabled(), which is public. (Jerin Jacob) * Removed changes that became superfluous with the above change. v8: * Added Stephen's Ack to v4, forgot to carry over. v7: * Updated version.map to not export __rte_trace_feature_is_enabled for Windows target. v6: * Removed test_trace_perf.c changes; they don't compile for Windows target, and are superfluous. v5: * Added public function rte_trace_feature_is_enabled(), to test if trace is build time enabled in both the DPDK and the application. Use in test application instead of private function. (Jerin Jacob) v4: * Added check for generic trace enabled when registering trace points, in RTE_INIT. (Jerin Jacob) * Test application uses function instead of macro to check if generic trace is enabled. (Jerin Jacob) * Performance test application uses function to check if generic trace is enabled. 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 | 4 ++++ config/rte_config.h | 1 + lib/eal/include/rte_trace.h | 19 +++++++++++++++++++ lib/eal/include/rte_trace_point.h | 3 +++ lib/eal/include/rte_trace_point_register.h | 2 ++ 5 files changed, 29 insertions(+) diff --git a/app/test/test_trace.c b/app/test/test_trace.c index 00809f433b..8ea1443044 100644 --- a/app/test/test_trace.c +++ b/app/test/test_trace.c @@ -245,6 +245,10 @@ static struct unit_test_suite trace_tests = { static int test_trace(void) { + if (!rte_trace_feature_is_enabled()) { + printf("Trace omitted at build-time, skipping test\n"); + return TEST_SKIPPED; + } return unit_test_suite_runner(&trace_tests); } 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.h b/lib/eal/include/rte_trace.h index a6e991fad3..6eac95188b 100644 --- a/lib/eal/include/rte_trace.h +++ b/lib/eal/include/rte_trace.h @@ -35,6 +35,25 @@ extern "C" { __rte_experimental bool rte_trace_is_enabled(void); +/** + * @warning + * @b EXPERIMENTAL: this API may change, or be removed, without prior notice + * + * Test if trace feature is enabled at compile time. + * + * @return + * true if trace feature is enabled, false otherwise. + */ +static __rte_always_inline +bool rte_trace_feature_is_enabled(void) +{ +#ifdef RTE_TRACE + return true; +#else + return false; +#endif +} + /** * Enumerate trace mode operation. */ diff --git a/lib/eal/include/rte_trace_point.h b/lib/eal/include/rte_trace_point.h index 41e2a7f99e..dfe89302ed 100644 --- a/lib/eal/include/rte_trace_point.h +++ b/lib/eal/include/rte_trace_point.h @@ -30,6 +30,7 @@ extern "C" { #include #include #include +#include #include /** The tracepoint object. */ @@ -359,6 +360,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_feature_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; \ diff --git a/lib/eal/include/rte_trace_point_register.h b/lib/eal/include/rte_trace_point_register.h index 41260e5964..283dcef75d 100644 --- a/lib/eal/include/rte_trace_point_register.h +++ b/lib/eal/include/rte_trace_point_register.h @@ -23,6 +23,8 @@ rte_trace_point_t __rte_section("__rte_trace_point") __##trace; \ static const char __##trace##_name[] = RTE_STR(name); \ RTE_INIT(trace##_init) \ { \ + if (!rte_trace_feature_is_enabled()) \ + return; \ __rte_trace_point_register(&__##trace, __##trace##_name, \ (void (*)(void)) trace); \ }