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 "vhost.h"
  52 #include "vhost_user.h"
  53
  54 #define VIRTIO_MIN_MTU 68
  55 #define VIRTIO_MAX_MTU 65535
  56
  57 static const char *vhost_message_str[VHOST_USER_MAX] = {
  58         [VHOST_USER_NONE] = "VHOST_USER_NONE",
  59         [VHOST_USER_GET_FEATURES] = "VHOST_USER_GET_FEATURES",
  60         [VHOST_USER_SET_FEATURES] = "VHOST_USER_SET_FEATURES",
  61         [VHOST_USER_SET_OWNER] = "VHOST_USER_SET_OWNER",
  62         [VHOST_USER_RESET_OWNER] = "VHOST_USER_RESET_OWNER",
  63         [VHOST_USER_SET_MEM_TABLE] = "VHOST_USER_SET_MEM_TABLE",
  64         [VHOST_USER_SET_LOG_BASE] = "VHOST_USER_SET_LOG_BASE",
  65         [VHOST_USER_SET_LOG_FD] = "VHOST_USER_SET_LOG_FD",
  66         [VHOST_USER_SET_VRING_NUM] = "VHOST_USER_SET_VRING_NUM",
  67         [VHOST_USER_SET_VRING_ADDR] = "VHOST_USER_SET_VRING_ADDR",
  68         [VHOST_USER_SET_VRING_BASE] = "VHOST_USER_SET_VRING_BASE",
  69         [VHOST_USER_GET_VRING_BASE] = "VHOST_USER_GET_VRING_BASE",
  70         [VHOST_USER_SET_VRING_KICK] = "VHOST_USER_SET_VRING_KICK",
  71         [VHOST_USER_SET_VRING_CALL] = "VHOST_USER_SET_VRING_CALL",
  72         [VHOST_USER_SET_VRING_ERR]  = "VHOST_USER_SET_VRING_ERR",
  73         [VHOST_USER_GET_PROTOCOL_FEATURES]  = "VHOST_USER_GET_PROTOCOL_FEATURES",
  74         [VHOST_USER_SET_PROTOCOL_FEATURES]  = "VHOST_USER_SET_PROTOCOL_FEATURES",
  75         [VHOST_USER_GET_QUEUE_NUM]  = "VHOST_USER_GET_QUEUE_NUM",
  76         [VHOST_USER_SET_VRING_ENABLE]  = "VHOST_USER_SET_VRING_ENABLE",
  77         [VHOST_USER_SEND_RARP]  = "VHOST_USER_SEND_RARP",
  78         [VHOST_USER_NET_SET_MTU]  = "VHOST_USER_NET_SET_MTU",
  79 };
  80
  81 static uint64_t
  82 get_blk_size(int fd)
  83 {
  84         struct stat stat;
  85         int ret;
  86
  87         ret = fstat(fd, &stat);
  88         return ret == -1 ? (uint64_t)-1 : (uint64_t)stat.st_blksize;
  89 }
  90
  91 static void
  92 free_mem_region(struct virtio_net *dev)
  93 {
  94         uint32_t i;
  95         struct rte_vhost_mem_region *reg;
  96
  97         if (!dev || !dev->mem)
  98                 return;
  99
 100         for (i = 0; i < dev->mem->nregions; i++) {
 101                 reg = &dev->mem->regions[i];
 102                 if (reg->host_user_addr) {
 103                         munmap(reg->mmap_addr, reg->mmap_size);
 104                         close(reg->fd);
 105                 }
 106         }
 107 }
 108
 109 void
 110 vhost_backend_cleanup(struct virtio_net *dev)
 111 {
 112         if (dev->mem) {
 113                 free_mem_region(dev);
 114                 rte_free(dev->mem);
 115                 dev->mem = NULL;
 116         }
 117
 118         free(dev->guest_pages);
 119         dev->guest_pages = NULL;
 120
 121         if (dev->log_addr) {
 122                 munmap((void *)(uintptr_t)dev->log_addr, dev->log_size);
 123                 dev->log_addr = 0;
 124         }
 125 }
 126
 127 /*
 128  * This function just returns success at the moment unless
 129  * the device hasn't been initialised.
 130  */
 131 static int
 132 vhost_user_set_owner(void)
 133 {
 134         return 0;
 135 }
 136
 137 static int
 138 vhost_user_reset_owner(struct virtio_net *dev)
 139 {
 140         if (dev->flags & VIRTIO_DEV_RUNNING) {
 141                 dev->flags &= ~VIRTIO_DEV_RUNNING;
 142                 dev->notify_ops->destroy_device(dev->vid);
 143         }
 144
 145         cleanup_device(dev, 0);
 146         reset_device(dev);
 147         return 0;
 148 }
 149
 150 /*
 151  * The features that we support are requested.
 152  */
 153 static uint64_t
 154 vhost_user_get_features(struct virtio_net *dev)
 155 {
 156         uint64_t features = 0;
 157
 158         rte_vhost_driver_get_features(dev->ifname, &features);
 159         return features;
 160 }
 161
 162 /*
 163  * We receive the negotiated features supported by us and the virtio device.
 164  */
 165 static int
 166 vhost_user_set_features(struct virtio_net *dev, uint64_t features)
 167 {
 168         uint64_t vhost_features = 0;
 169
 170         rte_vhost_driver_get_features(dev->ifname, &vhost_features);
 171         if (features & ~vhost_features)
 172                 return -1;
 173
 174         if ((dev->flags & VIRTIO_DEV_RUNNING) && dev->features != features) {
 175                 if (dev->notify_ops->features_changed)
 176                         dev->notify_ops->features_changed(dev->vid, features);
 177         }
 178
 179         dev->features = features;
 180         if (dev->features &
 181                 ((1 << VIRTIO_NET_F_MRG_RXBUF) | (1ULL << VIRTIO_F_VERSION_1))) {
 182                 dev->vhost_hlen = sizeof(struct virtio_net_hdr_mrg_rxbuf);
 183         } else {
 184                 dev->vhost_hlen = sizeof(struct virtio_net_hdr);
 185         }
 186         LOG_DEBUG(VHOST_CONFIG,
 187                 "(%d) mergeable RX buffers %s, virtio 1 %s\n",
 188                 dev->vid,
 189                 (dev->features & (1 << VIRTIO_NET_F_MRG_RXBUF)) ? "on" : "off",
 190                 (dev->features & (1ULL << VIRTIO_F_VERSION_1)) ? "on" : "off");
 191
 192         return 0;
 193 }
 194
 195 /*
 196  * The virtio device sends us the size of the descriptor ring.
 197  */
 198 static int
 199 vhost_user_set_vring_num(struct virtio_net *dev,
 200                          struct vhost_vring_state *state)
 201 {
 202         struct vhost_virtqueue *vq = dev->virtqueue[state->index];
 203
 204         vq->size = state->num;
 205
 206         if (dev->dequeue_zero_copy) {
 207                 vq->nr_zmbuf = 0;
 208                 vq->last_zmbuf_idx = 0;
 209                 vq->zmbuf_size = vq->size;
 210                 vq->zmbufs = rte_zmalloc(NULL, vq->zmbuf_size *
 211                                          sizeof(struct zcopy_mbuf), 0);
 212                 if (vq->zmbufs == NULL) {
 213                         RTE_LOG(WARNING, VHOST_CONFIG,
 214                                 "failed to allocate mem for zero copy; "
 215                                 "zero copy is force disabled\n");
 216                         dev->dequeue_zero_copy = 0;
 217                 }
 218         }
 219
 220         vq->shadow_used_ring = rte_malloc(NULL,
 221                                 vq->size * sizeof(struct vring_used_elem),
 222                                 RTE_CACHE_LINE_SIZE);
 223         if (!vq->shadow_used_ring) {
 224                 RTE_LOG(ERR, VHOST_CONFIG,
 225                         "failed to allocate memory for shadow used ring.\n");
 226                 return -1;
 227         }
 228
 229         return 0;
 230 }
 231
 232 /*
 233  * Reallocate virtio_dev and vhost_virtqueue data structure to make them on the
 234  * same numa node as the memory of vring descriptor.
 235  */
 236 #ifdef RTE_LIBRTE_VHOST_NUMA
 237 static struct virtio_net*
 238 numa_realloc(struct virtio_net *dev, int index)
 239 {
 240         int oldnode, newnode;
 241         struct virtio_net *old_dev;
 242         struct vhost_virtqueue *old_vq, *vq;
 243         int ret;
 244
 245         old_dev = dev;
 246         vq = old_vq = dev->virtqueue[index];
 247
 248         ret = get_mempolicy(&newnode, NULL, 0, old_vq->desc,
 249                             MPOL_F_NODE | MPOL_F_ADDR);
 250
 251         /* check if we need to reallocate vq */
 252         ret |= get_mempolicy(&oldnode, NULL, 0, old_vq,
 253                              MPOL_F_NODE | MPOL_F_ADDR);
 254         if (ret) {
 255                 RTE_LOG(ERR, VHOST_CONFIG,
 256                         "Unable to get vq numa information.\n");
 257                 return dev;
 258         }
 259         if (oldnode != newnode) {
 260                 RTE_LOG(INFO, VHOST_CONFIG,
 261                         "reallocate vq from %d to %d node\n", oldnode, newnode);
 262                 vq = rte_malloc_socket(NULL, sizeof(*vq), 0, newnode);
 263                 if (!vq)
 264                         return dev;
 265
 266                 memcpy(vq, old_vq, sizeof(*vq));
 267                 rte_free(old_vq);
 268         }
 269
 270         /* check if we need to reallocate dev */
 271         ret = get_mempolicy(&oldnode, NULL, 0, old_dev,
 272                             MPOL_F_NODE | MPOL_F_ADDR);
 273         if (ret) {
 274                 RTE_LOG(ERR, VHOST_CONFIG,
 275                         "Unable to get dev numa information.\n");
 276                 goto out;
 277         }
 278         if (oldnode != newnode) {
 279                 RTE_LOG(INFO, VHOST_CONFIG,
 280                         "reallocate dev from %d to %d node\n",
 281                         oldnode, newnode);
 282                 dev = rte_malloc_socket(NULL, sizeof(*dev), 0, newnode);
 283                 if (!dev) {
 284                         dev = old_dev;
 285                         goto out;
 286                 }
 287
 288                 memcpy(dev, old_dev, sizeof(*dev));
 289                 rte_free(old_dev);
 290         }
 291
 292 out:
 293         dev->virtqueue[index] = vq;
 294         vhost_devices[dev->vid] = dev;
 295
 296         return dev;
 297 }
 298 #else
 299 static struct virtio_net*
 300 numa_realloc(struct virtio_net *dev, int index __rte_unused)
 301 {
 302         return dev;
 303 }
 304 #endif
 305
 306 /*
 307  * Converts QEMU virtual address to Vhost virtual address. This function is
 308  * used to convert the ring addresses to our address space.
 309  */
 310 static uint64_t
 311 qva_to_vva(struct virtio_net *dev, uint64_t qva)
 312 {
 313         struct rte_vhost_mem_region *reg;
 314         uint32_t i;
 315
 316         /* Find the region where the address lives. */
 317         for (i = 0; i < dev->mem->nregions; i++) {
 318                 reg = &dev->mem->regions[i];
 319
 320                 if (qva >= reg->guest_user_addr &&
 321                     qva <  reg->guest_user_addr + reg->size) {
 322                         return qva - reg->guest_user_addr +
 323                                reg->host_user_addr;
 324                 }
 325         }
 326
 327         return 0;
 328 }
 329
 330 /*
 331  * The virtio device sends us the desc, used and avail ring addresses.
 332  * This function then converts these to our address space.
 333  */
 334 static int
 335 vhost_user_set_vring_addr(struct virtio_net *dev, struct vhost_vring_addr *addr)
 336 {
 337         struct vhost_virtqueue *vq;
 338
 339         if (dev->mem == NULL)
 340                 return -1;
 341
 342         /* addr->index refers to the queue index. The txq 1, rxq is 0. */
 343         vq = dev->virtqueue[addr->index];
 344
 345         /* The addresses are converted from QEMU virtual to Vhost virtual. */
 346         vq->desc = (struct vring_desc *)(uintptr_t)qva_to_vva(dev,
 347                         addr->desc_user_addr);
 348         if (vq->desc == 0) {
 349                 RTE_LOG(ERR, VHOST_CONFIG,
 350                         "(%d) failed to find desc ring address.\n",
 351                         dev->vid);
 352                 return -1;
 353         }
 354
 355         dev = numa_realloc(dev, addr->index);
 356         vq = dev->virtqueue[addr->index];
 357
 358         vq->avail = (struct vring_avail *)(uintptr_t)qva_to_vva(dev,
 359                         addr->avail_user_addr);
 360         if (vq->avail == 0) {
 361                 RTE_LOG(ERR, VHOST_CONFIG,
 362                         "(%d) failed to find avail ring address.\n",
 363                         dev->vid);
 364                 return -1;
 365         }
 366
 367         vq->used = (struct vring_used *)(uintptr_t)qva_to_vva(dev,
 368                         addr->used_user_addr);
 369         if (vq->used == 0) {
 370                 RTE_LOG(ERR, VHOST_CONFIG,
 371                         "(%d) failed to find used ring address.\n",
 372                         dev->vid);
 373                 return -1;
 374         }
 375
 376         if (vq->last_used_idx != vq->used->idx) {
 377                 RTE_LOG(WARNING, VHOST_CONFIG,
 378                         "last_used_idx (%u) and vq->used->idx (%u) mismatches; "
 379                         "some packets maybe resent for Tx and dropped for Rx\n",
 380                         vq->last_used_idx, vq->used->idx);
 381                 vq->last_used_idx  = vq->used->idx;
 382                 vq->last_avail_idx = vq->used->idx;
 383         }
 384
 385         vq->log_guest_addr = addr->log_guest_addr;
 386
 387         LOG_DEBUG(VHOST_CONFIG, "(%d) mapped address desc: %p\n",
 388                         dev->vid, vq->desc);
 389         LOG_DEBUG(VHOST_CONFIG, "(%d) mapped address avail: %p\n",
 390                         dev->vid, vq->avail);
 391         LOG_DEBUG(VHOST_CONFIG, "(%d) mapped address used: %p\n",
 392                         dev->vid, vq->used);
 393         LOG_DEBUG(VHOST_CONFIG, "(%d) log_guest_addr: %" PRIx64 "\n",
 394                         dev->vid, vq->log_guest_addr);
 395
 396         return 0;
 397 }
 398
 399 /*
 400  * The virtio device sends us the available ring last used index.
 401  */
 402 static int
 403 vhost_user_set_vring_base(struct virtio_net *dev,
 404                           struct vhost_vring_state *state)
 405 {
 406         dev->virtqueue[state->index]->last_used_idx  = state->num;
 407         dev->virtqueue[state->index]->last_avail_idx = state->num;
 408
 409         return 0;
 410 }
 411
 412 static void
 413 add_one_guest_page(struct virtio_net *dev, uint64_t guest_phys_addr,
 414                    uint64_t host_phys_addr, uint64_t size)
 415 {
 416         struct guest_page *page, *last_page;
 417
 418         if (dev->nr_guest_pages == dev->max_guest_pages) {
 419                 dev->max_guest_pages *= 2;
 420                 dev->guest_pages = realloc(dev->guest_pages,
 421                                         dev->max_guest_pages * sizeof(*page));
 422         }
 423
 424         if (dev->nr_guest_pages > 0) {
 425                 last_page = &dev->guest_pages[dev->nr_guest_pages - 1];
 426                 /* merge if the two pages are continuous */
 427                 if (host_phys_addr == last_page->host_phys_addr +
 428                                       last_page->size) {
 429                         last_page->size += size;
 430                         return;
 431                 }
 432         }
 433
 434         page = &dev->guest_pages[dev->nr_guest_pages++];
 435         page->guest_phys_addr = guest_phys_addr;
 436         page->host_phys_addr  = host_phys_addr;
 437         page->size = size;
 438 }
 439
 440 static void
 441 add_guest_pages(struct virtio_net *dev, struct rte_vhost_mem_region *reg,
 442                 uint64_t page_size)
 443 {
 444         uint64_t reg_size = reg->size;
 445         uint64_t host_user_addr  = reg->host_user_addr;
 446         uint64_t guest_phys_addr = reg->guest_phys_addr;
 447         uint64_t host_phys_addr;
 448         uint64_t size;
 449
 450         host_phys_addr = rte_mem_virt2phy((void *)(uintptr_t)host_user_addr);
 451         size = page_size - (guest_phys_addr & (page_size - 1));
 452         size = RTE_MIN(size, reg_size);
 453
 454         add_one_guest_page(dev, guest_phys_addr, host_phys_addr, size);
 455         host_user_addr  += size;
 456         guest_phys_addr += size;
 457         reg_size -= size;
 458
 459         while (reg_size > 0) {
 460                 size = RTE_MIN(reg_size, page_size);
 461                 host_phys_addr = rte_mem_virt2phy((void *)(uintptr_t)
 462                                                   host_user_addr);
 463                 add_one_guest_page(dev, guest_phys_addr, host_phys_addr, size);
 464
 465                 host_user_addr  += size;
 466                 guest_phys_addr += size;
 467                 reg_size -= size;
 468         }
 469 }
 470
 471 #ifdef RTE_LIBRTE_VHOST_DEBUG
 472 /* TODO: enable it only in debug mode? */
 473 static void
 474 dump_guest_pages(struct virtio_net *dev)
 475 {
 476         uint32_t i;
 477         struct guest_page *page;
 478
 479         for (i = 0; i < dev->nr_guest_pages; i++) {
 480                 page = &dev->guest_pages[i];
 481
 482                 RTE_LOG(INFO, VHOST_CONFIG,
 483                         "guest physical page region %u\n"
 484                         "\t guest_phys_addr: %" PRIx64 "\n"
 485                         "\t host_phys_addr : %" PRIx64 "\n"
 486                         "\t size           : %" PRIx64 "\n",
 487                         i,
 488                         page->guest_phys_addr,
 489                         page->host_phys_addr,
 490                         page->size);
 491         }
 492 }
 493 #else
 494 #define dump_guest_pages(dev)
 495 #endif
 496
 497 static int
 498 vhost_user_set_mem_table(struct virtio_net *dev, struct VhostUserMsg *pmsg)
 499 {
 500         struct VhostUserMemory memory = pmsg->payload.memory;
 501         struct rte_vhost_mem_region *reg;
 502         void *mmap_addr;
 503         uint64_t mmap_size;
 504         uint64_t mmap_offset;
 505         uint64_t alignment;
 506         uint32_t i;
 507         int fd;
 508
 509         if (dev->mem) {
 510                 free_mem_region(dev);
 511                 rte_free(dev->mem);
 512                 dev->mem = NULL;
 513         }
 514
 515         dev->nr_guest_pages = 0;
 516         if (!dev->guest_pages) {
 517                 dev->max_guest_pages = 8;
 518                 dev->guest_pages = malloc(dev->max_guest_pages *
 519                                                 sizeof(struct guest_page));
 520         }
 521
 522         dev->mem = rte_zmalloc("vhost-mem-table", sizeof(struct rte_vhost_memory) +
 523                 sizeof(struct rte_vhost_mem_region) * memory.nregions, 0);
 524         if (dev->mem == NULL) {
 525                 RTE_LOG(ERR, VHOST_CONFIG,
 526                         "(%d) failed to allocate memory for dev->mem\n",
 527                         dev->vid);
 528                 return -1;
 529         }
 530         dev->mem->nregions = memory.nregions;
 531
 532         for (i = 0; i < memory.nregions; i++) {
 533                 fd  = pmsg->fds[i];
 534                 reg = &dev->mem->regions[i];
 535
 536                 reg->guest_phys_addr = memory.regions[i].guest_phys_addr;
 537                 reg->guest_user_addr = memory.regions[i].userspace_addr;
 538                 reg->size            = memory.regions[i].memory_size;
 539                 reg->fd              = fd;
 540
 541                 mmap_offset = memory.regions[i].mmap_offset;
 542                 mmap_size   = reg->size + mmap_offset;
 543
 544                 /* mmap() without flag of MAP_ANONYMOUS, should be called
 545                  * with length argument aligned with hugepagesz at older
 546                  * longterm version Linux, like 2.6.32 and 3.2.72, or
 547                  * mmap() will fail with EINVAL.
 548                  *
 549                  * to avoid failure, make sure in caller to keep length
 550                  * aligned.
 551                  */
 552                 alignment = get_blk_size(fd);
 553                 if (alignment == (uint64_t)-1) {
 554                         RTE_LOG(ERR, VHOST_CONFIG,
 555                                 "couldn't get hugepage size through fstat\n");
 556                         goto err_mmap;
 557                 }
 558                 mmap_size = RTE_ALIGN_CEIL(mmap_size, alignment);
 559
 560                 mmap_addr = mmap(NULL, mmap_size, PROT_READ | PROT_WRITE,
 561                                  MAP_SHARED | MAP_POPULATE, fd, 0);
 562
 563                 if (mmap_addr == MAP_FAILED) {
 564                         RTE_LOG(ERR, VHOST_CONFIG,
 565                                 "mmap region %u failed.\n", i);
 566                         goto err_mmap;
 567                 }
 568
 569                 reg->mmap_addr = mmap_addr;
 570                 reg->mmap_size = mmap_size;
 571                 reg->host_user_addr = (uint64_t)(uintptr_t)mmap_addr +
 572                                       mmap_offset;
 573
 574                 if (dev->dequeue_zero_copy)
 575                         add_guest_pages(dev, reg, alignment);
 576
 577                 RTE_LOG(INFO, VHOST_CONFIG,
 578                         "guest memory region %u, size: 0x%" PRIx64 "\n"
 579                         "\t guest physical addr: 0x%" PRIx64 "\n"
 580                         "\t guest virtual  addr: 0x%" PRIx64 "\n"
 581                         "\t host  virtual  addr: 0x%" PRIx64 "\n"
 582                         "\t mmap addr : 0x%" PRIx64 "\n"
 583                         "\t mmap size : 0x%" PRIx64 "\n"
 584                         "\t mmap align: 0x%" PRIx64 "\n"
 585                         "\t mmap off  : 0x%" PRIx64 "\n",
 586                         i, reg->size,
 587                         reg->guest_phys_addr,
 588                         reg->guest_user_addr,
 589                         reg->host_user_addr,
 590                         (uint64_t)(uintptr_t)mmap_addr,
 591                         mmap_size,
 592                         alignment,
 593                         mmap_offset);
 594         }
 595
 596         dump_guest_pages(dev);
 597
 598         return 0;
 599
 600 err_mmap:
 601         free_mem_region(dev);
 602         rte_free(dev->mem);
 603         dev->mem = NULL;
 604         return -1;
 605 }
 606
 607 static int
 608 vq_is_ready(struct vhost_virtqueue *vq)
 609 {
 610         return vq && vq->desc   &&
 611                vq->kickfd != VIRTIO_UNINITIALIZED_EVENTFD &&
 612                vq->callfd != VIRTIO_UNINITIALIZED_EVENTFD;
 613 }
 614
 615 static int
 616 virtio_is_ready(struct virtio_net *dev)
 617 {
 618         struct vhost_virtqueue *vq;
 619         uint32_t i;
 620
 621         if (dev->nr_vring == 0)
 622                 return 0;
 623
 624         for (i = 0; i < dev->nr_vring; i++) {
 625                 vq = dev->virtqueue[i];
 626
 627                 if (!vq_is_ready(vq))
 628                         return 0;
 629         }
 630
 631         RTE_LOG(INFO, VHOST_CONFIG,
 632                 "virtio is now ready for processing.\n");
 633         return 1;
 634 }
 635
 636 static void
 637 vhost_user_set_vring_call(struct virtio_net *dev, struct VhostUserMsg *pmsg)
 638 {
 639         struct vhost_vring_file file;
 640         struct vhost_virtqueue *vq;
 641
 642         file.index = pmsg->payload.u64 & VHOST_USER_VRING_IDX_MASK;
 643         if (pmsg->payload.u64 & VHOST_USER_VRING_NOFD_MASK)
 644                 file.fd = VIRTIO_INVALID_EVENTFD;
 645         else
 646                 file.fd = pmsg->fds[0];
 647         RTE_LOG(INFO, VHOST_CONFIG,
 648                 "vring call idx:%d file:%d\n", file.index, file.fd);
 649
 650         vq = dev->virtqueue[file.index];
 651         if (vq->callfd >= 0)
 652                 close(vq->callfd);
 653
 654         vq->callfd = file.fd;
 655 }
 656
 657 static void
 658 vhost_user_set_vring_kick(struct virtio_net *dev, struct VhostUserMsg *pmsg)
 659 {
 660         struct vhost_vring_file file;
 661         struct vhost_virtqueue *vq;
 662
 663         file.index = pmsg->payload.u64 & VHOST_USER_VRING_IDX_MASK;
 664         if (pmsg->payload.u64 & VHOST_USER_VRING_NOFD_MASK)
 665                 file.fd = VIRTIO_INVALID_EVENTFD;
 666         else
 667                 file.fd = pmsg->fds[0];
 668         RTE_LOG(INFO, VHOST_CONFIG,
 669                 "vring kick idx:%d file:%d\n", file.index, file.fd);
 670
 671         vq = dev->virtqueue[file.index];
 672         if (vq->kickfd >= 0)
 673                 close(vq->kickfd);
 674         vq->kickfd = file.fd;
 675 }
 676
 677 static void
 678 free_zmbufs(struct vhost_virtqueue *vq)
 679 {
 680         struct zcopy_mbuf *zmbuf, *next;
 681
 682         for (zmbuf = TAILQ_FIRST(&vq->zmbuf_list);
 683              zmbuf != NULL; zmbuf = next) {
 684                 next = TAILQ_NEXT(zmbuf, next);
 685
 686                 rte_pktmbuf_free(zmbuf->mbuf);
 687                 TAILQ_REMOVE(&vq->zmbuf_list, zmbuf, next);
 688         }
 689
 690         rte_free(vq->zmbufs);
 691 }
 692
 693 /*
 694  * when virtio is stopped, qemu will send us the GET_VRING_BASE message.
 695  */
 696 static int
 697 vhost_user_get_vring_base(struct virtio_net *dev,
 698                           struct vhost_vring_state *state)
 699 {
 700         struct vhost_virtqueue *vq = dev->virtqueue[state->index];
 701
 702         /* We have to stop the queue (virtio) if it is running. */
 703         if (dev->flags & VIRTIO_DEV_RUNNING) {
 704                 dev->flags &= ~VIRTIO_DEV_RUNNING;
 705                 dev->notify_ops->destroy_device(dev->vid);
 706         }
 707
 708         dev->flags &= ~VIRTIO_DEV_READY;
 709
 710         /* Here we are safe to get the last used index */
 711         state->num = vq->last_used_idx;
 712
 713         RTE_LOG(INFO, VHOST_CONFIG,
 714                 "vring base idx:%d file:%d\n", state->index, state->num);
 715         /*
 716          * Based on current qemu vhost-user implementation, this message is
 717          * sent and only sent in vhost_vring_stop.
 718          * TODO: cleanup the vring, it isn't usable since here.
 719          */
 720         if (vq->kickfd >= 0)
 721                 close(vq->kickfd);
 722
 723         vq->kickfd = VIRTIO_UNINITIALIZED_EVENTFD;
 724
 725         if (dev->dequeue_zero_copy)
 726                 free_zmbufs(vq);
 727         rte_free(vq->shadow_used_ring);
 728         vq->shadow_used_ring = NULL;
 729
 730         return 0;
 731 }
 732
 733 /*
 734  * when virtio queues are ready to work, qemu will send us to
 735  * enable the virtio queue pair.
 736  */
 737 static int
 738 vhost_user_set_vring_enable(struct virtio_net *dev,
 739                             struct vhost_vring_state *state)
 740 {
 741         int enable = (int)state->num;
 742
 743         RTE_LOG(INFO, VHOST_CONFIG,
 744                 "set queue enable: %d to qp idx: %d\n",
 745                 enable, state->index);
 746
 747         if (dev->notify_ops->vring_state_changed)
 748                 dev->notify_ops->vring_state_changed(dev->vid, state->index, enable);
 749
 750         dev->virtqueue[state->index]->enabled = enable;
 751
 752         return 0;
 753 }
 754
 755 static void
 756 vhost_user_set_protocol_features(struct virtio_net *dev,
 757                                  uint64_t protocol_features)
 758 {
 759         if (protocol_features & ~VHOST_USER_PROTOCOL_FEATURES)
 760                 return;
 761
 762         dev->protocol_features = protocol_features;
 763 }
 764
 765 static int
 766 vhost_user_set_log_base(struct virtio_net *dev, struct VhostUserMsg *msg)
 767 {
 768         int fd = msg->fds[0];
 769         uint64_t size, off;
 770         void *addr;
 771
 772         if (fd < 0) {
 773                 RTE_LOG(ERR, VHOST_CONFIG, "invalid log fd: %d\n", fd);
 774                 return -1;
 775         }
 776
 777         if (msg->size != sizeof(VhostUserLog)) {
 778                 RTE_LOG(ERR, VHOST_CONFIG,
 779                         "invalid log base msg size: %"PRId32" != %d\n",
 780                         msg->size, (int)sizeof(VhostUserLog));
 781                 return -1;
 782         }
 783
 784         size = msg->payload.log.mmap_size;
 785         off  = msg->payload.log.mmap_offset;
 786         RTE_LOG(INFO, VHOST_CONFIG,
 787                 "log mmap size: %"PRId64", offset: %"PRId64"\n",
 788                 size, off);
 789
 790         /*
 791          * mmap from 0 to workaround a hugepage mmap bug: mmap will
 792          * fail when offset is not page size aligned.
 793          */
 794         addr = mmap(0, size, PROT_READ | PROT_WRITE, MAP_SHARED, fd, 0);
 795         close(fd);
 796         if (addr == MAP_FAILED) {
 797                 RTE_LOG(ERR, VHOST_CONFIG, "mmap log base failed!\n");
 798                 return -1;
 799         }
 800
 801         /*
 802          * Free previously mapped log memory on occasionally
 803          * multiple VHOST_USER_SET_LOG_BASE.
 804          */
 805         if (dev->log_addr) {
 806                 munmap((void *)(uintptr_t)dev->log_addr, dev->log_size);
 807         }
 808         dev->log_addr = (uint64_t)(uintptr_t)addr;
 809         dev->log_base = dev->log_addr + off;
 810         dev->log_size = size;
 811
 812         return 0;
 813 }
 814
 815 /*
 816  * An rarp packet is constructed and broadcasted to notify switches about
 817  * the new location of the migrated VM, so that packets from outside will
 818  * not be lost after migration.
 819  *
 820  * However, we don't actually "send" a rarp packet here, instead, we set
 821  * a flag 'broadcast_rarp' to let rte_vhost_dequeue_burst() inject it.
 822  */
 823 static int
 824 vhost_user_send_rarp(struct virtio_net *dev, struct VhostUserMsg *msg)
 825 {
 826         uint8_t *mac = (uint8_t *)&msg->payload.u64;
 827
 828         RTE_LOG(DEBUG, VHOST_CONFIG,
 829                 ":: mac: %02x:%02x:%02x:%02x:%02x:%02x\n",
 830                 mac[0], mac[1], mac[2], mac[3], mac[4], mac[5]);
 831         memcpy(dev->mac.addr_bytes, mac, 6);
 832
 833         /*
 834          * Set the flag to inject a RARP broadcast packet at
 835          * rte_vhost_dequeue_burst().
 836          *
 837          * rte_smp_wmb() is for making sure the mac is copied
 838          * before the flag is set.
 839          */
 840         rte_smp_wmb();
 841         rte_atomic16_set(&dev->broadcast_rarp, 1);
 842
 843         return 0;
 844 }
 845
 846 static int
 847 vhost_user_net_set_mtu(struct virtio_net *dev, struct VhostUserMsg *msg)
 848 {
 849         if (msg->payload.u64 < VIRTIO_MIN_MTU ||
 850                         msg->payload.u64 > VIRTIO_MAX_MTU) {
 851                 RTE_LOG(ERR, VHOST_CONFIG, "Invalid MTU size (%"PRIu64")\n",
 852                                 msg->payload.u64);
 853
 854                 return -1;
 855         }
 856
 857         dev->mtu = msg->payload.u64;
 858
 859         return 0;
 860 }
 861
 862 /* return bytes# of read on success or negative val on failure. */
 863 static int
 864 read_vhost_message(int sockfd, struct VhostUserMsg *msg)
 865 {
 866         int ret;
 867
 868         ret = read_fd_message(sockfd, (char *)msg, VHOST_USER_HDR_SIZE,
 869                 msg->fds, VHOST_MEMORY_MAX_NREGIONS);
 870         if (ret <= 0)
 871                 return ret;
 872
 873         if (msg && msg->size) {
 874                 if (msg->size > sizeof(msg->payload)) {
 875                         RTE_LOG(ERR, VHOST_CONFIG,
 876                                 "invalid msg size: %d\n", msg->size);
 877                         return -1;
 878                 }
 879                 ret = read(sockfd, &msg->payload, msg->size);
 880                 if (ret <= 0)
 881                         return ret;
 882                 if (ret != (int)msg->size) {
 883                         RTE_LOG(ERR, VHOST_CONFIG,
 884                                 "read control message failed\n");
 885                         return -1;
 886                 }
 887         }
 888
 889         return ret;
 890 }
 891
 892 static int
 893 send_vhost_message(int sockfd, struct VhostUserMsg *msg)
 894 {
 895         int ret;
 896
 897         if (!msg)
 898                 return 0;
 899
 900         msg->flags &= ~VHOST_USER_VERSION_MASK;
 901         msg->flags &= ~VHOST_USER_NEED_REPLY;
 902         msg->flags |= VHOST_USER_VERSION;
 903         msg->flags |= VHOST_USER_REPLY_MASK;
 904
 905         ret = send_fd_message(sockfd, (char *)msg,
 906                 VHOST_USER_HDR_SIZE + msg->size, NULL, 0);
 907
 908         return ret;
 909 }
 910
 911 /*
 912  * Allocate a queue pair if it hasn't been allocated yet
 913  */
 914 static int
 915 vhost_user_check_and_alloc_queue_pair(struct virtio_net *dev, VhostUserMsg *msg)
 916 {
 917         uint16_t vring_idx;
 918
 919         switch (msg->request) {
 920         case VHOST_USER_SET_VRING_KICK:
 921         case VHOST_USER_SET_VRING_CALL:
 922         case VHOST_USER_SET_VRING_ERR:
 923                 vring_idx = msg->payload.u64 & VHOST_USER_VRING_IDX_MASK;
 924                 break;
 925         case VHOST_USER_SET_VRING_NUM:
 926         case VHOST_USER_SET_VRING_BASE:
 927         case VHOST_USER_SET_VRING_ENABLE:
 928                 vring_idx = msg->payload.state.index;
 929                 break;
 930         case VHOST_USER_SET_VRING_ADDR:
 931                 vring_idx = msg->payload.addr.index;
 932                 break;
 933         default:
 934                 return 0;
 935         }
 936
 937         if (vring_idx >= VHOST_MAX_VRING) {
 938                 RTE_LOG(ERR, VHOST_CONFIG,
 939                         "invalid vring index: %u\n", vring_idx);
 940                 return -1;
 941         }
 942
 943         if (dev->virtqueue[vring_idx])
 944                 return 0;
 945
 946         return alloc_vring_queue(dev, vring_idx);
 947 }
 948
 949 int
 950 vhost_user_msg_handler(int vid, int fd)
 951 {
 952         struct virtio_net *dev;
 953         struct VhostUserMsg msg;
 954         int ret;
 955
 956         dev = get_device(vid);
 957         if (dev == NULL)
 958                 return -1;
 959
 960         if (!dev->notify_ops) {
 961                 dev->notify_ops = vhost_driver_callback_get(dev->ifname);
 962                 if (!dev->notify_ops) {
 963                         RTE_LOG(ERR, VHOST_CONFIG,
 964                                 "failed to get callback ops for driver %s\n",
 965                                 dev->ifname);
 966                         return -1;
 967                 }
 968         }
 969
 970         ret = read_vhost_message(fd, &msg);
 971         if (ret <= 0 || msg.request >= VHOST_USER_MAX) {
 972                 if (ret < 0)
 973                         RTE_LOG(ERR, VHOST_CONFIG,
 974                                 "vhost read message failed\n");
 975                 else if (ret == 0)
 976                         RTE_LOG(INFO, VHOST_CONFIG,
 977                                 "vhost peer closed\n");
 978                 else
 979                         RTE_LOG(ERR, VHOST_CONFIG,
 980                                 "vhost read incorrect message\n");
 981
 982                 return -1;
 983         }
 984
 985         ret = 0;
 986         RTE_LOG(INFO, VHOST_CONFIG, "read message %s\n",
 987                 vhost_message_str[msg.request]);
 988
 989         ret = vhost_user_check_and_alloc_queue_pair(dev, &msg);
 990         if (ret < 0) {
 991                 RTE_LOG(ERR, VHOST_CONFIG,
 992                         "failed to alloc queue\n");
 993                 return -1;
 994         }
 995
 996         switch (msg.request) {
 997         case VHOST_USER_GET_FEATURES:
 998                 msg.payload.u64 = vhost_user_get_features(dev);
 999                 msg.size = sizeof(msg.payload.u64);
1000                 send_vhost_message(fd, &msg);
1001                 break;
1002         case VHOST_USER_SET_FEATURES:
1003                 vhost_user_set_features(dev, msg.payload.u64);
1004                 break;
1005
1006         case VHOST_USER_GET_PROTOCOL_FEATURES:
1007                 msg.payload.u64 = VHOST_USER_PROTOCOL_FEATURES;
1008                 msg.size = sizeof(msg.payload.u64);
1009                 send_vhost_message(fd, &msg);
1010                 break;
1011         case VHOST_USER_SET_PROTOCOL_FEATURES:
1012                 vhost_user_set_protocol_features(dev, msg.payload.u64);
1013                 break;
1014
1015         case VHOST_USER_SET_OWNER:
1016                 vhost_user_set_owner();
1017                 break;
1018         case VHOST_USER_RESET_OWNER:
1019                 vhost_user_reset_owner(dev);
1020                 break;
1021
1022         case VHOST_USER_SET_MEM_TABLE:
1023                 ret = vhost_user_set_mem_table(dev, &msg);
1024                 break;
1025
1026         case VHOST_USER_SET_LOG_BASE:
1027                 vhost_user_set_log_base(dev, &msg);
1028
1029                 /* it needs a reply */
1030                 msg.size = sizeof(msg.payload.u64);
1031                 send_vhost_message(fd, &msg);
1032                 break;
1033         case VHOST_USER_SET_LOG_FD:
1034                 close(msg.fds[0]);
1035                 RTE_LOG(INFO, VHOST_CONFIG, "not implemented.\n");
1036                 break;
1037
1038         case VHOST_USER_SET_VRING_NUM:
1039                 vhost_user_set_vring_num(dev, &msg.payload.state);
1040                 break;
1041         case VHOST_USER_SET_VRING_ADDR:
1042                 vhost_user_set_vring_addr(dev, &msg.payload.addr);
1043                 break;
1044         case VHOST_USER_SET_VRING_BASE:
1045                 vhost_user_set_vring_base(dev, &msg.payload.state);
1046                 break;
1047
1048         case VHOST_USER_GET_VRING_BASE:
1049                 vhost_user_get_vring_base(dev, &msg.payload.state);
1050                 msg.size = sizeof(msg.payload.state);
1051                 send_vhost_message(fd, &msg);
1052                 break;
1053
1054         case VHOST_USER_SET_VRING_KICK:
1055                 vhost_user_set_vring_kick(dev, &msg);
1056                 break;
1057         case VHOST_USER_SET_VRING_CALL:
1058                 vhost_user_set_vring_call(dev, &msg);
1059                 break;
1060
1061         case VHOST_USER_SET_VRING_ERR:
1062                 if (!(msg.payload.u64 & VHOST_USER_VRING_NOFD_MASK))
1063                         close(msg.fds[0]);
1064                 RTE_LOG(INFO, VHOST_CONFIG, "not implemented\n");
1065                 break;
1066
1067         case VHOST_USER_GET_QUEUE_NUM:
1068                 msg.payload.u64 = VHOST_MAX_QUEUE_PAIRS;
1069                 msg.size = sizeof(msg.payload.u64);
1070                 send_vhost_message(fd, &msg);
1071                 break;
1072
1073         case VHOST_USER_SET_VRING_ENABLE:
1074                 vhost_user_set_vring_enable(dev, &msg.payload.state);
1075                 break;
1076         case VHOST_USER_SEND_RARP:
1077                 vhost_user_send_rarp(dev, &msg);
1078                 break;
1079
1080         case VHOST_USER_NET_SET_MTU:
1081                 ret = vhost_user_net_set_mtu(dev, &msg);
1082                 break;
1083
1084         default:
1085                 ret = -1;
1086                 break;
1087
1088         }
1089
1090         if (msg.flags & VHOST_USER_NEED_REPLY) {
1091                 msg.payload.u64 = !!ret;
1092                 msg.size = sizeof(msg.payload.u64);
1093                 send_vhost_message(fd, &msg);
1094         }
1095
1096         if (!(dev->flags & VIRTIO_DEV_RUNNING) && virtio_is_ready(dev)) {
1097                 dev->flags |= VIRTIO_DEV_READY;
1098
1099                 if (!(dev->flags & VIRTIO_DEV_RUNNING)) {
1100                         if (dev->dequeue_zero_copy) {
1101                                 RTE_LOG(INFO, VHOST_CONFIG,
1102                                                 "dequeue zero copy is enabled\n");
1103                         }
1104
1105                         if (dev->notify_ops->new_device(dev->vid) == 0)
1106                                 dev->flags |= VIRTIO_DEV_RUNNING;
1107                 }
1108         }
1109
1110         return 0;
1111 }