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_size2pages (uword size, u32 log2_page_sz)
46 return round_pow2 (size, 1ULL << log2_page_sz) >> log2_page_sz;
50 pmalloc_validate_numa_node (u32 * numa_node)
52 if (*numa_node == CLIB_PMALLOC_NUMA_LOCAL)
55 if (getcpu (&cpu, numa_node, 0) != 0)
62 clib_pmalloc_init (clib_pmalloc_main_t * pm, uword size)
67 ASSERT (pm->error == 0);
69 pagesize = clib_mem_get_default_hugepage_size ();
70 pm->def_log2_page_sz = min_log2 (pagesize);
71 pm->sys_log2_page_sz = min_log2 (sysconf (_SC_PAGESIZE));
72 pm->lookup_log2_page_sz = pm->def_log2_page_sz;
74 /* check if pagemap is accessible */
75 pt = clib_mem_vm_get_paddr (&pt, pm->sys_log2_page_sz, 1);
76 if (pt == 0 || pt[0] == 0)
77 pm->flags |= CLIB_PMALLOC_F_NO_PAGEMAP;
79 size = size ? size : ((u64) DEFAULT_RESERVED_MB) << 20;
80 size = round_pow2 (size, pagesize);
82 pm->max_pages = size >> pm->def_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 + ((uword) 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 = 0;
113 clib_pmalloc_arena_t *a;
116 u32 alloc_chunk_index;
118 a = pool_elt_at_index (pm->arenas, pp->arena_index);
122 u32 i, start = 0, prev = ~0;
124 for (i = 0; i < a->subpages_per_page; i++)
126 pool_get (pp->chunks, c);
129 c->size = pp->n_free_blocks / a->subpages_per_page;
132 pp->first_chunk_index = c - pp->chunks;
134 pp->chunks[prev].next = c - pp->chunks;
135 prev = c - pp->chunks;
138 pp->n_free_chunks = a->subpages_per_page;
141 alloc_chunk_index = pp->first_chunk_index;
144 c = pool_elt_at_index (pp->chunks, alloc_chunk_index);
145 off = (block_align - (c->start & (block_align - 1))) & (block_align - 1);
147 if (c->used || n_blocks + off > c->size)
151 alloc_chunk_index = c->next;
155 /* if alignment is needed create new empty chunk */
158 u32 offset_chunk_index;
159 clib_pmalloc_chunk_t *co;
160 pool_get (pp->chunks, c);
162 offset_chunk_index = alloc_chunk_index;
163 alloc_chunk_index = c - pp->chunks;
165 co = pool_elt_at_index (pp->chunks, offset_chunk_index);
166 c->size = co->size - off;
168 c->start = co->start + off;
169 c->prev = offset_chunk_index;
171 co->next = alloc_chunk_index;
175 if (c->size > n_blocks)
177 u32 tail_chunk_index;
178 clib_pmalloc_chunk_t *ct;
179 pool_get (pp->chunks, ct);
181 tail_chunk_index = ct - pp->chunks;
182 c = pool_elt_at_index (pp->chunks, alloc_chunk_index);
183 ct->size = c->size - n_blocks;
185 ct->prev = alloc_chunk_index;
186 ct->start = c->start + n_blocks;
189 c->next = tail_chunk_index;
191 pool_elt_at_index (pp->chunks, ct->next)->prev = tail_chunk_index;
193 else if (c->next != ~0)
194 pool_elt_at_index (pp->chunks, c->next)->prev = alloc_chunk_index;
196 c = get_chunk (pp, alloc_chunk_index);
197 va = pm->base + ((pp - pm->pages) << pm->def_log2_page_sz) +
198 (c->start << PMALLOC_LOG2_BLOCK_SZ);
199 hash_set (pm->chunk_index_by_va, pointer_to_uword (va), alloc_chunk_index);
200 pp->n_free_blocks -= n_blocks;
206 pmalloc_update_lookup_table (clib_pmalloc_main_t * pm, u32 first, u32 count)
208 uword seek, va, pa, p;
210 u32 elts_per_page = 1U << (pm->def_log2_page_sz - pm->lookup_log2_page_sz);
212 vec_validate_aligned (pm->lookup_table, vec_len (pm->pages) *
213 elts_per_page - 1, CLIB_CACHE_LINE_BYTES);
215 p = (uword) first *elts_per_page;
216 if (pm->flags & CLIB_PMALLOC_F_NO_PAGEMAP)
218 while (p < (uword) elts_per_page * count)
220 pm->lookup_table[p] = pointer_to_uword (pm->base) +
221 (p << pm->lookup_log2_page_sz);
227 fd = open ((char *) "/proc/self/pagemap", O_RDONLY);
228 while (p < (uword) elts_per_page * count)
230 va = pointer_to_uword (pm->base) + (p << pm->lookup_log2_page_sz);
232 seek = (va >> pm->sys_log2_page_sz) * sizeof (pa);
233 if (fd != -1 && lseek (fd, seek, SEEK_SET) == seek &&
234 read (fd, &pa, sizeof (pa)) == (sizeof (pa)) &&
235 pa & (1ULL << 63) /* page present bit */ )
237 pa = (pa & pow2_mask (55)) << pm->sys_log2_page_sz;
239 pm->lookup_table[p] = va - pa;
247 static inline clib_pmalloc_page_t *
248 pmalloc_map_pages (clib_pmalloc_main_t * pm, clib_pmalloc_arena_t * a,
249 u32 numa_node, u32 n_pages)
251 clib_pmalloc_page_t *pp = 0;
252 int status, rv, i, mmap_flags;
255 long unsigned int mask[16] = { 0 };
256 long unsigned int old_mask[16] = { 0 };
257 uword size = (uword) n_pages << pm->def_log2_page_sz;
259 clib_error_free (pm->error);
261 if (pm->max_pages <= vec_len (pm->pages))
263 pm->error = clib_error_return (0, "maximum number of pages reached");
267 if (a->log2_subpage_sz != pm->sys_log2_page_sz)
269 pm->error = clib_sysfs_prealloc_hugepages (numa_node,
270 a->log2_subpage_sz, n_pages);
276 rv = get_mempolicy (&old_mpol, old_mask, sizeof (old_mask) * 8 + 1, 0, 0);
277 /* failure to get mempolicy means we can only proceed with numa 0 maps */
278 if (rv == -1 && numa_node != 0)
280 pm->error = clib_error_return_unix (0, "failed to get mempolicy");
284 mask[0] = 1 << numa_node;
285 rv = set_mempolicy (MPOL_BIND, mask, sizeof (mask) * 8 + 1);
286 if (rv == -1 && numa_node != 0)
288 pm->error = clib_error_return_unix (0, "failed to set mempolicy for "
289 "numa node %u", numa_node);
293 mmap_flags = MAP_FIXED;
295 if ((pm->flags & CLIB_PMALLOC_F_NO_PAGEMAP) == 0)
296 mmap_flags |= MAP_LOCKED;
298 if (a->flags & CLIB_PMALLOC_ARENA_F_SHARED_MEM)
300 mmap_flags |= MAP_SHARED;
301 if (a->log2_subpage_sz != pm->sys_log2_page_sz)
302 pm->error = clib_mem_create_hugetlb_fd ((char *) a->name, &a->fd);
304 pm->error = clib_mem_create_fd ((char *) a->name, &a->fd);
307 if ((ftruncate (a->fd, size)) == -1)
312 if (a->log2_subpage_sz != pm->sys_log2_page_sz)
313 mmap_flags |= MAP_HUGETLB;
315 mmap_flags |= MAP_PRIVATE | MAP_ANONYMOUS;
319 va = pm->base + (((uword) vec_len (pm->pages)) << pm->def_log2_page_sz);
320 if (mmap (va, size, PROT_READ | PROT_WRITE, mmap_flags, a->fd, 0) ==
323 pm->error = clib_error_return_unix (0, "failed to mmap %u pages at %p "
324 "fd %d numa %d flags 0x%x", n_pages,
325 va, a->fd, numa_node, mmap_flags);
329 clib_memset (va, 0, size);
331 rv = set_mempolicy (old_mpol, old_mask, sizeof (old_mask) * 8 + 1);
332 if (rv == -1 && numa_node != 0)
334 pm->error = clib_error_return_unix (0, "failed to restore mempolicy");
338 /* we tolerate move_pages failure only if request os for numa node 0
339 to support non-numa kernels */
340 rv = move_pages (0, 1, &va, 0, &status, 0);
341 if ((rv == 0 && status != numa_node) || (rv != 0 && numa_node != 0))
343 pm->error = rv == -1 ?
344 clib_error_return_unix (0, "page allocated on wrong node, numa node "
345 "%u status %d", numa_node, status) :
346 clib_error_return (0, "page allocated on wrong node, numa node "
347 "%u status %d", numa_node, status);
349 /* unmap & reesrve */
351 mmap (va, size, PROT_NONE, MAP_FIXED | MAP_PRIVATE | MAP_ANONYMOUS,
356 for (i = 0; i < n_pages; i++)
358 vec_add2 (pm->pages, pp, 1);
359 pp->n_free_blocks = 1 << (pm->def_log2_page_sz - PMALLOC_LOG2_BLOCK_SZ);
360 pp->index = pp - pm->pages;
361 pp->arena_index = a->index;
362 vec_add1 (a->page_indices, pp->index);
367 /* if new arena is using smaller page size, we need to rebuild whole
369 if (a->log2_subpage_sz < pm->lookup_log2_page_sz)
371 pm->lookup_log2_page_sz = a->log2_subpage_sz;
372 pmalloc_update_lookup_table (pm, vec_len (pm->pages) - n_pages,
376 pmalloc_update_lookup_table (pm, 0, vec_len (pm->pages));
378 /* return pointer to 1st page */
379 return pp - (n_pages - 1);
388 clib_pmalloc_create_shared_arena (clib_pmalloc_main_t * pm, char *name,
389 uword size, u32 log2_page_sz, u32 numa_node)
391 clib_pmalloc_arena_t *a;
392 clib_pmalloc_page_t *pp;
395 clib_error_free (pm->error);
397 if (log2_page_sz == 0)
398 log2_page_sz = pm->def_log2_page_sz;
399 else if (log2_page_sz != pm->def_log2_page_sz &&
400 log2_page_sz != pm->sys_log2_page_sz)
402 pm->error = clib_error_create ("unsupported page size (%uKB)",
403 1 << (log2_page_sz - 10));
407 n_pages = pmalloc_size2pages (size, pm->def_log2_page_sz);
409 if (n_pages + vec_len (pm->pages) > pm->max_pages)
412 if (pmalloc_validate_numa_node (&numa_node))
415 pool_get (pm->arenas, a);
416 a->index = a - pm->arenas;
417 a->name = format (0, "%s%c", name, 0);
418 a->numa_node = numa_node;
419 a->flags = CLIB_PMALLOC_ARENA_F_SHARED_MEM;
420 a->log2_subpage_sz = log2_page_sz;
421 a->subpages_per_page = 1U << (pm->def_log2_page_sz - log2_page_sz);
423 if ((pp = pmalloc_map_pages (pm, a, numa_node, n_pages)) == 0)
426 memset (a, 0, sizeof (*a));
427 pool_put (pm->arenas, a);
431 return pm->base + ((uword) pp->index << pm->def_log2_page_sz);
435 clib_pmalloc_alloc_inline (clib_pmalloc_main_t * pm, clib_pmalloc_arena_t * a,
436 uword size, uword align, u32 numa_node)
438 clib_pmalloc_page_t *pp;
439 u32 n_blocks, block_align, *page_index;
441 ASSERT (is_pow2 (align));
443 if (pmalloc_validate_numa_node (&numa_node))
448 if (size > 1ULL << pm->def_log2_page_sz)
451 vec_validate_init_empty (pm->default_arena_for_numa_node,
453 if (pm->default_arena_for_numa_node[numa_node] == ~0)
455 pool_get (pm->arenas, a);
456 pm->default_arena_for_numa_node[numa_node] = a - pm->arenas;
457 a->name = format (0, "default-numa-%u%c", numa_node, 0);
458 a->numa_node = numa_node;
459 a->log2_subpage_sz = pm->def_log2_page_sz;
460 a->subpages_per_page = 1;
463 a = pool_elt_at_index (pm->arenas,
464 pm->default_arena_for_numa_node[numa_node]);
466 else if (size > 1ULL << a->log2_subpage_sz)
469 n_blocks = round_pow2 (size, PMALLOC_BLOCK_SZ) / PMALLOC_BLOCK_SZ;
470 block_align = align >> PMALLOC_LOG2_BLOCK_SZ;
472 vec_foreach (page_index, a->page_indices)
474 pp = vec_elt_at_index (pm->pages, *page_index);
475 void *rv = alloc_chunk_from_page (pm, pp, n_blocks, block_align,
482 if ((a->flags & CLIB_PMALLOC_ARENA_F_SHARED_MEM) == 0 &&
483 (pp = pmalloc_map_pages (pm, a, numa_node, 1)))
484 return alloc_chunk_from_page (pm, pp, n_blocks, block_align, numa_node);
490 clib_pmalloc_alloc_aligned_on_numa (clib_pmalloc_main_t * pm, uword size,
491 uword align, u32 numa_node)
493 return clib_pmalloc_alloc_inline (pm, 0, size, align, numa_node);
497 clib_pmalloc_alloc_aligned (clib_pmalloc_main_t * pm, uword size, uword align)
499 return clib_pmalloc_alloc_inline (pm, 0, size, align,
500 CLIB_PMALLOC_NUMA_LOCAL);
504 clib_pmalloc_alloc_from_arena (clib_pmalloc_main_t * pm, void *arena_va,
505 uword size, uword align)
507 clib_pmalloc_arena_t *a = clib_pmalloc_get_arena (pm, arena_va);
508 return clib_pmalloc_alloc_inline (pm, a, size, align, 0);
512 pmalloc_chunks_mergeable (clib_pmalloc_arena_t * a, clib_pmalloc_page_t * pp,
515 clib_pmalloc_chunk_t *c1, *c2;
517 if (ci1 == ~0 || ci2 == ~0)
520 c1 = get_chunk (pp, ci1);
521 c2 = get_chunk (pp, ci2);
523 if (c1->used || c2->used)
526 if (c1->start >> (a->log2_subpage_sz - PMALLOC_LOG2_BLOCK_SZ) !=
527 c2->start >> (a->log2_subpage_sz - PMALLOC_LOG2_BLOCK_SZ))
534 clib_pmalloc_free (clib_pmalloc_main_t * pm, void *va)
536 clib_pmalloc_page_t *pp;
537 clib_pmalloc_chunk_t *c;
538 clib_pmalloc_arena_t *a;
540 u32 chunk_index, page_index;
542 p = hash_get (pm->chunk_index_by_va, pointer_to_uword (va));
548 page_index = clib_pmalloc_get_page_index (pm, va);
549 hash_unset (pm->chunk_index_by_va, pointer_to_uword (va));
551 pp = vec_elt_at_index (pm->pages, page_index);
552 c = pool_elt_at_index (pp->chunks, chunk_index);
553 a = pool_elt_at_index (pm->arenas, pp->arena_index);
555 pp->n_free_blocks += c->size;
558 /* merge with next if free */
559 if (pmalloc_chunks_mergeable (a, pp, chunk_index, c->next))
561 clib_pmalloc_chunk_t *next = get_chunk (pp, c->next);
562 c->size += next->size;
563 c->next = next->next;
564 if (next->next != ~0)
565 get_chunk (pp, next->next)->prev = chunk_index;
566 memset (next, 0, sizeof (*next));
567 pool_put (pp->chunks, next);
571 /* merge with prev if free */
572 if (pmalloc_chunks_mergeable (a, pp, c->prev, chunk_index))
574 clib_pmalloc_chunk_t *prev = get_chunk (pp, c->prev);
575 prev->size += c->size;
576 prev->next = c->next;
578 get_chunk (pp, c->next)->prev = c->prev;
579 memset (c, 0, sizeof (*c));
580 pool_put (pp->chunks, c);
586 format_log2_page_size (u8 * s, va_list * va)
588 u32 log2_page_sz = va_arg (*va, u32);
590 if (log2_page_sz >= 30)
591 return format (s, "%uGB", 1 << (log2_page_sz - 30));
593 if (log2_page_sz >= 20)
594 return format (s, "%uMB", 1 << (log2_page_sz - 20));
596 if (log2_page_sz >= 10)
597 return format (s, "%uKB", 1 << (log2_page_sz - 10));
599 return format (s, "%uB", 1 << log2_page_sz);
604 format_pmalloc_page (u8 * s, va_list * va)
606 clib_pmalloc_page_t *pp = va_arg (*va, clib_pmalloc_page_t *);
607 int verbose = va_arg (*va, int);
608 u32 indent = format_get_indent (s);
613 s = format (s, "free %u chunks %u free-chunks %d ",
614 (pp->n_free_blocks) << PMALLOC_LOG2_BLOCK_SZ,
615 pool_elts (pp->chunks), pp->n_free_chunks);
619 clib_pmalloc_chunk_t *c;
620 c = pool_elt_at_index (pp->chunks, pp->first_chunk_index);
621 s = format (s, "\n%U%12s%12s%8s%8s%8s%8s",
622 format_white_space, indent + 2,
623 "chunk offset", "size", "used", "index", "prev", "next");
626 s = format (s, "\n%U%12u%12u%8s%8d%8d%8d",
627 format_white_space, indent + 2,
628 c->start << PMALLOC_LOG2_BLOCK_SZ,
629 c->size << PMALLOC_LOG2_BLOCK_SZ,
630 c->used ? "yes" : "no",
631 c - pp->chunks, c->prev, c->next);
634 c = pool_elt_at_index (pp->chunks, c->next);
641 format_pmalloc (u8 * s, va_list * va)
643 clib_pmalloc_main_t *pm = va_arg (*va, clib_pmalloc_main_t *);
644 int verbose = va_arg (*va, int);
645 u32 indent = format_get_indent (s);
647 clib_pmalloc_page_t *pp;
648 clib_pmalloc_arena_t *a;
650 s = format (s, "used-pages %u reserved-pages %u default-page-size %U "
651 "lookup-page-size %U%s", vec_len (pm->pages), pm->max_pages,
652 format_log2_page_size, pm->def_log2_page_sz,
653 format_log2_page_size, pm->lookup_log2_page_sz,
654 pm->flags & CLIB_PMALLOC_F_NO_PAGEMAP ? " no-pagemap" : "");
658 s = format (s, " va-start %p", pm->base);
661 s = format (s, "\n%Ulast-error: %U", format_white_space, indent + 2,
662 format_clib_error, pm->error);
666 pool_foreach (a, pm->arenas,
669 s = format (s, "\n%Uarena '%s' pages %u subpage-size %U numa-node %u",
670 format_white_space, indent + 2, a->name,
671 vec_len (a->page_indices), format_log2_page_size,
672 a->log2_subpage_sz, a->numa_node);
674 s = format (s, " shared fd %d", a->fd);
676 vec_foreach (page_index, a->page_indices)
678 pp = vec_elt_at_index (pm->pages, *page_index);
679 s = format (s, "\n%U%U", format_white_space, indent + 4,
680 format_pmalloc_page, pp, verbose);
689 format_pmalloc_map (u8 * s, va_list * va)
691 clib_pmalloc_main_t *pm = va_arg (*va, clib_pmalloc_main_t *);
694 s = format (s, "%16s %13s %8s", "virtual-addr", "physical-addr", "size");
695 vec_foreach_index (index, pm->lookup_table)
697 uword *lookup_val, pa, va;
698 lookup_val = vec_elt_at_index (pm->lookup_table, index);
700 pointer_to_uword (pm->base) +
701 ((uword) index << pm->lookup_log2_page_sz);
702 pa = va - *lookup_val;
704 format (s, "\n %16p %13p %8U", uword_to_pointer (va, u64),
705 uword_to_pointer (pa, u64), format_log2_page_size,
706 pm->lookup_log2_page_sz);
712 * fd.io coding-style-patch-verification: ON
715 * eval: (c-set-style "gnu")