+
+function enable_ust_lttng_channel_ok ()
+{
+ enable_ust_lttng_channel 1 0 "$@"
+}
+
+function enable_ust_lttng_channel_fail ()
+{
+ enable_ust_lttng_channel 1 1 "$@"
+}
+
+function enable_ust_lttng_channel_notap ()
+{
+ enable_ust_lttng_channel 0 0 "$@"
+}
+
+function disable_ust_lttng_channel()
+{
+ local sess_name=$1
+ local channel_name=$2
+
+ _run_lttng_cmd "$OUTPUT_DEST" "$ERROR_OUTPUT_DEST" \
+ disable-channel -u $channel_name -s $sess_name
+ ok $? "Disable channel $channel_name for session $sess_name"
+}
+
+function enable_lttng_mmap_overwrite_kernel_channel()
+{
+ local sess_name=$1
+ local channel_name=$2
+
+ _run_lttng_cmd "$OUTPUT_DEST" "$ERROR_OUTPUT_DEST" \
+ enable-channel -s $sess_name $channel_name -k --output mmap --overwrite
+ 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
+
+ _run_lttng_cmd "$OUTPUT_DEST" "$ERROR_OUTPUT_DEST" \
+ enable-channel -s $sess_name $channel_name -k --output mmap --discard --subbuf-size=$(getconf PAGE_SIZE) --num-subbuf=2
+ 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
+
+ _run_lttng_cmd "$OUTPUT_DEST" "$ERROR_OUTPUT_DEST" \
+ enable-channel -s $sess_name $channel_name -k --output mmap --overwrite --subbuf-size=$(getconf PAGE_SIZE) --num-subbuf=2
+ ok $? "Enable small discard channel $channel_name for session $sess_name"
+}
+
+function enable_lttng_mmap_overwrite_ust_channel()
+{
+ local sess_name=$1
+ local channel_name=$2
+
+ _run_lttng_cmd "$OUTPUT_DEST" "$ERROR_OUTPUT_DEST" \
+ enable-channel -s $sess_name $channel_name -u --output mmap --overwrite
+ ok $? "Enable channel $channel_name for session $sess_name"
+}
+
+function enable_ust_lttng_event ()
+{
+ local withtap=$1
+ local expected_to_fail=$2
+ local sess_name=$3
+ local event_name="$4"
+ local channel_name=$5
+
+ if [ -z $channel_name ]; then
+ # default channel if none specified
+ chan=""
+ else
+ chan="-c $channel_name"
+ fi
+
+ _run_lttng_cmd "$OUTPUT_DEST" "$ERROR_OUTPUT_DEST" \
+ enable-event "$event_name" $chan -s "$sess_name" -u
+ ret=$?
+ if [[ $expected_to_fail -eq "1" ]]; then
+ test $ret -ne "0"
+ ret=$?
+ if [[ $withtap -eq "1" ]]; then
+ ok $ret "Enable ust event $event_name for session $session_name failed as expected"
+ fi
+ else
+ if [[ $withtap -eq "1" ]]; then
+ ok $ret "Enable ust event $event_name for session $sess_name"
+ fi
+ fi
+ return $ret
+}
+
+function enable_ust_lttng_event_ok ()
+{
+ enable_ust_lttng_event 1 0 "$@"
+}
+
+function enable_ust_lttng_event_fail ()
+{
+ enable_ust_lttng_event 1 1 "$@"
+}
+
+function enable_ust_lttng_event_notap ()
+{
+ enable_ust_lttng_event 0 0 "$@"
+}
+
+function enable_jul_lttng_event()
+{
+ sess_name=$1
+ event_name="$2"
+ channel_name=$3
+
+ if [ -z $channel_name ]; then
+ # default channel if none specified
+ chan=""
+ else
+ chan="-c $channel_name"
+ fi
+
+ _run_lttng_cmd "$OUTPUT_DEST" "$ERROR_OUTPUT_DEST" \
+ enable-event "$event_name" $chan -s $sess_name -j
+ ok $? "Enable JUL event $event_name for session $sess_name"
+}
+
+function enable_jul_lttng_event_loglevel()
+{
+ local sess_name=$1
+ local event_name="$2"
+ local loglevel=$3
+ local channel_name=$4
+
+ if [ -z $channel_name ]; then
+ # default channel if none specified
+ chan=""
+ else
+ chan="-c $channel_name"
+ fi
+
+ _run_lttng_cmd "$OUTPUT_DEST" "$ERROR_OUTPUT_DEST" \
+ enable-event --loglevel $loglevel "$event_name" $chan -s $sess_name -j
+ ok $? "Enable JUL event $event_name for session $sess_name with loglevel $loglevel"
+}
+
+function enable_log4j_lttng_event()
+{
+ local sess_name=$1
+ local event_name=$2
+ local channel_name=$3
+
+ local chan_opt=()
+
+ # default channel if none specified
+ if [ -n "$channel_name" ]; then
+ chan_opt=("-c" "$channel_name")
+ fi
+
+ _run_lttng_cmd "$OUTPUT_DEST" "$ERROR_OUTPUT_DEST" \
+ enable-event "$event_name" "${chan_opt[@]}" -s "$sess_name" --log4j
+ ok $? "Enable LOG4J event '$event_name' for session '$sess_name'"
+}
+
+function enable_log4j_lttng_event_filter()
+{
+ local sess_name=$1
+ local event_name=$2
+ local filter=$3
+
+ _run_lttng_cmd "$OUTPUT_DEST" "$ERROR_OUTPUT_DEST" \
+ enable-event "$event_name" -s "$sess_name" --log4j --filter "$filter"
+ ok $? "Enable LOG4J event '$event_name' with filter '$filter' for session '$sess_name'"
+}
+
+function enable_log4j_lttng_event_filter_loglevel_only()
+{
+ local sess_name=$1
+ local event_name=$2
+ local filter=$3
+ local loglevel=$4
+
+ _run_lttng_cmd "$OUTPUT_DEST" "$ERROR_OUTPUT_DEST" \
+ enable-event --loglevel-only "$loglevel" "$event_name" -s "$sess_name" -l --filter "$filter"
+ ok $? "Enable LOG4J event '$event_name' with filter '$filter' and loglevel-only '$loglevel' for session '$sess_name'"
+}
+
+function enable_log4j_lttng_event_loglevel()
+{
+ local sess_name=$1
+ local event_name=$2
+ local loglevel=$3
+ local channel_name=$4
+
+
+ # default channel if none specified
+ if [ -n "$channel_name" ]; then
+ chan_opt=("-c" "$channel_name")
+ fi
+
+ _run_lttng_cmd "$OUTPUT_DEST" "$ERROR_OUTPUT_DEST" \
+ enable-event --loglevel "$loglevel" "$event_name" "${chan_opt[@]}" -s "$sess_name" --log4j
+ ok $? "Enable LOG4J event '$event_name' for session '$sess_name' with loglevel '$loglevel'"
+}
+
+function enable_log4j_lttng_event_loglevel_only()
+{
+ local sess_name=$1
+ local event_name=$2
+ local loglevel=$3
+ local channel_name=$4
+
+ local chan_opt=()
+
+ # default channel if none specified
+ if [ -n "$channel_name" ]; then
+ chan_opt=("-c" "$channel_name")
+ fi
+
+ _run_lttng_cmd "$OUTPUT_DEST" "$ERROR_OUTPUT_DEST" \
+ enable-event --loglevel-only "$loglevel" "$event_name" "${chan_opt[@]}" -s "$sess_name" --log4j
+ ok $? "Enable LOG4J event '$event_name' for session '$sess_name' with loglevel-only '$loglevel'"
+}
+
+function enable_python_lttng_event()
+{
+ sess_name=$1
+ event_name="$2"
+ channel_name=$3
+
+ if [ -z $channel_name ]; then
+ # default channel if none specified
+ chan=""
+ else
+ chan="-c $channel_name"
+ fi
+
+ _run_lttng_cmd "$OUTPUT_DEST" "$ERROR_OUTPUT_DEST" \
+ enable-event "$event_name" $chan -s $sess_name -p
+ ok $? "Enable Python event $event_name for session $sess_name"
+}
+
+function enable_python_lttng_event_loglevel()
+{
+ local sess_name=$1
+ local event_name="$2"
+ local loglevel=$3
+ local channel_name=$4
+
+ if [ -z $channel_name ]; then
+ # default channel if none specified
+ chan=""
+ else
+ chan="-c $channel_name"
+ fi
+
+ _run_lttng_cmd "$OUTPUT_DEST" "$ERROR_OUTPUT_DEST" \
+ enable-event --loglevel $loglevel "$event_name" $chan -s $sess_name -p
+ ok $? "Enable Python event $event_name for session $sess_name with loglevel $loglevel"
+}
+
+function enable_ust_lttng_event_filter()
+{
+ local sess_name="$1"
+ local event_name="$2"
+ local filter="$3"
+ local channel_name=$4
+
+ if [ -z $channel_name ]; then
+ # default channel if none specified
+ chan=""
+ else
+ chan="-c $channel_name"
+ fi
+
+ _run_lttng_cmd "$OUTPUT_DEST" "$ERROR_OUTPUT_DEST" \
+ enable-event $chan "$event_name" -s $sess_name -u --filter "$filter"
+ ok $? "Enable event $event_name with filtering for session $sess_name"
+}
+
+function enable_ust_lttng_event_loglevel()
+{
+ local sess_name="$1"
+ local event_name="$2"
+ local loglevel="$3"
+
+ _run_lttng_cmd "$OUTPUT_DEST" "$ERROR_OUTPUT_DEST" \
+ enable-event "$event_name" -s $sess_name -u --loglevel $loglevel
+ ok $? "Enable event $event_name with loglevel $loglevel"
+}
+
+function enable_ust_lttng_event_loglevel_only()
+{
+ local sess_name="$1"
+ local event_name="$2"
+ local loglevel="$3"
+
+ _run_lttng_cmd "$OUTPUT_DEST" "$ERROR_OUTPUT_DEST" \
+ enable-event "$event_name" -s $sess_name -u --loglevel-only $loglevel
+ ok $? "Enable event $event_name with loglevel-only $loglevel"
+}
+
+function disable_ust_lttng_event ()
+{
+ local sess_name="$1"
+ local event_name="$2"
+ local channel_name="$3"
+
+ if [ -z $channel_name ]; then
+ # default channel if none specified
+ chan=""
+ else
+ chan="-c $channel_name"
+ fi
+
+ _run_lttng_cmd "$OUTPUT_DEST" "$ERROR_OUTPUT_DEST" \
+ disable-event "$event_name" -s $sess_name $chan -u
+ ok $? "Disable event $event_name for session $sess_name"
+}
+
+function disable_jul_lttng_event ()
+{
+ local sess_name="$1"
+ local event_name="$2"
+
+ $TESTDIR/../src/bin/lttng/$LTTNG_BIN disable-event "$event_name" -s $sess_name -j >/dev/null 2>&1
+ ok $? "Disable JUL event $event_name for session $sess_name"
+}
+
+function disable_log4j_lttng_event ()
+{
+ local sess_name="$1"
+ local event_name="$2"
+
+ _run_lttng_cmd "$OUTPUT_DEST" "$ERROR_OUTPUT_DEST" \
+ disable-event "$event_name" -s "$sess_name" --log4j
+ ok $? "Disable LOG4J event '$event_name' for session '$sess_name'"
+}
+
+function disable_python_lttng_event ()
+{
+ local sess_name="$1"
+ local event_name="$2"
+
+ _run_lttng_cmd "$OUTPUT_DEST" "$ERROR_OUTPUT_DEST" \
+ disable-event "$event_name" -s $sess_name -p
+ ok $? "Disable Python event $event_name for session $sess_name"
+}
+
+function start_lttng_tracing_opt ()
+{
+ local withtap=$1
+ local expected_to_fail=$2
+ local sess_name=$3
+
+ _run_lttng_cmd "$OUTPUT_DEST" "$ERROR_OUTPUT_DEST" \
+ start $sess_name
+ ret=$?
+ if [[ $expected_to_fail -eq "1" ]]; then
+ test "$ret" -ne "0"
+ ret=$?
+ if [ $withtap -eq "1" ]; then
+ ok $? "Start tracing for session $sess_name failed as expected"
+ fi
+ else
+ if [ $withtap -eq "1" ]; then
+ ok $ret "Start tracing for session $sess_name"
+ fi
+ fi
+}
+
+function start_lttng_tracing_ok ()
+{
+ start_lttng_tracing_opt 1 0 "$@"
+}
+
+function start_lttng_tracing_fail ()
+{
+ start_lttng_tracing_opt 1 1 "$@"
+}
+
+function start_lttng_tracing_notap ()
+{
+ start_lttng_tracing_opt 0 1 "$@"
+}
+
+function stop_lttng_tracing_opt ()
+{
+ local withtap=$1
+ local expected_to_fail=$2
+ local sess_name=$3
+
+ _run_lttng_cmd "$OUTPUT_DEST" "$ERROR_OUTPUT_DEST" \
+ stop $sess_name
+ ret=$?
+ if [[ $expected_to_fail -eq "1" ]]; then
+ test "$ret" -ne "0"
+ ret=$?
+ if [ $withtap -eq "1" ]; then
+ ok $? "Stop lttng tracing for session $sess_name failed as expected"
+ fi
+ else
+ if [ $withtap -eq "1" ]; then
+ ok $ret "Stop lttng tracing for session $sess_name"
+ fi
+ fi
+}
+
+function stop_lttng_tracing_ok ()
+{
+ stop_lttng_tracing_opt 1 0 "$@"
+}
+
+function stop_lttng_tracing_fail ()
+{
+ stop_lttng_tracing_opt 1 1 "$@"
+}
+
+function stop_lttng_tracing_notap ()
+{
+ stop_lttng_tracing_opt 0 0 "$@"
+}
+
+function destroy_lttng_session ()
+{
+ local withtap=$1
+ local expected_to_fail=$2
+ local sess_name=$3
+
+ _run_lttng_cmd "$OUTPUT_DEST" "$ERROR_OUTPUT_DEST" \
+ destroy $sess_name
+ ret=$?
+ if [[ $expected_to_fail -eq "1" ]]; then
+ test "$ret" -ne "0"
+ ret=$?
+ if [ $withtap -eq "1" ]; then
+ ok $ret "Destroy session $sess_name failed as expected"
+ fi
+ else
+ if [ $withtap -eq "1" ]; then
+ ok $ret "Destroy session $sess_name"
+ fi
+ fi
+}
+
+function destroy_lttng_session_ok ()
+{
+ destroy_lttng_session 1 0 "$@"
+
+}
+
+function destroy_lttng_session_fail ()
+{
+ destroy_lttng_session 1 1 "$@"
+}
+
+function destroy_lttng_session_notap ()
+{
+ destroy_lttng_session 0 0 "$@"
+}
+
+function destroy_lttng_sessions ()
+{
+ _run_lttng_cmd "$OUTPUT_DEST" "$ERROR_OUTPUT_DEST" \
+ destroy --all
+ ok $? "Destroy all lttng sessions"
+}
+
+function lttng_snapshot_add_output ()
+{
+ local expected_to_fail=$1
+ local sess_name=$2
+ local trace_path=$3
+ local opts=$4
+
+ _run_lttng_cmd "$OUTPUT_DEST" "$ERROR_OUTPUT_DEST" \
+ snapshot add-output -s $sess_name $trace_path $opts
+ ret=$?
+ if [[ $expected_to_fail -eq 1 ]]; then
+ test "$ret" -ne "0"
+ ok $? "Added snapshot output $trace_path failed as expected"
+ else
+ ok $ret "Added snapshot output $trace_path"
+ fi
+}
+
+function lttng_snapshot_add_output_ok ()
+{
+ lttng_snapshot_add_output 0 "$@"
+}
+
+function lttng_snapshot_add_output_fail ()
+{
+ lttng_snapshot_add_output 1 "$@"
+}
+
+function lttng_snapshot_del_output ()
+{
+ local expected_to_fail=$1
+ local sess_name=$2
+ local id=$3
+
+ _run_lttng_cmd "$OUTPUT_DEST" "$ERROR_OUTPUT_DEST" \
+ snapshot del-output -s $sess_name $id
+ ret=$?
+ if [[ $expected_to_fail -eq "1" ]]; then
+ test "$ret" -ne "0"
+ ok $? "Deleted snapshot output id $id failed as expected"
+ else
+ ok $ret "Deleted snapshot output id $id"
+ fi
+}
+
+function lttng_snapshot_del_output_ok ()
+{
+ lttng_snapshot_del_output 0 "$@"
+}
+
+function lttng_snapshot_del_output_fail ()
+{
+ lttng_snapshot_del_output 1 "$@"
+}
+
+function lttng_snapshot_record ()
+{
+ local sess_name=$1
+ local trace_path=$2
+
+ _run_lttng_cmd "$OUTPUT_DEST" "$ERROR_OUTPUT_DEST" \
+ snapshot record -s "$sess_name" "$trace_path"
+ ok $? "Snapshot recorded"
+}
+
+function lttng_snapshot_list ()
+{
+ local sess_name=$1
+ _run_lttng_cmd "$OUTPUT_DEST" "$ERROR_OUTPUT_DEST" \
+ snapshot list-output -s $sess_name
+ ok $? "Snapshot list"
+}
+
+function lttng_save()
+{
+ local sess_name=$1
+ local opts=$2
+
+ _run_lttng_cmd "$OUTPUT_DEST" "$ERROR_OUTPUT_DEST" \
+ save $sess_name $opts
+ ok $? "Session saved"
+}
+
+function lttng_load()
+{
+ local expected_to_fail=$1
+ local opts=$2
+
+ _run_lttng_cmd "$OUTPUT_DEST" "$ERROR_OUTPUT_DEST" \
+ load $opts
+ ret=$?
+ if [[ $expected_to_fail -eq "1" ]]; then
+ test $ret -ne "0"
+ ok $? "Load command failed as expected with opts: $opts"
+ else
+ ok $ret "Load command with opts: $opts"
+ fi
+}
+
+function lttng_load_ok()
+{
+ lttng_load 0 "$@"
+}
+
+function lttng_load_fail()
+{
+ lttng_load 1 "$@"
+}
+
+function lttng_track()
+{
+ local expected_to_fail="$1"
+ shift 1
+ local opts="$@"
+ $TESTDIR/../src/bin/lttng/$LTTNG_BIN track $opts >$OUTPUT_DEST
+ ret=$?
+ if [[ $expected_to_fail -eq "1" ]]; then
+ test $ret -ne "0"
+ ok $? "Track command failed as expected with opts: $opts"
+ else
+ ok $ret "Track command with opts: $opts"
+ fi
+}
+
+function lttng_track_ok()
+{
+ lttng_track 0 "$@"
+}
+
+function lttng_track_fail()
+{
+ lttng_track 1 "$@"
+}
+
+function lttng_untrack()
+{
+ local expected_to_fail="$1"
+ shift 1
+ local opts="$@"
+ $TESTDIR/../src/bin/lttng/$LTTNG_BIN untrack $opts >$OUTPUT_DEST
+ ret=$?
+ if [[ $expected_to_fail -eq "1" ]]; then
+ test $ret -ne "0"
+ ok $? "Untrack command failed as expected with opts: $opts"
+ else
+ ok $ret "Untrack command with opts: $opts"
+ fi
+}
+
+function lttng_untrack_ok()
+{
+ lttng_untrack 0 "$@"
+}
+
+function lttng_untrack_fail()
+{
+ lttng_untrack 1 "$@"
+}
+
+function lttng_track_pid_ok()
+{
+ PID=$1
+ "$TESTDIR/../src/bin/lttng/$LTTNG_BIN" track --kernel --pid=$PID 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
+ ok $? "Lttng track pid on the kernel domain"
+}
+
+function lttng_untrack_kernel_all_ok()
+{
+ "$TESTDIR/../src/bin/lttng/$LTTNG_BIN" untrack --kernel --pid --all 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
+ ok $? "Lttng untrack all pid on the kernel domain"
+}
+
+function lttng_track_ust_ok()
+{
+ lttng_track_ok -u "$@"
+}
+
+function lttng_track_ust_fail()
+{
+ lttng_track_fail -u "$@"
+}
+
+function lttng_track_kernel_ok()
+{
+ lttng_track_ok -k "$@"
+}
+
+function lttng_track_kernel_fail()
+{
+ lttng_track_fail -k "$@"
+}
+
+function lttng_untrack_ust_ok()
+{
+ lttng_untrack_ok -u "$@"
+}
+
+function lttng_untrack_ust_fail()
+{
+ lttng_untrack_fail -u "$@"
+}
+
+function lttng_untrack_kernel_ok()
+{
+ lttng_untrack_ok -k "$@"
+}
+
+function lttng_untrack_kernel_fail()
+{
+ lttng_untrack_fail -k "$@"
+}
+
+function lttng_add_context_list()
+{
+ _run_lttng_cmd "$OUTPUT_DEST" "$ERROR_OUTPUT_DEST" \
+ add-context --list
+ ret=$?
+ ok $ret "Context listing"
+}
+
+function add_context_lttng()
+{
+ local expected_to_fail="$1"
+ local domain="$2"
+ local session_name="$3"
+ local channel_name="$4"
+ local type="$5"
+
+ _run_lttng_cmd "$OUTPUT_DEST" "$ERROR_OUTPUT_DEST" \
+ add-context -s $session_name -c $channel_name -t $type $domain
+ ret=$?
+ if [[ $expected_to_fail -eq "1" ]]; then
+ test $ret -ne "0"
+ ok $? "Add context command failed as expected for type: $type"
+ else
+ ok $ret "Add context command for type: $type"
+ fi
+}
+
+function add_context_ust_ok()
+{
+ add_context_lttng 0 -u "$@"
+}
+
+function add_context_ust_fail()
+{
+ add_context_lttng 1 -u "$@"
+}
+
+function add_context_kernel_ok()
+{
+ add_context_lttng 0 -k "$@"
+}
+
+function add_context_kernel_fail()
+{
+ add_context_lttng 1 -k "$@"
+}
+
+function wait_live_trace_ready ()
+{
+ local url=$1
+ local zero_client_match=0
+
+ diag "Waiting for live trace at url: $url"
+ while [ $zero_client_match -eq 0 ]; do
+ zero_client_match=$($BABELTRACE_BIN -i lttng-live $url | grep "0 client(s) connected" | wc -l)
+ sleep 0.5
+ done
+ pass "Waiting for live trace at url: $url"
+}
+
+function wait_live_viewer_connect ()
+{
+ local url=$1
+ local one_client_match=0
+
+ diag "Waiting for live viewers on url: $url"
+ while [ $one_client_match -eq 0 ]; do
+ one_client_match=$($BABELTRACE_BIN -i lttng-live $url | grep "1 client(s) connected" | wc -l)
+ sleep 0.5
+ done
+ pass "Waiting for live viewers on url: $url"
+}
+
+function bail_out_if_no_babeltrace()
+{
+ which "$BABELTRACE_BIN" >/dev/null
+ if [ $? -ne 0 ]; then
+ LTTNG_BAIL_OUT "\"$BABELTRACE_BIN\" binary not found. Skipping tests"
+ fi
+}
+
+# Check that the trace metadata contains '$expected' event ids matching '$event_name'.
+function validate_metadata_event()
+{
+ local event_name=$1
+ local expected=$2
+ local trace_path=$3
+
+ local metadata_file
+ local metadata_path
+ local count
+
+ metadata_file=$(find "$trace_path" -name "metadata")
+ metadata_path=$(dirname "$metadata_file")
+
+ bail_out_if_no_babeltrace
+
+ count=$($BABELTRACE_BIN --output-format=ctf-metadata "$metadata_path" | grep -c "$event_name")
+
+ test "$count" -eq "$expected"
+ ok $? "Found $count / $expected metadata event id matching '$event_name'"
+}
+
+# Check that the trace contains '$expected' events matching '$event_name', other
+# events not matching '$event_name' can be present.
+function trace_matches()
+{
+ local event_name=$1
+ local expected=$2
+ local trace_path=$3
+
+ local count
+ local total
+
+ bail_out_if_no_babeltrace
+
+ count=$($BABELTRACE_BIN "$trace_path" | grep -c "$event_name")
+ total=$($BABELTRACE_BIN "$trace_path" | wc -l)
+
+ test "$count" -eq "$expected"
+
+ ok $? "Found $count / $expected events matching '$event_name' out of $total events"
+}
+
+# Check that the trace contains '$expected' events matching '$event_name' and no
+# other events.
+function trace_match_only()
+{
+ local event_name=$1
+ local expected=$2
+ local trace_path=$3
+
+ local count
+ local total
+
+ bail_out_if_no_babeltrace
+
+ count=$($BABELTRACE_BIN "$trace_path" | grep -c "$event_name")
+ total=$($BABELTRACE_BIN "$trace_path" | wc -l)
+
+ test "$expected" -eq "$count" && test "$total" -eq "$expected"
+
+ ok $? "Found $count / $expected events matching '$event_name' amongst $total events"
+}
+
+# Check that the trace contains at least 1 event matching each name in the
+# comma separated list '$event_names'.
+function validate_trace()
+{
+ local event_names=$1
+ local trace_path=$2
+
+ local count
+
+ bail_out_if_no_babeltrace
+
+ OLDIFS=$IFS
+ IFS=","
+ for event_name in $event_names; do
+ # trace_path is unquoted since callers make use of globbing
+ count=$($BABELTRACE_BIN $trace_path | grep -c "$event_name")
+ test "$count" -gt 0
+ ok $? "Found $count events matching '$event_name'"
+ done
+ IFS=$OLDIFS
+}
+
+# Check that the trace contains at least 1 event matching each name in the
+# comma separated list '$event_names' and a total of '$expected' events.
+function validate_trace_count()
+{
+ local event_names=$1
+ local trace_path=$2
+ local expected=$3
+
+ local count
+ local total=0
+
+ bail_out_if_no_babeltrace
+
+ OLDIFS=$IFS
+ IFS=","
+ for event_name in $event_names; do
+ count=$($BABELTRACE_BIN "$trace_path" | grep -c "$event_name")
+ test "$count" -gt 0
+ ok $? "Found '$count' events matching '$event_name'"
+ total=$(( total + count ))
+ done
+ IFS=$OLDIFS
+ test $total -eq "$expected"
+ ok $? "Found $total events, expected $expected events"
+}
+
+# Check that the trace contains at least '$expected_min' event matching each
+# name in the comma separated list '$event_names' and a total at least
+# '$expected_min' and less than '$expected_max' events.
+function validate_trace_count_range_incl_min_excl_max()
+{
+ local event_names=$1
+ local trace_path=$2
+ local expected_min=$3
+ local expected_max=$4
+
+ local count
+ local total=0
+
+ bail_out_if_no_babeltrace
+
+ OLDIFS=$IFS
+ IFS=","
+ for event_name in $event_names; do
+ count=$($BABELTRACE_BIN "$trace_path" | grep -c "$event_name")
+ test "$count" -ge "$expected_min"
+ ok $? "Found $count events matching '$event_name', expected at least $expected_min"
+ total=$(( total + count ))
+ done
+ IFS=$OLDIFS
+ test $total -ge "$expected_min" && test $total -lt "$expected_max"
+ ok $? "Found a total of $total events, expected at least $expected_min and less than $expected_max"
+}
+
+function trace_first_line()
+{
+ local trace_path=$1
+
+ $BABELTRACE_BIN "$trace_path" | head -n 1
+}
+
+# Check that the trace contains at least 1 event matching the grep extended
+# regexp '$event_exp'.
+function validate_trace_exp()
+{
+ local event_exp=$1
+ local trace_path=$2
+
+ local count
+
+ bail_out_if_no_babeltrace
+
+ # event_exp is unquoted since it contains multiple grep arguments
+ count=$($BABELTRACE_BIN "$trace_path" | grep -c --extended-regexp $event_exp)
+ test "$count" -gt 0
+ ok $? "Found $count events matching expression '$event_exp'"
+}
+
+# Check that the trace contains at least 1 event matching the grep extended
+# regexp '$event_exp' and zero event not matching it.
+function validate_trace_only_exp()
+{
+ local event_exp=$1
+ local trace_path=$2
+
+ local count
+ local total
+
+ bail_out_if_no_babeltrace
+
+ # event_exp is unquoted since it contains multiple grep arguments
+ count=$($BABELTRACE_BIN "$trace_path" | grep -c --extended-regexp $event_exp)
+ total=$($BABELTRACE_BIN "$trace_path" | wc -l)
+
+ test "$count" -gt 0 && test "$total" -eq "$count"
+ ok $? "Found $count events matching expression '$event_exp' amongst $total events"
+}
+
+# Check that the trace is valid and contains 0 event.
+function validate_trace_empty()
+{
+ local trace_path=$1
+
+ local ret
+ local count
+
+ bail_out_if_no_babeltrace
+
+ events=$($BABELTRACE_BIN "$trace_path")
+ ret=$?
+ if [ $ret -ne 0 ]; then
+ fail "Failed to parse trace"
+ return $ret
+ fi
+
+ count=$(echo -n "$events" | wc -l)
+ test "$count" -eq 0
+ ok $? "Validate trace is empty, found $count events"
+}
+
+function validate_directory_empty ()
+{
+ local trace_path="$1"
+
+ local files
+ local ret
+ local nb_files
+
+ # 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)"
+ test "$nb_files" -eq 0
+ ok $? "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
+
+ _run_lttng_cmd "$OUTPUT_DEST" "$ERROR_OUTPUT_DEST" \
+ regenerate metadata -s $sess_name
+ 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
+
+ _run_lttng_cmd "$OUTPUT_DEST" "$ERROR_OUTPUT_DEST" \
+ regenerate statedump -s $sess_name
+ 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
+
+ _run_lttng_cmd "$OUTPUT_DEST" "$ERROR_OUTPUT_DEST" \
+ rotate $sess_name
+ 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
+
+ _run_lttng_cmd "$OUTPUT_DEST" "$ERROR_OUTPUT_DEST" \
+ enable-rotation -s $sess_name --timer $period
+ 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
+
+ _run_lttng_cmd "$OUTPUT_DEST" "$ERROR_OUTPUT_DEST" \
+ enable-rotation -s $sess_name --size $size
+ ret=$?
+ if [[ $expected_to_fail -eq "1" ]]; then
+ test "$ret" -ne "0"
+ ok $? "Expected to fail to set a periodic rotation of session $sess_name" "every " $size " bytes"
+ else
+ ok $ret "Set a scheduled rotation of session $sess_name" "every " $size " bytes"
+ 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
+
+ _run_lttng_cmd "$OUTPUT_DEST" "$ERROR_OUTPUT_DEST" \
+ clear $sess_name
+ 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 ()
+{
+ _run_lttng_cmd "$OUTPUT_DEST" "$ERROR_OUTPUT_DEST" \
+ clear --all
+ 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 list_triggers_matches_ok ()
+{
+ local tmp_stdout=$(mktemp -t "tmp.${FUNCNAME[0]}_stdout.XXXXXX")
+ local tmp_stderr=$(mktemp -t "tmp.${FUNCNAME[0]}_stderr.XXXXXX")
+
+ local test_name="$1"
+ local expected_stdout_file="$2"
+
+ diag "$TESTDIR/../src/bin/lttng/$LTTNG_BIN list-triggers"
+
+ "$TESTDIR/../src/bin/lttng/$LTTNG_BIN" list-triggers > "${tmp_stdout}" 2> "${tmp_stderr}"
+ ok $? "${test_name}: exit code is 0"
+
+ diff -u "${expected_stdout_file}" "${tmp_stdout}"
+ ok $? "${test_name}: expected stdout"
+
+ diff -u /dev/null "${tmp_stderr}"
+ ok $? "${test_name}: expected stderr"
+
+ rm -f "${tmp_stdout}"
+ rm -f "${tmp_stderr}"
+}
+
+function list_triggers_matches_mi_ok ()
+{
+ local tmp_stdout
+ local tmp_stdout_raw
+ local tmp_stderr
+
+ local test_name="$1"
+ local expected_stdout_file="$2"
+
+ tmp_stdout_raw=$(mktemp -t "tmp.${FUNCNAME[0]}_stdout.XXXXXX")
+ tmp_stdout=$(mktemp -t "tmp.${FUNCNAME[0]}_stdout.XXXXXX")
+ tmp_stderr=$(mktemp -t "tmp.${FUNCNAME[0]}_stderr.XXXXXX")
+
+ diag "$TESTDIR/../src/bin/lttng/$LTTNG_BIN --mi xml list-triggers"
+
+ "$TESTDIR/../src/bin/lttng/$LTTNG_BIN" --mi=xml list-triggers > "${tmp_stdout_raw}" 2> "${tmp_stderr}"
+ ok $? "${test_name}: exit code is 0"
+
+ # Pretty-fy xml before further test.
+ $XML_PRETTY < "${tmp_stdout_raw}" > "${tmp_stdout}"
+
+ $MI_VALIDATE "${tmp_stdout}"
+ ok $? "list-trigger mi is valid"
+
+ diff -u "${expected_stdout_file}" "${tmp_stdout}"
+ ok $? "${test_name}: expected stdout"
+
+ diff -u /dev/null "${tmp_stderr}"
+ ok $? "${test_name}: expected stderr"
+
+ rm -f "${tmp_stdout}"
+ rm -f "${tmp_stdout_raw}"
+ rm -f "${tmp_stderr}"
+}
+
+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"
+}