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")
163 diag
"Test UST snapshot output listing"
164 create_lttng_session_no_output
$SESSION_NAME
165 enable_lttng_mmap_overwrite_ust_channel
$SESSION_NAME $CHANNEL_NAME
166 enable_ust_lttng_event_ok
$SESSION_NAME $EVENT_NAME $CHANNEL_NAME
168 start_lttng_tracing_ok
$SESSION_NAME
170 snapshot_add_output
$SESSION_NAME "file://$TRACE_PATH" ${output_names[0]}
172 $TESTDIR/..
/src
/bin
/lttng
/$LTTNG_BIN snapshot list-output \
173 -s $SESSION_NAME 2>&1 |
grep ${output_names[0]} > /dev
/null
174 ok $?
"Snapshot named ${output_names[0]} present in list-output listing"
176 snapshot_del_output
$SESSION_NAME ${output_names[0]}
178 snapshot_add_output
$SESSION_NAME "file://$TRACE_PATH" ${output_names[1]}
180 $TESTDIR/..
/src
/bin
/lttng
/$LTTNG_BIN snapshot list-output \
181 -s $SESSION_NAME 2>&1 |
grep ${output_names[1]} > /dev
/null
183 ok $?
"Snapshot named ${output_names[1]} present in list-output listing"
185 stop_lttng_tracing_ok
$SESSION_NAME
186 destroy_lttng_session_ok
$SESSION_NAME
189 function test_ust_local_snapshot
()
194 diag
"Test local UST snapshots"
195 create_lttng_session_no_output
$SESSION_NAME
196 enable_lttng_mmap_overwrite_ust_channel
$SESSION_NAME $CHANNEL_NAME
197 enable_ust_lttng_event_ok
$SESSION_NAME $EVENT_NAME $CHANNEL_NAME
198 start_lttng_tracing_ok
$SESSION_NAME
199 lttng_snapshot_add_output_ok
$SESSION_NAME $TRACE_PATH
201 # Returns once the application has at least fired ONE tracepoint.
204 lttng_snapshot_record
$SESSION_NAME
205 stop_lttng_tracing_ok
$SESSION_NAME
206 destroy_lttng_session_ok
$SESSION_NAME
209 validate_trace
$EVENT_NAME $TRACE_PATH/
210 if [ $?
-eq 0 ]; then
211 # Only delete if successful
218 function test_ust_local_snapshot_small_discard_buffers
()
222 OLDCPUSET
=$
(taskset
-p $$
)
224 diag
"Test local UST snapshots with small discard buffers"
225 taskset
-p 0x1 $$
1>/dev
/null
2>&1 # CPU 0 only
226 create_lttng_session_no_output
$SESSION_NAME
227 enable_mmap_small_discard_ust_channel
$SESSION_NAME $CHANNEL_NAME
228 enable_ust_lttng_event_ok
$SESSION_NAME $EVENT_NAME $CHANNEL_NAME
229 start_lttng_tracing_ok
$SESSION_NAME
230 lttng_snapshot_add_output_ok
$SESSION_NAME $TRACE_PATH
232 # Run test apps, wait for them to complete.
236 # Take first snapshot, remember first line.
237 lttng_snapshot_record
$SESSION_NAME
238 FIRST_LINE
="$(trace_first_line $TRACE_PATH/)"
239 diag
"First line (1st snapshot): $FIRST_LINE"
242 # Run test apps, wait for them to complete.
246 # Take second snapshot, remember first line.
247 lttng_snapshot_record
$SESSION_NAME
248 FIRST_LINE_2
="$(trace_first_line $TRACE_PATH/)"
249 diag
"First line (2nd snapshot): $FIRST_LINE_2"
252 if [ x
"$FIRST_LINE" != x
"$FIRST_LINE_2" ]; then
253 fail
"First snapshot event do not match."
255 pass
"First snapshot event match."
258 stop_lttng_tracing_ok
$SESSION_NAME
259 destroy_lttng_session_ok
$SESSION_NAME
260 taskset
-p $OLDCPUSET $$
1>/dev
/null
2>&1
263 function test_ust_local_snapshot_small_overwrite_buffers
()
267 OLDCPUSET
=$
(taskset
-p $$
)
269 diag
"Test local UST snapshots with small overwrite buffers"
270 taskset
-p 0x1 $$
1>/dev
/null
2>&1 # CPU 0 only
271 create_lttng_session_no_output
$SESSION_NAME
272 enable_mmap_small_overwrite_ust_channel
$SESSION_NAME $CHANNEL_NAME
273 enable_ust_lttng_event_ok
$SESSION_NAME $EVENT_NAME $CHANNEL_NAME
274 start_lttng_tracing_ok
$SESSION_NAME
275 lttng_snapshot_add_output_ok
$SESSION_NAME $TRACE_PATH
277 # Run test apps, wait for them to complete.
281 # Take first snapshot, remember first line.
282 lttng_snapshot_record
$SESSION_NAME
283 FIRST_LINE
="$(trace_first_line $TRACE_PATH/)"
284 diag
"First line (1st snapshot): $FIRST_LINE"
287 # Run test apps, wait for them to complete.
291 # Take second snapshot, remember first line.
292 lttng_snapshot_record
$SESSION_NAME
293 FIRST_LINE_2
="$(trace_first_line $TRACE_PATH/)"
294 diag
"First line (2nd snapshot): $FIRST_LINE_2"
297 if [ x
"$FIRST_LINE" != x
"$FIRST_LINE_2" ]; then
298 pass
"First snapshot event do not match."
300 fail
"First snapshot event match."
303 stop_lttng_tracing_ok
$SESSION_NAME
304 destroy_lttng_session_ok
$SESSION_NAME
305 taskset
-p $OLDCPUSET $$
1>/dev
/null
2>&1
308 function test_ust_local_snapshot_max_size
()
312 page_size
=`getconf PAGE_SIZE`
313 num_cpus
=$
(conf_proc_count
)
315 # The minimum subbuf size is the platform PAGE_SIZE
316 subbuf_size
=$
(($page_size*2))
318 # The minimum size limit is min(subbuf_size) * nb_streams
319 max_size
=$
(($subbuf_size*$num_cpus))
321 diag
"Test local UST snapshots with max size $max_size"
322 create_lttng_session_no_output
$SESSION_NAME
324 enable_mmap_overwrite_subbuf_ust_channel
$SESSION_NAME $CHANNEL_NAME $subbuf_size
326 enable_ust_lttng_event_ok
$SESSION_NAME $EVENT_NAME $CHANNEL_NAME
327 start_lttng_tracing_ok
$SESSION_NAME
329 snapshot_add_output
$SESSION_NAME "file://$TRACE_PATH" "" $max_size
331 # Returns once the application has at least fired ONE tracepoint.
334 lttng_snapshot_record
$SESSION_NAME
337 sum_size_tracefiles
=$
(find $TRACE_PATH -name "${CHANNEL_NAME}_*" \
338 -exec stat
-c '%s' {} \
; |
awk '{s = s + $1}END{print s}')
340 if [ "$sum_size_tracefiles" -gt "$max_size" ]; then
341 fail
"Tracefiles size sum validation"
342 diag
"Tracefiles size sum: $sum_size_tracefiles Expected max: $max_size"
345 pass
"Tracefiles size sum validation"
347 stop_lttng_tracing_ok
$SESSION_NAME
348 destroy_lttng_session_ok
$SESSION_NAME
351 validate_trace
$EVENT_NAME $TRACE_PATH/
353 if [ $?
-eq 0 ]; then
354 # Only delete if successful
361 function test_ust_local_snapshot_large_metadata
()
365 LM_EVENT
="tp:tptest1,tp:tptest2,tp:tptest3,tp:tptest4,tp:tptest5"
366 LM_PATH
="$TESTDIR/utils/testapp"
367 LM_NAME
="gen-ust-nevents"
368 LM_BIN
="$LM_PATH/$LM_NAME/$LM_NAME"
370 diag
"Test local UST snapshots with > 4kB metadata"
371 create_lttng_session_no_output
$SESSION_NAME
372 enable_lttng_mmap_overwrite_ust_channel
$SESSION_NAME $CHANNEL_NAME
373 enable_ust_lttng_event_ok
$SESSION_NAME $LM_EVENT $CHANNEL_NAME
374 start_lttng_tracing_ok
$SESSION_NAME
375 lttng_snapshot_add_output_ok
$SESSION_NAME $TRACE_PATH
377 ok $?
"Start application to trace"
378 lttng_snapshot_record
$SESSION_NAME
379 stop_lttng_tracing_ok
$SESSION_NAME
380 destroy_lttng_session_ok
$SESSION_NAME
383 validate_trace
$LM_EVENT $TRACE_PATH/
384 if [ $?
-eq 0 ]; then
385 # Only delete if successful
390 function enable_channel_per_uid_mmap_overwrite
()
397 $TESTDIR/..
/src
/bin
/lttng
/$LTTNG_BIN enable-channel
--buffers-uid -u $channel_name -s $sess_name --output mmap
--overwrite >/dev
/null
2>&1
398 ok $?
"Enable channel $channel_name per UID for session $sess_name"
401 function test_ust_per_uid_local_snapshot
()
403 diag
"Test per-uid local UST snapshots"
404 create_lttng_session_no_output
$SESSION_NAME
405 enable_channel_per_uid_mmap_overwrite
$SESSION_NAME $CHANNEL_NAME
406 enable_ust_lttng_event_ok
$SESSION_NAME $EVENT_NAME $CHANNEL_NAME
407 start_lttng_tracing_ok
$SESSION_NAME
408 lttng_snapshot_add_output_ok
$SESSION_NAME $TRACE_PATH
410 # Returns once the application has at least fired ONE tracepoint.
413 lttng_snapshot_record
$SESSION_NAME
414 stop_lttng_tracing_ok
$SESSION_NAME
415 destroy_lttng_session_ok
$SESSION_NAME
418 validate_trace
$EVENT_NAME $TRACE_PATH/
419 if [ $?
-eq 0 ]; then
420 # Only delete if successful
427 function test_ust_per_uid_local_snapshot_post_mortem
()
432 diag
"Test local UST snapshots post-mortem"
433 create_lttng_session_no_output
$SESSION_NAME
434 enable_channel_per_uid_mmap_overwrite
$SESSION_NAME $CHANNEL_NAME
435 enable_ust_lttng_event_ok
$SESSION_NAME $EVENT_NAME $CHANNEL_NAME
436 start_lttng_tracing_ok
$SESSION_NAME
437 lttng_snapshot_add_output_ok
$SESSION_NAME $TRACE_PATH
439 # Returns once the application has at least fired ONE tracepoint.
443 lttng_snapshot_record
$SESSION_NAME
444 stop_lttng_tracing_ok
$SESSION_NAME
445 destroy_lttng_session_ok
$SESSION_NAME
448 validate_trace
$EVENT_NAME $TRACE_PATH/
449 if [ $?
-eq 0 ]; then
450 # Only delete if successful
455 function test_ust_local_snapshots
()
460 diag
"Test $NR_SNAPSHOT local UST snapshots"
461 create_lttng_session_no_output
$SESSION_NAME
462 enable_lttng_mmap_overwrite_ust_channel
$SESSION_NAME $CHANNEL_NAME
463 enable_ust_lttng_event_ok
$SESSION_NAME $EVENT_NAME $CHANNEL_NAME
464 start_lttng_tracing_ok
$SESSION_NAME
465 lttng_snapshot_add_output_ok
$SESSION_NAME $TRACE_PATH
467 # Returns once the application has at least fired ONE tracepoint.
470 for i
in $
(seq 1 $NR_SNAPSHOT); do
471 diag
"Snapshot $i/$NR_SNAPSHOT"
472 rm -rf $TRACE_PATH/snapshot
/* 2>/dev
/null
473 lttng_snapshot_record
$SESSION_NAME
475 validate_trace
$EVENT_NAME $TRACE_PATH/
476 if [ $?
-eq 0 ]; then
477 # Only delete if successful
481 stop_lttng_tracing_ok
$SESSION_NAME
482 destroy_lttng_session_ok
$SESSION_NAME
487 plan_tests
$NUM_TESTS
489 print_test_banner
"$TEST_DESC"
492 tests
=( test_ust_list_output
493 test_ust_local_snapshot
494 test_ust_local_snapshot_max_size
495 test_ust_per_uid_local_snapshot
496 test_ust_per_uid_local_snapshot_post_mortem
497 test_ust_local_snapshot_large_metadata
498 test_ust_local_snapshots
499 test_ust_local_snapshot_small_discard_buffers
500 test_ust_local_snapshot_small_overwrite_buffers
503 for fct_test
in ${tests[@]};
505 SESSION_NAME
=$
(randstring
16 0)