Test: kill sessiond,relayd and background children on SIGTERM/SIGINT
[lttng-tools.git] / tests / utils / utils.sh
index 5ffe6eb47ad8da6836e3e183356cb09066360033..5b81febb6bfb5c52ba9e3eff2c451175603326ad 100644 (file)
 # 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301 USA
 
 SESSIOND_BIN="lttng-sessiond"
+SESSIOND_PIDS=""
+RUNAS_BIN="lttng-runas"
 CONSUMERD_BIN="lttng-consumerd"
 RELAYD_BIN="lttng-relayd"
+RELAYD_PIDS=""
 LTTNG_BIN="lttng"
 BABELTRACE_BIN="babeltrace"
 OUTPUT_DEST=/dev/null
@@ -33,8 +36,30 @@ KERNEL_PATCHLEVEL_VERSION=27
 # systems. Specialized tests should test those corner-cases.
 export LTTNG_UST_REGISTER_TIMEOUT=-1
 
+# We set the default lttng-sessiond path to /bin/true to prevent the spawning
+# of a daemonized sessiond. This is necessary since 'lttng create' will spawn
+# its own sessiond if none is running. It also ensures that 'lttng create'
+# fails when no sessiond is running.
+export LTTNG_SESSIOND_PATH="/bin/true"
+
 source $TESTDIR/utils/tap/tap.sh
 
+function full_cleanup ()
+{
+       if [ -n "${SESSIOND_PIDS}" ] || [ -n "${RELAYD_PIDS}" ]; then
+               kill -9 ${SESSIOND_PIDS} ${RELAYD_PIDS} > /dev/null 2>&1
+       fi
+
+       # Disable trap for SIGTERM since the following kill to the
+       # pidgroup will be SIGTERM. Otherwise it loops.
+       # The '-' before the pid number ($$) indicates 'kill' to signal the
+       # whole process group.
+       trap - SIGTERM && kill -- -$$
+}
+
+
+trap full_cleanup SIGINT SIGTERM
+
 function print_ok ()
 {
        # Check if we are a terminal
@@ -82,7 +107,17 @@ function validate_kernel_version ()
 function randstring()
 {
        [ "$2" == "0" ] && CHAR="[:alnum:]" || CHAR="[:graph:]"
-       cat /dev/urandom | tr -cd "$CHAR" | head -c ${1:-16}
+       cat /dev/urandom 2>/dev/null | tr -cd "$CHAR" 2>/dev/null | head -c ${1:-16} 2>/dev/null
+       echo
+}
+
+# Return the number of _configured_ CPUs.
+function conf_proc_count()
+{
+       getconf _NPROCESSORS_CONF
+       if [ $? -ne 0 ]; then
+               diag "Failed to get the number of configured CPUs"
+       fi
        echo
 }
 
@@ -194,7 +229,7 @@ function lttng_disable_kernel_syscall()
        ret=$?
        if [[ $expected_to_fail -eq "1" ]]; then
                test $ret -ne "0"
-               ok $? "Disable kernel syscall $syscall_name for session $sess_name on channel $channel_name fail as expected"
+               ok $? "Disable kernel syscall $syscall_name for session $sess_name on channel $channel_name failed as expected"
        else
                ok $ret "Disable kernel syscall $syscall_name for session $sess_name on channel $channel_name"
        fi
@@ -220,7 +255,7 @@ function lttng_enable_kernel_channel()
        ret=$?
        if [[ $expected_to_fail -eq "1" ]]; then
                test "$ret" -ne "0"
-               ok $? "Expected failure on kernel channel creation $channel_name in $sess_name"
+               ok $? "Enable channel $channel_name for session $sess_name failed as expected"
        else
                ok $ret "Enable channel $channel_name for session $sess_name"
        fi
@@ -246,9 +281,9 @@ function lttng_disable_kernel_channel()
        ret=$?
        if [[ $expected_to_fail -eq "1" ]]; then
                test "$ret" -ne "0"
-               ok $? "Expected failure on kernel channel creation $channel_name in $sess_name"
+               ok $? "Disable channel $channel_name for session $sess_name failed as expected"
        else
-               ok $ret "disable channel $channel_name for session $sess_name"
+               ok $ret "Disable channel $channel_name for session $sess_name"
        fi
 }
 
