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>
24 #include <vppinfra/format.h>
26 #include <vppinfra/linux/sysfs.h>
28 #include <vppinfra/mem.h>
29 #include <vppinfra/hash.h>
30 #include <vppinfra/pmalloc.h>
31 #include <vppinfra/cpu.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 clib_pmalloc_init (clib_pmalloc_main_t * pm, uword base_addr, uword size)
57 ASSERT (pm->error == 0);
59 pagesize = clib_mem_get_default_hugepage_size ();
60 pm->def_log2_page_sz = min_log2 (pagesize);
61 pm->lookup_log2_page_sz = pm->def_log2_page_sz;
63 /* check if pagemap is accessible */
64 pt = clib_mem_vm_get_paddr (&pt, CLIB_MEM_PAGE_SZ_DEFAULT, 1);
65 if (pt == 0 || pt[0] == 0)
66 pm->flags |= CLIB_PMALLOC_F_NO_PAGEMAP;
68 size = size ? size : ((u64) DEFAULT_RESERVED_MB) << 20;
69 size = round_pow2 (size, pagesize);
71 pm->max_pages = size >> pm->def_log2_page_sz;
73 base = clib_mem_vm_reserve (base_addr, size, pm->def_log2_page_sz);
77 pm->error = clib_error_return (0, "failed to reserve %u pages",
82 pm->base = uword_to_pointer (base, void *);
87 alloc_chunk_from_page (clib_pmalloc_main_t * pm, clib_pmalloc_page_t * pp,
88 u32 n_blocks, u32 block_align, u32 numa_node)
90 clib_pmalloc_chunk_t *c = 0;
91 clib_pmalloc_arena_t *a;
94 u32 alloc_chunk_index;
96 a = pool_elt_at_index (pm->arenas, pp->arena_index);
100 u32 i, start = 0, prev = ~0;
102 for (i = 0; i < a->subpages_per_page; i++)
104 pool_get (pp->chunks, c);
107 c->size = pp->n_free_blocks / a->subpages_per_page;
110 pp->first_chunk_index = c - pp->chunks;
112 pp->chunks[prev].next = c - pp->chunks;
113 prev = c - pp->chunks;
116 pp->n_free_chunks = a->subpages_per_page;
119 if (pp->n_free_blocks < n_blocks)
122 alloc_chunk_index = pp->first_chunk_index;
125 c = pool_elt_at_index (pp->chunks, alloc_chunk_index);
126 off = (block_align - (c->start & (block_align - 1))) & (block_align - 1);
128 if (c->used || n_blocks + off > c->size)
132 alloc_chunk_index = c->next;
136 /* if alignment is needed create new empty chunk */
139 u32 offset_chunk_index;
140 clib_pmalloc_chunk_t *co;
141 pool_get (pp->chunks, c);
143 offset_chunk_index = alloc_chunk_index;
144 alloc_chunk_index = c - pp->chunks;
146 co = pool_elt_at_index (pp->chunks, offset_chunk_index);
147 c->size = co->size - off;
149 c->start = co->start + off;
150 c->prev = offset_chunk_index;
152 co->next = alloc_chunk_index;
156 if (c->size > n_blocks)
158 u32 tail_chunk_index;
159 clib_pmalloc_chunk_t *ct;
160 pool_get (pp->chunks, ct);
162 tail_chunk_index = ct - pp->chunks;
163 c = pool_elt_at_index (pp->chunks, alloc_chunk_index);
164 ct->size = c->size - n_blocks;
166 ct->prev = alloc_chunk_index;
167 ct->start = c->start + n_blocks;
170 c->next = tail_chunk_index;
172 pool_elt_at_index (pp->chunks, ct->next)->prev = tail_chunk_index;
174 else if (c->next != ~0)
175 pool_elt_at_index (pp->chunks, c->next)->prev = alloc_chunk_index;
177 c = get_chunk (pp, alloc_chunk_index);
178 va = pm->base + ((pp - pm->pages) << pm->def_log2_page_sz) +
179 (c->start << PMALLOC_LOG2_BLOCK_SZ);
180 hash_set (pm->chunk_index_by_va, pointer_to_uword (va), alloc_chunk_index);
181 pp->n_free_blocks -= n_blocks;
187 pmalloc_update_lookup_table (clib_pmalloc_main_t * pm, u32 first, u32 count)
189 uword seek, va, pa, p;
191 u32 elts_per_page = 1U << (pm->def_log2_page_sz - pm->lookup_log2_page_sz);
193 vec_validate_aligned (pm->lookup_table, vec_len (pm->pages) *
194 elts_per_page - 1, CLIB_CACHE_LINE_BYTES);
196 p = (uword) first *elts_per_page;
197 if (pm->flags & CLIB_PMALLOC_F_NO_PAGEMAP)
199 while (p < (uword) elts_per_page * count)
201 pm->lookup_table[p] = pointer_to_uword (pm->base) +
202 (p << pm->lookup_log2_page_sz);
208 fd = open ((char *) "/proc/self/pagemap", O_RDONLY);
209 while (p < (uword) elts_per_page * count)
211 va = pointer_to_uword (pm->base) + (p << pm->lookup_log2_page_sz);
213 seek = (va >> clib_mem_get_log2_page_size ()) * sizeof (pa);
214 if (fd != -1 && lseek (fd, seek, SEEK_SET) == seek &&
215 read (fd, &pa, sizeof (pa)) == (sizeof (pa)) &&
216 pa & (1ULL << 63) /* page present bit */ )
218 pa = (pa & pow2_mask (55)) << clib_mem_get_log2_page_size ();
220 pm->lookup_table[p] = va - pa;
228 static inline clib_pmalloc_page_t *
229 pmalloc_map_pages (clib_pmalloc_main_t * pm, clib_pmalloc_arena_t * a,
230 u32 numa_node, u32 n_pages)
232 clib_mem_page_stats_t stats = {};
233 clib_pmalloc_page_t *pp = 0;
234 int rv, i, mmap_flags;
235 void *va = MAP_FAILED;
236 uword size = (uword) n_pages << pm->def_log2_page_sz;
238 clib_error_free (pm->error);
240 if (pm->max_pages <= vec_len (pm->pages))
242 pm->error = clib_error_return (0, "maximum number of pages reached");
247 if (a->log2_subpage_sz != clib_mem_get_log2_page_size ())
249 pm->error = clib_sysfs_prealloc_hugepages (numa_node,
250 a->log2_subpage_sz, n_pages);
255 #endif /* __linux__ */
257 rv = clib_mem_set_numa_affinity (numa_node, /* force */ 1);
258 if (rv == CLIB_MEM_ERROR && numa_node != 0)
260 pm->error = clib_error_return_unix (0, "failed to set mempolicy for "
261 "numa node %u", numa_node);
265 mmap_flags = MAP_FIXED;
267 if (a->flags & CLIB_PMALLOC_ARENA_F_SHARED_MEM)
269 mmap_flags |= MAP_SHARED;
270 a->fd = clib_mem_vm_create_fd (a->log2_subpage_sz, "%s", a->name);
273 if ((ftruncate (a->fd, size)) == -1)
279 if (a->log2_subpage_sz != clib_mem_get_log2_page_size ())
280 mmap_flags |= MAP_HUGETLB;
281 #endif /* __linux__ */
283 mmap_flags |= MAP_PRIVATE | MAP_ANONYMOUS;
287 va = pm->base + (((uword) vec_len (pm->pages)) << pm->def_log2_page_sz);
288 if (mmap (va, size, PROT_READ | PROT_WRITE, mmap_flags, a->fd, 0) ==
291 pm->error = clib_error_return_unix (0, "failed to mmap %u pages at %p "
292 "fd %d numa %d flags 0x%x", n_pages,
293 va, a->fd, numa_node, mmap_flags);
298 if (a->log2_subpage_sz != clib_mem_get_log2_page_size () &&
299 mlock (va, size) != 0)
301 pm->error = clib_error_return_unix (0, "Unable to lock pages");
305 clib_memset (va, 0, size);
307 rv = clib_mem_set_default_numa_affinity ();
308 if (rv == CLIB_MEM_ERROR && numa_node != 0)
310 pm->error = clib_error_return_unix (0, "failed to restore mempolicy");
314 /* we tolerate move_pages failure only if request os for numa node 0
315 to support non-numa kernels */
316 clib_mem_get_page_stats (va, CLIB_MEM_PAGE_SZ_DEFAULT, 1, &stats);
318 if (stats.per_numa[numa_node] != 1 &&
319 !(numa_node == 0 && stats.unknown == 1))
321 u16 allocated_at = ~0;
323 clib_error_return (0,
324 "unable to get information about numa allocation");
326 for (u16 i = 0; i < CLIB_MAX_NUMAS; i++)
327 if (stats.per_numa[i] == 1)
330 clib_error_return (0,
331 "page allocated on the wrong numa node (%u), "
333 allocated_at, numa_node);
338 for (i = 0; i < n_pages; i++)
340 vec_add2 (pm->pages, pp, 1);
341 pp->n_free_blocks = 1 << (pm->def_log2_page_sz - PMALLOC_LOG2_BLOCK_SZ);
342 pp->index = pp - pm->pages;
343 pp->arena_index = a->index;
344 vec_add1 (a->page_indices, pp->index);
349 /* if new arena is using smaller page size, we need to rebuild whole
351 if (a->log2_subpage_sz < pm->lookup_log2_page_sz)
353 pm->lookup_log2_page_sz = a->log2_subpage_sz;
354 pmalloc_update_lookup_table (pm, vec_len (pm->pages) - n_pages,
358 pmalloc_update_lookup_table (pm, 0, vec_len (pm->pages));
360 /* return pointer to 1st page */
361 return pp - (n_pages - 1);
364 if (va != MAP_FAILED)
366 /* unmap & reserve */
368 mmap (va, size, PROT_NONE, MAP_FIXED | MAP_PRIVATE | MAP_ANONYMOUS,
377 clib_pmalloc_create_shared_arena (clib_pmalloc_main_t * pm, char *name,
378 uword size, u32 log2_page_sz, u32 numa_node)
380 clib_pmalloc_arena_t *a;
381 clib_pmalloc_page_t *pp;
384 clib_error_free (pm->error);
386 if (log2_page_sz == 0)
387 log2_page_sz = pm->def_log2_page_sz;
388 else if (log2_page_sz != pm->def_log2_page_sz &&
389 log2_page_sz != clib_mem_get_log2_page_size ())
391 pm->error = clib_error_create ("unsupported page size (%uKB)",
392 1 << (log2_page_sz - 10));
396 n_pages = pmalloc_size2pages (size, pm->def_log2_page_sz);
398 if (n_pages + vec_len (pm->pages) > pm->max_pages)
401 if (numa_node == CLIB_PMALLOC_NUMA_LOCAL)
402 numa_node = clib_get_current_numa_node ();
404 pool_get (pm->arenas, a);
405 a->index = a - pm->arenas;
406 a->name = format (0, "%s%c", name, 0);
407 a->numa_node = numa_node;
408 a->flags = CLIB_PMALLOC_ARENA_F_SHARED_MEM;
409 a->log2_subpage_sz = log2_page_sz;
410 a->subpages_per_page = 1U << (pm->def_log2_page_sz - log2_page_sz);
412 if ((pp = pmalloc_map_pages (pm, a, numa_node, n_pages)) == 0)
415 memset (a, 0, sizeof (*a));
416 pool_put (pm->arenas, a);
420 return pm->base + ((uword) pp->index << pm->def_log2_page_sz);
424 clib_pmalloc_alloc_inline (clib_pmalloc_main_t * pm, clib_pmalloc_arena_t * a,
425 uword size, uword align, u32 numa_node)
427 clib_pmalloc_page_t *pp;
428 u32 n_blocks, block_align, *page_index;
430 ASSERT (is_pow2 (align));
432 if (numa_node == CLIB_PMALLOC_NUMA_LOCAL)
433 numa_node = clib_get_current_numa_node ();
437 if (size > 1ULL << pm->def_log2_page_sz)
440 vec_validate_init_empty (pm->default_arena_for_numa_node,
442 if (pm->default_arena_for_numa_node[numa_node] == ~0)
444 pool_get (pm->arenas, a);
445 pm->default_arena_for_numa_node[numa_node] = a - pm->arenas;
446 a->name = format (0, "default-numa-%u%c", numa_node, 0);
447 a->numa_node = numa_node;
448 a->log2_subpage_sz = pm->def_log2_page_sz;
449 a->subpages_per_page = 1;
452 a = pool_elt_at_index (pm->arenas,
453 pm->default_arena_for_numa_node[numa_node]);
455 else if (size > 1ULL << a->log2_subpage_sz)
458 n_blocks = round_pow2 (size, PMALLOC_BLOCK_SZ) / PMALLOC_BLOCK_SZ;
459 block_align = align >> PMALLOC_LOG2_BLOCK_SZ;
461 vec_foreach (page_index, a->page_indices)
463 pp = vec_elt_at_index (pm->pages, *page_index);
464 void *rv = alloc_chunk_from_page (pm, pp, n_blocks, block_align,
471 if ((a->flags & CLIB_PMALLOC_ARENA_F_SHARED_MEM) == 0 &&
472 (pp = pmalloc_map_pages (pm, a, numa_node, 1)))
473 return alloc_chunk_from_page (pm, pp, n_blocks, block_align, numa_node);
479 clib_pmalloc_alloc_aligned_on_numa (clib_pmalloc_main_t * pm, uword size,
480 uword align, u32 numa_node)
482 return clib_pmalloc_alloc_inline (pm, 0, size, align, numa_node);
486 clib_pmalloc_alloc_aligned (clib_pmalloc_main_t *pm, uword size, uword align)
488 return clib_pmalloc_alloc_inline (pm, 0, size, align,
489 CLIB_PMALLOC_NUMA_LOCAL);
493 clib_pmalloc_alloc_from_arena (clib_pmalloc_main_t *pm, void *arena_va,
494 uword size, uword align)
496 clib_pmalloc_arena_t *a = clib_pmalloc_get_arena (pm, arena_va);
497 return clib_pmalloc_alloc_inline (pm, a, size, align, 0);
501 pmalloc_chunks_mergeable (clib_pmalloc_arena_t * a, clib_pmalloc_page_t * pp,
504 clib_pmalloc_chunk_t *c1, *c2;
506 if (ci1 == ~0 || ci2 == ~0)
509 c1 = get_chunk (pp, ci1);
510 c2 = get_chunk (pp, ci2);
512 if (c1->used || c2->used)
515 if (c1->start >> (a->log2_subpage_sz - PMALLOC_LOG2_BLOCK_SZ) !=
516 c2->start >> (a->log2_subpage_sz - PMALLOC_LOG2_BLOCK_SZ))
523 clib_pmalloc_free (clib_pmalloc_main_t * pm, void *va)
525 clib_pmalloc_page_t *pp;
526 clib_pmalloc_chunk_t *c;
527 clib_pmalloc_arena_t *a;
529 u32 chunk_index, page_index;
531 p = hash_get (pm->chunk_index_by_va, pointer_to_uword (va));
537 page_index = clib_pmalloc_get_page_index (pm, va);
538 hash_unset (pm->chunk_index_by_va, pointer_to_uword (va));
540 pp = vec_elt_at_index (pm->pages, page_index);
541 c = pool_elt_at_index (pp->chunks, chunk_index);
542 a = pool_elt_at_index (pm->arenas, pp->arena_index);
544 pp->n_free_blocks += c->size;
547 /* merge with next if free */
548 if (pmalloc_chunks_mergeable (a, pp, chunk_index, c->next))
550 clib_pmalloc_chunk_t *next = get_chunk (pp, c->next);
551 c->size += next->size;
552 c->next = next->next;
553 if (next->next != ~0)
554 get_chunk (pp, next->next)->prev = chunk_index;
555 memset (next, 0, sizeof (*next));
556 pool_put (pp->chunks, next);
560 /* merge with prev if free */
561 if (pmalloc_chunks_mergeable (a, pp, c->prev, chunk_index))
563 clib_pmalloc_chunk_t *prev = get_chunk (pp, c->prev);
564 prev->size += c->size;
565 prev->next = c->next;
567 get_chunk (pp, c->next)->prev = c->prev;
568 memset (c, 0, sizeof (*c));
569 pool_put (pp->chunks, c);
575 format_pmalloc_page (u8 * s, va_list * va)
577 clib_pmalloc_page_t *pp = va_arg (*va, clib_pmalloc_page_t *);
578 int verbose = va_arg (*va, int);
579 u32 indent = format_get_indent (s);
584 s = format (s, "free %u chunks %u free-chunks %d ",
585 (pp->n_free_blocks) << PMALLOC_LOG2_BLOCK_SZ,
586 pool_elts (pp->chunks), pp->n_free_chunks);
590 clib_pmalloc_chunk_t *c;
591 c = pool_elt_at_index (pp->chunks, pp->first_chunk_index);
592 s = format (s, "\n%U%12s%12s%8s%8s%8s%8s",
593 format_white_space, indent + 2,
594 "chunk offset", "size", "used", "index", "prev", "next");
597 s = format (s, "\n%U%12u%12u%8s%8d%8d%8d",
598 format_white_space, indent + 2,
599 c->start << PMALLOC_LOG2_BLOCK_SZ,
600 c->size << PMALLOC_LOG2_BLOCK_SZ,
601 c->used ? "yes" : "no",
602 c - pp->chunks, c->prev, c->next);
605 c = pool_elt_at_index (pp->chunks, c->next);
612 format_pmalloc (u8 * s, va_list * va)
614 clib_pmalloc_main_t *pm = va_arg (*va, clib_pmalloc_main_t *);
615 int verbose = va_arg (*va, int);
616 u32 indent = format_get_indent (s);
618 clib_pmalloc_page_t *pp;
619 clib_pmalloc_arena_t *a;
621 s = format (s, "used-pages %u reserved-pages %u default-page-size %U "
622 "lookup-page-size %U%s", vec_len (pm->pages), pm->max_pages,
623 format_log2_page_size, pm->def_log2_page_sz,
624 format_log2_page_size, pm->lookup_log2_page_sz,
625 pm->flags & CLIB_PMALLOC_F_NO_PAGEMAP ? " no-pagemap" : "");
629 s = format (s, " va-start %p", pm->base);
632 s = format (s, "\n%Ulast-error: %U", format_white_space, indent + 2,
633 format_clib_error, pm->error);
636 pool_foreach (a, pm->arenas)
639 s = format (s, "\n%Uarena '%s' pages %u subpage-size %U numa-node %u",
640 format_white_space, indent + 2, a->name,
641 vec_len (a->page_indices), format_log2_page_size,
642 a->log2_subpage_sz, a->numa_node);
644 s = format (s, " shared fd %d", a->fd);
646 vec_foreach (page_index, a->page_indices)
648 pp = vec_elt_at_index (pm->pages, *page_index);
649 s = format (s, "\n%U%U", format_white_space, indent + 4,
650 format_pmalloc_page, pp, verbose);
658 format_pmalloc_map (u8 * s, va_list * va)
660 clib_pmalloc_main_t *pm = va_arg (*va, clib_pmalloc_main_t *);
663 s = format (s, "%16s %13s %8s", "virtual-addr", "physical-addr", "size");
664 vec_foreach_index (index, pm->lookup_table)
666 uword *lookup_val, pa, va;
667 lookup_val = vec_elt_at_index (pm->lookup_table, index);
669 pointer_to_uword (pm->base) +
670 ((uword) index << pm->lookup_log2_page_sz);
671 pa = va - *lookup_val;
673 format (s, "\n %16p %13p %8U", uword_to_pointer (va, u64),
674 uword_to_pointer (pa, u64), format_log2_page_size,
675 pm->lookup_log2_page_sz);
681 * fd.io coding-style-patch-verification: ON
684 * eval: (c-set-style "gnu")