From nobody Tue Apr 28 23:22:28 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 005EAC433EF for ; Thu, 26 May 2022 22:45:38 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1349340AbiEZWph (ORCPT ); Thu, 26 May 2022 18:45:37 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:55426 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1349267AbiEZWp0 (ORCPT ); Thu, 26 May 2022 18:45:26 -0400 Received: from mail-yb1-xb49.google.com (mail-yb1-xb49.google.com [IPv6:2607:f8b0:4864:20::b49]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id ABA2CEAD28 for ; Thu, 26 May 2022 15:45:22 -0700 (PDT) Received: by mail-yb1-xb49.google.com with SMTP id i17-20020a259d11000000b0064cd3084085so2731746ybp.9 for ; Thu, 26 May 2022 15:45:22 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20210112; h=date:in-reply-to:message-id:mime-version:references:subject:from:to :cc; bh=AnSyX/Sm99AXliSbWauBigEMtulFecNV4hCuFVa7Ezw=; b=l76Z9Lr2pk9dqCXjKNkAD77DHtysk5WNI/UNbs6mRrAbSFjqAfhddDQrDZIo8BQHoC mVa0kscHX/eAiwRkeMel+n0fLBHWWLJ8EQ3YXfVibSMUTF1r7FmqQhltUCGm87wtDUZ3 aGJ8oB8JdZSknCINvW5vysqhwDN4PuDbVoAvjVwCkVdnZzjT2Qraab4KxxV3kHlmfWHu VKf06k281tw82zZ9OqA3Ezrf7+5X3yKGCxifnoiIrqeiVUOj5S493SiN1swgqcq08ZgX rzq3BBPPR2UGQBS0f+mgm3h8/9QazFdp/89Zitusg+HhIB/u5z+tPykytRqXwff9SVaU fIMA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:date:in-reply-to:message-id:mime-version :references:subject:from:to:cc; bh=AnSyX/Sm99AXliSbWauBigEMtulFecNV4hCuFVa7Ezw=; b=6VIVIDuTtDNKj6itC7CoJx//Ii93lP6ves22jkp2LUh5xkKng85ILyK6M4Lhm59nZi eP069ulj1cI7D67dXJyVBbX2o1/wqnJVY6PtJYgp8cawnU0no7s5cu4HKeihaUkZGkk1 xcwiJlaD/m88FRMDHDeo7MWo4gBNHgHZKf+SQIzlAitVojP+nM7VLgRAQAhYJt3UsTjN /FIOhEUVtVZHKs3wDrK0CPw8KvLZ70OABHTMNL82/txDha8ZsJXVsp1uaTlbvgAt8lRc 6D6rLxZkE5xTPpTWpuE57ydoSR+Lj2N8Ahm5IxkusDyBRb2jPo9KE3tZ5r3VI/ZjCBQ6 E9tg== X-Gm-Message-State: AOAM531aipodLEvtLcrrIiTkyXcsALW1jtOtU/u0jQYsVXnBmfnLMOIC jvDwtrauDjxmy8U3dDXjyv90hwF2I2BH X-Google-Smtp-Source: ABdhPJx7QuyUZ5/OfEgJzIPLNaje7Zdsn2HMqKQsnIK9b97HEoLm+/GigeOmg0mhrez3U2kkSgzM/bxu3mQ9 X-Received: from irogers.svl.corp.google.com ([2620:15c:2cd:202:4b39:e167:e698:7d4]) (user=irogers job=sendgmr) by 2002:a25:41c8:0:b0:65b:1578:e11 with SMTP id o191-20020a2541c8000000b0065b15780e11mr324242yba.262.1653605121214; Thu, 26 May 2022 15:45:21 -0700 (PDT) Date: Thu, 26 May 2022 15:45:14 -0700 In-Reply-To: <20220526224515.4088240-1-irogers@google.com> Message-Id: <20220526224515.4088240-2-irogers@google.com> Mime-Version: 1.0 References: <20220526224515.4088240-1-irogers@google.com> X-Mailer: git-send-email 2.36.1.124.g0e6072fb45-goog Subject: [PATCH v5 1/2] perf stat: Add JSON output option From: Ian Rogers To: Peter Zijlstra , Ingo Molnar , Arnaldo Carvalho de Melo , Mark Rutland , Alexander Shishkin , Jiri Olsa , Namhyung Kim , Kan Liang , Zhengjun Xing , Sandipan Das , Claire Jensen , Alyssa Ross , Like Xu , James Clark , Florian Fischer , linux-kernel@vger.kernel.org, linux-perf-users@vger.kernel.org, Claire Jensen 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" From: Claire Jensen CSV output is tricky to format and column layout changes are susceptible to breaking parsers. New JSON-formatted output has variable names to identify fields that are consistent and informative, making the output parseable. CSV output example: 1.20,msec,task-clock:u,1204272,100.00,0.697,CPUs utilized 0,,context-switches:u,1204272,100.00,0.000,/sec 0,,cpu-migrations:u,1204272,100.00,0.000,/sec 70,,page-faults:u,1204272,100.00,58.126,K/sec JSON output example: {"counter-value" : "3805.723968", "unit" : "msec", "event" : "cpu-clock", "event-runtime" : 3805731510100.00, "pcnt-running" : 100.00, "metric-value" : 4.007571, "metric-unit" : "CPUs utilized"} {"counter-value" : "6166.000000", "unit" : "", "event" : "context-switches", "event-runtime" : 3805723045100.00, "pcnt-running" : 100.00, "metric-value" : 1.620191, "metric-unit" : "K/sec"} {"counter-value" : "466.000000", "unit" : "", "event" : "cpu-migrations", "event-runtime" : 3805727613100.00, "pcnt-running" : 100.00, "metric-value" : 122.447136, "metric-unit" : "/sec"} {"counter-value" : "208.000000", "unit" : "", "event" : "page-faults", "event-runtime" : 3805726799100.00, "pcnt-running" : 100.00, "metric-value" : 54.654516, "metric-unit" : "/sec"} Also added documentation for JSON option. There is some tidy up of CSV code including a potential memory over run in the os.nfields set up. To facilitate this an AGGR_MAX value is added. Signed-off-by: Claire Jensen Signed-off-by: Ian Rogers --- tools/perf/Documentation/perf-stat.txt | 21 ++ tools/perf/builtin-stat.c | 6 + tools/perf/util/stat-display.c | 384 ++++++++++++++++++------- tools/perf/util/stat.c | 1 + tools/perf/util/stat.h | 2 + 5 files changed, 308 insertions(+), 106 deletions(-) diff --git a/tools/perf/Documentation/perf-stat.txt b/tools/perf/Documentat= ion/perf-stat.txt index 8d1cde00b8d6..f9cdfd912b05 100644 --- a/tools/perf/Documentation/perf-stat.txt +++ b/tools/perf/Documentation/perf-stat.txt @@ -570,6 +570,27 @@ Additional metrics may be printed with all earlier fie= lds being empty. =20 include::intel-hybrid.txt[] =20 +JSON FORMAT +----------- + +With -j, perf stat is able to print out a JSON format output +that can be used for parsing. + +- timestamp : optional usec time stamp in fractions of second (with -I) +- optional aggregate options: + - core : core identifier (with --per-core) + - die : die identifier (with --per-die) + - socket : socket identifier (with --per-socket) + - node : node identifier (with --per-node) + - thread : thread identifier (with --per-thread) +- counter-value : counter value +- unit : unit of the counter value or empty +- event : event name +- variance : optional variance if multiple values are collected (with -r) +- runtime : run time of counter +- metric-value : optional metric value +- metric-unit : optional unit of metric + SEE ALSO -------- linkperf:perf-top[1], linkperf:perf-list[1] diff --git a/tools/perf/builtin-stat.c b/tools/perf/builtin-stat.c index 4ce87a8eb7d7..6c7e59440e3a 100644 --- a/tools/perf/builtin-stat.c +++ b/tools/perf/builtin-stat.c @@ -1256,6 +1256,8 @@ static struct option stat_options[] =3D { "Merge identical named hybrid events"), OPT_STRING('x', "field-separator", &stat_config.csv_sep, "separator", "print counts with custom separator"), + OPT_BOOLEAN('j', "json-output", &stat_config.json_output, + "print counts in JSON format"), OPT_CALLBACK('G', "cgroup", &evsel_list, "name", "monitor event in cgroup name only", parse_stat_cgroups), OPT_STRING(0, "for-each-cgroup", &stat_config.cgroup_list, "name", @@ -1442,6 +1444,7 @@ static aggr_cpu_id_get_t aggr_mode__get_aggr(enum agg= r_mode aggr_mode) case AGGR_GLOBAL: case AGGR_THREAD: case AGGR_UNSET: + case AGGR_MAX: default: return NULL; } @@ -1466,6 +1469,7 @@ static aggr_get_id_t aggr_mode__get_id(enum aggr_mode= aggr_mode) case AGGR_GLOBAL: case AGGR_THREAD: case AGGR_UNSET: + case AGGR_MAX: default: return NULL; } @@ -1616,6 +1620,7 @@ static aggr_cpu_id_get_t aggr_mode__get_aggr_file(enu= m aggr_mode aggr_mode) case AGGR_GLOBAL: case AGGR_THREAD: case AGGR_UNSET: + case AGGR_MAX: default: return NULL; } @@ -1636,6 +1641,7 @@ static aggr_get_id_t aggr_mode__get_id_file(enum aggr= _mode aggr_mode) case AGGR_GLOBAL: case AGGR_THREAD: case AGGR_UNSET: + case AGGR_MAX: default: return NULL; } diff --git a/tools/perf/util/stat-display.c b/tools/perf/util/stat-display.c index 606f09b09226..2bbd11446fa9 100644 --- a/tools/perf/util/stat-display.c +++ b/tools/perf/util/stat-display.c @@ -28,15 +28,21 @@ static void print_running(struct perf_stat_config *config, u64 run, u64 ena) { - if (config->csv_output) { - fprintf(config->output, "%s%" PRIu64 "%s%.2f", - config->csv_sep, - run, - config->csv_sep, - ena ? 100.0 * run / ena : 100.0); - } else if (run !=3D ena) { + + double enabled_percent =3D 100; + + if (run !=3D ena) + enabled_percent =3D 100 * run / ena; + if (config->json_output) + fprintf(config->output, + "\"event-runtime\" : %lu, \"pcnt-running\" : %.2f, ", + run, enabled_percent); + else if (config->csv_output) + fprintf(config->output, + "%s%" PRIu64 "%s%.2f", config->csv_sep, + run, config->csv_sep, enabled_percent); + else if (run !=3D ena) fprintf(config->output, " (%.2f%%)", 100.0 * run / ena); - } } =20 static void print_noise_pct(struct perf_stat_config *config, @@ -44,7 +50,9 @@ static void print_noise_pct(struct perf_stat_config *conf= ig, { double pct =3D rel_stddev_stats(total, avg); =20 - if (config->csv_output) + if (config->json_output) + fprintf(config->output, "\"variance\" : %.2f, ", pct); + else if (config->csv_output) fprintf(config->output, "%s%.2f%%", config->csv_sep, pct); else if (pct) fprintf(config->output, " ( +-%6.2f%% )", pct); @@ -66,7 +74,11 @@ static void print_cgroup(struct perf_stat_config *config= , struct evsel *evsel) { if (nr_cgroups) { const char *cgrp_name =3D evsel->cgrp ? evsel->cgrp->name : ""; - fprintf(config->output, "%s%s", config->csv_sep, cgrp_name); + + if (config->json_output) + fprintf(config->output, "\"cgroup\" : \"%s\", ", cgrp_name); + else + fprintf(config->output, "%s%s", config->csv_sep, cgrp_name); } } =20 @@ -74,69 +86,123 @@ static void print_cgroup(struct perf_stat_config *conf= ig, struct evsel *evsel) static void aggr_printout(struct perf_stat_config *config, struct evsel *evsel, struct aggr_cpu_id id, int nr) { + + + if (config->json_output && !config->interval) + fprintf(config->output, "{"); + switch (config->aggr_mode) { case AGGR_CORE: - fprintf(config->output, "S%d-D%d-C%*d%s%*d%s", - id.socket, - id.die, - config->csv_output ? 0 : -8, - id.core, - config->csv_sep, - config->csv_output ? 0 : 4, - nr, - config->csv_sep); + if (config->json_output) { + fprintf(config->output, + "\"core\" : \"S%d-D%d-C%d\", \"aggregate-number\" : %d, ", + id.socket, + id.die, + id.core, + nr); + } else { + fprintf(config->output, "S%d-D%d-C%*d%s%*d%s", + id.socket, + id.die, + config->csv_output ? 0 : -8, + id.core, + config->csv_sep, + config->csv_output ? 0 : 4, + nr, + config->csv_sep); + } break; case AGGR_DIE: - fprintf(config->output, "S%d-D%*d%s%*d%s", - id.socket, - config->csv_output ? 0 : -8, - id.die, - config->csv_sep, - config->csv_output ? 0 : 4, - nr, - config->csv_sep); + if (config->json_output) { + fprintf(config->output, + "\"die\" : \"S%d-D%d\", \"aggregate-number\" : %d, ", + id.socket, + id.die, + nr); + } else { + fprintf(config->output, "S%d-D%*d%s%*d%s", + id.socket, + config->csv_output ? 0 : -8, + id.die, + config->csv_sep, + config->csv_output ? 0 : 4, + nr, + config->csv_sep); + } break; case AGGR_SOCKET: - fprintf(config->output, "S%*d%s%*d%s", - config->csv_output ? 0 : -5, - id.socket, - config->csv_sep, - config->csv_output ? 0 : 4, - nr, - config->csv_sep); - break; + if (config->json_output) { + fprintf(config->output, + "\"socket\" : \"S%d\", \"aggregate-number\" : %d, ", + id.socket, + nr); + } else { + fprintf(config->output, "S%*d%s%*d%s", + config->csv_output ? 0 : -5, + id.socket, + config->csv_sep, + config->csv_output ? 0 : 4, + nr, + config->csv_sep); + } + break; case AGGR_NODE: - fprintf(config->output, "N%*d%s%*d%s", - config->csv_output ? 0 : -5, - id.node, - config->csv_sep, - config->csv_output ? 0 : 4, - nr, - config->csv_sep); - break; + if (config->json_output) { + fprintf(config->output, "\"node\" : \"N%d\", \"aggregate-number\" : %d,= ", + id.node, + nr); + } else { + fprintf(config->output, "N%*d%s%*d%s", + config->csv_output ? 0 : -5, + id.node, + config->csv_sep, + config->csv_output ? 0 : 4, + nr, + config->csv_sep); + } + break; case AGGR_NONE: - if (evsel->percore && !config->percore_show_thread) { - fprintf(config->output, "S%d-D%d-C%*d%s", - id.socket, - id.die, - config->csv_output ? 0 : -3, - id.core, config->csv_sep); - } else if (id.cpu.cpu > -1) { - fprintf(config->output, "CPU%*d%s", - config->csv_output ? 0 : -7, - id.cpu.cpu, config->csv_sep); + if (config->json_output) { + if (evsel->percore && !config->percore_show_thread) { + fprintf(config->output, "\"core\" : \"S%d-D%d-C%d\"", + id.socket, + id.die, + id.core); + } else if (id.core > -1) { + fprintf(config->output, "\"cpu\" : \"%d\", ", + id.cpu.cpu); + } + } else { + if (evsel->percore && !config->percore_show_thread) { + fprintf(config->output, "S%d-D%d-C%*d%s", + id.socket, + id.die, + config->csv_output ? 0 : -3, + id.core, config->csv_sep); + } else if (id.core > -1) { + fprintf(config->output, "CPU%*d%s", + config->csv_output ? 0 : -7, + id.cpu.cpu, config->csv_sep); + } } break; case AGGR_THREAD: - fprintf(config->output, "%*s-%*d%s", - config->csv_output ? 0 : 16, - perf_thread_map__comm(evsel->core.threads, id.thread), - config->csv_output ? 0 : -8, - perf_thread_map__pid(evsel->core.threads, id.thread), - config->csv_sep); + if (config->json_output) { + fprintf(config->output, "\"thread\" : \"%s-%d\", ", + perf_thread_map__comm(evsel->core.threads, id.thread), + perf_thread_map__pid(evsel->core.threads, id.thread)); + } else { + fprintf(config->output, "%*s-%*d%s", + config->csv_output ? 0 : 16, + perf_thread_map__comm(evsel->core.threads, id.thread), + config->csv_output ? 0 : -8, + perf_thread_map__pid(evsel->core.threads, id.thread), + config->csv_sep); + } break; case AGGR_GLOBAL: case AGGR_UNSET: + case AGGR_MAX: default: break; } @@ -234,6 +300,31 @@ static void print_metric_csv(struct perf_stat_config *= config __maybe_unused, fprintf(out, "%s%s%s%s", config->csv_sep, vals, config->csv_sep, skip_spa= ces(unit)); } =20 +static void print_metric_json(struct perf_stat_config *config __maybe_unus= ed, + void *ctx, + const char *color __maybe_unused, + const char *fmt __maybe_unused, + const char *unit, double val) +{ + struct outstate *os =3D ctx; + FILE *out =3D os->fh; + + fprintf(out, "\"metric-value\" : %f, ", val); + fprintf(out, "\"metric-unit\" : \"%s\"", unit); + if (!config->metric_only) + fprintf(out, "}"); +} + +static void new_line_json(struct perf_stat_config *config, void *ctx) +{ + struct outstate *os =3D ctx; + + fputc('\n', os->fh); + if (os->prefix) + fprintf(os->fh, "%s", os->prefix); + aggr_printout(config, os->evsel, os->id, os->nr); +} + /* Filter out some columns that don't work well in metrics only mode */ =20 static bool valid_only_metric(const char *unit) @@ -300,6 +391,27 @@ static void print_metric_only_csv(struct perf_stat_con= fig *config __maybe_unused fprintf(out, "%s%s", vals, config->csv_sep); } =20 +static void print_metric_only_json(struct perf_stat_config *config __maybe= _unused, + void *ctx, const char *color __maybe_unused, + const char *fmt, + const char *unit, double val) +{ + struct outstate *os =3D ctx; + FILE *out =3D os->fh; + char buf[64], *vals, *ends; + char tbuf[1024]; + + if (!valid_only_metric(unit)) + return; + unit =3D fixunit(tbuf, os->evsel, unit); + snprintf(buf, sizeof(buf), fmt, val); + ends =3D vals =3D skip_spaces(buf); + while (isdigit(*ends) || *ends =3D=3D '.') + ends++; + *ends =3D 0; + fprintf(out, "{\"metric-value\" : \"%s\"}", vals); +} + static void new_line_metric(struct perf_stat_config *config __maybe_unused, void *ctx __maybe_unused) { @@ -318,10 +430,13 @@ static void print_metric_header(struct perf_stat_conf= ig *config, os->evsel->priv !=3D os->evsel->evlist->selected->priv) return; =20 - if (!valid_only_metric(unit)) + if (!valid_only_metric(unit) && !config->json_output) return; unit =3D fixunit(tbuf, os->evsel, unit); - if (config->csv_output) + + if (config->json_output) + fprintf(os->fh, "\"unit\" : \"%s\"", unit); + else if (config->csv_output) fprintf(os->fh, "%s%s", unit, config->csv_sep); else fprintf(os->fh, "%*s ", config->metric_only_len, unit); @@ -367,14 +482,28 @@ static void abs_printout(struct perf_stat_config *con= fig, =20 aggr_printout(config, evsel, id, nr); =20 - fprintf(output, fmt, avg, config->csv_sep); + if (config->json_output) + fprintf(output, "\"counter-value\" : \"%f\", ", avg); + else + fprintf(output, fmt, avg, config->csv_sep); + + if (config->json_output) { + if (evsel->unit) { + fprintf(output, "\"unit\" : \"%s\", ", + evsel->unit); + } + } else { + if (evsel->unit) + fprintf(output, "%-*s%s", + config->csv_output ? 0 : config->unit_width, + evsel->unit, config->csv_sep); + } =20 - if (evsel->unit) - fprintf(output, "%-*s%s", - config->csv_output ? 0 : config->unit_width, - evsel->unit, config->csv_sep); =20 - fprintf(output, "%-*s", config->csv_output ? 0 : 25, evsel__name(evsel)); + if (config->json_output) + fprintf(output, "\"event\" : \"%s\", ", evsel__name(evsel)); + else + fprintf(output, "%-*s", config->csv_output ? 0 : 25, evsel__name(evsel)); =20 print_cgroup(config, evsel); } @@ -416,34 +545,30 @@ static void printout(struct perf_stat_config *config,= struct aggr_cpu_id id, int .nr =3D nr, .evsel =3D counter, }; - print_metric_t pm =3D print_metric_std; + print_metric_t pm; new_line_t nl; =20 - if (config->metric_only) { - nl =3D new_line_metric; - if (config->csv_output) - pm =3D print_metric_only_csv; - else - pm =3D print_metric_only; - } else - nl =3D new_line_std; - - if (config->csv_output && !config->metric_only) { - static int aggr_fields[] =3D { - [AGGR_GLOBAL] =3D 0, - [AGGR_THREAD] =3D 1, + if (config->csv_output) { + static const int aggr_fields[AGGR_MAX] =3D { [AGGR_NONE] =3D 1, + [AGGR_GLOBAL] =3D 0, [AGGR_SOCKET] =3D 2, [AGGR_DIE] =3D 2, [AGGR_CORE] =3D 2, + [AGGR_THREAD] =3D 1, + [AGGR_UNSET] =3D 0, + [AGGR_NODE] =3D 0, }; =20 - pm =3D print_metric_csv; - nl =3D new_line_csv; - os.nfields =3D 3; - os.nfields +=3D aggr_fields[config->aggr_mode]; - if (counter->cgrp) - os.nfields++; + pm =3D config->metric_only ? print_metric_only_csv : print_metric_csv; + nl =3D config->metric_only ? new_line_metric : new_line_csv; + os.nfields =3D 3 + aggr_fields[config->aggr_mode] + (counter->cgrp ? 1 := 0); + } else if (config->json_output) { + pm =3D config->metric_only ? print_metric_only_json : print_metric_json; + nl =3D config->metric_only ? new_line_metric : new_line_json; + } else { + pm =3D config->metric_only ? print_metric_only : print_metric_std; + nl =3D config->metric_only ? new_line_metric : new_line_std; } =20 if (!config->no_csv_summary && config->csv_output && @@ -458,10 +583,15 @@ static void printout(struct perf_stat_config *config,= struct aggr_cpu_id id, int } aggr_printout(config, counter, id, nr); =20 - fprintf(config->output, "%*s%s", - config->csv_output ? 0 : 18, - counter->supported ? CNTR_NOT_COUNTED : CNTR_NOT_SUPPORTED, - config->csv_sep); + if (config->json_output) { + fprintf(config->output, "\"counter-value\" : \"%s\", ", + counter->supported ? CNTR_NOT_COUNTED : CNTR_NOT_SUPPORTED); + } else { + fprintf(config->output, "%*s%s", + config->csv_output ? 0 : 18, + counter->supported ? CNTR_NOT_COUNTED : CNTR_NOT_SUPPORTED, + config->csv_sep); + } =20 if (counter->supported) { if (!evlist__has_hybrid(counter->evlist)) { @@ -471,21 +601,32 @@ static void printout(struct perf_stat_config *config,= struct aggr_cpu_id id, int } } =20 - fprintf(config->output, "%-*s%s", - config->csv_output ? 0 : config->unit_width, - counter->unit, config->csv_sep); + if (config->json_output) { + fprintf(config->output, "\"unit\" : \"%s\", ", counter->unit); + } else { + fprintf(config->output, "%-*s%s", + config->csv_output ? 0 : config->unit_width, + counter->unit, config->csv_sep); + } =20 - fprintf(config->output, "%*s", - config->csv_output ? 0 : -25, evsel__name(counter)); + if (config->json_output) { + fprintf(config->output, "\"event\" : \"%s\", ", + evsel__name(counter)); + } else { + fprintf(config->output, "%*s", + config->csv_output ? 0 : -25, evsel__name(counter)); + } =20 print_cgroup(config, counter); =20 - if (!config->csv_output) + if (!config->csv_output && !config->json_output) pm(config, &os, NULL, NULL, "", 0); print_noise(config, counter, noise); print_running(config, run, ena); if (config->csv_output) pm(config, &os, NULL, NULL, "", 0); + else if (config->json_output) + pm(config, &os, NULL, NULL, "", 0); return; } =20 @@ -500,12 +641,15 @@ static void printout(struct perf_stat_config *config,= struct aggr_cpu_id id, int if (config->csv_output && !config->metric_only) { print_noise(config, counter, noise); print_running(config, run, ena); + } else if (config->json_output && !config->metric_only) { + print_noise(config, counter, noise); + print_running(config, run, ena); } =20 perf_stat__print_shadow_stats(config, counter, uval, first_shadow_cpu_map_idx(config, counter, &id), &out, &config->metric_events, st); - if (!config->csv_output && !config->metric_only) { + if (!config->csv_output && !config->metric_only && !config->json_output) { print_noise(config, counter, noise); print_running(config, run, ena); } @@ -1004,8 +1148,12 @@ static void print_metric_headers(struct perf_stat_co= nfig *config, struct outstate os =3D { .fh =3D config->output }; + bool first =3D true; + + if (config->json_output && !config->interval) + fprintf(config->output, "{"); =20 - if (prefix) + if (prefix && !config->json_output) fprintf(config->output, "%s", prefix); =20 if (!config->csv_output && !no_indent) @@ -1025,6 +1173,9 @@ static void print_metric_headers(struct perf_stat_con= fig *config, os.evsel =3D counter; out.ctx =3D &os; out.print_metric =3D print_metric_header; + if (!first && config->json_output) + fprintf(config->output, ", "); + first =3D false; out.new_line =3D new_line_metric; out.force_header =3D true; perf_stat__print_shadow_stats(config, counter, 0, @@ -1033,6 +1184,8 @@ static void print_metric_headers(struct perf_stat_con= fig *config, &config->metric_events, &rt_stat); } + if (config->json_output) + fprintf(config->output, "}"); fputc('\n', config->output); } =20 @@ -1048,10 +1201,18 @@ static void print_interval(struct perf_stat_config = *config, if (config->interval_clear) puts(CONSOLE_CLEAR); =20 - if (!config->iostat_run) - sprintf(prefix, "%6lu.%09lu%s", (unsigned long) ts->tv_sec, ts->tv_nsec,= config->csv_sep); - - if ((num_print_interval =3D=3D 0 && !config->csv_output) || config->inter= val_clear) { + if (!config->iostat_run && !config->json_output) + sprintf(prefix, "%6lu.%09lu%s", (unsigned long) ts->tv_sec, + ts->tv_nsec, config->csv_sep); + if (!config->iostat_run && config->json_output && !config->metric_only) + sprintf(prefix, "{\"interval\" : %lu.%09lu, ", (unsigned long) + ts->tv_sec, ts->tv_nsec); + if (!config->iostat_run && config->json_output && config->metric_only) + sprintf(prefix, "{\"interval\" : %lu.%09lu}", (unsigned long) + ts->tv_sec, ts->tv_nsec); + + if ((num_print_interval =3D=3D 0 && !config->csv_output && !config->json_= output) + || config->interval_clear) { switch (config->aggr_mode) { case AGGR_NODE: fprintf(output, "# time node cpus"); @@ -1091,12 +1252,19 @@ static void print_interval(struct perf_stat_config = *config, fprintf(output, " counts %*s events\n", unit_width, "unit= "); } case AGGR_UNSET: + case AGGR_MAX: break; } } =20 - if ((num_print_interval =3D=3D 0 || config->interval_clear) && metric_onl= y) + if ((num_print_interval =3D=3D 0 || config->interval_clear) + && metric_only && !config->json_output) print_metric_headers(config, evlist, " ", true); + if ((num_print_interval =3D=3D 0 || config->interval_clear) + && metric_only && config->json_output) { + fprintf(output, "{"); + print_metric_headers(config, evlist, " ", true); + } if (++num_print_interval =3D=3D 25) num_print_interval =3D 0; } @@ -1110,7 +1278,7 @@ static void print_header(struct perf_stat_config *con= fig, =20 fflush(stdout); =20 - if (!config->csv_output) { + if (!config->csv_output && !config->json_output) { fprintf(output, "\n"); fprintf(output, " Performance counter stats for "); if (_target->bpf_str) @@ -1303,6 +1471,9 @@ void evlist__print_counters(struct evlist *evlist, st= ruct perf_stat_config *conf num_print_iv =3D 0; if (config->aggr_mode =3D=3D AGGR_GLOBAL && prefix && !config->iostat_ru= n) fprintf(config->output, "%s", prefix); + + if (config->json_output && !config->metric_only) + fprintf(config->output, "}"); } =20 switch (config->aggr_mode) { @@ -1341,12 +1512,13 @@ void evlist__print_counters(struct evlist *evlist, = struct perf_stat_config *conf } } break; + case AGGR_MAX: case AGGR_UNSET: default: break; } =20 - if (!interval && !config->csv_output) + if (!interval && !config->csv_output && !config->json_output) print_footer(config); =20 fflush(config->output); diff --git a/tools/perf/util/stat.c b/tools/perf/util/stat.c index 37ea2d044708..0882b4754fcf 100644 --- a/tools/perf/util/stat.c +++ b/tools/perf/util/stat.c @@ -401,6 +401,7 @@ process_counter_values(struct perf_stat_config *config,= struct evsel *evsel, aggr->ena +=3D count->ena; aggr->run +=3D count->run; case AGGR_UNSET: + case AGGR_MAX: default: break; } diff --git a/tools/perf/util/stat.h b/tools/perf/util/stat.h index b5aeb8e6d34b..668250022f8c 100644 --- a/tools/perf/util/stat.h +++ b/tools/perf/util/stat.h @@ -57,6 +57,7 @@ enum aggr_mode { AGGR_THREAD, AGGR_UNSET, AGGR_NODE, + AGGR_MAX }; =20 enum { @@ -121,6 +122,7 @@ struct perf_stat_config { bool no_inherit; bool identifier; bool csv_output; + bool json_output; bool interval_clear; bool metric_only; bool null_run; --=20 2.36.1.124.g0e6072fb45-goog From nobody Tue Apr 28 23:22:28 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 C0F51C433EF for ; Thu, 26 May 2022 22:45:33 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S235623AbiEZWpa (ORCPT ); Thu, 26 May 2022 18:45:30 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:55428 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1349302AbiEZWp0 (ORCPT ); Thu, 26 May 2022 18:45:26 -0400 Received: from mail-yb1-xb4a.google.com (mail-yb1-xb4a.google.com [IPv6:2607:f8b0:4864:20::b4a]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 6723DC5D8C for ; Thu, 26 May 2022 15:45:24 -0700 (PDT) Received: by mail-yb1-xb4a.google.com with SMTP id m9-20020a056902004900b0064fb755258dso2721195ybh.13 for ; Thu, 26 May 2022 15:45:24 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20210112; h=date:in-reply-to:message-id:mime-version:references:subject:from:to :cc; bh=W0sWuy6oTQPVjB3fsY9LwhFU+wj+C4Fi95g+ekuZQ7c=; b=C7RV9ok6dY1AYybfe9s5PMS/59NC1X3IjevQKCRiN+NQlRjB4Tm06DoTkjbT2a3OeZ FXxnQ19pSb/ZVNLRV+APwvbQET8wxnxtiOyJ/wnWNSiO3HF3gRhquAF3UglD63dLOS8S Z9IzRHBl7LcAseQzano1oINnxxIjL5YZBS3HcHo35n6R32+I/TsSUjQpgmRMjmwmNenk aQyrU2r77wrgkNlQnYl9VuUD2FMscqa3kGCwX2t9lND/8/3Ffmp/5JFx3v+uWJa6gomV 17kNTv/Rt04dYmZsNXvrqpLv0M5xGbr37tHHvc/kLcoRSSd8rZxjYA6Uk4x1/1OTSTm+ P3Gg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:date:in-reply-to:message-id:mime-version :references:subject:from:to:cc; bh=W0sWuy6oTQPVjB3fsY9LwhFU+wj+C4Fi95g+ekuZQ7c=; b=xUbTVI2qo4mRG+RC8qfeLdLbrKAguQvFlrPCuFxPWbBmLmVUXAlHbj+iou8cKQ/MRG 5oqAX+BD0Pgfh9cyXXaOjGwy5SKAg8RjU1/teK0Z6WH0moEKrvx9rdFrDV9roM//ZpE+ 20JbSVeXL8sGfWK/+A55EsS3+bbA4Cv9Wsb7vfUpEwySXo4ShpV0D62Ud8CAOF/MrM+M SM5H0UHrgME92enPUOMm/+a1g+OGAiYJ5envOOJAFe/qexi6pkxrRyeKaIOiSpAtDzTZ uplmsuqeLJ1cR1Fg8UQdj/0sqSwEOmTHWl/nifC7VX6OFMTKT3Nz25uTWeV+yRwaKYM2 sk9w== X-Gm-Message-State: AOAM531xdnKz5K7cU1qYAkLPTqfWgJ3ECwaLl/FYnYB4iWf7YItZH9Bq 1rNZ8L5TBifpqmgjjruzwNvtGuTM0IQr X-Google-Smtp-Source: ABdhPJzJVxppI89ysg2ullf/UAcAYv3UIE1+AUTlJtIr5xVgb4JgOk9mU7egYfFt2Ycmwl91DPDomKqOnwDo X-Received: from irogers.svl.corp.google.com ([2620:15c:2cd:202:4b39:e167:e698:7d4]) (user=irogers job=sendgmr) by 2002:a5b:642:0:b0:64f:f322:8827 with SMTP id o2-20020a5b0642000000b0064ff3228827mr20474054ybq.536.1653605123527; Thu, 26 May 2022 15:45:23 -0700 (PDT) Date: Thu, 26 May 2022 15:45:15 -0700 In-Reply-To: <20220526224515.4088240-1-irogers@google.com> Message-Id: <20220526224515.4088240-3-irogers@google.com> Mime-Version: 1.0 References: <20220526224515.4088240-1-irogers@google.com> X-Mailer: git-send-email 2.36.1.124.g0e6072fb45-goog Subject: [PATCH v5 2/2] perf test: Json format checking From: Ian Rogers To: Peter Zijlstra , Ingo Molnar , Arnaldo Carvalho de Melo , Mark Rutland , Alexander Shishkin , Jiri Olsa , Namhyung Kim , Kan Liang , Zhengjun Xing , Sandipan Das , Claire Jensen , Alyssa Ross , Like Xu , James Clark , Florian Fischer , linux-kernel@vger.kernel.org, linux-perf-users@vger.kernel.org, Claire Jensen 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" From: Claire Jensen Add field checking tests for perf stat JSON output. Sanity checks the expected number of fields are present, that the expected keys are present and they have the correct values. Signed-off-by: Claire Jensen Signed-off-by: Ian Rogers --- .../tests/shell/lib/perf_json_output_lint.py | 95 +++++++++++ tools/perf/tests/shell/stat+json_output.sh | 147 ++++++++++++++++++ 2 files changed, 242 insertions(+) create mode 100644 tools/perf/tests/shell/lib/perf_json_output_lint.py create mode 100755 tools/perf/tests/shell/stat+json_output.sh diff --git a/tools/perf/tests/shell/lib/perf_json_output_lint.py b/tools/pe= rf/tests/shell/lib/perf_json_output_lint.py new file mode 100644 index 000000000000..aaa4a8677b6c --- /dev/null +++ b/tools/perf/tests/shell/lib/perf_json_output_lint.py @@ -0,0 +1,95 @@ +#!/usr/bin/python +# SPDX-License-Identifier: (LGPL-2.1 OR BSD-2-Clause) +# Basic sanity check of perf JSON output as specified in the man page. + +import argparse +import sys +import json + +ap =3D argparse.ArgumentParser() +ap.add_argument('--no-args', action=3D'store_true') +ap.add_argument('--interval', action=3D'store_true') +ap.add_argument('--system-wide-no-aggr', action=3D'store_true') +ap.add_argument('--system-wide', action=3D'store_true') +ap.add_argument('--event', action=3D'store_true') +ap.add_argument('--per-core', action=3D'store_true') +ap.add_argument('--per-thread', action=3D'store_true') +ap.add_argument('--per-die', action=3D'store_true') +ap.add_argument('--per-node', action=3D'store_true') +ap.add_argument('--per-socket', action=3D'store_true') +args =3D ap.parse_args() + +Lines =3D sys.stdin.readlines() + +def isfloat(num): + try: + float(num) + return True + except ValueError: + return False + + +def isint(num): + try: + int(num) + return True + except ValueError: + return False + +def is_counter_value(num): + return isfloat(num) or num =3D=3D '' or num =3D=3D '' + +def check_json_output(expected_items): + if expected_items !=3D -1: + for line in Lines: + if 'failed' not in line: + count =3D 0 + count =3D line.count(',') + if count !=3D expected_items and (count =3D=3D 1 or count =3D=3D 2= ) and 'metric-value' in line: + # Events that generate >1 metric may have isolated metric + # values and possibly have an interval prefix. + continue + if count !=3D expected_items: + raise RuntimeError(f'wrong number of fields. counted {count} exp= ected {expected_items}' + f' in \'{line}\'') + checks =3D { + 'aggregate-number': lambda x: isfloat(x), + 'core': lambda x: True, + 'counter-value': lambda x: is_counter_value(x), + 'cgroup': lambda x: True, + 'cpu': lambda x: isint(x), + 'die': lambda x: True, + 'event': lambda x: True, + 'event-runtime': lambda x: isfloat(x), + 'interval': lambda x: isfloat(x), + 'metric-unit': lambda x: True, + 'metric-value': lambda x: isfloat(x), + 'node': lambda x: True, + 'pcnt-running': lambda x: isfloat(x), + 'socket': lambda x: True, + 'thread': lambda x: True, + 'unit': lambda x: True, + } + input =3D '[\n' + ','.join(Lines) + '\n]' + for item in json.loads(input): + for key, value in item.items(): + if key not in checks: + raise RuntimeError(f'Unexpected key: key=3D{key} value=3D{value}') + if not checks[key](value): + raise RuntimeError(f'Check failed for: key=3D{key} value=3D{value}= ') + + +try: + if args.no_args or args.system_wide or args.event: + expected_items =3D 6 + elif args.interval or args.per_thread or args.system_wide_no_aggr: + expected_items =3D 7 + elif args.per_core or args.per_socket or args.per_node or args.per_die: + expected_items =3D 8 + else: + # If no option is specified, don't check the number of items. + expected_items =3D -1 + check_json_output(expected_items) +except: + print('Test failed for input:\n' + '\n'.join(Lines)) + raise diff --git a/tools/perf/tests/shell/stat+json_output.sh b/tools/perf/tests/= shell/stat+json_output.sh new file mode 100755 index 000000000000..ea8714a36051 --- /dev/null +++ b/tools/perf/tests/shell/stat+json_output.sh @@ -0,0 +1,147 @@ +#!/bin/bash +# perf stat JSON output linter +# SPDX-License-Identifier: (LGPL-2.1 OR BSD-2-Clause) +# Checks various perf stat JSON output commands for the +# correct number of fields. + +set -e + +pythonchecker=3D$(dirname $0)/lib/perf_json_output_lint.py +if [ "x$PYTHON" =3D=3D "x" ] +then + if which python3 > /dev/null + then + PYTHON=3Dpython3 + elif which python > /dev/null + then + PYTHON=3Dpython + else + echo Skipping test, python not detected please set environment variable = PYTHON. + exit 2 + fi +fi + +# Return true if perf_event_paranoid is > $1 and not running as root. +function ParanoidAndNotRoot() +{ + [ $(id -u) !=3D 0 ] && [ $(cat /proc/sys/kernel/perf_event_paranoid) -gt= $1 ] +} + +check_no_args() +{ + echo -n "Checking json output: no args " + perf stat -j true 2>&1 | $PYTHON $pythonchecker --no-args + echo "[Success]" +} + +check_system_wide() +{ + echo -n "Checking json output: system wide " + if ParanoidAndNotRoot 0 + then + echo "[Skip] paranoia and not root" + return + fi + perf stat -j -a true 2>&1 | $PYTHON $pythonchecker --system-wide + echo "[Success]" +} + +check_system_wide_no_aggr() +{ + echo -n "Checking json output: system wide " + if ParanoidAndNotRoot 0 + then + echo "[Skip] paranoia and not root" + return + fi + echo -n "Checking json output: system wide no aggregation " + perf stat -j -A -a --no-merge true 2>&1 | $PYTHON $pythonchecker --system= -wide-no-aggr + echo "[Success]" +} + +check_interval() +{ + echo -n "Checking json output: interval " + perf stat -j -I 1000 true 2>&1 | $PYTHON $pythonchecker --interval + echo "[Success]" +} + + +check_event() +{ + echo -n "Checking json output: event " + perf stat -j -e cpu-clock true 2>&1 | $PYTHON $pythonchecker --event + echo "[Success]" +} + +check_per_core() +{ + echo -n "Checking json output: per core " + if ParanoidAndNotRoot 0 + then + echo "[Skip] paranoia and not root" + return + fi + perf stat -j --per-core -a true 2>&1 | $PYTHON $pythonchecker --per-core + echo "[Success]" +} + +check_per_thread() +{ + echo -n "Checking json output: per thread " + if ParanoidAndNotRoot 0 + then + echo "[Skip] paranoia and not root" + return + fi + perf stat -j --per-thread -a true 2>&1 | $PYTHON $pythonchecker --per-thr= ead + echo "[Success]" +} + +check_per_die() +{ + echo -n "Checking json output: per die " + if ParanoidAndNotRoot 0 + then + echo "[Skip] paranoia and not root" + return + fi + perf stat -j --per-die -a true 2>&1 | $PYTHON $pythonchecker --per-die + echo "[Success]" +} + +check_per_node() +{ + echo -n "Checking json output: per node " + if ParanoidAndNotRoot 0 + then + echo "[Skip] paranoia and not root" + return + fi + perf stat -j --per-node -a true 2>&1 | $PYTHON $pythonchecker --per-node + echo "[Success]" +} + +check_per_socket() +{ + echo -n "Checking json output: per socket " + if ParanoidAndNotRoot 0 + then + echo "[Skip] paranoia and not root" + return + fi + perf stat -j --per-socket -a true 2>&1 | $PYTHON $pythonchecker --per-soc= ket + echo "[Success]" +} + +check_no_args +check_system_wide +check_system_wide_no_aggr +check_interval +check_event +check_per_core +check_per_thread +check_per_die +check_per_node +check_per_socket +exit 0 --=20 2.36.1.124.g0e6072fb45-goog