tests/regression/tools/snapshots/ust_test

   1 #!/bin/bash
   2 #
   3 # Copyright (C) 2013 Julien Desfossez <jdesfossez@efficios.com>
   4 #
   5 # SPDX-License-Identifier: LGPL-2.1-only
   6
   7 TEST_DESC="Snapshots - UST tracing"
   8
   9 CURDIR=$(dirname $0)/
  10 TESTDIR=$CURDIR/../../..
  11 EVENT_NAME="tp:tptest"
  12 SESSION_NAME=""
  13 CHANNEL_NAME="snapchan"
  14 TESTAPP_PATH="$TESTDIR/utils/testapp"
  15 TESTAPP_NAME="gen-ust-events"
  16 TESTAPP_BIN="$TESTAPP_PATH/$TESTAPP_NAME/$TESTAPP_NAME"
  17 APPS_PID=
  18
  19 NUM_TESTS=104
  20
  21 TRACE_PATH=$(mktemp -d -t tmp.test_snapshots_ust_trace_path.XXXXXX)
  22
  23 source $TESTDIR/utils/utils.sh
  24
  25 if [ ! -x "$TESTAPP_BIN" ]; then
  26         BAIL_OUT "No UST events binary detected"
  27 fi
  28
  29 # Need the number of snapshot to do.
  30 if [ -z $1 ]; then
  31         BAIL_OUT "A number of snapshot is needed"
  32 fi
  33 NR_SNAPSHOT=$1
  34
  35 NUM_TESTS=$(($NUM_TESTS + ($NR_SNAPSHOT * 3)))
  36
  37 function start_test_app()
  38 {
  39         local tmp_file=$(mktemp -u -t "tmp.${FUNCNAME[0]}_tmp_file.XXXXXX")
  40
  41         # Start application with a temporary file.
  42         $TESTAPP_BIN -i $NR_ITER -w $NR_USEC_WAIT --sync-after-first-event $tmp_file &
  43         ret=$?
  44         APPS_PID="${APPS_PID} ${!}"
  45         ok $ret "Start application to trace"
  46
  47         # Wait for the application file to appear indicating that at least one
  48         # tracepoint has been fired.
  49         while [ ! -f "$tmp_file" ]; do
  50                 sleep 0.5
  51         done
  52         diag "Removing test app temporary file $tmp_file"
  53         rm -f $tmp_file
  54 }
  55
  56 function wait_test_apps()
  57 {
  58         diag "Waiting for $TESTAPP_NAME"
  59         for p in ${APPS_PID}; do
  60                 wait ${p} 2>/dev/null
  61         done
  62 }
  63
  64 function stop_test_apps()
  65 {
  66         diag "Stopping $TESTAPP_NAME"
  67         for p in ${APPS_PID}; do
  68                 kill ${p}
  69                 wait ${p} 2>/dev/null
  70         done
  71         APPS_PID=
  72 }
  73
  74 function snapshot_add_output ()
  75 {
  76         local sess_name=$1
  77         local trace_path=$2
  78         local name=$3
  79         local max_size=$4
  80         local extra_opt=""
  81
  82         if [ ! -z $name ]; then
  83                 extra_opt+=" -n $name "
  84         fi
  85
  86         if [ ! -z $max_size ]; then
  87                 extra_opt+=" -m $max_size "
  88         fi
  89
  90         $TESTDIR/../src/bin/lttng/$LTTNG_BIN snapshot add-output \
  91                 -s $sess_name $extra_opt $trace_path > /dev/null 2>&1
  92
  93         ok $? "Added snapshot output $trace_path ($extra_opt)"
  94 }
  95
  96 function snapshot_del_output ()
  97 {
  98         local sess_name=$1
  99         local name=$2
 100
 101         $TESTDIR/../src/bin/lttng/$LTTNG_BIN snapshot del-output \
 102                 -s $sess_name $name > /dev/null 2>&1
 103
 104         ok $? "Deleted snapshot output named $name"
 105 }
 106
 107 function enable_mmap_overwrite_subbuf_ust_channel ()
 108 {
 109         local sess_name=$1
 110         local chan_name=$2
 111         local subbuf_size=$3
 112         local subbuf_count=$4
 113
 114         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-channel -s $sess_name \
 115                 $chan_name -u --output mmap --overwrite \
 116                 --num-subbuf=$subbuf_count \
 117                 --subbuf-size $subbuf_size > /dev/null 2>&1
 118
 119         ok $? "Enable channel $channel_name for session $sess_name with subbuf size $subbuf_size"
 120 }
 121
 122 function enable_mmap_small_discard_ust_channel ()
 123 {
 124         local sess_name=$1
 125         local chan_name=$2
 126
 127         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-channel -s $sess_name \
 128                 $chan_name -u --output mmap --discard \
 129                 --subbuf-size $(getconf PAGE_SIZE) --num-subbuf 2 \
 130                 > /dev/null 2>&1
 131
 132         ok $? "Enable channel $channel_name for session $sess_name with small discard buffers"
 133 }
 134
 135 function enable_mmap_small_overwrite_ust_channel ()
 136 {
 137         local sess_name=$1
 138         local chan_name=$2
 139
 140         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-channel -s $sess_name \
 141                 $chan_name -u --output mmap --overwrite \
 142                 --subbuf-size $(getconf PAGE_SIZE) --num-subbuf 2 \
 143                 > /dev/null 2>&1
 144
 145         ok $? "Enable channel $channel_name for session $sess_name with small discard buffers"
 146 }
 147
 148 function test_ust_list_output ()
 149 {
 150         output_names=("randomname" "somesnapshot")
 151
 152         diag "Test UST snapshot output listing"
 153         create_lttng_session_no_output $SESSION_NAME
 154         enable_lttng_mmap_overwrite_ust_channel $SESSION_NAME $CHANNEL_NAME
 155         enable_ust_lttng_event_ok $SESSION_NAME $EVENT_NAME $CHANNEL_NAME
 156
 157         start_lttng_tracing_ok $SESSION_NAME
 158
 159         snapshot_add_output $SESSION_NAME "file://$TRACE_PATH" ${output_names[0]}
 160
 161         $TESTDIR/../src/bin/lttng/$LTTNG_BIN snapshot list-output \
 162                 -s $SESSION_NAME 2>&1 | grep ${output_names[0]} > /dev/null
 163         ok $? "Snapshot named ${output_names[0]} present in list-output listing"
 164
 165         snapshot_del_output $SESSION_NAME ${output_names[0]}
 166
 167         snapshot_add_output $SESSION_NAME "file://$TRACE_PATH" ${output_names[1]}
 168
 169         $TESTDIR/../src/bin/lttng/$LTTNG_BIN snapshot list-output \
 170                 -s $SESSION_NAME 2>&1 | grep ${output_names[1]} > /dev/null
 171
 172         ok $? "Snapshot named ${output_names[1]} present in list-output listing"
 173
 174         stop_lttng_tracing_ok $SESSION_NAME
 175         destroy_lttng_session_ok $SESSION_NAME
 176 }
 177
 178 function test_ust_local_snapshot ()
 179 {
 180         NR_ITER=-1
 181         NR_USEC_WAIT=100
 182
 183         diag "Test local UST snapshots"
 184         create_lttng_session_no_output $SESSION_NAME
 185         enable_lttng_mmap_overwrite_ust_channel $SESSION_NAME $CHANNEL_NAME
 186         enable_ust_lttng_event_ok $SESSION_NAME $EVENT_NAME $CHANNEL_NAME
 187         start_lttng_tracing_ok $SESSION_NAME
 188         lttng_snapshot_add_output_ok $SESSION_NAME file://$TRACE_PATH
 189
 190         # Returns once the application has at least fired ONE tracepoint.
 191         start_test_app
 192
 193         lttng_snapshot_record $SESSION_NAME
 194         stop_lttng_tracing_ok $SESSION_NAME
 195         destroy_lttng_session_ok $SESSION_NAME
 196
 197         # Validate test
 198         validate_trace_path_ust_uid_snapshot "$TRACE_PATH" "" "snapshot-1" 0
 199         validate_trace $EVENT_NAME $TRACE_PATH/
 200         if [ $? -eq 0 ]; then
 201                 # Only delete if successful
 202                 rm -rf $TRACE_PATH
 203         fi
 204
 205         stop_test_apps
 206 }
 207
 208 function test_ust_local_snapshot_small_discard_buffers ()
 209 {
 210         NR_ITER=10000
 211         NR_USEC_WAIT=0
 212         OLDCPUSET=$(taskset -p $$)
 213
 214         diag "Test local UST snapshots with small discard buffers"
 215         taskset -p 0x1 $$ 1>/dev/null 2>&1      # CPU 0 only
 216         create_lttng_session_no_output $SESSION_NAME
 217         enable_mmap_small_discard_ust_channel $SESSION_NAME $CHANNEL_NAME
 218         enable_ust_lttng_event_ok $SESSION_NAME $EVENT_NAME $CHANNEL_NAME
 219         start_lttng_tracing_ok $SESSION_NAME
 220         lttng_snapshot_add_output_ok $SESSION_NAME file://$TRACE_PATH
 221
 222         # Run test apps, wait for them to complete.
 223         start_test_app
 224         wait_test_apps
 225
 226         # Take first snapshot, remember first line.
 227         lttng_snapshot_record $SESSION_NAME
 228         FIRST_LINE="$(trace_first_line $TRACE_PATH/)"
 229         diag "First line (1st snapshot): $FIRST_LINE"
 230         rm -rf $TRACE_PATH/
 231
 232         # Run test apps, wait for them to complete.
 233         start_test_app
 234         wait_test_apps
 235
 236         # Take second snapshot, remember first line.
 237         lttng_snapshot_record $SESSION_NAME
 238         FIRST_LINE_2="$(trace_first_line $TRACE_PATH/)"
 239         diag "First line (2nd snapshot): $FIRST_LINE_2"
 240         rm -rf $TRACE_PATH/
 241
 242         if [ x"$FIRST_LINE" != x"$FIRST_LINE_2" ]; then
 243                 fail "First snapshot event do not match"
 244         else
 245                 pass "First snapshot event match"
 246         fi
 247
 248         stop_lttng_tracing_ok $SESSION_NAME
 249         destroy_lttng_session_ok $SESSION_NAME
 250         taskset -p $OLDCPUSET $$ 1>/dev/null 2>&1
 251 }
 252
 253 function test_ust_local_snapshot_small_overwrite_buffers ()
 254 {
 255         NR_ITER=10000
 256         NR_USEC_WAIT=0
 257         OLDCPUSET=$(taskset -p $$)
 258
 259         diag "Test local UST snapshots with small overwrite buffers"
 260         taskset -p 0x1 $$ 1>/dev/null 2>&1      # CPU 0 only
 261         create_lttng_session_no_output $SESSION_NAME
 262         enable_mmap_small_overwrite_ust_channel $SESSION_NAME $CHANNEL_NAME
 263         enable_ust_lttng_event_ok $SESSION_NAME $EVENT_NAME $CHANNEL_NAME
 264         start_lttng_tracing_ok $SESSION_NAME
 265         lttng_snapshot_add_output_ok $SESSION_NAME file://$TRACE_PATH
 266
 267         # Run test apps, wait for them to complete.
 268         start_test_app
 269         wait_test_apps
 270
 271         # Take first snapshot, remember first line.
 272         lttng_snapshot_record $SESSION_NAME
 273         FIRST_LINE="$(trace_first_line $TRACE_PATH/)"
 274         diag "First line (1st snapshot): $FIRST_LINE"
 275         rm -rf $TRACE_PATH/
 276
 277         # Run test apps, wait for them to complete.
 278         start_test_app
 279         wait_test_apps
 280
 281         # Take second snapshot, remember first line.
 282         lttng_snapshot_record $SESSION_NAME
 283         FIRST_LINE_2="$(trace_first_line $TRACE_PATH/)"
 284         diag "First line (2nd snapshot): $FIRST_LINE_2"
 285         rm -rf $TRACE_PATH/
 286
 287         if [ x"$FIRST_LINE" != x"$FIRST_LINE_2" ]; then
 288                 pass "First snapshot event do not match"
 289         else
 290                 fail "First snapshot event match"
 291         fi
 292
 293         stop_lttng_tracing_ok $SESSION_NAME
 294         destroy_lttng_session_ok $SESSION_NAME
 295         taskset -p $OLDCPUSET $$ 1>/dev/null 2>&1
 296 }
 297
 298 function test_ust_local_snapshot_max_size ()
 299 {
 300         local possible_cpus
 301         local online_cpus
 302         local subbuf_size
 303         local subbuf_count
 304         local snapshot_max_size
 305         local channel_max_size_per_cpu
 306
 307         possible_cpus=$(get_possible_cpus_count)
 308         online_cpus=$(conf_proc_count)
 309         subbuf_size=$(getconf PAGE_SIZE)
 310         subbuf_count=8
 311         snapshot_max_size=$((subbuf_size*possible_cpus))
 312         channel_max_size_per_cpu=$((subbuf_size*subbuf_count))
 313
 314         diag "Test local UST snapshots with max size $max_size"
 315         create_lttng_session_no_output "$SESSION_NAME"
 316
 317         enable_mmap_overwrite_subbuf_ust_channel \
 318                 "$SESSION_NAME" "$CHANNEL_NAME" \
 319                 "$subbuf_size" "$subbuf_count"
 320
 321         enable_ust_lttng_event_ok "$SESSION_NAME" "$EVENT_NAME" "$CHANNEL_NAME"
 322         start_lttng_tracing_ok "$SESSION_NAME"
 323
 324         snapshot_add_output "$SESSION_NAME" "file://$TRACE_PATH" "" "$snapshot_max_size"
 325
 326         # Fill all ring-buffers of the channel; assuming event size of at least one
 327         # byte
 328         for cpu in $(seq "$online_cpus");
 329         do
 330                 taskset --cpu-list $((cpu-1)) "$TESTAPP_BIN" \
 331                         --iter "$channel_max_size_per_cpu"
 332         done
 333         diag "Filled channel ring-buffers"
 334
 335         lttng_snapshot_record "$SESSION_NAME"
 336
 337         # Check file size
 338         local snapshot_size
 339         snapshot_size=$(find "$TRACE_PATH" -name "${CHANNEL_NAME}_*" \
 340                                 -exec stat -c '%s' {} \; | \
 341                                 awk '{s = s + $1}END{print s}')
 342
 343         if [ "$snapshot_size" -eq "$snapshot_max_size" ]; then
 344                 pass "Tracefiles size sum validation"
 345         else
 346                 fail "Tracefiles size sum validation"
 347                 diag "Tracefiles size sum: $snapshot_size Expected max: $snapshot_max_size"
 348         fi
 349
 350         stop_lttng_tracing_ok "$SESSION_NAME"
 351         destroy_lttng_session_ok "$SESSION_NAME"
 352
 353         # Validate test
 354         validate_trace_path_ust_uid_snapshot "$TRACE_PATH" "" "snapshot-1" 0
 355
 356         if validate_trace "$EVENT_NAME" "$TRACE_PATH/"; then
 357                 # Only delete if successful
 358                 rm -rf "$TRACE_PATH"
 359         fi
 360
 361         stop_test_apps
 362 }
 363
 364 function test_ust_local_snapshot_large_metadata ()
 365 {
 366         LM_EVENT="tp:tptest1,tp:tptest2,tp:tptest3,tp:tptest4,tp:tptest5"
 367         LM_PATH="$TESTDIR/utils/testapp"
 368         LM_NAME="gen-ust-nevents"
 369         LM_BIN="$LM_PATH/$LM_NAME/$LM_NAME"
 370
 371         diag "Test local UST snapshots with > 4kB metadata"
 372         create_lttng_session_no_output $SESSION_NAME
 373         enable_lttng_mmap_overwrite_ust_channel $SESSION_NAME $CHANNEL_NAME
 374         enable_ust_lttng_event_ok $SESSION_NAME $LM_EVENT $CHANNEL_NAME
 375         start_lttng_tracing_ok $SESSION_NAME
 376         lttng_snapshot_add_output_ok $SESSION_NAME file://$TRACE_PATH
 377         $LM_BIN --iter 1 --wait 1
 378         ok $? "Start application to trace"
 379         lttng_snapshot_record $SESSION_NAME
 380         stop_lttng_tracing_ok $SESSION_NAME
 381         destroy_lttng_session_ok $SESSION_NAME
 382
 383         # Validate test
 384         validate_trace_path_ust_uid_snapshot "$TRACE_PATH" "" "snapshot-1" 0
 385         validate_trace $LM_EVENT $TRACE_PATH/
 386         if [ $? -eq 0 ]; then
 387                 # Only delete if successful
 388                 rm -rf $TRACE_PATH
 389         fi
 390 }
 391
 392 function enable_channel_per_uid_mmap_overwrite()
 393 {
 394         sess_name=$1
 395         channel_name=$2
 396
 397         $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-channel --buffers-uid -u $channel_name -s $sess_name --output mmap --overwrite >/dev/null 2>&1
 398         ok $? "Enable channel $channel_name per UID for session $sess_name"
 399 }
 400
 401 function test_ust_per_uid_local_snapshot ()
 402 {
 403         NR_ITER=-1
 404         NR_USEC_WAIT=100
 405         diag "Test per-uid local UST snapshots"
 406         create_lttng_session_no_output $SESSION_NAME
 407         enable_channel_per_uid_mmap_overwrite $SESSION_NAME $CHANNEL_NAME
 408         enable_ust_lttng_event_ok $SESSION_NAME $EVENT_NAME $CHANNEL_NAME
 409         start_lttng_tracing_ok $SESSION_NAME
 410         lttng_snapshot_add_output_ok $SESSION_NAME file://$TRACE_PATH
 411
 412         # Returns once the application has at least fired ONE tracepoint.
 413         start_test_app
 414
 415         lttng_snapshot_record $SESSION_NAME
 416         stop_lttng_tracing_ok $SESSION_NAME
 417         destroy_lttng_session_ok $SESSION_NAME
 418
 419         # Validate test
 420         validate_trace_path_ust_uid_snapshot "$TRACE_PATH" "" "snapshot-1" 0
 421         validate_trace $EVENT_NAME $TRACE_PATH/
 422         if [ $? -eq 0 ]; then
 423                 # Only delete if successful
 424                 rm -rf $TRACE_PATH
 425         fi
 426
 427         stop_test_apps
 428 }
 429
 430 function test_ust_per_uid_local_snapshot_post_mortem ()
 431 {
 432         NR_ITER=-1
 433         NR_USEC_WAIT=100
 434
 435         diag "Test local UST snapshots post-mortem"
 436         create_lttng_session_no_output $SESSION_NAME
 437         enable_channel_per_uid_mmap_overwrite $SESSION_NAME $CHANNEL_NAME
 438         enable_ust_lttng_event_ok $SESSION_NAME $EVENT_NAME $CHANNEL_NAME
 439         start_lttng_tracing_ok $SESSION_NAME
 440         lttng_snapshot_add_output_ok $SESSION_NAME file://$TRACE_PATH
 441
 442         # Returns once the application has at least fired ONE tracepoint.
 443         start_test_app
 444         stop_test_apps
 445
 446         lttng_snapshot_record $SESSION_NAME
 447         stop_lttng_tracing_ok $SESSION_NAME
 448         destroy_lttng_session_ok $SESSION_NAME
 449
 450         # Validate test
 451         validate_trace_path_ust_uid_snapshot "$TRACE_PATH" "" "snapshot-1" 0
 452         validate_trace $EVENT_NAME $TRACE_PATH/
 453         if [ $? -eq 0 ]; then
 454                 # Only delete if successful
 455                 rm -rf $TRACE_PATH
 456         fi
 457 }
 458
 459 function test_ust_local_snapshots ()
 460 {
 461         NR_ITER=-1
 462         NR_USEC_WAIT=100
 463
 464         diag "Test $NR_SNAPSHOT local UST snapshots"
 465         create_lttng_session_no_output $SESSION_NAME
 466         enable_lttng_mmap_overwrite_ust_channel $SESSION_NAME $CHANNEL_NAME
 467         enable_ust_lttng_event_ok $SESSION_NAME $EVENT_NAME $CHANNEL_NAME
 468         start_lttng_tracing_ok $SESSION_NAME
 469         lttng_snapshot_add_output_ok $SESSION_NAME file://$TRACE_PATH
 470
 471         # Returns once the application has at least fired ONE tracepoint.
 472         start_test_app
 473
 474         for i in $(seq 1 $NR_SNAPSHOT); do
 475                 diag "Snapshot $i/$NR_SNAPSHOT"
 476                 rm -rf $TRACE_PATH/snapshot/* 2>/dev/null
 477                 lttng_snapshot_record $SESSION_NAME
 478                 # Validate test
 479                 validate_trace_path_ust_uid_snapshot "$TRACE_PATH" "" "snapshot-1" $((i - 1))
 480                 validate_trace $EVENT_NAME $TRACE_PATH/
 481                 if [ $? -eq 0 ]; then
 482                         # Only delete if successful
 483                         rm -rf $TRACE_PATH
 484                 fi
 485         done
 486         stop_lttng_tracing_ok $SESSION_NAME
 487         destroy_lttng_session_ok $SESSION_NAME
 488
 489         stop_test_apps
 490 }
 491
 492 plan_tests $NUM_TESTS
 493
 494 print_test_banner "$TEST_DESC"
 495
 496 bail_out_if_no_babeltrace
 497
 498 start_lttng_sessiond
 499 tests=( test_ust_list_output
 500         test_ust_local_snapshot
 501         test_ust_local_snapshot_max_size
 502         test_ust_per_uid_local_snapshot
 503         test_ust_per_uid_local_snapshot_post_mortem
 504         test_ust_local_snapshot_large_metadata
 505         test_ust_local_snapshots
 506         test_ust_local_snapshot_small_discard_buffers
 507         test_ust_local_snapshot_small_overwrite_buffers
 508 )
 509
 510 for fct_test in ${tests[@]};
 511 do
 512         SESSION_NAME=$(randstring 16 0)
 513         ${fct_test}
 514 done
 515
 516 stop_lttng_sessiond