4 * Copyright(c) 2010-2014 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_string_fns.h>
41 #include <rte_kvargs.h>
43 #define ETH_RING_NUMA_NODE_ACTION_ARG "nodeaction"
44 #define ETH_RING_ACTION_CREATE "CREATE"
45 #define ETH_RING_ACTION_ATTACH "ATTACH"
47 static const char *valid_arguments[] = {
48 ETH_RING_NUMA_NODE_ACTION_ARG,
54 rte_atomic64_t rx_pkts;
55 rte_atomic64_t tx_pkts;
56 rte_atomic64_t err_pkts;
59 struct pmd_internals {
60 unsigned nb_rx_queues;
61 unsigned nb_tx_queues;
63 struct ring_queue rx_ring_queues[RTE_PMD_RING_MAX_RX_RINGS];
64 struct ring_queue tx_ring_queues[RTE_PMD_RING_MAX_TX_RINGS];
68 static struct ether_addr eth_addr = { .addr_bytes = {0} };
69 static const char *drivername = "Rings PMD";
70 static struct rte_eth_link pmd_link = {
72 .link_duplex = ETH_LINK_FULL_DUPLEX,
77 eth_ring_rx(void *q, struct rte_mbuf **bufs, uint16_t nb_bufs)
79 void **ptrs = (void *)&bufs[0];
80 struct ring_queue *r = q;
81 const uint16_t nb_rx = (uint16_t)rte_ring_dequeue_burst(r->rng,
83 if (r->rng->flags & RING_F_SC_DEQ)
84 r->rx_pkts.cnt += nb_rx;
86 rte_atomic64_add(&(r->rx_pkts), nb_rx);
91 eth_ring_tx(void *q, struct rte_mbuf **bufs, uint16_t nb_bufs)
93 void **ptrs = (void *)&bufs[0];
94 struct ring_queue *r = q;
95 const uint16_t nb_tx = (uint16_t)rte_ring_enqueue_burst(r->rng,
97 if (r->rng->flags & RING_F_SP_ENQ) {
98 r->tx_pkts.cnt += nb_tx;
99 r->err_pkts.cnt += nb_bufs - nb_tx;
101 rte_atomic64_add(&(r->tx_pkts), nb_tx);
102 rte_atomic64_add(&(r->err_pkts), nb_bufs - nb_tx);
108 eth_dev_configure(struct rte_eth_dev *dev __rte_unused) { return 0; }
111 eth_dev_start(struct rte_eth_dev *dev)
113 dev->data->dev_link.link_status = 1;
118 eth_dev_stop(struct rte_eth_dev *dev)
120 dev->data->dev_link.link_status = 0;
124 eth_rx_queue_setup(struct rte_eth_dev *dev,uint16_t rx_queue_id,
125 uint16_t nb_rx_desc __rte_unused,
126 unsigned int socket_id __rte_unused,
127 const struct rte_eth_rxconf *rx_conf __rte_unused,
128 struct rte_mempool *mb_pool __rte_unused)
130 struct pmd_internals *internals = dev->data->dev_private;
131 dev->data->rx_queues[rx_queue_id] = &internals->rx_ring_queues[rx_queue_id];
136 eth_tx_queue_setup(struct rte_eth_dev *dev, uint16_t tx_queue_id,
137 uint16_t nb_tx_desc __rte_unused,
138 unsigned int socket_id __rte_unused,
139 const struct rte_eth_txconf *tx_conf __rte_unused)
141 struct pmd_internals *internals = dev->data->dev_private;
142 dev->data->tx_queues[tx_queue_id] = &internals->tx_ring_queues[tx_queue_id];
148 eth_dev_info(struct rte_eth_dev *dev,
149 struct rte_eth_dev_info *dev_info)
151 struct pmd_internals *internals = dev->data->dev_private;
152 dev_info->driver_name = drivername;
153 dev_info->max_mac_addrs = 1;
154 dev_info->max_rx_pktlen = (uint32_t)-1;
155 dev_info->max_rx_queues = (uint16_t)internals->nb_rx_queues;
156 dev_info->max_tx_queues = (uint16_t)internals->nb_tx_queues;
157 dev_info->min_rx_bufsize = 0;
158 dev_info->pci_dev = NULL;
162 eth_stats_get(struct rte_eth_dev *dev, struct rte_eth_stats *igb_stats)
165 unsigned long rx_total = 0, tx_total = 0, tx_err_total = 0;
166 const struct pmd_internals *internal = dev->data->dev_private;
168 memset(igb_stats, 0, sizeof(*igb_stats));
169 for (i = 0; i < RTE_ETHDEV_QUEUE_STAT_CNTRS &&
170 i < internal->nb_rx_queues; i++) {
171 igb_stats->q_ipackets[i] = internal->rx_ring_queues[i].rx_pkts.cnt;
172 rx_total += igb_stats->q_ipackets[i];
175 for (i = 0; i < RTE_ETHDEV_QUEUE_STAT_CNTRS &&
176 i < internal->nb_tx_queues; i++) {
177 igb_stats->q_opackets[i] = internal->tx_ring_queues[i].tx_pkts.cnt;
178 igb_stats->q_errors[i] = internal->tx_ring_queues[i].err_pkts.cnt;
179 tx_total += igb_stats->q_opackets[i];
180 tx_err_total += igb_stats->q_errors[i];
183 igb_stats->ipackets = rx_total;
184 igb_stats->opackets = tx_total;
185 igb_stats->oerrors = tx_err_total;
189 eth_stats_reset(struct rte_eth_dev *dev)
192 struct pmd_internals *internal = dev->data->dev_private;
193 for (i = 0; i < internal->nb_rx_queues; i++)
194 internal->rx_ring_queues[i].rx_pkts.cnt = 0;
195 for (i = 0; i < internal->nb_tx_queues; i++) {
196 internal->tx_ring_queues[i].tx_pkts.cnt = 0;
197 internal->tx_ring_queues[i].err_pkts.cnt = 0;
202 eth_queue_release(void *q __rte_unused) { ; }
204 eth_link_update(struct rte_eth_dev *dev __rte_unused,
205 int wait_to_complete __rte_unused) { return 0; }
207 static struct eth_dev_ops ops = {
208 .dev_start = eth_dev_start,
209 .dev_stop = eth_dev_stop,
210 .dev_configure = eth_dev_configure,
211 .dev_infos_get = eth_dev_info,
212 .rx_queue_setup = eth_rx_queue_setup,
213 .tx_queue_setup = eth_tx_queue_setup,
214 .rx_queue_release = eth_queue_release,
215 .tx_queue_release = eth_queue_release,
216 .link_update = eth_link_update,
217 .stats_get = eth_stats_get,
218 .stats_reset = eth_stats_reset,
222 rte_eth_from_rings(const char *name, struct rte_ring *const rx_queues[],
223 const unsigned nb_rx_queues,
224 struct rte_ring *const tx_queues[],
225 const unsigned nb_tx_queues,
226 const unsigned numa_node)
228 struct rte_eth_dev_data *data = NULL;
229 struct rte_pci_device *pci_dev = NULL;
230 struct pmd_internals *internals = NULL;
231 struct rte_eth_dev *eth_dev = NULL;
234 /* do some parameter checking */
235 if (rx_queues == NULL && nb_rx_queues > 0)
237 if (tx_queues == NULL && nb_tx_queues > 0)
240 RTE_LOG(INFO, PMD, "Creating rings-backed ethdev on numa socket %u\n",
243 /* now do all data allocation - for eth_dev structure, dummy pci driver
244 * and internal (private) data
246 data = rte_zmalloc_socket(name, sizeof(*data), 0, numa_node);
250 pci_dev = rte_zmalloc_socket(name, sizeof(*pci_dev), 0, numa_node);
254 internals = rte_zmalloc_socket(name, sizeof(*internals), 0, numa_node);
255 if (internals == NULL)
258 /* reserve an ethdev entry */
259 eth_dev = rte_eth_dev_allocate(name);
263 /* now put it all together
264 * - store queue data in internals,
265 * - store numa_node info in pci_driver
266 * - point eth_dev_data to internals and pci_driver
267 * - and point eth_dev structure to new eth_dev_data structure
269 /* NOTE: we'll replace the data element, of originally allocated eth_dev
270 * so the rings are local per-process */
272 internals->nb_rx_queues = nb_rx_queues;
273 internals->nb_tx_queues = nb_tx_queues;
274 for (i = 0; i < nb_rx_queues; i++) {
275 internals->rx_ring_queues[i].rng = rx_queues[i];
277 for (i = 0; i < nb_tx_queues; i++) {
278 internals->tx_ring_queues[i].rng = tx_queues[i];
281 pci_dev->numa_node = numa_node;
283 data->dev_private = internals;
284 data->port_id = eth_dev->data->port_id;
285 data->nb_rx_queues = (uint16_t)nb_rx_queues;
286 data->nb_tx_queues = (uint16_t)nb_tx_queues;
287 data->dev_link = pmd_link;
288 data->mac_addrs = ð_addr;
290 eth_dev ->data = data;
291 eth_dev ->dev_ops = &ops;
292 eth_dev ->pci_dev = pci_dev;
294 /* finally assign rx and tx ops */
295 eth_dev->rx_pkt_burst = eth_ring_rx;
296 eth_dev->tx_pkt_burst = eth_ring_tx;
316 eth_dev_ring_create(const char *name, const unsigned numa_node,
317 enum dev_action action)
319 /* rx and tx are so-called from point of view of first port.
320 * They are inverted from the point of view of second port
322 struct rte_ring *rxtx[RTE_PMD_RING_MAX_RX_RINGS];
324 char rng_name[RTE_RING_NAMESIZE];
325 unsigned num_rings = RTE_MIN(RTE_PMD_RING_MAX_RX_RINGS,
326 RTE_PMD_RING_MAX_TX_RINGS);
328 for (i = 0; i < num_rings; i++) {
329 snprintf(rng_name, sizeof(rng_name), "ETH_RXTX%u_%s", i, name);
330 rxtx[i] = (action == DEV_CREATE) ?
331 rte_ring_create(rng_name, 1024, numa_node,
332 RING_F_SP_ENQ|RING_F_SC_DEQ) :
333 rte_ring_lookup(rng_name);
338 if (rte_eth_from_rings(name, rxtx, num_rings, rxtx, num_rings, numa_node))
346 eth_dev_ring_pair_create(const char *name, const unsigned numa_node,
347 enum dev_action action)
349 /* rx and tx are so-called from point of view of first port.
350 * They are inverted from the point of view of second port
352 struct rte_ring *rx[RTE_PMD_RING_MAX_RX_RINGS];
353 struct rte_ring *tx[RTE_PMD_RING_MAX_TX_RINGS];
355 char rx_rng_name[RTE_RING_NAMESIZE];
356 char tx_rng_name[RTE_RING_NAMESIZE];
357 unsigned num_rings = RTE_MIN(RTE_PMD_RING_MAX_RX_RINGS,
358 RTE_PMD_RING_MAX_TX_RINGS);
360 for (i = 0; i < num_rings; i++) {
361 snprintf(rx_rng_name, sizeof(rx_rng_name), "ETH_RX%u_%s", i, name);
362 rx[i] = (action == DEV_CREATE) ?
363 rte_ring_create(rx_rng_name, 1024, numa_node,
364 RING_F_SP_ENQ|RING_F_SC_DEQ) :
365 rte_ring_lookup(rx_rng_name);
368 snprintf(tx_rng_name, sizeof(tx_rng_name), "ETH_TX%u_%s", i, name);
369 tx[i] = (action == DEV_CREATE) ?
370 rte_ring_create(tx_rng_name, 1024, numa_node,
371 RING_F_SP_ENQ|RING_F_SC_DEQ):
372 rte_ring_lookup(tx_rng_name);
377 if (rte_eth_from_rings(rx_rng_name, rx, num_rings, tx, num_rings,
378 numa_node) || rte_eth_from_rings(tx_rng_name, tx, num_rings, rx,
379 num_rings, numa_node))
386 rte_eth_ring_pair_create(const char *name, const unsigned numa_node)
388 RTE_LOG(WARNING, PMD, "rte_eth_ring_pair_create is deprecated\n");
389 return eth_dev_ring_pair_create(name, numa_node, DEV_CREATE);
393 rte_eth_ring_pair_attach(const char *name, const unsigned numa_node)
395 RTE_LOG(WARNING, PMD, "rte_eth_ring_pair_attach is deprecated\n");
396 return eth_dev_ring_pair_create(name, numa_node, DEV_ATTACH);
399 struct node_action_pair {
402 enum dev_action action;
405 struct node_action_list {
408 struct node_action_pair *list;
411 static int parse_kvlist (const char *key __rte_unused, const char *value, void *data)
413 struct node_action_list *info = data;
420 name = strdup(value);
425 RTE_LOG(WARNING, PMD, "command line paramter is empty for ring pmd!\n");
429 node = strchr(name, ':');
431 RTE_LOG(WARNING, PMD, "could not parse node value from %s", name);
438 action = strchr(node, ':');
440 RTE_LOG(WARNING, PMD, "could not action value from %s", node);
448 * Need to do some sanity checking here
451 if (strcmp(action, ETH_RING_ACTION_ATTACH) == 0)
452 info->list[info->count].action = DEV_ATTACH;
453 else if (strcmp(action, ETH_RING_ACTION_CREATE) == 0)
454 info->list[info->count].action = DEV_CREATE;
459 info->list[info->count].node = strtol(node, &end, 10);
461 if ((errno != 0) || (*end != '\0')) {
462 RTE_LOG(WARNING, PMD, "node value %s is unparseable as a number\n", node);
466 snprintf(info->list[info->count].name, sizeof(info->list[info->count].name), "%s", name);
477 rte_pmd_ring_devinit(const char *name, const char *params)
479 struct rte_kvargs *kvlist;
481 struct node_action_list *info = NULL;
483 RTE_LOG(INFO, PMD, "Initializing pmd_ring for %s\n", name);
485 if (params == NULL || params[0] == '\0')
486 eth_dev_ring_create(name, rte_socket_id(), DEV_CREATE);
488 kvlist = rte_kvargs_parse(params, valid_arguments);
491 RTE_LOG(INFO, PMD, "Ignoring unsupported parameters when creating"
492 " rings-backed ethernet device\n");
493 eth_dev_ring_create(name, rte_socket_id(), DEV_CREATE);
496 ret = rte_kvargs_count(kvlist, ETH_RING_NUMA_NODE_ACTION_ARG);
497 info = rte_zmalloc("struct node_action_list", sizeof(struct node_action_list) +
498 (sizeof(struct node_action_pair) * ret), 0);
503 info->list = (struct node_action_pair*)(info + 1);
505 ret = rte_kvargs_process(kvlist, ETH_RING_NUMA_NODE_ACTION_ARG,
511 for (info->count = 0; info->count < info->total; info->count++) {
512 eth_dev_ring_create(name, info->list[info->count].node,
513 info->list[info->count].action);
524 static struct rte_driver pmd_ring_drv = {
527 .init = rte_pmd_ring_devinit,
530 PMD_REGISTER_DRIVER(pmd_ring_drv);