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