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