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"
33 TRACE_PATH
=$
(mktemp
-d)
35 source $TESTDIR/utils
/utils.sh
37 if [ ! -x "$TESTAPP_BIN" ]; then
38 BAIL_OUT
"No UST events binary detected."
41 # Need the number of snapshot to do.
43 BAIL_OUT
"A number of snapshot is needed."
47 NUM_TESTS
=$
(($NUM_TESTS + ($NR_SNAPSHOT * 2)))
49 function start_test_app
()
51 local tmp_file
="/tmp/lttng_test_ust.42.file"
53 # Start application with a temporary file.
54 $TESTAPP_BIN $NR_ITER $NR_USEC_WAIT $tmp_file &
55 ok $?
"Start application to trace"
57 # Wait for the application file to appear indicating that at least one
58 # tracepoint has been fired.
59 while [ ! -f "$tmp_file" ]; do
62 diag
"Removing test app temporary file $tmp_file"
66 function stop_test_app
()
68 diag
"Killing $TESTAPP_NAME"
69 PID_APP
=`pidof $TESTAPP_NAME`
70 kill $PID_APP >/dev
/null
2>&1
71 diag
"Waiting on $TESTAPP_NAME"
75 function snapshot_add_output
()
83 if [ ! -z $name ]; then
84 extra_opt
+=" -n $name "
87 if [ ! -z $max_size ]; then
88 extra_opt
+=" -m $max_size "
91 $TESTDIR/..
/src
/bin
/lttng
/$LTTNG_BIN snapshot add-output \
92 -s $sess_name $extra_opt $trace_path > /dev
/null
2>&1
94 ok $?
"Added snapshot output $trace_path ($extra_opt)"
97 function snapshot_del_output
()
102 $TESTDIR/..
/src
/bin
/lttng
/$LTTNG_BIN snapshot del-output \
103 -s $sess_name $name > /dev
/null
2>&1
105 ok $?
"Deleted snapshot output named $name"
108 function enable_mmap_overwrite_subbuf_ust_channel
()
114 $TESTDIR/..
/src
/bin
/lttng
/$LTTNG_BIN enable-channel
-s $sess_name \
115 $chan_name -u --output mmap
--overwrite \
116 --subbuf-size $subbuf_size > /dev
/null
2>&1
118 ok $?
"Enable channel $channel_name for session $sess_name with subbuf size $subbuf_size"
122 function test_ust_list_output
()
124 output_names
=("randomname" "somesnapshot")
126 diag
"Test UST snapshot output listing"
127 create_lttng_session_no_output
$SESSION_NAME
128 enable_lttng_mmap_overwrite_ust_channel
$SESSION_NAME $CHANNEL_NAME
129 enable_ust_lttng_event
$SESSION_NAME $EVENT_NAME $CHANNEL_NAME
131 start_lttng_tracing
$SESSION_NAME
133 snapshot_add_output
$SESSION_NAME "file://$TRACE_PATH" ${output_names[0]}
135 $TESTDIR/..
/src
/bin
/lttng
/$LTTNG_BIN snapshot list-output \
136 -s $SESSION_NAME 2>&1 |
grep ${output_names[0]} > /dev
/null
137 ok $?
"Snapshot named ${output_names[0]} present in list-output listing"
139 snapshot_del_output
$SESSION_NAME ${output_names[0]}
141 snapshot_add_output
$SESSION_NAME "file://$TRACE_PATH" ${output_names[1]}
143 $TESTDIR/..
/src
/bin
/lttng
/$LTTNG_BIN snapshot list-output \
144 -s $SESSION_NAME 2>&1 |
grep ${output_names[1]} > /dev
/null
146 ok $?
"Snapshot named ${output_names[1]} present in list-output listing"
148 stop_lttng_tracing
$SESSION_NAME
149 destroy_lttng_session
$SESSION_NAME
152 function test_ust_local_snapshot
()
154 diag
"Test local UST snapshots"
155 create_lttng_session_no_output
$SESSION_NAME
156 enable_lttng_mmap_overwrite_ust_channel
$SESSION_NAME $CHANNEL_NAME
157 enable_ust_lttng_event
$SESSION_NAME $EVENT_NAME $CHANNEL_NAME
158 start_lttng_tracing
$SESSION_NAME
159 lttng_snapshot_add_output
$SESSION_NAME $TRACE_PATH
161 # Returns once the application has at least fired ONE tracepoint.
164 lttng_snapshot_record
$SESSION_NAME
165 stop_lttng_tracing
$SESSION_NAME
166 destroy_lttng_session
$SESSION_NAME
169 validate_trace
$EVENT_NAME $TRACE_PATH/
170 if [ $?
-eq 0 ]; then
171 # Only delete if successful
180 function test_ust_local_snapshot_max_size
()
185 # The minimum size limit is min(subbuf_size) * nb_streams
186 max_size
=$
(($subbuf_size*$num_cpus))
188 diag
"Test local UST snapshots with max size $max_size"
189 create_lttng_session_no_output
$SESSION_NAME
191 enable_mmap_overwrite_subbuf_ust_channel
$SESSION_NAME $CHANNEL_NAME $subbuf_size
193 enable_ust_lttng_event
$SESSION_NAME $EVENT_NAME $CHANNEL_NAME
194 start_lttng_tracing
$SESSION_NAME
196 snapshot_add_output
$SESSION_NAME "file://$TRACE_PATH" "" $max_size
198 # Returns once the application has at least fired ONE tracepoint.
201 lttng_snapshot_record
$SESSION_NAME
204 sum_size_tracefiles
=$
(find $TRACE_PATH -name "${CHANNEL_NAME}_*" \
205 -exec stat
-c '%s' {} \
; |
awk '{s = s + $1}END{print s}')
207 if [ "$sum_size_tracefiles" -gt "$max_size" ]; then
208 fail
"Tracefiles size sum validation"
209 diag
"Tracefiles size sum: $sum_size_tracefiles Expected max: $max_size"
212 pass
"Tracefiles size sum validation"
214 stop_lttng_tracing
$SESSION_NAME
215 destroy_lttng_session
$SESSION_NAME
218 validate_trace
$EVENT_NAME $TRACE_PATH/
220 if [ $?
-eq 0 ]; then
221 # Only delete if successful
228 function test_ust_local_snapshot_large_metadata
()
230 LM_EVENT
="tp:tptest1,tp:tptest2,tp:tptest3,tp:tptest4,tp:tptest5"
231 LM_PATH
="$TESTDIR/utils/testapp"
232 LM_NAME
="gen-ust-nevents"
233 LM_BIN
="$LM_PATH/$LM_NAME/$LM_NAME"
235 diag
"Test local UST snapshots with > 4kB metadata"
236 create_lttng_session_no_output
$SESSION_NAME
237 enable_lttng_mmap_overwrite_ust_channel
$SESSION_NAME $CHANNEL_NAME
238 enable_ust_lttng_event
$SESSION_NAME $LM_EVENT $CHANNEL_NAME
239 start_lttng_tracing
$SESSION_NAME
240 lttng_snapshot_add_output
$SESSION_NAME $TRACE_PATH
242 ok $?
"Start application to trace"
243 lttng_snapshot_record
$SESSION_NAME
244 stop_lttng_tracing
$SESSION_NAME
245 destroy_lttng_session
$SESSION_NAME
248 validate_trace
$LM_EVENT $TRACE_PATH/
249 if [ $?
-eq 0 ]; then
250 # Only delete if successful
257 function enable_channel_per_uid_mmap_overwrite
()
262 $TESTDIR/..
/src
/bin
/lttng
/$LTTNG_BIN enable-channel
--buffers-uid -u $channel_name -s $sess_name --output mmap
--overwrite >/dev
/null
2>&1
263 ok $?
"Enable channel $channel_name per UID for session $sess_name"
266 function test_ust_per_uid_local_snapshot
()
268 diag
"Test local UST snapshots"
269 create_lttng_session_no_output
$SESSION_NAME
270 enable_channel_per_uid_mmap_overwrite
$SESSION_NAME $CHANNEL_NAME
271 enable_ust_lttng_event
$SESSION_NAME $EVENT_NAME $CHANNEL_NAME
272 start_lttng_tracing
$SESSION_NAME
273 lttng_snapshot_add_output
$SESSION_NAME $TRACE_PATH
275 # Returns once the application has at least fired ONE tracepoint.
278 lttng_snapshot_record
$SESSION_NAME
279 stop_lttng_tracing
$SESSION_NAME
280 destroy_lttng_session
$SESSION_NAME
283 validate_trace
$EVENT_NAME $TRACE_PATH/
284 if [ $?
-eq 0 ]; then
285 # Only delete if successful
294 function test_ust_per_uid_local_snapshot_post_mortem
()
296 diag
"Test local UST snapshots post-mortem"
297 create_lttng_session_no_output
$SESSION_NAME
298 enable_channel_per_uid_mmap_overwrite
$SESSION_NAME $CHANNEL_NAME
299 enable_ust_lttng_event
$SESSION_NAME $EVENT_NAME $CHANNEL_NAME
300 start_lttng_tracing
$SESSION_NAME
301 lttng_snapshot_add_output
$SESSION_NAME $TRACE_PATH
303 # Returns once the application has at least fired ONE tracepoint.
307 lttng_snapshot_record
$SESSION_NAME
308 stop_lttng_tracing
$SESSION_NAME
309 destroy_lttng_session
$SESSION_NAME
312 validate_trace
$EVENT_NAME $TRACE_PATH/
313 if [ $?
-eq 0 ]; then
314 # Only delete if successful
321 function test_ust_local_snapshots
()
323 diag
"Test $NR_SNAPSHOT local UST snapshots"
324 create_lttng_session_no_output
$SESSION_NAME
325 enable_lttng_mmap_overwrite_ust_channel
$SESSION_NAME $CHANNEL_NAME
326 enable_ust_lttng_event
$SESSION_NAME $EVENT_NAME $CHANNEL_NAME
327 start_lttng_tracing
$SESSION_NAME
328 lttng_snapshot_add_output
$SESSION_NAME $TRACE_PATH
330 # Returns once the application has at least fired ONE tracepoint.
333 for i
in $
(seq 1 $NR_SNAPSHOT); do
334 diag
"Snapshot $i/$NR_SNAPSHOT"
335 rm -rf $TRACE_PATH/snapshot
/* 2>/dev
/null
336 lttng_snapshot_record
$SESSION_NAME
338 validate_trace
$EVENT_NAME $TRACE_PATH/
339 if [ $?
-eq 0 ]; then
340 # Only delete if successful
346 stop_lttng_tracing
$SESSION_NAME
347 destroy_lttng_session
$SESSION_NAME
352 plan_tests
$NUM_TESTS
354 print_test_banner
"$TEST_DESC"
358 tests
=( test_ust_list_output
359 test_ust_local_snapshot
360 test_ust_local_snapshot_max_size
361 test_ust_per_uid_local_snapshot
362 test_ust_per_uid_local_snapshot_post_mortem
363 test_ust_local_snapshot_large_metadata
364 test_ust_local_snapshots
)
366 for fct_test
in ${tests[@]};
368 SESSION_NAME
=$
(randstring
16 0)