FD.io VPP  v19.08.3-2-gbabecb413
Vector Packet Processing
pmalloc.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2018 Cisco and/or its affiliates.
3  * Licensed under the Apache License, Version 2.0 (the "License");
4  * you may not use this file except in compliance with the License.
5  * You may obtain a copy of the License at:
6  *
7  * http://www.apache.org/licenses/LICENSE-2.0
8  *
9  * Unless required by applicable law or agreed to in writing, software
10  * distributed under the License is distributed on an "AS IS" BASIS,
11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12  * See the License for the specific language governing permissions and
13  * limitations under the License.
14  */
15 
16 #ifndef included_palloc_h
17 #define included_palloc_h
18 #include <vppinfra/format.h>
19 #include <vppinfra/pool.h>
20 
21 #define PMALLOC_LOG2_BLOCK_SZ CLIB_LOG2_CACHE_LINE_BYTES
22 #define PMALLOC_BLOCK_SZ (1 << 6)
23 
24 #define CLIB_PMALLOC_NUMA_LOCAL 0xffffffff
25 
26 typedef struct
27 {
28  u32 start, prev, next;
29  u32 size:31;
30  u32 used:1;
32 
34 
35 typedef struct
36 {
44 
45 typedef struct
46 {
49 #define CLIB_PMALLOC_ARENA_F_SHARED_MEM (1 << 0)
50  int fd;
56  u8 *name;
59 
60 typedef struct
61 {
62  /* flags */
64 #define CLIB_PMALLOC_F_NO_PAGEMAP (1 << 0)
65 
66  /* base VA address */
67  u8 *base;
68 
69  /* default page size - typically 2M */
71 
72  /* system page size - typically 4K */
74 
75  /* maximum number of pages, limited by VA preallocation size */
77 
78  /* vector of pages - each page have own alloc pool and it can be split
79  into subpages (i.e. 2M page build out of 512 4K pages) */
81 
82  /* hash used to find chunk index out of VA, chunk index is defined
83  per page */
85 
86  /* alloc arenas are group of pages which share same attributes
87  shared arenas are represented by FD and they are not grovable
88  private arenas are growable */
90 
91  /* vector of per numa node alloc arena indices
92  each numa node have own default privat alloc arena */
94 
95  /* VA to PA lookup table */
97 
98  /* lookup page size - equals to smalles subpage used */
100 
101  /* last error */
104 
105 
106 int clib_pmalloc_init (clib_pmalloc_main_t * pm, uword base_addr, uword size);
108  uword size, uword align,
109  u32 numa_node);
111  uword align);
112 void clib_pmalloc_free (clib_pmalloc_main_t * pm, void *va);
113 
115  uword size, u32 log2_page_sz,
116  u32 numa_node);
117 
118 void *clib_pmalloc_alloc_from_arena (clib_pmalloc_main_t * pm, void *arena_va,
119  uword size, uword align);
120 
123 
126 {
127  return pm->error;
128 }
129 
132 {
133  uword index = (pointer_to_uword (va) - pointer_to_uword (pm->base)) >>
134  pm->def_log2_page_sz;
135 
136  ASSERT (index < vec_len (pm->pages));
137 
138  return index;
139 }
140 
143 {
144  u32 index = clib_pmalloc_get_page_index (pm, va);
145  return pm->arenas + pm->pages[index].arena_index;
146 }
147 
150 {
151  uword index = (pointer_to_uword (va) - pointer_to_uword (pm->base)) >>
153  return pointer_to_uword (va) - pm->lookup_table[index];
154 }
155 
156 
157 #endif /* included_palloc_h */
158 
159 /*
160  * fd.io coding-style-patch-verification: ON
161  *
162  * Local Variables:
163  * eval: (c-set-style "gnu")
164  * End:
165  */
u32 lookup_log2_page_sz
Definition: pmalloc.h:99
Fixed length block allocator.
format_function_t format_pmalloc_map
Definition: pmalloc.h:122
static u32 clib_pmalloc_get_page_index(clib_pmalloc_main_t *pm, void *va)
Definition: pmalloc.h:131
unsigned char u8
Definition: types.h:56
clib_pmalloc_chunk_t * chunks
Definition: pmalloc.h:39
clib_pmalloc_arena_t * arenas
Definition: pmalloc.h:89
u8 *() format_function_t(u8 *s, va_list *args)
Definition: format.h:48
format_function_t format_pmalloc
Definition: pmalloc.h:121
#define always_inline
Definition: clib.h:99
unsigned int u32
Definition: types.h:88
STATIC_ASSERT_SIZEOF(clib_pmalloc_chunk_t, 16)
uword size
void clib_pmalloc_free(clib_pmalloc_main_t *pm, void *va)
Definition: pmalloc.c:552
int clib_pmalloc_init(clib_pmalloc_main_t *pm, uword base_addr, uword size)
Definition: pmalloc.c:64
u32 * default_arena_for_numa_node
Definition: pmalloc.h:93
u8 name[64]
Definition: memclnt.api:152
static clib_error_t * clib_pmalloc_last_error(clib_pmalloc_main_t *pm)
Definition: pmalloc.h:125
uword * lookup_table
Definition: pmalloc.h:96
clib_pmalloc_page_t * pages
Definition: pmalloc.h:80
clib_error_t * error
Definition: pmalloc.h:102
void * clib_pmalloc_create_shared_arena(clib_pmalloc_main_t *pm, char *name, uword size, u32 log2_page_sz, u32 numa_node)
Definition: pmalloc.c:406
#define ASSERT(truth)
uword * chunk_index_by_va
Definition: pmalloc.h:84
static uword pointer_to_uword(const void *p)
Definition: types.h:131
void * clib_pmalloc_alloc_aligned_on_numa(clib_pmalloc_main_t *pm, uword size, uword align, u32 numa_node)
Definition: pmalloc.c:508
static clib_pmalloc_arena_t * clib_pmalloc_get_arena(clib_pmalloc_main_t *pm, void *va)
Definition: pmalloc.h:142
#define vec_len(v)
Number of elements in vector (rvalue-only, NULL tolerant)
u64 uword
Definition: types.h:112
void * clib_pmalloc_alloc_aligned(clib_pmalloc_main_t *pm, uword size, uword align)
Definition: pmalloc.c:515
void * clib_pmalloc_alloc_from_arena(clib_pmalloc_main_t *pm, void *arena_va, uword size, uword align)
Definition: pmalloc.c:522
static uword clib_pmalloc_get_pa(clib_pmalloc_main_t *pm, void *va)
Definition: pmalloc.h:149