Skip to contentSkip to conversation

perf test: Skip Intel TPEBS under hypervisor

PATCH In review Ian Rogers 3 participants 6 messages Jan 28, 2025 – Jan 30, 2025 perf events

lore
Share & tools
lore

Ian Rogers

author reviewer
#0 lore raw

PATCH v2 1/1 perf test: Skip Intel TPEBS under hypervisor

Intel TPEBS test skips on non-Intel CPUs. On Intel CPUs under a hypervisor the cache-misses event may not be present. Skip the test under this condition.

Refactor the output code to be placed in a file so that on a signal the file can be dumped. This was necessary to catch the issue above as the failing perf record command would fail without output.

---
v2: Fix lost :R and use :p with record as it is ignored by perf stat.

---
 .../perf/tests/shell/test_stat_intel_tpebs.sh | 36 +++++++++++--------
 1 file changed, 22 insertions(+), 14 deletions(-)
tools/perf/tests/shell/test_stat_intel_tpebs.sh +22 -14
index 695dcb93bb5e..a330ecdb7ba5 100755
@@ -20,31 +20,39 @@ then
   exit 2
 fi
 
+stat_output=$(mktemp /tmp/__perf_stat_tpebs_output.XXXXX)
+
 cleanup() {
+  rm -rf "${stat_output}"
   trap - EXIT TERM INT
 }
 
 trap_cleanup() {
   echo "Unexpected signal in ${FUNCNAME[1]}"
+  cat "${stat_output}"
   cleanup
   exit 1
 }
 trap trap_cleanup EXIT TERM INT
 
-# Use this event for testing because it should exist in all platforms
-event=cache-misses:R
-
-# Hybrid platforms output like "cpu_atom/cache-misses/R", rather than as above
-alt_name=/cache-misses/R
+# Event to be used in tests
+event=cache-misses
 
