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;
67 * If the kernel doesn't support hugepages, /proc/meminfo won't
68 * say anything about it. Use the regular page size as a default.
70 size = clib_mem_get_page_size () / 1024;
72 if ((fd = open ("/proc/meminfo", 0)) == -1)
75 unformat_init_clib_file (&input, fd);
77 while (unformat_check_input (&input) != UNFORMAT_END_OF_INPUT)
79 if (unformat (&input, "Hugepagesize:%_%u kB", &size))
82 unformat_skip_line (&input);
84 unformat_free (&input);
87 return 1024ULL * size;
91 clib_mem_get_fd_page_size (int fd)
93 struct stat st = { 0 };
94 if (fstat (fd, &st) == -1)
100 clib_mem_get_fd_log2_page_size (int fd)
102 return min_log2 (clib_mem_get_fd_page_size (fd));
106 clib_mem_vm_randomize_va (uword * requested_va, u32 log2_page_size)
110 if (log2_page_size <= 12)
112 else if (log2_page_size > 12 && log2_page_size <= 16)
118 (clib_cpu_time_now () & bit_mask) * (1ull << log2_page_size);
122 #define MFD_HUGETLB 0x0004U
126 clib_mem_create_fd (char *name, int *fdp)
132 if ((fd = memfd_create (name, MFD_ALLOW_SEALING)) == -1)
133 return clib_error_return_unix (0, "memfd_create");
135 if ((fcntl (fd, F_ADD_SEALS, F_SEAL_SHRINK)) == -1)
138 return clib_error_return_unix (0, "fcntl (F_ADD_SEALS)");
146 clib_mem_create_hugetlb_fd (char *name, int *fdp)
148 clib_error_t *err = 0;
150 static int memfd_hugetlb_supported = 1;
152 char template[] = "/tmp/hugepage_mount.XXXXXX";
157 if (memfd_hugetlb_supported)
159 if ((fd = memfd_create (name, MFD_HUGETLB)) != -1)
162 /* avoid further tries if memfd MFD_HUGETLB is not supported */
163 if (errno == EINVAL && strnlen (name, 256) <= 249)
164 memfd_hugetlb_supported = 0;
167 mount_dir = mkdtemp (template);
169 return clib_error_return_unix (0, "mkdtemp \'%s\'", template);
171 if (mount ("none", (char *) mount_dir, "hugetlbfs", 0, NULL))
173 rmdir ((char *) mount_dir);
174 err = clib_error_return_unix (0, "mount hugetlb directory '%s'",
178 filename = format (0, "%s/%s%c", mount_dir, name, 0);
179 fd = open ((char *) filename, O_CREAT | O_RDWR, 0755);
180 umount2 ((char *) mount_dir, MNT_DETACH);
181 rmdir ((char *) mount_dir);
184 err = clib_error_return_unix (0, "open");
193 clib_mem_vm_ext_alloc (clib_mem_vm_alloc_t * a)
196 clib_error_t *err = 0;
203 long unsigned int old_mask[16] = { 0 };
205 /* save old numa mem policy if needed */
206 if (a->flags & (CLIB_MEM_VM_F_NUMA_PREFER | CLIB_MEM_VM_F_NUMA_FORCE))
209 rv = get_mempolicy (&old_mpol, old_mask, sizeof (old_mask) * 8 + 1,
214 if (a->numa_node != 0 && (a->flags & CLIB_MEM_VM_F_NUMA_FORCE) != 0)
216 err = clib_error_return_unix (0, "get_mempolicy");
224 if (a->flags & CLIB_MEM_VM_F_LOCKED)
225 mmap_flags |= MAP_LOCKED;
227 /* if we are creating shared segment, we need file descriptor */
228 if (a->flags & CLIB_MEM_VM_F_SHARED)
230 mmap_flags |= MAP_SHARED;
231 /* if hugepages are needed we need to create mount point */
232 if (a->flags & CLIB_MEM_VM_F_HUGETLB)
234 if ((err = clib_mem_create_hugetlb_fd (a->name, &fd)))
237 mmap_flags |= MAP_LOCKED;
241 if ((err = clib_mem_create_fd (a->name, &fd)))
245 log2_page_size = clib_mem_get_fd_log2_page_size (fd);
246 if (log2_page_size == 0)
248 err = clib_error_return_unix (0, "cannot determine page size");
254 clib_mem_vm_randomize_va (&a->requested_va, log2_page_size);
255 mmap_flags |= MAP_FIXED;
258 else /* not CLIB_MEM_VM_F_SHARED */
260 mmap_flags |= MAP_PRIVATE | MAP_ANONYMOUS;
261 if (a->flags & CLIB_MEM_VM_F_HUGETLB)
263 mmap_flags |= MAP_HUGETLB;
268 log2_page_size = min_log2 (sysconf (_SC_PAGESIZE));
272 n_pages = ((a->size - 1) >> log2_page_size) + 1;
274 if (a->flags & CLIB_MEM_VM_F_HUGETLB_PREALLOC)
276 err = clib_sysfs_prealloc_hugepages (a->numa_node, log2_page_size,
284 if ((ftruncate (fd, (u64) n_pages * (1 << log2_page_size))) == -1)
286 err = clib_error_return_unix (0, "ftruncate");
293 long unsigned int mask[16] = { 0 };
294 mask[0] = 1 << a->numa_node;
295 rv = set_mempolicy (MPOL_BIND, mask, sizeof (mask) * 8 + 1);
296 if (rv == -1 && a->numa_node != 0 &&
297 (a->flags & CLIB_MEM_VM_F_NUMA_FORCE) != 0)
299 err = clib_error_return_unix (0, "set_mempolicy");
304 addr = mmap (uword_to_pointer (a->requested_va, void *), a->size,
305 (PROT_READ | PROT_WRITE), mmap_flags, fd, 0);
306 if (addr == MAP_FAILED)
308 err = clib_error_return_unix (0, "mmap");
312 /* re-apply old numa memory policy */
313 if (old_mpol != -1 &&
314 set_mempolicy (old_mpol, old_mask, sizeof (old_mask) * 8 + 1) == -1)
316 err = clib_error_return_unix (0, "set_mempolicy");
320 a->log2_page_size = log2_page_size;
321 a->n_pages = n_pages;
336 clib_mem_vm_ext_free (clib_mem_vm_alloc_t * a)
340 clib_mem_vm_free (a->addr, 1ull << a->log2_page_size);
347 clib_mem_vm_get_paddr (void *mem, int log2_page_size, int n_pages)
349 int pagesize = sysconf (_SC_PAGESIZE);
354 if ((fd = open ((char *) "/proc/self/pagemap", O_RDONLY)) == -1)
357 for (i = 0; i < n_pages; i++)
359 u64 seek, pagemap = 0;
360 uword vaddr = pointer_to_uword (mem) + (((u64) i) << log2_page_size);
361 seek = ((u64) vaddr / pagesize) * sizeof (u64);
362 if (lseek (fd, seek, SEEK_SET) != seek)
365 if (read (fd, &pagemap, sizeof (pagemap)) != (sizeof (pagemap)))
368 if ((pagemap & (1ULL << 63)) == 0)
371 pagemap &= pow2_mask (55);
372 vec_add1 (r, pagemap * pagesize);
377 if (vec_len (r) != n_pages)
386 clib_mem_vm_ext_map (clib_mem_vm_map_t * a)
388 int mmap_flags = MAP_SHARED;
392 mmap_flags |= MAP_FIXED;
394 addr = (void *) mmap (uword_to_pointer (a->requested_va, void *), a->size,
395 PROT_READ | PROT_WRITE, mmap_flags, a->fd, 0);
397 if (addr == MAP_FAILED)
398 return clib_error_return_unix (0, "mmap");
405 * fd.io coding-style-patch-verification: ON
408 * eval: (c-set-style "gnu")