examples/multi_process/client_server_mp/mp_server/main.c

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