examples/l2fwd-cat/l2fwd-cat.c

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(c) 2016 Intel Corporation
   3  */
   4
   5 #include <stdint.h>
   6 #include <inttypes.h>
   7 #include <rte_eal.h>
   8 #include <rte_ethdev.h>
   9 #include <rte_cycles.h>
  10 #include <rte_lcore.h>
  11 #include <rte_mbuf.h>
  12
  13 #include "cat.h"
  14
  15 #define RX_RING_SIZE 128
  16 #define TX_RING_SIZE 512
  17
  18 #define NUM_MBUFS 8191
  19 #define MBUF_CACHE_SIZE 250
  20 #define BURST_SIZE 32
  21
  22 static const struct rte_eth_conf port_conf_default = {
  23         .rxmode = { .max_rx_pkt_len = RTE_ETHER_MAX_LEN }
  24 };
  25
  26 /* l2fwd-cat.c: CAT enabled, basic DPDK skeleton forwarding example. */
  27
  28 /*
  29  * Initializes a given port using global settings and with the RX buffers
  30  * coming from the mbuf_pool passed as a parameter.
  31  */
  32 static inline int
  33 port_init(uint16_t port, struct rte_mempool *mbuf_pool)
  34 {
  35         struct rte_eth_conf port_conf = port_conf_default;
  36         const uint16_t rx_rings = 1, tx_rings = 1;
  37         int retval;
  38         uint16_t q;
  39         uint16_t nb_rxd = RX_RING_SIZE;
  40         uint16_t nb_txd = TX_RING_SIZE;
  41
  42         if (!rte_eth_dev_is_valid_port(port))
  43                 return -1;
  44
  45         /* Configure the Ethernet device. */
  46         retval = rte_eth_dev_configure(port, rx_rings, tx_rings, &port_conf);
  47         if (retval != 0)
  48                 return retval;
  49
  50         retval = rte_eth_dev_adjust_nb_rx_tx_desc(port, &nb_rxd, &nb_txd);
  51         if (retval != 0)
  52                 return retval;
  53
  54         /* Allocate and set up 1 RX queue per Ethernet port. */
  55         for (q = 0; q < rx_rings; q++) {
  56                 retval = rte_eth_rx_queue_setup(port, q, nb_rxd,
  57                                 rte_eth_dev_socket_id(port), NULL, mbuf_pool);
  58                 if (retval < 0)
  59                         return retval;
  60         }
  61
  62         /* Allocate and set up 1 TX queue per Ethernet port. */
  63         for (q = 0; q < tx_rings; q++) {
  64                 retval = rte_eth_tx_queue_setup(port, q, nb_txd,
  65                                 rte_eth_dev_socket_id(port), NULL);
  66                 if (retval < 0)
  67                         return retval;
  68         }
  69
  70         /* Start the Ethernet port. */
  71         retval = rte_eth_dev_start(port);
  72         if (retval < 0)
  73                 return retval;
  74
  75         /* Display the port MAC address. */
  76         struct rte_ether_addr addr;
  77         retval = rte_eth_macaddr_get(port, &addr);
  78         if (retval < 0)
  79                 return retval;
  80
  81         printf("Port %u MAC: %02" PRIx8 " %02" PRIx8 " %02" PRIx8
  82                            " %02" PRIx8 " %02" PRIx8 " %02" PRIx8 "\n",
  83                         port, RTE_ETHER_ADDR_BYTES(&addr));
  84
  85         /* Enable RX in promiscuous mode for the Ethernet device. */
  86         retval = rte_eth_promiscuous_enable(port);
  87         if (retval != 0)
  88                 return retval;
  89
  90         return 0;
  91 }
  92
  93 /*
  94  * The lcore main. This is the main thread that does the work, reading from
  95  * an input port and writing to an output port.
  96  */
  97 static __rte_noreturn void
  98 lcore_main(void)
  99 {
 100         uint16_t port;
 101
 102         /*
 103          * Check that the port is on the same NUMA node as the polling thread
 104          * for best performance.
 105          */
 106         RTE_ETH_FOREACH_DEV(port)
 107                 if (rte_eth_dev_socket_id(port) >= 0 &&
 108                                 rte_eth_dev_socket_id(port) !=
 109                                                 (int)rte_socket_id())
 110                         printf("WARNING, port %u is on remote NUMA node to "
 111                                         "polling thread.\n\tPerformance will "
 112                                         "not be optimal.\n", port);
 113
 114         printf("\nCore %u forwarding packets. [Ctrl+C to quit]\n",
 115                         rte_lcore_id());
 116
 117         /* Run until the application is quit or killed. */
 118         for (;;) {
 119                 /*
 120                  * Receive packets on a port and forward them on the paired
 121                  * port. The mapping is 0 -> 1, 1 -> 0, 2 -> 3, 3 -> 2, etc.
 122                  */
 123                 RTE_ETH_FOREACH_DEV(port) {
 124
 125                         /* Get burst of RX packets, from first port of pair. */
 126                         struct rte_mbuf *bufs[BURST_SIZE];
 127                         const uint16_t nb_rx = rte_eth_rx_burst(port, 0,
 128                                         bufs, BURST_SIZE);
 129
 130                         if (unlikely(nb_rx == 0))
 131                                 continue;
 132
 133                         /* Send burst of TX packets, to second port of pair. */
 134                         const uint16_t nb_tx = rte_eth_tx_burst(port ^ 1, 0,
 135                                         bufs, nb_rx);
 136
 137                         /* Free any unsent packets. */
 138                         if (unlikely(nb_tx < nb_rx)) {
 139                                 uint16_t buf;
 140                                 for (buf = nb_tx; buf < nb_rx; buf++)
 141                                         rte_pktmbuf_free(bufs[buf]);
 142                         }
 143                 }
 144         }
 145 }
 146
 147 /*
 148  * The main function, which does initialization and calls the per-lcore
 149  * functions.
 150  */
 151 int
 152 main(int argc, char *argv[])
 153 {
 154         struct rte_mempool *mbuf_pool;
 155         unsigned nb_ports;
 156         uint16_t portid;
 157
 158         /* Initialize the Environment Abstraction Layer (EAL). 8< */
 159         int ret = rte_eal_init(argc, argv);
 160         if (ret < 0)
 161                 rte_exit(EXIT_FAILURE, "Error with EAL initialization\n");
 162         /* >8 End of initializion the Environment Abstraction Layer (EAL). */
 163
 164         argc -= ret;
 165         argv += ret;
 166
 167         /*
 168          * Initialize the PQoS library and configure CAT.
 169          * Please see l2fwd-cat documentation for more info.
 170          */
 171
 172         /* Initialize the PQoS. 8< */
 173         ret = cat_init(argc, argv);
 174         if (ret < 0)
 175                 rte_exit(EXIT_FAILURE, "PQOS: L3CA init failed!\n");
 176         /* >8 End of initialization of PQoS. */
 177
 178         argc -= ret;
 179         argv += ret;
 180
 181         /* Check that there is an even number of ports to send/receive on. */
 182         nb_ports = rte_eth_dev_count_avail();
 183         if (nb_ports < 2 || (nb_ports & 1))
 184                 rte_exit(EXIT_FAILURE, "Error: number of ports must be even\n");
 185
 186         /* Creates a new mempool in memory to hold the mbufs. */
 187         mbuf_pool = rte_pktmbuf_pool_create("MBUF_POOL", NUM_MBUFS * nb_ports,
 188                 MBUF_CACHE_SIZE, 0, RTE_MBUF_DEFAULT_BUF_SIZE, rte_socket_id());
 189
 190         if (mbuf_pool == NULL)
 191                 rte_exit(EXIT_FAILURE, "Cannot create mbuf pool\n");
 192
 193         /* Initialize all ports. */
 194         RTE_ETH_FOREACH_DEV(portid)
 195                 if (port_init(portid, mbuf_pool) != 0)
 196                         rte_exit(EXIT_FAILURE, "Cannot init port %"PRIu16 "\n",
 197                                         portid);
 198
 199         if (rte_lcore_count() > 1)
 200                 printf("\nWARNING: Too many lcores enabled. Only 1 used.\n");
 201
 202         /* Call lcore_main on the main core only. */
 203         lcore_main();
 204
 205         /* clean up the EAL */
 206         rte_eal_cleanup();
 207
 208         return 0;
 209 }