2 # Copyright (C) 2009, 2010, 2011 Nicira Networks, 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.sh" || exit 1
22 for dir in "$sbindir" "$bindir" /sbin /bin /usr/sbin /usr/bin; do
33 insert_openvswitch_mod_if_required () {
34 # If openvswitch_mod is already loaded then we're done.
35 test -e /sys/module/openvswitch_mod && return 0
37 # Load openvswitch_mod. If that's successful then we're done.
38 action "Inserting openvswitch module" modprobe openvswitch_mod && return 0
40 # If the bridge module is loaded, then that might be blocking
41 # openvswitch_mod. Try to unload it, if there are no bridges.
42 test -e /sys/module/bridge || return 1
43 bridges=`echo /sys/class/net/*/bridge | sed 's,/sys/class/net/,,g;s,/bridge,,g'`
44 if test "$bridges" != "*"; then
45 log_warning_msg "not removing bridge module because bridges exist ($bridges)"
48 action "removing bridge module" rmmod bridge || return 1
50 # Try loading openvswitch_mod again.
51 action "Inserting openvswitch module" modprobe openvswitch_mod
54 insert_brcompat_mod_if_required () {
55 test -e /sys/module/brcompat_mod && return 0
56 action "Inserting brcompat module" modprobe brcompat_mod
60 ovs-vsctl --no-wait --timeout=5 "$@"
64 ovsdb-tool -vANY:console:off "$@"
68 action "Creating empty database $DB_FILE" ovsdb_tool create "$DB_FILE" "$DB_SCHEMA"
72 schemaver=`ovsdb_tool schema-version "$DB_SCHEMA"`
73 if test ! -e "$DB_FILE"; then
74 log_warning_msg "$DB_FILE does not exist"
75 install -d -m 755 -o root -g root `dirname $DB_FILE`
77 elif test X"`ovsdb_tool needs-conversion "$DB_FILE" "$DB_SCHEMA"`" != Xno; then
78 # Back up the old version.
79 version=`ovsdb_tool db-version "$DB_FILE"`
80 cksum=`ovsdb_tool db-cksum "$DB_FILE" | awk '{print $1}'`
81 backup=$DB_FILE.backup$version-$cksum
82 action "Backing up database to $backup" cp "$DB_FILE" "$backup" || return 1
84 # Compact database. This is important if the old schema did not enable
85 # garbage collection (i.e. if it did not have any tables with "isRoot":
86 # true) but the new schema does. In that situation the old database
87 # may contain a transaction that creates a record followed by a
88 # transaction that creates the first use of the record. Replaying that
89 # series of transactions against the new database schema (as "convert"
90 # does) would cause the record to be dropped by the first transaction,
91 # then the second transaction would cause a referential integrity
92 # failure (for a strong reference).
94 # Errors might occur on an Open vSwitch downgrade if ovsdb-tool doesn't
95 # understand some feature of the schema used in the OVSDB version that
96 # we're downgrading from, so we don't give up on error.
97 action "Compacting database" ovsdb_tool compact "$DB_FILE"
99 # Upgrade or downgrade schema.
100 if action "Converting database schema" ovsdb_tool convert "$DB_FILE" "$DB_SCHEMA"; then
103 log_warning_msg "Schema conversion failed, using empty database instead"
111 set ovs_vsctl set Open_vSwitch .
113 OVS_VERSION=`ovs-vswitchd --version | sed 's/.*) //;1q'`
114 set "$@" ovs-version="$OVS_VERSION"
118 id_file=$etcdir/system-id.conf
119 uuid_file=$etcdir/install_uuid.conf
120 if test -e "$id_file"; then
121 SYSTEM_ID=`cat "$id_file"`
122 elif test -e "$uuid_file"; then
123 # Migrate from old file name.
125 SYSTEM_ID=$INSTALLATION_UUID
126 echo "$SYSTEM_ID" > "$id_file"
127 elif SYSTEM_ID=`uuidgen`; then
128 echo "$SYSTEM_ID" > "$id_file"
130 log_failure_msg "missing uuidgen, could not generate system ID"
135 log_failure_msg "system ID not configured, please use --system-id"
141 set "$@" external-ids:system-id="\"$SYSTEM_ID\""
143 if test X"$SYSTEM_TYPE" != X; then
144 set "$@" system-type="\"$SYSTEM_TYPE\""
146 log_failure_msg "no default system type, please use --system-type"
149 if test X"$SYSTEM_VERSION" != X; then
150 set "$@" system-version="\"$SYSTEM_VERSION\""
152 log_failure_msg "no default system version, please use --system-version"
155 action "Configuring Open vSwitch system IDs" "$@" $extra_ids
159 if test X"$FORCE_COREFILES" = Xyes; then
163 insert_openvswitch_mod_if_required || return 1
164 if test X"$BRCOMPAT" = Xyes; then
165 insert_brcompat_mod_if_required || return 1
168 if daemon_is_running ovsdb-server; then
169 log_success_msg "ovsdb-server is already running"
171 # Create initial database or upgrade database schema.
172 upgrade_db || return 1
174 # Start ovsdb-server.
175 set ovsdb-server "$DB_FILE"
176 set "$@" -vANY:CONSOLE:EMER -vANY:SYSLOG:ERR -vANY:FILE:INFO
177 set "$@" --remote=punix:"$DB_SOCK"
178 set "$@" --remote=db:Open_vSwitch,manager_options
179 set "$@" --private-key=db:SSL,private_key
180 set "$@" --certificate=db:SSL,certificate
181 set "$@" --bootstrap-ca-cert=db:SSL,ca_cert
182 start_daemon "$OVSDB_SERVER_PRIORITY" "$@" || return 1
184 # Initialize database settings.
185 ovs_vsctl -- init -- set Open_vSwitch . db-version="$schemaver" \
187 set_system_ids || return 1
188 if test X"$DELETE_BRIDGES" = Xyes; then
189 for bridge in `ovs_vsctl list-br`; do
190 ovs_vsctl del-br $bridge
195 if daemon_is_running ovs-vswitchd; then
196 log_success_msg "ovs-vswitchd is already running"
198 # Increase the limit on the number of open file descriptors since
199 # ovs-vswitchd needs a few per bridge
202 # Start ovs-vswitchd.
203 set ovs-vswitchd unix:"$DB_SOCK"
204 set "$@" -vANY:CONSOLE:EMER -vANY:SYSLOG:ERR -vANY:FILE:INFO
205 if test X"$MLOCKALL" != Xno; then
208 start_daemon "$OVS_VSWITCHD_PRIORITY" "$@"
211 if daemon_is_running ovs-brcompatd; then
212 log_success_msg "ovs-brcompatd is already running"
213 elif test X"$BRCOMPAT" = Xyes; then
215 set "$@" -vANY:CONSOLE:EMER -vANY:SYSLOG:ERR -vANY:FILE:INFO
216 start_daemon "$OVS_BRCOMPATD_PRIORITY" "$@"
225 stop_daemon ovs-brcompatd
226 stop_daemon ovs-vswitchd
227 stop_daemon ovsdb-server
230 ## ----------------- ##
231 ## force-reload-kmod ##
232 ## ----------------- ##
234 internal_interfaces () {
235 # Outputs a list of internal interfaces:
237 # - There is an internal interface for every bridge, whether it
238 # has an Interface record or not and whether the Interface
239 # record's 'type' is properly set or not.
241 # - There is an internal interface for each Interface record whose
242 # 'type' is 'internal'.
244 # But ignore interfaces that don't really exist.
245 for d in `(ovs_vsctl --bare \
246 -- --columns=name find Interface type=internal \
247 -- list-br) | sort -u`
249 if test -e "/sys/class/net/$d"; then
256 "$datadir/scripts/ovs-save" $ifaces > "$script"
259 force_reload_kmod () {
260 ifaces=`internal_interfaces`
261 action "Detected internal interfaces: $ifaces" true
266 trap 'rm -f "$script"' 0 1 2 13 15
267 if action "Saving interface configuration" save_interfaces; then
270 log_warning_msg "Failed to save configuration, not replacing kernel module"
276 for dp in `ovs-dpctl dump-dps`; do
277 action "Removing datapath: $dp" ovs-dpctl del-dp "$dp"
280 if test -e /sys/module/brcompat_mod; then
281 action "Removing brcompat module" rmmod brcompat_mod
283 if test -e /sys/module/openvswitch_mod; then
284 action "Removing openvswitch module" rmmod openvswitch_mod
289 action "Restoring interface configuration" "$script"
291 if test $rc = 0; then
296 log="logger -p daemon.$level -t ovs-save"
297 $log "force-reload-kmod interface restore script exited with status $rc:"
301 ## --------------- ##
302 ## enable-protocol ##
303 ## --------------- ##
306 # Translate the protocol name to a number, because "iptables -n -L" prints
307 # some protocols by name (despite the -n) and therefore we need to look for
310 # (iptables -S output is more uniform but old iptables doesn't have it.)
311 protonum=`grep "^$PROTOCOL[ ]" /etc/protocols | awk '{print $2}'`
312 if expr X"$protonum" : X'[0-9]\{1,\}$' > /dev/null; then :; else
313 log_failure_msg "unknown protocol $PROTOCOL"
318 match="(\$2 == \"$PROTOCOL\" || \$2 == $protonum)"
319 insert="iptables -I INPUT -p $PROTOCOL"
320 if test X"$DPORT" != X; then
321 name="$name to port $DPORT"
322 match="$match && /dpt:$DPORT/"
323 insert="$insert --dport $DPORT"
325 if test X"$SPORT" != X; then
326 name="$name from port $SPORT"
327 match="$match && /spt:$SPORT/"
328 insert="$insert --sport $SPORT"
330 insert="$insert -j ACCEPT"
332 if (iptables -n -L INPUT) >/dev/null 2>&1; then
333 if iptables -n -L INPUT | awk "$match { n++ } END { exit n == 0 }"
335 # There's already a rule for this protocol. Don't override it.
336 log_success_msg "iptables already has a rule for $name, not explicitly enabling"
338 action "Enabling $name with iptables" $insert
340 elif (iptables --version) >/dev/null 2>&1; then
341 action "cannot list iptables rules, not adding a rule for $name"
343 action "iptables binary not installed, not adding a rule for $name"
360 OVSDB_SERVER_PRIORITY=-10
361 OVS_VSWITCHD_PRIORITY=-10
362 OVS_BRCOMPATD_PRIORITY=-10
364 DB_FILE=$etcdir/conf.db
365 DB_SOCK=$rundir/db.sock
366 DB_SCHEMA=$datadir/vswitch.ovsschema
372 if (lsb_release --id) >/dev/null 2>&1; then
373 SYSTEM_TYPE=`lsb_release --id -s`
374 system_release=`lsb_release --release -s`
375 system_codename=`lsb_release --codename -s`
376 SYSTEM_VERSION="${system_release}-${system_codename}"
379 SYSTEM_VERSION=unknown
386 $0: controls Open vSwitch daemons
387 usage: $0 [OPTIONS] COMMAND
389 This program is intended to be invoked internally by Open vSwitch startup
390 scripts. System administrators should not normally invoke it directly.
393 start start Open vSwitch daemons
394 stop stop Open vSwitch daemons
395 status check whether Open vSwitch daemons are running
396 version print versions of Open vSwitch daemons
397 force-reload-kmod save OVS network device state, stop OVS, unload kernel
398 module, reload kernel module, start OVS, restore state
399 enable-protocol enable protocol specified in options with iptables
400 help display this help message
402 One of the following options is required for "start" and "force-reload-kmod":
403 --system-id=UUID set specific ID to uniquely identify this system
404 --system-id=random use a random but persistent UUID to identify this system
406 Other important options for "start" and "force-reload-kmod":
407 --system-type=TYPE set system type (e.g. "XenServer")
408 --system-version=VERSION set system version (e.g. "5.6.100-39265p")
409 --external-id="key=value"
410 add given key-value pair to Open_vSwitch external-ids
411 --delete-bridges delete all bridges just before starting ovs-vswitchd
413 Less important options for "start" and "force-reload-kmod":
414 --daemon-cwd=DIR set working dir for OVS daemons (default: $DAEMON_CWD)
415 --no-force-corefiles do not force on core dumps for OVS daemons
416 --no-mlockall do not lock all of ovs-vswitchd into memory
417 --ovsdb-server-priority=NICE set ovsdb-server's niceness (default: $OVSDB_SERVER_PRIORITY)
418 --ovs-vswitchd-priority=NICE set ovs-vswitchd's niceness (default: $OVS_VSWITCHD_PRIORITY)
419 --ovs-brcompatd-priority=NICE set ovs-brcompatd's niceness (default: $OVS_BRCOMPATD_PRIORITY)
421 Options for "start", "force-reload-kmod", "status", and "version":
422 --brcompat enable Linux bridge compatibility module and daemon
424 File location options:
425 --db-file=FILE database file name (default: $DB_FILE)
426 --db-sock=SOCKET JSON-RPC socket name (default: $DB_SOCK)
427 --db-schema=FILE database schema file name (default: $DB_SCHEMA)
429 Options for "enable-protocol":
430 --protocol=PROTOCOL protocol to enable with iptables (default: gre)
431 --sport=PORT source port to match (for tcp or udp protocol)
432 --dport=PORT ddestination port to match (for tcp or udp protocol)
435 -h, --help display this help message
436 -V, --version display version information
438 Default directories with "configure" option and environment variable override:
439 logs: @LOGDIR@ (--log-dir, OVS_LOGDIR)
440 pidfiles and sockets: @RUNDIR@ (--run-dir, OVS_RUNDIR)
441 system configuration: @sysconfdir@ (--sysconfdir, OVS_SYSCONFDIR)
442 data files: @pkgdatadir@ (--pkgdatadir, OVS_PKGDATADIR)
443 user binaries: @bindir@ (--bindir, OVS_BINDIR)
444 system binaries: @sbindir@ (--sbindir, OVS_SBINDIR)
446 Please report bugs to bugs@openvswitch.org (see REPORTING-BUGS for details).
453 var=`echo "$option" | tr abcdefghijklmnopqrstuvwxyz- ABCDEFGHIJKLMNOPQRSTUVWXYZ_`
454 eval set=\${$var+yes}
455 eval old_value=\$$var
456 if test X$set = X || \
457 (test $type = bool && \
458 test X"$old_value" != Xno && test X"$old_value" != Xyes); then
459 echo >&2 "$0: unknown option \"$arg\" (use --help for help)"
466 echo ovsdb-server ovs-vswitchd
467 if test X"$BRCOMPAT" = Xyes; then
482 echo "$0 (Open vSwitch) $VERSION$BUILDNR"
486 value=`expr X"$arg" : 'X[^=]*=\(.*\)'`
489 extra_ids="$extra_ids external-ids:$value"
492 echo >&2 "$0: --external-id argument not in the form \"key=value\""
498 option=`expr X"$arg" : 'X--\([^=]*\)'`
499 value=`expr X"$arg" : 'X[^=]*=\(.*\)'`
504 option=`expr X"$arg" : 'X--no-\(.*\)'`
510 option=`expr X"$arg" : 'X--\(.*\)'`
516 echo >&2 "$0: unknown option \"$arg\" (use --help for help)"
520 if test X"$command" = X; then
523 echo >&2 "$0: exactly one non-option argument required (use --help for help)"
538 for daemon in `daemons`; do
539 daemon_status $daemon || rc=$?
544 for daemon in `daemons`; do
558 echo >&2 "$0: missing command name (use --help for help)"
562 echo >&2 "$0: unknown command \"$command\" (use --help for help)"