From nobody Fri May 8 00:57:45 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 DDD24C433F5 for ; Sun, 15 May 2022 17:36:33 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S237932AbiEORga (ORCPT ); Sun, 15 May 2022 13:36:30 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:52016 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S237913AbiEORgP (ORCPT ); Sun, 15 May 2022 13:36:15 -0400 Received: from mail-yw1-x114a.google.com (mail-yw1-x114a.google.com [IPv6:2607:f8b0:4864:20::114a]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 7AE07EA4 for ; Sun, 15 May 2022 10:36:09 -0700 (PDT) Received: by mail-yw1-x114a.google.com with SMTP id 00721157ae682-2f8398e99dcso112828797b3.9 for ; Sun, 15 May 2022 10:36:09 -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=hr4Kx7vz6eiJv03wCUlPh5MzpIVWGg8R+A3dGgGPS38=; b=n1oZmt9vKhZ8MrXqiGCfgmEA3X+7wZPRYgN9YaF9GdfrgTGY7Nji56ByYWFgdk01tX H9PJQ+pqIuGglmMdmBEBm7BeUEwD9j0e0FCHsBVsdfCWVcirLGQLo+40Neb7+K4y3Pm+ /0UMaI1JNRAz7LbqlnvbATxrr59G0NqAaaBhn7yqIl4uKHQvAxp3abvEpMXRvpGxQIt2 4oErSPhvy+LQTV6FW2EIgZR+Mr45HLUn/juap6CxoKEbPS0CUw/AaEomPi+c3EeP++ei cnexEhaIzRNCwbpbmwTI97mMh3RH/zht93vODrKYlkUAW2s1SJoJVDFWvNaVJ8UW+qe6 a9gw== 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=hr4Kx7vz6eiJv03wCUlPh5MzpIVWGg8R+A3dGgGPS38=; b=ixfAXWmsY+izx3/+Glm4IL98JuobpnPmbBHswqvmjlpMkz61L42SnO+gzOORLYp5ZB eBuEqOVQvKA4wTGbkUJtR/WK9v6X/hjEUy+pR6bGb/mJWGjVHnMVzRzLnsvLrHBR6+Hc j3n6WItTthSUHKQGRMDoT5MjsGsr45TFWrgJXQDuRo6NfABpohgbsDUHm1q91nQl6cOD TQE8ZrXFefBm5gnSTY/1OVFhDdgZpZBCG5Neib8UDYBKmNLuk2pVasLDivAWfExOwDSB 0X7uEZ87XTm9LGTKMobbps7mYh08/5TWXtlemDcjPcSVgeqcbzuCroxrhUTOViYs20Po q7wQ== X-Gm-Message-State: AOAM533AiCJVyacw9w2nmBUZMvwnYEhC/Ybs+MsrjTmF0/xYne+HxyHh cudzT9dYbC5BAZvhtfqHKSM0z71N29G7 X-Google-Smtp-Source: ABdhPJzlF5oeN3nVNL66T/oTY6hSRCPBKV0NYuUXA57xITSz3XQIZD0GmeMksj2Gx4v90cBlM9KP/TOKpOwv X-Received: from irogers.svl.corp.google.com ([2620:15c:2cd:202:2a5e:db66:d206:cbaf]) (user=irogers job=sendgmr) by 2002:a25:da84:0:b0:648:423e:57b0 with SMTP id n126-20020a25da84000000b00648423e57b0mr13984604ybf.137.1652636168440; Sun, 15 May 2022 10:36:08 -0700 (PDT) Date: Sun, 15 May 2022 10:35:57 -0700 In-Reply-To: <20220515173558.2289702-1-irogers@google.com> Message-Id: <20220515173558.2289702-2-irogers@google.com> Mime-Version: 1.0 References: <20220515173558.2289702-1-irogers@google.com> X-Mailer: git-send-email 2.36.0.550.gb090851708-goog Subject: [PATCH 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. Signed-off-by: Claire Jensen Signed-off-by: Ian Rogers --- tools/perf/Documentation/perf-stat.txt | 21 ++ tools/perf/builtin-stat.c | 2 + tools/perf/util/stat-display.c | 365 +++++++++++++++++++------ tools/perf/util/stat.h | 1 + 4 files changed, 303 insertions(+), 86 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 1b96636df01e..0855f763d17d 100644 --- a/tools/perf/builtin-stat.c +++ b/tools/perf/builtin-stat.c @@ -1262,6 +1262,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", diff --git a/tools/perf/util/stat-display.c b/tools/perf/util/stat-display.c index 98669ca5a86b..1e93094146cd 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,66 +86,119 @@ 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: @@ -234,6 +299,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 +390,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 +429,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 +481,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); } @@ -423,6 +551,8 @@ static void printout(struct perf_stat_config *config, s= truct aggr_cpu_id id, int nl =3D new_line_metric; if (config->csv_output) pm =3D print_metric_only_csv; + else if (config->json_output) + pm =3D print_metric_only_json; else pm =3D print_metric_only; } else @@ -446,6 +576,24 @@ static void printout(struct perf_stat_config *config, = struct aggr_cpu_id id, int os.nfields++; } =20 + if (config->json_output && !config->metric_only) { + static const int aggr_fields[] =3D { + [AGGR_GLOBAL] =3D 0, + [AGGR_THREAD] =3D 1, + [AGGR_NONE] =3D 1, + [AGGR_SOCKET] =3D 2, + [AGGR_DIE] =3D 2, + [AGGR_CORE] =3D 2, + }; + + pm =3D print_metric_json; + nl =3D new_line_json; + os.nfields =3D 3; + os.nfields +=3D aggr_fields[config->aggr_mode]; + if (counter->cgrp) + os.nfields++; + } + if (!config->no_csv_summary && config->csv_output && config->summary && !config->interval) { fprintf(config->output, "%16s%s", "summary", config->csv_sep); @@ -458,10 +606,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 +624,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 +664,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); } @@ -1002,8 +1169,12 @@ static void print_metric_headers(struct perf_stat_co= nfig *config, struct outstate os =3D { .fh =3D config->output }; + bool first =3D true; =20 - if (prefix) + if (config->json_output && !config->interval) + fprintf(config->output, "{"); + + if (prefix && !config->json_output) fprintf(config->output, "%s", prefix); =20 if (!config->csv_output && !no_indent) @@ -1023,6 +1194,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, @@ -1031,6 +1205,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 @@ -1046,10 +1222,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"); @@ -1093,8 +1277,14 @@ static void print_interval(struct perf_stat_config *= config, } } =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; } @@ -1108,7 +1298,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) @@ -1301,6 +1491,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) { @@ -1344,7 +1537,7 @@ void evlist__print_counters(struct evlist *evlist, st= ruct perf_stat_config *conf 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.h b/tools/perf/util/stat.h index b5aeb8e6d34b..09120337cdba 100644 --- a/tools/perf/util/stat.h +++ b/tools/perf/util/stat.h @@ -121,6 +121,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.0.550.gb090851708-goog From nobody Fri May 8 00:57:45 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 DE149C433EF for ; Sun, 15 May 2022 17:36:28 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S237936AbiEORg0 (ORCPT ); Sun, 15 May 2022 13:36:26 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:51870 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S237903AbiEORgR (ORCPT ); Sun, 15 May 2022 13:36:17 -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 874D1EAF for ; Sun, 15 May 2022 10:36:11 -0700 (PDT) Received: by mail-yb1-xb4a.google.com with SMTP id b6-20020a5b0b46000000b006457d921729so11398031ybr.23 for ; Sun, 15 May 2022 10:36:11 -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=8sHlDEs1q4JukqBHuWMP1ZMhpXOvq75/48oBKXyDEuU=; b=ez8Lk1k+iXKPT37+NcdQsVblaqAIufwRTtUy5BPvC35lWYU9gPN+ZQi8VjLVuN+a+y A0seUY8QY4ZWDV6IUcp+rSfHtK62dplL89ZTQ2ejb7YzFPGWzL9rDSKZKN2WKlkuBi/W gEP3qAMq3emNrET8UkeCKNknCCKjNTkZOV3a7OAa35D+ZWWxWs5o+ZobiU9eUrJ9ie6G gXLHY4VWX8CDExJM1t77gkUC9UeLmkb22WLVkrr8A3C/Cwrgt2FcoNA8XGfyAt8lz1R6 z55i71hw5TjflUKBfdDJobdkP1x4/sCdpUrAv9X7Xfqch1d5hjo+JJ+DxufxjtZq4kgw hAmA== 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=8sHlDEs1q4JukqBHuWMP1ZMhpXOvq75/48oBKXyDEuU=; b=3T6F6aPdhj1XER8Naq0d9pRSf7OXD6Jt00XffbC3MNuIm4zEXfI2f8/TVo5MxUJFwy 1vLEPd2YxSjhtH8ORD/BveYIi7lsIYMfkpuSBJqOKgBe+Q8gZVL3Ws7T/zcaSTM7OlRt xlvT6+YUSv3hFLXfJ42xJQdp+rqKGR1H0B0woCtr1u4iCwGYDFNbzQ/f4xK7gisaDJdU ArWD9brW6wJMt5YuwuANeRpjvnx9ED3gMHMtK4NTzaDNLARpTkaBujTGV+T0af/vhPpY JCXuUSMqG+O8LWi/Bt+zs7sCX7TKlNRHZ+8iofGdmzGbQwd0dEksSVVOoNfUH2lJa6Nq CvAw== X-Gm-Message-State: AOAM532nDE/0Fh9Q8sGqmADiCHFTtQX0evSJQTL9ThCnP97A0vsuOT88 GdylbQiFV9/ZfE/G/1vxSKdgyL2BtzUE X-Google-Smtp-Source: ABdhPJxqE0FK36N/zbPltFvdN3+0L1NaNwJqBtogZodPV1uz0vELjSDJB177+wPeghZR0WKsOq6O+qU4Wrfv X-Received: from irogers.svl.corp.google.com ([2620:15c:2cd:202:2a5e:db66:d206:cbaf]) (user=irogers job=sendgmr) by 2002:a25:3757:0:b0:64d:775d:7036 with SMTP id e84-20020a253757000000b0064d775d7036mr5091438yba.635.1652636170500; Sun, 15 May 2022 10:36:10 -0700 (PDT) Date: Sun, 15 May 2022 10:35:58 -0700 In-Reply-To: <20220515173558.2289702-1-irogers@google.com> Message-Id: <20220515173558.2289702-3-irogers@google.com> Mime-Version: 1.0 References: <20220515173558.2289702-1-irogers@google.com> X-Mailer: git-send-email 2.36.0.550.gb090851708-goog Subject: [PATCH 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 | 90 +++++++++++ tools/perf/tests/shell/stat+json_output.sh | 141 ++++++++++++++++++ 2 files changed, 231 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..3d7404bf6e0b --- /dev/null +++ b/tools/perf/tests/shell/lib/perf_json_output_lint.py @@ -0,0 +1,90 @@ +#!/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. + +from __future__ import print_function +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 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: + raise RuntimeError('wrong number of fields. counted {0}' + ' expected {1} in {2}\n'.format(count, exp, l= ine)) + checks =3D { + 'aggregate-number': lambda x: isfloat(x), + 'core': lambda x: True, + 'counter-value': lambda x: isfloat(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 not key 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..7b3745f3eeb8 --- /dev/null +++ b/tools/perf/tests/shell/stat+json_output.sh @@ -0,0 +1,141 @@ +#!/bin/bash +# perf stat JSON output linter +# SPDX-License-Identifier: GPL-2.0 +# 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] parnoia 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 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] parnoia 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] parnoia 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] parnoia 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] parnoia 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] parnoia 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.0.550.gb090851708-goog