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