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