net/ice/base: implement firmware debug dump
[dpdk.git] / examples / l2fwd / main.c
index 4a41aac..911e40c 100644 (file)
@@ -9,7 +9,6 @@
 #include <inttypes.h>
 #include <sys/types.h>
 #include <sys/queue.h>
-#include <netinet/in.h>
 #include <setjmp.h>
 #include <stdarg.h>
 #include <ctype.h>
@@ -38,6 +37,7 @@
 #include <rte_ethdev.h>
 #include <rte_mempool.h>
 #include <rte_mbuf.h>
+#include <rte_string_fns.h>
 
 static volatile bool force_quit;
 
@@ -67,15 +67,26 @@ static uint32_t l2fwd_enabled_port_mask = 0;
 /* list of enabled ports */
 static uint32_t l2fwd_dst_ports[RTE_MAX_ETHPORTS];
 
+struct port_pair_params {
+#define NUM_PORTS      2
+       uint16_t port[NUM_PORTS];
+} __rte_cache_aligned;
+
+static struct port_pair_params port_pair_params_array[RTE_MAX_ETHPORTS / 2];
+static struct port_pair_params *port_pair_params;
+static uint16_t nb_port_pair_params;
+
 static unsigned int l2fwd_rx_queue_per_lcore = 1;
 
 #define MAX_RX_QUEUE_PER_LCORE 16
 #define MAX_TX_QUEUE_PER_PORT 16
+/* List of queues to be polled for a given lcore. 8< */
 struct lcore_queue_conf {
        unsigned n_rx_port;
        unsigned rx_port_list[MAX_RX_QUEUE_PER_LCORE];
 } __rte_cache_aligned;
 struct lcore_queue_conf lcore_queue_conf[RTE_MAX_LCORE];
+/* >8 End of list of queues to be polled for a given lcore. */
 
 static struct rte_eth_dev_tx_buffer *tx_buffer[RTE_MAX_ETHPORTS];
 
@@ -166,6 +177,7 @@ l2fwd_mac_updating(struct rte_mbuf *m, unsigned dest_portid)
        rte_ether_addr_copy(&l2fwd_ports_eth_addr[dest_portid], &eth->s_addr);
 }
 
+/* Simple forward. 8< */
 static void
 l2fwd_simple_forward(struct rte_mbuf *m, unsigned portid)
 {
@@ -183,6 +195,7 @@ l2fwd_simple_forward(struct rte_mbuf *m, unsigned portid)
        if (sent)
                port_statistics[dst_port].tx += sent;
 }
+/* >8 End of simple forward. */
 
 /* main processing loop */
 static void
@@ -222,6 +235,7 @@ l2fwd_main_loop(void)
 
        while (!force_quit) {
 
+               /* Drains TX queue in its main loop. 8< */
                cur_tsc = rte_rdtsc();
 
                /*
@@ -250,8 +264,8 @@ l2fwd_main_loop(void)
                                /* if timer has reached its timeout */
                                if (unlikely(timer_tsc >= timer_period)) {
 
-                                       /* do this only on master core */
-                                       if (lcore_id == rte_get_master_lcore()) {
+                                       /* do this only on main core */
+                                       if (lcore_id == rte_get_main_lcore()) {
                                                print_stats();
                                                /* reset the timer */
                                                timer_tsc = 0;
@@ -261,10 +275,9 @@ l2fwd_main_loop(void)
 
                        prev_tsc = cur_tsc;
                }
+               /* >8 End of draining TX queue. */
 
-               /*
-                * Read packet from RX queues
-                */
+               /* Read packet from RX queues. 8< */
                for (i = 0; i < qconf->n_rx_port; i++) {
 
                        portid = qconf->rx_port_list[i];
@@ -279,6 +292,7 @@ l2fwd_main_loop(void)
                                l2fwd_simple_forward(m, portid);
                        }
                }
+               /* >8 End of read packet from RX queues. */
        }
 }
 
