[lttng-tools.git] / tests / regression / tools / snapshots / ust_test

#!/bin/bash
#
# Copyright (C) 2013 Julien Desfossez <jdesfossez@efficios.com>
#
# SPDX-License-Identifier: LGPL-2.1-only

TEST_DESC="Snapshots - UST tracing"

CURDIR=$(dirname $0)/
TESTDIR=$CURDIR/../../..
EVENT_NAME="tp:tptest"
SESSION_NAME=""
CHANNEL_NAME="snapchan"
TESTAPP_PATH="$TESTDIR/utils/testapp"
TESTAPP_NAME="gen-ust-events"
TESTAPP_BIN="$TESTAPP_PATH/$TESTAPP_NAME/$TESTAPP_NAME"
APPS_PID=

NUM_TESTS=104

TRACE_PATH=$(mktemp -d -t tmp.test_snapshots_ust_trace_path.XXXXXX)

source $TESTDIR/utils/utils.sh

if [ ! -x "$TESTAPP_BIN" ]; then
	BAIL_OUT "No UST events binary detected"
fi

# Need the number of snapshot to do.
if [ -z $1 ]; then
	BAIL_OUT "A number of snapshot is needed"
fi
NR_SNAPSHOT=$1

NUM_TESTS=$(($NUM_TESTS + ($NR_SNAPSHOT * 3)))

function start_test_app()
{
	local tmp_file=$(mktemp -u -t "tmp.${FUNCNAME[0]}_tmp_file.XXXXXX")

	# Start application with a temporary file.
	$TESTAPP_BIN -i $NR_ITER -w $NR_USEC_WAIT --sync-after-first-event $tmp_file &
	ret=$?
	APPS_PID="${APPS_PID} ${!}"
	ok $ret "Start application to trace"

	# Wait for the application file to appear indicating that at least one
	# tracepoint has been fired.
	while [ ! -f "$tmp_file" ]; do
		sleep 0.5
	done
	diag "Removing test app temporary file $tmp_file"
	rm -f $tmp_file
}

function wait_test_apps()
{
	diag "Waiting for $TESTAPP_NAME"
	for p in ${APPS_PID}; do
		wait ${p} 2>/dev/null
	done
}

function stop_test_apps()
{
	diag "Stopping $TESTAPP_NAME"
	for p in ${APPS_PID}; do
		kill ${p}
		wait ${p} 2>/dev/null
	done
	APPS_PID=
}

function snapshot_add_output ()
{
	local sess_name=$1
	local trace_path=$2
	local name=$3
	local max_size=$4
	local extra_opt=""

	if [ ! -z $name ]; then
		extra_opt+=" -n $name "
	fi

	if [ ! -z $max_size ]; then
		extra_opt+=" -m $max_size "
	fi

	$TESTDIR/../src/bin/lttng/$LTTNG_BIN snapshot add-output \
		-s $sess_name $extra_opt $trace_path > /dev/null 2>&1

	ok $? "Added snapshot output $trace_path ($extra_opt)"
}

function snapshot_del_output ()
{
	local sess_name=$1
	local name=$2

	$TESTDIR/../src/bin/lttng/$LTTNG_BIN snapshot del-output \
		-s $sess_name $name > /dev/null 2>&1

	ok $? "Deleted snapshot output named $name"
}

function enable_mmap_overwrite_subbuf_ust_channel ()
{
	local sess_name=$1
	local chan_name=$2
	local subbuf_size=$3
	local subbuf_count=$4

	$TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-channel -s $sess_name \
		$chan_name -u --output mmap --overwrite \
		--num-subbuf=$subbuf_count \
		--subbuf-size $subbuf_size > /dev/null 2>&1

	ok $? "Enable channel $channel_name for session $sess_name with subbuf size $subbuf_size"
}

function enable_mmap_small_discard_ust_channel ()
{
	local sess_name=$1
	local chan_name=$2

	$TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-channel -s $sess_name \
		$chan_name -u --output mmap --discard \
		--subbuf-size $(getconf PAGE_SIZE) --num-subbuf 2 \
		> /dev/null 2>&1

	ok $? "Enable channel $channel_name for session $sess_name with small discard buffers"
}

function enable_mmap_small_overwrite_ust_channel ()
{
	local sess_name=$1
	local chan_name=$2

	$TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-channel -s $sess_name \
		$chan_name -u --output mmap --overwrite \
		--subbuf-size $(getconf PAGE_SIZE) --num-subbuf 2 \
		> /dev/null 2>&1

	ok $? "Enable channel $channel_name for session $sess_name with small discard buffers"
}

function test_ust_list_output ()
{
	output_names=("randomname" "somesnapshot")

	diag "Test UST snapshot output listing"
	create_lttng_session_no_output $SESSION_NAME
	enable_lttng_mmap_overwrite_ust_channel $SESSION_NAME $CHANNEL_NAME
	enable_ust_lttng_event_ok $SESSION_NAME $EVENT_NAME $CHANNEL_NAME

	start_lttng_tracing_ok $SESSION_NAME

	snapshot_add_output $SESSION_NAME "file://$TRACE_PATH" ${output_names[0]}

	$TESTDIR/../src/bin/lttng/$LTTNG_BIN snapshot list-output \
		-s $SESSION_NAME 2>&1 | grep ${output_names[0]} > /dev/null
	ok $? "Snapshot named ${output_names[0]} present in list-output listing"

	snapshot_del_output $SESSION_NAME ${output_names[0]}

	snapshot_add_output $SESSION_NAME "file://$TRACE_PATH" ${output_names[1]}

	$TESTDIR/../src/bin/lttng/$LTTNG_BIN snapshot list-output \
		-s $SESSION_NAME 2>&1 | grep ${output_names[1]} > /dev/null

	ok $? "Snapshot named ${output_names[1]} present in list-output listing"

	stop_lttng_tracing_ok $SESSION_NAME
	destroy_lttng_session_ok $SESSION_NAME
}

