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