perf tools: Add printing perf_event_attr config symbol in perf_event_attr__fprintf()
authorYang Jihong <yangjihong1@huawei.com>
Fri, 23 Jun 2023 05:44:16 +0000 (05:44 +0000)
committerNamhyung Kim <namhyung@kernel.org>
Sat, 24 Jun 2023 05:30:42 +0000 (22:30 -0700)
When printing perf_event_attr, always display perf_event_attr config and
its symbol to improve the readability of debugging information.

Before:

  # perf --debug verbose=2 record -e cycles,cpu-clock,sched:sched_switch,branch-load-misses,r101,mem:0x0 -C 0 true
  <SNIP>
  ------------------------------------------------------------
  perf_event_attr:
    size                             136
    { sample_period, sample_freq }   4000
    sample_type                      IP|TID|TIME|CPU|PERIOD|IDENTIFIER
    read_format                      ID
    disabled                         1
    inherit                          1
    freq                             1
    sample_id_all                    1
    exclude_guest                    1
  ------------------------------------------------------------
  sys_perf_event_open: pid -1  cpu 0  group_fd -1  flags 0x8 = 5
  ------------------------------------------------------------
  perf_event_attr:
    type                             1
    size                             136
    { sample_period, sample_freq }   4000
    sample_type                      IP|TID|TIME|CPU|PERIOD|IDENTIFIER
    read_format                      ID
    disabled                         1
    inherit                          1
    freq                             1
    sample_id_all                    1
    exclude_guest                    1
  ------------------------------------------------------------
  sys_perf_event_open: pid -1  cpu 0  group_fd -1  flags 0x8 = 6
  ------------------------------------------------------------
  perf_event_attr:
    type                             2
    size                             136
    config                           0x143
    { sample_period, sample_freq }   1
    sample_type                      IP|TID|TIME|CPU|PERIOD|RAW|IDENTIFIER
    read_format                      ID
    disabled                         1
    inherit                          1
    sample_id_all                    1
    exclude_guest                    1
  ------------------------------------------------------------
  sys_perf_event_open: pid -1  cpu 0  group_fd -1  flags 0x8 = 7
  ------------------------------------------------------------
  perf_event_attr:
    type                             3
    size                             136
    config                           0x10005
    { sample_period, sample_freq }   4000
    sample_type                      IP|TID|TIME|CPU|PERIOD|IDENTIFIER
    read_format                      ID
    disabled                         1
    inherit                          1
    freq                             1
    sample_id_all                    1
    exclude_guest                    1
  ------------------------------------------------------------
  sys_perf_event_open: pid -1  cpu 0  group_fd -1  flags 0x8 = 9
  ------------------------------------------------------------
  perf_event_attr:
    type                             4
    size                             136
    config                           0x101
    { sample_period, sample_freq }   4000
    sample_type                      IP|TID|TIME|CPU|PERIOD|IDENTIFIER
    read_format                      ID
    disabled                         1
    inherit                          1
    freq                             1
    sample_id_all                    1
    exclude_guest                    1
  ------------------------------------------------------------
  sys_perf_event_open: pid -1  cpu 0  group_fd -1  flags 0x8 = 10
  ------------------------------------------------------------
  perf_event_attr:
    type                             5
    size                             136
    { sample_period, sample_freq }   1
    sample_type                      IP|TID|TIME|CPU|IDENTIFIER
    read_format                      ID
    disabled                         1
    inherit                          1
    sample_id_all                    1
    exclude_guest                    1
    bp_type                          3
    { bp_len, config2 }              0x4
  ------------------------------------------------------------
  sys_perf_event_open: pid -1  cpu 0  group_fd -1  flags 0x8 = 11
  <SNIP>

