lib/librte_vhost/vhost_user.c

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