lib/librte_eal/bsdapp/eal/eal.c

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
   5  *   Copyright(c) 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 <stddef.h>
  46 #include <errno.h>
  47 #include <limits.h>
  48 #include <errno.h>
  49 #include <sys/mman.h>
  50 #include <sys/queue.h>
  51
  52 #include <rte_common.h>
  53 #include <rte_debug.h>
  54 #include <rte_memory.h>
  55 #include <rte_memzone.h>
  56 #include <rte_launch.h>
  57 #include <rte_eal.h>
  58 #include <rte_eal_memconfig.h>
  59 #include <rte_per_lcore.h>
  60 #include <rte_lcore.h>
  61 #include <rte_log.h>
  62 #include <rte_random.h>
  63 #include <rte_cycles.h>
  64 #include <rte_string_fns.h>
  65 #include <rte_cpuflags.h>
  66 #include <rte_interrupts.h>
  67 #include <rte_pci.h>
  68 #include <rte_dev.h>
  69 #include <rte_devargs.h>
  70 #include <rte_common.h>
  71 #include <rte_version.h>
  72 #include <rte_atomic.h>
  73 #include <malloc_heap.h>
  74 #include <rte_eth_ring.h>
  75
  76 #include "eal_private.h"
  77 #include "eal_thread.h"
  78 #include "eal_internal_cfg.h"
  79 #include "eal_filesystem.h"
  80 #include "eal_hugepages.h"
  81 #include "eal_options.h"
  82
  83 #define MEMSIZE_IF_NO_HUGE_PAGE (64ULL * 1024ULL * 1024ULL)
  84
  85 /* Allow the application to print its usage message too if set */
  86 static rte_usage_hook_t rte_application_usage_hook = NULL;
  87 /* early configuration structure, when memory config is not mmapped */
  88 static struct rte_mem_config early_mem_config;
  89
  90 /* define fd variable here, because file needs to be kept open for the
  91  * duration of the program, as we hold a write lock on it in the primary proc */
  92 static int mem_cfg_fd = -1;
  93
  94 static struct flock wr_lock = {
  95                 .l_type = F_WRLCK,
  96                 .l_whence = SEEK_SET,
  97                 .l_start = offsetof(struct rte_mem_config, memseg),
  98                 .l_len = sizeof(early_mem_config.memseg),
  99 };
 100
 101 /* Address of global and public configuration */
 102 static struct rte_config rte_config = {
 103                 .mem_config = &early_mem_config,
 104 };
 105
 106 /* internal configuration (per-core) */
 107 struct lcore_config lcore_config[RTE_MAX_LCORE];
 108
 109 /* internal configuration */
 110 struct internal_config internal_config;
 111
 112 /* used by rte_rdtsc() */
 113 int rte_cycles_vmware_tsc_map;
 114
 115 /* Return a pointer to the configuration structure */
 116 struct rte_config *
 117 rte_eal_get_configuration(void)
 118 {
 119         return &rte_config;
 120 }
 121
 122 /* parse a sysfs (or other) file containing one integer value */
 123 int
 124 eal_parse_sysfs_value(const char *filename, unsigned long *val)
 125 {
 126         FILE *f;
 127         char buf[BUFSIZ];
 128         char *end = NULL;
 129
 130         if ((f = fopen(filename, "r")) == NULL) {
 131                 RTE_LOG(ERR, EAL, "%s(): cannot open sysfs value %s\n",
 132                         __func__, filename);
 133                 return -1;
 134         }
 135
 136         if (fgets(buf, sizeof(buf), f) == NULL) {
 137                 RTE_LOG(ERR, EAL, "%s(): cannot read sysfs value %s\n",
 138                         __func__, filename);
 139                 fclose(f);
 140                 return -1;
 141         }
 142         *val = strtoul(buf, &end, 0);
 143         if ((buf[0] == '\0') || (end == NULL) || (*end != '\n')) {
 144                 RTE_LOG(ERR, EAL, "%s(): cannot parse sysfs value %s\n",
 145                                 __func__, filename);
 146                 fclose(f);
 147                 return -1;
 148         }
 149         fclose(f);
 150         return 0;
 151 }
 152
 153
 154 /* create memory configuration in shared/mmap memory. Take out
 155  * a write lock on the memsegs, so we can auto-detect primary/secondary.
 156  * This means we never close the file while running (auto-close on exit).
 157  * We also don't lock the whole file, so that in future we can use read-locks
 158  * on other parts, e.g. memzones, to detect if there are running secondary
 159  * processes. */
 160 static void
 161 rte_eal_config_create(void)
 162 {
 163         void *rte_mem_cfg_addr;
 164         int retval;
 165
 166         const char *pathname = eal_runtime_config_path();
 167
 168         if (internal_config.no_shconf)
 169                 return;
 170
 171         if (mem_cfg_fd < 0){
 172                 mem_cfg_fd = open(pathname, O_RDWR | O_CREAT, 0660);
 173                 if (mem_cfg_fd < 0)
 174                         rte_panic("Cannot open '%s' for rte_mem_config\n", pathname);
 175         }
 176
 177         retval = ftruncate(mem_cfg_fd, sizeof(*rte_config.mem_config));
 178         if (retval < 0){
 179                 close(mem_cfg_fd);
 180                 rte_panic("Cannot resize '%s' for rte_mem_config\n", pathname);
 181         }
 182
 183         retval = fcntl(mem_cfg_fd, F_SETLK, &wr_lock);
 184         if (retval < 0){
 185                 close(mem_cfg_fd);
 186                 rte_exit(EXIT_FAILURE, "Cannot create lock on '%s'. Is another primary "
 187                                 "process running?\n", pathname);
 188         }
 189
 190         rte_mem_cfg_addr = mmap(NULL, sizeof(*rte_config.mem_config),
 191                                 PROT_READ | PROT_WRITE, MAP_SHARED, mem_cfg_fd, 0);
 192
 193         if (rte_mem_cfg_addr == MAP_FAILED){
 194                 rte_panic("Cannot mmap memory for rte_config\n");
 195         }
 196         memcpy(rte_mem_cfg_addr, &early_mem_config, sizeof(early_mem_config));
 197         rte_config.mem_config = (struct rte_mem_config *) rte_mem_cfg_addr;
 198 }
 199
 200 /* attach to an existing shared memory config */
 201 static void
 202 rte_eal_config_attach(void)
 203 {
 204         void *rte_mem_cfg_addr;
 205         const char *pathname = eal_runtime_config_path();
 206
 207         if (internal_config.no_shconf)
 208                 return;
 209
 210         if (mem_cfg_fd < 0){
 211                 mem_cfg_fd = open(pathname, O_RDWR);
 212                 if (mem_cfg_fd < 0)
 213                         rte_panic("Cannot open '%s' for rte_mem_config\n", pathname);
 214         }
 215
 216         rte_mem_cfg_addr = mmap(NULL, sizeof(*rte_config.mem_config),
 217                                 PROT_READ | PROT_WRITE, MAP_SHARED, mem_cfg_fd, 0);
 218         close(mem_cfg_fd);
 219         if (rte_mem_cfg_addr == MAP_FAILED)
 220                 rte_panic("Cannot mmap memory for rte_config\n");
 221
 222         rte_config.mem_config = (struct rte_mem_config *) rte_mem_cfg_addr;
 223 }
 224
 225 /* Detect if we are a primary or a secondary process */
 226 enum rte_proc_type_t
 227 eal_proc_type_detect(void)
 228 {
 229         enum rte_proc_type_t ptype = RTE_PROC_PRIMARY;
 230         const char *pathname = eal_runtime_config_path();
 231
 232         /* if we can open the file but not get a write-lock we are a secondary
 233          * process. NOTE: if we get a file handle back, we keep that open
 234          * and don't close it to prevent a race condition between multiple opens */
 235         if (((mem_cfg_fd = open(pathname, O_RDWR)) >= 0) &&
 236                         (fcntl(mem_cfg_fd, F_SETLK, &wr_lock) < 0))
 237                 ptype = RTE_PROC_SECONDARY;
 238
 239         RTE_LOG(INFO, EAL, "Auto-detected process type: %s\n",
 240                         ptype == RTE_PROC_PRIMARY ? "PRIMARY" : "SECONDARY");
 241
 242         return ptype;
 243 }
 244
 245 /* Sets up rte_config structure with the pointer to shared memory config.*/
 246 static void
 247 rte_config_init(void)
 248 {
 249         rte_config.process_type = internal_config.process_type;
 250
 251         switch (rte_config.process_type){
 252         case RTE_PROC_PRIMARY:
 253                 rte_eal_config_create();
 254                 break;
 255         case RTE_PROC_SECONDARY:
 256                 rte_eal_config_attach();
 257                 rte_eal_mcfg_wait_complete(rte_config.mem_config);
 258                 break;
 259         case RTE_PROC_AUTO:
 260         case RTE_PROC_INVALID:
 261                 rte_panic("Invalid process type\n");
 262         }
 263 }
 264
 265 /* display usage */
 266 static void
 267 eal_usage(const char *prgname)
 268 {
 269         printf("\nUsage: %s ", prgname);
 270         eal_common_usage();
 271         /* Allow the application to print its usage message too if hook is set */
 272         if ( rte_application_usage_hook ) {
 273                 printf("===== Application Usage =====\n\n");
 274                 rte_application_usage_hook(prgname);
 275         }
 276 }
 277
 278 /* Set a per-application usage message */
 279 rte_usage_hook_t
 280 rte_set_application_usage_hook( rte_usage_hook_t usage_func )
 281 {
 282         rte_usage_hook_t        old_func;
 283
 284         /* Will be NULL on the first call to denote the last usage routine. */
 285         old_func                                        = rte_application_usage_hook;
 286         rte_application_usage_hook      = usage_func;
 287
 288         return old_func;
 289 }
 290
 291 static inline size_t
 292 eal_get_hugepage_mem_size(void)
 293 {
 294         uint64_t size = 0;
 295         unsigned i, j;
 296
 297         for (i = 0; i < internal_config.num_hugepage_sizes; i++) {
 298                 struct hugepage_info *hpi = &internal_config.hugepage_info[i];
 299                 if (hpi->hugedir != NULL) {
 300                         for (j = 0; j < RTE_MAX_NUMA_NODES; j++) {
 301                                 size += hpi->hugepage_sz * hpi->num_pages[j];
 302                         }
 303                 }
 304         }
 305
 306         return (size < SIZE_MAX) ? (size_t)(size) : SIZE_MAX;
 307 }
 308
 309 /* Parse the argument given in the command line of the application */
 310 static int
 311 eal_parse_args(int argc, char **argv)
 312 {
 313         int opt, ret;
 314         char **argvopt;
 315         int option_index;
 316         char *prgname = argv[0];
 317
 318         argvopt = argv;
 319
 320         eal_reset_internal_config(&internal_config);
 321
 322         while ((opt = getopt_long(argc, argvopt, eal_short_options,
 323                                   eal_long_options, &option_index)) != EOF) {
 324
 325                 int ret;
 326
 327                 /* getopt is not happy, stop right now */
 328                 if (opt == '?') {
 329                         eal_usage(prgname);
 330                         return -1;
 331                 }
 332
 333                 ret = eal_parse_common_option(opt, optarg, &internal_config);
 334                 /* common parser is not happy */
 335                 if (ret < 0) {
 336                         eal_usage(prgname);
 337                         return -1;
 338                 }
 339                 /* common parser handled this option */
 340                 if (ret == 0)
 341                         continue;
 342
 343                 switch (opt) {
 344                 case 'h':
 345                         eal_usage(prgname);
 346                         exit(EXIT_SUCCESS);
 347                 default:
 348                         if (opt < OPT_LONG_MIN_NUM && isprint(opt)) {
 349                                 RTE_LOG(ERR, EAL, "Option %c is not supported "
 350                                         "on FreeBSD\n", opt);
 351                         } else if (opt >= OPT_LONG_MIN_NUM &&
 352                                    opt < OPT_LONG_MAX_NUM) {
 353                                 RTE_LOG(ERR, EAL, "Option %s is not supported "
 354                                         "on FreeBSD\n",
 355                                         eal_long_options[option_index].name);
 356                         } else {
 357                                 RTE_LOG(ERR, EAL, "Option %d is not supported "
 358                                         "on FreeBSD\n", opt);
 359                         }
 360                         eal_usage(prgname);
 361                         return -1;
 362                 }
 363         }
 364
 365         if (eal_adjust_config(&internal_config) != 0)
 366                 return -1;
 367
 368         /* sanity checks */
 369         if (eal_check_common_options(&internal_config) != 0) {
 370                 eal_usage(prgname);
 371                 return -1;
 372         }
 373
 374         if (optind >= 0)
 375                 argv[optind-1] = prgname;
 376         ret = optind-1;
 377         optind = 0; /* reset getopt lib */
 378         return ret;
 379 }
 380
 381 static void
 382 eal_check_mem_on_local_socket(void)
 383 {
 384         const struct rte_memseg *ms;
 385         int i, socket_id;
 386
 387         socket_id = rte_lcore_to_socket_id(rte_config.master_lcore);
 388
 389         ms = rte_eal_get_physmem_layout();
 390
 391         for (i = 0; i < RTE_MAX_MEMSEG; i++)
 392                 if (ms[i].socket_id == socket_id &&
 393                                 ms[i].len > 0)
 394                         return;
 395
 396         RTE_LOG(WARNING, EAL, "WARNING: Master core has no "
 397                         "memory on local socket!\n");
 398 }
 399
 400 static int
 401 sync_func(__attribute__((unused)) void *arg)
 402 {
 403         return 0;
 404 }
 405
 406 inline static void
 407 rte_eal_mcfg_complete(void)
 408 {
 409         /* ALL shared mem_config related INIT DONE */
 410         if (rte_config.process_type == RTE_PROC_PRIMARY)
 411                 rte_config.mem_config->magic = RTE_MAGIC;
 412 }
 413
 414 /* return non-zero if hugepages are enabled. */
 415 int rte_eal_has_hugepages(void)
 416 {
 417         return !internal_config.no_hugetlbfs;
 418 }
 419
 420 /* Abstraction for port I/0 privilege */
 421 int
 422 rte_eal_iopl_init(void)
 423 {
 424         int fd;
 425
 426         fd = open("/dev/io", O_RDWR);
 427         if (fd < 0)
 428                 return -1;
 429         close(fd);
 430         return 0;
 431 }
 432
 433 /* Launch threads, called at application init(). */
 434 int
 435 rte_eal_init(int argc, char **argv)
 436 {
 437         int i, fctret, ret;
 438         pthread_t thread_id;
 439         static rte_atomic32_t run_once = RTE_ATOMIC32_INIT(0);
 440         char cpuset[RTE_CPU_AFFINITY_STR_LEN];
 441
 442         if (!rte_atomic32_test_and_set(&run_once))
 443                 return -1;
 444
 445         thread_id = pthread_self();
 446
 447         if (rte_eal_log_early_init() < 0)
 448                 rte_panic("Cannot init early logs\n");
 449
 450         if (rte_eal_cpu_init() < 0)
 451                 rte_panic("Cannot detect lcores\n");
 452
 453         fctret = eal_parse_args(argc, argv);
 454         if (fctret < 0)
 455                 exit(1);
 456
 457         /* set log level as early as possible */
 458         rte_set_log_level(internal_config.log_level);
 459
 460         if (internal_config.no_hugetlbfs == 0 &&
 461                         internal_config.process_type != RTE_PROC_SECONDARY &&
 462                         eal_hugepage_info_init() < 0)
 463                 rte_panic("Cannot get hugepage information\n");
 464
 465         if (internal_config.memory == 0 && internal_config.force_sockets == 0) {
 466                 if (internal_config.no_hugetlbfs)
 467                         internal_config.memory = MEMSIZE_IF_NO_HUGE_PAGE;
 468                 else
 469                         internal_config.memory = eal_get_hugepage_mem_size();
 470         }
 471
 472         if (internal_config.vmware_tsc_map == 1) {
 473 #ifdef RTE_LIBRTE_EAL_VMWARE_TSC_MAP_SUPPORT
 474                 rte_cycles_vmware_tsc_map = 1;
 475                 RTE_LOG (DEBUG, EAL, "Using VMWARE TSC MAP, "
 476                                 "you must have monitor_control.pseudo_perfctr = TRUE\n");
 477 #else
 478                 RTE_LOG (WARNING, EAL, "Ignoring --vmware-tsc-map because "
 479                                 "RTE_LIBRTE_EAL_VMWARE_TSC_MAP_SUPPORT is not set\n");
 480 #endif
 481         }
 482
 483         rte_srand(rte_rdtsc());
 484
 485         rte_config_init();
 486
 487         if (rte_eal_memory_init() < 0)
 488                 rte_panic("Cannot init memory\n");
 489
 490         if (rte_eal_memzone_init() < 0)
 491                 rte_panic("Cannot init memzone\n");
 492
 493         if (rte_eal_tailqs_init() < 0)
 494                 rte_panic("Cannot init tail queues for objects\n");
 495
 496 /*      if (rte_eal_log_init(argv[0], internal_config.syslog_facility) < 0)
 497                 rte_panic("Cannot init logs\n");*/
 498
 499         if (rte_eal_alarm_init() < 0)
 500                 rte_panic("Cannot init interrupt-handling thread\n");
 501
 502         if (rte_eal_intr_init() < 0)
 503                 rte_panic("Cannot init interrupt-handling thread\n");
 504
 505         if (rte_eal_timer_init() < 0)
 506                 rte_panic("Cannot init HPET or TSC timers\n");
 507
 508         if (rte_eal_pci_init() < 0)
 509                 rte_panic("Cannot init PCI\n");
 510
 511         eal_check_mem_on_local_socket();
 512
 513         rte_eal_mcfg_complete();
 514
 515         eal_thread_init_master(rte_config.master_lcore);
 516
 517         ret = eal_thread_dump_affinity(cpuset, RTE_CPU_AFFINITY_STR_LEN);
 518
 519         RTE_LOG(DEBUG, EAL, "Master lcore %u is ready (tid=%p;cpuset=[%s%s])\n",
 520                 rte_config.master_lcore, thread_id, cpuset,
 521                 ret == 0 ? "" : "...");
 522
 523         if (rte_eal_dev_init() < 0)
 524                 rte_panic("Cannot init pmd devices\n");
 525
 526         RTE_LCORE_FOREACH_SLAVE(i) {
 527
 528                 /*
 529                  * create communication pipes between master thread
 530                  * and children
 531                  */
 532                 if (pipe(lcore_config[i].pipe_master2slave) < 0)
 533                         rte_panic("Cannot create pipe\n");
 534                 if (pipe(lcore_config[i].pipe_slave2master) < 0)
 535                         rte_panic("Cannot create pipe\n");
 536
 537                 lcore_config[i].state = WAIT;
 538
 539                 /* create a thread for each lcore */
 540                 ret = pthread_create(&lcore_config[i].thread_id, NULL,
 541                                      eal_thread_loop, NULL);
 542                 if (ret != 0)
 543                         rte_panic("Cannot create thread\n");
 544         }
 545
 546         /*
 547          * Launch a dummy function on all slave lcores, so that master lcore
 548          * knows they are all ready when this function returns.
 549          */
 550         rte_eal_mp_remote_launch(sync_func, NULL, SKIP_MASTER);
 551         rte_eal_mp_wait_lcore();
 552
 553         /* Probe & Initialize PCI devices */
 554         if (rte_eal_pci_probe())
 555                 rte_panic("Cannot probe PCI\n");
 556
 557         return fctret;
 558 }
 559
 560 /* get core role */
 561 enum rte_lcore_role_t
 562 rte_eal_lcore_role(unsigned lcore_id)
 563 {
 564         return (rte_config.lcore_role[lcore_id]);
 565 }
 566
 567 enum rte_proc_type_t
 568 rte_eal_process_type(void)
 569 {
 570         return (rte_config.process_type);
 571 }
 572