eal: add option usage string
[dpdk.git] / lib / librte_eal / common / eal_common_options.c
1 /* SPDX-License-Identifier: BSD-3-Clause
2  * Copyright(c) 2010-2014 Intel Corporation.
3  * Copyright(c) 2014 6WIND S.A.
4  */
5
6 #include <stdlib.h>
7 #include <unistd.h>
8 #include <string.h>
9 #include <syslog.h>
10 #include <ctype.h>
11 #include <limits.h>
12 #include <errno.h>
13 #include <getopt.h>
14 #include <dlfcn.h>
15 #include <sys/types.h>
16 #include <sys/stat.h>
17 #include <dirent.h>
18
19 #include <rte_eal.h>
20 #include <rte_log.h>
21 #include <rte_lcore.h>
22 #include <rte_tailq.h>
23 #include <rte_version.h>
24 #include <rte_devargs.h>
25 #include <rte_memcpy.h>
26
27 #include "eal_internal_cfg.h"
28 #include "eal_options.h"
29 #include "eal_filesystem.h"
30 #include "eal_private.h"
31
32 #define BITS_PER_HEX 4
33 #define LCORE_OPT_LST 1
34 #define LCORE_OPT_MSK 2
35 #define LCORE_OPT_MAP 3
36
37 const char
38 eal_short_options[] =
39         "b:" /* pci-blacklist */
40         "c:" /* coremask */
41         "s:" /* service coremask */
42         "d:" /* driver */
43         "h"  /* help */
44         "l:" /* corelist */
45         "S:" /* service corelist */
46         "m:" /* memory size */
47         "n:" /* memory channels */
48         "r:" /* memory ranks */
49         "v"  /* version */
50         "w:" /* pci-whitelist */
51         ;
52
53 const struct option
54 eal_long_options[] = {
55         {OPT_BASE_VIRTADDR,     1, NULL, OPT_BASE_VIRTADDR_NUM    },
56         {OPT_CREATE_UIO_DEV,    0, NULL, OPT_CREATE_UIO_DEV_NUM   },
57         {OPT_FILE_PREFIX,       1, NULL, OPT_FILE_PREFIX_NUM      },
58         {OPT_HELP,              0, NULL, OPT_HELP_NUM             },
59         {OPT_HUGE_DIR,          1, NULL, OPT_HUGE_DIR_NUM         },
60         {OPT_HUGE_UNLINK,       0, NULL, OPT_HUGE_UNLINK_NUM      },
61         {OPT_IOVA_MODE,         1, NULL, OPT_IOVA_MODE_NUM        },
62         {OPT_LCORES,            1, NULL, OPT_LCORES_NUM           },
63         {OPT_LOG_LEVEL,         1, NULL, OPT_LOG_LEVEL_NUM        },
64         {OPT_MASTER_LCORE,      1, NULL, OPT_MASTER_LCORE_NUM     },
65         {OPT_MBUF_POOL_OPS_NAME, 1, NULL, OPT_MBUF_POOL_OPS_NAME_NUM},
66         {OPT_NO_HPET,           0, NULL, OPT_NO_HPET_NUM          },
67         {OPT_NO_HUGE,           0, NULL, OPT_NO_HUGE_NUM          },
68         {OPT_NO_PCI,            0, NULL, OPT_NO_PCI_NUM           },
69         {OPT_NO_SHCONF,         0, NULL, OPT_NO_SHCONF_NUM        },
70         {OPT_IN_MEMORY,         0, NULL, OPT_IN_MEMORY_NUM        },
71         {OPT_PCI_BLACKLIST,     1, NULL, OPT_PCI_BLACKLIST_NUM    },
72         {OPT_PCI_WHITELIST,     1, NULL, OPT_PCI_WHITELIST_NUM    },
73         {OPT_PROC_TYPE,         1, NULL, OPT_PROC_TYPE_NUM        },
74         {OPT_SOCKET_MEM,        1, NULL, OPT_SOCKET_MEM_NUM       },
75         {OPT_SOCKET_LIMIT,      1, NULL, OPT_SOCKET_LIMIT_NUM     },
76         {OPT_SYSLOG,            1, NULL, OPT_SYSLOG_NUM           },
77         {OPT_VDEV,              1, NULL, OPT_VDEV_NUM             },
78         {OPT_VFIO_INTR,         1, NULL, OPT_VFIO_INTR_NUM        },
79         {OPT_VMWARE_TSC_MAP,    0, NULL, OPT_VMWARE_TSC_MAP_NUM   },
80         {OPT_LEGACY_MEM,        0, NULL, OPT_LEGACY_MEM_NUM       },
81         {OPT_SINGLE_FILE_SEGMENTS, 0, NULL, OPT_SINGLE_FILE_SEGMENTS_NUM},
82         {OPT_MATCH_ALLOCATIONS, 0, NULL, OPT_MATCH_ALLOCATIONS_NUM},
83         {0,                     0, NULL, 0                        }
84 };
85
86 TAILQ_HEAD(shared_driver_list, shared_driver);
87
88 /* Definition for shared object drivers. */
89 struct shared_driver {
90         TAILQ_ENTRY(shared_driver) next;
91
92         char    name[PATH_MAX];
93         void*   lib_handle;
94 };
95
96 /* List of external loadable drivers */
97 static struct shared_driver_list solib_list =
98 TAILQ_HEAD_INITIALIZER(solib_list);
99
100 /* Default path of external loadable drivers */
101 static const char *default_solib_dir = RTE_EAL_PMD_PATH;
102
103 /*
104  * Stringified version of solib path used by dpdk-pmdinfo.py
105  * Note: PLEASE DO NOT ALTER THIS without making a corresponding
106  * change to usertools/dpdk-pmdinfo.py
107  */
108 static const char dpdk_solib_path[] __attribute__((used)) =
109 "DPDK_PLUGIN_PATH=" RTE_EAL_PMD_PATH;
110
111 TAILQ_HEAD(device_option_list, device_option);
112
113 struct device_option {
114         TAILQ_ENTRY(device_option) next;
115
116         enum rte_devtype type;
117         char arg[];
118 };
119
120 static struct device_option_list devopt_list =
121 TAILQ_HEAD_INITIALIZER(devopt_list);
122
123 static int master_lcore_parsed;
124 static int mem_parsed;
125 static int core_parsed;
126
127 static int
128 eal_option_device_add(enum rte_devtype type, const char *optarg)
129 {
130         struct device_option *devopt;
131         size_t optlen;
132         int ret;
133
134         optlen = strlen(optarg) + 1;
135         devopt = calloc(1, sizeof(*devopt) + optlen);
136         if (devopt == NULL) {
137                 RTE_LOG(ERR, EAL, "Unable to allocate device option\n");
138                 return -ENOMEM;
139         }
140
141         devopt->type = type;
142         ret = snprintf(devopt->arg, optlen, "%s", optarg);
143         if (ret < 0) {
144                 RTE_LOG(ERR, EAL, "Unable to copy device option\n");
145                 free(devopt);
146                 return -EINVAL;
147         }
148         TAILQ_INSERT_TAIL(&devopt_list, devopt, next);
149         return 0;
150 }
151
152 int
153 eal_option_device_parse(void)
154 {
155         struct device_option *devopt;
156         void *tmp;
157         int ret = 0;
158
159         TAILQ_FOREACH_SAFE(devopt, &devopt_list, next, tmp) {
160                 if (ret == 0) {
161                         ret = rte_devargs_add(devopt->type, devopt->arg);
162                         if (ret)
163                                 RTE_LOG(ERR, EAL, "Unable to parse device '%s'\n",
164                                         devopt->arg);
165                 }
166                 TAILQ_REMOVE(&devopt_list, devopt, next);
167                 free(devopt);
168         }
169         return ret;
170 }
171
172 const char *
173 eal_get_hugefile_prefix(void)
174 {
175         if (internal_config.hugefile_prefix != NULL)
176                 return internal_config.hugefile_prefix;
177         return HUGEFILE_PREFIX_DEFAULT;
178 }
179
180 void
181 eal_reset_internal_config(struct internal_config *internal_cfg)
182 {
183         int i;
184
185         internal_cfg->memory = 0;
186         internal_cfg->force_nrank = 0;
187         internal_cfg->force_nchannel = 0;
188         internal_cfg->hugefile_prefix = NULL;
189         internal_cfg->hugepage_dir = NULL;
190         internal_cfg->force_sockets = 0;
191         /* zero out the NUMA config */
192         for (i = 0; i < RTE_MAX_NUMA_NODES; i++)
193                 internal_cfg->socket_mem[i] = 0;
194         internal_cfg->force_socket_limits = 0;
195         /* zero out the NUMA limits config */
196         for (i = 0; i < RTE_MAX_NUMA_NODES; i++)
197                 internal_cfg->socket_limit[i] = 0;
198         /* zero out hugedir descriptors */
199         for (i = 0; i < MAX_HUGEPAGE_SIZES; i++) {
200                 memset(&internal_cfg->hugepage_info[i], 0,
201                                 sizeof(internal_cfg->hugepage_info[0]));
202                 internal_cfg->hugepage_info[i].lock_descriptor = -1;
203         }
204         internal_cfg->base_virtaddr = 0;
205
206         internal_cfg->syslog_facility = LOG_DAEMON;
207
208         /* if set to NONE, interrupt mode is determined automatically */
209         internal_cfg->vfio_intr_mode = RTE_INTR_MODE_NONE;
210
211 #ifdef RTE_LIBEAL_USE_HPET
212         internal_cfg->no_hpet = 0;
213 #else
214         internal_cfg->no_hpet = 1;
215 #endif
216         internal_cfg->vmware_tsc_map = 0;
217         internal_cfg->create_uio_dev = 0;
218         internal_cfg->iova_mode = RTE_IOVA_DC;
219         internal_cfg->user_mbuf_pool_ops_name = NULL;
220         internal_cfg->init_complete = 0;
221 }
222
223 static int
224 eal_plugin_add(const char *path)
225 {
226         struct shared_driver *solib;
227
228         solib = malloc(sizeof(*solib));
229         if (solib == NULL) {
230                 RTE_LOG(ERR, EAL, "malloc(solib) failed\n");
231                 return -1;
232         }
233         memset(solib, 0, sizeof(*solib));
234         strlcpy(solib->name, path, PATH_MAX-1);
235         solib->name[PATH_MAX-1] = 0;
236         TAILQ_INSERT_TAIL(&solib_list, solib, next);
237
238         return 0;
239 }
240
241 static int
242 eal_plugindir_init(const char *path)
243 {
244         DIR *d = NULL;
245         struct dirent *dent = NULL;
246         char sopath[PATH_MAX];
247
248         if (path == NULL || *path == '\0')
249                 return 0;
250
251         d = opendir(path);
252         if (d == NULL) {
253                 RTE_LOG(ERR, EAL, "failed to open directory %s: %s\n",
254                         path, strerror(errno));
255                 return -1;
256         }
257
258         while ((dent = readdir(d)) != NULL) {
259                 struct stat sb;
260
261                 snprintf(sopath, PATH_MAX-1, "%s/%s", path, dent->d_name);
262                 sopath[PATH_MAX-1] = 0;
263
264                 if (!(stat(sopath, &sb) == 0 && S_ISREG(sb.st_mode)))
265                         continue;
266
267                 if (eal_plugin_add(sopath) == -1)
268                         break;
269         }
270
271         closedir(d);
272         /* XXX this ignores failures from readdir() itself */
273         return (dent == NULL) ? 0 : -1;
274 }
275
276 int
277 eal_plugins_init(void)
278 {
279         struct shared_driver *solib = NULL;
280         struct stat sb;
281
282         if (*default_solib_dir != '\0' && stat(default_solib_dir, &sb) == 0 &&
283                                 S_ISDIR(sb.st_mode))
284                 eal_plugin_add(default_solib_dir);
285
286         TAILQ_FOREACH(solib, &solib_list, next) {
287
288                 if (stat(solib->name, &sb) == 0 && S_ISDIR(sb.st_mode)) {
289                         if (eal_plugindir_init(solib->name) == -1) {
290                                 RTE_LOG(ERR, EAL,
291                                         "Cannot init plugin directory %s\n",
292                                         solib->name);
293                                 return -1;
294                         }
295                 } else {
296                         RTE_LOG(DEBUG, EAL, "open shared lib %s\n",
297                                 solib->name);
298                         solib->lib_handle = dlopen(solib->name, RTLD_NOW);
299                         if (solib->lib_handle == NULL) {
300                                 RTE_LOG(ERR, EAL, "%s\n", dlerror());
301                                 return -1;
302                         }
303                 }
304
305         }
306         return 0;
307 }
308
309 /*
310  * Parse the coremask given as argument (hexadecimal string) and fill
311  * the global configuration (core role and core count) with the parsed
312  * value.
313  */
314 static int xdigit2val(unsigned char c)
315 {
316         int val;
317
318         if (isdigit(c))
319                 val = c - '0';
320         else if (isupper(c))
321                 val = c - 'A' + 10;
322         else
323                 val = c - 'a' + 10;
324         return val;
325 }
326
327 static int
328 eal_parse_service_coremask(const char *coremask)
329 {
330         struct rte_config *cfg = rte_eal_get_configuration();
331         int i, j, idx = 0;
332         unsigned int count = 0;
333         char c;
334         int val;
335         uint32_t taken_lcore_count = 0;
336
337         if (coremask == NULL)
338                 return -1;
339         /* Remove all blank characters ahead and after .
340          * Remove 0x/0X if exists.
341          */
342         while (isblank(*coremask))
343                 coremask++;
344         if (coremask[0] == '0' && ((coremask[1] == 'x')
345                 || (coremask[1] == 'X')))
346                 coremask += 2;
347         i = strlen(coremask);
348         while ((i > 0) && isblank(coremask[i - 1]))
349                 i--;
350
351         if (i == 0)
352                 return -1;
353
354         for (i = i - 1; i >= 0 && idx < RTE_MAX_LCORE; i--) {
355                 c = coremask[i];
356                 if (isxdigit(c) == 0) {
357                         /* invalid characters */
358                         return -1;
359                 }
360                 val = xdigit2val(c);
361                 for (j = 0; j < BITS_PER_HEX && idx < RTE_MAX_LCORE;
362                                 j++, idx++) {
363                         if ((1 << j) & val) {
364                                 /* handle master lcore already parsed */
365                                 uint32_t lcore = idx;
366                                 if (master_lcore_parsed &&
367                                                 cfg->master_lcore == lcore) {
368                                         RTE_LOG(ERR, EAL,
369                                                 "lcore %u is master lcore, cannot use as service core\n",
370                                                 idx);
371                                         return -1;
372                                 }
373
374                                 if (!lcore_config[idx].detected) {
375                                         RTE_LOG(ERR, EAL,
376                                                 "lcore %u unavailable\n", idx);
377                                         return -1;
378                                 }
379
380                                 if (cfg->lcore_role[idx] == ROLE_RTE)
381                                         taken_lcore_count++;
382
383                                 lcore_config[idx].core_role = ROLE_SERVICE;
384                                 count++;
385                         }
386                 }
387         }
388
389         for (; i >= 0; i--)
390                 if (coremask[i] != '0')
391                         return -1;
392
393         for (; idx < RTE_MAX_LCORE; idx++)
394                 lcore_config[idx].core_index = -1;
395
396         if (count == 0)
397                 return -1;
398
399         if (core_parsed && taken_lcore_count != count) {
400                 RTE_LOG(WARNING, EAL,
401                         "Not all service cores are in the coremask. "
402                         "Please ensure -c or -l includes service cores\n");
403         }
404
405         cfg->service_lcore_count = count;
406         return 0;
407 }
408
409 static int
410 eal_service_cores_parsed(void)
411 {
412         int idx;
413         for (idx = 0; idx < RTE_MAX_LCORE; idx++) {
414                 if (lcore_config[idx].core_role == ROLE_SERVICE)
415                         return 1;
416         }
417         return 0;
418 }
419
420 static int
421 eal_parse_coremask(const char *coremask)
422 {
423         struct rte_config *cfg = rte_eal_get_configuration();
424         int i, j, idx = 0;
425         unsigned count = 0;
426         char c;
427         int val;
428
429         if (eal_service_cores_parsed())
430                 RTE_LOG(WARNING, EAL,
431                         "Service cores parsed before dataplane cores. "
432                         "Please ensure -c is before -s or -S\n");
433
434         if (coremask == NULL)
435                 return -1;
436         /* Remove all blank characters ahead and after .
437          * Remove 0x/0X if exists.
438          */
439         while (isblank(*coremask))
440                 coremask++;
441         if (coremask[0] == '0' && ((coremask[1] == 'x')
442                 || (coremask[1] == 'X')))
443                 coremask += 2;
444         i = strlen(coremask);
445         while ((i > 0) && isblank(coremask[i - 1]))
446                 i--;
447         if (i == 0)
448                 return -1;
449
450         for (i = i - 1; i >= 0 && idx < RTE_MAX_LCORE; i--) {
451                 c = coremask[i];
452                 if (isxdigit(c) == 0) {
453                         /* invalid characters */
454                         return -1;
455                 }
456                 val = xdigit2val(c);
457                 for (j = 0; j < BITS_PER_HEX && idx < RTE_MAX_LCORE; j++, idx++)
458                 {
459                         if ((1 << j) & val) {
460                                 if (!lcore_config[idx].detected) {
461                                         RTE_LOG(ERR, EAL, "lcore %u "
462                                                 "unavailable\n", idx);
463                                         return -1;
464                                 }
465
466                                 cfg->lcore_role[idx] = ROLE_RTE;
467                                 lcore_config[idx].core_index = count;
468                                 count++;
469                         } else {
470                                 cfg->lcore_role[idx] = ROLE_OFF;
471                                 lcore_config[idx].core_index = -1;
472                         }
473                 }
474         }
475         for (; i >= 0; i--)
476                 if (coremask[i] != '0')
477                         return -1;
478         for (; idx < RTE_MAX_LCORE; idx++) {
479                 cfg->lcore_role[idx] = ROLE_OFF;
480                 lcore_config[idx].core_index = -1;
481         }
482         if (count == 0)
483                 return -1;
484         /* Update the count of enabled logical cores of the EAL configuration */
485         cfg->lcore_count = count;
486         return 0;
487 }
488
489 static int
490 eal_parse_service_corelist(const char *corelist)
491 {
492         struct rte_config *cfg = rte_eal_get_configuration();
493         int i, idx = 0;
494         unsigned count = 0;
495         char *end = NULL;
496         int min, max;
497         uint32_t taken_lcore_count = 0;
498
499         if (corelist == NULL)
500                 return -1;
501
502         /* Remove all blank characters ahead and after */
503         while (isblank(*corelist))
504                 corelist++;
505         i = strlen(corelist);
506         while ((i > 0) && isblank(corelist[i - 1]))
507                 i--;
508
509         /* Get list of cores */
510         min = RTE_MAX_LCORE;
511         do {
512                 while (isblank(*corelist))
513                         corelist++;
514                 if (*corelist == '\0')
515                         return -1;
516                 errno = 0;
517                 idx = strtoul(corelist, &end, 10);
518                 if (errno || end == NULL)
519                         return -1;
520                 while (isblank(*end))
521                         end++;
522                 if (*end == '-') {
523                         min = idx;
524                 } else if ((*end == ',') || (*end == '\0')) {
525                         max = idx;
526                         if (min == RTE_MAX_LCORE)
527                                 min = idx;
528                         for (idx = min; idx <= max; idx++) {
529                                 if (cfg->lcore_role[idx] != ROLE_SERVICE) {
530                                         /* handle master lcore already parsed */
531                                         uint32_t lcore = idx;
532                                         if (cfg->master_lcore == lcore &&
533                                                         master_lcore_parsed) {
534                                                 RTE_LOG(ERR, EAL,
535                                                         "Error: lcore %u is master lcore, cannot use as service core\n",
536                                                         idx);
537                                                 return -1;
538                                         }
539                                         if (cfg->lcore_role[idx] == ROLE_RTE)
540                                                 taken_lcore_count++;
541
542                                         lcore_config[idx].core_role =
543                                                         ROLE_SERVICE;
544                                         count++;
545                                 }
546                         }
547                         min = RTE_MAX_LCORE;
548                 } else
549                         return -1;
550                 corelist = end + 1;
551         } while (*end != '\0');
552
553         if (count == 0)
554                 return -1;
555
556         if (core_parsed && taken_lcore_count != count) {
557                 RTE_LOG(WARNING, EAL,
558                         "Not all service cores were in the coremask. "
559                         "Please ensure -c or -l includes service cores\n");
560         }
561
562         return 0;
563 }
564
565 static int
566 eal_parse_corelist(const char *corelist)
567 {
568         struct rte_config *cfg = rte_eal_get_configuration();
569         int i, idx = 0;
570         unsigned count = 0;
571         char *end = NULL;
572         int min, max;
573
574         if (eal_service_cores_parsed())
575                 RTE_LOG(WARNING, EAL,
576                         "Service cores parsed before dataplane cores. "
577                         "Please ensure -l is before -s or -S\n");
578
579         if (corelist == NULL)
580                 return -1;
581
582         /* Remove all blank characters ahead and after */
583         while (isblank(*corelist))
584                 corelist++;
585         i = strlen(corelist);
586         while ((i > 0) && isblank(corelist[i - 1]))
587                 i--;
588
589         /* Reset config */
590         for (idx = 0; idx < RTE_MAX_LCORE; idx++) {
591                 cfg->lcore_role[idx] = ROLE_OFF;
592                 lcore_config[idx].core_index = -1;
593         }
594
595         /* Get list of cores */
596         min = RTE_MAX_LCORE;
597         do {
598                 while (isblank(*corelist))
599                         corelist++;
600                 if (*corelist == '\0')
601                         return -1;
602                 errno = 0;
603                 idx = strtoul(corelist, &end, 10);
604                 if (errno || end == NULL)
605                         return -1;
606                 while (isblank(*end))
607                         end++;
608                 if (*end == '-') {
609                         min = idx;
610                 } else if ((*end == ',') || (*end == '\0')) {
611                         max = idx;
612                         if (min == RTE_MAX_LCORE)
613                                 min = idx;
614                         for (idx = min; idx <= max; idx++) {
615                                 if (cfg->lcore_role[idx] != ROLE_RTE) {
616                                         cfg->lcore_role[idx] = ROLE_RTE;
617                                         lcore_config[idx].core_index = count;
618                                         count++;
619                                 }
620                         }
621                         min = RTE_MAX_LCORE;
622                 } else
623                         return -1;
624                 corelist = end + 1;
625         } while (*end != '\0');
626
627         if (count == 0)
628                 return -1;
629
630         /* Update the count of enabled logical cores of the EAL configuration */
631         cfg->lcore_count = count;
632
633         return 0;
634 }
635
636 /* Changes the lcore id of the master thread */
637 static int
638 eal_parse_master_lcore(const char *arg)
639 {
640         char *parsing_end;
641         struct rte_config *cfg = rte_eal_get_configuration();
642
643         errno = 0;
644         cfg->master_lcore = (uint32_t) strtol(arg, &parsing_end, 0);
645         if (errno || parsing_end[0] != 0)
646                 return -1;
647         if (cfg->master_lcore >= RTE_MAX_LCORE)
648                 return -1;
649         master_lcore_parsed = 1;
650
651         /* ensure master core is not used as service core */
652         if (lcore_config[cfg->master_lcore].core_role == ROLE_SERVICE) {
653                 RTE_LOG(ERR, EAL,
654                         "Error: Master lcore is used as a service core\n");
655                 return -1;
656         }
657
658         return 0;
659 }
660
661 /*
662  * Parse elem, the elem could be single number/range or '(' ')' group
663  * 1) A single number elem, it's just a simple digit. e.g. 9
664  * 2) A single range elem, two digits with a '-' between. e.g. 2-6
665  * 3) A group elem, combines multiple 1) or 2) with '( )'. e.g (0,2-4,6)
666  *    Within group elem, '-' used for a range separator;
667  *                       ',' used for a single number.
668  */
669 static int
670 eal_parse_set(const char *input, uint16_t set[], unsigned num)
671 {
672         unsigned idx;
673         const char *str = input;
674         char *end = NULL;
675         unsigned min, max;
676
677         memset(set, 0, num * sizeof(uint16_t));
678
679         while (isblank(*str))
680                 str++;
681
682         /* only digit or left bracket is qualify for start point */
683         if ((!isdigit(*str) && *str != '(') || *str == '\0')
684                 return -1;
685
686         /* process single number or single range of number */
687         if (*str != '(') {
688                 errno = 0;
689                 idx = strtoul(str, &end, 10);
690                 if (errno || end == NULL || idx >= num)
691                         return -1;
692                 else {
693                         while (isblank(*end))
694                                 end++;
695
696                         min = idx;
697                         max = idx;
698                         if (*end == '-') {
699                                 /* process single <number>-<number> */
700                                 end++;
701                                 while (isblank(*end))
702                                         end++;
703                                 if (!isdigit(*end))
704                                         return -1;
705
706                                 errno = 0;
707                                 idx = strtoul(end, &end, 10);
708                                 if (errno || end == NULL || idx >= num)
709                                         return -1;
710                                 max = idx;
711                                 while (isblank(*end))
712                                         end++;
713                                 if (*end != ',' && *end != '\0')
714                                         return -1;
715                         }
716
717                         if (*end != ',' && *end != '\0' &&
718                             *end != '@')
719                                 return -1;
720
721                         for (idx = RTE_MIN(min, max);
722                              idx <= RTE_MAX(min, max); idx++)
723                                 set[idx] = 1;
724
725                         return end - input;
726                 }
727         }
728
729         /* process set within bracket */
730         str++;
731         while (isblank(*str))
732                 str++;
733         if (*str == '\0')
734                 return -1;
735
736         min = RTE_MAX_LCORE;
737         do {
738
739                 /* go ahead to the first digit */
740                 while (isblank(*str))
741                         str++;
742                 if (!isdigit(*str))
743                         return -1;
744
745                 /* get the digit value */
746                 errno = 0;
747                 idx = strtoul(str, &end, 10);
748                 if (errno || end == NULL || idx >= num)
749                         return -1;
750
751                 /* go ahead to separator '-',',' and ')' */
752                 while (isblank(*end))
753                         end++;
754                 if (*end == '-') {
755                         if (min == RTE_MAX_LCORE)
756                                 min = idx;
757                         else /* avoid continuous '-' */
758                                 return -1;
759                 } else if ((*end == ',') || (*end == ')')) {
760                         max = idx;
761                         if (min == RTE_MAX_LCORE)
762                                 min = idx;
763                         for (idx = RTE_MIN(min, max);
764                              idx <= RTE_MAX(min, max); idx++)
765                                 set[idx] = 1;
766
767                         min = RTE_MAX_LCORE;
768                 } else
769                         return -1;
770
771                 str = end + 1;
772         } while (*end != '\0' && *end != ')');
773
774         /*
775          * to avoid failure that tail blank makes end character check fail
776          * in eal_parse_lcores( )
777          */
778         while (isblank(*str))
779                 str++;
780
781         return str - input;
782 }
783
784 /* convert from set array to cpuset bitmap */
785 static int
786 convert_to_cpuset(rte_cpuset_t *cpusetp,
787               uint16_t *set, unsigned num)
788 {
789         unsigned idx;
790
791         CPU_ZERO(cpusetp);
792
793         for (idx = 0; idx < num; idx++) {
794                 if (!set[idx])
795                         continue;
796
797                 if (!lcore_config[idx].detected) {
798                         RTE_LOG(ERR, EAL, "core %u "
799                                 "unavailable\n", idx);
800                         return -1;
801                 }
802
803                 CPU_SET(idx, cpusetp);
804         }
805
806         return 0;
807 }
808
809 /*
810  * The format pattern: --lcores='<lcores[@cpus]>[<,lcores[@cpus]>...]'
811  * lcores, cpus could be a single digit/range or a group.
812  * '(' and ')' are necessary if it's a group.
813  * If not supply '@cpus', the value of cpus uses the same as lcores.
814  * e.g. '1,2@(5-7),(3-5)@(0,2),(0,6),7-8' means start 9 EAL thread as below
815  *   lcore 0 runs on cpuset 0x41 (cpu 0,6)
816  *   lcore 1 runs on cpuset 0x2 (cpu 1)
817  *   lcore 2 runs on cpuset 0xe0 (cpu 5,6,7)
818  *   lcore 3,4,5 runs on cpuset 0x5 (cpu 0,2)
819  *   lcore 6 runs on cpuset 0x41 (cpu 0,6)
820  *   lcore 7 runs on cpuset 0x80 (cpu 7)
821  *   lcore 8 runs on cpuset 0x100 (cpu 8)
822  */
823 static int
824 eal_parse_lcores(const char *lcores)
825 {
826         struct rte_config *cfg = rte_eal_get_configuration();
827         static uint16_t set[RTE_MAX_LCORE];
828         unsigned idx = 0;
829         unsigned count = 0;
830         const char *lcore_start = NULL;
831         const char *end = NULL;
832         int offset;
833         rte_cpuset_t cpuset;
834         int lflags;
835         int ret = -1;
836
837         if (lcores == NULL)
838                 return -1;
839
840         /* Remove all blank characters ahead and after */
841         while (isblank(*lcores))
842                 lcores++;
843
844         CPU_ZERO(&cpuset);
845
846         /* Reset lcore config */
847         for (idx = 0; idx < RTE_MAX_LCORE; idx++) {
848                 cfg->lcore_role[idx] = ROLE_OFF;
849                 lcore_config[idx].core_index = -1;
850                 CPU_ZERO(&lcore_config[idx].cpuset);
851         }
852
853         /* Get list of cores */
854         do {
855                 while (isblank(*lcores))
856                         lcores++;
857                 if (*lcores == '\0')
858                         goto err;
859
860                 lflags = 0;
861
862                 /* record lcore_set start point */
863                 lcore_start = lcores;
864
865                 /* go across a complete bracket */
866                 if (*lcore_start == '(') {
867                         lcores += strcspn(lcores, ")");
868                         if (*lcores++ == '\0')
869                                 goto err;
870                 }
871
872                 /* scan the separator '@', ','(next) or '\0'(finish) */
873                 lcores += strcspn(lcores, "@,");
874
875                 if (*lcores == '@') {
876                         /* explicit assign cpu_set */
877                         offset = eal_parse_set(lcores + 1, set, RTE_DIM(set));
878                         if (offset < 0)
879                                 goto err;
880
881                         /* prepare cpu_set and update the end cursor */
882                         if (0 > convert_to_cpuset(&cpuset,
883                                                   set, RTE_DIM(set)))
884                                 goto err;
885                         end = lcores + 1 + offset;
886                 } else { /* ',' or '\0' */
887                         /* haven't given cpu_set, current loop done */
888                         end = lcores;
889
890                         /* go back to check <number>-<number> */
891                         offset = strcspn(lcore_start, "(-");
892                         if (offset < (end - lcore_start) &&
893                             *(lcore_start + offset) != '(')
894                                 lflags = 1;
895                 }
896
897                 if (*end != ',' && *end != '\0')
898                         goto err;
899
900                 /* parse lcore_set from start point */
901                 if (0 > eal_parse_set(lcore_start, set, RTE_DIM(set)))
902                         goto err;
903
904                 /* without '@', by default using lcore_set as cpu_set */
905                 if (*lcores != '@' &&
906                     0 > convert_to_cpuset(&cpuset, set, RTE_DIM(set)))
907                         goto err;
908
909                 /* start to update lcore_set */
910                 for (idx = 0; idx < RTE_MAX_LCORE; idx++) {
911                         if (!set[idx])
912                                 continue;
913
914                         if (cfg->lcore_role[idx] != ROLE_RTE) {
915                                 lcore_config[idx].core_index = count;
916                                 cfg->lcore_role[idx] = ROLE_RTE;
917                                 count++;
918                         }
919
920                         if (lflags) {
921                                 CPU_ZERO(&cpuset);
922                                 CPU_SET(idx, &cpuset);
923                         }
924                         rte_memcpy(&lcore_config[idx].cpuset, &cpuset,
925                                    sizeof(rte_cpuset_t));
926                 }
927
928                 lcores = end + 1;
929         } while (*end != '\0');
930
931         if (count == 0)
932                 goto err;
933
934         cfg->lcore_count = count;
935         ret = 0;
936
937 err:
938
939         return ret;
940 }
941
942 static int
943 eal_parse_syslog(const char *facility, struct internal_config *conf)
944 {
945         int i;
946         static const struct {
947                 const char *name;
948                 int value;
949         } map[] = {
950                 { "auth", LOG_AUTH },
951                 { "cron", LOG_CRON },
952                 { "daemon", LOG_DAEMON },
953                 { "ftp", LOG_FTP },
954                 { "kern", LOG_KERN },
955                 { "lpr", LOG_LPR },
956                 { "mail", LOG_MAIL },
957                 { "news", LOG_NEWS },
958                 { "syslog", LOG_SYSLOG },
959                 { "user", LOG_USER },
960                 { "uucp", LOG_UUCP },
961                 { "local0", LOG_LOCAL0 },
962                 { "local1", LOG_LOCAL1 },
963                 { "local2", LOG_LOCAL2 },
964                 { "local3", LOG_LOCAL3 },
965                 { "local4", LOG_LOCAL4 },
966                 { "local5", LOG_LOCAL5 },
967                 { "local6", LOG_LOCAL6 },
968                 { "local7", LOG_LOCAL7 },
969                 { NULL, 0 }
970         };
971
972         for (i = 0; map[i].name; i++) {
973                 if (!strcmp(facility, map[i].name)) {
974                         conf->syslog_facility = map[i].value;
975                         return 0;
976                 }
977         }
978         return -1;
979 }
980
981 static int
982 eal_parse_log_priority(const char *level)
983 {
984         static const char * const levels[] = {
985                 [RTE_LOG_EMERG]   = "emergency",
986                 [RTE_LOG_ALERT]   = "alert",
987                 [RTE_LOG_CRIT]    = "critical",
988                 [RTE_LOG_ERR]     = "error",
989                 [RTE_LOG_WARNING] = "warning",
990                 [RTE_LOG_NOTICE]  = "notice",
991                 [RTE_LOG_INFO]    = "info",
992                 [RTE_LOG_DEBUG]   = "debug",
993         };
994         size_t len = strlen(level);
995         unsigned long tmp;
996         char *end;
997         unsigned int i;
998
999         if (len == 0)
1000                 return -1;
1001
1002         /* look for named values, skip 0 which is not a valid level */
1003         for (i = 1; i < RTE_DIM(levels); i++) {
1004                 if (strncmp(levels[i], level, len) == 0)
1005                         return i;
1006         }
1007
1008         /* not a string, maybe it is numeric */
1009         errno = 0;
1010         tmp = strtoul(level, &end, 0);
1011
1012         /* check for errors */
1013         if (errno != 0 || end == NULL || *end != '\0' ||
1014             tmp >= UINT32_MAX)
1015                 return -1;
1016
1017         return tmp;
1018 }
1019
1020 static int
1021 eal_parse_log_level(const char *arg)
1022 {
1023         const char *pattern = NULL;
1024         const char *regex = NULL;
1025         char *str, *level;
1026         int priority;
1027
1028         str = strdup(arg);
1029         if (str == NULL)
1030                 return -1;
1031
1032         if ((level = strchr(str, ','))) {
1033                 regex = str;
1034                 *level++ = '\0';
1035         } else if ((level = strchr(str, ':'))) {
1036                 pattern = str;
1037                 *level++ = '\0';
1038         } else {
1039                 level = str;
1040         }
1041
1042         priority = eal_parse_log_priority(level);
1043         if (priority < 0) {
1044                 fprintf(stderr, "invalid log priority: %s\n", level);
1045                 goto fail;
1046         }
1047
1048         if (regex) {
1049                 if (rte_log_set_level_regexp(regex, priority) < 0) {
1050                         fprintf(stderr, "cannot set log level %s,%d\n",
1051                                 pattern, priority);
1052                         goto fail;
1053                 }
1054                 if (rte_log_save_regexp(regex, priority) < 0)
1055                         goto fail;
1056         } else if (pattern) {
1057                 if (rte_log_set_level_pattern(pattern, priority) < 0) {
1058                         fprintf(stderr, "cannot set log level %s:%d\n",
1059                                 pattern, priority);
1060                         goto fail;
1061                 }
1062                 if (rte_log_save_pattern(pattern, priority) < 0)
1063                         goto fail;
1064         } else {
1065                 rte_log_set_global_level(priority);
1066         }
1067
1068         free(str);
1069         return 0;
1070
1071 fail:
1072         free(str);
1073         return -1;
1074 }
1075
1076 static enum rte_proc_type_t
1077 eal_parse_proc_type(const char *arg)
1078 {
1079         if (strncasecmp(arg, "primary", sizeof("primary")) == 0)
1080                 return RTE_PROC_PRIMARY;
1081         if (strncasecmp(arg, "secondary", sizeof("secondary")) == 0)
1082                 return RTE_PROC_SECONDARY;
1083         if (strncasecmp(arg, "auto", sizeof("auto")) == 0)
1084                 return RTE_PROC_AUTO;
1085
1086         return RTE_PROC_INVALID;
1087 }
1088
1089 static int
1090 eal_parse_iova_mode(const char *name)
1091 {
1092         int mode;
1093
1094         if (name == NULL)
1095                 return -1;
1096
1097         if (!strcmp("pa", name))
1098                 mode = RTE_IOVA_PA;
1099         else if (!strcmp("va", name))
1100                 mode = RTE_IOVA_VA;
1101         else
1102                 return -1;
1103
1104         internal_config.iova_mode = mode;
1105         return 0;
1106 }
1107
1108 int
1109 eal_parse_common_option(int opt, const char *optarg,
1110                         struct internal_config *conf)
1111 {
1112         static int b_used;
1113         static int w_used;
1114
1115         switch (opt) {
1116         /* blacklist */
1117         case 'b':
1118                 if (w_used)
1119                         goto bw_used;
1120                 if (eal_option_device_add(RTE_DEVTYPE_BLACKLISTED_PCI,
1121                                 optarg) < 0) {
1122                         return -1;
1123                 }
1124                 b_used = 1;
1125                 break;
1126         /* whitelist */
1127         case 'w':
1128                 if (b_used)
1129                         goto bw_used;
1130                 if (eal_option_device_add(RTE_DEVTYPE_WHITELISTED_PCI,
1131                                 optarg) < 0) {
1132                         return -1;
1133                 }
1134                 w_used = 1;
1135                 break;
1136         /* coremask */
1137         case 'c':
1138                 if (eal_parse_coremask(optarg) < 0) {
1139                         RTE_LOG(ERR, EAL, "invalid coremask\n");
1140                         return -1;
1141                 }
1142
1143                 if (core_parsed) {
1144                         RTE_LOG(ERR, EAL, "Option -c is ignored, because (%s) is set!\n",
1145                                 (core_parsed == LCORE_OPT_LST) ? "-l" :
1146                                 (core_parsed == LCORE_OPT_MAP) ? "--lcore" :
1147                                 "-c");
1148                         return -1;
1149                 }
1150
1151                 core_parsed = LCORE_OPT_MSK;
1152                 break;
1153         /* corelist */
1154         case 'l':
1155                 if (eal_parse_corelist(optarg) < 0) {
1156                         RTE_LOG(ERR, EAL, "invalid core list\n");
1157                         return -1;
1158                 }
1159
1160                 if (core_parsed) {
1161                         RTE_LOG(ERR, EAL, "Option -l is ignored, because (%s) is set!\n",
1162                                 (core_parsed == LCORE_OPT_MSK) ? "-c" :
1163                                 (core_parsed == LCORE_OPT_MAP) ? "--lcore" :
1164                                 "-l");
1165                         return -1;
1166                 }
1167
1168                 core_parsed = LCORE_OPT_LST;
1169                 break;
1170         /* service coremask */
1171         case 's':
1172                 if (eal_parse_service_coremask(optarg) < 0) {
1173                         RTE_LOG(ERR, EAL, "invalid service coremask\n");
1174                         return -1;
1175                 }
1176                 break;
1177         /* service corelist */
1178         case 'S':
1179                 if (eal_parse_service_corelist(optarg) < 0) {
1180                         RTE_LOG(ERR, EAL, "invalid service core list\n");
1181                         return -1;
1182                 }
1183                 break;
1184         /* size of memory */
1185         case 'm':
1186                 conf->memory = atoi(optarg);
1187                 conf->memory *= 1024ULL;
1188                 conf->memory *= 1024ULL;
1189                 mem_parsed = 1;
1190                 break;
1191         /* force number of channels */
1192         case 'n':
1193                 conf->force_nchannel = atoi(optarg);
1194                 if (conf->force_nchannel == 0) {
1195                         RTE_LOG(ERR, EAL, "invalid channel number\n");
1196                         return -1;
1197                 }
1198                 break;
1199         /* force number of ranks */
1200         case 'r':
1201                 conf->force_nrank = atoi(optarg);
1202                 if (conf->force_nrank == 0 ||
1203                     conf->force_nrank > 16) {
1204                         RTE_LOG(ERR, EAL, "invalid rank number\n");
1205                         return -1;
1206                 }
1207                 break;
1208         /* force loading of external driver */
1209         case 'd':
1210                 if (eal_plugin_add(optarg) == -1)
1211                         return -1;
1212                 break;
1213         case 'v':
1214                 /* since message is explicitly requested by user, we
1215                  * write message at highest log level so it can always
1216                  * be seen
1217                  * even if info or warning messages are disabled */
1218                 RTE_LOG(CRIT, EAL, "RTE Version: '%s'\n", rte_version());
1219                 break;
1220
1221         /* long options */
1222         case OPT_HUGE_UNLINK_NUM:
1223                 conf->hugepage_unlink = 1;
1224                 break;
1225
1226         case OPT_NO_HUGE_NUM:
1227                 conf->no_hugetlbfs = 1;
1228                 /* no-huge is legacy mem */
1229                 conf->legacy_mem = 1;
1230                 break;
1231
1232         case OPT_NO_PCI_NUM:
1233                 conf->no_pci = 1;
1234                 break;
1235
1236         case OPT_NO_HPET_NUM:
1237                 conf->no_hpet = 1;
1238                 break;
1239
1240         case OPT_VMWARE_TSC_MAP_NUM:
1241                 conf->vmware_tsc_map = 1;
1242                 break;
1243
1244         case OPT_NO_SHCONF_NUM:
1245                 conf->no_shconf = 1;
1246                 break;
1247
1248         case OPT_IN_MEMORY_NUM:
1249                 conf->in_memory = 1;
1250                 /* in-memory is a superset of noshconf and huge-unlink */
1251                 conf->no_shconf = 1;
1252                 conf->hugepage_unlink = 1;
1253                 break;
1254
1255         case OPT_PROC_TYPE_NUM:
1256                 conf->process_type = eal_parse_proc_type(optarg);
1257                 break;
1258
1259         case OPT_MASTER_LCORE_NUM:
1260                 if (eal_parse_master_lcore(optarg) < 0) {
1261                         RTE_LOG(ERR, EAL, "invalid parameter for --"
1262                                         OPT_MASTER_LCORE "\n");
1263                         return -1;
1264                 }
1265                 break;
1266
1267         case OPT_VDEV_NUM:
1268                 if (eal_option_device_add(RTE_DEVTYPE_VIRTUAL,
1269                                 optarg) < 0) {
1270                         return -1;
1271                 }
1272                 break;
1273
1274         case OPT_SYSLOG_NUM:
1275                 if (eal_parse_syslog(optarg, conf) < 0) {
1276                         RTE_LOG(ERR, EAL, "invalid parameters for --"
1277                                         OPT_SYSLOG "\n");
1278                         return -1;
1279                 }
1280                 break;
1281
1282         case OPT_LOG_LEVEL_NUM: {
1283                 if (eal_parse_log_level(optarg) < 0) {
1284                         RTE_LOG(ERR, EAL,
1285                                 "invalid parameters for --"
1286                                 OPT_LOG_LEVEL "\n");
1287                         return -1;
1288                 }
1289                 break;
1290         }
1291         case OPT_LCORES_NUM:
1292                 if (eal_parse_lcores(optarg) < 0) {
1293                         RTE_LOG(ERR, EAL, "invalid parameter for --"
1294                                 OPT_LCORES "\n");
1295                         return -1;
1296                 }
1297
1298                 if (core_parsed) {
1299                         RTE_LOG(ERR, EAL, "Option --lcore is ignored, because (%s) is set!\n",
1300                                 (core_parsed == LCORE_OPT_LST) ? "-l" :
1301                                 (core_parsed == LCORE_OPT_MSK) ? "-c" :
1302                                 "--lcore");
1303                         return -1;
1304                 }
1305
1306                 core_parsed = LCORE_OPT_MAP;
1307                 break;
1308         case OPT_LEGACY_MEM_NUM:
1309                 conf->legacy_mem = 1;
1310                 break;
1311         case OPT_SINGLE_FILE_SEGMENTS_NUM:
1312                 conf->single_file_segments = 1;
1313                 break;
1314         case OPT_IOVA_MODE_NUM:
1315                 if (eal_parse_iova_mode(optarg) < 0) {
1316                         RTE_LOG(ERR, EAL, "invalid parameters for --"
1317                                 OPT_IOVA_MODE "\n");
1318                         return -1;
1319                 }
1320                 break;
1321
1322         /* don't know what to do, leave this to caller */
1323         default:
1324                 return 1;
1325
1326         }
1327
1328         return 0;
1329 bw_used:
1330         RTE_LOG(ERR, EAL, "Options blacklist (-b) and whitelist (-w) "
1331                 "cannot be used at the same time\n");
1332         return -1;
1333 }
1334
1335 static void
1336 eal_auto_detect_cores(struct rte_config *cfg)
1337 {
1338         unsigned int lcore_id;
1339         unsigned int removed = 0;
1340         rte_cpuset_t affinity_set;
1341         pthread_t tid = pthread_self();
1342
1343         if (pthread_getaffinity_np(tid, sizeof(rte_cpuset_t),
1344                                 &affinity_set) < 0)
1345                 CPU_ZERO(&affinity_set);
1346
1347         for (lcore_id = 0; lcore_id < RTE_MAX_LCORE; lcore_id++) {
1348                 if (cfg->lcore_role[lcore_id] == ROLE_RTE &&
1349                     !CPU_ISSET(lcore_id, &affinity_set)) {
1350                         cfg->lcore_role[lcore_id] = ROLE_OFF;
1351                         removed++;
1352                 }
1353         }
1354
1355         cfg->lcore_count -= removed;
1356 }
1357
1358 int
1359 eal_cleanup_config(struct internal_config *internal_cfg)
1360 {
1361         if (internal_cfg->hugefile_prefix != NULL)
1362                 free(internal_cfg->hugefile_prefix);
1363         if (internal_cfg->hugepage_dir != NULL)
1364                 free(internal_cfg->hugepage_dir);
1365         if (internal_cfg->user_mbuf_pool_ops_name != NULL)
1366                 free(internal_cfg->user_mbuf_pool_ops_name);
1367
1368         return 0;
1369 }
1370
1371 int
1372 eal_adjust_config(struct internal_config *internal_cfg)
1373 {
1374         int i;
1375         struct rte_config *cfg = rte_eal_get_configuration();
1376
1377         if (!core_parsed)
1378                 eal_auto_detect_cores(cfg);
1379
1380         if (internal_config.process_type == RTE_PROC_AUTO)
1381                 internal_config.process_type = eal_proc_type_detect();
1382
1383         /* default master lcore is the first one */
1384         if (!master_lcore_parsed) {
1385                 cfg->master_lcore = rte_get_next_lcore(-1, 0, 0);
1386                 lcore_config[cfg->master_lcore].core_role = ROLE_RTE;
1387         }
1388
1389         /* if no memory amounts were requested, this will result in 0 and
1390          * will be overridden later, right after eal_hugepage_info_init() */
1391         for (i = 0; i < RTE_MAX_NUMA_NODES; i++)
1392                 internal_cfg->memory += internal_cfg->socket_mem[i];
1393
1394         return 0;
1395 }
1396
1397 int
1398 eal_check_common_options(struct internal_config *internal_cfg)
1399 {
1400         struct rte_config *cfg = rte_eal_get_configuration();
1401
1402         if (cfg->lcore_role[cfg->master_lcore] != ROLE_RTE) {
1403                 RTE_LOG(ERR, EAL, "Master lcore is not enabled for DPDK\n");
1404                 return -1;
1405         }
1406
1407         if (internal_cfg->process_type == RTE_PROC_INVALID) {
1408                 RTE_LOG(ERR, EAL, "Invalid process type specified\n");
1409                 return -1;
1410         }
1411         if (index(eal_get_hugefile_prefix(), '%') != NULL) {
1412                 RTE_LOG(ERR, EAL, "Invalid char, '%%', in --"OPT_FILE_PREFIX" "
1413                         "option\n");
1414                 return -1;
1415         }
1416         if (mem_parsed && internal_cfg->force_sockets == 1) {
1417                 RTE_LOG(ERR, EAL, "Options -m and --"OPT_SOCKET_MEM" cannot "
1418                         "be specified at the same time\n");
1419                 return -1;
1420         }
1421         if (internal_cfg->no_hugetlbfs && internal_cfg->force_sockets == 1) {
1422                 RTE_LOG(ERR, EAL, "Option --"OPT_SOCKET_MEM" cannot "
1423                         "be specified together with --"OPT_NO_HUGE"\n");
1424                 return -1;
1425         }
1426         if (internal_cfg->no_hugetlbfs && internal_cfg->hugepage_unlink &&
1427                         !internal_cfg->in_memory) {
1428                 RTE_LOG(ERR, EAL, "Option --"OPT_HUGE_UNLINK" cannot "
1429                         "be specified together with --"OPT_NO_HUGE"\n");
1430                 return -1;
1431         }
1432         if (internal_config.force_socket_limits && internal_config.legacy_mem) {
1433                 RTE_LOG(ERR, EAL, "Option --"OPT_SOCKET_LIMIT
1434                         " is only supported in non-legacy memory mode\n");
1435         }
1436         if (internal_cfg->single_file_segments &&
1437                         internal_cfg->hugepage_unlink &&
1438                         !internal_cfg->in_memory) {
1439                 RTE_LOG(ERR, EAL, "Option --"OPT_SINGLE_FILE_SEGMENTS" is "
1440                         "not compatible with --"OPT_HUGE_UNLINK"\n");
1441                 return -1;
1442         }
1443         if (internal_cfg->legacy_mem &&
1444                         internal_cfg->in_memory) {
1445                 RTE_LOG(ERR, EAL, "Option --"OPT_LEGACY_MEM" is not compatible "
1446                                 "with --"OPT_IN_MEMORY"\n");
1447                 return -1;
1448         }
1449         if (internal_cfg->legacy_mem && internal_cfg->match_allocations) {
1450                 RTE_LOG(ERR, EAL, "Option --"OPT_LEGACY_MEM" is not compatible "
1451                                 "with --"OPT_MATCH_ALLOCATIONS"\n");
1452                 return -1;
1453         }
1454         if (internal_cfg->no_hugetlbfs && internal_cfg->match_allocations) {
1455                 RTE_LOG(ERR, EAL, "Option --"OPT_NO_HUGE" is not compatible "
1456                                 "with --"OPT_MATCH_ALLOCATIONS"\n");
1457                 return -1;
1458         }
1459
1460         return 0;
1461 }
1462
1463 void
1464 eal_common_usage(void)
1465 {
1466         printf("[options]\n\n"
1467                "EAL common options:\n"
1468                "  -c COREMASK         Hexadecimal bitmask of cores to run on\n"
1469                "  -l CORELIST         List of cores to run on\n"
1470                "                      The argument format is <c1>[-c2][,c3[-c4],...]\n"
1471                "                      where c1, c2, etc are core indexes between 0 and %d\n"
1472                "  --"OPT_LCORES" COREMAP    Map lcore set to physical cpu set\n"
1473                "                      The argument format is\n"
1474                "                            '<lcores[@cpus]>[<,lcores[@cpus]>...]'\n"
1475                "                      lcores and cpus list are grouped by '(' and ')'\n"
1476                "                      Within the group, '-' is used for range separator,\n"
1477                "                      ',' is used for single number separator.\n"
1478                "                      '( )' can be omitted for single element group,\n"
1479                "                      '@' can be omitted if cpus and lcores have the same value\n"
1480                "  -s SERVICE COREMASK Hexadecimal bitmask of cores to be used as service cores\n"
1481                "  --"OPT_MASTER_LCORE" ID   Core ID that is used as master\n"
1482                "  --"OPT_MBUF_POOL_OPS_NAME" Pool ops name for mbuf to use\n"
1483                "  -n CHANNELS         Number of memory channels\n"
1484                "  -m MB               Memory to allocate (see also --"OPT_SOCKET_MEM")\n"
1485                "  -r RANKS            Force number of memory ranks (don't detect)\n"
1486                "  -b, --"OPT_PCI_BLACKLIST" Add a PCI device in black list.\n"
1487                "                      Prevent EAL from using this PCI device. The argument\n"
1488                "                      format is <domain:bus:devid.func>.\n"
1489                "  -w, --"OPT_PCI_WHITELIST" Add a PCI device in white list.\n"
1490                "                      Only use the specified PCI devices. The argument format\n"
1491                "                      is <[domain:]bus:devid.func>. This option can be present\n"
1492                "                      several times (once per device).\n"
1493                "                      [NOTE: PCI whitelist cannot be used with -b option]\n"
1494                "  --"OPT_VDEV"              Add a virtual device.\n"
1495                "                      The argument format is <driver><id>[,key=val,...]\n"
1496                "                      (ex: --vdev=net_pcap0,iface=eth2).\n"
1497                "  --"OPT_IOVA_MODE"   Set IOVA mode. 'pa' for IOVA_PA\n"
1498                "                      'va' for IOVA_VA\n"
1499                "  -d LIB.so|DIR       Add a driver or driver directory\n"
1500                "                      (can be used multiple times)\n"
1501                "  --"OPT_VMWARE_TSC_MAP"    Use VMware TSC map instead of native RDTSC\n"
1502                "  --"OPT_PROC_TYPE"         Type of this process (primary|secondary|auto)\n"
1503                "  --"OPT_SYSLOG"            Set syslog facility\n"
1504                "  --"OPT_LOG_LEVEL"=<int>   Set global log level\n"
1505                "  --"OPT_LOG_LEVEL"=<type-match>:<int>\n"
1506                "                      Set specific log level\n"
1507                "  -v                  Display version information on startup\n"
1508                "  -h, --help          This help\n"
1509                "  --"OPT_IN_MEMORY"   Operate entirely in memory. This will\n"
1510                "                      disable secondary process support\n"
1511                "\nEAL options for DEBUG use only:\n"
1512                "  --"OPT_HUGE_UNLINK"       Unlink hugepage files after init\n"
1513                "  --"OPT_NO_HUGE"           Use malloc instead of hugetlbfs\n"
1514                "  --"OPT_NO_PCI"            Disable PCI\n"
1515                "  --"OPT_NO_HPET"           Disable HPET\n"
1516                "  --"OPT_NO_SHCONF"         No shared config (mmap'd files)\n"
1517                "\n", RTE_MAX_LCORE);
1518         rte_option_usage();
1519 }