4 * Copyright(c) 2010-2013 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/param.h>
42 #include <sys/queue.h>
47 #include <rte_common.h>
48 #include <rte_byteorder.h>
50 #include <rte_memory.h>
51 #include <rte_memcpy.h>
52 #include <rte_memzone.h>
53 #include <rte_tailq.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>
75 #include "rte_ipv4_frag.h"
78 #define RTE_LOGTYPE_L3FWD RTE_LOGTYPE_USER1
80 #define MBUF_SIZE (2048 + sizeof(struct rte_mbuf) + RTE_PKTMBUF_HEADROOM)
82 /* allow max jumbo frame 9.5 KB */
83 #define JUMBO_FRAME_MAX_SIZE 0x2600
85 #define ROUNDUP_DIV(a, b) (((a) + (b) - 1) / (b))
88 * Max number of fragments per packet expected.
90 #define MAX_PACKET_FRAG ROUNDUP_DIV(JUMBO_FRAME_MAX_SIZE, IPV4_DEFAULT_PAYLOAD)
95 * RX and TX Prefetch, Host, and Write-back threshold values should be
96 * carefully set for optimal performance. Consult the network
97 * controller's datasheet and supporting DPDK documentation for guidance
98 * on how these parameters should be set.
100 #define RX_PTHRESH 8 /**< Default values of RX prefetch threshold reg. */
101 #define RX_HTHRESH 8 /**< Default values of RX host threshold reg. */
102 #define RX_WTHRESH 4 /**< Default values of RX write-back threshold reg. */
105 * These default values are optimized for use with the Intel(R) 82599 10 GbE
106 * Controller and the DPDK ixgbe PMD. Consider using other values for other
107 * network controllers and/or network drivers.
109 #define TX_PTHRESH 36 /**< Default values of TX prefetch threshold reg. */
110 #define TX_HTHRESH 0 /**< Default values of TX host threshold reg. */
111 #define TX_WTHRESH 0 /**< Default values of TX write-back threshold reg. */
113 #define MAX_PKT_BURST 32
114 #define BURST_TX_DRAIN_US 100 /* TX drain every ~100us */
116 /* Configure how many packets ahead to prefetch, when reading packets */
117 #define PREFETCH_OFFSET 3
120 * Configurable number of RX/TX ring descriptors
122 #define RTE_TEST_RX_DESC_DEFAULT 128
123 #define RTE_TEST_TX_DESC_DEFAULT 512
124 static uint16_t nb_rxd = RTE_TEST_RX_DESC_DEFAULT;
125 static uint16_t nb_txd = RTE_TEST_TX_DESC_DEFAULT;
127 /* ethernet addresses of ports */
128 static struct ether_addr ports_eth_addr[RTE_MAX_ETHPORTS];
129 static struct ether_addr remote_eth_addr =
130 {{0xaa, 0xbb, 0xcc, 0xdd, 0xee, 0xff}};
132 /* mask of enabled ports */
133 static int enabled_port_mask = 0;
135 static int rx_queue_per_lcore = 1;
137 #define MBUF_TABLE_SIZE (2 * MAX(MAX_PKT_BURST, MAX_PACKET_FRAG))
141 struct rte_mbuf *m_table[MBUF_TABLE_SIZE];
144 #define MAX_RX_QUEUE_PER_LCORE 16
145 #define MAX_TX_QUEUE_PER_PORT 16
146 struct lcore_queue_conf {
148 uint8_t rx_queue_list[MAX_RX_QUEUE_PER_LCORE];
149 uint16_t tx_queue_id[RTE_MAX_ETHPORTS];
150 struct mbuf_table tx_mbufs[RTE_MAX_ETHPORTS];
152 } __rte_cache_aligned;
153 struct lcore_queue_conf lcore_queue_conf[RTE_MAX_LCORE];
155 static const struct rte_eth_conf port_conf = {
157 .max_rx_pkt_len = JUMBO_FRAME_MAX_SIZE,
159 .header_split = 0, /**< Header Split disabled */
160 .hw_ip_checksum = 0, /**< IP checksum offload disabled */
161 .hw_vlan_filter = 0, /**< VLAN filtering disabled */
162 .jumbo_frame = 1, /**< Jumbo Frame Support enabled */
163 .hw_strip_crc = 0, /**< CRC stripped by hardware */
166 .mq_mode = ETH_MQ_TX_NONE,
170 static const struct rte_eth_rxconf rx_conf = {
172 .pthresh = RX_PTHRESH,
173 .hthresh = RX_HTHRESH,
174 .wthresh = RX_WTHRESH,
178 static const struct rte_eth_txconf tx_conf = {
180 .pthresh = TX_PTHRESH,
181 .hthresh = TX_HTHRESH,
182 .wthresh = TX_WTHRESH,
184 .tx_free_thresh = 0, /* Use PMD default values */
185 .tx_rs_thresh = 0, /* Use PMD default values */
188 struct rte_mempool *pool_direct = NULL, *pool_indirect = NULL;
196 struct l3fwd_route l3fwd_route_array[] = {
197 {IPv4(100,10,0,0), 16, 2},
198 {IPv4(100,20,0,0), 16, 2},
199 {IPv4(100,30,0,0), 16, 0},
200 {IPv4(100,40,0,0), 16, 0},
203 #define L3FWD_NUM_ROUTES \
204 (sizeof(l3fwd_route_array) / sizeof(l3fwd_route_array[0]))
206 #define L3FWD_LPM_MAX_RULES 1024
208 struct rte_lpm *l3fwd_lpm = NULL;
210 /* Send burst of packets on an output interface */
212 send_burst(struct lcore_queue_conf *qconf, uint16_t n, uint8_t port)
214 struct rte_mbuf **m_table;
218 queueid = qconf->tx_queue_id[port];
219 m_table = (struct rte_mbuf **)qconf->tx_mbufs[port].m_table;
221 ret = rte_eth_tx_burst(port, queueid, m_table, n);
222 if (unlikely(ret < n)) {
224 rte_pktmbuf_free(m_table[ret]);
232 l3fwd_simple_forward(struct rte_mbuf *m, uint8_t port_in)
234 struct lcore_queue_conf *qconf;
235 struct ipv4_hdr *ip_hdr;
236 uint32_t i, len, lcore_id, ip_dst;
237 uint8_t next_hop, port_out;
240 lcore_id = rte_lcore_id();
241 qconf = &lcore_queue_conf[lcore_id];
243 /* Remove the Ethernet header and trailer from the input packet */
244 rte_pktmbuf_adj(m, (uint16_t)sizeof(struct ether_hdr));
246 /* Read the lookup key (i.e. ip_dst) from the input packet */
247 ip_hdr = rte_pktmbuf_mtod(m, struct ipv4_hdr *);
248 ip_dst = rte_be_to_cpu_32(ip_hdr->dst_addr);
250 /* Find destination port */
251 if (rte_lpm_lookup(l3fwd_lpm, ip_dst, &next_hop) == 0 &&
252 (enabled_port_mask & 1 << next_hop) != 0)
257 /* Build transmission burst */
258 len = qconf->tx_mbufs[port_out].len;
260 /* if we don't need to do any fragmentation */
261 if (likely (IPV4_MTU_DEFAULT >= m->pkt.pkt_len)) {
262 qconf->tx_mbufs[port_out].m_table[len] = m;
265 len2 = rte_ipv4_fragmentation(m,
266 &qconf->tx_mbufs[port_out].m_table[len],
267 (uint16_t)(MBUF_TABLE_SIZE - len),
269 pool_direct, pool_indirect);
271 /* Free input packet */
274 /* If we fail to fragment the packet */
275 if (unlikely (len2 < 0))
279 for (i = len; i < len + len2; i ++) {
280 m = qconf->tx_mbufs[port_out].m_table[i];
281 struct ether_hdr *eth_hdr = (struct ether_hdr *)
282 rte_pktmbuf_prepend(m, (uint16_t)sizeof(struct ether_hdr));
283 if (eth_hdr == NULL) {
284 rte_panic("No headroom in mbuf.\n");
287 m->pkt.vlan_macip.f.l2_len = sizeof(struct ether_hdr);
289 ether_addr_copy(&remote_eth_addr, ð_hdr->d_addr);
290 ether_addr_copy(&ports_eth_addr[port_out], ð_hdr->s_addr);
291 eth_hdr->ether_type = rte_be_to_cpu_16(ETHER_TYPE_IPv4);
296 if (likely(len < MAX_PKT_BURST)) {
297 qconf->tx_mbufs[port_out].len = (uint16_t)len;
301 /* Transmit packets */
302 send_burst(qconf, (uint16_t)len, port_out);
303 qconf->tx_mbufs[port_out].len = 0;
306 /* main processing loop */
308 main_loop(__attribute__((unused)) void *dummy)
310 struct rte_mbuf *pkts_burst[MAX_PKT_BURST];
312 uint64_t prev_tsc, diff_tsc, cur_tsc;
315 struct lcore_queue_conf *qconf;
316 const uint64_t drain_tsc = (rte_get_tsc_hz() + US_PER_S - 1) / US_PER_S * BURST_TX_DRAIN_US;
320 lcore_id = rte_lcore_id();
321 qconf = &lcore_queue_conf[lcore_id];
323 if (qconf->n_rx_queue == 0) {
324 RTE_LOG(INFO, L3FWD, "lcore %u has nothing to do\n", lcore_id);
328 RTE_LOG(INFO, L3FWD, "entering main loop on lcore %u\n", lcore_id);
330 for (i = 0; i < qconf->n_rx_queue; i++) {
332 portid = qconf->rx_queue_list[i];
333 RTE_LOG(INFO, L3FWD, " -- lcoreid=%u portid=%d\n", lcore_id,
339 cur_tsc = rte_rdtsc();
342 * TX burst queue drain
344 diff_tsc = cur_tsc - prev_tsc;
345 if (unlikely(diff_tsc > drain_tsc)) {
348 * This could be optimized (use queueid instead of
349 * portid), but it is not called so often
351 for (portid = 0; portid < RTE_MAX_ETHPORTS; portid++) {
352 if (qconf->tx_mbufs[portid].len == 0)
354 send_burst(&lcore_queue_conf[lcore_id],
355 qconf->tx_mbufs[portid].len,
357 qconf->tx_mbufs[portid].len = 0;
364 * Read packet from RX queues
366 for (i = 0; i < qconf->n_rx_queue; i++) {
368 portid = qconf->rx_queue_list[i];
369 nb_rx = rte_eth_rx_burst(portid, 0, pkts_burst,
372 /* Prefetch first packets */
373 for (j = 0; j < PREFETCH_OFFSET && j < nb_rx; j++) {
374 rte_prefetch0(rte_pktmbuf_mtod(
375 pkts_burst[j], void *));
378 /* Prefetch and forward already prefetched packets */
379 for (j = 0; j < (nb_rx - PREFETCH_OFFSET); j++) {
380 rte_prefetch0(rte_pktmbuf_mtod(pkts_burst[
381 j + PREFETCH_OFFSET], void *));
382 l3fwd_simple_forward(pkts_burst[j], portid);
385 /* Forward remaining prefetched packets */
386 for (; j < nb_rx; j++) {
387 l3fwd_simple_forward(pkts_burst[j], portid);
395 print_usage(const char *prgname)
397 printf("%s [EAL options] -- -p PORTMASK [-q NQ]\n"
398 " -p PORTMASK: hexadecimal bitmask of ports to configure\n"
399 " -q NQ: number of queue (=ports) per lcore (default is 1)\n",
404 parse_portmask(const char *portmask)
409 /* parse hexadecimal string */
410 pm = strtoul(portmask, &end, 16);
411 if ((portmask[0] == '\0') || (end == NULL) || (*end != '\0'))
421 parse_nqueue(const char *q_arg)
426 /* parse hexadecimal string */
427 n = strtoul(q_arg, &end, 10);
428 if ((q_arg[0] == '\0') || (end == NULL) || (*end != '\0'))
432 if (n >= MAX_RX_QUEUE_PER_LCORE)
438 /* Parse the argument given in the command line of the application */
440 parse_args(int argc, char **argv)
445 char *prgname = argv[0];
446 static struct option lgopts[] = {
452 while ((opt = getopt_long(argc, argvopt, "p:q:",
453 lgopts, &option_index)) != EOF) {
458 enabled_port_mask = parse_portmask(optarg);
459 if (enabled_port_mask < 0) {
460 printf("invalid portmask\n");
461 print_usage(prgname);
468 rx_queue_per_lcore = parse_nqueue(optarg);
469 if (rx_queue_per_lcore < 0) {
470 printf("invalid queue number\n");
471 print_usage(prgname);
478 print_usage(prgname);
482 print_usage(prgname);
487 if (enabled_port_mask == 0) {
488 printf("portmask not specified\n");
489 print_usage(prgname);
494 argv[optind-1] = prgname;
497 optind = 0; /* reset getopt lib */
502 print_ethaddr(const char *name, struct ether_addr *eth_addr)
504 printf("%s%02X:%02X:%02X:%02X:%02X:%02X", name,
505 eth_addr->addr_bytes[0],
506 eth_addr->addr_bytes[1],
507 eth_addr->addr_bytes[2],
508 eth_addr->addr_bytes[3],
509 eth_addr->addr_bytes[4],
510 eth_addr->addr_bytes[5]);
513 /* Check the link status of all ports in up to 9s, and print them finally */
515 check_all_ports_link_status(uint8_t port_num, uint32_t port_mask)
517 #define CHECK_INTERVAL 100 /* 100ms */
518 #define MAX_CHECK_TIME 90 /* 9s (90 * 100ms) in total */
519 uint8_t portid, count, all_ports_up, print_flag = 0;
520 struct rte_eth_link link;
522 printf("\nChecking link status");
524 for (count = 0; count <= MAX_CHECK_TIME; count++) {
526 for (portid = 0; portid < port_num; portid++) {
527 if ((port_mask & (1 << portid)) == 0)
529 memset(&link, 0, sizeof(link));
530 rte_eth_link_get_nowait(portid, &link);
531 /* print link status if flag set */
532 if (print_flag == 1) {
533 if (link.link_status)
534 printf("Port %d Link Up - speed %u "
535 "Mbps - %s\n", (uint8_t)portid,
536 (unsigned)link.link_speed,
537 (link.link_duplex == ETH_LINK_FULL_DUPLEX) ?
538 ("full-duplex") : ("half-duplex\n"));
540 printf("Port %d Link Down\n",
544 /* clear all_ports_up flag if any link down */
545 if (link.link_status == 0) {
550 /* after finally printing all link status, get out */
554 if (all_ports_up == 0) {
557 rte_delay_ms(CHECK_INTERVAL);
560 /* set the print_flag if all ports up or timeout */
561 if (all_ports_up == 1 || count == (MAX_CHECK_TIME - 1)) {
569 MAIN(int argc, char **argv)
571 struct lcore_queue_conf *qconf;
573 unsigned nb_ports, i;
574 uint16_t queueid = 0;
575 unsigned lcore_id = 0, rx_lcore_id = 0;;
576 uint32_t n_tx_queue, nb_lcores;
580 ret = rte_eal_init(argc, argv);
582 rte_exit(EXIT_FAILURE, "rte_eal_init failed");
586 /* parse application arguments (after the EAL ones) */
587 ret = parse_args(argc, argv);
589 rte_exit(EXIT_FAILURE, "Invalid arguments");
591 /* create the mbuf pools */
593 rte_mempool_create("pool_direct", NB_MBUF,
595 sizeof(struct rte_pktmbuf_pool_private),
596 rte_pktmbuf_pool_init, NULL,
597 rte_pktmbuf_init, NULL,
599 if (pool_direct == NULL)
600 rte_panic("Cannot init direct mbuf pool\n");
603 rte_mempool_create("pool_indirect", NB_MBUF,
604 sizeof(struct rte_mbuf), 32,
607 rte_pktmbuf_init, NULL,
609 if (pool_indirect == NULL)
610 rte_panic("Cannot init indirect mbuf pool\n");
613 if (rte_pmd_init_all() < 0)
614 rte_panic("Cannot init PMD\n");
616 if (rte_eal_pci_probe() < 0)
617 rte_panic("Cannot probe PCI\n");
619 nb_ports = rte_eth_dev_count();
620 if (nb_ports > RTE_MAX_ETHPORTS)
621 nb_ports = RTE_MAX_ETHPORTS;
623 nb_lcores = rte_lcore_count();
625 /* initialize all ports */
626 for (portid = 0; portid < nb_ports; portid++) {
627 /* skip ports that are not enabled */
628 if ((enabled_port_mask & (1 << portid)) == 0) {
629 printf("Skipping disabled port %d\n", portid);
633 qconf = &lcore_queue_conf[rx_lcore_id];
635 /* get the lcore_id for this port */
636 while (rte_lcore_is_enabled(rx_lcore_id) == 0 ||
637 qconf->n_rx_queue == (unsigned)rx_queue_per_lcore) {
640 if (rx_lcore_id >= RTE_MAX_LCORE)
641 rte_exit(EXIT_FAILURE, "Not enough cores\n");
643 qconf = &lcore_queue_conf[rx_lcore_id];
645 qconf->rx_queue_list[qconf->n_rx_queue] = portid;
649 printf("Initializing port %d on lcore %u... ", portid,
653 n_tx_queue = nb_lcores;
654 if (n_tx_queue > MAX_TX_QUEUE_PER_PORT)
655 n_tx_queue = MAX_TX_QUEUE_PER_PORT;
656 ret = rte_eth_dev_configure(portid, 1, (uint16_t)n_tx_queue,
659 rte_exit(EXIT_FAILURE, "Cannot configure device: "
663 rte_eth_macaddr_get(portid, &ports_eth_addr[portid]);
664 print_ethaddr(" Address:", &ports_eth_addr[portid]);
667 /* init one RX queue */
669 printf("rxq=%d ", queueid);
671 ret = rte_eth_rx_queue_setup(portid, queueid, nb_rxd,
672 rte_eth_dev_socket_id(portid), &rx_conf,
675 rte_exit(EXIT_FAILURE, "rte_eth_tx_queue_setup: "
679 /* init one TX queue per couple (lcore,port) */
681 for (lcore_id = 0; lcore_id < RTE_MAX_LCORE; lcore_id++) {
682 if (rte_lcore_is_enabled(lcore_id) == 0)
684 printf("txq=%u,%d ", lcore_id, queueid);
686 ret = rte_eth_tx_queue_setup(portid, queueid, nb_txd,
687 rte_eth_dev_socket_id(portid), &tx_conf);
689 rte_exit(EXIT_FAILURE, "rte_eth_tx_queue_setup: "
690 "err=%d, port=%d\n", ret, portid);
692 qconf = &lcore_queue_conf[lcore_id];
693 qconf->tx_queue_id[portid] = queueid;
698 ret = rte_eth_dev_start(portid);
700 rte_exit(EXIT_FAILURE, "rte_eth_dev_start: "
706 /* Set port in promiscuous mode */
707 rte_eth_promiscuous_enable(portid);
710 check_all_ports_link_status((uint8_t)nb_ports, enabled_port_mask);
712 /* create the LPM table */
713 l3fwd_lpm = rte_lpm_create("L3FWD_LPM", rte_socket_id(), L3FWD_LPM_MAX_RULES, 0);
714 if (l3fwd_lpm == NULL)
715 rte_panic("Unable to create the l3fwd LPM table\n");
717 /* populate the LPM table */
718 for (i = 0; i < L3FWD_NUM_ROUTES; i++) {
719 ret = rte_lpm_add(l3fwd_lpm,
720 l3fwd_route_array[i].ip,
721 l3fwd_route_array[i].depth,
722 l3fwd_route_array[i].if_out);
725 rte_panic("Unable to add entry %u to the l3fwd "
729 printf("Adding route 0x%08x / %d (%d)\n",
730 (unsigned) l3fwd_route_array[i].ip,
731 l3fwd_route_array[i].depth,
732 l3fwd_route_array[i].if_out);
735 /* launch per-lcore init on every lcore */
736 rte_eal_mp_remote_launch(main_loop, NULL, CALL_MASTER);
737 RTE_LCORE_FOREACH_SLAVE(lcore_id) {
738 if (rte_eal_wait_lcore(lcore_id) < 0)