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 ()
 716 {
 717         local withtap=$1
 718         local expected_to_fail=$2
 719         local sess_name=$3
 720         local trace_path=$4
 721         local opt=$5
 722
 723         $TESTDIR/../src/bin/lttng/$LTTNG_BIN create $sess_name -o $trace_path $opt > $OUTPUT_DEST
 724         ret=$?
 725         if [ $expected_to_fail -eq "1" ]; then
 726                 test "$ret" -ne "0"
 727                 ret=$?
 728                 if [ $withtap -eq "1" ]; then
 729                         ok $ret "Create session $sess_name in $trace_path failed as expected"
 730                 fi
 731         else
 732                 if [ $withtap -eq "1" ]; then
 733                         ok $ret "Create session $sess_name in $trace_path"
 734                 fi
 735         fi
 736         return $ret
 737 }
 738
 739 function create_lttng_session_ok ()
 740 {
 741         create_lttng_session 1 0 "$@"
 742 }
 743
 744 function create_lttng_session_fail ()
 745 {
 746         create_lttng_session 1 1 "$@"
 747 }
 748
 749 function create_lttng_session_notap ()
 750 {
 751         create_lttng_session 0 0 "$@"
 752 }
 753
 754
 755 function enable_ust_lttng_channel ()
 756 {
 757         local withtap=$1
 758         local expected_to_fail=$2
 759         local sess_name=$3
 760         local channel_name=$4
 761         local opt=$5
 762
 763         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-channel -u $channel_name -s $sess_name $opt 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
 764         ret=$?
 765         if [[ $expected_to_fail -eq "1" ]]; then
 766                 test "$ret" -ne "0"
 767                 ret=$?
 768                 if [ $withtap -eq "1" ]; then
 769                         ok $ret "Enable channel $channel_name for session $sess_name failed as expected"
 770                 fi
 771         else
 772                 if [ $withtap -eq "1" ]; then
 773                         ok $ret "Enable channel $channel_name for session $sess_name"
 774                 fi
 775         fi
 776         return $ret
 777 }
 778
 779 function enable_ust_lttng_channel_ok ()
 780 {
 781         enable_ust_lttng_channel 1 0 "$@"
 782 }
 783
 784 function enable_ust_lttng_channel_fail ()
 785 {
 786         enable_ust_lttng_channel 1 1 "$@"
 787 }
 788
 789 function enable_ust_lttng_channel_notap ()
 790 {
 791         enable_ust_lttng_channel 0 0 "$@"
 792 }
 793
 794 function disable_ust_lttng_channel()
 795 {
 796         local sess_name=$1
 797         local channel_name=$2
 798
 799         $TESTDIR/../src/bin/lttng/$LTTNG_BIN disable-channel -u $channel_name -s $sess_name 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
 800         ok $? "Disable channel $channel_name for session $sess_name"
 801 }
 802
 803 function enable_lttng_mmap_overwrite_kernel_channel()
 804 {
 805         local sess_name=$1
 806         local channel_name=$2
 807
 808         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-channel -s $sess_name $channel_name -k --output mmap --overwrite 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
 809         ok $? "Enable channel $channel_name for session $sess_name"
 810 }
 811
 812 function enable_lttng_mmap_discard_small_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 --discard --subbuf-size=$(getconf PAGE_SIZE) --num-subbuf=2 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
 818         ok $? "Enable small discard channel $channel_name for session $sess_name"
 819 }
 820
 821 function enable_lttng_mmap_overwrite_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 --overwrite --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_ust_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 -u --output mmap --overwrite 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
 836         ok $? "Enable channel $channel_name for session $sess_name"
 837 }
 838
 839 function enable_ust_lttng_event ()
 840 {
 841         local withtap=$1
 842         local expected_to_fail=$2
 843         local sess_name=$3
 844         local event_name="$4"
 845         local channel_name=$5
 846
 847         if [ -z $channel_name ]; then
 848                 # default channel if none specified
 849                 chan=""
 850         else
 851                 chan="-c $channel_name"
 852         fi
 853
 854         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event "$event_name" $chan -s $sess_name -u 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
 855         ret=$?
 856         if [[ $expected_to_fail -eq "1" ]]; then
 857                 test $ret -ne "0"
 858                 ret=$?
 859                 if [[ $withtap -eq "1" ]]; then
 860                         ok $ret "Enable ust event $event_name for session $session_name failed as expected"
 861                 fi
 862         else
 863                 if [[ $withtap -eq "1" ]]; then
 864                         ok $ret "Enable ust event $event_name for session $sess_name"
 865                 fi
 866         fi
 867         return $ret
 868 }
 869
 870 function enable_ust_lttng_event_ok ()
 871 {
 872         enable_ust_lttng_event 1 0 "$@"
 873 }
 874
 875 function enable_ust_lttng_event_fail ()
 876 {
 877         enable_ust_lttng_event 1 1 "$@"
 878 }
 879
 880 function enable_ust_lttng_event_notap ()
 881 {
 882         enable_ust_lttng_event 0 0 "$@"
 883 }
 884
 885 function enable_jul_lttng_event()
 886 {
 887         sess_name=$1
 888         event_name="$2"
 889         channel_name=$3
 890
 891         if [ -z $channel_name ]; then
 892                 # default channel if none specified
 893                 chan=""
 894         else
 895                 chan="-c $channel_name"
 896         fi
 897
 898         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event "$event_name" $chan -s $sess_name -j 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
 899         ok $? "Enable JUL event $event_name for session $sess_name"
 900 }
 901
 902 function enable_jul_lttng_event_loglevel()
 903 {
 904         local sess_name=$1
 905         local event_name="$2"
 906         local loglevel=$3
 907         local channel_name=$4
 908
 909         if [ -z $channel_name ]; then
 910                 # default channel if none specified
 911                 chan=""
 912         else
 913                 chan="-c $channel_name"
 914         fi
 915
 916         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event --loglevel $loglevel "$event_name" $chan -s $sess_name -j 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
 917         ok $? "Enable JUL event $event_name for session $sess_name with loglevel $loglevel"
 918 }
 919
 920 function enable_log4j_lttng_event()
 921 {
 922         sess_name=$1
 923         event_name="$2"
 924         channel_name=$3
 925
 926         if [ -z $channel_name ]; then
 927                 # default channel if none specified
 928                 chan=""
 929         else
 930                 chan="-c $channel_name"
 931         fi
 932
 933         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event "$event_name" $chan -s $sess_name -l 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
 934         ok $? "Enable LOG4J event $event_name for session $sess_name"
 935 }
 936
 937 function enable_log4j_lttng_event_loglevel()
 938 {
 939         local sess_name=$1
 940         local event_name="$2"
 941         local loglevel=$3
 942         local channel_name=$4
 943
 944         if [ -z $channel_name ]; then
 945                 # default channel if none specified
 946                 chan=""
 947         else
 948                 chan="-c $channel_name"
 949         fi
 950
 951         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event --loglevel $loglevel "$event_name" $chan -s $sess_name -l 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
 952         ok $? "Enable LOG4J event $event_name for session $sess_name with loglevel $loglevel"
 953 }
 954
 955 function enable_python_lttng_event()
 956 {
 957         sess_name=$1
 958         event_name="$2"
 959         channel_name=$3
 960
 961         if [ -z $channel_name ]; then
 962                 # default channel if none specified
 963                 chan=""
 964         else
 965                 chan="-c $channel_name"
 966         fi
 967
 968         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event "$event_name" $chan -s $sess_name -p 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
 969         ok $? "Enable Python event $event_name for session $sess_name"
 970 }
 971
 972 function enable_python_lttng_event_loglevel()
 973 {
 974         local sess_name=$1
 975         local event_name="$2"
 976         local loglevel=$3
 977         local channel_name=$4
 978
 979         if [ -z $channel_name ]; then
 980                 # default channel if none specified
 981                 chan=""
 982         else
 983                 chan="-c $channel_name"
 984         fi
 985
 986         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event --loglevel $loglevel "$event_name" $chan -s $sess_name -p 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
 987         ok $? "Enable Python event $event_name for session $sess_name with loglevel $loglevel"
 988 }
 989
 990 function enable_ust_lttng_event_filter()
 991 {
 992         local sess_name="$1"
 993         local event_name="$2"
 994         local filter="$3"
 995
 996         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event "$event_name" -s $sess_name -u --filter "$filter" 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
 997         ok $? "Enable event $event_name with filtering for session $sess_name"
 998 }
 999
