lib/librte_vhost/vhost-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 _VHOST_NET_CDEV_H_
  35 #define _VHOST_NET_CDEV_H_
  36 #include <stdint.h>
  37 #include <stdio.h>
  38 #include <sys/types.h>
  39 #include <unistd.h>
  40 #include <linux/vhost.h>
  41
  42 #include <rte_log.h>
  43
  44 #include "rte_virtio_net.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 #define BUF_VECTOR_MAX 256
  53
  54 /**
  55  * Structure contains buffer address, length and descriptor index
  56  * from vring to do scatter RX.
  57  */
  58 struct buf_vector {
  59         uint64_t buf_addr;
  60         uint32_t buf_len;
  61         uint32_t desc_idx;
  62 };
  63
  64 /**
  65  * Structure contains variables relevant to RX/TX virtqueues.
  66  */
  67 struct vhost_virtqueue {
  68         struct vring_desc       *desc;
  69         struct vring_avail      *avail;
  70         struct vring_used       *used;
  71         uint32_t                size;
  72
  73         /* Last index used on the available ring */
  74         volatile uint16_t       last_used_idx;
  75         /* Used for multiple devices reserving buffers */
  76         volatile uint16_t       last_used_idx_res;
  77 #define VIRTIO_INVALID_EVENTFD          (-1)
  78 #define VIRTIO_UNINITIALIZED_EVENTFD    (-2)
  79
  80         /* Backend value to determine if device should started/stopped */
  81         int                     backend;
  82         /* Used to notify the guest (trigger interrupt) */
  83         int                     callfd;
  84         /* Currently unused as polling mode is enabled */
  85         int                     kickfd;
  86         int                     enabled;
  87
  88         /* Physical address of used ring, for logging */
  89         uint64_t                log_guest_addr;
  90         struct buf_vector       buf_vec[BUF_VECTOR_MAX];
  91 } __rte_cache_aligned;
  92
  93 /* Old kernels have no such macro defined */
  94 #ifndef VIRTIO_NET_F_GUEST_ANNOUNCE
  95  #define VIRTIO_NET_F_GUEST_ANNOUNCE 21
  96 #endif
  97
  98
  99 /*
 100  * Make an extra wrapper for VIRTIO_NET_F_MQ and
 101  * VIRTIO_NET_CTRL_MQ_VQ_PAIRS_MAX as they are
 102  * introduced since kernel v3.8. This makes our
 103  * code buildable for older kernel.
 104  */
 105 #ifdef VIRTIO_NET_F_MQ
 106  #define VHOST_MAX_QUEUE_PAIRS  VIRTIO_NET_CTRL_MQ_VQ_PAIRS_MAX
 107  #define VHOST_SUPPORTS_MQ      (1ULL << VIRTIO_NET_F_MQ)
 108 #else
 109  #define VHOST_MAX_QUEUE_PAIRS  1
 110  #define VHOST_SUPPORTS_MQ      0
 111 #endif
 112
 113 /*
 114  * Define virtio 1.0 for older kernels
 115  */
 116 #ifndef VIRTIO_F_VERSION_1
 117  #define VIRTIO_F_VERSION_1 32
 118 #endif
 119
 120 /**
 121  * Device structure contains all configuration information relating
 122  * to the device.
 123  */
 124 struct virtio_net {
 125         /* Frontend (QEMU) memory and memory region information */
 126         struct virtio_memory    *mem;
 127         uint64_t                features;
 128         uint64_t                protocol_features;
 129         int                     vid;
 130         uint32_t                flags;
 131         uint16_t                vhost_hlen;
 132 #define IF_NAME_SZ (PATH_MAX > IFNAMSIZ ? PATH_MAX : IFNAMSIZ)
 133         char                    ifname[IF_NAME_SZ];
 134         uint32_t                virt_qp_nb;
 135         uint64_t                log_size;
 136         uint64_t                log_base;
 137         struct ether_addr       mac;
 138
 139         /* to tell if we need broadcast rarp packet */
 140         rte_atomic16_t          broadcast_rarp;
 141         struct vhost_virtqueue  *virtqueue[VHOST_MAX_QUEUE_PAIRS * 2];
 142 } __rte_cache_aligned;
 143
 144 /**
 145  * Information relating to memory regions including offsets to
 146  * addresses in QEMUs memory file.
 147  */
 148 struct virtio_memory_regions {
 149         uint64_t guest_phys_address;
 150         uint64_t guest_phys_address_end;
 151         uint64_t memory_size;
 152         uint64_t userspace_address;
 153         uint64_t address_offset;
 154 };
 155
 156
 157 /**
 158  * Memory structure includes region and mapping information.
 159  */
 160 struct virtio_memory {
 161         /* Base QEMU userspace address of the memory file. */
 162         uint64_t base_address;
 163         uint64_t mapped_address;
 164         uint64_t mapped_size;
 165         uint32_t nregions;
 166         struct virtio_memory_regions regions[0];
 167 };
 168
 169
 170 /* Macros for printing using RTE_LOG */
 171 #define RTE_LOGTYPE_VHOST_CONFIG RTE_LOGTYPE_USER1
 172 #define RTE_LOGTYPE_VHOST_DATA   RTE_LOGTYPE_USER1
 173
 174 #ifdef RTE_LIBRTE_VHOST_DEBUG
 175 #define VHOST_MAX_PRINT_BUFF 6072
 176 #define LOG_LEVEL RTE_LOG_DEBUG
 177 #define LOG_DEBUG(log_type, fmt, args...) RTE_LOG(DEBUG, log_type, fmt, ##args)
 178 #define PRINT_PACKET(device, addr, size, header) do { \
 179         char *pkt_addr = (char *)(addr); \
 180         unsigned int index; \
 181         char packet[VHOST_MAX_PRINT_BUFF]; \
 182         \
 183         if ((header)) \
 184                 snprintf(packet, VHOST_MAX_PRINT_BUFF, "(%d) Header size %d: ", (device->vid), (size)); \
 185         else \
 186                 snprintf(packet, VHOST_MAX_PRINT_BUFF, "(%d) Packet size %d: ", (device->vid), (size)); \
 187         for (index = 0; index < (size); index++) { \
 188                 snprintf(packet + strnlen(packet, VHOST_MAX_PRINT_BUFF), VHOST_MAX_PRINT_BUFF - strnlen(packet, VHOST_MAX_PRINT_BUFF), \
 189                         "%02hhx ", pkt_addr[index]); \
 190         } \
 191         snprintf(packet + strnlen(packet, VHOST_MAX_PRINT_BUFF), VHOST_MAX_PRINT_BUFF - strnlen(packet, VHOST_MAX_PRINT_BUFF), "\n"); \
 192         \
 193         LOG_DEBUG(VHOST_DATA, "%s", packet); \
 194 } while (0)
 195 #else
 196 #define LOG_LEVEL RTE_LOG_INFO
 197 #define LOG_DEBUG(log_type, fmt, args...) do {} while (0)
 198 #define PRINT_PACKET(device, addr, size, header) do {} while (0)
 199 #endif
 200
 201 /**
 202  * Function to convert guest physical addresses to vhost virtual addresses.
 203  * This is used to convert guest virtio buffer addresses.
 204  */
 205 static inline uint64_t __attribute__((always_inline))
 206 gpa_to_vva(struct virtio_net *dev, uint64_t guest_pa)
 207 {
 208         struct virtio_memory_regions *region;
 209         uint32_t regionidx;
 210         uint64_t vhost_va = 0;
 211
 212         for (regionidx = 0; regionidx < dev->mem->nregions; regionidx++) {
 213                 region = &dev->mem->regions[regionidx];
 214                 if ((guest_pa >= region->guest_phys_address) &&
 215                         (guest_pa <= region->guest_phys_address_end)) {
 216                         vhost_va = region->address_offset + guest_pa;
 217                         break;
 218                 }
 219         }
 220         return vhost_va;
 221 }
 222
 223 struct virtio_net_device_ops const *notify_ops;
 224 struct virtio_net *get_device(int vid);
 225
 226 int vhost_new_device(void);
 227 void vhost_destroy_device(int);
 228
 229 void vhost_set_ifname(int, const char *if_name, unsigned int if_len);
 230
 231 int vhost_get_features(int, uint64_t *);
 232 int vhost_set_features(int, uint64_t *);
 233
 234 int vhost_set_vring_num(int, struct vhost_vring_state *);
 235 int vhost_set_vring_addr(int, struct vhost_vring_addr *);
 236 int vhost_set_vring_base(int, struct vhost_vring_state *);
 237 int vhost_get_vring_base(int, uint32_t, struct vhost_vring_state *);
 238
 239 int vhost_set_vring_kick(int, struct vhost_vring_file *);
 240 int vhost_set_vring_call(int, struct vhost_vring_file *);
 241
 242 int vhost_set_backend(int, struct vhost_vring_file *);
 243
 244 int vhost_set_owner(int);
 245 int vhost_reset_owner(int);
 246
 247 /*
 248  * Backend-specific cleanup. Defined by vhost-cuse and vhost-user.
 249  */
 250 void vhost_backend_cleanup(struct virtio_net *dev);
 251
 252 #endif /* _VHOST_NET_CDEV_H_ */