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 #include <stdint.h>
  38 #include <linux/virtio_ring.h>
  39 #include <linux/virtio_net.h>
  40 #include <sys/eventfd.h>
  41
  42 #include <rte_memory.h>
  43 #include <rte_mempool.h>
  44 #include <rte_mbuf.h>
  45
  46 /* Used to indicate that the device is running on a data core */
  47 #define VIRTIO_DEV_RUNNING 1
  48
  49 /* Backend value set by guest. */
  50 #define VIRTIO_DEV_STOPPED -1
  51
  52
  53 /* Enum for virtqueue management. */
  54 enum {VIRTIO_RXQ, VIRTIO_TXQ, VIRTIO_QNUM};
  55
  56 #define BUF_VECTOR_MAX 256
  57
  58 /**
  59  * Structure contains buffer address, length and descriptor index
  60  * from vring to do scatter RX.
  61  */
  62 struct buf_vector {
  63         uint64_t buf_addr;
  64         uint32_t buf_len;
  65         uint32_t desc_idx;
  66 };
  67
  68 /**
  69  * Structure contains variables relevant to RX/TX virtqueues.
  70  */
  71 struct vhost_virtqueue {
  72         struct vring_desc       *desc;                  /**< Virtqueue descriptor ring. */
  73         struct vring_avail      *avail;                 /**< Virtqueue available ring. */
  74         struct vring_used       *used;                  /**< Virtqueue used ring. */
  75         uint32_t                size;                   /**< Size of descriptor ring. */
  76         uint32_t                backend;                /**< Backend value to determine if device should started/stopped. */
  77         uint16_t                vhost_hlen;             /**< Vhost header length (varies depending on RX merge buffers. */
  78         volatile uint16_t       last_used_idx;          /**< Last index used on the available ring */
  79         volatile uint16_t       last_used_idx_res;      /**< Used for multiple devices reserving buffers. */
  80         eventfd_t               callfd;                 /**< Currently unused as polling mode is enabled. */
  81         eventfd_t               kickfd;                 /**< Used to notify the guest (trigger interrupt). */
  82         struct buf_vector       buf_vec[BUF_VECTOR_MAX];        /**< for scatter RX. */
  83 } __rte_cache_aligned;
  84
  85 /**
  86  * Device structure contains all configuration information relating to the device.
  87  */
  88 struct virtio_net
  89 {
  90         struct vhost_virtqueue  *virtqueue[VIRTIO_QNUM];        /**< Contains all virtqueue information. */
  91         struct virtio_memory    *mem;           /**< QEMU memory and memory region information. */
  92         uint64_t                features;       /**< Negotiated feature set. */
  93         uint64_t                device_fh;      /**< device identifier. */
  94         uint32_t                flags;          /**< Device flags. Only used to check if device is running on data core. */
  95         void                    *priv;          /**< private context */
  96 } __rte_cache_aligned;
  97
  98 /**
  99  * Information relating to memory regions including offsets to addresses in QEMUs memory file.
 100  */
 101 struct virtio_memory_regions {
 102         uint64_t        guest_phys_address;     /**< Base guest physical address of region. */
 103         uint64_t        guest_phys_address_end; /**< End guest physical address of region. */
 104         uint64_t        memory_size;            /**< Size of region. */
 105         uint64_t        userspace_address;      /**< Base userspace address of region. */
 106         uint64_t        address_offset;         /**< Offset of region for address translation. */
 107 };
 108
 109
 110 /**
 111  * Memory structure includes region and mapping information.
 112  */
 113 struct virtio_memory {
 114         uint64_t        base_address;   /**< Base QEMU userspace address of the memory file. */
 115         uint64_t        mapped_address; /**< Mapped address of memory file base in our applications memory space. */
 116         uint64_t        mapped_size;    /**< Total size of memory file. */
 117         uint32_t        nregions;       /**< Number of memory regions. */
 118         struct virtio_memory_regions      regions[0]; /**< Memory region information. */
 119 };
 120
 121 /**
 122  * Device operations to add/remove device.
 123  */
 124 struct virtio_net_device_ops {
 125         int (*new_device)(struct virtio_net *); /**< Add device. */
 126         void (*destroy_device)(volatile struct virtio_net *);   /**< Remove device. */
 127 };
 128
 129 static inline uint16_t __attribute__((always_inline))
 130 rte_vring_available_entries(struct virtio_net *dev, uint16_t queue_id)
 131 {
 132         struct vhost_virtqueue *vq = dev->virtqueue[queue_id];
 133         return *(volatile uint16_t *)&vq->avail->idx - vq->last_used_idx_res;
 134 }
 135
 136 /**
 137  * Function to convert guest physical addresses to vhost virtual addresses.
 138  * This is used to convert guest virtio buffer addresses.
 139  */
 140 static inline uint64_t __attribute__((always_inline))
 141 gpa_to_vva(struct virtio_net *dev, uint64_t guest_pa)
 142 {
 143         struct virtio_memory_regions *region;
 144         uint32_t regionidx;
 145         uint64_t vhost_va = 0;
 146
 147         for (regionidx = 0; regionidx < dev->mem->nregions; regionidx++) {
 148                 region = &dev->mem->regions[regionidx];
 149                 if ((guest_pa >= region->guest_phys_address) &&
 150                         (guest_pa <= region->guest_phys_address_end)) {
 151                         vhost_va = region->address_offset + guest_pa;
 152                         break;
 153                 }
 154         }
 155         return vhost_va;
 156 }
 157
 158 /**
 159  *  Disable features in feature_mask. Returns 0 on success.
 160  */
 161 int rte_vhost_feature_disable(uint64_t feature_mask);
 162
 163 /**
 164  *  Enable features in feature_mask. Returns 0 on success.
 165  */
 166 int rte_vhost_feature_enable(uint64_t feature_mask);
 167
 168 /* Returns currently supported vhost features */
 169 uint64_t rte_vhost_feature_get(void);
 170
 171 int rte_vhost_enable_guest_notification(struct virtio_net *dev, uint16_t queue_id, int enable);
 172
 173 /* Register vhost driver. dev_name could be different for multiple instance support. */
 174 int rte_vhost_driver_register(const char *dev_name);
 175
 176 /* Register callbacks. */
 177 int rte_vhost_driver_callback_register(struct virtio_net_device_ops const * const);
 178 /* Start vhost driver session blocking loop. */
 179 int rte_vhost_driver_session_start(void);
 180
 181 /**
 182  * This function adds buffers to the virtio devices RX virtqueue. Buffers can
 183  * be received from the physical port or from another virtual device. A packet
 184  * count is returned to indicate the number of packets that were succesfully
 185  * added to the RX queue.
 186  * @param queue_id
 187  *  virtio queue index in mq case
 188  * @return
 189  *  num of packets enqueued
 190  */
 191 uint16_t rte_vhost_enqueue_burst(struct virtio_net *dev, uint16_t queue_id,
 192         struct rte_mbuf **pkts, uint16_t count);
 193
 194 /**
 195  * This function gets guest buffers from the virtio device TX virtqueue,
 196  * construct host mbufs, copies guest buffer content to host mbufs and
 197  * store them in pkts to be processed.
 198  * @param mbuf_pool
 199  *  mbuf_pool where host mbuf is allocated.
 200  * @param queue_id
 201  *  virtio queue index in mq case.
 202  * @return
 203  *  num of packets dequeued
 204  */
 205 uint16_t rte_vhost_dequeue_burst(struct virtio_net *dev, uint16_t queue_id,
 206         struct rte_mempool *mbuf_pool, struct rte_mbuf **pkts, uint16_t count);
 207
 208 #endif /* _VIRTIO_NET_H_ */