lib/librte_vhost/vhost_user.c

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(c) 2010-2018 Intel Corporation
   3  */
   4
   5 /* Security model
   6  * --------------
   7  * The vhost-user protocol connection is an external interface, so it must be
   8  * robust against invalid inputs.
   9  *
  10  * This is important because the vhost-user master is only one step removed
  11  * from the guest.  Malicious guests that have escaped will then launch further
  12  * attacks from the vhost-user master.
  13  *
  14  * Even in deployments where guests are trusted, a bug in the vhost-user master
  15  * can still cause invalid messages to be sent.  Such messages must not
  16  * compromise the stability of the DPDK application by causing crashes, memory
  17  * corruption, or other problematic behavior.
  18  *
  19  * Do not assume received VhostUserMsg fields contain sensible values!
  20  */
  21
  22 #include <stdint.h>
  23 #include <stdio.h>
  24 #include <stdlib.h>
  25 #include <string.h>
  26 #include <unistd.h>
  27 #include <fcntl.h>
  28 #include <sys/ioctl.h>
  29 #include <sys/mman.h>
  30 #include <sys/types.h>
  31 #include <sys/stat.h>
  32 #include <sys/syscall.h>
  33 #include <assert.h>
  34 #ifdef RTE_LIBRTE_VHOST_NUMA
  35 #include <numaif.h>
  36 #endif
  37 #ifdef RTE_LIBRTE_VHOST_POSTCOPY
  38 #include <linux/userfaultfd.h>
  39 #endif
  40
  41 #include <rte_common.h>
  42 #include <rte_malloc.h>
  43 #include <rte_log.h>
  44
  45 #include "iotlb.h"
  46 #include "vhost.h"
  47 #include "vhost_user.h"
  48
  49 #define VIRTIO_MIN_MTU 68
  50 #define VIRTIO_MAX_MTU 65535
  51
  52 static const char *vhost_message_str[VHOST_USER_MAX] = {
  53         [VHOST_USER_NONE] = "VHOST_USER_NONE",
  54         [VHOST_USER_GET_FEATURES] = "VHOST_USER_GET_FEATURES",
  55         [VHOST_USER_SET_FEATURES] = "VHOST_USER_SET_FEATURES",
  56         [VHOST_USER_SET_OWNER] = "VHOST_USER_SET_OWNER",
  57         [VHOST_USER_RESET_OWNER] = "VHOST_USER_RESET_OWNER",
  58         [VHOST_USER_SET_MEM_TABLE] = "VHOST_USER_SET_MEM_TABLE",
  59         [VHOST_USER_SET_LOG_BASE] = "VHOST_USER_SET_LOG_BASE",
  60         [VHOST_USER_SET_LOG_FD] = "VHOST_USER_SET_LOG_FD",
  61         [VHOST_USER_SET_VRING_NUM] = "VHOST_USER_SET_VRING_NUM",
  62         [VHOST_USER_SET_VRING_ADDR] = "VHOST_USER_SET_VRING_ADDR",
  63         [VHOST_USER_SET_VRING_BASE] = "VHOST_USER_SET_VRING_BASE",
  64         [VHOST_USER_GET_VRING_BASE] = "VHOST_USER_GET_VRING_BASE",
  65         [VHOST_USER_SET_VRING_KICK] = "VHOST_USER_SET_VRING_KICK",
  66         [VHOST_USER_SET_VRING_CALL] = "VHOST_USER_SET_VRING_CALL",
  67         [VHOST_USER_SET_VRING_ERR]  = "VHOST_USER_SET_VRING_ERR",
  68         [VHOST_USER_GET_PROTOCOL_FEATURES]  = "VHOST_USER_GET_PROTOCOL_FEATURES",
  69         [VHOST_USER_SET_PROTOCOL_FEATURES]  = "VHOST_USER_SET_PROTOCOL_FEATURES",
  70         [VHOST_USER_GET_QUEUE_NUM]  = "VHOST_USER_GET_QUEUE_NUM",
  71         [VHOST_USER_SET_VRING_ENABLE]  = "VHOST_USER_SET_VRING_ENABLE",
  72         [VHOST_USER_SEND_RARP]  = "VHOST_USER_SEND_RARP",
  73         [VHOST_USER_NET_SET_MTU]  = "VHOST_USER_NET_SET_MTU",
  74         [VHOST_USER_SET_SLAVE_REQ_FD]  = "VHOST_USER_SET_SLAVE_REQ_FD",
  75         [VHOST_USER_IOTLB_MSG]  = "VHOST_USER_IOTLB_MSG",
  76         [VHOST_USER_CRYPTO_CREATE_SESS] = "VHOST_USER_CRYPTO_CREATE_SESS",
  77         [VHOST_USER_CRYPTO_CLOSE_SESS] = "VHOST_USER_CRYPTO_CLOSE_SESS",
  78         [VHOST_USER_POSTCOPY_ADVISE]  = "VHOST_USER_POSTCOPY_ADVISE",
  79         [VHOST_USER_POSTCOPY_LISTEN]  = "VHOST_USER_POSTCOPY_LISTEN",
  80         [VHOST_USER_POSTCOPY_END]  = "VHOST_USER_POSTCOPY_END",
  81 };
  82
  83 static int send_vhost_reply(int sockfd, struct VhostUserMsg *msg);
  84 static int read_vhost_message(int sockfd, struct VhostUserMsg *msg);
  85
  86 static uint64_t
  87 get_blk_size(int fd)
  88 {
  89         struct stat stat;
  90         int ret;
  91
  92         ret = fstat(fd, &stat);
  93         return ret == -1 ? (uint64_t)-1 : (uint64_t)stat.st_blksize;
  94 }
  95
  96 static void
  97 free_mem_region(struct virtio_net *dev)
  98 {
  99         uint32_t i;
 100         struct rte_vhost_mem_region *reg;
 101
 102         if (!dev || !dev->mem)
 103                 return;
 104
 105         for (i = 0; i < dev->mem->nregions; i++) {
 106                 reg = &dev->mem->regions[i];
 107                 if (reg->host_user_addr) {
 108                         munmap(reg->mmap_addr, reg->mmap_size);
 109                         close(reg->fd);
 110                 }
 111         }
 112 }
 113
 114 void
 115 vhost_backend_cleanup(struct virtio_net *dev)
 116 {
 117         if (dev->mem) {
 118                 free_mem_region(dev);
 119                 rte_free(dev->mem);
 120                 dev->mem = NULL;
 121         }
 122
 123         free(dev->guest_pages);
 124         dev->guest_pages = NULL;
 125
 126         if (dev->log_addr) {
 127                 munmap((void *)(uintptr_t)dev->log_addr, dev->log_size);
 128                 dev->log_addr = 0;
 129         }
 130
 131         if (dev->slave_req_fd >= 0) {
 132                 close(dev->slave_req_fd);
 133                 dev->slave_req_fd = -1;
 134         }
 135
 136         if (dev->postcopy_ufd >= 0) {
 137                 close(dev->postcopy_ufd);
 138                 dev->postcopy_ufd = -1;
 139         }
 140
 141         dev->postcopy_listening = 0;
 142 }
 143
 144 /*
 145  * This function just returns success at the moment unless
 146  * the device hasn't been initialised.
 147  */
 148 static int
 149 vhost_user_set_owner(struct virtio_net **pdev __rte_unused,
 150                         struct VhostUserMsg *msg __rte_unused,
 151                         int main_fd __rte_unused)
 152 {
 153         return VH_RESULT_OK;
 154 }
 155
 156 static int
 157 vhost_user_reset_owner(struct virtio_net **pdev,
 158                         struct VhostUserMsg *msg __rte_unused,
 159                         int main_fd __rte_unused)
 160 {
 161         struct virtio_net *dev = *pdev;
 162         vhost_destroy_device_notify(dev);
 163
 164         cleanup_device(dev, 0);
 165         reset_device(dev);
 166         return VH_RESULT_OK;
 167 }
 168
 169 /*
 170  * The features that we support are requested.
 171  */
 172 static int
 173 vhost_user_get_features(struct virtio_net **pdev, struct VhostUserMsg *msg,
 174                         int main_fd __rte_unused)
 175 {
 176         struct virtio_net *dev = *pdev;
 177         uint64_t features = 0;
 178
 179         rte_vhost_driver_get_features(dev->ifname, &features);
 180
 181         msg->payload.u64 = features;
 182         msg->size = sizeof(msg->payload.u64);
 183         msg->fd_num = 0;
 184
 185         return VH_RESULT_REPLY;
 186 }
 187
 188 /*
 189  * The queue number that we support are requested.
 190  */
 191 static int
 192 vhost_user_get_queue_num(struct virtio_net **pdev, struct VhostUserMsg *msg,
 193                         int main_fd __rte_unused)
 194 {
 195         struct virtio_net *dev = *pdev;
 196         uint32_t queue_num = 0;
 197
 198         rte_vhost_driver_get_queue_num(dev->ifname, &queue_num);
 199
 200         msg->payload.u64 = (uint64_t)queue_num;
 201         msg->size = sizeof(msg->payload.u64);
 202         msg->fd_num = 0;
 203
 204         return VH_RESULT_REPLY;
 205 }
 206
 207 /*
 208  * We receive the negotiated features supported by us and the virtio device.
 209  */
 210 static int
 211 vhost_user_set_features(struct virtio_net **pdev, struct VhostUserMsg *msg,
 212                         int main_fd __rte_unused)
 213 {
 214         struct virtio_net *dev = *pdev;
 215         uint64_t features = msg->payload.u64;
 216         uint64_t vhost_features = 0;
 217         struct rte_vdpa_device *vdpa_dev;
 218         int did = -1;
 219
 220         rte_vhost_driver_get_features(dev->ifname, &vhost_features);
 221         if (features & ~vhost_features) {
 222                 RTE_LOG(ERR, VHOST_CONFIG,
 223                         "(%d) received invalid negotiated features.\n",
 224                         dev->vid);
 225                 return VH_RESULT_ERR;
 226         }
 227
 228         if (dev->flags & VIRTIO_DEV_RUNNING) {
 229                 if (dev->features == features)
 230                         return VH_RESULT_OK;
 231
 232                 /*
 233                  * Error out if master tries to change features while device is
 234                  * in running state. The exception being VHOST_F_LOG_ALL, which
 235                  * is enabled when the live-migration starts.
 236                  */
 237                 if ((dev->features ^ features) & ~(1ULL << VHOST_F_LOG_ALL)) {
 238                         RTE_LOG(ERR, VHOST_CONFIG,
 239                                 "(%d) features changed while device is running.\n",
 240                                 dev->vid);
 241                         return VH_RESULT_ERR;
 242                 }
 243
 244                 if (dev->notify_ops->features_changed)
 245                         dev->notify_ops->features_changed(dev->vid, features);
 246         }
 247
 248         dev->features = features;
 249         if (dev->features &
 250                 ((1 << VIRTIO_NET_F_MRG_RXBUF) | (1ULL << VIRTIO_F_VERSION_1))) {
 251                 dev->vhost_hlen = sizeof(struct virtio_net_hdr_mrg_rxbuf);
 252         } else {
 253                 dev->vhost_hlen = sizeof(struct virtio_net_hdr);
 254         }
 255         VHOST_LOG_DEBUG(VHOST_CONFIG,
 256                 "(%d) mergeable RX buffers %s, virtio 1 %s\n",
 257                 dev->vid,
 258                 (dev->features & (1 << VIRTIO_NET_F_MRG_RXBUF)) ? "on" : "off",
 259                 (dev->features & (1ULL << VIRTIO_F_VERSION_1)) ? "on" : "off");
 260
 261         if ((dev->flags & VIRTIO_DEV_BUILTIN_VIRTIO_NET) &&
 262             !(dev->features & (1ULL << VIRTIO_NET_F_MQ))) {
 263                 /*
 264                  * Remove all but first queue pair if MQ hasn't been
 265                  * negotiated. This is safe because the device is not
 266                  * running at this stage.
 267                  */
 268                 while (dev->nr_vring > 2) {
 269                         struct vhost_virtqueue *vq;
 270
 271                         vq = dev->virtqueue[--dev->nr_vring];
 272                         if (!vq)
 273                                 continue;
 274
 275                         dev->virtqueue[dev->nr_vring] = NULL;
 276                         cleanup_vq(vq, 1);
 277                         free_vq(dev, vq);
 278                 }
 279         }
 280
 281         did = dev->vdpa_dev_id;
 282         vdpa_dev = rte_vdpa_get_device(did);
 283         if (vdpa_dev && vdpa_dev->ops->set_features)
 284                 vdpa_dev->ops->set_features(dev->vid);
 285
 286         return VH_RESULT_OK;
 287 }
 288
 289 /*
 290  * The virtio device sends us the size of the descriptor ring.
 291  */
 292 static int
 293 vhost_user_set_vring_num(struct virtio_net **pdev,
 294                         struct VhostUserMsg *msg,
 295                         int main_fd __rte_unused)
 296 {
 297         struct virtio_net *dev = *pdev;
 298         struct vhost_virtqueue *vq = dev->virtqueue[msg->payload.state.index];
 299
 300         vq->size = msg->payload.state.num;
 301
 302         /* VIRTIO 1.0, 2.4 Virtqueues says:
 303          *
 304          *   Queue Size value is always a power of 2. The maximum Queue Size
 305          *   value is 32768.
 306          */
 307         if ((vq->size & (vq->size - 1)) || vq->size > 32768) {
 308                 RTE_LOG(ERR, VHOST_CONFIG,
 309                         "invalid virtqueue size %u\n", vq->size);
 310                 return VH_RESULT_ERR;
 311         }
 312
 313         if (dev->dequeue_zero_copy) {
 314                 vq->nr_zmbuf = 0;
 315                 vq->last_zmbuf_idx = 0;
 316                 vq->zmbuf_size = vq->size;
 317                 vq->zmbufs = rte_zmalloc(NULL, vq->zmbuf_size *
 318                                          sizeof(struct zcopy_mbuf), 0);
 319                 if (vq->zmbufs == NULL) {
 320                         RTE_LOG(WARNING, VHOST_CONFIG,
 321                                 "failed to allocate mem for zero copy; "
 322                                 "zero copy is force disabled\n");
 323                         dev->dequeue_zero_copy = 0;
 324                 }
 325                 TAILQ_INIT(&vq->zmbuf_list);
 326         }
 327
 328         if (vq_is_packed(dev)) {
 329                 vq->shadow_used_packed = rte_malloc(NULL,
 330                                 vq->size *
 331                                 sizeof(struct vring_used_elem_packed),
 332                                 RTE_CACHE_LINE_SIZE);
 333                 if (!vq->shadow_used_packed) {
 334                         RTE_LOG(ERR, VHOST_CONFIG,
 335                                         "failed to allocate memory for shadow used ring.\n");
 336                         return VH_RESULT_ERR;
 337                 }
 338
 339         } else {
 340                 vq->shadow_used_split = rte_malloc(NULL,
 341                                 vq->size * sizeof(struct vring_used_elem),
 342                                 RTE_CACHE_LINE_SIZE);
 343                 if (!vq->shadow_used_split) {
 344                         RTE_LOG(ERR, VHOST_CONFIG,
 345                                         "failed to allocate memory for shadow used ring.\n");
 346                         return VH_RESULT_ERR;
 347                 }
 348         }
 349
 350         vq->batch_copy_elems = rte_malloc(NULL,
 351                                 vq->size * sizeof(struct batch_copy_elem),
 352                                 RTE_CACHE_LINE_SIZE);
 353         if (!vq->batch_copy_elems) {
 354                 RTE_LOG(ERR, VHOST_CONFIG,
 355                         "failed to allocate memory for batching copy.\n");
 356                 return VH_RESULT_ERR;
 357         }
 358
 359         return VH_RESULT_OK;
 360 }
 361
 362 /*
 363  * Reallocate virtio_dev and vhost_virtqueue data structure to make them on the
 364  * same numa node as the memory of vring descriptor.
 365  */
 366 #ifdef RTE_LIBRTE_VHOST_NUMA
 367 static struct virtio_net*
 368 numa_realloc(struct virtio_net *dev, int index)
 369 {
 370         int oldnode, newnode;
 371         struct virtio_net *old_dev;
 372         struct vhost_virtqueue *old_vq, *vq;
 373         struct zcopy_mbuf *new_zmbuf;
 374         struct vring_used_elem *new_shadow_used_split;
 375         struct vring_used_elem_packed *new_shadow_used_packed;
 376         struct batch_copy_elem *new_batch_copy_elems;
 377         int ret;
 378
 379         old_dev = dev;
 380         vq = old_vq = dev->virtqueue[index];
 381
 382         ret = get_mempolicy(&newnode, NULL, 0, old_vq->desc,
 383                             MPOL_F_NODE | MPOL_F_ADDR);
 384
 385         /* check if we need to reallocate vq */
 386         ret |= get_mempolicy(&oldnode, NULL, 0, old_vq,
 387                              MPOL_F_NODE | MPOL_F_ADDR);
 388         if (ret) {
 389                 RTE_LOG(ERR, VHOST_CONFIG,
 390                         "Unable to get vq numa information.\n");
 391                 return dev;
 392         }
 393         if (oldnode != newnode) {
 394                 RTE_LOG(INFO, VHOST_CONFIG,
 395                         "reallocate vq from %d to %d node\n", oldnode, newnode);
 396                 vq = rte_malloc_socket(NULL, sizeof(*vq), 0, newnode);
 397                 if (!vq)
 398                         return dev;
 399
 400                 memcpy(vq, old_vq, sizeof(*vq));
 401                 TAILQ_INIT(&vq->zmbuf_list);
 402
 403                 if (dev->dequeue_zero_copy) {
 404                         new_zmbuf = rte_malloc_socket(NULL, vq->zmbuf_size *
 405                                         sizeof(struct zcopy_mbuf), 0, newnode);
 406                         if (new_zmbuf) {
 407                                 rte_free(vq->zmbufs);
 408                                 vq->zmbufs = new_zmbuf;
 409                         }
 410                 }
 411
 412                 if (vq_is_packed(dev)) {
 413                         new_shadow_used_packed = rte_malloc_socket(NULL,
 414                                         vq->size *
 415                                         sizeof(struct vring_used_elem_packed),
 416                                         RTE_CACHE_LINE_SIZE,
 417                                         newnode);
 418                         if (new_shadow_used_packed) {
 419                                 rte_free(vq->shadow_used_packed);
 420                                 vq->shadow_used_packed = new_shadow_used_packed;
 421                         }
 422                 } else {
 423                         new_shadow_used_split = rte_malloc_socket(NULL,
 424                                         vq->size *
 425                                         sizeof(struct vring_used_elem),
 426                                         RTE_CACHE_LINE_SIZE,
 427                                         newnode);
 428                         if (new_shadow_used_split) {
 429                                 rte_free(vq->shadow_used_split);
 430                                 vq->shadow_used_split = new_shadow_used_split;
 431                         }
 432                 }
 433
 434                 new_batch_copy_elems = rte_malloc_socket(NULL,
 435                         vq->size * sizeof(struct batch_copy_elem),
 436                         RTE_CACHE_LINE_SIZE,
 437                         newnode);
 438                 if (new_batch_copy_elems) {
 439                         rte_free(vq->batch_copy_elems);
 440                         vq->batch_copy_elems = new_batch_copy_elems;
 441                 }
 442
 443                 rte_free(old_vq);
 444         }
 445
 446         /* check if we need to reallocate dev */
 447         ret = get_mempolicy(&oldnode, NULL, 0, old_dev,
 448                             MPOL_F_NODE | MPOL_F_ADDR);
 449         if (ret) {
 450                 RTE_LOG(ERR, VHOST_CONFIG,
 451                         "Unable to get dev numa information.\n");
 452                 goto out;
 453         }
 454         if (oldnode != newnode) {
 455                 RTE_LOG(INFO, VHOST_CONFIG,
 456                         "reallocate dev from %d to %d node\n",
 457                         oldnode, newnode);
 458                 dev = rte_malloc_socket(NULL, sizeof(*dev), 0, newnode);
 459                 if (!dev) {
 460                         dev = old_dev;
 461                         goto out;
 462                 }
 463
 464                 memcpy(dev, old_dev, sizeof(*dev));
 465                 rte_free(old_dev);
 466         }
 467
 468 out:
 469         dev->virtqueue[index] = vq;
 470         vhost_devices[dev->vid] = dev;
 471
 472         if (old_vq != vq)
 473                 vhost_user_iotlb_init(dev, index);
 474
 475         return dev;
 476 }
 477 #else
 478 static struct virtio_net*
 479 numa_realloc(struct virtio_net *dev, int index __rte_unused)
 480 {
 481         return dev;
 482 }
 483 #endif
 484
 485 /* Converts QEMU virtual address to Vhost virtual address. */
 486 static uint64_t
 487 qva_to_vva(struct virtio_net *dev, uint64_t qva, uint64_t *len)
 488 {
 489         struct rte_vhost_mem_region *r;
 490         uint32_t i;
 491
 492         /* Find the region where the address lives. */
 493         for (i = 0; i < dev->mem->nregions; i++) {
 494                 r = &dev->mem->regions[i];
 495
 496                 if (qva >= r->guest_user_addr &&
 497                     qva <  r->guest_user_addr + r->size) {
 498
 499                         if (unlikely(*len > r->guest_user_addr + r->size - qva))
 500                                 *len = r->guest_user_addr + r->size - qva;
 501
 502                         return qva - r->guest_user_addr +
 503                                r->host_user_addr;
 504                 }
 505         }
 506         *len = 0;
 507
 508         return 0;
 509 }
 510
 511
 512 /*
 513  * Converts ring address to Vhost virtual address.
 514  * If IOMMU is enabled, the ring address is a guest IO virtual address,
 515  * else it is a QEMU virtual address.
 516  */
 517 static uint64_t
 518 ring_addr_to_vva(struct virtio_net *dev, struct vhost_virtqueue *vq,
 519                 uint64_t ra, uint64_t *size)
 520 {
 521         if (dev->features & (1ULL << VIRTIO_F_IOMMU_PLATFORM)) {
 522                 uint64_t vva;
 523
 524                 vva = vhost_user_iotlb_cache_find(vq, ra,
 525                                         size, VHOST_ACCESS_RW);
 526                 if (!vva)
 527                         vhost_user_iotlb_miss(dev, ra, VHOST_ACCESS_RW);
 528
 529                 return vva;
 530         }
 531
 532         return qva_to_vva(dev, ra, size);
 533 }
 534
 535 static struct virtio_net *
 536 translate_ring_addresses(struct virtio_net *dev, int vq_index)
 537 {
 538         struct vhost_virtqueue *vq = dev->virtqueue[vq_index];
 539         struct vhost_vring_addr *addr = &vq->ring_addrs;
 540         uint64_t len;
 541
 542         if (vq_is_packed(dev)) {
 543                 len = sizeof(struct vring_packed_desc) * vq->size;
 544                 vq->desc_packed = (struct vring_packed_desc *)(uintptr_t)
 545                         ring_addr_to_vva(dev, vq, addr->desc_user_addr, &len);
 546                 vq->log_guest_addr = 0;
 547                 if (vq->desc_packed == NULL ||
 548                                 len != sizeof(struct vring_packed_desc) *
 549                                 vq->size) {
 550                         RTE_LOG(DEBUG, VHOST_CONFIG,
 551                                 "(%d) failed to map desc_packed ring.\n",
 552                                 dev->vid);
 553                         return dev;
 554                 }
 555
 556                 dev = numa_realloc(dev, vq_index);
 557                 vq = dev->virtqueue[vq_index];
 558                 addr = &vq->ring_addrs;
 559
 560                 len = sizeof(struct vring_packed_desc_event);
 561                 vq->driver_event = (struct vring_packed_desc_event *)
 562                                         (uintptr_t)ring_addr_to_vva(dev,
 563                                         vq, addr->avail_user_addr, &len);
 564                 if (vq->driver_event == NULL ||
 565                                 len != sizeof(struct vring_packed_desc_event)) {
 566                         RTE_LOG(DEBUG, VHOST_CONFIG,
 567                                 "(%d) failed to find driver area address.\n",
 568                                 dev->vid);
 569                         return dev;
 570                 }
 571
 572                 len = sizeof(struct vring_packed_desc_event);
 573                 vq->device_event = (struct vring_packed_desc_event *)
 574                                         (uintptr_t)ring_addr_to_vva(dev,
 575                                         vq, addr->used_user_addr, &len);
 576                 if (vq->device_event == NULL ||
 577                                 len != sizeof(struct vring_packed_desc_event)) {
 578                         RTE_LOG(DEBUG, VHOST_CONFIG,
 579                                 "(%d) failed to find device area address.\n",
 580                                 dev->vid);
 581                         return dev;
 582                 }
 583
 584                 return dev;
 585         }
 586
 587         /* The addresses are converted from QEMU virtual to Vhost virtual. */
 588         if (vq->desc && vq->avail && vq->used)
 589                 return dev;
 590
 591         len = sizeof(struct vring_desc) * vq->size;
 592         vq->desc = (struct vring_desc *)(uintptr_t)ring_addr_to_vva(dev,
 593                         vq, addr->desc_user_addr, &len);
 594         if (vq->desc == 0 || len != sizeof(struct vring_desc) * vq->size) {
 595                 RTE_LOG(DEBUG, VHOST_CONFIG,
 596                         "(%d) failed to map desc ring.\n",
 597                         dev->vid);
 598                 return dev;
 599         }
 600
 601         dev = numa_realloc(dev, vq_index);
 602         vq = dev->virtqueue[vq_index];
 603         addr = &vq->ring_addrs;
 604
 605         len = sizeof(struct vring_avail) + sizeof(uint16_t) * vq->size;
 606         vq->avail = (struct vring_avail *)(uintptr_t)ring_addr_to_vva(dev,
 607                         vq, addr->avail_user_addr, &len);
 608         if (vq->avail == 0 ||
 609                         len != sizeof(struct vring_avail) +
 610                         sizeof(uint16_t) * vq->size) {
 611                 RTE_LOG(DEBUG, VHOST_CONFIG,
 612                         "(%d) failed to map avail ring.\n",
 613                         dev->vid);
 614                 return dev;
 615         }
 616
 617         len = sizeof(struct vring_used) +
 618                 sizeof(struct vring_used_elem) * vq->size;
 619         vq->used = (struct vring_used *)(uintptr_t)ring_addr_to_vva(dev,
 620                         vq, addr->used_user_addr, &len);
 621         if (vq->used == 0 || len != sizeof(struct vring_used) +
 622                         sizeof(struct vring_used_elem) * vq->size) {
 623                 RTE_LOG(DEBUG, VHOST_CONFIG,
 624                         "(%d) failed to map used ring.\n",
 625                         dev->vid);
 626                 return dev;
 627         }
 628
 629         if (vq->last_used_idx != vq->used->idx) {
 630                 RTE_LOG(WARNING, VHOST_CONFIG,
 631                         "last_used_idx (%u) and vq->used->idx (%u) mismatches; "
 632                         "some packets maybe resent for Tx and dropped for Rx\n",
 633                         vq->last_used_idx, vq->used->idx);
 634                 vq->last_used_idx  = vq->used->idx;
 635                 vq->last_avail_idx = vq->used->idx;
 636         }
 637
 638         vq->log_guest_addr = addr->log_guest_addr;
 639
 640         VHOST_LOG_DEBUG(VHOST_CONFIG, "(%d) mapped address desc: %p\n",
 641                         dev->vid, vq->desc);
 642         VHOST_LOG_DEBUG(VHOST_CONFIG, "(%d) mapped address avail: %p\n",
 643                         dev->vid, vq->avail);
 644         VHOST_LOG_DEBUG(VHOST_CONFIG, "(%d) mapped address used: %p\n",
 645                         dev->vid, vq->used);
 646         VHOST_LOG_DEBUG(VHOST_CONFIG, "(%d) log_guest_addr: %" PRIx64 "\n",
 647                         dev->vid, vq->log_guest_addr);
 648
 649         return dev;
 650 }
 651
 652 /*
 653  * The virtio device sends us the desc, used and avail ring addresses.
 654  * This function then converts these to our address space.
 655  */
 656 static int
 657 vhost_user_set_vring_addr(struct virtio_net **pdev, struct VhostUserMsg *msg,
 658                         int main_fd __rte_unused)
 659 {
 660         struct virtio_net *dev = *pdev;
 661         struct vhost_virtqueue *vq;
 662         struct vhost_vring_addr *addr = &msg->payload.addr;
 663
 664         if (dev->mem == NULL)
 665                 return VH_RESULT_ERR;
 666
 667         /* addr->index refers to the queue index. The txq 1, rxq is 0. */
 668         vq = dev->virtqueue[msg->payload.addr.index];
 669
 670         /*
 671          * Rings addresses should not be interpreted as long as the ring is not
 672          * started and enabled
 673          */
 674         memcpy(&vq->ring_addrs, addr, sizeof(*addr));
 675
 676         vring_invalidate(dev, vq);
 677
 678         if (vq->enabled && (dev->features &
 679                                 (1ULL << VHOST_USER_F_PROTOCOL_FEATURES))) {
 680                 dev = translate_ring_addresses(dev, msg->payload.addr.index);
 681                 if (!dev)
 682                         return VH_RESULT_ERR;
 683
 684                 *pdev = dev;
 685         }
 686
 687         return VH_RESULT_OK;
 688 }
 689
 690 /*
 691  * The virtio device sends us the available ring last used index.
 692  */
 693 static int
 694 vhost_user_set_vring_base(struct virtio_net **pdev,
 695                         struct VhostUserMsg *msg,
 696                         int main_fd __rte_unused)
 697 {
 698         struct virtio_net *dev = *pdev;
 699         struct vhost_virtqueue *vq = dev->virtqueue[msg->payload.state.index];
 700         uint64_t val = msg->payload.state.num;
 701
 702         if (vq_is_packed(dev)) {
 703                 /*
 704                  * Bit[0:14]: avail index
 705                  * Bit[15]: avail wrap counter
 706                  */
 707                 vq->last_avail_idx = val & 0x7fff;
 708                 vq->avail_wrap_counter = !!(val & (0x1 << 15));
 709                 /*
 710                  * Set used index to same value as available one, as
 711                  * their values should be the same since ring processing
 712                  * was stopped at get time.
 713                  */
 714                 vq->last_used_idx = vq->last_avail_idx;
 715                 vq->used_wrap_counter = vq->avail_wrap_counter;
 716         } else {
 717                 vq->last_used_idx = msg->payload.state.num;
 718                 vq->last_avail_idx = msg->payload.state.num;
 719         }
 720
 721         return VH_RESULT_OK;
 722 }
 723
 724 static int
 725 add_one_guest_page(struct virtio_net *dev, uint64_t guest_phys_addr,
 726                    uint64_t host_phys_addr, uint64_t size)
 727 {
 728         struct guest_page *page, *last_page;
 729
 730         if (dev->nr_guest_pages == dev->max_guest_pages) {
 731                 dev->max_guest_pages *= 2;
 732                 dev->guest_pages = realloc(dev->guest_pages,
 733                                         dev->max_guest_pages * sizeof(*page));
 734                 if (!dev->guest_pages) {
 735                         RTE_LOG(ERR, VHOST_CONFIG, "cannot realloc guest_pages\n");
 736                         return -1;
 737                 }
 738         }
 739
 740         if (dev->nr_guest_pages > 0) {
 741                 last_page = &dev->guest_pages[dev->nr_guest_pages - 1];
 742                 /* merge if the two pages are continuous */
 743                 if (host_phys_addr == last_page->host_phys_addr +
 744                                       last_page->size) {
 745                         last_page->size += size;
 746                         return 0;
 747                 }
 748         }
 749
 750         page = &dev->guest_pages[dev->nr_guest_pages++];
 751         page->guest_phys_addr = guest_phys_addr;
 752         page->host_phys_addr  = host_phys_addr;
 753         page->size = size;
 754
 755         return 0;
 756 }
 757
 758 static int
 759 add_guest_pages(struct virtio_net *dev, struct rte_vhost_mem_region *reg,
 760                 uint64_t page_size)
 761 {
 762         uint64_t reg_size = reg->size;
 763         uint64_t host_user_addr  = reg->host_user_addr;
 764         uint64_t guest_phys_addr = reg->guest_phys_addr;
 765         uint64_t host_phys_addr;
 766         uint64_t size;
 767
 768         host_phys_addr = rte_mem_virt2iova((void *)(uintptr_t)host_user_addr);
 769         size = page_size - (guest_phys_addr & (page_size - 1));
 770         size = RTE_MIN(size, reg_size);
 771
 772         if (add_one_guest_page(dev, guest_phys_addr, host_phys_addr, size) < 0)
 773                 return -1;
 774
 775         host_user_addr  += size;
 776         guest_phys_addr += size;
 777         reg_size -= size;
 778
 779         while (reg_size > 0) {
 780                 size = RTE_MIN(reg_size, page_size);
 781                 host_phys_addr = rte_mem_virt2iova((void *)(uintptr_t)
 782                                                   host_user_addr);
 783                 if (add_one_guest_page(dev, guest_phys_addr, host_phys_addr,
 784                                 size) < 0)
 785                         return -1;
 786
 787                 host_user_addr  += size;
 788                 guest_phys_addr += size;
 789                 reg_size -= size;
 790         }
 791
 792         return 0;
 793 }
 794
 795 #ifdef RTE_LIBRTE_VHOST_DEBUG
 796 /* TODO: enable it only in debug mode? */
 797 static void
 798 dump_guest_pages(struct virtio_net *dev)
 799 {
 800         uint32_t i;
 801         struct guest_page *page;
 802
 803         for (i = 0; i < dev->nr_guest_pages; i++) {
 804                 page = &dev->guest_pages[i];
 805
 806                 RTE_LOG(INFO, VHOST_CONFIG,
 807                         "guest physical page region %u\n"
 808                         "\t guest_phys_addr: %" PRIx64 "\n"
 809                         "\t host_phys_addr : %" PRIx64 "\n"
 810                         "\t size           : %" PRIx64 "\n",
 811                         i,
 812                         page->guest_phys_addr,
 813                         page->host_phys_addr,
 814                         page->size);
 815         }
 816 }
 817 #else
 818 #define dump_guest_pages(dev)
 819 #endif
 820
 821 static bool
 822 vhost_memory_changed(struct VhostUserMemory *new,
 823                      struct rte_vhost_memory *old)
 824 {
 825         uint32_t i;
 826
 827         if (new->nregions != old->nregions)
 828                 return true;
 829
 830         for (i = 0; i < new->nregions; ++i) {
 831                 VhostUserMemoryRegion *new_r = &new->regions[i];
 832                 struct rte_vhost_mem_region *old_r = &old->regions[i];
 833
 834                 if (new_r->guest_phys_addr != old_r->guest_phys_addr)
 835                         return true;
 836                 if (new_r->memory_size != old_r->size)
 837                         return true;
 838                 if (new_r->userspace_addr != old_r->guest_user_addr)
 839                         return true;
 840         }
 841
 842         return false;
 843 }
 844
 845 static int
 846 vhost_user_set_mem_table(struct virtio_net **pdev, struct VhostUserMsg *msg,
 847                         int main_fd)
 848 {
 849         struct virtio_net *dev = *pdev;
 850         struct VhostUserMemory *memory = &msg->payload.memory;
 851         struct rte_vhost_mem_region *reg;
 852         void *mmap_addr;
 853         uint64_t mmap_size;
 854         uint64_t mmap_offset;
 855         uint64_t alignment;
 856         uint32_t i;
 857         int populate;
 858         int fd;
 859
 860         if (memory->nregions > VHOST_MEMORY_MAX_NREGIONS) {
 861                 RTE_LOG(ERR, VHOST_CONFIG,
 862                         "too many memory regions (%u)\n", memory->nregions);
 863                 return VH_RESULT_ERR;
 864         }
 865
 866         if (dev->mem && !vhost_memory_changed(memory, dev->mem)) {
 867                 RTE_LOG(INFO, VHOST_CONFIG,
 868                         "(%d) memory regions not changed\n", dev->vid);
 869
 870                 for (i = 0; i < memory->nregions; i++)
 871                         close(msg->fds[i]);
 872
 873                 return VH_RESULT_OK;
 874         }
 875
 876         if (dev->mem) {
 877                 free_mem_region(dev);
 878                 rte_free(dev->mem);
 879                 dev->mem = NULL;
 880         }
 881
 882         /* Flush IOTLB cache as previous HVAs are now invalid */
 883         if (dev->features & (1ULL << VIRTIO_F_IOMMU_PLATFORM))
 884                 for (i = 0; i < dev->nr_vring; i++)
 885                         vhost_user_iotlb_flush_all(dev->virtqueue[i]);
 886
 887         dev->nr_guest_pages = 0;
 888         if (!dev->guest_pages) {
 889                 dev->max_guest_pages = 8;
 890                 dev->guest_pages = malloc(dev->max_guest_pages *
 891                                                 sizeof(struct guest_page));
 892                 if (dev->guest_pages == NULL) {
 893                         RTE_LOG(ERR, VHOST_CONFIG,
 894                                 "(%d) failed to allocate memory "
 895                                 "for dev->guest_pages\n",
 896                                 dev->vid);
 897                         return VH_RESULT_ERR;
 898                 }
 899         }
 900
 901         dev->mem = rte_zmalloc("vhost-mem-table", sizeof(struct rte_vhost_memory) +
 902                 sizeof(struct rte_vhost_mem_region) * memory->nregions, 0);
 903         if (dev->mem == NULL) {
 904                 RTE_LOG(ERR, VHOST_CONFIG,
 905                         "(%d) failed to allocate memory for dev->mem\n",
 906                         dev->vid);
 907                 return VH_RESULT_ERR;
 908         }
 909         dev->mem->nregions = memory->nregions;
 910
 911         for (i = 0; i < memory->nregions; i++) {
 912                 fd  = msg->fds[i];
 913                 reg = &dev->mem->regions[i];
 914
 915                 reg->guest_phys_addr = memory->regions[i].guest_phys_addr;
 916                 reg->guest_user_addr = memory->regions[i].userspace_addr;
 917                 reg->size            = memory->regions[i].memory_size;
 918                 reg->fd              = fd;
 919
 920                 mmap_offset = memory->regions[i].mmap_offset;
 921
 922                 /* Check for memory_size + mmap_offset overflow */
 923                 if (mmap_offset >= -reg->size) {
 924                         RTE_LOG(ERR, VHOST_CONFIG,
 925                                 "mmap_offset (%#"PRIx64") and memory_size "
 926                                 "(%#"PRIx64") overflow\n",
 927                                 mmap_offset, reg->size);
 928                         goto err_mmap;
 929                 }
 930
 931                 mmap_size = reg->size + mmap_offset;
 932
 933                 /* mmap() without flag of MAP_ANONYMOUS, should be called
 934                  * with length argument aligned with hugepagesz at older
 935                  * longterm version Linux, like 2.6.32 and 3.2.72, or
 936                  * mmap() will fail with EINVAL.
 937                  *
 938                  * to avoid failure, make sure in caller to keep length
 939                  * aligned.
 940                  */
 941                 alignment = get_blk_size(fd);
 942                 if (alignment == (uint64_t)-1) {
 943                         RTE_LOG(ERR, VHOST_CONFIG,
 944                                 "couldn't get hugepage size through fstat\n");
 945                         goto err_mmap;
 946                 }
 947                 mmap_size = RTE_ALIGN_CEIL(mmap_size, alignment);
 948
 949                 populate = (dev->dequeue_zero_copy) ? MAP_POPULATE : 0;
 950                 mmap_addr = mmap(NULL, mmap_size, PROT_READ | PROT_WRITE,
 951                                  MAP_SHARED | populate, fd, 0);
 952
 953                 if (mmap_addr == MAP_FAILED) {
 954                         RTE_LOG(ERR, VHOST_CONFIG,
 955                                 "mmap region %u failed.\n", i);
 956                         goto err_mmap;
 957                 }
 958
 959                 reg->mmap_addr = mmap_addr;
 960                 reg->mmap_size = mmap_size;
 961                 reg->host_user_addr = (uint64_t)(uintptr_t)mmap_addr +
 962                                       mmap_offset;
 963
 964                 if (dev->dequeue_zero_copy)
 965                         if (add_guest_pages(dev, reg, alignment) < 0) {
 966                                 RTE_LOG(ERR, VHOST_CONFIG,
 967                                         "adding guest pages to region %u failed.\n",
 968                                         i);
 969                                 goto err_mmap;
 970                         }
 971
 972                 RTE_LOG(INFO, VHOST_CONFIG,
 973                         "guest memory region %u, size: 0x%" PRIx64 "\n"
 974                         "\t guest physical addr: 0x%" PRIx64 "\n"
 975                         "\t guest virtual  addr: 0x%" PRIx64 "\n"
 976                         "\t host  virtual  addr: 0x%" PRIx64 "\n"
 977                         "\t mmap addr : 0x%" PRIx64 "\n"
 978                         "\t mmap size : 0x%" PRIx64 "\n"
 979                         "\t mmap align: 0x%" PRIx64 "\n"
 980                         "\t mmap off  : 0x%" PRIx64 "\n",
 981                         i, reg->size,
 982                         reg->guest_phys_addr,
 983                         reg->guest_user_addr,
 984                         reg->host_user_addr,
 985                         (uint64_t)(uintptr_t)mmap_addr,
 986                         mmap_size,
 987                         alignment,
 988                         mmap_offset);
 989
 990                 if (dev->postcopy_listening) {
 991                         /*
 992                          * We haven't a better way right now than sharing
 993                          * DPDK's virtual address with Qemu, so that Qemu can
 994                          * retrieve the region offset when handling userfaults.
 995                          */
 996                         memory->regions[i].userspace_addr =
 997                                 reg->host_user_addr;
 998                 }
 999         }
1000         if (dev->postcopy_listening) {
1001                 /* Send the addresses back to qemu */
1002                 msg->fd_num = 0;
1003                 send_vhost_reply(main_fd, msg);
1004
1005                 /* Wait for qemu to acknolwedge it's got the addresses
1006                  * we've got to wait before we're allowed to generate faults.
1007                  */
1008                 VhostUserMsg ack_msg;
1009                 if (read_vhost_message(main_fd, &ack_msg) <= 0) {
1010                         RTE_LOG(ERR, VHOST_CONFIG,
1011                                 "Failed to read qemu ack on postcopy set-mem-table\n");
1012                         goto err_mmap;
1013                 }
1014                 if (ack_msg.request.master != VHOST_USER_SET_MEM_TABLE) {
1015                         RTE_LOG(ERR, VHOST_CONFIG,
1016                                 "Bad qemu ack on postcopy set-mem-table (%d)\n",
1017                                 ack_msg.request.master);
1018                         goto err_mmap;
1019                 }
1020
1021                 /* Now userfault register and we can use the memory */
1022                 for (i = 0; i < memory->nregions; i++) {
1023 #ifdef RTE_LIBRTE_VHOST_POSTCOPY
1024                         reg = &dev->mem->regions[i];
1025                         struct uffdio_register reg_struct;
1026
1027                         /*
1028                          * Let's register all the mmap'ed area to ensure
1029                          * alignment on page boundary.
1030                          */
1031                         reg_struct.range.start =
1032                                 (uint64_t)(uintptr_t)reg->mmap_addr;
1033                         reg_struct.range.len = reg->mmap_size;
1034                         reg_struct.mode = UFFDIO_REGISTER_MODE_MISSING;
1035
1036                         if (ioctl(dev->postcopy_ufd, UFFDIO_REGISTER,
1037                                                 &reg_struct)) {
1038                                 RTE_LOG(ERR, VHOST_CONFIG,
1039                                         "Failed to register ufd for region %d: (ufd = %d) %s\n",
1040                                         i, dev->postcopy_ufd,
1041                                         strerror(errno));
1042                                 goto err_mmap;
1043                         }
1044                         RTE_LOG(INFO, VHOST_CONFIG,
1045                                 "\t userfaultfd registered for range : %llx - %llx\n",
1046                                 reg_struct.range.start,
1047                                 reg_struct.range.start +
1048                                 reg_struct.range.len - 1);
1049 #else
1050                         goto err_mmap;
1051 #endif
1052                 }
1053         }
1054
1055         for (i = 0; i < dev->nr_vring; i++) {
1056                 struct vhost_virtqueue *vq = dev->virtqueue[i];
1057
1058                 if (vq->desc || vq->avail || vq->used) {
1059                         /*
1060                          * If the memory table got updated, the ring addresses
1061                          * need to be translated again as virtual addresses have
1062                          * changed.
1063                          */
1064                         vring_invalidate(dev, vq);
1065
1066                         dev = translate_ring_addresses(dev, i);
1067                         if (!dev) {
1068                                 dev = *pdev;
1069                                 goto err_mmap;
1070                         }
1071
1072                         *pdev = dev;
1073                 }
1074         }
1075
1076         dump_guest_pages(dev);
1077
1078         return VH_RESULT_OK;
1079
1080 err_mmap:
1081         free_mem_region(dev);
1082         rte_free(dev->mem);
1083         dev->mem = NULL;
1084         return VH_RESULT_ERR;
1085 }
1086
1087 static bool
1088 vq_is_ready(struct virtio_net *dev, struct vhost_virtqueue *vq)
1089 {
1090         bool rings_ok;
1091
1092         if (!vq)
1093                 return false;
1094
1095         if (vq_is_packed(dev))
1096                 rings_ok = !!vq->desc_packed;
1097         else
1098                 rings_ok = vq->desc && vq->avail && vq->used;
1099
1100         return rings_ok &&
1101                vq->kickfd != VIRTIO_UNINITIALIZED_EVENTFD &&
1102                vq->callfd != VIRTIO_UNINITIALIZED_EVENTFD;
1103 }
1104
1105 static int
1106 virtio_is_ready(struct virtio_net *dev)
1107 {
1108         struct vhost_virtqueue *vq;
1109         uint32_t i;
1110
1111         if (dev->nr_vring == 0)
1112                 return 0;
1113
1114         for (i = 0; i < dev->nr_vring; i++) {
1115                 vq = dev->virtqueue[i];
1116
1117                 if (!vq_is_ready(dev, vq))
1118                         return 0;
1119         }
1120
1121         RTE_LOG(INFO, VHOST_CONFIG,
1122                 "virtio is now ready for processing.\n");
1123         return 1;
1124 }
1125
1126 static int
1127 vhost_user_set_vring_call(struct virtio_net **pdev, struct VhostUserMsg *msg,
1128                         int main_fd __rte_unused)
1129 {
1130         struct virtio_net *dev = *pdev;
1131         struct vhost_vring_file file;
1132         struct vhost_virtqueue *vq;
1133
1134         file.index = msg->payload.u64 & VHOST_USER_VRING_IDX_MASK;
1135         if (msg->payload.u64 & VHOST_USER_VRING_NOFD_MASK)
1136                 file.fd = VIRTIO_INVALID_EVENTFD;
1137         else
1138                 file.fd = msg->fds[0];
1139         RTE_LOG(INFO, VHOST_CONFIG,
1140                 "vring call idx:%d file:%d\n", file.index, file.fd);
1141
1142         vq = dev->virtqueue[file.index];
1143         if (vq->callfd >= 0)
1144                 close(vq->callfd);
1145
1146         vq->callfd = file.fd;
1147
1148         return VH_RESULT_OK;
1149 }
1150
1151 static int vhost_user_set_vring_err(struct virtio_net **pdev __rte_unused,
1152                         struct VhostUserMsg *msg,
1153                         int main_fd __rte_unused)
1154 {
1155         if (!(msg->payload.u64 & VHOST_USER_VRING_NOFD_MASK))
1156                 close(msg->fds[0]);
1157         RTE_LOG(INFO, VHOST_CONFIG, "not implemented\n");
1158
1159         return VH_RESULT_OK;
1160 }
1161
1162 static int
1163 vhost_user_set_vring_kick(struct virtio_net **pdev, struct VhostUserMsg *msg,
1164                         int main_fd __rte_unused)
1165 {
1166         struct virtio_net *dev = *pdev;
1167         struct vhost_vring_file file;
1168         struct vhost_virtqueue *vq;
1169
1170         file.index = msg->payload.u64 & VHOST_USER_VRING_IDX_MASK;
1171         if (msg->payload.u64 & VHOST_USER_VRING_NOFD_MASK)
1172                 file.fd = VIRTIO_INVALID_EVENTFD;
1173         else
1174                 file.fd = msg->fds[0];
1175         RTE_LOG(INFO, VHOST_CONFIG,
1176                 "vring kick idx:%d file:%d\n", file.index, file.fd);
1177
1178         /* Interpret ring addresses only when ring is started. */
1179         dev = translate_ring_addresses(dev, file.index);
1180         if (!dev)
1181                 return VH_RESULT_ERR;
1182
1183         *pdev = dev;
1184
1185         vq = dev->virtqueue[file.index];
1186
1187         /*
1188          * When VHOST_USER_F_PROTOCOL_FEATURES is not negotiated,
1189          * the ring starts already enabled. Otherwise, it is enabled via
1190          * the SET_VRING_ENABLE message.
1191          */
1192         if (!(dev->features & (1ULL << VHOST_USER_F_PROTOCOL_FEATURES)))
1193                 vq->enabled = 1;
1194
1195         if (vq->kickfd >= 0)
1196                 close(vq->kickfd);
1197         vq->kickfd = file.fd;
1198
1199         return VH_RESULT_OK;
1200 }
1201
1202 static void
1203 free_zmbufs(struct vhost_virtqueue *vq)
1204 {
1205         struct zcopy_mbuf *zmbuf, *next;
1206
1207         for (zmbuf = TAILQ_FIRST(&vq->zmbuf_list);
1208              zmbuf != NULL; zmbuf = next) {
1209                 next = TAILQ_NEXT(zmbuf, next);
1210
1211                 rte_pktmbuf_free(zmbuf->mbuf);
1212                 TAILQ_REMOVE(&vq->zmbuf_list, zmbuf, next);
1213         }
1214
1215         rte_free(vq->zmbufs);
1216 }
1217
1218 /*
1219  * when virtio is stopped, qemu will send us the GET_VRING_BASE message.
1220  */
1221 static int
1222 vhost_user_get_vring_base(struct virtio_net **pdev,
1223                         struct VhostUserMsg *msg,
1224                         int main_fd __rte_unused)
1225 {
1226         struct virtio_net *dev = *pdev;
1227         struct vhost_virtqueue *vq = dev->virtqueue[msg->payload.state.index];
1228         uint64_t val;
1229
1230         /* We have to stop the queue (virtio) if it is running. */
1231         vhost_destroy_device_notify(dev);
1232
1233         dev->flags &= ~VIRTIO_DEV_READY;
1234         dev->flags &= ~VIRTIO_DEV_VDPA_CONFIGURED;
1235
1236         /* Here we are safe to get the indexes */
1237         if (vq_is_packed(dev)) {
1238                 /*
1239                  * Bit[0:14]: avail index
1240                  * Bit[15]: avail wrap counter
1241                  */
1242                 val = vq->last_avail_idx & 0x7fff;
1243                 val |= vq->avail_wrap_counter << 15;
1244                 msg->payload.state.num = val;
1245         } else {
1246                 msg->payload.state.num = vq->last_avail_idx;
1247         }
1248
1249         RTE_LOG(INFO, VHOST_CONFIG,
1250                 "vring base idx:%d file:%d\n", msg->payload.state.index,
1251                 msg->payload.state.num);
1252         /*
1253          * Based on current qemu vhost-user implementation, this message is
1254          * sent and only sent in vhost_vring_stop.
1255          * TODO: cleanup the vring, it isn't usable since here.
1256          */
1257         if (vq->kickfd >= 0)
1258                 close(vq->kickfd);
1259
1260         vq->kickfd = VIRTIO_UNINITIALIZED_EVENTFD;
1261
1262         if (vq->callfd >= 0)
1263                 close(vq->callfd);
1264
1265         vq->callfd = VIRTIO_UNINITIALIZED_EVENTFD;
1266
1267         if (dev->dequeue_zero_copy)
1268                 free_zmbufs(vq);
1269         if (vq_is_packed(dev)) {
1270                 rte_free(vq->shadow_used_packed);
1271                 vq->shadow_used_packed = NULL;
1272         } else {
1273                 rte_free(vq->shadow_used_split);
1274                 vq->shadow_used_split = NULL;
1275         }
1276
1277         rte_free(vq->batch_copy_elems);
1278         vq->batch_copy_elems = NULL;
1279
1280         msg->size = sizeof(msg->payload.state);
1281         msg->fd_num = 0;
1282
1283         return VH_RESULT_REPLY;
1284 }
1285
1286 /*
1287  * when virtio queues are ready to work, qemu will send us to
1288  * enable the virtio queue pair.
1289  */
1290 static int
1291 vhost_user_set_vring_enable(struct virtio_net **pdev,
1292                         struct VhostUserMsg *msg,
1293                         int main_fd __rte_unused)
1294 {
1295         struct virtio_net *dev = *pdev;
1296         int enable = (int)msg->payload.state.num;
1297         int index = (int)msg->payload.state.index;
1298         struct rte_vdpa_device *vdpa_dev;
1299         int did = -1;
1300
1301         RTE_LOG(INFO, VHOST_CONFIG,
1302                 "set queue enable: %d to qp idx: %d\n",
1303                 enable, index);
1304
1305         did = dev->vdpa_dev_id;
1306         vdpa_dev = rte_vdpa_get_device(did);
1307         if (vdpa_dev && vdpa_dev->ops->set_vring_state)
1308                 vdpa_dev->ops->set_vring_state(dev->vid, index, enable);
1309
1310         if (dev->notify_ops->vring_state_changed)
1311                 dev->notify_ops->vring_state_changed(dev->vid,
1312                                 index, enable);
1313
1314         dev->virtqueue[index]->enabled = enable;
1315
1316         return VH_RESULT_OK;
1317 }
1318
1319 static int
1320 vhost_user_get_protocol_features(struct virtio_net **pdev,
1321                         struct VhostUserMsg *msg,
1322                         int main_fd __rte_unused)
1323 {
1324         struct virtio_net *dev = *pdev;
1325         uint64_t features, protocol_features;
1326
1327         rte_vhost_driver_get_features(dev->ifname, &features);
1328         rte_vhost_driver_get_protocol_features(dev->ifname, &protocol_features);
1329
1330         /*
1331          * REPLY_ACK protocol feature is only mandatory for now
1332          * for IOMMU feature. If IOMMU is explicitly disabled by the
1333          * application, disable also REPLY_ACK feature for older buggy
1334          * Qemu versions (from v2.7.0 to v2.9.0).
1335          */
1336         if (!(features & (1ULL << VIRTIO_F_IOMMU_PLATFORM)))
1337                 protocol_features &= ~(1ULL << VHOST_USER_PROTOCOL_F_REPLY_ACK);
1338
1339         msg->payload.u64 = protocol_features;
1340         msg->size = sizeof(msg->payload.u64);
1341         msg->fd_num = 0;
1342
1343         return VH_RESULT_REPLY;
1344 }
1345
1346 static int
1347 vhost_user_set_protocol_features(struct virtio_net **pdev,
1348                         struct VhostUserMsg *msg,
1349                         int main_fd __rte_unused)
1350 {
1351         struct virtio_net *dev = *pdev;
1352         uint64_t protocol_features = msg->payload.u64;
1353         uint64_t slave_protocol_features = 0;
1354
1355         rte_vhost_driver_get_protocol_features(dev->ifname,
1356                         &slave_protocol_features);
1357         if (protocol_features & ~slave_protocol_features) {
1358                 RTE_LOG(ERR, VHOST_CONFIG,
1359                         "(%d) received invalid protocol features.\n",
1360                         dev->vid);
1361                 return VH_RESULT_ERR;
1362         }
1363
1364         dev->protocol_features = protocol_features;
1365
1366         return VH_RESULT_OK;
1367 }
1368
1369 static int
1370 vhost_user_set_log_base(struct virtio_net **pdev, struct VhostUserMsg *msg,
1371                         int main_fd __rte_unused)
1372 {
1373         struct virtio_net *dev = *pdev;
1374         int fd = msg->fds[0];
1375         uint64_t size, off;
1376         void *addr;
1377
1378         if (fd < 0) {
1379                 RTE_LOG(ERR, VHOST_CONFIG, "invalid log fd: %d\n", fd);
1380                 return VH_RESULT_ERR;
1381         }
1382
1383         if (msg->size != sizeof(VhostUserLog)) {
1384                 RTE_LOG(ERR, VHOST_CONFIG,
1385                         "invalid log base msg size: %"PRId32" != %d\n",
1386                         msg->size, (int)sizeof(VhostUserLog));
1387                 return VH_RESULT_ERR;
1388         }
1389
1390         size = msg->payload.log.mmap_size;
1391         off  = msg->payload.log.mmap_offset;
1392
1393         /* Don't allow mmap_offset to point outside the mmap region */
1394         if (off > size) {
1395                 RTE_LOG(ERR, VHOST_CONFIG,
1396                         "log offset %#"PRIx64" exceeds log size %#"PRIx64"\n",
1397                         off, size);
1398                 return VH_RESULT_ERR;
1399         }
1400
1401         RTE_LOG(INFO, VHOST_CONFIG,
1402                 "log mmap size: %"PRId64", offset: %"PRId64"\n",
1403                 size, off);
1404
1405         /*
1406          * mmap from 0 to workaround a hugepage mmap bug: mmap will
1407          * fail when offset is not page size aligned.
1408          */
1409         addr = mmap(0, size + off, PROT_READ | PROT_WRITE, MAP_SHARED, fd, 0);
1410         close(fd);
1411         if (addr == MAP_FAILED) {
1412                 RTE_LOG(ERR, VHOST_CONFIG, "mmap log base failed!\n");
1413                 return VH_RESULT_ERR;
1414         }
1415
1416         /*
1417          * Free previously mapped log memory on occasionally
1418          * multiple VHOST_USER_SET_LOG_BASE.
1419          */
1420         if (dev->log_addr) {
1421                 munmap((void *)(uintptr_t)dev->log_addr, dev->log_size);
1422         }
1423         dev->log_addr = (uint64_t)(uintptr_t)addr;
1424         dev->log_base = dev->log_addr + off;
1425         dev->log_size = size;
1426
1427         /*
1428          * The spec is not clear about it (yet), but QEMU doesn't expect
1429          * any payload in the reply.
1430          */
1431         msg->size = 0;
1432         msg->fd_num = 0;
1433
1434         return VH_RESULT_REPLY;
1435 }
1436
1437 static int vhost_user_set_log_fd(struct virtio_net **pdev __rte_unused,
1438                         struct VhostUserMsg *msg,
1439                         int main_fd __rte_unused)
1440 {
1441         close(msg->fds[0]);
1442         RTE_LOG(INFO, VHOST_CONFIG, "not implemented.\n");
1443
1444         return VH_RESULT_OK;
1445 }
1446
1447 /*
1448  * An rarp packet is constructed and broadcasted to notify switches about
1449  * the new location of the migrated VM, so that packets from outside will
1450  * not be lost after migration.
1451  *
1452  * However, we don't actually "send" a rarp packet here, instead, we set
1453  * a flag 'broadcast_rarp' to let rte_vhost_dequeue_burst() inject it.
1454  */
1455 static int
1456 vhost_user_send_rarp(struct virtio_net **pdev, struct VhostUserMsg *msg,
1457                         int main_fd __rte_unused)
1458 {
1459         struct virtio_net *dev = *pdev;
1460         uint8_t *mac = (uint8_t *)&msg->payload.u64;
1461         struct rte_vdpa_device *vdpa_dev;
1462         int did = -1;
1463
1464         RTE_LOG(DEBUG, VHOST_CONFIG,
1465                 ":: mac: %02x:%02x:%02x:%02x:%02x:%02x\n",
1466                 mac[0], mac[1], mac[2], mac[3], mac[4], mac[5]);
1467         memcpy(dev->mac.addr_bytes, mac, 6);
1468
1469         /*
1470          * Set the flag to inject a RARP broadcast packet at
1471          * rte_vhost_dequeue_burst().
1472          *
1473          * rte_smp_wmb() is for making sure the mac is copied
1474          * before the flag is set.
1475          */
1476         rte_smp_wmb();
1477         rte_atomic16_set(&dev->broadcast_rarp, 1);
1478         did = dev->vdpa_dev_id;
1479         vdpa_dev = rte_vdpa_get_device(did);
1480         if (vdpa_dev && vdpa_dev->ops->migration_done)
1481                 vdpa_dev->ops->migration_done(dev->vid);
1482
1483         return VH_RESULT_OK;
1484 }
1485
1486 static int
1487 vhost_user_net_set_mtu(struct virtio_net **pdev, struct VhostUserMsg *msg,
1488                         int main_fd __rte_unused)
1489 {
1490         struct virtio_net *dev = *pdev;
1491         if (msg->payload.u64 < VIRTIO_MIN_MTU ||
1492                         msg->payload.u64 > VIRTIO_MAX_MTU) {
1493                 RTE_LOG(ERR, VHOST_CONFIG, "Invalid MTU size (%"PRIu64")\n",
1494                                 msg->payload.u64);
1495
1496                 return VH_RESULT_ERR;
1497         }
1498
1499         dev->mtu = msg->payload.u64;
1500
1501         return VH_RESULT_OK;
1502 }
1503
1504 static int
1505 vhost_user_set_req_fd(struct virtio_net **pdev, struct VhostUserMsg *msg,
1506                         int main_fd __rte_unused)
1507 {
1508         struct virtio_net *dev = *pdev;
1509         int fd = msg->fds[0];
1510
1511         if (fd < 0) {
1512                 RTE_LOG(ERR, VHOST_CONFIG,
1513                                 "Invalid file descriptor for slave channel (%d)\n",
1514                                 fd);
1515                 return VH_RESULT_ERR;
1516         }
1517
1518         dev->slave_req_fd = fd;
1519
1520         return VH_RESULT_OK;
1521 }
1522
1523 static int
1524 is_vring_iotlb_update(struct vhost_virtqueue *vq, struct vhost_iotlb_msg *imsg)
1525 {
1526         struct vhost_vring_addr *ra;
1527         uint64_t start, end;
1528
1529         start = imsg->iova;
1530         end = start + imsg->size;
1531
1532         ra = &vq->ring_addrs;
1533         if (ra->desc_user_addr >= start && ra->desc_user_addr < end)
1534                 return 1;
1535         if (ra->avail_user_addr >= start && ra->avail_user_addr < end)
1536                 return 1;
1537         if (ra->used_user_addr >= start && ra->used_user_addr < end)
1538                 return 1;
1539
1540         return 0;
1541 }
1542
1543 static int
1544 is_vring_iotlb_invalidate(struct vhost_virtqueue *vq,
1545                                 struct vhost_iotlb_msg *imsg)
1546 {
1547         uint64_t istart, iend, vstart, vend;
1548
1549         istart = imsg->iova;
1550         iend = istart + imsg->size - 1;
1551
1552         vstart = (uintptr_t)vq->desc;
1553         vend = vstart + sizeof(struct vring_desc) * vq->size - 1;
1554         if (vstart <= iend && istart <= vend)
1555                 return 1;
1556
1557         vstart = (uintptr_t)vq->avail;
1558         vend = vstart + sizeof(struct vring_avail);
1559         vend += sizeof(uint16_t) * vq->size - 1;
1560         if (vstart <= iend && istart <= vend)
1561                 return 1;
1562
1563         vstart = (uintptr_t)vq->used;
1564         vend = vstart + sizeof(struct vring_used);
1565         vend += sizeof(struct vring_used_elem) * vq->size - 1;
1566         if (vstart <= iend && istart <= vend)
1567                 return 1;
1568
1569         return 0;
1570 }
1571
1572 static int
1573 vhost_user_iotlb_msg(struct virtio_net **pdev, struct VhostUserMsg *msg,
1574                         int main_fd __rte_unused)
1575 {
1576         struct virtio_net *dev = *pdev;
1577         struct vhost_iotlb_msg *imsg = &msg->payload.iotlb;
1578         uint16_t i;
1579         uint64_t vva, len;
1580
1581         switch (imsg->type) {
1582         case VHOST_IOTLB_UPDATE:
1583                 len = imsg->size;
1584                 vva = qva_to_vva(dev, imsg->uaddr, &len);
1585                 if (!vva)
1586                         return VH_RESULT_ERR;
1587
1588                 for (i = 0; i < dev->nr_vring; i++) {
1589                         struct vhost_virtqueue *vq = dev->virtqueue[i];
1590
1591                         vhost_user_iotlb_cache_insert(vq, imsg->iova, vva,
1592                                         len, imsg->perm);
1593
1594                         if (is_vring_iotlb_update(vq, imsg))
1595                                 *pdev = dev = translate_ring_addresses(dev, i);
1596                 }
1597                 break;
1598         case VHOST_IOTLB_INVALIDATE:
1599                 for (i = 0; i < dev->nr_vring; i++) {
1600                         struct vhost_virtqueue *vq = dev->virtqueue[i];
1601
1602                         vhost_user_iotlb_cache_remove(vq, imsg->iova,
1603                                         imsg->size);
1604
1605                         if (is_vring_iotlb_invalidate(vq, imsg))
1606                                 vring_invalidate(dev, vq);
1607                 }
1608                 break;
1609         default:
1610                 RTE_LOG(ERR, VHOST_CONFIG, "Invalid IOTLB message type (%d)\n",
1611                                 imsg->type);
1612                 return VH_RESULT_ERR;
1613         }
1614
1615         return VH_RESULT_OK;
1616 }
1617
1618 static int
1619 vhost_user_set_postcopy_advise(struct virtio_net **pdev,
1620                         struct VhostUserMsg *msg,
1621                         int main_fd __rte_unused)
1622 {
1623         struct virtio_net *dev = *pdev;
1624 #ifdef RTE_LIBRTE_VHOST_POSTCOPY
1625         struct uffdio_api api_struct;
1626
1627         dev->postcopy_ufd = syscall(__NR_userfaultfd, O_CLOEXEC | O_NONBLOCK);
1628
1629         if (dev->postcopy_ufd == -1) {
1630                 RTE_LOG(ERR, VHOST_CONFIG, "Userfaultfd not available: %s\n",
1631                         strerror(errno));
1632                 return VH_RESULT_ERR;
1633         }
1634         api_struct.api = UFFD_API;
1635         api_struct.features = 0;
1636         if (ioctl(dev->postcopy_ufd, UFFDIO_API, &api_struct)) {
1637                 RTE_LOG(ERR, VHOST_CONFIG, "UFFDIO_API ioctl failure: %s\n",
1638                         strerror(errno));
1639                 close(dev->postcopy_ufd);
1640                 dev->postcopy_ufd = -1;
1641                 return VH_RESULT_ERR;
1642         }
1643         msg->fds[0] = dev->postcopy_ufd;
1644         msg->fd_num = 1;
1645
1646         return VH_RESULT_REPLY;
1647 #else
1648         dev->postcopy_ufd = -1;
1649         msg->fd_num = 0;
1650
1651         return VH_RESULT_ERR;
1652 #endif
1653 }
1654
1655 static int
1656 vhost_user_set_postcopy_listen(struct virtio_net **pdev,
1657                         struct VhostUserMsg *msg __rte_unused,
1658                         int main_fd __rte_unused)
1659 {
1660         struct virtio_net *dev = *pdev;
1661
1662         if (dev->mem && dev->mem->nregions) {
1663                 RTE_LOG(ERR, VHOST_CONFIG,
1664                         "Regions already registered at postcopy-listen\n");
1665                 return VH_RESULT_ERR;
1666         }
1667         dev->postcopy_listening = 1;
1668
1669         return VH_RESULT_OK;
1670 }
1671
1672 static int
1673 vhost_user_postcopy_end(struct virtio_net **pdev, struct VhostUserMsg *msg,
1674                         int main_fd __rte_unused)
1675 {
1676         struct virtio_net *dev = *pdev;
1677
1678         dev->postcopy_listening = 0;
1679         if (dev->postcopy_ufd >= 0) {
1680                 close(dev->postcopy_ufd);
1681                 dev->postcopy_ufd = -1;
1682         }
1683
1684         msg->payload.u64 = 0;
1685         msg->size = sizeof(msg->payload.u64);
1686         msg->fd_num = 0;
1687
1688         return VH_RESULT_REPLY;
1689 }
1690
1691 typedef int (*vhost_message_handler_t)(struct virtio_net **pdev,
1692                                         struct VhostUserMsg *msg,
1693                                         int main_fd);
1694 static vhost_message_handler_t vhost_message_handlers[VHOST_USER_MAX] = {
1695         [VHOST_USER_NONE] = NULL,
1696         [VHOST_USER_GET_FEATURES] = vhost_user_get_features,
1697         [VHOST_USER_SET_FEATURES] = vhost_user_set_features,
1698         [VHOST_USER_SET_OWNER] = vhost_user_set_owner,
1699         [VHOST_USER_RESET_OWNER] = vhost_user_reset_owner,
1700         [VHOST_USER_SET_MEM_TABLE] = vhost_user_set_mem_table,
1701         [VHOST_USER_SET_LOG_BASE] = vhost_user_set_log_base,
1702         [VHOST_USER_SET_LOG_FD] = vhost_user_set_log_fd,
1703         [VHOST_USER_SET_VRING_NUM] = vhost_user_set_vring_num,
1704         [VHOST_USER_SET_VRING_ADDR] = vhost_user_set_vring_addr,
1705         [VHOST_USER_SET_VRING_BASE] = vhost_user_set_vring_base,
1706         [VHOST_USER_GET_VRING_BASE] = vhost_user_get_vring_base,
1707         [VHOST_USER_SET_VRING_KICK] = vhost_user_set_vring_kick,
1708         [VHOST_USER_SET_VRING_CALL] = vhost_user_set_vring_call,
1709         [VHOST_USER_SET_VRING_ERR] = vhost_user_set_vring_err,
1710         [VHOST_USER_GET_PROTOCOL_FEATURES] = vhost_user_get_protocol_features,
1711         [VHOST_USER_SET_PROTOCOL_FEATURES] = vhost_user_set_protocol_features,
1712         [VHOST_USER_GET_QUEUE_NUM] = vhost_user_get_queue_num,
1713         [VHOST_USER_SET_VRING_ENABLE] = vhost_user_set_vring_enable,
1714         [VHOST_USER_SEND_RARP] = vhost_user_send_rarp,
1715         [VHOST_USER_NET_SET_MTU] = vhost_user_net_set_mtu,
1716         [VHOST_USER_SET_SLAVE_REQ_FD] = vhost_user_set_req_fd,
1717         [VHOST_USER_IOTLB_MSG] = vhost_user_iotlb_msg,
1718         [VHOST_USER_POSTCOPY_ADVISE] = vhost_user_set_postcopy_advise,
1719         [VHOST_USER_POSTCOPY_LISTEN] = vhost_user_set_postcopy_listen,
1720         [VHOST_USER_POSTCOPY_END] = vhost_user_postcopy_end,
1721 };
1722
1723
1724 /* return bytes# of read on success or negative val on failure. */
1725 static int
1726 read_vhost_message(int sockfd, struct VhostUserMsg *msg)
1727 {
1728         int ret;
1729
1730         ret = read_fd_message(sockfd, (char *)msg, VHOST_USER_HDR_SIZE,
1731                 msg->fds, VHOST_MEMORY_MAX_NREGIONS, &msg->fd_num);
1732         if (ret <= 0)
1733                 return ret;
1734
1735         if (msg && msg->size) {
1736                 if (msg->size > sizeof(msg->payload)) {
1737                         RTE_LOG(ERR, VHOST_CONFIG,
1738                                 "invalid msg size: %d\n", msg->size);
1739                         return -1;
1740                 }
1741                 ret = read(sockfd, &msg->payload, msg->size);
1742                 if (ret <= 0)
1743                         return ret;
1744                 if (ret != (int)msg->size) {
1745                         RTE_LOG(ERR, VHOST_CONFIG,
1746                                 "read control message failed\n");
1747                         return -1;
1748                 }
1749         }
1750
1751         return ret;
1752 }
1753
1754 static int
1755 send_vhost_message(int sockfd, struct VhostUserMsg *msg)
1756 {
1757         if (!msg)
1758                 return 0;
1759
1760         return send_fd_message(sockfd, (char *)msg,
1761                 VHOST_USER_HDR_SIZE + msg->size, msg->fds, msg->fd_num);
1762 }
1763
1764 static int
1765 send_vhost_reply(int sockfd, struct VhostUserMsg *msg)
1766 {
1767         if (!msg)
1768                 return 0;
1769
1770         msg->flags &= ~VHOST_USER_VERSION_MASK;
1771         msg->flags &= ~VHOST_USER_NEED_REPLY;
1772         msg->flags |= VHOST_USER_VERSION;
1773         msg->flags |= VHOST_USER_REPLY_MASK;
1774
1775         return send_vhost_message(sockfd, msg);
1776 }
1777
1778 static int
1779 send_vhost_slave_message(struct virtio_net *dev, struct VhostUserMsg *msg)
1780 {
1781         int ret;
1782
1783         if (msg->flags & VHOST_USER_NEED_REPLY)
1784                 rte_spinlock_lock(&dev->slave_req_lock);
1785
1786         ret = send_vhost_message(dev->slave_req_fd, msg);
1787         if (ret < 0 && (msg->flags & VHOST_USER_NEED_REPLY))
1788                 rte_spinlock_unlock(&dev->slave_req_lock);
1789
1790         return ret;
1791 }
1792
1793 /*
1794  * Allocate a queue pair if it hasn't been allocated yet
1795  */
1796 static int
1797 vhost_user_check_and_alloc_queue_pair(struct virtio_net *dev,
1798                         struct VhostUserMsg *msg)
1799 {
1800         uint16_t vring_idx;
1801
1802         switch (msg->request.master) {
1803         case VHOST_USER_SET_VRING_KICK:
1804         case VHOST_USER_SET_VRING_CALL:
1805         case VHOST_USER_SET_VRING_ERR:
1806                 vring_idx = msg->payload.u64 & VHOST_USER_VRING_IDX_MASK;
1807                 break;
1808         case VHOST_USER_SET_VRING_NUM:
1809         case VHOST_USER_SET_VRING_BASE:
1810         case VHOST_USER_SET_VRING_ENABLE:
1811                 vring_idx = msg->payload.state.index;
1812                 break;
1813         case VHOST_USER_SET_VRING_ADDR:
1814                 vring_idx = msg->payload.addr.index;
1815                 break;
1816         default:
1817                 return 0;
1818         }
1819
1820         if (vring_idx >= VHOST_MAX_VRING) {
1821                 RTE_LOG(ERR, VHOST_CONFIG,
1822                         "invalid vring index: %u\n", vring_idx);
1823                 return -1;
1824         }
1825
1826         if (dev->virtqueue[vring_idx])
1827                 return 0;
1828
1829         return alloc_vring_queue(dev, vring_idx);
1830 }
1831
1832 static void
1833 vhost_user_lock_all_queue_pairs(struct virtio_net *dev)
1834 {
1835         unsigned int i = 0;
1836         unsigned int vq_num = 0;
1837
1838         while (vq_num < dev->nr_vring) {
1839                 struct vhost_virtqueue *vq = dev->virtqueue[i];
1840
1841                 if (vq) {
1842                         rte_spinlock_lock(&vq->access_lock);
1843                         vq_num++;
1844                 }
1845                 i++;
1846         }
1847 }
1848
1849 static void
1850 vhost_user_unlock_all_queue_pairs(struct virtio_net *dev)
1851 {
1852         unsigned int i = 0;
1853         unsigned int vq_num = 0;
1854
1855         while (vq_num < dev->nr_vring) {
1856                 struct vhost_virtqueue *vq = dev->virtqueue[i];
1857
1858                 if (vq) {
1859                         rte_spinlock_unlock(&vq->access_lock);
1860                         vq_num++;
1861                 }
1862                 i++;
1863         }
1864 }
1865
1866 int
1867 vhost_user_msg_handler(int vid, int fd)
1868 {
1869         struct virtio_net *dev;
1870         struct VhostUserMsg msg;
1871         struct rte_vdpa_device *vdpa_dev;
1872         int did = -1;
1873         int ret;
1874         int unlock_required = 0;
1875         uint32_t skip_master = 0;
1876         int request;
1877
1878         dev = get_device(vid);
1879         if (dev == NULL)
1880                 return -1;
1881
1882         if (!dev->notify_ops) {
1883                 dev->notify_ops = vhost_driver_callback_get(dev->ifname);
1884                 if (!dev->notify_ops) {
1885                         RTE_LOG(ERR, VHOST_CONFIG,
1886                                 "failed to get callback ops for driver %s\n",
1887                                 dev->ifname);
1888                         return -1;
1889                 }
1890         }
1891
1892         ret = read_vhost_message(fd, &msg);
1893         if (ret <= 0 || msg.request.master >= VHOST_USER_MAX) {
1894                 if (ret < 0)
1895                         RTE_LOG(ERR, VHOST_CONFIG,
1896                                 "vhost read message failed\n");
1897                 else if (ret == 0)
1898                         RTE_LOG(INFO, VHOST_CONFIG,
1899                                 "vhost peer closed\n");
1900                 else
1901                         RTE_LOG(ERR, VHOST_CONFIG,
1902                                 "vhost read incorrect message\n");
1903
1904                 return -1;
1905         }
1906
1907         ret = 0;
1908         if (msg.request.master != VHOST_USER_IOTLB_MSG)
1909                 RTE_LOG(INFO, VHOST_CONFIG, "read message %s\n",
1910                         vhost_message_str[msg.request.master]);
1911         else
1912                 RTE_LOG(DEBUG, VHOST_CONFIG, "read message %s\n",
1913                         vhost_message_str[msg.request.master]);
1914
1915         ret = vhost_user_check_and_alloc_queue_pair(dev, &msg);
1916         if (ret < 0) {
1917                 RTE_LOG(ERR, VHOST_CONFIG,
1918                         "failed to alloc queue\n");
1919                 return -1;
1920         }
1921
1922         /*
1923          * Note: we don't lock all queues on VHOST_USER_GET_VRING_BASE
1924          * and VHOST_USER_RESET_OWNER, since it is sent when virtio stops
1925          * and device is destroyed. destroy_device waits for queues to be
1926          * inactive, so it is safe. Otherwise taking the access_lock
1927          * would cause a dead lock.
1928          */
1929         switch (msg.request.master) {
1930         case VHOST_USER_SET_FEATURES:
1931         case VHOST_USER_SET_PROTOCOL_FEATURES:
1932         case VHOST_USER_SET_OWNER:
1933         case VHOST_USER_SET_MEM_TABLE:
1934         case VHOST_USER_SET_LOG_BASE:
1935         case VHOST_USER_SET_LOG_FD:
1936         case VHOST_USER_SET_VRING_NUM:
1937         case VHOST_USER_SET_VRING_ADDR:
1938         case VHOST_USER_SET_VRING_BASE:
1939         case VHOST_USER_SET_VRING_KICK:
1940         case VHOST_USER_SET_VRING_CALL:
1941         case VHOST_USER_SET_VRING_ERR:
1942         case VHOST_USER_SET_VRING_ENABLE:
1943         case VHOST_USER_SEND_RARP:
1944         case VHOST_USER_NET_SET_MTU:
1945         case VHOST_USER_SET_SLAVE_REQ_FD:
1946                 vhost_user_lock_all_queue_pairs(dev);
1947                 unlock_required = 1;
1948                 break;
1949         default:
1950                 break;
1951
1952         }
1953
1954         if (dev->extern_ops.pre_msg_handle) {
1955                 ret = (*dev->extern_ops.pre_msg_handle)(dev->vid,
1956                                 (void *)&msg, &skip_master);
1957                 if (ret == VH_RESULT_ERR)
1958                         goto skip_to_reply;
1959                 else if (ret == VH_RESULT_REPLY)
1960                         send_vhost_reply(fd, &msg);
1961
1962                 if (skip_master)
1963                         goto skip_to_post_handle;
1964         }
1965
1966         request = msg.request.master;
1967         if (request > VHOST_USER_NONE && request < VHOST_USER_MAX) {
1968                 if (!vhost_message_handlers[request])
1969                         goto skip_to_post_handle;
1970                 ret = vhost_message_handlers[request](&dev, &msg, fd);
1971
1972                 switch (ret) {
1973                 case VH_RESULT_ERR:
1974                         RTE_LOG(ERR, VHOST_CONFIG,
1975                                 "Processing %s failed.\n",
1976                                 vhost_message_str[request]);
1977                         break;
1978                 case VH_RESULT_OK:
1979                         RTE_LOG(DEBUG, VHOST_CONFIG,
1980                                 "Processing %s succeeded.\n",
1981                                 vhost_message_str[request]);
1982                         break;
1983                 case VH_RESULT_REPLY:
1984                         RTE_LOG(DEBUG, VHOST_CONFIG,
1985                                 "Processing %s succeeded and needs reply.\n",
1986                                 vhost_message_str[request]);
1987                         send_vhost_reply(fd, &msg);
1988                         break;
1989                 }
1990         } else {
1991                 RTE_LOG(ERR, VHOST_CONFIG,
1992                         "Requested invalid message type %d.\n", request);
1993                 ret = VH_RESULT_ERR;
1994         }
1995
1996 skip_to_post_handle:
1997         if (ret != VH_RESULT_ERR && dev->extern_ops.post_msg_handle) {
1998                 ret = (*dev->extern_ops.post_msg_handle)(
1999                                 dev->vid, (void *)&msg);
2000                 if (ret == VH_RESULT_ERR)
2001                         goto skip_to_reply;
2002                 else if (ret == VH_RESULT_REPLY)
2003                         send_vhost_reply(fd, &msg);
2004         }
2005
2006 skip_to_reply:
2007         if (unlock_required)
2008                 vhost_user_unlock_all_queue_pairs(dev);
2009
2010         /*
2011          * If the request required a reply that was already sent,
2012          * this optional reply-ack won't be sent as the
2013          * VHOST_USER_NEED_REPLY was cleared in send_vhost_reply().
2014          */
2015         if (msg.flags & VHOST_USER_NEED_REPLY) {
2016                 msg.payload.u64 = ret == VH_RESULT_ERR;
2017                 msg.size = sizeof(msg.payload.u64);
2018                 msg.fd_num = 0;
2019                 send_vhost_reply(fd, &msg);
2020         } else if (ret == VH_RESULT_ERR) {
2021                 RTE_LOG(ERR, VHOST_CONFIG,
2022                         "vhost message handling failed.\n");
2023                 return -1;
2024         }
2025
2026         if (!(dev->flags & VIRTIO_DEV_RUNNING) && virtio_is_ready(dev)) {
2027                 dev->flags |= VIRTIO_DEV_READY;
2028
2029                 if (!(dev->flags & VIRTIO_DEV_RUNNING)) {
2030                         if (dev->dequeue_zero_copy) {
2031                                 RTE_LOG(INFO, VHOST_CONFIG,
2032                                                 "dequeue zero copy is enabled\n");
2033                         }
2034
2035                         if (dev->notify_ops->new_device(dev->vid) == 0)
2036                                 dev->flags |= VIRTIO_DEV_RUNNING;
2037                 }
2038         }
2039
2040         did = dev->vdpa_dev_id;
2041         vdpa_dev = rte_vdpa_get_device(did);
2042         if (vdpa_dev && virtio_is_ready(dev) &&
2043                         !(dev->flags & VIRTIO_DEV_VDPA_CONFIGURED) &&
2044                         msg.request.master == VHOST_USER_SET_VRING_ENABLE) {
2045                 if (vdpa_dev->ops->dev_conf)
2046                         vdpa_dev->ops->dev_conf(dev->vid);
2047                 dev->flags |= VIRTIO_DEV_VDPA_CONFIGURED;
2048                 if (vhost_user_host_notifier_ctrl(dev->vid, true) != 0) {
2049                         RTE_LOG(INFO, VHOST_CONFIG,
2050                                 "(%d) software relay is used for vDPA, performance may be low.\n",
2051                                 dev->vid);
2052                 }
2053         }
2054
2055         return 0;
2056 }
2057
2058 static int process_slave_message_reply(struct virtio_net *dev,
2059                                        const struct VhostUserMsg *msg)
2060 {
2061         struct VhostUserMsg msg_reply;
2062         int ret;
2063
2064         if ((msg->flags & VHOST_USER_NEED_REPLY) == 0)
2065                 return 0;
2066
2067         if (read_vhost_message(dev->slave_req_fd, &msg_reply) < 0) {
2068                 ret = -1;
2069                 goto out;
2070         }
2071
2072         if (msg_reply.request.slave != msg->request.slave) {
2073                 RTE_LOG(ERR, VHOST_CONFIG,
2074                         "Received unexpected msg type (%u), expected %u\n",
2075                         msg_reply.request.slave, msg->request.slave);
2076                 ret = -1;
2077                 goto out;
2078         }
2079
2080         ret = msg_reply.payload.u64 ? -1 : 0;
2081
2082 out:
2083         rte_spinlock_unlock(&dev->slave_req_lock);
2084         return ret;
2085 }
2086
2087 int
2088 vhost_user_iotlb_miss(struct virtio_net *dev, uint64_t iova, uint8_t perm)
2089 {
2090         int ret;
2091         struct VhostUserMsg msg = {
2092                 .request.slave = VHOST_USER_SLAVE_IOTLB_MSG,
2093                 .flags = VHOST_USER_VERSION,
2094                 .size = sizeof(msg.payload.iotlb),
2095                 .payload.iotlb = {
2096                         .iova = iova,
2097                         .perm = perm,
2098                         .type = VHOST_IOTLB_MISS,
2099                 },
2100         };
2101
2102         ret = send_vhost_message(dev->slave_req_fd, &msg);
2103         if (ret < 0) {
2104                 RTE_LOG(ERR, VHOST_CONFIG,
2105                                 "Failed to send IOTLB miss message (%d)\n",
2106                                 ret);
2107                 return ret;
2108         }
2109
2110         return 0;
2111 }
2112
2113 static int vhost_user_slave_set_vring_host_notifier(struct virtio_net *dev,
2114                                                     int index, int fd,
2115                                                     uint64_t offset,
2116                                                     uint64_t size)
2117 {
2118         int ret;
2119         struct VhostUserMsg msg = {
2120                 .request.slave = VHOST_USER_SLAVE_VRING_HOST_NOTIFIER_MSG,
2121                 .flags = VHOST_USER_VERSION | VHOST_USER_NEED_REPLY,
2122                 .size = sizeof(msg.payload.area),
2123                 .payload.area = {
2124                         .u64 = index & VHOST_USER_VRING_IDX_MASK,
2125                         .size = size,
2126                         .offset = offset,
2127                 },
2128         };
2129
2130         if (fd < 0)
2131                 msg.payload.area.u64 |= VHOST_USER_VRING_NOFD_MASK;
2132         else {
2133                 msg.fds[0] = fd;
2134                 msg.fd_num = 1;
2135         }
2136
2137         ret = send_vhost_slave_message(dev, &msg);
2138         if (ret < 0) {
2139                 RTE_LOG(ERR, VHOST_CONFIG,
2140                         "Failed to set host notifier (%d)\n", ret);
2141                 return ret;
2142         }
2143
2144         return process_slave_message_reply(dev, &msg);
2145 }
2146
2147 int vhost_user_host_notifier_ctrl(int vid, bool enable)
2148 {
2149         struct virtio_net *dev;
2150         struct rte_vdpa_device *vdpa_dev;
2151         int vfio_device_fd, did, ret = 0;
2152         uint64_t offset, size;
2153         unsigned int i;
2154
2155         dev = get_device(vid);
2156         if (!dev)
2157                 return -ENODEV;
2158
2159         did = dev->vdpa_dev_id;
2160         if (did < 0)
2161                 return -EINVAL;
2162
2163         if (!(dev->features & (1ULL << VIRTIO_F_VERSION_1)) ||
2164             !(dev->features & (1ULL << VHOST_USER_F_PROTOCOL_FEATURES)) ||
2165             !(dev->protocol_features &
2166                         (1ULL << VHOST_USER_PROTOCOL_F_SLAVE_REQ)) ||
2167             !(dev->protocol_features &
2168                         (1ULL << VHOST_USER_PROTOCOL_F_SLAVE_SEND_FD)) ||
2169             !(dev->protocol_features &
2170                         (1ULL << VHOST_USER_PROTOCOL_F_HOST_NOTIFIER)))
2171                 return -ENOTSUP;
2172
2173         vdpa_dev = rte_vdpa_get_device(did);
2174         if (!vdpa_dev)
2175                 return -ENODEV;
2176
2177         RTE_FUNC_PTR_OR_ERR_RET(vdpa_dev->ops->get_vfio_device_fd, -ENOTSUP);
2178         RTE_FUNC_PTR_OR_ERR_RET(vdpa_dev->ops->get_notify_area, -ENOTSUP);
2179
2180         vfio_device_fd = vdpa_dev->ops->get_vfio_device_fd(vid);
2181         if (vfio_device_fd < 0)
2182                 return -ENOTSUP;
2183
2184         if (enable) {
2185                 for (i = 0; i < dev->nr_vring; i++) {
2186                         if (vdpa_dev->ops->get_notify_area(vid, i, &offset,
2187                                         &size) < 0) {
2188                                 ret = -ENOTSUP;
2189                                 goto disable;
2190                         }
2191
2192                         if (vhost_user_slave_set_vring_host_notifier(dev, i,
2193                                         vfio_device_fd, offset, size) < 0) {
2194                                 ret = -EFAULT;
2195                                 goto disable;
2196                         }
2197                 }
2198         } else {
2199 disable:
2200                 for (i = 0; i < dev->nr_vring; i++) {
2201                         vhost_user_slave_set_vring_host_notifier(dev, i, -1,
2202                                         0, 0);
2203                 }
2204         }
2205
2206         return ret;
2207 }