lib/librte_eal/linuxapp/eal/eal.c

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2010-2016 Intel Corporation. All rights reserved.
   5  *   Copyright(c) 2012-2014 6WIND S.A.
   6  *   All rights reserved.
   7  *
   8  *   Redistribution and use in source and binary forms, with or without
   9  *   modification, are permitted provided that the following conditions
  10  *   are met:
  11  *
  12  *     * Redistributions of source code must retain the above copyright
  13  *       notice, this list of conditions and the following disclaimer.
  14  *     * Redistributions in binary form must reproduce the above copyright
  15  *       notice, this list of conditions and the following disclaimer in
  16  *       the documentation and/or other materials provided with the
  17  *       distribution.
  18  *     * Neither the name of Intel Corporation nor the names of its
  19  *       contributors may be used to endorse or promote products derived
  20  *       from this software without specific prior written permission.
  21  *
  22  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  23  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  24  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  25  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  26  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  27  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  28  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  29  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  30  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  31  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  32  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  33  */
  34
  35 #include <stdio.h>
  36 #include <stdlib.h>
  37 #include <stdint.h>
  38 #include <string.h>
  39 #include <stdarg.h>
  40 #include <unistd.h>
  41 #include <pthread.h>
  42 #include <syslog.h>
  43 #include <getopt.h>
  44 #include <sys/file.h>
  45 #include <fcntl.h>
  46 #include <stddef.h>
  47 #include <errno.h>
  48 #include <limits.h>
  49 #include <sys/mman.h>
  50 #include <sys/queue.h>
  51 #include <sys/stat.h>
  52 #if defined(RTE_ARCH_X86)
  53 #include <sys/io.h>
  54 #endif
  55
  56 #include <rte_common.h>
  57 #include <rte_debug.h>
  58 #include <rte_memory.h>
  59 #include <rte_memzone.h>
  60 #include <rte_launch.h>
  61 #include <rte_eal.h>
  62 #include <rte_eal_memconfig.h>
  63 #include <rte_errno.h>
  64 #include <rte_per_lcore.h>
  65 #include <rte_lcore.h>
  66 #include <rte_service_component.h>
  67 #include <rte_log.h>
  68 #include <rte_random.h>
  69 #include <rte_cycles.h>
  70 #include <rte_string_fns.h>
  71 #include <rte_cpuflags.h>
  72 #include <rte_interrupts.h>
  73 #include <rte_bus.h>
  74 #include <rte_pci.h>
  75 #include <rte_dev.h>
  76 #include <rte_devargs.h>
  77 #include <rte_version.h>
  78 #include <rte_atomic.h>
  79 #include <malloc_heap.h>
  80
  81 #include "eal_private.h"
  82 #include "eal_thread.h"
  83 #include "eal_internal_cfg.h"
  84 #include "eal_filesystem.h"
  85 #include "eal_hugepages.h"
  86 #include "eal_options.h"
  87 #include "eal_vfio.h"
  88
  89 #define MEMSIZE_IF_NO_HUGE_PAGE (64ULL * 1024ULL * 1024ULL)
  90
  91 #define SOCKET_MEM_STRLEN (RTE_MAX_NUMA_NODES * 10)
  92
  93 /* Allow the application to print its usage message too if set */
  94 static rte_usage_hook_t rte_application_usage_hook = NULL;
  95
  96 /* early configuration structure, when memory config is not mmapped */
  97 static struct rte_mem_config early_mem_config;
  98
  99 /* define fd variable here, because file needs to be kept open for the
 100  * duration of the program, as we hold a write lock on it in the primary proc */
 101 static int mem_cfg_fd = -1;
 102
 103 static struct flock wr_lock = {
 104                 .l_type = F_WRLCK,
 105                 .l_whence = SEEK_SET,
 106                 .l_start = offsetof(struct rte_mem_config, memseg),
 107                 .l_len = sizeof(early_mem_config.memseg),
 108 };
 109
 110 /* Address of global and public configuration */
 111 static struct rte_config rte_config = {
 112                 .mem_config = &early_mem_config,
 113 };
 114
 115 /* internal configuration (per-core) */
 116 struct lcore_config lcore_config[RTE_MAX_LCORE];
 117
 118 /* internal configuration */
 119 struct internal_config internal_config;
 120
 121 /* used by rte_rdtsc() */
 122 int rte_cycles_vmware_tsc_map;
 123
 124 /* Return mbuf pool ops name */
 125 const char *
 126 rte_eal_mbuf_default_mempool_ops(void)
 127 {
 128         return internal_config.mbuf_pool_ops_name;
 129 }
 130
 131 /* Return a pointer to the configuration structure */
 132 struct rte_config *
 133 rte_eal_get_configuration(void)
 134 {
 135         return &rte_config;
 136 }
 137
 138 enum rte_iova_mode
 139 rte_eal_iova_mode(void)
 140 {
 141         return rte_eal_get_configuration()->iova_mode;
 142 }
 143
 144 /* parse a sysfs (or other) file containing one integer value */
 145 int
 146 eal_parse_sysfs_value(const char *filename, unsigned long *val)
 147 {
 148         FILE *f;
 149         char buf[BUFSIZ];
 150         char *end = NULL;
 151
 152         if ((f = fopen(filename, "r")) == NULL) {
 153                 RTE_LOG(ERR, EAL, "%s(): cannot open sysfs value %s\n",
 154                         __func__, filename);
 155                 return -1;
 156         }
 157
 158         if (fgets(buf, sizeof(buf), f) == NULL) {
 159                 RTE_LOG(ERR, EAL, "%s(): cannot read sysfs value %s\n",
 160                         __func__, filename);
 161                 fclose(f);
 162                 return -1;
 163         }
 164         *val = strtoul(buf, &end, 0);
 165         if ((buf[0] == '\0') || (end == NULL) || (*end != '\n')) {
 166                 RTE_LOG(ERR, EAL, "%s(): cannot parse sysfs value %s\n",
 167                                 __func__, filename);
 168                 fclose(f);
 169                 return -1;
 170         }
 171         fclose(f);
 172         return 0;
 173 }
 174
 175
 176 /* create memory configuration in shared/mmap memory. Take out
 177  * a write lock on the memsegs, so we can auto-detect primary/secondary.
 178  * This means we never close the file while running (auto-close on exit).
 179  * We also don't lock the whole file, so that in future we can use read-locks
 180  * on other parts, e.g. memzones, to detect if there are running secondary
 181  * processes. */
 182 static void
 183 rte_eal_config_create(void)
 184 {
 185         void *rte_mem_cfg_addr;
 186         int retval;
 187
 188         const char *pathname = eal_runtime_config_path();
 189
 190         if (internal_config.no_shconf)
 191                 return;
 192
 193         /* map the config before hugepage address so that we don't waste a page */
 194         if (internal_config.base_virtaddr != 0)
 195                 rte_mem_cfg_addr = (void *)
 196                         RTE_ALIGN_FLOOR(internal_config.base_virtaddr -
 197                         sizeof(struct rte_mem_config), sysconf(_SC_PAGE_SIZE));
 198         else
 199                 rte_mem_cfg_addr = NULL;
 200
 201         if (mem_cfg_fd < 0){
 202                 mem_cfg_fd = open(pathname, O_RDWR | O_CREAT, 0660);
 203                 if (mem_cfg_fd < 0)
 204                         rte_panic("Cannot open '%s' for rte_mem_config\n", pathname);
 205         }
 206
 207         retval = ftruncate(mem_cfg_fd, sizeof(*rte_config.mem_config));
 208         if (retval < 0){
 209                 close(mem_cfg_fd);
 210                 rte_panic("Cannot resize '%s' for rte_mem_config\n", pathname);
 211         }
 212
 213         retval = fcntl(mem_cfg_fd, F_SETLK, &wr_lock);
 214         if (retval < 0){
 215                 close(mem_cfg_fd);
 216                 rte_exit(EXIT_FAILURE, "Cannot create lock on '%s'. Is another primary "
 217                                 "process running?\n", pathname);
 218         }
 219
 220         rte_mem_cfg_addr = mmap(rte_mem_cfg_addr, sizeof(*rte_config.mem_config),
 221                                 PROT_READ | PROT_WRITE, MAP_SHARED, mem_cfg_fd, 0);
 222
 223         if (rte_mem_cfg_addr == MAP_FAILED){
 224                 rte_panic("Cannot mmap memory for rte_config\n");
 225         }
 226         memcpy(rte_mem_cfg_addr, &early_mem_config, sizeof(early_mem_config));
 227         rte_config.mem_config = rte_mem_cfg_addr;
 228
 229         /* store address of the config in the config itself so that secondary
 230          * processes could later map the config into this exact location */
 231         rte_config.mem_config->mem_cfg_addr = (uintptr_t) rte_mem_cfg_addr;
 232
 233 }
 234
 235 /* attach to an existing shared memory config */
 236 static void
 237 rte_eal_config_attach(void)
 238 {
 239         struct rte_mem_config *mem_config;
 240
 241         const char *pathname = eal_runtime_config_path();
 242
 243         if (internal_config.no_shconf)
 244                 return;
 245
 246         if (mem_cfg_fd < 0){
 247                 mem_cfg_fd = open(pathname, O_RDWR);
 248                 if (mem_cfg_fd < 0)
 249                         rte_panic("Cannot open '%s' for rte_mem_config\n", pathname);
 250         }
 251
 252         /* map it as read-only first */
 253         mem_config = (struct rte_mem_config *) mmap(NULL, sizeof(*mem_config),
 254                         PROT_READ, MAP_SHARED, mem_cfg_fd, 0);
 255         if (mem_config == MAP_FAILED)
 256                 rte_panic("Cannot mmap memory for rte_config! error %i (%s)\n",
 257                           errno, strerror(errno));
 258
 259         rte_config.mem_config = mem_config;
 260 }
 261
 262 /* reattach the shared config at exact memory location primary process has it */
 263 static void
 264 rte_eal_config_reattach(void)
 265 {
 266         struct rte_mem_config *mem_config;
 267         void *rte_mem_cfg_addr;
 268
 269         if (internal_config.no_shconf)
 270                 return;
 271
 272         /* save the address primary process has mapped shared config to */
 273         rte_mem_cfg_addr = (void *) (uintptr_t) rte_config.mem_config->mem_cfg_addr;
 274
 275         /* unmap original config */
 276         munmap(rte_config.mem_config, sizeof(struct rte_mem_config));
 277
 278         /* remap the config at proper address */
 279         mem_config = (struct rte_mem_config *) mmap(rte_mem_cfg_addr,
 280                         sizeof(*mem_config), PROT_READ | PROT_WRITE, MAP_SHARED,
 281                         mem_cfg_fd, 0);
 282         if (mem_config == MAP_FAILED || mem_config != rte_mem_cfg_addr) {
 283                 if (mem_config != MAP_FAILED)
 284                         /* errno is stale, don't use */
 285                         rte_panic("Cannot mmap memory for rte_config at [%p], got [%p]"
 286                                   " - please use '--base-virtaddr' option\n",
 287                                   rte_mem_cfg_addr, mem_config);
 288                 else
 289                         rte_panic("Cannot mmap memory for rte_config! error %i (%s)\n",
 290                                   errno, strerror(errno));
 291         }
 292         close(mem_cfg_fd);
 293
 294         rte_config.mem_config = mem_config;
 295 }
 296
 297 /* Detect if we are a primary or a secondary process */
 298 enum rte_proc_type_t
 299 eal_proc_type_detect(void)
 300 {
 301         enum rte_proc_type_t ptype = RTE_PROC_PRIMARY;
 302         const char *pathname = eal_runtime_config_path();
 303
 304         /* if we can open the file but not get a write-lock we are a secondary
 305          * process. NOTE: if we get a file handle back, we keep that open
 306          * and don't close it to prevent a race condition between multiple opens */
 307         if (((mem_cfg_fd = open(pathname, O_RDWR)) >= 0) &&
 308                         (fcntl(mem_cfg_fd, F_SETLK, &wr_lock) < 0))
 309                 ptype = RTE_PROC_SECONDARY;
 310
 311         RTE_LOG(INFO, EAL, "Auto-detected process type: %s\n",
 312                         ptype == RTE_PROC_PRIMARY ? "PRIMARY" : "SECONDARY");
 313
 314         return ptype;
 315 }
 316
 317 /* Sets up rte_config structure with the pointer to shared memory config.*/
 318 static void
 319 rte_config_init(void)
 320 {
 321         rte_config.process_type = internal_config.process_type;
 322
 323         switch (rte_config.process_type){
 324         case RTE_PROC_PRIMARY:
 325                 rte_eal_config_create();
 326                 break;
 327         case RTE_PROC_SECONDARY:
 328                 rte_eal_config_attach();
 329                 rte_eal_mcfg_wait_complete(rte_config.mem_config);
 330                 rte_eal_config_reattach();
 331                 break;
 332         case RTE_PROC_AUTO:
 333         case RTE_PROC_INVALID:
 334                 rte_panic("Invalid process type\n");
 335         }
 336 }
 337
 338 /* Unlocks hugepage directories that were locked by eal_hugepage_info_init */
 339 static void
 340 eal_hugedirs_unlock(void)
 341 {
 342         int i;
 343
 344         for (i = 0; i < MAX_HUGEPAGE_SIZES; i++)
 345         {
 346                 /* skip uninitialized */
 347                 if (internal_config.hugepage_info[i].lock_descriptor < 0)
 348                         continue;
 349                 /* unlock hugepage file */
 350                 flock(internal_config.hugepage_info[i].lock_descriptor, LOCK_UN);
 351                 close(internal_config.hugepage_info[i].lock_descriptor);
 352                 /* reset the field */
 353                 internal_config.hugepage_info[i].lock_descriptor = -1;
 354         }
 355 }
 356
 357 /* display usage */
 358 static void
 359 eal_usage(const char *prgname)
 360 {
 361         printf("\nUsage: %s ", prgname);
 362         eal_common_usage();
 363         printf("EAL Linux options:\n"
 364                "  --"OPT_SOCKET_MEM"        Memory to allocate on sockets (comma separated values)\n"
 365                "  --"OPT_HUGE_DIR"          Directory where hugetlbfs is mounted\n"
 366                "  --"OPT_FILE_PREFIX"       Prefix for hugepage filenames\n"
 367                "  --"OPT_BASE_VIRTADDR"     Base virtual address\n"
 368                "  --"OPT_CREATE_UIO_DEV"    Create /dev/uioX (usually done by hotplug)\n"
 369                "  --"OPT_VFIO_INTR"         Interrupt mode for VFIO (legacy|msi|msix)\n"
 370                "  --"OPT_XEN_DOM0"          Support running on Xen dom0 without hugetlbfs\n"
 371                "\n");
 372         /* Allow the application to print its usage message too if hook is set */
 373         if ( rte_application_usage_hook ) {
 374                 printf("===== Application Usage =====\n\n");
 375                 rte_application_usage_hook(prgname);
 376         }
 377 }
 378
 379 /* Set a per-application usage message */
 380 rte_usage_hook_t
 381 rte_set_application_usage_hook( rte_usage_hook_t usage_func )
 382 {
 383         rte_usage_hook_t        old_func;
 384
 385         /* Will be NULL on the first call to denote the last usage routine. */
 386         old_func                                        = rte_application_usage_hook;
 387         rte_application_usage_hook      = usage_func;
 388
 389         return old_func;
 390 }
 391
 392 static int
 393 eal_parse_socket_mem(char *socket_mem)
 394 {
 395         char * arg[RTE_MAX_NUMA_NODES];
 396         char *end;
 397         int arg_num, i, len;
 398         uint64_t total_mem = 0;
 399
 400         len = strnlen(socket_mem, SOCKET_MEM_STRLEN);
 401         if (len == SOCKET_MEM_STRLEN) {
 402                 RTE_LOG(ERR, EAL, "--socket-mem is too long\n");
 403                 return -1;
 404         }
 405
 406         /* all other error cases will be caught later */
 407         if (!isdigit(socket_mem[len-1]))
 408                 return -1;
 409
 410         /* split the optarg into separate socket values */
 411         arg_num = rte_strsplit(socket_mem, len,
 412                         arg, RTE_MAX_NUMA_NODES, ',');
 413
 414         /* if split failed, or 0 arguments */
 415         if (arg_num <= 0)
 416                 return -1;
 417
 418         internal_config.force_sockets = 1;
 419
 420         /* parse each defined socket option */
 421         errno = 0;
 422         for (i = 0; i < arg_num; i++) {
 423                 end = NULL;
 424                 internal_config.socket_mem[i] = strtoull(arg[i], &end, 10);
 425
 426                 /* check for invalid input */
 427                 if ((errno != 0)  ||
 428                                 (arg[i][0] == '\0') || (end == NULL) || (*end != '\0'))
 429                         return -1;
 430                 internal_config.socket_mem[i] *= 1024ULL;
 431                 internal_config.socket_mem[i] *= 1024ULL;
 432                 total_mem += internal_config.socket_mem[i];
 433         }
 434
 435         /* check if we have a positive amount of total memory */
 436         if (total_mem == 0)
 437                 return -1;
 438
 439         return 0;
 440 }
 441
 442 static int
 443 eal_parse_base_virtaddr(const char *arg)
 444 {
 445         char *end;
 446         uint64_t addr;
 447
 448         errno = 0;
 449         addr = strtoull(arg, &end, 16);
 450
 451         /* check for errors */
 452         if ((errno != 0) || (arg[0] == '\0') || end == NULL || (*end != '\0'))
 453                 return -1;
 454
 455         /* make sure we don't exceed 32-bit boundary on 32-bit target */
 456 #ifndef RTE_ARCH_64
 457         if (addr >= UINTPTR_MAX)
 458                 return -1;
 459 #endif
 460
 461         /* align the addr on 16M boundary, 16MB is the minimum huge page
 462          * size on IBM Power architecture. If the addr is aligned to 16MB,
 463          * it can align to 2MB for x86. So this alignment can also be used
 464          * on x86 */
 465         internal_config.base_virtaddr =
 466                 RTE_PTR_ALIGN_CEIL((uintptr_t)addr, (size_t)RTE_PGSIZE_16M);
 467
 468         return 0;
 469 }
 470
 471 static int
 472 eal_parse_vfio_intr(const char *mode)
 473 {
 474         unsigned i;
 475         static struct {
 476                 const char *name;
 477                 enum rte_intr_mode value;
 478         } map[] = {
 479                 { "legacy", RTE_INTR_MODE_LEGACY },
 480                 { "msi", RTE_INTR_MODE_MSI },
 481                 { "msix", RTE_INTR_MODE_MSIX },
 482         };
 483
 484         for (i = 0; i < RTE_DIM(map); i++) {
 485                 if (!strcmp(mode, map[i].name)) {
 486                         internal_config.vfio_intr_mode = map[i].value;
 487                         return 0;
 488                 }
 489         }
 490         return -1;
 491 }
 492
 493 /* Parse the arguments for --log-level only */
 494 static void
 495 eal_log_level_parse(int argc, char **argv)
 496 {
 497         int opt;
 498         char **argvopt;
 499         int option_index;
 500         const int old_optind = optind;
 501         const int old_optopt = optopt;
 502         char * const old_optarg = optarg;
 503
 504         argvopt = argv;
 505         optind = 1;
 506
 507         while ((opt = getopt_long(argc, argvopt, eal_short_options,
 508                                   eal_long_options, &option_index)) != EOF) {
 509
 510                 int ret;
 511
 512                 /* getopt is not happy, stop right now */
 513                 if (opt == '?')
 514                         break;
 515
 516                 ret = (opt == OPT_LOG_LEVEL_NUM) ?
 517                         eal_parse_common_option(opt, optarg, &internal_config) : 0;
 518
 519                 /* common parser is not happy */
 520                 if (ret < 0)
 521                         break;
 522         }
 523
 524         /* restore getopt lib */
 525         optind = old_optind;
 526         optopt = old_optopt;
 527         optarg = old_optarg;
 528 }
 529
 530 /* Parse the argument given in the command line of the application */
 531 static int
 532 eal_parse_args(int argc, char **argv)
 533 {
 534         int opt, ret;
 535         char **argvopt;
 536         int option_index;
 537         char *prgname = argv[0];
 538         const int old_optind = optind;
 539         const int old_optopt = optopt;
 540         char * const old_optarg = optarg;
 541
 542         argvopt = argv;
 543         optind = 1;
 544
 545         while ((opt = getopt_long(argc, argvopt, eal_short_options,
 546                                   eal_long_options, &option_index)) != EOF) {
 547
 548                 /* getopt is not happy, stop right now */
 549                 if (opt == '?') {
 550                         eal_usage(prgname);
 551                         ret = -1;
 552                         goto out;
 553                 }
 554
 555                 ret = eal_parse_common_option(opt, optarg, &internal_config);
 556                 /* common parser is not happy */
 557                 if (ret < 0) {
 558                         eal_usage(prgname);
 559                         ret = -1;
 560                         goto out;
 561                 }
 562                 /* common parser handled this option */
 563                 if (ret == 0)
 564                         continue;
 565
 566                 switch (opt) {
 567                 case 'h':
 568                         eal_usage(prgname);
 569                         exit(EXIT_SUCCESS);
 570
 571                 /* long options */
 572                 case OPT_XEN_DOM0_NUM:
 573 #ifdef RTE_LIBRTE_XEN_DOM0
 574                         internal_config.xen_dom0_support = 1;
 575 #else
 576                         RTE_LOG(ERR, EAL, "Can't support DPDK app "
 577                                 "running on Dom0, please configure"
 578                                 " RTE_LIBRTE_XEN_DOM0=y\n");
 579                         ret = -1;
 580                         goto out;
 581 #endif
 582                         break;
 583
 584                 case OPT_HUGE_DIR_NUM:
 585                         internal_config.hugepage_dir = optarg;
 586                         break;
 587
 588                 case OPT_FILE_PREFIX_NUM:
 589                         internal_config.hugefile_prefix = optarg;
 590                         break;
 591
 592                 case OPT_SOCKET_MEM_NUM:
 593                         if (eal_parse_socket_mem(optarg) < 0) {
 594                                 RTE_LOG(ERR, EAL, "invalid parameters for --"
 595                                                 OPT_SOCKET_MEM "\n");
 596                                 eal_usage(prgname);
 597                                 ret = -1;
 598                                 goto out;
 599                         }
 600                         break;
 601
 602                 case OPT_BASE_VIRTADDR_NUM:
 603                         if (eal_parse_base_virtaddr(optarg) < 0) {
 604                                 RTE_LOG(ERR, EAL, "invalid parameter for --"
 605                                                 OPT_BASE_VIRTADDR "\n");
 606                                 eal_usage(prgname);
 607                                 ret = -1;
 608                                 goto out;
 609                         }
 610                         break;
 611
 612                 case OPT_VFIO_INTR_NUM:
 613                         if (eal_parse_vfio_intr(optarg) < 0) {
 614                                 RTE_LOG(ERR, EAL, "invalid parameters for --"
 615                                                 OPT_VFIO_INTR "\n");
 616                                 eal_usage(prgname);
 617                                 ret = -1;
 618                                 goto out;
 619                         }
 620                         break;
 621
 622                 case OPT_CREATE_UIO_DEV_NUM:
 623                         internal_config.create_uio_dev = 1;
 624                         break;
 625
 626                 case OPT_MBUF_POOL_OPS_NAME_NUM:
 627                         internal_config.mbuf_pool_ops_name = optarg;
 628                         break;
 629
 630                 default:
 631                         if (opt < OPT_LONG_MIN_NUM && isprint(opt)) {
 632                                 RTE_LOG(ERR, EAL, "Option %c is not supported "
 633                                         "on Linux\n", opt);
 634                         } else if (opt >= OPT_LONG_MIN_NUM &&
 635                                    opt < OPT_LONG_MAX_NUM) {
 636                                 RTE_LOG(ERR, EAL, "Option %s is not supported "
 637                                         "on Linux\n",
 638                                         eal_long_options[option_index].name);
 639                         } else {
 640                                 RTE_LOG(ERR, EAL, "Option %d is not supported "
 641                                         "on Linux\n", opt);
 642                         }
 643                         eal_usage(prgname);
 644                         ret = -1;
 645                         goto out;
 646                 }
 647         }
 648
 649         if (eal_adjust_config(&internal_config) != 0) {
 650                 ret = -1;
 651                 goto out;
 652         }
 653
 654         /* sanity checks */
 655         if (eal_check_common_options(&internal_config) != 0) {
 656                 eal_usage(prgname);
 657                 ret = -1;
 658                 goto out;
 659         }
 660
 661         /* --xen-dom0 doesn't make sense with --socket-mem */
 662         if (internal_config.xen_dom0_support && internal_config.force_sockets == 1) {
 663                 RTE_LOG(ERR, EAL, "Options --"OPT_SOCKET_MEM" cannot be specified "
 664                         "together with --"OPT_XEN_DOM0"\n");
 665                 eal_usage(prgname);
 666                 ret = -1;
 667                 goto out;
 668         }
 669
 670         if (optind >= 0)
 671                 argv[optind-1] = prgname;
 672         ret = optind-1;
 673
 674 out:
 675         /* restore getopt lib */
 676         optind = old_optind;
 677         optopt = old_optopt;
 678         optarg = old_optarg;
 679
 680         return ret;
 681 }
 682
 683 static void
 684 eal_check_mem_on_local_socket(void)
 685 {
 686         const struct rte_memseg *ms;
 687         int i, socket_id;
 688
 689         socket_id = rte_lcore_to_socket_id(rte_config.master_lcore);
 690
 691         ms = rte_eal_get_physmem_layout();
 692
 693         for (i = 0; i < RTE_MAX_MEMSEG; i++)
 694                 if (ms[i].socket_id == socket_id &&
 695                                 ms[i].len > 0)
 696                         return;
 697
 698         RTE_LOG(WARNING, EAL, "WARNING: Master core has no "
 699                         "memory on local socket!\n");
 700 }
 701
 702 static int
 703 sync_func(__attribute__((unused)) void *arg)
 704 {
 705         return 0;
 706 }
 707
 708 inline static void
 709 rte_eal_mcfg_complete(void)
 710 {
 711         /* ALL shared mem_config related INIT DONE */
 712         if (rte_config.process_type == RTE_PROC_PRIMARY)
 713                 rte_config.mem_config->magic = RTE_MAGIC;
 714 }
 715
 716 /*
 717  * Request iopl privilege for all RPL, returns 0 on success
 718  * iopl() call is mostly for the i386 architecture. For other architectures,
 719  * return -1 to indicate IO privilege can't be changed in this way.
 720  */
 721 int
 722 rte_eal_iopl_init(void)
 723 {
 724 #if defined(RTE_ARCH_X86)
 725         if (iopl(3) != 0)
 726                 return -1;
 727 #endif
 728         return 0;
 729 }
 730
 731 #ifdef VFIO_PRESENT
 732 static int rte_eal_vfio_setup(void)
 733 {
 734         int vfio_enabled = 0;
 735
 736         if (!internal_config.no_pci) {
 737                 pci_vfio_enable();
 738                 vfio_enabled |= pci_vfio_is_enabled();
 739         }
 740
 741         if (vfio_enabled) {
 742
 743                 /* if we are primary process, create a thread to communicate with
 744                  * secondary processes. the thread will use a socket to wait for
 745                  * requests from secondary process to send open file descriptors,
 746                  * because VFIO does not allow multiple open descriptors on a group or
 747                  * VFIO container.
 748                  */
 749                 if (internal_config.process_type == RTE_PROC_PRIMARY &&
 750                                 vfio_mp_sync_setup() < 0)
 751                         return -1;
 752         }
 753
 754         return 0;
 755 }
 756 #endif
 757
 758 static void rte_eal_init_alert(const char *msg)
 759 {
 760         fprintf(stderr, "EAL: FATAL: %s\n", msg);
 761         RTE_LOG(ERR, EAL, "%s\n", msg);
 762 }
 763
 764 /* Launch threads, called at application init(). */
 765 int
 766 rte_eal_init(int argc, char **argv)
 767 {
 768         int i, fctret, ret;
 769         pthread_t thread_id;
 770         static rte_atomic32_t run_once = RTE_ATOMIC32_INIT(0);
 771         const char *logid;
 772         char cpuset[RTE_CPU_AFFINITY_STR_LEN];
 773         char thread_name[RTE_MAX_THREAD_NAME_LEN];
 774
 775         /* checks if the machine is adequate */
 776         if (!rte_cpu_is_supported()) {
 777                 rte_eal_init_alert("unsupported cpu type.");
 778                 rte_errno = ENOTSUP;
 779                 return -1;
 780         }
 781
 782         if (!rte_atomic32_test_and_set(&run_once)) {
 783                 rte_eal_init_alert("already called initialization.");
 784                 rte_errno = EALREADY;
 785                 return -1;
 786         }
 787
 788         logid = strrchr(argv[0], '/');
 789         logid = strdup(logid ? logid + 1: argv[0]);
 790
 791         thread_id = pthread_self();
 792
 793         eal_reset_internal_config(&internal_config);
 794
 795         /* set log level as early as possible */
 796         eal_log_level_parse(argc, argv);
 797
 798         if (rte_eal_cpu_init() < 0) {
 799                 rte_eal_init_alert("Cannot detect lcores.");
 800                 rte_errno = ENOTSUP;
 801                 return -1;
 802         }
 803
 804         fctret = eal_parse_args(argc, argv);
 805         if (fctret < 0) {
 806                 rte_eal_init_alert("Invalid 'command line' arguments.");
 807                 rte_errno = EINVAL;
 808                 rte_atomic32_clear(&run_once);
 809                 return -1;
 810         }
 811
 812         if (eal_option_device_parse()) {
 813                 rte_errno = ENODEV;
 814                 rte_atomic32_clear(&run_once);
 815                 return -1;
 816         }
 817
 818         if (rte_bus_scan()) {
 819                 rte_eal_init_alert("Cannot scan the buses for devices\n");
 820                 rte_errno = ENODEV;
 821                 rte_atomic32_clear(&run_once);
 822                 return -1;
 823         }
 824
 825         /* autodetect the iova mapping mode (default is iova_pa) */
 826         rte_eal_get_configuration()->iova_mode = rte_bus_get_iommu_class();
 827
 828         if (internal_config.no_hugetlbfs == 0 &&
 829                         internal_config.process_type != RTE_PROC_SECONDARY &&
 830                         internal_config.xen_dom0_support == 0 &&
 831                         eal_hugepage_info_init() < 0) {
 832                 rte_eal_init_alert("Cannot get hugepage information.");
 833                 rte_errno = EACCES;
 834                 rte_atomic32_clear(&run_once);
 835                 return -1;
 836         }
 837
 838         if (internal_config.memory == 0 && internal_config.force_sockets == 0) {
 839                 if (internal_config.no_hugetlbfs)
 840                         internal_config.memory = MEMSIZE_IF_NO_HUGE_PAGE;
 841         }
 842
 843         if (internal_config.vmware_tsc_map == 1) {
 844 #ifdef RTE_LIBRTE_EAL_VMWARE_TSC_MAP_SUPPORT
 845                 rte_cycles_vmware_tsc_map = 1;
 846                 RTE_LOG (DEBUG, EAL, "Using VMWARE TSC MAP, "
 847                                 "you must have monitor_control.pseudo_perfctr = TRUE\n");
 848 #else
 849                 RTE_LOG (WARNING, EAL, "Ignoring --vmware-tsc-map because "
 850                                 "RTE_LIBRTE_EAL_VMWARE_TSC_MAP_SUPPORT is not set\n");
 851 #endif
 852         }
 853
 854         rte_srand(rte_rdtsc());
 855
 856         rte_config_init();
 857
 858         if (rte_eal_log_init(logid, internal_config.syslog_facility) < 0) {
 859                 rte_eal_init_alert("Cannot init logging.");
 860                 rte_errno = ENOMEM;
 861                 rte_atomic32_clear(&run_once);
 862                 return -1;
 863         }
 864
 865 #ifdef VFIO_PRESENT
 866         if (rte_eal_vfio_setup() < 0) {
 867                 rte_eal_init_alert("Cannot init VFIO\n");
 868                 rte_errno = EAGAIN;
 869                 rte_atomic32_clear(&run_once);
 870                 return -1;
 871         }
 872 #endif
 873
 874         if (rte_eal_memory_init() < 0) {
 875                 rte_eal_init_alert("Cannot init memory\n");
 876                 rte_errno = ENOMEM;
 877                 return -1;
 878         }
 879
 880         /* the directories are locked during eal_hugepage_info_init */
 881         eal_hugedirs_unlock();
 882
 883         if (rte_eal_memzone_init() < 0) {
 884                 rte_eal_init_alert("Cannot init memzone\n");
 885                 rte_errno = ENODEV;
 886                 return -1;
 887         }
 888
 889         if (rte_eal_tailqs_init() < 0) {
 890                 rte_eal_init_alert("Cannot init tail queues for objects\n");
 891                 rte_errno = EFAULT;
 892                 return -1;
 893         }
 894
 895         if (rte_eal_alarm_init() < 0) {
 896                 rte_eal_init_alert("Cannot init interrupt-handling thread\n");
 897                 /* rte_eal_alarm_init sets rte_errno on failure. */
 898                 return -1;
 899         }
 900
 901         if (rte_eal_timer_init() < 0) {
 902                 rte_eal_init_alert("Cannot init HPET or TSC timers\n");
 903                 rte_errno = ENOTSUP;
 904                 return -1;
 905         }
 906
 907         eal_check_mem_on_local_socket();
 908
 909         if (eal_plugins_init() < 0)
 910                 rte_eal_init_alert("Cannot init plugins\n");
 911
 912         eal_thread_init_master(rte_config.master_lcore);
 913
 914         ret = eal_thread_dump_affinity(cpuset, RTE_CPU_AFFINITY_STR_LEN);
 915
 916         RTE_LOG(DEBUG, EAL, "Master lcore %u is ready (tid=%x;cpuset=[%s%s])\n",
 917                 rte_config.master_lcore, (int)thread_id, cpuset,
 918                 ret == 0 ? "" : "...");
 919
 920         if (rte_eal_intr_init() < 0) {
 921                 rte_eal_init_alert("Cannot init interrupt-handling thread\n");
 922                 return -1;
 923         }
 924
 925         RTE_LCORE_FOREACH_SLAVE(i) {
 926
 927                 /*
 928                  * create communication pipes between master thread
 929                  * and children
 930                  */
 931                 if (pipe(lcore_config[i].pipe_master2slave) < 0)
 932                         rte_panic("Cannot create pipe\n");
 933                 if (pipe(lcore_config[i].pipe_slave2master) < 0)
 934                         rte_panic("Cannot create pipe\n");
 935
 936                 lcore_config[i].state = WAIT;
 937
 938                 /* create a thread for each lcore */
 939                 ret = pthread_create(&lcore_config[i].thread_id, NULL,
 940                                      eal_thread_loop, NULL);
 941                 if (ret != 0)
 942                         rte_panic("Cannot create thread\n");
 943
 944                 /* Set thread_name for aid in debugging. */
 945                 snprintf(thread_name, RTE_MAX_THREAD_NAME_LEN,
 946                         "lcore-slave-%d", i);
 947                 ret = rte_thread_setname(lcore_config[i].thread_id,
 948                                                 thread_name);
 949                 if (ret != 0)
 950                         RTE_LOG(DEBUG, EAL,
 951                                 "Cannot set name for lcore thread\n");
 952         }
 953
 954         /*
 955          * Launch a dummy function on all slave lcores, so that master lcore
 956          * knows they are all ready when this function returns.
 957          */
 958         rte_eal_mp_remote_launch(sync_func, NULL, SKIP_MASTER);
 959         rte_eal_mp_wait_lcore();
 960
 961         /* initialize services so vdevs register service during bus_probe. */
 962         ret = rte_service_init();
 963         if (ret) {
 964                 rte_eal_init_alert("rte_service_init() failed\n");
 965                 rte_errno = ENOEXEC;
 966                 return -1;
 967         }
 968
 969         /* Probe all the buses and devices/drivers on them */
 970         if (rte_bus_probe()) {
 971                 rte_eal_init_alert("Cannot probe devices\n");
 972                 rte_errno = ENOTSUP;
 973                 return -1;
 974         }
 975
 976         /* initialize default service/lcore mappings and start running. Ignore
 977          * -ENOTSUP, as it indicates no service coremask passed to EAL.
 978          */
 979         ret = rte_service_start_with_defaults();
 980         if (ret < 0 && ret != -ENOTSUP) {
 981                 rte_errno = ENOEXEC;
 982                 return -1;
 983         }
 984
 985         rte_eal_mcfg_complete();
 986
 987         return fctret;
 988 }
 989
 990 /* get core role */
 991 enum rte_lcore_role_t
 992 rte_eal_lcore_role(unsigned lcore_id)
 993 {
 994         return rte_config.lcore_role[lcore_id];
 995 }
 996
 997 enum rte_proc_type_t
 998 rte_eal_process_type(void)
 999 {
1000         return rte_config.process_type;
1001 }
1002
1003 int rte_eal_has_hugepages(void)
1004 {
1005         return ! internal_config.no_hugetlbfs;
1006 }
1007
1008 int
1009 rte_eal_check_module(const char *module_name)
1010 {
1011         char sysfs_mod_name[PATH_MAX];
1012         struct stat st;
1013         int n;
1014
1015         if (NULL == module_name)
1016                 return -1;
1017
1018         /* Check if there is sysfs mounted */
1019         if (stat("/sys/module", &st) != 0) {
1020                 RTE_LOG(DEBUG, EAL, "sysfs is not mounted! error %i (%s)\n",
1021                         errno, strerror(errno));
1022                 return -1;
1023         }
1024
1025         /* A module might be built-in, therefore try sysfs */
1026         n = snprintf(sysfs_mod_name, PATH_MAX, "/sys/module/%s", module_name);
1027         if (n < 0 || n > PATH_MAX) {
1028                 RTE_LOG(DEBUG, EAL, "Could not format module path\n");
1029                 return -1;
1030         }
1031
1032         if (stat(sysfs_mod_name, &st) != 0) {
1033                 RTE_LOG(DEBUG, EAL, "Module %s not found! error %i (%s)\n",
1034                         sysfs_mod_name, errno, strerror(errno));
1035                 return 0;
1036         }
1037
1038         /* Module has been found */
1039         return 1;
1040 }