Skip to contentSkip to conversation

perf stat: Clear reset_group for each stat run

PATCH In review Ian Rogers 4 participants 7 messages Aug 22, 2022 – Aug 23, 2022 perf events

lore
Share & tools
lore

Ian Rogers

author reviewer
#0 lore raw

PATCH 1/2 perf stat: Clear reset_group for each stat run

If a weak group is broken then the reset_group flag remains set for the next run. Having reset_group set means the counter isn't created and ultimately a segfault.

A simple reproduction of this is:
perf stat -r2 -e '{cycles,cycles,cycles,cycles,cycles,cycles,cycles,cycles,cycles,cycles}:W which will be added as a test in the next patch.

Fixes 4804e0111662 ("perf stat: Use affinity for opening events")
---
 tools/perf/builtin-stat.c | 1 +
 1 file changed, 1 insertion(+)
tools/perf/builtin-stat.c +1 -0
index 7fb81a44672d..54cd29d07ca8 100644
@@ -826,6 +826,7 @@ static int __run_perf_stat(int argc, const char **argv, int run_idx)
 	}
 
 	evlist__for_each_entry(evsel_list, counter) {
+		counter->reset_group = false;
 		if (bpf_counter__load(counter, &target))
 			return -1;
 		if (!evsel__is_bpf(counter))
Signature · 1 line
2.37.2.609.g9ff673ca1a-goog
author reviewer
#1 lore raw

PATCH 2/2 perf test: Stat test for repeat with a weak group

Breaking a weak group requires multiple passes of an evlist, with multiple runs this can introduce bugs ultimately leading to segfaults. Add a test to cover this.

---
 tools/perf/tests/shell/stat.sh | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)
tools/perf/tests/shell/stat.sh +19 -0
index 9313ef2739e0..26a51b48aee4 100755
@@ -28,6 +28,24 @@ test_stat_record_report() {
   echo "stat record and report test [Success]"
 }
 