function test_ust_local_snapshot ()
{
	NR_ITER=-1
	NR_USEC_WAIT=100

	diag "Test local UST snapshots"
	create_lttng_session_no_output $SESSION_NAME
	enable_lttng_mmap_overwrite_ust_channel $SESSION_NAME $CHANNEL_NAME
	enable_ust_lttng_event_ok $SESSION_NAME $EVENT_NAME $CHANNEL_NAME
	start_lttng_tracing_ok $SESSION_NAME
	lttng_snapshot_add_output_ok $SESSION_NAME file://$TRACE_PATH

	# Returns once the application has at least fired ONE tracepoint.
	start_test_app

	lttng_snapshot_record $SESSION_NAME
	stop_lttng_tracing_ok $SESSION_NAME
	destroy_lttng_session_ok $SESSION_NAME

	# Validate test
	validate_trace_path_ust_uid_snapshot "$TRACE_PATH" "" "snapshot-1" 0
	validate_trace $EVENT_NAME $TRACE_PATH/
	if [ $? -eq 0 ]; then
		# Only delete if successful
		rm -rf $TRACE_PATH
	fi

	stop_test_apps
}

function test_ust_local_snapshot_small_discard_buffers ()
{
	NR_ITER=10000
	NR_USEC_WAIT=0
	OLDCPUSET=$(taskset -p $$)

	diag "Test local UST snapshots with small discard buffers"
	taskset -p 0x1 $$ 1>/dev/null 2>&1 	# CPU 0 only
	create_lttng_session_no_output $SESSION_NAME
	enable_mmap_small_discard_ust_channel $SESSION_NAME $CHANNEL_NAME
	enable_ust_lttng_event_ok $SESSION_NAME $EVENT_NAME $CHANNEL_NAME
	start_lttng_tracing_ok $SESSION_NAME
	lttng_snapshot_add_output_ok $SESSION_NAME file://$TRACE_PATH

	# Run test apps, wait for them to complete.
	start_test_app
	wait_test_apps

	# Take first snapshot, remember first line.
	lttng_snapshot_record $SESSION_NAME
	FIRST_LINE="$(trace_first_line $TRACE_PATH/)"
	diag "First line (1st snapshot): $FIRST_LINE"
	rm -rf $TRACE_PATH/

	# Run test apps, wait for them to complete.
	start_test_app
	wait_test_apps

	# Take second snapshot, remember first line.
	lttng_snapshot_record $SESSION_NAME
	FIRST_LINE_2="$(trace_first_line $TRACE_PATH/)"
	diag "First line (2nd snapshot): $FIRST_LINE_2"
	rm -rf $TRACE_PATH/

	if [ x"$FIRST_LINE" != x"$FIRST_LINE_2" ]; then
		fail "First snapshot event do not match"
	else
		pass "First snapshot event match"
	fi

	stop_lttng_tracing_ok $SESSION_NAME
	destroy_lttng_session_ok $SESSION_NAME
	taskset -p $OLDCPUSET $$ 1>/dev/null 2>&1
}

function test_ust_local_snapshot_small_overwrite_buffers ()
{
	NR_ITER=10000
	NR_USEC_WAIT=0
	OLDCPUSET=$(taskset -p $$)

	diag "Test local UST snapshots with small overwrite buffers"
	taskset -p 0x1 $$ 1>/dev/null 2>&1 	# CPU 0 only
	create_lttng_session_no_output $SESSION_NAME
	enable_mmap_small_overwrite_ust_channel $SESSION_NAME $CHANNEL_NAME
	enable_ust_lttng_event_ok $SESSION_NAME $EVENT_NAME $CHANNEL_NAME
	start_lttng_tracing_ok $SESSION_NAME
	lttng_snapshot_add_output_ok $SESSION_NAME file://$TRACE_PATH

	# Run test apps, wait for them to complete.
	start_test_app
	wait_test_apps

	# Take first snapshot, remember first line.
	lttng_snapshot_record $SESSION_NAME
	FIRST_LINE="$(trace_first_line $TRACE_PATH/)"
	diag "First line (1st snapshot): $FIRST_LINE"
	rm -rf $TRACE_PATH/

	# Run test apps, wait for them to complete.
	start_test_app
	wait_test_apps

	# Take second snapshot, remember first line.
	lttng_snapshot_record $SESSION_NAME
	FIRST_LINE_2="$(trace_first_line $TRACE_PATH/)"
	diag "First line (2nd snapshot): $FIRST_LINE_2"
	rm -rf $TRACE_PATH/

	if [ x"$FIRST_LINE" != x"$FIRST_LINE_2" ]; then
		pass "First snapshot event do not match"
	else
		fail "First snapshot event match"
	fi

	stop_lttng_tracing_ok $SESSION_NAME
	destroy_lttng_session_ok $SESSION_NAME
	taskset -p $OLDCPUSET $$ 1>/dev/null 2>&1
}

