eal/windows: add missing SPDX license tag
[dpdk.git] / lib / librte_eal / common / eal_internal_cfg.h
1 /* SPDX-License-Identifier: BSD-3-Clause
2  * Copyright(c) 2010-2014 Intel Corporation
3  */
4
5 /**
6  * @file
7  * Holds the structures for the eal internal configuration
8  */
9
10 #ifndef EAL_INTERNAL_CFG_H
11 #define EAL_INTERNAL_CFG_H
12
13 #include <rte_eal.h>
14 #include <rte_pci_dev_feature_defs.h>
15
16 #include "eal_thread.h"
17
18 #if defined(RTE_ARCH_ARM)
19 #define MAX_HUGEPAGE_SIZES 4  /**< support up to 4 page sizes */
20 #else
21 #define MAX_HUGEPAGE_SIZES 3  /**< support up to 3 page sizes */
22 #endif
23
24 /*
25  * internal configuration structure for the number, size and
26  * mount points of hugepages
27  */
28 struct hugepage_info {
29         uint64_t hugepage_sz;   /**< size of a huge page */
30         char hugedir[PATH_MAX];    /**< dir where hugetlbfs is mounted */
31         uint32_t num_pages[RTE_MAX_NUMA_NODES];
32         /**< number of hugepages of that size on each socket */
33         int lock_descriptor;    /**< file descriptor for hugepage dir */
34 };
35
36 struct simd_bitwidth {
37         bool forced;
38         /**< flag indicating if bitwidth is forced and can't be modified */
39         uint16_t bitwidth; /**< bitwidth value */
40 };
41
42 /**
43  * internal configuration
44  */
45 struct internal_config {
46         volatile size_t memory;           /**< amount of asked memory */
47         volatile unsigned force_nchannel; /**< force number of channels */
48         volatile unsigned force_nrank;    /**< force number of ranks */
49         volatile unsigned no_hugetlbfs;   /**< true to disable hugetlbfs */
50         unsigned hugepage_unlink;         /**< true to unlink backing files */
51         volatile unsigned no_pci;         /**< true to disable PCI */
52         volatile unsigned no_hpet;        /**< true to disable HPET */
53         volatile unsigned vmware_tsc_map; /**< true to use VMware TSC mapping
54                                                                                 * instead of native TSC */
55         volatile unsigned no_shconf;      /**< true if there is no shared config */
56         volatile unsigned in_memory;
57         /**< true if DPDK should operate entirely in-memory and not create any
58          * shared files or runtime data.
59          */
60         volatile unsigned create_uio_dev; /**< true to create /dev/uioX devices */
61         volatile enum rte_proc_type_t process_type; /**< multi-process proc type */
62         /** true to try allocating memory on specific sockets */
63         volatile unsigned force_sockets;
64         volatile uint64_t socket_mem[RTE_MAX_NUMA_NODES]; /**< amount of memory per socket */
65         volatile unsigned force_socket_limits;
66         volatile uint64_t socket_limit[RTE_MAX_NUMA_NODES]; /**< limit amount of memory per socket */
67         uintptr_t base_virtaddr;          /**< base address to try and reserve memory from */
68         volatile unsigned legacy_mem;
69         /**< true to enable legacy memory behavior (no dynamic allocation,
70          * IOVA-contiguous segments).
71          */
72         volatile unsigned match_allocations;
73         /**< true to free hugepages exactly as allocated */
74         volatile unsigned single_file_segments;
75         /**< true if storing all pages within single files (per-page-size,
76          * per-node) non-legacy mode only.
77          */
78         volatile int syslog_facility;     /**< facility passed to openlog() */
79         /** default interrupt mode for VFIO */
80         volatile enum rte_intr_mode vfio_intr_mode;
81         /** the shared VF token for VFIO-PCI bound PF and VFs devices */
82         rte_uuid_t vfio_vf_token;
83         char *hugefile_prefix;      /**< the base filename of hugetlbfs files */
84         char *hugepage_dir;         /**< specific hugetlbfs directory to use */
85         char *user_mbuf_pool_ops_name;
86                         /**< user defined mbuf pool ops name */
87         unsigned num_hugepage_sizes;      /**< how many sizes on this system */
88         struct hugepage_info hugepage_info[MAX_HUGEPAGE_SIZES];
89         enum rte_iova_mode iova_mode ;    /**< Set IOVA mode on this system  */
90         rte_cpuset_t ctrl_cpuset;         /**< cpuset for ctrl threads */
91         volatile unsigned int init_complete;
92         /**< indicates whether EAL has completed initialization */
93         unsigned int no_telemetry; /**< true to disable Telemetry */
94         struct simd_bitwidth max_simd_bitwidth;
95         /**< max simd bitwidth path to use */
96 };
97
98 void eal_reset_internal_config(struct internal_config *internal_cfg);
99
100 #endif /* EAL_INTERNAL_CFG_H */