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