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:
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.
18 #include <sys/types.h>
21 #include <linux/mempolicy.h>
22 #include <linux/memfd.h>
24 #include <vppinfra/format.h>
25 #include <vppinfra/linux/syscall.h>
26 #include <vppinfra/linux/sysfs.h>
27 #include <vppinfra/mem.h>
28 #include <vppinfra/hash.h>
29 #include <vppinfra/pmalloc.h>
31 #if __SIZEOF_POINTER__ >= 8
32 #define DEFAULT_RESERVED_MB 16384
34 #define DEFAULT_RESERVED_MB 256
37 static inline clib_pmalloc_chunk_t *
38 get_chunk (clib_pmalloc_page_t * pp, u32 index)
40 return pool_elt_at_index (pp->chunks, index);
44 pmalloc_validate_numa_node (u32 * numa_node)
46 if (*numa_node == CLIB_PMALLOC_NUMA_LOCAL)
49 if (getcpu (&cpu, numa_node, 0) != 0)
56 clib_pmalloc_init (clib_pmalloc_main_t * pm, uword size)
62 ASSERT (pm->error == 0);
64 pm->log2_page_sz = 21;
65 pm->error = clib_mem_create_hugetlb_fd ("detect_hugepage_size", &fd);
72 if (fstat (fd, &st) == -1)
73 pm->log2_page_sz = min_log2 (st.st_blksize);
77 pagesize = 1ULL << pm->log2_page_sz;
79 size = size ? size : ((u64) DEFAULT_RESERVED_MB) << 20;
80 size = round_pow2 (size, pagesize);
82 pm->max_pages = size >> pm->log2_page_sz;
84 /* reserve VA space for future growth */
85 pm->base = mmap (0, size + pagesize, PROT_NONE,
86 MAP_PRIVATE | MAP_ANONYMOUS, -1, 0);
88 if (pm->base == MAP_FAILED)
90 pm->error = clib_error_return_unix (0, "failed to reserve %u pages");
94 off = round_pow2 (pointer_to_uword (pm->base), pagesize) -
95 pointer_to_uword (pm->base);
97 /* trim start and end of reservation to be page aligned */
100 munmap (pm->base, off);
104 munmap (pm->base + (pm->max_pages * pagesize), pagesize - off);
109 alloc_chunk_from_page (clib_pmalloc_main_t * pm, clib_pmalloc_page_t * pp,
110 u32 n_blocks, u32 block_align, u32 numa_node)
112 clib_pmalloc_chunk_t *c;
115 u32 alloc_chunk_index;
119 pool_get (pp->chunks, c);
120 pp->n_free_chunks = 1;
121 pp->first_chunk_index = c - pp->chunks;
122 c->prev = c->next = ~0;
123 c->size = pp->n_free_blocks;
126 alloc_chunk_index = pp->first_chunk_index;
129 c = pool_elt_at_index (pp->chunks, alloc_chunk_index);
130 off = (block_align - (c->start & (block_align - 1))) & (block_align - 1);
132 if (c->used || n_blocks + off > c->size)
136 alloc_chunk_index = c->next;
140 /* if alignment is needed create new empty chunk */
143 u32 offset_chunk_index;
144 clib_pmalloc_chunk_t *co;
145 pool_get (pp->chunks, c);
147 offset_chunk_index = alloc_chunk_index;
148 alloc_chunk_index = c - pp->chunks;
150 co = pool_elt_at_index (pp->chunks, offset_chunk_index);
151 c->size = co->size - off;
153 c->start = co->start + off;
154 c->prev = offset_chunk_index;
156 co->next = alloc_chunk_index;
160 if (c->size > n_blocks)
162 u32 tail_chunk_index;
163 clib_pmalloc_chunk_t *ct;
164 pool_get (pp->chunks, ct);
166 tail_chunk_index = ct - pp->chunks;
167 c = pool_elt_at_index (pp->chunks, alloc_chunk_index);
168 ct->size = c->size - n_blocks;
170 ct->prev = alloc_chunk_index;
171 ct->start = c->start + n_blocks;
174 c->next = tail_chunk_index;
176 pool_elt_at_index (pp->chunks, ct->next)->prev = tail_chunk_index;
178 else if (c->next != ~0)
179 pool_elt_at_index (pp->chunks, c->next)->prev = alloc_chunk_index;
181 c = get_chunk (pp, alloc_chunk_index);
182 va = pm->base + ((pp - pm->pages) << pm->log2_page_sz) +
183 (c->start << PMALLOC_LOG2_BLOCK_SZ);
184 hash_set (pm->chunk_index_by_va, pointer_to_uword (va), alloc_chunk_index);
185 pp->n_free_blocks -= n_blocks;
190 static inline clib_pmalloc_page_t *
191 pmalloc_map_pages (clib_pmalloc_main_t * pm, clib_pmalloc_arena_t * a,
192 u32 numa_node, u32 n_pages)
194 clib_pmalloc_page_t *pp = 0;
195 u64 seek, pa, sys_page_size;
196 int pagemap_fd, status, rv, i, mmap_flags;
199 long unsigned int mask[16] = { 0 };
200 long unsigned int old_mask[16] = { 0 };
202 clib_error_free (pm->error);
204 if (pm->max_pages <= vec_len (pm->pages))
206 pm->error = clib_error_return (0, "maximum number of pages reached");
210 pm->error = clib_sysfs_prealloc_hugepages (numa_node, pm->log2_page_sz,
216 rv = get_mempolicy (&old_mpol, old_mask, sizeof (old_mask) * 8 + 1, 0, 0);
217 /* failure to get mempolicy means we can only proceed with numa 0 maps */
218 if (rv == -1 && numa_node != 0)
220 pm->error = clib_error_return_unix (0, "failed to get mempolicy");
224 mask[0] = 1 << numa_node;
225 rv = set_mempolicy (MPOL_BIND, mask, sizeof (mask) * 8 + 1);
226 if (rv == -1 && numa_node != 0)
228 pm->error = clib_error_return_unix (0, "failed to set mempolicy for "
229 "numa node %u", numa_node);
233 mmap_flags = MAP_FIXED | MAP_HUGETLB | MAP_LOCKED | MAP_ANONYMOUS;
234 if (a->flags & CLIB_PMALLOC_ARENA_F_SHARED_MEM)
236 mmap_flags |= MAP_SHARED;
237 pm->error = clib_mem_create_hugetlb_fd ((char *) a->name, &a->fd);
243 mmap_flags |= MAP_PRIVATE;
247 va = pm->base + (vec_len (pm->pages) << pm->log2_page_sz);
248 if (mmap (va, n_pages << pm->log2_page_sz, PROT_READ | PROT_WRITE,
249 mmap_flags, a->fd, 0) == MAP_FAILED)
251 pm->error = clib_error_return_unix (0, "failed to mmap %u pages at %p "
252 "fd %d numa %d flags 0x%x", n_pages,
253 va, a->fd, numa_node, mmap_flags);
257 rv = set_mempolicy (old_mpol, old_mask, sizeof (old_mask) * 8 + 1);
258 if (rv == -1 && numa_node != 0)
260 pm->error = clib_error_return_unix (0, "failed to restore mempolicy");
264 /* we tolerate move_pages failure only if request os for numa node 0
265 to support non-numa kernels */
266 rv = move_pages (0, 1, &va, 0, &status, 0);
267 if ((rv == 0 && status != numa_node) || (rv != 0 && numa_node != 0))
269 pm->error = rv == -1 ?
270 clib_error_return_unix (0, "page allocated on wrong node, numa node "
271 "%u status %d", numa_node, status) :
272 clib_error_return (0, "page allocated on wrong node, numa node "
273 "%u status %d", numa_node, status);
275 /* unmap & reesrve */
276 munmap (va, n_pages << pm->log2_page_sz);
277 mmap (va, n_pages << pm->log2_page_sz, PROT_NONE,
278 MAP_FIXED | MAP_PRIVATE | MAP_ANONYMOUS, -1, 0);
282 memset (va, 0, n_pages << pm->log2_page_sz);
283 sys_page_size = sysconf (_SC_PAGESIZE);
284 pagemap_fd = open ((char *) "/proc/self/pagemap", O_RDONLY);
286 for (i = 0; i < n_pages; i++)
288 uword page_va = pointer_to_uword ((u8 *) va + (i << pm->log2_page_sz));
289 vec_add2 (pm->pages, pp, 1);
290 pp->n_free_blocks = 1 << (pm->log2_page_sz - PMALLOC_LOG2_BLOCK_SZ);
291 pp->index = pp - pm->pages;
292 pp->arena_index = a->index;
294 vec_add1 (a->page_indices, pp->index);
297 seek = (page_va / sys_page_size) * sizeof (pa);
298 if (pagemap_fd != -1 &&
299 lseek (pagemap_fd, seek, SEEK_SET) == seek &&
300 read (pagemap_fd, &pa, sizeof (pa)) == (sizeof (pa)) &&
301 pa & (1ULL << 63) /* page present bit */ )
303 pp->pa = (pa & pow2_mask (55)) * sys_page_size;
305 vec_add1_aligned (pm->va_pa_diffs, pp->pa ? page_va - pp->pa : 0,
306 CLIB_CACHE_LINE_BYTES);
309 if (pagemap_fd != -1)
312 /* return pointer to 1st page */
313 return pp - (n_pages - 1);
322 clib_pmalloc_create_shared_arena (clib_pmalloc_main_t * pm, char *name,
323 uword size, u32 numa_node)
325 clib_pmalloc_arena_t *a;
326 clib_pmalloc_page_t *pp;
327 u32 n_pages = round_pow2 (size, 1 << pm->log2_page_sz) >> pm->log2_page_sz;
329 if (n_pages + vec_len (pm->pages) > pm->max_pages)
332 if (pmalloc_validate_numa_node (&numa_node))
335 pool_get (pm->arenas, a);
336 a->index = a - pm->arenas;
337 a->name = format (0, "%s%c", name, 0);
338 a->numa_node = numa_node;
339 a->flags = CLIB_PMALLOC_ARENA_F_SHARED_MEM;
340 a->log2_page_sz = pm->log2_page_sz;
342 if ((pp = pmalloc_map_pages (pm, a, numa_node, n_pages)) == 0)
345 memset (a, 0, sizeof (*a));
346 pool_put (pm->arenas, a);
350 return pm->base + (pp->index << pm->log2_page_sz);
354 clib_pmalloc_alloc_inline (clib_pmalloc_main_t * pm, clib_pmalloc_arena_t * a,
355 uword size, uword align, u32 numa_node)
357 clib_pmalloc_page_t *pp;
358 u32 n_blocks, block_align, *page_index;
360 ASSERT (is_pow2 (align));
362 if (pmalloc_validate_numa_node (&numa_node))
367 vec_validate_init_empty (pm->default_arena_for_numa_node,
369 if (pm->default_arena_for_numa_node[numa_node] == ~0)
371 pool_get (pm->arenas, a);
372 pm->default_arena_for_numa_node[numa_node] = a - pm->arenas;
373 a->name = format (0, "default-numa-%u%c", numa_node, 0);
374 a->numa_node = numa_node;
377 a = pool_elt_at_index (pm->arenas,
378 pm->default_arena_for_numa_node[numa_node]);
381 n_blocks = round_pow2 (size, PMALLOC_BLOCK_SZ) / PMALLOC_BLOCK_SZ;
382 block_align = align >> PMALLOC_LOG2_BLOCK_SZ;
384 vec_foreach (page_index, a->page_indices)
386 pp = vec_elt_at_index (pm->pages, *page_index);
387 void *rv = alloc_chunk_from_page (pm, pp, n_blocks, block_align,
394 if ((a->flags & CLIB_PMALLOC_ARENA_F_SHARED_MEM) == 0 &&
395 (pp = pmalloc_map_pages (pm, a, numa_node, 1)))
396 return alloc_chunk_from_page (pm, pp, n_blocks, block_align, numa_node);
402 clib_pmalloc_alloc_aligned_on_numa (clib_pmalloc_main_t * pm, uword size,
403 uword align, u32 numa_node)
405 return clib_pmalloc_alloc_inline (pm, 0, size, align, numa_node);
409 clib_pmalloc_alloc_aligned (clib_pmalloc_main_t * pm, uword size, uword align)
411 return clib_pmalloc_alloc_inline (pm, 0, size, align,
412 CLIB_PMALLOC_NUMA_LOCAL);
416 clib_pmalloc_alloc_from_arena (clib_pmalloc_main_t * pm, void *arena_va,
417 uword size, uword align)
419 clib_pmalloc_arena_t *a = clib_pmalloc_get_arena (pm, arena_va);
420 return clib_pmalloc_alloc_inline (pm, a, size, align, 0);
424 clib_pmalloc_free (clib_pmalloc_main_t * pm, void *va)
426 clib_pmalloc_page_t *pp;
427 clib_pmalloc_chunk_t *c;
429 u32 chunk_index, page_index;
431 p = hash_get (pm->chunk_index_by_va, pointer_to_uword (va));
437 page_index = clib_pmalloc_get_page_index (pm, va);
438 hash_unset (pm->chunk_index_by_va, pointer_to_uword (va));
440 pp = vec_elt_at_index (pm->pages, page_index);
441 c = pool_elt_at_index (pp->chunks, chunk_index);
443 pp->n_free_blocks += c->size;
446 /* merge with next if free */
447 if (c->next != ~0 && get_chunk (pp, c->next)->used == 0)
449 clib_pmalloc_chunk_t *next = get_chunk (pp, c->next);
450 c->size += next->size;
451 c->next = next->next;
452 if (next->next != ~0)
453 get_chunk (pp, next->next)->prev = chunk_index;
454 memset (next, 0, sizeof (*next));
455 pool_put (pp->chunks, next);
459 /* merge with prev if free */
460 if (c->prev != ~0 && get_chunk (pp, c->prev)->used == 0)
462 clib_pmalloc_chunk_t *prev = get_chunk (pp, c->prev);
463 prev->size += c->size;
464 prev->next = c->next;
466 get_chunk (pp, c->next)->prev = c->prev;
467 memset (c, 0, sizeof (*c));
468 pool_put (pp->chunks, c);
474 format_pmalloc_page (u8 * s, va_list * va)
476 clib_pmalloc_page_t *pp = va_arg (*va, clib_pmalloc_page_t *);
477 int verbose = va_arg (*va, int);
478 u32 indent = format_get_indent (s);
480 s = format (s, "page %u: phys-addr %p ", pp->index, pp->pa);
485 s = format (s, "free %u chunks %u free-chunks %d ",
486 (pp->n_free_blocks) << PMALLOC_LOG2_BLOCK_SZ,
487 pool_elts (pp->chunks), pp->n_free_chunks);
491 clib_pmalloc_chunk_t *c;
492 c = pool_elt_at_index (pp->chunks, pp->first_chunk_index);
493 s = format (s, "\n%U%12s%12s%8s%8s%8s%8s",
494 format_white_space, indent + 2,
495 "chunk offset", "size", "used", "index", "prev", "next");
498 s = format (s, "\n%U%12u%12u%8s%8d%8d%8d",
499 format_white_space, indent + 2,
500 c->start << PMALLOC_LOG2_BLOCK_SZ,
501 c->size << PMALLOC_LOG2_BLOCK_SZ,
502 c->used ? "yes" : "no",
503 c - pp->chunks, c->prev, c->next);
506 c = pool_elt_at_index (pp->chunks, c->next);
513 format_pmalloc (u8 * s, va_list * va)
515 clib_pmalloc_main_t *pm = va_arg (*va, clib_pmalloc_main_t *);
516 int verbose = va_arg (*va, int);
517 u32 indent = format_get_indent (s);
519 clib_pmalloc_page_t *pp;
520 clib_pmalloc_arena_t *a;
522 s = format (s, "used-pages %u reserved-pages %u pagesize %uKB",
523 vec_len (pm->pages), pm->max_pages,
524 1 << (pm->log2_page_sz - 10));
527 s = format (s, " va-start %p", pm->base);
530 s = format (s, "\n%Ulast-error: %U", format_white_space, indent + 2,
531 format_clib_error, pm->error);
535 pool_foreach (a, pm->arenas,
538 s = format (s, "\n%Uarena '%s' pages %u numa-node %u",
539 format_white_space, indent + 2,
540 a->name, vec_len (a->page_indices), a->numa_node);
542 s = format (s, " shared fd %d", a->fd);
544 vec_foreach (page_index, a->page_indices)
546 pp = vec_elt_at_index (pm->pages, *page_index);
547 s = format (s, "\n%U%U", format_white_space, indent + 4,
548 format_pmalloc_page, pp, verbose);
557 * fd.io coding-style-patch-verification: ON
560 * eval: (c-set-style "gnu")