Debian Codegraph @

tests/regression/tools/notification/test_notification_notifier_discarded_count

raw
1 #!/bin/bash
2 #
3 # SPDX-FileCopyrightText: 2020 Francis Deslauriers <[email protected]>
4 #
5 # SPDX-License-Identifier: LGPL-2.1-only
6
7 CURDIR=$(dirname "$0")/
8 TESTDIR=$CURDIR/../../../
9
10 TEST_TMPDIR=$(mktemp -d -t tmp.test_notifier_discarded_count.XXXXXX)
11
12 # Set TMPDIR for further call to mktemp
13 export TMPDIR="$TEST_TMPDIR"
14
15 TESTAPP_PATH="$TESTDIR/utils/testapp"
16 TESTAPP_NAME="gen-ust-events"
17 TESTAPP_BIN="$TESTAPP_PATH/$TESTAPP_NAME"
18
19 TESTPOINT_BASE_PATH=$(readlink -f "$TEST_TMPDIR/lttng.t_p_n")
20 TESTPOINT_PIPE_PATH=$(mktemp -u -t "lttng.t_p_n.XXXXXX")
21 TESTPOINT=$(readlink -f "${CURDIR}/.libs/libpause_sessiond.so")
22
23 SH_TAP=1
24
25 # shellcheck source=../../../utils/utils.sh
26 source "$TESTDIR/utils/utils.sh"
27
28 FULL_LTTNG_BIN="${TESTDIR}/../src/bin/lttng/${LTTNG_BIN}"
29 FULL_LTTNG_SESSIOND_BIN="${TESTDIR}/../src/bin/lttng-sessiond/lttng-sessiond"
30
31 UST_DISCARD_NUM_TESTS=11
32 UST_DISCARD_MAX_BUCKET_NUM_TESTS=7
33 UST_NUM_TESTS=$((UST_DISCARD_NUM_TESTS + UST_DISCARD_MAX_BUCKET_NUM_TESTS ))
34
35 KERNEL_DISCARD_NUM_TESTS=10
36 KERNEL_DISCARD_MAX_BUCKET_NUM_TESTS=7
37 KERNEL_NUM_TESTS=$((KERNEL_DISCARD_NUM_TESTS + KERNEL_DISCARD_MAX_BUCKET_NUM_TESTS))
38
39 UST_DISCARD_MULTI_UID_NUM_TESTS=10
40 UST_DISCARD_TRIGGER_OWNER_NUM_TESTS=6
41 DESTRUCTIVE_NUM_TESTS=$((UST_DISCARD_MULTI_UID_NUM_TESTS + UST_DISCARD_TRIGGER_OWNER_NUM_TESTS))
42
43 NUM_TESTS=$((UST_NUM_TESTS + KERNEL_NUM_TESTS + DESTRUCTIVE_NUM_TESTS))
44
45 plan_tests $NUM_TESTS
46
47 function trigger_get_discarded_notif_number()
48 {
49 local trigger_name="$1"
50 local list_triggers_stdout
51
52 list_triggers_stdout=$(mktemp -t "list_triggers_stdout.XXXXXX")
53
54 "$FULL_LTTNG_BIN" list-triggers > "$list_triggers_stdout"
55
56 cat "$list_triggers_stdout" | grep -A7 "$trigger_name" | grep -A2 "event rule matches" | tail -1 | grep --quiet "errors: none"
57 ret=$?
58
59 if [ "$ret" -eq "0" ]; then
60 notif_nb="0"
61 else
62 notif_nb=$(cat "$list_triggers_stdout" | grep -A7 "$trigger_name" | grep "discarded tracer messages" | cut -d' ' -f10)
63 fi
64
65 rm -f "$list_triggers_stdout"
66
67 # Printing the value to that the caller can get it back.
68 echo "$notif_nb"
69 }
70
71 function test_kernel_notifier_discarded_count
72 {
73 local sessiond_pipe=()
74 local trigger_name="my_trigger"
75 local list_triggers_stdout
76
77 list_triggers_stdout=$(mktemp -t "list_triggers_stdout.XXXXXX")
78
79 # Used on sessiond launch.
80 LTTNG_SESSIOND_ENV_VARS="LTTNG_TESTPOINT_ENABLE=1 \
81 NOTIFIER_PAUSE_PIPE_PATH=${TESTPOINT_PIPE_PATH} \
82 LD_PRELOAD=${TESTPOINT}"
83
84 diag "Kernel event notifer error counter"
85
86 if ! start_lttng_sessiond; then
87 skip 0 "Failed to start sessiond" $((KERNEL_DISCARD_NUM_TESTS - 1))
88 return
89 fi
90
91 # This is needed since the testpoint creates a pipe with the sessiond
92 # type suffixed.
93 for f in "$TESTPOINT_BASE_PATH"*; do
94 sessiond_pipe+=("$f")
95 done
96
97 lttng_add_trigger_ok "$trigger_name" \
98 --condition event-rule-matches --type=kernel --name=lttng_test_filter_event \
99 --action notify
100
101 trigger_discarded_nb=$(trigger_get_discarded_notif_number "$trigger_name")
102 is "$trigger_discarded_nb" 0 "No discarded tracer notification"
103
104 # Stop consumption of notifier tracer notifications.
105 diag "Pause consumption of tracer messages"
106 echo -n 1 > "$sessiond_pipe"
107
108 # The notifier ring buffer configuration is currently made of 16 4096
109 # bytes subbuffers. Each kernel notification is at least 42 bytes long.
110 # To fill it, we need to generate (16 * 4096)/42 = 1561 notifications.
111 # That number is a bit larger than what we need since some of the space
112 # is lost in subbuffer boundaries.
113 echo -n "2000" > /proc/lttng-test-filter-event
114
115 # Confirm that the number of tracer notifications discarded is non-zero.
116 trigger_discarded_nb=$(trigger_get_discarded_notif_number "$trigger_name")
117 isnt "$trigger_discarded_nb" 0 "Discarded tracer notification number non-zero ($trigger_discarded_nb) as expected"
118
119 lttng_remove_trigger_ok "$trigger_name"
120
121 # Confirm that no notifier is enabled.
122 list_triggers_line_count=$("$FULL_LTTNG_BIN" list-triggers | wc -l)
123 is "$list_triggers_line_count" "0" "No \`event-rule-matches\` kernel notifier enabled as expected"
124
125 # Enable another notifier and list it to confirm the counter was cleared.
126 lttng_add_trigger_ok "$trigger_name" \
127 --condition event-rule-matches --type=kernel --name=lttng_test_filter_event \
128 --action notify
129
130 trigger_discarded_nb=$(trigger_get_discarded_notif_number "$trigger_name")
131 is "$trigger_discarded_nb" 0 "No discarded tracer notification"
132
133 lttng_remove_trigger_ok "$trigger_name"
134
135 stop_lttng_sessiond
136
137 unset LTTNG_SESSIOND_ENV_VARS
138
139 rm -f "$list_triggers_stdout"
140 }
141
142 function test_kernel_notifier_discarded_count_max_bucket
143 {
144 diag "Kernel event notifer error counter bucket limit"
145
146 if ! start_lttng_sessiond "" "--event-notifier-error-buffer-size-kernel=3"; then
147 skip 0 "Failed to start sessiond" $((KERNEL_DISCARD_MAX_BUCKET_NUM_TESTS - 1))
148 return
149 fi
150
151 for i in $(seq 3); do
152 lttng_add_trigger_ok "$i" \
153 --condition event-rule-matches --type=kernel --name="my_event_that_doesnt_need_to_really_exist_$i" \
154 --action notify
155 done
156
157 for i in $(seq 4 5); do
158 lttng_add_trigger_fail "$i" \
159 --condition event-rule-matches --type=kernel --name="my_event_that_doesnt_need_to_really_exist_$i" \
160 --action notify
161 done
162
163 stop_lttng_sessiond
164 }
165
166 function test_ust_notifier_discarded_count
167 {
168 local sessiond_pipe=()
169 local trigger_name="my_trigger"
170 local NR_USEC_WAIT=0
171 local PIPE_SIZE
172 local NR_ITER
173
174 diag "UST event notifer error counter"
175
176 PIPE_SIZE=$(get_pipe_max_size)
177
178 # Find the number of events needed to overflow the event notification
179 # pipe buffer. Each LTTng-UST notification is at least 42 bytes long.
180 # Double that number to ensure enough events are created to overflow
181 # the buffer.
182 NR_ITER=$(( (PIPE_SIZE / 42) * 2 ))
183 diag "Test application will emit $NR_ITER events"
184
185 # Used on sessiond launch.
186 LTTNG_SESSIOND_ENV_VARS="LTTNG_TESTPOINT_ENABLE=1 \
187 NOTIFIER_PAUSE_PIPE_PATH=${TESTPOINT_PIPE_PATH} \
188 LD_PRELOAD=${TESTPOINT}"
189
190 if ! start_lttng_sessiond; then
191 skip 0 "Failed to start sessiond" $((UST_DISCARD_NUM_TESTS - 1))
192 return
193 fi
194
195 # This is needed since the testpoint create a pipe with the sessiond
196 # type suffixed.
197 for f in "$TESTPOINT_BASE_PATH"*; do
198 sessiond_pipe+=("$f")
199 done
200
201 lttng_add_trigger_ok "$trigger_name" \
202 --condition event-rule-matches --type=user --name=tp:tptest \
203 --action notify
204
205 trigger_discarded_nb=$(trigger_get_discarded_notif_number "$trigger_name")
206 is "$trigger_discarded_nb" 0 "No discarded tracer notification"
207
208 # Stop consumption of notifier tracer notifications.
209 diag "Pause consumption of tracer messages"
210 echo -n 1 > "$sessiond_pipe"
211
212 $TESTAPP_BIN -i $NR_ITER -w $NR_USEC_WAIT
213 ok $? "Generating $NR_ITER tracer notifications"
214
215 # Confirm that the number of tracer notifications discarded is non-zero.
216 trigger_discarded_nb=$(trigger_get_discarded_notif_number "$trigger_name")
217 isnt "$trigger_discarded_nb" 0 "Discarded tracer notification number non-zero ($trigger_discarded_nb) as expected"
218
219 # Remove the notifier.
220 lttng_remove_trigger_ok "$trigger_name"
221
222 # Confirm that no trigger is enabled.
223 list_triggers_line_count=$("$FULL_LTTNG_BIN" list-triggers | wc -l)
224 is "$list_triggers_line_count" "0" "No \`event-rule-matches\` userspace notifier enabled as expected"
225
226 # Enable another notifier and list it to confirm the counter was cleared.
227 lttng_add_trigger_ok "$trigger_name" \
228 --condition event-rule-matches --type=user --name=tp:tptest \
229 --action notify
230
231 trigger_discarded_nb=$(trigger_get_discarded_notif_number "$trigger_name")
232 is "$trigger_discarded_nb" 0 "No discarded tracer notification"
233
234 lttng_remove_trigger_ok "$trigger_name"
235
236 stop_lttng_sessiond
237
238 unset LTTNG_SESSIOND_ENV_VARS
239 }
240
241 function test_ust_notifier_discarded_count_max_bucket
242 {
243 diag "UST event notifer error counter bucket limit"
244
245 if ! start_lttng_sessiond "" "--event-notifier-error-buffer-size-userspace=3"; then
246 skip 0 "Failed to start sessiond" $((UST_DISCARD_MAX_BUCKET_NUM_TESTS - 1))
247 return
248 fi
249
250 for i in $(seq 3); do
251 lttng_add_trigger_ok "$i" \
252 --condition event-rule-matches --type=user --name="my_event_that_doesnt_need_to_really_exist_$i" \
253 --action notify
254 done
255
256 for i in $(seq 4 5); do
257 lttng_add_trigger_fail "$i" \
258 --condition event-rule-matches --type=user --name="my_event_that_doesnt_need_to_really_exist_$i" \
259 --action notify
260 done
261
262 stop_lttng_sessiond
263 }
264
265 function test_ust_notifier_discarded_count_multi_uid
266 {
267 local sessiond_pipe=()
268 local root_trigger_name="root_trigger"
269 local user_trigger_name="user_trigger"
270 local list_triggers_stdout
271 local NR_USEC_WAIT=0
272 local PIPE_SIZE
273 local NR_ITER
274 local new_user="dummy_lttng_test_user"
275
276 diag "UST event notifer error counter multiple UIDs"
277
278 list_triggers_stdout=$(mktemp -t "list_triggers_stdout.XXXXXX")
279
280 # Create a dummy user to run test apps as.
281 useradd --no-create-home "$new_user"
282 new_uid=$(id -u "$new_user")
283
284 PIPE_SIZE=$(get_pipe_max_size)
285
286 # Find the number of events needed to overflow the event notification
287 # pipe buffer. Each LTTng-UST notification is at least 42 bytes long.
288 # Double that number to ensure enough events are created to overflow
289 # the buffer.
290 NR_ITER=$(( (PIPE_SIZE / 42) * 2 ))
291 diag "Test applications will emit $NR_ITER events"
292
293 # Used on sessiond launch.
294 LTTNG_SESSIOND_ENV_VARS="LTTNG_TESTPOINT_ENABLE=1 \
295 NOTIFIER_PAUSE_PIPE_PATH=${TESTPOINT_PIPE_PATH} \
296 LD_PRELOAD=${TESTPOINT}"
297
298 if ! start_lttng_sessiond; then
299 skip 0 "Failed to start sessiond" $((UST_DISCARD_MULTI_UID_NUM_TESTS - 1))
300 return
301 fi
302
303 # This is needed since the testpoint create a pipe with the sessiond
304 # type suffixed.
305 for f in "$TESTPOINT_BASE_PATH"*; do
306 sessiond_pipe+=("$f")
307 done
308
309 lttng_add_trigger_ok "$root_trigger_name" \
310 --condition event-rule-matches --type=user --name tp:tptest \
311 --action notify
312
313 lttng_add_trigger_ok "$user_trigger_name" --owner-uid "$new_uid" \
314 --condition event-rule-matches --type=user --name tp:tptest \
315 --action notify
316
317 # Stop consumption of notifier tracer notifications.
318 echo -n 1 > "$sessiond_pipe"
319
320 $TESTAPP_BIN -i $NR_ITER -w $NR_USEC_WAIT
321 ok $? "Generating $NR_ITER tracer notifications as UID: $(id -u)"
322
323 su "$new_user" -c "$TESTAPP_BIN -i $NR_ITER -w $NR_USEC_WAIT"
324 ok $? "Generating $NR_ITER tracer notifications as UID: $new_uid"
325
326 root_trigger_discarded_nb=$(trigger_get_discarded_notif_number "$root_trigger_name")
327 user_trigger_discarded_nb=$(trigger_get_discarded_notif_number "$user_trigger_name")
328
329 isnt "$root_trigger_discarded_nb" 0 \
330 "Root trigger discarded notifications number ($root_trigger_discarded_nb) is non-zero"
331 isnt "$user_trigger_discarded_nb" 0 \
332 "User trigger discarded notifications number ($user_trigger_discarded_nb) is non-zero"
333
334 lttng_remove_trigger_ok "$root_trigger_name"
335 lttng_remove_trigger_ok "$user_trigger_name" --owner-uid "$new_uid"
336
337 stop_lttng_sessiond
338
339 unset LTTNG_SESSIOND_ENV_VARS
340
341 userdel "$new_user"
342 rm -f "$list_triggers_stdout"
343 }
344
345 function test_ust_notifier_discarded_regardless_trigger_owner
346 {
347 local sessiond_pipe=()
348 local root_trigger_name="root_trigger"
349 local user_trigger_name="user_trigger"
350 local list_triggers_stdout=$(mktemp -t "list_triggers_stdout.XXXXXX")
351 local NR_USEC_WAIT=0
352 local PIPE_SIZE
353 local NR_ITER
354 local new_user="dummy_lttng_test_user"
355
356 PIPE_SIZE=$(get_pipe_max_size)
357
358 # Find the number of events needed to overflow the event notification
359 # pipe buffer. Each LTTng-UST notification is at least 42 bytes long.
360 # Double that number to ensure enough events are created to overflow
361 # the buffer.
362 NR_ITER=$(( (PIPE_SIZE / 42) * 2 ))
363 diag "Test applications will emit $NR_ITER events"
364
365 diag "UST event notifer error counter persists when a root trigger is present"
366
367 # Create a dummy user to run test apps as.
368 useradd --no-create-home "$new_user"
369 new_uid=$(id -u "$new_user")
370
371 # Used on sessiond launch.
372 LTTNG_SESSIOND_ENV_VARS="LTTNG_TESTPOINT_ENABLE=1 \
373 NOTIFIER_PAUSE_PIPE_PATH=${TESTPOINT_PIPE_PATH} \
374 LD_PRELOAD=${TESTPOINT}"
375
376 if ! start_lttng_sessiond; then
377 skip 0 "Failed to start sessiond" $((UST_DISCARD_TRIGGER_OWNER_NUM_TESTS - 1))
378 return
379 fi
380
381 # This is needed since the testpoint create a pipe with the sessiond
382 # type suffixed.
383 for f in "$TESTPOINT_BASE_PATH"*; do
384 sessiond_pipe+=("$f")
385 done
386
387 lttng_add_trigger_ok "$root_trigger_name" \
388 --condition event-rule-matches --type=user --name tp:tptest \
389 --action notify
390
391 # Stop consumption of notifier tracer notifications.
392 echo -n 1 > "$sessiond_pipe"
393
394 su "$new_user" -c "$TESTAPP_BIN -i $NR_ITER -w $NR_USEC_WAIT"
395 ok $? "Generating $NR_ITER tracer notifications as UID: $new_uid"
396
397 root_trigger_discarded_nb=$(trigger_get_discarded_notif_number "$root_trigger_name")
398
399 isnt "$root_trigger_discarded_nb" 0 \
400 "Root trigger discarded notifications number ($root_trigger_discarded_nb) is non-zero"
401
402 lttng_remove_trigger_ok "$root_trigger_name"
403
404 stop_lttng_sessiond
405
406 unset LTTNG_SESSIOND_ENV_VARS
407
408 userdel "$new_user"
409 rm -f "$list_triggers_stdout"
410 }
411
412 test_ust_notifier_discarded_count
413 test_ust_notifier_discarded_count_max_bucket
414
415 check_skip_kernel_test "$((KERNEL_NUM_TESTS + DESTRUCTIVE_NUM_TESTS))" "Skipping kernel notification tests." ||
416 {
417
418 validate_lttng_modules_present
419
420 modprobe lttng-test
421
422 test_kernel_notifier_discarded_count
423 test_kernel_notifier_discarded_count_max_bucket
424
425 if destructive_tests_enabled ; then
426 # Those tests add a new user on the system. Since it's a quite
427 # intrusive change to the system, we decide to only run it when
428 # the user knows what they are doing.
429 test_ust_notifier_discarded_count_multi_uid
430 test_ust_notifier_discarded_regardless_trigger_owner
431 else
432 skip 0 "You need to set the LTTNG_ENABLE_DESTRUCTIVE_TESTS environment variable to \"will-break-my-system\" to run this test" $DESTRUCTIVE_NUM_TESTS
433 fi
434
435 modprobe --remove lttng-test
436
437 rm -rf "${sessiond_pipe[@]}" 2> /dev/null
438
439 }
440
441 rm -rf "$TEST_TMPDIR"