tests/utils/utils.sh

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