Skip to contentSkip to conversation

perf evlist: Print hint for group

PATCH Applied [email protected] 3 participants 3 messages Sep 8, 2024 – Sep 11, 2024 perf events

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 perf evlist: Print hint for group

From: Kan Liang <[email protected]>

An event group is a critical relationship. There is a -g option that can display the relationship. But it's hard for a user to know when should this option be applied.

If there is an event group in the perf record, print a hint to suggest the user apply the -g to display the group information.

With the patch,

$perf record -e "{cycles,instructions},instructions" sleep 1 [ perf record: Woken up 1 times to write data ]
[ perf record: Captured and wrote 0.024 MB perf.data (4 samples) ]

$perf evlist
cycles
instructions
instructions
# Tip: use 'perf evlist -g' to show group information

$perf evlist -g
{cycles,instructions}
instructions

---
 tools/perf/builtin-evlist.c | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)
tools/perf/builtin-evlist.c +7 -1
index 818ab21c3f73..a9bd7bbef5a9 100644
@@ -36,7 +36,7 @@ static int __cmd_evlist(const char *file_name, struct perf_attr_details *details
 		.force     = details->force,
 	};
 	struct perf_tool tool;
-	bool has_tracepoint = false;
+	bool has_tracepoint = false, has_group = false;
 
 	perf_tool__init(&tool, /*ordered_events=*/false);
 	/* only needed for pipe mode */
@@ -54,11 +54,17 @@ static int __cmd_evlist(const char *file_name, struct perf_attr_details *details
 
 		if (pos->core.attr.type == PERF_TYPE_TRACEPOINT)
 			has_tracepoint = true;
+
+		if (!evsel__is_group_leader(pos))
+			has_group = true;
 	}
 
 	if (has_tracepoint && !details->trace_fields)
 		printf("# Tip: use 'perf evlist --trace-fields' to show fields for tracepoint events\n");
 
+	if (has_group && !details->event_group)
+		printf("# Tip: use 'perf evlist -g' to show group information\n");
+
 	perf_session__delete(session);
 	return 0;
 }
Signature · 1 line
2.38.1
reviewer Reviewed-by on v1 1/1
#1 lore raw
Quoted 22 lines · On Sun, Sep 8, 2024 at 1:28 PM <[email protected]> wrote:

From: Kan Liang <[email protected]>

An event group is a critical relationship. There is a -g option that can display the relationship. But it's hard for a user to know when should this option be applied.

If there is an event group in the perf record, print a hint to suggest the user apply the -g to display the group information.

With the patch,

$perf record -e "{cycles,instructions},instructions" sleep 1 [ perf record: Woken up 1 times to write data ]
[ perf record: Captured and wrote 0.024 MB perf.data (4 samples) ]

$perf evlist
cycles
instructions
instructions
# Tip: use 'perf evlist -g' to show group information

Quoted 7 lines

$perf evlist -g
{cycles,instructions}
instructions

Thanks,
Ian

Quoted 38 lines
---
 tools/perf/builtin-evlist.c | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)
tools/perf/builtin-evlist.c +7 -2
index 818ab21c3f73..a9bd7bbef5a9 100644
@@ -36,7 +36,7 @@ static int __cmd_evlist(const char *file_name, struct perf_attr_details *details
                .force     = details->force,
        };
        struct perf_tool tool;
-       bool has_tracepoint = false;
+       bool has_tracepoint = false, has_group = false;
 
        perf_tool__init(&tool, /*ordered_events=*/false);
        /* only needed for pipe mode */
@@ -54,11 +54,17 @@ static int __cmd_evlist(const char *file_name, struct perf_attr_details *details
 
                if (pos->core.attr.type == PERF_TYPE_TRACEPOINT)
                        has_tracepoint = true;
+
+               if (!evsel__is_group_leader(pos))
+                       has_group = true;
        }
 
        if (has_tracepoint && !details->trace_fields)
                printf("# Tip: use 'perf evlist --trace-fields' to show fields for tracepoint events\n");
 
+       if (has_group && !details->event_group)
+               printf("# Tip: use 'perf evlist -g' to show group information\n");
+
        perf_session__delete(session);
        return 0;
 }
--

2.38.1

maintainer Reviewed-by Ian Rogers Tested-by Applied
#2 lore raw
Quoted 27 lines · Ian Rogers
Quoted 26 lines · On Sun, Sep 8, 2024 at 1:28 PM <[email protected]> wrote:

From: Kan Liang <[email protected]>

An event group is a critical relationship. There is a -g option that can display the relationship. But it's hard for a user to know when should this option be applied.

If there is an event group in the perf record, print a hint to suggest the user apply the -g to display the group information.

With the patch,

$perf record -e "{cycles,instructions},instructions" sleep 1 [ perf record: Woken up 1 times to write data ]
[ perf record: Captured and wrote 0.024 MB perf.data (4 samples) ]

$perf evlist
cycles
instructions
instructions
# Tip: use 'perf evlist -g' to show group information

$perf evlist -g
{cycles,instructions}
instructions

Quoted 5 lines
Quoted 3 lines

Thanks, tested:

Committer testing:

So for a perf.data file _with_ a group:

root@number:~# perf evlist -g {cpu_core/branch-instructions/pp,cpu_core/branches/} dummy:u
root@number:~# perf evlist cpu_core/branch-instructions/pp cpu_core/branches/
dummy:u
# Tip: use 'perf evlist -g' to show group information root@number:~#

Then for something _without_ a group, no hint:

root@number:~# perf record ls
<SNIP>
[ perf record: Woken up 1 times to write data ]
[ perf record: Captured and wrote 0.035 MB perf.data (7 samples) ] root@number:~# perf evlist
cpu_atom/cycles/P
cpu_core/cycles/P
dummy:u
root@number:~#

No suggestion, good.

Applied.

- Arnaldo