examples/l2fwd-cat/l2fwd-cat.c

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