lib/librte_eal/common/eal_common_options.c

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
   5  *   Copyright(c) 2014 6WIND S.A.
   6  *
   7  *   Redistribution and use in source and binary forms, with or without
   8  *   modification, are permitted provided that the following conditions
   9  *   are met:
  10  *
  11  *     * Redistributions of source code must retain the above copyright
  12  *       notice, this list of conditions and the following disclaimer.
  13  *     * Redistributions in binary form must reproduce the above copyright
  14  *       notice, this list of conditions and the following disclaimer in
  15  *       the documentation and/or other materials provided with the
  16  *       distribution.
  17  *     * Neither the name of Intel Corporation nor the names of its
  18  *       contributors may be used to endorse or promote products derived
  19  *       from this software without specific prior written permission.
  20  *
  21  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  24  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  25  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  26  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  27  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  28  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  29  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  30  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  31  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32  */
  33
  34 #include <stdlib.h>
  35 #include <unistd.h>
  36 #include <string.h>
  37 #include <syslog.h>
  38 #include <ctype.h>
  39 #include <limits.h>
  40 #include <errno.h>
  41 #include <getopt.h>
  42
  43 #include <rte_eal.h>
  44 #include <rte_log.h>
  45 #include <rte_lcore.h>
  46 #include <rte_version.h>
  47 #include <rte_devargs.h>
  48
  49 #include "eal_internal_cfg.h"
  50 #include "eal_options.h"
  51 #include "eal_filesystem.h"
  52
  53 #define BITS_PER_HEX 4
  54
  55 const char
  56 eal_short_options[] =
  57         "b:" /* pci-blacklist */
  58         "w:" /* pci-whitelist */
  59         "c:" /* coremask */
  60         "d:"
  61         "l:" /* corelist */
  62         "m:"
  63         "n:"
  64         "r:"
  65         "v";
  66
  67 const struct option
  68 eal_long_options[] = {
  69         {OPT_HUGE_DIR, 1, 0, OPT_HUGE_DIR_NUM},
  70         {OPT_PROC_TYPE, 1, 0, OPT_PROC_TYPE_NUM},
  71         {OPT_NO_SHCONF, 0, 0, OPT_NO_SHCONF_NUM},
  72         {OPT_NO_HPET, 0, 0, OPT_NO_HPET_NUM},
  73         {OPT_VMWARE_TSC_MAP, 0, 0, OPT_VMWARE_TSC_MAP_NUM},
  74         {OPT_NO_PCI, 0, 0, OPT_NO_PCI_NUM},
  75         {OPT_NO_HUGE, 0, 0, OPT_NO_HUGE_NUM},
  76         {OPT_FILE_PREFIX, 1, 0, OPT_FILE_PREFIX_NUM},
  77         {OPT_SOCKET_MEM, 1, 0, OPT_SOCKET_MEM_NUM},
  78         {OPT_PCI_WHITELIST, 1, 0, OPT_PCI_WHITELIST_NUM},
  79         {OPT_PCI_BLACKLIST, 1, 0, OPT_PCI_BLACKLIST_NUM},
  80         {OPT_VDEV, 1, 0, OPT_VDEV_NUM},
  81         {OPT_SYSLOG, 1, NULL, OPT_SYSLOG_NUM},
  82         {OPT_LOG_LEVEL, 1, NULL, OPT_LOG_LEVEL_NUM},
  83         {OPT_BASE_VIRTADDR, 1, 0, OPT_BASE_VIRTADDR_NUM},
  84         {OPT_XEN_DOM0, 0, 0, OPT_XEN_DOM0_NUM},
  85         {OPT_CREATE_UIO_DEV, 1, NULL, OPT_CREATE_UIO_DEV_NUM},
  86         {OPT_VFIO_INTR, 1, NULL, OPT_VFIO_INTR_NUM},
  87         {0, 0, 0, 0}
  88 };
  89
  90 static int lcores_parsed;
  91 static int mem_parsed;
  92
  93 void
  94 eal_reset_internal_config(struct internal_config *internal_cfg)
  95 {
  96         int i;
  97
  98         internal_cfg->memory = 0;
  99         internal_cfg->force_nrank = 0;
 100         internal_cfg->force_nchannel = 0;
 101         internal_cfg->hugefile_prefix = HUGEFILE_PREFIX_DEFAULT;
 102         internal_cfg->hugepage_dir = NULL;
 103         internal_cfg->force_sockets = 0;
 104         /* zero out the NUMA config */
 105         for (i = 0; i < RTE_MAX_NUMA_NODES; i++)
 106                 internal_cfg->socket_mem[i] = 0;
 107         /* zero out hugedir descriptors */
 108         for (i = 0; i < MAX_HUGEPAGE_SIZES; i++)
 109                 internal_cfg->hugepage_info[i].lock_descriptor = -1;
 110         internal_cfg->base_virtaddr = 0;
 111
 112         internal_cfg->syslog_facility = LOG_DAEMON;
 113         /* default value from build option */
 114         internal_cfg->log_level = RTE_LOG_LEVEL;
 115
 116         internal_cfg->xen_dom0_support = 0;
 117
 118         /* if set to NONE, interrupt mode is determined automatically */
 119         internal_cfg->vfio_intr_mode = RTE_INTR_MODE_NONE;
 120
 121 #ifdef RTE_LIBEAL_USE_HPET
 122         internal_cfg->no_hpet = 0;
 123 #else
 124         internal_cfg->no_hpet = 1;
 125 #endif
 126         internal_cfg->vmware_tsc_map = 0;
 127 }
 128
 129 /*
 130  * Parse the coremask given as argument (hexadecimal string) and fill
 131  * the global configuration (core role and core count) with the parsed
 132  * value.
 133  */
 134 static int xdigit2val(unsigned char c)
 135 {
 136         int val;
 137
 138         if (isdigit(c))
 139                 val = c - '0';
 140         else if (isupper(c))
 141                 val = c - 'A' + 10;
 142         else
 143                 val = c - 'a' + 10;
 144         return val;
 145 }
 146
 147 static int
 148 eal_parse_coremask(const char *coremask)
 149 {
 150         struct rte_config *cfg = rte_eal_get_configuration();
 151         int i, j, idx = 0;
 152         unsigned count = 0;
 153         char c;
 154         int val;
 155
 156         if (coremask == NULL)
 157                 return -1;
 158         /* Remove all blank characters ahead and after .
 159          * Remove 0x/0X if exists.
 160          */
 161         while (isblank(*coremask))
 162                 coremask++;
 163         if (coremask[0] == '0' && ((coremask[1] == 'x')
 164                 || (coremask[1] == 'X')))
 165                 coremask += 2;
 166         i = strnlen(coremask, PATH_MAX);
 167         while ((i > 0) && isblank(coremask[i - 1]))
 168                 i--;
 169         if (i == 0)
 170                 return -1;
 171
 172         for (i = i - 1; i >= 0 && idx < RTE_MAX_LCORE; i--) {
 173                 c = coremask[i];
 174                 if (isxdigit(c) == 0) {
 175                         /* invalid characters */
 176                         return -1;
 177                 }
 178                 val = xdigit2val(c);
 179                 for (j = 0; j < BITS_PER_HEX && idx < RTE_MAX_LCORE; j++, idx++)
 180                 {
 181                         if ((1 << j) & val) {
 182                                 if (!lcore_config[idx].detected) {
 183                                         RTE_LOG(ERR, EAL, "lcore %u "
 184                                                 "unavailable\n", idx);
 185                                         return -1;
 186                                 }
 187                                 cfg->lcore_role[idx] = ROLE_RTE;
 188                                 if (count == 0)
 189                                         cfg->master_lcore = idx;
 190                                 count++;
 191                         } else {
 192                                 cfg->lcore_role[idx] = ROLE_OFF;
 193                         }
 194                 }
 195         }
 196         for (; i >= 0; i--)
 197                 if (coremask[i] != '0')
 198                         return -1;
 199         for (; idx < RTE_MAX_LCORE; idx++)
 200                 cfg->lcore_role[idx] = ROLE_OFF;
 201         if (count == 0)
 202                 return -1;
 203         /* Update the count of enabled logical cores of the EAL configuration */
 204         cfg->lcore_count = count;
 205         lcores_parsed = 1;
 206         return 0;
 207 }
 208
 209 static int
 210 eal_parse_corelist(const char *corelist)
 211 {
 212         struct rte_config *cfg = rte_eal_get_configuration();
 213         int i, idx = 0;
 214         unsigned count = 0;
 215         char *end = NULL;
 216         int min, max;
 217
 218         if (corelist == NULL)
 219                 return -1;
 220
 221         /* Remove all blank characters ahead and after */
 222         while (isblank(*corelist))
 223                 corelist++;
 224         i = strnlen(corelist, sysconf(_SC_ARG_MAX));
 225         while ((i > 0) && isblank(corelist[i - 1]))
 226                 i--;
 227
 228         /* Reset core roles */
 229         for (idx = 0; idx < RTE_MAX_LCORE; idx++)
 230                 cfg->lcore_role[idx] = ROLE_OFF;
 231
 232         /* Get list of cores */
 233         min = RTE_MAX_LCORE;
 234         do {
 235                 while (isblank(*corelist))
 236                         corelist++;
 237                 if (*corelist == '\0')
 238                         return -1;
 239                 errno = 0;
 240                 idx = strtoul(corelist, &end, 10);
 241                 if (errno || end == NULL)
 242                         return -1;
 243                 while (isblank(*end))
 244                         end++;
 245                 if (*end == '-') {
 246                         min = idx;
 247                 } else if ((*end == ',') || (*end == '\0')) {
 248                         max = idx;
 249                         if (min == RTE_MAX_LCORE)
 250                                 min = idx;
 251                         for (idx = min; idx <= max; idx++) {
 252                                 cfg->lcore_role[idx] = ROLE_RTE;
 253                                 if (count == 0)
 254                                         cfg->master_lcore = idx;
 255                                 count++;
 256                         }
 257                         min = RTE_MAX_LCORE;
 258                 } else
 259                         return -1;
 260                 corelist = end + 1;
 261         } while (*end != '\0');
 262
 263         if (count == 0)
 264                 return -1;
 265
 266         lcores_parsed = 1;
 267         return 0;
 268 }
 269
 270 static int
 271 eal_parse_syslog(const char *facility, struct internal_config *conf)
 272 {
 273         int i;
 274         static struct {
 275                 const char *name;
 276                 int value;
 277         } map[] = {
 278                 { "auth", LOG_AUTH },
 279                 { "cron", LOG_CRON },
 280                 { "daemon", LOG_DAEMON },
 281                 { "ftp", LOG_FTP },
 282                 { "kern", LOG_KERN },
 283                 { "lpr", LOG_LPR },
 284                 { "mail", LOG_MAIL },
 285                 { "news", LOG_NEWS },
 286                 { "syslog", LOG_SYSLOG },
 287                 { "user", LOG_USER },
 288                 { "uucp", LOG_UUCP },
 289                 { "local0", LOG_LOCAL0 },
 290                 { "local1", LOG_LOCAL1 },
 291                 { "local2", LOG_LOCAL2 },
 292                 { "local3", LOG_LOCAL3 },
 293                 { "local4", LOG_LOCAL4 },
 294                 { "local5", LOG_LOCAL5 },
 295                 { "local6", LOG_LOCAL6 },
 296                 { "local7", LOG_LOCAL7 },
 297                 { NULL, 0 }
 298         };
 299
 300         for (i = 0; map[i].name; i++) {
 301                 if (!strcmp(facility, map[i].name)) {
 302                         conf->syslog_facility = map[i].value;
 303                         return 0;
 304                 }
 305         }
 306         return -1;
 307 }
 308
 309 static int
 310 eal_parse_log_level(const char *level, uint32_t *log_level)
 311 {
 312         char *end;
 313         unsigned long tmp;
 314
 315         errno = 0;
 316         tmp = strtoul(level, &end, 0);
 317
 318         /* check for errors */
 319         if ((errno != 0) || (level[0] == '\0') ||
 320             end == NULL || (*end != '\0'))
 321                 return -1;
 322
 323         /* log_level is a uint32_t */
 324         if (tmp >= UINT32_MAX)
 325                 return -1;
 326
 327         *log_level = tmp;
 328         return 0;
 329 }
 330
 331 static enum rte_proc_type_t
 332 eal_parse_proc_type(const char *arg)
 333 {
 334         if (strncasecmp(arg, "primary", sizeof("primary")) == 0)
 335                 return RTE_PROC_PRIMARY;
 336         if (strncasecmp(arg, "secondary", sizeof("secondary")) == 0)
 337                 return RTE_PROC_SECONDARY;
 338         if (strncasecmp(arg, "auto", sizeof("auto")) == 0)
 339                 return RTE_PROC_AUTO;
 340
 341         return RTE_PROC_INVALID;
 342 }
 343
 344 int
 345 eal_parse_common_option(int opt, const char *optarg,
 346                         struct internal_config *conf)
 347 {
 348         switch (opt) {
 349         /* blacklist */
 350         case 'b':
 351                 if (rte_eal_devargs_add(RTE_DEVTYPE_BLACKLISTED_PCI,
 352                                 optarg) < 0) {
 353                         return -1;
 354                 }
 355                 break;
 356         /* whitelist */
 357         case 'w':
 358                 if (rte_eal_devargs_add(RTE_DEVTYPE_WHITELISTED_PCI,
 359                                 optarg) < 0) {
 360                         return -1;
 361                 }
 362                 break;
 363         /* coremask */
 364         case 'c':
 365                 if (eal_parse_coremask(optarg) < 0) {
 366                         RTE_LOG(ERR, EAL, "invalid coremask\n");
 367                         return -1;
 368                 }
 369                 break;
 370         /* corelist */
 371         case 'l':
 372                 if (eal_parse_corelist(optarg) < 0) {
 373                         RTE_LOG(ERR, EAL, "invalid core list\n");
 374                         return -1;
 375                 }
 376                 break;
 377         /* size of memory */
 378         case 'm':
 379                 conf->memory = atoi(optarg);
 380                 conf->memory *= 1024ULL;
 381                 conf->memory *= 1024ULL;
 382                 mem_parsed = 1;
 383                 break;
 384         /* force number of channels */
 385         case 'n':
 386                 conf->force_nchannel = atoi(optarg);
 387                 if (conf->force_nchannel == 0 ||
 388                     conf->force_nchannel > 4) {
 389                         RTE_LOG(ERR, EAL, "invalid channel number\n");
 390                         return -1;
 391                 }
 392                 break;
 393         /* force number of ranks */
 394         case 'r':
 395                 conf->force_nrank = atoi(optarg);
 396                 if (conf->force_nrank == 0 ||
 397                     conf->force_nrank > 16) {
 398                         RTE_LOG(ERR, EAL, "invalid rank number\n");
 399                         return -1;
 400                 }
 401                 break;
 402         case 'v':
 403                 /* since message is explicitly requested by user, we
 404                  * write message at highest log level so it can always
 405                  * be seen
 406                  * even if info or warning messages are disabled */
 407                 RTE_LOG(CRIT, EAL, "RTE Version: '%s'\n", rte_version());
 408                 break;
 409
 410         /* long options */
 411         case OPT_NO_HUGE_NUM:
 412                 conf->no_hugetlbfs = 1;
 413                 break;
 414
 415         case OPT_NO_PCI_NUM:
 416                 conf->no_pci = 1;
 417                 break;
 418
 419         case OPT_NO_HPET_NUM:
 420                 conf->no_hpet = 1;
 421                 break;
 422
 423         case OPT_VMWARE_TSC_MAP_NUM:
 424                 conf->vmware_tsc_map = 1;
 425                 break;
 426
 427         case OPT_NO_SHCONF_NUM:
 428                 conf->no_shconf = 1;
 429                 break;
 430
 431         case OPT_PROC_TYPE_NUM:
 432                 conf->process_type = eal_parse_proc_type(optarg);
 433                 break;
 434
 435         case OPT_VDEV_NUM:
 436                 if (rte_eal_devargs_add(RTE_DEVTYPE_VIRTUAL,
 437                                 optarg) < 0) {
 438                         return -1;
 439                 }
 440                 break;
 441
 442         case OPT_SYSLOG_NUM:
 443                 if (eal_parse_syslog(optarg, conf) < 0) {
 444                         RTE_LOG(ERR, EAL, "invalid parameters for --"
 445                                         OPT_SYSLOG "\n");
 446                         return -1;
 447                 }
 448                 break;
 449
 450         case OPT_LOG_LEVEL_NUM: {
 451                 uint32_t log;
 452
 453                 if (eal_parse_log_level(optarg, &log) < 0) {
 454                         RTE_LOG(ERR, EAL,
 455                                 "invalid parameters for --"
 456                                 OPT_LOG_LEVEL "\n");
 457                         return -1;
 458                 }
 459                 conf->log_level = log;
 460                 break;
 461         }
 462
 463         /* don't know what to do, leave this to caller */
 464         default:
 465                 return 1;
 466
 467         }
 468
 469         return 0;
 470 }
 471
 472 int
 473 eal_adjust_config(struct internal_config *internal_cfg)
 474 {
 475         int i;
 476
 477         if (internal_config.process_type == RTE_PROC_AUTO)
 478                 internal_config.process_type = eal_proc_type_detect();
 479
 480         /* if no memory amounts were requested, this will result in 0 and
 481          * will be overridden later, right after eal_hugepage_info_init() */
 482         for (i = 0; i < RTE_MAX_NUMA_NODES; i++)
 483                 internal_cfg->memory += internal_cfg->socket_mem[i];
 484
 485         return 0;
 486 }
 487
 488 int
 489 eal_check_common_options(struct internal_config *internal_cfg)
 490 {
 491         struct rte_config *cfg = rte_eal_get_configuration();
 492
 493         if (!lcores_parsed) {
 494                 RTE_LOG(ERR, EAL, "CPU cores must be enabled with options "
 495                         "-c or -l\n");
 496                 return -1;
 497         }
 498
 499         if (internal_cfg->process_type == RTE_PROC_INVALID) {
 500                 RTE_LOG(ERR, EAL, "Invalid process type specified\n");
 501                 return -1;
 502         }
 503         if (internal_cfg->process_type == RTE_PROC_PRIMARY &&
 504                         internal_cfg->force_nchannel == 0) {
 505                 RTE_LOG(ERR, EAL, "Number of memory channels (-n) not "
 506                         "specified\n");
 507                 return -1;
 508         }
 509         if (index(internal_cfg->hugefile_prefix, '%') != NULL) {
 510                 RTE_LOG(ERR, EAL, "Invalid char, '%%', in --"OPT_FILE_PREFIX" "
 511                         "option\n");
 512                 return -1;
 513         }
 514         if (mem_parsed && internal_cfg->force_sockets == 1) {
 515                 RTE_LOG(ERR, EAL, "Options -m and --"OPT_SOCKET_MEM" cannot "
 516                         "be specified at the same time\n");
 517                 return -1;
 518         }
 519         if (internal_cfg->no_hugetlbfs &&
 520                         (mem_parsed || internal_cfg->force_sockets == 1)) {
 521                 RTE_LOG(ERR, EAL, "Options -m or --"OPT_SOCKET_MEM" cannot "
 522                         "be specified together with --"OPT_NO_HUGE"\n");
 523                 return -1;
 524         }
 525
 526         if (rte_eal_devargs_type_count(RTE_DEVTYPE_WHITELISTED_PCI) != 0 &&
 527                 rte_eal_devargs_type_count(RTE_DEVTYPE_BLACKLISTED_PCI) != 0) {
 528                 RTE_LOG(ERR, EAL, "Options blacklist (-b) and whitelist (-w) "
 529                         "cannot be used at the same time\n");
 530                 return -1;
 531         }
 532
 533         return 0;
 534 }
 535
 536 void
 537 eal_common_usage(void)
 538 {
 539         printf("-c COREMASK -n NUM [-m NB] [-r NUM] [-b <domain:bus:devid.func>]"
 540                "[--proc-type primary|secondary|auto]\n\n"
 541                "EAL common options:\n"
 542                "  -c COREMASK  : A hexadecimal bitmask of cores to run on\n"
 543                "  -l CORELIST  : List of cores to run on\n"
 544                "                 The argument format is <c1>[-c2][,c3[-c4],...]\n"
 545                "                 where c1, c2, etc are core indexes between 0 and %d\n"
 546                "  -n NUM       : Number of memory channels\n"
 547                "  -v           : Display version information on startup\n"
 548                "  -m MB        : memory to allocate (see also --"OPT_SOCKET_MEM")\n"
 549                "  -r NUM       : force number of memory ranks (don't detect)\n"
 550                "  --"OPT_SYSLOG"     : set syslog facility\n"
 551                "  --"OPT_LOG_LEVEL"  : set default log level\n"
 552                "  --"OPT_PROC_TYPE"  : type of this process\n"
 553                "  --"OPT_PCI_BLACKLIST", -b: add a PCI device in black list.\n"
 554                "               Prevent EAL from using this PCI device. The argument\n"
 555                "               format is <domain:bus:devid.func>.\n"
 556                "  --"OPT_PCI_WHITELIST", -w: add a PCI device in white list.\n"
 557                "               Only use the specified PCI devices. The argument format\n"
 558                "               is <[domain:]bus:devid.func>. This option can be present\n"
 559                "               several times (once per device).\n"
 560                "               [NOTE: PCI whitelist cannot be used with -b option]\n"
 561                "  --"OPT_VDEV": add a virtual device.\n"
 562                "               The argument format is <driver><id>[,key=val,...]\n"
 563                "               (ex: --vdev=eth_pcap0,iface=eth2).\n"
 564                "  --"OPT_VMWARE_TSC_MAP": use VMware TSC map instead of native RDTSC\n"
 565                "\nEAL options for DEBUG use only:\n"
 566                "  --"OPT_NO_HUGE"  : use malloc instead of hugetlbfs\n"
 567                "  --"OPT_NO_PCI"   : disable pci\n"
 568                "  --"OPT_NO_HPET"  : disable hpet\n"
 569                "  --"OPT_NO_SHCONF": no shared config (mmap'd files)\n"
 570                "\n", RTE_MAX_LCORE);
 571 }