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