3 # Copyright (C) 2019 Jonathan Rajotte <jonathan.rajotte-julien@efficios.com>
5 # SPDX-License-Identifier: LGPL-2.1-only
7 TEST_DESC
="Metadata env - User space tracing"
9 CURDIR
=$
(dirname "$0")/
10 TESTDIR
=$CURDIR/..
/..
/..
11 TESTAPP_PATH
="$TESTDIR/utils/testapp"
12 TESTAPP_NAME
="gen-ust-events"
13 TESTAPP_BIN
="$TESTAPP_PATH/$TESTAPP_NAME/$TESTAPP_NAME"
14 EVENT_NAME
="tp:tptest"
16 TRACE_PATH
=$
(mktemp
--tmpdir -d tmp.test_metadata_env_ust_trace_path.XXXXXX
)
23 source "$TESTDIR/utils/utils.sh"
25 # Fetch utils functions common to ust and kernel tests.
26 source "$CURDIR/utils.sh"
28 if [ ! -x "$TESTAPP_BIN" ]; then
29 BAIL_OUT
"No UST events binary detected."
32 function test_per_uid
()
39 local expected_path
="${TRACE_PATH}/lttng-traces"
40 local session_name
="per-uid"
41 metadata_env
=$
(mktemp
--tmpdir tmp.test_
${FUNCNAME[0]}_metadata_env.XXXXXX
)
43 diag
"Test UST metadata env field in per-uid mode"
44 create_lttng_session_ok
"$session_name"
45 enable_ust_lttng_event_ok
"$session_name" $EVENT_NAME
46 start_lttng_tracing_ok
"$session_name"
48 $TESTAPP_BIN -i $NR_ITER
50 stop_lttng_tracing_ok
"$session_name"
51 destroy_lttng_session_ok
"$session_name"
53 # bt1 accepts only a directory while bt2 accepts either the metadata
54 # file directly or a directory with an immediate metadata file.
55 # Settle for the common denominator.
56 metadata_path
=$
(find "${expected_path}/${session_name}"* -name "metadata")
57 metadata_path
=$
(dirname "$metadata_path")
59 extract_env_to_file
"$metadata_path" "$metadata_env"
61 # Construct the expected path from the env metadata and use it to
62 # validate that all information make sense. This information is present
63 # to allow trace viewer to recreate the same directory hierarchy.
66 value
=$
(get_env_value
"$metadata_env" trace_name
)
67 ok $?
"Extracting trace_name from env metadata"
68 expected_path
="${expected_path}/${value}"
70 # Session creation time
71 value
=$
(get_env_value
"$metadata_env" trace_creation_datetime
)
72 ok $?
"Extracting trace_creation_datetime from env metadata"
73 value
=$
(iso8601_to_lttng_dir_datetime
"$value")
74 expected_path
="${expected_path}-${value}"
77 value
=$
(get_env_value
"$metadata_env" domain
)
78 ok $?
"Extracting domain from env metadata"
79 expected_path
="${expected_path}/${value}"
82 value
=$
(get_env_value
"$metadata_env" tracer_buffering_scheme
)
83 ok $?
"Extracting tracer_buffering_scheme from env metadata"
84 expected_path
="${expected_path}/${value}"
87 value
=$
(get_env_value
"$metadata_env" tracer_buffering_id
)
88 ok $?
"Extracting tracer_buffering_id from env metadata"
89 expected_path
="${expected_path}/${value}"
91 # Check that the uid is the one we expect from the current user
92 is
"$value" "$(id -u)" "tracer_buffering_id match current user uid"
94 # Architecture_bit_width
95 value
=$
(get_env_value
"$metadata_env" architecture_bit_width
)
96 ok $?
"Extracting architecture_bit_width from env metadata"
97 expected_path
="${expected_path}/${value}-bit"
99 # Append "metadata" and test that we find the file.
100 expected_path
="${expected_path}/metadata"
102 test -e "$expected_path"
103 ok $?
"Reconstructed path from metadata is valid"
106 # The hostname is not part of the lttng hierarchy still we can test for
108 value
=$
(get_env_value
"$metadata_env" hostname
)
109 ok $?
"Extracting hostname from env metadata"
110 is
"$value" "$(hostname)" "Hostname is valid"
112 rm -f "$metadata_env"
115 function test_per_pid
()
122 local expected_path
="${TRACE_PATH}/lttng-traces"
123 local session_name
="per-pid"
126 metadata_env
=$
(mktemp
--tmpdir "tmp.test_${FUNCNAME[0]}_metadata_env.XXXXXX")
128 diag
"Test UST metadata env field in per-pid mode"
129 create_lttng_session_ok
"$session_name"
130 enable_ust_lttng_channel_ok
"$session_name" channel
"--buffers-pid"
131 enable_ust_lttng_event_ok
"$session_name" $EVENT_NAME channel
132 start_lttng_tracing_ok
"$session_name"
134 $TESTAPP_BIN -i $NR_ITER -w $NR_USEC_WAIT &
138 stop_lttng_tracing_ok
"$session_name"
139 destroy_lttng_session_ok
"$session_name"
141 # bt1 accepts only a directory while bt2 accepts either the metadata
142 # file directly or a directory with an immediate metadata file.
143 # Settle for the common denominator.
144 metadata_path
=$
(find "${expected_path}/${session_name}"* -name "metadata")
145 metadata_path
=$
(dirname "$metadata_path")
147 extract_env_to_file
"$metadata_path" "$metadata_env"
149 # Construct the expected path from the env metadata and use it to
150 # validate that all information make sense. This information is present
151 # to allow trace viewer to recreate the same directory hierarchy.
154 value
=$
(get_env_value
"$metadata_env" trace_name
)
155 ok $?
"Extracting trace_name from env metadata"
156 expected_path
="${expected_path}/${value}"
158 # Session creation time
159 value
=$
(get_env_value
"$metadata_env" trace_creation_datetime
)
160 ok $?
"Extracting trace_creation_datetime from env metadata"
161 value
=$
(iso8601_to_lttng_dir_datetime
"$value")
162 expected_path
="${expected_path}-${value}"
165 value
=$
(get_env_value
"$metadata_env" domain
)
166 ok $?
"Extracting domain from env metadata"
167 expected_path
="${expected_path}/${value}"
170 value
=$
(get_env_value
"$metadata_env" tracer_buffering_scheme
)
171 ok $?
"Extracting tracer_buffering_scheme from env metadata"
172 expected_path
="${expected_path}/${value}"
175 value
=$
(get_env_value
"$metadata_env" procname
)
176 ok $?
"Extracting procname from env metadata"
177 expected_path
="${expected_path}/${value}"
179 # vpid and tracer_buffering_id should be the same here.
180 # "vpid =" is used since other key have vpid in them.
181 value
=$
(get_env_value
"$metadata_env" "vpid =")
182 ok $?
"Extracting vpid from env metadata"
184 value2
=$
(get_env_value
"$metadata_env" tracer_buffering_id
)
185 ok $?
"Extracting tracer_buffering_id from env metadata"
186 expected_path
="${expected_path}-${value2}"
188 is
"$value" "$value2" "vpid and tracer_buffering_id are identical"
189 is
"$testapp_pid" "$value" "vpid and known testapp pid are identical"
190 is
"$testapp_pid" "$value2" "tracer_buffering_id and known testapp pid are identical"
193 value
=$
(get_env_value
"$metadata_env" vpid_datetime
)
194 ok $?
"Extracting vpid_datetime from env metadata"
195 value
=$
(iso8601_to_lttng_dir_datetime
"$value")
196 expected_path
="${expected_path}-${value}"
198 # Append "metadata" and test that we find the file.
199 expected_path
="${expected_path}/metadata"
201 test -e "$expected_path"
202 ok $?
"Reconstructed path from metadata is valid"
205 # The hostname is not part of the lttng hierarchy still we can test for
207 value
=$
(get_env_value
"$metadata_env" hostname
)
208 ok $?
"Extracting hostname from env metadata"
209 is
"$value" "$(hostname)" "Hostname is valid"
211 rm -f "$metadata_env"
214 plan_tests
$NUM_TESTS
216 print_test_banner
"$TEST_DESC"
218 bail_out_if_no_babeltrace
220 # Use LTTNG_HOME since we want the complete "default" lttng directory hierarchy
221 # with "<session_name>-<datetime>/...".
222 LTTNG_HOME
="$TRACE_PATH"
227 tests
=( test_per_uid test_per_pid
)
229 for fct_test
in "${tests[@]}";