[thirdparty/linux.git] / tools / testing / selftests / ftrace / ftracetest

#!/bin/sh
# SPDX-License-Identifier: GPL-2.0-only

# ftracetest - Ftrace test shell scripts
#
# Copyright (C) Hitachi Ltd., 2014
#  Written by Masami Hiramatsu <masami.hiramatsu.pt@hitachi.com>
#

usage() { # errno [message]
[ ! -z "$2" ] && echo $2
echo "Usage: ftracetest [options] [testcase(s)] [testcase-directory(s)]"
echo " Options:"
echo "		-h|--help  Show help message"
echo "		-k|--keep  Keep passed test logs"
echo "		-v|--verbose Increase verbosity of test messages"
echo "		-vv        Alias of -v -v (Show all results in stdout)"
echo "		-vvv       Alias of -v -v -v (Show all commands immediately)"
echo "		--fail-unsupported Treat UNSUPPORTED as a failure"
echo "		--fail-unresolved Treat UNRESOLVED as a failure"
echo "		-d|--debug Debug mode (trace all shell commands)"
echo "		-l|--logdir <dir> Save logs on the <dir>"
echo "		            If <dir> is -, all logs output in console only"
exit $1
}

# default error
err_ret=1

# kselftest skip code is 4
err_skip=4

# cgroup RT scheduling prevents chrt commands from succeeding, which
# induces failures in test wakeup tests.  Disable for the duration of
# the tests.

readonly sched_rt_runtime=/proc/sys/kernel/sched_rt_runtime_us

sched_rt_runtime_orig=$(cat $sched_rt_runtime)

setup() {
  echo -1 > $sched_rt_runtime
}

cleanup() {
  echo $sched_rt_runtime_orig > $sched_rt_runtime
}

errexit() { # message
  echo "Error: $1" 1>&2
  cleanup
  exit $err_ret
}

# Ensuring user privilege
if [ `id -u` -ne 0 ]; then
  errexit "this must be run by root user"
fi

setup

# Utilities
absdir() { # file_path
  (cd `dirname $1`; pwd)
}

abspath() {
  echo `absdir $1`/`basename $1`
}

find_testcases() { #directory
  echo `find $1 -name \*.tc | sort`
}

parse_opts() { # opts
  local OPT_TEST_CASES=
  local OPT_TEST_DIR=

  while [ ! -z "$1" ]; do
    case "$1" in
    --help|-h)
      usage 0
    ;;
    --keep|-k)
      KEEP_LOG=1
      shift 1
    ;;
    --verbose|-v|-vv|-vvv)
      if [ $VERBOSE -eq -1 ]; then
	usage "--console can not use with --verbose"
      fi
      VERBOSE=$((VERBOSE + 1))
      [ $1 = '-vv' ] && VERBOSE=$((VERBOSE + 1))
      [ $1 = '-vvv' ] && VERBOSE=$((VERBOSE + 2))
      shift 1
    ;;
    --console)
      if [ $VERBOSE -ne 0 ]; then
	usage "--console can not use with --verbose"
      fi
      VERBOSE=-1
      shift 1
    ;;
    --debug|-d)
      DEBUG=1
      shift 1
    ;;
    --stop-fail)
      STOP_FAILURE=1
      shift 1
    ;;
    --fail-unsupported)
      UNSUPPORTED_RESULT=1
      shift 1
    ;;
    --fail-unresolved)
      UNRESOLVED_RESULT=1
      shift 1
    ;;
    --logdir|-l)
      LOG_DIR=$2
      shift 2
    ;;
    *.tc)
      if [ -f "$1" ]; then
        OPT_TEST_CASES="$OPT_TEST_CASES `abspath $1`"
        shift 1
      else
        usage 1 "$1 is not a testcase"
      fi
      ;;
    *)
      if [ -d "$1" ]; then
        OPT_TEST_DIR=`abspath $1`
        OPT_TEST_CASES="$OPT_TEST_CASES `find_testcases $OPT_TEST_DIR`"
        shift 1
      else
        usage 1 "Invalid option ($1)"
      fi
    ;;
    esac
  done
  if [ ! -z "$OPT_TEST_CASES" ]; then
    TEST_CASES=$OPT_TEST_CASES
  fi
}

