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 * Save the log regexp for later
88 int rte_log_save_regexp(const char *type, int priority);
89 int rte_log_save_pattern(const char *pattern, int priority);
92 * Init tail queues for non-EAL library structures. This is to allow
93 * the rings, mempools, etc. lists to be shared among multiple processes
95 * This function is private to EAL
98 * 0 on success, negative on error
100 int rte_eal_tailqs_init(void);
103 * Init interrupt handling.
105 * This function is private to EAL.
108 * 0 on success, negative on error
110 int rte_eal_intr_init(void);
113 * Init alarm mechanism. This is to allow a callback be called after
116 * This function is private to EAL.
119 * 0 on success, negative on error
121 int rte_eal_alarm_init(void);
124 * Function is to check if the kernel module(like, vfio, vfio_iommu_type1,
128 * The module's name which need to be checked
131 * -1 means some error happens(NULL pointer or open failure)
132 * 0 means the module not loaded
133 * 1 means the module loaded
135 int rte_eal_check_module(const char *module_name);
138 * Get virtual area of specified size from the OS.
140 * This function is private to the EAL.
142 * @param requested_addr
143 * Address where to request address space.
145 * Size of requested area.
147 * Page size on which to align requested virtual area.
149 * EAL_VIRTUAL_AREA_* flags.
151 * Extra flags passed directly to mmap().
154 * Virtual area address if successful.
155 * NULL if unsuccessful.
158 #define EAL_VIRTUAL_AREA_ADDR_IS_HINT (1 << 0)
159 /**< don't fail if cannot get exact requested address. */
160 #define EAL_VIRTUAL_AREA_ALLOW_SHRINK (1 << 1)
161 /**< try getting smaller sized (decrement by page size) virtual areas if cannot
162 * get area of requested size.
164 #define EAL_VIRTUAL_AREA_UNMAP (1 << 2)
165 /**< immediately unmap reserved virtual area. */
167 eal_get_virtual_area(void *requested_addr, size_t *size,
168 size_t page_sz, int flags, int mmap_flags);
173 * This function is private to the EAL.
175 unsigned eal_cpu_core_id(unsigned lcore_id);
178 * Check if cpu is present.
180 * This function is private to the EAL.
182 int eal_cpu_detected(unsigned lcore_id);
185 * Set TSC frequency from precise value or estimation
187 * This function is private to the EAL.
189 void set_tsc_freq(void);
192 * Get precise TSC frequency from system
194 * This function is private to the EAL.
196 uint64_t get_tsc_freq(void);
199 * Get TSC frequency if the architecture supports.
201 * This function is private to the EAL.
204 * The number of TSC cycles in one second.
205 * Returns zero if the architecture support is not available.
207 uint64_t get_tsc_freq_arch(void);
210 * Prepare physical memory mapping
211 * i.e. hugepages on Linux and
214 * This function is private to the EAL.
216 int rte_eal_hugepage_init(void);
219 * Creates memory mapping in secondary process
220 * i.e. hugepages on Linux and
223 * This function is private to the EAL.
225 int rte_eal_hugepage_attach(void);
228 * Find a bus capable of identifying a device.
231 * A device identifier (PCI address, virtual PMD name, ...).
234 * A valid bus handle if found.
235 * NULL if no bus is able to parse this device.
237 struct rte_bus *rte_bus_find_by_device_name(const char *str);
240 * Create the unix channel for primary/secondary communication.
247 int rte_mp_channel_init(void);
250 * Internal Executes all the user application registered callbacks for
251 * the specific device. It is for DPDK internal user only. User
252 * application should not call it directly.
257 * the device event type.
259 void dev_callback_process(char *device_name, enum rte_dev_event_type event);
261 #endif /* _EAL_PRIVATE_H_ */