Fix: tests: output_dir contains the consumerd pipe
[lttng-tools.git] / tests / regression / tools / notification / test_notification_multi_app
CommitLineData
434f8068
JR
1#!/bin/bash
2#
9d16b343 3# Copyright (C) 2017 Jonathan Rajotte <jonathan.rajotte-julien@efficiso.com>>
434f8068 4#
9d16b343 5# SPDX-License-Identifier: LGPL-2.1-only
434f8068
JR
6
7TEST_DESC="Notification"
8
9CURDIR=$(dirname $0)/
10TESTDIR=$CURDIR/../../../
11
434f8068
JR
12TESTPOINT=$(readlink -f ${CURDIR}/.libs/libpause_consumer.so)
13
14TESTAPP_PATH="$TESTDIR/utils/testapp"
15TESTAPP_NAME="gen-ust-events"
16TESTAPP_BIN="$TESTAPP_PATH/$TESTAPP_NAME/$TESTAPP_NAME"
854382b8 17TESTAPP_STATE_FILE="$(mktemp -u)"
434f8068 18
854382b8 19NR_ITER=1000
434f8068
JR
20NR_USEC_WAIT=5
21
22SESSION_NAME="my_session"
854382b8 23CHANNEL_NAME="my_channel"
434f8068 24
434f8068 25
434f8068
JR
26DIR=$(readlink -f $TESTDIR)
27
1bd26228
JG
28PAGE_SIZE=$(getconf PAGE_SIZE)
29
854382b8
JR
30NUM_TEST_UST=50
31NUM_TEST_KERNEL=50
32NUM_TESTS=$(($NUM_TEST_UST + $NUM_TEST_KERNEL))
434f8068
JR
33
34source $TESTDIR/utils/utils.sh
35
36consumerd_pipe=()
37file_sync_after_first_event=$(mktemp -u)
38
39# MUST set TESTDIR before calling those functions
40plan_tests $NUM_TESTS
41
42print_test_banner "$TEST_DESC"
43
44app_pids=()
867313e2 45
cb723729 46function kernel_event_generator_toggle_state
854382b8
JR
47{
48 kernel_event_generator_suspended=$((kernel_event_generator_suspended==0))
49
50}
51function kernel_event_generator
52{
53 state_file=$1
54 kernel_event_generator_suspended=0
cb723729 55 trap kernel_event_generator_toggle_state SIGUSR1
3be453c9 56
854382b8
JR
57 while (true); do
58 if [[ $kernel_event_generator_suspended -eq "1" ]]; then
59 touch $state_file
60 sleep 0.5
61 else
62 if [[ -f $state_file ]]; then
63 rm $state_file 2> /dev/null
64 fi
65 echo -n "1000" > /proc/lttng-test-filter-event
66 fi
67 done
68}
69
cb723729 70function ust_event_generator_toggle_state
854382b8
JR
71{
72 ust_event_generator_suspended=$((ust_event_generator_suspended==0))
73
74}
75function ust_event_generator
76{
77 state_file=$1
78 ust_event_generator_suspended=0
cb723729 79 trap ust_event_generator_toggle_state SIGUSR1
854382b8
JR
80 trap "exit" SIGTERM SIGINT
81 while (true); do
82 if [[ $ust_event_generator_suspended -eq "1" ]]; then
83 touch $state_file
84 sleep 0.5
85 else
86 if [[ -f $state_file ]]; then
87 rm $state_file 2> /dev/null
88 fi
6c4a91d6 89 taskset -c 0 $TESTAPP_BIN -i $NR_ITER -w $NR_USEC_WAIT > /dev/null 2>&1
854382b8
JR
90 fi
91 done
92}
93
434f8068
JR
94function start_client {
95 local pid=-1
96 local output_file=$1
97 local session_name=$2
98 local channel_name=$3
99 local domain_type=$4
100 local buffer_usage_type=$5
101 local buffer_usage_threshold_type=$6
102 local buffer_usage_threshold_value=$7
103 local nr_expected_notification=$8
104
105 ${CURDIR}/base_client ${session_name} ${channel_name} ${domain_type} ${buffer_usage_type} ${buffer_usage_threshold_type} ${buffer_usage_threshold_value} ${nr_expected_notification} > ${output_file} &
106 pid=$!
107
108 app_pids+=("$pid")
109}
110
111function wait_for_message ()
112{
345ed219
JR
113 local directory=$1
114 local file_pattern=$2
115 local message=$3
434f8068 116
345ed219 117 for file in $directory/${file_pattern}*; do
434f8068
JR
118 while(true); do
119 # Check for "error" message
120 grep -q "error:" ${file}
121 app_error=$?
122 if [ $app_error -eq "0" ] ; then
123 # An error occurred
124 fail "Waiting message: error logged see file content: ${message}, ${file}"
125 return 1
126 fi
127
128 grep -q "${message}" ${file}
129 if [[ "$?" -ne "0" ]]; then
130 # Lookup failed restart loop
131 diag "Lookup failed sleep and retry grep for: ${message}, ${file}"
132 sleep 0.25
133 continue
134 fi
135 break
136 done
137 done
138 pass "Message received: ${message}"
139 return 0
140}
141
142function print_errors ()
143{
345ed219
JR
144 local directory=$1
145 local file_pattern=$2
434f8068 146
345ed219 147 for file in $directory/${file_pattern}*; do
434f8068
JR
148 # Check for "error" message
149 error_message=$(grep "error:" ${file})
867313e2 150 if [[ "${error_message}x" != "x" ]]; then
434f8068
JR
151 diag "Errors for application ${file}:"
152 diag "${error_message}"
153 fi
154 done
155}
156
157function comm_consumerd ()
158{
159 local message=$1
160 local pipe=$2
161 echo -ne "${message}" > "${pipe}"
434f8068
JR
162}
163
164function stop_consumerd ()
165{
166 local pipe=$1
167 comm_consumerd "1" "$pipe"
434f8068
JR
168}
169
170function resume_consumerd ()
171{
172 local pipe=$1
173 comm_consumerd "\0" "$pipe"
434f8068
JR
174}
175
176function test_multi_app ()
177{
854382b8
JR
178 local domain_type=$1
179 local event_generator_pid=$2
180
434f8068
JR
181 local app_pids=()
182 local low_output_file_pattern="low_app_output_file_"
183 local high_output_file_pattern="high_app_output_file_"
345ed219 184 local output_dir=$(mktemp -d)
434f8068 185
345ed219 186 local testpoint_base_path=$(readlink -f "$output_dir/lttng.t_p_n_multi_app")
6a1eee92
JR
187 local testpoint_pipe_path=$(mktemp -u "${testpoint_base_path}.XXXXXX")
188
189 local nr_notification_expected=5
190 local nr_client_app=50
854382b8
JR
191 local domain_string=""
192 local event_name=""
193
194 case $domain_type in
195 ust)
196 domain_string=LTTNG_DOMAIN_UST
197 event_name="tp:tptest"
198 ;;
199 kernel)
200 domain_string=LTTNG_DOMAIN_KERNEL
201 event_name="lttng_test_filter_event"
202 ;;
203 *)
204 fail "Invalid domain type"
205 exit 1
206 ;;
207 esac
6a1eee92 208
434f8068 209 # Setup
6a1eee92 210 LTTNG_SESSIOND_ENV_VARS="LTTNG_TESTPOINT_ENABLE=1 CONSUMER_PAUSE_PIPE_PATH=${testpoint_pipe_path} LD_PRELOAD=${TESTPOINT}"
434f8068
JR
211 start_lttng_sessiond
212
434f8068 213 create_lttng_session_ok $SESSION_NAME $TRACE_PATH
854382b8
JR
214 enable_${domain_type}_lttng_channel_ok $SESSION_NAME $CHANNEL_NAME --subbuf-size=$PAGE_SIZE
215 enable_${domain_type}_lttng_event_ok $SESSION_NAME $event_name $CHANNEL_NAME
434f8068
JR
216
217 # Fetch consumerd testpoint pipe information
218 # This is needed since the testpoint create a pipe with the consumer type suffixed
345ed219
JR
219 consumerd_pipe=()
220 for f in "$testpoint_pipe_path"*; do
434f8068
JR
221 consumerd_pipe+=("$f")
222 done
223
6a1eee92 224 for (( i = 0; i < $nr_client_app; i++ )); do
345ed219
JR
225 low_app_output_file=$output_dir/${low_output_file_pattern}${i}
226 high_app_output_file=$output_dir/${high_output_file_pattern}${i}
854382b8
JR
227 start_client $low_app_output_file $SESSION_NAME $CHANNEL_NAME $domain_string LOW RATIO 0.0 $nr_notification_expected
228 start_client $high_app_output_file $SESSION_NAME $CHANNEL_NAME $domain_string HIGH RATIO 0.420 $nr_notification_expected
434f8068
JR
229 done
230
345ed219
JR
231 wait_for_message $output_dir "${low_output_file_pattern}" "sync: ready"
232 wait_for_message $output_dir "${high_output_file_pattern}" "sync: ready"
434f8068
JR
233
234 # Test notification reception
6a1eee92 235 for (( i = 0; i < $nr_notification_expected; i++ )); do
434f8068
JR
236
237 # Stop consumerd consumption to force high notification
238 start_lttng_tracing_ok $SESSION_NAME
239 for pipe in "${consumerd_pipe[@]}"; do
240 stop_consumerd "${pipe}"
241 done
242
345ed219 243 wait_for_message $output_dir "${high_output_file_pattern}" "notification: high $i"
434f8068 244
854382b8
JR
245 # Put application in suspend mode to prevent double low
246 # notification and synchronize on state file.
247 kill -s SIGUSR1 $event_generator_pid
248 while [ ! -f "${TESTAPP_STATE_FILE}" ]; do
249 sleep 0.5
250 done
251
434f8068
JR
252 # Resume consumerd
253 for pipe in "${consumerd_pipe[@]}"; do
254 resume_consumerd "${pipe}"
255 done
256 # Stop tracing forcing full buffer consumption
7fe98a98 257 stop_lttng_tracing_ok $SESSION_NAME
434f8068
JR
258
259 # Check for notifications reception
345ed219 260 wait_for_message $output_dir "${low_output_file_pattern}" "notification: low $i"
434f8068
JR
261 ret=$?
262 ok $ret "Notifications $i received"
263 if [[ $ret -ne "0" ]]; then
264 # Error occurred bail out
265 break;
266 fi
854382b8
JR
267
268 # Put application in active mode and synchronize on state file.
269 kill -s SIGUSR1 $event_generator_pid
270 while [ -f "${TESTAPP_STATE_FILE}" ]; do
271 sleep 0.5
272 done
434f8068
JR
273 done
274
345ed219 275 wait_for_message $output_dir "${low_output_file_pattern}" "exit: 0"
434f8068
JR
276 ret=$?
277 ok $ret "Application for low notification terminated normally"
345ed219
JR
278 if [[ $ret -ne "0" ]]; then
279 print_errors $output_dir "${low_output_file_pattern}"
434f8068
JR
280 fi
281
345ed219 282 wait_for_message $output_dir "${high_output_file_pattern}" "exit: 0"
434f8068
JR
283 ret=$?
284 ok $ret "Application for high notification terminated normally"
345ed219
JR
285 if [[ $ret -ne "0" ]]; then
286 print_errors $output_dir "${high_output_file_pattern}"
434f8068
JR
287 fi
288
345ed219 289
854382b8 290 destroy_lttng_session_ok $SESSION_NAME
434f8068 291 stop_lttng_sessiond
854382b8
JR
292
293 for pipe in "${consumerd_pipe[@]}"; do
294 rm -rf "${pipe}"
295 done
81665716
JR
296
297 rm -rf $output_dir
854382b8
JR
298}
299
300function test_multi_app_ust ()
301{
302 diag "Multi client app UST notification"
303 ust_event_generator $TESTAPP_STATE_FILE &
304 local generator_pid=$!
305
306 test_multi_app ust $generator_pid
307
e212acd4 308 kill -s SIGTERM $generator_pid 2> /dev/null
854382b8
JR
309 wait $generator_pid 2> /dev/null
310 rm -rf ${TESTAPP_STATE_FILE} 2> /dev/null
311}
312
313function test_multi_app_kernel ()
314{
315 diag "Multi client app kernel notification"
316 modprobe lttng-test
317
318 kernel_event_generator $TESTAPP_STATE_FILE &
319 local generator_pid=$!
320
321 test_multi_app kernel $generator_pid
322
323
e212acd4 324 kill -s SIGTERM $generator_pid 2> /dev/null
854382b8
JR
325 wait $generator_pid 2> /dev/null
326 rm -rf ${TESTAPP_STATE_FILE} 2> /dev/null
327
328 rmmod lttng-test
329}
330
331function test_on_register_evaluation_ust ()
332{
333 diag "On register notification UST"
334
335 # Start app in infinite loop
336 ust_event_generator $TESTAPP_STATE_FILE &
337 local generator_pid=$!
338
339 test_on_register_evaluation ust $generator_pid
340
e212acd4 341 kill -s SIGTERM $generator_pid 2> /dev/null
854382b8
JR
342 wait $generator_pid 2> /dev/null
343 rm -rf ${TESTAPP_STATE_FILE} 2> /dev/null
344
345}
346
347function test_on_register_evaluation_kernel()
348{
349 diag "On register notification kernel"
350
351 modprobe lttng-test
352
353 kernel_event_generator $TESTAPP_STATE_FILE &
354 local generator_pid=$!
355
356 test_on_register_evaluation kernel $generator_pid
357
358
e212acd4 359 kill -s SIGTERM $generator_pid 2> /dev/null
854382b8
JR
360 wait $generator_pid 2> /dev/null
361 rm -rf ${TESTAPP_STATE_FILE} 2> /dev/null
362
363 rmmod lttng-test
434f8068
JR
364}
365
867313e2
JR
366function test_on_register_evaluation ()
367{
854382b8
JR
368 local domain_type=$1
369 local event_generator_pid=$2
370
867313e2
JR
371 local app_pids=()
372 local high_output_file_pattern="high_app_output_file_on_register_evaluation"
373
345ed219
JR
374 local output_dir=$(mktemp -d)
375 local testpoint_base_path=$(readlink -f "$output_dir/lttng.t_p_n_register_evaluation")
867313e2 376 local testpoint_pipe_path=$(mktemp -u "${testpoint_base_path}.XXXXXX")
854382b8
JR
377 local domain_string=""
378 local event_name=""
867313e2 379
854382b8
JR
380 case $domain_type in
381 ust)
382 domain_string=LTTNG_DOMAIN_UST
383 event_name="tp:tptest"
384 ;;
385 kernel)
386 domain_string=LTTNG_DOMAIN_KERNEL
387 event_name="lttng_test_filter_event"
388 ;;
389 *)
390 fail "Invalid domain type"
391 exit 1
392 ;;
393 esac
394
867313e2
JR
395 # Setup
396 LTTNG_SESSIOND_ENV_VARS="LTTNG_TESTPOINT_ENABLE=1 CONSUMER_PAUSE_PIPE_PATH=${testpoint_pipe_path} LD_PRELOAD=${TESTPOINT}"
397 start_lttng_sessiond
398
867313e2 399 create_lttng_session_ok $SESSION_NAME $TRACE_PATH
854382b8
JR
400 enable_${domain_type}_lttng_channel_ok $SESSION_NAME $CHANNEL_NAME --subbuf-size=$PAGE_SIZE
401 enable_${domain_type}_lttng_event_ok $SESSION_NAME $event_name $CHANNEL_NAME
867313e2
JR
402
403 # Fetch consumerd testpoint pipe information
404 # This is needed since the testpoint create a pipe with the consumer type suffixed
345ed219
JR
405 consumerd_pipe=()
406 for f in "$testpoint_pipe_path"*; do
867313e2
JR
407 consumerd_pipe+=("$f")
408 done
409
410 high_app_output_file=${high_output_file_pattern}.first_receiver
345ed219 411 high_app_output_path=$output_dir/${high_app_output_file}
854382b8 412 start_client $high_app_output_path $SESSION_NAME $CHANNEL_NAME $domain_string HIGH RATIO 0.420 1
867313e2 413
345ed219 414 wait_for_message $output_dir "${high_app_output_file}" "sync: ready"
867313e2
JR
415
416 # Stop consumerd consumption to force high notification
417 start_lttng_tracing_ok $SESSION_NAME
418
419 for pipe in "${consumerd_pipe[@]}"; do
420 stop_consumerd "${pipe}"
421 done
422
345ed219 423 wait_for_message $output_dir "${high_app_output_file}" "notification: high 0"
867313e2
JR
424
425 # Start a second receiver, the receiver should receive a high
426 # notification on subscription
427 high_app_output_file=${high_output_file_pattern}.second_receiver
345ed219 428 high_app_output_path=$output_dir/${high_app_output_file}
854382b8 429 start_client $high_app_output_path $SESSION_NAME $CHANNEL_NAME $domain_string HIGH RATIO 0.420 1
345ed219
JR
430 wait_for_message $output_dir "${high_app_output_file}" "sync: ready"
431 wait_for_message $output_dir "${high_app_output_file}" "notification: high 0"
867313e2
JR
432
433 # Resume consumerd
434 for pipe in "${consumerd_pipe[@]}"; do
435 resume_consumerd "${pipe}"
436 done
437
345ed219 438 wait_for_message $output_dir "${high_output_file_pattern}" "exit: 0"
867313e2
JR
439 ret=$?
440 ok $ret "Application for high notification terminated normally"
345ed219 441 if [[ $ret -ne "0" ]]; then
867313e2
JR
442 # Keep the file
443 print_errors "${high_output_file_pattern}"
444 fi
445
345ed219 446
854382b8 447 destroy_lttng_session_ok $SESSION_NAME
867313e2
JR
448 stop_lttng_sessiond
449
e212acd4 450 kill -s SIGTERM $generator_pid 2> /dev/null
854382b8
JR
451 wait $generator_pid 2> /dev/null
452
453 for pipe in "${consumerd_pipe[@]}"; do
454 rm -rf "${pipe}"
455 done
456
81665716 457 rm -rf "$output_dir"
867313e2
JR
458}
459
434f8068
JR
460
461TESTS=(
854382b8
JR
462 test_multi_app_ust
463 test_on_register_evaluation_ust
434f8068
JR
464)
465
854382b8 466if [ "$(id -u)" == "0" ]; then
fb180e6e 467 validate_lttng_modules_present
854382b8
JR
468 TESTS+=(
469 test_multi_app_kernel
470 test_on_register_evaluation_kernel
471)
472else
473 skip 0 "Root access is needed. Skipping all kernel multi-app notification tests." $NUM_TEST_KERNEL
474fi
475
476
434f8068
JR
477for fct_test in ${TESTS[@]};
478do
479 TRACE_PATH=$(mktemp -d)
480
481 ${fct_test}
482 if [ $? -ne 0 ]; then
483 break;
484 fi
485
486 # Only delete if successful
487 rm -rf $TRACE_PATH
488done
This page took 0.0941380000000001 seconds and 5 git commands to generate.