doc/guides/nics/avp.rst

   1 ..  BSD LICENSE
   2     Copyright(c) 2017 Wind River Systems, Inc. rights reserved.
   3     All rights reserved.
   4
   5     Redistribution and use in source and binary forms, with or without
   6     modification, are permitted provided that the following conditions
   7     are met:
   8
   9     * Redistributions of source code must retain the above copyright
  10     notice, this list of conditions and the following disclaimer.
  11     * Redistributions in binary form must reproduce the above copyright
  12     notice, this list of conditions and the following disclaimer in
  13     the documentation and/or other materials provided with the
  14     distribution.
  15     * Neither the name of Intel Corporation nor the names of its
  16     contributors may be used to endorse or promote products derived
  17     from this software without specific prior written permission.
  18
  19     THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  20     "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  21     LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  22     A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  23     OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  24     SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  25     LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  26     DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  27     THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  28     (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  29     OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  30
  31 AVP Poll Mode Driver
  32 =================================================================
  33
  34 The Accelerated Virtual Port (AVP) device is a shared memory based device
  35 only available on `virtualization platforms <http://www.windriver.com/products/titanium-cloud/>`_
  36 from Wind River Systems.  The Wind River Systems virtualization platform
  37 currently uses QEMU/KVM as its hypervisor and as such provides support for all
  38 of the QEMU supported virtual and/or emulated devices (e.g., virtio, e1000,
  39 etc.).  The platform offers the virtio device type as the default device when
  40 launching a virtual machine or creating a virtual machine port.  The AVP device
  41 is a specialized device available to customers that require increased
  42 throughput and decreased latency to meet the demands of their performance
  43 focused applications.
  44
  45 The AVP driver binds to any AVP PCI devices that have been exported by the Wind
  46 River Systems QEMU/KVM hypervisor.  As a user of the DPDK driver API it
  47 supports a subset of the full Ethernet device API to enable the application to
  48 use the standard device configuration functions and packet receive/transmit
  49 functions.
  50
  51 These devices enable optimized packet throughput by bypassing QEMU and
  52 delivering packets directly to the virtual switch via a shared memory
  53 mechanism.  This provides DPDK applications running in virtual machines with
  54 significantly improved throughput and latency over other device types.
  55
  56 The AVP device implementation is integrated with the QEMU/KVM live-migration
  57 mechanism to allow applications to seamlessly migrate from one hypervisor node
  58 to another with minimal packet loss.
  59
  60
  61 Features and Limitations of the AVP PMD
  62 ---------------------------------------
  63
  64 The AVP PMD driver provides the following functionality.
  65
  66 *   Receive and transmit of both simple and chained mbuf packets,
  67
  68 *   Chained mbufs may include up to 5 chained segments,
  69
  70 *   Up to 8 receive and transmit queues per device,
  71
  72 *   Only a single MAC address is supported,
  73
  74 *   The MAC address cannot be modified,
  75
  76 *   The maximum receive packet length is 9238 bytes,
  77
  78 *   VLAN header stripping and inserting,
  79
  80 *   Promiscuous mode
  81
  82 *   VM live-migration
  83
  84 *   PCI hotplug insertion and removal
  85
  86
  87 Prerequisites
  88 -------------
  89
  90 The following prerequisites apply:
  91
  92 *   A virtual machine running in a Wind River Systems virtualization
  93     environment and configured with at least one neutron port defined with a
  94     vif-model set to "avp".
  95
  96
  97 Launching a VM with an AVP type network attachment
  98 --------------------------------------------------
  99
 100 The following example will launch a VM with three network attachments.  The
 101 first attachment will have a default vif-model of "virtio".  The next two
 102 network attachments will have a vif-model of "avp" and may be used with a DPDK
 103 application which is built to include the AVP PMD driver.
 104
 105 .. code-block:: console
 106
 107     nova boot --flavor small --image my-image \
 108        --nic net-id=${NETWORK1_UUID} \
 109        --nic net-id=${NETWORK2_UUID},vif-model=avp \
 110        --nic net-id=${NETWORK3_UUID},vif-model=avp \
 111        --security-group default my-instance1