File: test_ust_app_ctl_paths

package info (click to toggle)
ltt-control 2.14.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 21,860 kB
  • sloc: cpp: 192,012; sh: 28,777; ansic: 10,960; python: 7,108; makefile: 3,520; java: 109; xml: 46
file content (361 lines) | stat: -rwxr-xr-x 11,952 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
#!/bin/bash
#
# SPDX-FileCopyrightText: 2023 Kienan Stewart <kstewart@efficios.com>
#
# SPDX-License-Identifier: LGPL-2.1-only
#

TEST_DESC="Verifies the sessiond and traced applications with different combinations of LTTNG_UST_APP_PATH and LTTNG_UST_CTL_PATH settings."

CURDIR="$(dirname "${0}")"
TESTDIR="${CURDIR}/../../../"

NUM_TESTS=98

# shellcheck source=../../../utils/utils.sh
source "${TESTDIR}/utils/utils.sh"

TESTAPP="${TESTDIR}/utils/testapp/gen-ust-events/gen-ust-events"
EVENT_NAMES="tp:tptest"
SESSION_NAME="ust-app-ctl-path"
CHANNEL_NAME="ust-app-ctl-path"

function test_sessiond_started_before_app()
{
	CTL_PATH="$(mktemp -d -t "tmp.${FUNCNAME[0]}.ctl.XXXXXX")"
	TRACE_PATH="$(mktemp -d -t "tmp.${FUNCNAME[0]}.trace.XXXXXX")"
	env_vars=(
		LTTNG_UST_CTL_PATH="${CTL_PATH}"
	)

	# shellcheck disable=SC2119
	LTTNG_SESSIOND_ENV_VARS="${env_vars[*]}" start_lttng_sessiond
	create_lttng_session_ok "${SESSION_NAME}" "${TRACE_PATH}"
	enable_ust_lttng_channel_ok "${SESSION_NAME}" "${CHANNEL_NAME}"
	enable_ust_lttng_event_ok "${SESSION_NAME}" "--all" "${CHANNEL_NAME}"
	start_lttng_tracing_ok "${SESSION_NAME}"
	LTTNG_UST_APP_PATH="${CTL_PATH}" "${TESTAPP}" -i 100 -w 0
	stop_lttng_tracing_ok "${SESSION_NAME}"
	destroy_lttng_session_ok "${SESSION_NAME}" --no-wait
	# shellcheck disable=SC2119
	stop_lttng_sessiond

	validate_trace_count "${EVENT_NAMES}" "${TRACE_PATH}" 100
	rm -rf "${TRACE_PATH}" "${CTL_PATH}"
}

function test_sessiond_started_after_app()
{
	CTL_PATH="$(mktemp -d -t "tmp.${FUNCNAME[0]}.ctl.XXXXXX")"
	TRACE_PATH="$(mktemp -d -t "tmp.${FUNCNAME[0]}.trace.XXXXXX")"
	SYNC_FILE=$(mktemp -d)
	env_vars=(
		LTTNG_UST_CTL_PATH="${CTL_PATH}"
	)

	LTTNG_UST_APP_PATH="${CTL_PATH}" "${TESTAPP}" -b "${SYNC_FILE}/a" &
	APP_PID="${!}"

	# shellcheck disable=SC2119
	LTTNG_SESSIOND_ENV_VARS="${env_vars[*]}" start_lttng_sessiond
	create_lttng_session_ok "${SESSION_NAME}" "${TRACE_PATH}"
	enable_ust_lttng_channel_ok "${SESSION_NAME}" "${CHANNEL_NAME}"
	enable_ust_lttng_event_ok "${SESSION_NAME}" "--all" "${CHANNEL_NAME}"
	start_lttng_tracing_ok "${SESSION_NAME}"
	touch "${SYNC_FILE}/a"
	wait "${APP_PID}"
	stop_lttng_tracing_ok "${SESSION_NAME}"
	destroy_lttng_session_ok "${SESSION_NAME}" --no-wait
	# shellcheck disable=SC2119
	stop_lttng_sessiond

	validate_trace "${EVENT_NAMES}" "${TRACE_PATH}"
	rm -rf "${TRACE_PATH}" "${CTL_PATH}" "${SYNC_FILE}"
}

