Commit 400ea6d3 authored by Adrian Hunter's avatar Adrian Hunter Committed by Arnaldo Carvalho de Melo
Browse files

perf script: Add field option 'flags' to print sample flags 



Instruction tracing will typically have access to information about the
instruction being executed for a particular ip sample.  Some of that
information will be available in the 'flags' member of struct
perf_sample.

With the addition of transactions events synthesis to Instruction
Tracing options, there is a need to be able easily to see the flags
because they show whether the ip is at the start, commit or abort of a
tranasaction.

Consequently add an option to display the flags.

The flags are "bcrosyiABEx" which stand for branch, call, return,
conditional, system, asynchronous, interrupt, transaction abort, trace
begin, trace end, and in transaction, respectively.

Example using Intel PT:

perf script -fip,time,event,sym,addr,flags

...
 1288.721584105: branches:u:   bo              401146 main =>           401152 main
 1288.721584105: transactions:   x                   0           401164 main
 1288.721584105: branches:u:   bx              40117c main =>           40119b main
 1288.721584105: branches:u:   box             4011a4 main =>           40117e main
 1288.721584105: branches:u:   bcx             401187 main =>           401094 g
...
 1288.721591645: branches:u:   bx              4010c4 g =>           4010cb g
 1288.721591645: branches:u:   brx             4010cc g =>           401189 main
 1288.721591645: transactions:                       0           4011a6 main
 1288.721593199: branches:u:   b               4011a9 main =>           4011af main
 1288.721593199: branches:u:   bo              4011bc main =>           40113e main
 1288.721593199: branches:u:   b               401150 main =>           40115a main
 1288.721593199: transactions:   x                   0           401164 main
 1288.721593199: branches:u:   bx              40117c main =>           40119b main
 1288.721593199: branches:u:   box             4011a4 main =>           40117e main
 1288.721593199: branches:u:   bcx             401187 main =>           40105e f
...
 1288.722284747: branches:u:   brx             401093 f =>           401189 main
 1288.722284747: branches:u:   box             4011a4 main =>           40117e main
 1288.722284747: branches:u:   bcx             401187 main =>           40105e f
 1288.722285883: transactions:   bA                  0           401071 f
 1288.722285883: branches:u:   bA              401071 f =>           40116a main
 1288.722285883: branches:u:   bE              40116a main =>                0 [unknown]
 1288.722297174: branches:u:   bB                   0 [unknown] =>           40116a main
...

Signed-off-by: default avatarAdrian Hunter <adrian.hunter@intel.com>
Cc: David Ahern <dsahern@gmail.com>
Cc: Frederic Weisbecker <fweisbec@gmail.com>
Cc: Jiri Olsa <jolsa@redhat.com>
Cc: Namhyung Kim <namhyung@gmail.com>
Cc: Peter Zijlstra <peterz@infradead.org>
Cc: Stephane Eranian <eranian@google.com>
Link: http://lkml.kernel.org/r/1428594864-29309-26-git-send-email-adrian.hunter@intel.com


Signed-off-by: default avatarArnaldo Carvalho de Melo <acme@redhat.com>
parent 0f0aa5e0

tools/perf/Documentation/perf-script.txt

+8 −1
Original line number Diff line number Diff line
@@ -115,7 +115,8 @@ OPTIONS 
-f::

--fields::

        Comma separated list of fields to print. Options are:

        comm, tid, pid, time, cpu, event, trace, ip, sym, dso, addr, symoff, srcline, period.

        comm, tid, pid, time, cpu, event, trace, ip, sym, dso, addr, symoff,

	srcline, period, flags.

        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
@@ -165,6 +166,12 @@ OPTIONS 


	At this point usage is displayed, and perf-script exits.



	The flags field is synthesized and may have a value when Instruction

	Trace decoding. The flags are "bcrosyiABEx" which stand for branch,

	call, return, conditional, system, asynchronous, interrupt,

	transaction abort, trace begin, trace end, and in transaction,

	respectively.



	Finally, a user may not set fields to none for all event types.

	i.e., -f "" is not allowed.

tools/perf/builtin-script.c

+29 −5
Original line number Diff line number Diff line
@@ -27,6 +27,7 @@ static u64 nr_unordered; 
static bool			no_callchain;

static bool			latency_format;

static bool			system_wide;

static bool			print_flags;

static const char		*cpu_list;

static DECLARE_BITMAP(cpu_bitmap, MAX_NR_CPUS);
@@ -446,6 +447,25 @@ static void print_sample_bts(union perf_event *event, 
	printf("\n");

}



static void print_sample_flags(u32 flags)

{

	const char *chars = PERF_IP_FLAG_CHARS;

	const int n = strlen(PERF_IP_FLAG_CHARS);

	char str[33];

	int i, pos = 0;



	for (i = 0; i < n; i++, flags >>= 1) {

		if (flags & 1)

			str[pos++] = chars[i];

	}

	for (; i < 32; i++, flags >>= 1) {

		if (flags & 1)

			str[pos++] = '?';

	}

	str[pos] = 0;

	printf("  %-4s ", str);

}



static void process_event(union perf_event *event, struct perf_sample *sample,

			  struct perf_evsel *evsel, struct addr_location *al)

{
@@ -465,6 +485,9 @@ static void process_event(union perf_event *event, struct perf_sample *sample, 
		printf("%s: ", evname ? evname : "[unknown]");

	}



	if (print_flags)

		print_sample_flags(sample->flags);



	if (is_bts_event(attr)) {

		print_sample_bts(event, sample, evsel, thread, al);

		return;
@@ -1000,12 +1023,15 @@ static int parse_output_fields(const struct option *opt __maybe_unused, 
		}

	}



	tok = strtok(tok, ",");

	while (tok) {

	for (tok = strtok(tok, ","); tok; tok = strtok(NULL, ",")) {

		for (i = 0; i < imax; ++i) {

			if (strcmp(tok, all_output_options[i].str) == 0)

				break;

		}

		if (i == imax && strcmp(tok, "flags") == 0) {

			print_flags = true;

			continue;

		}

		if (i == imax) {

			fprintf(stderr, "Invalid field requested.\n");

			rc = -EINVAL;
@@ -1033,8 +1059,6 @@ static int parse_output_fields(const struct option *opt __maybe_unused, 
			}

			output[type].fields |= all_output_options[i].field;

		}



		tok = strtok(NULL, ",");

	}



	if (type >= 0) {
@@ -1555,7 +1579,7 @@ int cmd_script(int argc, const char **argv, const char *prefix __maybe_unused) 
		     "comma separated output fields prepend with 'type:'. "

		     "Valid types: hw,sw,trace,raw. "

		     "Fields: comm,tid,pid,time,cpu,event,trace,ip,sym,dso,"

		     "addr,symoff,period", parse_output_fields),

		     "addr,symoff,period,flags", parse_output_fields),

	OPT_BOOLEAN('a', "all-cpus", &system_wide,

		    "system-wide collection from all CPUs"),

	OPT_STRING('S', "symbols", &symbol_conf.sym_list_str, "symbol[,symbol...]",

tools/perf/util/event.h

+2 −0
Original line number Diff line number Diff line
@@ -157,6 +157,8 @@ enum { 
	PERF_IP_FLAG_IN_TX		= 1ULL << 10,

};



#define PERF_IP_FLAG_CHARS "bcrosyiABEx"



#define PERF_BRANCH_MASK		(\

	PERF_IP_FLAG_BRANCH		|\

	PERF_IP_FLAG_CALL		|\

CRA Git | Maintained and supported by SUSTech CRA and CCSE