Skip to contentSkip to conversation

perf, tools: Add support for perf list json

PATCH Applied Andi Kleen 3 participants 9 messages Oct 6, 2016 perf events

lore
Share & tools
lore

Andi Kleen

author
#0 lore raw

PATCH 1/3 perf, tools: Add support for perf list json

From: Andi Kleen <[email protected]>

Add an argument to perf list to only list json events. To be used for the command line completion script. This requires adding a new flag to the alias structure.

---
 tools/perf/Documentation/perf-list.txt |  2 +-
 tools/perf/builtin-list.c              |  9 ++++++---
 tools/perf/util/parse-events.c         |  2 +-
 tools/perf/util/pmu.c                  | 14 ++++++++++----
 tools/perf/util/pmu.h                  |  3 ++-
 5 files changed, 20 insertions(+), 10 deletions(-)
tools/perf/Documentation/perf-list.txt +1 -1
index 41857cce5e86..50a35b27a64d 100644
@@ -8,7 +8,7 @@ perf-list - List all symbolic event types
 SYNOPSIS
 --------
 [verse]
-'perf list' [--no-desc] [--long-desc] [hw|sw|cache|tracepoint|pmu|event_glob]
+'perf list' [--no-desc] [--long-desc] [hw|sw|cache|tracepoint|pmu|json|sdt|event_glob]
 
 DESCRIPTION
 -----------
tools/perf/builtin-list.c +6 -3
index ba9322ff858b..b9ccdc7ec733 100644
@@ -32,7 +32,7 @@ int cmd_list(int argc, const char **argv, const char *prefix __maybe_unused)
 		OPT_END()
 	};
 	const char * const list_usage[] = {
-		"perf list [<options>] [hw|sw|cache|tracepoint|pmu|sdt|event_glob]",
+		"perf list [<options>] [hw|sw|cache|tracepoint|pmu|sdt|json|event_glob]",
 		NULL
 	};
 
@@ -69,9 +69,12 @@ int cmd_list(int argc, const char **argv, const char *prefix __maybe_unused)
 			print_hwcache_events(NULL, raw_dump);
 		else if (strcmp(argv[i], "pmu") == 0)
 			print_pmu_events(NULL, raw_dump, !desc_flag,
-						long_desc_flag);
+						long_desc_flag, false);
 		else if (strcmp(argv[i], "sdt") == 0)
 			print_sdt_events(NULL, NULL, raw_dump);
+		else if (strcmp(argv[i], "json") == 0)
+			print_pmu_events(NULL, raw_dump, !desc_flag,
+					long_desc_flag, true);
 		else if ((sep = strchr(argv[i], ':')) != NULL) {
 			int sep_idx;
 
@@ -100,7 +103,7 @@ int cmd_list(int argc, const char **argv, const char *prefix __maybe_unused)
 					    event_symbols_sw, PERF_COUNT_SW_MAX, raw_dump);
 			print_hwcache_events(s, raw_dump);
 			print_pmu_events(s, raw_dump, !desc_flag,
-						long_desc_flag);
+						long_desc_flag, false);
 			print_tracepoint_events(NULL, s, raw_dump);
 			print_sdt_events(NULL, s, raw_dump);
 			free(s);
tools/perf/util/parse-events.c +1 -1
index 4e778eae1510..948ef84e4c6a 100644
@@ -2275,7 +2275,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, long_desc);
+	print_pmu_events(event_glob, name_only, quiet_flag, long_desc, false);
 
 	if (event_glob != NULL)
 		return;
tools/perf/util/pmu.c +10 -4
index b1474dcadfa2..d8d7d4c0319c 100644
@@ -224,7 +224,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 *long_desc,
-				 char *topic)
+				 char *topic, bool json)
 {
 	struct perf_pmu_alias *alias;
 	int ret;
@@ -238,6 +238,7 @@ static int __perf_pmu__new_alias(struct list_head *list, char *dir, char *name,
 	alias->unit[0] = '\0';
 	alias->per_pkg = false;
 	alias->snapshot = false;
+	alias->json = json;
 
 	ret = parse_events_terms(&alias->terms, val);
 	if (ret) {
@@ -278,7 +279,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, NULL, NULL);
+	return __perf_pmu__new_alias(list, dir, name, NULL, buf, NULL, NULL, false);
 }
 
 static inline bool pmu_alias_info_file(char *name)
@@ -537,7 +538,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->long_desc, (char *)pe->topic);
+				(char *)pe->long_desc, (char *)pe->topic,
+				true);
 	}
 
 out:
