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