4 * Copyright(c) 2010-2016 Intel Corporation. All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
11 * * Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * * Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in
15 * the documentation and/or other materials provided with the
17 * * Neither the name of Intel Corporation nor the names of its
18 * contributors may be used to endorse or promote products derived
19 * from this software without specific prior written permission.
21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
39 #include <sys/types.h>
40 #include <sys/queue.h>
41 #include <netinet/in.h>
48 #include <rte_common.h>
50 #include <rte_malloc.h>
51 #include <rte_memory.h>
52 #include <rte_memcpy.h>
53 #include <rte_memzone.h>
55 #include <rte_per_lcore.h>
56 #include <rte_launch.h>
57 #include <rte_atomic.h>
58 #include <rte_cycles.h>
59 #include <rte_prefetch.h>
60 #include <rte_lcore.h>
61 #include <rte_per_lcore.h>
62 #include <rte_branch_prediction.h>
63 #include <rte_interrupts.h>
65 #include <rte_random.h>
66 #include <rte_debug.h>
67 #include <rte_ether.h>
68 #include <rte_ethdev.h>
70 #include <rte_mempool.h>
72 #include <rte_timer.h>
73 #include <rte_keepalive.h>
77 #define RTE_LOGTYPE_L2FWD RTE_LOGTYPE_USER1
81 #define MAX_PKT_BURST 32
82 #define BURST_TX_DRAIN_US 100 /* TX drain every ~100us */
85 * Configurable number of RX/TX ring descriptors
87 #define RTE_TEST_RX_DESC_DEFAULT 128
88 #define RTE_TEST_TX_DESC_DEFAULT 512
89 static uint16_t nb_rxd = RTE_TEST_RX_DESC_DEFAULT;
90 static uint16_t nb_txd = RTE_TEST_TX_DESC_DEFAULT;
92 /* ethernet addresses of ports */
93 static struct ether_addr l2fwd_ports_eth_addr[RTE_MAX_ETHPORTS];
95 /* mask of enabled ports */
96 static uint32_t l2fwd_enabled_port_mask;
98 /* list of enabled ports */
99 static uint32_t l2fwd_dst_ports[RTE_MAX_ETHPORTS];
101 static unsigned int l2fwd_rx_queue_per_lcore = 1;
103 #define MAX_RX_QUEUE_PER_LCORE 16
104 #define MAX_TX_QUEUE_PER_PORT 16
105 struct lcore_queue_conf {
107 unsigned rx_port_list[MAX_RX_QUEUE_PER_LCORE];
108 } __rte_cache_aligned;
109 struct lcore_queue_conf lcore_queue_conf[RTE_MAX_LCORE];
111 struct rte_eth_dev_tx_buffer *tx_buffer[RTE_MAX_ETHPORTS];
113 static const struct rte_eth_conf port_conf = {
116 .header_split = 0, /**< Header Split disabled */
117 .hw_ip_checksum = 0, /**< IP checksum offload disabled */
118 .hw_vlan_filter = 0, /**< VLAN filtering disabled */
119 .jumbo_frame = 0, /**< Jumbo Frame Support disabled */
120 .hw_strip_crc = 0, /**< CRC stripped by hardware */
123 .mq_mode = ETH_MQ_TX_NONE,
127 struct rte_mempool *l2fwd_pktmbuf_pool = NULL;
129 /* Per-port statistics struct */
130 struct l2fwd_port_statistics {
134 } __rte_cache_aligned;
135 struct l2fwd_port_statistics port_statistics[RTE_MAX_ETHPORTS];
137 /* A tsc-based timer responsible for triggering statistics printout */
138 #define TIMER_MILLISECOND 1
139 #define MAX_TIMER_PERIOD 86400 /* 1 day max */
140 static int64_t timer_period = 10 * TIMER_MILLISECOND * 1000; /* 10 seconds */
141 static int64_t check_period = 5; /* default check cycle is 5ms */
143 /* Keepalive structure */
144 struct rte_keepalive *rte_global_keepalive_info;
146 /* Print out statistics on packets dropped */
148 print_stats(__attribute__((unused)) struct rte_timer *ptr_timer,
149 __attribute__((unused)) void *ptr_data)
151 uint64_t total_packets_dropped, total_packets_tx, total_packets_rx;
154 total_packets_dropped = 0;
155 total_packets_tx = 0;
156 total_packets_rx = 0;
158 const char clr[] = { 27, '[', '2', 'J', '\0' };
159 const char topLeft[] = { 27, '[', '1', ';', '1', 'H', '\0' };
161 /* Clear screen and move to top left */
162 printf("%s%s", clr, topLeft);
164 printf("\nPort statistics ====================================");
166 for (portid = 0; portid < RTE_MAX_ETHPORTS; portid++) {
167 /* skip disabled ports */
168 if ((l2fwd_enabled_port_mask & (1 << portid)) == 0)
170 printf("\nStatistics for port %u ------------------------------"
171 "\nPackets sent: %24"PRIu64
172 "\nPackets received: %20"PRIu64
173 "\nPackets dropped: %21"PRIu64,
175 port_statistics[portid].tx,
176 port_statistics[portid].rx,
177 port_statistics[portid].dropped);
179 total_packets_dropped += port_statistics[portid].dropped;
180 total_packets_tx += port_statistics[portid].tx;
181 total_packets_rx += port_statistics[portid].rx;
183 printf("\nAggregate statistics ==============================="
184 "\nTotal packets sent: %18"PRIu64
185 "\nTotal packets received: %14"PRIu64
186 "\nTotal packets dropped: %15"PRIu64,
189 total_packets_dropped);
190 printf("\n====================================================\n");
194 l2fwd_simple_forward(struct rte_mbuf *m, unsigned portid)
196 struct ether_hdr *eth;
200 struct rte_eth_dev_tx_buffer *buffer;
202 dst_port = l2fwd_dst_ports[portid];
203 eth = rte_pktmbuf_mtod(m, struct ether_hdr *);
205 /* 02:00:00:00:00:xx */
206 tmp = ð->d_addr.addr_bytes[0];
207 *((uint64_t *)tmp) = 0x000000000002 + ((uint64_t)dst_port << 40);
210 ether_addr_copy(&l2fwd_ports_eth_addr[dst_port], ð->s_addr);
212 buffer = tx_buffer[dst_port];
213 sent = rte_eth_tx_buffer(dst_port, 0, buffer, m);
215 port_statistics[dst_port].tx += sent;
218 /* main processing loop */
220 l2fwd_main_loop(void)
222 struct rte_mbuf *pkts_burst[MAX_PKT_BURST];
226 uint64_t prev_tsc, diff_tsc, cur_tsc;
227 unsigned i, j, portid, nb_rx;
228 struct lcore_queue_conf *qconf;
229 const uint64_t drain_tsc = (rte_get_tsc_hz() + US_PER_S - 1)
230 / US_PER_S * BURST_TX_DRAIN_US;
231 struct rte_eth_dev_tx_buffer *buffer;
235 lcore_id = rte_lcore_id();
236 qconf = &lcore_queue_conf[lcore_id];
238 if (qconf->n_rx_port == 0) {
239 RTE_LOG(INFO, L2FWD, "lcore %u has nothing to do\n", lcore_id);
243 RTE_LOG(INFO, L2FWD, "entering main loop on lcore %u\n", lcore_id);
245 for (i = 0; i < qconf->n_rx_port; i++) {
247 portid = qconf->rx_port_list[i];
248 RTE_LOG(INFO, L2FWD, " -- lcoreid=%u portid=%u\n", lcore_id,
252 uint64_t tsc_initial = rte_rdtsc();
253 uint64_t tsc_lifetime = (rand()&0x07) * rte_get_tsc_hz();
256 /* Keepalive heartbeat */
257 rte_keepalive_mark_alive(rte_global_keepalive_info);
259 cur_tsc = rte_rdtsc();
262 * Die randomly within 7 secs for demo purposes if
265 if (check_period > 0 && cur_tsc - tsc_initial > tsc_lifetime)
269 * TX burst queue drain
271 diff_tsc = cur_tsc - prev_tsc;
272 if (unlikely(diff_tsc > drain_tsc)) {
274 for (i = 0; i < qconf->n_rx_port; i++) {
276 portid = l2fwd_dst_ports[qconf->rx_port_list[i]];
277 buffer = tx_buffer[portid];
279 sent = rte_eth_tx_buffer_flush(portid, 0, buffer);
281 port_statistics[portid].tx += sent;
289 * Read packet from RX queues
291 for (i = 0; i < qconf->n_rx_port; i++) {
293 portid = qconf->rx_port_list[i];
294 nb_rx = rte_eth_rx_burst((uint8_t) portid, 0,
295 pkts_burst, MAX_PKT_BURST);
297 port_statistics[portid].rx += nb_rx;
299 for (j = 0; j < nb_rx; j++) {
301 rte_prefetch0(rte_pktmbuf_mtod(m, void *));
302 l2fwd_simple_forward(m, portid);
309 l2fwd_launch_one_lcore(__attribute__((unused)) void *dummy)
317 l2fwd_usage(const char *prgname)
319 printf("%s [EAL options] -- -p PORTMASK [-q NQ]\n"
320 " -p PORTMASK: hexadecimal bitmask of ports to configure\n"
321 " -q NQ: number of queue (=ports) per lcore (default is 1)\n"
322 " -K PERIOD: Keepalive check period (5 default; 86400 max)\n"
323 " -T PERIOD: statistics will be refreshed each PERIOD seconds (0 to disable, 10 default, 86400 maximum)\n",
328 l2fwd_parse_portmask(const char *portmask)
333 /* parse hexadecimal string */
334 pm = strtoul(portmask, &end, 16);
335 if ((portmask[0] == '\0') || (end == NULL) || (*end != '\0'))
345 l2fwd_parse_nqueue(const char *q_arg)
350 /* parse hexadecimal string */
351 n = strtoul(q_arg, &end, 10);
352 if ((q_arg[0] == '\0') || (end == NULL) || (*end != '\0'))
356 if (n >= MAX_RX_QUEUE_PER_LCORE)
363 l2fwd_parse_timer_period(const char *q_arg)
368 /* parse number string */
369 n = strtol(q_arg, &end, 10);
370 if ((q_arg[0] == '\0') || (end == NULL) || (*end != '\0'))
372 if (n >= MAX_TIMER_PERIOD)
379 l2fwd_parse_check_period(const char *q_arg)
384 /* parse number string */
385 n = strtol(q_arg, &end, 10);
386 if ((q_arg[0] == '\0') || (end == NULL) || (*end != '\0'))
388 if (n >= MAX_TIMER_PERIOD)
394 /* Parse the argument given in the command line of the application */
396 l2fwd_parse_args(int argc, char **argv)
401 char *prgname = argv[0];
402 static struct option lgopts[] = {
408 while ((opt = getopt_long(argc, argvopt, "p:q:T:K:",
409 lgopts, &option_index)) != EOF) {
414 l2fwd_enabled_port_mask = l2fwd_parse_portmask(optarg);
415 if (l2fwd_enabled_port_mask == 0) {
416 printf("invalid portmask\n");
417 l2fwd_usage(prgname);
424 l2fwd_rx_queue_per_lcore = l2fwd_parse_nqueue(optarg);
425 if (l2fwd_rx_queue_per_lcore == 0) {
426 printf("invalid queue number\n");
427 l2fwd_usage(prgname);
434 timer_period = l2fwd_parse_timer_period(optarg)
435 * (int64_t)(1000 * TIMER_MILLISECOND);
436 if (timer_period < 0) {
437 printf("invalid timer period\n");
438 l2fwd_usage(prgname);
445 check_period = l2fwd_parse_check_period(optarg);
446 if (check_period < 0) {
447 printf("invalid check period\n");
448 l2fwd_usage(prgname);
455 l2fwd_usage(prgname);
459 l2fwd_usage(prgname);
465 argv[optind-1] = prgname;
468 optind = 0; /* reset getopt lib */
472 /* Check the link status of all ports in up to 9s, and print them finally */
474 check_all_ports_link_status(uint8_t port_num, uint32_t port_mask)
476 #define CHECK_INTERVAL 100 /* 100ms */
477 #define MAX_CHECK_TIME 90 /* 9s (90 * 100ms) in total */
478 uint8_t portid, count, all_ports_up, print_flag = 0;
479 struct rte_eth_link link;
481 printf("\nChecking link status");
483 for (count = 0; count <= MAX_CHECK_TIME; count++) {
485 for (portid = 0; portid < port_num; portid++) {
486 if ((port_mask & (1 << portid)) == 0)
488 memset(&link, 0, sizeof(link));
489 rte_eth_link_get_nowait(portid, &link);
490 /* print link status if flag set */
491 if (print_flag == 1) {
492 if (link.link_status)
493 printf("Port %d Link Up - speed %u "
494 "Mbps - %s\n", (uint8_t)portid,
495 (unsigned)link.link_speed,
496 (link.link_duplex == ETH_LINK_FULL_DUPLEX) ?
497 ("full-duplex") : ("half-duplex\n"));
499 printf("Port %d Link Down\n",
503 /* clear all_ports_up flag if any link down */
504 if (link.link_status == ETH_LINK_DOWN) {
509 /* after finally printing all link status, get out */
513 if (all_ports_up == 0) {
516 rte_delay_ms(CHECK_INTERVAL);
519 /* set the print_flag if all ports up or timeout */
520 if (all_ports_up == 1 || count == (MAX_CHECK_TIME - 1)) {
528 dead_core(__rte_unused void *ptr_data, const int id_core)
530 printf("Dead core %i - restarting..\n", id_core);
531 if (rte_eal_get_lcore_state(id_core) == FINISHED) {
532 rte_eal_wait_lcore(id_core);
533 rte_eal_remote_launch(l2fwd_launch_one_lcore, NULL, id_core);
535 printf("..false positive!\n");
540 relay_core_state(void *ptr_data, const int id_core,
541 const enum rte_keepalive_state core_state, uint64_t last_alive)
543 rte_keepalive_relayed_state((struct rte_keepalive_shm *)ptr_data,
544 id_core, core_state, last_alive);
548 main(int argc, char **argv)
550 struct lcore_queue_conf *qconf;
551 struct rte_eth_dev_info dev_info;
554 uint8_t nb_ports_available;
555 uint8_t portid, last_port;
556 unsigned lcore_id, rx_lcore_id;
557 unsigned nb_ports_in_mask = 0;
560 ret = rte_eal_init(argc, argv);
562 rte_exit(EXIT_FAILURE, "Invalid EAL arguments\n");
566 l2fwd_enabled_port_mask = 0;
568 /* parse application arguments (after the EAL ones) */
569 ret = l2fwd_parse_args(argc, argv);
571 rte_exit(EXIT_FAILURE, "Invalid L2FWD arguments\n");
573 /* create the mbuf pool */
574 l2fwd_pktmbuf_pool = rte_pktmbuf_pool_create("mbuf_pool", NB_MBUF, 32,
575 0, RTE_MBUF_DEFAULT_BUF_SIZE, rte_socket_id());
576 if (l2fwd_pktmbuf_pool == NULL)
577 rte_exit(EXIT_FAILURE, "Cannot init mbuf pool\n");
579 nb_ports = rte_eth_dev_count();
581 rte_exit(EXIT_FAILURE, "No Ethernet ports - bye\n");
583 /* reset l2fwd_dst_ports */
584 for (portid = 0; portid < RTE_MAX_ETHPORTS; portid++)
585 l2fwd_dst_ports[portid] = 0;
589 * Each logical core is assigned a dedicated TX queue on each port.
591 for (portid = 0; portid < nb_ports; portid++) {
592 /* skip ports that are not enabled */
593 if ((l2fwd_enabled_port_mask & (1 << portid)) == 0)
596 if (nb_ports_in_mask % 2) {
597 l2fwd_dst_ports[portid] = last_port;
598 l2fwd_dst_ports[last_port] = portid;
604 rte_eth_dev_info_get(portid, &dev_info);
606 if (nb_ports_in_mask % 2) {
607 printf("Notice: odd number of ports in portmask.\n");
608 l2fwd_dst_ports[last_port] = last_port;
614 /* Initialize the port/queue configuration of each logical core */
615 for (portid = 0; portid < nb_ports; portid++) {
616 /* skip ports that are not enabled */
617 if ((l2fwd_enabled_port_mask & (1 << portid)) == 0)
620 /* get the lcore_id for this port */
621 while (rte_lcore_is_enabled(rx_lcore_id) == 0 ||
622 lcore_queue_conf[rx_lcore_id].n_rx_port ==
623 l2fwd_rx_queue_per_lcore) {
625 if (rx_lcore_id >= RTE_MAX_LCORE)
626 rte_exit(EXIT_FAILURE, "Not enough cores\n");
629 if (qconf != &lcore_queue_conf[rx_lcore_id])
630 /* Assigned a new logical core in the loop above. */
631 qconf = &lcore_queue_conf[rx_lcore_id];
633 qconf->rx_port_list[qconf->n_rx_port] = portid;
635 printf("Lcore %u: RX port %u\n",
636 rx_lcore_id, (unsigned) portid);
639 nb_ports_available = nb_ports;
641 /* Initialise each port */
642 for (portid = 0; portid < nb_ports; portid++) {
643 /* skip ports that are not enabled */
644 if ((l2fwd_enabled_port_mask & (1 << portid)) == 0) {
645 printf("Skipping disabled port %u\n",
647 nb_ports_available--;
651 printf("Initializing port %u... ", (unsigned) portid);
653 ret = rte_eth_dev_configure(portid, 1, 1, &port_conf);
655 rte_exit(EXIT_FAILURE,
656 "Cannot configure device: err=%d, port=%u\n",
657 ret, (unsigned) portid);
659 rte_eth_macaddr_get(portid, &l2fwd_ports_eth_addr[portid]);
661 /* init one RX queue */
663 ret = rte_eth_rx_queue_setup(portid, 0, nb_rxd,
664 rte_eth_dev_socket_id(portid),
668 rte_exit(EXIT_FAILURE,
669 "rte_eth_rx_queue_setup:err=%d, port=%u\n",
670 ret, (unsigned) portid);
672 /* init one TX queue on each port */
674 ret = rte_eth_tx_queue_setup(portid, 0, nb_txd,
675 rte_eth_dev_socket_id(portid),
678 rte_exit(EXIT_FAILURE,
679 "rte_eth_tx_queue_setup:err=%d, port=%u\n",
680 ret, (unsigned) portid);
682 /* Initialize TX buffers */
683 tx_buffer[portid] = rte_zmalloc_socket("tx_buffer",
684 RTE_ETH_TX_BUFFER_SIZE(MAX_PKT_BURST), 0,
685 rte_eth_dev_socket_id(portid));
686 if (tx_buffer[portid] == NULL)
687 rte_exit(EXIT_FAILURE, "Cannot allocate buffer for tx on port %u\n",
690 rte_eth_tx_buffer_init(tx_buffer[portid], MAX_PKT_BURST);
692 ret = rte_eth_tx_buffer_set_err_callback(tx_buffer[portid],
693 rte_eth_tx_buffer_count_callback,
694 &port_statistics[portid].dropped);
696 rte_exit(EXIT_FAILURE, "Cannot set error callback for "
697 "tx buffer on port %u\n", (unsigned) portid);
700 ret = rte_eth_dev_start(portid);
702 rte_exit(EXIT_FAILURE,
703 "rte_eth_dev_start:err=%d, port=%u\n",
704 ret, (unsigned) portid);
706 rte_eth_promiscuous_enable(portid);
708 printf("Port %u, MAC address: "
709 "%02X:%02X:%02X:%02X:%02X:%02X\n\n",
711 l2fwd_ports_eth_addr[portid].addr_bytes[0],
712 l2fwd_ports_eth_addr[portid].addr_bytes[1],
713 l2fwd_ports_eth_addr[portid].addr_bytes[2],
714 l2fwd_ports_eth_addr[portid].addr_bytes[3],
715 l2fwd_ports_eth_addr[portid].addr_bytes[4],
716 l2fwd_ports_eth_addr[portid].addr_bytes[5]);
718 /* initialize port stats */
719 memset(&port_statistics, 0, sizeof(port_statistics));
722 if (!nb_ports_available) {
723 rte_exit(EXIT_FAILURE,
724 "All available ports are disabled. Please set portmask.\n");
727 check_all_ports_link_status(nb_ports, l2fwd_enabled_port_mask);
729 struct rte_timer hb_timer, stats_timer;
731 rte_timer_subsystem_init();
732 rte_timer_init(&stats_timer);
734 if (check_period > 0) {
735 struct rte_keepalive_shm *ka_shm;
737 ka_shm = rte_keepalive_shm_create();
739 rte_exit(EXIT_FAILURE,
740 "rte_keepalive_shm_create() failed");
741 rte_global_keepalive_info =
742 rte_keepalive_create(&dead_core, ka_shm);
743 if (rte_global_keepalive_info == NULL)
744 rte_exit(EXIT_FAILURE, "init_keep_alive() failed");
745 rte_keepalive_register_relay_callback(rte_global_keepalive_info,
746 relay_core_state, ka_shm);
747 rte_timer_init(&hb_timer);
748 if (rte_timer_reset(&hb_timer,
749 (check_period * rte_get_timer_hz()) / 1000,
752 (void(*)(struct rte_timer*, void*))
753 &rte_keepalive_dispatch_pings,
754 rte_global_keepalive_info
756 rte_exit(EXIT_FAILURE, "Keepalive setup failure.\n");
758 if (timer_period > 0) {
759 if (rte_timer_reset(&stats_timer,
760 (timer_period * rte_get_timer_hz()) / 1000,
765 rte_exit(EXIT_FAILURE, "Stats setup failure.\n");
767 /* launch per-lcore init on every slave lcore */
768 RTE_LCORE_FOREACH_SLAVE(lcore_id) {
769 struct lcore_queue_conf *qconf = &lcore_queue_conf[lcore_id];
771 if (qconf->n_rx_port == 0)
773 "lcore %u has nothing to do\n",
777 rte_eal_remote_launch(
778 l2fwd_launch_one_lcore,
782 rte_keepalive_register_core(rte_global_keepalive_info,
791 RTE_LCORE_FOREACH_SLAVE(lcore_id) {
792 if (rte_eal_wait_lcore(lcore_id) < 0)