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 function enable_kernel_lttng_event
 129 {
 130         local withtap="$1"
 131         local expected_to_fail="$2"
 132         local sess_name="$3"
 133         local event_name="$4"
 134         local channel_name="$5"
 135
 136         if [ -z "$event_name" ]; then
 137                 # Enable all event if no event name specified
 138                 event_name="-a"
 139         fi
 140
 141         if [ -z "$channel_name" ]; then
 142                 # default channel if none specified
 143                 chan=""
 144         else
 145                 chan="-c $channel_name"
 146         fi
 147
 148         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event "$event_name" $chan -s $sess_name -k 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
 149         ret=$?
 150         if [[ $expected_to_fail -eq "1" ]]; then
 151                 test $ret -ne "0"
 152                 ret=$?
 153                 if [ $withtap -eq "1" ]; then
 154                         ok $ret "Enable kernel event $event_name for session $session_name on channel $channel_name failed as expected"
 155                 fi
 156         else
 157                 if [ $withtap -eq "1" ]; then
 158                         ok $ret "Enable kernel event $event_name for session $sess_name"
 159                 fi
 160         fi
 161 }
 162
 163 function enable_kernel_lttng_event_ok ()
 164 {
 165         enable_kernel_lttng_event 1 0 "$@"
 166 }
 167
 168 function enable_kernel_lttng_event_fail ()
 169 {
 170         enable_kernel_lttng_event 1 1 "$@"
 171 }
 172
 173 function enable_kernel_lttng_event_notap ()
 174 {
 175         enable_kernel_lttng_event 0 0 "$@"
 176 }
 177
 178 # Old interface
 179 function lttng_enable_kernel_event
 180 {
 181         enable_kernel_lttng_event_ok "$@"
 182 }
 183
 184 function lttng_enable_kernel_syscall()
 185 {
 186         local expected_to_fail=$1
 187         local sess_name=$2
 188         local syscall_name=$3
 189         local channel_name=$4
 190
 191         if [ -z $syscall_name ]; then
 192                 # Enable all event if no syscall name specified
 193                 syscall_name="-a"
 194         fi
 195
 196         if [ -z $channel_name ]; then
 197                 # default channel if none specified
 198                 chan=""
 199         else
 200                 chan="-c $channel_name"
 201         fi
 202
 203         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event --syscall "$syscall_name" $chan -s $sess_name -k 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
 204         ret=$?
 205         if [[ $expected_to_fail -eq "1" ]]; then
 206                 test $ret -ne "0"
 207                 ok $? "Enable kernel syscall $syscall_name for session $sess_name on channel $channel_name fail as expected"
 208         else
 209                 ok $ret "Enable kernel syscall $syscall_name for session $sess_name on channel $channel_name"
 210         fi
 211 }
 212
 213 function lttng_enable_kernel_syscall_ok()
 214 {
 215         lttng_enable_kernel_syscall 0 "$@"
 216 }
 217
 218 function lttng_enable_kernel_syscall_fail()
 219 {
 220         lttng_enable_kernel_syscall 1 "$@"
 221 }
 222
 223 function lttng_disable_kernel_syscall()
 224 {
 225         local expected_to_fail=$1
 226         local sess_name=$2
 227         local syscall_name=$3
 228         local channel_name=$4
 229
 230         if [ -z $syscall_name ]; then
 231                 # Enable all event if no syscall name specified
 232                 syscall_name="-a"
 233         fi
 234
 235         if [ -z $channel_name ]; then
 236                 # default channel if none specified
 237                 chan=""
 238         else
 239                 chan="-c $channel_name"
 240         fi
 241
 242         $TESTDIR/../src/bin/lttng/$LTTNG_BIN disable-event --syscall "$syscall_name" $chan -s $sess_name -k 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
 243
 244         ret=$?
 245         if [[ $expected_to_fail -eq "1" ]]; then
 246                 test $ret -ne "0"
 247                 ok $? "Disable kernel syscall $syscall_name for session $sess_name on channel $channel_name failed as expected"
 248         else
 249                 ok $ret "Disable kernel syscall $syscall_name for session $sess_name on channel $channel_name"
 250         fi
 251 }
 252
 253 function lttng_disable_kernel_syscall_ok()
 254 {
 255         lttng_disable_kernel_syscall 0 "$@"
 256 }
 257
 258 function lttng_disable_kernel_syscall_fail()
 259 {
 260         lttng_disable_kernel_syscall 1 "$@"
 261 }
 262
 263 function lttng_enable_kernel_channel()
 264 {
 265         local withtap=$1
 266         local expected_to_fail=$2
 267         local sess_name=$3
 268         local channel_name=$4
 269         local opt=$5
 270
 271         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-channel -k $channel_name -s $sess_name $opt 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
 272         ret=$?
 273         if [[ $expected_to_fail -eq "1" ]]; then
 274                 test "$ret" -ne "0"
 275                 ret=$?
 276                 if [ $withtap -eq "1" ]; then
 277                         ok $ret "Enable channel $channel_name for session $sess_name failed as expected"
 278                 fi
 279         else
 280                 if [ $withtap -eq "1" ]; then
 281                         ok $ret "Enable channel $channel_name for session $sess_name"
 282                 fi
 283         fi
 284 }
 285
 286 function lttng_enable_kernel_channel_ok()
 287 {
 288         lttng_enable_kernel_channel 1 0 "$@"
 289 }
 290
 291 function lttng_enable_kernel_channel_fail()
 292 {
 293         lttng_enable_kernel_channel 1 1 "$@"
 294 }
 295
 296 function lttng_enable_kernel_channel_notap()
 297 {
 298         lttng_enable_kernel_channel 0 0 "$@"
 299 }
 300
 301 function enable_kernel_lttng_channel_ok()
 302 {
 303         lttng_enable_kernel_channel 1 0 "$@"
 304 }
 305
 306 function lttng_disable_kernel_channel()
 307 {
 308         local expected_to_fail=$1
 309         local sess_name=$2
 310         local channel_name=$3
 311
 312         $TESTDIR/../src/bin/lttng/$LTTNG_BIN disable-channel -k $channel_name -s $sess_name 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
 313         ret=$?
 314         if [[ $expected_to_fail -eq "1" ]]; then
 315                 test "$ret" -ne "0"
 316                 ok $? "Disable channel $channel_name for session $sess_name failed as expected"
 317         else
 318                 ok $ret "Disable channel $channel_name for session $sess_name"
 319         fi
 320 }
 321
 322 function lttng_disable_kernel_channel_ok()
 323 {
 324         lttng_disable_kernel_channel 0 "$@"
 325 }
 326
 327 function lttng_disable_kernel_channel_fail()
 328 {
 329         lttng_disable_kernel_channel 1 "$@"
 330 }
 331
 332 function start_lttng_relayd_opt()
 333 {
 334         local withtap=$1
 335         local opt=$2
 336
 337         DIR=$(readlink -f $TESTDIR)
 338
 339         if [ -z $(pgrep $RELAYD_MATCH) ]; then
 340                 $DIR/../src/bin/lttng-relayd/$RELAYD_BIN -b $opt 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
 341                 #$DIR/../src/bin/lttng-relayd/$RELAYD_BIN $opt -vvv >>/tmp/relayd.log 2>&1 &
 342                 if [ $? -eq 1 ]; then
 343                         if [ $withtap -eq "1" ]; then
 344                                 fail "Start lttng-relayd (opt: $opt)"
 345                         fi
 346                         return 1
 347                 else
 348                         if [ $withtap -eq "1" ]; then
 349                                 pass "Start lttng-relayd (opt: $opt)"
 350                         fi
 351                 fi
 352         else
 353                 pass "Start lttng-relayd (opt: $opt)"
 354         fi
 355
 356         RELAYD_PIDS=$(pgrep $RELAYD_MATCH)
 357 }
 358
 359 function start_lttng_relayd()
 360 {
 361         start_lttng_relayd_opt 1 "$@"
 362 }
 363
 364 function start_lttng_relayd_notap()
 365 {
 366         start_lttng_relayd_opt 0 "$@"
 367 }
 368
 369 function stop_lttng_relayd_opt()
 370 {
 371         local withtap=$1
 372
 373         if [ $withtap -eq "1" ]; then
 374                 diag "Killing lttng-relayd (pid: $RELAYD_PIDS)"
 375         fi
 376         kill $RELAYD_PIDS 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
 377         retval=$?
 378
 379         if [ $? -eq 1 ]; then
 380                 if [ $withtap -eq "1" ]; then
 381                         fail "Kill relay daemon"
 382                 fi
 383                 return 1
 384         else
 385                 out=1
 386                 while [ -n "$out" ]; do
 387                         out=$(pgrep $RELAYD_MATCH)
 388                         sleep 0.5
 389                 done
 390                 if [ $withtap -eq "1" ]; then
 391                         pass "Kill relay daemon"
 392                 fi
 393         fi
 394         RELAYD_PIDS=""
 395         return $retval
 396 }
 397
 398 function stop_lttng_relayd()
 399 {
 400         stop_lttng_relayd_opt 1 "$@"
 401 }
 402
 403 function stop_lttng_relayd_notap()
 404 {
 405         stop_lttng_relayd_opt 0 "$@"
 406 }
 407
 408 #First arg: show tap output
 409 #Second argument: load path for automatic loading
 410 function start_lttng_sessiond_opt()
 411 {
 412         local withtap=$1
 413         local load_path=$2
 414
 415         local env_vars=""
 416         local consumerd=""
 417         local long_bit_value=$(getconf LONG_BIT)
 418
 419         if [ -n $TEST_NO_SESSIOND ] && [ "$TEST_NO_SESSIOND" == "1" ]; then
 420                 # Env variable requested no session daemon
 421                 return
 422         fi
 423
 424         DIR=$(readlink -f $TESTDIR)
 425
 426         # Get long_bit value for 32/64 consumerd
 427         case "$long_bit_value" in
 428                 32)
 429                         consumerd="--consumerd32-path=$DIR/../src/bin/lttng-consumerd/lttng-consumerd"
 430                         ;;
 431                 64)
 432                         consumerd="--consumerd64-path=$DIR/../src/bin/lttng-consumerd/lttng-consumerd"
 433                         ;;
 434                 *)
 435                         return
 436                         ;;
 437         esac
 438
 439         # Check for env. variable. Allow the use of LD_PRELOAD etc.
 440         if [[ "x${LTTNG_SESSIOND_ENV_VARS}" != "x" ]]; then
 441                 env_vars=${LTTNG_SESSIOND_ENV_VARS}
 442         fi
 443
 444         validate_kernel_version
 445         if [ $? -ne 0 ]; then
 446             fail "Start session daemon"
 447             BAIL_OUT "*** Kernel too old for session daemon tests ***"
 448         fi
 449
 450         : ${LTTNG_SESSION_CONFIG_XSD_PATH=${DIR}/../src/common/config/}
 451         export LTTNG_SESSION_CONFIG_XSD_PATH
 452
 453         if [ -z $(pgrep ${SESSIOND_MATCH}) ]; then
 454                 # Have a load path ?
 455                 if [ -n "$load_path" ]; then
 456                         env $env_vars $DIR/../src/bin/lttng-sessiond/$SESSIOND_BIN --load "$load_path" --background $consumerd
 457                 else
 458                         env $env_vars $DIR/../src/bin/lttng-sessiond/$SESSIOND_BIN --background $consumerd
 459                 fi
 460                 #$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
 461                 status=$?
 462                 if [ $withtap -eq "1" ]; then
 463                         ok $status "Start session daemon"
 464                 fi
 465         fi
 466         SESSIOND_PIDS=$(pgrep $SESSIOND_MATCH)
 467 }
 468
 469 function start_lttng_sessiond()
 470 {
 471         start_lttng_sessiond_opt 1 "$@"
 472 }
 473
 474 function start_lttng_sessiond_notap()
 475 {
 476         start_lttng_sessiond_opt 0 "$@"
 477 }
 478
 479 function stop_lttng_sessiond_opt()
 480 {
 481         local withtap=$1
 482         local signal=$2
 483         local kill_opt=""
 484
 485         if [ -n $TEST_NO_SESSIOND ] && [ "$TEST_NO_SESSIOND" == "1" ]; then
 486                 # Env variable requested no session daemon
 487                 return
 488         fi
 489
 490         local pids="${SESSIOND_PIDS} $(pgrep $RUNAS_MATCH)"
 491
 492         if [ -n "$2" ]; then
 493                 kill_opt="$kill_opt -s $signal"
 494         fi
 495         if [ $withtap -eq "1" ]; then
 496                 diag "Killing $SESSIOND_BIN and lt-$SESSIOND_BIN pids: $(echo $pids | tr '\n' ' ')"
 497         fi
 498         kill $kill_opt $pids 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
 499
 500         if [ $? -eq 1 ]; then
 501                 if [ $withtap -eq "1" ]; then
 502                         fail "Kill sessions daemon"
 503                 fi
 504         else
 505                 out=1
 506                 while [ -n "$out" ]; do
 507                         out=$(pgrep ${SESSIOND_MATCH})
 508                         sleep 0.5
 509                 done
 510                 out=1
 511                 while [ -n "$out" ]; do
 512                         out=$(pgrep $CONSUMERD_MATCH)
 513                         sleep 0.5
 514                 done
 515
 516                 SESSIOND_PIDS=""
 517                 if [ $withtap -eq "1" ]; then
 518                         pass "Kill session daemon"
 519                 fi
 520         fi
 521 }
 522
 523 function stop_lttng_sessiond()
 524 {
 525         stop_lttng_sessiond_opt 1 "$@"
 526 }
 527
 528 function stop_lttng_sessiond_notap()
 529 {
 530         stop_lttng_sessiond_opt 0 "$@"
 531 }
 532
 533 function sigstop_lttng_sessiond_opt()
 534 {
 535         local withtap=$1
 536         local signal=SIGSTOP
 537         local kill_opt=""
 538
 539         if [ -n $TEST_NO_SESSIOND ] && [ "$TEST_NO_SESSIOND" == "1" ]; then
 540                 # Env variable requested no session daemon
 541                 return
 542         fi
 543
 544         PID_SESSIOND="$(pgrep ${SESSIOND_MATCH}) $(pgrep $RUNAS_MATCH)"
 545
 546         kill_opt="$kill_opt -s $signal"
 547
 548         if [ $withtap -eq "1" ]; then
 549                 diag "Sending SIGSTOP to lt-$SESSIOND_BIN and $SESSIOND_BIN pids: $(echo $PID_SESSIOND | tr '\n' ' ')"
 550         fi
 551         kill $kill_opt $PID_SESSIOND 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
 552
 553         if [ $? -eq 1 ]; then
 554                 if [ $withtap -eq "1" ]; then
 555                         fail "Sending SIGSTOP to session daemon"
 556                 fi
 557         else
 558                 out=1
 559                 while [ $out -ne 0 ]; do
 560                         pid=$(pgrep $SESSIOND_MATCH)
 561
 562                         # Wait until state becomes stopped for session
 563                         # daemon(s).
 564                         out=0
 565                         for sessiond_pid in $pid; do
 566                                 state=$(ps -p $sessiond_pid -o state= )
 567                                 if [[ -n "$state" && "$state" != "T" ]]; then
 568                                         out=1
 569                                 fi
 570                         done
 571                         sleep 0.5
 572                 done
 573                 if [ $withtap -eq "1" ]; then
 574                         pass "Sending SIGSTOP to session daemon"
 575                 fi
 576         fi
 577 }
 578
 579 function sigstop_lttng_sessiond()
 580 {
 581         sigstop_lttng_sessiond_opt 1 "$@"
 582 }
 583
 584 function sigstop_lttng_sessiond_notap()
 585 {
 586         sigstop_lttng_sessiond_opt 0 "$@"
 587 }
 588
 589 function stop_lttng_consumerd_opt()
 590 {
 591         local withtap=$1
 592         local signal=$2
 593         local kill_opt=""
 594
 595         PID_CONSUMERD=$(pgrep $CONSUMERD_MATCH)
 596
 597         if [ -n "$2" ]; then
 598                 kill_opt="$kill_opt -s $signal"
 599         fi
 600
 601         if [ $withtap -eq "1" ]; then
 602                 diag "Killing $CONSUMERD_BIN pids: $(echo $PID_CONSUMERD | tr '\n' ' ')"
 603         fi
 604
 605         kill $kill_opt $PID_CONSUMERD 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
 606         retval=$?
 607
 608         if [ $? -eq 1 ]; then
 609                 if [ $withtap -eq "1" ]; then
 610                         fail "Kill consumer daemon"
 611                 fi
 612                 return 1
 613         else
 614                 out=1
 615                 while [ $out -ne 0 ]; do
 616                         pid=$(pgrep $CONSUMERD_MATCH)
 617
 618                         # If consumerds are still present check their status.
 619                         # A zombie status qualifies the consumerd as *killed*
 620                         out=0
 621                         for consumer_pid in $pid; do
 622                                 state=$(ps -p $consumer_pid -o state= )
 623                                 if [[ -n "$state" && "$state" != "Z" ]]; then
 624                                         out=1
 625                                 fi
 626                         done
 627                         sleep 0.5
 628                 done
 629                 if [ $withtap -eq "1" ]; then
 630                         pass "Kill consumer daemon"
 631                 fi
 632         fi
 633         return $retval
 634 }
 635
 636 function stop_lttng_consumerd()
 637 {
 638         stop_lttng_consumerd_opt 1 "$@"
 639 }
 640
 641 function stop_lttng_consumerd_notap()
 642 {
 643         stop_lttng_consumerd_opt 0 "$@"
 644 }
 645
 646 function sigstop_lttng_consumerd_opt()
 647 {
 648         local withtap=$1
 649         local signal=SIGSTOP
 650         local kill_opt=""
 651
 652         PID_CONSUMERD=$(pgrep $CONSUMERD_MATCH)
 653
 654         kill_opt="$kill_opt -s $signal"
 655
 656         if [ $withtap -eq "1" ]; then
 657                 diag "Sending SIGSTOP to $CONSUMERD_BIN pids: $(echo $PID_CONSUMERD | tr '\n' ' ')"
 658         fi
 659         kill $kill_opt $PID_CONSUMERD 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
 660         retval=$?
 661
 662         if [ $? -eq 1 ]; then
 663                 if [ $withtap -eq "1" ]; then
 664                         fail "Sending SIGSTOP to consumer daemon"
 665                 fi
 666                 return 1
 667         else
 668                 out=1
 669                 while [ $out -ne 0 ]; do
 670                         pid=$(pgrep $CONSUMERD_MATCH)
 671
 672                         # Wait until state becomes stopped for all
 673                         # consumers.
 674                         out=0
 675                         for consumer_pid in $pid; do
 676                                 state=$(ps -p $consumer_pid -o state= )
 677                                 if [[ -n "$state" && "$state" != "T" ]]; then
 678                                         out=1
 679                                 fi
 680                         done
 681                         sleep 0.5
 682                 done
 683                 if [ $withtap -eq "1" ]; then
 684                         pass "Sending SIGSTOP to consumer daemon"
 685                 fi
 686         fi
 687         return $retval
 688 }
 689
 690 function sigstop_lttng_consumerd()
 691 {
 692         sigstop_lttng_consumerd_opt 1 "$@"
 693 }
 694
 695 function sigstop_lttng_consumerd_notap()
 696 {
 697         sigstop_lttng_consumerd_opt 0 "$@"
 698 }
 699
 700 function list_lttng_with_opts ()
 701 {
 702         local opts=$1
 703         $TESTDIR/../src/bin/lttng/$LTTNG_BIN list $opts 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
 704         ok $? "Lttng-tool list command with option $opts"
 705 }
 706
 707 function create_lttng_session_no_output ()
 708 {
 709         local sess_name=$1
 710
 711         $TESTDIR/../src/bin/lttng/$LTTNG_BIN create $sess_name --no-output 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
 712         ok $? "Create session $sess_name in no-output mode"
 713 }
 714
 715 function create_lttng_session_uri () {
 716     local sess_name=$1
 717     local uri=$2
 718     local opts="${@:3}"
 719
 720     $TESTDIR/../src/bin/lttng/$LTTNG_BIN create $sess_name -U $uri $opts 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
 721     ok $? "Create session $sess_name with uri:$uri and opts: $opts"
 722 }
 723
 724 function create_lttng_session ()
 725 {
 726         local withtap=$1
 727         local expected_to_fail=$2
 728         local sess_name=$3
 729         local trace_path=$4
 730         local opt=$5
 731
 732         $TESTDIR/../src/bin/lttng/$LTTNG_BIN create $sess_name -o $trace_path $opt > $OUTPUT_DEST
 733         ret=$?
 734         if [ $expected_to_fail -eq "1" ]; then
 735                 test "$ret" -ne "0"
 736                 ret=$?
 737                 if [ $withtap -eq "1" ]; then
 738                         ok $ret "Create session $sess_name in $trace_path failed as expected"
 739                 fi
 740         else
 741                 if [ $withtap -eq "1" ]; then
 742                         ok $ret "Create session $sess_name in $trace_path"
 743                 fi
 744         fi
 745         return $ret
 746 }
 747
 748 function create_lttng_session_ok ()
 749 {
 750         create_lttng_session 1 0 "$@"
 751 }
 752
 753 function create_lttng_session_fail ()
 754 {
 755         create_lttng_session 1 1 "$@"
 756 }
 757
 758 function create_lttng_session_notap ()
 759 {
 760         create_lttng_session 0 0 "$@"
 761 }
 762
 763
 764 function enable_ust_lttng_channel ()
 765 {
 766         local withtap=$1
 767         local expected_to_fail=$2
 768         local sess_name=$3
 769         local channel_name=$4
 770         local opt=$5
 771
 772         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-channel -u $channel_name -s $sess_name $opt 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
 773         ret=$?
 774         if [[ $expected_to_fail -eq "1" ]]; then
 775                 test "$ret" -ne "0"
 776                 ret=$?
 777                 if [ $withtap -eq "1" ]; then
 778                         ok $ret "Enable channel $channel_name for session $sess_name failed as expected"
 779                 fi
 780         else
 781                 if [ $withtap -eq "1" ]; then
 782                         ok $ret "Enable channel $channel_name for session $sess_name"
 783                 fi
 784         fi
 785         return $ret
 786 }
 787
 788 function enable_ust_lttng_channel_ok ()
 789 {
 790         enable_ust_lttng_channel 1 0 "$@"
 791 }
 792
 793 function enable_ust_lttng_channel_fail ()
 794 {
 795         enable_ust_lttng_channel 1 1 "$@"
 796 }
 797
 798 function enable_ust_lttng_channel_notap ()
 799 {
 800         enable_ust_lttng_channel 0 0 "$@"
 801 }
 802
 803 function disable_ust_lttng_channel()
 804 {
 805         local sess_name=$1
 806         local channel_name=$2
 807
 808         $TESTDIR/../src/bin/lttng/$LTTNG_BIN disable-channel -u $channel_name -s $sess_name 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
 809         ok $? "Disable channel $channel_name for session $sess_name"
 810 }
 811
 812 function enable_lttng_mmap_overwrite_kernel_channel()
 813 {
 814         local sess_name=$1
 815         local channel_name=$2
 816
 817         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-channel -s $sess_name $channel_name -k --output mmap --overwrite 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
 818         ok $? "Enable channel $channel_name for session $sess_name"
 819 }
 820
 821 function enable_lttng_mmap_discard_small_kernel_channel()
 822 {
 823         local sess_name=$1
 824         local channel_name=$2
 825
 826         $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
 827         ok $? "Enable small discard channel $channel_name for session $sess_name"
 828 }
 829
 830 function enable_lttng_mmap_overwrite_small_kernel_channel()
 831 {
 832         local sess_name=$1
 833         local channel_name=$2
 834
 835         $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
 836         ok $? "Enable small discard channel $channel_name for session $sess_name"
 837 }
 838
 839 function enable_lttng_mmap_overwrite_ust_channel()
 840 {
 841         local sess_name=$1
 842         local channel_name=$2
 843
 844         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-channel -s $sess_name $channel_name -u --output mmap --overwrite 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
 845         ok $? "Enable channel $channel_name for session $sess_name"
 846 }
 847
 848 function enable_ust_lttng_event ()
 849 {
 850         local withtap=$1
 851         local expected_to_fail=$2
 852         local sess_name=$3
 853         local event_name="$4"
 854         local channel_name=$5
 855
 856         if [ -z $channel_name ]; then
 857                 # default channel if none specified
 858                 chan=""
 859         else
 860                 chan="-c $channel_name"
 861         fi
 862
 863         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event "$event_name" $chan -s $sess_name -u 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
 864         ret=$?
 865         if [[ $expected_to_fail -eq "1" ]]; then
 866                 test $ret -ne "0"
 867                 ret=$?
 868                 if [[ $withtap -eq "1" ]]; then
 869                         ok $ret "Enable ust event $event_name for session $session_name failed as expected"
 870                 fi
 871         else
 872                 if [[ $withtap -eq "1" ]]; then
 873                         ok $ret "Enable ust event $event_name for session $sess_name"
 874                 fi
 875         fi
 876         return $ret
 877 }
 878
 879 function enable_ust_lttng_event_ok ()
 880 {
 881         enable_ust_lttng_event 1 0 "$@"
 882 }
 883
 884 function enable_ust_lttng_event_fail ()
 885 {
 886         enable_ust_lttng_event 1 1 "$@"
 887 }
 888
 889 function enable_ust_lttng_event_notap ()
 890 {
 891         enable_ust_lttng_event 0 0 "$@"
 892 }
 893
 894 function enable_jul_lttng_event()
 895 {
 896         sess_name=$1
 897         event_name="$2"
 898         channel_name=$3
 899
 900         if [ -z $channel_name ]; then
 901                 # default channel if none specified
 902                 chan=""
 903         else
 904                 chan="-c $channel_name"
 905         fi
 906
 907         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event "$event_name" $chan -s $sess_name -j 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
 908         ok $? "Enable JUL event $event_name for session $sess_name"
 909 }
 910
 911 function enable_jul_lttng_event_loglevel()
 912 {
 913         local sess_name=$1
 914         local event_name="$2"
 915         local loglevel=$3
 916         local channel_name=$4
 917
 918         if [ -z $channel_name ]; then
 919                 # default channel if none specified
 920                 chan=""
 921         else
 922                 chan="-c $channel_name"
 923         fi
 924
 925         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event --loglevel $loglevel "$event_name" $chan -s $sess_name -j 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
 926         ok $? "Enable JUL event $event_name for session $sess_name with loglevel $loglevel"
 927 }
 928
 929 function enable_log4j_lttng_event()
 930 {
 931         sess_name=$1
 932         event_name="$2"
 933         channel_name=$3
 934
 935         if [ -z $channel_name ]; then
 936                 # default channel if none specified
 937                 chan=""
 938         else
 939                 chan="-c $channel_name"
 940         fi
 941
 942         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event "$event_name" $chan -s $sess_name -l 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
 943         ok $? "Enable LOG4J event $event_name for session $sess_name"
 944 }
 945
 946 function enable_log4j_lttng_event_loglevel()
 947 {
 948         local sess_name=$1
 949         local event_name="$2"
 950         local loglevel=$3
 951         local channel_name=$4
 952
 953         if [ -z $channel_name ]; then
 954                 # default channel if none specified
 955                 chan=""
 956         else
 957                 chan="-c $channel_name"
 958         fi
 959
 960         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event --loglevel $loglevel "$event_name" $chan -s $sess_name -l 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
 961         ok $? "Enable LOG4J event $event_name for session $sess_name with loglevel $loglevel"
 962 }
 963
 964 function enable_python_lttng_event()
 965 {
 966         sess_name=$1
 967         event_name="$2"
 968         channel_name=$3
 969
 970         if [ -z $channel_name ]; then
 971                 # default channel if none specified
 972                 chan=""
 973         else
 974                 chan="-c $channel_name"
 975         fi
 976
 977         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event "$event_name" $chan -s $sess_name -p 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
 978         ok $? "Enable Python event $event_name for session $sess_name"
 979 }
 980
 981 function enable_python_lttng_event_loglevel()
 982 {
 983         local sess_name=$1
 984         local event_name="$2"
 985         local loglevel=$3
 986         local channel_name=$4
 987
 988         if [ -z $channel_name ]; then
 989                 # default channel if none specified
 990                 chan=""
 991         else
 992                 chan="-c $channel_name"
 993         fi
 994
 995         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event --loglevel $loglevel "$event_name" $chan -s $sess_name -p 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
 996         ok $? "Enable Python event $event_name for session $sess_name with loglevel $loglevel"
 997 }
 998
 999 function enable_ust_lttng_event_filter()
