mem: fix potential resource leak on freeing
[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
43 /*
44  * not all kernel version support fallocate on hugetlbfs, so fall back to
45  * ftruncate and disallow deallocation if fallocate is not supported.
46  */
47 static int fallocate_supported = -1; /* unknown */
48
49 /*
50  * If each page is in a separate file, we can close fd's since we need each fd
51  * only once. However, in single file segments mode, we can get away with using
52  * a single fd for entire segments, but we need to store them somewhere. Each
53  * fd is different within each process, so we'll store them in a local tailq.
54  */
55 struct msl_entry {
56         TAILQ_ENTRY(msl_entry) next;
57         unsigned int msl_idx;
58         int fd;
59 };
60
61 /** Double linked list of memseg list fd's. */
62 TAILQ_HEAD(msl_entry_list, msl_entry);
63
64 static struct msl_entry_list msl_entry_list =
65                 TAILQ_HEAD_INITIALIZER(msl_entry_list);
66 static rte_spinlock_t tailq_lock = RTE_SPINLOCK_INITIALIZER;
67
68 /** local copy of a memory map, used to synchronize memory hotplug in MP */
69 static struct rte_memseg_list local_memsegs[RTE_MAX_MEMSEG_LISTS];
70
71 static sigjmp_buf huge_jmpenv;
72
73 static void __rte_unused huge_sigbus_handler(int signo __rte_unused)
74 {
75         siglongjmp(huge_jmpenv, 1);
76 }
77
78 /* Put setjmp into a wrap method to avoid compiling error. Any non-volatile,
79  * non-static local variable in the stack frame calling sigsetjmp might be
80  * clobbered by a call to longjmp.
81  */
82 static int __rte_unused huge_wrap_sigsetjmp(void)
83 {
84         return sigsetjmp(huge_jmpenv, 1);
85 }
86
87 static struct sigaction huge_action_old;
88 static int huge_need_recover;
89
90 static void __rte_unused
91 huge_register_sigbus(void)
92 {
93         sigset_t mask;
94         struct sigaction action;
95
96         sigemptyset(&mask);
97         sigaddset(&mask, SIGBUS);
98         action.sa_flags = 0;
99         action.sa_mask = mask;
100         action.sa_handler = huge_sigbus_handler;
101
102         huge_need_recover = !sigaction(SIGBUS, &action, &huge_action_old);
103 }
104
105 static void __rte_unused
106 huge_recover_sigbus(void)
107 {
108         if (huge_need_recover) {
109                 sigaction(SIGBUS, &huge_action_old, NULL);
110                 huge_need_recover = 0;
111         }
112 }
113
114 #ifdef RTE_EAL_NUMA_AWARE_HUGEPAGES
115 static bool
116 check_numa(void)
117 {
118         bool ret = true;
119         /* Check if kernel supports NUMA. */
120         if (numa_available() != 0) {
121                 RTE_LOG(DEBUG, EAL, "NUMA is not supported.\n");
122                 ret = false;
123         }
124         return ret;
125 }
126
127 static void
128 prepare_numa(int *oldpolicy, struct bitmask *oldmask, int socket_id)
129 {
130         RTE_LOG(DEBUG, EAL, "Trying to obtain current memory policy.\n");
131         if (get_mempolicy(oldpolicy, oldmask->maskp,
132                           oldmask->size + 1, 0, 0) < 0) {
133                 RTE_LOG(ERR, EAL,
134                         "Failed to get current mempolicy: %s. "
135                         "Assuming MPOL_DEFAULT.\n", strerror(errno));
136                 oldpolicy = MPOL_DEFAULT;
137         }
138         RTE_LOG(DEBUG, EAL,
139                 "Setting policy MPOL_PREFERRED for socket %d\n",
140                 socket_id);
141         numa_set_preferred(socket_id);
142 }
143
144 static void
145 resotre_numa(int *oldpolicy, struct bitmask *oldmask)
146 {
147         RTE_LOG(DEBUG, EAL,
148                 "Restoring previous memory policy: %d\n", *oldpolicy);
149         if (oldpolicy == MPOL_DEFAULT) {
150                 numa_set_localalloc();
151         } else if (set_mempolicy(*oldpolicy, oldmask->maskp,
152                                  oldmask->size + 1) < 0) {
153                 RTE_LOG(ERR, EAL, "Failed to restore mempolicy: %s\n",
154                         strerror(errno));
155                 numa_set_localalloc();
156         }
157         numa_free_cpumask(oldmask);
158 }
159 #endif
160
161 static struct msl_entry *
162 get_msl_entry_by_idx(unsigned int list_idx)
163 {
164         struct msl_entry *te;
165
166         rte_spinlock_lock(&tailq_lock);
167
168         TAILQ_FOREACH(te, &msl_entry_list, next) {
169                 if (te->msl_idx == list_idx)
170                         break;
171         }
172         if (te == NULL) {
173                 /* doesn't exist, so create it and set fd to -1 */
174
175                 te = malloc(sizeof(*te));
176                 if (te == NULL) {
177                         RTE_LOG(ERR, EAL, "%s(): cannot allocate tailq entry for memseg list\n",
178                                 __func__);
179                         goto unlock;
180                 }
181                 te->msl_idx = list_idx;
182                 te->fd = -1;
183                 TAILQ_INSERT_TAIL(&msl_entry_list, te, next);
184         }
185 unlock:
186         rte_spinlock_unlock(&tailq_lock);
187         return te;
188 }
189
190 /*
191  * uses fstat to report the size of a file on disk
192  */
193 static off_t
194 get_file_size(int fd)
195 {
196         struct stat st;
197         if (fstat(fd, &st) < 0)
198                 return 0;
199         return st.st_size;
200 }
201
202 /*
203  * uses fstat to check if file size on disk is zero (regular fstat won't show
204  * true file size due to how fallocate works)
205  */
206 static bool
207 is_zero_length(int fd)
208 {
209         struct stat st;
210         if (fstat(fd, &st) < 0)
211                 return false;
212         return st.st_blocks == 0;
213 }
214
215 /* we cannot use rte_memseg_list_walk() here because we will be holding a
216  * write lock whenever we enter every function in this file, however copying
217  * the same iteration code everywhere is not ideal as well. so, use a lockless
218  * copy of memseg list walk here.
219  */
220 static int
221 memseg_list_walk_thread_unsafe(rte_memseg_list_walk_t func, void *arg)
222 {
223         struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
224         int i, ret = 0;
225
226         for (i = 0; i < RTE_MAX_MEMSEG_LISTS; i++) {
227                 struct rte_memseg_list *msl = &mcfg->memsegs[i];
228
229                 if (msl->base_va == NULL)
230                         continue;
231
232                 ret = func(msl, arg);
233                 if (ret < 0)
234                         return -1;
235                 if (ret > 0)
236                         return 1;
237         }
238         return 0;
239 }
240
241 static int
242 get_seg_fd(char *path, int buflen, struct hugepage_info *hi,
243                 unsigned int list_idx, unsigned int seg_idx)
244 {
245         int fd;
246
247         if (internal_config.single_file_segments) {
248                 /*
249                  * try to find a tailq entry, for this memseg list, or create
250                  * one if it doesn't exist.
251                  */
252                 struct msl_entry *te = get_msl_entry_by_idx(list_idx);
253                 if (te == NULL) {
254                         RTE_LOG(ERR, EAL, "%s(): cannot allocate tailq entry for memseg list\n",
255                                 __func__);
256                         return -1;
257                 } else if (te->fd < 0) {
258                         /* create a hugepage file */
259                         eal_get_hugefile_path(path, buflen, hi->hugedir,
260                                         list_idx);
261                         fd = open(path, O_CREAT | O_RDWR, 0600);
262                         if (fd < 0) {
263                                 RTE_LOG(DEBUG, EAL, "%s(): open failed: %s\n",
264                                         __func__, strerror(errno));
265                                 return -1;
266                         }
267                         te->fd = fd;
268                 } else {
269                         fd = te->fd;
270                 }
271         } else {
272                 /* one file per page, just create it */
273                 eal_get_hugefile_path(path, buflen, hi->hugedir,
274                                 list_idx * RTE_MAX_MEMSEG_PER_LIST + seg_idx);
275                 fd = open(path, O_CREAT | O_RDWR, 0600);
276                 if (fd < 0) {
277                         RTE_LOG(DEBUG, EAL, "%s(): open failed: %s\n", __func__,
278                                         strerror(errno));
279                         return -1;
280                 }
281         }
282         return fd;
283 }
284
285 /* returns 1 on successful lock, 0 on unsuccessful lock, -1 on error */
286 static int lock(int fd, uint64_t offset, uint64_t len, int type)
287 {
288         struct flock lck;
289         int ret;
290
291         memset(&lck, 0, sizeof(lck));
292
293         lck.l_type = type;
294         lck.l_whence = SEEK_SET;
295         lck.l_start = offset;
296         lck.l_len = len;
297
298         ret = fcntl(fd, F_SETLK, &lck);
299
300         if (ret && (errno == EAGAIN || errno == EACCES)) {
301                 /* locked by another process, not an error */
302                 return 0;
303         } else if (ret) {
304                 RTE_LOG(ERR, EAL, "%s(): error calling fcntl(): %s\n",
305                         __func__, strerror(errno));
306                 /* we've encountered an unexpected error */
307                 return -1;
308         }
309         return 1;
310 }
311
312 static int
313 resize_hugefile(int fd, uint64_t fa_offset, uint64_t page_sz,
314                 bool grow)
315 {
316         bool again = false;
317         do {
318                 if (fallocate_supported == 0) {
319                         /* we cannot deallocate memory if fallocate() is not
320                          * supported, but locks are still needed to prevent
321                          * primary process' initialization from clearing out
322                          * huge pages used by this process.
323                          */
324
325                         if (!grow) {
326                                 RTE_LOG(DEBUG, EAL, "%s(): fallocate not supported, not freeing page back to the system\n",
327                                         __func__);
328                                 return -1;
329                         }
330                         uint64_t new_size = fa_offset + page_sz;
331                         uint64_t cur_size = get_file_size(fd);
332
333                         /* fallocate isn't supported, fall back to ftruncate */
334                         if (new_size > cur_size &&
335                                         ftruncate(fd, new_size) < 0) {
336                                 RTE_LOG(DEBUG, EAL, "%s(): ftruncate() failed: %s\n",
337                                         __func__, strerror(errno));
338                                 return -1;
339                         }
340                         /* not being able to take out a read lock is an error */
341                         if (lock(fd, fa_offset, page_sz, F_RDLCK) != 1)
342                                 return -1;
343                 } else {
344                         int flags = grow ? 0 : FALLOC_FL_PUNCH_HOLE |
345                                         FALLOC_FL_KEEP_SIZE;
346                         int ret;
347
348                         /* if fallocate() is supported, we need to take out a
349                          * read lock on allocate (to prevent other processes
350                          * from deallocating this page), and take out a write
351                          * lock on deallocate (to ensure nobody else is using
352                          * this page).
353                          *
354                          * we can't use flock() for this, as we actually need to
355                          * lock part of the file, not the entire file.
356                          */
357
358                         if (!grow) {
359                                 ret = lock(fd, fa_offset, page_sz, F_WRLCK);
360
361                                 if (ret < 0)
362                                         return -1;
363                                 else if (ret == 0)
364                                         /* failed to lock, not an error */
365                                         return 0;
366                         }
367                         if (fallocate(fd, flags, fa_offset, page_sz) < 0) {
368                                 if (fallocate_supported == -1 &&
369                                                 errno == ENOTSUP) {
370                                         RTE_LOG(ERR, EAL, "%s(): fallocate() not supported, hugepage deallocation will be disabled\n",
371                                                 __func__);
372                                         again = true;
373                                         fallocate_supported = 0;
374                                 } else {
375                                         RTE_LOG(DEBUG, EAL, "%s(): fallocate() failed: %s\n",
376                                                 __func__,
377                                                 strerror(errno));
378                                         return -1;
379                                 }
380                         } else {
381                                 fallocate_supported = 1;
382
383                                 if (grow) {
384                                         /* if can't read lock, it's an error */
385                                         if (lock(fd, fa_offset, page_sz,
386                                                         F_RDLCK) != 1)
387                                                 return -1;
388                                 } else {
389                                         /* if can't unlock, it's an error */
390                                         if (lock(fd, fa_offset, page_sz,
391                                                         F_UNLCK) != 1)
392                                                 return -1;
393                                 }
394                         }
395                 }
396         } while (again);
397         return 0;
398 }
399
400 static int
401 alloc_seg(struct rte_memseg *ms, void *addr, int socket_id,
402                 struct hugepage_info *hi, unsigned int list_idx,
403                 unsigned int seg_idx)
404 {
405 #ifdef RTE_EAL_NUMA_AWARE_HUGEPAGES
406         int cur_socket_id = 0;
407 #endif
408         uint64_t map_offset;
409         char path[PATH_MAX];
410         int ret = 0;
411         int fd;
412         size_t alloc_sz;
413
414         fd = get_seg_fd(path, sizeof(path), hi, list_idx, seg_idx);
415         if (fd < 0)
416                 return -1;
417
418         alloc_sz = hi->hugepage_sz;
419         if (internal_config.single_file_segments) {
420                 map_offset = seg_idx * alloc_sz;
421                 ret = resize_hugefile(fd, map_offset, alloc_sz, true);
422                 if (ret < 0)
423                         goto resized;
424         } else {
425                 map_offset = 0;
426                 if (ftruncate(fd, alloc_sz) < 0) {
427                         RTE_LOG(DEBUG, EAL, "%s(): ftruncate() failed: %s\n",
428                                 __func__, strerror(errno));
429                         goto resized;
430                 }
431                 /* we've allocated a page - take out a read lock. we're using
432                  * fcntl() locks rather than flock() here because doing that
433                  * gives us one huge advantage - fcntl() locks are per-process,
434                  * not per-file descriptor, which means that we don't have to
435                  * keep the original fd's around to keep a lock on the file.
436                  *
437                  * this is useful, because when it comes to unmapping pages, we
438                  * will have to take out a write lock (to figure out if another
439                  * process still has this page mapped), and to do itwith flock()
440                  * we'll have to use original fd, as lock is associated with
441                  * that particular fd. with fcntl(), this is not necessary - we
442                  * can open a new fd and use fcntl() on that.
443                  */
444                 ret = lock(fd, map_offset, alloc_sz, F_RDLCK);
445
446                 /* this should not fail */
447                 if (ret != 1) {
448                         RTE_LOG(ERR, EAL, "%s(): error locking file: %s\n",
449                                 __func__,
450                                 strerror(errno));
451                         goto resized;
452                 }
453         }
454
455         /*
456          * map the segment, and populate page tables, the kernel fills this
457          * segment with zeros if it's a new page.
458          */
459         void *va = mmap(addr, alloc_sz, PROT_READ | PROT_WRITE,
460                         MAP_SHARED | MAP_POPULATE | MAP_FIXED, fd, map_offset);
461
462         if (va == MAP_FAILED) {
463                 RTE_LOG(DEBUG, EAL, "%s(): mmap() failed: %s\n", __func__,
464                         strerror(errno));
465                 goto resized;
466         }
467         if (va != addr) {
468                 RTE_LOG(DEBUG, EAL, "%s(): wrong mmap() address\n", __func__);
469                 goto mapped;
470         }
471
472         rte_iova_t iova = rte_mem_virt2iova(addr);
473         if (iova == RTE_BAD_PHYS_ADDR) {
474                 RTE_LOG(DEBUG, EAL, "%s(): can't get IOVA addr\n",
475                         __func__);
476                 goto mapped;
477         }
478
479 #ifdef RTE_EAL_NUMA_AWARE_HUGEPAGES
480         move_pages(getpid(), 1, &addr, NULL, &cur_socket_id, 0);
481
482         if (cur_socket_id != socket_id) {
483                 RTE_LOG(DEBUG, EAL,
484                                 "%s(): allocation happened on wrong socket (wanted %d, got %d)\n",
485                         __func__, socket_id, cur_socket_id);
486                 goto mapped;
487         }
488 #endif
489
490         /* In linux, hugetlb limitations, like cgroup, are
491          * enforced at fault time instead of mmap(), even
492          * with the option of MAP_POPULATE. Kernel will send
493          * a SIGBUS signal. To avoid to be killed, save stack
494          * environment here, if SIGBUS happens, we can jump
495          * back here.
496          */
497         if (huge_wrap_sigsetjmp()) {
498                 RTE_LOG(DEBUG, EAL, "SIGBUS: Cannot mmap more hugepages of size %uMB\n",
499                         (unsigned int)(alloc_sz >> 20));
500                 goto mapped;
501         }
502         /* for non-single file segments, we can close fd here */
503         if (!internal_config.single_file_segments)
504                 close(fd);
505
506         *(int *)addr = *(int *)addr;
507
508         ms->addr = addr;
509         ms->hugepage_sz = alloc_sz;
510         ms->len = alloc_sz;
511         ms->nchannel = rte_memory_get_nchannel();
512         ms->nrank = rte_memory_get_nrank();
513         ms->iova = iova;
514         ms->socket_id = socket_id;
515
516         return 0;
517
518 mapped:
519         munmap(addr, alloc_sz);
520 resized:
521         if (internal_config.single_file_segments) {
522                 resize_hugefile(fd, map_offset, alloc_sz, false);
523                 if (is_zero_length(fd)) {
524                         struct msl_entry *te = get_msl_entry_by_idx(list_idx);
525                         if (te != NULL && te->fd >= 0) {
526                                 close(te->fd);
527                                 te->fd = -1;
528                         }
529                         /* ignore errors, can't make it any worse */
530                         unlink(path);
531                 }
532         } else {
533                 close(fd);
534                 unlink(path);
535         }
536         return -1;
537 }
538
539 static int
540 free_seg(struct rte_memseg *ms, struct hugepage_info *hi,
541                 unsigned int list_idx, unsigned int seg_idx)
542 {
543         uint64_t map_offset;
544         char path[PATH_MAX];
545         int fd, ret;
546
547         /* erase page data */
548         memset(ms->addr, 0, ms->len);
549
550         if (mmap(ms->addr, ms->len, PROT_READ,
551                         MAP_PRIVATE | MAP_ANONYMOUS | MAP_FIXED, -1, 0) ==
552                                 MAP_FAILED) {
553                 RTE_LOG(DEBUG, EAL, "couldn't unmap page\n");
554                 return -1;
555         }
556
557         fd = get_seg_fd(path, sizeof(path), hi, list_idx, seg_idx);
558         if (fd < 0)
559                 return -1;
560
561         if (internal_config.single_file_segments) {
562                 map_offset = seg_idx * ms->len;
563                 if (resize_hugefile(fd, map_offset, ms->len, false))
564                         return -1;
565                 /* if file is zero-length, we've already shrunk it, so it's
566                  * safe to remove.
567                  */
568                 if (is_zero_length(fd)) {
569                         struct msl_entry *te = get_msl_entry_by_idx(list_idx);
570                         /* te->fd is equivalent to fd */
571                         if (te != NULL && te->fd >= 0)
572                                 te->fd = -1;
573                         unlink(path);
574                         close(fd);
575                 }
576                 /* if we're not removing the file, fd stays in the tailq */
577                 ret = 0;
578         } else {
579                 /* if we're able to take out a write lock, we're the last one
580                  * holding onto this page.
581                  */
582
583                 ret = lock(fd, 0, ms->len, F_WRLCK);
584                 if (ret >= 0) {
585                         /* no one else is using this page */
586                         if (ret == 1)
587                                 unlink(path);
588                         ret = lock(fd, 0, ms->len, F_UNLCK);
589                         if (ret != 1)
590                                 RTE_LOG(ERR, EAL, "%s(): unable to unlock file %s\n",
591                                         __func__, path);
592                 }
593                 close(fd);
594         }
595
596         memset(ms, 0, sizeof(*ms));
597
598         return ret;
599 }
600
601 struct alloc_walk_param {
602         struct hugepage_info *hi;
603         struct rte_memseg **ms;
604         size_t page_sz;
605         unsigned int segs_allocated;
606         unsigned int n_segs;
607         int socket;
608         bool exact;
609 };
610 static int
611 alloc_seg_walk(const struct rte_memseg_list *msl, void *arg)
612 {
613         struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
614         struct alloc_walk_param *wa = arg;
615         struct rte_memseg_list *cur_msl;
616         size_t page_sz;
617         int cur_idx, start_idx, j;
618         unsigned int msl_idx, need, i;
619
620         if (msl->page_sz != wa->page_sz)
621                 return 0;
622         if (msl->socket_id != wa->socket)
623                 return 0;
624
625         page_sz = (size_t)msl->page_sz;
626
627         msl_idx = msl - mcfg->memsegs;
628         cur_msl = &mcfg->memsegs[msl_idx];
629
630         need = wa->n_segs;
631
632         /* try finding space in memseg list */
633         cur_idx = rte_fbarray_find_next_n_free(&cur_msl->memseg_arr, 0, need);
634         if (cur_idx < 0)
635                 return 0;
636         start_idx = cur_idx;
637
638         for (i = 0; i < need; i++, cur_idx++) {
639                 struct rte_memseg *cur;
640                 void *map_addr;
641
642                 cur = rte_fbarray_get(&cur_msl->memseg_arr, cur_idx);
643                 map_addr = RTE_PTR_ADD(cur_msl->base_va,
644                                 cur_idx * page_sz);
645
646                 if (alloc_seg(cur, map_addr, wa->socket, wa->hi,
647                                 msl_idx, cur_idx)) {
648                         RTE_LOG(DEBUG, EAL, "attempted to allocate %i segments, but only %i were allocated\n",
649                                 need, i);
650
651                         /* if exact number wasn't requested, stop */
652                         if (!wa->exact)
653                                 goto out;
654
655                         /* clean up */
656                         for (j = start_idx; j < cur_idx; j++) {
657                                 struct rte_memseg *tmp;
658                                 struct rte_fbarray *arr =
659                                                 &cur_msl->memseg_arr;
660
661                                 tmp = rte_fbarray_get(arr, j);
662                                 if (free_seg(tmp, wa->hi, msl_idx,
663                                                 start_idx + j)) {
664                                         RTE_LOG(ERR, EAL, "Cannot free page\n");
665                                         continue;
666                                 }
667
668                                 rte_fbarray_set_free(arr, j);
669                         }
670                         /* clear the list */
671                         if (wa->ms)
672                                 memset(wa->ms, 0, sizeof(*wa->ms) * wa->n_segs);
673                         return -1;
674                 }
675                 if (wa->ms)
676                         wa->ms[i] = cur;
677
678                 rte_fbarray_set_used(&cur_msl->memseg_arr, cur_idx);
679         }
680 out:
681         wa->segs_allocated = i;
682         if (i > 0)
683                 cur_msl->version++;
684         return 1;
685 }
686
687 struct free_walk_param {
688         struct hugepage_info *hi;
689         struct rte_memseg *ms;
690 };
691 static int
692 free_seg_walk(const struct rte_memseg_list *msl, void *arg)
693 {
694         struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
695         struct rte_memseg_list *found_msl;
696         struct free_walk_param *wa = arg;
697         uintptr_t start_addr, end_addr;
698         int msl_idx, seg_idx;
699
700         start_addr = (uintptr_t) msl->base_va;
701         end_addr = start_addr + msl->memseg_arr.len * (size_t)msl->page_sz;
702
703         if ((uintptr_t)wa->ms->addr < start_addr ||
704                         (uintptr_t)wa->ms->addr >= end_addr)
705                 return 0;
706
707         msl_idx = msl - mcfg->memsegs;
708         seg_idx = RTE_PTR_DIFF(wa->ms->addr, start_addr) / msl->page_sz;
709
710         /* msl is const */
711         found_msl = &mcfg->memsegs[msl_idx];
712
713         found_msl->version++;
714
715         rte_fbarray_set_free(&found_msl->memseg_arr, seg_idx);
716
717         if (free_seg(wa->ms, wa->hi, msl_idx, seg_idx))
718                 return -1;
719
720         return 1;
721 }
722
723 int
724 eal_memalloc_alloc_seg_bulk(struct rte_memseg **ms, int n_segs, size_t page_sz,
725                 int socket, bool exact)
726 {
727         int i, ret = -1;
728 #ifdef RTE_EAL_NUMA_AWARE_HUGEPAGES
729         bool have_numa = false;
730         int oldpolicy;
731         struct bitmask *oldmask;
732 #endif
733         struct alloc_walk_param wa;
734         struct hugepage_info *hi = NULL;
735
736         memset(&wa, 0, sizeof(wa));
737
738         /* dynamic allocation not supported in legacy mode */
739         if (internal_config.legacy_mem)
740                 return -1;
741
742         for (i = 0; i < (int) RTE_DIM(internal_config.hugepage_info); i++) {
743                 if (page_sz ==
744                                 internal_config.hugepage_info[i].hugepage_sz) {
745                         hi = &internal_config.hugepage_info[i];
746                         break;
747                 }
748         }
749         if (!hi) {
750                 RTE_LOG(ERR, EAL, "%s(): can't find relevant hugepage_info entry\n",
751                         __func__);
752                 return -1;
753         }
754
755 #ifdef RTE_EAL_NUMA_AWARE_HUGEPAGES
756         if (check_numa()) {
757                 oldmask = numa_allocate_nodemask();
758                 prepare_numa(&oldpolicy, oldmask, socket);
759                 have_numa = true;
760         }
761 #endif
762
763         wa.exact = exact;
764         wa.hi = hi;
765         wa.ms = ms;
766         wa.n_segs = n_segs;
767         wa.page_sz = page_sz;
768         wa.socket = socket;
769         wa.segs_allocated = 0;
770
771         ret = memseg_list_walk_thread_unsafe(alloc_seg_walk, &wa);
772         if (ret == 0) {
773                 RTE_LOG(ERR, EAL, "%s(): couldn't find suitable memseg_list\n",
774                         __func__);
775                 ret = -1;
776         } else if (ret > 0) {
777                 ret = (int)wa.segs_allocated;
778         }
779
780 #ifdef RTE_EAL_NUMA_AWARE_HUGEPAGES
781         if (have_numa)
782                 resotre_numa(&oldpolicy, oldmask);
783 #endif
784         return ret;
785 }
786
787 struct rte_memseg *
788 eal_memalloc_alloc_seg(size_t page_sz, int socket)
789 {
790         struct rte_memseg *ms;
791         if (eal_memalloc_alloc_seg_bulk(&ms, 1, page_sz, socket, true) < 0)
792                 return NULL;
793         /* return pointer to newly allocated memseg */
794         return ms;
795 }
796
797 int
798 eal_memalloc_free_seg_bulk(struct rte_memseg **ms, int n_segs)
799 {
800         int seg, ret = 0;
801
802         /* dynamic free not supported in legacy mode */
803         if (internal_config.legacy_mem)
804                 return -1;
805
806         for (seg = 0; seg < n_segs; seg++) {
807                 struct rte_memseg *cur = ms[seg];
808                 struct hugepage_info *hi = NULL;
809                 struct free_walk_param wa;
810                 int i, walk_res;
811
812                 /* if this page is marked as unfreeable, fail */
813                 if (cur->flags & RTE_MEMSEG_FLAG_DO_NOT_FREE) {
814                         RTE_LOG(DEBUG, EAL, "Page is not allowed to be freed\n");
815                         ret = -1;
816                         continue;
817                 }
818
819                 memset(&wa, 0, sizeof(wa));
820
821                 for (i = 0; i < (int)RTE_DIM(internal_config.hugepage_info);
822                                 i++) {
823                         hi = &internal_config.hugepage_info[i];
824                         if (cur->hugepage_sz == hi->hugepage_sz)
825                                 break;
826                 }
827                 if (i == (int)RTE_DIM(internal_config.hugepage_info)) {
828                         RTE_LOG(ERR, EAL, "Can't find relevant hugepage_info entry\n");
829                         ret = -1;
830                         continue;
831                 }
832
833                 wa.ms = cur;
834                 wa.hi = hi;
835
836                 walk_res = memseg_list_walk_thread_unsafe(free_seg_walk, &wa);
837                 if (walk_res == 1)
838                         continue;
839                 if (walk_res == 0)
840                         RTE_LOG(ERR, EAL, "Couldn't find memseg list\n");
841                 ret = -1;
842         }
843         return ret;
844 }
845
846 int
847 eal_memalloc_free_seg(struct rte_memseg *ms)
848 {
849         /* dynamic free not supported in legacy mode */
850         if (internal_config.legacy_mem)
851                 return -1;
852
853         return eal_memalloc_free_seg_bulk(&ms, 1);
854 }
855
856 static int
857 sync_chunk(struct rte_memseg_list *primary_msl,
858                 struct rte_memseg_list *local_msl, struct hugepage_info *hi,
859                 unsigned int msl_idx, bool used, int start, int end)
860 {
861         struct rte_fbarray *l_arr, *p_arr;
862         int i, ret, chunk_len, diff_len;
863
864         l_arr = &local_msl->memseg_arr;
865         p_arr = &primary_msl->memseg_arr;
866
867         /* we need to aggregate allocations/deallocations into bigger chunks,
868          * as we don't want to spam the user with per-page callbacks.
869          *
870          * to avoid any potential issues, we also want to trigger
871          * deallocation callbacks *before* we actually deallocate
872          * memory, so that the user application could wrap up its use
873          * before it goes away.
874          */
875
876         chunk_len = end - start;
877
878         /* find how many contiguous pages we can map/unmap for this chunk */
879         diff_len = used ?
880                         rte_fbarray_find_contig_free(l_arr, start) :
881                         rte_fbarray_find_contig_used(l_arr, start);
882
883         /* has to be at least one page */
884         if (diff_len < 1)
885                 return -1;
886
887         diff_len = RTE_MIN(chunk_len, diff_len);
888
889         /* if we are freeing memory, notify the application */
890         if (!used) {
891                 struct rte_memseg *ms;
892                 void *start_va;
893                 size_t len, page_sz;
894
895                 ms = rte_fbarray_get(l_arr, start);
896                 start_va = ms->addr;
897                 page_sz = (size_t)primary_msl->page_sz;
898                 len = page_sz * diff_len;
899
900                 eal_memalloc_mem_event_notify(RTE_MEM_EVENT_FREE,
901                                 start_va, len);
902         }
903
904         for (i = 0; i < diff_len; i++) {
905                 struct rte_memseg *p_ms, *l_ms;
906                 int seg_idx = start + i;
907
908                 l_ms = rte_fbarray_get(l_arr, seg_idx);
909                 p_ms = rte_fbarray_get(p_arr, seg_idx);
910
911                 if (l_ms == NULL || p_ms == NULL)
912                         return -1;
913
914                 if (used) {
915                         ret = alloc_seg(l_ms, p_ms->addr,
916                                         p_ms->socket_id, hi,
917                                         msl_idx, seg_idx);
918                         if (ret < 0)
919                                 return -1;
920                         rte_fbarray_set_used(l_arr, seg_idx);
921                 } else {
922                         ret = free_seg(l_ms, hi, msl_idx, seg_idx);
923                         rte_fbarray_set_free(l_arr, seg_idx);
924                         if (ret < 0)
925                                 return -1;
926                 }
927         }
928
929         /* if we just allocated memory, notify the application */
930         if (used) {
931                 struct rte_memseg *ms;
932                 void *start_va;
933                 size_t len, page_sz;
934
935                 ms = rte_fbarray_get(l_arr, start);
936                 start_va = ms->addr;
937                 page_sz = (size_t)primary_msl->page_sz;
938                 len = page_sz * diff_len;
939
940                 eal_memalloc_mem_event_notify(RTE_MEM_EVENT_ALLOC,
941                                 start_va, len);
942         }
943
944         /* calculate how much we can advance until next chunk */
945         diff_len = used ?
946                         rte_fbarray_find_contig_used(l_arr, start) :
947                         rte_fbarray_find_contig_free(l_arr, start);
948         ret = RTE_MIN(chunk_len, diff_len);
949
950         return ret;
951 }
952
953 static int
954 sync_status(struct rte_memseg_list *primary_msl,
955                 struct rte_memseg_list *local_msl, struct hugepage_info *hi,
956                 unsigned int msl_idx, bool used)
957 {
958         struct rte_fbarray *l_arr, *p_arr;
959         int p_idx, l_chunk_len, p_chunk_len, ret;
960         int start, end;
961
962         /* this is a little bit tricky, but the basic idea is - walk both lists
963          * and spot any places where there are discrepancies. walking both lists
964          * and noting discrepancies in a single go is a hard problem, so we do
965          * it in two passes - first we spot any places where allocated segments
966          * mismatch (i.e. ensure that everything that's allocated in the primary
967          * is also allocated in the secondary), and then we do it by looking at
968          * free segments instead.
969          *
970          * we also need to aggregate changes into chunks, as we have to call
971          * callbacks per allocation, not per page.
972          */
973         l_arr = &local_msl->memseg_arr;
974         p_arr = &primary_msl->memseg_arr;
975
976         if (used)
977                 p_idx = rte_fbarray_find_next_used(p_arr, 0);
978         else
979                 p_idx = rte_fbarray_find_next_free(p_arr, 0);
980
981         while (p_idx >= 0) {
982                 int next_chunk_search_idx;
983
984                 if (used) {
985                         p_chunk_len = rte_fbarray_find_contig_used(p_arr,
986                                         p_idx);
987                         l_chunk_len = rte_fbarray_find_contig_used(l_arr,
988                                         p_idx);
989                 } else {
990                         p_chunk_len = rte_fbarray_find_contig_free(p_arr,
991                                         p_idx);
992                         l_chunk_len = rte_fbarray_find_contig_free(l_arr,
993                                         p_idx);
994                 }
995                 /* best case scenario - no differences (or bigger, which will be
996                  * fixed during next iteration), look for next chunk
997                  */
998                 if (l_chunk_len >= p_chunk_len) {
999                         next_chunk_search_idx = p_idx + p_chunk_len;
1000                         goto next_chunk;
1001                 }
1002
1003                 /* if both chunks start at the same point, skip parts we know
1004                  * are identical, and sync the rest. each call to sync_chunk
1005                  * will only sync contiguous segments, so we need to call this
1006                  * until we are sure there are no more differences in this
1007                  * chunk.
1008                  */
1009                 start = p_idx + l_chunk_len;
1010                 end = p_idx + p_chunk_len;
1011                 do {
1012                         ret = sync_chunk(primary_msl, local_msl, hi, msl_idx,
1013                                         used, start, end);
1014                         start += ret;
1015                 } while (start < end && ret >= 0);
1016                 /* if ret is negative, something went wrong */
1017                 if (ret < 0)
1018                         return -1;
1019
1020                 next_chunk_search_idx = p_idx + p_chunk_len;
1021 next_chunk:
1022                 /* skip to end of this chunk */
1023                 if (used) {
1024                         p_idx = rte_fbarray_find_next_used(p_arr,
1025                                         next_chunk_search_idx);
1026                 } else {
1027                         p_idx = rte_fbarray_find_next_free(p_arr,
1028                                         next_chunk_search_idx);
1029                 }
1030         }
1031         return 0;
1032 }
1033
1034 static int
1035 sync_existing(struct rte_memseg_list *primary_msl,
1036                 struct rte_memseg_list *local_msl, struct hugepage_info *hi,
1037                 unsigned int msl_idx)
1038 {
1039         int ret;
1040
1041         /* ensure all allocated space is the same in both lists */
1042         ret = sync_status(primary_msl, local_msl, hi, msl_idx, true);
1043         if (ret < 0)
1044                 return -1;
1045
1046         /* ensure all unallocated space is the same in both lists */
1047         ret = sync_status(primary_msl, local_msl, hi, msl_idx, false);
1048         if (ret < 0)
1049                 return -1;
1050
1051         /* update version number */
1052         local_msl->version = primary_msl->version;
1053
1054         return 0;
1055 }
1056
1057 static int
1058 sync_walk(const struct rte_memseg_list *msl, void *arg __rte_unused)
1059 {
1060         struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
1061         struct rte_memseg_list *primary_msl, *local_msl;
1062         struct hugepage_info *hi = NULL;
1063         unsigned int i;
1064         int msl_idx;
1065         bool new_msl = false;
1066
1067         msl_idx = msl - mcfg->memsegs;
1068         primary_msl = &mcfg->memsegs[msl_idx];
1069         local_msl = &local_memsegs[msl_idx];
1070
1071         /* check if secondary has this memseg list set up */
1072         if (local_msl->base_va == NULL) {
1073                 char name[PATH_MAX];
1074                 int ret;
1075                 new_msl = true;
1076
1077                 /* create distinct fbarrays for each secondary */
1078                 snprintf(name, RTE_FBARRAY_NAME_LEN, "%s_%i",
1079                         primary_msl->memseg_arr.name, getpid());
1080
1081                 ret = rte_fbarray_init(&local_msl->memseg_arr, name,
1082                         primary_msl->memseg_arr.len,
1083                         primary_msl->memseg_arr.elt_sz);
1084                 if (ret < 0) {
1085                         RTE_LOG(ERR, EAL, "Cannot initialize local memory map\n");
1086                         return -1;
1087                 }
1088
1089                 local_msl->base_va = primary_msl->base_va;
1090         }
1091
1092         for (i = 0; i < RTE_DIM(internal_config.hugepage_info); i++) {
1093                 uint64_t cur_sz =
1094                         internal_config.hugepage_info[i].hugepage_sz;
1095                 uint64_t msl_sz = primary_msl->page_sz;
1096                 if (msl_sz == cur_sz) {
1097                         hi = &internal_config.hugepage_info[i];
1098                         break;
1099                 }
1100         }
1101         if (!hi) {
1102                 RTE_LOG(ERR, EAL, "Can't find relevant hugepage_info entry\n");
1103                 return -1;
1104         }
1105
1106         /* if versions don't match or if we have just allocated a new
1107          * memseg list, synchronize everything
1108          */
1109         if ((new_msl || local_msl->version != primary_msl->version) &&
1110                         sync_existing(primary_msl, local_msl, hi, msl_idx))
1111                 return -1;
1112         return 0;
1113 }
1114
1115
1116 int
1117 eal_memalloc_sync_with_primary(void)
1118 {
1119         /* nothing to be done in primary */
1120         if (rte_eal_process_type() == RTE_PROC_PRIMARY)
1121                 return 0;
1122
1123         if (memseg_list_walk_thread_unsafe(sync_walk, NULL))
1124                 return -1;
1125         return 0;
1126 }