@@ -296,11 +310,13 @@ l2fwd_usage(const char *prgname)
        printf("%s [EAL options] -- -p PORTMASK [-q NQ]\n"
               "  -p PORTMASK: hexadecimal bitmask of ports to configure\n"
               "  -q NQ: number of queue (=ports) per lcore (default is 1)\n"
-                  "  -T PERIOD: statistics will be refreshed each PERIOD seconds (0 to disable, 10 default, 86400 maximum)\n"
-                  "  --[no-]mac-updating: Enable or disable MAC addresses updating (enabled by default)\n"
-                  "      When enabled:\n"
-                  "       - The source MAC address is replaced by the TX port MAC address\n"
-                  "       - The destination MAC address is replaced by 02:00:00:00:00:TX_PORT_ID\n",
+              "  -T PERIOD: statistics will be refreshed each PERIOD seconds (0 to disable, 10 default, 86400 maximum)\n"
+              "  --no-mac-updating: Disable MAC addresses updating (enabled by default)\n"
+              "      When enabled:\n"
+              "       - The source MAC address is replaced by the TX port MAC address\n"
+              "       - The destination MAC address is replaced by 02:00:00:00:00:TX_PORT_ID\n"
+              "  --portmap: Configure forwarding port pair mapping\n"
+              "              Default: alternate port pairs\n\n",
               prgname);
 }
 
@@ -313,14 +329,66 @@ l2fwd_parse_portmask(const char *portmask)
        /* parse hexadecimal string */
        pm = strtoul(portmask, &end, 16);
        if ((portmask[0] == '\0') || (end == NULL) || (*end != '\0'))
-               return -1;
-
-       if (pm == 0)
-               return -1;
+               return 0;
 
        return pm;
 }
 
