Gen-ust-events: use options instead of arguments
[lttng-tools.git] / tests / regression / tools / snapshots / ust_test
CommitLineData
ebaaaf5e
JD
1#!/bin/bash
2#
3# Copyright (C) - 2013 Julien Desfossez <jdesfossez@efficios.com>
4#
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.
8#
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
12# details.
13#
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
17TEST_DESC="Snapshots - UST tracing"
18
19CURDIR=$(dirname $0)/
20TESTDIR=$CURDIR/../../..
21EVENT_NAME="tp:tptest"
ebaaaf5e
JD
22PID_RELAYD=0
23SESSION_NAME=""
24CHANNEL_NAME="snapchan"
25TESTAPP_PATH="$TESTDIR/utils/testapp"
26TESTAPP_NAME="gen-ust-events"
27TESTAPP_BIN="$TESTAPP_PATH/$TESTAPP_NAME/$TESTAPP_NAME"
0fc2834c 28APPS_PID=
ebaaaf5e 29
ae779dd6 30NUM_TESTS=100
ebaaaf5e 31
1d20c959 32TRACE_PATH=$(mktemp -d)
ebaaaf5e
JD
33
34source $TESTDIR/utils/utils.sh
35
36if [ ! -x "$TESTAPP_BIN" ]; then
37 BAIL_OUT "No UST events binary detected."
38fi
39
1d20c959
DG
40# Need the number of snapshot to do.
41if [ -z $1 ]; then
42 BAIL_OUT "A number of snapshot is needed."
43fi
44NR_SNAPSHOT=$1
45
46NUM_TESTS=$(($NUM_TESTS + ($NR_SNAPSHOT * 2)))
47
209b934f
DG
48function start_test_app()
49{
5fcaccbc 50 local tmp_file=$(mktemp -u)
209b934f
DG
51
52 # Start application with a temporary file.
e8526e3f 53 $TESTAPP_BIN -i $NR_ITER -w $NR_USEC_WAIT --sync-after-first-event $tmp_file &
0fc2834c
MD
54 ret=$?
55 APPS_PID="${APPS_PID} ${!}"
56 ok $ret "Start application to trace"
209b934f
DG
57
58 # Wait for the application file to appear indicating that at least one
59 # tracepoint has been fired.
60 while [ ! -f "$tmp_file" ]; do
61 sleep 0.5
62 done
63 diag "Removing test app temporary file $tmp_file"
64 rm -f $tmp_file
65}
66
ae779dd6
MD
67function wait_test_apps()
68{
69 diag "Waiting for $TESTAPP_NAME"
70 for p in ${APPS_PID}; do
71 wait ${p} 2>/dev/null
72 done
73}
74
0fc2834c 75function stop_test_apps()
209b934f 76{
0fc2834c
MD
77 diag "Stopping $TESTAPP_NAME"
78 for p in ${APPS_PID}; do
79 kill ${p}
5402fe87 80 wait ${p} 2>/dev/null
0fc2834c 81 done
c7613334 82 APPS_PID=
209b934f
DG
83}
84
5e83c405
CB
85function snapshot_add_output ()
86{
87 local sess_name=$1
88 local trace_path=$2
89 local name=$3
90 local max_size=$4
91 local extra_opt=""
92
93 if [ ! -z $name ]; then
94 extra_opt+=" -n $name "
95 fi
96
97 if [ ! -z $max_size ]; then
98 extra_opt+=" -m $max_size "
99 fi
100
101 $TESTDIR/../src/bin/lttng/$LTTNG_BIN snapshot add-output \
102 -s $sess_name $extra_opt $trace_path > /dev/null 2>&1
103
104 ok $? "Added snapshot output $trace_path ($extra_opt)"
105}
106
107function snapshot_del_output ()
108{
109 local sess_name=$1
110 local name=$2
111
112 $TESTDIR/../src/bin/lttng/$LTTNG_BIN snapshot del-output \
113 -s $sess_name $name > /dev/null 2>&1
114
115 ok $? "Deleted snapshot output named $name"
116}
117
118function enable_mmap_overwrite_subbuf_ust_channel ()
119{
120 local sess_name=$1
121 local chan_name=$2
122 local subbuf_size=$3
123
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
127
128 ok $? "Enable channel $channel_name for session $sess_name with subbuf size $subbuf_size"
129}
130
ae779dd6
MD
131function enable_mmap_small_discard_ust_channel ()
132{
133 local sess_name=$1
134 local chan_name=$2
135
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 \
139 > /dev/null 2>&1
140
141 ok $? "Enable channel $channel_name for session $sess_name with small discard buffers"
142}
143
144function enable_mmap_small_overwrite_ust_channel ()
145{
146 local sess_name=$1
147 local chan_name=$2
148
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 \
152 > /dev/null 2>&1
153
154 ok $? "Enable channel $channel_name for session $sess_name with small discard buffers"
155}
5e83c405
CB
156
157function test_ust_list_output ()
158{
159 output_names=("randomname" "somesnapshot")
160
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
c4926bb5 164 enable_ust_lttng_event_ok $SESSION_NAME $EVENT_NAME $CHANNEL_NAME
5e83c405 165
e563bbdb 166 start_lttng_tracing_ok $SESSION_NAME
5e83c405
CB
167
168 snapshot_add_output $SESSION_NAME "file://$TRACE_PATH" ${output_names[0]}
169
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"
173
174 snapshot_del_output $SESSION_NAME ${output_names[0]}
175
176 snapshot_add_output $SESSION_NAME "file://$TRACE_PATH" ${output_names[1]}
177
178 $TESTDIR/../src/bin/lttng/$LTTNG_BIN snapshot list-output \
179 -s $SESSION_NAME 2>&1 | grep ${output_names[1]} > /dev/null
180
181 ok $? "Snapshot named ${output_names[1]} present in list-output listing"
182
96340a01 183 stop_lttng_tracing_ok $SESSION_NAME
67b4c664 184 destroy_lttng_session_ok $SESSION_NAME
5e83c405
CB
185}
186
ebaaaf5e
JD
187function test_ust_local_snapshot ()
188{
98342ba3 189 NR_ITER=-1
ae779dd6
MD
190 NR_USEC_WAIT=100
191
ebaaaf5e
JD
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
c4926bb5 195 enable_ust_lttng_event_ok $SESSION_NAME $EVENT_NAME $CHANNEL_NAME
e563bbdb 196 start_lttng_tracing_ok $SESSION_NAME
b5633831 197 lttng_snapshot_add_output_ok $SESSION_NAME $TRACE_PATH
209b934f
DG
198
199 # Returns once the application has at least fired ONE tracepoint.
200 start_test_app
201
ebaaaf5e 202 lttng_snapshot_record $SESSION_NAME
96340a01 203 stop_lttng_tracing_ok $SESSION_NAME
67b4c664 204 destroy_lttng_session_ok $SESSION_NAME
ebaaaf5e
JD
205
206 # Validate test
207 validate_trace $EVENT_NAME $TRACE_PATH/
208 if [ $? -eq 0 ]; then
209 # Only delete if successful
210 rm -rf $TRACE_PATH
ebaaaf5e 211 fi
209b934f 212
0fc2834c 213 stop_test_apps
ebaaaf5e
JD
214}
215
ae779dd6
MD
216function test_ust_local_snapshot_small_discard_buffers ()
217{
218 NR_ITER=10000
219 NR_USEC_WAIT=0
220 OLDCPUSET=$(taskset -p $$)
221
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
229
230 # Run test apps, wait for them to complete.
231 start_test_app
232 wait_test_apps
233
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"
238 rm -rf $TRACE_PATH/
239
240 # Run test apps, wait for them to complete.
241 start_test_app
242 wait_test_apps
243
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"
248 rm -rf $TRACE_PATH/
249
250 if [ x"$FIRST_LINE" != x"$FIRST_LINE_2" ]; then
251 fail "First snapshot event do not match."
252 else
253 pass "First snapshot event match."
254 fi
255
256 stop_lttng_tracing_ok $SESSION_NAME
257 destroy_lttng_session_ok $SESSION_NAME
258 taskset -p $OLDCPUSET $$ 1>/dev/null 2>&1
259}
260
261function test_ust_local_snapshot_small_overwrite_buffers ()
262{
263 NR_ITER=10000
264 NR_USEC_WAIT=0
265 OLDCPUSET=$(taskset -p $$)
266
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
274
275 # Run test apps, wait for them to complete.
276 start_test_app
277 wait_test_apps
278
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"
283 rm -rf $TRACE_PATH/
284
285 # Run test apps, wait for them to complete.
286 start_test_app
287 wait_test_apps
288
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"
293 rm -rf $TRACE_PATH/
294
295 if [ x"$FIRST_LINE" != x"$FIRST_LINE_2" ]; then
296 pass "First snapshot event do not match."
297 else
298 fail "First snapshot event match."
299 fi
300
301 stop_lttng_tracing_ok $SESSION_NAME
302 destroy_lttng_session_ok $SESSION_NAME
303 taskset -p $OLDCPUSET $$ 1>/dev/null 2>&1
304}
305
5e83c405
CB
306function test_ust_local_snapshot_max_size ()
307{
98342ba3 308 NR_ITER=-1
ae779dd6 309 NR_USEC_WAIT=100
034a7848 310 page_size=`getconf PAGE_SIZE`
1901f874 311 num_cpus=$(conf_proc_count)
5e83c405 312
034a7848
MJ
313 # The minimum subbuf size is the platform PAGE_SIZE
314 subbuf_size=$(($page_size*2))
315
5e83c405
CB
316 # The minimum size limit is min(subbuf_size) * nb_streams
317 max_size=$(($subbuf_size*$num_cpus))
318
319 diag "Test local UST snapshots with max size $max_size"
320 create_lttng_session_no_output $SESSION_NAME
321
322 enable_mmap_overwrite_subbuf_ust_channel $SESSION_NAME $CHANNEL_NAME $subbuf_size
323
c4926bb5 324 enable_ust_lttng_event_ok $SESSION_NAME $EVENT_NAME $CHANNEL_NAME
e563bbdb 325 start_lttng_tracing_ok $SESSION_NAME
5e83c405
CB
326
327 snapshot_add_output $SESSION_NAME "file://$TRACE_PATH" "" $max_size
328
209b934f
DG
329 # Returns once the application has at least fired ONE tracepoint.
330 start_test_app
5e83c405
CB
331
332 lttng_snapshot_record $SESSION_NAME
333
334 # Check file size
335 sum_size_tracefiles=$(find $TRACE_PATH -name "${CHANNEL_NAME}_*" \
336 -exec stat -c '%s' {} \; | awk '{s = s + $1}END{print s}')
337
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"
341 fi
342
343 pass "Tracefiles size sum validation"
344
96340a01 345 stop_lttng_tracing_ok $SESSION_NAME
67b4c664 346 destroy_lttng_session_ok $SESSION_NAME
5e83c405
CB
347
348 # Validate test
349 validate_trace $EVENT_NAME $TRACE_PATH/
350
351 if [ $? -eq 0 ]; then
352 # Only delete if successful
353 rm -rf $TRACE_PATH
354 fi
355
0fc2834c 356 stop_test_apps
5e83c405
CB
357}
358
a54047ec
JD
359function test_ust_local_snapshot_large_metadata ()
360{
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"
365
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
c4926bb5 369 enable_ust_lttng_event_ok $SESSION_NAME $LM_EVENT $CHANNEL_NAME
e563bbdb 370 start_lttng_tracing_ok $SESSION_NAME
b5633831 371 lttng_snapshot_add_output_ok $SESSION_NAME $TRACE_PATH
a54047ec
JD
372 $LM_BIN 1 1
373 ok $? "Start application to trace"
374 lttng_snapshot_record $SESSION_NAME
96340a01 375 stop_lttng_tracing_ok $SESSION_NAME
67b4c664 376 destroy_lttng_session_ok $SESSION_NAME
a54047ec
JD
377
378 # Validate test
379 validate_trace $LM_EVENT $TRACE_PATH/
380 if [ $? -eq 0 ]; then
381 # Only delete if successful
382 rm -rf $TRACE_PATH
a54047ec
JD
383 fi
384}
385
5f4c2d80
JD
386function enable_channel_per_uid_mmap_overwrite()
387{
388 sess_name=$1
389 channel_name=$2
390
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"
393}
394
395function test_ust_per_uid_local_snapshot ()
396{
98342ba3
JR
397 NR_ITER=-1
398 NR_USEC_WAIT=100
891d74dd 399 diag "Test per-uid local UST snapshots"
5f4c2d80
JD
400 create_lttng_session_no_output $SESSION_NAME
401 enable_channel_per_uid_mmap_overwrite $SESSION_NAME $CHANNEL_NAME
c4926bb5 402 enable_ust_lttng_event_ok $SESSION_NAME $EVENT_NAME $CHANNEL_NAME
e563bbdb 403 start_lttng_tracing_ok $SESSION_NAME
b5633831 404 lttng_snapshot_add_output_ok $SESSION_NAME $TRACE_PATH
209b934f
DG
405
406 # Returns once the application has at least fired ONE tracepoint.
407 start_test_app
408
5f4c2d80 409 lttng_snapshot_record $SESSION_NAME
96340a01 410 stop_lttng_tracing_ok $SESSION_NAME
67b4c664 411 destroy_lttng_session_ok $SESSION_NAME
5f4c2d80
JD
412
413 # Validate test
414 validate_trace $EVENT_NAME $TRACE_PATH/
415 if [ $? -eq 0 ]; then
416 # Only delete if successful
417 rm -rf $TRACE_PATH
5f4c2d80 418 fi
209b934f 419
0fc2834c 420 stop_test_apps
5f4c2d80
JD
421}
422
4f03c06d
JD
423function test_ust_per_uid_local_snapshot_post_mortem ()
424{
98342ba3 425 NR_ITER=-1
ae779dd6
MD
426 NR_USEC_WAIT=100
427
4f03c06d
JD
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
c4926bb5 431 enable_ust_lttng_event_ok $SESSION_NAME $EVENT_NAME $CHANNEL_NAME
e563bbdb 432 start_lttng_tracing_ok $SESSION_NAME
b5633831 433 lttng_snapshot_add_output_ok $SESSION_NAME $TRACE_PATH
209b934f
DG
434
435 # Returns once the application has at least fired ONE tracepoint.
436 start_test_app
0fc2834c 437 stop_test_apps
209b934f 438
4f03c06d 439 lttng_snapshot_record $SESSION_NAME
96340a01 440 stop_lttng_tracing_ok $SESSION_NAME
67b4c664 441 destroy_lttng_session_ok $SESSION_NAME
4f03c06d
JD
442
443 # Validate test
444 validate_trace $EVENT_NAME $TRACE_PATH/
445 if [ $? -eq 0 ]; then
446 # Only delete if successful
447 rm -rf $TRACE_PATH
4f03c06d
JD
448 fi
449}
450
1d20c959 451function test_ust_local_snapshots ()
ebaaaf5e 452{
98342ba3 453 NR_ITER=-1
ae779dd6
MD
454 NR_USEC_WAIT=100
455
1d20c959 456 diag "Test $NR_SNAPSHOT local UST snapshots"
ebaaaf5e
JD
457 create_lttng_session_no_output $SESSION_NAME
458 enable_lttng_mmap_overwrite_ust_channel $SESSION_NAME $CHANNEL_NAME
c4926bb5 459 enable_ust_lttng_event_ok $SESSION_NAME $EVENT_NAME $CHANNEL_NAME
e563bbdb 460 start_lttng_tracing_ok $SESSION_NAME
b5633831 461 lttng_snapshot_add_output_ok $SESSION_NAME $TRACE_PATH
209b934f
DG
462
463 # Returns once the application has at least fired ONE tracepoint.
464 start_test_app
465
1d20c959
DG
466 for i in $(seq 1 $NR_SNAPSHOT); do
467 diag "Snapshot $i/$NR_SNAPSHOT"
ebaaaf5e
JD
468 rm -rf $TRACE_PATH/snapshot/* 2>/dev/null
469 lttng_snapshot_record $SESSION_NAME
470 # Validate test
471 validate_trace $EVENT_NAME $TRACE_PATH/
472 if [ $? -eq 0 ]; then
473 # Only delete if successful
474 rm -rf $TRACE_PATH
ebaaaf5e
JD
475 fi
476 done
96340a01 477 stop_lttng_tracing_ok $SESSION_NAME
67b4c664 478 destroy_lttng_session_ok $SESSION_NAME
209b934f 479
0fc2834c 480 stop_test_apps
ebaaaf5e
JD
481}
482
483plan_tests $NUM_TESTS
484
485print_test_banner "$TEST_DESC"
486
ebaaaf5e 487start_lttng_sessiond
5e83c405
CB
488tests=( 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
ae779dd6
MD
494 test_ust_local_snapshots
495 test_ust_local_snapshot_small_discard_buffers
496 test_ust_local_snapshot_small_overwrite_buffers
497)
ebaaaf5e
JD
498
499for fct_test in ${tests[@]};
500do
501 SESSION_NAME=$(randstring 16 0)
502 ${fct_test}
ebaaaf5e
JD
503done
504
505stop_lttng_sessiond
This page took 0.064954 seconds and 5 git commands to generate.