New perf ilist app
Ian Rogers
reviewerv5 cover New perf ilist app
(Resend, accidentally move 2 patches in a rebase and sent those patches twice)
This patch series builds up to the addition of a new ilist app written in python using textual [1] for the UI. The app presents perf PMUs and events, displays the event information as in perf list while at the bottom of the console showing recent activity of the event in total and across all CPUs. It also displays metrics, placed in a tree through their metric group, again with counts being displayed in the bottom panel.
The first ground work patches of fixes, cleanup and refactoring were separated into their own series here:
https://lore.kernel.org/lkml/[email protected]/
The second part of the patches adds event json for the software PMU and makes the tracepoint PMU support iteration of events and the like. Without these improvements the tracepoint and software PMUs will appear to have no events in the ilist app. As the software PMU moves parsing to json, the legacy hard coded parsing is removed. This has proven controversial for hardware events and so that cleanup isn't done here.
The final patches expand the perf python APIs and add the ilist command. To run it you need the updated perf.cpython.so in your PYTHONPATH and then execute the script. Expanding PMUs and then selecting events will cause event informatin to be displayed in the top-right and the counters values to be displayed as sparklines and counts in the bottom half of the screen.
[1] https://textual.textualize.io/
v5: Split the series in two. Add metric support. Various clean ups and
tweaks to the app in particular around the handling of searches.
v4: No conflict rebase. Picks up perf-tools-next DRM PMU which
displays as expected.
v3: Add a search dialog to the ilist app with 'n'ext and 'p'revious
keys. No changes in the ground work first 14 patches.
v2: In the jevents event description duplication, some minor changes
accidentally missed from v1 meaning that in v1 the descriptions were still duplicated. Expand the cover letter with some thoughts on the series.
Ian Rogers (14):
perf jevents: Add common software event json
perf parse-events: Remove non-json software events
perf tp_pmu: Factor existing tracepoint logic to new file perf tp_pmu: Add event APIs
perf list: Remove tracepoint printing code
perf list: Skip ABI PMUs when printing pmu values
perf python: Add basic PMU abstraction and pmus sequence perf python: Add function returning dictionary of all events on a PMU perf ilist: Add new python ilist command
perf python: Add parse_metrics function
perf python: Add evlist metrics function
perf python: Add evlist compute_metric
perf python: Add metrics function
perf ilist: Add support for metrics
tools/perf/builtin-list.c | 65 ++- .../arch/common/common/software.json | 92 ++++ tools/perf/pmu-events/empty-pmu-events.c | 266 ++++++---- tools/perf/pmu-events/jevents.py | 15 +- tools/perf/python/ilist.py | 486 ++++++++++++++++++ tools/perf/util/Build | 1 + tools/perf/util/evsel.c | 21 +- tools/perf/util/parse-events.c | 198 +++---- tools/perf/util/parse-events.h | 1 - tools/perf/util/parse-events.l | 38 +- tools/perf/util/parse-events.y | 29 +- tools/perf/util/pmu.c | 7 + tools/perf/util/pmus.c | 2 + tools/perf/util/print-events.c | 100 +--- tools/perf/util/print-events.h | 4 +- tools/perf/util/python.c | 484 +++++++++++++++++ tools/perf/util/tp_pmu.c | 209 ++++++++ tools/perf/util/tp_pmu.h | 19 + 18 files changed, 1609 insertions(+), 428 deletions(-) create mode 100644 tools/perf/pmu-events/arch/common/common/software.json create mode 100755 tools/perf/python/ilist.py create mode 100644 tools/perf/util/tp_pmu.c create mode 100644 tools/perf/util/tp_pmu.h
Signature · 1 line
2.50.0.727.gbf7dc18ff4-goog
Ian Rogers
reviewerPATCH v5 1/14 perf jevents: Add common software event json
Add json for software events so that in perf list the events can have a description. Common json exists for the tool PMU but it has no sysfs equivalent. Modify the map_for_pmu code to return the common map (rather than an architecture specific one) when a PMU with a common name is being looked for, this allows the events to be found.
--- .../arch/common/common/software.json | 92 ++++++ tools/perf/pmu-events/empty-pmu-events.c | 266 +++++++++++------- tools/perf/pmu-events/jevents.py | 15 +- 3 files changed, 264 insertions(+), 109 deletions(-) create mode 100644 tools/perf/pmu-events/arch/common/common/software.json
tools/perf/pmu-events/arch/common/common/software.json new file +92 -0
@@ -0,0 +1,92 @@ +[ + { + "Unit": "software", + "EventName": "cpu-clock", + "BriefDescription": "Per-CPU high-resolution timer based event", + "ConfigCode": "0" + }, + { + "Unit": "software", + "EventName": "task-clock", + "BriefDescription": "Task based high-resolution timer based event", + "ConfigCode": "1" + }, + { + "Unit": "software", + "EventName": "faults", + "BriefDescription": "Number of page faults [This event is an alias of page-faults]", + "ConfigCode": "2" + }, + { + "Unit": "software", + "EventName": "page-faults", + "BriefDescription": "Number of page faults [This event is an alias of faults]", + "ConfigCode": "2" + }, + { + "Unit": "software", + "EventName": "context-switches", + "BriefDescription": "Number of context switches [This event is an alias of cs]", + "ConfigCode": "3" + }, + { + "Unit": "software", + "EventName": "cs", + "BriefDescription": "Number of context switches [This event is an alias of context-switches]", + "ConfigCode": "3" + }, + { + "Unit": "software", + "EventName": "cpu-migrations", + "BriefDescription": "Number of times a process has migrated to a new CPU [This event is an alias of migrations]", + "ConfigCode": "4" + }, + { + "Unit": "software", + "EventName": "migrations", + "BriefDescription": "Number of times a process has migrated to a new CPU [This event is an alias of cpu-migrations]", + "ConfigCode": "4" + }, + { + "Unit": "software", + "EventName": "minor-faults", + "BriefDescription": "Number of minor page faults. Minor faults don't require I/O to handle", + "ConfigCode": "5" + }, + { + "Unit": "software", + "EventName": "major-faults", + "BriefDescription": "Number of major page faults. Major faults require I/O to handle", + "ConfigCode": "6" + }, + { + "Unit": "software", + "EventName": "alignment-faults", + "BriefDescription": "Number of kernel handled memory alignment faults", + "ConfigCode": "7" + }, + { + "Unit": "software", + "EventName": "emulation-faults", + "BriefDescription": "Number of kernel handled unimplemented instruction faults handled through emulation", + "ConfigCode": "8" + }, + { + "Unit": "software", + "EventName": "dummy", + "BriefDescription": "A placeholder event that doesn't count anything", + "ConfigCode": "9" + }, + { + "Unit": "software", + "EventName": "bpf-output", + "BriefDescription": "An event used by BPF programs to write to the perf ring buffer", + "ConfigCode": "10" + }, + { + "Unit": "software", + "EventName": "cgroup-switches", + "BriefDescription": "Number of context switches to a task in a different cgroup", + "ConfigCode": "11" + } +]
tools/perf/pmu-events/empty-pmu-events.c +158 -108
361 lines not on this page · raw message
tools/perf/pmu-events/jevents.py +14 -1
@@ -295,6 +295,7 @@ class JsonEvent: 'cpu_atom': 'cpu_atom', 'ali_drw': 'ali_drw', 'arm_cmn': 'arm_cmn', + 'software': 'software', 'tool': 'tool', } return table[unit] if unit in table else f'uncore_{unit.lower()}'
@@ -1158,8 +1159,20 @@ static const struct pmu_events_map *map_for_pmu(struct perf_pmu *pmu) { struct perf_cpu cpu = {-1}; - if (pmu) + if (pmu) { + for (size_t i=0; i < ARRAY_SIZE(pmu_events__common); i++) { + const char *pmu_name = &big_c_string[pmu_events__common[i].pmu_name.offset]; + + if (!strcmp(pmu_name, pmu->name)) { + const struct pmu_events_map *map = &pmu_events_map[0]; + + while (strcmp("common", map->arch)) + map++; + return map; + } + } cpu = perf_cpu_map__min(pmu->cpus); + } return map_for_cpu(cpu); }
Signature · 1 line
2.50.0.727.gbf7dc18ff4-goog
Ian Rogers
reviewerPATCH v5 2/14 perf parse-events: Remove non-json software events
In reply to Ian RogersRemove the hard coded encodings from parse-events. This has the consequence that software events are matched using the sysfs/json priority, will be case insensitive and will be wildcarded across PMUs. As there were software and hardware types in the parsing code, the removal means software vs hardware logic can be removed and hardware assumed.
Now the perf json provides detailed descriptions of software events, remove the previous listing support that didn't contain event descriptions. When globbing is required for the "sw" option in perf list, use string PMU globbing as was done previously for the tool PMU.
--- tools/perf/builtin-list.c | 19 ++++++------- tools/perf/util/parse-events.c | 51 ---------------------------------- tools/perf/util/parse-events.h | 1 - tools/perf/util/parse-events.l | 38 +++++++++---------------- tools/perf/util/parse-events.y | 29 ++++++++----------- tools/perf/util/print-events.c | 2 -- 6 files changed, 33 insertions(+), 107 deletions(-)
tools/perf/builtin-list.c +9 -10
@@ -623,16 +623,17 @@ int cmd_list(int argc, const char **argv)else if (strcmp (argv[i],"sw" ) ==0 ||strcmp (argv[i],"software" ) ==0 ) {char *old_pmu_glob = default_ps.pmu_glob; +static const char *const sw_globs[] = {"software" ,"tool" }; -print_symbol_events (&print_cb, ps,PERF_TYPE_SOFTWARE , - event_symbols_sw,PERF_COUNT_SW_MAX ); - default_ps.pmu_glob =strdup ("tool" ); -if (!default_ps.pmu_glob) { - ret =-1 ; - goto out; +for (size_t j =0 ; j <ARRAY_SIZE (sw_globs); j++) { + default_ps.pmu_glob =strdup (sw_globs[j]); +if (!default_ps.pmu_glob) { + ret =-1 ; + goto out; + } +perf_pmus__print_pmu_events (&print_cb, ps); +zfree (&default_ps.pmu_glob); } -perf_pmus__print_pmu_events (&print_cb, ps); -zfree (&default_ps.pmu_glob); default_ps.pmu_glob = old_pmu_glob; }else if (strcmp (argv[i],"cache" ) ==0 ||strcmp (argv[i],"hwcache" ) ==0 )
@@ -679,8 +680,6 @@ int cmd_list(int argc, const char **argv) default_ps.event_glob = 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 , - event_symbols_sw,PERF_COUNT_SW_MAX );print_hwcache_events (&print_cb, ps);perf_pmus__print_pmu_events (&print_cb, ps);print_tracepoint_events (&print_cb, ps);
tools/perf/util/parse-events.c +0 -51
57 lines not on this page · raw message
tools/perf/util/parse-events.h +0 -1
@@ -264,7 +264,6 @@ struct event_symbol {const char *alias; };extern const struct event_symbol event_symbols_hw[]; -extern const struct event_symbol event_symbols_sw[];char *parse_events_formats_error_string (char *additional_terms);
tools/perf/util/parse-events.l +13 -25
@@ -117,12 +117,12 @@ do { \ yyless(0); \ } while (0) -static int sym(yyscan_t scanner, int type, int config) +static int sym(yyscan_t scanner, int config) { YYSTYPE *yylval = parse_events_get_lval(scanner); - yylval->num = (type << 16) + config; - return type == PERF_TYPE_HARDWARE ? PE_VALUE_SYM_HW : PE_VALUE_SYM_SW; + yylval->num = config; + return PE_VALUE_SYM_HW; } static int term(yyscan_t scanner, enum parse_events__term_type type)
@@ -391,28 +391,16 @@ r0x{num_raw_hex} { return str(yyscanner, PE_RAW); } <<EOF>> { BEGIN(INITIAL); } } -cpu-cycles|cycles { return sym(yyscanner, PERF_TYPE_HARDWARE, PERF_COUNT_HW_CPU_CYCLES); } -stalled-cycles-frontend|idle-cycles-frontend { return sym(yyscanner, PERF_TYPE_HARDWARE, PERF_COUNT_HW_STALLED_CYCLES_FRONTEND); } -stalled-cycles-backend|idle-cycles-backend { return sym(yyscanner, PERF_TYPE_HARDWARE, PERF_COUNT_HW_STALLED_CYCLES_BACKEND); } -instructions { return sym(yyscanner, PERF_TYPE_HARDWARE, PERF_COUNT_HW_INSTRUCTIONS); } -cache-references { return sym(yyscanner, PERF_TYPE_HARDWARE, PERF_COUNT_HW_CACHE_REFERENCES); } -cache-misses { return sym(yyscanner, PERF_TYPE_HARDWARE, PERF_COUNT_HW_CACHE_MISSES); } -branch-instructions|branches { return sym(yyscanner, PERF_TYPE_HARDWARE, PERF_COUNT_HW_BRANCH_INSTRUCTIONS); } -branch-misses { return sym(yyscanner, PERF_TYPE_HARDWARE, PERF_COUNT_HW_BRANCH_MISSES); } -bus-cycles { return sym(yyscanner, PERF_TYPE_HARDWARE, PERF_COUNT_HW_BUS_CYCLES); } -ref-cycles { return sym(yyscanner, PERF_TYPE_HARDWARE, PERF_COUNT_HW_REF_CPU_CYCLES); } -cpu-clock { return sym(yyscanner, PERF_TYPE_SOFTWARE, PERF_COUNT_SW_CPU_CLOCK); } -task-clock { return sym(yyscanner, PERF_TYPE_SOFTWARE, PERF_COUNT_SW_TASK_CLOCK); } -page-faults|faults { return sym(yyscanner, PERF_TYPE_SOFTWARE, PERF_COUNT_SW_PAGE_FAULTS); } -minor-faults { return sym(yyscanner, PERF_TYPE_SOFTWARE, PERF_COUNT_SW_PAGE_FAULTS_MIN); } -major-faults { return sym(yyscanner, PERF_TYPE_SOFTWARE, PERF_COUNT_SW_PAGE_FAULTS_MAJ); } -context-switches|cs { return sym(yyscanner, PERF_TYPE_SOFTWARE, PERF_COUNT_SW_CONTEXT_SWITCHES); } -cpu-migrations|migrations { return sym(yyscanner, PERF_TYPE_SOFTWARE, PERF_COUNT_SW_CPU_MIGRATIONS); } -alignment-faults { return sym(yyscanner, PERF_TYPE_SOFTWARE, PERF_COUNT_SW_ALIGNMENT_FAULTS); } -emulation-faults { return sym(yyscanner, PERF_TYPE_SOFTWARE, PERF_COUNT_SW_EMULATION_FAULTS); } -dummy { return sym(yyscanner, PERF_TYPE_SOFTWARE, PERF_COUNT_SW_DUMMY); } -bpf-output { return sym(yyscanner, PERF_TYPE_SOFTWARE, PERF_COUNT_SW_BPF_OUTPUT); } -cgroup-switches { return sym(yyscanner, PERF_TYPE_SOFTWARE, PERF_COUNT_SW_CGROUP_SWITCHES); } +cpu-cycles|cycles { return sym(yyscanner, PERF_COUNT_HW_CPU_CYCLES); } +stalled-cycles-frontend|idle-cycles-frontend { return sym(yyscanner, PERF_COUNT_HW_STALLED_CYCLES_FRONTEND); } +stalled-cycles-backend|idle-cycles-backend { return sym(yyscanner, PERF_COUNT_HW_STALLED_CYCLES_BACKEND); } +instructions { return sym(yyscanner, PERF_COUNT_HW_INSTRUCTIONS); } +cache-references { return sym(yyscanner, PERF_COUNT_HW_CACHE_REFERENCES); } +cache-misses { return sym(yyscanner, PERF_COUNT_HW_CACHE_MISSES); } +branch-instructions|branches { return sym(yyscanner, PERF_COUNT_HW_BRANCH_INSTRUCTIONS); } +branch-misses { return sym(yyscanner, PERF_COUNT_HW_BRANCH_MISSES); } +bus-cycles { return sym(yyscanner, PERF_COUNT_HW_BUS_CYCLES); } +ref-cycles { return sym(yyscanner, PERF_COUNT_HW_REF_CPU_CYCLES); } {lc_type} { return str(yyscanner, PE_LEGACY_CACHE); } {lc_type}-{lc_op_result} { return str(yyscanner, PE_LEGACY_CACHE); }
tools/perf/util/parse-events.y +11 -18
@@ -55,7 +55,7 @@ static void free_list_evsel(struct list_head* list_evsel) %} %token PE_START_EVENTS PE_START_TERMS -%token PE_VALUE PE_VALUE_SYM_HW PE_VALUE_SYM_SW PE_TERM +%token PE_VALUE PE_VALUE_SYM_HW PE_TERM %token PE_EVENT_NAME %token PE_RAW PE_NAME %token PE_MODIFIER_EVENT PE_MODIFIER_BP PE_BP_COLON PE_BP_SLASH
@@ -66,10 +66,8 @@ static void free_list_evsel(struct list_head* list_evsel) %token PE_TERM_HW %type <num> PE_VALUE %type <num> PE_VALUE_SYM_HW -%type <num> PE_VALUE_SYM_SW %type <mod> PE_MODIFIER_EVENT %type <term_type> PE_TERM -%type <num> value_sym %type <str> PE_RAW %type <str> PE_NAME %type <str> PE_LEGACY_CACHE
@@ -306,24 +304,19 @@ PE_NAME sep_dc $$ = list; } -value_sym: -PE_VALUE_SYM_HW -| -PE_VALUE_SYM_SW - event_legacy_symbol: -value_sym '/' event_config '/' +PE_VALUE_SYM_HW '/' event_config '/' { struct list_head *list; - int type = $1 >> 16; - int config = $1 & 255; int err; - bool wildcard = (type == PERF_TYPE_HARDWARE || type == PERF_TYPE_HW_CACHE); list = alloc_list(); if (!list) YYNOMEM; - err = parse_events_add_numeric(_parse_state, list, type, config, $3, wildcard); + err = parse_events_add_numeric(_parse_state, list, + PERF_TYPE_HARDWARE, $1, + $3, + /*wildcard=*/true); parse_events_terms__delete($3); if (err) { free_list_evsel(list);
@@ -332,18 +325,18 @@ value_sym '/' event_config '/' $$ = list; } | -value_sym sep_slash_slash_dc +PE_VALUE_SYM_HW sep_slash_slash_dc { struct list_head *list; - int type = $1 >> 16; - int config = $1 & 255; - bool wildcard = (type == PERF_TYPE_HARDWARE || type == PERF_TYPE_HW_CACHE); int err; list = alloc_list(); if (!list) YYNOMEM; - err = parse_events_add_numeric(_parse_state, list, type, config, /*head_config=*/NULL, wildcard); + err = parse_events_add_numeric(_parse_state, list, + PERF_TYPE_HARDWARE, $1, + /*head_config=*/NULL, + /*wildcard=*/true); if (err) PE_ABORT(err); $$ = list;
tools/perf/util/print-events.c +0 -2
@@ -521,8 +521,6 @@ void print_events(const struct print_callbacks *print_cb, void *print_state) {print_symbol_events (print_cb, print_state,PERF_TYPE_HARDWARE , event_symbols_hw,PERF_COUNT_HW_MAX ); -print_symbol_events (print_cb, print_state,PERF_TYPE_SOFTWARE , - event_symbols_sw,PERF_COUNT_SW_MAX );print_hwcache_events (print_cb, print_state);
Signature · 1 line
2.50.0.727.gbf7dc18ff4-goog
Ian Rogers
reviewerPATCH v5 3/14 perf tp_pmu: Factor existing tracepoint logic to new file
In reply to Ian RogersStart the creation of a tracepoint PMU abstraction. Tracepoint events don't follow the regular sysfs perf conventions. Eventually the new PMU abstraction will bridge the gap so tracepoint events look more like regular perf ones.
--- tools/perf/util/Build | 1 + tools/perf/util/evsel.c | 21 +---- tools/perf/util/parse-events.c | 147 ++++++++++++++------------------- tools/perf/util/tp_pmu.c | 95 +++++++++++++++++++++ tools/perf/util/tp_pmu.h | 12 +++ 5 files changed, 170 insertions(+), 106 deletions(-) create mode 100644 tools/perf/util/tp_pmu.c create mode 100644 tools/perf/util/tp_pmu.h
tools/perf/util/Build +1 -0
@@ -88,6 +88,7 @@ perf-util-y += pmu-bison.o perf-util-y += drm_pmu.o perf-util-y += hwmon_pmu.o perf-util-y += tool_pmu.o +perf-util-y += tp_pmu.o perf-util-y += svghelper.o perf-util-y += trace-event-info.o perf-util-y += trace-event-scripting.o
tools/perf/util/evsel.c +2 -19
@@ -59,6 +59,7 @@#include "drm_pmu.h" #include "hwmon_pmu.h" #include "tool_pmu.h" +#include "tp_pmu.h" #include "rlimit.h" #include "../perf-sys.h" #include "util/parse-branch-options.h"
@@ -571,24 +572,6 @@ struct evsel *evsel__clone(struct evsel *dest, struct evsel *orig)return NULL ; } -static int trace_event__id (const char *sys,const char *name) -{ -char *tp_dir =get_events_file (sys); -char path[PATH_MAX ]; -int id, err; - -if (!tp_dir) -return -1 ; - -scnprintf (path,PATH_MAX ,"%s/%s/id" , tp_dir, name); -put_events_file (tp_dir); - err =filename__read_int (path, &id); -if (err) -return err; - -return id; -} -/* * Returns pointer with encoded error via <linux/err.h> interface. */
@@ -622,7 +605,7 @@ struct evsel *evsel__newtp_idx(const char *sys, const char *name, int idx, boolevent_attr_init (&attr);if (format) { - id =trace_event__id (sys, name); + id =tp_pmu__id (sys, name);if (id <0 ) { err = id; goto out_free;
tools/perf/util/parse-events.c +60 -87
196 lines not on this page · raw message
tools/perf/util/tp_pmu.c new file +95 -0
95 lines not on this page · raw message
tools/perf/util/tp_pmu.h new file +12 -0
@@ -0,0 +1,12 @@ +/* SPDX-License-Identifier: (LGPL-2.1 OR BSD-2-Clause) */ +#ifndef __TP_PMU_H +#define __TP_PMU_H + +typedef int (*tp_sys_callback )(void *state,const char *sys_name); +typedef int (*tp_event_callback )(void *state,const char *sys_name,const char *evt_name); + +int tp_pmu__id (const char *sys,const char *name); +int tp_pmu__for_each_tp_event (const char *sys,void *state,tp_event_callback cb); +int tp_pmu__for_each_tp_sys (void *state,tp_sys_callback cb); + +#endif /* __TP_PMU_H */
Signature · 1 line
2.50.0.727.gbf7dc18ff4-goog
Ian Rogers
reviewerPATCH v5 4/14 perf tp_pmu: Add event APIs
In reply to Ian RogersAdd event APIs for the tracepoint PMU allowing things like perf list to function using it. For perf list add the tracepoint format in the long description (shown with -v).
--- tools/perf/util/pmu.c | 7 +++ tools/perf/util/tp_pmu.c | 114 +++++++++++++++++++++++++++++++++++++++ tools/perf/util/tp_pmu.h | 7 +++ 3 files changed, 128 insertions(+)
tools/perf/util/pmu.c +7 -0
@@ -24,6 +24,7 @@#include "hwmon_pmu.h" #include "pmus.h" #include "tool_pmu.h" +#include "tp_pmu.h" #include <util/pmu-bison.h> #include <util/pmu-flex.h> #include "parse-events.h"
@@ -1983,6 +1984,8 @@ bool perf_pmu__have_event(struct perf_pmu *pmu, const char *name)return false;if (perf_pmu__is_tool (pmu) &&tool_pmu__skip_event (name))return false; +if (perf_pmu__is_tracepoint (pmu)) +return tp_pmu__have_event (pmu, name);if (perf_pmu__is_hwmon (pmu))return hwmon_pmu__have_event (pmu, name);if (perf_pmu__is_drm (pmu))
@@ -1998,6 +2001,8 @@ size_t perf_pmu__num_events(struct perf_pmu *pmu) {size_t nr; +if (perf_pmu__is_tracepoint (pmu)) +return tp_pmu__num_events (pmu);if (perf_pmu__is_hwmon (pmu))return hwmon_pmu__num_events (pmu);if (perf_pmu__is_drm (pmu))
@@ -2068,6 +2073,8 @@ int perf_pmu__for_each_event(struct perf_pmu *pmu, bool skip_duplicate_pmus,struct hashmap_entry *entry;size_t bkt; +if (perf_pmu__is_tracepoint (pmu)) +return tp_pmu__for_each_event (pmu, state, cb);if (perf_pmu__is_hwmon (pmu))return hwmon_pmu__for_each_event (pmu, state, cb);if (perf_pmu__is_drm (pmu))
tools/perf/util/tp_pmu.c +114 -0
122 lines not on this page · raw message
tools/perf/util/tp_pmu.h +7 -0
@@ -2,6 +2,8 @@#ifndef __TP_PMU_H#define __TP_PMU_H +#include "pmu.h" +typedef int (*tp_sys_callback )(void *state,const char *sys_name);typedef int (*tp_event_callback )(void *state,const char *sys_name,const char *evt_name);
@@ -9,4 +11,9 @@ int tp_pmu__id(const char *sys, const char *name);int tp_pmu__for_each_tp_event (const char *sys,void *state,tp_event_callback cb);int tp_pmu__for_each_tp_sys (void *state,tp_sys_callback cb); +bool perf_pmu__is_tracepoint (const struct perf_pmu *pmu); +int tp_pmu__for_each_event (struct perf_pmu *pmu,void *state,pmu_event_callback cb); +size_t tp_pmu__num_events (struct perf_pmu *pmu); +bool tp_pmu__have_event (struct perf_pmu *pmu,const char *name); +#endif /* __TP_PMU_H */
Signature · 1 line
2.50.0.727.gbf7dc18ff4-goog
Ian Rogers
reviewerPATCH v5 5/14 perf list: Remove tracepoint printing code
In reply to Ian RogersNow that the tp_pmu can iterate and describe events remove the custom tracepoint printing logic, this avoids perf list showing the tracepoint events twice.
--- tools/perf/builtin-list.c | 29 ++++++++--- tools/perf/util/print-events.c | 93 ---------------------------------- tools/perf/util/print-events.h | 2 - 3 files changed, 23 insertions(+), 101 deletions(-)
tools/perf/builtin-list.c +23 -6
@@ -614,9 +614,18 @@ int cmd_list(int argc, const char **argv)for (i =0 ; i < argc; ++i) {char *sep, *s; -if (strcmp (argv[i],"tracepoint" ) ==0 ) -print_tracepoint_events (&print_cb, ps); -else if (strcmp (argv[i],"hw" ) ==0 || +if (strcmp (argv[i],"tracepoint" ) ==0 ) { +char *old_pmu_glob = default_ps.pmu_glob; + + default_ps.pmu_glob =strdup ("tracepoint" ); +if (!default_ps.pmu_glob) { + ret =-1 ; + goto out; + } +perf_pmus__print_pmu_events (&print_cb, ps); +zfree (&default_ps.pmu_glob); + default_ps.pmu_glob = old_pmu_glob; + }else if (strcmp (argv[i],"hw" ) ==0 ||strcmp (argv[i],"hardware" ) ==0 )print_symbol_events (&print_cb, ps,PERF_TYPE_HARDWARE , event_symbols_hw,PERF_COUNT_HW_MAX );
@@ -658,6 +667,7 @@ int cmd_list(int argc, const char **argv)#endif else if ((sep = strchr(argv[i], ':')) != NULL) { char *old_pmu_glob = default_ps.pmu_glob; +char *old_event_glob = default_ps.event_glob; default_ps.event_glob =strdup (argv[i]);if (!default_ps.event_glob) {
@@ -665,13 +675,21 @@ int cmd_list(int argc, const char **argv) goto out; } -print_tracepoint_events (&print_cb, ps); + default_ps.pmu_glob =strdup ("tracepoint" ); +if (!default_ps.pmu_glob) { +zfree (&default_ps.event_glob); + ret =-1 ; + goto out; + } +perf_pmus__print_pmu_events (&print_cb, ps); +zfree (&default_ps.pmu_glob); + default_ps.pmu_glob = old_pmu_glob;print_sdt_events (&print_cb, ps); default_ps.metrics = true; default_ps.metricgroups = true;metricgroup__print (&print_cb, ps);zfree (&default_ps.event_glob); - default_ps.pmu_glob = old_pmu_glob; + default_ps.event_glob = old_event_glob; }else {if (asprintf (&s,"*%s*" , argv[i]) <0 ) {printf ("Critical: Not enough memory! Trying to continue...\n" );
@@ -682,7 +700,6 @@ int cmd_list(int argc, const char **argv) event_symbols_hw, PERF_COUNT_HW_MAX);print_hwcache_events (&print_cb, ps);perf_pmus__print_pmu_events (&print_cb, ps); -print_tracepoint_events (&print_cb, ps);print_sdt_events (&print_cb, ps); default_ps.metrics = true; default_ps.metricgroups = true;
tools/perf/util/print-events.c +0 -93
105 lines not on this page · raw message
tools/perf/util/print-events.h +0 -2
@@ -37,8 +37,6 @@ void print_sdt_events(const struct print_callbacks *print_cb, void *print_state)void print_symbol_events (const struct print_callbacks *print_cb,void *print_state,unsigned int type,const struct event_symbol *syms,unsigned int max); - -void print_tracepoint_events (const struct print_callbacks *print_cb,void *print_state);void metricgroup__print (const struct print_callbacks *print_cb,void *print_state);bool is_event_supported (u8 type,u64 config);
Signature · 1 line
2.50.0.727.gbf7dc18ff4-goog
Ian Rogers
reviewerPATCH v5 6/14 perf list: Skip ABI PMUs when printing pmu values
In reply to Ian RogersAvoid printing tracepoint, legacy and software events when listing for the pmu option. Add the PMU type to the print_event callbacks to ease detection.
--- tools/perf/builtin-list.c | 17 +++++++++++++---- tools/perf/util/pmus.c | 2 ++ tools/perf/util/print-events.c | 5 +++++ tools/perf/util/print-events.h | 2 +- 4 files changed, 21 insertions(+), 5 deletions(-)
tools/perf/builtin-list.c +13 -4
@@ -58,6 +58,8 @@ struct print_state {bool metrics;/** @metricgroups: Controls printing of metric and metric groups. */ bool metricgroups; +/** @exclude_abi: Exclude PMUs with types less than PERF_TYPE_MAX except PERF_TYPE_RAW. */ +bool exclude_abi;/** @last_topic: The last printed event topic. */ char *last_topic;/** @last_metricgroups: The last printed metric group. */
@@ -113,7 +115,8 @@ static void wordwrap(FILE *fp, const char *s, int start, int max, int corr) } } -static void default_print_event(void *ps, const char *topic, const char *pmu_name, +static void default_print_event(void *ps, const char *topic, + const char *pmu_name, u32 pmu_type, const char *event_name, const char *event_alias, const char *scale_unit __maybe_unused, bool deprecated, const char *event_type_desc,
@@ -130,6 +133,9 @@ static void default_print_event(void *ps, const char *topic, const char *pmu_namif (print_state->pmu_glob && pmu_name && !strglobmatch (pmu_name, print_state->pmu_glob))return ; +if (print_state->exclude_abi && pmu_type <PERF_TYPE_MAX && pmu_type !=PERF_TYPE_RAW ) +return ; + if (print_state->event_glob && (!event_name || !strglobmatch(event_name, print_state->event_glob)) && (!event_alias || !strglobmatch(event_alias, print_state->event_glob)) &&
@@ -354,7 +360,8 @@ static void fix_escape_fprintf(FILE *fp, struct strbuf *buf, const char *fmt, ..fputs (buf->buf, fp); } -static void json_print_event(void *ps, const char *topic, const char *pmu_name, +static void json_print_event(void *ps, const char *topic, + const char *pmu_name, u32 pmu_type __maybe_unused, const char *event_name, const char *event_alias, const char *scale_unit, bool deprecated, const char *event_type_desc,
@@ -647,9 +654,11 @@ int cmd_list(int argc, const char **argv) }else if (strcmp (argv[i],"cache" ) ==0 ||strcmp (argv[i],"hwcache" ) ==0 )print_hwcache_events (&print_cb, ps); -else if (strcmp (argv[i],"pmu" ) ==0 ) +else if (strcmp (argv[i],"pmu" ) ==0 ) { + default_ps.exclude_abi = true;perf_pmus__print_pmu_events (&print_cb, ps); -else if (strcmp (argv[i],"sdt" ) ==0 ) + default_ps.exclude_abi = false; + }else if (strcmp (argv[i],"sdt" ) ==0 )print_sdt_events (&print_cb, ps);else if (strcmp (argv[i],"metric" ) ==0 ||strcmp (argv[i],"metrics" ) ==0 ) { default_ps.metricgroups = false;
tools/perf/util/pmus.c +2 -0
@@ -645,6 +645,7 @@ void perf_pmus__print_pmu_events(const struct print_callbacks *print_cb, void *p print_cb->print_event(print_state, aliases[j].topic, aliases[j].pmu_name, + aliases[j].pmu->type, aliases[j].name, aliases[j].alias, aliases[j].scale_unit,
@@ -749,6 +750,7 @@ void perf_pmus__print_raw_pmu_events(const struct print_callbacks *print_cb, voi print_cb->print_event(print_state, /*topic=*/NULL, /*pmu_name=*/NULL, + pmu->type, format_args.short_string.buf, /*event_alias=*/NULL, /*scale_unit=*/NULL,
tools/perf/util/print-events.c +5 -0
@@ -121,6 +121,7 @@ void print_sdt_events(const struct print_callbacks *print_cb, void *print_state) print_cb->print_event(print_state, /*topic=*/NULL, /*pmu_name=*/NULL, + PERF_TYPE_TRACEPOINT, evt_name ?: sdt_name->s, /*event_alias=*/NULL, /*deprecated=*/false,
@@ -222,6 +223,7 @@ int print_hwcache_events(const struct print_callbacks *print_cb, void *print_sta print_cb->print_event(print_state, "cache", pmu->name, + pmu->type, name, alias_name, /*scale_unit=*/NULL,
@@ -278,6 +280,7 @@ void print_symbol_events(const struct print_callbacks *print_cb, void *print_sta print_cb->print_event(print_state, /*topic=*/NULL, /*pmu_name=*/NULL, + type, nd->s, alias, /*scale_unit=*/NULL,
@@ -438,6 +441,7 @@ void print_events(const struct print_callbacks *print_cb, void *print_state) print_cb->print_event(print_state, /*topic=*/NULL, /*pmu_name=*/NULL, + PERF_TYPE_RAW, "rNNN", /*event_alias=*/NULL, /*scale_unit=*/NULL,
@@ -452,6 +456,7 @@ void print_events(const struct print_callbacks *print_cb, void *print_state) print_cb->print_event(print_state, /*topic=*/NULL, /*pmu_name=*/NULL, + PERF_TYPE_BREAKPOINT, "mem:<addr>[/len][:access]", /*scale_unit=*/NULL, /*event_alias=*/NULL,
tools/perf/util/print-events.h +1 -1
@@ -12,7 +12,7 @@ struct print_callbacks {void (*print_start)(void *print_state);void (*print_end)(void *print_state); void (*print_event)(void *print_state, const char *topic, - const char *pmu_name, + const char *pmu_name, u32 pmu_type, const char *event_name, const char *event_alias, const char *scale_unit, bool deprecated, const char *event_type_desc,
Signature · 1 line
2.50.0.727.gbf7dc18ff4-goog
Ian Rogers
reviewerPATCH v5 7/14 perf python: Add basic PMU abstraction and pmus sequence
In reply to Ian RogersAdd an ability to iterate over PMUs and a basic PMU type then can just show the PMU's name.
An example usage:
``` $ python Python 3.12.9 (main, Feb 5 2025, 01:31:18) [GCC 14.2.0] on linux >>> import perf >>> list(perf.pmus()) [pmu(cpu), pmu(breakpoint), pmu(cstate_core), pmu(cstate_pkg), pmu(hwmon_acpitz), pmu(hwmon_ac), pmu(hwmon_bat0), pmu(hwmon_coretemp), pmu(hwmon_iwlwifi_1), pmu(hwmon_nvme), pmu(hwmon_thinkpad), pmu(hwmon_ucsi_source_psy_usbc000_0), pmu(hwmon_ucsi_source_psy_usbc000_0), pmu(i915), pmu(intel_bts), pmu(intel_pt), pmu(kprobe), pmu(msr), pmu(power), pmu(software), pmu(tool), pmu(tracepoint), pmu(uncore_arb), pmu(uncore_cbox_0), pmu(uncore_cbox_1), pmu(uncore_cbox_2), pmu(uncore_cbox_3), pmu(uncore_cbox_4), pmu(uncore_cbox_5), pmu(uncore_cbox_6), pmu(uncore_cbox_7), pmu(uncore_clock), pmu(uncore_imc_free_running_0), pmu(uncore_imc_free_running_1), pmu(uprobe)] ```
--- tools/perf/util/python.c | 140 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 140 insertions(+)
tools/perf/util/python.c +140 -0
@@ -628,6 +628,138 @@ static int pyrf_thread_map__setup_types(void)return PyType_Ready (&pyrf_thread_map__type); } +/** +* A python wrapper for perf_pmus that are globally owned by the pmus.c code. +*/ +struct pyrf_pmu { +PyObject_HEAD + + struct perf_pmu *pmu; +}; + +static void pyrf_pmu__delete (struct pyrf_pmu *ppmu) +{ +Py_TYPE (ppmu)->tp_free ((PyObject *)ppmu); +} + +static PyObject *pyrf_pmu__name (PyObject *self) +{ +struct pyrf_pmu *ppmu = (void *)self; + +return PyUnicode_FromString (ppmu->pmu->name); +} + +static PyObject *pyrf_pmu__repr (PyObject *self) +{ +struct pyrf_pmu *ppmu = (void *)self; + +return PyUnicode_FromFormat ("pmu(%s)" , ppmu->pmu->name); +} + +static const char pyrf_pmu__doc[] =PyDoc_STR ("perf Performance Monitoring Unit (PMU) object." ); + +static PyMethodDef pyrf_pmu__methods[] = { + { + .ml_name ="name" , + .ml_meth = (PyCFunction )pyrf_pmu__name, + .ml_flags =METH_NOARGS , + .ml_doc =PyDoc_STR ("Name of the PMU including suffixes." ) + }, + { .ml_name =NULL , } +}; + +/** The python type for a perf.pmu. */ +static PyTypeObject pyrf_pmu__type = { +PyVarObject_HEAD_INIT (NULL ,0 ) + .tp_name ="perf.pmu" , + .tp_basicsize =sizeof (struct pyrf_pmu ), + .tp_dealloc = (destructor )pyrf_pmu__delete, + .tp_flags = Py_TPFLAGS_DEFAULT|Py_TPFLAGS_BASETYPE, + .tp_doc = pyrf_pmu__doc, + .tp_methods = pyrf_pmu__methods, + .tp_str = pyrf_pmu__name, + .tp_repr = pyrf_pmu__repr, +}; + +static int pyrf_pmu__setup_types (void ) +{ + pyrf_pmu__type.tp_new = PyType_GenericNew; +return PyType_Ready (&pyrf_pmu__type); +} + + +/** A python iterator for pmus that has no equivalent in the C code. */ +struct pyrf_pmu_iterator { +PyObject_HEAD + struct perf_pmu *pmu; +}; + +static void pyrf_pmu_iterator__dealloc (struct pyrf_pmu_iterator *self) +{ +Py_TYPE (self)->tp_free ((PyObject *) self); +} + +static PyObject *pyrf_pmu_iterator__new (PyTypeObject *type,PyObject *args__maybe_unused , +PyObject *kwds__maybe_unused ) +{ +struct pyrf_pmu_iterator *itr = (void *)type->tp_alloc (type,0 ); + +if (itr !=NULL ) + itr->pmu =perf_pmus__scan (/*pmu=*/ NULL ); + +return (PyObject *) itr; +} + +static PyObject *pyrf_pmu_iterator__iter (PyObject *self) +{ +Py_INCREF (self); +return self; +} + +static PyObject *pyrf_pmu_iterator__iternext (PyObject *self) +{ +struct pyrf_pmu_iterator *itr = (void *)self; +struct pyrf_pmu *ppmu; + +if (itr->pmu ==NULL ) { +PyErr_SetNone (PyExc_StopIteration); +return NULL ; + } +// Create object to return. + ppmu = PyObject_New(struct pyrf_pmu, &pyrf_pmu__type); +if (ppmu) { + ppmu->pmu = itr->pmu; +// Advance iterator. + itr->pmu =perf_pmus__scan (itr->pmu); + } +return (PyObject *)ppmu; +} + +/** The python type for the PMU iterator. */ +static PyTypeObject pyrf_pmu_iterator__type = { +PyVarObject_HEAD_INIT (NULL ,0 ) + .tp_name ="pmus.iterator" , + .tp_doc ="Iterator for the pmus string sequence." , + .tp_basicsize =sizeof (struct pyrf_pmu_iterator ), + .tp_itemsize =0 , + .tp_flags = Py_TPFLAGS_DEFAULT, + .tp_new = pyrf_pmu_iterator__new, + .tp_dealloc = (destructor ) pyrf_pmu_iterator__dealloc, + .tp_iter = pyrf_pmu_iterator__iter, + .tp_iternext = pyrf_pmu_iterator__iternext, +}; + +static int pyrf_pmu_iterator__setup_types (void ) +{ +return PyType_Ready (&pyrf_pmu_iterator__type); +} + +static PyObject *pyrf__pmus (PyObject *self,PyObject *args) +{ +// Calling the class creates an instance of the iterator. +return PyObject_CallObject ((PyObject *) &pyrf_pmu_iterator__type,/*args=*/ NULL ); +} +struct pyrf_counts_values {PyObject_HEAD
@@ -1663,6 +1795,12 @@ static PyMethodDef perf__methods[] = { .ml_flags = METH_VARARGS, .ml_doc = PyDoc_STR("Parse a string of events and return an evlist.") }, + { + .ml_name = "pmus", + .ml_meth = (PyCFunction) pyrf__pmus, + .ml_flags = METH_NOARGS, + .ml_doc = PyDoc_STR("Returns a sequence of pmus.") + }, { .ml_name = NULL, } };
@@ -1690,6 +1828,8 @@ PyMODINIT_FUNC PyInit_perf(void)pyrf_evsel__setup_types () <0 ||pyrf_thread_map__setup_types () <0 ||pyrf_cpu_map__setup_types () <0 || +pyrf_pmu_iterator__setup_types () <0 || +pyrf_pmu__setup_types () <0 || pyrf_counts_values__setup_types() < 0) return module;
Signature · 1 line
2.50.0.727.gbf7dc18ff4-goog
Ian Rogers
reviewerPATCH v5 8/14 perf python: Add function returning dictionary of all events on a PMU
In reply to Ian RogersAllow all events on a PMU to be gathered, similar to how perf list gathers event information.
An example usage:
```
$ python
Python 3.12.9 (main, Feb 5 2025, 01:31:18) [GCC 14.2.0] on linux
>>> import perf
>>> for pmu in perf.pmus():
... print(pmu.events())
...
[{'name': 'mem_load_retired.l3_hit', 'desc': 'Retired load instructions...
```--- tools/perf/util/python.c | 67 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 67 insertions(+)
tools/perf/util/python.c +67 -0
@@ -649,6 +649,67 @@ static PyObject *pyrf_pmu__name(PyObject *self)return PyUnicode_FromString (ppmu->pmu->name); } +static bool add_to_dict (PyObject *dict,const char *key,const char *value) +{ +PyObject *pkey, *pvalue; +bool ret; + +if (value ==NULL ) +return true; + + pkey =PyUnicode_FromString (key); + pvalue =PyUnicode_FromString (value); + + ret = pkey && pvalue &&PyDict_SetItem (dict, pkey, pvalue) ==0 ; +Py_XDECREF (pkey); +Py_XDECREF (pvalue); +return ret; +} + +static int pyrf_pmu__events_cb (void *state,struct pmu_event_info *info) +{ +PyObject *py_list = state; +PyObject *dict =PyDict_New (); + +if (!dict) +return -ENOMEM ; + +if (!add_to_dict (dict,"name" , info->name) || + !add_to_dict (dict,"alias" , info->alias) || + !add_to_dict (dict,"scale_unit" , info->scale_unit) || + !add_to_dict (dict,"desc" , info->desc) || + !add_to_dict (dict,"long_desc" , info->long_desc) || + !add_to_dict (dict,"encoding_desc" , info->encoding_desc) || + !add_to_dict (dict,"topic" , info->topic) || + !add_to_dict (dict,"event_type_desc" , info->event_type_desc) || + !add_to_dict (dict,"str" , info->str) || + !add_to_dict (dict,"deprecated" , info->deprecated ?"deprecated" :NULL ) || +PyList_Append (py_list, dict) !=0 ) { +Py_DECREF (dict); +return -ENOMEM ; + } +Py_DECREF (dict); +return 0 ; +} + +static PyObject *pyrf_pmu__events (PyObject *self) +{ +struct pyrf_pmu *ppmu = (void *)self; +PyObject *py_list =PyList_New (0 ); + +if (!py_list) +return NULL ; + +if (perf_pmu__for_each_event (ppmu->pmu, +/*skip_duplicate_pmus=*/ false, + py_list, + pyrf_pmu__events_cb) !=0 ) { +Py_DECREF (py_list); +return NULL ; + } +return py_list; +} +static PyObject *pyrf_pmu__repr (PyObject *self) {struct pyrf_pmu *ppmu = (void *)self;
@@ -659,6 +720,12 @@ static PyObject *pyrf_pmu__repr(PyObject *self)static const char pyrf_pmu__doc[] =PyDoc_STR ("perf Performance Monitoring Unit (PMU) object." );static PyMethodDef pyrf_pmu__methods[] = { + { + .ml_name ="events" , + .ml_meth = (PyCFunction )pyrf_pmu__events, + .ml_flags =METH_NOARGS , + .ml_doc =PyDoc_STR ("Name of the PMU including suffixes." ) + }, { .ml_name ="name" , .ml_meth = (PyCFunction )pyrf_pmu__name,
Signature · 1 line
2.50.0.727.gbf7dc18ff4-goog
Ian Rogers
reviewerPATCH v5 9/14 perf ilist: Add new python ilist command
In reply to Ian RogersThe perf ilist command is a textual app [1] similar to perf list. In the top-left pane a tree of PMUs is displayed. Selecting a PMU expands the events within it. Selecting an event displays the perf list style event information in the top-right pane.
When an event is selected it is opened and the counters on each CPU the event is for are periodically read. The bottom of the screen contains a scrollable set of sparklines showing the events in total and on each CPU. Scrolling below the sparklines shows the same data as raw counts. The sparklines are small graphs where the height of the bar is in relation to maximum of the other counts in the graph.
By default the counts are read with an interval of 0.1 seconds (10 times per second). A -I/--interval command line option allows the interval to be changed. The oldest read counts are dropped when the counts fill the line causing the sparkline to move from right to left.
A search box can be pulled up with the 's' key. 'n' and 'p' iterate through the search results. As some PMUs have hundreds of events a 'c' key will collapse the events in the current PMU to make navigating the PMUs easier.
[1] https://textual.textualize.io/
--- tools/perf/python/ilist.py | 387 +++++++++++++++++++++++++++++++++++++ 1 file changed, 387 insertions(+) create mode 100755 tools/perf/python/ilist.py
tools/perf/python/ilist.py new file +387 -0
@@ -0,0 +1,387 @@ +#!/usr/bin/env python3 +# SPDX-License-Identifier: (LGPL-2.1 OR BSD-2-Clause) +"""Interactive perf list.""" + +import argparse +from typing import Any, Dict, Tuple +import perf +from textual import on +from textual.app import App, ComposeResult +from textual.binding import Binding +from textual.containers import Horizontal, HorizontalGroup, Vertical, VerticalScroll +from textual.command import SearchIcon +from textual.screen import ModalScreen +from textual.widgets import Button, Footer, Header, Input, Label, Sparkline, Static, Tree +from textual.widgets.tree import TreeNode + +class ErrorScreen(ModalScreen[bool]): + """Pop up dialog for errors.""" + + CSS=""" + ErrorScreen { + align: center middle; + } + """ + def __init__(self, error: str): + self.error = error + super().__init__() + + def compose(self) -> ComposeResult: + yield Button(f"Error: {self.error}", variant="primary", id="error") + + def on_button_pressed(self, event: Button.Pressed) -> None: + self.dismiss(True) + + +class SearchScreen(ModalScreen[str]): + """Pop up dialog for search.""" + + CSS=""" + SearchScreen Horizontal { + align: center middle; + margin-top: 1; + } + SearchScreen Input { + width: 1fr; + } + """ + def compose(self) -> ComposeResult: + yield Horizontal(SearchIcon(), Input(placeholder="Event name")) + + def on_input_submitted(self, event: Input.Submitted) -> None: + """Handle the user pressing Enter in the input field.""" + self.dismiss(event.value) + + +class Counter(HorizontalGroup): + """Two labels for a CPU and its counter value.""" + + CSS=""" + Label { + gutter: 1; + } + """ + + def __init__(self, cpu: int) -> None: + self.cpu = cpu + super().__init__() + + def compose(self) -> ComposeResult: + label = f"cpu{self.cpu}" if self.cpu >= 0 else "total" + yield Label(label + " ") + yield Label("0", id=f"counter_{label}") + + +class CounterSparkline(HorizontalGroup): + """A Sparkline for a performance counter.""" + + def __init__(self, cpu: int) -> None: + self.cpu = cpu + super().__init__() + + def compose(self) -> ComposeResult: + label = f"cpu{self.cpu}" if self.cpu >= 0 else "total" + yield Label(label) + yield Sparkline([], summary_function=max, id=f"sparkline_{label}") + + +class IListApp(App): + TITLE = "Interactive Perf List" + + BINDINGS = [ + Binding(key="s", action="search", description="Search", + tooltip="Search events and PMUs"), + Binding(key="n", action="next", description="Next", + tooltip="Next search result or item"), + Binding(key="p", action="prev", description="Previous", + tooltip="Previous search result or item"), + Binding(key="c", action="collapse", description="Collapse", + tooltip="Collapse the current PMU"), + Binding(key="^q", action="quit", description="Quit", + tooltip="Quit the app"), + ] + + CSS = """ + /* Make the 'total' sparkline a different color. */ + #sparkline_total > .sparkline--min-color { + color: $accent; + } + #sparkline_total > .sparkline--max-color { + color: $accent 30%; + } + /* + * Make the active_search initially not displayed with the text in + * the middle of the line. + */ + #active_search { + display: none; + width: 100%; + text-align: center; + } + """ + + def __init__(self, interval: float) -> None: + self.interval = interval + self.evlist = None + self.search_results: list[TreeNode[str]] = [] + self.cur_search_result: TreeNode[str] | None = None + super().__init__() + + + + def expand_and_select(self, node: TreeNode[Any]) -> None: + """Expand select a node in the tree.""" + if node.parent: + node.parent.expand() + if node.parent.parent: + node.parent.parent.expand() + node.expand() + node.tree.select_node(node) + node.tree.scroll_to_node(node) + + + def set_searched_tree_node(self, previous: bool) -> None: + """Set the cur_search_result node to either the next or previous.""" + l = len(self.search_results) + + if l < 1: + tree: Tree[str] = self.query_one("#pmus", Tree) + if previous: + tree.action_cursor_up() + else: + tree.action_cursor_down() + return + + if self.cur_search_result: + idx = self.search_results.index(self.cur_search_result) + if previous: + idx = idx - 1 if idx > 0 else l - 1 + else: + idx = idx + 1 if idx < l - 1 else 0 + else: + idx = l - 1 if previous else 0 + + node = self.search_results[idx] + if node == self.cur_search_result: + return + + self.cur_search_result = node + self.expand_and_select(node) + + def action_search(self) -> None: + """Search was chosen.""" + def set_initial_focus(event: str | None) -> None: + """Sets the focus after the SearchScreen is dismissed.""" + + search_label = self.query_one("#active_search", Label) + search_label.display = True if event else False + if not event: + return + event = event.lower() + search_label.update(f'Searching for events matching "{event}"') + + tree: Tree[str] = self.query_one("#pmus", Tree) + def find_search_results(event: str, node: TreeNode[str], \ + cursor_seen: bool = False, \ + match_after_cursor: TreeNode[str] | None = None) \ + -> Tuple[bool, TreeNode[str] | None]: + """Find nodes that match the search remembering the one after the cursor.""" + if not cursor_seen and node == tree.cursor_node: + cursor_seen = True + if node.data and event in node.data: + if cursor_seen and not match_after_cursor: + match_after_cursor = node + self.search_results.append(node) + + if node.children: + for child in node.children: + (cursor_seen, match_after_cursor) = \ + find_search_results(event, child, cursor_seen, match_after_cursor) + return (cursor_seen, match_after_cursor) + + self.search_results.clear() + (_ , self.cur_search_result) = find_search_results(event, tree.root) + if len(self.search_results) < 1: + self.push_screen(ErrorScreen(f"Failed to find pmu/event {event}")) + elif self.cur_search_result: + self.expand_and_select(self.cur_search_result) + else: + self.set_searched_tree_node(previous=False) + + self.push_screen(SearchScreen(), set_initial_focus) + + + def action_next(self) -> None: + """Next was chosen.""" + self.set_searched_tree_node(previous=False) + + + def action_prev(self) -> None: + """Previous was chosen.""" + self.set_searched_tree_node(previous=True) + + + def action_collapse(self) -> None: + """Collapse the potentially large number of events under a PMU.""" + tree: Tree[str] = self.query_one("#pmus", Tree) + node = tree.cursor_node + if node and node.parent and node.parent.parent: + node.parent.collapse_all() + node.tree.scroll_to_node(node.parent) + + + def update_counts(self) -> None: + """Called every interval to update counts.""" + if not self.evlist: + return + + def update_count(cpu: int, count: int): + # Update the raw count display. + counter: Label = self.query(f"#counter_cpu{cpu}" if cpu >= 0 else "#counter_total") + if not counter: + return + counter = counter.first(Label) + counter.update(str(count)) + + # Update the sparkline. + line: Sparkline = self.query(f"#sparkline_cpu{cpu}" if cpu >= 0 else "#sparkline_total") + if not line: + return + line = line.first(Sparkline) + # If there are more events than the width, remove the front event. + if len(line.data) > line.size.width: + line.data.pop(0) + line.data.append(count) + line.mutate_reactive(Sparkline.data) + + # Update the total and each CPU counts, assume there's just 1 evsel. + total = 0 + self.evlist.disable() + for evsel in self.evlist: + for cpu in evsel.cpus(): + aggr = 0 + for thread in evsel.threads(): + counts = evsel.read(cpu, thread) + aggr += counts.val + update_count(cpu, aggr) + total += aggr + update_count(-1, total) + self.evlist.enable() + + + def on_mount(self) -> None: + """When App starts set up periodic event updating.""" + self.update_counts() + self.set_interval(self.interval, self.update_counts) + + + def set_pmu_and_event(self, pmu: str, event: str) -> None: + """Updates the event/description and starts the counters.""" + # Remove previous event information. + if self.evlist: + self.evlist.disable() + self.evlist.close() + lines = self.query(CounterSparkline) + for line in lines: + line.remove() + lines = self.query(Counter) + for line in lines: + line.remove() + + def pmu_event_description(pmu: str, event: str) -> str: + """Find and format event description for {pmu}/{event}/.""" + def get_info(info: Dict[str, str], key: str): + return (info[key] + "\n") if key in info else "" + + for p in perf.pmus(): + if p.name() != pmu: + continue + for info in p.events(): + if "name" not in info or info["name"] != event: + continue + + desc = get_info(info, "topic") + desc += get_info(info, "event_type_desc") + desc += get_info(info, "desc") + desc += get_info(info, "long_desc") + desc += get_info(info, "encoding_desc") + return desc + return "description" + + # Parse event, update event text and description. + full_name = event if event.startswith(pmu) or ':' in event else f"{pmu}/{event}/" + self.query_one("#event_name", Label).update(full_name) + self.query_one("#event_description", Static).update(pmu_event_description(pmu, event)) + + # Open the event. + try: + self.evlist = perf.parse_events(full_name) + if self.evlist: + self.evlist.open() + self.evlist.enable() + except: + self.evlist = None + + if not self.evlist: + self.push_screen(ErrorScreen(f"Failed to open {full_name}")) + return + + # Add spark lines for all the CPUs. Note, must be done after + # open so that the evlist CPUs have been computed by propagate + # maps. + lines = self.query_one("#lines") + line = CounterSparkline(cpu=-1) + lines.mount(line) + for cpu in self.evlist.all_cpus(): + line = CounterSparkline(cpu) + lines.mount(line) + line = Counter(cpu=-1) + lines.mount(line) + for cpu in self.evlist.all_cpus(): + line = Counter(cpu) + lines.mount(line) + + + def compose(self) -> ComposeResult: + """Draws the app.""" + def pmu_event_tree() -> Tree: + """Create tree of PMUs with events under.""" + tree: Tree[str] = Tree("PMUs", id="pmus") + tree.root.expand() + for pmu in perf.pmus(): + pmu_name = pmu.name().lower() + pmu_node = tree.root.add(pmu_name, data=pmu_name) + for event in sorted(pmu.events(), key=lambda x: x["name"]): + if "name" in event: + e = event["name"].lower() + if "alias" in event: + pmu_node.add_leaf(f'{e} ({event["alias"]})', data=e) + else: + pmu_node.add_leaf(e, data=e) + return tree + + yield Header(id="header") + yield Horizontal(Vertical(pmu_event_tree(), id="events"), + Vertical(Label("event name", id="event_name"), + Static("description", markup=False, id="event_description"), + )) + yield Label(id="active_search") + yield VerticalScroll(id="lines") + yield Footer(id="footer") + + + @on(Tree.NodeSelected) + def on_tree_node_selected(self, event: Tree.NodeSelected[str]) -> None: + """Called when a tree node is selected, selecting the event.""" + if event.node.parent and event.node.parent.parent: + assert event.node.parent.data is not None + assert event.node.data is not None + self.set_pmu_and_event(event.node.parent.data, event.node.data) + + +if __name__ == "__main__": + ap = argparse.ArgumentParser() + ap.add_argument('-I', '--interval', help="Counter update interval in seconds", default=0.1) + args = ap.parse_args() + app = IListApp(float(args.interval)) + app.run()
Signature · 1 line
2.50.0.727.gbf7dc18ff4-goog
Ian Rogers
reviewerPATCH v5 10/14 perf python: Add parse_metrics function
In reply to Ian RogersAdd parse_metrics function that takes a string of metrics and/or metric groups and returns the evlist containing the events and metrics.
For example:
```
>>> import perf
>>> perf.parse_metrics("TopdownL1")
evlist([cpu/TOPDOWN.SLOTS/,cpu/topdown-retiring/,cpu/topdown-fe-bound/,
cpu/topdown-be-bound/,cpu/topdown-bad-spec/,cpu/INT_MISC.CLEARS_COUNT/,
cpu/INT_MISC.UOP_DROPPING/])
```--- tools/perf/util/python.c | 40 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+)
tools/perf/util/python.c +40 -0
@@ -1849,6 +1849,40 @@ static PyObject *pyrf__parse_events(PyObject *self, PyObject *args)return result; } +static PyObject *pyrf__parse_metrics (PyObject *self,PyObject *args) +{ +const char *input; +struct evlist evlist = {}; +PyObject *result; +PyObject *pcpus =NULL , *pthreads =NULL ; +struct perf_cpu_map *cpus; +struct perf_thread_map *threads; +int ret; + +if (!PyArg_ParseTuple (args,"s|OO" , &input, &pcpus, &pthreads)) +return NULL ; + + threads = pthreads ? ((struct pyrf_thread_map *)pthreads)->threads :NULL ; + cpus = pcpus ? ((struct pyrf_cpu_map *)pcpus)->cpus :NULL ; + +evlist__init (&evlist, cpus, threads); + ret =metricgroup__parse_groups (&evlist,/*pmu=*/ "all" , input, +/*metric_no_group=*/ false, +/*metric_no_merge=*/ false, +/*metric_no_threshold=*/ true, +/*user_requested_cpu_list=*/ NULL , +/*system_wide=*/ true, +/*hardware_aware_grouping=*/ false); +if (ret) { + errno = -ret; +PyErr_SetFromErrno (PyExc_OSError); +return NULL ; + } + result =pyrf_evlist__from_evlist (&evlist); +evlist__exit (&evlist); +return result; +} +static PyMethodDef perf__methods[] = { { .ml_name ="tracepoint" ,
@@ -1862,6 +1896,12 @@ static PyMethodDef perf__methods[] = { .ml_flags = METH_VARARGS, .ml_doc =PyDoc_STR ("Parse a string of events and return an evlist." ) }, + { + .ml_name = "parse_metrics", + .ml_meth = (PyCFunction) pyrf__parse_metrics, + .ml_flags = METH_VARARGS, + .ml_doc =PyDoc_STR ("Parse a string of metics or metric groups and return an evlist." ) + }, { .ml_name = "pmus", .ml_meth = (PyCFunction) pyrf__pmus,
Signature · 1 line
2.50.0.727.gbf7dc18ff4-goog
Ian Rogers
reviewerPATCH v5 11/14 perf python: Add evlist metrics function
In reply to Ian RogersThe function returns a list of the names of metrics within the evlist. For example:
```
>>> import perf
>>> perf.parse_metrics("TopdownL1").metrics()
['tma_bad_speculation', 'tma_frontend_bound', 'tma_backend_bound', 'tma_retiring']
```--- tools/perf/util/python.c | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+)
tools/perf/util/python.c +33 -0
@@ -1278,6 +1278,33 @@ static PyObject *pyrf_evlist__all_cpus(struct pyrf_evlist *pevlist)return (PyObject *)pcpu_map; } +static PyObject *pyrf_evlist__metrics (struct pyrf_evlist *pevlist) +{ +PyObject *list =PyList_New (/*len=*/ 0 ); +struct rb_node *node; + +if (!list) +return NULL ; + +for (node =rb_first_cached (&pevlist->evlist.metric_events.entries); node; + node =rb_next (node)) { + struct metric_event *me = container_of(node, struct metric_event, nd); +struct list_head *pos; + +list_for_each (pos, &me->head) { + struct metric_expr *expr = container_of(pos, struct metric_expr, nd); +PyObject *str =PyUnicode_FromString (expr->metric_name); + +if (!str ||PyList_Append (list, str) !=0 ) { +Py_DECREF (list); +return NULL ; + } +Py_DECREF (str); + } + } +return list; +} +static PyObject *pyrf_evlist__mmap (struct pyrf_evlist *pevlist,PyObject *args,PyObject *kwargs) {
@@ -1504,6 +1531,12 @@ static PyMethodDef pyrf_evlist__methods[] = { .ml_flags = METH_NOARGS, .ml_doc =PyDoc_STR ("CPU map union of all evsel CPU maps." ) }, + { + .ml_name = "metrics", + .ml_meth = (PyCFunction)pyrf_evlist__metrics, + .ml_flags = METH_NOARGS, + .ml_doc =PyDoc_STR ("List of metric names within the evlist." ) + }, { .ml_name = "mmap", .ml_meth = (PyCFunction)pyrf_evlist__mmap,
Signature · 1 line
2.50.0.727.gbf7dc18ff4-goog
Ian Rogers
reviewerPATCH v5 12/14 perf python: Add evlist compute_metric
In reply to Ian RogersAdd a compute_metric function that computes a metric double value for a given evlist, metric name, CPU and thread. For example:
```
>>> import perf
>>> x = perf.parse_metrics("TopdownL1")
>>> x.open()
>>> x.enable()
>>> x.disable()
>>> x.metrics()
['tma_bad_speculation', 'tma_frontend_bound', 'tma_backend_bound', 'tma_retiring']
>>> x.compute_metric('tma_bad_speculation', 0, -1)
0.08605342847131037
```--- tools/perf/util/python.c | 121 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 121 insertions(+)
tools/perf/util/python.c +121 -0
@@ -14,6 +14,7 @@#include "evlist.h" #include "evsel.h" #include "event.h" +#include "expr.h" #include "print_binary.h" #include "record.h" #include "strbuf.h"
@@ -1305,6 +1306,120 @@ static PyObject *pyrf_evlist__metrics(struct pyrf_evlist *pevlist)return list; } +static int prepare_metric (const struct metric_expr *mexp, +const struct evsel *evsel, +struct expr_parse_ctx *pctx, +int cpu_idx,int thread_idx) +{ +struct evsel *const *metric_events = mexp->metric_events; +struct metric_ref *metric_refs = mexp->metric_refs; + +for (int i =0 ; metric_events[i]; i++) { +char *n =strdup (evsel__metric_id (metric_events[i])); +double val, ena, run; +int source_count =evsel__source_count (metric_events[i]); +int ret; +struct perf_counts_values *old_count, *new_count; + +if (!n) +return -ENOMEM ; + +if (source_count ==0 ) + source_count =1 ; + + ret =evsel__ensure_counts (metric_events[i]); +if (ret) +return ret; + +/* Set up pointers to the old and newly read counter values. */ + old_count =perf_counts (metric_events[i]->prev_raw_counts, cpu_idx, thread_idx); + new_count =perf_counts (metric_events[i]->counts, cpu_idx, thread_idx); +/* Update the value in metric_events[i]->counts. */ +evsel__read_counter (metric_events[i], cpu_idx, thread_idx); + + val = new_count->val - old_count->val; + ena = new_count->ena - old_count->ena; + run = new_count->run - old_count->run; + +if (ena != run && run !=0 ) + val = val * ena / run; + ret =expr__add_id_val_source_count (pctx, n, val, source_count); +if (ret) +return ret; + } + +for (int i =0 ; metric_refs && metric_refs[i].metric_name; i++) { +int ret =expr__add_ref (pctx, &metric_refs[i]); + +if (ret) +return ret; + } + +return 0 ; +} + +static PyObject *pyrf_evlist__compute_metric (struct pyrf_evlist *pevlist, +PyObject *args,PyObject *kwargs) +{ +int ret, cpu =0 , cpu_idx, thread =0 , thread_idx; +const char *metric; +struct rb_node *node; +struct metric_expr *mexp =NULL ; +struct expr_parse_ctx *pctx; +double result =0 ; + +if (!PyArg_ParseTuple (args,"sii" , &metric, &cpu, &thread)) +return NULL ; + + cpu_idx =perf_cpu_map__idx (pevlist->evlist.core.all_cpus, (struct perf_cpu ){.cpu = cpu}); +if (cpu_idx <0 ) { +PyErr_Format (PyExc_TypeError,"CPU %d is not part of evsel's CPUs" , cpu); +return NULL ; + } + thread_idx =perf_thread_map__idx (pevlist->evlist.core.threads, thread); +if (thread_idx <0 ) { +PyErr_Format (PyExc_TypeError,"Thread %d is not part of evsel's threads" , + thread); +return NULL ; + } + +for (node =rb_first_cached (&pevlist->evlist.metric_events.entries); node; + node =rb_next (node)) { + struct metric_event *me = container_of(node, struct metric_event, nd); +struct list_head *pos; + +list_for_each (pos, &me->head) { + struct metric_expr *e = container_of(pos, struct metric_expr, nd); + +if (!strcmp (e->metric_name, metric)) { + mexp = e; +break ; + } + } + } +if (!mexp) { +PyErr_Format (PyExc_TypeError,"Unknown metric '%s'" , metric); +return NULL ; + } + + pctx =expr__ctx_new (); +if (!pctx) +return PyErr_NoMemory (); + + ret =prepare_metric (mexp, mexp->metric_events[0 ], pctx, cpu_idx, thread_idx); +if (ret) { +expr__ctx_free (pctx); + errno = -ret; +PyErr_SetFromErrno (PyExc_OSError); +return NULL ; + } +if (expr__parse (&result, pctx, mexp->metric_expr)) + result =0.0 ; + +expr__ctx_free (pctx); +return PyFloat_FromDouble (result); +} +static PyObject *pyrf_evlist__mmap (struct pyrf_evlist *pevlist,PyObject *args,PyObject *kwargs) {
@@ -1537,6 +1652,12 @@ static PyMethodDef pyrf_evlist__methods[] = { .ml_flags = METH_NOARGS, .ml_doc =PyDoc_STR ("List of metric names within the evlist." ) }, + { + .ml_name = "compute_metric", + .ml_meth = (PyCFunction)pyrf_evlist__compute_metric, + .ml_flags = METH_VARARGS | METH_KEYWORDS, + .ml_doc =PyDoc_STR ("compute metric for given name, cpu and thread" ) + }, { .ml_name = "mmap", .ml_meth = (PyCFunction)pyrf_evlist__mmap,
Signature · 1 line
2.50.0.727.gbf7dc18ff4-goog
Ian Rogers
reviewerPATCH v5 13/14 perf python: Add metrics function
In reply to Ian RogersThe metrics function returns a list dictionaries describing metrics as strings mapping to strings, except for metric groups that are a string mapping to a list of strings. For example:
```
>>> import perf
>>> perf.metrics()[0]
{'MetricGroup': ['Power'], 'MetricName': 'C10_Pkg_Residency',
'PMU': 'default_core', 'MetricExpr': 'cstate_pkg@c10\\-residency@ / TSC',
'ScaleUnit': '100%', 'BriefDescription': 'C10 residency percent per package'}
```--- tools/perf/util/python.c | 83 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 83 insertions(+)
tools/perf/util/python.c +83 -0
@@ -2037,7 +2037,90 @@ static PyObject *pyrf__parse_metrics(PyObject *self, PyObject *args)return result; } +static PyObject *pyrf__metrics_groups (const struct pmu_metric *pm) +{ +PyObject *groups =PyList_New (/*len=*/ 0 ); +const char *mg = pm->metric_group; + +if (!groups) +return NULL ; + +while (mg) { +PyObject *val =NULL ; +const char *sep =strchr (mg,';' ); +size_t len = sep ? (size_t )(sep - mg) :strlen (mg); + +if (len >0 ) { + val =PyUnicode_FromStringAndSize (mg, len); +if (val) +PyList_Append (groups, val); + +Py_XDECREF (val); + } + mg = sep ? sep +1 :NULL ; + } +return groups; +} + +static int pyrf__metrics_cb (const struct pmu_metric *pm, +const struct pmu_metrics_table *table__maybe_unused , +void *vdata) +{ +PyObject *py_list = vdata; +PyObject *dict =PyDict_New (); +PyObject *key = dict ?PyUnicode_FromString ("MetricGroup" ) :NULL ; +PyObject *value = key ?pyrf__metrics_groups (pm) :NULL ; + +if (!value ||PyDict_SetItem (dict, key, value) !=0 ) { +Py_XDECREF (key); +Py_XDECREF (value); +Py_XDECREF (dict); +return -ENOMEM ; + } + +if (!add_to_dict (dict,"MetricName" , pm->metric_name) || + !add_to_dict (dict,"PMU" , pm->pmu) || + !add_to_dict (dict,"MetricExpr" , pm->metric_expr) || + !add_to_dict (dict,"MetricThreshold" , pm->metric_threshold) || + !add_to_dict (dict,"ScaleUnit" , pm->unit) || + !add_to_dict (dict,"Compat" , pm->compat) || + !add_to_dict (dict,"BriefDescription" , pm->desc) || + !add_to_dict (dict,"PublicDescription" , pm->long_desc) || +PyList_Append (py_list, dict) !=0 ) { +Py_DECREF (dict); +return -ENOMEM ; + } +Py_DECREF (dict); +return 0 ; +} + +static PyObject *pyrf__metrics (PyObject *self,PyObject *args) +{ +const struct pmu_metrics_table *table =pmu_metrics_table__find (); +PyObject *list =PyList_New (/*len=*/ 0 ); +int ret; + +if (!list) +return NULL ; + + ret =pmu_metrics_table__for_each_metric (table, pyrf__metrics_cb, list); +if (ret) { +Py_DECREF (list); + errno = -ret; +PyErr_SetFromErrno (PyExc_OSError); +return NULL ; + } +return list; +} +static PyMethodDef perf__methods[] = { + { + .ml_name ="metrics" , + .ml_meth = (PyCFunction ) pyrf__metrics, + .ml_flags =METH_NOARGS , + .ml_doc =PyDoc_STR ( +"Returns a list of metrics represented as string values in dictionaries." ) + }, { .ml_name ="tracepoint" , .ml_meth = (PyCFunction ) pyrf__tracepoint,
Signature · 1 line
2.50.0.727.gbf7dc18ff4-goog
Ian Rogers
reviewerPATCH v5 14/14 perf ilist: Add support for metrics
In reply to Ian RogersChange tree nodes to having a value of either Metric or PmuEvent, these values have the ability to match searches, be parsed to create evlists and to give a value per CPU and per thread to display. Use perf.metrics to generate a tree of metrics. Most metrics are placed under their metric group, if the metric group name ends with '_group' then the metric group is placed next to the associated metric.
--- tools/perf/python/ilist.py | 207 +++++++++++++++++++++++++++---------- 1 file changed, 153 insertions(+), 54 deletions(-)
tools/perf/python/ilist.py +153 -54
@@ -2,8 +2,11 @@ # SPDX-License-Identifier: (LGPL-2.1 OR BSD-2-Clause) """Interactive perf list.""" +from abc import ABC, abstractmethod import argparse -from typing import Any, Dict, Tuple +from dataclasses import dataclass +from typing import Any, Dict, Optional, Tuple +import math import perf from textual import on from textual.app import App, ComposeResult
@@ -14,6 +17,103 @@ from textual.screen import ModalScreen from textual.widgets import Button, Footer, Header, Input, Label, Sparkline, Static, Tree from textual.widgets.tree import TreeNode +def get_info(info: Dict[str, str], key: str): + return (info[key] + "\n") if key in info else "" + +class TreeValue(ABC): + """Abstraction for the data of value in the tree.""" + + @abstractmethod + def name(self) -> str: + pass + + @abstractmethod + def description(self) -> str: + pass + + @abstractmethod + def matches(self, query: str) -> bool: + pass + + @abstractmethod + def parse(self) -> perf.evlist: + pass + + @abstractmethod + def value(self, evlist: perf.evlist, evsel: perf.evsel, cpu: int, thread: int) -> float: + pass + + +@dataclass +class Metric(TreeValue): + """A metric in the tree.""" + metric_name: str + + def name(self) -> str: + return self.metric_name + + def description(self) -> str: + """Find and format metric description.""" + for metric in perf.metrics(): + if metric["MetricName"] != self.metric_name: + continue + desc = get_info(metric, "BriefDescription") + desc += get_info(metric, "PublicDescription") + desc += get_info(metric, "MetricExpr") + desc += get_info(metric, "MetricThreshold") + return desc + return "description" + + def matches(self, query: str) -> bool: + return query in self.metric_name + + def parse(self) -> perf.evlist: + return perf.parse_metrics(self.metric_name) + + def value(self, evlist: perf.evlist, evsel: perf.evsel, cpu: int, thread: int) -> float: + val = evlist.compute_metric(self.metric_name, cpu, thread) + return 0 if math.isnan(val) else val + + +@dataclass +class PmuEvent(TreeValue): + """A PMU and event within the tree.""" + pmu: str + event: str + + def name(self) -> str: + if self.event.startswith(self.pmu) or ':' in self.event: + return self.event + else: + return f"{self.pmu}/{self.event}/" + + def description(self) -> str: + """Find and format event description for {pmu}/{event}/.""" + for p in perf.pmus(): + if p.name() != self.pmu: + continue + for info in p.events(): + if "name" not in info or info["name"] != self.event: + continue + + desc = get_info(info, "topic") + desc += get_info(info, "event_type_desc") + desc += get_info(info, "desc") + desc += get_info(info, "long_desc") + desc += get_info(info, "encoding_desc") + return desc + return "description" + + def matches(self, query: str) -> bool: + return query in self.pmu or query in self.event + + def parse(self) -> perf.evlist: + return perf.parse_events(self.name()) + + def value(self, evlist: perf.evlist, evsel: perf.evsel, cpu: int, thread: int) -> float: + return evsel.read(cpu, thread).val + + class ErrorScreen(ModalScreen[bool]): """Pop up dialog for errors."""
@@ -123,8 +223,9 @@ class IListApp(App): def __init__(self, interval: float) -> None: self.interval = interval self.evlist = None - self.search_results: list[TreeNode[str]] = [] - self.cur_search_result: TreeNode[str] | None = None + self.selected: Optional[TreeValue] = None + self.search_results: list[TreeNode[TreeValue]] = [] + self.cur_search_result: TreeNode[TreeValue] | None = None super().__init__()
@@ -180,15 +281,15 @@ class IListApp(App): event = event.lower() search_label.update(f'Searching for events matching "{event}"') - tree: Tree[str] = self.query_one("#pmus", Tree) - def find_search_results(event: str, node: TreeNode[str], \ + tree: Tree[TreeValue] = self.query_one("#root", Tree) + def find_search_results(event: str, node: TreeNode[TreeValue], \ cursor_seen: bool = False, \ - match_after_cursor: TreeNode[str] | None = None) \ - -> Tuple[bool, TreeNode[str] | None]: + match_after_cursor: TreeNode[TreeValue] | None = None) \ + -> Tuple[bool, TreeNode[TreeValue] | None]: """Find nodes that match the search remembering the one after the cursor.""" if not cursor_seen and node == tree.cursor_node: cursor_seen = True - if node.data and event in node.data: + if node.data and node.data.matches(event): if cursor_seen and not match_after_cursor: match_after_cursor = node self.search_results.append(node)
@@ -222,17 +323,17 @@ class IListApp(App): def action_collapse(self) -> None: - """Collapse the potentially large number of events under a PMU.""" - tree: Tree[str] = self.query_one("#pmus", Tree) + """Collapse the part of the tree currently on.""" + tree: Tree[str] = self.query_one("#root", Tree) node = tree.cursor_node - if node and node.parent and node.parent.parent: + if node and node.parent: node.parent.collapse_all() node.tree.scroll_to_node(node.parent) def update_counts(self) -> None: """Called every interval to update counts.""" - if not self.evlist: + if not self.selected or not self.evlist: return def update_count(cpu: int, count: int):
@@ -261,8 +362,7 @@ class IListApp(App): for cpu in evsel.cpus(): aggr = 0 for thread in evsel.threads(): - counts = evsel.read(cpu, thread) - aggr += counts.val + aggr += self.selected.value(self.evlist, evsel, cpu, thread) update_count(cpu, aggr) total += aggr update_count(-1, total)
@@ -275,8 +375,10 @@ class IListApp(App): self.set_interval(self.interval, self.update_counts) - def set_pmu_and_event(self, pmu: str, event: str) -> None: + def set_selected(self, value: TreeValue) -> None: """Updates the event/description and starts the counters.""" + self.selected = value + # Remove previous event information. if self.evlist: self.evlist.disable()
@@ -288,34 +390,13 @@ class IListApp(App): for line in lines: line.remove() - def pmu_event_description(pmu: str, event: str) -> str: - """Find and format event description for {pmu}/{event}/.""" - def get_info(info: Dict[str, str], key: str): - return (info[key] + "\n") if key in info else "" - - for p in perf.pmus(): - if p.name() != pmu: - continue - for info in p.events(): - if "name" not in info or info["name"] != event: - continue - - desc = get_info(info, "topic") - desc += get_info(info, "event_type_desc") - desc += get_info(info, "desc") - desc += get_info(info, "long_desc") - desc += get_info(info, "encoding_desc") - return desc - return "description" - - # Parse event, update event text and description. - full_name = event if event.startswith(pmu) or ':' in event else f"{pmu}/{event}/" - self.query_one("#event_name", Label).update(full_name) - self.query_one("#event_description", Static).update(pmu_event_description(pmu, event)) + # Update event/metric text and description. + self.query_one("#event_name", Label).update(value.name()) + self.query_one("#event_description", Static).update(value.description()) # Open the event. try: - self.evlist = perf.parse_events(full_name) + self.evlist = value.parse() if self.evlist: self.evlist.open() self.evlist.enable()
@@ -323,7 +404,7 @@ class IListApp(App): self.evlist = None if not self.evlist: - self.push_screen(ErrorScreen(f"Failed to open {full_name}")) + self.push_screen(ErrorScreen(f"Failed to open {value.name()}")) return # Add spark lines for all the CPUs. Note, must be done after
@@ -344,24 +425,44 @@ class IListApp(App): def compose(self) -> ComposeResult: """Draws the app.""" - def pmu_event_tree() -> Tree: - """Create tree of PMUs with events under.""" - tree: Tree[str] = Tree("PMUs", id="pmus") - tree.root.expand() + def metric_event_tree() -> Tree: + """Create tree of PMUs and metricgroups with events or metrics under.""" + tree: Tree[TreeValue] = Tree("Root", id="root") + pmus = tree.root.add("PMUs") for pmu in perf.pmus(): pmu_name = pmu.name().lower() - pmu_node = tree.root.add(pmu_name, data=pmu_name) + pmu_node = pmus.add(pmu_name) for event in sorted(pmu.events(), key=lambda x: x["name"]): if "name" in event: e = event["name"].lower() if "alias" in event: - pmu_node.add_leaf(f'{e} ({event["alias"]})', data=e) + pmu_node.add_leaf(f'{e} ({event["alias"]})', data=PmuEvent(pmu_name, e)) else: - pmu_node.add_leaf(e, data=e) + pmu_node.add_leaf(e, data=PmuEvent(pmu_name, e)) + metrics = tree.root.add("Metrics") + groups = set() + for metric in perf.metrics(): + groups.update(metric["MetricGroup"]) + + def add_metrics_to_tree(node: TreeNode[TreeValue], parent: str): + for metric in sorted(perf.metrics(), key=lambda x: x["MetricName"]): + if parent in metric["MetricGroup"]: + name = metric["MetricName"] + node.add_leaf(name, data=Metric(name)) + child_group_name = f'{name}_group' + if child_group_name in groups: + add_metrics_to_tree(node.add(child_group_name), child_group_name) + + for group in sorted(groups): + if group.endswith('_group'): + continue + add_metrics_to_tree(metrics.add(group), group) + + tree.root.expand() return tree yield Header(id="header") - yield Horizontal(Vertical(pmu_event_tree(), id="events"), + yield Horizontal(Vertical(metric_event_tree(), id="events"), Vertical(Label("event name", id="event_name"), Static("description", markup=False, id="event_description"), ))
@@ -371,12 +472,10 @@ class IListApp(App): @on(Tree.NodeSelected) - def on_tree_node_selected(self, event: Tree.NodeSelected[str]) -> None: + def on_tree_node_selected(self, event: Tree.NodeSelected[TreeValue]) -> None: """Called when a tree node is selected, selecting the event.""" - if event.node.parent and event.node.parent.parent: - assert event.node.parent.data is not None - assert event.node.data is not None - self.set_pmu_and_event(event.node.parent.data, event.node.data) + if event.node.data: + self.set_selected(event.node.data) if __name__ == "__main__":
Signature · 1 line
2.50.0.727.gbf7dc18ff4-goog