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