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")
39 if [ "$uid" == "0" ]; then
41 ls "$uprobe_sdt_binary" >/dev
/null
2>&1
53 function list_triggers_matches_ok
()
56 local expected_stdout_file
="$2"
58 "${FULL_LTTNG_BIN}" list-triggers > "${tmp_stdout}" 2> "${tmp_stderr}"
59 ok $?
"${test_name}: exit code is 0"
61 diff -u "${expected_stdout_file}" "${tmp_stdout}"
62 ok $?
"${test_name}: expected stdout"
64 diff -u /dev
/null
"${tmp_stderr}"
65 ok $?
"${test_name}: expected stderr"
68 test_top_level_options
()
70 diag
"Listing top level options"
72 lttng_add_trigger_ok
"hello" --condition event-rule-matches
--domain=user
--name=test-name
--action notify
74 cat > "${tmp_expected_stdout}" <<- EOF
77 condition: event rule hit
78 rule: test-name (type: tracepoint, domain: ust)
85 list_triggers_matches_ok
"top level options" "${tmp_expected_stdout}"
87 lttng_remove_trigger_ok
"hello"
90 test_on_event_tracepoint
()
92 diag
"Listing on-event tracepoint"
94 lttng_add_trigger_ok
"C" --condition event-rule-matches
--domain=user
--action notify
95 lttng_add_trigger_ok
"A" --condition event-rule-matches
--name=aaa
--domain=user
--filter 'p == 2' --action notify
96 lttng_add_trigger_ok
"D" --condition event-rule-matches
--name='hello*' --domain=user
-x 'hello2,hello3,hello4' --action notify
97 lttng_add_trigger_ok
"B" --condition event-rule-matches
--domain=user
--name=gerboise
--log-level INFO..
--action notify
98 lttng_add_trigger_ok
"E" --condition event-rule-matches
--domain=user
--name=lemming
--log-level WARNING
--action notify
99 lttng_add_trigger_ok
"J" --condition event-rule-matches
--domain=user
--name=lemming
--log-level ..
--action notify
100 lttng_add_trigger_ok
"F" --condition event-rule-matches
--domain=user
--name=capture-payload-field
--capture a
--action notify
101 lttng_add_trigger_ok
"G" --condition event-rule-matches
--domain=user
--name=capture-array
--capture 'a[2]' --capture '$ctx.tourlou[18]' --action notify
102 lttng_add_trigger_ok
"H" --condition event-rule-matches
--domain=user
--name=capture-chan-ctx
--capture '$ctx.vpid' --action notify
103 lttng_add_trigger_ok
"I" --condition event-rule-matches
--domain=user
--name=capture-app-ctx
--capture '$app.iga:active_clients' --action notify
105 cat > "${tmp_expected_stdout}" <<- EOF
108 condition: event rule hit
109 rule: aaa (type: tracepoint, domain: ust, filter: p == 2)
116 condition: event rule hit
117 rule: gerboise (type: tracepoint, domain: ust, log level at least INFO)
124 condition: event rule hit
125 rule: * (type: tracepoint, domain: ust)
132 condition: event rule hit
133 rule: hello* (type: tracepoint, domain: ust, exclusions: hello2,hello3,hello4)
140 condition: event rule hit
141 rule: lemming (type: tracepoint, domain: ust, log level is WARNING)
148 condition: event rule hit
149 rule: capture-payload-field (type: tracepoint, domain: ust)
158 condition: event rule hit
159 rule: capture-array (type: tracepoint, domain: ust)
169 condition: event rule hit
170 rule: capture-chan-ctx (type: tracepoint, domain: ust)
179 condition: event rule hit
180 rule: capture-app-ctx (type: tracepoint, domain: ust)
182 - \$app.iga:active_clients
189 condition: event rule hit
190 rule: lemming (type: tracepoint, domain: ust)
197 list_triggers_matches_ok
"event-rule-matches, tracepoint event rule" "${tmp_expected_stdout}"
199 lttng_remove_trigger_ok
"A"
200 lttng_remove_trigger_ok
"B"
201 lttng_remove_trigger_ok
"C"
202 lttng_remove_trigger_ok
"D"
203 lttng_remove_trigger_ok
"E"
204 lttng_remove_trigger_ok
"F"
205 lttng_remove_trigger_ok
"G"
206 lttng_remove_trigger_ok
"H"
207 lttng_remove_trigger_ok
"I"
208 lttng_remove_trigger_ok
"J"
211 test_on_event_probe
()
213 local channel_enable_addr
214 local channel_disable_addr
216 diag
"Listing on-event kernel probe"
218 channel_enable_addr
=$
(grep ' t lttng_channel_enable\s\[lttng_tracer\]$' /proc
/kallsyms | cut
-f 1 -d ' ')
219 channel_disable_addr
=$
(grep ' t lttng_channel_disable\s\[lttng_tracer\]$' /proc
/kallsyms | cut
-f 1 -d ' ')
221 # We need to find a valid offset.
224 if [[ 0x
$channel_enable_addr -lt 0x
$channel_disable_addr ]]; then
225 base_symbol
="lttng_channel_enable"
226 offset
=$
(( 0x
$channel_disable_addr - 0x
$channel_enable_addr ))
228 base_symbol
="lttng_channel_disable"
229 offset
=$
(( 0x
$channel_enable_addr - 0x
$channel_disable_addr ))
232 offset_hex
="0x$(printf '%x' $offset)"
234 lttng_add_trigger_ok
"T0" --condition event-rule-matches
--domain=kernel
--type=kprobe
--location=lttng_channel_enable
--event-name=my_channel_enable
--action notify
235 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
236 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
238 cat > "${tmp_expected_stdout}" <<- EOF
241 condition: event rule hit
242 rule: my_channel_enable (type: probe, location: lttng_channel_enable)
249 condition: event rule hit
250 rule: my_channel_enable (type: probe, location: ${base_symbol}+${offset_hex})
257 condition: event rule hit
258 rule: my_channel_enable (type: probe, location: 0x${channel_enable_addr})
265 list_triggers_matches_ok
"event-rule-matches, probe event rule" "${tmp_expected_stdout}"
267 lttng_remove_trigger_ok
"T0"
268 lttng_remove_trigger_ok
"T1"
269 lttng_remove_trigger_ok
"T2"
272 test_on_event_userspace_probe_elf
()
274 local elf_function_name
="test_function"
276 diag
"Listing on-event userspace-probe elf"
278 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
280 cat > "${tmp_expected_stdout}" <<- EOF
283 condition: event rule hit
284 rule: ma-probe-elf (type: userspace probe, location type: ELF, location: ${uprobe_elf_binary}:${elf_function_name})
291 list_triggers_matches_ok
"event-rule-matches, userspace-probe event rule" "${tmp_expected_stdout}"
293 lttng_remove_trigger_ok
"T0"
296 test_on_event_userspace_probe_sdt
()
298 local sdt_provider_name
="foobar"
299 local sdt_probe_name
="tp1"
301 diag
"on-event userspace-probe sdt"
303 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
305 cat > "${tmp_expected_stdout}" <<- EOF
308 condition: event rule hit
309 rule: ma-probe-sdt (type: userspace probe, location type: SDT, location: ${uprobe_sdt_binary}:${sdt_provider_name}:${sdt_probe_name})
316 list_triggers_matches_ok
"on-event, userspace-probe event rule SDT" "${tmp_expected_stdout}"
318 lttng_remove_trigger_ok
"T0"
321 test_on_event_syscall
()
323 diag
"Listing on-event syscall"
325 lttng_add_trigger_ok
"T0" --condition event-rule-matches
--domain=kernel
--type=syscall
--name=open
--action notify
326 lttng_add_trigger_ok
"T1" --condition event-rule-matches
--domain=kernel
--type=syscall
--name=ptrace
--filter 'a > 2' --action notify
328 cat > "${tmp_expected_stdout}" <<- EOF
331 condition: event rule hit
332 rule: open (type: syscall)
339 condition: event rule hit
340 rule: ptrace (type: syscall, filter: a > 2)
347 list_triggers_matches_ok
"event-rule-matches, syscall event rule" "${tmp_expected_stdout}"
349 lttng_remove_trigger_ok
"T0"
350 lttng_remove_trigger_ok
"T1"
353 test_snapshot_action
()
355 diag
"Listing snapshot actions"
357 lttng_add_trigger_ok
"T0" --condition event-rule-matches
--domain=user
--name=some-event
--action snapshot-session ze-session
358 lttng_add_trigger_ok
"T1" --condition event-rule-matches
--domain=user
--name=some-event
--action snapshot-session ze-session
--path /some
/path
359 lttng_add_trigger_ok
"T2" --condition event-rule-matches
--domain=user
--name=some-event
--action snapshot-session ze-session
--url file:///some
/other
/path
360 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
361 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
362 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
363 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
364 lttng_add_trigger_ok
"T7" --condition event-rule-matches
--domain=user
--name=some-event
--action snapshot-session ze-session
--path /some
/path
--name=meh
365 lttng_add_trigger_ok
"T8" --condition event-rule-matches
--domain=user
--name=some-event
--action snapshot-session ze-session
--rate-policy=every
:10
366 lttng_add_trigger_ok
"T9" --condition event-rule-matches
--domain=user
--name=some-event
--action snapshot-session ze-session
--rate-policy=once-after
:10
368 cat > "${tmp_expected_stdout}" <<- EOF
371 condition: event rule hit
372 rule: some-event (type: tracepoint, domain: ust)
374 snapshot session \`ze-session\`
379 condition: event rule hit
380 rule: some-event (type: tracepoint, domain: ust)
382 snapshot session \`ze-session\`, path: /some/path
387 condition: event rule hit
388 rule: some-event (type: tracepoint, domain: ust)
390 snapshot session \`ze-session\`, path: /some/other/path
395 condition: event rule hit
396 rule: some-event (type: tracepoint, domain: ust)
398 snapshot session \`ze-session\`, url: net://1.2.3.4
403 condition: event rule hit
404 rule: some-event (type: tracepoint, domain: ust)
406 snapshot session \`ze-session\`, url: net://1.2.3.4:1234:1235
411 condition: event rule hit
412 rule: some-event (type: tracepoint, domain: ust)
414 snapshot session \`ze-session\`, control url: tcp://1.2.3.4:1111, data url: tcp://1.2.3.4:1112
419 condition: event rule hit
420 rule: some-event (type: tracepoint, domain: ust)
422 snapshot session \`ze-session\`, path: /some/path, max size: 1234
427 condition: event rule hit
428 rule: some-event (type: tracepoint, domain: ust)
430 snapshot session \`ze-session\`, path: /some/path, name: meh
435 condition: event rule hit
436 rule: some-event (type: tracepoint, domain: ust)
438 snapshot session \`ze-session\`, rate policy: after every 10 occurrences
443 condition: event rule hit
444 rule: some-event (type: tracepoint, domain: ust)
446 snapshot session \`ze-session\`, rate policy: once after 10 occurrences
451 list_triggers_matches_ok
"snapshot action" "${tmp_expected_stdout}"
453 lttng_remove_trigger_ok
"T0"
454 lttng_remove_trigger_ok
"T1"
455 lttng_remove_trigger_ok
"T2"
456 lttng_remove_trigger_ok
"T3"
457 lttng_remove_trigger_ok
"T4"
458 lttng_remove_trigger_ok
"T5"
459 lttng_remove_trigger_ok
"T6"
460 lttng_remove_trigger_ok
"T7"
461 lttng_remove_trigger_ok
"T8"
462 lttng_remove_trigger_ok
"T9"
465 test_notify_action
()
467 lttng_add_trigger_ok
"T0" --condition event-rule-matches
--domain=user
--name=some-event
--action notify
--rate-policy=once-after
:5
468 lttng_add_trigger_ok
"T1" --condition event-rule-matches
--domain=user
--name=some-event
--action notify
--rate-policy=every
:10
470 cat > "${tmp_expected_stdout}" <<- EOF
473 condition: event rule hit
474 rule: some-event (type: tracepoint, domain: ust)
476 notify, rate policy: once after 5 occurrences
481 condition: event rule hit
482 rule: some-event (type: tracepoint, domain: ust)
484 notify, rate policy: after every 10 occurrences
489 list_triggers_matches_ok
"snapshot action" "${tmp_expected_stdout}"
491 lttng_remove_trigger_ok
"T0"
492 lttng_remove_trigger_ok
"T1"
495 plan_tests
$NUM_TESTS
497 # shellcheck disable=SC2119
498 start_lttng_sessiond_notap
500 test_top_level_options
501 test_on_event_tracepoint
502 skip
$ist_root "non-root user: skipping kprobe tests" 9 || test_on_event_probe
503 skip
$ist_root "non-root user: skipping userspace probe elf tests" 5 || test_on_event_userspace_probe_elf
504 skip $
(($ist_root && $hast_sdt_binary)) "skipping userspace probe SDT tests" 5 || test_on_event_userspace_probe_sdt
505 skip
$ist_root "non-root user: skipping syscall tests" 7 || test_on_event_syscall
509 stop_lttng_sessiond_notap
512 rm -f "${tmp_stdout}"
513 rm -f "${tmp_stderr}"
514 rm -f "${tmp_expected_stdout}"