1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2010-2015 Intel Corporation
5 #include "rte_eth_ring.h"
7 #include <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>
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 #define ETH_RING_INTERNAL_ARG_MAX_LEN 19 /* "0x..16chars..\0" */
21 static const char *valid_arguments[] = {
22 ETH_RING_NUMA_NODE_ACTION_ARG,
23 ETH_RING_INTERNAL_ARG,
27 struct ring_internal_args {
28 struct rte_ring * const *rx_queues;
29 const unsigned int nb_rx_queues;
30 struct rte_ring * const *tx_queues;
31 const unsigned int nb_tx_queues;
32 const unsigned int numa_node;
33 void *addr; /* self addr for sanity check */
43 rte_atomic64_t rx_pkts;
44 rte_atomic64_t tx_pkts;
47 struct pmd_internals {
48 unsigned int max_rx_queues;
49 unsigned int max_tx_queues;
51 struct ring_queue rx_ring_queues[RTE_PMD_RING_MAX_RX_RINGS];
52 struct ring_queue tx_ring_queues[RTE_PMD_RING_MAX_TX_RINGS];
54 struct rte_ether_addr address;
55 enum dev_action action;
58 static struct rte_eth_link pmd_link = {
59 .link_speed = RTE_ETH_SPEED_NUM_10G,
60 .link_duplex = RTE_ETH_LINK_FULL_DUPLEX,
61 .link_status = RTE_ETH_LINK_DOWN,
62 .link_autoneg = RTE_ETH_LINK_FIXED,
65 RTE_LOG_REGISTER_DEFAULT(eth_ring_logtype, NOTICE);
67 #define PMD_LOG(level, fmt, args...) \
68 rte_log(RTE_LOG_ ## level, eth_ring_logtype, \
69 "%s(): " fmt "\n", __func__, ##args)
72 eth_ring_rx(void *q, struct rte_mbuf **bufs, uint16_t nb_bufs)
74 void **ptrs = (void *)&bufs[0];
75 struct ring_queue *r = q;
76 const uint16_t nb_rx = (uint16_t)rte_ring_dequeue_burst(r->rng,
78 if (r->rng->flags & RING_F_SC_DEQ)
79 r->rx_pkts.cnt += nb_rx;
81 rte_atomic64_add(&(r->rx_pkts), nb_rx);
86 eth_ring_tx(void *q, struct rte_mbuf **bufs, uint16_t nb_bufs)
88 void **ptrs = (void *)&bufs[0];
89 struct ring_queue *r = q;
90 const uint16_t nb_tx = (uint16_t)rte_ring_enqueue_burst(r->rng,
92 if (r->rng->flags & RING_F_SP_ENQ)
93 r->tx_pkts.cnt += nb_tx;
95 rte_atomic64_add(&(r->tx_pkts), nb_tx);
100 eth_dev_configure(struct rte_eth_dev *dev __rte_unused) { return 0; }
103 eth_dev_start(struct rte_eth_dev *dev)
105 dev->data->dev_link.link_status = RTE_ETH_LINK_UP;
110 eth_dev_stop(struct rte_eth_dev *dev)
112 dev->data->dev_started = 0;
113 dev->data->dev_link.link_status = RTE_ETH_LINK_DOWN;
118 eth_dev_set_link_down(struct rte_eth_dev *dev)
120 dev->data->dev_link.link_status = RTE_ETH_LINK_DOWN;
125 eth_dev_set_link_up(struct rte_eth_dev *dev)
127 dev->data->dev_link.link_status = RTE_ETH_LINK_UP;
132 eth_rx_queue_setup(struct rte_eth_dev *dev, uint16_t rx_queue_id,
133 uint16_t nb_rx_desc __rte_unused,
134 unsigned int socket_id __rte_unused,
135 const struct rte_eth_rxconf *rx_conf __rte_unused,
136 struct rte_mempool *mb_pool __rte_unused)
138 struct pmd_internals *internals = dev->data->dev_private;
140 dev->data->rx_queues[rx_queue_id] = &internals->rx_ring_queues[rx_queue_id];
145 eth_tx_queue_setup(struct rte_eth_dev *dev, uint16_t tx_queue_id,
146 uint16_t nb_tx_desc __rte_unused,
147 unsigned int socket_id __rte_unused,
148 const struct rte_eth_txconf *tx_conf __rte_unused)
150 struct pmd_internals *internals = dev->data->dev_private;
152 dev->data->tx_queues[tx_queue_id] = &internals->tx_ring_queues[tx_queue_id];
158 eth_dev_info(struct rte_eth_dev *dev,
159 struct rte_eth_dev_info *dev_info)
161 struct pmd_internals *internals = dev->data->dev_private;
163 dev_info->max_mac_addrs = 1;
164 dev_info->max_rx_pktlen = (uint32_t)-1;
165 dev_info->max_rx_queues = (uint16_t)internals->max_rx_queues;
166 dev_info->rx_offload_capa = RTE_ETH_RX_OFFLOAD_SCATTER;
167 dev_info->tx_offload_capa = RTE_ETH_TX_OFFLOAD_MULTI_SEGS;
168 dev_info->max_tx_queues = (uint16_t)internals->max_tx_queues;
169 dev_info->min_rx_bufsize = 0;
175 eth_stats_get(struct rte_eth_dev *dev, struct rte_eth_stats *stats)
178 unsigned long rx_total = 0, tx_total = 0;
179 const struct pmd_internals *internal = dev->data->dev_private;
181 for (i = 0; i < RTE_ETHDEV_QUEUE_STAT_CNTRS &&
182 i < dev->data->nb_rx_queues; i++) {
183 stats->q_ipackets[i] = internal->rx_ring_queues[i].rx_pkts.cnt;
184 rx_total += stats->q_ipackets[i];
187 for (i = 0; i < RTE_ETHDEV_QUEUE_STAT_CNTRS &&
188 i < dev->data->nb_tx_queues; i++) {
189 stats->q_opackets[i] = internal->tx_ring_queues[i].tx_pkts.cnt;
190 tx_total += stats->q_opackets[i];
193 stats->ipackets = rx_total;
194 stats->opackets = tx_total;
200 eth_stats_reset(struct rte_eth_dev *dev)
203 struct pmd_internals *internal = dev->data->dev_private;
205 for (i = 0; i < dev->data->nb_rx_queues; i++)
206 internal->rx_ring_queues[i].rx_pkts.cnt = 0;
207 for (i = 0; i < dev->data->nb_tx_queues; i++)
208 internal->tx_ring_queues[i].tx_pkts.cnt = 0;
214 eth_mac_addr_remove(struct rte_eth_dev *dev __rte_unused,
215 uint32_t index __rte_unused)
220 eth_mac_addr_add(struct rte_eth_dev *dev __rte_unused,
221 struct rte_ether_addr *mac_addr __rte_unused,
222 uint32_t index __rte_unused,
223 uint32_t vmdq __rte_unused)
229 eth_promiscuous_enable(struct rte_eth_dev *dev __rte_unused)
235 eth_promiscuous_disable(struct rte_eth_dev *dev __rte_unused)
241 eth_allmulticast_enable(struct rte_eth_dev *dev __rte_unused)
247 eth_allmulticast_disable(struct rte_eth_dev *dev __rte_unused)
253 eth_link_update(struct rte_eth_dev *dev __rte_unused,
254 int wait_to_complete __rte_unused) { return 0; }
257 eth_dev_close(struct rte_eth_dev *dev)
259 struct pmd_internals *internals = NULL;
260 struct ring_queue *r = NULL;
264 if (rte_eal_process_type() != RTE_PROC_PRIMARY)
267 ret = eth_dev_stop(dev);
269 internals = dev->data->dev_private;
270 if (internals->action == DEV_CREATE) {
272 * it is only necessary to delete the rings in rx_queues because
273 * they are the same used in tx_queues
275 for (i = 0; i < dev->data->nb_rx_queues; i++) {
276 r = dev->data->rx_queues[i];
277 rte_ring_free(r->rng);
281 /* mac_addrs must not be freed alone because part of dev_private */
282 dev->data->mac_addrs = NULL;
287 static const struct eth_dev_ops ops = {
288 .dev_close = eth_dev_close,
289 .dev_start = eth_dev_start,
290 .dev_stop = eth_dev_stop,
291 .dev_set_link_up = eth_dev_set_link_up,
292 .dev_set_link_down = eth_dev_set_link_down,
293 .dev_configure = eth_dev_configure,
294 .dev_infos_get = eth_dev_info,
295 .rx_queue_setup = eth_rx_queue_setup,
296 .tx_queue_setup = eth_tx_queue_setup,
297 .link_update = eth_link_update,
298 .stats_get = eth_stats_get,
299 .stats_reset = eth_stats_reset,
300 .mac_addr_remove = eth_mac_addr_remove,
301 .mac_addr_add = eth_mac_addr_add,
302 .promiscuous_enable = eth_promiscuous_enable,
303 .promiscuous_disable = eth_promiscuous_disable,
304 .allmulticast_enable = eth_allmulticast_enable,
305 .allmulticast_disable = eth_allmulticast_disable,
309 do_eth_dev_ring_create(const char *name,
310 struct rte_vdev_device *vdev,
311 struct rte_ring * const rx_queues[],
312 const unsigned int nb_rx_queues,
313 struct rte_ring *const tx_queues[],
314 const unsigned int nb_tx_queues,
315 const unsigned int numa_node, enum dev_action action,
316 struct rte_eth_dev **eth_dev_p)
318 struct rte_eth_dev_data *data = NULL;
319 struct pmd_internals *internals = NULL;
320 struct rte_eth_dev *eth_dev = NULL;
321 void **rx_queues_local = NULL;
322 void **tx_queues_local = NULL;
325 PMD_LOG(INFO, "Creating rings-backed ethdev on numa socket %u",
328 rx_queues_local = rte_calloc_socket(name, nb_rx_queues,
329 sizeof(void *), 0, numa_node);
330 if (rx_queues_local == NULL) {
335 tx_queues_local = rte_calloc_socket(name, nb_tx_queues,
336 sizeof(void *), 0, numa_node);
337 if (tx_queues_local == NULL) {
342 internals = rte_zmalloc_socket(name, sizeof(*internals), 0, numa_node);
343 if (internals == NULL) {
348 /* reserve an ethdev entry */
349 eth_dev = rte_eth_dev_allocate(name);
350 if (eth_dev == NULL) {
355 /* now put it all together
356 * - store EAL device in eth_dev,
357 * - store queue data in internals,
358 * - store numa_node info in eth_dev_data
359 * - point eth_dev_data to internals
360 * - and point eth_dev structure to new eth_dev_data structure
363 eth_dev->device = &vdev->device;
365 data = eth_dev->data;
366 data->rx_queues = rx_queues_local;
367 data->tx_queues = tx_queues_local;
369 internals->action = action;
370 internals->max_rx_queues = nb_rx_queues;
371 internals->max_tx_queues = nb_tx_queues;
372 for (i = 0; i < nb_rx_queues; i++) {
373 internals->rx_ring_queues[i].rng = rx_queues[i];
374 data->rx_queues[i] = &internals->rx_ring_queues[i];
376 for (i = 0; i < nb_tx_queues; i++) {
377 internals->tx_ring_queues[i].rng = tx_queues[i];
378 data->tx_queues[i] = &internals->tx_ring_queues[i];
381 data->dev_private = internals;
382 data->nb_rx_queues = (uint16_t)nb_rx_queues;
383 data->nb_tx_queues = (uint16_t)nb_tx_queues;
384 data->dev_link = pmd_link;
385 data->mac_addrs = &internals->address;
386 data->promiscuous = 1;
387 data->all_multicast = 1;
388 data->dev_flags |= RTE_ETH_DEV_AUTOFILL_QUEUE_XSTATS;
390 eth_dev->dev_ops = &ops;
391 data->numa_node = numa_node;
393 /* finally assign rx and tx ops */
394 eth_dev->rx_pkt_burst = eth_ring_rx;
395 eth_dev->tx_pkt_burst = eth_ring_tx;
397 rte_eth_dev_probing_finish(eth_dev);
398 *eth_dev_p = eth_dev;
400 return data->port_id;
403 rte_free(rx_queues_local);
404 rte_free(tx_queues_local);
411 rte_eth_from_rings(const char *name, struct rte_ring *const rx_queues[],
412 const unsigned int nb_rx_queues,
413 struct rte_ring *const tx_queues[],
414 const unsigned int nb_tx_queues,
415 const unsigned int numa_node)
417 struct ring_internal_args args = {
418 .rx_queues = rx_queues,
419 .nb_rx_queues = nb_rx_queues,
420 .tx_queues = tx_queues,
421 .nb_tx_queues = nb_tx_queues,
422 .numa_node = numa_node,
426 char ring_name[RTE_RING_NAMESIZE];
427 uint16_t port_id = RTE_MAX_ETHPORTS;
430 /* do some parameter checking */
431 if (rx_queues == NULL && nb_rx_queues > 0) {
435 if (tx_queues == NULL && nb_tx_queues > 0) {
439 if (nb_rx_queues > RTE_PMD_RING_MAX_RX_RINGS) {
444 snprintf(args_str, sizeof(args_str), "%s=%p",
445 ETH_RING_INTERNAL_ARG, &args);
447 ret = snprintf(ring_name, sizeof(ring_name), "net_ring_%s", name);
448 if (ret >= (int)sizeof(ring_name)) {
449 rte_errno = ENAMETOOLONG;
453 ret = rte_vdev_init(ring_name, args_str);
459 ret = rte_eth_dev_get_port_by_name(ring_name, &port_id);
469 rte_eth_from_ring(struct rte_ring *r)
471 return rte_eth_from_rings(r->name, &r, 1, &r, 1,
472 r->memzone ? r->memzone->socket_id : SOCKET_ID_ANY);
476 eth_dev_ring_create(const char *name,
477 struct rte_vdev_device *vdev,
478 const unsigned int numa_node,
479 enum dev_action action, struct rte_eth_dev **eth_dev)
481 /* rx and tx are so-called from point of view of first port.
482 * They are inverted from the point of view of second port
484 struct rte_ring *rxtx[RTE_PMD_RING_MAX_RX_RINGS];
486 char rng_name[RTE_RING_NAMESIZE];
487 unsigned int num_rings = RTE_MIN(RTE_PMD_RING_MAX_RX_RINGS,
488 RTE_PMD_RING_MAX_TX_RINGS);
490 for (i = 0; i < num_rings; i++) {
493 cc = snprintf(rng_name, sizeof(rng_name),
494 "ETH_RXTX%u_%s", i, name);
495 if (cc >= (int)sizeof(rng_name)) {
496 rte_errno = ENAMETOOLONG;
500 rxtx[i] = (action == DEV_CREATE) ?
501 rte_ring_create(rng_name, 1024, numa_node,
502 RING_F_SP_ENQ|RING_F_SC_DEQ) :
503 rte_ring_lookup(rng_name);
508 if (do_eth_dev_ring_create(name, vdev, rxtx, num_rings, rxtx, num_rings,
509 numa_node, action, eth_dev) < 0)
515 struct node_action_pair {
518 enum dev_action action;
521 struct node_action_list {
524 struct node_action_pair *list;
527 static int parse_kvlist(const char *key __rte_unused,
528 const char *value, void *data)
530 struct node_action_list *info = data;
537 name = strdup(value);
542 PMD_LOG(WARNING, "command line parameter is empty for ring pmd!");
546 node = strchr(name, ':');
548 PMD_LOG(WARNING, "could not parse node value from %s",
556 action = strchr(node, ':');
558 PMD_LOG(WARNING, "could not parse action value from %s",
567 * Need to do some sanity checking here
570 if (strcmp(action, ETH_RING_ACTION_ATTACH) == 0)
571 info->list[info->count].action = DEV_ATTACH;
572 else if (strcmp(action, ETH_RING_ACTION_CREATE) == 0)
573 info->list[info->count].action = DEV_CREATE;
578 info->list[info->count].node = strtol(node, &end, 10);
580 if ((errno != 0) || (*end != '\0')) {
582 "node value %s is unparseable as a number", node);
586 strlcpy(info->list[info->count].name, name,
587 sizeof(info->list[info->count].name));
598 parse_internal_args(const char *key __rte_unused, const char *value,
601 struct ring_internal_args **internal_args = data;
605 /* make sure 'value' is valid pointer length */
606 if (strnlen(value, ETH_RING_INTERNAL_ARG_MAX_LEN) >=
607 ETH_RING_INTERNAL_ARG_MAX_LEN) {
608 PMD_LOG(ERR, "Error parsing internal args, argument is too long");
612 ret = sscanf(value, "%p%n", &args, &n);
613 if (ret == 0 || (size_t)n != strlen(value)) {
614 PMD_LOG(ERR, "Error parsing internal args");
619 *internal_args = args;
621 if ((*internal_args)->addr != args)
628 rte_pmd_ring_probe(struct rte_vdev_device *dev)
630 const char *name, *params;
631 struct rte_kvargs *kvlist = NULL;
633 struct node_action_list *info = NULL;
634 struct rte_eth_dev *eth_dev = NULL;
635 struct ring_internal_args *internal_args;
637 name = rte_vdev_device_name(dev);
638 params = rte_vdev_device_args(dev);
640 PMD_LOG(INFO, "Initializing pmd_ring for %s", name);
642 if (rte_eal_process_type() == RTE_PROC_SECONDARY) {
643 eth_dev = rte_eth_dev_attach_secondary(name);
645 PMD_LOG(ERR, "Failed to probe %s", name);
648 eth_dev->dev_ops = &ops;
649 eth_dev->device = &dev->device;
651 eth_dev->rx_pkt_burst = eth_ring_rx;
652 eth_dev->tx_pkt_burst = eth_ring_tx;
654 rte_eth_dev_probing_finish(eth_dev);
659 if (params == NULL || params[0] == '\0') {
660 ret = eth_dev_ring_create(name, dev, rte_socket_id(), DEV_CREATE,
664 "Attach to pmd_ring for %s", name);
665 ret = eth_dev_ring_create(name, dev, rte_socket_id(),
666 DEV_ATTACH, ð_dev);
669 kvlist = rte_kvargs_parse(params, valid_arguments);
673 "Ignoring unsupported parameters when creating rings-backed ethernet device");
674 ret = eth_dev_ring_create(name, dev, rte_socket_id(),
675 DEV_CREATE, ð_dev);
678 "Attach to pmd_ring for %s",
680 ret = eth_dev_ring_create(name, dev, rte_socket_id(),
681 DEV_ATTACH, ð_dev);
687 if (rte_kvargs_count(kvlist, ETH_RING_INTERNAL_ARG) == 1) {
688 ret = rte_kvargs_process(kvlist, ETH_RING_INTERNAL_ARG,
694 ret = do_eth_dev_ring_create(name, dev,
695 internal_args->rx_queues,
696 internal_args->nb_rx_queues,
697 internal_args->tx_queues,
698 internal_args->nb_tx_queues,
699 internal_args->numa_node,
705 ret = rte_kvargs_count(kvlist, ETH_RING_NUMA_NODE_ACTION_ARG);
706 info = rte_zmalloc("struct node_action_list",
707 sizeof(struct node_action_list) +
708 (sizeof(struct node_action_pair) * ret),
714 info->list = (struct node_action_pair *)(info + 1);
716 ret = rte_kvargs_process(kvlist, ETH_RING_NUMA_NODE_ACTION_ARG,
722 for (info->count = 0; info->count < info->total; info->count++) {
723 ret = eth_dev_ring_create(info->list[info->count].name,
725 info->list[info->count].node,
726 info->list[info->count].action,
729 (info->list[info->count].action == DEV_CREATE)) {
731 "Attach to pmd_ring for %s",
733 ret = eth_dev_ring_create(name, dev,
734 info->list[info->count].node,
743 rte_kvargs_free(kvlist);
749 rte_pmd_ring_remove(struct rte_vdev_device *dev)
751 const char *name = rte_vdev_device_name(dev);
752 struct rte_eth_dev *eth_dev = NULL;
754 PMD_LOG(INFO, "Un-Initializing pmd_ring for %s", name);
759 /* find an ethdev entry */
760 eth_dev = rte_eth_dev_allocated(name);
762 return 0; /* port already released */
764 eth_dev_close(eth_dev);
765 rte_eth_dev_release_port(eth_dev);
769 static struct rte_vdev_driver pmd_ring_drv = {
770 .probe = rte_pmd_ring_probe,
771 .remove = rte_pmd_ring_remove,
774 RTE_PMD_REGISTER_VDEV(net_ring, pmd_ring_drv);
775 RTE_PMD_REGISTER_ALIAS(net_ring, eth_ring);
776 RTE_PMD_REGISTER_PARAM_STRING(net_ring,
777 ETH_RING_NUMA_NODE_ACTION_ARG "=name:node:action(ATTACH|CREATE)");