lib/librte_vhost/vhost_user.c

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(c) 2010-2016 Intel Corporation
   3  */
   4
   5 #include <stdint.h>
   6 #include <stdio.h>
   7 #include <stdlib.h>
   8 #include <string.h>
   9 #include <unistd.h>
  10 #include <sys/mman.h>
  11 #include <sys/types.h>
  12 #include <sys/stat.h>
  13 #include <assert.h>
  14 #ifdef RTE_LIBRTE_VHOST_NUMA
  15 #include <numaif.h>
  16 #endif
  17
  18 #include <rte_common.h>
  19 #include <rte_malloc.h>
  20 #include <rte_log.h>
  21
  22 #include "iotlb.h"
  23 #include "vhost.h"
  24 #include "vhost_user.h"
  25
  26 #define VIRTIO_MIN_MTU 68
  27 #define VIRTIO_MAX_MTU 65535
  28
  29 static const char *vhost_message_str[VHOST_USER_MAX] = {
  30         [VHOST_USER_NONE] = "VHOST_USER_NONE",
  31         [VHOST_USER_GET_FEATURES] = "VHOST_USER_GET_FEATURES",
  32         [VHOST_USER_SET_FEATURES] = "VHOST_USER_SET_FEATURES",
  33         [VHOST_USER_SET_OWNER] = "VHOST_USER_SET_OWNER",
  34         [VHOST_USER_RESET_OWNER] = "VHOST_USER_RESET_OWNER",
  35         [VHOST_USER_SET_MEM_TABLE] = "VHOST_USER_SET_MEM_TABLE",
  36         [VHOST_USER_SET_LOG_BASE] = "VHOST_USER_SET_LOG_BASE",
  37         [VHOST_USER_SET_LOG_FD] = "VHOST_USER_SET_LOG_FD",
  38         [VHOST_USER_SET_VRING_NUM] = "VHOST_USER_SET_VRING_NUM",
  39         [VHOST_USER_SET_VRING_ADDR] = "VHOST_USER_SET_VRING_ADDR",
  40         [VHOST_USER_SET_VRING_BASE] = "VHOST_USER_SET_VRING_BASE",
  41         [VHOST_USER_GET_VRING_BASE] = "VHOST_USER_GET_VRING_BASE",
  42         [VHOST_USER_SET_VRING_KICK] = "VHOST_USER_SET_VRING_KICK",
  43         [VHOST_USER_SET_VRING_CALL] = "VHOST_USER_SET_VRING_CALL",
  44         [VHOST_USER_SET_VRING_ERR]  = "VHOST_USER_SET_VRING_ERR",
  45         [VHOST_USER_GET_PROTOCOL_FEATURES]  = "VHOST_USER_GET_PROTOCOL_FEATURES",
  46         [VHOST_USER_SET_PROTOCOL_FEATURES]  = "VHOST_USER_SET_PROTOCOL_FEATURES",
  47         [VHOST_USER_GET_QUEUE_NUM]  = "VHOST_USER_GET_QUEUE_NUM",
  48         [VHOST_USER_SET_VRING_ENABLE]  = "VHOST_USER_SET_VRING_ENABLE",
  49         [VHOST_USER_SEND_RARP]  = "VHOST_USER_SEND_RARP",
  50         [VHOST_USER_NET_SET_MTU]  = "VHOST_USER_NET_SET_MTU",
  51         [VHOST_USER_SET_SLAVE_REQ_FD]  = "VHOST_USER_SET_SLAVE_REQ_FD",
  52         [VHOST_USER_IOTLB_MSG]  = "VHOST_USER_IOTLB_MSG",
  53 };
  54
  55 static uint64_t
  56 get_blk_size(int fd)
  57 {
  58         struct stat stat;
  59         int ret;
  60
  61         ret = fstat(fd, &stat);
  62         return ret == -1 ? (uint64_t)-1 : (uint64_t)stat.st_blksize;
  63 }
  64
  65 static void
  66 free_mem_region(struct virtio_net *dev)
  67 {
  68         uint32_t i;
  69         struct rte_vhost_mem_region *reg;
  70
  71         if (!dev || !dev->mem)
  72                 return;
  73
  74         for (i = 0; i < dev->mem->nregions; i++) {
  75                 reg = &dev->mem->regions[i];
  76                 if (reg->host_user_addr) {
  77                         munmap(reg->mmap_addr, reg->mmap_size);
  78                         close(reg->fd);
  79                 }
  80         }
  81 }
  82
  83 void
  84 vhost_backend_cleanup(struct virtio_net *dev)
  85 {
  86         if (dev->mem) {
  87                 free_mem_region(dev);
  88                 rte_free(dev->mem);
  89                 dev->mem = NULL;
  90         }
  91
  92         free(dev->guest_pages);
  93         dev->guest_pages = NULL;
  94
  95         if (dev->log_addr) {
  96                 munmap((void *)(uintptr_t)dev->log_addr, dev->log_size);
  97                 dev->log_addr = 0;
  98         }
  99
 100         if (dev->slave_req_fd >= 0) {
 101                 close(dev->slave_req_fd);
 102                 dev->slave_req_fd = -1;
 103         }
 104 }
 105
 106 /*
 107  * This function just returns success at the moment unless
 108  * the device hasn't been initialised.
 109  */
 110 static int
 111 vhost_user_set_owner(void)
 112 {
 113         return 0;
 114 }
 115
 116 static int
 117 vhost_user_reset_owner(struct virtio_net *dev)
 118 {
 119         if (dev->flags & VIRTIO_DEV_RUNNING) {
 120                 dev->flags &= ~VIRTIO_DEV_RUNNING;
 121                 dev->notify_ops->destroy_device(dev->vid);
 122         }
 123
 124         cleanup_device(dev, 0);
 125         reset_device(dev);
 126         return 0;
 127 }
 128
 129 /*
 130  * The features that we support are requested.
 131  */
 132 static uint64_t
 133 vhost_user_get_features(struct virtio_net *dev)
 134 {
 135         uint64_t features = 0;
 136
 137         rte_vhost_driver_get_features(dev->ifname, &features);
 138         return features;
 139 }
 140
 141 /*
 142  * We receive the negotiated features supported by us and the virtio device.
 143  */
 144 static int
 145 vhost_user_set_features(struct virtio_net *dev, uint64_t features)
 146 {
 147         uint64_t vhost_features = 0;
 148
 149         rte_vhost_driver_get_features(dev->ifname, &vhost_features);
 150         if (features & ~vhost_features) {
 151                 RTE_LOG(ERR, VHOST_CONFIG,
 152                         "(%d) received invalid negotiated features.\n",
 153                         dev->vid);
 154                 return -1;
 155         }
 156
 157         if (dev->flags & VIRTIO_DEV_RUNNING) {
 158                 if (dev->features == features)
 159                         return 0;
 160
 161                 /*
 162                  * Error out if master tries to change features while device is
 163                  * in running state. The exception being VHOST_F_LOG_ALL, which
 164                  * is enabled when the live-migration starts.
 165                  */
 166                 if ((dev->features ^ features) & ~(1ULL << VHOST_F_LOG_ALL)) {
 167                         RTE_LOG(ERR, VHOST_CONFIG,
 168                                 "(%d) features changed while device is running.\n",
 169                                 dev->vid);
 170                         return -1;
 171                 }
 172
 173                 if (dev->notify_ops->features_changed)
 174                         dev->notify_ops->features_changed(dev->vid, features);
 175         }
 176
 177         dev->features = features;
 178         if (dev->features &
 179                 ((1 << VIRTIO_NET_F_MRG_RXBUF) | (1ULL << VIRTIO_F_VERSION_1))) {
 180                 dev->vhost_hlen = sizeof(struct virtio_net_hdr_mrg_rxbuf);
 181         } else {
 182                 dev->vhost_hlen = sizeof(struct virtio_net_hdr);
 183         }
 184         LOG_DEBUG(VHOST_CONFIG,
 185                 "(%d) mergeable RX buffers %s, virtio 1 %s\n",
 186                 dev->vid,
 187                 (dev->features & (1 << VIRTIO_NET_F_MRG_RXBUF)) ? "on" : "off",
 188                 (dev->features & (1ULL << VIRTIO_F_VERSION_1)) ? "on" : "off");
 189
 190         if ((dev->flags & VIRTIO_DEV_BUILTIN_VIRTIO_NET) &&
 191             !(dev->features & (1ULL << VIRTIO_NET_F_MQ))) {
 192                 /*
 193                  * Remove all but first queue pair if MQ hasn't been
 194                  * negotiated. This is safe because the device is not
 195                  * running at this stage.
 196                  */
 197                 while (dev->nr_vring > 2) {
 198                         struct vhost_virtqueue *vq;
 199
 200                         vq = dev->virtqueue[--dev->nr_vring];
 201                         if (!vq)
 202                                 continue;
 203
 204                         dev->virtqueue[dev->nr_vring] = NULL;
 205                         cleanup_vq(vq, 1);
 206                         free_vq(vq);
 207                 }
 208         }
 209
 210         return 0;
 211 }
 212
 213 /*
 214  * The virtio device sends us the size of the descriptor ring.
 215  */
 216 static int
 217 vhost_user_set_vring_num(struct virtio_net *dev,
 218                          VhostUserMsg *msg)
 219 {
 220         struct vhost_virtqueue *vq = dev->virtqueue[msg->payload.state.index];
 221
 222         vq->size = msg->payload.state.num;
 223
 224         if (dev->dequeue_zero_copy) {
 225                 vq->nr_zmbuf = 0;
 226                 vq->last_zmbuf_idx = 0;
 227                 vq->zmbuf_size = vq->size;
 228                 vq->zmbufs = rte_zmalloc(NULL, vq->zmbuf_size *
 229                                          sizeof(struct zcopy_mbuf), 0);
 230                 if (vq->zmbufs == NULL) {
 231                         RTE_LOG(WARNING, VHOST_CONFIG,
 232                                 "failed to allocate mem for zero copy; "
 233                                 "zero copy is force disabled\n");
 234                         dev->dequeue_zero_copy = 0;
 235                 }
 236                 TAILQ_INIT(&vq->zmbuf_list);
 237         }
 238
 239         vq->shadow_used_ring = rte_malloc(NULL,
 240                                 vq->size * sizeof(struct vring_used_elem),
 241                                 RTE_CACHE_LINE_SIZE);
 242         if (!vq->shadow_used_ring) {
 243                 RTE_LOG(ERR, VHOST_CONFIG,
 244                         "failed to allocate memory for shadow used ring.\n");
 245                 return -1;
 246         }
 247
 248         vq->batch_copy_elems = rte_malloc(NULL,
 249                                 vq->size * sizeof(struct batch_copy_elem),
 250                                 RTE_CACHE_LINE_SIZE);
 251         if (!vq->batch_copy_elems) {
 252                 RTE_LOG(ERR, VHOST_CONFIG,
 253                         "failed to allocate memory for batching copy.\n");
 254                 return -1;
 255         }
 256
 257         return 0;
 258 }
 259
 260 /*
 261  * Reallocate virtio_dev and vhost_virtqueue data structure to make them on the
 262  * same numa node as the memory of vring descriptor.
 263  */
 264 #ifdef RTE_LIBRTE_VHOST_NUMA
 265 static struct virtio_net*
 266 numa_realloc(struct virtio_net *dev, int index)
 267 {
 268         int oldnode, newnode;
 269         struct virtio_net *old_dev;
 270         struct vhost_virtqueue *old_vq, *vq;
 271         struct zcopy_mbuf *new_zmbuf;
 272         struct vring_used_elem *new_shadow_used_ring;
 273         struct batch_copy_elem *new_batch_copy_elems;
 274         int ret;
 275
 276         old_dev = dev;
 277         vq = old_vq = dev->virtqueue[index];
 278
 279         ret = get_mempolicy(&newnode, NULL, 0, old_vq->desc,
 280                             MPOL_F_NODE | MPOL_F_ADDR);
 281
 282         /* check if we need to reallocate vq */
 283         ret |= get_mempolicy(&oldnode, NULL, 0, old_vq,
 284                              MPOL_F_NODE | MPOL_F_ADDR);
 285         if (ret) {
 286                 RTE_LOG(ERR, VHOST_CONFIG,
 287                         "Unable to get vq numa information.\n");
 288                 return dev;
 289         }
 290         if (oldnode != newnode) {
 291                 RTE_LOG(INFO, VHOST_CONFIG,
 292                         "reallocate vq from %d to %d node\n", oldnode, newnode);
 293                 vq = rte_malloc_socket(NULL, sizeof(*vq), 0, newnode);
 294                 if (!vq)
 295                         return dev;
 296
 297                 memcpy(vq, old_vq, sizeof(*vq));
 298                 TAILQ_INIT(&vq->zmbuf_list);
 299
 300                 new_zmbuf = rte_malloc_socket(NULL, vq->zmbuf_size *
 301                         sizeof(struct zcopy_mbuf), 0, newnode);
 302                 if (new_zmbuf) {
 303                         rte_free(vq->zmbufs);
 304                         vq->zmbufs = new_zmbuf;
 305                 }
 306
 307                 new_shadow_used_ring = rte_malloc_socket(NULL,
 308                         vq->size * sizeof(struct vring_used_elem),
 309                         RTE_CACHE_LINE_SIZE,
 310                         newnode);
 311                 if (new_shadow_used_ring) {
 312                         rte_free(vq->shadow_used_ring);
 313                         vq->shadow_used_ring = new_shadow_used_ring;
 314                 }
 315
 316                 new_batch_copy_elems = rte_malloc_socket(NULL,
 317                         vq->size * sizeof(struct batch_copy_elem),
 318                         RTE_CACHE_LINE_SIZE,
 319                         newnode);
 320                 if (new_batch_copy_elems) {
 321                         rte_free(vq->batch_copy_elems);
 322                         vq->batch_copy_elems = new_batch_copy_elems;
 323                 }
 324
 325                 rte_free(old_vq);
 326         }
 327
 328         /* check if we need to reallocate dev */
 329         ret = get_mempolicy(&oldnode, NULL, 0, old_dev,
 330                             MPOL_F_NODE | MPOL_F_ADDR);
 331         if (ret) {
 332                 RTE_LOG(ERR, VHOST_CONFIG,
 333                         "Unable to get dev numa information.\n");
 334                 goto out;
 335         }
 336         if (oldnode != newnode) {
 337                 RTE_LOG(INFO, VHOST_CONFIG,
 338                         "reallocate dev from %d to %d node\n",
 339                         oldnode, newnode);
 340                 dev = rte_malloc_socket(NULL, sizeof(*dev), 0, newnode);
 341                 if (!dev) {
 342                         dev = old_dev;
 343                         goto out;
 344                 }
 345
 346                 memcpy(dev, old_dev, sizeof(*dev));
 347                 rte_free(old_dev);
 348         }
 349
 350 out:
 351         dev->virtqueue[index] = vq;
 352         vhost_devices[dev->vid] = dev;
 353
 354         if (old_vq != vq)
 355                 vhost_user_iotlb_init(dev, index);
 356
 357         return dev;
 358 }
 359 #else
 360 static struct virtio_net*
 361 numa_realloc(struct virtio_net *dev, int index __rte_unused)
 362 {
 363         return dev;
 364 }
 365 #endif
 366
 367 /* Converts QEMU virtual address to Vhost virtual address. */
 368 static uint64_t
 369 qva_to_vva(struct virtio_net *dev, uint64_t qva, uint64_t *len)
 370 {
 371         struct rte_vhost_mem_region *r;
 372         uint32_t i;
 373
 374         /* Find the region where the address lives. */
 375         for (i = 0; i < dev->mem->nregions; i++) {
 376                 r = &dev->mem->regions[i];
 377
 378                 if (qva >= r->guest_user_addr &&
 379                     qva <  r->guest_user_addr + r->size) {
 380
 381                         if (unlikely(*len > r->guest_user_addr + r->size - qva))
 382                                 *len = r->guest_user_addr + r->size - qva;
 383
 384                         return qva - r->guest_user_addr +
 385                                r->host_user_addr;
 386                 }
 387         }
 388         *len = 0;
 389
 390         return 0;
 391 }
 392
 393
 394 /*
 395  * Converts ring address to Vhost virtual address.
 396  * If IOMMU is enabled, the ring address is a guest IO virtual address,
 397  * else it is a QEMU virtual address.
 398  */
 399 static uint64_t
 400 ring_addr_to_vva(struct virtio_net *dev, struct vhost_virtqueue *vq,
 401                 uint64_t ra, uint64_t *size)
 402 {
 403         if (dev->features & (1ULL << VIRTIO_F_IOMMU_PLATFORM)) {
 404                 uint64_t vva;
 405
 406                 vva = vhost_user_iotlb_cache_find(vq, ra,
 407                                         size, VHOST_ACCESS_RW);
 408                 if (!vva)
 409                         vhost_user_iotlb_miss(dev, ra, VHOST_ACCESS_RW);
 410
 411                 return vva;
 412         }
 413
 414         return qva_to_vva(dev, ra, size);
 415 }
 416
 417 static struct virtio_net *
 418 translate_ring_addresses(struct virtio_net *dev, int vq_index)
 419 {
 420         struct vhost_virtqueue *vq = dev->virtqueue[vq_index];
 421         struct vhost_vring_addr *addr = &vq->ring_addrs;
 422         uint64_t len;
 423
 424         /* The addresses are converted from QEMU virtual to Vhost virtual. */
 425         if (vq->desc && vq->avail && vq->used)
 426                 return dev;
 427
 428         len = sizeof(struct vring_desc) * vq->size;
 429         vq->desc = (struct vring_desc *)(uintptr_t)ring_addr_to_vva(dev,
 430                         vq, addr->desc_user_addr, &len);
 431         if (vq->desc == 0 || len != sizeof(struct vring_desc) * vq->size) {
 432                 RTE_LOG(DEBUG, VHOST_CONFIG,
 433                         "(%d) failed to map desc ring.\n",
 434                         dev->vid);
 435                 return dev;
 436         }
 437
 438         dev = numa_realloc(dev, vq_index);
 439         vq = dev->virtqueue[vq_index];
 440         addr = &vq->ring_addrs;
 441
 442         len = sizeof(struct vring_avail) + sizeof(uint16_t) * vq->size;
 443         vq->avail = (struct vring_avail *)(uintptr_t)ring_addr_to_vva(dev,
 444                         vq, addr->avail_user_addr, &len);
 445         if (vq->avail == 0 ||
 446                         len != sizeof(struct vring_avail) +
 447                         sizeof(uint16_t) * vq->size) {
 448                 RTE_LOG(DEBUG, VHOST_CONFIG,
 449                         "(%d) failed to map avail ring.\n",
 450                         dev->vid);
 451                 return dev;
 452         }
 453
 454         len = sizeof(struct vring_used) +
 455                 sizeof(struct vring_used_elem) * vq->size;
 456         vq->used = (struct vring_used *)(uintptr_t)ring_addr_to_vva(dev,
 457                         vq, addr->used_user_addr, &len);
 458         if (vq->used == 0 || len != sizeof(struct vring_used) +
 459                         sizeof(struct vring_used_elem) * vq->size) {
 460                 RTE_LOG(DEBUG, VHOST_CONFIG,
 461                         "(%d) failed to map used ring.\n",
 462                         dev->vid);
 463                 return dev;
 464         }
 465
 466         if (vq->last_used_idx != vq->used->idx) {
 467                 RTE_LOG(WARNING, VHOST_CONFIG,
 468                         "last_used_idx (%u) and vq->used->idx (%u) mismatches; "
 469                         "some packets maybe resent for Tx and dropped for Rx\n",
 470                         vq->last_used_idx, vq->used->idx);
 471                 vq->last_used_idx  = vq->used->idx;
 472                 vq->last_avail_idx = vq->used->idx;
 473         }
 474
 475         vq->log_guest_addr = addr->log_guest_addr;
 476
 477         LOG_DEBUG(VHOST_CONFIG, "(%d) mapped address desc: %p\n",
 478                         dev->vid, vq->desc);
 479         LOG_DEBUG(VHOST_CONFIG, "(%d) mapped address avail: %p\n",
 480                         dev->vid, vq->avail);
 481         LOG_DEBUG(VHOST_CONFIG, "(%d) mapped address used: %p\n",
 482                         dev->vid, vq->used);
 483         LOG_DEBUG(VHOST_CONFIG, "(%d) log_guest_addr: %" PRIx64 "\n",
 484                         dev->vid, vq->log_guest_addr);
 485
 486         return dev;
 487 }
 488
 489 /*
 490  * The virtio device sends us the desc, used and avail ring addresses.
 491  * This function then converts these to our address space.
 492  */
 493 static int
 494 vhost_user_set_vring_addr(struct virtio_net **pdev, VhostUserMsg *msg)
 495 {
 496         struct vhost_virtqueue *vq;
 497         struct vhost_vring_addr *addr = &msg->payload.addr;
 498         struct virtio_net *dev = *pdev;
 499
 500         if (dev->mem == NULL)
 501                 return -1;
 502
 503         /* addr->index refers to the queue index. The txq 1, rxq is 0. */
 504         vq = dev->virtqueue[msg->payload.addr.index];
 505
 506         /*
 507          * Rings addresses should not be interpreted as long as the ring is not
 508          * started and enabled
 509          */
 510         memcpy(&vq->ring_addrs, addr, sizeof(*addr));
 511
 512         vring_invalidate(dev, vq);
 513
 514         if (vq->enabled && (dev->features &
 515                                 (1ULL << VHOST_USER_F_PROTOCOL_FEATURES))) {
 516                 dev = translate_ring_addresses(dev, msg->payload.state.index);
 517                 if (!dev)
 518                         return -1;
 519
 520                 *pdev = dev;
 521         }
 522
 523         return 0;
 524 }
 525
 526 /*
 527  * The virtio device sends us the available ring last used index.
 528  */
 529 static int
 530 vhost_user_set_vring_base(struct virtio_net *dev,
 531                           VhostUserMsg *msg)
 532 {
 533         dev->virtqueue[msg->payload.state.index]->last_used_idx  =
 534                         msg->payload.state.num;
 535         dev->virtqueue[msg->payload.state.index]->last_avail_idx =
 536                         msg->payload.state.num;
 537
 538         return 0;
 539 }
 540
 541 static void
 542 add_one_guest_page(struct virtio_net *dev, uint64_t guest_phys_addr,
 543                    uint64_t host_phys_addr, uint64_t size)
 544 {
 545         struct guest_page *page, *last_page;
 546
 547         if (dev->nr_guest_pages == dev->max_guest_pages) {
 548                 dev->max_guest_pages *= 2;
 549                 dev->guest_pages = realloc(dev->guest_pages,
 550                                         dev->max_guest_pages * sizeof(*page));
 551         }
 552
 553         if (dev->nr_guest_pages > 0) {
 554                 last_page = &dev->guest_pages[dev->nr_guest_pages - 1];
 555                 /* merge if the two pages are continuous */
 556                 if (host_phys_addr == last_page->host_phys_addr +
 557                                       last_page->size) {
 558                         last_page->size += size;
 559                         return;
 560                 }
 561         }
 562
 563         page = &dev->guest_pages[dev->nr_guest_pages++];
 564         page->guest_phys_addr = guest_phys_addr;
 565         page->host_phys_addr  = host_phys_addr;
 566         page->size = size;
 567 }
 568
 569 static void
 570 add_guest_pages(struct virtio_net *dev, struct rte_vhost_mem_region *reg,
 571                 uint64_t page_size)
 572 {
 573         uint64_t reg_size = reg->size;
 574         uint64_t host_user_addr  = reg->host_user_addr;
 575         uint64_t guest_phys_addr = reg->guest_phys_addr;
 576         uint64_t host_phys_addr;
 577         uint64_t size;
 578
 579         host_phys_addr = rte_mem_virt2iova((void *)(uintptr_t)host_user_addr);
 580         size = page_size - (guest_phys_addr & (page_size - 1));
 581         size = RTE_MIN(size, reg_size);
 582
 583         add_one_guest_page(dev, guest_phys_addr, host_phys_addr, size);
 584         host_user_addr  += size;
 585         guest_phys_addr += size;
 586         reg_size -= size;
 587
 588         while (reg_size > 0) {
 589                 size = RTE_MIN(reg_size, page_size);
 590                 host_phys_addr = rte_mem_virt2iova((void *)(uintptr_t)
 591                                                   host_user_addr);
 592                 add_one_guest_page(dev, guest_phys_addr, host_phys_addr, size);
 593
 594                 host_user_addr  += size;
 595                 guest_phys_addr += size;
 596                 reg_size -= size;
 597         }
 598 }
 599
 600 #ifdef RTE_LIBRTE_VHOST_DEBUG
 601 /* TODO: enable it only in debug mode? */
 602 static void
 603 dump_guest_pages(struct virtio_net *dev)
 604 {
 605         uint32_t i;
 606         struct guest_page *page;
 607
 608         for (i = 0; i < dev->nr_guest_pages; i++) {
 609                 page = &dev->guest_pages[i];
 610
 611                 RTE_LOG(INFO, VHOST_CONFIG,
 612                         "guest physical page region %u\n"
 613                         "\t guest_phys_addr: %" PRIx64 "\n"
 614                         "\t host_phys_addr : %" PRIx64 "\n"
 615                         "\t size           : %" PRIx64 "\n",
 616                         i,
 617                         page->guest_phys_addr,
 618                         page->host_phys_addr,
 619                         page->size);
 620         }
 621 }
 622 #else
 623 #define dump_guest_pages(dev)
 624 #endif
 625
 626 static bool
 627 vhost_memory_changed(struct VhostUserMemory *new,
 628                      struct rte_vhost_memory *old)
 629 {
 630         uint32_t i;
 631
 632         if (new->nregions != old->nregions)
 633                 return true;
 634
 635         for (i = 0; i < new->nregions; ++i) {
 636                 VhostUserMemoryRegion *new_r = &new->regions[i];
 637                 struct rte_vhost_mem_region *old_r = &old->regions[i];
 638
 639                 if (new_r->guest_phys_addr != old_r->guest_phys_addr)
 640                         return true;
 641                 if (new_r->memory_size != old_r->size)
 642                         return true;
 643                 if (new_r->userspace_addr != old_r->guest_user_addr)
 644                         return true;
 645         }
 646
 647         return false;
 648 }
 649
 650 static int
 651 vhost_user_set_mem_table(struct virtio_net *dev, struct VhostUserMsg *pmsg)
 652 {
 653         struct VhostUserMemory memory = pmsg->payload.memory;
 654         struct rte_vhost_mem_region *reg;
 655         void *mmap_addr;
 656         uint64_t mmap_size;
 657         uint64_t mmap_offset;
 658         uint64_t alignment;
 659         uint32_t i;
 660         int fd;
 661
 662         if (dev->mem && !vhost_memory_changed(&memory, dev->mem)) {
 663                 RTE_LOG(INFO, VHOST_CONFIG,
 664                         "(%d) memory regions not changed\n", dev->vid);
 665
 666                 for (i = 0; i < memory.nregions; i++)
 667                         close(pmsg->fds[i]);
 668
 669                 return 0;
 670         }
 671
 672         if (dev->mem) {
 673                 free_mem_region(dev);
 674                 rte_free(dev->mem);
 675                 dev->mem = NULL;
 676         }
 677
 678         dev->nr_guest_pages = 0;
 679         if (!dev->guest_pages) {
 680                 dev->max_guest_pages = 8;
 681                 dev->guest_pages = malloc(dev->max_guest_pages *
 682                                                 sizeof(struct guest_page));
 683                 if (dev->guest_pages == NULL) {
 684                         RTE_LOG(ERR, VHOST_CONFIG,
 685                                 "(%d) failed to allocate memory "
 686                                 "for dev->guest_pages\n",
 687                                 dev->vid);
 688                         return -1;
 689                 }
 690         }
 691
 692         dev->mem = rte_zmalloc("vhost-mem-table", sizeof(struct rte_vhost_memory) +
 693                 sizeof(struct rte_vhost_mem_region) * memory.nregions, 0);
 694         if (dev->mem == NULL) {
 695                 RTE_LOG(ERR, VHOST_CONFIG,
 696                         "(%d) failed to allocate memory for dev->mem\n",
 697                         dev->vid);
 698                 return -1;
 699         }
 700         dev->mem->nregions = memory.nregions;
 701
 702         for (i = 0; i < memory.nregions; i++) {
 703                 fd  = pmsg->fds[i];
 704                 reg = &dev->mem->regions[i];
 705
 706                 reg->guest_phys_addr = memory.regions[i].guest_phys_addr;
 707                 reg->guest_user_addr = memory.regions[i].userspace_addr;
 708                 reg->size            = memory.regions[i].memory_size;
 709                 reg->fd              = fd;
 710
 711                 mmap_offset = memory.regions[i].mmap_offset;
 712                 mmap_size   = reg->size + mmap_offset;
 713
 714                 /* mmap() without flag of MAP_ANONYMOUS, should be called
 715                  * with length argument aligned with hugepagesz at older
 716                  * longterm version Linux, like 2.6.32 and 3.2.72, or
 717                  * mmap() will fail with EINVAL.
 718                  *
 719                  * to avoid failure, make sure in caller to keep length
 720                  * aligned.
 721                  */
 722                 alignment = get_blk_size(fd);
 723                 if (alignment == (uint64_t)-1) {
 724                         RTE_LOG(ERR, VHOST_CONFIG,
 725                                 "couldn't get hugepage size through fstat\n");
 726                         goto err_mmap;
 727                 }
 728                 mmap_size = RTE_ALIGN_CEIL(mmap_size, alignment);
 729
 730                 mmap_addr = mmap(NULL, mmap_size, PROT_READ | PROT_WRITE,
 731                                  MAP_SHARED | MAP_POPULATE, fd, 0);
 732
 733                 if (mmap_addr == MAP_FAILED) {
 734                         RTE_LOG(ERR, VHOST_CONFIG,
 735                                 "mmap region %u failed.\n", i);
 736                         goto err_mmap;
 737                 }
 738
 739                 reg->mmap_addr = mmap_addr;
 740                 reg->mmap_size = mmap_size;
 741                 reg->host_user_addr = (uint64_t)(uintptr_t)mmap_addr +
 742                                       mmap_offset;
 743
 744                 if (dev->dequeue_zero_copy)
 745                         add_guest_pages(dev, reg, alignment);
 746
 747                 RTE_LOG(INFO, VHOST_CONFIG,
 748                         "guest memory region %u, size: 0x%" PRIx64 "\n"
 749                         "\t guest physical addr: 0x%" PRIx64 "\n"
 750                         "\t guest virtual  addr: 0x%" PRIx64 "\n"
 751                         "\t host  virtual  addr: 0x%" PRIx64 "\n"
 752                         "\t mmap addr : 0x%" PRIx64 "\n"
 753                         "\t mmap size : 0x%" PRIx64 "\n"
 754                         "\t mmap align: 0x%" PRIx64 "\n"
 755                         "\t mmap off  : 0x%" PRIx64 "\n",
 756                         i, reg->size,
 757                         reg->guest_phys_addr,
 758                         reg->guest_user_addr,
 759                         reg->host_user_addr,
 760                         (uint64_t)(uintptr_t)mmap_addr,
 761                         mmap_size,
 762                         alignment,
 763                         mmap_offset);
 764         }
 765
 766         dump_guest_pages(dev);
 767
 768         return 0;
 769
 770 err_mmap:
 771         free_mem_region(dev);
 772         rte_free(dev->mem);
 773         dev->mem = NULL;
 774         return -1;
 775 }
 776
 777 static int
 778 vq_is_ready(struct vhost_virtqueue *vq)
 779 {
 780         return vq && vq->desc && vq->avail && vq->used &&
 781                vq->kickfd != VIRTIO_UNINITIALIZED_EVENTFD &&
 782                vq->callfd != VIRTIO_UNINITIALIZED_EVENTFD;
 783 }
 784
 785 static int
 786 virtio_is_ready(struct virtio_net *dev)
 787 {
 788         struct vhost_virtqueue *vq;
 789         uint32_t i;
 790
 791         if (dev->nr_vring == 0)
 792                 return 0;
 793
 794         for (i = 0; i < dev->nr_vring; i++) {
 795                 vq = dev->virtqueue[i];
 796
 797                 if (!vq_is_ready(vq))
 798                         return 0;
 799         }
 800
 801         RTE_LOG(INFO, VHOST_CONFIG,
 802                 "virtio is now ready for processing.\n");
 803         return 1;
 804 }
 805
 806 static void
 807 vhost_user_set_vring_call(struct virtio_net *dev, struct VhostUserMsg *pmsg)
 808 {
 809         struct vhost_vring_file file;
 810         struct vhost_virtqueue *vq;
 811
 812         file.index = pmsg->payload.u64 & VHOST_USER_VRING_IDX_MASK;
 813         if (pmsg->payload.u64 & VHOST_USER_VRING_NOFD_MASK)
 814                 file.fd = VIRTIO_INVALID_EVENTFD;
 815         else
 816                 file.fd = pmsg->fds[0];
 817         RTE_LOG(INFO, VHOST_CONFIG,
 818                 "vring call idx:%d file:%d\n", file.index, file.fd);
 819
 820         vq = dev->virtqueue[file.index];
 821         if (vq->callfd >= 0)
 822                 close(vq->callfd);
 823
 824         vq->callfd = file.fd;
 825 }
 826
 827 static void
 828 vhost_user_set_vring_kick(struct virtio_net **pdev, struct VhostUserMsg *pmsg)
 829 {
 830         struct vhost_vring_file file;
 831         struct vhost_virtqueue *vq;
 832         struct virtio_net *dev = *pdev;
 833
 834         file.index = pmsg->payload.u64 & VHOST_USER_VRING_IDX_MASK;
 835         if (pmsg->payload.u64 & VHOST_USER_VRING_NOFD_MASK)
 836                 file.fd = VIRTIO_INVALID_EVENTFD;
 837         else
 838                 file.fd = pmsg->fds[0];
 839         RTE_LOG(INFO, VHOST_CONFIG,
 840                 "vring kick idx:%d file:%d\n", file.index, file.fd);
 841
 842         /* Interpret ring addresses only when ring is started. */
 843         dev = translate_ring_addresses(dev, file.index);
 844         if (!dev)
 845                 return;
 846
 847         *pdev = dev;
 848
 849         vq = dev->virtqueue[file.index];
 850
 851         /*
 852          * When VHOST_USER_F_PROTOCOL_FEATURES is not negotiated,
 853          * the ring starts already enabled. Otherwise, it is enabled via
 854          * the SET_VRING_ENABLE message.
 855          */
 856         if (!(dev->features & (1ULL << VHOST_USER_F_PROTOCOL_FEATURES)))
 857                 vq->enabled = 1;
 858
 859         if (vq->kickfd >= 0)
 860                 close(vq->kickfd);
 861         vq->kickfd = file.fd;
 862 }
 863
 864 static void
 865 free_zmbufs(struct vhost_virtqueue *vq)
 866 {
 867         struct zcopy_mbuf *zmbuf, *next;
 868
 869         for (zmbuf = TAILQ_FIRST(&vq->zmbuf_list);
 870              zmbuf != NULL; zmbuf = next) {
 871                 next = TAILQ_NEXT(zmbuf, next);
 872
 873                 rte_pktmbuf_free(zmbuf->mbuf);
 874                 TAILQ_REMOVE(&vq->zmbuf_list, zmbuf, next);
 875         }
 876
 877         rte_free(vq->zmbufs);
 878 }
 879
 880 /*
 881  * when virtio is stopped, qemu will send us the GET_VRING_BASE message.
 882  */
 883 static int
 884 vhost_user_get_vring_base(struct virtio_net *dev,
 885                           VhostUserMsg *msg)
 886 {
 887         struct vhost_virtqueue *vq = dev->virtqueue[msg->payload.state.index];
 888
 889         /* We have to stop the queue (virtio) if it is running. */
 890         if (dev->flags & VIRTIO_DEV_RUNNING) {
 891                 dev->flags &= ~VIRTIO_DEV_RUNNING;
 892                 dev->notify_ops->destroy_device(dev->vid);
 893         }
 894
 895         dev->flags &= ~VIRTIO_DEV_READY;
 896
 897         /* Here we are safe to get the last used index */
 898         msg->payload.state.num = vq->last_used_idx;
 899
 900         RTE_LOG(INFO, VHOST_CONFIG,
 901                 "vring base idx:%d file:%d\n", msg->payload.state.index,
 902                 msg->payload.state.num);
 903         /*
 904          * Based on current qemu vhost-user implementation, this message is
 905          * sent and only sent in vhost_vring_stop.
 906          * TODO: cleanup the vring, it isn't usable since here.
 907          */
 908         if (vq->kickfd >= 0)
 909                 close(vq->kickfd);
 910
 911         vq->kickfd = VIRTIO_UNINITIALIZED_EVENTFD;
 912
 913         if (dev->dequeue_zero_copy)
 914                 free_zmbufs(vq);
 915         rte_free(vq->shadow_used_ring);
 916         vq->shadow_used_ring = NULL;
 917
 918         rte_free(vq->batch_copy_elems);
 919         vq->batch_copy_elems = NULL;
 920
 921         return 0;
 922 }
 923
 924 /*
 925  * when virtio queues are ready to work, qemu will send us to
 926  * enable the virtio queue pair.
 927  */
 928 static int
 929 vhost_user_set_vring_enable(struct virtio_net *dev,
 930                             VhostUserMsg *msg)
 931 {
 932         int enable = (int)msg->payload.state.num;
 933
 934         RTE_LOG(INFO, VHOST_CONFIG,
 935                 "set queue enable: %d to qp idx: %d\n",
 936                 enable, msg->payload.state.index);
 937
 938         if (dev->notify_ops->vring_state_changed)
 939                 dev->notify_ops->vring_state_changed(dev->vid,
 940                                 msg->payload.state.index, enable);
 941
 942         dev->virtqueue[msg->payload.state.index]->enabled = enable;
 943
 944         return 0;
 945 }
 946
 947 static void
 948 vhost_user_get_protocol_features(struct virtio_net *dev,
 949                                  struct VhostUserMsg *msg)
 950 {
 951         uint64_t features, protocol_features = VHOST_USER_PROTOCOL_FEATURES;
 952
 953         rte_vhost_driver_get_features(dev->ifname, &features);
 954
 955         /*
 956          * REPLY_ACK protocol feature is only mandatory for now
 957          * for IOMMU feature. If IOMMU is explicitly disabled by the
 958          * application, disable also REPLY_ACK feature for older buggy
 959          * Qemu versions (from v2.7.0 to v2.9.0).
 960          */
 961         if (!(features & (1ULL << VIRTIO_F_IOMMU_PLATFORM)))
 962                 protocol_features &= ~(1ULL << VHOST_USER_PROTOCOL_F_REPLY_ACK);
 963
 964         msg->payload.u64 = protocol_features;
 965         msg->size = sizeof(msg->payload.u64);
 966 }
 967
 968 static void
 969 vhost_user_set_protocol_features(struct virtio_net *dev,
 970                                  uint64_t protocol_features)
 971 {
 972         if (protocol_features & ~VHOST_USER_PROTOCOL_FEATURES)
 973                 return;
 974
 975         dev->protocol_features = protocol_features;
 976 }
 977
 978 static int
 979 vhost_user_set_log_base(struct virtio_net *dev, struct VhostUserMsg *msg)
 980 {
 981         int fd = msg->fds[0];
 982         uint64_t size, off;
 983         void *addr;
 984
 985         if (fd < 0) {
 986                 RTE_LOG(ERR, VHOST_CONFIG, "invalid log fd: %d\n", fd);
 987                 return -1;
 988         }
 989
 990         if (msg->size != sizeof(VhostUserLog)) {
 991                 RTE_LOG(ERR, VHOST_CONFIG,
 992                         "invalid log base msg size: %"PRId32" != %d\n",
 993                         msg->size, (int)sizeof(VhostUserLog));
 994                 return -1;
 995         }
 996
 997         size = msg->payload.log.mmap_size;
 998         off  = msg->payload.log.mmap_offset;
 999         RTE_LOG(INFO, VHOST_CONFIG,
1000                 "log mmap size: %"PRId64", offset: %"PRId64"\n",
1001                 size, off);
1002
1003         /*
1004          * mmap from 0 to workaround a hugepage mmap bug: mmap will
1005          * fail when offset is not page size aligned.
1006          */
1007         addr = mmap(0, size, PROT_READ | PROT_WRITE, MAP_SHARED, fd, 0);
1008         close(fd);
1009         if (addr == MAP_FAILED) {
1010                 RTE_LOG(ERR, VHOST_CONFIG, "mmap log base failed!\n");
1011                 return -1;
1012         }
1013
1014         /*
1015          * Free previously mapped log memory on occasionally
1016          * multiple VHOST_USER_SET_LOG_BASE.
1017          */
1018         if (dev->log_addr) {
1019                 munmap((void *)(uintptr_t)dev->log_addr, dev->log_size);
1020         }
1021         dev->log_addr = (uint64_t)(uintptr_t)addr;
1022         dev->log_base = dev->log_addr + off;
1023         dev->log_size = size;
1024
1025         return 0;
1026 }
1027
1028 /*
1029  * An rarp packet is constructed and broadcasted to notify switches about
1030  * the new location of the migrated VM, so that packets from outside will
1031  * not be lost after migration.
1032  *
1033  * However, we don't actually "send" a rarp packet here, instead, we set
1034  * a flag 'broadcast_rarp' to let rte_vhost_dequeue_burst() inject it.
1035  */
1036 static int
1037 vhost_user_send_rarp(struct virtio_net *dev, struct VhostUserMsg *msg)
1038 {
1039         uint8_t *mac = (uint8_t *)&msg->payload.u64;
1040
1041         RTE_LOG(DEBUG, VHOST_CONFIG,
1042                 ":: mac: %02x:%02x:%02x:%02x:%02x:%02x\n",
1043                 mac[0], mac[1], mac[2], mac[3], mac[4], mac[5]);
1044         memcpy(dev->mac.addr_bytes, mac, 6);
1045
1046         /*
1047          * Set the flag to inject a RARP broadcast packet at
1048          * rte_vhost_dequeue_burst().
1049          *
1050          * rte_smp_wmb() is for making sure the mac is copied
1051          * before the flag is set.
1052          */
1053         rte_smp_wmb();
1054         rte_atomic16_set(&dev->broadcast_rarp, 1);
1055
1056         return 0;
1057 }
1058
1059 static int
1060 vhost_user_net_set_mtu(struct virtio_net *dev, struct VhostUserMsg *msg)
1061 {
1062         if (msg->payload.u64 < VIRTIO_MIN_MTU ||
1063                         msg->payload.u64 > VIRTIO_MAX_MTU) {
1064                 RTE_LOG(ERR, VHOST_CONFIG, "Invalid MTU size (%"PRIu64")\n",
1065                                 msg->payload.u64);
1066
1067                 return -1;
1068         }
1069
1070         dev->mtu = msg->payload.u64;
1071
1072         return 0;
1073 }
1074
1075 static int
1076 vhost_user_set_req_fd(struct virtio_net *dev, struct VhostUserMsg *msg)
1077 {
1078         int fd = msg->fds[0];
1079
1080         if (fd < 0) {
1081                 RTE_LOG(ERR, VHOST_CONFIG,
1082                                 "Invalid file descriptor for slave channel (%d)\n",
1083                                 fd);
1084                 return -1;
1085         }
1086
1087         dev->slave_req_fd = fd;
1088
1089         return 0;
1090 }
1091
1092 static int
1093 is_vring_iotlb_update(struct vhost_virtqueue *vq, struct vhost_iotlb_msg *imsg)
1094 {
1095         struct vhost_vring_addr *ra;
1096         uint64_t start, end;
1097
1098         start = imsg->iova;
1099         end = start + imsg->size;
1100
1101         ra = &vq->ring_addrs;
1102         if (ra->desc_user_addr >= start && ra->desc_user_addr < end)
1103                 return 1;
1104         if (ra->avail_user_addr >= start && ra->avail_user_addr < end)
1105                 return 1;
1106         if (ra->used_user_addr >= start && ra->used_user_addr < end)
1107                 return 1;
1108
1109         return 0;
1110 }
1111
1112 static int
1113 is_vring_iotlb_invalidate(struct vhost_virtqueue *vq,
1114                                 struct vhost_iotlb_msg *imsg)
1115 {
1116         uint64_t istart, iend, vstart, vend;
1117
1118         istart = imsg->iova;
1119         iend = istart + imsg->size - 1;
1120
1121         vstart = (uintptr_t)vq->desc;
1122         vend = vstart + sizeof(struct vring_desc) * vq->size - 1;
1123         if (vstart <= iend && istart <= vend)
1124                 return 1;
1125
1126         vstart = (uintptr_t)vq->avail;
1127         vend = vstart + sizeof(struct vring_avail);
1128         vend += sizeof(uint16_t) * vq->size - 1;
1129         if (vstart <= iend && istart <= vend)
1130                 return 1;
1131
1132         vstart = (uintptr_t)vq->used;
1133         vend = vstart + sizeof(struct vring_used);
1134         vend += sizeof(struct vring_used_elem) * vq->size - 1;
1135         if (vstart <= iend && istart <= vend)
1136                 return 1;
1137
1138         return 0;
1139 }
1140
1141 static int
1142 vhost_user_iotlb_msg(struct virtio_net **pdev, struct VhostUserMsg *msg)
1143 {
1144         struct virtio_net *dev = *pdev;
1145         struct vhost_iotlb_msg *imsg = &msg->payload.iotlb;
1146         uint16_t i;
1147         uint64_t vva, len;
1148
1149         switch (imsg->type) {
1150         case VHOST_IOTLB_UPDATE:
1151                 len = imsg->size;
1152                 vva = qva_to_vva(dev, imsg->uaddr, &len);
1153                 if (!vva)
1154                         return -1;
1155
1156                 for (i = 0; i < dev->nr_vring; i++) {
1157                         struct vhost_virtqueue *vq = dev->virtqueue[i];
1158
1159                         vhost_user_iotlb_cache_insert(vq, imsg->iova, vva,
1160                                         len, imsg->perm);
1161
1162                         if (is_vring_iotlb_update(vq, imsg))
1163                                 *pdev = dev = translate_ring_addresses(dev, i);
1164                 }
1165                 break;
1166         case VHOST_IOTLB_INVALIDATE:
1167                 for (i = 0; i < dev->nr_vring; i++) {
1168                         struct vhost_virtqueue *vq = dev->virtqueue[i];
1169
1170                         vhost_user_iotlb_cache_remove(vq, imsg->iova,
1171                                         imsg->size);
1172
1173                         if (is_vring_iotlb_invalidate(vq, imsg))
1174                                 vring_invalidate(dev, vq);
1175                 }
1176                 break;
1177         default:
1178                 RTE_LOG(ERR, VHOST_CONFIG, "Invalid IOTLB message type (%d)\n",
1179                                 imsg->type);
1180                 return -1;
1181         }
1182
1183         return 0;
1184 }
1185
1186 /* return bytes# of read on success or negative val on failure. */
1187 static int
1188 read_vhost_message(int sockfd, struct VhostUserMsg *msg)
1189 {
1190         int ret;
1191
1192         ret = read_fd_message(sockfd, (char *)msg, VHOST_USER_HDR_SIZE,
1193                 msg->fds, VHOST_MEMORY_MAX_NREGIONS);
1194         if (ret <= 0)
1195                 return ret;
1196
1197         if (msg && msg->size) {
1198                 if (msg->size > sizeof(msg->payload)) {
1199                         RTE_LOG(ERR, VHOST_CONFIG,
1200                                 "invalid msg size: %d\n", msg->size);
1201                         return -1;
1202                 }
1203                 ret = read(sockfd, &msg->payload, msg->size);
1204                 if (ret <= 0)
1205                         return ret;
1206                 if (ret != (int)msg->size) {
1207                         RTE_LOG(ERR, VHOST_CONFIG,
1208                                 "read control message failed\n");
1209                         return -1;
1210                 }
1211         }
1212
1213         return ret;
1214 }
1215
1216 static int
1217 send_vhost_message(int sockfd, struct VhostUserMsg *msg)
1218 {
1219         if (!msg)
1220                 return 0;
1221
1222         return send_fd_message(sockfd, (char *)msg,
1223                 VHOST_USER_HDR_SIZE + msg->size, NULL, 0);
1224 }
1225
1226 static int
1227 send_vhost_reply(int sockfd, struct VhostUserMsg *msg)
1228 {
1229         if (!msg)
1230                 return 0;
1231
1232         msg->flags &= ~VHOST_USER_VERSION_MASK;
1233         msg->flags &= ~VHOST_USER_NEED_REPLY;
1234         msg->flags |= VHOST_USER_VERSION;
1235         msg->flags |= VHOST_USER_REPLY_MASK;
1236
1237         return send_vhost_message(sockfd, msg);
1238 }
1239
1240 /*
1241  * Allocate a queue pair if it hasn't been allocated yet
1242  */
1243 static int
1244 vhost_user_check_and_alloc_queue_pair(struct virtio_net *dev, VhostUserMsg *msg)
1245 {
1246         uint16_t vring_idx;
1247
1248         switch (msg->request.master) {
1249         case VHOST_USER_SET_VRING_KICK:
1250         case VHOST_USER_SET_VRING_CALL:
1251         case VHOST_USER_SET_VRING_ERR:
1252                 vring_idx = msg->payload.u64 & VHOST_USER_VRING_IDX_MASK;
1253                 break;
1254         case VHOST_USER_SET_VRING_NUM:
1255         case VHOST_USER_SET_VRING_BASE:
1256         case VHOST_USER_SET_VRING_ENABLE:
1257                 vring_idx = msg->payload.state.index;
1258                 break;
1259         case VHOST_USER_SET_VRING_ADDR:
1260                 vring_idx = msg->payload.addr.index;
1261                 break;
1262         default:
1263                 return 0;
1264         }
1265
1266         if (vring_idx >= VHOST_MAX_VRING) {
1267                 RTE_LOG(ERR, VHOST_CONFIG,
1268                         "invalid vring index: %u\n", vring_idx);
1269                 return -1;
1270         }
1271
1272         if (dev->virtqueue[vring_idx])
1273                 return 0;
1274
1275         return alloc_vring_queue(dev, vring_idx);
1276 }
1277
1278 static void
1279 vhost_user_lock_all_queue_pairs(struct virtio_net *dev)
1280 {
1281         unsigned int i = 0;
1282         unsigned int vq_num = 0;
1283
1284         while (vq_num < dev->nr_vring) {
1285                 struct vhost_virtqueue *vq = dev->virtqueue[i];
1286
1287                 if (vq) {
1288                         rte_spinlock_lock(&vq->access_lock);
1289                         vq_num++;
1290                 }
1291                 i++;
1292         }
1293 }
1294
1295 static void
1296 vhost_user_unlock_all_queue_pairs(struct virtio_net *dev)
1297 {
1298         unsigned int i = 0;
1299         unsigned int vq_num = 0;
1300
1301         while (vq_num < dev->nr_vring) {
1302                 struct vhost_virtqueue *vq = dev->virtqueue[i];
1303
1304                 if (vq) {
1305                         rte_spinlock_unlock(&vq->access_lock);
1306                         vq_num++;
1307                 }
1308                 i++;
1309         }
1310 }
1311
1312 int
1313 vhost_user_msg_handler(int vid, int fd)
1314 {
1315         struct virtio_net *dev;
1316         struct VhostUserMsg msg;
1317         int ret;
1318         int unlock_required = 0;
1319
1320         dev = get_device(vid);
1321         if (dev == NULL)
1322                 return -1;
1323
1324         if (!dev->notify_ops) {
1325                 dev->notify_ops = vhost_driver_callback_get(dev->ifname);
1326                 if (!dev->notify_ops) {
1327                         RTE_LOG(ERR, VHOST_CONFIG,
1328                                 "failed to get callback ops for driver %s\n",
1329                                 dev->ifname);
1330                         return -1;
1331                 }
1332         }
1333
1334         ret = read_vhost_message(fd, &msg);
1335         if (ret <= 0 || msg.request.master >= VHOST_USER_MAX) {
1336                 if (ret < 0)
1337                         RTE_LOG(ERR, VHOST_CONFIG,
1338                                 "vhost read message failed\n");
1339                 else if (ret == 0)
1340                         RTE_LOG(INFO, VHOST_CONFIG,
1341                                 "vhost peer closed\n");
1342                 else
1343                         RTE_LOG(ERR, VHOST_CONFIG,
1344                                 "vhost read incorrect message\n");
1345
1346                 return -1;
1347         }
1348
1349         ret = 0;
1350         if (msg.request.master != VHOST_USER_IOTLB_MSG)
1351                 RTE_LOG(INFO, VHOST_CONFIG, "read message %s\n",
1352                         vhost_message_str[msg.request.master]);
1353         else
1354                 RTE_LOG(DEBUG, VHOST_CONFIG, "read message %s\n",
1355                         vhost_message_str[msg.request.master]);
1356
1357         ret = vhost_user_check_and_alloc_queue_pair(dev, &msg);
1358         if (ret < 0) {
1359                 RTE_LOG(ERR, VHOST_CONFIG,
1360                         "failed to alloc queue\n");
1361                 return -1;
1362         }
1363
1364         /*
1365          * Note: we don't lock all queues on VHOST_USER_GET_VRING_BASE
1366          * and VHOST_USER_RESET_OWNER, since it is sent when virtio stops
1367          * and device is destroyed. destroy_device waits for queues to be
1368          * inactive, so it is safe. Otherwise taking the access_lock
1369          * would cause a dead lock.
1370          */
1371         switch (msg.request.master) {
1372         case VHOST_USER_SET_FEATURES:
1373         case VHOST_USER_SET_PROTOCOL_FEATURES:
1374         case VHOST_USER_SET_OWNER:
1375         case VHOST_USER_SET_MEM_TABLE:
1376         case VHOST_USER_SET_LOG_BASE:
1377         case VHOST_USER_SET_LOG_FD:
1378         case VHOST_USER_SET_VRING_NUM:
1379         case VHOST_USER_SET_VRING_ADDR:
1380         case VHOST_USER_SET_VRING_BASE:
1381         case VHOST_USER_SET_VRING_KICK:
1382         case VHOST_USER_SET_VRING_CALL:
1383         case VHOST_USER_SET_VRING_ERR:
1384         case VHOST_USER_SET_VRING_ENABLE:
1385         case VHOST_USER_SEND_RARP:
1386         case VHOST_USER_NET_SET_MTU:
1387         case VHOST_USER_SET_SLAVE_REQ_FD:
1388                 vhost_user_lock_all_queue_pairs(dev);
1389                 unlock_required = 1;
1390                 break;
1391         default:
1392                 break;
1393
1394         }
1395
1396         switch (msg.request.master) {
1397         case VHOST_USER_GET_FEATURES:
1398                 msg.payload.u64 = vhost_user_get_features(dev);
1399                 msg.size = sizeof(msg.payload.u64);
1400                 send_vhost_reply(fd, &msg);
1401                 break;
1402         case VHOST_USER_SET_FEATURES:
1403                 ret = vhost_user_set_features(dev, msg.payload.u64);
1404                 if (ret)
1405                         return -1;
1406                 break;
1407
1408         case VHOST_USER_GET_PROTOCOL_FEATURES:
1409                 vhost_user_get_protocol_features(dev, &msg);
1410                 send_vhost_reply(fd, &msg);
1411                 break;
1412         case VHOST_USER_SET_PROTOCOL_FEATURES:
1413                 vhost_user_set_protocol_features(dev, msg.payload.u64);
1414                 break;
1415
1416         case VHOST_USER_SET_OWNER:
1417                 vhost_user_set_owner();
1418                 break;
1419         case VHOST_USER_RESET_OWNER:
1420                 vhost_user_reset_owner(dev);
1421                 break;
1422
1423         case VHOST_USER_SET_MEM_TABLE:
1424                 ret = vhost_user_set_mem_table(dev, &msg);
1425                 break;
1426
1427         case VHOST_USER_SET_LOG_BASE:
1428                 vhost_user_set_log_base(dev, &msg);
1429
1430                 /* it needs a reply */
1431                 msg.size = sizeof(msg.payload.u64);
1432                 send_vhost_reply(fd, &msg);
1433                 break;
1434         case VHOST_USER_SET_LOG_FD:
1435                 close(msg.fds[0]);
1436                 RTE_LOG(INFO, VHOST_CONFIG, "not implemented.\n");
1437                 break;
1438
1439         case VHOST_USER_SET_VRING_NUM:
1440                 vhost_user_set_vring_num(dev, &msg);
1441                 break;
1442         case VHOST_USER_SET_VRING_ADDR:
1443                 vhost_user_set_vring_addr(&dev, &msg);
1444                 break;
1445         case VHOST_USER_SET_VRING_BASE:
1446                 vhost_user_set_vring_base(dev, &msg);
1447                 break;
1448
1449         case VHOST_USER_GET_VRING_BASE:
1450                 vhost_user_get_vring_base(dev, &msg);
1451                 msg.size = sizeof(msg.payload.state);
1452                 send_vhost_reply(fd, &msg);
1453                 break;
1454
1455         case VHOST_USER_SET_VRING_KICK:
1456                 vhost_user_set_vring_kick(&dev, &msg);
1457                 break;
1458         case VHOST_USER_SET_VRING_CALL:
1459                 vhost_user_set_vring_call(dev, &msg);
1460                 break;
1461
1462         case VHOST_USER_SET_VRING_ERR:
1463                 if (!(msg.payload.u64 & VHOST_USER_VRING_NOFD_MASK))
1464                         close(msg.fds[0]);
1465                 RTE_LOG(INFO, VHOST_CONFIG, "not implemented\n");
1466                 break;
1467
1468         case VHOST_USER_GET_QUEUE_NUM:
1469                 msg.payload.u64 = VHOST_MAX_QUEUE_PAIRS;
1470                 msg.size = sizeof(msg.payload.u64);
1471                 send_vhost_reply(fd, &msg);
1472                 break;
1473
1474         case VHOST_USER_SET_VRING_ENABLE:
1475                 vhost_user_set_vring_enable(dev, &msg);
1476                 break;
1477         case VHOST_USER_SEND_RARP:
1478                 vhost_user_send_rarp(dev, &msg);
1479                 break;
1480
1481         case VHOST_USER_NET_SET_MTU:
1482                 ret = vhost_user_net_set_mtu(dev, &msg);
1483                 break;
1484
1485         case VHOST_USER_SET_SLAVE_REQ_FD:
1486                 ret = vhost_user_set_req_fd(dev, &msg);
1487                 break;
1488
1489         case VHOST_USER_IOTLB_MSG:
1490                 ret = vhost_user_iotlb_msg(&dev, &msg);
1491                 break;
1492
1493         default:
1494                 ret = -1;
1495                 break;
1496
1497         }
1498
1499         if (unlock_required)
1500                 vhost_user_unlock_all_queue_pairs(dev);
1501
1502         if (msg.flags & VHOST_USER_NEED_REPLY) {
1503                 msg.payload.u64 = !!ret;
1504                 msg.size = sizeof(msg.payload.u64);
1505                 send_vhost_reply(fd, &msg);
1506         }
1507
1508         if (!(dev->flags & VIRTIO_DEV_RUNNING) && virtio_is_ready(dev)) {
1509                 dev->flags |= VIRTIO_DEV_READY;
1510
1511                 if (!(dev->flags & VIRTIO_DEV_RUNNING)) {
1512                         if (dev->dequeue_zero_copy) {
1513                                 RTE_LOG(INFO, VHOST_CONFIG,
1514                                                 "dequeue zero copy is enabled\n");
1515                         }
1516
1517                         if (dev->notify_ops->new_device(dev->vid) == 0)
1518                                 dev->flags |= VIRTIO_DEV_RUNNING;
1519                 }
1520         }
1521
1522         return 0;
1523 }
1524
1525 int
1526 vhost_user_iotlb_miss(struct virtio_net *dev, uint64_t iova, uint8_t perm)
1527 {
1528         int ret;
1529         struct VhostUserMsg msg = {
1530                 .request.slave = VHOST_USER_SLAVE_IOTLB_MSG,
1531                 .flags = VHOST_USER_VERSION,
1532                 .size = sizeof(msg.payload.iotlb),
1533                 .payload.iotlb = {
1534                         .iova = iova,
1535                         .perm = perm,
1536                         .type = VHOST_IOTLB_MISS,
1537                 },
1538         };
1539
1540         ret = send_vhost_message(dev->slave_req_fd, &msg);
1541         if (ret < 0) {
1542                 RTE_LOG(ERR, VHOST_CONFIG,
1543                                 "Failed to send IOTLB miss message (%d)\n",
1544                                 ret);
1545                 return ret;
1546         }
1547
1548         return 0;
1549 }