Re: [PATCH v3 2/2] perf: script: add new output field 'dsoff' to print dso offset

From: Adrian Hunter
Date: Tue Apr 11 2023 - 05:16:02 EST

On 10/04/23 10:08, Changbin Du wrote:
> This adds a new 'dsoff' field to print dso offset for resolved symbols,
> and the offset is appended to dso name.
>
> Default output:
> $ perf script
> ls 2695501 3011030.487017: 500000 cycles: 152cc73ef4b5 get_common_indices.constprop.0+0x155 (/usr/lib/x86_64-linux-gnu/ld-2.31.so)
> ls 2695501 3011030.487018: 500000 cycles: ffffffff99045b3e [unknown] ([unknown])
> ls 2695501 3011030.487018: 500000 cycles: ffffffff9968e107 [unknown] ([unknown])
> ls 2695501 3011030.487018: 500000 cycles: ffffffffc1f54afb [unknown] ([unknown])
> ls 2695501 3011030.487018: 500000 cycles: ffffffff9968382f [unknown] ([unknown])
> ls 2695501 3011030.487019: 500000 cycles: ffffffff99e00094 [unknown] ([unknown])
> ls 2695501 3011030.487019: 500000 cycles: 152cc718a8d0 __errno_location@plt+0x0 (/usr/lib/x86_64-linux-gnu/libselinux.so.1)
>
> Display 'dsoff' field:
> $ perf script -F +dsoff
> ls 2695501 3011030.487017: 500000 cycles: 152cc73ef4b5 get_common_indices.constprop.0+0x155 (/usr/lib/x86_64-linux-gnu/ld-2.31.so+0x1c4b5)
> ls 2695501 3011030.487018: 500000 cycles: ffffffff99045b3e [unknown] ([unknown])
> ls 2695501 3011030.487018: 500000 cycles: ffffffff9968e107 [unknown] ([unknown])
> ls 2695501 3011030.487018: 500000 cycles: ffffffffc1f54afb [unknown] ([unknown])
> ls 2695501 3011030.487018: 500000 cycles: ffffffff9968382f [unknown] ([unknown])
> ls 2695501 3011030.487019: 500000 cycles: ffffffff99e00094 [unknown] ([unknown])
> ls 2695501 3011030.487019: 500000 cycles: 152cc718a8d0 __errno_location@plt+0x0 (/usr/lib/x86_64-linux-gnu/libselinux.so.1+0x68d0)
> ls 2695501 3011030.487019: 500000 cycles: ffffffff992a6db0 [unknown] ([unknown])
>
> Signed-off-by: Changbin Du <changbin.du@xxxxxxxxxx>
> ---
> tools/perf/Documentation/perf-script.txt | 2 +-
> tools/perf/builtin-script.c | 9 ++++++++-
> tools/perf/util/evsel_fprintf.c | 6 ++++++
> tools/perf/util/evsel_fprintf.h | 1 +
> 4 files changed, 16 insertions(+), 2 deletions(-)
>
> diff --git a/tools/perf/Documentation/perf-script.txt b/tools/perf/Documentation/perf-script.txt
> index 777a0d8ba7d1..ff9a52e44688 100644
> --- a/tools/perf/Documentation/perf-script.txt
> +++ b/tools/perf/Documentation/perf-script.txt
> @@ -130,7 +130,7 @@ OPTIONS
> -F::
> --fields::
> Comma separated list of fields to print. Options are:
> - comm, tid, pid, time, cpu, event, trace, ip, sym, dso, addr, symoff,
> + comm, tid, pid, time, cpu, event, trace, ip, sym, dso, dsoff, addr, symoff,
> srcline, period, iregs, uregs, brstack, brstacksym, flags, bpf-output,
> brstackinsn, brstackinsnlen, brstackoff, callindent, insn, insnlen, synth,
> phys_addr, metric, misc, srccode, ipc, data_page_size, code_page_size, ins_lat,
> diff --git a/tools/perf/builtin-script.c b/tools/perf/builtin-script.c
> index a792214d1af8..bdc5de94cf43 100644
> --- a/tools/perf/builtin-script.c
> +++ b/tools/perf/builtin-script.c
> @@ -133,6 +133,7 @@ enum perf_output_field {
> PERF_OUTPUT_VCPU = 1ULL << 38,
> PERF_OUTPUT_CGROUP = 1ULL << 39,
> PERF_OUTPUT_RETIRE_LAT = 1ULL << 40,
> + PERF_OUTPUT_DSOFF = 1ULL << 41,
> };
>
> struct perf_script {
> @@ -174,6 +175,7 @@ struct output_option {
> {.str = "ip", .field = PERF_OUTPUT_IP},
> {.str = "sym", .field = PERF_OUTPUT_SYM},
> {.str = "dso", .field = PERF_OUTPUT_DSO},
> + {.str = "dsoff", .field = PERF_OUTPUT_DSOFF},
> {.str = "addr", .field = PERF_OUTPUT_ADDR},
> {.str = "symoff", .field = PERF_OUTPUT_SYMOFFSET},
> {.str = "srcline", .field = PERF_OUTPUT_SRCLINE},
> @@ -574,6 +576,11 @@ static void set_print_ip_opts(struct perf_event_attr *attr)
> if (PRINT_FIELD(DSO))
> output[type].print_ip_opts |= EVSEL__PRINT_DSO;
>
> + if (PRINT_FIELD(DSOFF)) {
> + /* 'dsoff' implys 'dso' field for printing */
> + output[type].print_ip_opts |= EVSEL__PRINT_DSO | EVSEL__PRINT_DSOFF;
> + }
> +
> if (PRINT_FIELD(SYMOFFSET))
> output[type].print_ip_opts |= EVSEL__PRINT_SYMOFFSET;
>
> @@ -3881,7 +3888,7 @@ int cmd_script(int argc, const char **argv)
> "comma separated output fields prepend with 'type:'. "
> "+field to add and -field to remove."
> "Valid types: hw,sw,trace,raw,synth. "
> - "Fields: comm,tid,pid,time,cpu,event,trace,ip,sym,dso,"
> + "Fields: comm,tid,pid,time,cpu,event,trace,ip,sym,dso,dsoff"
> "addr,symoff,srcline,period,iregs,uregs,brstack,"
> "brstacksym,flags,data_src,weight,bpf-output,brstackinsn,"
> "brstackinsnlen,brstackoff,callindent,insn,insnlen,synth,"
> diff --git a/tools/perf/util/evsel_fprintf.c b/tools/perf/util/evsel_fprintf.c
> index 1fb8044d402e..ae8333772c76 100644
> --- a/tools/perf/util/evsel_fprintf.c
> +++ b/tools/perf/util/evsel_fprintf.c
> @@ -116,6 +116,7 @@ int sample__fprintf_callchain(struct perf_sample *sample, int left_alignment,
> int print_ip = print_opts & EVSEL__PRINT_IP;
> int print_sym = print_opts & EVSEL__PRINT_SYM;
> int print_dso = print_opts & EVSEL__PRINT_DSO;
> + int print_dsoff = print_opts & EVSEL__PRINT_DSOFF;
> int print_symoffset = print_opts & EVSEL__PRINT_SYMOFFSET;
> int print_oneline = print_opts & EVSEL__PRINT_ONELINE;
> int print_srcline = print_opts & EVSEL__PRINT_SRCLINE;
> @@ -174,6 +175,8 @@ int sample__fprintf_callchain(struct perf_sample *sample, int left_alignment,
> if (print_dso && (!sym || !sym->inlined)) {
> printed += fprintf(fp, " (");
> printed += map__fprintf_dsoname(map, fp);
> + if (print_dsoff && map && map->dso)
> + printed += fprintf(fp, "+0x%lx", addr);
> printed += fprintf(fp, ")");
> }
>
> @@ -209,6 +212,7 @@ int sample__fprintf_sym(struct perf_sample *sample, struct addr_location *al,
> int print_ip = print_opts & EVSEL__PRINT_IP;
> int print_sym = print_opts & EVSEL__PRINT_SYM;
> int print_dso = print_opts & EVSEL__PRINT_DSO;
> + int print_dsoff = print_opts & EVSEL__PRINT_DSOFF;
> int print_symoffset = print_opts & EVSEL__PRINT_SYMOFFSET;
> int print_srcline = print_opts & EVSEL__PRINT_SRCLINE;
> int print_unknown_as_addr = print_opts & EVSEL__PRINT_UNKNOWN_AS_ADDR;
> @@ -237,6 +241,8 @@ int sample__fprintf_sym(struct perf_sample *sample, struct addr_location *al,
> if (print_dso) {
> printed += fprintf(fp, " (");
> printed += map__fprintf_dsoname(al->map, fp);
> + if (print_dsoff && al->map && al->map->dso)
> + printed += fprintf(fp, "+0x%lx", al->addr);

There are a lot of map__fprintf_dsoname() callers that should
also support "dsoff". In fact, probably all of them except
perf_sample__fprintf_callindent().

> printed += fprintf(fp, ")");
> }
>
> diff --git a/tools/perf/util/evsel_fprintf.h b/tools/perf/util/evsel_fprintf.h
> index 3093d096c29f..c8a9fac2f2dd 100644
> --- a/tools/perf/util/evsel_fprintf.h
> +++ b/tools/perf/util/evsel_fprintf.h
> @@ -26,6 +26,7 @@ int evsel__fprintf(struct evsel *evsel, struct perf_attr_details *details, FILE
> #define EVSEL__PRINT_UNKNOWN_AS_ADDR (1<<6)
> #define EVSEL__PRINT_CALLCHAIN_ARROW (1<<7)
> #define EVSEL__PRINT_SKIP_IGNORED (1<<8)
> +#define EVSEL__PRINT_DSOFF (1<<9)
>
> struct addr_location;
> struct perf_event_attr;