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