[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
	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
	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
	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

	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

	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"

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
7539dcec	15	TRACE_PATH=$(mktemp --tmpdir -d tmp.test_snapshots_kernel_trace_path.XXXXXX)
07b86b52	16
e4061179	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
e4061179	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
07b86b52 JD	59	fi
	60	}
	61
	62	function test_kernel_local_snapshot_append_to_metadata ()
	63	{
78435723 JD	64	local EVENT1=sched_switch
78435723 JD	65	local EVENT2=sched_process_exit
07b86b52 JD	66
	67	diag "Test local kernel snapshots with one event $EVENT1"
	68	create_lttng_session_no_output $SESSION_NAME
	69	enable_lttng_mmap_overwrite_kernel_channel $SESSION_NAME $CHANNEL_NAME
	70	lttng_enable_kernel_event $SESSION_NAME $EVENT1 $CHANNEL_NAME
e563bbdb	71	start_lttng_tracing_ok $SESSION_NAME
9f0e230a	72	lttng_snapshot_add_output_ok $SESSION_NAME file://$TRACE_PATH
07b86b52 JD	73
	74	# first snapshot with only 1 event
	75	lttng_snapshot_record $SESSION_NAME
78435723	76	validate_trace $EVENT_NAME $TRACE_PATH/
07b86b52 JD	77	if [ $? -eq 0 ]; then
	78	# Only delete if successful
	79	rm -rf $TRACE_PATH
07b86b52 JD	80	fi
	81
	82	diag "Adding event $EVENT2"
	83	# second snapshot with 2 events
	84	lttng_enable_kernel_event $SESSION_NAME $EVENT2 $CHANNEL_NAME
	85	rm -rf $TRACE_PATH/snapshot/* 2>/dev/null
	86	lttng_snapshot_record $SESSION_NAME
78435723	87	validate_trace "${EVENT1},${EVENT2}" $TRACE_PATH/
07b86b52 JD	88	if [ $? -eq 0 ]; then
	89	# Only delete if successful
	90	rm -rf $TRACE_PATH
07b86b52 JD	91	fi
07b86b52 JD	92
96340a01	93	stop_lttng_tracing_ok $SESSION_NAME
67b4c664	94	destroy_lttng_session_ok $SESSION_NAME
07b86b52 JD	95	}
07b86b52 JD	96
43f71bbd	97	function generate_filter_events_cpu0()
086e6add	98	{
43f71bbd MD	99	# Generate many events (fill buffers) on CPU 0
43f71bbd MD	100	taskset 0x00000001 /bin/echo -n "$1" > /proc/lttng-test-filter-event 2> /dev/null
086e6add MD	101	}
	102
	103	function test_kernel_local_snapshot_discard ()
	104	{
	105	diag "Test local kernel snapshots with small discard buffers"
43f71bbd MD	106
	107	local event_name="lttng_test_filter_event"
	108
	109	modprobe lttng-test
086e6add MD	110	create_lttng_session_no_output $SESSION_NAME
	111	enable_lttng_mmap_discard_small_kernel_channel $SESSION_NAME \
	112	$CHANNEL_NAME
43f71bbd	113	enable_kernel_lttng_event_ok $SESSION_NAME $event_name $CHANNEL_NAME
086e6add	114	start_lttng_tracing_ok $SESSION_NAME
9f0e230a	115	lttng_snapshot_add_output_ok $SESSION_NAME file://$TRACE_PATH
086e6add	116
43f71bbd	117	generate_filter_events_cpu0 10000
086e6add MD	118
	119	# Take first snapshot, remember first line.
	120	lttng_snapshot_record $SESSION_NAME
	121	FIRST_LINE="$(trace_first_line $TRACE_PATH/)"
	122	diag "First line (1st snapshot): $FIRST_LINE"
	123
	124	rm -rf $TRACE_PATH
	125
43f71bbd	126	generate_filter_events_cpu0 10000
086e6add MD	127
	128	# Take 2nd snapshot, compare first line. In discard mode, they
	129	# should still be the same.
	130	lttng_snapshot_record $SESSION_NAME
	131	FIRST_LINE_2="$(trace_first_line $TRACE_PATH/)"
	132	diag "First line (2nd snapshot): $FIRST_LINE"
	133	rm -rf $TRACE_PATH
	134
	135	if [ x"$FIRST_LINE" != x"$FIRST_LINE_2" ]; then
ce83431d	136	fail "First snapshot event do not match"
086e6add	137	else
ce83431d	138	pass "First snapshot event match"
086e6add MD	139	fi
	140
	141	stop_lttng_tracing_ok $SESSION_NAME
	142	destroy_lttng_session_ok $SESSION_NAME
43f71bbd	143	modprobe --remove lttng-test
086e6add MD	144	}
	145
	146	function test_kernel_local_snapshot_overwrite_small_buffers ()
	147	{
	148	diag "Test local kernel snapshot with small overwrite buffers"
43f71bbd MD	149
	150	local event_name="lttng_test_filter_event"
	151
	152	modprobe lttng-test
086e6add MD	153	create_lttng_session_no_output $SESSION_NAME
	154	enable_lttng_mmap_overwrite_small_kernel_channel $SESSION_NAME \
	155	$CHANNEL_NAME
43f71bbd	156	enable_kernel_lttng_event_ok $SESSION_NAME $event_name $CHANNEL_NAME
086e6add	157	start_lttng_tracing_ok $SESSION_NAME
9f0e230a	158	lttng_snapshot_add_output_ok $SESSION_NAME file://$TRACE_PATH
086e6add	159
43f71bbd	160	generate_filter_events_cpu0 10000
086e6add MD	161
	162	# Take first snapshot, remember first line.
	163	lttng_snapshot_record $SESSION_NAME
	164	FIRST_LINE="$(trace_first_line $TRACE_PATH/)"
	165	diag "First line (1st snapshot): $FIRST_LINE"
	166
	167	rm -rf $TRACE_PATH
	168
43f71bbd	169	generate_filter_events_cpu0 10000
086e6add MD	170
	171	# Take 2nd snapshot, compare first line. In overwrite mode, they
	172	# WILL be different.
	173	lttng_snapshot_record $SESSION_NAME
	174	FIRST_LINE_2="$(trace_first_line $TRACE_PATH/)"
	175	diag "First line (2nd snapshot): $FIRST_LINE_2"
	176	rm -rf $TRACE_PATH
	177
	178	if [ x"$FIRST_LINE" != x"$FIRST_LINE_2" ]; then
ce83431d	179	pass "First snapshot event do not match"
086e6add	180	else
ce83431d	181	fail "First snapshot event match"
086e6add MD	182	fi
	183
	184	stop_lttng_tracing_ok $SESSION_NAME
	185	destroy_lttng_session_ok $SESSION_NAME
43f71bbd	186	modprobe --remove lttng-test
086e6add MD	187	}
086e6add MD	188
07b86b52 JD	189	function test_kernel_1000_local_snapshots ()
	190	{
	191	NB_SNAP=1000
	192
	193	diag "Test local kernel snapshots"
	194	create_lttng_session_no_output $SESSION_NAME
	195	enable_lttng_mmap_overwrite_kernel_channel $SESSION_NAME $CHANNEL_NAME
	196	lttng_enable_kernel_event $SESSION_NAME $EVENT_NAME $CHANNEL_NAME
e563bbdb	197	start_lttng_tracing_ok $SESSION_NAME
9f0e230a	198	lttng_snapshot_add_output_ok $SESSION_NAME file://$TRACE_PATH
07b86b52 JD	199	for i in $(seq 1 $NB_SNAP); do
	200	diag "Snapshot $i/$NB_SNAP"
	201	rm -rf $TRACE_PATH/snapshot/* 2>/dev/null
	202	lttng_snapshot_record $SESSION_NAME
	203	# Validate test
78435723	204	validate_trace $EVENT_NAME $TRACE_PATH/
07b86b52 JD	205	if [ $? -eq 0 ]; then
	206	# Only delete if successful
	207	rm -rf $TRACE_PATH
	208	else
	209	break
	210	fi
	211	done
96340a01	212	stop_lttng_tracing_ok $SESSION_NAME
67b4c664	213	destroy_lttng_session_ok $SESSION_NAME
07b86b52 JD	214	}
	215
	216	plan_tests $NUM_TESTS
	217
	218	print_test_banner "$TEST_DESC"
	219
	220	if [ "$(id -u)" == "0" ]; then
	221	isroot=1
	222	else
	223	isroot=0
	224	fi
	225
ce83431d	226	skip $isroot "Root access is needed. Skipping all kernel snapshot tests" $NUM_TESTS \|\|
07b86b52	227	{
9c8a3964 JR	228
	229	validate_lttng_modules_present
	230
07b86b52 JD	231	start_lttng_sessiond
	232
	233	#tests=( test_kernel_1000_local_snapshots )
086e6add MD	234	tests=( test_kernel_local_snapshot
	235	test_kernel_local_snapshot_after_stop
	236	test_kernel_local_snapshot_append_to_metadata
	237	test_kernel_local_snapshot_discard
	238	test_kernel_local_snapshot_overwrite_small_buffers
	239	test_kernel_1000_local_snapshots
	240	)
07b86b52 JD	241
	242	for fct_test in ${tests[@]};
	243	do
	244	SESSION_NAME=$(randstring 16 0)
	245	${fct_test}
	246
	247	done
	248
	249	stop_lttng_sessiond
	250	}