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