1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2010-2016 Intel Corporation
10 #include <sys/types.h>
11 #include <sys/queue.h>
12 #include <netinet/in.h>
21 #include <rte_common.h>
23 #include <rte_malloc.h>
24 #include <rte_memory.h>
25 #include <rte_memcpy.h>
27 #include <rte_launch.h>
28 #include <rte_atomic.h>
29 #include <rte_cycles.h>
30 #include <rte_prefetch.h>
31 #include <rte_lcore.h>
32 #include <rte_per_lcore.h>
33 #include <rte_branch_prediction.h>
34 #include <rte_interrupts.h>
35 #include <rte_random.h>
36 #include <rte_debug.h>
37 #include <rte_ether.h>
38 #include <rte_ethdev.h>
39 #include <rte_mempool.h>
42 static volatile bool force_quit;
44 /* MAC updating enabled by default */
45 static int mac_updating = 1;
47 #define RTE_LOGTYPE_L2FWD RTE_LOGTYPE_USER1
49 #define MAX_PKT_BURST 32
50 #define BURST_TX_DRAIN_US 100 /* TX drain every ~100us */
51 #define MEMPOOL_CACHE_SIZE 256
54 * Configurable number of RX/TX ring descriptors
56 #define RTE_TEST_RX_DESC_DEFAULT 1024
57 #define RTE_TEST_TX_DESC_DEFAULT 1024
58 static uint16_t nb_rxd = RTE_TEST_RX_DESC_DEFAULT;
59 static uint16_t nb_txd = RTE_TEST_TX_DESC_DEFAULT;
61 /* ethernet addresses of ports */
62 static struct rte_ether_addr l2fwd_ports_eth_addr[RTE_MAX_ETHPORTS];
64 /* mask of enabled ports */
65 static uint32_t l2fwd_enabled_port_mask = 0;
67 /* list of enabled ports */
68 static uint32_t l2fwd_dst_ports[RTE_MAX_ETHPORTS];
70 static unsigned int l2fwd_rx_queue_per_lcore = 1;
72 #define MAX_RX_QUEUE_PER_LCORE 16
73 #define MAX_TX_QUEUE_PER_PORT 16
74 struct lcore_queue_conf {
76 unsigned rx_port_list[MAX_RX_QUEUE_PER_LCORE];
77 } __rte_cache_aligned;
78 struct lcore_queue_conf lcore_queue_conf[RTE_MAX_LCORE];
80 static struct rte_eth_dev_tx_buffer *tx_buffer[RTE_MAX_ETHPORTS];
82 static struct rte_eth_conf port_conf = {
87 .mq_mode = ETH_MQ_TX_NONE,
91 struct rte_mempool * l2fwd_pktmbuf_pool = NULL;
93 /* Per-port statistics struct */
94 struct l2fwd_port_statistics {
98 } __rte_cache_aligned;
99 struct l2fwd_port_statistics port_statistics[RTE_MAX_ETHPORTS];
101 #define MAX_TIMER_PERIOD 86400 /* 1 day max */
102 /* A tsc-based timer responsible for triggering statistics printout */
103 static uint64_t timer_period = 10; /* default period is 10 seconds */
105 /* Print out statistics on packets dropped */
109 uint64_t total_packets_dropped, total_packets_tx, total_packets_rx;
112 total_packets_dropped = 0;
113 total_packets_tx = 0;
114 total_packets_rx = 0;
116 const char clr[] = { 27, '[', '2', 'J', '\0' };
117 const char topLeft[] = { 27, '[', '1', ';', '1', 'H','\0' };
119 /* Clear screen and move to top left */
120 printf("%s%s", clr, topLeft);
122 printf("\nPort statistics ====================================");
124 for (portid = 0; portid < RTE_MAX_ETHPORTS; portid++) {
125 /* skip disabled ports */
126 if ((l2fwd_enabled_port_mask & (1 << portid)) == 0)
128 printf("\nStatistics for port %u ------------------------------"
129 "\nPackets sent: %24"PRIu64
130 "\nPackets received: %20"PRIu64
131 "\nPackets dropped: %21"PRIu64,
133 port_statistics[portid].tx,
134 port_statistics[portid].rx,
135 port_statistics[portid].dropped);
137 total_packets_dropped += port_statistics[portid].dropped;
138 total_packets_tx += port_statistics[portid].tx;
139 total_packets_rx += port_statistics[portid].rx;
141 printf("\nAggregate statistics ==============================="
142 "\nTotal packets sent: %18"PRIu64
143 "\nTotal packets received: %14"PRIu64
144 "\nTotal packets dropped: %15"PRIu64,
147 total_packets_dropped);
148 printf("\n====================================================\n");
152 l2fwd_mac_updating(struct rte_mbuf *m, unsigned dest_portid)
154 struct rte_ether_hdr *eth;
157 eth = rte_pktmbuf_mtod(m, struct rte_ether_hdr *);
159 /* 02:00:00:00:00:xx */
160 tmp = ð->d_addr.addr_bytes[0];
161 *((uint64_t *)tmp) = 0x000000000002 + ((uint64_t)dest_portid << 40);
164 rte_ether_addr_copy(&l2fwd_ports_eth_addr[dest_portid], ð->s_addr);
168 l2fwd_simple_forward(struct rte_mbuf *m, unsigned portid)
172 struct rte_eth_dev_tx_buffer *buffer;
174 dst_port = l2fwd_dst_ports[portid];
177 l2fwd_mac_updating(m, dst_port);
179 buffer = tx_buffer[dst_port];
180 sent = rte_eth_tx_buffer(dst_port, 0, buffer, m);
182 port_statistics[dst_port].tx += sent;
185 /* main processing loop */
187 l2fwd_main_loop(void)
189 struct rte_mbuf *pkts_burst[MAX_PKT_BURST];
193 uint64_t prev_tsc, diff_tsc, cur_tsc, timer_tsc;
194 unsigned i, j, portid, nb_rx;
195 struct lcore_queue_conf *qconf;
196 const uint64_t drain_tsc = (rte_get_tsc_hz() + US_PER_S - 1) / US_PER_S *
198 struct rte_eth_dev_tx_buffer *buffer;
203 lcore_id = rte_lcore_id();
204 qconf = &lcore_queue_conf[lcore_id];
206 if (qconf->n_rx_port == 0) {
207 RTE_LOG(INFO, L2FWD, "lcore %u has nothing to do\n", lcore_id);
211 RTE_LOG(INFO, L2FWD, "entering main loop on lcore %u\n", lcore_id);
213 for (i = 0; i < qconf->n_rx_port; i++) {
215 portid = qconf->rx_port_list[i];
216 RTE_LOG(INFO, L2FWD, " -- lcoreid=%u portid=%u\n", lcore_id,
221 while (!force_quit) {
223 cur_tsc = rte_rdtsc();
226 * TX burst queue drain
228 diff_tsc = cur_tsc - prev_tsc;
229 if (unlikely(diff_tsc > drain_tsc)) {
231 for (i = 0; i < qconf->n_rx_port; i++) {
233 portid = l2fwd_dst_ports[qconf->rx_port_list[i]];
234 buffer = tx_buffer[portid];
236 sent = rte_eth_tx_buffer_flush(portid, 0, buffer);
238 port_statistics[portid].tx += sent;
242 /* if timer is enabled */
243 if (timer_period > 0) {
245 /* advance the timer */
246 timer_tsc += diff_tsc;
248 /* if timer has reached its timeout */
249 if (unlikely(timer_tsc >= timer_period)) {
251 /* do this only on master core */
252 if (lcore_id == rte_get_master_lcore()) {
254 /* reset the timer */
264 * Read packet from RX queues
266 for (i = 0; i < qconf->n_rx_port; i++) {
268 portid = qconf->rx_port_list[i];
269 nb_rx = rte_eth_rx_burst(portid, 0,
270 pkts_burst, MAX_PKT_BURST);
272 port_statistics[portid].rx += nb_rx;
274 for (j = 0; j < nb_rx; j++) {
276 rte_prefetch0(rte_pktmbuf_mtod(m, void *));
277 l2fwd_simple_forward(m, portid);
284 l2fwd_launch_one_lcore(__attribute__((unused)) void *dummy)
292 l2fwd_usage(const char *prgname)
294 printf("%s [EAL options] -- -p PORTMASK [-q NQ]\n"
295 " -p PORTMASK: hexadecimal bitmask of ports to configure\n"
296 " -q NQ: number of queue (=ports) per lcore (default is 1)\n"
297 " -T PERIOD: statistics will be refreshed each PERIOD seconds (0 to disable, 10 default, 86400 maximum)\n"
298 " --[no-]mac-updating: Enable or disable MAC addresses updating (enabled by default)\n"
300 " - The source MAC address is replaced by the TX port MAC address\n"
301 " - The destination MAC address is replaced by 02:00:00:00:00:TX_PORT_ID\n",
306 l2fwd_parse_portmask(const char *portmask)
311 /* parse hexadecimal string */
312 pm = strtoul(portmask, &end, 16);
313 if ((portmask[0] == '\0') || (end == NULL) || (*end != '\0'))
323 l2fwd_parse_nqueue(const char *q_arg)
328 /* parse hexadecimal string */
329 n = strtoul(q_arg, &end, 10);
330 if ((q_arg[0] == '\0') || (end == NULL) || (*end != '\0'))
334 if (n >= MAX_RX_QUEUE_PER_LCORE)
341 l2fwd_parse_timer_period(const char *q_arg)
346 /* parse number string */
347 n = strtol(q_arg, &end, 10);
348 if ((q_arg[0] == '\0') || (end == NULL) || (*end != '\0'))
350 if (n >= MAX_TIMER_PERIOD)
356 static const char short_options[] =
358 "q:" /* number of queues */
359 "T:" /* timer period */
362 #define CMD_LINE_OPT_MAC_UPDATING "mac-updating"
363 #define CMD_LINE_OPT_NO_MAC_UPDATING "no-mac-updating"
366 /* long options mapped to a short option */
368 /* first long only option value must be >= 256, so that we won't
369 * conflict with short options */
370 CMD_LINE_OPT_MIN_NUM = 256,
373 static const struct option lgopts[] = {
374 { CMD_LINE_OPT_MAC_UPDATING, no_argument, &mac_updating, 1},
375 { CMD_LINE_OPT_NO_MAC_UPDATING, no_argument, &mac_updating, 0},
379 /* Parse the argument given in the command line of the application */
381 l2fwd_parse_args(int argc, char **argv)
383 int opt, ret, timer_secs;
386 char *prgname = argv[0];
390 while ((opt = getopt_long(argc, argvopt, short_options,
391 lgopts, &option_index)) != EOF) {
396 l2fwd_enabled_port_mask = l2fwd_parse_portmask(optarg);
397 if (l2fwd_enabled_port_mask == 0) {
398 printf("invalid portmask\n");
399 l2fwd_usage(prgname);
406 l2fwd_rx_queue_per_lcore = l2fwd_parse_nqueue(optarg);
407 if (l2fwd_rx_queue_per_lcore == 0) {
408 printf("invalid queue number\n");
409 l2fwd_usage(prgname);
416 timer_secs = l2fwd_parse_timer_period(optarg);
417 if (timer_secs < 0) {
418 printf("invalid timer period\n");
419 l2fwd_usage(prgname);
422 timer_period = timer_secs;
430 l2fwd_usage(prgname);
436 argv[optind-1] = prgname;
439 optind = 1; /* reset getopt lib */
443 /* Check the link status of all ports in up to 9s, and print them finally */
445 check_all_ports_link_status(uint32_t port_mask)
447 #define CHECK_INTERVAL 100 /* 100ms */
448 #define MAX_CHECK_TIME 90 /* 9s (90 * 100ms) in total */
450 uint8_t count, all_ports_up, print_flag = 0;
451 struct rte_eth_link link;
454 printf("\nChecking link status");
456 for (count = 0; count <= MAX_CHECK_TIME; count++) {
460 RTE_ETH_FOREACH_DEV(portid) {
463 if ((port_mask & (1 << portid)) == 0)
465 memset(&link, 0, sizeof(link));
466 ret = rte_eth_link_get_nowait(portid, &link);
470 printf("Port %u link get failed: %s\n",
471 portid, rte_strerror(-ret));
474 /* print link status if flag set */
475 if (print_flag == 1) {
476 if (link.link_status)
478 "Port%d Link Up. Speed %u Mbps - %s\n",
479 portid, link.link_speed,
480 (link.link_duplex == ETH_LINK_FULL_DUPLEX) ?
481 ("full-duplex") : ("half-duplex\n"));
483 printf("Port %d Link Down\n", portid);
486 /* clear all_ports_up flag if any link down */
487 if (link.link_status == ETH_LINK_DOWN) {
492 /* after finally printing all link status, get out */
496 if (all_ports_up == 0) {
499 rte_delay_ms(CHECK_INTERVAL);
502 /* set the print_flag if all ports up or timeout */
503 if (all_ports_up == 1 || count == (MAX_CHECK_TIME - 1)) {
511 signal_handler(int signum)
513 if (signum == SIGINT || signum == SIGTERM) {
514 printf("\n\nSignal %d received, preparing to exit...\n",
521 main(int argc, char **argv)
523 struct lcore_queue_conf *qconf;
526 uint16_t nb_ports_available = 0;
527 uint16_t portid, last_port;
528 unsigned lcore_id, rx_lcore_id;
529 unsigned nb_ports_in_mask = 0;
530 unsigned int nb_lcores = 0;
531 unsigned int nb_mbufs;
534 ret = rte_eal_init(argc, argv);
536 rte_exit(EXIT_FAILURE, "Invalid EAL arguments\n");
541 signal(SIGINT, signal_handler);
542 signal(SIGTERM, signal_handler);
544 /* parse application arguments (after the EAL ones) */
545 ret = l2fwd_parse_args(argc, argv);
547 rte_exit(EXIT_FAILURE, "Invalid L2FWD arguments\n");
549 printf("MAC updating %s\n", mac_updating ? "enabled" : "disabled");
551 /* convert to number of cycles */
552 timer_period *= rte_get_timer_hz();
554 nb_ports = rte_eth_dev_count_avail();
556 rte_exit(EXIT_FAILURE, "No Ethernet ports - bye\n");
558 /* check port mask to possible port mask */
559 if (l2fwd_enabled_port_mask & ~((1 << nb_ports) - 1))
560 rte_exit(EXIT_FAILURE, "Invalid portmask; possible (0x%x)\n",
561 (1 << nb_ports) - 1);
563 /* reset l2fwd_dst_ports */
564 for (portid = 0; portid < RTE_MAX_ETHPORTS; portid++)
565 l2fwd_dst_ports[portid] = 0;
569 * Each logical core is assigned a dedicated TX queue on each port.
571 RTE_ETH_FOREACH_DEV(portid) {
572 /* skip ports that are not enabled */
573 if ((l2fwd_enabled_port_mask & (1 << portid)) == 0)
576 if (nb_ports_in_mask % 2) {
577 l2fwd_dst_ports[portid] = last_port;
578 l2fwd_dst_ports[last_port] = portid;
585 if (nb_ports_in_mask % 2) {
586 printf("Notice: odd number of ports in portmask.\n");
587 l2fwd_dst_ports[last_port] = last_port;
593 /* Initialize the port/queue configuration of each logical core */
594 RTE_ETH_FOREACH_DEV(portid) {
595 /* skip ports that are not enabled */
596 if ((l2fwd_enabled_port_mask & (1 << portid)) == 0)
599 /* get the lcore_id for this port */
600 while (rte_lcore_is_enabled(rx_lcore_id) == 0 ||
601 lcore_queue_conf[rx_lcore_id].n_rx_port ==
602 l2fwd_rx_queue_per_lcore) {
604 if (rx_lcore_id >= RTE_MAX_LCORE)
605 rte_exit(EXIT_FAILURE, "Not enough cores\n");
608 if (qconf != &lcore_queue_conf[rx_lcore_id]) {
609 /* Assigned a new logical core in the loop above. */
610 qconf = &lcore_queue_conf[rx_lcore_id];
614 qconf->rx_port_list[qconf->n_rx_port] = portid;
616 printf("Lcore %u: RX port %u\n", rx_lcore_id, portid);
619 nb_mbufs = RTE_MAX(nb_ports * (nb_rxd + nb_txd + MAX_PKT_BURST +
620 nb_lcores * MEMPOOL_CACHE_SIZE), 8192U);
622 /* create the mbuf pool */
623 l2fwd_pktmbuf_pool = rte_pktmbuf_pool_create("mbuf_pool", nb_mbufs,
624 MEMPOOL_CACHE_SIZE, 0, RTE_MBUF_DEFAULT_BUF_SIZE,
626 if (l2fwd_pktmbuf_pool == NULL)
627 rte_exit(EXIT_FAILURE, "Cannot init mbuf pool\n");
629 /* Initialise each port */
630 RTE_ETH_FOREACH_DEV(portid) {
631 struct rte_eth_rxconf rxq_conf;
632 struct rte_eth_txconf txq_conf;
633 struct rte_eth_conf local_port_conf = port_conf;
634 struct rte_eth_dev_info dev_info;
636 /* skip ports that are not enabled */
637 if ((l2fwd_enabled_port_mask & (1 << portid)) == 0) {
638 printf("Skipping disabled port %u\n", portid);
641 nb_ports_available++;
644 printf("Initializing port %u... ", portid);
647 ret = rte_eth_dev_info_get(portid, &dev_info);
649 rte_exit(EXIT_FAILURE,
650 "Error during getting device (port %u) info: %s\n",
651 portid, strerror(-ret));
653 if (dev_info.tx_offload_capa & DEV_TX_OFFLOAD_MBUF_FAST_FREE)
654 local_port_conf.txmode.offloads |=
655 DEV_TX_OFFLOAD_MBUF_FAST_FREE;
656 ret = rte_eth_dev_configure(portid, 1, 1, &local_port_conf);
658 rte_exit(EXIT_FAILURE, "Cannot configure device: err=%d, port=%u\n",
661 ret = rte_eth_dev_adjust_nb_rx_tx_desc(portid, &nb_rxd,
664 rte_exit(EXIT_FAILURE,
665 "Cannot adjust number of descriptors: err=%d, port=%u\n",
668 ret = rte_eth_macaddr_get(portid,
669 &l2fwd_ports_eth_addr[portid]);
671 rte_exit(EXIT_FAILURE,
672 "Cannot get MAC address: err=%d, port=%u\n",
675 /* init one RX queue */
677 rxq_conf = dev_info.default_rxconf;
678 rxq_conf.offloads = local_port_conf.rxmode.offloads;
679 ret = rte_eth_rx_queue_setup(portid, 0, nb_rxd,
680 rte_eth_dev_socket_id(portid),
684 rte_exit(EXIT_FAILURE, "rte_eth_rx_queue_setup:err=%d, port=%u\n",
687 /* init one TX queue on each port */
689 txq_conf = dev_info.default_txconf;
690 txq_conf.offloads = local_port_conf.txmode.offloads;
691 ret = rte_eth_tx_queue_setup(portid, 0, nb_txd,
692 rte_eth_dev_socket_id(portid),
695 rte_exit(EXIT_FAILURE, "rte_eth_tx_queue_setup:err=%d, port=%u\n",
698 /* Initialize TX buffers */
699 tx_buffer[portid] = rte_zmalloc_socket("tx_buffer",
700 RTE_ETH_TX_BUFFER_SIZE(MAX_PKT_BURST), 0,
701 rte_eth_dev_socket_id(portid));
702 if (tx_buffer[portid] == NULL)
703 rte_exit(EXIT_FAILURE, "Cannot allocate buffer for tx on port %u\n",
706 rte_eth_tx_buffer_init(tx_buffer[portid], MAX_PKT_BURST);
708 ret = rte_eth_tx_buffer_set_err_callback(tx_buffer[portid],
709 rte_eth_tx_buffer_count_callback,
710 &port_statistics[portid].dropped);
712 rte_exit(EXIT_FAILURE,
713 "Cannot set error callback for tx buffer on port %u\n",
717 ret = rte_eth_dev_start(portid);
719 rte_exit(EXIT_FAILURE, "rte_eth_dev_start:err=%d, port=%u\n",
724 ret = rte_eth_promiscuous_enable(portid);
726 rte_exit(EXIT_FAILURE,
727 "rte_eth_promiscuous_enable:err=%s, port=%u\n",
728 rte_strerror(-ret), portid);
730 printf("Port %u, MAC address: %02X:%02X:%02X:%02X:%02X:%02X\n\n",
732 l2fwd_ports_eth_addr[portid].addr_bytes[0],
733 l2fwd_ports_eth_addr[portid].addr_bytes[1],
734 l2fwd_ports_eth_addr[portid].addr_bytes[2],
735 l2fwd_ports_eth_addr[portid].addr_bytes[3],
736 l2fwd_ports_eth_addr[portid].addr_bytes[4],
737 l2fwd_ports_eth_addr[portid].addr_bytes[5]);
739 /* initialize port stats */
740 memset(&port_statistics, 0, sizeof(port_statistics));
743 if (!nb_ports_available) {
744 rte_exit(EXIT_FAILURE,
745 "All available ports are disabled. Please set portmask.\n");
748 check_all_ports_link_status(l2fwd_enabled_port_mask);
751 /* launch per-lcore init on every lcore */
752 rte_eal_mp_remote_launch(l2fwd_launch_one_lcore, NULL, CALL_MASTER);
753 RTE_LCORE_FOREACH_SLAVE(lcore_id) {
754 if (rte_eal_wait_lcore(lcore_id) < 0) {
760 RTE_ETH_FOREACH_DEV(portid) {
761 if ((l2fwd_enabled_port_mask & (1 << portid)) == 0)
763 printf("Closing port %d...", portid);
764 rte_eth_dev_stop(portid);
765 rte_eth_dev_close(portid);