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