Fix: set UST register timeout to -1 as test default
[lttng-tools.git] / tests / utils / utils.sh
CommitLineData
10a8a223 1#!/src/bin/bash
d3e8f6bb
DG
2#
3# Copyright (C) - 2012 David Goulet <dgoulet@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
17
18SESSIOND_BIN="lttng-sessiond"
f7613992 19CONSUMERD_BIN="lttng-consumerd"
f4e40ab6 20RELAYD_BIN="lttng-relayd"
d3e8f6bb
DG
21LTTNG_BIN="lttng"
22BABELTRACE_BIN="babeltrace"
23
fd4dfcec
DG
24# Minimal kernel version supported for session daemon tests
25KERNEL_MAJOR_VERSION=2
26KERNEL_MINOR_VERSION=6
27KERNEL_PATCHLEVEL_VERSION=27
28
4074c1df
MD
29# We set the default UST register timeout to "wait forever", so that
30# basic tests don't have to worry about hitting timeouts on busy
31# systems. Specialized tests should test those corner-cases.
32export LTTNG_UST_REGISTER_TIMEOUT=-1
33
29655db7
CB
34source $TESTDIR/utils/tap/tap.sh
35
fec81a7e
CB
36function print_ok ()
37{
38 # Check if we are a terminal
39 if [ -t 1 ]; then
40 echo -e "\e[1;32mOK\e[0m"
41 else
42 echo -e "OK"
43 fi
44}
45
46function print_fail ()
47{
48 # Check if we are a terminal
49 if [ -t 1 ]; then
50 echo -e "\e[1;31mFAIL\e[0m"
51 else
52 echo -e "FAIL"
53 fi
54}
55
56function print_test_banner ()
57{
58 desc="$1"
29655db7 59 diag "$desc"
fec81a7e
CB
60}
61
fd4dfcec
DG
62function validate_kernel_version ()
63{
64 kern_version=($(uname -r | awk -F. '{ printf("%d.%d.%d\n",$1,$2,$3); }' | tr '.' '\n'))
65 if [ ${kern_version[0]} -gt $KERNEL_MAJOR_VERSION ]; then
66 return 0
67 fi
68 if [ ${kern_version[1]} -gt $KERNEL_MINOR_VERSION ]; then
69 return 0
70 fi
71 if [ ${kern_version[2]} -ge $KERNEL_PATCHLEVEL_VERSION ]; then
72 return 0
73 fi
74 return 1
75}
76
9ac429ef 77# Generate a random string
f4e40ab6
DG
78# $1 = number of characters; defaults to 16
79# $2 = include special characters; 1 = yes, 0 = no; defaults to yes
9ac429ef 80function randstring()
f4e40ab6
DG
81{
82 [ "$2" == "0" ] && CHAR="[:alnum:]" || CHAR="[:graph:]"
83 cat /dev/urandom | tr -cd "$CHAR" | head -c ${1:-16}
84 echo
85}
86
f4e40ab6
DG
87function lttng_enable_kernel_event
88{
89 sess_name=$1
90 event_name=$2
07b86b52 91 channel_name=$3
f4e40ab6
DG
92
93 if [ -z $event_name ]; then
94 # Enable all event if no event name specified
29655db7 95 event_name="-a"
f4e40ab6
DG
96 fi
97
07b86b52
JD
98 if [ -z $channel_name ]; then
99 # default channel if none specified
100 chan=""
101 else
102 chan="-c $channel_name"
103 fi
104
105 $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event "$event_name" $chan -s $sess_name -k >/dev/null 2>&1
29655db7 106 ok $? "Enable kernel event $event_name for session $sess_name"
f4e40ab6
DG
107}
108
fb3268e3 109function start_lttng_relayd
f4e40ab6 110{
198e7caf 111 local opt=$1
173af62f 112
f4e40ab6
DG
113 DIR=$(readlink -f $TESTDIR)
114
115 if [ -z $(pidof lt-$RELAYD_BIN) ]; then
6f137cef 116 $DIR/../src/bin/lttng-relayd/$RELAYD_BIN -b $opt >/dev/null 2>&1
25a818af 117 #$DIR/../src/bin/lttng-relayd/$RELAYD_BIN $opt -vvv >>/tmp/relayd.log 2>&1 &
f4e40ab6 118 if [ $? -eq 1 ]; then
29655db7 119 fail "Start lttng-relayd (opt: $opt)"
f4e40ab6
DG
120 return 1
121 else
29655db7 122 pass "Start lttng-relayd (opt: $opt)"
f4e40ab6
DG
123 fi
124 else
29655db7 125 pass "Start lttng-relayd (opt: $opt)"
f4e40ab6
DG
126 fi
127}
128
1fb23888 129function stop_lttng_relayd_nocheck
f4e40ab6
DG
130{
131 PID_RELAYD=`pidof lt-$RELAYD_BIN`
132
1fb23888 133 diag "Killing lttng-relayd (pid: $PID_RELAYD)"
f4e40ab6 134 kill $PID_RELAYD >/dev/null 2>&1
1fb23888 135 retval=$?
29655db7 136
1fb23888 137 if [ $retval -eq 1 ]; then
f4e40ab6
DG
138 out=1
139 while [ -n "$out" ]; do
140 out=$(pidof lt-$RELAYD_BIN)
141 sleep 0.5
142 done
1fb23888
MD
143 fi
144 return $retval
145}
146
147function stop_lttng_relayd
148{
149 stop_lttng_relayd_nocheck
150
151 if [ $? -eq 1 ]; then
152 fail "Killed lttng-relayd (pid: $PID_RELAYD)"
153 return 1
154 else
155 pass "Killed lttng-relayd (pid: $PID_RELAYD)"
f4e40ab6
DG
156 return 0
157 fi
158}
159
fb3268e3 160function start_lttng_sessiond()
355f483d
DG
161{
162 if [ -n $TEST_NO_SESSIOND ] && [ "$TEST_NO_SESSIOND" == "1" ]; then
163 # Env variable requested no session daemon
164 return
165 fi
166
29655db7
CB
167 validate_kernel_version
168 if [ $? -ne 0 ]; then
169 fail "Start session daemon"
170 BAIL_OUT "*** Kernel too old for session daemon tests ***"
355f483d
DG
171 fi
172
29655db7 173 DIR=$(readlink -f $TESTDIR)
d3d97763
JG
174 : ${LTTNG_SESSION_CONFIG_XSD_PATH=${DIR}/../src/common/config/}
175 export LTTNG_SESSION_CONFIG_XSD_PATH
29655db7
CB
176
177 if [ -z $(pidof lt-$SESSIOND_BIN) ]; then
d7b63d8c 178 $DIR/../src/bin/lttng-sessiond/$SESSIOND_BIN --background --consumerd32-path="$DIR/../src/bin/lttng-consumerd/lttng-consumerd" --consumerd64-path="$DIR/../src/bin/lttng-consumerd/lttng-consumerd"
d4607bc6 179 #$DIR/../src/bin/lttng-sessiond/$SESSIOND_BIN --background --consumerd32-path="$DIR/../src/bin/lttng-consumerd/lttng-consumerd" --consumerd64-path="$DIR/../src/bin/lttng-consumerd/lttng-consumerd" --verbose-consumer >>/tmp/sessiond.log 2>&1
29655db7 180 status=$?
29655db7
CB
181 ok $status "Start session daemon"
182 fi
355f483d
DG
183}
184
fb3268e3 185function stop_lttng_sessiond ()
d3e8f6bb 186{
355f483d
DG
187 if [ -n $TEST_NO_SESSIOND ] && [ "$TEST_NO_SESSIOND" == "1" ]; then
188 # Env variable requested no session daemon
189 return
190 fi
191
d3e8f6bb
DG
192 PID_SESSIOND=`pidof lt-$SESSIOND_BIN`
193
d3e8f6bb 194 kill $PID_SESSIOND >/dev/null 2>&1
29655db7 195
d3e8f6bb 196 if [ $? -eq 1 ]; then
29655db7 197 fail "Kill sessions daemon"
d3e8f6bb
DG
198 return 1
199 else
5fa32580
DG
200 out=1
201 while [ -n "$out" ]; do
202 out=$(pidof lt-$SESSIOND_BIN)
203 sleep 0.5
204 done
f7613992
MD
205 out=1
206 while [ -n "$out" ]; do
207 out=$(pidof $CONSUMERD_BIN)
208 sleep 0.5
209 done
29655db7 210 pass "Kill session daemon"
d3e8f6bb
DG
211 fi
212}
213
07b86b52
JD
214function create_lttng_session_no_output ()
215{
216 sess_name=$1
217
218 $TESTDIR/../src/bin/lttng/$LTTNG_BIN create $sess_name --no-output >/dev/null 2>&1
219 ok $? "Create session $sess_name in no-output mode"
220}
221
d3e8f6bb
DG
222function create_lttng_session ()
223{
224 sess_name=$1
225 trace_path=$2
226
10a8a223 227 $TESTDIR/../src/bin/lttng/$LTTNG_BIN create $sess_name -o $trace_path >/dev/null 2>&1
29655db7 228 ok $? "Create session $sess_name in $trace_path"
d4018451
DG
229}
230
29655db7 231function enable_ust_lttng_channel()
d4018451
DG
232{
233 sess_name=$1
234 channel_name=$2
235
29655db7
CB
236 $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-channel -u $channel_name -s $sess_name >/dev/null 2>&1
237 ok $? "Enable channel $channel_name for session $sess_name"
d4018451
DG
238}
239
29655db7 240function disable_ust_lttng_channel()
d4018451
DG
241{
242 sess_name=$1
243 channel_name=$2
244
29655db7
CB
245 $TESTDIR/../src/bin/lttng/$LTTNG_BIN disable-channel -u $channel_name -s $sess_name >/dev/null 2>&1
246 ok $? "Disable channel $channel_name for session $sess_name"
d3e8f6bb
DG
247}
248
07b86b52
JD
249function enable_lttng_mmap_overwrite_kernel_channel()
250{
251 sess_name=$1
252 channel_name=$2
253
254 $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-channel -s $sess_name $channel_name -k --output mmap --overwrite >/dev/null 2>&1
255 ok $? "Enable channel $channel_name for session $sess_name"
256}
257
ebaaaf5e
JD
258function enable_lttng_mmap_overwrite_ust_channel()
259{
260 sess_name=$1
261 channel_name=$2
262
263 $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-channel -s $sess_name $channel_name -u --output mmap --overwrite >/dev/null 2>&1
264 ok $? "Enable channel $channel_name for session $sess_name"
265}
266
d3e8f6bb
DG
267function enable_ust_lttng_event ()
268{
269 sess_name=$1
26b53d3b 270 event_name="$2"
ebaaaf5e
JD
271 channel_name=$3
272
273 if [ -z $channel_name ]; then
274 # default channel if none specified
275 chan=""
276 else
277 chan="-c $channel_name"
278 fi
d3e8f6bb 279
ebaaaf5e 280 $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event "$event_name" $chan -s $sess_name -u >/dev/null 2>&1
29655db7 281 ok $? "Enable event $event_name for session $sess_name"
26b53d3b
DG
282}
283
37175ce4
DG
284function enable_jul_lttng_event()
285{
286 sess_name=$1
287 event_name="$2"
288 channel_name=$3
289
290 if [ -z $channel_name ]; then
291 # default channel if none specified
292 chan=""
293 else
294 chan="-c $channel_name"
295 fi
296
297 $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event "$event_name" $chan -s $sess_name -j >/dev/null 2>&1
298 ok $? "Enable JUL event $event_name for session $sess_name"
299}
300
b2064f54
DG
301function enable_jul_lttng_event_loglevel()
302{
303 sess_name=$1
304 event_name="$2"
305 loglevel=$3
306 channel_name=$4
307
308 if [ -z $channel_name ]; then
309 # default channel if none specified
310 chan=""
311 else
312 chan="-c $channel_name"
313 fi
314
315 $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event --loglevel $loglevel "$event_name" $chan -s $sess_name -j >/dev/null 2>&1
316 ok $? "Enable JUL event $event_name for session $sess_name with loglevel $loglevel"
317}
318
26b53d3b
DG
319function enable_ust_lttng_event_filter()
320{
321 sess_name="$1"
322 event_name="$2"
323 filter="$3"
26b53d3b 324
29655db7
CB
325 $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event "$event_name" -s $sess_name -u --filter "$filter" >/dev/null 2>&1
326 ok $? "Enable event $event_name with filtering for session $sess_name"
26b53d3b
DG
327}
328
329function enable_ust_lttng_event_loglevel()
330{
331 sess_name="$1"
332 event_name="$2"
333 loglevel="$3"
26b53d3b 334
29655db7
CB
335 $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event "$event_name" -s $sess_name -u --loglevel $loglevel >/dev/null 2>&1
336 ok $? "Enable event $event_name with loglevel $loglevel"
26b53d3b
DG
337}
338
339function enable_ust_lttng_event_loglevel_only()
340{
341 sess_name="$1"
342 event_name="$2"
343 loglevel="$3"
26b53d3b 344
29655db7
CB
345 $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event "$event_name" -s $sess_name -u --loglevel-only $loglevel >/dev/null 2>&1
346 ok $? "Enable event $event_name with loglevel-only $loglevel"
26b53d3b
DG
347}
348
349function disable_ust_lttng_event ()
350{
907b42de
DG
351 sess_name="$1"
352 event_name="$2"
26b53d3b 353
907b42de 354 $TESTDIR/../src/bin/lttng/$LTTNG_BIN disable-event "$event_name" -s $sess_name -u >/dev/null 2>&1
29655db7 355 ok $? "Disable event $event_name for session $sess_name"
d3e8f6bb
DG
356}
357
5ddababf
DG
358function disable_jul_lttng_event ()
359{
360 local sess_name="$1"
361 local event_name="$2"
362
363 $TESTDIR/../src/bin/lttng/$LTTNG_BIN disable-event "$event_name" -s $sess_name -j >/dev/null 2>&1
364 ok $? "Disable JUL event $event_name for session $sess_name"
365}
366
fb3268e3 367function start_lttng_tracing ()
d3e8f6bb
DG
368{
369 sess_name=$1
370
10a8a223 371 $TESTDIR/../src/bin/lttng/$LTTNG_BIN start $sess_name >/dev/null 2>&1
29655db7 372 ok $? "Start tracing for session $sess_name"
d3e8f6bb
DG
373}
374
fb3268e3 375function stop_lttng_tracing ()
d3e8f6bb
DG
376{
377 sess_name=$1
378
10a8a223 379 $TESTDIR/../src/bin/lttng/$LTTNG_BIN stop $sess_name >/dev/null 2>&1
29655db7 380 ok $? "Stop lttng tracing for session $sess_name"
d3e8f6bb
DG
381}
382
383function destroy_lttng_session ()
384{
385 sess_name=$1
386
29655db7 387
10a8a223 388 $TESTDIR/../src/bin/lttng/$LTTNG_BIN destroy $sess_name >/dev/null 2>&1
29655db7 389 ok $? "Destroy lttng session $sess_name"
d3e8f6bb
DG
390}
391
07b86b52
JD
392function lttng_snapshot_add_output ()
393{
394 sess_name=$1
395 trace_path=$2
396
397 $TESTDIR/../src/bin/lttng/$LTTNG_BIN snapshot add-output -s $sess_name file://$trace_path >/dev/null 2>&1
398 ok $? "Added snapshot output file://$trace_path"
399}
400
26402e0c
DG
401function lttng_snapshot_del_output ()
402{
403 local sess_name=$1
404 local id=$2
405
406 $TESTDIR/../src/bin/lttng/$LTTNG_BIN snapshot del-output -s $sess_name $id >/dev/null 2>&1
407 ok $? "Deleted snapshot output id $id"
408}
409
07b86b52
JD
410function lttng_snapshot_record ()
411{
412 sess_name=$1
413 trace_path=$2
414
415 $TESTDIR/../src/bin/lttng/$LTTNG_BIN snapshot record -s $sess_name >/dev/null 2>&1
416 ok $? "Snapshot recorded"
417}
418
e02b109b
DG
419function lttng_save()
420{
421 local sess_name=$1
422 local opts=$2
423
424 $TESTDIR/../src/bin/lttng/$LTTNG_BIN save $sess_name $opts >/dev/null 2>&1
425 ok $? "Session successfully saved"
426}
427
428function lttng_load()
429{
430 local opts=$1
431
432 $TESTDIR/../src/bin/lttng/$LTTNG_BIN load $opts >/dev/null 2>&1
433 ok $? "Load command successful"
434}
435
d3e8f6bb
DG
436function trace_matches ()
437{
438 event_name=$1
439 nr_iter=$2
440 trace_path=$3
441
317eef93 442 which $BABELTRACE_BIN >/dev/null
29655db7 443 skip $? -ne 0 "Babeltrace binary not found. Skipping trace matches"
d3e8f6bb
DG
444
445 count=$($BABELTRACE_BIN $trace_path | grep $event_name | wc -l)
29655db7 446
d3e8f6bb 447 if [ "$count" -ne "$nr_iter" ]; then
29655db7
CB
448 fail "Trace match"
449 diag "$count events found in trace"
d3e8f6bb 450 else
29655db7 451 pass "Trace match"
d3e8f6bb
DG
452 fi
453}
f4e40ab6
DG
454
455function validate_trace
456{
457 event_name=$1
458 trace_path=$2
459
460 which $BABELTRACE_BIN >/dev/null
29655db7
CB
461 if [ $? -ne 0 ]; then
462 skip 0 "Babeltrace binary not found. Skipping trace validation"
f4e40ab6
DG
463 fi
464
07b86b52
JD
465 OLDIFS=$IFS
466 IFS=","
467 for i in $event_name; do
468 traced=$($BABELTRACE_BIN $trace_path 2>/dev/null | grep $i | wc -l)
469 if [ "$traced" -ne 0 ]; then
ebaaaf5e 470 pass "Validate trace for event $i, $traced events"
07b86b52
JD
471 else
472 fail "Validate trace for event $i"
473 diag "Found $traced occurences of $i"
474 fi
475 done
476 ret=$?
477 IFS=$OLDIFS
478 return $ret
f4e40ab6 479}
3910e60d
DG
480
481function trace_match_only()
482{
483 local event_name=$1
484 local nr_iter=$2
485 local trace_path=$3
486
487 which $BABELTRACE_BIN >/dev/null
488 skip $? -ne 0 "Babeltrace binary not found. Skipping trace matches"
489
490 local count=$($BABELTRACE_BIN $trace_path | grep $event_name | wc -l)
491 local total=$($BABELTRACE_BIN $trace_path | wc -l)
492
493 if [ "$nr_iter" -eq "$count" ] && [ "$total" -eq "$nr_iter" ]; then
494 pass "Trace match with $total event $event_name"
495 else
496 fail "Trace match"
497 diag "$total event(s) found, expecting $nr_iter of event $event_name and only found $count"
498 fi
499}
This page took 0.056487 seconds and 4 git commands to generate.