+static int
+l2fwd_parse_port_pair_config(const char *q_arg)
+{
+       enum fieldnames {
+               FLD_PORT1 = 0,
+               FLD_PORT2,
+               _NUM_FLD
+       };
+       unsigned long int_fld[_NUM_FLD];
+       const char *p, *p0 = q_arg;
+       char *str_fld[_NUM_FLD];
+       unsigned int size;
+       char s[256];
+       char *end;
+       int i;
+
+       nb_port_pair_params = 0;
+
+       while ((p = strchr(p0, '(')) != NULL) {
+               ++p;
+               p0 = strchr(p, ')');
+               if (p0 == NULL)
+                       return -1;
+
+               size = p0 - p;
+               if (size >= sizeof(s))
+                       return -1;
+
+               memcpy(s, p, size);
+               s[size] = '\0';
+               if (rte_strsplit(s, sizeof(s), str_fld,
+                                _NUM_FLD, ',') != _NUM_FLD)
+                       return -1;
+               for (i = 0; i < _NUM_FLD; i++) {
+                       errno = 0;
+                       int_fld[i] = strtoul(str_fld[i], &end, 0);
+                       if (errno != 0 || end == str_fld[i] ||
+                           int_fld[i] >= RTE_MAX_ETHPORTS)
+                               return -1;
+               }
+               if (nb_port_pair_params >= RTE_MAX_ETHPORTS/2) {
+                       printf("exceeded max number of port pair params: %hu\n",
+                               nb_port_pair_params);
+                       return -1;
+               }
+               port_pair_params_array[nb_port_pair_params].port[0] =
+                               (uint16_t)int_fld[FLD_PORT1];
+               port_pair_params_array[nb_port_pair_params].port[1] =
+                               (uint16_t)int_fld[FLD_PORT2];
+               ++nb_port_pair_params;
+       }
+       port_pair_params = port_pair_params_array;
+       return 0;
+}
+
 static unsigned int
 l2fwd_parse_nqueue(const char *q_arg)
 {
@@ -361,20 +429,22 @@ static const char short_options[] =
        "T:"  /* timer period */
        ;
 
-#define CMD_LINE_OPT_MAC_UPDATING "mac-updating"
 #define CMD_LINE_OPT_NO_MAC_UPDATING "no-mac-updating"
+#define CMD_LINE_OPT_PORTMAP_CONFIG "portmap"
 
 enum {
        /* long options mapped to a short option */
 
        /* first long only option value must be >= 256, so that we won't
         * conflict with short options */
-       CMD_LINE_OPT_MIN_NUM = 256,
+       CMD_LINE_OPT_NO_MAC_UPDATING_NUM = 256,
+       CMD_LINE_OPT_PORTMAP_NUM,
 };
 
 static const struct option lgopts[] = {
-       { CMD_LINE_OPT_MAC_UPDATING, no_argument, &mac_updating, 1},
-       { CMD_LINE_OPT_NO_MAC_UPDATING, no_argument, &mac_updating, 0},
+       { CMD_LINE_OPT_NO_MAC_UPDATING, no_argument, 0,
+               CMD_LINE_OPT_NO_MAC_UPDATING_NUM},
+       { CMD_LINE_OPT_PORTMAP_CONFIG, 1, 0, CMD_LINE_OPT_PORTMAP_NUM},
        {NULL, 0, 0, 0}
 };
 
@@ -388,6 +458,7 @@ l2fwd_parse_args(int argc, char **argv)
        char *prgname = argv[0];
 
        argvopt = argv;
+       port_pair_params = NULL;
 
        while ((opt = getopt_long(argc, argvopt, short_options,
                                  lgopts, &option_index)) != EOF) {
@@ -425,7 +496,17 @@ l2fwd_parse_args(int argc, char **argv)
                        break;
 
                /* long options */
-               case 0:
+               case CMD_LINE_OPT_PORTMAP_NUM:
+                       ret = l2fwd_parse_port_pair_config(optarg);
+                       if (ret) {
+                               fprintf(stderr, "Invalid config\n");
+                               l2fwd_usage(prgname);
+                               return -1;
+                       }
+                       break;
+
+               case CMD_LINE_OPT_NO_MAC_UPDATING_NUM:
+                       mac_updating = 0;
                        break;
 
                default:
@@ -442,6 +523,48 @@ l2fwd_parse_args(int argc, char **argv)
        return ret;
 }
 
+/*
+ * Check port pair config with enabled port mask,
+ * and for valid port pair combinations.
+ */
+static int
+check_port_pair_config(void)
+{
+       uint32_t port_pair_config_mask = 0;
+       uint32_t port_pair_mask = 0;
+       uint16_t index, i, portid;
+
+       for (index = 0; index < nb_port_pair_params; index++) {
+               port_pair_mask = 0;
+
+               for (i = 0; i < NUM_PORTS; i++)  {
+                       portid = port_pair_params[index].port[i];
+                       if ((l2fwd_enabled_port_mask & (1 << portid)) == 0) {
+                               printf("port %u is not enabled in port mask\n",
+                                      portid);
+                               return -1;
+                       }
+                       if (!rte_eth_dev_is_valid_port(portid)) {
+                               printf("port %u is not present on the board\n",
+                                      portid);
+                               return -1;
+                       }
+
+                       port_pair_mask |= 1 << portid;
+               }
+
+               if (port_pair_config_mask & port_pair_mask) {
+                       printf("port %u is used in other port pairs\n", portid);
+                       return -1;
+               }
+               port_pair_config_mask |= port_pair_mask;
+       }
+
+       l2fwd_enabled_port_mask &= port_pair_config_mask;
+
+       return 0;
+}
+
 /* Check the link status of all ports in up to 9s, and print them finally */
 static void
 check_all_ports_link_status(uint32_t port_mask)
@@ -452,6 +575,7 @@ check_all_ports_link_status(uint32_t port_mask)
        uint8_t count, all_ports_up, print_flag = 0;
        struct rte_eth_link link;
        int ret;
+       char link_status_text[RTE_ETH_LINK_MAX_STR_LEN];
 
        printf("\nChecking link status");
        fflush(stdout);
@@ -475,14 +599,10 @@ check_all_ports_link_status(uint32_t port_mask)
                        }
                        /* print link status if flag set */
                        if (print_flag == 1) {
-                               if (link.link_status)
-                                       printf(
-                                       "Port%d Link Up. Speed %u Mbps - %s\n",
-                                               portid, link.link_speed,
-                               (link.link_duplex == ETH_LINK_FULL_DUPLEX) ?
-                                       ("full-duplex") : ("half-duplex"));
-                               else
-                                       printf("Port %d Link Down\n", portid);
+                               rte_eth_link_to_str(link_status_text,
+                                       sizeof(link_status_text), &link);
+                               printf("Port %d %s\n", portid,
+                                      link_status_text);
                                continue;
                        }
                        /* clear all_ports_up flag if any link down */