# Parameters
TRACING_DIR=`grep tracefs /proc/mounts | cut -f2 -d' ' | head -1`
if [ -z "$TRACING_DIR" ]; then
    DEBUGFS_DIR=`grep debugfs /proc/mounts | cut -f2 -d' ' | head -1`
    if [ -z "$DEBUGFS_DIR" ]; then
	# If tracefs exists, then so does /sys/kernel/tracing
	if [ -d "/sys/kernel/tracing" ]; then
	    mount -t tracefs nodev /sys/kernel/tracing ||
	      errexit "Failed to mount /sys/kernel/tracing"
	    TRACING_DIR="/sys/kernel/tracing"
	# If debugfs exists, then so does /sys/kernel/debug
	elif [ -d "/sys/kernel/debug" ]; then
	    mount -t debugfs nodev /sys/kernel/debug ||
	      errexit "Failed to mount /sys/kernel/debug"
	    TRACING_DIR="/sys/kernel/debug/tracing"
	else
	    err_ret=$err_skip
	    errexit "debugfs and tracefs are not configured in this kernel"
	fi
    else
	TRACING_DIR="$DEBUGFS_DIR/tracing"
    fi
fi
if [ ! -d "$TRACING_DIR" ]; then
    err_ret=$err_skip
    errexit "ftrace is not configured in this kernel"
fi

TOP_DIR=`absdir $0`
TEST_DIR=$TOP_DIR/test.d
TEST_CASES=`find_testcases $TEST_DIR`
LOG_DIR=$TOP_DIR/logs/`date +%Y%m%d-%H%M%S`/
KEEP_LOG=0
DEBUG=0
VERBOSE=0
UNSUPPORTED_RESULT=0
UNRESOLVED_RESULT=0
STOP_FAILURE=0
# Parse command-line options
parse_opts $*

[ $DEBUG -ne 0 ] && set -x

# Verify parameters
if [ -z "$TRACING_DIR" -o ! -d "$TRACING_DIR" ]; then
  errexit "No ftrace directory found"
fi

# Preparing logs
if [ "x$LOG_DIR" = "x-" ]; then
  LOG_FILE=
  date
else
  LOG_FILE=$LOG_DIR/ftracetest.log
  mkdir -p $LOG_DIR || errexit "Failed to make a log directory: $LOG_DIR"
  date > $LOG_FILE
fi

# Define text colors
# Check available colors on the terminal, if any
ncolors=`tput colors 2>/dev/null || echo 0`
color_reset=
color_red=
color_green=
color_blue=
# If stdout exists and number of colors is eight or more, use them
if [ -t 1 -a "$ncolors" -ge 8 ]; then
  color_reset="\033[0m"
  color_red="\033[31m"
  color_green="\033[32m"
  color_blue="\033[34m"
fi

strip_esc() {
  # busybox sed implementation doesn't accept "\x1B", so use [:cntrl:] instead.
  sed -E "s/[[:cntrl:]]\[([0-9]{1,2}(;[0-9]{1,2})?)?[m|K]//g"
}

prlog() { # messages
  newline="\n"
  if [ "$1" = "-n" ] ; then
    newline=
    shift
  fi
  printf "$*$newline"
  [ "$LOG_FILE" ] && printf "$*$newline" | strip_esc >> $LOG_FILE
}
catlog() { #file
  cat $1
  [ "$LOG_FILE" ] && cat $1 | strip_esc >> $LOG_FILE
}
prlog "=== Ftrace unit tests ==="


# Testcase management
# Test result codes - Dejagnu extended code
PASS=0	# The test succeeded.
FAIL=1	# The test failed, but was expected to succeed.
UNRESOLVED=2  # The test produced indeterminate results. (e.g. interrupted)
UNTESTED=3    # The test was not run, currently just a placeholder.
UNSUPPORTED=4 # The test failed because of lack of feature.
XFAIL=5	# The test failed, and was expected to fail.

# Accumulations
PASSED_CASES=
FAILED_CASES=
UNRESOLVED_CASES=
UNTESTED_CASES=
UNSUPPORTED_CASES=
XFAILED_CASES=
UNDEFINED_CASES=
TOTAL_RESULT=0

INSTANCE=
CASENO=0

testcase() { # testfile
  CASENO=$((CASENO+1))
  desc=`grep "^#[ \t]*description:" $1 | cut -f2 -d:`
  prlog -n "[$CASENO]$INSTANCE$desc"
}

test_on_instance() { # testfile
  grep -q "^#[ \t]*flags:.*instance" $1
}