function test_multi_sessiond()
{
	N_SESSIOND=3
	CTL_PATH_BASE="$(mktemp -d -t "tmp.${FUNCNAME[0]}.ctl.XXXXXX")"
	TRACE_PATH_BASE="$(mktemp -d -t "tmp.${FUNCNAME[0]}.trace.XXXXXX")"
	LTTNG_HOME_BASE="$(mktemp -d -t "tmp.${FUNCNAME[0]}.lttng-home.XXXXXX")"
	LTTNG_HOME_ORIG="${LTTNG_HOME}"

	for i in $(seq 1 "${N_SESSIOND}") ; do
		CTL_PATH="${CTL_PATH_BASE}/$i"
		TRACE_PATH="${TRACE_PATH_BASE}/$i"
		LTTNG_HOME="${LTTNG_HOME_BASE}/$i"
		mkdir -p "${CTL_PATH}" "${TRACE_PATH}" "${LTTNG_HOME}"
		env_vars=(
			LTTNG_HOME="${LTTNG_HOME}"
			LTTNG_UST_CTL_PATH="${CTL_PATH}"
			TEST_IGNORE_EXISTING_SESSIOND=1
		)
		if [ "${UID}" == "0" ] ; then
			env_vars+=(LTTNG_RUNDIR="${LTTNG_HOME_BASE}/$i")
		fi
		# shellcheck disable=SC2119
		LTTNG_SESSIOND_ENV_VARS="${env_vars[*]}" start_lttng_sessiond
		export "${env_vars[@]}"
		create_lttng_session_ok "${SESSION_NAME}" "${TRACE_PATH}"
		enable_ust_lttng_channel_ok "${SESSION_NAME}" "${CHANNEL_NAME}"
		enable_ust_lttng_event_ok "${SESSION_NAME}" "--all" "${CHANNEL_NAME}"
		start_lttng_tracing_ok "${SESSION_NAME}"
		unset LTTNG_HOME
		unset LTTNG_RUNDIR
		unset LTTNG_UST_CTL_PATH
	done
	for i in $(seq 1 "${N_SESSIOND}") ; do
		LTTNG_UST_APP_PATH="${CTL_PATH_BASE}/$i" "${TESTAPP}" -i 100 -w 0
	done
	for i in $(seq 1 "${N_SESSIOND}") ; do
		env_vars=(
			LTTNG_HOME="${LTTNG_HOME_BASE}/$i"
		)
		if [ "${UID}" == "0" ] ; then
			env_vars+=(LTTNG_RUNDIR="${LTTNG_HOME_BASE}/$i")
		fi
		export "${env_vars[@]}"
		stop_lttng_tracing_ok "${SESSION_NAME}"
		destroy_lttng_session_ok "${SESSION_NAME}" --no-wait
		unset LTTNG_HOME LTTNG_RUNDIR
		validate_trace_count "${EVENT_NAMES}" "${TRACE_PATH_BASE}/$i" 100
	done
	# shellcheck disable=SC2119
	stop_lttng_sessiond

	# Cleanup
	rm -rf "${TRACE_PATH_BASE}" "${CTL_PATH_BASE}" "${LTTNG_HOME_BASE}"
	unset TEST_IGNORE_EXISTING_SESSIOND LTTNG_UST_CTL_PATH
	if [ "${LTTNG_HOME_ORIG}" != "" ] ; then
		export LTTNG_HOME="${LTTNG_HOME_ORIG}"
	fi
}

