examples/exception_path/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 <stdint.h>
  37 #include <inttypes.h>
  38 #include <string.h>
  39 #include <sys/queue.h>
  40 #include <stdarg.h>
  41 #include <errno.h>
  42 #include <getopt.h>
  43
  44 #include <netinet/in.h>
  45 #include <linux/if.h>
  46 #include <linux/if_tun.h>
  47 #include <fcntl.h>
  48 #include <sys/ioctl.h>
  49 #include <unistd.h>
  50 #include <signal.h>
  51
  52 #include <rte_common.h>
  53 #include <rte_log.h>
  54 #include <rte_memory.h>
  55 #include <rte_memcpy.h>
  56 #include <rte_memzone.h>
  57 #include <rte_eal.h>
  58 #include <rte_per_lcore.h>
  59 #include <rte_launch.h>
  60 #include <rte_atomic.h>
  61 #include <rte_lcore.h>
  62 #include <rte_branch_prediction.h>
  63 #include <rte_interrupts.h>
  64 #include <rte_pci.h>
  65 #include <rte_debug.h>
  66 #include <rte_ether.h>
  67 #include <rte_ethdev.h>
  68 #include <rte_ring.h>
  69 #include <rte_log.h>
  70 #include <rte_mempool.h>
  71 #include <rte_mbuf.h>
  72 #include <rte_string_fns.h>
  73 #include <rte_cycles.h>
  74
  75 /* Macros for printing using RTE_LOG */
  76 #define RTE_LOGTYPE_APP RTE_LOGTYPE_USER1
  77 #define FATAL_ERROR(fmt, args...)       rte_exit(EXIT_FAILURE, fmt "\n", ##args)
  78 #define PRINT_INFO(fmt, args...)        RTE_LOG(INFO, APP, fmt "\n", ##args)
  79
  80 /* Max ports than can be used (each port is associated with two lcores) */
  81 #define MAX_PORTS               (RTE_MAX_LCORE / 2)
  82
  83 /* Max size of a single packet */
  84 #define MAX_PACKET_SZ (2048)
  85
  86 /* Size of the data buffer in each mbuf */
  87 #define MBUF_DATA_SZ (MAX_PACKET_SZ + RTE_PKTMBUF_HEADROOM)
  88
  89 /* Number of mbufs in mempool that is created */
  90 #define NB_MBUF                 8192
  91
  92 /* How many packets to attempt to read from NIC in one go */
  93 #define PKT_BURST_SZ            32
  94
  95 /* How many objects (mbufs) to keep in per-lcore mempool cache */
  96 #define MEMPOOL_CACHE_SZ        PKT_BURST_SZ
  97
  98 /* Number of RX ring descriptors */
  99 #define NB_RXD                  128
 100
 101 /* Number of TX ring descriptors */
 102 #define NB_TXD                  512
 103
 104 /*
 105  * RX and TX Prefetch, Host, and Write-back threshold values should be
 106  * carefully set for optimal performance. Consult the network
 107  * controller's datasheet and supporting DPDK documentation for guidance
 108  * on how these parameters should be set.
 109  */
 110
 111 /* Options for configuring ethernet port */
 112 static const struct rte_eth_conf port_conf = {
 113         .rxmode = {
 114                 .header_split = 0,      /* Header Split disabled */
 115                 .hw_ip_checksum = 0,    /* IP checksum offload disabled */
 116                 .hw_vlan_filter = 0,    /* VLAN filtering disabled */
 117                 .jumbo_frame = 0,       /* Jumbo Frame Support disabled */
 118                 .hw_strip_crc = 0,      /* CRC stripped by hardware */
 119         },
 120         .txmode = {
 121                 .mq_mode = ETH_MQ_TX_NONE,
 122         },
 123 };
 124
 125 /* Mempool for mbufs */
 126 static struct rte_mempool * pktmbuf_pool = NULL;
 127
 128 /* Mask of enabled ports */
 129 static uint32_t ports_mask = 0;
 130
 131 /* Mask of cores that read from NIC and write to tap */
 132 static uint64_t input_cores_mask = 0;
 133
 134 /* Mask of cores that read from tap and write to NIC */
 135 static uint64_t output_cores_mask = 0;
 136
 137 /* Array storing port_id that is associated with each lcore */
 138 static uint8_t port_ids[RTE_MAX_LCORE];
 139
 140 /* Structure type for recording lcore-specific stats */
 141 struct stats {
 142         uint64_t rx;
 143         uint64_t tx;
 144         uint64_t dropped;
 145 };
 146
 147 /* Array of lcore-specific stats */
 148 static struct stats lcore_stats[RTE_MAX_LCORE];
 149
 150 /* Print out statistics on packets handled */
 151 static void
 152 print_stats(void)
 153 {
 154         unsigned i;
 155
 156         printf("\n**Exception-Path example application statistics**\n"
 157                "=======  ======  ============  ============  ===============\n"
 158                " Lcore    Port            RX            TX    Dropped on TX\n"
 159                "-------  ------  ------------  ------------  ---------------\n");
 160         RTE_LCORE_FOREACH(i) {
 161                 printf("%6u %7u %13"PRIu64" %13"PRIu64" %16"PRIu64"\n",
 162                        i, (unsigned)port_ids[i],
 163                        lcore_stats[i].rx, lcore_stats[i].tx,
 164                        lcore_stats[i].dropped);
 165         }
 166         printf("=======  ======  ============  ============  ===============\n");
 167 }
 168
 169 /* Custom handling of signals to handle stats */
 170 static void
 171 signal_handler(int signum)
 172 {
 173         /* When we receive a USR1 signal, print stats */
 174         if (signum == SIGUSR1) {
 175                 print_stats();
 176         }
 177
 178         /* When we receive a USR2 signal, reset stats */
 179         if (signum == SIGUSR2) {
 180                 memset(&lcore_stats, 0, sizeof(lcore_stats));
 181                 printf("\n**Statistics have been reset**\n");
 182                 return;
 183         }
 184 }
 185
 186 /*
 187  * Create a tap network interface, or use existing one with same name.
 188  * If name[0]='\0' then a name is automatically assigned and returned in name.
 189  */
 190 static int tap_create(char *name)
 191 {
 192         struct ifreq ifr;
 193         int fd, ret;
 194
 195         fd = open("/dev/net/tun", O_RDWR);
 196         if (fd < 0)
 197                 return fd;
 198
 199         memset(&ifr, 0, sizeof(ifr));
 200
 201         /* TAP device without packet information */
 202         ifr.ifr_flags = IFF_TAP | IFF_NO_PI;
 203
 204         if (name && *name)
 205                 snprintf(ifr.ifr_name, IFNAMSIZ, "%s", name);
 206
 207         ret = ioctl(fd, TUNSETIFF, (void *) &ifr);
 208         if (ret < 0) {
 209                 close(fd);
 210                 return ret;
 211         }
 212
 213         if (name)
 214                 snprintf(name, IFNAMSIZ, "%s", ifr.ifr_name);
 215
 216         return fd;
 217 }
 218
 219 /* Main processing loop */
 220 static int
 221 main_loop(__attribute__((unused)) void *arg)
 222 {
 223         const unsigned lcore_id = rte_lcore_id();
 224         char tap_name[IFNAMSIZ];
 225         int tap_fd;
 226
 227         if ((1ULL << lcore_id) & input_cores_mask) {
 228                 /* Create new tap interface */
 229                 snprintf(tap_name, IFNAMSIZ, "tap_dpdk_%.2u", lcore_id);
 230                 tap_fd = tap_create(tap_name);
 231                 if (tap_fd < 0)
 232                         FATAL_ERROR("Could not create tap interface \"%s\" (%d)",
 233                                         tap_name, tap_fd);
 234
 235                 PRINT_INFO("Lcore %u is reading from port %u and writing to %s",
 236                            lcore_id, (unsigned)port_ids[lcore_id], tap_name);
 237                 fflush(stdout);
 238                 /* Loop forever reading from NIC and writing to tap */
 239                 for (;;) {
 240                         struct rte_mbuf *pkts_burst[PKT_BURST_SZ];
 241                         unsigned i;
 242                         const unsigned nb_rx =
 243                                         rte_eth_rx_burst(port_ids[lcore_id], 0,
 244                                             pkts_burst, PKT_BURST_SZ);
 245                         lcore_stats[lcore_id].rx += nb_rx;
 246                         for (i = 0; likely(i < nb_rx); i++) {
 247                                 struct rte_mbuf *m = pkts_burst[i];
 248                                 /* Ignore return val from write() */
 249                                 int ret = write(tap_fd,
 250                                                 rte_pktmbuf_mtod(m, void*),
 251                                                 rte_pktmbuf_data_len(m));
 252                                 rte_pktmbuf_free(m);
 253                                 if (unlikely(ret < 0))
 254                                         lcore_stats[lcore_id].dropped++;
 255                                 else
 256                                         lcore_stats[lcore_id].tx++;
 257                         }
 258                 }
 259         }
 260         else if ((1ULL << lcore_id) & output_cores_mask) {
 261                 /* Create new tap interface */
 262                 snprintf(tap_name, IFNAMSIZ, "tap_dpdk_%.2u", lcore_id);
 263                 tap_fd = tap_create(tap_name);
 264                 if (tap_fd < 0)
 265                         FATAL_ERROR("Could not create tap interface \"%s\" (%d)",
 266                                         tap_name, tap_fd);
 267
 268                 PRINT_INFO("Lcore %u is reading from %s and writing to port %u",
 269                            lcore_id, tap_name, (unsigned)port_ids[lcore_id]);
 270                 fflush(stdout);
 271                 /* Loop forever reading from tap and writing to NIC */
 272                 for (;;) {
 273                         int ret;
 274                         struct rte_mbuf *m = rte_pktmbuf_alloc(pktmbuf_pool);
 275                         if (m == NULL)
 276                                 continue;
 277
 278                         ret = read(tap_fd, rte_pktmbuf_mtod(m, void *),
 279                                 MAX_PACKET_SZ);
 280                         lcore_stats[lcore_id].rx++;
 281                         if (unlikely(ret < 0)) {
 282                                 FATAL_ERROR("Reading from %s interface failed",
 283                                             tap_name);
 284                         }
 285                         m->nb_segs = 1;
 286                         m->next = NULL;
 287                         m->pkt_len = (uint16_t)ret;
 288                         m->data_len = (uint16_t)ret;
 289                         ret = rte_eth_tx_burst(port_ids[lcore_id], 0, &m, 1);
 290                         if (unlikely(ret < 1)) {
 291                                 rte_pktmbuf_free(m);
 292                                 lcore_stats[lcore_id].dropped++;
 293                         }
 294                         else {
 295                                 lcore_stats[lcore_id].tx++;
 296                         }
 297                 }
 298         }
 299         else {
 300                 PRINT_INFO("Lcore %u has nothing to do", lcore_id);
 301                 return 0;
 302         }
 303         /*
 304          * Tap file is closed automatically when program exits. Putting close()
 305          * here will cause the compiler to give an error about unreachable code.
 306          */
 307 }
 308
 309 /* Display usage instructions */
 310 static void
 311 print_usage(const char *prgname)
 312 {
 313         PRINT_INFO("\nUsage: %s [EAL options] -- -p PORTMASK -i IN_CORES -o OUT_CORES\n"
 314                    "    -p PORTMASK: hex bitmask of ports to use\n"
 315                    "    -i IN_CORES: hex bitmask of cores which read from NIC\n"
 316                    "    -o OUT_CORES: hex bitmask of cores which write to NIC",
 317                    prgname);
 318 }
 319
 320 /* Convert string to unsigned number. 0 is returned if error occurs */
 321 static uint64_t
 322 parse_unsigned(const char *portmask)
 323 {
 324         char *end = NULL;
 325         uint64_t num;
 326
 327         num = strtoull(portmask, &end, 16);
 328         if ((portmask[0] == '\0') || (end == NULL) || (*end != '\0'))
 329                 return 0;
 330
 331         return (uint64_t)num;
 332 }
 333
 334 /* Record affinities between ports and lcores in global port_ids[] array */
 335 static void
 336 setup_port_lcore_affinities(void)
 337 {
 338         unsigned long i;
 339         uint8_t tx_port = 0;
 340         uint8_t rx_port = 0;
 341
 342         /* Setup port_ids[] array, and check masks were ok */
 343         RTE_LCORE_FOREACH(i) {
 344                 if (input_cores_mask & (1ULL << i)) {
 345                         /* Skip ports that are not enabled */
 346                         while ((ports_mask & (1 << rx_port)) == 0) {
 347                                 rx_port++;
 348                                 if (rx_port > (sizeof(ports_mask) * 8))
 349                                         goto fail; /* not enough ports */
 350                         }
 351
 352                         port_ids[i] = rx_port++;
 353                 }
 354                 else if (output_cores_mask & (1ULL << i)) {
 355                         /* Skip ports that are not enabled */
 356                         while ((ports_mask & (1 << tx_port)) == 0) {
 357                                 tx_port++;
 358                                 if (tx_port > (sizeof(ports_mask) * 8))
 359                                         goto fail; /* not enough ports */
 360                         }
 361
 362                         port_ids[i] = tx_port++;
 363                 }
 364         }
 365
 366         if (rx_port != tx_port)
 367                 goto fail; /* uneven number of cores in masks */
 368
 369         if (ports_mask & (~((1 << rx_port) - 1)))
 370                 goto fail; /* unused ports */
 371
 372         return;
 373 fail:
 374         FATAL_ERROR("Invalid core/port masks specified on command line");
 375 }
 376
 377 /* Parse the arguments given in the command line of the application */
 378 static void
 379 parse_args(int argc, char **argv)
 380 {
 381         int opt;
 382         const char *prgname = argv[0];
 383
 384         /* Disable printing messages within getopt() */
 385         opterr = 0;
 386
 387         /* Parse command line */
 388         while ((opt = getopt(argc, argv, "i:o:p:")) != EOF) {
 389                 switch (opt) {
 390                 case 'i':
 391                         input_cores_mask = parse_unsigned(optarg);
 392                         break;
 393                 case 'o':
 394                         output_cores_mask = parse_unsigned(optarg);
 395                         break;
 396                 case 'p':
 397                         ports_mask = parse_unsigned(optarg);
 398                         break;
 399                 default:
 400                         print_usage(prgname);
 401                         FATAL_ERROR("Invalid option specified");
 402                 }
 403         }
 404
 405         /* Check that options were parsed ok */
 406         if (input_cores_mask == 0) {
 407                 print_usage(prgname);
 408                 FATAL_ERROR("IN_CORES not specified correctly");
 409         }
 410         if (output_cores_mask == 0) {
 411                 print_usage(prgname);
 412                 FATAL_ERROR("OUT_CORES not specified correctly");
 413         }
 414         if (ports_mask == 0) {
 415                 print_usage(prgname);
 416                 FATAL_ERROR("PORTMASK not specified correctly");
 417         }
 418
 419         setup_port_lcore_affinities();
 420 }
 421
 422 /* Initialise a single port on an Ethernet device */
 423 static void
 424 init_port(uint8_t port)
 425 {
 426         int ret;
 427
 428         /* Initialise device and RX/TX queues */
 429         PRINT_INFO("Initialising port %u ...", (unsigned)port);
 430         fflush(stdout);
 431         ret = rte_eth_dev_configure(port, 1, 1, &port_conf);
 432         if (ret < 0)
 433                 FATAL_ERROR("Could not configure port%u (%d)",
 434                             (unsigned)port, ret);
 435
 436         ret = rte_eth_rx_queue_setup(port, 0, NB_RXD, rte_eth_dev_socket_id(port),
 437                                 NULL,
 438                                 pktmbuf_pool);
 439         if (ret < 0)
 440                 FATAL_ERROR("Could not setup up RX queue for port%u (%d)",
 441                             (unsigned)port, ret);
 442
 443         ret = rte_eth_tx_queue_setup(port, 0, NB_TXD, rte_eth_dev_socket_id(port),
 444                                 NULL);
 445         if (ret < 0)
 446                 FATAL_ERROR("Could not setup up TX queue for port%u (%d)",
 447                             (unsigned)port, ret);
 448
 449         ret = rte_eth_dev_start(port);
 450         if (ret < 0)
 451                 FATAL_ERROR("Could not start port%u (%d)", (unsigned)port, ret);
 452
 453         rte_eth_promiscuous_enable(port);
 454 }
 455
 456 /* Check the link status of all ports in up to 9s, and print them finally */
 457 static void
 458 check_all_ports_link_status(uint8_t port_num, uint32_t port_mask)
 459 {
 460 #define CHECK_INTERVAL 100 /* 100ms */
 461 #define MAX_CHECK_TIME 90 /* 9s (90 * 100ms) in total */
 462         uint8_t portid, count, all_ports_up, print_flag = 0;
 463         struct rte_eth_link link;
 464
 465         printf("\nChecking link status");
 466         fflush(stdout);
 467         for (count = 0; count <= MAX_CHECK_TIME; count++) {
 468                 all_ports_up = 1;
 469                 for (portid = 0; portid < port_num; portid++) {
 470                         if ((port_mask & (1 << portid)) == 0)
 471                                 continue;
 472                         memset(&link, 0, sizeof(link));
 473                         rte_eth_link_get_nowait(portid, &link);
 474                         /* print link status if flag set */
 475                         if (print_flag == 1) {
 476                                 if (link.link_status)
 477                                         printf("Port %d Link Up - speed %u "
 478                                                 "Mbps - %s\n", (uint8_t)portid,
 479                                                 (unsigned)link.link_speed,
 480                                 (link.link_duplex == ETH_LINK_FULL_DUPLEX) ?
 481                                         ("full-duplex") : ("half-duplex\n"));
 482                                 else
 483                                         printf("Port %d Link Down\n",
 484                                                 (uint8_t)portid);
 485                                 continue;
 486                         }
 487                         /* clear all_ports_up flag if any link down */
 488                         if (link.link_status == 0) {
 489                                 all_ports_up = 0;
 490                                 break;
 491                         }
 492                 }
 493                 /* after finally printing all link status, get out */
 494                 if (print_flag == 1)
 495                         break;
 496
 497                 if (all_ports_up == 0) {
 498                         printf(".");
 499                         fflush(stdout);
 500                         rte_delay_ms(CHECK_INTERVAL);
 501                 }
 502
 503                 /* set the print_flag if all ports up or timeout */
 504                 if (all_ports_up == 1 || count == (MAX_CHECK_TIME - 1)) {
 505                         print_flag = 1;
 506                         printf("done\n");
 507                 }
 508         }
 509 }
 510
 511 /* Initialise ports/queues etc. and start main loop on each core */
 512 int
 513 main(int argc, char** argv)
 514 {
 515         int ret;
 516         unsigned i,high_port;
 517         uint8_t nb_sys_ports, port;
 518
 519         /* Associate signal_hanlder function with USR signals */
 520         signal(SIGUSR1, signal_handler);
 521         signal(SIGUSR2, signal_handler);
 522
 523         /* Initialise EAL */
 524         ret = rte_eal_init(argc, argv);
 525         if (ret < 0)
 526                 FATAL_ERROR("Could not initialise EAL (%d)", ret);
 527         argc -= ret;
 528         argv += ret;
 529
 530         /* Parse application arguments (after the EAL ones) */
 531         parse_args(argc, argv);
 532
 533         /* Create the mbuf pool */
 534         pktmbuf_pool = rte_pktmbuf_pool_create("mbuf_pool", NB_MBUF,
 535                         MEMPOOL_CACHE_SZ, 0, MBUF_DATA_SZ, rte_socket_id());
 536         if (pktmbuf_pool == NULL) {
 537                 FATAL_ERROR("Could not initialise mbuf pool");
 538                 return -1;
 539         }
 540
 541         /* Get number of ports found in scan */
 542         nb_sys_ports = rte_eth_dev_count();
 543         if (nb_sys_ports == 0)
 544                 FATAL_ERROR("No supported Ethernet device found");
 545         /* Find highest port set in portmask */
 546         for (high_port = (sizeof(ports_mask) * 8) - 1;
 547                         (high_port != 0) && !(ports_mask & (1 << high_port));
 548                         high_port--)
 549                 ; /* empty body */
 550         if (high_port > nb_sys_ports)
 551                 FATAL_ERROR("Port mask requires more ports than available");
 552
 553         /* Initialise each port */
 554         for (port = 0; port < nb_sys_ports; port++) {
 555                 /* Skip ports that are not enabled */
 556                 if ((ports_mask & (1 << port)) == 0) {
 557                         continue;
 558                 }
 559                 init_port(port);
 560         }
 561         check_all_ports_link_status(nb_sys_ports, ports_mask);
 562
 563         /* Launch per-lcore function on every lcore */
 564         rte_eal_mp_remote_launch(main_loop, NULL, CALL_MASTER);
 565         RTE_LCORE_FOREACH_SLAVE(i) {
 566                 if (rte_eal_wait_lcore(i) < 0)
 567                         return -1;
 568         }
 569
 570         return 0;
 571 }