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);
78 static clib_mem_page_sz_t
79 legacy_get_log2_default_hugepage_size (void)
81 clib_mem_page_sz_t log2_page_size = CLIB_MEM_PAGE_SZ_UNKNOWN;
85 if ((fp = fopen ("/proc/meminfo", "r")) == NULL)
86 return CLIB_MEM_PAGE_SZ_UNKNOWN;
88 while (fscanf (fp, "%32s", tmp) > 0)
89 if (strncmp ("Hugepagesize:", tmp, 13) == 0)
92 if (fscanf (fp, "%u", &size) > 0)
93 log2_page_size = 10 + min_log2 (size);
98 return log2_page_size;
102 clib_mem_main_init ()
104 clib_mem_main_t *mm = &clib_mem_main;
109 if (mm->log2_page_sz != CLIB_MEM_PAGE_SZ_UNKNOWN)
112 /* system page size */
113 page_size = sysconf (_SC_PAGESIZE);
114 mm->log2_page_sz = min_log2 (page_size);
116 /* default system hugeppage size */
117 if ((fd = syscall (__NR_memfd_create, "test", MFD_HUGETLB)) != -1)
119 mm->log2_default_hugepage_sz = clib_mem_get_fd_log2_page_size (fd);
122 else /* likely kernel older than 4.14 */
123 mm->log2_default_hugepage_sz = legacy_get_log2_default_hugepage_size ();
125 mm->log2_sys_default_hugepage_sz = mm->log2_default_hugepage_sz;
128 va = mmap (0, page_size, PROT_READ | PROT_WRITE, MAP_PRIVATE |
129 MAP_ANONYMOUS, -1, 0);
130 if (va == MAP_FAILED)
133 if (mlock (va, page_size))
136 for (int i = 0; i < CLIB_MAX_NUMAS; i++)
139 if (syscall (__NR_move_pages, 0, 1, &va, &i, &status, 0) == 0)
140 mm->numa_node_bitmap |= 1ULL << i;
144 munmap (va, page_size);
148 clib_mem_get_fd_page_size (int fd)
150 struct stat st = { 0 };
151 if (fstat (fd, &st) == -1)
153 return st.st_blksize;
156 __clib_export clib_mem_page_sz_t
157 clib_mem_get_fd_log2_page_size (int fd)
159 uword page_size = clib_mem_get_fd_page_size (fd);
160 return page_size ? min_log2 (page_size) : CLIB_MEM_PAGE_SZ_UNKNOWN;
164 clib_mem_vm_randomize_va (uword * requested_va,
165 clib_mem_page_sz_t log2_page_size)
169 if (log2_page_size <= 12)
171 else if (log2_page_size > 12 && log2_page_size <= 16)
177 (clib_cpu_time_now () & bit_mask) * (1ull << log2_page_size);
181 legacy_memfd_create (u8 * name)
183 clib_mem_main_t *mm = &clib_mem_main;
190 * Since mkdtemp will modify template string "/tmp/hugepage_mount.XXXXXX",
191 * it must not be a string constant, but should be declared as
194 temp = format (0, "/tmp/hugepage_mount.XXXXXX%c", 0);
196 /* create mount directory */
197 if ((mount_dir = mkdtemp ((char *) temp)) == 0)
200 vec_reset_length (mm->error);
201 mm->error = clib_error_return_unix (mm->error, "mkdtemp");
202 return CLIB_MEM_ERROR;
205 if (mount ("none", mount_dir, "hugetlbfs", 0, NULL))
208 rmdir ((char *) mount_dir);
209 vec_reset_length (mm->error);
210 mm->error = clib_error_return_unix (mm->error, "mount");
211 return CLIB_MEM_ERROR;
214 filename = format (0, "%s/%s%c", mount_dir, name, 0);
216 if ((fd = open ((char *) filename, O_CREAT | O_RDWR, 0755)) == -1)
218 vec_reset_length (mm->error);
219 mm->error = clib_error_return_unix (mm->error, "mkdtemp");
222 umount2 ((char *) mount_dir, MNT_DETACH);
223 rmdir ((char *) mount_dir);
231 clib_mem_vm_create_fd (clib_mem_page_sz_t log2_page_size, char *fmt, ...)
233 clib_mem_main_t *mm = &clib_mem_main;
235 unsigned int memfd_flags;
239 if (log2_page_size == mm->log2_page_sz)
240 log2_page_size = CLIB_MEM_PAGE_SZ_DEFAULT;
241 else if (log2_page_size == mm->log2_sys_default_hugepage_sz)
242 log2_page_size = CLIB_MEM_PAGE_SZ_DEFAULT_HUGE;
244 switch (log2_page_size)
246 case CLIB_MEM_PAGE_SZ_UNKNOWN:
247 return CLIB_MEM_ERROR;
248 case CLIB_MEM_PAGE_SZ_DEFAULT:
249 memfd_flags = MFD_ALLOW_SEALING;
251 case CLIB_MEM_PAGE_SZ_DEFAULT_HUGE:
252 memfd_flags = MFD_HUGETLB;
255 memfd_flags = MFD_HUGETLB | log2_page_size << MFD_HUGE_SHIFT;
259 s = va_format (0, fmt, &va);
262 /* memfd_create maximum string size is 249 chars without trailing zero */
263 if (vec_len (s) > 249)
264 vec_set_len (s, 249);
267 /* memfd_create introduced in kernel 3.17, we don't support older kernels */
268 fd = syscall (__NR_memfd_create, (char *) s, memfd_flags);
270 /* kernel versions < 4.14 does not support memfd_create for huge pages */
271 if (fd == -1 && errno == EINVAL &&
272 log2_page_size == CLIB_MEM_PAGE_SZ_DEFAULT_HUGE)
274 fd = legacy_memfd_create (s);
278 vec_reset_length (mm->error);
279 mm->error = clib_error_return_unix (mm->error, "memfd_create");
281 return CLIB_MEM_ERROR;
286 if ((memfd_flags & MFD_ALLOW_SEALING) &&
287 ((fcntl (fd, F_ADD_SEALS, F_SEAL_SHRINK)) == -1))
289 vec_reset_length (mm->error);
290 mm->error = clib_error_return_unix (mm->error, "fcntl (F_ADD_SEALS)");
292 return CLIB_MEM_ERROR;
299 clib_mem_vm_reserve (uword start, uword size, clib_mem_page_sz_t log2_page_sz)
301 clib_mem_main_t *mm = &clib_mem_main;
302 uword pagesize = 1ULL << log2_page_sz;
303 uword sys_page_sz = 1ULL << mm->log2_page_sz;
307 size = round_pow2 (size, pagesize);
309 /* in adition of requested reservation, we also rserve one system page
310 * (typically 4K) adjacent to the start off reservation */
314 /* start address is provided, so we just need to make sure we are not
315 * replacing existing map */
316 if (start & pow2_mask (log2_page_sz))
319 base = (void *) start - sys_page_sz;
320 base = mmap (base, size + sys_page_sz, PROT_NONE,
321 MAP_PRIVATE | MAP_ANONYMOUS | MAP_FIXED_NOREPLACE, -1, 0);
322 return (base == MAP_FAILED) ? ~0 : start;
325 /* to make sure that we get reservation aligned to page_size we need to
326 * request one additional page as mmap will return us address which is
327 * aligned only to system page size */
328 base = mmap (0, size + pagesize, PROT_NONE,
329 MAP_PRIVATE | MAP_ANONYMOUS, -1, 0);
331 if (base == MAP_FAILED)
334 /* return additional space at the end of allocation */
335 p = base + size + pagesize;
336 n_bytes = (uword) p & pow2_mask (log2_page_sz);
343 /* return additional space at the start of allocation */
344 n_bytes = pagesize - sys_page_sz - n_bytes;
347 munmap (base, n_bytes);
351 return (uword) base + sys_page_sz;
354 __clib_export clib_mem_vm_map_hdr_t *
355 clib_mem_vm_get_next_map_hdr (clib_mem_vm_map_hdr_t * hdr)
357 clib_mem_main_t *mm = &clib_mem_main;
358 uword sys_page_sz = 1ULL << mm->log2_page_sz;
359 clib_mem_vm_map_hdr_t *next;
364 mprotect (hdr, sys_page_sz, PROT_READ);
368 mprotect (hdr, sys_page_sz, PROT_NONE);
370 mprotect (next, sys_page_sz, PROT_READ);
375 clib_mem_vm_map_internal (void *base, clib_mem_page_sz_t log2_page_sz,
376 uword size, int fd, uword offset, char *name)
378 clib_mem_main_t *mm = &clib_mem_main;
379 clib_mem_vm_map_hdr_t *hdr;
380 uword sys_page_sz = 1ULL << mm->log2_page_sz;
381 int mmap_flags = MAP_FIXED, is_huge = 0;
385 mmap_flags |= MAP_SHARED;
386 log2_page_sz = clib_mem_get_fd_log2_page_size (fd);
387 if (log2_page_sz > mm->log2_page_sz)
392 mmap_flags |= MAP_PRIVATE | MAP_ANONYMOUS;
394 if (log2_page_sz == mm->log2_page_sz)
395 log2_page_sz = CLIB_MEM_PAGE_SZ_DEFAULT;
397 switch (log2_page_sz)
399 case CLIB_MEM_PAGE_SZ_UNKNOWN:
400 /* will fail later */
402 case CLIB_MEM_PAGE_SZ_DEFAULT:
403 log2_page_sz = mm->log2_page_sz;
405 case CLIB_MEM_PAGE_SZ_DEFAULT_HUGE:
406 mmap_flags |= MAP_HUGETLB;
407 log2_page_sz = mm->log2_default_hugepage_sz;
411 mmap_flags |= MAP_HUGETLB;
412 mmap_flags |= log2_page_sz << MAP_HUGE_SHIFT;
417 if (log2_page_sz == CLIB_MEM_PAGE_SZ_UNKNOWN)
418 return CLIB_MEM_VM_MAP_FAILED;
420 size = round_pow2 (size, 1ULL << log2_page_sz);
422 base = (void *) clib_mem_vm_reserve ((uword) base, size, log2_page_sz);
424 if (base == (void *) ~0)
425 return CLIB_MEM_VM_MAP_FAILED;
427 base = mmap (base, size, PROT_READ | PROT_WRITE, mmap_flags, fd, offset);
429 if (base == MAP_FAILED)
430 return CLIB_MEM_VM_MAP_FAILED;
432 if (is_huge && (mlock (base, size) != 0))
435 return CLIB_MEM_VM_MAP_FAILED;
438 hdr = mmap (base - sys_page_sz, sys_page_sz, PROT_READ | PROT_WRITE,
439 MAP_ANONYMOUS | MAP_PRIVATE | MAP_FIXED, -1, 0);
441 if (hdr != base - sys_page_sz)
444 return CLIB_MEM_VM_MAP_FAILED;
451 mprotect (mm->last_map, sys_page_sz, PROT_READ | PROT_WRITE);
452 mm->last_map->next = hdr;
453 mprotect (mm->last_map, sys_page_sz, PROT_NONE);
458 CLIB_MEM_UNPOISON (hdr, sys_page_sz);
460 hdr->prev = mm->last_map;
461 snprintf (hdr->name, CLIB_VM_MAP_HDR_NAME_MAX_LEN - 1, "%s", (char *) name);
464 hdr->base_addr = (uword) base;
465 hdr->log2_page_sz = log2_page_sz;
466 hdr->num_pages = size >> log2_page_sz;
468 hdr->name[CLIB_VM_MAP_HDR_NAME_MAX_LEN - 1] = 0;
469 mprotect (hdr, sys_page_sz, PROT_NONE);
473 CLIB_MEM_UNPOISON (base, size);
478 clib_mem_vm_unmap (void *base)
480 clib_mem_main_t *mm = &clib_mem_main;
481 uword size, sys_page_sz = 1ULL << mm->log2_page_sz;
482 clib_mem_vm_map_hdr_t *hdr = base - sys_page_sz;;
485 if (mprotect (hdr, sys_page_sz, PROT_READ | PROT_WRITE) != 0)
488 size = hdr->num_pages << hdr->log2_page_sz;
489 if (munmap ((void *) hdr->base_addr, size) != 0)
494 mprotect (hdr->next, sys_page_sz, PROT_READ | PROT_WRITE);
495 hdr->next->prev = hdr->prev;
496 mprotect (hdr->next, sys_page_sz, PROT_NONE);
499 mm->last_map = hdr->prev;
503 mprotect (hdr->prev, sys_page_sz, PROT_READ | PROT_WRITE);
504 hdr->prev->next = hdr->next;
505 mprotect (hdr->prev, sys_page_sz, PROT_NONE);
508 mm->first_map = hdr->next;
512 if (munmap (hdr, sys_page_sz) != 0)
513 return CLIB_MEM_ERROR;
518 return CLIB_MEM_ERROR;
522 clib_mem_get_page_stats (void *start, clib_mem_page_sz_t log2_page_size,
523 uword n_pages, clib_mem_page_stats_t * stats)
528 log2_page_size = clib_mem_log2_page_size_validate (log2_page_size);
530 vec_validate (status, n_pages - 1);
531 vec_validate (ptr, n_pages - 1);
533 for (i = 0; i < n_pages; i++)
534 ptr[i] = start + (i << log2_page_size);
536 clib_memset (stats, 0, sizeof (clib_mem_page_stats_t));
537 stats->total = n_pages;
538 stats->log2_page_sz = log2_page_size;
540 if (syscall (__NR_move_pages, 0, n_pages, ptr, 0, status, 0) != 0)
542 stats->unknown = n_pages;
546 for (i = 0; i < n_pages; i++)
548 if (status[i] >= 0 && status[i] < CLIB_MAX_NUMAS)
551 stats->per_numa[status[i]]++;
553 else if (status[i] == -EFAULT)
566 clib_mem_vm_get_paddr (void *mem, clib_mem_page_sz_t log2_page_size,
569 int pagesize = sysconf (_SC_PAGESIZE);
574 log2_page_size = clib_mem_log2_page_size_validate (log2_page_size);
576 if ((fd = open ((char *) "/proc/self/pagemap", O_RDONLY)) == -1)
579 for (i = 0; i < n_pages; i++)
581 u64 seek, pagemap = 0;
582 uword vaddr = pointer_to_uword (mem) + (((u64) i) << log2_page_size);
583 seek = ((u64) vaddr / pagesize) * sizeof (u64);
584 if (lseek (fd, seek, SEEK_SET) != seek)
587 if (read (fd, &pagemap, sizeof (pagemap)) != (sizeof (pagemap)))
590 if ((pagemap & (1ULL << 63)) == 0)
593 pagemap &= pow2_mask (55);
594 vec_add1 (r, pagemap * pagesize);
599 if (vec_len (r) != n_pages)
608 clib_mem_set_numa_affinity (u8 numa_node, int force)
610 clib_mem_main_t *mm = &clib_mem_main;
611 long unsigned int mask[16] = { 0 };
612 int mask_len = sizeof (mask) * 8 + 1;
614 /* no numa support */
615 if (mm->numa_node_bitmap == 0)
619 vec_reset_length (mm->error);
620 mm->error = clib_error_return (mm->error, "%s: numa not supported",
622 return CLIB_MEM_ERROR;
628 mask[0] = 1 << numa_node;
630 if (syscall (__NR_set_mempolicy, force ? MPOL_BIND : MPOL_PREFERRED, mask,
634 vec_reset_length (mm->error);
638 vec_reset_length (mm->error);
639 mm->error = clib_error_return_unix (mm->error, (char *) __func__);
640 return CLIB_MEM_ERROR;
644 clib_mem_set_default_numa_affinity ()
646 clib_mem_main_t *mm = &clib_mem_main;
648 if (syscall (__NR_set_mempolicy, MPOL_DEFAULT, 0, 0))
650 vec_reset_length (mm->error);
651 mm->error = clib_error_return_unix (mm->error, (char *) __func__);
652 return CLIB_MEM_ERROR;
658 * fd.io coding-style-patch-verification: ON
661 * eval: (c-set-style "gnu")