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/syscall.h>
34 #include <vppinfra/linux/sysfs.h>
36 #ifndef F_LINUX_SPECIFIC_BASE
37 #define F_LINUX_SPECIFIC_BASE 1024
41 #define F_ADD_SEALS (F_LINUX_SPECIFIC_BASE + 9)
42 #define F_GET_SEALS (F_LINUX_SPECIFIC_BASE + 10)
44 #define F_SEAL_SEAL 0x0001 /* prevent further seals from being set */
45 #define F_SEAL_SHRINK 0x0002 /* prevent file from shrinking */
46 #define F_SEAL_GROW 0x0004 /* prevent file from growing */
47 #define F_SEAL_WRITE 0x0008 /* prevent writes */
51 #define MFD_HUGETLB 0x0004U
54 #ifndef MAP_HUGE_SHIFT
55 #define MAP_HUGE_SHIFT 26
58 #ifndef MFD_HUGE_SHIFT
59 #define MFD_HUGE_SHIFT 26
62 #ifndef MAP_FIXED_NOREPLACE
63 #define MAP_FIXED_NOREPLACE 0x100000
69 while (clib_atomic_test_and_set (&clib_mem_main.map_lock))
76 clib_atomic_release (&clib_mem_main.map_lock);
80 clib_mem_get_default_hugepage_size (void)
82 unformat_input_t input;
90 * If the kernel doesn't support hugepages, /proc/meminfo won't
91 * say anything about it. Use the regular page size as a default.
93 size = clib_mem_get_page_size () / 1024;
95 if ((fd = open ("/proc/meminfo", 0)) == -1)
98 unformat_init_clib_file (&input, fd);
100 while (unformat_check_input (&input) != UNFORMAT_END_OF_INPUT)
102 if (unformat (&input, "Hugepagesize:%_%u kB", &size))
105 unformat_skip_line (&input);
107 unformat_free (&input);
110 return 1024ULL * size;
113 static clib_mem_page_sz_t
114 legacy_get_log2_default_hugepage_size (void)
116 clib_mem_page_sz_t log2_page_size = CLIB_MEM_PAGE_SZ_UNKNOWN;
120 if ((fp = fopen ("/proc/meminfo", "r")) == NULL)
121 return CLIB_MEM_PAGE_SZ_UNKNOWN;
123 while (fscanf (fp, "%32s", tmp) > 0)
124 if (strncmp ("Hugepagesize:", tmp, 13) == 0)
127 if (fscanf (fp, "%u", &size) > 0)
128 log2_page_size = 10 + min_log2 (size);
133 return log2_page_size;
137 clib_mem_main_init ()
139 clib_mem_main_t *mm = &clib_mem_main;
144 if (mm->log2_page_sz != CLIB_MEM_PAGE_SZ_UNKNOWN)
147 /* system page size */
148 page_size = sysconf (_SC_PAGESIZE);
149 mm->log2_page_sz = min_log2 (page_size);
151 /* default system hugeppage size */
152 if ((fd = memfd_create ("test", MFD_HUGETLB)) != -1)
154 mm->log2_default_hugepage_sz = clib_mem_get_fd_log2_page_size (fd);
157 else /* likely kernel older than 4.14 */
158 mm->log2_default_hugepage_sz = legacy_get_log2_default_hugepage_size ();
161 va = mmap (0, page_size, PROT_READ | PROT_WRITE, MAP_PRIVATE |
162 MAP_ANONYMOUS, -1, 0);
163 if (va == MAP_FAILED)
166 if (mlock (va, page_size))
169 for (int i = 0; i < CLIB_MAX_NUMAS; i++)
172 if (move_pages (0, 1, &va, &i, &status, 0) == 0)
173 mm->numa_node_bitmap |= 1ULL << i;
177 munmap (va, page_size);
181 clib_mem_get_fd_page_size (int fd)
183 struct stat st = { 0 };
184 if (fstat (fd, &st) == -1)
186 return st.st_blksize;
189 __clib_export clib_mem_page_sz_t
190 clib_mem_get_fd_log2_page_size (int fd)
192 uword page_size = clib_mem_get_fd_page_size (fd);
193 return page_size ? min_log2 (page_size) : CLIB_MEM_PAGE_SZ_UNKNOWN;
197 clib_mem_vm_randomize_va (uword * requested_va,
198 clib_mem_page_sz_t log2_page_size)
202 if (log2_page_size <= 12)
204 else if (log2_page_size > 12 && log2_page_size <= 16)
210 (clib_cpu_time_now () & bit_mask) * (1ull << log2_page_size);
214 legacy_memfd_create (u8 * name)
216 clib_mem_main_t *mm = &clib_mem_main;
223 * Since mkdtemp will modify template string "/tmp/hugepage_mount.XXXXXX",
224 * it must not be a string constant, but should be declared as
227 temp = format (0, "/tmp/hugepage_mount.XXXXXX%c", 0);
229 /* create mount directory */
230 if ((mount_dir = mkdtemp ((char *) temp)) == 0)
233 vec_reset_length (mm->error);
234 mm->error = clib_error_return_unix (mm->error, "mkdtemp");
235 return CLIB_MEM_ERROR;
238 if (mount ("none", mount_dir, "hugetlbfs", 0, NULL))
241 rmdir ((char *) mount_dir);
242 vec_reset_length (mm->error);
243 mm->error = clib_error_return_unix (mm->error, "mount");
244 return CLIB_MEM_ERROR;
247 filename = format (0, "%s/%s%c", mount_dir, name, 0);
249 if ((fd = open ((char *) filename, O_CREAT | O_RDWR, 0755)) == -1)
251 vec_reset_length (mm->error);
252 mm->error = clib_error_return_unix (mm->error, "mkdtemp");
255 umount2 ((char *) mount_dir, MNT_DETACH);
256 rmdir ((char *) mount_dir);
264 clib_mem_vm_create_fd (clib_mem_page_sz_t log2_page_size, char *fmt, ...)
266 clib_mem_main_t *mm = &clib_mem_main;
268 unsigned int memfd_flags;
272 if (log2_page_size == mm->log2_page_sz)
273 log2_page_size = CLIB_MEM_PAGE_SZ_DEFAULT;
274 else if (log2_page_size == mm->log2_default_hugepage_sz)
275 log2_page_size = CLIB_MEM_PAGE_SZ_DEFAULT_HUGE;
277 switch (log2_page_size)
279 case CLIB_MEM_PAGE_SZ_UNKNOWN:
280 return CLIB_MEM_ERROR;
281 case CLIB_MEM_PAGE_SZ_DEFAULT:
282 memfd_flags = MFD_ALLOW_SEALING;
284 case CLIB_MEM_PAGE_SZ_DEFAULT_HUGE:
285 memfd_flags = MFD_HUGETLB;
288 memfd_flags = MFD_HUGETLB | log2_page_size << MFD_HUGE_SHIFT;
292 s = va_format (0, fmt, &va);
295 /* memfd_create maximum string size is 249 chars without trailing zero */
296 if (vec_len (s) > 249)
300 /* memfd_create introduced in kernel 3.17, we don't support older kernels */
301 fd = memfd_create ((char *) s, memfd_flags);
303 /* kernel versions < 4.14 does not support memfd_create for huge pages */
304 if (fd == -1 && errno == EINVAL &&
305 log2_page_size == CLIB_MEM_PAGE_SZ_DEFAULT_HUGE)
307 fd = legacy_memfd_create (s);
311 vec_reset_length (mm->error);
312 mm->error = clib_error_return_unix (mm->error, "memfd_create");
314 return CLIB_MEM_ERROR;
319 if ((memfd_flags & MFD_ALLOW_SEALING) &&
320 ((fcntl (fd, F_ADD_SEALS, F_SEAL_SHRINK)) == -1))
322 vec_reset_length (mm->error);
323 mm->error = clib_error_return_unix (mm->error, "fcntl (F_ADD_SEALS)");
325 return CLIB_MEM_ERROR;
332 clib_mem_vm_reserve (uword start, uword size, clib_mem_page_sz_t log2_page_sz)
334 clib_mem_main_t *mm = &clib_mem_main;
335 uword pagesize = 1ULL << log2_page_sz;
336 uword sys_page_sz = 1ULL << mm->log2_page_sz;
340 size = round_pow2 (size, pagesize);
342 /* in adition of requested reservation, we also rserve one system page
343 * (typically 4K) adjacent to the start off reservation */
347 /* start address is provided, so we just need to make sure we are not
348 * replacing existing map */
349 if (start & pow2_mask (log2_page_sz))
352 base = (void *) start - sys_page_sz;
353 base = mmap (base, size + sys_page_sz, PROT_NONE,
354 MAP_PRIVATE | MAP_ANONYMOUS | MAP_FIXED_NOREPLACE, -1, 0);
355 return (base == MAP_FAILED) ? ~0 : start;
358 /* to make sure that we get reservation aligned to page_size we need to
359 * request one additional page as mmap will return us address which is
360 * aligned only to system page size */
361 base = mmap (0, size + pagesize, PROT_NONE,
362 MAP_PRIVATE | MAP_ANONYMOUS, -1, 0);
364 if (base == MAP_FAILED)
367 /* return additional space at the end of allocation */
368 p = base + size + pagesize;
369 n_bytes = (uword) p & pow2_mask (log2_page_sz);
376 /* return additional space at the start of allocation */
377 n_bytes = pagesize - sys_page_sz - n_bytes;
380 munmap (base, n_bytes);
384 return (uword) base + sys_page_sz;
387 __clib_export clib_mem_vm_map_hdr_t *
388 clib_mem_vm_get_next_map_hdr (clib_mem_vm_map_hdr_t * hdr)
390 clib_mem_main_t *mm = &clib_mem_main;
391 uword sys_page_sz = 1ULL << mm->log2_page_sz;
392 clib_mem_vm_map_hdr_t *next;
397 mprotect (hdr, sys_page_sz, PROT_READ);
401 mprotect (hdr, sys_page_sz, PROT_NONE);
403 mprotect (next, sys_page_sz, PROT_READ);
408 clib_mem_vm_map_internal (void *base, clib_mem_page_sz_t log2_page_sz,
409 uword size, int fd, uword offset, char *name)
411 clib_mem_main_t *mm = &clib_mem_main;
412 clib_mem_vm_map_hdr_t *hdr;
413 uword sys_page_sz = 1ULL << mm->log2_page_sz;
414 int mmap_flags = MAP_FIXED, is_huge = 0;
418 mmap_flags |= MAP_SHARED;
419 log2_page_sz = clib_mem_get_fd_log2_page_size (fd);
420 if (log2_page_sz > mm->log2_page_sz)
425 mmap_flags |= MAP_PRIVATE | MAP_ANONYMOUS;
427 if (log2_page_sz == mm->log2_page_sz)
428 log2_page_sz = CLIB_MEM_PAGE_SZ_DEFAULT;
430 switch (log2_page_sz)
432 case CLIB_MEM_PAGE_SZ_UNKNOWN:
433 /* will fail later */
435 case CLIB_MEM_PAGE_SZ_DEFAULT:
436 log2_page_sz = mm->log2_page_sz;
438 case CLIB_MEM_PAGE_SZ_DEFAULT_HUGE:
439 mmap_flags |= MAP_HUGETLB;
440 log2_page_sz = mm->log2_default_hugepage_sz;
444 mmap_flags |= MAP_HUGETLB;
445 mmap_flags |= log2_page_sz << MAP_HUGE_SHIFT;
450 if (log2_page_sz == CLIB_MEM_PAGE_SZ_UNKNOWN)
451 return CLIB_MEM_VM_MAP_FAILED;
453 size = round_pow2 (size, 1ULL << log2_page_sz);
455 base = (void *) clib_mem_vm_reserve ((uword) base, size, log2_page_sz);
457 if (base == (void *) ~0)
458 return CLIB_MEM_VM_MAP_FAILED;
460 base = mmap (base, size, PROT_READ | PROT_WRITE, mmap_flags, fd, offset);
462 if (base == MAP_FAILED)
463 return CLIB_MEM_VM_MAP_FAILED;
465 if (is_huge && (mlock (base, size) != 0))
468 return CLIB_MEM_VM_MAP_FAILED;
471 hdr = mmap (base - sys_page_sz, sys_page_sz, PROT_READ | PROT_WRITE,
472 MAP_ANONYMOUS | MAP_PRIVATE | MAP_FIXED, -1, 0);
474 if (hdr != base - sys_page_sz)
477 return CLIB_MEM_VM_MAP_FAILED;
484 mprotect (mm->last_map, sys_page_sz, PROT_READ | PROT_WRITE);
485 mm->last_map->next = hdr;
486 mprotect (mm->last_map, sys_page_sz, PROT_NONE);
491 CLIB_MEM_UNPOISON (hdr, sys_page_sz);
493 hdr->prev = mm->last_map;
498 hdr->base_addr = (uword) base;
499 hdr->log2_page_sz = log2_page_sz;
500 hdr->num_pages = size >> log2_page_sz;
502 snprintf (hdr->name, CLIB_VM_MAP_HDR_NAME_MAX_LEN - 1, "%s", (char *) name);
503 hdr->name[CLIB_VM_MAP_HDR_NAME_MAX_LEN - 1] = 0;
504 mprotect (hdr, sys_page_sz, PROT_NONE);
506 CLIB_MEM_UNPOISON (base, size);
511 clib_mem_vm_unmap (void *base)
513 clib_mem_main_t *mm = &clib_mem_main;
514 uword size, sys_page_sz = 1ULL << mm->log2_page_sz;
515 clib_mem_vm_map_hdr_t *hdr = base - sys_page_sz;;
517 if (mprotect (hdr, sys_page_sz, PROT_READ | PROT_WRITE) != 0)
518 return CLIB_MEM_ERROR;
520 size = hdr->num_pages << hdr->log2_page_sz;
521 if (munmap ((void *) hdr->base_addr, size) != 0)
522 return CLIB_MEM_ERROR;
528 mprotect (hdr->next, sys_page_sz, PROT_READ | PROT_WRITE);
529 hdr->next->prev = hdr->prev;
530 mprotect (hdr->next, sys_page_sz, PROT_NONE);
533 mm->last_map = hdr->prev;
537 mprotect (hdr->prev, sys_page_sz, PROT_READ | PROT_WRITE);
538 hdr->prev->next = hdr->next;
539 mprotect (hdr->prev, sys_page_sz, PROT_NONE);
542 mm->first_map = hdr->next;
546 if (munmap (hdr, sys_page_sz) != 0)
547 return CLIB_MEM_ERROR;
553 clib_mem_get_page_stats (void *start, clib_mem_page_sz_t log2_page_size,
554 uword n_pages, clib_mem_page_stats_t * stats)
559 log2_page_size = clib_mem_log2_page_size_validate (log2_page_size);
561 vec_validate (status, n_pages - 1);
562 vec_validate (ptr, n_pages - 1);
564 for (i = 0; i < n_pages; i++)
565 ptr[i] = start + (i << log2_page_size);
567 clib_memset (stats, 0, sizeof (clib_mem_page_stats_t));
568 stats->total = n_pages;
569 stats->log2_page_sz = log2_page_size;
571 if (move_pages (0, n_pages, ptr, 0, status, 0) != 0)
573 stats->unknown = n_pages;
577 for (i = 0; i < n_pages; i++)
579 if (status[i] >= 0 && status[i] < CLIB_MAX_NUMAS)
582 stats->per_numa[status[i]]++;
584 else if (status[i] == -EFAULT)
593 clib_mem_vm_get_paddr (void *mem, clib_mem_page_sz_t log2_page_size,
596 int pagesize = sysconf (_SC_PAGESIZE);
601 log2_page_size = clib_mem_log2_page_size_validate (log2_page_size);
603 if ((fd = open ((char *) "/proc/self/pagemap", O_RDONLY)) == -1)
606 for (i = 0; i < n_pages; i++)
608 u64 seek, pagemap = 0;
609 uword vaddr = pointer_to_uword (mem) + (((u64) i) << log2_page_size);
610 seek = ((u64) vaddr / pagesize) * sizeof (u64);
611 if (lseek (fd, seek, SEEK_SET) != seek)
614 if (read (fd, &pagemap, sizeof (pagemap)) != (sizeof (pagemap)))
617 if ((pagemap & (1ULL << 63)) == 0)
620 pagemap &= pow2_mask (55);
621 vec_add1 (r, pagemap * pagesize);
626 if (vec_len (r) != n_pages)
635 clib_mem_set_numa_affinity (u8 numa_node, int force)
637 clib_mem_main_t *mm = &clib_mem_main;
638 long unsigned int mask[16] = { 0 };
639 int mask_len = sizeof (mask) * 8 + 1;
641 /* no numa support */
642 if (mm->numa_node_bitmap == 0)
646 vec_reset_length (mm->error);
647 mm->error = clib_error_return (mm->error, "%s: numa not supported",
649 return CLIB_MEM_ERROR;
655 mask[0] = 1 << numa_node;
657 if (set_mempolicy (force ? MPOL_BIND : MPOL_PREFERRED, mask, mask_len))
660 vec_reset_length (mm->error);
664 vec_reset_length (mm->error);
665 mm->error = clib_error_return_unix (mm->error, (char *) __func__);
666 return CLIB_MEM_ERROR;
670 clib_mem_set_default_numa_affinity ()
672 clib_mem_main_t *mm = &clib_mem_main;
674 if (set_mempolicy (MPOL_DEFAULT, 0, 0))
676 vec_reset_length (mm->error);
677 mm->error = clib_error_return_unix (mm->error, (char *) __func__);
678 return CLIB_MEM_ERROR;
684 * fd.io coding-style-patch-verification: ON
687 * eval: (c-set-style "gnu")