tests/utils/utils.sh

   1 #!/src/bin/bash
   2 #
   3 # Copyright (C) - 2012 David Goulet <dgoulet@efficios.com>
   4 #
   5 # This library is free software; you can redistribute it and/or modify it under
   6 # the terms of the GNU Lesser General Public License as published by the Free
   7 # Software Foundation; version 2.1 of the License.
   8 #
   9 # This library is distributed in the hope that it will be useful, but WITHOUT
  10 # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  11 # FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more
  12 # details.
  13 #
  14 # You should have received a copy of the GNU Lesser General Public License
  15 # along with this library; if not, write to the Free Software Foundation, Inc.,
  16 # 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301 USA
  17
  18 SESSIOND_BIN="lttng-sessiond"
  19 CONSUMERD_BIN="lttng-consumerd"
  20 RELAYD_BIN="lttng-relayd"
  21 LTTNG_BIN="lttng"
  22 BABELTRACE_BIN="babeltrace"
  23 OUTPUT_DEST=/dev/null 2>&1
  24
  25 # Minimal kernel version supported for session daemon tests
  26 KERNEL_MAJOR_VERSION=2
  27 KERNEL_MINOR_VERSION=6
  28 KERNEL_PATCHLEVEL_VERSION=27
  29
  30 # We set the default UST register timeout to "wait forever", so that
  31 # basic tests don't have to worry about hitting timeouts on busy
  32 # systems. Specialized tests should test those corner-cases.
  33 export LTTNG_UST_REGISTER_TIMEOUT=-1
  34
  35 source $TESTDIR/utils/tap/tap.sh
  36
  37 function print_ok ()
  38 {
  39         # Check if we are a terminal
  40         if [ -t 1 ]; then
  41                 echo -e "\e[1;32mOK\e[0m"
  42         else
  43                 echo -e "OK"
  44         fi
  45 }
  46
  47 function print_fail ()
  48 {
  49         # Check if we are a terminal
  50         if [ -t 1 ]; then
  51                 echo -e "\e[1;31mFAIL\e[0m"
  52         else
  53                 echo -e "FAIL"
  54         fi
  55 }
  56
  57 function print_test_banner ()
  58 {
  59         local desc="$1"
  60         diag "$desc"
  61 }
  62
  63 function validate_kernel_version ()
  64 {
  65         local kern_version=($(uname -r | awk -F. '{ printf("%d.%d.%d\n",$1,$2,$3); }' | tr '.' '\n'))
  66         if [ ${kern_version[0]} -gt $KERNEL_MAJOR_VERSION ]; then
  67                 return 0
  68         fi
  69         if [ ${kern_version[1]} -gt $KERNEL_MINOR_VERSION ]; then
  70                 return 0
  71         fi
  72         if [ ${kern_version[2]} -ge $KERNEL_PATCHLEVEL_VERSION ]; then
  73                 return 0
  74         fi
  75         return 1
  76 }
  77
  78 # Generate a random string
  79 #  $1 = number of characters; defaults to 16
  80 #  $2 = include special characters; 1 = yes, 0 = no; defaults to yes
  81 function randstring()
  82 {
  83         [ "$2" == "0" ] && CHAR="[:alnum:]" || CHAR="[:graph:]"
  84         cat /dev/urandom | tr -cd "$CHAR" | head -c ${1:-16}
  85         echo
  86 }
  87
  88 function lttng_enable_kernel_event
  89 {
  90         local sess_name=$1
  91         local event_name=$2
  92         local channel_name=$3
  93
  94         if [ -z $event_name ]; then
  95                 # Enable all event if no event name specified
  96                 event_name="-a"
  97         fi
  98
  99         if [ -z $channel_name ]; then
 100                 # default channel if none specified
 101                 chan=""
 102         else
 103                 chan="-c $channel_name"
 104         fi
 105
 106         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event "$event_name" $chan -s $sess_name -k >$OUTPUT_DEST
 107         ok $? "Enable kernel event $event_name for session $sess_name"
 108 }
 109
 110 function lttng_enable_kernel_syscall()
 111 {
 112         local expected_to_fail=$1
 113         local sess_name=$2
 114         local syscall_name=$3
 115         local channel_name=$4
 116
 117         if [ -z $syscall_name ]; then
 118                 # Enable all event if no syscall name specified
 119                 syscall_name="-a"
 120         fi
 121
 122         if [ -z $channel_name ]; then
 123                 # default channel if none specified
 124                 chan=""
 125         else
 126                 chan="-c $channel_name"
 127         fi
 128
 129         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event --syscall "$syscall_name" $chan -s $sess_name -k >$OUTPUT_DEST
 130         ret=$?
 131         if [[ $expected_to_fail -eq "1" ]]; then
 132                 test $ret -ne "0"
 133                 ok $? "Enable kernel syscall $syscall_name for session $sess_name on channel $channel_name fail as expected"
 134         else
 135                 ok $ret "Enable kernel syscall $syscall_name for session $sess_name on channel $channel_name"
 136         fi
 137 }
 138
 139 function lttng_enable_kernel_syscall_ok()
 140 {
 141         lttng_enable_kernel_syscall 0 ${*}
 142 }
 143
 144 function lttng_enable_kernel_syscall_fail()
 145 {
 146         lttng_enable_kernel_syscall 1 ${*}
 147 }
 148
 149 function lttng_disable_kernel_syscall()
 150 {
 151         local expected_to_fail=$1
 152         local sess_name=$2
 153         local syscall_name=$3
 154         local channel_name=$4
 155
 156         if [ -z $syscall_name ]; then
 157                 # Enable all event if no syscall name specified
 158                 syscall_name="-a"
 159         fi
 160
 161         if [ -z $channel_name ]; then
 162                 # default channel if none specified
 163                 chan=""
 164         else
 165                 chan="-c $channel_name"
 166         fi
 167
 168         $TESTDIR/../src/bin/lttng/$LTTNG_BIN disable-event --syscall "$syscall_name" $chan -s $sess_name -k >$OUTPUT_DEST
 169
 170         ret=$?
 171         if [[ $expected_to_fail -eq "1" ]]; then
 172                 test $ret -ne "0"
 173                 ok $? "Disable kernel syscall $syscall_name for session $sess_name on channel $channel_name fail as expected"
 174         else
 175                 ok $ret "Disable kernel syscall $syscall_name for session $sess_name on channel $channel_name"
 176         fi
 177 }
 178
 179 function lttng_disable_kernel_syscall_ok()
 180 {
 181         lttng_disable_kernel_syscall 0 ${*}
 182 }
 183
 184 function lttng_disable_kernel_syscall_fail()
 185 {
 186         lttng_disable_kernel_syscall 1 ${*}
 187 }
 188
 189 function lttng_enable_kernel_channel()
 190 {
 191         local expected_to_fail=$1
 192         local sess_name=$2
 193         local channel_name=$3
 194
 195         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-channel -k $channel_name -s $sess_name >$OUTPUT_DEST
 196         ret=$?
 197         if [[ $expected_to_fail -eq "1" ]]; then
 198                 test "$ret" -ne "0"
 199                 ok $? "Expected failure on kernel channel creation $channel_name in $sess_name"
 200         else
 201                 ok $ret "Enable channel $channel_name for session $sess_name"
 202         fi
 203 }
 204
 205 function lttng_enable_kernel_channel_ok()
 206 {
 207         lttng_enable_kernel_channel 0 ${*}
 208 }
 209
 210 function lttng_enable_kernel_channel_fail()
 211 {
 212         lttng_enable_kernel_channel 1 ${*}
 213 }
 214
 215 function lttng_disable_kernel_channel()
 216 {
 217         local expected_to_fail=$1
 218         local sess_name=$2
 219         local channel_name=$3
 220
 221         $TESTDIR/../src/bin/lttng/$LTTNG_BIN disable-channel -k $channel_name -s $sess_name >$OUTPUT_DEST
 222         ret=$?
 223         if [[ $expected_to_fail -eq "1" ]]; then
 224                 test "$ret" -ne "0"
 225                 ok $? "Expected failure on kernel channel creation $channel_name in $sess_name"
 226         else
 227                 ok $ret "disable channel $channel_name for session $sess_name"
 228         fi
 229 }
 230
 231 function lttng_disable_kernel_channel_ok()
 232 {
 233         lttng_disable_kernel_channel 0 ${*}
 234 }
 235
 236 function lttng_disable_kernel_channel_fail()
 237 {
 238         lttng_disable_kernel_channel 1 ${*}
 239 }
 240
 241 function start_lttng_relayd
 242 {
 243         local opt=$1
 244
 245         DIR=$(readlink -f $TESTDIR)
 246
 247         if [ -z $(pidof lt-$RELAYD_BIN) ]; then
 248                 $DIR/../src/bin/lttng-relayd/$RELAYD_BIN -b $opt >$OUTPUT_DEST
 249                 #$DIR/../src/bin/lttng-relayd/$RELAYD_BIN $opt -vvv >>/tmp/relayd.log 2>&1 &
 250                 if [ $? -eq 1 ]; then
 251                         fail "Start lttng-relayd (opt: $opt)"
 252                         return 1
 253                 else
 254                         pass "Start lttng-relayd (opt: $opt)"
 255                 fi
 256         else
 257                 pass "Start lttng-relayd (opt: $opt)"
 258         fi
 259 }
 260
 261 function stop_lttng_relayd_nocheck
 262 {
 263         PID_RELAYD=`pidof lt-$RELAYD_BIN`
 264
 265         diag "Killing lttng-relayd (pid: $PID_RELAYD)"
 266         kill $PID_RELAYD >$OUTPUT_DEST
 267         retval=$?
 268
 269         if [ $retval -eq 1 ]; then
 270                 out=1
 271                 while [ -n "$out" ]; do
 272                         out=$(pidof lt-$RELAYD_BIN)
 273                         sleep 0.5
 274                 done
 275         fi
 276         return $retval
 277 }
 278
 279 function stop_lttng_relayd
 280 {
 281         stop_lttng_relayd_nocheck
 282
 283         if [ $? -eq 1 ]; then
 284                 fail "Killed lttng-relayd (pid: $PID_RELAYD)"
 285                 return 1
 286         else
 287                 pass "Killed lttng-relayd (pid: $PID_RELAYD)"
 288                 return 0
 289         fi
 290 }
 291
 292 #First argument: load path for automatic loading
 293 function start_lttng_sessiond()
 294 {
 295
 296         local load_path="$1"
 297         if [ -n $TEST_NO_SESSIOND ] && [ "$TEST_NO_SESSIOND" == "1" ]; then
 298                 # Env variable requested no session daemon
 299                 return
 300         fi
 301
 302         validate_kernel_version
 303         if [ $? -ne 0 ]; then
 304             fail "Start session daemon"
 305             BAIL_OUT "*** Kernel too old for session daemon tests ***"
 306         fi
 307
 308         DIR=$(readlink -f $TESTDIR)
 309         : ${LTTNG_SESSION_CONFIG_XSD_PATH=${DIR}/../src/common/config/}
 310         export LTTNG_SESSION_CONFIG_XSD_PATH
 311
 312         if [ -z $(pidof lt-$SESSIOND_BIN) ]; then
 313                 # Have a load path ?
 314                 if [ -n "$1" ]; then
 315                         $DIR/../src/bin/lttng-sessiond/$SESSIOND_BIN --load "$1" --background --consumerd32-path="$DIR/../src/bin/lttng-consumerd/lttng-consumerd" --consumerd64-path="$DIR/../src/bin/lttng-consumerd/lttng-consumerd"
 316                 else
 317                         $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"
 318                 fi
 319                 #$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
 320                 status=$?
 321                 ok $status "Start session daemon"
 322         fi
 323 }
 324
 325 function stop_lttng_sessiond ()
 326 {
 327         if [ -n $TEST_NO_SESSIOND ] && [ "$TEST_NO_SESSIOND" == "1" ]; then
 328                 # Env variable requested no session daemon
 329                 return
 330         fi
 331
 332         PID_SESSIOND=`pidof lt-$SESSIOND_BIN`
 333
 334         kill $PID_SESSIOND >$OUTPUT_DEST
 335
 336         if [ $? -eq 1 ]; then
 337                 fail "Kill sessions daemon"
 338                 return 1
 339         else
 340                 out=1
 341                 while [ -n "$out" ]; do
 342                         out=$(pidof lt-$SESSIOND_BIN)
 343                         sleep 0.5
 344                 done
 345                 out=1
 346                 while [ -n "$out" ]; do
 347                         out=$(pidof $CONSUMERD_BIN)
 348                         sleep 0.5
 349                 done
 350                 pass "Kill session daemon"
 351         fi
 352 }
 353
 354 function list_lttng_with_opts ()
 355 {
 356         local opts=$1
 357         $TESTDIR/../src/bin/lttng/$LTTNG_BIN list $opts >$OUTPUT_DEST
 358         ok $? "Lttng-tool list command with option $opts"
 359 }
 360
 361 function create_lttng_session_no_output ()
 362 {
 363         local sess_name=$1
 364
 365         $TESTDIR/../src/bin/lttng/$LTTNG_BIN create $sess_name --no-output >$OUTPUT_DEST
 366         ok $? "Create session $sess_name in no-output mode"
 367 }
 368
 369 function create_lttng_session ()
 370 {
 371         local sess_name=$1
 372         local trace_path=$2
 373         local expected_to_fail=$3
 374
 375         $TESTDIR/../src/bin/lttng/$LTTNG_BIN create $sess_name -o $trace_path > $OUTPUT_DEST
 376         ret=$?
 377         if [[ $expected_to_fail ]]; then
 378                 test "$ret" -ne "0"
 379                 ok $? "Expected fail on session creation $sess_name in $trace_path"
 380         else
 381                 ok $ret "Create session $sess_name in $trace_path"
 382         fi
 383 }
 384
 385 function enable_ust_lttng_channel()
 386 {
 387         local sess_name=$1
 388         local channel_name=$2
 389         local expect_fail=$3
 390
 391         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-channel -u $channel_name -s $sess_name >$OUTPUT_DEST
 392         ret=$?
 393         if [[ $expect_fail ]]; then
 394                 test "$ret" -ne "0"
 395                 ok $? "Expected fail on ust channel creation $channel_name in $sess_name"
 396         else
 397                 ok $ret "Enable channel $channel_name for session $sess_name"
 398         fi
 399 }
 400
 401 function disable_ust_lttng_channel()
 402 {
 403         local sess_name=$1
 404         local channel_name=$2
 405
 406         $TESTDIR/../src/bin/lttng/$LTTNG_BIN disable-channel -u $channel_name -s $sess_name >$OUTPUT_DEST
 407         ok $? "Disable channel $channel_name for session $sess_name"
 408 }
 409
 410 function enable_lttng_mmap_overwrite_kernel_channel()
 411 {
 412         local sess_name=$1
 413         local channel_name=$2
 414
 415         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-channel -s $sess_name $channel_name -k --output mmap --overwrite >$OUTPUT_DEST
 416         ok $? "Enable channel $channel_name for session $sess_name"
 417 }
 418
 419 function enable_lttng_mmap_overwrite_ust_channel()
 420 {
 421         local sess_name=$1
 422         local channel_name=$2
 423
 424         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-channel -s $sess_name $channel_name -u --output mmap --overwrite >$OUTPUT_DEST
 425         ok $? "Enable channel $channel_name for session $sess_name"
 426 }
 427
 428 function enable_ust_lttng_event ()
 429 {
 430         local sess_name=$1
 431         local event_name="$2"
 432         local channel_name=$3
 433         local expected_to_fail=$4
 434
 435         if [ -z $channel_name ]; then
 436                 # default channel if none specified
 437                 chan=""
 438         else
 439                 chan="-c $channel_name"
 440         fi
 441
 442         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event "$event_name" $chan -s $sess_name -u >$OUTPUT_DEST
 443         ret=$?
 444         if [[ $expected_to_fail ]]; then
 445                 test $ret -ne "0"
 446                 ok $? "Enable ust event $event_name for session $session_name on channel $channel_name failed as expected"
 447         else
 448                 ok $ret "Enable event $event_name for session $sess_name"
 449         fi
 450 }
 451
 452 function enable_jul_lttng_event()
 453 {
 454         sess_name=$1
 455         event_name="$2"
 456         channel_name=$3
 457
 458         if [ -z $channel_name ]; then
 459                 # default channel if none specified
 460                 chan=""
 461         else
 462                 chan="-c $channel_name"
 463         fi
 464
 465         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event "$event_name" $chan -s $sess_name -j >$OUTPUT_DEST
 466         ok $? "Enable JUL event $event_name for session $sess_name"
 467 }
 468
 469 function enable_jul_lttng_event_loglevel()
 470 {
 471         local sess_name=$1
 472         local event_name="$2"
 473         local loglevel=$3
 474         local channel_name=$4
 475
 476         if [ -z $channel_name ]; then
 477                 # default channel if none specified
 478                 chan=""
 479         else
 480                 chan="-c $channel_name"
 481         fi
 482
 483         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event --loglevel $loglevel "$event_name" $chan -s $sess_name -j >$OUTPUT_DEST
 484         ok $? "Enable JUL event $event_name for session $sess_name with loglevel $loglevel"
 485 }
 486
 487 function enable_log4j_lttng_event()
 488 {
 489         sess_name=$1
 490         event_name="$2"
 491         channel_name=$3
 492
 493         if [ -z $channel_name ]; then
 494                 # default channel if none specified
 495                 chan=""
 496         else
 497                 chan="-c $channel_name"
 498         fi
 499
 500         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event "$event_name" $chan -s $sess_name -l >$OUTPUT_DEST
 501         ok $? "Enable LOG4J event $event_name for session $sess_name"
 502 }
 503
 504 function enable_log4j_lttng_event_loglevel()
 505 {
 506         local sess_name=$1
 507         local event_name="$2"
 508         local loglevel=$3
 509         local channel_name=$4
 510
 511         if [ -z $channel_name ]; then
 512                 # default channel if none specified
 513                 chan=""
 514         else
 515                 chan="-c $channel_name"
 516         fi
 517
 518         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event --loglevel $loglevel "$event_name" $chan -s $sess_name -l >$OUTPUT_DEST
 519         ok $? "Enable LOG4J event $event_name for session $sess_name with loglevel $loglevel"
 520 }
 521
 522 function enable_python_lttng_event()
 523 {
 524         sess_name=$1
 525         event_name="$2"
 526         channel_name=$3
 527
 528         if [ -z $channel_name ]; then
 529                 # default channel if none specified
 530                 chan=""
 531         else
 532                 chan="-c $channel_name"
 533         fi
 534
 535         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event "$event_name" $chan -s $sess_name -p >$OUTPUT_DEST
 536         ok $? "Enable Python event $event_name for session $sess_name"
 537 }
 538
 539 function enable_python_lttng_event_loglevel()
 540 {
 541         local sess_name=$1
 542         local event_name="$2"
 543         local loglevel=$3
 544         local channel_name=$4
 545
 546         if [ -z $channel_name ]; then
 547                 # default channel if none specified
 548                 chan=""
 549         else
 550                 chan="-c $channel_name"
 551         fi
 552
 553         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event --loglevel $loglevel "$event_name" $chan -s $sess_name -p >$OUTPUT_DEST
 554         ok $? "Enable Python event $event_name for session $sess_name with loglevel $loglevel"
 555 }
 556
 557 function enable_ust_lttng_event_filter()
 558 {
 559         local sess_name="$1"
 560         local event_name="$2"
 561         local filter="$3"
 562
 563         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event "$event_name" -s $sess_name -u --filter "$filter" >$OUTPUT_DEST
 564         ok $? "Enable event $event_name with filtering for session $sess_name"
 565 }
 566
 567 function enable_ust_lttng_event_loglevel()
 568 {
 569         local sess_name="$1"
 570         local event_name="$2"
 571         local loglevel="$3"
 572
 573         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event "$event_name" -s $sess_name -u --loglevel $loglevel >$OUTPUT_DEST
 574         ok $? "Enable event $event_name with loglevel $loglevel"
 575 }
 576
 577 function enable_ust_lttng_event_loglevel_only()
 578 {
 579         local sess_name="$1"
 580         local event_name="$2"
 581         local loglevel="$3"
 582
 583         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event "$event_name" -s $sess_name -u --loglevel-only $loglevel >$OUTPUT_DEST
 584         ok $? "Enable event $event_name with loglevel-only $loglevel"
 585 }
 586
 587 function disable_ust_lttng_event ()
 588 {
 589         local sess_name="$1"
 590         local event_name="$2"
 591         local channel_name="$3"
 592
 593         if [ -z $channel_name ]; then
 594                 # default channel if none specified
 595                 chan=""
 596         else
 597                 chan="-c $channel_name"
 598         fi
 599
 600         $TESTDIR/../src/bin/lttng/$LTTNG_BIN disable-event "$event_name" -s $sess_name $chan -u >$OUTPUT_DEST
 601         ok $? "Disable event $event_name for session $sess_name"
 602 }
 603
 604 function disable_jul_lttng_event ()
 605 {
 606         local sess_name="$1"
 607         local event_name="$2"
 608
 609         $TESTDIR/../src/bin/lttng/$LTTNG_BIN disable-event "$event_name" -s $sess_name -j >/dev/null 2>&1
 610         ok $? "Disable JUL event $event_name for session $sess_name"
 611 }
 612
 613 function disable_log4j_lttng_event ()
 614 {
 615         local sess_name="$1"
 616         local event_name="$2"
 617
 618         $TESTDIR/../src/bin/lttng/$LTTNG_BIN disable-event "$event_name" -s $sess_name -l >/dev/null 2>&1
 619         ok $? "Disable LOG4J event $event_name for session $sess_name"
 620 }
 621
 622 function disable_python_lttng_event ()
 623 {
 624         local sess_name="$1"
 625         local event_name="$2"
 626
 627         $TESTDIR/../src/bin/lttng/$LTTNG_BIN disable-event "$event_name" -s $sess_name -p >$OUTPUT_DEST
 628         ok $? "Disable Python event $event_name for session $sess_name"
 629 }
 630
 631 function start_lttng_tracing ()
 632 {
 633         local sess_name=$1
 634         local expected_to_fail=$2
 635
 636         $TESTDIR/../src/bin/lttng/$LTTNG_BIN start $sess_name >$OUTPUT_DEST
 637         ret=$?
 638         if [[ $expected_to_fail ]]; then
 639                 test "$ret" -ne "0"
 640                 ok $? "Expected fail on start tracing for session: $sess_name"
 641         else
 642                 ok $ret "Start tracing for session $sess_name"
 643         fi
 644 }
 645
 646 function stop_lttng_tracing ()
 647 {
 648         local sess_name=$1
 649         local expected_to_fail=$2
 650
 651         $TESTDIR/../src/bin/lttng/$LTTNG_BIN stop $sess_name >$OUTPUT_DEST
 652         ret=$?
 653         if [[ $expected_to_fail ]]; then
 654                 test "$ret" -ne "0"
 655                 ok $? "Expected fail on stop tracing for session: $sess_name"
 656         else
 657                 ok $ret "Stop lttng tracing for session $sess_name"
 658         fi
 659 }
 660
 661 function destroy_lttng_session ()
 662 {
 663         local sess_name=$1
 664         local expected_to_fail=$2
 665
 666         $TESTDIR/../src/bin/lttng/$LTTNG_BIN destroy $sess_name >$OUTPUT_DEST
 667         ret=$?
 668         if [[ $expected_to_fail ]]; then
 669                 test "$ret" -ne "0"
 670                 ok $? "Expected fail on session deletion $sess_name"
 671         else
 672                 ok $ret "Destroy session $sess_name"
 673         fi
 674 }
 675
 676 function destroy_lttng_sessions ()
 677 {
 678         $TESTDIR/../src/bin/lttng/$LTTNG_BIN destroy --all >$OUTPUT_DEST
 679         ok $? "Destroy all lttng sessions"
 680 }
 681
 682 function lttng_snapshot_add_output ()
 683 {
 684         local sess_name=$1
 685         local trace_path=$2
 686         local expected_to_fail=$3
 687
 688         $TESTDIR/../src/bin/lttng/$LTTNG_BIN snapshot add-output -s $sess_name file://$trace_path >$OUTPUT_DEST
 689         ret=$?
 690         if [[ $expected_to_fail ]]; then
 691                 test "$ret" -ne "0"
 692                 ok $? "Failed to add a  snapshot output file://$trace_path as expected"
 693         else
 694                 ok $ret "Added snapshot output file://$trace_path"
 695         fi
 696 }
 697
 698 function lttng_snapshot_del_output ()
 699 {
 700         local sess_name=$1
 701         local id=$2
 702         local expected_to_fail=$3
 703
 704         $TESTDIR/../src/bin/lttng/$LTTNG_BIN snapshot del-output -s $sess_name $id >$OUTPUT_DEST
 705         ret=$?
 706         if [[ $expected_to_fail ]]; then
 707                 test "$ret" -ne "0"
 708                 ok $? "Expect fail on deletion of snapshot output id $id"
 709         else
 710                 ok $ret "Deleted snapshot output id $id"
 711         fi
 712 }
 713
 714 function lttng_snapshot_record ()
 715 {
 716         local sess_name=$1
 717         local trace_path=$2
 718
 719         $TESTDIR/../src/bin/lttng/$LTTNG_BIN snapshot record -s $sess_name >$OUTPUT_DEST
 720         ok $? "Snapshot recorded"
 721 }
 722
 723 function lttng_snapshot_list ()
 724 {
 725         local sess_name=$1
 726         $TESTDIR/../src/bin/lttng/$LTTNG_BIN snapshot list-output -s $sess_name >$OUTPUT_DEST
 727         ok $? "Snapshot list"
 728 }
 729
 730 function lttng_save()
 731 {
 732         local sess_name=$1
 733         local opts=$2
 734
 735         $TESTDIR/../src/bin/lttng/$LTTNG_BIN save $sess_name $opts >$OUTPUT_DEST
 736         ok $? "Session successfully saved"
 737 }
 738
 739 function lttng_load()
 740 {
 741         local opts=$1
 742
 743         $TESTDIR/../src/bin/lttng/$LTTNG_BIN load $opts >$OUTPUT_DEST
 744         ok $? "Load command successful"
 745 }
 746
 747 function trace_matches ()
 748 {
 749         local event_name=$1
 750         local nr_iter=$2
 751         local trace_path=$3
 752
 753         which $BABELTRACE_BIN >/dev/null
 754         skip $? -ne 0 "Babeltrace binary not found. Skipping trace matches"
 755
 756         local count=$($BABELTRACE_BIN $trace_path | grep $event_name | wc -l)
 757
 758         if [ "$count" -ne "$nr_iter" ]; then
 759                 fail "Trace match"
 760                 diag "$count events found in trace"
 761         else
 762                 pass "Trace match"
 763         fi
 764 }
 765
 766 function trace_match_only()
 767 {
 768         local event_name=$1
 769         local nr_iter=$2
 770         local trace_path=$3
 771
 772         which $BABELTRACE_BIN >/dev/null
 773         skip $? -ne 0 "Babeltrace binary not found. Skipping trace matches"
 774
 775         local count=$($BABELTRACE_BIN $trace_path | grep $event_name | wc -l)
 776         local total=$($BABELTRACE_BIN $trace_path | wc -l)
 777
 778     if [ "$nr_iter" -eq "$count" ] && [ "$total" -eq "$nr_iter" ]; then
 779         pass "Trace match with $total event $event_name"
 780     else
 781         fail "Trace match"
 782         diag "$total event(s) found, expecting $nr_iter of event $event_name and only found $count"
 783     fi
 784 }
 785
 786 function validate_trace
 787 {
 788         local event_name=$1
 789         local trace_path=$2
 790
 791         which $BABELTRACE_BIN >/dev/null
 792         if [ $? -ne 0 ]; then
 793             skip 0 "Babeltrace binary not found. Skipping trace validation"
 794         fi
 795
 796         OLDIFS=$IFS
 797         IFS=","
 798         for i in $event_name; do
 799                 traced=$($BABELTRACE_BIN $trace_path 2>/dev/null | grep $i | wc -l)
 800                 if [ "$traced" -ne 0 ]; then
 801                         pass "Validate trace for event $i, $traced events"
 802                 else
 803                         fail "Validate trace for event $i"
 804                         diag "Found $traced occurences of $i"
 805                 fi
 806         done
 807         ret=$?
 808         IFS=$OLDIFS
 809         return $ret
 810 }
 811
 812 function validate_trace_exp()
 813 {
 814         local event_exp=$1
 815         local trace_path=$2
 816
 817         which $BABELTRACE_BIN >/dev/null
 818         skip $? -ne 0 "Babeltrace binary not found. Skipping trace validation"
 819
 820         traced=$($BABELTRACE_BIN $trace_path 2>/dev/null | grep ${event_exp} | wc -l)
 821         if [ "$traced" -ne 0 ]; then
 822                 pass "Validate trace for expression '${event_exp}', $traced events"
 823         else
 824                 fail "Validate trace for expression '${event_exp}'"
 825                 diag "Found $traced occurences of '${event_exp}'"
 826         fi
 827         ret=$?
 828         return $ret
 829 }
 830
 831 function validate_trace_only_exp()
 832 {
 833         local event_exp=$1
 834         local trace_path=$2
 835
 836         which $BABELTRACE_BIN >/dev/null
 837         skip $? -ne 0 "Babeltrace binary not found. Skipping trace matches"
 838
 839         local count=$($BABELTRACE_BIN $trace_path | grep ${event_exp} | wc -l)
 840         local total=$($BABELTRACE_BIN $trace_path | wc -l)
 841
 842         if [ "$count" -ne 0 ] && [ "$total" -eq "$count" ]; then
 843                 pass "Trace match with $total for expression '${event_exp}"
 844         else
 845                 fail "Trace match"
 846                 diag "$total syscall event(s) found, only syscalls matching expression '${event_exp}' ($count occurrences) are expected"
 847         fi
 848         ret=$?
 849         return $ret
 850 }
 851
 852 function validate_trace_empty()
 853 {
 854         local trace_path=$1
 855
 856         which $BABELTRACE_BIN >/dev/null
 857         if [ $? -ne 0 ]; then
 858             skip 0 "Babeltrace binary not found. Skipping trace validation"
 859         fi
 860
 861         traced=$($BABELTRACE_BIN $trace_path 2>/dev/null | wc -l)
 862         if [ "$traced" -eq 0 ]; then
 863                 pass "Validate empty trace"
 864         else
 865                 fail "Validate empty trace"
 866                 diag "Found $traced events in trace"
 867         fi
 868         ret=$?
 869         return $ret
 870 }