lib/librte_vhost/vhost.c

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(c) 2010-2016 Intel Corporation
   3  */
   4
   5 #include <linux/vhost.h>
   6 #include <linux/virtio_net.h>
   7 #include <stddef.h>
   8 #include <stdint.h>
   9 #include <stdlib.h>
  10 #ifdef RTE_LIBRTE_VHOST_NUMA
  11 #include <numaif.h>
  12 #endif
  13
  14 #include <rte_errno.h>
  15 #include <rte_ethdev.h>
  16 #include <rte_log.h>
  17 #include <rte_string_fns.h>
  18 #include <rte_memory.h>
  19 #include <rte_malloc.h>
  20 #include <rte_vhost.h>
  21 #include <rte_rwlock.h>
  22
  23 #include "iotlb.h"
  24 #include "vhost.h"
  25 #include "vhost_user.h"
  26
  27 struct virtio_net *vhost_devices[MAX_VHOST_DEVICE];
  28
  29 /* Called with iotlb_lock read-locked */
  30 uint64_t
  31 __vhost_iova_to_vva(struct virtio_net *dev, struct vhost_virtqueue *vq,
  32                     uint64_t iova, uint64_t size, uint8_t perm)
  33 {
  34         uint64_t vva, tmp_size;
  35
  36         if (unlikely(!size))
  37                 return 0;
  38
  39         tmp_size = size;
  40
  41         vva = vhost_user_iotlb_cache_find(vq, iova, &tmp_size, perm);
  42         if (tmp_size == size)
  43                 return vva;
  44
  45         iova += tmp_size;
  46
  47         if (!vhost_user_iotlb_pending_miss(vq, iova, perm)) {
  48                 /*
  49                  * iotlb_lock is read-locked for a full burst,
  50                  * but it only protects the iotlb cache.
  51                  * In case of IOTLB miss, we might block on the socket,
  52                  * which could cause a deadlock with QEMU if an IOTLB update
  53                  * is being handled. We can safely unlock here to avoid it.
  54                  */
  55                 vhost_user_iotlb_rd_unlock(vq);
  56
  57                 vhost_user_iotlb_pending_insert(vq, iova, perm);
  58                 if (vhost_user_iotlb_miss(dev, iova, perm)) {
  59                         RTE_LOG(ERR, VHOST_CONFIG,
  60                                 "IOTLB miss req failed for IOVA 0x%" PRIx64 "\n",
  61                                 iova);
  62                         vhost_user_iotlb_pending_remove(vq, iova, 1, perm);
  63                 }
  64
  65                 vhost_user_iotlb_rd_lock(vq);
  66         }
  67
  68         return 0;
  69 }
  70
  71 void
  72 cleanup_vq(struct vhost_virtqueue *vq, int destroy)
  73 {
  74         if ((vq->callfd >= 0) && (destroy != 0))
  75                 close(vq->callfd);
  76         if (vq->kickfd >= 0)
  77                 close(vq->kickfd);
  78 }
  79
  80 /*
  81  * Unmap any memory, close any file descriptors and
  82  * free any memory owned by a device.
  83  */
  84 void
  85 cleanup_device(struct virtio_net *dev, int destroy)
  86 {
  87         uint32_t i;
  88
  89         vhost_backend_cleanup(dev);
  90
  91         for (i = 0; i < dev->nr_vring; i++)
  92                 cleanup_vq(dev->virtqueue[i], destroy);
  93 }
  94
  95 void
  96 free_vq(struct vhost_virtqueue *vq)
  97 {
  98         rte_free(vq->shadow_used_ring);
  99         rte_free(vq->batch_copy_elems);
 100         rte_mempool_free(vq->iotlb_pool);
 101         rte_free(vq);
 102 }
 103
 104 /*
 105  * Release virtqueues and device memory.
 106  */
 107 static void
 108 free_device(struct virtio_net *dev)
 109 {
 110         uint32_t i;
 111
 112         for (i = 0; i < dev->nr_vring; i++)
 113                 free_vq(dev->virtqueue[i]);
 114
 115         rte_free(dev);
 116 }
 117
 118 int
 119 vring_translate(struct virtio_net *dev, struct vhost_virtqueue *vq)
 120 {
 121         uint64_t size;
 122
 123         if (!(dev->features & (1ULL << VIRTIO_F_IOMMU_PLATFORM)))
 124                 goto out;
 125
 126         size = sizeof(struct vring_desc) * vq->size;
 127         vq->desc = (struct vring_desc *)(uintptr_t)vhost_iova_to_vva(dev, vq,
 128                                                 vq->ring_addrs.desc_user_addr,
 129                                                 size, VHOST_ACCESS_RW);
 130         if (!vq->desc)
 131                 return -1;
 132
 133         size = sizeof(struct vring_avail);
 134         size += sizeof(uint16_t) * vq->size;
 135         vq->avail = (struct vring_avail *)(uintptr_t)vhost_iova_to_vva(dev, vq,
 136                                                 vq->ring_addrs.avail_user_addr,
 137                                                 size, VHOST_ACCESS_RW);
 138         if (!vq->avail)
 139                 return -1;
 140
 141         size = sizeof(struct vring_used);
 142         size += sizeof(struct vring_used_elem) * vq->size;
 143         vq->used = (struct vring_used *)(uintptr_t)vhost_iova_to_vva(dev, vq,
 144                                                 vq->ring_addrs.used_user_addr,
 145                                                 size, VHOST_ACCESS_RW);
 146         if (!vq->used)
 147                 return -1;
 148
 149 out:
 150         vq->access_ok = 1;
 151
 152         return 0;
 153 }
 154
 155 void
 156 vring_invalidate(struct virtio_net *dev, struct vhost_virtqueue *vq)
 157 {
 158         if (dev->features & (1ULL << VIRTIO_F_IOMMU_PLATFORM))
 159                 vhost_user_iotlb_wr_lock(vq);
 160
 161         vq->access_ok = 0;
 162         vq->desc = NULL;
 163         vq->avail = NULL;
 164         vq->used = NULL;
 165
 166         if (dev->features & (1ULL << VIRTIO_F_IOMMU_PLATFORM))
 167                 vhost_user_iotlb_wr_unlock(vq);
 168 }
 169
 170 static void
 171 init_vring_queue(struct virtio_net *dev, uint32_t vring_idx)
 172 {
 173         struct vhost_virtqueue *vq;
 174
 175         if (vring_idx >= VHOST_MAX_VRING) {
 176                 RTE_LOG(ERR, VHOST_CONFIG,
 177                                 "Failed not init vring, out of bound (%d)\n",
 178                                 vring_idx);
 179                 return;
 180         }
 181
 182         vq = dev->virtqueue[vring_idx];
 183
 184         memset(vq, 0, sizeof(struct vhost_virtqueue));
 185
 186         vq->kickfd = VIRTIO_UNINITIALIZED_EVENTFD;
 187         vq->callfd = VIRTIO_UNINITIALIZED_EVENTFD;
 188
 189         vhost_user_iotlb_init(dev, vring_idx);
 190         /* Backends are set to -1 indicating an inactive device. */
 191         vq->backend = -1;
 192
 193         TAILQ_INIT(&vq->zmbuf_list);
 194 }
 195
 196 static void
 197 reset_vring_queue(struct virtio_net *dev, uint32_t vring_idx)
 198 {
 199         struct vhost_virtqueue *vq;
 200         int callfd;
 201
 202         if (vring_idx >= VHOST_MAX_VRING) {
 203                 RTE_LOG(ERR, VHOST_CONFIG,
 204                                 "Failed not init vring, out of bound (%d)\n",
 205                                 vring_idx);
 206                 return;
 207         }
 208
 209         vq = dev->virtqueue[vring_idx];
 210         callfd = vq->callfd;
 211         init_vring_queue(dev, vring_idx);
 212         vq->callfd = callfd;
 213 }
 214
 215 int
 216 alloc_vring_queue(struct virtio_net *dev, uint32_t vring_idx)
 217 {
 218         struct vhost_virtqueue *vq;
 219
 220         vq = rte_malloc(NULL, sizeof(struct vhost_virtqueue), 0);
 221         if (vq == NULL) {
 222                 RTE_LOG(ERR, VHOST_CONFIG,
 223                         "Failed to allocate memory for vring:%u.\n", vring_idx);
 224                 return -1;
 225         }
 226
 227         dev->virtqueue[vring_idx] = vq;
 228         init_vring_queue(dev, vring_idx);
 229         rte_spinlock_init(&vq->access_lock);
 230
 231         dev->nr_vring += 1;
 232
 233         return 0;
 234 }
 235
 236 /*
 237  * Reset some variables in device structure, while keeping few
 238  * others untouched, such as vid, ifname, nr_vring: they
 239  * should be same unless the device is removed.
 240  */
 241 void
 242 reset_device(struct virtio_net *dev)
 243 {
 244         uint32_t i;
 245
 246         dev->features = 0;
 247         dev->protocol_features = 0;
 248         dev->flags &= VIRTIO_DEV_BUILTIN_VIRTIO_NET;
 249
 250         for (i = 0; i < dev->nr_vring; i++)
 251                 reset_vring_queue(dev, i);
 252 }
 253
 254 /*
 255  * Invoked when there is a new vhost-user connection established (when
 256  * there is a new virtio device being attached).
 257  */
 258 int
 259 vhost_new_device(void)
 260 {
 261         struct virtio_net *dev;
 262         int i;
 263
 264         dev = rte_zmalloc(NULL, sizeof(struct virtio_net), 0);
 265         if (dev == NULL) {
 266                 RTE_LOG(ERR, VHOST_CONFIG,
 267                         "Failed to allocate memory for new dev.\n");
 268                 return -1;
 269         }
 270
 271         for (i = 0; i < MAX_VHOST_DEVICE; i++) {
 272                 if (vhost_devices[i] == NULL)
 273                         break;
 274         }
 275         if (i == MAX_VHOST_DEVICE) {
 276                 RTE_LOG(ERR, VHOST_CONFIG,
 277                         "Failed to find a free slot for new device.\n");
 278                 rte_free(dev);
 279                 return -1;
 280         }
 281
 282         vhost_devices[i] = dev;
 283         dev->vid = i;
 284         dev->flags = VIRTIO_DEV_BUILTIN_VIRTIO_NET;
 285         dev->slave_req_fd = -1;
 286
 287         return i;
 288 }
 289
 290 /*
 291  * Invoked when there is the vhost-user connection is broken (when
 292  * the virtio device is being detached).
 293  */
 294 void
 295 vhost_destroy_device(int vid)
 296 {
 297         struct virtio_net *dev = get_device(vid);
 298
 299         if (dev == NULL)
 300                 return;
 301
 302         if (dev->flags & VIRTIO_DEV_RUNNING) {
 303                 dev->flags &= ~VIRTIO_DEV_RUNNING;
 304                 dev->notify_ops->destroy_device(vid);
 305         }
 306
 307         cleanup_device(dev, 1);
 308         free_device(dev);
 309
 310         vhost_devices[vid] = NULL;
 311 }
 312
 313 void
 314 vhost_set_ifname(int vid, const char *if_name, unsigned int if_len)
 315 {
 316         struct virtio_net *dev;
 317         unsigned int len;
 318
 319         dev = get_device(vid);
 320         if (dev == NULL)
 321                 return;
 322
 323         len = if_len > sizeof(dev->ifname) ?
 324                 sizeof(dev->ifname) : if_len;
 325
 326         strncpy(dev->ifname, if_name, len);
 327         dev->ifname[sizeof(dev->ifname) - 1] = '\0';
 328 }
 329
 330 void
 331 vhost_enable_dequeue_zero_copy(int vid)
 332 {
 333         struct virtio_net *dev = get_device(vid);
 334
 335         if (dev == NULL)
 336                 return;
 337
 338         dev->dequeue_zero_copy = 1;
 339 }
 340
 341 void
 342 vhost_set_builtin_virtio_net(int vid, bool enable)
 343 {
 344         struct virtio_net *dev = get_device(vid);
 345
 346         if (dev == NULL)
 347                 return;
 348
 349         if (enable)
 350                 dev->flags |= VIRTIO_DEV_BUILTIN_VIRTIO_NET;
 351         else
 352                 dev->flags &= ~VIRTIO_DEV_BUILTIN_VIRTIO_NET;
 353 }
 354
 355 int
 356 rte_vhost_get_mtu(int vid, uint16_t *mtu)
 357 {
 358         struct virtio_net *dev = get_device(vid);
 359
 360         if (!dev)
 361                 return -ENODEV;
 362
 363         if (!(dev->flags & VIRTIO_DEV_READY))
 364                 return -EAGAIN;
 365
 366         if (!(dev->features & (1ULL << VIRTIO_NET_F_MTU)))
 367                 return -ENOTSUP;
 368
 369         *mtu = dev->mtu;
 370
 371         return 0;
 372 }
 373
 374 int
 375 rte_vhost_get_numa_node(int vid)
 376 {
 377 #ifdef RTE_LIBRTE_VHOST_NUMA
 378         struct virtio_net *dev = get_device(vid);
 379         int numa_node;
 380         int ret;
 381
 382         if (dev == NULL)
 383                 return -1;
 384
 385         ret = get_mempolicy(&numa_node, NULL, 0, dev,
 386                             MPOL_F_NODE | MPOL_F_ADDR);
 387         if (ret < 0) {
 388                 RTE_LOG(ERR, VHOST_CONFIG,
 389                         "(%d) failed to query numa node: %s\n",
 390                         vid, rte_strerror(errno));
 391                 return -1;
 392         }
 393
 394         return numa_node;
 395 #else
 396         RTE_SET_USED(vid);
 397         return -1;
 398 #endif
 399 }
 400
 401 uint32_t
 402 rte_vhost_get_queue_num(int vid)
 403 {
 404         struct virtio_net *dev = get_device(vid);
 405
 406         if (dev == NULL)
 407                 return 0;
 408
 409         return dev->nr_vring / 2;
 410 }
 411
 412 uint16_t
 413 rte_vhost_get_vring_num(int vid)
 414 {
 415         struct virtio_net *dev = get_device(vid);
 416
 417         if (dev == NULL)
 418                 return 0;
 419
 420         return dev->nr_vring;
 421 }
 422
 423 int
 424 rte_vhost_get_ifname(int vid, char *buf, size_t len)
 425 {
 426         struct virtio_net *dev = get_device(vid);
 427
 428         if (dev == NULL)
 429                 return -1;
 430
 431         len = RTE_MIN(len, sizeof(dev->ifname));
 432
 433         strncpy(buf, dev->ifname, len);
 434         buf[len - 1] = '\0';
 435
 436         return 0;
 437 }
 438
 439 int
 440 rte_vhost_get_negotiated_features(int vid, uint64_t *features)
 441 {
 442         struct virtio_net *dev;
 443
 444         dev = get_device(vid);
 445         if (!dev)
 446                 return -1;
 447
 448         *features = dev->features;
 449         return 0;
 450 }
 451
 452 int
 453 rte_vhost_get_mem_table(int vid, struct rte_vhost_memory **mem)
 454 {
 455         struct virtio_net *dev;
 456         struct rte_vhost_memory *m;
 457         size_t size;
 458
 459         dev = get_device(vid);
 460         if (!dev)
 461                 return -1;
 462
 463         size = dev->mem->nregions * sizeof(struct rte_vhost_mem_region);
 464         m = malloc(sizeof(struct rte_vhost_memory) + size);
 465         if (!m)
 466                 return -1;
 467
 468         m->nregions = dev->mem->nregions;
 469         memcpy(m->regions, dev->mem->regions, size);
 470         *mem = m;
 471
 472         return 0;
 473 }
 474
 475 int
 476 rte_vhost_get_vhost_vring(int vid, uint16_t vring_idx,
 477                           struct rte_vhost_vring *vring)
 478 {
 479         struct virtio_net *dev;
 480         struct vhost_virtqueue *vq;
 481
 482         dev = get_device(vid);
 483         if (!dev)
 484                 return -1;
 485
 486         if (vring_idx >= VHOST_MAX_VRING)
 487                 return -1;
 488
 489         vq = dev->virtqueue[vring_idx];
 490         if (!vq)
 491                 return -1;
 492
 493         vring->desc  = vq->desc;
 494         vring->avail = vq->avail;
 495         vring->used  = vq->used;
 496         vring->log_guest_addr  = vq->log_guest_addr;
 497
 498         vring->callfd  = vq->callfd;
 499         vring->kickfd  = vq->kickfd;
 500         vring->size    = vq->size;
 501
 502         return 0;
 503 }
 504
 505 int
 506 rte_vhost_vring_call(int vid, uint16_t vring_idx)
 507 {
 508         struct virtio_net *dev;
 509         struct vhost_virtqueue *vq;
 510
 511         dev = get_device(vid);
 512         if (!dev)
 513                 return -1;
 514
 515         if (vring_idx >= VHOST_MAX_VRING)
 516                 return -1;
 517
 518         vq = dev->virtqueue[vring_idx];
 519         if (!vq)
 520                 return -1;
 521
 522         vhost_vring_call(dev, vq);
 523         return 0;
 524 }
 525
 526 uint16_t
 527 rte_vhost_avail_entries(int vid, uint16_t queue_id)
 528 {
 529         struct virtio_net *dev;
 530         struct vhost_virtqueue *vq;
 531
 532         dev = get_device(vid);
 533         if (!dev)
 534                 return 0;
 535
 536         vq = dev->virtqueue[queue_id];
 537         if (!vq->enabled)
 538                 return 0;
 539
 540         return *(volatile uint16_t *)&vq->avail->idx - vq->last_used_idx;
 541 }
 542
 543 int
 544 rte_vhost_enable_guest_notification(int vid, uint16_t queue_id, int enable)
 545 {
 546         struct virtio_net *dev = get_device(vid);
 547
 548         if (dev == NULL)
 549                 return -1;
 550
 551         if (enable) {
 552                 RTE_LOG(ERR, VHOST_CONFIG,
 553                         "guest notification isn't supported.\n");
 554                 return -1;
 555         }
 556
 557         dev->virtqueue[queue_id]->used->flags = VRING_USED_F_NO_NOTIFY;
 558         return 0;
 559 }
 560
 561 void
 562 rte_vhost_log_write(int vid, uint64_t addr, uint64_t len)
 563 {
 564         struct virtio_net *dev = get_device(vid);
 565
 566         if (dev == NULL)
 567                 return;
 568
 569         vhost_log_write(dev, addr, len);
 570 }
 571
 572 void
 573 rte_vhost_log_used_vring(int vid, uint16_t vring_idx,
 574                          uint64_t offset, uint64_t len)
 575 {
 576         struct virtio_net *dev;
 577         struct vhost_virtqueue *vq;
 578
 579         dev = get_device(vid);
 580         if (dev == NULL)
 581                 return;
 582
 583         if (vring_idx >= VHOST_MAX_VRING)
 584                 return;
 585         vq = dev->virtqueue[vring_idx];
 586         if (!vq)
 587                 return;
 588
 589         vhost_log_used_vring(dev, vq, offset, len);
 590 }
 591
 592 uint32_t
 593 rte_vhost_rx_queue_count(int vid, uint16_t qid)
 594 {
 595         struct virtio_net *dev;
 596         struct vhost_virtqueue *vq;
 597
 598         dev = get_device(vid);
 599         if (dev == NULL)
 600                 return 0;
 601
 602         if (unlikely(qid >= dev->nr_vring || (qid & 1) == 0)) {
 603                 RTE_LOG(ERR, VHOST_DATA, "(%d) %s: invalid virtqueue idx %d.\n",
 604                         dev->vid, __func__, qid);
 605                 return 0;
 606         }
 607
 608         vq = dev->virtqueue[qid];
 609         if (vq == NULL)
 610                 return 0;
 611
 612         if (unlikely(vq->enabled == 0 || vq->avail == NULL))
 613                 return 0;
 614
 615         return *((volatile uint16_t *)&vq->avail->idx) - vq->last_avail_idx;
 616 }