net/iavf: deprecate i40evf PMD
[dpdk.git] / doc / guides / nics / intel_vf.rst
1 ..  SPDX-License-Identifier: BSD-3-Clause
2     Copyright(c) 2010-2014 Intel Corporation.
3
4 Intel Virtual Function Driver
5 =============================
6
7 Supported Intel® Ethernet Controllers (see the *DPDK Release Notes* for details)
8 support the following modes of operation in a virtualized environment:
9
10 *   **SR-IOV mode**: Involves direct assignment of part of the port resources to different guest operating systems
11     using the PCI-SIG Single Root I/O Virtualization (SR IOV) standard,
12     also known as "native mode" or "pass-through" mode.
13     In this chapter, this mode is referred to as IOV mode.
14
15 *   **VMDq mode**: Involves central management of the networking resources by an IO Virtual Machine (IOVM) or
16     a Virtual Machine Monitor (VMM), also known as software switch acceleration mode.
17     In this chapter, this mode is referred to as the Next Generation VMDq mode.
18
19 SR-IOV Mode Utilization in a DPDK Environment
20 ---------------------------------------------
21
22 The DPDK uses the SR-IOV feature for hardware-based I/O sharing in IOV mode.
23 Therefore, it is possible to partition SR-IOV capability on Ethernet controller NIC resources logically and
24 expose them to a virtual machine as a separate PCI function called a "Virtual Function".
25 Refer to :numref:`figure_single_port_nic`.
26
27 Therefore, a NIC is logically distributed among multiple virtual machines (as shown in :numref:`figure_single_port_nic`),
28 while still having global data in common to share with the Physical Function and other Virtual Functions.
29 The DPDK fm10kvf, i40evf, igbvf or ixgbevf as a Poll Mode Driver (PMD) serves for the Intel® 82576 Gigabit Ethernet Controller,
30 Intel® Ethernet Controller I350 family, Intel® 82599 10 Gigabit Ethernet Controller NIC,
31 Intel® Fortville 10/40 Gigabit Ethernet Controller NIC's virtual PCI function, or PCIe host-interface of the Intel Ethernet Switch
32 FM10000 Series.
33 Meanwhile the DPDK Poll Mode Driver (PMD) also supports "Physical Function" of such NIC's on the host.
34
35 The DPDK PF/VF Poll Mode Driver (PMD) supports the Layer 2 switch on Intel® 82576 Gigabit Ethernet Controller,
36 Intel® Ethernet Controller I350 family, Intel® 82599 10 Gigabit Ethernet Controller,
37 and Intel® Fortville 10/40 Gigabit Ethernet Controller NICs so that guest can choose it for inter virtual machine traffic in SR-IOV mode.
38
39 For more detail on SR-IOV, please refer to the following documents:
40
41 *   `SR-IOV provides hardware based I/O sharing <http://www.intel.com/network/connectivity/solutions/vmdc.htm>`_
42
43 *   `PCI-SIG-Single Root I/O Virtualization Support on IA
44     <http://www.intel.com/content/www/us/en/pci-express/pci-sig-single-root-io-virtualization-support-in-virtualization-technology-for-connectivity-paper.html>`_
45
46 *   `Scalable I/O Virtualized Servers <http://www.intel.com/content/www/us/en/virtualization/server-virtualization/scalable-i-o-virtualized-servers-paper.html>`_
47
48 .. _figure_single_port_nic:
49
50 .. figure:: img/single_port_nic.*
51
52    Virtualization for a Single Port NIC in SR-IOV Mode
53
54
55 Physical and Virtual Function Infrastructure
56 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
57
58 The following describes the Physical Function and Virtual Functions infrastructure for the supported Ethernet Controller NICs.
59
60 Virtual Functions operate under the respective Physical Function on the same NIC Port and therefore have no access
61 to the global NIC resources that are shared between other functions for the same NIC port.
62
63 A Virtual Function has basic access to the queue resources and control structures of the queues assigned to it.
64 For global resource access, a Virtual Function has to send a request to the Physical Function for that port,
65 and the Physical Function operates on the global resources on behalf of the Virtual Function.
66 For this out-of-band communication, an SR-IOV enabled NIC provides a memory buffer for each Virtual Function,
67 which is called a "Mailbox".
68
69 Intel® Ethernet Adaptive Virtual Function
70 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
71 Adaptive Virtual Function (IAVF) is a SR-IOV Virtual Function with the same device id (8086:1889) on different Intel Ethernet Controller.
72 IAVF Driver is VF driver which supports for all future Intel devices without requiring a VM update. And since this happens to be an adaptive VF driver,
73 every new drop of the VF driver would add more and more advanced features that can be turned on in the VM if the underlying HW device supports those
74 advanced features based on a device agnostic way without ever compromising on the base functionality. IAVF provides generic hardware interface and
75 interface between IAVF driver and a compliant PF driver is specified.
76
77 Intel products starting Ethernet Controller 700 Series to support Adaptive Virtual Function.
78
79 The way to generate Virtual Function is like normal, and the resource of VF assignment depends on the NIC Infrastructure.
80
81 For more detail on SR-IOV, please refer to the following documents:
82
83 *   `Intel® IAVF HAS <https://www.intel.com/content/dam/www/public/us/en/documents/product-specifications/ethernet-adaptive-virtual-function-hardware-spec.pdf>`_
84
85 .. note::
86
87     To use DPDK IAVF PMD on Intel® 700 Series Ethernet Controller, the device id (0x1889) need to specified during device
88     assignment in hypervisor. Take qemu for example, the device assignment should carry the IAVF device id (0x1889) like
89     ``-device vfio-pci,x-pci-device-id=0x1889,host=03:0a.0``.
90
91     Starting from DPDK 21.05, the default VF driver for Intel® 700 Series Ethernet Controller will be IAVF. No new feature
92     will be added into i40evf except bug fix until it's removed in DPDK 21.11. Between DPDK 21.05 and 21.11, by using the
93     ``devargs`` option ``driver=i40evf``, i40evf PMD still can be used on Intel® 700 Series Ethernet Controller, for example::
94
95     -a 81:02.0,driver=i40evf
96
97     When IAVF is backed by an Intel® E810 device, the "Protocol Extraction" feature which is supported by ice PMD is also
98     available for IAVF PMD. The same devargs with the same parameters can be applied to IAVF PMD, for detail please reference
99     the section ``Protocol extraction for per queue`` of ice.rst.
100
101 The PCIE host-interface of Intel Ethernet Switch FM10000 Series VF infrastructure
102 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
103
104 In a virtualized environment, the programmer can enable a maximum of *64 Virtual Functions (VF)*
105 globally per PCIE host-interface of the Intel Ethernet Switch FM10000 Series device.
106 Each VF can have a maximum of 16 queue pairs.
107 The Physical Function in host could be only configured by the Linux* fm10k driver
108 (in the case of the Linux Kernel-based Virtual Machine [KVM]), DPDK PMD PF driver doesn't support it yet.
109
110 For example,
111
112 *   Using Linux* fm10k driver:
113
114     .. code-block:: console
115
116         rmmod fm10k (To remove the fm10k module)
117         insmod fm0k.ko max_vfs=2,2 (To enable two Virtual Functions per port)
118
119 Virtual Function enumeration is performed in the following sequence by the Linux* pci driver for a dual-port NIC.
120 When you enable the four Virtual Functions with the above command, the four enabled functions have a Function#
121 represented by (Bus#, Device#, Function#) in sequence starting from 0 to 3.
122 However:
123
124 *   Virtual Functions 0 and 2 belong to Physical Function 0
125
126 *   Virtual Functions 1 and 3 belong to Physical Function 1
127
128 .. note::
129
130     The above is an important consideration to take into account when targeting specific packets to a selected port.
131
132 Intel® X710/XL710 Gigabit Ethernet Controller VF Infrastructure
133 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
134
135 In a virtualized environment, the programmer can enable a maximum of *128 Virtual Functions (VF)*
136 globally per Intel® X710/XL710 Gigabit Ethernet Controller NIC device.
137 The Physical Function in host could be either configured by the Linux* i40e driver
138 (in the case of the Linux Kernel-based Virtual Machine [KVM]) or by DPDK PMD PF driver.
139 When using both DPDK PMD PF/VF drivers, the whole NIC will be taken over by DPDK based application.
140
141 For example,
142
143 *   Using Linux* i40e  driver:
144
145     .. code-block:: console
146
147         rmmod i40e (To remove the i40e module)
148         insmod i40e.ko max_vfs=2,2 (To enable two Virtual Functions per port)
149
150 *   Using the DPDK PMD PF i40e driver:
151
152     Kernel Params: iommu=pt, intel_iommu=on
153
154     .. code-block:: console
155
156         modprobe uio
157         insmod igb_uio
158         ./dpdk-devbind.py -b igb_uio bb:ss.f
159         echo 2 > /sys/bus/pci/devices/0000\:bb\:ss.f/max_vfs (To enable two VFs on a specific PCI device)
160
161     Launch the DPDK testpmd/example or your own host daemon application using the DPDK PMD library.
162
163 Virtual Function enumeration is performed in the following sequence by the Linux* pci driver for a dual-port NIC.
164 When you enable the four Virtual Functions with the above command, the four enabled functions have a Function#
165 represented by (Bus#, Device#, Function#) in sequence starting from 0 to 3.
166 However:
167
168 *   Virtual Functions 0 and 2 belong to Physical Function 0
169
170 *   Virtual Functions 1 and 3 belong to Physical Function 1
171
172 .. note::
173
174     The above is an important consideration to take into account when targeting specific packets to a selected port.
175
176     For Intel® X710/XL710 Gigabit Ethernet Controller, queues are in pairs. One queue pair means one receive queue and
177     one transmit queue. The default number of queue pairs per VF is 4, and can be 16 in maximum.
178
179 Intel® 82599 10 Gigabit Ethernet Controller VF Infrastructure
180 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
181
182 The programmer can enable a maximum of *63 Virtual Functions* and there must be *one Physical Function* per Intel® 82599
183 10 Gigabit Ethernet Controller NIC port.
184 The reason for this is that the device allows for a maximum of 128 queues per port and a virtual/physical function has to
185 have at least one queue pair (RX/TX).
186 The current implementation of the DPDK ixgbevf driver supports a single queue pair (RX/TX) per Virtual Function.
187 The Physical Function in host could be either configured by the Linux* ixgbe driver
188 (in the case of the Linux Kernel-based Virtual Machine [KVM]) or by DPDK PMD PF driver.
189 When using both DPDK PMD PF/VF drivers, the whole NIC will be taken over by DPDK based application.
190
191 For example,
192
193 *   Using Linux* ixgbe driver:
194
195     .. code-block:: console
196
197         rmmod ixgbe (To remove the ixgbe module)
198         insmod ixgbe max_vfs=2,2 (To enable two Virtual Functions per port)
199
200 *   Using the DPDK PMD PF ixgbe driver:
201
202     Kernel Params: iommu=pt, intel_iommu=on
203
204     .. code-block:: console
205
206         modprobe uio
207         insmod igb_uio
208         ./dpdk-devbind.py -b igb_uio bb:ss.f
209         echo 2 > /sys/bus/pci/devices/0000\:bb\:ss.f/max_vfs (To enable two VFs on a specific PCI device)
210
211     Launch the DPDK testpmd/example or your own host daemon application using the DPDK PMD library.
212
213 *   Using the DPDK PMD PF ixgbe driver to enable VF RSS:
214
215     Same steps as above to install the modules of uio, igb_uio, specify max_vfs for PCI device, and
216     launch the DPDK testpmd/example or your own host daemon application using the DPDK PMD library.
217
218     The available queue number (at most 4) per VF depends on the total number of pool, which is
219     determined by the max number of VF at PF initialization stage and the number of queue specified
220     in config:
221
222     *   If the max number of VFs (max_vfs) is set in the range of 1 to 32:
223
224         If the number of Rx queues is specified as 4 (``--rxq=4`` in testpmd), then there are totally 32
225         pools (ETH_32_POOLS), and each VF could have 4 Rx queues;
226
227         If the number of Rx queues is specified as 2 (``--rxq=2`` in testpmd), then there are totally 32
228         pools (ETH_32_POOLS), and each VF could have 2 Rx queues;
229
230     *   If the max number of VFs (max_vfs) is in the range of 33 to 64:
231
232         If the number of Rx queues in specified as 4 (``--rxq=4`` in testpmd), then error message is expected
233         as ``rxq`` is not correct at this case;
234
235         If the number of rxq is 2 (``--rxq=2`` in testpmd), then there is totally 64 pools (ETH_64_POOLS),
236         and each VF have 2 Rx queues;
237
238     On host, to enable VF RSS functionality, rx mq mode should be set as ETH_MQ_RX_VMDQ_RSS
239     or ETH_MQ_RX_RSS mode, and SRIOV mode should be activated (max_vfs >= 1).
240     It also needs config VF RSS information like hash function, RSS key, RSS key length.
241
242 .. note::
243
244     The limitation for VF RSS on Intel® 82599 10 Gigabit Ethernet Controller is:
245     The hash and key are shared among PF and all VF, the RETA table with 128 entries is also shared
246     among PF and all VF; So it could not to provide a method to query the hash and reta content per
247     VF on guest, while, if possible, please query them on host for the shared RETA information.
248
249 Virtual Function enumeration is performed in the following sequence by the Linux* pci driver for a dual-port NIC.
250 When you enable the four Virtual Functions with the above command, the four enabled functions have a Function#
251 represented by (Bus#, Device#, Function#) in sequence starting from 0 to 3.
252 However:
253
254 *   Virtual Functions 0 and 2 belong to Physical Function 0
255
256 *   Virtual Functions 1 and 3 belong to Physical Function 1
257
258 .. note::
259
260     The above is an important consideration to take into account when targeting specific packets to a selected port.
261
262 Intel® 82576 Gigabit Ethernet Controller and Intel® Ethernet Controller I350 Family VF Infrastructure
263 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
264
265 In a virtualized environment, an Intel® 82576 Gigabit Ethernet Controller serves up to eight virtual machines (VMs).
266 The controller has 16 TX and 16 RX queues.
267 They are generally referred to (or thought of) as queue pairs (one TX and one RX queue).
268 This gives the controller 16 queue pairs.
269
270 A pool is a group of queue pairs for assignment to the same VF, used for transmit and receive operations.
271 The controller has eight pools, with each pool containing two queue pairs, that is, two TX and two RX queues assigned to each VF.
272
273 In a virtualized environment, an Intel® Ethernet Controller I350 family device serves up to eight virtual machines (VMs) per port.
274 The eight queues can be accessed by eight different VMs if configured correctly (the i350 has 4x1GbE ports each with 8T X and 8 RX queues),
275 that means, one Transmit and one Receive queue assigned to each VF.
276
277 For example,
278
279 *   Using Linux* igb driver:
280
281     .. code-block:: console
282
283         rmmod igb (To remove the igb module)
284         insmod igb max_vfs=2,2 (To enable two Virtual Functions per port)
285
286 *   Using DPDK PMD PF igb driver:
287
288     Kernel Params: iommu=pt, intel_iommu=on modprobe uio
289
290     .. code-block:: console
291
292         insmod igb_uio
293         ./dpdk-devbind.py -b igb_uio bb:ss.f
294         echo 2 > /sys/bus/pci/devices/0000\:bb\:ss.f/max_vfs (To enable two VFs on a specific pci device)
295
296     Launch DPDK testpmd/example or your own host daemon application using the DPDK PMD library.
297
298 Virtual Function enumeration is performed in the following sequence by the Linux* pci driver for a four-port NIC.
299 When you enable the four Virtual Functions with the above command, the four enabled functions have a Function#
300 represented by (Bus#, Device#, Function#) in sequence, starting from 0 to 7.
301 However:
302
303 *   Virtual Functions 0 and 4 belong to Physical Function 0
304
305 *   Virtual Functions 1 and 5 belong to Physical Function 1
306
307 *   Virtual Functions 2 and 6 belong to Physical Function 2
308
309 *   Virtual Functions 3 and 7 belong to Physical Function 3
310
311 .. note::
312
313     The above is an important consideration to take into account when targeting specific packets to a selected port.
314
315 Validated Hypervisors
316 ~~~~~~~~~~~~~~~~~~~~~
317
318 The validated hypervisor is:
319
320 *   KVM (Kernel Virtual Machine) with  Qemu, version 0.14.0
321
322 However, the hypervisor is bypassed to configure the Virtual Function devices using the Mailbox interface,
323 the solution is hypervisor-agnostic.
324 Xen* and VMware* (when SR- IOV is supported) will also be able to support the DPDK with Virtual Function driver support.
325
326 Expected Guest Operating System in Virtual Machine
327 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
328
329 The expected guest operating systems in a virtualized environment are:
330
331 *   Fedora* 14 (64-bit)
332
333 *   Ubuntu* 10.04 (64-bit)
334
335 For supported kernel versions, refer to the *DPDK Release Notes*.
336
337 Setting Up a KVM Virtual Machine Monitor
338 ----------------------------------------
339
340 The following describes a target environment:
341
342 *   Host Operating System: Fedora 14
343
344 *   Hypervisor: KVM (Kernel Virtual Machine) with Qemu  version 0.14.0
345
346 *   Guest Operating System: Fedora 14
347
348 *   Linux Kernel Version: Refer to the  *DPDK Getting Started Guide*
349
350 *   Target Applications:  l2fwd, l3fwd-vf
351
352 The setup procedure is as follows:
353
354 #.  Before booting the Host OS, open **BIOS setup** and enable **Intel® VT features**.
355
356 #.  While booting the Host OS kernel, pass the intel_iommu=on kernel command line argument using GRUB.
357     When using DPDK PF driver on host, pass the iommu=pt kernel command line argument in GRUB.
358
359 #.  Download qemu-kvm-0.14.0 from
360     `http://sourceforge.net/projects/kvm/files/qemu-kvm/ <http://sourceforge.net/projects/kvm/files/qemu-kvm/>`_
361     and install it in the Host OS using the following steps:
362
363     When using a recent kernel (2.6.25+) with kvm modules included:
364
365     .. code-block:: console
366
367         tar xzf qemu-kvm-release.tar.gz
368         cd qemu-kvm-release
369         ./configure --prefix=/usr/local/kvm
370         make
371         sudo make install
372         sudo /sbin/modprobe kvm-intel
373
374     When using an older kernel, or a kernel from a distribution without the kvm modules,
375     you must download (from the same link), compile and install the modules yourself:
376
377     .. code-block:: console
378
379         tar xjf kvm-kmod-release.tar.bz2
380         cd kvm-kmod-release
381         ./configure
382         make
383         sudo make install
384         sudo /sbin/modprobe kvm-intel
385
386     qemu-kvm installs in the /usr/local/bin directory.
387
388     For more details about KVM configuration and usage, please refer to:
389
390     `http://www.linux-kvm.org/page/HOWTO1 <http://www.linux-kvm.org/page/HOWTO1>`_.
391
392 #.  Create a Virtual Machine and install Fedora 14 on the Virtual Machine.
393     This is referred to as the Guest Operating System (Guest OS).
394
395 #.  Download and install the latest ixgbe driver from:
396
397     `http://downloadcenter.intel.com/Detail_Desc.aspx?agr=Y&amp;DwnldID=14687 <http://downloadcenter.intel.com/Detail_Desc.aspx?agr=Y&amp;DwnldID=14687>`_
398
399 #.  In the Host OS
400
401     When using Linux kernel ixgbe driver, unload the Linux ixgbe driver and reload it with the max_vfs=2,2 argument:
402
403     .. code-block:: console
404
405         rmmod ixgbe
406         modprobe ixgbe max_vfs=2,2
407
408     When using DPDK PMD PF driver, insert DPDK kernel module igb_uio and set the number of VF by sysfs max_vfs:
409
410     .. code-block:: console
411
412         modprobe uio
413         insmod igb_uio
414         ./dpdk-devbind.py -b igb_uio 02:00.0 02:00.1 0e:00.0 0e:00.1
415         echo 2 > /sys/bus/pci/devices/0000\:02\:00.0/max_vfs
416         echo 2 > /sys/bus/pci/devices/0000\:02\:00.1/max_vfs
417         echo 2 > /sys/bus/pci/devices/0000\:0e\:00.0/max_vfs
418         echo 2 > /sys/bus/pci/devices/0000\:0e\:00.1/max_vfs
419
420     .. note::
421
422         You need to explicitly specify number of vfs for each port, for example,
423         in the command above, it creates two vfs for the first two ixgbe ports.
424
425     Let say we have a machine with four physical ixgbe ports:
426
427
428         0000:02:00.0
429
430         0000:02:00.1
431
432         0000:0e:00.0
433
434         0000:0e:00.1
435
436     The command above creates two vfs for device 0000:02:00.0:
437
438     .. code-block:: console
439
440         ls -alrt /sys/bus/pci/devices/0000\:02\:00.0/virt*
441         lrwxrwxrwx. 1 root root 0 Apr 13 05:40 /sys/bus/pci/devices/0000:02:00.0/virtfn1 -> ../0000:02:10.2
442         lrwxrwxrwx. 1 root root 0 Apr 13 05:40 /sys/bus/pci/devices/0000:02:00.0/virtfn0 -> ../0000:02:10.0
443
444     It also creates two vfs for device 0000:02:00.1:
445
446     .. code-block:: console
447
448         ls -alrt /sys/bus/pci/devices/0000\:02\:00.1/virt*
449         lrwxrwxrwx. 1 root root 0 Apr 13 05:51 /sys/bus/pci/devices/0000:02:00.1/virtfn1 -> ../0000:02:10.3
450         lrwxrwxrwx. 1 root root 0 Apr 13 05:51 /sys/bus/pci/devices/0000:02:00.1/virtfn0 -> ../0000:02:10.1
451
452 #.  List the PCI devices connected and notice that the Host OS shows two Physical Functions (traditional ports)
453     and four Virtual Functions (two for each port).
454     This is the result of the previous step.
455
456 #.  Insert the pci_stub module to hold the PCI devices that are freed from the default driver using the following command
457     (see http://www.linux-kvm.org/page/How_to_assign_devices_with_VT-d_in_KVM Section 4 for more information):
458
459     .. code-block:: console
460
461         sudo /sbin/modprobe pci-stub
462
463     Unbind the default driver from the PCI devices representing the Virtual Functions.
464     A script to perform this action is as follows:
465
466     .. code-block:: console
467
468         echo "8086 10ed" > /sys/bus/pci/drivers/pci-stub/new_id
469         echo 0000:08:10.0 > /sys/bus/pci/devices/0000:08:10.0/driver/unbind
470         echo 0000:08:10.0 > /sys/bus/pci/drivers/pci-stub/bind
471
472     where, 0000:08:10.0 belongs to the Virtual Function visible in the Host OS.
473
474 #.  Now, start the Virtual Machine by running the following command:
475
476     .. code-block:: console
477
478         /usr/local/kvm/bin/qemu-system-x86_64 -m 4096 -smp 4 -boot c -hda lucid.qcow2 -device pci-assign,host=08:10.0
479
480     where:
481
482         — -m = memory to assign
483
484         — -smp = number of smp cores
485
486         — -boot = boot option
487
488         — -hda = virtual disk image
489
490         — -device = device to attach
491
492     .. note::
493
494         — The pci-assign,host=08:10.0 value indicates that you want to attach a PCI device
495         to a Virtual Machine and the respective (Bus:Device.Function)
496         numbers should be passed for the Virtual Function to be attached.
497
498         — qemu-kvm-0.14.0 allows a maximum of four PCI devices assigned to a VM,
499         but this is qemu-kvm version dependent since qemu-kvm-0.14.1 allows a maximum of five PCI devices.
500
501         — qemu-system-x86_64 also has a -cpu command line option that is used to select the cpu_model
502         to emulate in a Virtual Machine. Therefore, it can be used as:
503
504         .. code-block:: console
505
506             /usr/local/kvm/bin/qemu-system-x86_64 -cpu ?
507
508             (to list all available cpu_models)
509
510             /usr/local/kvm/bin/qemu-system-x86_64 -m 4096 -cpu host -smp 4 -boot c -hda lucid.qcow2 -device pci-assign,host=08:10.0
511
512             (to use the same cpu_model equivalent to the host cpu)
513
514         For more information, please refer to: `http://wiki.qemu.org/Features/CPUModels <http://wiki.qemu.org/Features/CPUModels>`_.
515
516 #.  If use vfio-pci to pass through device instead of pci-assign, steps 8 and 9 need to be updated to bind device to vfio-pci and
517     replace pci-assign with vfio-pci when start virtual machine.
518
519     .. code-block:: console
520
521         sudo /sbin/modprobe vfio-pci
522
523         echo "8086 10ed" > /sys/bus/pci/drivers/vfio-pci/new_id
524         echo 0000:08:10.0 > /sys/bus/pci/devices/0000:08:10.0/driver/unbind
525         echo 0000:08:10.0 > /sys/bus/pci/drivers/vfio-pci/bind
526
527         /usr/local/kvm/bin/qemu-system-x86_64 -m 4096 -smp 4 -boot c -hda lucid.qcow2 -device vfio-pci,host=08:10.0
528
529 #.  Install and run DPDK host app to take  over the Physical Function. Eg.
530
531     .. code-block:: console
532
533         ./<build_dir>/app/dpdk-testpmd -l 0-3 -n 4 -- -i
534
535 #.  Finally, access the Guest OS using vncviewer with the localhost:5900 port and check the lspci command output in the Guest OS.
536     The virtual functions will be listed as available for use.
537
538 #.  Configure and install the DPDK on the Guest OS as normal, that is, there is no change to the normal installation procedure.
539
540 .. note::
541
542     If you are unable to compile the DPDK and you are getting "error: CPU you selected does not support x86-64 instruction set",
543     power off the Guest OS and start the virtual machine with the correct -cpu option in the qemu- system-x86_64 command as shown in step 9.
544     You must select the best x86_64 cpu_model to emulate or you can select host option if available.
545
546 .. note::
547
548     Run the DPDK l2fwd sample application in the Guest OS with Hugepages enabled.
549     For the expected benchmark performance, you must pin the cores from the Guest OS to the Host OS (taskset can be used to do this) and
550     you must also look at the PCI Bus layout on the board to ensure you are not running the traffic over the QPI Interface.
551
552 .. note::
553
554     *   The Virtual Machine Manager (the Fedora package name is virt-manager) is a utility for virtual machine management
555         that can also be used to create, start, stop and delete virtual machines.
556         If this option is used, step 2 and 6 in the instructions provided will be different.
557
558     *   virsh, a command line utility for virtual machine management,
559         can also be used to bind and unbind devices to a virtual machine in Ubuntu.
560         If this option is used, step 6 in the instructions provided will be different.
561
562     *   The Virtual Machine Monitor (see :numref:`figure_perf_benchmark`) is equivalent to a Host OS with KVM installed as described in the instructions.
563
564 .. _figure_perf_benchmark:
565
566 .. figure:: img/perf_benchmark.*
567
568    Performance Benchmark Setup
569
570
571 DPDK SR-IOV PMD PF/VF Driver Usage Model
572 ----------------------------------------
573
574 Fast Host-based Packet Processing
575 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
576
577 Software Defined Network (SDN) trends are demanding fast host-based packet handling.
578 In a virtualization environment,
579 the DPDK VF PMD driver performs the same throughput result as a non-VT native environment.
580
581 With such host instance fast packet processing, lots of services such as filtering, QoS,
582 DPI can be offloaded on the host fast path.
583
584 :numref:`figure_fast_pkt_proc` shows the scenario where some VMs directly communicate externally via a VFs,
585 while others connect to a virtual switch and share the same uplink bandwidth.
586
587 .. _figure_fast_pkt_proc:
588
589 .. figure:: img/fast_pkt_proc.*
590
591    Fast Host-based Packet Processing
592
593
594 SR-IOV (PF/VF) Approach for Inter-VM Communication
595 --------------------------------------------------
596
597 Inter-VM data communication is one of the traffic bottle necks in virtualization platforms.
598 SR-IOV device assignment helps a VM to attach the real device, taking advantage of the bridge in the NIC.
599 So VF-to-VF traffic within the same physical port (VM0<->VM1) have hardware acceleration.
600 However, when VF crosses physical ports (VM0<->VM2), there is no such hardware bridge.
601 In this case, the DPDK PMD PF driver provides host forwarding between such VMs.
602
603 :numref:`figure_inter_vm_comms` shows an example.
604 In this case an update of the MAC address lookup tables in both the NIC and host DPDK application is required.
605
606 In the NIC, writing the destination of a MAC address belongs to another cross device VM to the PF specific pool.
607 So when a packet comes in, its destination MAC address will match and forward to the host DPDK PMD application.
608
609 In the host DPDK application, the behavior is similar to L2 forwarding,
610 that is, the packet is forwarded to the correct PF pool.
611 The SR-IOV NIC switch forwards the packet to a specific VM according to the MAC destination address
612 which belongs to the destination VF on the VM.
613
614 .. _figure_inter_vm_comms:
615
616 .. figure:: img/inter_vm_comms.*
617
618    Inter-VM Communication