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