eval_result() { # sigval
  case $1 in
    $PASS)
      prlog "	[${color_green}PASS${color_reset}]"
      PASSED_CASES="$PASSED_CASES $CASENO"
      return 0
    ;;
    $FAIL)
      prlog "	[${color_red}FAIL${color_reset}]"
      FAILED_CASES="$FAILED_CASES $CASENO"
      return 1 # this is a bug.
    ;;
    $UNRESOLVED)
      prlog "	[${color_blue}UNRESOLVED${color_reset}]"
      UNRESOLVED_CASES="$UNRESOLVED_CASES $CASENO"
      return $UNRESOLVED_RESULT # depends on use case
    ;;
    $UNTESTED)
      prlog "	[${color_blue}UNTESTED${color_reset}]"
      UNTESTED_CASES="$UNTESTED_CASES $CASENO"
      return 0
    ;;
    $UNSUPPORTED)
      prlog "	[${color_blue}UNSUPPORTED${color_reset}]"
      UNSUPPORTED_CASES="$UNSUPPORTED_CASES $CASENO"
      return $UNSUPPORTED_RESULT # depends on use case
    ;;
    $XFAIL)
      prlog "	[${color_green}XFAIL${color_reset}]"
      XFAILED_CASES="$XFAILED_CASES $CASENO"
      return 0
    ;;
    *)
      prlog "	[${color_blue}UNDEFINED${color_reset}]"
      UNDEFINED_CASES="$UNDEFINED_CASES $CASENO"
      return 1 # this must be a test bug
    ;;
  esac
}

# Signal handling for result codes
SIG_RESULT=
SIG_BASE=36	# Use realtime signals
SIG_PID=$$

exit_pass () {
  exit 0
}

SIG_FAIL=$((SIG_BASE + FAIL))
exit_fail () {
  exit 1
}
trap 'SIG_RESULT=$FAIL' $SIG_FAIL

SIG_UNRESOLVED=$((SIG_BASE + UNRESOLVED))
exit_unresolved () {
  kill -s $SIG_UNRESOLVED $SIG_PID
  exit 0
}
trap 'SIG_RESULT=$UNRESOLVED' $SIG_UNRESOLVED

SIG_UNTESTED=$((SIG_BASE + UNTESTED))
exit_untested () {
  kill -s $SIG_UNTESTED $SIG_PID
  exit 0
}
trap 'SIG_RESULT=$UNTESTED' $SIG_UNTESTED

SIG_UNSUPPORTED=$((SIG_BASE + UNSUPPORTED))
exit_unsupported () {
  kill -s $SIG_UNSUPPORTED $SIG_PID
  exit 0
}
trap 'SIG_RESULT=$UNSUPPORTED' $SIG_UNSUPPORTED

SIG_XFAIL=$((SIG_BASE + XFAIL))
exit_xfail () {
  kill -s $SIG_XFAIL $SIG_PID
  exit 0
}
trap 'SIG_RESULT=$XFAIL' $SIG_XFAIL

__run_test() { # testfile
  # setup PID and PPID, $$ is not updated.
  (cd $TRACING_DIR; read PID _ < /proc/self/stat; set -e; set -x; initialize_ftrace; . $1)
  [ $? -ne 0 ] && kill -s $SIG_FAIL $SIG_PID
}

# Run one test case
run_test() { # testfile
  local testname=`basename $1`
  testcase $1
  if [ ! -z "$LOG_FILE" ] ; then
    local testlog=`mktemp $LOG_DIR/${CASENO}-${testname}-log.XXXXXX`
  else
    local testlog=/proc/self/fd/1
  fi
  export TMPDIR=`mktemp -d /tmp/ftracetest-dir.XXXXXX`
  export FTRACETEST_ROOT=$TOP_DIR
  echo "execute$INSTANCE: "$1 > $testlog
  SIG_RESULT=0
  if [ $VERBOSE -eq -1 ]; then
    __run_test $1
  elif [ -z "$LOG_FILE" ]; then
    __run_test $1 2>&1
  elif [ $VERBOSE -ge 3 ]; then
    __run_test $1 | tee -a $testlog 2>&1
  elif [ $VERBOSE -eq 2 ]; then
    __run_test $1 2>> $testlog | tee -a $testlog
  else
    __run_test $1 >> $testlog 2>&1
  fi
  eval_result $SIG_RESULT
  if [ $? -eq 0 ]; then
    # Remove test log if the test was done as it was expected.
    [ $KEEP_LOG -eq 0 -a ! -z "$LOG_FILE" ] && rm $testlog
  else
    [ $VERBOSE -eq 1 -o $VERBOSE -eq 2 ] && catlog $testlog
    TOTAL_RESULT=1
  fi
  rm -rf $TMPDIR
}

