Re: [PATCH v4 4/5] perf: script: add raw|disasm arguments to --insn-trace option

[Changbin Du <changbin.du@huawei.com>]

On Fri, Jan 19, 2024 at 08:39:50PM +0200, Adrian Hunter wrote:
> On 19/01/24 12:48, Changbin Du wrote:
> > Now '--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) insn: movq %rsp, %rdi
> >               ls 1443864 [006] 2275506.209908875:      7f216b426103 _start+0x3 (/usr/lib/x86_64-linux-gnu/ld-2.31.so) insn: callq _dl_start+0x0
> >               ls 1443864 [006] 2275506.209908875:      7f216b426df0 _dl_start+0x0 (/usr/lib/x86_64-linux-gnu/ld-2.31.so) insn: illegal instruction
> >               ls 1443864 [006] 2275506.209908875:      7f216b426df4 _dl_start+0x4 (/usr/lib/x86_64-linux-gnu/ld-2.31.so) insn: pushq %rbp
> >               ls 1443864 [006] 2275506.209908875:      7f216b426df5 _dl_start+0x5 (/usr/lib/x86_64-linux-gnu/ld-2.31.so) insn: movq %rsp, %rbp
> >               ls 1443864 [006] 2275506.209908875:      7f216b426df8 _dl_start+0x8 (/usr/lib/x86_64-linux-gnu/ld-2.31.so) insn: pushq %r15
> > 
> > Signed-off-by: Changbin Du <changbin.du@huawei.com>
> > ---
> >  tools/perf/Documentation/perf-script.txt |  6 +++---
> >  tools/perf/builtin-script.c              | 17 +++++++++++++----
> >  2 files changed, 16 insertions(+), 7 deletions(-)
> > 
> > diff --git a/tools/perf/Documentation/perf-script.txt b/tools/perf/Documentation/perf-script.txt
> > index fc79167c6bf8..9ae54f5bcb4d 100644
> > --- a/tools/perf/Documentation/perf-script.txt
> > +++ b/tools/perf/Documentation/perf-script.txt
> > @@ -442,9 +442,9 @@ 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 raw or mnemonic instruction stream for intel_pt traces. You can
> > +	also combine raw instructions with --xed to show disassembly.
> 
> Perhaps this is a bit clearer:
> 
> 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.
>
Updated, thanks.

> >  
> >  --xed::
> >  	Run xed disassembler on output. Requires installing the xed disassembler.
> > diff --git a/tools/perf/builtin-script.c b/tools/perf/builtin-script.c
> > index 12d886694f6c..2e3752b3b65a 100644
> > --- a/tools/perf/builtin-script.c
> > +++ b/tools/perf/builtin-script.c
> > @@ -3769,10 +3769,19 @@ 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";
> > +
> > +	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;
> > +		}
> > +	}
> > +	parse_output_fields(NULL, fields, 0);
> >  	itrace_parse_synth_opts(opt, "i0ns", 0);
> >  	symbol_conf.nanosecs = true;
> >  	return 0;
> > @@ -3918,7 +3927,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),
> 

-- 
Cheers,
Changbin Du