4 * Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
5 * Copyright(c) 2014 6WIND S.A.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
12 * * Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 * * Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in
16 * the documentation and/or other materials provided with the
18 * * Neither the name of Intel Corporation nor the names of its
19 * contributors may be used to endorse or promote products derived
20 * from this software without specific prior written permission.
22 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
24 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
25 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
26 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
27 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
28 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
29 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
30 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
31 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
32 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
50 #include <sys/queue.h>
52 #include <rte_common.h>
53 #include <rte_debug.h>
54 #include <rte_memory.h>
55 #include <rte_memzone.h>
56 #include <rte_launch.h>
58 #include <rte_eal_memconfig.h>
59 #include <rte_per_lcore.h>
60 #include <rte_lcore.h>
62 #include <rte_random.h>
63 #include <rte_cycles.h>
64 #include <rte_string_fns.h>
65 #include <rte_cpuflags.h>
66 #include <rte_interrupts.h>
69 #include <rte_devargs.h>
70 #include <rte_common.h>
71 #include <rte_version.h>
72 #include <rte_atomic.h>
73 #include <malloc_heap.h>
75 #include "eal_private.h"
76 #include "eal_thread.h"
77 #include "eal_internal_cfg.h"
78 #include "eal_filesystem.h"
79 #include "eal_hugepages.h"
80 #include "eal_options.h"
82 #define MEMSIZE_IF_NO_HUGE_PAGE (64ULL * 1024ULL * 1024ULL)
84 /* Allow the application to print its usage message too if set */
85 static rte_usage_hook_t rte_application_usage_hook = NULL;
86 /* early configuration structure, when memory config is not mmapped */
87 static struct rte_mem_config early_mem_config;
89 /* define fd variable here, because file needs to be kept open for the
90 * duration of the program, as we hold a write lock on it in the primary proc */
91 static int mem_cfg_fd = -1;
93 static struct flock wr_lock = {
96 .l_start = offsetof(struct rte_mem_config, memseg),
97 .l_len = sizeof(early_mem_config.memseg),
100 /* Address of global and public configuration */
101 static struct rte_config rte_config = {
102 .mem_config = &early_mem_config,
105 /* internal configuration (per-core) */
106 struct lcore_config lcore_config[RTE_MAX_LCORE];
108 /* internal configuration */
109 struct internal_config internal_config;
111 /* used by rte_rdtsc() */
112 int rte_cycles_vmware_tsc_map;
114 /* Return a pointer to the configuration structure */
116 rte_eal_get_configuration(void)
121 /* parse a sysfs (or other) file containing one integer value */
123 eal_parse_sysfs_value(const char *filename, unsigned long *val)
129 if ((f = fopen(filename, "r")) == NULL) {
130 RTE_LOG(ERR, EAL, "%s(): cannot open sysfs value %s\n",
135 if (fgets(buf, sizeof(buf), f) == NULL) {
136 RTE_LOG(ERR, EAL, "%s(): cannot read sysfs value %s\n",
141 *val = strtoul(buf, &end, 0);
142 if ((buf[0] == '\0') || (end == NULL) || (*end != '\n')) {
143 RTE_LOG(ERR, EAL, "%s(): cannot parse sysfs value %s\n",
153 /* create memory configuration in shared/mmap memory. Take out
154 * a write lock on the memsegs, so we can auto-detect primary/secondary.
155 * This means we never close the file while running (auto-close on exit).
156 * We also don't lock the whole file, so that in future we can use read-locks
157 * on other parts, e.g. memzones, to detect if there are running secondary
160 rte_eal_config_create(void)
162 void *rte_mem_cfg_addr;
165 const char *pathname = eal_runtime_config_path();
167 if (internal_config.no_shconf)
171 mem_cfg_fd = open(pathname, O_RDWR | O_CREAT, 0660);
173 rte_panic("Cannot open '%s' for rte_mem_config\n", pathname);
176 retval = ftruncate(mem_cfg_fd, sizeof(*rte_config.mem_config));
179 rte_panic("Cannot resize '%s' for rte_mem_config\n", pathname);
182 retval = fcntl(mem_cfg_fd, F_SETLK, &wr_lock);
185 rte_exit(EXIT_FAILURE, "Cannot create lock on '%s'. Is another primary "
186 "process running?\n", pathname);
189 rte_mem_cfg_addr = mmap(NULL, sizeof(*rte_config.mem_config),
190 PROT_READ | PROT_WRITE, MAP_SHARED, mem_cfg_fd, 0);
192 if (rte_mem_cfg_addr == MAP_FAILED){
193 rte_panic("Cannot mmap memory for rte_config\n");
195 memcpy(rte_mem_cfg_addr, &early_mem_config, sizeof(early_mem_config));
196 rte_config.mem_config = (struct rte_mem_config *) rte_mem_cfg_addr;
199 /* attach to an existing shared memory config */
201 rte_eal_config_attach(void)
203 void *rte_mem_cfg_addr;
204 const char *pathname = eal_runtime_config_path();
206 if (internal_config.no_shconf)
210 mem_cfg_fd = open(pathname, O_RDWR);
212 rte_panic("Cannot open '%s' for rte_mem_config\n", pathname);
215 rte_mem_cfg_addr = mmap(NULL, sizeof(*rte_config.mem_config),
216 PROT_READ | PROT_WRITE, MAP_SHARED, mem_cfg_fd, 0);
218 if (rte_mem_cfg_addr == MAP_FAILED)
219 rte_panic("Cannot mmap memory for rte_config\n");
221 rte_config.mem_config = (struct rte_mem_config *) rte_mem_cfg_addr;
224 /* Detect if we are a primary or a secondary process */
226 eal_proc_type_detect(void)
228 enum rte_proc_type_t ptype = RTE_PROC_PRIMARY;
229 const char *pathname = eal_runtime_config_path();
231 /* if we can open the file but not get a write-lock we are a secondary
232 * process. NOTE: if we get a file handle back, we keep that open
233 * and don't close it to prevent a race condition between multiple opens */
234 if (((mem_cfg_fd = open(pathname, O_RDWR)) >= 0) &&
235 (fcntl(mem_cfg_fd, F_SETLK, &wr_lock) < 0))
236 ptype = RTE_PROC_SECONDARY;
238 RTE_LOG(INFO, EAL, "Auto-detected process type: %s\n",
239 ptype == RTE_PROC_PRIMARY ? "PRIMARY" : "SECONDARY");
244 /* Sets up rte_config structure with the pointer to shared memory config.*/
246 rte_config_init(void)
248 rte_config.process_type = internal_config.process_type;
250 switch (rte_config.process_type){
251 case RTE_PROC_PRIMARY:
252 rte_eal_config_create();
254 case RTE_PROC_SECONDARY:
255 rte_eal_config_attach();
256 rte_eal_mcfg_wait_complete(rte_config.mem_config);
259 case RTE_PROC_INVALID:
260 rte_panic("Invalid process type\n");
266 eal_usage(const char *prgname)
268 printf("\nUsage: %s ", prgname);
270 /* Allow the application to print its usage message too if hook is set */
271 if ( rte_application_usage_hook ) {
272 printf("===== Application Usage =====\n\n");
273 rte_application_usage_hook(prgname);
277 /* Set a per-application usage message */
279 rte_set_application_usage_hook( rte_usage_hook_t usage_func )
281 rte_usage_hook_t old_func;
283 /* Will be NULL on the first call to denote the last usage routine. */
284 old_func = rte_application_usage_hook;
285 rte_application_usage_hook = usage_func;
291 eal_get_hugepage_mem_size(void)
296 for (i = 0; i < internal_config.num_hugepage_sizes; i++) {
297 struct hugepage_info *hpi = &internal_config.hugepage_info[i];
298 if (hpi->hugedir != NULL) {
299 for (j = 0; j < RTE_MAX_NUMA_NODES; j++) {
300 size += hpi->hugepage_sz * hpi->num_pages[j];
305 return (size < SIZE_MAX) ? (size_t)(size) : SIZE_MAX;
308 /* Parse the arguments for --log-level only */
310 eal_log_level_parse(int argc, char **argv)
318 eal_reset_internal_config(&internal_config);
320 while ((opt = getopt_long(argc, argvopt, eal_short_options,
321 eal_long_options, &option_index)) != EOF) {
325 /* getopt is not happy, stop right now */
329 ret = (opt == OPT_LOG_LEVEL_NUM) ?
330 eal_parse_common_option(opt, optarg, &internal_config) : 0;
332 /* common parser is not happy */
337 optind = 0; /* reset getopt lib */
340 /* Parse the argument given in the command line of the application */
342 eal_parse_args(int argc, char **argv)
347 char *prgname = argv[0];
351 while ((opt = getopt_long(argc, argvopt, eal_short_options,
352 eal_long_options, &option_index)) != EOF) {
356 /* getopt is not happy, stop right now */
362 ret = eal_parse_common_option(opt, optarg, &internal_config);
363 /* common parser is not happy */
368 /* common parser handled this option */
377 if (opt < OPT_LONG_MIN_NUM && isprint(opt)) {
378 RTE_LOG(ERR, EAL, "Option %c is not supported "
379 "on FreeBSD\n", opt);
380 } else if (opt >= OPT_LONG_MIN_NUM &&
381 opt < OPT_LONG_MAX_NUM) {
382 RTE_LOG(ERR, EAL, "Option %s is not supported "
384 eal_long_options[option_index].name);
386 RTE_LOG(ERR, EAL, "Option %d is not supported "
387 "on FreeBSD\n", opt);
394 if (eal_adjust_config(&internal_config) != 0)
398 if (eal_check_common_options(&internal_config) != 0) {
404 argv[optind-1] = prgname;
406 optind = 0; /* reset getopt lib */
411 eal_check_mem_on_local_socket(void)
413 const struct rte_memseg *ms;
416 socket_id = rte_lcore_to_socket_id(rte_config.master_lcore);
418 ms = rte_eal_get_physmem_layout();
420 for (i = 0; i < RTE_MAX_MEMSEG; i++)
421 if (ms[i].socket_id == socket_id &&
425 RTE_LOG(WARNING, EAL, "WARNING: Master core has no "
426 "memory on local socket!\n");
430 sync_func(__attribute__((unused)) void *arg)
436 rte_eal_mcfg_complete(void)
438 /* ALL shared mem_config related INIT DONE */
439 if (rte_config.process_type == RTE_PROC_PRIMARY)
440 rte_config.mem_config->magic = RTE_MAGIC;
443 /* return non-zero if hugepages are enabled. */
444 int rte_eal_has_hugepages(void)
446 return !internal_config.no_hugetlbfs;
449 /* Abstraction for port I/0 privilege */
451 rte_eal_iopl_init(void)
455 fd = open("/dev/io", O_RDWR);
458 /* keep fd open for iopl */
462 /* Launch threads, called at application init(). */
464 rte_eal_init(int argc, char **argv)
468 static rte_atomic32_t run_once = RTE_ATOMIC32_INIT(0);
469 char cpuset[RTE_CPU_AFFINITY_STR_LEN];
471 if (!rte_atomic32_test_and_set(&run_once))
474 thread_id = pthread_self();
476 if (rte_eal_log_early_init() < 0)
477 rte_panic("Cannot init early logs\n");
479 eal_log_level_parse(argc, argv);
481 /* set log level as early as possible */
482 rte_set_log_level(internal_config.log_level);
484 if (rte_eal_cpu_init() < 0)
485 rte_panic("Cannot detect lcores\n");
487 fctret = eal_parse_args(argc, argv);
491 if (internal_config.no_hugetlbfs == 0 &&
492 internal_config.process_type != RTE_PROC_SECONDARY &&
493 eal_hugepage_info_init() < 0)
494 rte_panic("Cannot get hugepage information\n");
496 if (internal_config.memory == 0 && internal_config.force_sockets == 0) {
497 if (internal_config.no_hugetlbfs)
498 internal_config.memory = MEMSIZE_IF_NO_HUGE_PAGE;
500 internal_config.memory = eal_get_hugepage_mem_size();
503 if (internal_config.vmware_tsc_map == 1) {
504 #ifdef RTE_LIBRTE_EAL_VMWARE_TSC_MAP_SUPPORT
505 rte_cycles_vmware_tsc_map = 1;
506 RTE_LOG (DEBUG, EAL, "Using VMWARE TSC MAP, "
507 "you must have monitor_control.pseudo_perfctr = TRUE\n");
509 RTE_LOG (WARNING, EAL, "Ignoring --vmware-tsc-map because "
510 "RTE_LIBRTE_EAL_VMWARE_TSC_MAP_SUPPORT is not set\n");
514 rte_srand(rte_rdtsc());
518 if (rte_eal_memory_init() < 0)
519 rte_panic("Cannot init memory\n");
521 if (rte_eal_memzone_init() < 0)
522 rte_panic("Cannot init memzone\n");
524 if (rte_eal_tailqs_init() < 0)
525 rte_panic("Cannot init tail queues for objects\n");
527 /* if (rte_eal_log_init(argv[0], internal_config.syslog_facility) < 0)
528 rte_panic("Cannot init logs\n");*/
530 if (rte_eal_alarm_init() < 0)
531 rte_panic("Cannot init interrupt-handling thread\n");
533 if (rte_eal_intr_init() < 0)
534 rte_panic("Cannot init interrupt-handling thread\n");
536 if (rte_eal_timer_init() < 0)
537 rte_panic("Cannot init HPET or TSC timers\n");
539 if (rte_eal_pci_init() < 0)
540 rte_panic("Cannot init PCI\n");
542 eal_check_mem_on_local_socket();
544 rte_eal_mcfg_complete();
546 eal_thread_init_master(rte_config.master_lcore);
548 ret = eal_thread_dump_affinity(cpuset, RTE_CPU_AFFINITY_STR_LEN);
550 RTE_LOG(DEBUG, EAL, "Master lcore %u is ready (tid=%p;cpuset=[%s%s])\n",
551 rte_config.master_lcore, thread_id, cpuset,
552 ret == 0 ? "" : "...");
554 if (rte_eal_dev_init() < 0)
555 rte_panic("Cannot init pmd devices\n");
557 RTE_LCORE_FOREACH_SLAVE(i) {
560 * create communication pipes between master thread
563 if (pipe(lcore_config[i].pipe_master2slave) < 0)
564 rte_panic("Cannot create pipe\n");
565 if (pipe(lcore_config[i].pipe_slave2master) < 0)
566 rte_panic("Cannot create pipe\n");
568 lcore_config[i].state = WAIT;
570 /* create a thread for each lcore */
571 ret = pthread_create(&lcore_config[i].thread_id, NULL,
572 eal_thread_loop, NULL);
574 rte_panic("Cannot create thread\n");
578 * Launch a dummy function on all slave lcores, so that master lcore
579 * knows they are all ready when this function returns.
581 rte_eal_mp_remote_launch(sync_func, NULL, SKIP_MASTER);
582 rte_eal_mp_wait_lcore();
584 /* Probe & Initialize PCI devices */
585 if (rte_eal_pci_probe())
586 rte_panic("Cannot probe PCI\n");
592 enum rte_lcore_role_t
593 rte_eal_lcore_role(unsigned lcore_id)
595 return rte_config.lcore_role[lcore_id];
599 rte_eal_process_type(void)
601 return rte_config.process_type;