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_modules_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
55 ovs-vsctl --no-wait --timeout=5 "$@"
59 ovsdb-tool -vANY:console:emer "$@"
63 schemaver=`ovsdb_tool schema-version "$DB_SCHEMA"`
64 if test ! -e "$DB_FILE"; then
65 log_warning_msg "$DB_FILE does not exist"
66 install -d -m 755 -o root -g root `dirname $DB_FILE`
68 action "Creating empty database $DB_FILE" true
69 ovsdb_tool create "$DB_FILE" "$DB_SCHEMA"
70 elif test X"`ovsdb_tool needs-conversion "$DB_FILE" "$DB_SCHEMA"`" != Xno; then
71 # Back up the old version.
72 version=`ovsdb_tool db-version "$DB_FILE"`
73 cksum=`ovsdb_tool db-cksum "$DB_FILE" | awk '{print $1}'`
74 cp "$DB_FILE" "$DB_FILE.backup$version-$cksum"
76 # Compact database. This is important if the old schema did not enable
77 # garbage collection (i.e. if it did not have any tables with "isRoot":
78 # true) but the new schema does. In that situation the old database
79 # may contain a transaction that creates a record followed by a
80 # transaction that creates the first use of the record. Replaying that
81 # series of transactions against the new database schema (as "convert"
82 # does) would cause the record to be dropped by the first transaction,
83 # then the second transaction would cause a referential integrity
84 # failure (for a strong reference).
85 ovsdb_tool compact "$DB_FILE"
87 # Upgrade or downgrade schema.
88 ovsdb_tool convert "$DB_FILE" "$DB_SCHEMA"
93 set ovs_vsctl set Open_vSwitch .
95 OVS_VERSION=`ovs-vswitchd --version | sed 's/.*) //;1q'`
96 set "$@" ovs-version="$OVS_VERSION"
100 id_file=$etcdir/system-id.conf
101 uuid_file=$etcdir/install_uuid.conf
102 if test -e "$id_file"; then
103 SYSTEM_ID=`cat "$id_file"`
104 elif test -e "$uuid_file"; then
105 # Migrate from old file name.
107 SYSTEM_ID=$INSTALLATION_UUID
108 echo "$SYSTEM_ID" > "$id_file"
109 elif SYSTEM_ID=`uuidgen`; then
110 echo "$SYSTEM_ID" > "$id_file"
112 log_failure_msg "missing uuidgen, could not generate system ID"
117 log_failure_msg "system ID not configured, please use --system-id"
123 set "$@" external-ids:system-id="\"$SYSTEM_ID\""
125 if test X"$SYSTEM_TYPE" != X; then
126 set "$@" system-type="\"$SYSTEM_TYPE\""
128 log_failure_msg "no default system type, please use --system-type"
131 if test X"$SYSTEM_VERSION" != X; then
132 set "$@" system-version="\"$SYSTEM_VERSION\""
134 log_failure_msg "no default system version, please use --system-version"
137 action "Configuring Open vSwitch system IDs" "$@" $extra_ids
141 if test X"$FORCE_COREFILES" = Xyes; then
145 insert_modules_if_required || return 1
147 if daemon_is_running ovsdb-server; then
148 log_success_msg "ovsdb-server is already running"
150 # Create initial database or upgrade database schema.
151 upgrade_db || return 1
153 # Start ovsdb-server.
154 set ovsdb-server "$DB_FILE"
155 set "$@" -vANY:CONSOLE:EMER -vANY:SYSLOG:ERR -vANY:FILE:INFO
156 set "$@" --remote=punix:"$DB_SOCK"
157 set "$@" --remote=db:Open_vSwitch,manager_options
158 set "$@" --private-key=db:SSL,private_key
159 set "$@" --certificate=db:SSL,certificate
160 set "$@" --bootstrap-ca-cert=db:SSL,ca_cert
161 start_daemon "$OVSDB_SERVER_PRIORITY" "$@" || return 1
163 # Initialize database settings.
164 ovs_vsctl -- init -- set Open_vSwitch . db-version="$schemaver" \
166 set_system_ids || return 1
167 if test X"$DELETE_BRIDGES" = Xyes; then
168 for bridge in `ovs_vsctl list-br`; do
169 ovs_vsctl del-br $bridge
174 if daemon_is_running ovs-vswitchd; then
175 log_success_msg "ovs-vswitchd is already running"
177 # Increase the limit on the number of open file descriptors since
178 # ovs-vswitchd needs a few per bridge
181 # Start ovs-vswitchd.
182 set ovs-vswitchd unix:"$DB_SOCK"
183 set "$@" -vANY:CONSOLE:EMER -vANY:SYSLOG:ERR -vANY:FILE:INFO
184 if test X"$MLOCKALL" != Xno; then
187 start_daemon "$VSWITCHD_PRIORITY" "$@"
196 stop_daemon ovs-vswitchd
197 stop_daemon ovsdb-server
200 ## ----------------- ##
201 ## force-reload-kmod ##
202 ## ----------------- ##
204 internal_interfaces () {
205 # Outputs a list of internal interfaces:
207 # - There is an internal interface for every bridge, whether it
208 # has an Interface record or not and whether the Interface
209 # record's 'type' is properly set or not.
211 # - There is an internal interface for each Interface record whose
212 # 'type' is 'internal'.
214 # But ignore interfaces that don't really exist.
215 for d in `(ovs_vsctl --bare \
216 -- --columns=name find Interface type=internal \
217 -- list-br) | sort -u`
219 if test -e "/sys/class/net/$d"; then
225 force_reload_kmod () {
226 ifaces=`internal_interfaces`
227 action "Detected internal interfaces: $ifaces" true
232 action "Save interface configuration to $script" true
233 if "$datadir/scripts/ovs-save" $ifaces > "$script"; then
236 log_warning_msg "Failed to save configuration, not replacing kernel module"
242 for dp in `ovs-dpctl dump-dps`; do
243 action "Removing datapath: $dp" "$dpctl" del-dp "$dp"
246 if test -e /sys/module/openvswitch_mod; then
247 action "Removing openvswitch module" rmmod openvswitch_mod
252 action "Restore interface configuration from $script" "$script"
267 OVSDB_SERVER_PRIORITY=-10
268 OVS_VSWITCHD_PRIORITY=-10
270 DB_FILE=$etcdir/conf.db
271 DB_SOCK=$rundir/db.sock
272 DB_SCHEMA=$datadir/vswitch.ovsschema
274 if (lsb_release --id) >/dev/null 2>&1; then
275 SYSTEM_TYPE=`lsb_release --id -s`
276 system_release=`lsb_release --release -s`
277 system_codename=`lsb_release --codename -s`
278 SYSTEM_VERSION="${system_release}-${system_codename}"
281 SYSTEM_VERSION=unknown
288 $0: controls Open vSwitch daemons
289 usage: $0 [OPTIONS] COMMAND
291 This program is intended to be invoked internally by Open vSwitch startup
292 scripts. System administrators should not normally invoke it directly.
295 start start Open vSwitch daemons
296 stop stop Open vSwitch daemons
297 status check whether Open vSwitch daemons are running
298 version print versions of Open vSwitch daemons
299 force-reload-kmod save OVS network device state, stop OVS, unload kernel
300 module, reload kernel module, start OVS, restore state
301 help display this help message
303 One of the following options should be specified when starting Open vSwitch:
304 --system-id=UUID set specific ID to uniquely identify this system
305 --system-id=random use a random but persistent UUID to identify this system
307 Other important options for starting Open vSwitch:
308 --system-type=TYPE set system type (e.g. "XenServer")
309 --system-version=VERSION set system version (e.g. "5.6.100-39265p")
310 --external-id="key=value"
311 add given key-value pair to Open_vSwitch external-ids
312 --delete-bridges delete all bridges just before starting ovs-vswitchd
314 Less important options for starting Open vSwitch:
315 --daemon-cwd=DIR current working directory for OVS daemons (default: $DAEMON_CWD)
317 do not forcibly enable core dumps for OVS daemons
318 --no-mlockall do not lock all of ovs-vswitchd into memory
319 --ovsdb-server-priority=NICE
320 set ovsdb-server's niceness (default: $OVSDB_SERVER_PRIORITY)
321 --ovs-vswitchd-priority=NICE
322 set ovs-vswitchd's niceness (default: $OVS_VSWITCHD_PRIORITY)
324 File location options:
325 --db-file=FILE database file name (default: $DB_FILE)
326 --db-sock=SOCKET JSON-RPC socket name (default: $DB_SOCK)
327 --db-schema=FILE database schema file name (default: $DB_SCHEMA)
330 -h, --help display this help message
331 -V, --version display version information
333 Default directories with "configure" option and environment variable override:
334 logs: @LOGDIR@ (--log-dir, OVS_LOGDIR)
335 pidfiles and sockets: @RUNDIR@ (--run-dir, OVS_RUNDIR)
336 system configuration: @sysconfdir@ (--sysconfdir, OVS_SYSCONFDIR)
337 data files: @pkgdatadir@ (--pkgdatadir, OVS_PKGDATADIR)
338 user binaries: @bindir@ (--bindir, OVS_BINDIR)
339 system binaries: @sbindir@ (--sbindir, OVS_SBINDIR)
341 Please report bugs to bugs@openvswitch.org (see REPORTING-BUGS for details).
348 var=`echo "$option" | tr abcdefghijklmnopqrstuvwxyz- ABCDEFGHIJKLMNOPQRSTUVWXYZ_`
349 eval set=\${$var+yes}
350 eval old_value=\$$var
351 if test X$set = X || \
352 (test $type = bool && \
353 test X"$old_value" != Xno && test X"$old_value" != Xyes); then
354 echo >&2 "$0: unknown option \"$arg\" (use --help for help)"
370 echo "$0 (Open vSwitch) $VERSION$BUILDNR"
374 value=`expr X"$arg" : 'X[^=]*=\(.*\)'`
377 extra_ids="$extra_ids external-ids:$value"
380 echo >&2 "$0: --external-id argument not in the form \"key=value\""
386 option=`expr X"$arg" : 'X--\([^=]*\)'`
387 value=`expr X"$arg" : 'X[^=]*=\(.*\)'`
392 option=`expr X"$arg" : 'X--no-\(.*\)'`
398 option=`expr X"$arg" : 'X--\(.*\)'`
404 echo >&2 "$0: unknown option \"$arg\" (use --help for help)"
408 if test X"$command" = X; then
411 echo >&2 "$0: exactly one non-option argument required (use --help for help)"
425 daemon_status ovsdb-server && daemon_status ovs-vswitchd
428 ovsdb-server --version && ovs-vswitchd --version
437 echo >&2 "$0: missing command name (use --help for help)"
441 echo >&2 "$0: unknown command \"$command\" (use --help for help)"