DPDK 22.11.0-rc2
rte_memory.h
Go to the documentation of this file.
1/* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2010-2014 Intel Corporation
3 */
4
5#ifndef _RTE_MEMORY_H_
6#define _RTE_MEMORY_H_
7
14#include <stdint.h>
15#include <stddef.h>
16#include <stdio.h>
17
18#ifdef __cplusplus
19extern "C" {
20#endif
21
22#include <rte_bitops.h>
23#include <rte_common.h>
24#include <rte_compat.h>
25#include <rte_config.h>
26#include <rte_fbarray.h>
27
28#define RTE_PGSIZE_4K (1ULL << 12)
29#define RTE_PGSIZE_64K (1ULL << 16)
30#define RTE_PGSIZE_256K (1ULL << 18)
31#define RTE_PGSIZE_2M (1ULL << 21)
32#define RTE_PGSIZE_16M (1ULL << 24)
33#define RTE_PGSIZE_256M (1ULL << 28)
34#define RTE_PGSIZE_512M (1ULL << 29)
35#define RTE_PGSIZE_1G (1ULL << 30)
36#define RTE_PGSIZE_4G (1ULL << 32)
37#define RTE_PGSIZE_16G (1ULL << 34)
38
39#define SOCKET_ID_ANY -1
42#define RTE_MEMSEG_FLAG_DO_NOT_FREE RTE_BIT32(0)
44#define RTE_MEMSEG_FLAG_DIRTY RTE_BIT32(1)
45
49struct rte_memseg {
52 union {
53 void *addr;
54 uint64_t addr_64;
55 };
56 size_t len;
57 uint64_t hugepage_sz;
58 int32_t socket_id;
59 uint32_t nchannel;
60 uint32_t nrank;
61 uint32_t flags;
63
70 union {
71 void *base_va;
73 uint64_t addr_64;
75 };
76 uint64_t page_sz;
78 volatile uint32_t version;
79 size_t len;
80 unsigned int external;
81 unsigned int heap;
82 struct rte_fbarray memseg_arr;
83};
84
93int rte_mem_lock_page(const void *virt);
94
106
121
134void *
136
148struct rte_memseg *
149rte_mem_virt2memseg(const void *virt, const struct rte_memseg_list *msl);
150
159struct rte_memseg_list *
160rte_mem_virt2memseg_list(const void *virt);
161
169typedef int (*rte_memseg_walk_t)(const struct rte_memseg_list *msl,
170 const struct rte_memseg *ms, void *arg);
171
181typedef int (*rte_memseg_contig_walk_t)(const struct rte_memseg_list *msl,
182 const struct rte_memseg *ms, size_t len, void *arg);
183
192typedef int (*rte_memseg_list_walk_t)(const struct rte_memseg_list *msl,
193 void *arg);
194
213int
215
234int
236
255int
257
273int
275
291int
293
309int
311
333int
335
357int
359
381int
382rte_memseg_get_fd_offset(const struct rte_memseg *ms, size_t *offset);
383
405int
407 size_t *offset);
408
443int
444rte_extmem_register(void *va_addr, size_t len, rte_iova_t iova_addrs[],
445 unsigned int n_pages, size_t page_sz);
446
470int
471rte_extmem_unregister(void *va_addr, size_t len);
472
493int
494rte_extmem_attach(void *va_addr, size_t len);
495
516int
517rte_extmem_detach(void *va_addr, size_t len);
518
529
540
549
557unsigned rte_memory_get_nrank(void);
558
566int rte_mem_check_dma_mask(uint8_t maskbits);
567
582
588void rte_mem_set_dma_mask(uint8_t maskbits);
589
600
601
609};
610#define RTE_MEM_EVENT_CALLBACK_NAME_LEN 64
616typedef void (*rte_mem_event_callback_t)(enum rte_mem_event event_type,
617 const void *addr, size_t len, void *arg);
618
644int
646 void *arg);
647
662int
663rte_mem_event_callback_unregister(const char *name, void *arg);
664
665
666#define RTE_MEM_ALLOC_VALIDATOR_NAME_LEN 64
675 size_t cur_limit, size_t new_len);
676
711int
713 rte_mem_alloc_validator_t clb, int socket_id, size_t limit);
714
729int
731
732#ifdef __cplusplus
733}
734#endif
735
736#endif /* _RTE_MEMORY_H_ */
uint64_t rte_iova_t
Definition: rte_common.h:458
#define __rte_packed
Definition: rte_common.h:83
uint64_t phys_addr_t
Definition: rte_common.h:448
#define RTE_STD_C11
Definition: rte_common.h:39
unsigned rte_memory_get_nchannel(void)
phys_addr_t rte_mem_virt2phy(const void *virt)
int rte_extmem_register(void *va_addr, size_t len, rte_iova_t iova_addrs[], unsigned int n_pages, size_t page_sz)
struct rte_memseg_list * rte_mem_virt2memseg_list(const void *virt)
int rte_memseg_get_fd_offset_thread_unsafe(const struct rte_memseg *ms, size_t *offset)
int(* rte_memseg_contig_walk_t)(const struct rte_memseg_list *msl, const struct rte_memseg *ms, size_t len, void *arg)
Definition: rte_memory.h:181
void rte_mem_set_dma_mask(uint8_t maskbits)
int rte_memseg_list_walk_thread_unsafe(rte_memseg_list_walk_t func, void *arg)
int rte_memseg_get_fd(const struct rte_memseg *ms)
int rte_memseg_contig_walk_thread_unsafe(rte_memseg_contig_walk_t func, void *arg)
rte_mem_event
Definition: rte_memory.h:606
@ RTE_MEM_EVENT_ALLOC
Definition: rte_memory.h:607
@ RTE_MEM_EVENT_FREE
Definition: rte_memory.h:608
int rte_memseg_contig_walk(rte_memseg_contig_walk_t func, void *arg)
int(* rte_memseg_list_walk_t)(const struct rte_memseg_list *msl, void *arg)
Definition: rte_memory.h:192
int rte_extmem_attach(void *va_addr, size_t len)
void * rte_mem_iova2virt(rte_iova_t iova)
int rte_memseg_list_walk(rte_memseg_list_walk_t func, void *arg)
void rte_dump_physmem_layout(FILE *f)
int rte_mem_alloc_validator_unregister(const char *name, int socket_id)
Unregister validator callback for memory allocations.
int rte_memseg_get_fd_offset(const struct rte_memseg *ms, size_t *offset)
int rte_mem_event_callback_register(const char *name, rte_mem_event_callback_t clb, void *arg)
struct rte_memseg * rte_mem_virt2memseg(const void *virt, const struct rte_memseg_list *msl)
int rte_mem_lock_page(const void *virt)
int 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.
rte_iova_t rte_mem_virt2iova(const void *virt)
int rte_eal_using_phys_addrs(void)
int rte_mem_check_dma_mask(uint8_t maskbits)
uint64_t rte_eal_get_physmem_size(void)
int(* rte_memseg_walk_t)(const struct rte_memseg_list *msl, const struct rte_memseg *ms, void *arg)
Definition: rte_memory.h:169
void(* rte_mem_event_callback_t)(enum rte_mem_event event_type, const void *addr, size_t len, void *arg)
Definition: rte_memory.h:616
int(* rte_mem_alloc_validator_t)(int socket_id, size_t cur_limit, size_t new_len)
Definition: rte_memory.h:674
int rte_memseg_walk(rte_memseg_walk_t func, void *arg)
int rte_extmem_detach(void *va_addr, size_t len)
int rte_memseg_walk_thread_unsafe(rte_memseg_walk_t func, void *arg)
unsigned rte_memory_get_nrank(void)
int rte_mem_check_dma_mask_thread_unsafe(uint8_t maskbits)
int rte_memseg_get_fd_thread_unsafe(const struct rte_memseg *ms)
int rte_extmem_unregister(void *va_addr, size_t len)
int rte_mem_event_callback_unregister(const char *name, void *arg)
void * base_va
Definition: rte_memory.h:71
volatile uint32_t version
Definition: rte_memory.h:78
uint64_t addr_64
Definition: rte_memory.h:73
unsigned int heap
Definition: rte_memory.h:81
unsigned int external
Definition: rte_memory.h:80
uint64_t page_sz
Definition: rte_memory.h:76
uint32_t nchannel
Definition: rte_memory.h:59
uint32_t nrank
Definition: rte_memory.h:60
uint64_t addr_64
Definition: rte_memory.h:54
size_t len
Definition: rte_memory.h:56
uint32_t flags
Definition: rte_memory.h:61
uint64_t hugepage_sz
Definition: rte_memory.h:57
int32_t socket_id
Definition: rte_memory.h:58
rte_iova_t iova
Definition: rte_memory.h:50
void * addr
Definition: rte_memory.h:53