perf script: add BTS analysis features

Add the option '--show-symbol-offset' to show the offset from the symbols in the output of perf-script. We can get the more detailed address information.

Output sample:

# perf script -f ip,addr,sym --show-symbol-offset
301ec016b0 ffffffff81467612 irq_return+0x0
301ec016b0            _start+0x0 ffffffff81467612 irq_return+0x0
301ec04b70         _dl_start+0x0       301ec016b3 _start+0x3
301ec04b70         _dl_start+0x0 ffffffff81467612 irq_return+0x0
301ec04b96        _dl_start+0x26 ffffffff81467612 irq_return+0x0
301ec04b9d        _dl_start+0x2d ffffffff81467612 irq_return+0x0
301ec04c0d        _dl_start+0x9d       301ec04beb _dl_start+0x7b
301ec04bf0        _dl_start+0x80       301ec04c11 _dl_start+0xa1
[snip]

Signed-off-by Akihiro Nagai <[email protected]>

Cc Peter Zijlstra <[email protected]>

Cc Frederic Weisbecker <[email protected]>

Cc Paul Mackerras <[email protected]>

Cc Ingo Molnar <[email protected]>

Cc Arnaldo Carvalho de Melo <[email protected]>

Cc David Ahern <[email protected]>

Cc Masami Hiramatsu <[email protected]>

---

 tools/perf/Documentation/perf-script.txt |    3 +++
 tools/perf/builtin-script.c              |   20 ++++++++++++++------
 tools/perf/util/session.c                |   16 ++++++++++------
 tools/perf/util/session.h                |    3 ++-
 4 files changed, 29 insertions(+), 13 deletions(-)

tools/perf/Documentation/perf-script.txt +3 -0

index c6068cb..39c4721 100644
@@ -182,6 +182,9 @@ OPTIONS
 --hide-call-graph::
         When printing symbols do not display call chain.
 
+--show-symbol-offset::
+	Show the offset of the symbols.
+
 SEE ALSO
 --------
 linkperf:perf-record[1], linkperf:perf-script-perl[1],

tools/perf/builtin-script.c +2 -0

index 2d68086..f9b7047 100644
@@ -21,6 +21,7 @@ static u64			last_timestamp;
 static u64			nr_unordered;
 extern const struct option	record_options[];
 static bool			no_callchain;
+static bool			show_symbol_offset;
 
 enum perf_output_field {
 	PERF_OUTPUT_COMM            = 1U << 0,

@@ -324,6 +325,7 @@ static void print_sample_addr(union perf_event *event,
 	struct addr_location al;
 	u8 cpumode = event->header.misc & PERF_RECORD_MISC_CPUMODE_MASK;
 	const char *symname, *dsoname;
+	unsigned long offset;
 
 	printf("%16" PRIx64, sample->addr);
 

tools/perf/builtin-script.c +9 -1

+			if (show_symbol_offset)
+				printf("%16s+0x%lx", symname, offset);
+			else
+				printf("%16s", symname);
+		}
 	}
 
 	if (PRINT_FIELD(DSO)) {

@@ -390,7 +395,8 @@ static void process_event(union perf_event *event __unused,
 		else
 			printf("\n");
 		perf_session__print_ip(event, sample, session,
-					      PRINT_FIELD(SYM), PRINT_FIELD(DSO));
+				       PRINT_FIELD(SYM), PRINT_FIELD(DSO),
+				       show_symbol_offset);
 	}
 
 	printf("\n");

@@ -1084,6 +1090,8 @@ static const struct option options[] = {
 	OPT_CALLBACK('f', "fields", NULL, "str",
 		     "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",
 		     parse_output_fields),
+	OPT_BOOLEAN('\0', "show-symbol-offset", &show_symbol_offset,
+		    "Show the offset of the symbol."),
 
 	OPT_END()
 };

tools/perf/util/session.c +2 -2

