From nobody Mon Apr 13 15:49:05 2026 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id A152CC433FE for ; Mon, 14 Nov 2022 07:53:49 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S236126AbiKNHxs (ORCPT ); Mon, 14 Nov 2022 02:53:48 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:46898 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S236077AbiKNHxQ (ORCPT ); Mon, 14 Nov 2022 02:53:16 -0500 Received: from mail-pg1-x54a.google.com (mail-pg1-x54a.google.com [IPv6:2607:f8b0:4864:20::54a]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 3BB79192B8 for ; Sun, 13 Nov 2022 23:53:15 -0800 (PST) Received: by mail-pg1-x54a.google.com with SMTP id f132-20020a636a8a000000b00473d0b600ebso5512795pgc.14 for ; Sun, 13 Nov 2022 23:53:15 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20210112; h=cc:to:from:subject:references:mime-version:message-id:in-reply-to :date:from:to:cc:subject:date:message-id:reply-to; bh=nAX60ecFtxgT+PDunRPYKAFBfhjC2kUCNn7e5xMw2JM=; b=buGqKnielvJwFkIZh5KnRlsCoQyiK3G1y/CNoBamUlBH5JV/Cifos89LeN123Ozmac axidpKkzBNDMZ8jNK7z1suD0cOyTqRSvsrcCILT79EzFnqwxip2ae74Mlq8BrSo5jcwI ZHsi2k1DudB15Aq/+cBACKSzIpjYKCt1MZhizZtuANMRZQSjSFNX2kXH3V5nt/FghEj0 0WtRXgCbXKB+dwW9AxCJ/auGvTPBaEuNNNOgef9BYRY+5k6D1JQR5IzBwWEyJleInXvN jGjbQacFrVPHuduF3QhjeeQ5//PL3CFx/FQKlLU6I300gDhM/XAo/zWD9s/g4v+GNg2z qH1Q== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=cc:to:from:subject:references:mime-version:message-id:in-reply-to :date:x-gm-message-state:from:to:cc:subject:date:message-id:reply-to; bh=nAX60ecFtxgT+PDunRPYKAFBfhjC2kUCNn7e5xMw2JM=; b=ix7TlGg6BA4rmAxoE6jLS2NpG05Ms5fz+fGn8/+NJAOJJRh1BLsr8A/tdnW3KUe3v4 uwBz5G4EY31gSxRyu1Hewihhob7eiGAkBMmwHbjgPUFVj76G7cIrv9c+6M08o8WNmaSh EEpSFdsOZZp+NkcXlZDJmwXsE939KWzVmrpTCMVPzZMSLwacO2pRkLbfxY2iOi+ZHQJr SEd7U2UKV6m5qqbMTELzWTiZzie/xt5i1jcaB6eMgry8QQlWJ67QOIpyICojCcqCdBIn dv22YG//qSwYXsvjK5WPzaQBskxtt4q2Tww1Z6kCB7CCavf7sBbhstDbtBXcp1/oHIte Pnlg== X-Gm-Message-State: ANoB5pn52nA4SOEEbhWSugn/mJvAV3Fy29I3q4SYw6kUGHVbsQr8/fyM UPXxkRD0SILK+POmw2NmDEwoK+w2TobX X-Google-Smtp-Source: AA0mqf5LtZ/I3nyYUy9i7XP06eUtsBJJ2jH8YLuDJ+643JLOqdp4Fpwgv/Ycvqsz8UGnevFML5okx/OFKn5q X-Received: from irogers.svl.corp.google.com ([2620:15c:2d4:203:cba6:8279:98e6:3d6e]) (user=irogers job=sendgmr) by 2002:a62:442:0:b0:562:86a3:12fc with SMTP id 63-20020a620442000000b0056286a312fcmr13130193pfe.8.1668412394679; Sun, 13 Nov 2022 23:53:14 -0800 (PST) Date: Sun, 13 Nov 2022 23:51:27 -0800 In-Reply-To: <20221114075127.2650315-1-irogers@google.com> Message-Id: <20221114075127.2650315-10-irogers@google.com> Mime-Version: 1.0 References: <20221114075127.2650315-1-irogers@google.com> X-Mailer: git-send-email 2.38.1.431.g37b22c650d-goog Subject: [PATCH v1 9/9] perf list: Add json output option From: Ian Rogers To: Weilin Wang , Perry Taylor , Caleb Biggers , Leo Yan , Adrian Hunter , Peter Zijlstra , Ingo Molnar , Arnaldo Carvalho de Melo , Mark Rutland , Alexander Shishkin , Jiri Olsa , Namhyung Kim , Sandipan Das , Kajol Jain , Zhengjun Xing , Kan Liang , Ravi Bangoria , Xin Gao , Rob Herring , linux-kernel@vger.kernel.org, linux-perf-users@vger.kernel.org Cc: Stephane Eranian , Ian Rogers Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset="utf-8" Output events and metrics in a json format by overriding the print callbacks. Currently other command line options aren't supported and metrics are repeated once per metric group. Signed-off-by: Ian Rogers --- tools/perf/Documentation/perf-list.txt | 4 + tools/perf/builtin-list.c | 283 ++++++++++++++++++++----- 2 files changed, 229 insertions(+), 58 deletions(-) diff --git a/tools/perf/Documentation/perf-list.txt b/tools/perf/Documentat= ion/perf-list.txt index 44a819af573d..43263ca88ff7 100644 --- a/tools/perf/Documentation/perf-list.txt +++ b/tools/perf/Documentation/perf-list.txt @@ -43,6 +43,10 @@ Print deprecated events. By default the deprecated event= s are hidden. Print PMU events and metrics limited to the specific PMU name. (e.g. --unit cpu, --unit msr, --unit cpu_core, --unit cpu_atom) =20 +-j:: +--json:: +Output in json format. + [[EVENT_MODIFIERS]] EVENT MODIFIERS --------------- diff --git a/tools/perf/builtin-list.c b/tools/perf/builtin-list.c index 91e2b6f52548..910b5c3a7365 100644 --- a/tools/perf/builtin-list.c +++ b/tools/perf/builtin-list.c @@ -19,6 +19,7 @@ #include "util/strlist.h" #include #include +#include #include =20 struct print_state { @@ -217,10 +218,165 @@ static void default_print_metric(void *ps, } } =20 +struct json_print_state { + /** Should a separator be printed prior to the next item? */ + bool need_sep; +}; + +static void json_print_start(void *print_state __maybe_unused) +{ + printf("[\n"); +} + +static void json_print_end(void *ps) +{ + struct json_print_state *print_state =3D ps; + + printf("%s]\n", print_state->need_sep ? "\n" : ""); +} + +static void fix_escape_printf(const char *fmt, ...) +{ + va_list args; + char buf[2048]; + size_t buf_pos =3D 0; + + va_start(args, fmt); + for (size_t fmt_pos =3D 0; fmt_pos < strlen(fmt); fmt_pos++) { + switch (fmt[fmt_pos]) { + case '%': { + const char *s =3D va_arg(args, const char*); + + fmt_pos++; + assert(fmt[fmt_pos] =3D=3D 's'); + for (size_t s_pos =3D 0; s_pos < strlen(s); s_pos++) { + switch (s[s_pos]) { + case '\\': + __fallthrough; + case '\"': + buf[buf_pos++] =3D '\\'; + assert(buf_pos < sizeof(buf)); + __fallthrough; + default: + buf[buf_pos++] =3D s[s_pos]; + assert(buf_pos < sizeof(buf)); + break; + } + } + break; + } + default: + buf[buf_pos++] =3D fmt[fmt_pos]; + assert(buf_pos < sizeof(buf)); + break; + } + } + va_end(args); + buf[buf_pos] =3D '\0'; + fputs(buf, stdout); +} + +static void json_print_event(void *ps, const char *pmu_name, const char *t= opic, + const char *event_name, const char *event_alias, + bool deprecated, const char *event_type_desc, + const char *desc, const char *long_desc, + const char *encoding_desc, + const char *metric_name, const char *metric_expr) +{ + struct json_print_state *print_state =3D ps; + bool need_sep =3D false; + + printf("%s{\n", print_state->need_sep ? ",\n" : ""); + print_state->need_sep =3D true; + if (pmu_name) { + fix_escape_printf("\t\"Unit\": \"%s\"", pmu_name); + need_sep =3D true; + } + if (topic) { + fix_escape_printf("%s\t\"Topic\": \"%s\"", need_sep ? ",\n" : "", topic); + need_sep =3D true; + } + if (event_name) { + fix_escape_printf("%s\t\"EventName\": \"%s\"", need_sep ? ",\n" : "", ev= ent_name); + need_sep =3D true; + } + if (event_alias && strlen(event_alias)) { + fix_escape_printf("%s\t\"EventAlias\": \"%s\"", need_sep ? ",\n" : "", e= vent_alias); + need_sep =3D true; + } + if (event_type_desc) { + fix_escape_printf("%s\t\"EventType\": \"%s\"", need_sep ? ",\n" : "", + event_type_desc); + need_sep =3D true; + } + if (deprecated) { + fix_escape_printf("%s\t\"Deprecated\": \"%s\"", need_sep ? ",\n" : "", + deprecated ? "1" : "0"); + need_sep =3D true; + } + if (desc) { + fix_escape_printf("%s\t\"BriefDescription\": \"%s\"", need_sep ? ",\n" := "", desc); + need_sep =3D true; + } + if (long_desc) { + fix_escape_printf("%s\t\"PublicDescription\": \"%s\"", need_sep ? ",\n" = : "", + long_desc); + need_sep =3D true; + } + if (encoding_desc) { + fix_escape_printf("%s\t\"Encoding\": \"%s\"", need_sep ? ",\n" : "", enc= oding_desc); + need_sep =3D true; + } + if (metric_name) { + fix_escape_printf("%s\t\"MetricName\": \"%s\"", need_sep ? ",\n" : "", m= etric_name); + need_sep =3D true; + } + if (metric_expr) { + fix_escape_printf("%s\t\"MetricExpr\": \"%s\"", need_sep ? ",\n" : "", m= etric_expr); + need_sep =3D true; + } + printf("%s}", need_sep ? "\n" : ""); +} + +static void json_print_metric(void *ps __maybe_unused, const char *group, + const char *name, const char *desc, + const char *long_desc, const char *expr) +{ + struct json_print_state *print_state =3D ps; + bool need_sep =3D false; + + printf("%s{\n", print_state->need_sep ? ",\n" : ""); + print_state->need_sep =3D true; + if (group) { + fix_escape_printf("\t\"MetricGroup\": \"%s\"", group); + need_sep =3D true; + } + if (name) { + fix_escape_printf("%s\t\"MetricName\": \"%s\"", need_sep ? ",\n" : "", n= ame); + need_sep =3D true; + } + if (expr) { + fix_escape_printf("%s\t\"MetricExpr\": \"%s\"", need_sep ? ",\n" : "", e= xpr); + need_sep =3D true; + } + if (desc) { + fix_escape_printf("%s\t\"BriefDescription\": \"%s\"", need_sep ? ",\n" := "", desc); + need_sep =3D true; + } + if (long_desc) { + fix_escape_printf("%s\t\"PublicDescription\": \"%s\"", need_sep ? ",\n" = : "", + long_desc); + need_sep =3D true; + } + printf("%s}", need_sep ? "\n" : ""); +} + int cmd_list(int argc, const char **argv) { int i, ret =3D 0; - struct print_state ps =3D {}; + struct print_state default_ps =3D {}; + struct print_state json_ps =3D {}; + void *ps =3D &default_ps; struct print_callbacks print_cb =3D { .print_start =3D default_print_start, .print_end =3D default_print_end, @@ -229,15 +385,17 @@ int cmd_list(int argc, const char **argv) }; const char *hybrid_name =3D NULL; const char *unit_name =3D NULL; + bool json =3D false; struct option list_options[] =3D { - OPT_BOOLEAN(0, "raw-dump", &ps.name_only, "Dump raw events"), - OPT_BOOLEAN('d', "desc", &ps.desc, + OPT_BOOLEAN(0, "raw-dump", &default_ps.name_only, "Dump raw events"), + OPT_BOOLEAN('j', "json", &json, "JSON encode events and metrics"), + OPT_BOOLEAN('d', "desc", &default_ps.desc, "Print extra event descriptions. --no-desc to not print."), - OPT_BOOLEAN('v', "long-desc", &ps.long_desc, + OPT_BOOLEAN('v', "long-desc", &default_ps.long_desc, "Print longer event descriptions."), - OPT_BOOLEAN(0, "details", &ps.detailed, + OPT_BOOLEAN(0, "details", &default_ps.detailed, "Print information on the perf event names and expressions used int= ernally by events."), - OPT_BOOLEAN(0, "deprecated", &ps.deprecated, + OPT_BOOLEAN(0, "deprecated", &default_ps.deprecated, "Print deprecated events."), OPT_STRING(0, "cputype", &hybrid_name, "hybrid cpu type", "Limit PMU or metric printing to the given hybrid PMU (e.g. core or = atom)."), @@ -261,28 +419,37 @@ int cmd_list(int argc, const char **argv) =20 setup_pager(); =20 - if (!ps.name_only) + if (!default_ps.name_only) setup_pager(); =20 - ps.desc =3D !ps.long_desc; - ps.last_topic =3D strdup(""); - assert(ps.last_topic); - ps.visited_metrics =3D strlist__new(NULL, NULL); - assert(ps.visited_metrics); - if (unit_name) - ps.pmu_glob =3D strdup(unit_name); - else if (hybrid_name) { - ps.pmu_glob =3D perf_pmu__hybrid_type_to_pmu(hybrid_name); - if (!ps.pmu_glob) - pr_warning("WARNING: hybrid cputype is not supported!\n"); + if (json) { + print_cb =3D (struct print_callbacks){ + .print_start =3D json_print_start, + .print_end =3D json_print_end, + .print_event =3D json_print_event, + .print_metric =3D json_print_metric, + }; + ps =3D &json_ps; + } else { + default_ps.desc =3D !default_ps.long_desc; + default_ps.last_topic =3D strdup(""); + assert(default_ps.last_topic); + default_ps.visited_metrics =3D strlist__new(NULL, NULL); + assert(default_ps.visited_metrics); + if (unit_name) + default_ps.pmu_glob =3D strdup(unit_name); + else if (hybrid_name) { + default_ps.pmu_glob =3D perf_pmu__hybrid_type_to_pmu(hybrid_name); + if (!default_ps.pmu_glob) + pr_warning("WARNING: hybrid cputype is not supported!\n"); + } } - print_cb.print_start(&ps); =20 if (argc =3D=3D 0) { - ps.metrics =3D true; - ps.metricgroups =3D true; - print_events(&print_cb, &ps); + default_ps.metrics =3D true; + default_ps.metricgroups =3D true; + print_events(&print_cb, ps); goto out; } =20 @@ -290,32 +457,32 @@ int cmd_list(int argc, const char **argv) char *sep, *s; =20 if (strcmp(argv[i], "tracepoint") =3D=3D 0) - print_tracepoint_events(&print_cb, &ps); + print_tracepoint_events(&print_cb, ps); else if (strcmp(argv[i], "hw") =3D=3D 0 || strcmp(argv[i], "hardware") =3D=3D 0) - print_symbol_events(&print_cb, &ps, PERF_TYPE_HARDWARE, + print_symbol_events(&print_cb, ps, PERF_TYPE_HARDWARE, event_symbols_hw, PERF_COUNT_HW_MAX); else if (strcmp(argv[i], "sw") =3D=3D 0 || strcmp(argv[i], "software") =3D=3D 0) { - print_symbol_events(&print_cb, &ps, PERF_TYPE_SOFTWARE, + print_symbol_events(&print_cb, ps, PERF_TYPE_SOFTWARE, event_symbols_sw, PERF_COUNT_SW_MAX); - print_tool_events(&print_cb, &ps); + print_tool_events(&print_cb, ps); } else if (strcmp(argv[i], "cache") =3D=3D 0 || strcmp(argv[i], "hwcache") =3D=3D 0) - print_hwcache_events(&print_cb, &ps); + print_hwcache_events(&print_cb, ps); else if (strcmp(argv[i], "pmu") =3D=3D 0) - print_pmu_events(&print_cb, &ps); + print_pmu_events(&print_cb, ps); else if (strcmp(argv[i], "sdt") =3D=3D 0) - print_sdt_events(&print_cb, &ps); + print_sdt_events(&print_cb, ps); else if (strcmp(argv[i], "metric") =3D=3D 0 || strcmp(argv[i], "metrics"= ) =3D=3D 0) { - ps.metricgroups =3D false; - ps.metrics =3D true; - metricgroup__print(&print_cb, &ps); + default_ps.metricgroups =3D false; + default_ps.metrics =3D true; + metricgroup__print(&print_cb, ps); } else if (strcmp(argv[i], "metricgroup") =3D=3D 0 || strcmp(argv[i], "metricgroups") =3D=3D 0) { - ps.metricgroups =3D true; - ps.metrics =3D false; - metricgroup__print(&print_cb, &ps); + default_ps.metricgroups =3D true; + default_ps.metrics =3D false; + metricgroup__print(&print_cb, ps); } else if ((sep =3D strchr(argv[i], ':')) !=3D NULL) { int sep_idx; =20 @@ -327,41 +494,41 @@ int cmd_list(int argc, const char **argv) } =20 s[sep_idx] =3D '\0'; - ps.pmu_glob =3D s; - ps.event_glob =3D s + sep_idx + 1; - print_tracepoint_events(&print_cb, &ps); - print_sdt_events(&print_cb, &ps); - ps.metrics =3D true; - ps.metricgroups =3D true; - metricgroup__print(&print_cb, &ps); + default_ps.pmu_glob =3D s; + default_ps.event_glob =3D s + sep_idx + 1; + print_tracepoint_events(&print_cb, ps); + print_sdt_events(&print_cb, ps); + default_ps.metrics =3D true; + default_ps.metricgroups =3D true; + metricgroup__print(&print_cb, ps); free(s); } else { if (asprintf(&s, "*%s*", argv[i]) < 0) { printf("Critical: Not enough memory! Trying to continue...\n"); continue; } - ps.event_glob =3D s; - print_symbol_events(&print_cb, &ps, PERF_TYPE_HARDWARE, + default_ps.event_glob =3D s; + print_symbol_events(&print_cb, ps, PERF_TYPE_HARDWARE, event_symbols_hw, PERF_COUNT_HW_MAX); - print_symbol_events(&print_cb, &ps, PERF_TYPE_SOFTWARE, + print_symbol_events(&print_cb, ps, PERF_TYPE_SOFTWARE, event_symbols_sw, PERF_COUNT_SW_MAX); - print_tool_events(&print_cb, &ps); - print_hwcache_events(&print_cb, &ps); - print_pmu_events(&print_cb, &ps); - print_tracepoint_events(&print_cb, &ps); - print_sdt_events(&print_cb, &ps); - ps.metrics =3D true; - ps.metricgroups =3D true; - metricgroup__print(&print_cb, &ps); + print_tool_events(&print_cb, ps); + print_hwcache_events(&print_cb, ps); + print_pmu_events(&print_cb, ps); + print_tracepoint_events(&print_cb, ps); + print_sdt_events(&print_cb, ps); + default_ps.metrics =3D true; + default_ps.metricgroups =3D true; + metricgroup__print(&print_cb, ps); free(s); } } =20 out: - print_cb.print_end(&ps); - free(ps.pmu_glob); - free(ps.last_topic); - free(ps.last_metricgroups); - strlist__delete(ps.visited_metrics); + print_cb.print_end(ps); + free(default_ps.pmu_glob); + free(default_ps.last_topic); + free(default_ps.last_metricgroups); + strlist__delete(default_ps.visited_metrics); return ret; } --=20 2.38.1.431.g37b22c650d-goog