After:

  # perf --debug verbose=2 record -e cycles,cpu-clock,sched:sched_switch,branch-load-misses,r101,mem:0x0 -C 0 true
  <SNIP>
  ------------------------------------------------------------
  perf_event_attr:
    type                             0 (PERF_TYPE_HARDWARE)
    size                             136
    config                           0 (PERF_COUNT_HW_CPU_CYCLES)
    { sample_period, sample_freq }   4000
    sample_type                      IP|TID|TIME|CPU|PERIOD|IDENTIFIER
    read_format                      ID
    disabled                         1
    inherit                          1
    freq                             1
    sample_id_all                    1
    exclude_guest                    1
  ------------------------------------------------------------
  sys_perf_event_open: pid -1  cpu 0  group_fd -1  flags 0x8 = 5
  ------------------------------------------------------------
  perf_event_attr:
    type                             1 (PERF_TYPE_SOFTWARE)
    size                             136
    config                           0 (PERF_COUNT_SW_CPU_CLOCK)
    { sample_period, sample_freq }   4000
    sample_type                      IP|TID|TIME|CPU|PERIOD|IDENTIFIER
    read_format                      ID
    disabled                         1
    inherit                          1
    freq                             1
    sample_id_all                    1
    exclude_guest                    1
  ------------------------------------------------------------
  sys_perf_event_open: pid -1  cpu 0  group_fd -1  flags 0x8 = 6
  ------------------------------------------------------------
  perf_event_attr:
    type                             2 (PERF_TYPE_TRACEPOINT)
    size                             136
    config                           0x143 (sched:sched_switch)
    { sample_period, sample_freq }   1
    sample_type                      IP|TID|TIME|CPU|PERIOD|RAW|IDENTIFIER
    read_format                      ID
    disabled                         1
    inherit                          1
    sample_id_all                    1
    exclude_guest                    1
  ------------------------------------------------------------
  sys_perf_event_open: pid -1  cpu 0  group_fd -1  flags 0x8 = 7
  ------------------------------------------------------------
  perf_event_attr:
    type                             3 (PERF_TYPE_HW_CACHE)
    size                             136
    config                           0x10005 (PERF_COUNT_HW_CACHE_RESULT_MISS | PERF_COUNT_HW_CACHE_OP_READ | PERF_COUNT_HW_CACHE_BPU)
    { sample_period, sample_freq }   4000
    sample_type                      IP|TID|TIME|CPU|PERIOD|IDENTIFIER
    read_format                      ID
    disabled                         1
    inherit                          1
    freq                             1
    sample_id_all                    1
    exclude_guest                    1
  ------------------------------------------------------------
  sys_perf_event_open: pid -1  cpu 0  group_fd -1  flags 0x8 = 9
  ------------------------------------------------------------
  perf_event_attr:
    type                             4 (PERF_TYPE_RAW)
    size                             136
    config                           0x101
    { sample_period, sample_freq }   4000
    sample_type                      IP|TID|TIME|CPU|PERIOD|IDENTIFIER
    read_format                      ID
    disabled                         1
    inherit                          1
    freq                             1
    sample_id_all                    1
    exclude_guest                    1
  ------------------------------------------------------------
  sys_perf_event_open: pid -1  cpu 0  group_fd -1  flags 0x8 = 10
  ------------------------------------------------------------
  perf_event_attr:
    type                             5 (PERF_TYPE_BREAKPOINT)
    size                             136
    config                           0
    { sample_period, sample_freq }   1
    sample_type                      IP|TID|TIME|CPU|IDENTIFIER
    read_format                      ID
    disabled                         1
    inherit                          1
    sample_id_all                    1
    exclude_guest                    1
    bp_type                          3
    { bp_len, config2 }              0x4
  ------------------------------------------------------------
  sys_perf_event_open: pid -1  cpu 0  group_fd -1  flags 0x8 = 11
  ------------------------------------------------------------
  perf_event_attr:
    type                             1 (PERF_TYPE_SOFTWARE)
    size                             136
    config                           0x9 (PERF_COUNT_SW_DUMMY)
    { sample_period, sample_freq }   4000
    sample_type                      IP|TID|TIME|CPU|PERIOD|IDENTIFIER
    read_format                      ID
    inherit                          1
    mmap                             1
    comm                             1
    freq                             1
    task                             1
    sample_id_all                    1
    mmap2                            1
    comm_exec                        1
    ksymbol                          1
    bpf_event                        1
  ------------------------------------------------------------
  sys_perf_event_open: pid -1  cpu 0  group_fd -1  flags 0x8 = 12
  <SNIP>

Signed-off-by: Yang Jihong <yangjihong1@huawei.com>
Acked-by: Adrian Hunter <adrian.hunter@intel.com>
Cc: anshuman.khandual@arm.com
Cc: mark.rutland@arm.com
Cc: irogers@google.com
Cc: jesussanp@google.com
Cc: peterz@infradead.org
Cc: acme@kernel.org
Cc: jolsa@kernel.org
Cc: alexander.shishkin@linux.intel.com
Cc: mingo@redhat.com
Link: https://lore.kernel.org/r/20230623054416.160858-5-yangjihong1@huawei.com
[ fix perf import test by adding a dummy tracepoint_id__to_name() ]
Signed-off-by: Namhyung Kim <namhyung@kernel.org>
tools/perf/util/perf_event_attr_fprintf.c
tools/perf/util/python.c

index b16521afc31d36d35b09f2c216e004a506504fcb..2247991451f3aa1ba0969b9ad4f1f22e595b2a21 100644 (file)
@@ -1,11 +1,13 @@
 // SPDX-License-Identifier: GPL-2.0
 #include <inttypes.h>
 #include <stdio.h>
+#include <stdlib.h>
 #include <stdbool.h>
 #include <linux/kernel.h>
 #include <linux/types.h>
 #include <linux/perf_event.h>
 #include "util/evsel_fprintf.h"
