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 4FB0245D31; Mon, 18 Nov 2024 08:37:50 +0100 (CET) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 59C5740E31; Mon, 18 Nov 2024 08:37:38 +0100 (CET) Received: from mx0b-0016f401.pphosted.com (mx0a-0016f401.pphosted.com [67.231.148.174]) by mails.dpdk.org (Postfix) with ESMTP id 8E81340DDE for ; Mon, 18 Nov 2024 08:37:36 +0100 (CET) Received: from pps.filterd (m0045849.ppops.net [127.0.0.1]) by mx0a-0016f401.pphosted.com (8.18.1.2/8.18.1.2) with ESMTP id 4AI5PObf020157; Sun, 17 Nov 2024 23:37:32 -0800 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=marvell.com; h= cc:content-transfer-encoding:content-type:date:from:in-reply-to :message-id:mime-version:references:subject:to; s=pfpt0220; bh=I k7Sy1rLlKSa97G4jkihrJXfrlR/r+ER1jjHzbvnYtw=; b=ZpV4AwQ9pkGfmm3Nk IlkH1gnWldaeVjGHBOLn0A7XGhNCU+doLID6TKgYHgbMsXPp5PSXk9kedFBfAMkK cqItrrDNQrM73WNe/YUNnXGoJd99bjRaqw4G5Vk8VqyIFcz7Dzf/NpE39IxrnJya 5+eWgvsvNz+LZFgZmLJ+Izjtjnto7aJU0gzR2G1vd97UBcQ/L5I121+yfVAs3nLQ 8bJJOsMj9UY+wmxfbL2tspFGX2nhrO0cE2m1HG0GGlTvurlrH9KpWVRib6AAZmFm gFlquuttOpBN9mj5h0Z2GF/riRl9pCkcqNz4G0/o5O60cLqzlA+vv2g4yQMezHBh cWIPA== Received: from dc6wp-exch02.marvell.com ([4.21.29.225]) by mx0a-0016f401.pphosted.com (PPS) with ESMTPS id 42xsmqtd86-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=NOT); Sun, 17 Nov 2024 23:37:31 -0800 (PST) Received: from DC6WP-EXCH02.marvell.com (10.76.176.209) by DC6WP-EXCH02.marvell.com (10.76.176.209) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.2.1544.4; Sun, 17 Nov 2024 23:37:30 -0800 Received: from maili.marvell.com (10.69.176.80) by DC6WP-EXCH02.marvell.com (10.76.176.209) with Microsoft SMTP Server id 15.2.1544.4 via Frontend Transport; Sun, 17 Nov 2024 23:37:30 -0800 Received: from cavium-optiplex-3070-BM15.. (unknown [10.28.34.39]) by maili.marvell.com (Postfix) with ESMTP id 190CF3F7065; Sun, 17 Nov 2024 23:37:25 -0800 (PST) From: Tomasz Duszynski To: , Jerin Jacob , "Sunil Kumar Kori" , Tyler Retzlaff CC: , , , , , , , , , Subject: [PATCH v16 4/4] eal: add PMU support to tracing library Date: Mon, 18 Nov 2024 08:37:06 +0100 Message-ID: <20241118073706.3129423-5-tduszynski@marvell.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20241118073706.3129423-1-tduszynski@marvell.com> References: <20241025085414.3412068-1-tduszynski@marvell.com> <20241118073706.3129423-1-tduszynski@marvell.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Content-Type: text/plain X-Proofpoint-ORIG-GUID: 3r01SVWUVuGN3pHl_0YSUq-04sA_wpdh X-Proofpoint-GUID: 3r01SVWUVuGN3pHl_0YSUq-04sA_wpdh X-Proofpoint-Virus-Version: vendor=baseguard engine=ICAP:2.0.293,Aquarius:18.0.1039,Hydra:6.0.680,FMLib:17.12.60.29 definitions=2024-09-06_09,2024-09-06_01,2024-09-02_01 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 In order to profile app one needs to store significant amount of samples somewhere for an analysis later on. Since trace library supports storing data in a CTF format lets take advantage of that and add a dedicated PMU tracepoint. Signed-off-by: Tomasz Duszynski --- app/test/test_trace_perf.c | 10 ++++ doc/guides/prog_guide/profile_app.rst | 5 ++ doc/guides/prog_guide/trace_lib.rst | 32 +++++++++++ lib/eal/common/eal_common_trace.c | 5 +- lib/eal/common/eal_common_trace_pmu.c | 38 ++++++++++++++ lib/eal/common/eal_common_trace_points.c | 5 ++ lib/eal/common/eal_trace.h | 4 ++ lib/eal/common/meson.build | 1 + lib/eal/include/rte_eal_trace.h | 11 ++++ lib/eal/version.map | 1 + lib/pmu/rte_pmu.c | 67 +++++++++++++++++++++++- lib/pmu/rte_pmu.h | 24 +++++++-- lib/pmu/version.map | 1 + 13 files changed, 198 insertions(+), 6 deletions(-) create mode 100644 lib/eal/common/eal_common_trace_pmu.c diff --git a/app/test/test_trace_perf.c b/app/test/test_trace_perf.c index 8257cc02be..28f908ce40 100644 --- a/app/test/test_trace_perf.c +++ b/app/test/test_trace_perf.c @@ -114,6 +114,10 @@ worker_fn_##func(void *arg) \ #define GENERIC_DOUBLE rte_eal_trace_generic_double(3.66666) #define GENERIC_STR rte_eal_trace_generic_str("hello world") #define VOID_FP app_dpdk_test_fp() +#ifdef RTE_LIB_PMU +/* 0 corresponds first event passed via --trace= */ +#define READ_PMU rte_pmu_trace_read(0) +#endif WORKER_DEFINE(GENERIC_VOID) WORKER_DEFINE(GENERIC_U64) @@ -122,6 +126,9 @@ WORKER_DEFINE(GENERIC_FLOAT) WORKER_DEFINE(GENERIC_DOUBLE) WORKER_DEFINE(GENERIC_STR) WORKER_DEFINE(VOID_FP) +#ifdef RTE_LIB_PMU +WORKER_DEFINE(READ_PMU) +#endif static void run_test(const char *str, lcore_function_t f, struct test_data *data, size_t sz) @@ -174,6 +181,9 @@ test_trace_perf(void) run_test("double", worker_fn_GENERIC_DOUBLE, data, sz); run_test("string", worker_fn_GENERIC_STR, data, sz); run_test("void_fp", worker_fn_VOID_FP, data, sz); +#ifdef RTE_LIB_PMU + run_test("read_pmu", worker_fn_READ_PMU, data, sz); +#endif rte_free(data); return TEST_SUCCESS; diff --git a/doc/guides/prog_guide/profile_app.rst b/doc/guides/prog_guide/profile_app.rst index ecb90a0d94..8e9cddb652 100644 --- a/doc/guides/prog_guide/profile_app.rst +++ b/doc/guides/prog_guide/profile_app.rst @@ -33,6 +33,11 @@ As of now implementation imposes certain limitations: * Each EAL lcore measures same group of events +Alternatively tracing library can be used which offers dedicated tracepoint +``rte_pmu_trace_read()``. + +Refer to :doc:`../prog_guide/trace_lib` for more details. + Profiling on x86 ---------------- diff --git a/doc/guides/prog_guide/trace_lib.rst b/doc/guides/prog_guide/trace_lib.rst index d9b17abe90..1cbfd42656 100644 --- a/doc/guides/prog_guide/trace_lib.rst +++ b/doc/guides/prog_guide/trace_lib.rst @@ -46,6 +46,7 @@ DPDK tracing library features trace format and is compatible with ``LTTng``. For detailed information, refer to `Common Trace Format `_. +- Support reading PMU events on ARM64 and x86-64 (Intel) How to add a tracepoint? ------------------------ @@ -139,6 +140,37 @@ the user must use ``RTE_TRACE_POINT_FP`` instead of ``RTE_TRACE_POINT``. ``RTE_TRACE_POINT_FP`` is compiled out by default and it can be enabled using the ``enable_trace_fp`` option for meson build. +PMU tracepoint +-------------- + +Performance monitoring unit (PMU) event values can be read from hardware +registers using predefined ``rte_pmu_read`` tracepoint. + +Tracing is enabled via ``--trace`` EAL option by passing both expression +matching PMU tracepoint name i.e ``lib.eal.pmu.read`` and expression +``e=ev1[,ev2,...]`` matching particular events:: + + --trace='.*pmu.read\|e=cpu_cycles,l1d_cache' + +Event names are available under ``/sys/bus/event_source/devices/PMU/events`` +directory, where ``PMU`` is a placeholder for either a ``cpu`` or a directory +containing ``cpus``. + +In contrary to other tracepoints this does not need any extra variables +added to source files. Instead, caller passes index which follows the order of +events specified via ``--trace`` parameter. In the following example index ``0`` +corresponds to ``cpu_cyclces`` while index ``1`` corresponds to ``l1d_cache``. + +.. code-block:: c + + ... + rte_pmu_trace_read(0); + rte_pmu_trace_read(1); + ... + +PMU tracing support must be explicitly enabled using the ``enable_trace_fp`` +option for meson build. + Event record mode ----------------- diff --git a/lib/eal/common/eal_common_trace.c b/lib/eal/common/eal_common_trace.c index 918f49bf4f..9be8724ec4 100644 --- a/lib/eal/common/eal_common_trace.c +++ b/lib/eal/common/eal_common_trace.c @@ -72,8 +72,10 @@ eal_trace_init(void) goto free_meta; /* Apply global configurations */ - STAILQ_FOREACH(arg, &trace.args, next) + STAILQ_FOREACH(arg, &trace.args, next) { trace_args_apply(arg->val); + trace_pmu_args_apply(arg->val); + } rte_trace_mode_set(trace.mode); @@ -89,6 +91,7 @@ eal_trace_init(void) void eal_trace_fini(void) { + trace_pmu_args_free(); trace_mem_free(); trace_metadata_destroy(); eal_trace_args_free(); diff --git a/lib/eal/common/eal_common_trace_pmu.c b/lib/eal/common/eal_common_trace_pmu.c new file mode 100644 index 0000000000..b3ab41e8a2 --- /dev/null +++ b/lib/eal/common/eal_common_trace_pmu.c @@ -0,0 +1,38 @@ +/* SPDX-License-Identifier: BSD-3-Clause + * Copyright(C) 2024 Marvell International Ltd. + */ + +#include + +#include "eal_trace.h" + +#ifdef RTE_LIB_PMU + +#include + +void +trace_pmu_args_apply(const char *arg) +{ + static bool once; + + if (!once) { + if (rte_pmu_init()) + return; + once = true; + } + + rte_pmu_add_events_by_pattern(arg); +} + +void +trace_pmu_args_free(void) +{ + rte_pmu_fini(); +} + +#else /* !RTE_LIB_PMU */ + +void trace_pmu_args_apply(const char *arg __rte_unused) { return; } +void trace_pmu_args_free(void) { return; } + +#endif /* RTE_LIB_PMU */ diff --git a/lib/eal/common/eal_common_trace_points.c b/lib/eal/common/eal_common_trace_points.c index 0f1240ea3a..25aeb439df 100644 --- a/lib/eal/common/eal_common_trace_points.c +++ b/lib/eal/common/eal_common_trace_points.c @@ -100,3 +100,8 @@ RTE_TRACE_POINT_REGISTER(rte_eal_trace_intr_enable, lib.eal.intr.enable) RTE_TRACE_POINT_REGISTER(rte_eal_trace_intr_disable, lib.eal.intr.disable) + +#if defined(ALLOW_EXPERIMENTAL_API) && defined(RTE_LIB_PMU) +RTE_TRACE_POINT_REGISTER(rte_pmu_trace_read, + lib.pmu.read) +#endif diff --git a/lib/eal/common/eal_trace.h b/lib/eal/common/eal_trace.h index 55262677e0..58fa43472a 100644 --- a/lib/eal/common/eal_trace.h +++ b/lib/eal/common/eal_trace.h @@ -104,6 +104,10 @@ int trace_epoch_time_save(void); void trace_mem_free(void); void trace_mem_per_thread_free(void); +/* PMU wrappers */ +void trace_pmu_args_apply(const char *arg); +void trace_pmu_args_free(void); + /* EAL interface */ int eal_trace_init(void); void eal_trace_fini(void); diff --git a/lib/eal/common/meson.build b/lib/eal/common/meson.build index e273745e93..239c111461 100644 --- a/lib/eal/common/meson.build +++ b/lib/eal/common/meson.build @@ -28,6 +28,7 @@ sources += files( 'eal_common_tailqs.c', 'eal_common_thread.c', 'eal_common_timer.c', + 'eal_common_trace_pmu.c', 'eal_common_trace_points.c', 'eal_common_uuid.c', 'malloc_elem.c', diff --git a/lib/eal/include/rte_eal_trace.h b/lib/eal/include/rte_eal_trace.h index 9ad2112801..774ff9dcb2 100644 --- a/lib/eal/include/rte_eal_trace.h +++ b/lib/eal/include/rte_eal_trace.h @@ -127,6 +127,17 @@ RTE_TRACE_POINT( #define RTE_EAL_TRACE_GENERIC_FUNC rte_eal_trace_generic_func(__func__) +#if defined(ALLOW_EXPERIMENTAL_API) && defined(RTE_LIB_PMU) +#include + +RTE_TRACE_POINT_FP( + rte_pmu_trace_read, + RTE_TRACE_POINT_ARGS(unsigned int index), + uint64_t val = rte_pmu_read(index); + rte_trace_point_emit_u64(val); +) +#endif + #ifdef __cplusplus } #endif diff --git a/lib/eal/version.map b/lib/eal/version.map index a20c713eb1..945414c626 100644 --- a/lib/eal/version.map +++ b/lib/eal/version.map @@ -398,6 +398,7 @@ EXPERIMENTAL { # added in 24.11 rte_bitset_to_str; rte_lcore_var_alloc; + __rte_pmu_trace_read; # WINDOWS_NO_EXPORT }; INTERNAL { diff --git a/lib/pmu/rte_pmu.c b/lib/pmu/rte_pmu.c index dd57961627..b65f08c75b 100644 --- a/lib/pmu/rte_pmu.c +++ b/lib/pmu/rte_pmu.c @@ -412,12 +412,75 @@ rte_pmu_add_event(const char *name) return event->index; } +static int +add_events(const char *pattern) +{ + char *token, *copy; + int ret = 0; + + copy = strdup(pattern); + if (copy == NULL) + return -ENOMEM; + + token = strtok(copy, ","); + while (token) { + ret = rte_pmu_add_event(token); + if (ret < 0) + break; + + token = strtok(NULL, ","); + } + + free(copy); + + return ret >= 0 ? 0 : ret; +} + +int +rte_pmu_add_events_by_pattern(const char *pattern) +{ + regmatch_t rmatch; + char buf[BUFSIZ]; + unsigned int num; + regex_t reg; + int ret; + + /* events are matched against occurrences of e=ev1[,ev2,..] pattern */ + ret = regcomp(®, "e=([_[:alnum:]-],?)+", REG_EXTENDED); + if (ret) { + PMU_LOG(ERR, "Failed to compile event matching regexp"); + return -EINVAL; + } + + for (;;) { + if (regexec(®, pattern, 1, &rmatch, 0)) + break; + + num = rmatch.rm_eo - rmatch.rm_so; + if (num > sizeof(buf)) + num = sizeof(buf); + + /* skip e= pattern prefix */ + memcpy(buf, pattern + rmatch.rm_so + 2, num - 2); + buf[num - 2] = '\0'; + ret = add_events(buf); + if (ret) + break; + + pattern += rmatch.rm_eo; + } + + regfree(®); + + return ret; +} + int rte_pmu_init(void) { int ret; - if (rte_pmu.initialized) + if (rte_pmu.initialized && ++rte_pmu.initialized) return 0; ret = scan_pmus(); @@ -450,7 +513,7 @@ rte_pmu_fini(void) struct rte_pmu_event_group *group; unsigned int i; - if (!rte_pmu.initialized) + if (!rte_pmu.initialized || --rte_pmu.initialized) return; RTE_TAILQ_FOREACH_SAFE(event, &rte_pmu.event_list, next, tmp_event) { diff --git a/lib/pmu/rte_pmu.h b/lib/pmu/rte_pmu.h index e96655e4d2..8c0d087874 100644 --- a/lib/pmu/rte_pmu.h +++ b/lib/pmu/rte_pmu.h @@ -19,7 +19,9 @@ * is required: * * rte_pmu_init() - * rte_pmu_add_event() + * rte_pmu_add_event() [or rte_pmu_add_events_by_pattern()] + * + * Note that if -Denable_trace_fp=True was passed to meson rte_pmu_init() gets called automatically. * * Afterwards all threads can read events by calling rte_pmu_read(). */ @@ -143,7 +145,7 @@ __rte_pmu_enable_group(struct rte_pmu_event_group *group); * @warning * @b EXPERIMENTAL: this API may change without prior notice * - * Initialize PMU library. + * Initialize PMU library. It's safe to call it multiple times. * * @return * 0 in case of success, negative value otherwise. @@ -156,7 +158,9 @@ rte_pmu_init(void); * @warning * @b EXPERIMENTAL: this API may change without prior notice * - * Finalize PMU library. + * Finalize PMU library. Number of calls must match number + * of times rte_pmu_init() was called. Otherwise memory + * won't be freed properly. */ __rte_experimental void @@ -183,6 +187,20 @@ rte_pmu_add_event(const char *name); #define __rte_pmu_read_userpage(pc) ({ RTE_SET_USED(pc); 0; }) #endif +/** + * @warning + * @b EXPERIMENTAL: this API may change without prior notice + * + * Add events matching pattern to the group of enabled events. + * + * @param pattern + * Pattern e=ev1[,ev2,...] matching events, where evX is a placeholder for an event listed under + * /sys/bus/event_source/devices//events. + */ +__rte_experimental +int +rte_pmu_add_events_by_pattern(const char *pattern); + /** * @warning * @b EXPERIMENTAL: this API may change without prior notice diff --git a/lib/pmu/version.map b/lib/pmu/version.map index 566d653fcd..0bdb3e2f48 100644 --- a/lib/pmu/version.map +++ b/lib/pmu/version.map @@ -6,6 +6,7 @@ EXPERIMENTAL { __rte_pmu_read_userpage; rte_pmu; rte_pmu_add_event; + rte_pmu_add_events_by_pattern; rte_pmu_fini; rte_pmu_init; rte_pmu_read; -- 2.34.1