tests/utils/utils.sh

   1 # Copyright (C) - 2012 David Goulet <dgoulet@efficios.com>
   2 #
   3 # This library is free software; you can redistribute it and/or modify it under
   4 # the terms of the GNU Lesser General Public License as published by the Free
   5 # Software Foundation; version 2.1 of the License.
   6 #
   7 # This library is distributed in the hope that it will be useful, but WITHOUT
   8 # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
   9 # FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more
  10 # details.
  11 #
  12 # You should have received a copy of the GNU Lesser General Public License
  13 # along with this library; if not, write to the Free Software Foundation, Inc.,
  14 # 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301 USA
  15
  16 SESSIOND_BIN="lttng-sessiond"
  17 SESSIOND_MATCH=".*lttng-sess.*"
  18 SESSIOND_PIDS=""
  19 RUNAS_BIN="lttng-runas"
  20 RUNAS_MATCH=".*lttng-runas.*"
  21 CONSUMERD_BIN="lttng-consumerd"
  22 CONSUMERD_MATCH=".*lttng-consumerd.*"
  23 RELAYD_BIN="lttng-relayd"
  24 RELAYD_MATCH=".*lttng-relayd.*"
  25 RELAYD_PIDS=""
  26 LTTNG_BIN="lttng"
  27 BABELTRACE_BIN="babeltrace"
  28 OUTPUT_DEST=/dev/null
  29 ERROR_OUTPUT_DEST=/dev/null
  30
  31 # Minimal kernel version supported for session daemon tests
  32 KERNEL_MAJOR_VERSION=2
  33 KERNEL_MINOR_VERSION=6
  34 KERNEL_PATCHLEVEL_VERSION=27
  35
  36 # We set the default UST register timeout and network and app socket timeout to
  37 # "wait forever", so that basic tests don't have to worry about hitting
  38 # timeouts on busy systems. Specialized tests should test those corner-cases.
  39 export LTTNG_UST_REGISTER_TIMEOUT=-1
  40 export LTTNG_NETWORK_SOCKET_TIMEOUT=-1
  41 export LTTNG_APP_SOCKET_TIMEOUT=-1
  42
  43 # We set the default lttng-sessiond path to /bin/true to prevent the spawning
  44 # of a daemonized sessiond. This is necessary since 'lttng create' will spawn
  45 # its own sessiond if none is running. It also ensures that 'lttng create'
  46 # fails when no sessiond is running.
  47 export LTTNG_SESSIOND_PATH="/bin/true"
  48
  49 source $TESTDIR/utils/tap/tap.sh
  50
  51 function full_cleanup ()
  52 {
  53         if [ -n "${SESSIOND_PIDS}" ] || [ -n "${RELAYD_PIDS}" ]; then
  54                 kill -9 ${SESSIOND_PIDS} ${RELAYD_PIDS} > /dev/null 2>&1
  55         fi
  56
  57         # Disable trap for SIGTERM since the following kill to the
  58         # pidgroup will be SIGTERM. Otherwise it loops.
  59         # The '-' before the pid number ($$) indicates 'kill' to signal the
  60         # whole process group.
  61         trap - SIGTERM && kill -- -$$
  62 }
  63
  64
  65 trap full_cleanup SIGINT SIGTERM
  66
  67 function print_ok ()
  68 {
  69         # Check if we are a terminal
  70         if [ -t 1 ]; then
  71                 echo -e "\e[1;32mOK\e[0m"
  72         else
  73                 echo -e "OK"
  74         fi
  75 }
  76
  77 function print_fail ()
  78 {
  79         # Check if we are a terminal
  80         if [ -t 1 ]; then
  81                 echo -e "\e[1;31mFAIL\e[0m"
  82         else
  83                 echo -e "FAIL"
  84         fi
  85 }
  86
  87 function print_test_banner ()
  88 {
  89         local desc="$1"
  90         diag "$desc"
  91 }
  92
  93 function validate_kernel_version ()
  94 {
  95         local kern_version=($(uname -r | awk -F. '{ printf("%d.%d.%d\n",$1,$2,$3); }' | tr '.' '\n'))
  96         if [ ${kern_version[0]} -gt $KERNEL_MAJOR_VERSION ]; then
  97                 return 0
  98         fi
  99         if [ ${kern_version[1]} -gt $KERNEL_MINOR_VERSION ]; then
 100                 return 0
 101         fi
 102         if [ ${kern_version[2]} -ge $KERNEL_PATCHLEVEL_VERSION ]; then
 103                 return 0
 104         fi
 105         return 1
 106 }
 107
 108 # Generate a random string
 109 #  $1 = number of characters; defaults to 16
 110 #  $2 = include special characters; 1 = yes, 0 = no; defaults to yes
 111 function randstring()
 112 {
 113         [ "$2" == "0" ] && CHAR="[:alnum:]" || CHAR="[:graph:]"
 114         cat /dev/urandom 2>/dev/null | tr -cd "$CHAR" 2>/dev/null | head -c ${1:-16} 2>/dev/null
 115         echo
 116 }
 117
 118 # Return the number of _configured_ CPUs.
 119 function conf_proc_count()
 120 {
 121         getconf _NPROCESSORS_CONF
 122         if [ $? -ne 0 ]; then
 123                 diag "Failed to get the number of configured CPUs"
 124         fi
 125         echo
 126 }
 127
 128 # Check if base lttng-modules are present.
 129 # Bail out on failure
 130 function validate_lttng_modules_present ()
 131 {
 132         modprobe -n lttng-tracer 2>/dev/null
 133         if [ $? -ne 0  ]; then
 134                 BAIL_OUT "LTTng modules not detected."
 135         fi
 136 }
 137
 138 function enable_kernel_lttng_event
 139 {
 140         local withtap="$1"
 141         local expected_to_fail="$2"
 142         local sess_name="$3"
 143         local event_name="$4"
 144         local channel_name="$5"
 145
 146         if [ -z "$event_name" ]; then
 147                 # Enable all event if no event name specified
 148                 event_name="-a"
 149         fi
 150
 151         if [ -z "$channel_name" ]; then
 152                 # default channel if none specified
 153                 chan=""
 154         else
 155                 chan="-c $channel_name"
 156         fi
 157
 158         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event "$event_name" $chan -s $sess_name -k 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
 159         ret=$?
 160         if [[ $expected_to_fail -eq "1" ]]; then
 161                 test $ret -ne "0"
 162                 ret=$?
 163                 if [ $withtap -eq "1" ]; then
 164                         ok $ret "Enable kernel event $event_name for session $session_name on channel $channel_name failed as expected"
 165                 fi
 166         else
 167                 if [ $withtap -eq "1" ]; then
 168                         ok $ret "Enable kernel event $event_name for session $sess_name"
 169                 fi
 170         fi
 171 }
 172
 173 function enable_kernel_lttng_event_ok ()
 174 {
 175         enable_kernel_lttng_event 1 0 "$@"
 176 }
 177
 178 function enable_kernel_lttng_event_fail ()
 179 {
 180         enable_kernel_lttng_event 1 1 "$@"
 181 }
 182
 183 function enable_kernel_lttng_event_notap ()
 184 {
 185         enable_kernel_lttng_event 0 0 "$@"
 186 }
 187
 188 # Old interface
 189 function lttng_enable_kernel_event
 190 {
 191         enable_kernel_lttng_event_ok "$@"
 192 }
 193
 194 function lttng_enable_kernel_syscall()
 195 {
 196         local expected_to_fail=$1
 197         local sess_name=$2
 198         local syscall_name=$3
 199         local channel_name=$4
 200
 201         if [ -z $syscall_name ]; then
 202                 # Enable all event if no syscall name specified
 203                 syscall_name="-a"
 204         fi
 205
 206         if [ -z $channel_name ]; then
 207                 # default channel if none specified
 208                 chan=""
 209         else
 210                 chan="-c $channel_name"
 211         fi
 212
 213         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event --syscall "$syscall_name" $chan -s $sess_name -k 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
 214         ret=$?
 215         if [[ $expected_to_fail -eq "1" ]]; then
 216                 test $ret -ne "0"
 217                 ok $? "Enable kernel syscall $syscall_name for session $sess_name on channel $channel_name fail as expected"
 218         else
 219                 ok $ret "Enable kernel syscall $syscall_name for session $sess_name on channel $channel_name"
 220         fi
 221 }
 222
 223 function lttng_enable_kernel_syscall_ok()
 224 {
 225         lttng_enable_kernel_syscall 0 "$@"
 226 }
 227
 228 function lttng_enable_kernel_syscall_fail()
 229 {
 230         lttng_enable_kernel_syscall 1 "$@"
 231 }
 232
 233 function lttng_disable_kernel_syscall()
 234 {
 235         local expected_to_fail=$1
 236         local sess_name=$2
 237         local syscall_name=$3
 238         local channel_name=$4
 239
 240         if [ -z $syscall_name ]; then
 241                 # Enable all event if no syscall name specified
 242                 syscall_name="-a"
 243         fi
 244
 245         if [ -z $channel_name ]; then
 246                 # default channel if none specified
 247                 chan=""
 248         else
 249                 chan="-c $channel_name"
 250         fi
 251
 252         $TESTDIR/../src/bin/lttng/$LTTNG_BIN disable-event --syscall "$syscall_name" $chan -s $sess_name -k 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
 253
 254         ret=$?
 255         if [[ $expected_to_fail -eq "1" ]]; then
 256                 test $ret -ne "0"
 257                 ok $? "Disable kernel syscall $syscall_name for session $sess_name on channel $channel_name failed as expected"
 258         else
 259                 ok $ret "Disable kernel syscall $syscall_name for session $sess_name on channel $channel_name"
 260         fi
 261 }
 262
 263 function lttng_disable_kernel_syscall_ok()
 264 {
 265         lttng_disable_kernel_syscall 0 "$@"
 266 }
 267
 268 function lttng_disable_kernel_syscall_fail()
 269 {
 270         lttng_disable_kernel_syscall 1 "$@"
 271 }
 272
 273 function lttng_enable_kernel_channel()
 274 {
 275         local withtap=$1
 276         local expected_to_fail=$2
 277         local sess_name=$3
 278         local channel_name=$4
 279         local opt=$5
 280
 281         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-channel -k $channel_name -s $sess_name $opt 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
 282         ret=$?
 283         if [[ $expected_to_fail -eq "1" ]]; then
 284                 test "$ret" -ne "0"
 285                 ret=$?
 286                 if [ $withtap -eq "1" ]; then
 287                         ok $ret "Enable channel $channel_name for session $sess_name failed as expected"
 288                 fi
 289         else
 290                 if [ $withtap -eq "1" ]; then
 291                         ok $ret "Enable channel $channel_name for session $sess_name"
 292                 fi
 293         fi
 294 }
 295
 296 function lttng_enable_kernel_channel_ok()
 297 {
 298         lttng_enable_kernel_channel 1 0 "$@"
 299 }
 300
 301 function lttng_enable_kernel_channel_fail()
 302 {
 303         lttng_enable_kernel_channel 1 1 "$@"
 304 }
 305
 306 function lttng_enable_kernel_channel_notap()
 307 {
 308         lttng_enable_kernel_channel 0 0 "$@"
 309 }
 310
 311 function enable_kernel_lttng_channel_ok()
 312 {
 313         lttng_enable_kernel_channel 1 0 "$@"
 314 }
 315
 316 function lttng_disable_kernel_channel()
 317 {
 318         local expected_to_fail=$1
 319         local sess_name=$2
 320         local channel_name=$3
 321
 322         $TESTDIR/../src/bin/lttng/$LTTNG_BIN disable-channel -k $channel_name -s $sess_name 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
 323         ret=$?
 324         if [[ $expected_to_fail -eq "1" ]]; then
 325                 test "$ret" -ne "0"
 326                 ok $? "Disable channel $channel_name for session $sess_name failed as expected"
 327         else
 328                 ok $ret "Disable channel $channel_name for session $sess_name"
 329         fi
 330 }
 331
 332 function lttng_disable_kernel_channel_ok()
 333 {
 334         lttng_disable_kernel_channel 0 "$@"
 335 }
 336
 337 function lttng_disable_kernel_channel_fail()
 338 {
 339         lttng_disable_kernel_channel 1 "$@"
 340 }
 341
 342 function start_lttng_relayd_opt()
 343 {
 344         local withtap=$1
 345         local process_mode=$2
 346         local opt=$3
 347
 348         DIR=$(readlink -f $TESTDIR)
 349
 350         if [ -z $(pgrep $RELAYD_MATCH) ]; then
 351                 $DIR/../src/bin/lttng-relayd/$RELAYD_BIN $process_mode $opt 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
 352                 #$DIR/../src/bin/lttng-relayd/$RELAYD_BIN $opt -vvv >>/tmp/relayd.log 2>&1 &
 353                 if [ $? -eq 1 ]; then
 354                         if [ $withtap -eq "1" ]; then
 355                                 fail "Start lttng-relayd (process mode: $process_mode opt: $opt)"
 356                         fi
 357                         return 1
 358                 else
 359                         if [ $withtap -eq "1" ]; then
 360                                 pass "Start lttng-relayd (process mode: $process_mode opt: $opt)"
 361                         fi
 362                 fi
 363         else
 364                 pass "Start lttng-relayd (opt: $opt)"
 365         fi
 366
 367         RELAYD_PIDS=$(pgrep $RELAYD_MATCH)
 368 }
 369
 370 function start_lttng_relayd()
 371 {
 372         start_lttng_relayd_opt 1 "-b" "$@"
 373 }
 374
 375 function start_lttng_relayd_notap()
 376 {
 377         start_lttng_relayd_opt 0 "-b" "$@"
 378 }
 379
 380 function stop_lttng_relayd_opt()
 381 {
 382         local withtap=$1
 383
 384         if [ $withtap -eq "1" ]; then
 385                 diag "Killing lttng-relayd (pid: $RELAYD_PIDS)"
 386         fi
 387         kill $RELAYD_PIDS 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
 388         retval=$?
 389
 390         if [ $? -eq 1 ]; then
 391                 if [ $withtap -eq "1" ]; then
 392                         fail "Kill relay daemon"
 393                 fi
 394                 return 1
 395         else
 396                 out=1
 397                 while [ -n "$out" ]; do
 398                         out=$(pgrep $RELAYD_MATCH)
 399                         sleep 0.5
 400                 done
 401                 if [ $withtap -eq "1" ]; then
 402                         pass "Kill relay daemon"
 403                 fi
 404         fi
 405         RELAYD_PIDS=""
 406         return $retval
 407 }
 408
 409 function stop_lttng_relayd()
 410 {
 411         stop_lttng_relayd_opt 1 "$@"
 412 }
 413
 414 function stop_lttng_relayd_notap()
 415 {
 416         stop_lttng_relayd_opt 0 "$@"
 417 }
 418
 419 #First arg: show tap output
 420 #Second argument: load path for automatic loading
 421 function start_lttng_sessiond_opt()
 422 {
 423         local withtap=$1
 424         local load_path=$2
 425
 426         local env_vars=""
 427         local consumerd=""
 428         local long_bit_value=$(getconf LONG_BIT)
 429
 430         if [ -n $TEST_NO_SESSIOND ] && [ "$TEST_NO_SESSIOND" == "1" ]; then
 431                 # Env variable requested no session daemon
 432                 return
 433         fi
 434
 435         DIR=$(readlink -f $TESTDIR)
 436
 437         # Get long_bit value for 32/64 consumerd
 438         case "$long_bit_value" in
 439                 32)
 440                         consumerd="--consumerd32-path=$DIR/../src/bin/lttng-consumerd/lttng-consumerd"
 441                         ;;
 442                 64)
 443                         consumerd="--consumerd64-path=$DIR/../src/bin/lttng-consumerd/lttng-consumerd"
 444                         ;;
 445                 *)
 446                         return
 447                         ;;
 448         esac
 449
 450         # Check for env. variable. Allow the use of LD_PRELOAD etc.
 451         if [[ "x${LTTNG_SESSIOND_ENV_VARS}" != "x" ]]; then
 452                 env_vars=${LTTNG_SESSIOND_ENV_VARS}
 453         fi
 454
 455         validate_kernel_version
 456         if [ $? -ne 0 ]; then
 457             fail "Start session daemon"
 458             BAIL_OUT "*** Kernel too old for session daemon tests ***"
 459         fi
 460
 461         : ${LTTNG_SESSION_CONFIG_XSD_PATH=${DIR}/../src/common/config/}
 462         export LTTNG_SESSION_CONFIG_XSD_PATH
 463
 464         if [ -z $(pgrep ${SESSIOND_MATCH}) ]; then
 465                 # Have a load path ?
 466                 if [ -n "$load_path" ]; then
 467                         env $env_vars $DIR/../src/bin/lttng-sessiond/$SESSIOND_BIN --load "$load_path" --background $consumerd
 468                 else
 469                         env $env_vars $DIR/../src/bin/lttng-sessiond/$SESSIOND_BIN --background $consumerd
 470                 fi
 471                 #$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
 472                 status=$?
 473                 if [ $withtap -eq "1" ]; then
 474                         ok $status "Start session daemon"
 475                 fi
 476         fi
 477         SESSIOND_PIDS=$(pgrep $SESSIOND_MATCH)
 478 }
 479
 480 function start_lttng_sessiond()
 481 {
 482         start_lttng_sessiond_opt 1 "$@"
 483 }
 484
 485 function start_lttng_sessiond_notap()
 486 {
 487         start_lttng_sessiond_opt 0 "$@"
 488 }
 489
 490 function stop_lttng_sessiond_opt()
 491 {
 492         local withtap=$1
 493         local signal=$2
 494         local kill_opt=""
 495
 496         if [ -n $TEST_NO_SESSIOND ] && [ "$TEST_NO_SESSIOND" == "1" ]; then
 497                 # Env variable requested no session daemon
 498                 return
 499         fi
 500
 501         local pids="${SESSIOND_PIDS} $(pgrep $RUNAS_MATCH)"
 502
 503         if [ -n "$2" ]; then
 504                 kill_opt="$kill_opt -s $signal"
 505         fi
 506         if [ $withtap -eq "1" ]; then
 507                 diag "Killing $SESSIOND_BIN and lt-$SESSIOND_BIN pids: $(echo $pids | tr '\n' ' ')"
 508         fi
 509         kill $kill_opt $pids 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
 510
 511         if [ $? -eq 1 ]; then
 512                 if [ $withtap -eq "1" ]; then
 513                         fail "Kill sessions daemon"
 514                 fi
 515         else
 516                 out=1
 517                 while [ -n "$out" ]; do
 518                         out=$(pgrep ${SESSIOND_MATCH})
 519                         sleep 0.5
 520                 done
 521                 out=1
 522                 while [ -n "$out" ]; do
 523                         out=$(pgrep $CONSUMERD_MATCH)
 524                         sleep 0.5
 525                 done
 526
 527                 SESSIOND_PIDS=""
 528                 if [ $withtap -eq "1" ]; then
 529                         pass "Kill session daemon"
 530                 fi
 531         fi
 532 }
 533
 534 function stop_lttng_sessiond()
 535 {
 536         stop_lttng_sessiond_opt 1 "$@"
 537 }
 538
 539 function stop_lttng_sessiond_notap()
 540 {
 541         stop_lttng_sessiond_opt 0 "$@"
 542 }
 543
 544 function sigstop_lttng_sessiond_opt()
 545 {
 546         local withtap=$1
 547         local signal=SIGSTOP
 548         local kill_opt=""
 549
 550         if [ -n $TEST_NO_SESSIOND ] && [ "$TEST_NO_SESSIOND" == "1" ]; then
 551                 # Env variable requested no session daemon
 552                 return
 553         fi
 554
 555         PID_SESSIOND="$(pgrep ${SESSIOND_MATCH}) $(pgrep $RUNAS_MATCH)"
 556
 557         kill_opt="$kill_opt -s $signal"
 558
 559         if [ $withtap -eq "1" ]; then
 560                 diag "Sending SIGSTOP to lt-$SESSIOND_BIN and $SESSIOND_BIN pids: $(echo $PID_SESSIOND | tr '\n' ' ')"
 561         fi
 562         kill $kill_opt $PID_SESSIOND 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
 563
 564         if [ $? -eq 1 ]; then
 565                 if [ $withtap -eq "1" ]; then
 566                         fail "Sending SIGSTOP to session daemon"
 567                 fi
 568         else
 569                 out=1
 570                 while [ $out -ne 0 ]; do
 571                         pid=$(pgrep $SESSIOND_MATCH)
 572
 573                         # Wait until state becomes stopped for session
 574                         # daemon(s).
 575                         out=0
 576                         for sessiond_pid in $pid; do
 577                                 state=$(ps -p $sessiond_pid -o state= )
 578                                 if [[ -n "$state" && "$state" != "T" ]]; then
 579                                         out=1
 580                                 fi
 581                         done
 582                         sleep 0.5
 583                 done
 584                 if [ $withtap -eq "1" ]; then
 585                         pass "Sending SIGSTOP to session daemon"
 586                 fi
 587         fi
 588 }
 589
 590 function sigstop_lttng_sessiond()
 591 {
 592         sigstop_lttng_sessiond_opt 1 "$@"
 593 }
 594
 595 function sigstop_lttng_sessiond_notap()
 596 {
 597         sigstop_lttng_sessiond_opt 0 "$@"
 598 }
 599
 600 function stop_lttng_consumerd_opt()
 601 {
 602         local withtap=$1
 603         local signal=$2
 604         local kill_opt=""
 605
 606         PID_CONSUMERD=$(pgrep $CONSUMERD_MATCH)
 607
 608         if [ -n "$2" ]; then
 609                 kill_opt="$kill_opt -s $signal"
 610         fi
 611
 612         if [ $withtap -eq "1" ]; then
 613                 diag "Killing $CONSUMERD_BIN pids: $(echo $PID_CONSUMERD | tr '\n' ' ')"
 614         fi
 615         kill $kill_opt $PID_CONSUMERD 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
 616         retval=$?
 617         set +x
 618
 619         if [ $? -eq 1 ]; then
 620                 if [ $withtap -eq "1" ]; then
 621                         fail "Kill consumer daemon"
 622                 fi
 623                 return 1
 624         else
 625                 out=1
 626                 while [ $out -ne 0 ]; do
 627                         pid=$(pgrep $CONSUMERD_MATCH)
 628
 629                         # If consumerds are still present check their status.
 630                         # A zombie status qualifies the consumerd as *killed*
 631                         out=0
 632                         for consumer_pid in $pid; do
 633                                 state=$(ps -p $consumer_pid -o state= )
 634                                 if [[ -n "$state" && "$state" != "Z" ]]; then
 635                                         out=1
 636                                 fi
 637                         done
 638                         sleep 0.5
 639                 done
 640                 if [ $withtap -eq "1" ]; then
 641                         pass "Kill consumer daemon"
 642                 fi
 643         fi
 644         return $retval
 645 }
 646
 647 function stop_lttng_consumerd()
 648 {
 649         stop_lttng_consumerd_opt 1 "$@"
 650 }
 651
 652 function stop_lttng_consumerd_notap()
 653 {
 654         stop_lttng_consumerd_opt 0 "$@"
 655 }
 656
 657 function sigstop_lttng_consumerd_opt()
 658 {
 659         local withtap=$1
 660         local signal=SIGSTOP
 661         local kill_opt=""
 662
 663         PID_CONSUMERD=$(pgrep $CONSUMERD_MATCH)
 664
 665         kill_opt="$kill_opt -s $signal"
 666
 667         if [ $withtap -eq "1" ]; then
 668                 diag "Sending SIGSTOP to $CONSUMERD_BIN pids: $(echo $PID_CONSUMERD | tr '\n' ' ')"
 669         fi
 670         kill $kill_opt $PID_CONSUMERD 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
 671         retval=$?
 672         set +x
 673
 674         if [ $? -eq 1 ]; then
 675                 if [ $withtap -eq "1" ]; then
 676                         fail "Sending SIGSTOP to consumer daemon"
 677                 fi
 678                 return 1
 679         else
 680                 out=1
 681                 while [ $out -ne 0 ]; do
 682                         pid=$(pgrep $CONSUMERD_MATCH)
 683
 684                         # Wait until state becomes stopped for all
 685                         # consumers.
 686                         out=0
 687                         for consumer_pid in $pid; do
 688                                 state=$(ps -p $consumer_pid -o state= )
 689                                 if [[ -n "$state" && "$state" != "T" ]]; then
 690                                         out=1
 691                                 fi
 692                         done
 693                         sleep 0.5
 694                 done
 695                 if [ $withtap -eq "1" ]; then
 696                         pass "Sending SIGSTOP to consumer daemon"
 697                 fi
 698         fi
 699         return $retval
 700 }
 701
 702 function sigstop_lttng_consumerd()
 703 {
 704         sigstop_lttng_consumerd_opt 1 "$@"
 705 }
 706
 707 function sigstop_lttng_consumerd_notap()
 708 {
 709         sigstop_lttng_consumerd_opt 0 "$@"
 710 }
 711
 712 function list_lttng_with_opts ()
 713 {
 714         local opts=$1
 715         $TESTDIR/../src/bin/lttng/$LTTNG_BIN list $opts 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
 716         ok $? "Lttng-tool list command with option $opts"
 717 }
 718
 719 function create_lttng_session_no_output ()
 720 {
 721         local sess_name=$1
 722
 723         $TESTDIR/../src/bin/lttng/$LTTNG_BIN create $sess_name --no-output 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
 724         ok $? "Create session $sess_name in no-output mode"
 725 }
 726
 727 function create_lttng_session_uri () {
 728         local sess_name=$1
 729         local uri=$2
 730         local opts="${@:3}"
 731
 732         $TESTDIR/../src/bin/lttng/$LTTNG_BIN create $sess_name -U $uri $opts 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
 733         ok $? "Create session $sess_name with uri:$uri and opts: $opts"
 734 }
 735
 736 function create_lttng_session ()
 737 {
 738         local withtap=$1
 739         local expected_to_fail=$2
 740         local sess_name=$3
 741         local trace_path=$4
 742         local opt=$5
 743
 744         $TESTDIR/../src/bin/lttng/$LTTNG_BIN create $sess_name -o $trace_path $opt > $OUTPUT_DEST
 745         ret=$?
 746         if [ $expected_to_fail -eq "1" ]; then
 747                 test "$ret" -ne "0"
 748                 ret=$?
 749                 if [ $withtap -eq "1" ]; then
 750                         ok $ret "Create session $sess_name in $trace_path failed as expected"
 751                 fi
 752         else
 753                 if [ $withtap -eq "1" ]; then
 754                         ok $ret "Create session $sess_name in $trace_path"
 755                 fi
 756         fi
 757         return $ret
 758 }
 759
 760 function create_lttng_session_ok ()
 761 {
 762         create_lttng_session 1 0 "$@"
 763 }
 764
 765 function create_lttng_session_fail ()
 766 {
 767         create_lttng_session 1 1 "$@"
 768 }
 769
 770 function create_lttng_session_notap ()
 771 {
 772         create_lttng_session 0 0 "$@"
 773 }
 774
 775
 776 function enable_ust_lttng_channel ()
 777 {
 778         local withtap=$1
 779         local expected_to_fail=$2
 780         local sess_name=$3
 781         local channel_name=$4
 782         local opt=$5
 783
 784         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-channel -u $channel_name -s $sess_name $opt 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
 785         ret=$?
 786         if [[ $expected_to_fail -eq "1" ]]; then
 787                 test "$ret" -ne "0"
 788                 ret=$?
 789                 if [ $withtap -eq "1" ]; then
 790                         ok $ret "Enable channel $channel_name for session $sess_name failed as expected"
 791                 fi
 792         else
 793                 if [ $withtap -eq "1" ]; then
 794                         ok $ret "Enable channel $channel_name for session $sess_name"
 795                 fi
 796         fi
 797         return $ret
 798 }
 799
 800 function enable_ust_lttng_channel_ok ()
 801 {
 802         enable_ust_lttng_channel 1 0 "$@"
 803 }
 804
 805 function enable_ust_lttng_channel_fail ()
 806 {
 807         enable_ust_lttng_channel 1 1 "$@"
 808 }
 809
 810 function enable_ust_lttng_channel_notap ()
 811 {
 812         enable_ust_lttng_channel 0 0 "$@"
 813 }
 814
 815 function disable_ust_lttng_channel()
 816 {
 817         local sess_name=$1
 818         local channel_name=$2
 819
 820         $TESTDIR/../src/bin/lttng/$LTTNG_BIN disable-channel -u $channel_name -s $sess_name 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
 821         ok $? "Disable channel $channel_name for session $sess_name"
 822 }
 823
 824 function enable_lttng_mmap_overwrite_kernel_channel()
 825 {
 826         local sess_name=$1
 827         local channel_name=$2
 828
 829         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-channel -s $sess_name $channel_name -k --output mmap --overwrite 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
 830         ok $? "Enable channel $channel_name for session $sess_name"
 831 }
 832
 833 function enable_lttng_mmap_discard_small_kernel_channel()
 834 {
 835         local sess_name=$1
 836         local channel_name=$2
 837
 838         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-channel -s $sess_name $channel_name -k --output mmap --discard --subbuf-size=$(getconf PAGE_SIZE) --num-subbuf=2 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
 839         ok $? "Enable small discard channel $channel_name for session $sess_name"
 840 }
 841
 842 function enable_lttng_mmap_overwrite_small_kernel_channel()
 843 {
 844         local sess_name=$1
 845         local channel_name=$2
 846
 847         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-channel -s $sess_name $channel_name -k --output mmap --overwrite --subbuf-size=$(getconf PAGE_SIZE) --num-subbuf=2 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
 848         ok $? "Enable small discard channel $channel_name for session $sess_name"
 849 }
 850
 851 function enable_lttng_mmap_overwrite_ust_channel()
 852 {
 853         local sess_name=$1
 854         local channel_name=$2
 855
 856         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-channel -s $sess_name $channel_name -u --output mmap --overwrite 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
 857         ok $? "Enable channel $channel_name for session $sess_name"
 858 }
 859
 860 function enable_ust_lttng_event ()
 861 {
 862         local withtap=$1
 863         local expected_to_fail=$2
 864         local sess_name=$3
 865         local event_name="$4"
 866         local channel_name=$5
 867
 868         if [ -z $channel_name ]; then
 869                 # default channel if none specified
 870                 chan=""
 871         else
 872                 chan="-c $channel_name"
 873         fi
 874
 875         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event "$event_name" $chan -s $sess_name -u 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
 876         ret=$?
 877         if [[ $expected_to_fail -eq "1" ]]; then
 878                 test $ret -ne "0"
 879                 ret=$?
 880                 if [[ $withtap -eq "1" ]]; then
 881                         ok $ret "Enable ust event $event_name for session $session_name failed as expected"
 882                 fi
 883         else
 884                 if [[ $withtap -eq "1" ]]; then
 885                         ok $ret "Enable ust event $event_name for session $sess_name"
 886                 fi
 887         fi
 888         return $ret
 889 }
 890
 891 function enable_ust_lttng_event_ok ()
 892 {
 893         enable_ust_lttng_event 1 0 "$@"
 894 }
 895
 896 function enable_ust_lttng_event_fail ()
 897 {
 898         enable_ust_lttng_event 1 1 "$@"
 899 }
 900
 901 function enable_ust_lttng_event_notap ()
 902 {
 903         enable_ust_lttng_event 0 0 "$@"
 904 }
 905
 906 function enable_jul_lttng_event()
 907 {
 908         sess_name=$1
 909         event_name="$2"
 910         channel_name=$3
 911
 912         if [ -z $channel_name ]; then
 913                 # default channel if none specified
 914                 chan=""
 915         else
 916                 chan="-c $channel_name"
 917         fi
 918
 919         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event "$event_name" $chan -s $sess_name -j 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
 920         ok $? "Enable JUL event $event_name for session $sess_name"
 921 }
 922
 923 function enable_jul_lttng_event_loglevel()
 924 {
 925         local sess_name=$1
 926         local event_name="$2"
 927         local loglevel=$3
 928         local channel_name=$4
 929
 930         if [ -z $channel_name ]; then
 931                 # default channel if none specified
 932                 chan=""
 933         else
 934                 chan="-c $channel_name"
 935         fi
 936
 937         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event --loglevel $loglevel "$event_name" $chan -s $sess_name -j 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
 938         ok $? "Enable JUL event $event_name for session $sess_name with loglevel $loglevel"
 939 }
 940
 941 function enable_log4j_lttng_event()
 942 {
 943         sess_name=$1
 944         event_name="$2"
 945         channel_name=$3
 946
 947         if [ -z $channel_name ]; then
 948                 # default channel if none specified
 949                 chan=""
 950         else
 951                 chan="-c $channel_name"
 952         fi
 953
 954         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event "$event_name" $chan -s $sess_name -l 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
 955         ok $? "Enable LOG4J event $event_name for session $sess_name"
 956 }
 957
 958 function enable_log4j_lttng_event_loglevel()
 959 {
 960         local sess_name=$1
 961         local event_name="$2"
 962         local loglevel=$3
 963         local channel_name=$4
 964
 965         if [ -z $channel_name ]; then
 966                 # default channel if none specified
 967                 chan=""
 968         else
 969                 chan="-c $channel_name"
 970         fi
 971
 972         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event --loglevel $loglevel "$event_name" $chan -s $sess_name -l 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
 973         ok $? "Enable LOG4J event $event_name for session $sess_name with loglevel $loglevel"
 974 }
 975
 976 function enable_python_lttng_event()
 977 {
 978         sess_name=$1
 979         event_name="$2"
 980         channel_name=$3
 981
 982         if [ -z $channel_name ]; then
 983                 # default channel if none specified
 984                 chan=""
 985         else
 986                 chan="-c $channel_name"
 987         fi
 988
 989         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event "$event_name" $chan -s $sess_name -p 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
 990         ok $? "Enable Python event $event_name for session $sess_name"
 991 }
 992
 993 function enable_python_lttng_event_loglevel()
 994 {
 995         local sess_name=$1
 996         local event_name="$2"
 997         local loglevel=$3
 998         local channel_name=$4
 999
1000         if [ -z $channel_name ]; then
1001                 # default channel if none specified
1002                 chan=""
1003         else
1004                 chan="-c $channel_name"
1005         fi
1006
1007         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event --loglevel $loglevel "$event_name" $chan -s $sess_name -p 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
1008         ok $? "Enable Python event $event_name for session $sess_name with loglevel $loglevel"
1009 }
1010
1011 function enable_ust_lttng_event_filter()
1012 {
1013         local sess_name="$1"
1014         local event_name="$2"
1015         local filter="$3"
1016
1017         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event "$event_name" -s $sess_name -u --filter "$filter" 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
1018         ok $? "Enable event $event_name with filtering for session $sess_name"
1019 }
1020
1021 function enable_ust_lttng_event_loglevel()
1022 {
1023         local sess_name="$1"
1024         local event_name="$2"
1025         local loglevel="$3"
1026
1027         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event "$event_name" -s $sess_name -u --loglevel $loglevel 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
1028         ok $? "Enable event $event_name with loglevel $loglevel"
1029 }
1030
1031 function enable_ust_lttng_event_loglevel_only()
1032 {
1033         local sess_name="$1"
1034         local event_name="$2"
1035         local loglevel="$3"
1036
1037         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event "$event_name" -s $sess_name -u --loglevel-only $loglevel 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
1038         ok $? "Enable event $event_name with loglevel-only $loglevel"
1039 }
1040
1041 function disable_ust_lttng_event ()
1042 {
1043         local sess_name="$1"
1044         local event_name="$2"
1045         local channel_name="$3"
1046
1047         if [ -z $channel_name ]; then
1048                 # default channel if none specified
1049                 chan=""
1050         else
1051                 chan="-c $channel_name"
1052         fi
1053
1054         $TESTDIR/../src/bin/lttng/$LTTNG_BIN disable-event "$event_name" -s $sess_name $chan -u 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
1055         ok $? "Disable event $event_name for session $sess_name"
1056 }
1057
1058 function disable_jul_lttng_event ()
1059 {
1060         local sess_name="$1"
1061         local event_name="$2"
1062
1063         $TESTDIR/../src/bin/lttng/$LTTNG_BIN disable-event "$event_name" -s $sess_name -j >/dev/null 2>&1
1064         ok $? "Disable JUL event $event_name for session $sess_name"
1065 }
1066
1067 function disable_log4j_lttng_event ()
1068 {
1069         local sess_name="$1"
1070         local event_name="$2"
1071
1072         $TESTDIR/../src/bin/lttng/$LTTNG_BIN disable-event "$event_name" -s $sess_name -l >/dev/null 2>&1
1073         ok $? "Disable LOG4J event $event_name for session $sess_name"
1074 }
1075
1076 function disable_python_lttng_event ()
1077 {
1078         local sess_name="$1"
1079         local event_name="$2"
1080
1081         $TESTDIR/../src/bin/lttng/$LTTNG_BIN disable-event "$event_name" -s $sess_name -p 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
1082         ok $? "Disable Python event $event_name for session $sess_name"
1083 }
1084
1085 function start_lttng_tracing ()
1086 {
1087         local expected_to_fail=$1
1088         local sess_name=$2
1089
1090         $TESTDIR/../src/bin/lttng/$LTTNG_BIN start $sess_name 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
1091         ret=$?
1092         if [[ $expected_to_fail -eq "1" ]]; then
1093                 test "$ret" -ne "0"
1094                 ok $? "Start tracing for session $sess_name failed as expected"
1095         else
1096                 ok $ret "Start tracing for session $sess_name"
1097         fi
1098 }
1099
1100 function start_lttng_tracing_ok ()
1101 {
1102         start_lttng_tracing 0 "$@"
1103 }
1104
1105 function start_lttng_tracing_fail ()
1106 {
1107         start_lttng_tracing 1 "$@"
1108 }
1109
1110 function stop_lttng_tracing ()
1111 {
1112         local expected_to_fail=$1
1113         local sess_name=$2
1114
1115         $TESTDIR/../src/bin/lttng/$LTTNG_BIN stop $sess_name 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
1116         ret=$?
1117         if [[ $expected_to_fail -eq "1" ]]; then
1118                 test "$ret" -ne "0"
1119                 ok $? "Stop lttng tracing for session $sess_name failed as expected"
1120         else
1121                 ok $ret "Stop lttng tracing for session $sess_name"
1122         fi
1123 }
1124
1125 function stop_lttng_tracing_ok ()
1126 {
1127         stop_lttng_tracing 0 "$@"
1128 }
1129
1130 function stop_lttng_tracing_fail ()
1131 {
1132         stop_lttng_tracing 1 "$@"
1133 }
1134
1135 function destroy_lttng_session ()
1136 {
1137         local withtap=$1
1138         local expected_to_fail=$2
1139         local sess_name=$3
1140
1141         $TESTDIR/../src/bin/lttng/$LTTNG_BIN destroy $sess_name 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
1142         ret=$?
1143         if [[ $expected_to_fail -eq "1" ]]; then
1144                 test "$ret" -ne "0"
1145                 ret=$?
1146                 if [ $withtap -eq "1" ]; then
1147                         ok $ret "Destroy session $sess_name failed as expected"
1148                 fi
1149         else
1150                 if [ $withtap -eq "1" ]; then
1151                         ok $ret "Destroy session $sess_name"
1152                 fi
1153         fi
1154 }
1155
1156 function destroy_lttng_session_ok ()
1157 {
1158         destroy_lttng_session 1 0 "$@"
1159
1160 }
1161
1162 function destroy_lttng_session_fail ()
1163 {
1164         destroy_lttng_session 1 1 "$@"
1165 }
1166
1167 function destroy_lttng_session_notap ()
1168 {
1169         destroy_lttng_session 0 0 "$@"
1170 }
1171
1172 function destroy_lttng_sessions ()
1173 {
1174         $TESTDIR/../src/bin/lttng/$LTTNG_BIN destroy --all 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
1175         ok $? "Destroy all lttng sessions"
1176 }
1177
1178 function lttng_snapshot_add_output ()
1179 {
1180         local expected_to_fail=$1
1181         local sess_name=$2
1182         local trace_path=$3
1183
1184         $TESTDIR/../src/bin/lttng/$LTTNG_BIN snapshot add-output -s $sess_name file://$trace_path 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
1185         ret=$?
1186         if [[ $expected_to_fail -eq 1 ]]; then
1187                 test "$ret" -ne "0"
1188                 ok $? "Added snapshot output file://$trace_path failed as expected"
1189         else
1190                 ok $ret "Added snapshot output file://$trace_path"
1191         fi
1192 }
1193
1194 function lttng_snapshot_add_output_ok ()
1195 {
1196         lttng_snapshot_add_output 0 "$@"
1197 }
1198
1199 function lttng_snapshot_add_output_fail ()
1200 {
1201         lttng_snapshot_add_output 1 "$@"
1202 }
1203
1204 function lttng_snapshot_del_output ()
1205 {
1206         local expected_to_fail=$1
1207         local sess_name=$2
1208         local id=$3
1209
1210         $TESTDIR/../src/bin/lttng/$LTTNG_BIN snapshot del-output -s $sess_name $id 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
1211         ret=$?
1212         if [[ $expected_to_fail -eq "1" ]]; then
1213                 test "$ret" -ne "0"
1214                 ok $? "Deleted snapshot output id $id failed as expected"
1215         else
1216                 ok $ret "Deleted snapshot output id $id"
1217         fi
1218 }
1219
1220 function lttng_snapshot_del_output_ok ()
1221 {
1222         lttng_snapshot_del_output 0 "$@"
1223 }
1224
1225 function lttng_snapshot_del_output_fail ()
1226 {
1227         lttng_snapshot_del_output 1 "$@"
1228 }
1229
1230 function lttng_snapshot_record ()
1231 {
1232         local sess_name=$1
1233         local trace_path=$2
1234
1235         $TESTDIR/../src/bin/lttng/$LTTNG_BIN snapshot record -s $sess_name 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
1236         ok $? "Snapshot recorded"
1237 }
1238
1239 function lttng_snapshot_list ()
1240 {
1241         local sess_name=$1
1242         $TESTDIR/../src/bin/lttng/$LTTNG_BIN snapshot list-output -s $sess_name 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
1243         ok $? "Snapshot list"
1244 }
1245
1246 function lttng_save()
1247 {
1248         local sess_name=$1
1249         local opts=$2
1250
1251         $TESTDIR/../src/bin/lttng/$LTTNG_BIN save $sess_name $opts 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
1252         ok $? "Session saved"
1253 }
1254
1255 function lttng_load()
1256 {
1257         local expected_to_fail=$1
1258         local opts=$2
1259
1260         $TESTDIR/../src/bin/lttng/$LTTNG_BIN load $opts 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
1261         ret=$?
1262         if [[ $expected_to_fail -eq "1" ]]; then
1263                 test $ret -ne "0"
1264                 ok $? "Load command failed as expected with opts: $opts"
1265         else
1266                 ok $ret "Load command with opts: $opts"
1267         fi
1268 }
1269
1270 function lttng_load_ok()
1271 {
1272         lttng_load 0 "$@"
1273 }
1274
1275 function lttng_load_fail()
1276 {
1277         lttng_load 1 "$@"
1278 }
1279
1280 function lttng_track()
1281 {
1282         local expected_to_fail=$1
1283         local opts=$2
1284         $TESTDIR/../src/bin/lttng/$LTTNG_BIN track $opts >$OUTPUT_DEST
1285         ret=$?
1286         if [[ $expected_to_fail -eq "1" ]]; then
1287                 test $ret -ne "0"
1288                 ok $? "Track command failed as expected with opts: $opts"
1289         else
1290                 ok $ret "Track command with opts: $opts"
1291         fi
1292 }
1293
1294 function lttng_track_ok()
1295 {
1296         lttng_track 0 "$@"
1297 }
1298
1299 function lttng_track_fail()
1300 {
1301         lttng_track 1 "$@"
1302 }
1303
1304 function lttng_untrack()
1305 {
1306         local expected_to_fail=$1
1307         local opts=$2
1308         $TESTDIR/../src/bin/lttng/$LTTNG_BIN untrack $opts >$OUTPUT_DEST
1309         ret=$?
1310         if [[ $expected_to_fail -eq "1" ]]; then
1311                 test $ret -ne "0"
1312                 ok $? "Untrack command failed as expected with opts: $opts"
1313         else
1314                 ok $ret "Untrack command with opts: $opts"
1315         fi
1316 }
1317
1318 function lttng_untrack_ok()
1319 {
1320         lttng_untrack 0 "$@"
1321 }
1322
1323 function lttng_untrack_fail()
1324 {
1325         lttng_untrack 1 "$@"
1326 }
1327
1328 function lttng_track_pid_ok()
1329 {
1330         PID=$1
1331         "$TESTDIR/../src/bin/lttng/$LTTNG_BIN" track --kernel --pid=$PID 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
1332         ok $? "Lttng track pid on the kernel domain"
1333 }
1334
1335 function lttng_untrack_kernel_all_ok()
1336 {
1337         "$TESTDIR/../src/bin/lttng/$LTTNG_BIN" untrack --kernel --pid --all 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
1338         ok $? "Lttng untrack all pid on the kernel domain"
1339 }
1340
1341 function lttng_add_context_list()
1342 {
1343         $TESTDIR/../src/bin/lttng/$LTTNG_BIN add-context --list 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
1344         ret=$?
1345         ok $ret "Context listing"
1346 }
1347
1348 function add_context_lttng()
1349 {
1350         local expected_to_fail="$1"
1351         local domain="$2"
1352         local session_name="$3"
1353         local channel_name="$4"
1354         local type="$5"
1355
1356         $TESTDIR/../src/bin/lttng/$LTTNG_BIN add-context -s $session_name -c $channel_name -t $type $domain  1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
1357         ret=$?
1358         if [[ $expected_to_fail -eq "1" ]]; then
1359                 test $ret -ne "0"
1360                 ok $? "Add context command failed as expected for type: $type"
1361         else
1362                 ok $ret "Add context command for type: $type"
1363         fi
1364 }
1365
1366 function add_context_ust_ok()
1367 {
1368         add_context_lttng 0 -u "$@"
1369 }
1370
1371 function add_context_ust_fail()
1372 {
1373         add_context_lttng 1 -u "$@"
1374 }
1375
1376 function add_context_kernel_ok()
1377 {
1378         add_context_lttng 0 -k "$@"
1379 }
1380
1381 function add_context_kernel_fail()
1382 {
1383         add_context_lttng 1 -k "$@"
1384 }
1385
1386 function validate_metadata_event ()
1387 {
1388         local event_name=$1
1389         local nr_event_id=$2
1390         local trace_path=$3
1391
1392         local metadata_file=$(find $trace_path | grep metadata)
1393         local metadata_path=$(dirname $metadata_file)
1394
1395         which $BABELTRACE_BIN >/dev/null
1396         skip $? -ne 0 "Babeltrace binary not found. Skipping trace matches"
1397
1398         local count=$($BABELTRACE_BIN --output-format=ctf-metadata $metadata_path | grep $event_name | wc -l)
1399
1400         if [ "$count" -ne "$nr_event_id" ]; then
1401                 fail "Metadata match with the metadata of $count event(s) named $event_name"
1402                 diag "$count matching event id found in metadata"
1403         else
1404                 pass "Metadata match with the metadata of $count event(s) named $event_name"
1405         fi
1406
1407 }
1408
1409 function trace_matches ()
1410 {
1411         local event_name=$1
1412         local nr_iter=$2
1413         local trace_path=$3
1414
1415         which $BABELTRACE_BIN >/dev/null
1416         skip $? -ne 0 "Babeltrace binary not found. Skipping trace matches"
1417
1418         local count=$($BABELTRACE_BIN $trace_path | grep $event_name | wc -l)
1419
1420         if [ "$count" -ne "$nr_iter" ]; then
1421                 fail "Trace match"
1422                 diag "$count matching events found in trace"
1423         else
1424                 pass "Trace match"
1425         fi
1426 }
1427
1428 function trace_match_only()
1429 {
1430         local event_name=$1
1431         local nr_iter=$2
1432         local trace_path=$3
1433
1434         which $BABELTRACE_BIN >/dev/null
1435         skip $? -ne 0 "Babeltrace binary not found. Skipping trace matches"
1436
1437         local count=$($BABELTRACE_BIN $trace_path | grep $event_name | wc -l)
1438         local total=$($BABELTRACE_BIN $trace_path | wc -l)
1439
1440         if [ "$nr_iter" -eq "$count" ] && [ "$total" -eq "$nr_iter" ]; then
1441                 pass "Trace match with $total event $event_name"
1442         else
1443                 fail "Trace match"
1444                 diag "$total event(s) found, expecting $nr_iter of event $event_name and only found $count"
1445         fi
1446 }
1447
1448 function validate_trace
1449 {
1450         local event_name=$1
1451         local trace_path=$2
1452
1453         which $BABELTRACE_BIN >/dev/null
1454         if [ $? -ne 0 ]; then
1455             skip 0 "Babeltrace binary not found. Skipping trace validation"
1456         fi
1457
1458         OLDIFS=$IFS
1459         IFS=","
1460         for i in $event_name; do
1461                 traced=$($BABELTRACE_BIN $trace_path 2>/dev/null | grep $i | wc -l)
1462                 if [ "$traced" -ne 0 ]; then
1463                         pass "Validate trace for event $i, $traced events"
1464                 else
1465                         fail "Validate trace for event $i"
1466                         diag "Found $traced occurences of $i"
1467                 fi
1468         done
1469         ret=$?
1470         IFS=$OLDIFS
1471         return $ret
1472 }
1473
1474 function validate_trace_count
1475 {
1476         local event_name=$1
1477         local trace_path=$2
1478         local expected_count=$3
1479
1480         which $BABELTRACE_BIN >/dev/null
1481         if [ $? -ne 0 ]; then
1482             skip 0 "Babeltrace binary not found. Skipping trace validation"
1483         fi
1484
1485         cnt=0
1486         OLDIFS=$IFS
1487         IFS=","
1488         for i in $event_name; do
1489                 traced=$($BABELTRACE_BIN $trace_path 2>/dev/null | grep $i | wc -l)
1490                 if [ "$traced" -ne 0 ]; then
1491                         pass "Validate trace for event $i, $traced events"
1492                 else
1493                         fail "Validate trace for event $i"
1494                         diag "Found $traced occurences of $i"
1495                 fi
1496                 cnt=$(($cnt + $traced))
1497         done
1498         IFS=$OLDIFS
1499         test $cnt -eq $expected_count
1500         ok $? "Read a total of $cnt events, expected $expected_count"
1501 }
1502
1503 function trace_first_line
1504 {
1505         local trace_path=$1
1506
1507         which $BABELTRACE_BIN >/dev/null
1508         if [ $? -ne 0 ]; then
1509             skip 0 "Babeltrace binary not found. Skipping trace validation"
1510         fi
1511
1512         $BABELTRACE_BIN $trace_path 2>/dev/null | head -n 1
1513 }
1514
1515 function validate_trace_exp()
1516 {
1517         local event_exp=$1
1518         local trace_path=$2
1519
1520         which $BABELTRACE_BIN >/dev/null
1521         skip $? -ne 0 "Babeltrace binary not found. Skipping trace validation"
1522
1523         traced=$($BABELTRACE_BIN $trace_path 2>/dev/null | grep --extended-regexp ${event_exp} | wc -l)
1524         if [ "$traced" -ne 0 ]; then
1525                 pass "Validate trace for expression '${event_exp}', $traced events"
1526         else
1527                 fail "Validate trace for expression '${event_exp}'"
1528                 diag "Found $traced occurences of '${event_exp}'"
1529         fi
1530         ret=$?
1531         return $ret
1532 }
1533
1534 function validate_trace_only_exp()
1535 {
1536         local event_exp=$1
1537         local trace_path=$2
1538
1539         which $BABELTRACE_BIN >/dev/null
1540         skip $? -ne 0 "Babeltrace binary not found. Skipping trace matches"
1541
1542         local count=$($BABELTRACE_BIN $trace_path | grep --extended-regexp ${event_exp} | wc -l)
1543         local total=$($BABELTRACE_BIN $trace_path | wc -l)
1544
1545         if [ "$count" -ne 0 ] && [ "$total" -eq "$count" ]; then
1546                 pass "Trace match with $total for expression '${event_exp}'"
1547         else
1548                 fail "Trace match"
1549                 diag "$total syscall event(s) found, only syscalls matching expression '${event_exp}' ($count occurrences) are expected"
1550         fi
1551         ret=$?
1552         return $ret
1553 }
1554
1555 function validate_trace_empty()
1556 {
1557         local trace_path=$1
1558
1559         which $BABELTRACE_BIN >/dev/null
1560         if [ $? -ne 0 ]; then
1561             skip 0 "Babeltrace binary not found. Skipping trace validation"
1562         fi
1563
1564         events=$($BABELTRACE_BIN $trace_path 2>/dev/null)
1565         ret=$?
1566         if [ $ret -ne 0 ]; then
1567                 fail "Failed to parse trace"
1568                 return $ret
1569         fi
1570
1571         traced=$(echo -n "$events" | wc -l)
1572         if [ "$traced" -eq 0 ]; then
1573                 pass "Validate empty trace"
1574         else
1575                 fail "Validate empty trace"
1576                 diag "Found $traced events in trace"
1577         fi
1578         ret=$?
1579         return $ret
1580 }
1581
1582 function regenerate_metadata ()
1583 {
1584         local expected_to_fail=$1
1585         local sess_name=$2
1586
1587         $TESTDIR/../src/bin/lttng/$LTTNG_BIN regenerate metadata -s $sess_name 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
1588         ret=$?
1589         if [[ $expected_to_fail -eq "1" ]]; then
1590                 test "$ret" -ne "0"
1591                 ok $? "Expected fail on regenerate metadata $sess_name"
1592         else
1593                 ok $ret "Metadata regenerate $sess_name"
1594         fi
1595 }
1596
1597 function regenerate_metadata_ok ()
1598 {
1599         regenerate_metadata 0 "$@"
1600 }
1601
1602 function regenerate_metadata_fail ()
1603 {
1604         regenerate_metadata 1 "$@"
1605 }
1606
1607 function regenerate_statedump ()
1608 {
1609         local expected_to_fail=$1
1610         local sess_name=$2
1611
1612         $TESTDIR/../src/bin/lttng/$LTTNG_BIN regenerate statedump -s $sess_name 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
1613         ret=$?
1614         if [[ $expected_to_fail -eq "1" ]]; then
1615                 test "$ret" -ne "0"
1616                 ok $? "Expected fail on regenerate statedump $sess_name"
1617         else
1618                 ok $ret "Metadata regenerate $sess_name"
1619         fi
1620 }
1621
1622 function regenerate_statedump_ok ()
1623 {
1624         regenerate_statedump 0 "$@"
1625 }
1626
1627 function regenerate_statedump_fail ()
1628 {
1629         regenerate_statedump 1 "$@"
1630 }
1631
1632 function rotate_session ()
1633 {
1634         local expected_to_fail=$1
1635         local sess_name=$2
1636
1637         $TESTDIR/../src/bin/lttng/$LTTNG_BIN rotate $sess_name 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
1638         ret=$?
1639         if [[ $expected_to_fail -eq "1" ]]; then
1640                 test "$ret" -ne "0"
1641                 ok $? "Expected fail on rotate session $sess_name"
1642         else
1643                 ok $ret "Rotate session $sess_name"
1644         fi
1645 }
1646
1647 function rotate_session_ok ()
1648 {
1649         rotate_session 0 "$@"
1650 }
1651
1652 function rotate_session_fail ()
1653 {
1654         rotate_session 1 "$@"
1655 }
1656
1657 function destructive_tests_enabled ()
1658 {
1659         if [ ${LTTNG_ENABLE_DESTRUCTIVE_TESTS} = "will-break-my-system" ]; then
1660                 return 0
1661         else
1662                 return 1
1663         fi
1664 }
1665
1666 function lttng_enable_rotation_timer ()
1667 {
1668         local expected_to_fail=$1
1669         local sess_name=$2
1670         local period=$3
1671
1672         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-rotation -s $sess_name --timer $period 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
1673         ret=$?
1674         if [[ $expected_to_fail -eq "1" ]]; then
1675                 test "$ret" -ne "0"
1676                 ok $? "Expected fail on rotate session $sess_name"
1677         else
1678                 ok $ret "Rotate session $sess_name"
1679         fi
1680 }
1681
1682 function lttng_enable_rotation_timer_ok ()
1683 {
1684         lttng_enable_rotation_timer 0 $@
1685 }
1686
1687 function lttng_enable_rotation_timer_fail ()
1688 {
1689         lttng_enable_rotation_timer 1 $@
1690 }
1691
1692 function lttng_enable_rotation_size ()
1693 {
1694         local expected_to_fail=$1
1695         local sess_name=$2
1696         local size=$3
1697
1698         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-rotation -s $sess_name --size $size 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
1699         ret=$?
1700         if [[ $expected_to_fail -eq "1" ]]; then
1701                 test "$ret" -ne "0"
1702                 ok $? "Expected fail on rotate session $sess_name"
1703         else
1704                 ok $ret "Rotate session $sess_name"
1705         fi
1706 }
1707
1708 function lttng_enable_rotation_size_ok ()
1709 {
1710         lttng_enable_rotation_size 0 $@
1711 }
1712
1713 function lttng_enable_rotation_size_fail ()
1714 {
1715         lttng_enable_rotation_size 1 $@
1716 }