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