+#include "trace-event.h"
 
 struct bit_names {
        int bit;
@@ -85,6 +87,80 @@ static const char *stringify_perf_type_id(u64 value)
                return NULL;
        }
 }
+
+static const char *stringify_perf_hw_id(u64 value)
+{
+       switch (value) {
+       ENUM_ID_TO_STR_CASE(PERF_COUNT_HW_CPU_CYCLES)
+       ENUM_ID_TO_STR_CASE(PERF_COUNT_HW_INSTRUCTIONS)
+       ENUM_ID_TO_STR_CASE(PERF_COUNT_HW_CACHE_REFERENCES)
+       ENUM_ID_TO_STR_CASE(PERF_COUNT_HW_CACHE_MISSES)
+       ENUM_ID_TO_STR_CASE(PERF_COUNT_HW_BRANCH_INSTRUCTIONS)
+       ENUM_ID_TO_STR_CASE(PERF_COUNT_HW_BRANCH_MISSES)
+       ENUM_ID_TO_STR_CASE(PERF_COUNT_HW_BUS_CYCLES)
+       ENUM_ID_TO_STR_CASE(PERF_COUNT_HW_STALLED_CYCLES_FRONTEND)
+       ENUM_ID_TO_STR_CASE(PERF_COUNT_HW_STALLED_CYCLES_BACKEND)
+       ENUM_ID_TO_STR_CASE(PERF_COUNT_HW_REF_CPU_CYCLES)
+       default:
+               return NULL;
+       }
+}
+
+static const char *stringify_perf_hw_cache_id(u64 value)
+{
+       switch (value) {
+       ENUM_ID_TO_STR_CASE(PERF_COUNT_HW_CACHE_L1D)
+       ENUM_ID_TO_STR_CASE(PERF_COUNT_HW_CACHE_L1I)
+       ENUM_ID_TO_STR_CASE(PERF_COUNT_HW_CACHE_LL)
+       ENUM_ID_TO_STR_CASE(PERF_COUNT_HW_CACHE_DTLB)
+       ENUM_ID_TO_STR_CASE(PERF_COUNT_HW_CACHE_ITLB)
+       ENUM_ID_TO_STR_CASE(PERF_COUNT_HW_CACHE_BPU)
+       ENUM_ID_TO_STR_CASE(PERF_COUNT_HW_CACHE_NODE)
+       default:
+               return NULL;
+       }
+}
+
+static const char *stringify_perf_hw_cache_op_id(u64 value)
+{
+       switch (value) {
+       ENUM_ID_TO_STR_CASE(PERF_COUNT_HW_CACHE_OP_READ)
+       ENUM_ID_TO_STR_CASE(PERF_COUNT_HW_CACHE_OP_WRITE)
+       ENUM_ID_TO_STR_CASE(PERF_COUNT_HW_CACHE_OP_PREFETCH)
+       default:
+               return NULL;
+       }
+}
+
+static const char *stringify_perf_hw_cache_op_result_id(u64 value)
+{
+       switch (value) {
+       ENUM_ID_TO_STR_CASE(PERF_COUNT_HW_CACHE_RESULT_ACCESS)
+       ENUM_ID_TO_STR_CASE(PERF_COUNT_HW_CACHE_RESULT_MISS)
+       default:
+               return NULL;
+       }
+}
+
+static const char *stringify_perf_sw_id(u64 value)
+{
+       switch (value) {
+       ENUM_ID_TO_STR_CASE(PERF_COUNT_SW_CPU_CLOCK)
+       ENUM_ID_TO_STR_CASE(PERF_COUNT_SW_TASK_CLOCK)
+       ENUM_ID_TO_STR_CASE(PERF_COUNT_SW_PAGE_FAULTS)
+       ENUM_ID_TO_STR_CASE(PERF_COUNT_SW_CONTEXT_SWITCHES)
+       ENUM_ID_TO_STR_CASE(PERF_COUNT_SW_CPU_MIGRATIONS)
+       ENUM_ID_TO_STR_CASE(PERF_COUNT_SW_PAGE_FAULTS_MIN)
+       ENUM_ID_TO_STR_CASE(PERF_COUNT_SW_PAGE_FAULTS_MAJ)
+       ENUM_ID_TO_STR_CASE(PERF_COUNT_SW_ALIGNMENT_FAULTS)
+       ENUM_ID_TO_STR_CASE(PERF_COUNT_SW_EMULATION_FAULTS)
+       ENUM_ID_TO_STR_CASE(PERF_COUNT_SW_DUMMY)
+       ENUM_ID_TO_STR_CASE(PERF_COUNT_SW_BPF_OUTPUT)
+       ENUM_ID_TO_STR_CASE(PERF_COUNT_SW_CGROUP_SWITCHES)
+       default:
+               return NULL;
+       }
+}
 #undef ENUM_ID_TO_STR_CASE
 
 #define PRINT_ID(_s, _f)                                       \
