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>
22 #include <linux/mempolicy.h>
23 #include <linux/memfd.h>
26 #include <vppinfra/format.h>
27 #include <vppinfra/linux/syscall.h>
28 #include <vppinfra/linux/sysfs.h>
29 #include <vppinfra/mem.h>
30 #include <vppinfra/hash.h>
31 #include <vppinfra/pmalloc.h>
33 #if __SIZEOF_POINTER__ >= 8
34 #define DEFAULT_RESERVED_MB 16384
36 #define DEFAULT_RESERVED_MB 256
39 static inline clib_pmalloc_chunk_t *
40 get_chunk (clib_pmalloc_page_t * pp, u32 index)
42 return pool_elt_at_index (pp->chunks, index);
46 pmalloc_size2pages (uword size, u32 log2_page_sz)
48 return round_pow2 (size, 1ULL << log2_page_sz) >> log2_page_sz;
52 pmalloc_validate_numa_node (u32 * numa_node)
54 if (*numa_node == CLIB_PMALLOC_NUMA_LOCAL)
57 if (getcpu (&cpu, numa_node) != 0)
64 clib_pmalloc_init (clib_pmalloc_main_t * pm, uword base_addr, uword size)
70 ASSERT (pm->error == 0);
72 pagesize = clib_mem_get_default_hugepage_size ();
73 pm->def_log2_page_sz = min_log2 (pagesize);
74 pm->sys_log2_page_sz = min_log2 (sysconf (_SC_PAGESIZE));
75 pm->lookup_log2_page_sz = pm->def_log2_page_sz;
77 /* check if pagemap is accessible */
78 pt = clib_mem_vm_get_paddr (&pt, pm->sys_log2_page_sz, 1);
79 if (pt == 0 || pt[0] == 0)
80 pm->flags |= CLIB_PMALLOC_F_NO_PAGEMAP;
82 size = size ? size : ((u64) DEFAULT_RESERVED_MB) << 20;
83 size = round_pow2 (size, pagesize);
85 pm->max_pages = size >> pm->def_log2_page_sz;
87 /* reserve VA space for future growth */
88 mmap_flags = MAP_PRIVATE | MAP_ANONYMOUS;
91 mmap_flags |= MAP_FIXED;
93 pm->base = mmap (uword_to_pointer (base_addr, void *), size + pagesize,
94 PROT_NONE, mmap_flags, -1, 0);
96 if (pm->base == MAP_FAILED)
98 pm->error = clib_error_return_unix (0, "failed to reserve %u pages");
102 off = round_pow2 (pointer_to_uword (pm->base), pagesize) -
103 pointer_to_uword (pm->base);
105 /* trim start and end of reservation to be page aligned */
108 munmap (pm->base, off);
112 munmap (pm->base + ((uword) pm->max_pages * pagesize), pagesize - off);
117 alloc_chunk_from_page (clib_pmalloc_main_t * pm, clib_pmalloc_page_t * pp,
118 u32 n_blocks, u32 block_align, u32 numa_node)
120 clib_pmalloc_chunk_t *c = 0;
121 clib_pmalloc_arena_t *a;
124 u32 alloc_chunk_index;
126 a = pool_elt_at_index (pm->arenas, pp->arena_index);
130 u32 i, start = 0, prev = ~0;
132 for (i = 0; i < a->subpages_per_page; i++)
134 pool_get (pp->chunks, c);
137 c->size = pp->n_free_blocks / a->subpages_per_page;
140 pp->first_chunk_index = c - pp->chunks;
142 pp->chunks[prev].next = c - pp->chunks;
143 prev = c - pp->chunks;
146 pp->n_free_chunks = a->subpages_per_page;
149 if (pp->n_free_blocks < n_blocks)
152 alloc_chunk_index = pp->first_chunk_index;
155 c = pool_elt_at_index (pp->chunks, alloc_chunk_index);
156 off = (block_align - (c->start & (block_align - 1))) & (block_align - 1);
158 if (c->used || n_blocks + off > c->size)
162 alloc_chunk_index = c->next;
166 /* if alignment is needed create new empty chunk */
169 u32 offset_chunk_index;
170 clib_pmalloc_chunk_t *co;
171 pool_get (pp->chunks, c);
173 offset_chunk_index = alloc_chunk_index;
174 alloc_chunk_index = c - pp->chunks;
176 co = pool_elt_at_index (pp->chunks, offset_chunk_index);
177 c->size = co->size - off;
179 c->start = co->start + off;
180 c->prev = offset_chunk_index;
182 co->next = alloc_chunk_index;
186 if (c->size > n_blocks)
188 u32 tail_chunk_index;
189 clib_pmalloc_chunk_t *ct;
190 pool_get (pp->chunks, ct);
192 tail_chunk_index = ct - pp->chunks;
193 c = pool_elt_at_index (pp->chunks, alloc_chunk_index);
194 ct->size = c->size - n_blocks;
196 ct->prev = alloc_chunk_index;
197 ct->start = c->start + n_blocks;
200 c->next = tail_chunk_index;
202 pool_elt_at_index (pp->chunks, ct->next)->prev = tail_chunk_index;
204 else if (c->next != ~0)
205 pool_elt_at_index (pp->chunks, c->next)->prev = alloc_chunk_index;
207 c = get_chunk (pp, alloc_chunk_index);
208 va = pm->base + ((pp - pm->pages) << pm->def_log2_page_sz) +
209 (c->start << PMALLOC_LOG2_BLOCK_SZ);
210 hash_set (pm->chunk_index_by_va, pointer_to_uword (va), alloc_chunk_index);
211 pp->n_free_blocks -= n_blocks;
217 pmalloc_update_lookup_table (clib_pmalloc_main_t * pm, u32 first, u32 count)
219 uword seek, va, pa, p;
221 u32 elts_per_page = 1U << (pm->def_log2_page_sz - pm->lookup_log2_page_sz);
223 vec_validate_aligned (pm->lookup_table, vec_len (pm->pages) *
224 elts_per_page - 1, CLIB_CACHE_LINE_BYTES);
226 p = (uword) first *elts_per_page;
227 if (pm->flags & CLIB_PMALLOC_F_NO_PAGEMAP)
229 while (p < (uword) elts_per_page * count)
231 pm->lookup_table[p] = pointer_to_uword (pm->base) +
232 (p << pm->lookup_log2_page_sz);
238 fd = open ((char *) "/proc/self/pagemap", O_RDONLY);
239 while (p < (uword) elts_per_page * count)
241 va = pointer_to_uword (pm->base) + (p << pm->lookup_log2_page_sz);
243 seek = (va >> pm->sys_log2_page_sz) * sizeof (pa);
244 if (fd != -1 && lseek (fd, seek, SEEK_SET) == seek &&
245 read (fd, &pa, sizeof (pa)) == (sizeof (pa)) &&
246 pa & (1ULL << 63) /* page present bit */ )
248 pa = (pa & pow2_mask (55)) << pm->sys_log2_page_sz;
250 pm->lookup_table[p] = va - pa;
258 static inline clib_pmalloc_page_t *
259 pmalloc_map_pages (clib_pmalloc_main_t * pm, clib_pmalloc_arena_t * a,
260 u32 numa_node, u32 n_pages)
262 clib_pmalloc_page_t *pp = 0;
263 int status, rv, i, mmap_flags;
264 void *va = MAP_FAILED;
266 long unsigned int mask[16] = { 0 };
267 long unsigned int old_mask[16] = { 0 };
268 uword size = (uword) n_pages << pm->def_log2_page_sz;
270 clib_error_free (pm->error);
272 if (pm->max_pages <= vec_len (pm->pages))
274 pm->error = clib_error_return (0, "maximum number of pages reached");
278 if (a->log2_subpage_sz != pm->sys_log2_page_sz)
280 pm->error = clib_sysfs_prealloc_hugepages (numa_node,
281 a->log2_subpage_sz, n_pages);
287 rv = get_mempolicy (&old_mpol, old_mask, sizeof (old_mask) * 8 + 1, 0, 0);
288 /* failure to get mempolicy means we can only proceed with numa 0 maps */
289 if (rv == -1 && numa_node != 0)
291 pm->error = clib_error_return_unix (0, "failed to get mempolicy");
295 mask[0] = 1 << numa_node;
296 rv = set_mempolicy (MPOL_BIND, mask, sizeof (mask) * 8 + 1);
297 if (rv == -1 && numa_node != 0)
299 pm->error = clib_error_return_unix (0, "failed to set mempolicy for "
300 "numa node %u", numa_node);
304 mmap_flags = MAP_FIXED;
306 if (a->flags & CLIB_PMALLOC_ARENA_F_SHARED_MEM)
308 mmap_flags |= MAP_SHARED;
309 if (a->log2_subpage_sz != pm->sys_log2_page_sz)
310 pm->error = clib_mem_create_hugetlb_fd ((char *) a->name, &a->fd);
312 pm->error = clib_mem_create_fd ((char *) a->name, &a->fd);
315 if ((ftruncate (a->fd, size)) == -1)
320 if (a->log2_subpage_sz != pm->sys_log2_page_sz)
321 mmap_flags |= MAP_HUGETLB;
323 mmap_flags |= MAP_PRIVATE | MAP_ANONYMOUS;
327 va = pm->base + (((uword) vec_len (pm->pages)) << pm->def_log2_page_sz);
328 if (mmap (va, size, PROT_READ | PROT_WRITE, mmap_flags, a->fd, 0) ==
331 pm->error = clib_error_return_unix (0, "failed to mmap %u pages at %p "
332 "fd %d numa %d flags 0x%x", n_pages,
333 va, a->fd, numa_node, mmap_flags);
337 if (a->log2_subpage_sz != pm->sys_log2_page_sz && mlock (va, size) != 0)
339 pm->error = clib_error_return_unix (0, "Unable to lock pages");
343 clib_memset (va, 0, size);
345 rv = set_mempolicy (old_mpol, old_mask, sizeof (old_mask) * 8 + 1);
346 if (rv == -1 && numa_node != 0)
348 pm->error = clib_error_return_unix (0, "failed to restore mempolicy");
352 /* we tolerate move_pages failure only if request os for numa node 0
353 to support non-numa kernels */
354 rv = move_pages (0, 1, &va, 0, &status, 0);
355 if ((rv == 0 && status != numa_node) || (rv != 0 && numa_node != 0))
357 pm->error = rv == -1 ?
358 clib_error_return_unix (0, "page allocated on wrong node, numa node "
359 "%u status %d", numa_node, status) :
360 clib_error_return (0, "page allocated on wrong node, numa node "
361 "%u status %d", numa_node, status);
366 for (i = 0; i < n_pages; i++)
368 vec_add2 (pm->pages, pp, 1);
369 pp->n_free_blocks = 1 << (pm->def_log2_page_sz - PMALLOC_LOG2_BLOCK_SZ);
370 pp->index = pp - pm->pages;
371 pp->arena_index = a->index;
372 vec_add1 (a->page_indices, pp->index);
377 /* if new arena is using smaller page size, we need to rebuild whole
379 if (a->log2_subpage_sz < pm->lookup_log2_page_sz)
381 pm->lookup_log2_page_sz = a->log2_subpage_sz;
382 pmalloc_update_lookup_table (pm, vec_len (pm->pages) - n_pages,
386 pmalloc_update_lookup_table (pm, 0, vec_len (pm->pages));
388 /* return pointer to 1st page */
389 return pp - (n_pages - 1);
392 if (va != MAP_FAILED)
394 /* unmap & reserve */
396 mmap (va, size, PROT_NONE, MAP_FIXED | MAP_PRIVATE | MAP_ANONYMOUS,
405 clib_pmalloc_create_shared_arena (clib_pmalloc_main_t * pm, char *name,
406 uword size, u32 log2_page_sz, u32 numa_node)
408 clib_pmalloc_arena_t *a;
409 clib_pmalloc_page_t *pp;
412 clib_error_free (pm->error);
414 if (log2_page_sz == 0)
415 log2_page_sz = pm->def_log2_page_sz;
416 else if (log2_page_sz != pm->def_log2_page_sz &&
417 log2_page_sz != pm->sys_log2_page_sz)
419 pm->error = clib_error_create ("unsupported page size (%uKB)",
420 1 << (log2_page_sz - 10));
424 n_pages = pmalloc_size2pages (size, pm->def_log2_page_sz);
426 if (n_pages + vec_len (pm->pages) > pm->max_pages)
429 if (pmalloc_validate_numa_node (&numa_node))
432 pool_get (pm->arenas, a);
433 a->index = a - pm->arenas;
434 a->name = format (0, "%s%c", name, 0);
435 a->numa_node = numa_node;
436 a->flags = CLIB_PMALLOC_ARENA_F_SHARED_MEM;
437 a->log2_subpage_sz = log2_page_sz;
438 a->subpages_per_page = 1U << (pm->def_log2_page_sz - log2_page_sz);
440 if ((pp = pmalloc_map_pages (pm, a, numa_node, n_pages)) == 0)
443 memset (a, 0, sizeof (*a));
444 pool_put (pm->arenas, a);
448 return pm->base + ((uword) pp->index << pm->def_log2_page_sz);
452 clib_pmalloc_alloc_inline (clib_pmalloc_main_t * pm, clib_pmalloc_arena_t * a,
453 uword size, uword align, u32 numa_node)
455 clib_pmalloc_page_t *pp;
456 u32 n_blocks, block_align, *page_index;
458 ASSERT (is_pow2 (align));
460 if (pmalloc_validate_numa_node (&numa_node))
465 if (size > 1ULL << pm->def_log2_page_sz)
468 vec_validate_init_empty (pm->default_arena_for_numa_node,
470 if (pm->default_arena_for_numa_node[numa_node] == ~0)
472 pool_get (pm->arenas, a);
473 pm->default_arena_for_numa_node[numa_node] = a - pm->arenas;
474 a->name = format (0, "default-numa-%u%c", numa_node, 0);
475 a->numa_node = numa_node;
476 a->log2_subpage_sz = pm->def_log2_page_sz;
477 a->subpages_per_page = 1;
480 a = pool_elt_at_index (pm->arenas,
481 pm->default_arena_for_numa_node[numa_node]);
483 else if (size > 1ULL << a->log2_subpage_sz)
486 n_blocks = round_pow2 (size, PMALLOC_BLOCK_SZ) / PMALLOC_BLOCK_SZ;
487 block_align = align >> PMALLOC_LOG2_BLOCK_SZ;
489 vec_foreach (page_index, a->page_indices)
491 pp = vec_elt_at_index (pm->pages, *page_index);
492 void *rv = alloc_chunk_from_page (pm, pp, n_blocks, block_align,
499 if ((a->flags & CLIB_PMALLOC_ARENA_F_SHARED_MEM) == 0 &&
500 (pp = pmalloc_map_pages (pm, a, numa_node, 1)))
501 return alloc_chunk_from_page (pm, pp, n_blocks, block_align, numa_node);
507 clib_pmalloc_alloc_aligned_on_numa (clib_pmalloc_main_t * pm, uword size,
508 uword align, u32 numa_node)
510 return clib_pmalloc_alloc_inline (pm, 0, size, align, numa_node);
514 clib_pmalloc_alloc_aligned (clib_pmalloc_main_t * pm, uword size, uword align)
516 return clib_pmalloc_alloc_inline (pm, 0, size, align,
517 CLIB_PMALLOC_NUMA_LOCAL);
521 clib_pmalloc_alloc_from_arena (clib_pmalloc_main_t * pm, void *arena_va,
522 uword size, uword align)
524 clib_pmalloc_arena_t *a = clib_pmalloc_get_arena (pm, arena_va);
525 return clib_pmalloc_alloc_inline (pm, a, size, align, 0);
529 pmalloc_chunks_mergeable (clib_pmalloc_arena_t * a, clib_pmalloc_page_t * pp,
532 clib_pmalloc_chunk_t *c1, *c2;
534 if (ci1 == ~0 || ci2 == ~0)
537 c1 = get_chunk (pp, ci1);
538 c2 = get_chunk (pp, ci2);
540 if (c1->used || c2->used)
543 if (c1->start >> (a->log2_subpage_sz - PMALLOC_LOG2_BLOCK_SZ) !=
544 c2->start >> (a->log2_subpage_sz - PMALLOC_LOG2_BLOCK_SZ))
551 clib_pmalloc_free (clib_pmalloc_main_t * pm, void *va)
553 clib_pmalloc_page_t *pp;
554 clib_pmalloc_chunk_t *c;
555 clib_pmalloc_arena_t *a;
557 u32 chunk_index, page_index;
559 p = hash_get (pm->chunk_index_by_va, pointer_to_uword (va));
565 page_index = clib_pmalloc_get_page_index (pm, va);
566 hash_unset (pm->chunk_index_by_va, pointer_to_uword (va));
568 pp = vec_elt_at_index (pm->pages, page_index);
569 c = pool_elt_at_index (pp->chunks, chunk_index);
570 a = pool_elt_at_index (pm->arenas, pp->arena_index);
572 pp->n_free_blocks += c->size;
575 /* merge with next if free */
576 if (pmalloc_chunks_mergeable (a, pp, chunk_index, c->next))
578 clib_pmalloc_chunk_t *next = get_chunk (pp, c->next);
579 c->size += next->size;
580 c->next = next->next;
581 if (next->next != ~0)
582 get_chunk (pp, next->next)->prev = chunk_index;
583 memset (next, 0, sizeof (*next));
584 pool_put (pp->chunks, next);
588 /* merge with prev if free */
589 if (pmalloc_chunks_mergeable (a, pp, c->prev, chunk_index))
591 clib_pmalloc_chunk_t *prev = get_chunk (pp, c->prev);
592 prev->size += c->size;
593 prev->next = c->next;
595 get_chunk (pp, c->next)->prev = c->prev;
596 memset (c, 0, sizeof (*c));
597 pool_put (pp->chunks, c);
603 format_log2_page_size (u8 * s, va_list * va)
605 u32 log2_page_sz = va_arg (*va, u32);
607 if (log2_page_sz >= 30)
608 return format (s, "%uGB", 1 << (log2_page_sz - 30));
610 if (log2_page_sz >= 20)
611 return format (s, "%uMB", 1 << (log2_page_sz - 20));
613 if (log2_page_sz >= 10)
614 return format (s, "%uKB", 1 << (log2_page_sz - 10));
616 return format (s, "%uB", 1 << log2_page_sz);
621 format_pmalloc_page (u8 * s, va_list * va)
623 clib_pmalloc_page_t *pp = va_arg (*va, clib_pmalloc_page_t *);
624 int verbose = va_arg (*va, int);
625 u32 indent = format_get_indent (s);
630 s = format (s, "free %u chunks %u free-chunks %d ",
631 (pp->n_free_blocks) << PMALLOC_LOG2_BLOCK_SZ,
632 pool_elts (pp->chunks), pp->n_free_chunks);
636 clib_pmalloc_chunk_t *c;
637 c = pool_elt_at_index (pp->chunks, pp->first_chunk_index);
638 s = format (s, "\n%U%12s%12s%8s%8s%8s%8s",
639 format_white_space, indent + 2,
640 "chunk offset", "size", "used", "index", "prev", "next");
643 s = format (s, "\n%U%12u%12u%8s%8d%8d%8d",
644 format_white_space, indent + 2,
645 c->start << PMALLOC_LOG2_BLOCK_SZ,
646 c->size << PMALLOC_LOG2_BLOCK_SZ,
647 c->used ? "yes" : "no",
648 c - pp->chunks, c->prev, c->next);
651 c = pool_elt_at_index (pp->chunks, c->next);
658 format_pmalloc (u8 * s, va_list * va)
660 clib_pmalloc_main_t *pm = va_arg (*va, clib_pmalloc_main_t *);
661 int verbose = va_arg (*va, int);
662 u32 indent = format_get_indent (s);
664 clib_pmalloc_page_t *pp;
665 clib_pmalloc_arena_t *a;
667 s = format (s, "used-pages %u reserved-pages %u default-page-size %U "
668 "lookup-page-size %U%s", vec_len (pm->pages), pm->max_pages,
669 format_log2_page_size, pm->def_log2_page_sz,
670 format_log2_page_size, pm->lookup_log2_page_sz,
671 pm->flags & CLIB_PMALLOC_F_NO_PAGEMAP ? " no-pagemap" : "");
675 s = format (s, " va-start %p", pm->base);
678 s = format (s, "\n%Ulast-error: %U", format_white_space, indent + 2,
679 format_clib_error, pm->error);
683 pool_foreach (a, pm->arenas,
686 s = format (s, "\n%Uarena '%s' pages %u subpage-size %U numa-node %u",
687 format_white_space, indent + 2, a->name,
688 vec_len (a->page_indices), format_log2_page_size,
689 a->log2_subpage_sz, a->numa_node);
691 s = format (s, " shared fd %d", a->fd);
693 vec_foreach (page_index, a->page_indices)
695 pp = vec_elt_at_index (pm->pages, *page_index);
696 s = format (s, "\n%U%U", format_white_space, indent + 4,
697 format_pmalloc_page, pp, verbose);
706 format_pmalloc_map (u8 * s, va_list * va)
708 clib_pmalloc_main_t *pm = va_arg (*va, clib_pmalloc_main_t *);
711 s = format (s, "%16s %13s %8s", "virtual-addr", "physical-addr", "size");
712 vec_foreach_index (index, pm->lookup_table)
714 uword *lookup_val, pa, va;
715 lookup_val = vec_elt_at_index (pm->lookup_table, index);
717 pointer_to_uword (pm->base) +
718 ((uword) index << pm->lookup_log2_page_sz);
719 pa = va - *lookup_val;
721 format (s, "\n %16p %13p %8U", uword_to_pointer (va, u64),
722 uword_to_pointer (pa, u64), format_log2_page_size,
723 pm->lookup_log2_page_sz);
729 * fd.io coding-style-patch-verification: ON
732 * eval: (c-set-style "gnu")