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 <sys/memrange.h>
22 #endif /* __FreeBSD__ */
27 #include <vppinfra/format.h>
29 #include <vppinfra/linux/sysfs.h>
31 #include <vppinfra/mem.h>
32 #include <vppinfra/hash.h>
33 #include <vppinfra/pmalloc.h>
34 #include <vppinfra/cpu.h>
36 #if __SIZEOF_POINTER__ >= 8
37 #define DEFAULT_RESERVED_MB 16384
39 #define DEFAULT_RESERVED_MB 256
42 static inline clib_pmalloc_chunk_t *
43 get_chunk (clib_pmalloc_page_t * pp, u32 index)
45 return pool_elt_at_index (pp->chunks, index);
49 pmalloc_size2pages (uword size, u32 log2_page_sz)
51 return round_pow2 (size, 1ULL << log2_page_sz) >> log2_page_sz;
55 clib_pmalloc_init (clib_pmalloc_main_t * pm, uword base_addr, uword size)
60 ASSERT (pm->error == 0);
62 pagesize = clib_mem_get_default_hugepage_size ();
63 pm->def_log2_page_sz = min_log2 (pagesize);
64 pm->lookup_log2_page_sz = pm->def_log2_page_sz;
66 /* check if pagemap is accessible */
67 pt = clib_mem_vm_get_paddr (&pt, CLIB_MEM_PAGE_SZ_DEFAULT, 1);
68 if (pt == 0 || pt[0] == 0)
69 pm->flags |= CLIB_PMALLOC_F_NO_PAGEMAP;
71 size = size ? size : ((u64) DEFAULT_RESERVED_MB) << 20;
72 size = round_pow2 (size, pagesize);
74 pm->max_pages = size >> pm->def_log2_page_sz;
76 base = clib_mem_vm_reserve (base_addr, size, pm->def_log2_page_sz);
80 pm->error = clib_error_return (0, "failed to reserve %u pages",
85 pm->base = uword_to_pointer (base, void *);
90 alloc_chunk_from_page (clib_pmalloc_main_t * pm, clib_pmalloc_page_t * pp,
91 u32 n_blocks, u32 block_align, u32 numa_node)
93 clib_pmalloc_chunk_t *c = 0;
94 clib_pmalloc_arena_t *a;
97 u32 alloc_chunk_index;
99 a = pool_elt_at_index (pm->arenas, pp->arena_index);
103 u32 i, start = 0, prev = ~0;
105 for (i = 0; i < a->subpages_per_page; i++)
107 pool_get (pp->chunks, c);
110 c->size = pp->n_free_blocks / a->subpages_per_page;
113 pp->first_chunk_index = c - pp->chunks;
115 pp->chunks[prev].next = c - pp->chunks;
116 prev = c - pp->chunks;
119 pp->n_free_chunks = a->subpages_per_page;
122 if (pp->n_free_blocks < n_blocks)
125 alloc_chunk_index = pp->first_chunk_index;
128 c = pool_elt_at_index (pp->chunks, alloc_chunk_index);
129 off = (block_align - (c->start & (block_align - 1))) & (block_align - 1);
131 if (c->used || n_blocks + off > c->size)
135 alloc_chunk_index = c->next;
139 /* if alignment is needed create new empty chunk */
142 u32 offset_chunk_index;
143 clib_pmalloc_chunk_t *co;
144 pool_get (pp->chunks, c);
146 offset_chunk_index = alloc_chunk_index;
147 alloc_chunk_index = c - pp->chunks;
149 co = pool_elt_at_index (pp->chunks, offset_chunk_index);
150 c->size = co->size - off;
152 c->start = co->start + off;
153 c->prev = offset_chunk_index;
155 co->next = alloc_chunk_index;
159 if (c->size > n_blocks)
161 u32 tail_chunk_index;
162 clib_pmalloc_chunk_t *ct;
163 pool_get (pp->chunks, ct);
165 tail_chunk_index = ct - pp->chunks;
166 c = pool_elt_at_index (pp->chunks, alloc_chunk_index);
167 ct->size = c->size - n_blocks;
169 ct->prev = alloc_chunk_index;
170 ct->start = c->start + n_blocks;
173 c->next = tail_chunk_index;
175 pool_elt_at_index (pp->chunks, ct->next)->prev = tail_chunk_index;
177 else if (c->next != ~0)
178 pool_elt_at_index (pp->chunks, c->next)->prev = alloc_chunk_index;
180 c = get_chunk (pp, alloc_chunk_index);
181 va = pm->base + ((pp - pm->pages) << pm->def_log2_page_sz) +
182 (c->start << PMALLOC_LOG2_BLOCK_SZ);
183 hash_set (pm->chunk_index_by_va, pointer_to_uword (va), alloc_chunk_index);
184 pp->n_free_blocks -= n_blocks;
190 pmalloc_update_lookup_table (clib_pmalloc_main_t *pm, u32 first, u32 count)
193 uword seek, va, pa, p;
195 u32 elts_per_page = 1U << (pm->def_log2_page_sz - pm->lookup_log2_page_sz);
197 vec_validate_aligned (pm->lookup_table, vec_len (pm->pages) *
198 elts_per_page - 1, CLIB_CACHE_LINE_BYTES);
200 p = (uword) first *elts_per_page;
201 if (pm->flags & CLIB_PMALLOC_F_NO_PAGEMAP)
203 while (p < (uword) elts_per_page * count)
205 pm->lookup_table[p] = pointer_to_uword (pm->base) +
206 (p << pm->lookup_log2_page_sz);
212 fd = open ((char *) "/proc/self/pagemap", O_RDONLY);
213 while (p < (uword) elts_per_page * count)
215 va = pointer_to_uword (pm->base) + (p << pm->lookup_log2_page_sz);
217 seek = (va >> clib_mem_get_log2_page_size ()) * sizeof (pa);
218 if (fd != -1 && lseek (fd, seek, SEEK_SET) == seek &&
219 read (fd, &pa, sizeof (pa)) == (sizeof (pa)) &&
220 pa & (1ULL << 63) /* page present bit */ )
222 pa = (pa & pow2_mask (55)) << clib_mem_get_log2_page_size ();
224 pm->lookup_table[p] = va - pa;
230 #elif defined(__FreeBSD__)
231 struct mem_extract meme;
234 u32 elts_per_page = 1U << (pm->def_log2_page_sz - pm->lookup_log2_page_sz);
236 vec_validate_aligned (pm->lookup_table,
237 vec_len (pm->pages) * elts_per_page - 1,
238 CLIB_CACHE_LINE_BYTES);
240 p = (uword) first * elts_per_page;
241 if (pm->flags & CLIB_PMALLOC_F_NO_PAGEMAP)
243 while (p < (uword) elts_per_page * count)
245 pm->lookup_table[p] =
246 pointer_to_uword (pm->base) + (p << pm->lookup_log2_page_sz);
252 fd = open ((char *) "/dev/mem", O_RDONLY);
256 while (p < (uword) elts_per_page * count)
259 pointer_to_uword (pm->base) + (p << pm->lookup_log2_page_sz);
260 if (ioctl (fd, MEM_EXTRACT_PADDR, &meme) == -1)
262 pm->lookup_table[p] = meme.me_vaddr - meme.me_paddr;
267 #error "Unsupported OS"
271 static inline clib_pmalloc_page_t *
272 pmalloc_map_pages (clib_pmalloc_main_t * pm, clib_pmalloc_arena_t * a,
273 u32 numa_node, u32 n_pages)
275 clib_mem_page_stats_t stats = {};
276 clib_pmalloc_page_t *pp = 0;
277 int rv, i, mmap_flags;
278 void *va = MAP_FAILED;
279 uword size = (uword) n_pages << pm->def_log2_page_sz;
281 clib_error_free (pm->error);
283 if (pm->max_pages <= vec_len (pm->pages))
285 pm->error = clib_error_return (0, "maximum number of pages reached");
290 if (a->log2_subpage_sz != clib_mem_get_log2_page_size ())
292 pm->error = clib_sysfs_prealloc_hugepages (numa_node,
293 a->log2_subpage_sz, n_pages);
298 #endif /* __linux__ */
300 rv = clib_mem_set_numa_affinity (numa_node, /* force */ 1);
301 if (rv == CLIB_MEM_ERROR && numa_node != 0)
303 pm->error = clib_error_return_unix (0, "failed to set mempolicy for "
304 "numa node %u", numa_node);
308 mmap_flags = MAP_FIXED;
310 if (a->flags & CLIB_PMALLOC_ARENA_F_SHARED_MEM)
312 mmap_flags |= MAP_SHARED;
313 a->fd = clib_mem_vm_create_fd (a->log2_subpage_sz, "%s", a->name);
316 if ((ftruncate (a->fd, size)) == -1)
322 if (a->log2_subpage_sz != clib_mem_get_log2_page_size ())
323 mmap_flags |= MAP_HUGETLB;
324 #endif /* __linux__ */
326 mmap_flags |= MAP_PRIVATE | MAP_ANONYMOUS;
330 va = pm->base + (((uword) vec_len (pm->pages)) << pm->def_log2_page_sz);
331 if (mmap (va, size, PROT_READ | PROT_WRITE, mmap_flags, a->fd, 0) ==
334 pm->error = clib_error_return_unix (0, "failed to mmap %u pages at %p "
335 "fd %d numa %d flags 0x%x", n_pages,
336 va, a->fd, numa_node, mmap_flags);
341 if (a->log2_subpage_sz != clib_mem_get_log2_page_size () &&
342 mlock (va, size) != 0)
344 pm->error = clib_error_return_unix (0, "Unable to lock pages");
348 clib_memset (va, 0, size);
350 rv = clib_mem_set_default_numa_affinity ();
351 if (rv == CLIB_MEM_ERROR && numa_node != 0)
353 pm->error = clib_error_return_unix (0, "failed to restore mempolicy");
357 /* we tolerate move_pages failure only if request os for numa node 0
358 to support non-numa kernels */
359 clib_mem_get_page_stats (va, CLIB_MEM_PAGE_SZ_DEFAULT, 1, &stats);
361 if (stats.per_numa[numa_node] != 1 &&
362 !(numa_node == 0 && stats.unknown == 1))
364 u16 allocated_at = ~0;
366 clib_error_return (0,
367 "unable to get information about numa allocation");
369 for (u16 i = 0; i < CLIB_MAX_NUMAS; i++)
370 if (stats.per_numa[i] == 1)
373 clib_error_return (0,
374 "page allocated on the wrong numa node (%u), "
376 allocated_at, numa_node);
381 for (i = 0; i < n_pages; i++)
383 vec_add2 (pm->pages, pp, 1);
384 pp->n_free_blocks = 1 << (pm->def_log2_page_sz - PMALLOC_LOG2_BLOCK_SZ);
385 pp->index = pp - pm->pages;
386 pp->arena_index = a->index;
387 vec_add1 (a->page_indices, pp->index);
392 /* if new arena is using smaller page size, we need to rebuild whole
394 if (a->log2_subpage_sz < pm->lookup_log2_page_sz)
396 pm->lookup_log2_page_sz = a->log2_subpage_sz;
397 pmalloc_update_lookup_table (pm, vec_len (pm->pages) - n_pages,
401 pmalloc_update_lookup_table (pm, 0, vec_len (pm->pages));
403 /* return pointer to 1st page */
404 return pp - (n_pages - 1);
407 if (va != MAP_FAILED)
409 /* unmap & reserve */
411 mmap (va, size, PROT_NONE, MAP_FIXED | MAP_PRIVATE | MAP_ANONYMOUS,
420 clib_pmalloc_create_shared_arena (clib_pmalloc_main_t * pm, char *name,
421 uword size, u32 log2_page_sz, u32 numa_node)
423 clib_pmalloc_arena_t *a;
424 clib_pmalloc_page_t *pp;
427 clib_error_free (pm->error);
429 if (log2_page_sz == 0)
430 log2_page_sz = pm->def_log2_page_sz;
431 else if (log2_page_sz != pm->def_log2_page_sz &&
432 log2_page_sz != clib_mem_get_log2_page_size ())
434 pm->error = clib_error_create ("unsupported page size (%uKB)",
435 1 << (log2_page_sz - 10));
439 n_pages = pmalloc_size2pages (size, pm->def_log2_page_sz);
441 if (n_pages + vec_len (pm->pages) > pm->max_pages)
444 if (numa_node == CLIB_PMALLOC_NUMA_LOCAL)
445 numa_node = clib_get_current_numa_node ();
447 pool_get (pm->arenas, a);
448 a->index = a - pm->arenas;
449 a->name = format (0, "%s%c", name, 0);
450 a->numa_node = numa_node;
451 a->flags = CLIB_PMALLOC_ARENA_F_SHARED_MEM;
452 a->log2_subpage_sz = log2_page_sz;
453 a->subpages_per_page = 1U << (pm->def_log2_page_sz - log2_page_sz);
455 if ((pp = pmalloc_map_pages (pm, a, numa_node, n_pages)) == 0)
458 memset (a, 0, sizeof (*a));
459 pool_put (pm->arenas, a);
463 return pm->base + ((uword) pp->index << pm->def_log2_page_sz);
467 clib_pmalloc_alloc_inline (clib_pmalloc_main_t * pm, clib_pmalloc_arena_t * a,
468 uword size, uword align, u32 numa_node)
470 clib_pmalloc_page_t *pp;
471 u32 n_blocks, block_align, *page_index;
473 ASSERT (is_pow2 (align));
475 if (numa_node == CLIB_PMALLOC_NUMA_LOCAL)
476 numa_node = clib_get_current_numa_node ();
480 if (size > 1ULL << pm->def_log2_page_sz)
483 vec_validate_init_empty (pm->default_arena_for_numa_node,
485 if (pm->default_arena_for_numa_node[numa_node] == ~0)
487 pool_get (pm->arenas, a);
488 pm->default_arena_for_numa_node[numa_node] = a - pm->arenas;
489 a->name = format (0, "default-numa-%u%c", numa_node, 0);
490 a->numa_node = numa_node;
491 a->log2_subpage_sz = pm->def_log2_page_sz;
492 a->subpages_per_page = 1;
495 a = pool_elt_at_index (pm->arenas,
496 pm->default_arena_for_numa_node[numa_node]);
498 else if (size > 1ULL << a->log2_subpage_sz)
501 n_blocks = round_pow2 (size, PMALLOC_BLOCK_SZ) / PMALLOC_BLOCK_SZ;
502 block_align = align >> PMALLOC_LOG2_BLOCK_SZ;
504 vec_foreach (page_index, a->page_indices)
506 pp = vec_elt_at_index (pm->pages, *page_index);
507 void *rv = alloc_chunk_from_page (pm, pp, n_blocks, block_align,
514 if ((a->flags & CLIB_PMALLOC_ARENA_F_SHARED_MEM) == 0 &&
515 (pp = pmalloc_map_pages (pm, a, numa_node, 1)))
516 return alloc_chunk_from_page (pm, pp, n_blocks, block_align, numa_node);
522 clib_pmalloc_alloc_aligned_on_numa (clib_pmalloc_main_t * pm, uword size,
523 uword align, u32 numa_node)
525 return clib_pmalloc_alloc_inline (pm, 0, size, align, numa_node);
529 clib_pmalloc_alloc_aligned (clib_pmalloc_main_t *pm, uword size, uword align)
531 return clib_pmalloc_alloc_inline (pm, 0, size, align,
532 CLIB_PMALLOC_NUMA_LOCAL);
536 clib_pmalloc_alloc_from_arena (clib_pmalloc_main_t *pm, void *arena_va,
537 uword size, uword align)
539 clib_pmalloc_arena_t *a = clib_pmalloc_get_arena (pm, arena_va);
540 return clib_pmalloc_alloc_inline (pm, a, size, align, 0);
544 pmalloc_chunks_mergeable (clib_pmalloc_arena_t * a, clib_pmalloc_page_t * pp,
547 clib_pmalloc_chunk_t *c1, *c2;
549 if (ci1 == ~0 || ci2 == ~0)
552 c1 = get_chunk (pp, ci1);
553 c2 = get_chunk (pp, ci2);
555 if (c1->used || c2->used)
558 if (c1->start >> (a->log2_subpage_sz - PMALLOC_LOG2_BLOCK_SZ) !=
559 c2->start >> (a->log2_subpage_sz - PMALLOC_LOG2_BLOCK_SZ))
566 clib_pmalloc_free (clib_pmalloc_main_t * pm, void *va)
568 clib_pmalloc_page_t *pp;
569 clib_pmalloc_chunk_t *c;
570 clib_pmalloc_arena_t *a;
572 u32 chunk_index, page_index;
574 p = hash_get (pm->chunk_index_by_va, pointer_to_uword (va));
580 page_index = clib_pmalloc_get_page_index (pm, va);
581 hash_unset (pm->chunk_index_by_va, pointer_to_uword (va));
583 pp = vec_elt_at_index (pm->pages, page_index);
584 c = pool_elt_at_index (pp->chunks, chunk_index);
585 a = pool_elt_at_index (pm->arenas, pp->arena_index);
587 pp->n_free_blocks += c->size;
590 /* merge with next if free */
591 if (pmalloc_chunks_mergeable (a, pp, chunk_index, c->next))
593 clib_pmalloc_chunk_t *next = get_chunk (pp, c->next);
594 c->size += next->size;
595 c->next = next->next;
596 if (next->next != ~0)
597 get_chunk (pp, next->next)->prev = chunk_index;
598 memset (next, 0, sizeof (*next));
599 pool_put (pp->chunks, next);
603 /* merge with prev if free */
604 if (pmalloc_chunks_mergeable (a, pp, c->prev, chunk_index))
606 clib_pmalloc_chunk_t *prev = get_chunk (pp, c->prev);
607 prev->size += c->size;
608 prev->next = c->next;
610 get_chunk (pp, c->next)->prev = c->prev;
611 memset (c, 0, sizeof (*c));
612 pool_put (pp->chunks, c);
618 format_pmalloc_page (u8 * s, va_list * va)
620 clib_pmalloc_page_t *pp = va_arg (*va, clib_pmalloc_page_t *);
621 int verbose = va_arg (*va, int);
622 u32 indent = format_get_indent (s);
627 s = format (s, "free %u chunks %u free-chunks %d ",
628 (pp->n_free_blocks) << PMALLOC_LOG2_BLOCK_SZ,
629 pool_elts (pp->chunks), pp->n_free_chunks);
633 clib_pmalloc_chunk_t *c;
634 c = pool_elt_at_index (pp->chunks, pp->first_chunk_index);
635 s = format (s, "\n%U%12s%12s%8s%8s%8s%8s",
636 format_white_space, indent + 2,
637 "chunk offset", "size", "used", "index", "prev", "next");
640 s = format (s, "\n%U%12u%12u%8s%8d%8d%8d",
641 format_white_space, indent + 2,
642 c->start << PMALLOC_LOG2_BLOCK_SZ,
643 c->size << PMALLOC_LOG2_BLOCK_SZ,
644 c->used ? "yes" : "no",
645 c - pp->chunks, c->prev, c->next);
648 c = pool_elt_at_index (pp->chunks, c->next);
655 format_pmalloc (u8 * s, va_list * va)
657 clib_pmalloc_main_t *pm = va_arg (*va, clib_pmalloc_main_t *);
658 int verbose = va_arg (*va, int);
659 u32 indent = format_get_indent (s);
661 clib_pmalloc_page_t *pp;
662 clib_pmalloc_arena_t *a;
664 s = format (s, "used-pages %u reserved-pages %u default-page-size %U "
665 "lookup-page-size %U%s", vec_len (pm->pages), pm->max_pages,
666 format_log2_page_size, pm->def_log2_page_sz,
667 format_log2_page_size, pm->lookup_log2_page_sz,
668 pm->flags & CLIB_PMALLOC_F_NO_PAGEMAP ? " no-pagemap" : "");
672 s = format (s, " va-start %p", pm->base);
675 s = format (s, "\n%Ulast-error: %U", format_white_space, indent + 2,
676 format_clib_error, pm->error);
679 pool_foreach (a, pm->arenas)
682 s = format (s, "\n%Uarena '%s' pages %u subpage-size %U numa-node %u",
683 format_white_space, indent + 2, a->name,
684 vec_len (a->page_indices), format_log2_page_size,
685 a->log2_subpage_sz, a->numa_node);
687 s = format (s, " shared fd %d", a->fd);
689 vec_foreach (page_index, a->page_indices)
691 pp = vec_elt_at_index (pm->pages, *page_index);
692 s = format (s, "\n%U%U", format_white_space, indent + 4,
693 format_pmalloc_page, pp, verbose);
701 format_pmalloc_map (u8 * s, va_list * va)
703 clib_pmalloc_main_t *pm = va_arg (*va, clib_pmalloc_main_t *);
706 s = format (s, "%16s %13s %8s", "virtual-addr", "physical-addr", "size");
707 vec_foreach_index (index, pm->lookup_table)
709 uword *lookup_val, pa, va;
710 lookup_val = vec_elt_at_index (pm->lookup_table, index);
712 pointer_to_uword (pm->base) +
713 ((uword) index << pm->lookup_log2_page_sz);
714 pa = va - *lookup_val;
716 format (s, "\n %16p %13p %8U", uword_to_pointer (va, u64),
717 uword_to_pointer (pa, u64), format_log2_page_size,
718 pm->lookup_log2_page_sz);
724 * fd.io coding-style-patch-verification: ON
727 * eval: (c-set-style "gnu")