function test_multi_sessiond_default()
{
	diag "Verifies that the lttng_session_daemon_alive()/set_session_daemon_path() in liblttng is coherent with LTTNG_UST_CTL_PATH"

	LTTNG_HOME_B="$(mktemp -d -t "tmp.${FUNCNAME[0]}.lttng-home.XXXXXX")"
	TRACE_PATH="$(mktemp -d -t "tmp.${FUNCNAME[0]}.trace.XXXXXX")"
	LTTNG_HOME_ORIG="${LTTNG_HOME}"

	# shellcheck disable=SC2119
	start_lttng_sessiond

	LTTNG_UST_APP_PATH="${LTTNG_HOME_B}/.lttng"
	env_vars_b=(
		LTTNG_HOME="${LTTNG_HOME_B}"
		TEST_IGNORE_EXISTING_SESSIOND=1
	)
	if [ "${UID}" == "0" ] ; then
		env_vars_b+=(LTTNG_RUNDIR="${LTTNG_HOME_B}")
		LTTNG_UST_APP_PATH="${LTTNG_HOME_B}"
	fi
	export "${env_vars_b[@]}"
	# shellcheck disable=SC2119
	LTTNG_SESSIOND_ENV_VARS="${env_vars_b[*]}" start_lttng_sessiond

	create_lttng_session_ok "${SESSION_NAME}" "${TRACE_PATH}"
	enable_ust_lttng_channel_ok "${SESSION_NAME}" "${CHANNEL_NAME}"
	enable_ust_lttng_event_ok "${SESSION_NAME}" "--all" "${CHANNEL_NAME}"
	start_lttng_tracing_ok "${SESSION_NAME}"
	LTTNG_UST_APP_PATH="${LTTNG_UST_APP_PATH}" "${TESTAPP}" -i 100 -w 0
	stop_lttng_tracing_ok "${SESSION_NAME}"
	destroy_lttng_session_ok "${SESSION_NAME}" --no-wait
	unset LTTNG_HOME LTTNG_RUNDIR
	validate_trace_count "${EVENT_NAMES}" "${TRACE_PATH}" 100

	# shellcheck disable=SC2119
	stop_lttng_sessiond

	unset LTTNG_HOME LTTNG_RUNDIR TEST_IGNORE_EXISTING_SESSIOND
	if [ "${LTTNG_HOME_ORIG}" != "" ] ; then
		export LTTNG_HOME="${LTTNG_HOME_ORIG}"
	fi
	rm -rf "${LTTNG_HOME_B}" "${TRACE_PATH}"
}

