1 /* SPDX-License-Identifier: BSD-3-Clause 2 * Copyright(c) 2010-2015 Intel Corporation 3 */ 4 5 #include "rte_eth_ring.h" 6 #include <rte_mbuf.h> 7 #include <rte_ethdev_driver.h> 8 #include <rte_malloc.h> 9 #include <rte_memcpy.h> 10 #include <rte_string_fns.h> 11 #include <rte_bus_vdev.h> 12 #include <rte_kvargs.h> 13 #include <rte_errno.h> 14 15 #define ETH_RING_NUMA_NODE_ACTION_ARG "nodeaction" 16 #define ETH_RING_ACTION_CREATE "CREATE" 17 #define ETH_RING_ACTION_ATTACH "ATTACH" 18 #define ETH_RING_INTERNAL_ARG "internal" 19 20 static const char *valid_arguments[] = { 21 ETH_RING_NUMA_NODE_ACTION_ARG, 22 ETH_RING_INTERNAL_ARG, 23 NULL 24 }; 25 26 struct ring_internal_args { 27 struct rte_ring * const *rx_queues; 28 const unsigned int nb_rx_queues; 29 struct rte_ring * const *tx_queues; 30 const unsigned int nb_tx_queues; 31 const unsigned int numa_node; 32 void *addr; /* self addr for sanity check */ 33 }; 34 35 enum dev_action { 36 DEV_CREATE, 37 DEV_ATTACH 38 }; 39 40 struct ring_queue { 41 struct rte_ring *rng; 42 rte_atomic64_t rx_pkts; 43 rte_atomic64_t tx_pkts; 44 }; 45 46 struct pmd_internals { 47 unsigned int max_rx_queues; 48 unsigned int max_tx_queues; 49 50 struct ring_queue rx_ring_queues[RTE_PMD_RING_MAX_RX_RINGS]; 51 struct ring_queue tx_ring_queues[RTE_PMD_RING_MAX_TX_RINGS]; 52 53 struct rte_ether_addr address; 54 enum dev_action action; 55 }; 56 57 static struct rte_eth_link pmd_link = { 58 .link_speed = ETH_SPEED_NUM_10G, 59 .link_duplex = ETH_LINK_FULL_DUPLEX, 60 .link_status = ETH_LINK_DOWN, 61 .link_autoneg = ETH_LINK_FIXED, 62 }; 63 64 RTE_LOG_REGISTER(eth_ring_logtype, pmd.net.ring, NOTICE); 65 66 #define PMD_LOG(level, fmt, args...) \ 67 rte_log(RTE_LOG_ ## level, eth_ring_logtype, \ 68 "%s(): " fmt "\n", __func__, ##args) 69 70 static uint16_t 71 eth_ring_rx(void *q, struct rte_mbuf **bufs, uint16_t nb_bufs) 72 { 73 void **ptrs = (void *)&bufs[0]; 74 struct ring_queue *r = q; 75 const uint16_t nb_rx = (uint16_t)rte_ring_dequeue_burst(r->rng, 76 ptrs, nb_bufs, NULL); 77 if (r->rng->flags & RING_F_SC_DEQ) 78 r->rx_pkts.cnt += nb_rx; 79 else 80 rte_atomic64_add(&(r->rx_pkts), nb_rx); 81 return nb_rx; 82 } 83 84 static uint16_t 85 eth_ring_tx(void *q, struct rte_mbuf **bufs, uint16_t nb_bufs) 86 { 87 void **ptrs = (void *)&bufs[0]; 88 struct ring_queue *r = q; 89 const uint16_t nb_tx = (uint16_t)rte_ring_enqueue_burst(r->rng, 90 ptrs, nb_bufs, NULL); 91 if (r->rng->flags & RING_F_SP_ENQ) 92 r->tx_pkts.cnt += nb_tx; 93 else 94 rte_atomic64_add(&(r->tx_pkts), nb_tx); 95 return nb_tx; 96 } 97 98 static int 99 eth_dev_configure(struct rte_eth_dev *dev __rte_unused) { return 0; } 100 101 static int 102 eth_dev_start(struct rte_eth_dev *dev) 103 { 104 dev->data->dev_link.link_status = ETH_LINK_UP; 105 return 0; 106 } 107 108 static void 109 eth_dev_stop(struct rte_eth_dev *dev) 110 { 111 dev->data->dev_link.link_status = ETH_LINK_DOWN; 112 } 113 114 static int 115 eth_dev_set_link_down(struct rte_eth_dev *dev) 116 { 117 dev->data->dev_link.link_status = ETH_LINK_DOWN; 118 return 0; 119 } 120 121 static int 122 eth_dev_set_link_up(struct rte_eth_dev *dev) 123 { 124 dev->data->dev_link.link_status = ETH_LINK_UP; 125 return 0; 126 } 127 128 static int 129 eth_rx_queue_setup(struct rte_eth_dev *dev, uint16_t rx_queue_id, 130 uint16_t nb_rx_desc __rte_unused, 131 unsigned int socket_id __rte_unused, 132 const struct rte_eth_rxconf *rx_conf __rte_unused, 133 struct rte_mempool *mb_pool __rte_unused) 134 { 135 struct pmd_internals *internals = dev->data->dev_private; 136 137 dev->data->rx_queues[rx_queue_id] = &internals->rx_ring_queues[rx_queue_id]; 138 return 0; 139 } 140 141 static int 142 eth_tx_queue_setup(struct rte_eth_dev *dev, uint16_t tx_queue_id, 143 uint16_t nb_tx_desc __rte_unused, 144 unsigned int socket_id __rte_unused, 145 const struct rte_eth_txconf *tx_conf __rte_unused) 146 { 147 struct pmd_internals *internals = dev->data->dev_private; 148 149 dev->data->tx_queues[tx_queue_id] = &internals->tx_ring_queues[tx_queue_id]; 150 return 0; 151 } 152 153 154 static int 155 eth_dev_info(struct rte_eth_dev *dev, 156 struct rte_eth_dev_info *dev_info) 157 { 158 struct pmd_internals *internals = dev->data->dev_private; 159 160 dev_info->max_mac_addrs = 1; 161 dev_info->max_rx_pktlen = (uint32_t)-1; 162 dev_info->max_rx_queues = (uint16_t)internals->max_rx_queues; 163 dev_info->max_tx_queues = (uint16_t)internals->max_tx_queues; 164 dev_info->min_rx_bufsize = 0; 165 166 return 0; 167 } 168 169 static int 170 eth_stats_get(struct rte_eth_dev *dev, struct rte_eth_stats *stats) 171 { 172 unsigned int i; 173 unsigned long rx_total = 0, tx_total = 0; 174 const struct pmd_internals *internal = dev->data->dev_private; 175 176 for (i = 0; i < RTE_ETHDEV_QUEUE_STAT_CNTRS && 177 i < dev->data->nb_rx_queues; i++) { 178 stats->q_ipackets[i] = internal->rx_ring_queues[i].rx_pkts.cnt; 179 rx_total += stats->q_ipackets[i]; 180 } 181 182 for (i = 0; i < RTE_ETHDEV_QUEUE_STAT_CNTRS && 183 i < dev->data->nb_tx_queues; i++) { 184 stats->q_opackets[i] = internal->tx_ring_queues[i].tx_pkts.cnt; 185 tx_total += stats->q_opackets[i]; 186 } 187 188 stats->ipackets = rx_total; 189 stats->opackets = tx_total; 190 191 return 0; 192 } 193 194 static int 195 eth_stats_reset(struct rte_eth_dev *dev) 196 { 197 unsigned int i; 198 struct pmd_internals *internal = dev->data->dev_private; 199 200 for (i = 0; i < dev->data->nb_rx_queues; i++) 201 internal->rx_ring_queues[i].rx_pkts.cnt = 0; 202 for (i = 0; i < dev->data->nb_tx_queues; i++) 203 internal->tx_ring_queues[i].tx_pkts.cnt = 0; 204 205 return 0; 206 } 207 208 static void 209 eth_mac_addr_remove(struct rte_eth_dev *dev __rte_unused, 210 uint32_t index __rte_unused) 211 { 212 } 213 214 static int 215 eth_mac_addr_add(struct rte_eth_dev *dev __rte_unused, 216 struct rte_ether_addr *mac_addr __rte_unused, 217 uint32_t index __rte_unused, 218 uint32_t vmdq __rte_unused) 219 { 220 return 0; 221 } 222 223 static void 224 eth_queue_release(void *q __rte_unused) { ; } 225 static int 226 eth_link_update(struct rte_eth_dev *dev __rte_unused, 227 int wait_to_complete __rte_unused) { return 0; } 228 229 static const struct eth_dev_ops ops = { 230 .dev_start = eth_dev_start, 231 .dev_stop = eth_dev_stop, 232 .dev_set_link_up = eth_dev_set_link_up, 233 .dev_set_link_down = eth_dev_set_link_down, 234 .dev_configure = eth_dev_configure, 235 .dev_infos_get = eth_dev_info, 236 .rx_queue_setup = eth_rx_queue_setup, 237 .tx_queue_setup = eth_tx_queue_setup, 238 .rx_queue_release = eth_queue_release, 239 .tx_queue_release = eth_queue_release, 240 .link_update = eth_link_update, 241 .stats_get = eth_stats_get, 242 .stats_reset = eth_stats_reset, 243 .mac_addr_remove = eth_mac_addr_remove, 244 .mac_addr_add = eth_mac_addr_add, 245 }; 246 247 static int 248 do_eth_dev_ring_create(const char *name, 249 struct rte_vdev_device *vdev, 250 struct rte_ring * const rx_queues[], 251 const unsigned int nb_rx_queues, 252 struct rte_ring *const tx_queues[], 253 const unsigned int nb_tx_queues, 254 const unsigned int numa_node, enum dev_action action, 255 struct rte_eth_dev **eth_dev_p) 256 { 257 struct rte_eth_dev_data *data = NULL; 258 struct pmd_internals *internals = NULL; 259 struct rte_eth_dev *eth_dev = NULL; 260 void **rx_queues_local = NULL; 261 void **tx_queues_local = NULL; 262 unsigned int i; 263 264 PMD_LOG(INFO, "Creating rings-backed ethdev on numa socket %u", 265 numa_node); 266 267 rx_queues_local = rte_calloc_socket(name, nb_rx_queues, 268 sizeof(void *), 0, numa_node); 269 if (rx_queues_local == NULL) { 270 rte_errno = ENOMEM; 271 goto error; 272 } 273 274 tx_queues_local = rte_calloc_socket(name, nb_tx_queues, 275 sizeof(void *), 0, numa_node); 276 if (tx_queues_local == NULL) { 277 rte_errno = ENOMEM; 278 goto error; 279 } 280 281 internals = rte_zmalloc_socket(name, sizeof(*internals), 0, numa_node); 282 if (internals == NULL) { 283 rte_errno = ENOMEM; 284 goto error; 285 } 286 287 /* reserve an ethdev entry */ 288 eth_dev = rte_eth_dev_allocate(name); 289 if (eth_dev == NULL) { 290 rte_errno = ENOSPC; 291 goto error; 292 } 293 294 /* now put it all together 295 * - store EAL device in eth_dev, 296 * - store queue data in internals, 297 * - store numa_node info in eth_dev_data 298 * - point eth_dev_data to internals 299 * - and point eth_dev structure to new eth_dev_data structure 300 */ 301 302 eth_dev->device = &vdev->device; 303 304 data = eth_dev->data; 305 data->rx_queues = rx_queues_local; 306 data->tx_queues = tx_queues_local; 307 308 internals->action = action; 309 internals->max_rx_queues = nb_rx_queues; 310 internals->max_tx_queues = nb_tx_queues; 311 for (i = 0; i < nb_rx_queues; i++) { 312 internals->rx_ring_queues[i].rng = rx_queues[i]; 313 data->rx_queues[i] = &internals->rx_ring_queues[i]; 314 } 315 for (i = 0; i < nb_tx_queues; i++) { 316 internals->tx_ring_queues[i].rng = tx_queues[i]; 317 data->tx_queues[i] = &internals->tx_ring_queues[i]; 318 } 319 320 data->dev_private = internals; 321 data->nb_rx_queues = (uint16_t)nb_rx_queues; 322 data->nb_tx_queues = (uint16_t)nb_tx_queues; 323 data->dev_link = pmd_link; 324 data->mac_addrs = &internals->address; 325 data->promiscuous = 1; 326 data->all_multicast = 1; 327 328 eth_dev->dev_ops = &ops; 329 data->numa_node = numa_node; 330 331 /* finally assign rx and tx ops */ 332 eth_dev->rx_pkt_burst = eth_ring_rx; 333 eth_dev->tx_pkt_burst = eth_ring_tx; 334 335 rte_eth_dev_probing_finish(eth_dev); 336 *eth_dev_p = eth_dev; 337 338 return data->port_id; 339 340 error: 341 rte_free(rx_queues_local); 342 rte_free(tx_queues_local); 343 rte_free(internals); 344 345 return -1; 346 } 347 348 int 349 rte_eth_from_rings(const char *name, struct rte_ring *const rx_queues[], 350 const unsigned int nb_rx_queues, 351 struct rte_ring *const tx_queues[], 352 const unsigned int nb_tx_queues, 353 const unsigned int numa_node) 354 { 355 struct ring_internal_args args = { 356 .rx_queues = rx_queues, 357 .nb_rx_queues = nb_rx_queues, 358 .tx_queues = tx_queues, 359 .nb_tx_queues = nb_tx_queues, 360 .numa_node = numa_node, 361 .addr = &args, 362 }; 363 char args_str[32]; 364 char ring_name[RTE_RING_NAMESIZE]; 365 uint16_t port_id = RTE_MAX_ETHPORTS; 366 int ret; 367 368 /* do some parameter checking */ 369 if (rx_queues == NULL && nb_rx_queues > 0) { 370 rte_errno = EINVAL; 371 return -1; 372 } 373 if (tx_queues == NULL && nb_tx_queues > 0) { 374 rte_errno = EINVAL; 375 return -1; 376 } 377 if (nb_rx_queues > RTE_PMD_RING_MAX_RX_RINGS) { 378 rte_errno = EINVAL; 379 return -1; 380 } 381 382 snprintf(args_str, sizeof(args_str), "%s=%p", 383 ETH_RING_INTERNAL_ARG, &args); 384 385 ret = snprintf(ring_name, sizeof(ring_name), "net_ring_%s", name); 386 if (ret >= (int)sizeof(ring_name)) { 387 rte_errno = ENAMETOOLONG; 388 return -1; 389 } 390 391 ret = rte_vdev_init(ring_name, args_str); 392 if (ret) { 393 rte_errno = EINVAL; 394 return -1; 395 } 396 397 ret = rte_eth_dev_get_port_by_name(ring_name, &port_id); 398 if (ret) { 399 rte_errno = ENODEV; 400 return -1; 401 } 402 403 return port_id; 404 } 405 406 int 407 rte_eth_from_ring(struct rte_ring *r) 408 { 409 return rte_eth_from_rings(r->name, &r, 1, &r, 1, 410 r->memzone ? r->memzone->socket_id : SOCKET_ID_ANY); 411 } 412 413 static int 414 eth_dev_ring_create(const char *name, 415 struct rte_vdev_device *vdev, 416 const unsigned int numa_node, 417 enum dev_action action, struct rte_eth_dev **eth_dev) 418 { 419 /* rx and tx are so-called from point of view of first port. 420 * They are inverted from the point of view of second port 421 */ 422 struct rte_ring *rxtx[RTE_PMD_RING_MAX_RX_RINGS]; 423 unsigned int i; 424 char rng_name[RTE_RING_NAMESIZE]; 425 unsigned int num_rings = RTE_MIN(RTE_PMD_RING_MAX_RX_RINGS, 426 RTE_PMD_RING_MAX_TX_RINGS); 427 428 for (i = 0; i < num_rings; i++) { 429 int cc; 430 431 cc = snprintf(rng_name, sizeof(rng_name), 432 "ETH_RXTX%u_%s", i, name); 433 if (cc >= (int)sizeof(rng_name)) { 434 rte_errno = ENAMETOOLONG; 435 return -1; 436 } 437 438 rxtx[i] = (action == DEV_CREATE) ? 439 rte_ring_create(rng_name, 1024, numa_node, 440 RING_F_SP_ENQ|RING_F_SC_DEQ) : 441 rte_ring_lookup(rng_name); 442 if (rxtx[i] == NULL) 443 return -1; 444 } 445 446 if (do_eth_dev_ring_create(name, vdev, rxtx, num_rings, rxtx, num_rings, 447 numa_node, action, eth_dev) < 0) 448 return -1; 449 450 return 0; 451 } 452 453 struct node_action_pair { 454 char name[PATH_MAX]; 455 unsigned int node; 456 enum dev_action action; 457 }; 458 459 struct node_action_list { 460 unsigned int total; 461 unsigned int count; 462 struct node_action_pair *list; 463 }; 464 465 static int parse_kvlist(const char *key __rte_unused, 466 const char *value, void *data) 467 { 468 struct node_action_list *info = data; 469 int ret; 470 char *name; 471 char *action; 472 char *node; 473 char *end; 474 475 name = strdup(value); 476 477 ret = -EINVAL; 478 479 if (!name) { 480 PMD_LOG(WARNING, "command line parameter is empty for ring pmd!"); 481 goto out; 482 } 483 484 node = strchr(name, ':'); 485 if (!node) { 486 PMD_LOG(WARNING, "could not parse node value from %s", 487 name); 488 goto out; 489 } 490 491 *node = '\0'; 492 node++; 493 494 action = strchr(node, ':'); 495 if (!action) { 496 PMD_LOG(WARNING, "could not parse action value from %s", 497 node); 498 goto out; 499 } 500 501 *action = '\0'; 502 action++; 503 504 /* 505 * Need to do some sanity checking here 506 */ 507 508 if (strcmp(action, ETH_RING_ACTION_ATTACH) == 0) 509 info->list[info->count].action = DEV_ATTACH; 510 else if (strcmp(action, ETH_RING_ACTION_CREATE) == 0) 511 info->list[info->count].action = DEV_CREATE; 512 else 513 goto out; 514 515 errno = 0; 516 info->list[info->count].node = strtol(node, &end, 10); 517 518 if ((errno != 0) || (*end != '\0')) { 519 PMD_LOG(WARNING, 520 "node value %s is unparseable as a number", node); 521 goto out; 522 } 523 524 strlcpy(info->list[info->count].name, name, 525 sizeof(info->list[info->count].name)); 526 527 info->count++; 528 529 ret = 0; 530 out: 531 free(name); 532 return ret; 533 } 534 535 static int 536 parse_internal_args(const char *key __rte_unused, const char *value, 537 void *data) 538 { 539 struct ring_internal_args **internal_args = data; 540 void *args; 541 542 sscanf(value, "%p", &args); 543 544 *internal_args = args; 545 546 if ((*internal_args)->addr != args) 547 return -1; 548 549 return 0; 550 } 551 552 static int 553 rte_pmd_ring_probe(struct rte_vdev_device *dev) 554 { 555 const char *name, *params; 556 struct rte_kvargs *kvlist = NULL; 557 int ret = 0; 558 struct node_action_list *info = NULL; 559 struct rte_eth_dev *eth_dev = NULL; 560 struct ring_internal_args *internal_args; 561 562 name = rte_vdev_device_name(dev); 563 params = rte_vdev_device_args(dev); 564 565 PMD_LOG(INFO, "Initializing pmd_ring for %s", name); 566 567 if (params == NULL || params[0] == '\0') { 568 ret = eth_dev_ring_create(name, dev, rte_socket_id(), DEV_CREATE, 569 ð_dev); 570 if (ret == -1) { 571 PMD_LOG(INFO, 572 "Attach to pmd_ring for %s", name); 573 ret = eth_dev_ring_create(name, dev, rte_socket_id(), 574 DEV_ATTACH, ð_dev); 575 } 576 } else { 577 kvlist = rte_kvargs_parse(params, valid_arguments); 578 579 if (!kvlist) { 580 PMD_LOG(INFO, 581 "Ignoring unsupported parameters when creatingrings-backed ethernet device"); 582 ret = eth_dev_ring_create(name, dev, rte_socket_id(), 583 DEV_CREATE, ð_dev); 584 if (ret == -1) { 585 PMD_LOG(INFO, 586 "Attach to pmd_ring for %s", 587 name); 588 ret = eth_dev_ring_create(name, dev, rte_socket_id(), 589 DEV_ATTACH, ð_dev); 590 } 591 592 return ret; 593 } 594 595 if (rte_kvargs_count(kvlist, ETH_RING_INTERNAL_ARG) == 1) { 596 ret = rte_kvargs_process(kvlist, ETH_RING_INTERNAL_ARG, 597 parse_internal_args, 598 &internal_args); 599 if (ret < 0) 600 goto out_free; 601 602 ret = do_eth_dev_ring_create(name, dev, 603 internal_args->rx_queues, 604 internal_args->nb_rx_queues, 605 internal_args->tx_queues, 606 internal_args->nb_tx_queues, 607 internal_args->numa_node, 608 DEV_ATTACH, 609 ð_dev); 610 if (ret >= 0) 611 ret = 0; 612 } else { 613 ret = rte_kvargs_count(kvlist, ETH_RING_NUMA_NODE_ACTION_ARG); 614 info = rte_zmalloc("struct node_action_list", 615 sizeof(struct node_action_list) + 616 (sizeof(struct node_action_pair) * ret), 617 0); 618 if (!info) 619 goto out_free; 620 621 info->total = ret; 622 info->list = (struct node_action_pair *)(info + 1); 623 624 ret = rte_kvargs_process(kvlist, ETH_RING_NUMA_NODE_ACTION_ARG, 625 parse_kvlist, info); 626 627 if (ret < 0) 628 goto out_free; 629 630 for (info->count = 0; info->count < info->total; info->count++) { 631 ret = eth_dev_ring_create(info->list[info->count].name, 632 dev, 633 info->list[info->count].node, 634 info->list[info->count].action, 635 ð_dev); 636 if ((ret == -1) && 637 (info->list[info->count].action == DEV_CREATE)) { 638 PMD_LOG(INFO, 639 "Attach to pmd_ring for %s", 640 name); 641 ret = eth_dev_ring_create(name, dev, 642 info->list[info->count].node, 643 DEV_ATTACH, 644 ð_dev); 645 } 646 } 647 } 648 } 649 650 out_free: 651 rte_kvargs_free(kvlist); 652 rte_free(info); 653 return ret; 654 } 655 656 static int 657 rte_pmd_ring_remove(struct rte_vdev_device *dev) 658 { 659 const char *name = rte_vdev_device_name(dev); 660 struct rte_eth_dev *eth_dev = NULL; 661 struct pmd_internals *internals = NULL; 662 struct ring_queue *r = NULL; 663 uint16_t i; 664 665 PMD_LOG(INFO, "Un-Initializing pmd_ring for %s", name); 666 667 if (name == NULL) 668 return -EINVAL; 669 670 /* find an ethdev entry */ 671 eth_dev = rte_eth_dev_allocated(name); 672 if (eth_dev == NULL) 673 return -ENODEV; 674 675 eth_dev_stop(eth_dev); 676 677 internals = eth_dev->data->dev_private; 678 if (internals->action == DEV_CREATE) { 679 /* 680 * it is only necessary to delete the rings in rx_queues because 681 * they are the same used in tx_queues 682 */ 683 for (i = 0; i < eth_dev->data->nb_rx_queues; i++) { 684 r = eth_dev->data->rx_queues[i]; 685 rte_ring_free(r->rng); 686 } 687 } 688 689 /* mac_addrs must not be freed alone because part of dev_private */ 690 eth_dev->data->mac_addrs = NULL; 691 rte_eth_dev_release_port(eth_dev); 692 return 0; 693 } 694 695 static struct rte_vdev_driver pmd_ring_drv = { 696 .probe = rte_pmd_ring_probe, 697 .remove = rte_pmd_ring_remove, 698 }; 699 700 RTE_PMD_REGISTER_VDEV(net_ring, pmd_ring_drv); 701 RTE_PMD_REGISTER_ALIAS(net_ring, eth_ring); 702 RTE_PMD_REGISTER_PARAM_STRING(net_ring, 703 ETH_RING_NUMA_NODE_ACTION_ARG "=name:node:action(ATTACH|CREATE)"); 704