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