2 * Copyright (c) 2015 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:
7 * http://www.apache.org/licenses/LICENSE-2.0
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.
16 Copyright (c) 2001, 2002, 2003 Eliot Dresselhaus
18 Permission is hereby granted, free of charge, to any person obtaining
19 a copy of this software and associated documentation files (the
20 "Software"), to deal in the Software without restriction, including
21 without limitation the rights to use, copy, modify, merge, publish,
22 distribute, sublicense, and/or sell copies of the Software, and to
23 permit persons to whom the Software is furnished to do so, subject to
24 the following conditions:
26 The above copyright notice and this permission notice shall be
27 included in all copies or substantial portions of the Software.
29 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
30 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
31 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
32 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
33 LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
34 OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
35 WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
38 #ifndef _included_clib_mem_h
39 #define _included_clib_mem_h
45 #include <vppinfra/clib.h> /* uword, etc */
46 #include <vppinfra/clib_error.h>
48 #include <vppinfra/dlmalloc.h>
50 #include <vppinfra/os.h>
51 #include <vppinfra/string.h> /* memcpy, clib_memset */
52 #include <vppinfra/sanitizer.h>
54 #define CLIB_MAX_MHEAPS 256
55 #define CLIB_MAX_NUMAS 8
57 /* Unspecified NUMA socket */
58 #define VEC_NUMA_UNSPECIFIED (0xFF)
61 extern void *clib_per_cpu_mheaps[CLIB_MAX_MHEAPS];
62 extern void *clib_per_numa_mheaps[CLIB_MAX_NUMAS];
65 clib_mem_get_per_cpu_heap (void)
67 int cpu = os_get_thread_index ();
68 return clib_per_cpu_mheaps[cpu];
72 clib_mem_set_per_cpu_heap (u8 * new_heap)
74 int cpu = os_get_thread_index ();
75 void *old = clib_per_cpu_mheaps[cpu];
76 clib_per_cpu_mheaps[cpu] = new_heap;
81 clib_mem_get_per_numa_heap (u32 numa_id)
83 ASSERT (numa_id < ARRAY_LEN (clib_per_numa_mheaps));
84 return clib_per_numa_mheaps[numa_id];
88 clib_mem_set_per_numa_heap (u8 * new_heap)
90 int numa = os_get_numa_index ();
91 void *old = clib_per_numa_mheaps[numa];
92 clib_per_numa_mheaps[numa] = new_heap;
97 clib_mem_set_thread_index (void)
100 * Find an unused slot in the per-cpu-mheaps array,
101 * and grab it for this thread. We need to be able to
102 * push/pop the thread heap without affecting other thread(s).
105 if (__os_thread_index != 0)
107 for (i = 0; i < ARRAY_LEN (clib_per_cpu_mheaps); i++)
108 if (clib_atomic_bool_cmp_and_swap (&clib_per_cpu_mheaps[i],
109 0, clib_per_cpu_mheaps[0]))
111 os_set_thread_index (i);
114 ASSERT (__os_thread_index > 0);
118 clib_mem_size_nocheck (void *p)
120 return mspace_usable_size_with_delta (p);
123 /* Memory allocator which may call os_out_of_memory() if it fails */
125 clib_mem_alloc_aligned_at_offset (uword size, uword align, uword align_offset,
126 int os_out_of_memory_on_failure)
131 if (align_offset > align)
134 align_offset %= align;
136 align_offset = align;
139 cpu = os_get_thread_index ();
140 heap = clib_per_cpu_mheaps[cpu];
142 p = mspace_get_aligned (heap, size, align, align_offset);
144 if (PREDICT_FALSE (0 == p))
146 if (os_out_of_memory_on_failure)
151 CLIB_MEM_UNPOISON (p, size);
155 /* Memory allocator which calls os_out_of_memory() when it fails */
157 clib_mem_alloc (uword size)
159 return clib_mem_alloc_aligned_at_offset (size, /* align */ 1,
160 /* align_offset */ 0,
161 /* os_out_of_memory */ 1);
165 clib_mem_alloc_aligned (uword size, uword align)
167 return clib_mem_alloc_aligned_at_offset (size, align, /* align_offset */ 0,
168 /* os_out_of_memory */ 1);
171 /* Memory allocator which calls os_out_of_memory() when it fails */
173 clib_mem_alloc_or_null (uword size)
175 return clib_mem_alloc_aligned_at_offset (size, /* align */ 1,
176 /* align_offset */ 0,
177 /* os_out_of_memory */ 0);
181 clib_mem_alloc_aligned_or_null (uword size, uword align)
183 return clib_mem_alloc_aligned_at_offset (size, align, /* align_offset */ 0,
184 /* os_out_of_memory */ 0);
189 /* Memory allocator which panics when it fails.
190 Use macro so that clib_panic macro can expand __FUNCTION__ and __LINE__. */
191 #define clib_mem_alloc_aligned_no_fail(size,align) \
193 uword _clib_mem_alloc_size = (size); \
194 void * _clib_mem_alloc_p; \
195 _clib_mem_alloc_p = clib_mem_alloc_aligned (_clib_mem_alloc_size, (align)); \
196 if (! _clib_mem_alloc_p) \
197 clib_panic ("failed to allocate %d bytes", _clib_mem_alloc_size); \
201 #define clib_mem_alloc_no_fail(size) clib_mem_alloc_aligned_no_fail(size,1)
203 /* Alias to stack allocator for naming consistency. */
204 #define clib_mem_alloc_stack(bytes) __builtin_alloca(bytes)
207 clib_mem_is_heap_object (void *p)
209 void *heap = clib_mem_get_per_cpu_heap ();
211 return mspace_is_heap_object (heap, p);
215 clib_mem_free (void *p)
217 u8 *heap = clib_mem_get_per_cpu_heap ();
219 /* Make sure object is in the correct heap. */
220 ASSERT (clib_mem_is_heap_object (p));
222 CLIB_MEM_POISON (p, clib_mem_size_nocheck (p));
224 mspace_put (heap, p);
228 clib_mem_realloc (void *p, uword new_size, uword old_size)
230 /* By default use alloc, copy and free to emulate realloc. */
231 void *q = clib_mem_alloc (new_size);
235 if (old_size < new_size)
236 copy_size = old_size;
238 copy_size = new_size;
239 clib_memcpy_fast (q, p, copy_size);
246 clib_mem_size (void *p)
248 ASSERT (clib_mem_is_heap_object (p));
249 return clib_mem_size_nocheck (p);
253 clib_mem_free_s (void *p)
255 uword size = clib_mem_size (p);
256 CLIB_MEM_UNPOISON (p, size);
257 memset_s_inline (p, size, 0, size);
262 clib_mem_get_heap (void)
264 return clib_mem_get_per_cpu_heap ();
268 clib_mem_set_heap (void *heap)
270 return clib_mem_set_per_cpu_heap (heap);
273 void *clib_mem_init (void *heap, uword size);
274 void *clib_mem_init_thread_safe (void *memory, uword memory_size);
275 void *clib_mem_init_thread_safe_numa (void *memory, uword memory_size,
278 void clib_mem_exit (void);
280 uword clib_mem_get_page_size (void);
282 void clib_mem_validate (void);
284 void clib_mem_trace (int enable);
286 int clib_mem_is_traced (void);
290 /* Total number of objects allocated. */
293 /* Total allocated bytes. Bytes used and free.
294 used + free = total */
295 uword bytes_total, bytes_used, bytes_free;
297 /* Number of bytes used by mheap data structure overhead
298 (e.g. free lists, mheap header). */
299 uword bytes_overhead;
301 /* Amount of free space returned to operating system. */
302 uword bytes_free_reclaimed;
304 /* For malloc which puts small objects in sbrk region and
305 large objects in mmap'ed regions. */
306 uword bytes_used_sbrk;
307 uword bytes_used_mmap;
309 /* Max. number of bytes in this heap. */
313 void clib_mem_usage (clib_mem_usage_t * usage);
315 u8 *format_clib_mem_usage (u8 * s, va_list * args);
317 /* Allocate virtual address space. */
319 clib_mem_vm_alloc (uword size)
322 uword flags = MAP_PRIVATE;
325 flags |= MAP_ANONYMOUS;
328 mmap_addr = mmap (0, size, PROT_READ | PROT_WRITE, flags, -1, 0);
329 if (mmap_addr == (void *) -1)
332 CLIB_MEM_UNPOISON (mmap_addr, size);
338 clib_mem_vm_free (void *addr, uword size)
341 CLIB_MEM_POISON (addr, size);
345 clib_mem_vm_unmap (void *addr, uword size)
348 uword flags = MAP_PRIVATE | MAP_FIXED;
350 /* To unmap we "map" with no protection. If we actually called
351 munmap then other callers could steal the address space. By
352 changing to PROT_NONE the kernel can free up the pages which is
353 really what we want "unmap" to mean. */
354 mmap_addr = mmap (addr, size, PROT_NONE, flags, -1, 0);
355 if (mmap_addr == (void *) -1)
358 CLIB_MEM_UNPOISON (mmap_addr, size);
364 clib_mem_vm_map (void *addr, uword size)
367 uword flags = MAP_PRIVATE | MAP_FIXED | MAP_ANONYMOUS;
369 mmap_addr = mmap (addr, size, (PROT_READ | PROT_WRITE), flags, -1, 0);
370 if (mmap_addr == (void *) -1)
373 CLIB_MEM_UNPOISON (mmap_addr, size);
380 #define CLIB_MEM_VM_F_SHARED (1 << 0)
381 #define CLIB_MEM_VM_F_HUGETLB (1 << 1)
382 #define CLIB_MEM_VM_F_NUMA_PREFER (1 << 2)
383 #define CLIB_MEM_VM_F_NUMA_FORCE (1 << 3)
384 #define CLIB_MEM_VM_F_HUGETLB_PREALLOC (1 << 4)
385 #define CLIB_MEM_VM_F_LOCKED (1 << 5)
386 u32 flags; /**< vm allocation flags:
387 <br> CLIB_MEM_VM_F_SHARED: request shared memory, file
388 descriptor will be provided on successful allocation.
389 <br> CLIB_MEM_VM_F_HUGETLB: request hugepages.
390 <br> CLIB_MEM_VM_F_NUMA_PREFER: numa_node field contains valid
391 numa node preference.
392 <br> CLIB_MEM_VM_F_NUMA_FORCE: fail if setting numa policy fails.
393 <br> CLIB_MEM_VM_F_HUGETLB_PREALLOC: pre-allocate hugepages if
394 number of available pages is not sufficient.
395 <br> CLIB_MEM_VM_F_LOCKED: request locked memory.
397 char *name; /**< Name for memory allocation, set by caller. */
398 uword size; /**< Allocation size, set by caller. */
399 int numa_node; /**< numa node preference. Valid if CLIB_MEM_VM_F_NUMA_PREFER set. */
400 void *addr; /**< Pointer to allocated memory, set on successful allocation. */
401 int fd; /**< File descriptor, set on successful allocation if CLIB_MEM_VM_F_SHARED is set. */
402 int log2_page_size; /* Page size in log2 format, set on successful allocation. */
403 int n_pages; /* Number of pages. */
404 uword requested_va; /**< Request fixed position mapping */
405 } clib_mem_vm_alloc_t;
407 clib_error_t *clib_mem_create_fd (char *name, int *fdp);
408 clib_error_t *clib_mem_create_hugetlb_fd (char *name, int *fdp);
409 clib_error_t *clib_mem_vm_ext_alloc (clib_mem_vm_alloc_t * a);
410 void clib_mem_vm_ext_free (clib_mem_vm_alloc_t * a);
411 u64 clib_mem_get_fd_page_size (int fd);
412 uword clib_mem_get_default_hugepage_size (void);
413 int clib_mem_get_fd_log2_page_size (int fd);
414 u64 *clib_mem_vm_get_paddr (void *mem, int log2_page_size, int n_pages);
418 uword size; /**< Map size */
419 int fd; /**< File descriptor to be mapped */
420 uword requested_va; /**< Request fixed position mapping */
421 void *addr; /**< Pointer to mapped memory, if successful */
425 clib_error_t *clib_mem_vm_ext_map (clib_mem_vm_map_t * a);
426 void clib_mem_vm_randomize_va (uword * requested_va, u32 log2_page_size);
427 void mheap_trace (void *v, int enable);
428 uword clib_mem_trace_enable_disable (uword enable);
429 void clib_mem_trace (int enable);
431 #include <vppinfra/error.h> /* clib_panic */
433 #endif /* _included_clib_mem_h */
436 * fd.io coding-style-patch-verification: ON
439 * eval: (c-set-style "gnu")