@@ -269,7 +304,7 @@ function start_lttng_relayd_opt()
 
        DIR=$(readlink -f $TESTDIR)
 
-       if [ -z $(pidof lt-$RELAYD_BIN) ]; then
+       if [ -z $(pgrep --full lt-$RELAYD_BIN) ]; then
                $DIR/../src/bin/lttng-relayd/$RELAYD_BIN -b $opt 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
                #$DIR/../src/bin/lttng-relayd/$RELAYD_BIN $opt -vvv >>/tmp/relayd.log 2>&1 &
                if [ $? -eq 1 ]; then
@@ -285,6 +320,8 @@ function start_lttng_relayd_opt()
        else
                pass "Start lttng-relayd (opt: $opt)"
        fi
+
+       RELAYD_PIDS=$(pgrep --full lt-$RELAYD_BIN)
 }
 
 function start_lttng_relayd()
@@ -301,12 +338,10 @@ function stop_lttng_relayd_opt()
 {
        local withtap=$1
 
-       PID_RELAYD=`pidof lt-$RELAYD_BIN`
-
        if [ $withtap -eq "1" ]; then
-               diag "Killing lttng-relayd (pid: $PID_RELAYD)"
+               diag "Killing lttng-relayd (pid: $RELAYD_PIDS)"
        fi
-       kill $PID_RELAYD 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
+       kill $RELAYD_PIDS 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
        retval=$?
 
        if [ $? -eq 1 ]; then
@@ -317,13 +352,14 @@ function stop_lttng_relayd_opt()
        else
                out=1
                while [ -n "$out" ]; do
-                       out=$(pidof lt-$RELAYD_BIN)
+                       out=$(pgrep --full lt-$RELAYD_BIN)
                        sleep 0.5
                done
                if [ $withtap -eq "1" ]; then
                        pass "Kill relay daemon"
                fi
        fi
+       RELAYD_PIDS=""
        return $retval
 }
 
@@ -359,10 +395,10 @@ function start_lttng_sessiond_opt()
        : ${LTTNG_SESSION_CONFIG_XSD_PATH=${DIR}/../src/common/config/}
        export LTTNG_SESSION_CONFIG_XSD_PATH
 
-       if [ -z $(pidof lt-$SESSIOND_BIN) ]; then
+       if [ -z $(pgrep --full lt-$SESSIOND_BIN) ]; then
                # Have a load path ?
                if [ -n "$load_path" ]; then
-                       $DIR/../src/bin/lttng-sessiond/$SESSIOND_BIN --load "$1" --background --consumerd32-path="$DIR/../src/bin/lttng-consumerd/lttng-consumerd" --consumerd64-path="$DIR/../src/bin/lttng-consumerd/lttng-consumerd"
+                       $DIR/../src/bin/lttng-sessiond/$SESSIOND_BIN --load "$load_path" --background --consumerd32-path="$DIR/../src/bin/lttng-consumerd/lttng-consumerd" --consumerd64-path="$DIR/../src/bin/lttng-consumerd/lttng-consumerd"
                else
                        $DIR/../src/bin/lttng-sessiond/$SESSIOND_BIN --background --consumerd32-path="$DIR/../src/bin/lttng-consumerd/lttng-consumerd" --consumerd64-path="$DIR/../src/bin/lttng-consumerd/lttng-consumerd"
                fi
@@ -372,6 +408,7 @@ function start_lttng_sessiond_opt()
                        ok $status "Start session daemon"
                fi
        fi
+       SESSIOND_PIDS=$(pgrep --full lt-$SESSIOND_BIN)
 }
 
 function start_lttng_sessiond()
@@ -395,13 +432,15 @@ function stop_lttng_sessiond_opt()
                return
        fi
 
-       PID_SESSIOND=`pidof lt-$SESSIOND_BIN`
+       local pids="${SESSIOND_PIDS} $(pgrep --full $RUNAS_BIN)"
 
        if [ -n "$2" ]; then
                kill_opt="$kill_opt -s $signal"
        fi
