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
51 #define MAX_PKT_BURST 32
52 #define BURST_TX_DRAIN_US 100 /* TX drain every ~100us */
53 #define MEMPOOL_CACHE_SIZE 256
56 * Configurable number of RX/TX ring descriptors
58 #define RTE_TEST_RX_DESC_DEFAULT 128
59 #define RTE_TEST_TX_DESC_DEFAULT 512
60 static uint16_t nb_rxd = RTE_TEST_RX_DESC_DEFAULT;
61 static uint16_t nb_txd = RTE_TEST_TX_DESC_DEFAULT;
63 /* ethernet addresses of ports */
64 static struct ether_addr l2fwd_ports_eth_addr[RTE_MAX_ETHPORTS];
66 /* mask of enabled ports */
67 static uint32_t l2fwd_enabled_port_mask = 0;
69 /* list of enabled ports */
70 static uint32_t l2fwd_dst_ports[RTE_MAX_ETHPORTS];
72 static unsigned int l2fwd_rx_queue_per_lcore = 1;
74 #define MAX_RX_QUEUE_PER_LCORE 16
75 #define MAX_TX_QUEUE_PER_PORT 16
76 struct lcore_queue_conf {
78 unsigned rx_port_list[MAX_RX_QUEUE_PER_LCORE];
79 } __rte_cache_aligned;
80 struct lcore_queue_conf lcore_queue_conf[RTE_MAX_LCORE];
82 static struct rte_eth_dev_tx_buffer *tx_buffer[RTE_MAX_ETHPORTS];
84 static const struct rte_eth_conf port_conf = {
87 .header_split = 0, /**< Header Split disabled */
88 .hw_ip_checksum = 0, /**< IP checksum offload disabled */
89 .hw_vlan_filter = 0, /**< VLAN filtering disabled */
90 .jumbo_frame = 0, /**< Jumbo Frame Support disabled */
91 .hw_strip_crc = 1, /**< CRC stripped by hardware */
94 .mq_mode = ETH_MQ_TX_NONE,
98 struct rte_mempool * l2fwd_pktmbuf_pool = NULL;
100 /* Per-port statistics struct */
101 struct l2fwd_port_statistics {
105 } __rte_cache_aligned;
106 struct l2fwd_port_statistics port_statistics[RTE_MAX_ETHPORTS];
108 #define MAX_TIMER_PERIOD 86400 /* 1 day max */
109 /* A tsc-based timer responsible for triggering statistics printout */
110 static uint64_t timer_period = 10; /* default period is 10 seconds */
112 /* Print out statistics on packets dropped */
116 uint64_t total_packets_dropped, total_packets_tx, total_packets_rx;
119 total_packets_dropped = 0;
120 total_packets_tx = 0;
121 total_packets_rx = 0;
123 const char clr[] = { 27, '[', '2', 'J', '\0' };
124 const char topLeft[] = { 27, '[', '1', ';', '1', 'H','\0' };
126 /* Clear screen and move to top left */
127 printf("%s%s", clr, topLeft);
129 printf("\nPort statistics ====================================");
131 for (portid = 0; portid < RTE_MAX_ETHPORTS; portid++) {
132 /* skip disabled ports */
133 if ((l2fwd_enabled_port_mask & (1 << portid)) == 0)
135 printf("\nStatistics for port %u ------------------------------"
136 "\nPackets sent: %24"PRIu64
137 "\nPackets received: %20"PRIu64
138 "\nPackets dropped: %21"PRIu64,
140 port_statistics[portid].tx,
141 port_statistics[portid].rx,
142 port_statistics[portid].dropped);
144 total_packets_dropped += port_statistics[portid].dropped;
145 total_packets_tx += port_statistics[portid].tx;
146 total_packets_rx += port_statistics[portid].rx;
148 printf("\nAggregate statistics ==============================="
149 "\nTotal packets sent: %18"PRIu64
150 "\nTotal packets received: %14"PRIu64
151 "\nTotal packets dropped: %15"PRIu64,
154 total_packets_dropped);
155 printf("\n====================================================\n");
159 l2fwd_mac_updating(struct rte_mbuf *m, unsigned dest_portid)
161 struct ether_hdr *eth;
164 eth = rte_pktmbuf_mtod(m, struct ether_hdr *);
166 /* 02:00:00:00:00:xx */
167 tmp = ð->d_addr.addr_bytes[0];
168 *((uint64_t *)tmp) = 0x000000000002 + ((uint64_t)dest_portid << 40);
171 ether_addr_copy(&l2fwd_ports_eth_addr[dest_portid], ð->s_addr);
175 l2fwd_simple_forward(struct rte_mbuf *m, unsigned portid)
179 struct rte_eth_dev_tx_buffer *buffer;
181 dst_port = l2fwd_dst_ports[portid];
184 l2fwd_mac_updating(m, dst_port);
186 buffer = tx_buffer[dst_port];
187 sent = rte_eth_tx_buffer(dst_port, 0, buffer, m);
189 port_statistics[dst_port].tx += sent;
192 /* main processing loop */
194 l2fwd_main_loop(void)
196 struct rte_mbuf *pkts_burst[MAX_PKT_BURST];
200 uint64_t prev_tsc, diff_tsc, cur_tsc, timer_tsc;
201 unsigned i, j, portid, nb_rx;
202 struct lcore_queue_conf *qconf;
203 const uint64_t drain_tsc = (rte_get_tsc_hz() + US_PER_S - 1) / US_PER_S *
205 struct rte_eth_dev_tx_buffer *buffer;
210 lcore_id = rte_lcore_id();
211 qconf = &lcore_queue_conf[lcore_id];
213 if (qconf->n_rx_port == 0) {
214 RTE_LOG(INFO, L2FWD, "lcore %u has nothing to do\n", lcore_id);
218 RTE_LOG(INFO, L2FWD, "entering main loop on lcore %u\n", lcore_id);
220 for (i = 0; i < qconf->n_rx_port; i++) {
222 portid = qconf->rx_port_list[i];
223 RTE_LOG(INFO, L2FWD, " -- lcoreid=%u portid=%u\n", lcore_id,
228 while (!force_quit) {
230 cur_tsc = rte_rdtsc();
233 * TX burst queue drain
235 diff_tsc = cur_tsc - prev_tsc;
236 if (unlikely(diff_tsc > drain_tsc)) {
238 for (i = 0; i < qconf->n_rx_port; i++) {
240 portid = l2fwd_dst_ports[qconf->rx_port_list[i]];
241 buffer = tx_buffer[portid];
243 sent = rte_eth_tx_buffer_flush(portid, 0, buffer);
245 port_statistics[portid].tx += sent;
249 /* if timer is enabled */
250 if (timer_period > 0) {
252 /* advance the timer */
253 timer_tsc += diff_tsc;
255 /* if timer has reached its timeout */
256 if (unlikely(timer_tsc >= timer_period)) {
258 /* do this only on master core */
259 if (lcore_id == rte_get_master_lcore()) {
261 /* reset the timer */
271 * Read packet from RX queues
273 for (i = 0; i < qconf->n_rx_port; i++) {
275 portid = qconf->rx_port_list[i];
276 nb_rx = rte_eth_rx_burst(portid, 0,
277 pkts_burst, MAX_PKT_BURST);
279 port_statistics[portid].rx += nb_rx;
281 for (j = 0; j < nb_rx; j++) {
283 rte_prefetch0(rte_pktmbuf_mtod(m, void *));
284 l2fwd_simple_forward(m, portid);
291 l2fwd_launch_one_lcore(__attribute__((unused)) void *dummy)
299 l2fwd_usage(const char *prgname)
301 printf("%s [EAL options] -- -p PORTMASK [-q NQ]\n"
302 " -p PORTMASK: hexadecimal bitmask of ports to configure\n"
303 " -q NQ: number of queue (=ports) per lcore (default is 1)\n"
304 " -T PERIOD: statistics will be refreshed each PERIOD seconds (0 to disable, 10 default, 86400 maximum)\n"
305 " --[no-]mac-updating: Enable or disable MAC addresses updating (enabled by default)\n"
307 " - The source MAC address is replaced by the TX port MAC address\n"
308 " - The destination MAC address is replaced by 02:00:00:00:00:TX_PORT_ID\n",
313 l2fwd_parse_portmask(const char *portmask)
318 /* parse hexadecimal string */
319 pm = strtoul(portmask, &end, 16);
320 if ((portmask[0] == '\0') || (end == NULL) || (*end != '\0'))
330 l2fwd_parse_nqueue(const char *q_arg)
335 /* parse hexadecimal string */
336 n = strtoul(q_arg, &end, 10);
337 if ((q_arg[0] == '\0') || (end == NULL) || (*end != '\0'))
341 if (n >= MAX_RX_QUEUE_PER_LCORE)
348 l2fwd_parse_timer_period(const char *q_arg)
353 /* parse number string */
354 n = strtol(q_arg, &end, 10);
355 if ((q_arg[0] == '\0') || (end == NULL) || (*end != '\0'))
357 if (n >= MAX_TIMER_PERIOD)
363 static const char short_options[] =
365 "q:" /* number of queues */
366 "T:" /* timer period */
369 #define CMD_LINE_OPT_MAC_UPDATING "mac-updating"
370 #define CMD_LINE_OPT_NO_MAC_UPDATING "no-mac-updating"
373 /* long options mapped to a short option */
375 /* first long only option value must be >= 256, so that we won't
376 * conflict with short options */
377 CMD_LINE_OPT_MIN_NUM = 256,
380 static const struct option lgopts[] = {
381 { CMD_LINE_OPT_MAC_UPDATING, no_argument, &mac_updating, 1},
382 { CMD_LINE_OPT_NO_MAC_UPDATING, no_argument, &mac_updating, 0},
386 /* Parse the argument given in the command line of the application */
388 l2fwd_parse_args(int argc, char **argv)
390 int opt, ret, timer_secs;
393 char *prgname = argv[0];
397 while ((opt = getopt_long(argc, argvopt, short_options,
398 lgopts, &option_index)) != EOF) {
403 l2fwd_enabled_port_mask = l2fwd_parse_portmask(optarg);
404 if (l2fwd_enabled_port_mask == 0) {
405 printf("invalid portmask\n");
406 l2fwd_usage(prgname);
413 l2fwd_rx_queue_per_lcore = l2fwd_parse_nqueue(optarg);
414 if (l2fwd_rx_queue_per_lcore == 0) {
415 printf("invalid queue number\n");
416 l2fwd_usage(prgname);
423 timer_secs = l2fwd_parse_timer_period(optarg);
424 if (timer_secs < 0) {
425 printf("invalid timer period\n");
426 l2fwd_usage(prgname);
429 timer_period = timer_secs;
437 l2fwd_usage(prgname);
443 argv[optind-1] = prgname;
446 optind = 1; /* reset getopt lib */
450 /* Check the link status of all ports in up to 9s, and print them finally */
452 check_all_ports_link_status(uint16_t port_num, uint32_t port_mask)
454 #define CHECK_INTERVAL 100 /* 100ms */
455 #define MAX_CHECK_TIME 90 /* 9s (90 * 100ms) in total */
457 uint8_t count, all_ports_up, print_flag = 0;
458 struct rte_eth_link link;
460 printf("\nChecking link status");
462 for (count = 0; count <= MAX_CHECK_TIME; count++) {
466 for (portid = 0; portid < port_num; portid++) {
469 if ((port_mask & (1 << portid)) == 0)
471 memset(&link, 0, sizeof(link));
472 rte_eth_link_get_nowait(portid, &link);
473 /* print link status if flag set */
474 if (print_flag == 1) {
475 if (link.link_status)
477 "Port%d Link Up. Speed %u Mbps - %s\n",
478 portid, link.link_speed,
479 (link.link_duplex == ETH_LINK_FULL_DUPLEX) ?
480 ("full-duplex") : ("half-duplex\n"));
482 printf("Port %d Link Down\n", portid);
485 /* clear all_ports_up flag if any link down */
486 if (link.link_status == ETH_LINK_DOWN) {
491 /* after finally printing all link status, get out */
495 if (all_ports_up == 0) {
498 rte_delay_ms(CHECK_INTERVAL);
501 /* set the print_flag if all ports up or timeout */
502 if (all_ports_up == 1 || count == (MAX_CHECK_TIME - 1)) {
510 signal_handler(int signum)
512 if (signum == SIGINT || signum == SIGTERM) {
513 printf("\n\nSignal %d received, preparing to exit...\n",
520 main(int argc, char **argv)
522 struct lcore_queue_conf *qconf;
525 uint16_t nb_ports_available;
526 uint16_t portid, last_port;
527 unsigned lcore_id, rx_lcore_id;
528 unsigned nb_ports_in_mask = 0;
531 ret = rte_eal_init(argc, argv);
533 rte_exit(EXIT_FAILURE, "Invalid EAL arguments\n");
538 signal(SIGINT, signal_handler);
539 signal(SIGTERM, signal_handler);
541 /* parse application arguments (after the EAL ones) */
542 ret = l2fwd_parse_args(argc, argv);
544 rte_exit(EXIT_FAILURE, "Invalid L2FWD arguments\n");
546 printf("MAC updating %s\n", mac_updating ? "enabled" : "disabled");
548 /* convert to number of cycles */
549 timer_period *= rte_get_timer_hz();
551 /* create the mbuf pool */
552 l2fwd_pktmbuf_pool = rte_pktmbuf_pool_create("mbuf_pool", NB_MBUF,
553 MEMPOOL_CACHE_SIZE, 0, RTE_MBUF_DEFAULT_BUF_SIZE,
555 if (l2fwd_pktmbuf_pool == NULL)
556 rte_exit(EXIT_FAILURE, "Cannot init mbuf pool\n");
558 nb_ports = rte_eth_dev_count();
560 rte_exit(EXIT_FAILURE, "No Ethernet ports - bye\n");
562 /* reset l2fwd_dst_ports */
563 for (portid = 0; portid < RTE_MAX_ETHPORTS; portid++)
564 l2fwd_dst_ports[portid] = 0;
568 * Each logical core is assigned a dedicated TX queue on each port.
570 for (portid = 0; portid < nb_ports; portid++) {
571 /* skip ports that are not enabled */
572 if ((l2fwd_enabled_port_mask & (1 << portid)) == 0)
575 if (nb_ports_in_mask % 2) {
576 l2fwd_dst_ports[portid] = last_port;
577 l2fwd_dst_ports[last_port] = portid;
584 if (nb_ports_in_mask % 2) {
585 printf("Notice: odd number of ports in portmask.\n");
586 l2fwd_dst_ports[last_port] = last_port;
592 /* Initialize the port/queue configuration of each logical core */
593 for (portid = 0; portid < nb_ports; portid++) {
594 /* skip ports that are not enabled */
595 if ((l2fwd_enabled_port_mask & (1 << portid)) == 0)
598 /* get the lcore_id for this port */
599 while (rte_lcore_is_enabled(rx_lcore_id) == 0 ||
600 lcore_queue_conf[rx_lcore_id].n_rx_port ==
601 l2fwd_rx_queue_per_lcore) {
603 if (rx_lcore_id >= RTE_MAX_LCORE)
604 rte_exit(EXIT_FAILURE, "Not enough cores\n");
607 if (qconf != &lcore_queue_conf[rx_lcore_id])
608 /* Assigned a new logical core in the loop above. */
609 qconf = &lcore_queue_conf[rx_lcore_id];
611 qconf->rx_port_list[qconf->n_rx_port] = portid;
613 printf("Lcore %u: RX port %u\n", rx_lcore_id, portid);
616 nb_ports_available = nb_ports;
618 /* Initialise each port */
619 for (portid = 0; portid < nb_ports; portid++) {
620 /* skip ports that are not enabled */
621 if ((l2fwd_enabled_port_mask & (1 << portid)) == 0) {
622 printf("Skipping disabled port %u\n", portid);
623 nb_ports_available--;
627 printf("Initializing port %u... ", portid);
629 ret = rte_eth_dev_configure(portid, 1, 1, &port_conf);
631 rte_exit(EXIT_FAILURE, "Cannot configure device: err=%d, port=%u\n",
634 ret = rte_eth_dev_adjust_nb_rx_tx_desc(portid, &nb_rxd,
637 rte_exit(EXIT_FAILURE,
638 "Cannot adjust number of descriptors: err=%d, port=%u\n",
641 rte_eth_macaddr_get(portid,&l2fwd_ports_eth_addr[portid]);
643 /* init one RX queue */
645 ret = rte_eth_rx_queue_setup(portid, 0, nb_rxd,
646 rte_eth_dev_socket_id(portid),
650 rte_exit(EXIT_FAILURE, "rte_eth_rx_queue_setup:err=%d, port=%u\n",
653 /* init one TX queue on each port */
655 ret = rte_eth_tx_queue_setup(portid, 0, nb_txd,
656 rte_eth_dev_socket_id(portid),
659 rte_exit(EXIT_FAILURE, "rte_eth_tx_queue_setup:err=%d, port=%u\n",
662 /* Initialize TX buffers */
663 tx_buffer[portid] = rte_zmalloc_socket("tx_buffer",
664 RTE_ETH_TX_BUFFER_SIZE(MAX_PKT_BURST), 0,
665 rte_eth_dev_socket_id(portid));
666 if (tx_buffer[portid] == NULL)
667 rte_exit(EXIT_FAILURE, "Cannot allocate buffer for tx on port %u\n",
670 rte_eth_tx_buffer_init(tx_buffer[portid], MAX_PKT_BURST);
672 ret = rte_eth_tx_buffer_set_err_callback(tx_buffer[portid],
673 rte_eth_tx_buffer_count_callback,
674 &port_statistics[portid].dropped);
676 rte_exit(EXIT_FAILURE,
677 "Cannot set error callback for tx buffer on port %u\n",
681 ret = rte_eth_dev_start(portid);
683 rte_exit(EXIT_FAILURE, "rte_eth_dev_start:err=%d, port=%u\n",
688 rte_eth_promiscuous_enable(portid);
690 printf("Port %u, MAC address: %02X:%02X:%02X:%02X:%02X:%02X\n\n",
692 l2fwd_ports_eth_addr[portid].addr_bytes[0],
693 l2fwd_ports_eth_addr[portid].addr_bytes[1],
694 l2fwd_ports_eth_addr[portid].addr_bytes[2],
695 l2fwd_ports_eth_addr[portid].addr_bytes[3],
696 l2fwd_ports_eth_addr[portid].addr_bytes[4],
697 l2fwd_ports_eth_addr[portid].addr_bytes[5]);
699 /* initialize port stats */
700 memset(&port_statistics, 0, sizeof(port_statistics));
703 if (!nb_ports_available) {
704 rte_exit(EXIT_FAILURE,
705 "All available ports are disabled. Please set portmask.\n");
708 check_all_ports_link_status(nb_ports, l2fwd_enabled_port_mask);
711 /* launch per-lcore init on every lcore */
712 rte_eal_mp_remote_launch(l2fwd_launch_one_lcore, NULL, CALL_MASTER);
713 RTE_LCORE_FOREACH_SLAVE(lcore_id) {
714 if (rte_eal_wait_lcore(lcore_id) < 0) {
720 for (portid = 0; portid < nb_ports; portid++) {
721 if ((l2fwd_enabled_port_mask & (1 << portid)) == 0)
723 printf("Closing port %d...", portid);
724 rte_eth_dev_stop(portid);
725 rte_eth_dev_close(portid);