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 #include <dlfcn.h>
  43 #include <sys/types.h>
  44 #include <sys/stat.h>
  45 #include <dirent.h>
  46
  47 #include <rte_eal.h>
  48 #include <rte_log.h>
  49 #include <rte_lcore.h>
  50 #include <rte_version.h>
  51 #include <rte_devargs.h>
  52 #include <rte_memcpy.h>
  53
  54 #include "eal_internal_cfg.h"
  55 #include "eal_options.h"
  56 #include "eal_filesystem.h"
  57
  58 #define BITS_PER_HEX 4
  59
  60 const char
  61 eal_short_options[] =
  62         "b:" /* pci-blacklist */
  63         "c:" /* coremask */
  64         "s:" /* service coremask */
  65         "d:" /* driver */
  66         "h"  /* help */
  67         "l:" /* corelist */
  68         "m:" /* memory size */
  69         "n:" /* memory channels */
  70         "r:" /* memory ranks */
  71         "v"  /* version */
  72         "w:" /* pci-whitelist */
  73         ;
  74
  75 const struct option
  76 eal_long_options[] = {
  77         {OPT_BASE_VIRTADDR,     1, NULL, OPT_BASE_VIRTADDR_NUM    },
  78         {OPT_CREATE_UIO_DEV,    0, NULL, OPT_CREATE_UIO_DEV_NUM   },
  79         {OPT_FILE_PREFIX,       1, NULL, OPT_FILE_PREFIX_NUM      },
  80         {OPT_HELP,              0, NULL, OPT_HELP_NUM             },
  81         {OPT_HUGE_DIR,          1, NULL, OPT_HUGE_DIR_NUM         },
  82         {OPT_HUGE_UNLINK,       0, NULL, OPT_HUGE_UNLINK_NUM      },
  83         {OPT_LCORES,            1, NULL, OPT_LCORES_NUM           },
  84         {OPT_LOG_LEVEL,         1, NULL, OPT_LOG_LEVEL_NUM        },
  85         {OPT_MASTER_LCORE,      1, NULL, OPT_MASTER_LCORE_NUM     },
  86         {OPT_NO_HPET,           0, NULL, OPT_NO_HPET_NUM          },
  87         {OPT_NO_HUGE,           0, NULL, OPT_NO_HUGE_NUM          },
  88         {OPT_NO_PCI,            0, NULL, OPT_NO_PCI_NUM           },
  89         {OPT_NO_SHCONF,         0, NULL, OPT_NO_SHCONF_NUM        },
  90         {OPT_PCI_BLACKLIST,     1, NULL, OPT_PCI_BLACKLIST_NUM    },
  91         {OPT_PCI_WHITELIST,     1, NULL, OPT_PCI_WHITELIST_NUM    },
  92         {OPT_PROC_TYPE,         1, NULL, OPT_PROC_TYPE_NUM        },
  93         {OPT_SOCKET_MEM,        1, NULL, OPT_SOCKET_MEM_NUM       },
  94         {OPT_SYSLOG,            1, NULL, OPT_SYSLOG_NUM           },
  95         {OPT_VDEV,              1, NULL, OPT_VDEV_NUM             },
  96         {OPT_VFIO_INTR,         1, NULL, OPT_VFIO_INTR_NUM        },
  97         {OPT_VMWARE_TSC_MAP,    0, NULL, OPT_VMWARE_TSC_MAP_NUM   },
  98         {OPT_XEN_DOM0,          0, NULL, OPT_XEN_DOM0_NUM         },
  99         {0,                     0, NULL, 0                        }
 100 };
 101
 102 TAILQ_HEAD(shared_driver_list, shared_driver);
 103
 104 /* Definition for shared object drivers. */
 105 struct shared_driver {
 106         TAILQ_ENTRY(shared_driver) next;
 107
 108         char    name[PATH_MAX];
 109         void*   lib_handle;
 110 };
 111
 112 /* List of external loadable drivers */
 113 static struct shared_driver_list solib_list =
 114 TAILQ_HEAD_INITIALIZER(solib_list);
 115
 116 /* Default path of external loadable drivers */
 117 static const char *default_solib_dir = RTE_EAL_PMD_PATH;
 118
 119 /*
 120  * Stringified version of solib path used by dpdk-pmdinfo.py
 121  * Note: PLEASE DO NOT ALTER THIS without making a corresponding
 122  * change to usertools/dpdk-pmdinfo.py
 123  */
 124 static const char dpdk_solib_path[] __attribute__((used)) =
 125 "DPDK_PLUGIN_PATH=" RTE_EAL_PMD_PATH;
 126
 127
 128 static int master_lcore_parsed;
 129 static int mem_parsed;
 130 static int core_parsed;
 131
 132 void
 133 eal_reset_internal_config(struct internal_config *internal_cfg)
 134 {
 135         int i;
 136
 137         internal_cfg->memory = 0;
 138         internal_cfg->force_nrank = 0;
 139         internal_cfg->force_nchannel = 0;
 140         internal_cfg->hugefile_prefix = HUGEFILE_PREFIX_DEFAULT;
 141         internal_cfg->hugepage_dir = NULL;
 142         internal_cfg->force_sockets = 0;
 143         /* zero out the NUMA config */
 144         for (i = 0; i < RTE_MAX_NUMA_NODES; i++)
 145                 internal_cfg->socket_mem[i] = 0;
 146         /* zero out hugedir descriptors */
 147         for (i = 0; i < MAX_HUGEPAGE_SIZES; i++)
 148                 internal_cfg->hugepage_info[i].lock_descriptor = -1;
 149         internal_cfg->base_virtaddr = 0;
 150
 151         internal_cfg->syslog_facility = LOG_DAEMON;
 152
 153         internal_cfg->xen_dom0_support = 0;
 154
 155         /* if set to NONE, interrupt mode is determined automatically */
 156         internal_cfg->vfio_intr_mode = RTE_INTR_MODE_NONE;
 157
 158 #ifdef RTE_LIBEAL_USE_HPET
 159         internal_cfg->no_hpet = 0;
 160 #else
 161         internal_cfg->no_hpet = 1;
 162 #endif
 163         internal_cfg->vmware_tsc_map = 0;
 164         internal_cfg->create_uio_dev = 0;
 165 }
 166
 167 static int
 168 eal_plugin_add(const char *path)
 169 {
 170         struct shared_driver *solib;
 171
 172         solib = malloc(sizeof(*solib));
 173         if (solib == NULL) {
 174                 RTE_LOG(ERR, EAL, "malloc(solib) failed\n");
 175                 return -1;
 176         }
 177         memset(solib, 0, sizeof(*solib));
 178         strncpy(solib->name, path, PATH_MAX-1);
 179         solib->name[PATH_MAX-1] = 0;
 180         TAILQ_INSERT_TAIL(&solib_list, solib, next);
 181
 182         return 0;
 183 }
 184
 185 static int
 186 eal_plugindir_init(const char *path)
 187 {
 188         DIR *d = NULL;
 189         struct dirent *dent = NULL;
 190         char sopath[PATH_MAX];
 191
 192         if (path == NULL || *path == '\0')
 193                 return 0;
 194
 195         d = opendir(path);
 196         if (d == NULL) {
 197                 RTE_LOG(ERR, EAL, "failed to open directory %s: %s\n",
 198                         path, strerror(errno));
 199                 return -1;
 200         }
 201
 202         while ((dent = readdir(d)) != NULL) {
 203                 struct stat sb;
 204
 205                 snprintf(sopath, PATH_MAX-1, "%s/%s", path, dent->d_name);
 206                 sopath[PATH_MAX-1] = 0;
 207
 208                 if (!(stat(sopath, &sb) == 0 && S_ISREG(sb.st_mode)))
 209                         continue;
 210
 211                 if (eal_plugin_add(sopath) == -1)
 212                         break;
 213         }
 214
 215         closedir(d);
 216         /* XXX this ignores failures from readdir() itself */
 217         return (dent == NULL) ? 0 : -1;
 218 }
 219
 220 int
 221 eal_plugins_init(void)
 222 {
 223         struct shared_driver *solib = NULL;
 224
 225         if (*default_solib_dir != '\0')
 226                 eal_plugin_add(default_solib_dir);
 227
 228         TAILQ_FOREACH(solib, &solib_list, next) {
 229                 struct stat sb;
 230
 231                 if (stat(solib->name, &sb) == 0 && S_ISDIR(sb.st_mode)) {
 232                         if (eal_plugindir_init(solib->name) == -1) {
 233                                 RTE_LOG(ERR, EAL,
 234                                         "Cannot init plugin directory %s\n",
 235                                         solib->name);
 236                                 return -1;
 237                         }
 238                 } else {
 239                         RTE_LOG(DEBUG, EAL, "open shared lib %s\n",
 240                                 solib->name);
 241                         solib->lib_handle = dlopen(solib->name, RTLD_NOW);
 242                         if (solib->lib_handle == NULL) {
 243                                 RTE_LOG(ERR, EAL, "%s\n", dlerror());
 244                                 return -1;
 245                         }
 246                 }
 247
 248         }
 249         return 0;
 250 }
 251
 252 /*
 253  * Parse the coremask given as argument (hexadecimal string) and fill
 254  * the global configuration (core role and core count) with the parsed
 255  * value.
 256  */
 257 static int xdigit2val(unsigned char c)
 258 {
 259         int val;
 260
 261         if (isdigit(c))
 262                 val = c - '0';
 263         else if (isupper(c))
 264                 val = c - 'A' + 10;
 265         else
 266                 val = c - 'a' + 10;
 267         return val;
 268 }
 269
 270 static int
 271 eal_parse_service_coremask(const char *coremask)
 272 {
 273         struct rte_config *cfg = rte_eal_get_configuration();
 274         int i, j, idx = 0;
 275         unsigned int count = 0;
 276         char c;
 277         int val;
 278
 279         if (coremask == NULL)
 280                 return -1;
 281         /* Remove all blank characters ahead and after .
 282          * Remove 0x/0X if exists.
 283          */
 284         while (isblank(*coremask))
 285                 coremask++;
 286         if (coremask[0] == '0' && ((coremask[1] == 'x')
 287                 || (coremask[1] == 'X')))
 288                 coremask += 2;
 289         i = strlen(coremask);
 290         while ((i > 0) && isblank(coremask[i - 1]))
 291                 i--;
 292
 293         if (i == 0)
 294                 return -1;
 295
 296         for (i = i - 1; i >= 0 && idx < RTE_MAX_LCORE; i--) {
 297                 c = coremask[i];
 298                 if (isxdigit(c) == 0) {
 299                         /* invalid characters */
 300                         return -1;
 301                 }
 302                 val = xdigit2val(c);
 303                 for (j = 0; j < BITS_PER_HEX && idx < RTE_MAX_LCORE;
 304                                 j++, idx++) {
 305                         if ((1 << j) & val) {
 306                                 /* handle master lcore already parsed */
 307                                 uint32_t lcore = idx;
 308                                 if (master_lcore_parsed &&
 309                                                 cfg->master_lcore == lcore) {
 310                                         RTE_LOG(ERR, EAL,
 311                                                 "Error: lcore %u is master lcore, cannot use as service core\n",
 312                                                 idx);
 313                                         return -1;
 314                                 }
 315
 316                                 if (!lcore_config[idx].detected) {
 317                                         RTE_LOG(ERR, EAL,
 318                                                 "lcore %u unavailable\n", idx);
 319                                         return -1;
 320                                 }
 321                                 lcore_config[idx].core_role = ROLE_SERVICE;
 322                                 count++;
 323                         }
 324                 }
 325         }
 326
 327         for (; i >= 0; i--)
 328                 if (coremask[i] != '0')
 329                         return -1;
 330
 331         for (; idx < RTE_MAX_LCORE; idx++)
 332                 lcore_config[idx].core_index = -1;
 333
 334         if (count == 0)
 335                 return -1;
 336
 337         cfg->service_lcore_count = count;
 338         return 0;
 339 }
 340
 341 static int
 342 eal_parse_coremask(const char *coremask)
 343 {
 344         struct rte_config *cfg = rte_eal_get_configuration();
 345         int i, j, idx = 0;
 346         unsigned count = 0;
 347         char c;
 348         int val;
 349
 350         if (coremask == NULL)
 351                 return -1;
 352         /* Remove all blank characters ahead and after .
 353          * Remove 0x/0X if exists.
 354          */
 355         while (isblank(*coremask))
 356                 coremask++;
 357         if (coremask[0] == '0' && ((coremask[1] == 'x')
 358                 || (coremask[1] == 'X')))
 359                 coremask += 2;
 360         i = strlen(coremask);
 361         while ((i > 0) && isblank(coremask[i - 1]))
 362                 i--;
 363         if (i == 0)
 364                 return -1;
 365
 366         for (i = i - 1; i >= 0 && idx < RTE_MAX_LCORE; i--) {
 367                 c = coremask[i];
 368                 if (isxdigit(c) == 0) {
 369                         /* invalid characters */
 370                         return -1;
 371                 }
 372                 val = xdigit2val(c);
 373                 for (j = 0; j < BITS_PER_HEX && idx < RTE_MAX_LCORE; j++, idx++)
 374                 {
 375                         if ((1 << j) & val) {
 376                                 if (!lcore_config[idx].detected) {
 377                                         RTE_LOG(ERR, EAL, "lcore %u "
 378                                                 "unavailable\n", idx);
 379                                         return -1;
 380                                 }
 381                                 cfg->lcore_role[idx] = ROLE_RTE;
 382                                 lcore_config[idx].core_index = count;
 383                                 count++;
 384                         } else {
 385                                 cfg->lcore_role[idx] = ROLE_OFF;
 386                                 lcore_config[idx].core_index = -1;
 387                         }
 388                 }
 389         }
 390         for (; i >= 0; i--)
 391                 if (coremask[i] != '0')
 392                         return -1;
 393         for (; idx < RTE_MAX_LCORE; idx++) {
 394                 cfg->lcore_role[idx] = ROLE_OFF;
 395                 lcore_config[idx].core_index = -1;
 396         }
 397         if (count == 0)
 398                 return -1;
 399         /* Update the count of enabled logical cores of the EAL configuration */
 400         cfg->lcore_count = count;
 401         return 0;
 402 }
 403
 404 static int
 405 eal_parse_corelist(const char *corelist)
 406 {
 407         struct rte_config *cfg = rte_eal_get_configuration();
 408         int i, idx = 0;
 409         unsigned count = 0;
 410         char *end = NULL;
 411         int min, max;
 412
 413         if (corelist == NULL)
 414                 return -1;
 415
 416         /* Remove all blank characters ahead and after */
 417         while (isblank(*corelist))
 418                 corelist++;
 419         i = strlen(corelist);
 420         while ((i > 0) && isblank(corelist[i - 1]))
 421                 i--;
 422
 423         /* Reset config */
 424         for (idx = 0; idx < RTE_MAX_LCORE; idx++) {
 425                 cfg->lcore_role[idx] = ROLE_OFF;
 426                 lcore_config[idx].core_index = -1;
 427         }
 428
 429         /* Get list of cores */
 430         min = RTE_MAX_LCORE;
 431         do {
 432                 while (isblank(*corelist))
 433                         corelist++;
 434                 if (*corelist == '\0')
 435                         return -1;
 436                 errno = 0;
 437                 idx = strtoul(corelist, &end, 10);
 438                 if (errno || end == NULL)
 439                         return -1;
 440                 while (isblank(*end))
 441                         end++;
 442                 if (*end == '-') {
 443                         min = idx;
 444                 } else if ((*end == ',') || (*end == '\0')) {
 445                         max = idx;
 446                         if (min == RTE_MAX_LCORE)
 447                                 min = idx;
 448                         for (idx = min; idx <= max; idx++) {
 449                                 if (cfg->lcore_role[idx] != ROLE_RTE) {
 450                                         cfg->lcore_role[idx] = ROLE_RTE;
 451                                         lcore_config[idx].core_index = count;
 452                                         count++;
 453                                 }
 454                         }
 455                         min = RTE_MAX_LCORE;
 456                 } else
 457                         return -1;
 458                 corelist = end + 1;
 459         } while (*end != '\0');
 460
 461         if (count == 0)
 462                 return -1;
 463
 464         /* Update the count of enabled logical cores of the EAL configuration */
 465         cfg->lcore_count = count;
 466
 467         return 0;
 468 }
 469
 470 /* Changes the lcore id of the master thread */
 471 static int
 472 eal_parse_master_lcore(const char *arg)
 473 {
 474         char *parsing_end;
 475         struct rte_config *cfg = rte_eal_get_configuration();
 476
 477         errno = 0;
 478         cfg->master_lcore = (uint32_t) strtol(arg, &parsing_end, 0);
 479         if (errno || parsing_end[0] != 0)
 480                 return -1;
 481         if (cfg->master_lcore >= RTE_MAX_LCORE)
 482                 return -1;
 483         master_lcore_parsed = 1;
 484
 485         /* ensure master core is not used as service core */
 486         if (lcore_config[cfg->master_lcore].core_role == ROLE_SERVICE) {
 487                 RTE_LOG(ERR, EAL, "Error: Master lcore is used as a service core.\n");
 488                 return -1;
 489         }
 490
 491         return 0;
 492 }
 493
 494 /*
 495  * Parse elem, the elem could be single number/range or '(' ')' group
 496  * 1) A single number elem, it's just a simple digit. e.g. 9
 497  * 2) A single range elem, two digits with a '-' between. e.g. 2-6
 498  * 3) A group elem, combines multiple 1) or 2) with '( )'. e.g (0,2-4,6)
 499  *    Within group elem, '-' used for a range separator;
 500  *                       ',' used for a single number.
 501  */
 502 static int
 503 eal_parse_set(const char *input, uint16_t set[], unsigned num)
 504 {
 505         unsigned idx;
 506         const char *str = input;
 507         char *end = NULL;
 508         unsigned min, max;
 509
 510         memset(set, 0, num * sizeof(uint16_t));
 511
 512         while (isblank(*str))
 513                 str++;
 514
 515         /* only digit or left bracket is qualify for start point */
 516         if ((!isdigit(*str) && *str != '(') || *str == '\0')
 517                 return -1;
 518
 519         /* process single number or single range of number */
 520         if (*str != '(') {
 521                 errno = 0;
 522                 idx = strtoul(str, &end, 10);
 523                 if (errno || end == NULL || idx >= num)
 524                         return -1;
 525                 else {
 526                         while (isblank(*end))
 527                                 end++;
 528
 529                         min = idx;
 530                         max = idx;
 531                         if (*end == '-') {
 532                                 /* process single <number>-<number> */
 533                                 end++;
 534                                 while (isblank(*end))
 535                                         end++;
 536                                 if (!isdigit(*end))
 537                                         return -1;
 538
 539                                 errno = 0;
 540                                 idx = strtoul(end, &end, 10);
 541                                 if (errno || end == NULL || idx >= num)
 542                                         return -1;
 543                                 max = idx;
 544                                 while (isblank(*end))
 545                                         end++;
 546                                 if (*end != ',' && *end != '\0')
 547                                         return -1;
 548                         }
 549
 550                         if (*end != ',' && *end != '\0' &&
 551                             *end != '@')
 552                                 return -1;
 553
 554                         for (idx = RTE_MIN(min, max);
 555                              idx <= RTE_MAX(min, max); idx++)
 556                                 set[idx] = 1;
 557
 558                         return end - input;
 559                 }
 560         }
 561
 562         /* process set within bracket */
 563         str++;
 564         while (isblank(*str))
 565                 str++;
 566         if (*str == '\0')
 567                 return -1;
 568
 569         min = RTE_MAX_LCORE;
 570         do {
 571
 572                 /* go ahead to the first digit */
 573                 while (isblank(*str))
 574                         str++;
 575                 if (!isdigit(*str))
 576                         return -1;
 577
 578                 /* get the digit value */
 579                 errno = 0;
 580                 idx = strtoul(str, &end, 10);
 581                 if (errno || end == NULL || idx >= num)
 582                         return -1;
 583
 584                 /* go ahead to separator '-',',' and ')' */
 585                 while (isblank(*end))
 586                         end++;
 587                 if (*end == '-') {
 588                         if (min == RTE_MAX_LCORE)
 589                                 min = idx;
 590                         else /* avoid continuous '-' */
 591                                 return -1;
 592                 } else if ((*end == ',') || (*end == ')')) {
 593                         max = idx;
 594                         if (min == RTE_MAX_LCORE)
 595                                 min = idx;
 596                         for (idx = RTE_MIN(min, max);
 597                              idx <= RTE_MAX(min, max); idx++)
 598                                 set[idx] = 1;
 599
 600                         min = RTE_MAX_LCORE;
 601                 } else
 602                         return -1;
 603
 604                 str = end + 1;
 605         } while (*end != '\0' && *end != ')');
 606
 607         /*
 608          * to avoid failure that tail blank makes end character check fail
 609          * in eal_parse_lcores( )
 610          */
 611         while (isblank(*str))
 612                 str++;
 613
 614         return str - input;
 615 }
 616
 617 /* convert from set array to cpuset bitmap */
 618 static int
 619 convert_to_cpuset(rte_cpuset_t *cpusetp,
 620               uint16_t *set, unsigned num)
 621 {
 622         unsigned idx;
 623
 624         CPU_ZERO(cpusetp);
 625
 626         for (idx = 0; idx < num; idx++) {
 627                 if (!set[idx])
 628                         continue;
 629
 630                 if (!lcore_config[idx].detected) {
 631                         RTE_LOG(ERR, EAL, "core %u "
 632                                 "unavailable\n", idx);
 633                         return -1;
 634                 }
 635
 636                 CPU_SET(idx, cpusetp);
 637         }
 638
 639         return 0;
 640 }
 641
 642 /*
 643  * The format pattern: --lcores='<lcores[@cpus]>[<,lcores[@cpus]>...]'
 644  * lcores, cpus could be a single digit/range or a group.
 645  * '(' and ')' are necessary if it's a group.
 646  * If not supply '@cpus', the value of cpus uses the same as lcores.
 647  * e.g. '1,2@(5-7),(3-5)@(0,2),(0,6),7-8' means start 9 EAL thread as below
 648  *   lcore 0 runs on cpuset 0x41 (cpu 0,6)
 649  *   lcore 1 runs on cpuset 0x2 (cpu 1)
 650  *   lcore 2 runs on cpuset 0xe0 (cpu 5,6,7)
 651  *   lcore 3,4,5 runs on cpuset 0x5 (cpu 0,2)
 652  *   lcore 6 runs on cpuset 0x41 (cpu 0,6)
 653  *   lcore 7 runs on cpuset 0x80 (cpu 7)
 654  *   lcore 8 runs on cpuset 0x100 (cpu 8)
 655  */
 656 static int
 657 eal_parse_lcores(const char *lcores)
 658 {
 659         struct rte_config *cfg = rte_eal_get_configuration();
 660         static uint16_t set[RTE_MAX_LCORE];
 661         unsigned idx = 0;
 662         unsigned count = 0;
 663         const char *lcore_start = NULL;
 664         const char *end = NULL;
 665         int offset;
 666         rte_cpuset_t cpuset;
 667         int lflags;
 668         int ret = -1;
 669
 670         if (lcores == NULL)
 671                 return -1;
 672
 673         /* Remove all blank characters ahead and after */
 674         while (isblank(*lcores))
 675                 lcores++;
 676
 677         CPU_ZERO(&cpuset);
 678
 679         /* Reset lcore config */
 680         for (idx = 0; idx < RTE_MAX_LCORE; idx++) {
 681                 cfg->lcore_role[idx] = ROLE_OFF;
 682                 lcore_config[idx].core_index = -1;
 683                 CPU_ZERO(&lcore_config[idx].cpuset);
 684         }
 685
 686         /* Get list of cores */
 687         do {
 688                 while (isblank(*lcores))
 689                         lcores++;
 690                 if (*lcores == '\0')
 691                         goto err;
 692
 693                 lflags = 0;
 694
 695                 /* record lcore_set start point */
 696                 lcore_start = lcores;
 697
 698                 /* go across a complete bracket */
 699                 if (*lcore_start == '(') {
 700                         lcores += strcspn(lcores, ")");
 701                         if (*lcores++ == '\0')
 702                                 goto err;
 703                 }
 704
 705                 /* scan the separator '@', ','(next) or '\0'(finish) */
 706                 lcores += strcspn(lcores, "@,");
 707
 708                 if (*lcores == '@') {
 709                         /* explicit assign cpu_set */
 710                         offset = eal_parse_set(lcores + 1, set, RTE_DIM(set));
 711                         if (offset < 0)
 712                                 goto err;
 713
 714                         /* prepare cpu_set and update the end cursor */
 715                         if (0 > convert_to_cpuset(&cpuset,
 716                                                   set, RTE_DIM(set)))
 717                                 goto err;
 718                         end = lcores + 1 + offset;
 719                 } else { /* ',' or '\0' */
 720                         /* haven't given cpu_set, current loop done */
 721                         end = lcores;
 722
 723                         /* go back to check <number>-<number> */
 724                         offset = strcspn(lcore_start, "(-");
 725                         if (offset < (end - lcore_start) &&
 726                             *(lcore_start + offset) != '(')
 727                                 lflags = 1;
 728                 }
 729
 730                 if (*end != ',' && *end != '\0')
 731                         goto err;
 732
 733                 /* parse lcore_set from start point */
 734                 if (0 > eal_parse_set(lcore_start, set, RTE_DIM(set)))
 735                         goto err;
 736
 737                 /* without '@', by default using lcore_set as cpu_set */
 738                 if (*lcores != '@' &&
 739                     0 > convert_to_cpuset(&cpuset, set, RTE_DIM(set)))
 740                         goto err;
 741
 742                 /* start to update lcore_set */
 743                 for (idx = 0; idx < RTE_MAX_LCORE; idx++) {
 744                         if (!set[idx])
 745                                 continue;
 746
 747                         if (cfg->lcore_role[idx] != ROLE_RTE) {
 748                                 lcore_config[idx].core_index = count;
 749                                 cfg->lcore_role[idx] = ROLE_RTE;
 750                                 count++;
 751                         }
 752
 753                         if (lflags) {
 754                                 CPU_ZERO(&cpuset);
 755                                 CPU_SET(idx, &cpuset);
 756                         }
 757                         rte_memcpy(&lcore_config[idx].cpuset, &cpuset,
 758                                    sizeof(rte_cpuset_t));
 759                 }
 760
 761                 lcores = end + 1;
 762         } while (*end != '\0');
 763
 764         if (count == 0)
 765                 goto err;
 766
 767         cfg->lcore_count = count;
 768         ret = 0;
 769
 770 err:
 771
 772         return ret;
 773 }
 774
 775 static int
 776 eal_parse_syslog(const char *facility, struct internal_config *conf)
 777 {
 778         int i;
 779         static struct {
 780                 const char *name;
 781                 int value;
 782         } map[] = {
 783                 { "auth", LOG_AUTH },
 784                 { "cron", LOG_CRON },
 785                 { "daemon", LOG_DAEMON },
 786                 { "ftp", LOG_FTP },
 787                 { "kern", LOG_KERN },
 788                 { "lpr", LOG_LPR },
 789                 { "mail", LOG_MAIL },
 790                 { "news", LOG_NEWS },
 791                 { "syslog", LOG_SYSLOG },
 792                 { "user", LOG_USER },
 793                 { "uucp", LOG_UUCP },
 794                 { "local0", LOG_LOCAL0 },
 795                 { "local1", LOG_LOCAL1 },
 796                 { "local2", LOG_LOCAL2 },
 797                 { "local3", LOG_LOCAL3 },
 798                 { "local4", LOG_LOCAL4 },
 799                 { "local5", LOG_LOCAL5 },
 800                 { "local6", LOG_LOCAL6 },
 801                 { "local7", LOG_LOCAL7 },
 802                 { NULL, 0 }
 803         };
 804
 805         for (i = 0; map[i].name; i++) {
 806                 if (!strcmp(facility, map[i].name)) {
 807                         conf->syslog_facility = map[i].value;
 808                         return 0;
 809                 }
 810         }
 811         return -1;
 812 }
 813
 814 static int
 815 eal_parse_log_level(const char *arg)
 816 {
 817         char *end, *str, *type, *level;
 818         unsigned long tmp;
 819
 820         str = strdup(arg);
 821         if (str == NULL)
 822                 return -1;
 823
 824         if (strchr(str, ',') == NULL) {
 825                 type = NULL;
 826                 level = str;
 827         } else {
 828                 type = strsep(&str, ",");
 829                 level = strsep(&str, ",");
 830         }
 831
 832         errno = 0;
 833         tmp = strtoul(level, &end, 0);
 834
 835         /* check for errors */
 836         if ((errno != 0) || (level[0] == '\0') ||
 837                     end == NULL || (*end != '\0'))
 838                 goto fail;
 839
 840         /* log_level is a uint32_t */
 841         if (tmp >= UINT32_MAX)
 842                 goto fail;
 843
 844         if (type == NULL) {
 845                 rte_log_set_global_level(tmp);
 846         } else if (rte_log_set_level_regexp(type, tmp) < 0) {
 847                 printf("cannot set log level %s,%lu\n",
 848                         type, tmp);
 849                 goto fail;
 850         }
 851
 852         free(str);
 853         return 0;
 854
 855 fail:
 856         free(str);
 857         return -1;
 858 }
 859
 860 static enum rte_proc_type_t
 861 eal_parse_proc_type(const char *arg)
 862 {
 863         if (strncasecmp(arg, "primary", sizeof("primary")) == 0)
 864                 return RTE_PROC_PRIMARY;
 865         if (strncasecmp(arg, "secondary", sizeof("secondary")) == 0)
 866                 return RTE_PROC_SECONDARY;
 867         if (strncasecmp(arg, "auto", sizeof("auto")) == 0)
 868                 return RTE_PROC_AUTO;
 869
 870         return RTE_PROC_INVALID;
 871 }
 872
 873 int
 874 eal_parse_common_option(int opt, const char *optarg,
 875                         struct internal_config *conf)
 876 {
 877         switch (opt) {
 878         /* blacklist */
 879         case 'b':
 880                 if (rte_eal_devargs_add(RTE_DEVTYPE_BLACKLISTED,
 881                                 optarg) < 0) {
 882                         return -1;
 883                 }
 884                 break;
 885         /* whitelist */
 886         case 'w':
 887                 if (rte_eal_devargs_add(RTE_DEVTYPE_WHITELISTED,
 888                                 optarg) < 0) {
 889                         return -1;
 890                 }
 891                 break;
 892         /* coremask */
 893         case 'c':
 894                 if (eal_parse_coremask(optarg) < 0) {
 895                         RTE_LOG(ERR, EAL, "invalid coremask\n");
 896                         return -1;
 897                 }
 898                 core_parsed = 1;
 899                 break;
 900         /* corelist */
 901         case 'l':
 902                 if (eal_parse_corelist(optarg) < 0) {
 903                         RTE_LOG(ERR, EAL, "invalid core list\n");
 904                         return -1;
 905                 }
 906                 core_parsed = 1;
 907                 break;
 908         /* service coremask */
 909         case 's':
 910                 if (eal_parse_service_coremask(optarg) < 0) {
 911                         RTE_LOG(ERR, EAL, "invalid service coremask\n");
 912                         return -1;
 913                 }
 914                 break;
 915         /* size of memory */
 916         case 'm':
 917                 conf->memory = atoi(optarg);
 918                 conf->memory *= 1024ULL;
 919                 conf->memory *= 1024ULL;
 920                 mem_parsed = 1;
 921                 break;
 922         /* force number of channels */
 923         case 'n':
 924                 conf->force_nchannel = atoi(optarg);
 925                 if (conf->force_nchannel == 0) {
 926                         RTE_LOG(ERR, EAL, "invalid channel number\n");
 927                         return -1;
 928                 }
 929                 break;
 930         /* force number of ranks */
 931         case 'r':
 932                 conf->force_nrank = atoi(optarg);
 933                 if (conf->force_nrank == 0 ||
 934                     conf->force_nrank > 16) {
 935                         RTE_LOG(ERR, EAL, "invalid rank number\n");
 936                         return -1;
 937                 }
 938                 break;
 939         /* force loading of external driver */
 940         case 'd':
 941                 if (eal_plugin_add(optarg) == -1)
 942                         return -1;
 943                 break;
 944         case 'v':
 945                 /* since message is explicitly requested by user, we
 946                  * write message at highest log level so it can always
 947                  * be seen
 948                  * even if info or warning messages are disabled */
 949                 RTE_LOG(CRIT, EAL, "RTE Version: '%s'\n", rte_version());
 950                 break;
 951
 952         /* long options */
 953         case OPT_HUGE_UNLINK_NUM:
 954                 conf->hugepage_unlink = 1;
 955                 break;
 956
 957         case OPT_NO_HUGE_NUM:
 958                 conf->no_hugetlbfs = 1;
 959                 break;
 960
 961         case OPT_NO_PCI_NUM:
 962                 conf->no_pci = 1;
 963                 break;
 964
 965         case OPT_NO_HPET_NUM:
 966                 conf->no_hpet = 1;
 967                 break;
 968
 969         case OPT_VMWARE_TSC_MAP_NUM:
 970                 conf->vmware_tsc_map = 1;
 971                 break;
 972
 973         case OPT_NO_SHCONF_NUM:
 974                 conf->no_shconf = 1;
 975                 break;
 976
 977         case OPT_PROC_TYPE_NUM:
 978                 conf->process_type = eal_parse_proc_type(optarg);
 979                 break;
 980
 981         case OPT_MASTER_LCORE_NUM:
 982                 if (eal_parse_master_lcore(optarg) < 0) {
 983                         RTE_LOG(ERR, EAL, "invalid parameter for --"
 984                                         OPT_MASTER_LCORE "\n");
 985                         return -1;
 986                 }
 987                 break;
 988
 989         case OPT_VDEV_NUM:
 990                 if (rte_eal_devargs_add(RTE_DEVTYPE_UNDEFINED,
 991                                 optarg) < 0) {
 992                         return -1;
 993                 }
 994                 break;
 995
 996         case OPT_SYSLOG_NUM:
 997                 if (eal_parse_syslog(optarg, conf) < 0) {
 998                         RTE_LOG(ERR, EAL, "invalid parameters for --"
 999                                         OPT_SYSLOG "\n");
1000                         return -1;
1001                 }
1002                 break;
1003
1004         case OPT_LOG_LEVEL_NUM: {
1005                 if (eal_parse_log_level(optarg) < 0) {
1006                         RTE_LOG(ERR, EAL,
1007                                 "invalid parameters for --"
1008                                 OPT_LOG_LEVEL "\n");
1009                         return -1;
1010                 }
1011                 break;
1012         }
1013         case OPT_LCORES_NUM:
1014                 if (eal_parse_lcores(optarg) < 0) {
1015                         RTE_LOG(ERR, EAL, "invalid parameter for --"
1016                                 OPT_LCORES "\n");
1017                         return -1;
1018                 }
1019                 core_parsed = 1;
1020                 break;
1021
1022         /* don't know what to do, leave this to caller */
1023         default:
1024                 return 1;
1025
1026         }
1027
1028         return 0;
1029 }
1030
1031 static void
1032 eal_auto_detect_cores(struct rte_config *cfg)
1033 {
1034         unsigned int lcore_id;
1035         unsigned int removed = 0;
1036         rte_cpuset_t affinity_set;
1037         pthread_t tid = pthread_self();
1038
1039         if (pthread_getaffinity_np(tid, sizeof(rte_cpuset_t),
1040                                 &affinity_set) < 0)
1041                 CPU_ZERO(&affinity_set);
1042
1043         for (lcore_id = 0; lcore_id < RTE_MAX_LCORE; lcore_id++) {
1044                 if (cfg->lcore_role[lcore_id] == ROLE_RTE &&
1045                     !CPU_ISSET(lcore_id, &affinity_set)) {
1046                         cfg->lcore_role[lcore_id] = ROLE_OFF;
1047                         removed++;
1048                 }
1049         }
1050
1051         cfg->lcore_count -= removed;
1052 }
1053
1054 int
1055 eal_adjust_config(struct internal_config *internal_cfg)
1056 {
1057         int i;
1058         struct rte_config *cfg = rte_eal_get_configuration();
1059
1060         if (!core_parsed)
1061                 eal_auto_detect_cores(cfg);
1062
1063         if (internal_config.process_type == RTE_PROC_AUTO)
1064                 internal_config.process_type = eal_proc_type_detect();
1065
1066         /* default master lcore is the first one */
1067         if (!master_lcore_parsed) {
1068                 cfg->master_lcore = rte_get_next_lcore(-1, 0, 0);
1069                 lcore_config[cfg->master_lcore].core_role = ROLE_RTE;
1070         }
1071
1072         /* if no memory amounts were requested, this will result in 0 and
1073          * will be overridden later, right after eal_hugepage_info_init() */
1074         for (i = 0; i < RTE_MAX_NUMA_NODES; i++)
1075                 internal_cfg->memory += internal_cfg->socket_mem[i];
1076
1077         return 0;
1078 }
1079
1080 int
1081 eal_check_common_options(struct internal_config *internal_cfg)
1082 {
1083         struct rte_config *cfg = rte_eal_get_configuration();
1084
1085         if (cfg->lcore_role[cfg->master_lcore] != ROLE_RTE) {
1086                 RTE_LOG(ERR, EAL, "Master lcore is not enabled for DPDK\n");
1087                 return -1;
1088         }
1089
1090         if (internal_cfg->process_type == RTE_PROC_INVALID) {
1091                 RTE_LOG(ERR, EAL, "Invalid process type specified\n");
1092                 return -1;
1093         }
1094         if (index(internal_cfg->hugefile_prefix, '%') != NULL) {
1095                 RTE_LOG(ERR, EAL, "Invalid char, '%%', in --"OPT_FILE_PREFIX" "
1096                         "option\n");
1097                 return -1;
1098         }
1099         if (mem_parsed && internal_cfg->force_sockets == 1) {
1100                 RTE_LOG(ERR, EAL, "Options -m and --"OPT_SOCKET_MEM" cannot "
1101                         "be specified at the same time\n");
1102                 return -1;
1103         }
1104         if (internal_cfg->no_hugetlbfs && internal_cfg->force_sockets == 1) {
1105                 RTE_LOG(ERR, EAL, "Option --"OPT_SOCKET_MEM" cannot "
1106                         "be specified together with --"OPT_NO_HUGE"\n");
1107                 return -1;
1108         }
1109
1110         if (internal_cfg->no_hugetlbfs && internal_cfg->hugepage_unlink) {
1111                 RTE_LOG(ERR, EAL, "Option --"OPT_HUGE_UNLINK" cannot "
1112                         "be specified together with --"OPT_NO_HUGE"\n");
1113                 return -1;
1114         }
1115
1116         return 0;
1117 }
1118
1119 void
1120 eal_common_usage(void)
1121 {
1122         printf("[options]\n\n"
1123                "EAL common options:\n"
1124                "  -c COREMASK         Hexadecimal bitmask of cores to run on\n"
1125                "  -l CORELIST         List of cores to run on\n"
1126                "                      The argument format is <c1>[-c2][,c3[-c4],...]\n"
1127                "                      where c1, c2, etc are core indexes between 0 and %d\n"
1128                "  --"OPT_LCORES" COREMAP    Map lcore set to physical cpu set\n"
1129                "                      The argument format is\n"
1130                "                            '<lcores[@cpus]>[<,lcores[@cpus]>...]'\n"
1131                "                      lcores and cpus list are grouped by '(' and ')'\n"
1132                "                      Within the group, '-' is used for range separator,\n"
1133                "                      ',' is used for single number separator.\n"
1134                "                      '( )' can be omitted for single element group,\n"
1135                "                      '@' can be omitted if cpus and lcores have the same value\n"
1136                "  -s SERVICE COREMASK Hexadecimal bitmask of cores to be used as service cores\n"
1137                "  --"OPT_MASTER_LCORE" ID   Core ID that is used as master\n"
1138                "  -n CHANNELS         Number of memory channels\n"
1139                "  -m MB               Memory to allocate (see also --"OPT_SOCKET_MEM")\n"
1140                "  -r RANKS            Force number of memory ranks (don't detect)\n"
1141                "  -b, --"OPT_PCI_BLACKLIST" Add a PCI device in black list.\n"
1142                "                      Prevent EAL from using this PCI device. The argument\n"
1143                "                      format is <domain:bus:devid.func>.\n"
1144                "  -w, --"OPT_PCI_WHITELIST" Add a PCI device in white list.\n"
1145                "                      Only use the specified PCI devices. The argument format\n"
1146                "                      is <[domain:]bus:devid.func>. This option can be present\n"
1147                "                      several times (once per device).\n"
1148                "                      [NOTE: PCI whitelist cannot be used with -b option]\n"
1149                "  --"OPT_VDEV"              Add a virtual device.\n"
1150                "                      The argument format is <driver><id>[,key=val,...]\n"
1151                "                      (ex: --vdev=net_pcap0,iface=eth2).\n"
1152                "  -d LIB.so|DIR       Add a driver or driver directory\n"
1153                "                      (can be used multiple times)\n"
1154                "  --"OPT_VMWARE_TSC_MAP"    Use VMware TSC map instead of native RDTSC\n"
1155                "  --"OPT_PROC_TYPE"         Type of this process (primary|secondary|auto)\n"
1156                "  --"OPT_SYSLOG"            Set syslog facility\n"
1157                "  --"OPT_LOG_LEVEL"=<int>   Set global log level\n"
1158                "  --"OPT_LOG_LEVEL"=<type-regexp>,<int>\n"
1159                "                      Set specific log level\n"
1160                "  -v                  Display version information on startup\n"
1161                "  -h, --help          This help\n"
1162                "\nEAL options for DEBUG use only:\n"
1163                "  --"OPT_HUGE_UNLINK"       Unlink hugepage files after init\n"
1164                "  --"OPT_NO_HUGE"           Use malloc instead of hugetlbfs\n"
1165                "  --"OPT_NO_PCI"            Disable PCI\n"
1166                "  --"OPT_NO_HPET"           Disable HPET\n"
1167                "  --"OPT_NO_SHCONF"         No shared config (mmap'd files)\n"
1168                "\n", RTE_MAX_LCORE);
1169 }