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 kill_test_app
()
68 diag
"Killing $TESTAPP_NAME"
69 PID_APP
=`pidof $TESTAPP_NAME`
70 kill $PID_APP >/dev
/null
2>&1
73 function snapshot_add_output
()
81 if [ ! -z $name ]; then
82 extra_opt
+=" -n $name "
85 if [ ! -z $max_size ]; then
86 extra_opt
+=" -m $max_size "
89 $TESTDIR/..
/src
/bin
/lttng
/$LTTNG_BIN snapshot add-output \
90 -s $sess_name $extra_opt $trace_path > /dev
/null
2>&1
92 ok $?
"Added snapshot output $trace_path ($extra_opt)"
95 function snapshot_del_output
()
100 $TESTDIR/..
/src
/bin
/lttng
/$LTTNG_BIN snapshot del-output \
101 -s $sess_name $name > /dev
/null
2>&1
103 ok $?
"Deleted snapshot output named $name"
106 function enable_mmap_overwrite_subbuf_ust_channel
()
112 $TESTDIR/..
/src
/bin
/lttng
/$LTTNG_BIN enable-channel
-s $sess_name \
113 $chan_name -u --output mmap
--overwrite \
114 --subbuf-size $subbuf_size > /dev
/null
2>&1
116 ok $?
"Enable channel $channel_name for session $sess_name with subbuf size $subbuf_size"
120 function test_ust_list_output
()
122 output_names
=("randomname" "somesnapshot")
124 diag
"Test UST snapshot output listing"
125 create_lttng_session_no_output
$SESSION_NAME
126 enable_lttng_mmap_overwrite_ust_channel
$SESSION_NAME $CHANNEL_NAME
127 enable_ust_lttng_event
$SESSION_NAME $EVENT_NAME $CHANNEL_NAME
129 start_lttng_tracing
$SESSION_NAME
131 snapshot_add_output
$SESSION_NAME "file://$TRACE_PATH" ${output_names[0]}
133 $TESTDIR/..
/src
/bin
/lttng
/$LTTNG_BIN snapshot list-output \
134 -s $SESSION_NAME 2>&1 |
grep ${output_names[0]} > /dev
/null
135 ok $?
"Snapshot named ${output_names[0]} present in list-output listing"
137 snapshot_del_output
$SESSION_NAME ${output_names[0]}
139 snapshot_add_output
$SESSION_NAME "file://$TRACE_PATH" ${output_names[1]}
141 $TESTDIR/..
/src
/bin
/lttng
/$LTTNG_BIN snapshot list-output \
142 -s $SESSION_NAME 2>&1 |
grep ${output_names[1]} > /dev
/null
144 ok $?
"Snapshot named ${output_names[1]} present in list-output listing"
146 stop_lttng_tracing
$SESSION_NAME
147 destroy_lttng_session
$SESSION_NAME
150 function test_ust_local_snapshot
()
152 diag
"Test local UST snapshots"
153 create_lttng_session_no_output
$SESSION_NAME
154 enable_lttng_mmap_overwrite_ust_channel
$SESSION_NAME $CHANNEL_NAME
155 enable_ust_lttng_event
$SESSION_NAME $EVENT_NAME $CHANNEL_NAME
156 start_lttng_tracing
$SESSION_NAME
157 lttng_snapshot_add_output
$SESSION_NAME $TRACE_PATH
159 # Returns once the application has at least fired ONE tracepoint.
162 lttng_snapshot_record
$SESSION_NAME
163 stop_lttng_tracing
$SESSION_NAME
164 destroy_lttng_session
$SESSION_NAME
167 validate_trace
$EVENT_NAME $TRACE_PATH/
168 if [ $?
-eq 0 ]; then
169 # Only delete if successful
176 function test_ust_local_snapshot_max_size
()
181 # The minimum size limit is min(subbuf_size) * nb_streams
182 max_size
=$
(($subbuf_size*$num_cpus))
184 diag
"Test local UST snapshots with max size $max_size"
185 create_lttng_session_no_output
$SESSION_NAME
187 enable_mmap_overwrite_subbuf_ust_channel
$SESSION_NAME $CHANNEL_NAME $subbuf_size
189 enable_ust_lttng_event
$SESSION_NAME $EVENT_NAME $CHANNEL_NAME
190 start_lttng_tracing
$SESSION_NAME
192 snapshot_add_output
$SESSION_NAME "file://$TRACE_PATH" "" $max_size
194 # Returns once the application has at least fired ONE tracepoint.
197 lttng_snapshot_record
$SESSION_NAME
200 sum_size_tracefiles
=$
(find $TRACE_PATH -name "${CHANNEL_NAME}_*" \
201 -exec stat
-c '%s' {} \
; |
awk '{s = s + $1}END{print s}')
203 if [ "$sum_size_tracefiles" -gt "$max_size" ]; then
204 fail
"Tracefiles size sum validation"
205 diag
"Tracefiles size sum: $sum_size_tracefiles Expected max: $max_size"
208 pass
"Tracefiles size sum validation"
210 stop_lttng_tracing
$SESSION_NAME
211 destroy_lttng_session
$SESSION_NAME
214 validate_trace
$EVENT_NAME $TRACE_PATH/
216 if [ $?
-eq 0 ]; then
217 # Only delete if successful
224 function test_ust_local_snapshot_large_metadata
()
226 LM_EVENT
="tp:tptest1,tp:tptest2,tp:tptest3,tp:tptest4,tp:tptest5"
227 LM_PATH
="$TESTDIR/utils/testapp"
228 LM_NAME
="gen-ust-nevents"
229 LM_BIN
="$LM_PATH/$LM_NAME/$LM_NAME"
231 diag
"Test local UST snapshots with > 4kB metadata"
232 create_lttng_session_no_output
$SESSION_NAME
233 enable_lttng_mmap_overwrite_ust_channel
$SESSION_NAME $CHANNEL_NAME
234 enable_ust_lttng_event
$SESSION_NAME $LM_EVENT $CHANNEL_NAME
235 start_lttng_tracing
$SESSION_NAME
236 lttng_snapshot_add_output
$SESSION_NAME $TRACE_PATH
238 ok $?
"Start application to trace"
239 lttng_snapshot_record
$SESSION_NAME
240 stop_lttng_tracing
$SESSION_NAME
241 destroy_lttng_session
$SESSION_NAME
244 validate_trace
$LM_EVENT $TRACE_PATH/
245 if [ $?
-eq 0 ]; then
246 # Only delete if successful
251 function enable_channel_per_uid_mmap_overwrite
()
256 $TESTDIR/..
/src
/bin
/lttng
/$LTTNG_BIN enable-channel
--buffers-uid -u $channel_name -s $sess_name --output mmap
--overwrite >/dev
/null
2>&1
257 ok $?
"Enable channel $channel_name per UID for session $sess_name"
260 function test_ust_per_uid_local_snapshot
()
262 diag
"Test local UST snapshots"
263 create_lttng_session_no_output
$SESSION_NAME
264 enable_channel_per_uid_mmap_overwrite
$SESSION_NAME $CHANNEL_NAME
265 enable_ust_lttng_event
$SESSION_NAME $EVENT_NAME $CHANNEL_NAME
266 start_lttng_tracing
$SESSION_NAME
267 lttng_snapshot_add_output
$SESSION_NAME $TRACE_PATH
269 # Returns once the application has at least fired ONE tracepoint.
272 lttng_snapshot_record
$SESSION_NAME
273 stop_lttng_tracing
$SESSION_NAME
274 destroy_lttng_session
$SESSION_NAME
277 validate_trace
$EVENT_NAME $TRACE_PATH/
278 if [ $?
-eq 0 ]; then
279 # Only delete if successful
286 function test_ust_per_uid_local_snapshot_post_mortem
()
288 diag
"Test local UST snapshots post-mortem"
289 create_lttng_session_no_output
$SESSION_NAME
290 enable_channel_per_uid_mmap_overwrite
$SESSION_NAME $CHANNEL_NAME
291 enable_ust_lttng_event
$SESSION_NAME $EVENT_NAME $CHANNEL_NAME
292 start_lttng_tracing
$SESSION_NAME
293 lttng_snapshot_add_output
$SESSION_NAME $TRACE_PATH
295 # Returns once the application has at least fired ONE tracepoint.
299 lttng_snapshot_record
$SESSION_NAME
300 stop_lttng_tracing
$SESSION_NAME
301 destroy_lttng_session
$SESSION_NAME
304 validate_trace
$EVENT_NAME $TRACE_PATH/
305 if [ $?
-eq 0 ]; then
306 # Only delete if successful
311 function test_ust_local_snapshots
()
313 diag
"Test $NR_SNAPSHOT local UST snapshots"
314 create_lttng_session_no_output
$SESSION_NAME
315 enable_lttng_mmap_overwrite_ust_channel
$SESSION_NAME $CHANNEL_NAME
316 enable_ust_lttng_event
$SESSION_NAME $EVENT_NAME $CHANNEL_NAME
317 start_lttng_tracing
$SESSION_NAME
318 lttng_snapshot_add_output
$SESSION_NAME $TRACE_PATH
320 # Returns once the application has at least fired ONE tracepoint.
323 for i
in $
(seq 1 $NR_SNAPSHOT); do
324 diag
"Snapshot $i/$NR_SNAPSHOT"
325 rm -rf $TRACE_PATH/snapshot
/* 2>/dev
/null
326 lttng_snapshot_record
$SESSION_NAME
328 validate_trace
$EVENT_NAME $TRACE_PATH/
329 if [ $?
-eq 0 ]; then
330 # Only delete if successful
334 stop_lttng_tracing
$SESSION_NAME
335 destroy_lttng_session
$SESSION_NAME
340 plan_tests
$NUM_TESTS
342 print_test_banner
"$TEST_DESC"
346 tests
=( test_ust_list_output
347 test_ust_local_snapshot
348 test_ust_local_snapshot_max_size
349 test_ust_per_uid_local_snapshot
350 test_ust_per_uid_local_snapshot_post_mortem
351 test_ust_local_snapshot_large_metadata
352 test_ust_local_snapshots
)
354 for fct_test
in ${tests[@]};
356 SESSION_NAME
=$
(randstring
16 0)