Add a libdw addr2line implementation
Ian Rogers
reviewerv2 cover Add a libdw addr2line implementation
addr2line is a performance bottleneck in perf, add a libdw based implementation that avoids forking addr2line and caches the decoded debug information.
Allow the addr2line implementation to be picked via the configuration file or --addr2line-style with perf report.
Test/fix that inline callchains are properly displayed by perf script.
v2: Fix bias issue with libdwfl functions. Use cu_walk_functions_at
from perf's dwarf-aux to fully walk inline functions. Add testing that inlined functions are shown in the perf script srcline callchain information. Add configurability as to which addr2line style to use.
v1: https://lore.kernel.org/lkml/[email protected]/
Ian Rogers (6):
perf addr2line: Add a libdw implementation
perf addr2line.c: Rename a2l_style to cmd_a2l_style perf srcline: Add configuration support for the addr2line style perf callchain: Fix srcline printing with inlines perf test workload: Add inlineloop test workload
perf test: Test addr2line unwinding works with inline functions
tools/perf/builtin-report.c | 10 ++ tools/perf/tests/builtin-test.c | 1 + tools/perf/tests/shell/addr2line_inlines.sh | 47 +++++++ tools/perf/tests/tests.h | 1 + tools/perf/tests/workloads/Build | 2 + tools/perf/tests/workloads/inlineloop.c | 52 +++++++ tools/perf/util/Build | 1 + tools/perf/util/addr2line.c | 20 +-- tools/perf/util/config.c | 4 + tools/perf/util/dso.c | 2 + tools/perf/util/dso.h | 11 ++ tools/perf/util/evsel_fprintf.c | 8 +- tools/perf/util/libdw.c | 148 ++++++++++++++++++++ tools/perf/util/libdw.h | 60 ++++++++ tools/perf/util/srcline.c | 116 +++++++++++++-- tools/perf/util/srcline.h | 3 + tools/perf/util/symbol_conf.h | 10 ++ 17 files changed, 476 insertions(+), 20 deletions(-) create mode 100755 tools/perf/tests/shell/addr2line_inlines.sh create mode 100644 tools/perf/tests/workloads/inlineloop.c create mode 100644 tools/perf/util/libdw.c create mode 100644 tools/perf/util/libdw.h
Signature · 1 line
2.52.0.457.g6b5491de43-goog
Ian Rogers
reviewerPATCH v2 1/6 perf addr2line: Add a libdw implementation
Add an implementation of addr2line that uses libdw. Other addr2line implementations are slow, particularly in the case of forking addr2line. Add an implementation that caches the libdw information in the dso and uses it to find the file and line number information. Inline information is supported but because cu_walk_functions_at visits the leaf function last add a inline_list__append_tail to reverse the lists order.
--- tools/perf/util/Build | 1 + tools/perf/util/dso.c | 2 + tools/perf/util/dso.h | 11 +++ tools/perf/util/libdw.c | 148 ++++++++++++++++++++++++++++++++++++++ tools/perf/util/libdw.h | 60 ++++++++++++++++ tools/perf/util/srcline.c | 24 +++++++ tools/perf/util/srcline.h | 1 + 7 files changed, 247 insertions(+) create mode 100644 tools/perf/util/libdw.c create mode 100644 tools/perf/util/libdw.h
tools/perf/util/Build +1 -0
@@ -224,6 +224,7 @@ perf-util-$(CONFIG_LIBDW) += dwarf-regs-powerpc.o perf-util-$(CONFIG_LIBDW) += dwarf-regs-x86.o perf-util-$(CONFIG_LIBDW) += debuginfo.o perf-util-$(CONFIG_LIBDW) += annotate-data.o +perf-util-$(CONFIG_LIBDW) += libdw.o perf-util-$(CONFIG_LIBDW_DWARF_UNWIND) += unwind-libdw.o perf-util-$(CONFIG_LOCAL_LIBUNWIND) += unwind-libunwind-local.o
tools/perf/util/dso.c +2 -0
@@ -32,6 +32,7 @@#include "string2.h" #include "vdso.h" #include "annotate-data.h" +#include "libdw.h" static const char *const debuglink_paths[] = {"%.0s%s" ,
@@ -1605,6 +1606,7 @@ void dso__delete(struct dso *dso)auxtrace_cache__free (RC_CHK_ACCESS (dso)->auxtrace_cache);dso_cache__free (dso);dso__free_a2l (dso); +dso__free_a2l_libdw (dso);dso__free_symsrc_filename (dso);nsinfo__zput (RC_CHK_ACCESS (dso)->nsinfo);mutex_destroy (dso__lock (dso));
tools/perf/util/dso.h +11 -0
@@ -268,6 +268,7 @@ DECLARE_RC_STRUCT(dso) {const char *short_name;const char *long_name;void *a2l; +void *a2l_libdw;char *symsrc_filename;#if defined(__powerpc__)void *dwfl;/* DWARF debug info */
@@ -334,6 +335,16 @@ static inline void dso__set_a2l(struct dso *dso, void *val)RC_CHK_ACCESS (dso)->a2l = val; } +static inline void *dso__a2l_libdw (const struct dso *dso) +{ +return RC_CHK_ACCESS (dso)->a2l_libdw; +} + +static inline void dso__set_a2l_libdw (struct dso *dso,void *val) +{ +RC_CHK_ACCESS (dso)->a2l_libdw = val; +} +static inline unsigned int dso__a2l_fails (const struct dso *dso) {return RC_CHK_ACCESS (dso)->a2l_fails;
tools/perf/util/libdw.c new file +148 -0
148 lines not on this page · raw message
tools/perf/util/libdw.h new file +60 -0
60 lines not on this page · raw message
tools/perf/util/srcline.c +24 -0
@@ -6,6 +6,7 @@#include "libbfd.h" #include "llvm.h" #include "symbol.h" +#include "libdw.h" #include <inttypes.h> #include <string.h>
@@ -51,6 +52,25 @@ int inline_list__append(struct symbol *symbol, char *srcline, struct inline_nodereturn 0 ; } +int inline_list__append_tail (struct symbol *symbol,char *srcline,struct inline_node *node) +{ +struct inline_list *ilist; + + ilist =zalloc (sizeof (*ilist)); +if (ilist ==NULL ) +return -1 ; + + ilist->symbol = symbol; + ilist->srcline = srcline; + +if (callchain_param.order ==ORDER_CALLEE ) +list_add (&ilist->list, &node->val); +else +list_add_tail (&ilist->list, &node->val); + +return 0 ; +} +/* basename version that takes a const input string */ static const char *gnu_basename (const char *path) {
@@ -120,6 +140,10 @@ static int addr2line(const char *dso_name, u64 addr, char **file, unsigned int * {int ret; + ret =libdw__addr2line (dso_name, addr, file, line_nr, dso, unwind_inlines, node, sym); +if (ret >0 ) +return ret; + ret =llvm__addr2line (dso_name, addr, file, line_nr, dso, unwind_inlines, node, sym);if (ret >0 )return ret;
tools/perf/util/srcline.h +1 -0
@@ -57,6 +57,7 @@ struct inline_node *inlines__tree_find(struct rb_root_cached *tree, u64 addr);void inlines__tree_delete (struct rb_root_cached *tree);int inline_list__append (struct symbol *symbol,char *srcline,struct inline_node *node); +int inline_list__append_tail (struct symbol *symbol,char *srcline,struct inline_node *node);char *srcline_from_fileline (const char *file,unsigned int line); struct symbol *new_inline_sym(struct dso *dso, struct symbol *base_sym,
Signature · 1 line
2.52.0.457.g6b5491de43-goog
Ian Rogers
reviewerPATCH v2 2/6 perf addr2line.c: Rename a2l_style to cmd_a2l_style
In reply to Ian RogersThe a2l_style is only relevant to the command line version, so rename to make this clearer.
--- tools/perf/util/addr2line.c | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-)
tools/perf/util/addr2line.c +10 -10
@@ -90,16 +90,16 @@ static struct child_process *addr2line_subprocess_init(const char *addr2line_patreturn a2l; } -enum a2l_style { +enum cmd_a2l_style {BROKEN ,GNU_BINUTILS ,LLVM , }; -static enum a2l_style addr2line_configure (struct child_process *a2l,const char *dso_name) +static enum cmd_a2l_style cmd_addr2line_configure (struct child_process *a2l,const char *dso_name) {static bool cached; -static enum a2l_style style; +static enum cmd_a2l_style style;if (!cached) {char buf[128 ];
@@ -149,7 +149,7 @@ static enum a2l_style addr2line_configure(struct child_process *a2l, const char } static int read_addr2line_record(struct io *io, - enum a2l_style style, + enum cmd_a2l_style style, const char *dso_name, u64 addr, bool first,
@@ -298,7 +298,7 @@ int cmd__addr2line(const char *dso_name, u64 addr,char buf[128 ];ssize_t written;struct io io = { .eof = false }; -enum a2l_style a2l_style; +enum cmd_a2l_style cmd_a2l_style;if (!a2l) {if (!filename__has_section (dso_name,".debug_line" ))
@@ -314,8 +314,8 @@ int cmd__addr2line(const char *dso_name, u64 addr,pr_warning ("%s %s: addr2line_subprocess_init failed\n" , __func__, dso_name); goto out; } - a2l_style =addr2line_configure (a2l, dso_name); -if (a2l_style ==BROKEN ) + cmd_a2l_style =cmd_addr2line_configure (a2l, dso_name); +if (cmd_a2l_style ==BROKEN ) goto out;/*
@@ -336,7 +336,7 @@ int cmd__addr2line(const char *dso_name, u64 addr, }io__init (&io, a2l->out, buf,sizeof (buf)); io.timeout_ms = addr2line_timeout_ms; -switch (read_addr2line_record (&io, a2l_style, dso_name, addr,/*first=*/ true, +switch (read_addr2line_record (&io, cmd_a2l_style, dso_name, addr,/*first=*/ true, &record_function, &record_filename, &record_line_nr)) {case -1 :if (!symbol_conf.disable_add2line_warn)
@@ -351,7 +351,7 @@ int cmd__addr2line(const char *dso_name, u64 addr,* binutils, also force a non-zero address as we're no longer * reading that record. */ -switch (read_addr2line_record (&io, a2l_style, dso_name, +switch (read_addr2line_record (&io, cmd_a2l_style, dso_name,/*addr=*/ 1 ,/*first=*/ true,NULL ,NULL ,NULL )) {case -1 :
@@ -397,7 +397,7 @@ int cmd__addr2line(const char *dso_name, u64 addr,* as we're reading records beyond the first. */ while ((record_status = read_addr2line_record(&io, - a2l_style, + cmd_a2l_style, dso_name, /*addr=*/1, /*first=*/false,
Signature · 1 line
2.52.0.457.g6b5491de43-goog
Ian Rogers
reviewerPATCH v2 3/6 perf srcline: Add configuration support for the addr2line style
In reply to Ian RogersAllow the addr2line style to be specified on the perf report command line or in the .perfconfig file.
--- tools/perf/builtin-report.c | 10 ++++ tools/perf/util/config.c | 4 ++ tools/perf/util/srcline.c | 98 +++++++++++++++++++++++++++++++---- tools/perf/util/srcline.h | 2 + tools/perf/util/symbol_conf.h | 10 ++++ 5 files changed, 113 insertions(+), 11 deletions(-)
tools/perf/builtin-report.c +10 -0
@@ -1271,6 +1271,13 @@ parse_percent_limit(const struct option *opt, const char *str,return 0 ; } +static int +report_parse_addr2line_config (const struct option *opt__maybe_unused , +const char *arg,int unset__maybe_unused ) +{ +return addr2line_configure ("addr2line.style" , arg,NULL ); +} +static int process_attr (const struct perf_tool *tool__maybe_unused ,union perf_event *event,struct evlist **pevlist)
@@ -1447,6 +1454,9 @@ int cmd_report(int argc, const char **argv) "objdump binary to use for disassembly and annotations"),OPT_STRING (0 ,"addr2line" , &addr2line_path,"path" ,"addr2line binary to use for line numbers" ), +OPT_CALLBACK (0 ,"addr2line-style" ,NULL ,"addr2line style" , +"addr2line styles (libdw,llvm,libbfd,addr2line)" , + report_parse_addr2line_config),OPT_BOOLEAN (0 ,"demangle" , &symbol_conf.demangle,"Symbol demangling. Enabled by default, use --no-demangle to disable." ), OPT_BOOLEAN(0, "demangle-kernel", &symbol_conf.demangle_kernel,
tools/perf/util/config.c +4 -0
@@ -20,6 +20,7 @@#include "util/stat.h" /* perf_stat__set_big_num */ #include "util/evsel.h" /* evsel__hw_names, evsel__use_bpf_counters */ #include "util/addr2line.h" /* addr2line_timeout_ms */ +#include "srcline.h" #include "build-id.h" #include "debug.h" #include "config.h"
@@ -519,6 +520,9 @@ int perf_default_config(const char *var, const char *value,if (strstarts (var,"stat." ))return perf_stat_config (var, value); +if (strstarts (var,"addr2line." )) +return addr2line_configure (var, value, dummy); +/* Add other config variables here. */ return 0 ; }
tools/perf/util/srcline.c +87 -11
117 lines not on this page · raw message
tools/perf/util/srcline.h +2 -0
@@ -63,4 +63,6 @@ struct symbol *new_inline_sym(struct dso *dso,struct symbol *base_sym, const char *funcname); +int addr2line_configure (const char *var,const char *value,void *cb); +#endif /* PERF_SRCLINE_H */
tools/perf/util/symbol_conf.h +10 -0
@@ -9,6 +9,15 @@struct strlist ;struct intlist ; +enum a2l_style { +A2L_STYLE_UNKNOWN =0 , +A2L_STYLE_LIBDW , +A2L_STYLE_LLVM , +A2L_STYLE_LIBBFD , +A2L_STYLE_CMD , +}; +#define MAX_A2L_STYLE (A2L_STYLE_CMD + 1) +struct symbol_conf {bool nanosecs;unsigned short priv_size;
@@ -70,6 +79,7 @@ struct symbol_conf { *col_width_list_str, *bt_stop_list_str;const char *addr2line_path; +enum a2l_style addr2line_style[MAX_A2L_STYLE ];unsigned long time_quantum;struct strlist *dso_list, *comm_list,
Signature · 1 line
2.52.0.457.g6b5491de43-goog
Ian Rogers
reviewerPATCH v2 4/6 perf callchain: Fix srcline printing with inlines
In reply to Ian Rogerssample__fprintf_callchain was using map__fprintf_srcline which won't report inline line numbers. Fix by using the srcline from the callchain and falling back to the map variant.
--- tools/perf/util/evsel_fprintf.c | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-)
tools/perf/util/evsel_fprintf.c +6 -2
@@ -185,8 +185,12 @@ int sample__fprintf_callchain(struct perf_sample *sample, int left_alignment,if (print_dso && (!sym || !sym->inlined)) printed +=map__fprintf_dsoname_dsoff (map, print_dsoff, addr, fp); -if (print_srcline) - printed +=map__fprintf_srcline (map, addr,"\n " , fp); +if (print_srcline) { +if (node->srcline) + printed +=fprintf (fp,"\n %s" , node->srcline); +else + printed +=map__fprintf_srcline (map, addr,"\n " , fp); + }if (sym && sym->inlined) printed +=fprintf (fp," (inlined)" );
Signature · 1 line
2.52.0.457.g6b5491de43-goog
Ian Rogers
reviewerPATCH v2 5/6 perf test workload: Add inlineloop test workload
In reply to Ian RogersThe purpose of this workload is to gather samples in an inlined function. This can be used to test whether inlined addr2line works correctly.
--- tools/perf/tests/builtin-test.c | 1 + tools/perf/tests/tests.h | 1 + tools/perf/tests/workloads/Build | 2 + tools/perf/tests/workloads/inlineloop.c | 52 +++++++++++++++++++++++++ 4 files changed, 56 insertions(+) create mode 100644 tools/perf/tests/workloads/inlineloop.c
tools/perf/tests/builtin-test.c +1 -0
@@ -153,6 +153,7 @@ static struct test_workload *workloads[] = { &workload__datasym, &workload__landlock, &workload__traploop, + &workload__inlineloop, };#define workloads__for_each (workload) \
tools/perf/tests/tests.h +1 -0
@@ -240,6 +240,7 @@ DECLARE_WORKLOAD(brstack);DECLARE_WORKLOAD (datasym);DECLARE_WORKLOAD (landlock);DECLARE_WORKLOAD (traploop); +DECLARE_WORKLOAD (inlineloop);extern const char *dso_to_test;extern const char *test_objdump_path;
tools/perf/tests/workloads/Build +2 -0
@@ -8,9 +8,11 @@ perf-test-y += brstack.o perf-test-y += datasym.o perf-test-y += landlock.o perf-test-y += traploop.o +perf-test-y += inlineloop.o CFLAGS_sqrtloop.o = -g -O0 -fno-inline -U_FORTIFY_SOURCE CFLAGS_leafloop.o = -g -O0 -fno-inline -fno-omit-frame-pointer -U_FORTIFY_SOURCE CFLAGS_brstack.o = -g -O0 -fno-inline -U_FORTIFY_SOURCE CFLAGS_datasym.o = -g -O0 -fno-inline -U_FORTIFY_SOURCE CFLAGS_traploop.o = -g -O0 -fno-inline -U_FORTIFY_SOURCE +CFLAGS_inlineloop.o = -g -O2
tools/perf/tests/workloads/inlineloop.c new file +52 -0
52 lines not on this page · raw message
Signature · 1 line
2.52.0.457.g6b5491de43-goog
Ian Rogers
reviewerPATCH v2 6/6 perf test: Test addr2line unwinding works with inline functions
In reply to Ian RogersAdd a test that seeks to see inline functions correctly displayed in perf script from the inlineloop workload.
--- tools/perf/tests/shell/addr2line_inlines.sh | 47 +++++++++++++++++++++ 1 file changed, 47 insertions(+) create mode 100755 tools/perf/tests/shell/addr2line_inlines.sh
tools/perf/tests/shell/addr2line_inlines.sh new file +47 -0
@@ -0,0 +1,47 @@ +#!/bin/bash +# test addr2line inline unwinding +# SPDX-License-Identifier: GPL-2.0 + +set -e + +err=0 +test_dir=$(mktemp -d /tmp/perf-test-inline-addr2line.XXXXXXXXXX) +perf_data="${test_dir}/perf.data" +perf_script_txt="${test_dir}/perf_script.txt" + +cleanup() { + rm -rf "${test_dir}" + trap - EXIT TERM INT +} + +trap_cleanup() { + echo "Unexpected signal in ${FUNCNAME[1]}" + cleanup + exit 1 +} +trap trap_cleanup EXIT TERM INT + +test_inlinedloop() { + echo "Inline unwinding verification test" + # Record data. Currently only dwarf callchains support inlined functions. + perf record --call-graph dwarf -e task-clock:u -o "${perf_data}" -- perf test -w inlineloop 1 + + # Check output with inline (default) and srcline + perf script -i "${perf_data}" --fields +srcline > "${perf_script_txt}" + + # Expect the leaf and middle functions to occur on lines in the 20s, with + # the non-inlined parent function on a line in the 30s. + if grep -q "inlineloop.c:2. (inlined)" "${perf_script_txt}" && + grep -q "inlineloop.c:3.$" "${perf_script_txt}" + then + echo "Inline unwinding verification test [Success]" + else + echo "Inline unwinding verification test [Failed missing inlined functions]" + err=1 + fi +} + +test_inlinedloop + +cleanup +exit $err
Signature · 1 line
2.52.0.457.g6b5491de43-goog