1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2010-2018 Intel Corporation
5 #ifndef _EAL_PRIVATE_H_
6 #define _EAL_PRIVATE_H_
15 * Initialize the memzone subsystem (private to eal).
21 int rte_eal_memzone_init(void);
24 * Common log initialization function (private to eal). Determines
25 * where log data is written when no call to rte_openlog_stream is
29 * The default log stream to be used.
34 void eal_log_set_default(FILE *default_log);
37 * Fill configuration with number of physical and logical processors
39 * This function is private to EAL.
41 * Parse /proc/cpuinfo to get the number of physical and logical
42 * processors on the machine.
45 * 0 on success, negative on error
47 int rte_eal_cpu_init(void);
52 * This function is private to EAL.
54 * Fill configuration structure with these infos, and return 0 on success.
57 * 0 on success, negative on error
59 int rte_eal_memory_init(void);
64 * This function is private to EAL.
66 * Mmap memory areas used by HPET (high precision event timer) that will
67 * provide our time reference, and configure the TSC frequency also for it
68 * to be used as a reference.
71 * 0 on success, negative on error
73 int rte_eal_timer_init(void);
76 * Init the default log stream
78 * This function is private to EAL.
81 * 0 on success, negative on error
83 int rte_eal_log_init(const char *id, int facility);
86 * Init tail queues for non-EAL library structures. This is to allow
87 * the rings, mempools, etc. lists to be shared among multiple processes
89 * This function is private to EAL
92 * 0 on success, negative on error
94 int rte_eal_tailqs_init(void);
97 * Init interrupt handling.
99 * This function is private to EAL.
102 * 0 on success, negative on error
104 int rte_eal_intr_init(void);
107 * Init alarm mechanism. This is to allow a callback be called after
110 * This function is private to EAL.
113 * 0 on success, negative on error
115 int rte_eal_alarm_init(void);
118 * Function is to check if the kernel module(like, vfio, vfio_iommu_type1,
122 * The module's name which need to be checked
125 * -1 means some error happens(NULL pointer or open failure)
126 * 0 means the module not loaded
127 * 1 means the module loaded
129 int rte_eal_check_module(const char *module_name);
132 * Get virtual area of specified size from the OS.
134 * This function is private to the EAL.
136 * @param requested_addr
137 * Address where to request address space.
139 * Size of requested area.
141 * Page size on which to align requested virtual area.
143 * EAL_VIRTUAL_AREA_* flags.
145 * Extra flags passed directly to mmap().
148 * Virtual area address if successful.
149 * NULL if unsuccessful.
152 #define EAL_VIRTUAL_AREA_ADDR_IS_HINT (1 << 0)
153 /**< don't fail if cannot get exact requested address. */
154 #define EAL_VIRTUAL_AREA_ALLOW_SHRINK (1 << 1)
155 /**< try getting smaller sized (decrement by page size) virtual areas if cannot
156 * get area of requested size.
158 #define EAL_VIRTUAL_AREA_UNMAP (1 << 2)
159 /**< immediately unmap reserved virtual area. */
161 eal_get_virtual_area(void *requested_addr, size_t *size,
162 size_t page_sz, int flags, int mmap_flags);
167 * This function is private to the EAL.
169 unsigned eal_cpu_core_id(unsigned lcore_id);
172 * Check if cpu is present.
174 * This function is private to the EAL.
176 int eal_cpu_detected(unsigned lcore_id);
179 * Set TSC frequency from precise value or estimation
181 * This function is private to the EAL.
183 void set_tsc_freq(void);
186 * Get precise TSC frequency from system
188 * This function is private to the EAL.
190 uint64_t get_tsc_freq(void);
193 * Get TSC frequency if the architecture supports.
195 * This function is private to the EAL.
198 * The number of TSC cycles in one second.
199 * Returns zero if the architecture support is not available.
201 uint64_t get_tsc_freq_arch(void);
204 * Prepare physical memory mapping
205 * i.e. hugepages on Linux and
208 * This function is private to the EAL.
210 int rte_eal_hugepage_init(void);
213 * Creates memory mapping in secondary process
214 * i.e. hugepages on Linux and
217 * This function is private to the EAL.
219 int rte_eal_hugepage_attach(void);
222 * Find a bus capable of identifying a device.
225 * A device identifier (PCI address, virtual PMD name, ...).
228 * A valid bus handle if found.
229 * NULL if no bus is able to parse this device.
231 struct rte_bus *rte_bus_find_by_device_name(const char *str);
234 * Create the unix channel for primary/secondary communication.
241 int rte_mp_channel_init(void);
244 * Internal Executes all the user application registered callbacks for
245 * the specific device. It is for DPDK internal user only. User
246 * application should not call it directly.
251 * the device event type.
253 void dev_callback_process(char *device_name, enum rte_dev_event_type event);
255 #endif /* _EAL_PRIVATE_H_ */