4 * Copyright(c) 2010-2016 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.
49 #include <sys/queue.h>
51 #include <rte_common.h>
52 #include <rte_debug.h>
53 #include <rte_memory.h>
54 #include <rte_memzone.h>
55 #include <rte_launch.h>
57 #include <rte_eal_memconfig.h>
58 #include <rte_errno.h>
59 #include <rte_per_lcore.h>
60 #include <rte_lcore.h>
61 #include <rte_service_component.h>
63 #include <rte_random.h>
64 #include <rte_cycles.h>
65 #include <rte_string_fns.h>
66 #include <rte_cpuflags.h>
67 #include <rte_interrupts.h>
71 #include <rte_devargs.h>
72 #include <rte_version.h>
73 #include <rte_atomic.h>
74 #include <malloc_heap.h>
76 #include "eal_private.h"
77 #include "eal_thread.h"
78 #include "eal_internal_cfg.h"
79 #include "eal_filesystem.h"
80 #include "eal_hugepages.h"
81 #include "eal_options.h"
83 #define MEMSIZE_IF_NO_HUGE_PAGE (64ULL * 1024ULL * 1024ULL)
85 /* Allow the application to print its usage message too if set */
86 static rte_usage_hook_t rte_application_usage_hook = NULL;
87 /* early configuration structure, when memory config is not mmapped */
88 static struct rte_mem_config early_mem_config;
90 /* define fd variable here, because file needs to be kept open for the
91 * duration of the program, as we hold a write lock on it in the primary proc */
92 static int mem_cfg_fd = -1;
94 static struct flock wr_lock = {
97 .l_start = offsetof(struct rte_mem_config, memseg),
98 .l_len = sizeof(early_mem_config.memseg),
101 /* Address of global and public configuration */
102 static struct rte_config rte_config = {
103 .mem_config = &early_mem_config,
106 /* internal configuration (per-core) */
107 struct lcore_config lcore_config[RTE_MAX_LCORE];
109 /* internal configuration */
110 struct internal_config internal_config;
112 /* used by rte_rdtsc() */
113 int rte_cycles_vmware_tsc_map;
115 /* Return a pointer to the configuration structure */
117 rte_eal_get_configuration(void)
122 /* parse a sysfs (or other) file containing one integer value */
124 eal_parse_sysfs_value(const char *filename, unsigned long *val)
130 if ((f = fopen(filename, "r")) == NULL) {
131 RTE_LOG(ERR, EAL, "%s(): cannot open sysfs value %s\n",
136 if (fgets(buf, sizeof(buf), f) == NULL) {
137 RTE_LOG(ERR, EAL, "%s(): cannot read sysfs value %s\n",
142 *val = strtoul(buf, &end, 0);
143 if ((buf[0] == '\0') || (end == NULL) || (*end != '\n')) {
144 RTE_LOG(ERR, EAL, "%s(): cannot parse sysfs value %s\n",
154 /* create memory configuration in shared/mmap memory. Take out
155 * a write lock on the memsegs, so we can auto-detect primary/secondary.
156 * This means we never close the file while running (auto-close on exit).
157 * We also don't lock the whole file, so that in future we can use read-locks
158 * on other parts, e.g. memzones, to detect if there are running secondary
161 rte_eal_config_create(void)
163 void *rte_mem_cfg_addr;
166 const char *pathname = eal_runtime_config_path();
168 if (internal_config.no_shconf)
172 mem_cfg_fd = open(pathname, O_RDWR | O_CREAT, 0660);
174 rte_panic("Cannot open '%s' for rte_mem_config\n", pathname);
177 retval = ftruncate(mem_cfg_fd, sizeof(*rte_config.mem_config));
180 rte_panic("Cannot resize '%s' for rte_mem_config\n", pathname);
183 retval = fcntl(mem_cfg_fd, F_SETLK, &wr_lock);
186 rte_exit(EXIT_FAILURE, "Cannot create lock on '%s'. Is another primary "
187 "process running?\n", pathname);
190 rte_mem_cfg_addr = mmap(NULL, sizeof(*rte_config.mem_config),
191 PROT_READ | PROT_WRITE, MAP_SHARED, mem_cfg_fd, 0);
193 if (rte_mem_cfg_addr == MAP_FAILED){
194 rte_panic("Cannot mmap memory for rte_config\n");
196 memcpy(rte_mem_cfg_addr, &early_mem_config, sizeof(early_mem_config));
197 rte_config.mem_config = rte_mem_cfg_addr;
200 /* attach to an existing shared memory config */
202 rte_eal_config_attach(void)
204 void *rte_mem_cfg_addr;
205 const char *pathname = eal_runtime_config_path();
207 if (internal_config.no_shconf)
211 mem_cfg_fd = open(pathname, O_RDWR);
213 rte_panic("Cannot open '%s' for rte_mem_config\n", pathname);
216 rte_mem_cfg_addr = mmap(NULL, sizeof(*rte_config.mem_config),
217 PROT_READ | PROT_WRITE, MAP_SHARED, mem_cfg_fd, 0);
219 if (rte_mem_cfg_addr == MAP_FAILED)
220 rte_panic("Cannot mmap memory for rte_config\n");
222 rte_config.mem_config = rte_mem_cfg_addr;
225 /* Detect if we are a primary or a secondary process */
227 eal_proc_type_detect(void)
229 enum rte_proc_type_t ptype = RTE_PROC_PRIMARY;
230 const char *pathname = eal_runtime_config_path();
232 /* if we can open the file but not get a write-lock we are a secondary
233 * process. NOTE: if we get a file handle back, we keep that open
234 * and don't close it to prevent a race condition between multiple opens */
235 if (((mem_cfg_fd = open(pathname, O_RDWR)) >= 0) &&
236 (fcntl(mem_cfg_fd, F_SETLK, &wr_lock) < 0))
237 ptype = RTE_PROC_SECONDARY;
239 RTE_LOG(INFO, EAL, "Auto-detected process type: %s\n",
240 ptype == RTE_PROC_PRIMARY ? "PRIMARY" : "SECONDARY");
245 /* Sets up rte_config structure with the pointer to shared memory config.*/
247 rte_config_init(void)
249 rte_config.process_type = internal_config.process_type;
251 switch (rte_config.process_type){
252 case RTE_PROC_PRIMARY:
253 rte_eal_config_create();
255 case RTE_PROC_SECONDARY:
256 rte_eal_config_attach();
257 rte_eal_mcfg_wait_complete(rte_config.mem_config);
260 case RTE_PROC_INVALID:
261 rte_panic("Invalid process type\n");
267 eal_usage(const char *prgname)
269 printf("\nUsage: %s ", prgname);
271 /* Allow the application to print its usage message too if hook is set */
272 if ( rte_application_usage_hook ) {
273 printf("===== Application Usage =====\n\n");
274 rte_application_usage_hook(prgname);
278 /* Set a per-application usage message */
280 rte_set_application_usage_hook( rte_usage_hook_t usage_func )
282 rte_usage_hook_t old_func;
284 /* Will be NULL on the first call to denote the last usage routine. */
285 old_func = rte_application_usage_hook;
286 rte_application_usage_hook = usage_func;
292 eal_get_hugepage_mem_size(void)
297 for (i = 0; i < internal_config.num_hugepage_sizes; i++) {
298 struct hugepage_info *hpi = &internal_config.hugepage_info[i];
299 if (hpi->hugedir != NULL) {
300 for (j = 0; j < RTE_MAX_NUMA_NODES; j++) {
301 size += hpi->hugepage_sz * hpi->num_pages[j];
306 return (size < SIZE_MAX) ? (size_t)(size) : SIZE_MAX;
309 /* Parse the arguments for --log-level only */
311 eal_log_level_parse(int argc, char **argv)
316 const int old_optind = optind;
317 const int old_optopt = optopt;
318 const int old_optreset = optreset;
319 char * const old_optarg = optarg;
325 while ((opt = getopt_long(argc, argvopt, eal_short_options,
326 eal_long_options, &option_index)) != EOF) {
330 /* getopt is not happy, stop right now */
334 ret = (opt == OPT_LOG_LEVEL_NUM) ?
335 eal_parse_common_option(opt, optarg, &internal_config) : 0;
337 /* common parser is not happy */
342 /* restore getopt lib */
345 optreset = old_optreset;
349 /* Parse the argument given in the command line of the application */
351 eal_parse_args(int argc, char **argv)
356 char *prgname = argv[0];
357 const int old_optind = optind;
358 const int old_optopt = optopt;
359 const int old_optreset = optreset;
360 char * const old_optarg = optarg;
366 while ((opt = getopt_long(argc, argvopt, eal_short_options,
367 eal_long_options, &option_index)) != EOF) {
369 /* getopt is not happy, stop right now */
376 ret = eal_parse_common_option(opt, optarg, &internal_config);
377 /* common parser is not happy */
383 /* common parser handled this option */
392 if (opt < OPT_LONG_MIN_NUM && isprint(opt)) {
393 RTE_LOG(ERR, EAL, "Option %c is not supported "
394 "on FreeBSD\n", opt);
395 } else if (opt >= OPT_LONG_MIN_NUM &&
396 opt < OPT_LONG_MAX_NUM) {
397 RTE_LOG(ERR, EAL, "Option %s is not supported "
399 eal_long_options[option_index].name);
401 RTE_LOG(ERR, EAL, "Option %d is not supported "
402 "on FreeBSD\n", opt);
410 if (eal_adjust_config(&internal_config) != 0) {
416 if (eal_check_common_options(&internal_config) != 0) {
423 argv[optind-1] = prgname;
427 /* restore getopt lib */
430 optreset = old_optreset;
437 eal_check_mem_on_local_socket(void)
439 const struct rte_memseg *ms;
442 socket_id = rte_lcore_to_socket_id(rte_config.master_lcore);
444 ms = rte_eal_get_physmem_layout();
446 for (i = 0; i < RTE_MAX_MEMSEG; i++)
447 if (ms[i].socket_id == socket_id &&
451 RTE_LOG(WARNING, EAL, "WARNING: Master core has no "
452 "memory on local socket!\n");
456 sync_func(__attribute__((unused)) void *arg)
462 rte_eal_mcfg_complete(void)
464 /* ALL shared mem_config related INIT DONE */
465 if (rte_config.process_type == RTE_PROC_PRIMARY)
466 rte_config.mem_config->magic = RTE_MAGIC;
469 /* return non-zero if hugepages are enabled. */
470 int rte_eal_has_hugepages(void)
472 return !internal_config.no_hugetlbfs;
475 /* Abstraction for port I/0 privilege */
477 rte_eal_iopl_init(void)
481 fd = open("/dev/io", O_RDWR);
484 /* keep fd open for iopl */
488 static void rte_eal_init_alert(const char *msg)
490 fprintf(stderr, "EAL: FATAL: %s\n", msg);
491 RTE_LOG(ERR, EAL, "%s\n", msg);
494 /* Launch threads, called at application init(). */
496 rte_eal_init(int argc, char **argv)
500 static rte_atomic32_t run_once = RTE_ATOMIC32_INIT(0);
501 char cpuset[RTE_CPU_AFFINITY_STR_LEN];
502 char thread_name[RTE_MAX_THREAD_NAME_LEN];
504 /* checks if the machine is adequate */
505 if (!rte_cpu_is_supported()) {
506 rte_eal_init_alert("unsupported cpu type.");
511 if (!rte_atomic32_test_and_set(&run_once)) {
512 rte_eal_init_alert("already called initialization.");
513 rte_errno = EALREADY;
517 thread_id = pthread_self();
519 eal_reset_internal_config(&internal_config);
521 /* set log level as early as possible */
522 eal_log_level_parse(argc, argv);
524 if (rte_eal_cpu_init() < 0) {
525 rte_eal_init_alert("Cannot detect lcores.");
530 fctret = eal_parse_args(argc, argv);
532 rte_eal_init_alert("Invalid 'command line' arguments.");
534 rte_atomic32_clear(&run_once);
538 if (internal_config.no_hugetlbfs == 0 &&
539 internal_config.process_type != RTE_PROC_SECONDARY &&
540 eal_hugepage_info_init() < 0) {
541 rte_eal_init_alert("Cannot get hugepage information.");
543 rte_atomic32_clear(&run_once);
547 if (internal_config.memory == 0 && internal_config.force_sockets == 0) {
548 if (internal_config.no_hugetlbfs)
549 internal_config.memory = MEMSIZE_IF_NO_HUGE_PAGE;
551 internal_config.memory = eal_get_hugepage_mem_size();
554 if (internal_config.vmware_tsc_map == 1) {
555 #ifdef RTE_LIBRTE_EAL_VMWARE_TSC_MAP_SUPPORT
556 rte_cycles_vmware_tsc_map = 1;
557 RTE_LOG (DEBUG, EAL, "Using VMWARE TSC MAP, "
558 "you must have monitor_control.pseudo_perfctr = TRUE\n");
560 RTE_LOG (WARNING, EAL, "Ignoring --vmware-tsc-map because "
561 "RTE_LIBRTE_EAL_VMWARE_TSC_MAP_SUPPORT is not set\n");
565 rte_srand(rte_rdtsc());
569 if (rte_eal_memory_init() < 0) {
570 rte_eal_init_alert("Cannot init memory\n");
575 if (rte_eal_memzone_init() < 0) {
576 rte_eal_init_alert("Cannot init memzone\n");
581 if (rte_eal_tailqs_init() < 0) {
582 rte_eal_init_alert("Cannot init tail queues for objects\n");
587 if (rte_eal_alarm_init() < 0) {
588 rte_eal_init_alert("Cannot init interrupt-handling thread\n");
589 /* rte_eal_alarm_init sets rte_errno on failure. */
593 if (rte_eal_intr_init() < 0) {
594 rte_eal_init_alert("Cannot init interrupt-handling thread\n");
598 if (rte_eal_timer_init() < 0) {
599 rte_eal_init_alert("Cannot init HPET or TSC timers\n");
604 eal_check_mem_on_local_socket();
606 if (eal_plugins_init() < 0)
607 rte_eal_init_alert("Cannot init plugins\n");
609 eal_thread_init_master(rte_config.master_lcore);
611 ret = eal_thread_dump_affinity(cpuset, RTE_CPU_AFFINITY_STR_LEN);
613 RTE_LOG(DEBUG, EAL, "Master lcore %u is ready (tid=%p;cpuset=[%s%s])\n",
614 rte_config.master_lcore, thread_id, cpuset,
615 ret == 0 ? "" : "...");
617 if (rte_bus_scan()) {
618 rte_eal_init_alert("Cannot scan the buses for devices\n");
623 RTE_LCORE_FOREACH_SLAVE(i) {
626 * create communication pipes between master thread
629 if (pipe(lcore_config[i].pipe_master2slave) < 0)
630 rte_panic("Cannot create pipe\n");
631 if (pipe(lcore_config[i].pipe_slave2master) < 0)
632 rte_panic("Cannot create pipe\n");
634 lcore_config[i].state = WAIT;
636 /* create a thread for each lcore */
637 ret = pthread_create(&lcore_config[i].thread_id, NULL,
638 eal_thread_loop, NULL);
640 rte_panic("Cannot create thread\n");
642 /* Set thread_name for aid in debugging. */
643 snprintf(thread_name, RTE_MAX_THREAD_NAME_LEN,
644 "lcore-slave-%d", i);
645 rte_thread_setname(lcore_config[i].thread_id, thread_name);
649 * Launch a dummy function on all slave lcores, so that master lcore
650 * knows they are all ready when this function returns.
652 rte_eal_mp_remote_launch(sync_func, NULL, SKIP_MASTER);
653 rte_eal_mp_wait_lcore();
655 /* initialize services so vdevs register service during bus_probe. */
656 ret = rte_service_init();
658 rte_eal_init_alert("rte_service_init() failed\n");
663 /* Probe all the buses and devices/drivers on them */
664 if (rte_bus_probe()) {
665 rte_eal_init_alert("Cannot probe devices\n");
670 /* initialize default service/lcore mappings and start running. Ignore
671 * -ENOTSUP, as it indicates no service coremask passed to EAL.
673 ret = rte_service_start_with_defaults();
674 if (ret < 0 && ret != -ENOTSUP) {
679 rte_eal_mcfg_complete();
685 enum rte_lcore_role_t
686 rte_eal_lcore_role(unsigned lcore_id)
688 return rte_config.lcore_role[lcore_id];
692 rte_eal_process_type(void)
694 return rte_config.process_type;