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 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 = {
85 .ignore_offload_bitfield = 1,
86 .offloads = DEV_RX_OFFLOAD_CRC_STRIP,
89 .mq_mode = ETH_MQ_TX_NONE,
93 struct rte_mempool * l2fwd_pktmbuf_pool = NULL;
95 /* Per-port statistics struct */
96 struct l2fwd_port_statistics {
100 } __rte_cache_aligned;
101 struct l2fwd_port_statistics port_statistics[RTE_MAX_ETHPORTS];
103 #define MAX_TIMER_PERIOD 86400 /* 1 day max */
104 /* A tsc-based timer responsible for triggering statistics printout */
105 static uint64_t timer_period = 10; /* default period is 10 seconds */
107 /* Print out statistics on packets dropped */
111 uint64_t total_packets_dropped, total_packets_tx, total_packets_rx;
114 total_packets_dropped = 0;
115 total_packets_tx = 0;
116 total_packets_rx = 0;
118 const char clr[] = { 27, '[', '2', 'J', '\0' };
119 const char topLeft[] = { 27, '[', '1', ';', '1', 'H','\0' };
121 /* Clear screen and move to top left */
122 printf("%s%s", clr, topLeft);
124 printf("\nPort statistics ====================================");
126 for (portid = 0; portid < RTE_MAX_ETHPORTS; portid++) {
127 /* skip disabled ports */
128 if ((l2fwd_enabled_port_mask & (1 << portid)) == 0)
130 printf("\nStatistics for port %u ------------------------------"
131 "\nPackets sent: %24"PRIu64
132 "\nPackets received: %20"PRIu64
133 "\nPackets dropped: %21"PRIu64,
135 port_statistics[portid].tx,
136 port_statistics[portid].rx,
137 port_statistics[portid].dropped);
139 total_packets_dropped += port_statistics[portid].dropped;
140 total_packets_tx += port_statistics[portid].tx;
141 total_packets_rx += port_statistics[portid].rx;
143 printf("\nAggregate statistics ==============================="
144 "\nTotal packets sent: %18"PRIu64
145 "\nTotal packets received: %14"PRIu64
146 "\nTotal packets dropped: %15"PRIu64,
149 total_packets_dropped);
150 printf("\n====================================================\n");
154 l2fwd_mac_updating(struct rte_mbuf *m, unsigned dest_portid)
156 struct ether_hdr *eth;
159 eth = rte_pktmbuf_mtod(m, struct ether_hdr *);
161 /* 02:00:00:00:00:xx */
162 tmp = ð->d_addr.addr_bytes[0];
163 *((uint64_t *)tmp) = 0x000000000002 + ((uint64_t)dest_portid << 40);
166 ether_addr_copy(&l2fwd_ports_eth_addr[dest_portid], ð->s_addr);
170 l2fwd_simple_forward(struct rte_mbuf *m, unsigned portid)
174 struct rte_eth_dev_tx_buffer *buffer;
176 dst_port = l2fwd_dst_ports[portid];
179 l2fwd_mac_updating(m, dst_port);
181 buffer = tx_buffer[dst_port];
182 sent = rte_eth_tx_buffer(dst_port, 0, buffer, m);
184 port_statistics[dst_port].tx += sent;
187 /* main processing loop */
189 l2fwd_main_loop(void)
191 struct rte_mbuf *pkts_burst[MAX_PKT_BURST];
195 uint64_t prev_tsc, diff_tsc, cur_tsc, timer_tsc;
196 unsigned i, j, portid, nb_rx;
197 struct lcore_queue_conf *qconf;
198 const uint64_t drain_tsc = (rte_get_tsc_hz() + US_PER_S - 1) / US_PER_S *
200 struct rte_eth_dev_tx_buffer *buffer;
205 lcore_id = rte_lcore_id();
206 qconf = &lcore_queue_conf[lcore_id];
208 if (qconf->n_rx_port == 0) {
209 RTE_LOG(INFO, L2FWD, "lcore %u has nothing to do\n", lcore_id);
213 RTE_LOG(INFO, L2FWD, "entering main loop on lcore %u\n", lcore_id);
215 for (i = 0; i < qconf->n_rx_port; i++) {
217 portid = qconf->rx_port_list[i];
218 RTE_LOG(INFO, L2FWD, " -- lcoreid=%u portid=%u\n", lcore_id,
223 while (!force_quit) {
225 cur_tsc = rte_rdtsc();
228 * TX burst queue drain
230 diff_tsc = cur_tsc - prev_tsc;
231 if (unlikely(diff_tsc > drain_tsc)) {
233 for (i = 0; i < qconf->n_rx_port; i++) {
235 portid = l2fwd_dst_ports[qconf->rx_port_list[i]];
236 buffer = tx_buffer[portid];
238 sent = rte_eth_tx_buffer_flush(portid, 0, buffer);
240 port_statistics[portid].tx += sent;
244 /* if timer is enabled */
245 if (timer_period > 0) {
247 /* advance the timer */
248 timer_tsc += diff_tsc;
250 /* if timer has reached its timeout */
251 if (unlikely(timer_tsc >= timer_period)) {
253 /* do this only on master core */
254 if (lcore_id == rte_get_master_lcore()) {
256 /* reset the timer */
266 * Read packet from RX queues
268 for (i = 0; i < qconf->n_rx_port; i++) {
270 portid = qconf->rx_port_list[i];
271 nb_rx = rte_eth_rx_burst(portid, 0,
272 pkts_burst, MAX_PKT_BURST);
274 port_statistics[portid].rx += nb_rx;
276 for (j = 0; j < nb_rx; j++) {
278 rte_prefetch0(rte_pktmbuf_mtod(m, void *));
279 l2fwd_simple_forward(m, portid);
286 l2fwd_launch_one_lcore(__attribute__((unused)) void *dummy)
294 l2fwd_usage(const char *prgname)
296 printf("%s [EAL options] -- -p PORTMASK [-q NQ]\n"
297 " -p PORTMASK: hexadecimal bitmask of ports to configure\n"
298 " -q NQ: number of queue (=ports) per lcore (default is 1)\n"
299 " -T PERIOD: statistics will be refreshed each PERIOD seconds (0 to disable, 10 default, 86400 maximum)\n"
300 " --[no-]mac-updating: Enable or disable MAC addresses updating (enabled by default)\n"
302 " - The source MAC address is replaced by the TX port MAC address\n"
303 " - The destination MAC address is replaced by 02:00:00:00:00:TX_PORT_ID\n",
308 l2fwd_parse_portmask(const char *portmask)
313 /* parse hexadecimal string */
314 pm = strtoul(portmask, &end, 16);
315 if ((portmask[0] == '\0') || (end == NULL) || (*end != '\0'))
325 l2fwd_parse_nqueue(const char *q_arg)
330 /* parse hexadecimal string */
331 n = strtoul(q_arg, &end, 10);
332 if ((q_arg[0] == '\0') || (end == NULL) || (*end != '\0'))
336 if (n >= MAX_RX_QUEUE_PER_LCORE)
343 l2fwd_parse_timer_period(const char *q_arg)
348 /* parse number string */
349 n = strtol(q_arg, &end, 10);
350 if ((q_arg[0] == '\0') || (end == NULL) || (*end != '\0'))
352 if (n >= MAX_TIMER_PERIOD)
358 static const char short_options[] =
360 "q:" /* number of queues */
361 "T:" /* timer period */
364 #define CMD_LINE_OPT_MAC_UPDATING "mac-updating"
365 #define CMD_LINE_OPT_NO_MAC_UPDATING "no-mac-updating"
368 /* long options mapped to a short option */
370 /* first long only option value must be >= 256, so that we won't
371 * conflict with short options */
372 CMD_LINE_OPT_MIN_NUM = 256,
375 static const struct option lgopts[] = {
376 { CMD_LINE_OPT_MAC_UPDATING, no_argument, &mac_updating, 1},
377 { CMD_LINE_OPT_NO_MAC_UPDATING, no_argument, &mac_updating, 0},
381 /* Parse the argument given in the command line of the application */
383 l2fwd_parse_args(int argc, char **argv)
385 int opt, ret, timer_secs;
388 char *prgname = argv[0];
392 while ((opt = getopt_long(argc, argvopt, short_options,
393 lgopts, &option_index)) != EOF) {
398 l2fwd_enabled_port_mask = l2fwd_parse_portmask(optarg);
399 if (l2fwd_enabled_port_mask == 0) {
400 printf("invalid portmask\n");
401 l2fwd_usage(prgname);
408 l2fwd_rx_queue_per_lcore = l2fwd_parse_nqueue(optarg);
409 if (l2fwd_rx_queue_per_lcore == 0) {
410 printf("invalid queue number\n");
411 l2fwd_usage(prgname);
418 timer_secs = l2fwd_parse_timer_period(optarg);
419 if (timer_secs < 0) {
420 printf("invalid timer period\n");
421 l2fwd_usage(prgname);
424 timer_period = timer_secs;
432 l2fwd_usage(prgname);
438 argv[optind-1] = prgname;
441 optind = 1; /* reset getopt lib */
445 /* Check the link status of all ports in up to 9s, and print them finally */
447 check_all_ports_link_status(uint16_t port_num, uint32_t port_mask)
449 #define CHECK_INTERVAL 100 /* 100ms */
450 #define MAX_CHECK_TIME 90 /* 9s (90 * 100ms) in total */
452 uint8_t count, all_ports_up, print_flag = 0;
453 struct rte_eth_link link;
455 printf("\nChecking link status");
457 for (count = 0; count <= MAX_CHECK_TIME; count++) {
461 for (portid = 0; portid < port_num; portid++) {
464 if ((port_mask & (1 << portid)) == 0)
466 memset(&link, 0, sizeof(link));
467 rte_eth_link_get_nowait(portid, &link);
468 /* print link status if flag set */
469 if (print_flag == 1) {
470 if (link.link_status)
472 "Port%d Link Up. Speed %u Mbps - %s\n",
473 portid, link.link_speed,
474 (link.link_duplex == ETH_LINK_FULL_DUPLEX) ?
475 ("full-duplex") : ("half-duplex\n"));
477 printf("Port %d Link Down\n", portid);
480 /* clear all_ports_up flag if any link down */
481 if (link.link_status == ETH_LINK_DOWN) {
486 /* after finally printing all link status, get out */
490 if (all_ports_up == 0) {
493 rte_delay_ms(CHECK_INTERVAL);
496 /* set the print_flag if all ports up or timeout */
497 if (all_ports_up == 1 || count == (MAX_CHECK_TIME - 1)) {
505 signal_handler(int signum)
507 if (signum == SIGINT || signum == SIGTERM) {
508 printf("\n\nSignal %d received, preparing to exit...\n",
515 main(int argc, char **argv)
517 struct lcore_queue_conf *qconf;
520 uint16_t nb_ports_available;
521 uint16_t portid, last_port;
522 unsigned lcore_id, rx_lcore_id;
523 unsigned nb_ports_in_mask = 0;
524 unsigned int nb_lcores = 0;
525 unsigned int nb_mbufs;
528 ret = rte_eal_init(argc, argv);
530 rte_exit(EXIT_FAILURE, "Invalid EAL arguments\n");
535 signal(SIGINT, signal_handler);
536 signal(SIGTERM, signal_handler);
538 /* parse application arguments (after the EAL ones) */
539 ret = l2fwd_parse_args(argc, argv);
541 rte_exit(EXIT_FAILURE, "Invalid L2FWD arguments\n");
543 printf("MAC updating %s\n", mac_updating ? "enabled" : "disabled");
545 /* convert to number of cycles */
546 timer_period *= rte_get_timer_hz();
548 nb_ports = rte_eth_dev_count();
550 rte_exit(EXIT_FAILURE, "No Ethernet ports - bye\n");
552 /* check port mask to possible port mask */
553 if (l2fwd_enabled_port_mask & ~((1 << nb_ports) - 1))
554 rte_exit(EXIT_FAILURE, "Invalid portmask; possible (0x%x)\n",
555 (1 << nb_ports) - 1);
557 /* reset l2fwd_dst_ports */
558 for (portid = 0; portid < RTE_MAX_ETHPORTS; portid++)
559 l2fwd_dst_ports[portid] = 0;
563 * Each logical core is assigned a dedicated TX queue on each port.
565 for (portid = 0; portid < nb_ports; portid++) {
566 /* skip ports that are not enabled */
567 if ((l2fwd_enabled_port_mask & (1 << portid)) == 0)
570 if (nb_ports_in_mask % 2) {
571 l2fwd_dst_ports[portid] = last_port;
572 l2fwd_dst_ports[last_port] = portid;
579 if (nb_ports_in_mask % 2) {
580 printf("Notice: odd number of ports in portmask.\n");
581 l2fwd_dst_ports[last_port] = last_port;
587 /* Initialize the port/queue configuration of each logical core */
588 for (portid = 0; portid < nb_ports; portid++) {
589 /* skip ports that are not enabled */
590 if ((l2fwd_enabled_port_mask & (1 << portid)) == 0)
593 /* get the lcore_id for this port */
594 while (rte_lcore_is_enabled(rx_lcore_id) == 0 ||
595 lcore_queue_conf[rx_lcore_id].n_rx_port ==
596 l2fwd_rx_queue_per_lcore) {
598 if (rx_lcore_id >= RTE_MAX_LCORE)
599 rte_exit(EXIT_FAILURE, "Not enough cores\n");
602 if (qconf != &lcore_queue_conf[rx_lcore_id]) {
603 /* Assigned a new logical core in the loop above. */
604 qconf = &lcore_queue_conf[rx_lcore_id];
608 qconf->rx_port_list[qconf->n_rx_port] = portid;
610 printf("Lcore %u: RX port %u\n", rx_lcore_id, portid);
613 nb_ports_available = nb_ports;
615 nb_mbufs = RTE_MAX(nb_ports * (nb_rxd + nb_txd + MAX_PKT_BURST +
616 nb_lcores * MEMPOOL_CACHE_SIZE), 8192U);
618 /* create the mbuf pool */
619 l2fwd_pktmbuf_pool = rte_pktmbuf_pool_create("mbuf_pool", nb_mbufs,
620 MEMPOOL_CACHE_SIZE, 0, RTE_MBUF_DEFAULT_BUF_SIZE,
622 if (l2fwd_pktmbuf_pool == NULL)
623 rte_exit(EXIT_FAILURE, "Cannot init mbuf pool\n");
625 /* Initialise each port */
626 for (portid = 0; portid < nb_ports; portid++) {
627 struct rte_eth_rxconf rxq_conf;
628 struct rte_eth_txconf txq_conf;
629 struct rte_eth_conf local_port_conf = port_conf;
630 struct rte_eth_dev_info dev_info;
632 /* skip ports that are not enabled */
633 if ((l2fwd_enabled_port_mask & (1 << portid)) == 0) {
634 printf("Skipping disabled port %u\n", portid);
635 nb_ports_available--;
639 printf("Initializing port %u... ", portid);
641 rte_eth_dev_info_get(portid, &dev_info);
642 if (dev_info.tx_offload_capa & DEV_TX_OFFLOAD_MBUF_FAST_FREE)
643 local_port_conf.txmode.offloads |=
644 DEV_TX_OFFLOAD_MBUF_FAST_FREE;
645 ret = rte_eth_dev_configure(portid, 1, 1, &local_port_conf);
647 rte_exit(EXIT_FAILURE, "Cannot configure device: err=%d, port=%u\n",
650 ret = rte_eth_dev_adjust_nb_rx_tx_desc(portid, &nb_rxd,
653 rte_exit(EXIT_FAILURE,
654 "Cannot adjust number of descriptors: err=%d, port=%u\n",
657 rte_eth_macaddr_get(portid,&l2fwd_ports_eth_addr[portid]);
659 /* init one RX queue */
661 rxq_conf = dev_info.default_rxconf;
662 rxq_conf.offloads = local_port_conf.rxmode.offloads;
663 ret = rte_eth_rx_queue_setup(portid, 0, nb_rxd,
664 rte_eth_dev_socket_id(portid),
668 rte_exit(EXIT_FAILURE, "rte_eth_rx_queue_setup:err=%d, port=%u\n",
671 /* init one TX queue on each port */
673 txq_conf = dev_info.default_txconf;
674 txq_conf.txq_flags = ETH_TXQ_FLAGS_IGNORE;
675 txq_conf.offloads = local_port_conf.txmode.offloads;
676 ret = rte_eth_tx_queue_setup(portid, 0, nb_txd,
677 rte_eth_dev_socket_id(portid),
680 rte_exit(EXIT_FAILURE, "rte_eth_tx_queue_setup:err=%d, port=%u\n",
683 /* Initialize TX buffers */
684 tx_buffer[portid] = rte_zmalloc_socket("tx_buffer",
685 RTE_ETH_TX_BUFFER_SIZE(MAX_PKT_BURST), 0,
686 rte_eth_dev_socket_id(portid));
687 if (tx_buffer[portid] == NULL)
688 rte_exit(EXIT_FAILURE, "Cannot allocate buffer for tx on port %u\n",
691 rte_eth_tx_buffer_init(tx_buffer[portid], MAX_PKT_BURST);
693 ret = rte_eth_tx_buffer_set_err_callback(tx_buffer[portid],
694 rte_eth_tx_buffer_count_callback,
695 &port_statistics[portid].dropped);
697 rte_exit(EXIT_FAILURE,
698 "Cannot set error callback for tx buffer on port %u\n",
702 ret = rte_eth_dev_start(portid);
704 rte_exit(EXIT_FAILURE, "rte_eth_dev_start:err=%d, port=%u\n",
709 rte_eth_promiscuous_enable(portid);
711 printf("Port %u, MAC address: %02X:%02X:%02X:%02X:%02X:%02X\n\n",
713 l2fwd_ports_eth_addr[portid].addr_bytes[0],
714 l2fwd_ports_eth_addr[portid].addr_bytes[1],
715 l2fwd_ports_eth_addr[portid].addr_bytes[2],
716 l2fwd_ports_eth_addr[portid].addr_bytes[3],
717 l2fwd_ports_eth_addr[portid].addr_bytes[4],
718 l2fwd_ports_eth_addr[portid].addr_bytes[5]);
720 /* initialize port stats */
721 memset(&port_statistics, 0, sizeof(port_statistics));
724 if (!nb_ports_available) {
725 rte_exit(EXIT_FAILURE,
726 "All available ports are disabled. Please set portmask.\n");
729 check_all_ports_link_status(nb_ports, l2fwd_enabled_port_mask);
732 /* launch per-lcore init on every lcore */
733 rte_eal_mp_remote_launch(l2fwd_launch_one_lcore, NULL, CALL_MASTER);
734 RTE_LCORE_FOREACH_SLAVE(lcore_id) {
735 if (rte_eal_wait_lcore(lcore_id) < 0) {
741 for (portid = 0; portid < nb_ports; portid++) {
742 if ((l2fwd_enabled_port_mask & (1 << portid)) == 0)
744 printf("Closing port %d...", portid);
745 rte_eth_dev_stop(portid);
746 rte_eth_dev_close(portid);