Debian Codegraph @

tests/regression/ust/ust-app-ctl-paths/test_ust_app_ctl_paths

raw
1 #!/bin/bash
2 #
3 # SPDX-FileCopyrightText: 2023 Kienan Stewart <[email protected]>
4 #
5 # SPDX-License-Identifier: LGPL-2.1-only
6 #
7
8 TEST_DESC="Verifies the sessiond and traced applications with different combinations of LTTNG_UST_APP_PATH and LTTNG_UST_CTL_PATH settings."
9
10 CURDIR="$(dirname "${0}")"
11 TESTDIR="${CURDIR}/../../../"
12
13 NUM_TESTS=98
14
15 # shellcheck source=../../../utils/utils.sh
16 source "${TESTDIR}/utils/utils.sh"
17
18 TESTAPP="${TESTDIR}/utils/testapp/gen-ust-events"
19 EVENT_NAMES="tp:tptest"
20 SESSION_NAME="ust-app-ctl-path"
21 CHANNEL_NAME="ust-app-ctl-path"
22
23 function test_sessiond_started_before_app()
24 {
25 CTL_PATH="$(mktemp -d -t "tmp.${FUNCNAME[0]}.ctl.XXXXXX")"
26 TRACE_PATH="$(mktemp -d -t "tmp.${FUNCNAME[0]}.trace.XXXXXX")"
27 env_vars=(
28 LTTNG_UST_CTL_PATH="${CTL_PATH}"
29 )
30
31 LTTNG_SESSIOND_ENV_VARS="${env_vars[*]}" start_lttng_sessiond
32 create_lttng_session_ok "${SESSION_NAME}" "${TRACE_PATH}"
33 enable_ust_lttng_channel_ok "${SESSION_NAME}" "${CHANNEL_NAME}"
34 enable_ust_lttng_event_ok "${SESSION_NAME}" "--all" "${CHANNEL_NAME}"
35 start_lttng_tracing_ok "${SESSION_NAME}"
36 LTTNG_UST_APP_PATH="${CTL_PATH}" "${TESTAPP}" -i 100 -w 0
37 stop_lttng_tracing_ok "${SESSION_NAME}"
38 destroy_lttng_session_ok "${SESSION_NAME}" --no-wait
39 stop_lttng_sessiond
40
41 validate_trace_count "${EVENT_NAMES}" "${TRACE_PATH}" 100
42 rm -rf "${TRACE_PATH}" "${CTL_PATH}"
43 }
44
45 function test_sessiond_started_after_app()
46 {
47 CTL_PATH="$(mktemp -d -t "tmp.${FUNCNAME[0]}.ctl.XXXXXX")"
48 TRACE_PATH="$(mktemp -d -t "tmp.${FUNCNAME[0]}.trace.XXXXXX")"
49 SYNC_FILE=$(mktemp -d)
50 env_vars=(
51 LTTNG_UST_CTL_PATH="${CTL_PATH}"
52 )
53
54 LTTNG_UST_APP_PATH="${CTL_PATH}" "${TESTAPP}" -b "${SYNC_FILE}/a" &
55 APP_PID="${!}"
56
57 LTTNG_SESSIOND_ENV_VARS="${env_vars[*]}" start_lttng_sessiond
58 create_lttng_session_ok "${SESSION_NAME}" "${TRACE_PATH}"
59 enable_ust_lttng_channel_ok "${SESSION_NAME}" "${CHANNEL_NAME}"
60 enable_ust_lttng_event_ok "${SESSION_NAME}" "--all" "${CHANNEL_NAME}"
61 start_lttng_tracing_ok "${SESSION_NAME}"
62 touch "${SYNC_FILE}/a"
63 wait "${APP_PID}"
64 stop_lttng_tracing_ok "${SESSION_NAME}"
65 destroy_lttng_session_ok "${SESSION_NAME}" --no-wait
66 stop_lttng_sessiond
67
68 validate_trace "${EVENT_NAMES}" "${TRACE_PATH}"
69 rm -rf "${TRACE_PATH}" "${CTL_PATH}" "${SYNC_FILE}"
70 }
71
72 function test_multi_sessiond()
73 {
74 N_SESSIOND=3
75 CTL_PATH_BASE="$(mktemp -d -t "tmp.${FUNCNAME[0]}.ctl.XXXXXX")"
76 TRACE_PATH_BASE="$(mktemp -d -t "tmp.${FUNCNAME[0]}.trace.XXXXXX")"
77 LTTNG_HOME_BASE="$(mktemp -d -t "tmp.${FUNCNAME[0]}.lttng-home.XXXXXX")"
78 LTTNG_HOME_ORIG="${LTTNG_HOME}"
79
80 for i in $(seq 1 "${N_SESSIOND}") ; do
81 CTL_PATH="${CTL_PATH_BASE}/$i"
82 TRACE_PATH="${TRACE_PATH_BASE}/$i"
83 LTTNG_HOME="${LTTNG_HOME_BASE}/$i"
84 mkdir -p "${CTL_PATH}" "${TRACE_PATH}" "${LTTNG_HOME}"
85 env_vars=(
86 LTTNG_HOME="${LTTNG_HOME}"
87 LTTNG_UST_CTL_PATH="${CTL_PATH}"
88 TEST_IGNORE_EXISTING_SESSIOND=1
89 )
90 if [ "${UID}" == "0" ] ; then
91 env_vars+=(LTTNG_RUNDIR="${LTTNG_HOME_BASE}/$i")
92 fi
93 LTTNG_SESSIOND_ENV_VARS="${env_vars[*]}" start_lttng_sessiond
94 export "${env_vars[@]}"
95 create_lttng_session_ok "${SESSION_NAME}" "${TRACE_PATH}"
96 enable_ust_lttng_channel_ok "${SESSION_NAME}" "${CHANNEL_NAME}"
97 enable_ust_lttng_event_ok "${SESSION_NAME}" "--all" "${CHANNEL_NAME}"
98 start_lttng_tracing_ok "${SESSION_NAME}"
99 unset LTTNG_HOME
100 unset LTTNG_RUNDIR
101 unset LTTNG_UST_CTL_PATH
102 done
103 for i in $(seq 1 "${N_SESSIOND}") ; do
104 LTTNG_UST_APP_PATH="${CTL_PATH_BASE}/$i" "${TESTAPP}" -i 100 -w 0
105 done
106 for i in $(seq 1 "${N_SESSIOND}") ; do
107 env_vars=(
108 LTTNG_HOME="${LTTNG_HOME_BASE}/$i"
109 )
110 if [ "${UID}" == "0" ] ; then
111 env_vars+=(LTTNG_RUNDIR="${LTTNG_HOME_BASE}/$i")
112 fi
113 export "${env_vars[@]}"
114 stop_lttng_tracing_ok "${SESSION_NAME}"
115 destroy_lttng_session_ok "${SESSION_NAME}" --no-wait
116 unset LTTNG_HOME LTTNG_RUNDIR
117 validate_trace_count "${EVENT_NAMES}" "${TRACE_PATH_BASE}/$i" 100
118 done
119 stop_lttng_sessiond
120
121 # Cleanup
122 rm -rf "${TRACE_PATH_BASE}" "${CTL_PATH_BASE}" "${LTTNG_HOME_BASE}"
123 unset TEST_IGNORE_EXISTING_SESSIOND LTTNG_UST_CTL_PATH
124 if [ "${LTTNG_HOME_ORIG}" != "" ] ; then
125 export LTTNG_HOME="${LTTNG_HOME_ORIG}"
126 fi
127 }
128
129 function test_multi_sessiond_default()
130 {
131 diag "Verifies that the lttng_session_daemon_alive()/set_session_daemon_path() in liblttng is coherent with LTTNG_UST_CTL_PATH"
132
133 LTTNG_HOME_B="$(mktemp -d -t "tmp.${FUNCNAME[0]}.lttng-home.XXXXXX")"
134 TRACE_PATH="$(mktemp -d -t "tmp.${FUNCNAME[0]}.trace.XXXXXX")"
135 LTTNG_HOME_ORIG="${LTTNG_HOME}"
136
137 start_lttng_sessiond
138
139 LTTNG_UST_APP_PATH="${LTTNG_HOME_B}/.lttng"
140 env_vars_b=(
141 LTTNG_HOME="${LTTNG_HOME_B}"
142 TEST_IGNORE_EXISTING_SESSIOND=1
143 )
144 if [ "${UID}" == "0" ] ; then
145 env_vars_b+=(LTTNG_RUNDIR="${LTTNG_HOME_B}")
146 LTTNG_UST_APP_PATH="${LTTNG_HOME_B}"
147 fi
148 export "${env_vars_b[@]}"
149 LTTNG_SESSIOND_ENV_VARS="${env_vars_b[*]}" start_lttng_sessiond
150
151 create_lttng_session_ok "${SESSION_NAME}" "${TRACE_PATH}"
152 enable_ust_lttng_channel_ok "${SESSION_NAME}" "${CHANNEL_NAME}"
153 enable_ust_lttng_event_ok "${SESSION_NAME}" "--all" "${CHANNEL_NAME}"
154 start_lttng_tracing_ok "${SESSION_NAME}"
155 LTTNG_UST_APP_PATH="${LTTNG_UST_APP_PATH}" "${TESTAPP}" -i 100 -w 0
156 stop_lttng_tracing_ok "${SESSION_NAME}"
157 destroy_lttng_session_ok "${SESSION_NAME}" --no-wait
158 unset LTTNG_HOME LTTNG_RUNDIR
159 validate_trace_count "${EVENT_NAMES}" "${TRACE_PATH}" 100
160
161 stop_lttng_sessiond
162
163 unset LTTNG_HOME LTTNG_RUNDIR TEST_IGNORE_EXISTING_SESSIOND
164 if [ "${LTTNG_HOME_ORIG}" != "" ] ; then
165 export LTTNG_HOME="${LTTNG_HOME_ORIG}"
166 fi
167 rm -rf "${LTTNG_HOME_B}" "${TRACE_PATH}"
168 }
169
170 function test_trace_another_sessiond()
171 {
172 CTL_PATH="$(mktemp -d -t "tmp.${FUNCNAME[0]}.ctl.XXXXXX")"
173 TRACE_PATH_A="$(mktemp -d -t "tmp.${FUNCNAME[0]}.trace_a.XXXXXX")"
174 TRACE_PATH_B="$(mktemp -d -t "tmp.${FUNCNAME[0]}.trace_b.XXXXXX")"
175 LTTNG_HOME_A="$(mktemp -d -t "tmp.${FUNCNAME[0]}.lttng-home.XXXXXX")"
176 LTTNG_HOME_ORIG="${LTTNG_HOME}"
177
178 # This sessiond will trace a new one that will be started
179 env_vars_a=(
180 LTTNG_UST_CTL_PATH="${CTL_PATH}"
181 LTTNG_HOME="${LTTNG_HOME_A}"
182 TEST_IGNORE_EXISTING_SESSIOND=1
183 )
184 if [ "${UID}" == "0" ] ; then
185 env_vars_a+=(LTTNG_RUNDIR="${LTTNG_HOME_A}")
186 fi
187 export "${env_vars_a[@]}"
188
189 LTTNG_SESSIOND_ENV_VARS="${env_vars_a[*]}" start_lttng_sessiond
190 create_lttng_session_ok "${SESSION_NAME}" "${TRACE_PATH_A}"
191 enable_ust_lttng_channel_ok "${SESSION_NAME}" "${CHANNEL_NAME}"
192 enable_ust_lttng_event_ok "${SESSION_NAME}" "--all" "${CHANNEL_NAME}"
193 start_lttng_tracing_ok "${SESSION_NAME}"
194 unset LTTNG_HOME LTTNG_RUNDIR LTTNG_UST_CTL_PATH
195
196 if [ "${LTTNG_HOME_ORIG}" != "" ] ; then
197 export LTTNG_HOME="${LTTNG_HOME_ORIG}"
198 fi
199 # This sessiond will be traced
200 env_vars_b=(
201 LTTNG_UST_APP_PATH="${CTL_PATH}"
202 TEST_IGNORE_EXISTING_SESSIOND=1
203 LD_PRELOAD="liblttng-ust-fd.so:liblttng-ust-fork.so"
204 )
205
206 LTTNG_SESSIOND_ENV_VARS="${env_vars_b[*]}" start_lttng_sessiond
207 create_lttng_session_ok "${SESSION_NAME}" "${TRACE_PATH_B}"
208 enable_ust_lttng_channel_ok "${SESSION_NAME}" "${CHANNEL_NAME}"
209 enable_ust_lttng_event_ok "${SESSION_NAME}" "--all" "${CHANNEL_NAME}"
210 start_lttng_tracing_ok "${SESSION_NAME}"
211
212 "${TESTAPP}" -i 100 -w 0
213
214 stop_lttng_tracing_ok "${SESSION_NAME}"
215 destroy_lttng_session_ok "${SESSION_NAME}" --no-wait
216 validate_trace_count "${EVENT_NAMES}" "${TRACE_PATH_B}" 100
217 unset LTTNG_HOME LTTNG_RUNDIR LTTNG_UST_CTL_PATH TEST_IGNORE_EXISTING_SESSIOND
218
219 # Confirm that we get traced data from the subordinate sessiond
220 export "${env_vars_a[@]}"
221 stop_lttng_tracing_ok "${SESSION_NAME}"
222 destroy_lttng_session_ok "${SESSION_NAME}" --no-wait
223 EVENT_COUNT="$("${BABELTRACE_BIN}" "${TRACE_PATH_A}" | wc -l)"
224 isnt "${EVENT_COUNT}" "0" "More than zero events were expected"
225
226 stop_lttng_sessiond
227
228 # Cleanup
229 rm -rf "${TRACE_PATH_A}" "{$TRACE_PATH_B}" "${LTTNG_HOME_A}" "${CTL_PATH}"
230 unset LTTNG_HOME LTTNG_RUNDIR LTTNG_UST_CTL_PATH TEST_IGNORE_EXISTING_SESSIOND
231 if [ "${LTTNG_HOME_ORIG}" != "" ] ; then
232 export LTTNG_HOME="${LTTNG_HOME_ORIG}"
233 fi
234 }
235
236 function test_trace_self_default_paths()
237 {
238 TRACE_PATH="$(mktemp -d -t "tmp.${FUNCNAME[0]}.trace.XXXXXX")"
239
240 env_vars=(
241 LD_PRELOAD="liblttng-ust-fd.so:liblttng-ust-fork.so"
242 # Don't block during registration
243 LTTNG_UST_REGISTER_TIMEOUT=0
244 )
245 LTTNG_SESSIOND_ENV_VARS="${env_vars[*]}" start_lttng_sessiond
246 create_lttng_session_ok "${SESSION_NAME}" "${TRACE_PATH}"
247 enable_ust_lttng_channel_ok "${SESSION_NAME}" "${CHANNEL_NAME}"
248 add_context_ust_ok "${SESSION_NAME}" "${CHANNEL_NAME}" vpid -t procname
249 enable_ust_lttng_event_ok "${SESSION_NAME}" "--all" "${CHANNEL_NAME}" -x "${EVENT_NAMES}"
250 start_lttng_tracing_ok "${SESSION_NAME}"
251 stop_lttng_tracing_ok "${SESSION_NAME}"
252 destroy_lttng_session_ok "${SESSION_NAME}"
253
254 LTTNG_UST_APP_PATH="${CTL_PATH}" \
255 LTTNG_UST_WITHOUT_BADDR_STATEDUMP=1 \
256 LTTNG_UST_WITHOUT_PROCNAME_STATEDUMP=1 \
257 "${TESTAPP}" -i 100 -w 0 &
258 APP_PID="${!}"
259
260 EVENT_COUNT="$("${BABELTRACE_BIN}" "${TRACE_PATH}" | grep -v "vpid = ${APP_PID}" -c)"
261 isnt "${EVENT_COUNT}" "0" "More than zero events were expected"
262
263 stop_lttng_sessiond
264 # Cleanup
265 rm -rf "${TRACE_PATH}"
266 }
267
268 function test_trace_self_app_and_ctl_paths()
269 {
270 CTL_PATH="$(mktemp -d -t "tmp.${FUNCNAME[0]}.ctl.XXXXXX")"
271 TRACE_PATH="$(mktemp -d -t "tmp.${FUNCNAME[0]}.trace.XXXXXX")"
272
273 env_vars=(
274 LTTNG_UST_APP_PATH="${CTL_PATH}"
275 LTTNG_UST_CTL_PATH="${CTL_PATH}"
276 LD_PRELOAD="liblttng-ust-fd.so:liblttng-ust-fork.so"
277 # Don't block during registration
278 LTTNG_UST_REGISTER_TIMEOUT=0
279 )
280 LTTNG_SESSIOND_ENV_VARS="${env_vars[*]}" start_lttng_sessiond
281 create_lttng_session_ok "${SESSION_NAME}" "${TRACE_PATH}"
282 enable_ust_lttng_channel_ok "${SESSION_NAME}" "${CHANNEL_NAME}"
283 add_context_ust_ok "${SESSION_NAME}" "${CHANNEL_NAME}" vpid -t procname
284 enable_ust_lttng_event_ok "${SESSION_NAME}" "--all" "${CHANNEL_NAME}" -x "${EVENT_NAMES}"
285 start_lttng_tracing_ok "${SESSION_NAME}"
286
287 LTTNG_UST_APP_PATH="${CTL_PATH}" \
288 LTTNG_UST_WITHOUT_BADDR_STATEDUMP=1 \
289 LTTNG_UST_WITHOUT_PROCNAME_STATEDUMP=1 \
290 "${TESTAPP}" -i 100 -w 0 &
291 APP_PID="${!}"
292
293 stop_lttng_tracing_ok "${SESSION_NAME}"
294 destroy_lttng_session_ok "${SESSION_NAME}" --no-wait
295
296 EVENT_COUNT="$("${BABELTRACE_BIN}" "${TRACE_PATH}" | grep -v "vpid = ${APP_PID}" -c)"
297 isnt "${EVENT_COUNT}" "0" "More than zero events were expected"
298
299 stop_lttng_sessiond
300 # Cleanup
301 rm -rf "${TRACE_PATH}" "${CTL_PATH}"
302 }
303
304 function test_sessiond_bad_ctl_path() {
305 diag "Test that starting a sessiond with a LTTNG_UST_CTL_PATH that doesn't exist fails"
306 CTL_PATH="$(mktemp -d -t "tmp.${FUNCNAME[0]}.ctl.XXXXXX")"
307 rm -rf "${CTL_PATH}"
308
309 env_vars=(
310 LTTNG_UST_APP_PATH="${CTL_PATH}"
311 LTTNG_UST_CTL_PATH="${CTL_PATH}"
312 )
313 LTTNG_SESSIOND_ENV_VARS="${env_vars[*]}" start_lttng_sessiond_fail
314 LTTNG_UST_APP_PATH="${CTL_PATH}" \
315 LTTNG_UST_WITHOUT_BADDR_STATEDUMP=1 \
316 LTTNG_UST_WITHOUT_PROCNAME_STATEDUMP=1 \
317 "${TESTAPP}" -i 100 -w 0 &
318 APP_PID="${!}"
319 wait "${APP_PID}"
320 ok "${?}" "Test application exited successfully"
321
322 stop_lttng_sessiond_cleanup
323 }
324
325 plan_tests "${NUM_TESTS}"
326 print_test_banner "${TEST_DESC}"
327 bail_out_if_no_babeltrace
328
329 TESTS=(
330 test_sessiond_started_before_app
331 test_sessiond_started_after_app
332 test_multi_sessiond
333 test_multi_sessiond_default
334 test_trace_another_sessiond
335 test_trace_self_default_paths
336 test_trace_self_app_and_ctl_paths
337 test_sessiond_bad_ctl_path
338 )
339
340 for TEST in "${TESTS[@]}" ; do
341 "${TEST}"
342 lttng_pgrep "${SESSIOND_MATCH}"
343 done