# load in the helper functions
. $TEST_DIR/functions

# Main loop
for t in $TEST_CASES; do
  run_test $t
  if [ $STOP_FAILURE -ne 0 -a $TOTAL_RESULT -ne 0 ]; then
    echo "A failure detected. Stop test."
    exit 1
  fi
done

# Test on instance loop
INSTANCE=" (instance) "
for t in $TEST_CASES; do
  test_on_instance $t || continue
  SAVED_TRACING_DIR=$TRACING_DIR
  export TRACING_DIR=`mktemp -d $TRACING_DIR/instances/ftracetest.XXXXXX`
  run_test $t
  rmdir $TRACING_DIR
  TRACING_DIR=$SAVED_TRACING_DIR
  if [ $STOP_FAILURE -ne 0 -a $TOTAL_RESULT -ne 0 ]; then
    echo "A failure detected. Stop test."
    exit 1
  fi
done
(cd $TRACING_DIR; initialize_ftrace) # for cleanup

prlog ""
prlog "# of passed: " `echo $PASSED_CASES | wc -w`
prlog "# of failed: " `echo $FAILED_CASES | wc -w`
prlog "# of unresolved: " `echo $UNRESOLVED_CASES | wc -w`
prlog "# of untested: " `echo $UNTESTED_CASES | wc -w`
prlog "# of unsupported: " `echo $UNSUPPORTED_CASES | wc -w`
prlog "# of xfailed: " `echo $XFAILED_CASES | wc -w`
prlog "# of undefined(test bug): " `echo $UNDEFINED_CASES | wc -w`

cleanup

# if no error, return 0
exit $TOTAL_RESULT
Commit	Line	Data
6e68e6c5	1	#!/bin/sh
63307d01	2	# SPDX-License-Identifier: GPL-2.0-only
6e68e6c5 MH	3
	4	# ftracetest - Ftrace test shell scripts
	5	#
	6	# Copyright (C) Hitachi Ltd., 2014
	7	# Written by Masami Hiramatsu <masami.hiramatsu.pt@hitachi.com>
	8	#
6e68e6c5 MH	9
6e68e6c5 MH	10	usage() { # errno [message]
97e49368	11	[ ! -z "$2" ] && echo $2
6e68e6c5 MH	12	echo "Usage: ftracetest [options] [testcase(s)] [testcase-directory(s)]"
	13	echo " Options:"
	14	echo " -h\|--help Show help message"
	15	echo " -k\|--keep Keep passed test logs"
3dbb16b8 MH	16	echo " -v\|--verbose Increase verbosity of test messages"
3dbb16b8 MH	17	echo " -vv Alias of -v -v (Show all results in stdout)"
dab24fb1	18	echo " -vvv Alias of -v -v -v (Show all commands immediately)"
9aa94139	19	echo " --fail-unsupported Treat UNSUPPORTED as a failure"
b730d668	20	echo " --fail-unresolved Treat UNRESOLVED as a failure"
6e68e6c5	21	echo " -d\|--debug Debug mode (trace all shell commands)"
560642d9	22	echo " -l\|--logdir <dir> Save logs on the <dir>"
97bece60	23	echo " If <dir> is -, all logs output in console only"
6e68e6c5 MH	24	exit $1
	25	}
	26
cbd965bd SRV	27	# default error
	28	err_ret=1
	29
	30	# kselftest skip code is 4
	31	err_skip=4
	32
57c4cfd4 AM	33	# cgroup RT scheduling prevents chrt commands from succeeding, which
	34	# induces failures in test wakeup tests. Disable for the duration of
	35	# the tests.
	36
	37	readonly sched_rt_runtime=/proc/sys/kernel/sched_rt_runtime_us
	38
	39	sched_rt_runtime_orig=$(cat $sched_rt_runtime)
	40
	41	setup() {
	42	echo -1 > $sched_rt_runtime
	43	}
	44
	45	cleanup() {
	46	echo $sched_rt_runtime_orig > $sched_rt_runtime
	47	}
	48
6e68e6c5 MH	49	errexit() { # message
6e68e6c5 MH	50	echo "Error: $1" 1>&2
57c4cfd4	51	cleanup
cbd965bd	52	exit $err_ret
6e68e6c5 MH	53	}
	54
	55	# Ensuring user privilege
	56	if [ `id -u` -ne 0 ]; then
	57	errexit "this must be run by root user"
	58	fi
	59
