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>
20 #include <rte_common.h>
22 #include <rte_malloc.h>
23 #include <rte_memory.h>
24 #include <rte_memcpy.h>
26 #include <rte_launch.h>
27 #include <rte_cycles.h>
28 #include <rte_prefetch.h>
29 #include <rte_lcore.h>
30 #include <rte_per_lcore.h>
31 #include <rte_branch_prediction.h>
32 #include <rte_interrupts.h>
33 #include <rte_random.h>
34 #include <rte_debug.h>
35 #include <rte_ether.h>
36 #include <rte_ethdev.h>
37 #include <rte_mempool.h>
39 #include <rte_timer.h>
40 #include <rte_keepalive.h>
44 #define RTE_LOGTYPE_L2FWD RTE_LOGTYPE_USER1
46 #define NB_MBUF_PER_PORT 3000
48 #define MAX_PKT_BURST 32
49 #define BURST_TX_DRAIN_US 100 /* TX drain every ~100us */
52 * Configurable number of RX/TX ring descriptors
54 #define RTE_TEST_RX_DESC_DEFAULT 1024
55 #define RTE_TEST_TX_DESC_DEFAULT 1024
56 static uint16_t nb_rxd = RTE_TEST_RX_DESC_DEFAULT;
57 static uint16_t nb_txd = RTE_TEST_TX_DESC_DEFAULT;
59 /* ethernet addresses of ports */
60 static struct rte_ether_addr l2fwd_ports_eth_addr[RTE_MAX_ETHPORTS];
62 /* mask of enabled ports */
63 static uint32_t l2fwd_enabled_port_mask;
65 /* list of enabled ports */
66 static uint32_t l2fwd_dst_ports[RTE_MAX_ETHPORTS];
68 static unsigned int l2fwd_rx_queue_per_lcore = 1;
70 #define MAX_RX_QUEUE_PER_LCORE 16
71 #define MAX_TX_QUEUE_PER_PORT 16
72 struct lcore_queue_conf {
74 unsigned rx_port_list[MAX_RX_QUEUE_PER_LCORE];
75 } __rte_cache_aligned;
76 struct lcore_queue_conf lcore_queue_conf[RTE_MAX_LCORE];
78 struct rte_eth_dev_tx_buffer *tx_buffer[RTE_MAX_ETHPORTS];
80 static struct rte_eth_conf port_conf = {
85 .mq_mode = RTE_ETH_MQ_TX_NONE,
89 struct rte_mempool *l2fwd_pktmbuf_pool = NULL;
91 /* Per-port statistics struct */
92 struct l2fwd_port_statistics {
96 } __rte_cache_aligned;
97 struct l2fwd_port_statistics port_statistics[RTE_MAX_ETHPORTS];
99 /* A tsc-based timer responsible for triggering statistics printout */
100 #define TIMER_MILLISECOND 1
101 #define MAX_TIMER_PERIOD 86400 /* 1 day max */
102 static int64_t timer_period = 10 * TIMER_MILLISECOND * 1000; /* 10 seconds */
103 static int64_t check_period = 5; /* default check cycle is 5ms */
105 /* Keepalive structure */
106 struct rte_keepalive *rte_global_keepalive_info;
108 /* Termination signalling */
109 static int terminate_signal_received;
111 /* Termination signal handler */
112 static void handle_sigterm(__rte_unused int value)
114 terminate_signal_received = 1;
117 /* Print out statistics on packets dropped */
119 print_stats(__rte_unused struct rte_timer *ptr_timer,
120 __rte_unused void *ptr_data)
122 uint64_t total_packets_dropped, total_packets_tx, total_packets_rx;
125 total_packets_dropped = 0;
126 total_packets_tx = 0;
127 total_packets_rx = 0;
129 const char clr[] = { 27, '[', '2', 'J', '\0' };
130 const char topLeft[] = { 27, '[', '1', ';', '1', 'H', '\0' };
132 /* Clear screen and move to top left */
133 printf("%s%s", clr, topLeft);
135 printf("\nPort statistics ====================================");
137 for (portid = 0; portid < RTE_MAX_ETHPORTS; portid++) {
138 /* skip disabled ports */
139 if ((l2fwd_enabled_port_mask & (1 << portid)) == 0)
141 printf("\nStatistics for port %u ------------------------------"
142 "\nPackets sent: %24"PRIu64
143 "\nPackets received: %20"PRIu64
144 "\nPackets dropped: %21"PRIu64,
146 port_statistics[portid].tx,
147 port_statistics[portid].rx,
148 port_statistics[portid].dropped);
150 total_packets_dropped += port_statistics[portid].dropped;
151 total_packets_tx += port_statistics[portid].tx;
152 total_packets_rx += port_statistics[portid].rx;
154 printf("\nAggregate statistics ==============================="
155 "\nTotal packets sent: %18"PRIu64
156 "\nTotal packets received: %14"PRIu64
157 "\nTotal packets dropped: %15"PRIu64,
160 total_packets_dropped);
161 printf("\n====================================================\n");
167 l2fwd_simple_forward(struct rte_mbuf *m, unsigned portid)
169 struct rte_ether_hdr *eth;
173 struct rte_eth_dev_tx_buffer *buffer;
175 dst_port = l2fwd_dst_ports[portid];
176 eth = rte_pktmbuf_mtod(m, struct rte_ether_hdr *);
178 /* 02:00:00:00:00:xx */
179 tmp = ð->dst_addr.addr_bytes[0];
180 *((uint64_t *)tmp) = 0x000000000002 + ((uint64_t)dst_port << 40);
183 rte_ether_addr_copy(&l2fwd_ports_eth_addr[dst_port], ð->src_addr);
185 buffer = tx_buffer[dst_port];
186 sent = rte_eth_tx_buffer(dst_port, 0, buffer, m);
188 port_statistics[dst_port].tx += sent;
191 /* main processing loop */
193 l2fwd_main_loop(void)
195 struct rte_mbuf *pkts_burst[MAX_PKT_BURST];
199 uint64_t prev_tsc, diff_tsc, cur_tsc;
200 unsigned i, j, portid, nb_rx;
201 struct lcore_queue_conf *qconf;
202 const uint64_t drain_tsc = (rte_get_tsc_hz() + US_PER_S - 1)
203 / US_PER_S * BURST_TX_DRAIN_US;
204 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,
225 uint64_t tsc_initial = rte_rdtsc();
226 uint64_t tsc_lifetime = (rand()&0x07) * rte_get_tsc_hz();
228 while (!terminate_signal_received) {
229 /* Keepalive heartbeat. 8< */
230 rte_keepalive_mark_alive(rte_global_keepalive_info);
232 cur_tsc = rte_rdtsc();
235 * Die randomly within 7 secs for demo purposes if
238 if (check_period > 0 && cur_tsc - tsc_initial > tsc_lifetime)
240 /* >8 End of keepalive heartbeat. */
243 * TX burst queue drain
245 diff_tsc = cur_tsc - prev_tsc;
246 if (unlikely(diff_tsc > drain_tsc)) {
248 for (i = 0; i < qconf->n_rx_port; i++) {
250 portid = l2fwd_dst_ports[qconf->rx_port_list[i]];
251 buffer = tx_buffer[portid];
253 sent = rte_eth_tx_buffer_flush(portid, 0, buffer);
255 port_statistics[portid].tx += sent;
263 * Read packet from RX queues
265 for (i = 0; i < qconf->n_rx_port; i++) {
267 portid = qconf->rx_port_list[i];
268 nb_rx = rte_eth_rx_burst(portid, 0,
269 pkts_burst, MAX_PKT_BURST);
271 port_statistics[portid].rx += nb_rx;
273 for (j = 0; j < nb_rx; j++) {
275 rte_prefetch0(rte_pktmbuf_mtod(m, void *));
276 l2fwd_simple_forward(m, portid);
283 l2fwd_launch_one_lcore(__rte_unused void *dummy)
291 l2fwd_usage(const char *prgname)
293 printf("%s [EAL options] -- -p PORTMASK [-q NQ]\n"
294 " -p PORTMASK: hexadecimal bitmask of ports to configure\n"
295 " -q NQ: number of queue (=ports) per lcore (default is 1)\n"
296 " -K PERIOD: Keepalive check period (5 default; 86400 max)\n"
297 " -T PERIOD: statistics will be refreshed each PERIOD seconds (0 to disable, 10 default, 86400 maximum)\n",
302 l2fwd_parse_portmask(const char *portmask)
307 /* parse hexadecimal string */
308 pm = strtoul(portmask, &end, 16);
309 if ((portmask[0] == '\0') || (end == NULL) || (*end != '\0'))
316 l2fwd_parse_nqueue(const char *q_arg)
321 /* parse hexadecimal string */
322 n = strtoul(q_arg, &end, 10);
323 if ((q_arg[0] == '\0') || (end == NULL) || (*end != '\0'))
327 if (n >= MAX_RX_QUEUE_PER_LCORE)
334 l2fwd_parse_timer_period(const char *q_arg)
339 /* parse number string */
340 n = strtol(q_arg, &end, 10);
341 if ((q_arg[0] == '\0') || (end == NULL) || (*end != '\0'))
343 if (n >= MAX_TIMER_PERIOD)
350 l2fwd_parse_check_period(const char *q_arg)
355 /* parse number string */
356 n = strtol(q_arg, &end, 10);
357 if ((q_arg[0] == '\0') || (end == NULL) || (*end != '\0'))
359 if (n >= MAX_TIMER_PERIOD)
365 /* Parse the argument given in the command line of the application */
367 l2fwd_parse_args(int argc, char **argv)
372 char *prgname = argv[0];
373 static struct option lgopts[] = {
379 while ((opt = getopt_long(argc, argvopt, "p:q:T:K:",
380 lgopts, &option_index)) != EOF) {
385 l2fwd_enabled_port_mask = l2fwd_parse_portmask(optarg);
386 if (l2fwd_enabled_port_mask == 0) {
387 printf("invalid portmask\n");
388 l2fwd_usage(prgname);
395 l2fwd_rx_queue_per_lcore = l2fwd_parse_nqueue(optarg);
396 if (l2fwd_rx_queue_per_lcore == 0) {
397 printf("invalid queue number\n");
398 l2fwd_usage(prgname);
405 timer_period = l2fwd_parse_timer_period(optarg)
406 * (int64_t)(1000 * TIMER_MILLISECOND);
407 if (timer_period < 0) {
408 printf("invalid timer period\n");
409 l2fwd_usage(prgname);
416 check_period = l2fwd_parse_check_period(optarg);
417 if (check_period < 0) {
418 printf("invalid check period\n");
419 l2fwd_usage(prgname);
426 l2fwd_usage(prgname);
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;
453 char link_status_text[RTE_ETH_LINK_MAX_STR_LEN];
455 printf("\nChecking link status");
457 for (count = 0; count <= MAX_CHECK_TIME; count++) {
459 RTE_ETH_FOREACH_DEV(portid) {
460 if ((port_mask & (1 << portid)) == 0)
462 memset(&link, 0, sizeof(link));
463 ret = rte_eth_link_get_nowait(portid, &link);
467 printf("Port %u link get failed: %s\n",
468 portid, rte_strerror(-ret));
471 /* print link status if flag set */
472 if (print_flag == 1) {
473 rte_eth_link_to_str(link_status_text,
474 sizeof(link_status_text), &link);
475 printf("Port %d %s\n", portid,
479 /* clear all_ports_up flag if any link down */
480 if (link.link_status == RTE_ETH_LINK_DOWN) {
485 /* after finally printing all link status, get out */
489 if (all_ports_up == 0) {
492 rte_delay_ms(CHECK_INTERVAL);
495 /* set the print_flag if all ports up or timeout */
496 if (all_ports_up == 1 || count == (MAX_CHECK_TIME - 1)) {
504 dead_core(__rte_unused void *ptr_data, const int id_core)
506 if (terminate_signal_received)
508 printf("Dead core %i - restarting..\n", id_core);
509 if (rte_eal_get_lcore_state(id_core) == WAIT) {
510 rte_eal_remote_launch(l2fwd_launch_one_lcore, NULL, id_core);
512 printf("..false positive!\n");
517 relay_core_state(void *ptr_data, const int id_core,
518 const enum rte_keepalive_state core_state, uint64_t last_alive)
520 rte_keepalive_relayed_state((struct rte_keepalive_shm *)ptr_data,
521 id_core, core_state, last_alive);
525 main(int argc, char **argv)
527 struct lcore_queue_conf *qconf;
530 uint16_t nb_ports_available = 0;
531 uint16_t portid, last_port;
532 unsigned lcore_id, rx_lcore_id;
533 unsigned nb_ports_in_mask = 0;
534 unsigned int total_nb_mbufs;
535 struct sigaction signal_handler;
536 struct rte_keepalive_shm *ka_shm;
538 memset(&signal_handler, 0, sizeof(signal_handler));
539 terminate_signal_received = 0;
540 signal_handler.sa_handler = &handle_sigterm;
541 if (sigaction(SIGINT, &signal_handler, NULL) == -1 ||
542 sigaction(SIGTERM, &signal_handler, NULL) == -1)
543 rte_exit(EXIT_FAILURE, "SIGNAL\n");
547 ret = rte_eal_init(argc, argv);
549 rte_exit(EXIT_FAILURE, "Invalid EAL arguments\n");
553 l2fwd_enabled_port_mask = 0;
555 /* parse application arguments (after the EAL ones) */
556 ret = l2fwd_parse_args(argc, argv);
558 rte_exit(EXIT_FAILURE, "Invalid L2FWD arguments\n");
560 nb_ports = rte_eth_dev_count_avail();
562 rte_exit(EXIT_FAILURE, "No Ethernet ports - bye\n");
564 /* create the mbuf pool */
565 total_nb_mbufs = NB_MBUF_PER_PORT * nb_ports;
567 l2fwd_pktmbuf_pool = rte_pktmbuf_pool_create("mbuf_pool",
568 total_nb_mbufs, 32, 0, RTE_MBUF_DEFAULT_BUF_SIZE,
570 if (l2fwd_pktmbuf_pool == NULL)
571 rte_exit(EXIT_FAILURE, "Cannot init mbuf pool\n");
573 /* reset l2fwd_dst_ports */
574 for (portid = 0; portid < RTE_MAX_ETHPORTS; portid++)
575 l2fwd_dst_ports[portid] = 0;
579 * Each logical core is assigned a dedicated TX queue on each port.
581 RTE_ETH_FOREACH_DEV(portid) {
582 /* skip ports that are not enabled */
583 if ((l2fwd_enabled_port_mask & (1 << portid)) == 0)
586 if (nb_ports_in_mask % 2) {
587 l2fwd_dst_ports[portid] = last_port;
588 l2fwd_dst_ports[last_port] = portid;
594 if (nb_ports_in_mask % 2) {
595 printf("Notice: odd number of ports in portmask.\n");
596 l2fwd_dst_ports[last_port] = last_port;
602 /* Initialize the port/queue configuration of each logical core */
603 RTE_ETH_FOREACH_DEV(portid) {
604 /* skip ports that are not enabled */
605 if ((l2fwd_enabled_port_mask & (1 << portid)) == 0)
608 /* get the lcore_id for this port */
609 while (rte_lcore_is_enabled(rx_lcore_id) == 0 ||
610 lcore_queue_conf[rx_lcore_id].n_rx_port ==
611 l2fwd_rx_queue_per_lcore) {
613 if (rx_lcore_id >= RTE_MAX_LCORE)
614 rte_exit(EXIT_FAILURE, "Not enough cores\n");
617 if (qconf != &lcore_queue_conf[rx_lcore_id])
618 /* Assigned a new logical core in the loop above. */
619 qconf = &lcore_queue_conf[rx_lcore_id];
621 qconf->rx_port_list[qconf->n_rx_port] = portid;
623 printf("Lcore %u: RX port %u\n",
624 rx_lcore_id, portid);
627 /* Initialise each port */
628 RTE_ETH_FOREACH_DEV(portid) {
629 struct rte_eth_dev_info dev_info;
630 struct rte_eth_rxconf rxq_conf;
631 struct rte_eth_txconf txq_conf;
632 struct rte_eth_conf local_port_conf = port_conf;
634 /* skip ports that are not enabled */
635 if ((l2fwd_enabled_port_mask & (1 << portid)) == 0) {
636 printf("Skipping disabled port %u\n", portid);
639 nb_ports_available++;
642 printf("Initializing port %u... ", portid);
645 ret = rte_eth_dev_info_get(portid, &dev_info);
647 rte_exit(EXIT_FAILURE,
648 "Error during getting device (port %u) info: %s\n",
649 portid, strerror(-ret));
651 if (dev_info.tx_offload_capa & RTE_ETH_TX_OFFLOAD_MBUF_FAST_FREE)
652 local_port_conf.txmode.offloads |=
653 RTE_ETH_TX_OFFLOAD_MBUF_FAST_FREE;
654 ret = rte_eth_dev_configure(portid, 1, 1, &local_port_conf);
656 rte_exit(EXIT_FAILURE,
657 "Cannot configure device: err=%d, port=%u\n",
660 ret = rte_eth_dev_adjust_nb_rx_tx_desc(portid, &nb_rxd,
663 rte_exit(EXIT_FAILURE,
664 "Cannot adjust number of descriptors: err=%d, port=%u\n",
667 ret = rte_eth_macaddr_get(portid,
668 &l2fwd_ports_eth_addr[portid]);
670 rte_exit(EXIT_FAILURE,
671 "Cannot mac address: err=%d, port=%u\n",
674 /* init one RX queue */
676 rxq_conf = dev_info.default_rxconf;
677 rxq_conf.offloads = local_port_conf.rxmode.offloads;
678 ret = rte_eth_rx_queue_setup(portid, 0, nb_rxd,
679 rte_eth_dev_socket_id(portid),
683 rte_exit(EXIT_FAILURE,
684 "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,
696 "rte_eth_tx_queue_setup:err=%d, port=%u\n",
699 /* Initialize TX buffers */
700 tx_buffer[portid] = rte_zmalloc_socket("tx_buffer",
701 RTE_ETH_TX_BUFFER_SIZE(MAX_PKT_BURST), 0,
702 rte_eth_dev_socket_id(portid));
703 if (tx_buffer[portid] == NULL)
704 rte_exit(EXIT_FAILURE, "Cannot allocate buffer for tx on port %u\n",
707 rte_eth_tx_buffer_init(tx_buffer[portid], MAX_PKT_BURST);
709 ret = rte_eth_tx_buffer_set_err_callback(tx_buffer[portid],
710 rte_eth_tx_buffer_count_callback,
711 &port_statistics[portid].dropped);
713 rte_exit(EXIT_FAILURE,
714 "Cannot set error callback for tx buffer on port %u\n",
718 ret = rte_eth_dev_start(portid);
720 rte_exit(EXIT_FAILURE,
721 "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: "
731 RTE_ETHER_ADDR_PRT_FMT "\n\n",
733 RTE_ETHER_ADDR_BYTES(&l2fwd_ports_eth_addr[portid]));
735 /* initialize port stats */
736 memset(&port_statistics, 0, sizeof(port_statistics));
739 if (!nb_ports_available) {
740 rte_exit(EXIT_FAILURE,
741 "All available ports are disabled. Please set portmask.\n");
744 check_all_ports_link_status(l2fwd_enabled_port_mask);
746 struct rte_timer hb_timer, stats_timer;
748 rte_timer_subsystem_init();
749 rte_timer_init(&stats_timer);
752 if (check_period > 0) {
753 ka_shm = rte_keepalive_shm_create();
755 rte_exit(EXIT_FAILURE,
756 "rte_keepalive_shm_create() failed");
757 /* Initialize keepalive functionality. 8< */
758 rte_global_keepalive_info =
759 rte_keepalive_create(&dead_core, ka_shm);
760 if (rte_global_keepalive_info == NULL)
761 rte_exit(EXIT_FAILURE, "init_keep_alive() failed");
762 /* >8 End of initializing keepalive functionality. */
763 rte_keepalive_register_relay_callback(rte_global_keepalive_info,
764 relay_core_state, ka_shm);
765 rte_timer_init(&hb_timer);
766 if (rte_timer_reset(&hb_timer,
767 (check_period * rte_get_timer_hz()) / 1000,
770 (void(*)(struct rte_timer*, void*))
771 &rte_keepalive_dispatch_pings,
772 rte_global_keepalive_info
774 rte_exit(EXIT_FAILURE, "Keepalive setup failure.\n");
776 if (timer_period > 0) {
777 /* Issues the pings keepalive_dispatch_pings(). 8< */
778 if (rte_timer_reset(&stats_timer,
779 (timer_period * rte_get_timer_hz()) / 1000,
784 rte_exit(EXIT_FAILURE, "Stats setup failure.\n");
785 /* >8 End of issuing the pings keepalive_dispatch_pings(). */
787 /* launch per-lcore init on every worker lcore */
788 RTE_LCORE_FOREACH_WORKER(lcore_id) {
789 struct lcore_queue_conf *qconf = &lcore_queue_conf[lcore_id];
791 if (qconf->n_rx_port == 0)
793 "lcore %u has nothing to do\n",
797 rte_eal_remote_launch(
798 l2fwd_launch_one_lcore,
802 rte_keepalive_register_core(rte_global_keepalive_info,
806 while (!terminate_signal_received) {
811 RTE_LCORE_FOREACH_WORKER(lcore_id) {
812 if (rte_eal_wait_lcore(lcore_id) < 0)
817 rte_keepalive_shm_cleanup(ka_shm);
819 /* clean up the EAL */