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 */
51 clib_mem_get_page_size (void)
53 return getpagesize ();
57 clib_mem_get_default_hugepage_size (void)
59 unformat_input_t input;
66 if ((fd = open ("/proc/meminfo", 0)) == -1)
69 unformat_init_clib_file (&input, fd);
71 while (unformat_check_input (&input) != UNFORMAT_END_OF_INPUT)
73 if (unformat (&input, "Hugepagesize:%_%u kB", &size))
76 unformat_skip_line (&input);
78 unformat_free (&input);
81 return 1024ULL * size;
85 clib_mem_vm_get_page_size (int fd)
87 struct stat st = { 0 };
88 if (fstat (fd, &st) == -1)
94 clib_mem_vm_get_log2_page_size (int fd)
96 return min_log2 (clib_mem_vm_get_page_size (fd));
100 clib_mem_vm_randomize_va (uword * requested_va, u32 log2_page_size)
104 if (log2_page_size <= 12)
106 else if (log2_page_size > 12 && log2_page_size <= 16)
112 (clib_cpu_time_now () & bit_mask) * (1ull << log2_page_size);
116 #define MFD_HUGETLB 0x0004U
120 clib_mem_create_hugetlb_fd (char *name, int *fdp)
122 clib_error_t *err = 0;
124 static int memfd_hugetlb_supported = 1;
126 char template[] = "/tmp/hugepage_mount.XXXXXX";
131 if (memfd_hugetlb_supported)
133 if ((fd = memfd_create (name, MFD_HUGETLB)) != -1)
136 /* avoid further tries if memfd MFD_HUGETLB is not supported */
137 if (errno == EINVAL && strnlen (name, 256) <= 249)
138 memfd_hugetlb_supported = 0;
141 mount_dir = mkdtemp (template);
143 return clib_error_return_unix (0, "mkdtemp \'%s\'", template);
145 if (mount ("none", (char *) mount_dir, "hugetlbfs", 0, NULL))
147 rmdir ((char *) mount_dir);
148 err = clib_error_return_unix (0, "mount hugetlb directory '%s'",
152 filename = format (0, "%s/%s%c", mount_dir, name, 0);
153 fd = open ((char *) filename, O_CREAT | O_RDWR, 0755);
154 umount2 ((char *) mount_dir, MNT_DETACH);
155 rmdir ((char *) mount_dir);
158 err = clib_error_return_unix (0, "open");
167 clib_mem_vm_ext_alloc (clib_mem_vm_alloc_t * a)
170 clib_error_t *err = 0;
177 long unsigned int old_mask[16] = { 0 };
179 /* save old numa mem policy if needed */
180 if (a->flags & (CLIB_MEM_VM_F_NUMA_PREFER | CLIB_MEM_VM_F_NUMA_FORCE))
183 rv = get_mempolicy (&old_mpol, old_mask, sizeof (old_mask) * 8 + 1,
188 if (a->numa_node != 0 && (a->flags & CLIB_MEM_VM_F_NUMA_FORCE) != 0)
190 err = clib_error_return_unix (0, "get_mempolicy");
198 if (a->flags & CLIB_MEM_VM_F_LOCKED)
199 mmap_flags |= MAP_LOCKED;
201 /* if we are creating shared segment, we need file descriptor */
202 if (a->flags & CLIB_MEM_VM_F_SHARED)
204 mmap_flags |= MAP_SHARED;
205 /* if hugepages are needed we need to create mount point */
206 if (a->flags & CLIB_MEM_VM_F_HUGETLB)
208 if ((err = clib_mem_create_hugetlb_fd (a->name, &fd)))
211 mmap_flags |= MAP_LOCKED;
215 if ((fd = memfd_create (a->name, MFD_ALLOW_SEALING)) == -1)
217 err = clib_error_return_unix (0, "memfd_create");
221 if ((fcntl (fd, F_ADD_SEALS, F_SEAL_SHRINK)) == -1)
223 err = clib_error_return_unix (0, "fcntl (F_ADD_SEALS)");
228 log2_page_size = clib_mem_vm_get_log2_page_size (fd);
229 if (log2_page_size == 0)
231 err = clib_error_return_unix (0, "cannot determine page size");
237 clib_mem_vm_randomize_va (&a->requested_va, log2_page_size);
238 mmap_flags |= MAP_FIXED;
241 else /* not CLIB_MEM_VM_F_SHARED */
243 mmap_flags |= MAP_PRIVATE | MAP_ANONYMOUS;
244 if (a->flags & CLIB_MEM_VM_F_HUGETLB)
246 mmap_flags |= MAP_HUGETLB;
251 log2_page_size = min_log2 (sysconf (_SC_PAGESIZE));
255 n_pages = ((a->size - 1) >> log2_page_size) + 1;
257 if (a->flags & CLIB_MEM_VM_F_HUGETLB_PREALLOC)
259 err = clib_sysfs_prealloc_hugepages (a->numa_node, log2_page_size,
267 if ((ftruncate (fd, (u64) n_pages * (1 << log2_page_size))) == -1)
269 err = clib_error_return_unix (0, "ftruncate");
276 long unsigned int mask[16] = { 0 };
277 mask[0] = 1 << a->numa_node;
278 rv = set_mempolicy (MPOL_BIND, mask, sizeof (mask) * 8 + 1);
279 if (rv == -1 && a->numa_node != 0 &&
280 (a->flags & CLIB_MEM_VM_F_NUMA_FORCE) != 0)
282 err = clib_error_return_unix (0, "set_mempolicy");
287 addr = mmap (uword_to_pointer (a->requested_va, void *), a->size,
288 (PROT_READ | PROT_WRITE), mmap_flags, fd, 0);
289 if (addr == MAP_FAILED)
291 err = clib_error_return_unix (0, "mmap");
295 /* re-apply old numa memory policy */
296 if (old_mpol != -1 &&
297 set_mempolicy (old_mpol, old_mask, sizeof (old_mask) * 8 + 1) == -1)
299 err = clib_error_return_unix (0, "set_mempolicy");
303 a->log2_page_size = log2_page_size;
304 a->n_pages = n_pages;
319 clib_mem_vm_ext_free (clib_mem_vm_alloc_t * a)
323 clib_mem_vm_free (a->addr, 1ull << a->log2_page_size);
330 clib_mem_vm_get_paddr (void *mem, int log2_page_size, int n_pages)
332 int pagesize = sysconf (_SC_PAGESIZE);
337 if ((fd = open ((char *) "/proc/self/pagemap", O_RDONLY)) == -1)
340 for (i = 0; i < n_pages; i++)
342 u64 seek, pagemap = 0;
343 uword vaddr = pointer_to_uword (mem) + (((u64) i) << log2_page_size);
344 seek = ((u64) vaddr / pagesize) * sizeof (u64);
345 if (lseek (fd, seek, SEEK_SET) != seek)
348 if (read (fd, &pagemap, sizeof (pagemap)) != (sizeof (pagemap)))
351 if ((pagemap & (1ULL << 63)) == 0)
354 pagemap &= pow2_mask (55);
355 vec_add1 (r, pagemap * pagesize);
360 if (vec_len (r) != n_pages)
369 clib_mem_vm_ext_map (clib_mem_vm_map_t * a)
371 int mmap_flags = MAP_SHARED;
375 mmap_flags |= MAP_FIXED;
377 addr = (void *) mmap (uword_to_pointer (a->requested_va, void *), a->size,
378 PROT_READ | PROT_WRITE, mmap_flags, a->fd, 0);
380 if (addr == MAP_FAILED)
381 return clib_error_return_unix (0, "mmap");
388 * fd.io coding-style-patch-verification: ON
391 * eval: (c-set-style "gnu")