1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2017-2018 Intel Corporation
14 #include <sys/types.h>
16 #include <sys/queue.h>
21 #include <sys/ioctl.h>
25 #ifdef F_ADD_SEALS /* if file sealing is supported, so is memfd */
26 #include <linux/memfd.h>
27 #define MEMFD_SUPPORTED
29 #ifdef RTE_EAL_NUMA_AWARE_HUGEPAGES
33 #include <linux/falloc.h>
34 #include <linux/mman.h> /* for hugetlb-related mmap flags */
36 #include <rte_common.h>
39 #include <rte_errno.h>
40 #include <rte_memory.h>
41 #include <rte_spinlock.h>
43 #include "eal_filesystem.h"
44 #include "eal_internal_cfg.h"
45 #include "eal_memalloc.h"
46 #include "eal_memcfg.h"
47 #include "eal_private.h"
49 const int anonymous_hugepages_supported =
52 #define RTE_MAP_HUGE_SHIFT MAP_HUGE_SHIFT
55 #define RTE_MAP_HUGE_SHIFT 26
59 * we've already checked memfd support at compile-time, but we also need to
60 * check if we can create hugepage files with memfd.
62 * also, this is not a constant, because while we may be *compiled* with memfd
63 * hugetlbfs support, we might not be *running* on a system that supports memfd
64 * and/or memfd with hugetlbfs, so we need to be able to adjust this flag at
65 * runtime, and fall back to anonymous memory.
67 static int memfd_create_supported =
70 #define RTE_MFD_HUGETLB MFD_HUGETLB
73 #define RTE_MFD_HUGETLB 4U
77 * not all kernel version support fallocate on hugetlbfs, so fall back to
78 * ftruncate and disallow deallocation if fallocate is not supported.
80 static int fallocate_supported = -1; /* unknown */
83 * we have two modes - single file segments, and file-per-page mode.
85 * for single-file segments, we use memseg_list_fd to store the segment fd,
86 * while the fds[] will not be allocated, and len will be set to 0.
88 * for file-per-page mode, each page will have its own fd, so 'memseg_list_fd'
89 * will be invalid (set to -1), and we'll use 'fds' to keep track of page fd's.
91 * we cannot know how many pages a system will have in advance, but we do know
92 * that they come in lists, and we know lengths of these lists. so, simply store
93 * a malloc'd array of fd's indexed by list and segment index.
95 * they will be initialized at startup, and filled as we allocate/deallocate
99 int *fds; /**< dynamically allocated array of segment lock fd's */
100 int memseg_list_fd; /**< memseg list fd */
101 int len; /**< total length of the array */
102 int count; /**< entries used in an array */
103 } fd_list[RTE_MAX_MEMSEG_LISTS];
105 /** local copy of a memory map, used to synchronize memory hotplug in MP */
106 static struct rte_memseg_list local_memsegs[RTE_MAX_MEMSEG_LISTS];
108 static sigjmp_buf huge_jmpenv;
110 static void __rte_unused huge_sigbus_handler(int signo __rte_unused)
112 siglongjmp(huge_jmpenv, 1);
115 /* Put setjmp into a wrap method to avoid compiling error. Any non-volatile,
116 * non-static local variable in the stack frame calling sigsetjmp might be
117 * clobbered by a call to longjmp.
119 static int __rte_unused huge_wrap_sigsetjmp(void)
121 return sigsetjmp(huge_jmpenv, 1);
124 static struct sigaction huge_action_old;
125 static int huge_need_recover;
127 static void __rte_unused
128 huge_register_sigbus(void)
131 struct sigaction action;
134 sigaddset(&mask, SIGBUS);
136 action.sa_mask = mask;
137 action.sa_handler = huge_sigbus_handler;
139 huge_need_recover = !sigaction(SIGBUS, &action, &huge_action_old);
142 static void __rte_unused
143 huge_recover_sigbus(void)
145 if (huge_need_recover) {
146 sigaction(SIGBUS, &huge_action_old, NULL);
147 huge_need_recover = 0;
151 #ifdef RTE_EAL_NUMA_AWARE_HUGEPAGES
156 /* Check if kernel supports NUMA. */
157 if (numa_available() != 0) {
158 RTE_LOG(DEBUG, EAL, "NUMA is not supported.\n");
165 prepare_numa(int *oldpolicy, struct bitmask *oldmask, int socket_id)
167 RTE_LOG(DEBUG, EAL, "Trying to obtain current memory policy.\n");
168 if (get_mempolicy(oldpolicy, oldmask->maskp,
169 oldmask->size + 1, 0, 0) < 0) {
171 "Failed to get current mempolicy: %s. "
172 "Assuming MPOL_DEFAULT.\n", strerror(errno));
173 *oldpolicy = MPOL_DEFAULT;
176 "Setting policy MPOL_PREFERRED for socket %d\n",
178 numa_set_preferred(socket_id);
182 restore_numa(int *oldpolicy, struct bitmask *oldmask)
185 "Restoring previous memory policy: %d\n", *oldpolicy);
186 if (*oldpolicy == MPOL_DEFAULT) {
187 numa_set_localalloc();
188 } else if (set_mempolicy(*oldpolicy, oldmask->maskp,
189 oldmask->size + 1) < 0) {
190 RTE_LOG(ERR, EAL, "Failed to restore mempolicy: %s\n",
192 numa_set_localalloc();
194 numa_free_cpumask(oldmask);
199 * uses fstat to report the size of a file on disk
202 get_file_size(int fd)
205 if (fstat(fd, &st) < 0)
211 pagesz_flags(uint64_t page_sz)
213 /* as per mmap() manpage, all page sizes are log2 of page size
214 * shifted by MAP_HUGE_SHIFT
216 int log2 = rte_log2_u64(page_sz);
217 return log2 << RTE_MAP_HUGE_SHIFT;
220 /* returns 1 on successful lock, 0 on unsuccessful lock, -1 on error */
221 static int lock(int fd, int type)
225 /* flock may be interrupted */
227 ret = flock(fd, type | LOCK_NB);
228 } while (ret && errno == EINTR);
230 if (ret && errno == EWOULDBLOCK) {
234 RTE_LOG(ERR, EAL, "%s(): error calling flock(): %s\n",
235 __func__, strerror(errno));
238 /* lock was successful */
243 get_seg_memfd(struct hugepage_info *hi __rte_unused,
244 unsigned int list_idx __rte_unused,
245 unsigned int seg_idx __rte_unused)
247 #ifdef MEMFD_SUPPORTED
249 char segname[250]; /* as per manpage, limit is 249 bytes plus null */
251 int flags = RTE_MFD_HUGETLB | pagesz_flags(hi->hugepage_sz);
253 if (internal_config.single_file_segments) {
254 fd = fd_list[list_idx].memseg_list_fd;
257 snprintf(segname, sizeof(segname), "seg_%i", list_idx);
258 fd = memfd_create(segname, flags);
260 RTE_LOG(DEBUG, EAL, "%s(): memfd create failed: %s\n",
261 __func__, strerror(errno));
264 fd_list[list_idx].memseg_list_fd = fd;
267 fd = fd_list[list_idx].fds[seg_idx];
270 snprintf(segname, sizeof(segname), "seg_%i-%i",
272 fd = memfd_create(segname, flags);
274 RTE_LOG(DEBUG, EAL, "%s(): memfd create failed: %s\n",
275 __func__, strerror(errno));
278 fd_list[list_idx].fds[seg_idx] = fd;
287 get_seg_fd(char *path, int buflen, struct hugepage_info *hi,
288 unsigned int list_idx, unsigned int seg_idx)
292 /* for in-memory mode, we only make it here when we're sure we support
293 * memfd, and this is a special case.
295 if (internal_config.in_memory)
296 return get_seg_memfd(hi, list_idx, seg_idx);
298 if (internal_config.single_file_segments) {
299 /* create a hugepage file path */
300 eal_get_hugefile_path(path, buflen, hi->hugedir, list_idx);
302 fd = fd_list[list_idx].memseg_list_fd;
305 fd = open(path, O_CREAT | O_RDWR, 0600);
307 RTE_LOG(ERR, EAL, "%s(): open failed: %s\n",
308 __func__, strerror(errno));
311 /* take out a read lock and keep it indefinitely */
312 if (lock(fd, LOCK_SH) < 0) {
313 RTE_LOG(ERR, EAL, "%s(): lock failed: %s\n",
314 __func__, strerror(errno));
318 fd_list[list_idx].memseg_list_fd = fd;
321 /* create a hugepage file path */
322 eal_get_hugefile_path(path, buflen, hi->hugedir,
323 list_idx * RTE_MAX_MEMSEG_PER_LIST + seg_idx);
325 fd = fd_list[list_idx].fds[seg_idx];
328 fd = open(path, O_CREAT | O_RDWR, 0600);
330 RTE_LOG(DEBUG, EAL, "%s(): open failed: %s\n",
331 __func__, strerror(errno));
334 /* take out a read lock */
335 if (lock(fd, LOCK_SH) < 0) {
336 RTE_LOG(ERR, EAL, "%s(): lock failed: %s\n",
337 __func__, strerror(errno));
341 fd_list[list_idx].fds[seg_idx] = fd;
348 resize_hugefile_in_memory(int fd, uint64_t fa_offset,
349 uint64_t page_sz, bool grow)
351 int flags = grow ? 0 : FALLOC_FL_PUNCH_HOLE |
355 /* grow or shrink the file */
356 ret = fallocate(fd, flags, fa_offset, page_sz);
359 RTE_LOG(DEBUG, EAL, "%s(): fallocate() failed: %s\n",
368 resize_hugefile_in_filesystem(int fd, uint64_t fa_offset, uint64_t page_sz,
374 if (fallocate_supported == 0) {
375 /* we cannot deallocate memory if fallocate() is not
376 * supported, and hugepage file is already locked at
377 * creation, so no further synchronization needed.
381 RTE_LOG(DEBUG, EAL, "%s(): fallocate not supported, not freeing page back to the system\n",
385 uint64_t new_size = fa_offset + page_sz;
386 uint64_t cur_size = get_file_size(fd);
388 /* fallocate isn't supported, fall back to ftruncate */
389 if (new_size > cur_size &&
390 ftruncate(fd, new_size) < 0) {
391 RTE_LOG(DEBUG, EAL, "%s(): ftruncate() failed: %s\n",
392 __func__, strerror(errno));
396 int flags = grow ? 0 : FALLOC_FL_PUNCH_HOLE |
401 * technically, it is perfectly safe for both primary
402 * and secondary to grow and shrink the page files:
403 * growing the file repeatedly has no effect because
404 * a page can only be allocated once, while mmap ensures
405 * that secondaries hold on to the page even after the
406 * page itself is removed from the filesystem.
408 * however, leaving growing/shrinking to the primary
409 * tends to expose bugs in fdlist page count handling,
410 * so leave this here just in case.
412 if (rte_eal_process_type() != RTE_PROC_PRIMARY)
415 /* grow or shrink the file */
416 ret = fallocate(fd, flags, fa_offset, page_sz);
419 if (fallocate_supported == -1 &&
421 RTE_LOG(ERR, EAL, "%s(): fallocate() not supported, hugepage deallocation will be disabled\n",
424 fallocate_supported = 0;
426 RTE_LOG(DEBUG, EAL, "%s(): fallocate() failed: %s\n",
432 fallocate_supported = 1;
440 close_hugefile(int fd, char *path, int list_idx)
443 * primary process must unlink the file, but only when not in in-memory
444 * mode (as in that case there is no file to unlink).
446 if (!internal_config.in_memory &&
447 rte_eal_process_type() == RTE_PROC_PRIMARY &&
449 RTE_LOG(ERR, EAL, "%s(): unlinking '%s' failed: %s\n",
450 __func__, path, strerror(errno));
453 fd_list[list_idx].memseg_list_fd = -1;
457 resize_hugefile(int fd, uint64_t fa_offset, uint64_t page_sz, bool grow)
459 /* in-memory mode is a special case, because we can be sure that
460 * fallocate() is supported.
462 if (internal_config.in_memory)
463 return resize_hugefile_in_memory(fd, fa_offset,
466 return resize_hugefile_in_filesystem(fd, fa_offset, page_sz,
471 alloc_seg(struct rte_memseg *ms, void *addr, int socket_id,
472 struct hugepage_info *hi, unsigned int list_idx,
473 unsigned int seg_idx)
475 #ifdef RTE_EAL_NUMA_AWARE_HUGEPAGES
476 int cur_socket_id = 0;
488 alloc_sz = hi->hugepage_sz;
490 /* these are checked at init, but code analyzers don't know that */
491 if (internal_config.in_memory && !anonymous_hugepages_supported) {
492 RTE_LOG(ERR, EAL, "Anonymous hugepages not supported, in-memory mode cannot allocate memory\n");
495 if (internal_config.in_memory && !memfd_create_supported &&
496 internal_config.single_file_segments) {
497 RTE_LOG(ERR, EAL, "Single-file segments are not supported without memfd support\n");
501 /* in-memory without memfd is a special case */
504 if (internal_config.in_memory && !memfd_create_supported) {
505 const int in_memory_flags = MAP_HUGETLB | MAP_FIXED |
506 MAP_PRIVATE | MAP_ANONYMOUS;
509 pagesz_flag = pagesz_flags(alloc_sz);
511 mmap_flags = in_memory_flags | pagesz_flag;
513 /* single-file segments codepath will never be active
514 * here because in-memory mode is incompatible with the
515 * fallback path, and it's stopped at EAL initialization
520 /* takes out a read lock on segment or segment list */
521 fd = get_seg_fd(path, sizeof(path), hi, list_idx, seg_idx);
523 RTE_LOG(ERR, EAL, "Couldn't get fd on hugepage file\n");
527 if (internal_config.single_file_segments) {
528 map_offset = seg_idx * alloc_sz;
529 ret = resize_hugefile(fd, map_offset, alloc_sz, true);
533 fd_list[list_idx].count++;
536 if (ftruncate(fd, alloc_sz) < 0) {
537 RTE_LOG(DEBUG, EAL, "%s(): ftruncate() failed: %s\n",
538 __func__, strerror(errno));
541 if (internal_config.hugepage_unlink &&
542 !internal_config.in_memory) {
544 RTE_LOG(DEBUG, EAL, "%s(): unlink() failed: %s\n",
545 __func__, strerror(errno));
550 mmap_flags = MAP_SHARED | MAP_POPULATE | MAP_FIXED;
554 * map the segment, and populate page tables, the kernel fills
555 * this segment with zeros if it's a new page.
557 va = mmap(addr, alloc_sz, PROT_READ | PROT_WRITE, mmap_flags, fd,
560 if (va == MAP_FAILED) {
561 RTE_LOG(DEBUG, EAL, "%s(): mmap() failed: %s\n", __func__,
563 /* mmap failed, but the previous region might have been
564 * unmapped anyway. try to remap it
569 RTE_LOG(DEBUG, EAL, "%s(): wrong mmap() address\n", __func__);
570 munmap(va, alloc_sz);
574 /* In linux, hugetlb limitations, like cgroup, are
575 * enforced at fault time instead of mmap(), even
576 * with the option of MAP_POPULATE. Kernel will send
577 * a SIGBUS signal. To avoid to be killed, save stack
578 * environment here, if SIGBUS happens, we can jump
581 if (huge_wrap_sigsetjmp()) {
582 RTE_LOG(DEBUG, EAL, "SIGBUS: Cannot mmap more hugepages of size %uMB\n",
583 (unsigned int)(alloc_sz >> 20));
587 /* we need to trigger a write to the page to enforce page fault and
588 * ensure that page is accessible to us, but we can't overwrite value
589 * that is already there, so read the old value, and write itback.
590 * kernel populates the page with zeroes initially.
592 *(volatile int *)addr = *(volatile int *)addr;
594 iova = rte_mem_virt2iova(addr);
595 if (iova == RTE_BAD_PHYS_ADDR) {
596 RTE_LOG(DEBUG, EAL, "%s(): can't get IOVA addr\n",
601 #ifdef RTE_EAL_NUMA_AWARE_HUGEPAGES
602 ret = get_mempolicy(&cur_socket_id, NULL, 0, addr,
603 MPOL_F_NODE | MPOL_F_ADDR);
605 RTE_LOG(DEBUG, EAL, "%s(): get_mempolicy: %s\n",
606 __func__, strerror(errno));
608 } else if (cur_socket_id != socket_id) {
610 "%s(): allocation happened on wrong socket (wanted %d, got %d)\n",
611 __func__, socket_id, cur_socket_id);
615 if (rte_socket_count() > 1)
616 RTE_LOG(DEBUG, EAL, "%s(): not checking hugepage NUMA node.\n",
621 ms->hugepage_sz = alloc_sz;
623 ms->nchannel = rte_memory_get_nchannel();
624 ms->nrank = rte_memory_get_nrank();
626 ms->socket_id = socket_id;
631 munmap(addr, alloc_sz);
634 new_addr = eal_get_virtual_area(addr, &alloc_sz, alloc_sz, 0, flags);
635 if (new_addr != addr) {
636 if (new_addr != NULL)
637 munmap(new_addr, alloc_sz);
638 /* we're leaving a hole in our virtual address space. if
639 * somebody else maps this hole now, we could accidentally
640 * override it in the future.
642 RTE_LOG(CRIT, EAL, "Can't mmap holes in our virtual address space\n");
644 /* roll back the ref count */
645 if (internal_config.single_file_segments)
646 fd_list[list_idx].count--;
648 /* some codepaths will return negative fd, so exit early */
652 if (internal_config.single_file_segments) {
653 resize_hugefile(fd, map_offset, alloc_sz, false);
654 /* ignore failure, can't make it any worse */
656 /* if refcount is at zero, close the file */
657 if (fd_list[list_idx].count == 0)
658 close_hugefile(fd, path, list_idx);
660 /* only remove file if we can take out a write lock */
661 if (internal_config.hugepage_unlink == 0 &&
662 internal_config.in_memory == 0 &&
663 lock(fd, LOCK_EX) == 1)
666 fd_list[list_idx].fds[seg_idx] = -1;
672 free_seg(struct rte_memseg *ms, struct hugepage_info *hi,
673 unsigned int list_idx, unsigned int seg_idx)
680 /* erase page data */
681 memset(ms->addr, 0, ms->len);
683 if (mmap(ms->addr, ms->len, PROT_READ,
684 MAP_PRIVATE | MAP_ANONYMOUS | MAP_FIXED, -1, 0) ==
686 RTE_LOG(DEBUG, EAL, "couldn't unmap page\n");
692 /* if we're using anonymous hugepages, nothing to be done */
693 if (internal_config.in_memory && !memfd_create_supported)
696 /* if we've already unlinked the page, nothing needs to be done */
697 if (!internal_config.in_memory && internal_config.hugepage_unlink)
701 memset(ms, 0, sizeof(*ms));
705 /* if we are not in single file segments mode, we're going to unmap the
706 * segment and thus drop the lock on original fd, but hugepage dir is
707 * now locked so we can take out another one without races.
709 fd = get_seg_fd(path, sizeof(path), hi, list_idx, seg_idx);
713 if (internal_config.single_file_segments) {
714 map_offset = seg_idx * ms->len;
715 if (resize_hugefile(fd, map_offset, ms->len, false))
718 if (--(fd_list[list_idx].count) == 0)
719 close_hugefile(fd, path, list_idx);
723 /* if we're able to take out a write lock, we're the last one
724 * holding onto this page.
726 if (!internal_config.in_memory) {
727 ret = lock(fd, LOCK_EX);
729 /* no one else is using this page */
734 /* closing fd will drop the lock */
736 fd_list[list_idx].fds[seg_idx] = -1;
739 memset(ms, 0, sizeof(*ms));
741 return ret < 0 ? -1 : 0;
744 struct alloc_walk_param {
745 struct hugepage_info *hi;
746 struct rte_memseg **ms;
748 unsigned int segs_allocated;
754 alloc_seg_walk(const struct rte_memseg_list *msl, void *arg)
756 struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
757 struct alloc_walk_param *wa = arg;
758 struct rte_memseg_list *cur_msl;
760 int cur_idx, start_idx, j, dir_fd = -1;
761 unsigned int msl_idx, need, i;
763 if (msl->page_sz != wa->page_sz)
765 if (msl->socket_id != wa->socket)
768 page_sz = (size_t)msl->page_sz;
770 msl_idx = msl - mcfg->memsegs;
771 cur_msl = &mcfg->memsegs[msl_idx];
775 /* try finding space in memseg list */
777 /* if we require exact number of pages in a list, find them */
778 cur_idx = rte_fbarray_find_next_n_free(&cur_msl->memseg_arr, 0,
786 /* we don't require exact number of pages, so we're going to go
787 * for best-effort allocation. that means finding the biggest
788 * unused block, and going with that.
790 cur_idx = rte_fbarray_find_biggest_free(&cur_msl->memseg_arr,
795 /* adjust the size to possibly be smaller than original
796 * request, but do not allow it to be bigger.
798 cur_len = rte_fbarray_find_contig_free(&cur_msl->memseg_arr,
800 need = RTE_MIN(need, (unsigned int)cur_len);
803 /* do not allow any page allocations during the time we're allocating,
804 * because file creation and locking operations are not atomic,
805 * and we might be the first or the last ones to use a particular page,
806 * so we need to ensure atomicity of every operation.
808 * during init, we already hold a write lock, so don't try to take out
811 if (wa->hi->lock_descriptor == -1 && !internal_config.in_memory) {
812 dir_fd = open(wa->hi->hugedir, O_RDONLY);
814 RTE_LOG(ERR, EAL, "%s(): Cannot open '%s': %s\n",
815 __func__, wa->hi->hugedir, strerror(errno));
818 /* blocking writelock */
819 if (flock(dir_fd, LOCK_EX)) {
820 RTE_LOG(ERR, EAL, "%s(): Cannot lock '%s': %s\n",
821 __func__, wa->hi->hugedir, strerror(errno));
827 for (i = 0; i < need; i++, cur_idx++) {
828 struct rte_memseg *cur;
831 cur = rte_fbarray_get(&cur_msl->memseg_arr, cur_idx);
832 map_addr = RTE_PTR_ADD(cur_msl->base_va,
835 if (alloc_seg(cur, map_addr, wa->socket, wa->hi,
837 RTE_LOG(DEBUG, EAL, "attempted to allocate %i segments, but only %i were allocated\n",
840 /* if exact number wasn't requested, stop */
845 for (j = start_idx; j < cur_idx; j++) {
846 struct rte_memseg *tmp;
847 struct rte_fbarray *arr =
848 &cur_msl->memseg_arr;
850 tmp = rte_fbarray_get(arr, j);
851 rte_fbarray_set_free(arr, j);
853 /* free_seg may attempt to create a file, which
856 if (free_seg(tmp, wa->hi, msl_idx, j))
857 RTE_LOG(DEBUG, EAL, "Cannot free page\n");
861 memset(wa->ms, 0, sizeof(*wa->ms) * wa->n_segs);
870 rte_fbarray_set_used(&cur_msl->memseg_arr, cur_idx);
873 wa->segs_allocated = i;
878 /* if we didn't allocate any segments, move on to the next list */
882 struct free_walk_param {
883 struct hugepage_info *hi;
884 struct rte_memseg *ms;
887 free_seg_walk(const struct rte_memseg_list *msl, void *arg)
889 struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
890 struct rte_memseg_list *found_msl;
891 struct free_walk_param *wa = arg;
892 uintptr_t start_addr, end_addr;
893 int msl_idx, seg_idx, ret, dir_fd = -1;
895 start_addr = (uintptr_t) msl->base_va;
896 end_addr = start_addr + msl->len;
898 if ((uintptr_t)wa->ms->addr < start_addr ||
899 (uintptr_t)wa->ms->addr >= end_addr)
902 msl_idx = msl - mcfg->memsegs;
903 seg_idx = RTE_PTR_DIFF(wa->ms->addr, start_addr) / msl->page_sz;
906 found_msl = &mcfg->memsegs[msl_idx];
908 /* do not allow any page allocations during the time we're freeing,
909 * because file creation and locking operations are not atomic,
910 * and we might be the first or the last ones to use a particular page,
911 * so we need to ensure atomicity of every operation.
913 * during init, we already hold a write lock, so don't try to take out
916 if (wa->hi->lock_descriptor == -1 && !internal_config.in_memory) {
917 dir_fd = open(wa->hi->hugedir, O_RDONLY);
919 RTE_LOG(ERR, EAL, "%s(): Cannot open '%s': %s\n",
920 __func__, wa->hi->hugedir, strerror(errno));
923 /* blocking writelock */
924 if (flock(dir_fd, LOCK_EX)) {
925 RTE_LOG(ERR, EAL, "%s(): Cannot lock '%s': %s\n",
926 __func__, wa->hi->hugedir, strerror(errno));
932 found_msl->version++;
934 rte_fbarray_set_free(&found_msl->memseg_arr, seg_idx);
936 ret = free_seg(wa->ms, wa->hi, msl_idx, seg_idx);
948 eal_memalloc_alloc_seg_bulk(struct rte_memseg **ms, int n_segs, size_t page_sz,
949 int socket, bool exact)
952 #ifdef RTE_EAL_NUMA_AWARE_HUGEPAGES
953 bool have_numa = false;
955 struct bitmask *oldmask;
957 struct alloc_walk_param wa;
958 struct hugepage_info *hi = NULL;
960 memset(&wa, 0, sizeof(wa));
962 /* dynamic allocation not supported in legacy mode */
963 if (internal_config.legacy_mem)
966 for (i = 0; i < (int) RTE_DIM(internal_config.hugepage_info); i++) {
968 internal_config.hugepage_info[i].hugepage_sz) {
969 hi = &internal_config.hugepage_info[i];
974 RTE_LOG(ERR, EAL, "%s(): can't find relevant hugepage_info entry\n",
979 #ifdef RTE_EAL_NUMA_AWARE_HUGEPAGES
981 oldmask = numa_allocate_nodemask();
982 prepare_numa(&oldpolicy, oldmask, socket);
991 wa.page_sz = page_sz;
993 wa.segs_allocated = 0;
995 /* memalloc is locked, so it's safe to use thread-unsafe version */
996 ret = rte_memseg_list_walk_thread_unsafe(alloc_seg_walk, &wa);
998 RTE_LOG(ERR, EAL, "%s(): couldn't find suitable memseg_list\n",
1001 } else if (ret > 0) {
1002 ret = (int)wa.segs_allocated;
1005 #ifdef RTE_EAL_NUMA_AWARE_HUGEPAGES
1007 restore_numa(&oldpolicy, oldmask);
1013 eal_memalloc_alloc_seg(size_t page_sz, int socket)
1015 struct rte_memseg *ms;
1016 if (eal_memalloc_alloc_seg_bulk(&ms, 1, page_sz, socket, true) < 0)
1018 /* return pointer to newly allocated memseg */
1023 eal_memalloc_free_seg_bulk(struct rte_memseg **ms, int n_segs)
1027 /* dynamic free not supported in legacy mode */
1028 if (internal_config.legacy_mem)
1031 for (seg = 0; seg < n_segs; seg++) {
1032 struct rte_memseg *cur = ms[seg];
1033 struct hugepage_info *hi = NULL;
1034 struct free_walk_param wa;
1037 /* if this page is marked as unfreeable, fail */
1038 if (cur->flags & RTE_MEMSEG_FLAG_DO_NOT_FREE) {
1039 RTE_LOG(DEBUG, EAL, "Page is not allowed to be freed\n");
1044 memset(&wa, 0, sizeof(wa));
1046 for (i = 0; i < (int)RTE_DIM(internal_config.hugepage_info);
1048 hi = &internal_config.hugepage_info[i];
1049 if (cur->hugepage_sz == hi->hugepage_sz)
1052 if (i == (int)RTE_DIM(internal_config.hugepage_info)) {
1053 RTE_LOG(ERR, EAL, "Can't find relevant hugepage_info entry\n");
1061 /* memalloc is locked, so it's safe to use thread-unsafe version
1063 walk_res = rte_memseg_list_walk_thread_unsafe(free_seg_walk,
1068 RTE_LOG(ERR, EAL, "Couldn't find memseg list\n");
1075 eal_memalloc_free_seg(struct rte_memseg *ms)
1077 /* dynamic free not supported in legacy mode */
1078 if (internal_config.legacy_mem)
1081 return eal_memalloc_free_seg_bulk(&ms, 1);
1085 sync_chunk(struct rte_memseg_list *primary_msl,
1086 struct rte_memseg_list *local_msl, struct hugepage_info *hi,
1087 unsigned int msl_idx, bool used, int start, int end)
1089 struct rte_fbarray *l_arr, *p_arr;
1090 int i, ret, chunk_len, diff_len;
1092 l_arr = &local_msl->memseg_arr;
1093 p_arr = &primary_msl->memseg_arr;
1095 /* we need to aggregate allocations/deallocations into bigger chunks,
1096 * as we don't want to spam the user with per-page callbacks.
1098 * to avoid any potential issues, we also want to trigger
1099 * deallocation callbacks *before* we actually deallocate
1100 * memory, so that the user application could wrap up its use
1101 * before it goes away.
1104 chunk_len = end - start;
1106 /* find how many contiguous pages we can map/unmap for this chunk */
1108 rte_fbarray_find_contig_free(l_arr, start) :
1109 rte_fbarray_find_contig_used(l_arr, start);
1111 /* has to be at least one page */
1115 diff_len = RTE_MIN(chunk_len, diff_len);
1117 /* if we are freeing memory, notify the application */
1119 struct rte_memseg *ms;
1121 size_t len, page_sz;
1123 ms = rte_fbarray_get(l_arr, start);
1124 start_va = ms->addr;
1125 page_sz = (size_t)primary_msl->page_sz;
1126 len = page_sz * diff_len;
1128 eal_memalloc_mem_event_notify(RTE_MEM_EVENT_FREE,
1132 for (i = 0; i < diff_len; i++) {
1133 struct rte_memseg *p_ms, *l_ms;
1134 int seg_idx = start + i;
1136 l_ms = rte_fbarray_get(l_arr, seg_idx);
1137 p_ms = rte_fbarray_get(p_arr, seg_idx);
1139 if (l_ms == NULL || p_ms == NULL)
1143 ret = alloc_seg(l_ms, p_ms->addr,
1144 p_ms->socket_id, hi,
1148 rte_fbarray_set_used(l_arr, seg_idx);
1150 ret = free_seg(l_ms, hi, msl_idx, seg_idx);
1151 rte_fbarray_set_free(l_arr, seg_idx);
1157 /* if we just allocated memory, notify the application */
1159 struct rte_memseg *ms;
1161 size_t len, page_sz;
1163 ms = rte_fbarray_get(l_arr, start);
1164 start_va = ms->addr;
1165 page_sz = (size_t)primary_msl->page_sz;
1166 len = page_sz * diff_len;
1168 eal_memalloc_mem_event_notify(RTE_MEM_EVENT_ALLOC,
1172 /* calculate how much we can advance until next chunk */
1174 rte_fbarray_find_contig_used(l_arr, start) :
1175 rte_fbarray_find_contig_free(l_arr, start);
1176 ret = RTE_MIN(chunk_len, diff_len);
1182 sync_status(struct rte_memseg_list *primary_msl,
1183 struct rte_memseg_list *local_msl, struct hugepage_info *hi,
1184 unsigned int msl_idx, bool used)
1186 struct rte_fbarray *l_arr, *p_arr;
1187 int p_idx, l_chunk_len, p_chunk_len, ret;
1190 /* this is a little bit tricky, but the basic idea is - walk both lists
1191 * and spot any places where there are discrepancies. walking both lists
1192 * and noting discrepancies in a single go is a hard problem, so we do
1193 * it in two passes - first we spot any places where allocated segments
1194 * mismatch (i.e. ensure that everything that's allocated in the primary
1195 * is also allocated in the secondary), and then we do it by looking at
1196 * free segments instead.
1198 * we also need to aggregate changes into chunks, as we have to call
1199 * callbacks per allocation, not per page.
1201 l_arr = &local_msl->memseg_arr;
1202 p_arr = &primary_msl->memseg_arr;
1205 p_idx = rte_fbarray_find_next_used(p_arr, 0);
1207 p_idx = rte_fbarray_find_next_free(p_arr, 0);
1209 while (p_idx >= 0) {
1210 int next_chunk_search_idx;
1213 p_chunk_len = rte_fbarray_find_contig_used(p_arr,
1215 l_chunk_len = rte_fbarray_find_contig_used(l_arr,
1218 p_chunk_len = rte_fbarray_find_contig_free(p_arr,
1220 l_chunk_len = rte_fbarray_find_contig_free(l_arr,
1223 /* best case scenario - no differences (or bigger, which will be
1224 * fixed during next iteration), look for next chunk
1226 if (l_chunk_len >= p_chunk_len) {
1227 next_chunk_search_idx = p_idx + p_chunk_len;
1231 /* if both chunks start at the same point, skip parts we know
1232 * are identical, and sync the rest. each call to sync_chunk
1233 * will only sync contiguous segments, so we need to call this
1234 * until we are sure there are no more differences in this
1237 start = p_idx + l_chunk_len;
1238 end = p_idx + p_chunk_len;
1240 ret = sync_chunk(primary_msl, local_msl, hi, msl_idx,
1243 } while (start < end && ret >= 0);
1244 /* if ret is negative, something went wrong */
1248 next_chunk_search_idx = p_idx + p_chunk_len;
1250 /* skip to end of this chunk */
1252 p_idx = rte_fbarray_find_next_used(p_arr,
1253 next_chunk_search_idx);
1255 p_idx = rte_fbarray_find_next_free(p_arr,
1256 next_chunk_search_idx);
1263 sync_existing(struct rte_memseg_list *primary_msl,
1264 struct rte_memseg_list *local_msl, struct hugepage_info *hi,
1265 unsigned int msl_idx)
1269 /* do not allow any page allocations during the time we're allocating,
1270 * because file creation and locking operations are not atomic,
1271 * and we might be the first or the last ones to use a particular page,
1272 * so we need to ensure atomicity of every operation.
1274 dir_fd = open(hi->hugedir, O_RDONLY);
1276 RTE_LOG(ERR, EAL, "%s(): Cannot open '%s': %s\n", __func__,
1277 hi->hugedir, strerror(errno));
1280 /* blocking writelock */
1281 if (flock(dir_fd, LOCK_EX)) {
1282 RTE_LOG(ERR, EAL, "%s(): Cannot lock '%s': %s\n", __func__,
1283 hi->hugedir, strerror(errno));
1288 /* ensure all allocated space is the same in both lists */
1289 ret = sync_status(primary_msl, local_msl, hi, msl_idx, true);
1293 /* ensure all unallocated space is the same in both lists */
1294 ret = sync_status(primary_msl, local_msl, hi, msl_idx, false);
1298 /* update version number */
1299 local_msl->version = primary_msl->version;
1310 sync_walk(const struct rte_memseg_list *msl, void *arg __rte_unused)
1312 struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
1313 struct rte_memseg_list *primary_msl, *local_msl;
1314 struct hugepage_info *hi = NULL;
1321 msl_idx = msl - mcfg->memsegs;
1322 primary_msl = &mcfg->memsegs[msl_idx];
1323 local_msl = &local_memsegs[msl_idx];
1325 for (i = 0; i < RTE_DIM(internal_config.hugepage_info); i++) {
1327 internal_config.hugepage_info[i].hugepage_sz;
1328 uint64_t msl_sz = primary_msl->page_sz;
1329 if (msl_sz == cur_sz) {
1330 hi = &internal_config.hugepage_info[i];
1335 RTE_LOG(ERR, EAL, "Can't find relevant hugepage_info entry\n");
1339 /* if versions don't match, synchronize everything */
1340 if (local_msl->version != primary_msl->version &&
1341 sync_existing(primary_msl, local_msl, hi, msl_idx))
1348 eal_memalloc_sync_with_primary(void)
1350 /* nothing to be done in primary */
1351 if (rte_eal_process_type() == RTE_PROC_PRIMARY)
1354 /* memalloc is locked, so it's safe to call thread-unsafe version */
1355 if (rte_memseg_list_walk_thread_unsafe(sync_walk, NULL))
1361 secondary_msl_create_walk(const struct rte_memseg_list *msl,
1362 void *arg __rte_unused)
1364 struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
1365 struct rte_memseg_list *primary_msl, *local_msl;
1366 char name[PATH_MAX];
1372 msl_idx = msl - mcfg->memsegs;
1373 primary_msl = &mcfg->memsegs[msl_idx];
1374 local_msl = &local_memsegs[msl_idx];
1376 /* create distinct fbarrays for each secondary */
1377 snprintf(name, RTE_FBARRAY_NAME_LEN, "%s_%i",
1378 primary_msl->memseg_arr.name, getpid());
1380 ret = rte_fbarray_init(&local_msl->memseg_arr, name,
1381 primary_msl->memseg_arr.len,
1382 primary_msl->memseg_arr.elt_sz);
1384 RTE_LOG(ERR, EAL, "Cannot initialize local memory map\n");
1387 local_msl->base_va = primary_msl->base_va;
1388 local_msl->len = primary_msl->len;
1394 alloc_list(int list_idx, int len)
1399 /* single-file segments mode does not need fd list */
1400 if (!internal_config.single_file_segments) {
1401 /* ensure we have space to store fd per each possible segment */
1402 data = malloc(sizeof(int) * len);
1404 RTE_LOG(ERR, EAL, "Unable to allocate space for file descriptors\n");
1407 /* set all fd's as invalid */
1408 for (i = 0; i < len; i++)
1410 fd_list[list_idx].fds = data;
1411 fd_list[list_idx].len = len;
1413 fd_list[list_idx].fds = NULL;
1414 fd_list[list_idx].len = 0;
1417 fd_list[list_idx].count = 0;
1418 fd_list[list_idx].memseg_list_fd = -1;
1424 fd_list_create_walk(const struct rte_memseg_list *msl,
1425 void *arg __rte_unused)
1427 struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
1434 msl_idx = msl - mcfg->memsegs;
1435 len = msl->memseg_arr.len;
1437 return alloc_list(msl_idx, len);
1441 eal_memalloc_set_seg_fd(int list_idx, int seg_idx, int fd)
1443 struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
1445 /* single file segments mode doesn't support individual segment fd's */
1446 if (internal_config.single_file_segments)
1449 /* if list is not allocated, allocate it */
1450 if (fd_list[list_idx].len == 0) {
1451 int len = mcfg->memsegs[list_idx].memseg_arr.len;
1453 if (alloc_list(list_idx, len) < 0)
1456 fd_list[list_idx].fds[seg_idx] = fd;
1462 eal_memalloc_set_seg_list_fd(int list_idx, int fd)
1464 /* non-single file segment mode doesn't support segment list fd's */
1465 if (!internal_config.single_file_segments)
1468 fd_list[list_idx].memseg_list_fd = fd;
1474 eal_memalloc_get_seg_fd(int list_idx, int seg_idx)
1478 if (internal_config.in_memory || internal_config.no_hugetlbfs) {
1479 #ifndef MEMFD_SUPPORTED
1480 /* in in-memory or no-huge mode, we rely on memfd support */
1483 /* memfd supported, but hugetlbfs memfd may not be */
1484 if (!internal_config.no_hugetlbfs && !memfd_create_supported)
1488 if (internal_config.single_file_segments) {
1489 fd = fd_list[list_idx].memseg_list_fd;
1490 } else if (fd_list[list_idx].len == 0) {
1491 /* list not initialized */
1494 fd = fd_list[list_idx].fds[seg_idx];
1502 test_memfd_create(void)
1504 #ifdef MEMFD_SUPPORTED
1506 for (i = 0; i < internal_config.num_hugepage_sizes; i++) {
1507 uint64_t pagesz = internal_config.hugepage_info[i].hugepage_sz;
1508 int pagesz_flag = pagesz_flags(pagesz);
1511 flags = pagesz_flag | RTE_MFD_HUGETLB;
1512 int fd = memfd_create("test", flags);
1514 /* we failed - let memalloc know this isn't working */
1515 if (errno == EINVAL) {
1516 memfd_create_supported = 0;
1517 return 0; /* not supported */
1520 /* we got other error - something's wrong */
1521 return -1; /* error */
1524 return 1; /* supported */
1527 return 0; /* not supported */
1531 eal_memalloc_get_seg_fd_offset(int list_idx, int seg_idx, size_t *offset)
1533 struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
1535 if (internal_config.in_memory || internal_config.no_hugetlbfs) {
1536 #ifndef MEMFD_SUPPORTED
1537 /* in in-memory or no-huge mode, we rely on memfd support */
1540 /* memfd supported, but hugetlbfs memfd may not be */
1541 if (!internal_config.no_hugetlbfs && !memfd_create_supported)
1545 if (internal_config.single_file_segments) {
1546 size_t pgsz = mcfg->memsegs[list_idx].page_sz;
1548 /* segment not active? */
1549 if (fd_list[list_idx].memseg_list_fd < 0)
1551 *offset = pgsz * seg_idx;
1553 /* fd_list not initialized? */
1554 if (fd_list[list_idx].len == 0)
1557 /* segment not active? */
1558 if (fd_list[list_idx].fds[seg_idx] < 0)
1566 eal_memalloc_init(void)
1568 if (rte_eal_process_type() == RTE_PROC_SECONDARY)
1569 if (rte_memseg_list_walk(secondary_msl_create_walk, NULL) < 0)
1571 if (rte_eal_process_type() == RTE_PROC_PRIMARY &&
1572 internal_config.in_memory) {
1573 int mfd_res = test_memfd_create();
1576 RTE_LOG(ERR, EAL, "Unable to check if memfd is supported\n");
1580 RTE_LOG(DEBUG, EAL, "Using memfd for anonymous memory\n");
1582 RTE_LOG(INFO, EAL, "Using memfd is not supported, falling back to anonymous hugepages\n");
1584 /* we only support single-file segments mode with in-memory mode
1585 * if we support hugetlbfs with memfd_create. this code will
1588 if (internal_config.single_file_segments &&
1590 RTE_LOG(ERR, EAL, "Single-file segments mode cannot be used without memfd support\n");
1593 /* this cannot ever happen but better safe than sorry */
1594 if (!anonymous_hugepages_supported) {
1595 RTE_LOG(ERR, EAL, "Using anonymous memory is not supported\n");
1600 /* initialize all of the fd lists */
1601 if (rte_memseg_list_walk(fd_list_create_walk, NULL))