1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2010-2018 Intel Corporation
5 #ifndef _EAL_PRIVATE_H_
6 #define _EAL_PRIVATE_H_
13 #include <rte_lcore.h>
14 #include <rte_memory.h>
17 * Structure storing internal configuration (per-lcore)
20 pthread_t thread_id; /**< pthread identifier */
21 int pipe_master2slave[2]; /**< communication pipe with master */
22 int pipe_slave2master[2]; /**< communication pipe with master */
24 lcore_function_t * volatile f; /**< function to call */
25 void * volatile arg; /**< argument of function */
26 volatile int ret; /**< return value of function */
28 volatile enum rte_lcore_state_t state; /**< lcore state */
29 unsigned int socket_id; /**< physical socket id for this lcore */
30 unsigned int core_id; /**< core number on socket for this lcore */
31 int core_index; /**< relative index, starting from 0 */
32 uint8_t core_role; /**< role of core eg: OFF, RTE, SERVICE */
34 rte_cpuset_t cpuset; /**< cpu set which the lcore affinity to */
37 extern struct lcore_config lcore_config[RTE_MAX_LCORE];
40 * The global RTE configuration structure.
43 uint32_t master_lcore; /**< Id of the master lcore */
44 uint32_t lcore_count; /**< Number of available logical cores. */
45 uint32_t numa_node_count; /**< Number of detected NUMA nodes. */
46 uint32_t numa_nodes[RTE_MAX_NUMA_NODES]; /**< List of detected NUMA nodes. */
47 uint32_t service_lcore_count;/**< Number of available service cores. */
48 enum rte_lcore_role_t lcore_role[RTE_MAX_LCORE]; /**< State of cores. */
50 /** Primary or secondary configuration */
51 enum rte_proc_type_t process_type;
53 /** PA or VA mapping mode */
54 enum rte_iova_mode iova_mode;
57 * Pointer to memory configuration, which may be shared across multiple
60 struct rte_mem_config *mem_config;
64 * Get the global configuration structure.
67 * A pointer to the global configuration structure.
69 struct rte_config *rte_eal_get_configuration(void);
72 * Initialize the memzone subsystem (private to eal).
78 int rte_eal_memzone_init(void);
81 * Common log initialization function (private to eal). Determines
82 * where log data is written when no call to rte_openlog_stream is
86 * The default log stream to be used.
91 void eal_log_set_default(FILE *default_log);
94 * Fill configuration with number of physical and logical processors
96 * This function is private to EAL.
98 * Parse /proc/cpuinfo to get the number of physical and logical
99 * processors on the machine.
102 * 0 on success, negative on error
104 int rte_eal_cpu_init(void);
107 * Create memseg lists
109 * This function is private to EAL.
111 * Preallocate virtual memory.
114 * 0 on success, negative on error
116 int rte_eal_memseg_init(void);
121 * This function is private to EAL.
123 * Fill configuration structure with these infos, and return 0 on success.
126 * 0 on success, negative on error
128 int rte_eal_memory_init(void);
133 * This function is private to EAL.
135 * Mmap memory areas used by HPET (high precision event timer) that will
136 * provide our time reference, and configure the TSC frequency also for it
137 * to be used as a reference.
140 * 0 on success, negative on error
142 int rte_eal_timer_init(void);
145 * Init the default log stream
147 * This function is private to EAL.
150 * 0 on success, negative on error
152 int rte_eal_log_init(const char *id, int facility);
155 * Save the log regexp for later
157 int rte_log_save_regexp(const char *type, int priority);
158 int rte_log_save_pattern(const char *pattern, int priority);
161 * Init tail queues for non-EAL library structures. This is to allow
162 * the rings, mempools, etc. lists to be shared among multiple processes
164 * This function is private to EAL
167 * 0 on success, negative on error
169 int rte_eal_tailqs_init(void);
172 * Init interrupt handling.
174 * This function is private to EAL.
177 * 0 on success, negative on error
179 int rte_eal_intr_init(void);
182 * Init alarm mechanism. This is to allow a callback be called after
185 * This function is private to EAL.
188 * 0 on success, negative on error
190 int rte_eal_alarm_init(void);
193 * Function is to check if the kernel module(like, vfio, vfio_iommu_type1,
197 * The module's name which need to be checked
200 * -1 means some error happens(NULL pointer or open failure)
201 * 0 means the module not loaded
202 * 1 means the module loaded
204 int rte_eal_check_module(const char *module_name);
207 * Memory reservation flags.
209 enum eal_mem_reserve_flags {
211 * Reserve hugepages. May be unsupported by some platforms.
213 EAL_RESERVE_HUGEPAGES = 1 << 0,
215 * Force reserving memory at the requested address.
216 * This can be a destructive action depending on the implementation.
218 * @see RTE_MAP_FORCE_ADDRESS for description of possible consequences
219 * (although implementations are not required to use it).
221 EAL_RESERVE_FORCE_ADDRESS = 1 << 1
225 * Get virtual area of specified size from the OS.
227 * This function is private to the EAL.
229 * @param requested_addr
230 * Address where to request address space.
232 * Size of requested area.
234 * Page size on which to align requested virtual area.
236 * EAL_VIRTUAL_AREA_* flags.
237 * @param reserve_flags
238 * Extra flags passed directly to eal_mem_reserve().
241 * Virtual area address if successful.
242 * NULL if unsuccessful.
245 #define EAL_VIRTUAL_AREA_ADDR_IS_HINT (1 << 0)
246 /**< don't fail if cannot get exact requested address. */
247 #define EAL_VIRTUAL_AREA_ALLOW_SHRINK (1 << 1)
248 /**< try getting smaller sized (decrement by page size) virtual areas if cannot
249 * get area of requested size.
251 #define EAL_VIRTUAL_AREA_UNMAP (1 << 2)
252 /**< immediately unmap reserved virtual area. */
254 eal_get_virtual_area(void *requested_addr, size_t *size,
255 size_t page_sz, int flags, int reserve_flags);
258 * Initialize a memory segment list and create its backing storage.
261 * Memory segment list to be filled.
263 * Name for the backing storage.
265 * Size of segment pages in the MSL.
267 * Number of segments.
269 * Socket ID. Must not be SOCKET_ID_ANY.
271 * Mark MSL as pointing to a heap.
273 * 0 on success, (-1) on failure and rte_errno is set.
276 eal_memseg_list_init_named(struct rte_memseg_list *msl, const char *name,
277 uint64_t page_sz, int n_segs, int socket_id, bool heap);
280 * Initialize memory segment list and create its backing storage
281 * with a name corresponding to MSL parameters.
283 * @param type_msl_idx
284 * Index of the MSL among other MSLs of the same socket and page size.
286 * @see eal_memseg_list_init_named for remaining parameters description.
289 eal_memseg_list_init(struct rte_memseg_list *msl, uint64_t page_sz,
290 int n_segs, int socket_id, int type_msl_idx, bool heap);
293 * Reserve VA space for a memory segment list
294 * previously initialized with eal_memseg_list_init().
297 * Initialized memory segment list with page size defined.
298 * @param reserve_flags
299 * Extra memory reservation flags. Can be 0 if unnecessary.
301 * 0 on success, (-1) on failure and rte_errno is set.
304 eal_memseg_list_alloc(struct rte_memseg_list *msl, int reserve_flags);
307 * Populate MSL, each segment is one page long.
310 * Initialized memory segment list with page size defined.
312 * Starting address of list segments.
314 * Number of segments to populate.
317 eal_memseg_list_populate(struct rte_memseg_list *msl, void *addr, int n_segs);
322 * This function is private to the EAL.
324 unsigned eal_cpu_core_id(unsigned lcore_id);
327 * Check if cpu is present.
329 * This function is private to the EAL.
331 int eal_cpu_detected(unsigned lcore_id);
334 * Set TSC frequency from precise value or estimation
336 * This function is private to the EAL.
338 void set_tsc_freq(void);
341 * Get precise TSC frequency from system
343 * This function is private to the EAL.
345 uint64_t get_tsc_freq(void);
348 * Get TSC frequency if the architecture supports.
350 * This function is private to the EAL.
353 * The number of TSC cycles in one second.
354 * Returns zero if the architecture support is not available.
356 uint64_t get_tsc_freq_arch(void);
359 * Prepare physical memory mapping
360 * i.e. hugepages on Linux and
363 * This function is private to the EAL.
365 int rte_eal_hugepage_init(void);
368 * Creates memory mapping in secondary process
369 * i.e. hugepages on Linux and
372 * This function is private to the EAL.
374 int rte_eal_hugepage_attach(void);
377 * Find a bus capable of identifying a device.
380 * A device identifier (PCI address, virtual PMD name, ...).
383 * A valid bus handle if found.
384 * NULL if no bus is able to parse this device.
386 struct rte_bus *rte_bus_find_by_device_name(const char *str);
389 * Create the unix channel for primary/secondary communication.
395 int rte_mp_channel_init(void);
398 * Primary/secondary communication cleanup.
400 void rte_mp_channel_cleanup(void);
404 * Parse a device string and store its information in an
405 * rte_devargs structure.
407 * A device description is split by layers of abstraction of the device:
408 * bus, class and driver. Each layer will offer a set of properties that
409 * can be applied either to configure or recognize a device.
411 * This function will parse those properties and prepare the rte_devargs
412 * to be given to each layers for processing.
414 * Note: if the "data" field of the devargs points to devstr,
415 * then no dynamic allocation is performed and the rte_devargs
416 * can be safely discarded.
418 * Otherwise ``data`` will hold a workable copy of devstr, that will be
419 * used by layers descriptors within rte_devargs. In this case,
420 * any rte_devargs should be cleaned-up before being freed.
423 * rte_devargs structure to fill.
430 * Negative errno values on error (rte_errno is set).
433 rte_devargs_layers_parse(struct rte_devargs *devargs,
437 * probe a device at local process.
440 * Device arguments including bus, class and driver properties.
442 * new device be probed as output.
444 * 0 on success, negative on error.
446 int local_dev_probe(const char *devargs, struct rte_device **new_dev);
449 * Hotplug remove a given device from a specific bus at local process.
452 * Data structure of the device to remove.
454 * 0 on success, negative on error.
456 int local_dev_remove(struct rte_device *dev);
459 * Iterate over all buses to find the corresponding bus to handle the sigbus
461 * @param failure_addr
462 * Pointer of the fault address of the sigbus error.
465 * 0 success to handle the sigbus.
466 * -1 failed to handle the sigbus
467 * 1 no bus can handler the sigbus
469 int rte_bus_sigbus_handler(const void *failure_addr);
473 * Register the sigbus handler.
476 * - On success, zero.
477 * - On failure, a negative value.
480 dev_sigbus_handler_register(void);
484 * Unregister the sigbus handler.
487 * - On success, zero.
488 * - On failure, a negative value.
491 dev_sigbus_handler_unregister(void);
494 * Get OS-specific EAL mapping base address.
497 eal_get_baseaddr(void);
500 eal_malloc_no_trace(const char *type, size_t size, unsigned int align);
502 void eal_free_no_trace(void *addr);
504 /** Options for eal_file_open(). */
505 enum eal_open_flags {
506 /** Open file for reading. */
507 EAL_OPEN_READONLY = 0x00,
508 /** Open file for reading and writing. */
509 EAL_OPEN_READWRITE = 0x02,
511 * Create the file if it doesn't exist.
512 * New files are only accessible to the owner (0600 equivalent).
514 EAL_OPEN_CREATE = 0x04
518 * Open or create a file.
523 * A combination of eal_open_flags controlling operation and FD behavior.
525 * Open file descriptor on success, (-1) on failure and rte_errno is set.
528 eal_file_open(const char *path, int flags);
530 /** File locking operation. */
532 EAL_FLOCK_SHARED, /**< Acquire a shared lock. */
533 EAL_FLOCK_EXCLUSIVE, /**< Acquire an exclusive lock. */
534 EAL_FLOCK_UNLOCK /**< Release a previously taken lock. */
537 /** Behavior on file locking conflict. */
538 enum eal_flock_mode {
539 EAL_FLOCK_WAIT, /**< Wait until the file gets unlocked to lock it. */
540 EAL_FLOCK_RETURN /**< Return immediately if the file is locked. */
544 * Lock or unlock the file.
546 * On failure @code rte_errno @endcode is set to the error code
547 * specified by POSIX flock(3) description.
550 * Opened file descriptor.
552 * Operation to perform.
554 * Behavior on conflict.
556 * 0 on success, (-1) on failure.
559 eal_file_lock(int fd, enum eal_flock_op op, enum eal_flock_mode mode);
562 * Truncate or extend the file to the specified size.
564 * On failure @code rte_errno @endcode is set to the error code
565 * specified by POSIX ftruncate(3) description.
568 * Opened file descriptor.
572 * 0 on success, (-1) on failure.
575 eal_file_truncate(int fd, ssize_t size);
578 * Reserve a region of virtual memory.
580 * Use eal_mem_free() to free reserved memory.
582 * @param requested_addr
583 * A desired reservation address which must be page-aligned.
584 * The system might not respect it.
585 * NULL means the address will be chosen by the system.
587 * Reservation size. Must be a multiple of system page size.
589 * Reservation options, a combination of eal_mem_reserve_flags.
591 * Starting address of the reserved area on success, NULL on failure.
592 * Callers must not access this memory until remapping it.
595 eal_mem_reserve(void *requested_addr, size_t size, int flags);
598 * Free memory obtained by eal_mem_reserve() or eal_mem_alloc().
600 * If *virt* and *size* describe a part of the reserved region,
601 * only this part of the region is freed (accurately up to the system
602 * page size). If *virt* points to allocated memory, *size* must match
603 * the one specified on allocation. The behavior is undefined
604 * if the memory pointed by *virt* is obtained from another source
608 * A virtual address in a region previously reserved.
610 * Number of bytes to unreserve.
613 eal_mem_free(void *virt, size_t size);
616 * Configure memory region inclusion into dumps.
619 * Starting address of the region.
621 * Size of the region.
623 * True to include memory into dumps, false to exclude.
625 * 0 on success, (-1) on failure and rte_errno is set.
628 eal_mem_set_dump(void *virt, size_t size, bool dump);
630 #endif /* _EAL_PRIVATE_H_ */