3 # Copyright (C) - 2017 Jonathan Rajotte <jonathan.rajotte-julien@efficiso.com>>
5 # This library is free software; you can redistribute it and/or modify it under
6 # the terms of the GNU Lesser General Public License as published by the Free
7 # Software Foundation; version 2.1 of the License.
9 # This library is distributed in the hope that it will be useful, but WITHOUT
10 # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
11 # FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
14 # You should have received a copy of the GNU Lesser General Public License
15 # along with this library; if not, write to the Free Software Foundation, Inc.,
16 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18 TEST_DESC
="Notification"
21 TESTDIR
=$CURDIR/..
/..
/..
/
23 TESTPOINT
=$
(readlink
-f ${CURDIR}/.libs
/libpause_consumer.so
)
25 TESTAPP_PATH
="$TESTDIR/utils/testapp"
26 TESTAPP_NAME
="gen-ust-events"
27 TESTAPP_BIN
="$TESTAPP_PATH/$TESTAPP_NAME/$TESTAPP_NAME"
28 TESTAPP_STATE_FILE
="$(mktemp -u)"
33 SESSION_NAME
="my_session"
34 CHANNEL_NAME
="my_channel"
37 DIR
=$
(readlink
-f $TESTDIR)
39 PAGE_SIZE
=$
(getconf PAGE_SIZE
)
43 NUM_TESTS
=$
(($NUM_TEST_UST + $NUM_TEST_KERNEL))
45 source $TESTDIR/utils
/utils.sh
48 file_sync_after_first_event
=$
(mktemp
-u)
50 # MUST set TESTDIR before calling those functions
53 print_test_banner
"$TEST_DESC"
57 function kernel_event_generator_toggle_state
59 kernel_event_generator_suspended
=$
((kernel_event_generator_suspended
==0))
62 function kernel_event_generator
65 kernel_event_generator_suspended
=0
66 trap kernel_event_generator_toggle_state SIGUSR1
69 if [[ $kernel_event_generator_suspended -eq "1" ]]; then
73 if [[ -f $state_file ]]; then
74 rm $state_file 2> /dev
/null
76 echo -n "1000" > /proc
/lttng-test-filter-event
81 function ust_event_generator_toggle_state
83 ust_event_generator_suspended
=$
((ust_event_generator_suspended
==0))
86 function ust_event_generator
89 ust_event_generator_suspended
=0
90 trap ust_event_generator_toggle_state SIGUSR1
91 trap "exit" SIGTERM SIGINT
93 if [[ $ust_event_generator_suspended -eq "1" ]]; then
97 if [[ -f $state_file ]]; then
98 rm $state_file 2> /dev
/null
100 taskset
-c 0 $TESTAPP_BIN $NR_ITER $NR_USEC_WAIT > /dev
/null
2>&1
105 function start_client
{
108 local session_name
=$2
109 local channel_name
=$3
111 local buffer_usage_type
=$5
112 local buffer_usage_threshold_type
=$6
113 local buffer_usage_threshold_value
=$7
114 local nr_expected_notification
=$8
116 ${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} &
122 function wait_for_message
()
125 local file_pattern
=$2
128 for file in $directory/${file_pattern}*; do
130 # Check for "error" message
131 grep -q "error:" ${file}
133 if [ $app_error -eq "0" ] ; then
135 fail
"Waiting message: error logged see file content: ${message}, ${file}"
139 grep -q "${message}" ${file}
140 if [[ "$?" -ne "0" ]]; then
141 # Lookup failed restart loop
142 diag
"Lookup failed sleep and retry grep for: ${message}, ${file}"
149 pass
"Message received: ${message}"
153 function print_errors
()
156 local file_pattern
=$2
158 for file in $directory/${file_pattern}*; do
159 # Check for "error" message
160 error_message
=$
(grep "error:" ${file})
161 if [[ "${error_message}x" != "x" ]]; then
162 diag
"Errors for application ${file}:"
163 diag
"${error_message}"
168 function comm_consumerd
()
172 echo -ne "${message}" > "${pipe}"
175 function stop_consumerd
()
178 comm_consumerd
"1" "$pipe"
181 function resume_consumerd
()
184 comm_consumerd
"\0" "$pipe"
187 function test_multi_app
()
190 local event_generator_pid
=$2
193 local low_output_file_pattern
="low_app_output_file_"
194 local high_output_file_pattern
="high_app_output_file_"
195 local output_dir
=$
(mktemp
-d)
197 local testpoint_base_path
=$
(readlink
-f "$output_dir/lttng.t_p_n_multi_app")
198 local testpoint_pipe_path
=$
(mktemp
-u "${testpoint_base_path}.XXXXXX")
200 local nr_notification_expected
=5
201 local nr_client_app
=50
202 local domain_string
=""
207 domain_string
=LTTNG_DOMAIN_UST
208 event_name
="tp:tptest"
211 domain_string
=LTTNG_DOMAIN_KERNEL
212 event_name
="lttng_test_filter_event"
215 fail
"Invalid domain type"
221 LTTNG_SESSIOND_ENV_VARS
="LTTNG_TESTPOINT_ENABLE=1 CONSUMER_PAUSE_PIPE_PATH=${testpoint_pipe_path} LD_PRELOAD=${TESTPOINT}"
224 create_lttng_session_ok
$SESSION_NAME $TRACE_PATH
225 enable_
${domain_type}_lttng_channel_ok
$SESSION_NAME $CHANNEL_NAME --subbuf-size=$PAGE_SIZE
226 enable_
${domain_type}_lttng_event_ok
$SESSION_NAME $event_name $CHANNEL_NAME
228 # Fetch consumerd testpoint pipe information
229 # This is needed since the testpoint create a pipe with the consumer type suffixed
231 for f
in "$testpoint_pipe_path"*; do
232 consumerd_pipe
+=("$f")
235 for (( i
= 0; i
< $nr_client_app; i
++ )); do
236 low_app_output_file
=$output_dir/${low_output_file_pattern}${i}
237 high_app_output_file
=$output_dir/${high_output_file_pattern}${i}
238 start_client
$low_app_output_file $SESSION_NAME $CHANNEL_NAME $domain_string LOW RATIO
0.0 $nr_notification_expected
239 start_client
$high_app_output_file $SESSION_NAME $CHANNEL_NAME $domain_string HIGH RATIO
0.420 $nr_notification_expected
242 wait_for_message
$output_dir "${low_output_file_pattern}" "sync: ready"
243 wait_for_message
$output_dir "${high_output_file_pattern}" "sync: ready"
245 # Test notification reception
246 for (( i
= 0; i
< $nr_notification_expected; i
++ )); do
248 # Stop consumerd consumption to force high notification
249 start_lttng_tracing_ok
$SESSION_NAME
250 for pipe
in "${consumerd_pipe[@]}"; do
251 stop_consumerd
"${pipe}"
254 wait_for_message
$output_dir "${high_output_file_pattern}" "notification: high $i"
256 # Put application in suspend mode to prevent double low
257 # notification and synchronize on state file.
258 kill -s SIGUSR1
$event_generator_pid
259 while [ ! -f "${TESTAPP_STATE_FILE}" ]; do
264 for pipe
in "${consumerd_pipe[@]}"; do
265 resume_consumerd
"${pipe}"
267 # Stop tracing forcing full buffer consumption
268 stop_lttng_tracing_ok
$SESSION_NAME
270 # Check for notifications reception
271 wait_for_message
$output_dir "${low_output_file_pattern}" "notification: low $i"
273 ok
$ret "Notifications $i received"
274 if [[ $ret -ne "0" ]]; then
275 # Error occurred bail out
279 # Put application in active mode and synchronize on state file.
280 kill -s SIGUSR1
$event_generator_pid
281 while [ -f "${TESTAPP_STATE_FILE}" ]; do
286 wait_for_message
$output_dir "${low_output_file_pattern}" "exit: 0"
288 ok
$ret "Application for low notification terminated normally"
289 if [[ $ret -ne "0" ]]; then
290 print_errors
$output_dir "${low_output_file_pattern}"
293 wait_for_message
$output_dir "${high_output_file_pattern}" "exit: 0"
295 ok
$ret "Application for high notification terminated normally"
296 if [[ $ret -ne "0" ]]; then
297 print_errors
$output_dir "${high_output_file_pattern}"
301 destroy_lttng_session_ok
$SESSION_NAME
304 for pipe
in "${consumerd_pipe[@]}"; do
311 function test_multi_app_ust
()
313 diag
"Multi client app UST notification"
314 ust_event_generator
$TESTAPP_STATE_FILE &
315 local generator_pid
=$
!
317 test_multi_app ust
$generator_pid
319 kill -s SIGTERM
$generator_pid 2> /dev
/null
320 wait $generator_pid 2> /dev
/null
321 rm -rf ${TESTAPP_STATE_FILE} 2> /dev
/null
324 function test_multi_app_kernel
()
326 diag
"Multi client app kernel notification"
329 kernel_event_generator
$TESTAPP_STATE_FILE &
330 local generator_pid
=$
!
332 test_multi_app kernel
$generator_pid
335 kill -s SIGTERM
$generator_pid 2> /dev
/null
336 wait $generator_pid 2> /dev
/null
337 rm -rf ${TESTAPP_STATE_FILE} 2> /dev
/null
342 function test_on_register_evaluation_ust
()
344 diag
"On register notification UST"
346 # Start app in infinite loop
347 ust_event_generator
$TESTAPP_STATE_FILE &
348 local generator_pid
=$
!
350 test_on_register_evaluation ust
$generator_pid
352 kill -s SIGTERM
$generator_pid 2> /dev
/null
353 wait $generator_pid 2> /dev
/null
354 rm -rf ${TESTAPP_STATE_FILE} 2> /dev
/null
358 function test_on_register_evaluation_kernel
()
360 diag
"On register notification kernel"
364 kernel_event_generator
$TESTAPP_STATE_FILE &
365 local generator_pid
=$
!
367 test_on_register_evaluation kernel
$generator_pid
370 kill -s SIGTERM
$generator_pid 2> /dev
/null
371 wait $generator_pid 2> /dev
/null
372 rm -rf ${TESTAPP_STATE_FILE} 2> /dev
/null
377 function test_on_register_evaluation
()
380 local event_generator_pid
=$2
383 local high_output_file_pattern
="high_app_output_file_on_register_evaluation"
385 local output_dir
=$
(mktemp
-d)
386 local testpoint_base_path
=$
(readlink
-f "$output_dir/lttng.t_p_n_register_evaluation")
387 local testpoint_pipe_path
=$
(mktemp
-u "${testpoint_base_path}.XXXXXX")
388 local domain_string
=""
393 domain_string
=LTTNG_DOMAIN_UST
394 event_name
="tp:tptest"
397 domain_string
=LTTNG_DOMAIN_KERNEL
398 event_name
="lttng_test_filter_event"
401 fail
"Invalid domain type"
407 LTTNG_SESSIOND_ENV_VARS
="LTTNG_TESTPOINT_ENABLE=1 CONSUMER_PAUSE_PIPE_PATH=${testpoint_pipe_path} LD_PRELOAD=${TESTPOINT}"
410 create_lttng_session_ok
$SESSION_NAME $TRACE_PATH
411 enable_
${domain_type}_lttng_channel_ok
$SESSION_NAME $CHANNEL_NAME --subbuf-size=$PAGE_SIZE
412 enable_
${domain_type}_lttng_event_ok
$SESSION_NAME $event_name $CHANNEL_NAME
414 # Fetch consumerd testpoint pipe information
415 # This is needed since the testpoint create a pipe with the consumer type suffixed
417 for f
in "$testpoint_pipe_path"*; do
418 consumerd_pipe
+=("$f")
421 high_app_output_file
=${high_output_file_pattern}.first_receiver
422 high_app_output_path
=$output_dir/${high_app_output_file}
423 start_client
$high_app_output_path $SESSION_NAME $CHANNEL_NAME $domain_string HIGH RATIO
0.420 1
425 wait_for_message
$output_dir "${high_app_output_file}" "sync: ready"
427 # Stop consumerd consumption to force high notification
428 start_lttng_tracing_ok
$SESSION_NAME
430 for pipe
in "${consumerd_pipe[@]}"; do
431 stop_consumerd
"${pipe}"
434 wait_for_message
$output_dir "${high_app_output_file}" "notification: high 0"
436 # Start a second receiver, the receiver should receive a high
437 # notification on subscription
438 high_app_output_file
=${high_output_file_pattern}.second_receiver
439 high_app_output_path
=$output_dir/${high_app_output_file}
440 start_client
$high_app_output_path $SESSION_NAME $CHANNEL_NAME $domain_string HIGH RATIO
0.420 1
441 wait_for_message
$output_dir "${high_app_output_file}" "sync: ready"
442 wait_for_message
$output_dir "${high_app_output_file}" "notification: high 0"
445 for pipe
in "${consumerd_pipe[@]}"; do
446 resume_consumerd
"${pipe}"
449 wait_for_message
$output_dir "${high_output_file_pattern}" "exit: 0"
451 ok
$ret "Application for high notification terminated normally"
452 if [[ $ret -ne "0" ]]; then
454 print_errors
"${high_output_file_pattern}"
458 destroy_lttng_session_ok
$SESSION_NAME
461 kill -s SIGTERM
$generator_pid 2> /dev
/null
462 wait $generator_pid 2> /dev
/null
464 for pipe
in "${consumerd_pipe[@]}"; do
474 test_on_register_evaluation_ust
477 if [ "$(id -u)" == "0" ]; then
478 validate_lttng_modules_present
480 test_multi_app_kernel
481 test_on_register_evaluation_kernel
484 skip
0 "Root access is needed. Skipping all kernel multi-app notification tests." $NUM_TEST_KERNEL
488 for fct_test
in ${TESTS[@]};
490 TRACE_PATH
=$
(mktemp
-d)
493 if [ $?
-ne 0 ]; then
497 # Only delete if successful