1 How to Install Open vSwitch on Linux and FreeBSD
2 ================================================
4 This document describes how to build and install Open vSwitch on a
5 generic Linux or FreeBSD host. For specifics around installation on a
6 specific platform, please see one of these files:
16 To compile the userspace programs in the Open vSwitch distribution,
17 you will need the following software:
19 - A make program, e.g. GNU make. BSD make should also work.
21 - The GNU C compiler. We generally test with version 4.1, 4.2, or
24 - pkg-config. We test with version 0.22.
26 - libssl, from OpenSSL, is optional but recommended if you plan to
27 connect the Open vSwitch to an OpenFlow controller. libssl is
28 required to establish confidentiality and authenticity in the
29 connections from an Open vSwitch to an OpenFlow controller. If
30 libssl is installed, then Open vSwitch will automatically build
33 To compile the kernel module on Linux, you must also install the
34 following. If you cannot build or install the kernel module, you may
35 use the userspace-only implementation, at a cost in performance. The
36 userspace implementation may also lack some features. Refer to
37 INSTALL.userspace for more information.
39 - A supported Linux kernel version. Please refer to README for a
40 list of supported versions.
42 The Open vSwitch datapath requires bridging support
43 (CONFIG_BRIDGE) to be built as a kernel module. (This is common
44 in kernels provided by Linux distributions.) The bridge module
45 must not be loaded or in use. If the bridge module is running
46 (check with "lsmod | grep bridge"), you must remove it ("rmmod
47 bridge") before starting the datapath.
49 For optional support of ingress policing, you must enable kernel
50 configuration options NET_CLS_BASIC, NET_SCH_INGRESS, and
51 NET_ACT_POLICE, either built-in or as modules. (NET_CLS_POLICE is
52 obsolete and not needed.)
54 If GRE tunneling is being used it is recommended that the kernel
55 be compiled with IPv6 support (CONFIG_IPV6). This allows for
56 special handling (such as path MTU discovery) of IPv6 packets.
58 To configure HTB or HFSC quality of service with Open vSwitch,
59 you must enable the respective configuration options.
61 To use Open vSwitch support for TAP devices, you must enable
64 - To build a kernel module, you need the same version of GCC that
65 was used to build that kernel.
67 - A kernel build directory corresponding to the Linux kernel image
68 the module is to run on. Under Debian and Ubuntu, for example,
69 each linux-image package containing a kernel binary has a
70 corresponding linux-headers package with the required build
73 If you are working from a Git tree or snapshot (instead of from a
74 distribution tarball), or if you modify the Open vSwitch build system
75 or the database schema, you will also need the following software:
77 - Autoconf version 2.64 or later.
79 - Automake version 1.10 or later.
81 - Python 2.x, for x >= 4.
83 If you modify the ovsdbmonitor tool, then you will also need the
86 - pyuic4 from PyQt4 (http://www.riverbankcomputing.co.uk).
88 To run the unit tests, you also need:
90 - Perl. Version 5.10.1 is known to work. Earlier versions should
93 If you modify the vswitchd database schema, then the E-R diagram in
94 the ovs-vswitchd.conf.db(5) manpage will be updated properly only if
95 you have the following:
97 - "dot" from graphviz (http://www.graphviz.org/).
99 - Perl. Version 5.10.1 is known to work. Earlier versions should
102 - Python 2.x, for x >= 4.
104 If you are going to extensively modify Open vSwitch, please consider
105 installing the following to obtain better warnings:
107 - "sparse" version 0.4.4 or later
108 (http://www.kernel.org/pub/software/devel/sparse/dist/).
112 Installation Requirements
113 -------------------------
115 The machine on which Open vSwitch is to be installed must have the
118 - libc compatible with the libc used for build.
120 - libssl compatible with the libssl used for build, if OpenSSL was
123 - On Linux, the same kernel version configured as part of the build.
125 - For optional support of ingress policing on Linux, the "tc" program
126 from iproute2 (part of all major distributions and available at
127 http://www.linux-foundation.org/en/Net:Iproute2).
129 On Linux you should ensure that /dev/urandom exists. To support TAP
130 devices, you must also ensure that /dev/net/tun exists.
132 To run the ovsdbmonitor tool, the machine must also have the following
135 - Python 2.x, for x >= 4.
137 - Python Twisted Conch.
143 - Python Zope interface module.
145 (On Debian "lenny" the above can be installed with "apt-get install
146 python-json python-qt4 python-zopeinterface python-twisted-conch".)
148 Building and Installing Open vSwitch for Linux or FreeBSD
149 =========================================================
151 Once you have installed all the prerequisites listed above in the Base
152 Prerequisites section, follow the procedure below to build.
154 1. If you pulled the sources directly from an Open vSwitch Git tree,
155 run boot.sh in the top source directory:
159 2. In the top source directory, configure the package by running the
160 configure script. You can usually invoke configure without any
165 By default all files are installed under /usr/local. If you want
166 to install into, e.g., /usr and /var instead of /usr/local and
167 /usr/local/var, add options as shown here:
169 % ./configure --prefix=/usr --localstatedir=/var
171 To use a specific C compiler for compiling Open vSwitch user
172 programs, also specify it on the configure command line, like so:
174 % ./configure CC=gcc-4.2
176 To build the Linux kernel module, so that you can run the
177 kernel-based switch, pass the location of the kernel build
178 directory on --with-linux. For example, to build for a running
181 % ./configure --with-linux=/lib/modules/`uname -r`/build
183 If you wish to build the kernel module for an architecture other
184 than the architecture of the machine used for the build, you may
185 specify the kernel architecture string using the KARCH variable
186 when invoking the configure script. For example, to build for MIPS
189 % ./configure --with-linux=/path/to/linux KARCH=mips
191 The configure script accepts a number of other options and honors
192 additional environment variables. For a full list, invoke
193 configure with the --help option.
195 3. Run make in the top source directory:
199 On FreeBSD you may need to use GNU make (gmake) or NetBSD make
200 (bmake) instead of the native make.
202 For improved warnings if you installed "sparse" (see
203 "Prerequisites"), add C=1 to the "make" command line.
205 4. Consider running the testsuite. Refer to "Running the Testsuite"
206 below, for instructions.
208 5. Become root by running "su" or another program.
210 6. Run "make install" to install the executables and manpages into the
211 running system, by default under /usr/local.
213 7. If you built kernel modules, you may load them with "insmod", e.g.:
215 % insmod datapath/linux/openvswitch.ko
217 You may need to specify a full path to insmod, e.g. /sbin/insmod.
218 To verify that the modules have been loaded, run "/sbin/lsmod" and
219 check that openvswitch is listed.
221 If the "insmod" operation fails, look at the last few kernel log
222 messages (e.g. with "dmesg | tail"):
224 - The message "openvswitch: exports duplicate symbol
225 br_should_route_hook (owned by bridge)" means that the bridge
226 module is loaded. Run "/sbin/rmmod bridge" to remove it.
228 If "/sbin/rmmod bridge" fails with "ERROR: Module bridge does
229 not exist in /proc/modules", then the bridge is compiled into
230 the kernel, rather than as a module. Open vSwitch does not
231 support this configuration (see "Build Requirements", above).
233 - The message "openvswitch: exports duplicate symbol
234 dp_ioctl_hook (owned by ofdatapath)" means that the ofdatapath
235 module from the OpenFlow reference implementation is loaded.
236 Run "/sbin/rmmod ofdatapath" to remove it. (You might have to
237 delete any existing datapaths beforehand, using the "dpctl"
238 program included with the OpenFlow reference implementation.
239 "ovs-dpctl" will not work.)
241 - Otherwise, the most likely problem is that Open vSwitch was
242 built for a kernel different from the one into which you are
243 trying to load it. Run "modinfo" on openvswitch.ko and on
244 a module built for the running kernel, e.g.:
246 % /sbin/modinfo openvswitch.ko
247 % /sbin/modinfo /lib/modules/`uname -r`/kernel/net/bridge/bridge.ko
249 Compare the "vermagic" lines output by the two commands. If
250 they differ, then Open vSwitch was built for the wrong kernel.
252 - If you decide to report a bug or ask a question related to
253 module loading, please include the output from the "dmesg" and
254 "modinfo" commands mentioned above.
256 There is an optional module parameter to openvswitch.ko called
257 vlan_tso that enables TCP segmentation offload over VLANs on NICs
258 that support it. Many drivers do not expose support for TSO on VLANs
259 in a way that Open vSwitch can use but there is no way to detect
260 whether this is the case. If you know that your particular driver can
261 handle it (for example by testing sending large TCP packets over VLANs)
262 then passing in a value of 1 may improve performance. Modules built for
263 Linux kernels 2.6.37 and later, as well as specially patched versions
264 of earlier kernels, do not need this and do not have this parameter. If
265 you do not understand what this means or do not know if your driver
266 will work, do not set this.
268 Once you verify that the kernel modules load properly, you should
271 % make modules_install
273 8. Initialize the configuration database using ovsdb-tool, e.g.:
275 % mkdir -p /usr/local/etc/openvswitch
276 % ovsdb-tool create /usr/local/etc/openvswitch/conf.db vswitchd/vswitch.ovsschema
281 Before starting ovs-vswitchd itself, you need to start its
282 configuration database, ovsdb-server. Each machine on which Open
283 vSwitch is installed should run its own copy of ovsdb-server.
284 Configure it to use the database you created during step 7 of
285 installation, above, to listen on a Unix domain socket, to connect to
286 any managers specified in the database itself, and to use the SSL
287 configuration in the database:
289 % ovsdb-server --remote=punix:/usr/local/var/run/openvswitch/db.sock \
290 --remote=db:Open_vSwitch,manager_options \
291 --private-key=db:SSL,private_key \
292 --certificate=db:SSL,certificate \
293 --bootstrap-ca-cert=db:SSL,ca_cert \
296 (If you built Open vSwitch without SSL support, then omit
297 --private-key, --certificate, and --bootstrap-ca-cert.)
299 Then initialize the database using ovs-vsctl. This is only
300 necessary the first time after you create the database with
301 ovsdb-tool (but running it at any time is harmless):
303 % ovs-vsctl --no-wait init
305 Then start the main Open vSwitch daemon, telling it to connect to the
306 same Unix domain socket:
308 % ovs-vswitchd --pidfile --detach
310 Now you may use ovs-vsctl to set up bridges and other Open vSwitch
311 features. For example, to create a bridge named br0 and add ports
312 eth0 and vif1.0 to it:
314 % ovs-vsctl add-br br0
315 % ovs-vsctl add-port br0 eth0
316 % ovs-vsctl add-port br0 vif1.0
318 Please refer to ovs-vsctl(8) for more details.
323 When you upgrade Open vSwitch from one version to another, you should
324 also upgrade the database schema:
326 1. Stop the Open vSwitch daemons, e.g.:
328 % kill `cd /usr/local/var/run/openvswitch && cat ovsdb-server.pid ovs-vswitchd.pid`
330 2. Install the new Open vSwitch release.
332 3. Upgrade the database, in one of the following two ways:
334 - If there is no important data in your database, then you may
335 delete the database file and recreate it with ovsdb-tool,
336 following the instructions under "Building and Installing Open
337 vSwitch for Linux or FreeBSD".
339 - If you want to preserve the contents of your database, back it
340 up first, then use "ovsdb-tool convert" to upgrade it, e.g.:
342 % ovsdb-tool convert /usr/local/etc/openvswitch/conf.db vswitchd/vswitch.ovsschema
344 4. Start the Open vSwitch daemons as described under "Building and
345 Installing Open vSwitch for Linux or FreeBSD" above.
347 Running the Testsuite
348 =====================
350 Open vSwitch includes a testsuite. Before you submit patches
351 upstream, we advise that you run the tests and ensure that they pass.
352 If you add new features to Open vSwitch, then adding tests for those
353 features will ensure your features don't break as developers modify
354 other areas of Open vSwitch.
356 You must configure and build Open vSwitch (steps 1 through 3 in
357 "Building and Installing Open vSwitch for Linux or FreeBSD" above)
358 before you run the testsuite. You do not need to install Open vSwitch
359 or to build or load the kernel module to run the testsuite. You do
360 not need supervisor privilege to run the testsuite.
362 To run all the unit tests in Open vSwitch, one at a time:
364 This takes under 5 minutes on a modern desktop system.
366 To run all the unit tests in Open vSwitch, up to 8 in parallel:
367 make check TESTSUITEFLAGS=-j8
368 This takes under a minute on a modern 4-core desktop system.
370 To see a list of all the available tests, run:
371 make check TESTSUITEFLAGS=--list
373 To run only a subset of tests, e.g. test 123 and tests 477 through 484:
374 make check TESTSUITEFLAGS='123 477-484'
375 (Tests do not have inter-dependencies, so you may run any subset.)
377 To run tests matching a keyword, e.g. "ovsdb":
378 make check TESTSUITEFLAGS='-k ovsdb'
380 To see a complete list of test options:
381 make check TESTSUITEFLAGS=--help
383 The results of a testing run are reported in tests/testsuite.log.
384 Please report test failures as bugs and include the testsuite.log in
387 If you have "valgrind" installed, then you can also run the testsuite
388 under valgrind by using "make check-valgrind" in place of "make
389 check". All the same options are available via TESTSUITEFLAGS. When
390 you do this, the "valgrind" results for test <N> are reported in files
391 named tests/testsuite.dir/<N>/valgrind.*. You may find that the
392 valgrind results are easier to interpret if you put "-q" in
393 ~/.valgrindrc, since that reduces the amount of
395 Sometimes a few tests may fail on some runs but not others. This is
396 usually a bug in the testsuite, not a bug in Open vSwitch itself. If
397 you find that a test fails intermittently, please report it, since the
398 developers may not have noticed.
403 Please report problems to bugs@openvswitch.org.