-# Without this cmd option, default value or zero is returned
-#echo "Testing without --record-tpebs"
-#result=$(perf stat -e "$event" true 2>&1)
-#[[ "$result" =~ $event || "$result" =~ $alt_name ]] || exit 1
+if ! perf record -e "${event}:p" -a -o /dev/null sleep 0.01 > "${stat_output}" 2>&1
+then
+  echo "Missing ${event} support"
+  cleanup
+  exit 2
+fi
 
 test_with_record_tpebs() {
   echo "Testing with --record-tpebs"
-  result=$(perf stat -e "$event" --record-tpebs -a sleep 0.01 2>&1)
+  if ! perf stat -e "${event}:R" --record-tpebs -a sleep 0.01 > "${stat_output}" 2>&1
+  then
+    echo "Testing with --record-tpebs [Failed perf stat]"
+    cat "${stat_output}"
+    exit 1
+  fi
 
   # Expected output:
   # $ perf stat --record-tpebs -e cache-misses:R -a sleep 0.01
@@ -57,16 +65,16 @@ test_with_record_tpebs() {
   #                  0      cache-misses:R
   #
   #        0.013963299 seconds time elapsed
-  if [[ ! "$result" =~ "perf record" ]]
+  if ! grep "perf record" "${stat_output}"
   then
     echo "Testing with --record-tpebs [Failed missing perf record]"
-    echo "$result"
+    cat "${stat_output}"
     exit 1
   fi
-  if [[ ! "$result" =~ $event && ! "$result" =~ $alt_name ]]
+  if ! grep "${event}:R" "${stat_output}" && ! grep "/${event}/R" "${stat_output}"
   then
     echo "Testing with --record-tpebs [Failed missing event name]"
-    echo "$result"
+    cat "${stat_output}"
     exit 1
   fi
   echo "Testing with --record-tpebs [Success]"
Signature · 1 line
2.48.1.262.g85cc9f2d1e-goog
maintainer
#1 lore raw
Quoted 41 lines · Ian Rogers

Intel TPEBS test skips on non-Intel CPUs. On Intel CPUs under a hypervisor the cache-misses event may not be present. Skip the test under this condition.

Refactor the output code to be placed in a file so that on a signal the file can be dumped. This was necessary to catch the issue above as the failing perf record command would fail without output.

---
v2: Fix lost :R and use :p with record as it is ignored by perf stat.

---
 .../perf/tests/shell/test_stat_intel_tpebs.sh | 36 +++++++++++--------
 1 file changed, 22 insertions(+), 14 deletions(-)
tools/perf/tests/shell/test_stat_intel_tpebs.sh +4 -3
index 695dcb93bb5e..a330ecdb7ba5 100755
@@ -20,31 +20,39 @@ then
   exit 2
 fi
 
+stat_output=$(mktemp /tmp/__perf_stat_tpebs_output.XXXXX)
+
 cleanup() {
+  rm -rf "${stat_output}"
   trap - EXIT TERM INT
 }
 
 trap_cleanup() {
   echo "Unexpected signal in ${FUNCNAME[1]}"
+  cat "${stat_output}"
   cleanup
   exit 1
 }
 trap trap_cleanup EXIT TERM INT
 
-# Use this event for testing because it should exist in all platforms
-event=cache-misses:R
-

tools/perf/tests/shell/test_stat_intel_tpebs.sh then · line 41

Quoted 10 lines
tools/perf/tests/shell/test_stat_intel_tpebs.sh +3 -6
-# Hybrid platforms output like "cpu_atom/cache-misses/R", rather than as above
-alt_name=/cache-misses/R
+# Event to be used in tests
+event=cache-misses
 
-# Without this cmd option, default value or zero is returned
-#echo "Testing without --record-tpebs"
-#result=$(perf stat -e "$event" true 2>&1)
-#[[ "$result" =~ $event || "$result" =~ $alt_name ]] || exit 1
+if ! perf record -e "${event}:p" -a -o /dev/null sleep 0.01 > "${stat_output}" 2>&1

Shouldn't it simply be

if ! perf list hw | grep -q cache-misses

? Doesn't it work on hybrid?

Thanks,
Namhyung

Quoted 42 lines
tools/perf/tests/shell/test_stat_intel_tpebs.sh +15 -5
+then
+  echo "Missing ${event} support"
+  cleanup
+  exit 2
+fi
 
 test_with_record_tpebs() {
   echo "Testing with --record-tpebs"
-  result=$(perf stat -e "$event" --record-tpebs -a sleep 0.01 2>&1)
+  if ! perf stat -e "${event}:R" --record-tpebs -a sleep 0.01 > "${stat_output}" 2>&1
+  then
+    echo "Testing with --record-tpebs [Failed perf stat]"
+    cat "${stat_output}"
+    exit 1
+  fi
 
   # Expected output:
   # $ perf stat --record-tpebs -e cache-misses:R -a sleep 0.01
@@ -57,16 +65,16 @@ test_with_record_tpebs() {
   #                  0      cache-misses:R
   #
   #        0.013963299 seconds time elapsed
-  if [[ ! "$result" =~ "perf record" ]]
+  if ! grep "perf record" "${stat_output}"
   then
     echo "Testing with --record-tpebs [Failed missing perf record]"
-    echo "$result"
+    cat "${stat_output}"
     exit 1
   fi
-  if [[ ! "$result" =~ $event && ! "$result" =~ $alt_name ]]
+  if ! grep "${event}:R" "${stat_output}" && ! grep "/${event}/R" "${stat_output}"
   then
     echo "Testing with --record-tpebs [Failed missing event name]"
-    echo "$result"
+    cat "${stat_output}"
     exit 1
   fi
   echo "Testing with --record-tpebs [Success]"
Signature · 1 line
2.48.1.262.g85cc9f2d1e-goog
author reviewer
#2 lore raw
Quoted 56 lines · Namhyung Kim
Quoted 41 lines · Ian Rogers

Intel TPEBS test skips on non-Intel CPUs. On Intel CPUs under a hypervisor the cache-misses event may not be present. Skip the test under this condition.

Refactor the output code to be placed in a file so that on a signal the file can be dumped. This was necessary to catch the issue above as the failing perf record command would fail without output.

---
v2: Fix lost :R and use :p with record as it is ignored by perf stat.

---
 .../perf/tests/shell/test_stat_intel_tpebs.sh | 36 +++++++++++--------
 1 file changed, 22 insertions(+), 14 deletions(-)
tools/perf/tests/shell/test_stat_intel_tpebs.sh +4 -3
index 695dcb93bb5e..a330ecdb7ba5 100755
@@ -20,31 +20,39 @@ then
   exit 2
 fi
 
+stat_output=$(mktemp /tmp/__perf_stat_tpebs_output.XXXXX)
+
 cleanup() {
+  rm -rf "${stat_output}"
   trap - EXIT TERM INT
 }
 
 trap_cleanup() {
   echo "Unexpected signal in ${FUNCNAME[1]}"
+  cat "${stat_output}"
   cleanup
   exit 1
 }
 trap trap_cleanup EXIT TERM INT
 
-# Use this event for testing because it should exist in all platforms
-event=cache-misses:R
-

tools/perf/tests/shell/test_stat_intel_tpebs.sh then · line 41

Quoted 10 lines
tools/perf/tests/shell/test_stat_intel_tpebs.sh +3 -6
-# Hybrid platforms output like "cpu_atom/cache-misses/R", rather than as above
-alt_name=/cache-misses/R
+# Event to be used in tests
+event=cache-misses
 
-# Without this cmd option, default value or zero is returned
-#echo "Testing without --record-tpebs"
-#result=$(perf stat -e "$event" true 2>&1)
-#[[ "$result" =~ $event || "$result" =~ $alt_name ]] || exit 1
+if ! perf record -e "${event}:p" -a -o /dev/null sleep 0.01 > "${stat_output}" 2>&1

Shouldn't it simply be

Quoted 1 line

if ! perf list hw | grep -q cache-misses

No, because that would succeed even if precise events weren't supported.

Quoted 1 line

? Doesn't it work on hybrid?

Untested, but I don't see a difference between grepping an event from a file to using a match in a bash line. Neither specify a PMU so it is unclear to me why you'd think this would break.

Thanks,
Ian

maintainer
#3 lore raw
Quoted 57 lines · Ian Rogers
Quoted 56 lines · Namhyung Kim
Quoted 41 lines · Ian Rogers

Intel TPEBS test skips on non-Intel CPUs. On Intel CPUs under a hypervisor the cache-misses event may not be present. Skip the test under this condition.

Refactor the output code to be placed in a file so that on a signal the file can be dumped. This was necessary to catch the issue above as the failing perf record command would fail without output.

---
v2: Fix lost :R and use :p with record as it is ignored by perf stat.

---
 .../perf/tests/shell/test_stat_intel_tpebs.sh | 36 +++++++++++--------
 1 file changed, 22 insertions(+), 14 deletions(-)
tools/perf/tests/shell/test_stat_intel_tpebs.sh +4 -3
index 695dcb93bb5e..a330ecdb7ba5 100755
@@ -20,31 +20,39 @@ then
   exit 2
 fi
 
+stat_output=$(mktemp /tmp/__perf_stat_tpebs_output.XXXXX)
+
 cleanup() {
+  rm -rf "${stat_output}"
   trap - EXIT TERM INT
 }
 
 trap_cleanup() {
   echo "Unexpected signal in ${FUNCNAME[1]}"
+  cat "${stat_output}"
   cleanup
   exit 1
 }
 trap trap_cleanup EXIT TERM INT
 
-# Use this event for testing because it should exist in all platforms
-event=cache-misses:R
-

tools/perf/tests/shell/test_stat_intel_tpebs.sh then · line 41

Quoted 10 lines
tools/perf/tests/shell/test_stat_intel_tpebs.sh +3 -6
-# Hybrid platforms output like "cpu_atom/cache-misses/R", rather than as above
-alt_name=/cache-misses/R
+# Event to be used in tests
+event=cache-misses
 
-# Without this cmd option, default value or zero is returned
-#echo "Testing without --record-tpebs"
-#result=$(perf stat -e "$event" true 2>&1)
-#[[ "$result" =~ $event || "$result" =~ $alt_name ]] || exit 1
+if ! perf record -e "${event}:p" -a -o /dev/null sleep 0.01 > "${stat_output}" 2>&1

Shouldn't it simply be

Quoted 3 lines
Quoted 1 line

if ! perf list hw | grep -q cache-misses

No, because that would succeed even if precise events weren't supported.

Oh I see.

Quoted 6 lines
Quoted 2 lines

? Doesn't it work on hybrid?

Untested, but I don't see a difference between grepping an event from a file to using a match in a bash line. Neither specify a PMU so it is unclear to me why you'd think this would break.

No specific reason. I thought checking perf list would be more intuitive and then started to think there should be a reason.

Thanks,
Namhyung

#4 lore raw
In reply to Ian Rogers
Quoted 10 lines · Ian Rogers

Intel TPEBS test skips on non-Intel CPUs. On Intel CPUs under a hypervisor the cache-misses event may not be present. Skip the test under this condition.

Refactor the output code to be placed in a file so that on a signal the file can be dumped. This was necessary to catch the issue above as
the failing perf record command would fail without output.

Hi, sorry, but I'm unable to apply this patch to perf-tools or perf- tools-next? What repository should I use to test this?

Thanks,
Tom

Quoted 88 lines

---
v2: Fix lost :R and use :p with record as it is ignored by perf stat.
---
 .../perf/tests/shell/test_stat_intel_tpebs.sh | 36 +++++++++++------ --

 1 file changed, 22 insertions(+), 14 deletions(-)
tools/perf/tests/shell/test_stat_intel_tpebs.sh +0 -0
index 695dcb93bb5e..a330ecdb7ba5 100755
@@ -20,31 +20,39 @@ then

   exit 2
 fi

tools/perf/tests/shell/test_stat_intel_tpebs.sh +2 -0
+stat_output=$(mktemp /tmp/__perf_stat_tpebs_output.XXXXX)
+

 cleanup() {
+  rm -rf "${stat_output}"
   trap - EXIT TERM INT
 }

 trap_cleanup() {
   echo "Unexpected signal in ${FUNCNAME[1]}"
+  cat "${stat_output}"
   cleanup
   exit 1
 }
 trap trap_cleanup EXIT TERM INT

-# Use this event for testing because it should exist in all platforms

tools/perf/tests/shell/test_stat_intel_tpebs.sh +0 -3
-event=cache-misses:R
-
-# Hybrid platforms output like "cpu_atom/cache-misses/R", rather

than as above

tools/perf/tests/shell/test_stat_intel_tpebs.sh +2 -1
-alt_name=/cache-misses/R
+# Event to be used in tests
+event=cache-misses

tools/perf/tests/shell/test_stat_intel_tpebs.sh +1 -4
-# Without this cmd option, default value or zero is returned
-#echo "Testing without --record-tpebs"
-#result=$(perf stat -e "$event" true 2>&1)
-#[[ "$result" =~ $event || "$result" =~ $alt_name ]] || exit 1
+if ! perf record -e "${event}:p" -a -o /dev/null sleep 0.01 >

"${stat_output}" 2>&1

tools/perf/tests/shell/test_stat_intel_tpebs.sh +5 -0
+then
+  echo "Missing ${event} support"
+  cleanup
+  exit 2
+fi


 test_with_record_tpebs() {
   echo "Testing with --record-tpebs"
-  result=$(perf stat -e "$event" --record-tpebs -a sleep 0.01 2>&1) +  if ! perf stat -e "${event}:R" --record-tpebs -a sleep 0.01 > "${stat_output}" 2>&1
+  then
+    echo "Testing with --record-tpebs [Failed perf stat]" +    cat "${stat_output}"
+    exit 1
+  fi

   # Expected output:
   # $ perf stat --record-tpebs -e cache-misses:R -a sleep 0.01

tools/perf/tests/shell/test_stat_intel_tpebs.sh +1 -1
@@ -57,16 +65,16 @@ test_with_record_tpebs() {
    #                  0      cache-misses:R
    #
    #        0.013963299 seconds time elapsed
-  if [[ ! "$result" =~ "perf record" ]]
+  if ! grep "perf record" "${stat_output}"

   then
     echo "Testing with --record-tpebs [Failed missing perf record]" -    echo "$result"
+    cat "${stat_output}"
     exit 1
   fi
-  if [[ ! "$result" =~ $event && ! "$result" =~ $alt_name ]] +  if ! grep "${event}:R" "${stat_output}" && ! grep "/${event}/R" "${stat_output}"
   then
     echo "Testing with --record-tpebs [Failed missing event name]" -    echo "$result"
+    cat "${stat_output}"
     exit 1
   fi
   echo "Testing with --record-tpebs [Success]"

author reviewer
#5 lore raw
Quoted 11 lines · Thomas
Quoted 9 lines · Ian Rogers

Intel TPEBS test skips on non-Intel CPUs. On Intel CPUs under a hypervisor the cache-misses event may not be present. Skip the test under this condition.

Refactor the output code to be placed in a file so that on a signal the file can be dumped. This was necessary to catch the issue above as
the failing perf record command would fail without output.

Quoted 4 lines
Quoted 1 line

Hi, sorry, but I'm unable to apply this patch to perf-tools or perf- tools-next? What repository should I use to test this?

Hi Tom,

sorry for this. I'll rebase/squash Google's patches [1] for this test and resend as v2. I hadn't realized how much was missing when sending this.

Thanks,
Ian

[1] https://github.com/googleprodkernel/linux-perf/commits/google_tools_master/tools/perf/tests/shell/test_stat_intel_tpebs.sh

Quoted 92 lines

Thanks,
Tom

Quoted 88 lines

---
v2: Fix lost :R and use :p with record as it is ignored by perf stat.

---
 .../perf/tests/shell/test_stat_intel_tpebs.sh | 36 +++++++++++------
--
 1 file changed, 22 insertions(+), 14 deletions(-)
tools/perf/tests/shell/test_stat_intel_tpebs.sh +4 -1
index 695dcb93bb5e..a330ecdb7ba5 100755
@@ -20,31 +20,39 @@ then
   exit 2
 fi
 
+stat_output=$(mktemp /tmp/__perf_stat_tpebs_output.XXXXX)
+
 cleanup() {
+  rm -rf "${stat_output}"
   trap - EXIT TERM INT
 }
 
 trap_cleanup() {
   echo "Unexpected signal in ${FUNCNAME[1]}"
+  cat "${stat_output}"
   cleanup
   exit 1
 }
 trap trap_cleanup EXIT TERM INT
 
-# Use this event for testing because it should exist in all

platforms

tools/perf/tests/shell/test_stat_intel_tpebs.sh +0 -3
-event=cache-misses:R
-
-# Hybrid platforms output like "cpu_atom/cache-misses/R", rather

than as above

tools/perf/tests/shell/test_stat_intel_tpebs.sh +3 -5
-alt_name=/cache-misses/R
+# Event to be used in tests
+event=cache-misses
 
-# Without this cmd option, default value or zero is returned
-#echo "Testing without --record-tpebs"
-#result=$(perf stat -e "$event" true 2>&1)
-#[[ "$result" =~ $event || "$result" =~ $alt_name ]] || exit 1
+if ! perf record -e "${event}:p" -a -o /dev/null sleep 0.01 >

"${stat_output}" 2>&1

tools/perf/tests/shell/test_stat_intel_tpebs.sh +6 -1
+then
+  echo "Missing ${event} support"
+  cleanup
+  exit 2
+fi
 
 test_with_record_tpebs() {
   echo "Testing with --record-tpebs"
-  result=$(perf stat -e "$event" --record-tpebs -a sleep 0.01 2>&1)
+  if ! perf stat -e "${event}:R" --record-tpebs -a sleep 0.01 >

"${stat_output}" 2>&1

tools/perf/tests/shell/test_stat_intel_tpebs.sh +8 -3
+  then
+    echo "Testing with --record-tpebs [Failed perf stat]"
+    cat "${stat_output}"
+    exit 1
+  fi
 
   # Expected output:
   # $ perf stat --record-tpebs -e cache-misses:R -a sleep 0.01
@@ -57,16 +65,16 @@ test_with_record_tpebs() {
   #                  0      cache-misses:R
   #
   #        0.013963299 seconds time elapsed
-  if [[ ! "$result" =~ "perf record" ]]
+  if ! grep "perf record" "${stat_output}"
   then
     echo "Testing with --record-tpebs [Failed missing perf record]"
-    echo "$result"
+    cat "${stat_output}"
     exit 1
   fi
-  if [[ ! "$result" =~ $event && ! "$result" =~ $alt_name ]]
+  if ! grep "${event}:R" "${stat_output}" && ! grep "/${event}/R"

"${stat_output}"
then
echo "Testing with --record-tpebs [Failed missing event name]"

tools/perf/tests/shell/test_stat_intel_tpebs.sh +1 -1
-    echo "$result"
+    cat "${stat_output}"
     exit 1
   fi
   echo "Testing with --record-tpebs [Success]"