eal: refactor --huge-unlink storage
[dpdk.git] / lib / eal / linux / eal_memalloc.c
1 /* SPDX-License-Identifier: BSD-3-Clause
2  * Copyright(c) 2017-2018 Intel Corporation
3  */
4
5 #include <errno.h>
6 #include <stdarg.h>
7 #include <stdbool.h>
8 #include <stdlib.h>
9 #include <stdio.h>
10 #include <stdint.h>
11 #include <inttypes.h>
12 #include <string.h>
13 #include <sys/mman.h>
14 #include <sys/types.h>
15 #include <sys/stat.h>
16 #include <sys/queue.h>
17 #include <sys/file.h>
18 #include <unistd.h>
19 #include <limits.h>
20 #include <fcntl.h>
21 #include <sys/ioctl.h>
22 #include <sys/time.h>
23 #include <signal.h>
24 #include <setjmp.h>
25 #ifdef F_ADD_SEALS /* if file sealing is supported, so is memfd */
26 #include <linux/memfd.h>
27 #define MEMFD_SUPPORTED
28 #endif
29 #ifdef RTE_EAL_NUMA_AWARE_HUGEPAGES
30 #include <numa.h>
31 #include <numaif.h>
32 #endif
33 #include <linux/falloc.h>
34 #include <linux/mman.h> /* for hugetlb-related mmap flags */
35
36 #include <rte_common.h>
37 #include <rte_log.h>
38 #include <rte_eal.h>
39 #include <rte_errno.h>
40 #include <rte_memory.h>
41 #include <rte_spinlock.h>
42
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"
48
49 const int anonymous_hugepages_supported =
50 #ifdef MAP_HUGE_SHIFT
51                 1;
52 #define RTE_MAP_HUGE_SHIFT MAP_HUGE_SHIFT
53 #else
54                 0;
55 #define RTE_MAP_HUGE_SHIFT 26
56 #endif
57
58 /*
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.
61  *
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.
66  */
67 static int memfd_create_supported =
68 #ifdef MFD_HUGETLB
69                 1;
70 #define RTE_MFD_HUGETLB MFD_HUGETLB
71 #else
72                 0;
73 #define RTE_MFD_HUGETLB 4U
74 #endif
75
76 /*
77  * not all kernel version support fallocate on hugetlbfs, so fall back to
78  * ftruncate and disallow deallocation if fallocate is not supported.
79  */
80 static int fallocate_supported = -1; /* unknown */
81
82 /*
83  * we have two modes - single file segments, and file-per-page mode.
84  *
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.
87  *
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.
90  *
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.
94  *
95  * they will be initialized at startup, and filled as we allocate/deallocate
96  * segments.
97  */
98 static struct {
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];
104
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];
107
108 static sigjmp_buf huge_jmpenv;
109
110 static void huge_sigbus_handler(int signo __rte_unused)
111 {
112         siglongjmp(huge_jmpenv, 1);
113 }
114
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.
118  */
119 static int huge_wrap_sigsetjmp(void)
120 {
121         return sigsetjmp(huge_jmpenv, 1);
122 }
123
124 static struct sigaction huge_action_old;
125 static int huge_need_recover;
126
127 static void
128 huge_register_sigbus(void)
129 {
130         sigset_t mask;
131         struct sigaction action;
132
133         sigemptyset(&mask);
134         sigaddset(&mask, SIGBUS);
135         action.sa_flags = 0;
136         action.sa_mask = mask;
137         action.sa_handler = huge_sigbus_handler;
138
139         huge_need_recover = !sigaction(SIGBUS, &action, &huge_action_old);
140 }
141
142 static void
143 huge_recover_sigbus(void)
144 {
145         if (huge_need_recover) {
146                 sigaction(SIGBUS, &huge_action_old, NULL);
147                 huge_need_recover = 0;
148         }
149 }
150
151 #ifdef RTE_EAL_NUMA_AWARE_HUGEPAGES
152 static bool
153 check_numa(void)
154 {
155         bool ret = true;
156         /* Check if kernel supports NUMA. */
157         if (numa_available() != 0) {
158                 RTE_LOG(DEBUG, EAL, "NUMA is not supported.\n");
159                 ret = false;
160         }
161         return ret;
162 }
163
164 static void
165 prepare_numa(int *oldpolicy, struct bitmask *oldmask, int socket_id)
166 {
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) {
170                 RTE_LOG(ERR, EAL,
171                         "Failed to get current mempolicy: %s. "
172                         "Assuming MPOL_DEFAULT.\n", strerror(errno));
173                 *oldpolicy = MPOL_DEFAULT;
174         }
175         RTE_LOG(DEBUG, EAL,
176                 "Setting policy MPOL_PREFERRED for socket %d\n",
177                 socket_id);
178         numa_set_preferred(socket_id);
179 }
180
181 static void
182 restore_numa(int *oldpolicy, struct bitmask *oldmask)
183 {
184         RTE_LOG(DEBUG, EAL,
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",
191                         strerror(errno));
192                 numa_set_localalloc();
193         }
194         numa_free_cpumask(oldmask);
195 }
196 #endif
197
198 /*
199  * uses fstat to report the size of a file on disk
200  */
201 static off_t
202 get_file_size(int fd)
203 {
204         struct stat st;
205         if (fstat(fd, &st) < 0)
206                 return 0;
207         return st.st_size;
208 }
209
210 static int
211 pagesz_flags(uint64_t page_sz)
212 {
213         /* as per mmap() manpage, all page sizes are log2 of page size
214          * shifted by MAP_HUGE_SHIFT
215          */
216         int log2 = rte_log2_u64(page_sz);
217         return log2 << RTE_MAP_HUGE_SHIFT;
218 }
219
220 /* returns 1 on successful lock, 0 on unsuccessful lock, -1 on error */
221 static int lock(int fd, int type)
222 {
223         int ret;
224
225         /* flock may be interrupted */
226         do {
227                 ret = flock(fd, type | LOCK_NB);
228         } while (ret && errno == EINTR);
229
230         if (ret && errno == EWOULDBLOCK) {
231                 /* couldn't lock */
232                 return 0;
233         } else if (ret) {
234                 RTE_LOG(ERR, EAL, "%s(): error calling flock(): %s\n",
235                         __func__, strerror(errno));
236                 return -1;
237         }
238         /* lock was successful */
239         return 1;
240 }
241
242 static int
243 get_seg_memfd(struct hugepage_info *hi __rte_unused,
244                 unsigned int list_idx __rte_unused,
245                 unsigned int seg_idx __rte_unused)
246 {
247 #ifdef MEMFD_SUPPORTED
248         int fd;
249         char segname[250]; /* as per manpage, limit is 249 bytes plus null */
250
251         int flags = RTE_MFD_HUGETLB | pagesz_flags(hi->hugepage_sz);
252         const struct internal_config *internal_conf =
253                 eal_get_internal_configuration();
254
255         if (internal_conf->single_file_segments) {
256                 fd = fd_list[list_idx].memseg_list_fd;
257
258                 if (fd < 0) {
259                         snprintf(segname, sizeof(segname), "seg_%i", list_idx);
260                         fd = memfd_create(segname, flags);
261                         if (fd < 0) {
262                                 RTE_LOG(DEBUG, EAL, "%s(): memfd create failed: %s\n",
263                                         __func__, strerror(errno));
264                                 return -1;
265                         }
266                         fd_list[list_idx].memseg_list_fd = fd;
267                 }
268         } else {
269                 fd = fd_list[list_idx].fds[seg_idx];
270
271                 if (fd < 0) {
272                         snprintf(segname, sizeof(segname), "seg_%i-%i",
273                                         list_idx, seg_idx);
274                         fd = memfd_create(segname, flags);
275                         if (fd < 0) {
276                                 RTE_LOG(DEBUG, EAL, "%s(): memfd create failed: %s\n",
277                                         __func__, strerror(errno));
278                                 return -1;
279                         }
280                         fd_list[list_idx].fds[seg_idx] = fd;
281                 }
282         }
283         return fd;
284 #endif
285         return -1;
286 }
287
288 static int
289 get_seg_fd(char *path, int buflen, struct hugepage_info *hi,
290                 unsigned int list_idx, unsigned int seg_idx)
291 {
292         int fd;
293         const struct internal_config *internal_conf =
294                 eal_get_internal_configuration();
295
296         /* for in-memory mode, we only make it here when we're sure we support
297          * memfd, and this is a special case.
298          */
299         if (internal_conf->in_memory)
300                 return get_seg_memfd(hi, list_idx, seg_idx);
301
302         if (internal_conf->single_file_segments) {
303                 /* create a hugepage file path */
304                 eal_get_hugefile_path(path, buflen, hi->hugedir, list_idx);
305
306                 fd = fd_list[list_idx].memseg_list_fd;
307
308                 if (fd < 0) {
309                         fd = open(path, O_CREAT | O_RDWR, 0600);
310                         if (fd < 0) {
311                                 RTE_LOG(ERR, EAL, "%s(): open '%s' failed: %s\n",
312                                         __func__, path, strerror(errno));
313                                 return -1;
314                         }
315                         /* take out a read lock and keep it indefinitely */
316                         if (lock(fd, LOCK_SH) < 0) {
317                                 RTE_LOG(ERR, EAL, "%s(): lock failed: %s\n",
318                                         __func__, strerror(errno));
319                                 close(fd);
320                                 return -1;
321                         }
322                         fd_list[list_idx].memseg_list_fd = fd;
323                 }
324         } else {
325                 /* create a hugepage file path */
326                 eal_get_hugefile_path(path, buflen, hi->hugedir,
327                                 list_idx * RTE_MAX_MEMSEG_PER_LIST + seg_idx);
328
329                 fd = fd_list[list_idx].fds[seg_idx];
330
331                 if (fd < 0) {
332                         /* A primary process is the only one creating these
333                          * files. If there is a leftover that was not cleaned
334                          * by clear_hugedir(), we must *now* make sure to drop
335                          * the file or we will remap old stuff while the rest
336                          * of the code is built on the assumption that a new
337                          * page is clean.
338                          */
339                         if (rte_eal_process_type() == RTE_PROC_PRIMARY &&
340                                         unlink(path) == -1 &&
341                                         errno != ENOENT) {
342                                 RTE_LOG(DEBUG, EAL, "%s(): could not remove '%s': %s\n",
343                                         __func__, path, strerror(errno));
344                                 return -1;
345                         }
346
347                         fd = open(path, O_CREAT | O_RDWR, 0600);
348                         if (fd < 0) {
349                                 RTE_LOG(ERR, EAL, "%s(): open '%s' failed: %s\n",
350                                         __func__, path, strerror(errno));
351                                 return -1;
352                         }
353                         /* take out a read lock */
354                         if (lock(fd, LOCK_SH) < 0) {
355                                 RTE_LOG(ERR, EAL, "%s(): lock failed: %s\n",
356                                         __func__, strerror(errno));
357                                 close(fd);
358                                 return -1;
359                         }
360                         fd_list[list_idx].fds[seg_idx] = fd;
361                 }
362         }
363         return fd;
364 }
365
366 static int
367 resize_hugefile_in_memory(int fd, uint64_t fa_offset,
368                 uint64_t page_sz, bool grow)
369 {
370         int flags = grow ? 0 : FALLOC_FL_PUNCH_HOLE |
371                         FALLOC_FL_KEEP_SIZE;
372         int ret;
373
374         /* grow or shrink the file */
375         ret = fallocate(fd, flags, fa_offset, page_sz);
376
377         if (ret < 0) {
378                 RTE_LOG(DEBUG, EAL, "%s(): fallocate() failed: %s\n",
379                                 __func__,
380                                 strerror(errno));
381                 return -1;
382         }
383         return 0;
384 }
385
386 static int
387 resize_hugefile_in_filesystem(int fd, uint64_t fa_offset, uint64_t page_sz,
388                 bool grow)
389 {
390         bool again = false;
391
392         do {
393                 if (fallocate_supported == 0) {
394                         /* we cannot deallocate memory if fallocate() is not
395                          * supported, and hugepage file is already locked at
396                          * creation, so no further synchronization needed.
397                          */
398
399                         if (!grow) {
400                                 RTE_LOG(DEBUG, EAL, "%s(): fallocate not supported, not freeing page back to the system\n",
401                                         __func__);
402                                 return -1;
403                         }
404                         uint64_t new_size = fa_offset + page_sz;
405                         uint64_t cur_size = get_file_size(fd);
406
407                         /* fallocate isn't supported, fall back to ftruncate */
408                         if (new_size > cur_size &&
409                                         ftruncate(fd, new_size) < 0) {
410                                 RTE_LOG(DEBUG, EAL, "%s(): ftruncate() failed: %s\n",
411                                         __func__, strerror(errno));
412                                 return -1;
413                         }
414                 } else {
415                         int flags = grow ? 0 : FALLOC_FL_PUNCH_HOLE |
416                                         FALLOC_FL_KEEP_SIZE;
417                         int ret;
418
419                         /*
420                          * technically, it is perfectly safe for both primary
421                          * and secondary to grow and shrink the page files:
422                          * growing the file repeatedly has no effect because
423                          * a page can only be allocated once, while mmap ensures
424                          * that secondaries hold on to the page even after the
425                          * page itself is removed from the filesystem.
426                          *
427                          * however, leaving growing/shrinking to the primary
428                          * tends to expose bugs in fdlist page count handling,
429                          * so leave this here just in case.
430                          */
431                         if (rte_eal_process_type() != RTE_PROC_PRIMARY)
432                                 return 0;
433
434                         /* grow or shrink the file */
435                         ret = fallocate(fd, flags, fa_offset, page_sz);
436
437                         if (ret < 0) {
438                                 if (fallocate_supported == -1 &&
439                                                 errno == ENOTSUP) {
440                                         RTE_LOG(ERR, EAL, "%s(): fallocate() not supported, hugepage deallocation will be disabled\n",
441                                                 __func__);
442                                         again = true;
443                                         fallocate_supported = 0;
444                                 } else {
445                                         RTE_LOG(DEBUG, EAL, "%s(): fallocate() failed: %s\n",
446                                                 __func__,
447                                                 strerror(errno));
448                                         return -1;
449                                 }
450                         } else
451                                 fallocate_supported = 1;
452                 }
453         } while (again);
454
455         return 0;
456 }
457
458 static void
459 close_hugefile(int fd, char *path, int list_idx)
460 {
461         const struct internal_config *internal_conf =
462                 eal_get_internal_configuration();
463         /*
464          * primary process must unlink the file, but only when not in in-memory
465          * mode (as in that case there is no file to unlink).
466          */
467         if (!internal_conf->in_memory &&
468                         rte_eal_process_type() == RTE_PROC_PRIMARY &&
469                         unlink(path))
470                 RTE_LOG(ERR, EAL, "%s(): unlinking '%s' failed: %s\n",
471                         __func__, path, strerror(errno));
472
473         close(fd);
474         fd_list[list_idx].memseg_list_fd = -1;
475 }
476
477 static int
478 resize_hugefile(int fd, uint64_t fa_offset, uint64_t page_sz, bool grow)
479 {
480         /* in-memory mode is a special case, because we can be sure that
481          * fallocate() is supported.
482          */
483         const struct internal_config *internal_conf =
484                 eal_get_internal_configuration();
485
486         if (internal_conf->in_memory)
487                 return resize_hugefile_in_memory(fd, fa_offset,
488                                 page_sz, grow);
489
490         return resize_hugefile_in_filesystem(fd, fa_offset, page_sz,
491                                 grow);
492 }
493
494 static int
495 alloc_seg(struct rte_memseg *ms, void *addr, int socket_id,
496                 struct hugepage_info *hi, unsigned int list_idx,
497                 unsigned int seg_idx)
498 {
499 #ifdef RTE_EAL_NUMA_AWARE_HUGEPAGES
500         int cur_socket_id = 0;
501 #endif
502         uint64_t map_offset;
503         rte_iova_t iova;
504         void *va;
505         char path[PATH_MAX];
506         int ret = 0;
507         int fd;
508         size_t alloc_sz;
509         int flags;
510         void *new_addr;
511         const struct internal_config *internal_conf =
512                 eal_get_internal_configuration();
513
514         alloc_sz = hi->hugepage_sz;
515
516         /* these are checked at init, but code analyzers don't know that */
517         if (internal_conf->in_memory && !anonymous_hugepages_supported) {
518                 RTE_LOG(ERR, EAL, "Anonymous hugepages not supported, in-memory mode cannot allocate memory\n");
519                 return -1;
520         }
521         if (internal_conf->in_memory && !memfd_create_supported &&
522                         internal_conf->single_file_segments) {
523                 RTE_LOG(ERR, EAL, "Single-file segments are not supported without memfd support\n");
524                 return -1;
525         }
526
527         /* in-memory without memfd is a special case */
528         int mmap_flags;
529
530         if (internal_conf->in_memory && !memfd_create_supported) {
531                 const int in_memory_flags = MAP_HUGETLB | MAP_FIXED |
532                                 MAP_PRIVATE | MAP_ANONYMOUS;
533                 int pagesz_flag;
534
535                 pagesz_flag = pagesz_flags(alloc_sz);
536                 fd = -1;
537                 mmap_flags = in_memory_flags | pagesz_flag;
538
539                 /* single-file segments codepath will never be active
540                  * here because in-memory mode is incompatible with the
541                  * fallback path, and it's stopped at EAL initialization
542                  * stage.
543                  */
544                 map_offset = 0;
545         } else {
546                 /* takes out a read lock on segment or segment list */
547                 fd = get_seg_fd(path, sizeof(path), hi, list_idx, seg_idx);
548                 if (fd < 0) {
549                         RTE_LOG(ERR, EAL, "Couldn't get fd on hugepage file\n");
550                         return -1;
551                 }
552
553                 if (internal_conf->single_file_segments) {
554                         map_offset = seg_idx * alloc_sz;
555                         ret = resize_hugefile(fd, map_offset, alloc_sz, true);
556                         if (ret < 0)
557                                 goto resized;
558
559                         fd_list[list_idx].count++;
560                 } else {
561                         map_offset = 0;
562                         if (ftruncate(fd, alloc_sz) < 0) {
563                                 RTE_LOG(DEBUG, EAL, "%s(): ftruncate() failed: %s\n",
564                                         __func__, strerror(errno));
565                                 goto resized;
566                         }
567                         if (internal_conf->hugepage_file.unlink_before_mapping &&
568                                         !internal_conf->in_memory) {
569                                 if (unlink(path)) {
570                                         RTE_LOG(DEBUG, EAL, "%s(): unlink() failed: %s\n",
571                                                 __func__, strerror(errno));
572                                         goto resized;
573                                 }
574                         }
575                 }
576                 mmap_flags = MAP_SHARED | MAP_POPULATE | MAP_FIXED;
577         }
578
579         huge_register_sigbus();
580
581         /*
582          * map the segment, and populate page tables, the kernel fills
583          * this segment with zeros if it's a new page.
584          */
585         va = mmap(addr, alloc_sz, PROT_READ | PROT_WRITE, mmap_flags, fd,
586                         map_offset);
587
588         if (va == MAP_FAILED) {
589                 RTE_LOG(DEBUG, EAL, "%s(): mmap() failed: %s\n", __func__,
590                         strerror(errno));
591                 /* mmap failed, but the previous region might have been
592                  * unmapped anyway. try to remap it
593                  */
594                 goto unmapped;
595         }
596         if (va != addr) {
597                 RTE_LOG(DEBUG, EAL, "%s(): wrong mmap() address\n", __func__);
598                 munmap(va, alloc_sz);
599                 goto resized;
600         }
601
602         /* In linux, hugetlb limitations, like cgroup, are
603          * enforced at fault time instead of mmap(), even
604          * with the option of MAP_POPULATE. Kernel will send
605          * a SIGBUS signal. To avoid to be killed, save stack
606          * environment here, if SIGBUS happens, we can jump
607          * back here.
608          */
609         if (huge_wrap_sigsetjmp()) {
610                 RTE_LOG(DEBUG, EAL, "SIGBUS: Cannot mmap more hugepages of size %uMB\n",
611                         (unsigned int)(alloc_sz >> 20));
612                 goto mapped;
613         }
614
615         /* we need to trigger a write to the page to enforce page fault and
616          * ensure that page is accessible to us, but we can't overwrite value
617          * that is already there, so read the old value, and write itback.
618          * kernel populates the page with zeroes initially.
619          */
620         *(volatile int *)addr = *(volatile int *)addr;
621
622         iova = rte_mem_virt2iova(addr);
623         if (iova == RTE_BAD_PHYS_ADDR) {
624                 RTE_LOG(DEBUG, EAL, "%s(): can't get IOVA addr\n",
625                         __func__);
626                 goto mapped;
627         }
628
629 #ifdef RTE_EAL_NUMA_AWARE_HUGEPAGES
630         /*
631          * If the kernel has been built without NUMA support, get_mempolicy()
632          * will return an error. If check_numa() returns false, memory
633          * allocation is not NUMA aware and the socket_id should not be
634          * checked.
635          */
636         if (check_numa()) {
637                 ret = get_mempolicy(&cur_socket_id, NULL, 0, addr,
638                                         MPOL_F_NODE | MPOL_F_ADDR);
639                 if (ret < 0) {
640                         RTE_LOG(DEBUG, EAL, "%s(): get_mempolicy: %s\n",
641                                 __func__, strerror(errno));
642                         goto mapped;
643                 } else if (cur_socket_id != socket_id) {
644                         RTE_LOG(DEBUG, EAL,
645                                         "%s(): allocation happened on wrong socket (wanted %d, got %d)\n",
646                                 __func__, socket_id, cur_socket_id);
647                         goto mapped;
648                 }
649         }
650 #else
651         if (rte_socket_count() > 1)
652                 RTE_LOG(DEBUG, EAL, "%s(): not checking hugepage NUMA node.\n",
653                                 __func__);
654 #endif
655
656         huge_recover_sigbus();
657
658         ms->addr = addr;
659         ms->hugepage_sz = alloc_sz;
660         ms->len = alloc_sz;
661         ms->nchannel = rte_memory_get_nchannel();
662         ms->nrank = rte_memory_get_nrank();
663         ms->iova = iova;
664         ms->socket_id = socket_id;
665
666         return 0;
667
668 mapped:
669         munmap(addr, alloc_sz);
670 unmapped:
671         huge_recover_sigbus();
672         flags = EAL_RESERVE_FORCE_ADDRESS;
673         new_addr = eal_get_virtual_area(addr, &alloc_sz, alloc_sz, 0, flags);
674         if (new_addr != addr) {
675                 if (new_addr != NULL)
676                         munmap(new_addr, alloc_sz);
677                 /* we're leaving a hole in our virtual address space. if
678                  * somebody else maps this hole now, we could accidentally
679                  * override it in the future.
680                  */
681                 RTE_LOG(CRIT, EAL, "Can't mmap holes in our virtual address space\n");
682         }
683         /* roll back the ref count */
684         if (internal_conf->single_file_segments)
685                 fd_list[list_idx].count--;
686 resized:
687         /* some codepaths will return negative fd, so exit early */
688         if (fd < 0)
689                 return -1;
690
691         if (internal_conf->single_file_segments) {
692                 resize_hugefile(fd, map_offset, alloc_sz, false);
693                 /* ignore failure, can't make it any worse */
694
695                 /* if refcount is at zero, close the file */
696                 if (fd_list[list_idx].count == 0)
697                         close_hugefile(fd, path, list_idx);
698         } else {
699                 /* only remove file if we can take out a write lock */
700                 if (!internal_conf->hugepage_file.unlink_before_mapping &&
701                                 internal_conf->in_memory == 0 &&
702                                 lock(fd, LOCK_EX) == 1)
703                         unlink(path);
704                 close(fd);
705                 fd_list[list_idx].fds[seg_idx] = -1;
706         }
707         return -1;
708 }
709
710 static int
711 free_seg(struct rte_memseg *ms, struct hugepage_info *hi,
712                 unsigned int list_idx, unsigned int seg_idx)
713 {
714         uint64_t map_offset;
715         char path[PATH_MAX];
716         int fd, ret = 0;
717         const struct internal_config *internal_conf =
718                 eal_get_internal_configuration();
719
720         /* erase page data */
721         memset(ms->addr, 0, ms->len);
722
723         if (mmap(ms->addr, ms->len, PROT_NONE,
724                         MAP_PRIVATE | MAP_ANONYMOUS | MAP_FIXED, -1, 0) ==
725                                 MAP_FAILED) {
726                 RTE_LOG(DEBUG, EAL, "couldn't unmap page\n");
727                 return -1;
728         }
729
730         eal_mem_set_dump(ms->addr, ms->len, false);
731
732         /* if we're using anonymous hugepages, nothing to be done */
733         if (internal_conf->in_memory && !memfd_create_supported) {
734                 memset(ms, 0, sizeof(*ms));
735                 return 0;
736         }
737
738         /* if we are not in single file segments mode, we're going to unmap the
739          * segment and thus drop the lock on original fd, but hugepage dir is
740          * now locked so we can take out another one without races.
741          */
742         fd = get_seg_fd(path, sizeof(path), hi, list_idx, seg_idx);
743         if (fd < 0)
744                 return -1;
745
746         if (internal_conf->single_file_segments) {
747                 map_offset = seg_idx * ms->len;
748                 if (resize_hugefile(fd, map_offset, ms->len, false))
749                         return -1;
750
751                 if (--(fd_list[list_idx].count) == 0)
752                         close_hugefile(fd, path, list_idx);
753
754                 ret = 0;
755         } else {
756                 /* if we're able to take out a write lock, we're the last one
757                  * holding onto this page.
758                  */
759                 if (!internal_conf->in_memory &&
760                                 !internal_conf->hugepage_file.unlink_before_mapping) {
761                         ret = lock(fd, LOCK_EX);
762                         if (ret >= 0) {
763                                 /* no one else is using this page */
764                                 if (ret == 1)
765                                         unlink(path);
766                         }
767                 }
768                 /* closing fd will drop the lock */
769                 close(fd);
770                 fd_list[list_idx].fds[seg_idx] = -1;
771         }
772
773         memset(ms, 0, sizeof(*ms));
774
775         return ret < 0 ? -1 : 0;
776 }
777
778 struct alloc_walk_param {
779         struct hugepage_info *hi;
780         struct rte_memseg **ms;
781         size_t page_sz;
782         unsigned int segs_allocated;
783         unsigned int n_segs;
784         int socket;
785         bool exact;
786 };
787 static int
788 alloc_seg_walk(const struct rte_memseg_list *msl, void *arg)
789 {
790         struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
791         struct alloc_walk_param *wa = arg;
792         struct rte_memseg_list *cur_msl;
793         size_t page_sz;
794         int cur_idx, start_idx, j, dir_fd = -1;
795         unsigned int msl_idx, need, i;
796         const struct internal_config *internal_conf =
797                 eal_get_internal_configuration();
798
799         if (msl->page_sz != wa->page_sz)
800                 return 0;
801         if (msl->socket_id != wa->socket)
802                 return 0;
803
804         page_sz = (size_t)msl->page_sz;
805
806         msl_idx = msl - mcfg->memsegs;
807         cur_msl = &mcfg->memsegs[msl_idx];
808
809         need = wa->n_segs;
810
811         /* try finding space in memseg list */
812         if (wa->exact) {
813                 /* if we require exact number of pages in a list, find them */
814                 cur_idx = rte_fbarray_find_next_n_free(&cur_msl->memseg_arr, 0,
815                                 need);
816                 if (cur_idx < 0)
817                         return 0;
818                 start_idx = cur_idx;
819         } else {
820                 int cur_len;
821
822                 /* we don't require exact number of pages, so we're going to go
823                  * for best-effort allocation. that means finding the biggest
824                  * unused block, and going with that.
825                  */
826                 cur_idx = rte_fbarray_find_biggest_free(&cur_msl->memseg_arr,
827                                 0);
828                 if (cur_idx < 0)
829                         return 0;
830                 start_idx = cur_idx;
831                 /* adjust the size to possibly be smaller than original
832                  * request, but do not allow it to be bigger.
833                  */
834                 cur_len = rte_fbarray_find_contig_free(&cur_msl->memseg_arr,
835                                 cur_idx);
836                 need = RTE_MIN(need, (unsigned int)cur_len);
837         }
838
839         /* do not allow any page allocations during the time we're allocating,
840          * because file creation and locking operations are not atomic,
841          * and we might be the first or the last ones to use a particular page,
842          * so we need to ensure atomicity of every operation.
843          *
844          * during init, we already hold a write lock, so don't try to take out
845          * another one.
846          */
847         if (wa->hi->lock_descriptor == -1 && !internal_conf->in_memory) {
848                 dir_fd = open(wa->hi->hugedir, O_RDONLY);
849                 if (dir_fd < 0) {
850                         RTE_LOG(ERR, EAL, "%s(): Cannot open '%s': %s\n",
851                                 __func__, wa->hi->hugedir, strerror(errno));
852                         return -1;
853                 }
854                 /* blocking writelock */
855                 if (flock(dir_fd, LOCK_EX)) {
856                         RTE_LOG(ERR, EAL, "%s(): Cannot lock '%s': %s\n",
857                                 __func__, wa->hi->hugedir, strerror(errno));
858                         close(dir_fd);
859                         return -1;
860                 }
861         }
862
863         for (i = 0; i < need; i++, cur_idx++) {
864                 struct rte_memseg *cur;
865                 void *map_addr;
866
867                 cur = rte_fbarray_get(&cur_msl->memseg_arr, cur_idx);
868                 map_addr = RTE_PTR_ADD(cur_msl->base_va,
869                                 cur_idx * page_sz);
870
871                 if (alloc_seg(cur, map_addr, wa->socket, wa->hi,
872                                 msl_idx, cur_idx)) {
873                         RTE_LOG(DEBUG, EAL, "attempted to allocate %i segments, but only %i were allocated\n",
874                                 need, i);
875
876                         /* if exact number wasn't requested, stop */
877                         if (!wa->exact)
878                                 goto out;
879
880                         /* clean up */
881                         for (j = start_idx; j < cur_idx; j++) {
882                                 struct rte_memseg *tmp;
883                                 struct rte_fbarray *arr =
884                                                 &cur_msl->memseg_arr;
885
886                                 tmp = rte_fbarray_get(arr, j);
887                                 rte_fbarray_set_free(arr, j);
888
889                                 /* free_seg may attempt to create a file, which
890                                  * may fail.
891                                  */
892                                 if (free_seg(tmp, wa->hi, msl_idx, j))
893                                         RTE_LOG(DEBUG, EAL, "Cannot free page\n");
894                         }
895                         /* clear the list */
896                         if (wa->ms)
897                                 memset(wa->ms, 0, sizeof(*wa->ms) * wa->n_segs);
898
899                         if (dir_fd >= 0)
900                                 close(dir_fd);
901                         return -1;
902                 }
903                 if (wa->ms)
904                         wa->ms[i] = cur;
905
906                 rte_fbarray_set_used(&cur_msl->memseg_arr, cur_idx);
907         }
908 out:
909         wa->segs_allocated = i;
910         if (i > 0)
911                 cur_msl->version++;
912         if (dir_fd >= 0)
913                 close(dir_fd);
914         /* if we didn't allocate any segments, move on to the next list */
915         return i > 0;
916 }
917
918 struct free_walk_param {
919         struct hugepage_info *hi;
920         struct rte_memseg *ms;
921 };
922 static int
923 free_seg_walk(const struct rte_memseg_list *msl, void *arg)
924 {
925         struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
926         struct rte_memseg_list *found_msl;
927         struct free_walk_param *wa = arg;
928         uintptr_t start_addr, end_addr;
929         int msl_idx, seg_idx, ret, dir_fd = -1;
930         const struct internal_config *internal_conf =
931                 eal_get_internal_configuration();
932
933         start_addr = (uintptr_t) msl->base_va;
934         end_addr = start_addr + msl->len;
935
936         if ((uintptr_t)wa->ms->addr < start_addr ||
937                         (uintptr_t)wa->ms->addr >= end_addr)
938                 return 0;
939
940         msl_idx = msl - mcfg->memsegs;
941         seg_idx = RTE_PTR_DIFF(wa->ms->addr, start_addr) / msl->page_sz;
942
943         /* msl is const */
944         found_msl = &mcfg->memsegs[msl_idx];
945
946         /* do not allow any page allocations during the time we're freeing,
947          * because file creation and locking operations are not atomic,
948          * and we might be the first or the last ones to use a particular page,
949          * so we need to ensure atomicity of every operation.
950          *
951          * during init, we already hold a write lock, so don't try to take out
952          * another one.
953          */
954         if (wa->hi->lock_descriptor == -1 && !internal_conf->in_memory) {
955                 dir_fd = open(wa->hi->hugedir, O_RDONLY);
956                 if (dir_fd < 0) {
957                         RTE_LOG(ERR, EAL, "%s(): Cannot open '%s': %s\n",
958                                 __func__, wa->hi->hugedir, strerror(errno));
959                         return -1;
960                 }
961                 /* blocking writelock */
962                 if (flock(dir_fd, LOCK_EX)) {
963                         RTE_LOG(ERR, EAL, "%s(): Cannot lock '%s': %s\n",
964                                 __func__, wa->hi->hugedir, strerror(errno));
965                         close(dir_fd);
966                         return -1;
967                 }
968         }
969
970         found_msl->version++;
971
972         rte_fbarray_set_free(&found_msl->memseg_arr, seg_idx);
973
974         ret = free_seg(wa->ms, wa->hi, msl_idx, seg_idx);
975
976         if (dir_fd >= 0)
977                 close(dir_fd);
978
979         if (ret < 0)
980                 return -1;
981
982         return 1;
983 }
984
985 int
986 eal_memalloc_alloc_seg_bulk(struct rte_memseg **ms, int n_segs, size_t page_sz,
987                 int socket, bool exact)
988 {
989         int i, ret = -1;
990 #ifdef RTE_EAL_NUMA_AWARE_HUGEPAGES
991         bool have_numa = false;
992         int oldpolicy;
993         struct bitmask *oldmask;
994 #endif
995         struct alloc_walk_param wa;
996         struct hugepage_info *hi = NULL;
997         struct internal_config *internal_conf =
998                 eal_get_internal_configuration();
999
1000         memset(&wa, 0, sizeof(wa));
1001
1002         /* dynamic allocation not supported in legacy mode */
1003         if (internal_conf->legacy_mem)
1004                 return -1;
1005
1006         for (i = 0; i < (int) RTE_DIM(internal_conf->hugepage_info); i++) {
1007                 if (page_sz ==
1008                                 internal_conf->hugepage_info[i].hugepage_sz) {
1009                         hi = &internal_conf->hugepage_info[i];
1010                         break;
1011                 }
1012         }
1013         if (!hi) {
1014                 RTE_LOG(ERR, EAL, "%s(): can't find relevant hugepage_info entry\n",
1015                         __func__);
1016                 return -1;
1017         }
1018
1019 #ifdef RTE_EAL_NUMA_AWARE_HUGEPAGES
1020         if (check_numa()) {
1021                 oldmask = numa_allocate_nodemask();
1022                 prepare_numa(&oldpolicy, oldmask, socket);
1023                 have_numa = true;
1024         }
1025 #endif
1026
1027         wa.exact = exact;
1028         wa.hi = hi;
1029         wa.ms = ms;
1030         wa.n_segs = n_segs;
1031         wa.page_sz = page_sz;
1032         wa.socket = socket;
1033         wa.segs_allocated = 0;
1034
1035         /* memalloc is locked, so it's safe to use thread-unsafe version */
1036         ret = rte_memseg_list_walk_thread_unsafe(alloc_seg_walk, &wa);
1037         if (ret == 0) {
1038                 RTE_LOG(ERR, EAL, "%s(): couldn't find suitable memseg_list\n",
1039                         __func__);
1040                 ret = -1;
1041         } else if (ret > 0) {
1042                 ret = (int)wa.segs_allocated;
1043         }
1044
1045 #ifdef RTE_EAL_NUMA_AWARE_HUGEPAGES
1046         if (have_numa)
1047                 restore_numa(&oldpolicy, oldmask);
1048 #endif
1049         return ret;
1050 }
1051
1052 struct rte_memseg *
1053 eal_memalloc_alloc_seg(size_t page_sz, int socket)
1054 {
1055         struct rte_memseg *ms;
1056         if (eal_memalloc_alloc_seg_bulk(&ms, 1, page_sz, socket, true) < 0)
1057                 return NULL;
1058         /* return pointer to newly allocated memseg */
1059         return ms;
1060 }
1061
1062 int
1063 eal_memalloc_free_seg_bulk(struct rte_memseg **ms, int n_segs)
1064 {
1065         int seg, ret = 0;
1066         struct internal_config *internal_conf =
1067                 eal_get_internal_configuration();
1068
1069         /* dynamic free not supported in legacy mode */
1070         if (internal_conf->legacy_mem)
1071                 return -1;
1072
1073         for (seg = 0; seg < n_segs; seg++) {
1074                 struct rte_memseg *cur = ms[seg];
1075                 struct hugepage_info *hi = NULL;
1076                 struct free_walk_param wa;
1077                 int i, walk_res;
1078
1079                 /* if this page is marked as unfreeable, fail */
1080                 if (cur->flags & RTE_MEMSEG_FLAG_DO_NOT_FREE) {
1081                         RTE_LOG(DEBUG, EAL, "Page is not allowed to be freed\n");
1082                         ret = -1;
1083                         continue;
1084                 }
1085
1086                 memset(&wa, 0, sizeof(wa));
1087
1088                 for (i = 0; i < (int)RTE_DIM(internal_conf->hugepage_info);
1089                                 i++) {
1090                         hi = &internal_conf->hugepage_info[i];
1091                         if (cur->hugepage_sz == hi->hugepage_sz)
1092                                 break;
1093                 }
1094                 if (i == (int)RTE_DIM(internal_conf->hugepage_info)) {
1095                         RTE_LOG(ERR, EAL, "Can't find relevant hugepage_info entry\n");
1096                         ret = -1;
1097                         continue;
1098                 }
1099
1100                 wa.ms = cur;
1101                 wa.hi = hi;
1102
1103                 /* memalloc is locked, so it's safe to use thread-unsafe version
1104                  */
1105                 walk_res = rte_memseg_list_walk_thread_unsafe(free_seg_walk,
1106                                 &wa);
1107                 if (walk_res == 1)
1108                         continue;
1109                 if (walk_res == 0)
1110                         RTE_LOG(ERR, EAL, "Couldn't find memseg list\n");
1111                 ret = -1;
1112         }
1113         return ret;
1114 }
1115
1116 int
1117 eal_memalloc_free_seg(struct rte_memseg *ms)
1118 {
1119         const struct internal_config *internal_conf =
1120                 eal_get_internal_configuration();
1121
1122         /* dynamic free not supported in legacy mode */
1123         if (internal_conf->legacy_mem)
1124                 return -1;
1125
1126         return eal_memalloc_free_seg_bulk(&ms, 1);
1127 }
1128
1129 static int
1130 sync_chunk(struct rte_memseg_list *primary_msl,
1131                 struct rte_memseg_list *local_msl, struct hugepage_info *hi,
1132                 unsigned int msl_idx, bool used, int start, int end)
1133 {
1134         struct rte_fbarray *l_arr, *p_arr;
1135         int i, ret, chunk_len, diff_len;
1136
1137         l_arr = &local_msl->memseg_arr;
1138         p_arr = &primary_msl->memseg_arr;
1139
1140         /* we need to aggregate allocations/deallocations into bigger chunks,
1141          * as we don't want to spam the user with per-page callbacks.
1142          *
1143          * to avoid any potential issues, we also want to trigger
1144          * deallocation callbacks *before* we actually deallocate
1145          * memory, so that the user application could wrap up its use
1146          * before it goes away.
1147          */
1148
1149         chunk_len = end - start;
1150
1151         /* find how many contiguous pages we can map/unmap for this chunk */
1152         diff_len = used ?
1153                         rte_fbarray_find_contig_free(l_arr, start) :
1154                         rte_fbarray_find_contig_used(l_arr, start);
1155
1156         /* has to be at least one page */
1157         if (diff_len < 1)
1158                 return -1;
1159
1160         diff_len = RTE_MIN(chunk_len, diff_len);
1161
1162         /* if we are freeing memory, notify the application */
1163         if (!used) {
1164                 struct rte_memseg *ms;
1165                 void *start_va;
1166                 size_t len, page_sz;
1167
1168                 ms = rte_fbarray_get(l_arr, start);
1169                 start_va = ms->addr;
1170                 page_sz = (size_t)primary_msl->page_sz;
1171                 len = page_sz * diff_len;
1172
1173                 eal_memalloc_mem_event_notify(RTE_MEM_EVENT_FREE,
1174                                 start_va, len);
1175         }
1176
1177         for (i = 0; i < diff_len; i++) {
1178                 struct rte_memseg *p_ms, *l_ms;
1179                 int seg_idx = start + i;
1180
1181                 l_ms = rte_fbarray_get(l_arr, seg_idx);
1182                 p_ms = rte_fbarray_get(p_arr, seg_idx);
1183
1184                 if (l_ms == NULL || p_ms == NULL)
1185                         return -1;
1186
1187                 if (used) {
1188                         ret = alloc_seg(l_ms, p_ms->addr,
1189                                         p_ms->socket_id, hi,
1190                                         msl_idx, seg_idx);
1191                         if (ret < 0)
1192                                 return -1;
1193                         rte_fbarray_set_used(l_arr, seg_idx);
1194                 } else {
1195                         ret = free_seg(l_ms, hi, msl_idx, seg_idx);
1196                         rte_fbarray_set_free(l_arr, seg_idx);
1197                         if (ret < 0)
1198                                 return -1;
1199                 }
1200         }
1201
1202         /* if we just allocated memory, notify the application */
1203         if (used) {
1204                 struct rte_memseg *ms;
1205                 void *start_va;
1206                 size_t len, page_sz;
1207
1208                 ms = rte_fbarray_get(l_arr, start);
1209                 start_va = ms->addr;
1210                 page_sz = (size_t)primary_msl->page_sz;
1211                 len = page_sz * diff_len;
1212
1213                 eal_memalloc_mem_event_notify(RTE_MEM_EVENT_ALLOC,
1214                                 start_va, len);
1215         }
1216
1217         /* calculate how much we can advance until next chunk */
1218         diff_len = used ?
1219                         rte_fbarray_find_contig_used(l_arr, start) :
1220                         rte_fbarray_find_contig_free(l_arr, start);
1221         ret = RTE_MIN(chunk_len, diff_len);
1222
1223         return ret;
1224 }
1225
1226 static int
1227 sync_status(struct rte_memseg_list *primary_msl,
1228                 struct rte_memseg_list *local_msl, struct hugepage_info *hi,
1229                 unsigned int msl_idx, bool used)
1230 {
1231         struct rte_fbarray *l_arr, *p_arr;
1232         int p_idx, l_chunk_len, p_chunk_len, ret;
1233         int start, end;
1234
1235         /* this is a little bit tricky, but the basic idea is - walk both lists
1236          * and spot any places where there are discrepancies. walking both lists
1237          * and noting discrepancies in a single go is a hard problem, so we do
1238          * it in two passes - first we spot any places where allocated segments
1239          * mismatch (i.e. ensure that everything that's allocated in the primary
1240          * is also allocated in the secondary), and then we do it by looking at
1241          * free segments instead.
1242          *
1243          * we also need to aggregate changes into chunks, as we have to call
1244          * callbacks per allocation, not per page.
1245          */
1246         l_arr = &local_msl->memseg_arr;
1247         p_arr = &primary_msl->memseg_arr;
1248
1249         if (used)
1250                 p_idx = rte_fbarray_find_next_used(p_arr, 0);
1251         else
1252                 p_idx = rte_fbarray_find_next_free(p_arr, 0);
1253
1254         while (p_idx >= 0) {
1255                 int next_chunk_search_idx;
1256
1257                 if (used) {
1258                         p_chunk_len = rte_fbarray_find_contig_used(p_arr,
1259                                         p_idx);
1260                         l_chunk_len = rte_fbarray_find_contig_used(l_arr,
1261                                         p_idx);
1262                 } else {
1263                         p_chunk_len = rte_fbarray_find_contig_free(p_arr,
1264                                         p_idx);
1265                         l_chunk_len = rte_fbarray_find_contig_free(l_arr,
1266                                         p_idx);
1267                 }
1268                 /* best case scenario - no differences (or bigger, which will be
1269                  * fixed during next iteration), look for next chunk
1270                  */
1271                 if (l_chunk_len >= p_chunk_len) {
1272                         next_chunk_search_idx = p_idx + p_chunk_len;
1273                         goto next_chunk;
1274                 }
1275
1276                 /* if both chunks start at the same point, skip parts we know
1277                  * are identical, and sync the rest. each call to sync_chunk
1278                  * will only sync contiguous segments, so we need to call this
1279                  * until we are sure there are no more differences in this
1280                  * chunk.
1281                  */
1282                 start = p_idx + l_chunk_len;
1283                 end = p_idx + p_chunk_len;
1284                 do {
1285                         ret = sync_chunk(primary_msl, local_msl, hi, msl_idx,
1286                                         used, start, end);
1287                         start += ret;
1288                 } while (start < end && ret >= 0);
1289                 /* if ret is negative, something went wrong */
1290                 if (ret < 0)
1291                         return -1;
1292
1293                 next_chunk_search_idx = p_idx + p_chunk_len;
1294 next_chunk:
1295                 /* skip to end of this chunk */
1296                 if (used) {
1297                         p_idx = rte_fbarray_find_next_used(p_arr,
1298                                         next_chunk_search_idx);
1299                 } else {
1300                         p_idx = rte_fbarray_find_next_free(p_arr,
1301                                         next_chunk_search_idx);
1302                 }
1303         }
1304         return 0;
1305 }
1306
1307 static int
1308 sync_existing(struct rte_memseg_list *primary_msl,
1309                 struct rte_memseg_list *local_msl, struct hugepage_info *hi,
1310                 unsigned int msl_idx)
1311 {
1312         int ret, dir_fd;
1313
1314         /* do not allow any page allocations during the time we're allocating,
1315          * because file creation and locking operations are not atomic,
1316          * and we might be the first or the last ones to use a particular page,
1317          * so we need to ensure atomicity of every operation.
1318          */
1319         dir_fd = open(hi->hugedir, O_RDONLY);
1320         if (dir_fd < 0) {
1321                 RTE_LOG(ERR, EAL, "%s(): Cannot open '%s': %s\n", __func__,
1322                         hi->hugedir, strerror(errno));
1323                 return -1;
1324         }
1325         /* blocking writelock */
1326         if (flock(dir_fd, LOCK_EX)) {
1327                 RTE_LOG(ERR, EAL, "%s(): Cannot lock '%s': %s\n", __func__,
1328                         hi->hugedir, strerror(errno));
1329                 close(dir_fd);
1330                 return -1;
1331         }
1332
1333         /* ensure all allocated space is the same in both lists */
1334         ret = sync_status(primary_msl, local_msl, hi, msl_idx, true);
1335         if (ret < 0)
1336                 goto fail;
1337
1338         /* ensure all unallocated space is the same in both lists */
1339         ret = sync_status(primary_msl, local_msl, hi, msl_idx, false);
1340         if (ret < 0)
1341                 goto fail;
1342
1343         /* update version number */
1344         local_msl->version = primary_msl->version;
1345
1346         close(dir_fd);
1347
1348         return 0;
1349 fail:
1350         close(dir_fd);
1351         return -1;
1352 }
1353
1354 static int
1355 sync_walk(const struct rte_memseg_list *msl, void *arg __rte_unused)
1356 {
1357         struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
1358         struct rte_memseg_list *primary_msl, *local_msl;
1359         struct hugepage_info *hi = NULL;
1360         unsigned int i;
1361         int msl_idx;
1362         struct internal_config *internal_conf =
1363                 eal_get_internal_configuration();
1364
1365         if (msl->external)
1366                 return 0;
1367
1368         msl_idx = msl - mcfg->memsegs;
1369         primary_msl = &mcfg->memsegs[msl_idx];
1370         local_msl = &local_memsegs[msl_idx];
1371
1372         for (i = 0; i < RTE_DIM(internal_conf->hugepage_info); i++) {
1373                 uint64_t cur_sz =
1374                         internal_conf->hugepage_info[i].hugepage_sz;
1375                 uint64_t msl_sz = primary_msl->page_sz;
1376                 if (msl_sz == cur_sz) {
1377                         hi = &internal_conf->hugepage_info[i];
1378                         break;
1379                 }
1380         }
1381         if (!hi) {
1382                 RTE_LOG(ERR, EAL, "Can't find relevant hugepage_info entry\n");
1383                 return -1;
1384         }
1385
1386         /* if versions don't match, synchronize everything */
1387         if (local_msl->version != primary_msl->version &&
1388                         sync_existing(primary_msl, local_msl, hi, msl_idx))
1389                 return -1;
1390         return 0;
1391 }
1392
1393
1394 int
1395 eal_memalloc_sync_with_primary(void)
1396 {
1397         /* nothing to be done in primary */
1398         if (rte_eal_process_type() == RTE_PROC_PRIMARY)
1399                 return 0;
1400
1401         /* memalloc is locked, so it's safe to call thread-unsafe version */
1402         if (rte_memseg_list_walk_thread_unsafe(sync_walk, NULL))
1403                 return -1;
1404         return 0;
1405 }
1406
1407 static int
1408 secondary_msl_create_walk(const struct rte_memseg_list *msl,
1409                 void *arg __rte_unused)
1410 {
1411         struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
1412         struct rte_memseg_list *primary_msl, *local_msl;
1413         char name[PATH_MAX];
1414         int msl_idx, ret;
1415
1416         if (msl->external)
1417                 return 0;
1418
1419         msl_idx = msl - mcfg->memsegs;
1420         primary_msl = &mcfg->memsegs[msl_idx];
1421         local_msl = &local_memsegs[msl_idx];
1422
1423         /* create distinct fbarrays for each secondary */
1424         snprintf(name, RTE_FBARRAY_NAME_LEN, "%s_%i",
1425                 primary_msl->memseg_arr.name, getpid());
1426
1427         ret = rte_fbarray_init(&local_msl->memseg_arr, name,
1428                 primary_msl->memseg_arr.len,
1429                 primary_msl->memseg_arr.elt_sz);
1430         if (ret < 0) {
1431                 RTE_LOG(ERR, EAL, "Cannot initialize local memory map\n");
1432                 return -1;
1433         }
1434         local_msl->base_va = primary_msl->base_va;
1435         local_msl->len = primary_msl->len;
1436
1437         return 0;
1438 }
1439
1440 static int
1441 secondary_msl_destroy_walk(const struct rte_memseg_list *msl,
1442                 void *arg __rte_unused)
1443 {
1444         struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
1445         struct rte_memseg_list *local_msl;
1446         int msl_idx, ret;
1447
1448         if (msl->external)
1449                 return 0;
1450
1451         msl_idx = msl - mcfg->memsegs;
1452         local_msl = &local_memsegs[msl_idx];
1453
1454         ret = rte_fbarray_destroy(&local_msl->memseg_arr);
1455         if (ret < 0) {
1456                 RTE_LOG(ERR, EAL, "Cannot destroy local memory map\n");
1457                 return -1;
1458         }
1459         local_msl->base_va = NULL;
1460         local_msl->len = 0;
1461
1462         return 0;
1463 }
1464
1465 static int
1466 alloc_list(int list_idx, int len)
1467 {
1468         int *data;
1469         int i;
1470         const struct internal_config *internal_conf =
1471                 eal_get_internal_configuration();
1472
1473         /* single-file segments mode does not need fd list */
1474         if (!internal_conf->single_file_segments) {
1475                 /* ensure we have space to store fd per each possible segment */
1476                 data = malloc(sizeof(int) * len);
1477                 if (data == NULL) {
1478                         RTE_LOG(ERR, EAL, "Unable to allocate space for file descriptors\n");
1479                         return -1;
1480                 }
1481                 /* set all fd's as invalid */
1482                 for (i = 0; i < len; i++)
1483                         data[i] = -1;
1484                 fd_list[list_idx].fds = data;
1485                 fd_list[list_idx].len = len;
1486         } else {
1487                 fd_list[list_idx].fds = NULL;
1488                 fd_list[list_idx].len = 0;
1489         }
1490
1491         fd_list[list_idx].count = 0;
1492         fd_list[list_idx].memseg_list_fd = -1;
1493
1494         return 0;
1495 }
1496
1497 static int
1498 destroy_list(int list_idx)
1499 {
1500         const struct internal_config *internal_conf =
1501                         eal_get_internal_configuration();
1502
1503         /* single-file segments mode does not need fd list */
1504         if (!internal_conf->single_file_segments) {
1505                 int *fds = fd_list[list_idx].fds;
1506                 int i;
1507                 /* go through each fd and ensure it's closed */
1508                 for (i = 0; i < fd_list[list_idx].len; i++) {
1509                         if (fds[i] >= 0) {
1510                                 close(fds[i]);
1511                                 fds[i] = -1;
1512                         }
1513                 }
1514                 free(fds);
1515                 fd_list[list_idx].fds = NULL;
1516                 fd_list[list_idx].len = 0;
1517         } else if (fd_list[list_idx].memseg_list_fd >= 0) {
1518                 close(fd_list[list_idx].memseg_list_fd);
1519                 fd_list[list_idx].count = 0;
1520                 fd_list[list_idx].memseg_list_fd = -1;
1521         }
1522         return 0;
1523 }
1524
1525 static int
1526 fd_list_create_walk(const struct rte_memseg_list *msl,
1527                 void *arg __rte_unused)
1528 {
1529         struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
1530         unsigned int len;
1531         int msl_idx;
1532
1533         if (msl->external)
1534                 return 0;
1535
1536         msl_idx = msl - mcfg->memsegs;
1537         len = msl->memseg_arr.len;
1538
1539         return alloc_list(msl_idx, len);
1540 }
1541
1542 static int
1543 fd_list_destroy_walk(const struct rte_memseg_list *msl, void *arg __rte_unused)
1544 {
1545         struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
1546         int msl_idx;
1547
1548         if (msl->external)
1549                 return 0;
1550
1551         msl_idx = msl - mcfg->memsegs;
1552
1553         return destroy_list(msl_idx);
1554 }
1555
1556 int
1557 eal_memalloc_set_seg_fd(int list_idx, int seg_idx, int fd)
1558 {
1559         struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
1560         const struct internal_config *internal_conf =
1561                 eal_get_internal_configuration();
1562
1563         /* single file segments mode doesn't support individual segment fd's */
1564         if (internal_conf->single_file_segments)
1565                 return -ENOTSUP;
1566
1567         /* if list is not allocated, allocate it */
1568         if (fd_list[list_idx].len == 0) {
1569                 int len = mcfg->memsegs[list_idx].memseg_arr.len;
1570
1571                 if (alloc_list(list_idx, len) < 0)
1572                         return -ENOMEM;
1573         }
1574         fd_list[list_idx].fds[seg_idx] = fd;
1575
1576         return 0;
1577 }
1578
1579 int
1580 eal_memalloc_set_seg_list_fd(int list_idx, int fd)
1581 {
1582         const struct internal_config *internal_conf =
1583                 eal_get_internal_configuration();
1584
1585         /* non-single file segment mode doesn't support segment list fd's */
1586         if (!internal_conf->single_file_segments)
1587                 return -ENOTSUP;
1588
1589         fd_list[list_idx].memseg_list_fd = fd;
1590
1591         return 0;
1592 }
1593
1594 int
1595 eal_memalloc_get_seg_fd(int list_idx, int seg_idx)
1596 {
1597         int fd;
1598         const struct internal_config *internal_conf =
1599                 eal_get_internal_configuration();
1600
1601         if (internal_conf->in_memory || internal_conf->no_hugetlbfs) {
1602 #ifndef MEMFD_SUPPORTED
1603                 /* in in-memory or no-huge mode, we rely on memfd support */
1604                 return -ENOTSUP;
1605 #endif
1606                 /* memfd supported, but hugetlbfs memfd may not be */
1607                 if (!internal_conf->no_hugetlbfs && !memfd_create_supported)
1608                         return -ENOTSUP;
1609         }
1610
1611         if (internal_conf->single_file_segments) {
1612                 fd = fd_list[list_idx].memseg_list_fd;
1613         } else if (fd_list[list_idx].len == 0) {
1614                 /* list not initialized */
1615                 fd = -1;
1616         } else {
1617                 fd = fd_list[list_idx].fds[seg_idx];
1618         }
1619         if (fd < 0)
1620                 return -ENODEV;
1621         return fd;
1622 }
1623
1624 static int
1625 test_memfd_create(void)
1626 {
1627 #ifdef MEMFD_SUPPORTED
1628         const struct internal_config *internal_conf =
1629                 eal_get_internal_configuration();
1630         unsigned int i;
1631         for (i = 0; i < internal_conf->num_hugepage_sizes; i++) {
1632                 uint64_t pagesz = internal_conf->hugepage_info[i].hugepage_sz;
1633                 int pagesz_flag = pagesz_flags(pagesz);
1634                 int flags;
1635
1636                 flags = pagesz_flag | RTE_MFD_HUGETLB;
1637                 int fd = memfd_create("test", flags);
1638                 if (fd < 0) {
1639                         /* we failed - let memalloc know this isn't working */
1640                         if (errno == EINVAL) {
1641                                 memfd_create_supported = 0;
1642                                 return 0; /* not supported */
1643                         }
1644
1645                         /* we got other error - something's wrong */
1646                         return -1; /* error */
1647                 }
1648                 close(fd);
1649                 return 1; /* supported */
1650         }
1651 #endif
1652         return 0; /* not supported */
1653 }
1654
1655 int
1656 eal_memalloc_get_seg_fd_offset(int list_idx, int seg_idx, size_t *offset)
1657 {
1658         struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
1659         const struct internal_config *internal_conf =
1660                 eal_get_internal_configuration();
1661
1662         if (internal_conf->in_memory || internal_conf->no_hugetlbfs) {
1663 #ifndef MEMFD_SUPPORTED
1664                 /* in in-memory or no-huge mode, we rely on memfd support */
1665                 return -ENOTSUP;
1666 #endif
1667                 /* memfd supported, but hugetlbfs memfd may not be */
1668                 if (!internal_conf->no_hugetlbfs && !memfd_create_supported)
1669                         return -ENOTSUP;
1670         }
1671
1672         if (internal_conf->single_file_segments) {
1673                 size_t pgsz = mcfg->memsegs[list_idx].page_sz;
1674
1675                 /* segment not active? */
1676                 if (fd_list[list_idx].memseg_list_fd < 0)
1677                         return -ENOENT;
1678                 *offset = pgsz * seg_idx;
1679         } else {
1680                 /* fd_list not initialized? */
1681                 if (fd_list[list_idx].len == 0)
1682                         return -ENODEV;
1683
1684                 /* segment not active? */
1685                 if (fd_list[list_idx].fds[seg_idx] < 0)
1686                         return -ENOENT;
1687                 *offset = 0;
1688         }
1689         return 0;
1690 }
1691
1692 int
1693 eal_memalloc_cleanup(void)
1694 {
1695         /* close all remaining fd's - these are per-process, so it's safe */
1696         if (rte_memseg_list_walk_thread_unsafe(fd_list_destroy_walk, NULL))
1697                 return -1;
1698
1699         /* destroy the shadow page table if we're a secondary process */
1700         if (rte_eal_process_type() == RTE_PROC_PRIMARY)
1701                 return 0;
1702
1703         if (rte_memseg_list_walk_thread_unsafe(secondary_msl_destroy_walk,
1704                         NULL))
1705                 return -1;
1706
1707         return 0;
1708 }
1709
1710 int
1711 eal_memalloc_init(void)
1712 {
1713         const struct internal_config *internal_conf =
1714                 eal_get_internal_configuration();
1715
1716         if (rte_eal_process_type() == RTE_PROC_SECONDARY)
1717                 if (rte_memseg_list_walk(secondary_msl_create_walk, NULL) < 0)
1718                         return -1;
1719         if (rte_eal_process_type() == RTE_PROC_PRIMARY &&
1720                         internal_conf->in_memory) {
1721                 int mfd_res = test_memfd_create();
1722
1723                 if (mfd_res < 0) {
1724                         RTE_LOG(ERR, EAL, "Unable to check if memfd is supported\n");
1725                         return -1;
1726                 }
1727                 if (mfd_res == 1)
1728                         RTE_LOG(DEBUG, EAL, "Using memfd for anonymous memory\n");
1729                 else
1730                         RTE_LOG(INFO, EAL, "Using memfd is not supported, falling back to anonymous hugepages\n");
1731
1732                 /* we only support single-file segments mode with in-memory mode
1733                  * if we support hugetlbfs with memfd_create. this code will
1734                  * test if we do.
1735                  */
1736                 if (internal_conf->single_file_segments &&
1737                                 mfd_res != 1) {
1738                         RTE_LOG(ERR, EAL, "Single-file segments mode cannot be used without memfd support\n");
1739                         return -1;
1740                 }
1741                 /* this cannot ever happen but better safe than sorry */
1742                 if (!anonymous_hugepages_supported) {
1743                         RTE_LOG(ERR, EAL, "Using anonymous memory is not supported\n");
1744                         return -1;
1745                 }
1746         }
1747
1748         /* initialize all of the fd lists */
1749         if (rte_memseg_list_walk(fd_list_create_walk, NULL))
1750                 return -1;
1751         return 0;
1752 }