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