lib/librte_vhost/rte_virtio_net.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
   5  *   All rights reserved.
   6  *
   7  *   Redistribution and use in source and binary forms, with or without
   8  *   modification, are permitted provided that the following conditions
   9  *   are met:
  10  *
  11  *     * Redistributions of source code must retain the above copyright
  12  *       notice, this list of conditions and the following disclaimer.
  13  *     * Redistributions in binary form must reproduce the above copyright
  14  *       notice, this list of conditions and the following disclaimer in
  15  *       the documentation and/or other materials provided with the
  16  *       distribution.
  17  *     * Neither the name of Intel Corporation nor the names of its
  18  *       contributors may be used to endorse or promote products derived
  19  *       from this software without specific prior written permission.
  20  *
  21  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  24  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  25  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  26  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  27  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  28  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  29  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  30  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  31  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32  */
  33
  34 #ifndef _VIRTIO_NET_H_
  35 #define _VIRTIO_NET_H_
  36
  37 /**
  38  * @file
  39  * Interface to vhost net
  40  */
  41
  42 #include <stdint.h>
  43 #include <linux/virtio_ring.h>
  44 #include <linux/virtio_net.h>
  45 #include <sys/eventfd.h>
  46
  47 #include <rte_memory.h>
  48 #include <rte_mempool.h>
  49 #include <rte_mbuf.h>
  50
  51 /* Used to indicate that the device is running on a data core */
  52 #define VIRTIO_DEV_RUNNING 1
  53
  54 /* Backend value set by guest. */
  55 #define VIRTIO_DEV_STOPPED -1
  56
  57
  58 /* Enum for virtqueue management. */
  59 enum {VIRTIO_RXQ, VIRTIO_TXQ, VIRTIO_QNUM};
  60
  61 #define BUF_VECTOR_MAX 256
  62
  63 /**
  64  * Structure contains buffer address, length and descriptor index
  65  * from vring to do scatter RX.
  66  */
  67 struct buf_vector {
  68         uint64_t buf_addr;
  69         uint32_t buf_len;
  70         uint32_t desc_idx;
  71 };
  72
  73 /**
  74  * Structure contains variables relevant to RX/TX virtqueues.
  75  */
  76 struct vhost_virtqueue {
  77         struct vring_desc       *desc;                  /**< Virtqueue descriptor ring. */
  78         struct vring_avail      *avail;                 /**< Virtqueue available ring. */
  79         struct vring_used       *used;                  /**< Virtqueue used ring. */
  80         uint32_t                size;                   /**< Size of descriptor ring. */
  81         uint32_t                backend;                /**< Backend value to determine if device should started/stopped. */
  82         uint16_t                vhost_hlen;             /**< Vhost header length (varies depending on RX merge buffers. */
  83         volatile uint16_t       last_used_idx;          /**< Last index used on the available ring */
  84         volatile uint16_t       last_used_idx_res;      /**< Used for multiple devices reserving buffers. */
  85         eventfd_t               callfd;                 /**< Currently unused as polling mode is enabled. */
  86         eventfd_t               kickfd;                 /**< Used to notify the guest (trigger interrupt). */
  87         struct buf_vector       buf_vec[BUF_VECTOR_MAX];        /**< for scatter RX. */
  88 } __rte_cache_aligned;
  89
  90 /**
  91  * Device structure contains all configuration information relating to the device.
  92  */
  93 struct virtio_net
  94 {
  95         struct vhost_virtqueue  *virtqueue[VIRTIO_QNUM];        /**< Contains all virtqueue information. */
  96         struct virtio_memory    *mem;           /**< QEMU memory and memory region information. */
  97         uint64_t                features;       /**< Negotiated feature set. */
  98         uint64_t                device_fh;      /**< device identifier. */
  99         uint32_t                flags;          /**< Device flags. Only used to check if device is running on data core. */
 100         void                    *priv;          /**< private context */
 101 } __rte_cache_aligned;
 102
 103 /**
 104  * Information relating to memory regions including offsets to addresses in QEMUs memory file.
 105  */
 106 struct virtio_memory_regions {
 107         uint64_t        guest_phys_address;     /**< Base guest physical address of region. */
 108         uint64_t        guest_phys_address_end; /**< End guest physical address of region. */
 109         uint64_t        memory_size;            /**< Size of region. */
 110         uint64_t        userspace_address;      /**< Base userspace address of region. */
 111         uint64_t        address_offset;         /**< Offset of region for address translation. */
 112 };
 113
 114
 115 /**
 116  * Memory structure includes region and mapping information.
 117  */
 118 struct virtio_memory {
 119         uint64_t        base_address;   /**< Base QEMU userspace address of the memory file. */
 120         uint64_t        mapped_address; /**< Mapped address of memory file base in our applications memory space. */
 121         uint64_t        mapped_size;    /**< Total size of memory file. */
 122         uint32_t        nregions;       /**< Number of memory regions. */
 123         struct virtio_memory_regions      regions[0]; /**< Memory region information. */
 124 };
 125
 126 /**
 127  * Device operations to add/remove device.
 128  */
 129 struct virtio_net_device_ops {
 130         int (*new_device)(struct virtio_net *); /**< Add device. */
 131         void (*destroy_device)(volatile struct virtio_net *);   /**< Remove device. */
 132 };
 133
 134 static inline uint16_t __attribute__((always_inline))
 135 rte_vring_available_entries(struct virtio_net *dev, uint16_t queue_id)
 136 {
 137         struct vhost_virtqueue *vq = dev->virtqueue[queue_id];
 138         return *(volatile uint16_t *)&vq->avail->idx - vq->last_used_idx_res;
 139 }
 140
 141 /**
 142  * Function to convert guest physical addresses to vhost virtual addresses.
 143  * This is used to convert guest virtio buffer addresses.
 144  */
 145 static inline uint64_t __attribute__((always_inline))
 146 gpa_to_vva(struct virtio_net *dev, uint64_t guest_pa)
 147 {
 148         struct virtio_memory_regions *region;
 149         uint32_t regionidx;
 150         uint64_t vhost_va = 0;
 151
 152         for (regionidx = 0; regionidx < dev->mem->nregions; regionidx++) {
 153                 region = &dev->mem->regions[regionidx];
 154                 if ((guest_pa >= region->guest_phys_address) &&
 155                         (guest_pa <= region->guest_phys_address_end)) {
 156                         vhost_va = region->address_offset + guest_pa;
 157                         break;
 158                 }
 159         }
 160         return vhost_va;
 161 }
 162
 163 /**
 164  *  Disable features in feature_mask. Returns 0 on success.
 165  */
 166 int rte_vhost_feature_disable(uint64_t feature_mask);
 167
 168 /**
 169  *  Enable features in feature_mask. Returns 0 on success.
 170  */
 171 int rte_vhost_feature_enable(uint64_t feature_mask);
 172
 173 /* Returns currently supported vhost features */
 174 uint64_t rte_vhost_feature_get(void);
 175
 176 int rte_vhost_enable_guest_notification(struct virtio_net *dev, uint16_t queue_id, int enable);
 177
 178 /* Register vhost driver. dev_name could be different for multiple instance support. */
 179 int rte_vhost_driver_register(const char *dev_name);
 180
 181 /* Register callbacks. */
 182 int rte_vhost_driver_callback_register(struct virtio_net_device_ops const * const);
 183 /* Start vhost driver session blocking loop. */
 184 int rte_vhost_driver_session_start(void);
 185
 186 /**
 187  * This function adds buffers to the virtio devices RX virtqueue. Buffers can
 188  * be received from the physical port or from another virtual device. A packet
 189  * count is returned to indicate the number of packets that were succesfully
 190  * added to the RX queue.
 191  * @param queue_id
 192  *  virtio queue index in mq case
 193  * @return
 194  *  num of packets enqueued
 195  */
 196 uint16_t rte_vhost_enqueue_burst(struct virtio_net *dev, uint16_t queue_id,
 197         struct rte_mbuf **pkts, uint16_t count);
 198
 199 /**
 200  * This function gets guest buffers from the virtio device TX virtqueue,
 201  * construct host mbufs, copies guest buffer content to host mbufs and
 202  * store them in pkts to be processed.
 203  * @param mbuf_pool
 204  *  mbuf_pool where host mbuf is allocated.
 205  * @param queue_id
 206  *  virtio queue index in mq case.
 207  * @return
 208  *  num of packets dequeued
 209  */
 210 uint16_t rte_vhost_dequeue_burst(struct virtio_net *dev, uint16_t queue_id,
 211         struct rte_mempool *mbuf_pool, struct rte_mbuf **pkts, uint16_t count);
 212
 213 #endif /* _VIRTIO_NET_H_ */