-
-       kill $kill_opt $PID_SESSIOND 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
+       if [ $withtap -eq "1" ]; then
+               diag "Killing lt-$SESSIOND_BIN pids: $(echo $pids | tr '\n' ' ')"
+       fi
+       kill $kill_opt $pids 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
 
        if [ $? -eq 1 ]; then
                if [ $withtap -eq "1" ]; then
@@ -410,14 +449,16 @@ function stop_lttng_sessiond_opt()
        else
                out=1
                while [ -n "$out" ]; do
-                       out=$(pidof lt-$SESSIOND_BIN)
+                       out=$(pgrep --full lt-$SESSIOND_BIN)
                        sleep 0.5
                done
                out=1
                while [ -n "$out" ]; do
-                       out=$(pidof $CONSUMERD_BIN)
+                       out=$(pgrep --full $CONSUMERD_BIN)
                        sleep 0.5
                done
+
+               SESSIOND_PIDS=""
                if [ $withtap -eq "1" ]; then
                        pass "Kill session daemon"
                fi
@@ -434,20 +475,76 @@ function stop_lttng_sessiond_notap()
        stop_lttng_sessiond_opt 0 "$@"
 }
 
+function sigstop_lttng_sessiond_opt()
+{
+       local withtap=$1
+       local signal=SIGSTOP
+       local kill_opt=""
+
+       if [ -n $TEST_NO_SESSIOND ] && [ "$TEST_NO_SESSIOND" == "1" ]; then
+               # Env variable requested no session daemon
+               return
+       fi
+
+       PID_SESSIOND="$(pgrep --full lt-$SESSIOND_BIN) $(pgrep --full $RUNAS_BIN)"
+
+       kill_opt="$kill_opt -s $signal"
+
+       if [ $withtap -eq "1" ]; then
+               diag "Sending SIGSTOP to lt-$SESSIOND_BIN pids: $(echo $PID_SESSIOND | tr '\n' ' ')"
+       fi
+       kill $kill_opt $PID_SESSIOND 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
+
+       if [ $? -eq 1 ]; then
+               if [ $withtap -eq "1" ]; then
+                       fail "Sending SIGSTOP to session daemon"
+               fi
+       else
+               out=1
+               while [ $out -ne 0 ]; do
+                       pid=$(pgrep --full lt-$SESSIOND_BIN)
+
+                       # Wait until state becomes stopped for session
+                       # daemon(s).
+                       out=0
+                       for sessiond_pid in $pid; do
+                               state=$(ps -p $sessiond_pid -o state= )
+                               if [[ -n "$state" && "$state" != "T" ]]; then
+                                       out=1
+                               fi
+                       done
+                       sleep 0.5
+               done
+               if [ $withtap -eq "1" ]; then
+                       pass "Sending SIGSTOP to session daemon"
+               fi
+       fi
+}
+
+function sigstop_lttng_sessiond()
+{
+       sigstop_lttng_sessiond_opt 1 "$@"
+}
+
+function sigstop_lttng_sessiond_notap()
+{
+       sigstop_lttng_sessiond_opt 0 "$@"
+}
+
 function stop_lttng_consumerd_opt()
 {
        local withtap=$1
        local signal=$2
        local kill_opt=""
 
-       PID_CONSUMERD=`pidof $CONSUMERD_BIN`
+       PID_CONSUMERD=`pgrep --full $CONSUMERD_BIN`
 
        if [ -n "$2" ]; then
                kill_opt="$kill_opt -s $signal"
        fi
 
        if [ $withtap -eq "1" ]; then
-               diag "Killing lttng-consumerd (pid: $PID_CONSUMERD)"
+               diag "Killing $CONSUMERD_BIN pids: $(echo $PID_CONSUMERD | tr '\n' ' ')"
        fi
        kill $kill_opt $PID_CONSUMERD 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
        retval=$?
@@ -461,7 +558,7 @@ function stop_lttng_consumerd_opt()
        else
                out=1
                while [ $out -ne 0 ]; do
-                       pid=$(pidof $CONSUMERD_BIN)
+                       pid=$(pgrep --full $CONSUMERD_BIN)
 
                        # If consumerds are still present check their status.
                        # A zombie status qualifies the consumerd as *killed*
@@ -491,6 +588,61 @@ function stop_lttng_consumerd_notap()
        stop_lttng_consumerd_opt 0 "$@"
 }
 
