Basic comment to describe the tests and the requirements

[benchmarks.git] / ust-systemtap-tracepoints / runtest.sh

diff --git a/ust-systemtap-tracepoints/runtest.sh b/ust-systemtap-tracepoints/runtest.sh
index 752916b8030c42909c61f91ce512753482a359f3..9301162730f25bd980e724d65a25d2d9922cc989 100644 (file)
--- a/ust-systemtap-tracepoints/runtest.sh
+++ b/ust-systemtap-tracepoints/runtest.sh
@@ -1,11 +1,19 @@
 #!/bin/sh
 
-#UST scalability test
+# UST vs SystemTap scalability test
+# This script can run 4 different tests :
+# - UST in flight recorder mode
+# - UST writing the trace to disk
+# - SystemTap in flight recorder mode
+# - SystemTap writing the trace to disk
+
+# You need to be root to run the SystemTap tests because of the rmmod
 
 BINARY=tracepoint_benchmark
 REPORT=/tmp/testreport
 TMPLOG=/tmp/testlog
 WRAPPER=""
+CLEANUP=""
 STAP=stap
 STAPTMP=/tmp/stapconsole
 STAPPROBE=testutrace.stp
@@ -55,9 +63,11 @@ case "$1" in
                ;;
        stap_flight_recorder)
                TEST=stap_flight_recorder
+               CLEANUP="rmmod $BINARY 2>/dev/null"
                ;;
        stap_disk)
                TEST=stap_disk
+               CLEANUP="killall stapio 2>/dev/null"
                ;;
        *)
                echo "Usage : $0 {ust_flight_recorder|ust_disk|stap_flight_recorder|stap_disk}"
@@ -70,9 +80,7 @@ for nr_threads in 1 2 4 8; do
        echo Number of threads: $nr_threads | tee >> $REPORT
        echo -n "* Baseline : " | tee >> $REPORT
 
-       # just some cleanup
-       killall stapio 2>/dev/null
-       rmmod $BINARY 2>/dev/null
+       $CLEANUP
 
        sync
        /usr/bin/time -f "%E" -o $TMPLOG ./$BINARY ${nr_threads}