Commit c8d6828a authored by Sukadev Bhattiprolu's avatar Sukadev Bhattiprolu Committed by Arnaldo Carvalho de Melo
Browse files

perf list: Support long jevents descriptions 



Previously we were dropping the useful longer descriptions that some
events have in the event list completely. This patch makes them appear with
perf list.

Old perf list:

baclears:
  baclears.all
       [Counts the number of baclears]

vs new:

perf list -v:
...
baclears:
  baclears.all
       [The BACLEARS event counts the number of times the front end is
        resteered, mainly when the Branch Prediction Unit cannot provide
        a correct prediction and this is corrected by the Branch Address
        Calculator at the front end. The BACLEARS.ANY event counts the
        number of baclears for any type of branch]

Signed-off-by: default avatarAndi Kleen <ak@linux.intel.com>
Signed-off-by: default avatarSukadev Bhattiprolu <sukadev@linux.vnet.ibm.com>
Acked-by: default avatarIngo Molnar <mingo@kernel.org>
Acked-by: default avatarJiri Olsa <jolsa@redhat.com>
Cc: Madhavan Srinivasan <maddy@linux.vnet.ibm.com>
Cc: Peter Zijlstra <peterz@infradead.org>
Cc: linuxppc-dev@lists.ozlabs.org
Link: http://lkml.kernel.org/r/1473978296-20712-13-git-send-email-sukadev@linux.vnet.ibm.com


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

tools/perf/Documentation/perf-list.txt

+5 −1
Original line number Diff line number Diff line
@@ -8,7 +8,7 @@ perf-list - List all symbolic event types 
SYNOPSIS

--------

[verse]

'perf list' [--no-desc] [hw|sw|cache|tracepoint|pmu|event_glob]

'perf list' [--no-desc] [--long-desc] [hw|sw|cache|tracepoint|pmu|event_glob]



DESCRIPTION

-----------
@@ -20,6 +20,10 @@ OPTIONS 
--no-desc::

Don't print descriptions.



-v::

--long-desc::

Print longer event descriptions.





[[EVENT_MODIFIERS]]

EVENT MODIFIERS

tools/perf/builtin-list.c

