lttng list-triggers: handle all condition types
[lttng-tools.git] / tests / regression / tools / trigger / test_list_triggers_cli
1 #!/bin/bash
2 #
3 # Copyright (C) - 2020 EfficiOS, inc
4 #
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.
8 #
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
12 # details.
13 #
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
17
18 # Test the `lttng list-trigger` command line interface.
19
20 CURDIR="$(dirname "$0")"
21 TESTDIR="$CURDIR/../../.."
22
23 # shellcheck source=../../../utils/utils.sh
24 source "$TESTDIR/utils/utils.sh"
25
26 NUM_TESTS=100
27
28 FULL_LTTNG_BIN="${TESTDIR}/../src/bin/lttng/${LTTNG_BIN}"
29
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")
36
37 uid=$(id --user)
38 gid=$(id --group)
39
40 if [ "$uid" == "0" ]; then
41 ist_root=1
42 ls "$uprobe_sdt_binary" >/dev/null 2>&1
43 if test $? == 0; then
44 hast_sdt_binary=1
45 else
46 hast_sdt_binary=0
47 fi
48 else
49 ist_root=0
50 hast_sdt_binary=0
51 fi
52
53
54 function list_triggers_matches_ok ()
55 {
56 local test_name="$1"
57 local expected_stdout_file="$2"
58
59 "${FULL_LTTNG_BIN}" list-triggers > "${tmp_stdout}" 2> "${tmp_stderr}"
60 ok $? "${test_name}: exit code is 0"
61
62 diff -u "${expected_stdout_file}" "${tmp_stdout}"
63 ok $? "${test_name}: expected stdout"
64
65 diff -u /dev/null "${tmp_stderr}"
66 ok $? "${test_name}: expected stderr"
67 }
68
69 test_top_level_options ()
70 {
71 diag "Listing top level options"
72
73 lttng_add_trigger_ok "hello" --condition event-rule-matches --domain=user --name=test-name --action notify
74
75 cat > "${tmp_expected_stdout}" <<- EOF
76 - name: hello
77 owner uid: ${uid}
78 condition: event rule hit
79 rule: test-name (type: tracepoint, domain: ust)
80 actions:
81 notify
82 errors: none
83 errors: none
84 EOF
85
86 list_triggers_matches_ok "top level options" "${tmp_expected_stdout}"
87
88 lttng_remove_trigger_ok "hello"
89 }
90
91 test_on_event_tracepoint ()
92 {
93 diag "Listing on-event tracepoint"
94
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
105
106 cat > "${tmp_expected_stdout}" <<- EOF
107 - name: A
108 owner uid: ${uid}
109 condition: event rule hit
110 rule: aaa (type: tracepoint, domain: ust, filter: p == 2)
111 actions:
112 notify
113 errors: none
114 errors: none
115 - name: B
116 owner uid: ${uid}
117 condition: event rule hit
118 rule: gerboise (type: tracepoint, domain: ust, log level at least INFO)
119 actions:
120 notify
121 errors: none
122 errors: none
123 - name: C
124 owner uid: ${uid}
125 condition: event rule hit
126 rule: * (type: tracepoint, domain: ust)
127 actions:
128 notify
129 errors: none
130 errors: none
131 - name: D
132 owner uid: ${uid}
133 condition: event rule hit
134 rule: hello* (type: tracepoint, domain: ust, exclusions: hello2,hello3,hello4)
135 actions:
136 notify
137 errors: none
138 errors: none
139 - name: E
140 owner uid: ${uid}
141 condition: event rule hit
142 rule: lemming (type: tracepoint, domain: ust, log level is WARNING)
143 actions:
144 notify
145 errors: none
146 errors: none
147 - name: F
148 owner uid: ${uid}
149 condition: event rule hit
150 rule: capture-payload-field (type: tracepoint, domain: ust)
151 captures:
152 - a
153 actions:
154 notify
155 errors: none
156 errors: none
157 - name: G
158 owner uid: ${uid}
159 condition: event rule hit
160 rule: capture-array (type: tracepoint, domain: ust)
161 captures:
162 - a[2]
163 - \$ctx.tourlou[18]
164 actions:
165 notify
166 errors: none
167 errors: none
168 - name: H
169 owner uid: ${uid}
170 condition: event rule hit
171 rule: capture-chan-ctx (type: tracepoint, domain: ust)
172 captures:
173 - \$ctx.vpid
174 actions:
175 notify
176 errors: none
177 errors: none
178 - name: I
179 owner uid: ${uid}
180 condition: event rule hit
181 rule: capture-app-ctx (type: tracepoint, domain: ust)
182 captures:
183 - \$app.iga:active_clients
184 actions:
185 notify
186 errors: none
187 errors: none
188 - name: J
189 owner uid: ${uid}
190 condition: event rule hit
191 rule: lemming (type: tracepoint, domain: ust)
192 actions:
193 notify
194 errors: none
195 errors: none
196 EOF
197
198 list_triggers_matches_ok "event-rule-matches, tracepoint event rule" "${tmp_expected_stdout}"
199
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"
210 }
211
212 test_on_event_probe ()
213 {
214 local channel_enable_addr
215 local channel_disable_addr
216
217 diag "Listing on-event kernel probe"
218
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 ' ')
221
222 # We need to find a valid offset.
223 base_symbol=""
224 offset=0
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 ))
228 else
229 base_symbol="lttng_channel_disable"
230 offset=$(( 0x$channel_enable_addr - 0x$channel_disable_addr ))
231 fi
232
233 offset_hex="0x$(printf '%x' $offset)"
234
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
238
239 cat > "${tmp_expected_stdout}" <<- EOF
240 - name: T0
241 owner uid: ${uid}
242 condition: event rule hit
243 rule: my_channel_enable (type: probe, location: lttng_channel_enable)
244 actions:
245 notify
246 errors: none
247 errors: none
248 - name: T1
249 owner uid: ${uid}
250 condition: event rule hit
251 rule: my_channel_enable (type: probe, location: ${base_symbol}+${offset_hex})
252 actions:
253 notify
254 errors: none
255 errors: none
256 - name: T2
257 owner uid: ${uid}
258 condition: event rule hit
259 rule: my_channel_enable (type: probe, location: 0x${channel_enable_addr})
260 actions:
261 notify
262 errors: none
263 errors: none
264 EOF
265
266 list_triggers_matches_ok "event-rule-matches, probe event rule" "${tmp_expected_stdout}"
267
268 lttng_remove_trigger_ok "T0"
269 lttng_remove_trigger_ok "T1"
270 lttng_remove_trigger_ok "T2"
271 }
272
273 test_on_event_userspace_probe_elf ()
274 {
275 local elf_function_name="test_function"
276
277 diag "Listing on-event userspace-probe elf"
278
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
280
281 cat > "${tmp_expected_stdout}" <<- EOF
282 - name: T0
283 owner uid: ${uid}
284 condition: event rule hit
285 rule: ma-probe-elf (type: userspace probe, location type: ELF, location: ${uprobe_elf_binary}:${elf_function_name})
286 actions:
287 notify
288 errors: none
289 errors: none
290 EOF
291
292 list_triggers_matches_ok "event-rule-matches, userspace-probe event rule" "${tmp_expected_stdout}"
293
294 lttng_remove_trigger_ok "T0"
295 }
296
297 test_on_event_userspace_probe_sdt ()
298 {
299 local sdt_provider_name="foobar"
300 local sdt_probe_name="tp1"
301
302 diag "on-event userspace-probe sdt"
303
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
305
306 cat > "${tmp_expected_stdout}" <<- EOF
307 - id: T0
308 user id: 0
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})
311 actions:
312 notify
313 errors: none
314 errors: none
315 EOF
316
317 list_triggers_matches_ok "on-event, userspace-probe event rule SDT" "${tmp_expected_stdout}"
318
319 lttng_remove_trigger_ok "T0"
320 }
321
322 test_on_event_syscall ()
323 {
324 diag "Listing on-event syscall"
325
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
328
329 cat > "${tmp_expected_stdout}" <<- EOF
330 - name: T0
331 owner uid: ${uid}
332 condition: event rule hit
333 rule: open (type: syscall)
334 actions:
335 notify
336 errors: none
337 errors: none
338 - name: T1
339 owner uid: ${uid}
340 condition: event rule hit
341 rule: ptrace (type: syscall, filter: a > 2)
342 actions:
343 notify
344 errors: none
345 errors: none
346 EOF
347
348 list_triggers_matches_ok "event-rule-matches, syscall event rule" "${tmp_expected_stdout}"
349
350 lttng_remove_trigger_ok "T0"
351 lttng_remove_trigger_ok "T1"
352 }
353
354 test_session_consumed_size_condition ()
355 {
356 ${register_some_triggers_bin} test_session_consumed_size_condition
357
358 cat > "${tmp_expected_stdout}" <<- EOF
359 - name: trigger-with-session-consumed-size-condition
360 owner uid: ${uid}
361 condition: session consumed size
362 session name: the-session-name
363 threshold: 1234 bytes
364 actions:
365 notify
366 errors: none
367 errors: none
368 EOF
369
370 list_triggers_matches_ok "session consumed size condition" "${tmp_expected_stdout}"
371
372 lttng_remove_trigger_ok "trigger-with-session-consumed-size-condition"
373 }
374
375 test_buffer_usage_conditions ()
376 {
377 ${register_some_triggers_bin} test_buffer_usage_conditions
378
379 cat > "${tmp_expected_stdout}" <<- EOF
380 - name: trigger-with-buffer-usage-high-bytes-condition
381 owner uid: ${uid}
382 condition: buffer usage high
383 session name: the-session-name
384 channel name: the-channel-name
385 domain: ust
386 threshold (bytes): 1234
387 actions:
388 notify
389 errors: none
390 errors: none
391 - name: trigger-with-buffer-usage-high-ratio-condition
392 owner uid: ${uid}
393 condition: buffer usage high
394 session name: the-session-name
395 channel name: the-channel-name
396 domain: ust
397 threshold (ratio): 0.25
398 actions:
399 notify
400 errors: none
401 errors: none
402 - name: trigger-with-buffer-usage-low-bytes-condition
403 owner uid: ${uid}
404 condition: buffer usage low
405 session name: the-session-name
406 channel name: the-channel-name
407 domain: ust
408 threshold (bytes): 2345
409 actions:
410 notify
411 errors: none
412 errors: none
413 - name: trigger-with-buffer-usage-low-ratio-condition
414 owner uid: ${uid}
415 condition: buffer usage low
416 session name: the-session-name
417 channel name: the-channel-name
418 domain: ust
419 threshold (ratio): 0.40
420 actions:
421 notify
422 errors: none
423 errors: none
424 EOF
425
426 list_triggers_matches_ok "buffer usage condition" "${tmp_expected_stdout}"
427
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"
432 }
433
434 test_session_rotation_conditions ()
435 {
436 ${register_some_triggers_bin} test_session_rotation_conditions
437
438 cat > "${tmp_expected_stdout}" <<- EOF
439 - name: trigger-with-session-rotation-completed-condition
440 owner uid: ${uid}
441 condition: session rotation completed
442 session name: the-session-name
443 actions:
444 notify
445 errors: none
446 errors: none
447 - name: trigger-with-session-rotation-ongoing-condition
448 owner uid: ${uid}
449 condition: session rotation ongoing
450 session name: the-session-name
451 actions:
452 notify
453 errors: none
454 errors: none
455 EOF
456
457 list_triggers_matches_ok "session rotation conditions" "${tmp_expected_stdout}"
458
459 lttng_remove_trigger_ok "trigger-with-session-rotation-completed-condition"
460 lttng_remove_trigger_ok "trigger-with-session-rotation-ongoing-condition"
461 }
462
463 test_snapshot_action ()
464 {
465 diag "Listing snapshot actions"
466
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
477
478 cat > "${tmp_expected_stdout}" <<- EOF
479 - name: T0
480 owner uid: ${uid}
481 condition: event rule hit
482 rule: some-event (type: tracepoint, domain: ust)
483 actions:
484 snapshot session \`ze-session\`
485 errors: none
486 errors: none
487 - name: T1
488 owner uid: ${uid}
489 condition: event rule hit
490 rule: some-event (type: tracepoint, domain: ust)
491 actions:
492 snapshot session \`ze-session\`, path: /some/path
493 errors: none
494 errors: none
495 - name: T2
496 owner uid: ${uid}
497 condition: event rule hit
498 rule: some-event (type: tracepoint, domain: ust)
499 actions:
500 snapshot session \`ze-session\`, path: /some/other/path
501 errors: none
502 errors: none
503 - name: T3
504 owner uid: ${uid}
505 condition: event rule hit
506 rule: some-event (type: tracepoint, domain: ust)
507 actions:
508 snapshot session \`ze-session\`, url: net://1.2.3.4
509 errors: none
510 errors: none
511 - name: T4
512 owner uid: ${uid}
513 condition: event rule hit
514 rule: some-event (type: tracepoint, domain: ust)
515 actions:
516 snapshot session \`ze-session\`, url: net://1.2.3.4:1234:1235
517 errors: none
518 errors: none
519 - name: T5
520 owner uid: ${uid}
521 condition: event rule hit
522 rule: some-event (type: tracepoint, domain: ust)
523 actions:
524 snapshot session \`ze-session\`, control url: tcp://1.2.3.4:1111, data url: tcp://1.2.3.4:1112
525 errors: none
526 errors: none
527 - name: T6
528 owner uid: ${uid}
529 condition: event rule hit
530 rule: some-event (type: tracepoint, domain: ust)
531 actions:
532 snapshot session \`ze-session\`, path: /some/path, max size: 1234
533 errors: none
534 errors: none
535 - name: T7
536 owner uid: ${uid}
537 condition: event rule hit
538 rule: some-event (type: tracepoint, domain: ust)
539 actions:
540 snapshot session \`ze-session\`, path: /some/path, name: meh
541 errors: none
542 errors: none
543 - name: T8
544 owner uid: ${uid}
545 condition: event rule hit
546 rule: some-event (type: tracepoint, domain: ust)
547 actions:
548 snapshot session \`ze-session\`, rate policy: after every 10 occurrences
549 errors: none
550 errors: none
551 - name: T9
552 owner uid: ${uid}
553 condition: event rule hit
554 rule: some-event (type: tracepoint, domain: ust)
555 actions:
556 snapshot session \`ze-session\`, rate policy: once after 10 occurrences
557 errors: none
558 errors: none
559 EOF
560
561 list_triggers_matches_ok "snapshot action" "${tmp_expected_stdout}"
562
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"
573 }
574
575 test_notify_action ()
576 {
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
579
580 cat > "${tmp_expected_stdout}" <<- EOF
581 - name: T0
582 owner uid: ${uid}
583 condition: event rule hit
584 rule: some-event (type: tracepoint, domain: ust)
585 actions:
586 notify, rate policy: once after 5 occurrences
587 errors: none
588 errors: none
589 - name: T1
590 owner uid: ${uid}
591 condition: event rule hit
592 rule: some-event (type: tracepoint, domain: ust)
593 actions:
594 notify, rate policy: after every 10 occurrences
595 errors: none
596 errors: none
597 EOF
598
599 list_triggers_matches_ok "notify action" "${tmp_expected_stdout}"
600
601 lttng_remove_trigger_ok "T0"
602 lttng_remove_trigger_ok "T1"
603 }
604
605 plan_tests $NUM_TESTS
606
607 # shellcheck disable=SC2119
608 start_lttng_sessiond_notap
609
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
619 test_snapshot_action
620 test_notify_action
621
622 stop_lttng_sessiond_notap
623
624 # Cleanup
625 rm -f "${tmp_stdout}"
626 rm -f "${tmp_stderr}"
627 rm -f "${tmp_expected_stdout}"
This page took 0.04211 seconds and 4 git commands to generate.