2 * Copyright (c) 2017 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/mount.h>
24 #include <linux/mempolicy.h>
25 #include <linux/memfd.h>
27 #include <vppinfra/clib.h>
28 #include <vppinfra/mem.h>
29 #include <vppinfra/time.h>
30 #include <vppinfra/format.h>
31 #include <vppinfra/clib_error.h>
32 #include <vppinfra/linux/syscall.h>
33 #include <vppinfra/linux/sysfs.h>
35 #ifndef F_LINUX_SPECIFIC_BASE
36 #define F_LINUX_SPECIFIC_BASE 1024
40 #define F_ADD_SEALS (F_LINUX_SPECIFIC_BASE + 9)
41 #define F_GET_SEALS (F_LINUX_SPECIFIC_BASE + 10)
43 #define F_SEAL_SEAL 0x0001 /* prevent further seals from being set */
44 #define F_SEAL_SHRINK 0x0002 /* prevent file from shrinking */
45 #define F_SEAL_GROW 0x0004 /* prevent file from growing */
46 #define F_SEAL_WRITE 0x0008 /* prevent writes */
50 #define MFD_HUGETLB 0x0004U
53 #ifndef MAP_HUGE_SHIFT
54 #define MAP_HUGE_SHIFT 26
57 #ifndef MFD_HUGE_SHIFT
58 #define MFD_HUGE_SHIFT 26
61 #ifndef MAP_FIXED_NOREPLACE
62 #define MAP_FIXED_NOREPLACE 0x100000
66 clib_mem_get_default_hugepage_size (void)
68 unformat_input_t input;
76 * If the kernel doesn't support hugepages, /proc/meminfo won't
77 * say anything about it. Use the regular page size as a default.
79 size = clib_mem_get_page_size () / 1024;
81 if ((fd = open ("/proc/meminfo", 0)) == -1)
84 unformat_init_clib_file (&input, fd);
86 while (unformat_check_input (&input) != UNFORMAT_END_OF_INPUT)
88 if (unformat (&input, "Hugepagesize:%_%u kB", &size))
91 unformat_skip_line (&input);
93 unformat_free (&input);
96 return 1024ULL * size;
99 static clib_mem_page_sz_t
100 legacy_get_log2_default_hugepage_size (void)
102 clib_mem_page_sz_t log2_page_size = CLIB_MEM_PAGE_SZ_UNKNOWN;
106 if ((fp = fopen ("/proc/meminfo", "r")) == NULL)
107 return CLIB_MEM_PAGE_SZ_UNKNOWN;
109 while (fscanf (fp, "%32s", tmp) > 0)
110 if (strncmp ("Hugepagesize:", tmp, 13) == 0)
113 if (fscanf (fp, "%u", &size) > 0)
114 log2_page_size = 10 + min_log2 (size);
119 return log2_page_size;
123 clib_mem_main_init ()
125 clib_mem_main_t *mm = &clib_mem_main;
130 if (mm->log2_page_sz != CLIB_MEM_PAGE_SZ_UNKNOWN)
133 /* system page size */
134 page_size = sysconf (_SC_PAGESIZE);
135 mm->log2_page_sz = min_log2 (page_size);
137 /* default system hugeppage size */
138 if ((fd = memfd_create ("test", MFD_HUGETLB)) != -1)
140 mm->log2_default_hugepage_sz = clib_mem_get_fd_log2_page_size (fd);
143 else /* likely kernel older than 4.14 */
144 mm->log2_default_hugepage_sz = legacy_get_log2_default_hugepage_size ();
147 va = mmap (0, page_size, PROT_READ | PROT_WRITE, MAP_PRIVATE |
148 MAP_ANONYMOUS, -1, 0);
149 if (va == MAP_FAILED)
152 if (mlock (va, page_size))
155 for (int i = 0; i < CLIB_MAX_NUMAS; i++)
158 if (move_pages (0, 1, &va, &i, &status, 0) == 0)
159 mm->numa_node_bitmap |= 1ULL << i;
163 munmap (va, page_size);
167 clib_mem_get_fd_page_size (int fd)
169 struct stat st = { 0 };
170 if (fstat (fd, &st) == -1)
172 return st.st_blksize;
175 __clib_export clib_mem_page_sz_t
176 clib_mem_get_fd_log2_page_size (int fd)
178 uword page_size = clib_mem_get_fd_page_size (fd);
179 return page_size ? min_log2 (page_size) : CLIB_MEM_PAGE_SZ_UNKNOWN;
183 clib_mem_vm_randomize_va (uword * requested_va,
184 clib_mem_page_sz_t log2_page_size)
188 if (log2_page_size <= 12)
190 else if (log2_page_size > 12 && log2_page_size <= 16)
196 (clib_cpu_time_now () & bit_mask) * (1ull << log2_page_size);
200 legacy_memfd_create (u8 * name)
202 clib_mem_main_t *mm = &clib_mem_main;
209 * Since mkdtemp will modify template string "/tmp/hugepage_mount.XXXXXX",
210 * it must not be a string constant, but should be declared as
213 temp = format (0, "/tmp/hugepage_mount.XXXXXX%c", 0);
215 /* create mount directory */
216 if ((mount_dir = mkdtemp ((char *) temp)) == 0)
219 vec_reset_length (mm->error);
220 mm->error = clib_error_return_unix (mm->error, "mkdtemp");
221 return CLIB_MEM_ERROR;
224 if (mount ("none", mount_dir, "hugetlbfs", 0, NULL))
227 rmdir ((char *) mount_dir);
228 vec_reset_length (mm->error);
229 mm->error = clib_error_return_unix (mm->error, "mount");
230 return CLIB_MEM_ERROR;
233 filename = format (0, "%s/%s%c", mount_dir, name, 0);
235 if ((fd = open ((char *) filename, O_CREAT | O_RDWR, 0755)) == -1)
237 vec_reset_length (mm->error);
238 mm->error = clib_error_return_unix (mm->error, "mkdtemp");
241 umount2 ((char *) mount_dir, MNT_DETACH);
242 rmdir ((char *) mount_dir);
250 clib_mem_vm_create_fd (clib_mem_page_sz_t log2_page_size, char *fmt, ...)
252 clib_mem_main_t *mm = &clib_mem_main;
254 unsigned int memfd_flags;
258 if (log2_page_size == mm->log2_page_sz)
259 log2_page_size = CLIB_MEM_PAGE_SZ_DEFAULT;
260 else if (log2_page_size == mm->log2_default_hugepage_sz)
261 log2_page_size = CLIB_MEM_PAGE_SZ_DEFAULT_HUGE;
263 switch (log2_page_size)
265 case CLIB_MEM_PAGE_SZ_UNKNOWN:
266 return CLIB_MEM_ERROR;
267 case CLIB_MEM_PAGE_SZ_DEFAULT:
268 memfd_flags = MFD_ALLOW_SEALING;
270 case CLIB_MEM_PAGE_SZ_DEFAULT_HUGE:
271 memfd_flags = MFD_HUGETLB;
274 memfd_flags = MFD_HUGETLB | log2_page_size << MFD_HUGE_SHIFT;
278 s = va_format (0, fmt, &va);
281 /* memfd_create maximum string size is 249 chars without trailing zero */
282 if (vec_len (s) > 249)
286 /* memfd_create introduced in kernel 3.17, we don't support older kernels */
287 fd = memfd_create ((char *) s, memfd_flags);
289 /* kernel versions < 4.14 does not support memfd_create for huge pages */
290 if (fd == -1 && errno == EINVAL &&
291 log2_page_size == CLIB_MEM_PAGE_SZ_DEFAULT_HUGE)
293 fd = legacy_memfd_create (s);
297 vec_reset_length (mm->error);
298 mm->error = clib_error_return_unix (mm->error, "memfd_create");
300 return CLIB_MEM_ERROR;
305 if ((memfd_flags & MFD_ALLOW_SEALING) &&
306 ((fcntl (fd, F_ADD_SEALS, F_SEAL_SHRINK)) == -1))
308 vec_reset_length (mm->error);
309 mm->error = clib_error_return_unix (mm->error, "fcntl (F_ADD_SEALS)");
311 return CLIB_MEM_ERROR;
318 clib_mem_vm_reserve (uword start, uword size, clib_mem_page_sz_t log2_page_sz)
320 clib_mem_main_t *mm = &clib_mem_main;
321 uword pagesize = 1ULL << log2_page_sz;
322 uword sys_page_sz = 1ULL << mm->log2_page_sz;
326 size = round_pow2 (size, pagesize);
328 /* in adition of requested reservation, we also rserve one system page
329 * (typically 4K) adjacent to the start off reservation */
333 /* start address is provided, so we just need to make sure we are not
334 * replacing existing map */
335 if (start & pow2_mask (log2_page_sz))
338 base = (void *) start - sys_page_sz;
339 base = mmap (base, size + sys_page_sz, PROT_NONE,
340 MAP_PRIVATE | MAP_ANONYMOUS | MAP_FIXED_NOREPLACE, -1, 0);
341 return (base == MAP_FAILED) ? ~0 : start;
344 /* to make sure that we get reservation aligned to page_size we need to
345 * request one additional page as mmap will return us address which is
346 * aligned only to system page size */
347 base = mmap (0, size + pagesize, PROT_NONE,
348 MAP_PRIVATE | MAP_ANONYMOUS, -1, 0);
350 if (base == MAP_FAILED)
353 /* return additional space at the end of allocation */
354 p = base + size + pagesize;
355 n_bytes = (uword) p & pow2_mask (log2_page_sz);
362 /* return additional space at the start of allocation */
363 n_bytes = pagesize - sys_page_sz - n_bytes;
366 munmap (base, n_bytes);
370 return (uword) base + sys_page_sz;
373 __clib_export clib_mem_vm_map_hdr_t *
374 clib_mem_vm_get_next_map_hdr (clib_mem_vm_map_hdr_t * hdr)
376 clib_mem_main_t *mm = &clib_mem_main;
377 uword sys_page_sz = 1ULL << mm->log2_page_sz;
378 clib_mem_vm_map_hdr_t *next;
383 mprotect (hdr, sys_page_sz, PROT_READ);
387 mprotect (hdr, sys_page_sz, PROT_NONE);
389 mprotect (next, sys_page_sz, PROT_READ);
394 clib_mem_vm_map_internal (void *base, clib_mem_page_sz_t log2_page_sz,
395 uword size, int fd, uword offset, char *name)
397 clib_mem_main_t *mm = &clib_mem_main;
398 clib_mem_vm_map_hdr_t *hdr;
399 uword sys_page_sz = 1ULL << mm->log2_page_sz;
400 int mmap_flags = MAP_FIXED, is_huge = 0;
404 mmap_flags |= MAP_SHARED;
405 log2_page_sz = clib_mem_get_fd_log2_page_size (fd);
406 if (log2_page_sz > mm->log2_page_sz)
411 mmap_flags |= MAP_PRIVATE | MAP_ANONYMOUS;
413 if (log2_page_sz == mm->log2_page_sz)
414 log2_page_sz = CLIB_MEM_PAGE_SZ_DEFAULT;
416 switch (log2_page_sz)
418 case CLIB_MEM_PAGE_SZ_UNKNOWN:
419 /* will fail later */
421 case CLIB_MEM_PAGE_SZ_DEFAULT:
422 log2_page_sz = mm->log2_page_sz;
424 case CLIB_MEM_PAGE_SZ_DEFAULT_HUGE:
425 mmap_flags |= MAP_HUGETLB;
426 log2_page_sz = mm->log2_default_hugepage_sz;
430 mmap_flags |= MAP_HUGETLB;
431 mmap_flags |= log2_page_sz << MAP_HUGE_SHIFT;
436 if (log2_page_sz == CLIB_MEM_PAGE_SZ_UNKNOWN)
437 return CLIB_MEM_VM_MAP_FAILED;
439 size = round_pow2 (size, 1ULL << log2_page_sz);
441 base = (void *) clib_mem_vm_reserve ((uword) base, size, log2_page_sz);
443 if (base == (void *) ~0)
444 return CLIB_MEM_VM_MAP_FAILED;
446 base = mmap (base, size, PROT_READ | PROT_WRITE, mmap_flags, fd, offset);
448 if (base == MAP_FAILED)
449 return CLIB_MEM_VM_MAP_FAILED;
451 if (is_huge && (mlock (base, size) != 0))
454 return CLIB_MEM_VM_MAP_FAILED;
457 hdr = mmap (base - sys_page_sz, sys_page_sz, PROT_READ | PROT_WRITE,
458 MAP_ANONYMOUS | MAP_PRIVATE | MAP_FIXED, -1, 0);
460 if (hdr != base - sys_page_sz)
463 return CLIB_MEM_VM_MAP_FAILED;
468 mprotect (mm->last_map, sys_page_sz, PROT_READ | PROT_WRITE);
469 mm->last_map->next = hdr;
470 mprotect (mm->last_map, sys_page_sz, PROT_NONE);
475 CLIB_MEM_UNPOISON (hdr, sys_page_sz);
477 hdr->prev = mm->last_map;
480 hdr->base_addr = (uword) base;
481 hdr->log2_page_sz = log2_page_sz;
482 hdr->num_pages = size >> log2_page_sz;
484 snprintf (hdr->name, CLIB_VM_MAP_HDR_NAME_MAX_LEN - 1, "%s", (char *) name);
485 hdr->name[CLIB_VM_MAP_HDR_NAME_MAX_LEN - 1] = 0;
486 mprotect (hdr, sys_page_sz, PROT_NONE);
488 CLIB_MEM_UNPOISON (base, size);
493 clib_mem_vm_unmap (void *base)
495 clib_mem_main_t *mm = &clib_mem_main;
496 uword size, sys_page_sz = 1ULL << mm->log2_page_sz;
497 clib_mem_vm_map_hdr_t *hdr = base - sys_page_sz;;
499 if (mprotect (hdr, sys_page_sz, PROT_READ | PROT_WRITE) != 0)
500 return CLIB_MEM_ERROR;
502 size = hdr->num_pages << hdr->log2_page_sz;
503 if (munmap ((void *) hdr->base_addr, size) != 0)
504 return CLIB_MEM_ERROR;
508 mprotect (hdr->next, sys_page_sz, PROT_READ | PROT_WRITE);
509 hdr->next->prev = hdr->prev;
510 mprotect (hdr->next, sys_page_sz, PROT_NONE);
513 mm->last_map = hdr->prev;
517 mprotect (hdr->prev, sys_page_sz, PROT_READ | PROT_WRITE);
518 hdr->prev->next = hdr->next;
519 mprotect (hdr->prev, sys_page_sz, PROT_NONE);
522 mm->first_map = hdr->next;
524 if (munmap (hdr, sys_page_sz) != 0)
525 return CLIB_MEM_ERROR;
531 clib_mem_get_page_stats (void *start, clib_mem_page_sz_t log2_page_size,
532 uword n_pages, clib_mem_page_stats_t * stats)
537 log2_page_size = clib_mem_log2_page_size_validate (log2_page_size);
539 vec_validate (status, n_pages - 1);
540 vec_validate (ptr, n_pages - 1);
542 for (i = 0; i < n_pages; i++)
543 ptr[i] = start + (i << log2_page_size);
545 clib_memset (stats, 0, sizeof (clib_mem_page_stats_t));
546 stats->total = n_pages;
547 stats->log2_page_sz = log2_page_size;
549 if (move_pages (0, n_pages, ptr, 0, status, 0) != 0)
551 stats->unknown = n_pages;
555 for (i = 0; i < n_pages; i++)
557 if (status[i] >= 0 && status[i] < CLIB_MAX_NUMAS)
560 stats->per_numa[status[i]]++;
562 else if (status[i] == -EFAULT)
571 clib_mem_vm_get_paddr (void *mem, clib_mem_page_sz_t log2_page_size,
574 int pagesize = sysconf (_SC_PAGESIZE);
579 log2_page_size = clib_mem_log2_page_size_validate (log2_page_size);
581 if ((fd = open ((char *) "/proc/self/pagemap", O_RDONLY)) == -1)
584 for (i = 0; i < n_pages; i++)
586 u64 seek, pagemap = 0;
587 uword vaddr = pointer_to_uword (mem) + (((u64) i) << log2_page_size);
588 seek = ((u64) vaddr / pagesize) * sizeof (u64);
589 if (lseek (fd, seek, SEEK_SET) != seek)
592 if (read (fd, &pagemap, sizeof (pagemap)) != (sizeof (pagemap)))
595 if ((pagemap & (1ULL << 63)) == 0)
598 pagemap &= pow2_mask (55);
599 vec_add1 (r, pagemap * pagesize);
604 if (vec_len (r) != n_pages)
613 clib_mem_set_numa_affinity (u8 numa_node, int force)
615 clib_mem_main_t *mm = &clib_mem_main;
616 long unsigned int mask[16] = { 0 };
617 int mask_len = sizeof (mask) * 8 + 1;
619 /* no numa support */
620 if (mm->numa_node_bitmap == 0)
624 vec_reset_length (mm->error);
625 mm->error = clib_error_return (mm->error, "%s: numa not supported",
627 return CLIB_MEM_ERROR;
633 mask[0] = 1 << numa_node;
635 if (set_mempolicy (force ? MPOL_BIND : MPOL_PREFERRED, mask, mask_len))
638 vec_reset_length (mm->error);
642 vec_reset_length (mm->error);
643 mm->error = clib_error_return_unix (mm->error, (char *) __func__);
644 return CLIB_MEM_ERROR;
648 clib_mem_set_default_numa_affinity ()
650 clib_mem_main_t *mm = &clib_mem_main;
652 if (set_mempolicy (MPOL_DEFAULT, 0, 0))
654 vec_reset_length (mm->error);
655 mm->error = clib_error_return_unix (mm->error, (char *) __func__);
656 return CLIB_MEM_ERROR;
662 * fd.io coding-style-patch-verification: ON
665 * eval: (c-set-style "gnu")