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;
46 struct pmd_internals {
47 unsigned int max_rx_queues;
48 unsigned int max_tx_queues;
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];
53 struct rte_ether_addr address;
54 enum dev_action action;
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,
64 static int eth_ring_logtype;
66 #define PMD_LOG(level, fmt, args...) \
67 rte_log(RTE_LOG_ ## level, eth_ring_logtype, \
68 "%s(): " fmt "\n", __func__, ##args)
71 eth_ring_rx(void *q, struct rte_mbuf **bufs, uint16_t nb_bufs)
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,
77 if (r->rng->flags & RING_F_SC_DEQ)
78 r->rx_pkts.cnt += nb_rx;
80 rte_atomic64_add(&(r->rx_pkts), nb_rx);
85 eth_ring_tx(void *q, struct rte_mbuf **bufs, uint16_t nb_bufs)
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,
91 if (r->rng->flags & RING_F_SP_ENQ)
92 r->tx_pkts.cnt += nb_tx;
94 rte_atomic64_add(&(r->tx_pkts), nb_tx);
99 eth_dev_configure(struct rte_eth_dev *dev __rte_unused) { return 0; }
102 eth_dev_start(struct rte_eth_dev *dev)
104 dev->data->dev_link.link_status = ETH_LINK_UP;
109 eth_dev_stop(struct rte_eth_dev *dev)
111 dev->data->dev_link.link_status = ETH_LINK_DOWN;
115 eth_dev_set_link_down(struct rte_eth_dev *dev)
117 dev->data->dev_link.link_status = ETH_LINK_DOWN;
122 eth_dev_set_link_up(struct rte_eth_dev *dev)
124 dev->data->dev_link.link_status = ETH_LINK_UP;
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)
135 struct pmd_internals *internals = dev->data->dev_private;
137 dev->data->rx_queues[rx_queue_id] = &internals->rx_ring_queues[rx_queue_id];
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)
147 struct pmd_internals *internals = dev->data->dev_private;
149 dev->data->tx_queues[tx_queue_id] = &internals->tx_ring_queues[tx_queue_id];
155 eth_dev_info(struct rte_eth_dev *dev,
156 struct rte_eth_dev_info *dev_info)
158 struct pmd_internals *internals = dev->data->dev_private;
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;
168 eth_stats_get(struct rte_eth_dev *dev, struct rte_eth_stats *stats)
171 unsigned long rx_total = 0, tx_total = 0;
172 const struct pmd_internals *internal = dev->data->dev_private;
174 for (i = 0; i < RTE_ETHDEV_QUEUE_STAT_CNTRS &&
175 i < dev->data->nb_rx_queues; i++) {
176 stats->q_ipackets[i] = internal->rx_ring_queues[i].rx_pkts.cnt;
177 rx_total += stats->q_ipackets[i];
180 for (i = 0; i < RTE_ETHDEV_QUEUE_STAT_CNTRS &&
181 i < dev->data->nb_tx_queues; i++) {
182 stats->q_opackets[i] = internal->tx_ring_queues[i].tx_pkts.cnt;
183 tx_total += stats->q_opackets[i];
186 stats->ipackets = rx_total;
187 stats->opackets = tx_total;
193 eth_stats_reset(struct rte_eth_dev *dev)
196 struct pmd_internals *internal = dev->data->dev_private;
198 for (i = 0; i < dev->data->nb_rx_queues; i++)
199 internal->rx_ring_queues[i].rx_pkts.cnt = 0;
200 for (i = 0; i < dev->data->nb_tx_queues; i++)
201 internal->tx_ring_queues[i].tx_pkts.cnt = 0;
205 eth_mac_addr_remove(struct rte_eth_dev *dev __rte_unused,
206 uint32_t index __rte_unused)
211 eth_mac_addr_add(struct rte_eth_dev *dev __rte_unused,
212 struct rte_ether_addr *mac_addr __rte_unused,
213 uint32_t index __rte_unused,
214 uint32_t vmdq __rte_unused)
220 eth_queue_release(void *q __rte_unused) { ; }
222 eth_link_update(struct rte_eth_dev *dev __rte_unused,
223 int wait_to_complete __rte_unused) { return 0; }
225 static const struct eth_dev_ops ops = {
226 .dev_start = eth_dev_start,
227 .dev_stop = eth_dev_stop,
228 .dev_set_link_up = eth_dev_set_link_up,
229 .dev_set_link_down = eth_dev_set_link_down,
230 .dev_configure = eth_dev_configure,
231 .dev_infos_get = eth_dev_info,
232 .rx_queue_setup = eth_rx_queue_setup,
233 .tx_queue_setup = eth_tx_queue_setup,
234 .rx_queue_release = eth_queue_release,
235 .tx_queue_release = eth_queue_release,
236 .link_update = eth_link_update,
237 .stats_get = eth_stats_get,
238 .stats_reset = eth_stats_reset,
239 .mac_addr_remove = eth_mac_addr_remove,
240 .mac_addr_add = eth_mac_addr_add,
244 do_eth_dev_ring_create(const char *name,
245 struct rte_ring * const rx_queues[],
246 const unsigned int nb_rx_queues,
247 struct rte_ring *const tx_queues[],
248 const unsigned int nb_tx_queues,
249 const unsigned int numa_node, enum dev_action action,
250 struct rte_eth_dev **eth_dev_p)
252 struct rte_eth_dev_data *data = NULL;
253 struct pmd_internals *internals = NULL;
254 struct rte_eth_dev *eth_dev = NULL;
255 void **rx_queues_local = NULL;
256 void **tx_queues_local = NULL;
259 PMD_LOG(INFO, "Creating rings-backed ethdev on numa socket %u",
262 rx_queues_local = rte_calloc_socket(name, nb_rx_queues,
263 sizeof(void *), 0, numa_node);
264 if (rx_queues_local == NULL) {
269 tx_queues_local = rte_calloc_socket(name, nb_tx_queues,
270 sizeof(void *), 0, numa_node);
271 if (tx_queues_local == NULL) {
276 internals = rte_zmalloc_socket(name, sizeof(*internals), 0, numa_node);
277 if (internals == NULL) {
282 /* reserve an ethdev entry */
283 eth_dev = rte_eth_dev_allocate(name);
284 if (eth_dev == NULL) {
289 /* now put it all together
290 * - store queue data in internals,
291 * - store numa_node info in eth_dev_data
292 * - point eth_dev_data to internals
293 * - and point eth_dev structure to new eth_dev_data structure
296 data = eth_dev->data;
297 data->rx_queues = rx_queues_local;
298 data->tx_queues = tx_queues_local;
300 internals->action = action;
301 internals->max_rx_queues = nb_rx_queues;
302 internals->max_tx_queues = nb_tx_queues;
303 for (i = 0; i < nb_rx_queues; i++) {
304 internals->rx_ring_queues[i].rng = rx_queues[i];
305 data->rx_queues[i] = &internals->rx_ring_queues[i];
307 for (i = 0; i < nb_tx_queues; i++) {
308 internals->tx_ring_queues[i].rng = tx_queues[i];
309 data->tx_queues[i] = &internals->tx_ring_queues[i];
312 data->dev_private = internals;
313 data->nb_rx_queues = (uint16_t)nb_rx_queues;
314 data->nb_tx_queues = (uint16_t)nb_tx_queues;
315 data->dev_link = pmd_link;
316 data->mac_addrs = &internals->address;
318 eth_dev->dev_ops = &ops;
319 data->kdrv = RTE_KDRV_NONE;
320 data->numa_node = numa_node;
322 /* finally assign rx and tx ops */
323 eth_dev->rx_pkt_burst = eth_ring_rx;
324 eth_dev->tx_pkt_burst = eth_ring_tx;
326 rte_eth_dev_probing_finish(eth_dev);
327 *eth_dev_p = eth_dev;
329 return data->port_id;
332 rte_free(rx_queues_local);
333 rte_free(tx_queues_local);
340 rte_eth_from_rings(const char *name, struct rte_ring *const rx_queues[],
341 const unsigned int nb_rx_queues,
342 struct rte_ring *const tx_queues[],
343 const unsigned int nb_tx_queues,
344 const unsigned int numa_node)
346 struct ring_internal_args args = {
347 .rx_queues = rx_queues,
348 .nb_rx_queues = nb_rx_queues,
349 .tx_queues = tx_queues,
350 .nb_tx_queues = nb_tx_queues,
351 .numa_node = numa_node,
355 char ring_name[RTE_RING_NAMESIZE];
356 uint16_t port_id = RTE_MAX_ETHPORTS;
359 /* do some parameter checking */
360 if (rx_queues == NULL && nb_rx_queues > 0) {
364 if (tx_queues == NULL && nb_tx_queues > 0) {
368 if (nb_rx_queues > RTE_PMD_RING_MAX_RX_RINGS) {
373 snprintf(args_str, sizeof(args_str), "%s=%p",
374 ETH_RING_INTERNAL_ARG, &args);
376 ret = snprintf(ring_name, sizeof(ring_name), "net_ring_%s", name);
377 if (ret >= (int)sizeof(ring_name)) {
378 rte_errno = ENAMETOOLONG;
382 ret = rte_vdev_init(ring_name, args_str);
388 ret = rte_eth_dev_get_port_by_name(ring_name, &port_id);
398 rte_eth_from_ring(struct rte_ring *r)
400 return rte_eth_from_rings(r->name, &r, 1, &r, 1,
401 r->memzone ? r->memzone->socket_id : SOCKET_ID_ANY);
405 eth_dev_ring_create(const char *name, const unsigned int numa_node,
406 enum dev_action action, struct rte_eth_dev **eth_dev)
408 /* rx and tx are so-called from point of view of first port.
409 * They are inverted from the point of view of second port
411 struct rte_ring *rxtx[RTE_PMD_RING_MAX_RX_RINGS];
413 char rng_name[RTE_RING_NAMESIZE];
414 unsigned int num_rings = RTE_MIN(RTE_PMD_RING_MAX_RX_RINGS,
415 RTE_PMD_RING_MAX_TX_RINGS);
417 for (i = 0; i < num_rings; i++) {
420 cc = snprintf(rng_name, sizeof(rng_name),
421 "ETH_RXTX%u_%s", i, name);
422 if (cc >= (int)sizeof(rng_name)) {
423 rte_errno = ENAMETOOLONG;
427 rxtx[i] = (action == DEV_CREATE) ?
428 rte_ring_create(rng_name, 1024, numa_node,
429 RING_F_SP_ENQ|RING_F_SC_DEQ) :
430 rte_ring_lookup(rng_name);
435 if (do_eth_dev_ring_create(name, rxtx, num_rings, rxtx, num_rings,
436 numa_node, action, eth_dev) < 0)
442 struct node_action_pair {
445 enum dev_action action;
448 struct node_action_list {
451 struct node_action_pair *list;
454 static int parse_kvlist(const char *key __rte_unused,
455 const char *value, void *data)
457 struct node_action_list *info = data;
464 name = strdup(value);
469 PMD_LOG(WARNING, "command line parameter is empty for ring pmd!");
473 node = strchr(name, ':');
475 PMD_LOG(WARNING, "could not parse node value from %s",
483 action = strchr(node, ':');
485 PMD_LOG(WARNING, "could not parse action value from %s",
494 * Need to do some sanity checking here
497 if (strcmp(action, ETH_RING_ACTION_ATTACH) == 0)
498 info->list[info->count].action = DEV_ATTACH;
499 else if (strcmp(action, ETH_RING_ACTION_CREATE) == 0)
500 info->list[info->count].action = DEV_CREATE;
505 info->list[info->count].node = strtol(node, &end, 10);
507 if ((errno != 0) || (*end != '\0')) {
509 "node value %s is unparseable as a number", node);
513 strlcpy(info->list[info->count].name, name,
514 sizeof(info->list[info->count].name));
525 parse_internal_args(const char *key __rte_unused, const char *value,
528 struct ring_internal_args **internal_args = data;
531 sscanf(value, "%p", &args);
533 *internal_args = args;
535 if ((*internal_args)->addr != args)
542 rte_pmd_ring_probe(struct rte_vdev_device *dev)
544 const char *name, *params;
545 struct rte_kvargs *kvlist = NULL;
547 struct node_action_list *info = NULL;
548 struct rte_eth_dev *eth_dev = NULL;
549 struct ring_internal_args *internal_args;
551 name = rte_vdev_device_name(dev);
552 params = rte_vdev_device_args(dev);
554 PMD_LOG(INFO, "Initializing pmd_ring for %s", name);
556 if (params == NULL || params[0] == '\0') {
557 ret = eth_dev_ring_create(name, rte_socket_id(), DEV_CREATE,
561 "Attach to pmd_ring for %s", name);
562 ret = eth_dev_ring_create(name, rte_socket_id(),
563 DEV_ATTACH, ð_dev);
566 kvlist = rte_kvargs_parse(params, valid_arguments);
570 "Ignoring unsupported parameters when creatingrings-backed ethernet device");
571 ret = eth_dev_ring_create(name, rte_socket_id(),
572 DEV_CREATE, ð_dev);
575 "Attach to pmd_ring for %s",
577 ret = eth_dev_ring_create(name, rte_socket_id(),
578 DEV_ATTACH, ð_dev);
582 eth_dev->device = &dev->device;
587 if (rte_kvargs_count(kvlist, ETH_RING_INTERNAL_ARG) == 1) {
588 ret = rte_kvargs_process(kvlist, ETH_RING_INTERNAL_ARG,
594 ret = do_eth_dev_ring_create(name,
595 internal_args->rx_queues,
596 internal_args->nb_rx_queues,
597 internal_args->tx_queues,
598 internal_args->nb_tx_queues,
599 internal_args->numa_node,
605 ret = rte_kvargs_count(kvlist, ETH_RING_NUMA_NODE_ACTION_ARG);
606 info = rte_zmalloc("struct node_action_list",
607 sizeof(struct node_action_list) +
608 (sizeof(struct node_action_pair) * ret),
614 info->list = (struct node_action_pair *)(info + 1);
616 ret = rte_kvargs_process(kvlist, ETH_RING_NUMA_NODE_ACTION_ARG,
622 for (info->count = 0; info->count < info->total; info->count++) {
623 ret = eth_dev_ring_create(info->list[info->count].name,
624 info->list[info->count].node,
625 info->list[info->count].action,
628 (info->list[info->count].action == DEV_CREATE)) {
630 "Attach to pmd_ring for %s",
632 ret = eth_dev_ring_create(name,
633 info->list[info->count].node,
642 eth_dev->device = &dev->device;
645 rte_kvargs_free(kvlist);
651 rte_pmd_ring_remove(struct rte_vdev_device *dev)
653 const char *name = rte_vdev_device_name(dev);
654 struct rte_eth_dev *eth_dev = NULL;
655 struct pmd_internals *internals = NULL;
656 struct ring_queue *r = NULL;
659 PMD_LOG(INFO, "Un-Initializing pmd_ring for %s", name);
664 /* find an ethdev entry */
665 eth_dev = rte_eth_dev_allocated(name);
669 eth_dev_stop(eth_dev);
671 internals = eth_dev->data->dev_private;
672 if (internals->action == DEV_CREATE) {
674 * it is only necessary to delete the rings in rx_queues because
675 * they are the same used in tx_queues
677 for (i = 0; i < eth_dev->data->nb_rx_queues; i++) {
678 r = eth_dev->data->rx_queues[i];
679 rte_ring_free(r->rng);
683 /* mac_addrs must not be freed alone because part of dev_private */
684 eth_dev->data->mac_addrs = NULL;
685 rte_eth_dev_release_port(eth_dev);
689 static struct rte_vdev_driver pmd_ring_drv = {
690 .probe = rte_pmd_ring_probe,
691 .remove = rte_pmd_ring_remove,
694 RTE_PMD_REGISTER_VDEV(net_ring, pmd_ring_drv);
695 RTE_PMD_REGISTER_ALIAS(net_ring, eth_ring);
696 RTE_PMD_REGISTER_PARAM_STRING(net_ring,
697 ETH_RING_NUMA_NODE_ACTION_ARG "=name:node:action(ATTACH|CREATE)");
699 RTE_INIT(eth_ring_init_log)
701 eth_ring_logtype = rte_log_register("pmd.net.ring");
702 if (eth_ring_logtype >= 0)
703 rte_log_set_level(eth_ring_logtype, RTE_LOG_NOTICE);