+test_stat_repeat_weak_groups() {
+  echo "stat repeat weak groups test"
+  if ! perf stat -e '{cycles,cycles,cycles,cycles,cycles,cycles,cycles,cycles,cycles,cycles}' \
+     true 2>&1 | grep -q 'seconds time elapsed'
+  then
+    echo "stat repeat weak groups test [Skipped event parsing failed]"
+    return
+  fi
+  if ! perf stat -r2 -e '{cycles,cycles,cycles,cycles,cycles,cycles,cycles,cycles,cycles,cycles}:W' \
+    true > /dev/null 2>&1
+  then
+    echo "stat repeat weak groups test [Failed]"
+    err=1
+    return
+  fi
+  echo "stat repeat weak groups test [Success]"
+}
+
 test_topdown_groups() {
   # Topdown events must be grouped with the slots event first. Test that
   # parse-events reorders this.
@@ -75,6 +93,7 @@ test_topdown_weak_groups() {
 
 test_default_stat
 test_stat_record_report
+test_stat_repeat_weak_groups
 test_topdown_groups
 test_topdown_weak_groups
 exit $err
Signature · 1 line
2.37.2.609.g9ff673ca1a-goog
Tested-by on v1 1/2
#2 lore raw
In reply to Ian Rogers
Quoted 6 lines · Ian Rogers

If a weak group is broken then the reset_group flag remains set for the next run. Having reset_group set means the counter isn't created and ultimately a segfault.

A simple reproduction of this is:
perf stat -r2 -e '{cycles,cycles,cycles,cycles,cycles,cycles,cycles,cycles,cycles,cycles}:W

It is better to change to a full command:
perf stat -r2 -e '{cycles,cycles,cycles,cycles,cycles,cycles,cycles,cycles,cycles,cycles}:W' true

Quoted 4 lines

which will be added as a test in the next patch.

Fixes 4804e0111662 ("perf stat: Use affinity for opening events")

I test the two patches on both non-hybrid and hybrid machines, and the "Segmentation fault" disappeared.

Quoted 16 lines
---
  tools/perf/builtin-stat.c | 1 +
  1 file changed, 1 insertion(+)
tools/perf/builtin-stat.c +1 -0
index 7fb81a44672d..54cd29d07ca8 100644
@@ -826,6 +826,7 @@ static int __run_perf_stat(int argc, const char **argv, int run_idx)
  	}
 
  	evlist__for_each_entry(evsel_list, counter) {
+		counter->reset_group = false;
  		if (bpf_counter__load(counter, &target))
  			return -1;
  		if (!evsel__is_bpf(counter))
Signature · 1 line
Zhengjun Xing
#3 lore raw
In reply to Ian Rogers

Em Mon, Aug 22, 2022 at 02:33:51PM -0700, Ian Rogers escreveu:

Quoted 7 lines

If a weak group is broken then the reset_group flag remains set for the next run. Having reset_group set means the counter isn't created and ultimately a segfault.

A simple reproduction of this is:
perf stat -r2 -e '{cycles,cycles,cycles,cycles,cycles,cycles,cycles,cycles,cycles,cycles}:W which will be added as a test in the next patch.

So doing this on that existing BPF related loop may solve the problem, but for someone looking just at the source code, without any comment, may be cryptic, no?

And then the fixes tags talks about affinity, adding a bit more confusion, albeit being the part that does the weak logic :-\

Can we have a comment just before:

+ counter->reset_group = false;

Stating that this is needed only when using -r?

- Arnaldo

Quoted 20 lines
Fixes 4804e0111662 ("perf stat: Use affinity for opening events")
---
 tools/perf/builtin-stat.c | 1 +
 1 file changed, 1 insertion(+)
tools/perf/builtin-stat.c +1 -0
index 7fb81a44672d..54cd29d07ca8 100644
@@ -826,6 +826,7 @@ static int __run_perf_stat(int argc, const char **argv, int run_idx)
 	}
 
 	evlist__for_each_entry(evsel_list, counter) {
+		counter->reset_group = false;
 		if (bpf_counter__load(counter, &target))
 			return -1;
 		if (!evsel__is_bpf(counter))
Signature · 1 line
2.37.2.609.g9ff673ca1a-goog
Signature · 1 line
- Arnaldo
author reviewer
#4 lore raw
Quoted 14 lines · Arnaldo Carvalho de Melo

Em Mon, Aug 22, 2022 at 02:33:51PM -0700, Ian Rogers escreveu:

Quoted 7 lines

If a weak group is broken then the reset_group flag remains set for the next run. Having reset_group set means the counter isn't created and ultimately a segfault.

A simple reproduction of this is:
perf stat -r2 -e '{cycles,cycles,cycles,cycles,cycles,cycles,cycles,cycles,cycles,cycles}:W which will be added as a test in the next patch.

So doing this on that existing BPF related loop may solve the problem, but for someone looking just at the source code, without any comment, may be cryptic, no?

Quoted 8 lines

And then the fixes tags talks about affinity, adding a bit more confusion, albeit being the part that does the weak logic :-\

Can we have a comment just before:

+ counter->reset_group = false;

Stating that this is needed only when using -r?

It is possible to add a comment but thinking about it, it would have said pretty much what the code was doing and so I skipped it. I'm wary of comments that capture too much of the implementation as they are prone to becoming stale. Logically this function is just iterating over the evlist creating counters, but on top of that we have the affinity optimization. The BPF code didn't need that and so has its own evlist iteration. We could add another loop just to clear reset_group, that didn't seem to make sense. It's unfortunate how that relates to the fixes tag but I don't think we should optimize for that case.

Thanks,
Ian

Quoted 26 lines

- Arnaldo

Quoted 19 lines
Fixes 4804e0111662 ("perf stat: Use affinity for opening events")
---
 tools/perf/builtin-stat.c | 1 +
 1 file changed, 1 insertion(+)
tools/perf/builtin-stat.c +1 -1
index 7fb81a44672d..54cd29d07ca8 100644
@@ -826,6 +826,7 @@ static int __run_perf_stat(int argc, const char **argv, int run_idx)
      }
 
      evlist__for_each_entry(evsel_list, counter) {
+             counter->reset_group = false;
              if (bpf_counter__load(counter, &target))
                      return -1;
              if (!evsel__is_bpf(counter))
--
Quoted 1 line

2.37.2.609.g9ff673ca1a-goog

--

- Arnaldo

Reviewed-by on v1 1/2
#5 lore raw
In reply to Ian Rogers
Quoted 10 lines · Ian Rogers

If a weak group is broken then the reset_group flag remains set for the next run. Having reset_group set means the counter isn't created and ultimately a segfault.

A simple reproduction of this is:
perf stat -r2 -e '{cycles,cycles,cycles,cycles,cycles,cycles,cycles,cycles,cycles,cycles}:W which will be added as a test in the next patch.

Fixes 4804e0111662 ("perf stat: Use affinity for opening events")

Makes sense

#6 lore raw

Em Tue, Aug 23, 2022 at 05:10:55PM +0200, Andi Kleen escreveu:

Quoted 10 lines · Ian Rogers
Quoted 8 lines

If a weak group is broken then the reset_group flag remains set for the next run. Having reset_group set means the counter isn't created and ultimately a segfault.

A simple reproduction of this is:
perf stat -r2 -e '{cycles,cycles,cycles,cycles,cycles,cycles,cycles,cycles,cycles,cycles}:W which will be added as a test in the next patch.

Quoted 8 lines
Quoted 2 lines
Fixes 4804e0111662 ("perf stat: Use affinity for opening events")

Makes sense

Ok, applied.

- Arnaldo