+function sigstop_lttng_consumerd_opt()
+{
+       local withtap=$1
+       local signal=SIGSTOP
+       local kill_opt=""
+
+       PID_CONSUMERD=`pgrep --full $CONSUMERD_BIN`
+
+       kill_opt="$kill_opt -s $signal"
+
+       if [ $withtap -eq "1" ]; then
+               diag "Sending SIGSTOP to $CONSUMERD_BIN pids: $(echo $PID_CONSUMERD | tr '\n' ' ')"
+       fi
+       kill $kill_opt $PID_CONSUMERD 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
+       retval=$?
+       set +x
+
+       if [ $? -eq 1 ]; then
+               if [ $withtap -eq "1" ]; then
+                       fail "Sending SIGSTOP to consumer daemon"
+               fi
+               return 1
+       else
+               out=1
+               while [ $out -ne 0 ]; do
+                       pid=$(pgrep --full $CONSUMERD_BIN)
+
+                       # Wait until state becomes stopped for all
+                       # consumers.
+                       out=0
+                       for consumer_pid in $pid; do
+                               state=$(ps -p $consumer_pid -o state= )
+                               if [[ -n "$state" && "$state" != "T" ]]; then
+                                       out=1
+                               fi
+                       done
+                       sleep 0.5
+               done
+               if [ $withtap -eq "1" ]; then
+                       pass "Sending SIGSTOP to consumer daemon"
+               fi
+       fi
+       return $retval
+}
+
+function sigstop_lttng_consumerd()
+{
+       sigstop_lttng_consumerd_opt 1 "$@"
+}
+
+function sigstop_lttng_consumerd_notap()
+{
+       sigstop_lttng_consumerd_opt 0 "$@"
+}
+
 function list_lttng_with_opts ()
 {
        local opts=$1
@@ -517,7 +669,7 @@ function create_lttng_session ()
        ret=$?
        if [[ $expected_to_fail -eq "1" ]]; then
                test "$ret" -ne "0"
-               ok $? "Expected fail on session creation $sess_name in $trace_path"
+               ok $? "Create session $sess_name in $trace_path failed as expected"
        else
                ok $ret "Create session $sess_name in $trace_path"
        fi
@@ -536,16 +688,16 @@ function create_lttng_session_fail ()
 
 function enable_ust_lttng_channel ()
 {
-       local expect_fail=$1
+       local expected_to_fail=$1
        local sess_name=$2
        local channel_name=$3
        local opt=$4
 
        $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-channel -u $channel_name -s $sess_name $opt 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
        ret=$?
-       if [[ $expect_fail -eq "1" ]]; then
+       if [[ $expected_to_fail -eq "1" ]]; then
                test "$ret" -ne "0"
-               ok $? "Expected fail on ust channel creation $channel_name in $sess_name"
+               ok $? "Enable channel $channel_name for session $sess_name failed as expected"
        else
                ok $ret "Enable channel $channel_name for session $sess_name"
        fi
@@ -606,9 +758,9 @@ function enable_ust_lttng_event ()
        ret=$?
        if [[ $expected_to_fail -eq "1" ]]; then
                test $ret -ne "0"
-               ok $? "Enable ust event $event_name for session $session_name on channel $channel_name failed as expected"
+               ok $? "Enable ust event $event_name for session $session_name failed as expected"
        else
-               ok $ret "Enable event $event_name for session $sess_name"
+               ok $ret "Enable ust event $event_name for session $sess_name"
        fi
 }
 
@@ -810,7 +962,7 @@ function start_lttng_tracing ()
        ret=$?
        if [[ $expected_to_fail -eq "1" ]]; then
                test "$ret" -ne "0"
-               ok $? "Expected fail on start tracing for session: $sess_name"
+               ok $? "Start tracing for session $sess_name failed as expected"
        else
                ok $ret "Start tracing for session $sess_name"
        fi
@@ -835,7 +987,7 @@ function stop_lttng_tracing ()
        ret=$?
        if [[ $expected_to_fail -eq "1" ]]; then
                test "$ret" -ne "0"
-               ok $? "Expected fail on stop tracing for session: $sess_name"
+               ok $? "Stop lttng tracing for session $sess_name failed as expected"
        else
                ok $ret "Stop lttng tracing for session $sess_name"
        fi
@@ -860,7 +1012,7 @@ function destroy_lttng_session ()
        ret=$?
        if [[ $expected_to_fail -eq "1" ]]; then
                test "$ret" -ne "0"
-               ok $? "Expected fail on session deletion $sess_name"
+               ok $? "Destroy session $sess_name failed as expected"
        else
                ok $ret "Destroy session $sess_name"
        fi
@@ -894,7 +1046,7 @@ function lttng_snapshot_add_output ()
        ret=$?
        if [[ $expected_to_fail -eq 1 ]]; then
                test "$ret" -ne "0"
-               ok $? "Failed to add a  snapshot output file://$trace_path as expected"
+               ok $? "Added snapshot output file://$trace_path failed as expected"
        else
                ok $ret "Added snapshot output file://$trace_path"
        fi
@@ -920,7 +1072,7 @@ function lttng_snapshot_del_output ()
        ret=$?
        if [[ $expected_to_fail -eq "1" ]]; then
                test "$ret" -ne "0"
-               ok $? "Expect fail on deletion of snapshot output id $id"
+               ok $? "Deleted snapshot output id $id failed as expected"
        else
                ok $ret "Deleted snapshot output id $id"
        fi
@@ -958,7 +1110,7 @@ function lttng_save()
        local opts=$2
 
        $TESTDIR/../src/bin/lttng/$LTTNG_BIN save $sess_name $opts 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
-       ok $? "Session successfully saved"
+       ok $? "Session saved"
 }
 
 function lttng_load()
