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
  24 # Minimal kernel version supported for session daemon tests
  25 KERNEL_MAJOR_VERSION=2
  26 KERNEL_MINOR_VERSION=6
  27 KERNEL_PATCHLEVEL_VERSION=27
  28
  29 # We set the default UST register timeout to "wait forever", so that
  30 # basic tests don't have to worry about hitting timeouts on busy
  31 # systems. Specialized tests should test those corner-cases.
  32 export LTTNG_UST_REGISTER_TIMEOUT=-1
  33
  34 source $TESTDIR/utils/tap/tap.sh
  35
  36 function print_ok ()
  37 {
  38         # Check if we are a terminal
  39         if [ -t 1 ]; then
  40                 echo -e "\e[1;32mOK\e[0m"
  41         else
  42                 echo -e "OK"
  43         fi
  44 }
  45
  46 function print_fail ()
  47 {
  48         # Check if we are a terminal
  49         if [ -t 1 ]; then
  50                 echo -e "\e[1;31mFAIL\e[0m"
  51         else
  52                 echo -e "FAIL"
  53         fi
  54 }
  55
  56 function print_test_banner ()
  57 {
  58         desc="$1"
  59         diag "$desc"
  60 }
  61
  62 function validate_kernel_version ()
  63 {
  64         kern_version=($(uname -r | awk -F. '{ printf("%d.%d.%d\n",$1,$2,$3); }' | tr '.' '\n'))
  65         if [ ${kern_version[0]} -gt $KERNEL_MAJOR_VERSION ]; then
  66                 return 0
  67         fi
  68         if [ ${kern_version[1]} -gt $KERNEL_MINOR_VERSION ]; then
  69                 return 0
  70         fi
  71         if [ ${kern_version[2]} -ge $KERNEL_PATCHLEVEL_VERSION ]; then
  72                 return 0
  73         fi
  74         return 1
  75 }
  76
  77 # Generate a random string
  78 #  $1 = number of characters; defaults to 16
  79 #  $2 = include special characters; 1 = yes, 0 = no; defaults to yes
  80 function randstring()
  81 {
  82         [ "$2" == "0" ] && CHAR="[:alnum:]" || CHAR="[:graph:]"
  83         cat /dev/urandom | tr -cd "$CHAR" | head -c ${1:-16}
  84         echo
  85 }
  86
  87 function lttng_enable_kernel_event
  88 {
  89         sess_name=$1
  90         event_name=$2
  91         channel_name=$3
  92
  93         if [ -z $event_name ]; then
  94                 # Enable all event if no event name specified
  95                 event_name="-a"
  96         fi
  97
  98         if [ -z $channel_name ]; then
  99                 # default channel if none specified
 100                 chan=""
 101         else
 102                 chan="-c $channel_name"
 103         fi
 104
 105         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event "$event_name" $chan -s $sess_name -k >/dev/null 2>&1
 106         ok $? "Enable kernel event $event_name for session $sess_name"
 107 }
 108
 109 function start_lttng_relayd
 110 {
 111         local opt=$1
 112
 113         DIR=$(readlink -f $TESTDIR)
 114
 115         if [ -z $(pidof lt-$RELAYD_BIN) ]; then
 116                 $DIR/../src/bin/lttng-relayd/$RELAYD_BIN -b $opt >/dev/null 2>&1
 117                 #$DIR/../src/bin/lttng-relayd/$RELAYD_BIN $opt -vvv >>/tmp/relayd.log 2>&1 &
 118                 if [ $? -eq 1 ]; then
 119                         fail "Start lttng-relayd (opt: $opt)"
 120                         return 1
 121                 else
 122                         pass "Start lttng-relayd (opt: $opt)"
 123                 fi
 124         else
 125                 pass "Start lttng-relayd (opt: $opt)"
 126         fi
 127 }
 128
 129 function stop_lttng_relayd_nocheck
 130 {
 131         PID_RELAYD=`pidof lt-$RELAYD_BIN`
 132
 133         diag "Killing lttng-relayd (pid: $PID_RELAYD)"
 134         kill $PID_RELAYD >/dev/null 2>&1
 135         retval=$?
 136
 137         if [ $retval -eq 1 ]; then
 138                 out=1
 139                 while [ -n "$out" ]; do
 140                         out=$(pidof lt-$RELAYD_BIN)
 141                         sleep 0.5
 142                 done
 143         fi
 144         return $retval
 145 }
 146
 147 function stop_lttng_relayd
 148 {
 149         stop_lttng_relayd_nocheck
 150
 151         if [ $? -eq 1 ]; then
 152                 fail "Killed lttng-relayd (pid: $PID_RELAYD)"
 153                 return 1
 154         else
 155                 pass "Killed lttng-relayd (pid: $PID_RELAYD)"
 156                 return 0
 157         fi
 158 }
 159
 160 function start_lttng_sessiond()
 161 {
 162         if [ -n $TEST_NO_SESSIOND ] && [ "$TEST_NO_SESSIOND" == "1" ]; then
 163                 # Env variable requested no session daemon
 164                 return
 165         fi
 166
 167         validate_kernel_version
 168         if [ $? -ne 0 ]; then
 169             fail "Start session daemon"
 170             BAIL_OUT "*** Kernel too old for session daemon tests ***"
 171         fi
 172
 173         DIR=$(readlink -f $TESTDIR)
 174         : ${LTTNG_SESSION_CONFIG_XSD_PATH=${DIR}/../src/common/config/}
 175         export LTTNG_SESSION_CONFIG_XSD_PATH
 176
 177         if [ -z $(pidof lt-$SESSIOND_BIN) ]; then
 178                 $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"
 179                 #$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
 180                 status=$?
 181                 ok $status "Start session daemon"
 182         fi
 183 }
 184
 185 function stop_lttng_sessiond ()
 186 {
 187         if [ -n $TEST_NO_SESSIOND ] && [ "$TEST_NO_SESSIOND" == "1" ]; then
 188                 # Env variable requested no session daemon
 189                 return
 190         fi
 191
 192         PID_SESSIOND=`pidof lt-$SESSIOND_BIN`
 193
 194         kill $PID_SESSIOND >/dev/null 2>&1
 195
 196         if [ $? -eq 1 ]; then
 197                 fail "Kill sessions daemon"
 198                 return 1
 199         else
 200                 out=1
 201                 while [ -n "$out" ]; do
 202                         out=$(pidof lt-$SESSIOND_BIN)
 203                         sleep 0.5
 204                 done
 205                 out=1
 206                 while [ -n "$out" ]; do
 207                         out=$(pidof $CONSUMERD_BIN)
 208                         sleep 0.5
 209                 done
 210                 pass "Kill session daemon"
 211         fi
 212 }
 213
 214 function create_lttng_session_no_output ()
 215 {
 216         sess_name=$1
 217
 218         $TESTDIR/../src/bin/lttng/$LTTNG_BIN create $sess_name --no-output >/dev/null 2>&1
 219         ok $? "Create session $sess_name in no-output mode"
 220 }
 221
 222 function create_lttng_session ()
 223 {
 224         sess_name=$1
 225         trace_path=$2
 226
 227         $TESTDIR/../src/bin/lttng/$LTTNG_BIN create $sess_name -o $trace_path >/dev/null 2>&1
 228         ok $? "Create session $sess_name in $trace_path"
 229 }
 230
 231 function enable_ust_lttng_channel()
 232 {
 233         sess_name=$1
 234         channel_name=$2
 235
 236         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-channel -u $channel_name -s $sess_name >/dev/null 2>&1
 237         ok $? "Enable channel $channel_name for session $sess_name"
 238 }
 239
 240 function disable_ust_lttng_channel()
 241 {
 242         sess_name=$1
 243         channel_name=$2
 244
 245         $TESTDIR/../src/bin/lttng/$LTTNG_BIN disable-channel -u $channel_name -s $sess_name >/dev/null 2>&1
 246         ok $? "Disable channel $channel_name for session $sess_name"
 247 }
 248
 249 function enable_lttng_mmap_overwrite_kernel_channel()
 250 {
 251         sess_name=$1
 252         channel_name=$2
 253
 254         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-channel -s $sess_name $channel_name -k --output mmap --overwrite >/dev/null 2>&1
 255         ok $? "Enable channel $channel_name for session $sess_name"
 256 }
 257
 258 function enable_lttng_mmap_overwrite_ust_channel()
 259 {
 260         sess_name=$1
 261         channel_name=$2
 262
 263         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-channel -s $sess_name $channel_name -u --output mmap --overwrite >/dev/null 2>&1
 264         ok $? "Enable channel $channel_name for session $sess_name"
 265 }
 266
 267 function enable_ust_lttng_event ()
 268 {
 269         sess_name=$1
 270         event_name="$2"
 271         channel_name=$3
 272
 273         if [ -z $channel_name ]; then
 274                 # default channel if none specified
 275                 chan=""
 276         else
 277                 chan="-c $channel_name"
 278         fi
 279
 280         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event "$event_name" $chan -s $sess_name -u >/dev/null 2>&1
 281         ok $? "Enable event $event_name for session $sess_name"
 282 }
 283
 284 function enable_jul_lttng_event()
 285 {
 286         sess_name=$1
 287         event_name="$2"
 288         channel_name=$3
 289
 290         if [ -z $channel_name ]; then
 291                 # default channel if none specified
 292                 chan=""
 293         else
 294                 chan="-c $channel_name"
 295         fi
 296
 297         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event "$event_name" $chan -s $sess_name -j >/dev/null 2>&1
 298         ok $? "Enable JUL event $event_name for session $sess_name"
 299 }
 300
 301 function enable_jul_lttng_event_loglevel()
 302 {
 303         sess_name=$1
 304         event_name="$2"
 305         loglevel=$3
 306         channel_name=$4
 307
 308         if [ -z $channel_name ]; then
 309                 # default channel if none specified
 310                 chan=""
 311         else
 312                 chan="-c $channel_name"
 313         fi
 314
 315         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event --loglevel $loglevel "$event_name" $chan -s $sess_name -j >/dev/null 2>&1
 316         ok $? "Enable JUL event $event_name for session $sess_name with loglevel $loglevel"
 317 }
 318
 319 function enable_ust_lttng_event_filter()
 320 {
 321         sess_name="$1"
 322         event_name="$2"
 323         filter="$3"
 324
 325         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event "$event_name" -s $sess_name -u --filter "$filter" >/dev/null 2>&1
 326         ok $? "Enable event $event_name with filtering for session $sess_name"
 327 }
 328
 329 function enable_ust_lttng_event_loglevel()
 330 {
 331         sess_name="$1"
 332         event_name="$2"
 333         loglevel="$3"
 334
 335         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event "$event_name" -s $sess_name -u --loglevel $loglevel >/dev/null 2>&1
 336         ok $? "Enable event $event_name with loglevel $loglevel"
 337 }
 338
 339 function enable_ust_lttng_event_loglevel_only()
 340 {
 341         sess_name="$1"
 342         event_name="$2"
 343         loglevel="$3"
 344
 345         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event "$event_name" -s $sess_name -u --loglevel-only $loglevel >/dev/null 2>&1
 346         ok $? "Enable event $event_name with loglevel-only $loglevel"
 347 }
 348
 349 function disable_ust_lttng_event ()
 350 {
 351         sess_name="$1"
 352         event_name="$2"
 353
 354         $TESTDIR/../src/bin/lttng/$LTTNG_BIN disable-event "$event_name" -s $sess_name -u >/dev/null 2>&1
 355         ok $? "Disable event $event_name for session $sess_name"
 356 }
 357
 358 function disable_jul_lttng_event ()
 359 {
 360         local sess_name="$1"
 361         local event_name="$2"
 362
 363         $TESTDIR/../src/bin/lttng/$LTTNG_BIN disable-event "$event_name" -s $sess_name -j >/dev/null 2>&1
 364         ok $? "Disable JUL event $event_name for session $sess_name"
 365 }
 366
 367 function start_lttng_tracing ()
 368 {
 369         sess_name=$1
 370
 371         $TESTDIR/../src/bin/lttng/$LTTNG_BIN start $sess_name >/dev/null 2>&1
 372         ok $? "Start tracing for session $sess_name"
 373 }
 374
 375 function stop_lttng_tracing ()
 376 {
 377         sess_name=$1
 378
 379         $TESTDIR/../src/bin/lttng/$LTTNG_BIN stop $sess_name >/dev/null 2>&1
 380         ok $? "Stop lttng tracing for session $sess_name"
 381 }
 382
 383 function destroy_lttng_session ()
 384 {
 385         sess_name=$1
 386
 387
 388         $TESTDIR/../src/bin/lttng/$LTTNG_BIN destroy $sess_name >/dev/null 2>&1
 389         ok $? "Destroy lttng session $sess_name"
 390 }
 391
 392 function lttng_snapshot_add_output ()
 393 {
 394         sess_name=$1
 395         trace_path=$2
 396
 397         $TESTDIR/../src/bin/lttng/$LTTNG_BIN snapshot add-output -s $sess_name file://$trace_path >/dev/null 2>&1
 398         ok $? "Added snapshot output file://$trace_path"
 399 }
 400
 401 function lttng_snapshot_del_output ()
 402 {
 403         local sess_name=$1
 404         local id=$2
 405
 406         $TESTDIR/../src/bin/lttng/$LTTNG_BIN snapshot del-output -s $sess_name $id >/dev/null 2>&1
 407         ok $? "Deleted snapshot output id $id"
 408 }
 409
 410 function lttng_snapshot_record ()
 411 {
 412         sess_name=$1
 413         trace_path=$2
 414
 415         $TESTDIR/../src/bin/lttng/$LTTNG_BIN snapshot record -s $sess_name >/dev/null 2>&1
 416         ok $? "Snapshot recorded"
 417 }
 418
 419 function lttng_save()
 420 {
 421         local sess_name=$1
 422         local opts=$2
 423
 424         $TESTDIR/../src/bin/lttng/$LTTNG_BIN save $sess_name $opts >/dev/null 2>&1
 425         ok $? "Session successfully saved"
 426 }
 427
 428 function lttng_load()
 429 {
 430         local opts=$1
 431
 432         $TESTDIR/../src/bin/lttng/$LTTNG_BIN load $opts >/dev/null 2>&1
 433         ok $? "Load command successful"
 434 }
 435
 436 function trace_matches ()
 437 {
 438         event_name=$1
 439         nr_iter=$2
 440         trace_path=$3
 441
 442         which $BABELTRACE_BIN >/dev/null
 443         skip $? -ne 0 "Babeltrace binary not found. Skipping trace matches"
 444
 445         count=$($BABELTRACE_BIN $trace_path | grep $event_name | wc -l)
 446
 447         if [ "$count" -ne "$nr_iter" ]; then
 448                 fail "Trace match"
 449                 diag "$count events found in trace"
 450         else
 451                 pass "Trace match"
 452         fi
 453 }
 454
 455 function validate_trace
 456 {
 457         event_name=$1
 458         trace_path=$2
 459
 460         which $BABELTRACE_BIN >/dev/null
 461         if [ $? -ne 0 ]; then
 462             skip 0 "Babeltrace binary not found. Skipping trace validation"
 463         fi
 464
 465         OLDIFS=$IFS
 466         IFS=","
 467         for i in $event_name; do
 468                 traced=$($BABELTRACE_BIN $trace_path 2>/dev/null | grep $i | wc -l)
 469                 if [ "$traced" -ne 0 ]; then
 470                         pass "Validate trace for event $i, $traced events"
 471                 else
 472                         fail "Validate trace for event $i"
 473                         diag "Found $traced occurences of $i"
 474                 fi
 475         done
 476         ret=$?
 477         IFS=$OLDIFS
 478         return $ret
 479 }
 480
 481 function trace_match_only()
 482 {
 483         local event_name=$1
 484         local nr_iter=$2
 485         local trace_path=$3
 486
 487         which $BABELTRACE_BIN >/dev/null
 488         skip $? -ne 0 "Babeltrace binary not found. Skipping trace matches"
 489
 490         local count=$($BABELTRACE_BIN $trace_path | grep $event_name | wc -l)
 491         local total=$($BABELTRACE_BIN $trace_path | wc -l)
 492
 493         if [ "$nr_iter" -eq "$count" ] && [ "$total" -eq "$nr_iter" ]; then
 494                 pass "Trace match with $total event $event_name"
 495         else
 496                 fail "Trace match"
 497                 diag "$total event(s) found, expecting $nr_iter of event $event_name and only found $count"
 498         fi
 499 }