Ensure "service vswitch status" returns appropriate error code
[sliver-openvswitch.git] / xenserver / etc_init.d_openvswitch
1 #!/bin/bash
2 #
3 # openvswitch
4 #
5 # chkconfig: 2345 09 91
6 # description: Manage Open vSwitch kernel modules and user-space daemons
7
8 # Copyright (C) 2009, 2010 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/openvswitch && . /etc/sysconfig/openvswitch
25
26 # General config variables in /etc/sysconfig/openvswitch
27 : ${ENABLE_BRCOMPAT:=y}
28 : ${ENABLE_FAKE_PROC_NET:=y}
29 : ${ENABLE_MONITOR:=y}
30 : ${FORCE_COREFILES:=y}
31
32 # Config variables specific to ovsdb-server
33 : ${OVSDB_SERVER_REMOTES:=punix:/var/run/openvswitch/db.sock db:Open_vSwitch,managers}
34 : ${OVSDB_SERVER_DB:=/etc/openvswitch/conf.db}
35 : ${OVSDB_SERVER_PIDFILE:=/var/run/openvswitch/ovsdb-server.pid}
36 : ${OVSDB_SERVER_RUN_DIR:=/var/xen/openvswitch}
37 : ${OVSDB_SERVER_PRIORITY:=-10}
38 : ${OVSDB_SERVER_LOGFILE:=/var/log/openvswitch/ovsdb-server.log}
39 : ${OVSDB_SERVER_FILE_LOGLEVEL:=INFO}
40 : ${OVSDB_SERVER_SYSLOG_LOGLEVEL:=ERR}
41 : ${OVSDB_SERVER_MEMLEAK_LOGFILE:=}
42 : ${OVSDB_SERVER_STRACE_LOG:=}
43 : ${OVSDB_SERVER_STRACE_OPT:=}
44 : ${OVSDB_SERVER_VALGRIND_LOG:=}
45 : ${OVSDB_SERVER_VALGRIND_OPT:=}
46
47 # Config variables specific to ovs-vswitchd
48 : ${VSWITCHD_OVSDB_SERVER:=unix:/var/run/openvswitch/db.sock}
49 : ${VSWITCHD_OVSDB_SCHEMA:=/usr/share/openvswitch/vswitch.ovsschema}
50 : ${VSWITCHD_PIDFILE:=/var/run/openvswitch/ovs-vswitchd.pid}
51 : ${VSWITCHD_RUN_DIR:=/var/xen/openvswitch}
52 : ${VSWITCHD_PRIORITY:=-10}
53 : ${VSWITCHD_MLOCKALL:=yes}
54 : ${VSWITCHD_LOGFILE:=/var/log/openvswitch/ovs-vswitchd.log}
55 : ${VSWITCHD_FILE_LOGLEVEL:=INFO}
56 : ${VSWITCHD_SYSLOG_LOGLEVEL:=ERR}
57 : ${VSWITCHD_MEMLEAK_LOGFILE:=}
58 : ${VSWITCHD_STRACE_LOG:=}
59 : ${VSWITCHD_STRACE_OPT:=}
60 : ${VSWITCHD_VALGRIND_LOG:=}
61 : ${VSWITCHD_VALGRIND_OPT:=}
62
63 # Config variables specific to ovs-brcompatd
64 : ${BRCOMPATD_PIDFILE:=/var/run/openvswitch/ovs-brcompatd.pid}
65 : ${BRCOMPATD_RUN_DIR:=/var/xen/openvswitch}
66 : ${BRCOMPATD_PRIORITY:=-10}
67 : ${BRCOMPATD_LOGFILE:=/var/log/openvswitch/ovs-brcompatd.log}
68 : ${BRCOMPATD_FILE_LOGLEVEL:=INFO}
69 : ${BRCOMPATD_SYSLOG_LOGLEVEL:=ERR}
70 : ${BRCOMPATD_MEMLEAK_LOGFILE:=}
71 : ${BRCOMPATD_STRACE_LOG:=}
72 : ${BRCOMPATD_STRACE_OPT:=}
73 : ${BRCOMPATD_VALGRIND_LOG:=}
74 : ${BRCOMPATD_VALGRIND_OPT:=}
75
76 # Full paths to executables & modules
77 ovsdb_server="/usr/sbin/ovsdb-server"
78 ovsdb_tool="/usr/bin/ovsdb-tool"
79 vswitchd="/usr/sbin/ovs-vswitchd"
80 brcompatd="/usr/sbin/ovs-brcompatd"
81 dpctl="/usr/bin/ovs-dpctl"
82 appctl="/usr/bin/ovs-appctl"
83 ofctl="/usr/bin/ovs-ofctl"
84 vsctl="/usr/bin/ovs-vsctl"
85
86 if [ "$ENABLE_FAKE_PROC_NET" = "y" ]; then
87     if [ "$ENABLE_BRCOMPAT" != "y" ]; then
88         warning "FAKE_PROC_NET required BRCOMPAT which was disabled.  Force enabling."
89         ENABLE_BRCOMPAT="y"
90     fi
91 fi
92
93 if test "$ENABLE_MONITOR" = "y"; then
94     monitor_opt="--monitor"
95 else
96     monitor_opt=
97 fi
98
99 function dp_list {
100     "$dpctl" show | grep '^dp[0-9]\+:' | cut -d':' -f 1
101 }
102
103 function turn_on_corefiles {
104     ulimit -Sc 67108864
105 }
106
107 function remove_all_dp {
108     for dp in $(dp_list); do
109         action "Removing datapath: $dp" "$dpctl" del-dp "$dp"
110     done
111 }
112
113 function insert_modules_if_required {
114     if ! lsmod | grep -q "openvswitch_mod"; then
115         action "Inserting llc module" modprobe llc
116         action "Inserting openvswitch module" modprobe openvswitch_mod
117     fi
118     if [ -n "$BRCOMPATD_PIDFILE" ] && ! lsmod | grep -q "brcompat_mod"; then
119         action "Inserting brcompat module" modprobe brcompat_mod
120     fi
121     if [ -f "/lib/modules/`uname -r`/kernel/net/openvswitch/ip_gre_mod.ko" ] && ! lsmod | grep -q "ip_gre_mod"; then
122         action "Inserting ip_gre module" modprobe ip_gre_mod
123     fi
124 }
125
126 function remove_modules {
127     if lsmod | grep -q "brcompat_mod"; then
128         action "Removing brcompat module" rmmod brcompat_mod.ko
129     fi
130     if lsmod | grep -q "openvswitch_mod"; then
131         action "Removing openvswitch module" rmmod openvswitch_mod.ko
132     fi
133     if lsmod | grep -q "ip_gre_mod"; then
134         action "Removing ip_gre module" rmmod ip_gre_mod.ko
135     fi
136 }
137
138 function start_ovsdb_server {
139     local syslog_opt="-vANY:SYSLOG:${OVSDB_SERVER_SYSLOG_LOGLEVEL}"
140     local logfile_file_opt=""
141     local logfile_level_opt=""
142     if [ ! -d "$OVSDB_SERVER_RUN_DIR" ]; then
143         install -d -m 755 -o root -g root "$OVSDB_SERVER_RUN_DIR"
144     fi
145     cd "$OVSDB_SERVER_RUN_DIR"
146     local remotes=
147     for remote in $OVSDB_SERVER_REMOTES; do
148         remotes="$remotes --remote=$remote"
149     done
150
151     install -d -m 755 -o root -g root `dirname $OVSDB_SERVER_LOGFILE`
152     if [ -n "$OVSDB_SERVER_FILE_LOGLEVEL" ]; then
153         logfile_level_opt="-vANY:FILE:${OVSDB_SERVER_FILE_LOGLEVEL}"
154         logfile_file_opt="--log-file=$OVSDB_SERVER_LOGFILE"
155     fi
156
157     local leak_opt=""
158     if [ -n "$OVSDB_SERVER_MEMLEAK_LOGFILE" ]; then
159         leak_opt="--check-leaks=$OVSDB_SERVER_MEMLEAK_LOGFILE"
160         if [ -e "$OVSDB_SERVER_MEMLEAK_LOGFILE" ]; then
161             mv "$OVSDB_SERVER_MEMLEAK_LOGFILE" "$OVSDB_SERVER_MEMLEAK_LOGFILE.prev"
162         fi
163     fi
164     local strace_opt=""
165     local daemonize="y"
166     if [ -n "$OVSDB_SERVER_STRACE_LOG" ] && [ -n "$OVSDB_SERVER_VALGRIND_LOG" ]; then
167         printf "Can not start with both VALGRIND and STRACE\n"
168         exit 1
169     fi
170     if [ -n "$OVSDB_SERVER_STRACE_LOG" ]; then
171         strace_opt="strace -o $OVSDB_SERVER_STRACE_LOG $OVSDB_SERVER_STRACE_OPT"
172         daemonize="n"
173     fi
174     if [ -n "$OVSDB_SERVER_VALGRIND_LOG" ]; then
175         valgrind_opt="valgrind --log-file=$OVSDB_SERVER_VALGRIND_LOG $OVSDB_SERVER_VALGRIND_OPT"
176         daemonize="n"
177     fi
178     ssl_opts="--private-key=db:SSL,private_key --certificate=db:SSL,certificate --bootstrap-ca-cert=db:SSL,ca_cert"
179     install -d -m 755 -o root -g root `dirname $OVSDB_SERVER_PIDFILE`
180     if [ "$daemonize" != "y" ]; then
181         # Start in background and force a "success" message
182         action "Starting ovsdb_server ($strace_opt$valgrind_opt)" true
183         (nice -n "$OVSDB_SERVER_PRIORITY" $strace_opt $valgrind_opt "$ovsdb_server" "$OVSDB_SERVER_DB" --pidfile="$OVSDB_SERVER_PIDFILE" --detach $monitor_opt --no-chdir -vANY:CONSOLE:EMER $syslog_opt $logfile_level_opt $logfile_file_opt $leak_opt $remotes $ssl_opts) &
184     else
185         action "Starting ovsdb-server" nice -n "$OVSDB_SERVER_PRIORITY" "$ovsdb_server" "$OVSDB_SERVER_DB" --pidfile="$OVSDB_SERVER_PIDFILE" --detach $monitor_opt --no-chdir -vANY:CONSOLE:EMER $syslog_opt $logfile_level_opt $logfile_file_opt $leak_opt $remotes $ssl_opts
186     fi
187 }
188
189 function start_vswitchd {
190     local syslog_opt="-vANY:SYSLOG:${VSWITCHD_SYSLOG_LOGLEVEL}"
191     local logfile_file_opt=""
192     local logfile_level_opt=""
193     if [ ! -d "$VSWITCHD_RUN_DIR" ]; then
194         install -d -m 755 -o root -g root "$VSWITCHD_RUN_DIR"
195     fi
196     cd "$VSWITCHD_RUN_DIR"
197
198     install -d -m 755 -o root -g root `dirname $VSWITCHD_LOGFILE`
199     if [ -n "$VSWITCHD_FILE_LOGLEVEL" ]; then
200         logfile_level_opt="-vANY:FILE:${VSWITCHD_FILE_LOGLEVEL}"
201         logfile_file_opt="--log-file=$VSWITCHD_LOGFILE"
202     fi
203
204     local leak_opt=""
205     if [ -n "$VSWITCHD_MEMLEAK_LOGFILE" ]; then
206         leak_opt="--check-leaks=$VSWITCHD_MEMLEAK_LOGFILE"
207         if [ -e "$VSWITCHD_MEMLEAK_LOGFILE" ]; then
208             mv "$VSWITCHD_MEMLEAK_LOGFILE" "$VSWITCHD_MEMLEAK_LOGFILE.prev"
209         fi
210     fi
211     local strace_opt=""
212     local daemonize="y"
213     if [ -n "$VSWITCHD_STRACE_LOG" ] && [ -n "$VSWITCHD_VALGRIND_LOG" ]; then
214         printf "Can not start with both VALGRIND and STRACE\n"
215         exit 1
216     fi
217     if [ -n "$VSWITCHD_STRACE_LOG" ]; then
218         strace_opt="strace -o $VSWITCHD_STRACE_LOG $VSWITCHD_STRACE_OPT"
219         daemonize="n"
220     fi
221     if [ -n "$VSWITCHD_VALGRIND_LOG" ]; then
222         valgrind_opt="valgrind --log-file=$VSWITCHD_VALGRIND_LOG $VSWITCHD_VALGRIND_OPT"
223         daemonize="n"
224     fi
225     local fake_proc_net_opt=""
226     if [ "$ENABLE_FAKE_PROC_NET" = "y" ]; then
227         fake_proc_net_opt="--fake-proc-net"
228     fi
229     if [ "$VSWITCHD_MLOCKALL" != "no" ]; then
230         mlockall_opt="--mlockall"
231     fi
232
233     install -d -m 755 -o root -g root `dirname $VSWITCHD_PIDFILE`
234     if [ "$daemonize" != "y" ]; then
235         # Start in background and force a "success" message
236         action "Starting ovs-vswitchd ($strace_opt$valgrind_opt)" true
237         (nice -n "$VSWITCHD_PRIORITY" $strace_opt $valgrind_opt "$vswitchd" --pidfile="$VSWITCHD_PIDFILE" --detach $monitor_opt --no-chdir $fake_proc_net_opt -vANY:CONSOLE:EMER $syslog_opt $logfile_level_opt $logfile_file_opt $leak_opt $mlockall_opt "$VSWITCHD_OVSDB_SERVER") &
238     else
239         action "Starting ovs-vswitchd" nice -n "$VSWITCHD_PRIORITY" "$vswitchd" --pidfile="$VSWITCHD_PIDFILE" --detach $monitor_opt --no-chdir $fake_proc_net_opt -vANY:CONSOLE:EMER $syslog_opt $logfile_level_opt $logfile_file_opt $leak_opt $mlockall_opt "$VSWITCHD_OVSDB_SERVER"
240     fi
241 }
242
243 function start_brcompatd {
244     local syslog_opt="-vANY:SYSLOG:${BRCOMPATD_SYSLOG_LOGLEVEL}"
245     local logfile_file_opt=""
246     local logfile_level_opt=""
247     if [ -d "$BRCOMPATD_RUN_DIR" ]; then
248         install -d -m 755 -o root -g root "$BRCOMPATD_RUN_DIR"
249     fi
250     cd "$BRCOMPATD_RUN_DIR"
251
252     install -d -m 755 -o root -g root `dirname $BRCOMPATD_LOGFILE`
253     if [ -n "$BRCOMPATD_FILE_LOGLEVEL" ]; then
254         logfile_level_opt="-vANY:FILE:${BRCOMPATD_FILE_LOGLEVEL}"
255         logfile_file_opt="--log-file=$BRCOMPATD_LOGFILE"
256     fi
257
258     local leak_opt=""
259     if [ -n "$BRCOMPATD_MEMLEAK_LOGFILE" ]; then
260         leak_opt="--check-leaks=$BRCOMPATD_MEMLEAK_LOGFILE"
261         if [ -e "$BRCOMPATD_MEMLEAK_LOGFILE" ]; then
262             mv "$BRCOMPATD_MEMLEAK_LOGFILE" "$BRCOMPATD_MEMLEAK_LOGFILE.prev"
263         fi
264     fi
265     local strace_opt=""
266     local daemonize="y"
267     if [ -n "$BRCOMPATD_STRACE_LOG" ] && [ -n "$BRCOMPATD_VALGRIND_LOG" ]; then
268         printf "Can not start with both VALGRIND and STRACE\n"
269         exit 1
270     fi
271     if [ -n "$BRCOMPATD_STRACE_LOG" ]; then
272         strace_opt="strace -o $BRCOMPATD_STRACE_LOG $BRCOMPATD_STRACE_OPT"
273         daemonize="n"
274     fi
275     if [ -n "$VALGRIND_LOG" ]; then
276         valgrind_opt="valgrind --log-file=$BRCOMPATD_VALGRIND_LOG $BRCOMPATD_VALGRIND_OPT"
277         daemonize="n"
278     fi
279     appctl_cmd="$appctl --target=/var/run/openvswitch/ovs-vswitchd.\`cat $VSWITCHD_PIDFILE\`.ctl %s"
280
281     install -d -m 755 -o root -g root `dirname $BRCOMPATD_PIDFILE`
282     if [ "$daemonize" != "y" ]; then
283         # Start in background and force a "success" message
284         action "Starting ovs-brcompatd ($strace_opt$valgrind_opt)" true
285         (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_OVSDB_SERVER") &
286     else
287         action "Starting ovs-brcompatd" nice -n "$BRCOMPATD_PRIORITY" $strace_opt $valgrind_opt "$brcompatd" --no-chdir --appctl-command="$appctl_cmd" --pidfile=$BRCOMPATD_PIDFILE --detach $monitor_opt -vANY:CONSOLE:EMER $syslog_opt $logfile_level_opt $logfile_file_opt $leak_opt "$VSWITCHD_OVSDB_SERVER"
288     fi
289 }
290
291 function stop_ovsdb_server {
292     if [ -f "$OVSDB_SERVER_PIDFILE" ]; then
293         local pid=$(cat "$OVSDB_SERVER_PIDFILE")
294         action "Killing ovsdb-server ($pid)" kill -TERM $pid
295         rm -f "$OVSDB_SERVER_PIDFILE"
296     fi
297 }
298
299 function stop_vswitchd {
300     if [ -f "$VSWITCHD_PIDFILE" ]; then
301         local pid=$(cat "$VSWITCHD_PIDFILE")
302         action "Killing ovs-vswitchd ($pid)" kill -TERM $pid
303         rm -f "$VSWITCHD_PIDFILE"
304     fi
305 }
306
307 function stop_brcompatd {
308     if [ -f "$BRCOMPATD_PIDFILE" ]; then
309         local pid=$(cat "$BRCOMPATD_PIDFILE")
310         action "Killing ovs-brcompatd ($pid)" kill -TERM $pid
311         rm -f "$BRCOMPATD_PIDFILE"
312     fi
313 }
314
315 function restart_approval {
316     if test ! -t 0; then
317         # Don't prompt if invoked non-interactively.
318         return 0
319     fi
320     cat <<EOF
321
322 WARNING!!!
323
324 Restarting Open vSwitch on a live server is not guaranteed to work.  It is
325 provided as a convenience for those situations in which it does work.
326
327 EOF
328     read -s -r -n 1 -p "Countinue with restart (y/N): " response
329     printf "\n"
330     case "$response" in
331         y|Y)
332             return 0
333             ;;
334         *)
335             return 1
336             ;;
337     esac
338 }
339
340 function set_system_uuid {
341     system_uuid=$(. /etc/xensource-inventory && echo $INSTALLATION_UUID)
342     if test -n "$system_uuid"; then
343         action "Configuring Open vSwitch system UUID" true
344         $vsctl --no-wait set Open_vSwitch . external-ids:system-uuid="$system_uuid"
345     else
346         action "Configuring Open vSwitch system UUID" false
347     fi
348 }
349
350 function start {
351     if [ "$FORCE_COREFILES" = "y" ]; then
352         turn_on_corefiles
353     fi
354
355     insert_modules_if_required
356
357     # Increase the limit on the number of open file descriptors since
358     # ovs-vswitchd needs a few per bridge
359     ulimit -n 4096
360
361     # Allow GRE traffic.
362     iptables -I INPUT -p gre -j ACCEPT
363
364     if [ ! -e "$OVSDB_SERVER_DB" ]; then
365         warning "$OVSDB_SERVER_DB does not exist"
366         install -d -m 755 -o root -g root `dirname $OVSDB_SERVER_DB`
367
368         action "Creating empty database $OVSDB_SERVER_DB" true
369         $ovsdb_tool -vANY:console:emer create "$OVSDB_SERVER_DB" "$VSWITCHD_OVSDB_SCHEMA"
370     else
371         # Upgrade or downgrade schema and compact database.
372         $ovsdb_tool -vANY:console:emer convert "$OVSDB_SERVER_DB" "$VSWITCHD_OVSDB_SCHEMA"
373     fi
374
375     start_ovsdb_server
376     $vsctl --no-wait init
377     if [ ! -e /var/run/openvswitch.booted ]; then
378         touch /var/run/openvswitch.booted
379         for bridge in $($vsctl list-br); do
380             $vsctl --no-wait del-br $bridge
381         done
382     fi
383
384     set_system_uuid
385
386     start_vswitchd
387     if [ "${ENABLE_BRCOMPAT}" = "y" ] ; then
388         start_brcompatd
389     fi
390     touch /var/lock/subsys/openvswitch
391 }
392
393 function stop {
394     stop_brcompatd
395     stop_vswitchd
396     stop_ovsdb_server
397     rm -f /var/lock/subsys/openvswitch
398 }
399
400 function restart {
401     if restart_approval; then
402         stop
403         start
404     fi
405 }
406
407 case "$1" in
408     start)
409         start
410         ;;
411     stop)
412         stop
413         ;;
414     restart)
415         restart
416         ;;
417     strace-vswitchd)
418         shift
419         strace -p $(cat "$VSWITCHD_PIDFILE") "$@"
420         ;;
421     strace-brcompatd)
422         shift
423         strace -p $(cat "$BRCOMPATD_PIDFILE") "$@"
424         ;;
425     status)
426         status -p "$OVSDB_SERVER_PIDFILE" ovsdb-server &&
427         status -p "$VSWITCHD_PIDFILE" ovs-vswitchd &&
428         (test "$ENABLE_BRCOMPAT" != "y" || 
429             status -p "$BRCOMPATD_PIDFILE" ovs-brcompatd)
430         ;;
431     version)
432         /usr/sbin/ovsdb-server -V
433         /usr/sbin/ovs-vswitchd -V
434         /usr/sbin/ovs-brcompatd -V
435         ;;
436     help)
437         printf "openvswitch [start|stop|restart|unload|status|version]\n"
438         ;;
439     *)
440         printf "Unknown command: $1\n"
441         exit 1
442         ;;
443 esac