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 #define VHOST_LOG_CACHE_NR 32
  40
  41 /**
  42  * Structure contains buffer address, length and descriptor index
  43  * from vring to do scatter RX.
  44  */
  45 struct buf_vector {
  46         uint64_t buf_iova;
  47         uint64_t buf_addr;
  48         uint32_t buf_len;
  49         uint32_t desc_idx;
  50 };
  51
  52 /*
  53  * A structure to hold some fields needed in zero copy code path,
  54  * mainly for associating an mbuf with the right desc_idx.
  55  */
  56 struct zcopy_mbuf {
  57         struct rte_mbuf *mbuf;
  58         uint32_t desc_idx;
  59         uint16_t desc_count;
  60         uint16_t in_use;
  61
  62         TAILQ_ENTRY(zcopy_mbuf) next;
  63 };
  64 TAILQ_HEAD(zcopy_mbuf_list, zcopy_mbuf);
  65
  66 /*
  67  * Structure contains the info for each batched memory copy.
  68  */
  69 struct batch_copy_elem {
  70         void *dst;
  71         void *src;
  72         uint32_t len;
  73         uint64_t log_addr;
  74 };
  75
  76 /*
  77  * Structure that contains the info for batched dirty logging.
  78  */
  79 struct log_cache_entry {
  80         uint32_t offset;
  81         unsigned long val;
  82 };
  83
  84 struct vring_used_elem_packed {
  85         uint16_t id;
  86         uint32_t len;
  87         uint32_t count;
  88 };
  89
  90 /**
  91  * Structure contains variables relevant to RX/TX virtqueues.
  92  */
  93 struct vhost_virtqueue {
  94         union {
  95                 struct vring_desc       *desc;
  96                 struct vring_packed_desc   *desc_packed;
  97         };
  98         union {
  99                 struct vring_avail      *avail;
 100                 struct vring_packed_desc_event *driver_event;
 101         };
 102         union {
 103                 struct vring_used       *used;
 104                 struct vring_packed_desc_event *device_event;
 105         };
 106         uint32_t                size;
 107
 108         uint16_t                last_avail_idx;
 109         uint16_t                last_used_idx;
 110         /* Last used index we notify to front end. */
 111         uint16_t                signalled_used;
 112         bool                    signalled_used_valid;
 113 #define VIRTIO_INVALID_EVENTFD          (-1)
 114 #define VIRTIO_UNINITIALIZED_EVENTFD    (-2)
 115
 116         /* Backend value to determine if device should started/stopped */
 117         int                     backend;
 118         int                     enabled;
 119         int                     access_ok;
 120         rte_spinlock_t          access_lock;
 121
 122         /* Used to notify the guest (trigger interrupt) */
 123         int                     callfd;
 124         /* Currently unused as polling mode is enabled */
 125         int                     kickfd;
 126
 127         /* Physical address of used ring, for logging */
 128         uint64_t                log_guest_addr;
 129
 130         uint16_t                nr_zmbuf;
 131         uint16_t                zmbuf_size;
 132         uint16_t                last_zmbuf_idx;
 133         struct zcopy_mbuf       *zmbufs;
 134         struct zcopy_mbuf_list  zmbuf_list;
 135
 136         union {
 137                 struct vring_used_elem  *shadow_used_split;
 138                 struct vring_used_elem_packed *shadow_used_packed;
 139         };
 140         uint16_t                shadow_used_idx;
 141         struct vhost_vring_addr ring_addrs;
 142
 143         struct batch_copy_elem  *batch_copy_elems;
 144         uint16_t                batch_copy_nb_elems;
 145         bool                    used_wrap_counter;
 146         bool                    avail_wrap_counter;
 147
 148         struct log_cache_entry log_cache[VHOST_LOG_CACHE_NR];
 149         uint16_t log_cache_nb_elem;
 150
 151         rte_rwlock_t    iotlb_lock;
 152         rte_rwlock_t    iotlb_pending_lock;
 153         struct rte_mempool *iotlb_pool;
 154         TAILQ_HEAD(, vhost_iotlb_entry) iotlb_list;
 155         int                             iotlb_cache_nr;
 156         TAILQ_HEAD(, vhost_iotlb_entry) iotlb_pending_list;
 157 } __rte_cache_aligned;
 158
 159 /* Old kernels have no such macros defined */
 160 #ifndef VIRTIO_NET_F_GUEST_ANNOUNCE
 161  #define VIRTIO_NET_F_GUEST_ANNOUNCE 21
 162 #endif
 163
 164 #ifndef VIRTIO_NET_F_MQ
 165  #define VIRTIO_NET_F_MQ                22
 166 #endif
 167
 168 #define VHOST_MAX_VRING                 0x100
 169 #define VHOST_MAX_QUEUE_PAIRS           0x80
 170
 171 #ifndef VIRTIO_NET_F_MTU
 172  #define VIRTIO_NET_F_MTU 3
 173 #endif
 174
 175 #ifndef VIRTIO_F_ANY_LAYOUT
 176  #define VIRTIO_F_ANY_LAYOUT            27
 177 #endif
 178
 179 /* Declare IOMMU related bits for older kernels */
 180 #ifndef VIRTIO_F_IOMMU_PLATFORM
 181
 182 #define VIRTIO_F_IOMMU_PLATFORM 33
 183
 184 struct vhost_iotlb_msg {
 185         __u64 iova;
 186         __u64 size;
 187         __u64 uaddr;
 188 #define VHOST_ACCESS_RO      0x1
 189 #define VHOST_ACCESS_WO      0x2
 190 #define VHOST_ACCESS_RW      0x3
 191         __u8 perm;
 192 #define VHOST_IOTLB_MISS           1
 193 #define VHOST_IOTLB_UPDATE         2
 194 #define VHOST_IOTLB_INVALIDATE     3
 195 #define VHOST_IOTLB_ACCESS_FAIL    4
 196         __u8 type;
 197 };
 198
 199 #define VHOST_IOTLB_MSG 0x1
 200
 201 struct vhost_msg {
 202         int type;
 203         union {
 204                 struct vhost_iotlb_msg iotlb;
 205                 __u8 padding[64];
 206         };
 207 };
 208 #endif
 209
 210 /*
 211  * Define virtio 1.0 for older kernels
 212  */
 213 #ifndef VIRTIO_F_VERSION_1
 214  #define VIRTIO_F_VERSION_1 32
 215 #endif
 216
 217 /* Declare packed ring related bits for older kernels */
 218 #ifndef VIRTIO_F_RING_PACKED
 219
 220 #define VIRTIO_F_RING_PACKED 34
 221
 222 #define VRING_DESC_F_NEXT       1
 223 #define VRING_DESC_F_WRITE      2
 224 #define VRING_DESC_F_INDIRECT   4
 225
 226 #define VRING_DESC_F_AVAIL      (1ULL << 7)
 227 #define VRING_DESC_F_USED       (1ULL << 15)
 228
 229 struct vring_packed_desc {
 230         uint64_t addr;
 231         uint32_t len;
 232         uint16_t id;
 233         uint16_t flags;
 234 };
 235
 236 #define VRING_EVENT_F_ENABLE 0x0
 237 #define VRING_EVENT_F_DISABLE 0x1
 238 #define VRING_EVENT_F_DESC 0x2
 239
 240 struct vring_packed_desc_event {
 241         uint16_t off_wrap;
 242         uint16_t flags;
 243 };
 244 #endif
 245
 246 /*
 247  * Available and used descs are in same order
 248  */
 249 #ifndef VIRTIO_F_IN_ORDER
 250 #define VIRTIO_F_IN_ORDER      35
 251 #endif
 252
 253 /* Features supported by this builtin vhost-user net driver. */
 254 #define VIRTIO_NET_SUPPORTED_FEATURES ((1ULL << VIRTIO_NET_F_MRG_RXBUF) | \
 255                                 (1ULL << VIRTIO_F_ANY_LAYOUT) | \
 256                                 (1ULL << VIRTIO_NET_F_CTRL_VQ) | \
 257                                 (1ULL << VIRTIO_NET_F_CTRL_RX) | \
 258                                 (1ULL << VIRTIO_NET_F_GUEST_ANNOUNCE) | \
 259                                 (1ULL << VIRTIO_NET_F_MQ)      | \
 260                                 (1ULL << VIRTIO_F_VERSION_1)   | \
 261                                 (1ULL << VHOST_F_LOG_ALL)      | \
 262                                 (1ULL << VHOST_USER_F_PROTOCOL_FEATURES) | \
 263                                 (1ULL << VIRTIO_NET_F_GSO) | \
 264                                 (1ULL << VIRTIO_NET_F_HOST_TSO4) | \
 265                                 (1ULL << VIRTIO_NET_F_HOST_TSO6) | \
 266                                 (1ULL << VIRTIO_NET_F_HOST_UFO) | \
 267                                 (1ULL << VIRTIO_NET_F_HOST_ECN) | \
 268                                 (1ULL << VIRTIO_NET_F_CSUM)    | \
 269                                 (1ULL << VIRTIO_NET_F_GUEST_CSUM) | \
 270                                 (1ULL << VIRTIO_NET_F_GUEST_TSO4) | \
 271                                 (1ULL << VIRTIO_NET_F_GUEST_TSO6) | \
 272                                 (1ULL << VIRTIO_NET_F_GUEST_UFO) | \
 273                                 (1ULL << VIRTIO_NET_F_GUEST_ECN) | \
 274                                 (1ULL << VIRTIO_RING_F_INDIRECT_DESC) | \
 275                                 (1ULL << VIRTIO_RING_F_EVENT_IDX) | \
 276                                 (1ULL << VIRTIO_NET_F_MTU)  | \
 277                                 (1ULL << VIRTIO_F_IN_ORDER) | \
 278                                 (1ULL << VIRTIO_F_IOMMU_PLATFORM))
 279
 280
 281 struct guest_page {
 282         uint64_t guest_phys_addr;
 283         uint64_t host_phys_addr;
 284         uint64_t size;
 285 };
 286
 287 /* The possible results of a message handling function */
 288 enum vh_result {
 289         /* Message handling failed */
 290         VH_RESULT_ERR   = -1,
 291         /* Message handling successful */
 292         VH_RESULT_OK    =  0,
 293         /* Message handling successful and reply prepared */
 294         VH_RESULT_REPLY =  1,
 295 };
 296
 297 /**
 298  * function prototype for the vhost backend to handler specific vhost user
 299  * messages prior to the master message handling
 300  *
 301  * @param vid
 302  *  vhost device id
 303  * @param msg
 304  *  Message pointer.
 305  * @param skip_master
 306  *  If the handler requires skipping the master message handling, this variable
 307  *  shall be written 1, otherwise 0.
 308  * @return
 309  *  VH_RESULT_OK on success, VH_RESULT_REPLY on success with reply,
 310  *  VH_RESULT_ERR on failure
 311  */
 312 typedef enum vh_result (*vhost_msg_pre_handle)(int vid, void *msg,
 313                 uint32_t *skip_master);
 314
 315 /**
 316  * function prototype for the vhost backend to handler specific vhost user
 317  * messages after the master message handling is done
 318  *
 319  * @param vid
 320  *  vhost device id
 321  * @param msg
 322  *  Message pointer.
 323  * @return
 324  *  VH_RESULT_OK on success, VH_RESULT_REPLY on success with reply,
 325  *  VH_RESULT_ERR on failure
 326  */
 327 typedef enum vh_result (*vhost_msg_post_handle)(int vid, void *msg);
 328
 329 /**
 330  * pre and post vhost user message handlers
 331  */
 332 struct vhost_user_extern_ops {
 333         vhost_msg_pre_handle pre_msg_handle;
 334         vhost_msg_post_handle post_msg_handle;
 335 };
 336
 337 /**
 338  * Device structure contains all configuration information relating
 339  * to the device.
 340  */
 341 struct virtio_net {
 342         /* Frontend (QEMU) memory and memory region information */
 343         struct rte_vhost_memory *mem;
 344         uint64_t                features;
 345         uint64_t                protocol_features;
 346         int                     vid;
 347         uint32_t                flags;
 348         uint16_t                vhost_hlen;
 349         /* to tell if we need broadcast rarp packet */
 350         rte_atomic16_t          broadcast_rarp;
 351         uint32_t                nr_vring;
 352         int                     dequeue_zero_copy;
 353         struct vhost_virtqueue  *virtqueue[VHOST_MAX_QUEUE_PAIRS * 2];
 354 #define IF_NAME_SZ (PATH_MAX > IFNAMSIZ ? PATH_MAX : IFNAMSIZ)
 355         char                    ifname[IF_NAME_SZ];
 356         uint64_t                log_size;
 357         uint64_t                log_base;
 358         uint64_t                log_addr;
 359         struct ether_addr       mac;
 360         uint16_t                mtu;
 361
 362         struct vhost_device_ops const *notify_ops;
 363
 364         uint32_t                nr_guest_pages;
 365         uint32_t                max_guest_pages;
 366         struct guest_page       *guest_pages;
 367
 368         int                     slave_req_fd;
 369         rte_spinlock_t          slave_req_lock;
 370
 371         int                     postcopy_ufd;
 372         int                     postcopy_listening;
 373
 374         /*
 375          * Device id to identify a specific backend device.
 376          * It's set to -1 for the default software implementation.
 377          */
 378         int                     vdpa_dev_id;
 379
 380         /* private data for virtio device */
 381         void                    *extern_data;
 382         /* pre and post vhost user message handlers for the device */
 383         struct vhost_user_extern_ops extern_ops;
 384 } __rte_cache_aligned;
 385
 386 static __rte_always_inline bool
 387 vq_is_packed(struct virtio_net *dev)
 388 {
 389         return dev->features & (1ull << VIRTIO_F_RING_PACKED);
 390 }
 391
 392 static inline bool
 393 desc_is_avail(struct vring_packed_desc *desc, bool wrap_counter)
 394 {
 395         return wrap_counter == !!(desc->flags & VRING_DESC_F_AVAIL) &&
 396                 wrap_counter != !!(desc->flags & VRING_DESC_F_USED);
 397 }
 398
 399 #define VHOST_LOG_PAGE  4096
 400
 401 /*
 402  * Atomically set a bit in memory.
 403  */
 404 static __rte_always_inline void
 405 vhost_set_bit(unsigned int nr, volatile uint8_t *addr)
 406 {
 407 #if defined(RTE_TOOLCHAIN_GCC) && (GCC_VERSION < 70100)
 408         /*
 409          * __sync_ built-ins are deprecated, but __atomic_ ones
 410          * are sub-optimized in older GCC versions.
 411          */
 412         __sync_fetch_and_or_1(addr, (1U << nr));
 413 #else
 414         __atomic_fetch_or(addr, (1U << nr), __ATOMIC_RELAXED);
 415 #endif
 416 }
 417
 418 static __rte_always_inline void
 419 vhost_log_page(uint8_t *log_base, uint64_t page)
 420 {
 421         vhost_set_bit(page % 8, &log_base[page / 8]);
 422 }
 423
 424 static __rte_always_inline void
 425 vhost_log_write(struct virtio_net *dev, uint64_t addr, uint64_t len)
 426 {
 427         uint64_t page;
 428
 429         if (likely(((dev->features & (1ULL << VHOST_F_LOG_ALL)) == 0) ||
 430                    !dev->log_base || !len))
 431                 return;
 432
 433         if (unlikely(dev->log_size <= ((addr + len - 1) / VHOST_LOG_PAGE / 8)))
 434                 return;
 435
 436         /* To make sure guest memory updates are committed before logging */
 437         rte_smp_wmb();
 438
 439         page = addr / VHOST_LOG_PAGE;
 440         while (page * VHOST_LOG_PAGE < addr + len) {
 441                 vhost_log_page((uint8_t *)(uintptr_t)dev->log_base, page);
 442                 page += 1;
 443         }
 444 }
 445
 446 static __rte_always_inline void
 447 vhost_log_cache_sync(struct virtio_net *dev, struct vhost_virtqueue *vq)
 448 {
 449         unsigned long *log_base;
 450         int i;
 451
 452         if (likely(((dev->features & (1ULL << VHOST_F_LOG_ALL)) == 0) ||
 453                    !dev->log_base))
 454                 return;
 455
 456         log_base = (unsigned long *)(uintptr_t)dev->log_base;
 457
 458         /*
 459          * It is expected a write memory barrier has been issued
 460          * before this function is called.
 461          */
 462
 463         for (i = 0; i < vq->log_cache_nb_elem; i++) {
 464                 struct log_cache_entry *elem = vq->log_cache + i;
 465
 466 #if defined(RTE_TOOLCHAIN_GCC) && (GCC_VERSION < 70100)
 467                 /*
 468                  * '__sync' builtins are deprecated, but '__atomic' ones
 469                  * are sub-optimized in older GCC versions.
 470                  */
 471                 __sync_fetch_and_or(log_base + elem->offset, elem->val);
 472 #else
 473                 __atomic_fetch_or(log_base + elem->offset, elem->val,
 474                                 __ATOMIC_RELAXED);
 475 #endif
 476         }
 477
 478         rte_smp_wmb();
 479
 480         vq->log_cache_nb_elem = 0;
 481 }
 482
 483 static __rte_always_inline void
 484 vhost_log_cache_page(struct virtio_net *dev, struct vhost_virtqueue *vq,
 485                         uint64_t page)
 486 {
 487         uint32_t bit_nr = page % (sizeof(unsigned long) << 3);
 488         uint32_t offset = page / (sizeof(unsigned long) << 3);
 489         int i;
 490
 491         for (i = 0; i < vq->log_cache_nb_elem; i++) {
 492                 struct log_cache_entry *elem = vq->log_cache + i;
 493
 494                 if (elem->offset == offset) {
 495                         elem->val |= (1UL << bit_nr);
 496                         return;
 497                 }
 498         }
 499
 500         if (unlikely(i >= VHOST_LOG_CACHE_NR)) {
 501                 /*
 502                  * No more room for a new log cache entry,
 503                  * so write the dirty log map directly.
 504                  */
 505                 rte_smp_wmb();
 506                 vhost_log_page((uint8_t *)(uintptr_t)dev->log_base, page);
 507
 508                 return;
 509         }
 510
 511         vq->log_cache[i].offset = offset;
 512         vq->log_cache[i].val = (1UL << bit_nr);
 513         vq->log_cache_nb_elem++;
 514 }
 515
 516 static __rte_always_inline void
 517 vhost_log_cache_write(struct virtio_net *dev, struct vhost_virtqueue *vq,
 518                         uint64_t addr, uint64_t len)
 519 {
 520         uint64_t page;
 521
 522         if (likely(((dev->features & (1ULL << VHOST_F_LOG_ALL)) == 0) ||
 523                    !dev->log_base || !len))
 524                 return;
 525
 526         if (unlikely(dev->log_size <= ((addr + len - 1) / VHOST_LOG_PAGE / 8)))
 527                 return;
 528
 529         page = addr / VHOST_LOG_PAGE;
 530         while (page * VHOST_LOG_PAGE < addr + len) {
 531                 vhost_log_cache_page(dev, vq, page);
 532                 page += 1;
 533         }
 534 }
 535
 536 static __rte_always_inline void
 537 vhost_log_cache_used_vring(struct virtio_net *dev, struct vhost_virtqueue *vq,
 538                         uint64_t offset, uint64_t len)
 539 {
 540         vhost_log_cache_write(dev, vq, vq->log_guest_addr + offset, len);
 541 }
 542
 543 static __rte_always_inline void
 544 vhost_log_used_vring(struct virtio_net *dev, struct vhost_virtqueue *vq,
 545                      uint64_t offset, uint64_t len)
 546 {
 547         vhost_log_write(dev, vq->log_guest_addr + offset, len);
 548 }
 549
 550 /* Macros for printing using RTE_LOG */
 551 #define RTE_LOGTYPE_VHOST_CONFIG RTE_LOGTYPE_USER1
 552 #define RTE_LOGTYPE_VHOST_DATA   RTE_LOGTYPE_USER1
 553
 554 #ifdef RTE_LIBRTE_VHOST_DEBUG
 555 #define VHOST_MAX_PRINT_BUFF 6072
 556 #define VHOST_LOG_DEBUG(log_type, fmt, args...) \
 557         RTE_LOG(DEBUG, log_type, fmt, ##args)
 558 #define PRINT_PACKET(device, addr, size, header) do { \
 559         char *pkt_addr = (char *)(addr); \
 560         unsigned int index; \
 561         char packet[VHOST_MAX_PRINT_BUFF]; \
 562         \
 563         if ((header)) \
 564                 snprintf(packet, VHOST_MAX_PRINT_BUFF, "(%d) Header size %d: ", (device->vid), (size)); \
 565         else \
 566                 snprintf(packet, VHOST_MAX_PRINT_BUFF, "(%d) Packet size %d: ", (device->vid), (size)); \
 567         for (index = 0; index < (size); index++) { \
 568                 snprintf(packet + strnlen(packet, VHOST_MAX_PRINT_BUFF), VHOST_MAX_PRINT_BUFF - strnlen(packet, VHOST_MAX_PRINT_BUFF), \
 569                         "%02hhx ", pkt_addr[index]); \
 570         } \
 571         snprintf(packet + strnlen(packet, VHOST_MAX_PRINT_BUFF), VHOST_MAX_PRINT_BUFF - strnlen(packet, VHOST_MAX_PRINT_BUFF), "\n"); \
 572         \
 573         VHOST_LOG_DEBUG(VHOST_DATA, "%s", packet); \
 574 } while (0)
 575 #else
 576 #define VHOST_LOG_DEBUG(log_type, fmt, args...) do {} while (0)
 577 #define PRINT_PACKET(device, addr, size, header) do {} while (0)
 578 #endif
 579
 580 extern uint64_t VHOST_FEATURES;
 581 #define MAX_VHOST_DEVICE        1024
 582 extern struct virtio_net *vhost_devices[MAX_VHOST_DEVICE];
 583
 584 /* Convert guest physical address to host physical address */
 585 static __rte_always_inline rte_iova_t
 586 gpa_to_hpa(struct virtio_net *dev, uint64_t gpa, uint64_t size)
 587 {
 588         uint32_t i;
 589         struct guest_page *page;
 590
 591         for (i = 0; i < dev->nr_guest_pages; i++) {
 592                 page = &dev->guest_pages[i];
 593
 594                 if (gpa >= page->guest_phys_addr &&
 595                     gpa + size < page->guest_phys_addr + page->size) {
 596                         return gpa - page->guest_phys_addr +
 597                                page->host_phys_addr;
 598                 }
 599         }
 600
 601         return 0;
 602 }
 603
 604 static __rte_always_inline struct virtio_net *
 605 get_device(int vid)
 606 {
 607         struct virtio_net *dev = vhost_devices[vid];
 608
 609         if (unlikely(!dev)) {
 610                 RTE_LOG(ERR, VHOST_CONFIG,
 611                         "(%d) device not found.\n", vid);
 612         }
 613
 614         return dev;
 615 }
 616
 617 int vhost_new_device(void);
 618 void cleanup_device(struct virtio_net *dev, int destroy);
 619 void reset_device(struct virtio_net *dev);
 620 void vhost_destroy_device(int);
 621 void vhost_destroy_device_notify(struct virtio_net *dev);
 622
 623 void cleanup_vq(struct vhost_virtqueue *vq, int destroy);
 624 void free_vq(struct virtio_net *dev, struct vhost_virtqueue *vq);
 625
 626 int alloc_vring_queue(struct virtio_net *dev, uint32_t vring_idx);
 627
 628 void vhost_attach_vdpa_device(int vid, int did);
 629 void vhost_detach_vdpa_device(int vid);
 630
 631 void vhost_set_ifname(int, const char *if_name, unsigned int if_len);
 632 void vhost_enable_dequeue_zero_copy(int vid);
 633 void vhost_set_builtin_virtio_net(int vid, bool enable);
 634
 635 struct vhost_device_ops const *vhost_driver_callback_get(const char *path);
 636
 637 /*
 638  * Backend-specific cleanup.
 639  *
 640  * TODO: fix it; we have one backend now
 641  */
 642 void vhost_backend_cleanup(struct virtio_net *dev);
 643
 644 uint64_t __vhost_iova_to_vva(struct virtio_net *dev, struct vhost_virtqueue *vq,
 645                         uint64_t iova, uint64_t *len, uint8_t perm);
 646 int vring_translate(struct virtio_net *dev, struct vhost_virtqueue *vq);
 647 void vring_invalidate(struct virtio_net *dev, struct vhost_virtqueue *vq);
 648
 649 static __rte_always_inline uint64_t
 650 vhost_iova_to_vva(struct virtio_net *dev, struct vhost_virtqueue *vq,
 651                         uint64_t iova, uint64_t *len, uint8_t perm)
 652 {
 653         if (!(dev->features & (1ULL << VIRTIO_F_IOMMU_PLATFORM)))
 654                 return rte_vhost_va_from_guest_pa(dev->mem, iova, len);
 655
 656         return __vhost_iova_to_vva(dev, vq, iova, len, perm);
 657 }
 658
 659 #define vhost_avail_event(vr) \
 660         (*(volatile uint16_t*)&(vr)->used->ring[(vr)->size])
 661 #define vhost_used_event(vr) \
 662         (*(volatile uint16_t*)&(vr)->avail->ring[(vr)->size])
 663
 664 /*
 665  * The following is used with VIRTIO_RING_F_EVENT_IDX.
 666  * Assuming a given event_idx value from the other size, if we have
 667  * just incremented index from old to new_idx, should we trigger an
 668  * event?
 669  */
 670 static __rte_always_inline int
 671 vhost_need_event(uint16_t event_idx, uint16_t new_idx, uint16_t old)
 672 {
 673         return (uint16_t)(new_idx - event_idx - 1) < (uint16_t)(new_idx - old);
 674 }
 675
 676 static __rte_always_inline void
 677 vhost_vring_call_split(struct virtio_net *dev, struct vhost_virtqueue *vq)
 678 {
 679         /* Flush used->idx update before we read avail->flags. */
 680         rte_smp_mb();
 681
 682         /* Don't kick guest if we don't reach index specified by guest. */
 683         if (dev->features & (1ULL << VIRTIO_RING_F_EVENT_IDX)) {
 684                 uint16_t old = vq->signalled_used;
 685                 uint16_t new = vq->last_used_idx;
 686
 687                 VHOST_LOG_DEBUG(VHOST_DATA, "%s: used_event_idx=%d, old=%d, new=%d\n",
 688                         __func__,
 689                         vhost_used_event(vq),
 690                         old, new);
 691                 if (vhost_need_event(vhost_used_event(vq), new, old)
 692                         && (vq->callfd >= 0)) {
 693                         vq->signalled_used = vq->last_used_idx;
 694                         eventfd_write(vq->callfd, (eventfd_t) 1);
 695                 }
 696         } else {
 697                 /* Kick the guest if necessary. */
 698                 if (!(vq->avail->flags & VRING_AVAIL_F_NO_INTERRUPT)
 699                                 && (vq->callfd >= 0))
 700                         eventfd_write(vq->callfd, (eventfd_t)1);
 701         }
 702 }
 703
 704 static __rte_always_inline void
 705 vhost_vring_call_packed(struct virtio_net *dev, struct vhost_virtqueue *vq)
 706 {
 707         uint16_t old, new, off, off_wrap;
 708         bool signalled_used_valid, kick = false;
 709
 710         /* Flush used desc update. */
 711         rte_smp_mb();
 712
 713         if (!(dev->features & (1ULL << VIRTIO_RING_F_EVENT_IDX))) {
 714                 if (vq->driver_event->flags !=
 715                                 VRING_EVENT_F_DISABLE)
 716                         kick = true;
 717                 goto kick;
 718         }
 719
 720         old = vq->signalled_used;
 721         new = vq->last_used_idx;
 722         vq->signalled_used = new;
 723         signalled_used_valid = vq->signalled_used_valid;
 724         vq->signalled_used_valid = true;
 725
 726         if (vq->driver_event->flags != VRING_EVENT_F_DESC) {
 727                 if (vq->driver_event->flags != VRING_EVENT_F_DISABLE)
 728                         kick = true;
 729                 goto kick;
 730         }
 731
 732         if (unlikely(!signalled_used_valid)) {
 733                 kick = true;
 734                 goto kick;
 735         }
 736
 737         rte_smp_rmb();
 738
 739         off_wrap = vq->driver_event->off_wrap;
 740         off = off_wrap & ~(1 << 15);
 741
 742         if (new <= old)
 743                 old -= vq->size;
 744
 745         if (vq->used_wrap_counter != off_wrap >> 15)
 746                 off -= vq->size;
 747
 748         if (vhost_need_event(off, new, old))
 749                 kick = true;
 750 kick:
 751         if (kick)
 752                 eventfd_write(vq->callfd, (eventfd_t)1);
 753 }
 754
 755 #endif /* _VHOST_NET_CDEV_H_ */