drivers/net/virtio/virtio_user_ethdev.c

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(c) 2010-2016 Intel Corporation
   3  */
   4
   5 #include <stdint.h>
   6 #include <sys/types.h>
   7 #include <unistd.h>
   8 #include <fcntl.h>
   9 #include <linux/major.h>
  10 #include <sys/stat.h>
  11 #include <sys/sysmacros.h>
  12 #include <sys/socket.h>
  13
  14 #include <rte_malloc.h>
  15 #include <rte_kvargs.h>
  16 #include <ethdev_vdev.h>
  17 #include <rte_bus_vdev.h>
  18 #include <rte_alarm.h>
  19 #include <rte_cycles.h>
  20
  21 #include "virtio_ethdev.h"
  22 #include "virtio_logs.h"
  23 #include "virtio_pci.h"
  24 #include "virtqueue.h"
  25 #include "virtio_rxtx.h"
  26 #include "virtio_user/virtio_user_dev.h"
  27 #include "virtio_user/vhost.h"
  28
  29 #define virtio_user_get_dev(hwp) container_of(hwp, struct virtio_user_dev, hw)
  30
  31 static void
  32 virtio_user_reset_queues_packed(struct rte_eth_dev *eth_dev)
  33 {
  34         struct virtio_user_dev *dev = eth_dev->data->dev_private;
  35         struct virtio_hw *hw = &dev->hw;
  36         struct virtnet_rx *rxvq;
  37         struct virtnet_tx *txvq;
  38         uint16_t i;
  39
  40         /* Add lock to avoid queue contention. */
  41         rte_spinlock_lock(&hw->state_lock);
  42         hw->started = 0;
  43
  44         /*
  45          * Waitting for datapath to complete before resetting queues.
  46          * 1 ms should be enough for the ongoing Tx/Rx function to finish.
  47          */
  48         rte_delay_ms(1);
  49
  50         /* Vring reset for each Tx queue and Rx queue. */
  51         for (i = 0; i < eth_dev->data->nb_rx_queues; i++) {
  52                 rxvq = eth_dev->data->rx_queues[i];
  53                 virtqueue_rxvq_reset_packed(rxvq->vq);
  54                 virtio_dev_rx_queue_setup_finish(eth_dev, i);
  55         }
  56
  57         for (i = 0; i < eth_dev->data->nb_tx_queues; i++) {
  58                 txvq = eth_dev->data->tx_queues[i];
  59                 virtqueue_txvq_reset_packed(txvq->vq);
  60         }
  61
  62         hw->started = 1;
  63         rte_spinlock_unlock(&hw->state_lock);
  64 }
  65
  66
  67 static int
  68 virtio_user_server_reconnect(struct virtio_user_dev *dev)
  69 {
  70         int ret, connectfd, old_status;
  71         struct rte_eth_dev *eth_dev = &rte_eth_devices[dev->port_id];
  72         struct virtio_hw *hw = &dev->hw;
  73         uint64_t protocol_features;
  74
  75         connectfd = accept(dev->listenfd, NULL, NULL);
  76         if (connectfd < 0)
  77                 return -1;
  78
  79         dev->vhostfd = connectfd;
  80         old_status = dev->status;
  81
  82         vtpci_reset(hw);
  83
  84         vtpci_set_status(hw, VIRTIO_CONFIG_STATUS_ACK);
  85
  86         vtpci_set_status(hw, VIRTIO_CONFIG_STATUS_DRIVER);
  87
  88         if (dev->ops->send_request(dev, VHOST_USER_GET_FEATURES,
  89                                    &dev->device_features) < 0) {
  90                 PMD_INIT_LOG(ERR, "get_features failed: %s",
  91                              strerror(errno));
  92                 return -1;
  93         }
  94
  95         if (dev->device_features &
  96                         (1ULL << VHOST_USER_F_PROTOCOL_FEATURES)) {
  97                 if (dev->ops->send_request(dev,
  98                                         VHOST_USER_GET_PROTOCOL_FEATURES,
  99                                         &protocol_features))
 100                         return -1;
 101
 102                 /* Offer VHOST_USER_PROTOCOL_F_STATUS */
 103                 dev->protocol_features |=
 104                         (1ULL << VHOST_USER_PROTOCOL_F_STATUS);
 105                 dev->protocol_features &= protocol_features;
 106
 107                 if (dev->ops->send_request(dev,
 108                                         VHOST_USER_SET_PROTOCOL_FEATURES,
 109                                         &dev->protocol_features))
 110                         return -1;
 111
 112                 if (!(dev->protocol_features &
 113                                 (1ULL << VHOST_USER_PROTOCOL_F_MQ)))
 114                         dev->unsupported_features |= (1ull << VIRTIO_NET_F_MQ);
 115         }
 116
 117         dev->device_features |= dev->frontend_features;
 118
 119         /* umask vhost-user unsupported features */
 120         dev->device_features &= ~(dev->unsupported_features);
 121
 122         dev->features &= dev->device_features;
 123
 124         /* For packed ring, resetting queues is required in reconnection. */
 125         if (vtpci_packed_queue(hw) &&
 126            (old_status & VIRTIO_CONFIG_STATUS_DRIVER_OK)) {
 127                 PMD_INIT_LOG(NOTICE, "Packets on the fly will be dropped"
 128                                 " when packed ring reconnecting.");
 129                 virtio_user_reset_queues_packed(eth_dev);
 130         }
 131
 132         vtpci_set_status(hw, VIRTIO_CONFIG_STATUS_FEATURES_OK);
 133
 134         /* Start the device */
 135         vtpci_set_status(hw, VIRTIO_CONFIG_STATUS_DRIVER_OK);
 136         if (!dev->started)
 137                 return -1;
 138
 139         if (dev->queue_pairs > 1) {
 140                 ret = virtio_user_handle_mq(dev, dev->queue_pairs);
 141                 if (ret != 0) {
 142                         PMD_INIT_LOG(ERR, "Fails to enable multi-queue pairs!");
 143                         return -1;
 144                 }
 145         }
 146         if (eth_dev->data->dev_flags & RTE_ETH_DEV_INTR_LSC) {
 147                 if (rte_intr_disable(eth_dev->intr_handle) < 0) {
 148                         PMD_DRV_LOG(ERR, "interrupt disable failed");
 149                         return -1;
 150                 }
 151                 rte_intr_callback_unregister(eth_dev->intr_handle,
 152                                              virtio_interrupt_handler,
 153                                              eth_dev);
 154                 eth_dev->intr_handle->fd = connectfd;
 155                 rte_intr_callback_register(eth_dev->intr_handle,
 156                                            virtio_interrupt_handler, eth_dev);
 157
 158                 if (rte_intr_enable(eth_dev->intr_handle) < 0) {
 159                         PMD_DRV_LOG(ERR, "interrupt enable failed");
 160                         return -1;
 161                 }
 162         }
 163         PMD_INIT_LOG(NOTICE, "server mode virtio-user reconnection succeeds!");
 164         return 0;
 165 }
 166
 167 static void
 168 virtio_user_delayed_handler(void *param)
 169 {
 170         struct virtio_hw *hw = (struct virtio_hw *)param;
 171         struct rte_eth_dev *eth_dev = &rte_eth_devices[hw->port_id];
 172         struct virtio_user_dev *dev = virtio_user_get_dev(hw);
 173
 174         if (rte_intr_disable(eth_dev->intr_handle) < 0) {
 175                 PMD_DRV_LOG(ERR, "interrupt disable failed");
 176                 return;
 177         }
 178         rte_intr_callback_unregister(eth_dev->intr_handle,
 179                                      virtio_interrupt_handler, eth_dev);
 180         if (dev->is_server) {
 181                 if (dev->vhostfd >= 0) {
 182                         close(dev->vhostfd);
 183                         dev->vhostfd = -1;
 184                         /* Until the featuers are negotiated again, don't assume
 185                          * the backend supports VHOST_USER_PROTOCOL_F_STATUS
 186                          */
 187                         dev->protocol_features &=
 188                                 ~(1ULL << VHOST_USER_PROTOCOL_F_STATUS);
 189                 }
 190                 eth_dev->intr_handle->fd = dev->listenfd;
 191                 rte_intr_callback_register(eth_dev->intr_handle,
 192                                            virtio_interrupt_handler, eth_dev);
 193                 if (rte_intr_enable(eth_dev->intr_handle) < 0) {
 194                         PMD_DRV_LOG(ERR, "interrupt enable failed");
 195                         return;
 196                 }
 197         }
 198 }
 199
 200 static void
 201 virtio_user_read_dev_config(struct virtio_hw *hw, size_t offset,
 202                      void *dst, int length)
 203 {
 204         int i;
 205         struct virtio_user_dev *dev = virtio_user_get_dev(hw);
 206
 207         if (offset == offsetof(struct virtio_net_config, mac) &&
 208             length == RTE_ETHER_ADDR_LEN) {
 209                 for (i = 0; i < RTE_ETHER_ADDR_LEN; ++i)
 210                         ((uint8_t *)dst)[i] = dev->mac_addr[i];
 211                 return;
 212         }
 213
 214         if (offset == offsetof(struct virtio_net_config, status)) {
 215                 char buf[128];
 216
 217                 if (dev->vhostfd >= 0) {
 218                         int r;
 219                         int flags;
 220
 221                         flags = fcntl(dev->vhostfd, F_GETFL);
 222                         if (fcntl(dev->vhostfd, F_SETFL,
 223                                         flags | O_NONBLOCK) == -1) {
 224                                 PMD_DRV_LOG(ERR, "error setting O_NONBLOCK flag");
 225                                 return;
 226                         }
 227                         r = recv(dev->vhostfd, buf, 128, MSG_PEEK);
 228                         if (r == 0 || (r < 0 && errno != EAGAIN)) {
 229                                 dev->net_status &= (~VIRTIO_NET_S_LINK_UP);
 230                                 PMD_DRV_LOG(ERR, "virtio-user port %u is down",
 231                                             hw->port_id);
 232
 233                                 /* This function could be called in the process
 234                                  * of interrupt handling, callback cannot be
 235                                  * unregistered here, set an alarm to do it.
 236                                  */
 237                                 rte_eal_alarm_set(1,
 238                                                   virtio_user_delayed_handler,
 239                                                   (void *)hw);
 240                         } else {
 241                                 dev->net_status |= VIRTIO_NET_S_LINK_UP;
 242                         }
 243                         if (fcntl(dev->vhostfd, F_SETFL,
 244                                         flags & ~O_NONBLOCK) == -1) {
 245                                 PMD_DRV_LOG(ERR, "error clearing O_NONBLOCK flag");
 246                                 return;
 247                         }
 248                 } else if (dev->is_server) {
 249                         dev->net_status &= (~VIRTIO_NET_S_LINK_UP);
 250                         if (virtio_user_server_reconnect(dev) >= 0)
 251                                 dev->net_status |= VIRTIO_NET_S_LINK_UP;
 252                 }
 253
 254                 *(uint16_t *)dst = dev->net_status;
 255         }
 256
 257         if (offset == offsetof(struct virtio_net_config, max_virtqueue_pairs))
 258                 *(uint16_t *)dst = dev->max_queue_pairs;
 259 }
 260
 261 static void
 262 virtio_user_write_dev_config(struct virtio_hw *hw, size_t offset,
 263                       const void *src, int length)
 264 {
 265         int i;
 266         struct virtio_user_dev *dev = virtio_user_get_dev(hw);
 267
 268         if ((offset == offsetof(struct virtio_net_config, mac)) &&
 269             (length == RTE_ETHER_ADDR_LEN))
 270                 for (i = 0; i < RTE_ETHER_ADDR_LEN; ++i)
 271                         dev->mac_addr[i] = ((const uint8_t *)src)[i];
 272         else
 273                 PMD_DRV_LOG(ERR, "not supported offset=%zu, len=%d",
 274                             offset, length);
 275 }
 276
 277 static void
 278 virtio_user_reset(struct virtio_hw *hw)
 279 {
 280         struct virtio_user_dev *dev = virtio_user_get_dev(hw);
 281
 282         if (dev->status & VIRTIO_CONFIG_STATUS_DRIVER_OK)
 283                 virtio_user_stop_device(dev);
 284 }
 285
 286 static void
 287 virtio_user_set_status(struct virtio_hw *hw, uint8_t status)
 288 {
 289         struct virtio_user_dev *dev = virtio_user_get_dev(hw);
 290         uint8_t old_status = dev->status;
 291
 292         if (status & VIRTIO_CONFIG_STATUS_FEATURES_OK &&
 293                         ~old_status & VIRTIO_CONFIG_STATUS_FEATURES_OK)
 294                 virtio_user_dev_set_features(dev);
 295         if (status & VIRTIO_CONFIG_STATUS_DRIVER_OK)
 296                 virtio_user_start_device(dev);
 297         else if (status == VIRTIO_CONFIG_STATUS_RESET)
 298                 virtio_user_reset(hw);
 299
 300         virtio_user_dev_set_status(dev, status);
 301 }
 302
 303 static uint8_t
 304 virtio_user_get_status(struct virtio_hw *hw)
 305 {
 306         struct virtio_user_dev *dev = virtio_user_get_dev(hw);
 307
 308         virtio_user_dev_update_status(dev);
 309
 310         return dev->status;
 311 }
 312
 313 static uint64_t
 314 virtio_user_get_features(struct virtio_hw *hw)
 315 {
 316         struct virtio_user_dev *dev = virtio_user_get_dev(hw);
 317
 318         /* unmask feature bits defined in vhost user protocol */
 319         return dev->device_features & VIRTIO_PMD_SUPPORTED_GUEST_FEATURES;
 320 }
 321
 322 static void
 323 virtio_user_set_features(struct virtio_hw *hw, uint64_t features)
 324 {
 325         struct virtio_user_dev *dev = virtio_user_get_dev(hw);
 326
 327         dev->features = features & dev->device_features;
 328 }
 329
 330 static uint8_t
 331 virtio_user_get_isr(struct virtio_hw *hw __rte_unused)
 332 {
 333         /* rxq interrupts and config interrupt are separated in virtio-user,
 334          * here we only report config change.
 335          */
 336         return VIRTIO_PCI_ISR_CONFIG;
 337 }
 338
 339 static uint16_t
 340 virtio_user_set_config_irq(struct virtio_hw *hw __rte_unused,
 341                     uint16_t vec __rte_unused)
 342 {
 343         return 0;
 344 }
 345
 346 static uint16_t
 347 virtio_user_set_queue_irq(struct virtio_hw *hw __rte_unused,
 348                           struct virtqueue *vq __rte_unused,
 349                           uint16_t vec)
 350 {
 351         /* pretend we have done that */
 352         return vec;
 353 }
 354
 355 /* This function is to get the queue size, aka, number of descs, of a specified
 356  * queue. Different with the VHOST_USER_GET_QUEUE_NUM, which is used to get the
 357  * max supported queues.
 358  */
 359 static uint16_t
 360 virtio_user_get_queue_num(struct virtio_hw *hw, uint16_t queue_id __rte_unused)
 361 {
 362         struct virtio_user_dev *dev = virtio_user_get_dev(hw);
 363
 364         /* Currently, each queue has same queue size */
 365         return dev->queue_size;
 366 }
 367
 368 static void
 369 virtio_user_setup_queue_packed(struct virtqueue *vq,
 370                                struct virtio_user_dev *dev)
 371 {
 372         uint16_t queue_idx = vq->vq_queue_index;
 373         struct vring_packed *vring;
 374         uint64_t desc_addr;
 375         uint64_t avail_addr;
 376         uint64_t used_addr;
 377         uint16_t i;
 378
 379         vring  = &dev->packed_vrings[queue_idx];
 380         desc_addr = (uintptr_t)vq->vq_ring_virt_mem;
 381         avail_addr = desc_addr + vq->vq_nentries *
 382                 sizeof(struct vring_packed_desc);
 383         used_addr = RTE_ALIGN_CEIL(avail_addr +
 384                            sizeof(struct vring_packed_desc_event),
 385                            VIRTIO_PCI_VRING_ALIGN);
 386         vring->num = vq->vq_nentries;
 387         vring->desc = (void *)(uintptr_t)desc_addr;
 388         vring->driver = (void *)(uintptr_t)avail_addr;
 389         vring->device = (void *)(uintptr_t)used_addr;
 390         dev->packed_queues[queue_idx].avail_wrap_counter = true;
 391         dev->packed_queues[queue_idx].used_wrap_counter = true;
 392
 393         for (i = 0; i < vring->num; i++)
 394                 vring->desc[i].flags = 0;
 395 }
 396
 397 static void
 398 virtio_user_setup_queue_split(struct virtqueue *vq, struct virtio_user_dev *dev)
 399 {
 400         uint16_t queue_idx = vq->vq_queue_index;
 401         uint64_t desc_addr, avail_addr, used_addr;
 402
 403         desc_addr = (uintptr_t)vq->vq_ring_virt_mem;
 404         avail_addr = desc_addr + vq->vq_nentries * sizeof(struct vring_desc);
 405         used_addr = RTE_ALIGN_CEIL(avail_addr + offsetof(struct vring_avail,
 406                                                          ring[vq->vq_nentries]),
 407                                    VIRTIO_PCI_VRING_ALIGN);
 408
 409         dev->vrings[queue_idx].num = vq->vq_nentries;
 410         dev->vrings[queue_idx].desc = (void *)(uintptr_t)desc_addr;
 411         dev->vrings[queue_idx].avail = (void *)(uintptr_t)avail_addr;
 412         dev->vrings[queue_idx].used = (void *)(uintptr_t)used_addr;
 413 }
 414
 415 static int
 416 virtio_user_setup_queue(struct virtio_hw *hw, struct virtqueue *vq)
 417 {
 418         struct virtio_user_dev *dev = virtio_user_get_dev(hw);
 419
 420         if (vtpci_packed_queue(hw))
 421                 virtio_user_setup_queue_packed(vq, dev);
 422         else
 423                 virtio_user_setup_queue_split(vq, dev);
 424
 425         return 0;
 426 }
 427
 428 static void
 429 virtio_user_del_queue(struct virtio_hw *hw, struct virtqueue *vq)
 430 {
 431         /* For legacy devices, write 0 to VIRTIO_PCI_QUEUE_PFN port, QEMU
 432          * correspondingly stops the ioeventfds, and reset the status of
 433          * the device.
 434          * For modern devices, set queue desc, avail, used in PCI bar to 0,
 435          * not see any more behavior in QEMU.
 436          *
 437          * Here we just care about what information to deliver to vhost-user
 438          * or vhost-kernel. So we just close ioeventfd for now.
 439          */
 440         struct virtio_user_dev *dev = virtio_user_get_dev(hw);
 441
 442         close(dev->callfds[vq->vq_queue_index]);
 443         close(dev->kickfds[vq->vq_queue_index]);
 444 }
 445
 446 static void
 447 virtio_user_notify_queue(struct virtio_hw *hw, struct virtqueue *vq)
 448 {
 449         uint64_t buf = 1;
 450         struct virtio_user_dev *dev = virtio_user_get_dev(hw);
 451
 452         if (hw->cvq && (hw->cvq->vq == vq)) {
 453                 if (vtpci_packed_queue(vq->hw))
 454                         virtio_user_handle_cq_packed(dev, vq->vq_queue_index);
 455                 else
 456                         virtio_user_handle_cq(dev, vq->vq_queue_index);
 457                 return;
 458         }
 459
 460         if (write(dev->kickfds[vq->vq_queue_index], &buf, sizeof(buf)) < 0)
 461                 PMD_DRV_LOG(ERR, "failed to kick backend: %s",
 462                             strerror(errno));
 463 }
 464
 465 static int
 466 virtio_user_dev_close(struct virtio_hw *hw)
 467 {
 468         struct virtio_user_dev *dev = virtio_user_get_dev(hw);
 469
 470         virtio_user_dev_uninit(dev);
 471
 472         return 0;
 473 }
 474
 475 const struct virtio_pci_ops virtio_user_ops = {
 476         .read_dev_cfg   = virtio_user_read_dev_config,
 477         .write_dev_cfg  = virtio_user_write_dev_config,
 478         .get_status     = virtio_user_get_status,
 479         .set_status     = virtio_user_set_status,
 480         .get_features   = virtio_user_get_features,
 481         .set_features   = virtio_user_set_features,
 482         .get_isr        = virtio_user_get_isr,
 483         .set_config_irq = virtio_user_set_config_irq,
 484         .set_queue_irq  = virtio_user_set_queue_irq,
 485         .get_queue_num  = virtio_user_get_queue_num,
 486         .setup_queue    = virtio_user_setup_queue,
 487         .del_queue      = virtio_user_del_queue,
 488         .notify_queue   = virtio_user_notify_queue,
 489         .dev_close      = virtio_user_dev_close,
 490 };
 491
 492 static const char *valid_args[] = {
 493 #define VIRTIO_USER_ARG_QUEUES_NUM     "queues"
 494         VIRTIO_USER_ARG_QUEUES_NUM,
 495 #define VIRTIO_USER_ARG_CQ_NUM         "cq"
 496         VIRTIO_USER_ARG_CQ_NUM,
 497 #define VIRTIO_USER_ARG_MAC            "mac"
 498         VIRTIO_USER_ARG_MAC,
 499 #define VIRTIO_USER_ARG_PATH           "path"
 500         VIRTIO_USER_ARG_PATH,
 501 #define VIRTIO_USER_ARG_QUEUE_SIZE     "queue_size"
 502         VIRTIO_USER_ARG_QUEUE_SIZE,
 503 #define VIRTIO_USER_ARG_INTERFACE_NAME "iface"
 504         VIRTIO_USER_ARG_INTERFACE_NAME,
 505 #define VIRTIO_USER_ARG_SERVER_MODE    "server"
 506         VIRTIO_USER_ARG_SERVER_MODE,
 507 #define VIRTIO_USER_ARG_MRG_RXBUF      "mrg_rxbuf"
 508         VIRTIO_USER_ARG_MRG_RXBUF,
 509 #define VIRTIO_USER_ARG_IN_ORDER       "in_order"
 510         VIRTIO_USER_ARG_IN_ORDER,
 511 #define VIRTIO_USER_ARG_PACKED_VQ      "packed_vq"
 512         VIRTIO_USER_ARG_PACKED_VQ,
 513 #define VIRTIO_USER_ARG_SPEED          "speed"
 514         VIRTIO_USER_ARG_SPEED,
 515 #define VIRTIO_USER_ARG_VECTORIZED     "vectorized"
 516         VIRTIO_USER_ARG_VECTORIZED,
 517         NULL
 518 };
 519
 520 #define VIRTIO_USER_DEF_CQ_EN   0
 521 #define VIRTIO_USER_DEF_Q_NUM   1
 522 #define VIRTIO_USER_DEF_Q_SZ    256
 523 #define VIRTIO_USER_DEF_SERVER_MODE     0
 524
 525 static int
 526 get_string_arg(const char *key __rte_unused,
 527                const char *value, void *extra_args)
 528 {
 529         if (!value || !extra_args)
 530                 return -EINVAL;
 531
 532         *(char **)extra_args = strdup(value);
 533
 534         if (!*(char **)extra_args)
 535                 return -ENOMEM;
 536
 537         return 0;
 538 }
 539
 540 static int
 541 get_integer_arg(const char *key __rte_unused,
 542                 const char *value, void *extra_args)
 543 {
 544         uint64_t integer = 0;
 545         if (!value || !extra_args)
 546                 return -EINVAL;
 547         errno = 0;
 548         integer = strtoull(value, NULL, 0);
 549         /* extra_args keeps default value, it should be replaced
 550          * only in case of successful parsing of the 'value' arg
 551          */
 552         if (errno == 0)
 553                 *(uint64_t *)extra_args = integer;
 554         return -errno;
 555 }
 556
 557 static uint32_t
 558 vdpa_dynamic_major_num(void)
 559 {
 560         FILE *fp;
 561         char *line = NULL;
 562         size_t size;
 563         char name[11];
 564         bool found = false;
 565         uint32_t num;
 566
 567         fp = fopen("/proc/devices", "r");
 568         if (fp == NULL) {
 569                 PMD_INIT_LOG(ERR, "Cannot open /proc/devices: %s",
 570                              strerror(errno));
 571                 return UNNAMED_MAJOR;
 572         }
 573
 574         while (getline(&line, &size, fp) > 0) {
 575                 char *stripped = line + strspn(line, " ");
 576                 if ((sscanf(stripped, "%u %10s", &num, name) == 2) &&
 577                     (strncmp(name, "vhost-vdpa", 10) == 0)) {
 578                         found = true;
 579                         break;
 580                 }
 581         }
 582         fclose(fp);
 583         return found ? num : UNNAMED_MAJOR;
 584 }
 585
 586 static enum virtio_user_backend_type
 587 virtio_user_backend_type(const char *path)
 588 {
 589         struct stat sb;
 590
 591         if (stat(path, &sb) == -1) {
 592                 if (errno == ENOENT)
 593                         return VIRTIO_USER_BACKEND_VHOST_USER;
 594
 595                 PMD_INIT_LOG(ERR, "Stat fails: %s (%s)\n", path,
 596                              strerror(errno));
 597                 return VIRTIO_USER_BACKEND_UNKNOWN;
 598         }
 599
 600         if (S_ISSOCK(sb.st_mode)) {
 601                 return VIRTIO_USER_BACKEND_VHOST_USER;
 602         } else if (S_ISCHR(sb.st_mode)) {
 603                 if (major(sb.st_rdev) == MISC_MAJOR)
 604                         return VIRTIO_USER_BACKEND_VHOST_KERNEL;
 605                 if (major(sb.st_rdev) == vdpa_dynamic_major_num())
 606                         return VIRTIO_USER_BACKEND_VHOST_VDPA;
 607         }
 608         return VIRTIO_USER_BACKEND_UNKNOWN;
 609 }
 610
 611 static struct rte_eth_dev *
 612 virtio_user_eth_dev_alloc(struct rte_vdev_device *vdev)
 613 {
 614         struct rte_eth_dev *eth_dev;
 615         struct rte_eth_dev_data *data;
 616         struct virtio_hw *hw;
 617         struct virtio_user_dev *dev;
 618
 619         eth_dev = rte_eth_vdev_allocate(vdev, sizeof(*dev));
 620         if (!eth_dev) {
 621                 PMD_INIT_LOG(ERR, "cannot alloc rte_eth_dev");
 622                 return NULL;
 623         }
 624
 625         data = eth_dev->data;
 626         dev = eth_dev->data->dev_private;
 627         hw = &dev->hw;
 628
 629         hw->port_id = data->port_id;
 630         dev->port_id = data->port_id;
 631         virtio_hw_internal[hw->port_id].vtpci_ops = &virtio_user_ops;
 632         /*
 633          * MSIX is required to enable LSC (see virtio_init_device).
 634          * Here just pretend that we support msix.
 635          */
 636         hw->use_msix = 1;
 637         hw->bus_type = VIRTIO_BUS_USER;
 638         hw->use_vec_rx = 0;
 639         hw->use_vec_tx = 0;
 640         hw->use_inorder_rx = 0;
 641         hw->use_inorder_tx = 0;
 642
 643         return eth_dev;
 644 }
 645
 646 static void
 647 virtio_user_eth_dev_free(struct rte_eth_dev *eth_dev)
 648 {
 649         rte_eth_dev_release_port(eth_dev);
 650 }
 651
 652 /* Dev initialization routine. Invoked once for each virtio vdev at
 653  * EAL init time, see rte_bus_probe().
 654  * Returns 0 on success.
 655  */
 656 static int
 657 virtio_user_pmd_probe(struct rte_vdev_device *vdev)
 658 {
 659         struct rte_kvargs *kvlist = NULL;
 660         struct rte_eth_dev *eth_dev;
 661         struct virtio_hw *hw;
 662         struct virtio_user_dev *dev;
 663         enum virtio_user_backend_type backend_type = VIRTIO_USER_BACKEND_UNKNOWN;
 664         uint64_t queues = VIRTIO_USER_DEF_Q_NUM;
 665         uint64_t cq = VIRTIO_USER_DEF_CQ_EN;
 666         uint64_t queue_size = VIRTIO_USER_DEF_Q_SZ;
 667         uint64_t server_mode = VIRTIO_USER_DEF_SERVER_MODE;
 668         uint64_t mrg_rxbuf = 1;
 669         uint64_t in_order = 1;
 670         uint64_t packed_vq = 0;
 671         uint64_t vectorized = 0;
 672         char *path = NULL;
 673         char *ifname = NULL;
 674         char *mac_addr = NULL;
 675         int ret = -1;
 676
 677         RTE_BUILD_BUG_ON(offsetof(struct virtio_user_dev, hw) != 0);
 678
 679         if (rte_eal_process_type() == RTE_PROC_SECONDARY) {
 680                 const char *name = rte_vdev_device_name(vdev);
 681                 eth_dev = rte_eth_dev_attach_secondary(name);
 682                 if (!eth_dev) {
 683                         PMD_INIT_LOG(ERR, "Failed to probe %s", name);
 684                         return -1;
 685                 }
 686
 687                 if (eth_virtio_dev_init(eth_dev) < 0) {
 688                         PMD_INIT_LOG(ERR, "eth_virtio_dev_init fails");
 689                         rte_eth_dev_release_port(eth_dev);
 690                         return -1;
 691                 }
 692
 693                 eth_dev->dev_ops = &virtio_user_secondary_eth_dev_ops;
 694                 eth_dev->device = &vdev->device;
 695                 rte_eth_dev_probing_finish(eth_dev);
 696                 return 0;
 697         }
 698
 699         kvlist = rte_kvargs_parse(rte_vdev_device_args(vdev), valid_args);
 700         if (!kvlist) {
 701                 PMD_INIT_LOG(ERR, "error when parsing param");
 702                 goto end;
 703         }
 704
 705         if (rte_kvargs_count(kvlist, VIRTIO_USER_ARG_PATH) == 1) {
 706                 if (rte_kvargs_process(kvlist, VIRTIO_USER_ARG_PATH,
 707                                        &get_string_arg, &path) < 0) {
 708                         PMD_INIT_LOG(ERR, "error to parse %s",
 709                                      VIRTIO_USER_ARG_PATH);
 710                         goto end;
 711                 }
 712         } else {
 713                 PMD_INIT_LOG(ERR, "arg %s is mandatory for virtio_user",
 714                              VIRTIO_USER_ARG_PATH);
 715                 goto end;
 716         }
 717
 718         backend_type = virtio_user_backend_type(path);
 719         if (backend_type == VIRTIO_USER_BACKEND_UNKNOWN) {
 720                 PMD_INIT_LOG(ERR,
 721                              "unable to determine backend type for path %s",
 722                         path);
 723                 goto end;
 724         }
 725         PMD_INIT_LOG(INFO, "Backend type detected: %s",
 726                      virtio_user_backend_strings[backend_type]);
 727
 728         if (rte_kvargs_count(kvlist, VIRTIO_USER_ARG_INTERFACE_NAME) == 1) {
 729                 if (backend_type != VIRTIO_USER_BACKEND_VHOST_KERNEL) {
 730                         PMD_INIT_LOG(ERR,
 731                                 "arg %s applies only to vhost-kernel backend",
 732                                 VIRTIO_USER_ARG_INTERFACE_NAME);
 733                         goto end;
 734                 }
 735
 736                 if (rte_kvargs_process(kvlist, VIRTIO_USER_ARG_INTERFACE_NAME,
 737                                        &get_string_arg, &ifname) < 0) {
 738                         PMD_INIT_LOG(ERR, "error to parse %s",
 739                                      VIRTIO_USER_ARG_INTERFACE_NAME);
 740                         goto end;
 741                 }
 742         }
 743
 744         if (rte_kvargs_count(kvlist, VIRTIO_USER_ARG_MAC) == 1) {
 745                 if (rte_kvargs_process(kvlist, VIRTIO_USER_ARG_MAC,
 746                                        &get_string_arg, &mac_addr) < 0) {
 747                         PMD_INIT_LOG(ERR, "error to parse %s",
 748                                      VIRTIO_USER_ARG_MAC);
 749                         goto end;
 750                 }
 751         }
 752
 753         if (rte_kvargs_count(kvlist, VIRTIO_USER_ARG_QUEUE_SIZE) == 1) {
 754                 if (rte_kvargs_process(kvlist, VIRTIO_USER_ARG_QUEUE_SIZE,
 755                                        &get_integer_arg, &queue_size) < 0) {
 756                         PMD_INIT_LOG(ERR, "error to parse %s",
 757                                      VIRTIO_USER_ARG_QUEUE_SIZE);
 758                         goto end;
 759                 }
 760         }
 761
 762         if (rte_kvargs_count(kvlist, VIRTIO_USER_ARG_QUEUES_NUM) == 1) {
 763                 if (rte_kvargs_process(kvlist, VIRTIO_USER_ARG_QUEUES_NUM,
 764                                        &get_integer_arg, &queues) < 0) {
 765                         PMD_INIT_LOG(ERR, "error to parse %s",
 766                                      VIRTIO_USER_ARG_QUEUES_NUM);
 767                         goto end;
 768                 }
 769         }
 770
 771         if (rte_kvargs_count(kvlist, VIRTIO_USER_ARG_SERVER_MODE) == 1) {
 772                 if (rte_kvargs_process(kvlist, VIRTIO_USER_ARG_SERVER_MODE,
 773                                        &get_integer_arg, &server_mode) < 0) {
 774                         PMD_INIT_LOG(ERR, "error to parse %s",
 775                                      VIRTIO_USER_ARG_SERVER_MODE);
 776                         goto end;
 777                 }
 778         }
 779
 780         if (rte_kvargs_count(kvlist, VIRTIO_USER_ARG_CQ_NUM) == 1) {
 781                 if (rte_kvargs_process(kvlist, VIRTIO_USER_ARG_CQ_NUM,
 782                                        &get_integer_arg, &cq) < 0) {
 783                         PMD_INIT_LOG(ERR, "error to parse %s",
 784                                      VIRTIO_USER_ARG_CQ_NUM);
 785                         goto end;
 786                 }
 787         } else if (queues > 1) {
 788                 cq = 1;
 789         }
 790
 791         if (rte_kvargs_count(kvlist, VIRTIO_USER_ARG_PACKED_VQ) == 1) {
 792                 if (rte_kvargs_process(kvlist, VIRTIO_USER_ARG_PACKED_VQ,
 793                                        &get_integer_arg, &packed_vq) < 0) {
 794                         PMD_INIT_LOG(ERR, "error to parse %s",
 795                                      VIRTIO_USER_ARG_PACKED_VQ);
 796                         goto end;
 797                 }
 798         }
 799
 800         if (rte_kvargs_count(kvlist, VIRTIO_USER_ARG_VECTORIZED) == 1) {
 801                 if (rte_kvargs_process(kvlist, VIRTIO_USER_ARG_VECTORIZED,
 802                                        &get_integer_arg, &vectorized) < 0) {
 803                         PMD_INIT_LOG(ERR, "error to parse %s",
 804                                      VIRTIO_USER_ARG_VECTORIZED);
 805                         goto end;
 806                 }
 807         }
 808
 809         if (queues > 1 && cq == 0) {
 810                 PMD_INIT_LOG(ERR, "multi-q requires ctrl-q");
 811                 goto end;
 812         }
 813
 814         if (queues > VIRTIO_MAX_VIRTQUEUE_PAIRS) {
 815                 PMD_INIT_LOG(ERR, "arg %s %" PRIu64 " exceeds the limit %u",
 816                         VIRTIO_USER_ARG_QUEUES_NUM, queues,
 817                         VIRTIO_MAX_VIRTQUEUE_PAIRS);
 818                 goto end;
 819         }
 820
 821         if (rte_kvargs_count(kvlist, VIRTIO_USER_ARG_MRG_RXBUF) == 1) {
 822                 if (rte_kvargs_process(kvlist, VIRTIO_USER_ARG_MRG_RXBUF,
 823                                        &get_integer_arg, &mrg_rxbuf) < 0) {
 824                         PMD_INIT_LOG(ERR, "error to parse %s",
 825                                      VIRTIO_USER_ARG_MRG_RXBUF);
 826                         goto end;
 827                 }
 828         }
 829
 830         if (rte_kvargs_count(kvlist, VIRTIO_USER_ARG_IN_ORDER) == 1) {
 831                 if (rte_kvargs_process(kvlist, VIRTIO_USER_ARG_IN_ORDER,
 832                                        &get_integer_arg, &in_order) < 0) {
 833                         PMD_INIT_LOG(ERR, "error to parse %s",
 834                                      VIRTIO_USER_ARG_IN_ORDER);
 835                         goto end;
 836                 }
 837         }
 838
 839         eth_dev = virtio_user_eth_dev_alloc(vdev);
 840         if (!eth_dev) {
 841                 PMD_INIT_LOG(ERR, "virtio_user fails to alloc device");
 842                 goto end;
 843         }
 844
 845         dev = eth_dev->data->dev_private;
 846         hw = &dev->hw;
 847         if (virtio_user_dev_init(dev, path, queues, cq,
 848                          queue_size, mac_addr, &ifname, server_mode,
 849                          mrg_rxbuf, in_order, packed_vq, backend_type) < 0) {
 850                 PMD_INIT_LOG(ERR, "virtio_user_dev_init fails");
 851                 virtio_user_eth_dev_free(eth_dev);
 852                 goto end;
 853         }
 854
 855         /* previously called by pci probing for physical dev */
 856         if (eth_virtio_dev_init(eth_dev) < 0) {
 857                 PMD_INIT_LOG(ERR, "eth_virtio_dev_init fails");
 858                 virtio_user_eth_dev_free(eth_dev);
 859                 goto end;
 860         }
 861
 862         if (vectorized) {
 863                 if (packed_vq) {
 864 #if defined(CC_AVX512_SUPPORT) || defined(RTE_ARCH_ARM)
 865                         hw->use_vec_rx = 1;
 866                         hw->use_vec_tx = 1;
 867 #else
 868                         PMD_INIT_LOG(INFO,
 869                                 "building environment do not support packed ring vectorized");
 870 #endif
 871                 } else {
 872                         hw->use_vec_rx = 1;
 873                 }
 874         }
 875
 876         rte_eth_dev_probing_finish(eth_dev);
 877         ret = 0;
 878
 879 end:
 880         if (kvlist)
 881                 rte_kvargs_free(kvlist);
 882         if (path)
 883                 free(path);
 884         if (mac_addr)
 885                 free(mac_addr);
 886         if (ifname)
 887                 free(ifname);
 888         return ret;
 889 }
 890
 891 static int
 892 virtio_user_pmd_remove(struct rte_vdev_device *vdev)
 893 {
 894         const char *name;
 895         struct rte_eth_dev *eth_dev;
 896
 897         if (!vdev)
 898                 return -EINVAL;
 899
 900         name = rte_vdev_device_name(vdev);
 901         PMD_DRV_LOG(INFO, "Un-Initializing %s", name);
 902         eth_dev = rte_eth_dev_allocated(name);
 903         /* Port has already been released by close. */
 904         if (!eth_dev)
 905                 return 0;
 906
 907         if (rte_eal_process_type() != RTE_PROC_PRIMARY)
 908                 return rte_eth_dev_release_port(eth_dev);
 909
 910         /* make sure the device is stopped, queues freed */
 911         return rte_eth_dev_close(eth_dev->data->port_id);
 912 }
 913
 914 static int virtio_user_pmd_dma_map(struct rte_vdev_device *vdev, void *addr,
 915                 uint64_t iova, size_t len)
 916 {
 917         const char *name;
 918         struct rte_eth_dev *eth_dev;
 919         struct virtio_user_dev *dev;
 920
 921         if (!vdev)
 922                 return -EINVAL;
 923
 924         name = rte_vdev_device_name(vdev);
 925         eth_dev = rte_eth_dev_allocated(name);
 926         /* Port has already been released by close. */
 927         if (!eth_dev)
 928                 return 0;
 929
 930         dev = eth_dev->data->dev_private;
 931
 932         if (dev->ops->dma_map)
 933                 return dev->ops->dma_map(dev, addr, iova, len);
 934
 935         return 0;
 936 }
 937
 938 static int virtio_user_pmd_dma_unmap(struct rte_vdev_device *vdev, void *addr,
 939                 uint64_t iova, size_t len)
 940 {
 941         const char *name;
 942         struct rte_eth_dev *eth_dev;
 943         struct virtio_user_dev *dev;
 944
 945         if (!vdev)
 946                 return -EINVAL;
 947
 948         name = rte_vdev_device_name(vdev);
 949         eth_dev = rte_eth_dev_allocated(name);
 950         /* Port has already been released by close. */
 951         if (!eth_dev)
 952                 return 0;
 953
 954         dev = eth_dev->data->dev_private;
 955
 956         if (dev->ops->dma_unmap)
 957                 return dev->ops->dma_unmap(dev, addr, iova, len);
 958
 959         return 0;
 960 }
 961
 962 static struct rte_vdev_driver virtio_user_driver = {
 963         .probe = virtio_user_pmd_probe,
 964         .remove = virtio_user_pmd_remove,
 965         .dma_map = virtio_user_pmd_dma_map,
 966         .dma_unmap = virtio_user_pmd_dma_unmap,
 967         .drv_flags = RTE_VDEV_DRV_NEED_IOVA_AS_VA,
 968 };
 969
 970 RTE_PMD_REGISTER_VDEV(net_virtio_user, virtio_user_driver);
 971 RTE_PMD_REGISTER_ALIAS(net_virtio_user, virtio_user);
 972 RTE_PMD_REGISTER_PARAM_STRING(net_virtio_user,
 973         "path=<path> "
 974         "mac=<mac addr> "
 975         "cq=<int> "
 976         "queue_size=<int> "
 977         "queues=<int> "
 978         "iface=<string> "
 979         "server=<0|1> "
 980         "mrg_rxbuf=<0|1> "
 981         "in_order=<0|1> "
 982         "packed_vq=<0|1> "
 983         "speed=<int> "
 984         "vectorized=<0|1>");