@@ -532,7 +652,7 @@ main(int argc, char **argv)
        unsigned int nb_lcores = 0;
        unsigned int nb_mbufs;
 
-       /* init EAL */
+       /* Init EAL. 8< */
        ret = rte_eal_init(argc, argv);
        if (ret < 0)
                rte_exit(EXIT_FAILURE, "Invalid EAL arguments\n");
@@ -547,6 +667,7 @@ main(int argc, char **argv)
        ret = l2fwd_parse_args(argc, argv);
        if (ret < 0)
                rte_exit(EXIT_FAILURE, "Invalid L2FWD arguments\n");
+       /* >8 End of init EAL. */
 
        printf("MAC updating %s\n", mac_updating ? "enabled" : "disabled");
 
@@ -557,37 +678,54 @@ main(int argc, char **argv)
        if (nb_ports == 0)
                rte_exit(EXIT_FAILURE, "No Ethernet ports - bye\n");
 
+       if (port_pair_params != NULL) {
+               if (check_port_pair_config() < 0)
+                       rte_exit(EXIT_FAILURE, "Invalid port pair config\n");
+       }
+
        /* check port mask to possible port mask */
        if (l2fwd_enabled_port_mask & ~((1 << nb_ports) - 1))
                rte_exit(EXIT_FAILURE, "Invalid portmask; possible (0x%x)\n",
                        (1 << nb_ports) - 1);
 
+       /* Initialization of the driver. 8< */
+
        /* reset l2fwd_dst_ports */
        for (portid = 0; portid < RTE_MAX_ETHPORTS; portid++)
                l2fwd_dst_ports[portid] = 0;
        last_port = 0;
 
