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