lib/librte_vhost/vhost.h

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(c) 2010-2018 Intel Corporation
   3  */
   4
   5 #ifndef _VHOST_NET_CDEV_H_
   6 #define _VHOST_NET_CDEV_H_
   7 #include <stdint.h>
   8 #include <stdio.h>
   9 #include <stdbool.h>
  10 #include <sys/types.h>
  11 #include <sys/queue.h>
  12 #include <unistd.h>
  13 #include <linux/vhost.h>
  14 #include <linux/virtio_net.h>
  15 #include <sys/socket.h>
  16 #include <linux/if.h>
  17
  18 #include <rte_log.h>
  19 #include <rte_ether.h>
  20 #include <rte_rwlock.h>
  21
  22 #include "rte_vhost.h"
  23 #include "rte_vdpa.h"
  24
  25 /* Used to indicate that the device is running on a data core */
  26 #define VIRTIO_DEV_RUNNING 1
  27 /* Used to indicate that the device is ready to operate */
  28 #define VIRTIO_DEV_READY 2
  29 /* Used to indicate that the built-in vhost net device backend is enabled */
  30 #define VIRTIO_DEV_BUILTIN_VIRTIO_NET 4
  31 /* Used to indicate that the device has its own data path and configured */
  32 #define VIRTIO_DEV_VDPA_CONFIGURED 8
  33
  34 /* Backend value set by guest. */
  35 #define VIRTIO_DEV_STOPPED -1
  36
  37 #define BUF_VECTOR_MAX 256
  38
  39 /**
  40  * Structure contains buffer address, length and descriptor index
  41  * from vring to do scatter RX.
  42  */
  43 struct buf_vector {
  44         uint64_t buf_addr;
  45         uint32_t buf_len;
  46         uint32_t desc_idx;
  47 };
  48
  49 /*
  50  * A structure to hold some fields needed in zero copy code path,
  51  * mainly for associating an mbuf with the right desc_idx.
  52  */
  53 struct zcopy_mbuf {
  54         struct rte_mbuf *mbuf;
  55         uint32_t desc_idx;
  56         uint16_t in_use;
  57
  58         TAILQ_ENTRY(zcopy_mbuf) next;
  59 };
  60 TAILQ_HEAD(zcopy_mbuf_list, zcopy_mbuf);
  61
  62 /*
  63  * Structure contains the info for each batched memory copy.
  64  */
  65 struct batch_copy_elem {
  66         void *dst;
  67         void *src;
  68         uint32_t len;
  69         uint64_t log_addr;
  70 };
  71
  72 /**
  73  * Structure contains variables relevant to RX/TX virtqueues.
  74  */
  75 struct vhost_virtqueue {
  76         struct vring_desc       *desc;
  77         struct vring_avail      *avail;
  78         struct vring_used       *used;
  79         uint32_t                size;
  80
  81         uint16_t                last_avail_idx;
  82         uint16_t                last_used_idx;
  83         /* Last used index we notify to front end. */
  84         uint16_t                signalled_used;
  85 #define VIRTIO_INVALID_EVENTFD          (-1)
  86 #define VIRTIO_UNINITIALIZED_EVENTFD    (-2)
  87
  88         /* Backend value to determine if device should started/stopped */
  89         int                     backend;
  90         int                     enabled;
  91         int                     access_ok;
  92         rte_spinlock_t          access_lock;
  93
  94         /* Used to notify the guest (trigger interrupt) */
  95         int                     callfd;
  96         /* Currently unused as polling mode is enabled */
  97         int                     kickfd;
  98
  99         /* Physical address of used ring, for logging */
 100         uint64_t                log_guest_addr;
 101
 102         uint16_t                nr_zmbuf;
 103         uint16_t                zmbuf_size;
 104         uint16_t                last_zmbuf_idx;
 105         struct zcopy_mbuf       *zmbufs;
 106         struct zcopy_mbuf_list  zmbuf_list;
 107
 108         struct vring_used_elem  *shadow_used_ring;
 109         uint16_t                shadow_used_idx;
 110         struct vhost_vring_addr ring_addrs;
 111
 112         struct batch_copy_elem  *batch_copy_elems;
 113         uint16_t                batch_copy_nb_elems;
 114
 115         rte_rwlock_t    iotlb_lock;
 116         rte_rwlock_t    iotlb_pending_lock;
 117         struct rte_mempool *iotlb_pool;
 118         TAILQ_HEAD(, vhost_iotlb_entry) iotlb_list;
 119         int                             iotlb_cache_nr;
 120         TAILQ_HEAD(, vhost_iotlb_entry) iotlb_pending_list;
 121 } __rte_cache_aligned;
 122
 123 /* Old kernels have no such macros defined */
 124 #ifndef VIRTIO_NET_F_GUEST_ANNOUNCE
 125  #define VIRTIO_NET_F_GUEST_ANNOUNCE 21
 126 #endif
 127
 128 #ifndef VIRTIO_NET_F_MQ
 129  #define VIRTIO_NET_F_MQ                22
 130 #endif
 131
 132 #define VHOST_MAX_VRING                 0x100
 133 #define VHOST_MAX_QUEUE_PAIRS           0x80
 134
 135 #ifndef VIRTIO_NET_F_MTU
 136  #define VIRTIO_NET_F_MTU 3
 137 #endif
 138
 139 #ifndef VIRTIO_F_ANY_LAYOUT
 140  #define VIRTIO_F_ANY_LAYOUT            27
 141 #endif
 142
 143 /* Declare IOMMU related bits for older kernels */
 144 #ifndef VIRTIO_F_IOMMU_PLATFORM
 145
 146 #define VIRTIO_F_IOMMU_PLATFORM 33
 147
 148 struct vhost_iotlb_msg {
 149         __u64 iova;
 150         __u64 size;
 151         __u64 uaddr;
 152 #define VHOST_ACCESS_RO      0x1
 153 #define VHOST_ACCESS_WO      0x2
 154 #define VHOST_ACCESS_RW      0x3
 155         __u8 perm;
 156 #define VHOST_IOTLB_MISS           1
 157 #define VHOST_IOTLB_UPDATE         2
 158 #define VHOST_IOTLB_INVALIDATE     3
 159 #define VHOST_IOTLB_ACCESS_FAIL    4
 160         __u8 type;
 161 };
 162
 163 #define VHOST_IOTLB_MSG 0x1
 164
 165 struct vhost_msg {
 166         int type;
 167         union {
 168                 struct vhost_iotlb_msg iotlb;
 169                 __u8 padding[64];
 170         };
 171 };
 172 #endif
 173
 174 /*
 175  * Define virtio 1.0 for older kernels
 176  */
 177 #ifndef VIRTIO_F_VERSION_1
 178  #define VIRTIO_F_VERSION_1 32
 179 #endif
 180
 181 /* Features supported by this builtin vhost-user net driver. */
 182 #define VIRTIO_NET_SUPPORTED_FEATURES ((1ULL << VIRTIO_NET_F_MRG_RXBUF) | \
 183                                 (1ULL << VIRTIO_F_ANY_LAYOUT) | \
 184                                 (1ULL << VIRTIO_NET_F_CTRL_VQ) | \
 185                                 (1ULL << VIRTIO_NET_F_CTRL_RX) | \
 186                                 (1ULL << VIRTIO_NET_F_GUEST_ANNOUNCE) | \
 187                                 (1ULL << VIRTIO_NET_F_MQ)      | \
 188                                 (1ULL << VIRTIO_F_VERSION_1)   | \
 189                                 (1ULL << VHOST_F_LOG_ALL)      | \
 190                                 (1ULL << VHOST_USER_F_PROTOCOL_FEATURES) | \
 191                                 (1ULL << VIRTIO_NET_F_GSO) | \
 192                                 (1ULL << VIRTIO_NET_F_HOST_TSO4) | \
 193                                 (1ULL << VIRTIO_NET_F_HOST_TSO6) | \
 194                                 (1ULL << VIRTIO_NET_F_HOST_UFO) | \
 195                                 (1ULL << VIRTIO_NET_F_HOST_ECN) | \
 196                                 (1ULL << VIRTIO_NET_F_CSUM)    | \
 197                                 (1ULL << VIRTIO_NET_F_GUEST_CSUM) | \
 198                                 (1ULL << VIRTIO_NET_F_GUEST_TSO4) | \
 199                                 (1ULL << VIRTIO_NET_F_GUEST_TSO6) | \
 200                                 (1ULL << VIRTIO_NET_F_GUEST_UFO) | \
 201                                 (1ULL << VIRTIO_NET_F_GUEST_ECN) | \
 202                                 (1ULL << VIRTIO_RING_F_INDIRECT_DESC) | \
 203                                 (1ULL << VIRTIO_RING_F_EVENT_IDX) | \
 204                                 (1ULL << VIRTIO_NET_F_MTU) | \
 205                                 (1ULL << VIRTIO_F_IOMMU_PLATFORM))
 206
 207
 208 struct guest_page {
 209         uint64_t guest_phys_addr;
 210         uint64_t host_phys_addr;
 211         uint64_t size;
 212 };
 213
 214 /**
 215  * function prototype for the vhost backend to handler specific vhost user
 216  * messages prior to the master message handling
 217  *
 218  * @param vid
 219  *  vhost device id
 220  * @param msg
 221  *  Message pointer.
 222  * @param require_reply
 223  *  If the handler requires sending a reply, this varaible shall be written 1,
 224  *  otherwise 0.
 225  * @param skip_master
 226  *  If the handler requires skipping the master message handling, this variable
 227  *  shall be written 1, otherwise 0.
 228  * @return
 229  *  0 on success, -1 on failure
 230  */
 231 typedef int (*vhost_msg_pre_handle)(int vid, void *msg,
 232                 uint32_t *require_reply, uint32_t *skip_master);
 233
 234 /**
 235  * function prototype for the vhost backend to handler specific vhost user
 236  * messages after the master message handling is done
 237  *
 238  * @param vid
 239  *  vhost device id
 240  * @param msg
 241  *  Message pointer.
 242  * @param require_reply
 243  *  If the handler requires sending a reply, this varaible shall be written 1,
 244  *  otherwise 0.
 245  * @return
 246  *  0 on success, -1 on failure
 247  */
 248 typedef int (*vhost_msg_post_handle)(int vid, void *msg,
 249                 uint32_t *require_reply);
 250
 251 /**
 252  * pre and post vhost user message handlers
 253  */
 254 struct vhost_user_extern_ops {
 255         vhost_msg_pre_handle pre_msg_handle;
 256         vhost_msg_post_handle post_msg_handle;
 257 };
 258
 259 /**
 260  * Device structure contains all configuration information relating
 261  * to the device.
 262  */
 263 struct virtio_net {
 264         /* Frontend (QEMU) memory and memory region information */
 265         struct rte_vhost_memory *mem;
 266         uint64_t                features;
 267         uint64_t                protocol_features;
 268         int                     vid;
 269         uint32_t                flags;
 270         uint16_t                vhost_hlen;
 271         /* to tell if we need broadcast rarp packet */
 272         rte_atomic16_t          broadcast_rarp;
 273         uint32_t                nr_vring;
 274         int                     dequeue_zero_copy;
 275         struct vhost_virtqueue  *virtqueue[VHOST_MAX_QUEUE_PAIRS * 2];
 276 #define IF_NAME_SZ (PATH_MAX > IFNAMSIZ ? PATH_MAX : IFNAMSIZ)
 277         char                    ifname[IF_NAME_SZ];
 278         uint64_t                log_size;
 279         uint64_t                log_base;
 280         uint64_t                log_addr;
 281         struct ether_addr       mac;
 282         uint16_t                mtu;
 283
 284         struct vhost_device_ops const *notify_ops;
 285
 286         uint32_t                nr_guest_pages;
 287         uint32_t                max_guest_pages;
 288         struct guest_page       *guest_pages;
 289
 290         int                     slave_req_fd;
 291
 292         /*
 293          * Device id to identify a specific backend device.
 294          * It's set to -1 for the default software implementation.
 295          */
 296         int                     vdpa_dev_id;
 297
 298         /* private data for virtio device */
 299         void                    *extern_data;
 300         /* pre and post vhost user message handlers for the device */
 301         struct vhost_user_extern_ops extern_ops;
 302 } __rte_cache_aligned;
 303
 304 #define VHOST_LOG_PAGE  4096
 305
 306 /*
 307  * Mark all pages belonging to the same dirty log bitmap byte
 308  * as dirty. The goal is to avoid concurrency between different
 309  * threads doing atomic read-modify-writes on the same byte.
 310  */
 311 static __rte_always_inline void
 312 vhost_log_page(uint8_t *log_base, uint64_t page)
 313 {
 314         log_base[page / 8] = 0xff;
 315 }
 316
 317 static __rte_always_inline void
 318 vhost_log_write(struct virtio_net *dev, uint64_t addr, uint64_t len)
 319 {
 320         uint64_t page;
 321
 322         if (likely(((dev->features & (1ULL << VHOST_F_LOG_ALL)) == 0) ||
 323                    !dev->log_base || !len))
 324                 return;
 325
 326         if (unlikely(dev->log_size <= ((addr + len - 1) / VHOST_LOG_PAGE / 8)))
 327                 return;
 328
 329         /* To make sure guest memory updates are committed before logging */
 330         rte_smp_wmb();
 331
 332         page = addr / VHOST_LOG_PAGE;
 333         while (page * VHOST_LOG_PAGE < addr + len) {
 334                 vhost_log_page((uint8_t *)(uintptr_t)dev->log_base, page);
 335                 page += 1;
 336         }
 337 }
 338
 339 static __rte_always_inline void
 340 vhost_log_used_vring(struct virtio_net *dev, struct vhost_virtqueue *vq,
 341                      uint64_t offset, uint64_t len)
 342 {
 343         vhost_log_write(dev, vq->log_guest_addr + offset, len);
 344 }
 345
 346 /* Macros for printing using RTE_LOG */
 347 #define RTE_LOGTYPE_VHOST_CONFIG RTE_LOGTYPE_USER1
 348 #define RTE_LOGTYPE_VHOST_DATA   RTE_LOGTYPE_USER1
 349
 350 #ifdef RTE_LIBRTE_VHOST_DEBUG
 351 #define VHOST_MAX_PRINT_BUFF 6072
 352 #define VHOST_LOG_DEBUG(log_type, fmt, args...) \
 353         RTE_LOG(DEBUG, log_type, fmt, ##args)
 354 #define PRINT_PACKET(device, addr, size, header) do { \
 355         char *pkt_addr = (char *)(addr); \
 356         unsigned int index; \
 357         char packet[VHOST_MAX_PRINT_BUFF]; \
 358         \
 359         if ((header)) \
 360                 snprintf(packet, VHOST_MAX_PRINT_BUFF, "(%d) Header size %d: ", (device->vid), (size)); \
 361         else \
 362                 snprintf(packet, VHOST_MAX_PRINT_BUFF, "(%d) Packet size %d: ", (device->vid), (size)); \
 363         for (index = 0; index < (size); index++) { \
 364                 snprintf(packet + strnlen(packet, VHOST_MAX_PRINT_BUFF), VHOST_MAX_PRINT_BUFF - strnlen(packet, VHOST_MAX_PRINT_BUFF), \
 365                         "%02hhx ", pkt_addr[index]); \
 366         } \
 367         snprintf(packet + strnlen(packet, VHOST_MAX_PRINT_BUFF), VHOST_MAX_PRINT_BUFF - strnlen(packet, VHOST_MAX_PRINT_BUFF), "\n"); \
 368         \
 369         VHOST_LOG_DEBUG(VHOST_DATA, "%s", packet); \
 370 } while (0)
 371 #else
 372 #define VHOST_LOG_DEBUG(log_type, fmt, args...) do {} while (0)
 373 #define PRINT_PACKET(device, addr, size, header) do {} while (0)
 374 #endif
 375
 376 extern uint64_t VHOST_FEATURES;
 377 #define MAX_VHOST_DEVICE        1024
 378 extern struct virtio_net *vhost_devices[MAX_VHOST_DEVICE];
 379
 380 /* Convert guest physical address to host physical address */
 381 static __rte_always_inline rte_iova_t
 382 gpa_to_hpa(struct virtio_net *dev, uint64_t gpa, uint64_t size)
 383 {
 384         uint32_t i;
 385         struct guest_page *page;
 386
 387         for (i = 0; i < dev->nr_guest_pages; i++) {
 388                 page = &dev->guest_pages[i];
 389
 390                 if (gpa >= page->guest_phys_addr &&
 391                     gpa + size < page->guest_phys_addr + page->size) {
 392                         return gpa - page->guest_phys_addr +
 393                                page->host_phys_addr;
 394                 }
 395         }
 396
 397         return 0;
 398 }
 399
 400 static __rte_always_inline struct virtio_net *
 401 get_device(int vid)
 402 {
 403         struct virtio_net *dev = vhost_devices[vid];
 404
 405         if (unlikely(!dev)) {
 406                 RTE_LOG(ERR, VHOST_CONFIG,
 407                         "(%d) device not found.\n", vid);
 408         }
 409
 410         return dev;
 411 }
 412
 413 int vhost_new_device(void);
 414 void cleanup_device(struct virtio_net *dev, int destroy);
 415 void reset_device(struct virtio_net *dev);
 416 void vhost_destroy_device(int);
 417
 418 void cleanup_vq(struct vhost_virtqueue *vq, int destroy);
 419 void free_vq(struct vhost_virtqueue *vq);
 420
 421 int alloc_vring_queue(struct virtio_net *dev, uint32_t vring_idx);
 422
 423 void vhost_attach_vdpa_device(int vid, int did);
 424 void vhost_detach_vdpa_device(int vid);
 425
 426 void vhost_set_ifname(int, const char *if_name, unsigned int if_len);
 427 void vhost_enable_dequeue_zero_copy(int vid);
 428 void vhost_set_builtin_virtio_net(int vid, bool enable);
 429
 430 struct vhost_device_ops const *vhost_driver_callback_get(const char *path);
 431
 432 /*
 433  * Backend-specific cleanup.
 434  *
 435  * TODO: fix it; we have one backend now
 436  */
 437 void vhost_backend_cleanup(struct virtio_net *dev);
 438
 439 uint64_t __vhost_iova_to_vva(struct virtio_net *dev, struct vhost_virtqueue *vq,
 440                         uint64_t iova, uint64_t *len, uint8_t perm);
 441 int vring_translate(struct virtio_net *dev, struct vhost_virtqueue *vq);
 442 void vring_invalidate(struct virtio_net *dev, struct vhost_virtqueue *vq);
 443
 444 static __rte_always_inline uint64_t
 445 vhost_iova_to_vva(struct virtio_net *dev, struct vhost_virtqueue *vq,
 446                         uint64_t iova, uint64_t *len, uint8_t perm)
 447 {
 448         if (!(dev->features & (1ULL << VIRTIO_F_IOMMU_PLATFORM)))
 449                 return rte_vhost_va_from_guest_pa(dev->mem, iova, len);
 450
 451         return __vhost_iova_to_vva(dev, vq, iova, len, perm);
 452 }
 453
 454 #define vhost_used_event(vr) \
 455         (*(volatile uint16_t*)&(vr)->avail->ring[(vr)->size])
 456
 457 /*
 458  * The following is used with VIRTIO_RING_F_EVENT_IDX.
 459  * Assuming a given event_idx value from the other size, if we have
 460  * just incremented index from old to new_idx, should we trigger an
 461  * event?
 462  */
 463 static __rte_always_inline int
 464 vhost_need_event(uint16_t event_idx, uint16_t new_idx, uint16_t old)
 465 {
 466         return (uint16_t)(new_idx - event_idx - 1) < (uint16_t)(new_idx - old);
 467 }
 468
 469 static __rte_always_inline void
 470 vhost_vring_call(struct virtio_net *dev, struct vhost_virtqueue *vq)
 471 {
 472         /* Flush used->idx update before we read avail->flags. */
 473         rte_mb();
 474
 475         /* Don't kick guest if we don't reach index specified by guest. */
 476         if (dev->features & (1ULL << VIRTIO_RING_F_EVENT_IDX)) {
 477                 uint16_t old = vq->signalled_used;
 478                 uint16_t new = vq->last_used_idx;
 479
 480                 VHOST_LOG_DEBUG(VHOST_DATA, "%s: used_event_idx=%d, old=%d, new=%d\n",
 481                         __func__,
 482                         vhost_used_event(vq),
 483                         old, new);
 484                 if (vhost_need_event(vhost_used_event(vq), new, old)
 485                         && (vq->callfd >= 0)) {
 486                         vq->signalled_used = vq->last_used_idx;
 487                         eventfd_write(vq->callfd, (eventfd_t) 1);
 488                 }
 489         } else {
 490                 /* Kick the guest if necessary. */
 491                 if (!(vq->avail->flags & VRING_AVAIL_F_NO_INTERRUPT)
 492                                 && (vq->callfd >= 0))
 493                         eventfd_write(vq->callfd, (eventfd_t)1);
 494         }
 495 }
 496
 497 #endif /* _VHOST_NET_CDEV_H_ */