function test_trace_another_sessiond()
{
	CTL_PATH="$(mktemp -d -t "tmp.${FUNCNAME[0]}.ctl.XXXXXX")"
	TRACE_PATH_A="$(mktemp -d -t "tmp.${FUNCNAME[0]}.trace_a.XXXXXX")"
	TRACE_PATH_B="$(mktemp -d -t "tmp.${FUNCNAME[0]}.trace_b.XXXXXX")"
	LTTNG_HOME_A="$(mktemp -d -t "tmp.${FUNCNAME[0]}.lttng-home.XXXXXX")"
	LTTNG_HOME_ORIG="${LTTNG_HOME}"

	# This sessiond will trace a new one that will be started
	env_vars_a=(
		LTTNG_UST_CTL_PATH="${CTL_PATH}"
		LTTNG_HOME="${LTTNG_HOME_A}"
		TEST_IGNORE_EXISTING_SESSIOND=1
	)
	if [ "${UID}" == "0" ] ; then
		env_vars_a+=(LTTNG_RUNDIR="${LTTNG_HOME_A}")
	fi
	export "${env_vars_a[@]}"

	# shellcheck disable=SC2119
	LTTNG_SESSIOND_ENV_VARS="${env_vars_a[*]}" start_lttng_sessiond
	create_lttng_session_ok "${SESSION_NAME}" "${TRACE_PATH_A}"
	enable_ust_lttng_channel_ok "${SESSION_NAME}" "${CHANNEL_NAME}"
	enable_ust_lttng_event_ok "${SESSION_NAME}" "--all" "${CHANNEL_NAME}"
	start_lttng_tracing_ok "${SESSION_NAME}"
	unset LTTNG_HOME LTTNG_RUNDIR LTTNG_UST_CTL_PATH

	if [ "${LTTNG_HOME_ORIG}" != "" ] ; then
		export LTTNG_HOME="${LTTNG_HOME_ORIG}"
	fi
	# This sessiond will be traced
	env_vars_b=(
		LTTNG_UST_APP_PATH="${CTL_PATH}"
		TEST_IGNORE_EXISTING_SESSIOND=1
		LD_PRELOAD="liblttng-ust-fd.so:liblttng-ust-fork.so"
	)

	# shellcheck disable=SC2119
	LTTNG_SESSIOND_ENV_VARS="${env_vars_b[*]}" start_lttng_sessiond
	create_lttng_session_ok "${SESSION_NAME}" "${TRACE_PATH_B}"
	enable_ust_lttng_channel_ok "${SESSION_NAME}" "${CHANNEL_NAME}"
	enable_ust_lttng_event_ok "${SESSION_NAME}" "--all" "${CHANNEL_NAME}"
	start_lttng_tracing_ok "${SESSION_NAME}"

	"${TESTAPP}" -i 100 -w 0

	stop_lttng_tracing_ok "${SESSION_NAME}"
	destroy_lttng_session_ok "${SESSION_NAME}" --no-wait
	validate_trace_count "${EVENT_NAMES}" "${TRACE_PATH_B}" 100
	unset LTTNG_HOME LTTNG_RUNDIR LTTNG_UST_CTL_PATH TEST_IGNORE_EXISTING_SESSIOND

	# Confirm that we get traced data from the subordinate sessiond
	export "${env_vars_a[@]}"
	stop_lttng_tracing_ok "${SESSION_NAME}"
	destroy_lttng_session_ok "${SESSION_NAME}" --no-wait
	EVENT_COUNT="$("${BABELTRACE_BIN}" "${TRACE_PATH_A}" | wc -l)"
	isnt "${EVENT_COUNT}" "0" "More than zero events were expected"

	# shellcheck disable=SC2119
	stop_lttng_sessiond

	# Cleanup
	rm -rf "${TRACE_PATH_A}" "{$TRACE_PATH_B}" "${LTTNG_HOME_A}" "${CTL_PATH}"
	unset LTTNG_HOME LTTNG_RUNDIR LTTNG_UST_CTL_PATH TEST_IGNORE_EXISTING_SESSIOND
	if [ "${LTTNG_HOME_ORIG}" != "" ] ; then
		export LTTNG_HOME="${LTTNG_HOME_ORIG}"
	fi
}

function test_trace_self_default_paths()
{
	TRACE_PATH="$(mktemp -d -t "tmp.${FUNCNAME[0]}.trace.XXXXXX")"

	env_vars=(
		LD_PRELOAD="liblttng-ust-fd.so:liblttng-ust-fork.so"
		# Don't block during registration
		LTTNG_UST_REGISTER_TIMEOUT=0
	)
	# shellcheck disable=SC2119
	LTTNG_SESSIOND_ENV_VARS="${env_vars[*]}" start_lttng_sessiond
	create_lttng_session_ok "${SESSION_NAME}" "${TRACE_PATH}"
	enable_ust_lttng_channel_ok "${SESSION_NAME}" "${CHANNEL_NAME}"
	add_context_ust_ok "${SESSION_NAME}" "${CHANNEL_NAME}" vpid -t procname
	enable_ust_lttng_event_ok "${SESSION_NAME}" "--all" "${CHANNEL_NAME}" -x "${EVENT_NAMES}"
	start_lttng_tracing_ok "${SESSION_NAME}"
	stop_lttng_tracing_ok "${SESSION_NAME}"
	destroy_lttng_session_ok "${SESSION_NAME}"

	LTTNG_UST_APP_PATH="${CTL_PATH}" \
					  LTTNG_UST_WITHOUT_BADDR_STATEDUMP=1 \
					  LTTNG_UST_WITHOUT_PROCNAME_STATEDUMP=1 \
					  "${TESTAPP}" -i 100 -w 0 &
	APP_PID="${!}"

	EVENT_COUNT="$("${BABELTRACE_BIN}" "${TRACE_PATH}" | grep -v "vpid = ${APP_PID}" -c)"
	isnt "${EVENT_COUNT}" "0" "More than zero events were expected"

	# shellcheck disable=SC2119
	stop_lttng_sessiond
	# Cleanup
	rm -rf "${TRACE_PATH}"
}