-       /*
-        * Each logical core is assigned a dedicated TX queue on each port.
-        */
-       RTE_ETH_FOREACH_DEV(portid) {
-               /* skip ports that are not enabled */
-               if ((l2fwd_enabled_port_mask & (1 << portid)) == 0)
-                       continue;
+       /* populate destination port details */
+       if (port_pair_params != NULL) {
+               uint16_t idx, p;
 
-               if (nb_ports_in_mask % 2) {
-                       l2fwd_dst_ports[portid] = last_port;
-                       l2fwd_dst_ports[last_port] = portid;
+               for (idx = 0; idx < (nb_port_pair_params << 1); idx++) {
+                       p = idx & 1;
+                       portid = port_pair_params[idx >> 1].port[p];
+                       l2fwd_dst_ports[portid] =
+                               port_pair_params[idx >> 1].port[p ^ 1];
                }
-               else
-                       last_port = portid;
+       } else {
+               RTE_ETH_FOREACH_DEV(portid) {
+                       /* skip ports that are not enabled */
+                       if ((l2fwd_enabled_port_mask & (1 << portid)) == 0)
+                               continue;
 
-               nb_ports_in_mask++;
-       }
-       if (nb_ports_in_mask % 2) {
-               printf("Notice: odd number of ports in portmask.\n");
-               l2fwd_dst_ports[last_port] = last_port;
+                       if (nb_ports_in_mask % 2) {
+                               l2fwd_dst_ports[portid] = last_port;
+                               l2fwd_dst_ports[last_port] = portid;
+                       } else {
+                               last_port = portid;
+                       }
+
+                       nb_ports_in_mask++;
+               }
+               if (nb_ports_in_mask % 2) {
+                       printf("Notice: odd number of ports in portmask.\n");
+                       l2fwd_dst_ports[last_port] = last_port;
+               }
        }
+       /* >8 End of initialization of the driver. */
 
        rx_lcore_id = 0;
        qconf = NULL;
@@ -615,18 +753,20 @@ main(int argc, char **argv)
 
                qconf->rx_port_list[qconf->n_rx_port] = portid;
                qconf->n_rx_port++;
-               printf("Lcore %u: RX port %u\n", rx_lcore_id, portid);
+               printf("Lcore %u: RX port %u TX port %u\n", rx_lcore_id,
+                      portid, l2fwd_dst_ports[portid]);
        }
 
        nb_mbufs = RTE_MAX(nb_ports * (nb_rxd + nb_txd + MAX_PKT_BURST +
                nb_lcores * MEMPOOL_CACHE_SIZE), 8192U);
 
-       /* create the mbuf pool */
+       /* Create the mbuf pool. 8< */
        l2fwd_pktmbuf_pool = rte_pktmbuf_pool_create("mbuf_pool", nb_mbufs,
                MEMPOOL_CACHE_SIZE, 0, RTE_MBUF_DEFAULT_BUF_SIZE,
                rte_socket_id());
        if (l2fwd_pktmbuf_pool == NULL)
                rte_exit(EXIT_FAILURE, "Cannot init mbuf pool\n");
+       /* >8 End of create the mbuf pool. */
 
        /* Initialise each port */
        RTE_ETH_FOREACH_DEV(portid) {
@@ -655,10 +795,12 @@ main(int argc, char **argv)
                if (dev_info.tx_offload_capa & DEV_TX_OFFLOAD_MBUF_FAST_FREE)
                        local_port_conf.txmode.offloads |=
                                DEV_TX_OFFLOAD_MBUF_FAST_FREE;
+               /* Configure the number of queues for a port. */
                ret = rte_eth_dev_configure(portid, 1, 1, &local_port_conf);
                if (ret < 0)
                        rte_exit(EXIT_FAILURE, "Cannot configure device: err=%d, port=%u\n",
                                  ret, portid);
+               /* >8 End of configuration of the number of queues for a port. */
 
                ret = rte_eth_dev_adjust_nb_rx_tx_desc(portid, &nb_rxd,
                                                       &nb_txd);
@@ -678,6 +820,7 @@ main(int argc, char **argv)
                fflush(stdout);
                rxq_conf = dev_info.default_rxconf;
                rxq_conf.offloads = local_port_conf.rxmode.offloads;
+               /* RX queue setup. 8< */
                ret = rte_eth_rx_queue_setup(portid, 0, nb_rxd,
                                             rte_eth_dev_socket_id(portid),
                                             &rxq_conf,
@@ -685,8 +828,9 @@ main(int argc, char **argv)
                if (ret < 0)
                        rte_exit(EXIT_FAILURE, "rte_eth_rx_queue_setup:err=%d, port=%u\n",
                                  ret, portid);
+               /* >8 End of RX queue setup. */
 
-               /* init one TX queue on each port */
+               /* Init one TX queue on each port. 8< */
                fflush(stdout);
                txq_conf = dev_info.default_txconf;
                txq_conf.offloads = local_port_conf.txmode.offloads;
@@ -696,6 +840,7 @@ main(int argc, char **argv)
                if (ret < 0)
                        rte_exit(EXIT_FAILURE, "rte_eth_tx_queue_setup:err=%d, port=%u\n",
                                ret, portid);
+               /* >8 End of init one TX queue on each port. */
 
                /* Initialize TX buffers */
                tx_buffer[portid] = rte_zmalloc_socket("tx_buffer",
@@ -756,8 +901,8 @@ main(int argc, char **argv)
 
        ret = 0;
        /* launch per-lcore init on every lcore */
-       rte_eal_mp_remote_launch(l2fwd_launch_one_lcore, NULL, CALL_MASTER);
-       RTE_LCORE_FOREACH_SLAVE(lcore_id) {
+       rte_eal_mp_remote_launch(l2fwd_launch_one_lcore, NULL, CALL_MAIN);
+       RTE_LCORE_FOREACH_WORKER(lcore_id) {
                if (rte_eal_wait_lcore(lcore_id) < 0) {
                        ret = -1;
                        break;
@@ -768,10 +913,16 @@ main(int argc, char **argv)
                if ((l2fwd_enabled_port_mask & (1 << portid)) == 0)
                        continue;
                printf("Closing port %d...", portid);
-               rte_eth_dev_stop(portid);
+               ret = rte_eth_dev_stop(portid);
+               if (ret != 0)
+                       printf("rte_eth_dev_stop: err=%d, port=%d\n",
+                              ret, portid);
                rte_eth_dev_close(portid);
                printf(" Done\n");
        }
+
+       /* clean up the EAL */
+       rte_eal_cleanup();
        printf("Bye...\n");
 
        return ret;