57c4cfd4 AM	60	setup
57c4cfd4 AM	61
6e68e6c5 MH	62	# Utilities
	63	absdir() { # file_path
	64	(cd `dirname $1`; pwd)
	65	}
	66
	67	abspath() {
	68	echo `absdir $1`/`basename $1`
	69	}
	70
	71	find_testcases() { #directory
52100d7f	72	echo `find $1 -name \*.tc \| sort`
6e68e6c5 MH	73	}
	74
	75	parse_opts() { # opts
	76	local OPT_TEST_CASES=
	77	local OPT_TEST_DIR=
	78
97e49368	79	while [ ! -z "$1" ]; do
6e68e6c5 MH	80	case "$1" in
	81	--help\|-h)
	82	usage 0
	83	;;
	84	--keep\|-k)
	85	KEEP_LOG=1
	86	shift 1
	87	;;
dab24fb1	88	--verbose\|-v\|-vv\|-vvv)
5d1c6580 MH	89	if [ $VERBOSE -eq -1 ]; then
	90	usage "--console can not use with --verbose"
	91	fi
3dbb16b8	92	VERBOSE=$((VERBOSE + 1))
d2ffb8d3	93	[ $1 = '-vv' ] && VERBOSE=$((VERBOSE + 1))
dab24fb1	94	[ $1 = '-vvv' ] && VERBOSE=$((VERBOSE + 2))
7786bcca MH	95	shift 1
7786bcca MH	96	;;
5d1c6580 MH	97	--console)
	98	if [ $VERBOSE -ne 0 ]; then
	99	usage "--console can not use with --verbose"
	100	fi
	101	VERBOSE=-1
	102	shift 1
	103	;;
6e68e6c5 MH	104	--debug\|-d)
	105	DEBUG=1
	106	shift 1
	107	;;
9d954f95 MH	108	--stop-fail)
	109	STOP_FAILURE=1
	110	shift 1
	111	;;
9aa94139 MH	112	--fail-unsupported)
	113	UNSUPPORTED_RESULT=1
	114	shift 1
	115	;;
b730d668 AM	116	--fail-unresolved)
	117	UNRESOLVED_RESULT=1
	118	shift 1
	119	;;
560642d9 NK	120	--logdir\|-l)
	121	LOG_DIR=$2
	122	shift 2
	123	;;
6e68e6c5 MH	124	*.tc)
	125	if [ -f "$1" ]; then
	126	OPT_TEST_CASES="$OPT_TEST_CASES `abspath $1`"
	127	shift 1
	128	else
	129	usage 1 "$1 is not a testcase"
	130	fi
	131	;;
	132	*)
	133	if [ -d "$1" ]; then
	134	OPT_TEST_DIR=`abspath $1`
	135	OPT_TEST_CASES="$OPT_TEST_CASES `find_testcases $OPT_TEST_DIR`"
	136	shift 1
	137	else
	138	usage 1 "Invalid option ($1)"
	139	fi
	140	;;
	141	esac
	142	done
97e49368	143	if [ ! -z "$OPT_TEST_CASES" ]; then
6e68e6c5 MH	144	TEST_CASES=$OPT_TEST_CASES
	145	fi
	146	}
	147
	148	# Parameters
cbd965bd SRV	149	TRACING_DIR=`grep tracefs /proc/mounts \| cut -f2 -d' ' \| head -1`
	150	if [ -z "$TRACING_DIR" ]; then
	151	DEBUGFS_DIR=`grep debugfs /proc/mounts \| cut -f2 -d' ' \| head -1`
	152	if [ -z "$DEBUGFS_DIR" ]; then
	153	# If tracefs exists, then so does /sys/kernel/tracing
	154	if [ -d "/sys/kernel/tracing" ]; then
	155	mount -t tracefs nodev /sys/kernel/tracing \|\|
	156	errexit "Failed to mount /sys/kernel/tracing"
	157	TRACING_DIR="/sys/kernel/tracing"
	158	# If debugfs exists, then so does /sys/kernel/debug
	159	elif [ -d "/sys/kernel/debug" ]; then
	160	mount -t debugfs nodev /sys/kernel/debug \|\|
	161	errexit "Failed to mount /sys/kernel/debug"
	162	TRACING_DIR="/sys/kernel/debug/tracing"
	163	else
	164	err_ret=$err_skip
	165	errexit "debugfs and tracefs are not configured in this kernel"
	166	fi
	167	else
	168	TRACING_DIR="$DEBUGFS_DIR/tracing"
	169	fi
	170	fi
	171	if [ ! -d "$TRACING_DIR" ]; then
	172	err_ret=$err_skip
	173	errexit "ftrace is not configured in this kernel"
