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 static int eth_ring_logtype; 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_ring * const rx_queues[], 250 const unsigned int nb_rx_queues, 251 struct rte_ring *const tx_queues[], 252 const unsigned int nb_tx_queues, 253 const unsigned int numa_node, enum dev_action action, 254 struct rte_eth_dev **eth_dev_p) 255 { 256 struct rte_eth_dev_data *data = NULL; 257 struct pmd_internals *internals = NULL; 258 struct rte_eth_dev *eth_dev = NULL; 259 void **rx_queues_local = NULL; 260 void **tx_queues_local = NULL; 261 unsigned int i; 262 263 PMD_LOG(INFO, "Creating rings-backed ethdev on numa socket %u", 264 numa_node); 265 266 rx_queues_local = rte_calloc_socket(name, nb_rx_queues, 267 sizeof(void *), 0, numa_node); 268 if (rx_queues_local == NULL) { 269 rte_errno = ENOMEM; 270 goto error; 271 } 272 273 tx_queues_local = rte_calloc_socket(name, nb_tx_queues, 274 sizeof(void *), 0, numa_node); 275 if (tx_queues_local == NULL) { 276 rte_errno = ENOMEM; 277 goto error; 278 } 279 280 internals = rte_zmalloc_socket(name, sizeof(*internals), 0, numa_node); 281 if (internals == NULL) { 282 rte_errno = ENOMEM; 283 goto error; 284 } 285 286 /* reserve an ethdev entry */ 287 eth_dev = rte_eth_dev_allocate(name); 288 if (eth_dev == NULL) { 289 rte_errno = ENOSPC; 290 goto error; 291 } 292 293 /* now put it all together 294 * - store queue data in internals, 295 * - store numa_node info in eth_dev_data 296 * - point eth_dev_data to internals 297 * - and point eth_dev structure to new eth_dev_data structure 298 */ 299 300 data = eth_dev->data; 301 data->rx_queues = rx_queues_local; 302 data->tx_queues = tx_queues_local; 303 304 internals->action = action; 305 internals->max_rx_queues = nb_rx_queues; 306 internals->max_tx_queues = nb_tx_queues; 307 for (i = 0; i < nb_rx_queues; i++) { 308 internals->rx_ring_queues[i].rng = rx_queues[i]; 309 data->rx_queues[i] = &internals->rx_ring_queues[i]; 310 } 311 for (i = 0; i < nb_tx_queues; i++) { 312 internals->tx_ring_queues[i].rng = tx_queues[i]; 313 data->tx_queues[i] = &internals->tx_ring_queues[i]; 314 } 315 316 data->dev_private = internals; 317 data->nb_rx_queues = (uint16_t)nb_rx_queues; 318 data->nb_tx_queues = (uint16_t)nb_tx_queues; 319 data->dev_link = pmd_link; 320 data->mac_addrs = &internals->address; 321 322 eth_dev->dev_ops = &ops; 323 data->kdrv = RTE_KDRV_NONE; 324 data->numa_node = numa_node; 325 326 /* finally assign rx and tx ops */ 327 eth_dev->rx_pkt_burst = eth_ring_rx; 328 eth_dev->tx_pkt_burst = eth_ring_tx; 329 330 rte_eth_dev_probing_finish(eth_dev); 331 *eth_dev_p = eth_dev; 332 333 return data->port_id; 334 335 error: 336 rte_free(rx_queues_local); 337 rte_free(tx_queues_local); 338 rte_free(internals); 339 340 return -1; 341 } 342 343 int 344 rte_eth_from_rings(const char *name, struct rte_ring *const rx_queues[], 345 const unsigned int nb_rx_queues, 346 struct rte_ring *const tx_queues[], 347 const unsigned int nb_tx_queues, 348 const unsigned int numa_node) 349 { 350 struct ring_internal_args args = { 351 .rx_queues = rx_queues, 352 .nb_rx_queues = nb_rx_queues, 353 .tx_queues = tx_queues, 354 .nb_tx_queues = nb_tx_queues, 355 .numa_node = numa_node, 356 .addr = &args, 357 }; 358 char args_str[32]; 359 char ring_name[RTE_RING_NAMESIZE]; 360 uint16_t port_id = RTE_MAX_ETHPORTS; 361 int ret; 362 363 /* do some parameter checking */ 364 if (rx_queues == NULL && nb_rx_queues > 0) { 365 rte_errno = EINVAL; 366 return -1; 367 } 368 if (tx_queues == NULL && nb_tx_queues > 0) { 369 rte_errno = EINVAL; 370 return -1; 371 } 372 if (nb_rx_queues > RTE_PMD_RING_MAX_RX_RINGS) { 373 rte_errno = EINVAL; 374 return -1; 375 } 376 377 snprintf(args_str, sizeof(args_str), "%s=%p", 378 ETH_RING_INTERNAL_ARG, &args); 379 380 ret = snprintf(ring_name, sizeof(ring_name), "net_ring_%s", name); 381 if (ret >= (int)sizeof(ring_name)) { 382 rte_errno = ENAMETOOLONG; 383 return -1; 384 } 385 386 ret = rte_vdev_init(ring_name, args_str); 387 if (ret) { 388 rte_errno = EINVAL; 389 return -1; 390 } 391 392 ret = rte_eth_dev_get_port_by_name(ring_name, &port_id); 393 if (ret) { 394 rte_errno = ENODEV; 395 return -1; 396 } 397 398 return port_id; 399 } 400 401 int 402 rte_eth_from_ring(struct rte_ring *r) 403 { 404 return rte_eth_from_rings(r->name, &r, 1, &r, 1, 405 r->memzone ? r->memzone->socket_id : SOCKET_ID_ANY); 406 } 407 408 static int 409 eth_dev_ring_create(const char *name, const unsigned int numa_node, 410 enum dev_action action, struct rte_eth_dev **eth_dev) 411 { 412 /* rx and tx are so-called from point of view of first port. 413 * They are inverted from the point of view of second port 414 */ 415 struct rte_ring *rxtx[RTE_PMD_RING_MAX_RX_RINGS]; 416 unsigned int i; 417 char rng_name[RTE_RING_NAMESIZE]; 418 unsigned int num_rings = RTE_MIN(RTE_PMD_RING_MAX_RX_RINGS, 419 RTE_PMD_RING_MAX_TX_RINGS); 420 421 for (i = 0; i < num_rings; i++) { 422 int cc; 423 424 cc = snprintf(rng_name, sizeof(rng_name), 425 "ETH_RXTX%u_%s", i, name); 426 if (cc >= (int)sizeof(rng_name)) { 427 rte_errno = ENAMETOOLONG; 428 return -1; 429 } 430 431 rxtx[i] = (action == DEV_CREATE) ? 432 rte_ring_create(rng_name, 1024, numa_node, 433 RING_F_SP_ENQ|RING_F_SC_DEQ) : 434 rte_ring_lookup(rng_name); 435 if (rxtx[i] == NULL) 436 return -1; 437 } 438 439 if (do_eth_dev_ring_create(name, rxtx, num_rings, rxtx, num_rings, 440 numa_node, action, eth_dev) < 0) 441 return -1; 442 443 return 0; 444 } 445 446 struct node_action_pair { 447 char name[PATH_MAX]; 448 unsigned int node; 449 enum dev_action action; 450 }; 451 452 struct node_action_list { 453 unsigned int total; 454 unsigned int count; 455 struct node_action_pair *list; 456 }; 457 458 static int parse_kvlist(const char *key __rte_unused, 459 const char *value, void *data) 460 { 461 struct node_action_list *info = data; 462 int ret; 463 char *name; 464 char *action; 465 char *node; 466 char *end; 467 468 name = strdup(value); 469 470 ret = -EINVAL; 471 472 if (!name) { 473 PMD_LOG(WARNING, "command line parameter is empty for ring pmd!"); 474 goto out; 475 } 476 477 node = strchr(name, ':'); 478 if (!node) { 479 PMD_LOG(WARNING, "could not parse node value from %s", 480 name); 481 goto out; 482 } 483 484 *node = '\0'; 485 node++; 486 487 action = strchr(node, ':'); 488 if (!action) { 489 PMD_LOG(WARNING, "could not parse action value from %s", 490 node); 491 goto out; 492 } 493 494 *action = '\0'; 495 action++; 496 497 /* 498 * Need to do some sanity checking here 499 */ 500 501 if (strcmp(action, ETH_RING_ACTION_ATTACH) == 0) 502 info->list[info->count].action = DEV_ATTACH; 503 else if (strcmp(action, ETH_RING_ACTION_CREATE) == 0) 504 info->list[info->count].action = DEV_CREATE; 505 else 506 goto out; 507 508 errno = 0; 509 info->list[info->count].node = strtol(node, &end, 10); 510 511 if ((errno != 0) || (*end != '\0')) { 512 PMD_LOG(WARNING, 513 "node value %s is unparseable as a number", node); 514 goto out; 515 } 516 517 strlcpy(info->list[info->count].name, name, 518 sizeof(info->list[info->count].name)); 519 520 info->count++; 521 522 ret = 0; 523 out: 524 free(name); 525 return ret; 526 } 527 528 static int 529 parse_internal_args(const char *key __rte_unused, const char *value, 530 void *data) 531 { 532 struct ring_internal_args **internal_args = data; 533 void *args; 534 535 sscanf(value, "%p", &args); 536 537 *internal_args = args; 538 539 if ((*internal_args)->addr != args) 540 return -1; 541 542 return 0; 543 } 544 545 static int 546 rte_pmd_ring_probe(struct rte_vdev_device *dev) 547 { 548 const char *name, *params; 549 struct rte_kvargs *kvlist = NULL; 550 int ret = 0; 551 struct node_action_list *info = NULL; 552 struct rte_eth_dev *eth_dev = NULL; 553 struct ring_internal_args *internal_args; 554 555 name = rte_vdev_device_name(dev); 556 params = rte_vdev_device_args(dev); 557 558 PMD_LOG(INFO, "Initializing pmd_ring for %s", name); 559 560 if (params == NULL || params[0] == '\0') { 561 ret = eth_dev_ring_create(name, rte_socket_id(), DEV_CREATE, 562 ð_dev); 563 if (ret == -1) { 564 PMD_LOG(INFO, 565 "Attach to pmd_ring for %s", name); 566 ret = eth_dev_ring_create(name, rte_socket_id(), 567 DEV_ATTACH, ð_dev); 568 } 569 } else { 570 kvlist = rte_kvargs_parse(params, valid_arguments); 571 572 if (!kvlist) { 573 PMD_LOG(INFO, 574 "Ignoring unsupported parameters when creatingrings-backed ethernet device"); 575 ret = eth_dev_ring_create(name, rte_socket_id(), 576 DEV_CREATE, ð_dev); 577 if (ret == -1) { 578 PMD_LOG(INFO, 579 "Attach to pmd_ring for %s", 580 name); 581 ret = eth_dev_ring_create(name, rte_socket_id(), 582 DEV_ATTACH, ð_dev); 583 } 584 585 if (eth_dev) 586 eth_dev->device = &dev->device; 587 588 return ret; 589 } 590 591 if (rte_kvargs_count(kvlist, ETH_RING_INTERNAL_ARG) == 1) { 592 ret = rte_kvargs_process(kvlist, ETH_RING_INTERNAL_ARG, 593 parse_internal_args, 594 &internal_args); 595 if (ret < 0) 596 goto out_free; 597 598 ret = do_eth_dev_ring_create(name, 599 internal_args->rx_queues, 600 internal_args->nb_rx_queues, 601 internal_args->tx_queues, 602 internal_args->nb_tx_queues, 603 internal_args->numa_node, 604 DEV_ATTACH, 605 ð_dev); 606 if (ret >= 0) 607 ret = 0; 608 } else { 609 ret = rte_kvargs_count(kvlist, ETH_RING_NUMA_NODE_ACTION_ARG); 610 info = rte_zmalloc("struct node_action_list", 611 sizeof(struct node_action_list) + 612 (sizeof(struct node_action_pair) * ret), 613 0); 614 if (!info) 615 goto out_free; 616 617 info->total = ret; 618 info->list = (struct node_action_pair *)(info + 1); 619 620 ret = rte_kvargs_process(kvlist, ETH_RING_NUMA_NODE_ACTION_ARG, 621 parse_kvlist, info); 622 623 if (ret < 0) 624 goto out_free; 625 626 for (info->count = 0; info->count < info->total; info->count++) { 627 ret = eth_dev_ring_create(info->list[info->count].name, 628 info->list[info->count].node, 629 info->list[info->count].action, 630 ð_dev); 631 if ((ret == -1) && 632 (info->list[info->count].action == DEV_CREATE)) { 633 PMD_LOG(INFO, 634 "Attach to pmd_ring for %s", 635 name); 636 ret = eth_dev_ring_create(name, 637 info->list[info->count].node, 638 DEV_ATTACH, 639 ð_dev); 640 } 641 } 642 } 643 } 644 645 if (eth_dev) 646 eth_dev->device = &dev->device; 647 648 out_free: 649 rte_kvargs_free(kvlist); 650 rte_free(info); 651 return ret; 652 } 653 654 static int 655 rte_pmd_ring_remove(struct rte_vdev_device *dev) 656 { 657 const char *name = rte_vdev_device_name(dev); 658 struct rte_eth_dev *eth_dev = NULL; 659 struct pmd_internals *internals = NULL; 660 struct ring_queue *r = NULL; 661 uint16_t i; 662 663 PMD_LOG(INFO, "Un-Initializing pmd_ring for %s", name); 664 665 if (name == NULL) 666 return -EINVAL; 667 668 /* find an ethdev entry */ 669 eth_dev = rte_eth_dev_allocated(name); 670 if (eth_dev == NULL) 671 return -ENODEV; 672 673 eth_dev_stop(eth_dev); 674 675 internals = eth_dev->data->dev_private; 676 if (internals->action == DEV_CREATE) { 677 /* 678 * it is only necessary to delete the rings in rx_queues because 679 * they are the same used in tx_queues 680 */ 681 for (i = 0; i < eth_dev->data->nb_rx_queues; i++) { 682 r = eth_dev->data->rx_queues[i]; 683 rte_ring_free(r->rng); 684 } 685 } 686 687 /* mac_addrs must not be freed alone because part of dev_private */ 688 eth_dev->data->mac_addrs = NULL; 689 rte_eth_dev_release_port(eth_dev); 690 return 0; 691 } 692 693 static struct rte_vdev_driver pmd_ring_drv = { 694 .probe = rte_pmd_ring_probe, 695 .remove = rte_pmd_ring_remove, 696 }; 697 698 RTE_PMD_REGISTER_VDEV(net_ring, pmd_ring_drv); 699 RTE_PMD_REGISTER_ALIAS(net_ring, eth_ring); 700 RTE_PMD_REGISTER_PARAM_STRING(net_ring, 701 ETH_RING_NUMA_NODE_ACTION_ARG "=name:node:action(ATTACH|CREATE)"); 702 703 RTE_INIT(eth_ring_init_log) 704 { 705 eth_ring_logtype = rte_log_register("pmd.net.ring"); 706 if (eth_ring_logtype >= 0) 707 rte_log_set_level(eth_ring_logtype, RTE_LOG_NOTICE); 708 } 709