perf: script: use capstone to show disassembly instructions for samples
cover perf: script: use capstone to show disassembly instructions for samples
Currently, the instructions of samples are shown as raw hex strings which are hard to read. x86 has a special option '--xed' to disassemble the hex string via intel XED.
Here we use capstone as our disassembly engine to do that. We select libcapstone because capstone can provide more insn details.
The improvements compared to xed:
* support arm, arm64, x86-32, x86_64 (more could be supported), xed only for x86_64.
* immediate address operands are shown as symbol+offs.
Before:
$ sudo perf script --insn-trace perf 17423 [000] 423271.557970005: 7f2d95f16217 __GI___ioctl+0x7 (/lib/x86_64-linux-gnu/libc-2.27.so) insn: 48 3d 01 f0 ff ff perf 17423 [000] 423271.557970005: 7f2d95f1621d __GI___ioctl+0xd (/lib/x86_64-linux-gnu/libc-2.27.so) insn: 73 01 perf 17423 [000] 423271.557970338: 7f2d95f1621f __GI___ioctl+0xf (/lib/x86_64-linux-gnu/libc-2.27.so) insn: c3 perf 17423 [000] 423271.557970338: 5593ad3346d7 perf_evsel__enable_cpu+0x97 (/work/linux/tools/perf/perf) insn: 85 c0 perf 17423 [000] 423271.557970338: 5593ad3346d9 perf_evsel__enable_cpu+0x99 (/work/linux/tools/perf/perf) insn: 75 12 perf 17423 [000] 423271.557970338: 5593ad3346db perf_evsel__enable_cpu+0x9b (/work/linux/tools/perf/perf) insn: 49 8b 84 24 a8 00 00 00 perf 17423 [000] 423271.557970338: 5593ad3346e3 perf_evsel__enable_cpu+0xa3 (/work/linux/tools/perf/perf) insn: 48 8b 50 20
After:
$ sudo perf script --insn-trace perf 17423 [000] 423271.557970005: 7f2d95f16217 __GI___ioctl+0x7 (/lib/x86_64-linux-gnu/libc-2.27.so) insn: cmpq $-0xfff, %rax perf 17423 [000] 423271.557970005: 7f2d95f1621d __GI___ioctl+0xd (/lib/x86_64-linux-gnu/libc-2.27.so) insn: jae __GI___ioctl+0x10 perf 17423 [000] 423271.557970338: 7f2d95f1621f __GI___ioctl+0xf (/lib/x86_64-linux-gnu/libc-2.27.so) insn: retq perf 17423 [000] 423271.557970338: 5593ad3346d7 perf_evsel__enable_cpu+0x97 (/work/linux/tools/perf/perf) insn: testl %eax, %eax perf 17423 [000] 423271.557970338: 5593ad3346d9 perf_evsel__enable_cpu+0x99 (/work/linux/tools/perf/perf) insn: jne perf_evsel__enable_cpu+0xad perf 17423 [000] 423271.557970338: 5593ad3346db perf_evsel__enable_cpu+0x9b (/work/linux/tools/perf/perf) insn: movq 0xa8(%r12), %rax perf 17423 [000] 423271.557970338: 5593ad3346e3 perf_evsel__enable_cpu+0xa3 (/work/linux/tools/perf/perf) insn: movq 0x20(%rax), %rdx perf 17423 [000] 423271.557970338: 5593ad3346e7 perf_evsel__enable_cpu+0xa7 (/work/linux/tools/perf/perf) insn: cmpl %edx, %ebx
Changbin Du (3):
perf: build: introduce the libcapstone
perf: script: use capstone disasm engine to show disassembly
instructions
perf: script: Deprecate the '--xed' option
tools/build/Makefile.feature | 2 + tools/build/feature/Makefile | 4 + tools/build/feature/test-all.c | 4 + tools/build/feature/test-libcapstone.c | 11 ++ tools/perf/Documentation/build-xed.txt | 19 ---- tools/perf/Documentation/perf-intel-pt.txt | 17 +-- tools/perf/Documentation/perf-script.txt | 5 +- tools/perf/Documentation/tips.txt | 2 +- tools/perf/Makefile.config | 21 ++++ tools/perf/Makefile.perf | 3 + tools/perf/builtin-script.c | 15 +-- tools/perf/ui/browsers/res_sample.c | 2 +- tools/perf/ui/browsers/scripts.c | 4 +- tools/perf/util/Build | 1 + tools/perf/util/print_insn.c | 126 +++++++++++++++++++++ tools/perf/util/print_insn.h | 13 +++ 16 files changed, 201 insertions(+), 48 deletions(-) create mode 100644 tools/build/feature/test-libcapstone.c delete mode 100644 tools/perf/Documentation/build-xed.txt create mode 100644 tools/perf/util/print_insn.c create mode 100644 tools/perf/util/print_insn.h
Signature · 1 line
2.17.1
PATCH 1/3 perf: build: introduce the libcapstone
Later we will use libcapstone to disassemble instructions of samples.
--- tools/build/Makefile.feature | 2 ++ tools/build/feature/Makefile | 4 ++++ tools/build/feature/test-all.c | 4 ++++ tools/build/feature/test-libcapstone.c | 11 +++++++++++ tools/perf/Makefile.config | 21 +++++++++++++++++++++ tools/perf/Makefile.perf | 3 +++ 6 files changed, 45 insertions(+) create mode 100644 tools/build/feature/test-libcapstone.c
tools/build/Makefile.feature +2 -0
@@ -84,6 +84,7 @@ FEATURE_TESTS_EXTRA := \ gtk2-infobar \ hello \ libbabeltrace \ + libcapstone \ libbfd-liberty \ libbfd-liberty-z \ libopencsd \
@@ -130,6 +131,7 @@ FEATURE_DISPLAY ?= \ libcrypto \ libunwind \ libdw-dwarf-unwind \ + libcapstone \ zlib \ lzma \ get_cpuid \
tools/build/feature/Makefile +4 -0
@@ -52,6 +52,7 @@ FILES= \ test-timerfd.bin \ test-libdw-dwarf-unwind.bin \ test-libbabeltrace.bin \ + test-libcapstone.bin \ test-compile-32.bin \ test-compile-x32.bin \ test-zlib.bin \
@@ -280,6 +281,9 @@ $(OUTPUT)test-libdw-dwarf-unwind.bin: $(OUTPUT)test-libbabeltrace.bin: $(BUILD) # -lbabeltrace provided by $(FEATURE_CHECK_LDFLAGS-libbabeltrace) +$(OUTPUT)test-libcapstone.bin: + $(BUILD) # -lcapstone provided by $(FEATURE_CHECK_LDFLAGS-libcapstone) + $(OUTPUT)test-compile-32.bin: $(CC) -m32 -o $@ test-compile.c
tools/build/feature/test-all.c +4 -0
@@ -130,6 +130,10 @@#undef main#endif +#define main main_test_libcapstone +# include "test-libcapstone.c" +#undef main +#define main main_test_lzma# include "test-lzma.c" #undef main
tools/build/feature/test-libcapstone.c new file +11 -0
@@ -0,0 +1,11 @@ +// SPDX-License-Identifier: GPL-2.0 + +#include <capstone/capstone.h> + +int main (void ) +{ +csh handle; + +cs_open (CS_ARCH_X86 ,CS_MODE_64 , &handle); +return 0 ; +}
tools/perf/Makefile.config +21 -0
@@ -180,6 +180,15 @@ endif FEATURE_CHECK_CFLAGS-libbabeltrace := $(LIBBABELTRACE_CFLAGS) FEATURE_CHECK_LDFLAGS-libbabeltrace := $(LIBBABELTRACE_LDFLAGS) -lbabeltrace-ctf +# for linking with debug library, run like: +# make DEBUG=1 LIBCAPSTONE_DIR=/opt/capstone/ +ifdef LIBCAPSTONE_DIR + LIBCAPSTONE_CFLAGS := -I$(LIBCAPSTONE_DIR)/include + LIBCAPSTONE_LDFLAGS := -L$(LIBCAPSTONE_DIR)/ +endif +FEATURE_CHECK_CFLAGS-libcapstone := $(LIBCAPSTONE_CFLAGS) +FEATURE_CHECK_LDFLAGS-libcapstone := $(LIBCAPSTONE_LDFLAGS) -lcapstone + ifdef LIBZSTD_DIR LIBZSTD_CFLAGS := -I$(LIBZSTD_DIR)/lib LIBZSTD_LDFLAGS := -L$(LIBZSTD_DIR)/lib
@@ -1082,6 +1091,18 @@ ifndef NO_LIBBABELTRACE endif endif +ifndef NO_CAPSTONE + $(call feature_check,libcapstone) + ifeq ($(feature-libcapstone), 1) + CFLAGS += -DHAVE_LIBCAPSTONE_SUPPORT $(LIBCAPSTONE_CFLAGS) + LDFLAGS += $(LICAPSTONE_LDFLAGS) + EXTLIBS += -lcapstone + $(call detected,CONFIG_LIBCAPSTONE) + else + msg := $(warning No libcapstone found, disables disasm engine support for 'perf script', please install libcapstone-dev/capstone-devel); + endif +endif + ifndef NO_AUXTRACE ifeq ($(SRCARCH),x86) ifeq ($(feature-get_cpuid), 0)
tools/perf/Makefile.perf +3 -0
@@ -82,6 +82,9 @@ include ../scripts/utilities.mak # Define NO_LIBBABELTRACE if you do not want libbabeltrace support # for CTF data format. # +# Define NO_CAPSTONE if you do not want libcapstone support +# for disasm engine. +# # Define NO_LZMA if you do not want to support compressed (xz) kernel modules # # Define NO_AUXTRACE if you do not want AUX area tracing support
Signature · 1 line
2.17.1
PATCH 2/3 perf: script: use capstone disasm engine to show disassembly instructions
In reply to Changbin DuCurrently, the instructions of samples are shown as raw hex strings which are hard to read. x86 has a special option '--xed' to disassemble the hex string via intel XED.
Here we use capstone as our disassembly engine to do that. We select libcapstone because capstone can provide more insn details.
The improvements compared to xed:
* support arm, arm64, x86-32, x86_64 (more could be supported), xed only for x86_64.
* immediate address operands are shown as symbol+offs.
Before:
$ sudo perf script --insn-trace
perf 17423 [000] 423271.557970005: 7f2d95f16217 __GI___ioctl+0x7 (/lib/x86_64-linux-gnu/libc-2.27.so) insn: 48 3d 01 f0 ff ff
perf 17423 [000] 423271.557970005: 7f2d95f1621d __GI___ioctl+0xd (/lib/x86_64-linux-gnu/libc-2.27.so) insn: 73 01
perf 17423 [000] 423271.557970338: 7f2d95f1621f __GI___ioctl+0xf (/lib/x86_64-linux-gnu/libc-2.27.so) insn: c3
perf 17423 [000] 423271.557970338: 5593ad3346d7 perf_evsel__enable_cpu+0x97 (/work/linux/tools/perf/perf) insn: 85 c0
perf 17423 [000] 423271.557970338: 5593ad3346d9 perf_evsel__enable_cpu+0x99 (/work/linux/tools/perf/perf) insn: 75 12
perf 17423 [000] 423271.557970338: 5593ad3346db perf_evsel__enable_cpu+0x9b (/work/linux/tools/perf/perf) insn: 49 8b 84 24 a8 00 00 00
perf 17423 [000] 423271.557970338: 5593ad3346e3 perf_evsel__enable_cpu+0xa3 (/work/linux/tools/perf/perf) insn: 48 8b 50 20After:
$ sudo perf script --insn-trace
perf 17423 [000] 423271.557970005: 7f2d95f16217 __GI___ioctl+0x7 (/lib/x86_64-linux-gnu/libc-2.27.so) insn: cmpq $-0xfff, %rax
perf 17423 [000] 423271.557970005: 7f2d95f1621d __GI___ioctl+0xd (/lib/x86_64-linux-gnu/libc-2.27.so) insn: jae __GI___ioctl+0x10
perf 17423 [000] 423271.557970338: 7f2d95f1621f __GI___ioctl+0xf (/lib/x86_64-linux-gnu/libc-2.27.so) insn: retq
perf 17423 [000] 423271.557970338: 5593ad3346d7 perf_evsel__enable_cpu+0x97 (/work/linux/tools/perf/perf) insn: testl %eax, %eax
perf 17423 [000] 423271.557970338: 5593ad3346d9 perf_evsel__enable_cpu+0x99 (/work/linux/tools/perf/perf) insn: jne perf_evsel__enable_cpu+0xad
perf 17423 [000] 423271.557970338: 5593ad3346db perf_evsel__enable_cpu+0x9b (/work/linux/tools/perf/perf) insn: movq 0xa8(%r12), %rax
perf 17423 [000] 423271.557970338: 5593ad3346e3 perf_evsel__enable_cpu+0xa3 (/work/linux/tools/perf/perf) insn: movq 0x20(%rax), %rdx
perf 17423 [000] 423271.557970338: 5593ad3346e7 perf_evsel__enable_cpu+0xa7 (/work/linux/tools/perf/perf) insn: cmpl %edx, %ebx
perf 17423 [000] 423271.557970338: 5593ad3346e9 perf_evsel__enable_cpu+0xa9 (/work/linux/tools/perf/perf) insn: jl perf_evsel__enable_cpu+0x60
perf 17423 [000] 423271.557970338: 5593ad3346eb perf_evsel__enable_cpu+0xab (/work/linux/tools/perf/perf) insn: xorl %eax, %eax--- tools/perf/builtin-script.c | 8 +-- tools/perf/util/Build | 1 + tools/perf/util/print_insn.c | 126 +++++++++++++++++++++++++++++++++++ tools/perf/util/print_insn.h | 13 ++++ 4 files changed, 143 insertions(+), 5 deletions(-) create mode 100644 tools/perf/util/print_insn.c create mode 100644 tools/perf/util/print_insn.h
tools/perf/builtin-script.c +3 -5
@@ -34,6 +34,7 @@#include "util/event.h" #include "ui/ui.h" #include "print_binary.h" +#include "print_insn.h" #include "archinsn.h" #include <linux/bitmap.h> #include <linux/kernel.h>
@@ -1482,11 +1483,8 @@ static int perf_sample__fprintf_insn(struct perf_sample *sample,if (PRINT_FIELD (INSNLEN )) printed +=fprintf (fp," ilen: %d" , sample->insn_len);if (PRINT_FIELD (INSN ) && sample->insn_len) { -int i; - - printed +=fprintf (fp," insn:" ); -for (i =0 ; i < sample->insn_len; i++) - printed +=fprintf (fp," %02x" , (unsigned char )sample->insn[i]); + printed +=fprintf (fp," insn: " ); + printed +=sample__fprintf_insn (sample, thread, machine, fp); }if (PRINT_FIELD (BRSTACKINSN ) ||PRINT_FIELD (BRSTACKINSNLEN )) printed +=perf_sample__fprintf_brstackinsn (sample, thread, attr, machine, fp);
tools/perf/util/Build +1 -0
@@ -31,6 +31,7 @@ perf-y += tracepoint.o perf-y += perf_regs.o perf-y += path.o perf-y += print_binary.o +perf-y += print_insn.o perf-y += rlimit.o perf-y += argv_split.o perf-y += rbtree.o
tools/perf/util/print_insn.c new file +126 -0
126 lines not on this page · raw message
tools/perf/util/print_insn.h new file +13 -0
@@ -0,0 +1,13 @@ +/* SPDX-License-Identifier: GPL-2.0 */ +#ifndef PERF_PRINT_ISNS_H +#define PERF_PRINT_ISNS_H + +#include <stddef.h> +#include <stdio.h> +#include "event.h" + +size_t sample__fprintf_insn (struct perf_sample *sample,struct thread *thread, +struct machine *machine,FILE *fp); +size_t sample__fprintf_insn_raw (struct perf_sample *sample,FILE *fp); + +#endif /* PERF_PRINT_ISNS_H */
Signature · 1 line
2.17.1
PATCH 3/3 perf: script: Deprecate the '--xed' option
In reply to Changbin DuNow perf can show assembly instructions with libcapstone for both x86 and Arm. So the old '--xed' option should not be used.
--- tools/perf/Documentation/build-xed.txt | 19 ------------------- tools/perf/Documentation/perf-intel-pt.txt | 17 +++++------------ tools/perf/Documentation/perf-script.txt | 5 ++--- tools/perf/Documentation/tips.txt | 2 +- tools/perf/builtin-script.c | 7 ++----- tools/perf/ui/browsers/res_sample.c | 2 +- tools/perf/ui/browsers/scripts.c | 4 ++-- 7 files changed, 13 insertions(+), 43 deletions(-) delete mode 100644 tools/perf/Documentation/build-xed.txt
tools/perf/Documentation/build-xed.txt deleted +0 -19
@@ -1,19 +0,0 @@ - -For --xed the xed tool is needed. Here is how to install it: - - $ git clone https://github.com/intelxed/mbuild.git mbuild - $ git clone https://github.com/intelxed/xed - $ cd xed - $ ./mfile.py --share - $ ./mfile.py examples - $ sudo ./mfile.py --prefix=/usr/local install - $ sudo ldconfig - $ sudo cp obj/examples/xed /usr/local/bin - -Basic xed testing: - - $ xed | head -3 - ERROR: required argument(s) were missing - Copyright (C) 2017, Intel Corporation. All rights reserved. - XED version: [v10.0-328-g7d62c8c49b7b] - $
tools/perf/Documentation/perf-intel-pt.txt +5 -12
@@ -115,9 +115,8 @@ toggle respectively. perf script also supports higher level ways to dump instruction traces: - perf script --insn-trace --xed + perf script --insn-trace -Dump all instructions. This requires installing the xed tool (see XED below) Dumping all instructions in a long trace can be fairly slow. It is usually better to start with higher level decoding, like
@@ -130,12 +129,12 @@ or and then select a time range of interest. The time range can then be examined in detail with - perf script --time starttime,stoptime --insn-trace --xed + perf script --time starttime,stoptime --insn-trace While examining the trace it's also useful to filter on specific CPUs using the -C option - perf script --time starttime,stoptime --insn-trace --xed -C 1 + perf script --time starttime,stoptime --insn-trace -C 1 Dump all instructions in time range on CPU 1.
@@ -1212,12 +1211,6 @@ To display PEBS events from the Intel PT trace, use the itrace 'o' option e.g. perf script --itrace=oe -XED ---- - -include::build-xed.txt[] - - Tracing Virtual Machines (kernel only) --------------------------------------
@@ -1275,7 +1268,7 @@ Without timestamps, --per-thread must be specified to distinguish threads. perf script can be used to provide an instruction trace - $ perf script --guestkallsyms $KALLSYMS --insn-trace --xed -F+ipc | grep -C10 vmresume | head -21 + $ perf script --guestkallsyms $KALLSYMS --insn-trace -F+ipc | grep -C10 vmresume | head -21 CPU 0/KVM 1440 ffffffff82133cdd __vmx_vcpu_run+0x3d ([kernel.kallsyms]) movq 0x48(%rax), %r9 CPU 0/KVM 1440 ffffffff82133ce1 __vmx_vcpu_run+0x41 ([kernel.kallsyms]) movq 0x50(%rax), %r10 CPU 0/KVM 1440 ffffffff82133ce5 __vmx_vcpu_run+0x45 ([kernel.kallsyms]) movq 0x58(%rax), %r11
@@ -1376,7 +1369,7 @@ There were none. 'perf script' can be used to provide an instruction trace showing timestamps - $ perf script -i perf.data.kvm --guestkallsyms $KALLSYMS --insn-trace --xed -F+ipc | grep -C10 vmresume | head -21 + $ perf script -i perf.data.kvm --guestkallsyms $KALLSYMS --insn-trace -F+ipc | grep -C10 vmresume | head -21 CPU 1/KVM 17006 [001] 11500.262865593: ffffffff82133cdd __vmx_vcpu_run+0x3d ([kernel.kallsyms]) movq 0x48(%rax), %r9 CPU 1/KVM 17006 [001] 11500.262865593: ffffffff82133ce1 __vmx_vcpu_run+0x41 ([kernel.kallsyms]) movq 0x50(%rax), %r10 CPU 1/KVM 17006 [001] 11500.262865593: ffffffff82133ce5 __vmx_vcpu_run+0x45 ([kernel.kallsyms]) movq 0x58(%rax), %r11
tools/perf/Documentation/perf-script.txt +2 -3
@@ -439,11 +439,10 @@ include::itrace.txt[] default, disable with --no-inline. --insn-trace:: - Show instruction stream for intel_pt traces. Combine with --xed to - show disassembly. + Show instruction stream for intel_pt traces. --xed:: - Run xed disassembler on output. Requires installing the xed disassembler. + Run xed disassembler on output. (deprecated) -S:: --symbols=symbol[,symbol...]::
tools/perf/Documentation/tips.txt +1 -1
@@ -15,7 +15,7 @@ To see callchains in a more compact form: perf report -g folded Show individual samples with: perf script Limit to show entries above 5% only: perf report --percent-limit 5 Profiling branch (mis)predictions with: perf record -b / perf report -To show assembler sample contexts use perf record -b / perf script -F +brstackinsn --xed +To show assembler sample contexts use perf record -b / perf script -F +brstackinsn Treat branches as callchains: perf report --branch-history To count events in every 1000 msec: perf stat -I 1000 Print event counts in CSV format with: perf stat -x,
tools/perf/builtin-script.c +2 -5
@@ -3721,10 +3721,7 @@ static int parse_xed(const struct option *opt __maybe_unused,const char *str__maybe_unused , int unset __maybe_unused) { - if (isatty(1)) - force_pager("xed -F insn: -A -64 | less"); - else - force_pager("xed -F insn: -A -64"); + pr_warning("xed option is deprecated\n");return 0 ; }
@@ -3857,7 +3854,7 @@ int cmd_script(int argc, const char **argv)OPT_CALLBACK_OPTARG (0 ,"insn-trace" , &itrace_synth_opts,NULL ,NULL ,"Decode instructions from itrace" , parse_insn_trace),OPT_CALLBACK_OPTARG (0 ,"xed" ,NULL ,NULL ,NULL , -"Run xed disassembler on output" , parse_xed), +"Run xed disassembler on output (deprecated)" , parse_xed),OPT_CALLBACK_OPTARG (0 ,"call-trace" , &itrace_synth_opts,NULL ,NULL ,"Decode calls from itrace" , parse_call_trace), OPT_CALLBACK_OPTARG(0, "call-ret-trace", &itrace_synth_opts, NULL, NULL,
tools/perf/ui/browsers/res_sample.c +1 -1
@@ -83,7 +83,7 @@ int res_sample_browse(struct res_sample *res_samples, int num_res, r->tid ?"--tid " :"" , r->tid ? (sprintf (tidbuf,"%d" , r->tid), tidbuf) :"" , extra_format, - rstype ==A_ASM ?"-F +insn --xed" : + rstype ==A_ASM ?"-F +insn" : rstype ==A_SOURCE ?"-F +srcline,+srccode" :"" , symbol_conf.inline_name ?"--inline" :"" , "--show-lost-events ",
tools/perf/ui/browsers/scripts.c +2 -2
@@ -37,7 +37,7 @@ void attr_to_script(char *extra_format, struct perf_event_attr *attr)if (attr->read_format &PERF_FORMAT_GROUP )strcat (extra_format," -F +metric" );if (attr->sample_type &PERF_SAMPLE_BRANCH_STACK ) -strcat (extra_format," -F +brstackinsn --xed" ); +strcat (extra_format," -F +brstackinsn" );if (attr->sample_type &PERF_SAMPLE_REGS_INTR )strcat (extra_format," -F +iregs" );if (attr->sample_type &PERF_SAMPLE_REGS_USER )
@@ -107,7 +107,7 @@ static int list_scripts(char *script_name, bool *custom,if (evsel)attr_to_script (scriptc.extra_format, &evsel->core.attr);add_script_option ("Show individual samples" ,"" , &scriptc); -add_script_option ("Show individual samples with assembler" ,"-F +insn --xed" , +add_script_option ("Show individual samples with assembler" ,"-F +insn" , &scriptc);add_script_option ("Show individual samples with source" ,"-F +srcline,+srccode" , &scriptc);
Signature · 1 line
2.17.1