lib/librte_vhost/vhost.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 <sys/queue.h>
  40 #include <unistd.h>
  41 #include <linux/vhost.h>
  42 #include <linux/virtio_net.h>
  43 #include <sys/socket.h>
  44 #include <linux/if.h>
  45
  46 #include <rte_log.h>
  47 #include <rte_ether.h>
  48
  49 #include "rte_vhost.h"
  50
  51 /* Used to indicate that the device is running on a data core */
  52 #define VIRTIO_DEV_RUNNING 1
  53 /* Used to indicate that the device is ready to operate */
  54 #define VIRTIO_DEV_READY 2
  55
  56 /* Backend value set by guest. */
  57 #define VIRTIO_DEV_STOPPED -1
  58
  59 #define BUF_VECTOR_MAX 256
  60
  61 /**
  62  * Structure contains buffer address, length and descriptor index
  63  * from vring to do scatter RX.
  64  */
  65 struct buf_vector {
  66         uint64_t buf_addr;
  67         uint32_t buf_len;
  68         uint32_t desc_idx;
  69 };
  70
  71 /*
  72  * A structure to hold some fields needed in zero copy code path,
  73  * mainly for associating an mbuf with the right desc_idx.
  74  */
  75 struct zcopy_mbuf {
  76         struct rte_mbuf *mbuf;
  77         uint32_t desc_idx;
  78         uint16_t in_use;
  79
  80         TAILQ_ENTRY(zcopy_mbuf) next;
  81 };
  82 TAILQ_HEAD(zcopy_mbuf_list, zcopy_mbuf);
  83
  84 /*
  85  * Structure contains the info for each batched memory copy.
  86  */
  87 struct batch_copy_elem {
  88         void *dst;
  89         void *src;
  90         uint32_t len;
  91         uint64_t log_addr;
  92 };
  93
  94 /**
  95  * Structure contains variables relevant to RX/TX virtqueues.
  96  */
  97 struct vhost_virtqueue {
  98         struct vring_desc       *desc;
  99         struct vring_avail      *avail;
 100         struct vring_used       *used;
 101         uint32_t                size;
 102
 103         uint16_t                last_avail_idx;
 104         uint16_t                last_used_idx;
 105 #define VIRTIO_INVALID_EVENTFD          (-1)
 106 #define VIRTIO_UNINITIALIZED_EVENTFD    (-2)
 107
 108         /* Backend value to determine if device should started/stopped */
 109         int                     backend;
 110         /* Used to notify the guest (trigger interrupt) */
 111         int                     callfd;
 112         /* Currently unused as polling mode is enabled */
 113         int                     kickfd;
 114         int                     enabled;
 115
 116         /* Physical address of used ring, for logging */
 117         uint64_t                log_guest_addr;
 118
 119         uint16_t                nr_zmbuf;
 120         uint16_t                zmbuf_size;
 121         uint16_t                last_zmbuf_idx;
 122         struct zcopy_mbuf       *zmbufs;
 123         struct zcopy_mbuf_list  zmbuf_list;
 124
 125         struct vring_used_elem  *shadow_used_ring;
 126         uint16_t                shadow_used_idx;
 127
 128         struct batch_copy_elem  *batch_copy_elems;
 129         uint16_t                batch_copy_nb_elems;
 130 } __rte_cache_aligned;
 131
 132 /* Old kernels have no such macros defined */
 133 #ifndef VIRTIO_NET_F_GUEST_ANNOUNCE
 134  #define VIRTIO_NET_F_GUEST_ANNOUNCE 21
 135 #endif
 136
 137 #ifndef VIRTIO_NET_F_MQ
 138  #define VIRTIO_NET_F_MQ                22
 139 #endif
 140
 141 #define VHOST_MAX_VRING                 0x100
 142 #define VHOST_MAX_QUEUE_PAIRS           0x80
 143
 144 #ifndef VIRTIO_NET_F_MTU
 145  #define VIRTIO_NET_F_MTU 3
 146 #endif
 147
 148 /*
 149  * Define virtio 1.0 for older kernels
 150  */
 151 #ifndef VIRTIO_F_VERSION_1
 152  #define VIRTIO_F_VERSION_1 32
 153 #endif
 154
 155 #define VHOST_USER_F_PROTOCOL_FEATURES  30
 156
 157 /* Features supported by this builtin vhost-user net driver. */
 158 #define VIRTIO_NET_SUPPORTED_FEATURES ((1ULL << VIRTIO_NET_F_MRG_RXBUF) | \
 159                                 (1ULL << VIRTIO_NET_F_CTRL_VQ) | \
 160                                 (1ULL << VIRTIO_NET_F_CTRL_RX) | \
 161                                 (1ULL << VIRTIO_NET_F_GUEST_ANNOUNCE) | \
 162                                 (1ULL << VIRTIO_NET_F_MQ)      | \
 163                                 (1ULL << VIRTIO_F_VERSION_1)   | \
 164                                 (1ULL << VHOST_F_LOG_ALL)      | \
 165                                 (1ULL << VHOST_USER_F_PROTOCOL_FEATURES) | \
 166                                 (1ULL << VIRTIO_NET_F_HOST_TSO4) | \
 167                                 (1ULL << VIRTIO_NET_F_HOST_TSO6) | \
 168                                 (1ULL << VIRTIO_NET_F_CSUM)    | \
 169                                 (1ULL << VIRTIO_NET_F_GUEST_CSUM) | \
 170                                 (1ULL << VIRTIO_NET_F_GUEST_TSO4) | \
 171                                 (1ULL << VIRTIO_NET_F_GUEST_TSO6) | \
 172                                 (1ULL << VIRTIO_RING_F_INDIRECT_DESC) | \
 173                                 (1ULL << VIRTIO_NET_F_MTU))
 174
 175
 176 struct guest_page {
 177         uint64_t guest_phys_addr;
 178         uint64_t host_phys_addr;
 179         uint64_t size;
 180 };
 181
 182 /**
 183  * Device structure contains all configuration information relating
 184  * to the device.
 185  */
 186 struct virtio_net {
 187         /* Frontend (QEMU) memory and memory region information */
 188         struct rte_vhost_memory *mem;
 189         uint64_t                features;
 190         uint64_t                protocol_features;
 191         int                     vid;
 192         uint32_t                flags;
 193         uint16_t                vhost_hlen;
 194         /* to tell if we need broadcast rarp packet */
 195         rte_atomic16_t          broadcast_rarp;
 196         uint32_t                nr_vring;
 197         int                     dequeue_zero_copy;
 198         struct vhost_virtqueue  *virtqueue[VHOST_MAX_QUEUE_PAIRS * 2];
 199 #define IF_NAME_SZ (PATH_MAX > IFNAMSIZ ? PATH_MAX : IFNAMSIZ)
 200         char                    ifname[IF_NAME_SZ];
 201         uint64_t                log_size;
 202         uint64_t                log_base;
 203         uint64_t                log_addr;
 204         struct ether_addr       mac;
 205         uint16_t                mtu;
 206
 207         struct vhost_device_ops const *notify_ops;
 208
 209         uint32_t                nr_guest_pages;
 210         uint32_t                max_guest_pages;
 211         struct guest_page       *guest_pages;
 212
 213         int                     slave_req_fd;
 214 } __rte_cache_aligned;
 215
 216
 217 #define VHOST_LOG_PAGE  4096
 218
 219 /*
 220  * Atomically set a bit in memory.
 221  */
 222 static __rte_always_inline void
 223 vhost_set_bit(unsigned int nr, volatile uint8_t *addr)
 224 {
 225         __sync_fetch_and_or_8(addr, (1U << nr));
 226 }
 227
 228 static __rte_always_inline void
 229 vhost_log_page(uint8_t *log_base, uint64_t page)
 230 {
 231         vhost_set_bit(page % 8, &log_base[page / 8]);
 232 }
 233
 234 static __rte_always_inline void
 235 vhost_log_write(struct virtio_net *dev, uint64_t addr, uint64_t len)
 236 {
 237         uint64_t page;
 238
 239         if (likely(((dev->features & (1ULL << VHOST_F_LOG_ALL)) == 0) ||
 240                    !dev->log_base || !len))
 241                 return;
 242
 243         if (unlikely(dev->log_size <= ((addr + len - 1) / VHOST_LOG_PAGE / 8)))
 244                 return;
 245
 246         /* To make sure guest memory updates are committed before logging */
 247         rte_smp_wmb();
 248
 249         page = addr / VHOST_LOG_PAGE;
 250         while (page * VHOST_LOG_PAGE < addr + len) {
 251                 vhost_log_page((uint8_t *)(uintptr_t)dev->log_base, page);
 252                 page += 1;
 253         }
 254 }
 255
 256 static __rte_always_inline void
 257 vhost_log_used_vring(struct virtio_net *dev, struct vhost_virtqueue *vq,
 258                      uint64_t offset, uint64_t len)
 259 {
 260         vhost_log_write(dev, vq->log_guest_addr + offset, len);
 261 }
 262
 263 /* Macros for printing using RTE_LOG */
 264 #define RTE_LOGTYPE_VHOST_CONFIG RTE_LOGTYPE_USER1
 265 #define RTE_LOGTYPE_VHOST_DATA   RTE_LOGTYPE_USER1
 266
 267 #ifdef RTE_LIBRTE_VHOST_DEBUG
 268 #define VHOST_MAX_PRINT_BUFF 6072
 269 #define LOG_LEVEL RTE_LOG_DEBUG
 270 #define LOG_DEBUG(log_type, fmt, args...) RTE_LOG(DEBUG, log_type, fmt, ##args)
 271 #define PRINT_PACKET(device, addr, size, header) do { \
 272         char *pkt_addr = (char *)(addr); \
 273         unsigned int index; \
 274         char packet[VHOST_MAX_PRINT_BUFF]; \
 275         \
 276         if ((header)) \
 277                 snprintf(packet, VHOST_MAX_PRINT_BUFF, "(%d) Header size %d: ", (device->vid), (size)); \
 278         else \
 279                 snprintf(packet, VHOST_MAX_PRINT_BUFF, "(%d) Packet size %d: ", (device->vid), (size)); \
 280         for (index = 0; index < (size); index++) { \
 281                 snprintf(packet + strnlen(packet, VHOST_MAX_PRINT_BUFF), VHOST_MAX_PRINT_BUFF - strnlen(packet, VHOST_MAX_PRINT_BUFF), \
 282                         "%02hhx ", pkt_addr[index]); \
 283         } \
 284         snprintf(packet + strnlen(packet, VHOST_MAX_PRINT_BUFF), VHOST_MAX_PRINT_BUFF - strnlen(packet, VHOST_MAX_PRINT_BUFF), "\n"); \
 285         \
 286         LOG_DEBUG(VHOST_DATA, "%s", packet); \
 287 } while (0)
 288 #else
 289 #define LOG_LEVEL RTE_LOG_INFO
 290 #define LOG_DEBUG(log_type, fmt, args...) do {} while (0)
 291 #define PRINT_PACKET(device, addr, size, header) do {} while (0)
 292 #endif
 293
 294 extern uint64_t VHOST_FEATURES;
 295 #define MAX_VHOST_DEVICE        1024
 296 extern struct virtio_net *vhost_devices[MAX_VHOST_DEVICE];
 297
 298 /* Convert guest physical address to host physical address */
 299 static __rte_always_inline phys_addr_t
 300 gpa_to_hpa(struct virtio_net *dev, uint64_t gpa, uint64_t size)
 301 {
 302         uint32_t i;
 303         struct guest_page *page;
 304
 305         for (i = 0; i < dev->nr_guest_pages; i++) {
 306                 page = &dev->guest_pages[i];
 307
 308                 if (gpa >= page->guest_phys_addr &&
 309                     gpa + size < page->guest_phys_addr + page->size) {
 310                         return gpa - page->guest_phys_addr +
 311                                page->host_phys_addr;
 312                 }
 313         }
 314
 315         return 0;
 316 }
 317
 318 struct virtio_net *get_device(int vid);
 319
 320 int vhost_new_device(void);
 321 void cleanup_device(struct virtio_net *dev, int destroy);
 322 void reset_device(struct virtio_net *dev);
 323 void vhost_destroy_device(int);
 324
 325 int alloc_vring_queue(struct virtio_net *dev, uint32_t vring_idx);
 326
 327 void vhost_set_ifname(int, const char *if_name, unsigned int if_len);
 328 void vhost_enable_dequeue_zero_copy(int vid);
 329
 330 struct vhost_device_ops const *vhost_driver_callback_get(const char *path);
 331
 332 /*
 333  * Backend-specific cleanup.
 334  *
 335  * TODO: fix it; we have one backend now
 336  */
 337 void vhost_backend_cleanup(struct virtio_net *dev);
 338
 339 #endif /* _VHOST_NET_CDEV_H_ */