drivers/net/virtio/virtio_user/virtio_user_dev.c

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(c) 2010-2016 Intel Corporation
   3  */
   4
   5 #include <stdint.h>
   6 #include <stdio.h>
   7 #include <fcntl.h>
   8 #include <string.h>
   9 #include <errno.h>
  10 #include <sys/mman.h>
  11 #include <unistd.h>
  12 #include <sys/eventfd.h>
  13 #include <sys/types.h>
  14 #include <sys/stat.h>
  15
  16 #include <rte_string_fns.h>
  17 #include <rte_eal_memconfig.h>
  18
  19 #include "vhost.h"
  20 #include "virtio_user_dev.h"
  21 #include "../virtio_ethdev.h"
  22
  23 #define VIRTIO_USER_MEM_EVENT_CLB_NAME "virtio_user_mem_event_clb"
  24
  25 const char * const virtio_user_backend_strings[] = {
  26         [VIRTIO_USER_BACKEND_UNKNOWN] = "VIRTIO_USER_BACKEND_UNKNOWN",
  27         [VIRTIO_USER_BACKEND_VHOST_USER] = "VHOST_USER",
  28         [VIRTIO_USER_BACKEND_VHOST_KERNEL] = "VHOST_NET",
  29         [VIRTIO_USER_BACKEND_VHOST_VDPA] = "VHOST_VDPA",
  30 };
  31
  32 static int
  33 virtio_user_create_queue(struct virtio_user_dev *dev, uint32_t queue_sel)
  34 {
  35         /* Of all per virtqueue MSGs, make sure VHOST_SET_VRING_CALL come
  36          * firstly because vhost depends on this msg to allocate virtqueue
  37          * pair.
  38          */
  39         struct vhost_vring_file file;
  40         int ret;
  41
  42         file.index = queue_sel;
  43         file.fd = dev->callfds[queue_sel];
  44         ret = dev->ops->set_vring_call(dev, &file);
  45         if (ret < 0) {
  46                 PMD_INIT_LOG(ERR, "(%s) Failed to create queue %u\n", dev->path, queue_sel);
  47                 return -1;
  48         }
  49
  50         return 0;
  51 }
  52
  53 static int
  54 virtio_user_kick_queue(struct virtio_user_dev *dev, uint32_t queue_sel)
  55 {
  56         int ret;
  57         struct vhost_vring_file file;
  58         struct vhost_vring_state state;
  59         struct vring *vring = &dev->vrings[queue_sel];
  60         struct vring_packed *pq_vring = &dev->packed_vrings[queue_sel];
  61         struct vhost_vring_addr addr = {
  62                 .index = queue_sel,
  63                 .log_guest_addr = 0,
  64                 .flags = 0, /* disable log */
  65         };
  66
  67         if (dev->features & (1ULL << VIRTIO_F_RING_PACKED)) {
  68                 addr.desc_user_addr =
  69                         (uint64_t)(uintptr_t)pq_vring->desc;
  70                 addr.avail_user_addr =
  71                         (uint64_t)(uintptr_t)pq_vring->driver;
  72                 addr.used_user_addr =
  73                         (uint64_t)(uintptr_t)pq_vring->device;
  74         } else {
  75                 addr.desc_user_addr = (uint64_t)(uintptr_t)vring->desc;
  76                 addr.avail_user_addr = (uint64_t)(uintptr_t)vring->avail;
  77                 addr.used_user_addr = (uint64_t)(uintptr_t)vring->used;
  78         }
  79
  80         state.index = queue_sel;
  81         state.num = vring->num;
  82         ret = dev->ops->set_vring_num(dev, &state);
  83         if (ret < 0)
  84                 goto err;
  85
  86         state.index = queue_sel;
  87         state.num = 0; /* no reservation */
  88         if (dev->features & (1ULL << VIRTIO_F_RING_PACKED))
  89                 state.num |= (1 << 15);
  90         ret = dev->ops->set_vring_base(dev, &state);
  91         if (ret < 0)
  92                 goto err;
  93
  94         ret = dev->ops->set_vring_addr(dev, &addr);
  95         if (ret < 0)
  96                 goto err;
  97
  98         /* Of all per virtqueue MSGs, make sure VHOST_USER_SET_VRING_KICK comes
  99          * lastly because vhost depends on this msg to judge if
 100          * virtio is ready.
 101          */
 102         file.index = queue_sel;
 103         file.fd = dev->kickfds[queue_sel];
 104         ret = dev->ops->set_vring_kick(dev, &file);
 105         if (ret < 0)
 106                 goto err;
 107
 108         return 0;
 109 err:
 110         PMD_INIT_LOG(ERR, "(%s) Failed to kick queue %u\n", dev->path, queue_sel);
 111
 112         return -1;
 113 }
 114
 115 static int
 116 virtio_user_queue_setup(struct virtio_user_dev *dev,
 117                         int (*fn)(struct virtio_user_dev *, uint32_t))
 118 {
 119         uint32_t i, queue_sel;
 120
 121         for (i = 0; i < dev->max_queue_pairs; ++i) {
 122                 queue_sel = 2 * i + VTNET_SQ_RQ_QUEUE_IDX;
 123                 if (fn(dev, queue_sel) < 0) {
 124                         PMD_DRV_LOG(ERR, "(%s) setup rx vq %u failed", dev->path, i);
 125                         return -1;
 126                 }
 127         }
 128         for (i = 0; i < dev->max_queue_pairs; ++i) {
 129                 queue_sel = 2 * i + VTNET_SQ_TQ_QUEUE_IDX;
 130                 if (fn(dev, queue_sel) < 0) {
 131                         PMD_DRV_LOG(INFO, "(%s) setup tx vq %u failed", dev->path, i);
 132                         return -1;
 133                 }
 134         }
 135
 136         return 0;
 137 }
 138
 139 int
 140 virtio_user_dev_set_features(struct virtio_user_dev *dev)
 141 {
 142         uint64_t features;
 143         int ret = -1;
 144
 145         pthread_mutex_lock(&dev->mutex);
 146
 147         /* Step 0: tell vhost to create queues */
 148         if (virtio_user_queue_setup(dev, virtio_user_create_queue) < 0)
 149                 goto error;
 150
 151         features = dev->features;
 152
 153         /* Strip VIRTIO_NET_F_MAC, as MAC address is handled in vdev init */
 154         features &= ~(1ull << VIRTIO_NET_F_MAC);
 155         /* Strip VIRTIO_NET_F_CTRL_VQ, as devices do not really need to know */
 156         features &= ~(1ull << VIRTIO_NET_F_CTRL_VQ);
 157         features &= ~(1ull << VIRTIO_NET_F_STATUS);
 158         ret = dev->ops->set_features(dev, features);
 159         if (ret < 0)
 160                 goto error;
 161         PMD_DRV_LOG(INFO, "(%s) set features: 0x%" PRIx64, dev->path, features);
 162 error:
 163         pthread_mutex_unlock(&dev->mutex);
 164
 165         return ret;
 166 }
 167
 168 int
 169 virtio_user_start_device(struct virtio_user_dev *dev)
 170 {
 171         int ret;
 172
 173         /*
 174          * XXX workaround!
 175          *
 176          * We need to make sure that the locks will be
 177          * taken in the correct order to avoid deadlocks.
 178          *
 179          * Before releasing this lock, this thread should
 180          * not trigger any memory hotplug events.
 181          *
 182          * This is a temporary workaround, and should be
 183          * replaced when we get proper supports from the
 184          * memory subsystem in the future.
 185          */
 186         rte_mcfg_mem_read_lock();
 187         pthread_mutex_lock(&dev->mutex);
 188
 189         /* Step 2: share memory regions */
 190         ret = dev->ops->set_memory_table(dev);
 191         if (ret < 0)
 192                 goto error;
 193
 194         /* Step 3: kick queues */
 195         ret = virtio_user_queue_setup(dev, virtio_user_kick_queue);
 196         if (ret < 0)
 197                 goto error;
 198
 199         /* Step 4: enable queues
 200          * we enable the 1st queue pair by default.
 201          */
 202         ret = dev->ops->enable_qp(dev, 0, 1);
 203         if (ret < 0)
 204                 goto error;
 205
 206         dev->started = true;
 207
 208         pthread_mutex_unlock(&dev->mutex);
 209         rte_mcfg_mem_read_unlock();
 210
 211         return 0;
 212 error:
 213         pthread_mutex_unlock(&dev->mutex);
 214         rte_mcfg_mem_read_unlock();
 215
 216         PMD_INIT_LOG(ERR, "(%s) Failed to start device\n", dev->path);
 217
 218         /* TODO: free resource here or caller to check */
 219         return -1;
 220 }
 221
 222 int virtio_user_stop_device(struct virtio_user_dev *dev)
 223 {
 224         struct vhost_vring_state state;
 225         uint32_t i;
 226         int ret;
 227
 228         pthread_mutex_lock(&dev->mutex);
 229         if (!dev->started)
 230                 goto out;
 231
 232         for (i = 0; i < dev->max_queue_pairs; ++i) {
 233                 ret = dev->ops->enable_qp(dev, i, 0);
 234                 if (ret < 0)
 235                         goto err;
 236         }
 237
 238         /* Stop the backend. */
 239         for (i = 0; i < dev->max_queue_pairs * 2; ++i) {
 240                 state.index = i;
 241                 ret = dev->ops->get_vring_base(dev, &state);
 242                 if (ret < 0) {
 243                         PMD_DRV_LOG(ERR, "(%s) get_vring_base failed, index=%u", dev->path, i);
 244                         goto err;
 245                 }
 246         }
 247
 248         dev->started = false;
 249
 250 out:
 251         pthread_mutex_unlock(&dev->mutex);
 252
 253         return 0;
 254 err:
 255         pthread_mutex_unlock(&dev->mutex);
 256
 257         PMD_INIT_LOG(ERR, "(%s) Failed to stop device\n", dev->path);
 258
 259         return -1;
 260 }
 261
 262 static inline void
 263 parse_mac(struct virtio_user_dev *dev, const char *mac)
 264 {
 265         struct rte_ether_addr tmp;
 266
 267         if (!mac)
 268                 return;
 269
 270         if (rte_ether_unformat_addr(mac, &tmp) == 0) {
 271                 memcpy(dev->mac_addr, &tmp, RTE_ETHER_ADDR_LEN);
 272                 dev->mac_specified = 1;
 273         } else {
 274                 /* ignore the wrong mac, use random mac */
 275                 PMD_DRV_LOG(ERR, "wrong format of mac: %s", mac);
 276         }
 277 }
 278
 279 static int
 280 virtio_user_dev_init_notify(struct virtio_user_dev *dev)
 281 {
 282         uint32_t i, j;
 283         int callfd;
 284         int kickfd;
 285
 286         for (i = 0; i < VIRTIO_MAX_VIRTQUEUES; ++i) {
 287                 if (i >= dev->max_queue_pairs * 2) {
 288                         dev->kickfds[i] = -1;
 289                         dev->callfds[i] = -1;
 290                         continue;
 291                 }
 292
 293                 /* May use invalid flag, but some backend uses kickfd and
 294                  * callfd as criteria to judge if dev is alive. so finally we
 295                  * use real event_fd.
 296                  */
 297                 callfd = eventfd(0, EFD_CLOEXEC | EFD_NONBLOCK);
 298                 if (callfd < 0) {
 299                         PMD_DRV_LOG(ERR, "(%s) callfd error, %s", dev->path, strerror(errno));
 300                         break;
 301                 }
 302                 kickfd = eventfd(0, EFD_CLOEXEC | EFD_NONBLOCK);
 303                 if (kickfd < 0) {
 304                         close(callfd);
 305                         PMD_DRV_LOG(ERR, "(%s) kickfd error, %s", dev->path, strerror(errno));
 306                         break;
 307                 }
 308                 dev->callfds[i] = callfd;
 309                 dev->kickfds[i] = kickfd;
 310         }
 311
 312         if (i < VIRTIO_MAX_VIRTQUEUES) {
 313                 for (j = 0; j < i; ++j) {
 314                         close(dev->callfds[j]);
 315                         close(dev->kickfds[j]);
 316                 }
 317
 318                 return -1;
 319         }
 320
 321         return 0;
 322 }
 323
 324 static int
 325 virtio_user_fill_intr_handle(struct virtio_user_dev *dev)
 326 {
 327         uint32_t i;
 328         struct rte_eth_dev *eth_dev = &rte_eth_devices[dev->port_id];
 329
 330         if (!eth_dev->intr_handle) {
 331                 eth_dev->intr_handle = malloc(sizeof(*eth_dev->intr_handle));
 332                 if (!eth_dev->intr_handle) {
 333                         PMD_DRV_LOG(ERR, "(%s) failed to allocate intr_handle", dev->path);
 334                         return -1;
 335                 }
 336                 memset(eth_dev->intr_handle, 0, sizeof(*eth_dev->intr_handle));
 337         }
 338
 339         for (i = 0; i < dev->max_queue_pairs; ++i)
 340                 eth_dev->intr_handle->efds[i] = dev->callfds[i];
 341         eth_dev->intr_handle->nb_efd = dev->max_queue_pairs;
 342         eth_dev->intr_handle->max_intr = dev->max_queue_pairs + 1;
 343         eth_dev->intr_handle->type = RTE_INTR_HANDLE_VDEV;
 344         /* For virtio vdev, no need to read counter for clean */
 345         eth_dev->intr_handle->efd_counter_size = 0;
 346         eth_dev->intr_handle->fd = -1;
 347         if (dev->vhostfd >= 0)
 348                 eth_dev->intr_handle->fd = dev->vhostfd;
 349         else if (dev->is_server)
 350                 eth_dev->intr_handle->fd = dev->listenfd;
 351
 352         return 0;
 353 }
 354
 355 static void
 356 virtio_user_mem_event_cb(enum rte_mem_event type __rte_unused,
 357                          const void *addr,
 358                          size_t len __rte_unused,
 359                          void *arg)
 360 {
 361         struct virtio_user_dev *dev = arg;
 362         struct rte_memseg_list *msl;
 363         uint16_t i;
 364         int ret = 0;
 365
 366         /* ignore externally allocated memory */
 367         msl = rte_mem_virt2memseg_list(addr);
 368         if (msl->external)
 369                 return;
 370
 371         pthread_mutex_lock(&dev->mutex);
 372
 373         if (dev->started == false)
 374                 goto exit;
 375
 376         /* Step 1: pause the active queues */
 377         for (i = 0; i < dev->queue_pairs; i++) {
 378                 ret = dev->ops->enable_qp(dev, i, 0);
 379                 if (ret < 0)
 380                         goto exit;
 381         }
 382
 383         /* Step 2: update memory regions */
 384         ret = dev->ops->set_memory_table(dev);
 385         if (ret < 0)
 386                 goto exit;
 387
 388         /* Step 3: resume the active queues */
 389         for (i = 0; i < dev->queue_pairs; i++) {
 390                 ret = dev->ops->enable_qp(dev, i, 1);
 391                 if (ret < 0)
 392                         goto exit;
 393         }
 394
 395 exit:
 396         pthread_mutex_unlock(&dev->mutex);
 397
 398         if (ret < 0)
 399                 PMD_DRV_LOG(ERR, "(%s) Failed to update memory table\n", dev->path);
 400 }
 401
 402 static int
 403 virtio_user_dev_setup(struct virtio_user_dev *dev)
 404 {
 405         uint32_t q;
 406
 407         dev->vhostfd = -1;
 408         dev->vhostfds = NULL;
 409         dev->tapfds = NULL;
 410
 411         if (dev->is_server) {
 412                 if (dev->backend_type != VIRTIO_USER_BACKEND_VHOST_USER) {
 413                         PMD_DRV_LOG(ERR, "Server mode only supports vhost-user!");
 414                         return -1;
 415                 }
 416         }
 417
 418         if (dev->backend_type == VIRTIO_USER_BACKEND_VHOST_USER) {
 419                 dev->ops = &virtio_ops_user;
 420         } else if (dev->backend_type ==
 421                         VIRTIO_USER_BACKEND_VHOST_KERNEL) {
 422                 dev->ops = &virtio_ops_kernel;
 423
 424                 dev->vhostfds = malloc(dev->max_queue_pairs *
 425                                 sizeof(int));
 426                 dev->tapfds = malloc(dev->max_queue_pairs *
 427                                 sizeof(int));
 428                 if (!dev->vhostfds || !dev->tapfds) {
 429                         PMD_INIT_LOG(ERR, "(%s) Failed to allocate FDs", dev->path);
 430                         return -1;
 431                 }
 432
 433                 for (q = 0; q < dev->max_queue_pairs; ++q) {
 434                         dev->vhostfds[q] = -1;
 435                         dev->tapfds[q] = -1;
 436                 }
 437         } else if (dev->backend_type ==
 438                         VIRTIO_USER_BACKEND_VHOST_VDPA) {
 439                 dev->ops = &virtio_ops_vdpa;
 440         } else {
 441                 PMD_DRV_LOG(ERR, "(%s) Unknown backend type", dev->path);
 442                 return -1;
 443         }
 444
 445
 446         if (dev->ops->setup(dev) < 0) {
 447                 PMD_INIT_LOG(ERR, "(%s) Failed to setup backend\n", dev->path);
 448                 return -1;
 449         }
 450
 451         if (virtio_user_dev_init_notify(dev) < 0) {
 452                 PMD_INIT_LOG(ERR, "(%s) Failed to init notifiers\n", dev->path);
 453                 return -1;
 454         }
 455
 456         if (virtio_user_fill_intr_handle(dev) < 0) {
 457                 PMD_INIT_LOG(ERR, "(%s) Failed to init interrupt handler\n", dev->path);
 458                 return -1;
 459         }
 460
 461         return 0;
 462 }
 463
 464 /* Use below macro to filter features from vhost backend */
 465 #define VIRTIO_USER_SUPPORTED_FEATURES                  \
 466         (1ULL << VIRTIO_NET_F_MAC               |       \
 467          1ULL << VIRTIO_NET_F_STATUS            |       \
 468          1ULL << VIRTIO_NET_F_MQ                |       \
 469          1ULL << VIRTIO_NET_F_CTRL_MAC_ADDR     |       \
 470          1ULL << VIRTIO_NET_F_CTRL_VQ           |       \
 471          1ULL << VIRTIO_NET_F_CTRL_RX           |       \
 472          1ULL << VIRTIO_NET_F_CTRL_VLAN         |       \
 473          1ULL << VIRTIO_NET_F_CSUM              |       \
 474          1ULL << VIRTIO_NET_F_HOST_TSO4         |       \
 475          1ULL << VIRTIO_NET_F_HOST_TSO6         |       \
 476          1ULL << VIRTIO_NET_F_MRG_RXBUF         |       \
 477          1ULL << VIRTIO_RING_F_INDIRECT_DESC    |       \
 478          1ULL << VIRTIO_NET_F_GUEST_CSUM        |       \
 479          1ULL << VIRTIO_NET_F_GUEST_TSO4        |       \
 480          1ULL << VIRTIO_NET_F_GUEST_TSO6        |       \
 481          1ULL << VIRTIO_F_IN_ORDER              |       \
 482          1ULL << VIRTIO_F_VERSION_1             |       \
 483          1ULL << VIRTIO_F_RING_PACKED)
 484
 485 int
 486 virtio_user_dev_init(struct virtio_user_dev *dev, char *path, int queues,
 487                      int cq, int queue_size, const char *mac, char **ifname,
 488                      int server, int mrg_rxbuf, int in_order, int packed_vq,
 489                      enum virtio_user_backend_type backend_type)
 490 {
 491         uint64_t backend_features;
 492
 493         pthread_mutex_init(&dev->mutex, NULL);
 494         strlcpy(dev->path, path, PATH_MAX);
 495         dev->started = 0;
 496         dev->max_queue_pairs = queues;
 497         dev->queue_pairs = 1; /* mq disabled by default */
 498         dev->queue_size = queue_size;
 499         dev->is_server = server;
 500         dev->mac_specified = 0;
 501         dev->frontend_features = 0;
 502         dev->unsupported_features = 0;
 503         dev->backend_type = backend_type;
 504
 505         parse_mac(dev, mac);
 506
 507         if (*ifname) {
 508                 dev->ifname = *ifname;
 509                 *ifname = NULL;
 510         }
 511
 512         if (virtio_user_dev_setup(dev) < 0) {
 513                 PMD_INIT_LOG(ERR, "(%s) backend set up fails", dev->path);
 514                 return -1;
 515         }
 516
 517         if (dev->ops->set_owner(dev) < 0) {
 518                 PMD_INIT_LOG(ERR, "(%s) Failed to set backend owner", dev->path);
 519                 return -1;
 520         }
 521
 522         if (dev->ops->get_backend_features(&backend_features) < 0) {
 523                 PMD_INIT_LOG(ERR, "(%s) Failed to get backend features", dev->path);
 524                 return -1;
 525         }
 526
 527         dev->unsupported_features = ~(VIRTIO_USER_SUPPORTED_FEATURES | backend_features);
 528
 529         if (dev->ops->get_features(dev, &dev->device_features) < 0) {
 530                 PMD_INIT_LOG(ERR, "(%s) Failed to get device features", dev->path);
 531                 return -1;
 532         }
 533
 534         if (!mrg_rxbuf)
 535                 dev->unsupported_features |= (1ull << VIRTIO_NET_F_MRG_RXBUF);
 536
 537         if (!in_order)
 538                 dev->unsupported_features |= (1ull << VIRTIO_F_IN_ORDER);
 539
 540         if (!packed_vq)
 541                 dev->unsupported_features |= (1ull << VIRTIO_F_RING_PACKED);
 542
 543         if (dev->mac_specified)
 544                 dev->frontend_features |= (1ull << VIRTIO_NET_F_MAC);
 545         else
 546                 dev->unsupported_features |= (1ull << VIRTIO_NET_F_MAC);
 547
 548         if (cq) {
 549                 /* device does not really need to know anything about CQ,
 550                  * so if necessary, we just claim to support CQ
 551                  */
 552                 dev->frontend_features |= (1ull << VIRTIO_NET_F_CTRL_VQ);
 553         } else {
 554                 dev->unsupported_features |= (1ull << VIRTIO_NET_F_CTRL_VQ);
 555                 /* Also disable features that depend on VIRTIO_NET_F_CTRL_VQ */
 556                 dev->unsupported_features |= (1ull << VIRTIO_NET_F_CTRL_RX);
 557                 dev->unsupported_features |= (1ull << VIRTIO_NET_F_CTRL_VLAN);
 558                 dev->unsupported_features |=
 559                         (1ull << VIRTIO_NET_F_GUEST_ANNOUNCE);
 560                 dev->unsupported_features |= (1ull << VIRTIO_NET_F_MQ);
 561                 dev->unsupported_features |=
 562                         (1ull << VIRTIO_NET_F_CTRL_MAC_ADDR);
 563         }
 564
 565         /* The backend will not report this feature, we add it explicitly */
 566         if (dev->backend_type == VIRTIO_USER_BACKEND_VHOST_USER)
 567                 dev->frontend_features |= (1ull << VIRTIO_NET_F_STATUS);
 568
 569         /*
 570          * Device features =
 571          *     (frontend_features | backend_features) & ~unsupported_features;
 572          */
 573         dev->device_features |= dev->frontend_features;
 574         dev->device_features &= ~dev->unsupported_features;
 575
 576         if (rte_mem_event_callback_register(VIRTIO_USER_MEM_EVENT_CLB_NAME,
 577                                 virtio_user_mem_event_cb, dev)) {
 578                 if (rte_errno != ENOTSUP) {
 579                         PMD_INIT_LOG(ERR, "(%s) Failed to register mem event callback\n",
 580                                         dev->path);
 581                         return -1;
 582                 }
 583         }
 584
 585         return 0;
 586 }
 587
 588 void
 589 virtio_user_dev_uninit(struct virtio_user_dev *dev)
 590 {
 591         uint32_t i;
 592
 593         virtio_user_stop_device(dev);
 594
 595         rte_mem_event_callback_unregister(VIRTIO_USER_MEM_EVENT_CLB_NAME, dev);
 596
 597         for (i = 0; i < dev->max_queue_pairs * 2; ++i) {
 598                 close(dev->callfds[i]);
 599                 close(dev->kickfds[i]);
 600         }
 601
 602         if (dev->vhostfd >= 0)
 603                 close(dev->vhostfd);
 604
 605         if (dev->is_server && dev->listenfd >= 0) {
 606                 close(dev->listenfd);
 607                 dev->listenfd = -1;
 608         }
 609
 610         if (dev->vhostfds) {
 611                 for (i = 0; i < dev->max_queue_pairs; ++i) {
 612                         close(dev->vhostfds[i]);
 613                         if (dev->tapfds[i] >= 0)
 614                                 close(dev->tapfds[i]);
 615                 }
 616                 free(dev->vhostfds);
 617                 free(dev->tapfds);
 618         }
 619
 620         free(dev->ifname);
 621
 622         if (dev->is_server)
 623                 unlink(dev->path);
 624
 625         dev->ops->destroy(dev);
 626 }
 627
 628 uint8_t
 629 virtio_user_handle_mq(struct virtio_user_dev *dev, uint16_t q_pairs)
 630 {
 631         uint16_t i;
 632         uint8_t ret = 0;
 633
 634         if (q_pairs > dev->max_queue_pairs) {
 635                 PMD_INIT_LOG(ERR, "(%s) multi-q config %u, but only %u supported",
 636                              dev->path, q_pairs, dev->max_queue_pairs);
 637                 return -1;
 638         }
 639
 640         /* Server mode can't enable queue pairs if vhostfd is invalid,
 641          * always return 0 in this case.
 642          */
 643         if (!dev->is_server || dev->vhostfd >= 0) {
 644                 for (i = 0; i < q_pairs; ++i)
 645                         ret |= dev->ops->enable_qp(dev, i, 1);
 646                 for (i = q_pairs; i < dev->max_queue_pairs; ++i)
 647                         ret |= dev->ops->enable_qp(dev, i, 0);
 648         }
 649         dev->queue_pairs = q_pairs;
 650
 651         return ret;
 652 }
 653
 654 static uint32_t
 655 virtio_user_handle_ctrl_msg(struct virtio_user_dev *dev, struct vring *vring,
 656                             uint16_t idx_hdr)
 657 {
 658         struct virtio_net_ctrl_hdr *hdr;
 659         virtio_net_ctrl_ack status = ~0;
 660         uint16_t i, idx_data, idx_status;
 661         uint32_t n_descs = 0;
 662
 663         /* locate desc for header, data, and status */
 664         idx_data = vring->desc[idx_hdr].next;
 665         n_descs++;
 666
 667         i = idx_data;
 668         while (vring->desc[i].flags == VRING_DESC_F_NEXT) {
 669                 i = vring->desc[i].next;
 670                 n_descs++;
 671         }
 672
 673         /* locate desc for status */
 674         idx_status = i;
 675         n_descs++;
 676
 677         hdr = (void *)(uintptr_t)vring->desc[idx_hdr].addr;
 678         if (hdr->class == VIRTIO_NET_CTRL_MQ &&
 679             hdr->cmd == VIRTIO_NET_CTRL_MQ_VQ_PAIRS_SET) {
 680                 uint16_t queues;
 681
 682                 queues = *(uint16_t *)(uintptr_t)vring->desc[idx_data].addr;
 683                 status = virtio_user_handle_mq(dev, queues);
 684         } else if (hdr->class == VIRTIO_NET_CTRL_RX  ||
 685                    hdr->class == VIRTIO_NET_CTRL_MAC ||
 686                    hdr->class == VIRTIO_NET_CTRL_VLAN) {
 687                 status = 0;
 688         }
 689
 690         /* Update status */
 691         *(virtio_net_ctrl_ack *)(uintptr_t)vring->desc[idx_status].addr = status;
 692
 693         return n_descs;
 694 }
 695
 696 static inline int
 697 desc_is_avail(struct vring_packed_desc *desc, bool wrap_counter)
 698 {
 699         uint16_t flags = __atomic_load_n(&desc->flags, __ATOMIC_ACQUIRE);
 700
 701         return wrap_counter == !!(flags & VRING_PACKED_DESC_F_AVAIL) &&
 702                 wrap_counter != !!(flags & VRING_PACKED_DESC_F_USED);
 703 }
 704
 705 static uint32_t
 706 virtio_user_handle_ctrl_msg_packed(struct virtio_user_dev *dev,
 707                                    struct vring_packed *vring,
 708                                    uint16_t idx_hdr)
 709 {
 710         struct virtio_net_ctrl_hdr *hdr;
 711         virtio_net_ctrl_ack status = ~0;
 712         uint16_t idx_data, idx_status;
 713         /* initialize to one, header is first */
 714         uint32_t n_descs = 1;
 715
 716         /* locate desc for header, data, and status */
 717         idx_data = idx_hdr + 1;
 718         if (idx_data >= dev->queue_size)
 719                 idx_data -= dev->queue_size;
 720
 721         n_descs++;
 722
 723         idx_status = idx_data;
 724         while (vring->desc[idx_status].flags & VRING_DESC_F_NEXT) {
 725                 idx_status++;
 726                 if (idx_status >= dev->queue_size)
 727                         idx_status -= dev->queue_size;
 728                 n_descs++;
 729         }
 730
 731         hdr = (void *)(uintptr_t)vring->desc[idx_hdr].addr;
 732         if (hdr->class == VIRTIO_NET_CTRL_MQ &&
 733             hdr->cmd == VIRTIO_NET_CTRL_MQ_VQ_PAIRS_SET) {
 734                 uint16_t queues;
 735
 736                 queues = *(uint16_t *)(uintptr_t)
 737                                 vring->desc[idx_data].addr;
 738                 status = virtio_user_handle_mq(dev, queues);
 739         } else if (hdr->class == VIRTIO_NET_CTRL_RX  ||
 740                    hdr->class == VIRTIO_NET_CTRL_MAC ||
 741                    hdr->class == VIRTIO_NET_CTRL_VLAN) {
 742                 status = 0;
 743         }
 744
 745         /* Update status */
 746         *(virtio_net_ctrl_ack *)(uintptr_t)
 747                 vring->desc[idx_status].addr = status;
 748
 749         /* Update used descriptor */
 750         vring->desc[idx_hdr].id = vring->desc[idx_status].id;
 751         vring->desc[idx_hdr].len = sizeof(status);
 752
 753         return n_descs;
 754 }
 755
 756 void
 757 virtio_user_handle_cq_packed(struct virtio_user_dev *dev, uint16_t queue_idx)
 758 {
 759         struct virtio_user_queue *vq = &dev->packed_queues[queue_idx];
 760         struct vring_packed *vring = &dev->packed_vrings[queue_idx];
 761         uint16_t n_descs, flags;
 762
 763         /* Perform a load-acquire barrier in desc_is_avail to
 764          * enforce the ordering between desc flags and desc
 765          * content.
 766          */
 767         while (desc_is_avail(&vring->desc[vq->used_idx],
 768                              vq->used_wrap_counter)) {
 769
 770                 n_descs = virtio_user_handle_ctrl_msg_packed(dev, vring,
 771                                 vq->used_idx);
 772
 773                 flags = VRING_DESC_F_WRITE;
 774                 if (vq->used_wrap_counter)
 775                         flags |= VRING_PACKED_DESC_F_AVAIL_USED;
 776
 777                 __atomic_store_n(&vring->desc[vq->used_idx].flags, flags,
 778                                  __ATOMIC_RELEASE);
 779
 780                 vq->used_idx += n_descs;
 781                 if (vq->used_idx >= dev->queue_size) {
 782                         vq->used_idx -= dev->queue_size;
 783                         vq->used_wrap_counter ^= 1;
 784                 }
 785         }
 786 }
 787
 788 void
 789 virtio_user_handle_cq(struct virtio_user_dev *dev, uint16_t queue_idx)
 790 {
 791         uint16_t avail_idx, desc_idx;
 792         struct vring_used_elem *uep;
 793         uint32_t n_descs;
 794         struct vring *vring = &dev->vrings[queue_idx];
 795
 796         /* Consume avail ring, using used ring idx as first one */
 797         while (__atomic_load_n(&vring->used->idx, __ATOMIC_RELAXED)
 798                != vring->avail->idx) {
 799                 avail_idx = __atomic_load_n(&vring->used->idx, __ATOMIC_RELAXED)
 800                             & (vring->num - 1);
 801                 desc_idx = vring->avail->ring[avail_idx];
 802
 803                 n_descs = virtio_user_handle_ctrl_msg(dev, vring, desc_idx);
 804
 805                 /* Update used ring */
 806                 uep = &vring->used->ring[avail_idx];
 807                 uep->id = desc_idx;
 808                 uep->len = n_descs;
 809
 810                 __atomic_add_fetch(&vring->used->idx, 1, __ATOMIC_RELAXED);
 811         }
 812 }
 813
 814 int
 815 virtio_user_dev_set_status(struct virtio_user_dev *dev, uint8_t status)
 816 {
 817         int ret;
 818
 819         pthread_mutex_lock(&dev->mutex);
 820         dev->status = status;
 821         ret = dev->ops->set_status(dev, status);
 822         if (ret && ret != -ENOTSUP)
 823                 PMD_INIT_LOG(ERR, "(%s) Failed to set backend status\n", dev->path);
 824
 825         pthread_mutex_unlock(&dev->mutex);
 826         return ret;
 827 }
 828
 829 int
 830 virtio_user_dev_update_status(struct virtio_user_dev *dev)
 831 {
 832         int ret;
 833         uint8_t status;
 834
 835         pthread_mutex_lock(&dev->mutex);
 836
 837         ret = dev->ops->get_status(dev, &status);
 838         if (!ret) {
 839                 dev->status = status;
 840                 PMD_INIT_LOG(DEBUG, "Updated Device Status(0x%08x):\n"
 841                         "\t-RESET: %u\n"
 842                         "\t-ACKNOWLEDGE: %u\n"
 843                         "\t-DRIVER: %u\n"
 844                         "\t-DRIVER_OK: %u\n"
 845                         "\t-FEATURES_OK: %u\n"
 846                         "\t-DEVICE_NEED_RESET: %u\n"
 847                         "\t-FAILED: %u\n",
 848                         dev->status,
 849                         (dev->status == VIRTIO_CONFIG_STATUS_RESET),
 850                         !!(dev->status & VIRTIO_CONFIG_STATUS_ACK),
 851                         !!(dev->status & VIRTIO_CONFIG_STATUS_DRIVER),
 852                         !!(dev->status & VIRTIO_CONFIG_STATUS_DRIVER_OK),
 853                         !!(dev->status & VIRTIO_CONFIG_STATUS_FEATURES_OK),
 854                         !!(dev->status & VIRTIO_CONFIG_STATUS_DEV_NEED_RESET),
 855                         !!(dev->status & VIRTIO_CONFIG_STATUS_FAILED));
 856         } else if (ret != -ENOTSUP) {
 857                 PMD_INIT_LOG(ERR, "(%s) Failed to get backend status\n", dev->path);
 858         }
 859
 860         pthread_mutex_unlock(&dev->mutex);
 861         return ret;
 862 }