perf: script: Intro capstone disasm engine to show instruction trace
v8 cover perf: script: Intro capstone disasm engine to show instruction trace
This series introduces capstone disassembler engine to print instructions of Intel PT trace, which was printed via the XED tool.
The advantages compared to XED tool:
* Support arm, arm64, x86-32, x86_64, s390 (more could be supported), xed only for x86_64.
* More friendly to read. Immediate address operands are shown as symbol+offs.
Display raw instructions:
$ sudo perf record --event intel_pt//u -- ls
$ 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 20Display mnemonic instructions:
$ sudo perf script --insn-trace=disasm
perf 17423 [000] 423271.557970005: 7f2d95f16217 __GI___ioctl+0x7 (/lib/x86_64-linux-gnu/libc-2.27.so) cmpq $-0xfff, %rax
perf 17423 [000] 423271.557970005: 7f2d95f1621d __GI___ioctl+0xd (/lib/x86_64-linux-gnu/libc-2.27.so) jae __GI___ioctl+0x10
perf 17423 [000] 423271.557970338: 7f2d95f1621f __GI___ioctl+0xf (/lib/x86_64-linux-gnu/libc-2.27.so) retq
perf 17423 [000] 423271.557970338: 5593ad3346d7 perf_evsel__enable_cpu+0x97 (/work/linux/tools/perf/perf) testl %eax, %eax
perf 17423 [000] 423271.557970338: 5593ad3346d9 perf_evsel__enable_cpu+0x99 (/work/linux/tools/perf/perf) jne perf_evsel__enable_cpu+0xad
perf 17423 [000] 423271.557970338: 5593ad3346db perf_evsel__enable_cpu+0x9b (/work/linux/tools/perf/perf) movq 0xa8(%r12), %rax
perf 17423 [000] 423271.557970338: 5593ad3346e3 perf_evsel__enable_cpu+0xa3 (/work/linux/tools/perf/perf) movq 0x20(%rax), %rdx
perf 17423 [000] 423271.557970338: 5593ad3346e7 perf_evsel__enable_cpu+0xa7 (/work/linux/tools/perf/perf) cmpl %edx, %ebx
perf 17423 [000] 423271.557970338: 5593ad3346e9 perf_evsel__enable_cpu+0xa9 (/work/linux/tools/perf/perf) jl perf_evsel__enable_cpu+0x60
perf 17423 [000] 423271.557970338: 5593ad3346eb perf_evsel__enable_cpu+0xab (/work/linux/tools/perf/perf) xorl %eax, %eaxv8:
- fix conflicting header bpf.h problem, aka, capstone/bpf.h and uapi/linux/bpf.h. (Namhyung Kim, Adrian Hunter)
v7:
- remove redundant space for raw instruction.
- rename sample__fprintf_insn() as sample__fprintf_insn_asm() and make it empty if libcapstone is not available.
v6:
- make '-F +disasm' fatal if libcapstone is not supported. (Adrian Hunter)
- display with perf version --build-options. (Adrian Hunter)
- exclude libcapstone from make_minimal. (Adrian Hunter)
v5:
- fixes and improments suggested by Adrian Hunter
v4:
- rename 'insn_disam' to 'disasm' (Adrian Hunter)
v3:
- fix s390 detection. (Thomas Richter)
v2:
- add a new field 'insn_disam' instead of changing the default output.
- preserve the old --xed option.
Changbin Du (5):
perf: build: introduce the libcapstone
perf: util: use capstone disasm engine to show assembly instructions
perf: script: add field 'disasm' to display mnemonic instructions
perf: script: add raw|disasm arguments to --insn-trace option
perf: script: prefer capstone to XED
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/perf-intel-pt.txt | 14 ++- tools/perf/Documentation/perf-script.txt | 20 +-- tools/perf/Makefile.config | 21 ++++ tools/perf/Makefile.perf | 3 + tools/perf/builtin-script.c | 45 +++++-- tools/perf/builtin-version.c | 1 + tools/perf/tests/make | 4 +- tools/perf/ui/browsers/res_sample.c | 2 +- tools/perf/ui/browsers/scripts.c | 2 +- tools/perf/util/Build | 1 + tools/perf/util/print_insn.c | 135 +++++++++++++++++++++ tools/perf/util/print_insn.h | 16 +++ tools/perf/util/thread.h | 1 - 17 files changed, 258 insertions(+), 28 deletions(-) create mode 100644 tools/build/feature/test-libcapstone.c create mode 100644 tools/perf/util/print_insn.c create mode 100644 tools/perf/util/print_insn.h
Signature · 1 line
2.25.1
PATCH v8 1/5 perf: build: introduce the libcapstone
Later we will use libcapstone to disassemble instructions of samples.
---
v3:
- display with perf version --build-options. (Adrian Hunter)
- exclude libcapstone from make_minimal.
v2:
- change tools/perf/tests/make also.
--- 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 +++ tools/perf/builtin-version.c | 1 + tools/perf/tests/make | 4 +++- 8 files changed, 49 insertions(+), 1 deletion(-) create mode 100644 tools/build/feature/test-libcapstone.c
tools/build/Makefile.feature +2 -0
@@ -87,6 +87,7 @@ FEATURE_TESTS_EXTRA := \ gtk2-infobar \ hello \ libbabeltrace \ + libcapstone \ libbfd-liberty \ libbfd-liberty-z \ libopencsd \
@@ -134,6 +135,7 @@ FEATURE_DISPLAY ?= \ libcrypto \ libunwind \ libdw-dwarf-unwind \ + libcapstone \ zlib \ lzma \ get_cpuid \
tools/build/feature/Makefile +4 -0
@@ -54,6 +54,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 \
@@ -286,6 +287,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
@@ -134,6 +134,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
@@ -191,6 +191,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
@@ -1094,6 +1103,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
@@ -84,6 +84,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
tools/perf/builtin-version.c +1 -0
@@ -73,6 +73,7 @@ static void library_status(void)STATUS (HAVE_LIBCRYPTO_SUPPORT , libcrypto);STATUS (HAVE_LIBUNWIND_SUPPORT , libunwind);STATUS (HAVE_DWARF_SUPPORT , libdw-dwarf-unwind); +STATUS (HAVE_LIBCAPSTONE_SUPPORT , libcapstone);STATUS (HAVE_ZLIB_SUPPORT , zlib);STATUS (HAVE_LZMA_SUPPORT , lzma);STATUS (HAVE_AUXTRACE_SUPPORT , get_cpuid);
tools/perf/tests/make +3 -1
@@ -83,6 +83,7 @@ make_no_libelf := NO_LIBELF=1 make_no_libunwind := NO_LIBUNWIND=1 make_no_libdw_dwarf_unwind := NO_LIBDW_DWARF_UNWIND=1 make_no_backtrace := NO_BACKTRACE=1 +make_no_libcapstone := NO_CAPSTONE=1 make_no_libnuma := NO_LIBNUMA=1 make_no_libaudit := NO_LIBAUDIT=1 make_no_libbionic := NO_LIBBIONIC=1
@@ -122,7 +123,7 @@ make_minimal += NO_DEMANGLE=1 NO_LIBELF=1 NO_LIBUNWIND=1 NO_BACKTRACE=1 make_minimal += NO_LIBNUMA=1 NO_LIBAUDIT=1 NO_LIBBIONIC=1 make_minimal += NO_LIBDW_DWARF_UNWIND=1 NO_AUXTRACE=1 NO_LIBBPF=1 make_minimal += NO_LIBCRYPTO=1 NO_SDT=1 NO_JVMTI=1 NO_LIBZSTD=1 -make_minimal += NO_LIBCAP=1 NO_SYSCALL_TABLE=1 +make_minimal += NO_LIBCAP=1 NO_SYSCALL_TABLE=1 NO_CAPSTONE=1 # $(run) contains all available tests run := make_pure
@@ -152,6 +153,7 @@ run += make_no_libelf run += make_no_libunwind run += make_no_libdw_dwarf_unwind run += make_no_backtrace +run += make_no_libcapstone run += make_no_libnuma run += make_no_libaudit run += make_no_libbionic
Signature · 1 line
2.25.1
PATCH v8 2/5 perf: util: use capstone disasm engine to show assembly 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 tool.
Here we use capstone as our disassembler engine to give more friendly instructions. We select libcapstone because capstone can provide more insn details. Perf will fallback to raw instructions if libcapstone is not available.
The advantages compared to XED tool:
* Support arm, arm64, x86-32, x86_64 (more could be supported), xed only for x86_64.
* Immediate address operands are shown as symbol+offs.
---
v4:
- fix conflicting header bpf.h problem, aka, capstone/bpf.h and uapi/linux/bpf.h. (Namhyung Kim, Adrian Hunter)
v3:
- show warning msg if libcapstone is not available.
v2:
- line up the output by preceding two tabs. (Adrian Hunter)
- removed the tailing space. (Adrian Hunter)
- forward declaration for perf_sample, thread, machine. (Adrian Hunter)
- other trivial fixes (Adrian Hunter)
--- tools/perf/builtin-script.c | 8 +-- tools/perf/util/Build | 1 + tools/perf/util/print_insn.c | 135 +++++++++++++++++++++++++++++++++++ tools/perf/util/print_insn.h | 16 +++++ tools/perf/util/thread.h | 1 - 5 files changed, 155 insertions(+), 6 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>
@@ -1511,11 +1512,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_raw (sample, fp); }if (PRINT_FIELD (BRSTACKINSN ) ||PRINT_FIELD (BRSTACKINSNLEN )) printed +=perf_sample__fprintf_brstackinsn (sample, thread, attr, machine, fp);
tools/perf/util/Build +1 -0
@@ -32,6 +32,7 @@ perf-y += perf_regs.o perf-y += perf-regs-arch/ 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 +135 -0
135 lines not on this page · raw message
tools/perf/util/print_insn.h new file +16 -0
@@ -0,0 +1,16 @@ +/* SPDX-License-Identifier: GPL-2.0 */ +#ifndef PERF_PRINT_INSN_H +#define PERF_PRINT_INSN_H + +#include <stddef.h> +#include <stdio.h> + +struct perf_sample ; +struct thread ; +struct machine ; + +size_t sample__fprintf_insn_asm (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_INSN_H */
tools/perf/util/thread.h +0 -1
@@ -13,7 +13,6 @@#include <strlist.h> #include <intlist.h> #include "rwsem.h" -#include "event.h" #include "callchain.h" #include <internal/rc_check.h>
Signature · 1 line
2.25.1
Re: [PATCH v8 2/5] perf: util: use capstone disasm engine to show assembly instructions
Quoted 9 lines · Changbin Du
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 tool.
Here we use capstone as our disassembler engine to give more friendly instructions. We select libcapstone because capstone can provide more insn details. Perf will fallback to raw instructions if libcapstone is not available.
Quoted 6 lines
The advantages compared to XED tool:
* Support arm, arm64, x86-32,x86_64(more could be supported), xed only forx86_64.
* Immediate address operands are shown as symbol+offs.Signed-off-by Changbin Du <[email protected]>
This is the only patch of V8 that made it to my inbox, Namhyung also mentioned problems receiving V7, but the patches are on lore.
For whole patch set:
Quoted 235 lines
---
v4:
- fix conflicting headerbpf.hproblem, aka,capstone/bpf.handuapi/linux/bpf.h. (Namhyung Kim, Adrian Hunter)
v3:
- show warning msg if libcapstone is not available.
v2:
- line up the output by preceding two tabs. (Adrian Hunter)
- removed the tailing space. (Adrian Hunter)
- forward declaration forperf_sample, thread, machine. (Adrian Hunter)
- other trivial fixes (Adrian Hunter)--- tools/perf/builtin-script.c | 8 +-- tools/perf/util/Build | 1 + tools/perf/util/print_insn.c | 135 +++++++++++++++++++++++++++++++++++ tools/perf/util/print_insn.h | 16 +++++ tools/perf/util/thread.h | 1 - 5 files changed, 155 insertions(+), 6 deletions(-) create mode 100644 tools/perf/util/print_insn.c create mode 100644 tools/perf/util/print_insn.htools/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> @@ -1511,11 +1512,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_raw (sample, fp); }if (PRINT_FIELD (BRSTACKINSN ) ||PRINT_FIELD (BRSTACKINSNLEN )) printed +=perf_sample__fprintf_brstackinsn (sample, thread, attr, machine, fp);tools/perf/util/Build +1
-0@@ -32,6 +32,7 @@ perf-y += perf_regs.o perf-y += perf-regs-arch/ 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.otools/perf/util/print_insn.c new file +135
-0@@ -0,0 +1,135 @@ +// SPDX-License-Identifier: GPL-2.0 +/* +* Instruction binary disassembler based on capstone. +* +* Author(s): Changbin Du <[email protected]> +*/ +#include <string.h> +#include <stdbool.h> +#include "debug.h" +#include "sample.h" +#include "symbol.h" +#include "machine.h" +#include "thread.h" +#include "print_insn.h" + +size_t sample__fprintf_insn_raw (struct perf_sample *sample,FILE *fp) +{ +int printed =0 ; + +for (int i =0 ; i < sample->insn_len; i++) { + printed +=fprintf (fp,"%02x" , (unsigned char )sample->insn[i]); +if (sample->insn_len - i >1 ) + printed +=fprintf (fp," " ); + } +return printed; +} + +#ifdef HAVE_LIBCAPSTONE_SUPPORT +#include <capstone/capstone.h> + +static int capstone_init (struct machine *machine,csh *cs_handle) +{ +cs_arch arch; +cs_mode mode; + +if (machine__is (machine,"x86_64" )) { + arch =CS_ARCH_X86 ; + mode =CS_MODE_64 ; + }else if (machine__normalized_is (machine,"x86" )) { + arch =CS_ARCH_X86 ; + mode =CS_MODE_32 ; + }else if (machine__normalized_is (machine,"arm64" )) { + arch =CS_ARCH_ARM64 ; + mode =CS_MODE_ARM ; + }else if (machine__normalized_is (machine,"arm" )) { + arch =CS_ARCH_ARM ; + mode =CS_MODE_ARM +CS_MODE_V8 ; + }else if (machine__normalized_is (machine,"s390" )) { + arch =CS_ARCH_SYSZ ; + mode =CS_MODE_BIG_ENDIAN ; + }else { +return -1 ; + } + +if (cs_open (arch, mode, cs_handle) !=CS_ERR_OK ) { +pr_warning_once ("cs_open failed\n" ); +return -1 ; + } + +if (machine__normalized_is (machine,"x86" )) { +cs_option (*cs_handle,CS_OPT_SYNTAX ,CS_OPT_SYNTAX_ATT ); +/* +* Resolving address operands to symbols is implemented +* on x86 by investigating instruction details. +*/ +cs_option (*cs_handle,CS_OPT_DETAIL ,CS_OPT_ON ); + } + +return 0 ; +} + +static size_t print_insn_x86 (struct perf_sample *sample,struct thread *thread, +cs_insn *insn,FILE *fp) +{ +struct addr_location al; +size_t printed =0 ; + +if (insn->detail && insn->detail->x86.op_count ==1 ) { +cs_x86_op *op = &insn->detail->x86.operands[0 ]; + +addr_location__init (&al); +if (op->type ==X86_OP_IMM && +thread__find_symbol (thread, sample->cpumode, op->imm, &al)) { + printed +=fprintf (fp,"%s " , insn[0 ].mnemonic); + printed +=symbol__fprintf_symname_offs (al.sym, &al, fp); +addr_location__exit (&al); +return printed; + } +addr_location__exit (&al); + } + + printed +=fprintf (fp,"%s %s" , insn[0 ].mnemonic, insn[0 ].op_str); +return printed; +} + +size_t sample__fprintf_insn_asm (struct perf_sample *sample,struct thread *thread, +struct machine *machine,FILE *fp) +{ +csh cs_handle; +cs_insn *insn; +size_t count; +size_t printed =0 ; +int ret; + +/* TODO: Try to initiate capstone only once but need a proper place. */ + ret =capstone_init (machine, &cs_handle); +if (ret <0 ) { +/* fallback */ +return sample__fprintf_insn_raw (sample, fp); + } + + count =cs_disasm (cs_handle, (uint8_t *)sample->insn, sample->insn_len, + sample->ip,1 , &insn); +if (count >0 ) { +if (machine__normalized_is (machine,"x86" )) + printed +=print_insn_x86 (sample, thread, &insn[0 ], fp); +else + printed +=fprintf (fp,"%s %s" , insn[0 ].mnemonic, insn[0 ].op_str); +cs_free (insn, count); + }else { + printed +=fprintf (fp,"illegal instruction" ); + } + +cs_close (&cs_handle); +return printed; +} +#else +size_t sample__fprintf_insn_asm (struct perf_sample *sample__maybe_unused , +struct thread *thread__maybe_unused , +struct machine *machine__maybe_unused , +FILE *fp__maybe_unused ) +{ +return 0 ; +} +#endif tools/perf/util/print_insn.h new file +16
-0@@ -0,0 +1,16 @@ +/* SPDX-License-Identifier: GPL-2.0 */ +#ifndef PERF_PRINT_INSN_H +#define PERF_PRINT_INSN_H + +#include <stddef.h> +#include <stdio.h> + +struct perf_sample ; +struct thread ; +struct machine ; + +size_t sample__fprintf_insn_asm (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_INSN_H */ tools/perf/util/thread.h +0
-1@@ -13,7 +13,6 @@#include <strlist.h> #include <intlist.h> #include "rwsem.h" -#include "event.h" #include "callchain.h" #include <internal/rc_check.h>
Namhyung Kim
maintainerRe: [PATCH v8 2/5] perf: util: use capstone disasm engine to show assembly instructions
Hi Adrian and Changbin,
Quoted 16 lines · Adrian Hunter
Quoted 14 lines · Changbin Du
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 tool.
Here we use capstone as our disassembler engine to give more friendly instructions. We select libcapstone because capstone can provide more insn details. Perf will fallback to raw instructions if libcapstone is not available.
The advantages compared to XED tool:
* Support arm, arm64, x86-32,x86_64(more could be supported), xed only forx86_64.
* Immediate address operands are shown as symbol+offs.
Quoted 8 lines
Quoted 1 line
Signed-off-by Changbin Du <[email protected]>This is the only patch of V8 that made it to my inbox, Namhyung also mentioned problems receiving V7, but the patches are on lore.
For whole patch set:
Reviewed-by Adrian Hunter <[email protected]>
I found it in my spam box, maybe there was a change in the spam filtering logic.
Thanks,
Namhyung
PATCH v8 3/5 perf: script: add field 'disasm' to display mnemonic instructions
In reply to Changbin DuIn addition to the 'insn' field, this adds a new field 'disasm' to display mnemonic instructions instead of the raw code.
$ sudo perf script -F +disasm
perf-exec 1443864 [006] 2275506.209848: psb: psb offs: 0 0 [unknown] ([unknown])
perf-exec 1443864 [006] 2275506.209848: cbr: cbr: 41 freq: 4100 MHz (114%) 0 [unknown] ([unknown])
ls 1443864 [006] 2275506.209905: 1 branches:uH: 7f216b426100 _start+0x0 (/usr/lib/x86_64-linux-gnu/ld-2.31.so) movq %rsp, %rdi
ls 1443864 [006] 2275506.209908: 1 branches:uH: 7f216b426103 _start+0x3 (/usr/lib/x86_64-linux-gnu/ld-2.31.so) callq _dl_start+0x0---
v2:
- make '-F +disasm' fatal if libcapstone is not supported.
v2:
- update Documentation.
--- tools/perf/Documentation/perf-script.txt | 13 +++++++------ tools/perf/builtin-script.c | 15 ++++++++++++++- 2 files changed, 21 insertions(+), 7 deletions(-)
tools/perf/Documentation/perf-script.txt +7 -6
@@ -132,9 +132,10 @@ OPTIONS Comma separated list of fields to print. Options are: 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, - machine_pid, vcpu, cgroup, retire_lat. + brstackinsn, brstackinsnlen, brstackoff, callindent, insn, disasm, + insnlen, synth, phys_addr, metric, misc, srccode, ipc, data_page_size, + code_page_size, ins_lat, machine_pid, vcpu, cgroup, retire_lat. + Field list can be prepended with the type, trace, sw or hw, to indicate to which event type the field list applies. e.g., -F sw:comm,tid,time,ip,sym and -F trace:time,cpu,trace
@@ -217,9 +218,9 @@ OPTIONS Instruction Trace decoding. For calls and returns, it will display the name of the symbol indented with spaces to reflect the stack depth. - When doing instruction trace decoding insn and insnlen give the - instruction bytes and the instruction length of the current - instruction. + When doing instruction trace decoding, insn, disasm and insnlen give the + instruction bytes, disassembled instructions (requires libcapstone support) + and the instruction length of the current instruction respectively. The synth field is used by synthesized events which may be created when Instruction Trace decoding.
tools/perf/builtin-script.c +14 -1
@@ -135,6 +135,7 @@ enum perf_output_field {PERF_OUTPUT_CGROUP =1ULL <<39 ,PERF_OUTPUT_RETIRE_LAT =1ULL <<40 ,PERF_OUTPUT_DSOFF =1ULL <<41 , + PERF_OUTPUT_DISASM = 1ULL << 42, }; struct perf_script {
@@ -190,6 +191,7 @@ struct output_option { {.str = "bpf-output", .field = PERF_OUTPUT_BPF_OUTPUT}, {.str = "callindent", .field = PERF_OUTPUT_CALLINDENT}, {.str = "insn", .field = PERF_OUTPUT_INSN}, + {.str = "disasm", .field = PERF_OUTPUT_DISASM}, {.str = "insnlen", .field = PERF_OUTPUT_INSNLEN}, {.str = "brstackinsn", .field = PERF_OUTPUT_BRSTACKINSN}, {.str = "brstackoff", .field = PERF_OUTPUT_BRSTACKOFF},
@@ -1515,6 +1517,10 @@ static int perf_sample__fprintf_insn(struct perf_sample *sample, printed +=fprintf (fp," insn: " ); printed +=sample__fprintf_insn_raw (sample, fp); } +if (PRINT_FIELD (DISASM ) && sample->insn_len) { + printed +=fprintf (fp,"\t\t" ); + printed +=sample__fprintf_insn_asm (sample, thread, machine, fp); + }if (PRINT_FIELD (BRSTACKINSN ) ||PRINT_FIELD (BRSTACKINSNLEN )) printed +=perf_sample__fprintf_brstackinsn (sample, thread, attr, machine, fp);
@@ -3106,6 +3112,13 @@ static int parse_output_fields(const struct option *opt __maybe_unused, rc = -EINVAL ; goto out; } +#ifndef HAVE_LIBCAPSTONE_SUPPORT +if (change !=REMOVE &&strcmp (tok,"disasm" ) ==0 ) { +fprintf (stderr,"Field \"disasm\" requires perf to be built with libcapstone support.\n" ); + rc = -EINVAL ; + goto out; + } +#endif if (type ==-1 ) {/* add user option to all events types for
@@ -3900,7 +3913,7 @@ int cmd_script(int argc, const char **argv)"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," +"brstackinsnlen,brstackoff,callindent,insn,disasm,insnlen,synth," "phys_addr,metric,misc,srccode,ipc,tod,data_page_size," "code_page_size,ins_lat,machine_pid,vcpu,cgroup,retire_lat" , parse_output_fields),
Signature · 1 line
2.25.1
PATCH v8 4/5 perf: script: add raw|disasm arguments to --insn-trace option
In reply to Changbin DuNow '--insn-trace' accept a argument to specify the output format:
- raw: display raw instructions.
- disasm: display mnemonic instructions (if capstone is installed).
$ sudo perf script --insn-trace=raw
ls 1443864 [006] 2275506.209908875: 7f216b426100 _start+0x0 (/usr/lib/x86_64-linux-gnu/ld-2.31.so) insn: 48 89 e7
ls 1443864 [006] 2275506.209908875: 7f216b426103 _start+0x3 (/usr/lib/x86_64-linux-gnu/ld-2.31.so) insn: e8 e8 0c 00 00
ls 1443864 [006] 2275506.209908875: 7f216b426df0 _dl_start+0x0 (/usr/lib/x86_64-linux-gnu/ld-2.31.so) insn: f3 0f 1e fa$ sudo perf script --insn-trace=disasm
ls 1443864 [006] 2275506.209908875: 7f216b426100 _start+0x0 (/usr/lib/x86_64-linux-gnu/ld-2.31.so) movq %rsp, %rdi
ls 1443864 [006] 2275506.209908875: 7f216b426103 _start+0x3 (/usr/lib/x86_64-linux-gnu/ld-2.31.so) callq _dl_start+0x0
ls 1443864 [006] 2275506.209908875: 7f216b426df0 _dl_start+0x0 (/usr/lib/x86_64-linux-gnu/ld-2.31.so) illegal instruction
ls 1443864 [006] 2275506.209908875: 7f216b426df4 _dl_start+0x4 (/usr/lib/x86_64-linux-gnu/ld-2.31.so) pushq %rbp
ls 1443864 [006] 2275506.209908875: 7f216b426df5 _dl_start+0x5 (/usr/lib/x86_64-linux-gnu/ld-2.31.so) movq %rsp, %rbp
ls 1443864 [006] 2275506.209908875: 7f216b426df8 _dl_start+0x8 (/usr/lib/x86_64-linux-gnu/ld-2.31.so) pushq %r15---
v2:
- update Documentation (Adrian Hunter)
--- tools/perf/Documentation/perf-script.txt | 7 ++++--- tools/perf/builtin-script.c | 22 ++++++++++++++++++---- 2 files changed, 22 insertions(+), 7 deletions(-)
tools/perf/Documentation/perf-script.txt +4 -3
@@ -442,9 +442,10 @@ include::itrace.txt[] will be printed. Each entry has function name and file/line. Enabled by default, disable with --no-inline. ---insn-trace:: - Show instruction stream for intel_pt traces. Combine with --xed to - show disassembly. +--insn-trace[=<raw|disasm>]:: + Show instruction stream in bytes (raw) or disassembled (disasm) + for intel_pt traces. The default is 'raw'. To use xed, combine + 'raw' with --xed to show disassembly done by xed. --xed:: Run xed disassembler on output. Requires installing the xed disassembler.
tools/perf/builtin-script.c +18 -4
@@ -3776,10 +3776,24 @@ static int perf_script__process_auxtrace_info(struct perf_session *session,#endif static int parse_insn_trace (const struct option *opt__maybe_unused , -const char *str__maybe_unused , -int unset__maybe_unused ) +const char *str,int unset__maybe_unused ) { -parse_output_fields (NULL ,"+insn,-event,-period" ,0 ); +const char *fields ="+insn,-event,-period" ; +int ret; + +if (str) { +if (strcmp (str,"disasm" ) ==0 ) + fields ="+disasm,-event,-period" ; +else if (strlen (str) !=0 &&strcmp (str,"raw" ) !=0 ) { +fprintf (stderr,"Only accept raw|disasm\n" ); +return -EINVAL ; + } + } + + ret =parse_output_fields (NULL , fields,0 ); +if (ret <0 ) +return ret; +itrace_parse_synth_opts (opt,"i0ns" ,0 ); symbol_conf.nanosecs = true;return 0 ;
@@ -3925,7 +3939,7 @@ int cmd_script(int argc, const char **argv) "only consider these symbols"),OPT_INTEGER (0 ,"addr-range" , &symbol_conf.addr_range,"Use with -S to list traced records within address range" ), -OPT_CALLBACK_OPTARG (0 ,"insn-trace" , &itrace_synth_opts,NULL ,NULL , +OPT_CALLBACK_OPTARG (0 ,"insn-trace" , &itrace_synth_opts,NULL ,"raw|disasm" ,"Decode instructions from itrace" , parse_insn_trace),OPT_CALLBACK_OPTARG (0 ,"xed" ,NULL ,NULL ,NULL , "Run xed disassembler on output", parse_xed),
Signature · 1 line
2.25.1
PATCH v8 5/5 perf: script: prefer capstone to XED
In reply to Changbin DuNow perf can show assembly instructions with libcapstone for x86, and the capstone is better in general.
---
v2:
- update Documentation. (Adrian Hunter)
- fix typo.
--- tools/perf/Documentation/perf-intel-pt.txt | 14 +++++++++----- tools/perf/ui/browsers/res_sample.c | 2 +- tools/perf/ui/browsers/scripts.c | 2 +- 3 files changed, 11 insertions(+), 7 deletions(-)
tools/perf/Documentation/perf-intel-pt.txt +9 -5
@@ -115,9 +115,13 @@ toggle respectively. perf script also supports higher level ways to dump instruction traces: + perf script --insn-trace=disasm + +or to use the xed disassembler, which requires installing the xed tool +(see XED below): + perf script --insn-trace --xed -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 +134,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=disasm 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=disasm -C 1 Dump all instructions in time range on CPU 1.
@@ -1306,7 +1310,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=disasm -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
@@ -1407,7 +1411,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=disasm -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/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 +disasm" : rstype ==A_SOURCE ?"-F +srcline,+srccode" :"" , symbol_conf.inline_name ?"--inline" :"" , "--show-lost-events ",
tools/perf/ui/browsers/scripts.c +1 -1
@@ -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 +disasm" , &scriptc);add_script_option ("Show individual samples with source" ,"-F +srcline,+srccode" , &scriptc);
Signature · 1 line
2.25.1
Quoted 9 lines · Changbin Du
This series introduces capstone disassembler engine to print instructions of Intel PT trace, which was printed via the XED tool.
The advantages compared to XED tool:
* Support arm, arm64, x86-32,x86_64, s390 (more could be supported), xed only forx86_64.
* More friendly to read. Immediate address operands are shown as symbol+offs.[...]
Applied to perf-tools-next, thanks!
Best regards,
Signature · 1 line
Namhyung Kim <[email protected]>