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 function print_ok ()
  29 {
  30         # Check if we are a terminal
  31         if [ -t 1 ]; then
  32                 echo -e "\e[1;32mOK\e[0m"
  33         else
  34                 echo -e "OK"
  35         fi
  36 }
  37
  38 function print_fail ()
  39 {
  40         # Check if we are a terminal
  41         if [ -t 1 ]; then
  42                 echo -e "\e[1;31mFAIL\e[0m"
  43         else
  44                 echo -e "FAIL"
  45         fi
  46 }
  47
  48 function print_test_banner ()
  49 {
  50         desc="$1"
  51
  52         count=$((${#desc}+2))
  53         str=$(printf "%${count}s");
  54         echo -e "\n"
  55         echo -e ${str// /-}
  56         echo -e " $desc "
  57         echo -e ${str// /-}
  58 }
  59
  60 function validate_kernel_version ()
  61 {
  62         kern_version=($(uname -r | awk -F. '{ printf("%d.%d.%d\n",$1,$2,$3); }' | tr '.' '\n'))
  63         if [ ${kern_version[0]} -gt $KERNEL_MAJOR_VERSION ]; then
  64                 return 0
  65         fi
  66         if [ ${kern_version[1]} -gt $KERNEL_MINOR_VERSION ]; then
  67                 return 0
  68         fi
  69         if [ ${kern_version[2]} -ge $KERNEL_PATCHLEVEL_VERSION ]; then
  70                 return 0
  71         fi
  72         return 1
  73 }
  74
  75 # Generate a random string
  76 #  $1 = number of characters; defaults to 16
  77 #  $2 = include special characters; 1 = yes, 0 = no; defaults to yes
  78 function randstring()
  79 {
  80         [ "$2" == "0" ] && CHAR="[:alnum:]" || CHAR="[:graph:]"
  81         cat /dev/urandom | tr -cd "$CHAR" | head -c ${1:-16}
  82         echo
  83 }
  84
  85 function spawn_sessiond ()
  86 {
  87         echo ""
  88         echo -n "Starting session daemon... "
  89         validate_kernel_version
  90         if [ $? -ne 0 ]; then
  91                 echo -e "\n*** Kernel too old for session daemon tests ***\n"
  92                 return 2
  93         fi
  94
  95         DIR=$(readlink -f $TESTDIR)
  96
  97         if [ -z $(pidof lt-$SESSIOND_BIN) ]; then
  98                 $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"
  99                 #$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 &
 100                 if [ $? -eq 1 ]; then
 101                         print_fail
 102                         return 1
 103                 else
 104                         print_ok
 105                 fi
 106         fi
 107
 108         return 0
 109 }
 110
 111 function lttng_enable_kernel_event
 112 {
 113         sess_name=$1
 114         event_name=$2
 115
 116         if [ -z $event_name ]; then
 117                 # Enable all event if no event name specified
 118                 $event_name="-a"
 119         fi
 120
 121         echo -n "Enabling kernel event $event_name for session $sess_name"
 122         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event "$event_name" -s $sess_name -k >/dev/null 2>&1
 123         if [ $? -eq 1 ]; then
 124                 print_fail
 125                 return 1
 126         else
 127                 print_ok
 128         fi
 129 }
 130
 131 function start_lttng_relayd
 132 {
 133         local opt=$1
 134
 135         echo -e -n "Starting lttng-relayd (opt: $opt)... "
 136
 137         DIR=$(readlink -f $TESTDIR)
 138
 139         if [ -z $(pidof lt-$RELAYD_BIN) ]; then
 140                 $DIR/../src/bin/lttng-relayd/$RELAYD_BIN $opt >/dev/null 2>&1 &
 141                 #$DIR/../src/bin/lttng-relayd/$RELAYD_BIN $opt -vvv >>/tmp/relayd.log 2>&1 &
 142                 if [ $? -eq 1 ]; then
 143                         print_fail
 144                         return 1
 145                 else
 146                         print_ok
 147                 fi
 148         else
 149                 print_ok
 150         fi
 151 }
 152
 153 function stop_lttng_relayd
 154 {
 155         PID_RELAYD=`pidof lt-$RELAYD_BIN`
 156
 157         echo -e -n "Killing lttng-relayd (pid: $PID_RELAYD)... "
 158         kill $PID_RELAYD >/dev/null 2>&1
 159         if [ $? -eq 1 ]; then
 160                 print_fail
 161                 return 1
 162         else
 163                 out=1
 164                 while [ -n "$out" ]; do
 165                         out=$(pidof lt-$RELAYD_BIN)
 166                         sleep 0.5
 167                 done
 168                 print_ok
 169                 return 0
 170         fi
 171 }
 172
 173 function start_lttng_sessiond()
 174 {
 175         if [ -n $TEST_NO_SESSIOND ] && [ "$TEST_NO_SESSIOND" == "1" ]; then
 176                 # Env variable requested no session daemon
 177                 return
 178         fi
 179
 180         spawn_sessiond
 181         out=$?
 182         if [ $out -eq 2 ]; then
 183                 # Kernel version is not compatible.
 184                 exit 0
 185         elif [ $out -ne 0 ]; then
 186                 echo "NOT bad $?"
 187                 exit 1
 188         fi
 189
 190         # Simply wait for the session daemon bootstrap
 191         echo "Waiting for the session daemon to bootstrap (2 secs)"
 192         sleep 2
 193 }
 194
 195 function stop_lttng_sessiond ()
 196 {
 197         if [ -n $TEST_NO_SESSIOND ] && [ "$TEST_NO_SESSIOND" == "1" ]; then
 198                 # Env variable requested no session daemon
 199                 return
 200         fi
 201
 202         PID_SESSIOND=`pidof lt-$SESSIOND_BIN`
 203
 204         echo -e -n "Killing session daemon... "
 205         kill $PID_SESSIOND >/dev/null 2>&1
 206         if [ $? -eq 1 ]; then
 207                 print_fail
 208                 return 1
 209         else
 210                 out=1
 211                 while [ -n "$out" ]; do
 212                         out=$(pidof lt-$SESSIOND_BIN)
 213                         sleep 0.5
 214                 done
 215                 print_ok
 216         fi
 217 }
 218
 219 function create_lttng_session ()
 220 {
 221         sess_name=$1
 222         trace_path=$2
 223
 224         echo -n "Creating lttng session $sess_name in $trace_path "
 225         $TESTDIR/../src/bin/lttng/$LTTNG_BIN create $sess_name -o $trace_path >/dev/null 2>&1
 226         if [ $? -eq 1 ]; then
 227                 print_fail
 228                 return 1
 229         else
 230                 print_ok
 231         fi
 232 }
 233
 234 function enable_lttng_channel()
 235 {
 236         sess_name=$1
 237         channel_name=$2
 238
 239         echo -n "Enabling lttng channel $channel_name for session $sess_name"
 240         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-channel $channel_name -s $sess_name >/dev/null 2>&1
 241         if [ $? -eq 1 ]; then
 242                 print_fail
 243                 return 1
 244         else
 245                 print_ok
 246         fi
 247 }
 248
 249 function disable_lttng_channel()
 250 {
 251         sess_name=$1
 252         channel_name=$2
 253
 254         echo -n "Disabling lttng channel $channel_name for session $sess_name"
 255         $TESTDIR/../src/bin/lttng/$LTTNG_BIN disable-channel $channel_name -s $sess_name >/dev/null 2>&1
 256         if [ $? -eq 1 ]; then
 257                 print_fail
 258                 return 1
 259         else
 260                 print_ok
 261         fi
 262 }
 263
 264 function enable_ust_lttng_event ()
 265 {
 266         sess_name=$1
 267         event_name="$2"
 268
 269         echo -n "Enabling lttng event $event_name for session $sess_name "
 270         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event "$event_name" -s $sess_name -u >/dev/null 2>&1
 271         if [ $? -eq 1 ]; then
 272                 print_fail
 273                 return 1
 274         else
 275                 print_ok
 276         fi
 277 }
 278
 279 function enable_ust_lttng_event_filter()
 280 {
 281         sess_name="$1"
 282         event_name="$2"
 283         filter="$3"
 284         echo -n "Enabling lttng event with filtering "
 285
 286         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event "$event_name" -s $sess_name -u --filter "$filter" 2>&1 >/dev/null
 287         if [ $? -eq 0 ]; then
 288                 print_ok
 289                 return 0
 290         else
 291                 print_fail
 292                 return 1
 293         fi
 294 }
 295
 296 function enable_ust_lttng_event_loglevel()
 297 {
 298         sess_name="$1"
 299         event_name="$2"
 300         loglevel="$3"
 301         echo -n "Enabling lttng event $event_name with loglevel $loglevel"
 302
 303         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event "$event_name" -s $sess_name -u --loglevel $loglevel 2>&1 >/dev/null
 304         if [ $? -eq 0 ]; then
 305                 print_ok
 306                 return 0
 307         else
 308                 print_fail
 309                 return 1
 310         fi
 311 }
 312
 313 function enable_ust_lttng_event_loglevel_only()
 314 {
 315         sess_name="$1"
 316         event_name="$2"
 317         loglevel="$3"
 318         echo -n "Enabling lttng event $event_name with loglevel-only $loglevel"
 319
 320         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event "$event_name" -s $sess_name -u --loglevel-only $loglevel 2>&1 >/dev/null
 321         if [ $? -eq 0 ]; then
 322                 print_ok
 323                 return 0
 324         else
 325                 print_fail
 326                 return 1
 327         fi
 328 }
 329
 330 function disable_ust_lttng_event ()
 331 {
 332         sess_name="$1"
 333         event_name="$2"
 334
 335         echo -n "Disabling lttng event $event_name for session $sess_name "
 336         $TESTDIR/../src/bin/lttng/$LTTNG_BIN disable-event "$event_name" -s $sess_name -u >/dev/null 2>&1
 337         if [ $? -eq 1 ]; then
 338                 print_fail
 339                 return 1
 340         else
 341                 print_ok
 342         fi
 343 }
 344
 345 function start_lttng_tracing ()
 346 {
 347         sess_name=$1
 348
 349         echo -n "Start lttng tracing for session $sess_name "
 350         $TESTDIR/../src/bin/lttng/$LTTNG_BIN start $sess_name >/dev/null 2>&1
 351         if [ $? -eq 1 ]; then
 352                 print_fail
 353                 return 1
 354         else
 355                 print_ok
 356         fi
 357 }
 358
 359 function stop_lttng_tracing ()
 360 {
 361         sess_name=$1
 362
 363         echo -n "Stop lttng tracing for session $sess_name "
 364         $TESTDIR/../src/bin/lttng/$LTTNG_BIN stop $sess_name >/dev/null 2>&1
 365         if [ $? -eq 1 ]; then
 366                 print_fail
 367                 return 1
 368         else
 369                 print_ok
 370         fi
 371 }
 372
 373 function destroy_lttng_session ()
 374 {
 375         sess_name=$1
 376
 377         echo -n "Destroy lttng session $sess_name "
 378         $TESTDIR/../src/bin/lttng/$LTTNG_BIN destroy $sess_name >/dev/null 2>&1
 379         if [ $? -eq 1 ]; then
 380                 print_fail
 381                 return 1
 382         else
 383                 print_ok
 384         fi
 385 }
 386
 387 function trace_matches ()
 388 {
 389         event_name=$1
 390         nr_iter=$2
 391         trace_path=$3
 392
 393         which $BABELTRACE_BIN >/dev/null
 394         if [ $? -eq 1 ]; then
 395                 echo "Babeltrace binary not found. Skipping trace matches"
 396                 return 0
 397         fi
 398
 399         echo -n "Looking for $nr_iter $event_name in $trace_path "
 400
 401         count=$($BABELTRACE_BIN $trace_path | grep $event_name | wc -l)
 402         if [ "$count" -ne "$nr_iter" ]; then
 403                 echo -n "$count found in trace "
 404                 print_fail
 405                 return 1
 406         else
 407                 echo -n "Trace is coherent "
 408                 print_ok
 409                 return 0
 410         fi
 411 }
 412
 413 function validate_trace
 414 {
 415         event_name=$1
 416         trace_path=$2
 417
 418         which $BABELTRACE_BIN >/dev/null
 419         if [ $? -eq 1 ]; then
 420                 echo "Babeltrace binary not found. Skipping trace matches"
 421                 return 0
 422         fi
 423
 424         echo -n "Validating trace for event $event_name... "
 425         traced=$($BABELTRACE_BIN $trace_path 2>/dev/null | grep $event_name | wc -l)
 426         if [ $traced -eq 0 ]; then
 427                 print_fail
 428                 return 1
 429         else
 430                 print_ok
 431                 return 0
 432         fi
 433 }