[Patch v9 09/10] perf tests: Add x86 eGPRs/SSP registers sampling test

[Dapeng Mi]

Validate that eGPRs (extended general purpose registers) and SSP
(shadow stack pointer) registers can be sampled correctly on x86
platforms with hardware support.

Signed-off-by: Dapeng Mi <dapeng1.mi@xxxxxxxxxxxxxxx>
---
 tools/perf/tests/shell/record.sh | 126 +++++++++++++++++++++++++++++++
 1 file changed, 126 insertions(+)

diff --git a/tools/perf/tests/shell/record.sh b/tools/perf/tests/shell/record.sh
index dd90fef2088b..48c722e563e2 100755
--- a/tools/perf/tests/shell/record.sh
+++ b/tools/perf/tests/shell/record.sh
@@ -131,6 +131,131 @@ check_system_wide() {
   perf report -i "${perfdata}" -q | grep -q "${testsym}"
 }
 
+has_required_regs() {
+  local regs_output="$1"
+  shift
+
+  for reg in "$@"
+  do
+    if ! echo "${regs_output}" | grep -q -i "${reg}"
+    then
+      return 1
+    fi
+  done
+
+  return 0
+}
+
+validate_gp_reg_sampling() {
+  local regs_opt="$1"
+  local regs_value="$2"
+  local script_field="$3"
+  local sample_output
+  shift 3
+
+  if ! sample_output=$(perf record -o - "${regs_opt}=${regs_value}" \
+    -e br_inst_retired.near_call -c 1000 --per-thread ${testprog} 2> /dev/null \
+    | perf script -F ip,sym,"${script_field}" -i - 2> /dev/null)
+  then
+    return 1
+  fi
+
+  if ! has_required_regs "${sample_output}" "$@"
+  then
+    return 1
+  fi
+
+  return 0
+}
+
+test_egpr_register_capture() {
+  local arch
+  local intr_regs
+  local user_regs
+  local tested=0
+
+  echo "eGPR/SSP register capture test"
+
+  arch=$(uname -m)
+  case ${arch} in
+  x86_64|i386)
+    ;;
+  *)
+    echo "eGPR/SSP register capture test [Skipped non-x86 platform]"
+    return
+    ;;
+  esac
+
+  if ! perf list pmu | grep -q 'br_inst_retired.near_call'
+  then
+    echo "eGPR/SSP register capture test [Skipped missing event]"
+    return
+  fi
+
+  intr_regs=$(perf record --intr-regs=\? 2>&1 || true)
+  user_regs=$(perf record --user-regs=\? 2>&1 || true)
+
+  if has_required_regs "${intr_regs}" R16 R31
+  then
+    if ! validate_gp_reg_sampling "--intr-regs" "r16,r31" "iregs" "R16:" "R31:"
+    then
+      echo "eGPR/SSP register capture test [Failed eGPR intr-regs validation]"
+      err=1
+      return
+    fi
+    tested=1
+  else
+    echo "eGPR/SSP register capture test [Skipped missing eGPR intr-regs (R16/R31)]"
+  fi
+
+  if has_required_regs "${user_regs}" R16 R31
+  then
+    if ! validate_gp_reg_sampling "--user-regs" "r16,r31" "uregs" "R16:" "R31:"
+    then
+      echo "eGPR/SSP register capture test [Failed eGPR user-regs validation]"
+      err=1
+      return
+    fi
+    tested=1
+  else
+    echo "eGPR/SSP register capture test [Skipped missing eGPR user-regs (R16/R31)]"
+  fi
+
+  if has_required_regs "${intr_regs}" SSP
+  then
+    if ! validate_gp_reg_sampling "--intr-regs" "ssp" "iregs" "SSP:"
+    then
+      echo "eGPR/SSP register capture test [Failed SSP intr-regs validation]"
+      err=1
+      return
+    fi
+    tested=1
+  else
+    echo "eGPR/SSP register capture test [Skipped missing SSP intr-regs]"
+  fi
+
+  if has_required_regs "${user_regs}" SSP
+  then
+    if ! validate_gp_reg_sampling "--user-regs" "ssp" "uregs" "SSP:"
+    then
+      echo "eGPR/SSP register capture test [Failed SSP user-regs validation]"
+      err=1
+      return
+    fi
+    tested=1
+  else
+    echo "eGPR/SSP register capture test [Skipped missing SSP user-regs]"
+  fi
+
+  if [ ${tested} -eq 0 ]
+  then
+    echo "eGPR/SSP register capture test [Skipped missing eGPR/SSP registers]"
+    return
+  fi
+
+  echo "eGPR/SSP register capture test [Success]"
+}
+
 test_system_wide() {
   echo "Basic --system-wide mode test"
   local ret=0
@@ -449,6 +574,7 @@ fi
 
 test_per_thread
 test_register_capture
+test_egpr_register_capture
 test_system_wide
 test_workload
 test_branch_counter
-- 
2.34.1