3 # Copyright (C) - 2020 EfficiOS, inc
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 the `lttng list-trigger` command line interface.
20 CURDIR
="$(dirname "$0")"
21 TESTDIR
="$CURDIR/../../.."
23 # shellcheck source=../../../utils/utils.sh
24 source "$TESTDIR/utils/utils.sh"
28 FULL_LTTNG_BIN
="${TESTDIR}/../src/bin/lttng/${LTTNG_BIN}"
30 tmp_stdout
=$
(mktemp
-t test_list_triggers_cli_stdout.XXXXXX
)
31 tmp_stderr
=$
(mktemp
-t test_list_triggers_cli_stderr.XXXXXX
)
32 tmp_expected_stdout
=$
(mktemp
-t test_list_triggers_cli_expected_stdout.XXXXXX
)
33 uprobe_elf_binary
=$
(realpath
"${TESTDIR}/utils/testapp/userspace-probe-elf-binary/.libs/userspace-probe-elf-binary")
34 uprobe_sdt_binary
=$
(realpath
"${TESTDIR}/utils/testapp/userspace-probe-sdt-binary/.libs/userspace-probe-sdt-binary")
35 register_some_triggers_bin
=$
(realpath
"${CURDIR}/utils/register-some-triggers")
40 if [ "$uid" == "0" ]; then
42 ls "$uprobe_sdt_binary" >/dev
/null
2>&1
54 function list_triggers_matches_ok
()
57 local expected_stdout_file
="$2"
59 "${FULL_LTTNG_BIN}" list-triggers > "${tmp_stdout}" 2> "${tmp_stderr}"
60 ok $?
"${test_name}: exit code is 0"
62 diff -u "${expected_stdout_file}" "${tmp_stdout}"
63 ok $?
"${test_name}: expected stdout"
65 diff -u /dev
/null
"${tmp_stderr}"
66 ok $?
"${test_name}: expected stderr"
69 test_top_level_options
()
71 diag
"Listing top level options"
73 lttng_add_trigger_ok
"hello" --condition event-rule-matches
--domain=user
--name=test-name
--action notify
75 cat > "${tmp_expected_stdout}" <<- EOF
78 condition: event rule hit
79 rule: test-name (type: tracepoint, domain: ust)
86 list_triggers_matches_ok
"top level options" "${tmp_expected_stdout}"
88 lttng_remove_trigger_ok
"hello"
91 test_on_event_tracepoint
()
93 diag
"Listing on-event tracepoint"
95 lttng_add_trigger_ok
"C" --condition event-rule-matches
--domain=user
--action notify
96 lttng_add_trigger_ok
"A" --condition event-rule-matches
--name=aaa
--domain=user
--filter 'p == 2' --action notify
97 lttng_add_trigger_ok
"D" --condition event-rule-matches
--name='hello*' --domain=user
-x 'hello2,hello3,hello4' --action notify
98 lttng_add_trigger_ok
"B" --condition event-rule-matches
--domain=user
--name=gerboise
--log-level INFO..
--action notify
99 lttng_add_trigger_ok
"E" --condition event-rule-matches
--domain=user
--name=lemming
--log-level WARNING
--action notify
100 lttng_add_trigger_ok
"J" --condition event-rule-matches
--domain=user
--name=lemming
--log-level ..
--action notify
101 lttng_add_trigger_ok
"F" --condition event-rule-matches
--domain=user
--name=capture-payload-field
--capture a
--action notify
102 lttng_add_trigger_ok
"G" --condition event-rule-matches
--domain=user
--name=capture-array
--capture 'a[2]' --capture '$ctx.tourlou[18]' --action notify
103 lttng_add_trigger_ok
"H" --condition event-rule-matches
--domain=user
--name=capture-chan-ctx
--capture '$ctx.vpid' --action notify
104 lttng_add_trigger_ok
"I" --condition event-rule-matches
--domain=user
--name=capture-app-ctx
--capture '$app.iga:active_clients' --action notify
106 cat > "${tmp_expected_stdout}" <<- EOF
109 condition: event rule hit
110 rule: aaa (type: tracepoint, domain: ust, filter: p == 2)
117 condition: event rule hit
118 rule: gerboise (type: tracepoint, domain: ust, log level at least INFO)
125 condition: event rule hit
126 rule: * (type: tracepoint, domain: ust)
133 condition: event rule hit
134 rule: hello* (type: tracepoint, domain: ust, exclusions: hello2,hello3,hello4)
141 condition: event rule hit
142 rule: lemming (type: tracepoint, domain: ust, log level is WARNING)
149 condition: event rule hit
150 rule: capture-payload-field (type: tracepoint, domain: ust)
159 condition: event rule hit
160 rule: capture-array (type: tracepoint, domain: ust)
170 condition: event rule hit
171 rule: capture-chan-ctx (type: tracepoint, domain: ust)
180 condition: event rule hit
181 rule: capture-app-ctx (type: tracepoint, domain: ust)
183 - \$app.iga:active_clients
190 condition: event rule hit
191 rule: lemming (type: tracepoint, domain: ust)
198 list_triggers_matches_ok
"event-rule-matches, tracepoint event rule" "${tmp_expected_stdout}"
200 lttng_remove_trigger_ok
"A"
201 lttng_remove_trigger_ok
"B"
202 lttng_remove_trigger_ok
"C"
203 lttng_remove_trigger_ok
"D"
204 lttng_remove_trigger_ok
"E"
205 lttng_remove_trigger_ok
"F"
206 lttng_remove_trigger_ok
"G"
207 lttng_remove_trigger_ok
"H"
208 lttng_remove_trigger_ok
"I"
209 lttng_remove_trigger_ok
"J"
212 test_on_event_probe
()
214 local channel_enable_addr
215 local channel_disable_addr
217 diag
"Listing on-event kernel probe"
219 channel_enable_addr
=$
(grep ' t lttng_channel_enable\s\[lttng_tracer\]$' /proc
/kallsyms | cut
-f 1 -d ' ')
220 channel_disable_addr
=$
(grep ' t lttng_channel_disable\s\[lttng_tracer\]$' /proc
/kallsyms | cut
-f 1 -d ' ')
222 # We need to find a valid offset.
225 if [[ 0x
$channel_enable_addr -lt 0x
$channel_disable_addr ]]; then
226 base_symbol
="lttng_channel_enable"
227 offset
=$
(( 0x
$channel_disable_addr - 0x
$channel_enable_addr ))
229 base_symbol
="lttng_channel_disable"
230 offset
=$
(( 0x
$channel_enable_addr - 0x
$channel_disable_addr ))
233 offset_hex
="0x$(printf '%x' $offset)"
235 lttng_add_trigger_ok
"T0" --condition event-rule-matches
--domain=kernel
--type=kprobe
--location=lttng_channel_enable
--event-name=my_channel_enable
--action notify
236 lttng_add_trigger_ok
"T1" --condition event-rule-matches
--domain=kernel
--type=kprobe
--location="${base_symbol}+${offset_hex}" --event-name=my_channel_enable
--action notify
237 lttng_add_trigger_ok
"T2" --condition event-rule-matches
--domain=kernel
--type=kprobe
--location="0x${channel_enable_addr}" --event-name=my_channel_enable
--action notify
239 cat > "${tmp_expected_stdout}" <<- EOF
242 condition: event rule hit
243 rule: my_channel_enable (type: probe, location: lttng_channel_enable)
250 condition: event rule hit
251 rule: my_channel_enable (type: probe, location: ${base_symbol}+${offset_hex})
258 condition: event rule hit
259 rule: my_channel_enable (type: probe, location: 0x${channel_enable_addr})
266 list_triggers_matches_ok
"event-rule-matches, probe event rule" "${tmp_expected_stdout}"
268 lttng_remove_trigger_ok
"T0"
269 lttng_remove_trigger_ok
"T1"
270 lttng_remove_trigger_ok
"T2"
273 test_on_event_userspace_probe_elf
()
275 local elf_function_name
="test_function"
277 diag
"Listing on-event userspace-probe elf"
279 lttng_add_trigger_ok
"T0" --condition event-rule-matches
--domain=kernel
--type=uprobe
--location=${uprobe_elf_binary}:test_function
--event-name=ma-probe-elf
--action notify
281 cat > "${tmp_expected_stdout}" <<- EOF
284 condition: event rule hit
285 rule: ma-probe-elf (type: userspace probe, location type: ELF, location: ${uprobe_elf_binary}:${elf_function_name})
292 list_triggers_matches_ok
"event-rule-matches, userspace-probe event rule" "${tmp_expected_stdout}"
294 lttng_remove_trigger_ok
"T0"
297 test_on_event_userspace_probe_sdt
()
299 local sdt_provider_name
="foobar"
300 local sdt_probe_name
="tp1"
302 diag
"on-event userspace-probe sdt"
304 lttng_add_trigger_ok
"T0" --condition on-event
-k --userspace-probe=sdt
:${uprobe_sdt_binary}:${sdt_provider_name}:${sdt_probe_name} ma-probe-sdt
--action notify
306 cat > "${tmp_expected_stdout}" <<- EOF
309 condition: event rule hit
310 rule: ma-probe-sdt (type: userspace probe, location type: SDT, location: ${uprobe_sdt_binary}:${sdt_provider_name}:${sdt_probe_name})
317 list_triggers_matches_ok
"on-event, userspace-probe event rule SDT" "${tmp_expected_stdout}"
319 lttng_remove_trigger_ok
"T0"
322 test_on_event_syscall
()
324 diag
"Listing on-event syscall"
326 lttng_add_trigger_ok
"T0" --condition event-rule-matches
--domain=kernel
--type=syscall
--name=open
--action notify
327 lttng_add_trigger_ok
"T1" --condition event-rule-matches
--domain=kernel
--type=syscall
--name=ptrace
--filter 'a > 2' --action notify
329 cat > "${tmp_expected_stdout}" <<- EOF
332 condition: event rule hit
333 rule: open (type: syscall)
340 condition: event rule hit
341 rule: ptrace (type: syscall, filter: a > 2)
348 list_triggers_matches_ok
"event-rule-matches, syscall event rule" "${tmp_expected_stdout}"
350 lttng_remove_trigger_ok
"T0"
351 lttng_remove_trigger_ok
"T1"
354 test_session_consumed_size_condition
()
356 ${register_some_triggers_bin} test_session_consumed_size_condition
358 cat > "${tmp_expected_stdout}" <<- EOF
359 - name: trigger-with-session-consumed-size-condition
361 condition: session consumed size
362 session name: the-session-name
363 threshold: 1234 bytes
370 list_triggers_matches_ok
"session consumed size condition" "${tmp_expected_stdout}"
372 lttng_remove_trigger_ok
"trigger-with-session-consumed-size-condition"
375 test_buffer_usage_conditions
()
377 ${register_some_triggers_bin} test_buffer_usage_conditions
379 cat > "${tmp_expected_stdout}" <<- EOF
380 - name: trigger-with-buffer-usage-high-bytes-condition
382 condition: buffer usage high
383 session name: the-session-name
384 channel name: the-channel-name
386 threshold (bytes): 1234
391 - name: trigger-with-buffer-usage-high-ratio-condition
393 condition: buffer usage high
394 session name: the-session-name
395 channel name: the-channel-name
397 threshold (ratio): 0.25
402 - name: trigger-with-buffer-usage-low-bytes-condition
404 condition: buffer usage low
405 session name: the-session-name
406 channel name: the-channel-name
408 threshold (bytes): 2345
413 - name: trigger-with-buffer-usage-low-ratio-condition
415 condition: buffer usage low
416 session name: the-session-name
417 channel name: the-channel-name
419 threshold (ratio): 0.40
426 list_triggers_matches_ok
"buffer usage condition" "${tmp_expected_stdout}"
428 lttng_remove_trigger_ok
"trigger-with-buffer-usage-high-bytes-condition"
429 lttng_remove_trigger_ok
"trigger-with-buffer-usage-high-ratio-condition"
430 lttng_remove_trigger_ok
"trigger-with-buffer-usage-low-bytes-condition"
431 lttng_remove_trigger_ok
"trigger-with-buffer-usage-low-ratio-condition"
434 test_session_rotation_conditions
()
436 ${register_some_triggers_bin} test_session_rotation_conditions
438 cat > "${tmp_expected_stdout}" <<- EOF
439 - name: trigger-with-session-rotation-completed-condition
441 condition: session rotation completed
442 session name: the-session-name
447 - name: trigger-with-session-rotation-ongoing-condition
449 condition: session rotation ongoing
450 session name: the-session-name
457 list_triggers_matches_ok
"session rotation conditions" "${tmp_expected_stdout}"
459 lttng_remove_trigger_ok
"trigger-with-session-rotation-completed-condition"
460 lttng_remove_trigger_ok
"trigger-with-session-rotation-ongoing-condition"
463 test_snapshot_action
()
465 diag
"Listing snapshot actions"
467 lttng_add_trigger_ok
"T0" --condition event-rule-matches
--domain=user
--name=some-event
--action snapshot-session ze-session
468 lttng_add_trigger_ok
"T1" --condition event-rule-matches
--domain=user
--name=some-event
--action snapshot-session ze-session
--path /some
/path
469 lttng_add_trigger_ok
"T2" --condition event-rule-matches
--domain=user
--name=some-event
--action snapshot-session ze-session
--url file:///some
/other
/path
470 lttng_add_trigger_ok
"T3" --condition event-rule-matches
--domain=user
--name=some-event
--action snapshot-session ze-session
--url net
://1.2.3.4
471 lttng_add_trigger_ok
"T4" --condition event-rule-matches
--domain=user
--name=some-event
--action snapshot-session ze-session
--url net
://1.2.3.4:1234:1235
472 lttng_add_trigger_ok
"T5" --condition event-rule-matches
--domain=user
--name=some-event
--action snapshot-session ze-session
--ctrl-url=tcp
://1.2.3.4:1111 --data-url=tcp
://1.2.3.4:1112
473 lttng_add_trigger_ok
"T6" --condition event-rule-matches
--domain=user
--name=some-event
--action snapshot-session ze-session
--path /some
/path
--max-size=1234
474 lttng_add_trigger_ok
"T7" --condition event-rule-matches
--domain=user
--name=some-event
--action snapshot-session ze-session
--path /some
/path
--name=meh
475 lttng_add_trigger_ok
"T8" --condition event-rule-matches
--domain=user
--name=some-event
--action snapshot-session ze-session
--rate-policy=every
:10
476 lttng_add_trigger_ok
"T9" --condition event-rule-matches
--domain=user
--name=some-event
--action snapshot-session ze-session
--rate-policy=once-after
:10
478 cat > "${tmp_expected_stdout}" <<- EOF
481 condition: event rule hit
482 rule: some-event (type: tracepoint, domain: ust)
484 snapshot session \`ze-session\`
489 condition: event rule hit
490 rule: some-event (type: tracepoint, domain: ust)
492 snapshot session \`ze-session\`, path: /some/path
497 condition: event rule hit
498 rule: some-event (type: tracepoint, domain: ust)
500 snapshot session \`ze-session\`, path: /some/other/path
505 condition: event rule hit
506 rule: some-event (type: tracepoint, domain: ust)
508 snapshot session \`ze-session\`, url: net://1.2.3.4
513 condition: event rule hit
514 rule: some-event (type: tracepoint, domain: ust)
516 snapshot session \`ze-session\`, url: net://1.2.3.4:1234:1235
521 condition: event rule hit
522 rule: some-event (type: tracepoint, domain: ust)
524 snapshot session \`ze-session\`, control url: tcp://1.2.3.4:1111, data url: tcp://1.2.3.4:1112
529 condition: event rule hit
530 rule: some-event (type: tracepoint, domain: ust)
532 snapshot session \`ze-session\`, path: /some/path, max size: 1234
537 condition: event rule hit
538 rule: some-event (type: tracepoint, domain: ust)
540 snapshot session \`ze-session\`, path: /some/path, name: meh
545 condition: event rule hit
546 rule: some-event (type: tracepoint, domain: ust)
548 snapshot session \`ze-session\`, rate policy: after every 10 occurrences
553 condition: event rule hit
554 rule: some-event (type: tracepoint, domain: ust)
556 snapshot session \`ze-session\`, rate policy: once after 10 occurrences
561 list_triggers_matches_ok
"snapshot action" "${tmp_expected_stdout}"
563 lttng_remove_trigger_ok
"T0"
564 lttng_remove_trigger_ok
"T1"
565 lttng_remove_trigger_ok
"T2"
566 lttng_remove_trigger_ok
"T3"
567 lttng_remove_trigger_ok
"T4"
568 lttng_remove_trigger_ok
"T5"
569 lttng_remove_trigger_ok
"T6"
570 lttng_remove_trigger_ok
"T7"
571 lttng_remove_trigger_ok
"T8"
572 lttng_remove_trigger_ok
"T9"
575 test_notify_action
()
577 lttng_add_trigger_ok
"T0" --condition event-rule-matches
--domain=user
--name=some-event
--action notify
--rate-policy=once-after
:5
578 lttng_add_trigger_ok
"T1" --condition event-rule-matches
--domain=user
--name=some-event
--action notify
--rate-policy=every
:10
580 cat > "${tmp_expected_stdout}" <<- EOF
583 condition: event rule hit
584 rule: some-event (type: tracepoint, domain: ust)
586 notify, rate policy: once after 5 occurrences
591 condition: event rule hit
592 rule: some-event (type: tracepoint, domain: ust)
594 notify, rate policy: after every 10 occurrences
599 list_triggers_matches_ok
"notify action" "${tmp_expected_stdout}"
601 lttng_remove_trigger_ok
"T0"
602 lttng_remove_trigger_ok
"T1"
605 plan_tests
$NUM_TESTS
607 # shellcheck disable=SC2119
608 start_lttng_sessiond_notap
610 test_top_level_options
611 test_on_event_tracepoint
612 skip
$ist_root "non-root user: skipping kprobe tests" 9 || test_on_event_probe
613 skip
$ist_root "non-root user: skipping uprobe tests" 5 || test_on_event_userspace_probe_elf
614 skip $
(($ist_root && $hast_sdt_binary)) "skipping userspace probe SDT tests" 5 || test_on_event_userspace_probe_sdt
615 skip
$ist_root "non-root user: skipping syscall tests" 7 || test_on_event_syscall
616 test_session_consumed_size_condition
617 test_buffer_usage_conditions
618 test_session_rotation_conditions
622 stop_lttng_sessiond_notap
625 rm -f "${tmp_stdout}"
626 rm -f "${tmp_stderr}"
627 rm -f "${tmp_expected_stdout}"