1000 {
1001         local sess_name="$1"
1002         local event_name="$2"
1003         local filter="$3"
1004
1005         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event "$event_name" -s $sess_name -u --filter "$filter" 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
1006         ok $? "Enable event $event_name with filtering for session $sess_name"
1007 }
1008
1009 function enable_ust_lttng_event_loglevel()
1010 {
1011         local sess_name="$1"
1012         local event_name="$2"
1013         local loglevel="$3"
1014
1015         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event "$event_name" -s $sess_name -u --loglevel $loglevel 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
1016         ok $? "Enable event $event_name with loglevel $loglevel"
1017 }
1018
1019 function enable_ust_lttng_event_loglevel_only()
1020 {
1021         local sess_name="$1"
1022         local event_name="$2"
1023         local loglevel="$3"
1024
1025         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event "$event_name" -s $sess_name -u --loglevel-only $loglevel 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
1026         ok $? "Enable event $event_name with loglevel-only $loglevel"
1027 }
1028
1029 function disable_ust_lttng_event ()
1030 {
1031         local sess_name="$1"
1032         local event_name="$2"
1033         local channel_name="$3"
1034
1035         if [ -z $channel_name ]; then
1036                 # default channel if none specified
1037                 chan=""
1038         else
1039                 chan="-c $channel_name"
1040         fi
1041
1042         $TESTDIR/../src/bin/lttng/$LTTNG_BIN disable-event "$event_name" -s $sess_name $chan -u 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
1043         ok $? "Disable event $event_name for session $sess_name"
1044 }
1045
1046 function disable_jul_lttng_event ()
1047 {
1048         local sess_name="$1"
1049         local event_name="$2"
1050
1051         $TESTDIR/../src/bin/lttng/$LTTNG_BIN disable-event "$event_name" -s $sess_name -j >/dev/null 2>&1
1052         ok $? "Disable JUL event $event_name for session $sess_name"
1053 }
1054
1055 function disable_log4j_lttng_event ()
1056 {
1057         local sess_name="$1"
1058         local event_name="$2"
1059
1060         $TESTDIR/../src/bin/lttng/$LTTNG_BIN disable-event "$event_name" -s $sess_name -l >/dev/null 2>&1
1061         ok $? "Disable LOG4J event $event_name for session $sess_name"
1062 }
1063
1064 function disable_python_lttng_event ()
1065 {
1066         local sess_name="$1"
1067         local event_name="$2"
1068
1069         $TESTDIR/../src/bin/lttng/$LTTNG_BIN disable-event "$event_name" -s $sess_name -p 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
1070         ok $? "Disable Python event $event_name for session $sess_name"
1071 }
1072
1073 function start_lttng_tracing ()
1074 {
1075         local expected_to_fail=$1
1076         local sess_name=$2
1077
1078         $TESTDIR/../src/bin/lttng/$LTTNG_BIN start $sess_name 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
1079         ret=$?
1080         if [[ $expected_to_fail -eq "1" ]]; then
1081                 test "$ret" -ne "0"
1082                 ok $? "Start tracing for session $sess_name failed as expected"
1083         else
1084                 ok $ret "Start tracing for session $sess_name"
1085         fi
1086 }
1087
1088 function start_lttng_tracing_ok ()
1089 {
1090         start_lttng_tracing 0 "$@"
1091 }
1092
1093 function start_lttng_tracing_fail ()
1094 {
1095         start_lttng_tracing 1 "$@"
1096 }
1097
1098 function stop_lttng_tracing ()
1099 {
1100         local expected_to_fail=$1
1101         local sess_name=$2
1102
1103         $TESTDIR/../src/bin/lttng/$LTTNG_BIN stop $sess_name 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
1104         ret=$?
1105         if [[ $expected_to_fail -eq "1" ]]; then
1106                 test "$ret" -ne "0"
1107                 ok $? "Stop lttng tracing for session $sess_name failed as expected"
1108         else
1109                 ok $ret "Stop lttng tracing for session $sess_name"
1110         fi
1111 }
1112
1113 function stop_lttng_tracing_ok ()
1114 {
1115         stop_lttng_tracing 0 "$@"
1116 }
1117
1118 function stop_lttng_tracing_fail ()
1119 {
1120         stop_lttng_tracing 1 "$@"
1121 }
1122
1123 function destroy_lttng_session ()
1124 {
1125         local withtap=$1
1126         local expected_to_fail=$2
1127         local sess_name=$3
1128
1129         $TESTDIR/../src/bin/lttng/$LTTNG_BIN destroy $sess_name 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
1130         ret=$?
1131         if [[ $expected_to_fail -eq "1" ]]; then
1132                 test "$ret" -ne "0"
1133                 ret=$?
1134                 if [ $withtap -eq "1" ]; then
1135                         ok $ret "Destroy session $sess_name failed as expected"
1136                 fi
1137         else
1138                 if [ $withtap -eq "1" ]; then
1139                         ok $ret "Destroy session $sess_name"
1140                 fi
1141         fi
1142 }
1143
1144 function destroy_lttng_session_ok ()
1145 {
1146         destroy_lttng_session 1 0 "$@"
1147
1148 }
1149
1150 function destroy_lttng_session_fail ()
1151 {
1152         destroy_lttng_session 1 1 "$@"
1153 }
1154
1155 function destroy_lttng_session_notap ()
1156 {
1157         destroy_lttng_session 0 0 "$@"
1158 }
1159
1160 function destroy_lttng_sessions ()
1161 {
1162         $TESTDIR/../src/bin/lttng/$LTTNG_BIN destroy --all 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
1163         ok $? "Destroy all lttng sessions"
1164 }
1165
1166 function lttng_snapshot_add_output ()
1167 {
1168         local expected_to_fail=$1
1169         local sess_name=$2
1170         local trace_path=$3
1171
1172         $TESTDIR/../src/bin/lttng/$LTTNG_BIN snapshot add-output -s $sess_name file://$trace_path 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
1173         ret=$?
1174         if [[ $expected_to_fail -eq 1 ]]; then
1175                 test "$ret" -ne "0"
1176                 ok $? "Added snapshot output file://$trace_path failed as expected"
1177         else
1178                 ok $ret "Added snapshot output file://$trace_path"
1179         fi
1180 }
1181
1182 function lttng_snapshot_add_output_ok ()
1183 {
1184         lttng_snapshot_add_output 0 "$@"
1185 }
1186
1187 function lttng_snapshot_add_output_fail ()
1188 {
1189         lttng_snapshot_add_output 1 "$@"
1190 }
1191
1192 function lttng_snapshot_del_output ()
1193 {
1194         local expected_to_fail=$1
1195         local sess_name=$2
1196         local id=$3
1197
1198         $TESTDIR/../src/bin/lttng/$LTTNG_BIN snapshot del-output -s $sess_name $id 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
1199         ret=$?
1200         if [[ $expected_to_fail -eq "1" ]]; then
1201                 test "$ret" -ne "0"
1202                 ok $? "Deleted snapshot output id $id failed as expected"
1203         else
1204                 ok $ret "Deleted snapshot output id $id"
1205         fi
1206 }
1207
1208 function lttng_snapshot_del_output_ok ()
1209 {
1210         lttng_snapshot_del_output 0 "$@"
1211 }
1212
1213 function lttng_snapshot_del_output_fail ()
1214 {
1215         lttng_snapshot_del_output 1 "$@"
1216 }
1217
1218 function lttng_snapshot_record ()
1219 {
1220         local sess_name=$1
1221         local trace_path=$2
1222
1223         $TESTDIR/../src/bin/lttng/$LTTNG_BIN snapshot record -s $sess_name 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
1224         ok $? "Snapshot recorded"
1225 }
1226
1227 function lttng_snapshot_list ()
1228 {
1229         local sess_name=$1
1230         $TESTDIR/../src/bin/lttng/$LTTNG_BIN snapshot list-output -s $sess_name 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
1231         ok $? "Snapshot list"
1232 }
1233
1234 function lttng_save()
1235 {
1236         local sess_name=$1
1237         local opts=$2
1238
1239         $TESTDIR/../src/bin/lttng/$LTTNG_BIN save $sess_name $opts 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
1240         ok $? "Session saved"
1241 }
1242
1243 function lttng_load()
1244 {
1245         local expected_to_fail=$1
1246         local opts=$2
1247
1248         $TESTDIR/../src/bin/lttng/$LTTNG_BIN load $opts 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
1249         ret=$?
1250         if [[ $expected_to_fail -eq "1" ]]; then
1251                 test $ret -ne "0"
1252                 ok $? "Load command failed as expected with opts: $opts"
1253         else
1254                 ok $ret "Load command with opts: $opts"
1255         fi
1256 }
1257
1258 function lttng_load_ok()
1259 {
1260         lttng_load 0 "$@"
1261 }
1262
1263 function lttng_load_fail()
1264 {
1265         lttng_load 1 "$@"
1266 }
1267
1268 function lttng_track()
1269 {
1270         local expected_to_fail=$1
1271         local opts=$2
1272         $TESTDIR/../src/bin/lttng/$LTTNG_BIN track $opts >$OUTPUT_DEST
1273         ret=$?
1274         if [[ $expected_to_fail -eq "1" ]]; then
1275                 test $ret -ne "0"
1276                 ok $? "Track command failed as expected with opts: $opts"
1277         else
1278                 ok $ret "Track command with opts: $opts"
1279         fi
1280 }
1281
1282 function lttng_track_ok()
1283 {
1284         lttng_track 0 "$@"
1285 }
1286
1287 function lttng_track_fail()
1288 {
1289         lttng_track 1 "$@"
1290 }
1291
1292 function lttng_untrack()
1293 {
1294         local expected_to_fail=$1
1295         local opts=$2
1296         $TESTDIR/../src/bin/lttng/$LTTNG_BIN untrack $opts >$OUTPUT_DEST
1297         ret=$?
1298         if [[ $expected_to_fail -eq "1" ]]; then
1299                 test $ret -ne "0"
1300                 ok $? "Untrack command failed as expected with opts: $opts"
1301         else
1302                 ok $ret "Untrack command with opts: $opts"
1303         fi
1304 }
1305
1306 function lttng_untrack_ok()
1307 {
1308         lttng_untrack 0 "$@"
1309 }
1310
1311 function lttng_untrack_fail()
1312 {
1313         lttng_untrack 1 "$@"
1314 }
1315
1316 function add_context_lttng()
1317 {
1318         local expected_to_fail="$1"
1319         local domain="$2"
1320         local session_name="$3"
1321         local channel_name="$4"
1322         local type="$5"
1323
1324         $TESTDIR/../src/bin/lttng/$LTTNG_BIN add-context -s $session_name -c $channel_name -t $type $domain  1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
1325         ret=$?
1326         if [[ $expected_to_fail -eq "1" ]]; then
1327                 test $ret -ne "0"
1328                 ok $? "Add context command failed as expected for type: $type"
1329         else
1330                 ok $ret "Add context command for type: $type"
1331         fi
1332 }
1333
1334 function add_context_ust_ok()
1335 {
1336         add_context_lttng 0 -u "$@"
1337 }
1338
1339 function add_context_ust_fail()
1340 {
1341         add_context_lttng 1 -u "$@"
1342 }
1343
1344 function add_context_kernel_ok()
1345 {
1346         add_context_lttng 0 -k "$@"
1347 }
1348
1349 function add_context_kernel_fail()
1350 {
1351         add_context_lttng 1 -k "$@"
1352 }
1353
1354 function trace_matches ()
1355 {
1356         local event_name=$1
1357         local nr_iter=$2
1358         local trace_path=$3
1359
1360         which $BABELTRACE_BIN >/dev/null
1361         skip $? -ne 0 "Babeltrace binary not found. Skipping trace matches"
1362
1363         local count=$($BABELTRACE_BIN $trace_path | grep $event_name | wc -l)
1364
1365         if [ "$count" -ne "$nr_iter" ]; then
1366                 fail "Trace match"
1367                 diag "$count matching events found in trace"
1368         else
1369                 pass "Trace match"
1370         fi
1371 }
1372
1373 function trace_match_only()
1374 {
1375         local event_name=$1
1376         local nr_iter=$2
1377         local trace_path=$3
1378
1379         which $BABELTRACE_BIN >/dev/null
1380         skip $? -ne 0 "Babeltrace binary not found. Skipping trace matches"
1381
1382         local count=$($BABELTRACE_BIN $trace_path | grep $event_name | wc -l)
1383         local total=$($BABELTRACE_BIN $trace_path | wc -l)
1384
1385     if [ "$nr_iter" -eq "$count" ] && [ "$total" -eq "$nr_iter" ]; then
1386         pass "Trace match with $total event $event_name"
1387     else
1388         fail "Trace match"
1389         diag "$total event(s) found, expecting $nr_iter of event $event_name and only found $count"
1390     fi
1391 }
1392
1393 function validate_trace
1394 {
1395         local event_name=$1
1396         local trace_path=$2
1397
1398         which $BABELTRACE_BIN >/dev/null
1399         if [ $? -ne 0 ]; then
1400             skip 0 "Babeltrace binary not found. Skipping trace validation"
1401         fi
1402
1403         OLDIFS=$IFS
1404         IFS=","
1405         for i in $event_name; do
1406                 traced=$($BABELTRACE_BIN $trace_path 2>/dev/null | grep $i | wc -l)
1407                 if [ "$traced" -ne 0 ]; then
1408                         pass "Validate trace for event $i, $traced events"
1409                 else
1410                         fail "Validate trace for event $i"
1411                         diag "Found $traced occurences of $i"
1412                 fi
1413         done
1414         ret=$?
1415         IFS=$OLDIFS
1416         return $ret
1417 }
1418
1419 function validate_trace_count
1420 {
1421         local event_name=$1
1422         local trace_path=$2
1423         local expected_count=$3
1424
1425         which $BABELTRACE_BIN >/dev/null
1426         if [ $? -ne 0 ]; then
1427             skip 0 "Babeltrace binary not found. Skipping trace validation"
1428         fi
1429
1430         cnt=0
1431         OLDIFS=$IFS
1432         IFS=","
1433         for i in $event_name; do
1434                 traced=$($BABELTRACE_BIN $trace_path 2>/dev/null | grep $i | wc -l)
1435                 if [ "$traced" -ne 0 ]; then
1436                         pass "Validate trace for event $i, $traced events"
1437                 else
1438                         fail "Validate trace for event $i"
1439                         diag "Found $traced occurences of $i"
1440                 fi
1441                 cnt=$(($cnt + $traced))
1442         done
1443         IFS=$OLDIFS
1444         test $cnt -eq $expected_count
1445         ok $? "Read a total of $cnt events, expected $expected_count"
1446 }
1447
1448 function trace_first_line
1449 {
1450         local trace_path=$1
1451
1452         which $BABELTRACE_BIN >/dev/null
1453         if [ $? -ne 0 ]; then
1454             skip 0 "Babeltrace binary not found. Skipping trace validation"
1455         fi
1456
1457         $BABELTRACE_BIN $trace_path 2>/dev/null | head -n 1
1458 }
1459
1460 function validate_trace_exp()
1461 {
1462         local event_exp=$1
1463         local trace_path=$2
1464
1465         which $BABELTRACE_BIN >/dev/null
1466         skip $? -ne 0 "Babeltrace binary not found. Skipping trace validation"
1467
1468         traced=$($BABELTRACE_BIN $trace_path 2>/dev/null | grep ${event_exp} | wc -l)
1469         if [ "$traced" -ne 0 ]; then
1470                 pass "Validate trace for expression '${event_exp}', $traced events"
1471         else
1472                 fail "Validate trace for expression '${event_exp}'"
1473                 diag "Found $traced occurences of '${event_exp}'"
1474         fi
1475         ret=$?
1476         return $ret
1477 }
1478
1479 function validate_trace_only_exp()
1480 {
1481         local event_exp=$1
1482         local trace_path=$2
1483
1484         which $BABELTRACE_BIN >/dev/null
1485         skip $? -ne 0 "Babeltrace binary not found. Skipping trace matches"
1486
1487         local count=$($BABELTRACE_BIN $trace_path | grep ${event_exp} | wc -l)
1488         local total=$($BABELTRACE_BIN $trace_path | wc -l)
1489
1490         if [ "$count" -ne 0 ] && [ "$total" -eq "$count" ]; then
1491                 pass "Trace match with $total for expression '${event_exp}"
1492         else
1493                 fail "Trace match"
1494                 diag "$total syscall event(s) found, only syscalls matching expression '${event_exp}' ($count occurrences) are expected"
1495         fi
1496         ret=$?
1497         return $ret
1498 }
1499
1500 function validate_trace_empty()
1501 {
1502         local trace_path=$1
1503
1504         which $BABELTRACE_BIN >/dev/null
1505         if [ $? -ne 0 ]; then
1506             skip 0 "Babeltrace binary not found. Skipping trace validation"
1507         fi
1508
1509         events=$($BABELTRACE_BIN $trace_path 2>/dev/null)
1510         ret=$?
1511         if [ $ret -ne 0 ]; then
1512                 fail "Failed to parse trace"
1513                 return $ret
1514         fi
1515
1516         traced=$(echo -n "$events" | wc -l)
1517         if [ "$traced" -eq 0 ]; then
1518                 pass "Validate empty trace"
1519         else
1520                 fail "Validate empty trace"
1521                 diag "Found $traced events in trace"
1522         fi
1523         ret=$?
1524         return $ret
1525 }
1526
1527 function regenerate_metadata ()
1528 {
1529         local expected_to_fail=$1
1530         local sess_name=$2
1531
1532         $TESTDIR/../src/bin/lttng/$LTTNG_BIN regenerate metadata -s $sess_name 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
1533         ret=$?
1534         if [[ $expected_to_fail -eq "1" ]]; then
1535                 test "$ret" -ne "0"
1536                 ok $? "Expected fail on regenerate metadata $sess_name"
1537         else
1538                 ok $ret "Metadata regenerate $sess_name"
1539         fi
1540 }
1541
1542 function regenerate_metadata_ok ()
1543 {
1544         regenerate_metadata 0 "$@"
1545 }
1546
1547 function regenerate_metadata_fail ()
1548 {
1549         regenerate_metadata 1 "$@"
1550 }
1551
1552 function regenerate_statedump ()
1553 {
1554         local expected_to_fail=$1
1555         local sess_name=$2
1556
1557         $TESTDIR/../src/bin/lttng/$LTTNG_BIN regenerate statedump -s $sess_name 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
1558         ret=$?
1559         if [[ $expected_to_fail -eq "1" ]]; then
1560                 test "$ret" -ne "0"
1561                 ok $? "Expected fail on regenerate statedump $sess_name"
1562         else
1563                 ok $ret "Metadata regenerate $sess_name"
1564         fi
1565 }
1566
1567 function regenerate_statedump_ok ()
1568 {
1569         regenerate_statedump 0 "$@"
1570 }
1571
1572 function regenerate_statedump_fail ()
1573 {
1574         regenerate_statedump 1 "$@"
1575 }
1576
1577 function destructive_tests_enabled ()
1578 {
1579         if [ ${LTTNG_ENABLE_DESTRUCTIVE_TESTS} = "will-break-my-system" ]; then
1580                 return 0
1581         else
1582                 return 1
1583         fi
1584 }