@@ -1103,7 +1105,7 @@ 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,
-			bool long_desc)
+			bool long_desc, bool json_only)
 {
 	struct perf_pmu *pmu;
 	struct perf_pmu_alias *alias;
@@ -1134,6 +1136,9 @@ void print_pmu_events(const char *event_glob, bool name_only, bool quiet_flag,
 				format_alias(buf, sizeof(buf), pmu, alias);
 			bool is_cpu = !strcmp(pmu->name, "cpu");
 
+			if (json_only && !alias->json)
+				continue;
+
 			if (event_glob != NULL &&
 			    !(strglobmatch(name, event_glob) ||
 			      (!is_cpu && strglobmatch(alias->name,
@@ -1158,6 +1163,7 @@ void print_pmu_events(const char *event_glob, bool name_only, bool quiet_flag,
 			j++;
 		}
 		if (pmu->selectable &&
+		    !json_only &&
 		    (event_glob == NULL || strglobmatch(pmu->name, event_glob))) {
 			char *s;
 			if (asprintf(&s, "%s//", pmu->name) < 0)
tools/perf/util/pmu.h +2 -1
index 25712034c815..19fa2e19dbe9 100644
@@ -49,6 +49,7 @@ struct perf_pmu_alias {
 	double scale;
 	bool per_pkg;
 	bool snapshot;
+	bool json;
 };
 
 struct perf_pmu *perf_pmu__find(const char *name);
@@ -75,7 +76,7 @@ int perf_pmu__format_parse(char *dir, struct list_head *head);
 struct perf_pmu *perf_pmu__scan(struct perf_pmu *pmu);
 
 void print_pmu_events(const char *event_glob, bool name_only, bool quiet,
-		      bool long_desc);
+		      bool long_desc, bool json_only);
 bool pmu_have_event(const char *pname, const char *name);
 
 int perf_pmu__scan_file(struct perf_pmu *pmu, const char *name, const char *fmt,
Signature · 1 line
2.5.5
author
#1 lore raw

PATCH 2/3 perf, tools: Handle completion of upper case events

From: Andi Kleen <[email protected]>

Vendor events are often specified in upper case. perf list outputs them in lower case. Handle this case in perf-completion.sh so that completion on the upper case events still works.

v2: Use locale aware check for upper case
v3: Use perf list json

---
 tools/perf/perf-completion.sh | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)
tools/perf/perf-completion.sh +5 -1
index 3ba80b2359cc..3b5a258a4b7b 100644
@@ -161,7 +161,11 @@ __perf_main ()
 	# List possible events for -e option
 	elif [[ $prev == @("-e"|"--event") &&
 		$prev_skip_opts == @(record|stat|top) ]]; then
-		evts=$($cmd list --raw-dump)
+		# handle upper case events
+		case "$cur" in
+			[[:upper:]]*) evts=$($cmd list --raw-dump json | tr a-z A-Z) ;;
+			*) evts=$($cmd list --raw-dump) ;;
+		esac
 		__perfcomp_colon "$evts" "$cur"
 	else
 		# List subcommands for perf commands
Signature · 1 line
2.5.5
maintainer Applied
#2 lore raw

Re: [PATCH 2/3] perf, tools: Handle completion of upper case events

Em Thu, Oct 06, 2016 at 12:23:26PM -0700, Andi Kleen escreveu:

Quoted 5 lines

From: Andi Kleen <[email protected]>

Vendor events are often specified in upper case. perf list outputs them in lower case. Handle this case in perf-completion.sh so that completion on the upper case events still works.

Thanks, applied.

Quoted 26 lines

v2: Use locale aware check for upper case
v3: Use perf list json

---
 tools/perf/perf-completion.sh | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)
tools/perf/perf-completion.sh +5 -1
index 3ba80b2359cc..3b5a258a4b7b 100644
@@ -161,7 +161,11 @@ __perf_main ()
 	# List possible events for -e option
 	elif [[ $prev == @("-e"|"--event") &&
 		$prev_skip_opts == @(record|stat|top) ]]; then
-		evts=$($cmd list --raw-dump)
+		# handle upper case events
+		case "$cur" in
+			[[:upper:]]*) evts=$($cmd list --raw-dump json | tr a-z A-Z) ;;
+			*) evts=$($cmd list --raw-dump) ;;
+		esac
 		__perfcomp_colon "$evts" "$cur"
 	else
 		# List subcommands for perf commands
Signature · 1 line
2.5.5
author
#3 lore raw

PATCH 3/3 perf, tools: Fix completion script to handle comma list

In reply to Andi Kleen

From: Andi Kleen <[email protected]>

The perf event completion script only handled a single event per -e option. So for "perf stat -e cycles,branches" branches could not be completed.

Fix that issue by always only using the last suffix for completion.

For some reason it only works in bash currently, but zsh is the same as before.

v2: Handle conflict with upper case completion patch

---
 tools/perf/perf-completion.sh | 4 ++++
 1 file changed, 4 insertions(+)
tools/perf/perf-completion.sh +4 -0
index 3b5a258a4b7b..819a1346689f 100644
@@ -166,7 +166,11 @@ __perf_main ()
 			[[:upper:]]*) evts=$($cmd list --raw-dump json | tr a-z A-Z) ;;
 			*) evts=$($cmd list --raw-dump) ;;
 		esac
