1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2010-2015 Intel Corporation
5 #include "rte_eth_ring.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>
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"
20 static const char *valid_arguments[] = {
21 ETH_RING_NUMA_NODE_ACTION_ARG,
22 ETH_RING_INTERNAL_ARG,
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 */
42 rte_atomic64_t rx_pkts;
43 rte_atomic64_t tx_pkts;
44 rte_atomic64_t err_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 = ETH_SPEED_NUM_10G,
60 .link_duplex = ETH_LINK_FULL_DUPLEX,
61 .link_status = ETH_LINK_DOWN,
62 .link_autoneg = ETH_LINK_FIXED,
65 static int eth_ring_logtype;
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;
94 r->err_pkts.cnt += nb_bufs - nb_tx;
96 rte_atomic64_add(&(r->tx_pkts), nb_tx);
97 rte_atomic64_add(&(r->err_pkts), nb_bufs - nb_tx);
103 eth_dev_configure(struct rte_eth_dev *dev __rte_unused) { return 0; }
106 eth_dev_start(struct rte_eth_dev *dev)
108 dev->data->dev_link.link_status = ETH_LINK_UP;
113 eth_dev_stop(struct rte_eth_dev *dev)
115 dev->data->dev_link.link_status = ETH_LINK_DOWN;
119 eth_dev_set_link_down(struct rte_eth_dev *dev)
121 dev->data->dev_link.link_status = ETH_LINK_DOWN;
126 eth_dev_set_link_up(struct rte_eth_dev *dev)
128 dev->data->dev_link.link_status = ETH_LINK_UP;
133 eth_rx_queue_setup(struct rte_eth_dev *dev, uint16_t rx_queue_id,
134 uint16_t nb_rx_desc __rte_unused,
135 unsigned int socket_id __rte_unused,
136 const struct rte_eth_rxconf *rx_conf __rte_unused,
137 struct rte_mempool *mb_pool __rte_unused)
139 struct pmd_internals *internals = dev->data->dev_private;
141 dev->data->rx_queues[rx_queue_id] = &internals->rx_ring_queues[rx_queue_id];
146 eth_tx_queue_setup(struct rte_eth_dev *dev, uint16_t tx_queue_id,
147 uint16_t nb_tx_desc __rte_unused,
148 unsigned int socket_id __rte_unused,
149 const struct rte_eth_txconf *tx_conf __rte_unused)
151 struct pmd_internals *internals = dev->data->dev_private;
153 dev->data->tx_queues[tx_queue_id] = &internals->tx_ring_queues[tx_queue_id];
159 eth_dev_info(struct rte_eth_dev *dev,
160 struct rte_eth_dev_info *dev_info)
162 struct pmd_internals *internals = dev->data->dev_private;
164 dev_info->max_mac_addrs = 1;
165 dev_info->max_rx_pktlen = (uint32_t)-1;
166 dev_info->max_rx_queues = (uint16_t)internals->max_rx_queues;
167 dev_info->max_tx_queues = (uint16_t)internals->max_tx_queues;
168 dev_info->min_rx_bufsize = 0;
172 eth_stats_get(struct rte_eth_dev *dev, struct rte_eth_stats *stats)
175 unsigned long rx_total = 0, tx_total = 0, tx_err_total = 0;
176 const struct pmd_internals *internal = dev->data->dev_private;
178 for (i = 0; i < RTE_ETHDEV_QUEUE_STAT_CNTRS &&
179 i < dev->data->nb_rx_queues; i++) {
180 stats->q_ipackets[i] = internal->rx_ring_queues[i].rx_pkts.cnt;
181 rx_total += stats->q_ipackets[i];
184 for (i = 0; i < RTE_ETHDEV_QUEUE_STAT_CNTRS &&
185 i < dev->data->nb_tx_queues; i++) {
186 stats->q_opackets[i] = internal->tx_ring_queues[i].tx_pkts.cnt;
187 tx_total += stats->q_opackets[i];
188 tx_err_total += internal->tx_ring_queues[i].err_pkts.cnt;
191 stats->ipackets = rx_total;
192 stats->opackets = tx_total;
193 stats->oerrors = tx_err_total;
199 eth_stats_reset(struct rte_eth_dev *dev)
202 struct pmd_internals *internal = dev->data->dev_private;
204 for (i = 0; i < dev->data->nb_rx_queues; i++)
205 internal->rx_ring_queues[i].rx_pkts.cnt = 0;
206 for (i = 0; i < dev->data->nb_tx_queues; i++) {
207 internal->tx_ring_queues[i].tx_pkts.cnt = 0;
208 internal->tx_ring_queues[i].err_pkts.cnt = 0;
213 eth_mac_addr_remove(struct rte_eth_dev *dev __rte_unused,
214 uint32_t index __rte_unused)
219 eth_mac_addr_add(struct rte_eth_dev *dev __rte_unused,
220 struct rte_ether_addr *mac_addr __rte_unused,
221 uint32_t index __rte_unused,
222 uint32_t vmdq __rte_unused)
228 eth_queue_release(void *q __rte_unused) { ; }
230 eth_link_update(struct rte_eth_dev *dev __rte_unused,
231 int wait_to_complete __rte_unused) { return 0; }
233 static const struct eth_dev_ops ops = {
234 .dev_start = eth_dev_start,
235 .dev_stop = eth_dev_stop,
236 .dev_set_link_up = eth_dev_set_link_up,
237 .dev_set_link_down = eth_dev_set_link_down,
238 .dev_configure = eth_dev_configure,
239 .dev_infos_get = eth_dev_info,
240 .rx_queue_setup = eth_rx_queue_setup,
241 .tx_queue_setup = eth_tx_queue_setup,
242 .rx_queue_release = eth_queue_release,
243 .tx_queue_release = eth_queue_release,
244 .link_update = eth_link_update,
245 .stats_get = eth_stats_get,
246 .stats_reset = eth_stats_reset,
247 .mac_addr_remove = eth_mac_addr_remove,
248 .mac_addr_add = eth_mac_addr_add,
251 static struct rte_vdev_driver pmd_ring_drv;
254 do_eth_dev_ring_create(const char *name,
255 struct rte_ring * const rx_queues[],
256 const unsigned int nb_rx_queues,
257 struct rte_ring *const tx_queues[],
258 const unsigned int nb_tx_queues,
259 const unsigned int numa_node, enum dev_action action,
260 struct rte_eth_dev **eth_dev_p)
262 struct rte_eth_dev_data *data = NULL;
263 struct pmd_internals *internals = NULL;
264 struct rte_eth_dev *eth_dev = NULL;
265 void **rx_queues_local = NULL;
266 void **tx_queues_local = NULL;
269 PMD_LOG(INFO, "Creating rings-backed ethdev on numa socket %u",
272 rx_queues_local = rte_calloc_socket(name, nb_rx_queues,
273 sizeof(void *), 0, numa_node);
274 if (rx_queues_local == NULL) {
279 tx_queues_local = rte_calloc_socket(name, nb_tx_queues,
280 sizeof(void *), 0, numa_node);
281 if (tx_queues_local == NULL) {
286 internals = rte_zmalloc_socket(name, sizeof(*internals), 0, numa_node);
287 if (internals == NULL) {
292 /* reserve an ethdev entry */
293 eth_dev = rte_eth_dev_allocate(name);
294 if (eth_dev == NULL) {
299 /* now put it all together
300 * - store queue data in internals,
301 * - store numa_node info in eth_dev_data
302 * - point eth_dev_data to internals
303 * - and point eth_dev structure to new eth_dev_data structure
306 data = eth_dev->data;
307 data->rx_queues = rx_queues_local;
308 data->tx_queues = tx_queues_local;
310 internals->action = action;
311 internals->max_rx_queues = nb_rx_queues;
312 internals->max_tx_queues = nb_tx_queues;
313 for (i = 0; i < nb_rx_queues; i++) {
314 internals->rx_ring_queues[i].rng = rx_queues[i];
315 data->rx_queues[i] = &internals->rx_ring_queues[i];
317 for (i = 0; i < nb_tx_queues; i++) {
318 internals->tx_ring_queues[i].rng = tx_queues[i];
319 data->tx_queues[i] = &internals->tx_ring_queues[i];
322 data->dev_private = internals;
323 data->nb_rx_queues = (uint16_t)nb_rx_queues;
324 data->nb_tx_queues = (uint16_t)nb_tx_queues;
325 data->dev_link = pmd_link;
326 data->mac_addrs = &internals->address;
328 eth_dev->dev_ops = &ops;
329 data->kdrv = RTE_KDRV_NONE;
330 data->numa_node = numa_node;
332 /* finally assign rx and tx ops */
333 eth_dev->rx_pkt_burst = eth_ring_rx;
334 eth_dev->tx_pkt_burst = eth_ring_tx;
336 rte_eth_dev_probing_finish(eth_dev);
337 *eth_dev_p = eth_dev;
339 return data->port_id;
342 rte_free(rx_queues_local);
343 rte_free(tx_queues_local);
350 rte_eth_from_rings(const char *name, struct rte_ring *const rx_queues[],
351 const unsigned int nb_rx_queues,
352 struct rte_ring *const tx_queues[],
353 const unsigned int nb_tx_queues,
354 const unsigned int numa_node)
356 struct ring_internal_args args = {
357 .rx_queues = rx_queues,
358 .nb_rx_queues = nb_rx_queues,
359 .tx_queues = tx_queues,
360 .nb_tx_queues = nb_tx_queues,
361 .numa_node = numa_node,
365 char ring_name[RTE_RING_NAMESIZE];
366 uint16_t port_id = RTE_MAX_ETHPORTS;
369 /* do some parameter checking */
370 if (rx_queues == NULL && nb_rx_queues > 0) {
374 if (tx_queues == NULL && nb_tx_queues > 0) {
378 if (nb_rx_queues > RTE_PMD_RING_MAX_RX_RINGS) {
383 snprintf(args_str, sizeof(args_str), "%s=%p",
384 ETH_RING_INTERNAL_ARG, &args);
386 ret = snprintf(ring_name, sizeof(ring_name), "net_ring_%s", name);
387 if (ret >= (int)sizeof(ring_name)) {
388 rte_errno = ENAMETOOLONG;
392 ret = rte_vdev_init(ring_name, args_str);
398 ret = rte_eth_dev_get_port_by_name(ring_name, &port_id);
408 rte_eth_from_ring(struct rte_ring *r)
410 return rte_eth_from_rings(r->name, &r, 1, &r, 1,
411 r->memzone ? r->memzone->socket_id : SOCKET_ID_ANY);
415 eth_dev_ring_create(const char *name, const unsigned int numa_node,
416 enum dev_action action, struct rte_eth_dev **eth_dev)
418 /* rx and tx are so-called from point of view of first port.
419 * They are inverted from the point of view of second port
421 struct rte_ring *rxtx[RTE_PMD_RING_MAX_RX_RINGS];
423 char rng_name[RTE_RING_NAMESIZE];
424 unsigned int num_rings = RTE_MIN(RTE_PMD_RING_MAX_RX_RINGS,
425 RTE_PMD_RING_MAX_TX_RINGS);
427 for (i = 0; i < num_rings; i++) {
430 cc = snprintf(rng_name, sizeof(rng_name),
431 "ETH_RXTX%u_%s", i, name);
432 if (cc >= (int)sizeof(rng_name)) {
433 rte_errno = ENAMETOOLONG;
437 rxtx[i] = (action == DEV_CREATE) ?
438 rte_ring_create(rng_name, 1024, numa_node,
439 RING_F_SP_ENQ|RING_F_SC_DEQ) :
440 rte_ring_lookup(rng_name);
445 if (do_eth_dev_ring_create(name, rxtx, num_rings, rxtx, num_rings,
446 numa_node, action, eth_dev) < 0)
452 struct node_action_pair {
455 enum dev_action action;
458 struct node_action_list {
461 struct node_action_pair *list;
464 static int parse_kvlist(const char *key __rte_unused,
465 const char *value, void *data)
467 struct node_action_list *info = data;
474 name = strdup(value);
479 PMD_LOG(WARNING, "command line parameter is empty for ring pmd!");
483 node = strchr(name, ':');
485 PMD_LOG(WARNING, "could not parse node value from %s",
493 action = strchr(node, ':');
495 PMD_LOG(WARNING, "could not parse action value from %s",
504 * Need to do some sanity checking here
507 if (strcmp(action, ETH_RING_ACTION_ATTACH) == 0)
508 info->list[info->count].action = DEV_ATTACH;
509 else if (strcmp(action, ETH_RING_ACTION_CREATE) == 0)
510 info->list[info->count].action = DEV_CREATE;
515 info->list[info->count].node = strtol(node, &end, 10);
517 if ((errno != 0) || (*end != '\0')) {
519 "node value %s is unparseable as a number", node);
523 strlcpy(info->list[info->count].name, name,
524 sizeof(info->list[info->count].name));
535 parse_internal_args(const char *key __rte_unused, const char *value,
538 struct ring_internal_args **internal_args = data;
541 sscanf(value, "%p", &args);
543 *internal_args = args;
545 if ((*internal_args)->addr != args)
552 rte_pmd_ring_probe(struct rte_vdev_device *dev)
554 const char *name, *params;
555 struct rte_kvargs *kvlist = NULL;
557 struct node_action_list *info = NULL;
558 struct rte_eth_dev *eth_dev = NULL;
559 struct ring_internal_args *internal_args;
561 name = rte_vdev_device_name(dev);
562 params = rte_vdev_device_args(dev);
564 PMD_LOG(INFO, "Initializing pmd_ring for %s", name);
566 if (params == NULL || params[0] == '\0') {
567 ret = eth_dev_ring_create(name, rte_socket_id(), DEV_CREATE,
571 "Attach to pmd_ring for %s", name);
572 ret = eth_dev_ring_create(name, rte_socket_id(),
573 DEV_ATTACH, ð_dev);
576 kvlist = rte_kvargs_parse(params, valid_arguments);
580 "Ignoring unsupported parameters when creatingrings-backed ethernet device");
581 ret = eth_dev_ring_create(name, rte_socket_id(),
582 DEV_CREATE, ð_dev);
585 "Attach to pmd_ring for %s",
587 ret = eth_dev_ring_create(name, rte_socket_id(),
588 DEV_ATTACH, ð_dev);
592 eth_dev->device = &dev->device;
597 if (rte_kvargs_count(kvlist, ETH_RING_INTERNAL_ARG) == 1) {
598 ret = rte_kvargs_process(kvlist, ETH_RING_INTERNAL_ARG,
604 ret = do_eth_dev_ring_create(name,
605 internal_args->rx_queues,
606 internal_args->nb_rx_queues,
607 internal_args->tx_queues,
608 internal_args->nb_tx_queues,
609 internal_args->numa_node,
615 ret = rte_kvargs_count(kvlist, ETH_RING_NUMA_NODE_ACTION_ARG);
616 info = rte_zmalloc("struct node_action_list",
617 sizeof(struct node_action_list) +
618 (sizeof(struct node_action_pair) * ret),
624 info->list = (struct node_action_pair *)(info + 1);
626 ret = rte_kvargs_process(kvlist, ETH_RING_NUMA_NODE_ACTION_ARG,
632 for (info->count = 0; info->count < info->total; info->count++) {
633 ret = eth_dev_ring_create(info->list[info->count].name,
634 info->list[info->count].node,
635 info->list[info->count].action,
638 (info->list[info->count].action == DEV_CREATE)) {
640 "Attach to pmd_ring for %s",
642 ret = eth_dev_ring_create(name,
643 info->list[info->count].node,
652 eth_dev->device = &dev->device;
655 rte_kvargs_free(kvlist);
661 rte_pmd_ring_remove(struct rte_vdev_device *dev)
663 const char *name = rte_vdev_device_name(dev);
664 struct rte_eth_dev *eth_dev = NULL;
665 struct pmd_internals *internals = NULL;
666 struct ring_queue *r = NULL;
669 PMD_LOG(INFO, "Un-Initializing pmd_ring for %s", name);
674 /* find an ethdev entry */
675 eth_dev = rte_eth_dev_allocated(name);
679 eth_dev_stop(eth_dev);
681 internals = eth_dev->data->dev_private;
682 if (internals->action == DEV_CREATE) {
684 * it is only necessary to delete the rings in rx_queues because
685 * they are the same used in tx_queues
687 for (i = 0; i < eth_dev->data->nb_rx_queues; i++) {
688 r = eth_dev->data->rx_queues[i];
689 rte_ring_free(r->rng);
693 /* mac_addrs must not be freed alone because part of dev_private */
694 eth_dev->data->mac_addrs = NULL;
695 rte_eth_dev_release_port(eth_dev);
699 static struct rte_vdev_driver pmd_ring_drv = {
700 .probe = rte_pmd_ring_probe,
701 .remove = rte_pmd_ring_remove,
704 RTE_PMD_REGISTER_VDEV(net_ring, pmd_ring_drv);
705 RTE_PMD_REGISTER_ALIAS(net_ring, eth_ring);
706 RTE_PMD_REGISTER_PARAM_STRING(net_ring,
707 ETH_RING_NUMA_NODE_ACTION_ARG "=name:node:action(ATTACH|CREATE)");
709 RTE_INIT(eth_ring_init_log)
711 eth_ring_logtype = rte_log_register("pmd.net.ring");
712 if (eth_ring_logtype >= 0)
713 rte_log_set_level(eth_ring_logtype, RTE_LOG_NOTICE);