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 RTE_VHOST_MSG_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 RTE_VHOST_MSG_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 RTE_VHOST_MSG_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 RTE_VHOST_MSG_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 RTE_VHOST_MSG_RESULT_ERR;
 226         }
 227
 228         if (dev->flags & VIRTIO_DEV_RUNNING) {
 229                 if (dev->features == features)
 230                         return RTE_VHOST_MSG_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 RTE_VHOST_MSG_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 RTE_VHOST_MSG_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 RTE_VHOST_MSG_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 RTE_VHOST_MSG_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 RTE_VHOST_MSG_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 RTE_VHOST_MSG_RESULT_ERR;
 357         }
 358
 359         return RTE_VHOST_MSG_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         if (unlikely(!dev || !dev->mem))
 493                 goto out_error;
 494
 495         /* Find the region where the address lives. */
 496         for (i = 0; i < dev->mem->nregions; i++) {
 497                 r = &dev->mem->regions[i];
 498
 499                 if (qva >= r->guest_user_addr &&
 500                     qva <  r->guest_user_addr + r->size) {
 501
 502                         if (unlikely(*len > r->guest_user_addr + r->size - qva))
 503                                 *len = r->guest_user_addr + r->size - qva;
 504
 505                         return qva - r->guest_user_addr +
 506                                r->host_user_addr;
 507                 }
 508         }
 509 out_error:
 510         *len = 0;
 511
 512         return 0;
 513 }
 514
 515
 516 /*
 517  * Converts ring address to Vhost virtual address.
 518  * If IOMMU is enabled, the ring address is a guest IO virtual address,
 519  * else it is a QEMU virtual address.
 520  */
 521 static uint64_t
 522 ring_addr_to_vva(struct virtio_net *dev, struct vhost_virtqueue *vq,
 523                 uint64_t ra, uint64_t *size)
 524 {
 525         if (dev->features & (1ULL << VIRTIO_F_IOMMU_PLATFORM)) {
 526                 uint64_t vva;
 527
 528                 vva = vhost_user_iotlb_cache_find(vq, ra,
 529                                         size, VHOST_ACCESS_RW);
 530                 if (!vva)
 531                         vhost_user_iotlb_miss(dev, ra, VHOST_ACCESS_RW);
 532
 533                 return vva;
 534         }
 535
 536         return qva_to_vva(dev, ra, size);
 537 }
 538
 539 static struct virtio_net *
 540 translate_ring_addresses(struct virtio_net *dev, int vq_index)
 541 {
 542         struct vhost_virtqueue *vq = dev->virtqueue[vq_index];
 543         struct vhost_vring_addr *addr = &vq->ring_addrs;
 544         uint64_t len, expected_len;
 545
 546         if (vq_is_packed(dev)) {
 547                 len = sizeof(struct vring_packed_desc) * vq->size;
 548                 vq->desc_packed = (struct vring_packed_desc *)(uintptr_t)
 549                         ring_addr_to_vva(dev, vq, addr->desc_user_addr, &len);
 550                 vq->log_guest_addr = 0;
 551                 if (vq->desc_packed == NULL ||
 552                                 len != sizeof(struct vring_packed_desc) *
 553                                 vq->size) {
 554                         RTE_LOG(DEBUG, VHOST_CONFIG,
 555                                 "(%d) failed to map desc_packed ring.\n",
 556                                 dev->vid);
 557                         return dev;
 558                 }
 559
 560                 dev = numa_realloc(dev, vq_index);
 561                 vq = dev->virtqueue[vq_index];
 562                 addr = &vq->ring_addrs;
 563
 564                 len = sizeof(struct vring_packed_desc_event);
 565                 vq->driver_event = (struct vring_packed_desc_event *)
 566                                         (uintptr_t)ring_addr_to_vva(dev,
 567                                         vq, addr->avail_user_addr, &len);
 568                 if (vq->driver_event == NULL ||
 569                                 len != sizeof(struct vring_packed_desc_event)) {
 570                         RTE_LOG(DEBUG, VHOST_CONFIG,
 571                                 "(%d) failed to find driver area address.\n",
 572                                 dev->vid);
 573                         return dev;
 574                 }
 575
 576                 len = sizeof(struct vring_packed_desc_event);
 577                 vq->device_event = (struct vring_packed_desc_event *)
 578                                         (uintptr_t)ring_addr_to_vva(dev,
 579                                         vq, addr->used_user_addr, &len);
 580                 if (vq->device_event == NULL ||
 581                                 len != sizeof(struct vring_packed_desc_event)) {
 582                         RTE_LOG(DEBUG, VHOST_CONFIG,
 583                                 "(%d) failed to find device area address.\n",
 584                                 dev->vid);
 585                         return dev;
 586                 }
 587
 588                 return dev;
 589         }
 590
 591         /* The addresses are converted from QEMU virtual to Vhost virtual. */
 592         if (vq->desc && vq->avail && vq->used)
 593                 return dev;
 594
 595         len = sizeof(struct vring_desc) * vq->size;
 596         vq->desc = (struct vring_desc *)(uintptr_t)ring_addr_to_vva(dev,
 597                         vq, addr->desc_user_addr, &len);
 598         if (vq->desc == 0 || len != sizeof(struct vring_desc) * vq->size) {
 599                 RTE_LOG(DEBUG, VHOST_CONFIG,
 600                         "(%d) failed to map desc ring.\n",
 601                         dev->vid);
 602                 return dev;
 603         }
 604
 605         dev = numa_realloc(dev, vq_index);
 606         vq = dev->virtqueue[vq_index];
 607         addr = &vq->ring_addrs;
 608
 609         len = sizeof(struct vring_avail) + sizeof(uint16_t) * vq->size;
 610         if (dev->features & (1ULL << VIRTIO_RING_F_EVENT_IDX))
 611                 len += sizeof(uint16_t);
 612         expected_len = len;
 613         vq->avail = (struct vring_avail *)(uintptr_t)ring_addr_to_vva(dev,
 614                         vq, addr->avail_user_addr, &len);
 615         if (vq->avail == 0 || len != expected_len) {
 616                 RTE_LOG(DEBUG, VHOST_CONFIG,
 617                         "(%d) failed to map avail ring.\n",
 618                         dev->vid);
 619                 return dev;
 620         }
 621
 622         len = sizeof(struct vring_used) +
 623                 sizeof(struct vring_used_elem) * vq->size;
 624         if (dev->features & (1ULL << VIRTIO_RING_F_EVENT_IDX))
 625                 len += sizeof(uint16_t);
 626         expected_len = len;
 627         vq->used = (struct vring_used *)(uintptr_t)ring_addr_to_vva(dev,
 628                         vq, addr->used_user_addr, &len);
 629         if (vq->used == 0 || len != expected_len) {
 630                 RTE_LOG(DEBUG, VHOST_CONFIG,
 631                         "(%d) failed to map used ring.\n",
 632                         dev->vid);
 633                 return dev;
 634         }
 635
 636         if (vq->last_used_idx != vq->used->idx) {
 637                 RTE_LOG(WARNING, VHOST_CONFIG,
 638                         "last_used_idx (%u) and vq->used->idx (%u) mismatches; "
 639                         "some packets maybe resent for Tx and dropped for Rx\n",
 640                         vq->last_used_idx, vq->used->idx);
 641                 vq->last_used_idx  = vq->used->idx;
 642                 vq->last_avail_idx = vq->used->idx;
 643         }
 644
 645         vq->log_guest_addr = addr->log_guest_addr;
 646
 647         VHOST_LOG_DEBUG(VHOST_CONFIG, "(%d) mapped address desc: %p\n",
 648                         dev->vid, vq->desc);
 649         VHOST_LOG_DEBUG(VHOST_CONFIG, "(%d) mapped address avail: %p\n",
 650                         dev->vid, vq->avail);
 651         VHOST_LOG_DEBUG(VHOST_CONFIG, "(%d) mapped address used: %p\n",
 652                         dev->vid, vq->used);
 653         VHOST_LOG_DEBUG(VHOST_CONFIG, "(%d) log_guest_addr: %" PRIx64 "\n",
 654                         dev->vid, vq->log_guest_addr);
 655
 656         return dev;
 657 }
 658
 659 /*
 660  * The virtio device sends us the desc, used and avail ring addresses.
 661  * This function then converts these to our address space.
 662  */
 663 static int
 664 vhost_user_set_vring_addr(struct virtio_net **pdev, struct VhostUserMsg *msg,
 665                         int main_fd __rte_unused)
 666 {
 667         struct virtio_net *dev = *pdev;
 668         struct vhost_virtqueue *vq;
 669         struct vhost_vring_addr *addr = &msg->payload.addr;
 670
 671         if (dev->mem == NULL)
 672                 return RTE_VHOST_MSG_RESULT_ERR;
 673
 674         /* addr->index refers to the queue index. The txq 1, rxq is 0. */
 675         vq = dev->virtqueue[msg->payload.addr.index];
 676
 677         /*
 678          * Rings addresses should not be interpreted as long as the ring is not
 679          * started and enabled
 680          */
 681         memcpy(&vq->ring_addrs, addr, sizeof(*addr));
 682
 683         vring_invalidate(dev, vq);
 684
 685         if (vq->enabled && (dev->features &
 686                                 (1ULL << VHOST_USER_F_PROTOCOL_FEATURES))) {
 687                 dev = translate_ring_addresses(dev, msg->payload.addr.index);
 688                 if (!dev)
 689                         return RTE_VHOST_MSG_RESULT_ERR;
 690
 691                 *pdev = dev;
 692         }
 693
 694         return RTE_VHOST_MSG_RESULT_OK;
 695 }
 696
 697 /*
 698  * The virtio device sends us the available ring last used index.
 699  */
 700 static int
 701 vhost_user_set_vring_base(struct virtio_net **pdev,
 702                         struct VhostUserMsg *msg,
 703                         int main_fd __rte_unused)
 704 {
 705         struct virtio_net *dev = *pdev;
 706         struct vhost_virtqueue *vq = dev->virtqueue[msg->payload.state.index];
 707         uint64_t val = msg->payload.state.num;
 708
 709         if (vq_is_packed(dev)) {
 710                 /*
 711                  * Bit[0:14]: avail index
 712                  * Bit[15]: avail wrap counter
 713                  */
 714                 vq->last_avail_idx = val & 0x7fff;
 715                 vq->avail_wrap_counter = !!(val & (0x1 << 15));
 716                 /*
 717                  * Set used index to same value as available one, as
 718                  * their values should be the same since ring processing
 719                  * was stopped at get time.
 720                  */
 721                 vq->last_used_idx = vq->last_avail_idx;
 722                 vq->used_wrap_counter = vq->avail_wrap_counter;
 723         } else {
 724                 vq->last_used_idx = msg->payload.state.num;
 725                 vq->last_avail_idx = msg->payload.state.num;
 726         }
 727
 728         return RTE_VHOST_MSG_RESULT_OK;
 729 }
 730
 731 static int
 732 add_one_guest_page(struct virtio_net *dev, uint64_t guest_phys_addr,
 733                    uint64_t host_phys_addr, uint64_t size)
 734 {
 735         struct guest_page *page, *last_page;
 736         struct guest_page *old_pages;
 737
 738         if (dev->nr_guest_pages == dev->max_guest_pages) {
 739                 dev->max_guest_pages *= 2;
 740                 old_pages = dev->guest_pages;
 741                 dev->guest_pages = realloc(dev->guest_pages,
 742                                         dev->max_guest_pages * sizeof(*page));
 743                 if (!dev->guest_pages) {
 744                         RTE_LOG(ERR, VHOST_CONFIG, "cannot realloc guest_pages\n");
 745                         free(old_pages);
 746                         return -1;
 747                 }
 748         }
 749
 750         if (dev->nr_guest_pages > 0) {
 751                 last_page = &dev->guest_pages[dev->nr_guest_pages - 1];
 752                 /* merge if the two pages are continuous */
 753                 if (host_phys_addr == last_page->host_phys_addr +
 754                                       last_page->size) {
 755                         last_page->size += size;
 756                         return 0;
 757                 }
 758         }
 759
 760         page = &dev->guest_pages[dev->nr_guest_pages++];
 761         page->guest_phys_addr = guest_phys_addr;
 762         page->host_phys_addr  = host_phys_addr;
 763         page->size = size;
 764
 765         return 0;
 766 }
 767
 768 static int
 769 add_guest_pages(struct virtio_net *dev, struct rte_vhost_mem_region *reg,
 770                 uint64_t page_size)
 771 {
 772         uint64_t reg_size = reg->size;
 773         uint64_t host_user_addr  = reg->host_user_addr;
 774         uint64_t guest_phys_addr = reg->guest_phys_addr;
 775         uint64_t host_phys_addr;
 776         uint64_t size;
 777
 778         host_phys_addr = rte_mem_virt2iova((void *)(uintptr_t)host_user_addr);
 779         size = page_size - (guest_phys_addr & (page_size - 1));
 780         size = RTE_MIN(size, reg_size);
 781
 782         if (add_one_guest_page(dev, guest_phys_addr, host_phys_addr, size) < 0)
 783                 return -1;
 784
 785         host_user_addr  += size;
 786         guest_phys_addr += size;
 787         reg_size -= size;
 788
 789         while (reg_size > 0) {
 790                 size = RTE_MIN(reg_size, page_size);
 791                 host_phys_addr = rte_mem_virt2iova((void *)(uintptr_t)
 792                                                   host_user_addr);
 793                 if (add_one_guest_page(dev, guest_phys_addr, host_phys_addr,
 794                                 size) < 0)
 795                         return -1;
 796
 797                 host_user_addr  += size;
 798                 guest_phys_addr += size;
 799                 reg_size -= size;
 800         }
 801
 802         return 0;
 803 }
 804
 805 #ifdef RTE_LIBRTE_VHOST_DEBUG
 806 /* TODO: enable it only in debug mode? */
 807 static void
 808 dump_guest_pages(struct virtio_net *dev)
 809 {
 810         uint32_t i;
 811         struct guest_page *page;
 812
 813         for (i = 0; i < dev->nr_guest_pages; i++) {
 814                 page = &dev->guest_pages[i];
 815
 816                 RTE_LOG(INFO, VHOST_CONFIG,
 817                         "guest physical page region %u\n"
 818                         "\t guest_phys_addr: %" PRIx64 "\n"
 819                         "\t host_phys_addr : %" PRIx64 "\n"
 820                         "\t size           : %" PRIx64 "\n",
 821                         i,
 822                         page->guest_phys_addr,
 823                         page->host_phys_addr,
 824                         page->size);
 825         }
 826 }
 827 #else
 828 #define dump_guest_pages(dev)
 829 #endif
 830
 831 static bool
 832 vhost_memory_changed(struct VhostUserMemory *new,
 833                      struct rte_vhost_memory *old)
 834 {
 835         uint32_t i;
 836
 837         if (new->nregions != old->nregions)
 838                 return true;
 839
 840         for (i = 0; i < new->nregions; ++i) {
 841                 VhostUserMemoryRegion *new_r = &new->regions[i];
 842                 struct rte_vhost_mem_region *old_r = &old->regions[i];
 843
 844                 if (new_r->guest_phys_addr != old_r->guest_phys_addr)
 845                         return true;
 846                 if (new_r->memory_size != old_r->size)
 847                         return true;
 848                 if (new_r->userspace_addr != old_r->guest_user_addr)
 849                         return true;
 850         }
 851
 852         return false;
 853 }
 854
 855 static int
 856 vhost_user_set_mem_table(struct virtio_net **pdev, struct VhostUserMsg *msg,
 857                         int main_fd)
 858 {
 859         struct virtio_net *dev = *pdev;
 860         struct VhostUserMemory *memory = &msg->payload.memory;
 861         struct rte_vhost_mem_region *reg;
 862         void *mmap_addr;
 863         uint64_t mmap_size;
 864         uint64_t mmap_offset;
 865         uint64_t alignment;
 866         uint32_t i;
 867         int populate;
 868         int fd;
 869
 870         if (memory->nregions > VHOST_MEMORY_MAX_NREGIONS) {
 871                 RTE_LOG(ERR, VHOST_CONFIG,
 872                         "too many memory regions (%u)\n", memory->nregions);
 873                 return RTE_VHOST_MSG_RESULT_ERR;
 874         }
 875
 876         if (dev->mem && !vhost_memory_changed(memory, dev->mem)) {
 877                 RTE_LOG(INFO, VHOST_CONFIG,
 878                         "(%d) memory regions not changed\n", dev->vid);
 879
 880                 for (i = 0; i < memory->nregions; i++)
 881                         close(msg->fds[i]);
 882
 883                 return RTE_VHOST_MSG_RESULT_OK;
 884         }
 885
 886         if (dev->mem) {
 887                 free_mem_region(dev);
 888                 rte_free(dev->mem);
 889                 dev->mem = NULL;
 890         }
 891
 892         /* Flush IOTLB cache as previous HVAs are now invalid */
 893         if (dev->features & (1ULL << VIRTIO_F_IOMMU_PLATFORM))
 894                 for (i = 0; i < dev->nr_vring; i++)
 895                         vhost_user_iotlb_flush_all(dev->virtqueue[i]);
 896
 897         dev->nr_guest_pages = 0;
 898         if (!dev->guest_pages) {
 899                 dev->max_guest_pages = 8;
 900                 dev->guest_pages = malloc(dev->max_guest_pages *
 901                                                 sizeof(struct guest_page));
 902                 if (dev->guest_pages == NULL) {
 903                         RTE_LOG(ERR, VHOST_CONFIG,
 904                                 "(%d) failed to allocate memory "
 905                                 "for dev->guest_pages\n",
 906                                 dev->vid);
 907                         return RTE_VHOST_MSG_RESULT_ERR;
 908                 }
 909         }
 910
 911         dev->mem = rte_zmalloc("vhost-mem-table", sizeof(struct rte_vhost_memory) +
 912                 sizeof(struct rte_vhost_mem_region) * memory->nregions, 0);
 913         if (dev->mem == NULL) {
 914                 RTE_LOG(ERR, VHOST_CONFIG,
 915                         "(%d) failed to allocate memory for dev->mem\n",
 916                         dev->vid);
 917                 return RTE_VHOST_MSG_RESULT_ERR;
 918         }
 919         dev->mem->nregions = memory->nregions;
 920
 921         for (i = 0; i < memory->nregions; i++) {
 922                 fd  = msg->fds[i];
 923                 reg = &dev->mem->regions[i];
 924
 925                 reg->guest_phys_addr = memory->regions[i].guest_phys_addr;
 926                 reg->guest_user_addr = memory->regions[i].userspace_addr;
 927                 reg->size            = memory->regions[i].memory_size;
 928                 reg->fd              = fd;
 929
 930                 mmap_offset = memory->regions[i].mmap_offset;
 931
 932                 /* Check for memory_size + mmap_offset overflow */
 933                 if (mmap_offset >= -reg->size) {
 934                         RTE_LOG(ERR, VHOST_CONFIG,
 935                                 "mmap_offset (%#"PRIx64") and memory_size "
 936                                 "(%#"PRIx64") overflow\n",
 937                                 mmap_offset, reg->size);
 938                         goto err_mmap;
 939                 }
 940
 941                 mmap_size = reg->size + mmap_offset;
 942
 943                 /* mmap() without flag of MAP_ANONYMOUS, should be called
 944                  * with length argument aligned with hugepagesz at older
 945                  * longterm version Linux, like 2.6.32 and 3.2.72, or
 946                  * mmap() will fail with EINVAL.
 947                  *
 948                  * to avoid failure, make sure in caller to keep length
 949                  * aligned.
 950                  */
 951                 alignment = get_blk_size(fd);
 952                 if (alignment == (uint64_t)-1) {
 953                         RTE_LOG(ERR, VHOST_CONFIG,
 954                                 "couldn't get hugepage size through fstat\n");
 955                         goto err_mmap;
 956                 }
 957                 mmap_size = RTE_ALIGN_CEIL(mmap_size, alignment);
 958
 959                 populate = (dev->dequeue_zero_copy) ? MAP_POPULATE : 0;
 960                 mmap_addr = mmap(NULL, mmap_size, PROT_READ | PROT_WRITE,
 961                                  MAP_SHARED | populate, fd, 0);
 962
 963                 if (mmap_addr == MAP_FAILED) {
 964                         RTE_LOG(ERR, VHOST_CONFIG,
 965                                 "mmap region %u failed.\n", i);
 966                         goto err_mmap;
 967                 }
 968
 969                 reg->mmap_addr = mmap_addr;
 970                 reg->mmap_size = mmap_size;
 971                 reg->host_user_addr = (uint64_t)(uintptr_t)mmap_addr +
 972                                       mmap_offset;
 973
 974                 if (dev->dequeue_zero_copy)
 975                         if (add_guest_pages(dev, reg, alignment) < 0) {
 976                                 RTE_LOG(ERR, VHOST_CONFIG,
 977                                         "adding guest pages to region %u failed.\n",
 978                                         i);
 979                                 goto err_mmap;
 980                         }
 981
 982                 RTE_LOG(INFO, VHOST_CONFIG,
 983                         "guest memory region %u, size: 0x%" PRIx64 "\n"
 984                         "\t guest physical addr: 0x%" PRIx64 "\n"
 985                         "\t guest virtual  addr: 0x%" PRIx64 "\n"
 986                         "\t host  virtual  addr: 0x%" PRIx64 "\n"
 987                         "\t mmap addr : 0x%" PRIx64 "\n"
 988                         "\t mmap size : 0x%" PRIx64 "\n"
 989                         "\t mmap align: 0x%" PRIx64 "\n"
 990                         "\t mmap off  : 0x%" PRIx64 "\n",
 991                         i, reg->size,
 992                         reg->guest_phys_addr,
 993                         reg->guest_user_addr,
 994                         reg->host_user_addr,
 995                         (uint64_t)(uintptr_t)mmap_addr,
 996                         mmap_size,
 997                         alignment,
 998                         mmap_offset);
 999
1000                 if (dev->postcopy_listening) {
1001                         /*
1002                          * We haven't a better way right now than sharing
1003                          * DPDK's virtual address with Qemu, so that Qemu can
1004                          * retrieve the region offset when handling userfaults.
1005                          */
1006                         memory->regions[i].userspace_addr =
1007                                 reg->host_user_addr;
1008                 }
1009         }
1010         if (dev->postcopy_listening) {
1011                 /* Send the addresses back to qemu */
1012                 msg->fd_num = 0;
1013                 send_vhost_reply(main_fd, msg);
1014
1015                 /* Wait for qemu to acknolwedge it's got the addresses
1016                  * we've got to wait before we're allowed to generate faults.
1017                  */
1018                 VhostUserMsg ack_msg;
1019                 if (read_vhost_message(main_fd, &ack_msg) <= 0) {
1020                         RTE_LOG(ERR, VHOST_CONFIG,
1021                                 "Failed to read qemu ack on postcopy set-mem-table\n");
1022                         goto err_mmap;
1023                 }
1024                 if (ack_msg.request.master != VHOST_USER_SET_MEM_TABLE) {
1025                         RTE_LOG(ERR, VHOST_CONFIG,
1026                                 "Bad qemu ack on postcopy set-mem-table (%d)\n",
1027                                 ack_msg.request.master);
1028                         goto err_mmap;
1029                 }
1030
1031                 /* Now userfault register and we can use the memory */
1032                 for (i = 0; i < memory->nregions; i++) {
1033 #ifdef RTE_LIBRTE_VHOST_POSTCOPY
1034                         reg = &dev->mem->regions[i];
1035                         struct uffdio_register reg_struct;
1036
1037                         /*
1038                          * Let's register all the mmap'ed area to ensure
1039                          * alignment on page boundary.
1040                          */
1041                         reg_struct.range.start =
1042                                 (uint64_t)(uintptr_t)reg->mmap_addr;
1043                         reg_struct.range.len = reg->mmap_size;
1044                         reg_struct.mode = UFFDIO_REGISTER_MODE_MISSING;
1045
1046                         if (ioctl(dev->postcopy_ufd, UFFDIO_REGISTER,
1047                                                 &reg_struct)) {
1048                                 RTE_LOG(ERR, VHOST_CONFIG,
1049                                         "Failed to register ufd for region %d: (ufd = %d) %s\n",
1050                                         i, dev->postcopy_ufd,
1051                                         strerror(errno));
1052                                 goto err_mmap;
1053                         }
1054                         RTE_LOG(INFO, VHOST_CONFIG,
1055                                 "\t userfaultfd registered for range : %llx - %llx\n",
1056                                 reg_struct.range.start,
1057                                 reg_struct.range.start +
1058                                 reg_struct.range.len - 1);
1059 #else
1060                         goto err_mmap;
1061 #endif
1062                 }
1063         }
1064
1065         for (i = 0; i < dev->nr_vring; i++) {
1066                 struct vhost_virtqueue *vq = dev->virtqueue[i];
1067
1068                 if (vq->desc || vq->avail || vq->used) {
1069                         /*
1070                          * If the memory table got updated, the ring addresses
1071                          * need to be translated again as virtual addresses have
1072                          * changed.
1073                          */
1074                         vring_invalidate(dev, vq);
1075
1076                         dev = translate_ring_addresses(dev, i);
1077                         if (!dev) {
1078                                 dev = *pdev;
1079                                 goto err_mmap;
1080                         }
1081
1082                         *pdev = dev;
1083                 }
1084         }
1085
1086         dump_guest_pages(dev);
1087
1088         return RTE_VHOST_MSG_RESULT_OK;
1089
1090 err_mmap:
1091         free_mem_region(dev);
1092         rte_free(dev->mem);
1093         dev->mem = NULL;
1094         return RTE_VHOST_MSG_RESULT_ERR;
1095 }
1096
1097 static bool
1098 vq_is_ready(struct virtio_net *dev, struct vhost_virtqueue *vq)
1099 {
1100         bool rings_ok;
1101
1102         if (!vq)
1103                 return false;
1104
1105         if (vq_is_packed(dev))
1106                 rings_ok = !!vq->desc_packed;
1107         else
1108                 rings_ok = vq->desc && vq->avail && vq->used;
1109
1110         return rings_ok &&
1111                vq->kickfd != VIRTIO_UNINITIALIZED_EVENTFD &&
1112                vq->callfd != VIRTIO_UNINITIALIZED_EVENTFD;
1113 }
1114
1115 static int
1116 virtio_is_ready(struct virtio_net *dev)
1117 {
1118         struct vhost_virtqueue *vq;
1119         uint32_t i;
1120
1121         if (dev->nr_vring == 0)
1122                 return 0;
1123
1124         for (i = 0; i < dev->nr_vring; i++) {
1125                 vq = dev->virtqueue[i];
1126
1127                 if (!vq_is_ready(dev, vq))
1128                         return 0;
1129         }
1130
1131         RTE_LOG(INFO, VHOST_CONFIG,
1132                 "virtio is now ready for processing.\n");
1133         return 1;
1134 }
1135
1136 static int
1137 vhost_user_set_vring_call(struct virtio_net **pdev, struct VhostUserMsg *msg,
1138                         int main_fd __rte_unused)
1139 {
1140         struct virtio_net *dev = *pdev;
1141         struct vhost_vring_file file;
1142         struct vhost_virtqueue *vq;
1143
1144         file.index = msg->payload.u64 & VHOST_USER_VRING_IDX_MASK;
1145         if (msg->payload.u64 & VHOST_USER_VRING_NOFD_MASK)
1146                 file.fd = VIRTIO_INVALID_EVENTFD;
1147         else
1148                 file.fd = msg->fds[0];
1149         RTE_LOG(INFO, VHOST_CONFIG,
1150                 "vring call idx:%d file:%d\n", file.index, file.fd);
1151
1152         vq = dev->virtqueue[file.index];
1153         if (vq->callfd >= 0)
1154                 close(vq->callfd);
1155
1156         vq->callfd = file.fd;
1157
1158         return RTE_VHOST_MSG_RESULT_OK;
1159 }
1160
1161 static int vhost_user_set_vring_err(struct virtio_net **pdev __rte_unused,
1162                         struct VhostUserMsg *msg,
1163                         int main_fd __rte_unused)
1164 {
1165         if (!(msg->payload.u64 & VHOST_USER_VRING_NOFD_MASK))
1166                 close(msg->fds[0]);
1167         RTE_LOG(INFO, VHOST_CONFIG, "not implemented\n");
1168
1169         return RTE_VHOST_MSG_RESULT_OK;
1170 }
1171
1172 static int
1173 vhost_user_set_vring_kick(struct virtio_net **pdev, struct VhostUserMsg *msg,
1174                         int main_fd __rte_unused)
1175 {
1176         struct virtio_net *dev = *pdev;
1177         struct vhost_vring_file file;
1178         struct vhost_virtqueue *vq;
1179
1180         file.index = msg->payload.u64 & VHOST_USER_VRING_IDX_MASK;
1181         if (msg->payload.u64 & VHOST_USER_VRING_NOFD_MASK)
1182                 file.fd = VIRTIO_INVALID_EVENTFD;
1183         else
1184                 file.fd = msg->fds[0];
1185         RTE_LOG(INFO, VHOST_CONFIG,
1186                 "vring kick idx:%d file:%d\n", file.index, file.fd);
1187
1188         /* Interpret ring addresses only when ring is started. */
1189         dev = translate_ring_addresses(dev, file.index);
1190         if (!dev)
1191                 return RTE_VHOST_MSG_RESULT_ERR;
1192
1193         *pdev = dev;
1194
1195         vq = dev->virtqueue[file.index];
1196
1197         /*
1198          * When VHOST_USER_F_PROTOCOL_FEATURES is not negotiated,
1199          * the ring starts already enabled. Otherwise, it is enabled via
1200          * the SET_VRING_ENABLE message.
1201          */
1202         if (!(dev->features & (1ULL << VHOST_USER_F_PROTOCOL_FEATURES)))
1203                 vq->enabled = 1;
1204
1205         if (vq->kickfd >= 0)
1206                 close(vq->kickfd);
1207         vq->kickfd = file.fd;
1208
1209         return RTE_VHOST_MSG_RESULT_OK;
1210 }
1211
1212 static void
1213 free_zmbufs(struct vhost_virtqueue *vq)
1214 {
1215         struct zcopy_mbuf *zmbuf, *next;
1216
1217         for (zmbuf = TAILQ_FIRST(&vq->zmbuf_list);
1218              zmbuf != NULL; zmbuf = next) {
1219                 next = TAILQ_NEXT(zmbuf, next);
1220
1221                 restore_mbuf(zmbuf->mbuf);
1222                 rte_pktmbuf_free(zmbuf->mbuf);
1223                 TAILQ_REMOVE(&vq->zmbuf_list, zmbuf, next);
1224         }
1225
1226         rte_free(vq->zmbufs);
1227 }
1228
1229 /*
1230  * when virtio is stopped, qemu will send us the GET_VRING_BASE message.
1231  */
1232 static int
1233 vhost_user_get_vring_base(struct virtio_net **pdev,
1234                         struct VhostUserMsg *msg,
1235                         int main_fd __rte_unused)
1236 {
1237         struct virtio_net *dev = *pdev;
1238         struct vhost_virtqueue *vq = dev->virtqueue[msg->payload.state.index];
1239         uint64_t val;
1240
1241         /* We have to stop the queue (virtio) if it is running. */
1242         vhost_destroy_device_notify(dev);
1243
1244         dev->flags &= ~VIRTIO_DEV_READY;
1245         dev->flags &= ~VIRTIO_DEV_VDPA_CONFIGURED;
1246
1247         /* Here we are safe to get the indexes */
1248         if (vq_is_packed(dev)) {
1249                 /*
1250                  * Bit[0:14]: avail index
1251                  * Bit[15]: avail wrap counter
1252                  */
1253                 val = vq->last_avail_idx & 0x7fff;
1254                 val |= vq->avail_wrap_counter << 15;
1255                 msg->payload.state.num = val;
1256         } else {
1257                 msg->payload.state.num = vq->last_avail_idx;
1258         }
1259
1260         RTE_LOG(INFO, VHOST_CONFIG,
1261                 "vring base idx:%d file:%d\n", msg->payload.state.index,
1262                 msg->payload.state.num);
1263         /*
1264          * Based on current qemu vhost-user implementation, this message is
1265          * sent and only sent in vhost_vring_stop.
1266          * TODO: cleanup the vring, it isn't usable since here.
1267          */
1268         if (vq->kickfd >= 0)
1269                 close(vq->kickfd);
1270
1271         vq->kickfd = VIRTIO_UNINITIALIZED_EVENTFD;
1272
1273         if (vq->callfd >= 0)
1274                 close(vq->callfd);
1275
1276         vq->callfd = VIRTIO_UNINITIALIZED_EVENTFD;
1277
1278         if (dev->dequeue_zero_copy)
1279                 free_zmbufs(vq);
1280         if (vq_is_packed(dev)) {
1281                 rte_free(vq->shadow_used_packed);
1282                 vq->shadow_used_packed = NULL;
1283         } else {
1284                 rte_free(vq->shadow_used_split);
1285                 vq->shadow_used_split = NULL;
1286         }
1287
1288         rte_free(vq->batch_copy_elems);
1289         vq->batch_copy_elems = NULL;
1290
1291         msg->size = sizeof(msg->payload.state);
1292         msg->fd_num = 0;
1293
1294         return RTE_VHOST_MSG_RESULT_REPLY;
1295 }
1296
1297 /*
1298  * when virtio queues are ready to work, qemu will send us to
1299  * enable the virtio queue pair.
1300  */
1301 static int
1302 vhost_user_set_vring_enable(struct virtio_net **pdev,
1303                         struct VhostUserMsg *msg,
1304                         int main_fd __rte_unused)
1305 {
1306         struct virtio_net *dev = *pdev;
1307         int enable = (int)msg->payload.state.num;
1308         int index = (int)msg->payload.state.index;
1309         struct rte_vdpa_device *vdpa_dev;
1310         int did = -1;
1311
1312         RTE_LOG(INFO, VHOST_CONFIG,
1313                 "set queue enable: %d to qp idx: %d\n",
1314                 enable, index);
1315
1316         did = dev->vdpa_dev_id;
1317         vdpa_dev = rte_vdpa_get_device(did);
1318         if (vdpa_dev && vdpa_dev->ops->set_vring_state)
1319                 vdpa_dev->ops->set_vring_state(dev->vid, index, enable);
1320
1321         if (dev->notify_ops->vring_state_changed)
1322                 dev->notify_ops->vring_state_changed(dev->vid,
1323                                 index, enable);
1324
1325         dev->virtqueue[index]->enabled = enable;
1326
1327         return RTE_VHOST_MSG_RESULT_OK;
1328 }
1329
1330 static int
1331 vhost_user_get_protocol_features(struct virtio_net **pdev,
1332                         struct VhostUserMsg *msg,
1333                         int main_fd __rte_unused)
1334 {
1335         struct virtio_net *dev = *pdev;
1336         uint64_t features, protocol_features;
1337
1338         rte_vhost_driver_get_features(dev->ifname, &features);
1339         rte_vhost_driver_get_protocol_features(dev->ifname, &protocol_features);
1340
1341         /*
1342          * REPLY_ACK protocol feature is only mandatory for now
1343          * for IOMMU feature. If IOMMU is explicitly disabled by the
1344          * application, disable also REPLY_ACK feature for older buggy
1345          * Qemu versions (from v2.7.0 to v2.9.0).
1346          */
1347         if (!(features & (1ULL << VIRTIO_F_IOMMU_PLATFORM)))
1348                 protocol_features &= ~(1ULL << VHOST_USER_PROTOCOL_F_REPLY_ACK);
1349
1350         msg->payload.u64 = protocol_features;
1351         msg->size = sizeof(msg->payload.u64);
1352         msg->fd_num = 0;
1353
1354         return RTE_VHOST_MSG_RESULT_REPLY;
1355 }
1356
1357 static int
1358 vhost_user_set_protocol_features(struct virtio_net **pdev,
1359                         struct VhostUserMsg *msg,
1360                         int main_fd __rte_unused)
1361 {
1362         struct virtio_net *dev = *pdev;
1363         uint64_t protocol_features = msg->payload.u64;
1364         uint64_t slave_protocol_features = 0;
1365
1366         rte_vhost_driver_get_protocol_features(dev->ifname,
1367                         &slave_protocol_features);
1368         if (protocol_features & ~slave_protocol_features) {
1369                 RTE_LOG(ERR, VHOST_CONFIG,
1370                         "(%d) received invalid protocol features.\n",
1371                         dev->vid);
1372                 return RTE_VHOST_MSG_RESULT_ERR;
1373         }
1374
1375         dev->protocol_features = protocol_features;
1376
1377         return RTE_VHOST_MSG_RESULT_OK;
1378 }
1379
1380 static int
1381 vhost_user_set_log_base(struct virtio_net **pdev, struct VhostUserMsg *msg,
1382                         int main_fd __rte_unused)
1383 {
1384         struct virtio_net *dev = *pdev;
1385         int fd = msg->fds[0];
1386         uint64_t size, off;
1387         void *addr;
1388
1389         if (fd < 0) {
1390                 RTE_LOG(ERR, VHOST_CONFIG, "invalid log fd: %d\n", fd);
1391                 return RTE_VHOST_MSG_RESULT_ERR;
1392         }
1393
1394         if (msg->size != sizeof(VhostUserLog)) {
1395                 RTE_LOG(ERR, VHOST_CONFIG,
1396                         "invalid log base msg size: %"PRId32" != %d\n",
1397                         msg->size, (int)sizeof(VhostUserLog));
1398                 return RTE_VHOST_MSG_RESULT_ERR;
1399         }
1400
1401         size = msg->payload.log.mmap_size;
1402         off  = msg->payload.log.mmap_offset;
1403
1404         /* Don't allow mmap_offset to point outside the mmap region */
1405         if (off > size) {
1406                 RTE_LOG(ERR, VHOST_CONFIG,
1407                         "log offset %#"PRIx64" exceeds log size %#"PRIx64"\n",
1408                         off, size);
1409                 return RTE_VHOST_MSG_RESULT_ERR;
1410         }
1411
1412         RTE_LOG(INFO, VHOST_CONFIG,
1413                 "log mmap size: %"PRId64", offset: %"PRId64"\n",
1414                 size, off);
1415
1416         /*
1417          * mmap from 0 to workaround a hugepage mmap bug: mmap will
1418          * fail when offset is not page size aligned.
1419          */
1420         addr = mmap(0, size + off, PROT_READ | PROT_WRITE, MAP_SHARED, fd, 0);
1421         close(fd);
1422         if (addr == MAP_FAILED) {
1423                 RTE_LOG(ERR, VHOST_CONFIG, "mmap log base failed!\n");
1424                 return RTE_VHOST_MSG_RESULT_ERR;
1425         }
1426
1427         /*
1428          * Free previously mapped log memory on occasionally
1429          * multiple VHOST_USER_SET_LOG_BASE.
1430          */
1431         if (dev->log_addr) {
1432                 munmap((void *)(uintptr_t)dev->log_addr, dev->log_size);
1433         }
1434         dev->log_addr = (uint64_t)(uintptr_t)addr;
1435         dev->log_base = dev->log_addr + off;
1436         dev->log_size = size;
1437
1438         /*
1439          * The spec is not clear about it (yet), but QEMU doesn't expect
1440          * any payload in the reply.
1441          */
1442         msg->size = 0;
1443         msg->fd_num = 0;
1444
1445         return RTE_VHOST_MSG_RESULT_REPLY;
1446 }
1447
1448 static int vhost_user_set_log_fd(struct virtio_net **pdev __rte_unused,
1449                         struct VhostUserMsg *msg,
1450                         int main_fd __rte_unused)
1451 {
1452         close(msg->fds[0]);
1453         RTE_LOG(INFO, VHOST_CONFIG, "not implemented.\n");
1454
1455         return RTE_VHOST_MSG_RESULT_OK;
1456 }
1457
1458 /*
1459  * An rarp packet is constructed and broadcasted to notify switches about
1460  * the new location of the migrated VM, so that packets from outside will
1461  * not be lost after migration.
1462  *
1463  * However, we don't actually "send" a rarp packet here, instead, we set
1464  * a flag 'broadcast_rarp' to let rte_vhost_dequeue_burst() inject it.
1465  */
1466 static int
1467 vhost_user_send_rarp(struct virtio_net **pdev, struct VhostUserMsg *msg,
1468                         int main_fd __rte_unused)
1469 {
1470         struct virtio_net *dev = *pdev;
1471         uint8_t *mac = (uint8_t *)&msg->payload.u64;
1472         struct rte_vdpa_device *vdpa_dev;
1473         int did = -1;
1474
1475         RTE_LOG(DEBUG, VHOST_CONFIG,
1476                 ":: mac: %02x:%02x:%02x:%02x:%02x:%02x\n",
1477                 mac[0], mac[1], mac[2], mac[3], mac[4], mac[5]);
1478         memcpy(dev->mac.addr_bytes, mac, 6);
1479
1480         /*
1481          * Set the flag to inject a RARP broadcast packet at
1482          * rte_vhost_dequeue_burst().
1483          *
1484          * rte_smp_wmb() is for making sure the mac is copied
1485          * before the flag is set.
1486          */
1487         rte_smp_wmb();
1488         rte_atomic16_set(&dev->broadcast_rarp, 1);
1489         did = dev->vdpa_dev_id;
1490         vdpa_dev = rte_vdpa_get_device(did);
1491         if (vdpa_dev && vdpa_dev->ops->migration_done)
1492                 vdpa_dev->ops->migration_done(dev->vid);
1493
1494         return RTE_VHOST_MSG_RESULT_OK;
1495 }
1496
1497 static int
1498 vhost_user_net_set_mtu(struct virtio_net **pdev, struct VhostUserMsg *msg,
1499                         int main_fd __rte_unused)
1500 {
1501         struct virtio_net *dev = *pdev;
1502         if (msg->payload.u64 < VIRTIO_MIN_MTU ||
1503                         msg->payload.u64 > VIRTIO_MAX_MTU) {
1504                 RTE_LOG(ERR, VHOST_CONFIG, "Invalid MTU size (%"PRIu64")\n",
1505                                 msg->payload.u64);
1506
1507                 return RTE_VHOST_MSG_RESULT_ERR;
1508         }
1509
1510         dev->mtu = msg->payload.u64;
1511
1512         return RTE_VHOST_MSG_RESULT_OK;
1513 }
1514
1515 static int
1516 vhost_user_set_req_fd(struct virtio_net **pdev, struct VhostUserMsg *msg,
1517                         int main_fd __rte_unused)
1518 {
1519         struct virtio_net *dev = *pdev;
1520         int fd = msg->fds[0];
1521
1522         if (fd < 0) {
1523                 RTE_LOG(ERR, VHOST_CONFIG,
1524                                 "Invalid file descriptor for slave channel (%d)\n",
1525                                 fd);
1526                 return RTE_VHOST_MSG_RESULT_ERR;
1527         }
1528
1529         dev->slave_req_fd = fd;
1530
1531         return RTE_VHOST_MSG_RESULT_OK;
1532 }
1533
1534 static int
1535 is_vring_iotlb_update(struct vhost_virtqueue *vq, struct vhost_iotlb_msg *imsg)
1536 {
1537         struct vhost_vring_addr *ra;
1538         uint64_t start, end;
1539
1540         start = imsg->iova;
1541         end = start + imsg->size;
1542
1543         ra = &vq->ring_addrs;
1544         if (ra->desc_user_addr >= start && ra->desc_user_addr < end)
1545                 return 1;
1546         if (ra->avail_user_addr >= start && ra->avail_user_addr < end)
1547                 return 1;
1548         if (ra->used_user_addr >= start && ra->used_user_addr < end)
1549                 return 1;
1550
1551         return 0;
1552 }
1553
1554 static int
1555 is_vring_iotlb_invalidate(struct vhost_virtqueue *vq,
1556                                 struct vhost_iotlb_msg *imsg)
1557 {
1558         uint64_t istart, iend, vstart, vend;
1559
1560         istart = imsg->iova;
1561         iend = istart + imsg->size - 1;
1562
1563         vstart = (uintptr_t)vq->desc;
1564         vend = vstart + sizeof(struct vring_desc) * vq->size - 1;
1565         if (vstart <= iend && istart <= vend)
1566                 return 1;
1567
1568         vstart = (uintptr_t)vq->avail;
1569         vend = vstart + sizeof(struct vring_avail);
1570         vend += sizeof(uint16_t) * vq->size - 1;
1571         if (vstart <= iend && istart <= vend)
1572                 return 1;
1573
1574         vstart = (uintptr_t)vq->used;
1575         vend = vstart + sizeof(struct vring_used);
1576         vend += sizeof(struct vring_used_elem) * vq->size - 1;
1577         if (vstart <= iend && istart <= vend)
1578                 return 1;
1579
1580         return 0;
1581 }
1582
1583 static int
1584 vhost_user_iotlb_msg(struct virtio_net **pdev, struct VhostUserMsg *msg,
1585                         int main_fd __rte_unused)
1586 {
1587         struct virtio_net *dev = *pdev;
1588         struct vhost_iotlb_msg *imsg = &msg->payload.iotlb;
1589         uint16_t i;
1590         uint64_t vva, len;
1591
1592         switch (imsg->type) {
1593         case VHOST_IOTLB_UPDATE:
1594                 len = imsg->size;
1595                 vva = qva_to_vva(dev, imsg->uaddr, &len);
1596                 if (!vva)
1597                         return RTE_VHOST_MSG_RESULT_ERR;
1598
1599                 for (i = 0; i < dev->nr_vring; i++) {
1600                         struct vhost_virtqueue *vq = dev->virtqueue[i];
1601
1602                         vhost_user_iotlb_cache_insert(vq, imsg->iova, vva,
1603                                         len, imsg->perm);
1604
1605                         if (is_vring_iotlb_update(vq, imsg))
1606                                 *pdev = dev = translate_ring_addresses(dev, i);
1607                 }
1608                 break;
1609         case VHOST_IOTLB_INVALIDATE:
1610                 for (i = 0; i < dev->nr_vring; i++) {
1611                         struct vhost_virtqueue *vq = dev->virtqueue[i];
1612
1613                         vhost_user_iotlb_cache_remove(vq, imsg->iova,
1614                                         imsg->size);
1615
1616                         if (is_vring_iotlb_invalidate(vq, imsg))
1617                                 vring_invalidate(dev, vq);
1618                 }
1619                 break;
1620         default:
1621                 RTE_LOG(ERR, VHOST_CONFIG, "Invalid IOTLB message type (%d)\n",
1622                                 imsg->type);
1623                 return RTE_VHOST_MSG_RESULT_ERR;
1624         }
1625
1626         return RTE_VHOST_MSG_RESULT_OK;
1627 }
1628
1629 static int
1630 vhost_user_set_postcopy_advise(struct virtio_net **pdev,
1631                         struct VhostUserMsg *msg,
1632                         int main_fd __rte_unused)
1633 {
1634         struct virtio_net *dev = *pdev;
1635 #ifdef RTE_LIBRTE_VHOST_POSTCOPY
1636         struct uffdio_api api_struct;
1637
1638         dev->postcopy_ufd = syscall(__NR_userfaultfd, O_CLOEXEC | O_NONBLOCK);
1639
1640         if (dev->postcopy_ufd == -1) {
1641                 RTE_LOG(ERR, VHOST_CONFIG, "Userfaultfd not available: %s\n",
1642                         strerror(errno));
1643                 return RTE_VHOST_MSG_RESULT_ERR;
1644         }
1645         api_struct.api = UFFD_API;
1646         api_struct.features = 0;
1647         if (ioctl(dev->postcopy_ufd, UFFDIO_API, &api_struct)) {
1648                 RTE_LOG(ERR, VHOST_CONFIG, "UFFDIO_API ioctl failure: %s\n",
1649                         strerror(errno));
1650                 close(dev->postcopy_ufd);
1651                 dev->postcopy_ufd = -1;
1652                 return RTE_VHOST_MSG_RESULT_ERR;
1653         }
1654         msg->fds[0] = dev->postcopy_ufd;
1655         msg->fd_num = 1;
1656
1657         return RTE_VHOST_MSG_RESULT_REPLY;
1658 #else
1659         dev->postcopy_ufd = -1;
1660         msg->fd_num = 0;
1661
1662         return RTE_VHOST_MSG_RESULT_ERR;
1663 #endif
1664 }
1665
1666 static int
1667 vhost_user_set_postcopy_listen(struct virtio_net **pdev,
1668                         struct VhostUserMsg *msg __rte_unused,
1669                         int main_fd __rte_unused)
1670 {
1671         struct virtio_net *dev = *pdev;
1672
1673         if (dev->mem && dev->mem->nregions) {
1674                 RTE_LOG(ERR, VHOST_CONFIG,
1675                         "Regions already registered at postcopy-listen\n");
1676                 return RTE_VHOST_MSG_RESULT_ERR;
1677         }
1678         dev->postcopy_listening = 1;
1679
1680         return RTE_VHOST_MSG_RESULT_OK;
1681 }
1682
1683 static int
1684 vhost_user_postcopy_end(struct virtio_net **pdev, struct VhostUserMsg *msg,
1685                         int main_fd __rte_unused)
1686 {
1687         struct virtio_net *dev = *pdev;
1688
1689         dev->postcopy_listening = 0;
1690         if (dev->postcopy_ufd >= 0) {
1691                 close(dev->postcopy_ufd);
1692                 dev->postcopy_ufd = -1;
1693         }
1694
1695         msg->payload.u64 = 0;
1696         msg->size = sizeof(msg->payload.u64);
1697         msg->fd_num = 0;
1698
1699         return RTE_VHOST_MSG_RESULT_REPLY;
1700 }
1701
1702 typedef int (*vhost_message_handler_t)(struct virtio_net **pdev,
1703                                         struct VhostUserMsg *msg,
1704                                         int main_fd);
1705 static vhost_message_handler_t vhost_message_handlers[VHOST_USER_MAX] = {
1706         [VHOST_USER_NONE] = NULL,
1707         [VHOST_USER_GET_FEATURES] = vhost_user_get_features,
1708         [VHOST_USER_SET_FEATURES] = vhost_user_set_features,
1709         [VHOST_USER_SET_OWNER] = vhost_user_set_owner,
1710         [VHOST_USER_RESET_OWNER] = vhost_user_reset_owner,
1711         [VHOST_USER_SET_MEM_TABLE] = vhost_user_set_mem_table,
1712         [VHOST_USER_SET_LOG_BASE] = vhost_user_set_log_base,
1713         [VHOST_USER_SET_LOG_FD] = vhost_user_set_log_fd,
1714         [VHOST_USER_SET_VRING_NUM] = vhost_user_set_vring_num,
1715         [VHOST_USER_SET_VRING_ADDR] = vhost_user_set_vring_addr,
1716         [VHOST_USER_SET_VRING_BASE] = vhost_user_set_vring_base,
1717         [VHOST_USER_GET_VRING_BASE] = vhost_user_get_vring_base,
1718         [VHOST_USER_SET_VRING_KICK] = vhost_user_set_vring_kick,
1719         [VHOST_USER_SET_VRING_CALL] = vhost_user_set_vring_call,
1720         [VHOST_USER_SET_VRING_ERR] = vhost_user_set_vring_err,
1721         [VHOST_USER_GET_PROTOCOL_FEATURES] = vhost_user_get_protocol_features,
1722         [VHOST_USER_SET_PROTOCOL_FEATURES] = vhost_user_set_protocol_features,
1723         [VHOST_USER_GET_QUEUE_NUM] = vhost_user_get_queue_num,
1724         [VHOST_USER_SET_VRING_ENABLE] = vhost_user_set_vring_enable,
1725         [VHOST_USER_SEND_RARP] = vhost_user_send_rarp,
1726         [VHOST_USER_NET_SET_MTU] = vhost_user_net_set_mtu,
1727         [VHOST_USER_SET_SLAVE_REQ_FD] = vhost_user_set_req_fd,
1728         [VHOST_USER_IOTLB_MSG] = vhost_user_iotlb_msg,
1729         [VHOST_USER_POSTCOPY_ADVISE] = vhost_user_set_postcopy_advise,
1730         [VHOST_USER_POSTCOPY_LISTEN] = vhost_user_set_postcopy_listen,
1731         [VHOST_USER_POSTCOPY_END] = vhost_user_postcopy_end,
1732 };
1733
1734
1735 /* return bytes# of read on success or negative val on failure. */
1736 static int
1737 read_vhost_message(int sockfd, struct VhostUserMsg *msg)
1738 {
1739         int ret;
1740
1741         ret = read_fd_message(sockfd, (char *)msg, VHOST_USER_HDR_SIZE,
1742                 msg->fds, VHOST_MEMORY_MAX_NREGIONS, &msg->fd_num);
1743         if (ret <= 0)
1744                 return ret;
1745
1746         if (msg->size) {
1747                 if (msg->size > sizeof(msg->payload)) {
1748                         RTE_LOG(ERR, VHOST_CONFIG,
1749                                 "invalid msg size: %d\n", msg->size);
1750                         return -1;
1751                 }
1752                 ret = read(sockfd, &msg->payload, msg->size);
1753                 if (ret <= 0)
1754                         return ret;
1755                 if (ret != (int)msg->size) {
1756                         RTE_LOG(ERR, VHOST_CONFIG,
1757                                 "read control message failed\n");
1758                         return -1;
1759                 }
1760         }
1761
1762         return ret;
1763 }
1764
1765 static int
1766 send_vhost_message(int sockfd, struct VhostUserMsg *msg)
1767 {
1768         if (!msg)
1769                 return 0;
1770
1771         return send_fd_message(sockfd, (char *)msg,
1772                 VHOST_USER_HDR_SIZE + msg->size, msg->fds, msg->fd_num);
1773 }
1774
1775 static int
1776 send_vhost_reply(int sockfd, struct VhostUserMsg *msg)
1777 {
1778         if (!msg)
1779                 return 0;
1780
1781         msg->flags &= ~VHOST_USER_VERSION_MASK;
1782         msg->flags &= ~VHOST_USER_NEED_REPLY;
1783         msg->flags |= VHOST_USER_VERSION;
1784         msg->flags |= VHOST_USER_REPLY_MASK;
1785
1786         return send_vhost_message(sockfd, msg);
1787 }
1788
1789 static int
1790 send_vhost_slave_message(struct virtio_net *dev, struct VhostUserMsg *msg)
1791 {
1792         int ret;
1793
1794         if (msg->flags & VHOST_USER_NEED_REPLY)
1795                 rte_spinlock_lock(&dev->slave_req_lock);
1796
1797         ret = send_vhost_message(dev->slave_req_fd, msg);
1798         if (ret < 0 && (msg->flags & VHOST_USER_NEED_REPLY))
1799                 rte_spinlock_unlock(&dev->slave_req_lock);
1800
1801         return ret;
1802 }
1803
1804 /*
1805  * Allocate a queue pair if it hasn't been allocated yet
1806  */
1807 static int
1808 vhost_user_check_and_alloc_queue_pair(struct virtio_net *dev,
1809                         struct VhostUserMsg *msg)
1810 {
1811         uint16_t vring_idx;
1812
1813         switch (msg->request.master) {
1814         case VHOST_USER_SET_VRING_KICK:
1815         case VHOST_USER_SET_VRING_CALL:
1816         case VHOST_USER_SET_VRING_ERR:
1817                 vring_idx = msg->payload.u64 & VHOST_USER_VRING_IDX_MASK;
1818                 break;
1819         case VHOST_USER_SET_VRING_NUM:
1820         case VHOST_USER_SET_VRING_BASE:
1821         case VHOST_USER_SET_VRING_ENABLE:
1822                 vring_idx = msg->payload.state.index;
1823                 break;
1824         case VHOST_USER_SET_VRING_ADDR:
1825                 vring_idx = msg->payload.addr.index;
1826                 break;
1827         default:
1828                 return 0;
1829         }
1830
1831         if (vring_idx >= VHOST_MAX_VRING) {
1832                 RTE_LOG(ERR, VHOST_CONFIG,
1833                         "invalid vring index: %u\n", vring_idx);
1834                 return -1;
1835         }
1836
1837         if (dev->virtqueue[vring_idx])
1838                 return 0;
1839
1840         return alloc_vring_queue(dev, vring_idx);
1841 }
1842
1843 static void
1844 vhost_user_lock_all_queue_pairs(struct virtio_net *dev)
1845 {
1846         unsigned int i = 0;
1847         unsigned int vq_num = 0;
1848
1849         while (vq_num < dev->nr_vring) {
1850                 struct vhost_virtqueue *vq = dev->virtqueue[i];
1851
1852                 if (vq) {
1853                         rte_spinlock_lock(&vq->access_lock);
1854                         vq_num++;
1855                 }
1856                 i++;
1857         }
1858 }
1859
1860 static void
1861 vhost_user_unlock_all_queue_pairs(struct virtio_net *dev)
1862 {
1863         unsigned int i = 0;
1864         unsigned int vq_num = 0;
1865
1866         while (vq_num < dev->nr_vring) {
1867                 struct vhost_virtqueue *vq = dev->virtqueue[i];
1868
1869                 if (vq) {
1870                         rte_spinlock_unlock(&vq->access_lock);
1871                         vq_num++;
1872                 }
1873                 i++;
1874         }
1875 }
1876
1877 int
1878 vhost_user_msg_handler(int vid, int fd)
1879 {
1880         struct virtio_net *dev;
1881         struct VhostUserMsg msg;
1882         struct rte_vdpa_device *vdpa_dev;
1883         int did = -1;
1884         int ret;
1885         int unlock_required = 0;
1886         uint32_t skip_master = 0;
1887         int request;
1888
1889         dev = get_device(vid);
1890         if (dev == NULL)
1891                 return -1;
1892
1893         if (!dev->notify_ops) {
1894                 dev->notify_ops = vhost_driver_callback_get(dev->ifname);
1895                 if (!dev->notify_ops) {
1896                         RTE_LOG(ERR, VHOST_CONFIG,
1897                                 "failed to get callback ops for driver %s\n",
1898                                 dev->ifname);
1899                         return -1;
1900                 }
1901         }
1902
1903         ret = read_vhost_message(fd, &msg);
1904         if (ret <= 0 || msg.request.master >= VHOST_USER_MAX) {
1905                 if (ret < 0)
1906                         RTE_LOG(ERR, VHOST_CONFIG,
1907                                 "vhost read message failed\n");
1908                 else if (ret == 0)
1909                         RTE_LOG(INFO, VHOST_CONFIG,
1910                                 "vhost peer closed\n");
1911                 else
1912                         RTE_LOG(ERR, VHOST_CONFIG,
1913                                 "vhost read incorrect message\n");
1914
1915                 return -1;
1916         }
1917
1918         ret = 0;
1919         if (msg.request.master != VHOST_USER_IOTLB_MSG)
1920                 RTE_LOG(INFO, VHOST_CONFIG, "read message %s\n",
1921                         vhost_message_str[msg.request.master]);
1922         else
1923                 RTE_LOG(DEBUG, VHOST_CONFIG, "read message %s\n",
1924                         vhost_message_str[msg.request.master]);
1925
1926         ret = vhost_user_check_and_alloc_queue_pair(dev, &msg);
1927         if (ret < 0) {
1928                 RTE_LOG(ERR, VHOST_CONFIG,
1929                         "failed to alloc queue\n");
1930                 return -1;
1931         }
1932
1933         /*
1934          * Note: we don't lock all queues on VHOST_USER_GET_VRING_BASE
1935          * and VHOST_USER_RESET_OWNER, since it is sent when virtio stops
1936          * and device is destroyed. destroy_device waits for queues to be
1937          * inactive, so it is safe. Otherwise taking the access_lock
1938          * would cause a dead lock.
1939          */
1940         switch (msg.request.master) {
1941         case VHOST_USER_SET_FEATURES:
1942         case VHOST_USER_SET_PROTOCOL_FEATURES:
1943         case VHOST_USER_SET_OWNER:
1944         case VHOST_USER_SET_MEM_TABLE:
1945         case VHOST_USER_SET_LOG_BASE:
1946         case VHOST_USER_SET_LOG_FD:
1947         case VHOST_USER_SET_VRING_NUM:
1948         case VHOST_USER_SET_VRING_ADDR:
1949         case VHOST_USER_SET_VRING_BASE:
1950         case VHOST_USER_SET_VRING_KICK:
1951         case VHOST_USER_SET_VRING_CALL:
1952         case VHOST_USER_SET_VRING_ERR:
1953         case VHOST_USER_SET_VRING_ENABLE:
1954         case VHOST_USER_SEND_RARP:
1955         case VHOST_USER_NET_SET_MTU:
1956         case VHOST_USER_SET_SLAVE_REQ_FD:
1957                 vhost_user_lock_all_queue_pairs(dev);
1958                 unlock_required = 1;
1959                 break;
1960         default:
1961                 break;
1962
1963         }
1964
1965         if (dev->extern_ops.pre_msg_handle) {
1966                 ret = (*dev->extern_ops.pre_msg_handle)(dev->vid,
1967                                 (void *)&msg, &skip_master);
1968                 if (ret == RTE_VHOST_MSG_RESULT_ERR)
1969                         goto skip_to_reply;
1970                 else if (ret == RTE_VHOST_MSG_RESULT_REPLY)
1971                         send_vhost_reply(fd, &msg);
1972
1973                 if (skip_master)
1974                         goto skip_to_post_handle;
1975         }
1976
1977         request = msg.request.master;
1978         if (request > VHOST_USER_NONE && request < VHOST_USER_MAX) {
1979                 if (!vhost_message_handlers[request])
1980                         goto skip_to_post_handle;
1981                 ret = vhost_message_handlers[request](&dev, &msg, fd);
1982
1983                 switch (ret) {
1984                 case RTE_VHOST_MSG_RESULT_ERR:
1985                         RTE_LOG(ERR, VHOST_CONFIG,
1986                                 "Processing %s failed.\n",
1987                                 vhost_message_str[request]);
1988                         break;
1989                 case RTE_VHOST_MSG_RESULT_OK:
1990                         RTE_LOG(DEBUG, VHOST_CONFIG,
1991                                 "Processing %s succeeded.\n",
1992                                 vhost_message_str[request]);
1993                         break;
1994                 case RTE_VHOST_MSG_RESULT_REPLY:
1995                         RTE_LOG(DEBUG, VHOST_CONFIG,
1996                                 "Processing %s succeeded and needs reply.\n",
1997                                 vhost_message_str[request]);
1998                         send_vhost_reply(fd, &msg);
1999                         break;
2000                 }
2001         } else {
2002                 RTE_LOG(ERR, VHOST_CONFIG,
2003                         "Requested invalid message type %d.\n", request);
2004                 ret = RTE_VHOST_MSG_RESULT_ERR;
2005         }
2006
2007 skip_to_post_handle:
2008         if (ret != RTE_VHOST_MSG_RESULT_ERR &&
2009                         dev->extern_ops.post_msg_handle) {
2010                 ret = (*dev->extern_ops.post_msg_handle)(
2011                                 dev->vid, (void *)&msg);
2012                 if (ret == RTE_VHOST_MSG_RESULT_ERR)
2013                         goto skip_to_reply;
2014                 else if (ret == RTE_VHOST_MSG_RESULT_REPLY)
2015                         send_vhost_reply(fd, &msg);
2016         }
2017
2018 skip_to_reply:
2019         if (unlock_required)
2020                 vhost_user_unlock_all_queue_pairs(dev);
2021
2022         /*
2023          * If the request required a reply that was already sent,
2024          * this optional reply-ack won't be sent as the
2025          * VHOST_USER_NEED_REPLY was cleared in send_vhost_reply().
2026          */
2027         if (msg.flags & VHOST_USER_NEED_REPLY) {
2028                 msg.payload.u64 = ret == RTE_VHOST_MSG_RESULT_ERR;
2029                 msg.size = sizeof(msg.payload.u64);
2030                 msg.fd_num = 0;
2031                 send_vhost_reply(fd, &msg);
2032         } else if (ret == RTE_VHOST_MSG_RESULT_ERR) {
2033                 RTE_LOG(ERR, VHOST_CONFIG,
2034                         "vhost message handling failed.\n");
2035                 return -1;
2036         }
2037
2038         if (!(dev->flags & VIRTIO_DEV_RUNNING) && virtio_is_ready(dev)) {
2039                 dev->flags |= VIRTIO_DEV_READY;
2040
2041                 if (!(dev->flags & VIRTIO_DEV_RUNNING)) {
2042                         if (dev->dequeue_zero_copy) {
2043                                 RTE_LOG(INFO, VHOST_CONFIG,
2044                                                 "dequeue zero copy is enabled\n");
2045                         }
2046
2047                         if (dev->notify_ops->new_device(dev->vid) == 0)
2048                                 dev->flags |= VIRTIO_DEV_RUNNING;
2049                 }
2050         }
2051
2052         did = dev->vdpa_dev_id;
2053         vdpa_dev = rte_vdpa_get_device(did);
2054         if (vdpa_dev && virtio_is_ready(dev) &&
2055                         !(dev->flags & VIRTIO_DEV_VDPA_CONFIGURED) &&
2056                         msg.request.master == VHOST_USER_SET_VRING_CALL) {
2057                 if (vdpa_dev->ops->dev_conf)
2058                         vdpa_dev->ops->dev_conf(dev->vid);
2059                 dev->flags |= VIRTIO_DEV_VDPA_CONFIGURED;
2060         }
2061
2062         return 0;
2063 }
2064
2065 static int process_slave_message_reply(struct virtio_net *dev,
2066                                        const struct VhostUserMsg *msg)
2067 {
2068         struct VhostUserMsg msg_reply;
2069         int ret;
2070
2071         if ((msg->flags & VHOST_USER_NEED_REPLY) == 0)
2072                 return 0;
2073
2074         if (read_vhost_message(dev->slave_req_fd, &msg_reply) < 0) {
2075                 ret = -1;
2076                 goto out;
2077         }
2078
2079         if (msg_reply.request.slave != msg->request.slave) {
2080                 RTE_LOG(ERR, VHOST_CONFIG,
2081                         "Received unexpected msg type (%u), expected %u\n",
2082                         msg_reply.request.slave, msg->request.slave);
2083                 ret = -1;
2084                 goto out;
2085         }
2086
2087         ret = msg_reply.payload.u64 ? -1 : 0;
2088
2089 out:
2090         rte_spinlock_unlock(&dev->slave_req_lock);
2091         return ret;
2092 }
2093
2094 int
2095 vhost_user_iotlb_miss(struct virtio_net *dev, uint64_t iova, uint8_t perm)
2096 {
2097         int ret;
2098         struct VhostUserMsg msg = {
2099                 .request.slave = VHOST_USER_SLAVE_IOTLB_MSG,
2100                 .flags = VHOST_USER_VERSION,
2101                 .size = sizeof(msg.payload.iotlb),
2102                 .payload.iotlb = {
2103                         .iova = iova,
2104                         .perm = perm,
2105                         .type = VHOST_IOTLB_MISS,
2106                 },
2107         };
2108
2109         ret = send_vhost_message(dev->slave_req_fd, &msg);
2110         if (ret < 0) {
2111                 RTE_LOG(ERR, VHOST_CONFIG,
2112                                 "Failed to send IOTLB miss message (%d)\n",
2113                                 ret);
2114                 return ret;
2115         }
2116
2117         return 0;
2118 }
2119
2120 static int vhost_user_slave_set_vring_host_notifier(struct virtio_net *dev,
2121                                                     int index, int fd,
2122                                                     uint64_t offset,
2123                                                     uint64_t size)
2124 {
2125         int ret;
2126         struct VhostUserMsg msg = {
2127                 .request.slave = VHOST_USER_SLAVE_VRING_HOST_NOTIFIER_MSG,
2128                 .flags = VHOST_USER_VERSION | VHOST_USER_NEED_REPLY,
2129                 .size = sizeof(msg.payload.area),
2130                 .payload.area = {
2131                         .u64 = index & VHOST_USER_VRING_IDX_MASK,
2132                         .size = size,
2133                         .offset = offset,
2134                 },
2135         };
2136
2137         if (fd < 0)
2138                 msg.payload.area.u64 |= VHOST_USER_VRING_NOFD_MASK;
2139         else {
2140                 msg.fds[0] = fd;
2141                 msg.fd_num = 1;
2142         }
2143
2144         ret = send_vhost_slave_message(dev, &msg);
2145         if (ret < 0) {
2146                 RTE_LOG(ERR, VHOST_CONFIG,
2147                         "Failed to set host notifier (%d)\n", ret);
2148                 return ret;
2149         }
2150
2151         return process_slave_message_reply(dev, &msg);
2152 }
2153
2154 int rte_vhost_host_notifier_ctrl(int vid, bool enable)
2155 {
2156         struct virtio_net *dev;
2157         struct rte_vdpa_device *vdpa_dev;
2158         int vfio_device_fd, did, ret = 0;
2159         uint64_t offset, size;
2160         unsigned int i;
2161
2162         dev = get_device(vid);
2163         if (!dev)
2164                 return -ENODEV;
2165
2166         did = dev->vdpa_dev_id;
2167         if (did < 0)
2168                 return -EINVAL;
2169
2170         if (!(dev->features & (1ULL << VIRTIO_F_VERSION_1)) ||
2171             !(dev->features & (1ULL << VHOST_USER_F_PROTOCOL_FEATURES)) ||
2172             !(dev->protocol_features &
2173                         (1ULL << VHOST_USER_PROTOCOL_F_SLAVE_REQ)) ||
2174             !(dev->protocol_features &
2175                         (1ULL << VHOST_USER_PROTOCOL_F_SLAVE_SEND_FD)) ||
2176             !(dev->protocol_features &
2177                         (1ULL << VHOST_USER_PROTOCOL_F_HOST_NOTIFIER)))
2178                 return -ENOTSUP;
2179
2180         vdpa_dev = rte_vdpa_get_device(did);
2181         if (!vdpa_dev)
2182                 return -ENODEV;
2183
2184         RTE_FUNC_PTR_OR_ERR_RET(vdpa_dev->ops->get_vfio_device_fd, -ENOTSUP);
2185         RTE_FUNC_PTR_OR_ERR_RET(vdpa_dev->ops->get_notify_area, -ENOTSUP);
2186
2187         vfio_device_fd = vdpa_dev->ops->get_vfio_device_fd(vid);
2188         if (vfio_device_fd < 0)
2189                 return -ENOTSUP;
2190
2191         if (enable) {
2192                 for (i = 0; i < dev->nr_vring; i++) {
2193                         if (vdpa_dev->ops->get_notify_area(vid, i, &offset,
2194                                         &size) < 0) {
2195                                 ret = -ENOTSUP;
2196                                 goto disable;
2197                         }
2198
2199                         if (vhost_user_slave_set_vring_host_notifier(dev, i,
2200                                         vfio_device_fd, offset, size) < 0) {
2201                                 ret = -EFAULT;
2202                                 goto disable;
2203                         }
2204                 }
2205         } else {
2206 disable:
2207                 for (i = 0; i < dev->nr_vring; i++) {
2208                         vhost_user_slave_set_vring_host_notifier(dev, i, -1,
2209                                         0, 0);
2210                 }
2211         }
2212
2213         return ret;
2214 }