tests/utils/utils.sh

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