@@ -96,12 +172,71 @@ do {                                                               \
                snprintf(buf, size, _f" (%s)", value, __s);     \
 } while (0)
 #define print_id_unsigned(_s)  PRINT_ID(_s, "%"PRIu64)
+#define print_id_hex(_s)       PRINT_ID(_s, "%#"PRIx64)
 
 static void __p_type_id(char *buf, size_t size, u64 value)
 {
        print_id_unsigned(stringify_perf_type_id(value));
 }
 
+static void __p_config_hw_id(char *buf, size_t size, u64 value)
+{
+       print_id_hex(stringify_perf_hw_id(value));
+}
+
+static void __p_config_sw_id(char *buf, size_t size, u64 value)
+{
+       print_id_hex(stringify_perf_sw_id(value));
+}
+
+static void __p_config_hw_cache_id(char *buf, size_t size, u64 value)
+{
+       const char *hw_cache_str = stringify_perf_hw_cache_id(value & 0xff);
+       const char *hw_cache_op_str =
+               stringify_perf_hw_cache_op_id((value & 0xff00) >> 8);
+       const char *hw_cache_op_result_str =
+               stringify_perf_hw_cache_op_result_id((value & 0xff0000) >> 16);
+
+       if (hw_cache_str == NULL || hw_cache_op_str == NULL ||
+           hw_cache_op_result_str == NULL) {
+               snprintf(buf, size, "%#"PRIx64, value);
+       } else {
+               snprintf(buf, size, "%#"PRIx64" (%s | %s | %s)", value,
+                        hw_cache_op_result_str, hw_cache_op_str, hw_cache_str);
+       }
+}
+
+#ifdef HAVE_LIBTRACEEVENT
+static void __p_config_tracepoint_id(char *buf, size_t size, u64 value)
+{
+       char *str = tracepoint_id_to_name(value);
+
+       print_id_hex(str);
+       free(str);
+}
+#endif
+
+static void __p_config_id(char *buf, size_t size, u32 type, u64 value)
+{
+       switch (type) {
+       case PERF_TYPE_HARDWARE:
+               return __p_config_hw_id(buf, size, value);
+       case PERF_TYPE_SOFTWARE:
+               return __p_config_sw_id(buf, size, value);
+       case PERF_TYPE_HW_CACHE:
+               return __p_config_hw_cache_id(buf, size, value);
+       case PERF_TYPE_TRACEPOINT:
+#ifdef HAVE_LIBTRACEEVENT
+               return __p_config_tracepoint_id(buf, size, value);
+#endif
+       case PERF_TYPE_RAW:
+       case PERF_TYPE_BREAKPOINT:
+       default:
+               snprintf(buf, size, "%#"PRIx64, value);
+               return;
+       }
+}
+
 #define BUF_SIZE               1024
 
 #define p_hex(val)             snprintf(buf, BUF_SIZE, "%#"PRIx64, (uint64_t)(val))
@@ -111,6 +246,7 @@ static void __p_type_id(char *buf, size_t size, u64 value)
 #define p_branch_sample_type(val) __p_branch_sample_type(buf, BUF_SIZE, val)
 #define p_read_format(val)     __p_read_format(buf, BUF_SIZE, val)
 #define p_type_id(val)         __p_type_id(buf, BUF_SIZE, val)
+#define p_config_id(val)       __p_config_id(buf, BUF_SIZE, attr->type, val)
 
 #define PRINT_ATTRn(_n, _f, _p, _a)                    \
 do {                                                   \
@@ -130,7 +266,7 @@ int perf_event_attr__fprintf(FILE *fp, struct perf_event_attr *attr,
 
        PRINT_ATTRn("type", type, p_type_id, true);
        PRINT_ATTRf(size, p_unsigned);
-       PRINT_ATTRf(config, p_hex);
+       PRINT_ATTRn("config", config, p_config_id, true);
        PRINT_ATTRn("{ sample_period, sample_freq }", sample_period, p_unsigned, false);
        PRINT_ATTRf(sample_type, p_sample_type);
        PRINT_ATTRf(read_format, p_read_format);
index a7b2cb05dc86170032f58c39dea228fe28cc0503..4eed8ec239948e8b9e30028bb403312a254b36c8 100644 (file)
@@ -123,6 +123,14 @@ int metricgroup__copy_metric_events(struct evlist *evlist, struct cgroup *cgrp,
        return 0;
 }
 
+/*
+ * Add this one here not to drag util/trace-event-info.c
+ */
+char *tracepoint_id_to_name(u64 config)
+{
+       return NULL;
+}
+
 /*
  * XXX: All these evsel destructors need some better mechanism, like a linked
  * list of destructors registered when the relevant code indeed is used instead