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
 236         dev->nr_vring += 1;
 237
 238         return 0;
 239 }
 240
 241 /*
 242  * Reset some variables in device structure, while keeping few
 243  * others untouched, such as vid, ifname, nr_vring: they
 244  * should be same unless the device is removed.
 245  */
 246 void
 247 reset_device(struct virtio_net *dev)
 248 {
 249         uint32_t i;
 250
 251         dev->features = 0;
 252         dev->protocol_features = 0;
 253         dev->flags = 0;
 254
 255         for (i = 0; i < dev->nr_vring; i++)
 256                 reset_vring_queue(dev, i);
 257 }
 258
 259 /*
 260  * Invoked when there is a new vhost-user connection established (when
 261  * there is a new virtio device being attached).
 262  */
 263 int
 264 vhost_new_device(void)
 265 {
 266         struct virtio_net *dev;
 267         int i;
 268
 269         dev = rte_zmalloc(NULL, sizeof(struct virtio_net), 0);
 270         if (dev == NULL) {
 271                 RTE_LOG(ERR, VHOST_CONFIG,
 272                         "Failed to allocate memory for new dev.\n");
 273                 return -1;
 274         }
 275
 276         for (i = 0; i < MAX_VHOST_DEVICE; i++) {
 277                 if (vhost_devices[i] == NULL)
 278                         break;
 279         }
 280         if (i == MAX_VHOST_DEVICE) {
 281                 RTE_LOG(ERR, VHOST_CONFIG,
 282                         "Failed to find a free slot for new device.\n");
 283                 rte_free(dev);
 284                 return -1;
 285         }
 286
 287         vhost_devices[i] = dev;
 288         dev->vid = i;
 289         dev->slave_req_fd = -1;
 290
 291         return i;
 292 }
 293
 294 /*
 295  * Invoked when there is the vhost-user connection is broken (when
 296  * the virtio device is being detached).
 297  */
 298 void
 299 vhost_destroy_device(int vid)
 300 {
 301         struct virtio_net *dev = get_device(vid);
 302
 303         if (dev == NULL)
 304                 return;
 305
 306         if (dev->flags & VIRTIO_DEV_RUNNING) {
 307                 dev->flags &= ~VIRTIO_DEV_RUNNING;
 308                 dev->notify_ops->destroy_device(vid);
 309         }
 310
 311         cleanup_device(dev, 1);
 312         free_device(dev);
 313
 314         vhost_devices[vid] = NULL;
 315 }
 316
 317 void
 318 vhost_set_ifname(int vid, const char *if_name, unsigned int if_len)
 319 {
 320         struct virtio_net *dev;
 321         unsigned int len;
 322
 323         dev = get_device(vid);
 324         if (dev == NULL)
 325                 return;
 326
 327         len = if_len > sizeof(dev->ifname) ?
 328                 sizeof(dev->ifname) : if_len;
 329
 330         strncpy(dev->ifname, if_name, len);
 331         dev->ifname[sizeof(dev->ifname) - 1] = '\0';
 332 }
 333
 334 void
 335 vhost_enable_dequeue_zero_copy(int vid)
 336 {
 337         struct virtio_net *dev = get_device(vid);
 338
 339         if (dev == NULL)
 340                 return;
 341
 342         dev->dequeue_zero_copy = 1;
 343 }
 344
 345 int
 346 rte_vhost_get_mtu(int vid, uint16_t *mtu)
 347 {
 348         struct virtio_net *dev = get_device(vid);
 349
 350         if (!dev)
 351                 return -ENODEV;
 352
 353         if (!(dev->flags & VIRTIO_DEV_READY))
 354                 return -EAGAIN;
 355
 356         if (!(dev->features & (1ULL << VIRTIO_NET_F_MTU)))
 357                 return -ENOTSUP;
 358
 359         *mtu = dev->mtu;
 360
 361         return 0;
 362 }
 363
 364 int
 365 rte_vhost_get_numa_node(int vid)
 366 {
 367 #ifdef RTE_LIBRTE_VHOST_NUMA
 368         struct virtio_net *dev = get_device(vid);
 369         int numa_node;
 370         int ret;
 371
 372         if (dev == NULL)
 373                 return -1;
 374
 375         ret = get_mempolicy(&numa_node, NULL, 0, dev,
 376                             MPOL_F_NODE | MPOL_F_ADDR);
 377         if (ret < 0) {
 378                 RTE_LOG(ERR, VHOST_CONFIG,
 379                         "(%d) failed to query numa node: %s\n",
 380                         vid, rte_strerror(errno));
 381                 return -1;
 382         }
 383
 384         return numa_node;
 385 #else
 386         RTE_SET_USED(vid);
 387         return -1;
 388 #endif
 389 }
 390
 391 uint32_t
 392 rte_vhost_get_queue_num(int vid)
 393 {
 394         struct virtio_net *dev = get_device(vid);
 395
 396         if (dev == NULL)
 397                 return 0;
 398
 399         return dev->nr_vring / 2;
 400 }
 401
 402 uint16_t
 403 rte_vhost_get_vring_num(int vid)
 404 {
 405         struct virtio_net *dev = get_device(vid);
 406
 407         if (dev == NULL)
 408                 return 0;
 409
 410         return dev->nr_vring;
 411 }
 412
 413 int
 414 rte_vhost_get_ifname(int vid, char *buf, size_t len)
 415 {
 416         struct virtio_net *dev = get_device(vid);
 417
 418         if (dev == NULL)
 419                 return -1;
 420
 421         len = RTE_MIN(len, sizeof(dev->ifname));
 422
 423         strncpy(buf, dev->ifname, len);
 424         buf[len - 1] = '\0';
 425
 426         return 0;
 427 }
 428
 429 int
 430 rte_vhost_get_negotiated_features(int vid, uint64_t *features)
 431 {
 432         struct virtio_net *dev;
 433
 434         dev = get_device(vid);
 435         if (!dev)
 436                 return -1;
 437
 438         *features = dev->features;
 439         return 0;
 440 }
 441
 442 int
 443 rte_vhost_get_mem_table(int vid, struct rte_vhost_memory **mem)
 444 {
 445         struct virtio_net *dev;
 446         struct rte_vhost_memory *m;
 447         size_t size;
 448
 449         dev = get_device(vid);
 450         if (!dev)
 451                 return -1;
 452
 453         size = dev->mem->nregions * sizeof(struct rte_vhost_mem_region);
 454         m = malloc(sizeof(struct rte_vhost_memory) + size);
 455         if (!m)
 456                 return -1;
 457
 458         m->nregions = dev->mem->nregions;
 459         memcpy(m->regions, dev->mem->regions, size);
 460         *mem = m;
 461
 462         return 0;
 463 }
 464
 465 int
 466 rte_vhost_get_vhost_vring(int vid, uint16_t vring_idx,
 467                           struct rte_vhost_vring *vring)
 468 {
 469         struct virtio_net *dev;
 470         struct vhost_virtqueue *vq;
 471
 472         dev = get_device(vid);
 473         if (!dev)
 474                 return -1;
 475
 476         if (vring_idx >= VHOST_MAX_VRING)
 477                 return -1;
 478
 479         vq = dev->virtqueue[vring_idx];
 480         if (!vq)
 481                 return -1;
 482
 483         vring->desc  = vq->desc;
 484         vring->avail = vq->avail;
 485         vring->used  = vq->used;
 486         vring->log_guest_addr  = vq->log_guest_addr;
 487
 488         vring->callfd  = vq->callfd;
 489         vring->kickfd  = vq->kickfd;
 490         vring->size    = vq->size;
 491
 492         return 0;
 493 }
 494
 495 int
 496 rte_vhost_vring_call(int vid, uint16_t vring_idx)
 497 {
 498         struct virtio_net *dev;
 499         struct vhost_virtqueue *vq;
 500
 501         dev = get_device(vid);
 502         if (!dev)
 503                 return -1;
 504
 505         if (vring_idx >= VHOST_MAX_VRING)
 506                 return -1;
 507
 508         vq = dev->virtqueue[vring_idx];
 509         if (!vq)
 510                 return -1;
 511
 512         vhost_vring_call(dev, vq);
 513         return 0;
 514 }
 515
 516 uint16_t
 517 rte_vhost_avail_entries(int vid, uint16_t queue_id)
 518 {
 519         struct virtio_net *dev;
 520         struct vhost_virtqueue *vq;
 521
 522         dev = get_device(vid);
 523         if (!dev)
 524                 return 0;
 525
 526         vq = dev->virtqueue[queue_id];
 527         if (!vq->enabled)
 528                 return 0;
 529
 530         return *(volatile uint16_t *)&vq->avail->idx - vq->last_used_idx;
 531 }
 532
 533 int
 534 rte_vhost_enable_guest_notification(int vid, uint16_t queue_id, int enable)
 535 {
 536         struct virtio_net *dev = get_device(vid);
 537
 538         if (dev == NULL)
 539                 return -1;
 540
 541         if (enable) {
 542                 RTE_LOG(ERR, VHOST_CONFIG,
 543                         "guest notification isn't supported.\n");
 544                 return -1;
 545         }
 546
 547         dev->virtqueue[queue_id]->used->flags = VRING_USED_F_NO_NOTIFY;
 548         return 0;
 549 }
 550
 551 void
 552 rte_vhost_log_write(int vid, uint64_t addr, uint64_t len)
 553 {
 554         struct virtio_net *dev = get_device(vid);
 555
 556         if (dev == NULL)
 557                 return;
 558
 559         vhost_log_write(dev, addr, len);
 560 }
 561
 562 void
 563 rte_vhost_log_used_vring(int vid, uint16_t vring_idx,
 564                          uint64_t offset, uint64_t len)
 565 {
 566         struct virtio_net *dev;
 567         struct vhost_virtqueue *vq;
 568
 569         dev = get_device(vid);
 570         if (dev == NULL)
 571                 return;
 572
 573         if (vring_idx >= VHOST_MAX_VRING)
 574                 return;
 575         vq = dev->virtqueue[vring_idx];
 576         if (!vq)
 577                 return;
 578
 579         vhost_log_used_vring(dev, vq, offset, len);
 580 }
 581
 582 uint32_t
 583 rte_vhost_rx_queue_count(int vid, uint16_t qid)
 584 {
 585         struct virtio_net *dev;
 586         struct vhost_virtqueue *vq;
 587
 588         dev = get_device(vid);
 589         if (dev == NULL)
 590                 return 0;
 591
 592         if (unlikely(qid >= dev->nr_vring || (qid & 1) == 0)) {
 593                 RTE_LOG(ERR, VHOST_DATA, "(%d) %s: invalid virtqueue idx %d.\n",
 594                         dev->vid, __func__, qid);
 595                 return 0;
 596         }
 597
 598         vq = dev->virtqueue[qid];
 599         if (vq == NULL)
 600                 return 0;
 601
 602         if (unlikely(vq->enabled == 0 || vq->avail == NULL))
 603                 return 0;
 604
 605         return *((volatile uint16_t *)&vq->avail->idx) - vq->last_avail_idx;
 606 }