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