4 * Copyright(c) 2010-2015 Intel Corporation. All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
11 * * Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * * Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in
15 * the documentation and/or other materials provided with the
17 * * Neither the name of Intel Corporation nor the names of its
18 * contributors may be used to endorse or promote products derived
19 * from this software without specific prior written permission.
21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34 #include "rte_eth_ring.h"
36 #include <rte_ethdev.h>
37 #include <rte_malloc.h>
38 #include <rte_memcpy.h>
39 #include <rte_memzone.h>
40 #include <rte_string_fns.h>
42 #include <rte_kvargs.h>
43 #include <rte_errno.h>
45 #define ETH_RING_NUMA_NODE_ACTION_ARG "nodeaction"
46 #define ETH_RING_ACTION_CREATE "CREATE"
47 #define ETH_RING_ACTION_ATTACH "ATTACH"
49 static const char *valid_arguments[] = {
50 ETH_RING_NUMA_NODE_ACTION_ARG,
61 rte_atomic64_t rx_pkts;
62 rte_atomic64_t tx_pkts;
63 rte_atomic64_t err_pkts;
66 struct pmd_internals {
67 unsigned max_rx_queues;
68 unsigned max_tx_queues;
70 struct ring_queue rx_ring_queues[RTE_PMD_RING_MAX_RX_RINGS];
71 struct ring_queue tx_ring_queues[RTE_PMD_RING_MAX_TX_RINGS];
73 struct ether_addr address;
74 enum dev_action action;
78 static const char *drivername = "Rings PMD";
79 static struct rte_eth_link pmd_link = {
80 .link_speed = ETH_SPEED_NUM_10G,
81 .link_duplex = ETH_LINK_FULL_DUPLEX,
82 .link_status = ETH_LINK_DOWN,
83 .link_autoneg = ETH_LINK_SPEED_AUTONEG
87 eth_ring_rx(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_rx = (uint16_t)rte_ring_dequeue_burst(r->rng,
93 if (r->rng->flags & RING_F_SC_DEQ)
94 r->rx_pkts.cnt += nb_rx;
96 rte_atomic64_add(&(r->rx_pkts), nb_rx);
101 eth_ring_tx(void *q, struct rte_mbuf **bufs, uint16_t nb_bufs)
103 void **ptrs = (void *)&bufs[0];
104 struct ring_queue *r = q;
105 const uint16_t nb_tx = (uint16_t)rte_ring_enqueue_burst(r->rng,
107 if (r->rng->flags & RING_F_SP_ENQ) {
108 r->tx_pkts.cnt += nb_tx;
109 r->err_pkts.cnt += nb_bufs - nb_tx;
111 rte_atomic64_add(&(r->tx_pkts), nb_tx);
112 rte_atomic64_add(&(r->err_pkts), nb_bufs - nb_tx);
118 eth_dev_configure(struct rte_eth_dev *dev __rte_unused) { return 0; }
121 eth_dev_start(struct rte_eth_dev *dev)
123 dev->data->dev_link.link_status = ETH_LINK_UP;
128 eth_dev_stop(struct rte_eth_dev *dev)
130 dev->data->dev_link.link_status = ETH_LINK_DOWN;
134 eth_dev_set_link_down(struct rte_eth_dev *dev)
136 dev->data->dev_link.link_status = ETH_LINK_DOWN;
141 eth_dev_set_link_up(struct rte_eth_dev *dev)
143 dev->data->dev_link.link_status = ETH_LINK_UP;
148 eth_rx_queue_setup(struct rte_eth_dev *dev, uint16_t rx_queue_id,
149 uint16_t nb_rx_desc __rte_unused,
150 unsigned int socket_id __rte_unused,
151 const struct rte_eth_rxconf *rx_conf __rte_unused,
152 struct rte_mempool *mb_pool __rte_unused)
154 struct pmd_internals *internals = dev->data->dev_private;
155 dev->data->rx_queues[rx_queue_id] = &internals->rx_ring_queues[rx_queue_id];
160 eth_tx_queue_setup(struct rte_eth_dev *dev, uint16_t tx_queue_id,
161 uint16_t nb_tx_desc __rte_unused,
162 unsigned int socket_id __rte_unused,
163 const struct rte_eth_txconf *tx_conf __rte_unused)
165 struct pmd_internals *internals = dev->data->dev_private;
166 dev->data->tx_queues[tx_queue_id] = &internals->tx_ring_queues[tx_queue_id];
172 eth_dev_info(struct rte_eth_dev *dev,
173 struct rte_eth_dev_info *dev_info)
175 struct pmd_internals *internals = dev->data->dev_private;
176 dev_info->driver_name = drivername;
177 dev_info->max_mac_addrs = 1;
178 dev_info->max_rx_pktlen = (uint32_t)-1;
179 dev_info->max_rx_queues = (uint16_t)internals->max_rx_queues;
180 dev_info->max_tx_queues = (uint16_t)internals->max_tx_queues;
181 dev_info->min_rx_bufsize = 0;
182 dev_info->pci_dev = NULL;
186 eth_stats_get(struct rte_eth_dev *dev, struct rte_eth_stats *stats)
189 unsigned long rx_total = 0, tx_total = 0, tx_err_total = 0;
190 const struct pmd_internals *internal = dev->data->dev_private;
192 for (i = 0; i < RTE_ETHDEV_QUEUE_STAT_CNTRS &&
193 i < dev->data->nb_rx_queues; i++) {
194 stats->q_ipackets[i] = internal->rx_ring_queues[i].rx_pkts.cnt;
195 rx_total += stats->q_ipackets[i];
198 for (i = 0; i < RTE_ETHDEV_QUEUE_STAT_CNTRS &&
199 i < dev->data->nb_tx_queues; i++) {
200 stats->q_opackets[i] = internal->tx_ring_queues[i].tx_pkts.cnt;
201 stats->q_errors[i] = internal->tx_ring_queues[i].err_pkts.cnt;
202 tx_total += stats->q_opackets[i];
203 tx_err_total += stats->q_errors[i];
206 stats->ipackets = rx_total;
207 stats->opackets = tx_total;
208 stats->oerrors = tx_err_total;
212 eth_stats_reset(struct rte_eth_dev *dev)
215 struct pmd_internals *internal = dev->data->dev_private;
216 for (i = 0; i < dev->data->nb_rx_queues; i++)
217 internal->rx_ring_queues[i].rx_pkts.cnt = 0;
218 for (i = 0; i < dev->data->nb_tx_queues; i++) {
219 internal->tx_ring_queues[i].tx_pkts.cnt = 0;
220 internal->tx_ring_queues[i].err_pkts.cnt = 0;
225 eth_mac_addr_remove(struct rte_eth_dev *dev __rte_unused,
226 uint32_t index __rte_unused)
231 eth_mac_addr_add(struct rte_eth_dev *dev __rte_unused,
232 struct ether_addr *mac_addr __rte_unused,
233 uint32_t index __rte_unused,
234 uint32_t vmdq __rte_unused)
239 eth_queue_release(void *q __rte_unused) { ; }
241 eth_link_update(struct rte_eth_dev *dev __rte_unused,
242 int wait_to_complete __rte_unused) { return 0; }
244 static const struct eth_dev_ops ops = {
245 .dev_start = eth_dev_start,
246 .dev_stop = eth_dev_stop,
247 .dev_set_link_up = eth_dev_set_link_up,
248 .dev_set_link_down = eth_dev_set_link_down,
249 .dev_configure = eth_dev_configure,
250 .dev_infos_get = eth_dev_info,
251 .rx_queue_setup = eth_rx_queue_setup,
252 .tx_queue_setup = eth_tx_queue_setup,
253 .rx_queue_release = eth_queue_release,
254 .tx_queue_release = eth_queue_release,
255 .link_update = eth_link_update,
256 .stats_get = eth_stats_get,
257 .stats_reset = eth_stats_reset,
258 .mac_addr_remove = eth_mac_addr_remove,
259 .mac_addr_add = eth_mac_addr_add,
263 do_eth_dev_ring_create(const char *name,
264 struct rte_ring * const rx_queues[], const unsigned nb_rx_queues,
265 struct rte_ring *const tx_queues[], const unsigned nb_tx_queues,
266 const unsigned numa_node, enum dev_action action)
268 struct rte_eth_dev_data *data = NULL;
269 struct pmd_internals *internals = NULL;
270 struct rte_eth_dev *eth_dev = NULL;
273 RTE_LOG(INFO, PMD, "Creating rings-backed ethdev on numa socket %u\n",
276 /* now do all data allocation - for eth_dev structure, dummy pci driver
277 * and internal (private) data
279 data = rte_zmalloc_socket(name, sizeof(*data), 0, numa_node);
285 data->rx_queues = rte_zmalloc_socket(name,
286 sizeof(void *) * nb_rx_queues, 0, numa_node);
287 if (data->rx_queues == NULL) {
292 data->tx_queues = rte_zmalloc_socket(name,
293 sizeof(void *) * nb_tx_queues, 0, numa_node);
294 if (data->tx_queues == NULL) {
299 internals = rte_zmalloc_socket(name, sizeof(*internals), 0, numa_node);
300 if (internals == NULL) {
305 /* reserve an ethdev entry */
306 eth_dev = rte_eth_dev_allocate(name);
307 if (eth_dev == NULL) {
312 /* now put it all together
313 * - store queue data in internals,
314 * - store numa_node info in eth_dev_data
315 * - point eth_dev_data to internals
316 * - and point eth_dev structure to new eth_dev_data structure
318 /* NOTE: we'll replace the data element, of originally allocated eth_dev
319 * so the rings are local per-process */
321 internals->action = action;
322 internals->max_rx_queues = nb_rx_queues;
323 internals->max_tx_queues = nb_tx_queues;
324 for (i = 0; i < nb_rx_queues; i++) {
325 internals->rx_ring_queues[i].rng = rx_queues[i];
326 data->rx_queues[i] = &internals->rx_ring_queues[i];
328 for (i = 0; i < nb_tx_queues; i++) {
329 internals->tx_ring_queues[i].rng = tx_queues[i];
330 data->tx_queues[i] = &internals->tx_ring_queues[i];
333 data->dev_private = internals;
334 data->port_id = eth_dev->data->port_id;
335 memmove(data->name, eth_dev->data->name, sizeof(data->name));
336 data->nb_rx_queues = (uint16_t)nb_rx_queues;
337 data->nb_tx_queues = (uint16_t)nb_tx_queues;
338 data->dev_link = pmd_link;
339 data->mac_addrs = &internals->address;
341 eth_dev->data = data;
342 eth_dev->driver = NULL;
343 eth_dev->dev_ops = &ops;
344 data->dev_flags = RTE_ETH_DEV_DETACHABLE;
345 data->kdrv = RTE_KDRV_NONE;
346 data->drv_name = drivername;
347 data->numa_node = numa_node;
349 /* finally assign rx and tx ops */
350 eth_dev->rx_pkt_burst = eth_ring_rx;
351 eth_dev->tx_pkt_burst = eth_ring_tx;
353 return data->port_id;
357 rte_free(data->rx_queues);
358 rte_free(data->tx_queues);
367 rte_eth_from_rings(const char *name, struct rte_ring *const rx_queues[],
368 const unsigned nb_rx_queues,
369 struct rte_ring *const tx_queues[],
370 const unsigned nb_tx_queues,
371 const unsigned numa_node)
373 /* do some parameter checking */
374 if (rx_queues == NULL && nb_rx_queues > 0) {
378 if (tx_queues == NULL && nb_tx_queues > 0) {
382 if (nb_rx_queues > RTE_PMD_RING_MAX_RX_RINGS) {
387 return do_eth_dev_ring_create(name, rx_queues, nb_rx_queues,
388 tx_queues, nb_tx_queues, numa_node, DEV_ATTACH);
392 rte_eth_from_ring(struct rte_ring *r)
394 return rte_eth_from_rings(r->name, &r, 1, &r, 1,
395 r->memzone ? r->memzone->socket_id : SOCKET_ID_ANY);
399 eth_dev_ring_create(const char *name, const unsigned numa_node,
400 enum dev_action action)
402 /* rx and tx are so-called from point of view of first port.
403 * They are inverted from the point of view of second port
405 struct rte_ring *rxtx[RTE_PMD_RING_MAX_RX_RINGS];
407 char rng_name[RTE_RING_NAMESIZE];
408 unsigned num_rings = RTE_MIN(RTE_PMD_RING_MAX_RX_RINGS,
409 RTE_PMD_RING_MAX_TX_RINGS);
411 for (i = 0; i < num_rings; i++) {
412 snprintf(rng_name, sizeof(rng_name), "ETH_RXTX%u_%s", i, name);
413 rxtx[i] = (action == DEV_CREATE) ?
414 rte_ring_create(rng_name, 1024, numa_node,
415 RING_F_SP_ENQ|RING_F_SC_DEQ) :
416 rte_ring_lookup(rng_name);
421 if (do_eth_dev_ring_create(name, rxtx, num_rings, rxtx, num_rings,
422 numa_node, action) < 0)
428 struct node_action_pair {
431 enum dev_action action;
434 struct node_action_list {
437 struct node_action_pair *list;
440 static int parse_kvlist (const char *key __rte_unused, const char *value, void *data)
442 struct node_action_list *info = data;
449 name = strdup(value);
454 RTE_LOG(WARNING, PMD, "command line paramter is empty for ring pmd!\n");
458 node = strchr(name, ':');
460 RTE_LOG(WARNING, PMD, "could not parse node value from %s", name);
467 action = strchr(node, ':');
469 RTE_LOG(WARNING, PMD, "could not action value from %s", node);
477 * Need to do some sanity checking here
480 if (strcmp(action, ETH_RING_ACTION_ATTACH) == 0)
481 info->list[info->count].action = DEV_ATTACH;
482 else if (strcmp(action, ETH_RING_ACTION_CREATE) == 0)
483 info->list[info->count].action = DEV_CREATE;
488 info->list[info->count].node = strtol(node, &end, 10);
490 if ((errno != 0) || (*end != '\0')) {
491 RTE_LOG(WARNING, PMD, "node value %s is unparseable as a number\n", node);
495 snprintf(info->list[info->count].name, sizeof(info->list[info->count].name), "%s", name);
506 rte_pmd_ring_probe(const char *name, const char *params)
508 struct rte_kvargs *kvlist = NULL;
510 struct node_action_list *info = NULL;
512 RTE_LOG(INFO, PMD, "Initializing pmd_ring for %s\n", name);
514 if (params == NULL || params[0] == '\0') {
515 ret = eth_dev_ring_create(name, rte_socket_id(), DEV_CREATE);
518 "Attach to pmd_ring for %s\n", name);
519 ret = eth_dev_ring_create(name, rte_socket_id(),
524 kvlist = rte_kvargs_parse(params, valid_arguments);
527 RTE_LOG(INFO, PMD, "Ignoring unsupported parameters when creating"
528 " rings-backed ethernet device\n");
529 ret = eth_dev_ring_create(name, rte_socket_id(),
533 "Attach to pmd_ring for %s\n",
535 ret = eth_dev_ring_create(name, rte_socket_id(),
540 ret = rte_kvargs_count(kvlist, ETH_RING_NUMA_NODE_ACTION_ARG);
541 info = rte_zmalloc("struct node_action_list",
542 sizeof(struct node_action_list) +
543 (sizeof(struct node_action_pair) * ret),
549 info->list = (struct node_action_pair*)(info + 1);
551 ret = rte_kvargs_process(kvlist, ETH_RING_NUMA_NODE_ACTION_ARG,
557 for (info->count = 0; info->count < info->total; info->count++) {
558 ret = eth_dev_ring_create(info->list[info->count].name,
559 info->list[info->count].node,
560 info->list[info->count].action);
562 (info->list[info->count].action == DEV_CREATE)) {
564 "Attach to pmd_ring for %s\n",
566 ret = eth_dev_ring_create(name,
567 info->list[info->count].node,
575 rte_kvargs_free(kvlist);
581 rte_pmd_ring_remove(const char *name)
583 struct rte_eth_dev *eth_dev = NULL;
584 struct pmd_internals *internals = NULL;
585 struct ring_queue *r = NULL;
588 RTE_LOG(INFO, PMD, "Un-Initializing pmd_ring for %s\n", name);
593 /* find an ethdev entry */
594 eth_dev = rte_eth_dev_allocated(name);
598 eth_dev_stop(eth_dev);
600 internals = eth_dev->data->dev_private;
601 if (internals->action == DEV_CREATE) {
603 * it is only necessary to delete the rings in rx_queues because
604 * they are the same used in tx_queues
606 for (i = 0; i < eth_dev->data->nb_rx_queues; i++) {
607 r = eth_dev->data->rx_queues[i];
608 rte_ring_free(r->rng);
612 rte_free(eth_dev->data->rx_queues);
613 rte_free(eth_dev->data->tx_queues);
614 rte_free(eth_dev->data->dev_private);
616 rte_free(eth_dev->data);
618 rte_eth_dev_release_port(eth_dev);
622 static struct rte_vdev_driver pmd_ring_drv = {
623 .probe = rte_pmd_ring_probe,
624 .remove = rte_pmd_ring_remove,
627 RTE_PMD_REGISTER_VDEV(net_ring, pmd_ring_drv);
628 RTE_PMD_REGISTER_ALIAS(net_ring, eth_ring);
629 RTE_PMD_REGISTER_PARAM_STRING(net_ring,
630 ETH_RING_NUMA_NODE_ACTION_ARG "=name:node:action(ATTACH|CREATE)");