+11 −5
Original line number Diff line number Diff line
@@ -22,14 +22,17 @@ int cmd_list(int argc, const char **argv, const char *prefix __maybe_unused) 
{

	int i;

	bool raw_dump = false;

	bool long_desc_flag = false;

	struct option list_options[] = {

		OPT_BOOLEAN(0, "raw-dump", &raw_dump, "Dump raw events"),

		OPT_BOOLEAN('d', "desc", &desc_flag,

			    "Print extra event descriptions. --no-desc to not print."),

		OPT_BOOLEAN('v', "long-desc", &long_desc_flag,

			    "Print longer event descriptions."),

		OPT_END()

	};

	const char * const list_usage[] = {

		"perf list [--no-desc] [hw|sw|cache|tracepoint|pmu|sdt|event_glob]",

		"perf list [<options>] [hw|sw|cache|tracepoint|pmu|sdt|event_glob]",

		NULL

	};
@@ -44,7 +47,7 @@ int cmd_list(int argc, const char **argv, const char *prefix __maybe_unused) 
		printf("\nList of pre-defined events (to be used in -e):\n\n");



	if (argc == 0) {

		print_events(NULL, raw_dump, !desc_flag);

		print_events(NULL, raw_dump, !desc_flag, long_desc_flag);

		return 0;

	}
@@ -65,14 +68,16 @@ int cmd_list(int argc, const char **argv, const char *prefix __maybe_unused) 
			 strcmp(argv[i], "hwcache") == 0)

			print_hwcache_events(NULL, raw_dump);

		else if (strcmp(argv[i], "pmu") == 0)

			print_pmu_events(NULL, raw_dump, !desc_flag);

			print_pmu_events(NULL, raw_dump, !desc_flag,

						long_desc_flag);

		else if (strcmp(argv[i], "sdt") == 0)

			print_sdt_events(NULL, NULL, raw_dump);

		else if ((sep = strchr(argv[i], ':')) != NULL) {

			int sep_idx;



			if (sep == NULL) {

				print_events(argv[i], raw_dump, !desc_flag);

				print_events(argv[i], raw_dump, !desc_flag,

							long_desc_flag);

				continue;

			}

			sep_idx = sep - argv[i];
@@ -94,7 +99,8 @@ int cmd_list(int argc, const char **argv, const char *prefix __maybe_unused) 
			print_symbol_events(s, PERF_TYPE_SOFTWARE,

					    event_symbols_sw, PERF_COUNT_SW_MAX, raw_dump);

			print_hwcache_events(s, raw_dump);

			print_pmu_events(s, raw_dump, !desc_flag);

			print_pmu_events(s, raw_dump, !desc_flag,

						long_desc_flag);

			print_tracepoint_events(NULL, s, raw_dump);

			print_sdt_events(NULL, s, raw_dump);

			free(s);

tools/perf/util/parse-events.c

+3 −2
Original line number Diff line number Diff line
@@ -2263,7 +2263,8 @@ out_enomem: 
/*

 * Print the help text for the event symbols:

 */

void print_events(const char *event_glob, bool name_only, bool quiet_flag)

void print_events(const char *event_glob, bool name_only, bool quiet_flag,

			bool long_desc)

{

	print_symbol_events(event_glob, PERF_TYPE_HARDWARE,

			    event_symbols_hw, PERF_COUNT_HW_MAX, name_only);
@@ -2273,7 +2274,7 @@ void print_events(const char *event_glob, bool name_only, bool quiet_flag) 


	print_hwcache_events(event_glob, name_only);



	print_pmu_events(event_glob, name_only, quiet_flag);

	print_pmu_events(event_glob, name_only, quiet_flag, long_desc);



	if (event_glob != NULL)

		return;

tools/perf/util/parse-events.h

+2 −1
Original line number Diff line number Diff line
@@ -172,7 +172,8 @@ void parse_events_update_lists(struct list_head *list_event, 
void parse_events_evlist_error(struct parse_events_evlist *data,

			       int idx, const char *str);



void print_events(const char *event_glob, bool name_only, bool quiet);

void print_events(const char *event_glob, bool name_only, bool quiet,

		  bool long_desc);



struct event_symbol {

	const char	*symbol;

tools/perf/util/pmu.c

+10 −5
Original line number Diff line number Diff line
@@ -223,7 +223,7 @@ static int perf_pmu__parse_snapshot(struct perf_pmu_alias *alias, 
}



static int __perf_pmu__new_alias(struct list_head *list, char *dir, char *name,

				 char *desc, char *val)

				 char *desc, char *val, char *long_desc)

{

	struct perf_pmu_alias *alias;

	int ret;
@@ -257,6 +257,8 @@ static int __perf_pmu__new_alias(struct list_head *list, char *dir, char *name, 
	}



	alias->desc = desc ? strdup(desc) : NULL;

	alias->long_desc = long_desc ? strdup(long_desc) :

				desc ? strdup(desc) : NULL;



	list_add_tail(&alias->list, list);
@@ -274,7 +276,7 @@ static int perf_pmu__new_alias(struct list_head *list, char *dir, char *name, FI 


	buf[ret] = 0;



	return __perf_pmu__new_alias(list, dir, name, NULL, buf);

	return __perf_pmu__new_alias(list, dir, name, NULL, buf, NULL);

}



static inline bool pmu_alias_info_file(char *name)
@@ -532,7 +534,8 @@ static void pmu_add_cpu_aliases(struct list_head *head) 


		/* need type casts to override 'const' */

		__perf_pmu__new_alias(head, NULL, (char *)pe->name,

				(char *)pe->desc, (char *)pe->event);

				(char *)pe->desc, (char *)pe->event,

				(char *)pe->long_desc);

	}



out:
@@ -1090,7 +1093,8 @@ static void wordwrap(char *s, int start, int max, int corr) 
	}

}



void print_pmu_events(const char *event_glob, bool name_only, bool quiet_flag)

void print_pmu_events(const char *event_glob, bool name_only, bool quiet_flag,

			bool long_desc)

{

	struct perf_pmu *pmu;

	struct perf_pmu_alias *alias;
@@ -1138,7 +1142,8 @@ void print_pmu_events(const char *event_glob, bool name_only, bool quiet_flag) 
			if (!aliases[j].name)

				goto out_enomem;



			aliases[j].desc = alias->desc;

			aliases[j].desc = long_desc ? alias->long_desc :

						alias->desc;

			j++;

		}

		if (pmu->selectable &&

CRA Git | Maintained and supported by SUSTech CRA and CCSE