tests/regression/ust/clock-override/test_clock_override

   1 #!/bin/bash
   2 #
   3 # Copyright (C) 2015 Jonathan Rajotte <jonathan.rajotte-julien@efficios.com>
   4 #
   5 # SPDX-License-Identifier: LGPL-2.1-only
   6
   7 TEST_DESC="UST - Clock override plugin"
   8
   9 CURDIR=$(dirname $0)/
  10 TESTDIR=$CURDIR/../../..
  11 SESSION_NAME="clock_override"
  12
  13 TESTAPP_PATH="$TESTDIR/utils/testapp"
  14 TESTAPP_NAME="gen-ust-events"
  15 TESTAPP_BIN="$TESTAPP_PATH/$TESTAPP_NAME/$TESTAPP_NAME"
  16 NUM_EVENT=256
  17 EVENT_NAME="tp:tptest"
  18 LTTNG_UST_CLOCK_PLUGIN_SO="lttng-ust-clock-override-test.so"
  19 LIBS_DIR=".libs"
  20
  21 METADATA_CLOCK_START_TOKEN="clock {"
  22 METADATA_CLOCK_END_TOKEN="};"
  23
  24 METADATA_TOKEN_LIST=(
  25         "name"
  26         "uuid"
  27         "description"
  28         "freq"
  29 )
  30
  31 UST_CLOCK_TOKEN_VALUE=(
  32         "lttng_test_clock_override"
  33         "83c63deb-7aa4-48fb-abda-946f400d76e6"
  34         "Freeze time with 1KHz for regression test"
  35         "1000"
  36 )
  37
  38 NUM_TESTS=33
  39
  40 source $TESTDIR/utils/utils.sh
  41
  42 # MUST set TESTDIR before calling those functions
  43 function run_app()
  44 {
  45         $TESTAPP_BIN -i $NUM_EVENT
  46         ok $? "Application done"
  47 }
  48
  49 function extract_clock_metadata()
  50 {
  51         local metadata_file=$1
  52         local clock_metadata_file_destination=$2
  53         cat $metadata_file \
  54                 | sed -n "/$METADATA_CLOCK_START_TOKEN/,/$METADATA_CLOCK_END_TOKEN/p" \
  55                 > $clock_metadata_file_destination
  56         ok $? "Clock metadata extraction"
  57 }
  58
  59 function extract_clock_metadata_token()
  60 {
  61         local clock_metadata_file=$1
  62         local token=$2
  63         # Look for token and get value between ""
  64         cat $clock_metadata_file | grep $token | awk -F"= |;" '{print $2}' | tr -d '"'
  65 }
  66
  67 function test_getcpu_override_metadata()
  68 {
  69         local ctf_metadata_file=$(mktemp --tmpdir -p $TRACE_PATH ctf-metadata.XXXXXX)
  70         local clock_metadata_file=$(mktemp --tmpdir -p $TRACE_PATH clock-metadata.XXXXXX)
  71         local result=""
  72
  73         diag "Clock override plugin metadata test"
  74
  75         # LTTNG_UST_CLOCK_PLUGIN need to be defined for lttng-sessiond.
  76         export LTTNG_UST_CLOCK_PLUGIN=$CURDIR/.libs/$LTTNG_UST_CLOCK_PLUGIN_SO
  77         start_lttng_sessiond
  78         unset LTTNG_UST_CLOCK_PLUGIN
  79
  80         create_lttng_session_ok $SESSION_NAME $TRACE_PATH
  81         enable_ust_lttng_event_ok $SESSION_NAME "$EVENT_NAME"
  82         start_lttng_tracing_ok $SESSION_NAME
  83         run_app
  84         stop_lttng_tracing_ok $SESSION_NAME
  85         destroy_lttng_session_ok $SESSION_NAME
  86         stop_lttng_sessiond
  87
  88         local TRACE_METADATA_FILE_PATH="$(find "$TRACE_PATH" -name metadata -type f)"
  89         local TRACE_METADATA_DIR="$(dirname "$TRACE_METADATA_FILE_PATH")"
  90
  91         $BABELTRACE_BIN -o ctf-metadata -w $ctf_metadata_file $TRACE_METADATA_DIR
  92         ok $? "Metadata extraction from babeltrace"
  93
  94         extract_clock_metadata $ctf_metadata_file $clock_metadata_file
  95
  96         test ${#METADATA_TOKEN_LIST[@]} -eq ${#UST_CLOCK_TOKEN_VALUE[@]}
  97         ok $? "Tokens to check(${#METADATA_TOKEN_LIST[@]}) and provided values(${#UST_CLOCK_TOKEN_VALUE[@]}) count is equal"
  98
  99         local counter=0
 100         while [ "$counter" -lt "${#METADATA_TOKEN_LIST[@]}" ]; do
 101                 result=$(extract_clock_metadata_token $clock_metadata_file \
 102                         ${METADATA_TOKEN_LIST[$counter]})
 103                 test "$result" == "${UST_CLOCK_TOKEN_VALUE[$counter]}"
 104                 ok $? "Token \"${METADATA_TOKEN_LIST[$counter]}\" expect:${UST_CLOCK_TOKEN_VALUE[$counter]} got:$result"
 105                 let "counter++"
 106         done
 107         rm -rf $ctf_metadata_file
 108         rm -rf $clock_metadata_file
 109 }
 110
 111 function test_getcpu_override_timestamp()
 112 {
 113         diag "Clock override test"
 114
 115         # Test without the plugin
 116         diag "Plugin disabled"
 117         start_lttng_sessiond
 118         create_lttng_session_ok $SESSION_NAME $TRACE_PATH
 119         enable_ust_lttng_event_ok $SESSION_NAME "$EVENT_NAME"
 120         start_lttng_tracing_ok $SESSION_NAME
 121         run_app
 122         stop_lttng_tracing_ok $SESSION_NAME
 123         destroy_lttng_session_ok $SESSION_NAME
 124
 125         # Use Babeltrace with "-n all" to give a comma separated list for
 126         # easy extraction of timestamps.
 127         unique_timestamps_count=$($BABELTRACE_BIN -n all $TRACE_PATH | \
 128                 cut -d, -f1 | uniq | wc -l)
 129         test $unique_timestamps_count -gt 1
 130         ok $? "Unique event timestamps without clock override: $unique_timestamps_count expect >1"
 131         stop_lttng_sessiond
 132
 133         # Test with clock override plugin.
 134         # LTTNG_UST_CLOCK_PLUGIN need to be defined for both lttng-sessiond.
 135         diag "Plugin enabled"
 136         export LTTNG_UST_CLOCK_PLUGIN=$CURDIR/.libs/$LTTNG_UST_CLOCK_PLUGIN_SO
 137         start_lttng_sessiond
 138         create_lttng_session_ok $SESSION_NAME $TRACE_PATH
 139         enable_ust_lttng_event_ok $SESSION_NAME "$EVENT_NAME"
 140         start_lttng_tracing_ok $SESSION_NAME
 141         run_app
 142         unset LTTNG_UST_CLOCK_PLUGIN
 143         stop_lttng_tracing_ok $SESSION_NAME
 144         destroy_lttng_session_ok $SESSION_NAME
 145         stop_lttng_sessiond
 146
 147         # Use Babeltrace with "-n all" to give a comma separated list for
 148         # easy extraction of timestamps.
 149         unique_timestamps_count=$($BABELTRACE_BIN -n all $TRACE_PATH | \
 150                 cut -d, -f1 | uniq | wc -l)
 151         test $unique_timestamps_count -eq 1
 152         ok $? "Unique event timestamps with clock override: $unique_timestamps_count expect 1"
 153 }
 154
 155 plan_tests $NUM_TESTS
 156
 157 print_test_banner "$TEST_DESC"
 158
 159 if [ -x "$CURDIR/$LIBS_DIR/$LTTNG_UST_CLOCK_PLUGIN_SO" ]; then
 160         foundobj=1
 161 else
 162         foundobj=0
 163 fi
 164
 165 skip $foundobj "No shared object generated. Skipping all tests." $NUM_TESTS && exit 0
 166
 167 TESTS=(
 168         "test_getcpu_override_metadata"
 169         "test_getcpu_override_timestamp"
 170 )
 171
 172 TEST_COUNT=${#TESTS[@]}
 173 i=0
 174
 175 while [ "$i" -lt "$TEST_COUNT" ]; do
 176
 177         TRACE_PATH=$(mktemp --tmpdir -d tmp.test_clock_override_ust_trace_path.XXXXXX)
 178
 179         # Execute test
 180         ${TESTS[$i]}
 181
 182         rm -rf $TRACE_PATH
 183
 184         let "i++"
 185 done
 186