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 128
57 #define RTE_TEST_TX_DESC_DEFAULT 512
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 const struct rte_eth_conf port_conf = {
85 .header_split = 0, /**< Header Split disabled */
86 .hw_ip_checksum = 0, /**< IP checksum offload disabled */
87 .hw_vlan_filter = 0, /**< VLAN filtering disabled */
88 .jumbo_frame = 0, /**< Jumbo Frame Support disabled */
89 .hw_strip_crc = 1, /**< CRC stripped by hardware */
92 .mq_mode = ETH_MQ_TX_NONE,
96 struct rte_mempool * l2fwd_pktmbuf_pool = NULL;
98 /* Per-port statistics struct */
99 struct l2fwd_port_statistics {
103 } __rte_cache_aligned;
104 struct l2fwd_port_statistics port_statistics[RTE_MAX_ETHPORTS];
106 #define MAX_TIMER_PERIOD 86400 /* 1 day max */
107 /* A tsc-based timer responsible for triggering statistics printout */
108 static uint64_t timer_period = 10; /* default period is 10 seconds */
110 /* Print out statistics on packets dropped */
114 uint64_t total_packets_dropped, total_packets_tx, total_packets_rx;
117 total_packets_dropped = 0;
118 total_packets_tx = 0;
119 total_packets_rx = 0;
121 const char clr[] = { 27, '[', '2', 'J', '\0' };
122 const char topLeft[] = { 27, '[', '1', ';', '1', 'H','\0' };
124 /* Clear screen and move to top left */
125 printf("%s%s", clr, topLeft);
127 printf("\nPort statistics ====================================");
129 for (portid = 0; portid < RTE_MAX_ETHPORTS; portid++) {
130 /* skip disabled ports */
131 if ((l2fwd_enabled_port_mask & (1 << portid)) == 0)
133 printf("\nStatistics for port %u ------------------------------"
134 "\nPackets sent: %24"PRIu64
135 "\nPackets received: %20"PRIu64
136 "\nPackets dropped: %21"PRIu64,
138 port_statistics[portid].tx,
139 port_statistics[portid].rx,
140 port_statistics[portid].dropped);
142 total_packets_dropped += port_statistics[portid].dropped;
143 total_packets_tx += port_statistics[portid].tx;
144 total_packets_rx += port_statistics[portid].rx;
146 printf("\nAggregate statistics ==============================="
147 "\nTotal packets sent: %18"PRIu64
148 "\nTotal packets received: %14"PRIu64
149 "\nTotal packets dropped: %15"PRIu64,
152 total_packets_dropped);
153 printf("\n====================================================\n");
157 l2fwd_mac_updating(struct rte_mbuf *m, unsigned dest_portid)
159 struct ether_hdr *eth;
162 eth = rte_pktmbuf_mtod(m, struct ether_hdr *);
164 /* 02:00:00:00:00:xx */
165 tmp = ð->d_addr.addr_bytes[0];
166 *((uint64_t *)tmp) = 0x000000000002 + ((uint64_t)dest_portid << 40);
169 ether_addr_copy(&l2fwd_ports_eth_addr[dest_portid], ð->s_addr);
173 l2fwd_simple_forward(struct rte_mbuf *m, unsigned portid)
177 struct rte_eth_dev_tx_buffer *buffer;
179 dst_port = l2fwd_dst_ports[portid];
182 l2fwd_mac_updating(m, dst_port);
184 buffer = tx_buffer[dst_port];
185 sent = rte_eth_tx_buffer(dst_port, 0, buffer, m);
187 port_statistics[dst_port].tx += sent;
190 /* main processing loop */
192 l2fwd_main_loop(void)
194 struct rte_mbuf *pkts_burst[MAX_PKT_BURST];
198 uint64_t prev_tsc, diff_tsc, cur_tsc, timer_tsc;
199 unsigned i, j, portid, nb_rx;
200 struct lcore_queue_conf *qconf;
201 const uint64_t drain_tsc = (rte_get_tsc_hz() + US_PER_S - 1) / US_PER_S *
203 struct rte_eth_dev_tx_buffer *buffer;
208 lcore_id = rte_lcore_id();
209 qconf = &lcore_queue_conf[lcore_id];
211 if (qconf->n_rx_port == 0) {
212 RTE_LOG(INFO, L2FWD, "lcore %u has nothing to do\n", lcore_id);
216 RTE_LOG(INFO, L2FWD, "entering main loop on lcore %u\n", lcore_id);
218 for (i = 0; i < qconf->n_rx_port; i++) {
220 portid = qconf->rx_port_list[i];
221 RTE_LOG(INFO, L2FWD, " -- lcoreid=%u portid=%u\n", lcore_id,
226 while (!force_quit) {
228 cur_tsc = rte_rdtsc();
231 * TX burst queue drain
233 diff_tsc = cur_tsc - prev_tsc;
234 if (unlikely(diff_tsc > drain_tsc)) {
236 for (i = 0; i < qconf->n_rx_port; i++) {
238 portid = l2fwd_dst_ports[qconf->rx_port_list[i]];
239 buffer = tx_buffer[portid];
241 sent = rte_eth_tx_buffer_flush(portid, 0, buffer);
243 port_statistics[portid].tx += sent;
247 /* if timer is enabled */
248 if (timer_period > 0) {
250 /* advance the timer */
251 timer_tsc += diff_tsc;
253 /* if timer has reached its timeout */
254 if (unlikely(timer_tsc >= timer_period)) {
256 /* do this only on master core */
257 if (lcore_id == rte_get_master_lcore()) {
259 /* reset the timer */
269 * Read packet from RX queues
271 for (i = 0; i < qconf->n_rx_port; i++) {
273 portid = qconf->rx_port_list[i];
274 nb_rx = rte_eth_rx_burst(portid, 0,
275 pkts_burst, MAX_PKT_BURST);
277 port_statistics[portid].rx += nb_rx;
279 for (j = 0; j < nb_rx; j++) {
281 rte_prefetch0(rte_pktmbuf_mtod(m, void *));
282 l2fwd_simple_forward(m, portid);
289 l2fwd_launch_one_lcore(__attribute__((unused)) void *dummy)
297 l2fwd_usage(const char *prgname)
299 printf("%s [EAL options] -- -p PORTMASK [-q NQ]\n"
300 " -p PORTMASK: hexadecimal bitmask of ports to configure\n"
301 " -q NQ: number of queue (=ports) per lcore (default is 1)\n"
302 " -T PERIOD: statistics will be refreshed each PERIOD seconds (0 to disable, 10 default, 86400 maximum)\n"
303 " --[no-]mac-updating: Enable or disable MAC addresses updating (enabled by default)\n"
305 " - The source MAC address is replaced by the TX port MAC address\n"
306 " - The destination MAC address is replaced by 02:00:00:00:00:TX_PORT_ID\n",
311 l2fwd_parse_portmask(const char *portmask)
316 /* parse hexadecimal string */
317 pm = strtoul(portmask, &end, 16);
318 if ((portmask[0] == '\0') || (end == NULL) || (*end != '\0'))
328 l2fwd_parse_nqueue(const char *q_arg)
333 /* parse hexadecimal string */
334 n = strtoul(q_arg, &end, 10);
335 if ((q_arg[0] == '\0') || (end == NULL) || (*end != '\0'))
339 if (n >= MAX_RX_QUEUE_PER_LCORE)
346 l2fwd_parse_timer_period(const char *q_arg)
351 /* parse number string */
352 n = strtol(q_arg, &end, 10);
353 if ((q_arg[0] == '\0') || (end == NULL) || (*end != '\0'))
355 if (n >= MAX_TIMER_PERIOD)
361 static const char short_options[] =
363 "q:" /* number of queues */
364 "T:" /* timer period */
367 #define CMD_LINE_OPT_MAC_UPDATING "mac-updating"
368 #define CMD_LINE_OPT_NO_MAC_UPDATING "no-mac-updating"
371 /* long options mapped to a short option */
373 /* first long only option value must be >= 256, so that we won't
374 * conflict with short options */
375 CMD_LINE_OPT_MIN_NUM = 256,
378 static const struct option lgopts[] = {
379 { CMD_LINE_OPT_MAC_UPDATING, no_argument, &mac_updating, 1},
380 { CMD_LINE_OPT_NO_MAC_UPDATING, no_argument, &mac_updating, 0},
384 /* Parse the argument given in the command line of the application */
386 l2fwd_parse_args(int argc, char **argv)
388 int opt, ret, timer_secs;
391 char *prgname = argv[0];
395 while ((opt = getopt_long(argc, argvopt, short_options,
396 lgopts, &option_index)) != EOF) {
401 l2fwd_enabled_port_mask = l2fwd_parse_portmask(optarg);
402 if (l2fwd_enabled_port_mask == 0) {
403 printf("invalid portmask\n");
404 l2fwd_usage(prgname);
411 l2fwd_rx_queue_per_lcore = l2fwd_parse_nqueue(optarg);
412 if (l2fwd_rx_queue_per_lcore == 0) {
413 printf("invalid queue number\n");
414 l2fwd_usage(prgname);
421 timer_secs = l2fwd_parse_timer_period(optarg);
422 if (timer_secs < 0) {
423 printf("invalid timer period\n");
424 l2fwd_usage(prgname);
427 timer_period = timer_secs;
435 l2fwd_usage(prgname);
441 argv[optind-1] = prgname;
444 optind = 1; /* reset getopt lib */
448 /* Check the link status of all ports in up to 9s, and print them finally */
450 check_all_ports_link_status(uint16_t port_num, uint32_t port_mask)
452 #define CHECK_INTERVAL 100 /* 100ms */
453 #define MAX_CHECK_TIME 90 /* 9s (90 * 100ms) in total */
455 uint8_t count, all_ports_up, print_flag = 0;
456 struct rte_eth_link link;
458 printf("\nChecking link status");
460 for (count = 0; count <= MAX_CHECK_TIME; count++) {
464 for (portid = 0; portid < port_num; portid++) {
467 if ((port_mask & (1 << portid)) == 0)
469 memset(&link, 0, sizeof(link));
470 rte_eth_link_get_nowait(portid, &link);
471 /* print link status if flag set */
472 if (print_flag == 1) {
473 if (link.link_status)
475 "Port%d Link Up. Speed %u Mbps - %s\n",
476 portid, link.link_speed,
477 (link.link_duplex == ETH_LINK_FULL_DUPLEX) ?
478 ("full-duplex") : ("half-duplex\n"));
480 printf("Port %d Link Down\n", portid);
483 /* clear all_ports_up flag if any link down */
484 if (link.link_status == ETH_LINK_DOWN) {
489 /* after finally printing all link status, get out */
493 if (all_ports_up == 0) {
496 rte_delay_ms(CHECK_INTERVAL);
499 /* set the print_flag if all ports up or timeout */
500 if (all_ports_up == 1 || count == (MAX_CHECK_TIME - 1)) {
508 signal_handler(int signum)
510 if (signum == SIGINT || signum == SIGTERM) {
511 printf("\n\nSignal %d received, preparing to exit...\n",
518 main(int argc, char **argv)
520 struct lcore_queue_conf *qconf;
523 uint16_t nb_ports_available;
524 uint16_t portid, last_port;
525 unsigned lcore_id, rx_lcore_id;
526 unsigned nb_ports_in_mask = 0;
527 unsigned int nb_lcores = 0;
528 unsigned int nb_mbufs;
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 nb_ports = rte_eth_dev_count();
553 rte_exit(EXIT_FAILURE, "No Ethernet ports - bye\n");
555 /* reset l2fwd_dst_ports */
556 for (portid = 0; portid < RTE_MAX_ETHPORTS; portid++)
557 l2fwd_dst_ports[portid] = 0;
561 * Each logical core is assigned a dedicated TX queue on each port.
563 for (portid = 0; portid < nb_ports; portid++) {
564 /* skip ports that are not enabled */
565 if ((l2fwd_enabled_port_mask & (1 << portid)) == 0)
568 if (nb_ports_in_mask % 2) {
569 l2fwd_dst_ports[portid] = last_port;
570 l2fwd_dst_ports[last_port] = portid;
577 if (nb_ports_in_mask % 2) {
578 printf("Notice: odd number of ports in portmask.\n");
579 l2fwd_dst_ports[last_port] = last_port;
585 /* Initialize the port/queue configuration of each logical core */
586 for (portid = 0; portid < nb_ports; portid++) {
587 /* skip ports that are not enabled */
588 if ((l2fwd_enabled_port_mask & (1 << portid)) == 0)
591 /* get the lcore_id for this port */
592 while (rte_lcore_is_enabled(rx_lcore_id) == 0 ||
593 lcore_queue_conf[rx_lcore_id].n_rx_port ==
594 l2fwd_rx_queue_per_lcore) {
596 if (rx_lcore_id >= RTE_MAX_LCORE)
597 rte_exit(EXIT_FAILURE, "Not enough cores\n");
600 if (qconf != &lcore_queue_conf[rx_lcore_id]) {
601 /* Assigned a new logical core in the loop above. */
602 qconf = &lcore_queue_conf[rx_lcore_id];
606 qconf->rx_port_list[qconf->n_rx_port] = portid;
608 printf("Lcore %u: RX port %u\n", rx_lcore_id, portid);
611 nb_ports_available = nb_ports;
613 nb_mbufs = RTE_MAX(nb_ports * (nb_rxd + nb_txd + MAX_PKT_BURST +
614 nb_lcores * MEMPOOL_CACHE_SIZE), 8192U);
616 /* create the mbuf pool */
617 l2fwd_pktmbuf_pool = rte_pktmbuf_pool_create("mbuf_pool", nb_mbufs,
618 MEMPOOL_CACHE_SIZE, 0, RTE_MBUF_DEFAULT_BUF_SIZE,
620 if (l2fwd_pktmbuf_pool == NULL)
621 rte_exit(EXIT_FAILURE, "Cannot init mbuf pool\n");
623 /* Initialise each port */
624 for (portid = 0; portid < nb_ports; portid++) {
625 /* skip ports that are not enabled */
626 if ((l2fwd_enabled_port_mask & (1 << portid)) == 0) {
627 printf("Skipping disabled port %u\n", portid);
628 nb_ports_available--;
632 printf("Initializing port %u... ", portid);
634 ret = rte_eth_dev_configure(portid, 1, 1, &port_conf);
636 rte_exit(EXIT_FAILURE, "Cannot configure device: err=%d, port=%u\n",
639 ret = rte_eth_dev_adjust_nb_rx_tx_desc(portid, &nb_rxd,
642 rte_exit(EXIT_FAILURE,
643 "Cannot adjust number of descriptors: err=%d, port=%u\n",
646 rte_eth_macaddr_get(portid,&l2fwd_ports_eth_addr[portid]);
648 /* init one RX queue */
650 ret = rte_eth_rx_queue_setup(portid, 0, nb_rxd,
651 rte_eth_dev_socket_id(portid),
655 rte_exit(EXIT_FAILURE, "rte_eth_rx_queue_setup:err=%d, port=%u\n",
658 /* init one TX queue on each port */
660 ret = rte_eth_tx_queue_setup(portid, 0, nb_txd,
661 rte_eth_dev_socket_id(portid),
664 rte_exit(EXIT_FAILURE, "rte_eth_tx_queue_setup:err=%d, port=%u\n",
667 /* Initialize TX buffers */
668 tx_buffer[portid] = rte_zmalloc_socket("tx_buffer",
669 RTE_ETH_TX_BUFFER_SIZE(MAX_PKT_BURST), 0,
670 rte_eth_dev_socket_id(portid));
671 if (tx_buffer[portid] == NULL)
672 rte_exit(EXIT_FAILURE, "Cannot allocate buffer for tx on port %u\n",
675 rte_eth_tx_buffer_init(tx_buffer[portid], MAX_PKT_BURST);
677 ret = rte_eth_tx_buffer_set_err_callback(tx_buffer[portid],
678 rte_eth_tx_buffer_count_callback,
679 &port_statistics[portid].dropped);
681 rte_exit(EXIT_FAILURE,
682 "Cannot set error callback for tx buffer on port %u\n",
686 ret = rte_eth_dev_start(portid);
688 rte_exit(EXIT_FAILURE, "rte_eth_dev_start:err=%d, port=%u\n",
693 rte_eth_promiscuous_enable(portid);
695 printf("Port %u, MAC address: %02X:%02X:%02X:%02X:%02X:%02X\n\n",
697 l2fwd_ports_eth_addr[portid].addr_bytes[0],
698 l2fwd_ports_eth_addr[portid].addr_bytes[1],
699 l2fwd_ports_eth_addr[portid].addr_bytes[2],
700 l2fwd_ports_eth_addr[portid].addr_bytes[3],
701 l2fwd_ports_eth_addr[portid].addr_bytes[4],
702 l2fwd_ports_eth_addr[portid].addr_bytes[5]);
704 /* initialize port stats */
705 memset(&port_statistics, 0, sizeof(port_statistics));
708 if (!nb_ports_available) {
709 rte_exit(EXIT_FAILURE,
710 "All available ports are disabled. Please set portmask.\n");
713 check_all_ports_link_status(nb_ports, l2fwd_enabled_port_mask);
716 /* launch per-lcore init on every lcore */
717 rte_eal_mp_remote_launch(l2fwd_launch_one_lcore, NULL, CALL_MASTER);
718 RTE_LCORE_FOREACH_SLAVE(lcore_id) {
719 if (rte_eal_wait_lcore(lcore_id) < 0) {
725 for (portid = 0; portid < nb_ports; portid++) {
726 if ((l2fwd_enabled_port_mask & (1 << portid)) == 0)
728 printf("Closing port %d...", portid);
729 rte_eth_dev_stop(portid);
730 rte_eth_dev_close(portid);