2 # Copyright (C) 2009, 2010, 2011, 2012, 2013 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_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
56 ovs-vsctl --no-wait "$@"
60 ovsdb-tool -vconsole:off "$@"
64 action "Creating empty database $DB_FILE" ovsdb_tool create "$DB_FILE" "$DB_SCHEMA"
68 schemaver=`ovsdb_tool schema-version "$DB_SCHEMA"`
69 if test ! -e "$DB_FILE"; then
70 log_warning_msg "$DB_FILE does not exist"
71 install -d -m 755 -o root -g root `dirname $DB_FILE`
73 elif test X"`ovsdb_tool needs-conversion "$DB_FILE" "$DB_SCHEMA"`" != Xno; then
74 # Back up the old version.
75 version=`ovsdb_tool db-version "$DB_FILE"`
76 cksum=`ovsdb_tool db-cksum "$DB_FILE" | awk '{print $1}'`
77 backup=$DB_FILE.backup$version-$cksum
78 action "Backing up database to $backup" cp "$DB_FILE" "$backup" || return 1
80 # Compact database. This is important if the old schema did not enable
81 # garbage collection (i.e. if it did not have any tables with "isRoot":
82 # true) but the new schema does. In that situation the old database
83 # may contain a transaction that creates a record followed by a
84 # transaction that creates the first use of the record. Replaying that
85 # series of transactions against the new database schema (as "convert"
86 # does) would cause the record to be dropped by the first transaction,
87 # then the second transaction would cause a referential integrity
88 # failure (for a strong reference).
90 # Errors might occur on an Open vSwitch downgrade if ovsdb-tool doesn't
91 # understand some feature of the schema used in the OVSDB version that
92 # we're downgrading from, so we don't give up on error.
93 action "Compacting database" ovsdb_tool compact "$DB_FILE"
95 # Upgrade or downgrade schema.
96 if action "Converting database schema" ovsdb_tool convert "$DB_FILE" "$DB_SCHEMA"; then
99 log_warning_msg "Schema conversion failed, using empty database instead"
107 set ovs_vsctl set Open_vSwitch .
109 OVS_VERSION=`ovs-vswitchd --version | sed 's/.*) //;1q'`
110 set "$@" ovs-version="$OVS_VERSION"
114 id_file=$etcdir/system-id.conf
115 uuid_file=$etcdir/install_uuid.conf
116 if test -e "$id_file"; then
117 SYSTEM_ID=`cat "$id_file"`
118 elif test -e "$uuid_file"; then
119 # Migrate from old file name.
121 SYSTEM_ID=$INSTALLATION_UUID
122 echo "$SYSTEM_ID" > "$id_file"
123 elif SYSTEM_ID=`uuidgen`; then
124 echo "$SYSTEM_ID" > "$id_file"
126 log_failure_msg "missing uuidgen, could not generate system ID"
131 log_failure_msg "system ID not configured, please use --system-id"
137 set "$@" external-ids:system-id="\"$SYSTEM_ID\""
139 if test X"$SYSTEM_TYPE" != X; then
140 set "$@" system-type="\"$SYSTEM_TYPE\""
142 log_failure_msg "no default system type, please use --system-type"
145 if test X"$SYSTEM_VERSION" != X; then
146 set "$@" system-version="\"$SYSTEM_VERSION\""
148 log_failure_msg "no default system version, please use --system-version"
151 action "Configuring Open vSwitch system IDs" "$@" $extra_ids
154 check_force_cores () {
155 if test X"$FORCE_COREFILES" = Xyes; then
163 if daemon_is_running ovsdb-server; then
164 log_success_msg "ovsdb-server is already running"
166 # Create initial database or upgrade database schema.
167 upgrade_db || return 1
169 # Start ovsdb-server.
170 set ovsdb-server "$DB_FILE"
171 for db in $EXTRA_DBS; do
177 if test ! -f "$db"; then
178 log_warning_msg "$db (from \$EXTRA_DBS) does not exist."
179 elif ovsdb-tool db-version "$db" >/dev/null; then
182 log_warning_msg "$db (from \$EXTRA_DBS) cannot be read as a database (see error message above)"
185 set "$@" -vconsole:emer -vsyslog:err -vfile:info
186 set "$@" --remote=punix:"$DB_SOCK"
187 set "$@" --private-key=db:Open_vSwitch,SSL,private_key
188 set "$@" --certificate=db:Open_vSwitch,SSL,certificate
189 set "$@" --bootstrap-ca-cert=db:Open_vSwitch,SSL,ca_cert
190 start_daemon "$OVSDB_SERVER_PRIORITY" "$OVSDB_SERVER_WRAPPER" "$@" \
193 # Initialize database settings.
194 ovs_vsctl -- init -- set Open_vSwitch . db-version="$schemaver" \
196 set_system_ids || return 1
197 if test X"$DELETE_BRIDGES" = Xyes; then
198 for bridge in `ovs_vsctl list-br`; do
199 ovs_vsctl del-br $bridge
205 start_forwarding () {
208 insert_mod_if_required || return 1
210 if daemon_is_running ovs-vswitchd; then
211 log_success_msg "ovs-vswitchd is already running"
213 # Increase the limit on the number of open file descriptors.
214 # On Linux, ovs-vswitchd needs about one file descriptor per
215 # switch port, so this allows a very large number of switch
219 # Start ovs-vswitchd.
220 set ovs-vswitchd unix:"$DB_SOCK"
221 set "$@" -vconsole:emer -vsyslog:err -vfile:info
222 if test X"$MLOCKALL" != Xno; then
225 start_daemon "$OVS_VSWITCHD_PRIORITY" "$OVS_VSWITCHD_WRAPPER" "$@"
228 # Now that ovs-vswitchd has started and completed its initial
229 # configuration, tell ovsdb-server to conenct to the remote managers. We
230 # used to do this at ovsdb-server startup time, but waiting for
231 # ovs-vswitchd to finish configuring means that remote managers see less
232 # churn in the database at startup or restart. (For example, managers
233 # won't briefly see empty datapath-id or ofport columns for records that
235 action "Enabling remote OVSDB managers" \
236 ovs-appctl -t ovsdb-server ovsdb-server/add-remote \
237 db:Open_vSwitch,Open_vSwitch,manager_options
245 stop_daemon ovsdb-server
249 stop_daemon ovs-vswitchd
252 ## ----------------- ##
253 ## force-reload-kmod ##
254 ## ----------------- ##
256 internal_interfaces () {
257 # Outputs a list of internal interfaces:
259 # - There is an internal interface for every bridge, whether it
260 # has an Interface record or not and whether the Interface
261 # record's 'type' is properly set or not.
263 # - There is an internal interface for each Interface record whose
264 # 'type' is 'internal'.
266 # But ignore interfaces that don't really exist.
267 for d in `(ovs_vsctl --bare \
268 -- --columns=name find Interface type=internal \
269 -- list-br) | sort -u`
271 if test -e "/sys/class/net/$d"; then
278 bridges=`ovs_vsctl -- --real list-br`
279 if [ -n "${bridges}" ] && \
280 "$datadir/scripts/ovs-save" "$1" ${bridges} > "$2"; then
284 [ -z "${bridges}" ] && return 0
287 save_ofports_if_required () {
288 # Save ofports if we are upgrading from a pre-1.10 branch.
289 case `ovs-appctl version | sed 1q` in
290 "ovs-vswitchd (Open vSwitch) 1."[0-9].*)
291 action "Saving ofport values" ovs_save save-ofports \
298 "$datadir/scripts/ovs-save" save-interfaces ${ifaces} \
299 > "${script_interfaces}"
303 [ -x "${script_ofports}" ] && \
304 action "Restoring ofport values" "${script_ofports}"
308 [ -x "${script_flows}" ] && \
309 action "Restoring saved flows" "${script_flows}"
312 restore_interfaces () {
313 [ ! -x "${script_interfaces}" ] && return 0
314 action "Restoring interface configuration" "${script_interfaces}"
316 if test $rc = 0; then
321 log="logger -p daemon.$level -t ovs-save"
322 $log "interface restore script exited with status $rc:"
323 $log -f "$script_interfaces"
326 init_restore_scripts () {
327 script_interfaces=`mktemp`
328 script_flows=`mktemp`
329 script_ofports=`mktemp`
330 trap 'rm -f "${script_interfaces}" "${script_flows}" "${script_ofports}"' 0
333 force_reload_kmod () {
334 ifaces=`internal_interfaces`
335 action "Detected internal interfaces: $ifaces" true
339 action "Saving flows" ovs_save save-flows "${script_flows}"
341 save_ofports_if_required
343 # Restart the database first, since a large database may take a
344 # while to load, and we want to minimize forwarding disruption.
348 # Restore of ofports should happen before vswitchd is restarted.
353 if action "Saving interface configuration" save_interfaces; then
356 log_warning_msg "Failed to save configuration, not replacing kernel module"
360 chmod +x "$script_interfaces"
362 for dp in `ovs-dpctl dump-dps`; do
363 action "Removing datapath: $dp" ovs-dpctl del-dp "$dp"
366 # try both old and new names in case this is post upgrade
367 if test -e /sys/module/openvswitch_mod; then
368 action "Removing openvswitch module" rmmod openvswitch_mod
369 elif test -e /sys/module/openvswitch; then
370 action "Removing openvswitch module" rmmod openvswitch
379 "$datadir/scripts/ovs-check-dead-ifs"
386 save_interfaces_if_required () {
387 # Save interfaces if we are upgrading from a pre-1.10 branch.
388 case `ovs-appctl version | sed 1q` in
389 "ovs-vswitchd (Open vSwitch) 1."[0-9].*)
390 ifaces=`internal_interfaces`
391 action "Detected internal interfaces: $ifaces" true
392 if action "Saving interface configuration" save_interfaces; then
393 chmod +x "$script_interfaces"
400 if daemon_is_running ovsdb-server && daemon_is_running ovs-vswitchd; then
402 save_interfaces_if_required
403 action "Saving flows" ovs_save save-flows "${script_flows}"
404 save_ofports_if_required
407 # Restart the database first, since a large database may take a
408 # while to load, and we want to minimize forwarding disruption.
412 # Restore of ofports, if required, should happen before vswitchd is
419 # Restore the saved flows.
422 # Restore the interfaces if required. Return true even if restore fails.
423 restore_interfaces || true
426 ## --------------- ##
427 ## enable-protocol ##
428 ## --------------- ##
431 # Translate the protocol name to a number, because "iptables -n -L" prints
432 # some protocols by name (despite the -n) and therefore we need to look for
435 # (iptables -S output is more uniform but old iptables doesn't have it.)
436 protonum=`grep "^$PROTOCOL[ ]" /etc/protocols | awk '{print $2}'`
437 if expr X"$protonum" : X'[0-9]\{1,\}$' > /dev/null; then :; else
438 log_failure_msg "unknown protocol $PROTOCOL"
443 match="(\$2 == \"$PROTOCOL\" || \$2 == $protonum)"
444 insert="iptables -I INPUT -p $PROTOCOL"
445 if test X"$DPORT" != X; then
446 name="$name to port $DPORT"
447 match="$match && /dpt:$DPORT/"
448 insert="$insert --dport $DPORT"
450 if test X"$SPORT" != X; then
451 name="$name from port $SPORT"
452 match="$match && /spt:$SPORT/"
453 insert="$insert --sport $SPORT"
455 insert="$insert -j ACCEPT"
457 if (iptables -n -L INPUT) >/dev/null 2>&1; then
458 if iptables -n -L INPUT | awk "$match { n++ } END { exit n == 0 }"
460 # There's already a rule for this protocol. Don't override it.
461 log_success_msg "iptables already has a rule for $name, not explicitly enabling"
463 action "Enabling $name with iptables" $insert
465 elif (iptables --version) >/dev/null 2>&1; then
466 action "cannot list iptables rules, not adding a rule for $name"
468 action "iptables binary not installed, not adding a rule for $name"
484 OVSDB_SERVER_PRIORITY=-10
485 OVS_VSWITCHD_PRIORITY=-10
486 OVSDB_SERVER_WRAPPER=
487 OVS_VSWITCHD_WRAPPER=
489 DB_FILE=$dbdir/conf.db
490 DB_SOCK=$rundir/db.sock
491 DB_SCHEMA=$datadir/vswitch.ovsschema
498 type_file=$etcdir/system-type.conf
499 version_file=$etcdir/system-version.conf
501 if test -e "$type_file" ; then
502 SYSTEM_TYPE=`cat $type_file`
503 SYSTEM_VERSION=`cat $version_file`
504 elif (lsb_release --id) >/dev/null 2>&1; then
505 SYSTEM_TYPE=`lsb_release --id -s`
506 system_release=`lsb_release --release -s`
507 system_codename=`lsb_release --codename -s`
508 SYSTEM_VERSION="${system_release}-${system_codename}"
511 SYSTEM_VERSION=unknown
518 $0: controls Open vSwitch daemons
519 usage: $0 [OPTIONS] COMMAND
521 This program is intended to be invoked internally by Open vSwitch startup
522 scripts. System administrators should not normally invoke it directly.
525 start start Open vSwitch daemons
526 stop stop Open vSwitch daemons
527 restart stop and start Open vSwitch daemons
528 status check whether Open vSwitch daemons are running
529 version print versions of Open vSwitch daemons
530 load-kmod insert modules if not already present
531 force-reload-kmod save OVS network device state, stop OVS, unload kernel
532 module, reload kernel module, start OVS, restore state
533 enable-protocol enable protocol specified in options with iptables
534 help display this help message
536 One of the following options is required for "start", "restart" and "force-reload-kmod":
537 --system-id=UUID set specific ID to uniquely identify this system
538 --system-id=random use a random but persistent UUID to identify this system
540 Other important options for "start", "restart" and "force-reload-kmod":
541 --system-type=TYPE set system type (e.g. "XenServer")
542 --system-version=VERSION set system version (e.g. "5.6.100-39265p")
543 --external-id="key=value"
544 add given key-value pair to Open_vSwitch external-ids
545 --delete-bridges delete all bridges just before starting ovs-vswitchd
547 Less important options for "start", "restart" and "force-reload-kmod":
548 --daemon-cwd=DIR set working dir for OVS daemons (default: $DAEMON_CWD)
549 --no-force-corefiles do not force on core dumps for OVS daemons
550 --no-mlockall do not lock all of ovs-vswitchd into memory
551 --ovsdb-server-priority=NICE set ovsdb-server's niceness (default: $OVSDB_SERVER_PRIORITY)
552 --ovs-vswitchd-priority=NICE set ovs-vswitchd's niceness (default: $OVS_VSWITCHD_PRIORITY)
554 Debugging options for "start", "restart" and "force-reload-kmod":
555 --ovsdb-server-wrapper=WRAPPER
556 --ovs-vswitchd-wrapper=WRAPPER
557 --ovs-vswitchd-wrapper=WRAPPER
558 run specified daemon under WRAPPER (either 'valgrind' or 'strace')
560 File location options:
561 --db-file=FILE database file name (default: $DB_FILE)
562 --db-sock=SOCKET JSON-RPC socket name (default: $DB_SOCK)
563 --db-schema=FILE database schema file name (default: $DB_SCHEMA)
565 Options for "enable-protocol":
566 --protocol=PROTOCOL protocol to enable with iptables (default: gre)
567 --sport=PORT source port to match (for tcp or udp protocol)
568 --dport=PORT ddestination port to match (for tcp or udp protocol)
571 -h, --help display this help message
572 -V, --version display version information
574 Default directories with "configure" option and environment variable override:
575 logs: @LOGDIR@ (--with-logdir, OVS_LOGDIR)
576 pidfiles and sockets: @RUNDIR@ (--with-rundir, OVS_RUNDIR)
577 conf.db: @DBDIR@ (--with-dbdir, OVS_DBDIR)
578 system configuration: @sysconfdir@ (--sysconfdir, OVS_SYSCONFDIR)
579 data files: @pkgdatadir@ (--pkgdatadir, OVS_PKGDATADIR)
580 user binaries: @bindir@ (--bindir, OVS_BINDIR)
581 system binaries: @sbindir@ (--sbindir, OVS_SBINDIR)
583 Please report bugs to bugs@openvswitch.org (see REPORTING-BUGS for details).
590 var=`echo "$option" | tr abcdefghijklmnopqrstuvwxyz- ABCDEFGHIJKLMNOPQRSTUVWXYZ_`
591 eval set=\${$var+yes}
592 eval old_value=\$$var
593 if test X$set = X || \
594 (test $type = bool && \
595 test X"$old_value" != Xno && test X"$old_value" != Xyes); then
596 echo >&2 "$0: unknown option \"$arg\" (use --help for help)"
603 echo ovsdb-server ovs-vswitchd
616 echo "$0 (Open vSwitch) $VERSION"
620 value=`expr X"$arg" : 'X[^=]*=\(.*\)'`
623 extra_ids="$extra_ids external-ids:$value"
626 echo >&2 "$0: --external-id argument not in the form \"key=value\""
632 option=`expr X"$arg" : 'X--\([^=]*\)'`
633 value=`expr X"$arg" : 'X[^=]*=\(.*\)'`
638 option=`expr X"$arg" : 'X--no-\(.*\)'`
644 option=`expr X"$arg" : 'X--\(.*\)'`
650 echo >&2 "$0: unknown option \"$arg\" (use --help for help)"
654 if test X"$command" = X; then
657 echo >&2 "$0: exactly one non-option argument required (use --help for help)"
677 for daemon in `daemons`; do
678 daemon_status $daemon || rc=$?
683 for daemon in `daemons`; do
691 insert_mod_if_required
700 echo >&2 "$0: missing command name (use --help for help)"
704 echo >&2 "$0: unknown command \"$command\" (use --help for help)"