app/test/virtual_pmd.c

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(c) 2010-2014 Intel Corporation
   3  */
   4
   5 #include <rte_mbuf.h>
   6 #include <rte_ethdev.h>
   7 #include <rte_ethdev_driver.h>
   8 #include <rte_pci.h>
   9 #include <rte_bus_pci.h>
  10 #include <rte_malloc.h>
  11 #include <rte_memcpy.h>
  12 #include <rte_memory.h>
  13 #include <rte_ring.h>
  14
  15 #include "virtual_pmd.h"
  16
  17 #define MAX_PKT_BURST 512
  18
  19 static const char *virtual_ethdev_driver_name = "Virtual PMD";
  20
  21 struct virtual_ethdev_private {
  22         struct eth_dev_ops dev_ops;
  23         struct rte_eth_stats eth_stats;
  24
  25         struct rte_ring *rx_queue;
  26         struct rte_ring *tx_queue;
  27
  28         int tx_burst_fail_count;
  29 };
  30
  31 struct virtual_ethdev_queue {
  32         int port_id;
  33         int queue_id;
  34 };
  35
  36 static int
  37 virtual_ethdev_start_success(struct rte_eth_dev *eth_dev __rte_unused)
  38 {
  39         eth_dev->data->dev_started = 1;
  40
  41         return 0;
  42 }
  43
  44 static int
  45 virtual_ethdev_start_fail(struct rte_eth_dev *eth_dev __rte_unused)
  46 {
  47         eth_dev->data->dev_started = 0;
  48
  49         return -1;
  50 }
  51 static void  virtual_ethdev_stop(struct rte_eth_dev *eth_dev __rte_unused)
  52 {
  53         void *pkt = NULL;
  54         struct virtual_ethdev_private *prv = eth_dev->data->dev_private;
  55
  56         eth_dev->data->dev_link.link_status = ETH_LINK_DOWN;
  57         eth_dev->data->dev_started = 0;
  58         while (rte_ring_dequeue(prv->rx_queue, &pkt) != -ENOENT)
  59                 rte_pktmbuf_free(pkt);
  60
  61         while (rte_ring_dequeue(prv->tx_queue, &pkt) != -ENOENT)
  62                 rte_pktmbuf_free(pkt);
  63 }
  64
  65 static void
  66 virtual_ethdev_close(struct rte_eth_dev *dev __rte_unused)
  67 {}
  68
  69 static int
  70 virtual_ethdev_configure_success(struct rte_eth_dev *dev __rte_unused)
  71 {
  72         return 0;
  73 }
  74
  75 static int
  76 virtual_ethdev_configure_fail(struct rte_eth_dev *dev __rte_unused)
  77 {
  78         return -1;
  79 }
  80
  81 static int
  82 virtual_ethdev_info_get(struct rte_eth_dev *dev __rte_unused,
  83                 struct rte_eth_dev_info *dev_info)
  84 {
  85         dev_info->driver_name = virtual_ethdev_driver_name;
  86         dev_info->max_mac_addrs = 1;
  87
  88         dev_info->max_rx_pktlen = (uint32_t)2048;
  89
  90         dev_info->max_rx_queues = (uint16_t)128;
  91         dev_info->max_tx_queues = (uint16_t)512;
  92
  93         dev_info->min_rx_bufsize = 0;
  94
  95         return 0;
  96 }
  97
  98 static int
  99 virtual_ethdev_rx_queue_setup_success(struct rte_eth_dev *dev,
 100                 uint16_t rx_queue_id, uint16_t nb_rx_desc __rte_unused,
 101                 unsigned int socket_id,
 102                 const struct rte_eth_rxconf *rx_conf __rte_unused,
 103                 struct rte_mempool *mb_pool __rte_unused)
 104 {
 105         struct virtual_ethdev_queue *rx_q;
 106
 107         rx_q = (struct virtual_ethdev_queue *)rte_zmalloc_socket(NULL,
 108                         sizeof(struct virtual_ethdev_queue), 0, socket_id);
 109
 110         if (rx_q == NULL)
 111                 return -1;
 112
 113         rx_q->port_id = dev->data->port_id;
 114         rx_q->queue_id = rx_queue_id;
 115
 116         dev->data->rx_queues[rx_queue_id] = rx_q;
 117
 118         return 0;
 119 }
 120
 121 static int
 122 virtual_ethdev_rx_queue_setup_fail(struct rte_eth_dev *dev __rte_unused,
 123                 uint16_t rx_queue_id __rte_unused, uint16_t nb_rx_desc __rte_unused,
 124                 unsigned int socket_id __rte_unused,
 125                 const struct rte_eth_rxconf *rx_conf __rte_unused,
 126                 struct rte_mempool *mb_pool __rte_unused)
 127 {
 128         return -1;
 129 }
 130
 131 static int
 132 virtual_ethdev_tx_queue_setup_success(struct rte_eth_dev *dev,
 133                 uint16_t tx_queue_id, uint16_t nb_tx_desc __rte_unused,
 134                 unsigned int socket_id,
 135                 const struct rte_eth_txconf *tx_conf __rte_unused)
 136 {
 137         struct virtual_ethdev_queue *tx_q;
 138
 139         tx_q = (struct virtual_ethdev_queue *)rte_zmalloc_socket(NULL,
 140                         sizeof(struct virtual_ethdev_queue), 0, socket_id);
 141
 142         if (tx_q == NULL)
 143                 return -1;
 144
 145         tx_q->port_id = dev->data->port_id;
 146         tx_q->queue_id = tx_queue_id;
 147
 148         dev->data->tx_queues[tx_queue_id] = tx_q;
 149
 150         return 0;
 151 }
 152
 153 static int
 154 virtual_ethdev_tx_queue_setup_fail(struct rte_eth_dev *dev __rte_unused,
 155                 uint16_t tx_queue_id __rte_unused, uint16_t nb_tx_desc __rte_unused,
 156                 unsigned int socket_id __rte_unused,
 157                 const struct rte_eth_txconf *tx_conf __rte_unused)
 158 {
 159         return -1;
 160 }
 161
 162 static void
 163 virtual_ethdev_rx_queue_release(void *q __rte_unused)
 164 {
 165 }
 166
 167 static void
 168 virtual_ethdev_tx_queue_release(void *q __rte_unused)
 169 {
 170 }
 171
 172 static int
 173 virtual_ethdev_link_update_success(struct rte_eth_dev *bonded_eth_dev,
 174                 int wait_to_complete __rte_unused)
 175 {
 176         if (!bonded_eth_dev->data->dev_started)
 177                 bonded_eth_dev->data->dev_link.link_status = ETH_LINK_DOWN;
 178
 179         return 0;
 180 }
 181
 182 static int
 183 virtual_ethdev_link_update_fail(struct rte_eth_dev *bonded_eth_dev __rte_unused,
 184                 int wait_to_complete __rte_unused)
 185 {
 186         return -1;
 187 }
 188
 189 static int
 190 virtual_ethdev_stats_get(struct rte_eth_dev *dev, struct rte_eth_stats *stats)
 191 {
 192         struct virtual_ethdev_private *dev_private = dev->data->dev_private;
 193
 194         if (stats)
 195                 rte_memcpy(stats, &dev_private->eth_stats, sizeof(*stats));
 196
 197         return 0;
 198 }
 199
 200 static void
 201 virtual_ethdev_stats_reset(struct rte_eth_dev *dev)
 202 {
 203         struct virtual_ethdev_private *dev_private = dev->data->dev_private;
 204         void *pkt = NULL;
 205
 206         while (rte_ring_dequeue(dev_private->tx_queue, &pkt) == -ENOBUFS)
 207                         rte_pktmbuf_free(pkt);
 208
 209         /* Reset internal statistics */
 210         memset(&dev_private->eth_stats, 0, sizeof(dev_private->eth_stats));
 211 }
 212
 213 static void
 214 virtual_ethdev_promiscuous_mode_enable(struct rte_eth_dev *dev __rte_unused)
 215 {}
 216
 217 static void
 218 virtual_ethdev_promiscuous_mode_disable(struct rte_eth_dev *dev __rte_unused)
 219 {}
 220
 221 static int
 222 virtual_ethdev_mac_address_set(__rte_unused struct rte_eth_dev *dev,
 223                                __rte_unused struct rte_ether_addr *addr)
 224 {
 225         return 0;
 226 }
 227
 228 static const struct eth_dev_ops virtual_ethdev_default_dev_ops = {
 229         .dev_configure = virtual_ethdev_configure_success,
 230         .dev_start = virtual_ethdev_start_success,
 231         .dev_stop = virtual_ethdev_stop,
 232         .dev_close = virtual_ethdev_close,
 233         .dev_infos_get = virtual_ethdev_info_get,
 234         .rx_queue_setup = virtual_ethdev_rx_queue_setup_success,
 235         .tx_queue_setup = virtual_ethdev_tx_queue_setup_success,
 236         .rx_queue_release = virtual_ethdev_rx_queue_release,
 237         .tx_queue_release = virtual_ethdev_tx_queue_release,
 238         .link_update = virtual_ethdev_link_update_success,
 239         .mac_addr_set = virtual_ethdev_mac_address_set,
 240         .stats_get = virtual_ethdev_stats_get,
 241         .stats_reset = virtual_ethdev_stats_reset,
 242         .promiscuous_enable = virtual_ethdev_promiscuous_mode_enable,
 243         .promiscuous_disable = virtual_ethdev_promiscuous_mode_disable
 244 };
 245
 246 void
 247 virtual_ethdev_start_fn_set_success(uint16_t port_id, uint8_t success)
 248 {
 249         struct rte_eth_dev *dev = &rte_eth_devices[port_id];
 250         struct virtual_ethdev_private *dev_private = dev->data->dev_private;
 251         struct eth_dev_ops *dev_ops = &dev_private->dev_ops;
 252
 253         if (success)
 254                 dev_ops->dev_start = virtual_ethdev_start_success;
 255         else
 256                 dev_ops->dev_start = virtual_ethdev_start_fail;
 257
 258 }
 259
 260 void
 261 virtual_ethdev_configure_fn_set_success(uint16_t port_id, uint8_t success)
 262 {
 263         struct rte_eth_dev *dev = &rte_eth_devices[port_id];
 264         struct virtual_ethdev_private *dev_private = dev->data->dev_private;
 265         struct eth_dev_ops *dev_ops = &dev_private->dev_ops;
 266
 267         if (success)
 268                 dev_ops->dev_configure = virtual_ethdev_configure_success;
 269         else
 270                 dev_ops->dev_configure = virtual_ethdev_configure_fail;
 271 }
 272
 273 void
 274 virtual_ethdev_rx_queue_setup_fn_set_success(uint16_t port_id, uint8_t success)
 275 {
 276         struct rte_eth_dev *dev = &rte_eth_devices[port_id];
 277         struct virtual_ethdev_private *dev_private = dev->data->dev_private;
 278         struct eth_dev_ops *dev_ops = &dev_private->dev_ops;
 279
 280         if (success)
 281                 dev_ops->rx_queue_setup = virtual_ethdev_rx_queue_setup_success;
 282         else
 283                 dev_ops->rx_queue_setup = virtual_ethdev_rx_queue_setup_fail;
 284 }
 285
 286 void
 287 virtual_ethdev_tx_queue_setup_fn_set_success(uint16_t port_id, uint8_t success)
 288 {
 289         struct rte_eth_dev *dev = &rte_eth_devices[port_id];
 290         struct virtual_ethdev_private *dev_private = dev->data->dev_private;
 291         struct eth_dev_ops *dev_ops = &dev_private->dev_ops;
 292
 293         if (success)
 294                 dev_ops->tx_queue_setup = virtual_ethdev_tx_queue_setup_success;
 295         else
 296                 dev_ops->tx_queue_setup = virtual_ethdev_tx_queue_setup_fail;
 297 }
 298
 299 void
 300 virtual_ethdev_link_update_fn_set_success(uint16_t port_id, uint8_t success)
 301 {
 302         struct rte_eth_dev *dev = &rte_eth_devices[port_id];
 303         struct virtual_ethdev_private *dev_private = dev->data->dev_private;
 304         struct eth_dev_ops *dev_ops = &dev_private->dev_ops;
 305
 306         if (success)
 307                 dev_ops->link_update = virtual_ethdev_link_update_success;
 308         else
 309                 dev_ops->link_update = virtual_ethdev_link_update_fail;
 310 }
 311
 312
 313 static uint16_t
 314 virtual_ethdev_rx_burst_success(void *queue __rte_unused,
 315                                                          struct rte_mbuf **bufs,
 316                                                          uint16_t nb_pkts)
 317 {
 318         struct rte_eth_dev *vrtl_eth_dev;
 319         struct virtual_ethdev_queue *pq_map;
 320         struct virtual_ethdev_private *dev_private;
 321
 322         int rx_count, i;
 323
 324         pq_map = (struct virtual_ethdev_queue *)queue;
 325         vrtl_eth_dev = &rte_eth_devices[pq_map->port_id];
 326         dev_private = vrtl_eth_dev->data->dev_private;
 327
 328         rx_count = rte_ring_dequeue_burst(dev_private->rx_queue, (void **) bufs,
 329                         nb_pkts, NULL);
 330
 331         /* increments ipackets count */
 332         dev_private->eth_stats.ipackets += rx_count;
 333
 334         /* increments ibytes count */
 335         for (i = 0; i < rx_count; i++)
 336                 dev_private->eth_stats.ibytes += rte_pktmbuf_pkt_len(bufs[i]);
 337
 338         return rx_count;
 339 }
 340
 341 static uint16_t
 342 virtual_ethdev_rx_burst_fail(void *queue __rte_unused,
 343                                                          struct rte_mbuf **bufs __rte_unused,
 344                                                          uint16_t nb_pkts __rte_unused)
 345 {
 346         return 0;
 347 }
 348
 349 static uint16_t
 350 virtual_ethdev_tx_burst_success(void *queue, struct rte_mbuf **bufs,
 351                 uint16_t nb_pkts)
 352 {
 353         struct virtual_ethdev_queue *tx_q = queue;
 354
 355         struct rte_eth_dev *vrtl_eth_dev;
 356         struct virtual_ethdev_private *dev_private;
 357
 358         int i;
 359
 360         vrtl_eth_dev = &rte_eth_devices[tx_q->port_id];
 361         dev_private = vrtl_eth_dev->data->dev_private;
 362
 363         if (!vrtl_eth_dev->data->dev_link.link_status)
 364                 nb_pkts = 0;
 365         else
 366                 nb_pkts = rte_ring_enqueue_burst(dev_private->tx_queue, (void **)bufs,
 367                                 nb_pkts, NULL);
 368
 369         /* increment opacket count */
 370         dev_private->eth_stats.opackets += nb_pkts;
 371
 372         /* increment obytes count */
 373         for (i = 0; i < nb_pkts; i++)
 374                 dev_private->eth_stats.obytes += rte_pktmbuf_pkt_len(bufs[i]);
 375
 376         return nb_pkts;
 377 }
 378
 379 static uint16_t
 380 virtual_ethdev_tx_burst_fail(void *queue, struct rte_mbuf **bufs,
 381                 uint16_t nb_pkts)
 382 {
 383         struct rte_eth_dev *vrtl_eth_dev = NULL;
 384         struct virtual_ethdev_queue *tx_q = NULL;
 385         struct virtual_ethdev_private *dev_private = NULL;
 386
 387         int i;
 388
 389         tx_q = queue;
 390         vrtl_eth_dev = &rte_eth_devices[tx_q->port_id];
 391         dev_private = vrtl_eth_dev->data->dev_private;
 392
 393         if (dev_private->tx_burst_fail_count < nb_pkts) {
 394                 int successfully_txd = nb_pkts - dev_private->tx_burst_fail_count;
 395
 396                 /* increment opacket count */
 397                 dev_private->eth_stats.opackets += successfully_txd;
 398
 399                 /* free packets in burst */
 400                 for (i = 0; i < successfully_txd; i++) {
 401                         /* free packets in burst */
 402                         if (bufs[i] != NULL)
 403                                 rte_pktmbuf_free(bufs[i]);
 404
 405                         bufs[i] = NULL;
 406                 }
 407
 408                 return successfully_txd;
 409         }
 410
 411         return 0;
 412 }
 413
 414
 415 void
 416 virtual_ethdev_rx_burst_fn_set_success(uint16_t port_id, uint8_t success)
 417 {
 418         struct rte_eth_dev *vrtl_eth_dev = &rte_eth_devices[port_id];
 419
 420         if (success)
 421                 vrtl_eth_dev->rx_pkt_burst = virtual_ethdev_rx_burst_success;
 422         else
 423                 vrtl_eth_dev->rx_pkt_burst = virtual_ethdev_rx_burst_fail;
 424 }
 425
 426
 427 void
 428 virtual_ethdev_tx_burst_fn_set_success(uint16_t port_id, uint8_t success)
 429 {
 430         struct virtual_ethdev_private *dev_private = NULL;
 431         struct rte_eth_dev *vrtl_eth_dev = &rte_eth_devices[port_id];
 432
 433         dev_private = vrtl_eth_dev->data->dev_private;
 434
 435         if (success)
 436                 vrtl_eth_dev->tx_pkt_burst = virtual_ethdev_tx_burst_success;
 437         else
 438                 vrtl_eth_dev->tx_pkt_burst = virtual_ethdev_tx_burst_fail;
 439
 440         dev_private->tx_burst_fail_count = 0;
 441 }
 442
 443 void
 444 virtual_ethdev_tx_burst_fn_set_tx_pkt_fail_count(uint16_t port_id,
 445                 uint8_t packet_fail_count)
 446 {
 447         struct virtual_ethdev_private *dev_private = NULL;
 448         struct rte_eth_dev *vrtl_eth_dev = &rte_eth_devices[port_id];
 449
 450
 451         dev_private = vrtl_eth_dev->data->dev_private;
 452         dev_private->tx_burst_fail_count = packet_fail_count;
 453 }
 454
 455 void
 456 virtual_ethdev_set_link_status(uint16_t port_id, uint8_t link_status)
 457 {
 458         struct rte_eth_dev *vrtl_eth_dev = &rte_eth_devices[port_id];
 459
 460         vrtl_eth_dev->data->dev_link.link_status = link_status;
 461 }
 462
 463 void
 464 virtual_ethdev_simulate_link_status_interrupt(uint16_t port_id,
 465                 uint8_t link_status)
 466 {
 467         struct rte_eth_dev *vrtl_eth_dev = &rte_eth_devices[port_id];
 468
 469         vrtl_eth_dev->data->dev_link.link_status = link_status;
 470
 471         _rte_eth_dev_callback_process(vrtl_eth_dev, RTE_ETH_EVENT_INTR_LSC,
 472                                       NULL);
 473 }
 474
 475 int
 476 virtual_ethdev_add_mbufs_to_rx_queue(uint16_t port_id,
 477                 struct rte_mbuf **pkt_burst, int burst_length)
 478 {
 479         struct rte_eth_dev *vrtl_eth_dev = &rte_eth_devices[port_id];
 480         struct virtual_ethdev_private *dev_private =
 481                         vrtl_eth_dev->data->dev_private;
 482
 483         return rte_ring_enqueue_burst(dev_private->rx_queue, (void **)pkt_burst,
 484                         burst_length, NULL);
 485 }
 486
 487 int
 488 virtual_ethdev_get_mbufs_from_tx_queue(uint16_t port_id,
 489                 struct rte_mbuf **pkt_burst, int burst_length)
 490 {
 491         struct virtual_ethdev_private *dev_private;
 492         struct rte_eth_dev *vrtl_eth_dev = &rte_eth_devices[port_id];
 493
 494         dev_private = vrtl_eth_dev->data->dev_private;
 495         return rte_ring_dequeue_burst(dev_private->tx_queue, (void **)pkt_burst,
 496                 burst_length, NULL);
 497 }
 498
 499
 500 int
 501 virtual_ethdev_create(const char *name, struct rte_ether_addr *mac_addr,
 502                 uint8_t socket_id, uint8_t isr_support)
 503 {
 504         struct rte_pci_device *pci_dev = NULL;
 505         struct rte_eth_dev *eth_dev = NULL;
 506         struct rte_pci_driver *pci_drv = NULL;
 507         struct rte_pci_id *id_table = NULL;
 508         struct virtual_ethdev_private *dev_private = NULL;
 509         char name_buf[RTE_RING_NAMESIZE];
 510
 511
 512         /* now do all data allocation - for eth_dev structure, dummy pci driver
 513          * and internal (dev_private) data
 514          */
 515
 516         pci_dev = rte_zmalloc_socket(name, sizeof(*pci_dev), 0, socket_id);
 517         if (pci_dev == NULL)
 518                 goto err;
 519
 520         pci_drv = rte_zmalloc_socket(name, sizeof(*pci_drv), 0, socket_id);
 521         if (pci_drv == NULL)
 522                 goto err;
 523
 524         id_table = rte_zmalloc_socket(name, sizeof(*id_table), 0, socket_id);
 525         if (id_table == NULL)
 526                 goto err;
 527         id_table->device_id = 0xBEEF;
 528
 529         dev_private = rte_zmalloc_socket(name, sizeof(*dev_private), 0, socket_id);
 530         if (dev_private == NULL)
 531                 goto err;
 532
 533         snprintf(name_buf, sizeof(name_buf), "%s_rxQ", name);
 534         dev_private->rx_queue = rte_ring_create(name_buf, MAX_PKT_BURST, socket_id,
 535                         0);
 536         if (dev_private->rx_queue == NULL)
 537                 goto err;
 538
 539         snprintf(name_buf, sizeof(name_buf), "%s_txQ", name);
 540         dev_private->tx_queue = rte_ring_create(name_buf, MAX_PKT_BURST, socket_id,
 541                         0);
 542         if (dev_private->tx_queue == NULL)
 543                 goto err;
 544
 545         /* reserve an ethdev entry */
 546         eth_dev = rte_eth_dev_allocate(name);
 547         if (eth_dev == NULL)
 548                 goto err;
 549
 550         pci_dev->device.numa_node = socket_id;
 551         pci_dev->device.name = eth_dev->data->name;
 552         pci_drv->driver.name = virtual_ethdev_driver_name;
 553         pci_drv->id_table = id_table;
 554
 555         if (isr_support)
 556                 pci_drv->drv_flags |= RTE_PCI_DRV_INTR_LSC;
 557         else
 558                 pci_drv->drv_flags &= ~RTE_PCI_DRV_INTR_LSC;
 559
 560
 561         eth_dev->device = &pci_dev->device;
 562         eth_dev->device->driver = &pci_drv->driver;
 563
 564         eth_dev->data->nb_rx_queues = (uint16_t)1;
 565         eth_dev->data->nb_tx_queues = (uint16_t)1;
 566
 567         eth_dev->data->dev_link.link_status = ETH_LINK_DOWN;
 568         eth_dev->data->dev_link.link_speed = ETH_SPEED_NUM_10G;
 569         eth_dev->data->dev_link.link_duplex = ETH_LINK_FULL_DUPLEX;
 570
 571         eth_dev->data->mac_addrs = rte_zmalloc(name, RTE_ETHER_ADDR_LEN, 0);
 572         if (eth_dev->data->mac_addrs == NULL)
 573                 goto err;
 574
 575         memcpy(eth_dev->data->mac_addrs, mac_addr,
 576                         sizeof(*eth_dev->data->mac_addrs));
 577
 578         eth_dev->data->dev_started = 0;
 579         eth_dev->data->promiscuous = 0;
 580         eth_dev->data->scattered_rx = 0;
 581         eth_dev->data->all_multicast = 0;
 582
 583         eth_dev->data->dev_private = dev_private;
 584
 585         /* Copy default device operation functions */
 586         dev_private->dev_ops = virtual_ethdev_default_dev_ops;
 587         eth_dev->dev_ops = &dev_private->dev_ops;
 588
 589         pci_dev->device.driver = &pci_drv->driver;
 590         eth_dev->device = &pci_dev->device;
 591
 592         eth_dev->rx_pkt_burst = virtual_ethdev_rx_burst_success;
 593         eth_dev->tx_pkt_burst = virtual_ethdev_tx_burst_success;
 594
 595         rte_eth_dev_probing_finish(eth_dev);
 596
 597         return eth_dev->data->port_id;
 598
 599 err:
 600         rte_free(pci_dev);
 601         rte_free(pci_drv);
 602         rte_free(id_table);
 603         rte_free(dev_private);
 604
 605         return -1;
 606 }