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 # Check if base lttng-modules are present.
 129 # Bail out on failure
 130 function validate_lttng_modules_present ()
 131 {
 132         modprobe -n lttng-tracer 2>/dev/null
 133         if [ $? -ne 0  ]; then
 134                 BAIL_OUT "LTTng modules not detected."
 135         fi
 136 }
 137
 138 function enable_kernel_lttng_event
 139 {
 140         local withtap="$1"
 141         local expected_to_fail="$2"
 142         local sess_name="$3"
 143         local event_name="$4"
 144         local channel_name="$5"
 145
 146         if [ -z "$event_name" ]; then
 147                 # Enable all event if no event name specified
 148                 event_name="-a"
 149         fi
 150
 151         if [ -z "$channel_name" ]; then
 152                 # default channel if none specified
 153                 chan=""
 154         else
 155                 chan="-c $channel_name"
 156         fi
 157
 158         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event "$event_name" $chan -s $sess_name -k 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
 159         ret=$?
 160         if [[ $expected_to_fail -eq "1" ]]; then
 161                 test $ret -ne "0"
 162                 ret=$?
 163                 if [ $withtap -eq "1" ]; then
 164                         ok $ret "Enable kernel event $event_name for session $session_name on channel $channel_name failed as expected"
 165                 fi
 166         else
 167                 if [ $withtap -eq "1" ]; then
 168                         ok $ret "Enable kernel event $event_name for session $sess_name"
 169                 fi
 170         fi
 171 }
 172
 173 function enable_kernel_lttng_event_ok ()
 174 {
 175         enable_kernel_lttng_event 1 0 "$@"
 176 }
 177
 178 function enable_kernel_lttng_event_fail ()
 179 {
 180         enable_kernel_lttng_event 1 1 "$@"
 181 }
 182
 183 function enable_kernel_lttng_event_notap ()
 184 {
 185         enable_kernel_lttng_event 0 0 "$@"
 186 }
 187
 188 # Old interface
 189 function lttng_enable_kernel_event
 190 {
 191         enable_kernel_lttng_event_ok "$@"
 192 }
 193
 194 function lttng_enable_kernel_syscall()
 195 {
 196         local expected_to_fail=$1
 197         local sess_name=$2
 198         local syscall_name=$3
 199         local channel_name=$4
 200
 201         if [ -z $syscall_name ]; then
 202                 # Enable all event if no syscall name specified
 203                 syscall_name="-a"
 204         fi
 205
 206         if [ -z $channel_name ]; then
 207                 # default channel if none specified
 208                 chan=""
 209         else
 210                 chan="-c $channel_name"
 211         fi
 212
 213         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event --syscall "$syscall_name" $chan -s $sess_name -k 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
 214         ret=$?
 215         if [[ $expected_to_fail -eq "1" ]]; then
 216                 test $ret -ne "0"
 217                 ok $? "Enable kernel syscall $syscall_name for session $sess_name on channel $channel_name fail as expected"
 218         else
 219                 ok $ret "Enable kernel syscall $syscall_name for session $sess_name on channel $channel_name"
 220         fi
 221 }
 222
 223 function lttng_enable_kernel_syscall_ok()
 224 {
 225         lttng_enable_kernel_syscall 0 "$@"
 226 }
 227
 228 function lttng_enable_kernel_syscall_fail()
 229 {
 230         lttng_enable_kernel_syscall 1 "$@"
 231 }
 232
 233 function lttng_disable_kernel_syscall()
 234 {
 235         local expected_to_fail=$1
 236         local sess_name=$2
 237         local syscall_name=$3
 238         local channel_name=$4
 239
 240         if [ -z $syscall_name ]; then
 241                 # Enable all event if no syscall name specified
 242                 syscall_name="-a"
 243         fi
 244
 245         if [ -z $channel_name ]; then
 246                 # default channel if none specified
 247                 chan=""
 248         else
 249                 chan="-c $channel_name"
 250         fi
 251
 252         $TESTDIR/../src/bin/lttng/$LTTNG_BIN disable-event --syscall "$syscall_name" $chan -s $sess_name -k 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
 253
 254         ret=$?
 255         if [[ $expected_to_fail -eq "1" ]]; then
 256                 test $ret -ne "0"
 257                 ok $? "Disable kernel syscall $syscall_name for session $sess_name on channel $channel_name failed as expected"
 258         else
 259                 ok $ret "Disable kernel syscall $syscall_name for session $sess_name on channel $channel_name"
 260         fi
 261 }
 262
 263 function lttng_disable_kernel_syscall_ok()
 264 {
 265         lttng_disable_kernel_syscall 0 "$@"
 266 }
 267
 268 function lttng_disable_kernel_syscall_fail()
 269 {
 270         lttng_disable_kernel_syscall 1 "$@"
 271 }
 272
 273 function lttng_enable_kernel_channel()
 274 {
 275         local withtap=$1
 276         local expected_to_fail=$2
 277         local sess_name=$3
 278         local channel_name=$4
 279         local opt=$5
 280
 281         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-channel -k $channel_name -s $sess_name $opt 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
 282         ret=$?
 283         if [[ $expected_to_fail -eq "1" ]]; then
 284                 test "$ret" -ne "0"
 285                 ret=$?
 286                 if [ $withtap -eq "1" ]; then
 287                         ok $ret "Enable channel $channel_name for session $sess_name failed as expected"
 288                 fi
 289         else
 290                 if [ $withtap -eq "1" ]; then
 291                         ok $ret "Enable channel $channel_name for session $sess_name"
 292                 fi
 293         fi
 294 }
 295
 296 function lttng_enable_kernel_channel_ok()
 297 {
 298         lttng_enable_kernel_channel 1 0 "$@"
 299 }
 300
 301 function lttng_enable_kernel_channel_fail()
 302 {
 303         lttng_enable_kernel_channel 1 1 "$@"
 304 }
 305
 306 function lttng_enable_kernel_channel_notap()
 307 {
 308         lttng_enable_kernel_channel 0 0 "$@"
 309 }
 310
 311 function enable_kernel_lttng_channel_ok()
 312 {
 313         lttng_enable_kernel_channel 1 0 "$@"
 314 }
 315
 316 function lttng_disable_kernel_channel()
 317 {
 318         local expected_to_fail=$1
 319         local sess_name=$2
 320         local channel_name=$3
 321
 322         $TESTDIR/../src/bin/lttng/$LTTNG_BIN disable-channel -k $channel_name -s $sess_name 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
 323         ret=$?
 324         if [[ $expected_to_fail -eq "1" ]]; then
 325                 test "$ret" -ne "0"
 326                 ok $? "Disable channel $channel_name for session $sess_name failed as expected"
 327         else
 328                 ok $ret "Disable channel $channel_name for session $sess_name"
 329         fi
 330 }
 331
 332 function lttng_disable_kernel_channel_ok()
 333 {
 334         lttng_disable_kernel_channel 0 "$@"
 335 }
 336
 337 function lttng_disable_kernel_channel_fail()
 338 {
 339         lttng_disable_kernel_channel 1 "$@"
 340 }
 341
 342 function start_lttng_relayd_opt()
 343 {
 344         local withtap=$1
 345         local opt=$2
 346         local env_vars=""
 347
 348         DIR=$(readlink -f $TESTDIR)
 349
 350         # Check for env. variable. Allow the use of LD_PRELOAD etc.
 351         if [[ "x${LTTNG_RELAYD_ENV_VARS}" != "x" ]]; then
 352                 env_vars=${LTTNG_RELAYD_ENV_VARS}
 353         fi
 354
 355         if [ -z $(pgrep $RELAYD_MATCH) ]; then
 356                 env $env_vars $DIR/../src/bin/lttng-relayd/$RELAYD_BIN -b $opt 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
 357                 #$DIR/../src/bin/lttng-relayd/$RELAYD_BIN $opt -vvv >>/tmp/relayd.log 2>&1 &
 358                 if [ $? -eq 1 ]; then
 359                         if [ $withtap -eq "1" ]; then
 360                                 fail "Start lttng-relayd (opt: $opt)"
 361                         fi
 362                         return 1
 363                 else
 364                         if [ $withtap -eq "1" ]; then
 365                                 pass "Start lttng-relayd (opt: $opt)"
 366                         fi
 367                 fi
 368         else
 369                 pass "Start lttng-relayd (opt: $opt)"
 370         fi
 371
 372         RELAYD_PIDS=$(pgrep $RELAYD_MATCH)
 373 }
 374
 375 function start_lttng_relayd()
 376 {
 377         start_lttng_relayd_opt 1 "$@"
 378 }
 379
 380 function start_lttng_relayd_notap()
 381 {
 382         start_lttng_relayd_opt 0 "$@"
 383 }
 384
 385 function stop_lttng_relayd_opt()
 386 {
 387         local withtap=$1
 388
 389         if [ $withtap -eq "1" ]; then
 390                 diag "Killing lttng-relayd (pid: $RELAYD_PIDS)"
 391         fi
 392         kill $RELAYD_PIDS 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
 393         retval=$?
 394
 395         if [ $? -eq 1 ]; then
 396                 if [ $withtap -eq "1" ]; then
 397                         fail "Kill relay daemon"
 398                 fi
 399                 return 1
 400         else
 401                 out=1
 402                 while [ -n "$out" ]; do
 403                         out=$(pgrep $RELAYD_MATCH)
 404                         sleep 0.5
 405                 done
 406                 if [ $withtap -eq "1" ]; then
 407                         pass "Kill relay daemon"
 408                 fi
 409         fi
 410         RELAYD_PIDS=""
 411         return $retval
 412 }
 413
 414 function stop_lttng_relayd()
 415 {
 416         stop_lttng_relayd_opt 1 "$@"
 417 }
 418
 419 function stop_lttng_relayd_notap()
 420 {
 421         stop_lttng_relayd_opt 0 "$@"
 422 }
 423
 424 #First arg: show tap output
 425 #Second argument: load path for automatic loading
 426 function start_lttng_sessiond_opt()
 427 {
 428         local withtap=$1
 429         local load_path=$2
 430
 431         local env_vars=""
 432         local consumerd=""
 433         local long_bit_value=$(getconf LONG_BIT)
 434
 435         if [ -n $TEST_NO_SESSIOND ] && [ "$TEST_NO_SESSIOND" == "1" ]; then
 436                 # Env variable requested no session daemon
 437                 return
 438         fi
 439
 440         DIR=$(readlink -f $TESTDIR)
 441
 442         # Get long_bit value for 32/64 consumerd
 443         case "$long_bit_value" in
 444                 32)
 445                         consumerd="--consumerd32-path=$DIR/../src/bin/lttng-consumerd/lttng-consumerd"
 446                         ;;
 447                 64)
 448                         consumerd="--consumerd64-path=$DIR/../src/bin/lttng-consumerd/lttng-consumerd"
 449                         ;;
 450                 *)
 451                         return
 452                         ;;
 453         esac
 454
 455         # Check for env. variable. Allow the use of LD_PRELOAD etc.
 456         if [[ "x${LTTNG_SESSIOND_ENV_VARS}" != "x" ]]; then
 457                 env_vars=${LTTNG_SESSIOND_ENV_VARS}
 458         fi
 459
 460         validate_kernel_version
 461         if [ $? -ne 0 ]; then
 462             fail "Start session daemon"
 463             BAIL_OUT "*** Kernel too old for session daemon tests ***"
 464         fi
 465
 466         : ${LTTNG_SESSION_CONFIG_XSD_PATH=${DIR}/../src/common/config/}
 467         export LTTNG_SESSION_CONFIG_XSD_PATH
 468
 469         if [ -z $(pgrep ${SESSIOND_MATCH}) ]; then
 470                 # Have a load path ?
 471                 if [ -n "$load_path" ]; then
 472                         env $env_vars $DIR/../src/bin/lttng-sessiond/$SESSIOND_BIN --load "$load_path" --background $consumerd
 473                 else
 474                         env $env_vars $DIR/../src/bin/lttng-sessiond/$SESSIOND_BIN --background $consumerd
 475                 fi
 476                 #$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
 477                 status=$?
 478                 if [ $withtap -eq "1" ]; then
 479                         ok $status "Start session daemon"
 480                 fi
 481         fi
 482         SESSIOND_PIDS=$(pgrep $SESSIOND_MATCH)
 483 }
 484
 485 function start_lttng_sessiond()
 486 {
 487         start_lttng_sessiond_opt 1 "$@"
 488 }
 489
 490 function start_lttng_sessiond_notap()
 491 {
 492         start_lttng_sessiond_opt 0 "$@"
 493 }
 494
 495 function stop_lttng_sessiond_opt()
 496 {
 497         local withtap=$1
 498         local signal=$2
 499         local kill_opt=""
 500
 501         if [ -n $TEST_NO_SESSIOND ] && [ "$TEST_NO_SESSIOND" == "1" ]; then
 502                 # Env variable requested no session daemon
 503                 return
 504         fi
 505
 506         local pids="${SESSIOND_PIDS} $(pgrep $RUNAS_MATCH)"
 507
 508         if [ -n "$2" ]; then
 509                 kill_opt="$kill_opt -s $signal"
 510         fi
 511         if [ $withtap -eq "1" ]; then
 512                 diag "Killing $SESSIOND_BIN and lt-$SESSIOND_BIN pids: $(echo $pids | tr '\n' ' ')"
 513         fi
 514         kill $kill_opt $pids 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
 515
 516         if [ $? -eq 1 ]; then
 517                 if [ $withtap -eq "1" ]; then
 518                         fail "Kill sessions daemon"
 519                 fi
 520         else
 521                 out=1
 522                 while [ -n "$out" ]; do
 523                         out=$(pgrep ${SESSIOND_MATCH})
 524                         sleep 0.5
 525                 done
 526                 out=1
 527                 while [ -n "$out" ]; do
 528                         out=$(pgrep $CONSUMERD_MATCH)
 529                         sleep 0.5
 530                 done
 531
 532                 SESSIOND_PIDS=""
 533                 if [ $withtap -eq "1" ]; then
 534                         pass "Kill session daemon"
 535                 fi
 536         fi
 537 }
 538
 539 function stop_lttng_sessiond()
 540 {
 541         stop_lttng_sessiond_opt 1 "$@"
 542 }
 543
 544 function stop_lttng_sessiond_notap()
 545 {
 546         stop_lttng_sessiond_opt 0 "$@"
 547 }
 548
 549 function sigstop_lttng_sessiond_opt()
 550 {
 551         local withtap=$1
 552         local signal=SIGSTOP
 553         local kill_opt=""
 554
 555         if [ -n $TEST_NO_SESSIOND ] && [ "$TEST_NO_SESSIOND" == "1" ]; then
 556                 # Env variable requested no session daemon
 557                 return
 558         fi
 559
 560         PID_SESSIOND="$(pgrep ${SESSIOND_MATCH}) $(pgrep $RUNAS_MATCH)"
 561
 562         kill_opt="$kill_opt -s $signal"
 563
 564         if [ $withtap -eq "1" ]; then
 565                 diag "Sending SIGSTOP to lt-$SESSIOND_BIN and $SESSIOND_BIN pids: $(echo $PID_SESSIOND | tr '\n' ' ')"
 566         fi
 567         kill $kill_opt $PID_SESSIOND 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
 568
 569         if [ $? -eq 1 ]; then
 570                 if [ $withtap -eq "1" ]; then
 571                         fail "Sending SIGSTOP to session daemon"
 572                 fi
 573         else
 574                 out=1
 575                 while [ $out -ne 0 ]; do
 576                         pid=$(pgrep $SESSIOND_MATCH)
 577
 578                         # Wait until state becomes stopped for session
 579                         # daemon(s).
 580                         out=0
 581                         for sessiond_pid in $pid; do
 582                                 state=$(ps -p $sessiond_pid -o state= )
 583                                 if [[ -n "$state" && "$state" != "T" ]]; then
 584                                         out=1
 585                                 fi
 586                         done
 587                         sleep 0.5
 588                 done
 589                 if [ $withtap -eq "1" ]; then
 590                         pass "Sending SIGSTOP to session daemon"
 591                 fi
 592         fi
 593 }
 594
 595 function sigstop_lttng_sessiond()
 596 {
 597         sigstop_lttng_sessiond_opt 1 "$@"
 598 }
 599
 600 function sigstop_lttng_sessiond_notap()
 601 {
 602         sigstop_lttng_sessiond_opt 0 "$@"
 603 }
 604
 605 function stop_lttng_consumerd_opt()
 606 {
 607         local withtap=$1
 608         local signal=$2
 609         local kill_opt=""
 610
 611         PID_CONSUMERD=$(pgrep $CONSUMERD_MATCH)
 612
 613         if [ -n "$2" ]; then
 614                 kill_opt="$kill_opt -s $signal"
 615         fi
 616
 617         if [ $withtap -eq "1" ]; then
 618                 diag "Killing $CONSUMERD_BIN pids: $(echo $PID_CONSUMERD | tr '\n' ' ')"
 619         fi
 620
 621         kill $kill_opt $PID_CONSUMERD 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
 622         retval=$?
 623
 624         if [ $? -eq 1 ]; then
 625                 if [ $withtap -eq "1" ]; then
 626                         fail "Kill consumer daemon"
 627                 fi
 628                 return 1
 629         else
 630                 out=1
 631                 while [ $out -ne 0 ]; do
 632                         pid=$(pgrep $CONSUMERD_MATCH)
 633
 634                         # If consumerds are still present check their status.
 635                         # A zombie status qualifies the consumerd as *killed*
 636                         out=0
 637                         for consumer_pid in $pid; do
 638                                 state=$(ps -p $consumer_pid -o state= )
 639                                 if [[ -n "$state" && "$state" != "Z" ]]; then
 640                                         out=1
 641                                 fi
 642                         done
 643                         sleep 0.5
 644                 done
 645                 if [ $withtap -eq "1" ]; then
 646                         pass "Kill consumer daemon"
 647                 fi
 648         fi
 649         return $retval
 650 }
 651
 652 function stop_lttng_consumerd()
 653 {
 654         stop_lttng_consumerd_opt 1 "$@"
 655 }
 656
 657 function stop_lttng_consumerd_notap()
 658 {
 659         stop_lttng_consumerd_opt 0 "$@"
 660 }
 661
 662 function sigstop_lttng_consumerd_opt()
 663 {
 664         local withtap=$1
 665         local signal=SIGSTOP
 666         local kill_opt=""
 667
 668         PID_CONSUMERD=$(pgrep $CONSUMERD_MATCH)
 669
 670         kill_opt="$kill_opt -s $signal"
 671
 672         if [ $withtap -eq "1" ]; then
 673                 diag "Sending SIGSTOP to $CONSUMERD_BIN pids: $(echo $PID_CONSUMERD | tr '\n' ' ')"
 674         fi
 675         kill $kill_opt $PID_CONSUMERD 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
 676         retval=$?
 677
 678         if [ $? -eq 1 ]; then
 679                 if [ $withtap -eq "1" ]; then
 680                         fail "Sending SIGSTOP to consumer daemon"
 681                 fi
 682                 return 1
 683         else
 684                 out=1
 685                 while [ $out -ne 0 ]; do
 686                         pid=$(pgrep $CONSUMERD_MATCH)
 687
 688                         # Wait until state becomes stopped for all
 689                         # consumers.
 690                         out=0
 691                         for consumer_pid in $pid; do
 692                                 state=$(ps -p $consumer_pid -o state= )
 693                                 if [[ -n "$state" && "$state" != "T" ]]; then
 694                                         out=1
 695                                 fi
 696                         done
 697                         sleep 0.5
 698                 done
 699                 if [ $withtap -eq "1" ]; then
 700                         pass "Sending SIGSTOP to consumer daemon"
 701                 fi
 702         fi
 703         return $retval
 704 }
 705
 706 function sigstop_lttng_consumerd()
 707 {
 708         sigstop_lttng_consumerd_opt 1 "$@"
 709 }
 710
 711 function sigstop_lttng_consumerd_notap()
 712 {
 713         sigstop_lttng_consumerd_opt 0 "$@"
 714 }
 715
 716 function list_lttng_with_opts ()
 717 {
 718         local opts=$1
 719         $TESTDIR/../src/bin/lttng/$LTTNG_BIN list $opts 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
 720         ok $? "Lttng-tool list command with option $opts"
 721 }
 722
 723 function create_lttng_session_no_output ()
 724 {
 725         local sess_name=$1
 726
 727         $TESTDIR/../src/bin/lttng/$LTTNG_BIN create $sess_name --no-output 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
 728         ok $? "Create session $sess_name in no-output mode"
 729 }
 730
 731 function create_lttng_session_uri () {
 732     local sess_name=$1
 733     local uri=$2
 734     local opts="${@:3}"
 735
 736     $TESTDIR/../src/bin/lttng/$LTTNG_BIN create $sess_name -U $uri $opts 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
 737     ok $? "Create session $sess_name with uri:$uri and opts: $opts"
 738 }
 739
 740 function create_lttng_session ()
 741 {
 742         local withtap=$1
 743         local expected_to_fail=$2
 744         local sess_name=$3
 745         local trace_path=$4
 746         local opt=$5
 747
 748         $TESTDIR/../src/bin/lttng/$LTTNG_BIN create $sess_name -o $trace_path $opt > $OUTPUT_DEST
 749         ret=$?
 750         if [ $expected_to_fail -eq "1" ]; then
 751                 test "$ret" -ne "0"
 752                 ret=$?
 753                 if [ $withtap -eq "1" ]; then
 754                         ok $ret "Create session $sess_name in $trace_path failed as expected"
 755                 fi
 756         else
 757                 if [ $withtap -eq "1" ]; then
 758                         ok $ret "Create session $sess_name in $trace_path"
 759                 fi
 760         fi
 761         return $ret
 762 }
 763
 764 function create_lttng_session_ok ()
 765 {
 766         create_lttng_session 1 0 "$@"
 767 }
 768
 769 function create_lttng_session_fail ()
 770 {
 771         create_lttng_session 1 1 "$@"
 772 }
 773
 774 function create_lttng_session_notap ()
 775 {
 776         create_lttng_session 0 0 "$@"
 777 }
 778
 779
 780 function enable_ust_lttng_channel ()
 781 {
 782         local withtap=$1
 783         local expected_to_fail=$2
 784         local sess_name=$3
 785         local channel_name=$4
 786         local opt=$5
 787
 788         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-channel -u $channel_name -s $sess_name $opt 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
 789         ret=$?
 790         if [[ $expected_to_fail -eq "1" ]]; then
 791                 test "$ret" -ne "0"
 792                 ret=$?
 793                 if [ $withtap -eq "1" ]; then
 794                         ok $ret "Enable channel $channel_name for session $sess_name failed as expected"
 795                 fi
 796         else
 797                 if [ $withtap -eq "1" ]; then
 798                         ok $ret "Enable channel $channel_name for session $sess_name"
 799                 fi
 800         fi
 801         return $ret
 802 }
 803
 804 function enable_ust_lttng_channel_ok ()
 805 {
 806         enable_ust_lttng_channel 1 0 "$@"
 807 }
 808
 809 function enable_ust_lttng_channel_fail ()
 810 {
 811         enable_ust_lttng_channel 1 1 "$@"
 812 }
 813
 814 function enable_ust_lttng_channel_notap ()
 815 {
 816         enable_ust_lttng_channel 0 0 "$@"
 817 }
 818
 819 function disable_ust_lttng_channel()
 820 {
 821         local sess_name=$1
 822         local channel_name=$2
 823
 824         $TESTDIR/../src/bin/lttng/$LTTNG_BIN disable-channel -u $channel_name -s $sess_name 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
 825         ok $? "Disable channel $channel_name for session $sess_name"
 826 }
 827
 828 function enable_lttng_mmap_overwrite_kernel_channel()
 829 {
 830         local sess_name=$1
 831         local channel_name=$2
 832
 833         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-channel -s $sess_name $channel_name -k --output mmap --overwrite 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
 834         ok $? "Enable channel $channel_name for session $sess_name"
 835 }
 836
 837 function enable_lttng_mmap_discard_small_kernel_channel()
 838 {
 839         local sess_name=$1
 840         local channel_name=$2
 841
 842         $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
 843         ok $? "Enable small discard channel $channel_name for session $sess_name"
 844 }
 845
 846 function enable_lttng_mmap_overwrite_small_kernel_channel()
 847 {
 848         local sess_name=$1
 849         local channel_name=$2
 850
 851         $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
 852         ok $? "Enable small discard channel $channel_name for session $sess_name"
 853 }
 854
 855 function enable_lttng_mmap_overwrite_ust_channel()
 856 {
 857         local sess_name=$1
 858         local channel_name=$2
 859
 860         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-channel -s $sess_name $channel_name -u --output mmap --overwrite 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
 861         ok $? "Enable channel $channel_name for session $sess_name"
 862 }
 863
 864 function enable_ust_lttng_event ()
 865 {
 866         local withtap=$1
 867         local expected_to_fail=$2
 868         local sess_name=$3
 869         local event_name="$4"
 870         local channel_name=$5
 871
 872         if [ -z $channel_name ]; then
 873                 # default channel if none specified
 874                 chan=""
 875         else
 876                 chan="-c $channel_name"
 877         fi
 878
 879         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event "$event_name" $chan -s $sess_name -u 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
 880         ret=$?
 881         if [[ $expected_to_fail -eq "1" ]]; then
 882                 test $ret -ne "0"
 883                 ret=$?
 884                 if [[ $withtap -eq "1" ]]; then
 885                         ok $ret "Enable ust event $event_name for session $session_name failed as expected"
 886                 fi
 887         else
 888                 if [[ $withtap -eq "1" ]]; then
 889                         ok $ret "Enable ust event $event_name for session $sess_name"
 890                 fi
 891         fi
 892         return $ret
 893 }
 894
 895 function enable_ust_lttng_event_ok ()
 896 {
 897         enable_ust_lttng_event 1 0 "$@"
 898 }
 899
 900 function enable_ust_lttng_event_fail ()
 901 {
 902         enable_ust_lttng_event 1 1 "$@"
 903 }
 904
 905 function enable_ust_lttng_event_notap ()
 906 {
 907         enable_ust_lttng_event 0 0 "$@"
 908 }
 909
 910 function enable_jul_lttng_event()
 911 {
 912         sess_name=$1
 913         event_name="$2"
 914         channel_name=$3
 915
 916         if [ -z $channel_name ]; then
 917                 # default channel if none specified
 918                 chan=""
 919         else
 920                 chan="-c $channel_name"
 921         fi
 922
 923         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event "$event_name" $chan -s $sess_name -j 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
 924         ok $? "Enable JUL event $event_name for session $sess_name"
 925 }
 926
 927 function enable_jul_lttng_event_loglevel()
 928 {
 929         local sess_name=$1
 930         local event_name="$2"
 931         local loglevel=$3
 932         local channel_name=$4
 933
 934         if [ -z $channel_name ]; then
 935                 # default channel if none specified
 936                 chan=""
 937         else
 938                 chan="-c $channel_name"
 939         fi
 940
 941         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event --loglevel $loglevel "$event_name" $chan -s $sess_name -j 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
 942         ok $? "Enable JUL event $event_name for session $sess_name with loglevel $loglevel"
 943 }
 944
 945 function enable_log4j_lttng_event()
 946 {
 947         sess_name=$1
 948         event_name="$2"
 949         channel_name=$3
 950
 951         if [ -z $channel_name ]; then
 952                 # default channel if none specified
 953                 chan=""
 954         else
 955                 chan="-c $channel_name"
 956         fi
 957
 958         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event "$event_name" $chan -s $sess_name -l 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
 959         ok $? "Enable LOG4J event $event_name for session $sess_name"
 960 }
 961
 962 function enable_log4j_lttng_event_loglevel()
 963 {
 964         local sess_name=$1
 965         local event_name="$2"
 966         local loglevel=$3
 967         local channel_name=$4
 968
 969         if [ -z $channel_name ]; then
 970                 # default channel if none specified
 971                 chan=""
 972         else
 973                 chan="-c $channel_name"
 974         fi
 975
 976         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event --loglevel $loglevel "$event_name" $chan -s $sess_name -l 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
 977         ok $? "Enable LOG4J event $event_name for session $sess_name with loglevel $loglevel"
 978 }
 979
 980 function enable_python_lttng_event()
 981 {
 982         sess_name=$1
 983         event_name="$2"
 984         channel_name=$3
 985
 986         if [ -z $channel_name ]; then
 987                 # default channel if none specified
 988                 chan=""
 989         else
 990                 chan="-c $channel_name"
 991         fi
 992
 993         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event "$event_name" $chan -s $sess_name -p 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
 994         ok $? "Enable Python event $event_name for session $sess_name"
 995 }
 996
 997 function enable_python_lttng_event_loglevel()
 998 {
 999         local sess_name=$1
1000         local event_name="$2"
1001         local loglevel=$3
1002         local channel_name=$4
1003
1004         if [ -z $channel_name ]; then
1005                 # default channel if none specified
1006                 chan=""
1007         else
1008                 chan="-c $channel_name"
1009         fi
1010
1011         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event --loglevel $loglevel "$event_name" $chan -s $sess_name -p 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
1012         ok $? "Enable Python event $event_name for session $sess_name with loglevel $loglevel"
1013 }
1014
1015 function enable_ust_lttng_event_filter()
1016 {
1017         local sess_name="$1"
1018         local event_name="$2"
1019         local filter="$3"
1020
1021         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event "$event_name" -s $sess_name -u --filter "$filter" 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
1022         ok $? "Enable event $event_name with filtering for session $sess_name"
1023 }
1024
1025 function enable_ust_lttng_event_loglevel()
1026 {
1027         local sess_name="$1"
1028         local event_name="$2"
1029         local loglevel="$3"
1030
1031         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event "$event_name" -s $sess_name -u --loglevel $loglevel 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
1032         ok $? "Enable event $event_name with loglevel $loglevel"
1033 }
1034
1035 function enable_ust_lttng_event_loglevel_only()
1036 {
1037         local sess_name="$1"
1038         local event_name="$2"
1039         local loglevel="$3"
1040
1041         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event "$event_name" -s $sess_name -u --loglevel-only $loglevel 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
1042         ok $? "Enable event $event_name with loglevel-only $loglevel"
1043 }
1044
1045 function disable_ust_lttng_event ()
1046 {
1047         local sess_name="$1"
1048         local event_name="$2"
1049         local channel_name="$3"
1050
1051         if [ -z $channel_name ]; then
1052                 # default channel if none specified
1053                 chan=""
1054         else
1055                 chan="-c $channel_name"
1056         fi
1057
1058         $TESTDIR/../src/bin/lttng/$LTTNG_BIN disable-event "$event_name" -s $sess_name $chan -u 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
1059         ok $? "Disable event $event_name for session $sess_name"
1060 }
1061
1062 function disable_jul_lttng_event ()
1063 {
1064         local sess_name="$1"
1065         local event_name="$2"
1066
1067         $TESTDIR/../src/bin/lttng/$LTTNG_BIN disable-event "$event_name" -s $sess_name -j >/dev/null 2>&1
1068         ok $? "Disable JUL event $event_name for session $sess_name"
1069 }
1070
1071 function disable_log4j_lttng_event ()
1072 {
1073         local sess_name="$1"
1074         local event_name="$2"
1075
1076         $TESTDIR/../src/bin/lttng/$LTTNG_BIN disable-event "$event_name" -s $sess_name -l >/dev/null 2>&1
1077         ok $? "Disable LOG4J event $event_name for session $sess_name"
1078 }
1079
1080 function disable_python_lttng_event ()
1081 {
1082         local sess_name="$1"
1083         local event_name="$2"
1084
1085         $TESTDIR/../src/bin/lttng/$LTTNG_BIN disable-event "$event_name" -s $sess_name -p 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
1086         ok $? "Disable Python event $event_name for session $sess_name"
1087 }
1088
1089 function start_lttng_tracing ()
1090 {
1091         local withtap=$1
1092         local expected_to_fail=$2
1093         local sess_name=$3
1094
1095         $TESTDIR/../src/bin/lttng/$LTTNG_BIN start $sess_name 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
1096         ret=$?
1097         if [ $withtap -eq "1" ]; then
1098                 if [[ $expected_to_fail -eq "1" ]]; then
1099                         test "$ret" -ne "0"
1100                         ok $? "Start tracing for session $sess_name failed as expected"
1101                 else
1102                         ok $ret "Start tracing for session $sess_name"
1103                 fi
1104         fi
1105 }
1106
1107 function start_lttng_tracing_ok ()
1108 {
1109         start_lttng_tracing 1 0 "$@"
1110 }
1111
1112 function start_lttng_tracing_fail ()
1113 {
1114         start_lttng_tracing 1 1 "$@"
1115 }
1116
1117 function start_lttng_tracing_notap ()
1118 {
1119         start_lttng_tracing 0 0 "$@"
1120 }
1121
1122 function stop_lttng_tracing ()
1123 {
1124         local withtap=$1
1125         local expected_to_fail=$2
1126         local sess_name=$3
1127
1128         $TESTDIR/../src/bin/lttng/$LTTNG_BIN stop $sess_name 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
1129         ret=$?
1130         if [ $withtap -eq "1" ]; then
1131                 if [[ $expected_to_fail -eq "1" ]]; then
1132                         test "$ret" -ne "0"
1133                         ok $? "Stop lttng tracing for session $sess_name failed as expected"
1134                 else
1135                         ok $ret "Stop lttng tracing for session $sess_name"
1136                 fi
1137         fi
1138 }
1139
1140 function stop_lttng_tracing_ok ()
1141 {
1142         stop_lttng_tracing 1 0 "$@"
1143 }
1144
1145 function stop_lttng_tracing_fail ()
1146 {
1147         stop_lttng_tracing 1 1 "$@"
1148 }
1149
1150 function stop_lttng_tracing_notap ()
1151 {
1152         stop_lttng_tracing 0 0 "$@"
1153 }
1154
1155 function destroy_lttng_session ()
1156 {
1157         local withtap=$1
1158         local expected_to_fail=$2
1159         local sess_name=$3
1160
1161         $TESTDIR/../src/bin/lttng/$LTTNG_BIN destroy $sess_name 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
1162         ret=$?
1163         if [[ $expected_to_fail -eq "1" ]]; then
1164                 test "$ret" -ne "0"
1165                 ret=$?
1166                 if [ $withtap -eq "1" ]; then
1167                         ok $ret "Destroy session $sess_name failed as expected"
1168                 fi
1169         else
1170                 if [ $withtap -eq "1" ]; then
1171                         ok $ret "Destroy session $sess_name"
1172                 fi
1173         fi
1174 }
1175
1176 function destroy_lttng_session_ok ()
1177 {
1178         destroy_lttng_session 1 0 "$@"
1179
1180 }
1181
1182 function destroy_lttng_session_fail ()
1183 {
1184         destroy_lttng_session 1 1 "$@"
1185 }
1186
1187 function destroy_lttng_session_notap ()
1188 {
1189         destroy_lttng_session 0 0 "$@"
1190 }
1191
1192 function destroy_lttng_sessions ()
1193 {
1194         $TESTDIR/../src/bin/lttng/$LTTNG_BIN destroy --all 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
1195         ok $? "Destroy all lttng sessions"
1196 }
1197
1198 function lttng_snapshot_add_output ()
1199 {
1200         local expected_to_fail=$1
1201         local sess_name=$2
1202         local trace_path=$3
1203
1204         $TESTDIR/../src/bin/lttng/$LTTNG_BIN snapshot add-output -s $sess_name file://$trace_path 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
1205         ret=$?
1206         if [[ $expected_to_fail -eq 1 ]]; then
1207                 test "$ret" -ne "0"
1208                 ok $? "Added snapshot output file://$trace_path failed as expected"
1209         else
1210                 ok $ret "Added snapshot output file://$trace_path"
1211         fi
1212 }
1213
1214 function lttng_snapshot_add_output_ok ()
1215 {
1216         lttng_snapshot_add_output 0 "$@"
1217 }
1218
1219 function lttng_snapshot_add_output_fail ()
1220 {
1221         lttng_snapshot_add_output 1 "$@"
1222 }
1223
1224 function lttng_snapshot_del_output ()
1225 {
1226         local expected_to_fail=$1
1227         local sess_name=$2
1228         local id=$3
1229
1230         $TESTDIR/../src/bin/lttng/$LTTNG_BIN snapshot del-output -s $sess_name $id 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
1231         ret=$?
1232         if [[ $expected_to_fail -eq "1" ]]; then
1233                 test "$ret" -ne "0"
1234                 ok $? "Deleted snapshot output id $id failed as expected"
1235         else
1236                 ok $ret "Deleted snapshot output id $id"
1237         fi
1238 }
1239
1240 function lttng_snapshot_del_output_ok ()
1241 {
1242         lttng_snapshot_del_output 0 "$@"
1243 }
1244
1245 function lttng_snapshot_del_output_fail ()
1246 {
1247         lttng_snapshot_del_output 1 "$@"
1248 }
1249
1250 function lttng_snapshot_record ()
1251 {
1252         local sess_name=$1
1253
1254         $TESTDIR/../src/bin/lttng/$LTTNG_BIN snapshot record -s $sess_name 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
1255         ok $? "Snapshot recorded"
1256 }
1257
1258 function lttng_snapshot_list ()
1259 {
1260         local sess_name=$1
1261         $TESTDIR/../src/bin/lttng/$LTTNG_BIN snapshot list-output -s $sess_name 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
1262         ok $? "Snapshot list"
1263 }
1264
1265 function lttng_save()
1266 {
1267         local sess_name=$1
1268         local opts=$2
1269
1270         $TESTDIR/../src/bin/lttng/$LTTNG_BIN save $sess_name $opts 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
1271         ok $? "Session saved"
1272 }
1273
1274 function lttng_load()
1275 {
1276         local expected_to_fail=$1
1277         local opts=$2
1278
1279         $TESTDIR/../src/bin/lttng/$LTTNG_BIN load $opts 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
1280         ret=$?
1281         if [[ $expected_to_fail -eq "1" ]]; then
1282                 test $ret -ne "0"
1283                 ok $? "Load command failed as expected with opts: $opts"
1284         else
1285                 ok $ret "Load command with opts: $opts"
1286         fi
1287 }
1288
1289 function lttng_load_ok()
1290 {
1291         lttng_load 0 "$@"
1292 }
1293
1294 function lttng_load_fail()
1295 {
1296         lttng_load 1 "$@"
1297 }
1298
1299 function lttng_track()
1300 {
1301         local expected_to_fail=$1
1302         local opts=$2
1303         $TESTDIR/../src/bin/lttng/$LTTNG_BIN track $opts >$OUTPUT_DEST
1304         ret=$?
1305         if [[ $expected_to_fail -eq "1" ]]; then
1306                 test $ret -ne "0"
1307                 ok $? "Track command failed as expected with opts: $opts"
1308         else
1309                 ok $ret "Track command with opts: $opts"
1310         fi
1311 }
1312
1313 function lttng_track_ok()
1314 {
1315         lttng_track 0 "$@"
1316 }
1317
1318 function lttng_track_fail()
1319 {
1320         lttng_track 1 "$@"
1321 }
1322
1323 function lttng_untrack()
1324 {
1325         local expected_to_fail=$1
1326         local opts=$2
1327         $TESTDIR/../src/bin/lttng/$LTTNG_BIN untrack $opts >$OUTPUT_DEST
1328         ret=$?
1329         if [[ $expected_to_fail -eq "1" ]]; then
1330                 test $ret -ne "0"
1331                 ok $? "Untrack command failed as expected with opts: $opts"
1332         else
1333                 ok $ret "Untrack command with opts: $opts"
1334         fi
1335 }
1336
1337 function lttng_untrack_ok()
1338 {
1339         lttng_untrack 0 "$@"
1340 }
1341
1342 function lttng_untrack_fail()
1343 {
1344         lttng_untrack 1 "$@"
1345 }
1346
1347 function add_context_lttng()
1348 {
1349         local expected_to_fail="$1"
1350         local domain="$2"
1351         local session_name="$3"
1352         local channel_name="$4"
1353         local type="$5"
1354
1355         $TESTDIR/../src/bin/lttng/$LTTNG_BIN add-context -s $session_name -c $channel_name -t $type $domain  1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
1356         ret=$?
1357         if [[ $expected_to_fail -eq "1" ]]; then
1358                 test $ret -ne "0"
1359                 ok $? "Add context command failed as expected for type: $type"
1360         else
1361                 ok $ret "Add context command for type: $type"
1362         fi
1363 }
1364
1365 function add_context_ust_ok()
1366 {
1367         add_context_lttng 0 -u "$@"
1368 }
1369
1370 function add_context_ust_fail()
1371 {
1372         add_context_lttng 1 -u "$@"
1373 }
1374
1375 function add_context_kernel_ok()
1376 {
1377         add_context_lttng 0 -k "$@"
1378 }
1379
1380 function add_context_kernel_fail()
1381 {
1382         add_context_lttng 1 -k "$@"
1383 }
1384
1385 function trace_matches ()
1386 {
1387         local event_name=$1
1388         local nr_iter=$2
1389         local trace_path=$3
1390
1391         which $BABELTRACE_BIN >/dev/null
1392         skip $? -ne 0 "Babeltrace binary not found. Skipping trace matches"
1393
1394         local count=$($BABELTRACE_BIN $trace_path | grep $event_name | wc -l)
1395
1396         if [ "$count" -ne "$nr_iter" ]; then
1397                 fail "Trace match"
1398                 diag "$count matching events found in trace"
1399         else
1400                 pass "Trace match"
1401         fi
1402 }
1403
1404 function trace_match_only()
1405 {
1406         local event_name=$1
1407         local nr_iter=$2
1408         local trace_path=$3
1409
1410         which $BABELTRACE_BIN >/dev/null
1411         skip $? -ne 0 "Babeltrace binary not found. Skipping trace matches"
1412
1413         local count=$($BABELTRACE_BIN $trace_path | grep $event_name | wc -l)
1414         local total=$($BABELTRACE_BIN $trace_path | wc -l)
1415
1416     if [ "$nr_iter" -eq "$count" ] && [ "$total" -eq "$nr_iter" ]; then
1417         pass "Trace match with $total event $event_name"
1418     else
1419         fail "Trace match"
1420         diag "$total event(s) found, expecting $nr_iter of event $event_name and only found $count"
1421     fi
1422 }
1423
1424 function validate_trace
1425 {
1426         local event_name=$1
1427         local trace_path=$2
1428
1429         which $BABELTRACE_BIN >/dev/null
1430         if [ $? -ne 0 ]; then
1431             skip 0 "Babeltrace binary not found. Skipping trace validation"
1432         fi
1433
1434         OLDIFS=$IFS
1435         IFS=","
1436         for i in $event_name; do
1437                 traced=$($BABELTRACE_BIN $trace_path 2>/dev/null | grep $i | wc -l)
1438                 if [ "$traced" -ne 0 ]; then
1439                         pass "Validate trace for event $i, $traced events"
1440                 else
1441                         fail "Validate trace for event $i"
1442                         diag "Found $traced occurences of $i"
1443                 fi
1444         done
1445         ret=$?
1446         IFS=$OLDIFS
1447         return $ret
1448 }
1449
1450 function validate_trace_count
1451 {
1452         local event_name=$1
1453         local trace_path=$2
1454         local expected_count=$3
1455
1456         which $BABELTRACE_BIN >/dev/null
1457         if [ $? -ne 0 ]; then
1458             skip 0 "Babeltrace binary not found. Skipping trace validation"
1459         fi
1460
1461         cnt=0
1462         OLDIFS=$IFS
1463         IFS=","
1464         for i in $event_name; do
1465                 traced=$($BABELTRACE_BIN $trace_path 2>/dev/null | grep $i | wc -l)
1466                 if [ "$traced" -ne 0 ]; then
1467                         pass "Validate trace for event $i, $traced events"
1468                 else
1469                         fail "Validate trace for event $i"
1470                         diag "Found $traced occurences of $i"
1471                 fi
1472                 cnt=$(($cnt + $traced))
1473         done
1474         IFS=$OLDIFS
1475         test $cnt -eq $expected_count
1476         ok $? "Read a total of $cnt events, expected $expected_count"
1477 }
1478
1479 function trace_first_line
1480 {
1481         local trace_path=$1
1482
1483         which $BABELTRACE_BIN >/dev/null
1484         if [ $? -ne 0 ]; then
1485             skip 0 "Babeltrace binary not found. Skipping trace validation"
1486         fi
1487
1488         $BABELTRACE_BIN $trace_path 2>/dev/null | head -n 1
1489 }
1490
1491 function validate_trace_exp()
1492 {
1493         local event_exp=$1
1494         local trace_path=$2
1495
1496         which $BABELTRACE_BIN >/dev/null
1497         skip $? -ne 0 "Babeltrace binary not found. Skipping trace validation"
1498
1499         traced=$($BABELTRACE_BIN $trace_path 2>/dev/null | grep ${event_exp} | wc -l)
1500         if [ "$traced" -ne 0 ]; then
1501                 pass "Validate trace for expression '${event_exp}', $traced events"
1502         else
1503                 fail "Validate trace for expression '${event_exp}'"
1504                 diag "Found $traced occurences of '${event_exp}'"
1505         fi
1506         ret=$?
1507         return $ret
1508 }
1509
1510 function validate_trace_only_exp()
1511 {
1512         local event_exp=$1
1513         local trace_path=$2
1514
1515         which $BABELTRACE_BIN >/dev/null
1516         skip $? -ne 0 "Babeltrace binary not found. Skipping trace matches"
1517
1518         local count=$($BABELTRACE_BIN $trace_path | grep ${event_exp} | wc -l)
1519         local total=$($BABELTRACE_BIN $trace_path | wc -l)
1520
1521         if [ "$count" -ne 0 ] && [ "$total" -eq "$count" ]; then
1522                 pass "Trace match with $total for expression '${event_exp}"
1523         else
1524                 fail "Trace match"
1525                 diag "$total syscall event(s) found, only syscalls matching expression '${event_exp}' ($count occurrences) are expected"
1526         fi
1527         ret=$?
1528         return $ret
1529 }
1530
1531 function validate_trace_empty()
1532 {
1533         local trace_path=$1
1534
1535         which $BABELTRACE_BIN >/dev/null
1536         if [ $? -ne 0 ]; then
1537             skip 0 "Babeltrace binary not found. Skipping trace validation"
1538         fi
1539
1540         events=$($BABELTRACE_BIN $trace_path 2>/dev/null)
1541         ret=$?
1542         if [ $ret -ne 0 ]; then
1543                 fail "Failed to parse trace"
1544                 return $ret
1545         fi
1546
1547         traced=$(echo -n "$events" | wc -l)
1548         if [ "$traced" -eq 0 ]; then
1549                 pass "Validate empty trace"
1550         else
1551                 fail "Validate empty trace"
1552                 diag "Found $traced events in trace"
1553         fi
1554         ret=$?
1555         return $ret
1556 }
1557
1558 function regenerate_metadata ()
1559 {
1560         local expected_to_fail=$1
1561         local sess_name=$2
1562
1563         $TESTDIR/../src/bin/lttng/$LTTNG_BIN regenerate metadata -s $sess_name 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
1564         ret=$?
1565         if [[ $expected_to_fail -eq "1" ]]; then
1566                 test "$ret" -ne "0"
1567                 ok $? "Expected fail on regenerate metadata $sess_name"
1568         else
1569                 ok $ret "Metadata regenerate $sess_name"
1570         fi
1571 }
1572
1573 function regenerate_metadata_ok ()
1574 {
1575         regenerate_metadata 0 "$@"
1576 }
1577
1578 function regenerate_metadata_fail ()
1579 {
1580         regenerate_metadata 1 "$@"
1581 }
1582
1583 function regenerate_statedump ()
1584 {
1585         local expected_to_fail=$1
1586         local sess_name=$2
1587
1588         $TESTDIR/../src/bin/lttng/$LTTNG_BIN regenerate statedump -s $sess_name 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
1589         ret=$?
1590         if [[ $expected_to_fail -eq "1" ]]; then
1591                 test "$ret" -ne "0"
1592                 ok $? "Expected fail on regenerate statedump $sess_name"
1593         else
1594                 ok $ret "Metadata regenerate $sess_name"
1595         fi
1596 }
1597
1598 function regenerate_statedump_ok ()
1599 {
1600         regenerate_statedump 0 "$@"
1601 }
1602
1603 function regenerate_statedump_fail ()
1604 {
1605         regenerate_statedump 1 "$@"
1606 }
1607
1608 function destructive_tests_enabled ()
1609 {
1610         if [ ${LTTNG_ENABLE_DESTRUCTIVE_TESTS} = "will-break-my-system" ]; then
1611                 return 0
1612         else
1613                 return 1
1614         fi
1615 }
1616
1617 function lttng_clear_session ()
1618 {
1619         local expected_to_fail=$1
1620         local sess_name=$2
1621
1622         $TESTDIR/../src/bin/lttng/$LTTNG_BIN clear $sess_name 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
1623         ret=$?
1624         if [[ $expected_to_fail -eq "1" ]]; then
1625                 test "$ret" -ne "0"
1626                 ok $? "Expected fail on clear session $sess_name"
1627         else
1628                 ok $ret "Clear session $sess_name"
1629         fi
1630 }
1631
1632 function lttng_clear_session_ok ()
1633 {
1634         lttng_clear_session 0 $@
1635 }
1636
1637 function lttng_clear_session_fail ()
1638 {
1639         lttng_clear_session 1 $@
1640 }
1641
1642 function lttng_clear_all ()
1643 {
1644         $TESTDIR/../src/bin/lttng/$LTTNG_BIN clear --all 1> $OUTPUT_DEST 2> $ERROR_OUTPUT_DEST
1645         ok $? "Clear all lttng sessions"
1646 }