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>
25 #include <vppinfra/linux/sysfs.h>
26 #include <vppinfra/mem.h>
27 #include <vppinfra/hash.h>
28 #include <vppinfra/pmalloc.h>
29 #include <vppinfra/cpu.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 clib_pmalloc_init (clib_pmalloc_main_t * pm, uword base_addr, uword size)
55 ASSERT (pm->error == 0);
57 pagesize = clib_mem_get_default_hugepage_size ();
58 pm->def_log2_page_sz = min_log2 (pagesize);
59 pm->lookup_log2_page_sz = pm->def_log2_page_sz;
61 /* check if pagemap is accessible */
62 pt = clib_mem_vm_get_paddr (&pt, CLIB_MEM_PAGE_SZ_DEFAULT, 1);
63 if (pt == 0 || pt[0] == 0)
64 pm->flags |= CLIB_PMALLOC_F_NO_PAGEMAP;
66 size = size ? size : ((u64) DEFAULT_RESERVED_MB) << 20;
67 size = round_pow2 (size, pagesize);
69 pm->max_pages = size >> pm->def_log2_page_sz;
71 base = clib_mem_vm_reserve (base_addr, size, pm->def_log2_page_sz);
75 pm->error = clib_error_return (0, "failed to reserve %u pages",
80 pm->base = uword_to_pointer (base, void *);
85 alloc_chunk_from_page (clib_pmalloc_main_t * pm, clib_pmalloc_page_t * pp,
86 u32 n_blocks, u32 block_align, u32 numa_node)
88 clib_pmalloc_chunk_t *c = 0;
89 clib_pmalloc_arena_t *a;
92 u32 alloc_chunk_index;
94 a = pool_elt_at_index (pm->arenas, pp->arena_index);
98 u32 i, start = 0, prev = ~0;
100 for (i = 0; i < a->subpages_per_page; i++)
102 pool_get (pp->chunks, c);
105 c->size = pp->n_free_blocks / a->subpages_per_page;
108 pp->first_chunk_index = c - pp->chunks;
110 pp->chunks[prev].next = c - pp->chunks;
111 prev = c - pp->chunks;
114 pp->n_free_chunks = a->subpages_per_page;
117 if (pp->n_free_blocks < n_blocks)
120 alloc_chunk_index = pp->first_chunk_index;
123 c = pool_elt_at_index (pp->chunks, alloc_chunk_index);
124 off = (block_align - (c->start & (block_align - 1))) & (block_align - 1);
126 if (c->used || n_blocks + off > c->size)
130 alloc_chunk_index = c->next;
134 /* if alignment is needed create new empty chunk */
137 u32 offset_chunk_index;
138 clib_pmalloc_chunk_t *co;
139 pool_get (pp->chunks, c);
141 offset_chunk_index = alloc_chunk_index;
142 alloc_chunk_index = c - pp->chunks;
144 co = pool_elt_at_index (pp->chunks, offset_chunk_index);
145 c->size = co->size - off;
147 c->start = co->start + off;
148 c->prev = offset_chunk_index;
150 co->next = alloc_chunk_index;
154 if (c->size > n_blocks)
156 u32 tail_chunk_index;
157 clib_pmalloc_chunk_t *ct;
158 pool_get (pp->chunks, ct);
160 tail_chunk_index = ct - pp->chunks;
161 c = pool_elt_at_index (pp->chunks, alloc_chunk_index);
162 ct->size = c->size - n_blocks;
164 ct->prev = alloc_chunk_index;
165 ct->start = c->start + n_blocks;
168 c->next = tail_chunk_index;
170 pool_elt_at_index (pp->chunks, ct->next)->prev = tail_chunk_index;
172 else if (c->next != ~0)
173 pool_elt_at_index (pp->chunks, c->next)->prev = alloc_chunk_index;
175 c = get_chunk (pp, alloc_chunk_index);
176 va = pm->base + ((pp - pm->pages) << pm->def_log2_page_sz) +
177 (c->start << PMALLOC_LOG2_BLOCK_SZ);
178 hash_set (pm->chunk_index_by_va, pointer_to_uword (va), alloc_chunk_index);
179 pp->n_free_blocks -= n_blocks;
185 pmalloc_update_lookup_table (clib_pmalloc_main_t * pm, u32 first, u32 count)
187 uword seek, va, pa, p;
189 u32 elts_per_page = 1U << (pm->def_log2_page_sz - pm->lookup_log2_page_sz);
191 vec_validate_aligned (pm->lookup_table, vec_len (pm->pages) *
192 elts_per_page - 1, CLIB_CACHE_LINE_BYTES);
194 p = (uword) first *elts_per_page;
195 if (pm->flags & CLIB_PMALLOC_F_NO_PAGEMAP)
197 while (p < (uword) elts_per_page * count)
199 pm->lookup_table[p] = pointer_to_uword (pm->base) +
200 (p << pm->lookup_log2_page_sz);
206 fd = open ((char *) "/proc/self/pagemap", O_RDONLY);
207 while (p < (uword) elts_per_page * count)
209 va = pointer_to_uword (pm->base) + (p << pm->lookup_log2_page_sz);
211 seek = (va >> clib_mem_get_log2_page_size ()) * sizeof (pa);
212 if (fd != -1 && lseek (fd, seek, SEEK_SET) == seek &&
213 read (fd, &pa, sizeof (pa)) == (sizeof (pa)) &&
214 pa & (1ULL << 63) /* page present bit */ )
216 pa = (pa & pow2_mask (55)) << clib_mem_get_log2_page_size ();
218 pm->lookup_table[p] = va - pa;
226 static inline clib_pmalloc_page_t *
227 pmalloc_map_pages (clib_pmalloc_main_t * pm, clib_pmalloc_arena_t * a,
228 u32 numa_node, u32 n_pages)
230 clib_mem_page_stats_t stats = {};
231 clib_pmalloc_page_t *pp = 0;
232 int rv, i, mmap_flags;
233 void *va = MAP_FAILED;
234 uword size = (uword) n_pages << pm->def_log2_page_sz;
236 clib_error_free (pm->error);
238 if (pm->max_pages <= vec_len (pm->pages))
240 pm->error = clib_error_return (0, "maximum number of pages reached");
245 if (a->log2_subpage_sz != clib_mem_get_log2_page_size ())
247 pm->error = clib_sysfs_prealloc_hugepages (numa_node,
248 a->log2_subpage_sz, n_pages);
253 #endif /* __linux__ */
255 rv = clib_mem_set_numa_affinity (numa_node, /* force */ 1);
256 if (rv == CLIB_MEM_ERROR && numa_node != 0)
258 pm->error = clib_error_return_unix (0, "failed to set mempolicy for "
259 "numa node %u", numa_node);
263 mmap_flags = MAP_FIXED;
265 if (a->flags & CLIB_PMALLOC_ARENA_F_SHARED_MEM)
267 mmap_flags |= MAP_SHARED;
268 a->fd = clib_mem_vm_create_fd (a->log2_subpage_sz, "%s", a->name);
271 if ((ftruncate (a->fd, size)) == -1)
277 if (a->log2_subpage_sz != clib_mem_get_log2_page_size ())
278 mmap_flags |= MAP_HUGETLB;
279 #endif /* __linux__ */
281 mmap_flags |= MAP_PRIVATE | MAP_ANONYMOUS;
285 va = pm->base + (((uword) vec_len (pm->pages)) << pm->def_log2_page_sz);
286 if (mmap (va, size, PROT_READ | PROT_WRITE, mmap_flags, a->fd, 0) ==
289 pm->error = clib_error_return_unix (0, "failed to mmap %u pages at %p "
290 "fd %d numa %d flags 0x%x", n_pages,
291 va, a->fd, numa_node, mmap_flags);
296 if (a->log2_subpage_sz != clib_mem_get_log2_page_size () &&
297 mlock (va, size) != 0)
299 pm->error = clib_error_return_unix (0, "Unable to lock pages");
303 clib_memset (va, 0, size);
305 rv = clib_mem_set_default_numa_affinity ();
306 if (rv == CLIB_MEM_ERROR && numa_node != 0)
308 pm->error = clib_error_return_unix (0, "failed to restore mempolicy");
312 /* we tolerate move_pages failure only if request os for numa node 0
313 to support non-numa kernels */
314 clib_mem_get_page_stats (va, CLIB_MEM_PAGE_SZ_DEFAULT, 1, &stats);
316 if (stats.per_numa[numa_node] != 1 &&
317 !(numa_node == 0 && stats.unknown == 1))
319 u16 allocated_at = ~0;
321 clib_error_return (0,
322 "unable to get information about numa allocation");
324 for (u16 i = 0; i < CLIB_MAX_NUMAS; i++)
325 if (stats.per_numa[i] == 1)
328 clib_error_return (0,
329 "page allocated on the wrong numa node (%u), "
331 allocated_at, numa_node);
336 for (i = 0; i < n_pages; i++)
338 vec_add2 (pm->pages, pp, 1);
339 pp->n_free_blocks = 1 << (pm->def_log2_page_sz - PMALLOC_LOG2_BLOCK_SZ);
340 pp->index = pp - pm->pages;
341 pp->arena_index = a->index;
342 vec_add1 (a->page_indices, pp->index);
347 /* if new arena is using smaller page size, we need to rebuild whole
349 if (a->log2_subpage_sz < pm->lookup_log2_page_sz)
351 pm->lookup_log2_page_sz = a->log2_subpage_sz;
352 pmalloc_update_lookup_table (pm, vec_len (pm->pages) - n_pages,
356 pmalloc_update_lookup_table (pm, 0, vec_len (pm->pages));
358 /* return pointer to 1st page */
359 return pp - (n_pages - 1);
362 if (va != MAP_FAILED)
364 /* unmap & reserve */
366 mmap (va, size, PROT_NONE, MAP_FIXED | MAP_PRIVATE | MAP_ANONYMOUS,
375 clib_pmalloc_create_shared_arena (clib_pmalloc_main_t * pm, char *name,
376 uword size, u32 log2_page_sz, u32 numa_node)
378 clib_pmalloc_arena_t *a;
379 clib_pmalloc_page_t *pp;
382 clib_error_free (pm->error);
384 if (log2_page_sz == 0)
385 log2_page_sz = pm->def_log2_page_sz;
386 else if (log2_page_sz != pm->def_log2_page_sz &&
387 log2_page_sz != clib_mem_get_log2_page_size ())
389 pm->error = clib_error_create ("unsupported page size (%uKB)",
390 1 << (log2_page_sz - 10));
394 n_pages = pmalloc_size2pages (size, pm->def_log2_page_sz);
396 if (n_pages + vec_len (pm->pages) > pm->max_pages)
399 if (numa_node == CLIB_PMALLOC_NUMA_LOCAL)
400 numa_node = clib_get_current_numa_node ();
402 pool_get (pm->arenas, a);
403 a->index = a - pm->arenas;
404 a->name = format (0, "%s%c", name, 0);
405 a->numa_node = numa_node;
406 a->flags = CLIB_PMALLOC_ARENA_F_SHARED_MEM;
407 a->log2_subpage_sz = log2_page_sz;
408 a->subpages_per_page = 1U << (pm->def_log2_page_sz - log2_page_sz);
410 if ((pp = pmalloc_map_pages (pm, a, numa_node, n_pages)) == 0)
413 memset (a, 0, sizeof (*a));
414 pool_put (pm->arenas, a);
418 return pm->base + ((uword) pp->index << pm->def_log2_page_sz);
422 clib_pmalloc_alloc_inline (clib_pmalloc_main_t * pm, clib_pmalloc_arena_t * a,
423 uword size, uword align, u32 numa_node)
425 clib_pmalloc_page_t *pp;
426 u32 n_blocks, block_align, *page_index;
428 ASSERT (is_pow2 (align));
430 if (numa_node == CLIB_PMALLOC_NUMA_LOCAL)
431 numa_node = clib_get_current_numa_node ();
435 if (size > 1ULL << pm->def_log2_page_sz)
438 vec_validate_init_empty (pm->default_arena_for_numa_node,
440 if (pm->default_arena_for_numa_node[numa_node] == ~0)
442 pool_get (pm->arenas, a);
443 pm->default_arena_for_numa_node[numa_node] = a - pm->arenas;
444 a->name = format (0, "default-numa-%u%c", numa_node, 0);
445 a->numa_node = numa_node;
446 a->log2_subpage_sz = pm->def_log2_page_sz;
447 a->subpages_per_page = 1;
450 a = pool_elt_at_index (pm->arenas,
451 pm->default_arena_for_numa_node[numa_node]);
453 else if (size > 1ULL << a->log2_subpage_sz)
456 n_blocks = round_pow2 (size, PMALLOC_BLOCK_SZ) / PMALLOC_BLOCK_SZ;
457 block_align = align >> PMALLOC_LOG2_BLOCK_SZ;
459 vec_foreach (page_index, a->page_indices)
461 pp = vec_elt_at_index (pm->pages, *page_index);
462 void *rv = alloc_chunk_from_page (pm, pp, n_blocks, block_align,
469 if ((a->flags & CLIB_PMALLOC_ARENA_F_SHARED_MEM) == 0 &&
470 (pp = pmalloc_map_pages (pm, a, numa_node, 1)))
471 return alloc_chunk_from_page (pm, pp, n_blocks, block_align, numa_node);
477 clib_pmalloc_alloc_aligned_on_numa (clib_pmalloc_main_t * pm, uword size,
478 uword align, u32 numa_node)
480 return clib_pmalloc_alloc_inline (pm, 0, size, align, numa_node);
484 clib_pmalloc_alloc_aligned (clib_pmalloc_main_t *pm, uword size, uword align)
486 return clib_pmalloc_alloc_inline (pm, 0, size, align,
487 CLIB_PMALLOC_NUMA_LOCAL);
491 clib_pmalloc_alloc_from_arena (clib_pmalloc_main_t *pm, void *arena_va,
492 uword size, uword align)
494 clib_pmalloc_arena_t *a = clib_pmalloc_get_arena (pm, arena_va);
495 return clib_pmalloc_alloc_inline (pm, a, size, align, 0);
499 pmalloc_chunks_mergeable (clib_pmalloc_arena_t * a, clib_pmalloc_page_t * pp,
502 clib_pmalloc_chunk_t *c1, *c2;
504 if (ci1 == ~0 || ci2 == ~0)
507 c1 = get_chunk (pp, ci1);
508 c2 = get_chunk (pp, ci2);
510 if (c1->used || c2->used)
513 if (c1->start >> (a->log2_subpage_sz - PMALLOC_LOG2_BLOCK_SZ) !=
514 c2->start >> (a->log2_subpage_sz - PMALLOC_LOG2_BLOCK_SZ))
521 clib_pmalloc_free (clib_pmalloc_main_t * pm, void *va)
523 clib_pmalloc_page_t *pp;
524 clib_pmalloc_chunk_t *c;
525 clib_pmalloc_arena_t *a;
527 u32 chunk_index, page_index;
529 p = hash_get (pm->chunk_index_by_va, pointer_to_uword (va));
535 page_index = clib_pmalloc_get_page_index (pm, va);
536 hash_unset (pm->chunk_index_by_va, pointer_to_uword (va));
538 pp = vec_elt_at_index (pm->pages, page_index);
539 c = pool_elt_at_index (pp->chunks, chunk_index);
540 a = pool_elt_at_index (pm->arenas, pp->arena_index);
542 pp->n_free_blocks += c->size;
545 /* merge with next if free */
546 if (pmalloc_chunks_mergeable (a, pp, chunk_index, c->next))
548 clib_pmalloc_chunk_t *next = get_chunk (pp, c->next);
549 c->size += next->size;
550 c->next = next->next;
551 if (next->next != ~0)
552 get_chunk (pp, next->next)->prev = chunk_index;
553 memset (next, 0, sizeof (*next));
554 pool_put (pp->chunks, next);
558 /* merge with prev if free */
559 if (pmalloc_chunks_mergeable (a, pp, c->prev, chunk_index))
561 clib_pmalloc_chunk_t *prev = get_chunk (pp, c->prev);
562 prev->size += c->size;
563 prev->next = c->next;
565 get_chunk (pp, c->next)->prev = c->prev;
566 memset (c, 0, sizeof (*c));
567 pool_put (pp->chunks, c);
573 format_pmalloc_page (u8 * s, va_list * va)
575 clib_pmalloc_page_t *pp = va_arg (*va, clib_pmalloc_page_t *);
576 int verbose = va_arg (*va, int);
577 u32 indent = format_get_indent (s);
582 s = format (s, "free %u chunks %u free-chunks %d ",
583 (pp->n_free_blocks) << PMALLOC_LOG2_BLOCK_SZ,
584 pool_elts (pp->chunks), pp->n_free_chunks);
588 clib_pmalloc_chunk_t *c;
589 c = pool_elt_at_index (pp->chunks, pp->first_chunk_index);
590 s = format (s, "\n%U%12s%12s%8s%8s%8s%8s",
591 format_white_space, indent + 2,
592 "chunk offset", "size", "used", "index", "prev", "next");
595 s = format (s, "\n%U%12u%12u%8s%8d%8d%8d",
596 format_white_space, indent + 2,
597 c->start << PMALLOC_LOG2_BLOCK_SZ,
598 c->size << PMALLOC_LOG2_BLOCK_SZ,
599 c->used ? "yes" : "no",
600 c - pp->chunks, c->prev, c->next);
603 c = pool_elt_at_index (pp->chunks, c->next);
610 format_pmalloc (u8 * s, va_list * va)
612 clib_pmalloc_main_t *pm = va_arg (*va, clib_pmalloc_main_t *);
613 int verbose = va_arg (*va, int);
614 u32 indent = format_get_indent (s);
616 clib_pmalloc_page_t *pp;
617 clib_pmalloc_arena_t *a;
619 s = format (s, "used-pages %u reserved-pages %u default-page-size %U "
620 "lookup-page-size %U%s", vec_len (pm->pages), pm->max_pages,
621 format_log2_page_size, pm->def_log2_page_sz,
622 format_log2_page_size, pm->lookup_log2_page_sz,
623 pm->flags & CLIB_PMALLOC_F_NO_PAGEMAP ? " no-pagemap" : "");
627 s = format (s, " va-start %p", pm->base);
630 s = format (s, "\n%Ulast-error: %U", format_white_space, indent + 2,
631 format_clib_error, pm->error);
635 pool_foreach (a, pm->arenas)
638 s = format (s, "\n%Uarena '%s' pages %u subpage-size %U numa-node %u",
639 format_white_space, indent + 2, a->name,
640 vec_len (a->page_indices), format_log2_page_size,
641 a->log2_subpage_sz, a->numa_node);
643 s = format (s, " shared fd %d", a->fd);
645 vec_foreach (page_index, a->page_indices)
647 pp = vec_elt_at_index (pm->pages, *page_index);
648 s = format (s, "\n%U%U", format_white_space, indent + 4,
649 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")