1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2010-2018 Intel Corporation
5 #ifndef _EAL_PRIVATE_H_
6 #define _EAL_PRIVATE_H_
11 #include <sys/queue.h>
14 #include <rte_lcore.h>
15 #include <rte_memory.h>
17 #include "eal_internal_cfg.h"
20 * Structure storing internal configuration (per-lcore)
23 pthread_t thread_id; /**< pthread identifier */
24 int pipe_main2worker[2]; /**< communication pipe with main */
25 int pipe_worker2main[2]; /**< communication pipe with main */
27 lcore_function_t * volatile f; /**< function to call */
28 void * volatile arg; /**< argument of function */
29 volatile int ret; /**< return value of function */
31 volatile enum rte_lcore_state_t state; /**< lcore state */
32 unsigned int socket_id; /**< physical socket id for this lcore */
33 unsigned int core_id; /**< core number on socket for this lcore */
34 int core_index; /**< relative index, starting from 0 */
35 uint8_t core_role; /**< role of core eg: OFF, RTE, SERVICE */
37 rte_cpuset_t cpuset; /**< cpu set which the lcore affinity to */
40 extern struct lcore_config lcore_config[RTE_MAX_LCORE];
43 * The global RTE configuration structure.
46 uint32_t main_lcore; /**< Id of the main lcore */
47 uint32_t lcore_count; /**< Number of available logical cores. */
48 uint32_t numa_node_count; /**< Number of detected NUMA nodes. */
49 uint32_t numa_nodes[RTE_MAX_NUMA_NODES]; /**< List of detected NUMA nodes. */
50 uint32_t service_lcore_count;/**< Number of available service cores. */
51 enum rte_lcore_role_t lcore_role[RTE_MAX_LCORE]; /**< State of cores. */
53 /** Primary or secondary configuration */
54 enum rte_proc_type_t process_type;
56 /** PA or VA mapping mode */
57 enum rte_iova_mode iova_mode;
60 * Pointer to memory configuration, which may be shared across multiple
63 struct rte_mem_config *mem_config;
67 * Get the global configuration structure.
70 * A pointer to the global configuration structure.
72 struct rte_config *rte_eal_get_configuration(void);
75 * Initialize the memzone subsystem (private to eal).
81 int rte_eal_memzone_init(void);
84 * Fill configuration with number of physical and logical processors
86 * This function is private to EAL.
88 * Parse /proc/cpuinfo to get the number of physical and logical
89 * processors on the machine.
92 * 0 on success, negative on error
94 int rte_eal_cpu_init(void);
99 * This function is private to EAL.
101 * Preallocate virtual memory.
104 * 0 on success, negative on error
106 int rte_eal_memseg_init(void);
111 * This function is private to EAL.
113 * Fill configuration structure with these infos, and return 0 on success.
116 * 0 on success, negative on error
118 int rte_eal_memory_init(void);
123 * This function is private to EAL.
125 * Mmap memory areas used by HPET (high precision event timer) that will
126 * provide our time reference, and configure the TSC frequency also for it
127 * to be used as a reference.
130 * 0 on success, negative on error
132 int rte_eal_timer_init(void);
135 * Init tail queues for non-EAL library structures. This is to allow
136 * the rings, mempools, etc. lists to be shared among multiple processes
138 * This function is private to EAL
141 * 0 on success, negative on error
143 int rte_eal_tailqs_init(void);
146 * Init interrupt handling.
148 * This function is private to EAL.
151 * 0 on success, negative on error
153 int rte_eal_intr_init(void);
156 * Init alarm mechanism. This is to allow a callback be called after
159 * This function is private to EAL.
162 * 0 on success, negative on error
164 int rte_eal_alarm_init(void);
167 * Alarm mechanism cleanup.
169 * This function is private to EAL.
172 * 0 on success, negative on error
174 void rte_eal_alarm_cleanup(void);
177 * Function is to check if the kernel module(like, vfio, vfio_iommu_type1,
181 * The module's name which need to be checked
184 * -1 means some error happens(NULL pointer or open failure)
185 * 0 means the module not loaded
186 * 1 means the module loaded
188 int rte_eal_check_module(const char *module_name);
191 * Memory reservation flags.
193 enum eal_mem_reserve_flags {
195 * Reserve hugepages. May be unsupported by some platforms.
197 EAL_RESERVE_HUGEPAGES = 1 << 0,
199 * Force reserving memory at the requested address.
200 * This can be a destructive action depending on the implementation.
202 * @see RTE_MAP_FORCE_ADDRESS for description of possible consequences
203 * (although implementations are not required to use it).
205 EAL_RESERVE_FORCE_ADDRESS = 1 << 1
209 * Get virtual area of specified size from the OS.
211 * This function is private to the EAL.
213 * @param requested_addr
214 * Address where to request address space.
216 * Size of requested area.
218 * Page size on which to align requested virtual area.
220 * EAL_VIRTUAL_AREA_* flags.
221 * @param reserve_flags
222 * Extra flags passed directly to eal_mem_reserve().
225 * Virtual area address if successful.
226 * NULL if unsuccessful.
229 #define EAL_VIRTUAL_AREA_ADDR_IS_HINT (1 << 0)
230 /**< don't fail if cannot get exact requested address. */
231 #define EAL_VIRTUAL_AREA_ALLOW_SHRINK (1 << 1)
232 /**< try getting smaller sized (decrement by page size) virtual areas if cannot
233 * get area of requested size.
235 #define EAL_VIRTUAL_AREA_UNMAP (1 << 2)
236 /**< immediately unmap reserved virtual area. */
238 eal_get_virtual_area(void *requested_addr, size_t *size,
239 size_t page_sz, int flags, int reserve_flags);
242 * Initialize a memory segment list and create its backing storage.
245 * Memory segment list to be filled.
247 * Name for the backing storage.
249 * Size of segment pages in the MSL.
251 * Number of segments.
253 * Socket ID. Must not be SOCKET_ID_ANY.
255 * Mark MSL as pointing to a heap.
257 * 0 on success, (-1) on failure and rte_errno is set.
260 eal_memseg_list_init_named(struct rte_memseg_list *msl, const char *name,
261 uint64_t page_sz, int n_segs, int socket_id, bool heap);
264 * Initialize memory segment list and create its backing storage
265 * with a name corresponding to MSL parameters.
267 * @param type_msl_idx
268 * Index of the MSL among other MSLs of the same socket and page size.
270 * @see eal_memseg_list_init_named for remaining parameters description.
273 eal_memseg_list_init(struct rte_memseg_list *msl, uint64_t page_sz,
274 int n_segs, int socket_id, int type_msl_idx, bool heap);
277 * Reserve VA space for a memory segment list
278 * previously initialized with eal_memseg_list_init().
281 * Initialized memory segment list with page size defined.
282 * @param reserve_flags
283 * Extra memory reservation flags. Can be 0 if unnecessary.
285 * 0 on success, (-1) on failure and rte_errno is set.
288 eal_memseg_list_alloc(struct rte_memseg_list *msl, int reserve_flags);
291 * Populate MSL, each segment is one page long.
294 * Initialized memory segment list with page size defined.
296 * Starting address of list segments.
298 * Number of segments to populate.
301 eal_memseg_list_populate(struct rte_memseg_list *msl, void *addr, int n_segs);
304 * Distribute available memory between MSLs.
307 * 0 on success, (-1) on failure.
310 eal_dynmem_memseg_lists_init(void);
313 * Preallocate hugepages for dynamic allocation.
316 * 0 on success, (-1) on failure.
319 eal_dynmem_hugepage_init(void);
322 * Given the list of hugepage sizes and the number of pages thereof,
323 * calculate the best number of pages of each size to fulfill the request
324 * for RAM on each NUMA node.
327 * Amounts of memory requested for each NUMA node of RTE_MAX_NUMA_NODES.
329 * Information about hugepages of different size.
331 * Receives information about used hugepages of each size.
333 * Number of elements in hp_info and hp_used.
335 * 0 on success, (-1) on failure.
338 eal_dynmem_calc_num_pages_per_socket(
339 uint64_t *memory, struct hugepage_info *hp_info,
340 struct hugepage_info *hp_used, unsigned int num_hp_info);
345 * This function is private to the EAL.
347 unsigned eal_cpu_core_id(unsigned lcore_id);
350 * Check if cpu is present.
352 * This function is private to the EAL.
354 int eal_cpu_detected(unsigned lcore_id);
357 * Set TSC frequency from precise value or estimation
359 * This function is private to the EAL.
361 void set_tsc_freq(void);
364 * Get precise TSC frequency from system
366 * This function is private to the EAL.
368 uint64_t get_tsc_freq(void);
371 * Get TSC frequency if the architecture supports.
373 * This function is private to the EAL.
376 * The number of TSC cycles in one second.
377 * Returns zero if the architecture support is not available.
379 uint64_t get_tsc_freq_arch(void);
382 * Allocate a free lcore to associate to a non-EAL thread.
385 * - the id of a lcore with role ROLE_NON_EAL on success.
386 * - RTE_MAX_LCORE if none was available or initializing was refused (see
387 * rte_lcore_callback_register).
389 unsigned int eal_lcore_non_eal_allocate(void);
392 * Release the lcore used by a non-EAL thread.
393 * Counterpart of eal_lcore_non_eal_allocate().
396 * The lcore with role ROLE_NON_EAL to release.
398 void eal_lcore_non_eal_release(unsigned int lcore_id);
401 * Prepare physical memory mapping
402 * i.e. hugepages on Linux and
405 * This function is private to the EAL.
407 int rte_eal_hugepage_init(void);
410 * Creates memory mapping in secondary process
411 * i.e. hugepages on Linux and
414 * This function is private to the EAL.
416 int rte_eal_hugepage_attach(void);
419 * Detaches all memory mappings from a process.
421 * This function is private to the EAL.
423 int rte_eal_memory_detach(void);
426 * Find a bus capable of identifying a device.
429 * A device identifier (PCI address, virtual PMD name, ...).
432 * A valid bus handle if found.
433 * NULL if no bus is able to parse this device.
435 struct rte_bus *rte_bus_find_by_device_name(const char *str);
438 * Create the unix channel for primary/secondary communication.
444 int rte_mp_channel_init(void);
447 * Primary/secondary communication cleanup.
449 void rte_mp_channel_cleanup(void);
453 * Parse a device string and store its information in an
454 * rte_devargs structure.
456 * A device description is split by layers of abstraction of the device:
457 * bus, class and driver. Each layer will offer a set of properties that
458 * can be applied either to configure or recognize a device.
460 * This function will parse those properties and prepare the rte_devargs
461 * to be given to each layers for processing.
463 * Note: if the "data" field of the devargs points to devstr,
464 * then no dynamic allocation is performed and the rte_devargs
465 * can be safely discarded.
467 * Otherwise ``data`` will hold a workable copy of devstr, that will be
468 * used by layers descriptors within rte_devargs. In this case,
469 * any rte_devargs should be cleaned-up before being freed.
472 * rte_devargs structure to fill.
479 * Negative errno values on error (rte_errno is set).
482 rte_devargs_layers_parse(struct rte_devargs *devargs,
486 * probe a device at local process.
489 * Device arguments including bus, class and driver properties.
491 * new device be probed as output.
493 * 0 on success, negative on error.
495 int local_dev_probe(const char *devargs, struct rte_device **new_dev);
498 * Hotplug remove a given device from a specific bus at local process.
501 * Data structure of the device to remove.
503 * 0 on success, negative on error.
505 int local_dev_remove(struct rte_device *dev);
508 * Iterate over all buses to find the corresponding bus to handle the sigbus
510 * @param failure_addr
511 * Pointer of the fault address of the sigbus error.
514 * 0 success to handle the sigbus.
515 * -1 failed to handle the sigbus
516 * 1 no bus can handler the sigbus
518 int rte_bus_sigbus_handler(const void *failure_addr);
522 * Register the sigbus handler.
525 * - On success, zero.
526 * - On failure, a negative value.
529 dev_sigbus_handler_register(void);
533 * Unregister the sigbus handler.
536 * - On success, zero.
537 * - On failure, a negative value.
540 dev_sigbus_handler_unregister(void);
543 * Get OS-specific EAL mapping base address.
546 eal_get_baseaddr(void);
549 eal_malloc_no_trace(const char *type, size_t size, unsigned int align);
551 void eal_free_no_trace(void *addr);
553 /** Options for eal_file_open(). */
554 enum eal_open_flags {
555 /** Open file for reading. */
556 EAL_OPEN_READONLY = 0x00,
557 /** Open file for reading and writing. */
558 EAL_OPEN_READWRITE = 0x02,
560 * Create the file if it doesn't exist.
561 * New files are only accessible to the owner (0600 equivalent).
563 EAL_OPEN_CREATE = 0x04
567 * Open or create a file.
572 * A combination of eal_open_flags controlling operation and FD behavior.
574 * Open file descriptor on success, (-1) on failure and rte_errno is set.
577 eal_file_open(const char *path, int flags);
579 /** File locking operation. */
581 EAL_FLOCK_SHARED, /**< Acquire a shared lock. */
582 EAL_FLOCK_EXCLUSIVE, /**< Acquire an exclusive lock. */
583 EAL_FLOCK_UNLOCK /**< Release a previously taken lock. */
586 /** Behavior on file locking conflict. */
587 enum eal_flock_mode {
588 EAL_FLOCK_WAIT, /**< Wait until the file gets unlocked to lock it. */
589 EAL_FLOCK_RETURN /**< Return immediately if the file is locked. */
593 * Lock or unlock the file.
595 * On failure @code rte_errno @endcode is set to the error code
596 * specified by POSIX flock(3) description.
599 * Opened file descriptor.
601 * Operation to perform.
603 * Behavior on conflict.
605 * 0 on success, (-1) on failure.
608 eal_file_lock(int fd, enum eal_flock_op op, enum eal_flock_mode mode);
611 * Truncate or extend the file to the specified size.
613 * On failure @code rte_errno @endcode is set to the error code
614 * specified by POSIX ftruncate(3) description.
617 * Opened file descriptor.
621 * 0 on success, (-1) on failure.
624 eal_file_truncate(int fd, ssize_t size);
627 * Reserve a region of virtual memory.
629 * Use eal_mem_free() to free reserved memory.
631 * @param requested_addr
632 * A desired reservation address which must be page-aligned.
633 * The system might not respect it.
634 * NULL means the address will be chosen by the system.
636 * Reservation size. Must be a multiple of system page size.
638 * Reservation options, a combination of eal_mem_reserve_flags.
640 * Starting address of the reserved area on success, NULL on failure.
641 * Callers must not access this memory until remapping it.
644 eal_mem_reserve(void *requested_addr, size_t size, int flags);
647 * Free memory obtained by eal_mem_reserve() and possibly allocated.
649 * If *virt* and *size* describe a part of the reserved region,
650 * only this part of the region is freed (accurately up to the system
651 * page size). If *virt* points to allocated memory, *size* must match
652 * the one specified on allocation. The behavior is undefined
653 * if the memory pointed by *virt* is obtained from another source
657 * A virtual address in a region previously reserved.
659 * Number of bytes to unreserve.
662 eal_mem_free(void *virt, size_t size);
665 * Configure memory region inclusion into dumps.
668 * Starting address of the region.
670 * Size of the region.
672 * True to include memory into dumps, false to exclude.
674 * 0 on success, (-1) on failure and rte_errno is set.
677 eal_mem_set_dump(void *virt, size_t size, bool dump);
680 * Sets the runtime directory of DPDK
683 * The new runtime directory path of DPDK
685 * The size of the new runtime directory path in bytes.
687 * 0 on success, (-1) on failure.
690 eal_set_runtime_dir(char *run_dir, size_t size);
693 * Get the internal configuration structure.
696 * A pointer to the internal configuration structure.
698 struct internal_config *
699 eal_get_internal_configuration(void);
702 * Get the current value of the rte_application_usage pointer
705 * Pointer to the current value of rte_application_usage .
708 eal_get_application_usage_hook(void);
711 * Instruct primary process that a secondary process wants to attach.
713 bool __rte_mp_enable(void);
716 * Init per-lcore info in current thread.
719 * identifier of lcore.
721 * CPU affinity for this thread.
723 void __rte_thread_init(unsigned int lcore_id, rte_cpuset_t *cpuset);
726 * Uninitialize per-lcore info for current thread.
728 void __rte_thread_uninit(void);
731 * asprintf(3) replacement for Windows.
733 #ifdef RTE_EXEC_ENV_WINDOWS
734 __rte_format_printf(2, 3)
735 int eal_asprintf(char **buffer, const char *format, ...);
737 #define asprintf(buffer, format, ...) \
738 eal_asprintf(buffer, format, ##__VA_ARGS__)
741 #endif /* _EAL_PRIVATE_H_ */