The goal of this change is to achieve consistent output for symbol address.
Before this, the raw ip is printed for non-callchain and dso offset for
callchain. Mostly what we expect is the raw ip.
This patch does two changes:
- Always print raw ip for resolved symbols.
- Add a new 'dsoff' field if we really need the dso offset, and the
offset is appended to dso name.
v2:
o split into two patches.
o do not print offset for unresolved symbols.
Changbin Du (2):
perf script: print raw ip instead of binary offset for callchain
perf: script: add new output field 'dsoff' to print dso offset
tools/perf/Documentation/perf-script.txt | 2 +-
tools/perf/builtin-script.c | 5 +++++
tools/perf/util/evsel_fprintf.c | 15 ++++++++-------
tools/perf/util/evsel_fprintf.h | 1 +
4 files changed, 15 insertions(+), 8 deletions(-)
--
2.25.1
Before this, the raw ip is printed for non-callchain and dso offset for
callchain. This inconsistent output for address may confuse people. And
mostly what we expect is the raw ip.
'dso offset' is printed in callchain:
$ perf script
...
ls 1341034 2739463.008343: 2162417 cycles:
ffffffff99d657a7 [unknown] ([unknown])
ffffffff99e00b67 [unknown] ([unknown])
235d3 memset+0x53 (/usr/lib/x86_64-linux-gnu/ld-2.31.so) # dso offset
a61b _dl_map_object+0x1bb (/usr/lib/x86_64-linux-gnu/ld-2.31.so)
raw ip is printed for non-callchain:
$ perf script -G
...
ls 1341034 2739463.008876: 2053304 cycles: ffffffffc1596923 [unknown] ([unknown])
ls 1341034 2739463.009381: 1917049 cycles: 14def8e149e6 __strcoll_l+0xd96 (/usr/lib/x86_64-linux-gnu/libc-2.31.so) # raw ip
Let's have consistent output for it. Later I'll add a new field 'dsoff' to
print dso offset.
Signed-off-by: Changbin Du <[email protected]>
---
tools/perf/util/evsel_fprintf.c | 9 ++-------
1 file changed, 2 insertions(+), 7 deletions(-)
diff --git a/tools/perf/util/evsel_fprintf.c b/tools/perf/util/evsel_fprintf.c
index bd22c4932d10..1fb8044d402e 100644
--- a/tools/perf/util/evsel_fprintf.c
+++ b/tools/perf/util/evsel_fprintf.c
@@ -153,13 +153,8 @@ int sample__fprintf_callchain(struct perf_sample *sample, int left_alignment,
if (map)
addr = map->map_ip(map, node->ip);
- if (print_ip) {
- /* Show binary offset for userspace addr */
- if (map && !map->dso->kernel)
- printed += fprintf(fp, "%c%16" PRIx64, s, addr);
- else
- printed += fprintf(fp, "%c%16" PRIx64, s, node->ip);
- }
+ if (print_ip)
+ printed += fprintf(fp, "%c%16" PRIx64, s, node->ip);
if (print_sym) {
printed += fprintf(fp, " ");
--
2.25.1
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 <[email protected]>
---
tools/perf/Documentation/perf-script.txt | 2 +-
tools/perf/builtin-script.c | 5 +++++
tools/perf/util/evsel_fprintf.c | 6 ++++++
tools/perf/util/evsel_fprintf.h | 1 +
4 files changed, 13 insertions(+), 1 deletion(-)
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..ccc409893c4b 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,9 @@ 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))
+ output[type].print_ip_opts |= EVSEL__PRINT_DSOFF;
+
if (PRINT_FIELD(SYMOFFSET))
output[type].print_ip_opts |= EVSEL__PRINT_SYMOFFSET;
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);
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;
--
2.25.1
Hello Changbin,
On Thu, Apr 6, 2023 at 10:53 PM Changbin Du <[email protected]> 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 <[email protected]>
> ---
> tools/perf/Documentation/perf-script.txt | 2 +-
> tools/perf/builtin-script.c | 5 +++++
> tools/perf/util/evsel_fprintf.c | 6 ++++++
> tools/perf/util/evsel_fprintf.h | 1 +
> 4 files changed, 13 insertions(+), 1 deletion(-)
>
> 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..ccc409893c4b 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,9 @@ 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))
> + output[type].print_ip_opts |= EVSEL__PRINT_DSOFF;
What if the user gives 'dsoff' without 'dso'. Better to set the
EVSEL__PRINT_DSO as well?
Thanks,
Namhyung
> +
> if (PRINT_FIELD(SYMOFFSET))
> output[type].print_ip_opts |= EVSEL__PRINT_SYMOFFSET;
>
> 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);
> 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;
> --
> 2.25.1
>
On Fri, Apr 07, 2023 at 02:24:48PM -0700, Namhyung Kim wrote:
> Hello Changbin,
>
> On Thu, Apr 6, 2023 at 10:53 PM Changbin Du <[email protected]> wrote:
[snip]
> > @@ -574,6 +576,9 @@ 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))
> > + output[type].print_ip_opts |= EVSEL__PRINT_DSOFF;
>
> What if the user gives 'dsoff' without 'dso'. Better to set the
> EVSEL__PRINT_DSO as well?
>
It will be dropped currently. I will make 'dsoff' implicitly add 'dso' field
later.
> Thanks,
> Namhyung
>
--
Cheers,
Changbin Du