3 # Copyright (C) 2013 Christian Babeux <christian.babeux@efficios.com>
4 # Copyright (C) 2014, 2016 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
6 # SPDX-License-Identifier: GPL-2.0-only
9 TEST_DESC
="Kernel tracer - Clock override plugin"
11 CURDIR
=$
(dirname "$0")/
13 SESSION_NAME
="clock_override"
16 EVENT_NAME
="lttng_test_filter_event"
18 TESTCMD
="echo -n 10 > /proc/lttng-test-filter-event"
20 source $TESTDIR/utils
/utils.sh
22 if [ "$TRACE_FORMAT_OUTPUT" == "ctf1" ]; then
24 elif [ "$TRACE_FORMAT_OUTPUT" == "ctf2" ]; then
28 function signal_cleanup
()
30 diag
"*** Exiting ***"
32 modprobe
--remove lttng-test lttng-clock-plugin-test lttng-clock
36 function extract_clock_metadata_ctf1
()
38 local metadata_clock_start_token
="clock {"
39 local metadata_clock_end_token
="};"
41 local metadata_file
=$1
42 local clock_metadata_file_destination
=$2
44 sed -n "/$metadata_clock_start_token/,/$metadata_clock_end_token/p" "$metadata_file" > "$clock_metadata_file_destination"
45 ok $?
"Clock metadata extraction"
48 function extract_clock_metadata_token_ctf1
()
50 local clock_metadata_file
=$1
52 # Look for token and get value between ""
53 grep "$token" "$clock_metadata_file" |
awk -F"= |;" '{print $2}' |
tr -d '"'
56 function validate_tokens_ctf1
59 local metadata_token_list
=(
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"
73 local metadata_directory_path
=$1
74 local ctf_metadata_file
75 local clock_metadata_file
77 test ${#metadata_token_list[@]} -eq ${#ust_clock_token_value[@]}
78 ok $?
"Tokens to check(${#metadata_token_list[@]}) and provided values(${#ust_clock_token_value[@]}) count is equal"
81 clock_metadata_file
=$
(mktemp
--tmpdir -p "$TRACE_PATH" clock-metadata.XXXXXX
)
82 ctf_metadata_file
=$
(mktemp
--tmpdir -p "$TRACE_PATH" ctf-metadata.XXXXXX
)
84 $BABELTRACE_BIN -o ctf-metadata
-w "$ctf_metadata_file" "$metadata_directory_path"
85 ok $?
"Metadata extraction from babeltrace"
87 extract_clock_metadata_ctf1
"$ctf_metadata_file" "$clock_metadata_file"
90 while [ "$counter" -lt "${#metadata_token_list[@]}" ]; do
91 result
=$
(extract_clock_metadata_token_ctf1
"$clock_metadata_file" \
92 "${metadata_token_list[$counter]}")
93 test "$result" == "${ust_clock_token_value[$counter]}"
94 ok $?
"Token \"${metadata_token_list[$counter]}\" expect:${ust_clock_token_value[$counter]} got:$result"
98 rm -rf "$ctf_metadata_file"
99 rm -rf "$clock_metadata_file"
102 function validate_tokens_ctf2
104 local metadata_token_list
=(
111 local ust_clock_token_value
=(
112 "lttng_test_clock_override"
113 "[131,198,61,235,122,164,72,251,171,218,148,111,64,13,118,230]"
114 "Freeze time with 1KHz for regression test"
118 test ${#metadata_token_list[@]} -eq ${#ust_clock_token_value[@]}
119 ok $?
"Tokens to check(${#metadata_token_list[@]}) and provided values(${#ust_clock_token_value[@]}) count is equal"
121 local metadata_path
=$1
124 while [ "$counter" -lt "${#metadata_token_list[@]}" ]; do
125 result
=$
(jq
-c -r "select(.type == \"clock-class\").${metadata_token_list[$counter]}" "$metadata_path")
126 test "$result" == "${ust_clock_token_value[$counter]}"
127 ok $?
"Token \"${metadata_token_list[$counter]}\" expect:${ust_clock_token_value[$counter]} got:$result"
133 function test_clock_override_metadata
()
135 local trace_metadata_file_path
136 local trace_metadata_dir
138 diag
"Clock override plugin metadata test"
140 modprobe lttng-clock-plugin-test
144 create_lttng_session_ok
$SESSION_NAME "$TRACE_PATH"
145 enable_kernel_lttng_event_ok
$SESSION_NAME "$EVENT_NAME"
146 start_lttng_tracing_ok
$SESSION_NAME
148 stop_lttng_tracing_ok
$SESSION_NAME
149 destroy_lttng_session_ok
$SESSION_NAME
152 modprobe
--remove lttng-test lttng-clock-plugin-test lttng-clock
154 trace_metadata_file_path
="$(find "$TRACE_PATH" -name metadata -type f)"
155 trace_metadata_dir
="$(dirname "$trace_metadata_file_path")"
157 if [ "$TRACE_FORMAT_OUTPUT" == "ctf1" ]; then
158 validate_tokens_ctf1
"$trace_metadata_dir"
159 elif [ "$TRACE_FORMAT_OUTPUT" == "ctf2" ]; then
160 validate_tokens_ctf2
"$trace_metadata_file_path"
164 function test_clock_override_timestamp
()
166 diag
"Clock override test"
168 # Test without the plugin
169 diag
"Plugin disabled"
174 create_lttng_session_ok
$SESSION_NAME "$TRACE_PATH"
175 enable_kernel_lttng_event_ok
$SESSION_NAME "$EVENT_NAME"
176 start_lttng_tracing_ok
$SESSION_NAME
178 stop_lttng_tracing_ok
$SESSION_NAME
179 destroy_lttng_session_ok
$SESSION_NAME
181 # Use Babeltrace with "-n all" to give a comma separated list for
182 # easy extraction of timestamps.
183 unique_timestamps_count
=$
($BABELTRACE_BIN -n all
"$TRACE_PATH" | \
184 cut
-d, -f1 |
uniq |
wc -l)
185 test "$unique_timestamps_count" -gt 1
186 ok $?
"Unique event timestamps without clock override: $unique_timestamps_count expect >1"
187 modprobe
--remove lttng-test
190 # Test with clock override plugin.
191 diag
"Plugin enabled"
193 modprobe lttng-clock-plugin-test
198 create_lttng_session_ok
$SESSION_NAME "$TRACE_PATH"
199 enable_kernel_lttng_event_ok
$SESSION_NAME "$EVENT_NAME"
200 start_lttng_tracing_ok
$SESSION_NAME
202 stop_lttng_tracing_ok
$SESSION_NAME
203 destroy_lttng_session_ok
$SESSION_NAME
206 modprobe
--remove lttng-test lttng-clock-plugin-test lttng-clock
208 # Use Babeltrace with "-n all" to give a comma separated list for
209 # easy extraction of timestamps.
210 unique_timestamps_count
=$
($BABELTRACE_BIN -n all
"$TRACE_PATH" | \
211 cut
-d, -f1 |
uniq |
wc -l)
212 test "$unique_timestamps_count" -eq 1
213 ok $?
"Unique event timestamps with clock override: $unique_timestamps_count expect 1"
216 # MUST set TESTDIR before calling those functions
217 plan_tests
$NUM_TESTS
219 print_test_banner
"$TEST_DESC"
221 bail_out_if_no_babeltrace
224 "test_clock_override_metadata"
225 "test_clock_override_timestamp"
228 TEST_COUNT
=${#TESTS[@]}
231 if [ "$(id -u)" == "0" ]; then
237 skip
$isroot "Root access is needed. Skipping all tests." $NUM_TESTS ||
239 validate_lttng_modules_present
240 trap signal_cleanup SIGTERM SIGINT
242 while [ "$i" -lt "$TEST_COUNT" ]; do
244 TRACE_PATH
=$
(mktemp
--tmpdir -d tmp.test_clock_override_trace_path.XXXXXX
)