examples/multi_process/client_server_mp/mp_server/init.c

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2010-2012 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
  35 #include <stdint.h>
  36 #include <stdio.h>
  37 #include <string.h>
  38 #include <sys/queue.h>
  39 #include <errno.h>
  40 #include <stdarg.h>
  41 #include <inttypes.h>
  42
  43 #include <rte_common.h>
  44 #include <rte_memory.h>
  45 #include <rte_memzone.h>
  46 #include <rte_tailq.h>
  47 #include <rte_eal.h>
  48 #include <rte_byteorder.h>
  49 #include <rte_atomic.h>
  50 #include <rte_launch.h>
  51 #include <rte_per_lcore.h>
  52 #include <rte_lcore.h>
  53 #include <rte_branch_prediction.h>
  54 #include <rte_debug.h>
  55 #include <rte_ring.h>
  56 #include <rte_log.h>
  57 #include <rte_mempool.h>
  58 #include <rte_memcpy.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_malloc.h>
  65 #include <rte_hash_crc.h>
  66 #include <rte_fbk_hash.h>
  67 #include <rte_string_fns.h>
  68 #include <rte_cycles.h>
  69
  70 #include "common.h"
  71 #include "init_drivers.h"
  72 #include "args.h"
  73 #include "init.h"
  74 #include "main.h"
  75
  76 #define MBUFS_PER_CLIENT 1536
  77 #define MBUFS_PER_PORT 1536
  78 #define MBUF_CACHE_SIZE 512
  79 #define MBUF_OVERHEAD (sizeof(struct rte_mbuf) + RTE_PKTMBUF_HEADROOM)
  80 #define RX_MBUF_DATA_SIZE 2048
  81 #define MBUF_SIZE (RX_MBUF_DATA_SIZE + MBUF_OVERHEAD)
  82
  83 #define RTE_MP_RX_DESC_DEFAULT 512
  84 #define RTE_MP_TX_DESC_DEFAULT 512
  85 #define CLIENT_QUEUE_RINGSIZE 128
  86
  87 #define NO_FLAGS 0
  88
  89 /*
  90  * RX and TX Prefetch, Host, and Write-back threshold values should be
  91  * carefully set for optimal performance. Consult the network
  92  * controller's datasheet and supporting DPDK documentation for guidance
  93  * on how these parameters should be set.
  94  */
  95 /* Default configuration for rx and tx thresholds etc. */
  96 /*
  97  * These default values are optimized for use with the Intel(R) 82599 10 GbE
  98  * Controller and the DPDK ixgbe PMD. Consider using other values for other
  99  * network controllers and/or network drivers.
 100  */
 101 #define MP_DEFAULT_PTHRESH 36
 102 #define MP_DEFAULT_RX_HTHRESH 8
 103 #define MP_DEFAULT_TX_HTHRESH 0
 104 #define MP_DEFAULT_WTHRESH 0
 105
 106 static const struct rte_eth_rxconf rx_conf_default = {
 107                 .rx_thresh = {
 108                                 .pthresh = MP_DEFAULT_PTHRESH,
 109                                 .hthresh = MP_DEFAULT_RX_HTHRESH,
 110                                 .wthresh = MP_DEFAULT_WTHRESH,
 111                 },
 112 };
 113
 114 static const struct rte_eth_txconf tx_conf_default = {
 115                 .tx_thresh = {
 116                                 .pthresh = MP_DEFAULT_PTHRESH,
 117                                 .hthresh = MP_DEFAULT_TX_HTHRESH,
 118                                 .wthresh = MP_DEFAULT_WTHRESH,
 119                 },
 120                 .tx_free_thresh = 0, /* Use PMD default values */
 121                 .tx_rs_thresh = 0, /* Use PMD default values */
 122 };
 123
 124 /* The mbuf pool for packet rx */
 125 struct rte_mempool *pktmbuf_pool;
 126
 127 /* array of info/queues for clients */
 128 struct client *clients = NULL;
 129
 130 /* the port details */
 131 struct port_info *ports;
 132
 133 /**
 134  * Initialise the mbuf pool for packet reception for the NIC, and any other
 135  * buffer pools needed by the app - currently none.
 136  */
 137 static int
 138 init_mbuf_pools(void)
 139 {
 140         const unsigned num_mbufs = (num_clients * MBUFS_PER_CLIENT) \
 141                         + (ports->num_ports * MBUFS_PER_PORT);
 142
 143         /* don't pass single-producer/single-consumer flags to mbuf create as it
 144          * seems faster to use a cache instead */
 145         printf("Creating mbuf pool '%s' [%u mbufs] ...\n",
 146                         PKTMBUF_POOL_NAME, num_mbufs);
 147         pktmbuf_pool = rte_mempool_create(PKTMBUF_POOL_NAME, num_mbufs,
 148                         MBUF_SIZE, MBUF_CACHE_SIZE,
 149                         sizeof(struct rte_pktmbuf_pool_private), rte_pktmbuf_pool_init,
 150                         NULL, rte_pktmbuf_init, NULL, SOCKET0, NO_FLAGS );
 151
 152         return (pktmbuf_pool == NULL); /* 0  on success */
 153 }
 154
 155 /**
 156  * Initialise an individual port:
 157  * - configure number of rx and tx rings
 158  * - set up each rx ring, to pull from the main mbuf pool
 159  * - set up each tx ring
 160  * - start the port and report its status to stdout
 161  */
 162 static int
 163 init_port(uint8_t port_num)
 164 {
 165         /* for port configuration all features are off by default */
 166         const struct rte_eth_conf port_conf = {
 167                 .rxmode = {
 168                         .mq_mode = ETH_RSS
 169                 }
 170         };
 171         const uint16_t rx_rings = 1, tx_rings = num_clients;
 172         const uint16_t rx_ring_size = RTE_MP_RX_DESC_DEFAULT;
 173         const uint16_t tx_ring_size = RTE_MP_TX_DESC_DEFAULT;
 174
 175         uint16_t q;
 176         int retval;
 177
 178         printf("Port %u init ... ", (unsigned)port_num);
 179         fflush(stdout);
 180
 181         /* Standard DPDK port initialisation - config port, then set up
 182          * rx and tx rings */
 183         if ((retval = rte_eth_dev_configure(port_num, rx_rings, tx_rings,
 184                 &port_conf)) != 0)
 185                 return retval;
 186
 187         for (q = 0; q < rx_rings; q++) {
 188                 retval = rte_eth_rx_queue_setup(port_num, q, rx_ring_size,
 189                                 SOCKET0, &rx_conf_default, pktmbuf_pool);
 190                 if (retval < 0) return retval;
 191         }
 192
 193         for ( q = 0; q < tx_rings; q ++ ) {
 194                 retval = rte_eth_tx_queue_setup(port_num, q, tx_ring_size,
 195                                 SOCKET0, &tx_conf_default);
 196                 if (retval < 0) return retval;
 197         }
 198
 199         rte_eth_promiscuous_enable(port_num);
 200
 201         retval  = rte_eth_dev_start(port_num);
 202         if (retval < 0) return retval;
 203
 204         printf( "done: \n");
 205
 206         return 0;
 207 }
 208
 209 /**
 210  * Set up the DPDK rings which will be used to pass packets, via
 211  * pointers, between the multi-process server and client processes.
 212  * Each client needs one RX queue.
 213  */
 214 static int
 215 init_shm_rings(void)
 216 {
 217         unsigned i;
 218         const unsigned ringsize = CLIENT_QUEUE_RINGSIZE;
 219
 220         clients = rte_malloc("client details",
 221                 sizeof(*clients) * num_clients, 0);
 222         if (clients == NULL)
 223                 rte_exit(EXIT_FAILURE, "Cannot allocate memory for client program details\n");
 224
 225         for (i = 0; i < num_clients; i++) {
 226                 /* Create an RX queue for each client */
 227                 clients[i].rx_q = rte_ring_create(get_rx_queue_name(i),
 228                                 ringsize, SOCKET0,
 229                                 RING_F_SP_ENQ | RING_F_SC_DEQ ); /* single prod, single cons */
 230                 if (clients[i].rx_q == NULL)
 231                         rte_exit(EXIT_FAILURE, "Cannot create rx ring queue for client %u\n", i);
 232         }
 233         return 0;
 234 }
 235
 236 /* Check the link status of all ports in up to 9s, and print them finally */
 237 static void
 238 check_all_ports_link_status(uint8_t port_num, uint32_t port_mask)
 239 {
 240 #define CHECK_INTERVAL 100 /* 100ms */
 241 #define MAX_CHECK_TIME 90 /* 9s (90 * 100ms) in total */
 242         uint8_t portid, count, all_ports_up, print_flag = 0;
 243         struct rte_eth_link link;
 244
 245         printf("\nChecking link status");
 246         fflush(stdout);
 247         for (count = 0; count <= MAX_CHECK_TIME; count++) {
 248                 all_ports_up = 1;
 249                 for (portid = 0; portid < port_num; portid++) {
 250                         if ((port_mask & (1 << portid)) == 0)
 251                                 continue;
 252                         memset(&link, 0, sizeof(link));
 253                         rte_eth_link_get_nowait(portid, &link);
 254                         /* print link status if flag set */
 255                         if (print_flag == 1) {
 256                                 if (link.link_status)
 257                                         printf("Port %d Link Up - speed %u "
 258                                                 "Mbps - %s\n", (uint8_t)portid,
 259                                                 (unsigned)link.link_speed,
 260                                 (link.link_duplex == ETH_LINK_FULL_DUPLEX) ?
 261                                         ("full-duplex") : ("half-duplex\n"));
 262                                 else
 263                                         printf("Port %d Link Down\n",
 264                                                 (uint8_t)portid);
 265                                 continue;
 266                         }
 267                         /* clear all_ports_up flag if any link down */
 268                         if (link.link_status == 0) {
 269                                 all_ports_up = 0;
 270                                 break;
 271                         }
 272                 }
 273                 /* after finally printing all link status, get out */
 274                 if (print_flag == 1)
 275                         break;
 276
 277                 if (all_ports_up == 0) {
 278                         printf(".");
 279                         fflush(stdout);
 280                         rte_delay_ms(CHECK_INTERVAL);
 281                 }
 282
 283                 /* set the print_flag if all ports up or timeout */
 284                 if (all_ports_up == 1 || count == (MAX_CHECK_TIME - 1)) {
 285                         print_flag = 1;
 286                         printf("done\n");
 287                 }
 288         }
 289 }
 290
 291 /**
 292  * Main init function for the multi-process server app,
 293  * calls subfunctions to do each stage of the initialisation.
 294  */
 295 int
 296 init(int argc, char *argv[])
 297 {
 298         int retval;
 299         const struct rte_memzone *mz;
 300         uint8_t i, total_ports;
 301
 302         /* init EAL, parsing EAL args */
 303         retval = rte_eal_init(argc, argv);
 304         if (retval < 0)
 305                 return -1;
 306         argc -= retval;
 307         argv += retval;
 308
 309         /* initialise the nic drivers */
 310         retval = init_drivers();
 311         if (retval != 0)
 312                 rte_exit(EXIT_FAILURE, "Cannot initialise drivers\n");
 313
 314         /* get total number of ports */
 315         total_ports = rte_eth_dev_count();
 316
 317         /* set up array for port data */
 318         mz = rte_memzone_reserve(MZ_PORT_INFO, sizeof(*ports),
 319                                 rte_socket_id(), NO_FLAGS);
 320         if (mz == NULL)
 321                 rte_exit(EXIT_FAILURE, "Cannot reserve memory zone for port information\n");
 322         memset(mz->addr, 0, sizeof(*ports));
 323         ports = mz->addr;
 324
 325         /* parse additional, application arguments */
 326         retval = parse_app_args(total_ports, argc, argv);
 327         if (retval != 0)
 328                 return -1;
 329
 330         /* initialise mbuf pools */
 331         retval = init_mbuf_pools();
 332         if (retval != 0)
 333                 rte_exit(EXIT_FAILURE, "Cannot create needed mbuf pools\n");
 334
 335         /* now initialise the ports we will use */
 336         for (i = 0; i < ports->num_ports; i++) {
 337                 retval = init_port(ports->id[i]);
 338                 if (retval != 0)
 339                         rte_exit(EXIT_FAILURE, "Cannot initialise port %u\n",
 340                                         (unsigned)i);
 341         }
 342
 343         check_all_ports_link_status(ports->num_ports, (~0x0));
 344
 345         /* initialise the client queues/rings for inter-eu comms */
 346         init_shm_rings();
 347
 348         return 0;
 349 }