]> git.proxmox.com Git - ceph.git/blame - ceph/src/spdk/dpdk/doc/guides/nics/avp.rst
update source to Ceph Pacific 16.2.2
[ceph.git] / ceph / src / spdk / dpdk / doc / guides / nics / avp.rst
CommitLineData
f67539c2
TL
1.. SPDX-License-Identifier: BSD-3-Clause
2 Copyright(c) 2017 Wind River Systems, Inc.
11fdf7f2
TL
3 All rights reserved.
4
11fdf7f2
TL
5AVP Poll Mode Driver
6=================================================================
7
8The Accelerated Virtual Port (AVP) device is a shared memory based device
9only available on `virtualization platforms <http://www.windriver.com/products/titanium-cloud/>`_
10from Wind River Systems. The Wind River Systems virtualization platform
11currently uses QEMU/KVM as its hypervisor and as such provides support for all
12of the QEMU supported virtual and/or emulated devices (e.g., virtio, e1000,
13etc.). The platform offers the virtio device type as the default device when
14launching a virtual machine or creating a virtual machine port. The AVP device
15is a specialized device available to customers that require increased
16throughput and decreased latency to meet the demands of their performance
17focused applications.
18
19The AVP driver binds to any AVP PCI devices that have been exported by the Wind
20River Systems QEMU/KVM hypervisor. As a user of the DPDK driver API it
21supports a subset of the full Ethernet device API to enable the application to
22use the standard device configuration functions and packet receive/transmit
23functions.
24
25These devices enable optimized packet throughput by bypassing QEMU and
26delivering packets directly to the virtual switch via a shared memory
27mechanism. This provides DPDK applications running in virtual machines with
28significantly improved throughput and latency over other device types.
29
30The AVP device implementation is integrated with the QEMU/KVM live-migration
31mechanism to allow applications to seamlessly migrate from one hypervisor node
32to another with minimal packet loss.
33
34
35Features and Limitations of the AVP PMD
36---------------------------------------
37
38The AVP PMD driver provides the following functionality.
39
40* Receive and transmit of both simple and chained mbuf packets,
41
42* Chained mbufs may include up to 5 chained segments,
43
44* Up to 8 receive and transmit queues per device,
45
46* Only a single MAC address is supported,
47
48* The MAC address cannot be modified,
49
50* The maximum receive packet length is 9238 bytes,
51
52* VLAN header stripping and inserting,
53
54* Promiscuous mode
55
56* VM live-migration
57
58* PCI hotplug insertion and removal
59
60
61Prerequisites
62-------------
63
64The following prerequisites apply:
65
66* A virtual machine running in a Wind River Systems virtualization
67 environment and configured with at least one neutron port defined with a
68 vif-model set to "avp".
69
70
71Launching a VM with an AVP type network attachment
72--------------------------------------------------
73
74The following example will launch a VM with three network attachments. The
75first attachment will have a default vif-model of "virtio". The next two
76network attachments will have a vif-model of "avp" and may be used with a DPDK
77application which is built to include the AVP PMD driver.
78
79.. code-block:: console
80
81 nova boot --flavor small --image my-image \
82 --nic net-id=${NETWORK1_UUID} \
83 --nic net-id=${NETWORK2_UUID},vif-model=avp \
84 --nic net-id=${NETWORK3_UUID},vif-model=avp \
85 --security-group default my-instance1