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