+		old="$cur"
+		cur="${cur/*[,{]/}"
+		prefix=${old%$cur}
 		__perfcomp_colon "$evts" "$cur"
+		COMPREPLY=("${prefix}${COMPREPLY[0]}")
 	else
 		# List subcommands for perf commands
 		if [[ $prev_skip_opts == @(kvm|kmem|mem|lock|sched|
Signature · 1 line
2.5.5
#4 lore raw

Re: [PATCH 3/3] perf, tools: Fix completion script to handle comma list

Em Thu, Oct 06, 2016 at 12:23:27PM -0700, Andi Kleen escreveu:

Quoted 10 lines

From: Andi Kleen <[email protected]>

The perf event completion script only handled a single event per -e option. So for "perf stat -e cycles,branches" branches could not be completed.

Fix that issue by always only using the last suffix for completion.

For some reason it only works in bash currently, but zsh is the same as before.

It works partially, for instance, if I try completing:

perf stat -e CPL<TAB>

I get:

perf stat -e CPL_CYCLES.RING0

but if I try:

perf stat -e cycles,CPL<TAB>

I get nothing :-\

Is this working with you?

Quoted 24 lines

v2: Handle conflict with upper case completion patch

---
 tools/perf/perf-completion.sh | 4 ++++
 1 file changed, 4 insertions(+)
tools/perf/perf-completion.sh +4 -0
index 3b5a258a4b7b..819a1346689f 100644
@@ -166,7 +166,11 @@ __perf_main ()
 			[[:upper:]]*) evts=$($cmd list --raw-dump json | tr a-z A-Z) ;;
 			*) evts=$($cmd list --raw-dump) ;;
 		esac
+		old="$cur"
+		cur="${cur/*[,{]/}"
+		prefix=${old%$cur}
 		__perfcomp_colon "$evts" "$cur"
+		COMPREPLY=("${prefix}${COMPREPLY[0]}")
 	else
 		# List subcommands for perf commands
 		if [[ $prev_skip_opts == @(kvm|kmem|mem|lock|sched|
Signature · 1 line
2.5.5
#5 lore raw

Re: [PATCH 3/3] perf, tools: Fix completion script to handle comma list

Quoted 9 lines

perf stat -e CPL_CYCLES.RING0

but if I try:

perf stat -e cycles,CPL<TAB>

I get nothing :-\

Is this working with you?

You can't mix cases like this, the upper case patch doesn't support that. It's either all upper or all lower case.

If you continue with lower case it should work.

-Andi

#6 lore raw

Re: [PATCH 3/3] perf, tools: Fix completion script to handle comma list

Em Thu, Oct 06, 2016 at 01:08:39PM -0700, Andi Kleen escreveu:

Quoted 6 lines
Quoted 6 lines

perf stat -e CPL_CYCLES.RING0

but if I try:

perf stat -e cycles,CPL<TAB>

Quoted 8 lines
Quoted 3 lines

I get nothing :-\

Is this working with you?

You can't mix cases like this, the upper case patch doesn't support that. It's either all upper or all lower case.

If you continue with lower case it should work.

I understand that this should be a limitation of the current patch, but if we decide to support completion after a comma, I think people will expect that all events will be available :-\

- Arnaldo

#7 lore raw

Re: [PATCH 3/3] perf, tools: Fix completion script to handle comma list

Quoted 11 lines · Arnaldo Carvalho de Melo

Em Thu, Oct 06, 2016 at 01:08:39PM -0700, Andi Kleen escreveu:

Quoted 10 lines
Quoted 9 lines

perf stat -e CPL_CYCLES.RING0

but if I try:

perf stat -e cycles,CPL<TAB>

I get nothing :-\

Is this working with you?

Quoted 8 lines
Quoted 4 lines

You can't mix cases like this, the upper case patch doesn't support that. It's either all upper or all lower case.

If you continue with lower case it should work.

I understand that this should be a limitation of the current patch, but if we decide to support completion after a comma, I think people will expect that all events will be available :-\

I don't see a simple way to do it. I'm not gonna write a complex parser in shell.

If that really is a requirement the patch has to be withdrawn.

-Andi

maintainer Applied
#8 lore raw
In reply to Andi Kleen

Em Thu, Oct 06, 2016 at 12:23:25PM -0700, Andi Kleen escreveu:

Quoted 5 lines

From: Andi Kleen <[email protected]>

Add an argument to perf list to only list json events. To be used for the command line completion script. This requires adding a new flag to the alias structure.

Thanks, applied.

Quoted 161 lines
---
 tools/perf/Documentation/perf-list.txt |  2 +-
 tools/perf/builtin-list.c              |  9 ++++++---
 tools/perf/util/parse-events.c         |  2 +-
 tools/perf/util/pmu.c                  | 14 ++++++++++----
 tools/perf/util/pmu.h                  |  3 ++-
 5 files changed, 20 insertions(+), 10 deletions(-)
tools/perf/Documentation/perf-list.txt +1 -1
index 41857cce5e86..50a35b27a64d 100644
@@ -8,7 +8,7 @@ perf-list - List all symbolic event types
 SYNOPSIS
 --------
 [verse]
-'perf list' [--no-desc] [--long-desc] [hw|sw|cache|tracepoint|pmu|event_glob]
+'perf list' [--no-desc] [--long-desc] [hw|sw|cache|tracepoint|pmu|json|sdt|event_glob]
 
 DESCRIPTION
 -----------
tools/perf/builtin-list.c +6 -3
index ba9322ff858b..b9ccdc7ec733 100644
@@ -32,7 +32,7 @@ int cmd_list(int argc, const char **argv, const char *prefix __maybe_unused)
 		OPT_END()
 	};
 	const char * const list_usage[] = {
-		"perf list [<options>] [hw|sw|cache|tracepoint|pmu|sdt|event_glob]",
+		"perf list [<options>] [hw|sw|cache|tracepoint|pmu|sdt|json|event_glob]",
 		NULL
 	};
 
@@ -69,9 +69,12 @@ int cmd_list(int argc, const char **argv, const char *prefix __maybe_unused)
 			print_hwcache_events(NULL, raw_dump);
 		else if (strcmp(argv[i], "pmu") == 0)
 			print_pmu_events(NULL, raw_dump, !desc_flag,
-						long_desc_flag);
+						long_desc_flag, false);
 		else if (strcmp(argv[i], "sdt") == 0)
 			print_sdt_events(NULL, NULL, raw_dump);
+		else if (strcmp(argv[i], "json") == 0)
+			print_pmu_events(NULL, raw_dump, !desc_flag,
+					long_desc_flag, true);
 		else if ((sep = strchr(argv[i], ':')) != NULL) {
 			int sep_idx;
 
@@ -100,7 +103,7 @@ int cmd_list(int argc, const char **argv, const char *prefix __maybe_unused)
 					    event_symbols_sw, PERF_COUNT_SW_MAX, raw_dump);
 			print_hwcache_events(s, raw_dump);
 			print_pmu_events(s, raw_dump, !desc_flag,
-						long_desc_flag);
+						long_desc_flag, false);
 			print_tracepoint_events(NULL, s, raw_dump);
 			print_sdt_events(NULL, s, raw_dump);
 			free(s);
tools/perf/util/parse-events.c +1 -1
index 4e778eae1510..948ef84e4c6a 100644
@@ -2275,7 +2275,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, long_desc);
+	print_pmu_events(event_glob, name_only, quiet_flag, long_desc, false);
 
 	if (event_glob != NULL)
 		return;
