ovs-vswitchd: Add --mlockall option and enable on XenServer.
[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="${VSWITCH_BASE:-/root/vswitch}"
28 ENABLE_BRCOMPAT="${ENABLE_BRCOMPAT:-y}"
29 ENABLE_FAKE_PROC_NET="${ENABLE_FAKE_PROC_NET:-y}"
30 FORCE_COREFILES="${FORCE_COREFILES:-y}"
31
32 # Config variables specific to ovs-vswitchd
33 VSWITCHD_CONF="${VSWITCHD_CONF:-/etc/ovs-vswitchd.conf}"
34 VSWITCHD_PIDFILE="${VSWITCHD_PIDFILE:-/var/run/ovs-vswitchd.pid}"
35 VSWITCHD_RUN_DIR="${VSWITCHD_RUN_DIR:-/var/xen/vswitch}"
36 VSWITCHD_PRIORITY="${VSWITCHD_PRIORITY:--10}"
37 VSWITCHD_MLOCKALL="${VSWITCHD_MLOCKALL:-yes}"
38 VSWITCHD_LOGFILE="${VSWITCHD_LOGFILE:-/var/log/ovs-vswitchd.log}"
39 VSWITCHD_FILE_LOGLEVEL="${VSWITCHD_FILE_LOGLEVEL:-INFO}"
40 VSWITCHD_SYSLOG_LOGLEVEL="${VSWITCHD_SYSLOG_LOGLEVEL:-ERR}"
41 VSWITCHD_MEMLEAK_LOGFILE="${VSWITCHD_MEMLEAK_LOGFILE:-}"
42 VSWITCHD_STRACE_LOG="${VSWITCHD_STRACE_LOG:-}"
43 VSWITCHD_STRACE_OPT="${VSWITCHD_STRACE_OPT:-}"
44 VSWITCHD_VALGRIND_LOG="${VSWITCHD_VALGRIND_LOG:-}"
45 VSWITCHD_VALGRIND_OPT="${VSWITCHD_VALGRIND_OPT:-}"
46
47 # Config variables specific to ovs-brcompatd
48 BRCOMPATD_PIDFILE="${BRCOMPATD_PIDFILE:-/var/run/ovs-brcompatd.pid}"
49 BRCOMPATD_RUN_DIR="${BRCOMPATD_RUN_DIR:-/var/xen/vswitch}"
50 BRCOMPATD_PRIORITY="${BRCOMPATD_PRIORITY:--10}"
51 BRCOMPATD_LOGFILE="${BRCOMPATD_LOGFILE:-/var/log/ovs-brcompatd.log}"
52 BRCOMPATD_FILE_LOGLEVEL="${BRCOMPATD_FILE_LOGLEVEL:-INFO}"
53 BRCOMPATD_SYSLOG_LOGLEVEL="${BRCOMPATD_SYSLOG_LOGLEVEL:-ERR}"
54 BRCOMPATD_MEMLEAK_LOGFILE="${BRCOMPATD_MEMLEAK_LOGFILE:-}"
55 BRCOMPATD_STRACE_LOG="${BRCOMPATD_STRACE_LOG:-}"
56 BRCOMPATD_STRACE_OPT="${BRCOMPATD_STRACE_OPT:-}"
57 BRCOMPATD_VALGRIND_LOG="${BRCOMPATD_VALGRIND_LOG:-}"
58 BRCOMPATD_VALGRIND_OPT="${BRCOMPATD_VALGRIND_OPT:-}"
59
60
61
62
63 # Full paths to executables & modules
64 vswitchd="$VSWITCH_BASE/sbin/ovs-vswitchd"
65 brcompatd="$VSWITCH_BASE/sbin/ovs-brcompatd"
66 dpctl="$VSWITCH_BASE/bin/ovs-dpctl"
67 appctl="$VSWITCH_BASE/bin/ovs-appctl"
68 ofctl="$VSWITCH_BASE/bin/ovs-ofctl"
69
70
71 if [ "$ENABLE_FAKE_PROC_NET" = "y" ]; then
72     if [ "$ENABLE_BRCOMPAT" != "y" ]; then
73         warning "FAKE_PROC_NET required BRCOMPAT which was disabled.  Force enabling."
74         ENABLE_BRCOMPAT="y"
75     fi
76 fi
77
78 function dp_list {
79     "$dpctl" show | grep '^dp[0-9]\+:' | cut -d':' -f 1
80 }
81
82 function turn_on_corefiles {
83     ulimit -Sc 67108864
84 }
85
86 function remove_all_dp {
87     for dp in $(dp_list); do
88         action "Removing datapath: $dp" "$dpctl" del-dp "$dp"
89     done
90 }
91
92 function insert_modules_if_required {
93     if ! lsmod | grep -q "openvswitch_mod"; then
94         action "Inserting llc module" modprobe llc
95         action "Inserting openvswitch module" insmod $VSWITCH_BASE/kernel_modules/openvswitch_mod.ko
96     fi
97     if [ -n "$BRCOMPATD_PIDFILE" ] && ! lsmod | grep -q "brcompat_mod"; then
98         action "Inserting brcompat module" insmod $VSWITCH_BASE/kernel_modules/brcompat_mod.ko
99     fi
100 }
101
102 function remove_modules {
103     if lsmod | grep -q "brcompat_mod"; then
104         action "Removing brcompat module" rmmod brcompat_mod.ko
105     fi
106     if lsmod | grep -q "openvswitch_mod"; then
107         action "Removing openvswitch module" rmmod openvswitch_mod.ko
108     fi
109 }
110
111 function reload_vswitchd {
112     if [ -f "$VSWITCHD_PIDFILE" ]; then
113         "$appctl" \
114             --target=ovs-vswitchd.$(cat "$VSWITCHD_PIDFILE").ctl \
115             --execute=vswitchd/reload
116     fi
117 }
118
119 function reload_brcompatd {
120     if [ -f "$BRCOMPATD_PIDFILE" ]; then
121         "$appctl" \
122             --target=ovs-brcompatd.$(cat "$BRCOMPATD_PIDFILE").ctl --reopen
123     fi
124 }
125
126 function start_vswitchd {
127     local syslog_opt="-vANY:SYSLOG:${VSWITCHD_SYSLOG_LOGLEVEL}"
128     local logfile_file_opt=""
129     local logfile_level_opt=""
130     if [ ! -d "$VSWITCHD_RUN_DIR" ]; then
131         mkdir -p "$VSWITCHD_RUN_DIR"
132     fi
133     cd "$VSWITCHD_RUN_DIR"
134     if [ -n "$VSWITCHD_FILE_LOGLEVEL" ]; then
135         logfile_level_opt="-vANY:FILE:${VSWITCHD_FILE_LOGLEVEL}"
136         logfile_file_opt="--log-file=$VSWITCHD_LOGFILE"
137     fi
138     local leak_opt=""
139     if [ -n "$VSWITCHD_MEMLEAK_LOGFILE" ]; then
140         leak_opt="--check-leaks=$VSWITCHD_MEMLEAK_LOGFILE"
141         if [ -e "$VSWITCHD_MEMLEAK_LOGFILE" ]; then
142             mv "$VSWITCHD_MEMLEAK_LOGFILE" "$VSWITCHD_MEMLEAK_LOGFILE.prev"
143         fi
144     fi
145     local strace_opt=""
146     local daemonize="y"
147     if [ -n "$VSWITCHD_STRACE_LOG" ] && [ -n "$VSWITCHD_VALGRIND_LOG" ]; then
148         printf "Can not start with both VALGRIND and STRACE\n"
149         exit 1
150     fi
151     if [ -n "$VSWITCHD_STRACE_LOG" ]; then
152         strace_opt="strace -o $VSWITCHD_STRACE_LOG $VSWITCHD_STRACE_OPT"
153         daemonize="n"
154     fi
155     if [ -n "$VSWITCHD_VALGRIND_LOG" ]; then
156         valgrind_opt="valgrind --log-file=$VSWITCHD_VALGRIND_LOG $VSWITCHD_VALGRIND_OPT"
157         daemonize="n"
158     fi
159     local fake_proc_net_opt=""
160     if [ "$ENABLE_FAKE_PROC_NET" = "y" ]; then
161         fake_proc_net_opt="--fake-proc-net"
162     fi
163     if [ "$VSWITCHD_MLOCKALL" != "no" ]; then
164         mlockall_opt="--mlockall"
165     fi
166     if [ "$daemonize" != "y" ]; then
167         # Start in background and force a "success" message
168         action "Starting ovs-vswitchd ($strace_opt$valgrind_opt)" true
169         (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 $mlockall_opt "$VSWITCHD_CONF") &
170     else
171         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 $mlockall_opt "$VSWITCHD_CONF"
172     fi
173 }
174
175 function start_brcompatd {
176     local syslog_opt="-vANY:SYSLOG:${BRCOMPATD_SYSLOG_LOGLEVEL}"
177     local logfile_file_opt=""
178     local logfile_level_opt=""
179     if [ -d "$BRCOMPATD_RUN_DIR" ]; then
180         mkdir -p "$BRCOMPATD_RUN_DIR"
181     fi
182     cd "$BRCOMPATD_RUN_DIR"
183     if [ -n "$BRCOMPATD_FILE_LOGLEVEL" ]; then
184         logfile_level_opt="-vANY:FILE:${BRCOMPATD_FILE_LOGLEVEL}"
185         logfile_file_opt="--log-file=$BRCOMPATD_LOGFILE"
186     fi
187     local leak_opt=""
188     if [ -n "$BRCOMPATD_MEMLEAK_LOG" ]; then
189         leak_opt="--check-leaks=$BRCOMPATD_MEMLEAK_LOGFILE"
190         if [ -e "$BRCOMPATD_MEMLEAK_LOGFILE" ]; then
191             mv "$BRCOMPATD_MEMLEAK_LOGFILE" "$BRCOMPATD_MEMLEAK_LOGFILE.prev"
192         fi
193     fi
194     local strace_opt=""
195     local daemonize="y"
196     if [ -n "$BRCOMPATD_STRACE_LOG" ] && [ -n "$BRCOMPATD_VALGRIND_LOG" ]; then
197         printf "Can not start with both VALGRIND and STRACE\n"
198         exit 1
199     fi
200     if [ -n "$BRCOMPATD_STRACE_LOG" ]; then
201         strace_opt="strace -o $BRCOMPATD_STRACE_LOG $BRCOMPATD_STRACE_OPT"
202         daemonize="n"
203     fi
204     if [ -n "$VALGRIND_LOG" ]; then
205         valgrind_opt="valgrind --log-file=$BRCOMPATD_VALGRIND_LOG $BRCOMPATD_VALGRIND_OPT"
206         daemonize="n"
207     fi
208     appctl_cmd="$appctl -t /var/run/ovs-vswitchd.\`cat $VSWITCHD_PIDFILE\`.ctl -e '%s'"
209     if [ "$daemonize" != "y" ]; then
210         # Start in background and force a "success" message
211         action "Starting ovs-brcompatd ($strace_opt$valgrind_opt)" true
212         (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") &
213     else
214         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"
215     fi
216 }
217
218 function stop_vswitchd {
219     if [ -f "$VSWITCHD_PIDFILE" ]; then
220         local pid=$(cat "$VSWITCHD_PIDFILE")
221         action "Killing ovs-vswitchd ($pid)" kill -TERM $pid
222         rm -f "$VSWITCHD_PIDFILE"
223     fi
224 }
225
226 function stop_brcompatd {
227     if [ -f "$BRCOMPATD_PIDFILE" ]; then
228         local pid=$(cat "$BRCOMPATD_PIDFILE")
229         action "Killing ovs-brcompatd ($pid)" kill -TERM $pid
230         rm -f "$BRCOMPATD_PIDFILE"
231     fi
232 }
233
234 function restart_approval {
235     if test ! -t 0; then
236         # Don't prompt if invoked non-interactively.
237         return 0
238     fi
239     cat <<EOF
240
241 WARNING!!!
242
243 Restarting vswitch on a live server is not guaranteed to work.  It is
244 provided as a convenience for those situations in which it does work.
245 If you just want to reload the configuration file, use "reload"
246 instead of restart.
247
248 EOF
249     read -s -r -n 1 -p "Countinue with restart (y/N): " response
250     printf "\n"
251     case "$response" in
252         y|Y)
253             return 0
254             ;;
255         *)
256             return 1
257             ;;
258     esac
259 }
260
261 function start {
262     if [ "$FORCE_COREFILES" = "y" ]; then
263         turn_on_corefiles
264     fi
265
266     insert_modules_if_required
267
268     # Increase the limit on the number of open file descriptors since
269     # ovs-vswitchd needs a few per bridge
270     ulimit -n 4096
271
272     if [ ! -e "$VSWITCHD_CONF" ]; then
273         warning "$VSWITCHD_CONF does not exist"
274         action "Creating empty $VSWITCHD_CONF" touch "$VSWITCHD_CONF"
275     elif [ ! -e /var/run/vswitch.booted ]; then
276         touch /var/run/vswitch.booted
277         /usr/bin/ovs-cfg-mod '-vANY:console:emer' -F "$VSWITCHD_CONF" \
278             '--del-match=bridge.*' \
279             '--del-match=port.*' \
280             '--del-match=bonding.*' \
281             '--del-match=iface.*' \
282             '--del-match=vlan.*.trunks=*' \
283             '--del-match=vlan.*.tag=*'
284     fi
285
286     start_vswitchd
287     start_brcompatd
288     reload_vswitchd  # ensures ovs-vswitchd has fully read config file.
289 }
290
291 function stop {
292     stop_brcompatd
293     stop_vswitchd
294 }
295
296 function restart {
297     if restart_approval; then
298         stop
299         start
300     fi
301 }
302
303 case "$1" in
304     start)
305         start
306         ;;
307     stop)
308         stop
309         ;;
310     restart)
311         restart
312         ;;
313     reload)
314         reload_vswitchd
315         reload_brcompatd
316         ;;
317     strace-vswitchd)
318         shift
319         strace -p $(cat "$VSWITCHD_PIDFILE") "$@"
320         ;;
321     strace-brcompatd)
322         shift
323         strace -p $(cat "$BRCOMPATD_PIDFILE") "$@"
324         ;;
325     status)
326         status -p ovs-vswitchd.pid ovs-vswitchd
327         status -p ovs-brcompatd.pid ovs-brcompatd
328         ;;
329     version)
330         "$VSWITCH_BASE"/sbin/ovs-vswitchd -V
331         "$VSWITCH_BASE"/sbin/ovs-brcompatd -V
332         ;;
333     help)
334         printf "vswitch [start|stop|restart|reload|unload|status|version]\n"
335         ;;
336     *)
337         printf "Unknown command: $1\n"
338         exit 1
339         ;;
340 esac