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"
31 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 function start_test_app
()
43 local tmp_file
="/tmp/lttng_test_ust.42.file"
45 # Start application with a temporary file.
46 $TESTAPP_BIN $NR_ITER $NR_USEC_WAIT $tmp_file &
47 ok $?
"Start application to trace"
49 # Wait for the application file to appear indicating that at least one
50 # tracepoint has been fired.
51 while [ ! -f "$tmp_file" ]; do
54 diag
"Removing test app temporary file $tmp_file"
58 function kill_test_app
()
60 diag
"Killing $TESTAPP_NAME"
61 PID_APP
=`pidof $TESTAPP_NAME`
62 kill $PID_APP >/dev
/null
2>&1
65 function snapshot_add_output
()
73 if [ ! -z $name ]; then
74 extra_opt
+=" -n $name "
77 if [ ! -z $max_size ]; then
78 extra_opt
+=" -m $max_size "
81 $TESTDIR/..
/src
/bin
/lttng
/$LTTNG_BIN snapshot add-output \
82 -s $sess_name $extra_opt $trace_path > /dev
/null
2>&1
84 ok $?
"Added snapshot output $trace_path ($extra_opt)"
87 function snapshot_del_output
()
92 $TESTDIR/..
/src
/bin
/lttng
/$LTTNG_BIN snapshot del-output \
93 -s $sess_name $name > /dev
/null
2>&1
95 ok $?
"Deleted snapshot output named $name"
98 function enable_mmap_overwrite_subbuf_ust_channel
()
104 $TESTDIR/..
/src
/bin
/lttng
/$LTTNG_BIN enable-channel
-s $sess_name \
105 $chan_name -u --output mmap
--overwrite \
106 --subbuf-size $subbuf_size > /dev
/null
2>&1
108 ok $?
"Enable channel $channel_name for session $sess_name with subbuf size $subbuf_size"
112 function test_ust_list_output
()
114 output_names
=("randomname" "somesnapshot")
116 diag
"Test UST snapshot output listing"
117 create_lttng_session_no_output
$SESSION_NAME
118 enable_lttng_mmap_overwrite_ust_channel
$SESSION_NAME $CHANNEL_NAME
119 enable_ust_lttng_event
$SESSION_NAME $EVENT_NAME $CHANNEL_NAME
121 start_lttng_tracing
$SESSION_NAME
123 snapshot_add_output
$SESSION_NAME "file://$TRACE_PATH" ${output_names[0]}
125 $TESTDIR/..
/src
/bin
/lttng
/$LTTNG_BIN snapshot list-output \
126 -s $SESSION_NAME 2>&1 |
grep ${output_names[0]} > /dev
/null
127 ok $?
"Snapshot named ${output_names[0]} present in list-output listing"
129 snapshot_del_output
$SESSION_NAME ${output_names[0]}
131 snapshot_add_output
$SESSION_NAME "file://$TRACE_PATH" ${output_names[1]}
133 $TESTDIR/..
/src
/bin
/lttng
/$LTTNG_BIN snapshot list-output \
134 -s $SESSION_NAME 2>&1 |
grep ${output_names[1]} > /dev
/null
136 ok $?
"Snapshot named ${output_names[1]} present in list-output listing"
138 stop_lttng_tracing
$SESSION_NAME
139 destroy_lttng_session
$SESSION_NAME
142 function test_ust_local_snapshot
()
144 diag
"Test local UST snapshots"
145 create_lttng_session_no_output
$SESSION_NAME
146 enable_lttng_mmap_overwrite_ust_channel
$SESSION_NAME $CHANNEL_NAME
147 enable_ust_lttng_event
$SESSION_NAME $EVENT_NAME $CHANNEL_NAME
148 start_lttng_tracing
$SESSION_NAME
149 lttng_snapshot_add_output
$SESSION_NAME $TRACE_PATH
151 # Returns once the application has at least fired ONE tracepoint.
154 lttng_snapshot_record
$SESSION_NAME
155 stop_lttng_tracing
$SESSION_NAME
156 destroy_lttng_session
$SESSION_NAME
159 validate_trace
$EVENT_NAME $TRACE_PATH/
160 if [ $?
-eq 0 ]; then
161 # Only delete if successful
170 function test_ust_local_snapshot_max_size
()
175 # The minimum size limit is min(subbuf_size) * nb_streams
176 max_size
=$
(($subbuf_size*$num_cpus))
178 diag
"Test local UST snapshots with max size $max_size"
179 create_lttng_session_no_output
$SESSION_NAME
181 enable_mmap_overwrite_subbuf_ust_channel
$SESSION_NAME $CHANNEL_NAME $subbuf_size
183 enable_ust_lttng_event
$SESSION_NAME $EVENT_NAME $CHANNEL_NAME
184 start_lttng_tracing
$SESSION_NAME
186 snapshot_add_output
$SESSION_NAME "file://$TRACE_PATH" "" $max_size
188 # Returns once the application has at least fired ONE tracepoint.
191 lttng_snapshot_record
$SESSION_NAME
194 sum_size_tracefiles
=$
(find $TRACE_PATH -name "${CHANNEL_NAME}_*" \
195 -exec stat
-c '%s' {} \
; |
awk '{s = s + $1}END{print s}')
197 if [ "$sum_size_tracefiles" -gt "$max_size" ]; then
198 fail
"Tracefiles size sum validation"
199 diag
"Tracefiles size sum: $sum_size_tracefiles Expected max: $max_size"
202 pass
"Tracefiles size sum validation"
204 stop_lttng_tracing
$SESSION_NAME
205 destroy_lttng_session
$SESSION_NAME
208 validate_trace
$EVENT_NAME $TRACE_PATH/
210 if [ $?
-eq 0 ]; then
211 # Only delete if successful
218 function test_ust_local_snapshot_large_metadata
()
220 LM_EVENT
="tp:tptest1,tp:tptest2,tp:tptest3,tp:tptest4,tp:tptest5"
221 LM_PATH
="$TESTDIR/utils/testapp"
222 LM_NAME
="gen-ust-nevents"
223 LM_BIN
="$LM_PATH/$LM_NAME/$LM_NAME"
225 diag
"Test local UST snapshots with > 4kB metadata"
226 create_lttng_session_no_output
$SESSION_NAME
227 enable_lttng_mmap_overwrite_ust_channel
$SESSION_NAME $CHANNEL_NAME
228 enable_ust_lttng_event
$SESSION_NAME $LM_EVENT $CHANNEL_NAME
229 start_lttng_tracing
$SESSION_NAME
230 lttng_snapshot_add_output
$SESSION_NAME $TRACE_PATH
232 ok $?
"Start application to trace"
233 lttng_snapshot_record
$SESSION_NAME
234 stop_lttng_tracing
$SESSION_NAME
235 destroy_lttng_session
$SESSION_NAME
238 validate_trace
$LM_EVENT $TRACE_PATH/
239 if [ $?
-eq 0 ]; then
240 # Only delete if successful
247 function enable_channel_per_uid_mmap_overwrite
()
252 $TESTDIR/..
/src
/bin
/lttng
/$LTTNG_BIN enable-channel
--buffers-uid -u $channel_name -s $sess_name --output mmap
--overwrite >/dev
/null
2>&1
253 ok $?
"Enable channel $channel_name per UID for session $sess_name"
256 function test_ust_per_uid_local_snapshot
()
258 diag
"Test local UST snapshots"
259 create_lttng_session_no_output
$SESSION_NAME
260 enable_channel_per_uid_mmap_overwrite
$SESSION_NAME $CHANNEL_NAME
261 enable_ust_lttng_event
$SESSION_NAME $EVENT_NAME $CHANNEL_NAME
262 start_lttng_tracing
$SESSION_NAME
263 lttng_snapshot_add_output
$SESSION_NAME $TRACE_PATH
265 # Returns once the application has at least fired ONE tracepoint.
268 lttng_snapshot_record
$SESSION_NAME
269 stop_lttng_tracing
$SESSION_NAME
270 destroy_lttng_session
$SESSION_NAME
273 validate_trace
$EVENT_NAME $TRACE_PATH/
274 if [ $?
-eq 0 ]; then
275 # Only delete if successful
284 function test_ust_per_uid_local_snapshot_post_mortem
()
286 diag
"Test local UST snapshots post-mortem"
287 create_lttng_session_no_output
$SESSION_NAME
288 enable_channel_per_uid_mmap_overwrite
$SESSION_NAME $CHANNEL_NAME
289 enable_ust_lttng_event
$SESSION_NAME $EVENT_NAME $CHANNEL_NAME
290 start_lttng_tracing
$SESSION_NAME
291 lttng_snapshot_add_output
$SESSION_NAME $TRACE_PATH
293 # Returns once the application has at least fired ONE tracepoint.
297 lttng_snapshot_record
$SESSION_NAME
298 stop_lttng_tracing
$SESSION_NAME
299 destroy_lttng_session
$SESSION_NAME
302 validate_trace
$EVENT_NAME $TRACE_PATH/
303 if [ $?
-eq 0 ]; then
304 # Only delete if successful
311 function test_ust_1000_local_snapshots
()
315 diag
"Test $NB_SNAP local UST snapshots"
316 create_lttng_session_no_output
$SESSION_NAME
317 enable_lttng_mmap_overwrite_ust_channel
$SESSION_NAME $CHANNEL_NAME
318 enable_ust_lttng_event
$SESSION_NAME $EVENT_NAME $CHANNEL_NAME
319 start_lttng_tracing
$SESSION_NAME
320 lttng_snapshot_add_output
$SESSION_NAME $TRACE_PATH
322 # Returns once the application has at least fired ONE tracepoint.
325 for i
in $
(seq 1 $NB_SNAP); do
326 diag
"Snapshot $i/$NB_SNAP"
327 rm -rf $TRACE_PATH/snapshot
/* 2>/dev
/null
328 lttng_snapshot_record
$SESSION_NAME
330 validate_trace
$EVENT_NAME $TRACE_PATH/
331 if [ $?
-eq 0 ]; then
332 # Only delete if successful
338 stop_lttng_tracing
$SESSION_NAME
339 destroy_lttng_session
$SESSION_NAME
344 plan_tests
$NUM_TESTS
346 print_test_banner
"$TEST_DESC"
348 if [ "$(id -u)" == "0" ]; then
356 tests
=( test_ust_list_output
357 test_ust_local_snapshot
358 test_ust_local_snapshot_max_size
359 test_ust_per_uid_local_snapshot
360 test_ust_per_uid_local_snapshot_post_mortem
361 test_ust_local_snapshot_large_metadata
362 test_ust_1000_local_snapshots
)
364 for fct_test
in ${tests[@]};
366 SESSION_NAME
=$
(randstring
16 0)