xref: /dpdk/examples/multi_process/client_server_mp/mp_server/init.c (revision b6df9fc8715f9a925136006b18fdd65f9c621757)
1 /*-
2  *   BSD LICENSE
3  *
4  *   Copyright(c) 2010-2013 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 
35 #include <stdint.h>
36 #include <stdio.h>
37 #include <string.h>
38 #include <sys/queue.h>
39 #include <errno.h>
40 #include <stdarg.h>
41 #include <inttypes.h>
42 
43 #include <rte_common.h>
44 #include <rte_memory.h>
45 #include <rte_memzone.h>
46 #include <rte_tailq.h>
47 #include <rte_eal.h>
48 #include <rte_byteorder.h>
49 #include <rte_atomic.h>
50 #include <rte_launch.h>
51 #include <rte_per_lcore.h>
52 #include <rte_lcore.h>
53 #include <rte_branch_prediction.h>
54 #include <rte_debug.h>
55 #include <rte_ring.h>
56 #include <rte_log.h>
57 #include <rte_mempool.h>
58 #include <rte_memcpy.h>
59 #include <rte_mbuf.h>
60 #include <rte_interrupts.h>
61 #include <rte_pci.h>
62 #include <rte_ether.h>
63 #include <rte_ethdev.h>
64 #include <rte_malloc.h>
65 #include <rte_fbk_hash.h>
66 #include <rte_string_fns.h>
67 #include <rte_cycles.h>
68 
69 #include "common.h"
70 #include "init_drivers.h"
71 #include "args.h"
72 #include "init.h"
73 #include "main.h"
74 
75 #define MBUFS_PER_CLIENT 1536
76 #define MBUFS_PER_PORT 1536
77 #define MBUF_CACHE_SIZE 512
78 #define MBUF_OVERHEAD (sizeof(struct rte_mbuf) + RTE_PKTMBUF_HEADROOM)
79 #define RX_MBUF_DATA_SIZE 2048
80 #define MBUF_SIZE (RX_MBUF_DATA_SIZE + MBUF_OVERHEAD)
81 
82 #define RTE_MP_RX_DESC_DEFAULT 512
83 #define RTE_MP_TX_DESC_DEFAULT 512
84 #define CLIENT_QUEUE_RINGSIZE 128
85 
86 #define NO_FLAGS 0
87 
88 /*
89  * RX and TX Prefetch, Host, and Write-back threshold values should be
90  * carefully set for optimal performance. Consult the network
91  * controller's datasheet and supporting DPDK documentation for guidance
92  * on how these parameters should be set.
93  */
94 /* Default configuration for rx and tx thresholds etc. */
95 /*
96  * These default values are optimized for use with the Intel(R) 82599 10 GbE
97  * Controller and the DPDK ixgbe PMD. Consider using other values for other
98  * network controllers and/or network drivers.
99  */
100 #define MP_DEFAULT_PTHRESH 36
101 #define MP_DEFAULT_RX_HTHRESH 8
102 #define MP_DEFAULT_TX_HTHRESH 0
103 #define MP_DEFAULT_WTHRESH 0
104 
105 static const struct rte_eth_rxconf rx_conf_default = {
106 		.rx_thresh = {
107 				.pthresh = MP_DEFAULT_PTHRESH,
108 				.hthresh = MP_DEFAULT_RX_HTHRESH,
109 				.wthresh = MP_DEFAULT_WTHRESH,
110 		},
111 };
112 
113 static const struct rte_eth_txconf tx_conf_default = {
114 		.tx_thresh = {
115 				.pthresh = MP_DEFAULT_PTHRESH,
116 				.hthresh = MP_DEFAULT_TX_HTHRESH,
117 				.wthresh = MP_DEFAULT_WTHRESH,
118 		},
119 		.tx_free_thresh = 0, /* Use PMD default values */
120 		.tx_rs_thresh = 0, /* Use PMD default values */
121 };
122 
123 /* The mbuf pool for packet rx */
124 struct rte_mempool *pktmbuf_pool;
125 
126 /* array of info/queues for clients */
127 struct client *clients = NULL;
128 
129 /* the port details */
130 struct port_info *ports;
131 
132 /**
133  * Initialise the mbuf pool for packet reception for the NIC, and any other
134  * buffer pools needed by the app - currently none.
135  */
136 static int
137 init_mbuf_pools(void)
138 {
139 	const unsigned num_mbufs = (num_clients * MBUFS_PER_CLIENT) \
140 			+ (ports->num_ports * MBUFS_PER_PORT);
141 
142 	/* don't pass single-producer/single-consumer flags to mbuf create as it
143 	 * seems faster to use a cache instead */
144 	printf("Creating mbuf pool '%s' [%u mbufs] ...\n",
145 			PKTMBUF_POOL_NAME, num_mbufs);
146 	pktmbuf_pool = rte_mempool_create(PKTMBUF_POOL_NAME, num_mbufs,
147 			MBUF_SIZE, MBUF_CACHE_SIZE,
148 			sizeof(struct rte_pktmbuf_pool_private), rte_pktmbuf_pool_init,
149 			NULL, rte_pktmbuf_init, NULL, SOCKET0, NO_FLAGS );
150 
151 	return (pktmbuf_pool == NULL); /* 0  on success */
152 }
153 
154 /**
155  * Initialise an individual port:
156  * - configure number of rx and tx rings
157  * - set up each rx ring, to pull from the main mbuf pool
158  * - set up each tx ring
159  * - start the port and report its status to stdout
160  */
161 static int
162 init_port(uint8_t port_num)
163 {
164 	/* for port configuration all features are off by default */
165 	const struct rte_eth_conf port_conf = {
166 		.rxmode = {
167 			.mq_mode = ETH_RSS
168 		}
169 	};
170 	const uint16_t rx_rings = 1, tx_rings = num_clients;
171 	const uint16_t rx_ring_size = RTE_MP_RX_DESC_DEFAULT;
172 	const uint16_t tx_ring_size = RTE_MP_TX_DESC_DEFAULT;
173 
174 	uint16_t q;
175 	int retval;
176 
177 	printf("Port %u init ... ", (unsigned)port_num);
178 	fflush(stdout);
179 
180 	/* Standard DPDK port initialisation - config port, then set up
181 	 * rx and tx rings */
182 	if ((retval = rte_eth_dev_configure(port_num, rx_rings, tx_rings,
183 		&port_conf)) != 0)
184 		return retval;
185 
186 	for (q = 0; q < rx_rings; q++) {
187 		retval = rte_eth_rx_queue_setup(port_num, q, rx_ring_size,
188 				SOCKET0, &rx_conf_default, pktmbuf_pool);
189 		if (retval < 0) return retval;
190 	}
191 
192 	for ( q = 0; q < tx_rings; q ++ ) {
193 		retval = rte_eth_tx_queue_setup(port_num, q, tx_ring_size,
194 				SOCKET0, &tx_conf_default);
195 		if (retval < 0) return retval;
196 	}
197 
198 	rte_eth_promiscuous_enable(port_num);
199 
200 	retval  = rte_eth_dev_start(port_num);
201 	if (retval < 0) return retval;
202 
203 	printf( "done: \n");
204 
205 	return 0;
206 }
207 
208 /**
209  * Set up the DPDK rings which will be used to pass packets, via
210  * pointers, between the multi-process server and client processes.
211  * Each client needs one RX queue.
212  */
213 static int
214 init_shm_rings(void)
215 {
216 	unsigned i;
217 	const unsigned ringsize = CLIENT_QUEUE_RINGSIZE;
218 
219 	clients = rte_malloc("client details",
220 		sizeof(*clients) * num_clients, 0);
221 	if (clients == NULL)
222 		rte_exit(EXIT_FAILURE, "Cannot allocate memory for client program details\n");
223 
224 	for (i = 0; i < num_clients; i++) {
225 		/* Create an RX queue for each client */
226 		clients[i].rx_q = rte_ring_create(get_rx_queue_name(i),
227 				ringsize, SOCKET0,
228 				RING_F_SP_ENQ | RING_F_SC_DEQ ); /* single prod, single cons */
229 		if (clients[i].rx_q == NULL)
230 			rte_exit(EXIT_FAILURE, "Cannot create rx ring queue for client %u\n", i);
231 	}
232 	return 0;
233 }
234 
235 /* Check the link status of all ports in up to 9s, and print them finally */
236 static void
237 check_all_ports_link_status(uint8_t port_num, uint32_t port_mask)
238 {
239 #define CHECK_INTERVAL 100 /* 100ms */
240 #define MAX_CHECK_TIME 90 /* 9s (90 * 100ms) in total */
241 	uint8_t portid, count, all_ports_up, print_flag = 0;
242 	struct rte_eth_link link;
243 
244 	printf("\nChecking link status");
245 	fflush(stdout);
246 	for (count = 0; count <= MAX_CHECK_TIME; count++) {
247 		all_ports_up = 1;
248 		for (portid = 0; portid < port_num; portid++) {
249 			if ((port_mask & (1 << portid)) == 0)
250 				continue;
251 			memset(&link, 0, sizeof(link));
252 			rte_eth_link_get_nowait(portid, &link);
253 			/* print link status if flag set */
254 			if (print_flag == 1) {
255 				if (link.link_status)
256 					printf("Port %d Link Up - speed %u "
257 						"Mbps - %s\n", (uint8_t)portid,
258 						(unsigned)link.link_speed,
259 				(link.link_duplex == ETH_LINK_FULL_DUPLEX) ?
260 					("full-duplex") : ("half-duplex\n"));
261 				else
262 					printf("Port %d Link Down\n",
263 						(uint8_t)portid);
264 				continue;
265 			}
266 			/* clear all_ports_up flag if any link down */
267 			if (link.link_status == 0) {
268 				all_ports_up = 0;
269 				break;
270 			}
271 		}
272 		/* after finally printing all link status, get out */
273 		if (print_flag == 1)
274 			break;
275 
276 		if (all_ports_up == 0) {
277 			printf(".");
278 			fflush(stdout);
279 			rte_delay_ms(CHECK_INTERVAL);
280 		}
281 
282 		/* set the print_flag if all ports up or timeout */
283 		if (all_ports_up == 1 || count == (MAX_CHECK_TIME - 1)) {
284 			print_flag = 1;
285 			printf("done\n");
286 		}
287 	}
288 }
289 
290 /**
291  * Main init function for the multi-process server app,
292  * calls subfunctions to do each stage of the initialisation.
293  */
294 int
295 init(int argc, char *argv[])
296 {
297 	int retval;
298 	const struct rte_memzone *mz;
299 	uint8_t i, total_ports;
300 
301 	/* init EAL, parsing EAL args */
302 	retval = rte_eal_init(argc, argv);
303 	if (retval < 0)
304 		return -1;
305 	argc -= retval;
306 	argv += retval;
307 
308 	/* initialise the nic drivers */
309 	retval = init_drivers();
310 	if (retval != 0)
311 		rte_exit(EXIT_FAILURE, "Cannot initialise drivers\n");
312 
313 	/* get total number of ports */
314 	total_ports = rte_eth_dev_count();
315 
316 	/* set up array for port data */
317 	mz = rte_memzone_reserve(MZ_PORT_INFO, sizeof(*ports),
318 				rte_socket_id(), NO_FLAGS);
319 	if (mz == NULL)
320 		rte_exit(EXIT_FAILURE, "Cannot reserve memory zone for port information\n");
321 	memset(mz->addr, 0, sizeof(*ports));
322 	ports = mz->addr;
323 
324 	/* parse additional, application arguments */
325 	retval = parse_app_args(total_ports, argc, argv);
326 	if (retval != 0)
327 		return -1;
328 
329 	/* initialise mbuf pools */
330 	retval = init_mbuf_pools();
331 	if (retval != 0)
332 		rte_exit(EXIT_FAILURE, "Cannot create needed mbuf pools\n");
333 
334 	/* now initialise the ports we will use */
335 	for (i = 0; i < ports->num_ports; i++) {
336 		retval = init_port(ports->id[i]);
337 		if (retval != 0)
338 			rte_exit(EXIT_FAILURE, "Cannot initialise port %u\n",
339 					(unsigned)i);
340 	}
341 
342 	check_all_ports_link_status(ports->num_ports, (~0x0));
343 
344 	/* initialise the client queues/rings for inter-eu comms */
345 	init_shm_rings();
346 
347 	return 0;
348 }
349