xenserver: Improve readability of /etc/init.d scripts.
[sliver-openvswitch.git] / xenserver / etc_init.d_vswitch
1 #!/bin/bash
2 #
3 # vswitch
4 #
5 # chkconfig: 2345 09 91
6 # description: Manage vswitch kernel modules and user-space daemon
7
8 # Copyright (C) 2009 Nicira Networks, Inc.
9 #
10 # Licensed under the Apache License, Version 2.0 (the "License");
11 # you may not use this file except in compliance with the License.
12 # You may obtain a copy of the License at:
13 #
14 #     http://www.apache.org/licenses/LICENSE-2.0
15 #
16 # Unless required by applicable law or agreed to in writing, software
17 # distributed under the License is distributed on an "AS IS" BASIS,
18 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
19 # See the License for the specific language governing permissions and
20 # limitations under the License.
21
22 . /etc/init.d/functions
23
24 test -e /etc/sysconfig/vswitch && . /etc/sysconfig/vswitch
25
26 # General config variables in /etc/sysconfig/vswitch
27 : ${VSWITCH_BASE:=/root/vswitch}
28 : ${ENABLE_BRCOMPAT:=y}
29 : ${ENABLE_FAKE_PROC_NET:=y}
30 : ${FORCE_COREFILES:=y}
31
32 # Config variables specific to ovs-vswitchd
33 : ${VSWITCHD_CONF:=/etc/ovs-vswitchd.conf}
34 : ${VSWITCHD_PIDFILE:=/var/run/ovs-vswitchd.pid}
35 : ${VSWITCHD_RUN_DIR:=/var/xen/vswitch}
36 : ${VSWITCHD_PRIORITY:=-5}
37 : ${VSWITCHD_NETBACK_PRIORITY:=0}
38 : ${VSWITCHD_LOGFILE:=/var/log/ovs-vswitchd.log}
39 : ${VSWITCHD_FILE_LOGLEVEL:=}
40 : ${VSWITCHD_SYSLOG_LOGLEVEL:=WARN}
41 : ${VSWITCHD_MEMLEAK_LOGFILE:=}
42 : ${VSWITCHD_STRACE_LOG:=}
43 : ${VSWITCHD_STRACE_OPT:=}
44 : ${VSWITCHD_VALGRIND_LOG:=}
45 : ${VSWITCHD_VALGRIND_OPT:=}
46
47 # Config variables specific to ovs-brcompatd
48 : ${BRCOMPATD_PIDFILE:=/var/run/ovs-brcompatd.pid}
49 : ${BRCOMPATD_RUN_DIR:=/var/xen/vswitch}
50 : ${BRCOMPATD_PRIORITY:=-5}
51 : ${BRCOMPATD_LOGFILE:=/var/log/ovs-brcompatd.log}
52 : ${BRCOMPATD_FILE_LOGLEVEL:=}
53 : ${BRCOMPATD_SYSLOG_LOGLEVEL:=INFO}
54 : ${BRCOMPATD_MEMLEAK_LOGFILE:=}
55 : ${BRCOMPATD_STRACE_LOG:=}
56 : ${BRCOMPATD_STRACE_OPT:=}
57 : ${BRCOMPATD_VALGRIND_LOG:=}
58 : ${BRCOMPATD_VALGRIND_OPT:=}
59
60 # Full paths to executables & modules
61 vswitchd="$VSWITCH_BASE/sbin/ovs-vswitchd"
62 brcompatd="$VSWITCH_BASE/sbin/ovs-brcompatd"
63 dpctl="$VSWITCH_BASE/bin/ovs-dpctl"
64 appctl="$VSWITCH_BASE/bin/ovs-appctl"
65 ofctl="$VSWITCH_BASE/bin/ovs-ofctl"
66
67
68 if [ "$ENABLE_FAKE_PROC_NET" = "y" ]; then
69     if [ "$ENABLE_BRCOMPAT" != "y" ]; then
70         warning "FAKE_PROC_NET required BRCOMPAT which was disabled.  Force enabling."
71         ENABLE_BRCOMPAT="y"
72     fi
73 fi
74
75 function dp_list {
76     "$dpctl" show | grep '^dp[0-9]\+:' | cut -d':' -f 1
77 }
78
79 function turn_on_corefiles {
80     ulimit -Sc 67108864
81 }
82
83 function remove_all_dp {
84     for dp in $(dp_list); do
85         action "Removing datapath: $dp" "$dpctl" del-dp "$dp"
86     done
87 }
88
89 function insert_modules_if_required {
90     if ! lsmod | grep -q "openvswitch_mod"; then
91         action "Inserting llc module" modprobe llc
92         action "Inserting openvswitch module" insmod $VSWITCH_BASE/kernel_modules/openvswitch_mod.ko
93     fi
94     if [ -n "$BRCOMPATD_PIDFILE" ] && ! lsmod | grep -q "brcompat_mod"; then
95         action "Inserting brcompat module" insmod $VSWITCH_BASE/kernel_modules/brcompat_mod.ko
96     fi
97 }
98
99 function remove_modules {
100     if lsmod | grep -q "brcompat_mod"; then
101         action "Removing brcompat module" rmmod brcompat_mod.ko
102     fi
103     if lsmod | grep -q "openvswitch_mod"; then
104         action "Removing openvswitch module" rmmod openvswitch_mod.ko
105     fi
106 }
107
108 function reload_vswitchd {
109     if [ -f "$VSWITCHD_PIDFILE" ]; then
110         "$appctl" \
111             --target=ovs-vswitchd.$(cat "$VSWITCHD_PIDFILE").ctl \
112             --execute=vswitchd/reload
113     fi
114 }
115
116 function quietly {
117     "$@" > /dev/null
118 }
119
120 # renice_netback PRIORITY PID [PID...]
121 #
122 # Renices the netback processes given as each PID to nice level PRIORITY.
123 function renice_netback {
124     local pri=$1
125     shift
126
127     if test $# = 0; then
128         warning "Netback not running, nothing to renice"
129         return
130     fi
131
132     for pid
133     do
134         action "Renicing netback (pid $pid) to priority $pri" quietly renice $pri -p $pid
135     done
136 }
137
138 function start_vswitchd {
139     local syslog_opt="-vANY:SYSLOG:${VSWITCHD_SYSLOG_LOGLEVEL}"
140     local logfile_file_opt=""
141     local logfile_level_opt=""
142     if [ ! -d "$VSWITCHD_RUN_DIR" ]; then
143         mkdir -p "$VSWITCHD_RUN_DIR"
144     fi
145     cd "$VSWITCHD_RUN_DIR"
146     if [ -n "$VSWITCHD_FILE_LOGLEVEL" ]; then
147         logfile_level_opt="-vANY:FILE:${VSWITCHD_FILE_LOGLEVEL}"
148         logfile_file_opt="--log-file=$VSWITCHD_LOGFILE"
149     fi
150     local leak_opt=""
151     if [ -n "$VSWITCHD_MEMLEAK_LOGFILE" ]; then
152         leak_opt="--check-leaks=$VSWITCHD_MEMLEAK_LOGFILE"
153         if [ -e "$VSWITCHD_MEMLEAK_LOGFILE" ]; then
154             mv "$VSWITCHD_MEMLEAK_LOGFILE" "$VSWITCHD_MEMLEAK_LOGFILE.prev"
155         fi
156     fi
157     local strace_opt=""
158     local daemonize="y"
159     if [ -n "$VSWITCHD_STRACE_LOG" ] && [ -n "$VSWITCHD_VALGRIND_LOG" ]; then
160         printf "Can not start with both VALGRIND and STRACE\n"
161         exit 1
162     fi
163     if [ -n "$VSWITCHD_STRACE_LOG" ]; then
164         strace_opt="strace -o $VSWITCHD_STRACE_LOG $VSWITCHD_STRACE_OPT"
165         daemonize="n"
166     fi
167     if [ -n "$VSWITCHD_VALGRIND_LOG" ]; then
168         valgrind_opt="valgrind --log-file=$VSWITCHD_VALGRIND_LOG $VSWITCHD_VALGRIND_OPT"
169         daemonize="n"
170     fi
171     local fake_proc_net_opt=""
172     if [ "$ENABLE_FAKE_PROC_NET" = "y" ]; then
173         fake_proc_net_opt="--fake-proc-net"
174     fi
175     if [ "$VSWITCHD_NETBACK_PRIORITY" != default ]; then
176         renice_netback $VSWITCHD_NETBACK_PRIORITY $(pidof netback)
177     else
178         warning "Netback renicing disabled (see /etc/sysconfig/vswitch)"
179     fi
180     if [ "$daemonize" != "y" ]; then
181         # Start in background and force a "success" message
182         action "Starting ovs-vswitchd ($strace_opt$valgrind_opt)" true
183         (nice -n "$VSWITCHD_PRIORITY" $strace_opt $valgrind_opt "$vswitchd" --pidfile="$VSWITCHD_PIDFILE" --detach --no-chdir $fake_proc_net_opt -vANY:CONSOLE:EMER $syslog_opt $logfile_level_opt $logfile_file_opt $leak_opt "$VSWITCHD_CONF") &
184     else
185         action "Starting ovs-vswitchd" nice -n "$VSWITCHD_PRIORITY" "$vswitchd" --pidfile="$VSWITCHD_PIDFILE" --detach --no-chdir $fake_proc_net_opt -vANY:CONSOLE:EMER $syslog_opt $logfile_level_opt $logfile_file_opt $leak_opt "$VSWITCHD_CONF"
186     fi
187 }
188
189 function start_brcompatd {
190     local syslog_opt="-vANY:SYSLOG:${BRCOMPATD_SYSLOG_LOGLEVEL}"
191     local logfile_file_opt=""
192     local logfile_level_opt=""
193     if [ -d "$BRCOMPATD_RUN_DIR" ]; then
194         mkdir -p "$BRCOMPATD_RUN_DIR"
195     fi
196     cd "$BRCOMPATD_RUN_DIR"
197     if [ ! -n "$BRCOMPATD_FILE_LOGLEVEL" ]; then
198         logfile_level_opt="-vANY:FILE:${BRCOMPATD_FILE_LOGLEVEL}"
199         logfile_file_opt="--log-file=$BRCOMPATD_LOGFILE"
200     fi
201     local leak_opt=""
202     if [ -n "$BRCOMPATD_MEMLEAK_LOG" ]; then
203         leak_opt="--check-leaks=$BRCOMPATD_MEMLEAK_LOGFILE"
204         if [ -e "$BRCOMPATD_MEMLEAK_LOGFILE" ]; then
205             mv "$BRCOMPATD_MEMLEAK_LOGFILE" "$BRCOMPATD_MEMLEAK_LOGFILE.prev"
206         fi
207     fi
208     local strace_opt=""
209     local daemonize="y"
210     if [ -n "$BRCOMPATD_STRACE_LOG" ] && [ -n "$BRCOMPATD_VALGRIND_LOG" ]; then
211         printf "Can not start with both VALGRIND and STRACE\n"
212         exit 1
213     fi
214     if [ -n "$BRCOMPATD_STRACE_LOG" ]; then
215         strace_opt="strace -o $BRCOMPATD_STRACE_LOG $BRCOMPATD_STRACE_OPT"
216         daemonize="n"
217     fi
218     if [ -n "$VALGRIND_LOG" ]; then
219         valgrind_opt="valgrind --log-file=$BRCOMPATD_VALGRIND_LOG $BRCOMPATD_VALGRIND_OPT"
220         daemonize="n"
221     fi
222     appctl_cmd="$appctl -t /var/run/ovs-vswitchd.\`cat $VSWITCHD_PIDFILE\`.ctl -e '%s'"
223     if [ "$daemonize" != "y" ]; then
224         # Start in background and force a "success" message
225         action "Starting ovs-brcompatd ($strace_opt$valgrind_opt)" true
226         (nice -n "$VSWITCHD_PRIORITY" $strace_opt $valgrind_opt "$brcompatd"--no-chdir --appctl-command="$appctl_cmd" --pidfile=$BRCOMPATD_PIDFILE -vANY:CONSOLE:EMER $syslog_opt $logfile_level_opt $logfile_file_opt $leak_opt "$VSWITCHD_CONF") &
227     else
228         action "Starting ovs-brcompatd" nice -n "$BRCOMPATD_PRIORITY" $strace_opt $valgrind_opt "$brcompatd" --no-chdir --appctl-command="$appctl_cmd" --pidfile=$BRCOMPATD_PIDFILE --detach -vANY:CONSOLE:EMER $syslog_opt $logfile_level_opt $logfile_file_opt $leak_opt "$VSWITCHD_CONF"
229     fi
230 }
231
232 function stop_vswitchd {
233     if [ -f "$VSWITCHD_PIDFILE" ]; then
234         local pid=$(cat "$VSWITCHD_PIDFILE")
235         action "Killing ovs-vswitchd ($pid)" kill -TERM $pid
236         rm -f "$VSWITCHD_PIDFILE"
237     fi
238 }
239
240 function stop_brcompatd {
241     if [ -f "$BRCOMPATD_PIDFILE" ]; then
242         local pid=$(cat "$BRCOMPATD_PIDFILE")
243         action "Killing ovs-brcompatd ($pid)" kill -TERM $pid
244         rm -f "$BRCOMPATD_PIDFILE"
245     fi
246 }
247
248 function restart_approval {
249     if test ! -t 0; then
250         # Don't prompt if invoked non-interactively.
251         return 0
252     fi
253     cat <<EOF
254
255 WARNING!!!
256
257 Restarting vswitch on a live server is not guaranteed to work.  It is
258 provided as a convenience for those situations in which it does work.
259 If you just want to reload the configuration file, use "reload"
260 instead of restart.
261
262 EOF
263     read -s -r -n 1 -p "Countinue with restart (y/N): " response
264     printf "\n"
265     case "$response" in
266         y|Y)
267             return 0
268             ;;
269         *)
270             return 1
271             ;;
272     esac
273 }
274
275 function start {
276     if [ "$FORCE_COREFILES" = "y" ]; then
277         turn_on_corefiles
278     fi
279
280     insert_modules_if_required
281
282     # Increase the limit on the number of open file descriptors since
283     # ovs-vswitchd needs a few per bridge
284     ulimit -n 4096
285
286     if [ ! -e "$VSWITCHD_CONF" ]; then
287         warning "$VSWITCHD_CONF does not exist"
288         action "Creating empty $VSWITCHD_CONF" touch "$VSWITCHD_CONF"
289     fi
290
291     start_vswitchd
292     start_brcompatd
293     reload_vswitchd  # ensures ovs-vswitchd has fully read config file.
294 }
295
296 function stop {
297     stop_brcompatd
298     stop_vswitchd
299 }
300
301 function restart {
302     if restart_approval; then
303         stop
304         start
305     fi
306 }
307
308 case "$1" in
309     start)
310         start
311         ;;
312     stop)
313         stop
314         ;;
315     restart)
316         restart
317         ;;
318     reload)
319         reload_vswitchd
320         ;;
321     strace-vswitchd)
322         shift
323         strace -p $(cat "$VSWITCHD_PIDFILE") "$@"
324         ;;
325     strace-brcompatd)
326         shift
327         strace -p $(cat "$BRCOMPATD_PIDFILE") "$@"
328         ;;
329     status)
330         status -p ovs-vswitchd.pid ovs-vswitchd
331         status -p ovs-brcompatd.pid ovs-brcompatd
332         ;;
333     version)
334         "$VSWITCH_BASE"/sbin/ovs-vswitchd -V
335         "$VSWITCH_BASE"/sbin/ovs-brcompatd -V
336         ;;
337     help)
338         printf "vswitch [start|stop|restart|reload|unload|status|version]\n"
339         ;;
340     *)
341         printf "Unknown command: $1\n"
342         exit 1
343         ;;
344 esac