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