4 * Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
5 * Copyright(c) 2014 6WIND S.A.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
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
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.
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.
45 #include <rte_lcore.h>
46 #include <rte_version.h>
47 #include <rte_devargs.h>
49 #include "eal_internal_cfg.h"
50 #include "eal_options.h"
51 #include "eal_filesystem.h"
53 #define BITS_PER_HEX 4
57 "b:" /* pci-blacklist */
62 "m:" /* memory size */
63 "n:" /* memory channels */
64 "r:" /* memory ranks */
66 "w:" /* pci-whitelist */
70 eal_long_options[] = {
71 {OPT_BASE_VIRTADDR, 1, NULL, OPT_BASE_VIRTADDR_NUM },
72 {OPT_CREATE_UIO_DEV, 1, NULL, OPT_CREATE_UIO_DEV_NUM },
73 {OPT_FILE_PREFIX, 1, NULL, OPT_FILE_PREFIX_NUM },
74 {OPT_HELP, 0, NULL, OPT_HELP_NUM },
75 {OPT_HUGE_DIR, 1, NULL, OPT_HUGE_DIR_NUM },
76 {OPT_LOG_LEVEL, 1, NULL, OPT_LOG_LEVEL_NUM },
77 {OPT_MASTER_LCORE, 1, NULL, OPT_MASTER_LCORE_NUM },
78 {OPT_NO_HPET, 0, NULL, OPT_NO_HPET_NUM },
79 {OPT_NO_HUGE, 0, NULL, OPT_NO_HUGE_NUM },
80 {OPT_NO_PCI, 0, NULL, OPT_NO_PCI_NUM },
81 {OPT_NO_SHCONF, 0, NULL, OPT_NO_SHCONF_NUM },
82 {OPT_PCI_BLACKLIST, 1, NULL, OPT_PCI_BLACKLIST_NUM },
83 {OPT_PCI_WHITELIST, 1, NULL, OPT_PCI_WHITELIST_NUM },
84 {OPT_PROC_TYPE, 1, NULL, OPT_PROC_TYPE_NUM },
85 {OPT_SOCKET_MEM, 1, NULL, OPT_SOCKET_MEM_NUM },
86 {OPT_SYSLOG, 1, NULL, OPT_SYSLOG_NUM },
87 {OPT_VDEV, 1, NULL, OPT_VDEV_NUM },
88 {OPT_VFIO_INTR, 1, NULL, OPT_VFIO_INTR_NUM },
89 {OPT_VMWARE_TSC_MAP, 0, NULL, OPT_VMWARE_TSC_MAP_NUM },
90 {OPT_XEN_DOM0, 0, NULL, OPT_XEN_DOM0_NUM },
94 static int lcores_parsed;
95 static int master_lcore_parsed;
96 static int mem_parsed;
99 eal_reset_internal_config(struct internal_config *internal_cfg)
103 internal_cfg->memory = 0;
104 internal_cfg->force_nrank = 0;
105 internal_cfg->force_nchannel = 0;
106 internal_cfg->hugefile_prefix = HUGEFILE_PREFIX_DEFAULT;
107 internal_cfg->hugepage_dir = NULL;
108 internal_cfg->force_sockets = 0;
109 /* zero out the NUMA config */
110 for (i = 0; i < RTE_MAX_NUMA_NODES; i++)
111 internal_cfg->socket_mem[i] = 0;
112 /* zero out hugedir descriptors */
113 for (i = 0; i < MAX_HUGEPAGE_SIZES; i++)
114 internal_cfg->hugepage_info[i].lock_descriptor = -1;
115 internal_cfg->base_virtaddr = 0;
117 internal_cfg->syslog_facility = LOG_DAEMON;
118 /* default value from build option */
119 internal_cfg->log_level = RTE_LOG_LEVEL;
121 internal_cfg->xen_dom0_support = 0;
123 /* if set to NONE, interrupt mode is determined automatically */
124 internal_cfg->vfio_intr_mode = RTE_INTR_MODE_NONE;
126 #ifdef RTE_LIBEAL_USE_HPET
127 internal_cfg->no_hpet = 0;
129 internal_cfg->no_hpet = 1;
131 internal_cfg->vmware_tsc_map = 0;
135 * Parse the coremask given as argument (hexadecimal string) and fill
136 * the global configuration (core role and core count) with the parsed
139 static int xdigit2val(unsigned char c)
153 eal_parse_coremask(const char *coremask)
155 struct rte_config *cfg = rte_eal_get_configuration();
161 if (coremask == NULL)
163 /* Remove all blank characters ahead and after .
164 * Remove 0x/0X if exists.
166 while (isblank(*coremask))
168 if (coremask[0] == '0' && ((coremask[1] == 'x')
169 || (coremask[1] == 'X')))
171 i = strnlen(coremask, PATH_MAX);
172 while ((i > 0) && isblank(coremask[i - 1]))
177 for (i = i - 1; i >= 0 && idx < RTE_MAX_LCORE; i--) {
179 if (isxdigit(c) == 0) {
180 /* invalid characters */
184 for (j = 0; j < BITS_PER_HEX && idx < RTE_MAX_LCORE; j++, idx++)
186 if ((1 << j) & val) {
187 if (!lcore_config[idx].detected) {
188 RTE_LOG(ERR, EAL, "lcore %u "
189 "unavailable\n", idx);
192 cfg->lcore_role[idx] = ROLE_RTE;
193 lcore_config[idx].core_index = count;
196 cfg->lcore_role[idx] = ROLE_OFF;
197 lcore_config[idx].core_index = -1;
202 if (coremask[i] != '0')
204 for (; idx < RTE_MAX_LCORE; idx++) {
205 cfg->lcore_role[idx] = ROLE_OFF;
206 lcore_config[idx].core_index = -1;
210 /* Update the count of enabled logical cores of the EAL configuration */
211 cfg->lcore_count = count;
217 eal_parse_corelist(const char *corelist)
219 struct rte_config *cfg = rte_eal_get_configuration();
225 if (corelist == NULL)
228 /* Remove all blank characters ahead and after */
229 while (isblank(*corelist))
231 i = strnlen(corelist, sysconf(_SC_ARG_MAX));
232 while ((i > 0) && isblank(corelist[i - 1]))
236 for (idx = 0; idx < RTE_MAX_LCORE; idx++) {
237 cfg->lcore_role[idx] = ROLE_OFF;
238 lcore_config[idx].core_index = -1;
241 /* Get list of cores */
244 while (isblank(*corelist))
246 if (*corelist == '\0')
249 idx = strtoul(corelist, &end, 10);
250 if (errno || end == NULL)
252 while (isblank(*end))
256 } else if ((*end == ',') || (*end == '\0')) {
258 if (min == RTE_MAX_LCORE)
260 for (idx = min; idx <= max; idx++) {
261 cfg->lcore_role[idx] = ROLE_RTE;
262 lcore_config[idx].core_index = count;
269 } while (*end != '\0');
274 /* Update the count of enabled logical cores of the EAL configuration */
275 cfg->lcore_count = count;
281 /* Changes the lcore id of the master thread */
283 eal_parse_master_lcore(const char *arg)
286 struct rte_config *cfg = rte_eal_get_configuration();
289 cfg->master_lcore = (uint32_t) strtol(arg, &parsing_end, 0);
290 if (errno || parsing_end[0] != 0)
292 if (cfg->master_lcore >= RTE_MAX_LCORE)
294 master_lcore_parsed = 1;
299 eal_parse_syslog(const char *facility, struct internal_config *conf)
306 { "auth", LOG_AUTH },
307 { "cron", LOG_CRON },
308 { "daemon", LOG_DAEMON },
310 { "kern", LOG_KERN },
312 { "mail", LOG_MAIL },
313 { "news", LOG_NEWS },
314 { "syslog", LOG_SYSLOG },
315 { "user", LOG_USER },
316 { "uucp", LOG_UUCP },
317 { "local0", LOG_LOCAL0 },
318 { "local1", LOG_LOCAL1 },
319 { "local2", LOG_LOCAL2 },
320 { "local3", LOG_LOCAL3 },
321 { "local4", LOG_LOCAL4 },
322 { "local5", LOG_LOCAL5 },
323 { "local6", LOG_LOCAL6 },
324 { "local7", LOG_LOCAL7 },
328 for (i = 0; map[i].name; i++) {
329 if (!strcmp(facility, map[i].name)) {
330 conf->syslog_facility = map[i].value;
338 eal_parse_log_level(const char *level, uint32_t *log_level)
344 tmp = strtoul(level, &end, 0);
346 /* check for errors */
347 if ((errno != 0) || (level[0] == '\0') ||
348 end == NULL || (*end != '\0'))
351 /* log_level is a uint32_t */
352 if (tmp >= UINT32_MAX)
359 static enum rte_proc_type_t
360 eal_parse_proc_type(const char *arg)
362 if (strncasecmp(arg, "primary", sizeof("primary")) == 0)
363 return RTE_PROC_PRIMARY;
364 if (strncasecmp(arg, "secondary", sizeof("secondary")) == 0)
365 return RTE_PROC_SECONDARY;
366 if (strncasecmp(arg, "auto", sizeof("auto")) == 0)
367 return RTE_PROC_AUTO;
369 return RTE_PROC_INVALID;
373 eal_parse_common_option(int opt, const char *optarg,
374 struct internal_config *conf)
379 if (rte_eal_devargs_add(RTE_DEVTYPE_BLACKLISTED_PCI,
386 if (rte_eal_devargs_add(RTE_DEVTYPE_WHITELISTED_PCI,
393 if (eal_parse_coremask(optarg) < 0) {
394 RTE_LOG(ERR, EAL, "invalid coremask\n");
400 if (eal_parse_corelist(optarg) < 0) {
401 RTE_LOG(ERR, EAL, "invalid core list\n");
407 conf->memory = atoi(optarg);
408 conf->memory *= 1024ULL;
409 conf->memory *= 1024ULL;
412 /* force number of channels */
414 conf->force_nchannel = atoi(optarg);
415 if (conf->force_nchannel == 0 ||
416 conf->force_nchannel > 4) {
417 RTE_LOG(ERR, EAL, "invalid channel number\n");
421 /* force number of ranks */
423 conf->force_nrank = atoi(optarg);
424 if (conf->force_nrank == 0 ||
425 conf->force_nrank > 16) {
426 RTE_LOG(ERR, EAL, "invalid rank number\n");
431 /* since message is explicitly requested by user, we
432 * write message at highest log level so it can always
434 * even if info or warning messages are disabled */
435 RTE_LOG(CRIT, EAL, "RTE Version: '%s'\n", rte_version());
439 case OPT_NO_HUGE_NUM:
440 conf->no_hugetlbfs = 1;
447 case OPT_NO_HPET_NUM:
451 case OPT_VMWARE_TSC_MAP_NUM:
452 conf->vmware_tsc_map = 1;
455 case OPT_NO_SHCONF_NUM:
459 case OPT_PROC_TYPE_NUM:
460 conf->process_type = eal_parse_proc_type(optarg);
463 case OPT_MASTER_LCORE_NUM:
464 if (eal_parse_master_lcore(optarg) < 0) {
465 RTE_LOG(ERR, EAL, "invalid parameter for --"
466 OPT_MASTER_LCORE "\n");
472 if (rte_eal_devargs_add(RTE_DEVTYPE_VIRTUAL,
479 if (eal_parse_syslog(optarg, conf) < 0) {
480 RTE_LOG(ERR, EAL, "invalid parameters for --"
486 case OPT_LOG_LEVEL_NUM: {
489 if (eal_parse_log_level(optarg, &log) < 0) {
491 "invalid parameters for --"
495 conf->log_level = log;
499 /* don't know what to do, leave this to caller */
509 eal_adjust_config(struct internal_config *internal_cfg)
512 struct rte_config *cfg = rte_eal_get_configuration();
514 if (internal_config.process_type == RTE_PROC_AUTO)
515 internal_config.process_type = eal_proc_type_detect();
517 /* default master lcore is the first one */
518 if (!master_lcore_parsed)
519 cfg->master_lcore = rte_get_next_lcore(-1, 0, 0);
521 /* if no memory amounts were requested, this will result in 0 and
522 * will be overridden later, right after eal_hugepage_info_init() */
523 for (i = 0; i < RTE_MAX_NUMA_NODES; i++)
524 internal_cfg->memory += internal_cfg->socket_mem[i];
530 eal_check_common_options(struct internal_config *internal_cfg)
532 struct rte_config *cfg = rte_eal_get_configuration();
534 if (!lcores_parsed) {
535 RTE_LOG(ERR, EAL, "CPU cores must be enabled with options "
539 if (cfg->lcore_role[cfg->master_lcore] != ROLE_RTE) {
540 RTE_LOG(ERR, EAL, "Master lcore is not enabled for DPDK\n");
544 if (internal_cfg->process_type == RTE_PROC_INVALID) {
545 RTE_LOG(ERR, EAL, "Invalid process type specified\n");
548 if (internal_cfg->process_type == RTE_PROC_PRIMARY &&
549 internal_cfg->force_nchannel == 0) {
550 RTE_LOG(ERR, EAL, "Number of memory channels (-n) not "
554 if (index(internal_cfg->hugefile_prefix, '%') != NULL) {
555 RTE_LOG(ERR, EAL, "Invalid char, '%%', in --"OPT_FILE_PREFIX" "
559 if (mem_parsed && internal_cfg->force_sockets == 1) {
560 RTE_LOG(ERR, EAL, "Options -m and --"OPT_SOCKET_MEM" cannot "
561 "be specified at the same time\n");
564 if (internal_cfg->no_hugetlbfs &&
565 (mem_parsed || internal_cfg->force_sockets == 1)) {
566 RTE_LOG(ERR, EAL, "Options -m or --"OPT_SOCKET_MEM" cannot "
567 "be specified together with --"OPT_NO_HUGE"\n");
571 if (rte_eal_devargs_type_count(RTE_DEVTYPE_WHITELISTED_PCI) != 0 &&
572 rte_eal_devargs_type_count(RTE_DEVTYPE_BLACKLISTED_PCI) != 0) {
573 RTE_LOG(ERR, EAL, "Options blacklist (-b) and whitelist (-w) "
574 "cannot be used at the same time\n");
582 eal_common_usage(void)
584 printf("-c COREMASK|-l CORELIST -n CHANNELS [options]\n\n"
585 "EAL common options:\n"
586 " -c COREMASK Hexadecimal bitmask of cores to run on\n"
587 " -l CORELIST List of cores to run on\n"
588 " The argument format is <c1>[-c2][,c3[-c4],...]\n"
589 " where c1, c2, etc are core indexes between 0 and %d\n"
590 " --"OPT_MASTER_LCORE" ID Core ID that is used as master\n"
591 " -n CHANNELS Number of memory channels\n"
592 " -m MB Memory to allocate (see also --"OPT_SOCKET_MEM")\n"
593 " -r RANKS Force number of memory ranks (don't detect)\n"
594 " -b, --"OPT_PCI_BLACKLIST" Add a PCI device in black list.\n"
595 " Prevent EAL from using this PCI device. The argument\n"
596 " format is <domain:bus:devid.func>.\n"
597 " -w, --"OPT_PCI_WHITELIST" Add a PCI device in white list.\n"
598 " Only use the specified PCI devices. The argument format\n"
599 " is <[domain:]bus:devid.func>. This option can be present\n"
600 " several times (once per device).\n"
601 " [NOTE: PCI whitelist cannot be used with -b option]\n"
602 " --"OPT_VDEV" Add a virtual device.\n"
603 " The argument format is <driver><id>[,key=val,...]\n"
604 " (ex: --vdev=eth_pcap0,iface=eth2).\n"
605 " --"OPT_VMWARE_TSC_MAP" Use VMware TSC map instead of native RDTSC\n"
606 " --"OPT_PROC_TYPE" Type of this process (primary|secondary|auto)\n"
607 " --"OPT_SYSLOG" Set syslog facility\n"
608 " --"OPT_LOG_LEVEL" Set default log level\n"
609 " -v Display version information on startup\n"
610 " -h, --help This help\n"
611 "\nEAL options for DEBUG use only:\n"
612 " --"OPT_NO_HUGE" Use malloc instead of hugetlbfs\n"
613 " --"OPT_NO_PCI" Disable PCI\n"
614 " --"OPT_NO_HPET" Disable HPET\n"
615 " --"OPT_NO_SHCONF" No shared config (mmap'd files)\n"
616 "\n", RTE_MAX_LCORE);