DPDK
19.05.0
|
#include <stdint.h>
#include <stddef.h>
#include <stdio.h>
#include <rte_common.h>
#include <rte_compat.h>
#include <rte_config.h>
Go to the source code of this file.
Macros | |
#define | SOCKET_ID_ANY -1 |
#define | RTE_CACHE_LINE_MASK (RTE_CACHE_LINE_SIZE-1) |
#define | RTE_CACHE_LINE_ROUNDUP(size) (RTE_CACHE_LINE_SIZE * ((size + RTE_CACHE_LINE_SIZE - 1) / RTE_CACHE_LINE_SIZE)) |
#define | RTE_CACHE_LINE_MIN_SIZE 64 |
#define | __rte_cache_aligned __rte_aligned(RTE_CACHE_LINE_SIZE) |
#define | __rte_cache_min_aligned __rte_aligned(RTE_CACHE_LINE_MIN_SIZE) |
#define | RTE_MEMSEG_FLAG_DO_NOT_FREE (1 << 0) |
#define | RTE_MEM_EVENT_CALLBACK_NAME_LEN 64 |
#define | RTE_MEM_ALLOC_VALIDATOR_NAME_LEN 64 |
Typedefs | |
typedef uint64_t | phys_addr_t |
typedef uint64_t | rte_iova_t |
typedef int(* | rte_memseg_walk_t )(const struct rte_memseg_list *msl, const struct rte_memseg *ms, void *arg) |
typedef int(* | rte_memseg_contig_walk_t )(const struct rte_memseg_list *msl, const struct rte_memseg *ms, size_t len, void *arg) |
typedef int(* | rte_memseg_list_walk_t )(const struct rte_memseg_list *msl, void *arg) |
typedef void(* | rte_mem_event_callback_t )(enum rte_mem_event event_type, const void *addr, size_t len, void *arg) |
typedef int(* | rte_mem_alloc_validator_t )(int socket_id, size_t cur_limit, size_t new_len) |
Enumerations | |
enum | rte_mem_event { RTE_MEM_EVENT_ALLOC = 0, RTE_MEM_EVENT_FREE } |
Functions | |
int | rte_mem_lock_page (const void *virt) |
phys_addr_t | rte_mem_virt2phy (const void *virt) |
rte_iova_t | rte_mem_virt2iova (const void *virt) |
__rte_experimental void * | rte_mem_iova2virt (rte_iova_t iova) |
__rte_experimental struct rte_memseg * | rte_mem_virt2memseg (const void *virt, const struct rte_memseg_list *msl) |
__rte_experimental struct rte_memseg_list * | rte_mem_virt2memseg_list (const void *virt) |
int __rte_experimental | rte_memseg_walk (rte_memseg_walk_t func, void *arg) |
int __rte_experimental | rte_memseg_contig_walk (rte_memseg_contig_walk_t func, void *arg) |
int __rte_experimental | rte_memseg_list_walk (rte_memseg_list_walk_t func, void *arg) |
int __rte_experimental | rte_memseg_walk_thread_unsafe (rte_memseg_walk_t func, void *arg) |
int __rte_experimental | rte_memseg_contig_walk_thread_unsafe (rte_memseg_contig_walk_t func, void *arg) |
int __rte_experimental | rte_memseg_list_walk_thread_unsafe (rte_memseg_list_walk_t func, void *arg) |
int __rte_experimental | rte_memseg_get_fd (const struct rte_memseg *ms) |
int __rte_experimental | rte_memseg_get_fd_thread_unsafe (const struct rte_memseg *ms) |
int __rte_experimental | rte_memseg_get_fd_offset (const struct rte_memseg *ms, size_t *offset) |
int __rte_experimental | rte_memseg_get_fd_offset_thread_unsafe (const struct rte_memseg *ms, size_t *offset) |
int __rte_experimental | rte_extmem_register (void *va_addr, size_t len, rte_iova_t iova_addrs[], unsigned int n_pages, size_t page_sz) |
int __rte_experimental | rte_extmem_unregister (void *va_addr, size_t len) |
int __rte_experimental | rte_extmem_attach (void *va_addr, size_t len) |
int __rte_experimental | rte_extmem_detach (void *va_addr, size_t len) |
void | rte_dump_physmem_layout (FILE *f) |
uint64_t | rte_eal_get_physmem_size (void) |
unsigned | rte_memory_get_nchannel (void) |
unsigned | rte_memory_get_nrank (void) |
int __rte_experimental | rte_mem_check_dma_mask (uint8_t maskbits) |
int __rte_experimental | rte_mem_check_dma_mask_thread_unsafe (uint8_t maskbits) |
void __rte_experimental | rte_mem_set_dma_mask (uint8_t maskbits) |
int | rte_eal_using_phys_addrs (void) |
int __rte_experimental | rte_mem_event_callback_register (const char *name, rte_mem_event_callback_t clb, void *arg) |
int __rte_experimental | rte_mem_event_callback_unregister (const char *name, void *arg) |
int __rte_experimental | rte_mem_alloc_validator_register (const char *name, rte_mem_alloc_validator_t clb, int socket_id, size_t limit) |
Register validator callback for memory allocations. | |
int __rte_experimental | rte_mem_alloc_validator_unregister (const char *name, int socket_id) |
Unregister validator callback for memory allocations. |
Memory-related RTE API.
Definition in file rte_memory.h.
#define SOCKET_ID_ANY -1 |
Any NUMA socket.
Definition at line 43 of file rte_memory.h.
#define RTE_CACHE_LINE_MASK (RTE_CACHE_LINE_SIZE-1) |
Cache line mask.
Definition at line 44 of file rte_memory.h.
#define RTE_CACHE_LINE_ROUNDUP | ( | size | ) | (RTE_CACHE_LINE_SIZE * ((size + RTE_CACHE_LINE_SIZE - 1) / RTE_CACHE_LINE_SIZE)) |
Return the first cache-aligned value greater or equal to size. Cache line size in terms of log2
Definition at line 46 of file rte_memory.h.
#define RTE_CACHE_LINE_MIN_SIZE 64 |
Minimum Cache line size.
Definition at line 61 of file rte_memory.h.
struct rte_rcu_qsbr __rte_cache_aligned __rte_aligned(RTE_CACHE_LINE_SIZE) |
Force alignment to cache line.
Definition at line 66 of file rte_memory.h.
struct rte_eth_txq_info __rte_cache_min_aligned __rte_aligned(RTE_CACHE_LINE_MIN_SIZE) |
Force minimum cache line alignment.
Definition at line 71 of file rte_memory.h.
#define RTE_MEMSEG_FLAG_DO_NOT_FREE (1 << 0) |
Physical memory segment descriptor.Prevent this segment from being freed back to the OS.
Definition at line 88 of file rte_memory.h.
#define RTE_MEM_EVENT_CALLBACK_NAME_LEN 64 |
maximum length of callback name
Definition at line 650 of file rte_memory.h.
#define RTE_MEM_ALLOC_VALIDATOR_NAME_LEN 64 |
maximum length of alloc validator name
Definition at line 706 of file rte_memory.h.
typedef uint64_t phys_addr_t |
Physical address.
Definition at line 73 of file rte_memory.h.
typedef uint64_t rte_iova_t |
IO virtual address type. When the physical addressing mode (IOVA as PA) is in use, the translation from an IO virtual address (IOVA) to a physical address is a direct mapping, i.e. the same value. Otherwise, in virtual mode (IOVA as VA), an IOMMU may do the translation.
Definition at line 82 of file rte_memory.h.
typedef int(* rte_memseg_walk_t)(const struct rte_memseg_list *msl, const struct rte_memseg *ms, void *arg) |
Memseg walk function prototype.
Returning 0 will continue walk Returning 1 will stop the walk Returning -1 will stop the walk and report error
Definition at line 188 of file rte_memory.h.
typedef int(* rte_memseg_contig_walk_t)(const struct rte_memseg_list *msl, const struct rte_memseg *ms, size_t len, void *arg) |
Memseg contig walk function prototype. This will trigger a callback on every VA-contiguous are starting at memseg ms
, so total valid VA space at each callback call will be [ms->addr
, ms->addr + len
).
Returning 0 will continue walk Returning 1 will stop the walk Returning -1 will stop the walk and report error
Definition at line 200 of file rte_memory.h.
typedef int(* rte_memseg_list_walk_t)(const struct rte_memseg_list *msl, void *arg) |
Memseg list walk function prototype. This will trigger a callback on every allocated memseg list.
Returning 0 will continue walk Returning 1 will stop the walk Returning -1 will stop the walk and report error
Definition at line 211 of file rte_memory.h.
typedef void(* rte_mem_event_callback_t)(enum rte_mem_event event_type, const void *addr, size_t len, void *arg) |
Function typedef used to register callbacks for memory events.
Definition at line 656 of file rte_memory.h.
typedef int(* rte_mem_alloc_validator_t)(int socket_id, size_t cur_limit, size_t new_len) |
Function typedef used to register memory allocation validation callbacks.
Returning 0 will allow allocation attempt to continue. Returning -1 will prevent allocation from succeeding.
Definition at line 714 of file rte_memory.h.
enum rte_mem_event |
Enum indicating which kind of memory event has happened. Used by callbacks to distinguish between memory allocations and deallocations.
Definition at line 646 of file rte_memory.h.
int rte_mem_lock_page | ( | const void * | virt | ) |
Lock page in physical memory and prevent from swapping.
virt | The virtual address. |
phys_addr_t rte_mem_virt2phy | ( | const void * | virt | ) |
Get physical address of any mapped virtual address in the current process. It is found by browsing the /proc/self/pagemap special file. The page must be locked.
virt | The virtual address. |
rte_iova_t rte_mem_virt2iova | ( | const void * | virt | ) |
Get IO virtual address of any mapped virtual address in the current process.
virt | The virtual address. |
__rte_experimental void* rte_mem_iova2virt | ( | rte_iova_t | iova | ) |
Get virtual memory address corresponding to iova address.
iova | The iova address. |
|
read |
Get memseg to which a particular virtual address belongs.
virt | The virtual address. |
msl | The memseg list in which to look up based on virt address (can be NULL). |
|
read |
Get memseg list corresponding to virtual memory address.
virt | The virtual address. |
int __rte_experimental rte_memseg_walk | ( | rte_memseg_walk_t | func, |
void * | arg | ||
) |
Walk list of all memsegs.
func | Iterator function |
arg | Argument passed to iterator |
int __rte_experimental rte_memseg_contig_walk | ( | rte_memseg_contig_walk_t | func, |
void * | arg | ||
) |
Walk each VA-contiguous area.
func | Iterator function |
arg | Argument passed to iterator |
int __rte_experimental rte_memseg_list_walk | ( | rte_memseg_list_walk_t | func, |
void * | arg | ||
) |
Walk each allocated memseg list.
func | Iterator function |
arg | Argument passed to iterator |
int __rte_experimental rte_memseg_walk_thread_unsafe | ( | rte_memseg_walk_t | func, |
void * | arg | ||
) |
Walk list of all memsegs without performing any locking.
func | Iterator function |
arg | Argument passed to iterator |
int __rte_experimental rte_memseg_contig_walk_thread_unsafe | ( | rte_memseg_contig_walk_t | func, |
void * | arg | ||
) |
Walk each VA-contiguous area without performing any locking.
func | Iterator function |
arg | Argument passed to iterator |
int __rte_experimental rte_memseg_list_walk_thread_unsafe | ( | rte_memseg_list_walk_t | func, |
void * | arg | ||
) |
Walk each allocated memseg list without performing any locking.
func | Iterator function |
arg | Argument passed to iterator |
int __rte_experimental rte_memseg_get_fd | ( | const struct rte_memseg * | ms | ) |
Return file descriptor associated with a particular memseg (if available).
ms | A pointer to memseg for which to get file descriptor. |
rte_errno
set to the following values:ms
pointer was NULL or did not point to a valid memsegms
fd is not availablems
is an unused segmentint __rte_experimental rte_memseg_get_fd_thread_unsafe | ( | const struct rte_memseg * | ms | ) |
Return file descriptor associated with a particular memseg (if available).
ms | A pointer to memseg for which to get file descriptor. |
rte_errno
set to the following values:ms
pointer was NULL or did not point to a valid memsegms
fd is not availablems
is an unused segmentint __rte_experimental rte_memseg_get_fd_offset | ( | const struct rte_memseg * | ms, |
size_t * | offset | ||
) |
Get offset into segment file descriptor associated with a particular memseg (if available).
ms | A pointer to memseg for which to get file descriptor. |
offset | A pointer to offset value where the result will be stored. |
rte_errno
set to the following values:ms
pointer was NULL or did not point to a valid memsegoffset
pointer was NULLms
fd is not availablems
is an unused segmentint __rte_experimental rte_memseg_get_fd_offset_thread_unsafe | ( | const struct rte_memseg * | ms, |
size_t * | offset | ||
) |
Get offset into segment file descriptor associated with a particular memseg (if available).
ms | A pointer to memseg for which to get file descriptor. |
offset | A pointer to offset value where the result will be stored. |
rte_errno
set to the following values:ms
pointer was NULL or did not point to a valid memsegoffset
pointer was NULLms
fd is not availablems
is an unused segmentint __rte_experimental rte_extmem_register | ( | void * | va_addr, |
size_t | len, | ||
rte_iova_t | iova_addrs[], | ||
unsigned int | n_pages, | ||
size_t | page_sz | ||
) |
Register external memory chunk with DPDK.
rte_malloc
family of API's.rte_extmem_attach
in each other process.va_addr | Start of virtual area to register. Must be aligned by page_sz . |
len | Length of virtual area to register. Must be aligned by page_sz . |
iova_addrs | Array of page IOVA addresses corresponding to each page in this memory area. Can be NULL, in which case page IOVA addresses will be set to RTE_BAD_IOVA. |
n_pages | Number of elements in the iova_addrs array. Ignored if iova_addrs is NULL. |
page_sz | Page size of the underlying memory |
int __rte_experimental rte_extmem_unregister | ( | void * | va_addr, |
size_t | len | ||
) |
Unregister external memory chunk with DPDK.
rte_malloc
family of API's.rte_extmem_detach
to detach from the memory area.va_addr | Start of virtual area to unregister |
len | Length of virtual area to unregister |
int __rte_experimental rte_extmem_attach | ( | void * | va_addr, |
size_t | len | ||
) |
Attach to external memory chunk registered in another process.
rte_malloc
family of API's.va_addr | Start of virtual area to register |
len | Length of virtual area to register |
int __rte_experimental rte_extmem_detach | ( | void * | va_addr, |
size_t | len | ||
) |
Detach from external memory chunk registered in another process.
rte_malloc
family of API's.va_addr | Start of virtual area to unregister |
len | Length of virtual area to unregister |
void rte_dump_physmem_layout | ( | FILE * | f | ) |
Dump the physical memory layout to a file.
f | A pointer to a file for output |
uint64_t rte_eal_get_physmem_size | ( | void | ) |
Get the total amount of available physical memory.
unsigned rte_memory_get_nchannel | ( | void | ) |
Get the number of memory channels.
unsigned rte_memory_get_nrank | ( | void | ) |
Get the number of memory ranks.
int __rte_experimental rte_mem_check_dma_mask | ( | uint8_t | maskbits | ) |
Check if all currently allocated memory segments are compliant with supplied DMA address width.
maskbits | Address width to check against. |
int __rte_experimental rte_mem_check_dma_mask_thread_unsafe | ( | uint8_t | maskbits | ) |
Check if all currently allocated memory segments are compliant with supplied DMA address width. This function will use rte_memseg_walk_thread_unsafe instead of rte_memseg_walk implying memory_hotplug_lock will not be acquired avoiding deadlock during memory initialization.
This function is just for EAL core memory internal use. Drivers should use the previous rte_mem_check_dma_mask.
maskbits | Address width to check against. |
void __rte_experimental rte_mem_set_dma_mask | ( | uint8_t | maskbits | ) |
Set dma mask to use once memory initialization is done. Previous functions rte_mem_check_dma_mask and rte_mem_check_dma_mask_thread_unsafe can not be used safely until memory has been initialized.
int rte_eal_using_phys_addrs | ( | void | ) |
Drivers based on uio will not load unless physical addresses are obtainable. It is only possible to get physical addresses when running as a privileged user.
int __rte_experimental rte_mem_event_callback_register | ( | const char * | name, |
rte_mem_event_callback_t | clb, | ||
void * | arg | ||
) |
Function used to register callbacks for memory events.
rte_memseg_walk()
) will cause a deadlock when called from within such callbacks.name | Name associated with specified callback to be added to the list. |
clb | Callback function pointer. |
arg | Argument to pass to the callback. |
int __rte_experimental rte_mem_event_callback_unregister | ( | const char * | name, |
void * | arg | ||
) |
Function used to unregister callbacks for memory events.
name | Name associated with specified callback to be removed from the list. |
arg | Argument to look for among callbacks with specified callback name. |
int __rte_experimental rte_mem_alloc_validator_register | ( | const char * | name, |
rte_mem_alloc_validator_t | clb, | ||
int | socket_id, | ||
size_t | limit | ||
) |
Register validator callback for memory allocations.
Callbacks registered by this function will be called right before memory allocator is about to trigger allocation of more pages from the system if said allocation will bring total memory usage above specified limit on specified socket. User will be able to cancel pending allocation if callback returns -1.
rte_memseg_walk()
) will cause a deadlock when called from within such callbacks.name | Name associated with specified callback to be added to the list. |
clb | Callback function pointer. |
socket_id | Socket ID on which to watch for allocations. |
limit | Limit above which to trigger callbacks. |
int __rte_experimental rte_mem_alloc_validator_unregister | ( | const char * | name, |
int | socket_id | ||
) |
Unregister validator callback for memory allocations.
name | Name associated with specified callback to be removed from the list. |
socket_id | Socket ID on which to watch for allocations. |