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         int                     enabled;
  93         struct buf_vector       buf_vec[BUF_VECTOR_MAX];        /**< for scatter RX. */
  94 } __rte_cache_aligned;
  95
  96
  97 /*
  98  * Make an extra wrapper for VIRTIO_NET_F_MQ and
  99  * VIRTIO_NET_CTRL_MQ_VQ_PAIRS_MAX as they are
 100  * introduced since kernel v3.8. This makes our
 101  * code buildable for older kernel.
 102  */
 103 #ifdef VIRTIO_NET_F_MQ
 104  #define VHOST_MAX_QUEUE_PAIRS  VIRTIO_NET_CTRL_MQ_VQ_PAIRS_MAX
 105  #define VHOST_SUPPORTS_MQ      (1ULL << VIRTIO_NET_F_MQ)
 106 #else
 107  #define VHOST_MAX_QUEUE_PAIRS  1
 108  #define VHOST_SUPPORTS_MQ      0
 109 #endif
 110
 111 /**
 112  * Device structure contains all configuration information relating to the device.
 113  */
 114 struct virtio_net {
 115         struct virtio_memory    *mem;           /**< QEMU memory and memory region information. */
 116         uint64_t                features;       /**< Negotiated feature set. */
 117         uint64_t                protocol_features;      /**< Negotiated protocol feature set. */
 118         uint64_t                device_fh;      /**< device identifier. */
 119         uint32_t                flags;          /**< Device flags. Only used to check if device is running on data core. */
 120 #define IF_NAME_SZ (PATH_MAX > IFNAMSIZ ? PATH_MAX : IFNAMSIZ)
 121         char                    ifname[IF_NAME_SZ];     /**< Name of the tap device or socket path. */
 122         uint32_t                virt_qp_nb;     /**< number of queue pair we have allocated */
 123         void                    *priv;          /**< private context */
 124         struct vhost_virtqueue  *virtqueue[VHOST_MAX_QUEUE_PAIRS * 2];  /**< Contains all virtqueue information. */
 125 } __rte_cache_aligned;
 126
 127 /**
 128  * Information relating to memory regions including offsets to addresses in QEMUs memory file.
 129  */
 130 struct virtio_memory_regions {
 131         uint64_t        guest_phys_address;     /**< Base guest physical address of region. */
 132         uint64_t        guest_phys_address_end; /**< End guest physical address of region. */
 133         uint64_t        memory_size;            /**< Size of region. */
 134         uint64_t        userspace_address;      /**< Base userspace address of region. */
 135         uint64_t        address_offset;         /**< Offset of region for address translation. */
 136 };
 137
 138
 139 /**
 140  * Memory structure includes region and mapping information.
 141  */
 142 struct virtio_memory {
 143         uint64_t        base_address;   /**< Base QEMU userspace address of the memory file. */
 144         uint64_t        mapped_address; /**< Mapped address of memory file base in our applications memory space. */
 145         uint64_t        mapped_size;    /**< Total size of memory file. */
 146         uint32_t        nregions;       /**< Number of memory regions. */
 147         struct virtio_memory_regions      regions[0]; /**< Memory region information. */
 148 };
 149
 150 /**
 151  * Device and vring operations.
 152  *
 153  * Make sure to set VIRTIO_DEV_RUNNING to the device flags in new_device and
 154  * remove it in destroy_device.
 155  *
 156  */
 157 struct virtio_net_device_ops {
 158         int (*new_device)(struct virtio_net *); /**< Add device. */
 159         void (*destroy_device)(volatile struct virtio_net *);   /**< Remove device. */
 160
 161         int (*vring_state_changed)(struct virtio_net *dev, uint16_t queue_id, int enable);      /**< triggered when a vring is enabled or disabled */
 162 };
 163
 164 static inline uint16_t __attribute__((always_inline))
 165 rte_vring_available_entries(struct virtio_net *dev, uint16_t queue_id)
 166 {
 167         struct vhost_virtqueue *vq = dev->virtqueue[queue_id];
 168
 169         if (!vq->enabled)
 170                 return 0;
 171
 172         return *(volatile uint16_t *)&vq->avail->idx - vq->last_used_idx_res;
 173 }
 174
 175 /**
 176  * Function to convert guest physical addresses to vhost virtual addresses.
 177  * This is used to convert guest virtio buffer addresses.
 178  */
 179 static inline uint64_t __attribute__((always_inline))
 180 gpa_to_vva(struct virtio_net *dev, uint64_t guest_pa)
 181 {
 182         struct virtio_memory_regions *region;
 183         uint32_t regionidx;
 184         uint64_t vhost_va = 0;
 185
 186         for (regionidx = 0; regionidx < dev->mem->nregions; regionidx++) {
 187                 region = &dev->mem->regions[regionidx];
 188                 if ((guest_pa >= region->guest_phys_address) &&
 189                         (guest_pa <= region->guest_phys_address_end)) {
 190                         vhost_va = region->address_offset + guest_pa;
 191                         break;
 192                 }
 193         }
 194         return vhost_va;
 195 }
 196
 197 /**
 198  *  Disable features in feature_mask. Returns 0 on success.
 199  */
 200 int rte_vhost_feature_disable(uint64_t feature_mask);
 201
 202 /**
 203  *  Enable features in feature_mask. Returns 0 on success.
 204  */
 205 int rte_vhost_feature_enable(uint64_t feature_mask);
 206
 207 /* Returns currently supported vhost features */
 208 uint64_t rte_vhost_feature_get(void);
 209
 210 int rte_vhost_enable_guest_notification(struct virtio_net *dev, uint16_t queue_id, int enable);
 211
 212 /* Register vhost driver. dev_name could be different for multiple instance support. */
 213 int rte_vhost_driver_register(const char *dev_name);
 214
 215 /* Unregister vhost driver. This is only meaningful to vhost user. */
 216 int rte_vhost_driver_unregister(const char *dev_name);
 217
 218 /* Register callbacks. */
 219 int rte_vhost_driver_callback_register(struct virtio_net_device_ops const * const);
 220 /* Start vhost driver session blocking loop. */
 221 int rte_vhost_driver_session_start(void);
 222
 223 /**
 224  * This function adds buffers to the virtio devices RX virtqueue. Buffers can
 225  * be received from the physical port or from another virtual device. A packet
 226  * count is returned to indicate the number of packets that were succesfully
 227  * added to the RX queue.
 228  * @param dev
 229  *  virtio-net device
 230  * @param queue_id
 231  *  virtio queue index in mq case
 232  * @param pkts
 233  *  array to contain packets to be enqueued
 234  * @param count
 235  *  packets num to be enqueued
 236  * @return
 237  *  num of packets enqueued
 238  */
 239 uint16_t rte_vhost_enqueue_burst(struct virtio_net *dev, uint16_t queue_id,
 240         struct rte_mbuf **pkts, uint16_t count);
 241
 242 /**
 243  * This function gets guest buffers from the virtio device TX virtqueue,
 244  * construct host mbufs, copies guest buffer content to host mbufs and
 245  * store them in pkts to be processed.
 246  * @param dev
 247  *  virtio-net device
 248  * @param queue_id
 249  *  virtio queue index in mq case
 250  * @param mbuf_pool
 251  *  mbuf_pool where host mbuf is allocated.
 252  * @param pkts
 253  *  array to contain packets to be dequeued
 254  * @param count
 255  *  packets num to be dequeued
 256  * @return
 257  *  num of packets dequeued
 258  */
 259 uint16_t rte_vhost_dequeue_burst(struct virtio_net *dev, uint16_t queue_id,
 260         struct rte_mempool *mbuf_pool, struct rte_mbuf **pkts, uint16_t count);
 261
 262 #endif /* _VIRTIO_NET_H_ */