3 # Copyright (C) - 2013 Julien Desfossez <jdesfossez@efficios.com>
5 # This library is free software; you can redistribute it and/or modify it under
6 # the terms of the GNU Lesser General Public License as published by the Free
7 # Software Foundation; version 2.1 of the License.
9 # This library is distributed in the hope that it will be useful, but WITHOUT
10 # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
11 # FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
14 # You should have received a copy of the GNU Lesser General Public License
15 # along with this library; if not, write to the Free Software Foundation, Inc.,
16 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17 TEST_DESC
="Snapshots - UST tracing"
20 TESTDIR
=$CURDIR/..
/..
/..
21 EVENT_NAME
="tp:tptest"
24 CHANNEL_NAME
="snapchan"
25 TESTAPP_PATH
="$TESTDIR/utils/testapp"
26 TESTAPP_NAME
="gen-ust-events"
27 TESTAPP_BIN
="$TESTAPP_PATH/$TESTAPP_NAME/$TESTAPP_NAME"
34 TRACE_PATH
=$
(mktemp
-d)
36 source $TESTDIR/utils
/utils.sh
38 if [ ! -x "$TESTAPP_BIN" ]; then
39 BAIL_OUT
"No UST events binary detected."
42 # Need the number of snapshot to do.
44 BAIL_OUT
"A number of snapshot is needed."
48 NUM_TESTS
=$
(($NUM_TESTS + ($NR_SNAPSHOT * 2)))
50 function start_test_app
()
52 local tmp_file
="/tmp/lttng_test_ust.42.file"
54 # Start application with a temporary file.
55 $TESTAPP_BIN $NR_ITER $NR_USEC_WAIT $tmp_file &
57 APPS_PID
="${APPS_PID} ${!}"
58 ok
$ret "Start application to trace"
60 # Wait for the application file to appear indicating that at least one
61 # tracepoint has been fired.
62 while [ ! -f "$tmp_file" ]; do
65 diag
"Removing test app temporary file $tmp_file"
69 function stop_test_apps
()
71 diag
"Stopping $TESTAPP_NAME"
72 for p
in ${APPS_PID}; do
78 function snapshot_add_output
()
86 if [ ! -z $name ]; then
87 extra_opt
+=" -n $name "
90 if [ ! -z $max_size ]; then
91 extra_opt
+=" -m $max_size "
94 $TESTDIR/..
/src
/bin
/lttng
/$LTTNG_BIN snapshot add-output \
95 -s $sess_name $extra_opt $trace_path > /dev
/null
2>&1
97 ok $?
"Added snapshot output $trace_path ($extra_opt)"
100 function snapshot_del_output
()
105 $TESTDIR/..
/src
/bin
/lttng
/$LTTNG_BIN snapshot del-output \
106 -s $sess_name $name > /dev
/null
2>&1
108 ok $?
"Deleted snapshot output named $name"
111 function enable_mmap_overwrite_subbuf_ust_channel
()
117 $TESTDIR/..
/src
/bin
/lttng
/$LTTNG_BIN enable-channel
-s $sess_name \
118 $chan_name -u --output mmap
--overwrite \
119 --subbuf-size $subbuf_size > /dev
/null
2>&1
121 ok $?
"Enable channel $channel_name for session $sess_name with subbuf size $subbuf_size"
125 function test_ust_list_output
()
127 output_names
=("randomname" "somesnapshot")
129 diag
"Test UST snapshot output listing"
130 create_lttng_session_no_output
$SESSION_NAME
131 enable_lttng_mmap_overwrite_ust_channel
$SESSION_NAME $CHANNEL_NAME
132 enable_ust_lttng_event
$SESSION_NAME $EVENT_NAME $CHANNEL_NAME
134 start_lttng_tracing
$SESSION_NAME
136 snapshot_add_output
$SESSION_NAME "file://$TRACE_PATH" ${output_names[0]}
138 $TESTDIR/..
/src
/bin
/lttng
/$LTTNG_BIN snapshot list-output \
139 -s $SESSION_NAME 2>&1 |
grep ${output_names[0]} > /dev
/null
140 ok $?
"Snapshot named ${output_names[0]} present in list-output listing"
142 snapshot_del_output
$SESSION_NAME ${output_names[0]}
144 snapshot_add_output
$SESSION_NAME "file://$TRACE_PATH" ${output_names[1]}
146 $TESTDIR/..
/src
/bin
/lttng
/$LTTNG_BIN snapshot list-output \
147 -s $SESSION_NAME 2>&1 |
grep ${output_names[1]} > /dev
/null
149 ok $?
"Snapshot named ${output_names[1]} present in list-output listing"
151 stop_lttng_tracing
$SESSION_NAME
152 destroy_lttng_session
$SESSION_NAME
155 function test_ust_local_snapshot
()
157 diag
"Test local UST snapshots"
158 create_lttng_session_no_output
$SESSION_NAME
159 enable_lttng_mmap_overwrite_ust_channel
$SESSION_NAME $CHANNEL_NAME
160 enable_ust_lttng_event
$SESSION_NAME $EVENT_NAME $CHANNEL_NAME
161 start_lttng_tracing
$SESSION_NAME
162 lttng_snapshot_add_output
$SESSION_NAME $TRACE_PATH
164 # Returns once the application has at least fired ONE tracepoint.
167 lttng_snapshot_record
$SESSION_NAME
168 stop_lttng_tracing
$SESSION_NAME
169 destroy_lttng_session
$SESSION_NAME
172 validate_trace
$EVENT_NAME $TRACE_PATH/
173 if [ $?
-eq 0 ]; then
174 # Only delete if successful
181 function test_ust_local_snapshot_max_size
()
186 # The minimum size limit is min(subbuf_size) * nb_streams
187 max_size
=$
(($subbuf_size*$num_cpus))
189 diag
"Test local UST snapshots with max size $max_size"
190 create_lttng_session_no_output
$SESSION_NAME
192 enable_mmap_overwrite_subbuf_ust_channel
$SESSION_NAME $CHANNEL_NAME $subbuf_size
194 enable_ust_lttng_event
$SESSION_NAME $EVENT_NAME $CHANNEL_NAME
195 start_lttng_tracing
$SESSION_NAME
197 snapshot_add_output
$SESSION_NAME "file://$TRACE_PATH" "" $max_size
199 # Returns once the application has at least fired ONE tracepoint.
202 lttng_snapshot_record
$SESSION_NAME
205 sum_size_tracefiles
=$
(find $TRACE_PATH -name "${CHANNEL_NAME}_*" \
206 -exec stat
-c '%s' {} \
; |
awk '{s = s + $1}END{print s}')
208 if [ "$sum_size_tracefiles" -gt "$max_size" ]; then
209 fail
"Tracefiles size sum validation"
210 diag
"Tracefiles size sum: $sum_size_tracefiles Expected max: $max_size"
213 pass
"Tracefiles size sum validation"
215 stop_lttng_tracing
$SESSION_NAME
216 destroy_lttng_session
$SESSION_NAME
219 validate_trace
$EVENT_NAME $TRACE_PATH/
221 if [ $?
-eq 0 ]; then
222 # Only delete if successful
229 function test_ust_local_snapshot_large_metadata
()
231 LM_EVENT
="tp:tptest1,tp:tptest2,tp:tptest3,tp:tptest4,tp:tptest5"
232 LM_PATH
="$TESTDIR/utils/testapp"
233 LM_NAME
="gen-ust-nevents"
234 LM_BIN
="$LM_PATH/$LM_NAME/$LM_NAME"
236 diag
"Test local UST snapshots with > 4kB metadata"
237 create_lttng_session_no_output
$SESSION_NAME
238 enable_lttng_mmap_overwrite_ust_channel
$SESSION_NAME $CHANNEL_NAME
239 enable_ust_lttng_event
$SESSION_NAME $LM_EVENT $CHANNEL_NAME
240 start_lttng_tracing
$SESSION_NAME
241 lttng_snapshot_add_output
$SESSION_NAME $TRACE_PATH
243 ok $?
"Start application to trace"
244 lttng_snapshot_record
$SESSION_NAME
245 stop_lttng_tracing
$SESSION_NAME
246 destroy_lttng_session
$SESSION_NAME
249 validate_trace
$LM_EVENT $TRACE_PATH/
250 if [ $?
-eq 0 ]; then
251 # Only delete if successful
256 function enable_channel_per_uid_mmap_overwrite
()
261 $TESTDIR/..
/src
/bin
/lttng
/$LTTNG_BIN enable-channel
--buffers-uid -u $channel_name -s $sess_name --output mmap
--overwrite >/dev
/null
2>&1
262 ok $?
"Enable channel $channel_name per UID for session $sess_name"
265 function test_ust_per_uid_local_snapshot
()
267 diag
"Test local UST snapshots"
268 create_lttng_session_no_output
$SESSION_NAME
269 enable_channel_per_uid_mmap_overwrite
$SESSION_NAME $CHANNEL_NAME
270 enable_ust_lttng_event
$SESSION_NAME $EVENT_NAME $CHANNEL_NAME
271 start_lttng_tracing
$SESSION_NAME
272 lttng_snapshot_add_output
$SESSION_NAME $TRACE_PATH
274 # Returns once the application has at least fired ONE tracepoint.
277 lttng_snapshot_record
$SESSION_NAME
278 stop_lttng_tracing
$SESSION_NAME
279 destroy_lttng_session
$SESSION_NAME
282 validate_trace
$EVENT_NAME $TRACE_PATH/
283 if [ $?
-eq 0 ]; then
284 # Only delete if successful
291 function test_ust_per_uid_local_snapshot_post_mortem
()
293 diag
"Test local UST snapshots post-mortem"
294 create_lttng_session_no_output
$SESSION_NAME
295 enable_channel_per_uid_mmap_overwrite
$SESSION_NAME $CHANNEL_NAME
296 enable_ust_lttng_event
$SESSION_NAME $EVENT_NAME $CHANNEL_NAME
297 start_lttng_tracing
$SESSION_NAME
298 lttng_snapshot_add_output
$SESSION_NAME $TRACE_PATH
300 # Returns once the application has at least fired ONE tracepoint.
304 lttng_snapshot_record
$SESSION_NAME
305 stop_lttng_tracing
$SESSION_NAME
306 destroy_lttng_session
$SESSION_NAME
309 validate_trace
$EVENT_NAME $TRACE_PATH/
310 if [ $?
-eq 0 ]; then
311 # Only delete if successful
316 function test_ust_local_snapshots
()
318 diag
"Test $NR_SNAPSHOT local UST snapshots"
319 create_lttng_session_no_output
$SESSION_NAME
320 enable_lttng_mmap_overwrite_ust_channel
$SESSION_NAME $CHANNEL_NAME
321 enable_ust_lttng_event
$SESSION_NAME $EVENT_NAME $CHANNEL_NAME
322 start_lttng_tracing
$SESSION_NAME
323 lttng_snapshot_add_output
$SESSION_NAME $TRACE_PATH
325 # Returns once the application has at least fired ONE tracepoint.
328 for i
in $
(seq 1 $NR_SNAPSHOT); do
329 diag
"Snapshot $i/$NR_SNAPSHOT"
330 rm -rf $TRACE_PATH/snapshot
/* 2>/dev
/null
331 lttng_snapshot_record
$SESSION_NAME
333 validate_trace
$EVENT_NAME $TRACE_PATH/
334 if [ $?
-eq 0 ]; then
335 # Only delete if successful
339 stop_lttng_tracing
$SESSION_NAME
340 destroy_lttng_session
$SESSION_NAME
345 plan_tests
$NUM_TESTS
347 print_test_banner
"$TEST_DESC"
351 tests
=( test_ust_list_output
352 test_ust_local_snapshot
353 test_ust_local_snapshot_max_size
354 test_ust_per_uid_local_snapshot
355 test_ust_per_uid_local_snapshot_post_mortem
356 test_ust_local_snapshot_large_metadata
357 test_ust_local_snapshots
)
359 for fct_test
in ${tests[@]};
361 SESSION_NAME
=$
(randstring
16 0)