ovs-ctl: Add support for running daemons under valgrind or strace.
[openvswitch] / utilities / ovs-lib.in
1 # This is a shell function library sourced by some Open vSwitch scripts.
2 # It is not intended to be invoked on its own.
3
4 # Copyright (C) 2009, 2010, 2011, 2012 Nicira, Inc.
5 #
6 # Licensed under the Apache License, Version 2.0 (the "License");
7 # you may not use this file except in compliance with the License.
8 # You may obtain a copy of the License at:
9 #
10 #     http://www.apache.org/licenses/LICENSE-2.0
11 #
12 # Unless required by applicable law or agreed to in writing, software
13 # distributed under the License is distributed on an "AS IS" BASIS,
14 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 # See the License for the specific language governing permissions and
16 # limitations under the License.
17
18 ## ----------------- ##
19 ## configure options ##
20 ## ----------------- ##
21
22 # All of these should be substituted by the Makefile at build time.
23 logdir=${OVS_LOGDIR-'@LOGDIR@'}                 # /var/log/openvswitch
24 rundir=${OVS_RUNDIR-'@RUNDIR@'}                 # /var/run/openvswitch
25 sysconfdir=${OVS_SYSCONFDIR-'@sysconfdir@'}     # /etc
26 etcdir=$sysconfdir/openvswitch                  # /etc/openvswitch
27 datadir=${OVS_PKGDATADIR-'@pkgdatadir@'}        # /usr/share/openvswitch
28 bindir=${OVS_BINDIR-'@bindir@'}                 # /usr/bin
29 sbindir=${OVS_SBINDIR-'@sbindir@'}              # /usr/sbin
30
31 VERSION='@VERSION@'
32
33 LC_ALL=C; export LC_ALL
34
35 ## ------------- ##
36 ## LSB functions ##
37 ## ------------- ##
38
39 # Use the system's own implementations if it has any.
40 if test -e /etc/init.d/functions; then
41     . /etc/init.d/functions
42 elif test -e /etc/rc.d/init.d/functions; then
43     . /etc/rc.d/init.d/functions
44 elif test -e /lib/lsb/init-functions; then
45     . /lib/lsb/init-functions
46 fi
47
48 # Implement missing functions (e.g. OpenSUSE lacks 'action').
49 if type log_success_msg >/dev/null 2>&1; then :; else
50     log_success_msg () {
51         printf '%s.\n' "$*"
52     }
53 fi
54 if type log_failure_msg >/dev/null 2>&1; then :; else
55     log_failure_msg () {
56         printf '%s ... failed!\n' "$*"
57     }
58 fi
59 if type log_warning_msg >/dev/null 2>&1; then :; else
60     log_warning_msg () {
61         printf '%s ... (warning).\n' "$*"
62     }
63 fi
64 if type action >/dev/null 2>&1; then :; else
65     action () {
66        STRING=$1
67        shift
68        "$@"
69        rc=$?
70        if test $rc = 0; then
71             log_success_msg "$STRING"
72        else
73             log_failure_msg "$STRING"
74        fi
75        return $rc
76     }
77 fi
78
79 ## ------- ##
80 ## Daemons ##
81 ## ------- ##
82
83 pid_exists () {
84     # This is better than "kill -0" because it doesn't require permission to
85     # send a signal (so daemon_status in particular works as non-root).
86     test -d /proc/"$1"
87 }
88
89 start_daemon () {
90     priority=$1
91     wrapper=$2
92     shift; shift
93     daemon=$1
94
95     # drop core files in a sensible place
96     test -d "$DAEMON_CWD" || install -d -m 755 -o root -g root "$DAEMON_CWD"
97     set "$@" --no-chdir
98     cd "$DAEMON_CWD"
99
100     # log file
101     test -d "$logdir" || install -d -m 755 -o root -g root "$logdir"
102     set "$@" --log-file="$logdir/$daemon.log"
103
104     # pidfile and monitoring
105     test -d "$rundir" || install -d -m 755 -o root -g root "$rundir"
106     set "$@" --pidfile="$rundir/$daemon.pid"
107     set "$@" --detach --monitor
108
109     # wrapper
110     case $wrapper in
111         valgrind)
112             if (valgrind --version) > /dev/null 2>&1; then
113                 set valgrind -q --leak-check=full \
114                     --log-file="$logdir/$daemon.valgrind.log.%p" "$@"
115             else
116                 log_failure_msg "valgrind not installed, running $daemon without it"
117             fi
118             ;;
119         strace)
120             if (strace -V) > /dev/null 2>&1; then
121                 set strace -D -ff -o "$logdir/$daemon.strace.log" "$@"
122             else
123                 log_failure_msg "strace not installed, running $daemon without it"
124             fi
125             ;;
126         '')
127             ;;
128         *)
129             log_failure_msg "unknown wrapper $wrapper, running $daemon without it"
130             ;;
131     esac
132
133     # priority
134     if test X"$priority" != X; then
135         set nice -n "$priority" "$@"
136     fi
137
138     action "Starting $daemon" "$@"
139 }
140
141 DAEMON_CWD=/
142 stop_daemon () {
143     if test -e "$rundir/$1.pid"; then
144         if pid=`cat "$rundir/$1.pid"`; then
145             for action in TERM .1 .25 .65 1 1 1 1 KILL 1 1 1 1 FAIL; do
146                 case $action in
147                     TERM)
148                         action "Killing $1 ($pid)" kill $pid
149                         ;;
150                     KILL)
151                         action "Killing $1 ($pid) with SIGKILL" kill -9 $pid
152                         ;;
153                     FAIL)
154                         log_failure_msg "Killing $1 ($pid) failed"
155                         return 1
156                         ;;
157                     *)
158                         if pid_exists $pid >/dev/null 2>&1; then
159                             sleep $action
160                         else
161                             return 0
162                         fi
163                         ;;
164                 esac
165             done
166         fi
167     fi
168     log_success_msg "$1 is not running"
169 }
170
171 daemon_status () {
172     pidfile=$rundir/$1.pid
173     if test -e "$pidfile"; then
174         if pid=`cat "$pidfile"`; then
175             if pid_exists "$pid"; then
176                 echo "$1 is running with pid $pid"
177                 return 0
178             else
179                 echo "Pidfile for $1 ($pidfile) is stale"
180             fi
181         else
182             echo "Pidfile for $1 ($pidfile) exists but cannot be read"
183         fi
184     else
185         echo "$1 is not running"
186     fi
187     return 1
188 }
189
190 daemon_is_running () {
191     pidfile=$rundir/$1.pid
192     test -e "$pidfile" && pid=`cat "$pidfile"` && pid_exists "$pid"
193 } >/dev/null 2>&1