Re: [PATCH -tip v3 3/6] perf branch trace: print pid and command

From: David Ahern
Date: Thu Mar 24 2011 - 13:05:52 EST




On 03/24/11 05:32, Akihiro Nagai wrote:
> Provide the function to print pid and command name to
> 'perf branch trace'. Users can select items to print with options.
> For example,
> 'perf branch -p trace' prints only pid,
> 'perf branch -ac trace' prints address and comamnd name.
> 'perf branch trace' prints only address (default)
>
> This is output sample (perf branch -ac trace):
> command address
> ls 0xffffffff8146fe0e => ls 0x0000003806200b20
> ls 0xffffffff8146fe0e => ls 0x0000003806200b20
> ls 0x0000003806200b23 => ls 0x0000003806204910
> ls 0xffffffff8146fe0e => ls 0x0000003806204910
> ls 0xffffffff8146fe0e => ls 0x0000003806204936
> ls 0xffffffff8146fe0e => ls 0x000000380620493d
> ls 0x0000003806204981 => ls 0x00000038062049a3
> ls 0x00000038062049a7 => ls 0x0000003806204988

This can be easily added to perf-script. e.g,

perf record -e branches:u -c 1 -d -- ls /tmp

perf script -i /tmp/perf.data -f hw:comm,pid,event,sym,addr

...
ls 8150 branches: 0x39d30144d0 ffffffff8146a48e ()
ls 8150 branches: 0x39d3014507 ffffffff8146a48e ()
ls 8150 branches: 0x39d3014510 14518 _dl_sysdep_start
(/lib64/ld-2.13.so)
...
ls 8150 branches: 0x39d3015250 1833 process_envvars
(/lib64/ld-2.13.so)
ls 8150 branches: 0x39d3015260 1526f _dl_next_ld_env_entry
(/lib64/ld-2.13.so)
ls 8150 branches: 0x39d3015260 1526f _dl_next_ld_env_entry
(/lib64/ld-2.13.so)


diff --git a/tools/perf/builtin-script.c b/tools/perf/builtin-script.c
index ac574ea..85376b7 100644
--- a/tools/perf/builtin-script.c
+++ b/tools/perf/builtin-script.c
@@ -32,6 +32,7 @@ enum perf_output_field {
PERF_OUTPUT_EVNAME = 1U << 5,
PERF_OUTPUT_TRACE = 1U << 6,
PERF_OUTPUT_SYM = 1U << 7,
+ PERF_OUTPUT_ADDR = 1U << 8,
};

struct output_option {
@@ -46,6 +47,7 @@ struct output_option {
{.str = "event", .field = PERF_OUTPUT_EVNAME},
{.str = "trace", .field = PERF_OUTPUT_TRACE},
{.str = "sym", .field = PERF_OUTPUT_SYM},
+ {.str = "addr", .field = PERF_OUTPUT_ADDR},
};

/* default set to maintain compatibility with current format */
@@ -158,6 +160,8 @@ static void print_sample_start(struct perf_sample
*sample,

printf("%s: ", evname ? evname : "(unknown)");
}
+ if (PRINT_FIELD(ADDR))
+ printf("0x%" PRIx64, sample->addr);
}