@@ -966,7 +1118,7 @@ function lttng_load()
        local opts=$1
 
        $TESTDIR/../src/bin/lttng/$LTTNG_BIN load $opts 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
-       ok $? "Load command successful"
+       ok $? "Load command with opts: $opts"
 }
 
 function lttng_track()
@@ -979,7 +1131,7 @@ function lttng_track()
                test $ret -ne "0"
                ok $? "Track command failed as expected with opts: $opts"
        else
-               ok $ret "Track command success as expected with opts: $opts"
+               ok $ret "Track command with opts: $opts"
        fi
 }
 
@@ -1003,7 +1155,7 @@ function lttng_untrack()
                test $ret -ne "0"
                ok $? "Untrack command failed as expected with opts: $opts"
        else
-               ok $ret "Untrack command success as expected with opts: $opts"
+               ok $ret "Untrack command with opts: $opts"
        fi
 }
 
@@ -1179,3 +1331,37 @@ function validate_trace_empty()
        ret=$?
        return $ret
 }
+
+function metadata_regenerate ()
+{
+       local expected_to_fail=$1
+       local sess_name=$2
+
+       $TESTDIR/../src/bin/lttng/$LTTNG_BIN metadata regenerate -s $sess_name 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
+       ret=$?
+       if [[ $expected_to_fail -eq "1" ]]; then
+               test "$ret" -ne "0"
+               ok $? "Expected fail on regenerate $sess_name"
+       else
+               ok $ret "Metadata regenerate $sess_name"
+       fi
+}
+
+function metadata_regenerate_ok ()
+{
+       metadata_regenerate 0 "$@"
+}
+
+function metadata_regenerate_fail ()
+{
+       metadata_regenerate 1 "$@"
+}
+
+function destructive_tests_enabled ()
+{
+       if [ ${LTTNG_ENABLE_DESTRUCTIVE_TESTS} = "will-break-my-system" ]; then
+               return 0
+       else
+               return 1
+       fi
+}
This page took 0.030665 seconds and 4 git commands to generate.