2 # Copyright (C) 2009, 2010, 2011, 2012 Nicira, Inc.
4 # Licensed under the Apache License, Version 2.0 (the "License");
5 # you may not use this file except in compliance with the License.
6 # You may obtain a copy of the License at:
8 # http://www.apache.org/licenses/LICENSE-2.0
10 # Unless required by applicable law or agreed to in writing, software
11 # distributed under the License is distributed on an "AS IS" BASIS,
12 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 # See the License for the specific language governing permissions and
14 # limitations under the License.
17 */*) dir0
=`echo "$0" | sed 's,/[^/]*$,,'` ;;
20 .
"$dir0/ovs-lib" ||
exit 1
22 for dir
in "$sbindir" "$bindir" /sbin
/bin
/usr
/sbin
/usr
/bin
; do
33 insert_openvswitch_mod_if_required
() {
34 # If openvswitch is already loaded then we're done.
35 test -e /sys
/module
/openvswitch
-o -e /sys
/module
/openvswitch_mod
&& \
38 # Load openvswitch. If that's successful then we're done.
39 action
"Inserting openvswitch module" modprobe openvswitch
&& return 0
41 # If the bridge module is loaded, then that might be blocking
42 # openvswitch. Try to unload it, if there are no bridges.
43 test -e /sys
/module
/bridge ||
return 1
44 bridges
=`echo /sys/class/net/*/bridge | sed 's,/sys/class/net/,,g;s,/bridge,,g'`
45 if test "$bridges" != "*"; then
46 log_warning_msg
"not removing bridge module because bridges exist ($bridges)"
49 action
"removing bridge module" rmmod bridge ||
return 1
51 # Try loading openvswitch again.
52 action
"Inserting openvswitch module" modprobe openvswitch
55 insert_brcompat_mod_if_required
() {
56 if test -e /sys
/module
/bridge
; then
57 log_warning_msg
"bridge module is loaded, not loading brcompat"
60 test -e /sys
/module
/brcompat
-o -e /sys
/module
/brcompat_mod
&& return 0
61 action
"Inserting brcompat module" modprobe brcompat
64 insert_mod_if_required
() {
65 insert_openvswitch_mod_if_required ||
return 1
66 if test X
"$BRCOMPAT" = Xyes
; then
67 if insert_brcompat_mod_if_required
; then
70 log_warning_msg
"could not load brcompat module, disabling bridge compatibility"
77 ovs-vsctl
--no-wait --timeout=5 "$@"
81 ovsdb-tool
-vconsole:off
"$@"
85 action
"Creating empty database $DB_FILE" ovsdb_tool create
"$DB_FILE" "$DB_SCHEMA"
89 schemaver
=`ovsdb_tool schema-version "$DB_SCHEMA"`
90 if test ! -e "$DB_FILE"; then
91 log_warning_msg
"$DB_FILE does not exist"
92 install -d -m 755 -o root
-g root
`dirname $DB_FILE`
94 elif test X
"`ovsdb_tool needs-conversion "$DB_FILE" "$DB_SCHEMA"`" != Xno
; then
95 # Back up the old version.
96 version
=`ovsdb_tool db-version "$DB_FILE"`
97 cksum=`ovsdb_tool db-cksum "$DB_FILE" | awk '{print $1}'`
98 backup
=$DB_FILE.backup
$version-$cksum
99 action
"Backing up database to $backup" cp "$DB_FILE" "$backup" ||
return 1
101 # Compact database. This is important if the old schema did not enable
102 # garbage collection (i.e. if it did not have any tables with "isRoot":
103 # true) but the new schema does. In that situation the old database
104 # may contain a transaction that creates a record followed by a
105 # transaction that creates the first use of the record. Replaying that
106 # series of transactions against the new database schema (as "convert"
107 # does) would cause the record to be dropped by the first transaction,
108 # then the second transaction would cause a referential integrity
109 # failure (for a strong reference).
111 # Errors might occur on an Open vSwitch downgrade if ovsdb-tool doesn't
112 # understand some feature of the schema used in the OVSDB version that
113 # we're downgrading from, so we don't give up on error.
114 action
"Compacting database" ovsdb_tool compact
"$DB_FILE"
116 # Upgrade or downgrade schema.
117 if action
"Converting database schema" ovsdb_tool convert
"$DB_FILE" "$DB_SCHEMA"; then
120 log_warning_msg
"Schema conversion failed, using empty database instead"
128 set ovs_vsctl
set Open_vSwitch .
130 OVS_VERSION
=`ovs-vswitchd --version | sed 's/.*) //;1q'`
131 set "$@" ovs-version
="$OVS_VERSION"
135 id_file
=$etcdir/system-id.conf
136 uuid_file
=$etcdir/install_uuid.conf
137 if test -e "$id_file"; then
138 SYSTEM_ID
=`cat "$id_file"`
139 elif test -e "$uuid_file"; then
140 # Migrate from old file name.
142 SYSTEM_ID
=$INSTALLATION_UUID
143 echo "$SYSTEM_ID" > "$id_file"
144 elif SYSTEM_ID
=`uuidgen`; then
145 echo "$SYSTEM_ID" > "$id_file"
147 log_failure_msg
"missing uuidgen, could not generate system ID"
152 log_failure_msg
"system ID not configured, please use --system-id"
158 set "$@" external-ids
:system-id
="\"$SYSTEM_ID\""
160 if test X
"$SYSTEM_TYPE" != X
; then
161 set "$@" system-type
="\"$SYSTEM_TYPE\""
163 log_failure_msg
"no default system type, please use --system-type"
166 if test X
"$SYSTEM_VERSION" != X
; then
167 set "$@" system-version
="\"$SYSTEM_VERSION\""
169 log_failure_msg
"no default system version, please use --system-version"
172 action
"Configuring Open vSwitch system IDs" "$@" $extra_ids
175 check_force_cores
() {
176 if test X
"$FORCE_COREFILES" = Xyes
; then
184 if daemon_is_running ovsdb-server
; then
185 log_success_msg
"ovsdb-server is already running"
187 # Create initial database or upgrade database schema.
188 upgrade_db ||
return 1
190 # Start ovsdb-server.
191 set ovsdb-server
"$DB_FILE"
192 for db
in $EXTRA_DBS; do
198 if test ! -f "$db"; then
199 log_warning_msg
"$db (from \$EXTRA_DBS) does not exist."
200 elif ovsdb-tool db-version
"$db" >/dev
/null
; then
203 log_warning_msg
"$db (from \$EXTRA_DBS) cannot be read as a database (see error message above)"
206 set "$@" -vconsole:emer
-vsyslog:err
-vfile:info
207 set "$@" --remote=punix
:"$DB_SOCK"
208 set "$@" --remote=db
:Open_vSwitch
,Open_vSwitch
,manager_options
209 set "$@" --private-key=db
:Open_vSwitch
,SSL
,private_key
210 set "$@" --certificate=db
:Open_vSwitch
,SSL
,certificate
211 set "$@" --bootstrap-ca-cert=db
:Open_vSwitch
,SSL
,ca_cert
212 start_daemon
"$OVSDB_SERVER_PRIORITY" "$OVSDB_SERVER_WRAPPER" "$@" \
215 # Initialize database settings.
216 ovs_vsctl
-- init
-- set Open_vSwitch . db-version
="$schemaver" \
218 set_system_ids ||
return 1
219 if test X
"$DELETE_BRIDGES" = Xyes
; then
220 for bridge
in `ovs_vsctl list-br`; do
221 ovs_vsctl del-br
$bridge
227 start_forwarding
() {
230 insert_mod_if_required ||
return 1
232 if daemon_is_running ovs-vswitchd
; then
233 log_success_msg
"ovs-vswitchd is already running"
235 # Increase the limit on the number of open file descriptors.
236 # ovs-vswitchd needs 16 per datapath, plus a few extra, so this
237 # should allow for 256 (or more) bridges.
240 # Start ovs-vswitchd.
241 set ovs-vswitchd unix
:"$DB_SOCK"
242 set "$@" -vconsole:emer
-vsyslog:err
-vfile:info
243 if test X
"$MLOCKALL" != Xno
; then
246 start_daemon
"$OVS_VSWITCHD_PRIORITY" "$OVS_VSWITCHD_WRAPPER" "$@"
249 if daemon_is_running ovs-brcompatd
; then
250 log_success_msg
"ovs-brcompatd is already running"
251 elif test X
"$BRCOMPAT" = Xyes
; then
253 set "$@" -vconsole:emer
-vsyslog:err
-vfile:info
254 start_daemon
"$OVS_BRCOMPATD_PRIORITY" "$OVS_BRCOMPATD_WRAPPER" "$@"
263 stop_daemon ovsdb-server
267 stop_daemon ovs-brcompatd
268 stop_daemon ovs-vswitchd
271 ## ----------------- ##
272 ## force-reload-kmod ##
273 ## ----------------- ##
275 internal_interfaces
() {
276 # Outputs a list of internal interfaces:
278 # - There is an internal interface for every bridge, whether it
279 # has an Interface record or not and whether the Interface
280 # record's 'type' is properly set or not.
282 # - There is an internal interface for each Interface record whose
283 # 'type' is 'internal'.
285 # But ignore interfaces that don't really exist.
286 for d
in `(ovs_vsctl --bare \
287 -- --columns=name find Interface type=internal \
288 -- list-br) | sort -u`
290 if test -e "/sys/class/net/$d"; then
297 if set X
`ovs_vsctl list-br`; then
299 if "$datadir/scripts/ovs-save" save-flows
"$@" > "$script_flows"; then
300 chmod +x
"$script_flows"
309 "$datadir/scripts/ovs-save" save-interfaces
${ifaces} \
310 > "${script_interfaces}"
314 [ -n "${script_flows}" ] && \
315 action
"Restoring saved flows" "${script_flows}"
318 force_reload_kmod
() {
319 ifaces
=`internal_interfaces`
320 action
"Detected internal interfaces: $ifaces" true
322 script_interfaces
=`mktemp`
323 script_flows
=`mktemp`
324 trap 'rm -f "${script_interfaces}" "${script_flows}" ' 0 1 2 13 15
326 action
"Saving flows" save_flows
328 # Restart the database first, since a large database may take a
329 # while to load, and we want to minimize forwarding disruption.
335 if action
"Saving interface configuration" save_interfaces
; then
338 log_warning_msg
"Failed to save configuration, not replacing kernel module"
342 chmod +x
"$script_interfaces"
344 for dp
in `ovs-dpctl dump-dps`; do
345 action
"Removing datapath: $dp" ovs-dpctl del-dp
"$dp"
348 # try both old and new names in case this is post upgrade
349 if test -e /sys
/module
/brcompat_mod
; then
350 action
"Removing brcompat module" rmmod brcompat_mod
351 elif test -e /sys
/module
/brcompat
; then
352 action
"Removing brcompat module" rmmod brcompat
354 if test -e /sys
/module
/openvswitch_mod
; then
355 action
"Removing openvswitch module" rmmod openvswitch_mod
356 elif test -e /sys
/module
/openvswitch
; then
357 action
"Removing openvswitch module" rmmod openvswitch
364 action
"Restoring interface configuration" "$script_interfaces"
366 if test $rc = 0; then
371 log
="logger -p daemon.$level -t ovs-save"
372 $log "force-reload-kmod interface restore script exited with status $rc:"
373 $log -f "$script_interfaces"
375 "$datadir/scripts/ovs-check-dead-ifs"
383 if daemon_is_running ovsdb-server
&& daemon_is_running ovs-vswitchd
; then
384 script_flows
=`mktemp`
385 trap 'rm -f "${script_flows}"' 0 1 2 13 15
387 action
"Saving flows" save_flows
390 # Restart the database first, since a large database may take a
391 # while to load, and we want to minimize forwarding disruption.
398 # Restore the saved flows. Do not return error if restore fails.
399 restore_flows || true
402 ## --------------- ##
403 ## enable-protocol ##
404 ## --------------- ##
407 # Translate the protocol name to a number, because "iptables -n -L" prints
408 # some protocols by name (despite the -n) and therefore we need to look for
411 # (iptables -S output is more uniform but old iptables doesn't have it.)
412 protonum
=`grep "^$PROTOCOL[ ]" /etc/protocols | awk '{print $2}'`
413 if expr X
"$protonum" : X
'[0-9]\{1,\}$' > /dev
/null
; then :; else
414 log_failure_msg
"unknown protocol $PROTOCOL"
419 match
="(\$2 == \"$PROTOCOL\" || \$2 == $protonum)"
420 insert
="iptables -I INPUT -p $PROTOCOL"
421 if test X
"$DPORT" != X
; then
422 name
="$name to port $DPORT"
423 match
="$match && /dpt:$DPORT/"
424 insert
="$insert --dport $DPORT"
426 if test X
"$SPORT" != X
; then
427 name
="$name from port $SPORT"
428 match
="$match && /spt:$SPORT/"
429 insert
="$insert --sport $SPORT"
431 insert
="$insert -j ACCEPT"
433 if (iptables
-n -L INPUT
) >/dev
/null
2>&1; then
434 if iptables
-n -L INPUT |
awk "$match { n++ } END { exit n == 0 }"
436 # There's already a rule for this protocol. Don't override it.
437 log_success_msg
"iptables already has a rule for $name, not explicitly enabling"
439 action
"Enabling $name with iptables" $insert
441 elif (iptables
--version) >/dev
/null
2>&1; then
442 action
"cannot list iptables rules, not adding a rule for $name"
444 action
"iptables binary not installed, not adding a rule for $name"
461 OVSDB_SERVER_PRIORITY
=-10
462 OVS_VSWITCHD_PRIORITY
=-10
463 OVS_BRCOMPATD_PRIORITY
=-10
464 OVSDB_SERVER_WRAPPER
=
465 OVS_VSWITCHD_WRAPPER
=
466 OVS_BRCOMPATD_WRAPPER
=
468 DB_FILE
=$dbdir/conf.db
469 DB_SOCK
=$rundir/db.sock
470 DB_SCHEMA
=$datadir/vswitch.ovsschema
477 type_file
=$etcdir/system-type.conf
478 version_file
=$etcdir/system-version.conf
480 if test -e "$type_file" ; then
481 SYSTEM_TYPE
=`cat $type_file`
482 SYSTEM_VERSION
=`cat $version_file`
483 elif (lsb_release
--id) >/dev
/null
2>&1; then
484 SYSTEM_TYPE
=`lsb_release --id -s`
485 system_release
=`lsb_release --release -s`
486 system_codename
=`lsb_release --codename -s`
487 SYSTEM_VERSION
="${system_release}-${system_codename}"
490 SYSTEM_VERSION
=unknown
497 $0: controls Open vSwitch daemons
498 usage: $0 [OPTIONS] COMMAND
500 This program is intended to be invoked internally by Open vSwitch startup
501 scripts. System administrators should not normally invoke it directly.
504 start start Open vSwitch daemons
505 stop stop Open vSwitch daemons
506 restart stop and start Open vSwitch daemons
507 status check whether Open vSwitch daemons are running
508 version print versions of Open vSwitch daemons
509 load-kmod insert modules if not already present
510 force-reload-kmod save OVS network device state, stop OVS, unload kernel
511 module, reload kernel module, start OVS, restore state
512 enable-protocol enable protocol specified in options with iptables
513 help display this help message
515 One of the following options is required for "start", "restart" and "force-reload-kmod":
516 --system-id=UUID set specific ID to uniquely identify this system
517 --system-id=random use a random but persistent UUID to identify this system
519 Other important options for "start", "restart" and "force-reload-kmod":
520 --system-type=TYPE set system type (e.g. "XenServer")
521 --system-version=VERSION set system version (e.g. "5.6.100-39265p")
522 --external-id="key=value"
523 add given key-value pair to Open_vSwitch external-ids
524 --delete-bridges delete all bridges just before starting ovs-vswitchd
526 Less important options for "start", "restart" and "force-reload-kmod":
527 --daemon-cwd=DIR set working dir for OVS daemons (default: $DAEMON_CWD)
528 --no-force-corefiles do not force on core dumps for OVS daemons
529 --no-mlockall do not lock all of ovs-vswitchd into memory
530 --ovsdb-server-priority=NICE set ovsdb-server's niceness (default: $OVSDB_SERVER_PRIORITY)
531 --ovs-vswitchd-priority=NICE set ovs-vswitchd's niceness (default: $OVS_VSWITCHD_PRIORITY)
532 --ovs-brcompatd-priority=NICE set ovs-brcompatd's niceness (default: $OVS_BRCOMPATD_PRIORITY)
534 Debugging options for "start", "restart" and "force-reload-kmod":
535 --ovsdb-server-wrapper=WRAPPER
536 --ovs-vswitchd-wrapper=WRAPPER
537 --ovs-vswitchd-wrapper=WRAPPER
538 run specified daemon under WRAPPER (either 'valgrind' or 'strace')
540 Options for "start", "restart", "force-reload-kmod", "load-kmod", "status", and "version":
541 --brcompat enable Linux bridge compatibility module and daemon
543 File location options:
544 --db-file=FILE database file name (default: $DB_FILE)
545 --db-sock=SOCKET JSON-RPC socket name (default: $DB_SOCK)
546 --db-schema=FILE database schema file name (default: $DB_SCHEMA)
548 Options for "enable-protocol":
549 --protocol=PROTOCOL protocol to enable with iptables (default: gre)
550 --sport=PORT source port to match (for tcp or udp protocol)
551 --dport=PORT ddestination port to match (for tcp or udp protocol)
554 -h, --help display this help message
555 -V, --version display version information
557 Default directories with "configure" option and environment variable override:
558 logs: @LOGDIR@ (--with-logdir, OVS_LOGDIR)
559 pidfiles and sockets: @RUNDIR@ (--with-rundir, OVS_RUNDIR)
560 conf.db: @DBDIR@ (--with-dbdir, OVS_DBDIR)
561 system configuration: @sysconfdir@ (--sysconfdir, OVS_SYSCONFDIR)
562 data files: @pkgdatadir@ (--pkgdatadir, OVS_PKGDATADIR)
563 user binaries: @bindir@ (--bindir, OVS_BINDIR)
564 system binaries: @sbindir@ (--sbindir, OVS_SBINDIR)
566 Please report bugs to bugs@openvswitch.org (see REPORTING-BUGS for details).
573 var
=`echo "$option" | tr abcdefghijklmnopqrstuvwxyz- ABCDEFGHIJKLMNOPQRSTUVWXYZ_`
574 eval set=\
${$var+yes}
575 eval old_value
=\$
$var
576 if test X
$set = X || \
577 (test $type = bool
&& \
578 test X
"$old_value" != Xno
&& test X
"$old_value" != Xyes
); then
579 echo >&2 "$0: unknown option \"$arg\" (use --help for help)"
586 echo ovsdb-server ovs-vswitchd
587 if test X
"$BRCOMPAT" = Xyes
; then
602 echo "$0 (Open vSwitch) $VERSION"
606 value
=`expr X"$arg" : 'X[^=]*=\(.*\)'`
609 extra_ids
="$extra_ids external-ids:$value"
612 echo >&2 "$0: --external-id argument not in the form \"key=value\""
618 option
=`expr X"$arg" : 'X--\([^=]*\)'`
619 value
=`expr X"$arg" : 'X[^=]*=\(.*\)'`
624 option
=`expr X"$arg" : 'X--no-\(.*\)'`
630 option
=`expr X"$arg" : 'X--\(.*\)'`
636 echo >&2 "$0: unknown option \"$arg\" (use --help for help)"
640 if test X
"$command" = X
; then
643 echo >&2 "$0: exactly one non-option argument required (use --help for help)"
663 for daemon
in `daemons`; do
664 daemon_status
$daemon || rc
=$?
669 for daemon
in `daemons`; do
677 insert_mod_if_required
686 echo >&2 "$0: missing command name (use --help for help)"
690 echo >&2 "$0: unknown command \"$command\" (use --help for help)"