tests/utils/utils.sh

   1 #!/src/bin/bash
   2 #
   3 # Copyright (C) - 2012 David Goulet <dgoulet@efficios.com>
   4 #
   5 # This library is free software; you can redistribute it and/or modify it under
   6 # the terms of the GNU Lesser General Public License as published by the Free
   7 # Software Foundation; version 2.1 of the License.
   8 #
   9 # This library is distributed in the hope that it will be useful, but WITHOUT
  10 # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  11 # FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more
  12 # details.
  13 #
  14 # You should have received a copy of the GNU Lesser General Public License
  15 # along with this library; if not, write to the Free Software Foundation, Inc.,
  16 # 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301 USA
  17
  18 SESSIOND_BIN="lttng-sessiond"
  19 SESSIOND_MATCH=".*lttng-sess.*"
  20 SESSIOND_PIDS=""
  21 RUNAS_BIN="lttng-runas"
  22 RUNAS_MATCH=".*lttng-runas.*"
  23 CONSUMERD_BIN="lttng-consumerd"
  24 CONSUMERD_MATCH=".*lttng-consumerd.*"
  25 RELAYD_BIN="lttng-relayd"
  26 RELAYD_MATCH=".*lttng-relayd.*"
  27 RELAYD_PIDS=""
  28 LTTNG_BIN="lttng"
  29 BABELTRACE_BIN="babeltrace"
  30 OUTPUT_DEST=/dev/null
  31 ERROR_OUTPUT_DEST=/dev/null
  32
  33 # Minimal kernel version supported for session daemon tests
  34 KERNEL_MAJOR_VERSION=2
  35 KERNEL_MINOR_VERSION=6
  36 KERNEL_PATCHLEVEL_VERSION=27
  37
  38 # We set the default UST register timeout to "wait forever", so that
  39 # basic tests don't have to worry about hitting timeouts on busy
  40 # systems. Specialized tests should test those corner-cases.
  41 export LTTNG_UST_REGISTER_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 opt=$2
 308
 309         DIR=$(readlink -f $TESTDIR)
 310
 311         if [ -z $(pgrep $RELAYD_MATCH) ]; then
 312                 $DIR/../src/bin/lttng-relayd/$RELAYD_BIN -b $opt 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
 313                 #$DIR/../src/bin/lttng-relayd/$RELAYD_BIN $opt -vvv >>/tmp/relayd.log 2>&1 &
 314                 if [ $? -eq 1 ]; then
 315                         if [ $withtap -eq "1" ]; then
 316                                 fail "Start lttng-relayd (opt: $opt)"
 317                         fi
 318                         return 1
 319                 else
 320                         if [ $withtap -eq "1" ]; then
 321                                 pass "Start lttng-relayd (opt: $opt)"
 322                         fi
 323                 fi
 324         else
 325                 pass "Start lttng-relayd (opt: $opt)"
 326         fi
 327
 328         RELAYD_PIDS=$(pgrep $RELAYD_MATCH)
 329 }
 330
 331 function start_lttng_relayd()
 332 {
 333         start_lttng_relayd_opt 1 "$@"
 334 }
 335
 336 function start_lttng_relayd_notap()
 337 {
 338         start_lttng_relayd_opt 0 "$@"
 339 }
 340
 341 function stop_lttng_relayd_opt()
 342 {
 343         local withtap=$1
 344
 345         if [ $withtap -eq "1" ]; then
 346                 diag "Killing lttng-relayd (pid: $RELAYD_PIDS)"
 347         fi
 348         kill $RELAYD_PIDS 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
 349         retval=$?
 350
 351         if [ $? -eq 1 ]; then
 352                 if [ $withtap -eq "1" ]; then
 353                         fail "Kill relay daemon"
 354                 fi
 355                 return 1
 356         else
 357                 out=1
 358                 while [ -n "$out" ]; do
 359                         out=$(pgrep $RELAYD_MATCH)
 360                         sleep 0.5
 361                 done
 362                 if [ $withtap -eq "1" ]; then
 363                         pass "Kill relay daemon"
 364                 fi
 365         fi
 366         RELAYD_PIDS=""
 367         return $retval
 368 }
 369
 370 function stop_lttng_relayd()
 371 {
 372         stop_lttng_relayd_opt 1 "$@"
 373 }
 374
 375 function stop_lttng_relayd_notap()
 376 {
 377         stop_lttng_relayd_opt 0 "$@"
 378 }
 379
 380 #First arg: show tap output
 381 #Second argument: load path for automatic loading
 382 function start_lttng_sessiond_opt()
 383 {
 384         local withtap=$1
 385         local load_path=$2
 386
 387         if [ -n $TEST_NO_SESSIOND ] && [ "$TEST_NO_SESSIOND" == "1" ]; then
 388                 # Env variable requested no session daemon
 389                 return
 390         fi
 391
 392         validate_kernel_version
 393         if [ $? -ne 0 ]; then
 394             fail "Start session daemon"
 395             BAIL_OUT "*** Kernel too old for session daemon tests ***"
 396         fi
 397
 398         DIR=$(readlink -f $TESTDIR)
 399         : ${LTTNG_SESSION_CONFIG_XSD_PATH=${DIR}/../src/common/config/}
 400         export LTTNG_SESSION_CONFIG_XSD_PATH
 401
 402         if [ -z $(pgrep ${SESSIOND_MATCH}) ]; then
 403                 # Have a load path ?
 404                 if [ -n "$load_path" ]; then
 405                         $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"
 406                 else
 407                         $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"
 408                 fi
 409                 #$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
 410                 status=$?
 411                 if [ $withtap -eq "1" ]; then
 412                         ok $status "Start session daemon"
 413                 fi
 414         fi
 415         SESSIOND_PIDS=$(pgrep $SESSIOND_MATCH)
 416 }
 417
 418 function start_lttng_sessiond()
 419 {
 420         start_lttng_sessiond_opt 1 "$@"
 421 }
 422
 423 function start_lttng_sessiond_notap()
 424 {
 425         start_lttng_sessiond_opt 0 "$@"
 426 }
 427
 428 function stop_lttng_sessiond_opt()
 429 {
 430         local withtap=$1
 431         local signal=$2
 432         local kill_opt=""
 433
 434         if [ -n $TEST_NO_SESSIOND ] && [ "$TEST_NO_SESSIOND" == "1" ]; then
 435                 # Env variable requested no session daemon
 436                 return
 437         fi
 438
 439         local pids="${SESSIOND_PIDS} $(pgrep $RUNAS_MATCH)"
 440
 441         if [ -n "$2" ]; then
 442                 kill_opt="$kill_opt -s $signal"
 443         fi
 444         if [ $withtap -eq "1" ]; then
 445                 diag "Killing $SESSIOND_BIN and lt-$SESSIOND_BIN pids: $(echo $pids | tr '\n' ' ')"
 446         fi
 447         kill $kill_opt $pids 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
 448
 449         if [ $? -eq 1 ]; then
 450                 if [ $withtap -eq "1" ]; then
 451                         fail "Kill sessions daemon"
 452                 fi
 453         else
 454                 out=1
 455                 while [ -n "$out" ]; do
 456                         out=$(pgrep ${SESSIOND_MATCH})
 457                         sleep 0.5
 458                 done
 459                 out=1
 460                 while [ -n "$out" ]; do
 461                         out=$(pgrep $CONSUMERD_MATCH)
 462                         sleep 0.5
 463                 done
 464
 465                 SESSIOND_PIDS=""
 466                 if [ $withtap -eq "1" ]; then
 467                         pass "Kill session daemon"
 468                 fi
 469         fi
 470 }
 471
 472 function stop_lttng_sessiond()
 473 {
 474         stop_lttng_sessiond_opt 1 "$@"
 475 }
 476
 477 function stop_lttng_sessiond_notap()
 478 {
 479         stop_lttng_sessiond_opt 0 "$@"
 480 }
 481
 482 function sigstop_lttng_sessiond_opt()
 483 {
 484         local withtap=$1
 485         local signal=SIGSTOP
 486         local kill_opt=""
 487
 488         if [ -n $TEST_NO_SESSIOND ] && [ "$TEST_NO_SESSIOND" == "1" ]; then
 489                 # Env variable requested no session daemon
 490                 return
 491         fi
 492
 493         PID_SESSIOND="$(pgrep ${SESSIOND_MATCH}) $(pgrep $RUNAS_MATCH)"
 494
 495         kill_opt="$kill_opt -s $signal"
 496
 497         if [ $withtap -eq "1" ]; then
 498                 diag "Sending SIGSTOP to lt-$SESSIOND_BIN and $SESSIOND_BIN pids: $(echo $PID_SESSIOND | tr '\n' ' ')"
 499         fi
 500         kill $kill_opt $PID_SESSIOND 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
 501
 502         if [ $? -eq 1 ]; then
 503                 if [ $withtap -eq "1" ]; then
 504                         fail "Sending SIGSTOP to session daemon"
 505                 fi
 506         else
 507                 out=1
 508                 while [ $out -ne 0 ]; do
 509                         pid=$(pgrep $SESSIOND_MATCH)
 510
 511                         # Wait until state becomes stopped for session
 512                         # daemon(s).
 513                         out=0
 514                         for sessiond_pid in $pid; do
 515                                 state=$(ps -p $sessiond_pid -o state= )
 516                                 if [[ -n "$state" && "$state" != "T" ]]; then
 517                                         out=1
 518                                 fi
 519                         done
 520                         sleep 0.5
 521                 done
 522                 if [ $withtap -eq "1" ]; then
 523                         pass "Sending SIGSTOP to session daemon"
 524                 fi
 525         fi
 526 }
 527
 528 function sigstop_lttng_sessiond()
 529 {
 530         sigstop_lttng_sessiond_opt 1 "$@"
 531 }
 532
 533 function sigstop_lttng_sessiond_notap()
 534 {
 535         sigstop_lttng_sessiond_opt 0 "$@"
 536 }
 537
 538 function stop_lttng_consumerd_opt()
 539 {
 540         local withtap=$1
 541         local signal=$2
 542         local kill_opt=""
 543
 544         PID_CONSUMERD=$(pgrep $CONSUMERD_MATCH)
 545
 546         if [ -n "$2" ]; then
 547                 kill_opt="$kill_opt -s $signal"
 548         fi
 549
 550         if [ $withtap -eq "1" ]; then
 551                 diag "Killing $CONSUMERD_BIN pids: $(echo $PID_CONSUMERD | tr '\n' ' ')"
 552         fi
 553         kill $kill_opt $PID_CONSUMERD 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
 554         retval=$?
 555         set +x
 556
 557         if [ $? -eq 1 ]; then
 558                 if [ $withtap -eq "1" ]; then
 559                         fail "Kill consumer daemon"
 560                 fi
 561                 return 1
 562         else
 563                 out=1
 564                 while [ $out -ne 0 ]; do
 565                         pid=$(pgrep $CONSUMERD_MATCH)
 566
 567                         # If consumerds are still present check their status.
 568                         # A zombie status qualifies the consumerd as *killed*
 569                         out=0
 570                         for consumer_pid in $pid; do
 571                                 state=$(ps -p $consumer_pid -o state= )
 572                                 if [[ -n "$state" && "$state" != "Z" ]]; then
 573                                         out=1
 574                                 fi
 575                         done
 576                         sleep 0.5
 577                 done
 578                 if [ $withtap -eq "1" ]; then
 579                         pass "Kill consumer daemon"
 580                 fi
 581         fi
 582         return $retval
 583 }
 584
 585 function stop_lttng_consumerd()
 586 {
 587         stop_lttng_consumerd_opt 1 "$@"
 588 }
 589
 590 function stop_lttng_consumerd_notap()
 591 {
 592         stop_lttng_consumerd_opt 0 "$@"
 593 }
 594
 595 function sigstop_lttng_consumerd_opt()
 596 {
 597         local withtap=$1
 598         local signal=SIGSTOP
 599         local kill_opt=""
 600
 601         PID_CONSUMERD=$(pgrep $CONSUMERD_MATCH)
 602
 603         kill_opt="$kill_opt -s $signal"
 604
 605         if [ $withtap -eq "1" ]; then
 606                 diag "Sending SIGSTOP to $CONSUMERD_BIN pids: $(echo $PID_CONSUMERD | tr '\n' ' ')"
 607         fi
 608         kill $kill_opt $PID_CONSUMERD 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
 609         retval=$?
 610         set +x
 611
 612         if [ $? -eq 1 ]; then
 613                 if [ $withtap -eq "1" ]; then
 614                         fail "Sending SIGSTOP to consumer daemon"
 615                 fi
 616                 return 1
 617         else
 618                 out=1
 619                 while [ $out -ne 0 ]; do
 620                         pid=$(pgrep $CONSUMERD_MATCH)
 621
 622                         # Wait until state becomes stopped for all
 623                         # consumers.
 624                         out=0
 625                         for consumer_pid in $pid; do
 626                                 state=$(ps -p $consumer_pid -o state= )
 627                                 if [[ -n "$state" && "$state" != "T" ]]; then
 628                                         out=1
 629                                 fi
 630                         done
 631                         sleep 0.5
 632                 done
 633                 if [ $withtap -eq "1" ]; then
 634                         pass "Sending SIGSTOP to consumer daemon"
 635                 fi
 636         fi
 637         return $retval
 638 }
 639
 640 function sigstop_lttng_consumerd()
 641 {
 642         sigstop_lttng_consumerd_opt 1 "$@"
 643 }
 644
 645 function sigstop_lttng_consumerd_notap()
 646 {
 647         sigstop_lttng_consumerd_opt 0 "$@"
 648 }
 649
 650 function list_lttng_with_opts ()
 651 {
 652         local opts=$1
 653         $TESTDIR/../src/bin/lttng/$LTTNG_BIN list $opts 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
 654         ok $? "Lttng-tool list command with option $opts"
 655 }
 656
 657 function create_lttng_session_no_output ()
 658 {
 659         local sess_name=$1
 660
 661         $TESTDIR/../src/bin/lttng/$LTTNG_BIN create $sess_name --no-output 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
 662         ok $? "Create session $sess_name in no-output mode"
 663 }
 664
 665 function create_lttng_session ()
 666 {
 667         local expected_to_fail=$1
 668         local sess_name=$2
 669         local trace_path=$3
 670         local opt=$4
 671
 672         $TESTDIR/../src/bin/lttng/$LTTNG_BIN create $sess_name -o $trace_path $opt > $OUTPUT_DEST
 673         ret=$?
 674         if [[ $expected_to_fail -eq "1" ]]; then
 675                 test "$ret" -ne "0"
 676                 ok $? "Create session $sess_name in $trace_path failed as expected"
 677         else
 678                 ok $ret "Create session $sess_name in $trace_path"
 679         fi
 680 }
 681
 682 function create_lttng_session_ok ()
 683 {
 684         create_lttng_session 0 "$@"
 685 }
 686
 687 function create_lttng_session_fail ()
 688 {
 689         create_lttng_session 1 "$@"
 690 }
 691
 692 function create_lttng_session_template ()
 693 {
 694         local expected_to_fail=$1
 695         local template_path=$2
 696         local opt=$3
 697
 698         $TESTDIR/../src/bin/lttng/$LTTNG_BIN create --template-path="$template_path" $opt > $OUTPUT_DEST
 699         ret=$?
 700         if [[ $expected_to_fail -eq "1" ]]; then
 701                 test "$ret" -ne "0"
 702                 ok $? "Create session from template $template_path failed as expected"
 703         else
 704                 ok $ret "Create session from template $template_path"
 705         fi
 706 }
 707
 708 function create_lttng_session_template_ok () {
 709         create_lttng_session_template 0 "$@"
 710 }
 711
 712 function create_lttng_session_template_fail () {
 713         create_lttng_session_template 1 "$@"
 714 }
 715
 716 function enable_ust_lttng_channel ()
 717 {
 718         local expected_to_fail=$1
 719         local sess_name=$2
 720         local channel_name=$3
 721         local opt=$4
 722
 723         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-channel -u $channel_name -s $sess_name $opt 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
 724         ret=$?
 725         if [[ $expected_to_fail -eq "1" ]]; then
 726                 test "$ret" -ne "0"
 727                 ok $? "Enable channel $channel_name for session $sess_name failed as expected"
 728         else
 729                 ok $ret "Enable channel $channel_name for session $sess_name"
 730         fi
 731 }
 732
 733 function enable_ust_lttng_channel_ok ()
 734 {
 735         enable_ust_lttng_channel 0 "$@"
 736 }
 737
 738 function enable_ust_lttng_channel_fail ()
 739 {
 740         enable_ust_lttng_channel 1 "$@"
 741 }
 742
 743 function disable_ust_lttng_channel()
 744 {
 745         local sess_name=$1
 746         local channel_name=$2
 747
 748         $TESTDIR/../src/bin/lttng/$LTTNG_BIN disable-channel -u $channel_name -s $sess_name 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
 749         ok $? "Disable channel $channel_name for session $sess_name"
 750 }
 751
 752 function enable_lttng_mmap_overwrite_kernel_channel()
 753 {
 754         local sess_name=$1
 755         local channel_name=$2
 756
 757         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-channel -s $sess_name $channel_name -k --output mmap --overwrite 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
 758         ok $? "Enable channel $channel_name for session $sess_name"
 759 }
 760
 761 function enable_lttng_mmap_discard_small_kernel_channel()
 762 {
 763         local sess_name=$1
 764         local channel_name=$2
 765
 766         $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
 767         ok $? "Enable small discard channel $channel_name for session $sess_name"
 768 }
 769
 770 function enable_lttng_mmap_overwrite_small_kernel_channel()
 771 {
 772         local sess_name=$1
 773         local channel_name=$2
 774
 775         $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
 776         ok $? "Enable small discard channel $channel_name for session $sess_name"
 777 }
 778
 779 function enable_lttng_mmap_overwrite_ust_channel()
 780 {
 781         local sess_name=$1
 782         local channel_name=$2
 783
 784         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-channel -s $sess_name $channel_name -u --output mmap --overwrite 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
 785         ok $? "Enable channel $channel_name for session $sess_name"
 786 }
 787
 788 function enable_ust_lttng_event ()
 789 {
 790         local expected_to_fail=$1
 791         local sess_name=$2
 792         local event_name="$3"
 793         local channel_name=$4
 794
 795         if [ -z $channel_name ]; then
 796                 # default channel if none specified
 797                 chan=""
 798         else
 799                 chan="-c $channel_name"
 800         fi
 801
 802         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event "$event_name" $chan -s $sess_name -u 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
 803         ret=$?
 804         if [[ $expected_to_fail -eq "1" ]]; then
 805                 test $ret -ne "0"
 806                 ok $? "Enable ust event $event_name for session $session_name failed as expected"
 807         else
 808                 ok $ret "Enable ust event $event_name for session $sess_name"
 809         fi
 810 }
 811
 812 function enable_ust_lttng_event_ok ()
 813 {
 814         enable_ust_lttng_event 0 "$@"
 815 }
 816
 817 function enable_ust_lttng_event_fail ()
 818 {
 819         enable_ust_lttng_event 1 "$@"
 820 }
 821
 822 function enable_jul_lttng_event()
 823 {
 824         sess_name=$1
 825         event_name="$2"
 826         channel_name=$3
 827
 828         if [ -z $channel_name ]; then
 829                 # default channel if none specified
 830                 chan=""
 831         else
 832                 chan="-c $channel_name"
 833         fi
 834
 835         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event "$event_name" $chan -s $sess_name -j 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
 836         ok $? "Enable JUL event $event_name for session $sess_name"
 837 }
 838
 839 function enable_jul_lttng_event_loglevel()
 840 {
 841         local sess_name=$1
 842         local event_name="$2"
 843         local loglevel=$3
 844         local channel_name=$4
 845
 846         if [ -z $channel_name ]; then
 847                 # default channel if none specified
 848                 chan=""
 849         else
 850                 chan="-c $channel_name"
 851         fi
 852
 853         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event --loglevel $loglevel "$event_name" $chan -s $sess_name -j 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
 854         ok $? "Enable JUL event $event_name for session $sess_name with loglevel $loglevel"
 855 }
 856
 857 function enable_log4j_lttng_event()
 858 {
 859         sess_name=$1
 860         event_name="$2"
 861         channel_name=$3
 862
 863         if [ -z $channel_name ]; then
 864                 # default channel if none specified
 865                 chan=""
 866         else
 867                 chan="-c $channel_name"
 868         fi
 869
 870         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event "$event_name" $chan -s $sess_name -l 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
 871         ok $? "Enable LOG4J event $event_name for session $sess_name"
 872 }
 873
 874 function enable_log4j_lttng_event_loglevel()
 875 {
 876         local sess_name=$1
 877         local event_name="$2"
 878         local loglevel=$3
 879         local channel_name=$4
 880
 881         if [ -z $channel_name ]; then
 882                 # default channel if none specified
 883                 chan=""
 884         else
 885                 chan="-c $channel_name"
 886         fi
 887
 888         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event --loglevel $loglevel "$event_name" $chan -s $sess_name -l 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
 889         ok $? "Enable LOG4J event $event_name for session $sess_name with loglevel $loglevel"
 890 }
 891
 892 function enable_python_lttng_event()
 893 {
 894         sess_name=$1
 895         event_name="$2"
 896         channel_name=$3
 897
 898         if [ -z $channel_name ]; then
 899                 # default channel if none specified
 900                 chan=""
 901         else
 902                 chan="-c $channel_name"
 903         fi
 904
 905         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event "$event_name" $chan -s $sess_name -p 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
 906         ok $? "Enable Python event $event_name for session $sess_name"
 907 }
 908
 909 function enable_python_lttng_event_loglevel()
 910 {
 911         local sess_name=$1
 912         local event_name="$2"
 913         local loglevel=$3
 914         local channel_name=$4
 915
 916         if [ -z $channel_name ]; then
 917                 # default channel if none specified
 918                 chan=""
 919         else
 920                 chan="-c $channel_name"
 921         fi
 922
 923         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event --loglevel $loglevel "$event_name" $chan -s $sess_name -p 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
 924         ok $? "Enable Python event $event_name for session $sess_name with loglevel $loglevel"
 925 }
 926
 927 function enable_ust_lttng_event_filter()
 928 {
 929         local sess_name="$1"
 930         local event_name="$2"
 931         local filter="$3"
 932
 933         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event "$event_name" -s $sess_name -u --filter "$filter" 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
 934         ok $? "Enable event $event_name with filtering for session $sess_name"
 935 }
 936
 937 function enable_ust_lttng_event_loglevel()
 938 {
 939         local sess_name="$1"
 940         local event_name="$2"
 941         local loglevel="$3"
 942
 943         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event "$event_name" -s $sess_name -u --loglevel $loglevel 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
 944         ok $? "Enable event $event_name with loglevel $loglevel"
 945 }
 946
 947 function enable_ust_lttng_event_loglevel_only()
 948 {
 949         local sess_name="$1"
 950         local event_name="$2"
 951         local loglevel="$3"
 952
 953         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event "$event_name" -s $sess_name -u --loglevel-only $loglevel 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
 954         ok $? "Enable event $event_name with loglevel-only $loglevel"
 955 }
 956
 957 function disable_ust_lttng_event ()
 958 {
 959         local sess_name="$1"
 960         local event_name="$2"
 961         local channel_name="$3"
 962
 963         if [ -z $channel_name ]; then
 964                 # default channel if none specified
 965                 chan=""
 966         else
 967                 chan="-c $channel_name"
 968         fi
 969
 970         $TESTDIR/../src/bin/lttng/$LTTNG_BIN disable-event "$event_name" -s $sess_name $chan -u 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
 971         ok $? "Disable event $event_name for session $sess_name"
 972 }
 973
 974 function disable_jul_lttng_event ()
 975 {
 976         local sess_name="$1"
 977         local event_name="$2"
 978
 979         $TESTDIR/../src/bin/lttng/$LTTNG_BIN disable-event "$event_name" -s $sess_name -j >/dev/null 2>&1
 980         ok $? "Disable JUL event $event_name for session $sess_name"
 981 }
 982
 983 function disable_log4j_lttng_event ()
 984 {
 985         local sess_name="$1"
 986         local event_name="$2"
 987
 988         $TESTDIR/../src/bin/lttng/$LTTNG_BIN disable-event "$event_name" -s $sess_name -l >/dev/null 2>&1
 989         ok $? "Disable LOG4J event $event_name for session $sess_name"
 990 }
 991
 992 function disable_python_lttng_event ()
 993 {
 994         local sess_name="$1"
 995         local event_name="$2"
 996
 997         $TESTDIR/../src/bin/lttng/$LTTNG_BIN disable-event "$event_name" -s $sess_name -p 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
 998         ok $? "Disable Python event $event_name for session $sess_name"
 999 }
