+
+function validate_directory_empty ()
+{
+ local trace_path="$1"
+
+ # Do not double quote `$trace_path` below as we want wildcards to be
+ # expanded.
+ files="$(ls -A $trace_path)"
+ ret=$?
+ if [ $ret -ne 0 ]; then
+ fail "Failed to list content of directory \"$trace_path\""
+ return $ret
+ fi
+
+ nb_files="$(echo -n "$files" | wc -l)"
+ ok $nb_files "Directory \"$trace_path\" is empty"
+}
+
+function validate_trace_session_ust_empty()
+{
+ validate_directory_empty "$1"/ust
+}
+
+function validate_trace_session_kernel_empty()
+{
+ validate_trace_empty "$1"/kernel
+}
+
+function regenerate_metadata ()
+{
+ local expected_to_fail=$1
+ local sess_name=$2
+
+ $TESTDIR/../src/bin/lttng/$LTTNG_BIN regenerate metadata -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 metadata $sess_name"
+ else
+ ok $ret "Metadata regenerate $sess_name"
+ fi
+}
+
+function regenerate_metadata_ok ()
+{
+ regenerate_metadata 0 "$@"
+}
+
+function regenerate_metadata_fail ()
+{
+ regenerate_metadata 1 "$@"
+}
+
+function regenerate_statedump ()
+{
+ local expected_to_fail=$1
+ local sess_name=$2
+
+ $TESTDIR/../src/bin/lttng/$LTTNG_BIN regenerate statedump -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 statedump $sess_name"
+ else
+ ok $ret "Statedump regenerate $sess_name"
+ fi
+}
+
+function regenerate_statedump_ok ()
+{
+ regenerate_statedump 0 "$@"
+}
+
+function regenerate_statedump_fail ()
+{
+ regenerate_statedump 1 "$@"
+}
+
+function rotate_session ()
+{
+ local expected_to_fail=$1
+ local sess_name=$2
+
+ $TESTDIR/../src/bin/lttng/$LTTNG_BIN rotate $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 rotate session $sess_name"
+ else
+ ok $ret "Rotate session $sess_name"
+ fi
+}
+
+function rotate_session_ok ()
+{
+ rotate_session 0 "$@"
+}
+
+function rotate_session_fail ()
+{
+ rotate_session 1 "$@"
+}
+
+function destructive_tests_enabled ()
+{
+ if [ "$LTTNG_ENABLE_DESTRUCTIVE_TESTS" = "will-break-my-system" ]; then
+ return 0
+ else
+ return 1
+ fi
+}
+
+function lttng_enable_rotation_timer ()
+{
+ local expected_to_fail=$1
+ local sess_name=$2
+ local period=$3
+
+ $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-rotation -s $sess_name --timer $period 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
+ ret=$?
+ if [[ $expected_to_fail -eq "1" ]]; then
+ test "$ret" -ne "0"
+ ok $? "Expected fail when setting periodic rotation ($period) of session $sess_name"
+ else
+ ok $ret "Set periodic rotation ($period) of session $sess_name"
+ fi
+}
+
+function lttng_enable_rotation_timer_ok ()
+{
+ lttng_enable_rotation_timer 0 $@
+}
+
+function lttng_enable_rotation_timer_fail ()
+{
+ lttng_enable_rotation_timer 1 $@
+}
+
+function lttng_enable_rotation_size ()
+{
+ local expected_to_fail=$1
+ local sess_name=$2
+ local size=$3
+
+ $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-rotation -s $sess_name --size $size 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
+ ret=$?
+ if [[ $expected_to_fail -eq "1" ]]; then
+ test "$ret" -ne "0"
+ ok $? "Expected fail on rotate session $sess_name"
+ else
+ ok $ret "Rotate session $sess_name"
+ fi
+}
+
+function lttng_enable_rotation_size_ok ()
+{
+ lttng_enable_rotation_size 0 $@
+}
+
+function lttng_enable_rotation_size_fail ()
+{
+ lttng_enable_rotation_size 1 $@
+}
+
+function lttng_clear_session ()
+{
+ local expected_to_fail=$1
+ local sess_name=$2
+
+ $TESTDIR/../src/bin/lttng/$LTTNG_BIN clear $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 clear session $sess_name"
+ else
+ ok $ret "Clear session $sess_name"
+ fi
+}
+
+function lttng_clear_session_ok ()
+{
+ lttng_clear_session 0 $@
+}
+
+function lttng_clear_session_fail ()
+{
+ lttng_clear_session 1 $@
+}
+
+function lttng_clear_all ()
+{
+ $TESTDIR/../src/bin/lttng/$LTTNG_BIN clear --all 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
+ ok $? "Clear all lttng sessions"
+}
+
+function lttng_add_trigger()
+{
+ local expected_to_fail="$1"
+ local trigger_name="$2"
+ shift 2
+ local args=("$@")
+
+ diag "$TESTDIR/../src/bin/lttng/$LTTNG_BIN add-trigger --name $trigger_name ${args[*]}"
+ $TESTDIR/../src/bin/lttng/$LTTNG_BIN add-trigger --name "$trigger_name" "${args[@]}" 1> /dev/null 2> /dev/null
+ ret=$?
+ if [[ $expected_to_fail -eq "1" ]]; then
+ test "$ret" -ne "0"
+ ok $? "Add trigger $trigger_name failed as expected"
+ else
+ ok $ret "Add trigger $trigger_name"
+ fi
+}
+
+function lttng_remove_trigger()
+{
+ local expected_to_fail="$1"
+ local trigger_name="$2"
+ shift 2
+
+ diag "$TESTDIR/../src/bin/lttng/$LTTNG_BIN remove-trigger $trigger_name $*"
+ "$TESTDIR/../src/bin/lttng/$LTTNG_BIN" remove-trigger "$trigger_name" "$@" 1> /dev/null 2> /dev/null
+ ret=$?
+ if [[ $expected_to_fail -eq "1" ]]; then
+ test "$ret" -ne "0"
+ ok $? "Remove trigger $trigger_name failed as expected"
+ else
+ ok $ret "Remove trigger $trigger_name"
+ fi
+}
+
+function lttng_add_trigger_ok()
+{
+ lttng_add_trigger 0 "$@"
+}
+
+function lttng_add_trigger_fail()
+{
+ lttng_add_trigger 1 "$@"
+}
+
+function lttng_remove_trigger_ok()
+{
+ lttng_remove_trigger 0 "$@"
+}
+
+function validate_path_pattern ()
+{
+ local message=$1
+ local pattern=$2
+ # Base path is only used in error case and is used to list the content
+ # of the base path.
+ local base_path=$3
+
+
+ [ -f $pattern ]
+ ret=$?
+ ok $ret "$message"
+
+ if [ "$ret" -ne "0" ]; then
+ diag "Path pattern expected: $pattern"
+ # List the tracepath for more info. We use find as a recursive
+ # directory lister.
+ diag "The base path content:"
+ find "$base_path" -print
+ fi
+}
+
+function validate_trace_path_ust_uid ()
+{
+ local trace_path=$1
+ local session_name=$2
+ local uid=$UID
+ local pattern="$trace_path/$session_name-$date_time_pattern/ust/uid/$uid/${system_long_bit_size}-bit/metadata"
+
+ validate_path_pattern "UST per-uid trace path is valid" "$pattern" "$trace_path"
+}
+
+function validate_trace_path_ust_uid_network ()
+{
+ local trace_path=$1
+ local session_name=$2
+ local base_path=$3
+ local uid=$UID
+ local hostname=$HOSTNAME
+ local pattern
+ local ret
+
+ # If the session was given a network base path (e.g
+ # 127.0.0.1/my/custom/path on creation, there is no session name
+ # component to the path on the relayd side. Caller can simply not pass a
+ # session name for this scenario.
+ if [ -n "$session_name" ]; then
+ session_name="$session_name-$date_time_pattern"
+ if [ -n "$base_path" ]; then
+ fail "Session name and base path are mutually exclusive"
+ return
+ fi
+ fi
+
+ pattern="$trace_path/$hostname/$base_path/$session_name/ust/uid/$uid/${system_long_bit_size}-bit/metadata"
+
+ validate_path_pattern "UST per-uid network trace path is valid" "$pattern" "$trace_path"
+}
+
+function validate_trace_path_ust_uid_snapshot_network ()
+{
+ local trace_path=$1
+ local session_name=$2
+ local snapshot_name=$3
+ local snapshot_number=$4
+ local base_path=$5
+ local hostname=$HOSTNAME
+ local uid=$UID
+ local pattern
+ local ret
+
+ # If the session/output was given a network base path (e.g
+ # 127.0.0.1/my/custom/path on creation, there is no session name
+ # component to the path on the relayd side. Caller can simply not pass a
+ # session name for this scenario.
+ if [ -n "$session_name" ]; then
+ session_name="$session_name-$date_time_pattern"
+ if [ -n "$base_path" ]; then
+ fail "Session name and base path are mutually exclusive"
+ return
+ fi
+ fi
+
+ pattern="$trace_path/$hostname/$base_path/$session_name/$snapshot_name-$date_time_pattern-$snapshot_number/ust/uid/$uid/${system_long_bit_size}-bit/metadata"
+
+ validate_path_pattern "UST per-uid network snapshot trace path is valid" "$pattern" "$trace_path"
+}
+
+function validate_trace_path_ust_uid_snapshot ()
+{
+ local trace_path=$1
+ local session_name=$2
+ local snapshot_name=$3
+ local snapshot_number=$4
+ local base_path=$5
+ local uid=$UID
+ local pattern
+ local ret
+
+ # If the session/output was given a network base path (e.g
+ # 127.0.0.1/my/custom/path) on creation, there is no session name
+ # component to the path on the relayd side. Caller can simply not pass a
+ # session name for this scenario.
+ if [ -n "$session_name" ]; then
+ session_name="$session_name-$date_time_pattern"
+ if [ -n "$base_path" ]; then
+ fail "Session name and base path are mutually exclusive"
+ return
+ fi
+ fi
+
+ pattern="$trace_path/$base_path/$session_name/$snapshot_name-$date_time_pattern-$snapshot_number/ust/uid/$uid/${system_long_bit_size}-bit/metadata"
+
+ validate_path_pattern "UST per-uid snapshot trace path is valid" "$pattern" "$trace_path"
+}
+
+function validate_trace_path_ust_pid ()
+{
+ local trace_path=$1
+ local session_name=$2
+ local app_string=$3
+ local pid=$4
+ local pattern
+ local ret
+
+ # If the session was given a trace path on creation, there is no session
+ # name component to the path. Caller can simply not pass a session name
+ # for this scenario.
+ if [ -n "$session_name" ]; then
+ session_name="$session_name-$date_time_pattern"
+ fi
+
+ pattern="$trace_path/$session_name/ust/pid/$pid/$app_string-*-$date_time_pattern/metadata"
+
+ validate_path_pattern "UST per-pid trace path is valid" "$pattern" "$trace_path"
+}
+
+function validate_trace_path_kernel ()
+{
+ local trace_path=$1
+ local session_name=$2
+ local pattern
+
+ # If the session was given a trace path on creation, there is no session
+ # name component to the path. Caller can simply not pass a session name
+ # for this scenario.
+ if [ -n "$session_name" ]; then
+ session_name="$session_name-$date_time_pattern"
+ fi
+
+ pattern="$trace_path/$session_name/kernel/metadata"
+
+ validate_path_pattern "Kernel trace path is valid" "$pattern" "$trace_path"
+}
+
+function validate_trace_path_kernel_network ()
+{
+ local trace_path=$1
+ local session_name=$2
+ local hostname=$HOSTNAME
+ local pattern="$trace_path/$hostname/$session_name-$date_time_pattern/kernel/metadata"
+
+ validate_path_pattern "Kernel network trace path is valid" "$pattern" "$trace_path"
+}
+
+function validate_trace_path_kernel_snapshot ()
+{
+ local trace_path=$1
+ local session_name=$2
+ local snapshot_name=$3
+ local snapshot_number=$4
+ local base_path=$5
+ local pattern
+ local ret
+
+ # If the session/output was given a network base path (e.g
+ # 127.0.0.1/my/custom/path on creation, there is no session name
+ # component to the path on the relayd side. Caller can simply not pass a
+ # session name for this scenario.
+ if [ -n "$session_name" ]; then
+ session_name="$session_name-$date_time_pattern"
+ if [ -n "$base_path" ]; then
+ fail "Session name and base path are mutually exclusive"
+ return
+ fi
+ fi
+
+ pattern="$trace_path/$base_path/$session_name/$snapshot_name-$date_time_pattern-$snapshot_number/kernel/metadata"
+
+ validate_path_pattern "Kernel snapshot trace path is valid" "$pattern" "$trace_path"
+}
+
+function validate_trace_path_kernel_snapshot_network ()
+{
+ local trace_path=$1
+ local session_name=$2
+ local snapshot_name=$3
+ local snapshot_number=$4
+ local base_path=$5
+ local hostname=$HOSTNAME
+ local pattern
+ local ret
+
+ # If the session/output was given a network base path (e.g
+ # 127.0.0.1/my/custom/path on creation, there is no session name
+ # component to the path on the relayd side. Caller can simply not pass a
+ # session name for this scenario.
+ if [ -n "$session_name" ]; then
+ session_name="$session_name-$date_time_pattern"
+ if [ -n "$base_path" ]; then
+ fail "Session name and base path are mutually exclusive"
+ return
+ fi
+ fi
+
+ pattern="$trace_path/$hostname/$base_path/$session_name/$snapshot_name-$date_time_pattern-$snapshot_number/kernel/metadata"
+
+ validate_path_pattern "Kernel network snapshot trace path is valid" "$pattern" "$trace_path"
+}