examples/distributor/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 <stdint.h>
  35 #include <inttypes.h>
  36 #include <unistd.h>
  37 #include <signal.h>
  38 #include <getopt.h>
  39
  40 #include <rte_eal.h>
  41 #include <rte_ethdev.h>
  42 #include <rte_cycles.h>
  43 #include <rte_malloc.h>
  44 #include <rte_debug.h>
  45 #include <rte_prefetch.h>
  46 #include <rte_distributor.h>
  47
  48 #define RX_RING_SIZE 256
  49 #define TX_RING_SIZE 512
  50 #define NUM_MBUFS ((64*1024)-1)
  51 #define MBUF_CACHE_SIZE 250
  52 #define BURST_SIZE 32
  53 #define RTE_RING_SZ 1024
  54
  55 #define RTE_LOGTYPE_DISTRAPP RTE_LOGTYPE_USER1
  56
  57 /* mask of enabled ports */
  58 static uint32_t enabled_port_mask;
  59 volatile uint8_t quit_signal;
  60 volatile uint8_t quit_signal_rx;
  61
  62 static volatile struct app_stats {
  63         struct {
  64                 uint64_t rx_pkts;
  65                 uint64_t returned_pkts;
  66                 uint64_t enqueued_pkts;
  67         } rx __rte_cache_aligned;
  68
  69         struct {
  70                 uint64_t dequeue_pkts;
  71                 uint64_t tx_pkts;
  72         } tx __rte_cache_aligned;
  73 } app_stats;
  74
  75 static const struct rte_eth_conf port_conf_default = {
  76         .rxmode = {
  77                 .mq_mode = ETH_MQ_RX_RSS,
  78                 .max_rx_pkt_len = ETHER_MAX_LEN,
  79         },
  80         .txmode = {
  81                 .mq_mode = ETH_MQ_TX_NONE,
  82         },
  83         .rx_adv_conf = {
  84                 .rss_conf = {
  85                         .rss_hf = ETH_RSS_IP | ETH_RSS_UDP |
  86                                 ETH_RSS_TCP | ETH_RSS_SCTP,
  87                 }
  88         },
  89 };
  90
  91 struct output_buffer {
  92         unsigned count;
  93         struct rte_mbuf *mbufs[BURST_SIZE];
  94 };
  95
  96 /*
  97  * Initialises a given port using global settings and with the rx buffers
  98  * coming from the mbuf_pool passed as parameter
  99  */
 100 static inline int
 101 port_init(uint8_t port, struct rte_mempool *mbuf_pool)
 102 {
 103         struct rte_eth_conf port_conf = port_conf_default;
 104         const uint16_t rxRings = 1, txRings = rte_lcore_count() - 1;
 105         int retval;
 106         uint16_t q;
 107
 108         if (port >= rte_eth_dev_count())
 109                 return -1;
 110
 111         retval = rte_eth_dev_configure(port, rxRings, txRings, &port_conf);
 112         if (retval != 0)
 113                 return retval;
 114
 115         for (q = 0; q < rxRings; q++) {
 116                 retval = rte_eth_rx_queue_setup(port, q, RX_RING_SIZE,
 117                                                 rte_eth_dev_socket_id(port),
 118                                                 NULL, mbuf_pool);
 119                 if (retval < 0)
 120                         return retval;
 121         }
 122
 123         for (q = 0; q < txRings; q++) {
 124                 retval = rte_eth_tx_queue_setup(port, q, TX_RING_SIZE,
 125                                                 rte_eth_dev_socket_id(port),
 126                                                 NULL);
 127                 if (retval < 0)
 128                         return retval;
 129         }
 130
 131         retval = rte_eth_dev_start(port);
 132         if (retval < 0)
 133                 return retval;
 134
 135         struct rte_eth_link link;
 136         rte_eth_link_get_nowait(port, &link);
 137         if (!link.link_status) {
 138                 sleep(1);
 139                 rte_eth_link_get_nowait(port, &link);
 140         }
 141
 142         if (!link.link_status) {
 143                 printf("Link down on port %"PRIu8"\n", port);
 144                 return 0;
 145         }
 146
 147         struct ether_addr addr;
 148         rte_eth_macaddr_get(port, &addr);
 149         printf("Port %u MAC: %02"PRIx8" %02"PRIx8" %02"PRIx8
 150                         " %02"PRIx8" %02"PRIx8" %02"PRIx8"\n",
 151                         (unsigned)port,
 152                         addr.addr_bytes[0], addr.addr_bytes[1],
 153                         addr.addr_bytes[2], addr.addr_bytes[3],
 154                         addr.addr_bytes[4], addr.addr_bytes[5]);
 155
 156         rte_eth_promiscuous_enable(port);
 157
 158         return 0;
 159 }
 160
 161 struct lcore_params {
 162         unsigned worker_id;
 163         struct rte_distributor *d;
 164         struct rte_ring *r;
 165         struct rte_mempool *mem_pool;
 166 };
 167
 168 static int
 169 quit_workers(struct rte_distributor *d, struct rte_mempool *p)
 170 {
 171         const unsigned num_workers = rte_lcore_count() - 2;
 172         unsigned i;
 173         struct rte_mbuf *bufs[num_workers];
 174
 175         if (rte_mempool_get_bulk(p, (void *)bufs, num_workers) != 0) {
 176                 printf("line %d: Error getting mbufs from pool\n", __LINE__);
 177                 return -1;
 178         }
 179
 180         for (i = 0; i < num_workers; i++)
 181                 bufs[i]->hash.rss = i << 1;
 182
 183         rte_distributor_process(d, bufs, num_workers);
 184         rte_mempool_put_bulk(p, (void *)bufs, num_workers);
 185
 186         return 0;
 187 }
 188
 189 static int
 190 lcore_rx(struct lcore_params *p)
 191 {
 192         struct rte_distributor *d = p->d;
 193         struct rte_mempool *mem_pool = p->mem_pool;
 194         struct rte_ring *r = p->r;
 195         const uint8_t nb_ports = rte_eth_dev_count();
 196         const int socket_id = rte_socket_id();
 197         uint8_t port;
 198
 199         for (port = 0; port < nb_ports; port++) {
 200                 /* skip ports that are not enabled */
 201                 if ((enabled_port_mask & (1 << port)) == 0)
 202                         continue;
 203
 204                 if (rte_eth_dev_socket_id(port) > 0 &&
 205                                 rte_eth_dev_socket_id(port) != socket_id)
 206                         printf("WARNING, port %u is on remote NUMA node to "
 207                                         "RX thread.\n\tPerformance will not "
 208                                         "be optimal.\n", port);
 209         }
 210
 211         printf("\nCore %u doing packet RX.\n", rte_lcore_id());
 212         port = 0;
 213         while (!quit_signal_rx) {
 214
 215                 /* skip ports that are not enabled */
 216                 if ((enabled_port_mask & (1 << port)) == 0) {
 217                         if (++port == nb_ports)
 218                                 port = 0;
 219                         continue;
 220                 }
 221                 struct rte_mbuf *bufs[BURST_SIZE*2];
 222                 const uint16_t nb_rx = rte_eth_rx_burst(port, 0, bufs,
 223                                 BURST_SIZE);
 224                 app_stats.rx.rx_pkts += nb_rx;
 225
 226                 rte_distributor_process(d, bufs, nb_rx);
 227                 const uint16_t nb_ret = rte_distributor_returned_pkts(d,
 228                                 bufs, BURST_SIZE*2);
 229                 app_stats.rx.returned_pkts += nb_ret;
 230                 if (unlikely(nb_ret == 0))
 231                         continue;
 232
 233                 uint16_t sent = rte_ring_enqueue_burst(r, (void *)bufs, nb_ret);
 234                 app_stats.rx.enqueued_pkts += sent;
 235                 if (unlikely(sent < nb_ret)) {
 236                         RTE_LOG(DEBUG, DISTRAPP,
 237                                 "%s:Packet loss due to full ring\n", __func__);
 238                         while (sent < nb_ret)
 239                                 rte_pktmbuf_free(bufs[sent++]);
 240                 }
 241                 if (++port == nb_ports)
 242                         port = 0;
 243         }
 244         rte_distributor_process(d, NULL, 0);
 245         /* flush distributor to bring to known state */
 246         rte_distributor_flush(d);
 247         /* set worker & tx threads quit flag */
 248         quit_signal = 1;
 249         /*
 250          * worker threads may hang in get packet as
 251          * distributor process is not running, just make sure workers
 252          * get packets till quit_signal is actually been
 253          * received and they gracefully shutdown
 254          */
 255         if (quit_workers(d, mem_pool) != 0)
 256                 return -1;
 257         /* rx thread should quit at last */
 258         return 0;
 259 }
 260
 261 static inline void
 262 flush_one_port(struct output_buffer *outbuf, uint8_t outp)
 263 {
 264         unsigned nb_tx = rte_eth_tx_burst(outp, 0, outbuf->mbufs,
 265                         outbuf->count);
 266         app_stats.tx.tx_pkts += nb_tx;
 267
 268         if (unlikely(nb_tx < outbuf->count)) {
 269                 RTE_LOG(DEBUG, DISTRAPP,
 270                         "%s:Packet loss with tx_burst\n", __func__);
 271                 do {
 272                         rte_pktmbuf_free(outbuf->mbufs[nb_tx]);
 273                 } while (++nb_tx < outbuf->count);
 274         }
 275         outbuf->count = 0;
 276 }
 277
 278 static inline void
 279 flush_all_ports(struct output_buffer *tx_buffers, uint8_t nb_ports)
 280 {
 281         uint8_t outp;
 282         for (outp = 0; outp < nb_ports; outp++) {
 283                 /* skip ports that are not enabled */
 284                 if ((enabled_port_mask & (1 << outp)) == 0)
 285                         continue;
 286
 287                 if (tx_buffers[outp].count == 0)
 288                         continue;
 289
 290                 flush_one_port(&tx_buffers[outp], outp);
 291         }
 292 }
 293
 294 static int
 295 lcore_tx(struct rte_ring *in_r)
 296 {
 297         static struct output_buffer tx_buffers[RTE_MAX_ETHPORTS];
 298         const uint8_t nb_ports = rte_eth_dev_count();
 299         const int socket_id = rte_socket_id();
 300         uint8_t port;
 301
 302         for (port = 0; port < nb_ports; port++) {
 303                 /* skip ports that are not enabled */
 304                 if ((enabled_port_mask & (1 << port)) == 0)
 305                         continue;
 306
 307                 if (rte_eth_dev_socket_id(port) > 0 &&
 308                                 rte_eth_dev_socket_id(port) != socket_id)
 309                         printf("WARNING, port %u is on remote NUMA node to "
 310                                         "TX thread.\n\tPerformance will not "
 311                                         "be optimal.\n", port);
 312         }
 313
 314         printf("\nCore %u doing packet TX.\n", rte_lcore_id());
 315         while (!quit_signal) {
 316
 317                 for (port = 0; port < nb_ports; port++) {
 318                         /* skip ports that are not enabled */
 319                         if ((enabled_port_mask & (1 << port)) == 0)
 320                                 continue;
 321
 322                         struct rte_mbuf *bufs[BURST_SIZE];
 323                         const uint16_t nb_rx = rte_ring_dequeue_burst(in_r,
 324                                         (void *)bufs, BURST_SIZE);
 325                         app_stats.tx.dequeue_pkts += nb_rx;
 326
 327                         /* if we get no traffic, flush anything we have */
 328                         if (unlikely(nb_rx == 0)) {
 329                                 flush_all_ports(tx_buffers, nb_ports);
 330                                 continue;
 331                         }
 332
 333                         /* for traffic we receive, queue it up for transmit */
 334                         uint16_t i;
 335                         rte_prefetch_non_temporal((void *)bufs[0]);
 336                         rte_prefetch_non_temporal((void *)bufs[1]);
 337                         rte_prefetch_non_temporal((void *)bufs[2]);
 338                         for (i = 0; i < nb_rx; i++) {
 339                                 struct output_buffer *outbuf;
 340                                 uint8_t outp;
 341                                 rte_prefetch_non_temporal((void *)bufs[i + 3]);
 342                                 /*
 343                                  * workers should update in_port to hold the
 344                                  * output port value
 345                                  */
 346                                 outp = bufs[i]->port;
 347                                 /* skip ports that are not enabled */
 348                                 if ((enabled_port_mask & (1 << outp)) == 0)
 349                                         continue;
 350
 351                                 outbuf = &tx_buffers[outp];
 352                                 outbuf->mbufs[outbuf->count++] = bufs[i];
 353                                 if (outbuf->count == BURST_SIZE)
 354                                         flush_one_port(outbuf, outp);
 355                         }
 356                 }
 357         }
 358         return 0;
 359 }
 360
 361 static void
 362 int_handler(int sig_num)
 363 {
 364         printf("Exiting on signal %d\n", sig_num);
 365         /* set quit flag for rx thread to exit */
 366         quit_signal_rx = 1;
 367 }
 368
 369 static void
 370 print_stats(void)
 371 {
 372         struct rte_eth_stats eth_stats;
 373         unsigned i;
 374
 375         printf("\nRX thread stats:\n");
 376         printf(" - Received:    %"PRIu64"\n", app_stats.rx.rx_pkts);
 377         printf(" - Processed:   %"PRIu64"\n", app_stats.rx.returned_pkts);
 378         printf(" - Enqueued:    %"PRIu64"\n", app_stats.rx.enqueued_pkts);
 379
 380         printf("\nTX thread stats:\n");
 381         printf(" - Dequeued:    %"PRIu64"\n", app_stats.tx.dequeue_pkts);
 382         printf(" - Transmitted: %"PRIu64"\n", app_stats.tx.tx_pkts);
 383
 384         for (i = 0; i < rte_eth_dev_count(); i++) {
 385                 rte_eth_stats_get(i, &eth_stats);
 386                 printf("\nPort %u stats:\n", i);
 387                 printf(" - Pkts in:   %"PRIu64"\n", eth_stats.ipackets);
 388                 printf(" - Pkts out:  %"PRIu64"\n", eth_stats.opackets);
 389                 printf(" - In Errs:   %"PRIu64"\n", eth_stats.ierrors);
 390                 printf(" - Out Errs:  %"PRIu64"\n", eth_stats.oerrors);
 391                 printf(" - Mbuf Errs: %"PRIu64"\n", eth_stats.rx_nombuf);
 392         }
 393 }
 394
 395 static int
 396 lcore_worker(struct lcore_params *p)
 397 {
 398         struct rte_distributor *d = p->d;
 399         const unsigned id = p->worker_id;
 400         /*
 401          * for single port, xor_val will be zero so we won't modify the output
 402          * port, otherwise we send traffic from 0 to 1, 2 to 3, and vice versa
 403          */
 404         const unsigned xor_val = (rte_eth_dev_count() > 1);
 405         struct rte_mbuf *buf = NULL;
 406
 407         printf("\nCore %u acting as worker core.\n", rte_lcore_id());
 408         while (!quit_signal) {
 409                 buf = rte_distributor_get_pkt(d, id, buf);
 410                 buf->port ^= xor_val;
 411         }
 412         return 0;
 413 }
 414
 415 /* display usage */
 416 static void
 417 print_usage(const char *prgname)
 418 {
 419         printf("%s [EAL options] -- -p PORTMASK\n"
 420                         "  -p PORTMASK: hexadecimal bitmask of ports to configure\n",
 421                         prgname);
 422 }
 423
 424 static int
 425 parse_portmask(const char *portmask)
 426 {
 427         char *end = NULL;
 428         unsigned long pm;
 429
 430         /* parse hexadecimal string */
 431         pm = strtoul(portmask, &end, 16);
 432         if ((portmask[0] == '\0') || (end == NULL) || (*end != '\0'))
 433                 return -1;
 434
 435         if (pm == 0)
 436                 return -1;
 437
 438         return pm;
 439 }
 440
 441 /* Parse the argument given in the command line of the application */
 442 static int
 443 parse_args(int argc, char **argv)
 444 {
 445         int opt;
 446         char **argvopt;
 447         int option_index;
 448         char *prgname = argv[0];
 449         static struct option lgopts[] = {
 450                 {NULL, 0, 0, 0}
 451         };
 452
 453         argvopt = argv;
 454
 455         while ((opt = getopt_long(argc, argvopt, "p:",
 456                         lgopts, &option_index)) != EOF) {
 457
 458                 switch (opt) {
 459                 /* portmask */
 460                 case 'p':
 461                         enabled_port_mask = parse_portmask(optarg);
 462                         if (enabled_port_mask == 0) {
 463                                 printf("invalid portmask\n");
 464                                 print_usage(prgname);
 465                                 return -1;
 466                         }
 467                         break;
 468
 469                 default:
 470                         print_usage(prgname);
 471                         return -1;
 472                 }
 473         }
 474
 475         if (optind <= 1) {
 476                 print_usage(prgname);
 477                 return -1;
 478         }
 479
 480         argv[optind-1] = prgname;
 481
 482         optind = 0; /* reset getopt lib */
 483         return 0;
 484 }
 485
 486 /* Main function, does initialization and calls the per-lcore functions */
 487 int
 488 main(int argc, char *argv[])
 489 {
 490         struct rte_mempool *mbuf_pool;
 491         struct rte_distributor *d;
 492         struct rte_ring *output_ring;
 493         unsigned lcore_id, worker_id = 0;
 494         unsigned nb_ports;
 495         uint8_t portid;
 496         uint8_t nb_ports_available;
 497
 498         /* catch ctrl-c so we can print on exit */
 499         signal(SIGINT, int_handler);
 500
 501         /* init EAL */
 502         int ret = rte_eal_init(argc, argv);
 503         if (ret < 0)
 504                 rte_exit(EXIT_FAILURE, "Error with EAL initialization\n");
 505         argc -= ret;
 506         argv += ret;
 507
 508         /* parse application arguments (after the EAL ones) */
 509         ret = parse_args(argc, argv);
 510         if (ret < 0)
 511                 rte_exit(EXIT_FAILURE, "Invalid distributor parameters\n");
 512
 513         if (rte_lcore_count() < 3)
 514                 rte_exit(EXIT_FAILURE, "Error, This application needs at "
 515                                 "least 3 logical cores to run:\n"
 516                                 "1 lcore for packet RX and distribution\n"
 517                                 "1 lcore for packet TX\n"
 518                                 "and at least 1 lcore for worker threads\n");
 519
 520         nb_ports = rte_eth_dev_count();
 521         if (nb_ports == 0)
 522                 rte_exit(EXIT_FAILURE, "Error: no ethernet ports detected\n");
 523         if (nb_ports != 1 && (nb_ports & 1))
 524                 rte_exit(EXIT_FAILURE, "Error: number of ports must be even, except "
 525                                 "when using a single port\n");
 526
 527         mbuf_pool = rte_pktmbuf_pool_create("MBUF_POOL",
 528                 NUM_MBUFS * nb_ports, MBUF_CACHE_SIZE, 0,
 529                 RTE_MBUF_DEFAULT_BUF_SIZE, rte_socket_id());
 530         if (mbuf_pool == NULL)
 531                 rte_exit(EXIT_FAILURE, "Cannot create mbuf pool\n");
 532         nb_ports_available = nb_ports;
 533
 534         /* initialize all ports */
 535         for (portid = 0; portid < nb_ports; portid++) {
 536                 /* skip ports that are not enabled */
 537                 if ((enabled_port_mask & (1 << portid)) == 0) {
 538                         printf("\nSkipping disabled port %d\n", portid);
 539                         nb_ports_available--;
 540                         continue;
 541                 }
 542                 /* init port */
 543                 printf("Initializing port %u... done\n", (unsigned) portid);
 544
 545                 if (port_init(portid, mbuf_pool) != 0)
 546                         rte_exit(EXIT_FAILURE, "Cannot initialize port %"PRIu8"\n",
 547                                         portid);
 548         }
 549
 550         if (!nb_ports_available) {
 551                 rte_exit(EXIT_FAILURE,
 552                                 "All available ports are disabled. Please set portmask.\n");
 553         }
 554
 555         d = rte_distributor_create("PKT_DIST", rte_socket_id(),
 556                         rte_lcore_count() - 2);
 557         if (d == NULL)
 558                 rte_exit(EXIT_FAILURE, "Cannot create distributor\n");
 559
 560         /*
 561          * scheduler ring is read only by the transmitter core, but written to
 562          * by multiple threads
 563          */
 564         output_ring = rte_ring_create("Output_ring", RTE_RING_SZ,
 565                         rte_socket_id(), RING_F_SC_DEQ);
 566         if (output_ring == NULL)
 567                 rte_exit(EXIT_FAILURE, "Cannot create output ring\n");
 568
 569         RTE_LCORE_FOREACH_SLAVE(lcore_id) {
 570                 if (worker_id == rte_lcore_count() - 2)
 571                         rte_eal_remote_launch((lcore_function_t *)lcore_tx,
 572                                         output_ring, lcore_id);
 573                 else {
 574                         struct lcore_params *p =
 575                                         rte_malloc(NULL, sizeof(*p), 0);
 576                         if (!p)
 577                                 rte_panic("malloc failure\n");
 578                         *p = (struct lcore_params){worker_id, d, output_ring, mbuf_pool};
 579
 580                         rte_eal_remote_launch((lcore_function_t *)lcore_worker,
 581                                         p, lcore_id);
 582                 }
 583                 worker_id++;
 584         }
 585         /* call lcore_main on master core only */
 586         struct lcore_params p = { 0, d, output_ring, mbuf_pool};
 587
 588         if (lcore_rx(&p) != 0)
 589                 return -1;
 590
 591         RTE_LCORE_FOREACH_SLAVE(lcore_id) {
 592                 if (rte_eal_wait_lcore(lcore_id) < 0)
 593                         return -1;
 594         }
 595
 596         print_stats();
 597         return 0;
 598 }