mem: do not unmap overlapping region on mmap failure
[dpdk.git] / lib / librte_eal / linuxapp / eal / eal_memalloc.c
1 /* SPDX-License-Identifier: BSD-3-Clause
2  * Copyright(c) 2017-2018 Intel Corporation
3  */
4
5 #define _FILE_OFFSET_BITS 64
6 #include <errno.h>
7 #include <stdarg.h>
8 #include <stdbool.h>
9 #include <stdlib.h>
10 #include <stdio.h>
11 #include <stdint.h>
12 #include <inttypes.h>
13 #include <string.h>
14 #include <sys/mman.h>
15 #include <sys/types.h>
16 #include <sys/stat.h>
17 #include <sys/queue.h>
18 #include <sys/file.h>
19 #include <unistd.h>
20 #include <limits.h>
21 #include <fcntl.h>
22 #include <sys/ioctl.h>
23 #include <sys/time.h>
24 #include <signal.h>
25 #include <setjmp.h>
26 #ifdef RTE_EAL_NUMA_AWARE_HUGEPAGES
27 #include <numa.h>
28 #include <numaif.h>
29 #endif
30 #include <linux/falloc.h>
31
32 #include <rte_common.h>
33 #include <rte_log.h>
34 #include <rte_eal_memconfig.h>
35 #include <rte_eal.h>
36 #include <rte_memory.h>
37 #include <rte_spinlock.h>
38
39 #include "eal_filesystem.h"
40 #include "eal_internal_cfg.h"
41 #include "eal_memalloc.h"
42 #include "eal_private.h"
43
44 /*
45  * not all kernel version support fallocate on hugetlbfs, so fall back to
46  * ftruncate and disallow deallocation if fallocate is not supported.
47  */
48 static int fallocate_supported = -1; /* unknown */
49
50 /* for single-file segments, we need some kind of mechanism to keep track of
51  * which hugepages can be freed back to the system, and which cannot. we cannot
52  * use flock() because they don't allow locking parts of a file, and we cannot
53  * use fcntl() due to issues with their semantics, so we will have to rely on a
54  * bunch of lockfiles for each page.
55  *
56  * we cannot know how many pages a system will have in advance, but we do know
57  * that they come in lists, and we know lengths of these lists. so, simply store
58  * a malloc'd array of fd's indexed by list and segment index.
59  *
60  * they will be initialized at startup, and filled as we allocate/deallocate
61  * segments. also, use this to track memseg list proper fd.
62  */
63 static struct {
64         int *fds; /**< dynamically allocated array of segment lock fd's */
65         int memseg_list_fd; /**< memseg list fd */
66         int len; /**< total length of the array */
67         int count; /**< entries used in an array */
68 } lock_fds[RTE_MAX_MEMSEG_LISTS];
69
70 /** local copy of a memory map, used to synchronize memory hotplug in MP */
71 static struct rte_memseg_list local_memsegs[RTE_MAX_MEMSEG_LISTS];
72
73 static sigjmp_buf huge_jmpenv;
74
75 static void __rte_unused huge_sigbus_handler(int signo __rte_unused)
76 {
77         siglongjmp(huge_jmpenv, 1);
78 }
79
80 /* Put setjmp into a wrap method to avoid compiling error. Any non-volatile,
81  * non-static local variable in the stack frame calling sigsetjmp might be
82  * clobbered by a call to longjmp.
83  */
84 static int __rte_unused huge_wrap_sigsetjmp(void)
85 {
86         return sigsetjmp(huge_jmpenv, 1);
87 }
88
89 static struct sigaction huge_action_old;
90 static int huge_need_recover;
91
92 static void __rte_unused
93 huge_register_sigbus(void)
94 {
95         sigset_t mask;
96         struct sigaction action;
97
98         sigemptyset(&mask);
99         sigaddset(&mask, SIGBUS);
100         action.sa_flags = 0;
101         action.sa_mask = mask;
102         action.sa_handler = huge_sigbus_handler;
103
104         huge_need_recover = !sigaction(SIGBUS, &action, &huge_action_old);
105 }
106
107 static void __rte_unused
108 huge_recover_sigbus(void)
109 {
110         if (huge_need_recover) {
111                 sigaction(SIGBUS, &huge_action_old, NULL);
112                 huge_need_recover = 0;
113         }
114 }
115
116 #ifdef RTE_EAL_NUMA_AWARE_HUGEPAGES
117 static bool
118 check_numa(void)
119 {
120         bool ret = true;
121         /* Check if kernel supports NUMA. */
122         if (numa_available() != 0) {
123                 RTE_LOG(DEBUG, EAL, "NUMA is not supported.\n");
124                 ret = false;
125         }
126         return ret;
127 }
128
129 static void
130 prepare_numa(int *oldpolicy, struct bitmask *oldmask, int socket_id)
131 {
132         RTE_LOG(DEBUG, EAL, "Trying to obtain current memory policy.\n");
133         if (get_mempolicy(oldpolicy, oldmask->maskp,
134                           oldmask->size + 1, 0, 0) < 0) {
135                 RTE_LOG(ERR, EAL,
136                         "Failed to get current mempolicy: %s. "
137                         "Assuming MPOL_DEFAULT.\n", strerror(errno));
138                 oldpolicy = MPOL_DEFAULT;
139         }
140         RTE_LOG(DEBUG, EAL,
141                 "Setting policy MPOL_PREFERRED for socket %d\n",
142                 socket_id);
143         numa_set_preferred(socket_id);
144 }
145
146 static void
147 restore_numa(int *oldpolicy, struct bitmask *oldmask)
148 {
149         RTE_LOG(DEBUG, EAL,
150                 "Restoring previous memory policy: %d\n", *oldpolicy);
151         if (*oldpolicy == MPOL_DEFAULT) {
152                 numa_set_localalloc();
153         } else if (set_mempolicy(*oldpolicy, oldmask->maskp,
154                                  oldmask->size + 1) < 0) {
155                 RTE_LOG(ERR, EAL, "Failed to restore mempolicy: %s\n",
156                         strerror(errno));
157                 numa_set_localalloc();
158         }
159         numa_free_cpumask(oldmask);
160 }
161 #endif
162
163 /*
164  * uses fstat to report the size of a file on disk
165  */
166 static off_t
167 get_file_size(int fd)
168 {
169         struct stat st;
170         if (fstat(fd, &st) < 0)
171                 return 0;
172         return st.st_size;
173 }
174
175 /* we cannot use rte_memseg_list_walk() here because we will be holding a
176  * write lock whenever we enter every function in this file, however copying
177  * the same iteration code everywhere is not ideal as well. so, use a lockless
178  * copy of memseg list walk here.
179  */
180 static int
181 memseg_list_walk_thread_unsafe(rte_memseg_list_walk_t func, void *arg)
182 {
183         struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
184         int i, ret = 0;
185
186         for (i = 0; i < RTE_MAX_MEMSEG_LISTS; i++) {
187                 struct rte_memseg_list *msl = &mcfg->memsegs[i];
188
189                 if (msl->base_va == NULL)
190                         continue;
191
192                 ret = func(msl, arg);
193                 if (ret < 0)
194                         return -1;
195                 if (ret > 0)
196                         return 1;
197         }
198         return 0;
199 }
200
201 /* returns 1 on successful lock, 0 on unsuccessful lock, -1 on error */
202 static int lock(int fd, int type)
203 {
204         int ret;
205
206         /* flock may be interrupted */
207         do {
208                 ret = flock(fd, type | LOCK_NB);
209         } while (ret && errno == EINTR);
210
211         if (ret && errno == EWOULDBLOCK) {
212                 /* couldn't lock */
213                 return 0;
214         } else if (ret) {
215                 RTE_LOG(ERR, EAL, "%s(): error calling flock(): %s\n",
216                         __func__, strerror(errno));
217                 return -1;
218         }
219         /* lock was successful */
220         return 1;
221 }
222
223 static int get_segment_lock_fd(int list_idx, int seg_idx)
224 {
225         char path[PATH_MAX] = {0};
226         int fd;
227
228         if (list_idx < 0 || list_idx >= (int)RTE_DIM(lock_fds))
229                 return -1;
230         if (seg_idx < 0 || seg_idx >= lock_fds[list_idx].len)
231                 return -1;
232
233         fd = lock_fds[list_idx].fds[seg_idx];
234         /* does this lock already exist? */
235         if (fd >= 0)
236                 return fd;
237
238         eal_get_hugefile_lock_path(path, sizeof(path),
239                         list_idx * RTE_MAX_MEMSEG_PER_LIST + seg_idx);
240
241         fd = open(path, O_CREAT | O_RDWR, 0660);
242         if (fd < 0) {
243                 RTE_LOG(ERR, EAL, "%s(): error creating lockfile '%s': %s\n",
244                         __func__, path, strerror(errno));
245                 return -1;
246         }
247         /* take out a read lock */
248         if (lock(fd, LOCK_SH) != 1) {
249                 RTE_LOG(ERR, EAL, "%s(): failed to take out a readlock on '%s': %s\n",
250                         __func__, path, strerror(errno));
251                 close(fd);
252                 return -1;
253         }
254         /* store it for future reference */
255         lock_fds[list_idx].fds[seg_idx] = fd;
256         lock_fds[list_idx].count++;
257         return fd;
258 }
259
260 static int unlock_segment(int list_idx, int seg_idx)
261 {
262         int fd, ret;
263
264         if (list_idx < 0 || list_idx >= (int)RTE_DIM(lock_fds))
265                 return -1;
266         if (seg_idx < 0 || seg_idx >= lock_fds[list_idx].len)
267                 return -1;
268
269         fd = lock_fds[list_idx].fds[seg_idx];
270
271         /* upgrade lock to exclusive to see if we can remove the lockfile */
272         ret = lock(fd, LOCK_EX);
273         if (ret == 1) {
274                 /* we've succeeded in taking exclusive lock, this lockfile may
275                  * be removed.
276                  */
277                 char path[PATH_MAX] = {0};
278                 eal_get_hugefile_lock_path(path, sizeof(path),
279                                 list_idx * RTE_MAX_MEMSEG_PER_LIST + seg_idx);
280                 if (unlink(path)) {
281                         RTE_LOG(ERR, EAL, "%s(): error removing lockfile '%s': %s\n",
282                                         __func__, path, strerror(errno));
283                 }
284         }
285         /* we don't want to leak the fd, so even if we fail to lock, close fd
286          * and remove it from list anyway.
287          */
288         close(fd);
289         lock_fds[list_idx].fds[seg_idx] = -1;
290         lock_fds[list_idx].count--;
291
292         if (ret < 0)
293                 return -1;
294         return 0;
295 }
296
297 static int
298 get_seg_fd(char *path, int buflen, struct hugepage_info *hi,
299                 unsigned int list_idx, unsigned int seg_idx)
300 {
301         int fd;
302
303         if (internal_config.single_file_segments) {
304                 /* create a hugepage file path */
305                 eal_get_hugefile_path(path, buflen, hi->hugedir, list_idx);
306
307                 fd = lock_fds[list_idx].memseg_list_fd;
308
309                 if (fd < 0) {
310                         fd = open(path, O_CREAT | O_RDWR, 0600);
311                         if (fd < 0) {
312                                 RTE_LOG(ERR, EAL, "%s(): open failed: %s\n",
313                                         __func__, strerror(errno));
314                                 return -1;
315                         }
316                         /* take out a read lock and keep it indefinitely */
317                         if (lock(fd, LOCK_SH) < 0) {
318                                 RTE_LOG(ERR, EAL, "%s(): lock failed: %s\n",
319                                         __func__, strerror(errno));
320                                 close(fd);
321                                 return -1;
322                         }
323                         lock_fds[list_idx].memseg_list_fd = fd;
324                 }
325         } else {
326                 /* create a hugepage file path */
327                 eal_get_hugefile_path(path, buflen, hi->hugedir,
328                                 list_idx * RTE_MAX_MEMSEG_PER_LIST + seg_idx);
329                 fd = open(path, O_CREAT | O_RDWR, 0600);
330                 if (fd < 0) {
331                         RTE_LOG(DEBUG, EAL, "%s(): open failed: %s\n", __func__,
332                                         strerror(errno));
333                         return -1;
334                 }
335                 /* take out a read lock */
336                 if (lock(fd, LOCK_SH) < 0) {
337                         RTE_LOG(ERR, EAL, "%s(): lock failed: %s\n",
338                                 __func__, strerror(errno));
339                         close(fd);
340                         return -1;
341                 }
342         }
343         return fd;
344 }
345
346 static int
347 resize_hugefile(int fd, char *path, int list_idx, int seg_idx,
348                 uint64_t fa_offset, uint64_t page_sz, bool grow)
349 {
350         bool again = false;
351         do {
352                 if (fallocate_supported == 0) {
353                         /* we cannot deallocate memory if fallocate() is not
354                          * supported, and hugepage file is already locked at
355                          * creation, so no further synchronization needed.
356                          */
357
358                         if (!grow) {
359                                 RTE_LOG(DEBUG, EAL, "%s(): fallocate not supported, not freeing page back to the system\n",
360                                         __func__);
361                                 return -1;
362                         }
363                         uint64_t new_size = fa_offset + page_sz;
364                         uint64_t cur_size = get_file_size(fd);
365
366                         /* fallocate isn't supported, fall back to ftruncate */
367                         if (new_size > cur_size &&
368                                         ftruncate(fd, new_size) < 0) {
369                                 RTE_LOG(DEBUG, EAL, "%s(): ftruncate() failed: %s\n",
370                                         __func__, strerror(errno));
371                                 return -1;
372                         }
373                 } else {
374                         int flags = grow ? 0 : FALLOC_FL_PUNCH_HOLE |
375                                         FALLOC_FL_KEEP_SIZE;
376                         int ret, lock_fd;
377
378                         /* if fallocate() is supported, we need to take out a
379                          * read lock on allocate (to prevent other processes
380                          * from deallocating this page), and take out a write
381                          * lock on deallocate (to ensure nobody else is using
382                          * this page).
383                          *
384                          * read locks on page itself are already taken out at
385                          * file creation, in get_seg_fd().
386                          *
387                          * we cannot rely on simple use of flock() call, because
388                          * we need to be able to lock a section of the file,
389                          * and we cannot use fcntl() locks, because of numerous
390                          * problems with their semantics, so we will use
391                          * deterministically named lock files for each section
392                          * of the file.
393                          *
394                          * if we're shrinking the file, we want to upgrade our
395                          * lock from shared to exclusive.
396                          *
397                          * lock_fd is an fd for a lockfile, not for the segment
398                          * list.
399                          */
400                         lock_fd = get_segment_lock_fd(list_idx, seg_idx);
401
402                         if (!grow) {
403                                 /* we are using this lockfile to determine
404                                  * whether this particular page is locked, as we
405                                  * are in single file segments mode and thus
406                                  * cannot use regular flock() to get this info.
407                                  *
408                                  * we want to try and take out an exclusive lock
409                                  * on the lock file to determine if we're the
410                                  * last ones using this page, and if not, we
411                                  * won't be shrinking it, and will instead exit
412                                  * prematurely.
413                                  */
414                                 ret = lock(lock_fd, LOCK_EX);
415
416                                 /* drop the lock on the lockfile, so that even
417                                  * if we couldn't shrink the file ourselves, we
418                                  * are signalling to other processes that we're
419                                  * no longer using this page.
420                                  */
421                                 if (unlock_segment(list_idx, seg_idx))
422                                         RTE_LOG(ERR, EAL, "Could not unlock segment\n");
423
424                                 /* additionally, if this was the last lock on
425                                  * this segment list, we can safely close the
426                                  * page file fd, so that one of the processes
427                                  * could then delete the file after shrinking.
428                                  */
429                                 if (ret < 1 && lock_fds[list_idx].count == 0) {
430                                         close(fd);
431                                         lock_fds[list_idx].memseg_list_fd = -1;
432                                 }
433
434                                 if (ret < 0) {
435                                         RTE_LOG(ERR, EAL, "Could not lock segment\n");
436                                         return -1;
437                                 }
438                                 if (ret == 0)
439                                         /* failed to lock, not an error. */
440                                         return 0;
441                         }
442
443                         /* grow or shrink the file */
444                         ret = fallocate(fd, flags, fa_offset, page_sz);
445
446                         if (ret < 0) {
447                                 if (fallocate_supported == -1 &&
448                                                 errno == ENOTSUP) {
449                                         RTE_LOG(ERR, EAL, "%s(): fallocate() not supported, hugepage deallocation will be disabled\n",
450                                                 __func__);
451                                         again = true;
452                                         fallocate_supported = 0;
453                                 } else {
454                                         RTE_LOG(DEBUG, EAL, "%s(): fallocate() failed: %s\n",
455                                                 __func__,
456                                                 strerror(errno));
457                                         return -1;
458                                 }
459                         } else {
460                                 fallocate_supported = 1;
461
462                                 /* we've grew/shrunk the file, and we hold an
463                                  * exclusive lock now. check if there are no
464                                  * more segments active in this segment list,
465                                  * and remove the file if there aren't.
466                                  */
467                                 if (lock_fds[list_idx].count == 0) {
468                                         if (unlink(path))
469                                                 RTE_LOG(ERR, EAL, "%s(): unlinking '%s' failed: %s\n",
470                                                         __func__, path,
471                                                         strerror(errno));
472                                         close(fd);
473                                         lock_fds[list_idx].memseg_list_fd = -1;
474                                 }
475                         }
476                 }
477         } while (again);
478         return 0;
479 }
480
481 static int
482 alloc_seg(struct rte_memseg *ms, void *addr, int socket_id,
483                 struct hugepage_info *hi, unsigned int list_idx,
484                 unsigned int seg_idx)
485 {
486 #ifdef RTE_EAL_NUMA_AWARE_HUGEPAGES
487         int cur_socket_id = 0;
488 #endif
489         uint64_t map_offset;
490         char path[PATH_MAX];
491         int ret = 0;
492         int fd;
493         size_t alloc_sz;
494         int flags;
495         void *new_addr;
496
497         /* takes out a read lock on segment or segment list */
498         fd = get_seg_fd(path, sizeof(path), hi, list_idx, seg_idx);
499         if (fd < 0) {
500                 RTE_LOG(ERR, EAL, "Couldn't get fd on hugepage file\n");
501                 return -1;
502         }
503
504         alloc_sz = hi->hugepage_sz;
505         if (internal_config.single_file_segments) {
506                 map_offset = seg_idx * alloc_sz;
507                 ret = resize_hugefile(fd, path, list_idx, seg_idx, map_offset,
508                                 alloc_sz, true);
509                 if (ret < 0)
510                         goto resized;
511         } else {
512                 map_offset = 0;
513                 if (ftruncate(fd, alloc_sz) < 0) {
514                         RTE_LOG(DEBUG, EAL, "%s(): ftruncate() failed: %s\n",
515                                 __func__, strerror(errno));
516                         goto resized;
517                 }
518         }
519
520         /*
521          * map the segment, and populate page tables, the kernel fills this
522          * segment with zeros if it's a new page.
523          */
524         void *va = mmap(addr, alloc_sz, PROT_READ | PROT_WRITE,
525                         MAP_SHARED | MAP_POPULATE | MAP_FIXED, fd, map_offset);
526
527         if (va == MAP_FAILED) {
528                 RTE_LOG(DEBUG, EAL, "%s(): mmap() failed: %s\n", __func__,
529                         strerror(errno));
530                 /* mmap failed, but the previous region might have been
531                  * unmapped anyway. try to remap it
532                  */
533                 goto unmapped;
534         }
535         if (va != addr) {
536                 RTE_LOG(DEBUG, EAL, "%s(): wrong mmap() address\n", __func__);
537                 munmap(va, alloc_sz);
538                 goto resized;
539         }
540
541         rte_iova_t iova = rte_mem_virt2iova(addr);
542         if (iova == RTE_BAD_PHYS_ADDR) {
543                 RTE_LOG(DEBUG, EAL, "%s(): can't get IOVA addr\n",
544                         __func__);
545                 goto mapped;
546         }
547
548 #ifdef RTE_EAL_NUMA_AWARE_HUGEPAGES
549         move_pages(getpid(), 1, &addr, NULL, &cur_socket_id, 0);
550
551         if (cur_socket_id != socket_id) {
552                 RTE_LOG(DEBUG, EAL,
553                                 "%s(): allocation happened on wrong socket (wanted %d, got %d)\n",
554                         __func__, socket_id, cur_socket_id);
555                 goto mapped;
556         }
557 #endif
558
559         /* In linux, hugetlb limitations, like cgroup, are
560          * enforced at fault time instead of mmap(), even
561          * with the option of MAP_POPULATE. Kernel will send
562          * a SIGBUS signal. To avoid to be killed, save stack
563          * environment here, if SIGBUS happens, we can jump
564          * back here.
565          */
566         if (huge_wrap_sigsetjmp()) {
567                 RTE_LOG(DEBUG, EAL, "SIGBUS: Cannot mmap more hugepages of size %uMB\n",
568                         (unsigned int)(alloc_sz >> 20));
569                 goto mapped;
570         }
571         /* for non-single file segments, we can close fd here */
572         if (!internal_config.single_file_segments)
573                 close(fd);
574
575         /* we need to trigger a write to the page to enforce page fault and
576          * ensure that page is accessible to us, but we can't overwrite value
577          * that is already there, so read the old value, and write itback.
578          * kernel populates the page with zeroes initially.
579          */
580         *(volatile int *)addr = *(volatile int *)addr;
581
582         ms->addr = addr;
583         ms->hugepage_sz = alloc_sz;
584         ms->len = alloc_sz;
585         ms->nchannel = rte_memory_get_nchannel();
586         ms->nrank = rte_memory_get_nrank();
587         ms->iova = iova;
588         ms->socket_id = socket_id;
589
590         return 0;
591
592 mapped:
593         munmap(addr, alloc_sz);
594 unmapped:
595         flags = MAP_FIXED;
596 #ifdef RTE_ARCH_PPC_64
597         flags |= MAP_HUGETLB;
598 #endif
599         new_addr = eal_get_virtual_area(addr, &alloc_sz, alloc_sz, 0, flags);
600         if (new_addr != addr) {
601                 if (new_addr != NULL)
602                         munmap(new_addr, alloc_sz);
603                 /* we're leaving a hole in our virtual address space. if
604                  * somebody else maps this hole now, we could accidentally
605                  * override it in the future.
606                  */
607                 RTE_LOG(CRIT, EAL, "Can't mmap holes in our virtual address space\n");
608         }
609 resized:
610         if (internal_config.single_file_segments) {
611                 resize_hugefile(fd, path, list_idx, seg_idx, map_offset,
612                                 alloc_sz, false);
613                 /* ignore failure, can't make it any worse */
614         } else {
615                 /* only remove file if we can take out a write lock */
616                 if (lock(fd, LOCK_EX) == 1)
617                         unlink(path);
618                 close(fd);
619         }
620         return -1;
621 }
622
623 static int
624 free_seg(struct rte_memseg *ms, struct hugepage_info *hi,
625                 unsigned int list_idx, unsigned int seg_idx)
626 {
627         uint64_t map_offset;
628         char path[PATH_MAX];
629         int fd, ret;
630
631         /* erase page data */
632         memset(ms->addr, 0, ms->len);
633
634         if (mmap(ms->addr, ms->len, PROT_READ,
635                         MAP_PRIVATE | MAP_ANONYMOUS | MAP_FIXED, -1, 0) ==
636                                 MAP_FAILED) {
637                 RTE_LOG(DEBUG, EAL, "couldn't unmap page\n");
638                 return -1;
639         }
640
641         /* if we are not in single file segments mode, we're going to unmap the
642          * segment and thus drop the lock on original fd, but hugepage dir is
643          * now locked so we can take out another one without races.
644          */
645         fd = get_seg_fd(path, sizeof(path), hi, list_idx, seg_idx);
646         if (fd < 0)
647                 return -1;
648
649         if (internal_config.single_file_segments) {
650                 map_offset = seg_idx * ms->len;
651                 if (resize_hugefile(fd, path, list_idx, seg_idx, map_offset,
652                                 ms->len, false))
653                         return -1;
654                 ret = 0;
655         } else {
656                 /* if we're able to take out a write lock, we're the last one
657                  * holding onto this page.
658                  */
659                 ret = lock(fd, LOCK_EX);
660                 if (ret >= 0) {
661                         /* no one else is using this page */
662                         if (ret == 1)
663                                 unlink(path);
664                 }
665                 /* closing fd will drop the lock */
666                 close(fd);
667         }
668
669         memset(ms, 0, sizeof(*ms));
670
671         return ret < 0 ? -1 : 0;
672 }
673
674 struct alloc_walk_param {
675         struct hugepage_info *hi;
676         struct rte_memseg **ms;
677         size_t page_sz;
678         unsigned int segs_allocated;
679         unsigned int n_segs;
680         int socket;
681         bool exact;
682 };
683 static int
684 alloc_seg_walk(const struct rte_memseg_list *msl, void *arg)
685 {
686         struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
687         struct alloc_walk_param *wa = arg;
688         struct rte_memseg_list *cur_msl;
689         size_t page_sz;
690         int cur_idx, start_idx, j, dir_fd = -1;
691         unsigned int msl_idx, need, i;
692
693         if (msl->page_sz != wa->page_sz)
694                 return 0;
695         if (msl->socket_id != wa->socket)
696                 return 0;
697
698         page_sz = (size_t)msl->page_sz;
699
700         msl_idx = msl - mcfg->memsegs;
701         cur_msl = &mcfg->memsegs[msl_idx];
702
703         need = wa->n_segs;
704
705         /* try finding space in memseg list */
706         cur_idx = rte_fbarray_find_next_n_free(&cur_msl->memseg_arr, 0, need);
707         if (cur_idx < 0)
708                 return 0;
709         start_idx = cur_idx;
710
711         /* do not allow any page allocations during the time we're allocating,
712          * because file creation and locking operations are not atomic,
713          * and we might be the first or the last ones to use a particular page,
714          * so we need to ensure atomicity of every operation.
715          *
716          * during init, we already hold a write lock, so don't try to take out
717          * another one.
718          */
719         if (wa->hi->lock_descriptor == -1) {
720                 dir_fd = open(wa->hi->hugedir, O_RDONLY);
721                 if (dir_fd < 0) {
722                         RTE_LOG(ERR, EAL, "%s(): Cannot open '%s': %s\n",
723                                 __func__, wa->hi->hugedir, strerror(errno));
724                         return -1;
725                 }
726                 /* blocking writelock */
727                 if (flock(dir_fd, LOCK_EX)) {
728                         RTE_LOG(ERR, EAL, "%s(): Cannot lock '%s': %s\n",
729                                 __func__, wa->hi->hugedir, strerror(errno));
730                         close(dir_fd);
731                         return -1;
732                 }
733         }
734
735         for (i = 0; i < need; i++, cur_idx++) {
736                 struct rte_memseg *cur;
737                 void *map_addr;
738
739                 cur = rte_fbarray_get(&cur_msl->memseg_arr, cur_idx);
740                 map_addr = RTE_PTR_ADD(cur_msl->base_va,
741                                 cur_idx * page_sz);
742
743                 if (alloc_seg(cur, map_addr, wa->socket, wa->hi,
744                                 msl_idx, cur_idx)) {
745                         RTE_LOG(DEBUG, EAL, "attempted to allocate %i segments, but only %i were allocated\n",
746                                 need, i);
747
748                         /* if exact number wasn't requested, stop */
749                         if (!wa->exact)
750                                 goto out;
751
752                         /* clean up */
753                         for (j = start_idx; j < cur_idx; j++) {
754                                 struct rte_memseg *tmp;
755                                 struct rte_fbarray *arr =
756                                                 &cur_msl->memseg_arr;
757
758                                 tmp = rte_fbarray_get(arr, j);
759                                 rte_fbarray_set_free(arr, j);
760
761                                 /* free_seg may attempt to create a file, which
762                                  * may fail.
763                                  */
764                                 if (free_seg(tmp, wa->hi, msl_idx, j))
765                                         RTE_LOG(DEBUG, EAL, "Cannot free page\n");
766                         }
767                         /* clear the list */
768                         if (wa->ms)
769                                 memset(wa->ms, 0, sizeof(*wa->ms) * wa->n_segs);
770
771                         if (dir_fd >= 0)
772                                 close(dir_fd);
773                         return -1;
774                 }
775                 if (wa->ms)
776                         wa->ms[i] = cur;
777
778                 rte_fbarray_set_used(&cur_msl->memseg_arr, cur_idx);
779         }
780 out:
781         wa->segs_allocated = i;
782         if (i > 0)
783                 cur_msl->version++;
784         if (dir_fd >= 0)
785                 close(dir_fd);
786         return 1;
787 }
788
789 struct free_walk_param {
790         struct hugepage_info *hi;
791         struct rte_memseg *ms;
792 };
793 static int
794 free_seg_walk(const struct rte_memseg_list *msl, void *arg)
795 {
796         struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
797         struct rte_memseg_list *found_msl;
798         struct free_walk_param *wa = arg;
799         uintptr_t start_addr, end_addr;
800         int msl_idx, seg_idx, ret, dir_fd = -1;
801
802         start_addr = (uintptr_t) msl->base_va;
803         end_addr = start_addr + msl->memseg_arr.len * (size_t)msl->page_sz;
804
805         if ((uintptr_t)wa->ms->addr < start_addr ||
806                         (uintptr_t)wa->ms->addr >= end_addr)
807                 return 0;
808
809         msl_idx = msl - mcfg->memsegs;
810         seg_idx = RTE_PTR_DIFF(wa->ms->addr, start_addr) / msl->page_sz;
811
812         /* msl is const */
813         found_msl = &mcfg->memsegs[msl_idx];
814
815         /* do not allow any page allocations during the time we're freeing,
816          * because file creation and locking operations are not atomic,
817          * and we might be the first or the last ones to use a particular page,
818          * so we need to ensure atomicity of every operation.
819          *
820          * during init, we already hold a write lock, so don't try to take out
821          * another one.
822          */
823         if (wa->hi->lock_descriptor == -1) {
824                 dir_fd = open(wa->hi->hugedir, O_RDONLY);
825                 if (dir_fd < 0) {
826                         RTE_LOG(ERR, EAL, "%s(): Cannot open '%s': %s\n",
827                                 __func__, wa->hi->hugedir, strerror(errno));
828                         return -1;
829                 }
830                 /* blocking writelock */
831                 if (flock(dir_fd, LOCK_EX)) {
832                         RTE_LOG(ERR, EAL, "%s(): Cannot lock '%s': %s\n",
833                                 __func__, wa->hi->hugedir, strerror(errno));
834                         close(dir_fd);
835                         return -1;
836                 }
837         }
838
839         found_msl->version++;
840
841         rte_fbarray_set_free(&found_msl->memseg_arr, seg_idx);
842
843         ret = free_seg(wa->ms, wa->hi, msl_idx, seg_idx);
844
845         if (dir_fd >= 0)
846                 close(dir_fd);
847
848         if (ret < 0)
849                 return -1;
850
851         return 1;
852 }
853
854 int
855 eal_memalloc_alloc_seg_bulk(struct rte_memseg **ms, int n_segs, size_t page_sz,
856                 int socket, bool exact)
857 {
858         int i, ret = -1;
859 #ifdef RTE_EAL_NUMA_AWARE_HUGEPAGES
860         bool have_numa = false;
861         int oldpolicy;
862         struct bitmask *oldmask;
863 #endif
864         struct alloc_walk_param wa;
865         struct hugepage_info *hi = NULL;
866
867         memset(&wa, 0, sizeof(wa));
868
869         /* dynamic allocation not supported in legacy mode */
870         if (internal_config.legacy_mem)
871                 return -1;
872
873         for (i = 0; i < (int) RTE_DIM(internal_config.hugepage_info); i++) {
874                 if (page_sz ==
875                                 internal_config.hugepage_info[i].hugepage_sz) {
876                         hi = &internal_config.hugepage_info[i];
877                         break;
878                 }
879         }
880         if (!hi) {
881                 RTE_LOG(ERR, EAL, "%s(): can't find relevant hugepage_info entry\n",
882                         __func__);
883                 return -1;
884         }
885
886 #ifdef RTE_EAL_NUMA_AWARE_HUGEPAGES
887         if (check_numa()) {
888                 oldmask = numa_allocate_nodemask();
889                 prepare_numa(&oldpolicy, oldmask, socket);
890                 have_numa = true;
891         }
892 #endif
893
894         wa.exact = exact;
895         wa.hi = hi;
896         wa.ms = ms;
897         wa.n_segs = n_segs;
898         wa.page_sz = page_sz;
899         wa.socket = socket;
900         wa.segs_allocated = 0;
901
902         ret = memseg_list_walk_thread_unsafe(alloc_seg_walk, &wa);
903         if (ret == 0) {
904                 RTE_LOG(ERR, EAL, "%s(): couldn't find suitable memseg_list\n",
905                         __func__);
906                 ret = -1;
907         } else if (ret > 0) {
908                 ret = (int)wa.segs_allocated;
909         }
910
911 #ifdef RTE_EAL_NUMA_AWARE_HUGEPAGES
912         if (have_numa)
913                 restore_numa(&oldpolicy, oldmask);
914 #endif
915         return ret;
916 }
917
918 struct rte_memseg *
919 eal_memalloc_alloc_seg(size_t page_sz, int socket)
920 {
921         struct rte_memseg *ms;
922         if (eal_memalloc_alloc_seg_bulk(&ms, 1, page_sz, socket, true) < 0)
923                 return NULL;
924         /* return pointer to newly allocated memseg */
925         return ms;
926 }
927
928 int
929 eal_memalloc_free_seg_bulk(struct rte_memseg **ms, int n_segs)
930 {
931         int seg, ret = 0;
932
933         /* dynamic free not supported in legacy mode */
934         if (internal_config.legacy_mem)
935                 return -1;
936
937         for (seg = 0; seg < n_segs; seg++) {
938                 struct rte_memseg *cur = ms[seg];
939                 struct hugepage_info *hi = NULL;
940                 struct free_walk_param wa;
941                 int i, walk_res;
942
943                 /* if this page is marked as unfreeable, fail */
944                 if (cur->flags & RTE_MEMSEG_FLAG_DO_NOT_FREE) {
945                         RTE_LOG(DEBUG, EAL, "Page is not allowed to be freed\n");
946                         ret = -1;
947                         continue;
948                 }
949
950                 memset(&wa, 0, sizeof(wa));
951
952                 for (i = 0; i < (int)RTE_DIM(internal_config.hugepage_info);
953                                 i++) {
954                         hi = &internal_config.hugepage_info[i];
955                         if (cur->hugepage_sz == hi->hugepage_sz)
956                                 break;
957                 }
958                 if (i == (int)RTE_DIM(internal_config.hugepage_info)) {
959                         RTE_LOG(ERR, EAL, "Can't find relevant hugepage_info entry\n");
960                         ret = -1;
961                         continue;
962                 }
963
964                 wa.ms = cur;
965                 wa.hi = hi;
966
967                 walk_res = memseg_list_walk_thread_unsafe(free_seg_walk, &wa);
968                 if (walk_res == 1)
969                         continue;
970                 if (walk_res == 0)
971                         RTE_LOG(ERR, EAL, "Couldn't find memseg list\n");
972                 ret = -1;
973         }
974         return ret;
975 }
976
977 int
978 eal_memalloc_free_seg(struct rte_memseg *ms)
979 {
980         /* dynamic free not supported in legacy mode */
981         if (internal_config.legacy_mem)
982                 return -1;
983
984         return eal_memalloc_free_seg_bulk(&ms, 1);
985 }
986
987 static int
988 sync_chunk(struct rte_memseg_list *primary_msl,
989                 struct rte_memseg_list *local_msl, struct hugepage_info *hi,
990                 unsigned int msl_idx, bool used, int start, int end)
991 {
992         struct rte_fbarray *l_arr, *p_arr;
993         int i, ret, chunk_len, diff_len;
994
995         l_arr = &local_msl->memseg_arr;
996         p_arr = &primary_msl->memseg_arr;
997
998         /* we need to aggregate allocations/deallocations into bigger chunks,
999          * as we don't want to spam the user with per-page callbacks.
1000          *
1001          * to avoid any potential issues, we also want to trigger
1002          * deallocation callbacks *before* we actually deallocate
1003          * memory, so that the user application could wrap up its use
1004          * before it goes away.
1005          */
1006
1007         chunk_len = end - start;
1008
1009         /* find how many contiguous pages we can map/unmap for this chunk */
1010         diff_len = used ?
1011                         rte_fbarray_find_contig_free(l_arr, start) :
1012                         rte_fbarray_find_contig_used(l_arr, start);
1013
1014         /* has to be at least one page */
1015         if (diff_len < 1)
1016                 return -1;
1017
1018         diff_len = RTE_MIN(chunk_len, diff_len);
1019
1020         /* if we are freeing memory, notify the application */
1021         if (!used) {
1022                 struct rte_memseg *ms;
1023                 void *start_va;
1024                 size_t len, page_sz;
1025
1026                 ms = rte_fbarray_get(l_arr, start);
1027                 start_va = ms->addr;
1028                 page_sz = (size_t)primary_msl->page_sz;
1029                 len = page_sz * diff_len;
1030
1031                 eal_memalloc_mem_event_notify(RTE_MEM_EVENT_FREE,
1032                                 start_va, len);
1033         }
1034
1035         for (i = 0; i < diff_len; i++) {
1036                 struct rte_memseg *p_ms, *l_ms;
1037                 int seg_idx = start + i;
1038
1039                 l_ms = rte_fbarray_get(l_arr, seg_idx);
1040                 p_ms = rte_fbarray_get(p_arr, seg_idx);
1041
1042                 if (l_ms == NULL || p_ms == NULL)
1043                         return -1;
1044
1045                 if (used) {
1046                         ret = alloc_seg(l_ms, p_ms->addr,
1047                                         p_ms->socket_id, hi,
1048                                         msl_idx, seg_idx);
1049                         if (ret < 0)
1050                                 return -1;
1051                         rte_fbarray_set_used(l_arr, seg_idx);
1052                 } else {
1053                         ret = free_seg(l_ms, hi, msl_idx, seg_idx);
1054                         rte_fbarray_set_free(l_arr, seg_idx);
1055                         if (ret < 0)
1056                                 return -1;
1057                 }
1058         }
1059
1060         /* if we just allocated memory, notify the application */
1061         if (used) {
1062                 struct rte_memseg *ms;
1063                 void *start_va;
1064                 size_t len, page_sz;
1065
1066                 ms = rte_fbarray_get(l_arr, start);
1067                 start_va = ms->addr;
1068                 page_sz = (size_t)primary_msl->page_sz;
1069                 len = page_sz * diff_len;
1070
1071                 eal_memalloc_mem_event_notify(RTE_MEM_EVENT_ALLOC,
1072                                 start_va, len);
1073         }
1074
1075         /* calculate how much we can advance until next chunk */
1076         diff_len = used ?
1077                         rte_fbarray_find_contig_used(l_arr, start) :
1078                         rte_fbarray_find_contig_free(l_arr, start);
1079         ret = RTE_MIN(chunk_len, diff_len);
1080
1081         return ret;
1082 }
1083
1084 static int
1085 sync_status(struct rte_memseg_list *primary_msl,
1086                 struct rte_memseg_list *local_msl, struct hugepage_info *hi,
1087                 unsigned int msl_idx, bool used)
1088 {
1089         struct rte_fbarray *l_arr, *p_arr;
1090         int p_idx, l_chunk_len, p_chunk_len, ret;
1091         int start, end;
1092
1093         /* this is a little bit tricky, but the basic idea is - walk both lists
1094          * and spot any places where there are discrepancies. walking both lists
1095          * and noting discrepancies in a single go is a hard problem, so we do
1096          * it in two passes - first we spot any places where allocated segments
1097          * mismatch (i.e. ensure that everything that's allocated in the primary
1098          * is also allocated in the secondary), and then we do it by looking at
1099          * free segments instead.
1100          *
1101          * we also need to aggregate changes into chunks, as we have to call
1102          * callbacks per allocation, not per page.
1103          */
1104         l_arr = &local_msl->memseg_arr;
1105         p_arr = &primary_msl->memseg_arr;
1106
1107         if (used)
1108                 p_idx = rte_fbarray_find_next_used(p_arr, 0);
1109         else
1110                 p_idx = rte_fbarray_find_next_free(p_arr, 0);
1111
1112         while (p_idx >= 0) {
1113                 int next_chunk_search_idx;
1114
1115                 if (used) {
1116                         p_chunk_len = rte_fbarray_find_contig_used(p_arr,
1117                                         p_idx);
1118                         l_chunk_len = rte_fbarray_find_contig_used(l_arr,
1119                                         p_idx);
1120                 } else {
1121                         p_chunk_len = rte_fbarray_find_contig_free(p_arr,
1122                                         p_idx);
1123                         l_chunk_len = rte_fbarray_find_contig_free(l_arr,
1124                                         p_idx);
1125                 }
1126                 /* best case scenario - no differences (or bigger, which will be
1127                  * fixed during next iteration), look for next chunk
1128                  */
1129                 if (l_chunk_len >= p_chunk_len) {
1130                         next_chunk_search_idx = p_idx + p_chunk_len;
1131                         goto next_chunk;
1132                 }
1133
1134                 /* if both chunks start at the same point, skip parts we know
1135                  * are identical, and sync the rest. each call to sync_chunk
1136                  * will only sync contiguous segments, so we need to call this
1137                  * until we are sure there are no more differences in this
1138                  * chunk.
1139                  */
1140                 start = p_idx + l_chunk_len;
1141                 end = p_idx + p_chunk_len;
1142                 do {
1143                         ret = sync_chunk(primary_msl, local_msl, hi, msl_idx,
1144                                         used, start, end);
1145                         start += ret;
1146                 } while (start < end && ret >= 0);
1147                 /* if ret is negative, something went wrong */
1148                 if (ret < 0)
1149                         return -1;
1150
1151                 next_chunk_search_idx = p_idx + p_chunk_len;
1152 next_chunk:
1153                 /* skip to end of this chunk */
1154                 if (used) {
1155                         p_idx = rte_fbarray_find_next_used(p_arr,
1156                                         next_chunk_search_idx);
1157                 } else {
1158                         p_idx = rte_fbarray_find_next_free(p_arr,
1159                                         next_chunk_search_idx);
1160                 }
1161         }
1162         return 0;
1163 }
1164
1165 static int
1166 sync_existing(struct rte_memseg_list *primary_msl,
1167                 struct rte_memseg_list *local_msl, struct hugepage_info *hi,
1168                 unsigned int msl_idx)
1169 {
1170         int ret, dir_fd;
1171
1172         /* do not allow any page allocations during the time we're allocating,
1173          * because file creation and locking operations are not atomic,
1174          * and we might be the first or the last ones to use a particular page,
1175          * so we need to ensure atomicity of every operation.
1176          */
1177         dir_fd = open(hi->hugedir, O_RDONLY);
1178         if (dir_fd < 0) {
1179                 RTE_LOG(ERR, EAL, "%s(): Cannot open '%s': %s\n", __func__,
1180                         hi->hugedir, strerror(errno));
1181                 return -1;
1182         }
1183         /* blocking writelock */
1184         if (flock(dir_fd, LOCK_EX)) {
1185                 RTE_LOG(ERR, EAL, "%s(): Cannot lock '%s': %s\n", __func__,
1186                         hi->hugedir, strerror(errno));
1187                 close(dir_fd);
1188                 return -1;
1189         }
1190
1191         /* ensure all allocated space is the same in both lists */
1192         ret = sync_status(primary_msl, local_msl, hi, msl_idx, true);
1193         if (ret < 0)
1194                 goto fail;
1195
1196         /* ensure all unallocated space is the same in both lists */
1197         ret = sync_status(primary_msl, local_msl, hi, msl_idx, false);
1198         if (ret < 0)
1199                 goto fail;
1200
1201         /* update version number */
1202         local_msl->version = primary_msl->version;
1203
1204         close(dir_fd);
1205
1206         return 0;
1207 fail:
1208         close(dir_fd);
1209         return -1;
1210 }
1211
1212 static int
1213 sync_walk(const struct rte_memseg_list *msl, void *arg __rte_unused)
1214 {
1215         struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
1216         struct rte_memseg_list *primary_msl, *local_msl;
1217         struct hugepage_info *hi = NULL;
1218         unsigned int i;
1219         int msl_idx;
1220
1221         msl_idx = msl - mcfg->memsegs;
1222         primary_msl = &mcfg->memsegs[msl_idx];
1223         local_msl = &local_memsegs[msl_idx];
1224
1225         for (i = 0; i < RTE_DIM(internal_config.hugepage_info); i++) {
1226                 uint64_t cur_sz =
1227                         internal_config.hugepage_info[i].hugepage_sz;
1228                 uint64_t msl_sz = primary_msl->page_sz;
1229                 if (msl_sz == cur_sz) {
1230                         hi = &internal_config.hugepage_info[i];
1231                         break;
1232                 }
1233         }
1234         if (!hi) {
1235                 RTE_LOG(ERR, EAL, "Can't find relevant hugepage_info entry\n");
1236                 return -1;
1237         }
1238
1239         /* if versions don't match, synchronize everything */
1240         if (local_msl->version != primary_msl->version &&
1241                         sync_existing(primary_msl, local_msl, hi, msl_idx))
1242                 return -1;
1243         return 0;
1244 }
1245
1246
1247 int
1248 eal_memalloc_sync_with_primary(void)
1249 {
1250         /* nothing to be done in primary */
1251         if (rte_eal_process_type() == RTE_PROC_PRIMARY)
1252                 return 0;
1253
1254         if (memseg_list_walk_thread_unsafe(sync_walk, NULL))
1255                 return -1;
1256         return 0;
1257 }
1258
1259 static int
1260 secondary_msl_create_walk(const struct rte_memseg_list *msl,
1261                 void *arg __rte_unused)
1262 {
1263         struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
1264         struct rte_memseg_list *primary_msl, *local_msl;
1265         char name[PATH_MAX];
1266         int msl_idx, ret;
1267
1268         msl_idx = msl - mcfg->memsegs;
1269         primary_msl = &mcfg->memsegs[msl_idx];
1270         local_msl = &local_memsegs[msl_idx];
1271
1272         /* create distinct fbarrays for each secondary */
1273         snprintf(name, RTE_FBARRAY_NAME_LEN, "%s_%i",
1274                 primary_msl->memseg_arr.name, getpid());
1275
1276         ret = rte_fbarray_init(&local_msl->memseg_arr, name,
1277                 primary_msl->memseg_arr.len,
1278                 primary_msl->memseg_arr.elt_sz);
1279         if (ret < 0) {
1280                 RTE_LOG(ERR, EAL, "Cannot initialize local memory map\n");
1281                 return -1;
1282         }
1283         local_msl->base_va = primary_msl->base_va;
1284
1285         return 0;
1286 }
1287
1288 static int
1289 secondary_lock_list_create_walk(const struct rte_memseg_list *msl,
1290                 void *arg __rte_unused)
1291 {
1292         struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
1293         unsigned int i, len;
1294         int msl_idx;
1295         int *data;
1296
1297         msl_idx = msl - mcfg->memsegs;
1298         len = msl->memseg_arr.len;
1299
1300         /* ensure we have space to store lock fd per each possible segment */
1301         data = malloc(sizeof(int) * len);
1302         if (data == NULL) {
1303                 RTE_LOG(ERR, EAL, "Unable to allocate space for lock descriptors\n");
1304                 return -1;
1305         }
1306         /* set all fd's as invalid */
1307         for (i = 0; i < len; i++)
1308                 data[i] = -1;
1309
1310         lock_fds[msl_idx].fds = data;
1311         lock_fds[msl_idx].len = len;
1312         lock_fds[msl_idx].count = 0;
1313         lock_fds[msl_idx].memseg_list_fd = -1;
1314
1315         return 0;
1316 }
1317
1318 int
1319 eal_memalloc_init(void)
1320 {
1321         if (rte_eal_process_type() == RTE_PROC_SECONDARY)
1322                 if (rte_memseg_list_walk(secondary_msl_create_walk, NULL) < 0)
1323                         return -1;
1324
1325         /* initialize all of the lock fd lists */
1326         if (internal_config.single_file_segments)
1327                 if (rte_memseg_list_walk(secondary_lock_list_create_walk, NULL))
1328                         return -1;
1329         return 0;
1330 }