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 add-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 # shellcheck disable=SC2119
31 start_lttng_sessiond_notap
33 tmp_stdout
=$
(mktemp
--tmpdir -t test_parse_cli_trigger_stdout.XXXXXX
)
34 tmp_stderr
=$
(mktemp
--tmpdir -t test_parse_cli_trigger_stderr.XXXXXX
)
35 uprobe_elf_binary
="${TESTDIR}/utils/testapp/userspace-probe-elf-binary/.libs/userspace-probe-elf-binary"
37 if [ "$(id -u)" == "0" ]; then
43 function test_success
()
48 diag
"${FULL_LTTNG_BIN} add-trigger $*"
50 "${FULL_LTTNG_BIN}" add-trigger "$@" > "${tmp_stdout}" 2> "${tmp_stderr}"
52 ok $?
"${test_name}: exit code is 0"
54 diff -u "${tmp_stdout}" <(echo "Trigger registered successfully.")
55 ok $?
"${test_name}: expected stdout"
57 diff -u "${tmp_stderr}" /dev
/null
58 ok $?
"${test_name}: expected stderr"
61 function test_failure
()
68 diag
"${FULL_LTTNG_BIN} add-trigger $*"
69 "${FULL_LTTNG_BIN}" add-trigger "$@" > "${tmp_stdout}" 2> "${tmp_stderr}"
70 isnt $?
0 "${test_name}: exit code is not 0"
72 diff -u "${tmp_stdout}" /dev
/null
73 ok $?
"${test_name}: expected stdout"
75 diff -u "${tmp_stderr}" <(echo "${error_msg}")
76 ok $?
"${test_name}: expected stderr"
80 test_success
"explicit name" \
82 --condition event-rule-matches
--name=some-event-id
--domain=user \
85 # `--condition event-rule-matches` successes
86 test_success
"--condition event-rule-matches some-event --domain=user" \
87 --condition event-rule-matches
--name=some-event
--domain=user \
90 test_success
"--condition event-rule-matches --domain=user" \
91 --condition event-rule-matches
--domain=user \
94 test_success
"notify action polices" \
95 --condition event-rule-matches
--domain=user
--name=test-rate-policy \
97 --rate-policy=every
:55 \
99 --rate-policy=once-after
:55
101 test_success
"start session action polices" \
102 --condition event-rule-matches
--domain=user
--name=test-rate-policy \
103 --action start-session my_session \
104 --rate-policy=every
:55 \
105 --action start-session my_session \
106 --rate-policy=once-after
:55
108 test_success
"stop session action polices" \
109 --condition event-rule-matches
--domain=user
--name=test-rate-policy \
110 --action stop-session my_session \
111 --rate-policy=every
:55 \
112 --action stop-session my_session \
113 --rate-policy=once-after
:55
115 test_success
"snapshot session action polices" \
116 --condition event-rule-matches
--domain=user
--name=test-rate-policy \
117 --action snapshot-session my_session \
118 --rate-policy=every
:55 \
119 --action snapshot-session my_session \
120 --rate-policy=once-after
:55
122 test_success
"rotate session action polices" \
123 --condition event-rule-matches
--domain=user
--name=test-rate-policy \
124 --action rotate-session my_session \
125 --rate-policy=every
:55 \
126 --action rotate-session my_session \
127 --rate-policy=once-after
:55
129 test_success
"--log-level single level" \
130 --condition event-rule-matches
--domain=user
--log-level=INFO \
133 test_success
"--log-level range open max" \
134 --condition event-rule-matches
--domain=user
--log-level=INFO.. \
137 test_success
"--log-level range any" \
138 --condition event-rule-matches
--domain=user
--log-level=.. \
141 test_success
"--exclude-name one" \
142 --condition event-rule-matches
--domain=user
--name='bernard*' --exclude-name=bernard-lermite \
145 test_success
"--exclude-name two" \
146 --condition event-rule-matches
--domain=user
--name='jean-*' --exclude-name jean-chretien
-x jean-charest \
149 skip
$ist_root "non-root user: skipping kprobe tests" 18 ||
{
150 for type in kprobe kernel-probe
; do
151 test_success
"--condition event-rule-matches probe by symbol" \
152 --condition event-rule-matches
--domain=kernel
--type=$type --location=lttng_channel_enable
--event-name=my_channel_enable \
155 channel_enable_addr
=$
(grep ' t lttng_channel_enable\s\[lttng_tracer\]$' /proc
/kallsyms | cut
-f 1 -d ' ')
156 channel_disable_addr
=$
(grep ' t lttng_channel_disable\s\[lttng_tracer\]$' /proc
/kallsyms | cut
-f 1 -d ' ')
158 # We need to find a valid offset.
161 if [[ 0x
$channel_enable_addr -lt 0x
$channel_disable_addr ]]; then
162 base_symbol
="lttng_channel_enable"
163 offset
=$
(( 0x
$channel_disable_addr - 0x
$channel_enable_addr ))
165 base_symbol
="lttng_channel_disable"
166 offset
=$
(( 0x
$channel_enable_addr - 0x
$channel_disable_addr ))
169 offset_hex
="0x$(printf '%x' $offset)"
171 test_success
"--condition event-rule-matches probe by symbol with offset" \
172 --condition event-rule-matches
--domain=kernel
--type=$type --location="${base_symbol}+${offset_hex}" --event-name=my_
$base_symbol \
175 test_success
"--condition event-rule-matches probe by address" \
176 --condition event-rule-matches
--domain=kernel
--type=$type --location="0x${channel_enable_addr}" --event-name=my_channel_enable \
181 skip
$ist_root "non-root user: skipping uprobe tests" 12 ||
{
182 for type in uprobe userspace-probe
; do
183 test_success
"--condition event-rule-matches uprobe" \
184 --condition event-rule-matches
--domain=kernel
--type=$type --location=${uprobe_elf_binary}:test_function
--event-name=ma-probe \
187 test_success
"--condition event-rule-matches uprobe with elf prefix" \
188 --condition event-rule-matches
--domain=kernel
--type=$type --location=elf
:${uprobe_elf_binary}:test_function
--event-name=ma-probe-2 \
193 skip
$ist_root "non-root user: skipping syscall tests" 30 ||
{
194 test_success
"--condition event-rule-matches one syscall" \
195 --condition event-rule-matches
--domain=kernel
--type=syscall
--name=open \
198 test_success
"--condition event-rule-matches all syscalls" \
199 --condition event-rule-matches
--domain=kernel
--type=syscall \
202 test_success
"--condition event-rule-matches one syscall with filter" \
203 --condition event-rule-matches
--domain=kernel
--type=syscall
--filter 'a > 2' --name=open \
205 test_success
"--condition event-rule-matches one syscall:entry" \
206 --condition event-rule-matches
--domain=kernel
--type=syscall
:entry
--name=open \
208 test_success
"--condition event-rule-matches one syscall:exit" \
209 --condition event-rule-matches
--domain=kernel
--type=syscall
:exit --name=open \
211 test_success
"--condition event-rule-matches one syscall:entry-exit" \
212 --condition event-rule-matches
--domain=kernel
--type=syscall
:entry
+exit --name=open \
215 # Same thing but with "kernel:syscall" type instead:
216 test_success
"--condition event-rule-matches one syscall" \
217 --condition event-rule-matches
--domain=kernel
--type=kernel
:syscall
--name=open \
220 test_success
"--condition event-rule-matches one kernel:syscall:entry" \
221 --condition event-rule-matches
--domain=kernel
--type=kernel
:syscall
:entry
--name=open \
223 test_success
"--condition event-rule-matches one kernel:syscall:exit" \
224 --condition event-rule-matches
--domain=kernel
--type=kernel
:syscall
:exit --name=open \
226 test_success
"--condition event-rule-matches one kernel:syscall:entry-exit" \
227 --condition event-rule-matches
--domain=kernel
--type=kernel
:syscall
:entry
+exit --name=open \
232 # `--action notify` successes
233 test_success
"--action notify" \
234 --condition event-rule-matches
--domain=user \
237 test_success
"--action notify --capture foo" \
238 --condition event-rule-matches
--domain=user \
239 --capture foo
--action notify
241 test_success
"--action notify --capture foo[2]" \
242 --condition event-rule-matches
--domain=user \
243 --capture 'foo[2]' --action notify
245 test_success
'--action notify --capture $ctx.foo' \
246 --condition event-rule-matches
--domain=user \
247 --capture '$ctx.foo' --action notify
249 test_success
'--action notify --capture $ctx.foo[2]' \
250 --condition event-rule-matches
--domain=user \
251 --capture '$ctx.foo[2]' --action notify
253 test_success
'--action notify --capture $app.prov:type' \
254 --condition event-rule-matches
--domain=user \
255 --capture '$app.prov:type' --action notify
257 test_success
'--action notify --capture $app.prov:type[2]' \
258 --condition event-rule-matches
--domain=user \
259 --capture '$app.prov:type[2]' --action notify
261 test_success
'--action notify multiple captures' \
262 --condition event-rule-matches
--domain=user \
263 --capture foo
--capture '$app.hello:world' --action notify
265 # `--action start-session` successes
266 test_success
"--action start-session" \
267 --condition event-rule-matches
--domain=user \
268 --action start-session ze-session
270 # `--action stop-session` successes
271 test_success
"--action stop-session foo" \
272 --condition event-rule-matches
--domain=user \
273 --action stop-session ze-session
275 # `--action rotate-session` successes
276 test_success
"--action rotate-session foo" \
277 --condition event-rule-matches
--domain=user \
278 --action rotate-session ze-session
280 # `--action snapshot-session` successes
281 test_success
"--action snapshot-session foo" \
282 --condition event-rule-matches
--domain=user \
283 --action snapshot-session ze-session
285 test_success
"--action snapshot-session with file URI" \
286 --condition event-rule-matches
--domain=user \
287 --action snapshot-session ze-session
--path /hello
289 test_success
"--action snapshot-session with net URI" \
290 --condition event-rule-matches
--domain=user \
291 --action snapshot-session ze-session
--url net
://1.2.3.4
293 test_success
"--action snapshot-session with ctrl/data URIs" \
294 --condition event-rule-matches
--domain=user \
295 --action snapshot-session ze-session
--ctrl-url=tcp
://1.2.3.4:1234 --data-url=tcp
://1.2.3.4:1235
298 test_failure
"no args" "Error: Missing --condition."
300 test_failure
"unknown option" \
301 "Error: Unknown option \`--hello\`" \
304 test_failure
"missing --action" \
305 "Error: Need at least one --action." \
306 --condition event-rule-matches
--domain=user
308 test_failure
"two --condition" \
309 "Error: A --condition was already given." \
310 --condition event-rule-matches
--name=aaa
--domain=user \
311 --condition event-rule-matches
--name=bbb
--domain=user \
314 test_failure
"missing argument to --name" \
315 "Error: While parsing argument #1 (\`--name\`): Missing required argument for option \`--name\`" \
318 for cmd
in rate-policy
=once-after rate-policy
=every
; do
319 test_failure
"missing argument to --${cmd}" \
320 "Error: Rate policy format is invalid." \
321 --condition event-rule-matches
--domain=user
--action notify \
324 test_failure
"invalid argument to --${cmd}: non-digit character" \
325 "Error: Failed to parse rate policy value \`123bob\` as an integer." \
326 --condition event-rule-matches
--domain=user
--action notify \
329 test_failure
"invalid argument to --${cmd}: empty string" \
330 "Error: Failed to parse rate policy value \`\` as an integer." \
331 --condition event-rule-matches
--domain=user
--action notify \
335 test_failure
"invalid argument to --rate-policy: unknown policy type" \
336 "Error: Rate policy type \`bob\` unknown." \
337 --condition event-rule-matches
--domain=user
--action notify \
338 --rate-policy=bob
:123
340 # `--condition` failures
341 test_failure
"missing args after --condition" \
342 "Error: While parsing argument #1 (\`--condition\`): Missing required argument for option \`--condition\`" \
344 test_failure
"unknown --condition" \
345 "Error: Unknown condition name 'zoofest'" \
348 # `--condition event-rule-matches` failures
349 test_failure
"missing args after --condition event-rule-matches" \
350 "Error: Please specify a domain (--domain=(kernel,user,jul,log4j,python))." \
351 --condition event-rule-matches
353 test_failure
"extra args after --condition event-rule-matches" \
354 "Error: Unexpected argument 'bozo'" \
355 --condition event-rule-matches
--domain=user bozo
357 test_failure
"--log-level unknown level" \
358 "Error: Failed to parse log level string \`FOO\`." \
359 --condition event-rule-matches
--domain=user
--log-level=FOO
361 test_failure
"two same --domain" \
362 "Error: More than one \`--domain\` was specified." \
363 --condition event-rule-matches
--domain=user
--domain=user
365 test_failure
"two different --domain" \
366 "Error: More than one \`--domain\` was specified." \
367 --condition event-rule-matches
--domain=user
--domain=kernel
369 for type in kprobe kernel-probe
; do
370 test_failure
"--condition event-rule-matches: --name with --type=$type" \
371 "Error: Can't use --name with probe event rules." \
372 --condition event-rule-matches
--type=$type --location=do_sys_open
--name='hello'
375 test_failure
"--condition event-rule-matches: --location with tracepoint event rule" \
376 "Error: Can't use --location with tracepoint event rules." \
377 --condition event-rule-matches
--domain=user
--location='hello'
379 test_failure
"--condition event-rule-matches: --event-name with tracepoint event rule" \
380 "Error: Can't use --event-name with tracepoint event rules." \
381 --condition event-rule-matches
--domain=user
--event-name='hello'
383 for type in uprobe userspace-probe
; do
384 test_failure
"--condition event-rule-matches: extra argument with --type=$type" \
385 "Error: Unexpected argument 'hello'" \
386 --condition event-rule-matches
--domain=kernel
--type=$type --location=${uprobe_elf_binary}:test_failure hello
389 test_failure
"--condition event-rule-matches: extra argument with --type=syscall" \
390 "Error: Unexpected argument 'open'" \
391 --condition event-rule-matches
--domain=kernel
--type=syscall open
393 test_failure
"--condition event-rule-matches: --type=syscall:nope" \
394 "Error: Failed to parse syscall type 'syscall:nope'." \
395 --condition event-rule-matches
--domain=kernel
--type=syscall
:nope \
398 test_failure
"--exclude-name with non-glob name" \
399 "Error: Event jean: Exclusions can only be used with a globbing pattern" \
400 --condition event-rule-matches
--domain=user
--name='jean' --exclude-name jean-chretien \
403 test_failure
"--condition event-rule-matches --capture: missing argument (end of arg list)" \
404 'Error: While parsing argument #2 (`--capture`): Missing required argument for option `--capture`' \
406 --condition event-rule-matches
--domain=user
--capture
408 test_failure
"--condition event-rule-matches --capture: missing argument (before another option)" \
409 'Error: While parsing expression `--action`: Unary operators are not allowed in capture expressions.' \
410 --condition event-rule-matches
--domain=user
--capture \
413 test_failure
"--condition event-rule-matches --capture: binary operator" \
414 'Error: While parsing expression `foo == 2`: Binary operators are not allowed in capture expressions.' \
415 --condition event-rule-matches
--domain=user \
416 --capture 'foo == 2' --action notify
418 test_failure
"--condition event-rule-matches --capture: unary operator" \
419 'Error: While parsing expression `!foo`: Unary operators are not allowed in capture expressions.' \
420 --condition event-rule-matches
--domain=user \
421 --capture '!foo' --action notify
423 test_failure
"--condition event-rule-matches --capture: logical operator" \
424 'Error: While parsing expression `foo || bar`: Logical operators are not allowed in capture expressions.' \
425 --condition event-rule-matches
--domain=user \
426 --capture 'foo || bar' --action notify
428 test_failure
"--condition event-rule-matches --capture: accessing a sub-field" \
429 'Error: While parsing expression `foo.bar`: Capturing subfields is not supported.' \
430 --condition event-rule-matches
--domain=user \
431 --capture 'foo.bar' --action notify
433 test_failure
"--condition event-rule-matches --capture: accessing the sub-field of an array element" \
434 'Error: While parsing expression `foo[3].bar`: Capturing subfields is not supported.' \
435 --condition event-rule-matches
--domain=user \
436 --capture 'foo[3].bar' --action notify
438 test_failure
"--condition event-rule-matches --capture: missing colon in app-specific context field" \
439 'Error: Invalid app-specific context field name: missing colon in `foo`.' \
440 --condition event-rule-matches
--domain=user \
441 --capture '$app.foo' --action notify
443 test_failure
"--condition event-rule-matches --capture: missing colon in app-specific context field" \
444 'Error: Invalid app-specific context field name: missing type name after colon in `foo:`.' \
445 --condition event-rule-matches
--domain=user \
446 --capture '$app.foo:' --action notify
448 # `--action` failures
449 test_failure
"missing args after --action" \
450 "Error: While parsing argument #1 (\`--action\`): Missing required argument for option \`--action\`" \
451 --condition event-rule-matches
--domain=user \
454 # `--action notify` failures
455 test_failure
"extra arg after --action notify" \
456 "Error: Unexpected argument \`bob\`." \
457 --condition event-rule-matches
--domain=user \
460 # `--action start-session` failures
461 test_failure
"missing arg after --action start-session" \
462 "Error: Missing session name." \
463 --condition event-rule-matches
--domain=user \
464 --action start-session
465 test_failure
"extra arg after --action start-session" \
466 "Error: Unexpected argument \`bob\`." \
467 --condition event-rule-matches
--domain=user \
468 --action start-session ze-session bob
470 # `--action stop-session` failures
471 test_failure
"missing arg after --action stop-session" \
472 "Error: Missing session name." \
473 --condition event-rule-matches
--domain=user \
474 --action stop-session
475 test_failure
"extra arg after --action stop-session" \
476 "Error: Unexpected argument \`bob\`." \
477 --condition event-rule-matches
--domain=user \
478 --action stop-session ze-session bob
480 # `--action rotate-session` failures
481 test_failure
"missing arg after --action rotate-session" \
482 "Error: Missing session name." \
483 --condition event-rule-matches
--domain=user \
484 --action rotate-session
485 test_failure
"extra arg after --action rotate-session" \
486 "Error: Unexpected argument \`bob\`." \
487 --condition event-rule-matches
--domain=user \
488 --action rotate-session ze-session bob
490 # `--action snapshot-session` failures
491 test_failure
"missing arg after --action snapshot-session" \
492 "Error: Missing session name." \
493 --condition event-rule-matches
--domain=user \
494 --action snapshot-session
495 test_failure
"extra arg after --action snapshot-session" \
496 "Error: Unexpected argument \`bob\`." \
497 --condition event-rule-matches
--domain=user \
498 --action snapshot-session ze-session bob
499 test_failure
"snapshot-session action, --max-size without destination" \
500 "Error: Can't provide a snapshot output max size without a snapshot output destination." \
501 --condition event-rule-matches
--domain=user \
502 --action snapshot-session ze-session
--max-size 10M
503 test_failure
"snapshot-session action, --name without destination" \
504 "Error: Can't provide a snapshot output name without a snapshot output destination." \
505 --condition event-rule-matches
--domain=user \
506 --action snapshot-session ze-session
--name hallo
507 test_failure
"snapshot-session action, --name with-local-path-instead-of-url" \
508 "Error: Failed to parse '/something/that/looks/like/a/path' as an URL." \
509 --condition event-rule-matches
--domain=user \
510 --action snapshot-session ze-session
--name hallo
--url /something
/that
/looks
/like
/a
/path
511 test_failure
"snapshot-session action, --name with-net-url-instead-of-path" \
512 "Error: Failed to parse 'net://8.8.8.8/' as a local path." \
513 --condition event-rule-matches
--domain=user \
514 --action snapshot-session ze-session
--name hallo
--path net
://8.8.8.8/
517 stop_lttng_sessiond_notap
518 rm -f "${tmp_stdout}"
519 rm -f "${tmp_stderr}"