1000
1001 function start_lttng_tracing ()
1002 {
1003         local expected_to_fail=$1
1004         local sess_name=$2
1005
1006         $TESTDIR/../src/bin/lttng/$LTTNG_BIN start $sess_name 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
1007         ret=$?
1008         if [[ $expected_to_fail -eq "1" ]]; then
1009                 test "$ret" -ne "0"
1010                 ok $? "Start tracing for session $sess_name failed as expected"
1011         else
1012                 ok $ret "Start tracing for session $sess_name"
1013         fi
1014 }
1015
1016 function start_lttng_tracing_ok ()
1017 {
1018         start_lttng_tracing 0 "$@"
1019 }
1020
1021 function start_lttng_tracing_fail ()
1022 {
1023         start_lttng_tracing 1 "$@"
1024 }
1025
1026 function stop_lttng_tracing ()
1027 {
1028         local expected_to_fail=$1
1029         local sess_name=$2
1030
1031         $TESTDIR/../src/bin/lttng/$LTTNG_BIN stop $sess_name 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
1032         ret=$?
1033         if [[ $expected_to_fail -eq "1" ]]; then
1034                 test "$ret" -ne "0"
1035                 ok $? "Stop lttng tracing for session $sess_name failed as expected"
1036         else
1037                 ok $ret "Stop lttng tracing for session $sess_name"
1038         fi
1039 }
1040
1041 function stop_lttng_tracing_ok ()
1042 {
1043         stop_lttng_tracing 0 "$@"
1044 }
1045
1046 function stop_lttng_tracing_fail ()
1047 {
1048         stop_lttng_tracing 1 "$@"
1049 }
1050
1051 function destroy_lttng_session ()
1052 {
1053         local expected_to_fail=$1
1054         local sess_name=$2
1055
1056         $TESTDIR/../src/bin/lttng/$LTTNG_BIN destroy $sess_name 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
1057         ret=$?
1058         if [[ $expected_to_fail -eq "1" ]]; then
1059                 test "$ret" -ne "0"
1060                 ok $? "Destroy session $sess_name failed as expected"
1061         else
1062                 ok $ret "Destroy session $sess_name"
1063         fi
1064 }
1065
1066 function destroy_lttng_session_ok ()
1067 {
1068         destroy_lttng_session 0 "$@"
1069
1070 }
1071
1072 function destroy_lttng_session_fail ()
1073 {
1074         destroy_lttng_session 1 "$@"
1075 }
1076
1077
1078 function destroy_lttng_sessions ()
1079 {
1080         $TESTDIR/../src/bin/lttng/$LTTNG_BIN destroy --all 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
1081         ok $? "Destroy all lttng sessions"
1082 }
1083
1084 function lttng_snapshot_add_output ()
1085 {
1086         local expected_to_fail=$1
1087         local sess_name=$2
1088         local trace_path=$3
1089
1090         $TESTDIR/../src/bin/lttng/$LTTNG_BIN snapshot add-output -s $sess_name file://$trace_path 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
1091         ret=$?
1092         if [[ $expected_to_fail -eq 1 ]]; then
1093                 test "$ret" -ne "0"
1094                 ok $? "Added snapshot output file://$trace_path failed as expected"
1095         else
1096                 ok $ret "Added snapshot output file://$trace_path"
1097         fi
1098 }
1099
1100 function lttng_snapshot_add_output_ok ()
1101 {
1102         lttng_snapshot_add_output 0 "$@"
1103 }
1104
1105 function lttng_snapshot_add_output_fail ()
1106 {
1107         lttng_snapshot_add_output 1 "$@"
1108 }
1109
1110 function lttng_snapshot_del_output ()
1111 {
1112         local expected_to_fail=$1
1113         local sess_name=$2
1114         local id=$3
1115
1116         $TESTDIR/../src/bin/lttng/$LTTNG_BIN snapshot del-output -s $sess_name $id 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
1117         ret=$?
1118         if [[ $expected_to_fail -eq "1" ]]; then
1119                 test "$ret" -ne "0"
1120                 ok $? "Deleted snapshot output id $id failed as expected"
1121         else
1122                 ok $ret "Deleted snapshot output id $id"
1123         fi
1124 }
1125
1126 function lttng_snapshot_del_output_ok ()
1127 {
1128         lttng_snapshot_del_output 0 "$@"
1129 }
1130
1131 function lttng_snapshot_del_output_fail ()
1132 {
1133         lttng_snapshot_del_output 1 "$@"
1134 }
1135
1136 function lttng_snapshot_record ()
1137 {
1138         local sess_name=$1
1139         local trace_path=$2
1140
1141         $TESTDIR/../src/bin/lttng/$LTTNG_BIN snapshot record -s $sess_name 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
1142         ok $? "Snapshot recorded"
1143 }
1144
1145 function lttng_snapshot_list ()
1146 {
1147         local sess_name=$1
1148         $TESTDIR/../src/bin/lttng/$LTTNG_BIN snapshot list-output -s $sess_name 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
1149         ok $? "Snapshot list"
1150 }
1151
1152 function lttng_save()
1153 {
1154         local sess_name=$1
1155         local opts=$2
1156
1157         $TESTDIR/../src/bin/lttng/$LTTNG_BIN save $sess_name $opts 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
1158         ok $? "Session saved"
1159 }
1160
1161 function lttng_load()
1162 {
1163         local opts=$1
1164
1165         $TESTDIR/../src/bin/lttng/$LTTNG_BIN load $opts 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
1166         ok $? "Load command with opts: $opts"
1167 }
1168
1169 function lttng_track()
1170 {
1171         local expected_to_fail=$1
1172         local opts=$2
1173         $TESTDIR/../src/bin/lttng/$LTTNG_BIN track $opts >$OUTPUT_DEST
1174         ret=$?
1175         if [[ $expected_to_fail -eq "1" ]]; then
1176                 test $ret -ne "0"
1177                 ok $? "Track command failed as expected with opts: $opts"
1178         else
1179                 ok $ret "Track command with opts: $opts"
1180         fi
1181 }
1182
1183 function lttng_track_ok()
1184 {
1185         lttng_track 0 "$@"
1186 }
1187
1188 function lttng_track_fail()
1189 {
1190         lttng_track 1 "$@"
1191 }
1192
1193 function lttng_untrack()
1194 {
1195         local expected_to_fail=$1
1196         local opts=$2
1197         $TESTDIR/../src/bin/lttng/$LTTNG_BIN untrack $opts >$OUTPUT_DEST
1198         ret=$?
1199         if [[ $expected_to_fail -eq "1" ]]; then
1200                 test $ret -ne "0"
1201                 ok $? "Untrack command failed as expected with opts: $opts"
1202         else
1203                 ok $ret "Untrack command with opts: $opts"
1204         fi
1205 }
1206
1207 function lttng_untrack_ok()
1208 {
1209         lttng_untrack 0 "$@"
1210 }
1211
1212 function lttng_untrack_fail()
1213 {
1214         lttng_untrack 1 "$@"
1215 }
1216
1217 function add_context_lttng()
1218 {
1219         local expected_to_fail="$1"
1220         local domain="$2"
1221         local session_name="$3"
1222         local channel_name="$4"
1223         local type="$5"
1224
1225         $TESTDIR/../src/bin/lttng/$LTTNG_BIN add-context -s $session_name -c $channel_name -t $type $domain  1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
1226         ret=$?
1227         if [[ $expected_to_fail -eq "1" ]]; then
1228                 test $ret -ne "0"
1229                 ok $? "Add context command failed as expected for type: $type"
1230         else
1231                 ok $ret "Add context command for type: $type"
1232         fi
1233 }
1234
1235 function add_context_ust_ok()
1236 {
1237         add_context_lttng 0 -u "$@"
1238 }
1239
1240 function add_context_ust_fail()
1241 {
1242         add_context_lttng 1 -u "$@"
1243 }
1244
1245 function add_context_kernel_ok()
1246 {
1247         add_context_lttng 0 -k "$@"
1248 }
1249
1250 function add_context_kernel_fail()
1251 {
1252         add_context_lttng 1 -k "$@"
1253 }
1254
1255 function trace_matches ()
1256 {
1257         local event_name=$1
1258         local nr_iter=$2
1259         local trace_path=$3
1260
1261         which $BABELTRACE_BIN >/dev/null
1262         skip $? -ne 0 "Babeltrace binary not found. Skipping trace matches"
1263
1264         local count=$($BABELTRACE_BIN $trace_path | grep $event_name | wc -l)
1265
1266         if [ "$count" -ne "$nr_iter" ]; then
1267                 fail "Trace match"
1268                 diag "$count matching events found in trace"
1269         else
1270                 pass "Trace match"
1271         fi
1272 }
1273
1274 function trace_match_only()
1275 {
1276         local event_name=$1
1277         local nr_iter=$2
1278         local trace_path=$3
1279
1280         which $BABELTRACE_BIN >/dev/null
1281         skip $? -ne 0 "Babeltrace binary not found. Skipping trace matches"
1282
1283         local count=$($BABELTRACE_BIN $trace_path | grep $event_name | wc -l)
1284         local total=$($BABELTRACE_BIN $trace_path | wc -l)
1285
1286     if [ "$nr_iter" -eq "$count" ] && [ "$total" -eq "$nr_iter" ]; then
1287         pass "Trace match with $total event $event_name"
1288     else
1289         fail "Trace match"
1290         diag "$total event(s) found, expecting $nr_iter of event $event_name and only found $count"
1291     fi
1292 }
1293
1294 function validate_trace
1295 {
1296         local event_name=$1
1297         local trace_path=$2
1298
1299         which $BABELTRACE_BIN >/dev/null
1300         if [ $? -ne 0 ]; then
1301             skip 0 "Babeltrace binary not found. Skipping trace validation"
1302         fi
1303
1304         OLDIFS=$IFS
1305         IFS=","
1306         for i in $event_name; do
1307                 traced=$($BABELTRACE_BIN $trace_path 2>/dev/null | grep $i | wc -l)
1308                 if [ "$traced" -ne 0 ]; then
1309                         pass "Validate trace for event $i, $traced events"
1310                 else
1311                         fail "Validate trace for event $i"
1312                         diag "Found $traced occurences of $i"
1313                 fi
1314         done
1315         ret=$?
1316         IFS=$OLDIFS
1317         return $ret
1318 }
1319
1320 function trace_first_line
1321 {
1322         local trace_path=$1
1323
1324         which $BABELTRACE_BIN >/dev/null
1325         if [ $? -ne 0 ]; then
1326             skip 0 "Babeltrace binary not found. Skipping trace validation"
1327         fi
1328
1329         $BABELTRACE_BIN $trace_path 2>/dev/null | head -n 1
1330 }
1331
1332 function validate_trace_exp()
1333 {
1334         local event_exp=$1
1335         local trace_path=$2
1336
1337         which $BABELTRACE_BIN >/dev/null
1338         skip $? -ne 0 "Babeltrace binary not found. Skipping trace validation"
1339
1340         traced=$($BABELTRACE_BIN $trace_path 2>/dev/null | grep ${event_exp} | wc -l)
1341         if [ "$traced" -ne 0 ]; then
1342                 pass "Validate trace for expression '${event_exp}', $traced events"
1343         else
1344                 fail "Validate trace for expression '${event_exp}'"
1345                 diag "Found $traced occurences of '${event_exp}'"
1346         fi
1347         ret=$?
1348         return $ret
1349 }
1350
1351 function validate_trace_only_exp()
1352 {
1353         local event_exp=$1
1354         local trace_path=$2
1355
1356         which $BABELTRACE_BIN >/dev/null
1357         skip $? -ne 0 "Babeltrace binary not found. Skipping trace matches"
1358
1359         local count=$($BABELTRACE_BIN $trace_path | grep ${event_exp} | wc -l)
1360         local total=$($BABELTRACE_BIN $trace_path | wc -l)
1361
1362         if [ "$count" -ne 0 ] && [ "$total" -eq "$count" ]; then
1363                 pass "Trace match with $total for expression '${event_exp}"
1364         else
1365                 fail "Trace match"
1366                 diag "$total syscall event(s) found, only syscalls matching expression '${event_exp}' ($count occurrences) are expected"
1367         fi
1368         ret=$?
1369         return $ret
1370 }
1371
1372 function validate_trace_empty()
1373 {
1374         local trace_path=$1
1375
1376         which $BABELTRACE_BIN >/dev/null
1377         if [ $? -ne 0 ]; then
1378             skip 0 "Babeltrace binary not found. Skipping trace validation"
1379         fi
1380
1381         traced=$($BABELTRACE_BIN $trace_path 2>/dev/null | wc -l)
1382         if [ "$traced" -eq 0 ]; then
1383                 pass "Validate empty trace"
1384         else
1385                 fail "Validate empty trace"
1386                 diag "Found $traced events in trace"
1387         fi
1388         ret=$?
1389         return $ret
1390 }
1391
1392 function metadata_regenerate ()
1393 {
1394         local expected_to_fail=$1
1395         local sess_name=$2
1396
1397         $TESTDIR/../src/bin/lttng/$LTTNG_BIN metadata regenerate -s $sess_name 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
1398         ret=$?
1399         if [[ $expected_to_fail -eq "1" ]]; then
1400                 test "$ret" -ne "0"
1401                 ok $? "Expected fail on regenerate $sess_name"
1402         else
1403                 ok $ret "Metadata regenerate $sess_name"
1404         fi
1405 }
1406
1407 function metadata_regenerate_ok ()
1408 {
1409         metadata_regenerate 0 "$@"
1410 }
1411
1412 function metadata_regenerate_fail ()
1413 {
1414         metadata_regenerate 1 "$@"
1415 }
1416
1417 function destructive_tests_enabled ()
1418 {
1419         if [ ${LTTNG_ENABLE_DESTRUCTIVE_TESTS} = "will-break-my-system" ]; then
1420                 return 0
1421         else
1422                 return 1
1423         fi
1424 }