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