xref: /dpdk/examples/skeleton/basicfwd.c (revision 8809f78c7dd9f33a44a4f89c58fc91ded34296ed)
1 /* SPDX-License-Identifier: BSD-3-Clause
2  * Copyright(c) 2010-2015 Intel Corporation
3  */
4 
5 #include <stdint.h>
6 #include <inttypes.h>
7 #include <rte_eal.h>
8 #include <rte_ethdev.h>
9 #include <rte_cycles.h>
10 #include <rte_lcore.h>
11 #include <rte_mbuf.h>
12 
13 #define RX_RING_SIZE 1024
14 #define TX_RING_SIZE 1024
15 
16 #define NUM_MBUFS 8191
17 #define MBUF_CACHE_SIZE 250
18 #define BURST_SIZE 32
19 
20 static const struct rte_eth_conf port_conf_default = {
21 	.rxmode = {
22 		.max_rx_pkt_len = RTE_ETHER_MAX_LEN,
23 	},
24 };
25 
26 /* basicfwd.c: Basic DPDK skeleton forwarding example. */
27 
28 /*
29  * Initializes a given port using global settings and with the RX buffers
30  * coming from the mbuf_pool passed as a parameter.
31  */
32 static inline int
33 port_init(uint16_t port, struct rte_mempool *mbuf_pool)
34 {
35 	struct rte_eth_conf port_conf = port_conf_default;
36 	const uint16_t rx_rings = 1, tx_rings = 1;
37 	uint16_t nb_rxd = RX_RING_SIZE;
38 	uint16_t nb_txd = TX_RING_SIZE;
39 	int retval;
40 	uint16_t q;
41 	struct rte_eth_dev_info dev_info;
42 	struct rte_eth_txconf txconf;
43 
44 	if (!rte_eth_dev_is_valid_port(port))
45 		return -1;
46 
47 	retval = rte_eth_dev_info_get(port, &dev_info);
48 	if (retval != 0) {
49 		printf("Error during getting device (port %u) info: %s\n",
50 				port, strerror(-retval));
51 		return retval;
52 	}
53 
54 	if (dev_info.tx_offload_capa & DEV_TX_OFFLOAD_MBUF_FAST_FREE)
55 		port_conf.txmode.offloads |=
56 			DEV_TX_OFFLOAD_MBUF_FAST_FREE;
57 
58 	/* Configure the Ethernet device. */
59 	retval = rte_eth_dev_configure(port, rx_rings, tx_rings, &port_conf);
60 	if (retval != 0)
61 		return retval;
62 
63 	retval = rte_eth_dev_adjust_nb_rx_tx_desc(port, &nb_rxd, &nb_txd);
64 	if (retval != 0)
65 		return retval;
66 
67 	/* Allocate and set up 1 RX queue per Ethernet port. */
68 	for (q = 0; q < rx_rings; q++) {
69 		retval = rte_eth_rx_queue_setup(port, q, nb_rxd,
70 				rte_eth_dev_socket_id(port), NULL, mbuf_pool);
71 		if (retval < 0)
72 			return retval;
73 	}
74 
75 	txconf = dev_info.default_txconf;
76 	txconf.offloads = port_conf.txmode.offloads;
77 	/* Allocate and set up 1 TX queue per Ethernet port. */
78 	for (q = 0; q < tx_rings; q++) {
79 		retval = rte_eth_tx_queue_setup(port, q, nb_txd,
80 				rte_eth_dev_socket_id(port), &txconf);
81 		if (retval < 0)
82 			return retval;
83 	}
84 
85 	/* Start the Ethernet port. */
86 	retval = rte_eth_dev_start(port);
87 	if (retval < 0)
88 		return retval;
89 
90 	/* Display the port MAC address. */
91 	struct rte_ether_addr addr;
92 	retval = rte_eth_macaddr_get(port, &addr);
93 	if (retval != 0)
94 		return retval;
95 
96 	printf("Port %u MAC: %02" PRIx8 " %02" PRIx8 " %02" PRIx8
97 			   " %02" PRIx8 " %02" PRIx8 " %02" PRIx8 "\n",
98 			port,
99 			addr.addr_bytes[0], addr.addr_bytes[1],
100 			addr.addr_bytes[2], addr.addr_bytes[3],
101 			addr.addr_bytes[4], addr.addr_bytes[5]);
102 
103 	/* Enable RX in promiscuous mode for the Ethernet device. */
104 	retval = rte_eth_promiscuous_enable(port);
105 	if (retval != 0)
106 		return retval;
107 
108 	return 0;
109 }
110 
111 /*
112  * The lcore main. This is the main thread that does the work, reading from
113  * an input port and writing to an output port.
114  */
115 static __rte_noreturn void
116 lcore_main(void)
117 {
118 	uint16_t port;
119 
120 	/*
121 	 * Check that the port is on the same NUMA node as the polling thread
122 	 * for best performance.
123 	 */
124 	RTE_ETH_FOREACH_DEV(port)
125 		if (rte_eth_dev_socket_id(port) > 0 &&
126 				rte_eth_dev_socket_id(port) !=
127 						(int)rte_socket_id())
128 			printf("WARNING, port %u is on remote NUMA node to "
129 					"polling thread.\n\tPerformance will "
130 					"not be optimal.\n", port);
131 
132 	printf("\nCore %u forwarding packets. [Ctrl+C to quit]\n",
133 			rte_lcore_id());
134 
135 	/* Run until the application is quit or killed. */
136 	for (;;) {
137 		/*
138 		 * Receive packets on a port and forward them on the paired
139 		 * port. The mapping is 0 -> 1, 1 -> 0, 2 -> 3, 3 -> 2, etc.
140 		 */
141 		RTE_ETH_FOREACH_DEV(port) {
142 
143 			/* Get burst of RX packets, from first port of pair. */
144 			struct rte_mbuf *bufs[BURST_SIZE];
145 			const uint16_t nb_rx = rte_eth_rx_burst(port, 0,
146 					bufs, BURST_SIZE);
147 
148 			if (unlikely(nb_rx == 0))
149 				continue;
150 
151 			/* Send burst of TX packets, to second port of pair. */
152 			const uint16_t nb_tx = rte_eth_tx_burst(port ^ 1, 0,
153 					bufs, nb_rx);
154 
155 			/* Free any unsent packets. */
156 			if (unlikely(nb_tx < nb_rx)) {
157 				uint16_t buf;
158 				for (buf = nb_tx; buf < nb_rx; buf++)
159 					rte_pktmbuf_free(bufs[buf]);
160 			}
161 		}
162 	}
163 }
164 
165 /*
166  * The main function, which does initialization and calls the per-lcore
167  * functions.
168  */
169 int
170 main(int argc, char *argv[])
171 {
172 	struct rte_mempool *mbuf_pool;
173 	unsigned nb_ports;
174 	uint16_t portid;
175 
176 	/* Initialize the Environment Abstraction Layer (EAL). */
177 	int ret = rte_eal_init(argc, argv);
178 	if (ret < 0)
179 		rte_exit(EXIT_FAILURE, "Error with EAL initialization\n");
180 
181 	argc -= ret;
182 	argv += ret;
183 
184 	/* Check that there is an even number of ports to send/receive on. */
185 	nb_ports = rte_eth_dev_count_avail();
186 	if (nb_ports < 2 || (nb_ports & 1))
187 		rte_exit(EXIT_FAILURE, "Error: number of ports must be even\n");
188 
189 	/* Creates a new mempool in memory to hold the mbufs. */
190 	mbuf_pool = rte_pktmbuf_pool_create("MBUF_POOL", NUM_MBUFS * nb_ports,
191 		MBUF_CACHE_SIZE, 0, RTE_MBUF_DEFAULT_BUF_SIZE, rte_socket_id());
192 
193 	if (mbuf_pool == NULL)
194 		rte_exit(EXIT_FAILURE, "Cannot create mbuf pool\n");
195 
196 	/* Initialize all ports. */
197 	RTE_ETH_FOREACH_DEV(portid)
198 		if (port_init(portid, mbuf_pool) != 0)
199 			rte_exit(EXIT_FAILURE, "Cannot init port %"PRIu16 "\n",
200 					portid);
201 
202 	if (rte_lcore_count() > 1)
203 		printf("\nWARNING: Too many lcores enabled. Only 1 used.\n");
204 
205 	/* Call lcore_main on the main core only. */
206 	lcore_main();
207 
208 	return 0;
209 }
210