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 max_rx_queues;
49 unsigned 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 ether_addr address;
55 enum dev_action action;
59 static struct rte_eth_link pmd_link = {
60 .link_speed = ETH_SPEED_NUM_10G,
61 .link_duplex = ETH_LINK_FULL_DUPLEX,
62 .link_status = ETH_LINK_DOWN,
63 .link_autoneg = ETH_LINK_FIXED,
66 static int eth_ring_logtype;
68 #define PMD_LOG(level, fmt, args...) \
69 rte_log(RTE_LOG_ ## level, eth_ring_logtype, \
70 "%s(): " fmt "\n", __func__, ##args)
73 eth_ring_rx(void *q, struct rte_mbuf **bufs, uint16_t nb_bufs)
75 void **ptrs = (void *)&bufs[0];
76 struct ring_queue *r = q;
77 const uint16_t nb_rx = (uint16_t)rte_ring_dequeue_burst(r->rng,
79 if (r->rng->flags & RING_F_SC_DEQ)
80 r->rx_pkts.cnt += nb_rx;
82 rte_atomic64_add(&(r->rx_pkts), nb_rx);
87 eth_ring_tx(void *q, struct rte_mbuf **bufs, uint16_t nb_bufs)
89 void **ptrs = (void *)&bufs[0];
90 struct ring_queue *r = q;
91 const uint16_t nb_tx = (uint16_t)rte_ring_enqueue_burst(r->rng,
93 if (r->rng->flags & RING_F_SP_ENQ) {
94 r->tx_pkts.cnt += nb_tx;
95 r->err_pkts.cnt += nb_bufs - nb_tx;
97 rte_atomic64_add(&(r->tx_pkts), nb_tx);
98 rte_atomic64_add(&(r->err_pkts), nb_bufs - nb_tx);
104 eth_dev_configure(struct rte_eth_dev *dev __rte_unused) { return 0; }
107 eth_dev_start(struct rte_eth_dev *dev)
109 dev->data->dev_link.link_status = ETH_LINK_UP;
114 eth_dev_stop(struct rte_eth_dev *dev)
116 dev->data->dev_link.link_status = ETH_LINK_DOWN;
120 eth_dev_set_link_down(struct rte_eth_dev *dev)
122 dev->data->dev_link.link_status = ETH_LINK_DOWN;
127 eth_dev_set_link_up(struct rte_eth_dev *dev)
129 dev->data->dev_link.link_status = ETH_LINK_UP;
134 eth_rx_queue_setup(struct rte_eth_dev *dev, uint16_t rx_queue_id,
135 uint16_t nb_rx_desc __rte_unused,
136 unsigned int socket_id __rte_unused,
137 const struct rte_eth_rxconf *rx_conf __rte_unused,
138 struct rte_mempool *mb_pool __rte_unused)
140 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;
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;
162 dev_info->max_mac_addrs = 1;
163 dev_info->max_rx_pktlen = (uint32_t)-1;
164 dev_info->max_rx_queues = (uint16_t)internals->max_rx_queues;
165 dev_info->max_tx_queues = (uint16_t)internals->max_tx_queues;
166 dev_info->min_rx_bufsize = 0;
170 eth_stats_get(struct rte_eth_dev *dev, struct rte_eth_stats *stats)
173 unsigned long rx_total = 0, tx_total = 0, tx_err_total = 0;
174 const struct pmd_internals *internal = dev->data->dev_private;
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];
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 stats->q_errors[i] = internal->tx_ring_queues[i].err_pkts.cnt;
186 tx_total += stats->q_opackets[i];
187 tx_err_total += stats->q_errors[i];
190 stats->ipackets = rx_total;
191 stats->opackets = tx_total;
192 stats->oerrors = tx_err_total;
198 eth_stats_reset(struct rte_eth_dev *dev)
201 struct pmd_internals *internal = dev->data->dev_private;
202 for (i = 0; i < dev->data->nb_rx_queues; i++)
203 internal->rx_ring_queues[i].rx_pkts.cnt = 0;
204 for (i = 0; i < dev->data->nb_tx_queues; i++) {
205 internal->tx_ring_queues[i].tx_pkts.cnt = 0;
206 internal->tx_ring_queues[i].err_pkts.cnt = 0;
211 eth_mac_addr_remove(struct rte_eth_dev *dev __rte_unused,
212 uint32_t index __rte_unused)
217 eth_mac_addr_add(struct rte_eth_dev *dev __rte_unused,
218 struct ether_addr *mac_addr __rte_unused,
219 uint32_t index __rte_unused,
220 uint32_t vmdq __rte_unused)
226 eth_queue_release(void *q __rte_unused) { ; }
228 eth_link_update(struct rte_eth_dev *dev __rte_unused,
229 int wait_to_complete __rte_unused) { return 0; }
231 static const struct eth_dev_ops ops = {
232 .dev_start = eth_dev_start,
233 .dev_stop = eth_dev_stop,
234 .dev_set_link_up = eth_dev_set_link_up,
235 .dev_set_link_down = eth_dev_set_link_down,
236 .dev_configure = eth_dev_configure,
237 .dev_infos_get = eth_dev_info,
238 .rx_queue_setup = eth_rx_queue_setup,
239 .tx_queue_setup = eth_tx_queue_setup,
240 .rx_queue_release = eth_queue_release,
241 .tx_queue_release = eth_queue_release,
242 .link_update = eth_link_update,
243 .stats_get = eth_stats_get,
244 .stats_reset = eth_stats_reset,
245 .mac_addr_remove = eth_mac_addr_remove,
246 .mac_addr_add = eth_mac_addr_add,
249 static struct rte_vdev_driver pmd_ring_drv;
252 do_eth_dev_ring_create(const char *name,
253 struct rte_ring * const rx_queues[], const unsigned nb_rx_queues,
254 struct rte_ring *const tx_queues[], const unsigned nb_tx_queues,
255 const unsigned int numa_node, enum dev_action action,
256 struct rte_eth_dev **eth_dev_p)
258 struct rte_eth_dev_data *data = NULL;
259 struct pmd_internals *internals = NULL;
260 struct rte_eth_dev *eth_dev = NULL;
261 void **rx_queues_local = NULL;
262 void **tx_queues_local = NULL;
265 PMD_LOG(INFO, "Creating rings-backed ethdev on numa socket %u",
268 rx_queues_local = rte_zmalloc_socket(name,
269 sizeof(void *) * nb_rx_queues, 0, numa_node);
270 if (rx_queues_local == NULL) {
275 tx_queues_local = rte_zmalloc_socket(name,
276 sizeof(void *) * nb_tx_queues, 0, numa_node);
277 if (tx_queues_local == NULL) {
282 internals = rte_zmalloc_socket(name, sizeof(*internals), 0, numa_node);
283 if (internals == NULL) {
288 /* reserve an ethdev entry */
289 eth_dev = rte_eth_dev_allocate(name);
290 if (eth_dev == NULL) {
295 /* now put it all together
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
302 data = eth_dev->data;
303 data->rx_queues = rx_queues_local;
304 data->tx_queues = tx_queues_local;
306 internals->action = action;
307 internals->max_rx_queues = nb_rx_queues;
308 internals->max_tx_queues = nb_tx_queues;
309 for (i = 0; i < nb_rx_queues; i++) {
310 internals->rx_ring_queues[i].rng = rx_queues[i];
311 data->rx_queues[i] = &internals->rx_ring_queues[i];
313 for (i = 0; i < nb_tx_queues; i++) {
314 internals->tx_ring_queues[i].rng = tx_queues[i];
315 data->tx_queues[i] = &internals->tx_ring_queues[i];
318 data->dev_private = internals;
319 data->nb_rx_queues = (uint16_t)nb_rx_queues;
320 data->nb_tx_queues = (uint16_t)nb_tx_queues;
321 data->dev_link = pmd_link;
322 data->mac_addrs = &internals->address;
324 eth_dev->dev_ops = &ops;
325 data->kdrv = RTE_KDRV_NONE;
326 data->numa_node = numa_node;
328 /* finally assign rx and tx ops */
329 eth_dev->rx_pkt_burst = eth_ring_rx;
330 eth_dev->tx_pkt_burst = eth_ring_tx;
332 *eth_dev_p = eth_dev;
334 return data->port_id;
337 rte_free(rx_queues_local);
338 rte_free(tx_queues_local);
345 rte_eth_from_rings(const char *name, struct rte_ring *const rx_queues[],
346 const unsigned nb_rx_queues,
347 struct rte_ring *const tx_queues[],
348 const unsigned nb_tx_queues,
349 const unsigned numa_node)
351 struct ring_internal_args args = {
352 .rx_queues = rx_queues,
353 .nb_rx_queues = nb_rx_queues,
354 .tx_queues = tx_queues,
355 .nb_tx_queues = nb_tx_queues,
356 .numa_node = numa_node,
359 char args_str[32] = { 0 };
360 char ring_name[32] = { 0 };
361 uint16_t port_id = RTE_MAX_ETHPORTS;
364 /* do some parameter checking */
365 if (rx_queues == NULL && nb_rx_queues > 0) {
369 if (tx_queues == NULL && nb_tx_queues > 0) {
373 if (nb_rx_queues > RTE_PMD_RING_MAX_RX_RINGS) {
378 snprintf(args_str, 32, "%s=%p", ETH_RING_INTERNAL_ARG, &args);
379 snprintf(ring_name, 32, "net_ring_%s", name);
381 ret = rte_vdev_init(ring_name, args_str);
387 rte_eth_dev_get_port_by_name(ring_name, &port_id);
393 rte_eth_from_ring(struct rte_ring *r)
395 return rte_eth_from_rings(r->name, &r, 1, &r, 1,
396 r->memzone ? r->memzone->socket_id : SOCKET_ID_ANY);
400 eth_dev_ring_create(const char *name, const unsigned numa_node,
401 enum dev_action action, struct rte_eth_dev **eth_dev)
403 /* rx and tx are so-called from point of view of first port.
404 * They are inverted from the point of view of second port
406 struct rte_ring *rxtx[RTE_PMD_RING_MAX_RX_RINGS];
408 char rng_name[RTE_RING_NAMESIZE];
409 unsigned num_rings = RTE_MIN(RTE_PMD_RING_MAX_RX_RINGS,
410 RTE_PMD_RING_MAX_TX_RINGS);
412 for (i = 0; i < num_rings; i++) {
413 snprintf(rng_name, sizeof(rng_name), "ETH_RXTX%u_%s", i, name);
414 rxtx[i] = (action == DEV_CREATE) ?
415 rte_ring_create(rng_name, 1024, numa_node,
416 RING_F_SP_ENQ|RING_F_SC_DEQ) :
417 rte_ring_lookup(rng_name);
422 if (do_eth_dev_ring_create(name, rxtx, num_rings, rxtx, num_rings,
423 numa_node, action, eth_dev) < 0)
429 struct node_action_pair {
432 enum dev_action action;
435 struct node_action_list {
438 struct node_action_pair *list;
441 static int parse_kvlist (const char *key __rte_unused, const char *value, void *data)
443 struct node_action_list *info = data;
450 name = strdup(value);
455 PMD_LOG(WARNING, "command line parameter is empty for ring pmd!");
459 node = strchr(name, ':');
461 PMD_LOG(WARNING, "could not parse node value from %s",
469 action = strchr(node, ':');
471 PMD_LOG(WARNING, "could not parse action value from %s",
480 * Need to do some sanity checking here
483 if (strcmp(action, ETH_RING_ACTION_ATTACH) == 0)
484 info->list[info->count].action = DEV_ATTACH;
485 else if (strcmp(action, ETH_RING_ACTION_CREATE) == 0)
486 info->list[info->count].action = DEV_CREATE;
491 info->list[info->count].node = strtol(node, &end, 10);
493 if ((errno != 0) || (*end != '\0')) {
495 "node value %s is unparseable as a number", node);
499 snprintf(info->list[info->count].name, sizeof(info->list[info->count].name), "%s", name);
510 parse_internal_args(const char *key __rte_unused, const char *value,
513 struct ring_internal_args **internal_args = data;
516 sscanf(value, "%p", &args);
518 *internal_args = args;
520 if ((*internal_args)->addr != args)
527 rte_pmd_ring_probe(struct rte_vdev_device *dev)
529 const char *name, *params;
530 struct rte_kvargs *kvlist = NULL;
532 struct node_action_list *info = NULL;
533 struct rte_eth_dev *eth_dev = NULL;
534 struct ring_internal_args *internal_args;
536 name = rte_vdev_device_name(dev);
537 params = rte_vdev_device_args(dev);
539 PMD_LOG(INFO, "Initializing pmd_ring for %s", name);
541 if (params == NULL || params[0] == '\0') {
542 ret = eth_dev_ring_create(name, rte_socket_id(), DEV_CREATE,
546 "Attach to pmd_ring for %s", name);
547 ret = eth_dev_ring_create(name, rte_socket_id(),
548 DEV_ATTACH, ð_dev);
551 kvlist = rte_kvargs_parse(params, valid_arguments);
554 PMD_LOG(INFO, "Ignoring unsupported parameters when creating"
555 " rings-backed ethernet device");
556 ret = eth_dev_ring_create(name, rte_socket_id(),
557 DEV_CREATE, ð_dev);
560 "Attach to pmd_ring for %s",
562 ret = eth_dev_ring_create(name, rte_socket_id(),
563 DEV_ATTACH, ð_dev);
567 eth_dev->device = &dev->device;
572 if (rte_kvargs_count(kvlist, ETH_RING_INTERNAL_ARG) == 1) {
573 ret = rte_kvargs_process(kvlist, ETH_RING_INTERNAL_ARG,
579 ret = do_eth_dev_ring_create(name,
580 internal_args->rx_queues,
581 internal_args->nb_rx_queues,
582 internal_args->tx_queues,
583 internal_args->nb_tx_queues,
584 internal_args->numa_node,
590 ret = rte_kvargs_count(kvlist, ETH_RING_NUMA_NODE_ACTION_ARG);
591 info = rte_zmalloc("struct node_action_list",
592 sizeof(struct node_action_list) +
593 (sizeof(struct node_action_pair) * ret),
599 info->list = (struct node_action_pair*)(info + 1);
601 ret = rte_kvargs_process(kvlist, ETH_RING_NUMA_NODE_ACTION_ARG,
607 for (info->count = 0; info->count < info->total; info->count++) {
608 ret = eth_dev_ring_create(info->list[info->count].name,
609 info->list[info->count].node,
610 info->list[info->count].action,
613 (info->list[info->count].action == DEV_CREATE)) {
615 "Attach to pmd_ring for %s",
617 ret = eth_dev_ring_create(name,
618 info->list[info->count].node,
627 eth_dev->device = &dev->device;
630 rte_kvargs_free(kvlist);
636 rte_pmd_ring_remove(struct rte_vdev_device *dev)
638 const char *name = rte_vdev_device_name(dev);
639 struct rte_eth_dev *eth_dev = NULL;
640 struct pmd_internals *internals = NULL;
641 struct ring_queue *r = NULL;
644 PMD_LOG(INFO, "Un-Initializing pmd_ring for %s", name);
649 /* find an ethdev entry */
650 eth_dev = rte_eth_dev_allocated(name);
654 eth_dev_stop(eth_dev);
656 internals = eth_dev->data->dev_private;
657 if (internals->action == DEV_CREATE) {
659 * it is only necessary to delete the rings in rx_queues because
660 * they are the same used in tx_queues
662 for (i = 0; i < eth_dev->data->nb_rx_queues; i++) {
663 r = eth_dev->data->rx_queues[i];
664 rte_ring_free(r->rng);
668 rte_free(eth_dev->data->rx_queues);
669 rte_free(eth_dev->data->tx_queues);
670 rte_free(eth_dev->data->dev_private);
672 rte_eth_dev_release_port(eth_dev);
676 static struct rte_vdev_driver pmd_ring_drv = {
677 .probe = rte_pmd_ring_probe,
678 .remove = rte_pmd_ring_remove,
681 RTE_PMD_REGISTER_VDEV(net_ring, pmd_ring_drv);
682 RTE_PMD_REGISTER_ALIAS(net_ring, eth_ring);
683 RTE_PMD_REGISTER_PARAM_STRING(net_ring,
684 ETH_RING_NUMA_NODE_ACTION_ARG "=name:node:action(ATTACH|CREATE)");
686 RTE_INIT(eth_ring_init_log);
688 eth_ring_init_log(void)
690 eth_ring_logtype = rte_log_register("pmd.net.ring");
691 if (eth_ring_logtype >= 0)
692 rte_log_set_level(eth_ring_logtype, RTE_LOG_NOTICE);