Commit | Line | Data |
---|---|---|
199800b2 JR |
1 | #!/bin/bash |
2 | # | |
9d16b343 | 3 | # Copyright (C) 2015 Jonathan Rajotte <jonathan.rajotte-julien@efficios.com> |
199800b2 | 4 | # |
9d16b343 MJ |
5 | # SPDX-License-Identifier: LGPL-2.1-only |
6 | ||
e10ccd82 | 7 | TEST_DESC="UST - Clock override plugin" |
199800b2 | 8 | |
1b59ae1f | 9 | CURDIR=$(dirname "$0")/ |
199800b2 JR |
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" | |
199800b2 JR |
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 | ||
199800b2 JR |
21 | source $TESTDIR/utils/utils.sh |
22 | ||
1b59ae1f JR |
23 | if [ "$TRACE_FORMAT_OUTPUT" == "ctf1" ]; then |
24 | NUM_TESTS=33 | |
25 | elif [ "$TRACE_FORMAT_OUTPUT" == "ctf2" ]; then | |
26 | NUM_TESTS=31 | |
27 | fi | |
28 | ||
199800b2 JR |
29 | # MUST set TESTDIR before calling those functions |
30 | function run_app() | |
31 | { | |
6c4a91d6 | 32 | $TESTAPP_BIN -i $NUM_EVENT |
199800b2 JR |
33 | ok $? "Application done" |
34 | } | |
35 | ||
1b59ae1f | 36 | function extract_clock_metadata_ctf1() |
199800b2 | 37 | { |
1b59ae1f JR |
38 | local metadata_clock_start_token="clock {" |
39 | local metadata_clock_end_token="};" | |
40 | ||
199800b2 JR |
41 | local metadata_file=$1 |
42 | local clock_metadata_file_destination=$2 | |
1b59ae1f JR |
43 | |
44 | sed -n "/$metadata_clock_start_token/,/$metadata_clock_end_token/p" "$metadata_file" > "$clock_metadata_file_destination" | |
199800b2 JR |
45 | ok $? "Clock metadata extraction" |
46 | } | |
47 | ||
1b59ae1f | 48 | function extract_clock_metadata_token_ctf1() |
199800b2 JR |
49 | { |
50 | local clock_metadata_file=$1 | |
51 | local token=$2 | |
52 | # Look for token and get value between "" | |
1b59ae1f JR |
53 | grep "$token" "$clock_metadata_file" | awk -F"= |;" '{print $2}' | tr -d '"' |
54 | } | |
55 | ||
56 | function validate_tokens_ctf1 | |
57 | { | |
58 | ||
59 | local metadata_token_list=( | |
60 | "name" | |
61 | "uuid" | |
62 | "description" | |
63 | "freq" | |
64 | ) | |
65 | ||
66 | local ust_clock_token_value=( | |
67 | "lttng_test_clock_override" | |
68 | "83c63deb-7aa4-48fb-abda-946f400d76e6" | |
69 | "Freeze time with 1KHz for regression test" | |
70 | "1000" | |
71 | ) | |
72 | ||
73 | test ${#metadata_token_list[@]} -eq ${#ust_clock_token_value[@]} | |
74 | ok $? "Tokens to check(${#metadata_token_list[@]}) and provided values(${#ust_clock_token_value[@]}) count is equal" | |
75 | ||
76 | local metadata_directory_path=$1 | |
77 | local ctf_metadata_file | |
78 | local clock_metadata_file | |
79 | ||
80 | clock_metadata_file=$(mktemp --tmpdir -p "$TRACE_PATH" clock-metadata.XXXXXX) | |
81 | ctf_metadata_file=$(mktemp --tmpdir -p "$TRACE_PATH" ctf-metadata.XXXXXX) | |
82 | ||
83 | $BABELTRACE_BIN -o ctf-metadata -w "$ctf_metadata_file" "$metadata_directory_path" | |
84 | ok $? "Metadata extraction from babeltrace" | |
85 | ||
86 | extract_clock_metadata_ctf1 "$ctf_metadata_file" "$clock_metadata_file" | |
87 | ||
88 | local counter=0 | |
89 | while [ "$counter" -lt "${#metadata_token_list[@]}" ]; do | |
90 | result=$(extract_clock_metadata_token_ctf1 "$clock_metadata_file" \ | |
91 | "${metadata_token_list[$counter]}") | |
92 | test "$result" == "${ust_clock_token_value[$counter]}" | |
93 | ok $? "Token \"${metadata_token_list[$counter]}\" expect:${ust_clock_token_value[$counter]} got:$result" | |
94 | (( counter++ )) | |
95 | done | |
96 | ||
97 | rm -rf "$ctf_metadata_file" | |
98 | rm -rf "$clock_metadata_file" | |
99 | } | |
100 | ||
101 | function validate_tokens_ctf2 | |
102 | { | |
103 | local metadata_token_list=( | |
104 | "name" | |
105 | "uuid" | |
106 | "description" | |
107 | "frequency" | |
108 | ) | |
109 | ||
110 | local ust_clock_token_value=( | |
111 | "lttng_test_clock_override" | |
112 | "[131,198,61,235,122,164,72,251,171,218,148,111,64,13,118,230]" | |
113 | "Freeze time with 1KHz for regression test" | |
114 | "1000" | |
115 | ) | |
116 | ||
117 | test ${#metadata_token_list[@]} -eq ${#ust_clock_token_value[@]} | |
118 | ok $? "Tokens to check(${#metadata_token_list[@]}) and provided values(${#ust_clock_token_value[@]}) count is equal" | |
119 | ||
120 | local metadata_path=$1 | |
121 | ||
122 | local counter=0 | |
123 | while [ "$counter" -lt "${#metadata_token_list[@]}" ]; do | |
124 | result=$(jq -c -r "select(.type == \"clock-class\").${metadata_token_list[$counter]}" "$metadata_path") | |
125 | test "$result" == "${ust_clock_token_value[$counter]}" | |
126 | ok $? "Token \"${metadata_token_list[$counter]}\" expect:${ust_clock_token_value[$counter]} got:$result" | |
127 | (( counter++ )) | |
128 | done | |
129 | ||
199800b2 JR |
130 | } |
131 | ||
132 | function test_getcpu_override_metadata() | |
133 | { | |
199800b2 | 134 | local result="" |
1b59ae1f JR |
135 | local metadata_file |
136 | local metadata_directory_path | |
199800b2 JR |
137 | |
138 | diag "Clock override plugin metadata test" | |
139 | ||
140 | # LTTNG_UST_CLOCK_PLUGIN need to be defined for lttng-sessiond. | |
141 | export LTTNG_UST_CLOCK_PLUGIN=$CURDIR/.libs/$LTTNG_UST_CLOCK_PLUGIN_SO | |
142 | start_lttng_sessiond | |
143 | unset LTTNG_UST_CLOCK_PLUGIN | |
144 | ||
1b59ae1f | 145 | create_lttng_session_ok $SESSION_NAME "$TRACE_PATH" |
199800b2 JR |
146 | enable_ust_lttng_event_ok $SESSION_NAME "$EVENT_NAME" |
147 | start_lttng_tracing_ok $SESSION_NAME | |
148 | run_app | |
149 | stop_lttng_tracing_ok $SESSION_NAME | |
150 | destroy_lttng_session_ok $SESSION_NAME | |
151 | stop_lttng_sessiond | |
152 | ||
1b59ae1f JR |
153 | metadata_file="$(find "$TRACE_PATH" -name metadata -type f)" |
154 | metadata_directory_path="$(dirname "$metadata_file")" | |
199800b2 | 155 | |
1b59ae1f JR |
156 | if [ "$TRACE_FORMAT_OUTPUT" == "ctf1" ]; then |
157 | validate_tokens_ctf1 "$metadata_directory_path" | |
158 | elif [ "$TRACE_FORMAT_OUTPUT" == "ctf2" ]; then | |
159 | validate_tokens_ctf2 "$metadata_file" | |
160 | fi | |
199800b2 JR |
161 | } |
162 | ||
163 | function test_getcpu_override_timestamp() | |
164 | { | |
165 | diag "Clock override test" | |
166 | ||
167 | # Test without the plugin | |
168 | diag "Plugin disabled" | |
169 | start_lttng_sessiond | |
170 | create_lttng_session_ok $SESSION_NAME $TRACE_PATH | |
171 | enable_ust_lttng_event_ok $SESSION_NAME "$EVENT_NAME" | |
172 | start_lttng_tracing_ok $SESSION_NAME | |
173 | run_app | |
174 | stop_lttng_tracing_ok $SESSION_NAME | |
175 | destroy_lttng_session_ok $SESSION_NAME | |
176 | ||
177 | # Use Babeltrace with "-n all" to give a comma separated list for | |
178 | # easy extraction of timestamps. | |
179 | unique_timestamps_count=$($BABELTRACE_BIN -n all $TRACE_PATH | \ | |
180 | cut -d, -f1 | uniq | wc -l) | |
181 | test $unique_timestamps_count -gt 1 | |
182 | ok $? "Unique event timestamps without clock override: $unique_timestamps_count expect >1" | |
183 | stop_lttng_sessiond | |
184 | ||
185 | # Test with clock override plugin. | |
186 | # LTTNG_UST_CLOCK_PLUGIN need to be defined for both lttng-sessiond. | |
187 | diag "Plugin enabled" | |
188 | export LTTNG_UST_CLOCK_PLUGIN=$CURDIR/.libs/$LTTNG_UST_CLOCK_PLUGIN_SO | |
189 | start_lttng_sessiond | |
199800b2 JR |
190 | create_lttng_session_ok $SESSION_NAME $TRACE_PATH |
191 | enable_ust_lttng_event_ok $SESSION_NAME "$EVENT_NAME" | |
192 | start_lttng_tracing_ok $SESSION_NAME | |
193 | run_app | |
1df1febe | 194 | unset LTTNG_UST_CLOCK_PLUGIN |
199800b2 JR |
195 | stop_lttng_tracing_ok $SESSION_NAME |
196 | destroy_lttng_session_ok $SESSION_NAME | |
197 | stop_lttng_sessiond | |
198 | ||
199 | # Use Babeltrace with "-n all" to give a comma separated list for | |
200 | # easy extraction of timestamps. | |
201 | unique_timestamps_count=$($BABELTRACE_BIN -n all $TRACE_PATH | \ | |
202 | cut -d, -f1 | uniq | wc -l) | |
203 | test $unique_timestamps_count -eq 1 | |
204 | ok $? "Unique event timestamps with clock override: $unique_timestamps_count expect 1" | |
205 | } | |
206 | ||
207 | plan_tests $NUM_TESTS | |
208 | ||
209 | print_test_banner "$TEST_DESC" | |
210 | ||
f37e092d MD |
211 | if [ -x "$CURDIR/$LIBS_DIR/$LTTNG_UST_CLOCK_PLUGIN_SO" ]; then |
212 | foundobj=1 | |
213 | else | |
214 | foundobj=0 | |
215 | fi | |
216 | ||
217 | skip $foundobj "No shared object generated. Skipping all tests." $NUM_TESTS && exit 0 | |
218 | ||
199800b2 JR |
219 | TESTS=( |
220 | "test_getcpu_override_metadata" | |
221 | "test_getcpu_override_timestamp" | |
222 | ) | |
223 | ||
224 | TEST_COUNT=${#TESTS[@]} | |
225 | i=0 | |
226 | ||
227 | while [ "$i" -lt "$TEST_COUNT" ]; do | |
228 | ||
33e55711 | 229 | TRACE_PATH=$(mktemp --tmpdir -d tmp.test_clock_override_ust_trace_path.XXXXXX) |
199800b2 JR |
230 | |
231 | # Execute test | |
232 | ${TESTS[$i]} | |
233 | ||
234 | rm -rf $TRACE_PATH | |
235 | ||
236 | let "i++" | |
237 | done | |
238 |