3 # ftracetest - Ftrace test shell scripts
5 # Copyright (C) Hitachi Ltd., 2014
6 # Written by Masami Hiramatsu <masami.hiramatsu.pt@hitachi.com>
8 # Released under the terms of the GPL v2.
10 usage() { # errno [message]
12 echo "Usage: ftracetest [options] [testcase(s)] [testcase-directory(s)]"
14 echo " -h|--help Show help message"
15 echo " -k|--keep Keep passed test logs"
16 echo " -v|--verbose Increase verbosity of test messages"
17 echo " -vv Alias of -v -v (Show all results in stdout)"
18 echo " -d|--debug Debug mode (trace all shell commands)"
19 echo " -l|--logdir <dir> Save logs on the <dir>"
28 # Ensuring user privilege
29 if [ `id -u` -ne 0 ]; then
30 errexit "this must be run by root user"
34 absdir() { # file_path
35 (cd `dirname $1`; pwd)
39 echo `absdir $1`/`basename $1`
42 find_testcases() { #directory
43 echo `find $1 -name \*.tc | sort`
60 VERBOSE=$((VERBOSE + 1))
61 [ $1 == '-vv' ] && VERBOSE=$((VERBOSE + 1))
74 OPT_TEST_CASES="$OPT_TEST_CASES `abspath $1`"
77 usage 1 "$1 is not a testcase"
82 OPT_TEST_DIR=`abspath $1`
83 OPT_TEST_CASES="$OPT_TEST_CASES `find_testcases $OPT_TEST_DIR`"
86 usage 1 "Invalid option ($1)"
91 if [ "$OPT_TEST_CASES" ]; then
92 TEST_CASES=$OPT_TEST_CASES
97 DEBUGFS_DIR=`grep debugfs /proc/mounts | cut -f2 -d' ' | head -1`
98 if [ -z "$DEBUGFS_DIR" ]; then
99 TRACING_DIR=`grep tracefs /proc/mounts | cut -f2 -d' ' | head -1`
101 TRACING_DIR=$DEBUGFS_DIR/tracing
105 TEST_DIR=$TOP_DIR/test.d
106 TEST_CASES=`find_testcases $TEST_DIR`
107 LOG_DIR=$TOP_DIR/logs/`date +%Y%m%d-%H%M%S`/
111 # Parse command-line options
114 [ $DEBUG -ne 0 ] && set -x
117 if [ -z "$TRACING_DIR" -o ! -d "$TRACING_DIR" ]; then
118 errexit "No ftrace directory found"
122 LOG_FILE=$LOG_DIR/ftracetest.log
123 mkdir -p $LOG_DIR || errexit "Failed to make a log directory: $LOG_DIR"
126 echo "$@" | tee -a $LOG_FILE
129 cat $1 | tee -a $LOG_FILE
131 prlog "=== Ftrace unit tests ==="
134 # Testcase management
135 # Test result codes - Dejagnu extended code
136 PASS=0 # The test succeeded.
137 FAIL=1 # The test failed, but was expected to succeed.
138 UNRESOLVED=2 # The test produced indeterminate results. (e.g. interrupted)
139 UNTESTED=3 # The test was not run, currently just a placeholder.
140 UNSUPPORTED=4 # The test failed because of lack of feature.
141 XFAIL=5 # The test failed, and was expected to fail.
155 testcase() { # testfile
157 desc=`grep "^#[ \t]*description:" $1 | cut -f2 -d:`
158 prlog -n "[$CASENO]$INSTANCE$desc"
161 test_on_instance() { # testfile
162 grep -q "^#[ \t]*flags:.*instance" $1
165 eval_result() { # sigval
169 PASSED_CASES="$PASSED_CASES $CASENO"
174 FAILED_CASES="$FAILED_CASES $CASENO"
175 return 1 # this is a bug.
178 prlog " [UNRESOLVED]"
179 UNRESOLVED_CASES="$UNRESOLVED_CASES $CASENO"
180 return 1 # this is a kind of bug.. something happened.
184 UNTESTED_CASES="$UNTESTED_CASES $CASENO"
188 prlog " [UNSUPPORTED]"
189 UNSUPPORTED_CASES="$UNSUPPORTED_CASES $CASENO"
190 return 1 # this is not a bug, but the result should be reported.
194 XFAILED_CASES="$XFAILED_CASES $CASENO"
199 UNDEFINED_CASES="$UNDEFINED_CASES $CASENO"
200 return 1 # this must be a test bug
205 # Signal handling for result codes
207 SIG_BASE=36 # Use realtime signals
210 SIG_FAIL=$((SIG_BASE + FAIL))
211 trap 'SIG_RESULT=$FAIL' $SIG_FAIL
213 SIG_UNRESOLVED=$((SIG_BASE + UNRESOLVED))
215 kill -s $SIG_UNRESOLVED $SIG_PID
218 trap 'SIG_RESULT=$UNRESOLVED' $SIG_UNRESOLVED
220 SIG_UNTESTED=$((SIG_BASE + UNTESTED))
222 kill -s $SIG_UNTESTED $SIG_PID
225 trap 'SIG_RESULT=$UNTESTED' $SIG_UNTESTED
227 SIG_UNSUPPORTED=$((SIG_BASE + UNSUPPORTED))
228 exit_unsupported () {
229 kill -s $SIG_UNSUPPORTED $SIG_PID
232 trap 'SIG_RESULT=$UNSUPPORTED' $SIG_UNSUPPORTED
234 SIG_XFAIL=$((SIG_BASE + XFAIL))
236 kill -s $SIG_XFAIL $SIG_PID
239 trap 'SIG_RESULT=$XFAIL' $SIG_XFAIL
241 __run_test() { # testfile
242 # setup PID and PPID, $$ is not updated.
243 (cd $TRACING_DIR; read PID _ < /proc/self/stat; set -e; set -x; initialize_ftrace; . $1)
244 [ $? -ne 0 ] && kill -s $SIG_FAIL $SIG_PID
248 run_test() { # testfile
249 local testname=`basename $1`
250 local testlog=`mktemp $LOG_DIR/${testname}-log.XXXXXX`
251 export TMPDIR=`mktemp -d /tmp/ftracetest-dir.XXXXXX`
253 echo "execute: "$1 > $testlog
255 if [ $VERBOSE -ge 2 ]; then
256 __run_test $1 2>> $testlog | tee -a $testlog
258 __run_test $1 >> $testlog 2>&1
260 eval_result $SIG_RESULT
261 if [ $? -eq 0 ]; then
262 # Remove test log if the test was done as it was expected.
263 [ $KEEP_LOG -eq 0 ] && rm $testlog
265 [ $VERBOSE -ge 1 ] && catlog $testlog
271 # load in the helper functions
272 . $TEST_DIR/functions
275 for t in $TEST_CASES; do
279 # Test on instance loop
280 INSTANCE=" (instance) "
281 for t in $TEST_CASES; do
282 test_on_instance $t || continue
283 SAVED_TRACING_DIR=$TRACING_DIR
284 export TRACING_DIR=`mktemp -d $TRACING_DIR/instances/ftracetest.XXXXXX`
287 TRACING_DIR=$SAVED_TRACING_DIR
291 prlog "# of passed: " `echo $PASSED_CASES | wc -w`
292 prlog "# of failed: " `echo $FAILED_CASES | wc -w`
293 prlog "# of unresolved: " `echo $UNRESOLVED_CASES | wc -w`
294 prlog "# of untested: " `echo $UNTESTED_CASES | wc -w`
295 prlog "# of unsupported: " `echo $UNSUPPORTED_CASES | wc -w`
296 prlog "# of xfailed: " `echo $XFAILED_CASES | wc -w`
297 prlog "# of undefined(test bug): " `echo $UNDEFINED_CASES | wc -w`
299 # if no error, return 0