tests/regression/tools/tracefile-limits/test_tracefile_count

   1 #!/bin/bash
   2 #
   3 # Copyright (C) 2013 Christian Babeux <christian.babeux@efficios.com>
   4 # Copyright (C) 2020 Jérémie Galarneau <jeremie.galarneau@efficios.com>
   5 #
   6 # SPDX-License-Identifier: LGPL-2.1-only
   7
   8 TEST_DESC="Tracefile count limits"
   9
  10 CURDIR=$(dirname "$0")/
  11 TESTDIR=$CURDIR/../../..
  12
  13 TESTAPP_PATH="$TESTDIR/utils/testapp"
  14 TESTAPP_NAME="gen-ust-events"
  15 TESTAPP_BIN="$TESTAPP_PATH/$TESTAPP_NAME/$TESTAPP_NAME"
  16
  17 STATS_BIN="$TESTDIR/utils/babelstats.pl"
  18 NUM_TESTS=74
  19
  20 NUM_CPUS=$(nproc)
  21 PAGE_SIZE=$(getconf PAGE_SIZE)
  22 TRACEFILE_SIZE=$PAGE_SIZE
  23
  24 source "$TESTDIR"/utils/utils.sh
  25
  26 if [ ! -x "$TESTAPP_BIN" ]; then
  27         BAIL_OUT "No UST events binary detected."
  28 fi
  29
  30 function enable_lttng_channel_count_limit ()
  31 {
  32         sess_name="$1"
  33         channel_name="$2"
  34         tracefile_count_limit="$3"
  35
  36         test_name="Enable channel \`$channel_name\` "
  37         test_name+="for session \`$sess_name\`: "
  38         test_name+="$tracefile_count_limit tracefiles"
  39
  40         "$TESTDIR"/../src/bin/lttng/"$LTTNG_BIN" enable-channel \
  41             -u "$channel_name" -s "$sess_name" \
  42             --subbuf-size "$PAGE_SIZE" \
  43             --tracefile-size "$TRACEFILE_SIZE" \
  44             --tracefile-count "$tracefile_count_limit" >/dev/null 2>&1
  45
  46         ok $? "$test_name"
  47 }
  48
  49 function validate_min_max ()
  50 {
  51         stats="$1"
  52         field="$2"
  53         expected_min="$3"
  54         expected_max="$4"
  55
  56         echo $stats | grep -q -E "$field $expected_min $expected_max"
  57         return $?
  58 }
  59
  60 function get_total_stream_file_size ()
  61 {
  62         local trace_path="$1"
  63         local stream_name_pattern="$2"
  64         local size
  65
  66         size=$(find "$trace_path" -type f -regex "$stream_name_pattern" -exec du -b -c {} + | tail -n1 | cut -f 1)
  67         echo "$size"
  68 }
  69
  70 function get_stream_file_count ()
  71 {
  72         local trace_path="$1"
  73         local stream_name_pattern="$2"
  74         local count
  75
  76         count=$(find "$trace_path" -type f -regex "$stream_name_pattern" | wc -l)
  77         echo "$count"
  78 }
  79
  80 function test_tracefile_count_limit ()
  81 {
  82         local count_limit="$1"
  83
  84         local channel_name="channel"
  85         local cpuno=$((RANDOM % NUM_CPUS))
  86         local event_name="tp:tptest"
  87         local expected_size=$((count_limit * TRACEFILE_SIZE))
  88         local num_iter=100000
  89         local previous_stream_size=-1
  90         local session_name
  91         local stream_pattern=".*${channel_name}_${cpuno}_[0-9]*"
  92         local stream_size=0
  93         local trace_path
  94
  95         session_name=$(randstring 16 0)
  96         trace_path=$(mktemp -d)
  97
  98         diag "Test tracefile count limit : CPU $cpuno, $count_limit tracefiles, expecting a maximum of $expected_size bytes per CPU"
  99
 100         create_lttng_session_ok "$session_name" "$trace_path"
 101
 102         enable_lttng_channel_count_limit \
 103             "$session_name" "$channel_name" "$count_limit"
 104
 105         enable_ust_lttng_event_ok \
 106             "$session_name" "$event_name" "$channel_name"
 107
 108         # Run the test app until the total stream size stops changing the
 109         # expected size is exceeded (error).
 110         #
 111         # The `$stream_size` will not stabilize until the trace file count
 112         # limit is reached. This is guaranteed by the use of start/produce/stop
 113         # cycles forcing the consumption of buffers, preventing unwanted stall
 114         # in stream size.
 115         while [ "$stream_size" -ne "$previous_stream_size" ]; do
 116                 start_lttng_tracing_notap "$session_name"
 117                 taskset -c "$cpuno" "$TESTAPP_BIN" -i "$num_iter" >/dev/null 2>&1
 118                 stop_lttng_tracing_notap "$session_name"
 119
 120                 previous_stream_size="$stream_size"
 121                 stream_size=$(get_total_stream_file_size "$trace_path" "$stream_pattern")
 122                 diag "Completed an iteration: previous size = $previous_stream_size bytes, new size = $stream_size bytes"
 123
 124                 if [ "$stream_size" -gt "$expected_size" ]; then
 125                         diag "Total size for CPU $cpuno exceeds expected size: stream size = $stream_size bytes, expected size = $expected_size"
 126                         break
 127                 fi
 128         done
 129
 130         destroy_lttng_session_ok "$session_name"
 131
 132         [ "$expected_size" -eq "$stream_size" ]
 133         ok $? "Total stream size of CPU $cpuno is $expected_size"
 134
 135         [ "$(get_stream_file_count "$trace_path" "$stream_pattern")" -eq "$count_limit" ]
 136         ok $? "Stream meets the trace file limit of $count_limit"
 137
 138         stats=`babeltrace $trace_path | $STATS_BIN --tracepoint $event_name`
 139
 140         validate_min_max "$stats" "intfield" "[0-9]+" "$expected_max"
 141         ok $? "Trace validation - intfield"
 142
 143         validate_min_max "$stats" "netintfield" "[0-9]+" "$expected_max"
 144         ok $? "Trace validation - netintfield"
 145
 146         validate_min_max "$stats" "longfield" "[0-9]+" "$expected_max"
 147         ok $? "Trace validation - longfield"
 148
 149         rm -rf "$trace_path"
 150 }
 151
 152 LIMITS=("1" "2" "4" "8" "10" "16" "32" "64")
 153
 154 plan_tests $NUM_TESTS
 155
 156 print_test_banner "$TEST_DESC"
 157
 158 start_lttng_sessiond
 159
 160 for limit in "${LIMITS[@]}";
 161 do
 162         test_tracefile_count_limit "$limit"
 163 done
 164
 165 stop_lttng_sessiond