tools/perf/util/pmu.c +10 -4
index b1474dcadfa2..d8d7d4c0319c 100644
@@ -224,7 +224,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 *long_desc,
-				 char *topic)
+				 char *topic, bool json)
 {
 	struct perf_pmu_alias *alias;
 	int ret;
@@ -238,6 +238,7 @@ static int __perf_pmu__new_alias(struct list_head *list, char *dir, char *name,
 	alias->unit[0] = '\0';
 	alias->per_pkg = false;
 	alias->snapshot = false;
+	alias->json = json;
 
 	ret = parse_events_terms(&alias->terms, val);
 	if (ret) {
@@ -278,7 +279,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, NULL, NULL);
+	return __perf_pmu__new_alias(list, dir, name, NULL, buf, NULL, NULL, false);
 }
 
 static inline bool pmu_alias_info_file(char *name)
@@ -537,7 +538,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->long_desc, (char *)pe->topic);
+				(char *)pe->long_desc, (char *)pe->topic,
+				true);
 	}
 
 out:
@@ -1103,7 +1105,7 @@ 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,
-			bool long_desc)
+			bool long_desc, bool json_only)
 {
 	struct perf_pmu *pmu;
 	struct perf_pmu_alias *alias;
@@ -1134,6 +1136,9 @@ void print_pmu_events(const char *event_glob, bool name_only, bool quiet_flag,
 				format_alias(buf, sizeof(buf), pmu, alias);
 			bool is_cpu = !strcmp(pmu->name, "cpu");
 
+			if (json_only && !alias->json)
+				continue;
+
 			if (event_glob != NULL &&
 			    !(strglobmatch(name, event_glob) ||
 			      (!is_cpu && strglobmatch(alias->name,
@@ -1158,6 +1163,7 @@ void print_pmu_events(const char *event_glob, bool name_only, bool quiet_flag,
 			j++;
 		}
 		if (pmu->selectable &&
+		    !json_only &&
 		    (event_glob == NULL || strglobmatch(pmu->name, event_glob))) {
 			char *s;
 			if (asprintf(&s, "%s//", pmu->name) < 0)
tools/perf/util/pmu.h +2 -1
index 25712034c815..19fa2e19dbe9 100644
@@ -49,6 +49,7 @@ struct perf_pmu_alias {
 	double scale;
 	bool per_pkg;
 	bool snapshot;
+	bool json;
 };
 
 struct perf_pmu *perf_pmu__find(const char *name);
@@ -75,7 +76,7 @@ int perf_pmu__format_parse(char *dir, struct list_head *head);
 struct perf_pmu *perf_pmu__scan(struct perf_pmu *pmu);
 
 void print_pmu_events(const char *event_glob, bool name_only, bool quiet,
-		      bool long_desc);
+		      bool long_desc, bool json_only);
 bool pmu_have_event(const char *pname, const char *name);
 
 int perf_pmu__scan_file(struct perf_pmu *pmu, const char *name, const char *fmt,
Signature · 1 line
2.5.5