Fix: tests: wait for consumerd to complete
[lttng-tools.git] / tests / utils / utils.sh
1 #!/src/bin/bash
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
18 SESSIOND_BIN="lttng-sessiond"
19 CONSUMERD_BIN="lttng-consumerd"
20 RELAYD_BIN="lttng-relayd"
21 LTTNG_BIN="lttng"
22 BABELTRACE_BIN="babeltrace"
23
24 # Minimal kernel version supported for session daemon tests
25 KERNEL_MAJOR_VERSION=2
26 KERNEL_MINOR_VERSION=6
27 KERNEL_PATCHLEVEL_VERSION=27
28
29 source $TESTDIR/utils/tap/tap.sh
30
31 function 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
41 function 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
51 function print_test_banner ()
52 {
53 desc="$1"
54 diag "$desc"
55 }
56
57 function 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
72 # Generate a random string
73 # $1 = number of characters; defaults to 16
74 # $2 = include special characters; 1 = yes, 0 = no; defaults to yes
75 function randstring()
76 {
77 [ "$2" == "0" ] && CHAR="[:alnum:]" || CHAR="[:graph:]"
78 cat /dev/urandom | tr -cd "$CHAR" | head -c ${1:-16}
79 echo
80 }
81
82 function lttng_enable_kernel_event
83 {
84 sess_name=$1
85 event_name=$2
86 channel_name=$3
87
88 if [ -z $event_name ]; then
89 # Enable all event if no event name specified
90 event_name="-a"
91 fi
92
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
101 ok $? "Enable kernel event $event_name for session $sess_name"
102 }
103
104 function start_lttng_relayd
105 {
106 local opt=$1
107
108 DIR=$(readlink -f $TESTDIR)
109
110 if [ -z $(pidof lt-$RELAYD_BIN) ]; then
111 $DIR/../src/bin/lttng-relayd/$RELAYD_BIN $opt >/dev/null 2>&1 &
112 #$DIR/../src/bin/lttng-relayd/$RELAYD_BIN $opt -vvv >>/tmp/relayd.log 2>&1 &
113 if [ $? -eq 1 ]; then
114 fail "Start lttng-relayd (opt: $opt)"
115 return 1
116 else
117 pass "Start lttng-relayd (opt: $opt)"
118 fi
119 else
120 pass "Start lttng-relayd (opt: $opt)"
121 fi
122 }
123
124 function stop_lttng_relayd
125 {
126 PID_RELAYD=`pidof lt-$RELAYD_BIN`
127
128 kill $PID_RELAYD >/dev/null 2>&1
129
130 if [ $? -eq 1 ]; then
131 fail "Kill lttng-relayd (pid: $PID_RELAYD)"
132 return 1
133 else
134 out=1
135 while [ -n "$out" ]; do
136 out=$(pidof lt-$RELAYD_BIN)
137 sleep 0.5
138 done
139 pass "Kill lttng-relayd (pid: $PID_RELAYD)"
140 return 0
141 fi
142 }
143
144 function start_lttng_sessiond()
145 {
146 if [ -n $TEST_NO_SESSIOND ] && [ "$TEST_NO_SESSIOND" == "1" ]; then
147 # Env variable requested no session daemon
148 return
149 fi
150
151 validate_kernel_version
152 if [ $? -ne 0 ]; then
153 fail "Start session daemon"
154 BAIL_OUT "*** Kernel too old for session daemon tests ***"
155 fi
156
157 DIR=$(readlink -f $TESTDIR)
158
159 if [ -z $(pidof lt-$SESSIOND_BIN) ]; then
160 $DIR/../src/bin/lttng-sessiond/$SESSIOND_BIN --daemonize --consumerd32-path="$DIR/../src/bin/lttng-consumerd/lttng-consumerd" --consumerd64-path="$DIR/../src/bin/lttng-consumerd/lttng-consumerd"
161 #$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 &
162 status=$?
163 ok $status "Start session daemon"
164 fi
165 }
166
167 function stop_lttng_sessiond ()
168 {
169 if [ -n $TEST_NO_SESSIOND ] && [ "$TEST_NO_SESSIOND" == "1" ]; then
170 # Env variable requested no session daemon
171 return
172 fi
173
174 PID_SESSIOND=`pidof lt-$SESSIOND_BIN`
175
176 kill $PID_SESSIOND >/dev/null 2>&1
177
178 if [ $? -eq 1 ]; then
179 fail "Kill sessions daemon"
180 return 1
181 else
182 out=1
183 while [ -n "$out" ]; do
184 out=$(pidof lt-$SESSIOND_BIN)
185 sleep 0.5
186 done
187 out=1
188 while [ -n "$out" ]; do
189 out=$(pidof $CONSUMERD_BIN)
190 sleep 0.5
191 done
192 pass "Kill session daemon"
193 fi
194 }
195
196 function create_lttng_session_no_output ()
197 {
198 sess_name=$1
199
200 $TESTDIR/../src/bin/lttng/$LTTNG_BIN create $sess_name --no-output >/dev/null 2>&1
201 ok $? "Create session $sess_name in no-output mode"
202 }
203
204 function create_lttng_session ()
205 {
206 sess_name=$1
207 trace_path=$2
208
209 $TESTDIR/../src/bin/lttng/$LTTNG_BIN create $sess_name -o $trace_path >/dev/null 2>&1
210 ok $? "Create session $sess_name in $trace_path"
211 }
212
213 function enable_ust_lttng_channel()
214 {
215 sess_name=$1
216 channel_name=$2
217
218 $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-channel -u $channel_name -s $sess_name >/dev/null 2>&1
219 ok $? "Enable channel $channel_name for session $sess_name"
220 }
221
222 function disable_ust_lttng_channel()
223 {
224 sess_name=$1
225 channel_name=$2
226
227 $TESTDIR/../src/bin/lttng/$LTTNG_BIN disable-channel -u $channel_name -s $sess_name >/dev/null 2>&1
228 ok $? "Disable channel $channel_name for session $sess_name"
229 }
230
231 function enable_lttng_mmap_overwrite_kernel_channel()
232 {
233 sess_name=$1
234 channel_name=$2
235
236 $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-channel -s $sess_name $channel_name -k --output mmap --overwrite >/dev/null 2>&1
237 ok $? "Enable channel $channel_name for session $sess_name"
238 }
239
240 function enable_lttng_mmap_overwrite_ust_channel()
241 {
242 sess_name=$1
243 channel_name=$2
244
245 $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-channel -s $sess_name $channel_name -u --output mmap --overwrite >/dev/null 2>&1
246 ok $? "Enable channel $channel_name for session $sess_name"
247 }
248
249 function enable_ust_lttng_event ()
250 {
251 sess_name=$1
252 event_name="$2"
253 channel_name=$3
254
255 if [ -z $channel_name ]; then
256 # default channel if none specified
257 chan=""
258 else
259 chan="-c $channel_name"
260 fi
261
262 $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event "$event_name" $chan -s $sess_name -u >/dev/null 2>&1
263 ok $? "Enable event $event_name for session $sess_name"
264 }
265
266 function enable_jul_lttng_event()
267 {
268 sess_name=$1
269 event_name="$2"
270 channel_name=$3
271
272 if [ -z $channel_name ]; then
273 # default channel if none specified
274 chan=""
275 else
276 chan="-c $channel_name"
277 fi
278
279 $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event "$event_name" $chan -s $sess_name -j >/dev/null 2>&1
280 ok $? "Enable JUL event $event_name for session $sess_name"
281 }
282
283 function enable_ust_lttng_event_filter()
284 {
285 sess_name="$1"
286 event_name="$2"
287 filter="$3"
288
289 $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event "$event_name" -s $sess_name -u --filter "$filter" >/dev/null 2>&1
290 ok $? "Enable event $event_name with filtering for session $sess_name"
291 }
292
293 function enable_ust_lttng_event_loglevel()
294 {
295 sess_name="$1"
296 event_name="$2"
297 loglevel="$3"
298
299 $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event "$event_name" -s $sess_name -u --loglevel $loglevel >/dev/null 2>&1
300 ok $? "Enable event $event_name with loglevel $loglevel"
301 }
302
303 function enable_ust_lttng_event_loglevel_only()
304 {
305 sess_name="$1"
306 event_name="$2"
307 loglevel="$3"
308
309 $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event "$event_name" -s $sess_name -u --loglevel-only $loglevel >/dev/null 2>&1
310 ok $? "Enable event $event_name with loglevel-only $loglevel"
311 }
312
313 function disable_ust_lttng_event ()
314 {
315 sess_name="$1"
316 event_name="$2"
317
318 $TESTDIR/../src/bin/lttng/$LTTNG_BIN disable-event "$event_name" -s $sess_name -u >/dev/null 2>&1
319 ok $? "Disable event $event_name for session $sess_name"
320 }
321
322 function start_lttng_tracing ()
323 {
324 sess_name=$1
325
326 $TESTDIR/../src/bin/lttng/$LTTNG_BIN start $sess_name >/dev/null 2>&1
327 ok $? "Start tracing for session $sess_name"
328 }
329
330 function stop_lttng_tracing ()
331 {
332 sess_name=$1
333
334 $TESTDIR/../src/bin/lttng/$LTTNG_BIN stop $sess_name >/dev/null 2>&1
335 ok $? "Stop lttng tracing for session $sess_name"
336 }
337
338 function destroy_lttng_session ()
339 {
340 sess_name=$1
341
342
343 $TESTDIR/../src/bin/lttng/$LTTNG_BIN destroy $sess_name >/dev/null 2>&1
344 ok $? "Destroy lttng session $sess_name"
345 }
346
347 function lttng_snapshot_add_output ()
348 {
349 sess_name=$1
350 trace_path=$2
351
352 $TESTDIR/../src/bin/lttng/$LTTNG_BIN snapshot add-output -s $sess_name file://$trace_path >/dev/null 2>&1
353 ok $? "Added snapshot output file://$trace_path"
354 }
355
356 function lttng_snapshot_del_output ()
357 {
358 local sess_name=$1
359 local id=$2
360
361 $TESTDIR/../src/bin/lttng/$LTTNG_BIN snapshot del-output -s $sess_name $id >/dev/null 2>&1
362 ok $? "Deleted snapshot output id $id"
363 }
364
365 function lttng_snapshot_record ()
366 {
367 sess_name=$1
368 trace_path=$2
369
370 $TESTDIR/../src/bin/lttng/$LTTNG_BIN snapshot record -s $sess_name >/dev/null 2>&1
371 ok $? "Snapshot recorded"
372 }
373
374 function trace_matches ()
375 {
376 event_name=$1
377 nr_iter=$2
378 trace_path=$3
379
380 which $BABELTRACE_BIN >/dev/null
381 skip $? -ne 0 "Babeltrace binary not found. Skipping trace matches"
382
383 count=$($BABELTRACE_BIN $trace_path | grep $event_name | wc -l)
384
385 if [ "$count" -ne "$nr_iter" ]; then
386 fail "Trace match"
387 diag "$count events found in trace"
388 else
389 pass "Trace match"
390 fi
391 }
392
393 function validate_trace
394 {
395 event_name=$1
396 trace_path=$2
397
398 which $BABELTRACE_BIN >/dev/null
399 if [ $? -ne 0 ]; then
400 skip 0 "Babeltrace binary not found. Skipping trace validation"
401 fi
402
403 OLDIFS=$IFS
404 IFS=","
405 for i in $event_name; do
406 traced=$($BABELTRACE_BIN $trace_path 2>/dev/null | grep $i | wc -l)
407 if [ "$traced" -ne 0 ]; then
408 pass "Validate trace for event $i, $traced events"
409 else
410 fail "Validate trace for event $i"
411 diag "Found $traced occurences of $i"
412 fi
413 done
414 ret=$?
415 IFS=$OLDIFS
416 return $ret
417 }
This page took 0.040482 seconds and 5 git commands to generate.