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