ring: create device from a ring
[dpdk.git] / drivers / net / ring / rte_eth_ring.c
1 /*-
2  *   BSD LICENSE
3  *
4  *   Copyright(c) 2010-2015 Intel Corporation. All rights reserved.
5  *   All rights reserved.
6  *
7  *   Redistribution and use in source and binary forms, with or without
8  *   modification, are permitted provided that the following conditions
9  *   are met:
10  *
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
16  *       distribution.
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.
20  *
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.
32  */
33
34 #include "rte_eth_ring.h"
35 #include <rte_mbuf.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>
41 #include <rte_dev.h>
42 #include <rte_kvargs.h>
43 #include <rte_errno.h>
44
45 #define ETH_RING_NUMA_NODE_ACTION_ARG   "nodeaction"
46 #define ETH_RING_ACTION_CREATE          "CREATE"
47 #define ETH_RING_ACTION_ATTACH          "ATTACH"
48
49 static const char *ring_ethdev_driver_name = "Ring PMD";
50
51 static const char *valid_arguments[] = {
52         ETH_RING_NUMA_NODE_ACTION_ARG,
53         NULL
54 };
55
56 struct ring_queue {
57         struct rte_ring *rng;
58         rte_atomic64_t rx_pkts;
59         rte_atomic64_t tx_pkts;
60         rte_atomic64_t err_pkts;
61 };
62
63 struct pmd_internals {
64         unsigned nb_rx_queues;
65         unsigned nb_tx_queues;
66
67         struct ring_queue rx_ring_queues[RTE_PMD_RING_MAX_RX_RINGS];
68         struct ring_queue tx_ring_queues[RTE_PMD_RING_MAX_TX_RINGS];
69
70         struct ether_addr address;
71 };
72
73
74 static const char *drivername = "Rings PMD";
75 static struct rte_eth_link pmd_link = {
76                 .link_speed = 10000,
77                 .link_duplex = ETH_LINK_FULL_DUPLEX,
78                 .link_status = 0
79 };
80
81 static uint16_t
82 eth_ring_rx(void *q, struct rte_mbuf **bufs, uint16_t nb_bufs)
83 {
84         void **ptrs = (void *)&bufs[0];
85         struct ring_queue *r = q;
86         const uint16_t nb_rx = (uint16_t)rte_ring_dequeue_burst(r->rng,
87                         ptrs, nb_bufs);
88         if (r->rng->flags & RING_F_SC_DEQ)
89                 r->rx_pkts.cnt += nb_rx;
90         else
91                 rte_atomic64_add(&(r->rx_pkts), nb_rx);
92         return nb_rx;
93 }
94
95 static uint16_t
96 eth_ring_tx(void *q, struct rte_mbuf **bufs, uint16_t nb_bufs)
97 {
98         void **ptrs = (void *)&bufs[0];
99         struct ring_queue *r = q;
100         const uint16_t nb_tx = (uint16_t)rte_ring_enqueue_burst(r->rng,
101                         ptrs, nb_bufs);
102         if (r->rng->flags & RING_F_SP_ENQ) {
103                 r->tx_pkts.cnt += nb_tx;
104                 r->err_pkts.cnt += nb_bufs - nb_tx;
105         } else {
106                 rte_atomic64_add(&(r->tx_pkts), nb_tx);
107                 rte_atomic64_add(&(r->err_pkts), nb_bufs - nb_tx);
108         }
109         return nb_tx;
110 }
111
112 static int
113 eth_dev_configure(struct rte_eth_dev *dev __rte_unused) { return 0; }
114
115 static int
116 eth_dev_start(struct rte_eth_dev *dev)
117 {
118         dev->data->dev_link.link_status = 1;
119         return 0;
120 }
121
122 static void
123 eth_dev_stop(struct rte_eth_dev *dev)
124 {
125         dev->data->dev_link.link_status = 0;
126 }
127
128 static int
129 eth_dev_set_link_down(struct rte_eth_dev *dev)
130 {
131         dev->data->dev_link.link_status = 0;
132         return 0;
133 }
134
135 static int
136 eth_dev_set_link_up(struct rte_eth_dev *dev)
137 {
138         dev->data->dev_link.link_status = 1;
139         return 0;
140 }
141
142 static int
143 eth_rx_queue_setup(struct rte_eth_dev *dev,uint16_t rx_queue_id,
144                                     uint16_t nb_rx_desc __rte_unused,
145                                     unsigned int socket_id __rte_unused,
146                                     const struct rte_eth_rxconf *rx_conf __rte_unused,
147                                     struct rte_mempool *mb_pool __rte_unused)
148 {
149         struct pmd_internals *internals = dev->data->dev_private;
150         dev->data->rx_queues[rx_queue_id] = &internals->rx_ring_queues[rx_queue_id];
151         return 0;
152 }
153
154 static int
155 eth_tx_queue_setup(struct rte_eth_dev *dev, uint16_t tx_queue_id,
156                                     uint16_t nb_tx_desc __rte_unused,
157                                     unsigned int socket_id __rte_unused,
158                                     const struct rte_eth_txconf *tx_conf __rte_unused)
159 {
160         struct pmd_internals *internals = dev->data->dev_private;
161         dev->data->tx_queues[tx_queue_id] = &internals->tx_ring_queues[tx_queue_id];
162         return 0;
163 }
164
165
166 static void
167 eth_dev_info(struct rte_eth_dev *dev,
168                 struct rte_eth_dev_info *dev_info)
169 {
170         struct pmd_internals *internals = dev->data->dev_private;
171         dev_info->driver_name = drivername;
172         dev_info->max_mac_addrs = 1;
173         dev_info->max_rx_pktlen = (uint32_t)-1;
174         dev_info->max_rx_queues = (uint16_t)internals->nb_rx_queues;
175         dev_info->max_tx_queues = (uint16_t)internals->nb_tx_queues;
176         dev_info->min_rx_bufsize = 0;
177         dev_info->pci_dev = NULL;
178 }
179
180 static void
181 eth_stats_get(struct rte_eth_dev *dev, struct rte_eth_stats *igb_stats)
182 {
183         unsigned i;
184         unsigned long rx_total = 0, tx_total = 0, tx_err_total = 0;
185         const struct pmd_internals *internal = dev->data->dev_private;
186
187         for (i = 0; i < RTE_ETHDEV_QUEUE_STAT_CNTRS &&
188                         i < internal->nb_rx_queues; i++) {
189                 igb_stats->q_ipackets[i] = internal->rx_ring_queues[i].rx_pkts.cnt;
190                 rx_total += igb_stats->q_ipackets[i];
191         }
192
193         for (i = 0; i < RTE_ETHDEV_QUEUE_STAT_CNTRS &&
194                         i < internal->nb_tx_queues; i++) {
195                 igb_stats->q_opackets[i] = internal->tx_ring_queues[i].tx_pkts.cnt;
196                 igb_stats->q_errors[i] = internal->tx_ring_queues[i].err_pkts.cnt;
197                 tx_total += igb_stats->q_opackets[i];
198                 tx_err_total += igb_stats->q_errors[i];
199         }
200
201         igb_stats->ipackets = rx_total;
202         igb_stats->opackets = tx_total;
203         igb_stats->oerrors = tx_err_total;
204 }
205
206 static void
207 eth_stats_reset(struct rte_eth_dev *dev)
208 {
209         unsigned i;
210         struct pmd_internals *internal = dev->data->dev_private;
211         for (i = 0; i < internal->nb_rx_queues; i++)
212                 internal->rx_ring_queues[i].rx_pkts.cnt = 0;
213         for (i = 0; i < internal->nb_tx_queues; i++) {
214                 internal->tx_ring_queues[i].tx_pkts.cnt = 0;
215                 internal->tx_ring_queues[i].err_pkts.cnt = 0;
216         }
217 }
218
219 static void
220 eth_mac_addr_remove(struct rte_eth_dev *dev __rte_unused,
221         uint32_t index __rte_unused)
222 {
223 }
224
225 static void
226 eth_mac_addr_add(struct rte_eth_dev *dev __rte_unused,
227         struct ether_addr *mac_addr __rte_unused,
228         uint32_t index __rte_unused,
229         uint32_t vmdq __rte_unused)
230 {
231 }
232
233 static void
234 eth_queue_release(void *q __rte_unused) { ; }
235 static int
236 eth_link_update(struct rte_eth_dev *dev __rte_unused,
237                 int wait_to_complete __rte_unused) { return 0; }
238
239 static const struct eth_dev_ops ops = {
240         .dev_start = eth_dev_start,
241         .dev_stop = eth_dev_stop,
242         .dev_set_link_up = eth_dev_set_link_up,
243         .dev_set_link_down = eth_dev_set_link_down,
244         .dev_configure = eth_dev_configure,
245         .dev_infos_get = eth_dev_info,
246         .rx_queue_setup = eth_rx_queue_setup,
247         .tx_queue_setup = eth_tx_queue_setup,
248         .rx_queue_release = eth_queue_release,
249         .tx_queue_release = eth_queue_release,
250         .link_update = eth_link_update,
251         .stats_get = eth_stats_get,
252         .stats_reset = eth_stats_reset,
253         .mac_addr_remove = eth_mac_addr_remove,
254         .mac_addr_add = eth_mac_addr_add,
255 };
256
257 static struct eth_driver rte_ring_pmd = {
258         .pci_drv = {
259                 .name = "rte_ring_pmd",
260                 .drv_flags = RTE_PCI_DRV_DETACHABLE,
261         },
262 };
263
264 static struct rte_pci_id id_table;
265
266 int
267 rte_eth_from_rings(const char *name, struct rte_ring *const rx_queues[],
268                 const unsigned nb_rx_queues,
269                 struct rte_ring *const tx_queues[],
270                 const unsigned nb_tx_queues,
271                 const unsigned numa_node)
272 {
273         struct rte_eth_dev_data *data = NULL;
274         struct rte_pci_device *pci_dev = NULL;
275         struct pmd_internals *internals = NULL;
276         struct rte_eth_dev *eth_dev = NULL;
277
278         unsigned i;
279
280         /* do some parameter checking */
281         if (rx_queues == NULL && nb_rx_queues > 0) {
282                 rte_errno = EINVAL;
283                 goto error;
284         }
285         if (tx_queues == NULL && nb_tx_queues > 0) {
286                 rte_errno = EINVAL;
287                 goto error;
288         }
289         if (nb_rx_queues > RTE_PMD_RING_MAX_RX_RINGS) {
290                 rte_errno = EINVAL;
291                 goto error;
292         }
293
294         RTE_LOG(INFO, PMD, "Creating rings-backed ethdev on numa socket %u\n",
295                         numa_node);
296
297         /* now do all data allocation - for eth_dev structure, dummy pci driver
298          * and internal (private) data
299          */
300         data = rte_zmalloc_socket(name, sizeof(*data), 0, numa_node);
301         if (data == NULL) {
302                 rte_errno = ENOMEM;
303                 goto error;
304         }
305
306         data->rx_queues = rte_zmalloc_socket(name, sizeof(void *) * nb_rx_queues,
307                         0, numa_node);
308         if (data->rx_queues == NULL) {
309                 rte_errno = ENOMEM;
310                 goto error;
311         }
312
313         data->tx_queues = rte_zmalloc_socket(name, sizeof(void *) * nb_tx_queues,
314                         0, numa_node);
315         if (data->tx_queues == NULL) {
316                 rte_errno = ENOMEM;
317                 goto error;
318         }
319
320         pci_dev = rte_zmalloc_socket(name, sizeof(*pci_dev), 0, numa_node);
321         if (pci_dev == NULL) {
322                 rte_errno = ENOMEM;
323                 goto error;
324         }
325
326         internals = rte_zmalloc_socket(name, sizeof(*internals), 0, numa_node);
327         if (internals == NULL) {
328                 rte_errno = ENOMEM;
329                 goto error;
330         }
331
332         /* reserve an ethdev entry */
333         eth_dev = rte_eth_dev_allocate(name, RTE_ETH_DEV_VIRTUAL);
334         if (eth_dev == NULL) {
335                 rte_errno = ENOSPC;
336                 goto error;
337         }
338
339
340         /* now put it all together
341          * - store queue data in internals,
342          * - store numa_node info in pci_driver
343          * - point eth_dev_data to internals and pci_driver
344          * - and point eth_dev structure to new eth_dev_data structure
345          */
346         /* NOTE: we'll replace the data element, of originally allocated eth_dev
347          * so the rings are local per-process */
348
349         internals->nb_rx_queues = nb_rx_queues;
350         internals->nb_tx_queues = nb_tx_queues;
351         for (i = 0; i < nb_rx_queues; i++) {
352                 internals->rx_ring_queues[i].rng = rx_queues[i];
353                 data->rx_queues[i] = &internals->rx_ring_queues[i];
354         }
355         for (i = 0; i < nb_tx_queues; i++) {
356                 internals->tx_ring_queues[i].rng = tx_queues[i];
357                 data->tx_queues[i] = &internals->tx_ring_queues[i];
358         }
359
360         rte_ring_pmd.pci_drv.name = ring_ethdev_driver_name;
361         rte_ring_pmd.pci_drv.id_table = &id_table;
362
363         pci_dev->numa_node = numa_node;
364         pci_dev->driver = &rte_ring_pmd.pci_drv;
365
366         data->dev_private = internals;
367         data->port_id = eth_dev->data->port_id;
368         memmove(data->name, eth_dev->data->name, sizeof(data->name));
369         data->nb_rx_queues = (uint16_t)nb_rx_queues;
370         data->nb_tx_queues = (uint16_t)nb_tx_queues;
371         data->dev_link = pmd_link;
372         data->mac_addrs = &internals->address;
373
374         eth_dev->data = data;
375         eth_dev->driver = &rte_ring_pmd;
376         eth_dev->dev_ops = &ops;
377         eth_dev->pci_dev = pci_dev;
378         TAILQ_INIT(&(eth_dev->link_intr_cbs));
379
380         /* finally assign rx and tx ops */
381         eth_dev->rx_pkt_burst = eth_ring_rx;
382         eth_dev->tx_pkt_burst = eth_ring_tx;
383
384         return data->port_id;
385
386 error:
387         rte_free(data->rx_queues);
388         rte_free(data->tx_queues);
389         rte_free(data);
390         rte_free(pci_dev);
391         rte_free(internals);
392
393         return -1;
394 }
395
396 int
397 rte_eth_from_ring(struct rte_ring *r)
398 {
399         return rte_eth_from_rings(r->name, &r, 1, &r, 1,
400                         r->memzone ? r->memzone->socket_id : SOCKET_ID_ANY);
401 }
402
403 enum dev_action{
404         DEV_CREATE,
405         DEV_ATTACH
406 };
407
408 static int
409 eth_dev_ring_create(const char *name, const unsigned numa_node,
410                 enum dev_action action)
411 {
412         /* rx and tx are so-called from point of view of first port.
413          * They are inverted from the point of view of second port
414          */
415         struct rte_ring *rxtx[RTE_PMD_RING_MAX_RX_RINGS];
416         unsigned i;
417         char rng_name[RTE_RING_NAMESIZE];
418         unsigned num_rings = RTE_MIN(RTE_PMD_RING_MAX_RX_RINGS,
419                         RTE_PMD_RING_MAX_TX_RINGS);
420
421         for (i = 0; i < num_rings; i++) {
422                 snprintf(rng_name, sizeof(rng_name), "ETH_RXTX%u_%s", i, name);
423                 rxtx[i] = (action == DEV_CREATE) ?
424                                 rte_ring_create(rng_name, 1024, numa_node,
425                                                 RING_F_SP_ENQ|RING_F_SC_DEQ) :
426                                 rte_ring_lookup(rng_name);
427                 if (rxtx[i] == NULL)
428                         return -1;
429         }
430
431         if (rte_eth_from_rings(name, rxtx, num_rings, rxtx, num_rings, numa_node) < 0)
432                 return -1;
433
434         return 0;
435 }
436
437 struct node_action_pair {
438         char name[PATH_MAX];
439         unsigned node;
440         enum dev_action action;
441 };
442
443 struct node_action_list {
444         unsigned total;
445         unsigned count;
446         struct node_action_pair *list;
447 };
448
449 static int parse_kvlist (const char *key __rte_unused, const char *value, void *data)
450 {
451         struct node_action_list *info = data;
452         int ret;
453         char *name;
454         char *action;
455         char *node;
456         char *end;
457
458         name = strdup(value);
459
460         ret = -EINVAL;
461
462         if (!name) {
463                 RTE_LOG(WARNING, PMD, "command line paramter is empty for ring pmd!\n");
464                 goto out;
465         }
466
467         node = strchr(name, ':');
468         if (!node) {
469                 RTE_LOG(WARNING, PMD, "could not parse node value from %s", name);
470                 goto out;
471         }
472
473         *node = '\0';
474         node++;
475
476         action = strchr(node, ':');
477         if (!action) {
478                 RTE_LOG(WARNING, PMD, "could not action value from %s", node);
479                 goto out;
480         }
481
482         *action = '\0';
483         action++;
484
485         /*
486          * Need to do some sanity checking here
487          */
488
489         if (strcmp(action, ETH_RING_ACTION_ATTACH) == 0)
490                 info->list[info->count].action = DEV_ATTACH;
491         else if (strcmp(action, ETH_RING_ACTION_CREATE) == 0)
492                 info->list[info->count].action = DEV_CREATE;
493         else
494                 goto out;
495
496         errno = 0;
497         info->list[info->count].node = strtol(node, &end, 10);
498
499         if ((errno != 0) || (*end != '\0')) {
500                 RTE_LOG(WARNING, PMD, "node value %s is unparseable as a number\n", node);
501                 goto out;
502         }
503
504         snprintf(info->list[info->count].name, sizeof(info->list[info->count].name), "%s", name);
505
506         info->count++;
507
508         ret = 0;
509 out:
510         free(name);
511         return ret;
512 }
513
514 static int
515 rte_pmd_ring_devinit(const char *name, const char *params)
516 {
517         struct rte_kvargs *kvlist = NULL;
518         int ret = 0;
519         struct node_action_list *info = NULL;
520
521         RTE_LOG(INFO, PMD, "Initializing pmd_ring for %s\n", name);
522
523         if (params == NULL || params[0] == '\0') {
524                 ret = eth_dev_ring_create(name, rte_socket_id(), DEV_CREATE);
525                 if (ret == -1) {
526                         RTE_LOG(INFO, PMD,
527                                 "Attach to pmd_ring for %s\n", name);
528                         ret = eth_dev_ring_create(name, rte_socket_id(),
529                                                   DEV_ATTACH);
530                 }
531         }
532         else {
533                 kvlist = rte_kvargs_parse(params, valid_arguments);
534
535                 if (!kvlist) {
536                         RTE_LOG(INFO, PMD, "Ignoring unsupported parameters when creating"
537                                         " rings-backed ethernet device\n");
538                         ret = eth_dev_ring_create(name, rte_socket_id(),
539                                                   DEV_CREATE);
540                         if (ret == -1) {
541                                 RTE_LOG(INFO, PMD,
542                                         "Attach to pmd_ring for %s\n",
543                                         name);
544                                 ret = eth_dev_ring_create(name, rte_socket_id(),
545                                                           DEV_ATTACH);
546                         }
547                         return ret;
548                 } else {
549                         ret = rte_kvargs_count(kvlist, ETH_RING_NUMA_NODE_ACTION_ARG);
550                         info = rte_zmalloc("struct node_action_list",
551                                            sizeof(struct node_action_list) +
552                                            (sizeof(struct node_action_pair) * ret),
553                                            0);
554                         if (!info)
555                                 goto out_free;
556
557                         info->total = ret;
558                         info->list = (struct node_action_pair*)(info + 1);
559
560                         ret = rte_kvargs_process(kvlist, ETH_RING_NUMA_NODE_ACTION_ARG,
561                                                  parse_kvlist, info);
562
563                         if (ret < 0)
564                                 goto out_free;
565
566                         for (info->count = 0; info->count < info->total; info->count++) {
567                                 ret = eth_dev_ring_create(name,
568                                                           info->list[info->count].node,
569                                                           info->list[info->count].action);
570                                 if ((ret == -1) &&
571                                     (info->list[info->count].action == DEV_CREATE)) {
572                                         RTE_LOG(INFO, PMD,
573                                                 "Attach to pmd_ring for %s\n",
574                                                 name);
575                                         ret = eth_dev_ring_create(name,
576                                                         info->list[info->count].node,
577                                                         DEV_ATTACH);
578                                 }
579                         }
580                 }
581         }
582
583 out_free:
584         rte_kvargs_free(kvlist);
585         rte_free(info);
586         return ret;
587 }
588
589 static int
590 rte_pmd_ring_devuninit(const char *name)
591 {
592         struct rte_eth_dev *eth_dev = NULL;
593
594         RTE_LOG(INFO, PMD, "Un-Initializing pmd_ring for %s\n", name);
595
596         if (name == NULL)
597                 return -EINVAL;
598
599         /* find an ethdev entry */
600         eth_dev = rte_eth_dev_allocated(name);
601         if (eth_dev == NULL)
602                 return -ENODEV;
603
604         eth_dev_stop(eth_dev);
605         rte_free(eth_dev->data->dev_private);
606         rte_free(eth_dev->data);
607         rte_free(eth_dev->pci_dev);
608
609         rte_eth_dev_release_port(eth_dev);
610         return 0;
611 }
612
613 static struct rte_driver pmd_ring_drv = {
614         .name = "eth_ring",
615         .type = PMD_VDEV,
616         .init = rte_pmd_ring_devinit,
617         .uninit = rte_pmd_ring_devuninit,
618 };
619
620 PMD_REGISTER_DRIVER(pmd_ring_drv);