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"
32 TRACE_PATH
=$
(mktemp
-d)
34 source $TESTDIR/utils
/utils.sh
36 if [ ! -x "$TESTAPP_BIN" ]; then
37 BAIL_OUT
"No UST events binary detected."
40 # Need the number of snapshot to do.
42 BAIL_OUT
"A number of snapshot is needed."
46 NUM_TESTS
=$
(($NUM_TESTS + ($NR_SNAPSHOT * 2)))
48 function start_test_app
()
50 local tmp_file
=$
(mktemp
-u)
52 # Start application with a temporary file.
53 $TESTAPP_BIN $NR_ITER $NR_USEC_WAIT $tmp_file &
55 APPS_PID
="${APPS_PID} ${!}"
56 ok
$ret "Start application to trace"
58 # Wait for the application file to appear indicating that at least one
59 # tracepoint has been fired.
60 while [ ! -f "$tmp_file" ]; do
63 diag
"Removing test app temporary file $tmp_file"
67 function wait_test_apps
()
69 diag
"Waiting for $TESTAPP_NAME"
70 for p
in ${APPS_PID}; do
75 function stop_test_apps
()
77 diag
"Stopping $TESTAPP_NAME"
78 for p
in ${APPS_PID}; do
85 function snapshot_add_output
()
93 if [ ! -z $name ]; then
94 extra_opt
+=" -n $name "
97 if [ ! -z $max_size ]; then
98 extra_opt
+=" -m $max_size "
101 $TESTDIR/..
/src
/bin
/lttng
/$LTTNG_BIN snapshot add-output \
102 -s $sess_name $extra_opt $trace_path > /dev
/null
2>&1
104 ok $?
"Added snapshot output $trace_path ($extra_opt)"
107 function snapshot_del_output
()
112 $TESTDIR/..
/src
/bin
/lttng
/$LTTNG_BIN snapshot del-output \
113 -s $sess_name $name > /dev
/null
2>&1
115 ok $?
"Deleted snapshot output named $name"
118 function enable_mmap_overwrite_subbuf_ust_channel
()
124 $TESTDIR/..
/src
/bin
/lttng
/$LTTNG_BIN enable-channel
-s $sess_name \
125 $chan_name -u --output mmap
--overwrite \
126 --subbuf-size $subbuf_size > /dev
/null
2>&1
128 ok $?
"Enable channel $channel_name for session $sess_name with subbuf size $subbuf_size"
131 function enable_mmap_small_discard_ust_channel
()
136 $TESTDIR/..
/src
/bin
/lttng
/$LTTNG_BIN enable-channel
-s $sess_name \
137 $chan_name -u --output mmap
--discard \
138 --subbuf-size $
(getconf PAGE_SIZE
) --num-subbuf 2 \
141 ok $?
"Enable channel $channel_name for session $sess_name with small discard buffers"
144 function enable_mmap_small_overwrite_ust_channel
()
149 $TESTDIR/..
/src
/bin
/lttng
/$LTTNG_BIN enable-channel
-s $sess_name \
150 $chan_name -u --output mmap
--overwrite \
151 --subbuf-size $
(getconf PAGE_SIZE
) --num-subbuf 2 \
154 ok $?
"Enable channel $channel_name for session $sess_name with small discard buffers"
157 function test_ust_list_output
()
159 output_names
=("randomname" "somesnapshot")
161 diag
"Test UST snapshot output listing"
162 create_lttng_session_no_output
$SESSION_NAME
163 enable_lttng_mmap_overwrite_ust_channel
$SESSION_NAME $CHANNEL_NAME
164 enable_ust_lttng_event_ok
$SESSION_NAME $EVENT_NAME $CHANNEL_NAME
166 start_lttng_tracing_ok
$SESSION_NAME
168 snapshot_add_output
$SESSION_NAME "file://$TRACE_PATH" ${output_names[0]}
170 $TESTDIR/..
/src
/bin
/lttng
/$LTTNG_BIN snapshot list-output \
171 -s $SESSION_NAME 2>&1 |
grep ${output_names[0]} > /dev
/null
172 ok $?
"Snapshot named ${output_names[0]} present in list-output listing"
174 snapshot_del_output
$SESSION_NAME ${output_names[0]}
176 snapshot_add_output
$SESSION_NAME "file://$TRACE_PATH" ${output_names[1]}
178 $TESTDIR/..
/src
/bin
/lttng
/$LTTNG_BIN snapshot list-output \
179 -s $SESSION_NAME 2>&1 |
grep ${output_names[1]} > /dev
/null
181 ok $?
"Snapshot named ${output_names[1]} present in list-output listing"
183 stop_lttng_tracing_ok
$SESSION_NAME
184 destroy_lttng_session_ok
$SESSION_NAME
187 function test_ust_local_snapshot
()
192 diag
"Test local UST snapshots"
193 create_lttng_session_no_output
$SESSION_NAME
194 enable_lttng_mmap_overwrite_ust_channel
$SESSION_NAME $CHANNEL_NAME
195 enable_ust_lttng_event_ok
$SESSION_NAME $EVENT_NAME $CHANNEL_NAME
196 start_lttng_tracing_ok
$SESSION_NAME
197 lttng_snapshot_add_output_ok
$SESSION_NAME $TRACE_PATH
199 # Returns once the application has at least fired ONE tracepoint.
202 lttng_snapshot_record
$SESSION_NAME
203 stop_lttng_tracing_ok
$SESSION_NAME
204 destroy_lttng_session_ok
$SESSION_NAME
207 validate_trace
$EVENT_NAME $TRACE_PATH/
208 if [ $?
-eq 0 ]; then
209 # Only delete if successful
216 function test_ust_local_snapshot_small_discard_buffers
()
220 OLDCPUSET
=$
(taskset
-p $$
)
222 diag
"Test local UST snapshots with small discard buffers"
223 taskset
-p 0x1 $$
1>/dev
/null
2>&1 # CPU 0 only
224 create_lttng_session_no_output
$SESSION_NAME
225 enable_mmap_small_discard_ust_channel
$SESSION_NAME $CHANNEL_NAME
226 enable_ust_lttng_event_ok
$SESSION_NAME $EVENT_NAME $CHANNEL_NAME
227 start_lttng_tracing_ok
$SESSION_NAME
228 lttng_snapshot_add_output_ok
$SESSION_NAME $TRACE_PATH
230 # Run test apps, wait for them to complete.
234 # Take first snapshot, remember first line.
235 lttng_snapshot_record
$SESSION_NAME
236 FIRST_LINE
="$(trace_first_line $TRACE_PATH/)"
237 diag
"First line (1st snapshot): $FIRST_LINE"
240 # Run test apps, wait for them to complete.
244 # Take second snapshot, remember first line.
245 lttng_snapshot_record
$SESSION_NAME
246 FIRST_LINE_2
="$(trace_first_line $TRACE_PATH/)"
247 diag
"First line (2nd snapshot): $FIRST_LINE_2"
250 if [ x
"$FIRST_LINE" != x
"$FIRST_LINE_2" ]; then
251 fail
"First snapshot event do not match."
253 pass
"First snapshot event match."
256 stop_lttng_tracing_ok
$SESSION_NAME
257 destroy_lttng_session_ok
$SESSION_NAME
258 taskset
-p $OLDCPUSET $$
1>/dev
/null
2>&1
261 function test_ust_local_snapshot_small_overwrite_buffers
()
265 OLDCPUSET
=$
(taskset
-p $$
)
267 diag
"Test local UST snapshots with small overwrite buffers"
268 taskset
-p 0x1 $$
1>/dev
/null
2>&1 # CPU 0 only
269 create_lttng_session_no_output
$SESSION_NAME
270 enable_mmap_small_overwrite_ust_channel
$SESSION_NAME $CHANNEL_NAME
271 enable_ust_lttng_event_ok
$SESSION_NAME $EVENT_NAME $CHANNEL_NAME
272 start_lttng_tracing_ok
$SESSION_NAME
273 lttng_snapshot_add_output_ok
$SESSION_NAME $TRACE_PATH
275 # Run test apps, wait for them to complete.
279 # Take first snapshot, remember first line.
280 lttng_snapshot_record
$SESSION_NAME
281 FIRST_LINE
="$(trace_first_line $TRACE_PATH/)"
282 diag
"First line (1st snapshot): $FIRST_LINE"
285 # Run test apps, wait for them to complete.
289 # Take second snapshot, remember first line.
290 lttng_snapshot_record
$SESSION_NAME
291 FIRST_LINE_2
="$(trace_first_line $TRACE_PATH/)"
292 diag
"First line (2nd snapshot): $FIRST_LINE_2"
295 if [ x
"$FIRST_LINE" != x
"$FIRST_LINE_2" ]; then
296 pass
"First snapshot event do not match."
298 fail
"First snapshot event match."
301 stop_lttng_tracing_ok
$SESSION_NAME
302 destroy_lttng_session_ok
$SESSION_NAME
303 taskset
-p $OLDCPUSET $$
1>/dev
/null
2>&1
306 function test_ust_local_snapshot_max_size
()
310 page_size
=`getconf PAGE_SIZE`
311 num_cpus
=$
(conf_proc_count
)
313 # The minimum subbuf size is the platform PAGE_SIZE
314 subbuf_size
=$
(($page_size*2))
316 # The minimum size limit is min(subbuf_size) * nb_streams
317 max_size
=$
(($subbuf_size*$num_cpus))
319 diag
"Test local UST snapshots with max size $max_size"
320 create_lttng_session_no_output
$SESSION_NAME
322 enable_mmap_overwrite_subbuf_ust_channel
$SESSION_NAME $CHANNEL_NAME $subbuf_size
324 enable_ust_lttng_event_ok
$SESSION_NAME $EVENT_NAME $CHANNEL_NAME
325 start_lttng_tracing_ok
$SESSION_NAME
327 snapshot_add_output
$SESSION_NAME "file://$TRACE_PATH" "" $max_size
329 # Returns once the application has at least fired ONE tracepoint.
332 lttng_snapshot_record
$SESSION_NAME
335 sum_size_tracefiles
=$
(find $TRACE_PATH -name "${CHANNEL_NAME}_*" \
336 -exec stat
-c '%s' {} \
; |
awk '{s = s + $1}END{print s}')
338 if [ "$sum_size_tracefiles" -gt "$max_size" ]; then
339 fail
"Tracefiles size sum validation"
340 diag
"Tracefiles size sum: $sum_size_tracefiles Expected max: $max_size"
342 pass
"Tracefiles size sum validation"
345 stop_lttng_tracing_ok
$SESSION_NAME
346 destroy_lttng_session_ok
$SESSION_NAME
349 validate_trace
$EVENT_NAME $TRACE_PATH/
351 if [ $?
-eq 0 ]; then
352 # Only delete if successful
359 function test_ust_local_snapshot_large_metadata
()
361 LM_EVENT
="tp:tptest1,tp:tptest2,tp:tptest3,tp:tptest4,tp:tptest5"
362 LM_PATH
="$TESTDIR/utils/testapp"
363 LM_NAME
="gen-ust-nevents"
364 LM_BIN
="$LM_PATH/$LM_NAME/$LM_NAME"
366 diag
"Test local UST snapshots with > 4kB metadata"
367 create_lttng_session_no_output
$SESSION_NAME
368 enable_lttng_mmap_overwrite_ust_channel
$SESSION_NAME $CHANNEL_NAME
369 enable_ust_lttng_event_ok
$SESSION_NAME $LM_EVENT $CHANNEL_NAME
370 start_lttng_tracing_ok
$SESSION_NAME
371 lttng_snapshot_add_output_ok
$SESSION_NAME $TRACE_PATH
373 ok $?
"Start application to trace"
374 lttng_snapshot_record
$SESSION_NAME
375 stop_lttng_tracing_ok
$SESSION_NAME
376 destroy_lttng_session_ok
$SESSION_NAME
379 validate_trace
$LM_EVENT $TRACE_PATH/
380 if [ $?
-eq 0 ]; then
381 # Only delete if successful
386 function enable_channel_per_uid_mmap_overwrite
()
391 $TESTDIR/..
/src
/bin
/lttng
/$LTTNG_BIN enable-channel
--buffers-uid -u $channel_name -s $sess_name --output mmap
--overwrite >/dev
/null
2>&1
392 ok $?
"Enable channel $channel_name per UID for session $sess_name"
395 function test_ust_per_uid_local_snapshot
()
399 diag
"Test per-uid local UST snapshots"
400 create_lttng_session_no_output
$SESSION_NAME
401 enable_channel_per_uid_mmap_overwrite
$SESSION_NAME $CHANNEL_NAME
402 enable_ust_lttng_event_ok
$SESSION_NAME $EVENT_NAME $CHANNEL_NAME
403 start_lttng_tracing_ok
$SESSION_NAME
404 lttng_snapshot_add_output_ok
$SESSION_NAME $TRACE_PATH
406 # Returns once the application has at least fired ONE tracepoint.
409 lttng_snapshot_record
$SESSION_NAME
410 stop_lttng_tracing_ok
$SESSION_NAME
411 destroy_lttng_session_ok
$SESSION_NAME
414 validate_trace
$EVENT_NAME $TRACE_PATH/
415 if [ $?
-eq 0 ]; then
416 # Only delete if successful
423 function test_ust_per_uid_local_snapshot_post_mortem
()
428 diag
"Test local UST snapshots post-mortem"
429 create_lttng_session_no_output
$SESSION_NAME
430 enable_channel_per_uid_mmap_overwrite
$SESSION_NAME $CHANNEL_NAME
431 enable_ust_lttng_event_ok
$SESSION_NAME $EVENT_NAME $CHANNEL_NAME
432 start_lttng_tracing_ok
$SESSION_NAME
433 lttng_snapshot_add_output_ok
$SESSION_NAME $TRACE_PATH
435 # Returns once the application has at least fired ONE tracepoint.
439 lttng_snapshot_record
$SESSION_NAME
440 stop_lttng_tracing_ok
$SESSION_NAME
441 destroy_lttng_session_ok
$SESSION_NAME
444 validate_trace
$EVENT_NAME $TRACE_PATH/
445 if [ $?
-eq 0 ]; then
446 # Only delete if successful
451 function test_ust_local_snapshots
()
456 diag
"Test $NR_SNAPSHOT local UST snapshots"
457 create_lttng_session_no_output
$SESSION_NAME
458 enable_lttng_mmap_overwrite_ust_channel
$SESSION_NAME $CHANNEL_NAME
459 enable_ust_lttng_event_ok
$SESSION_NAME $EVENT_NAME $CHANNEL_NAME
460 start_lttng_tracing_ok
$SESSION_NAME
461 lttng_snapshot_add_output_ok
$SESSION_NAME $TRACE_PATH
463 # Returns once the application has at least fired ONE tracepoint.
466 for i
in $
(seq 1 $NR_SNAPSHOT); do
467 diag
"Snapshot $i/$NR_SNAPSHOT"
468 rm -rf $TRACE_PATH/snapshot
/* 2>/dev
/null
469 lttng_snapshot_record
$SESSION_NAME
471 validate_trace
$EVENT_NAME $TRACE_PATH/
472 if [ $?
-eq 0 ]; then
473 # Only delete if successful
477 stop_lttng_tracing_ok
$SESSION_NAME
478 destroy_lttng_session_ok
$SESSION_NAME
483 plan_tests
$NUM_TESTS
485 print_test_banner
"$TEST_DESC"
488 tests
=( test_ust_list_output
489 test_ust_local_snapshot
490 test_ust_local_snapshot_max_size
491 test_ust_per_uid_local_snapshot
492 test_ust_per_uid_local_snapshot_post_mortem
493 test_ust_local_snapshot_large_metadata
494 test_ust_local_snapshots
495 test_ust_local_snapshot_small_discard_buffers
496 test_ust_local_snapshot_small_overwrite_buffers
499 for fct_test
in ${tests[@]};
501 SESSION_NAME
=$
(randstring
16 0)