lib/librte_vhost/vhost_user.c

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