index 632266f..bb522ed 100644
@@ -1205,10 +1205,11 @@ struct perf_evsel *perf_session__find_first_evtype(struct perf_session *session,
 void perf_session__print_ip(union perf_event *event,
 			    struct perf_sample *sample,
 			    struct perf_session *session,
-			    int print_sym, int print_dso)
+			    int print_sym, int print_dso, int print_offset)
 {
 	struct addr_location al;
 	const char *symname, *dsoname;
+	unsigned long offset;
 	struct callchain_cursor *cursor = &session->callchain_cursor;
 	struct callchain_cursor_node *node;
 

@@ -1259,12 +1260,15 @@ void perf_session__print_ip(union perf_event *event,
 	} else {
 		printf("%16" PRIx64, sample->ip);
 		if (print_sym) {
-			if (al.sym && al.sym->name)

tools/perf/util/session.c +3 -0

+				else
+					printf("%s", symname);
+			}
 		}
 
 		if (print_dso) {

tools/perf/util/session.h +2 -1

index de4178d..8187e68 100644
@@ -170,6 +170,7 @@ struct perf_evsel *perf_session__find_first_evtype(struct perf_session *session,
 void perf_session__print_ip(union perf_event *event,
 				 struct perf_sample *sample,
 				 struct perf_session *session,
-				 int print_sym, int print_dso);
+				 int print_sym, int print_dso,
+				 int print_offset);
 
 #endif /* __PERF_SESSION_H */

Quoted 3 lines · Akihiro Nagai

Add the option '--show-symbol-offset' to show the offset from the symbols in the output of perf-script. We can get the more detailed address information.

I like the offset option; added that locally last week as well. more below.

Quoted 65 lines

Output sample:

# perf script -f ip,addr,sym --show-symbol-offset
301ec016b0 ffffffff81467612 irq_return+0x0
301ec016b0            _start+0x0 ffffffff81467612 irq_return+0x0
301ec04b70         _dl_start+0x0       301ec016b3 _start+0x3
301ec04b70         _dl_start+0x0 ffffffff81467612 irq_return+0x0
301ec04b96        _dl_start+0x26 ffffffff81467612 irq_return+0x0
301ec04b9d        _dl_start+0x2d ffffffff81467612 irq_return+0x0
301ec04c0d        _dl_start+0x9d       301ec04beb _dl_start+0x7b
301ec04bf0        _dl_start+0x80       301ec04c11 _dl_start+0xa1
[snip]

Signed-off-by Akihiro Nagai <[email protected]>

Cc Peter Zijlstra <[email protected]>

Cc Frederic Weisbecker <[email protected]>

Cc Paul Mackerras <[email protected]>

Cc Ingo Molnar <[email protected]>

Cc Arnaldo Carvalho de Melo <[email protected]>

Cc David Ahern <[email protected]>

Cc Masami Hiramatsu <[email protected]>

---

 tools/perf/Documentation/perf-script.txt |    3 +++
 tools/perf/builtin-script.c              |   20 ++++++++++++++------
 tools/perf/util/session.c                |   16 ++++++++++------
 tools/perf/util/session.h                |    3 ++-
 4 files changed, 29 insertions(+), 13 deletions(-)

tools/perf/Documentation/perf-script.txt +3 -0

index c6068cb..39c4721 100644
@@ -182,6 +182,9 @@ OPTIONS
 --hide-call-graph::
         When printing symbols do not display call chain.
 
+--show-symbol-offset::
+	Show the offset of the symbols.
+
 SEE ALSO
 --------
 linkperf:perf-record[1], linkperf:perf-script-perl[1],

tools/perf/builtin-script.c +2 -0

index 2d68086..f9b7047 100644
@@ -21,6 +21,7 @@ static u64			last_timestamp;
 static u64			nr_unordered;
 extern const struct option	record_options[];
 static bool			no_callchain;
+static bool			show_symbol_offset;
 
 enum perf_output_field {
 	PERF_OUTPUT_COMM            = 1U << 0,

@@ -324,6 +325,7 @@ static void print_sample_addr(union perf_event *event,
 	struct addr_location al;
 	u8 cpumode = event->header.misc & PERF_RECORD_MISC_CPUMODE_MASK;
 	const char *symname, *dsoname;
+	unsigned long offset;
 
 	printf("%16" PRIx64, sample->addr);
 

tools/perf/builtin-script.c static void print_sample_addr(union perf_event *event, · line 352

Quoted 9 lines

tools/perf/builtin-script.c +2 -3

@@ -346,12 +348,15 @@ static void print_sample_addr(union perf_event *event,
 		al.sym = map__find_symbol(al.map, al.addr, NULL);
 
 	if (PRINT_FIELD(SYM)) {
-		if (al.sym && al.sym->name)
+		printf(" ");
+		if (al.sym && al.sym->name) {
 			symname = al.sym->name;
-		else
-			symname = "";

dropping the else path will cause columns to misalign when ip's do not resolve.

tools/perf/builtin-script.c static void print_sample_addr(union perf_event *event, · line 354

Quoted 3 lines

tools/perf/builtin-script.c +1 -2

-
-		printf(" %16s", symname);
+			offset = al.addr - al.sym->start;

move the offset calculation under the if (show_symbol_offset)

Quoted 49 lines

tools/perf/builtin-script.c +9 -1

+			if (show_symbol_offset)
+				printf("%16s+0x%lx", symname, offset);
+			else
+				printf("%16s", symname);
+		}
 	}
 
 	if (PRINT_FIELD(DSO)) {

@@ -390,7 +395,8 @@ static void process_event(union perf_event *event __unused,
 		else
 			printf("\n");
 		perf_session__print_ip(event, sample, session,
-					      PRINT_FIELD(SYM), PRINT_FIELD(DSO));
+				       PRINT_FIELD(SYM), PRINT_FIELD(DSO),
+				       show_symbol_offset);
 	}
 
 	printf("\n");

@@ -1084,6 +1090,8 @@ static const struct option options[] = {
 	OPT_CALLBACK('f', "fields", NULL, "str",
 		     "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",
 		     parse_output_fields),
+	OPT_BOOLEAN('\0', "show-symbol-offset", &show_symbol_offset,
+		    "Show the offset of the symbol."),
 
 	OPT_END()
 };

tools/perf/util/session.c +2 -2

index 632266f..bb522ed 100644
@@ -1205,10 +1205,11 @@ struct perf_evsel *perf_session__find_first_evtype(struct perf_session *session,
 void perf_session__print_ip(union perf_event *event,
 			    struct perf_sample *sample,
 			    struct perf_session *session,
-			    int print_sym, int print_dso)
+			    int print_sym, int print_dso, int print_offset)
 {
 	struct addr_location al;
 	const char *symname, *dsoname;
+	unsigned long offset;
 	struct callchain_cursor *cursor = &session->callchain_cursor;
 	struct callchain_cursor_node *node;
 

@@ -1259,12 +1260,15 @@ void perf_session__print_ip(union perf_event *event,
 	} else {
 		printf("%16" PRIx64, sample->ip);
 		if (print_sym) {
-			if (al.sym && al.sym->name)

tools/perf/util/session.c void perf_session__print_ip(union perf_event *event, · line 1268

Quoted 10 lines

tools/perf/util/session.c +5 -4

+			printf(" ");
+			if (al.sym && al.sym->name) {
 				symname = al.sym->name;
-			else
-				symname = "";
-
-			printf(" %s", symname);
+				offset = al.addr - al.sym->start;
+				if (print_offset)
+					printf("%s+0x%lx", symname, offset);

same comments for this code path.

David

Quoted 20 lines

tools/perf/util/session.c +3 -0

+				else
+					printf("%s", symname);
+			}
 		}
 
 		if (print_dso) {

tools/perf/util/session.h +2 -1

index de4178d..8187e68 100644
@@ -170,6 +170,7 @@ struct perf_evsel *perf_session__find_first_evtype(struct perf_session *session,
 void perf_session__print_ip(union perf_event *event,
 				 struct perf_sample *sample,
 				 struct perf_session *session,
-				 int print_sym, int print_dso);
+				 int print_sym, int print_dso,
+				 int print_offset);
 
 #endif /* __PERF_SESSION_H */

Quoted 5 lines · David Ahern

Quoted 3 lines · Akihiro Nagai

Add the option '--show-symbol-offset' to show the offset from the symbols in the output of perf-script. We can get the more detailed address information.

Quoted 1 line

I like the offset option; added that locally last week as well. more below.

one more comment: move the --show-symbol-offset option to a field parameter - like ip, addr, dso and sym. For parameter checking make it depend on the sym field.

Update the Documentation file as well.

David

Quoted 77 lines

Quoted 65 lines

Output sample:

# perf script -f ip,addr,sym --show-symbol-offset
301ec016b0 ffffffff81467612 irq_return+0x0
301ec016b0            _start+0x0 ffffffff81467612 irq_return+0x0
301ec04b70         _dl_start+0x0       301ec016b3 _start+0x3
301ec04b70         _dl_start+0x0 ffffffff81467612 irq_return+0x0
301ec04b96        _dl_start+0x26 ffffffff81467612 irq_return+0x0
301ec04b9d        _dl_start+0x2d ffffffff81467612 irq_return+0x0
301ec04c0d        _dl_start+0x9d       301ec04beb _dl_start+0x7b
301ec04bf0        _dl_start+0x80       301ec04c11 _dl_start+0xa1
[snip]

Signed-off-by Akihiro Nagai<[email protected]>

Cc Peter Zijlstra<[email protected]>

Cc Frederic Weisbecker<[email protected]>

Cc Paul Mackerras<[email protected]>

Cc Ingo Molnar<[email protected]>

Cc Arnaldo Carvalho de Melo<[email protected]>

Cc David Ahern<[email protected]>

Cc Masami Hiramatsu<[email protected]>

---

  tools/perf/Documentation/perf-script.txt |    3 +++
  tools/perf/builtin-script.c              |   20 ++++++++++++++------
  tools/perf/util/session.c                |   16 ++++++++++------
  tools/perf/util/session.h                |    3 ++-
  4 files changed, 29 insertions(+), 13 deletions(-)

tools/perf/Documentation/perf-script.txt +3 -0

index c6068cb..39c4721 100644
@@ -182,6 +182,9 @@ OPTIONS
  --hide-call-graph::
          When printing symbols do not display call chain.
 
+--show-symbol-offset::
+	Show the offset of the symbols.
+
  SEE ALSO
  --------
  linkperf:perf-record[1], linkperf:perf-script-perl[1],

tools/perf/builtin-script.c +2 -0

index 2d68086..f9b7047 100644
@@ -21,6 +21,7 @@ static u64			last_timestamp;
  static u64			nr_unordered;
  extern const struct option	record_options[];
  static bool			no_callchain;
+static bool			show_symbol_offset;
 
  enum perf_output_field {
  	PERF_OUTPUT_COMM            = 1U<<  0,

@@ -324,6 +325,7 @@ static void print_sample_addr(union perf_event *event,
  	struct addr_location al;
  	u8 cpumode = event->header.misc&  PERF_RECORD_MISC_CPUMODE_MASK;
  	const char *symname, *dsoname;
+	unsigned long offset;
 
  	printf("%16" PRIx64, sample->addr);
 

tools/perf/builtin-script.c static void print_sample_addr(union perf_event *event, · line 352

Quoted 9 lines

tools/perf/builtin-script.c +2 -3

@@ -346,12 +348,15 @@ static void print_sample_addr(union perf_event *event,
  		al.sym = map__find_symbol(al.map, al.addr, NULL);
 
  	if (PRINT_FIELD(SYM)) {
-		if (al.sym&&  al.sym->name)
+		printf(" ");
+		if (al.sym&&  al.sym->name) {
  			symname = al.sym->name;
-		else
-			symname = "";

dropping the else path will cause columns to misalign when ip's do not resolve.

Quoted 6 lines

tools/perf/builtin-script.c static void print_sample_addr(union perf_event *event, · line 354

Quoted 4 lines

tools/perf/builtin-script.c +1 -2

-
-		printf(" %16s", symname);
+			offset = al.addr - al.sym->start;

move the offset calculation under the if (show_symbol_offset)

Quoted 54 lines

Quoted 54 lines

tools/perf/builtin-script.c +9 -1

+			if (show_symbol_offset)
+				printf("%16s+0x%lx", symname, offset);
+			else
+				printf("%16s", symname);
+		}
  	}
 
  	if (PRINT_FIELD(DSO)) {

@@ -390,7 +395,8 @@ static void process_event(union perf_event *event __unused,
  		else
  			printf("\n");
  		perf_session__print_ip(event, sample, session,
-					      PRINT_FIELD(SYM), PRINT_FIELD(DSO));
+				       PRINT_FIELD(SYM), PRINT_FIELD(DSO),
+				       show_symbol_offset);
  	}
 
  	printf("\n");

@@ -1084,6 +1090,8 @@ static const struct option options[] = {
  	OPT_CALLBACK('f', "fields", NULL, "str",
  		     "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",
  		     parse_output_fields),
+	OPT_BOOLEAN('\0', "show-symbol-offset",&show_symbol_offset,
+		    "Show the offset of the symbol."),
 
  	OPT_END()
  };

tools/perf/util/session.c +4 -3

index 632266f..bb522ed 100644
@@ -1205,10 +1205,11 @@ struct perf_evsel *perf_session__find_first_evtype(struct perf_session *session,
  void perf_session__print_ip(union perf_event *event,
  			    struct perf_sample *sample,
  			    struct perf_session *session,
-			    int print_sym, int print_dso)
+			    int print_sym, int print_dso, int print_offset)
  {
  	struct addr_location al;
  	const char *symname, *dsoname;
+	unsigned long offset;
  	struct callchain_cursor *cursor =&session->callchain_cursor;
  	struct callchain_cursor_node *node;
 

@@ -1259,12 +1260,15 @@ void perf_session__print_ip(union perf_event *event,
  	} else {
  		printf("%16" PRIx64, sample->ip);
  		if (print_sym) {
-			if (al.sym&&  al.sym->name)
+			printf(" ");
+			if (al.sym&&  al.sym->name) {
  				symname = al.sym->name;
-			else

Quoted 8 lines

tools/perf/util/session.c void perf_session__print_ip(union perf_event *event, · line 1268

Quoted 6 lines

tools/perf/util/session.c +3 -3

-				symname = "";
-
-			printf(" %s", symname);
+				offset = al.addr - al.sym->start;
+				if (print_offset)
+					printf("%s+0x%lx", symname, offset);

same comments for this code path.

Quoted 24 lines

David

Quoted 20 lines

tools/perf/util/session.c +3 -0

+				else
+					printf("%s", symname);
+			}
  		}
 
  		if (print_dso) {

tools/perf/util/session.h +2 -1

index de4178d..8187e68 100644
@@ -170,6 +170,7 @@ struct perf_evsel *perf_session__find_first_evtype(struct perf_session *session,
  void perf_session__print_ip(union perf_event *event,
  				 struct perf_sample *sample,
  				 struct perf_session *session,
-				 int print_sym, int print_dso);
+				 int print_sym, int print_dso,
+				 int print_offset);
 
  #endif /* __PERF_SESSION_H */

Quoted 4 lines

Quoted 4 lines

Quoted 4 lines

tools/perf/builtin-script.c +0 -0

@@ -346,12 +348,15 @@ static void print_sample_addr(union perf_event
 *event,
          al.sym = map__find_symbol(al.map, al.addr, NULL);
 

Quoted 10 lines

Quoted 10 lines

tools/perf/builtin-script.c static void print_sample_addr(union perf_event *event, · line 352

Quoted 7 lines

tools/perf/builtin-script.c +2 -3

      if (PRINT_FIELD(SYM)) {
-        if (al.sym&&  al.sym->name)
+        printf(" ");
+        if (al.sym&&  al.sym->name) {
              symname = al.sym->name;
-        else
-            symname = "";

dropping the else path will cause columns to misalign when ip's do not resolve.

I see.
I'd like to add a magic word that indicates perf-script failed to resolve the symbol.
For example, '[unknown]'.

BTW, I couldn't run a script generated by 'perf script -g {pyton|perl}' with branch events. How do I make scripts analyzing branch events?

# perf record -e branches:u -c 1 -d ls
# perf script -g python
# perf script -s perf-script.py
 in trace_begin
   Fatal: no event_list!
# perf script -g perl
# perf script -s perf-script.pl
   Fatal: no event_list!

Quoted 11 lines · Akihiro Nagai

BTW, I couldn't run a script generated by 'perf script -g {pyton|perl}' with branch events. How do I make scripts analyzing branch events?

# perf record -e branches:u -c 1 -d ls
# perf script -g python
# perf script -s perf-script.py
  in trace_begin
    Fatal: no event_list!
# perf script -g perl
# perf script -s perf-script.pl
    Fatal: no event_list!

Generated scripts currently only work on trace events. At this point it is arguable that perf-script should be focused on the python and perl scripts and the code for dumping the events should be moved to a new command (perf-dump?).

David