function test_ust_local_snapshot_max_size ()
{
	local possible_cpus
	local cpus_list
	local subbuf_size
	local subbuf_count
	local snapshot_max_size
	local channel_max_size_per_cpu

	IFS=" " read -r -a cpus_list <<< "$(get_exposed_cpus_list)"

	possible_cpus=$(get_possible_cpus_count)
	subbuf_size=$(getconf PAGE_SIZE)
	subbuf_count=8
	snapshot_max_size=$((subbuf_size*possible_cpus))
	channel_max_size_per_cpu=$((subbuf_size*subbuf_count))

	diag "Test local UST snapshots with max size $max_size"
	create_lttng_session_no_output "$SESSION_NAME"

	enable_mmap_overwrite_subbuf_ust_channel \
		"$SESSION_NAME" "$CHANNEL_NAME" \
		"$subbuf_size" "$subbuf_count"

	enable_ust_lttng_event_ok "$SESSION_NAME" "$EVENT_NAME" "$CHANNEL_NAME"
	start_lttng_tracing_ok "$SESSION_NAME"

	snapshot_add_output "$SESSION_NAME" "file://$TRACE_PATH" "" "$snapshot_max_size"

	# Fill all ring-buffers of the channel; assuming event size of at least one
	# byte
	for cpu in "${cpus_list[@]}";
	do
		diag "setting affinity to $cpu"
		taskset --cpu-list "$cpu" "$TESTAPP_BIN" \
			--iter "$channel_max_size_per_cpu"
	done
	diag "Filled channel ring-buffers"

	lttng_snapshot_record "$SESSION_NAME"

	# Check file size
	local snapshot_size
	snapshot_size=$(find "$TRACE_PATH" -name "${CHANNEL_NAME}_*" \
				-exec stat -c '%s' {} \; | \
				awk '{s = s + $1}END{print s}')

	if [ "$snapshot_size" -eq "$snapshot_max_size" ]; then
		pass "Tracefiles size sum validation"
	else
		fail "Tracefiles size sum validation"
		diag "Tracefiles size sum: $snapshot_size Expected max: $snapshot_max_size"
	fi

	stop_lttng_tracing_ok "$SESSION_NAME"
	destroy_lttng_session_ok "$SESSION_NAME"

	# Validate test
	validate_trace_path_ust_uid_snapshot "$TRACE_PATH" "" "snapshot-1" 0

	if validate_trace "$EVENT_NAME" "$TRACE_PATH/"; then
		# Only delete if successful
		rm -rf "$TRACE_PATH"
	fi

	stop_test_apps
}

function test_ust_local_snapshot_large_metadata ()
{
	LM_EVENT="tp:tptest1,tp:tptest2,tp:tptest3,tp:tptest4,tp:tptest5"
	LM_PATH="$TESTDIR/utils/testapp"
	LM_NAME="gen-ust-nevents"
	LM_BIN="$LM_PATH/$LM_NAME/$LM_NAME"

	diag "Test local UST snapshots with > 4kB metadata"
	create_lttng_session_no_output $SESSION_NAME
	enable_lttng_mmap_overwrite_ust_channel $SESSION_NAME $CHANNEL_NAME
	enable_ust_lttng_event_ok $SESSION_NAME $LM_EVENT $CHANNEL_NAME
	start_lttng_tracing_ok $SESSION_NAME
	lttng_snapshot_add_output_ok $SESSION_NAME file://$TRACE_PATH
	$LM_BIN --iter 1 --wait 1
	ok $? "Start application to trace"
	lttng_snapshot_record $SESSION_NAME
	stop_lttng_tracing_ok $SESSION_NAME
	destroy_lttng_session_ok $SESSION_NAME

	# Validate test
	validate_trace_path_ust_uid_snapshot "$TRACE_PATH" "" "snapshot-1" 0
	validate_trace $LM_EVENT $TRACE_PATH/
	if [ $? -eq 0 ]; then
		# Only delete if successful
		rm -rf $TRACE_PATH
	fi
}

function enable_channel_per_uid_mmap_overwrite()
{
	sess_name=$1
	channel_name=$2

	$TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-channel --buffers-uid -u $channel_name -s $sess_name --output mmap --overwrite >/dev/null 2>&1
	ok $? "Enable channel $channel_name per UID for session $sess_name"
}

function test_ust_per_uid_local_snapshot ()
{
	NR_ITER=-1
	NR_USEC_WAIT=100
	diag "Test per-uid local UST snapshots"
	create_lttng_session_no_output $SESSION_NAME
	enable_channel_per_uid_mmap_overwrite $SESSION_NAME $CHANNEL_NAME
	enable_ust_lttng_event_ok $SESSION_NAME $EVENT_NAME $CHANNEL_NAME
	start_lttng_tracing_ok $SESSION_NAME
	lttng_snapshot_add_output_ok $SESSION_NAME file://$TRACE_PATH

	# Returns once the application has at least fired ONE tracepoint.
	start_test_app

	lttng_snapshot_record $SESSION_NAME
	stop_lttng_tracing_ok $SESSION_NAME
	destroy_lttng_session_ok $SESSION_NAME

	# Validate test
	validate_trace_path_ust_uid_snapshot "$TRACE_PATH" "" "snapshot-1" 0
	validate_trace $EVENT_NAME $TRACE_PATH/
	if [ $? -eq 0 ]; then
		# Only delete if successful
		rm -rf $TRACE_PATH
	fi

	stop_test_apps
}

function test_ust_per_uid_local_snapshot_post_mortem ()
{
	NR_ITER=-1
	NR_USEC_WAIT=100

	diag "Test local UST snapshots post-mortem"
	create_lttng_session_no_output $SESSION_NAME
	enable_channel_per_uid_mmap_overwrite $SESSION_NAME $CHANNEL_NAME
	enable_ust_lttng_event_ok $SESSION_NAME $EVENT_NAME $CHANNEL_NAME
	start_lttng_tracing_ok $SESSION_NAME
	lttng_snapshot_add_output_ok $SESSION_NAME file://$TRACE_PATH

	# Returns once the application has at least fired ONE tracepoint.
	start_test_app
	stop_test_apps

	lttng_snapshot_record $SESSION_NAME
	stop_lttng_tracing_ok $SESSION_NAME
	destroy_lttng_session_ok $SESSION_NAME

	# Validate test
	validate_trace_path_ust_uid_snapshot "$TRACE_PATH" "" "snapshot-1" 0
	validate_trace $EVENT_NAME $TRACE_PATH/
	if [ $? -eq 0 ]; then
		# Only delete if successful
		rm -rf $TRACE_PATH
	fi
}

