xref: /dpdk/lib/eal/common/malloc_heap.h (revision e5fb1a9698e7111473ca0980fdf6c0edb7acdf91)
1 /* SPDX-License-Identifier: BSD-3-Clause
2  * Copyright(c) 2010-2014 Intel Corporation
3  */
4 
5 #ifndef MALLOC_HEAP_H_
6 #define MALLOC_HEAP_H_
7 
8 #include <stdbool.h>
9 #include <sys/queue.h>
10 
11 #include <rte_malloc.h>
12 #include <rte_spinlock.h>
13 
14 /* Number of free lists per heap, grouped by size. */
15 #define RTE_HEAP_NUM_FREELISTS  13
16 #define RTE_HEAP_NAME_MAX_LEN 32
17 
18 /* dummy definition, for pointers */
19 struct malloc_elem;
20 
21 /**
22  * Structure to hold malloc heap
23  */
24 struct malloc_heap {
25 	rte_spinlock_t lock;
26 	LIST_HEAD(, malloc_elem) free_head[RTE_HEAP_NUM_FREELISTS];
27 	struct malloc_elem *volatile first;
28 	struct malloc_elem *volatile last;
29 
30 	unsigned int alloc_count;
31 	unsigned int socket_id;
32 	size_t total_size;
33 	char name[RTE_HEAP_NAME_MAX_LEN];
34 } __rte_cache_aligned;
35 
36 #ifdef __cplusplus
37 extern "C" {
38 #endif
39 
40 static inline unsigned
41 malloc_get_numa_socket(void)
42 {
43 	unsigned socket_id = rte_socket_id();
44 
45 	if (socket_id == (unsigned)SOCKET_ID_ANY)
46 		return 0;
47 
48 	return socket_id;
49 }
50 
51 void *
52 malloc_heap_alloc(const char *type, size_t size, int socket, unsigned int flags,
53 		size_t align, size_t bound, bool contig);
54 
55 void *
56 malloc_heap_alloc_biggest(const char *type, int socket, unsigned int flags,
57 		size_t align, bool contig);
58 
59 int
60 malloc_heap_create(struct malloc_heap *heap, const char *heap_name);
61 
62 int
63 malloc_heap_destroy(struct malloc_heap *heap);
64 
65 struct rte_memseg_list *
66 malloc_heap_create_external_seg(void *va_addr, rte_iova_t iova_addrs[],
67 		unsigned int n_pages, size_t page_sz, const char *seg_name,
68 		unsigned int socket_id);
69 
70 struct rte_memseg_list *
71 malloc_heap_find_external_seg(void *va_addr, size_t len);
72 
73 int
74 malloc_heap_destroy_external_seg(struct rte_memseg_list *msl);
75 
76 int
77 malloc_heap_add_external_memory(struct malloc_heap *heap,
78 		struct rte_memseg_list *msl);
79 
80 int
81 malloc_heap_remove_external_memory(struct malloc_heap *heap, void *va_addr,
82 		size_t len);
83 
84 int
85 malloc_heap_free(struct malloc_elem *elem);
86 
87 int
88 malloc_heap_resize(struct malloc_elem *elem, size_t size);
89 
90 int
91 malloc_heap_get_stats(struct malloc_heap *heap,
92 		struct rte_malloc_socket_stats *socket_stats);
93 
94 void
95 malloc_heap_dump(struct malloc_heap *heap, FILE *f);
96 
97 int
98 malloc_socket_to_heap_id(unsigned int socket_id);
99 
100 int
101 rte_eal_malloc_heap_init(void);
102 
103 #ifdef __cplusplus
104 }
105 #endif
106 
107 #endif /* MALLOC_HEAP_H_ */
108