static void process_event(union perf_event *event __unused,
@@ -829,7 +833,7 @@ static const struct option options[] = {
OPT_STRING(0, "symfs", &symbol_conf.symfs, "directory",
"Look for files with symbols relative to this directory"),
OPT_CALLBACK('f', "fields", NULL, "str",
- "comma separated output fields prepend with 'type:'. Valid
types: hw,sw,trace. Fields: comm,tid,pid,time,cpu,event,trace,sym",
+ "comma separated output fields prepend with 'type:'. Valid
types: hw,sw,trace. Fields: comm,tid,pid,time,cpu,event,trace,sym,addr",
parse_output_fields),

OPT_END()

>
> Signed-off-by: Akihiro Nagai <akihiro.nagai.hw@xxxxxxxxxxx>
> Reviewed-by: Masami Hiramatsu <masami.hiramatsu.pt@xxxxxxxxxxx>
> Cc: Peter Zijlstra <peterz@xxxxxxxxxxxxx>
> Cc: Frederic Weisbecker <fweisbec@xxxxxxxxx>
> Cc: Paul Mackerras <paulus@xxxxxxxxx>
> Cc: Ingo Molnar <mingo@xxxxxxx>
> Cc: Arnaldo Carvalho de Melo <acme@xxxxxxxxxxxxx>
> ---
>
> tools/perf/Documentation/perf-branch.txt | 18 ++++-
> tools/perf/builtin-branch.c | 119 ++++++++++++++++++++++++++++++
> 2 files changed, 133 insertions(+), 4 deletions(-)
>
> diff --git a/tools/perf/Documentation/perf-branch.txt b/tools/perf/Documentation/perf-branch.txt
> index e223267..6c9c253 100644
> --- a/tools/perf/Documentation/perf-branch.txt
> +++ b/tools/perf/Documentation/perf-branch.txt
> @@ -3,7 +3,7 @@ perf-branch(1)
>
> NAME
> ----
> -perf-branch - Record and print branch-trace-store log
> +perf-branch - Record and analyze branch-trace-store log
>
> SYNOPSIS
> --------
> @@ -12,7 +12,7 @@ SYNOPSIS
>
> DESCRIPTION
> -----------
> -This command records and prints a branch-trace-store log.
> +This command records and analyzes a branch-trace-store log.
> Branch-trace-store is a facility of processors. It can record
> addresses of from/to which the execution of a program branches,
> at every branch instruction and interrupt.
> @@ -20,13 +20,25 @@ at every branch instruction and interrupt.
> 'perf branch record <command>' records branch-trace-store log while
> the specified command is executing. And, save to the file "perf.data".
>
> -'perf branch trace' parses recorded branch-trace-store log and prints it.
> +'perf branch trace' analyzes recorded branch-trace-store log and prints it.
> +The command can select the item to print. For example,
> + 'perf branch -a trace' : prints only address
> + 'perf branch -acp trace' : prints address, command name and pid
>
> OPTIONS
> -------
> -i::
> --input=::
> Specify input file name to analyze.
> +-a::
> +--addr::
> + Print address. (default)
> +-c::
> +--comm::
> + Print command name.
> +-p::
> +--pid::
> + Print pid.
>
> SEE ALSO
> --------
> diff --git a/tools/perf/builtin-branch.c b/tools/perf/builtin-branch.c
> index 7dbabf4..22aa25e 100644
> --- a/tools/perf/builtin-branch.c
> +++ b/tools/perf/builtin-branch.c
> @@ -17,6 +17,32 @@
> /* format string to print address */
> #define FMT_ADDR "%#0" FMT_ADDR_WIDTH "lx"
>
> +/* printable items */
> +struct exec_info {
> + u64 addr; /* recorded address by bts */
> + pid_t pid; /* tracee process pid */
> + const char *comm; /* command name */
> +};
> +
> +#define EI_PID_UNSET -1
> +
> +/* flags which item print */
> +#define EI_FLAG_PRINT_ADDR (1 << 0)
> +#define EI_FLAG_PRINT_PID (1 << 1)
> +#define EI_FLAG_PRINT_COMM (1 << 2)
> +
> +/* it's used when no print item specified */
> +#define EI_FLAG_PRINT_DEFAULT EI_FLAG_PRINT_ADDR
> +
> +/* print item flags */
> +static unsigned long print_flags;
> +
> +#define is_flags_unset(flags) (flags == 0)
> +
> +/* print it when we cannnot analyze and get the information */
> +#define EI_UNKNOWN_TEXT "(unknown)"
> +#define EI_UNKNOWN_TEXT_LEN (sizeof(EI_UNKNOWN_TEXT))
> +
> /* default input file name to analyze */
> static const char *input_name = "perf.data";
>
> @@ -34,8 +60,25 @@ static const char * const record_args[] = {
> "-d",
> };
>
> +/* set print flags call from parse_options() */
> +static int set_print_flags(const struct option *opt, const char *str __unused,
> + int unset __unused)
> +{
> + print_flags |= (unsigned long)opt->defval;
> + return 0;
> +}
> +
> static const struct option branch_options[] = {
> OPT_STRING('i', "input", &input_name, "file", "input file name"),
> + OPT_CALLBACK_DEFAULT_NOOPT('a', "addr", NULL, NULL,
> + "print address (default)", set_print_flags,
> + (void *)EI_FLAG_PRINT_ADDR),
> + OPT_CALLBACK_DEFAULT_NOOPT('p', "pid", NULL, NULL,
> + "print pid", set_print_flags,
> + (void *)EI_FLAG_PRINT_PID),
> + OPT_CALLBACK_DEFAULT_NOOPT('c', "comm", NULL, NULL,
> + "print command name", set_print_flags,
> + (void *)EI_FLAG_PRINT_COMM),
> OPT_END()
> };
>
> @@ -60,20 +103,89 @@ static bool is_bts_sample(struct perf_sample *sample,
> return is_bts_event(evsel);
> }
>
> +static void init_exec_info(struct exec_info *ei)
> +{
> + memset(ei, 0, sizeof(*ei));
> + ei->pid = EI_PID_UNSET;
> +}
> +
> +/* collect printable items to struct exec_info */
> +static void fill_exec_info(struct exec_info *ei,
> + struct perf_session *session, union perf_event *event, u64 addr)
> +{
> + struct thread *thread;
> +
> + ei->addr = addr;
> + ei->pid = event->ip.pid;
> +
> + thread = perf_session__findnew(session, event->ip.pid);
> + if (!thread)
> + return;
> + ei->comm = thread->comm;
> +}
> +
> +static void __print_exec_info(struct exec_info *ei)
> +{
> + char pid[16];
> + const char *comm;
> +
> + if (print_flags & EI_FLAG_PRINT_PID) {
> + if (ei->pid == EI_PID_UNSET)
> + strncpy(pid, EI_UNKNOWN_TEXT, EI_UNKNOWN_TEXT_LEN);
> + else
> + snprintf(pid, 16, "%d", ei->pid);
> + printf("%5s ", pid);
> + }
> + if (print_flags & EI_FLAG_PRINT_COMM) {
> + comm = ei->comm ? : EI_UNKNOWN_TEXT;
> + printf("%-12s ", comm);
> + }
> + if (print_flags & EI_FLAG_PRINT_ADDR)
> + printf(FMT_ADDR " ", ei->addr);
> +}
> +
> +static void print_exec_info(struct exec_info *ei_from, struct exec_info *ei_to)
> +{
> + __print_exec_info(ei_from);
> + printf("=> ");
> + __print_exec_info(ei_to);
> + printf("\n");
> +}
> +
> +static void print_exec_info_header(void)
> +{
> + if (print_flags & EI_FLAG_PRINT_PID)
> + printf("%5s ", "pid");
> + if (print_flags & EI_FLAG_PRINT_COMM)
> + printf("%-12s ", "command");
> + if (print_flags & EI_FLAG_PRINT_ADDR)
> + printf("%-" FMT_ADDR_WIDTH "s ", "address");
> + printf("\n");
> +}
> +
> static int process_sample_event(union perf_event *event __unused,
> struct perf_sample *sample, struct perf_session *session)
> {
> + struct exec_info ei_from, ei_to;
> +
> if (!is_bts_sample(sample, session))
> return 0;
>
> + init_exec_info(&ei_from);
> + init_exec_info(&ei_to);
> +
> /* sample->ip is 'from address', sample->addr is 'to address' */
> - printf(FMT_ADDR " => " FMT_ADDR "\n", sample->ip, sample->addr);
> + fill_exec_info(&ei_from, session, event, sample->ip);
> + fill_exec_info(&ei_to, session, event, sample->addr);
> +
> + print_exec_info(&ei_from, &ei_to);
>
> return 0;
> }
>
> static struct perf_event_ops event_ops = {
> .sample = process_sample_event,
> + .comm = perf_event__process_comm,
> .ordered_samples = false,
> };
>
> @@ -87,7 +199,12 @@ static int __cmd_trace(void)
> return EXIT_FAILURE;
> }
>
> + /* if print flags are unset, we use default flags */
> + if (is_flags_unset(print_flags))
> + print_flags = EI_FLAG_PRINT_DEFAULT;
> +
> setup_pager();
> + print_exec_info_header();
> perf_session__process_events(session, &event_ops);
> perf_session__delete(session);
>
>
> --
> To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
> the body of a message to majordomo@xxxxxxxxxxxxxxx
> More majordomo info at http://vger.kernel.org/majordomo-info.html
> Please read the FAQ at http://www.tux.org/lkml/
--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at http://vger.kernel.org/majordomo-info.html
Please read the FAQ at http://www.tux.org/lkml/