Merge commit '259e0b1ad1bfea762a76f0098deb8f8d8db1dfa3'

[sliver-openvswitch.git] / INSTALL

diff --git a/INSTALL b/INSTALL
index 28bc1a0..4c54b59 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -18,8 +18,13 @@ you will need the following software:
 
     - GNU make.
 
 
     - GNU make.
 

-    - The GNU C compiler.  We generally test with version 4.1, 4.2, or
-      4.3.
+    - A C compiler, such as:
+
+        * GCC 4.x.
+
+        * Clang.  Clang 3.4 and later provide useful static semantic
+          analysis and thread-safety checks.  For Ubuntu, there are
+          nightly built packages available on clang's website.

 
     - libssl, from OpenSSL, is optional but recommended if you plan to
       connect the Open vSwitch to an OpenFlow controller.  libssl is
 
     - libssl, from OpenSSL, is optional but recommended if you plan to
       connect the Open vSwitch to an OpenFlow controller.  libssl is


@@ -49,9 +54,9 @@ INSTALL.userspace for more information.
       NET_ACT_POLICE, either built-in or as modules.  (NET_CLS_POLICE is
       obsolete and not needed.)
 
       NET_ACT_POLICE, either built-in or as modules.  (NET_CLS_POLICE is
       obsolete and not needed.)
 

-      If GRE tunneling is being used it is recommended that the kernel
-      be compiled with IPv6 support (CONFIG_IPV6).  This allows for
-      special handling (such as path MTU discovery) of IPv6 packets.
+      To use GRE tunneling on Linux 2.6.37 or newer, kernel support
+      for GRE must be compiled in or available as a module
+      (CONFIG_NET_IPGRE_DEMUX).

 
       To configure HTB or HFSC quality of service with Open vSwitch,
       you must enable the respective configuration options.
 
       To configure HTB or HFSC quality of service with Open vSwitch,
       you must enable the respective configuration options.


@@ -107,6 +112,10 @@ installing the following to obtain better warnings:
 
     - GNU make.
 
 
     - GNU make.
 

+    - clang, version 3.4 or later
+
+Also, you may find the ovs-dev script found in utilities/ovs-dev.py useful.
+

 Installation Requirements
 -------------------------
 
 Installation Requirements
 -------------------------
 


@@ -171,6 +180,10 @@ Prerequisites section, follow the procedure below to build.
 
       % ./configure CC=gcc-4.2
 
 
       % ./configure CC=gcc-4.2
 

+   To use 'clang' compiler:
+
+      % ./configure CC=clang
+

    To build the Linux kernel module, so that you can run the
    kernel-based switch, pass the location of the kernel build
    directory on --with-linux.  For example, to build for a running
    To build the Linux kernel module, so that you can run the
    kernel-based switch, pass the location of the kernel build
    directory on --with-linux.  For example, to build for a running


@@ -209,15 +222,15 @@ Prerequisites section, follow the procedure below to build.
 6. Run "make install" to install the executables and manpages into the
    running system, by default under /usr/local.
 
 6. Run "make install" to install the executables and manpages into the
    running system, by default under /usr/local.
 

-7. If you built kernel modules, you may load them with "insmod", e.g.:
+7. If you built kernel modules, you may install and load them, e.g.:

 
 

-      % insmod datapath/linux/openvswitch.ko
+      % make modules_install
+      % /sbin/modprobe openvswitch 

 
 

-   You may need to specify a full path to insmod, e.g. /sbin/insmod.

    To verify that the modules have been loaded, run "/sbin/lsmod" and
    check that openvswitch is listed.
 
    To verify that the modules have been loaded, run "/sbin/lsmod" and
    check that openvswitch is listed.
 

-   If the "insmod" operation fails, look at the last few kernel log
+   If the "modprobe" operation fails, look at the last few kernel log

    messages (e.g. with "dmesg | tail"):
 
       - The message "openvswitch: exports duplicate symbol
    messages (e.g. with "dmesg | tail"):
 
       - The message "openvswitch: exports duplicate symbol


@@ -264,11 +277,6 @@ Prerequisites section, follow the procedure below to build.
    you do not understand what this means or do not know if your driver
    will work, do not set this.
 
    you do not understand what this means or do not know if your driver
    will work, do not set this.
 

-   Once you verify that the kernel modules load properly, you should
-   install them:
-
-      % make modules_install
-

 8. Initialize the configuration database using ovsdb-tool, e.g.:
 
       % mkdir -p /usr/local/etc/openvswitch
 8. Initialize the configuration database using ovsdb-tool, e.g.:
 
       % mkdir -p /usr/local/etc/openvswitch


@@ -286,10 +294,10 @@ any managers specified in the database itself, and to use the SSL
 configuration in the database:
 
       % ovsdb-server --remote=punix:/usr/local/var/run/openvswitch/db.sock \
 configuration in the database:
 
       % ovsdb-server --remote=punix:/usr/local/var/run/openvswitch/db.sock \

-                     --remote=db:Open_vSwitch,manager_options \
-                     --private-key=db:SSL,private_key \
-                     --certificate=db:SSL,certificate \
-                     --bootstrap-ca-cert=db:SSL,ca_cert \
+                     --remote=db:Open_vSwitch,Open_vSwitch,manager_options \
+                     --private-key=db:Open_vSwitch,SSL,private_key \
+                     --certificate=db:Open_vSwitch,SSL,certificate \
+                     --bootstrap-ca-cert=db:Open_vSwitch,SSL,ca_cert \

                      --pidfile --detach
 
 (If you built Open vSwitch without SSL support, then omit
                      --pidfile --detach
 
 (If you built Open vSwitch without SSL support, then omit