3 # Copyright (C) 2020 Francis Deslauriers <francis.deslauriers@efficios.com>
5 # SPDX-License-Identifier: LGPL-2.1-only
7 CURDIR
=$
(dirname "$0")/
8 TESTDIR
=$CURDIR/..
/..
/..
/
12 TESTAPP_PATH
="$TESTDIR/utils/testapp"
13 TESTAPP_NAME
="gen-ust-events"
14 TESTAPP_BIN
="$TESTAPP_PATH/$TESTAPP_NAME/$TESTAPP_NAME"
16 TESTPOINT_BASE_PATH
=$
(readlink
-f "$TMPDIR/lttng.t_p_n")
17 TESTPOINT_PIPE_PATH
=$
(mktemp
-u "${TESTPOINT_BASE_PATH}.XXXXXX")
18 TESTPOINT
=$
(readlink
-f "${CURDIR}/.libs/libpause_sessiond.so")
22 # shellcheck source=../../../utils/utils.sh
23 source "$TESTDIR/utils/utils.sh"
24 # shellcheck source=./util_event_generator.sh
25 source "$CURDIR/util_event_generator.sh"
27 FULL_LTTNG_BIN
="${TESTDIR}/../src/bin/lttng/${LTTNG_BIN}"
28 FULL_LTTNG_SESSIOND_BIN
="${TESTDIR}/../src/bin/lttng-sessiond/lttng-sessiond"
32 NUM_TESTS
=$
(($UST_NUM_TESTS + $KERNEL_NUM_TESTS))
36 function test_kernel_notifier_discarded_count
38 local sessiond_pipe
=()
39 local trigger_name
="my_trigger"
40 local list_triggers_stdout
=$
(mktemp
-t list_triggers_stdout.XXXXXX
)
42 # Used on sessiond launch.
43 LTTNG_SESSIOND_ENV_VARS
="LTTNG_TESTPOINT_ENABLE=1 \
44 NOTIFIER_PAUSE_PIPE_PATH=${TESTPOINT_PIPE_PATH} \
45 LD_PRELOAD=${TESTPOINT}"
47 diag
"Kernel event notifer error counter"
49 start_lttng_sessiond_notap
51 # This is needed since the testpoint creates a pipe with the sessiond
53 for f
in "$TESTPOINT_BASE_PATH"*; do
57 lttng_add_trigger_ok
"$trigger_name" \
58 --condition on-event
--kernel lttng_test_filter_event \
61 "$FULL_LTTNG_BIN" list-triggers
> "$list_triggers_stdout"
63 # Confirm that the discarded notification line is not present.
64 cat "$list_triggers_stdout" |
grep -v --quiet "discarded tracer messages"
65 ok $?
"No discarded tracer notification message"
67 tail -n 1 "$list_triggers_stdout" |
grep --quiet "errors: none"
68 ok $?
"Trigger 'errors: none' notification message"
70 # Stop consumption of notifier tracer notifications.
71 diag
"Pause consumption of tracer messages"
72 echo -n 1 > $sessiond_pipe
74 # The notifier ring buffer configuration is currently made of 16 4096
75 # bytes subbuffers. Each kernel notification is at least 42 bytes long.
76 # To fill it, we need to generate (16 * 4096)/42 = 1561 notifications.
77 # That number is a bit larger than what we need since some of the space
78 # is lost in subbuffer boundaries.
79 echo -n "2000" > /proc
/lttng-test-filter-event
81 "$FULL_LTTNG_BIN" list-triggers
> "$list_triggers_stdout"
83 # Confirm that the discarded notification line is present. To avoid
85 cat "$list_triggers_stdout" |
grep --quiet "discarded tracer messages"
86 ok $?
"Tracer notification discarded line printed"
88 # Confirm that the number of dicarded tracer messages is not zero.
89 cat "$list_triggers_stdout" |
grep --quiet "discarded tracer messages: 0"
90 isnt $?
0 "Discarded tracer notification number non-zero as expected"
92 lttng_remove_trigger_ok
"$trigger_name"
94 # Confirm that no notifier is enabled.
95 list_triggers_line_count
=$
("$FULL_LTTNG_BIN" list-triggers |
wc -l)
96 is
"$list_triggers_line_count" "0" "No \`on-event\` kernel notifier enabled as expected"
98 # Enable another notifier and list it to confirm the counter was cleared.
99 lttng_add_trigger_ok
"$trigger_name" \
100 --condition on-event
--kernel lttng_test_filter_event \
103 "$FULL_LTTNG_BIN" list-triggers
> "$list_triggers_stdout"
105 # Confirm that the discarded notification line is not present.
106 cat "$list_triggers_stdout" |
grep -v --quiet "discarded tracer messages"
107 ok $?
"No discarded tracer notification message"
109 tail -n 1 "$list_triggers_stdout" |
grep --quiet "errors: none"
110 ok $?
"Trigger 'errors: none' notification message"
112 lttng_remove_trigger_ok
"$trigger_name"
114 stop_lttng_sessiond_notap
116 unset LTTNG_SESSIOND_ENV_VARS
118 rm -f "$list_triggers_stdout"
121 function test_kernel_notifier_discarded_count_max_bucket
123 start_lttng_sessiond
"" "--event-notifier-error-number-of-bucket=3"
125 diag
"Kernel event notifer error counter bucket limit"
126 for i
in $
(seq 3); do
127 lttng_add_trigger_ok
"$i" \
128 --condition on-event
--kernel my_event_that_doesnt_need_to_really_exist_
$i \
132 for i
in $
(seq 4 5); do
133 lttng_add_trigger_fail
"$i" \
134 --condition on-event
--kernel my_event_that_doesnt_need_to_really_exist_
$i \
138 stop_lttng_sessiond_notap
141 function test_ust_notifier_discarded_count
143 local sessiond_pipe
=()
144 local trigger_name
="my_trigger"
145 local list_triggers_stdout
=$
(mktemp
-t list_triggers_stdout.XXXXXX
)
150 diag
"UST event notifer error counter"
152 PIPE_SIZE
=$
("$CURDIR"/default_pipe_size_getter
)
153 if [ $?
-ne 0 ]; then
154 BAIL_OUT
"Failed to get system default pipe size"
156 diag
"Default system pipe size: $PIPE_SIZE bytes"
159 # Find the number of events needed to overflow the event notification
160 # pipe buffer. Each LTTng-UST notification is at least 42 bytes long.
161 # Double that number to ensure enough events are created to overflow
163 NR_ITER
=$
(( (PIPE_SIZE
/ 42) * 2 ))
164 diag
"Test application will emit $NR_ITER events"
166 # Used on sessiond launch.
167 LTTNG_SESSIOND_ENV_VARS
="LTTNG_TESTPOINT_ENABLE=1 \
168 NOTIFIER_PAUSE_PIPE_PATH=${TESTPOINT_PIPE_PATH} \
169 LD_PRELOAD=${TESTPOINT}"
171 start_lttng_sessiond_notap
173 # This is needed since the testpoint create a pipe with the sessiond
175 for f
in "$TESTPOINT_BASE_PATH"*; do
176 sessiond_pipe
+=("$f")
179 lttng_add_trigger_ok
"$trigger_name" \
180 --condition on-event
--userspace tp
:tptest \
183 "$FULL_LTTNG_BIN" list-triggers
> "$list_triggers_stdout"
185 # Confirm that the discarded notification line is not present.
186 cat "$list_triggers_stdout" |
grep -v --quiet "discarded tracer messages"
187 ok $?
"No discarded tracer notification message"
189 tail -n 1 "$list_triggers_stdout" |
grep --quiet "errors: none"
190 ok $?
"Trigger 'errors: none' notification message"
192 # Stop consumption of notifier tracer notifications.
193 diag
"Pause consumption of tracer messages"
194 echo -n 1 > $sessiond_pipe
196 $TESTAPP_BIN -i $NR_ITER -w $NR_USEC_WAIT
197 ok $?
"Generating $NR_ITER tracer notifications"
199 "$FULL_LTTNG_BIN" list-triggers
> "$list_triggers_stdout"
201 # Confirm that the discarded notification line is present. To avoid
203 cat "$list_triggers_stdout" |
grep --quiet "discarded tracer messages"
204 ok $?
"Tracer notification discarded line printed"
206 # Confirm that the number of discarded tracer messages is not zero.
207 cat "$list_triggers_stdout" |
grep --quiet "discarded tracer messages: 0"
208 isnt $?
0 "Discarded tracer notification number non-zero as expected"
210 # Remove the notifier.
211 lttng_remove_trigger_ok
"$trigger_name"
213 # Confirm that no notifier is enabled.
214 list_triggers_line_count
=$
("$FULL_LTTNG_BIN" list-triggers |
wc -l)
215 is
"$list_triggers_line_count" "0" "No \`on-event\` userspace notifier enabled as expected"
217 # Enable another notifier and list it to confirm the counter was cleared.
218 lttng_add_trigger_ok
"$trigger_name" \
219 --condition on-event
--userspace tp
:tptest \
222 # Confirm that the discarded notification line is not present.
223 "$FULL_LTTNG_BIN" list-triggers
> "$list_triggers_stdout"
225 # Confirm that the discarded notification line is not present.
226 cat "$list_triggers_stdout" |
grep -v --quiet "discarded tracer messages"
227 ok $?
"No discarded tracer notification message"
229 tail -n 1 "$list_triggers_stdout" |
grep --quiet "errors: none"
230 ok $?
"Trigger 'errors: none' notification message"
232 lttng_remove_trigger_ok
"$trigger_name"
234 stop_lttng_sessiond_notap
236 unset LTTNG_SESSIOND_ENV_VARS
238 rm -f "$list_triggers_stdout"
240 function test_ust_notifier_discarded_count_max_bucket
242 start_lttng_sessiond
"" "--event-notifier-error-number-of-bucket=3"
244 diag
"UST event notifer error counter bucket limit"
245 for i
in $
(seq 3); do
246 lttng_add_trigger_ok
"$i" \
247 --condition on-event
--userspace my_event_that_doesnt_need_to_really_exist_
$i \
251 for i
in $
(seq 4 5); do
252 lttng_add_trigger_fail
"$i" \
253 --condition on-event
--userspace my_event_that_doesnt_need_to_really_exist_
$i \
257 stop_lttng_sessiond_notap
260 test_ust_notifier_discarded_count
261 test_ust_notifier_discarded_count_max_bucket
263 if [ "$(id -u)" == "0" ]; then
265 validate_lttng_modules_present
269 test_kernel_notifier_discarded_count
271 test_kernel_notifier_discarded_count_max_bucket
273 modprobe
--remove lttng-test
275 rm -rf "${sessiond_pipe[@]}" 2> /dev
/null
277 # Kernel tests are skipped.
278 skip
0 "Root access is needed. Skipping all kernel notification tests." $KERNEL_NUM_TESTS