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 RELAYD_BIN="lttng-relayd"
  20 LTTNG_BIN="lttng"
  21 BABELTRACE_BIN="babeltrace"
  22
  23 # Minimal kernel version supported for session daemon tests
  24 KERNEL_MAJOR_VERSION=2
  25 KERNEL_MINOR_VERSION=6
  26 KERNEL_PATCHLEVEL_VERSION=27
  27
  28 source $TESTDIR/utils/tap/tap.sh
  29
  30 function print_ok ()
  31 {
  32         # Check if we are a terminal
  33         if [ -t 1 ]; then
  34                 echo -e "\e[1;32mOK\e[0m"
  35         else
  36                 echo -e "OK"
  37         fi
  38 }
  39
  40 function print_fail ()
  41 {
  42         # Check if we are a terminal
  43         if [ -t 1 ]; then
  44                 echo -e "\e[1;31mFAIL\e[0m"
  45         else
  46                 echo -e "FAIL"
  47         fi
  48 }
  49
  50 function print_test_banner ()
  51 {
  52         desc="$1"
  53         diag "$desc"
  54 }
  55
  56 function validate_kernel_version ()
  57 {
  58         kern_version=($(uname -r | awk -F. '{ printf("%d.%d.%d\n",$1,$2,$3); }' | tr '.' '\n'))
  59         if [ ${kern_version[0]} -gt $KERNEL_MAJOR_VERSION ]; then
  60                 return 0
  61         fi
  62         if [ ${kern_version[1]} -gt $KERNEL_MINOR_VERSION ]; then
  63                 return 0
  64         fi
  65         if [ ${kern_version[2]} -ge $KERNEL_PATCHLEVEL_VERSION ]; then
  66                 return 0
  67         fi
  68         return 1
  69 }
  70
  71 # Generate a random string
  72 #  $1 = number of characters; defaults to 16
  73 #  $2 = include special characters; 1 = yes, 0 = no; defaults to yes
  74 function randstring()
  75 {
  76         [ "$2" == "0" ] && CHAR="[:alnum:]" || CHAR="[:graph:]"
  77         cat /dev/urandom | tr -cd "$CHAR" | head -c ${1:-16}
  78         echo
  79 }
  80
  81 function lttng_enable_kernel_event
  82 {
  83         sess_name=$1
  84         event_name=$2
  85         channel_name=$3
  86
  87         if [ -z $event_name ]; then
  88                 # Enable all event if no event name specified
  89                 event_name="-a"
  90         fi
  91
  92         if [ -z $channel_name ]; then
  93                 # default channel if none specified
  94                 chan=""
  95         else
  96                 chan="-c $channel_name"
  97         fi
  98
  99         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event "$event_name" $chan -s $sess_name -k >/dev/null 2>&1
 100         ok $? "Enable kernel event $event_name for session $sess_name"
 101 }
 102
 103 function start_lttng_relayd
 104 {
 105         local opt=$1
 106
 107         DIR=$(readlink -f $TESTDIR)
 108
 109         if [ -z $(pidof lt-$RELAYD_BIN) ]; then
 110                 $DIR/../src/bin/lttng-relayd/$RELAYD_BIN $opt >/dev/null 2>&1 &
 111                 #$DIR/../src/bin/lttng-relayd/$RELAYD_BIN $opt -vvv >>/tmp/relayd.log 2>&1 &
 112                 if [ $? -eq 1 ]; then
 113                         fail "Start lttng-relayd (opt: $opt)"
 114                         return 1
 115                 else
 116                         pass "Start lttng-relayd (opt: $opt)"
 117                 fi
 118         else
 119                 pass "Start lttng-relayd (opt: $opt)"
 120         fi
 121 }
 122
 123 function stop_lttng_relayd
 124 {
 125         PID_RELAYD=`pidof lt-$RELAYD_BIN`
 126
 127         kill $PID_RELAYD >/dev/null 2>&1
 128
 129         if [ $? -eq 1 ]; then
 130                 fail "Kill lttng-relayd (pid: $PID_RELAYD)"
 131                 return 1
 132         else
 133                 out=1
 134                 while [ -n "$out" ]; do
 135                         out=$(pidof lt-$RELAYD_BIN)
 136                         sleep 0.5
 137                 done
 138                 pass "Kill lttng-relayd (pid: $PID_RELAYD)"
 139                 return 0
 140         fi
 141 }
 142
 143 function start_lttng_sessiond()
 144 {
 145         if [ -n $TEST_NO_SESSIOND ] && [ "$TEST_NO_SESSIOND" == "1" ]; then
 146                 # Env variable requested no session daemon
 147                 return
 148         fi
 149
 150         validate_kernel_version
 151         if [ $? -ne 0 ]; then
 152             fail "Start session daemon"
 153             BAIL_OUT "*** Kernel too old for session daemon tests ***"
 154         fi
 155
 156         DIR=$(readlink -f $TESTDIR)
 157
 158         if [ -z $(pidof lt-$SESSIOND_BIN) ]; then
 159                 $DIR/../src/bin/lttng-sessiond/$SESSIOND_BIN --daemonize --quiet --consumerd32-path="$DIR/../src/bin/lttng-consumerd/lttng-consumerd" --consumerd64-path="$DIR/../src/bin/lttng-consumerd/lttng-consumerd"
 160                 #$DIR/../src/bin/lttng-sessiond/$SESSIOND_BIN --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 &
 161                 status=$?
 162                 # Wait for sessiond to bootstrap
 163                 sleep 2
 164                 ok $status "Start session daemon"
 165         fi
 166 }
 167
 168 function stop_lttng_sessiond ()
 169 {
 170         if [ -n $TEST_NO_SESSIOND ] && [ "$TEST_NO_SESSIOND" == "1" ]; then
 171                 # Env variable requested no session daemon
 172                 return
 173         fi
 174
 175         PID_SESSIOND=`pidof lt-$SESSIOND_BIN`
 176
 177         kill $PID_SESSIOND >/dev/null 2>&1
 178
 179         if [ $? -eq 1 ]; then
 180                 fail "Kill sessions daemon"
 181                 return 1
 182         else
 183                 out=1
 184                 while [ -n "$out" ]; do
 185                         out=$(pidof lt-$SESSIOND_BIN)
 186                         sleep 0.5
 187                 done
 188                 pass "Kill session daemon"
 189         fi
 190 }
 191
 192 function create_lttng_session_no_output ()
 193 {
 194         sess_name=$1
 195
 196         $TESTDIR/../src/bin/lttng/$LTTNG_BIN create $sess_name --no-output >/dev/null 2>&1
 197         ok $? "Create session $sess_name in no-output mode"
 198 }
 199
 200 function create_lttng_session ()
 201 {
 202         sess_name=$1
 203         trace_path=$2
 204
 205         $TESTDIR/../src/bin/lttng/$LTTNG_BIN create $sess_name -o $trace_path >/dev/null 2>&1
 206         ok $? "Create session $sess_name in $trace_path"
 207 }
 208
 209 function enable_ust_lttng_channel()
 210 {
 211         sess_name=$1
 212         channel_name=$2
 213
 214         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-channel -u $channel_name -s $sess_name >/dev/null 2>&1
 215         ok $? "Enable channel $channel_name for session $sess_name"
 216 }
 217
 218 function disable_ust_lttng_channel()
 219 {
 220         sess_name=$1
 221         channel_name=$2
 222
 223         $TESTDIR/../src/bin/lttng/$LTTNG_BIN disable-channel -u $channel_name -s $sess_name >/dev/null 2>&1
 224         ok $? "Disable channel $channel_name for session $sess_name"
 225 }
 226
 227 function enable_lttng_mmap_overwrite_kernel_channel()
 228 {
 229         sess_name=$1
 230         channel_name=$2
 231
 232         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-channel -s $sess_name $channel_name -k --output mmap --overwrite >/dev/null 2>&1
 233         ok $? "Enable channel $channel_name for session $sess_name"
 234 }
 235
 236 function enable_ust_lttng_event ()
 237 {
 238         sess_name=$1
 239         event_name="$2"
 240
 241         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event "$event_name" -s $sess_name -u >/dev/null 2>&1
 242         ok $? "Enable event $event_name for session $sess_name"
 243 }
 244
 245 function enable_ust_lttng_event_filter()
 246 {
 247         sess_name="$1"
 248         event_name="$2"
 249         filter="$3"
 250
 251         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event "$event_name" -s $sess_name -u --filter "$filter" >/dev/null 2>&1
 252         ok $? "Enable event $event_name with filtering for session $sess_name"
 253 }
 254
 255 function enable_ust_lttng_event_loglevel()
 256 {
 257         sess_name="$1"
 258         event_name="$2"
 259         loglevel="$3"
 260
 261         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event "$event_name" -s $sess_name -u --loglevel $loglevel >/dev/null 2>&1
 262         ok $? "Enable event $event_name with loglevel $loglevel"
 263 }
 264
 265 function enable_ust_lttng_event_loglevel_only()
 266 {
 267         sess_name="$1"
 268         event_name="$2"
 269         loglevel="$3"
 270
 271         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event "$event_name" -s $sess_name -u --loglevel-only $loglevel >/dev/null 2>&1
 272         ok $? "Enable event $event_name with loglevel-only $loglevel"
 273 }
 274
 275 function disable_ust_lttng_event ()
 276 {
 277         sess_name="$1"
 278         event_name="$2"
 279
 280         $TESTDIR/../src/bin/lttng/$LTTNG_BIN disable-event "$event_name" -s $sess_name -u >/dev/null 2>&1
 281         ok $? "Disable event $event_name for session $sess_name"
 282 }
 283
 284 function start_lttng_tracing ()
 285 {
 286         sess_name=$1
 287
 288         $TESTDIR/../src/bin/lttng/$LTTNG_BIN start $sess_name >/dev/null 2>&1
 289         ok $? "Start tracing for session $sess_name"
 290 }
 291
 292 function stop_lttng_tracing ()
 293 {
 294         sess_name=$1
 295
 296         $TESTDIR/../src/bin/lttng/$LTTNG_BIN stop $sess_name >/dev/null 2>&1
 297         ok $? "Stop lttng tracing for session $sess_name"
 298 }
 299
 300 function destroy_lttng_session ()
 301 {
 302         sess_name=$1
 303
 304
 305         $TESTDIR/../src/bin/lttng/$LTTNG_BIN destroy $sess_name >/dev/null 2>&1
 306         ok $? "Destroy lttng session $sess_name"
 307 }
 308
 309 function lttng_snapshot_add_output ()
 310 {
 311         sess_name=$1
 312         trace_path=$2
 313
 314         $TESTDIR/../src/bin/lttng/$LTTNG_BIN snapshot add-output -s $sess_name file://$trace_path >/dev/null 2>&1
 315         ok $? "Added snapshot output file://$trace_path"
 316 }
 317
 318 function lttng_snapshot_del_output ()
 319 {
 320         local sess_name=$1
 321         local id=$2
 322
 323         $TESTDIR/../src/bin/lttng/$LTTNG_BIN snapshot del-output -s $sess_name $id >/dev/null 2>&1
 324         ok $? "Deleted snapshot output id $id"
 325 }
 326
 327 function lttng_snapshot_record ()
 328 {
 329         sess_name=$1
 330         trace_path=$2
 331
 332         $TESTDIR/../src/bin/lttng/$LTTNG_BIN snapshot record -s $sess_name >/dev/null 2>&1
 333         ok $? "Snapshot recorded"
 334 }
 335
 336 function trace_matches ()
 337 {
 338         event_name=$1
 339         nr_iter=$2
 340         trace_path=$3
 341
 342         which $BABELTRACE_BIN >/dev/null
 343         skip $? -ne 0 "Babeltrace binary not found. Skipping trace matches"
 344
 345         count=$($BABELTRACE_BIN $trace_path | grep $event_name | wc -l)
 346
 347         if [ "$count" -ne "$nr_iter" ]; then
 348                 fail "Trace match"
 349                 diag "$count events found in trace"
 350         else
 351                 pass "Trace match"
 352         fi
 353 }
 354
 355 function validate_trace
 356 {
 357         event_name=$1
 358         trace_path=$2
 359
 360         which $BABELTRACE_BIN >/dev/null
 361         if [ $? -ne 0 ]; then
 362             skip 0 "Babeltrace binary not found. Skipping trace validation"
 363         fi
 364
 365         OLDIFS=$IFS
 366         IFS=","
 367         for i in $event_name; do
 368                 traced=$($BABELTRACE_BIN $trace_path 2>/dev/null | grep $i | wc -l)
 369                 if [ "$traced" -ne 0 ]; then
 370                         pass "Validate trace for event $i"
 371                 else
 372                         fail "Validate trace for event $i"
 373                         diag "Found $traced occurences of $i"
 374                 fi
 375         done
 376         ret=$?
 377         IFS=$OLDIFS
 378         return $ret
 379 }