5a614ec8 NK	174	fi
5a614ec8 NK	175
6e68e6c5 MH	176	TOP_DIR=`absdir $0`
	177	TEST_DIR=$TOP_DIR/test.d
	178	TEST_CASES=`find_testcases $TEST_DIR`
	179	LOG_DIR=$TOP_DIR/logs/`date +%Y%m%d-%H%M%S`/
	180	KEEP_LOG=0
	181	DEBUG=0
57cee236	182	VERBOSE=0
9aa94139	183	UNSUPPORTED_RESULT=0
b730d668	184	UNRESOLVED_RESULT=0
9d954f95	185	STOP_FAILURE=0
6e68e6c5 MH	186	# Parse command-line options
	187	parse_opts $*
	188
	189	[ $DEBUG -ne 0 ] && set -x
	190
	191	# Verify parameters
5a614ec8	192	if [ -z "$TRACING_DIR" -o ! -d "$TRACING_DIR" ]; then
6e68e6c5 MH	193	errexit "No ftrace directory found"
	194	fi
	195
	196	# Preparing logs
97bece60 MH	197	if [ "x$LOG_DIR" = "x-" ]; then
	198	LOG_FILE=
	199	date
	200	else
	201	LOG_FILE=$LOG_DIR/ftracetest.log
	202	mkdir -p $LOG_DIR \|\| errexit "Failed to make a log directory: $LOG_DIR"
	203	date > $LOG_FILE
	204	fi
	205
8096fbcf DD	206	# Define text colors
8096fbcf DD	207	# Check available colors on the terminal, if any
0e27ded1	208	ncolors=`tput colors 2>/dev/null \|\| echo 0`
8096fbcf DD	209	color_reset=
	210	color_red=
	211	color_green=
	212	color_blue=
	213	# If stdout exists and number of colors is eight or more, use them
0e27ded1	214	if [ -t 1 -a "$ncolors" -ge 8 ]; then
4ce55a9c JH	215	color_reset="\033[0m"
	216	color_red="\033[31m"
	217	color_green="\033[32m"
	218	color_blue="\033[34m"
8096fbcf DD	219	fi
8096fbcf DD	220
f73581f8 MH	221	strip_esc() {
	222	# busybox sed implementation doesn't accept "\x1B", so use [:cntrl:] instead.
	223	sed -E "s/[[:cntrl:]]\[([0-9]{1,2}(;[0-9]{1,2})?)?[m\|K]//g"
	224	}
	225
6e68e6c5	226	prlog() { # messages
37fb665b JH	227	newline="\n"
	228	if [ "$1" = "-n" ] ; then
	229	newline=
	230	shift
	231	fi
	232	printf "$*$newline"
	233	[ "$LOG_FILE" ] && printf "$*$newline" \| strip_esc >> $LOG_FILE
6e68e6c5 MH	234	}
6e68e6c5 MH	235	catlog() { #file
f73581f8 MH	236	cat $1
f73581f8 MH	237	[ "$LOG_FILE" ] && cat $1 \| strip_esc >> $LOG_FILE
6e68e6c5 MH	238	}
	239	prlog "=== Ftrace unit tests ==="
	240
	241
	242	# Testcase management
915de2ad MH	243	# Test result codes - Dejagnu extended code
	244	PASS=0 # The test succeeded.
	245	FAIL=1 # The test failed, but was expected to succeed.
	246	UNRESOLVED=2 # The test produced indeterminate results. (e.g. interrupted)
	247	UNTESTED=3 # The test was not run, currently just a placeholder.
	248	UNSUPPORTED=4 # The test failed because of lack of feature.
	249	XFAIL=5 # The test failed, and was expected to fail.
	250
	251	# Accumulations
6e68e6c5 MH	252	PASSED_CASES=
6e68e6c5 MH	253	FAILED_CASES=
915de2ad MH	254	UNRESOLVED_CASES=
	255	UNTESTED_CASES=
	256	UNSUPPORTED_CASES=
	257	XFAILED_CASES=
	258	UNDEFINED_CASES=
	259	TOTAL_RESULT=0
	260