function test_trace_self_app_and_ctl_paths()
{
	CTL_PATH="$(mktemp -d -t "tmp.${FUNCNAME[0]}.ctl.XXXXXX")"
	TRACE_PATH="$(mktemp -d -t "tmp.${FUNCNAME[0]}.trace.XXXXXX")"

	env_vars=(
		LTTNG_UST_APP_PATH="${CTL_PATH}"
		LTTNG_UST_CTL_PATH="${CTL_PATH}"
		LD_PRELOAD="liblttng-ust-fd.so:liblttng-ust-fork.so"
		# Don't block during registration
		LTTNG_UST_REGISTER_TIMEOUT=0
	)
	# shellcheck disable=SC2119
	LTTNG_SESSIOND_ENV_VARS="${env_vars[*]}" start_lttng_sessiond
	create_lttng_session_ok "${SESSION_NAME}" "${TRACE_PATH}"
	enable_ust_lttng_channel_ok "${SESSION_NAME}" "${CHANNEL_NAME}"
	add_context_ust_ok "${SESSION_NAME}" "${CHANNEL_NAME}" vpid -t procname
	enable_ust_lttng_event_ok "${SESSION_NAME}" "--all" "${CHANNEL_NAME}" -x "${EVENT_NAMES}"
	start_lttng_tracing_ok "${SESSION_NAME}"

	LTTNG_UST_APP_PATH="${CTL_PATH}" \
					  LTTNG_UST_WITHOUT_BADDR_STATEDUMP=1 \
					  LTTNG_UST_WITHOUT_PROCNAME_STATEDUMP=1 \
					  "${TESTAPP}" -i 100 -w 0 &
	APP_PID="${!}"

	stop_lttng_tracing_ok "${SESSION_NAME}"
	destroy_lttng_session_ok "${SESSION_NAME}" --no-wait

	EVENT_COUNT="$("${BABELTRACE_BIN}" "${TRACE_PATH}" | grep -v "vpid = ${APP_PID}" -c)"
	isnt "${EVENT_COUNT}" "0" "More than zero events were expected"

	# shellcheck disable=SC2119
	stop_lttng_sessiond
	# Cleanup
	rm -rf "${TRACE_PATH}" "${CTL_PATH}"
}

function test_sessiond_bad_ctl_path() {
	diag "Test that starting a sessiond with a LTTNG_UST_CTL_PATH that doesn't exist fails"
	CTL_PATH="$(mktemp -d -t "tmp.${FUNCNAME[0]}.ctl.XXXXXX")"
	rm -rf "${CTL_PATH}"

	env_vars=(
		LTTNG_UST_APP_PATH="${CTL_PATH}"
		LTTNG_UST_CTL_PATH="${CTL_PATH}"
	)
	# shellcheck disable=SC2119
	LTTNG_SESSIOND_ENV_VARS="${env_vars[*]}" start_lttng_sessiond_fail
	LTTNG_UST_APP_PATH="${CTL_PATH}" \
					  LTTNG_UST_WITHOUT_BADDR_STATEDUMP=1 \
					  LTTNG_UST_WITHOUT_PROCNAME_STATEDUMP=1 \
					  "${TESTAPP}" -i 100 -w 0 &
	APP_PID="${!}"
	wait "${APP_PID}"
	ok "${?}" "Test application exited successfully"

	# shellcheck disable=SC2119
	stop_lttng_sessiond_cleanup
}

plan_tests "${NUM_TESTS}"
print_test_banner "${TEST_DESC}"
bail_out_if_no_babeltrace

TESTS=(
	test_sessiond_started_before_app
	test_sessiond_started_after_app
	test_multi_sessiond
	test_multi_sessiond_default
	test_trace_another_sessiond
	test_trace_self_default_paths
	test_trace_self_app_and_ctl_paths
	test_sessiond_bad_ctl_path
)

for TEST in "${TESTS[@]}" ; do
    "${TEST}"
    lttng_pgrep "${SESSIOND_MATCH}"
done