1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2010-2018 Intel Corporation.
3 * Copyright(c) 2014 6WIND S.A.
20 #include <sys/queue.h>
23 #include <rte_compat.h>
24 #include <rte_common.h>
25 #include <rte_debug.h>
26 #include <rte_memory.h>
27 #include <rte_launch.h>
29 #include <rte_eal_memconfig.h>
30 #include <rte_errno.h>
31 #include <rte_per_lcore.h>
32 #include <rte_lcore.h>
33 #include <rte_service_component.h>
35 #include <rte_random.h>
36 #include <rte_cycles.h>
37 #include <rte_string_fns.h>
38 #include <rte_cpuflags.h>
39 #include <rte_interrupts.h>
42 #include <rte_devargs.h>
43 #include <rte_version.h>
45 #include <rte_option.h>
46 #include <rte_atomic.h>
47 #include <malloc_heap.h>
49 #include "eal_private.h"
50 #include "eal_thread.h"
51 #include "eal_internal_cfg.h"
52 #include "eal_filesystem.h"
53 #include "eal_hugepages.h"
54 #include "eal_options.h"
56 #define MEMSIZE_IF_NO_HUGE_PAGE (64ULL * 1024ULL * 1024ULL)
58 /* Allow the application to print its usage message too if set */
59 static rte_usage_hook_t rte_application_usage_hook = NULL;
60 /* early configuration structure, when memory config is not mmapped */
61 static struct rte_mem_config early_mem_config;
63 /* define fd variable here, because file needs to be kept open for the
64 * duration of the program, as we hold a write lock on it in the primary proc */
65 static int mem_cfg_fd = -1;
67 static struct flock wr_lock = {
70 .l_start = offsetof(struct rte_mem_config, memsegs),
71 .l_len = sizeof(early_mem_config.memsegs),
74 /* Address of global and public configuration */
75 static struct rte_config rte_config = {
76 .mem_config = &early_mem_config,
79 /* internal configuration (per-core) */
80 struct lcore_config lcore_config[RTE_MAX_LCORE];
82 /* internal configuration */
83 struct internal_config internal_config;
85 /* used by rte_rdtsc() */
86 int rte_cycles_vmware_tsc_map;
88 /* platform-specific runtime dir */
89 static char runtime_dir[PATH_MAX];
91 static const char *default_runtime_dir = "/var/run";
94 eal_create_runtime_dir(void)
96 const char *directory = default_runtime_dir;
97 const char *xdg_runtime_dir = getenv("XDG_RUNTIME_DIR");
98 const char *fallback = "/tmp";
103 /* try XDG path first, fall back to /tmp */
104 if (xdg_runtime_dir != NULL)
105 directory = xdg_runtime_dir;
107 directory = fallback;
109 /* create DPDK subdirectory under runtime dir */
110 ret = snprintf(tmp, sizeof(tmp), "%s/dpdk", directory);
111 if (ret < 0 || ret == sizeof(tmp)) {
112 RTE_LOG(ERR, EAL, "Error creating DPDK runtime path name\n");
116 /* create prefix-specific subdirectory under DPDK runtime dir */
117 ret = snprintf(runtime_dir, sizeof(runtime_dir), "%s/%s",
118 tmp, internal_config.hugefile_prefix);
119 if (ret < 0 || ret == sizeof(runtime_dir)) {
120 RTE_LOG(ERR, EAL, "Error creating prefix-specific runtime path name\n");
124 /* create the path if it doesn't exist. no "mkdir -p" here, so do it
127 ret = mkdir(tmp, 0700);
128 if (ret < 0 && errno != EEXIST) {
129 RTE_LOG(ERR, EAL, "Error creating '%s': %s\n",
130 tmp, strerror(errno));
134 ret = mkdir(runtime_dir, 0700);
135 if (ret < 0 && errno != EEXIST) {
136 RTE_LOG(ERR, EAL, "Error creating '%s': %s\n",
137 runtime_dir, strerror(errno));
145 rte_eal_get_runtime_dir(void)
150 /* Return user provided mbuf pool ops name */
152 rte_eal_mbuf_user_pool_ops(void)
154 return internal_config.user_mbuf_pool_ops_name;
157 /* Return a pointer to the configuration structure */
159 rte_eal_get_configuration(void)
165 rte_eal_iova_mode(void)
167 return rte_eal_get_configuration()->iova_mode;
170 /* parse a sysfs (or other) file containing one integer value */
172 eal_parse_sysfs_value(const char *filename, unsigned long *val)
178 if ((f = fopen(filename, "r")) == NULL) {
179 RTE_LOG(ERR, EAL, "%s(): cannot open sysfs value %s\n",
184 if (fgets(buf, sizeof(buf), f) == NULL) {
185 RTE_LOG(ERR, EAL, "%s(): cannot read sysfs value %s\n",
190 *val = strtoul(buf, &end, 0);
191 if ((buf[0] == '\0') || (end == NULL) || (*end != '\n')) {
192 RTE_LOG(ERR, EAL, "%s(): cannot parse sysfs value %s\n",
202 /* create memory configuration in shared/mmap memory. Take out
203 * a write lock on the memsegs, so we can auto-detect primary/secondary.
204 * This means we never close the file while running (auto-close on exit).
205 * We also don't lock the whole file, so that in future we can use read-locks
206 * on other parts, e.g. memzones, to detect if there are running secondary
209 rte_eal_config_create(void)
211 void *rte_mem_cfg_addr;
214 const char *pathname = eal_runtime_config_path();
216 if (internal_config.no_shconf)
220 mem_cfg_fd = open(pathname, O_RDWR | O_CREAT, 0660);
222 rte_panic("Cannot open '%s' for rte_mem_config\n", pathname);
225 retval = ftruncate(mem_cfg_fd, sizeof(*rte_config.mem_config));
228 rte_panic("Cannot resize '%s' for rte_mem_config\n", pathname);
231 retval = fcntl(mem_cfg_fd, F_SETLK, &wr_lock);
234 rte_exit(EXIT_FAILURE, "Cannot create lock on '%s'. Is another primary "
235 "process running?\n", pathname);
238 rte_mem_cfg_addr = mmap(NULL, sizeof(*rte_config.mem_config),
239 PROT_READ | PROT_WRITE, MAP_SHARED, mem_cfg_fd, 0);
241 if (rte_mem_cfg_addr == MAP_FAILED){
242 rte_panic("Cannot mmap memory for rte_config\n");
244 memcpy(rte_mem_cfg_addr, &early_mem_config, sizeof(early_mem_config));
245 rte_config.mem_config = rte_mem_cfg_addr;
248 /* attach to an existing shared memory config */
250 rte_eal_config_attach(void)
252 void *rte_mem_cfg_addr;
253 const char *pathname = eal_runtime_config_path();
255 if (internal_config.no_shconf)
259 mem_cfg_fd = open(pathname, O_RDWR);
261 rte_panic("Cannot open '%s' for rte_mem_config\n", pathname);
264 rte_mem_cfg_addr = mmap(NULL, sizeof(*rte_config.mem_config),
265 PROT_READ | PROT_WRITE, MAP_SHARED, mem_cfg_fd, 0);
267 if (rte_mem_cfg_addr == MAP_FAILED)
268 rte_panic("Cannot mmap memory for rte_config\n");
270 rte_config.mem_config = rte_mem_cfg_addr;
273 /* Detect if we are a primary or a secondary process */
275 eal_proc_type_detect(void)
277 enum rte_proc_type_t ptype = RTE_PROC_PRIMARY;
278 const char *pathname = eal_runtime_config_path();
280 /* if there no shared config, there can be no secondary processes */
281 if (!internal_config.no_shconf) {
282 /* if we can open the file but not get a write-lock we are a
283 * secondary process. NOTE: if we get a file handle back, we
284 * keep that open and don't close it to prevent a race condition
285 * between multiple opens.
287 if (((mem_cfg_fd = open(pathname, O_RDWR)) >= 0) &&
288 (fcntl(mem_cfg_fd, F_SETLK, &wr_lock) < 0))
289 ptype = RTE_PROC_SECONDARY;
292 RTE_LOG(INFO, EAL, "Auto-detected process type: %s\n",
293 ptype == RTE_PROC_PRIMARY ? "PRIMARY" : "SECONDARY");
298 /* Sets up rte_config structure with the pointer to shared memory config.*/
300 rte_config_init(void)
302 rte_config.process_type = internal_config.process_type;
304 switch (rte_config.process_type){
305 case RTE_PROC_PRIMARY:
306 rte_eal_config_create();
308 case RTE_PROC_SECONDARY:
309 rte_eal_config_attach();
310 rte_eal_mcfg_wait_complete(rte_config.mem_config);
313 case RTE_PROC_INVALID:
314 rte_panic("Invalid process type\n");
320 eal_usage(const char *prgname)
322 printf("\nUsage: %s ", prgname);
324 /* Allow the application to print its usage message too if hook is set */
325 if ( rte_application_usage_hook ) {
326 printf("===== Application Usage =====\n\n");
327 rte_application_usage_hook(prgname);
331 /* Set a per-application usage message */
333 rte_set_application_usage_hook( rte_usage_hook_t usage_func )
335 rte_usage_hook_t old_func;
337 /* Will be NULL on the first call to denote the last usage routine. */
338 old_func = rte_application_usage_hook;
339 rte_application_usage_hook = usage_func;
345 eal_get_hugepage_mem_size(void)
350 for (i = 0; i < internal_config.num_hugepage_sizes; i++) {
351 struct hugepage_info *hpi = &internal_config.hugepage_info[i];
352 if (strnlen(hpi->hugedir, sizeof(hpi->hugedir)) != 0) {
353 for (j = 0; j < RTE_MAX_NUMA_NODES; j++) {
354 size += hpi->hugepage_sz * hpi->num_pages[j];
359 return (size < SIZE_MAX) ? (size_t)(size) : SIZE_MAX;
362 /* Parse the arguments for --log-level only */
364 eal_log_level_parse(int argc, char **argv)
369 const int old_optind = optind;
370 const int old_optopt = optopt;
371 const int old_optreset = optreset;
372 char * const old_optarg = optarg;
378 while ((opt = getopt_long(argc, argvopt, eal_short_options,
379 eal_long_options, &option_index)) != EOF) {
383 /* getopt is not happy, stop right now */
387 ret = (opt == OPT_LOG_LEVEL_NUM) ?
388 eal_parse_common_option(opt, optarg, &internal_config) : 0;
390 /* common parser is not happy */
395 /* restore getopt lib */
398 optreset = old_optreset;
402 /* Parse the argument given in the command line of the application */
404 eal_parse_args(int argc, char **argv)
409 char *prgname = argv[0];
410 const int old_optind = optind;
411 const int old_optopt = optopt;
412 const int old_optreset = optreset;
413 char * const old_optarg = optarg;
420 while ((opt = getopt_long(argc, argvopt, eal_short_options,
421 eal_long_options, &option_index)) != EOF) {
424 * getopt didn't recognise the option, lets parse the
425 * registered options to see if the flag is valid
428 ret = rte_option_parse(argv[optind-1]);
437 ret = eal_parse_common_option(opt, optarg, &internal_config);
438 /* common parser is not happy */
444 /* common parser handled this option */
449 case OPT_MBUF_POOL_OPS_NAME_NUM:
450 internal_config.user_mbuf_pool_ops_name =
457 if (opt < OPT_LONG_MIN_NUM && isprint(opt)) {
458 RTE_LOG(ERR, EAL, "Option %c is not supported "
459 "on FreeBSD\n", opt);
460 } else if (opt >= OPT_LONG_MIN_NUM &&
461 opt < OPT_LONG_MAX_NUM) {
462 RTE_LOG(ERR, EAL, "Option %s is not supported "
464 eal_long_options[option_index].name);
466 RTE_LOG(ERR, EAL, "Option %d is not supported "
467 "on FreeBSD\n", opt);
475 /* create runtime data directory */
476 if (internal_config.no_shconf == 0 &&
477 eal_create_runtime_dir() < 0) {
478 RTE_LOG(ERR, EAL, "Cannot create runtime directory\n");
483 if (eal_adjust_config(&internal_config) != 0) {
489 if (eal_check_common_options(&internal_config) != 0) {
496 argv[optind-1] = prgname;
500 /* restore getopt lib */
503 optreset = old_optreset;
510 check_socket(const struct rte_memseg_list *msl, void *arg)
512 int *socket_id = arg;
517 if (msl->socket_id == *socket_id && msl->memseg_arr.count != 0)
524 eal_check_mem_on_local_socket(void)
528 socket_id = rte_lcore_to_socket_id(rte_config.master_lcore);
530 if (rte_memseg_list_walk(check_socket, &socket_id) == 0)
531 RTE_LOG(WARNING, EAL, "WARNING: Master core has no memory on local socket!\n");
536 sync_func(__attribute__((unused)) void *arg)
542 rte_eal_mcfg_complete(void)
544 /* ALL shared mem_config related INIT DONE */
545 if (rte_config.process_type == RTE_PROC_PRIMARY)
546 rte_config.mem_config->magic = RTE_MAGIC;
549 /* return non-zero if hugepages are enabled. */
550 int rte_eal_has_hugepages(void)
552 return !internal_config.no_hugetlbfs;
555 /* Abstraction for port I/0 privilege */
557 rte_eal_iopl_init(void)
561 fd = open("/dev/io", O_RDWR);
564 /* keep fd open for iopl */
568 static void rte_eal_init_alert(const char *msg)
570 fprintf(stderr, "EAL: FATAL: %s\n", msg);
571 RTE_LOG(ERR, EAL, "%s\n", msg);
574 /* Launch threads, called at application init(). */
576 rte_eal_init(int argc, char **argv)
580 static rte_atomic32_t run_once = RTE_ATOMIC32_INIT(0);
581 char cpuset[RTE_CPU_AFFINITY_STR_LEN];
582 char thread_name[RTE_MAX_THREAD_NAME_LEN];
584 /* checks if the machine is adequate */
585 if (!rte_cpu_is_supported()) {
586 rte_eal_init_alert("unsupported cpu type.");
591 if (!rte_atomic32_test_and_set(&run_once)) {
592 rte_eal_init_alert("already called initialization.");
593 rte_errno = EALREADY;
597 thread_id = pthread_self();
599 eal_reset_internal_config(&internal_config);
601 /* set log level as early as possible */
602 eal_log_level_parse(argc, argv);
604 if (rte_eal_cpu_init() < 0) {
605 rte_eal_init_alert("Cannot detect lcores.");
610 fctret = eal_parse_args(argc, argv);
612 rte_eal_init_alert("Invalid 'command line' arguments.");
614 rte_atomic32_clear(&run_once);
618 /* FreeBSD always uses legacy memory model */
619 internal_config.legacy_mem = true;
621 if (eal_plugins_init() < 0) {
622 rte_eal_init_alert("Cannot init plugins");
624 rte_atomic32_clear(&run_once);
628 if (eal_option_device_parse()) {
630 rte_atomic32_clear(&run_once);
636 if (rte_eal_intr_init() < 0) {
637 rte_eal_init_alert("Cannot init interrupt-handling thread");
641 /* Put mp channel init before bus scan so that we can init the vdev
642 * bus through mp channel in the secondary process before the bus scan.
644 if (rte_mp_channel_init() < 0) {
645 rte_eal_init_alert("failed to init mp channel");
646 if (rte_eal_process_type() == RTE_PROC_PRIMARY) {
652 if (rte_bus_scan()) {
653 rte_eal_init_alert("Cannot scan the buses for devices");
655 rte_atomic32_clear(&run_once);
659 /* if no EAL option "--iova-mode=<pa|va>", use bus IOVA scheme */
660 if (internal_config.iova_mode == RTE_IOVA_DC) {
661 /* autodetect the IOVA mapping mode (default is RTE_IOVA_PA) */
662 rte_eal_get_configuration()->iova_mode =
663 rte_bus_get_iommu_class();
665 rte_eal_get_configuration()->iova_mode =
666 internal_config.iova_mode;
669 if (internal_config.no_hugetlbfs == 0) {
670 /* rte_config isn't initialized yet */
671 ret = internal_config.process_type == RTE_PROC_PRIMARY ?
672 eal_hugepage_info_init() :
673 eal_hugepage_info_read();
675 rte_eal_init_alert("Cannot get hugepage information.");
677 rte_atomic32_clear(&run_once);
682 if (internal_config.memory == 0 && internal_config.force_sockets == 0) {
683 if (internal_config.no_hugetlbfs)
684 internal_config.memory = MEMSIZE_IF_NO_HUGE_PAGE;
686 internal_config.memory = eal_get_hugepage_mem_size();
689 if (internal_config.vmware_tsc_map == 1) {
690 #ifdef RTE_LIBRTE_EAL_VMWARE_TSC_MAP_SUPPORT
691 rte_cycles_vmware_tsc_map = 1;
692 RTE_LOG (DEBUG, EAL, "Using VMWARE TSC MAP, "
693 "you must have monitor_control.pseudo_perfctr = TRUE\n");
695 RTE_LOG (WARNING, EAL, "Ignoring --vmware-tsc-map because "
696 "RTE_LIBRTE_EAL_VMWARE_TSC_MAP_SUPPORT is not set\n");
700 rte_srand(rte_rdtsc());
702 /* in secondary processes, memory init may allocate additional fbarrays
703 * not present in primary processes, so to avoid any potential issues,
704 * initialize memzones first.
706 if (rte_eal_memzone_init() < 0) {
707 rte_eal_init_alert("Cannot init memzone");
712 if (rte_eal_memory_init() < 0) {
713 rte_eal_init_alert("Cannot init memory");
718 if (rte_eal_malloc_heap_init() < 0) {
719 rte_eal_init_alert("Cannot init malloc heap");
724 if (rte_eal_tailqs_init() < 0) {
725 rte_eal_init_alert("Cannot init tail queues for objects");
730 if (rte_eal_alarm_init() < 0) {
731 rte_eal_init_alert("Cannot init interrupt-handling thread");
732 /* rte_eal_alarm_init sets rte_errno on failure. */
736 if (rte_eal_timer_init() < 0) {
737 rte_eal_init_alert("Cannot init HPET or TSC timers");
742 eal_check_mem_on_local_socket();
744 eal_thread_init_master(rte_config.master_lcore);
746 ret = eal_thread_dump_affinity(cpuset, sizeof(cpuset));
748 RTE_LOG(DEBUG, EAL, "Master lcore %u is ready (tid=%p;cpuset=[%s%s])\n",
749 rte_config.master_lcore, thread_id, cpuset,
750 ret == 0 ? "" : "...");
752 RTE_LCORE_FOREACH_SLAVE(i) {
755 * create communication pipes between master thread
758 if (pipe(lcore_config[i].pipe_master2slave) < 0)
759 rte_panic("Cannot create pipe\n");
760 if (pipe(lcore_config[i].pipe_slave2master) < 0)
761 rte_panic("Cannot create pipe\n");
763 lcore_config[i].state = WAIT;
765 /* create a thread for each lcore */
766 ret = pthread_create(&lcore_config[i].thread_id, NULL,
767 eal_thread_loop, NULL);
769 rte_panic("Cannot create thread\n");
771 /* Set thread_name for aid in debugging. */
772 snprintf(thread_name, sizeof(thread_name),
773 "lcore-slave-%d", i);
774 rte_thread_setname(lcore_config[i].thread_id, thread_name);
778 * Launch a dummy function on all slave lcores, so that master lcore
779 * knows they are all ready when this function returns.
781 rte_eal_mp_remote_launch(sync_func, NULL, SKIP_MASTER);
782 rte_eal_mp_wait_lcore();
784 /* initialize services so vdevs register service during bus_probe. */
785 ret = rte_service_init();
787 rte_eal_init_alert("rte_service_init() failed");
792 /* Probe all the buses and devices/drivers on them */
793 if (rte_bus_probe()) {
794 rte_eal_init_alert("Cannot probe devices");
799 /* initialize default service/lcore mappings and start running. Ignore
800 * -ENOTSUP, as it indicates no service coremask passed to EAL.
802 ret = rte_service_start_with_defaults();
803 if (ret < 0 && ret != -ENOTSUP) {
808 rte_eal_mcfg_complete();
810 /* Call each registered callback, if enabled */
816 int __rte_experimental
817 rte_eal_cleanup(void)
819 rte_service_finalize();
824 enum rte_lcore_role_t
825 rte_eal_lcore_role(unsigned lcore_id)
827 return rte_config.lcore_role[lcore_id];
831 rte_eal_process_type(void)
833 return rte_config.process_type;
836 int rte_eal_has_pci(void)
838 return !internal_config.no_pci;
841 int rte_eal_create_uio_dev(void)
843 return internal_config.create_uio_dev;
847 rte_eal_vfio_intr_mode(void)
849 return RTE_INTR_MODE_NONE;
852 int rte_vfio_setup_device(__rte_unused const char *sysfs_base,
853 __rte_unused const char *dev_addr,
854 __rte_unused int *vfio_dev_fd,
855 __rte_unused struct vfio_device_info *device_info)
860 int rte_vfio_release_device(__rte_unused const char *sysfs_base,
861 __rte_unused const char *dev_addr,
867 int rte_vfio_enable(__rte_unused const char *modname)
872 int rte_vfio_is_enabled(__rte_unused const char *modname)
877 int rte_vfio_noiommu_is_enabled(void)
882 int rte_vfio_clear_group(__rte_unused int vfio_group_fd)
888 rte_vfio_dma_map(uint64_t __rte_unused vaddr, __rte_unused uint64_t iova,
889 __rte_unused uint64_t len)
895 rte_vfio_dma_unmap(uint64_t __rte_unused vaddr, uint64_t __rte_unused iova,
896 __rte_unused uint64_t len)
902 rte_vfio_get_group_num(__rte_unused const char *sysfs_base,
903 __rte_unused const char *dev_addr,
904 __rte_unused int *iommu_group_num)
910 rte_vfio_get_container_fd(void)
916 rte_vfio_get_group_fd(__rte_unused int iommu_group_num)
922 rte_vfio_container_create(void)
928 rte_vfio_container_destroy(__rte_unused int container_fd)
934 rte_vfio_container_group_bind(__rte_unused int container_fd,
935 __rte_unused int iommu_group_num)
941 rte_vfio_container_group_unbind(__rte_unused int container_fd,
942 __rte_unused int iommu_group_num)
948 rte_vfio_container_dma_map(__rte_unused int container_fd,
949 __rte_unused uint64_t vaddr,
950 __rte_unused uint64_t iova,
951 __rte_unused uint64_t len)
957 rte_vfio_container_dma_unmap(__rte_unused int container_fd,
958 __rte_unused uint64_t vaddr,
959 __rte_unused uint64_t iova,
960 __rte_unused uint64_t len)