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

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

TEST_DESC="Snapshots - Kernel tracing"

CURDIR=$(dirname $0)/
TESTDIR=$CURDIR/../../..
EVENT_NAME="sched_switch"
SESSION_NAME=""
CHANNEL_NAME="snapchan"

TRACE_PATH=$(mktemp --tmpdir -d tmp.test_snapshots_kernel_trace_path.XXXXXX)

NUM_TESTS=2061

source $TESTDIR/utils/utils.sh

function test_kernel_local_snapshot ()
{
	diag "Test local kernel snapshots"
	create_lttng_session_no_output $SESSION_NAME
	enable_lttng_mmap_overwrite_kernel_channel $SESSION_NAME $CHANNEL_NAME
	lttng_enable_kernel_event $SESSION_NAME $EVENT_NAME $CHANNEL_NAME
	start_lttng_tracing_ok $SESSION_NAME
	lttng_snapshot_add_output_ok $SESSION_NAME file://$TRACE_PATH
	lttng_snapshot_record $SESSION_NAME
	stop_lttng_tracing_ok $SESSION_NAME
	destroy_lttng_session_ok $SESSION_NAME

	# Validate test
	validate_trace_path_kernel_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_kernel_local_snapshot_after_stop ()
{
	diag "Test local kernel snapshots after stop"
	create_lttng_session_no_output $SESSION_NAME
	enable_lttng_mmap_overwrite_kernel_channel $SESSION_NAME $CHANNEL_NAME
	lttng_enable_kernel_event $SESSION_NAME $EVENT_NAME $CHANNEL_NAME
	start_lttng_tracing_ok $SESSION_NAME
	stop_lttng_tracing_ok $SESSION_NAME
	lttng_snapshot_add_output_ok $SESSION_NAME file://$TRACE_PATH
	lttng_snapshot_record $SESSION_NAME
	destroy_lttng_session_ok $SESSION_NAME

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

function test_kernel_local_snapshot_append_to_metadata ()
{
	local EVENT1=sched_switch
	local EVENT2=sched_process_exit

	diag "Test local kernel snapshots with one event $EVENT1"
	create_lttng_session_no_output $SESSION_NAME
	enable_lttng_mmap_overwrite_kernel_channel $SESSION_NAME $CHANNEL_NAME
	lttng_enable_kernel_event $SESSION_NAME $EVENT1 $CHANNEL_NAME
	start_lttng_tracing_ok $SESSION_NAME
	lttng_snapshot_add_output_ok $SESSION_NAME file://$TRACE_PATH

	# first snapshot with only 1 event
	lttng_snapshot_record $SESSION_NAME
	validate_trace $EVENT_NAME $TRACE_PATH/
	if [ $? -eq 0 ]; then
		# Only delete if successful
		rm -rf $TRACE_PATH
	else
		break
	fi

	diag "Adding event $EVENT2"
	# second snapshot with 2 events
	lttng_enable_kernel_event $SESSION_NAME $EVENT2 $CHANNEL_NAME
	rm -rf $TRACE_PATH/snapshot/* 2>/dev/null
	lttng_snapshot_record $SESSION_NAME
	validate_trace "${EVENT1},${EVENT2}" $TRACE_PATH/
	if [ $? -eq 0 ]; then
		# Only delete if successful
		rm -rf $TRACE_PATH
	else
		break
	fi

	stop_lttng_tracing_ok $SESSION_NAME
	destroy_lttng_session_ok $SESSION_NAME
}

function generate_filter_events_cpu0()
{
	# Generate many events (fill buffers) on CPU 0
	taskset 0x00000001 /bin/echo -n "$1" > /proc/lttng-test-filter-event 2> /dev/null
}

function test_kernel_local_snapshot_discard ()
{
	diag "Test local kernel snapshots with small discard buffers"

	local event_name="lttng_test_filter_event"

	modprobe lttng-test
	create_lttng_session_no_output $SESSION_NAME
	enable_lttng_mmap_discard_small_kernel_channel $SESSION_NAME \
			$CHANNEL_NAME
	enable_kernel_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

	generate_filter_events_cpu0 10000

	# 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

	# Fill CPU 0's buffer and overwrite previous contents
	generate_filter_events_cpu0 10000

	# Take 2nd snapshot, compare first line. In discard mode, they
	# should still be the same.
	lttng_snapshot_record $SESSION_NAME
	FIRST_LINE_2="$(trace_first_line $TRACE_PATH/)"
	diag "First line (2nd snapshot): $FIRST_LINE"
	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
	modprobe --remove lttng-test
}

function test_kernel_local_snapshot_overwrite_small_buffers ()
{
	diag "Test local kernel snapshot with small overwrite buffers"

	local event_name="lttng_test_filter_event"

	modprobe lttng-test
	create_lttng_session_no_output $SESSION_NAME
	enable_lttng_mmap_overwrite_small_kernel_channel $SESSION_NAME \
			$CHANNEL_NAME
	enable_kernel_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

	generate_filter_events_cpu0 10000

	# 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

	# Fill CPU 0's buffer and overwrite previous contents
	generate_filter_events_cpu0 10000

	# Take 2nd snapshot, compare first line. In overwrite mode, they
	# WILL be different.
	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
	modprobe --remove lttng-test
}

function test_kernel_1000_local_snapshots ()
{
	NB_SNAP=1000

	diag "Test local kernel snapshots"
	create_lttng_session_no_output $SESSION_NAME
	enable_lttng_mmap_overwrite_kernel_channel $SESSION_NAME $CHANNEL_NAME
	lttng_enable_kernel_event $SESSION_NAME $EVENT_NAME $CHANNEL_NAME
	start_lttng_tracing_ok $SESSION_NAME
	lttng_snapshot_add_output_ok $SESSION_NAME file://$TRACE_PATH
	for i in $(seq 1 $NB_SNAP); do
		diag "Snapshot $i/$NB_SNAP"
		rm -rf $TRACE_PATH/snapshot/* 2>/dev/null
		lttng_snapshot_record $SESSION_NAME
		# Validate test
		validate_trace $EVENT_NAME $TRACE_PATH/
		if [ $? -eq 0 ]; then
			# Only delete if successful
			rm -rf $TRACE_PATH
		else
			break
		fi
	done
	stop_lttng_tracing_ok $SESSION_NAME
	destroy_lttng_session_ok $SESSION_NAME
}

plan_tests $NUM_TESTS

print_test_banner "$TEST_DESC"

bail_out_if_no_babeltrace


if [ "$(id -u)" == "0" ]; then
	isroot=1
else
	isroot=0
fi

skip $isroot "Root access is needed. Skipping all kernel snapshot tests" $NUM_TESTS ||
{

	validate_lttng_modules_present

	start_lttng_sessiond

	#tests=( test_kernel_1000_local_snapshots )
	tests=( test_kernel_local_snapshot
		test_kernel_local_snapshot_after_stop
		test_kernel_local_snapshot_append_to_metadata
		test_kernel_local_snapshot_discard
		test_kernel_local_snapshot_overwrite_small_buffers
		test_kernel_1000_local_snapshots
	)

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

	done

	stop_lttng_sessiond
}
Commit	Line	Data
07b86b52 JD	1	#!/bin/bash
07b86b52 JD	2	#
9d16b343	3	# Copyright (C) 2013 Julien Desfossez <jdesfossez@efficios.com>
07b86b52	4	#
9d16b343 MJ	5	# SPDX-License-Identifier: LGPL-2.1-only
9d16b343 MJ	6
07b86b52 JD	7	TEST_DESC="Snapshots - Kernel tracing"
	8
	9	CURDIR=$(dirname $0)/
	10	TESTDIR=$CURDIR/../../..
	11	EVENT_NAME="sched_switch"
07b86b52 JD	12	SESSION_NAME=""
	13	CHANNEL_NAME="snapchan"
	14
33e55711	15	TRACE_PATH=$(mktemp --tmpdir -d tmp.test_snapshots_kernel_trace_path.XXXXXX)
07b86b52	16
bd666153	17	NUM_TESTS=2061
07b86b52 JD	18
	19	source $TESTDIR/utils/utils.sh
	20
07b86b52 JD	21	function test_kernel_local_snapshot ()
	22	{
	23	diag "Test local kernel snapshots"
	24	create_lttng_session_no_output $SESSION_NAME
	25	enable_lttng_mmap_overwrite_kernel_channel $SESSION_NAME $CHANNEL_NAME
	26	lttng_enable_kernel_event $SESSION_NAME $EVENT_NAME $CHANNEL_NAME
e563bbdb	27	start_lttng_tracing_ok $SESSION_NAME
9f0e230a	28	lttng_snapshot_add_output_ok $SESSION_NAME file://$TRACE_PATH
07b86b52	29	lttng_snapshot_record $SESSION_NAME
96340a01	30	stop_lttng_tracing_ok $SESSION_NAME
67b4c664	31	destroy_lttng_session_ok $SESSION_NAME
07b86b52 JD	32
07b86b52 JD	33	# Validate test
bd666153	34	validate_trace_path_kernel_snapshot "$TRACE_PATH" "" "snapshot-1" 0 ""
78435723	35	validate_trace $EVENT_NAME $TRACE_PATH/
07b86b52 JD	36	if [ $? -eq 0 ]; then
	37	# Only delete if successful
	38	rm -rf $TRACE_PATH
07b86b52 JD	39	fi
	40	}
	41
	42	function test_kernel_local_snapshot_after_stop ()
	43	{
	44	diag "Test local kernel snapshots after stop"
	45	create_lttng_session_no_output $SESSION_NAME
	46	enable_lttng_mmap_overwrite_kernel_channel $SESSION_NAME $CHANNEL_NAME
	47	lttng_enable_kernel_event $SESSION_NAME $EVENT_NAME $CHANNEL_NAME
e563bbdb	48	start_lttng_tracing_ok $SESSION_NAME
96340a01	49	stop_lttng_tracing_ok $SESSION_NAME
9f0e230a	50	lttng_snapshot_add_output_ok $SESSION_NAME file://$TRACE_PATH
07b86b52	51	lttng_snapshot_record $SESSION_NAME
67b4c664	52	destroy_lttng_session_ok $SESSION_NAME
07b86b52 JD	53
07b86b52 JD	54	# Validate test
78435723	55	validate_trace $EVENT_NAME $TRACE_PATH/
07b86b52 JD	56	if [ $? -eq 0 ]; then
	57	# Only delete if successful
	58	rm -rf $TRACE_PATH
	59	else
	60	break
	61	fi
	62	}
	63
	64	function test_kernel_local_snapshot_append_to_metadata ()
	65	{
78435723 JD	66	local EVENT1=sched_switch
78435723 JD	67	local EVENT2=sched_process_exit
07b86b52 JD	68
	69	diag "Test local kernel snapshots with one event $EVENT1"
	70	create_lttng_session_no_output $SESSION_NAME
	71	enable_lttng_mmap_overwrite_kernel_channel $SESSION_NAME $CHANNEL_NAME
	72	lttng_enable_kernel_event $SESSION_NAME $EVENT1 $CHANNEL_NAME
e563bbdb	73	start_lttng_tracing_ok $SESSION_NAME
9f0e230a	74	lttng_snapshot_add_output_ok $SESSION_NAME file://$TRACE_PATH
07b86b52 JD	75
	76	# first snapshot with only 1 event
	77	lttng_snapshot_record $SESSION_NAME
78435723	78	validate_trace $EVENT_NAME $TRACE_PATH/
07b86b52 JD	79	if [ $? -eq 0 ]; then
	80	# Only delete if successful
	81	rm -rf $TRACE_PATH
	82	else
	83	break
	84	fi
	85
	86	diag "Adding event $EVENT2"
	87	# second snapshot with 2 events
	88	lttng_enable_kernel_event $SESSION_NAME $EVENT2 $CHANNEL_NAME
	89	rm -rf $TRACE_PATH/snapshot/* 2>/dev/null
	90	lttng_snapshot_record $SESSION_NAME
78435723	91	validate_trace "${EVENT1},${EVENT2}" $TRACE_PATH/
07b86b52 JD	92	if [ $? -eq 0 ]; then
	93	# Only delete if successful
	94	rm -rf $TRACE_PATH
	95	else
	96	break
	97	fi
	98
96340a01	99	stop_lttng_tracing_ok $SESSION_NAME
67b4c664	100	destroy_lttng_session_ok $SESSION_NAME
07b86b52 JD	101	}
07b86b52 JD	102
0cb9c473	103	function generate_filter_events_cpu0()
086e6add	104	{
0cb9c473 MD	105	# Generate many events (fill buffers) on CPU 0
0cb9c473 MD	106	taskset 0x00000001 /bin/echo -n "$1" > /proc/lttng-test-filter-event 2> /dev/null
086e6add MD	107	}
	108
	109	function test_kernel_local_snapshot_discard ()
	110	{
	111	diag "Test local kernel snapshots with small discard buffers"
0cb9c473 MD	112
	113	local event_name="lttng_test_filter_event"
	114
	115	modprobe lttng-test
086e6add MD	116	create_lttng_session_no_output $SESSION_NAME
	117	enable_lttng_mmap_discard_small_kernel_channel $SESSION_NAME \
	118	$CHANNEL_NAME
0cb9c473	119	enable_kernel_lttng_event_ok $SESSION_NAME $event_name $CHANNEL_NAME
086e6add	120	start_lttng_tracing_ok $SESSION_NAME
9f0e230a	121	lttng_snapshot_add_output_ok $SESSION_NAME file://$TRACE_PATH
086e6add	122
0cb9c473	123	generate_filter_events_cpu0 10000
086e6add MD	124
	125	# Take first snapshot, remember first line.
	126	lttng_snapshot_record $SESSION_NAME
	127	FIRST_LINE="$(trace_first_line $TRACE_PATH/)"
	128	diag "First line (1st snapshot): $FIRST_LINE"
	129
	130	rm -rf $TRACE_PATH
	131
dcab3877	132	# Fill CPU 0's buffer and overwrite previous contents
0cb9c473	133	generate_filter_events_cpu0 10000
086e6add MD	134
	135	# Take 2nd snapshot, compare first line. In discard mode, they
	136	# should still be the same.
	137	lttng_snapshot_record $SESSION_NAME
	138	FIRST_LINE_2="$(trace_first_line $TRACE_PATH/)"
	139	diag "First line (2nd snapshot): $FIRST_LINE"
	140	rm -rf $TRACE_PATH
	141
	142	if [ x"$FIRST_LINE" != x"$FIRST_LINE_2" ]; then
ce83431d	143	fail "First snapshot event do not match"
086e6add	144	else
ce83431d	145	pass "First snapshot event match"
086e6add MD	146	fi
	147
	148	stop_lttng_tracing_ok $SESSION_NAME
	149	destroy_lttng_session_ok $SESSION_NAME
0cb9c473	150	modprobe --remove lttng-test
086e6add MD	151	}
	152
	153	function test_kernel_local_snapshot_overwrite_small_buffers ()
	154	{
	155	diag "Test local kernel snapshot with small overwrite buffers"
0cb9c473 MD	156
	157	local event_name="lttng_test_filter_event"
	158
	159	modprobe lttng-test
086e6add MD	160	create_lttng_session_no_output $SESSION_NAME
	161	enable_lttng_mmap_overwrite_small_kernel_channel $SESSION_NAME \
	162	$CHANNEL_NAME
0cb9c473	163	enable_kernel_lttng_event_ok $SESSION_NAME $event_name $CHANNEL_NAME
086e6add	164	start_lttng_tracing_ok $SESSION_NAME
9f0e230a	165	lttng_snapshot_add_output_ok $SESSION_NAME file://$TRACE_PATH
086e6add	166
0cb9c473	167	generate_filter_events_cpu0 10000
086e6add MD	168
	169	# Take first snapshot, remember first line.
	170	lttng_snapshot_record $SESSION_NAME
	171	FIRST_LINE="$(trace_first_line $TRACE_PATH/)"
	172	diag "First line (1st snapshot): $FIRST_LINE"
	173
	174	rm -rf $TRACE_PATH
	175
dcab3877	176	# Fill CPU 0's buffer and overwrite previous contents
0cb9c473	177	generate_filter_events_cpu0 10000
086e6add MD	178
	179	# Take 2nd snapshot, compare first line. In overwrite mode, they
	180	# WILL be different.
	181	lttng_snapshot_record $SESSION_NAME
	182	FIRST_LINE_2="$(trace_first_line $TRACE_PATH/)"
	183	diag "First line (2nd snapshot): $FIRST_LINE_2"
	184	rm -rf $TRACE_PATH
	185
	186	if [ x"$FIRST_LINE" != x"$FIRST_LINE_2" ]; then
ce83431d	187	pass "First snapshot event do not match"
086e6add	188	else
ce83431d	189	fail "First snapshot event match"
086e6add MD	190	fi
	191
	192	stop_lttng_tracing_ok $SESSION_NAME
	193	destroy_lttng_session_ok $SESSION_NAME
0cb9c473	194	modprobe --remove lttng-test
086e6add MD	195	}
086e6add MD	196
07b86b52 JD	197	function test_kernel_1000_local_snapshots ()
	198	{
	199	NB_SNAP=1000
	200
	201	diag "Test local kernel snapshots"
	202	create_lttng_session_no_output $SESSION_NAME
	203	enable_lttng_mmap_overwrite_kernel_channel $SESSION_NAME $CHANNEL_NAME
	204	lttng_enable_kernel_event $SESSION_NAME $EVENT_NAME $CHANNEL_NAME
e563bbdb	205	start_lttng_tracing_ok $SESSION_NAME
9f0e230a	206	lttng_snapshot_add_output_ok $SESSION_NAME file://$TRACE_PATH
07b86b52 JD	207	for i in $(seq 1 $NB_SNAP); do
	208	diag "Snapshot $i/$NB_SNAP"
	209	rm -rf $TRACE_PATH/snapshot/* 2>/dev/null
	210	lttng_snapshot_record $SESSION_NAME
	211	# Validate test
78435723	212	validate_trace $EVENT_NAME $TRACE_PATH/
07b86b52 JD	213	if [ $? -eq 0 ]; then
	214	# Only delete if successful
	215	rm -rf $TRACE_PATH
	216	else
	217	break
	218	fi
	219	done
96340a01	220	stop_lttng_tracing_ok $SESSION_NAME
67b4c664	221	destroy_lttng_session_ok $SESSION_NAME
07b86b52 JD	222	}
	223
	224	plan_tests $NUM_TESTS
	225
	226	print_test_banner "$TEST_DESC"
	227
c125de8f FD	228	bail_out_if_no_babeltrace
	229
	230
07b86b52 JD	231	if [ "$(id -u)" == "0" ]; then
	232	isroot=1
	233	else
	234	isroot=0
	235	fi
	236
ce83431d	237	skip $isroot "Root access is needed. Skipping all kernel snapshot tests" $NUM_TESTS \|\|
07b86b52	238	{
9c8a3964 JR	239
	240	validate_lttng_modules_present
	241
07b86b52 JD	242	start_lttng_sessiond
	243
	244	#tests=( test_kernel_1000_local_snapshots )
086e6add MD	245	tests=( test_kernel_local_snapshot
	246	test_kernel_local_snapshot_after_stop
	247	test_kernel_local_snapshot_append_to_metadata
	248	test_kernel_local_snapshot_discard
	249	test_kernel_local_snapshot_overwrite_small_buffers
	250	test_kernel_1000_local_snapshots
	251	)
07b86b52 JD	252
	253	for fct_test in ${tests[@]};
	254	do
	255	SESSION_NAME=$(randstring 16 0)
	256	${fct_test}
	257
	258	done
	259
	260	stop_lttng_sessiond
	261	}