function test_ust_local_snapshots ()
{
	NR_ITER=-1
	NR_USEC_WAIT=100

	diag "Test $NR_SNAPSHOT local UST snapshots"
	create_lttng_session_no_output $SESSION_NAME
	enable_lttng_mmap_overwrite_ust_channel $SESSION_NAME $CHANNEL_NAME
	enable_ust_lttng_event_ok $SESSION_NAME $EVENT_NAME $CHANNEL_NAME
	start_lttng_tracing_ok $SESSION_NAME
	lttng_snapshot_add_output_ok $SESSION_NAME file://$TRACE_PATH

	# Returns once the application has at least fired ONE tracepoint.
	start_test_app

	for i in $(seq 1 $NR_SNAPSHOT); do
		diag "Snapshot $i/$NR_SNAPSHOT"
		rm -rf $TRACE_PATH/snapshot/* 2>/dev/null
		lttng_snapshot_record $SESSION_NAME
		# Validate test
		validate_trace_path_ust_uid_snapshot "$TRACE_PATH" "" "snapshot-1" $((i - 1))
		validate_trace $EVENT_NAME $TRACE_PATH/
		if [ $? -eq 0 ]; then
			# Only delete if successful
			rm -rf $TRACE_PATH
		fi
	done
	stop_lttng_tracing_ok $SESSION_NAME
	destroy_lttng_session_ok $SESSION_NAME

	stop_test_apps
}

plan_tests $NUM_TESTS

print_test_banner "$TEST_DESC"

bail_out_if_no_babeltrace

start_lttng_sessiond
tests=( test_ust_list_output
	test_ust_local_snapshot
	test_ust_local_snapshot_max_size
	test_ust_per_uid_local_snapshot
	test_ust_per_uid_local_snapshot_post_mortem
	test_ust_local_snapshot_large_metadata
	test_ust_local_snapshots
	test_ust_local_snapshot_small_discard_buffers
	test_ust_local_snapshot_small_overwrite_buffers
)

for fct_test in ${tests[@]};
do
	SESSION_NAME=$(randstring 16 0)
	${fct_test}
done

stop_lttng_sessiond
Commit	Line	Data
ebaaaf5e JD	1	#!/bin/bash
ebaaaf5e JD	2	#
9d16b343	3	# Copyright (C) 2013 Julien Desfossez <jdesfossez@efficios.com>
ebaaaf5e	4	#
9d16b343 MJ	5	# SPDX-License-Identifier: LGPL-2.1-only
9d16b343 MJ	6
ebaaaf5e JD	7	TEST_DESC="Snapshots - UST tracing"
	8
	9	CURDIR=$(dirname $0)/
	10	TESTDIR=$CURDIR/../../..
	11	EVENT_NAME="tp:tptest"
ebaaaf5e JD	12	SESSION_NAME=""
	13	CHANNEL_NAME="snapchan"
	14	TESTAPP_PATH="$TESTDIR/utils/testapp"
	15	TESTAPP_NAME="gen-ust-events"
	16	TESTAPP_BIN="$TESTAPP_PATH/$TESTAPP_NAME/$TESTAPP_NAME"
0fc2834c	17	APPS_PID=
ebaaaf5e	18
d34e7a4d	19	NUM_TESTS=104
ebaaaf5e	20
8d5a3312	21	TRACE_PATH=$(mktemp -d -t tmp.test_snapshots_ust_trace_path.XXXXXX)
ebaaaf5e JD	22
	23	source $TESTDIR/utils/utils.sh
	24
	25	if [ ! -x "$TESTAPP_BIN" ]; then
ce83431d	26	BAIL_OUT "No UST events binary detected"
ebaaaf5e JD	27	fi
ebaaaf5e JD	28
1d20c959 DG	29	# Need the number of snapshot to do.
1d20c959 DG	30	if [ -z $1 ]; then
ce83431d	31	BAIL_OUT "A number of snapshot is needed"
1d20c959 DG	32	fi
	33	NR_SNAPSHOT=$1
	34
bd666153	35	NUM_TESTS=$(($NUM_TESTS + ($NR_SNAPSHOT * 3)))
1d20c959	36
209b934f DG	37	function start_test_app()
209b934f DG	38	{
8d5a3312	39	local tmp_file=$(mktemp -u -t "tmp.${FUNCNAME[0]}_tmp_file.XXXXXX")
209b934f DG	40
209b934f DG	41	# Start application with a temporary file.
6c4a91d6	42	$TESTAPP_BIN -i $NR_ITER -w $NR_USEC_WAIT --sync-after-first-event $tmp_file &
0fc2834c MD	43	ret=$?
	44	APPS_PID="${APPS_PID} ${!}"
	45	ok $ret "Start application to trace"
209b934f DG	46
	47	# Wait for the application file to appear indicating that at least one
	48	# tracepoint has been fired.
	49	while [ ! -f "$tmp_file" ]; do
	50	sleep 0.5
	51	done
	52	diag "Removing test app temporary file $tmp_file"
	53	rm -f $tmp_file
	54	}
	55
ae779dd6 MD	56	function wait_test_apps()
	57	{
	58	diag "Waiting for $TESTAPP_NAME"
	59	for p in ${APPS_PID}; do
	60	wait ${p} 2>/dev/null
	61	done
	62	}
	63
0fc2834c	64	function stop_test_apps()
209b934f	65	{
0fc2834c MD	66	diag "Stopping $TESTAPP_NAME"
	67	for p in ${APPS_PID}; do
	68	kill ${p}
5402fe87	69	wait ${p} 2>/dev/null
0fc2834c	70	done
c7613334	71	APPS_PID=
209b934f DG	72	}
209b934f DG	73
5e83c405 CB	74	function snapshot_add_output ()
	75	{
	76	local sess_name=$1
	77	local trace_path=$2
	78	local name=$3
	79	local max_size=$4
	80	local extra_opt=""
	81
	82	if [ ! -z $name ]; then
	83	extra_opt+=" -n $name "
	84	fi
	85
	86	if [ ! -z $max_size ]; then
	87	extra_opt+=" -m $max_size "
	88	fi
	89
	90	$TESTDIR/../src/bin/lttng/$LTTNG_BIN snapshot add-output \
	91	-s $sess_name $extra_opt $trace_path > /dev/null 2>&1
	92
	93	ok $? "Added snapshot output $trace_path ($extra_opt)"
	94	}
	95
	96	function snapshot_del_output ()
	97	{
	98	local sess_name=$1
	99	local name=$2
	100
	101	$TESTDIR/../src/bin/lttng/$LTTNG_BIN snapshot del-output \
	102	-s $sess_name $name > /dev/null 2>&1
	103
	104	ok $? "Deleted snapshot output named $name"
	105	}
	106
	107	function enable_mmap_overwrite_subbuf_ust_channel ()
	108	{
	109	local sess_name=$1
	110	local chan_name=$2
	111	local subbuf_size=$3
d34e7a4d	112	local subbuf_count=$4
5e83c405 CB	113
	114	$TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-channel -s $sess_name \
	115	$chan_name -u --output mmap --overwrite \
d34e7a4d	116	--num-subbuf=$subbuf_count \
5e83c405 CB	117	--subbuf-size $subbuf_size > /dev/null 2>&1
	118
	119	ok $? "Enable channel $channel_name for session $sess_name with subbuf size $subbuf_size"
	120	}
	121
ae779dd6 MD	122	function enable_mmap_small_discard_ust_channel ()
	123	{
	124	local sess_name=$1
	125	local chan_name=$2
	126
	127	$TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-channel -s $sess_name \
	128	$chan_name -u --output mmap --discard \
	129	--subbuf-size $(getconf PAGE_SIZE) --num-subbuf 2 \
	130	> /dev/null 2>&1
	131
	132	ok $? "Enable channel $channel_name for session $sess_name with small discard buffers"
	133	}
	134
	135	function enable_mmap_small_overwrite_ust_channel ()
	136	{
	137	local sess_name=$1
	138	local chan_name=$2
	139
	140	$TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-channel -s $sess_name \
	141	$chan_name -u --output mmap --overwrite \
	142	--subbuf-size $(getconf PAGE_SIZE) --num-subbuf 2 \
	143	> /dev/null 2>&1
	144
	145	ok $? "Enable channel $channel_name for session $sess_name with small discard buffers"
	146	}
5e83c405 CB	147
	148	function test_ust_list_output ()
	149	{
	150	output_names=("randomname" "somesnapshot")
	151
	152	diag "Test UST snapshot output listing"
	153	create_lttng_session_no_output $SESSION_NAME
	154	enable_lttng_mmap_overwrite_ust_channel $SESSION_NAME $CHANNEL_NAME
c4926bb5	155	enable_ust_lttng_event_ok $SESSION_NAME $EVENT_NAME $CHANNEL_NAME
5e83c405	156
e563bbdb	157	start_lttng_tracing_ok $SESSION_NAME
5e83c405 CB	158
	159	snapshot_add_output $SESSION_NAME "file://$TRACE_PATH" ${output_names[0]}
	160
	161	$TESTDIR/../src/bin/lttng/$LTTNG_BIN snapshot list-output \
	162	-s $SESSION_NAME 2>&1 \| grep ${output_names[0]} > /dev/null
	163	ok $? "Snapshot named ${output_names[0]} present in list-output listing"
	164
	165	snapshot_del_output $SESSION_NAME ${output_names[0]}
	166
	167	snapshot_add_output $SESSION_NAME "file://$TRACE_PATH" ${output_names[1]}
	168
	169	$TESTDIR/../src/bin/lttng/$LTTNG_BIN snapshot list-output \
	170	-s $SESSION_NAME 2>&1 \| grep ${output_names[1]} > /dev/null
	171
	172	ok $? "Snapshot named ${output_names[1]} present in list-output listing"
	173
96340a01	174	stop_lttng_tracing_ok $SESSION_NAME
67b4c664	175	destroy_lttng_session_ok $SESSION_NAME
5e83c405 CB	176	}
5e83c405 CB	177
ebaaaf5e JD	178	function test_ust_local_snapshot ()
ebaaaf5e JD	179	{
18c9d47c	180	NR_ITER=-1
ae779dd6 MD	181	NR_USEC_WAIT=100
ae779dd6 MD	182
ebaaaf5e JD	183	diag "Test local UST snapshots"
	184	create_lttng_session_no_output $SESSION_NAME
	185	enable_lttng_mmap_overwrite_ust_channel $SESSION_NAME $CHANNEL_NAME
c4926bb5	186	enable_ust_lttng_event_ok $SESSION_NAME $EVENT_NAME $CHANNEL_NAME
e563bbdb	187	start_lttng_tracing_ok $SESSION_NAME
9f0e230a	188	lttng_snapshot_add_output_ok $SESSION_NAME file://$TRACE_PATH
209b934f DG	189
	190	# Returns once the application has at least fired ONE tracepoint.
	191	start_test_app
	192
ebaaaf5e	193	lttng_snapshot_record $SESSION_NAME
96340a01	194	stop_lttng_tracing_ok $SESSION_NAME
67b4c664	195	destroy_lttng_session_ok $SESSION_NAME
ebaaaf5e JD	196
ebaaaf5e JD	197	# Validate test
bd666153	198	validate_trace_path_ust_uid_snapshot "$TRACE_PATH" "" "snapshot-1" 0
ebaaaf5e JD	199	validate_trace $EVENT_NAME $TRACE_PATH/
	200	if [ $? -eq 0 ]; then
	201	# Only delete if successful
	202	rm -rf $TRACE_PATH
ebaaaf5e	203	fi
209b934f	204
0fc2834c	205	stop_test_apps
ebaaaf5e JD	206	}
ebaaaf5e JD	207
ae779dd6 MD	208	function test_ust_local_snapshot_small_discard_buffers ()
	209	{
	210	NR_ITER=10000
	211	NR_USEC_WAIT=0
	212	OLDCPUSET=$(taskset -p $$)
	213
	214	diag "Test local UST snapshots with small discard buffers"
	215	taskset -p 0x1 $$ 1>/dev/null 2>&1 # CPU 0 only
	216	create_lttng_session_no_output $SESSION_NAME
	217	enable_mmap_small_discard_ust_channel $SESSION_NAME $CHANNEL_NAME
	218	enable_ust_lttng_event_ok $SESSION_NAME $EVENT_NAME $CHANNEL_NAME
	219	start_lttng_tracing_ok $SESSION_NAME
9f0e230a	220	lttng_snapshot_add_output_ok $SESSION_NAME file://$TRACE_PATH
ae779dd6 MD	221
	222	# Run test apps, wait for them to complete.
	223	start_test_app
	224	wait_test_apps
	225
	226	# Take first snapshot, remember first line.
	227	lttng_snapshot_record $SESSION_NAME
	228	FIRST_LINE="$(trace_first_line $TRACE_PATH/)"
	229	diag "First line (1st snapshot): $FIRST_LINE"
	230	rm -rf $TRACE_PATH/
	231
	232	# Run test apps, wait for them to complete.
	233	start_test_app
	234	wait_test_apps
	235
	236	# Take second snapshot, remember first line.
	237	lttng_snapshot_record $SESSION_NAME
	238	FIRST_LINE_2="$(trace_first_line $TRACE_PATH/)"
	239	diag "First line (2nd snapshot): $FIRST_LINE_2"
	240	rm -rf $TRACE_PATH/
	241
	242	if [ x"$FIRST_LINE" != x"$FIRST_LINE_2" ]; then
ce83431d	243	fail "First snapshot event do not match"
ae779dd6	244	else
ce83431d	245	pass "First snapshot event match"
ae779dd6 MD	246	fi
	247
	248	stop_lttng_tracing_ok $SESSION_NAME
	249	destroy_lttng_session_ok $SESSION_NAME
	250	taskset -p $OLDCPUSET $$ 1>/dev/null 2>&1
	251	}
	252
	253	function test_ust_local_snapshot_small_overwrite_buffers ()
	254	{
	255	NR_ITER=10000
	256	NR_USEC_WAIT=0
	257	OLDCPUSET=$(taskset -p $$)
	258
	259	diag "Test local UST snapshots with small overwrite buffers"
	260	taskset -p 0x1 $$ 1>/dev/null 2>&1 # CPU 0 only
	261	create_lttng_session_no_output $SESSION_NAME
	262	enable_mmap_small_overwrite_ust_channel $SESSION_NAME $CHANNEL_NAME
	263	enable_ust_lttng_event_ok $SESSION_NAME $EVENT_NAME $CHANNEL_NAME
	264	start_lttng_tracing_ok $SESSION_NAME
9f0e230a	265	lttng_snapshot_add_output_ok $SESSION_NAME file://$TRACE_PATH
ae779dd6 MD	266
	267	# Run test apps, wait for them to complete.
	268	start_test_app
	269	wait_test_apps
	270
	271	# Take first snapshot, remember first line.
	272	lttng_snapshot_record $SESSION_NAME
	273	FIRST_LINE="$(trace_first_line $TRACE_PATH/)"
	274	diag "First line (1st snapshot): $FIRST_LINE"
	275	rm -rf $TRACE_PATH/
	276
	277	# Run test apps, wait for them to complete.
	278	start_test_app
	279	wait_test_apps
	280
	281	# Take second snapshot, remember first line.
	282	lttng_snapshot_record $SESSION_NAME
	283	FIRST_LINE_2="$(trace_first_line $TRACE_PATH/)"
	284	diag "First line (2nd snapshot): $FIRST_LINE_2"
	285	rm -rf $TRACE_PATH/
	286
	287	if [ x"$FIRST_LINE" != x"$FIRST_LINE_2" ]; then
ce83431d	288	pass "First snapshot event do not match"
ae779dd6	289	else
ce83431d	290	fail "First snapshot event match"
ae779dd6 MD	291	fi
	292
	293	stop_lttng_tracing_ok $SESSION_NAME
	294	destroy_lttng_session_ok $SESSION_NAME
	295	taskset -p $OLDCPUSET $$ 1>/dev/null 2>&1
	296	}
	297
5e83c405 CB	298	function test_ust_local_snapshot_max_size ()
5e83c405 CB	299	{
d34e7a4d	300	local possible_cpus
3bfde48a	301	local cpus_list
d34e7a4d OD	302	local subbuf_size
	303	local subbuf_count
	304	local snapshot_max_size
	305	local channel_max_size_per_cpu
	306
3bfde48a OD	307	IFS=" " read -r -a cpus_list <<< "$(get_exposed_cpus_list)"
3bfde48a OD	308
d34e7a4d	309	possible_cpus=$(get_possible_cpus_count)
d34e7a4d OD	310	subbuf_size=$(getconf PAGE_SIZE)
	311	subbuf_count=8
	312	snapshot_max_size=$((subbuf_size*possible_cpus))
	313	channel_max_size_per_cpu=$((subbuf_size*subbuf_count))
5e83c405 CB	314
5e83c405 CB	315	diag "Test local UST snapshots with max size $max_size"
d34e7a4d	316	create_lttng_session_no_output "$SESSION_NAME"
5e83c405	317
d34e7a4d OD	318	enable_mmap_overwrite_subbuf_ust_channel \
	319	"$SESSION_NAME" "$CHANNEL_NAME" \
	320	"$subbuf_size" "$subbuf_count"
5e83c405	321
d34e7a4d OD	322	enable_ust_lttng_event_ok "$SESSION_NAME" "$EVENT_NAME" "$CHANNEL_NAME"
d34e7a4d OD	323	start_lttng_tracing_ok "$SESSION_NAME"
5e83c405	324
d34e7a4d	325	snapshot_add_output "$SESSION_NAME" "file://$TRACE_PATH" "" "$snapshot_max_size"
5e83c405	326
d34e7a4d OD	327	# Fill all ring-buffers of the channel; assuming event size of at least one
d34e7a4d OD	328	# byte
3bfde48a	329	for cpu in "${cpus_list[@]}";
d34e7a4d	330	do
3bfde48a OD	331	diag "setting affinity to $cpu"
3bfde48a OD	332	taskset --cpu-list "$cpu" "$TESTAPP_BIN" \
d34e7a4d OD	333	--iter "$channel_max_size_per_cpu"
	334	done
	335	diag "Filled channel ring-buffers"
5e83c405	336
d34e7a4d	337	lttng_snapshot_record "$SESSION_NAME"
5e83c405 CB	338
5e83c405 CB	339	# Check file size
d34e7a4d OD	340	local snapshot_size
	341	snapshot_size=$(find "$TRACE_PATH" -name "${CHANNEL_NAME}_*" \
	342	-exec stat -c '%s' {} \; \| \
	343	awk '{s = s + $1}END{print s}')
5e83c405	344
d34e7a4d	345	if [ "$snapshot_size" -eq "$snapshot_max_size" ]; then
b67cdb8c	346	pass "Tracefiles size sum validation"
d34e7a4d OD	347	else
	348	fail "Tracefiles size sum validation"
	349	diag "Tracefiles size sum: $snapshot_size Expected max: $snapshot_max_size"
5e83c405 CB	350	fi
5e83c405 CB	351
d34e7a4d OD	352	stop_lttng_tracing_ok "$SESSION_NAME"
d34e7a4d OD	353	destroy_lttng_session_ok "$SESSION_NAME"
5e83c405 CB	354
5e83c405 CB	355	# Validate test
bd666153	356	validate_trace_path_ust_uid_snapshot "$TRACE_PATH" "" "snapshot-1" 0
5e83c405	357
d34e7a4d	358	if validate_trace "$EVENT_NAME" "$TRACE_PATH/"; then
5e83c405	359	# Only delete if successful
d34e7a4d	360	rm -rf "$TRACE_PATH"
5e83c405 CB	361	fi
5e83c405 CB	362
0fc2834c	363	stop_test_apps
5e83c405 CB	364	}
5e83c405 CB	365
a54047ec JD	366	function test_ust_local_snapshot_large_metadata ()
	367	{
	368	LM_EVENT="tp:tptest1,tp:tptest2,tp:tptest3,tp:tptest4,tp:tptest5"
	369	LM_PATH="$TESTDIR/utils/testapp"
	370	LM_NAME="gen-ust-nevents"
	371	LM_BIN="$LM_PATH/$LM_NAME/$LM_NAME"
	372
	373	diag "Test local UST snapshots with > 4kB metadata"
	374	create_lttng_session_no_output $SESSION_NAME
	375	enable_lttng_mmap_overwrite_ust_channel $SESSION_NAME $CHANNEL_NAME
c4926bb5	376	enable_ust_lttng_event_ok $SESSION_NAME $LM_EVENT $CHANNEL_NAME
e563bbdb	377	start_lttng_tracing_ok $SESSION_NAME
9f0e230a	378	lttng_snapshot_add_output_ok $SESSION_NAME file://$TRACE_PATH
8db430e7	379	$LM_BIN --iter 1 --wait 1
a54047ec JD	380	ok $? "Start application to trace"
a54047ec JD	381	lttng_snapshot_record $SESSION_NAME
96340a01	382	stop_lttng_tracing_ok $SESSION_NAME
67b4c664	383	destroy_lttng_session_ok $SESSION_NAME
a54047ec JD	384
a54047ec JD	385	# Validate test
bd666153	386	validate_trace_path_ust_uid_snapshot "$TRACE_PATH" "" "snapshot-1" 0
a54047ec JD	387	validate_trace $LM_EVENT $TRACE_PATH/
	388	if [ $? -eq 0 ]; then
	389	# Only delete if successful
	390	rm -rf $TRACE_PATH
a54047ec JD	391	fi
	392	}
	393
5f4c2d80 JD	394	function enable_channel_per_uid_mmap_overwrite()
	395	{
	396	sess_name=$1
	397	channel_name=$2
	398
	399	$TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-channel --buffers-uid -u $channel_name -s $sess_name --output mmap --overwrite >/dev/null 2>&1
	400	ok $? "Enable channel $channel_name per UID for session $sess_name"
	401	}
	402
	403	function test_ust_per_uid_local_snapshot ()
	404	{
18c9d47c JR	405	NR_ITER=-1
18c9d47c JR	406	NR_USEC_WAIT=100
891d74dd	407	diag "Test per-uid local UST snapshots"
5f4c2d80 JD	408	create_lttng_session_no_output $SESSION_NAME
5f4c2d80 JD	409	enable_channel_per_uid_mmap_overwrite $SESSION_NAME $CHANNEL_NAME
c4926bb5	410	enable_ust_lttng_event_ok $SESSION_NAME $EVENT_NAME $CHANNEL_NAME
e563bbdb	411	start_lttng_tracing_ok $SESSION_NAME
9f0e230a	412	lttng_snapshot_add_output_ok $SESSION_NAME file://$TRACE_PATH
209b934f DG	413
	414	# Returns once the application has at least fired ONE tracepoint.
	415	start_test_app
	416
5f4c2d80	417	lttng_snapshot_record $SESSION_NAME
96340a01	418	stop_lttng_tracing_ok $SESSION_NAME
67b4c664	419	destroy_lttng_session_ok $SESSION_NAME
5f4c2d80 JD	420
5f4c2d80 JD	421	# Validate test
bd666153	422	validate_trace_path_ust_uid_snapshot "$TRACE_PATH" "" "snapshot-1" 0
5f4c2d80 JD	423	validate_trace $EVENT_NAME $TRACE_PATH/
	424	if [ $? -eq 0 ]; then
	425	# Only delete if successful
	426	rm -rf $TRACE_PATH
5f4c2d80	427	fi
209b934f	428
0fc2834c	429	stop_test_apps
5f4c2d80 JD	430	}
5f4c2d80 JD	431
4f03c06d JD	432	function test_ust_per_uid_local_snapshot_post_mortem ()
4f03c06d JD	433	{
18c9d47c	434	NR_ITER=-1
ae779dd6 MD	435	NR_USEC_WAIT=100
ae779dd6 MD	436
4f03c06d JD	437	diag "Test local UST snapshots post-mortem"
	438	create_lttng_session_no_output $SESSION_NAME
	439	enable_channel_per_uid_mmap_overwrite $SESSION_NAME $CHANNEL_NAME
c4926bb5	440	enable_ust_lttng_event_ok $SESSION_NAME $EVENT_NAME $CHANNEL_NAME
e563bbdb	441	start_lttng_tracing_ok $SESSION_NAME
9f0e230a	442	lttng_snapshot_add_output_ok $SESSION_NAME file://$TRACE_PATH
209b934f DG	443
	444	# Returns once the application has at least fired ONE tracepoint.
	445	start_test_app
0fc2834c	446	stop_test_apps
209b934f	447
4f03c06d	448	lttng_snapshot_record $SESSION_NAME
96340a01	449	stop_lttng_tracing_ok $SESSION_NAME
67b4c664	450	destroy_lttng_session_ok $SESSION_NAME
4f03c06d JD	451
4f03c06d JD	452	# Validate test
bd666153	453	validate_trace_path_ust_uid_snapshot "$TRACE_PATH" "" "snapshot-1" 0
4f03c06d JD	454	validate_trace $EVENT_NAME $TRACE_PATH/
	455	if [ $? -eq 0 ]; then
	456	# Only delete if successful
	457	rm -rf $TRACE_PATH
4f03c06d JD	458	fi
	459	}
	460
1d20c959	461	function test_ust_local_snapshots ()
ebaaaf5e	462	{
18c9d47c	463	NR_ITER=-1
ae779dd6 MD	464	NR_USEC_WAIT=100
ae779dd6 MD	465
1d20c959	466	diag "Test $NR_SNAPSHOT local UST snapshots"
ebaaaf5e JD	467	create_lttng_session_no_output $SESSION_NAME
ebaaaf5e JD	468	enable_lttng_mmap_overwrite_ust_channel $SESSION_NAME $CHANNEL_NAME
c4926bb5	469	enable_ust_lttng_event_ok $SESSION_NAME $EVENT_NAME $CHANNEL_NAME
e563bbdb	470	start_lttng_tracing_ok $SESSION_NAME
9f0e230a	471	lttng_snapshot_add_output_ok $SESSION_NAME file://$TRACE_PATH
209b934f DG	472
	473	# Returns once the application has at least fired ONE tracepoint.
	474	start_test_app
	475
1d20c959 DG	476	for i in $(seq 1 $NR_SNAPSHOT); do
1d20c959 DG	477	diag "Snapshot $i/$NR_SNAPSHOT"
ebaaaf5e JD	478	rm -rf $TRACE_PATH/snapshot/* 2>/dev/null
	479	lttng_snapshot_record $SESSION_NAME
	480	# Validate test
bd666153	481	validate_trace_path_ust_uid_snapshot "$TRACE_PATH" "" "snapshot-1" $((i - 1))
ebaaaf5e JD	482	validate_trace $EVENT_NAME $TRACE_PATH/
	483	if [ $? -eq 0 ]; then
	484	# Only delete if successful
	485	rm -rf $TRACE_PATH
ebaaaf5e JD	486	fi
ebaaaf5e JD	487	done
96340a01	488	stop_lttng_tracing_ok $SESSION_NAME
67b4c664	489	destroy_lttng_session_ok $SESSION_NAME
209b934f	490
0fc2834c	491	stop_test_apps
ebaaaf5e JD	492	}
	493
	494	plan_tests $NUM_TESTS
	495
	496	print_test_banner "$TEST_DESC"
	497
c125de8f FD	498	bail_out_if_no_babeltrace
c125de8f FD	499
ebaaaf5e	500	start_lttng_sessiond
5e83c405 CB	501	tests=( test_ust_list_output
	502	test_ust_local_snapshot
	503	test_ust_local_snapshot_max_size
	504	test_ust_per_uid_local_snapshot
	505	test_ust_per_uid_local_snapshot_post_mortem
	506	test_ust_local_snapshot_large_metadata
ae779dd6 MD	507	test_ust_local_snapshots
	508	test_ust_local_snapshot_small_discard_buffers
	509	test_ust_local_snapshot_small_overwrite_buffers
	510	)
ebaaaf5e JD	511
	512	for fct_test in ${tests[@]};
	513	do
	514	SESSION_NAME=$(randstring 16 0)
	515	${fct_test}
ebaaaf5e JD	516	done
	517
	518	stop_lttng_sessiond