v4 of perf weight annotation
This patchkit display weights in perf annotate.
Changes in v4:
Address review comments (except for some Sashiko nitpick) Support no-weights for perf report too
Rename the symbol_conf flag
PPC and x86 now report correct field names (using ifdef)
PATCH v4 1/4 perf tools record: Modernize -W man page
Modernize the -W / --weight description in the manpage to cover more cases that are supported now.
--- tools/perf/Documentation/perf-record.txt | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-)
tools/perf/Documentation/perf-record.txt +5 -3
@@ -480,9 +480,11 @@ Note that this feature may not be available on all processors. -W:: --weight:: -Enable weightened sampling. An additional weight is recorded per sample and can be -displayed with the weight and local_weight sort keys. This currently works for TSX -abort events and some memory events in precise mode on modern Intel CPUs. +Enable weighted sampling. One or more additional weights can be recorded per sample +and can be displayed with the weight, weight2, weight3 and local_weight sort keys. +Possible uses for weights are memory or instruction retirement latencies. +Support depends on the PMU and the event, as well as its configuration. Typically +it requires use of 'p'. --namespaces:: Record events of type PERF_RECORD_NAMESPACES. This enables 'cgroup_id' sort key.
Signature · 1 line
2.55.0
PATCH v4 2/4 perf tools top: Add --weight option
In reply to Andi KleenAdd a -W/--weight option to perf top to collect weights too. Useful with follow on patches.
--- tools/perf/Documentation/perf-top.txt | 6 ++++++ tools/perf/builtin-top.c | 2 ++ 2 files changed, 8 insertions(+)
tools/perf/Documentation/perf-top.txt +6 -0
@@ -25,6 +25,12 @@ OPTIONS --count=<count>:: Event period to sample. +-W:: +--weight:: +Enable weighted sampling. One or more additional weights can be recorded per sample +and can be displayed with the weight, weight2, weight3 and local_weight sort keys. +Possible uses for weights are memory or instruction retirement latencies. + -C <cpu-list>:: --cpu=<cpu>:: Monitor only on the list of CPUs provided. Multiple CPUs can be provided as a
tools/perf/builtin-top.c +2 -0
@@ -1493,6 +1493,8 @@ int cmd_top(int argc, const char **argv)OPT_CALLBACK (0 ,"filter" , &top.evlist,"filter" ,"event filter" , parse_filter),OPT_U64 ('c' ,"count" , &opts->user_interval,"event period to sample" ), +OPT_BOOLEAN ('W' ,"weight" , &opts->sample_weight, +"sample by weight (on special events only)" ),OPT_STRING ('p' ,"pid" , &target->pid,"pid" ,"profile events on existing process id" ), OPT_STRING('t', "tid", &target->tid, "tid",
Signature · 1 line
2.55.0
PATCH v4 3/4 perf tools: Add support for displaying weights in annotate
In reply to Andi KleenAdd support for showing all the three possible per IP weights in annotate. The weights are shown by defaults if any are non zero. This is useful, especially with the new insn lat statistics, but also for all the existing weights.
Add a hotkey to the interactive browser to turn them off (w), as well as a perf annotate command line option.
The weights are stored unconditionally in the sym_hist_entry, which will increase memory consumption somewhat.
--- tools/perf/Documentation/perf-annotate.txt | 3 + tools/perf/Documentation/perf-report.txt | 6 ++ tools/perf/builtin-annotate.c | 3 + tools/perf/builtin-report.c | 3 + tools/perf/ui/browsers/annotate.c | 17 ++- tools/perf/util/annotate.c | 118 ++++++++++++++++++--- tools/perf/util/annotate.h | 32 +++++- tools/perf/util/symbol_conf.h | 15 ++- 8 files changed, 179 insertions(+), 18 deletions(-)
tools/perf/Documentation/perf-annotate.txt +3 -0
@@ -95,6 +95,9 @@ include::itrace.txt[] --gtk:: Use the GTK interface. +--weights:: Show or hide (with `--no-weights`) weight columns in annotation output. + By default, weight columns are shown when samples contain non-zero weights. + -C:: --cpu=<cpu>:: Only report samples for the list of CPUs provided. Multiple CPUs can be provided as a comma-separated list with no space: 0,1. Ranges of
tools/perf/Documentation/perf-report.txt +6 -0
@@ -64,6 +64,9 @@ OPTIONS --symbol-filter=:: Only show symbols that match (partially) with this filter. +--weights:: Show or hide (with `--no-weights`) weight columns in annotation output. + By default, weight columns are shown when samples contain non-zero weights. + -U:: --hide-unresolved:: Only display entries resolved to a symbol.
@@ -353,6 +356,9 @@ OPTIONS --gtk:: Use the GTK2 interface. +--weights:: Show or hide (with `--no-weights`) weight columns in annotation output. + By default, weight columns are shown when samples contain non-zero weights. + -k:: --vmlinux=<file>:: vmlinux pathname
tools/perf/builtin-annotate.c +3 -0
@@ -719,6 +719,8 @@ int cmd_annotate(int argc, const char **argv)OPT_BOOLEAN (0 ,"tui" , &annotate.use_tui,"Use the TUI interface" ), #endifOPT_BOOLEAN (0 ,"stdio" , &annotate.use_stdio,"Use the stdio interface" ), +OPT_BOOLEAN (0 ,"weights" , &symbol_conf.annotate_weight, +"Hide or hide weight columns in annotation. Default show if non zero." ),OPT_BOOLEAN (0 ,"stdio2" , &annotate.use_stdio2,"Use the stdio interface" ),OPT_BOOLEAN (0 ,"ignore-vmlinux" , &symbol_conf.ignore_vmlinux, "don't load vmlinux even if found"),
@@ -788,6 +790,7 @@ int cmd_annotate(int argc, const char **argv)set_option_flag (options,0 ,"show-total-period" ,PARSE_OPT_EXCLUSIVE );set_option_flag (options,0 ,"show-nr-samples" ,PARSE_OPT_EXCLUSIVE ); + symbol_conf.annotate_weight = true;annotation_options__init ();
tools/perf/builtin-report.c +3 -0
@@ -1364,6 +1364,8 @@ int cmd_report(int argc, const char **argv)#endif OPT_BOOLEAN (0 ,"stdio" , &report.use_stdio,"Use the stdio interface" ), +OPT_BOOLEAN (0 ,"weights" , &symbol_conf.annotate_weight, +"Show or hide weight columns in annotation. Default show if non-zero." ),OPT_BOOLEAN (0 ,"header" , &report.header,"Show data header." ),OPT_BOOLEAN (0 ,"header-only" , &report.header_only, "Show only data header."),
@@ -1525,6 +1527,7 @@ int cmd_report(int argc, const char **argv)* reference exited threads. */ symbol_conf.keep_exited_threads = true; + symbol_conf.annotate_weight = true;annotation_options__init ();
tools/perf/ui/browsers/annotate.c +14 -3
@@ -189,7 +189,7 @@ static void annotate_browser__draw_current_jump(struct ui_browser *browser)struct map_symbol *ms = ab->b.priv;struct symbol *sym = ms->sym;struct annotation *notes =symbol__annotation (sym); -u8 pcnt_width =annotation__pcnt_width (notes); +u8 pcnt_width =annotation__pcnt_width (notes, ab->evsel);u8 cntr_width =annotation__br_cntr_width ();int width;int diff =0 ;
@@ -255,7 +255,8 @@ static unsigned int annotate_browser__refresh(struct ui_browser *browser) {struct annotation *notes =browser__annotation (browser);int ret =ui_browser__list_head_refresh (browser); -int pcnt_width =annotation__pcnt_width (notes); +int pcnt_width =annotation__pcnt_width (notes, + container_of(browser, struct annotate_browser, b)->evsel);if (annotate_opts.jump_arrows)annotate_browser__draw_current_jump (browser);
@@ -972,6 +973,7 @@ static int annotate_browser__run(struct annotate_browser *browser,"O Bump offset level (jump targets -> +call -> all -> cycle thru)\n" "s Toggle source code view\n" "t Circulate percent, total period, samples view\n" +"w Toggle weight columns\n" "c Show min/max cycle\n" "/ Search string\n" "k Toggle line numbers\n"
@@ -1091,6 +1093,15 @@ static int annotate_browser__run(struct annotate_browser *browser, symbol_conf.show_total_period = true;annotation__update_column_widths (notes);continue ; +case 'w' : + symbol_conf.annotate_weight = !symbol_conf.annotate_weight; + symbol_conf.weight_mask_user = true; + symbol_conf.weight_mask = !symbol_conf.annotate_weight ? +0 :sym_hist__weight_mask (annotation__histogram (notes, evsel)); + browser->b.width = notes->src->widths.max_line_len + +annotation__pcnt_width (notes, evsel); +ui_browser__refresh_dimensions (&browser->b); +continue ;case 'c' :if (annotate_opts.show_minmax_cycle) annotate_opts.show_minmax_cycle = false;
@@ -1228,7 +1239,7 @@ int __hist_entry__tui_annotate(struct hist_entry *he, struct map_symbol *ms, browser.b.width = notes->src->widths.max_line_len; browser.b.nr_entries = notes->src->nr_entries; browser.b.entries = ¬es->src->source; - browser.b.width +=18 ;/* Percentage */ + browser.b.width +=annotation__pcnt_width (notes, evsel);if (annotate_opts.hide_src_code)ui_browser__init_asm_mode (&browser.b);
tools/perf/util/annotate.c +106 -12
218 lines not on this page · raw message
tools/perf/util/annotate.h +30 -2
@@ -6,6 +6,7 @@#include <stdint.h> #include <stdio.h> #include <linux/types.h> +#include <linux/bitops.h> #include <linux/list.h> #include <linux/rbtree.h> #include <asm/bug.h>
@@ -86,6 +87,8 @@ struct annotation;struct sym_hist_entry {u64 nr_samples;u64 period; +u64 weight_sum[WEIGHT_WEIGHT3 +1 ]; +u64 weight_num[WEIGHT_WEIGHT3 +1 ]; };enum {
@@ -231,8 +234,20 @@ void symbol__calc_percent(struct symbol *sym, struct evsel *evsel);struct sym_hist {u64 nr_samples;u64 period; +u8 weight_mask; }; +/* Can be set asynchronously by top. */ +static inline u8 sym_hist__weight_mask (const struct sym_hist *hist) +{ +return __atomic_load_n (&hist->weight_mask, __ATOMIC_RELAXED); +} + +static inline void sym_hist__set_weight_mask (struct sym_hist *hist,u8 mask) +{ +__atomic_fetch_or (&hist->weight_mask, mask, __ATOMIC_RELAXED); +} +/** * struct cyc_hist - (CPU) cycle histogram for a basic block *
@@ -376,9 +391,22 @@ static inline int annotation__cycles_width(struct annotation *notes)return notes->branch ?ANNOTATION__IPC_WIDTH +ANNOTATION__CYCLES_WIDTH :0 ; } -static inline int annotation__pcnt_width (struct annotation *notes) +static inline u8 annotation__weight_mask (struct annotation *notes, +const struct evsel *evsel) +{ +if (symbol_conf.weight_mask_user) +return symbol_conf.weight_mask; +if (!symbol_conf.annotate_weight) +return 0 ; +return sym_hist__weight_mask (¬es->src->histograms[evsel->core.idx]); +} + +static inline int annotation__pcnt_width (struct annotation *notes, +const struct evsel *evsel) { -return (symbol_conf.show_total_period ?12 :8 ) * notes->src->nr_events; +int extra =hweight8 (annotation__weight_mask (notes, evsel)) *8 ; +return ((symbol_conf.show_total_period ?12 :8 ) + extra) * + notes->src->nr_events; }static inline bool annotation_line__filter (struct annotation_line *al)
tools/perf/util/symbol_conf.h +14 -1
@@ -27,6 +27,16 @@ enum a2l_style { };#define MAX_A2L_STYLE (A2L_STYLE_CMD + 1) +enum symbol__weight_mode { +WEIGHT_NONE =0 , +WEIGHT_WEIGHT , +WEIGHT_INSNLAT , +WEIGHT_WEIGHT3 , +}; + +#define for_each_weight (_weight) \ + for ((_weight) = WEIGHT_WEIGHT; (_weight) <= WEIGHT_WEIGHT3; (_weight)++) +struct symbol_conf {bool nanosecs;unsigned short priv_size;
@@ -69,7 +79,10 @@ struct symbol_conf { annotate_data_sample, skip_empty, enable_latency, - prefer_latency; + prefer_latency, + annotate_weight, + weight_mask_user; +u8 weight_mask;const char *vmlinux_name, *kallsyms_name, *source_prefix,
Signature · 1 line
2.55.0
PATCH v4 4/4 perf tools: Add test for weight annotation
In reply to Andi KleenAdd a test case to check if --stdio weight annotation works
--- tools/perf/tests/shell/annotate_weight.sh | 63 +++++++++++++++++++++++ 1 file changed, 63 insertions(+) create mode 100755 tools/perf/tests/shell/annotate_weight.sh
tools/perf/tests/shell/annotate_weight.sh new file +63 -0
@@ -0,0 +1,63 @@ +#!/bin/bash +# perf annotate weight regression test +# SPDX-License-Identifier: GPL-2.0 + +set -e + +shelldir=$(dirname "$0") +# shellcheck source=tools/perf/tests/shell/lib/perf_has_symbol.sh +. "${shelldir}"/lib/perf_has_symbol.sh + +testsym="test_loop" +skip_test_missing_symbol "${testsym}" + +perfdata=$(mktemp /tmp/__perf_test.annotate_weight.XXXXX) +record_log=$(mktemp /tmp/__perf_test.annotate_weight.XXXXX.log) +report_out=$(mktemp /tmp/__perf_test.annotate_weight.XXXXX.report) +annotate_out=$(mktemp /tmp/__perf_test.annotate_weight.XXXXX.annotate) + +cleanup() { + rm -f "${perfdata}" "${record_log}" "${report_out}" "${annotate_out}" + trap - EXIT TERM INT +} + +trap 'cleanup; exit 1' TERM INT +trap cleanup EXIT + +# mem-loads:pu requests a precise user PEBS event whose sample weight should +# be populated by -W. Unsupported PEBS/weight PMUs are skipped below. +if ! perf record -W -e mem-loads:pu -o "${perfdata}" -- perf test -w thloop \ + > /dev/null 2> "${record_log}"; then + echo "[SKIP] precise PEBS weight sampling is unavailable" + exit 2 +fi + +# Confirm the PMU actually produced nonzero weights. A successful record alone +# is insufficient: some PMUs accept the event but provide no weight payload. +if ! perf report --stdio -i "${perfdata}" --fields=weight1,weight2,weight3,symbol --percent-limit 0 \ + > "${report_out}" 2> "${record_log}"; then + echo "[SKIP] weighted samples cannot be decoded" + exit 2 +fi + +if ! awk '$1 ~ /^[0-9]/ && ($1 + 0) > 0 { found = 1 } END { exit !found }' \ + "${report_out}"; then + echo "[SKIP] PEBS weight sampling produced no nonzero weights" + exit 2 +fi + +perf annotate --stdio -i "${perfdata}" --symbol "${testsym}" \ + > "${annotate_out}" 2> "${record_log}" + +grep -q 'Percent Weight' "${annotate_out}" + +# The second numeric column is the rendered average weight. This assertion +# fails on the original regression because calc_percent() left it at zero. +if ! awk '$1 ~ /^[0-9]/ && $2 ~ /^[0-9]/ && ($2 + 0) > 0 { found = 1 } END { exit !found }' \ + "${annotate_out}"; then + echo "Annotation output contained no nonzero weight" + cat "${annotate_out}" + exit 1 +fi + +echo "PEBS annotation weights: PASS"
Signature · 1 line
2.55.0
[email protected]
AI reviewRe: [PATCH v4 1/4] perf tools record: Modernize -W man page
In reply to Andi KleenSashiko has reviewed this patch and found no issues. It looks great!
Quoted 4 lines
Modernize the -W / --weight description in the manpage to cover more cases that are supported now.
Signed-off-by Andi Kleen <[email protected]>
Sashiko has reviewed this patch and found no issues. It looks great!
Signature · 1 line
Sashiko AI review · https://sashiko.dev/#/patchset/[email protected]?part=1
[email protected]
AI reviewRe: [PATCH v4 2/4] perf tools top: Add --weight option
In reply to Andi KleenSashiko has reviewed this patch and found no issues. It looks great!
Quoted 5 lines
Add a -W/--weight option to perf top to collect weights too. Useful with follow on patches.
Assisted-by omp:GPT-5.6-LunaSigned-off-by Andi Kleen <[email protected]>
Sashiko has reviewed this patch and found no issues. It looks great!
Signature · 1 line
Sashiko AI review · https://sashiko.dev/#/patchset/[email protected]?part=2
[email protected]
AI reviewRe: [PATCH v4 4/4] perf tools: Add test for weight annotation
In reply to Andi KleenThank you for your contribution! Sashiko AI review found 1 potential issue(s) to consider: - [Medium] Silent failures on intermediate commands cause test logs to be deleted without error output. --
Thank you for your contribution! Sashiko AI review found 1 potential issue(s) to consider:
- [Medium] Silent failures on intermediate commands cause test logs to be deleted without error output. --
--- Patch [4]: [PATCH v4 4/4] perf tools: Add test for weight annotation --- commit fa7661757e0ece36caeb06128442cf38d097b4dd
Author: Andi Kleen <[email protected]>
perf tools: Add test for weight annotation
This commit adds a shell script test case to verify if the --stdio weight annotation functions correctly.
Quoted 5 lines
tools/perf/tests/shell/annotate_weight.sh new file +0
-0
[ ... ]
tools/perf/tests/shell/annotate_weight.sh line 52
Quoted 10 lines
tools/perf/tests/shell/annotate_weight.sh new file +10
-0+if ! awk '$1 ~ /^[0-9]/ && ($1 + 0) > 0 { found = 1 } END { exit !found }' \ + "${report_out}"; then + echo "[SKIP] PEBS weight sampling produced no nonzero weights" + exit 2 +fi + +perf annotate --stdio -i "${perfdata}" --symbol "${testsym}" \ + > "${annotate_out}" 2> "${record_log}" + +grep -q 'Percent Weight' "${annotate_out}"
[Severity: Medium]
Because the script runs under set -e, will a failure in perf annotate or grep cause the script to exit immediately and trigger the cleanup trap?
If the script aborts here, it appears it will delete the log files without printing any error output, which might mask the failure reason and make debugging difficult.
Quoted 6 lines
tools/perf/tests/shell/annotate_weight.sh new file +6
-0+ +# The second numeric column is the rendered average weight. This assertion +# fails on the original regression because calc_percent() left it at zero. +if ! awk '$1 ~ /^[0-9]/ && $2 ~ /^[0-9]/ && ($2 + 0) > 0 { found = 1 } END { exit !found }' \ + "${annotate_out}"; then + echo "Annotation output contained no nonzero weight"
Signature · 1 line
Sashiko AI review · https://sashiko.dev/#/patchset/[email protected]?part=4
[email protected]
AI reviewRe: [PATCH v4 3/4] perf tools: Add support for displaying weights in annotate
In reply to Andi KleenThank you for your contribution! Sashiko AI review found 4 potential issue(s) to consider: - [Medium] The TUI browser width calculation omits cycle and branch counter widths, leading to visual…
Thank you for your contribution! Sashiko AI review found 4 potential issue(s) to consider:
- [Medium] The TUI browser width calculation omits cycle and branch counter widths, leading to visual truncation.
- [Medium] Toggling weight columns globally freezes the weight mask for all symbols, breaking accurate display.
- [Medium] Use of compile-time host architecture macros breaks cross-platform analysis for weight modes.
- [Low] Typographical error in the --weights command-line option description.
--
--- Patch [3]: [PATCH v4 3/4] perf tools: Add support for displaying weights in annotate --- commit 9eb5862996d191c9f87138b1476aa94808cc5008
Author: Andi Kleen <[email protected]>
perf tools: Add support for displaying weights in annotate
Add support for showing all the three possible per IP weights in annotate. The weights are shown by defaults if any are non zero. This is useful, especially with the new insn lat statistics, but also for all the existing weights.
Add a hotkey to the interactive browser to turn them off (w), as well as a perf annotate command line option.
Quoted 4 lines
tools/perf/builtin-annotate.c +0
-0
[ ... ]
tools/perf/builtin-annotate.c int cmd_annotate(int argc, const char **argv) · line 723
Quoted 6 lines
tools/perf/builtin-annotate.c +2
-0@@ -719,6 +719,8 @@ int cmd_annotate(int argc, const char **argv)OPT_BOOLEAN (0 ,"tui" , &annotate.use_tui,"Use the TUI interface" ), #endifOPT_BOOLEAN (0 ,"stdio" , &annotate.use_stdio,"Use the stdio interface" ), +OPT_BOOLEAN (0 ,"weights" , &symbol_conf.annotate_weight, + "Hide or hide weight columns in annotation. Default show if non zero."),
[Severity: Low]
This isn't a bug, but there is a typo in the help text here. "Hide or hide" should probably be "Show or hide" to match the identical option added to builtin-report.c.
Quoted 4 lines
tools/perf/ui/browsers/annotate.c +0
-0
[ ... ]
tools/perf/ui/browsers/annotate.c static int annotate_browser__run(struct annotate_browser *browser, · line 1100
Quoted 9 lines
tools/perf/ui/browsers/annotate.c +5
-0@@ -1091,6 +1093,15 @@ static int annotate_browser__run(struct annotate_browser *browser, symbol_conf.show_total_period = true;annotation__update_column_widths (notes);continue ; +case 'w' : + symbol_conf.annotate_weight = !symbol_conf.annotate_weight; + symbol_conf.weight_mask_user = true; + symbol_conf.weight_mask = !symbol_conf.annotate_weight ? +0 :sym_hist__weight_mask (annotation__histogram (notes, evsel));
[Severity: Medium]
Does toggling weight columns globally freeze the weight mask for all symbols?
Because symbol_conf is global, when the 'w' hotkey sets symbol_conf.weight_mask_user to true, all subsequently viewed symbols will use the frozen mask from this current symbol.
If a newly opened symbol has different weights (for example, WEIGHT_INSNLAT instead of WEIGHT_WEIGHT), those relevant columns might incorrectly remain hidden.
[ ... ]
tools/perf/ui/browsers/annotate.c int __hist_entry__tui_annotate(struct hist_entry *he, struct map_symbol *ms, · line 1242
Quoted 6 lines
tools/perf/ui/browsers/annotate.c +1
-1@@ -1228,7 +1239,7 @@ int __hist_entry__tui_annotate(struct hist_entry *he, struct map_symbol *ms, browser.b.width = notes->src->widths.max_line_len; browser.b.nr_entries = notes->src->nr_entries; browser.b.entries = ¬es->src->source; - browser.b.width +=18 ;/* Percentage */ + browser.b.width +=annotation__pcnt_width (notes, evsel);
[Severity: Medium]
Could this width calculation result in visual truncation of the TUI browser?
By replacing the hardcoded 18 with annotation__pcnt_width() in __hist_entry__tui_annotate(), the browser width calculation remains strictly bound to the percentage and weight columns. It doesn't appear to make any allowance for the IPC, cycles, or branch counters that might be displayed.
If no weights are present, the padding drops significantly, which might set the horizontal scroll limit too narrow to show the full annotated line.
Quoted 4 lines
tools/perf/util/annotate.c +0
-0
[ ... ]
Quoted 11 lines
tools/perf/util/annotate.c +7
-0@@ -778,6 +797,47 @@ static bool needs_type_info(struct annotated_data_type *data_type)return (data_type != &stackop_type) && (data_type != &canary_type); } +static const char *annotation__weight_mode_str (enum symbol__weight_mode mode) +{ +switch (mode) { +case WEIGHT_NONE : +return "" ; +case WEIGHT_WEIGHT : +return "Weight" ;
tools/perf/util/annotate.c static bool needs_type_info(struct annotated_data_type *data_type) · line 816
Quoted 10 lines
tools/perf/util/annotate.c +10
-0+case WEIGHT_INSNLAT : +return "InsnLat" ; +case WEIGHT_WEIGHT3 : +#ifdef __powerpc__ +return "PCycleLat" ; +#elif defined(__x86_64__) +return "RetireLat" ; +#else +return "Weight3" ; +#endif
[Severity: Medium]
Does using compile-time host architecture macros break cross-platform analysis for weight modes?
If an ARM64 host machine analyzes an x86_64 perf.data file, it will incorrectly display "Weight3" instead of "RetireLat".
Would it be better to dynamically inspect the ELF machine constant (e_machine) via the evsel or session structures instead of relying on host compile-time macros?
Signature · 1 line
Sashiko AI review · https://sashiko.dev/#/patchset/[email protected]?part=3
Namhyung Kim
maintainerRe: [PATCH v4 3/4] perf tools: Add support for displaying weights in annotate
Hi Andi,
Quoted 26 lines · On Tue, Aug 18, 2026 at 11:15:36PM +0000, [email protected] wrote:
Thank you for your contribution! Sashiko AI review found 4 potential issue(s) to consider:
- [Medium] The TUI browser width calculation omits cycle and branch counter widths, leading to visual truncation.
- [Medium] Toggling weight columns globally freezes the weight mask for all symbols, breaking accurate display.
- [Medium] Use of compile-time host architecture macros breaks cross-platform analysis for weight modes.
- [Low] Typographical error in the--weightscommand-line option description.
----- Patch [3]: [PATCH v4 3/4] perf tools: Add support for displaying weights in annotate --- commit
9eb5862996d191c9f87138b1476aa94808cc5008
Author: Andi Kleen <[email protected]>perf tools: Add support for displaying weights in annotate
Add support for showing all the three possible per IP weights in annotate. The weights are shown by defaults if any are non zero. This is useful, especially with the new insn lat statistics, but also for all the existing weights.
Add a hotkey to the interactive browser to turn them off (w), as well as a perf annotate command line option.
Quoted 4 lines
tools/perf/builtin-annotate.c +0
-0[ ... ]
Quoted 11 lines
tools/perf/builtin-annotate.c int cmd_annotate(int argc, const char **argv) · line 723
Quoted 6 lines
tools/perf/builtin-annotate.c +2
-0@@ -719,6 +719,8 @@ int cmd_annotate(int argc, const char **argv)OPT_BOOLEAN (0 ,"tui" , &annotate.use_tui,"Use the TUI interface" ), #endifOPT_BOOLEAN (0 ,"stdio" , &annotate.use_stdio,"Use the stdio interface" ), +OPT_BOOLEAN (0 ,"weights" , &symbol_conf.annotate_weight, + "Hide or hide weight columns in annotation. Default show if non zero."),[Severity: Low]
This isn't a bug, but there is a typo in the help text here. "Hide or hide" should probably be "Show or hide" to match the identical option added tobuiltin-report.c.
Please fix.
Quoted 38 lines
Quoted 5 lines
tools/perf/ui/browsers/annotate.c +0
-0[ ... ]
tools/perf/ui/browsers/annotate.c static int annotate_browser__run(struct annotate_browser *browser, · line 1100
Quoted 9 lines
tools/perf/ui/browsers/annotate.c +5
-0@@ -1091,6 +1093,15 @@ static int annotate_browser__run(struct annotate_browser *browser, symbol_conf.show_total_period = true;annotation__update_column_widths (notes);continue ; +case 'w' : + symbol_conf.annotate_weight = !symbol_conf.annotate_weight; + symbol_conf.weight_mask_user = true; + symbol_conf.weight_mask = !symbol_conf.annotate_weight ? +0 :sym_hist__weight_mask (annotation__histogram (notes, evsel));[Severity: Medium]
Does toggling weight columns globally freeze the weight mask for all symbols?Because
symbol_confis global, when the 'w' hotkey sets symbol_conf.weight_mask_user to true, all subsequently viewed symbols will use the frozen mask from this current symbol.If a newly opened symbol has different weights (for example,
WEIGHT_INSNLATinstead ofWEIGHT_WEIGHT), those relevant columns might incorrectly remain hidden.[ ... ]
tools/perf/ui/browsers/annotate.c int __hist_entry__tui_annotate(struct hist_entry *he, struct map_symbol *ms, · line 1242
Quoted 6 lines
tools/perf/ui/browsers/annotate.c +1
-1@@ -1228,7 +1239,7 @@ int __hist_entry__tui_annotate(struct hist_entry *he, struct map_symbol *ms, browser.b.width = notes->src->widths.max_line_len; browser.b.nr_entries = notes->src->nr_entries; browser.b.entries = ¬es->src->source; - browser.b.width +=18 ;/* Percentage */ + browser.b.width +=annotation__pcnt_width (notes, evsel);[Severity: Medium]
Could this width calculation result in visual truncation of the TUI browser?
Quoted 7 lines
By replacing the hardcoded 18 with
annotation__pcnt_width()in__hist_entry__tui_annotate(), the browser width calculation remains strictly bound to the percentage and weight columns. It doesn't appear to make any allowance for the IPC, cycles, or branch counters that might be displayed.If no weights are present, the padding drops significantly, which might set the horizontal scroll limit too narrow to show the full annotated line.
I don't remember where 18 came from but it seems we need to check different annotation mode like IPC or branch counters with this change.
Quoted 32 lines
Quoted 5 lines
tools/perf/util/annotate.c +0
-0[ ... ]
Quoted 11 lines
tools/perf/util/annotate.c +7
-0@@ -778,6 +797,47 @@ static bool needs_type_info(struct annotated_data_type *data_type)return (data_type != &stackop_type) && (data_type != &canary_type); } +static const char *annotation__weight_mode_str (enum symbol__weight_mode mode) +{ +switch (mode) { +case WEIGHT_NONE : +return "" ; +case WEIGHT_WEIGHT : +return "Weight" ;tools/perf/util/annotate.c static bool needs_type_info(struct annotated_data_type *data_type) · line 816
Quoted 10 lines
tools/perf/util/annotate.c +10
-0+case WEIGHT_INSNLAT : +return "InsnLat" ; +case WEIGHT_WEIGHT3 : +#ifdef __powerpc__ +return "PCycleLat" ; +#elif defined(__x86_64__) +return "RetireLat" ; +#else +return "Weight3" ; +#endif [Severity: Medium]
Does using compile-time host architecture macros break cross-platform analysis for weight modes?
Quoted 6 lines
If an ARM64 host machine analyzes an
x86_64perf.data file, it will incorrectly display "Weight3" instead of "RetireLat".Would it be better to dynamically inspect the ELF machine constant (
e_machine) via the evsel or session structures instead of relying on host compile-time macros?
Right, I think you can pass an evsel and get a session then e_machine from it.
Thanks,
Namhyung
Quoted 3 lines
Signature · 2 lines
-- Sashiko AI review · https://sashiko.dev/#/patchset/[email protected]?part=3