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