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/lock.h>
30 #include <vppinfra/time.h>
31 #include <vppinfra/format.h>
32 #include <vppinfra/clib_error.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
68 while (clib_atomic_test_and_set (&clib_mem_main.map_lock))
75 clib_atomic_release (&clib_mem_main.map_lock);
79 clib_mem_get_default_hugepage_size (void)
81 unformat_input_t input;
89 * If the kernel doesn't support hugepages, /proc/meminfo won't
90 * say anything about it. Use the regular page size as a default.
92 size = clib_mem_get_page_size () / 1024;
94 if ((fd = open ("/proc/meminfo", 0)) == -1)
97 unformat_init_clib_file (&input, fd);
99 while (unformat_check_input (&input) != UNFORMAT_END_OF_INPUT)
101 if (unformat (&input, "Hugepagesize:%_%u kB", &size))
104 unformat_skip_line (&input);
106 unformat_free (&input);
109 return 1024ULL * size;
112 static clib_mem_page_sz_t
113 legacy_get_log2_default_hugepage_size (void)
115 clib_mem_page_sz_t log2_page_size = CLIB_MEM_PAGE_SZ_UNKNOWN;
119 if ((fp = fopen ("/proc/meminfo", "r")) == NULL)
120 return CLIB_MEM_PAGE_SZ_UNKNOWN;
122 while (fscanf (fp, "%32s", tmp) > 0)
123 if (strncmp ("Hugepagesize:", tmp, 13) == 0)
126 if (fscanf (fp, "%u", &size) > 0)
127 log2_page_size = 10 + min_log2 (size);
132 return log2_page_size;
136 clib_mem_main_init ()
138 clib_mem_main_t *mm = &clib_mem_main;
143 if (mm->log2_page_sz != CLIB_MEM_PAGE_SZ_UNKNOWN)
146 /* system page size */
147 page_size = sysconf (_SC_PAGESIZE);
148 mm->log2_page_sz = min_log2 (page_size);
150 /* default system hugeppage size */
151 if ((fd = syscall (__NR_memfd_create, "test", MFD_HUGETLB)) != -1)
153 mm->log2_default_hugepage_sz = clib_mem_get_fd_log2_page_size (fd);
156 else /* likely kernel older than 4.14 */
157 mm->log2_default_hugepage_sz = legacy_get_log2_default_hugepage_size ();
160 va = mmap (0, page_size, PROT_READ | PROT_WRITE, MAP_PRIVATE |
161 MAP_ANONYMOUS, -1, 0);
162 if (va == MAP_FAILED)
165 if (mlock (va, page_size))
168 for (int i = 0; i < CLIB_MAX_NUMAS; i++)
171 if (syscall (__NR_move_pages, 0, 1, &va, &i, &status, 0) == 0)
172 mm->numa_node_bitmap |= 1ULL << i;
176 munmap (va, page_size);
180 clib_mem_get_fd_page_size (int fd)
182 struct stat st = { 0 };
183 if (fstat (fd, &st) == -1)
185 return st.st_blksize;
188 __clib_export clib_mem_page_sz_t
189 clib_mem_get_fd_log2_page_size (int fd)
191 uword page_size = clib_mem_get_fd_page_size (fd);
192 return page_size ? min_log2 (page_size) : CLIB_MEM_PAGE_SZ_UNKNOWN;
196 clib_mem_vm_randomize_va (uword * requested_va,
197 clib_mem_page_sz_t log2_page_size)
201 if (log2_page_size <= 12)
203 else if (log2_page_size > 12 && log2_page_size <= 16)
209 (clib_cpu_time_now () & bit_mask) * (1ull << log2_page_size);
213 legacy_memfd_create (u8 * name)
215 clib_mem_main_t *mm = &clib_mem_main;
222 * Since mkdtemp will modify template string "/tmp/hugepage_mount.XXXXXX",
223 * it must not be a string constant, but should be declared as
226 temp = format (0, "/tmp/hugepage_mount.XXXXXX%c", 0);
228 /* create mount directory */
229 if ((mount_dir = mkdtemp ((char *) temp)) == 0)
232 vec_reset_length (mm->error);
233 mm->error = clib_error_return_unix (mm->error, "mkdtemp");
234 return CLIB_MEM_ERROR;
237 if (mount ("none", mount_dir, "hugetlbfs", 0, NULL))
240 rmdir ((char *) mount_dir);
241 vec_reset_length (mm->error);
242 mm->error = clib_error_return_unix (mm->error, "mount");
243 return CLIB_MEM_ERROR;
246 filename = format (0, "%s/%s%c", mount_dir, name, 0);
248 if ((fd = open ((char *) filename, O_CREAT | O_RDWR, 0755)) == -1)
250 vec_reset_length (mm->error);
251 mm->error = clib_error_return_unix (mm->error, "mkdtemp");
254 umount2 ((char *) mount_dir, MNT_DETACH);
255 rmdir ((char *) mount_dir);
263 clib_mem_vm_create_fd (clib_mem_page_sz_t log2_page_size, char *fmt, ...)
265 clib_mem_main_t *mm = &clib_mem_main;
267 unsigned int memfd_flags;
271 if (log2_page_size == mm->log2_page_sz)
272 log2_page_size = CLIB_MEM_PAGE_SZ_DEFAULT;
273 else if (log2_page_size == mm->log2_default_hugepage_sz)
274 log2_page_size = CLIB_MEM_PAGE_SZ_DEFAULT_HUGE;
276 switch (log2_page_size)
278 case CLIB_MEM_PAGE_SZ_UNKNOWN:
279 return CLIB_MEM_ERROR;
280 case CLIB_MEM_PAGE_SZ_DEFAULT:
281 memfd_flags = MFD_ALLOW_SEALING;
283 case CLIB_MEM_PAGE_SZ_DEFAULT_HUGE:
284 memfd_flags = MFD_HUGETLB;
287 memfd_flags = MFD_HUGETLB | log2_page_size << MFD_HUGE_SHIFT;
291 s = va_format (0, fmt, &va);
294 /* memfd_create maximum string size is 249 chars without trailing zero */
295 if (vec_len (s) > 249)
299 /* memfd_create introduced in kernel 3.17, we don't support older kernels */
300 fd = syscall (__NR_memfd_create, (char *) s, memfd_flags);
302 /* kernel versions < 4.14 does not support memfd_create for huge pages */
303 if (fd == -1 && errno == EINVAL &&
304 log2_page_size == CLIB_MEM_PAGE_SZ_DEFAULT_HUGE)
306 fd = legacy_memfd_create (s);
310 vec_reset_length (mm->error);
311 mm->error = clib_error_return_unix (mm->error, "memfd_create");
313 return CLIB_MEM_ERROR;
318 if ((memfd_flags & MFD_ALLOW_SEALING) &&
319 ((fcntl (fd, F_ADD_SEALS, F_SEAL_SHRINK)) == -1))
321 vec_reset_length (mm->error);
322 mm->error = clib_error_return_unix (mm->error, "fcntl (F_ADD_SEALS)");
324 return CLIB_MEM_ERROR;
331 clib_mem_vm_reserve (uword start, uword size, clib_mem_page_sz_t log2_page_sz)
333 clib_mem_main_t *mm = &clib_mem_main;
334 uword pagesize = 1ULL << log2_page_sz;
335 uword sys_page_sz = 1ULL << mm->log2_page_sz;
339 size = round_pow2 (size, pagesize);
341 /* in adition of requested reservation, we also rserve one system page
342 * (typically 4K) adjacent to the start off reservation */
346 /* start address is provided, so we just need to make sure we are not
347 * replacing existing map */
348 if (start & pow2_mask (log2_page_sz))
351 base = (void *) start - sys_page_sz;
352 base = mmap (base, size + sys_page_sz, PROT_NONE,
353 MAP_PRIVATE | MAP_ANONYMOUS | MAP_FIXED_NOREPLACE, -1, 0);
354 return (base == MAP_FAILED) ? ~0 : start;
357 /* to make sure that we get reservation aligned to page_size we need to
358 * request one additional page as mmap will return us address which is
359 * aligned only to system page size */
360 base = mmap (0, size + pagesize, PROT_NONE,
361 MAP_PRIVATE | MAP_ANONYMOUS, -1, 0);
363 if (base == MAP_FAILED)
366 /* return additional space at the end of allocation */
367 p = base + size + pagesize;
368 n_bytes = (uword) p & pow2_mask (log2_page_sz);
375 /* return additional space at the start of allocation */
376 n_bytes = pagesize - sys_page_sz - n_bytes;
379 munmap (base, n_bytes);
383 return (uword) base + sys_page_sz;
386 __clib_export clib_mem_vm_map_hdr_t *
387 clib_mem_vm_get_next_map_hdr (clib_mem_vm_map_hdr_t * hdr)
389 clib_mem_main_t *mm = &clib_mem_main;
390 uword sys_page_sz = 1ULL << mm->log2_page_sz;
391 clib_mem_vm_map_hdr_t *next;
396 mprotect (hdr, sys_page_sz, PROT_READ);
400 mprotect (hdr, sys_page_sz, PROT_NONE);
402 mprotect (next, sys_page_sz, PROT_READ);
407 clib_mem_vm_map_internal (void *base, clib_mem_page_sz_t log2_page_sz,
408 uword size, int fd, uword offset, char *name)
410 clib_mem_main_t *mm = &clib_mem_main;
411 clib_mem_vm_map_hdr_t *hdr;
412 uword sys_page_sz = 1ULL << mm->log2_page_sz;
413 int mmap_flags = MAP_FIXED, is_huge = 0;
417 mmap_flags |= MAP_SHARED;
418 log2_page_sz = clib_mem_get_fd_log2_page_size (fd);
419 if (log2_page_sz > mm->log2_page_sz)
424 mmap_flags |= MAP_PRIVATE | MAP_ANONYMOUS;
426 if (log2_page_sz == mm->log2_page_sz)
427 log2_page_sz = CLIB_MEM_PAGE_SZ_DEFAULT;
429 switch (log2_page_sz)
431 case CLIB_MEM_PAGE_SZ_UNKNOWN:
432 /* will fail later */
434 case CLIB_MEM_PAGE_SZ_DEFAULT:
435 log2_page_sz = mm->log2_page_sz;
437 case CLIB_MEM_PAGE_SZ_DEFAULT_HUGE:
438 mmap_flags |= MAP_HUGETLB;
439 log2_page_sz = mm->log2_default_hugepage_sz;
443 mmap_flags |= MAP_HUGETLB;
444 mmap_flags |= log2_page_sz << MAP_HUGE_SHIFT;
449 if (log2_page_sz == CLIB_MEM_PAGE_SZ_UNKNOWN)
450 return CLIB_MEM_VM_MAP_FAILED;
452 size = round_pow2 (size, 1ULL << log2_page_sz);
454 base = (void *) clib_mem_vm_reserve ((uword) base, size, log2_page_sz);
456 if (base == (void *) ~0)
457 return CLIB_MEM_VM_MAP_FAILED;
459 base = mmap (base, size, PROT_READ | PROT_WRITE, mmap_flags, fd, offset);
461 if (base == MAP_FAILED)
462 return CLIB_MEM_VM_MAP_FAILED;
464 if (is_huge && (mlock (base, size) != 0))
467 return CLIB_MEM_VM_MAP_FAILED;
470 hdr = mmap (base - sys_page_sz, sys_page_sz, PROT_READ | PROT_WRITE,
471 MAP_ANONYMOUS | MAP_PRIVATE | MAP_FIXED, -1, 0);
473 if (hdr != base - sys_page_sz)
476 return CLIB_MEM_VM_MAP_FAILED;
483 mprotect (mm->last_map, sys_page_sz, PROT_READ | PROT_WRITE);
484 mm->last_map->next = hdr;
485 mprotect (mm->last_map, sys_page_sz, PROT_NONE);
490 CLIB_MEM_UNPOISON (hdr, sys_page_sz);
492 hdr->prev = mm->last_map;
493 snprintf (hdr->name, CLIB_VM_MAP_HDR_NAME_MAX_LEN - 1, "%s", (char *) name);
498 hdr->base_addr = (uword) base;
499 hdr->log2_page_sz = log2_page_sz;
500 hdr->num_pages = size >> log2_page_sz;
502 hdr->name[CLIB_VM_MAP_HDR_NAME_MAX_LEN - 1] = 0;
503 mprotect (hdr, sys_page_sz, PROT_NONE);
505 CLIB_MEM_UNPOISON (base, size);
510 clib_mem_vm_unmap (void *base)
512 clib_mem_main_t *mm = &clib_mem_main;
513 uword size, sys_page_sz = 1ULL << mm->log2_page_sz;
514 clib_mem_vm_map_hdr_t *hdr = base - sys_page_sz;;
516 if (mprotect (hdr, sys_page_sz, PROT_READ | PROT_WRITE) != 0)
517 return CLIB_MEM_ERROR;
519 size = hdr->num_pages << hdr->log2_page_sz;
520 if (munmap ((void *) hdr->base_addr, size) != 0)
521 return CLIB_MEM_ERROR;
527 mprotect (hdr->next, sys_page_sz, PROT_READ | PROT_WRITE);
528 hdr->next->prev = hdr->prev;
529 mprotect (hdr->next, sys_page_sz, PROT_NONE);
532 mm->last_map = hdr->prev;
536 mprotect (hdr->prev, sys_page_sz, PROT_READ | PROT_WRITE);
537 hdr->prev->next = hdr->next;
538 mprotect (hdr->prev, sys_page_sz, PROT_NONE);
541 mm->first_map = hdr->next;
545 if (munmap (hdr, sys_page_sz) != 0)
546 return CLIB_MEM_ERROR;
552 clib_mem_get_page_stats (void *start, clib_mem_page_sz_t log2_page_size,
553 uword n_pages, clib_mem_page_stats_t * stats)
558 log2_page_size = clib_mem_log2_page_size_validate (log2_page_size);
560 vec_validate (status, n_pages - 1);
561 vec_validate (ptr, n_pages - 1);
563 for (i = 0; i < n_pages; i++)
564 ptr[i] = start + (i << log2_page_size);
566 clib_memset (stats, 0, sizeof (clib_mem_page_stats_t));
567 stats->total = n_pages;
568 stats->log2_page_sz = log2_page_size;
570 if (syscall (__NR_move_pages, 0, n_pages, ptr, 0, status, 0) != 0)
572 stats->unknown = n_pages;
576 for (i = 0; i < n_pages; i++)
578 if (status[i] >= 0 && status[i] < CLIB_MAX_NUMAS)
581 stats->per_numa[status[i]]++;
583 else if (status[i] == -EFAULT)
596 clib_mem_vm_get_paddr (void *mem, clib_mem_page_sz_t log2_page_size,
599 int pagesize = sysconf (_SC_PAGESIZE);
604 log2_page_size = clib_mem_log2_page_size_validate (log2_page_size);
606 if ((fd = open ((char *) "/proc/self/pagemap", O_RDONLY)) == -1)
609 for (i = 0; i < n_pages; i++)
611 u64 seek, pagemap = 0;
612 uword vaddr = pointer_to_uword (mem) + (((u64) i) << log2_page_size);
613 seek = ((u64) vaddr / pagesize) * sizeof (u64);
614 if (lseek (fd, seek, SEEK_SET) != seek)
617 if (read (fd, &pagemap, sizeof (pagemap)) != (sizeof (pagemap)))
620 if ((pagemap & (1ULL << 63)) == 0)
623 pagemap &= pow2_mask (55);
624 vec_add1 (r, pagemap * pagesize);
629 if (vec_len (r) != n_pages)
638 clib_mem_set_numa_affinity (u8 numa_node, int force)
640 clib_mem_main_t *mm = &clib_mem_main;
641 long unsigned int mask[16] = { 0 };
642 int mask_len = sizeof (mask) * 8 + 1;
644 /* no numa support */
645 if (mm->numa_node_bitmap == 0)
649 vec_reset_length (mm->error);
650 mm->error = clib_error_return (mm->error, "%s: numa not supported",
652 return CLIB_MEM_ERROR;
658 mask[0] = 1 << numa_node;
660 if (syscall (__NR_set_mempolicy, force ? MPOL_BIND : MPOL_PREFERRED, mask,
664 vec_reset_length (mm->error);
668 vec_reset_length (mm->error);
669 mm->error = clib_error_return_unix (mm->error, (char *) __func__);
670 return CLIB_MEM_ERROR;
674 clib_mem_set_default_numa_affinity ()
676 clib_mem_main_t *mm = &clib_mem_main;
678 if (syscall (__NR_set_mempolicy, MPOL_DEFAULT, 0, 0))
680 vec_reset_length (mm->error);
681 mm->error = clib_error_return_unix (mm->error, (char *) __func__);
682 return CLIB_MEM_ERROR;
688 * fd.io coding-style-patch-verification: ON
691 * eval: (c-set-style "gnu")