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