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 "$datadir/scripts/ovs-save" $ifaces > "$script"
300 force_reload_kmod () {
301 ifaces=`internal_interfaces`
302 action "Detected internal interfaces: $ifaces" true
304 # Restart the database first, since a large database may take a
305 # while to load, and we want to minimize forwarding disruption.
312 trap 'rm -f "$script"' 0 1 2 13 15
313 if action "Saving interface configuration" save_interfaces; then
316 log_warning_msg "Failed to save configuration, not replacing kernel module"
322 for dp in `ovs-dpctl dump-dps`; do
323 action "Removing datapath: $dp" ovs-dpctl del-dp "$dp"
326 # try both old and new names in case this is post upgrade
327 if test -e /sys/module/brcompat_mod; then
328 action "Removing brcompat module" rmmod brcompat_mod
329 elif test -e /sys/module/brcompat; then
330 action "Removing brcompat module" rmmod brcompat
332 if test -e /sys/module/openvswitch_mod; then
333 action "Removing openvswitch module" rmmod openvswitch_mod
334 elif test -e /sys/module/openvswitch; then
335 action "Removing openvswitch module" rmmod openvswitch
340 action "Restoring interface configuration" "$script"
342 if test $rc = 0; then
347 log="logger -p daemon.$level -t ovs-save"
348 $log "force-reload-kmod interface restore script exited with status $rc:"
351 "$datadir/scripts/ovs-check-dead-ifs"
354 ## --------------- ##
355 ## enable-protocol ##
356 ## --------------- ##
359 # Translate the protocol name to a number, because "iptables -n -L" prints
360 # some protocols by name (despite the -n) and therefore we need to look for
363 # (iptables -S output is more uniform but old iptables doesn't have it.)
364 protonum=`grep "^$PROTOCOL[ ]" /etc/protocols | awk '{print $2}'`
365 if expr X"$protonum" : X'[0-9]\{1,\}$' > /dev/null; then :; else
366 log_failure_msg "unknown protocol $PROTOCOL"
371 match="(\$2 == \"$PROTOCOL\" || \$2 == $protonum)"
372 insert="iptables -I INPUT -p $PROTOCOL"
373 if test X"$DPORT" != X; then
374 name="$name to port $DPORT"
375 match="$match && /dpt:$DPORT/"
376 insert="$insert --dport $DPORT"
378 if test X"$SPORT" != X; then
379 name="$name from port $SPORT"
380 match="$match && /spt:$SPORT/"
381 insert="$insert --sport $SPORT"
383 insert="$insert -j ACCEPT"
385 if (iptables -n -L INPUT) >/dev/null 2>&1; then
386 if iptables -n -L INPUT | awk "$match { n++ } END { exit n == 0 }"
388 # There's already a rule for this protocol. Don't override it.
389 log_success_msg "iptables already has a rule for $name, not explicitly enabling"
391 action "Enabling $name with iptables" $insert
393 elif (iptables --version) >/dev/null 2>&1; then
394 action "cannot list iptables rules, not adding a rule for $name"
396 action "iptables binary not installed, not adding a rule for $name"
413 OVSDB_SERVER_PRIORITY=-10
414 OVS_VSWITCHD_PRIORITY=-10
415 OVS_BRCOMPATD_PRIORITY=-10
416 OVSDB_SERVER_WRAPPER=
417 OVS_VSWITCHD_WRAPPER=
418 OVS_BRCOMPATD_WRAPPER=
420 DB_FILE=$dbdir/conf.db
421 DB_SOCK=$rundir/db.sock
422 DB_SCHEMA=$datadir/vswitch.ovsschema
429 type_file=$etcdir/system-type.conf
430 version_file=$etcdir/system-version.conf
432 if test -e "$type_file" ; then
433 SYSTEM_TYPE=`cat $type_file`
434 SYSTEM_VERSION=`cat $version_file`
435 elif (lsb_release --id) >/dev/null 2>&1; then
436 SYSTEM_TYPE=`lsb_release --id -s`
437 system_release=`lsb_release --release -s`
438 system_codename=`lsb_release --codename -s`
439 SYSTEM_VERSION="${system_release}-${system_codename}"
442 SYSTEM_VERSION=unknown
449 $0: controls Open vSwitch daemons
450 usage: $0 [OPTIONS] COMMAND
452 This program is intended to be invoked internally by Open vSwitch startup
453 scripts. System administrators should not normally invoke it directly.
456 start start Open vSwitch daemons
457 stop stop Open vSwitch daemons
458 status check whether Open vSwitch daemons are running
459 version print versions of Open vSwitch daemons
460 load-kmod insert modules if not already present
461 force-reload-kmod save OVS network device state, stop OVS, unload kernel
462 module, reload kernel module, start OVS, restore state
463 enable-protocol enable protocol specified in options with iptables
464 help display this help message
466 One of the following options is required for "start" and "force-reload-kmod":
467 --system-id=UUID set specific ID to uniquely identify this system
468 --system-id=random use a random but persistent UUID to identify this system
470 Other important options for "start" and "force-reload-kmod":
471 --system-type=TYPE set system type (e.g. "XenServer")
472 --system-version=VERSION set system version (e.g. "5.6.100-39265p")
473 --external-id="key=value"
474 add given key-value pair to Open_vSwitch external-ids
475 --delete-bridges delete all bridges just before starting ovs-vswitchd
477 Less important options for "start" and "force-reload-kmod":
478 --daemon-cwd=DIR set working dir for OVS daemons (default: $DAEMON_CWD)
479 --no-force-corefiles do not force on core dumps for OVS daemons
480 --no-mlockall do not lock all of ovs-vswitchd into memory
481 --ovsdb-server-priority=NICE set ovsdb-server's niceness (default: $OVSDB_SERVER_PRIORITY)
482 --ovs-vswitchd-priority=NICE set ovs-vswitchd's niceness (default: $OVS_VSWITCHD_PRIORITY)
483 --ovs-brcompatd-priority=NICE set ovs-brcompatd's niceness (default: $OVS_BRCOMPATD_PRIORITY)
485 Debugging options for "start" and "force-reload-kmod":
486 --ovsdb-server-wrapper=WRAPPER
487 --ovs-vswitchd-wrapper=WRAPPER
488 --ovs-vswitchd-wrapper=WRAPPER
489 run specified daemon under WRAPPER (either 'valgrind' or 'strace')
491 Options for "start", "force-reload-kmod", "load-kmod", "status", and "version":
492 --brcompat enable Linux bridge compatibility module and daemon
494 File location options:
495 --db-file=FILE database file name (default: $DB_FILE)
496 --db-sock=SOCKET JSON-RPC socket name (default: $DB_SOCK)
497 --db-schema=FILE database schema file name (default: $DB_SCHEMA)
499 Options for "enable-protocol":
500 --protocol=PROTOCOL protocol to enable with iptables (default: gre)
501 --sport=PORT source port to match (for tcp or udp protocol)
502 --dport=PORT ddestination port to match (for tcp or udp protocol)
505 -h, --help display this help message
506 -V, --version display version information
508 Default directories with "configure" option and environment variable override:
509 logs: @LOGDIR@ (--with-logdir, OVS_LOGDIR)
510 pidfiles and sockets: @RUNDIR@ (--with-rundir, OVS_RUNDIR)
511 conf.db: @DBDIR@ (--with-dbdir, OVS_DBDIR)
512 system configuration: @sysconfdir@ (--sysconfdir, OVS_SYSCONFDIR)
513 data files: @pkgdatadir@ (--pkgdatadir, OVS_PKGDATADIR)
514 user binaries: @bindir@ (--bindir, OVS_BINDIR)
515 system binaries: @sbindir@ (--sbindir, OVS_SBINDIR)
517 Please report bugs to bugs@openvswitch.org (see REPORTING-BUGS for details).
524 var=`echo "$option" | tr abcdefghijklmnopqrstuvwxyz- ABCDEFGHIJKLMNOPQRSTUVWXYZ_`
525 eval set=\${$var+yes}
526 eval old_value=\$$var
527 if test X$set = X || \
528 (test $type = bool && \
529 test X"$old_value" != Xno && test X"$old_value" != Xyes); then
530 echo >&2 "$0: unknown option \"$arg\" (use --help for help)"
537 echo ovsdb-server ovs-vswitchd
538 if test X"$BRCOMPAT" = Xyes; then
553 echo "$0 (Open vSwitch) $VERSION"
557 value=`expr X"$arg" : 'X[^=]*=\(.*\)'`
560 extra_ids="$extra_ids external-ids:$value"
563 echo >&2 "$0: --external-id argument not in the form \"key=value\""
569 option=`expr X"$arg" : 'X--\([^=]*\)'`
570 value=`expr X"$arg" : 'X[^=]*=\(.*\)'`
575 option=`expr X"$arg" : 'X--no-\(.*\)'`
581 option=`expr X"$arg" : 'X--\(.*\)'`
587 echo >&2 "$0: unknown option \"$arg\" (use --help for help)"
591 if test X"$command" = X; then
594 echo >&2 "$0: exactly one non-option argument required (use --help for help)"
611 for daemon in `daemons`; do
612 daemon_status $daemon || rc=$?
617 for daemon in `daemons`; do
625 insert_mod_if_required
634 echo >&2 "$0: missing command name (use --help for help)"
638 echo >&2 "$0: unknown command \"$command\" (use --help for help)"