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, 0700);
 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, 0700);
 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_SOCKET_LIMIT"      Limit memory allocation on sockets (comma separated values)\n"
 409                "  --"OPT_HUGE_DIR"          Directory where hugetlbfs is mounted\n"
 410                "  --"OPT_FILE_PREFIX"       Prefix for hugepage filenames\n"
 411                "  --"OPT_BASE_VIRTADDR"     Base virtual address\n"
 412                "  --"OPT_CREATE_UIO_DEV"    Create /dev/uioX (usually done by hotplug)\n"
 413                "  --"OPT_VFIO_INTR"         Interrupt mode for VFIO (legacy|msi|msix)\n"
 414                "  --"OPT_LEGACY_MEM"        Legacy memory mode (no dynamic allocation, contiguous segments)\n"
 415                "  --"OPT_SINGLE_FILE_SEGMENTS" Put all hugepage memory in single files\n"
 416                "\n");
 417         /* Allow the application to print its usage message too if hook is set */
 418         if ( rte_application_usage_hook ) {
 419                 printf("===== Application Usage =====\n\n");
 420                 rte_application_usage_hook(prgname);
 421         }
 422 }
 423
 424 /* Set a per-application usage message */
 425 rte_usage_hook_t
 426 rte_set_application_usage_hook( rte_usage_hook_t usage_func )
 427 {
 428         rte_usage_hook_t        old_func;
 429
 430         /* Will be NULL on the first call to denote the last usage routine. */
 431         old_func                                        = rte_application_usage_hook;
 432         rte_application_usage_hook      = usage_func;
 433
 434         return old_func;
 435 }
 436
 437 static int
 438 eal_parse_socket_arg(char *strval, volatile uint64_t *socket_arg)
 439 {
 440         char * arg[RTE_MAX_NUMA_NODES];
 441         char *end;
 442         int arg_num, i, len;
 443         uint64_t total_mem = 0;
 444
 445         len = strnlen(strval, SOCKET_MEM_STRLEN);
 446         if (len == SOCKET_MEM_STRLEN) {
 447                 RTE_LOG(ERR, EAL, "--socket-mem is too long\n");
 448                 return -1;
 449         }
 450
 451         /* all other error cases will be caught later */
 452         if (!isdigit(strval[len-1]))
 453                 return -1;
 454
 455         /* split the optarg into separate socket values */
 456         arg_num = rte_strsplit(strval, len,
 457                         arg, RTE_MAX_NUMA_NODES, ',');
 458
 459         /* if split failed, or 0 arguments */
 460         if (arg_num <= 0)
 461                 return -1;
 462
 463         /* parse each defined socket option */
 464         errno = 0;
 465         for (i = 0; i < arg_num; i++) {
 466                 uint64_t val;
 467                 end = NULL;
 468                 val = 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                 val <<= 20;
 475                 total_mem += val;
 476                 socket_arg[i] = val;
 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_arg(optarg,
 625                                         internal_config.socket_mem) < 0) {
 626                                 RTE_LOG(ERR, EAL, "invalid parameters for --"
 627                                                 OPT_SOCKET_MEM "\n");
 628                                 eal_usage(prgname);
 629                                 ret = -1;
 630                                 goto out;
 631                         }
 632                         internal_config.force_sockets = 1;
 633                         break;
 634
 635                 case OPT_SOCKET_LIMIT_NUM:
 636                         if (eal_parse_socket_arg(optarg,
 637                                         internal_config.socket_limit) < 0) {
 638                                 RTE_LOG(ERR, EAL, "invalid parameters for --"
 639                                                 OPT_SOCKET_LIMIT "\n");
 640                                 eal_usage(prgname);
 641                                 ret = -1;
 642                                 goto out;
 643                         }
 644                         internal_config.force_socket_limits = 1;
 645                         break;
 646
 647                 case OPT_BASE_VIRTADDR_NUM:
 648                         if (eal_parse_base_virtaddr(optarg) < 0) {
 649                                 RTE_LOG(ERR, EAL, "invalid parameter for --"
 650                                                 OPT_BASE_VIRTADDR "\n");
 651                                 eal_usage(prgname);
 652                                 ret = -1;
 653                                 goto out;
 654                         }
 655                         break;
 656
 657                 case OPT_VFIO_INTR_NUM:
 658                         if (eal_parse_vfio_intr(optarg) < 0) {
 659                                 RTE_LOG(ERR, EAL, "invalid parameters for --"
 660                                                 OPT_VFIO_INTR "\n");
 661                                 eal_usage(prgname);
 662                                 ret = -1;
 663                                 goto out;
 664                         }
 665                         break;
 666
 667                 case OPT_CREATE_UIO_DEV_NUM:
 668                         internal_config.create_uio_dev = 1;
 669                         break;
 670
 671                 case OPT_MBUF_POOL_OPS_NAME_NUM:
 672                         internal_config.user_mbuf_pool_ops_name =
 673                             strdup(optarg);
 674                         break;
 675
 676                 default:
 677                         if (opt < OPT_LONG_MIN_NUM && isprint(opt)) {
 678                                 RTE_LOG(ERR, EAL, "Option %c is not supported "
 679                                         "on Linux\n", opt);
 680                         } else if (opt >= OPT_LONG_MIN_NUM &&
 681                                    opt < OPT_LONG_MAX_NUM) {
 682                                 RTE_LOG(ERR, EAL, "Option %s is not supported "
 683                                         "on Linux\n",
 684                                         eal_long_options[option_index].name);
 685                         } else {
 686                                 RTE_LOG(ERR, EAL, "Option %d is not supported "
 687                                         "on Linux\n", opt);
 688                         }
 689                         eal_usage(prgname);
 690                         ret = -1;
 691                         goto out;
 692                 }
 693         }
 694
 695         if (eal_adjust_config(&internal_config) != 0) {
 696                 ret = -1;
 697                 goto out;
 698         }
 699
 700         /* sanity checks */
 701         if (eal_check_common_options(&internal_config) != 0) {
 702                 eal_usage(prgname);
 703                 ret = -1;
 704                 goto out;
 705         }
 706
 707         if (optind >= 0)
 708                 argv[optind-1] = prgname;
 709         ret = optind-1;
 710
 711 out:
 712         /* restore getopt lib */
 713         optind = old_optind;
 714         optopt = old_optopt;
 715         optarg = old_optarg;
 716
 717         return ret;
 718 }
 719
 720 static int
 721 check_socket(const struct rte_memseg_list *msl, void *arg)
 722 {
 723         int *socket_id = arg;
 724
 725         return *socket_id == msl->socket_id;
 726 }
 727
 728 static void
 729 eal_check_mem_on_local_socket(void)
 730 {
 731         int socket_id;
 732
 733         socket_id = rte_lcore_to_socket_id(rte_config.master_lcore);
 734
 735         if (rte_memseg_list_walk(check_socket, &socket_id) == 0)
 736                 RTE_LOG(WARNING, EAL, "WARNING: Master core has no memory on local socket!\n");
 737 }
 738
 739 static int
 740 sync_func(__attribute__((unused)) void *arg)
 741 {
 742         return 0;
 743 }
 744
 745 inline static void
 746 rte_eal_mcfg_complete(void)
 747 {
 748         /* ALL shared mem_config related INIT DONE */
 749         if (rte_config.process_type == RTE_PROC_PRIMARY)
 750                 rte_config.mem_config->magic = RTE_MAGIC;
 751
 752         internal_config.init_complete = 1;
 753 }
 754
 755 /*
 756  * Request iopl privilege for all RPL, returns 0 on success
 757  * iopl() call is mostly for the i386 architecture. For other architectures,
 758  * return -1 to indicate IO privilege can't be changed in this way.
 759  */
 760 int
 761 rte_eal_iopl_init(void)
 762 {
 763 #if defined(RTE_ARCH_X86)
 764         if (iopl(3) != 0)
 765                 return -1;
 766 #endif
 767         return 0;
 768 }
 769
 770 #ifdef VFIO_PRESENT
 771 static int rte_eal_vfio_setup(void)
 772 {
 773         if (rte_vfio_enable("vfio"))
 774                 return -1;
 775
 776         return 0;
 777 }
 778 #endif
 779
 780 static void rte_eal_init_alert(const char *msg)
 781 {
 782         fprintf(stderr, "EAL: FATAL: %s\n", msg);
 783         RTE_LOG(ERR, EAL, "%s\n", msg);
 784 }
 785
 786 /* Launch threads, called at application init(). */
 787 int
 788 rte_eal_init(int argc, char **argv)
 789 {
 790         int i, fctret, ret;
 791         pthread_t thread_id;
 792         static rte_atomic32_t run_once = RTE_ATOMIC32_INIT(0);
 793         const char *logid;
 794         char cpuset[RTE_CPU_AFFINITY_STR_LEN];
 795         char thread_name[RTE_MAX_THREAD_NAME_LEN];
 796
 797         /* checks if the machine is adequate */
 798         if (!rte_cpu_is_supported()) {
 799                 rte_eal_init_alert("unsupported cpu type.");
 800                 rte_errno = ENOTSUP;
 801                 return -1;
 802         }
 803
 804         if (!rte_atomic32_test_and_set(&run_once)) {
 805                 rte_eal_init_alert("already called initialization.");
 806                 rte_errno = EALREADY;
 807                 return -1;
 808         }
 809
 810         logid = strrchr(argv[0], '/');
 811         logid = strdup(logid ? logid + 1: argv[0]);
 812
 813         thread_id = pthread_self();
 814
 815         eal_reset_internal_config(&internal_config);
 816
 817         /* set log level as early as possible */
 818         eal_log_level_parse(argc, argv);
 819
 820         if (rte_eal_cpu_init() < 0) {
 821                 rte_eal_init_alert("Cannot detect lcores.");
 822                 rte_errno = ENOTSUP;
 823                 return -1;
 824         }
 825
 826         fctret = eal_parse_args(argc, argv);
 827         if (fctret < 0) {
 828                 rte_eal_init_alert("Invalid 'command line' arguments.");
 829                 rte_errno = EINVAL;
 830                 rte_atomic32_clear(&run_once);
 831                 return -1;
 832         }
 833
 834         /* create runtime data directory */
 835         if (internal_config.no_shconf == 0 &&
 836                         eal_create_runtime_dir() < 0) {
 837                 rte_eal_init_alert("Cannot create runtime directory\n");
 838                 rte_errno = EACCES;
 839                 return -1;
 840         }
 841
 842         if (eal_plugins_init() < 0) {
 843                 rte_eal_init_alert("Cannot init plugins\n");
 844                 rte_errno = EINVAL;
 845                 rte_atomic32_clear(&run_once);
 846                 return -1;
 847         }
 848
 849         if (eal_option_device_parse()) {
 850                 rte_errno = ENODEV;
 851                 rte_atomic32_clear(&run_once);
 852                 return -1;
 853         }
 854
 855         rte_config_init();
 856
 857         if (rte_eal_intr_init() < 0) {
 858                 rte_eal_init_alert("Cannot init interrupt-handling thread\n");
 859                 return -1;
 860         }
 861
 862         /* Put mp channel init before bus scan so that we can init the vdev
 863          * bus through mp channel in the secondary process before the bus scan.
 864          */
 865         if (rte_mp_channel_init() < 0) {
 866                 rte_eal_init_alert("failed to init mp channel\n");
 867                 if (rte_eal_process_type() == RTE_PROC_PRIMARY) {
 868                         rte_errno = EFAULT;
 869                         return -1;
 870                 }
 871         }
 872
 873         if (rte_bus_scan()) {
 874                 rte_eal_init_alert("Cannot scan the buses for devices\n");
 875                 rte_errno = ENODEV;
 876                 rte_atomic32_clear(&run_once);
 877                 return -1;
 878         }
 879
 880         /* autodetect the iova mapping mode (default is iova_pa) */
 881         rte_eal_get_configuration()->iova_mode = rte_bus_get_iommu_class();
 882
 883         /* Workaround for KNI which requires physical address to work */
 884         if (rte_eal_get_configuration()->iova_mode == RTE_IOVA_VA &&
 885                         rte_eal_check_module("rte_kni") == 1) {
 886                 rte_eal_get_configuration()->iova_mode = RTE_IOVA_PA;
 887                 RTE_LOG(WARNING, EAL,
 888                         "Some devices want IOVA as VA but PA will be used because.. "
 889                         "KNI module inserted\n");
 890         }
 891
 892         if (internal_config.no_hugetlbfs == 0) {
 893                 /* rte_config isn't initialized yet */
 894                 ret = internal_config.process_type == RTE_PROC_PRIMARY ?
 895                                 eal_hugepage_info_init() :
 896                                 eal_hugepage_info_read();
 897                 if (ret < 0) {
 898                         rte_eal_init_alert("Cannot get hugepage information.");
 899                         rte_errno = EACCES;
 900                         rte_atomic32_clear(&run_once);
 901                         return -1;
 902                 }
 903         }
 904
 905         if (internal_config.memory == 0 && internal_config.force_sockets == 0) {
 906                 if (internal_config.no_hugetlbfs)
 907                         internal_config.memory = MEMSIZE_IF_NO_HUGE_PAGE;
 908         }
 909
 910         if (internal_config.vmware_tsc_map == 1) {
 911 #ifdef RTE_LIBRTE_EAL_VMWARE_TSC_MAP_SUPPORT
 912                 rte_cycles_vmware_tsc_map = 1;
 913                 RTE_LOG (DEBUG, EAL, "Using VMWARE TSC MAP, "
 914                                 "you must have monitor_control.pseudo_perfctr = TRUE\n");
 915 #else
 916                 RTE_LOG (WARNING, EAL, "Ignoring --vmware-tsc-map because "
 917                                 "RTE_LIBRTE_EAL_VMWARE_TSC_MAP_SUPPORT is not set\n");
 918 #endif
 919         }
 920
 921         rte_srand(rte_rdtsc());
 922
 923         if (rte_eal_log_init(logid, internal_config.syslog_facility) < 0) {
 924                 rte_eal_init_alert("Cannot init logging.");
 925                 rte_errno = ENOMEM;
 926                 rte_atomic32_clear(&run_once);
 927                 return -1;
 928         }
 929
 930 #ifdef VFIO_PRESENT
 931         if (rte_eal_vfio_setup() < 0) {
 932                 rte_eal_init_alert("Cannot init VFIO\n");
 933                 rte_errno = EAGAIN;
 934                 rte_atomic32_clear(&run_once);
 935                 return -1;
 936         }
 937 #endif
 938         /* in secondary processes, memory init may allocate additional fbarrays
 939          * not present in primary processes, so to avoid any potential issues,
 940          * initialize memzones first.
 941          */
 942         if (rte_eal_memzone_init() < 0) {
 943                 rte_eal_init_alert("Cannot init memzone\n");
 944                 rte_errno = ENODEV;
 945                 return -1;
 946         }
 947
 948         if (rte_eal_memory_init() < 0) {
 949                 rte_eal_init_alert("Cannot init memory\n");
 950                 rte_errno = ENOMEM;
 951                 return -1;
 952         }
 953
 954         /* the directories are locked during eal_hugepage_info_init */
 955         eal_hugedirs_unlock();
 956
 957         if (rte_eal_malloc_heap_init() < 0) {
 958                 rte_eal_init_alert("Cannot init malloc heap\n");
 959                 rte_errno = ENODEV;
 960                 return -1;
 961         }
 962
 963         if (rte_eal_tailqs_init() < 0) {
 964                 rte_eal_init_alert("Cannot init tail queues for objects\n");
 965                 rte_errno = EFAULT;
 966                 return -1;
 967         }
 968
 969         if (rte_eal_alarm_init() < 0) {
 970                 rte_eal_init_alert("Cannot init interrupt-handling thread\n");
 971                 /* rte_eal_alarm_init sets rte_errno on failure. */
 972                 return -1;
 973         }
 974
 975         if (rte_eal_timer_init() < 0) {
 976                 rte_eal_init_alert("Cannot init HPET or TSC timers\n");
 977                 rte_errno = ENOTSUP;
 978                 return -1;
 979         }
 980
 981         eal_check_mem_on_local_socket();
 982
 983         eal_thread_init_master(rte_config.master_lcore);
 984
 985         ret = eal_thread_dump_affinity(cpuset, sizeof(cpuset));
 986
 987         RTE_LOG(DEBUG, EAL, "Master lcore %u is ready (tid=%x;cpuset=[%s%s])\n",
 988                 rte_config.master_lcore, (int)thread_id, cpuset,
 989                 ret == 0 ? "" : "...");
 990
 991         RTE_LCORE_FOREACH_SLAVE(i) {
 992
 993                 /*
 994                  * create communication pipes between master thread
 995                  * and children
 996                  */
 997                 if (pipe(lcore_config[i].pipe_master2slave) < 0)
 998                         rte_panic("Cannot create pipe\n");
 999                 if (pipe(lcore_config[i].pipe_slave2master) < 0)
1000                         rte_panic("Cannot create pipe\n");
1001
1002                 lcore_config[i].state = WAIT;
1003
1004                 /* create a thread for each lcore */
1005                 ret = pthread_create(&lcore_config[i].thread_id, NULL,
1006                                      eal_thread_loop, NULL);
1007                 if (ret != 0)
1008                         rte_panic("Cannot create thread\n");
1009
1010                 /* Set thread_name for aid in debugging. */
1011                 snprintf(thread_name, sizeof(thread_name),
1012                         "lcore-slave-%d", i);
1013                 ret = rte_thread_setname(lcore_config[i].thread_id,
1014                                                 thread_name);
1015                 if (ret != 0)
1016                         RTE_LOG(DEBUG, EAL,
1017                                 "Cannot set name for lcore thread\n");
1018         }
1019
1020         /*
1021          * Launch a dummy function on all slave lcores, so that master lcore
1022          * knows they are all ready when this function returns.
1023          */
1024         rte_eal_mp_remote_launch(sync_func, NULL, SKIP_MASTER);
1025         rte_eal_mp_wait_lcore();
1026
1027         /* initialize services so vdevs register service during bus_probe. */
1028         ret = rte_service_init();
1029         if (ret) {
1030                 rte_eal_init_alert("rte_service_init() failed\n");
1031                 rte_errno = ENOEXEC;
1032                 return -1;
1033         }
1034
1035         /* Probe all the buses and devices/drivers on them */
1036         if (rte_bus_probe()) {
1037                 rte_eal_init_alert("Cannot probe devices\n");
1038                 rte_errno = ENOTSUP;
1039                 return -1;
1040         }
1041
1042 #ifdef VFIO_PRESENT
1043         /* Register mp action after probe() so that we got enough info */
1044         if (rte_vfio_is_enabled("vfio") && vfio_mp_sync_setup() < 0)
1045                 return -1;
1046 #endif
1047
1048         /* initialize default service/lcore mappings and start running. Ignore
1049          * -ENOTSUP, as it indicates no service coremask passed to EAL.
1050          */
1051         ret = rte_service_start_with_defaults();
1052         if (ret < 0 && ret != -ENOTSUP) {
1053                 rte_errno = ENOEXEC;
1054                 return -1;
1055         }
1056
1057         rte_eal_mcfg_complete();
1058
1059         return fctret;
1060 }
1061
1062 static int
1063 mark_freeable(const struct rte_memseg_list *msl, const struct rte_memseg *ms,
1064                 void *arg __rte_unused)
1065 {
1066         /* ms is const, so find this memseg */
1067         struct rte_memseg *found = rte_mem_virt2memseg(ms->addr, msl);
1068
1069         found->flags &= ~RTE_MEMSEG_FLAG_DO_NOT_FREE;
1070
1071         return 0;
1072 }
1073
1074 int __rte_experimental
1075 rte_eal_cleanup(void)
1076 {
1077         /* if we're in a primary process, we need to mark hugepages as freeable
1078          * so that finalization can release them back to the system.
1079          */
1080         if (rte_eal_process_type() == RTE_PROC_PRIMARY)
1081                 rte_memseg_walk(mark_freeable, NULL);
1082         rte_service_finalize();
1083         return 0;
1084 }
1085
1086 /* get core role */
1087 enum rte_lcore_role_t
1088 rte_eal_lcore_role(unsigned lcore_id)
1089 {
1090         return rte_config.lcore_role[lcore_id];
1091 }
1092
1093 enum rte_proc_type_t
1094 rte_eal_process_type(void)
1095 {
1096         return rte_config.process_type;
1097 }
1098
1099 int rte_eal_has_hugepages(void)
1100 {
1101         return ! internal_config.no_hugetlbfs;
1102 }
1103
1104 int rte_eal_has_pci(void)
1105 {
1106         return !internal_config.no_pci;
1107 }
1108
1109 int rte_eal_create_uio_dev(void)
1110 {
1111         return internal_config.create_uio_dev;
1112 }
1113
1114 enum rte_intr_mode
1115 rte_eal_vfio_intr_mode(void)
1116 {
1117         return internal_config.vfio_intr_mode;
1118 }
1119
1120 int
1121 rte_eal_check_module(const char *module_name)
1122 {
1123         char sysfs_mod_name[PATH_MAX];
1124         struct stat st;
1125         int n;
1126
1127         if (NULL == module_name)
1128                 return -1;
1129
1130         /* Check if there is sysfs mounted */
1131         if (stat("/sys/module", &st) != 0) {
1132                 RTE_LOG(DEBUG, EAL, "sysfs is not mounted! error %i (%s)\n",
1133                         errno, strerror(errno));
1134                 return -1;
1135         }
1136
1137         /* A module might be built-in, therefore try sysfs */
1138         n = snprintf(sysfs_mod_name, PATH_MAX, "/sys/module/%s", module_name);
1139         if (n < 0 || n > PATH_MAX) {
1140                 RTE_LOG(DEBUG, EAL, "Could not format module path\n");
1141                 return -1;
1142         }
1143
1144         if (stat(sysfs_mod_name, &st) != 0) {
1145                 RTE_LOG(DEBUG, EAL, "Module %s not found! error %i (%s)\n",
1146                         sysfs_mod_name, errno, strerror(errno));
1147                 return 0;
1148         }
1149
1150         /* Module has been found */
1151         return 1;
1152 }