xref: /dpdk/examples/multi_process/client_server_mp/mp_server/main.c (revision 2f45703c17acb943aaded9f79676fd56a72542b2)
1 /*-
2  *   BSD LICENSE
3  *
4  *   Copyright(c) 2010-2014 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 <stdio.h>
35 #include <stdlib.h>
36 #include <string.h>
37 #include <unistd.h>
38 #include <stdint.h>
39 #include <stdarg.h>
40 #include <inttypes.h>
41 #include <inttypes.h>
42 #include <sys/queue.h>
43 #include <errno.h>
44 #include <netinet/ip.h>
45 
46 #include <rte_common.h>
47 #include <rte_memory.h>
48 #include <rte_memzone.h>
49 #include <rte_eal.h>
50 #include <rte_byteorder.h>
51 #include <rte_launch.h>
52 #include <rte_per_lcore.h>
53 #include <rte_lcore.h>
54 #include <rte_branch_prediction.h>
55 #include <rte_atomic.h>
56 #include <rte_ring.h>
57 #include <rte_log.h>
58 #include <rte_debug.h>
59 #include <rte_mempool.h>
60 #include <rte_memcpy.h>
61 #include <rte_mbuf.h>
62 #include <rte_ether.h>
63 #include <rte_interrupts.h>
64 #include <rte_pci.h>
65 #include <rte_ethdev.h>
66 #include <rte_byteorder.h>
67 #include <rte_malloc.h>
68 #include <rte_string_fns.h>
69 
70 #include "common.h"
71 #include "args.h"
72 #include "init.h"
73 
74 /*
75  * When doing reads from the NIC or the client queues,
76  * use this batch size
77  */
78 #define PACKET_READ_SIZE 32
79 
80 /*
81  * Local buffers to put packets in, used to send packets in bursts to the
82  * clients
83  */
84 struct client_rx_buf {
85 	struct rte_mbuf *buffer[PACKET_READ_SIZE];
86 	uint16_t count;
87 };
88 
89 /* One buffer per client rx queue - dynamically allocate array */
90 static struct client_rx_buf *cl_rx_buf;
91 
92 static const char *
93 get_printable_mac_addr(uint8_t port)
94 {
95 	static const char err_address[] = "00:00:00:00:00:00";
96 	static char addresses[RTE_MAX_ETHPORTS][sizeof(err_address)];
97 
98 	if (unlikely(port >= RTE_MAX_ETHPORTS))
99 		return err_address;
100 	if (unlikely(addresses[port][0]=='\0')){
101 		struct ether_addr mac;
102 		rte_eth_macaddr_get(port, &mac);
103 		snprintf(addresses[port], sizeof(addresses[port]),
104 				"%02x:%02x:%02x:%02x:%02x:%02x\n",
105 				mac.addr_bytes[0], mac.addr_bytes[1], mac.addr_bytes[2],
106 				mac.addr_bytes[3], mac.addr_bytes[4], mac.addr_bytes[5]);
107 	}
108 	return addresses[port];
109 }
110 
111 /*
112  * This function displays the recorded statistics for each port
113  * and for each client. It uses ANSI terminal codes to clear
114  * screen when called. It is called from a single non-master
115  * thread in the server process, when the process is run with more
116  * than one lcore enabled.
117  */
118 static void
119 do_stats_display(void)
120 {
121 	unsigned i, j;
122 	const char clr[] = { 27, '[', '2', 'J', '\0' };
123 	const char topLeft[] = { 27, '[', '1', ';', '1', 'H','\0' };
124 	uint64_t port_tx[RTE_MAX_ETHPORTS], port_tx_drop[RTE_MAX_ETHPORTS];
125 	uint64_t client_tx[MAX_CLIENTS], client_tx_drop[MAX_CLIENTS];
126 
127 	/* to get TX stats, we need to do some summing calculations */
128 	memset(port_tx, 0, sizeof(port_tx));
129 	memset(port_tx_drop, 0, sizeof(port_tx_drop));
130 	memset(client_tx, 0, sizeof(client_tx));
131 	memset(client_tx_drop, 0, sizeof(client_tx_drop));
132 
133 	for (i = 0; i < num_clients; i++){
134 		const volatile struct tx_stats *tx = &ports->tx_stats[i];
135 		for (j = 0; j < ports->num_ports; j++){
136 			/* assign to local variables here, save re-reading volatile vars */
137 			const uint64_t tx_val = tx->tx[ports->id[j]];
138 			const uint64_t drop_val = tx->tx_drop[ports->id[j]];
139 			port_tx[j] += tx_val;
140 			port_tx_drop[j] += drop_val;
141 			client_tx[i] += tx_val;
142 			client_tx_drop[i] += drop_val;
143 		}
144 	}
145 
146 	/* Clear screen and move to top left */
147 	printf("%s%s", clr, topLeft);
148 
149 	printf("PORTS\n");
150 	printf("-----\n");
151 	for (i = 0; i < ports->num_ports; i++)
152 		printf("Port %u: '%s'\t", (unsigned)ports->id[i],
153 				get_printable_mac_addr(ports->id[i]));
154 	printf("\n\n");
155 	for (i = 0; i < ports->num_ports; i++){
156 		printf("Port %u - rx: %9"PRIu64"\t"
157 				"tx: %9"PRIu64"\n",
158 				(unsigned)ports->id[i], ports->rx_stats.rx[i],
159 				port_tx[i]);
160 	}
161 
162 	printf("\nCLIENTS\n");
163 	printf("-------\n");
164 	for (i = 0; i < num_clients; i++){
165 		const unsigned long long rx = clients[i].stats.rx;
166 		const unsigned long long rx_drop = clients[i].stats.rx_drop;
167 		printf("Client %2u - rx: %9llu, rx_drop: %9llu\n"
168 				"            tx: %9"PRIu64", tx_drop: %9"PRIu64"\n",
169 				i, rx, rx_drop, client_tx[i], client_tx_drop[i]);
170 	}
171 
172 	printf("\n");
173 }
174 
175 /*
176  * The function called from each non-master lcore used by the process.
177  * The test_and_set function is used to randomly pick a single lcore on which
178  * the code to display the statistics will run. Otherwise, the code just
179  * repeatedly sleeps.
180  */
181 static int
182 sleep_lcore(__attribute__((unused)) void *dummy)
183 {
184 	/* Used to pick a display thread - static, so zero-initialised */
185 	static rte_atomic32_t display_stats;
186 
187 	/* Only one core should display stats */
188 	if (rte_atomic32_test_and_set(&display_stats)) {
189 		const unsigned sleeptime = 1;
190 		printf("Core %u displaying statistics\n", rte_lcore_id());
191 
192 		/* Longer initial pause so above printf is seen */
193 		sleep(sleeptime * 3);
194 
195 		/* Loop forever: sleep always returns 0 or <= param */
196 		while (sleep(sleeptime) <= sleeptime)
197 			do_stats_display();
198 	}
199 	return 0;
200 }
201 
202 /*
203  * Function to set all the client statistic values to zero.
204  * Called at program startup.
205  */
206 static void
207 clear_stats(void)
208 {
209 	unsigned i;
210 
211 	for (i = 0; i < num_clients; i++)
212 		clients[i].stats.rx = clients[i].stats.rx_drop = 0;
213 }
214 
215 /*
216  * send a burst of traffic to a client, assuming there are packets
217  * available to be sent to this client
218  */
219 static void
220 flush_rx_queue(uint16_t client)
221 {
222 	uint16_t j;
223 	struct client *cl;
224 
225 	if (cl_rx_buf[client].count == 0)
226 		return;
227 
228 	cl = &clients[client];
229 	if (rte_ring_enqueue_bulk(cl->rx_q, (void **)cl_rx_buf[client].buffer,
230 			cl_rx_buf[client].count) != 0){
231 		for (j = 0; j < cl_rx_buf[client].count; j++)
232 			rte_pktmbuf_free(cl_rx_buf[client].buffer[j]);
233 		cl->stats.rx_drop += cl_rx_buf[client].count;
234 	}
235 	else
236 		cl->stats.rx += cl_rx_buf[client].count;
237 
238 	cl_rx_buf[client].count = 0;
239 }
240 
241 /*
242  * marks a packet down to be sent to a particular client process
243  */
244 static inline void
245 enqueue_rx_packet(uint8_t client, struct rte_mbuf *buf)
246 {
247 	cl_rx_buf[client].buffer[cl_rx_buf[client].count++] = buf;
248 }
249 
250 /*
251  * This function takes a group of packets and routes them
252  * individually to the client process. Very simply round-robins the packets
253  * without checking any of the packet contents.
254  */
255 static void
256 process_packets(uint32_t port_num __rte_unused,
257 		struct rte_mbuf *pkts[], uint16_t rx_count)
258 {
259 	uint16_t i;
260 	uint8_t client = 0;
261 
262 	for (i = 0; i < rx_count; i++) {
263 		enqueue_rx_packet(client, pkts[i]);
264 
265 		if (++client == num_clients)
266 			client = 0;
267 	}
268 
269 	for (i = 0; i < num_clients; i++)
270 		flush_rx_queue(i);
271 }
272 
273 /*
274  * Function called by the master lcore of the DPDK process.
275  */
276 static void
277 do_packet_forwarding(void)
278 {
279 	unsigned port_num = 0; /* indexes the port[] array */
280 
281 	for (;;) {
282 		struct rte_mbuf *buf[PACKET_READ_SIZE];
283 		uint16_t rx_count;
284 
285 		/* read a port */
286 		rx_count = rte_eth_rx_burst(ports->id[port_num], 0, \
287 				buf, PACKET_READ_SIZE);
288 		ports->rx_stats.rx[port_num] += rx_count;
289 
290 		/* Now process the NIC packets read */
291 		if (likely(rx_count > 0))
292 			process_packets(port_num, buf, rx_count);
293 
294 		/* move to next port */
295 		if (++port_num == ports->num_ports)
296 			port_num = 0;
297 	}
298 }
299 
300 int
301 main(int argc, char *argv[])
302 {
303 	/* initialise the system */
304 	if (init(argc, argv) < 0 )
305 		return -1;
306 	RTE_LOG(INFO, APP, "Finished Process Init.\n");
307 
308 	cl_rx_buf = calloc(num_clients, sizeof(cl_rx_buf[0]));
309 
310 	/* clear statistics */
311 	clear_stats();
312 
313 	/* put all other cores to sleep bar master */
314 	rte_eal_mp_remote_launch(sleep_lcore, NULL, SKIP_MASTER);
315 
316 	do_packet_forwarding();
317 	return 0;
318 }
319