INSTALL.DPDK.md

   1 Using Open vSwitch with DPDK
   2 ============================
   3
   4 Open vSwitch can use Intel(R) DPDK lib to operate entirely in
   5 userspace. This file explains how to install and use Open vSwitch in
   6 such a mode.
   7
   8 The DPDK support of Open vSwitch is considered experimental.
   9 It has not been thoroughly tested.
  10
  11 This version of Open vSwitch should be built manually with `configure`
  12 and `make`.
  13
  14 OVS needs a system with 1GB hugepages support.
  15
  16 Building and Installing:
  17 ------------------------
  18
  19 Required DPDK 2.0, `fuse`, `fuse-devel` (`libfuse-dev` on Debian/Ubuntu)
  20
  21 1. Configure build & install DPDK:
  22   1. Set `$DPDK_DIR`
  23
  24      ```
  25      export DPDK_DIR=/usr/src/dpdk-2.0
  26      cd $DPDK_DIR
  27      ```
  28
  29   2. Update `config/common_linuxapp` so that DPDK generate single lib file.
  30      (modification also required for IVSHMEM build)
  31
  32      `CONFIG_RTE_BUILD_COMBINE_LIBS=y`
  33
  34      Update `config/common_linuxapp` so that DPDK is built with vhost
  35      libraries; currently, OVS only supports vhost-cuse, so DPDK vhost-user
  36      libraries should be explicitly turned off (they are enabled by default
  37      in DPDK 2.0).
  38
  39      `CONFIG_RTE_LIBRTE_VHOST=y`
  40      `CONFIG_RTE_LIBRTE_VHOST_USER=n`
  41
  42      Then run `make install` to build and install the library.
  43      For default install without IVSHMEM:
  44
  45      `make install T=x86_64-native-linuxapp-gcc`
  46
  47      To include IVSHMEM (shared memory):
  48
  49      `make install T=x86_64-ivshmem-linuxapp-gcc`
  50
  51      For further details refer to http://dpdk.org/
  52
  53 2. Configure & build the Linux kernel:
  54
  55    Refer to intel-dpdk-getting-started-guide.pdf for understanding
  56    DPDK kernel requirement.
  57
  58 3. Configure & build OVS:
  59
  60    * Non IVSHMEM:
  61
  62      `export DPDK_BUILD=$DPDK_DIR/x86_64-native-linuxapp-gcc/`
  63
  64    * IVSHMEM:
  65
  66      `export DPDK_BUILD=$DPDK_DIR/x86_64-ivshmem-linuxapp-gcc/`
  67
  68    ```
  69    cd $(OVS_DIR)/openvswitch
  70    ./boot.sh
  71    ./configure --with-dpdk=$DPDK_BUILD [CFLAGS="-g -O2 -Wno-cast-align"]
  72    make
  73    ```
  74
  75    Note: 'clang' users may specify the '-Wno-cast-align' flag to suppress DPDK cast-align warnings.
  76
  77 To have better performance one can enable aggressive compiler optimizations and
  78 use the special instructions(popcnt, crc32) that may not be available on all
  79 machines. Instead of typing `make`, type:
  80
  81 `make CFLAGS='-O3 -march=native'`
  82
  83 Refer to [INSTALL.userspace.md] for general requirements of building userspace OVS.
  84
  85 Using the DPDK with ovs-vswitchd:
  86 ---------------------------------
  87
  88 1. Setup system boot
  89    Add the following options to the kernel bootline:
  90
  91    `default_hugepagesz=1GB hugepagesz=1G hugepages=1`
  92
  93 2. Setup DPDK devices:
  94
  95    DPDK devices can be setup using either the VFIO (for DPDK 1.7+) or UIO
  96    modules. UIO requires inserting an out of tree driver igb_uio.ko that is
  97    available in DPDK. Setup for both methods are described below.
  98
  99    * UIO:
 100      1. insert uio.ko: `modprobe uio`
 101      2. insert igb_uio.ko: `insmod $DPDK_BUILD/kmod/igb_uio.ko`
 102      3. Bind network device to igb_uio:
 103          `$DPDK_DIR/tools/dpdk_nic_bind.py --bind=igb_uio eth1`
 104
 105    * VFIO:
 106
 107      VFIO needs to be supported in the kernel and the BIOS. More information
 108      can be found in the [DPDK Linux GSG].
 109
 110      1. Insert vfio-pci.ko: `modprobe vfio-pci`
 111      2. Set correct permissions on vfio device: `sudo /usr/bin/chmod a+x /dev/vfio`
 112         and: `sudo /usr/bin/chmod 0666 /dev/vfio/*`
 113      3. Bind network device to vfio-pci:
 114         `$DPDK_DIR/tools/dpdk_nic_bind.py --bind=vfio-pci eth1`
 115
 116 3. Mount the hugetable filsystem
 117
 118    `mount -t hugetlbfs -o pagesize=1G none /dev/hugepages`
 119
 120    Ref to http://www.dpdk.org/doc/quick-start for verifying DPDK setup.
 121
 122 4. Follow the instructions in [INSTALL.md] to install only the
 123    userspace daemons and utilities (via 'make install').
 124    1. First time only db creation (or clearing):
 125
 126       ```
 127       mkdir -p /usr/local/etc/openvswitch
 128       mkdir -p /usr/local/var/run/openvswitch
 129       rm /usr/local/etc/openvswitch/conf.db
 130       ovsdb-tool create /usr/local/etc/openvswitch/conf.db  \
 131              /usr/local/share/openvswitch/vswitch.ovsschema
 132       ```
 133
 134    2. Start ovsdb-server
 135
 136       ```
 137       ovsdb-server --remote=punix:/usr/local/var/run/openvswitch/db.sock \
 138           --remote=db:Open_vSwitch,Open_vSwitch,manager_options \
 139           --private-key=db:Open_vSwitch,SSL,private_key \
 140           --certificate=Open_vSwitch,SSL,certificate \
 141           --bootstrap-ca-cert=db:Open_vSwitch,SSL,ca_cert --pidfile --detach
 142       ```
 143
 144     3. First time after db creation, initialize:
 145
 146        ```
 147        ovs-vsctl --no-wait init
 148        ```
 149
 150 5. Start vswitchd:
 151
 152    DPDK configuration arguments can be passed to vswitchd via `--dpdk`
 153    argument. This needs to be first argument passed to vswitchd process.
 154    dpdk arg -c is ignored by ovs-dpdk, but it is a required parameter
 155    for dpdk initialization.
 156
 157    ```
 158    export DB_SOCK=/usr/local/var/run/openvswitch/db.sock
 159    ovs-vswitchd --dpdk -c 0x1 -n 4 -- unix:$DB_SOCK --pidfile --detach
 160    ```
 161
 162    If allocated more than one GB hugepage (as for IVSHMEM), set amount and
 163    use NUMA node 0 memory:
 164
 165    ```
 166    ovs-vswitchd --dpdk -c 0x1 -n 4 --socket-mem 1024,0 \
 167    -- unix:$DB_SOCK --pidfile --detach
 168    ```
 169
 170 6. Add bridge & ports
 171
 172    To use ovs-vswitchd with DPDK, create a bridge with datapath_type
 173    "netdev" in the configuration database.  For example:
 174
 175    `ovs-vsctl add-br br0 -- set bridge br0 datapath_type=netdev`
 176
 177    Now you can add dpdk devices. OVS expect DPDK device name start with dpdk
 178    and end with portid. vswitchd should print (in the log file) the number
 179    of dpdk devices found.
 180
 181    ```
 182    ovs-vsctl add-port br0 dpdk0 -- set Interface dpdk0 type=dpdk
 183    ovs-vsctl add-port br0 dpdk1 -- set Interface dpdk1 type=dpdk
 184    ```
 185
 186    Once first DPDK port is added to vswitchd, it creates a Polling thread and
 187    polls dpdk device in continuous loop. Therefore CPU utilization
 188    for that thread is always 100%.
 189
 190    Note: creating bonds of DPDK interfaces is slightly different to creating
 191    bonds of system interfaces.  For DPDK, the interface type must be explicitly
 192    set, for example:
 193
 194    ```
 195    ovs-vsctl add-bond br0 dpdkbond dpdk0 dpdk1 -- set Interface dpdk0 type=dpdk -- set Interface dpdk1 type=dpdk
 196    ```
 197
 198 7. Add test flows
 199
 200    Test flow script across NICs (assuming ovs in /usr/src/ovs):
 201    Execute script:
 202
 203    ```
 204    #! /bin/sh
 205    # Move to command directory
 206    cd /usr/src/ovs/utilities/
 207
 208    # Clear current flows
 209    ./ovs-ofctl del-flows br0
 210
 211    # Add flows between port 1 (dpdk0) to port 2 (dpdk1)
 212    ./ovs-ofctl add-flow br0 in_port=1,action=output:2
 213    ./ovs-ofctl add-flow br0 in_port=2,action=output:1
 214    ```
 215
 216 8. Performance tuning
 217
 218    With pmd multi-threading support, OVS creates one pmd thread for each
 219    numa node as default.  The pmd thread handles the I/O of all DPDK
 220    interfaces on the same numa node.  The following two commands can be used
 221    to configure the multi-threading behavior.
 222
 223    `ovs-vsctl set Open_vSwitch . other_config:pmd-cpu-mask=<hex string>`
 224
 225    The command above asks for a CPU mask for setting the affinity of pmd
 226    threads.  A set bit in the mask means a pmd thread is created and pinned
 227    to the corresponding CPU core.  For more information, please refer to
 228    `man ovs-vswitchd.conf.db`
 229
 230    `ovs-vsctl set Open_vSwitch . other_config:n-dpdk-rxqs=<integer>`
 231
 232    The command above sets the number of rx queues of each DPDK interface. The
 233    rx queues are assigned to pmd threads on the same numa node in round-robin
 234    fashion.  For more information, please refer to `man ovs-vswitchd.conf.db`
 235
 236    Ideally for maximum throughput, the pmd thread should not be scheduled out
 237    which temporarily halts its execution. The following affinitization methods
 238    can help.
 239
 240    Lets pick core 4,6,8,10 for pmd threads to run on.  Also assume a dual 8 core
 241    sandy bridge system with hyperthreading enabled where CPU1 has cores 0,...,7
 242    and 16,...,23 & CPU2 cores 8,...,15 & 24,...,31.  (A different cpu
 243    configuration could have different core mask requirements).
 244
 245    To kernel bootline add core isolation list for cores and associated hype cores
 246    (e.g.  isolcpus=4,20,6,22,8,24,10,26,).  Reboot system for isolation to take
 247    effect, restart everything.
 248
 249    Configure pmd threads on core 4,6,8,10 using 'pmd-cpu-mask':
 250
 251    `ovs-vsctl set Open_vSwitch . other_config:pmd-cpu-mask=00000550`
 252
 253    You should be able to check that pmd threads are pinned to the correct cores
 254    via:
 255
 256    ```
 257    top -p `pidof ovs-vswitchd` -H -d1
 258    ```
 259
 260    Note, the pmd threads on a numa node are only created if there is at least
 261    one DPDK interface from the numa node that has been added to OVS.
 262
 263    Note, core 0 is always reserved from non-pmd threads and should never be set
 264    in the cpu mask.
 265
 266    To understand where most of the time is spent and whether the caches are
 267    effective, these commands can be used:
 268
 269    ```
 270    ovs-appctl dpif-netdev/pmd-stats-clear #To reset statistics
 271    ovs-appctl dpif-netdev/pmd-stats-show
 272    ```
 273
 274 DPDK Rings :
 275 ------------
 276
 277 Following the steps above to create a bridge, you can now add dpdk rings
 278 as a port to the vswitch.  OVS will expect the DPDK ring device name to
 279 start with dpdkr and end with a portid.
 280
 281 `ovs-vsctl add-port br0 dpdkr0 -- set Interface dpdkr0 type=dpdkr`
 282
 283 DPDK rings client test application
 284
 285 Included in the test directory is a sample DPDK application for testing
 286 the rings.  This is from the base dpdk directory and modified to work
 287 with the ring naming used within ovs.
 288
 289 location tests/ovs_client
 290
 291 To run the client :
 292
 293 ```
 294 cd /usr/src/ovs/tests/
 295 ovsclient -c 1 -n 4 --proc-type=secondary -- -n "port id you gave dpdkr"
 296 ```
 297
 298 In the case of the dpdkr example above the "port id you gave dpdkr" is 0.
 299
 300 It is essential to have --proc-type=secondary
 301
 302 The application simply receives an mbuf on the receive queue of the
 303 ethernet ring and then places that same mbuf on the transmit ring of
 304 the ethernet ring.  It is a trivial loopback application.
 305
 306 DPDK rings in VM (IVSHMEM shared memory communications)
 307 -------------------------------------------------------
 308
 309 In addition to executing the client in the host, you can execute it within
 310 a guest VM. To do so you will need a patched qemu.  You can download the
 311 patch and getting started guide at :
 312
 313 https://01.org/packet-processing/downloads
 314
 315 A general rule of thumb for better performance is that the client
 316 application should not be assigned the same dpdk core mask "-c" as
 317 the vswitchd.
 318
 319 DPDK vhost:
 320 -----------
 321
 322 vhost-cuse is only supported at present i.e. not using the standard QEMU
 323 vhost-user interface. It is intended that vhost-user support will be added
 324 in future releases when supported in DPDK and that vhost-cuse will eventually
 325 be deprecated. See [DPDK Docs] for more info on vhost.
 326
 327 Prerequisites:
 328 1.  Insert the Cuse module:
 329
 330       `modprobe cuse`
 331
 332 2.  Build and insert the `eventfd_link` module:
 333
 334      `cd $DPDK_DIR/lib/librte_vhost/eventfd_link/`
 335      `make`
 336      `insmod $DPDK_DIR/lib/librte_vhost/eventfd_link.ko`
 337
 338 Following the steps above to create a bridge, you can now add DPDK vhost
 339 as a port to the vswitch.
 340
 341 `ovs-vsctl add-port br0 dpdkvhost0 -- set Interface dpdkvhost0 type=dpdkvhost`
 342
 343 Unlike DPDK ring ports, DPDK vhost ports can have arbitrary names:
 344
 345 `ovs-vsctl add-port br0 port123ABC -- set Interface port123ABC type=dpdkvhost`
 346
 347 However, please note that when attaching userspace devices to QEMU, the
 348 name provided during the add-port operation must match the ifname parameter
 349 on the QEMU command line.
 350
 351
 352 DPDK vhost VM configuration:
 353 ----------------------------
 354
 355    vhost ports use a Linux* character device to communicate with QEMU.
 356    By default it is set to `/dev/vhost-net`. It is possible to reuse this
 357    standard device for DPDK vhost, which makes setup a little simpler but it
 358    is better practice to specify an alternative character device in order to
 359    avoid any conflicts if kernel vhost is to be used in parallel.
 360
 361 1. This step is only needed if using an alternative character device.
 362
 363    The new character device filename must be specified on the vswitchd
 364    commandline:
 365
 366         `./vswitchd/ovs-vswitchd --dpdk --cuse_dev_name my-vhost-net -c 0x1 ...`
 367
 368    Note that the `--cuse_dev_name` argument and associated string must be the first
 369    arguments after `--dpdk` and come before the EAL arguments. In the example
 370    above, the character device to be used will be `/dev/my-vhost-net`.
 371
 372 2. This step is only needed if reusing the standard character device. It will
 373    conflict with the kernel vhost character device so the user must first
 374    remove it.
 375
 376        `rm -rf /dev/vhost-net`
 377
 378 3a. Configure virtio-net adaptors:
 379    The following parameters must be passed to the QEMU binary:
 380
 381      ```
 382      -netdev tap,id=<id>,script=no,downscript=no,ifname=<name>,vhost=on
 383      -device virtio-net-pci,netdev=net1,mac=<mac>
 384      ```
 385
 386      Repeat the above parameters for multiple devices.
 387
 388      The DPDK vhost library will negiotiate its own features, so they
 389      need not be passed in as command line params. Note that as offloads are
 390      disabled this is the equivalent of setting:
 391
 392      `csum=off,gso=off,guest_tso4=off,guest_tso6=off,guest_ecn=off`
 393
 394 3b. If using an alternative character device. It must be also explicitly
 395     passed to QEMU using the `vhostfd` argument:
 396
 397      ```
 398      -netdev tap,id=<id>,script=no,downscript=no,ifname=<name>,vhost=on,
 399      vhostfd=<open_fd>
 400      -device virtio-net-pci,netdev=net1,mac=<mac>
 401      ```
 402
 403      The open file descriptor must be passed to QEMU running as a child
 404      process. This could be done with a simple python script.
 405
 406        ```
 407        #!/usr/bin/python
 408        fd = os.open("/dev/usvhost", os.O_RDWR)
 409        subprocess.call("qemu-system-x86_64 .... -netdev tap,id=vhostnet0,\
 410                         vhost=on,vhostfd=" + fd +"...", shell=True)
 411
 412    Alternatively the the `qemu-wrap.py` script can be used to automate the
 413    requirements specified above and can be used in conjunction with libvirt if
 414    desired. See the "DPDK vhost VM configuration with QEMU wrapper" section
 415    below.
 416
 417 4. Configure huge pages:
 418    QEMU must allocate the VM's memory on hugetlbfs. Vhost ports access a
 419    virtio-net device's virtual rings and packet buffers mapping the VM's
 420    physical memory on hugetlbfs. To enable vhost-ports to map the VM's
 421    memory into their process address space, pass the following paramters
 422    to QEMU:
 423
 424      `-object memory-backend-file,id=mem,size=4096M,mem-path=/dev/hugepages,
 425       share=on -numa node,memdev=mem -mem-prealloc`
 426
 427
 428 DPDK vhost VM configuration with QEMU wrapper:
 429 ----------------------------------------------
 430
 431 The QEMU wrapper script automatically detects and calls QEMU with the
 432 necessary parameters. It performs the following actions:
 433
 434   * Automatically detects the location of the hugetlbfs and inserts this
 435     into the command line parameters.
 436   * Automatically open file descriptors for each virtio-net device and
 437     inserts this into the command line parameters.
 438   * Calls QEMU passing both the command line parameters passed to the
 439     script itself and those it has auto-detected.
 440
 441 Before use, you **must** edit the configuration parameters section of the
 442 script to point to the correct emulator location and set additional
 443 settings. Of these settings, `emul_path` and `us_vhost_path` **must** be
 444 set. All other settings are optional.
 445
 446 To use directly from the command line simply pass the wrapper some of the
 447 QEMU parameters: it will configure the rest. For example:
 448
 449 ```
 450 qemu-wrap.py -cpu host -boot c -hda <disk image> -m 4096 -smp 4
 451   --enable-kvm -nographic -vnc none -net none -netdev tap,id=net1,
 452   script=no,downscript=no,ifname=if1,vhost=on -device virtio-net-pci,
 453   netdev=net1,mac=00:00:00:00:00:01
 454 ```
 455
 456 DPDK vhost VM configuration with libvirt:
 457 -----------------------------------------
 458
 459 If you are using libvirt, you must enable libvirt to access the character
 460 device by adding it to controllers cgroup for libvirtd using the following
 461 steps.
 462
 463      1. In `/etc/libvirt/qemu.conf` add/edit the following lines:
 464
 465         ```
 466         1) clear_emulator_capabilities = 0
 467         2) user = "root"
 468         3) group = "root"
 469         4) cgroup_device_acl = [
 470                "/dev/null", "/dev/full", "/dev/zero",
 471                "/dev/random", "/dev/urandom",
 472                "/dev/ptmx", "/dev/kvm", "/dev/kqemu",
 473                "/dev/rtc", "/dev/hpet", "/dev/net/tun",
 474                "/dev/<my-vhost-device>",
 475                "/dev/hugepages"]
 476         ```
 477
 478         <my-vhost-device> refers to "vhost-net" if using the `/dev/vhost-net`
 479         device. If you have specificed a different name on the ovs-vswitchd
 480         commandline using the "--cuse_dev_name" parameter, please specify that
 481         filename instead.
 482
 483      2. Disable SELinux or set to permissive mode
 484
 485      3. Restart the libvirtd process
 486         For example, on Fedora:
 487
 488           `systemctl restart libvirtd.service`
 489
 490 After successfully editing the configuration, you may launch your
 491 vhost-enabled VM. The XML describing the VM can be configured like so
 492 within the <qemu:commandline> section:
 493
 494      1. Set up shared hugepages:
 495
 496      ```
 497      <qemu:arg value='-object'/>
 498      <qemu:arg value='memory-backend-file,id=mem,size=4096M,mem-path=/dev/hugepages,share=on'/>
 499      <qemu:arg value='-numa'/>
 500      <qemu:arg value='node,memdev=mem'/>
 501      <qemu:arg value='-mem-prealloc'/>
 502      ```
 503
 504      2. Set up your tap devices:
 505
 506      ```
 507      <qemu:arg value='-netdev'/>
 508      <qemu:arg value='type=tap,id=net1,script=no,downscript=no,ifname=vhost0,vhost=on'/>
 509      <qemu:arg value='-device'/>
 510      <qemu:arg value='virtio-net-pci,netdev=net1,mac=00:00:00:00:00:01'/>
 511      ```
 512
 513      Repeat for as many devices as are desired, modifying the id, ifname
 514      and mac as necessary.
 515
 516      Again, if you are using an alternative character device (other than
 517      `/dev/vhost-net`), please specify the file descriptor like so:
 518
 519      `<qemu:arg value='type=tap,id=net3,script=no,downscript=no,ifname=vhost0,vhost=on,vhostfd=<open_fd>'/>`
 520
 521      Where <open_fd> refers to the open file descriptor of the character device.
 522      Instructions of how to retrieve the file descriptor can be found in the
 523      "DPDK vhost VM configuration" section.
 524      Alternatively, the process is automated with the qemu-wrap.py script,
 525      detailed in the next section.
 526
 527 Now you may launch your VM using virt-manager, or like so:
 528
 529     `virsh create my_vhost_vm.xml`
 530
 531 DPDK vhost VM configuration with libvirt and QEMU wrapper:
 532 ----------------------------------------------------------
 533
 534 To use the qemu-wrapper script in conjuntion with libvirt, follow the
 535 steps in the previous section before proceeding with the following steps:
 536
 537   1. Place `qemu-wrap.py` in libvirtd's binary search PATH ($PATH)
 538      Ideally in the same directory that the QEMU binary is located.
 539
 540   2. Ensure that the script has the same owner/group and file permissions
 541      as the QEMU binary.
 542
 543   3. Update the VM xml file using "virsh edit VM.xml"
 544
 545        1. Set the VM to use the launch script.
 546           Set the emulator path contained in the `<emulator><emulator/>` tags.
 547           For example, replace:
 548
 549             `<emulator>/usr/bin/qemu-kvm<emulator/>`
 550
 551             with:
 552
 553             `<emulator>/usr/bin/qemu-wrap.py<emulator/>`
 554
 555   4. Edit the Configuration Parameters section of the script to point to
 556   the correct emulator location and set any additional options. If you are
 557   using a alternative character device name, please set "us_vhost_path" to the
 558   location of that device. The script will automatically detect and insert
 559   the correct "vhostfd" value in the QEMU command line arguements.
 560
 561   5. Use virt-manager to launch the VM
 562
 563 Restrictions:
 564 -------------
 565
 566   - Work with 1500 MTU, needs few changes in DPDK lib to fix this issue.
 567   - Currently DPDK port does not make use any offload functionality.
 568   - DPDK-vHost support works with 1G huge pages.
 569
 570   ivshmem:
 571   - If you run Open vSwitch with smaller page sizes (e.g. 2MB), you may be
 572     unable to share any rings or mempools with a virtual machine.
 573     This is because the current implementation of ivshmem works by sharing
 574     a single 1GB huge page from the host operating system to any guest
 575     operating system through the Qemu ivshmem device. When using smaller
 576     page sizes, multiple pages may be required to hold the ring descriptors
 577     and buffer pools. The Qemu ivshmem device does not allow you to share
 578     multiple file descriptors to the guest operating system. However, if you
 579     want to share dpdkr rings with other processes on the host, you can do
 580     this with smaller page sizes.
 581
 582 Bug Reporting:
 583 --------------
 584
 585 Please report problems to bugs@openvswitch.org.
 586
 587 [INSTALL.userspace.md]:INSTALL.userspace.md
 588 [INSTALL.md]:INSTALL.md
 589 [DPDK Linux GSG]: http://www.dpdk.org/doc/guides/linux_gsg/build_dpdk.html#binding-and-unbinding-network-ports-to-from-the-igb-uioor-vfio-modules
 590 [DPDK Docs]: http://dpdk.org/doc