lib/librte_eal/linuxapp/eal/eal.c

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