From: Ben Pfaff Date: Tue, 7 Jun 2011 16:40:53 +0000 (-0700) Subject: ovs-openflowd: Rename test-openflowd and move to "tests" directory. X-Git-Url: https://pintos-os.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=045b2e5c77d02cd0d7bba046e2dbed72ec4828c8;p=openvswitch ovs-openflowd: Rename test-openflowd and move to "tests" directory. Too many users thought that they needed to run ovs-openflowd at the same time as ovs-vswitchd. I hope that this change discourages them. --- diff --git a/ChangeLog b/ChangeLog index e1539c77..ba39a17a 100644 --- a/ChangeLog +++ b/ChangeLog @@ -4,6 +4,9 @@ post v1.1.0 counters for each port. - ovs-vsctl: - New "show" command to print an overview of configuration. + - ovs-openflowd has been renamed test-openflowd and moved into the + tests directory. Its presence confused too many users. Please + use ovs-vswitchd instead. - Feature removals: - Dropped support for "tun_id_from_cookie" OpenFlow extension. (Use the extensible match extensions instead.) diff --git a/INSTALL.OpenFlow b/INSTALL.OpenFlow deleted file mode 100644 index 173a6883..00000000 --- a/INSTALL.OpenFlow +++ /dev/null @@ -1,150 +0,0 @@ - Using Open vSwitch as a Simple OpenFlow Switch - ============================================== - -Open vSwitch uses OpenFlow as its preferred method of remote flow -table configuration. This is the simplest method of using it with an -OpenFlow controller. The ovs-vsctl "set-controller" command can also -be used in conjunction with ovs-vswitchd to set the controller for one -or more bridges. We recommend using OpenFlow in this manner and in this -case you should not run ovs-openflowd. Directions for setting up -ovs-vswitchd can be found in INSTALL.Linux. - -However, it is also possible to use Open vSwitch as a simple OpenFlow -switch like that provided by the OpenFlow reference implementation -[1]. The remainder of this file describes how to use it in that -manner. - -What is OpenFlow? ------------------ - -OpenFlow is a flow-based switch specification designed to enable -researchers to run experiments in live networks. OpenFlow is based on a -simple Ethernet flow switch that exposes a standardized interface for -adding and removing flow entries. - -An OpenFlow switch consists of three parts: (1) A "flow table" in -which each flow entry is associated with an action telling the switch -how to process the flow, (2) a "secure channel" that connects the switch -to a remote process (a controller), allowing commands and packets to -be sent between the controller and the switch, and (3) an OpenFlow -protocol implementation, providing an open and standard way for a -controller to talk to the switch. - -An OpenFlow switch can thus serve as a simple datapath element that -forwards packets between ports according to flow actions defined by -the controller using OpenFlow commands. Example actions are: - - - Forward this flow's packets to the given port(s) - - Drop this flow's packets - - Encapsulate and forward this flow's packets to the controller. - -The OpenFlow switch is defined in detail in the OpenFlow switch -Specification [2]. - -Installation Procedure ----------------------- - -The procedure below explains how to use the Open vSwitch as a simple -OpenFlow switch. - -1. Build and install the Open vSwitch kernel modules and userspace - programs as described in INSTALL.Linux. - - It is important to run "make install", because some Open vSwitch - programs expect to find files in locations selected at installation - time. - -2. Load the openvswitch kernel module (which was built in step 1), e.g.: - - % insmod datapath/linux-2.6/openvswitch_mod.ko - - If your Linux kernel is earlier than 2.6.36, this kernel module - cannot be loaded if the Linux bridge module is already loaded. - Thus, you may need to remove any existing bridges and unload the - bridge module with "rmmod bridge" before you can do this. - -3. Create a datapath instance. The command below creates a datapath - identified as dp0 (see ovs-dpctl(8) for more detailed usage - information). - - # ovs-dpctl add-dp dp0 - - Creating datapath dp0 creates a new network device, also named dp0. - This network device, called the datapath's "local port", will be - bridged to the physical switch ports by ovs-openflowd(8). It is - optionally used for in-band control as described in step 5. - -4. Use ovs-dpctl to attach the datapath to physical interfaces on the - machine. Say, for example, you want to create a trivial 2-port - switch using interfaces eth1 and eth2, you would issue the following - commands: - - # ovs-dpctl add-if dp0 eth1 - # ovs-dpctl add-if dp0 eth2 - - You can verify that the interfaces were successfully added by asking - ovs-dpctl to print the current status of datapath dp0: - - # ovs-dpctl show dp0 - -5. Arrange so that the switch can reach the controller over the network. - This can be done in two ways. The switch may be configured for - out-of-band control, which means it uses a network separate from the - data traffic that it controls. Alternatively, the switch may be - configured to contact the controller over one of the network devices - under its control. In-band control is often more convenient than - out-of-band, because it is not necessary to maintain two independent - networks. - - - If you are using out-of-band control, at this point make sure - that the switch machine can reach the controller over the - network. - - - If you are using in-band control, then at this point you must - configure the dp0 network device created in step 3. This - device is not yet bridged to any physical network (because - ovs-openflowd does that, and it is not yet running), so the next - step depends on whether connectivity is required to configure - the device's IP address: - - * If the switch has a static IP address, you may configure - its IP address now, e.g.: - - # ifconfig dp0 192.168.1.1 - - * If the switch does not have a static IP address, e.g. its - IP address is obtained dynamically via DHCP, then proceed - to the next step. The DHCP client will not be able to - contact the DHCP server until the secure channel has - started. The address will be obtained in step 7. - -6. Run ovs-openflowd to start the secure channel connecting the datapath to - a remote controller. If the controller is running on host - 192.168.1.2 port 6633 (the default port), the ovs-openflowd invocation - would look like this: - - # ovs-openflowd dp0 tcp:192.168.1.2 - - - If you are using out-of-band control, add --out-of-band to the - command line. - - Using the "tcp:" argument causes the switch to connect - in an insecure manner. Please see INSTALL.SSL for a description of - how to connect securely using SSL. - -7. If you are using in-band control, and the switch obtains its IP address - dynamically, then you may now obtain the switch's IP address, e.g. by - invoking a DHCP client. The secure channel will only be able to connect - to the controller after an IP address has been obtained. - -8. The secure channel should connect to the controller within a few - seconds. - -References ----------- - - [1] OpenFlow Reference Implementation. - - - [2] OpenFlow Switch Specification. - diff --git a/INSTALL.userspace b/INSTALL.userspace index c13365a4..6e6fcd49 100644 --- a/INSTALL.userspace +++ b/INSTALL.userspace @@ -47,18 +47,6 @@ ovs-vswitchd will create a TAP device as the bridge's local interface, named the same as the bridge, as well as for each configured internal interface. -Using the Userspace Datapath with ovs-openflowd ------------------------------------------------ - -To use ovs-openflowd in userspace mode, specify a datapath name that -begins with "netdev@", and specify --ports with the names of the ports -that should be included in the datapath as argument. For example: - - ovs-openflowd netdev@br0 --ports=eth0,eth1,eth2 - -ovs-openflowd will create a TAP device as the bridge's local -interface, named the same as the bridge minus the "netdev@" prefix. - Bug Reporting ------------- diff --git a/Makefile.am b/Makefile.am index 71a0652c..f0e75711 100644 --- a/Makefile.am +++ b/Makefile.am @@ -34,7 +34,6 @@ EXTRA_DIST = \ DESIGN \ INSTALL.KVM \ INSTALL.Linux \ - INSTALL.OpenFlow \ INSTALL.SSL \ INSTALL.XenServer \ INSTALL.bridge \ @@ -58,6 +57,7 @@ man_MANS = noinst_DATA = noinst_HEADERS = noinst_LIBRARIES = +noinst_man_MANS = noinst_PROGRAMS = noinst_SCRIPTS = OVSIDL_BUILT = diff --git a/PORTING b/PORTING index 09458ee4..c395d653 100644 --- a/PORTING +++ b/PORTING @@ -242,9 +242,9 @@ latter is equivalent to the one of the former, but the difference in name makes the intended use obvious. ovs-vswitchd is the most sophisticated of ofproto's clients, but -ofproto can have other clients as well. ovs-openflowd, in the -utilities directory, is much simpler than ovs-vswitchd. It may be -easier to initially bring up ovs-openflowd as part of a port. +ofproto can have other clients as well. test-openflowd, in the +tests directory, is much simpler than ovs-vswitchd. It may be +easier to initially bring up test-openflowd as part of a port. lib/entropy.c assumes that it can obtain high-quality random number seeds at startup by reading from /dev/urandom. You will need to diff --git a/README b/README index 8972aec0..d23636d5 100644 --- a/README +++ b/README @@ -71,12 +71,7 @@ The main components of this distribution are: * ovsdbmonitor, a GUI tool for remotely viewing OVS databases and OpenFlow flow tables. -Open vSwitch also provides an OpenFlow implementation and tools for -those interested in OpenFlow but not additional Open vSwitch features: - - * ovs-openflowd, an alternative to ovs-vswitchd that implements a - simple OpenFlow switch, without the special features provided by - ovs-vswitchd. +Open vSwitch also provides some tools: * ovs-controller, a simple OpenFlow controller. diff --git a/tests/.gitignore b/tests/.gitignore index a1bde03e..e2b293c4 100644 --- a/tests/.gitignore +++ b/tests/.gitignore @@ -21,6 +21,8 @@ /test-list /test-lockfile /test-multipath +/test-openflowd +/test-openflowd.8 /test-ovsdb /test-packets /test-random diff --git a/tests/automake.mk b/tests/automake.mk index eda69f7b..750f420d 100644 --- a/tests/automake.mk +++ b/tests/automake.mk @@ -113,7 +113,6 @@ check-lcov: all tests/atconfig tests/atlocal $(TESTSUITE) $(lcov_wrappers) valgrind_wrappers = \ tests/valgrind/ovs-appctl \ - tests/valgrind/ovs-openflowd \ tests/valgrind/ovs-vsctl \ tests/valgrind/ovsdb-client \ tests/valgrind/ovsdb-server \ @@ -131,6 +130,7 @@ valgrind_wrappers = \ tests/valgrind/test-list \ tests/valgrind/test-lockfile \ tests/valgrind/test-multipath \ + tests/valgrind/test-openflowd \ tests/valgrind/test-ovsdb \ tests/valgrind/test-packets \ tests/valgrind/test-random \ @@ -230,6 +230,18 @@ noinst_PROGRAMS += tests/test-multipath tests_test_multipath_SOURCES = tests/test-multipath.c tests_test_multipath_LDADD = lib/libopenvswitch.a +noinst_PROGRAMS += tests/test-openflowd +EXTRA_DIST += tests/test-openflowd.8.in +DISTCLEANFILES += tests/test-openflowd.8 +noinst_man_MANS += tests/ovs-openflowd.8 +tests_test_openflowd_SOURCES = tests/test-openflowd.c +tests_test_openflowd_LDADD = \ + ofproto/libofproto.a \ + lib/libsflow.a \ + lib/libopenvswitch.a \ + $(SSL_LIBS) + + noinst_PROGRAMS += tests/test-packets tests_test_packets_SOURCES = tests/test-packets.c tests_test_packets_LDADD = lib/libopenvswitch.a diff --git a/tests/ofproto-macros.at b/tests/ofproto-macros.at index dc863e73..24cb45a7 100644 --- a/tests/ofproto-macros.at +++ b/tests/ofproto-macros.at @@ -5,10 +5,10 @@ m4_define([TESTABLE_LOG], [-vPATTERN:ANY:'%c|%p|%m']) m4_define([OFPROTO_START], [OVS_RUNDIR=$PWD; export OVS_RUNDIR OVS_LOGDIR=$PWD; export OVS_LOGDIR - trap 'kill `cat ovs-openflowd.pid`' 0 - AT_CAPTURE_FILE([ovs-openflowd.log]) + trap 'kill `cat test-openflowd.pid`' 0 + AT_CAPTURE_FILE([test-openflowd.log]) AT_CHECK( - [ovs-openflowd --detach --pidfile --enable-dummy --log-file --fail=closed dummy@br0 none --datapath-id=fedcba9876543210 $1], + [test-openflowd --detach --pidfile --enable-dummy --log-file --fail=closed dummy@br0 none --datapath-id=fedcba9876543210 $1], [0], [], [stderr]) AT_CHECK([[sed < stderr ' /vlog|INFO|opened log file/d @@ -19,5 +19,5 @@ m4_define([OFPROTO_START], ]) m4_define([OFPROTO_STOP], - [AT_CHECK([ovs-appctl -t ovs-openflowd exit]) + [AT_CHECK([ovs-appctl -t test-openflowd exit]) trap '' 0]) diff --git a/tests/test-openflowd.8.in b/tests/test-openflowd.8.in new file mode 100644 index 00000000..135ba846 --- /dev/null +++ b/tests/test-openflowd.8.in @@ -0,0 +1,345 @@ +.TH test\-openflowd 8 "March 2009" "Open vSwitch" "Open vSwitch Manual" +.\" This program's name: +.ds PN test\-openflowd +.\" SSL peer program's name: +.ds SN ovs\-controller +. +.SH NAME +test\-openflowd \- OpenFlow switch implementation +. +.SH SYNOPSIS +.B test\-openflowd +[\fIoptions\fR] \fIdatapath\fR \fIcontroller\fR\&... +. +.SH DESCRIPTION +The \fBtest\-openflowd\fR program implements an OpenFlow switch using a +flow-based datapath. \fBtest\-openflowd\fR connects to one or more +OpenFlow controllers over TCP or SSL. +.PP +For a more powerful alternative to \fBtest\-openflowd\fR, see +\fBovs\-vswitchd\fR(8). Do not run both daemons at the same time. +.PP +The mandatory \fIdatapath\fR argument argument specifies the local +datapath to relay. It takes the form [\fItype\fB@\fR]\fIname\fR, +where \fIname\fR is the network device associated with the datapath's +local port. If \fItype\fR is given, it specifies the datapath +provider of \fIname\fR, otherwise the default provider \fBsystem\fR is +assumed. +. +.PP +The optional \fIcontroller\fR arguments specify how to connect to the +OpenFlow controller or controllers. Each takes one of the following +forms: +. +.so lib/vconn-active.man +.IP "\fBnone\fR" +Run without actively maintaining a connection to a remote OpenFlow +controller. (See the \fB\-\-listen\fR option, under \fBNetworking +Options\fR below, for another way to make OpenFlow connections to the +switch.) +. +.PP +When multiple controllers are configured, \fBtest\-openflowd\fR +connects to all of them simultaneously. OpenFlow 1.0 does not specify +how multiple controllers coordinate in interacting with a single +switch, so more than one controller should be specified only if the +controllers are themselves designed to coordinate with each other. +(The Nicira-defined \fBNXT_ROLE\fR OpenFlow vendor extension may be +useful for this.) +. +.SS "Contacting Controllers" +The OpenFlow switch must be able to contact the OpenFlow controllers +over the network. It can do so in one of two ways: +. +.IP out-of-band +In this configuration, OpenFlow traffic uses a network separate from +the data traffic that it controls, that is, the switch does not use +any of the network devices added to the datapath with \fBovs\-dpctl +add\-if\fR in its communication with the controller. +.IP +To use \fBtest\-openflowd\fR in a network with out-of-band control, specify +\fB\-\-out\-of\-band\fR on the \fBtest\-openflowd\fR command line. The control +network must be configured separately, before or after \fBtest\-openflowd\fR +is started. +. +.IP in-band +In this configuration, a single network is used for OpenFlow traffic +and other data traffic, that is, the switch contacts the controller +over one of the network devices added to the datapath with \fBovs\-dpctl +add\-if\fR. This configuration is often more convenient than +out-of-band control, because it is not necessary to maintain two +independent networks. +.IP +In-band control is the default for \fBtest\-openflowd\fR, so no special +command-line option is required. + +Specify the location of the +controller on the \fBtest\-openflowd\fR command line as the \fIcontroller\fR +argument. You must also configure the network device for the OpenFlow +``local port'' to allow \fBtest\-openflowd\fR to connect to that controller. +The OpenFlow local port is a virtual network port that \fBtest\-openflowd\fR +bridges to the physical switch ports. The name of the local port for +a given \fIdatapath\fR may be seen by running \fBovs\-dpctl show +\fIdatapath\fR; the local port is listed as port 0 in \fBshow\fR's +output. +. +.IP +Before \fBtest\-openflowd\fR starts, the local port network device is not +bridged to any physical network, so the next step depends on whether +connectivity is required to configure the device's IP address. If the +switch has a static IP address, you may configure its IP address now +with a command such as +.B ifconfig of0 192.168.1.1 +and then invoke \fBtest\-openflowd\fR. +.IP +On the other hand, if the switch does not have a static IP address, +e.g. it obtains its IP address dynamically via DHCP, the DHCP client +will not be able to contact the DHCP server until the OpenFlow switch +has started up. Thus, start \fBtest\-openflowd\fR without configuring +the local port network device, and start the DHCP client afterward. +.RE +. +.SH OPTIONS +.SS "OpenFlow Options" +.TP +\fB\-\-datapath\-id=\fIdpid\fR +Sets \fIdpid\fR, which must consist of exactly 16 hexadecimal digits +and may not be all-zero, +as the datapath ID that the switch will use to identify itself to +OpenFlow controllers. +.IP +If this option is omitted, the default datapath ID is taken from the +Ethernet address of the datapath's local port (which is typically +randomly generated) in the lower 48 bits and zeros in the upper 16. +. +.TP +\fB\-\-mfr\-desc=\fIdesc\fR +Set the description of the switch's manufacturer to \fIdesc\fR, which +may contain up to 255 ASCII characters. +. +.TP +\fB\-\-hw\-desc=\fIdesc\fR +Set the description of the switch's hardware revision to \fIdesc\fR, which +may contain up to 255 ASCII characters. +. +.TP +\fB\-\-sw\-desc=\fIdesc\fR +Set the description of the switch's software revision to \fIdesc\fR, which +may contain up to 255 ASCII characters. +. +.TP +\fB\-\-serial\-desc=\fIdesc\fR +Set the description of the switch's serial number to \fIdesc\fR, which +may contain up to 31 ASCII characters. +. +.TP +\fB\-\-dp\-desc=\fIdesc\fR +Set the description of the datapath to \fIdesc\fR, which may contain up to +255 ASCII characters. Note that this field is intended for debugging +purposes and is not guaranteed to be unique and should not be used as +the primary identifier of the datapath. +. +.SS "Networking Options" +.TP +\fB\-\-datapath\-id=\fIdpid\fR +Sets \fIdpid\fR, which must consist of exactly 16 hexadecimal digits, +as the datapath ID that the switch will use to identify itself to the +OpenFlow controller. +.IP +If this option is omitted, the default datapath ID is taken from the +Ethernet address of the datapath's local port (which is typically +randomly generated) in the lower 48 bits and zeros in the upper 16. +. +.TP +\fB\-\-fail=\fR[\fBstandalone\fR|\fBsecure\fR] +The controller is, ordinarily, responsible for setting up all flows on +the OpenFlow switch. Thus, if the connection to the controller fails, +no new network connections can be set up. If the connection to the +controller stays down long enough, no packets can pass through the +switch at all. +.IP +If this option is set to \fBstandalone\fR (the default), +\fBtest\-openflowd\fR will +take over responsibility for setting up flows in the local datapath +when no message has been received from the controller for three times +the inactivity probe interval (see below), or 45 seconds by default. +In this ``fail open'' mode, \fBtest\-openflowd\fR causes the datapath to act +like an ordinary MAC-learning switch. \fBtest\-openflowd\fR will continue to +retry connection to the controller in the background and, when the +connection succeeds, it discontinues its standalone switching behavior. +.IP +If this option is set to \fBsecure\fR, then \fBtest\-openflowd\fR will not +set up flows on its own when the controller connection fails. +. +.TP +\fB\-\-inactivity\-probe=\fIsecs\fR +When the OpenFlow switch is connected to the controller, the +switch waits for a message to be received from the controller for +\fIsecs\fR seconds before it sends a inactivity probe to the +controller. After sending the inactivity probe, if no response is +received for an additional \fIsecs\fR seconds, the switch +assumes that the connection has been broken and attempts to reconnect. +The default and the minimum value are both 5 seconds. +.IP +When fail-open mode is configured, changing the inactivity probe +interval also changes the interval before entering fail-open mode (see +above). +. +.TP +\fB\-\-max\-idle=\fIsecs\fR|\fBpermanent\fR +Sets \fIsecs\fR as the number of seconds that a flow set up by the +OpenFlow switch will remain in the switch's flow table without any +matching packets being seen. If \fBpermanent\fR is specified, which +is not recommended, flows set up by the switch will never +expire. The default is 15 seconds. +.IP +Most flows are set up by the OpenFlow controller, not by the +switch. This option affects only the following flows, which the +OpenFlow switch sets up itself: +. +.RS +.IP \(bu +When \fB\-\-fail=open\fR is specified, flows set up when the +switch has not been able to contact the controller for the configured +fail-open delay. +. +.IP \(bu +When in-band control is in use, flows set up to bootstrap contacting +the controller (see \fBContacting the Controller\fR, above, for +more information about in-band control). +.RE +. +.IP +As a result, when both \fB\-\-fail=secure\fR and \fB\-\-out\-of\-band\fR are +specified, this option has no effect. +. +.TP +\fB\-\-max\-backoff=\fIsecs\fR +Sets the maximum time between attempts to connect to the controller to +\fIsecs\fR, which must be at least 1. The actual interval between +connection attempts starts at 1 second and doubles on each failing +attempt until it reaches the maximum. The default maximum backoff +time is 8 seconds. +. +.TP +\fB\-l\fR, \fB\-\-listen=\fImethod\fR +By default, the switch listens for OpenFlow management connections on a +Unix domain socket named \fB@RUNDIR@/\fIdatapath\fB.mgmt\fR. This socket +can be used to perform local OpenFlow monitoring and administration with +tools such as \fBovs\-ofctl\fR. +.IP +This option may be used to override the default listener. The \fImethod\fR +must be given as one of the passive OpenFlow connection methods listed +below. This option may be specified multiple times to listen to +multiple connection methods. If a single \fImethod\fR of \fBnone\fR is +used, no listeners will be created. +. +.RS +.so lib/vconn-passive.man +.RE +. +.TP +\fB\-\-snoop=\fImethod\fR +Configures the switch to additionally listen for incoming OpenFlow +connections for controller connection snooping. The \fImethod\fR must +be given as one of the passive OpenFlow connection methods listed +under the \fB\-\-listen\fR option above. This option may be specified +multiple times to listen to multiple connection methods. +.IP +If \fBovs\-ofctl monitor\fR is used to connect to \fImethod\fR specified on +\fB\-\-snoop\fR, it will display all the OpenFlow messages traveling +between the switch and its controller on the primary OpenFlow +connection. This can be useful for debugging switch and controller +problems. +. +.TP +\fB\-\-in\-band\fR, \fB\-\-out\-of\-band\fR +Configures \fBtest\-openflowd\fR to operate in in-band or out-of-band control +mode (see \fBContacting the Controller\fR above). When neither option +is given, the default is in-band control. +. +.TP +\fB\-\-netflow=\fIip\fB:\fIport\fR +Configures the given UDP \fIport\fR on the specified IP \fIip\fR as +a recipient of NetFlow messages for expired flows. The \fIip\fR must +be specified numerically, not as a DNS name. +.IP +This option may be specified multiple times to configure additional +NetFlow collectors. +. +.SS "Rate-Limiting Options" +. +These options configure how the switch applies a ``token bucket'' to +limit the rate at which packets in unknown flows are forwarded to an +OpenFlow controller for flow-setup processing. This feature prevents +a single OpenFlow switch from overwhelming a controller. +. +.TP +\fB\-\-rate\-limit\fR[\fB=\fIrate\fR] +. +Limits the maximum rate at which packets will be forwarded to the +OpenFlow controller to \fIrate\fR packets per second. If \fIrate\fR +is not specified then the default of 1,000 packets per second is used. +.IP +If \fB\-\-rate\-limit\fR is not used, then the switch does not limit the +rate at which packets are forwarded to the controller. +. +.TP +\fB\-\-burst\-limit=\fIburst\fR +. +Sets the maximum number of unused packet credits that the switch will +allow to accumulate during time in which no packets are being +forwarded to the OpenFlow controller to \fIburst\fR (measured in +packets). The default \fIburst\fR is one-quarter of the \fIrate\fR +specified on \fB\-\-rate\-limit\fR. +. +This option takes effect only when \fB\-\-rate\-limit\fR is also specified. +. +.SS "Datapath Options" +. +.IP "\fB\-\-ports=\fIport\fR[\fB,\fIport\fR...]" +Ordinarily, \fBtest\-openflowd\fR expects the administrator to create +the specified \fIdatapath\fR and add ports to it externally with a +utility such as \fBovs\-dpctl\fR. However, the userspace switch +datapath is implemented inside \fBtest\-openflowd\fR itself and does +not (currently) have any external interface for \fBovs\-dpctl\fR to +access. As a stopgap measure, this option specifies one or more ports +to add to the datapath at \fBtest\-openflowd\fR startup time. Multiple +ports may be specified as a comma-separated list or by specifying +\fB\-\-ports\fR multiple times. +.IP +See \fBINSTALL.userspace\fR for more information about userspace +switching. +. +.SS "Daemon Options" +.so lib/daemon.man +. +.SS "Public Key Infrastructure Options" +.so lib/ssl.man +.so lib/ssl-bootstrap.man +. +.SS "Logging Options" +.so lib/vlog.man +.SS "Other Options" +.so lib/unixctl.man +.so lib/common.man +.so lib/leak-checker.man +. +.SH "RUNTIME MANAGEMENT COMMANDS" +\fBovs\-appctl\fR(8) can send commands to a running +\fBtest\-openflowd\fR process. The currently supported commands are +described below. +.SS "TEST\-OPENFLOWD COMMANDS" +These commands are specific to \fBtest\-openflowd\fR. +.IP "\fBexit\fR" +Causes \fBtest\-openflowd\fR to gracefully terminate. +.so ofproto/ofproto-unixctl.man +.so lib/vlog-unixctl.man +. +.SH "SEE ALSO" +. +.BR ovs\-appctl (8), +.BR ovs\-controller (8), +.BR ovs\-dpctl (8), +.BR ovs\-ofctl (8), +.BR ovs\-pki (8) diff --git a/tests/test-openflowd.c b/tests/test-openflowd.c new file mode 100644 index 00000000..b22b2aad --- /dev/null +++ b/tests/test-openflowd.c @@ -0,0 +1,541 @@ +/* + * Copyright (c) 2008, 2009, 2010, 2011 Nicira Networks. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at: + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include "command-line.h" +#include "compiler.h" +#include "daemon.h" +#include "dirs.h" +#include "dummy.h" +#include "leak-checker.h" +#include "list.h" +#include "netdev.h" +#include "ofpbuf.h" +#include "ofproto/ofproto.h" +#include "openflow/openflow.h" +#include "packets.h" +#include "poll-loop.h" +#include "rconn.h" +#include "stream-ssl.h" +#include "timeval.h" +#include "unixctl.h" +#include "util.h" +#include "vconn.h" +#include "vlog.h" + +VLOG_DEFINE_THIS_MODULE(openflowd); + +/* Settings that may be configured by the user. */ +struct ofsettings { + const char *unixctl_path; /* File name for unixctl socket. */ + + /* Controller configuration. */ + struct ofproto_controller *controllers; + size_t n_controllers; + enum ofproto_fail_mode fail_mode; + bool run_forever; /* Continue running even with no controller? */ + + /* Datapath. */ + uint64_t datapath_id; /* Datapath ID. */ + char *dp_name; /* Name of local datapath. */ + char *dp_type; /* Type of local datapath. */ + struct sset ports; /* Set of ports to add to datapath (if any). */ + + /* Description strings. */ + const char *mfr_desc; /* Manufacturer. */ + const char *hw_desc; /* Hardware. */ + const char *sw_desc; /* Software version. */ + const char *serial_desc; /* Serial number. */ + const char *dp_desc; /* Datapath description. */ + + /* Related vconns and network devices. */ + struct sset snoops; /* Listen for controller snooping conns. */ + + /* Failure behavior. */ + int max_idle; /* Idle time for flows in fail-open mode. */ + + /* NetFlow. */ + struct sset netflow; /* NetFlow targets. */ +}; + +static unixctl_cb_func test_openflowd_exit; + +static void parse_options(int argc, char *argv[], struct ofsettings *); +static void usage(void) NO_RETURN; + +int +main(int argc, char *argv[]) +{ + struct unixctl_server *unixctl; + struct ofproto *ofproto; + struct ofsettings s; + int error; + struct netflow_options nf_options; + const char *port; + bool exiting; + + proctitle_init(argc, argv); + set_program_name(argv[0]); + parse_options(argc, argv, &s); + signal(SIGPIPE, SIG_IGN); + + daemonize_start(); + + /* Start listening for ovs-appctl requests. */ + error = unixctl_server_create(s.unixctl_path, &unixctl); + if (error) { + exit(EXIT_FAILURE); + } + + unixctl_command_register("exit", test_openflowd_exit, &exiting); + + VLOG_INFO("Open vSwitch version %s", VERSION BUILDNR); + VLOG_INFO("OpenFlow protocol version 0x%02x", OFP_VERSION); + + error = ofproto_create(s.dp_name, s.dp_type, &ofproto); + if (error) { + VLOG_FATAL("could not initialize OpenFlow switch (%s)", + strerror(error)); + } + + /* Add ports to the datapath if requested by the user. */ + SSET_FOR_EACH (port, &s.ports) { + struct netdev *netdev; + + error = netdev_open_default(port, &netdev); + if (error) { + VLOG_FATAL("%s: failed to open network device (%s)", + port, strerror(error)); + } + + error = ofproto_port_add(ofproto, netdev, NULL); + if (error) { + VLOG_FATAL("failed to add %s as a port (%s)", + port, strerror(error)); + } + + netdev_close(netdev); + } + + /* Configure OpenFlow switch. */ + if (s.datapath_id) { + ofproto_set_datapath_id(ofproto, s.datapath_id); + } + ofproto_set_desc(ofproto, s.mfr_desc, s.hw_desc, s.sw_desc, + s.serial_desc, s.dp_desc); + error = ofproto_set_snoops(ofproto, &s.snoops); + if (error) { + VLOG_FATAL("failed to configure controller snooping connections (%s)", + strerror(error)); + } + memset(&nf_options, 0, sizeof nf_options); + nf_options.collectors = s.netflow; + error = ofproto_set_netflow(ofproto, &nf_options); + if (error) { + VLOG_FATAL("failed to configure NetFlow collectors (%s)", + strerror(error)); + } + ofproto_set_controllers(ofproto, s.controllers, s.n_controllers); + ofproto_set_fail_mode(ofproto, s.fail_mode); + + daemonize_complete(); + + exiting = false; + while (!exiting && (s.run_forever || ofproto_is_alive(ofproto))) { + error = ofproto_run(ofproto); + if (error) { + VLOG_FATAL("unrecoverable datapath error (%s)", strerror(error)); + } + unixctl_server_run(unixctl); + netdev_run(); + + ofproto_wait(ofproto); + unixctl_server_wait(unixctl); + netdev_wait(); + if (exiting) { + poll_immediate_wake(); + } + poll_block(); + } + + ofproto_destroy(ofproto); + + return 0; +} + +static void +test_openflowd_exit(struct unixctl_conn *conn, const char *args OVS_UNUSED, + void *exiting_) +{ + bool *exiting = exiting_; + *exiting = true; + unixctl_command_reply(conn, 200, NULL); +} + +/* User interface. */ + +/* Breaks 'ports' apart at commas and adds each resulting word to 'ports'. */ +static void +parse_ports(const char *s_, struct sset *ports) +{ + char *s = xstrdup(s_); + char *save_ptr = NULL; + char *token; + + for (token = strtok_r(s, ",", &save_ptr); token != NULL; + token = strtok_r(NULL, ",", &save_ptr)) { + sset_add(ports, token); + } + free(s); +} + +static void +parse_options(int argc, char *argv[], struct ofsettings *s) +{ + enum { + OPT_DATAPATH_ID = UCHAR_MAX + 1, + OPT_MFR_DESC, + OPT_HW_DESC, + OPT_SW_DESC, + OPT_SERIAL_DESC, + OPT_DP_DESC, + OPT_BR_NAME, + OPT_FAIL_MODE, + OPT_INACTIVITY_PROBE, + OPT_MAX_IDLE, + OPT_MAX_BACKOFF, + OPT_SNOOP, + OPT_RATE_LIMIT, + OPT_BURST_LIMIT, + OPT_BOOTSTRAP_CA_CERT, + OPT_OUT_OF_BAND, + OPT_IN_BAND, + OPT_NETFLOW, + OPT_PORTS, + OPT_UNIXCTL, + OPT_ENABLE_DUMMY, + VLOG_OPTION_ENUMS, + LEAK_CHECKER_OPTION_ENUMS, + DAEMON_OPTION_ENUMS + }; + static struct option long_options[] = { + {"datapath-id", required_argument, NULL, OPT_DATAPATH_ID}, + {"mfr-desc", required_argument, NULL, OPT_MFR_DESC}, + {"hw-desc", required_argument, NULL, OPT_HW_DESC}, + {"sw-desc", required_argument, NULL, OPT_SW_DESC}, + {"serial-desc", required_argument, NULL, OPT_SERIAL_DESC}, + {"dp-desc", required_argument, NULL, OPT_DP_DESC}, + {"config", required_argument, NULL, 'F'}, + {"br-name", required_argument, NULL, OPT_BR_NAME}, + {"fail", required_argument, NULL, OPT_FAIL_MODE}, + {"inactivity-probe", required_argument, NULL, OPT_INACTIVITY_PROBE}, + {"max-idle", required_argument, NULL, OPT_MAX_IDLE}, + {"max-backoff", required_argument, NULL, OPT_MAX_BACKOFF}, + {"listen", required_argument, NULL, 'l'}, + {"snoop", required_argument, NULL, OPT_SNOOP}, + {"rate-limit", optional_argument, NULL, OPT_RATE_LIMIT}, + {"burst-limit", required_argument, NULL, OPT_BURST_LIMIT}, + {"out-of-band", no_argument, NULL, OPT_OUT_OF_BAND}, + {"in-band", no_argument, NULL, OPT_IN_BAND}, + {"netflow", required_argument, NULL, OPT_NETFLOW}, + {"ports", required_argument, NULL, OPT_PORTS}, + {"unixctl", required_argument, NULL, OPT_UNIXCTL}, + {"enable-dummy", no_argument, NULL, OPT_ENABLE_DUMMY}, + {"verbose", optional_argument, NULL, 'v'}, + {"help", no_argument, NULL, 'h'}, + {"version", no_argument, NULL, 'V'}, + DAEMON_LONG_OPTIONS, + VLOG_LONG_OPTIONS, + LEAK_CHECKER_LONG_OPTIONS, + STREAM_SSL_LONG_OPTIONS, + {"bootstrap-ca-cert", required_argument, NULL, OPT_BOOTSTRAP_CA_CERT}, + {NULL, 0, NULL, 0}, + }; + char *short_options = long_options_to_short_options(long_options); + struct ofproto_controller controller_opts; + struct sset controllers; + const char *name; + int i; + + /* Set defaults that we can figure out before parsing options. */ + controller_opts.target = NULL; + controller_opts.max_backoff = 8; + controller_opts.probe_interval = 5; + controller_opts.band = OFPROTO_IN_BAND; + controller_opts.rate_limit = 0; + controller_opts.burst_limit = 0; + s->unixctl_path = NULL; + s->fail_mode = OFPROTO_FAIL_STANDALONE; + s->datapath_id = 0; + s->mfr_desc = NULL; + s->hw_desc = NULL; + s->sw_desc = NULL; + s->serial_desc = NULL; + s->dp_desc = NULL; + sset_init(&controllers); + sset_init(&s->snoops); + s->max_idle = 0; + sset_init(&s->netflow); + sset_init(&s->ports); + for (;;) { + int c; + + c = getopt_long(argc, argv, short_options, long_options, NULL); + if (c == -1) { + break; + } + + switch (c) { + case OPT_DATAPATH_ID: + if (!dpid_from_string(optarg, &s->datapath_id)) { + VLOG_FATAL("argument to --datapath-id must be exactly 16 hex " + "digits and may not be all-zero"); + } + break; + + case OPT_MFR_DESC: + s->mfr_desc = optarg; + break; + + case OPT_HW_DESC: + s->hw_desc = optarg; + break; + + case OPT_SW_DESC: + s->sw_desc = optarg; + break; + + case OPT_SERIAL_DESC: + s->serial_desc = optarg; + break; + + case OPT_DP_DESC: + s->dp_desc = optarg; + break; + + case OPT_FAIL_MODE: + if (!strcmp(optarg, "open") || !strcmp(optarg, "standalone")) { + s->fail_mode = OFPROTO_FAIL_STANDALONE; + } else if (!strcmp(optarg, "closed") + || !strcmp(optarg, "secure")) { + s->fail_mode = OFPROTO_FAIL_SECURE; + } else { + VLOG_FATAL("--fail argument must be \"standalone\" " + "or \"secure\""); + } + break; + + case OPT_INACTIVITY_PROBE: + controller_opts.probe_interval = atoi(optarg); + if (controller_opts.probe_interval < 5) { + VLOG_FATAL("--inactivity-probe argument must be at least 5"); + } + break; + + case OPT_MAX_IDLE: + if (!strcmp(optarg, "permanent")) { + s->max_idle = OFP_FLOW_PERMANENT; + } else { + s->max_idle = atoi(optarg); + if (s->max_idle < 1 || s->max_idle > 65535) { + VLOG_FATAL("--max-idle argument must be between 1 and " + "65535 or the word 'permanent'"); + } + } + break; + + case OPT_MAX_BACKOFF: + controller_opts.max_backoff = atoi(optarg); + if (controller_opts.max_backoff < 1) { + VLOG_FATAL("--max-backoff argument must be at least 1"); + } else if (controller_opts.max_backoff > 3600) { + controller_opts.max_backoff = 3600; + } + break; + + case OPT_RATE_LIMIT: + if (optarg) { + controller_opts.rate_limit = atoi(optarg); + if (controller_opts.rate_limit < 1) { + VLOG_FATAL("--rate-limit argument must be at least 1"); + } + } else { + controller_opts.rate_limit = 1000; + } + break; + + case OPT_BURST_LIMIT: + controller_opts.burst_limit = atoi(optarg); + if (controller_opts.burst_limit < 1) { + VLOG_FATAL("--burst-limit argument must be at least 1"); + } + break; + + case OPT_OUT_OF_BAND: + controller_opts.band = OFPROTO_OUT_OF_BAND; + break; + + case OPT_IN_BAND: + controller_opts.band = OFPROTO_IN_BAND; + break; + + case OPT_NETFLOW: + sset_add(&s->netflow, optarg); + break; + + case 'l': + sset_add(&controllers, optarg); + break; + + case OPT_SNOOP: + sset_add(&s->snoops, optarg); + break; + + case OPT_PORTS: + parse_ports(optarg, &s->ports); + break; + + case OPT_UNIXCTL: + s->unixctl_path = optarg; + break; + + case OPT_ENABLE_DUMMY: + dummy_enable(); + break; + + case 'h': + usage(); + + case 'V': + OVS_PRINT_VERSION(OFP_VERSION, OFP_VERSION); + exit(EXIT_SUCCESS); + + DAEMON_OPTION_HANDLERS + + VLOG_OPTION_HANDLERS + + LEAK_CHECKER_OPTION_HANDLERS + + STREAM_SSL_OPTION_HANDLERS + + case OPT_BOOTSTRAP_CA_CERT: + stream_ssl_set_ca_cert_file(optarg, true); + break; + + case '?': + exit(EXIT_FAILURE); + + default: + abort(); + } + } + free(short_options); + + argc -= optind; + argv += optind; + if (argc < 2) { + VLOG_FATAL("need at least two non-option arguments; " + "use --help for usage"); + } + + /* Rate limiting. */ + if (controller_opts.rate_limit && controller_opts.rate_limit < 100) { + VLOG_WARN("Rate limit set to unusually low value %d", + controller_opts.rate_limit); + } + + /* Local vconns. */ + ofproto_parse_name(argv[0], &s->dp_name, &s->dp_type); + + /* Figure out controller names. */ + s->run_forever = false; + if (sset_is_empty(&controllers)) { + sset_add_and_free(&controllers, xasprintf("punix:%s/%s.mgmt", + ovs_rundir(), s->dp_name)); + } + for (i = 1; i < argc; i++) { + if (!strcmp(argv[i], "none")) { + s->run_forever = true; + } else { + sset_add(&controllers, argv[i]); + } + } + + /* Set up controllers. */ + s->n_controllers = sset_count(&controllers); + s->controllers = xmalloc(s->n_controllers * sizeof *s->controllers); + i = 0; + SSET_FOR_EACH (name, &controllers) { + s->controllers[i] = controller_opts; + s->controllers[i].target = xstrdup(name); + i++; + } + sset_destroy(&controllers); +} + +static void +usage(void) +{ + printf("%s: an OpenFlow switch implementation.\n" + "usage: %s [OPTIONS] [TYPE@]DATAPATH CONTROLLER...\n" + "where DATAPATH is a local datapath (e.g. \"dp0\")\n" + "optionally with an explicit TYPE (default: \"system\").\n" + "Each CONTROLLER is an active OpenFlow connection method.\n", + program_name, program_name); + vconn_usage(true, true, true); + printf("\nOpenFlow options:\n" + " -d, --datapath-id=ID Use ID as the OpenFlow switch ID\n" + " (ID must consist of 16 hex digits)\n" + " --mfr-desc=MFR Identify manufacturer as MFR\n" + " --hw-desc=HW Identify hardware as HW\n" + " --sw-desc=SW Identify software as SW\n" + " --serial-desc=SERIAL Identify serial number as SERIAL\n" + " --dp-desc=DP_DESC Identify dp description as DP_DESC\n" + "\nNetworking options:\n" + " --fail=open|closed when controller connection fails:\n" + " closed: drop all packets\n" + " open (default): act as learning switch\n" + " --inactivity-probe=SECS time between inactivity probes\n" + " --max-idle=SECS max idle for flows set up by switch\n" + " --max-backoff=SECS max time between controller connection\n" + " attempts (default: 8 seconds)\n" + " -l, --listen=METHOD allow management connections on METHOD\n" + " (a passive OpenFlow connection method)\n" + " --snoop=METHOD allow controller snooping on METHOD\n" + " (a passive OpenFlow connection method)\n" + " --out-of-band controller connection is out-of-band\n" + " --netflow=HOST:PORT configure NetFlow output target\n" + "\nRate-limiting of \"packet-in\" messages to the controller:\n" + " --rate-limit[=PACKETS] max rate, in packets/s (default: 1000)\n" + " --burst-limit=BURST limit on packet credit for idle time\n"); + daemon_usage(); + vlog_usage(); + printf("\nOther options:\n" + " --unixctl=SOCKET override default control socket name\n" + " -h, --help display this help message\n" + " -V, --version display version information\n"); + leak_checker_usage(); + exit(EXIT_SUCCESS); +} diff --git a/utilities/.gitignore b/utilities/.gitignore index 88abec7d..dcc317a2 100644 --- a/utilities/.gitignore +++ b/utilities/.gitignore @@ -11,8 +11,6 @@ /ovs-dpctl.8 /ovs-ofctl /ovs-ofctl.8 -/ovs-openflowd -/ovs-openflowd.8 /ovs-parse-leaks /ovs-pcap /ovs-pcap.1 diff --git a/utilities/automake.mk b/utilities/automake.mk index cb06f5a3..47e3a1f7 100644 --- a/utilities/automake.mk +++ b/utilities/automake.mk @@ -3,7 +3,6 @@ bin_PROGRAMS += \ utilities/ovs-controller \ utilities/ovs-dpctl \ utilities/ovs-ofctl \ - utilities/ovs-openflowd \ utilities/ovs-vsctl bin_SCRIPTS += utilities/ovs-pki utilities/ovs-vsctl if HAVE_PYTHON @@ -19,7 +18,6 @@ EXTRA_DIST += \ utilities/ovs-controller.8.in \ utilities/ovs-dpctl.8.in \ utilities/ovs-ofctl.8.in \ - utilities/ovs-openflowd.8.in \ utilities/ovs-parse-leaks.8 \ utilities/ovs-parse-leaks.in \ utilities/ovs-pcap.1.in \ @@ -40,7 +38,6 @@ DISTCLEANFILES += \ utilities/ovs-controller.8 \ utilities/ovs-dpctl.8 \ utilities/ovs-ofctl.8 \ - utilities/ovs-openflowd.8 \ utilities/ovs-parse-leaks \ utilities/ovs-pcap \ utilities/ovs-pcap.1 \ @@ -59,7 +56,6 @@ man_MANS += \ utilities/ovs-controller.8 \ utilities/ovs-dpctl.8 \ utilities/ovs-ofctl.8 \ - utilities/ovs-openflowd.8 \ utilities/ovs-parse-leaks.8 \ utilities/ovs-pcap.1 \ utilities/ovs-pki.8 \ @@ -83,13 +79,6 @@ utilities_ovs_ofctl_LDADD = \ lib/libopenvswitch.a \ $(SSL_LIBS) -utilities_ovs_openflowd_SOURCES = utilities/ovs-openflowd.c -utilities_ovs_openflowd_LDADD = \ - ofproto/libofproto.a \ - lib/libsflow.a \ - lib/libopenvswitch.a \ - $(SSL_LIBS) - utilities_ovs_vsctl_SOURCES = utilities/ovs-vsctl.c vswitchd/vswitch-idl.c utilities_ovs_vsctl_LDADD = lib/libopenvswitch.a $(SSL_LIBS) diff --git a/utilities/ovs-appctl.8.in b/utilities/ovs-appctl.8.in index 86d5a8b0..04a74dcc 100644 --- a/utilities/ovs-appctl.8.in +++ b/utilities/ovs-appctl.8.in @@ -166,6 +166,5 @@ white space. . \fBovs\-appctl\fR can control the following daemons: .BR ovs\-vswitchd (8), -.BR ovs\-openflowd (8), .BR ovs\-controller (8), .BR ovs\-brcompatd (8). diff --git a/utilities/ovs-controller.8.in b/utilities/ovs-controller.8.in index 016c7e39..429d81bf 100644 --- a/utilities/ovs-controller.8.in +++ b/utilities/ovs-controller.8.in @@ -44,11 +44,6 @@ controller will remain in the switch's flow table without any matching packets being seen. If \fBpermanent\fR is specified, which is not recommended, flows will never expire. The default is 60 seconds. .IP -This option affects only flows set up by the OpenFlow controller. In -some configurations, the switch can set up some flows -on its own. To set the idle time for those flows, pass -\fB\-\-max\-idle\fR to \fBovs\-openflowd\fR (on the switch). -.IP This option has no effect when \fB\-n\fR (or \fB\-\-noflow\fR) is in use (because the controller does not set up flows in that case). . @@ -169,7 +164,6 @@ connection and set the controller, e.g.: \-\-peer\-ca\-cert=cacert.pem set\-controller ssl:\fIip\fR .SH "SEE ALSO" . -.BR ovs\-openflowd (8), .BR ovs\-appctl (8), .BR ovs\-ofctl (8), .BR ovs\-dpctl (8) diff --git a/utilities/ovs-dpctl.8.in b/utilities/ovs-dpctl.8.in index 5b5941be..ee124484 100644 --- a/utilities/ovs-dpctl.8.in +++ b/utilities/ovs-dpctl.8.in @@ -118,34 +118,7 @@ signal. .so lib/vlog.man .so lib/common.man . -.SH EXAMPLES -. -A typical \fBovs\-dpctl\fR command sequence for controlling an -Open vSwitch kernel module: -. -.TP -\fBovs\-dpctl add\-dp dp0\fR -Creates datapath number 0. -. -.TP -\fBovs\-dpctl add\-if dp0 eth0 eth1\fR -Adds two network devices to the new datapath. -. -.PP -At this point one would ordinarily start \fBovs\-openflowd\fR(8) on -\fBdp0\fR, transforming \fBdp0\fR into an OpenFlow switch. Then, when -the switch and the datapath is no longer needed: -. -.TP -\fBovs\-dpctl del\-if dp0 eth0 eth1\fR -Removes network devices from the datapath. -. -.TP -\fBovs\-dpctl del\-dp dp0\fR -Deletes the datapath. -. .SH "SEE ALSO" . .BR ovs\-appctl (8), -.BR ovs\-openflowd (8), .BR ovs\-vswitchd (8) diff --git a/utilities/ovs-ofctl.8.in b/utilities/ovs-ofctl.8.in index 06d61dee..7150bfce 100644 --- a/utilities/ovs-ofctl.8.in +++ b/utilities/ovs-ofctl.8.in @@ -199,9 +199,8 @@ monitoring will not show any traffic. . .IP "\fBmonitor \fIswitch\fR [\fImiss-len\fR]" Connects to \fIswitch\fR and prints to the console all OpenFlow -messages received. Usually, \fIswitch\fR should specify a connection -named on \fBovs\-openflowd\fR(8)'s \fB\-l\fR or \fB\-\-listen\fR command line -option. +messages received. Usually, \fIswitch\fR should specify the name of a +bridge in the \fBovs\-vswitchd\fR database. .IP If \fImiss-len\fR is provided, \fBovs\-ofctl\fR sends an OpenFlow ``set configuration'' message at connection setup time that requests @@ -533,8 +532,7 @@ omitted, then the entire packet is sent. . .IP \fBlocal\fR Outputs the packet on the ``local port,'' which corresponds to the -\fBof\fIn\fR network device (see \fBCONTACTING THE CONTROLLER\fR in -\fBovs\-openflowd\fR(8) for information on the \fBof\fIn\fR network device). +network device that has the same name as the bridge. . .IP \fBdrop\fR Discards the packet, so no further processing or forwarding takes place. @@ -805,19 +803,16 @@ increase verbosity further. . .SH EXAMPLES . -The following examples assume that an OpenFlow switch on the local -host has been configured to listen for management connections on a -Unix domain socket named \fB@RUNDIR@/openflow.sock\fR, e.g. by -specifying \fB\-\-listen=punix:@RUNDIR@/openflow.sock\fR on the -\fBovs\-openflowd\fR(8) command line. +The following examples assume that \fBovs\-vswitchd\fR has a bridge +named \fBbr0\fR configured. . .TP -\fBovs\-ofctl dump\-tables unix:@RUNDIR@/openflow.sock\fR +\fBovs\-ofctl dump\-tables br0\fR Prints out the switch's table stats. (This is more interesting after some traffic has passed through.) . .TP -\fBovs\-ofctl dump\-flows unix:@RUNDIR@/openflow.sock\fR +\fBovs\-ofctl dump\-flows br0\fR Prints the flow entries in the switch. . .SH "SEE ALSO" diff --git a/utilities/ovs-openflowd.8.in b/utilities/ovs-openflowd.8.in deleted file mode 100644 index c22ed918..00000000 --- a/utilities/ovs-openflowd.8.in +++ /dev/null @@ -1,345 +0,0 @@ -.TH ovs\-openflowd 8 "March 2009" "Open vSwitch" "Open vSwitch Manual" -.\" This program's name: -.ds PN ovs\-openflowd -.\" SSL peer program's name: -.ds SN ovs\-controller -. -.SH NAME -ovs\-openflowd \- OpenFlow switch implementation -. -.SH SYNOPSIS -.B ovs\-openflowd -[\fIoptions\fR] \fIdatapath\fR \fIcontroller\fR\&... -. -.SH DESCRIPTION -The \fBovs\-openflowd\fR program implements an OpenFlow switch using a -flow-based datapath. \fBovs\-openflowd\fR connects to one or more -OpenFlow controllers over TCP or SSL. -.PP -For a more powerful alternative to \fBovs\-openflowd\fR, see -\fBovs\-vswitchd\fR(8). Do not run both daemons at the same time. -.PP -The mandatory \fIdatapath\fR argument argument specifies the local -datapath to relay. It takes the form [\fItype\fB@\fR]\fIname\fR, -where \fIname\fR is the network device associated with the datapath's -local port. If \fItype\fR is given, it specifies the datapath -provider of \fIname\fR, otherwise the default provider \fBsystem\fR is -assumed. -. -.PP -The optional \fIcontroller\fR arguments specify how to connect to the -OpenFlow controller or controllers. Each takes one of the following -forms: -. -.so lib/vconn-active.man -.IP "\fBnone\fR" -Run without actively maintaining a connection to a remote OpenFlow -controller. (See the \fB\-\-listen\fR option, under \fBNetworking -Options\fR below, for another way to make OpenFlow connections to the -switch.) -. -.PP -When multiple controllers are configured, \fBovs\-openflowd\fR -connects to all of them simultaneously. OpenFlow 1.0 does not specify -how multiple controllers coordinate in interacting with a single -switch, so more than one controller should be specified only if the -controllers are themselves designed to coordinate with each other. -(The Nicira-defined \fBNXT_ROLE\fR OpenFlow vendor extension may be -useful for this.) -. -.SS "Contacting Controllers" -The OpenFlow switch must be able to contact the OpenFlow controllers -over the network. It can do so in one of two ways: -. -.IP out-of-band -In this configuration, OpenFlow traffic uses a network separate from -the data traffic that it controls, that is, the switch does not use -any of the network devices added to the datapath with \fBovs\-dpctl -add\-if\fR in its communication with the controller. -.IP -To use \fBovs\-openflowd\fR in a network with out-of-band control, specify -\fB\-\-out\-of\-band\fR on the \fBovs\-openflowd\fR command line. The control -network must be configured separately, before or after \fBovs\-openflowd\fR -is started. -. -.IP in-band -In this configuration, a single network is used for OpenFlow traffic -and other data traffic, that is, the switch contacts the controller -over one of the network devices added to the datapath with \fBovs\-dpctl -add\-if\fR. This configuration is often more convenient than -out-of-band control, because it is not necessary to maintain two -independent networks. -.IP -In-band control is the default for \fBovs\-openflowd\fR, so no special -command-line option is required. - -Specify the location of the -controller on the \fBovs\-openflowd\fR command line as the \fIcontroller\fR -argument. You must also configure the network device for the OpenFlow -``local port'' to allow \fBovs\-openflowd\fR to connect to that controller. -The OpenFlow local port is a virtual network port that \fBovs\-openflowd\fR -bridges to the physical switch ports. The name of the local port for -a given \fIdatapath\fR may be seen by running \fBovs\-dpctl show -\fIdatapath\fR; the local port is listed as port 0 in \fBshow\fR's -output. -. -.IP -Before \fBovs\-openflowd\fR starts, the local port network device is not -bridged to any physical network, so the next step depends on whether -connectivity is required to configure the device's IP address. If the -switch has a static IP address, you may configure its IP address now -with a command such as -.B ifconfig of0 192.168.1.1 -and then invoke \fBovs\-openflowd\fR. -.IP -On the other hand, if the switch does not have a static IP address, -e.g. it obtains its IP address dynamically via DHCP, the DHCP client -will not be able to contact the DHCP server until the OpenFlow switch -has started up. Thus, start \fBovs\-openflowd\fR without configuring -the local port network device, and start the DHCP client afterward. -.RE -. -.SH OPTIONS -.SS "OpenFlow Options" -.TP -\fB\-\-datapath\-id=\fIdpid\fR -Sets \fIdpid\fR, which must consist of exactly 16 hexadecimal digits -and may not be all-zero, -as the datapath ID that the switch will use to identify itself to -OpenFlow controllers. -.IP -If this option is omitted, the default datapath ID is taken from the -Ethernet address of the datapath's local port (which is typically -randomly generated) in the lower 48 bits and zeros in the upper 16. -. -.TP -\fB\-\-mfr\-desc=\fIdesc\fR -Set the description of the switch's manufacturer to \fIdesc\fR, which -may contain up to 255 ASCII characters. -. -.TP -\fB\-\-hw\-desc=\fIdesc\fR -Set the description of the switch's hardware revision to \fIdesc\fR, which -may contain up to 255 ASCII characters. -. -.TP -\fB\-\-sw\-desc=\fIdesc\fR -Set the description of the switch's software revision to \fIdesc\fR, which -may contain up to 255 ASCII characters. -. -.TP -\fB\-\-serial\-desc=\fIdesc\fR -Set the description of the switch's serial number to \fIdesc\fR, which -may contain up to 31 ASCII characters. -. -.TP -\fB\-\-dp\-desc=\fIdesc\fR -Set the description of the datapath to \fIdesc\fR, which may contain up to -255 ASCII characters. Note that this field is intended for debugging -purposes and is not guaranteed to be unique and should not be used as -the primary identifier of the datapath. -. -.SS "Networking Options" -.TP -\fB\-\-datapath\-id=\fIdpid\fR -Sets \fIdpid\fR, which must consist of exactly 16 hexadecimal digits, -as the datapath ID that the switch will use to identify itself to the -OpenFlow controller. -.IP -If this option is omitted, the default datapath ID is taken from the -Ethernet address of the datapath's local port (which is typically -randomly generated) in the lower 48 bits and zeros in the upper 16. -. -.TP -\fB\-\-fail=\fR[\fBstandalone\fR|\fBsecure\fR] -The controller is, ordinarily, responsible for setting up all flows on -the OpenFlow switch. Thus, if the connection to the controller fails, -no new network connections can be set up. If the connection to the -controller stays down long enough, no packets can pass through the -switch at all. -.IP -If this option is set to \fBstandalone\fR (the default), -\fBovs\-openflowd\fR will -take over responsibility for setting up flows in the local datapath -when no message has been received from the controller for three times -the inactivity probe interval (see below), or 45 seconds by default. -In this ``fail open'' mode, \fBovs\-openflowd\fR causes the datapath to act -like an ordinary MAC-learning switch. \fBovs\-openflowd\fR will continue to -retry connection to the controller in the background and, when the -connection succeeds, it discontinues its standalone switching behavior. -.IP -If this option is set to \fBsecure\fR, then \fBovs\-openflowd\fR will not -set up flows on its own when the controller connection fails. -. -.TP -\fB\-\-inactivity\-probe=\fIsecs\fR -When the OpenFlow switch is connected to the controller, the -switch waits for a message to be received from the controller for -\fIsecs\fR seconds before it sends a inactivity probe to the -controller. After sending the inactivity probe, if no response is -received for an additional \fIsecs\fR seconds, the switch -assumes that the connection has been broken and attempts to reconnect. -The default and the minimum value are both 5 seconds. -.IP -When fail-open mode is configured, changing the inactivity probe -interval also changes the interval before entering fail-open mode (see -above). -. -.TP -\fB\-\-max\-idle=\fIsecs\fR|\fBpermanent\fR -Sets \fIsecs\fR as the number of seconds that a flow set up by the -OpenFlow switch will remain in the switch's flow table without any -matching packets being seen. If \fBpermanent\fR is specified, which -is not recommended, flows set up by the switch will never -expire. The default is 15 seconds. -.IP -Most flows are set up by the OpenFlow controller, not by the -switch. This option affects only the following flows, which the -OpenFlow switch sets up itself: -. -.RS -.IP \(bu -When \fB\-\-fail=open\fR is specified, flows set up when the -switch has not been able to contact the controller for the configured -fail-open delay. -. -.IP \(bu -When in-band control is in use, flows set up to bootstrap contacting -the controller (see \fBContacting the Controller\fR, above, for -more information about in-band control). -.RE -. -.IP -As a result, when both \fB\-\-fail=secure\fR and \fB\-\-out\-of\-band\fR are -specified, this option has no effect. -. -.TP -\fB\-\-max\-backoff=\fIsecs\fR -Sets the maximum time between attempts to connect to the controller to -\fIsecs\fR, which must be at least 1. The actual interval between -connection attempts starts at 1 second and doubles on each failing -attempt until it reaches the maximum. The default maximum backoff -time is 8 seconds. -. -.TP -\fB\-l\fR, \fB\-\-listen=\fImethod\fR -By default, the switch listens for OpenFlow management connections on a -Unix domain socket named \fB@RUNDIR@/\fIdatapath\fB.mgmt\fR. This socket -can be used to perform local OpenFlow monitoring and administration with -tools such as \fBovs\-ofctl\fR. -.IP -This option may be used to override the default listener. The \fImethod\fR -must be given as one of the passive OpenFlow connection methods listed -below. This option may be specified multiple times to listen to -multiple connection methods. If a single \fImethod\fR of \fBnone\fR is -used, no listeners will be created. -. -.RS -.so lib/vconn-passive.man -.RE -. -.TP -\fB\-\-snoop=\fImethod\fR -Configures the switch to additionally listen for incoming OpenFlow -connections for controller connection snooping. The \fImethod\fR must -be given as one of the passive OpenFlow connection methods listed -under the \fB\-\-listen\fR option above. This option may be specified -multiple times to listen to multiple connection methods. -.IP -If \fBovs\-ofctl monitor\fR is used to connect to \fImethod\fR specified on -\fB\-\-snoop\fR, it will display all the OpenFlow messages traveling -between the switch and its controller on the primary OpenFlow -connection. This can be useful for debugging switch and controller -problems. -. -.TP -\fB\-\-in\-band\fR, \fB\-\-out\-of\-band\fR -Configures \fBovs\-openflowd\fR to operate in in-band or out-of-band control -mode (see \fBContacting the Controller\fR above). When neither option -is given, the default is in-band control. -. -.TP -\fB\-\-netflow=\fIip\fB:\fIport\fR -Configures the given UDP \fIport\fR on the specified IP \fIip\fR as -a recipient of NetFlow messages for expired flows. The \fIip\fR must -be specified numerically, not as a DNS name. -.IP -This option may be specified multiple times to configure additional -NetFlow collectors. -. -.SS "Rate-Limiting Options" -. -These options configure how the switch applies a ``token bucket'' to -limit the rate at which packets in unknown flows are forwarded to an -OpenFlow controller for flow-setup processing. This feature prevents -a single OpenFlow switch from overwhelming a controller. -. -.TP -\fB\-\-rate\-limit\fR[\fB=\fIrate\fR] -. -Limits the maximum rate at which packets will be forwarded to the -OpenFlow controller to \fIrate\fR packets per second. If \fIrate\fR -is not specified then the default of 1,000 packets per second is used. -.IP -If \fB\-\-rate\-limit\fR is not used, then the switch does not limit the -rate at which packets are forwarded to the controller. -. -.TP -\fB\-\-burst\-limit=\fIburst\fR -. -Sets the maximum number of unused packet credits that the switch will -allow to accumulate during time in which no packets are being -forwarded to the OpenFlow controller to \fIburst\fR (measured in -packets). The default \fIburst\fR is one-quarter of the \fIrate\fR -specified on \fB\-\-rate\-limit\fR. -. -This option takes effect only when \fB\-\-rate\-limit\fR is also specified. -. -.SS "Datapath Options" -. -.IP "\fB\-\-ports=\fIport\fR[\fB,\fIport\fR...]" -Ordinarily, \fBovs\-openflowd\fR expects the administrator to create -the specified \fIdatapath\fR and add ports to it externally with a -utility such as \fBovs\-dpctl\fR. However, the userspace switch -datapath is implemented inside \fBovs\-openflowd\fR itself and does -not (currently) have any external interface for \fBovs\-dpctl\fR to -access. As a stopgap measure, this option specifies one or more ports -to add to the datapath at \fBovs\-openflowd\fR startup time. Multiple -ports may be specified as a comma-separated list or by specifying -\fB\-\-ports\fR multiple times. -.IP -See \fBINSTALL.userspace\fR for more information about userspace -switching. -. -.SS "Daemon Options" -.so lib/daemon.man -. -.SS "Public Key Infrastructure Options" -.so lib/ssl.man -.so lib/ssl-bootstrap.man -. -.SS "Logging Options" -.so lib/vlog.man -.SS "Other Options" -.so lib/unixctl.man -.so lib/common.man -.so lib/leak-checker.man -. -.SH "RUNTIME MANAGEMENT COMMANDS" -\fBovs\-appctl\fR(8) can send commands to a running -\fBovs\-openflowd\fR process. The currently supported commands are -described below. -.SS "OVS\-OPENFLOWD COMMANDS" -These commands are specific to \fBovs\-openflowd\fR. -.IP "\fBexit\fR" -Causes \fBovs\-openflowd\fR to gracefully terminate. -.so ofproto/ofproto-unixctl.man -.so lib/vlog-unixctl.man -. -.SH "SEE ALSO" -. -.BR ovs\-appctl (8), -.BR ovs\-controller (8), -.BR ovs\-dpctl (8), -.BR ovs\-ofctl (8), -.BR ovs\-pki (8) diff --git a/utilities/ovs-openflowd.c b/utilities/ovs-openflowd.c deleted file mode 100644 index 4ca22e0d..00000000 --- a/utilities/ovs-openflowd.c +++ /dev/null @@ -1,541 +0,0 @@ -/* - * Copyright (c) 2008, 2009, 2010, 2011 Nicira Networks. - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at: - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -#include -#include -#include -#include -#include -#include -#include -#include -#include - -#include "command-line.h" -#include "compiler.h" -#include "daemon.h" -#include "dirs.h" -#include "dummy.h" -#include "leak-checker.h" -#include "list.h" -#include "netdev.h" -#include "ofpbuf.h" -#include "ofproto/ofproto.h" -#include "openflow/openflow.h" -#include "packets.h" -#include "poll-loop.h" -#include "rconn.h" -#include "stream-ssl.h" -#include "timeval.h" -#include "unixctl.h" -#include "util.h" -#include "vconn.h" -#include "vlog.h" - -VLOG_DEFINE_THIS_MODULE(openflowd); - -/* Settings that may be configured by the user. */ -struct ofsettings { - const char *unixctl_path; /* File name for unixctl socket. */ - - /* Controller configuration. */ - struct ofproto_controller *controllers; - size_t n_controllers; - enum ofproto_fail_mode fail_mode; - bool run_forever; /* Continue running even with no controller? */ - - /* Datapath. */ - uint64_t datapath_id; /* Datapath ID. */ - char *dp_name; /* Name of local datapath. */ - char *dp_type; /* Type of local datapath. */ - struct sset ports; /* Set of ports to add to datapath (if any). */ - - /* Description strings. */ - const char *mfr_desc; /* Manufacturer. */ - const char *hw_desc; /* Hardware. */ - const char *sw_desc; /* Software version. */ - const char *serial_desc; /* Serial number. */ - const char *dp_desc; /* Datapath description. */ - - /* Related vconns and network devices. */ - struct sset snoops; /* Listen for controller snooping conns. */ - - /* Failure behavior. */ - int max_idle; /* Idle time for flows in fail-open mode. */ - - /* NetFlow. */ - struct sset netflow; /* NetFlow targets. */ -}; - -static unixctl_cb_func ovs_openflowd_exit; - -static void parse_options(int argc, char *argv[], struct ofsettings *); -static void usage(void) NO_RETURN; - -int -main(int argc, char *argv[]) -{ - struct unixctl_server *unixctl; - struct ofproto *ofproto; - struct ofsettings s; - int error; - struct netflow_options nf_options; - const char *port; - bool exiting; - - proctitle_init(argc, argv); - set_program_name(argv[0]); - parse_options(argc, argv, &s); - signal(SIGPIPE, SIG_IGN); - - daemonize_start(); - - /* Start listening for ovs-appctl requests. */ - error = unixctl_server_create(s.unixctl_path, &unixctl); - if (error) { - exit(EXIT_FAILURE); - } - - unixctl_command_register("exit", ovs_openflowd_exit, &exiting); - - VLOG_INFO("Open vSwitch version %s", VERSION BUILDNR); - VLOG_INFO("OpenFlow protocol version 0x%02x", OFP_VERSION); - - error = ofproto_create(s.dp_name, s.dp_type, &ofproto); - if (error) { - VLOG_FATAL("could not initialize OpenFlow switch (%s)", - strerror(error)); - } - - /* Add ports to the datapath if requested by the user. */ - SSET_FOR_EACH (port, &s.ports) { - struct netdev *netdev; - - error = netdev_open_default(port, &netdev); - if (error) { - VLOG_FATAL("%s: failed to open network device (%s)", - port, strerror(error)); - } - - error = ofproto_port_add(ofproto, netdev, NULL); - if (error) { - VLOG_FATAL("failed to add %s as a port (%s)", - port, strerror(error)); - } - - netdev_close(netdev); - } - - /* Configure OpenFlow switch. */ - if (s.datapath_id) { - ofproto_set_datapath_id(ofproto, s.datapath_id); - } - ofproto_set_desc(ofproto, s.mfr_desc, s.hw_desc, s.sw_desc, - s.serial_desc, s.dp_desc); - error = ofproto_set_snoops(ofproto, &s.snoops); - if (error) { - VLOG_FATAL("failed to configure controller snooping connections (%s)", - strerror(error)); - } - memset(&nf_options, 0, sizeof nf_options); - nf_options.collectors = s.netflow; - error = ofproto_set_netflow(ofproto, &nf_options); - if (error) { - VLOG_FATAL("failed to configure NetFlow collectors (%s)", - strerror(error)); - } - ofproto_set_controllers(ofproto, s.controllers, s.n_controllers); - ofproto_set_fail_mode(ofproto, s.fail_mode); - - daemonize_complete(); - - exiting = false; - while (!exiting && (s.run_forever || ofproto_is_alive(ofproto))) { - error = ofproto_run(ofproto); - if (error) { - VLOG_FATAL("unrecoverable datapath error (%s)", strerror(error)); - } - unixctl_server_run(unixctl); - netdev_run(); - - ofproto_wait(ofproto); - unixctl_server_wait(unixctl); - netdev_wait(); - if (exiting) { - poll_immediate_wake(); - } - poll_block(); - } - - ofproto_destroy(ofproto); - - return 0; -} - -static void -ovs_openflowd_exit(struct unixctl_conn *conn, const char *args OVS_UNUSED, - void *exiting_) -{ - bool *exiting = exiting_; - *exiting = true; - unixctl_command_reply(conn, 200, NULL); -} - -/* User interface. */ - -/* Breaks 'ports' apart at commas and adds each resulting word to 'ports'. */ -static void -parse_ports(const char *s_, struct sset *ports) -{ - char *s = xstrdup(s_); - char *save_ptr = NULL; - char *token; - - for (token = strtok_r(s, ",", &save_ptr); token != NULL; - token = strtok_r(NULL, ",", &save_ptr)) { - sset_add(ports, token); - } - free(s); -} - -static void -parse_options(int argc, char *argv[], struct ofsettings *s) -{ - enum { - OPT_DATAPATH_ID = UCHAR_MAX + 1, - OPT_MFR_DESC, - OPT_HW_DESC, - OPT_SW_DESC, - OPT_SERIAL_DESC, - OPT_DP_DESC, - OPT_BR_NAME, - OPT_FAIL_MODE, - OPT_INACTIVITY_PROBE, - OPT_MAX_IDLE, - OPT_MAX_BACKOFF, - OPT_SNOOP, - OPT_RATE_LIMIT, - OPT_BURST_LIMIT, - OPT_BOOTSTRAP_CA_CERT, - OPT_OUT_OF_BAND, - OPT_IN_BAND, - OPT_NETFLOW, - OPT_PORTS, - OPT_UNIXCTL, - OPT_ENABLE_DUMMY, - VLOG_OPTION_ENUMS, - LEAK_CHECKER_OPTION_ENUMS, - DAEMON_OPTION_ENUMS - }; - static struct option long_options[] = { - {"datapath-id", required_argument, NULL, OPT_DATAPATH_ID}, - {"mfr-desc", required_argument, NULL, OPT_MFR_DESC}, - {"hw-desc", required_argument, NULL, OPT_HW_DESC}, - {"sw-desc", required_argument, NULL, OPT_SW_DESC}, - {"serial-desc", required_argument, NULL, OPT_SERIAL_DESC}, - {"dp-desc", required_argument, NULL, OPT_DP_DESC}, - {"config", required_argument, NULL, 'F'}, - {"br-name", required_argument, NULL, OPT_BR_NAME}, - {"fail", required_argument, NULL, OPT_FAIL_MODE}, - {"inactivity-probe", required_argument, NULL, OPT_INACTIVITY_PROBE}, - {"max-idle", required_argument, NULL, OPT_MAX_IDLE}, - {"max-backoff", required_argument, NULL, OPT_MAX_BACKOFF}, - {"listen", required_argument, NULL, 'l'}, - {"snoop", required_argument, NULL, OPT_SNOOP}, - {"rate-limit", optional_argument, NULL, OPT_RATE_LIMIT}, - {"burst-limit", required_argument, NULL, OPT_BURST_LIMIT}, - {"out-of-band", no_argument, NULL, OPT_OUT_OF_BAND}, - {"in-band", no_argument, NULL, OPT_IN_BAND}, - {"netflow", required_argument, NULL, OPT_NETFLOW}, - {"ports", required_argument, NULL, OPT_PORTS}, - {"unixctl", required_argument, NULL, OPT_UNIXCTL}, - {"enable-dummy", no_argument, NULL, OPT_ENABLE_DUMMY}, - {"verbose", optional_argument, NULL, 'v'}, - {"help", no_argument, NULL, 'h'}, - {"version", no_argument, NULL, 'V'}, - DAEMON_LONG_OPTIONS, - VLOG_LONG_OPTIONS, - LEAK_CHECKER_LONG_OPTIONS, - STREAM_SSL_LONG_OPTIONS, - {"bootstrap-ca-cert", required_argument, NULL, OPT_BOOTSTRAP_CA_CERT}, - {NULL, 0, NULL, 0}, - }; - char *short_options = long_options_to_short_options(long_options); - struct ofproto_controller controller_opts; - struct sset controllers; - const char *name; - int i; - - /* Set defaults that we can figure out before parsing options. */ - controller_opts.target = NULL; - controller_opts.max_backoff = 8; - controller_opts.probe_interval = 5; - controller_opts.band = OFPROTO_IN_BAND; - controller_opts.rate_limit = 0; - controller_opts.burst_limit = 0; - s->unixctl_path = NULL; - s->fail_mode = OFPROTO_FAIL_STANDALONE; - s->datapath_id = 0; - s->mfr_desc = NULL; - s->hw_desc = NULL; - s->sw_desc = NULL; - s->serial_desc = NULL; - s->dp_desc = NULL; - sset_init(&controllers); - sset_init(&s->snoops); - s->max_idle = 0; - sset_init(&s->netflow); - sset_init(&s->ports); - for (;;) { - int c; - - c = getopt_long(argc, argv, short_options, long_options, NULL); - if (c == -1) { - break; - } - - switch (c) { - case OPT_DATAPATH_ID: - if (!dpid_from_string(optarg, &s->datapath_id)) { - VLOG_FATAL("argument to --datapath-id must be exactly 16 hex " - "digits and may not be all-zero"); - } - break; - - case OPT_MFR_DESC: - s->mfr_desc = optarg; - break; - - case OPT_HW_DESC: - s->hw_desc = optarg; - break; - - case OPT_SW_DESC: - s->sw_desc = optarg; - break; - - case OPT_SERIAL_DESC: - s->serial_desc = optarg; - break; - - case OPT_DP_DESC: - s->dp_desc = optarg; - break; - - case OPT_FAIL_MODE: - if (!strcmp(optarg, "open") || !strcmp(optarg, "standalone")) { - s->fail_mode = OFPROTO_FAIL_STANDALONE; - } else if (!strcmp(optarg, "closed") - || !strcmp(optarg, "secure")) { - s->fail_mode = OFPROTO_FAIL_SECURE; - } else { - VLOG_FATAL("--fail argument must be \"standalone\" " - "or \"secure\""); - } - break; - - case OPT_INACTIVITY_PROBE: - controller_opts.probe_interval = atoi(optarg); - if (controller_opts.probe_interval < 5) { - VLOG_FATAL("--inactivity-probe argument must be at least 5"); - } - break; - - case OPT_MAX_IDLE: - if (!strcmp(optarg, "permanent")) { - s->max_idle = OFP_FLOW_PERMANENT; - } else { - s->max_idle = atoi(optarg); - if (s->max_idle < 1 || s->max_idle > 65535) { - VLOG_FATAL("--max-idle argument must be between 1 and " - "65535 or the word 'permanent'"); - } - } - break; - - case OPT_MAX_BACKOFF: - controller_opts.max_backoff = atoi(optarg); - if (controller_opts.max_backoff < 1) { - VLOG_FATAL("--max-backoff argument must be at least 1"); - } else if (controller_opts.max_backoff > 3600) { - controller_opts.max_backoff = 3600; - } - break; - - case OPT_RATE_LIMIT: - if (optarg) { - controller_opts.rate_limit = atoi(optarg); - if (controller_opts.rate_limit < 1) { - VLOG_FATAL("--rate-limit argument must be at least 1"); - } - } else { - controller_opts.rate_limit = 1000; - } - break; - - case OPT_BURST_LIMIT: - controller_opts.burst_limit = atoi(optarg); - if (controller_opts.burst_limit < 1) { - VLOG_FATAL("--burst-limit argument must be at least 1"); - } - break; - - case OPT_OUT_OF_BAND: - controller_opts.band = OFPROTO_OUT_OF_BAND; - break; - - case OPT_IN_BAND: - controller_opts.band = OFPROTO_IN_BAND; - break; - - case OPT_NETFLOW: - sset_add(&s->netflow, optarg); - break; - - case 'l': - sset_add(&controllers, optarg); - break; - - case OPT_SNOOP: - sset_add(&s->snoops, optarg); - break; - - case OPT_PORTS: - parse_ports(optarg, &s->ports); - break; - - case OPT_UNIXCTL: - s->unixctl_path = optarg; - break; - - case OPT_ENABLE_DUMMY: - dummy_enable(); - break; - - case 'h': - usage(); - - case 'V': - OVS_PRINT_VERSION(OFP_VERSION, OFP_VERSION); - exit(EXIT_SUCCESS); - - DAEMON_OPTION_HANDLERS - - VLOG_OPTION_HANDLERS - - LEAK_CHECKER_OPTION_HANDLERS - - STREAM_SSL_OPTION_HANDLERS - - case OPT_BOOTSTRAP_CA_CERT: - stream_ssl_set_ca_cert_file(optarg, true); - break; - - case '?': - exit(EXIT_FAILURE); - - default: - abort(); - } - } - free(short_options); - - argc -= optind; - argv += optind; - if (argc < 2) { - VLOG_FATAL("need at least two non-option arguments; " - "use --help for usage"); - } - - /* Rate limiting. */ - if (controller_opts.rate_limit && controller_opts.rate_limit < 100) { - VLOG_WARN("Rate limit set to unusually low value %d", - controller_opts.rate_limit); - } - - /* Local vconns. */ - ofproto_parse_name(argv[0], &s->dp_name, &s->dp_type); - - /* Figure out controller names. */ - s->run_forever = false; - if (sset_is_empty(&controllers)) { - sset_add_and_free(&controllers, xasprintf("punix:%s/%s.mgmt", - ovs_rundir(), s->dp_name)); - } - for (i = 1; i < argc; i++) { - if (!strcmp(argv[i], "none")) { - s->run_forever = true; - } else { - sset_add(&controllers, argv[i]); - } - } - - /* Set up controllers. */ - s->n_controllers = sset_count(&controllers); - s->controllers = xmalloc(s->n_controllers * sizeof *s->controllers); - i = 0; - SSET_FOR_EACH (name, &controllers) { - s->controllers[i] = controller_opts; - s->controllers[i].target = xstrdup(name); - i++; - } - sset_destroy(&controllers); -} - -static void -usage(void) -{ - printf("%s: an OpenFlow switch implementation.\n" - "usage: %s [OPTIONS] [TYPE@]DATAPATH CONTROLLER...\n" - "where DATAPATH is a local datapath (e.g. \"dp0\")\n" - "optionally with an explicit TYPE (default: \"system\").\n" - "Each CONTROLLER is an active OpenFlow connection method.\n", - program_name, program_name); - vconn_usage(true, true, true); - printf("\nOpenFlow options:\n" - " -d, --datapath-id=ID Use ID as the OpenFlow switch ID\n" - " (ID must consist of 16 hex digits)\n" - " --mfr-desc=MFR Identify manufacturer as MFR\n" - " --hw-desc=HW Identify hardware as HW\n" - " --sw-desc=SW Identify software as SW\n" - " --serial-desc=SERIAL Identify serial number as SERIAL\n" - " --dp-desc=DP_DESC Identify dp description as DP_DESC\n" - "\nNetworking options:\n" - " --fail=open|closed when controller connection fails:\n" - " closed: drop all packets\n" - " open (default): act as learning switch\n" - " --inactivity-probe=SECS time between inactivity probes\n" - " --max-idle=SECS max idle for flows set up by switch\n" - " --max-backoff=SECS max time between controller connection\n" - " attempts (default: 8 seconds)\n" - " -l, --listen=METHOD allow management connections on METHOD\n" - " (a passive OpenFlow connection method)\n" - " --snoop=METHOD allow controller snooping on METHOD\n" - " (a passive OpenFlow connection method)\n" - " --out-of-band controller connection is out-of-band\n" - " --netflow=HOST:PORT configure NetFlow output target\n" - "\nRate-limiting of \"packet-in\" messages to the controller:\n" - " --rate-limit[=PACKETS] max rate, in packets/s (default: 1000)\n" - " --burst-limit=BURST limit on packet credit for idle time\n"); - daemon_usage(); - vlog_usage(); - printf("\nOther options:\n" - " --unixctl=SOCKET override default control socket name\n" - " -h, --help display this help message\n" - " -V, --version display version information\n"); - leak_checker_usage(); - exit(EXIT_SUCCESS); -} diff --git a/utilities/ovs-pcap.1.in b/utilities/ovs-pcap.1.in index 470e251d..b36bbe70 100644 --- a/utilities/ovs-pcap.1.in +++ b/utilities/ovs-pcap.1.in @@ -11,8 +11,7 @@ ovs\-pcap \- print packets from a pcap file as hex The \fBovs\-pcap\fR program reads the pcap \fIfile\fR named on the command line and prints each packet's contents as a sequence of hex digits on a line of its own. This format is suitable for use with the -\fBofproto/trace\fR command supported by \fBovs\-vswitchd\fR(8) and -\fBovs-openflowd\fR(8). +\fBofproto/trace\fR command supported by \fBovs\-vswitchd\fR(8). . .SH "OPTIONS" .so lib/common.man @@ -20,7 +19,6 @@ digits on a line of its own. This format is suitable for use with the .SH "SEE ALSO" . .BR ovs\-vswitchd (8), -.BR ovs\-openflowd (8), .BR ovs\-tcpundump (1), .BR tcpdump (8), .BR wireshark (8). diff --git a/utilities/ovs-pki.8.in b/utilities/ovs-pki.8.in index 599bb08e..ecc8c96a 100644 --- a/utilities/ovs-pki.8.in +++ b/utilities/ovs-pki.8.in @@ -326,5 +326,4 @@ Prints a help usage message and exits. .SH "SEE ALSO" .BR ovs\-controller (8), -.BR ovs\-openflowd (8), .BR ovs\-pki\-cgi (8) diff --git a/utilities/ovs-tcpundump.1.in b/utilities/ovs-tcpundump.1.in index 0837dc33..ce12e820 100644 --- a/utilities/ovs-tcpundump.1.in +++ b/utilities/ovs-tcpundump.1.in @@ -12,7 +12,7 @@ The \fBovs\-tcpundump\fR program reads \fBtcpdump \-xx\fR output on stdin, looking for hexadecimal packet data, and dumps each Ethernet as a single hexadecimal string on stdout. This format is suitable for use with the \fBofproto/trace\fR command supported by -\fBovs\-vswitchd\fR(8) and \fBovs-openflowd\fR(8) +\fBovs\-vswitchd\fR(8) via \fBovs\-appctl\fR(8). .PP At least two \fB\-x\fR or \fB\-X\fR options must be given, otherwise @@ -26,7 +26,6 @@ from being using with \fBofproto/trace\fR. . .BR ovs\-appctl (8), .BR ovs\-vswitchd (8), -.BR ovs\-openflowd (8), .BR ovs\-pcap (1), .BR tcpdump (8), .BR wireshark (8). diff --git a/vswitchd/ovs-vswitchd.8.in b/vswitchd/ovs-vswitchd.8.in index 48825740..3e41babd 100644 --- a/vswitchd/ovs-vswitchd.8.in +++ b/vswitchd/ovs-vswitchd.8.in @@ -67,9 +67,6 @@ Only a single instance of \fBovs\-vswitchd\fR is intended to run at a time. A single \fBovs\-vswitchd\fR can manage any number of switch instances, up to the maximum number of supported Open vSwitch datapaths. .PP -\fBovs\-vswitchd\fR provides all the features of \fBovs-openflowd\fR, -and more. Do not run both daemons at the same time. -.PP \fBovs\-vswitchd\fR does all the necessary management of Open vSwitch datapaths itself. Thus, external tools, such \fBovs\-dpctl\fR(8), are not needed for managing datapaths in conjunction with \fBovs\-vswitchd\fR, and their use diff --git a/xenserver/openvswitch-xen.spec b/xenserver/openvswitch-xen.spec index 4b3019d5..78da1d5a 100644 --- a/xenserver/openvswitch-xen.spec +++ b/xenserver/openvswitch-xen.spec @@ -121,10 +121,8 @@ install xenserver/uuid.py $RPM_BUILD_ROOT/usr/share/openvswitch/python # Get rid of stuff we don't want to make RPM happy. rm \ $RPM_BUILD_ROOT/usr/bin/ovs-controller \ - $RPM_BUILD_ROOT/usr/bin/ovs-openflowd \ $RPM_BUILD_ROOT/usr/bin/ovs-pki \ $RPM_BUILD_ROOT/usr/share/man/man8/ovs-controller.8 \ - $RPM_BUILD_ROOT/usr/share/man/man8/ovs-openflowd.8 \ $RPM_BUILD_ROOT/usr/share/man/man8/ovs-pki.8 install -d -m 755 $RPM_BUILD_ROOT/var/lib/openvswitch