xref: /dpdk/examples/multi_process/client_server_mp/mp_client/client.c (revision 1ad89e0d0883b95ba1f52fef4eb98deebfbaaff5)
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 <stdint.h>
35 #include <stdio.h>
36 #include <inttypes.h>
37 #include <stdarg.h>
38 #include <errno.h>
39 #include <sys/queue.h>
40 #include <stdlib.h>
41 #include <getopt.h>
42 #include <string.h>
43 
44 #include <rte_common.h>
45 #include <rte_memory.h>
46 #include <rte_memzone.h>
47 #include <rte_eal.h>
48 #include <rte_atomic.h>
49 #include <rte_branch_prediction.h>
50 #include <rte_log.h>
51 #include <rte_per_lcore.h>
52 #include <rte_launch.h>
53 #include <rte_lcore.h>
54 #include <rte_ring.h>
55 #include <rte_launch.h>
56 #include <rte_lcore.h>
57 #include <rte_debug.h>
58 #include <rte_mempool.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_string_fns.h>
65 
66 #include "common.h"
67 
68 /* Number of packets to attempt to read from queue */
69 #define PKT_READ_SIZE  ((uint16_t)32)
70 
71 /* our client id number - tells us which rx queue to read, and NIC TX
72  * queue to write to. */
73 static uint8_t client_id = 0;
74 
75 struct mbuf_queue {
76 #define MBQ_CAPACITY 32
77 	struct rte_mbuf *bufs[MBQ_CAPACITY];
78 	uint16_t top;
79 };
80 
81 /* maps input ports to output ports for packets */
82 static uint8_t output_ports[RTE_MAX_ETHPORTS];
83 
84 /* buffers up a set of packet that are ready to send */
85 static struct mbuf_queue output_bufs[RTE_MAX_ETHPORTS];
86 
87 /* shared data from server. We update statistics here */
88 static volatile struct tx_stats *tx_stats;
89 
90 
91 /*
92  * print a usage message
93  */
94 static void
95 usage(const char *progname)
96 {
97 	printf("Usage: %s [EAL args] -- -n <client_id>\n\n", progname);
98 }
99 
100 /*
101  * Convert the client id number from a string to an int.
102  */
103 static int
104 parse_client_num(const char *client)
105 {
106 	char *end = NULL;
107 	unsigned long temp;
108 
109 	if (client == NULL || *client == '\0')
110 		return -1;
111 
112 	temp = strtoul(client, &end, 10);
113 	if (end == NULL || *end != '\0')
114 		return -1;
115 
116 	client_id = (uint8_t)temp;
117 	return 0;
118 }
119 
120 /*
121  * Parse the application arguments to the client app.
122  */
123 static int
124 parse_app_args(int argc, char *argv[])
125 {
126 	int option_index, opt;
127 	char **argvopt = argv;
128 	const char *progname = NULL;
129 	static struct option lgopts[] = { /* no long options */
130 		{NULL, 0, 0, 0 }
131 	};
132 	progname = argv[0];
133 
134 	while ((opt = getopt_long(argc, argvopt, "n:", lgopts,
135 		&option_index)) != EOF){
136 		switch (opt){
137 			case 'n':
138 				if (parse_client_num(optarg) != 0){
139 					usage(progname);
140 					return -1;
141 				}
142 				break;
143 			default:
144 				usage(progname);
145 				return -1;
146 		}
147 	}
148 	return 0;
149 }
150 
151 /*
152  * set up output ports so that all traffic on port gets sent out
153  * its paired port. Index using actual port numbers since that is
154  * what comes in the mbuf structure.
155  */
156 static void configure_output_ports(const struct port_info *ports)
157 {
158 	int i;
159 	if (ports->num_ports > RTE_MAX_ETHPORTS)
160 		rte_exit(EXIT_FAILURE, "Too many ethernet ports. RTE_MAX_ETHPORTS = %u\n",
161 				(unsigned)RTE_MAX_ETHPORTS);
162 	for (i = 0; i < ports->num_ports - 1; i+=2){
163 		uint8_t p1 = ports->id[i];
164 		uint8_t p2 = ports->id[i+1];
165 		output_ports[p1] = p2;
166 		output_ports[p2] = p1;
167 	}
168 }
169 
170 
171 static inline void
172 send_packets(uint8_t port)
173 {
174 	uint16_t i, sent;
175 	struct mbuf_queue *mbq = &output_bufs[port];
176 
177 	if (unlikely(mbq->top == 0))
178 		return;
179 
180 	sent = rte_eth_tx_burst(port, client_id, mbq->bufs, mbq->top);
181 	if (unlikely(sent < mbq->top)){
182 		for (i = sent; i < mbq->top; i++)
183 			rte_pktmbuf_free(mbq->bufs[i]);
184 		tx_stats->tx_drop[port] += (mbq->top - sent);
185 	}
186 	tx_stats->tx[port] += sent;
187 	mbq->top = 0;
188 }
189 
190 /*
191  * Enqueue a packet to be sent on a particular port, but
192  * don't send it yet. Only when the buffer is full.
193  */
194 static inline void
195 enqueue_packet(struct rte_mbuf *buf, uint8_t port)
196 {
197 	struct mbuf_queue *mbq = &output_bufs[port];
198 	mbq->bufs[mbq->top++] = buf;
199 
200 	if (mbq->top == MBQ_CAPACITY)
201 		send_packets(port);
202 }
203 
204 /*
205  * This function performs routing of packets
206  * Just sends each input packet out an output port based solely on the input
207  * port it arrived on.
208  */
209 static void
210 handle_packet(struct rte_mbuf *buf)
211 {
212 	const uint8_t in_port = buf->port;
213 	const uint8_t out_port = output_ports[in_port];
214 
215 	enqueue_packet(buf, out_port);
216 }
217 
218 /*
219  * Application main function - loops through
220  * receiving and processing packets. Never returns
221  */
222 int
223 main(int argc, char *argv[])
224 {
225 	const struct rte_memzone *mz;
226 	struct rte_ring *rx_ring;
227 	struct rte_mempool *mp;
228 	struct port_info *ports;
229 	int need_flush = 0; /* indicates whether we have unsent packets */
230 	int retval;
231 	void *pkts[PKT_READ_SIZE];
232 
233 	if ((retval = rte_eal_init(argc, argv)) < 0)
234 		return -1;
235 	argc -= retval;
236 	argv += retval;
237 
238 	if (parse_app_args(argc, argv) < 0)
239 		rte_exit(EXIT_FAILURE, "Invalid command-line arguments\n");
240 
241 	if (rte_eth_dev_count() == 0)
242 		rte_exit(EXIT_FAILURE, "No Ethernet ports - bye\n");
243 
244 	rx_ring = rte_ring_lookup(get_rx_queue_name(client_id));
245 	if (rx_ring == NULL)
246 		rte_exit(EXIT_FAILURE, "Cannot get RX ring - is server process running?\n");
247 
248 	mp = rte_mempool_lookup(PKTMBUF_POOL_NAME);
249 	if (mp == NULL)
250 		rte_exit(EXIT_FAILURE, "Cannot get mempool for mbufs\n");
251 
252 	mz = rte_memzone_lookup(MZ_PORT_INFO);
253 	if (mz == NULL)
254 		rte_exit(EXIT_FAILURE, "Cannot get port info structure\n");
255 	ports = mz->addr;
256 	tx_stats = &(ports->tx_stats[client_id]);
257 
258 	configure_output_ports(ports);
259 
260 	RTE_LOG(INFO, APP, "Finished Process Init.\n");
261 
262 	printf("\nClient process %d handling packets\n", client_id);
263 	printf("[Press Ctrl-C to quit ...]\n");
264 
265 	for (;;) {
266 		uint16_t i, rx_pkts = PKT_READ_SIZE;
267 		uint8_t port;
268 
269 		/* try dequeuing max possible packets first, if that fails, get the
270 		 * most we can. Loop body should only execute once, maximum */
271 		while (rx_pkts > 0 &&
272 				unlikely(rte_ring_dequeue_bulk(rx_ring, pkts, rx_pkts) != 0))
273 			rx_pkts = (uint16_t)RTE_MIN(rte_ring_count(rx_ring), PKT_READ_SIZE);
274 
275 		if (unlikely(rx_pkts == 0)){
276 			if (need_flush)
277 				for (port = 0; port < ports->num_ports; port++)
278 					send_packets(ports->id[port]);
279 			need_flush = 0;
280 			continue;
281 		}
282 
283 		for (i = 0; i < rx_pkts; i++)
284 			handle_packet(pkts[i]);
285 
286 		need_flush = 1;
287 	}
288 }
289