1000 function enable_ust_lttng_event_loglevel()
1001 {
1002         local sess_name="$1"
1003         local event_name="$2"
1004         local loglevel="$3"
1005
1006         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event "$event_name" -s $sess_name -u --loglevel $loglevel 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
1007         ok $? "Enable event $event_name with loglevel $loglevel"
1008 }
1009
1010 function enable_ust_lttng_event_loglevel_only()
1011 {
1012         local sess_name="$1"
1013         local event_name="$2"
1014         local loglevel="$3"
1015
1016         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event "$event_name" -s $sess_name -u --loglevel-only $loglevel 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
1017         ok $? "Enable event $event_name with loglevel-only $loglevel"
1018 }
1019
1020 function disable_ust_lttng_event ()
1021 {
1022         local sess_name="$1"
1023         local event_name="$2"
1024         local channel_name="$3"
1025
1026         if [ -z $channel_name ]; then
1027                 # default channel if none specified
1028                 chan=""
1029         else
1030                 chan="-c $channel_name"
1031         fi
1032
1033         $TESTDIR/../src/bin/lttng/$LTTNG_BIN disable-event "$event_name" -s $sess_name $chan -u 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
1034         ok $? "Disable event $event_name for session $sess_name"
1035 }
1036
1037 function disable_jul_lttng_event ()
1038 {
1039         local sess_name="$1"
1040         local event_name="$2"
1041
1042         $TESTDIR/../src/bin/lttng/$LTTNG_BIN disable-event "$event_name" -s $sess_name -j >/dev/null 2>&1
1043         ok $? "Disable JUL event $event_name for session $sess_name"
1044 }
1045
1046 function disable_log4j_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 -l >/dev/null 2>&1
1052         ok $? "Disable LOG4J event $event_name for session $sess_name"
1053 }
1054
1055 function disable_python_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 -p 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
1061         ok $? "Disable Python event $event_name for session $sess_name"
1062 }
1063
1064 function start_lttng_tracing ()
1065 {
1066         local expected_to_fail=$1
1067         local sess_name=$2
1068
1069         $TESTDIR/../src/bin/lttng/$LTTNG_BIN start $sess_name 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
1070         ret=$?
1071         if [[ $expected_to_fail -eq "1" ]]; then
1072                 test "$ret" -ne "0"
1073                 ok $? "Start tracing for session $sess_name failed as expected"
1074         else
1075                 ok $ret "Start tracing for session $sess_name"
1076         fi
1077 }
1078
1079 function start_lttng_tracing_ok ()
1080 {
1081         start_lttng_tracing 0 "$@"
1082 }
1083
1084 function start_lttng_tracing_fail ()
1085 {
1086         start_lttng_tracing 1 "$@"
1087 }
1088
1089 function stop_lttng_tracing ()
1090 {
1091         local expected_to_fail=$1
1092         local sess_name=$2
1093
1094         $TESTDIR/../src/bin/lttng/$LTTNG_BIN stop $sess_name 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
1095         ret=$?
1096         if [[ $expected_to_fail -eq "1" ]]; then
1097                 test "$ret" -ne "0"
1098                 ok $? "Stop lttng tracing for session $sess_name failed as expected"
1099         else
1100                 ok $ret "Stop lttng tracing for session $sess_name"
1101         fi
1102 }
1103
1104 function stop_lttng_tracing_ok ()
1105 {
1106         stop_lttng_tracing 0 "$@"
1107 }
1108
1109 function stop_lttng_tracing_fail ()
1110 {
1111         stop_lttng_tracing 1 "$@"
1112 }
1113
1114 function destroy_lttng_session ()
1115 {
1116         local withtap=$1
1117         local expected_to_fail=$2
1118         local sess_name=$3
1119
1120         $TESTDIR/../src/bin/lttng/$LTTNG_BIN destroy $sess_name 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
1121         ret=$?
1122         if [[ $expected_to_fail -eq "1" ]]; then
1123                 test "$ret" -ne "0"
1124                 ret=$?
1125                 if [ $withtap -eq "1" ]; then
1126                         ok $ret "Destroy session $sess_name failed as expected"
1127                 fi
1128         else
1129                 if [ $withtap -eq "1" ]; then
1130                         ok $ret "Destroy session $sess_name"
1131                 fi
1132         fi
1133 }
1134
1135 function destroy_lttng_session_ok ()
1136 {
1137         destroy_lttng_session 1 0 "$@"
1138
1139 }
1140
1141 function destroy_lttng_session_fail ()
1142 {
1143         destroy_lttng_session 1 1 "$@"
1144 }
1145
1146 function destroy_lttng_session_notap ()
1147 {
1148         destroy_lttng_session 0 0 "$@"
1149 }
1150
1151 function destroy_lttng_sessions ()
1152 {
1153         $TESTDIR/../src/bin/lttng/$LTTNG_BIN destroy --all 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
1154         ok $? "Destroy all lttng sessions"
1155 }
1156
1157 function lttng_snapshot_add_output ()
1158 {
1159         local expected_to_fail=$1
1160         local sess_name=$2
1161         local trace_path=$3
1162
1163         $TESTDIR/../src/bin/lttng/$LTTNG_BIN snapshot add-output -s $sess_name file://$trace_path 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
1164         ret=$?
1165         if [[ $expected_to_fail -eq 1 ]]; then
1166                 test "$ret" -ne "0"
1167                 ok $? "Added snapshot output file://$trace_path failed as expected"
1168         else
1169                 ok $ret "Added snapshot output file://$trace_path"
1170         fi
1171 }
1172
1173 function lttng_snapshot_add_output_ok ()
1174 {
1175         lttng_snapshot_add_output 0 "$@"
1176 }
1177
1178 function lttng_snapshot_add_output_fail ()
1179 {
1180         lttng_snapshot_add_output 1 "$@"
1181 }
1182
1183 function lttng_snapshot_del_output ()
1184 {
1185         local expected_to_fail=$1
1186         local sess_name=$2
1187         local id=$3
1188
1189         $TESTDIR/../src/bin/lttng/$LTTNG_BIN snapshot del-output -s $sess_name $id 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
1190         ret=$?
1191         if [[ $expected_to_fail -eq "1" ]]; then
1192                 test "$ret" -ne "0"
1193                 ok $? "Deleted snapshot output id $id failed as expected"
1194         else
1195                 ok $ret "Deleted snapshot output id $id"
1196         fi
1197 }
1198
1199 function lttng_snapshot_del_output_ok ()
1200 {
1201         lttng_snapshot_del_output 0 "$@"
1202 }
1203
1204 function lttng_snapshot_del_output_fail ()
1205 {
1206         lttng_snapshot_del_output 1 "$@"
1207 }
1208
1209 function lttng_snapshot_record ()
1210 {
1211         local sess_name=$1
1212         local trace_path=$2
1213
1214         $TESTDIR/../src/bin/lttng/$LTTNG_BIN snapshot record -s $sess_name 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
1215         ok $? "Snapshot recorded"
1216 }
1217
1218 function lttng_snapshot_list ()
1219 {
1220         local sess_name=$1
1221         $TESTDIR/../src/bin/lttng/$LTTNG_BIN snapshot list-output -s $sess_name 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
1222         ok $? "Snapshot list"
1223 }
1224
1225 function lttng_save()
1226 {
1227         local sess_name=$1
1228         local opts=$2
1229
1230         $TESTDIR/../src/bin/lttng/$LTTNG_BIN save $sess_name $opts 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
1231         ok $? "Session saved"
1232 }
1233
1234 function lttng_load()
1235 {
1236         local expected_to_fail=$1
1237         local opts=$2
1238
1239         $TESTDIR/../src/bin/lttng/$LTTNG_BIN load $opts 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
1240         ret=$?
1241         if [[ $expected_to_fail -eq "1" ]]; then
1242                 test $ret -ne "0"
1243                 ok $? "Load command failed as expected with opts: $opts"
1244         else
1245                 ok $ret "Load command with opts: $opts"
1246         fi
1247 }
1248
1249 function lttng_load_ok()
1250 {
1251         lttng_load 0 "$@"
1252 }
1253
1254 function lttng_load_fail()
1255 {
1256         lttng_load 1 "$@"
1257 }
1258
1259 function lttng_track()
1260 {
1261         local expected_to_fail=$1
1262         local opts=$2
1263         $TESTDIR/../src/bin/lttng/$LTTNG_BIN track $opts >$OUTPUT_DEST
1264         ret=$?
1265         if [[ $expected_to_fail -eq "1" ]]; then
1266                 test $ret -ne "0"
1267                 ok $? "Track command failed as expected with opts: $opts"
1268         else
1269                 ok $ret "Track command with opts: $opts"
1270         fi
1271 }
1272
1273 function lttng_track_ok()
1274 {
1275         lttng_track 0 "$@"
1276 }
1277
1278 function lttng_track_fail()
1279 {
1280         lttng_track 1 "$@"
1281 }
1282
1283 function lttng_untrack()
1284 {
1285         local expected_to_fail=$1
1286         local opts=$2
1287         $TESTDIR/../src/bin/lttng/$LTTNG_BIN untrack $opts >$OUTPUT_DEST
1288         ret=$?
1289         if [[ $expected_to_fail -eq "1" ]]; then
1290                 test $ret -ne "0"
1291                 ok $? "Untrack command failed as expected with opts: $opts"
1292         else
1293                 ok $ret "Untrack command with opts: $opts"
1294         fi
1295 }
1296
1297 function lttng_untrack_ok()
1298 {
1299         lttng_untrack 0 "$@"
1300 }
1301
1302 function lttng_untrack_fail()
1303 {
1304         lttng_untrack 1 "$@"
1305 }
1306
1307 function add_context_lttng()
1308 {
1309         local expected_to_fail="$1"
1310         local domain="$2"
1311         local session_name="$3"
1312         local channel_name="$4"
1313         local type="$5"
1314
1315         $TESTDIR/../src/bin/lttng/$LTTNG_BIN add-context -s $session_name -c $channel_name -t $type $domain  1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
1316         ret=$?
1317         if [[ $expected_to_fail -eq "1" ]]; then
1318                 test $ret -ne "0"
1319                 ok $? "Add context command failed as expected for type: $type"
1320         else
1321                 ok $ret "Add context command for type: $type"
1322         fi
1323 }
1324
1325 function add_context_ust_ok()
1326 {
1327         add_context_lttng 0 -u "$@"
1328 }
1329
1330 function add_context_ust_fail()
1331 {
1332         add_context_lttng 1 -u "$@"
1333 }
1334
1335 function add_context_kernel_ok()
1336 {
1337         add_context_lttng 0 -k "$@"
1338 }
1339
1340 function add_context_kernel_fail()
1341 {
1342         add_context_lttng 1 -k "$@"
1343 }
1344
1345 function trace_matches ()
1346 {
1347         local event_name=$1
1348         local nr_iter=$2
1349         local trace_path=$3
1350
1351         which $BABELTRACE_BIN >/dev/null
1352         skip $? -ne 0 "Babeltrace binary not found. Skipping trace matches"
1353
1354         local count=$($BABELTRACE_BIN $trace_path | grep $event_name | wc -l)
1355
1356         if [ "$count" -ne "$nr_iter" ]; then
1357                 fail "Trace match"
1358                 diag "$count matching events found in trace"
1359         else
1360                 pass "Trace match"
1361         fi
1362 }
1363
1364 function trace_match_only()
1365 {
1366         local event_name=$1
1367         local nr_iter=$2
1368         local trace_path=$3
1369
1370         which $BABELTRACE_BIN >/dev/null
1371         skip $? -ne 0 "Babeltrace binary not found. Skipping trace matches"
1372
1373         local count=$($BABELTRACE_BIN $trace_path | grep $event_name | wc -l)
1374         local total=$($BABELTRACE_BIN $trace_path | wc -l)
1375
1376     if [ "$nr_iter" -eq "$count" ] && [ "$total" -eq "$nr_iter" ]; then
1377         pass "Trace match with $total event $event_name"
1378     else
1379         fail "Trace match"
1380         diag "$total event(s) found, expecting $nr_iter of event $event_name and only found $count"
1381     fi
1382 }
1383
1384 function validate_trace
1385 {
1386         local event_name=$1
1387         local trace_path=$2
1388
1389         which $BABELTRACE_BIN >/dev/null
1390         if [ $? -ne 0 ]; then
1391             skip 0 "Babeltrace binary not found. Skipping trace validation"
1392         fi
1393
1394         OLDIFS=$IFS
1395         IFS=","
1396         for i in $event_name; do
1397                 traced=$($BABELTRACE_BIN $trace_path 2>/dev/null | grep $i | wc -l)
1398                 if [ "$traced" -ne 0 ]; then
1399                         pass "Validate trace for event $i, $traced events"
1400                 else
1401                         fail "Validate trace for event $i"
1402                         diag "Found $traced occurences of $i"
1403                 fi
1404         done
1405         ret=$?
1406         IFS=$OLDIFS
1407         return $ret
1408 }
1409
1410 function validate_trace_count
1411 {
1412         local event_name=$1
1413         local trace_path=$2
1414         local expected_count=$3
1415
1416         which $BABELTRACE_BIN >/dev/null
1417         if [ $? -ne 0 ]; then
1418             skip 0 "Babeltrace binary not found. Skipping trace validation"
1419         fi
1420
1421         cnt=0
1422         OLDIFS=$IFS
1423         IFS=","
1424         for i in $event_name; do
1425                 traced=$($BABELTRACE_BIN $trace_path 2>/dev/null | grep $i | wc -l)
1426                 if [ "$traced" -ne 0 ]; then
1427                         pass "Validate trace for event $i, $traced events"
1428                 else
1429                         fail "Validate trace for event $i"
1430                         diag "Found $traced occurences of $i"
1431                 fi
1432                 cnt=$(($cnt + $traced))
1433         done
1434         IFS=$OLDIFS
1435         test $cnt -eq $expected_count
1436         ok $? "Read a total of $cnt events, expected $expected_count"
1437 }
1438
1439 function trace_first_line
1440 {
1441         local trace_path=$1
1442
1443         which $BABELTRACE_BIN >/dev/null
1444         if [ $? -ne 0 ]; then
1445             skip 0 "Babeltrace binary not found. Skipping trace validation"
1446         fi
1447
1448         $BABELTRACE_BIN $trace_path 2>/dev/null | head -n 1
1449 }
1450
1451 function validate_trace_exp()
1452 {
1453         local event_exp=$1
1454         local trace_path=$2
1455
1456         which $BABELTRACE_BIN >/dev/null
1457         skip $? -ne 0 "Babeltrace binary not found. Skipping trace validation"
1458
1459         traced=$($BABELTRACE_BIN $trace_path 2>/dev/null | grep ${event_exp} | wc -l)
1460         if [ "$traced" -ne 0 ]; then
1461                 pass "Validate trace for expression '${event_exp}', $traced events"
1462         else
1463                 fail "Validate trace for expression '${event_exp}'"
1464                 diag "Found $traced occurences of '${event_exp}'"
1465         fi
1466         ret=$?
1467         return $ret
1468 }
1469
1470 function validate_trace_only_exp()
1471 {
1472         local event_exp=$1
1473         local trace_path=$2
1474
1475         which $BABELTRACE_BIN >/dev/null
1476         skip $? -ne 0 "Babeltrace binary not found. Skipping trace matches"
1477
1478         local count=$($BABELTRACE_BIN $trace_path | grep ${event_exp} | wc -l)
1479         local total=$($BABELTRACE_BIN $trace_path | wc -l)
1480
1481         if [ "$count" -ne 0 ] && [ "$total" -eq "$count" ]; then
1482                 pass "Trace match with $total for expression '${event_exp}"
1483         else
1484                 fail "Trace match"
1485                 diag "$total syscall event(s) found, only syscalls matching expression '${event_exp}' ($count occurrences) are expected"
1486         fi
1487         ret=$?
1488         return $ret
1489 }
1490
1491 function validate_trace_empty()
1492 {
1493         local trace_path=$1
1494
1495         which $BABELTRACE_BIN >/dev/null
1496         if [ $? -ne 0 ]; then
1497             skip 0 "Babeltrace binary not found. Skipping trace validation"
1498         fi
1499
1500         events=$($BABELTRACE_BIN $trace_path 2>/dev/null)
1501         ret=$?
1502         if [ $ret -ne 0 ]; then
1503                 fail "Failed to parse trace"
1504                 return $ret
1505         fi
1506
1507         traced=$(echo -n "$events" | wc -l)
1508         if [ "$traced" -eq 0 ]; then
1509                 pass "Validate empty trace"
1510         else
1511                 fail "Validate empty trace"
1512                 diag "Found $traced events in trace"
1513         fi
1514         ret=$?
1515         return $ret
1516 }
1517
1518 function regenerate_metadata ()
1519 {
1520         local expected_to_fail=$1
1521         local sess_name=$2
1522
1523         $TESTDIR/../src/bin/lttng/$LTTNG_BIN regenerate metadata -s $sess_name 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
1524         ret=$?
1525         if [[ $expected_to_fail -eq "1" ]]; then
1526                 test "$ret" -ne "0"
1527                 ok $? "Expected fail on regenerate metadata $sess_name"
1528         else
1529                 ok $ret "Metadata regenerate $sess_name"
1530         fi
1531 }
1532
1533 function regenerate_metadata_ok ()
1534 {
1535         regenerate_metadata 0 "$@"
1536 }
1537
1538 function regenerate_metadata_fail ()
1539 {
1540         regenerate_metadata 1 "$@"
1541 }
1542
1543 function regenerate_statedump ()
1544 {
1545         local expected_to_fail=$1
1546         local sess_name=$2
1547
1548         $TESTDIR/../src/bin/lttng/$LTTNG_BIN regenerate statedump -s $sess_name 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
1549         ret=$?
1550         if [[ $expected_to_fail -eq "1" ]]; then
1551                 test "$ret" -ne "0"
1552                 ok $? "Expected fail on regenerate statedump $sess_name"
1553         else
1554                 ok $ret "Metadata regenerate $sess_name"
1555         fi
1556 }
1557
1558 function regenerate_statedump_ok ()
1559 {
1560         regenerate_statedump 0 "$@"
1561 }
1562
1563 function regenerate_statedump_fail ()
1564 {
1565         regenerate_statedump 1 "$@"
1566 }
1567
1568 function destructive_tests_enabled ()
1569 {
1570         if [ ${LTTNG_ENABLE_DESTRUCTIVE_TESTS} = "will-break-my-system" ]; then
1571                 return 0
1572         else
1573                 return 1
1574         fi
1575 }