b5b77be8	261	INSTANCE=
6e68e6c5	262	CASENO=0
57c4cfd4	263
6e68e6c5 MH	264	testcase() { # testfile
6e68e6c5 MH	265	CASENO=$((CASENO+1))
36922d13	266	desc=`grep "^#[ \t]*description:" $1 \| cut -f2 -d:`
b5b77be8 SRV	267	prlog -n "[$CASENO]$INSTANCE$desc"
	268	}
	269
	270	test_on_instance() { # testfile
	271	grep -q "^#[ \t]flags:.instance" $1
6e68e6c5	272	}
915de2ad	273
57cee236 MH	274	eval_result() { # sigval
57cee236 MH	275	case $1 in
915de2ad	276	$PASS)
8096fbcf	277	prlog " [${color_green}PASS${color_reset}]"
915de2ad MH	278	PASSED_CASES="$PASSED_CASES $CASENO"
	279	return 0
	280	;;
	281	$FAIL)
8096fbcf	282	prlog " [${color_red}FAIL${color_reset}]"
915de2ad MH	283	FAILED_CASES="$FAILED_CASES $CASENO"
	284	return 1 # this is a bug.
	285	;;
	286	$UNRESOLVED)
8096fbcf	287	prlog " [${color_blue}UNRESOLVED${color_reset}]"
915de2ad	288	UNRESOLVED_CASES="$UNRESOLVED_CASES $CASENO"
b730d668	289	return $UNRESOLVED_RESULT # depends on use case
915de2ad MH	290	;;
915de2ad MH	291	$UNTESTED)
8096fbcf	292	prlog " [${color_blue}UNTESTED${color_reset}]"
915de2ad MH	293	UNTESTED_CASES="$UNTESTED_CASES $CASENO"
	294	return 0
	295	;;
	296	$UNSUPPORTED)
8096fbcf	297	prlog " [${color_blue}UNSUPPORTED${color_reset}]"
915de2ad	298	UNSUPPORTED_CASES="$UNSUPPORTED_CASES $CASENO"
9aa94139	299	return $UNSUPPORTED_RESULT # depends on use case
915de2ad MH	300	;;
915de2ad MH	301	$XFAIL)
6734d211	302	prlog " [${color_green}XFAIL${color_reset}]"
915de2ad MH	303	XFAILED_CASES="$XFAILED_CASES $CASENO"
	304	return 0
	305	;;
	306	*)
8096fbcf	307	prlog " [${color_blue}UNDEFINED${color_reset}]"
915de2ad MH	308	UNDEFINED_CASES="$UNDEFINED_CASES $CASENO"
	309	return 1 # this must be a test bug
	310	;;
	311	esac
	312	}
	313
	314	# Signal handling for result codes
	315	SIG_RESULT=
	316	SIG_BASE=36 # Use realtime signals
	317	SIG_PID=$$
	318
42534b1f MH	319	exit_pass () {
	320	exit 0
	321	}
	322
57cee236	323	SIG_FAIL=$((SIG_BASE + FAIL))
42534b1f MH	324	exit_fail () {
	325	exit 1
	326	}
57cee236 MH	327	trap 'SIG_RESULT=$FAIL' $SIG_FAIL
57cee236 MH	328
915de2ad MH	329	SIG_UNRESOLVED=$((SIG_BASE + UNRESOLVED))
	330	exit_unresolved () {
	331	kill -s $SIG_UNRESOLVED $SIG_PID
	332	exit 0
	333	}
	334	trap 'SIG_RESULT=$UNRESOLVED' $SIG_UNRESOLVED
	335
	336	SIG_UNTESTED=$((SIG_BASE + UNTESTED))
	337	exit_untested () {
	338	kill -s $SIG_UNTESTED $SIG_PID
	339	exit 0
6e68e6c5	340	}
915de2ad MH	341	trap 'SIG_RESULT=$UNTESTED' $SIG_UNTESTED
	342
	343	SIG_UNSUPPORTED=$((SIG_BASE + UNSUPPORTED))
	344	exit_unsupported () {
	345	kill -s $SIG_UNSUPPORTED $SIG_PID
	346	exit 0
6e68e6c5	347	}
915de2ad	348	trap 'SIG_RESULT=$UNSUPPORTED' $SIG_UNSUPPORTED
6e68e6c5	349
915de2ad MH	350	SIG_XFAIL=$((SIG_BASE + XFAIL))
	351	exit_xfail () {
	352	kill -s $SIG_XFAIL $SIG_PID
	353	exit 0
	354	}
	355	trap 'SIG_RESULT=$XFAIL' $SIG_XFAIL
6e68e6c5	356
57cee236 MH	357	__run_test() { # testfile
57cee236 MH	358	# setup PID and PPID, $$ is not updated.
131f840d	359	(cd $TRACING_DIR; read PID _ < /proc/self/stat; set -e; set -x; initialize_ftrace; . $1)
57cee236 MH	360	[ $? -ne 0 ] && kill -s $SIG_FAIL $SIG_PID
	361	}
	362
