Commit 22736977 authored by Ian Rogers's avatar Ian Rogers Committed by Arnaldo Carvalho de Melo
Browse files

perf test script: Add perl script testing support 



Basic coverage of perl script support from `perf script`. This is
disabled by default and so the test will most normally skip.

Committer testing:

  $ perf test 'perf script perl'
  106: perf script perl tests                                          : Skip
  $ perf test -vv 'perf script perl'
  106: perf script perl tests:
  --- start ---
  test child forked, pid 578323
  perf script perl test [Skipped: no libperl support]
  ---- end(-2) ----
  106: perf script perl tests                                          : Skip
  $ perf check feature libperl
                 libperl: [ OFF ]  # HAVE_LIBPERL_SUPPORT ( tip: Deprecated, use LIBPERL=1 and install perl-ExtUtils-Embed/libperl-dev to build with it )
  $

Install perl-ExtUtils-Embed, build with LIBPERL=1, rebuild:

  $ perf check feature libperl
                 libperl: [ on  ]  # HAVE_LIBPERL_SUPPORT
  $ perf test 'perf script perl'
  106: perf script perl tests                                          : Ok
  $ perf test -vv 'perf script perl'
  106: perf script perl tests:
  --- start ---
  test child forked, pid 588206
  Testing event: sched:sched_switch
  perf script perl test [Skipped: failed to record sched:sched_switch]
  Testing event: task-clock
  Generating perl script...
  generated Perl script: /tmp/__perf_test_script.RpMn5.pl
  Executing perl script...
  perf script perl test [Success: task-clock triggered $VAR1]
  ---- end(0) ----
  106: perf script perl tests                                          : Ok
  $

Signed-off-by: default avatarIan Rogers <irogers@google.com>
Tested-by: default avatarArnaldo Carvalho de Melo <acme@redhat.com>
Cc: Adrian Hunter <adrian.hunter@intel.com>
Cc: Alexander Shishkin <alexander.shishkin@linux.intel.com>
Cc: Ingo Molnar <mingo@redhat.com>
Cc: James Clark <james.clark@linaro.org>
Cc: Jiri Olsa <jolsa@kernel.org>
Cc: Leo Yan <leo.yan@arm.com>
Cc: Namhyung Kim <namhyung@kernel.org>
Cc: Peter Zijlstra <peterz@infradead.org>
Cc: Sandipan Das <sandipan.das@amd.com>
Cc: Yujie Liu <yujie.liu@intel.com>
Signed-off-by: default avatarArnaldo Carvalho de Melo <acme@redhat.com>
parent 22ca2f7f

tools/perf/tests/shell/script_perl.sh

0 → 100755
+102 −0
Original line number Diff line number Diff line 
#!/bin/bash

# perf script perl tests

# SPDX-License-Identifier: GPL-2.0



set -e



# set PERF_EXEC_PATH to find scripts in the source directory

perfdir=$(dirname "$0")/../..

if [ -e "$perfdir/scripts/perl/Perf-Trace-Util" ]; then

  export PERF_EXEC_PATH=$perfdir

fi





perfdata=$(mktemp /tmp/__perf_test_script_perl.perf.data.XXXXX)

generated_script=$(mktemp /tmp/__perf_test_script.XXXXX.pl)



cleanup() {

  rm -f "${perfdata}"

  rm -f "${generated_script}"

  trap - EXIT TERM INT

}



trap_cleanup() {

  echo "Unexpected signal in ${FUNCNAME[1]}"

  cleanup

  exit 1

}

trap trap_cleanup TERM INT

trap cleanup EXIT



check_perl_support() {

	if perf check feature -q libperl; then

		return 0

	fi

	echo "perf script perl test [Skipped: no libperl support]"

	return 2

}



test_script() {

	local event_name=$1

	local expected_output=$2

	local record_opts=$3



	echo "Testing event: $event_name"



	# Try to record. If this fails, it might be permissions or lack of support.

	# We return 2 to indicate "skip this event" rather than "fail test".

	if ! perf record -o "${perfdata}" -e "$event_name" $record_opts -- perf test -w thloop > /dev/null 2>&1; then

		echo "perf script perl test [Skipped: failed to record $event_name]"

		return 2

	fi



	echo "Generating perl script..."

	if ! perf script -i "${perfdata}" -g "${generated_script}"; then

		echo "perf script perl test [Failed: script generation for $event_name]"

		return 1

	fi



	if [ ! -f "${generated_script}" ]; then

		echo "perf script perl test [Failed: script not generated for $event_name]"

		return 1

	fi



	echo "Executing perl script..."

	output=$(perf script -i "${perfdata}" -s "${generated_script}" 2>&1)



	if echo "$output" | grep -q "$expected_output"; then

		echo "perf script perl test [Success: $event_name triggered $expected_output]"

		return 0

	else

		echo "perf script perl test [Failed: $event_name did not trigger $expected_output]"

		echo "Output was:"

		echo "$output" | head -n 20

		return 1

	fi

}



check_perl_support || exit 2



# Try tracepoint first

test_script "sched:sched_switch" "sched::sched_switch" "-c 1" && res=0 || res=$?



if [ $res -eq 0 ]; then

	exit 0

elif [ $res -eq 1 ]; then

	exit 1

fi



# If tracepoint skipped (res=2), try task-clock

# For generic events like task-clock, the generated script uses process_event()

# which dumps data using Data::Dumper. We check for "$VAR1" which is standard Dumper output.

test_script "task-clock" "\$VAR1" "-c 100" && res=0 || res=$?



if [ $res -eq 0 ]; then

	exit 0

elif [ $res -eq 1 ]; then

	exit 1

fi



# If both skipped

echo "perf script perl test [Skipped: Could not record tracepoint or task-clock]"

exit 2