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 /**
 288  * function prototype for the vhost backend to handler specific vhost user
 289  * messages prior to the master message handling
 290  *
 291  * @param vid
 292  *  vhost device id
 293  * @param msg
 294  *  Message pointer.
 295  * @param require_reply
 296  *  If the handler requires sending a reply, this varaible shall be written 1,
 297  *  otherwise 0.
 298  * @param skip_master
 299  *  If the handler requires skipping the master message handling, this variable
 300  *  shall be written 1, otherwise 0.
 301  * @return
 302  *  0 on success, -1 on failure
 303  */
 304 typedef int (*vhost_msg_pre_handle)(int vid, void *msg,
 305                 uint32_t *require_reply, uint32_t *skip_master);
 306
 307 /**
 308  * function prototype for the vhost backend to handler specific vhost user
 309  * messages after the master message handling is done
 310  *
 311  * @param vid
 312  *  vhost device id
 313  * @param msg
 314  *  Message pointer.
 315  * @param require_reply
 316  *  If the handler requires sending a reply, this varaible shall be written 1,
 317  *  otherwise 0.
 318  * @return
 319  *  0 on success, -1 on failure
 320  */
 321 typedef int (*vhost_msg_post_handle)(int vid, void *msg,
 322                 uint32_t *require_reply);
 323
 324 /**
 325  * pre and post vhost user message handlers
 326  */
 327 struct vhost_user_extern_ops {
 328         vhost_msg_pre_handle pre_msg_handle;
 329         vhost_msg_post_handle post_msg_handle;
 330 };
 331
 332 /**
 333  * Device structure contains all configuration information relating
 334  * to the device.
 335  */
 336 struct virtio_net {
 337         /* Frontend (QEMU) memory and memory region information */
 338         struct rte_vhost_memory *mem;
 339         uint64_t                features;
 340         uint64_t                protocol_features;
 341         int                     vid;
 342         uint32_t                flags;
 343         uint16_t                vhost_hlen;
 344         /* to tell if we need broadcast rarp packet */
 345         rte_atomic16_t          broadcast_rarp;
 346         uint32_t                nr_vring;
 347         int                     dequeue_zero_copy;
 348         struct vhost_virtqueue  *virtqueue[VHOST_MAX_QUEUE_PAIRS * 2];
 349 #define IF_NAME_SZ (PATH_MAX > IFNAMSIZ ? PATH_MAX : IFNAMSIZ)
 350         char                    ifname[IF_NAME_SZ];
 351         uint64_t                log_size;
 352         uint64_t                log_base;
 353         uint64_t                log_addr;
 354         struct ether_addr       mac;
 355         uint16_t                mtu;
 356
 357         struct vhost_device_ops const *notify_ops;
 358
 359         uint32_t                nr_guest_pages;
 360         uint32_t                max_guest_pages;
 361         struct guest_page       *guest_pages;
 362
 363         int                     slave_req_fd;
 364         rte_spinlock_t          slave_req_lock;
 365
 366         /*
 367          * Device id to identify a specific backend device.
 368          * It's set to -1 for the default software implementation.
 369          */
 370         int                     vdpa_dev_id;
 371
 372         /* private data for virtio device */
 373         void                    *extern_data;
 374         /* pre and post vhost user message handlers for the device */
 375         struct vhost_user_extern_ops extern_ops;
 376 } __rte_cache_aligned;
 377
 378 static __rte_always_inline bool
 379 vq_is_packed(struct virtio_net *dev)
 380 {
 381         return dev->features & (1ull << VIRTIO_F_RING_PACKED);
 382 }
 383
 384 static inline bool
 385 desc_is_avail(struct vring_packed_desc *desc, bool wrap_counter)
 386 {
 387         return wrap_counter == !!(desc->flags & VRING_DESC_F_AVAIL) &&
 388                 wrap_counter != !!(desc->flags & VRING_DESC_F_USED);
 389 }
 390
 391 #define VHOST_LOG_PAGE  4096
 392
 393 /*
 394  * Atomically set a bit in memory.
 395  */
 396 static __rte_always_inline void
 397 vhost_set_bit(unsigned int nr, volatile uint8_t *addr)
 398 {
 399 #if defined(RTE_TOOLCHAIN_GCC) && (GCC_VERSION < 70100)
 400         /*
 401          * __sync_ built-ins are deprecated, but __atomic_ ones
 402          * are sub-optimized in older GCC versions.
 403          */
 404         __sync_fetch_and_or_1(addr, (1U << nr));
 405 #else
 406         __atomic_fetch_or(addr, (1U << nr), __ATOMIC_RELAXED);
 407 #endif
 408 }
 409
 410 static __rte_always_inline void
 411 vhost_log_page(uint8_t *log_base, uint64_t page)
 412 {
 413         vhost_set_bit(page % 8, &log_base[page / 8]);
 414 }
 415
 416 static __rte_always_inline void
 417 vhost_log_write(struct virtio_net *dev, uint64_t addr, uint64_t len)
 418 {
 419         uint64_t page;
 420
 421         if (likely(((dev->features & (1ULL << VHOST_F_LOG_ALL)) == 0) ||
 422                    !dev->log_base || !len))
 423                 return;
 424
 425         if (unlikely(dev->log_size <= ((addr + len - 1) / VHOST_LOG_PAGE / 8)))
 426                 return;
 427
 428         /* To make sure guest memory updates are committed before logging */
 429         rte_smp_wmb();
 430
 431         page = addr / VHOST_LOG_PAGE;
 432         while (page * VHOST_LOG_PAGE < addr + len) {
 433                 vhost_log_page((uint8_t *)(uintptr_t)dev->log_base, page);
 434                 page += 1;
 435         }
 436 }
 437
 438 static __rte_always_inline void
 439 vhost_log_cache_sync(struct virtio_net *dev, struct vhost_virtqueue *vq)
 440 {
 441         unsigned long *log_base;
 442         int i;
 443
 444         if (likely(((dev->features & (1ULL << VHOST_F_LOG_ALL)) == 0) ||
 445                    !dev->log_base))
 446                 return;
 447
 448         log_base = (unsigned long *)(uintptr_t)dev->log_base;
 449
 450         /*
 451          * It is expected a write memory barrier has been issued
 452          * before this function is called.
 453          */
 454
 455         for (i = 0; i < vq->log_cache_nb_elem; i++) {
 456                 struct log_cache_entry *elem = vq->log_cache + i;
 457
 458 #if defined(RTE_TOOLCHAIN_GCC) && (GCC_VERSION < 70100)
 459                 /*
 460                  * '__sync' builtins are deprecated, but '__atomic' ones
 461                  * are sub-optimized in older GCC versions.
 462                  */
 463                 __sync_fetch_and_or(log_base + elem->offset, elem->val);
 464 #else
 465                 __atomic_fetch_or(log_base + elem->offset, elem->val,
 466                                 __ATOMIC_RELAXED);
 467 #endif
 468         }
 469
 470         rte_smp_wmb();
 471
 472         vq->log_cache_nb_elem = 0;
 473 }
 474
 475 static __rte_always_inline void
 476 vhost_log_cache_page(struct virtio_net *dev, struct vhost_virtqueue *vq,
 477                         uint64_t page)
 478 {
 479         uint32_t bit_nr = page % (sizeof(unsigned long) << 3);
 480         uint32_t offset = page / (sizeof(unsigned long) << 3);
 481         int i;
 482
 483         for (i = 0; i < vq->log_cache_nb_elem; i++) {
 484                 struct log_cache_entry *elem = vq->log_cache + i;
 485
 486                 if (elem->offset == offset) {
 487                         elem->val |= (1UL << bit_nr);
 488                         return;
 489                 }
 490         }
 491
 492         if (unlikely(i >= VHOST_LOG_CACHE_NR)) {
 493                 /*
 494                  * No more room for a new log cache entry,
 495                  * so write the dirty log map directly.
 496                  */
 497                 rte_smp_wmb();
 498                 vhost_log_page((uint8_t *)(uintptr_t)dev->log_base, page);
 499
 500                 return;
 501         }
 502
 503         vq->log_cache[i].offset = offset;
 504         vq->log_cache[i].val = (1UL << bit_nr);
 505         vq->log_cache_nb_elem++;
 506 }
 507
 508 static __rte_always_inline void
 509 vhost_log_cache_write(struct virtio_net *dev, struct vhost_virtqueue *vq,
 510                         uint64_t addr, uint64_t len)
 511 {
 512         uint64_t page;
 513
 514         if (likely(((dev->features & (1ULL << VHOST_F_LOG_ALL)) == 0) ||
 515                    !dev->log_base || !len))
 516                 return;
 517
 518         if (unlikely(dev->log_size <= ((addr + len - 1) / VHOST_LOG_PAGE / 8)))
 519                 return;
 520
 521         page = addr / VHOST_LOG_PAGE;
 522         while (page * VHOST_LOG_PAGE < addr + len) {
 523                 vhost_log_cache_page(dev, vq, page);
 524                 page += 1;
 525         }
 526 }
 527
 528 static __rte_always_inline void
 529 vhost_log_cache_used_vring(struct virtio_net *dev, struct vhost_virtqueue *vq,
 530                         uint64_t offset, uint64_t len)
 531 {
 532         vhost_log_cache_write(dev, vq, vq->log_guest_addr + offset, len);
 533 }
 534
 535 static __rte_always_inline void
 536 vhost_log_used_vring(struct virtio_net *dev, struct vhost_virtqueue *vq,
 537                      uint64_t offset, uint64_t len)
 538 {
 539         vhost_log_write(dev, vq->log_guest_addr + offset, len);
 540 }
 541
 542 /* Macros for printing using RTE_LOG */
 543 #define RTE_LOGTYPE_VHOST_CONFIG RTE_LOGTYPE_USER1
 544 #define RTE_LOGTYPE_VHOST_DATA   RTE_LOGTYPE_USER1
 545
 546 #ifdef RTE_LIBRTE_VHOST_DEBUG
 547 #define VHOST_MAX_PRINT_BUFF 6072
 548 #define VHOST_LOG_DEBUG(log_type, fmt, args...) \
 549         RTE_LOG(DEBUG, log_type, fmt, ##args)
 550 #define PRINT_PACKET(device, addr, size, header) do { \
 551         char *pkt_addr = (char *)(addr); \
 552         unsigned int index; \
 553         char packet[VHOST_MAX_PRINT_BUFF]; \
 554         \
 555         if ((header)) \
 556                 snprintf(packet, VHOST_MAX_PRINT_BUFF, "(%d) Header size %d: ", (device->vid), (size)); \
 557         else \
 558                 snprintf(packet, VHOST_MAX_PRINT_BUFF, "(%d) Packet size %d: ", (device->vid), (size)); \
 559         for (index = 0; index < (size); index++) { \
 560                 snprintf(packet + strnlen(packet, VHOST_MAX_PRINT_BUFF), VHOST_MAX_PRINT_BUFF - strnlen(packet, VHOST_MAX_PRINT_BUFF), \
 561                         "%02hhx ", pkt_addr[index]); \
 562         } \
 563         snprintf(packet + strnlen(packet, VHOST_MAX_PRINT_BUFF), VHOST_MAX_PRINT_BUFF - strnlen(packet, VHOST_MAX_PRINT_BUFF), "\n"); \
 564         \
 565         VHOST_LOG_DEBUG(VHOST_DATA, "%s", packet); \
 566 } while (0)
 567 #else
 568 #define VHOST_LOG_DEBUG(log_type, fmt, args...) do {} while (0)
 569 #define PRINT_PACKET(device, addr, size, header) do {} while (0)
 570 #endif
 571
 572 extern uint64_t VHOST_FEATURES;
 573 #define MAX_VHOST_DEVICE        1024
 574 extern struct virtio_net *vhost_devices[MAX_VHOST_DEVICE];
 575
 576 /* Convert guest physical address to host physical address */
 577 static __rte_always_inline rte_iova_t
 578 gpa_to_hpa(struct virtio_net *dev, uint64_t gpa, uint64_t size)
 579 {
 580         uint32_t i;
 581         struct guest_page *page;
 582
 583         for (i = 0; i < dev->nr_guest_pages; i++) {
 584                 page = &dev->guest_pages[i];
 585
 586                 if (gpa >= page->guest_phys_addr &&
 587                     gpa + size < page->guest_phys_addr + page->size) {
 588                         return gpa - page->guest_phys_addr +
 589                                page->host_phys_addr;
 590                 }
 591         }
 592
 593         return 0;
 594 }
 595
 596 static __rte_always_inline struct virtio_net *
 597 get_device(int vid)
 598 {
 599         struct virtio_net *dev = vhost_devices[vid];
 600
 601         if (unlikely(!dev)) {
 602                 RTE_LOG(ERR, VHOST_CONFIG,
 603                         "(%d) device not found.\n", vid);
 604         }
 605
 606         return dev;
 607 }
 608
 609 int vhost_new_device(void);
 610 void cleanup_device(struct virtio_net *dev, int destroy);
 611 void reset_device(struct virtio_net *dev);
 612 void vhost_destroy_device(int);
 613 void vhost_destroy_device_notify(struct virtio_net *dev);
 614
 615 void cleanup_vq(struct vhost_virtqueue *vq, int destroy);
 616 void free_vq(struct virtio_net *dev, struct vhost_virtqueue *vq);
 617
 618 int alloc_vring_queue(struct virtio_net *dev, uint32_t vring_idx);
 619
 620 void vhost_attach_vdpa_device(int vid, int did);
 621 void vhost_detach_vdpa_device(int vid);
 622
 623 void vhost_set_ifname(int, const char *if_name, unsigned int if_len);
 624 void vhost_enable_dequeue_zero_copy(int vid);
 625 void vhost_set_builtin_virtio_net(int vid, bool enable);
 626
 627 struct vhost_device_ops const *vhost_driver_callback_get(const char *path);
 628
 629 /*
 630  * Backend-specific cleanup.
 631  *
 632  * TODO: fix it; we have one backend now
 633  */
 634 void vhost_backend_cleanup(struct virtio_net *dev);
 635
 636 uint64_t __vhost_iova_to_vva(struct virtio_net *dev, struct vhost_virtqueue *vq,
 637                         uint64_t iova, uint64_t *len, uint8_t perm);
 638 int vring_translate(struct virtio_net *dev, struct vhost_virtqueue *vq);
 639 void vring_invalidate(struct virtio_net *dev, struct vhost_virtqueue *vq);
 640
 641 static __rte_always_inline uint64_t
 642 vhost_iova_to_vva(struct virtio_net *dev, struct vhost_virtqueue *vq,
 643                         uint64_t iova, uint64_t *len, uint8_t perm)
 644 {
 645         if (!(dev->features & (1ULL << VIRTIO_F_IOMMU_PLATFORM)))
 646                 return rte_vhost_va_from_guest_pa(dev->mem, iova, len);
 647
 648         return __vhost_iova_to_vva(dev, vq, iova, len, perm);
 649 }
 650
 651 #define vhost_used_event(vr) \
 652         (*(volatile uint16_t*)&(vr)->avail->ring[(vr)->size])
 653
 654 /*
 655  * The following is used with VIRTIO_RING_F_EVENT_IDX.
 656  * Assuming a given event_idx value from the other size, if we have
 657  * just incremented index from old to new_idx, should we trigger an
 658  * event?
 659  */
 660 static __rte_always_inline int
 661 vhost_need_event(uint16_t event_idx, uint16_t new_idx, uint16_t old)
 662 {
 663         return (uint16_t)(new_idx - event_idx - 1) < (uint16_t)(new_idx - old);
 664 }
 665
 666 static __rte_always_inline void
 667 vhost_vring_call_split(struct virtio_net *dev, struct vhost_virtqueue *vq)
 668 {
 669         /* Flush used->idx update before we read avail->flags. */
 670         rte_smp_mb();
 671
 672         /* Don't kick guest if we don't reach index specified by guest. */
 673         if (dev->features & (1ULL << VIRTIO_RING_F_EVENT_IDX)) {
 674                 uint16_t old = vq->signalled_used;
 675                 uint16_t new = vq->last_used_idx;
 676
 677                 VHOST_LOG_DEBUG(VHOST_DATA, "%s: used_event_idx=%d, old=%d, new=%d\n",
 678                         __func__,
 679                         vhost_used_event(vq),
 680                         old, new);
 681                 if (vhost_need_event(vhost_used_event(vq), new, old)
 682                         && (vq->callfd >= 0)) {
 683                         vq->signalled_used = vq->last_used_idx;
 684                         eventfd_write(vq->callfd, (eventfd_t) 1);
 685                 }
 686         } else {
 687                 /* Kick the guest if necessary. */
 688                 if (!(vq->avail->flags & VRING_AVAIL_F_NO_INTERRUPT)
 689                                 && (vq->callfd >= 0))
 690                         eventfd_write(vq->callfd, (eventfd_t)1);
 691         }
 692 }
 693
 694 static __rte_always_inline void
 695 vhost_vring_call_packed(struct virtio_net *dev, struct vhost_virtqueue *vq)
 696 {
 697         uint16_t old, new, off, off_wrap;
 698         bool signalled_used_valid, kick = false;
 699
 700         /* Flush used desc update. */
 701         rte_smp_mb();
 702
 703         if (!(dev->features & (1ULL << VIRTIO_RING_F_EVENT_IDX))) {
 704                 if (vq->driver_event->flags !=
 705                                 VRING_EVENT_F_DISABLE)
 706                         kick = true;
 707                 goto kick;
 708         }
 709
 710         old = vq->signalled_used;
 711         new = vq->last_used_idx;
 712         vq->signalled_used = new;
 713         signalled_used_valid = vq->signalled_used_valid;
 714         vq->signalled_used_valid = true;
 715
 716         if (vq->driver_event->flags != VRING_EVENT_F_DESC) {
 717                 if (vq->driver_event->flags != VRING_EVENT_F_DISABLE)
 718                         kick = true;
 719                 goto kick;
 720         }
 721
 722         if (unlikely(!signalled_used_valid)) {
 723                 kick = true;
 724                 goto kick;
 725         }
 726
 727         rte_smp_rmb();
 728
 729         off_wrap = vq->driver_event->off_wrap;
 730         off = off_wrap & ~(1 << 15);
 731
 732         if (new <= old)
 733                 old -= vq->size;
 734
 735         if (vq->used_wrap_counter != off_wrap >> 15)
 736                 off -= vq->size;
 737
 738         if (vhost_need_event(off, new, old))
 739                 kick = true;
 740 kick:
 741         if (kick)
 742                 eventfd_write(vq->callfd, (eventfd_t)1);
 743 }
 744
 745 #endif /* _VHOST_NET_CDEV_H_ */