6e68e6c5 MH	363	# Run one test case
	364	run_test() { # testfile
	365	local testname=`basename $1`
7d0abba4	366	testcase $1
97bece60	367	if [ ! -z "$LOG_FILE" ] ; then
7d0abba4	368	local testlog=`mktemp $LOG_DIR/${CASENO}-${testname}-log.XXXXXX`
97bece60 MH	369	else
	370	local testlog=/proc/self/fd/1
	371	fi
62197529	372	export TMPDIR=`mktemp -d /tmp/ftracetest-dir.XXXXXX`
4a075bd4	373	export FTRACETEST_ROOT=$TOP_DIR
1917d2c8	374	echo "execute$INSTANCE: "$1 > $testlog
915de2ad	375	SIG_RESULT=0
5d1c6580 MH	376	if [ $VERBOSE -eq -1 ]; then
	377	__run_test $1
	378	elif [ -z "$LOG_FILE" ]; then
97bece60 MH	379	__run_test $1 2>&1
97bece60 MH	380	elif [ $VERBOSE -ge 3 ]; then
dab24fb1 MH	381	__run_test $1 \| tee -a $testlog 2>&1
dab24fb1 MH	382	elif [ $VERBOSE -eq 2 ]; then
57cee236 MH	383	__run_test $1 2>> $testlog \| tee -a $testlog
	384	else
	385	__run_test $1 >> $testlog 2>&1
	386	fi
	387	eval_result $SIG_RESULT
915de2ad MH	388	if [ $? -eq 0 ]; then
915de2ad MH	389	# Remove test log if the test was done as it was expected.
97bece60	390	[ $KEEP_LOG -eq 0 -a ! -z "$LOG_FILE" ] && rm $testlog
915de2ad	391	else
dab24fb1	392	[ $VERBOSE -eq 1 -o $VERBOSE -eq 2 ] && catlog $testlog
915de2ad	393	TOTAL_RESULT=1
6e68e6c5	394	fi
62197529	395	rm -rf $TMPDIR
6e68e6c5 MH	396	}
6e68e6c5 MH	397
ee3988c7 SRRH	398	# load in the helper functions
	399	. $TEST_DIR/functions
	400
6e68e6c5 MH	401	# Main loop
	402	for t in $TEST_CASES; do
	403	run_test $t
9d954f95 MH	404	if [ $STOP_FAILURE -ne 0 -a $TOTAL_RESULT -ne 0 ]; then
	405	echo "A failure detected. Stop test."
	406	exit 1
	407	fi
6e68e6c5	408	done
915de2ad	409
b5b77be8 SRV	410	# Test on instance loop
	411	INSTANCE=" (instance) "
	412	for t in $TEST_CASES; do
	413	test_on_instance $t \|\| continue
	414	SAVED_TRACING_DIR=$TRACING_DIR
	415	export TRACING_DIR=`mktemp -d $TRACING_DIR/instances/ftracetest.XXXXXX`
	416	run_test $t
	417	rmdir $TRACING_DIR
	418	TRACING_DIR=$SAVED_TRACING_DIR
9d954f95 MH	419	if [ $STOP_FAILURE -ne 0 -a $TOTAL_RESULT -ne 0 ]; then
	420	echo "A failure detected. Stop test."
	421	exit 1
	422	fi
b5b77be8	423	done
9768cc46	424	(cd $TRACING_DIR; initialize_ftrace) # for cleanup
b5b77be8	425
6e68e6c5 MH	426	prlog ""
	427	prlog "# of passed: " `echo $PASSED_CASES \| wc -w`
	428	prlog "# of failed: " `echo $FAILED_CASES \| wc -w`
915de2ad MH	429	prlog "# of unresolved: " `echo $UNRESOLVED_CASES \| wc -w`
	430	prlog "# of untested: " `echo $UNTESTED_CASES \| wc -w`
	431	prlog "# of unsupported: " `echo $UNSUPPORTED_CASES \| wc -w`
	432	prlog "# of xfailed: " `echo $XFAILED_CASES \| wc -w`
	433	prlog "# of undefined(test bug): " `echo $UNDEFINED_CASES \| wc -w`
	434
57c4cfd4 AM	435	cleanup
57c4cfd4 AM	436
915de2ad MH	437	# if no error, return 0
915de2ad MH	438	exit $TOTAL_RESULT