tests/utils/utils.sh

   1 # Copyright (C) 2012 David Goulet <dgoulet@efficios.com>
   2 #
   3 # SPDX-License-Identifier: LGPL-2.1-only
   4 #
   5
   6 SESSIOND_BIN="lttng-sessiond"
   7 SESSIOND_MATCH=".*lttng-sess.*"
   8 RUNAS_BIN="lttng-runas"
   9 RUNAS_MATCH=".*lttng-runas.*"
  10 CONSUMERD_BIN="lttng-consumerd"
  11 CONSUMERD_MATCH=".*lttng-consumerd.*"
  12 RELAYD_BIN="lttng-relayd"
  13 RELAYD_MATCH=".*lttng-relayd.*"
  14 LTTNG_BIN="lttng"
  15 BABELTRACE_BIN="babeltrace2"
  16 OUTPUT_DEST=/dev/null
  17 ERROR_OUTPUT_DEST=/dev/null
  18 MI_XSD_MAJOR_VERSION=4
  19 MI_XSD_MINOR_VERSION=1
  20 MI_XSD_PATH="$TESTDIR/../src/common/mi-lttng-${MI_XSD_MAJOR_VERSION}.${MI_XSD_MINOR_VERSION}.xsd"
  21 MI_VALIDATE="$TESTDIR/utils/xml-utils/validate_xml ${MI_XSD_PATH}"
  22
  23 XML_PRETTY="$TESTDIR/utils/xml-utils/pretty_xml"
  24 XML_EXTRACT="$TESTDIR/utils/xml-utils/extract_xml"
  25 XML_NODE_CHECK="${XML_EXTRACT} -e"
  26
  27 # To match 20201127-175802
  28 date_time_pattern="[0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9]-[0-9][0-9][0-9][0-9][0-9][0-9]"
  29 # The size of a long on this system
  30 system_long_bit_size=$(getconf LONG_BIT)
  31
  32 # Minimal kernel version supported for session daemon tests
  33 KERNEL_MAJOR_VERSION=2
  34 KERNEL_MINOR_VERSION=6
  35 KERNEL_PATCHLEVEL_VERSION=27
  36
  37 # We set the default UST register timeout and network and app socket timeout to
  38 # "wait forever", so that basic tests don't have to worry about hitting
  39 # timeouts on busy systems. Specialized tests should test those corner-cases.
  40 export LTTNG_UST_REGISTER_TIMEOUT=-1
  41 export LTTNG_NETWORK_SOCKET_TIMEOUT=-1
  42 export LTTNG_APP_SOCKET_TIMEOUT=-1
  43
  44 # We set the default lttng-sessiond path to /bin/true to prevent the spawning
  45 # of a daemonized sessiond. This is necessary since 'lttng create' will spawn
  46 # its own sessiond if none is running. It also ensures that 'lttng create'
  47 # fails when no sessiond is running.
  48 export LTTNG_SESSIOND_PATH="/bin/true"
  49
  50 source $TESTDIR/utils/tap/tap.sh
  51
  52 if [ -z ${LTTNG_TEST_TEARDOWN_TIMEOUT+x} ]; then
  53         LTTNG_TEST_TEARDOWN_TIMEOUT=60
  54 fi
  55
  56 # Enable job monitor mode.
  57 # Here we are mostly interested in the following from the monitor mode:
  58 #    All processes run in a separate process group.
  59 # This allows us to ensure that all subprocesses from all background tasks are
  60 # cleaned up correctly using signal to process group id.
  61 set -m
  62
  63 kill_background_jobs ()
  64 {
  65         local pids
  66         pids=$(jobs -p)
  67
  68         if [ -z "$pids" ]; then
  69                 # Empty
  70                 return 0
  71         fi
  72
  73         while read -r pid;
  74         do
  75                 # Use negative number to send the signal to the process group.
  76                 # This ensure that any subprocesses receive the signal.
  77                 # /dev/null is used since there is an acceptable race between
  78                 # the moments the pids are listed and the moment we send a
  79                 # signal.
  80                 kill -SIGTERM -- "-$pid" 2>/dev/null
  81         done <<< "$pids"
  82 }
  83
  84 function cleanup ()
  85 {
  86         # Try to kill daemons gracefully
  87         stop_lttng_relayd_cleanup SIGTERM $LTTNG_TEST_TEARDOWN_TIMEOUT
  88         stop_lttng_sessiond_cleanup SIGTERM $LTTNG_TEST_TEARDOWN_TIMEOUT
  89
  90         # If daemons are still present, forcibly kill them
  91         stop_lttng_relayd_cleanup SIGKILL $LTTNG_TEST_TEARDOWN_TIMEOUT
  92         stop_lttng_sessiond_cleanup SIGKILL $LTTNG_TEST_TEARDOWN_TIMEOUT
  93         stop_lttng_consumerd_cleanup SIGKILL $LTTNG_TEST_TEARDOWN_TIMEOUT
  94
  95         kill_background_jobs
  96 }
  97
  98 function full_cleanup ()
  99 {
 100         cleanup
 101         exit 1
 102 }
 103
 104 function LTTNG_BAIL_OUT ()
 105 {
 106         cleanup
 107         BAIL_OUT "$@"
 108 }
 109
 110 function null_pipes ()
 111 {
 112         exec 0>/dev/null
 113         exec 1>/dev/null
 114         exec 2>/dev/null
 115 }
 116
 117 trap full_cleanup SIGINT SIGTERM
 118
 119 # perl prove closes its child pipes before giving it a chance to run its
 120 # signal trap handlers. Redirect pipes to /dev/null if SIGPIPE is caught
 121 # to allow those trap handlers to proceed.
 122
 123 trap null_pipes SIGPIPE
 124
 125 # Check pgrep from env, default to pgrep if none
 126 if [ -z "$PGREP" ]; then
 127         PGREP=pgrep
 128 fi
 129
 130 # Due to the renaming of threads we need to use the full command (pgrep -f) to
 131 # identify the pids for multiple lttng related processes. The problem with "pgrep
 132 # -f" is that it ends up also looking at the arguments. We use a two stage
 133 # lookup. The first one is using "pgrep -f" yielding potential candidate.
 134 # The second on perform grep on the basename of the first field of the
 135 # /proc/pid/cmdline of the previously identified pids. The first field
 136 # correspond to the actual command.
 137 function lttng_pgrep ()
 138 {
 139         local pattern=$1
 140         local possible_pids
 141         local full_command_no_argument
 142         local command_basename
 143
 144         possible_pids=$($PGREP -f "$pattern")
 145         if [ -z "$possible_pids" ]; then
 146                 return 0
 147         fi
 148
 149         while IFS= read -r pid ; do
 150                 # /proc/pid/cmdline is null separated.
 151                 if full_command_no_argument=$(cut -d '' -f 1 2>/dev/null < /proc/"$pid"/cmdline); then
 152                         command_basename=$(basename "$full_command_no_argument")
 153                         if grep -q "$pattern" <<< "$command_basename"; then
 154                                 echo "$pid"
 155                         fi
 156                 fi
 157         done <<< "$possible_pids"
 158         return 0
 159 }
 160
 161 function print_ok ()
 162 {
 163         # Check if we are a terminal
 164         if [ -t 1 ]; then
 165                 echo -e "\e[1;32mOK\e[0m"
 166         else
 167                 echo -e "OK"
 168         fi
 169 }
 170
 171 function print_fail ()
 172 {
 173         # Check if we are a terminal
 174         if [ -t 1 ]; then
 175                 echo -e "\e[1;31mFAIL\e[0m"
 176         else
 177                 echo -e "FAIL"
 178         fi
 179 }
 180
 181 function print_test_banner ()
 182 {
 183         local desc="$1"
 184         diag "$desc"
 185 }
 186
 187 function validate_kernel_version ()
 188 {
 189         local kern_version=($(uname -r | awk -F. '{ printf("%d.%d.%d\n",$1,$2,$3); }' | tr '.' '\n'))
 190         if [ ${kern_version[0]} -gt $KERNEL_MAJOR_VERSION ]; then
 191                 return 0
 192         fi
 193         if [ ${kern_version[1]} -gt $KERNEL_MINOR_VERSION ]; then
 194                 return 0
 195         fi
 196         if [ ${kern_version[2]} -ge $KERNEL_PATCHLEVEL_VERSION ]; then
 197                 return 0
 198         fi
 199         return 1
 200 }
 201
 202 # Generate a random string
 203 #  $1 = number of characters; defaults to 16
 204 #  $2 = include special characters; 1 = yes, 0 = no; defaults to yes
 205 function randstring()
 206 {
 207         [ "$2" == "0" ] && CHAR="[:alnum:]" || CHAR="[:graph:]"
 208         cat /dev/urandom 2>/dev/null | tr -cd "$CHAR" 2>/dev/null | head -c ${1:-16} 2>/dev/null
 209         echo
 210 }
 211
 212 # Return the number of _configured_ CPUs.
 213 function conf_proc_count()
 214 {
 215         getconf _NPROCESSORS_CONF
 216         if [ $? -ne 0 ]; then
 217                 diag "Failed to get the number of configured CPUs"
 218         fi
 219         echo
 220 }
 221
 222 # Check if base lttng-modules are present.
 223 # Bail out on failure
 224 function validate_lttng_modules_present ()
 225 {
 226         # Check for loadable modules.
 227         modprobe -n lttng-tracer 2>/dev/null
 228         if [ $? -eq 0 ]; then
 229                 return 0
 230         fi
 231
 232         # Check for builtin modules.
 233         ls /proc/lttng > /dev/null 2>&1
 234         if [ $? -eq 0 ]; then
 235                 return 0
 236         fi
 237
 238         LTTNG_BAIL_OUT "LTTng modules not detected."
 239 }
 240
 241 # Run the lttng binary.
 242 #
 243 # The first two arguments are stdout and stderr redirect paths, respectively.
 244 # The rest of the arguments are forwarded to the lttng binary
 245 function _run_lttng_cmd
 246 {
 247         local stdout_dest="$1"
 248         local stderr_dest="$2"
 249         shift 2
 250
 251         diag "$TESTDIR/../src/bin/lttng/$LTTNG_BIN $*"
 252         $TESTDIR/../src/bin/lttng/$LTTNG_BIN "$@" 1> "$stdout_dest" 2> "$stderr_dest"
 253 }
 254
 255 function enable_kernel_lttng_event
 256 {
 257         local withtap="$1"
 258         local expected_to_fail="$2"
 259         local sess_name="$3"
 260         local event_name="$4"
 261         local channel_name="$5"
 262
 263         if [ -z "$event_name" ]; then
 264                 # Enable all event if no event name specified
 265                 event_name="-a"
 266         fi
 267
 268         if [ -z "$channel_name" ]; then
 269                 # default channel if none specified
 270                 chan=""
 271         else
 272                 chan="-c $channel_name"
 273         fi
 274
 275         _run_lttng_cmd "$OUTPUT_DEST" "$ERROR_OUTPUT_DEST" \
 276                 enable-event "$event_name" $chan -s $sess_name -k
 277         ret=$?
 278         if [[ $expected_to_fail -eq "1" ]]; then
 279                 test $ret -ne "0"
 280                 ret=$?
 281                 if [ $withtap -eq "1" ]; then
 282                         ok $ret "Enable kernel event $event_name for session $session_name on channel $channel_name failed as expected"
 283                 fi
 284         else
 285                 if [ $withtap -eq "1" ]; then
 286                         ok $ret "Enable kernel event $event_name for session $sess_name"
 287                 fi
 288         fi
 289 }
 290
 291 function enable_kernel_lttng_event_ok ()
 292 {
 293         enable_kernel_lttng_event 1 0 "$@"
 294 }
 295
 296 function enable_kernel_lttng_event_fail ()
 297 {
 298         enable_kernel_lttng_event 1 1 "$@"
 299 }
 300
 301 function enable_kernel_lttng_event_notap ()
 302 {
 303         enable_kernel_lttng_event 0 0 "$@"
 304 }
 305
 306 # Old interface
 307 function lttng_enable_kernel_event
 308 {
 309         enable_kernel_lttng_event_ok "$@"
 310 }
 311
 312 function lttng_enable_kernel_syscall()
 313 {
 314         local expected_to_fail=$1
 315         local sess_name=$2
 316         local syscall_name=$3
 317         local channel_name=$4
 318
 319         if [ -z $syscall_name ]; then
 320                 # Enable all event if no syscall name specified
 321                 syscall_name="-a"
 322         fi
 323
 324         if [ -z $channel_name ]; then
 325                 # default channel if none specified
 326                 chan=""
 327         else
 328                 chan="-c $channel_name"
 329         fi
 330
 331         _run_lttng_cmd "$OUTPUT_DEST" "$ERROR_OUTPUT_DEST" \
 332                 enable-event --syscall "$syscall_name" $chan -s $sess_name -k
 333         ret=$?
 334         if [[ $expected_to_fail -eq "1" ]]; then
 335                 test $ret -ne "0"
 336                 ok $? "Enable kernel syscall $syscall_name for session $sess_name on channel $channel_name fail as expected"
 337         else
 338                 ok $ret "Enable kernel syscall $syscall_name for session $sess_name on channel $channel_name"
 339         fi
 340 }
 341
 342 function lttng_enable_kernel_syscall_ok()
 343 {
 344         lttng_enable_kernel_syscall 0 "$@"
 345 }
 346
 347 function lttng_enable_kernel_syscall_fail()
 348 {
 349         lttng_enable_kernel_syscall 1 "$@"
 350 }
 351
 352 function lttng_disable_kernel_syscall()
 353 {
 354         local expected_to_fail=$1
 355         local sess_name=$2
 356         local syscall_name=$3
 357         local channel_name=$4
 358
 359         if [ -z $syscall_name ]; then
 360                 # Enable all event if no syscall name specified
 361                 syscall_name="-a"
 362         fi
 363
 364         if [ -z $channel_name ]; then
 365                 # default channel if none specified
 366                 chan=""
 367         else
 368                 chan="-c $channel_name"
 369         fi
 370
 371         _run_lttng_cmd "$OUTPUT_DEST" "$ERROR_OUTPUT_DEST" \
 372                 disable-event --syscall "$syscall_name" $chan -s $sess_name -k
 373
 374         ret=$?
 375         if [[ $expected_to_fail -eq "1" ]]; then
 376                 test $ret -ne "0"
 377                 ok $? "Disable kernel syscall $syscall_name for session $sess_name on channel $channel_name failed as expected"
 378         else
 379                 ok $ret "Disable kernel syscall $syscall_name for session $sess_name on channel $channel_name"
 380         fi
 381 }
 382
 383 function lttng_disable_kernel_syscall_ok()
 384 {
 385         lttng_disable_kernel_syscall 0 "$@"
 386 }
 387
 388 function lttng_disable_kernel_syscall_fail()
 389 {
 390         lttng_disable_kernel_syscall 1 "$@"
 391 }
 392
 393 function lttng_enable_kernel_function_event ()
 394 {
 395         local expected_to_fail="$1"
 396         local sess_name="$2"
 397         local target="$3"
 398         local event_name="$4"
 399
 400         "$TESTDIR/../src/bin/lttng/$LTTNG_BIN" enable-event --kernel --function="$target" "$event_name" -s "$sess_name" > "$OUTPUT_DEST" 2> "$ERROR_OUTPUT_DEST"
 401         ret=$?
 402         if [[ $expected_to_fail -eq "1" ]]; then
 403                 test $ret -ne "0"
 404                 ok $? "Enable kernel function event for session $sess_name failed as expected"
 405         else
 406                 ok $ret "Enable kernel function event for session $sess_name"
 407         fi
 408 }
 409
 410 function lttng_enable_kernel_function_event_ok ()
 411 {
 412         lttng_enable_kernel_function_event 0 "$@"
 413 }
 414
 415 function lttng_enable_kernel_userspace_probe_event ()
 416 {
 417         local expected_to_fail="$1"
 418         local sess_name="$2"
 419         local target="$3"
 420         local event_name="$4"
 421
 422         "$TESTDIR/../src/bin/lttng/$LTTNG_BIN" enable-event --kernel --userspace-probe="$target" "$event_name" -s "$sess_name" > "$OUTPUT_DEST" 2> "$ERROR_OUTPUT_DEST"
 423         ret=$?
 424         if [[ $expected_to_fail -eq "1" ]]; then
 425                 test $ret -ne "0"
 426                 ok $? "Enable kernel userspace probe event for session $sess_name failed as expected"
 427         else
 428                 ok $ret "Enable kernel userspace probe event for session $sess_name"
 429         fi
 430 }
 431
 432 function lttng_enable_kernel_userspace_probe_event_fail ()
 433 {
 434         lttng_enable_kernel_userspace_probe_event 1 "$@"
 435 }
 436
 437 function lttng_enable_kernel_userspace_probe_event_ok ()
 438 {
 439         lttng_enable_kernel_userspace_probe_event 0 "$@"
 440 }
 441
 442 function disable_kernel_lttng_userspace_probe_event_ok ()
 443 {
 444         local sess_name="$1"
 445         local event_name="$2"
 446
 447         "$TESTDIR/../src/bin/lttng/$LTTNG_BIN" disable-event --kernel "$event_name" -s "$sess_name" > "$OUTPUT_DEST" 2> "$ERROR_OUTPUT_DEST"
 448         ok $? "Disable kernel event $target for session $sess_name"
 449 }
 450 function lttng_enable_kernel_channel()
 451 {
 452         local withtap=$1
 453         local expected_to_fail=$2
 454         local sess_name=$3
 455         local channel_name=$4
 456         local opts="${@:5}"
 457
 458         _run_lttng_cmd "$OUTPUT_DEST" "$ERROR_OUTPUT_DEST" \
 459                 enable-channel -k $channel_name -s $sess_name $opts
 460         ret=$?
 461         if [[ $expected_to_fail -eq "1" ]]; then
 462                 test "$ret" -ne "0"
 463                 ret=$?
 464                 if [ $withtap -eq "1" ]; then
 465                         ok $ret "Enable channel $channel_name for session $sess_name failed as expected"
 466                 fi
 467         else
 468                 if [ $withtap -eq "1" ]; then
 469                         ok $ret "Enable channel $channel_name for session $sess_name"
 470                 fi
 471         fi
 472 }
 473
 474 function lttng_enable_kernel_channel_ok()
 475 {
 476         lttng_enable_kernel_channel 1 0 "$@"
 477 }
 478
 479 function lttng_enable_kernel_channel_fail()
 480 {
 481         lttng_enable_kernel_channel 1 1 "$@"
 482 }
 483
 484 function lttng_enable_kernel_channel_notap()
 485 {
 486         lttng_enable_kernel_channel 0 0 "$@"
 487 }
 488
 489 function enable_kernel_lttng_channel_ok()
 490 {
 491         lttng_enable_kernel_channel 1 0 "$@"
 492 }
 493
 494 function lttng_disable_kernel_channel()
 495 {
 496         local expected_to_fail=$1
 497         local sess_name=$2
 498         local channel_name=$3
 499
 500         _run_lttng_cmd "$OUTPUT_DEST" "$ERROR_OUTPUT_DEST" \
 501                 disable-channel -k $channel_name -s $sess_name
 502         ret=$?
 503         if [[ $expected_to_fail -eq "1" ]]; then
 504                 test "$ret" -ne "0"
 505                 ok $? "Disable channel $channel_name for session $sess_name failed as expected"
 506         else
 507                 ok $ret "Disable channel $channel_name for session $sess_name"
 508         fi
 509 }
 510
 511 function lttng_disable_kernel_channel_ok()
 512 {
 513         lttng_disable_kernel_channel 0 "$@"
 514 }
 515
 516 function lttng_disable_kernel_channel_fail()
 517 {
 518         lttng_disable_kernel_channel 1 "$@"
 519 }
 520
 521 function start_lttng_relayd_opt()
 522 {
 523         local withtap=$1
 524         local process_mode=$2
 525         local opt=$3
 526
 527         DIR=$(readlink -f "$TESTDIR")
 528
 529         if [ -z $(lttng_pgrep "$RELAYD_MATCH") ]; then
 530                 # shellcheck disable=SC2086
 531                 $DIR/../src/bin/lttng-relayd/$RELAYD_BIN $process_mode $opt 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
 532                 #$DIR/../src/bin/lttng-relayd/$RELAYD_BIN $opt -vvv >>/tmp/relayd.log 2>&1 &
 533                 if [ $? -eq 1 ]; then
 534                         if [ $withtap -eq "1" ]; then
 535                                 fail "Start lttng-relayd (process mode: $process_mode opt: $opt)"
 536                         fi
 537                         return 1
 538                 else
 539                         if [ $withtap -eq "1" ]; then
 540                                 pass "Start lttng-relayd (process mode: $process_mode opt: $opt)"
 541                         fi
 542                 fi
 543         else
 544                 pass "Start lttng-relayd (opt: $opt)"
 545         fi
 546 }
 547
 548 function start_lttng_relayd()
 549 {
 550         start_lttng_relayd_opt 1 "-b" "$@"
 551 }
 552
 553 function start_lttng_relayd_notap()
 554 {
 555         start_lttng_relayd_opt 0 "-b" "$@"
 556 }
 557
 558 function stop_lttng_relayd_opt()
 559 {
 560         local withtap=$1
 561         local is_cleanup=$2
 562         local signal=$3
 563         local timeout_s=$4
 564         local dtimeleft_s=
 565         local retval=0
 566         local pids
 567
 568         if [ -z "$signal" ]; then
 569                 signal="SIGTERM"
 570         fi
 571
 572
 573         # Multiply time by 2 to simplify integer arithmetic
 574         if [ -n "$timeout_s" ]; then
 575                 dtimeleft_s=$((timeout_s * 2))
 576         fi
 577
 578
 579         pids=$(lttng_pgrep "$RELAYD_MATCH")
 580         if [ -z "$pids" ]; then
 581                 if [ "$is_cleanup" -eq 1 ]; then
 582                         :
 583                 elif [ "$withtap" -eq "1" ]; then
 584                         fail "No relay daemon to kill"
 585                 else
 586                         LTTNG_BAIL_OUT "No relay daemon to kill"
 587                 fi
 588                 return 0
 589         fi
 590
 591         diag "Killing (signal $signal) lttng-relayd (pid: $pids)"
 592
 593         # shellcheck disable=SC2086
 594         if ! kill -s $signal $pids 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST; then
 595                 retval=1
 596                 if [ "$withtap" -eq "1" ]; then
 597                         fail "Kill relay daemon"
 598                 fi
 599         else
 600                 out=1
 601                 while [ -n "$out" ]; do
 602                         out=$(lttng_pgrep "$RELAYD_MATCH")
 603                         if [ -n "$dtimeleft_s" ]; then
 604                                 if [ $dtimeleft_s -lt 0 ]; then
 605                                         out=
 606                                         retval=1
 607                                 fi
 608                                 dtimeleft_s=$((dtimeleft_s - 1))
 609                         fi
 610                         sleep 0.5
 611                 done
 612                 if [ "$withtap" -eq "1" ]; then
 613                         if [ "$retval" -eq "0" ]; then
 614                                 pass "Wait after kill relay daemon"
 615                         else
 616                                 fail "Wait after kill relay daemon"
 617                         fi
 618                 fi
 619         fi
 620         return $retval
 621 }
 622
 623 function stop_lttng_relayd()
 624 {
 625         stop_lttng_relayd_opt 1 0 "$@"
 626 }
 627
 628 function stop_lttng_relayd_notap()
 629 {
 630         stop_lttng_relayd_opt 0 0 "$@"
 631 }
 632
 633 function stop_lttng_relayd_cleanup()
 634 {
 635         stop_lttng_relayd_opt 0 1 "$@"
 636 }
 637
 638 #First arg: show tap output
 639 #Second argument: load path for automatic loading
 640 function start_lttng_sessiond_opt()
 641 {
 642         local withtap=$1
 643         local load_path=$2
 644
 645         # The rest of the arguments will be passed directly to lttng-sessiond.
 646         shift 2
 647
 648         local env_vars=""
 649         local consumerd=""
 650
 651         local long_bit_value=
 652         long_bit_value=$(getconf LONG_BIT)
 653
 654         if [ -n "$TEST_NO_SESSIOND" ] && [ "$TEST_NO_SESSIOND" == "1" ]; then
 655                 # Env variable requested no session daemon
 656                 return
 657         fi
 658
 659         DIR=$(readlink -f "$TESTDIR")
 660
 661         # Get long_bit value for 32/64 consumerd
 662         case "$long_bit_value" in
 663                 32)
 664                         consumerd="--consumerd32-path=$DIR/../src/bin/lttng-consumerd/lttng-consumerd"
 665                         ;;
 666                 64)
 667                         consumerd="--consumerd64-path=$DIR/../src/bin/lttng-consumerd/lttng-consumerd"
 668                         ;;
 669                 *)
 670                         return
 671                         ;;
 672         esac
 673
 674         # Check for env. variable. Allow the use of LD_PRELOAD etc.
 675         if [[ "x${LTTNG_SESSIOND_ENV_VARS}" != "x" ]]; then
 676                 env_vars="${LTTNG_SESSIOND_ENV_VARS} "
 677         fi
 678         env_vars="${env_vars}$DIR/../src/bin/lttng-sessiond/$SESSIOND_BIN"
 679
 680         if ! validate_kernel_version; then
 681             fail "Start session daemon"
 682             LTTNG_BAIL_OUT "*** Kernel too old for session daemon tests ***"
 683         fi
 684
 685         diag "export LTTNG_SESSION_CONFIG_XSD_PATH=${DIR}/../src/common/"
 686         : "${LTTNG_SESSION_CONFIG_XSD_PATH="${DIR}/../src/common/"}"
 687         export LTTNG_SESSION_CONFIG_XSD_PATH
 688
 689         if [ -z "$(lttng_pgrep "${SESSIOND_MATCH}")" ]; then
 690                 # Have a load path ?
 691                 if [ -n "$load_path" ]; then
 692                         diag "env $env_vars --load $load_path --background $consumerd $@"
 693                         # shellcheck disable=SC2086
 694                         env $env_vars --load "$load_path" --background "$consumerd" "$@"
 695                 else
 696                         diag "env $env_vars --background $consumerd $@"
 697                         # shellcheck disable=SC2086
 698                         env $env_vars --background "$consumerd" "$@"
 699                 fi
 700                 #$DIR/../src/bin/lttng-sessiond/$SESSIOND_BIN --background --consumerd32-path="$DIR/../src/bin/lttng-consumerd/lttng-consumerd" --consumerd64-path="$DIR/../src/bin/lttng-consumerd/lttng-consumerd" --verbose-consumer >>/tmp/sessiond.log 2>&1
 701                 status=$?
 702                 if [ "$withtap" -eq "1" ]; then
 703                         ok $status "Start session daemon"
 704                 fi
 705         fi
 706 }
 707
 708 function start_lttng_sessiond()
 709 {
 710         start_lttng_sessiond_opt 1 "$@"
 711 }
 712
 713 function start_lttng_sessiond_notap()
 714 {
 715         start_lttng_sessiond_opt 0 "$@"
 716 }
 717
 718 function stop_lttng_sessiond_opt()
 719 {
 720         local withtap=$1
 721         local is_cleanup=$2
 722         local signal=$3
 723         local timeout_s=$4
 724         local dtimeleft_s=
 725         local retval=0
 726         local runas_pids
 727         local pids
 728
 729         if [ -z "$signal" ]; then
 730                 signal=SIGTERM
 731         fi
 732
 733         # Multiply time by 2 to simplify integer arithmetic
 734         if [ -n "$timeout_s" ]; then
 735                 dtimeleft_s=$((timeout_s * 2))
 736         fi
 737
 738         if [ -n "$TEST_NO_SESSIOND" ] && [ "$TEST_NO_SESSIOND" == "1" ]; then
 739                 # Env variable requested no session daemon
 740                 return 0
 741         fi
 742
 743         runas_pids=$(lttng_pgrep "$RUNAS_MATCH")
 744         pids=$(lttng_pgrep "$SESSIOND_MATCH")
 745
 746         if [ -n "$runas_pids" ]; then
 747                 pids="$pids $runas_pids"
 748         fi
 749
 750         if [ -z "$pids" ]; then
 751                 if [ "$is_cleanup" -eq 1 ]; then
 752                         :
 753                 elif [ "$withtap" -eq "1" ]; then
 754                         fail "No session daemon to kill"
 755                 else
 756                         LTTNG_BAIL_OUT "No session daemon to kill"
 757                 fi
 758                 return 0
 759         fi
 760
 761         diag "Killing (signal $signal) $SESSIOND_BIN and lt-$SESSIOND_BIN pids: $(echo "$pids" | tr '\n' ' ')"
 762
 763         # shellcheck disable=SC2086
 764         if ! kill -s $signal $pids 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST; then
 765                 retval=1
 766                 if [ "$withtap" -eq "1" ]; then
 767                         fail "Kill sessions daemon"
 768                 fi
 769         else
 770                 out=1
 771                 while [ -n "$out" ]; do
 772                         out=$(lttng_pgrep "${SESSIOND_MATCH}")
 773                         if [ -n "$dtimeleft_s" ]; then
 774                                 if [ $dtimeleft_s -lt 0 ]; then
 775                                         out=
 776                                         retval=1
 777                                 fi
 778                                 dtimeleft_s=$((dtimeleft_s - 1))
 779                         fi
 780                         sleep 0.5
 781                 done
 782                 out=1
 783                 while [ -n "$out" ]; do
 784                         out=$(lttng_pgrep "$CONSUMERD_MATCH")
 785                         if [ -n "$dtimeleft_s" ]; then
 786                                 if [ $dtimeleft_s -lt 0 ]; then
 787                                         out=
 788                                         retval=1
 789                                 fi
 790                                 dtimeleft_s=$((dtimeleft_s - 1))
 791                         fi
 792                         sleep 0.5
 793                 done
 794
 795                 if [ "$withtap" -eq "1" ]; then
 796                         if [ "$retval" -eq "0" ]; then
 797                                 pass "Wait after kill session daemon"
 798                         else
 799                                 fail "Wait after kill session daemon"
 800                         fi
 801                 fi
 802         fi
 803         if [ "$signal" = "SIGKILL" ]; then
 804                 if [ "$(id -u)" -eq "0" ]; then
 805                         local modules=
 806                         modules="$(lsmod | grep ^lttng | awk '{print $1}')"
 807
 808                         if [ -n "$modules" ]; then
 809                                 diag "Unloading all LTTng modules"
 810                                 modprobe --remove "$modules"
 811                         fi
 812                 fi
 813         fi
 814
 815         return $retval
 816 }
 817
 818 function stop_lttng_sessiond()
 819 {
 820         stop_lttng_sessiond_opt 1 0 "$@"
 821 }
 822
 823 function stop_lttng_sessiond_notap()
 824 {
 825         stop_lttng_sessiond_opt 0 0 "$@"
 826 }
 827
 828 function stop_lttng_sessiond_cleanup()
 829 {
 830         stop_lttng_sessiond_opt 0 1 "$@"
 831 }
 832
 833 function sigstop_lttng_sessiond_opt()
 834 {
 835         local withtap=$1
 836         local signal=SIGSTOP
 837         local pids
 838
 839         if [ -n "$TEST_NO_SESSIOND" ] && [ "$TEST_NO_SESSIOND" == "1" ]; then
 840                 # Env variable requested no session daemon
 841                 return
 842         fi
 843
 844         pids="$(lttng_pgrep "${SESSIOND_MATCH}") $(lttng_pgrep "$RUNAS_MATCH")"
 845
 846         if [ "$withtap" -eq "1" ]; then
 847                 diag "Sending SIGSTOP to lt-$SESSIOND_BIN and $SESSIOND_BIN pids: $(echo "$pids" | tr '\n' ' ')"
 848         fi
 849
 850         # shellcheck disable=SC2086
 851         if ! kill -s $signal $pids 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST; then
 852                 if [ "$withtap" -eq "1" ]; then
 853                         fail "Sending SIGSTOP to session daemon"
 854                 fi
 855         else
 856                 out=1
 857                 while [ $out -ne 0 ]; do
 858                         pids="$(lttng_pgrep "$SESSIOND_MATCH")"
 859
 860                         # Wait until state becomes stopped for session
 861                         # daemon(s).
 862                         out=0
 863                         for sessiond_pid in $pids; do
 864                                 state="$(ps -p "$sessiond_pid" -o state= )"
 865                                 if [[ -n "$state" && "$state" != "T" ]]; then
 866                                         out=1
 867                                 fi
 868                         done
 869                         sleep 0.5
 870                 done
 871                 if [ "$withtap" -eq "1" ]; then
 872                         pass "Sending SIGSTOP to session daemon"
 873                 fi
 874         fi
 875 }
 876
 877 function sigstop_lttng_sessiond()
 878 {
 879         sigstop_lttng_sessiond_opt 1 "$@"
 880 }
 881
 882 function sigstop_lttng_sessiond_notap()
 883 {
 884         sigstop_lttng_sessiond_opt 0 "$@"
 885 }
 886
 887 function stop_lttng_consumerd_opt()
 888 {
 889         local withtap=$1
 890         local is_cleanup=$2
 891         local signal=$3
 892         local timeout_s=$4
 893         local dtimeleft_s=
 894         local retval=0
 895         local pids
 896
 897         if [ -z "$signal" ]; then
 898                 signal=SIGTERM
 899         fi
 900
 901         # Multiply time by 2 to simplify integer arithmetic
 902         if [ -n "$timeout_s" ]; then
 903                 dtimeleft_s=$((timeout_s * 2))
 904         fi
 905
 906         pids="$(lttng_pgrep "$CONSUMERD_MATCH")"
 907
 908         if [ -z "$pids" ]; then
 909                 if [ "$is_cleanup" -eq 1 ]; then
 910                         :
 911                 elif [ "$withtap" -eq "1" ]; then
 912                         fail "No consumerd daemon to kill"
 913                 else
 914                         LTTNG_BAIL_OUT "No consumerd daemon to kill"
 915                 fi
 916                 return 0
 917         fi
 918
 919         diag "Killing (signal $signal) $CONSUMERD_BIN pids: $(echo "$pids" | tr '\n' ' ')"
 920
 921         # shellcheck disable=SC2086
 922         if ! kill -s $signal $pids 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST; then
 923                 retval=1
 924                 if [ "$withtap" -eq "1" ]; then
 925                         fail "Kill consumer daemon"
 926                 fi
 927         else
 928                 out=1
 929                 while [ $out -ne 0 ]; do
 930                         pids="$(lttng_pgrep "$CONSUMERD_MATCH")"
 931
 932                         # If consumerds are still present check their status.
 933                         # A zombie status qualifies the consumerd as *killed*
 934                         out=0
 935                         for consumer_pid in $pids; do
 936                                 state="$(ps -p "$consumer_pid" -o state= )"
 937                                 if [[ -n "$state" && "$state" != "Z" ]]; then
 938                                         out=1
 939                                 fi
 940                         done
 941                         if [ -n "$dtimeleft_s" ]; then
 942                                 if [ $dtimeleft_s -lt 0 ]; then
 943                                         out=0
 944                                         retval=1
 945                                 fi
 946                                 dtimeleft_s=$((dtimeleft_s - 1))
 947                         fi
 948                         sleep 0.5
 949                 done
 950                 if [ "$withtap" -eq "1" ]; then
 951                         if [ "$retval" -eq "0" ]; then
 952                                 pass "Wait after kill consumer daemon"
 953                         else
 954                                 fail "Wait after kill consumer daemon"
 955                         fi
 956                 fi
 957         fi
 958
 959         return $retval
 960 }
 961
 962 function stop_lttng_consumerd()
 963 {
 964         stop_lttng_consumerd_opt 1 0 "$@"
 965 }
 966
 967 function stop_lttng_consumerd_notap()
 968 {
 969         stop_lttng_consumerd_opt 0 0 "$@"
 970 }
 971
 972 function stop_lttng_consumerd_cleanup()
 973 {
 974         stop_lttng_consumerd_opt 0 1 "$@"
 975 }
 976
 977 function sigstop_lttng_consumerd_opt()
 978 {
 979         local withtap=$1
 980         local signal=SIGSTOP
 981         local pids
 982
 983         pids="$(lttng_pgrep "$CONSUMERD_MATCH")"
 984
 985         diag "Sending SIGSTOP to $CONSUMERD_BIN pids: $(echo "$pids" | tr '\n' ' ')"
 986
 987         # shellcheck disable=SC2086
 988         kill -s $signal $pids 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
 989         retval=$?
 990
 991         if [ $retval -eq 1 ]; then
 992                 if [ "$withtap" -eq "1" ]; then
 993                         fail "Sending SIGSTOP to consumer daemon"
 994                 fi
 995                 return 1
 996         else
 997                 out=1
 998                 while [ $out -ne 0 ]; do
 999                         pids="$(lttng_pgrep "$CONSUMERD_MATCH")"
1000
1001                         # Wait until state becomes stopped for all
1002                         # consumers.
1003                         out=0
1004                         for consumer_pid in $pids; do
1005                                 state="$(ps -p "$consumer_pid" -o state= )"
1006                                 if [[ -n "$state" && "$state" != "T" ]]; then
1007                                         out=1
1008                                 fi
1009                         done
1010                         sleep 0.5
1011                 done
1012                 if [ "$withtap" -eq "1" ]; then
1013                         pass "Sending SIGSTOP to consumer daemon"
1014                 fi
1015         fi
1016         return $retval
1017 }
1018
1019 function sigstop_lttng_consumerd()
1020 {
1021         sigstop_lttng_consumerd_opt 1 "$@"
1022 }
1023
1024 function sigstop_lttng_consumerd_notap()
1025 {
1026         sigstop_lttng_consumerd_opt 0 "$@"
1027 }
1028
1029 function list_lttng_with_opts ()
1030 {
1031         local ret
1032         local withtap=$1
1033         shift
1034         local opts=$1
1035         _run_lttng_cmd "$OUTPUT_DEST" "$ERROR_OUTPUT_DEST" \
1036                 list $opts
1037         ret=$?
1038         if [ $withtap -eq "1" ]; then
1039                 ok $ret "Lttng-tool list command with option $opts"
1040         fi
1041 }
1042
1043 function list_lttng_ok ()
1044 {
1045         list_lttng_with_opts 1 "$@"
1046 }
1047
1048 function list_lttng_notap ()
1049 {
1050         list_lttng_with_opts 0 "$@"
1051 }
1052
1053 function create_lttng_session_no_output ()
1054 {
1055         local sess_name=$1
1056         local opts="${@:2}"
1057
1058         _run_lttng_cmd "$OUTPUT_DEST" "$ERROR_OUTPUT_DEST" \
1059                 create $sess_name --no-output $opts
1060         ok $? "Create session $sess_name in no-output mode"
1061 }
1062
1063 function create_lttng_session_uri () {
1064         local sess_name=$1
1065         local uri=$2
1066         local opts="${@:3}"
1067
1068         _run_lttng_cmd "$OUTPUT_DEST" "$ERROR_OUTPUT_DEST" \
1069                 create $sess_name -U $uri $opts
1070         ok $? "Create session $sess_name with uri:$uri and opts: $opts"
1071 }
1072
1073 function create_lttng_session ()
1074 {
1075         local withtap=$1
1076         local expected_to_fail=$2
1077         local sess_name=$3
1078         local trace_path=$4
1079         local opt=$5
1080
1081         if [ -z "$trace_path" ]; then
1082                 # Use lttng-sessiond default output.
1083                 trace_path=""
1084         else
1085                 trace_path="-o $trace_path"
1086         fi
1087
1088         _run_lttng_cmd "$OUTPUT_DEST" "$ERROR_OUTPUT_DEST" \
1089                 create "$sess_name" $trace_path $opt
1090         ret=$?
1091         if [ $expected_to_fail -eq "1" ]; then
1092                 test "$ret" -ne "0"
1093                 ret=$?
1094                 if [ $withtap -eq "1" ]; then
1095                         ok $ret "Create session $sess_name in $trace_path failed as expected"
1096                 fi
1097         else
1098                 if [ $withtap -eq "1" ]; then
1099                         ok $ret "Create session $sess_name in $trace_path"
1100                 fi
1101         fi
1102         return $ret
1103 }
1104
1105 function create_lttng_session_ok ()
1106 {
1107         create_lttng_session 1 0 "$@"
1108 }
1109
1110 function create_lttng_session_fail ()
1111 {
1112         create_lttng_session 1 1 "$@"
1113 }
1114
1115 function create_lttng_session_notap ()
1116 {
1117         create_lttng_session 0 0 "$@"
1118 }
1119
1120
1121 function enable_ust_lttng_channel ()
1122 {
1123         local withtap=$1
1124         local expected_to_fail=$2
1125         local sess_name=$3
1126         local channel_name=$4
1127         local opts="${@:5}"
1128
1129         _run_lttng_cmd "$OUTPUT_DEST" "$ERROR_OUTPUT_DEST" \
1130                 enable-channel -u $channel_name -s $sess_name $opts
1131         ret=$?
1132         if [[ $expected_to_fail -eq "1" ]]; then
1133                 test "$ret" -ne "0"
1134                 ret=$?
1135                 if [ $withtap -eq "1" ]; then
1136                         ok $ret "Enable channel $channel_name for session $sess_name failed as expected"
1137                 fi
1138         else
1139                 if [ $withtap -eq "1" ]; then
1140                         ok $ret "Enable channel $channel_name for session $sess_name"
1141                 fi
1142         fi
1143         return $ret
1144 }
1145
1146 function enable_ust_lttng_channel_ok ()
1147 {
1148         enable_ust_lttng_channel 1 0 "$@"
1149 }
1150
1151 function enable_ust_lttng_channel_fail ()
1152 {
1153         enable_ust_lttng_channel 1 1 "$@"
1154 }
1155
1156 function enable_ust_lttng_channel_notap ()
1157 {
1158         enable_ust_lttng_channel 0 0 "$@"
1159 }
1160
1161 function disable_ust_lttng_channel()
1162 {
1163         local sess_name=$1
1164         local channel_name=$2
1165
1166         _run_lttng_cmd "$OUTPUT_DEST" "$ERROR_OUTPUT_DEST" \
1167                 disable-channel -u $channel_name -s $sess_name
1168         ok $? "Disable channel $channel_name for session $sess_name"
1169 }
1170
1171 function enable_lttng_mmap_overwrite_kernel_channel()
1172 {
1173         local sess_name=$1
1174         local channel_name=$2
1175
1176         _run_lttng_cmd "$OUTPUT_DEST" "$ERROR_OUTPUT_DEST" \
1177                 enable-channel -s $sess_name $channel_name -k --output mmap --overwrite
1178         ok $? "Enable channel $channel_name for session $sess_name"
1179 }
1180
1181 function enable_lttng_mmap_discard_small_kernel_channel()
1182 {
1183         local sess_name=$1
1184         local channel_name=$2
1185
1186         _run_lttng_cmd "$OUTPUT_DEST" "$ERROR_OUTPUT_DEST" \
1187                 enable-channel -s $sess_name $channel_name -k --output mmap --discard --subbuf-size=$(getconf PAGE_SIZE) --num-subbuf=2
1188         ok $? "Enable small discard channel $channel_name for session $sess_name"
1189 }
1190
1191 function enable_lttng_mmap_overwrite_small_kernel_channel()
1192 {
1193         local sess_name=$1
1194         local channel_name=$2
1195
1196         _run_lttng_cmd "$OUTPUT_DEST" "$ERROR_OUTPUT_DEST" \
1197                 enable-channel -s $sess_name $channel_name -k --output mmap --overwrite --subbuf-size=$(getconf PAGE_SIZE) --num-subbuf=2
1198         ok $? "Enable small discard channel $channel_name for session $sess_name"
1199 }
1200
1201 function enable_lttng_mmap_overwrite_ust_channel()
1202 {
1203         local sess_name=$1
1204         local channel_name=$2
1205
1206         _run_lttng_cmd "$OUTPUT_DEST" "$ERROR_OUTPUT_DEST" \
1207                 enable-channel -s $sess_name $channel_name -u --output mmap --overwrite
1208         ok $? "Enable channel $channel_name for session $sess_name"
1209 }
1210
1211 function enable_ust_lttng_event ()
1212 {
1213         local withtap=$1
1214         local expected_to_fail=$2
1215         local sess_name=$3
1216         local event_name="$4"
1217         local channel_name=$5
1218
1219         if [ -z $channel_name ]; then
1220                 # default channel if none specified
1221                 chan=""
1222         else
1223                 chan="-c $channel_name"
1224         fi
1225
1226         _run_lttng_cmd "$OUTPUT_DEST" "$ERROR_OUTPUT_DEST" \
1227                 enable-event "$event_name" $chan -s "$sess_name" -u
1228         ret=$?
1229         if [[ $expected_to_fail -eq "1" ]]; then
1230                 test $ret -ne "0"
1231                 ret=$?
1232                 if [[ $withtap -eq "1" ]]; then
1233                         ok $ret "Enable ust event $event_name for session $session_name failed as expected"
1234                 fi
1235         else
1236                 if [[ $withtap -eq "1" ]]; then
1237                         ok $ret "Enable ust event $event_name for session $sess_name"
1238                 fi
1239         fi
1240         return $ret
1241 }
1242
1243 function enable_ust_lttng_event_ok ()
1244 {
1245         enable_ust_lttng_event 1 0 "$@"
1246 }
1247
1248 function enable_ust_lttng_event_fail ()
1249 {
1250         enable_ust_lttng_event 1 1 "$@"
1251 }
1252
1253 function enable_ust_lttng_event_notap ()
1254 {
1255         enable_ust_lttng_event 0 0 "$@"
1256 }
1257
1258 function enable_jul_lttng_event()
1259 {
1260         sess_name=$1
1261         event_name="$2"
1262         channel_name=$3
1263
1264         if [ -z $channel_name ]; then
1265                 # default channel if none specified
1266                 chan=""
1267         else
1268                 chan="-c $channel_name"
1269         fi
1270
1271         _run_lttng_cmd "$OUTPUT_DEST" "$ERROR_OUTPUT_DEST" \
1272                 enable-event "$event_name" $chan -s $sess_name -j
1273         ok $? "Enable JUL event $event_name for session $sess_name"
1274 }
1275
1276 function enable_jul_lttng_event_loglevel()
1277 {
1278         local sess_name=$1
1279         local event_name="$2"
1280         local loglevel=$3
1281         local channel_name=$4
1282
1283         if [ -z $channel_name ]; then
1284                 # default channel if none specified
1285                 chan=""
1286         else
1287                 chan="-c $channel_name"
1288         fi
1289
1290         _run_lttng_cmd "$OUTPUT_DEST" "$ERROR_OUTPUT_DEST" \
1291                 enable-event --loglevel $loglevel "$event_name" $chan -s $sess_name -j
1292         ok $? "Enable JUL event $event_name for session $sess_name with loglevel $loglevel"
1293 }
1294
1295 function enable_log4j_lttng_event()
1296 {
1297         local sess_name=$1
1298         local event_name=$2
1299         local channel_name=$3
1300
1301         local chan_opt=()
1302
1303         # default channel if none specified
1304         if [ -n "$channel_name" ]; then
1305                 chan_opt=("-c" "$channel_name")
1306         fi
1307
1308         _run_lttng_cmd "$OUTPUT_DEST" "$ERROR_OUTPUT_DEST" \
1309                 enable-event "$event_name" "${chan_opt[@]}" -s "$sess_name" --log4j
1310         ok $? "Enable LOG4J event '$event_name' for session '$sess_name'"
1311 }
1312
1313 function enable_log4j_lttng_event_filter()
1314 {
1315         local sess_name=$1
1316         local event_name=$2
1317         local filter=$3
1318
1319         _run_lttng_cmd "$OUTPUT_DEST" "$ERROR_OUTPUT_DEST" \
1320                 enable-event "$event_name" -s "$sess_name" --log4j --filter "$filter"
1321         ok $? "Enable LOG4J event '$event_name' with filter '$filter' for session '$sess_name'"
1322 }
1323
1324 function enable_log4j_lttng_event_filter_loglevel_only()
1325 {
1326         local sess_name=$1
1327         local event_name=$2
1328         local filter=$3
1329         local loglevel=$4
1330
1331         _run_lttng_cmd "$OUTPUT_DEST" "$ERROR_OUTPUT_DEST" \
1332                 enable-event --loglevel-only "$loglevel" "$event_name" -s "$sess_name" -l --filter "$filter"
1333         ok $? "Enable LOG4J event '$event_name' with filter '$filter' and loglevel-only '$loglevel' for session '$sess_name'"
1334 }
1335
1336 function enable_log4j_lttng_event_loglevel()
1337 {
1338         local sess_name=$1
1339         local event_name=$2
1340         local loglevel=$3
1341         local channel_name=$4
1342
1343
1344         # default channel if none specified
1345         if [ -n "$channel_name" ]; then
1346                 chan_opt=("-c" "$channel_name")
1347         fi
1348
1349         _run_lttng_cmd "$OUTPUT_DEST" "$ERROR_OUTPUT_DEST" \
1350                 enable-event --loglevel "$loglevel" "$event_name" "${chan_opt[@]}" -s "$sess_name" --log4j
1351         ok $? "Enable LOG4J event '$event_name' for session '$sess_name' with loglevel '$loglevel'"
1352 }
1353
1354 function enable_log4j_lttng_event_loglevel_only()
1355 {
1356         local sess_name=$1
1357         local event_name=$2
1358         local loglevel=$3
1359         local channel_name=$4
1360
1361         local chan_opt=()
1362
1363         # default channel if none specified
1364         if [ -n "$channel_name" ]; then
1365                 chan_opt=("-c" "$channel_name")
1366         fi
1367
1368         _run_lttng_cmd "$OUTPUT_DEST" "$ERROR_OUTPUT_DEST" \
1369                 enable-event --loglevel-only "$loglevel" "$event_name" "${chan_opt[@]}" -s "$sess_name" --log4j
1370         ok $? "Enable LOG4J event '$event_name' for session '$sess_name' with loglevel-only '$loglevel'"
1371 }
1372
1373 function enable_python_lttng_event()
1374 {
1375         sess_name=$1
1376         event_name="$2"
1377         channel_name=$3
1378
1379         if [ -z $channel_name ]; then
1380                 # default channel if none specified
1381                 chan=""
1382         else
1383                 chan="-c $channel_name"
1384         fi
1385
1386         _run_lttng_cmd "$OUTPUT_DEST" "$ERROR_OUTPUT_DEST" \
1387                 enable-event "$event_name" $chan -s $sess_name -p
1388         ok $? "Enable Python event $event_name for session $sess_name"
1389 }
1390
1391 function enable_python_lttng_event_loglevel()
1392 {
1393         local sess_name=$1
1394         local event_name="$2"
1395         local loglevel=$3
1396         local channel_name=$4
1397
1398         if [ -z $channel_name ]; then
1399                 # default channel if none specified
1400                 chan=""
1401         else
1402                 chan="-c $channel_name"
1403         fi
1404
1405         _run_lttng_cmd "$OUTPUT_DEST" "$ERROR_OUTPUT_DEST" \
1406                 enable-event --loglevel $loglevel "$event_name" $chan -s $sess_name -p
1407         ok $? "Enable Python event $event_name for session $sess_name with loglevel $loglevel"
1408 }
1409
1410 function enable_ust_lttng_event_filter()
1411 {
1412         local sess_name="$1"
1413         local event_name="$2"
1414         local filter="$3"
1415         local channel_name=$4
1416
1417         if [ -z $channel_name ]; then
1418                 # default channel if none specified
1419                 chan=""
1420         else
1421                 chan="-c $channel_name"
1422         fi
1423
1424         _run_lttng_cmd "$OUTPUT_DEST" "$ERROR_OUTPUT_DEST" \
1425                 enable-event $chan "$event_name" -s $sess_name -u --filter "$filter"
1426         ok $? "Enable event $event_name with filtering for session $sess_name"
1427 }
1428
1429 function enable_ust_lttng_event_loglevel()
1430 {
1431         local sess_name="$1"
1432         local event_name="$2"
1433         local loglevel="$3"
1434
1435         _run_lttng_cmd "$OUTPUT_DEST" "$ERROR_OUTPUT_DEST" \
1436                 enable-event "$event_name" -s $sess_name -u --loglevel $loglevel
1437         ok $? "Enable event $event_name with loglevel $loglevel"
1438 }
1439
1440 function enable_ust_lttng_event_loglevel_only()
1441 {
1442         local sess_name="$1"
1443         local event_name="$2"
1444         local loglevel="$3"
1445
1446         _run_lttng_cmd "$OUTPUT_DEST" "$ERROR_OUTPUT_DEST" \
1447                 enable-event "$event_name" -s $sess_name -u --loglevel-only $loglevel
1448         ok $? "Enable event $event_name with loglevel-only $loglevel"
1449 }
1450
1451 function disable_ust_lttng_event ()
1452 {
1453         local sess_name="$1"
1454         local event_name="$2"
1455         local channel_name="$3"
1456
1457         if [ -z $channel_name ]; then
1458                 # default channel if none specified
1459                 chan=""
1460         else
1461                 chan="-c $channel_name"
1462         fi
1463
1464         _run_lttng_cmd "$OUTPUT_DEST" "$ERROR_OUTPUT_DEST" \
1465                 disable-event "$event_name" -s $sess_name $chan -u
1466         ok $? "Disable event $event_name for session $sess_name"
1467 }
1468
1469 function disable_jul_lttng_event ()
1470 {
1471         local sess_name="$1"
1472         local event_name="$2"
1473
1474         $TESTDIR/../src/bin/lttng/$LTTNG_BIN disable-event "$event_name" -s $sess_name -j >/dev/null 2>&1
1475         ok $? "Disable JUL event $event_name for session $sess_name"
1476 }
1477
1478 function disable_log4j_lttng_event ()
1479 {
1480         local sess_name="$1"
1481         local event_name="$2"
1482
1483         _run_lttng_cmd "$OUTPUT_DEST" "$ERROR_OUTPUT_DEST" \
1484                 disable-event "$event_name" -s "$sess_name" --log4j
1485         ok $? "Disable LOG4J event '$event_name' for session '$sess_name'"
1486 }
1487
1488 function disable_python_lttng_event ()
1489 {
1490         local sess_name="$1"
1491         local event_name="$2"
1492
1493         _run_lttng_cmd "$OUTPUT_DEST" "$ERROR_OUTPUT_DEST" \
1494                 disable-event "$event_name" -s $sess_name -p
1495         ok $? "Disable Python event $event_name for session $sess_name"
1496 }
1497
1498 function start_lttng_tracing_opt ()
1499 {
1500         local withtap=$1
1501         local expected_to_fail=$2
1502         local sess_name=$3
1503
1504         _run_lttng_cmd "$OUTPUT_DEST" "$ERROR_OUTPUT_DEST" \
1505                 start $sess_name
1506         ret=$?
1507         if [[ $expected_to_fail -eq "1" ]]; then
1508                 test "$ret" -ne "0"
1509                 ret=$?
1510                 if [ $withtap -eq "1" ]; then
1511                         ok $? "Start tracing for session $sess_name failed as expected"
1512                 fi
1513         else
1514                 if [ $withtap -eq "1" ]; then
1515                         ok $ret "Start tracing for session $sess_name"
1516                 fi
1517         fi
1518 }
1519
1520 function start_lttng_tracing_ok ()
1521 {
1522         start_lttng_tracing_opt 1 0 "$@"
1523 }
1524
1525 function start_lttng_tracing_fail ()
1526 {
1527         start_lttng_tracing_opt 1 1 "$@"
1528 }
1529
1530 function start_lttng_tracing_notap ()
1531 {
1532         start_lttng_tracing_opt 0 1 "$@"
1533 }
1534
1535 function stop_lttng_tracing_opt ()
1536 {
1537         local withtap=$1
1538         local expected_to_fail=$2
1539         local sess_name=$3
1540
1541         _run_lttng_cmd "$OUTPUT_DEST" "$ERROR_OUTPUT_DEST" \
1542                 stop $sess_name
1543         ret=$?
1544         if [[ $expected_to_fail -eq "1" ]]; then
1545                 test "$ret" -ne "0"
1546                 ret=$?
1547                 if [ $withtap -eq "1" ]; then
1548                         ok $? "Stop lttng tracing for session $sess_name failed as expected"
1549                 fi
1550         else
1551                 if [ $withtap -eq "1" ]; then
1552                         ok $ret "Stop lttng tracing for session $sess_name"
1553                 fi
1554         fi
1555 }
1556
1557 function stop_lttng_tracing_ok ()
1558 {
1559         stop_lttng_tracing_opt 1 0 "$@"
1560 }
1561
1562 function stop_lttng_tracing_fail ()
1563 {
1564         stop_lttng_tracing_opt 1 1 "$@"
1565 }
1566
1567 function stop_lttng_tracing_notap ()
1568 {
1569         stop_lttng_tracing_opt 0 0 "$@"
1570 }
1571
1572 function destroy_lttng_session ()
1573 {
1574         local withtap=$1
1575         local expected_to_fail=$2
1576         local sess_name=$3
1577
1578         _run_lttng_cmd "$OUTPUT_DEST" "$ERROR_OUTPUT_DEST" \
1579                 destroy $sess_name
1580         ret=$?
1581         if [[ $expected_to_fail -eq "1" ]]; then
1582                 test "$ret" -ne "0"
1583                 ret=$?
1584                 if [ $withtap -eq "1" ]; then
1585                         ok $ret "Destroy session $sess_name failed as expected"
1586                 fi
1587         else
1588                 if [ $withtap -eq "1" ]; then
1589                         ok $ret "Destroy session $sess_name"
1590                 fi
1591         fi
1592 }
1593
1594 function destroy_lttng_session_ok ()
1595 {
1596         destroy_lttng_session 1 0 "$@"
1597
1598 }
1599
1600 function destroy_lttng_session_fail ()
1601 {
1602         destroy_lttng_session 1 1 "$@"
1603 }
1604
1605 function destroy_lttng_session_notap ()
1606 {
1607         destroy_lttng_session 0 0 "$@"
1608 }
1609
1610 function destroy_lttng_sessions ()
1611 {
1612         _run_lttng_cmd "$OUTPUT_DEST" "$ERROR_OUTPUT_DEST" \
1613                 destroy --all
1614         ok $? "Destroy all lttng sessions"
1615 }
1616
1617 function lttng_snapshot_add_output ()
1618 {
1619         local expected_to_fail=$1
1620         local sess_name=$2
1621         local trace_path=$3
1622         local opts=$4
1623
1624         _run_lttng_cmd "$OUTPUT_DEST" "$ERROR_OUTPUT_DEST" \
1625                 snapshot add-output -s $sess_name $trace_path $opts
1626         ret=$?
1627         if [[ $expected_to_fail -eq 1 ]]; then
1628                 test "$ret" -ne "0"
1629                 ok $? "Added snapshot output $trace_path failed as expected"
1630         else
1631                 ok $ret "Added snapshot output $trace_path"
1632         fi
1633 }
1634
1635 function lttng_snapshot_add_output_ok ()
1636 {
1637         lttng_snapshot_add_output 0 "$@"
1638 }
1639
1640 function lttng_snapshot_add_output_fail ()
1641 {
1642         lttng_snapshot_add_output 1 "$@"
1643 }
1644
1645 function lttng_snapshot_del_output ()
1646 {
1647         local expected_to_fail=$1
1648         local sess_name=$2
1649         local id=$3
1650
1651         _run_lttng_cmd "$OUTPUT_DEST" "$ERROR_OUTPUT_DEST" \
1652                 snapshot del-output -s $sess_name $id
1653         ret=$?
1654         if [[ $expected_to_fail -eq "1" ]]; then
1655                 test "$ret" -ne "0"
1656                 ok $? "Deleted snapshot output id $id failed as expected"
1657         else
1658                 ok $ret "Deleted snapshot output id $id"
1659         fi
1660 }
1661
1662 function lttng_snapshot_del_output_ok ()
1663 {
1664         lttng_snapshot_del_output 0 "$@"
1665 }
1666
1667 function lttng_snapshot_del_output_fail ()
1668 {
1669         lttng_snapshot_del_output 1 "$@"
1670 }
1671
1672 function lttng_snapshot_record ()
1673 {
1674         local sess_name=$1
1675         local trace_path=$2
1676
1677         _run_lttng_cmd "$OUTPUT_DEST" "$ERROR_OUTPUT_DEST" \
1678                 snapshot record -s "$sess_name" "$trace_path"
1679         ok $? "Snapshot recorded"
1680 }
1681
1682 function lttng_snapshot_list ()
1683 {
1684         local sess_name=$1
1685         _run_lttng_cmd "$OUTPUT_DEST" "$ERROR_OUTPUT_DEST" \
1686                 snapshot list-output -s $sess_name
1687         ok $? "Snapshot list"
1688 }
1689
1690 function lttng_save()
1691 {
1692         local sess_name=$1
1693         local opts=$2
1694
1695         _run_lttng_cmd "$OUTPUT_DEST" "$ERROR_OUTPUT_DEST" \
1696                 save $sess_name $opts
1697         ok $? "Session saved"
1698 }
1699
1700 function lttng_load()
1701 {
1702         local expected_to_fail=$1
1703         local opts=$2
1704
1705         _run_lttng_cmd "$OUTPUT_DEST" "$ERROR_OUTPUT_DEST" \
1706                 load $opts
1707         ret=$?
1708         if [[ $expected_to_fail -eq "1" ]]; then
1709                 test $ret -ne "0"
1710                 ok $? "Load command failed as expected with opts: $opts"
1711         else
1712                 ok $ret "Load command with opts: $opts"
1713         fi
1714 }
1715
1716 function lttng_load_ok()
1717 {
1718         lttng_load 0 "$@"
1719 }
1720
1721 function lttng_load_fail()
1722 {
1723         lttng_load 1 "$@"
1724 }
1725
1726 function lttng_track()
1727 {
1728         local expected_to_fail="$1"
1729         shift 1
1730         local opts="$@"
1731         $TESTDIR/../src/bin/lttng/$LTTNG_BIN track $opts >$OUTPUT_DEST
1732         ret=$?
1733         if [[ $expected_to_fail -eq "1" ]]; then
1734                 test $ret -ne "0"
1735                 ok $? "Track command failed as expected with opts: $opts"
1736         else
1737                 ok $ret "Track command with opts: $opts"
1738         fi
1739 }
1740
1741 function lttng_track_ok()
1742 {
1743         lttng_track 0 "$@"
1744 }
1745
1746 function lttng_track_fail()
1747 {
1748         lttng_track 1 "$@"
1749 }
1750
1751 function lttng_untrack()
1752 {
1753         local expected_to_fail="$1"
1754         shift 1
1755         local opts="$@"
1756         $TESTDIR/../src/bin/lttng/$LTTNG_BIN untrack $opts >$OUTPUT_DEST
1757         ret=$?
1758         if [[ $expected_to_fail -eq "1" ]]; then
1759                 test $ret -ne "0"
1760                 ok $? "Untrack command failed as expected with opts: $opts"
1761         else
1762                 ok $ret "Untrack command with opts: $opts"
1763         fi
1764 }
1765
1766 function lttng_untrack_ok()
1767 {
1768         lttng_untrack 0 "$@"
1769 }
1770
1771 function lttng_untrack_fail()
1772 {
1773         lttng_untrack 1 "$@"
1774 }
1775
1776 function lttng_track_pid_ok()
1777 {
1778         PID=$1
1779         "$TESTDIR/../src/bin/lttng/$LTTNG_BIN" track --kernel --pid=$PID 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
1780         ok $? "Lttng track pid on the kernel domain"
1781 }
1782
1783 function lttng_untrack_kernel_all_ok()
1784 {
1785         "$TESTDIR/../src/bin/lttng/$LTTNG_BIN" untrack --kernel --pid --all 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
1786         ok $? "Lttng untrack all pid on the kernel domain"
1787 }
1788
1789 function lttng_track_ust_ok()
1790 {
1791         lttng_track_ok -u "$@"
1792 }
1793
1794 function lttng_track_ust_fail()
1795 {
1796         lttng_track_fail -u "$@"
1797 }
1798
1799 function lttng_track_kernel_ok()
1800 {
1801         lttng_track_ok -k "$@"
1802 }
1803
1804 function lttng_track_kernel_fail()
1805 {
1806         lttng_track_fail -k "$@"
1807 }
1808
1809 function lttng_untrack_ust_ok()
1810 {
1811         lttng_untrack_ok -u "$@"
1812 }
1813
1814 function lttng_untrack_ust_fail()
1815 {
1816         lttng_untrack_fail -u "$@"
1817 }
1818
1819 function lttng_untrack_kernel_ok()
1820 {
1821         lttng_untrack_ok -k "$@"
1822 }
1823
1824 function lttng_untrack_kernel_fail()
1825 {
1826         lttng_untrack_fail -k "$@"
1827 }
1828
1829 function lttng_add_context_list()
1830 {
1831         _run_lttng_cmd "$OUTPUT_DEST" "$ERROR_OUTPUT_DEST" \
1832                 add-context --list
1833         ret=$?
1834         ok $ret "Context listing"
1835 }
1836
1837 function add_context_lttng()
1838 {
1839         local expected_to_fail="$1"
1840         local domain="$2"
1841         local session_name="$3"
1842         local channel_name="$4"
1843         local type="$5"
1844
1845         _run_lttng_cmd "$OUTPUT_DEST" "$ERROR_OUTPUT_DEST" \
1846                 add-context -s $session_name -c $channel_name -t $type $domain
1847         ret=$?
1848         if [[ $expected_to_fail -eq "1" ]]; then
1849                 test $ret -ne "0"
1850                 ok $? "Add context command failed as expected for type: $type"
1851         else
1852                 ok $ret "Add context command for type: $type"
1853         fi
1854 }
1855
1856 function add_context_ust_ok()
1857 {
1858         add_context_lttng 0 -u "$@"
1859 }
1860
1861 function add_context_ust_fail()
1862 {
1863         add_context_lttng 1 -u "$@"
1864 }
1865
1866 function add_context_kernel_ok()
1867 {
1868         add_context_lttng 0 -k "$@"
1869 }
1870
1871 function add_context_kernel_fail()
1872 {
1873         add_context_lttng 1 -k "$@"
1874 }
1875
1876 function wait_live_trace_ready ()
1877 {
1878         local url=$1
1879         local zero_client_match=0
1880
1881         diag "Waiting for live trace at url: $url"
1882         while [ $zero_client_match -eq 0 ]; do
1883                 zero_client_match=$($BABELTRACE_BIN -i lttng-live $url | grep "0 client(s) connected" | wc -l)
1884                 sleep 0.5
1885         done
1886         pass "Waiting for live trace at url: $url"
1887 }
1888
1889 function wait_live_viewer_connect ()
1890 {
1891         local url=$1
1892         local one_client_match=0
1893
1894         diag "Waiting for live viewers on url: $url"
1895         while [ $one_client_match -eq 0 ]; do
1896                 one_client_match=$($BABELTRACE_BIN -i lttng-live $url | grep "1 client(s) connected" | wc -l)
1897                 sleep 0.5
1898         done
1899         pass "Waiting for live viewers on url: $url"
1900 }
1901
1902 function bail_out_if_no_babeltrace()
1903 {
1904         which "$BABELTRACE_BIN" >/dev/null
1905         if [ $? -ne 0 ]; then
1906                 LTTNG_BAIL_OUT "\"$BABELTRACE_BIN\" binary not found. Skipping tests"
1907         fi
1908 }
1909
1910 # Check that the trace metadata contains '$expected' event ids matching '$event_name'.
1911 function validate_metadata_event()
1912 {
1913         local event_name=$1
1914         local expected=$2
1915         local trace_path=$3
1916
1917         local metadata_file
1918         local metadata_path
1919         local count
1920
1921         metadata_file=$(find "$trace_path" -name "metadata")
1922         metadata_path=$(dirname "$metadata_file")
1923
1924         bail_out_if_no_babeltrace
1925
1926         count=$($BABELTRACE_BIN --output-format=ctf-metadata "$metadata_path" | grep -c "$event_name")
1927
1928         test "$count" -eq "$expected"
1929         ok $? "Found $count / $expected metadata event id matching '$event_name'"
1930 }
1931
1932 # Check that the trace contains '$expected' events matching '$event_name', other
1933 # events not matching '$event_name' can be present.
1934 function trace_matches()
1935 {
1936         local event_name=$1
1937         local expected=$2
1938         local trace_path=$3
1939
1940         local count
1941         local total
1942
1943         bail_out_if_no_babeltrace
1944
1945         count=$($BABELTRACE_BIN "$trace_path" | grep -c "$event_name")
1946         total=$($BABELTRACE_BIN "$trace_path" | wc -l)
1947
1948         test "$count" -eq "$expected"
1949
1950         ok $? "Found $count / $expected events matching '$event_name' out of $total events"
1951 }
1952
1953 # Check that the trace contains '$expected' events matching '$event_name' and no
1954 # other events.
1955 function trace_match_only()
1956 {
1957         local event_name=$1
1958         local expected=$2
1959         local trace_path=$3
1960
1961         local count
1962         local total
1963
1964         bail_out_if_no_babeltrace
1965
1966         count=$($BABELTRACE_BIN "$trace_path" | grep -c "$event_name")
1967         total=$($BABELTRACE_BIN "$trace_path" | wc -l)
1968
1969         test "$expected" -eq "$count" && test "$total" -eq "$expected"
1970
1971         ok $? "Found $count / $expected events matching '$event_name' amongst $total events"
1972 }
1973
1974 # Check that the trace contains at least 1 event matching each name in the
1975 # comma separated list '$event_names'.
1976 function validate_trace()
1977 {
1978         local event_names=$1
1979         local trace_path=$2
1980
1981         local count
1982
1983         bail_out_if_no_babeltrace
1984
1985         OLDIFS=$IFS
1986         IFS=","
1987         for event_name in $event_names; do
1988                 # trace_path is unquoted since callers make use of globbing
1989                 count=$($BABELTRACE_BIN $trace_path | grep -c "$event_name")
1990                 test "$count" -gt 0
1991                 ok $? "Found $count events matching '$event_name'"
1992         done
1993         IFS=$OLDIFS
1994 }
1995
1996 # Check that the trace contains at least 1 event matching each name in the
1997 # comma separated list '$event_names' and a total of '$expected' events.
1998 function validate_trace_count()
1999 {
2000         local event_names=$1
2001         local trace_path=$2
2002         local expected=$3
2003
2004         local count
2005         local total=0
2006
2007         bail_out_if_no_babeltrace
2008
2009         OLDIFS=$IFS
2010         IFS=","
2011         for event_name in $event_names; do
2012                 count=$($BABELTRACE_BIN "$trace_path" | grep -c "$event_name")
2013                 test "$count" -gt 0
2014                 ok $? "Found '$count' events matching '$event_name'"
2015                 total=$(( total + count ))
2016         done
2017         IFS=$OLDIFS
2018         test $total -eq "$expected"
2019         ok $? "Found $total events, expected $expected events"
2020 }
2021
2022 # Check that the trace contains at least '$expected_min' event matching each
2023 # name in the comma separated list '$event_names' and a total at least
2024 # '$expected_min' and less than '$expected_max' events.
2025 function validate_trace_count_range_incl_min_excl_max()
2026 {
2027         local event_names=$1
2028         local trace_path=$2
2029         local expected_min=$3
2030         local expected_max=$4
2031
2032         local count
2033         local total=0
2034
2035         bail_out_if_no_babeltrace
2036
2037         OLDIFS=$IFS
2038         IFS=","
2039         for event_name in $event_names; do
2040                 count=$($BABELTRACE_BIN "$trace_path" | grep -c "$event_name")
2041                 test "$count" -ge "$expected_min"
2042                 ok $? "Found $count events matching '$event_name', expected at least $expected_min"
2043                 total=$(( total + count ))
2044         done
2045         IFS=$OLDIFS
2046         test $total -ge "$expected_min" && test $total -lt "$expected_max"
2047         ok $? "Found a total of $total events, expected at least $expected_min and less than $expected_max"
2048 }
2049
2050 function trace_first_line()
2051 {
2052         local trace_path=$1
2053
2054         $BABELTRACE_BIN "$trace_path" | head -n 1
2055 }
2056
2057 # Check that the trace contains at least 1 event matching the grep extended
2058 # regexp '$event_exp'.
2059 function validate_trace_exp()
2060 {
2061         local event_exp=$1
2062         local trace_path=$2
2063
2064         local count
2065
2066         bail_out_if_no_babeltrace
2067
2068         # event_exp is unquoted since it contains multiple grep arguments
2069         count=$($BABELTRACE_BIN "$trace_path" | grep -c --extended-regexp $event_exp)
2070         test "$count" -gt 0
2071         ok $? "Found $count events matching expression '$event_exp'"
2072 }
2073
2074 # Check that the trace contains at least 1 event matching the grep extended
2075 # regexp '$event_exp' and zero event not matching it.
2076 function validate_trace_only_exp()
2077 {
2078         local event_exp=$1
2079         local trace_path=$2
2080
2081         local count
2082         local total
2083
2084         bail_out_if_no_babeltrace
2085
2086         # event_exp is unquoted since it contains multiple grep arguments
2087         count=$($BABELTRACE_BIN "$trace_path" | grep -c --extended-regexp $event_exp)
2088         total=$($BABELTRACE_BIN "$trace_path" | wc -l)
2089
2090         test  "$count" -gt 0 && test "$total" -eq "$count"
2091         ok $? "Found $count events matching expression '$event_exp' amongst $total events"
2092 }
2093
2094 # Check that the trace is valid and contains 0 event.
2095 function validate_trace_empty()
2096 {
2097         local trace_path=$1
2098
2099         local ret
2100         local count
2101
2102         bail_out_if_no_babeltrace
2103
2104         events=$($BABELTRACE_BIN "$trace_path")
2105         ret=$?
2106         if [ $ret -ne 0 ]; then
2107                 fail "Failed to parse trace"
2108                 return $ret
2109         fi
2110
2111         count=$(echo -n "$events" | wc -l)
2112         test "$count" -eq 0
2113         ok $? "Validate trace is empty, found $count events"
2114 }
2115
2116 function validate_directory_empty ()
2117 {
2118         local trace_path="$1"
2119
2120         local files
2121         local ret
2122         local nb_files
2123
2124         # Do not double quote `$trace_path` below as we want wildcards to be
2125         # expanded.
2126         files="$(ls -A $trace_path)"
2127         ret=$?
2128         if [ $ret -ne 0 ]; then
2129                 fail "Failed to list content of directory \"$trace_path\""
2130                 return $ret
2131         fi
2132
2133         nb_files="$(echo -n "$files" | wc -l)"
2134         test "$nb_files" -eq 0
2135         ok $? "Directory \"$trace_path\" is empty"
2136 }
2137
2138 function validate_trace_session_ust_empty()
2139 {
2140         validate_directory_empty "$1"/ust
2141 }
2142
2143 function validate_trace_session_kernel_empty()
2144 {
2145         validate_trace_empty "$1"/kernel
2146 }
2147
2148 function regenerate_metadata ()
2149 {
2150         local expected_to_fail=$1
2151         local sess_name=$2
2152
2153         _run_lttng_cmd "$OUTPUT_DEST" "$ERROR_OUTPUT_DEST" \
2154                 regenerate metadata -s $sess_name
2155         ret=$?
2156         if [[ $expected_to_fail -eq "1" ]]; then
2157                 test "$ret" -ne "0"
2158                 ok $? "Expected fail on regenerate metadata $sess_name"
2159         else
2160                 ok $ret "Metadata regenerate $sess_name"
2161         fi
2162 }
2163
2164 function regenerate_metadata_ok ()
2165 {
2166         regenerate_metadata 0 "$@"
2167 }
2168
2169 function regenerate_metadata_fail ()
2170 {
2171         regenerate_metadata 1 "$@"
2172 }
2173
2174 function regenerate_statedump ()
2175 {
2176         local expected_to_fail=$1
2177         local sess_name=$2
2178
2179         _run_lttng_cmd "$OUTPUT_DEST" "$ERROR_OUTPUT_DEST" \
2180                 regenerate statedump -s $sess_name
2181         ret=$?
2182         if [[ $expected_to_fail -eq "1" ]]; then
2183                 test "$ret" -ne "0"
2184                 ok $? "Expected fail on regenerate statedump $sess_name"
2185         else
2186                 ok $ret "Statedump regenerate $sess_name"
2187         fi
2188 }
2189
2190 function regenerate_statedump_ok ()
2191 {
2192         regenerate_statedump 0 "$@"
2193 }
2194
2195 function regenerate_statedump_fail ()
2196 {
2197         regenerate_statedump 1 "$@"
2198 }
2199
2200 function rotate_session ()
2201 {
2202         local expected_to_fail=$1
2203         local sess_name=$2
2204
2205         _run_lttng_cmd "$OUTPUT_DEST" "$ERROR_OUTPUT_DEST" \
2206                 rotate $sess_name
2207         ret=$?
2208         if [[ $expected_to_fail -eq "1" ]]; then
2209                 test "$ret" -ne "0"
2210                 ok $? "Expected fail on rotate session $sess_name"
2211         else
2212                 ok $ret "Rotate session $sess_name"
2213         fi
2214 }
2215
2216 function rotate_session_ok ()
2217 {
2218         rotate_session 0 "$@"
2219 }
2220
2221 function rotate_session_fail ()
2222 {
2223         rotate_session 1 "$@"
2224 }
2225
2226 function destructive_tests_enabled ()
2227 {
2228         if [ "$LTTNG_ENABLE_DESTRUCTIVE_TESTS" = "will-break-my-system" ]; then
2229                 return 0
2230         else
2231                 return 1
2232         fi
2233 }
2234
2235 function lttng_enable_rotation_timer ()
2236 {
2237         local expected_to_fail=$1
2238         local sess_name=$2
2239         local period=$3
2240
2241         _run_lttng_cmd "$OUTPUT_DEST" "$ERROR_OUTPUT_DEST" \
2242                 enable-rotation -s $sess_name --timer $period
2243         ret=$?
2244         if [[ $expected_to_fail -eq "1" ]]; then
2245                 test "$ret" -ne "0"
2246                 ok $? "Expected fail when setting periodic rotation ($period) of session $sess_name"
2247         else
2248                 ok $ret "Set periodic rotation ($period) of session $sess_name"
2249         fi
2250 }
2251
2252 function lttng_enable_rotation_timer_ok ()
2253 {
2254         lttng_enable_rotation_timer 0 $@
2255 }
2256
2257 function lttng_enable_rotation_timer_fail ()
2258 {
2259         lttng_enable_rotation_timer 1 $@
2260 }
2261
2262 function lttng_enable_rotation_size ()
2263 {
2264         local expected_to_fail=$1
2265         local sess_name=$2
2266         local size=$3
2267
2268         _run_lttng_cmd "$OUTPUT_DEST" "$ERROR_OUTPUT_DEST" \
2269                 enable-rotation -s $sess_name --size $size
2270         ret=$?
2271         if [[ $expected_to_fail -eq "1" ]]; then
2272                 test "$ret" -ne "0"
2273                 ok $? "Expected to fail to set a periodic rotation of session $sess_name" "every " $size " bytes"
2274         else
2275                 ok $ret "Set a scheduled rotation of session $sess_name" "every " $size " bytes"
2276         fi
2277 }
2278
2279 function lttng_enable_rotation_size_ok ()
2280 {
2281         lttng_enable_rotation_size 0 $@
2282 }
2283
2284 function lttng_enable_rotation_size_fail ()
2285 {
2286         lttng_enable_rotation_size 1 $@
2287 }
2288
2289 function lttng_clear_session ()
2290 {
2291         local expected_to_fail=$1
2292         local sess_name=$2
2293
2294         _run_lttng_cmd "$OUTPUT_DEST" "$ERROR_OUTPUT_DEST" \
2295                 clear $sess_name
2296         ret=$?
2297         if [[ $expected_to_fail -eq "1" ]]; then
2298                 test "$ret" -ne "0"
2299                 ok $? "Expected fail on clear session $sess_name"
2300         else
2301                 ok $ret "Clear session $sess_name"
2302         fi
2303 }
2304
2305 function lttng_clear_session_ok ()
2306 {
2307         lttng_clear_session 0 $@
2308 }
2309
2310 function lttng_clear_session_fail ()
2311 {
2312         lttng_clear_session 1 $@
2313 }
2314
2315 function lttng_clear_all ()
2316 {
2317         _run_lttng_cmd "$OUTPUT_DEST" "$ERROR_OUTPUT_DEST" \
2318                 clear --all
2319         ok $? "Clear all lttng sessions"
2320 }
2321
2322 function lttng_add_trigger()
2323 {
2324         local expected_to_fail="$1"
2325         local trigger_name="$2"
2326         shift 2
2327         local args=("$@")
2328
2329         diag "$TESTDIR/../src/bin/lttng/$LTTNG_BIN add-trigger --name $trigger_name ${args[*]}"
2330         $TESTDIR/../src/bin/lttng/$LTTNG_BIN add-trigger --name "$trigger_name" "${args[@]}" 1> /dev/null 2> /dev/null
2331         ret=$?
2332         if [[ $expected_to_fail -eq "1" ]]; then
2333                 test "$ret" -ne "0"
2334                 ok $? "Add trigger $trigger_name failed as expected"
2335         else
2336                 ok $ret "Add trigger $trigger_name"
2337         fi
2338 }
2339
2340 function lttng_remove_trigger()
2341 {
2342         local expected_to_fail="$1"
2343         local trigger_name="$2"
2344         shift 2
2345
2346         diag "$TESTDIR/../src/bin/lttng/$LTTNG_BIN remove-trigger $trigger_name $*"
2347         "$TESTDIR/../src/bin/lttng/$LTTNG_BIN" remove-trigger "$trigger_name" "$@" 1> /dev/null 2> /dev/null
2348         ret=$?
2349         if [[ $expected_to_fail -eq "1" ]]; then
2350                 test "$ret" -ne "0"
2351                 ok $? "Remove trigger $trigger_name failed as expected"
2352         else
2353                 ok $ret "Remove trigger $trigger_name"
2354         fi
2355 }
2356
2357 function lttng_add_trigger_ok()
2358 {
2359         lttng_add_trigger 0 "$@"
2360 }
2361
2362 function lttng_add_trigger_fail()
2363 {
2364         lttng_add_trigger 1 "$@"
2365 }
2366
2367 function lttng_remove_trigger_ok()
2368 {
2369         lttng_remove_trigger 0 "$@"
2370 }
2371
2372 function list_triggers_matches_ok ()
2373 {
2374         local tmp_stdout=$(mktemp --tmpdir -t "tmp.${FUNCNAME[0]}_stdout.XXXXXX")
2375         local tmp_stderr=$(mktemp --tmpdir -t "tmp.${FUNCNAME[0]}_stderr.XXXXXX")
2376
2377         local test_name="$1"
2378         local expected_stdout_file="$2"
2379
2380         diag "$TESTDIR/../src/bin/lttng/$LTTNG_BIN list-triggers"
2381
2382         "$TESTDIR/../src/bin/lttng/$LTTNG_BIN" list-triggers > "${tmp_stdout}" 2> "${tmp_stderr}"
2383         ok $? "${test_name}: exit code is 0"
2384
2385         diff -u "${expected_stdout_file}" "${tmp_stdout}"
2386         ok $? "${test_name}: expected stdout"
2387
2388         diff -u /dev/null "${tmp_stderr}"
2389         ok $? "${test_name}: expected stderr"
2390
2391         rm -f "${tmp_stdout}"
2392         rm -f "${tmp_stderr}"
2393 }
2394
2395 function list_triggers_matches_mi_ok ()
2396 {
2397         local tmp_stdout
2398         local tmp_stdout_raw
2399         local tmp_stderr
2400
2401         local test_name="$1"
2402         local expected_stdout_file="$2"
2403
2404         tmp_stdout_raw=$(mktemp --tmpdir -t "tmp.${FUNCNAME[0]}_stdout.XXXXXX")
2405         tmp_stdout=$(mktemp --tmpdir -t "tmp.${FUNCNAME[0]}_stdout.XXXXXX")
2406         tmp_stderr=$(mktemp --tmpdir -t "tmp.${FUNCNAME[0]}_stderr.XXXXXX")
2407
2408         diag "$TESTDIR/../src/bin/lttng/$LTTNG_BIN --mi xml list-triggers"
2409
2410         "$TESTDIR/../src/bin/lttng/$LTTNG_BIN" --mi=xml list-triggers > "${tmp_stdout_raw}" 2> "${tmp_stderr}"
2411         ok $? "${test_name}: exit code is 0"
2412
2413         # Pretty-fy xml before further test.
2414         $XML_PRETTY < "${tmp_stdout_raw}" > "${tmp_stdout}"
2415
2416         $MI_VALIDATE "${tmp_stdout}"
2417         ok $? "list-trigger mi is valid"
2418
2419         diff -u "${expected_stdout_file}" "${tmp_stdout}"
2420         ok $? "${test_name}: expected stdout"
2421
2422         diff -u /dev/null "${tmp_stderr}"
2423         ok $? "${test_name}: expected stderr"
2424
2425         rm -f "${tmp_stdout}"
2426         rm -f "${tmp_stdout_raw}"
2427         rm -f "${tmp_stderr}"
2428 }
2429
2430 function validate_path_pattern ()
2431 {
2432         local message=$1
2433         local pattern=$2
2434         # Base path is only used in error case and is used to list the content
2435         # of the base path.
2436         local base_path=$3
2437
2438
2439         [ -f $pattern ]
2440         ret=$?
2441         ok $ret "$message"
2442
2443         if [ "$ret" -ne "0" ]; then
2444                 diag "Path pattern expected: $pattern"
2445                 # List the tracepath for more info. We use find as a recursive
2446                 # directory lister.
2447                 diag "The base path content:"
2448                 find "$base_path" -print
2449         fi
2450 }
2451
2452 function validate_trace_path_ust_uid ()
2453 {
2454         local trace_path=$1
2455         local session_name=$2
2456         local uid=$UID
2457         local pattern="$trace_path/$session_name-$date_time_pattern/ust/uid/$uid/${system_long_bit_size}-bit/metadata"
2458
2459         validate_path_pattern "UST per-uid trace path is valid" "$pattern" "$trace_path"
2460 }
2461
2462 function validate_trace_path_ust_uid_network ()
2463 {
2464         local trace_path=$1
2465         local session_name=$2
2466         local base_path=$3
2467         local uid=$UID
2468         local hostname=$HOSTNAME
2469         local pattern
2470         local ret
2471
2472         # If the session was given a network base path (e.g
2473         # 127.0.0.1/my/custom/path on creation, there is no session name
2474         # component to the path on the relayd side. Caller can simply not pass a
2475         # session name for this scenario.
2476         if [ -n "$session_name" ]; then
2477                 session_name="$session_name-$date_time_pattern"
2478                 if [ -n "$base_path" ]; then
2479                         fail "Session name and base path are mutually exclusive"
2480                         return
2481                 fi
2482         fi
2483
2484         pattern="$trace_path/$hostname/$base_path/$session_name/ust/uid/$uid/${system_long_bit_size}-bit/metadata"
2485
2486         validate_path_pattern "UST per-uid network trace path is valid" "$pattern" "$trace_path"
2487 }
2488
2489 function validate_trace_path_ust_uid_snapshot_network ()
2490 {
2491         local trace_path=$1
2492         local session_name=$2
2493         local snapshot_name=$3
2494         local snapshot_number=$4
2495         local base_path=$5
2496         local hostname=$HOSTNAME
2497         local uid=$UID
2498         local pattern
2499         local ret
2500
2501         # If the session/output was given a network base path (e.g
2502         # 127.0.0.1/my/custom/path on creation, there is no session name
2503         # component to the path on the relayd side. Caller can simply not pass a
2504         # session name for this scenario.
2505         if [ -n "$session_name" ]; then
2506                 session_name="$session_name-$date_time_pattern"
2507                 if [ -n "$base_path" ]; then
2508                         fail "Session name and base path are mutually exclusive"
2509                         return
2510                 fi
2511         fi
2512
2513         pattern="$trace_path/$hostname/$base_path/$session_name/$snapshot_name-$date_time_pattern-$snapshot_number/ust/uid/$uid/${system_long_bit_size}-bit/metadata"
2514
2515         validate_path_pattern "UST per-uid network snapshot trace path is valid" "$pattern" "$trace_path"
2516 }
2517
2518 function validate_trace_path_ust_uid_snapshot ()
2519 {
2520         local trace_path=$1
2521         local session_name=$2
2522         local snapshot_name=$3
2523         local snapshot_number=$4
2524         local base_path=$5
2525         local uid=$UID
2526         local pattern
2527         local ret
2528
2529         # If the session/output was given a network base path (e.g
2530         # 127.0.0.1/my/custom/path) on creation, there is no session name
2531         # component to the path on the relayd side. Caller can simply not pass a
2532         # session name for this scenario.
2533         if [ -n "$session_name" ]; then
2534                 session_name="$session_name-$date_time_pattern"
2535                 if [ -n "$base_path" ]; then
2536                         fail "Session name and base path are mutually exclusive"
2537                         return
2538                 fi
2539         fi
2540
2541         pattern="$trace_path/$base_path/$session_name/$snapshot_name-$date_time_pattern-$snapshot_number/ust/uid/$uid/${system_long_bit_size}-bit/metadata"
2542
2543         validate_path_pattern "UST per-uid snapshot trace path is valid" "$pattern" "$trace_path"
2544 }
2545
2546 function validate_trace_path_ust_pid ()
2547 {
2548         local trace_path=$1
2549         local session_name=$2
2550         local app_string=$3
2551         local pid=$4
2552         local pattern
2553         local ret
2554
2555         # If the session was given a trace path on creation, there is no session
2556         # name component to the path. Caller can simply not pass a session name
2557         # for this scenario.
2558         if [ -n "$session_name" ]; then
2559                 session_name="$session_name-$date_time_pattern"
2560         fi
2561
2562         pattern="$trace_path/$session_name/ust/pid/$pid/$app_string-*-$date_time_pattern/metadata"
2563
2564         validate_path_pattern "UST per-pid trace path is valid" "$pattern" "$trace_path"
2565 }
2566
2567 function validate_trace_path_kernel ()
2568 {
2569         local trace_path=$1
2570         local session_name=$2
2571         local pattern
2572
2573         # If the session was given a trace path on creation, there is no session
2574         # name component to the path. Caller can simply not pass a session name
2575         # for this scenario.
2576         if [ -n "$session_name" ]; then
2577                 session_name="$session_name-$date_time_pattern"
2578         fi
2579
2580         pattern="$trace_path/$session_name/kernel/metadata"
2581
2582         validate_path_pattern "Kernel trace path is valid" "$pattern" "$trace_path"
2583 }
2584
2585 function validate_trace_path_kernel_network ()
2586 {
2587         local trace_path=$1
2588         local session_name=$2
2589         local hostname=$HOSTNAME
2590         local pattern="$trace_path/$hostname/$session_name-$date_time_pattern/kernel/metadata"
2591
2592         validate_path_pattern "Kernel network trace path is valid" "$pattern" "$trace_path"
2593 }
2594
2595 function validate_trace_path_kernel_snapshot ()
2596 {
2597         local trace_path=$1
2598         local session_name=$2
2599         local snapshot_name=$3
2600         local snapshot_number=$4
2601         local base_path=$5
2602         local pattern
2603         local ret
2604
2605         # If the session/output was given a network base path (e.g
2606         # 127.0.0.1/my/custom/path on creation, there is no session name
2607         # component to the path on the relayd side. Caller can simply not pass a
2608         # session name for this scenario.
2609         if [ -n "$session_name" ]; then
2610                 session_name="$session_name-$date_time_pattern"
2611                 if [ -n "$base_path" ]; then
2612                         fail "Session name and base path are mutually exclusive"
2613                         return
2614                 fi
2615         fi
2616
2617         pattern="$trace_path/$base_path/$session_name/$snapshot_name-$date_time_pattern-$snapshot_number/kernel/metadata"
2618
2619         validate_path_pattern "Kernel snapshot trace path is valid" "$pattern" "$trace_path"
2620 }
2621
2622 function validate_trace_path_kernel_snapshot_network ()
2623 {
2624         local trace_path=$1
2625         local session_name=$2
2626         local snapshot_name=$3
2627         local snapshot_number=$4
2628         local base_path=$5
2629         local hostname=$HOSTNAME
2630         local pattern
2631         local ret
2632
2633         # If the session/output was given a network base path (e.g
2634         # 127.0.0.1/my/custom/path on creation, there is no session name
2635         # component to the path on the relayd side. Caller can simply not pass a
2636         # session name for this scenario.
2637         if [ -n "$session_name" ]; then
2638                 session_name="$session_name-$date_time_pattern"
2639                 if [ -n "$base_path" ]; then
2640                         fail "Session name and base path are mutually exclusive"
2641                         return
2642                 fi
2643         fi
2644
2645         pattern="$trace_path/$hostname/$base_path/$session_name/$snapshot_name-$date_time_pattern-$snapshot_number/kernel/metadata"
2646
2647         validate_path_pattern "Kernel network snapshot trace path is valid" "$pattern" "$trace_path"
2648 }