tests: test kernel snapshot with discard buffers
[lttng-tools.git] / tests / utils / utils.sh
index 42b344138d9f176ef2fcb39e37fbec9acc2e994b..da2efe91a72264b93cd5c67b8d46cf28c53408d2 100644 (file)
 # 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301 USA
 
 SESSIOND_BIN="lttng-sessiond"
+SESSIOND_MATCH=".*lttng-sess.*"
+SESSIOND_PIDS=""
+RUNAS_BIN="lttng-runas"
+RUNAS_MATCH=".*lttng-runas.*"
 CONSUMERD_BIN="lttng-consumerd"
+CONSUMERD_MATCH=".*lttng-consumerd.*"
 RELAYD_BIN="lttng-relayd"
+RELAYD_MATCH=".*lttng-relayd.*"
+RELAYD_PIDS=""
 LTTNG_BIN="lttng"
 BABELTRACE_BIN="babeltrace"
 OUTPUT_DEST=/dev/null
@@ -33,8 +40,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 +111,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
 }
 
@@ -269,7 +308,7 @@ function start_lttng_relayd_opt()
 
        DIR=$(readlink -f $TESTDIR)
 
-       if [ -z $(pgrep --full lt-$RELAYD_BIN) ]; then
+       if [ -z $(pgrep $RELAYD_MATCH) ]; 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 +324,8 @@ function start_lttng_relayd_opt()
        else
                pass "Start lttng-relayd (opt: $opt)"
        fi
+
+       RELAYD_PIDS=$(pgrep $RELAYD_MATCH)
 }
 
 function start_lttng_relayd()
@@ -301,12 +342,10 @@ function stop_lttng_relayd_opt()
 {
        local withtap=$1
 
-       PID_RELAYD=`pgrep --full 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 +356,14 @@ function stop_lttng_relayd_opt()
        else
                out=1
                while [ -n "$out" ]; do
-                       out=$(pgrep --full lt-$RELAYD_BIN)
+                       out=$(pgrep $RELAYD_MATCH)
                        sleep 0.5
                done
                if [ $withtap -eq "1" ]; then
                        pass "Kill relay daemon"
                fi
        fi
+       RELAYD_PIDS=""
        return $retval
 }
 
@@ -359,7 +399,7 @@ function start_lttng_sessiond_opt()
        : ${LTTNG_SESSION_CONFIG_XSD_PATH=${DIR}/../src/common/config/}
        export LTTNG_SESSION_CONFIG_XSD_PATH
 
-       if [ -z $(pgrep --full lt-$SESSIOND_BIN) ]; then
+       if [ -z $(pgrep ${SESSIOND_MATCH}) ]; then
                # Have a load path ?
                if [ -n "$load_path" ]; then
                        $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"
@@ -372,6 +412,7 @@ function start_lttng_sessiond_opt()
                        ok $status "Start session daemon"
                fi
        fi
+       SESSIOND_PIDS=$(pgrep $SESSIOND_MATCH)
 }
 
 function start_lttng_sessiond()
@@ -395,13 +436,15 @@ function stop_lttng_sessiond_opt()
                return
        fi
 
-       PID_SESSIOND=`pgrep --full lt-$SESSIOND_BIN`
+       local pids="${SESSIOND_PIDS} $(pgrep $RUNAS_MATCH)"
 
        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 $SESSIOND_BIN and 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 +453,16 @@ function stop_lttng_sessiond_opt()
        else
                out=1
                while [ -n "$out" ]; do
-                       out=$(pgrep --full lt-$SESSIOND_BIN)
+                       out=$(pgrep ${SESSIOND_MATCH})
                        sleep 0.5
                done
                out=1
                while [ -n "$out" ]; do
-                       out=$(pgrep --full $CONSUMERD_BIN)
+                       out=$(pgrep $CONSUMERD_MATCH)
                        sleep 0.5
                done
+
+               SESSIOND_PIDS=""
                if [ $withtap -eq "1" ]; then
                        pass "Kill session daemon"
                fi
@@ -434,20 +479,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 ${SESSIOND_MATCH}) $(pgrep $RUNAS_MATCH)"
+
+       kill_opt="$kill_opt -s $signal"
+
+       if [ $withtap -eq "1" ]; then
+               diag "Sending SIGSTOP to lt-$SESSIOND_BIN and $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 $SESSIOND_MATCH)
+
+                       # 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=`pgrep --full $CONSUMERD_BIN`
+       PID_CONSUMERD=$(pgrep $CONSUMERD_MATCH)
 
        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 +562,7 @@ function stop_lttng_consumerd_opt()
        else
                out=1
                while [ $out -ne 0 ]; do
-                       pid=$(pgrep --full $CONSUMERD_BIN)
+                       pid=$(pgrep $CONSUMERD_MATCH)
 
                        # If consumerds are still present check their status.
                        # A zombie status qualifies the consumerd as *killed*
@@ -491,6 +592,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 $CONSUMERD_MATCH)
+
+       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 $CONSUMERD_MATCH)
+
+                       # 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
@@ -579,6 +735,24 @@ function enable_lttng_mmap_overwrite_kernel_channel()
        ok $? "Enable channel $channel_name for session $sess_name"
 }
 
+function enable_lttng_mmap_discard_small_kernel_channel()
+{
+       local sess_name=$1
+       local channel_name=$2
+
+       $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-channel -s $sess_name $channel_name -k --output mmap --discard --subbuf-size=$(getconf PAGE_SIZE) --num-subbuf=2 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
+       ok $? "Enable small discard channel $channel_name for session $sess_name"
+}
+
+function enable_lttng_mmap_overwrite_small_kernel_channel()
+{
+       local sess_name=$1
+       local channel_name=$2
+
+       $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-channel -s $sess_name $channel_name -k --output mmap --overwrite --subbuf-size=$(getconf PAGE_SIZE) --num-subbuf=2 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
+       ok $? "Enable small discard channel $channel_name for session $sess_name"
+}
+
 function enable_lttng_mmap_overwrite_ust_channel()
 {
        local sess_name=$1
@@ -1068,7 +1242,7 @@ function trace_matches ()
 
        if [ "$count" -ne "$nr_iter" ]; then
                fail "Trace match"
-               diag "$count events found in trace"
+               diag "$count matching events found in trace"
        else
                pass "Trace match"
        fi
@@ -1120,6 +1294,18 @@ function validate_trace
        return $ret
 }
 
+function trace_first_line
+{
+       local trace_path=$1
+
+       which $BABELTRACE_BIN >/dev/null
+       if [ $? -ne 0 ]; then
+           skip 0 "Babeltrace binary not found. Skipping trace validation"
+       fi
+
+       $BABELTRACE_BIN $trace_path 2>/dev/null | head -n 1
+}
+
 function validate_trace_exp()
 {
        local event_exp=$1
@@ -1179,3 +1365,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.027647 seconds and 4 git commands to generate.