lib/librte_eal/common/malloc_heap.c

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(c) 2010-2014 Intel Corporation
   3  */
   4 #include <stdint.h>
   5 #include <stddef.h>
   6 #include <stdlib.h>
   7 #include <stdio.h>
   8 #include <stdarg.h>
   9 #include <errno.h>
  10 #include <sys/queue.h>
  11
  12 #include <rte_memory.h>
  13 #include <rte_errno.h>
  14 #include <rte_eal.h>
  15 #include <rte_eal_memconfig.h>
  16 #include <rte_launch.h>
  17 #include <rte_per_lcore.h>
  18 #include <rte_lcore.h>
  19 #include <rte_common.h>
  20 #include <rte_string_fns.h>
  21 #include <rte_spinlock.h>
  22 #include <rte_memcpy.h>
  23 #include <rte_atomic.h>
  24 #include <rte_fbarray.h>
  25
  26 #include "eal_internal_cfg.h"
  27 #include "eal_memalloc.h"
  28 #include "malloc_elem.h"
  29 #include "malloc_heap.h"
  30 #include "malloc_mp.h"
  31
  32 /* start external socket ID's at a very high number */
  33 #define CONST_MAX(a, b) (a > b ? a : b) /* RTE_MAX is not a constant */
  34 #define EXTERNAL_HEAP_MIN_SOCKET_ID (CONST_MAX((1 << 8), RTE_MAX_NUMA_NODES))
  35
  36 static unsigned
  37 check_hugepage_sz(unsigned flags, uint64_t hugepage_sz)
  38 {
  39         unsigned check_flag = 0;
  40
  41         if (!(flags & ~RTE_MEMZONE_SIZE_HINT_ONLY))
  42                 return 1;
  43
  44         switch (hugepage_sz) {
  45         case RTE_PGSIZE_256K:
  46                 check_flag = RTE_MEMZONE_256KB;
  47                 break;
  48         case RTE_PGSIZE_2M:
  49                 check_flag = RTE_MEMZONE_2MB;
  50                 break;
  51         case RTE_PGSIZE_16M:
  52                 check_flag = RTE_MEMZONE_16MB;
  53                 break;
  54         case RTE_PGSIZE_256M:
  55                 check_flag = RTE_MEMZONE_256MB;
  56                 break;
  57         case RTE_PGSIZE_512M:
  58                 check_flag = RTE_MEMZONE_512MB;
  59                 break;
  60         case RTE_PGSIZE_1G:
  61                 check_flag = RTE_MEMZONE_1GB;
  62                 break;
  63         case RTE_PGSIZE_4G:
  64                 check_flag = RTE_MEMZONE_4GB;
  65                 break;
  66         case RTE_PGSIZE_16G:
  67                 check_flag = RTE_MEMZONE_16GB;
  68         }
  69
  70         return check_flag & flags;
  71 }
  72
  73 int
  74 malloc_socket_to_heap_id(unsigned int socket_id)
  75 {
  76         struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
  77         int i;
  78
  79         for (i = 0; i < RTE_MAX_HEAPS; i++) {
  80                 struct malloc_heap *heap = &mcfg->malloc_heaps[i];
  81
  82                 if (heap->socket_id == socket_id)
  83                         return i;
  84         }
  85         return -1;
  86 }
  87
  88 /*
  89  * Expand the heap with a memory area.
  90  */
  91 static struct malloc_elem *
  92 malloc_heap_add_memory(struct malloc_heap *heap, struct rte_memseg_list *msl,
  93                 void *start, size_t len)
  94 {
  95         struct malloc_elem *elem = start;
  96
  97         malloc_elem_init(elem, heap, msl, len);
  98
  99         malloc_elem_insert(elem);
 100
 101         elem = malloc_elem_join_adjacent_free(elem);
 102
 103         malloc_elem_free_list_insert(elem);
 104
 105         return elem;
 106 }
 107
 108 static int
 109 malloc_add_seg(const struct rte_memseg_list *msl,
 110                 const struct rte_memseg *ms, size_t len, void *arg __rte_unused)
 111 {
 112         struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
 113         struct rte_memseg_list *found_msl;
 114         struct malloc_heap *heap;
 115         int msl_idx, heap_idx;
 116
 117         if (msl->external)
 118                 return 0;
 119
 120         heap_idx = malloc_socket_to_heap_id(msl->socket_id);
 121         if (heap_idx < 0) {
 122                 RTE_LOG(ERR, EAL, "Memseg list has invalid socket id\n");
 123                 return -1;
 124         }
 125         heap = &mcfg->malloc_heaps[heap_idx];
 126
 127         /* msl is const, so find it */
 128         msl_idx = msl - mcfg->memsegs;
 129
 130         if (msl_idx < 0 || msl_idx >= RTE_MAX_MEMSEG_LISTS)
 131                 return -1;
 132
 133         found_msl = &mcfg->memsegs[msl_idx];
 134
 135         malloc_heap_add_memory(heap, found_msl, ms->addr, len);
 136
 137         heap->total_size += len;
 138
 139         RTE_LOG(DEBUG, EAL, "Added %zuM to heap on socket %i\n", len >> 20,
 140                         msl->socket_id);
 141         return 0;
 142 }
 143
 144 /*
 145  * Iterates through the freelist for a heap to find a free element
 146  * which can store data of the required size and with the requested alignment.
 147  * If size is 0, find the biggest available elem.
 148  * Returns null on failure, or pointer to element on success.
 149  */
 150 static struct malloc_elem *
 151 find_suitable_element(struct malloc_heap *heap, size_t size,
 152                 unsigned int flags, size_t align, size_t bound, bool contig)
 153 {
 154         size_t idx;
 155         struct malloc_elem *elem, *alt_elem = NULL;
 156
 157         for (idx = malloc_elem_free_list_index(size);
 158                         idx < RTE_HEAP_NUM_FREELISTS; idx++) {
 159                 for (elem = LIST_FIRST(&heap->free_head[idx]);
 160                                 !!elem; elem = LIST_NEXT(elem, free_list)) {
 161                         if (malloc_elem_can_hold(elem, size, align, bound,
 162                                         contig)) {
 163                                 if (check_hugepage_sz(flags,
 164                                                 elem->msl->page_sz))
 165                                         return elem;
 166                                 if (alt_elem == NULL)
 167                                         alt_elem = elem;
 168                         }
 169                 }
 170         }
 171
 172         if ((alt_elem != NULL) && (flags & RTE_MEMZONE_SIZE_HINT_ONLY))
 173                 return alt_elem;
 174
 175         return NULL;
 176 }
 177
 178 /*
 179  * Iterates through the freelist for a heap to find a free element with the
 180  * biggest size and requested alignment. Will also set size to whatever element
 181  * size that was found.
 182  * Returns null on failure, or pointer to element on success.
 183  */
 184 static struct malloc_elem *
 185 find_biggest_element(struct malloc_heap *heap, size_t *size,
 186                 unsigned int flags, size_t align, bool contig)
 187 {
 188         struct malloc_elem *elem, *max_elem = NULL;
 189         size_t idx, max_size = 0;
 190
 191         for (idx = 0; idx < RTE_HEAP_NUM_FREELISTS; idx++) {
 192                 for (elem = LIST_FIRST(&heap->free_head[idx]);
 193                                 !!elem; elem = LIST_NEXT(elem, free_list)) {
 194                         size_t cur_size;
 195                         if ((flags & RTE_MEMZONE_SIZE_HINT_ONLY) == 0 &&
 196                                         !check_hugepage_sz(flags,
 197                                                 elem->msl->page_sz))
 198                                 continue;
 199                         if (contig) {
 200                                 cur_size =
 201                                         malloc_elem_find_max_iova_contig(elem,
 202                                                         align);
 203                         } else {
 204                                 void *data_start = RTE_PTR_ADD(elem,
 205                                                 MALLOC_ELEM_HEADER_LEN);
 206                                 void *data_end = RTE_PTR_ADD(elem, elem->size -
 207                                                 MALLOC_ELEM_TRAILER_LEN);
 208                                 void *aligned = RTE_PTR_ALIGN_CEIL(data_start,
 209                                                 align);
 210                                 /* check if aligned data start is beyond end */
 211                                 if (aligned >= data_end)
 212                                         continue;
 213                                 cur_size = RTE_PTR_DIFF(data_end, aligned);
 214                         }
 215                         if (cur_size > max_size) {
 216                                 max_size = cur_size;
 217                                 max_elem = elem;
 218                         }
 219                 }
 220         }
 221
 222         *size = max_size;
 223         return max_elem;
 224 }
 225
 226 /*
 227  * Main function to allocate a block of memory from the heap.
 228  * It locks the free list, scans it, and adds a new memseg if the
 229  * scan fails. Once the new memseg is added, it re-scans and should return
 230  * the new element after releasing the lock.
 231  */
 232 static void *
 233 heap_alloc(struct malloc_heap *heap, const char *type __rte_unused, size_t size,
 234                 unsigned int flags, size_t align, size_t bound, bool contig)
 235 {
 236         struct malloc_elem *elem;
 237
 238         size = RTE_CACHE_LINE_ROUNDUP(size);
 239         align = RTE_CACHE_LINE_ROUNDUP(align);
 240
 241         elem = find_suitable_element(heap, size, flags, align, bound, contig);
 242         if (elem != NULL) {
 243                 elem = malloc_elem_alloc(elem, size, align, bound, contig);
 244
 245                 /* increase heap's count of allocated elements */
 246                 heap->alloc_count++;
 247         }
 248
 249         return elem == NULL ? NULL : (void *)(&elem[1]);
 250 }
 251
 252 static void *
 253 heap_alloc_biggest(struct malloc_heap *heap, const char *type __rte_unused,
 254                 unsigned int flags, size_t align, bool contig)
 255 {
 256         struct malloc_elem *elem;
 257         size_t size;
 258
 259         align = RTE_CACHE_LINE_ROUNDUP(align);
 260
 261         elem = find_biggest_element(heap, &size, flags, align, contig);
 262         if (elem != NULL) {
 263                 elem = malloc_elem_alloc(elem, size, align, 0, contig);
 264
 265                 /* increase heap's count of allocated elements */
 266                 heap->alloc_count++;
 267         }
 268
 269         return elem == NULL ? NULL : (void *)(&elem[1]);
 270 }
 271
 272 /* this function is exposed in malloc_mp.h */
 273 void
 274 rollback_expand_heap(struct rte_memseg **ms, int n_segs,
 275                 struct malloc_elem *elem, void *map_addr, size_t map_len)
 276 {
 277         if (elem != NULL) {
 278                 malloc_elem_free_list_remove(elem);
 279                 malloc_elem_hide_region(elem, map_addr, map_len);
 280         }
 281
 282         eal_memalloc_free_seg_bulk(ms, n_segs);
 283 }
 284
 285 /* this function is exposed in malloc_mp.h */
 286 struct malloc_elem *
 287 alloc_pages_on_heap(struct malloc_heap *heap, uint64_t pg_sz, size_t elt_size,
 288                 int socket, unsigned int flags, size_t align, size_t bound,
 289                 bool contig, struct rte_memseg **ms, int n_segs)
 290 {
 291         struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
 292         struct rte_memseg_list *msl;
 293         struct malloc_elem *elem = NULL;
 294         size_t alloc_sz;
 295         int allocd_pages;
 296         void *ret, *map_addr;
 297
 298         alloc_sz = (size_t)pg_sz * n_segs;
 299
 300         /* first, check if we're allowed to allocate this memory */
 301         if (eal_memalloc_mem_alloc_validate(socket,
 302                         heap->total_size + alloc_sz) < 0) {
 303                 RTE_LOG(DEBUG, EAL, "User has disallowed allocation\n");
 304                 return NULL;
 305         }
 306
 307         allocd_pages = eal_memalloc_alloc_seg_bulk(ms, n_segs, pg_sz,
 308                         socket, true);
 309
 310         /* make sure we've allocated our pages... */
 311         if (allocd_pages < 0)
 312                 return NULL;
 313
 314         map_addr = ms[0]->addr;
 315         msl = rte_mem_virt2memseg_list(map_addr);
 316
 317         /* check if we wanted contiguous memory but didn't get it */
 318         if (contig && !eal_memalloc_is_contig(msl, map_addr, alloc_sz)) {
 319                 RTE_LOG(DEBUG, EAL, "%s(): couldn't allocate physically contiguous space\n",
 320                                 __func__);
 321                 goto fail;
 322         }
 323
 324         if (mcfg->dma_maskbits) {
 325                 if (rte_eal_check_dma_mask(mcfg->dma_maskbits)) {
 326                         RTE_LOG(ERR, EAL,
 327                                 "%s(): couldn't allocate memory due to DMA mask\n",
 328                                 __func__);
 329                         goto fail;
 330                 }
 331         }
 332
 333         /* add newly minted memsegs to malloc heap */
 334         elem = malloc_heap_add_memory(heap, msl, map_addr, alloc_sz);
 335
 336         /* try once more, as now we have allocated new memory */
 337         ret = find_suitable_element(heap, elt_size, flags, align, bound,
 338                         contig);
 339
 340         if (ret == NULL)
 341                 goto fail;
 342
 343         return elem;
 344
 345 fail:
 346         rollback_expand_heap(ms, n_segs, elem, map_addr, alloc_sz);
 347         return NULL;
 348 }
 349
 350 static int
 351 try_expand_heap_primary(struct malloc_heap *heap, uint64_t pg_sz,
 352                 size_t elt_size, int socket, unsigned int flags, size_t align,
 353                 size_t bound, bool contig)
 354 {
 355         struct malloc_elem *elem;
 356         struct rte_memseg **ms;
 357         void *map_addr;
 358         size_t alloc_sz;
 359         int n_segs;
 360         bool callback_triggered = false;
 361
 362         alloc_sz = RTE_ALIGN_CEIL(align + elt_size +
 363                         MALLOC_ELEM_TRAILER_LEN, pg_sz);
 364         n_segs = alloc_sz / pg_sz;
 365
 366         /* we can't know in advance how many pages we'll need, so we malloc */
 367         ms = malloc(sizeof(*ms) * n_segs);
 368         if (ms == NULL)
 369                 return -1;
 370         memset(ms, 0, sizeof(*ms) * n_segs);
 371
 372         elem = alloc_pages_on_heap(heap, pg_sz, elt_size, socket, flags, align,
 373                         bound, contig, ms, n_segs);
 374
 375         if (elem == NULL)
 376                 goto free_ms;
 377
 378         map_addr = ms[0]->addr;
 379
 380         /* notify user about changes in memory map */
 381         eal_memalloc_mem_event_notify(RTE_MEM_EVENT_ALLOC, map_addr, alloc_sz);
 382
 383         /* notify other processes that this has happened */
 384         if (request_sync()) {
 385                 /* we couldn't ensure all processes have mapped memory,
 386                  * so free it back and notify everyone that it's been
 387                  * freed back.
 388                  *
 389                  * technically, we could've avoided adding memory addresses to
 390                  * the map, but that would've led to inconsistent behavior
 391                  * between primary and secondary processes, as those get
 392                  * callbacks during sync. therefore, force primary process to
 393                  * do alloc-and-rollback syncs as well.
 394                  */
 395                 callback_triggered = true;
 396                 goto free_elem;
 397         }
 398         heap->total_size += alloc_sz;
 399
 400         RTE_LOG(DEBUG, EAL, "Heap on socket %d was expanded by %zdMB\n",
 401                 socket, alloc_sz >> 20ULL);
 402
 403         free(ms);
 404
 405         return 0;
 406
 407 free_elem:
 408         if (callback_triggered)
 409                 eal_memalloc_mem_event_notify(RTE_MEM_EVENT_FREE,
 410                                 map_addr, alloc_sz);
 411
 412         rollback_expand_heap(ms, n_segs, elem, map_addr, alloc_sz);
 413
 414         request_sync();
 415 free_ms:
 416         free(ms);
 417
 418         return -1;
 419 }
 420
 421 static int
 422 try_expand_heap_secondary(struct malloc_heap *heap, uint64_t pg_sz,
 423                 size_t elt_size, int socket, unsigned int flags, size_t align,
 424                 size_t bound, bool contig)
 425 {
 426         struct malloc_mp_req req;
 427         int req_result;
 428
 429         memset(&req, 0, sizeof(req));
 430
 431         req.t = REQ_TYPE_ALLOC;
 432         req.alloc_req.align = align;
 433         req.alloc_req.bound = bound;
 434         req.alloc_req.contig = contig;
 435         req.alloc_req.flags = flags;
 436         req.alloc_req.elt_size = elt_size;
 437         req.alloc_req.page_sz = pg_sz;
 438         req.alloc_req.socket = socket;
 439         req.alloc_req.heap = heap; /* it's in shared memory */
 440
 441         req_result = request_to_primary(&req);
 442
 443         if (req_result != 0)
 444                 return -1;
 445
 446         if (req.result != REQ_RESULT_SUCCESS)
 447                 return -1;
 448
 449         return 0;
 450 }
 451
 452 static int
 453 try_expand_heap(struct malloc_heap *heap, uint64_t pg_sz, size_t elt_size,
 454                 int socket, unsigned int flags, size_t align, size_t bound,
 455                 bool contig)
 456 {
 457         struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
 458         int ret;
 459
 460         rte_rwlock_write_lock(&mcfg->memory_hotplug_lock);
 461
 462         if (rte_eal_process_type() == RTE_PROC_PRIMARY) {
 463                 ret = try_expand_heap_primary(heap, pg_sz, elt_size, socket,
 464                                 flags, align, bound, contig);
 465         } else {
 466                 ret = try_expand_heap_secondary(heap, pg_sz, elt_size, socket,
 467                                 flags, align, bound, contig);
 468         }
 469
 470         rte_rwlock_write_unlock(&mcfg->memory_hotplug_lock);
 471         return ret;
 472 }
 473
 474 static int
 475 compare_pagesz(const void *a, const void *b)
 476 {
 477         const struct rte_memseg_list * const*mpa = a;
 478         const struct rte_memseg_list * const*mpb = b;
 479         const struct rte_memseg_list *msla = *mpa;
 480         const struct rte_memseg_list *mslb = *mpb;
 481         uint64_t pg_sz_a = msla->page_sz;
 482         uint64_t pg_sz_b = mslb->page_sz;
 483
 484         if (pg_sz_a < pg_sz_b)
 485                 return -1;
 486         if (pg_sz_a > pg_sz_b)
 487                 return 1;
 488         return 0;
 489 }
 490
 491 static int
 492 alloc_more_mem_on_socket(struct malloc_heap *heap, size_t size, int socket,
 493                 unsigned int flags, size_t align, size_t bound, bool contig)
 494 {
 495         struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
 496         struct rte_memseg_list *requested_msls[RTE_MAX_MEMSEG_LISTS];
 497         struct rte_memseg_list *other_msls[RTE_MAX_MEMSEG_LISTS];
 498         uint64_t requested_pg_sz[RTE_MAX_MEMSEG_LISTS];
 499         uint64_t other_pg_sz[RTE_MAX_MEMSEG_LISTS];
 500         uint64_t prev_pg_sz;
 501         int i, n_other_msls, n_other_pg_sz, n_requested_msls, n_requested_pg_sz;
 502         bool size_hint = (flags & RTE_MEMZONE_SIZE_HINT_ONLY) > 0;
 503         unsigned int size_flags = flags & ~RTE_MEMZONE_SIZE_HINT_ONLY;
 504         void *ret;
 505
 506         memset(requested_msls, 0, sizeof(requested_msls));
 507         memset(other_msls, 0, sizeof(other_msls));
 508         memset(requested_pg_sz, 0, sizeof(requested_pg_sz));
 509         memset(other_pg_sz, 0, sizeof(other_pg_sz));
 510
 511         /*
 512          * go through memseg list and take note of all the page sizes available,
 513          * and if any of them were specifically requested by the user.
 514          */
 515         n_requested_msls = 0;
 516         n_other_msls = 0;
 517         for (i = 0; i < RTE_MAX_MEMSEG_LISTS; i++) {
 518                 struct rte_memseg_list *msl = &mcfg->memsegs[i];
 519
 520                 if (msl->socket_id != socket)
 521                         continue;
 522
 523                 if (msl->base_va == NULL)
 524                         continue;
 525
 526                 /* if pages of specific size were requested */
 527                 if (size_flags != 0 && check_hugepage_sz(size_flags,
 528                                 msl->page_sz))
 529                         requested_msls[n_requested_msls++] = msl;
 530                 else if (size_flags == 0 || size_hint)
 531                         other_msls[n_other_msls++] = msl;
 532         }
 533
 534         /* sort the lists, smallest first */
 535         qsort(requested_msls, n_requested_msls, sizeof(requested_msls[0]),
 536                         compare_pagesz);
 537         qsort(other_msls, n_other_msls, sizeof(other_msls[0]),
 538                         compare_pagesz);
 539
 540         /* now, extract page sizes we are supposed to try */
 541         prev_pg_sz = 0;
 542         n_requested_pg_sz = 0;
 543         for (i = 0; i < n_requested_msls; i++) {
 544                 uint64_t pg_sz = requested_msls[i]->page_sz;
 545
 546                 if (prev_pg_sz != pg_sz) {
 547                         requested_pg_sz[n_requested_pg_sz++] = pg_sz;
 548                         prev_pg_sz = pg_sz;
 549                 }
 550         }
 551         prev_pg_sz = 0;
 552         n_other_pg_sz = 0;
 553         for (i = 0; i < n_other_msls; i++) {
 554                 uint64_t pg_sz = other_msls[i]->page_sz;
 555
 556                 if (prev_pg_sz != pg_sz) {
 557                         other_pg_sz[n_other_pg_sz++] = pg_sz;
 558                         prev_pg_sz = pg_sz;
 559                 }
 560         }
 561
 562         /* finally, try allocating memory of specified page sizes, starting from
 563          * the smallest sizes
 564          */
 565         for (i = 0; i < n_requested_pg_sz; i++) {
 566                 uint64_t pg_sz = requested_pg_sz[i];
 567
 568                 /*
 569                  * do not pass the size hint here, as user expects other page
 570                  * sizes first, before resorting to best effort allocation.
 571                  */
 572                 if (!try_expand_heap(heap, pg_sz, size, socket, size_flags,
 573                                 align, bound, contig))
 574                         return 0;
 575         }
 576         if (n_other_pg_sz == 0)
 577                 return -1;
 578
 579         /* now, check if we can reserve anything with size hint */
 580         ret = find_suitable_element(heap, size, flags, align, bound, contig);
 581         if (ret != NULL)
 582                 return 0;
 583
 584         /*
 585          * we still couldn't reserve memory, so try expanding heap with other
 586          * page sizes, if there are any
 587          */
 588         for (i = 0; i < n_other_pg_sz; i++) {
 589                 uint64_t pg_sz = other_pg_sz[i];
 590
 591                 if (!try_expand_heap(heap, pg_sz, size, socket, flags,
 592                                 align, bound, contig))
 593                         return 0;
 594         }
 595         return -1;
 596 }
 597
 598 /* this will try lower page sizes first */
 599 static void *
 600 malloc_heap_alloc_on_heap_id(const char *type, size_t size,
 601                 unsigned int heap_id, unsigned int flags, size_t align,
 602                 size_t bound, bool contig)
 603 {
 604         struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
 605         struct malloc_heap *heap = &mcfg->malloc_heaps[heap_id];
 606         unsigned int size_flags = flags & ~RTE_MEMZONE_SIZE_HINT_ONLY;
 607         int socket_id;
 608         void *ret;
 609
 610         rte_spinlock_lock(&(heap->lock));
 611
 612         align = align == 0 ? 1 : align;
 613
 614         /* for legacy mode, try once and with all flags */
 615         if (internal_config.legacy_mem) {
 616                 ret = heap_alloc(heap, type, size, flags, align, bound, contig);
 617                 goto alloc_unlock;
 618         }
 619
 620         /*
 621          * we do not pass the size hint here, because even if allocation fails,
 622          * we may still be able to allocate memory from appropriate page sizes,
 623          * we just need to request more memory first.
 624          */
 625
 626         socket_id = rte_socket_id_by_idx(heap_id);
 627         /*
 628          * if socket ID is negative, we cannot find a socket ID for this heap -
 629          * which means it's an external heap. those can have unexpected page
 630          * sizes, so if the user asked to allocate from there - assume user
 631          * knows what they're doing, and allow allocating from there with any
 632          * page size flags.
 633          */
 634         if (socket_id < 0)
 635                 size_flags |= RTE_MEMZONE_SIZE_HINT_ONLY;
 636
 637         ret = heap_alloc(heap, type, size, size_flags, align, bound, contig);
 638         if (ret != NULL)
 639                 goto alloc_unlock;
 640
 641         /* if socket ID is invalid, this is an external heap */
 642         if (socket_id < 0)
 643                 goto alloc_unlock;
 644
 645         if (!alloc_more_mem_on_socket(heap, size, socket_id, flags, align,
 646                         bound, contig)) {
 647                 ret = heap_alloc(heap, type, size, flags, align, bound, contig);
 648
 649                 /* this should have succeeded */
 650                 if (ret == NULL)
 651                         RTE_LOG(ERR, EAL, "Error allocating from heap\n");
 652         }
 653 alloc_unlock:
 654         rte_spinlock_unlock(&(heap->lock));
 655         return ret;
 656 }
 657
 658 void *
 659 malloc_heap_alloc(const char *type, size_t size, int socket_arg,
 660                 unsigned int flags, size_t align, size_t bound, bool contig)
 661 {
 662         int socket, heap_id, i;
 663         void *ret;
 664
 665         /* return NULL if size is 0 or alignment is not power-of-2 */
 666         if (size == 0 || (align && !rte_is_power_of_2(align)))
 667                 return NULL;
 668
 669         if (!rte_eal_has_hugepages() && socket_arg < RTE_MAX_NUMA_NODES)
 670                 socket_arg = SOCKET_ID_ANY;
 671
 672         if (socket_arg == SOCKET_ID_ANY)
 673                 socket = malloc_get_numa_socket();
 674         else
 675                 socket = socket_arg;
 676
 677         /* turn socket ID into heap ID */
 678         heap_id = malloc_socket_to_heap_id(socket);
 679         /* if heap id is negative, socket ID was invalid */
 680         if (heap_id < 0)
 681                 return NULL;
 682
 683         ret = malloc_heap_alloc_on_heap_id(type, size, heap_id, flags, align,
 684                         bound, contig);
 685         if (ret != NULL || socket_arg != SOCKET_ID_ANY)
 686                 return ret;
 687
 688         /* try other heaps. we are only iterating through native DPDK sockets,
 689          * so external heaps won't be included.
 690          */
 691         for (i = 0; i < (int) rte_socket_count(); i++) {
 692                 if (i == heap_id)
 693                         continue;
 694                 ret = malloc_heap_alloc_on_heap_id(type, size, i, flags, align,
 695                                 bound, contig);
 696                 if (ret != NULL)
 697                         return ret;
 698         }
 699         return NULL;
 700 }
 701
 702 static void *
 703 heap_alloc_biggest_on_heap_id(const char *type, unsigned int heap_id,
 704                 unsigned int flags, size_t align, bool contig)
 705 {
 706         struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
 707         struct malloc_heap *heap = &mcfg->malloc_heaps[heap_id];
 708         void *ret;
 709
 710         rte_spinlock_lock(&(heap->lock));
 711
 712         align = align == 0 ? 1 : align;
 713
 714         ret = heap_alloc_biggest(heap, type, flags, align, contig);
 715
 716         rte_spinlock_unlock(&(heap->lock));
 717
 718         return ret;
 719 }
 720
 721 void *
 722 malloc_heap_alloc_biggest(const char *type, int socket_arg, unsigned int flags,
 723                 size_t align, bool contig)
 724 {
 725         int socket, i, cur_socket, heap_id;
 726         void *ret;
 727
 728         /* return NULL if align is not power-of-2 */
 729         if ((align && !rte_is_power_of_2(align)))
 730                 return NULL;
 731
 732         if (!rte_eal_has_hugepages())
 733                 socket_arg = SOCKET_ID_ANY;
 734
 735         if (socket_arg == SOCKET_ID_ANY)
 736                 socket = malloc_get_numa_socket();
 737         else
 738                 socket = socket_arg;
 739
 740         /* turn socket ID into heap ID */
 741         heap_id = malloc_socket_to_heap_id(socket);
 742         /* if heap id is negative, socket ID was invalid */
 743         if (heap_id < 0)
 744                 return NULL;
 745
 746         ret = heap_alloc_biggest_on_heap_id(type, heap_id, flags, align,
 747                         contig);
 748         if (ret != NULL || socket_arg != SOCKET_ID_ANY)
 749                 return ret;
 750
 751         /* try other heaps */
 752         for (i = 0; i < (int) rte_socket_count(); i++) {
 753                 cur_socket = rte_socket_id_by_idx(i);
 754                 if (cur_socket == socket)
 755                         continue;
 756                 ret = heap_alloc_biggest_on_heap_id(type, i, flags, align,
 757                                 contig);
 758                 if (ret != NULL)
 759                         return ret;
 760         }
 761         return NULL;
 762 }
 763
 764 /* this function is exposed in malloc_mp.h */
 765 int
 766 malloc_heap_free_pages(void *aligned_start, size_t aligned_len)
 767 {
 768         int n_segs, seg_idx, max_seg_idx;
 769         struct rte_memseg_list *msl;
 770         size_t page_sz;
 771
 772         msl = rte_mem_virt2memseg_list(aligned_start);
 773         if (msl == NULL)
 774                 return -1;
 775
 776         page_sz = (size_t)msl->page_sz;
 777         n_segs = aligned_len / page_sz;
 778         seg_idx = RTE_PTR_DIFF(aligned_start, msl->base_va) / page_sz;
 779         max_seg_idx = seg_idx + n_segs;
 780
 781         for (; seg_idx < max_seg_idx; seg_idx++) {
 782                 struct rte_memseg *ms;
 783
 784                 ms = rte_fbarray_get(&msl->memseg_arr, seg_idx);
 785                 eal_memalloc_free_seg(ms);
 786         }
 787         return 0;
 788 }
 789
 790 int
 791 malloc_heap_free(struct malloc_elem *elem)
 792 {
 793         struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
 794         struct malloc_heap *heap;
 795         void *start, *aligned_start, *end, *aligned_end;
 796         size_t len, aligned_len, page_sz;
 797         struct rte_memseg_list *msl;
 798         unsigned int i, n_segs, before_space, after_space;
 799         int ret;
 800
 801         if (!malloc_elem_cookies_ok(elem) || elem->state != ELEM_BUSY)
 802                 return -1;
 803
 804         /* elem may be merged with previous element, so keep heap address */
 805         heap = elem->heap;
 806         msl = elem->msl;
 807         page_sz = (size_t)msl->page_sz;
 808
 809         rte_spinlock_lock(&(heap->lock));
 810
 811         /* mark element as free */
 812         elem->state = ELEM_FREE;
 813
 814         elem = malloc_elem_free(elem);
 815
 816         /* anything after this is a bonus */
 817         ret = 0;
 818
 819         /* ...of which we can't avail if we are in legacy mode, or if this is an
 820          * externally allocated segment.
 821          */
 822         if (internal_config.legacy_mem || (msl->external > 0))
 823                 goto free_unlock;
 824
 825         /* check if we can free any memory back to the system */
 826         if (elem->size < page_sz)
 827                 goto free_unlock;
 828
 829         /* probably, but let's make sure, as we may not be using up full page */
 830         start = elem;
 831         len = elem->size;
 832         aligned_start = RTE_PTR_ALIGN_CEIL(start, page_sz);
 833         end = RTE_PTR_ADD(elem, len);
 834         aligned_end = RTE_PTR_ALIGN_FLOOR(end, page_sz);
 835
 836         aligned_len = RTE_PTR_DIFF(aligned_end, aligned_start);
 837
 838         /* can't free anything */
 839         if (aligned_len < page_sz)
 840                 goto free_unlock;
 841
 842         /* we can free something. however, some of these pages may be marked as
 843          * unfreeable, so also check that as well
 844          */
 845         n_segs = aligned_len / page_sz;
 846         for (i = 0; i < n_segs; i++) {
 847                 const struct rte_memseg *tmp =
 848                                 rte_mem_virt2memseg(aligned_start, msl);
 849
 850                 if (tmp->flags & RTE_MEMSEG_FLAG_DO_NOT_FREE) {
 851                         /* this is an unfreeable segment, so move start */
 852                         aligned_start = RTE_PTR_ADD(tmp->addr, tmp->len);
 853                 }
 854         }
 855
 856         /* recalculate length and number of segments */
 857         aligned_len = RTE_PTR_DIFF(aligned_end, aligned_start);
 858         n_segs = aligned_len / page_sz;
 859
 860         /* check if we can still free some pages */
 861         if (n_segs == 0)
 862                 goto free_unlock;
 863
 864         /* We're not done yet. We also have to check if by freeing space we will
 865          * be leaving free elements that are too small to store new elements.
 866          * Check if we have enough space in the beginning and at the end, or if
 867          * start/end are exactly page aligned.
 868          */
 869         before_space = RTE_PTR_DIFF(aligned_start, elem);
 870         after_space = RTE_PTR_DIFF(end, aligned_end);
 871         if (before_space != 0 &&
 872                         before_space < MALLOC_ELEM_OVERHEAD + MIN_DATA_SIZE) {
 873                 /* There is not enough space before start, but we may be able to
 874                  * move the start forward by one page.
 875                  */
 876                 if (n_segs == 1)
 877                         goto free_unlock;
 878
 879                 /* move start */
 880                 aligned_start = RTE_PTR_ADD(aligned_start, page_sz);
 881                 aligned_len -= page_sz;
 882                 n_segs--;
 883         }
 884         if (after_space != 0 && after_space <
 885                         MALLOC_ELEM_OVERHEAD + MIN_DATA_SIZE) {
 886                 /* There is not enough space after end, but we may be able to
 887                  * move the end backwards by one page.
 888                  */
 889                 if (n_segs == 1)
 890                         goto free_unlock;
 891
 892                 /* move end */
 893                 aligned_end = RTE_PTR_SUB(aligned_end, page_sz);
 894                 aligned_len -= page_sz;
 895                 n_segs--;
 896         }
 897
 898         /* now we can finally free us some pages */
 899
 900         rte_rwlock_write_lock(&mcfg->memory_hotplug_lock);
 901
 902         /*
 903          * we allow secondary processes to clear the heap of this allocated
 904          * memory because it is safe to do so, as even if notifications about
 905          * unmapped pages don't make it to other processes, heap is shared
 906          * across all processes, and will become empty of this memory anyway,
 907          * and nothing can allocate it back unless primary process will be able
 908          * to deliver allocation message to every single running process.
 909          */
 910
 911         malloc_elem_free_list_remove(elem);
 912
 913         malloc_elem_hide_region(elem, (void *) aligned_start, aligned_len);
 914
 915         heap->total_size -= aligned_len;
 916
 917         if (rte_eal_process_type() == RTE_PROC_PRIMARY) {
 918                 /* notify user about changes in memory map */
 919                 eal_memalloc_mem_event_notify(RTE_MEM_EVENT_FREE,
 920                                 aligned_start, aligned_len);
 921
 922                 /* don't care if any of this fails */
 923                 malloc_heap_free_pages(aligned_start, aligned_len);
 924
 925                 request_sync();
 926         } else {
 927                 struct malloc_mp_req req;
 928
 929                 memset(&req, 0, sizeof(req));
 930
 931                 req.t = REQ_TYPE_FREE;
 932                 req.free_req.addr = aligned_start;
 933                 req.free_req.len = aligned_len;
 934
 935                 /*
 936                  * we request primary to deallocate pages, but we don't do it
 937                  * in this thread. instead, we notify primary that we would like
 938                  * to deallocate pages, and this process will receive another
 939                  * request (in parallel) that will do it for us on another
 940                  * thread.
 941                  *
 942                  * we also don't really care if this succeeds - the data is
 943                  * already removed from the heap, so it is, for all intents and
 944                  * purposes, hidden from the rest of DPDK even if some other
 945                  * process (including this one) may have these pages mapped.
 946                  *
 947                  * notifications about deallocated memory happen during sync.
 948                  */
 949                 request_to_primary(&req);
 950         }
 951
 952         RTE_LOG(DEBUG, EAL, "Heap on socket %d was shrunk by %zdMB\n",
 953                 msl->socket_id, aligned_len >> 20ULL);
 954
 955         rte_rwlock_write_unlock(&mcfg->memory_hotplug_lock);
 956 free_unlock:
 957         rte_spinlock_unlock(&(heap->lock));
 958         return ret;
 959 }
 960
 961 int
 962 malloc_heap_resize(struct malloc_elem *elem, size_t size)
 963 {
 964         int ret;
 965
 966         if (!malloc_elem_cookies_ok(elem) || elem->state != ELEM_BUSY)
 967                 return -1;
 968
 969         rte_spinlock_lock(&(elem->heap->lock));
 970
 971         ret = malloc_elem_resize(elem, size);
 972
 973         rte_spinlock_unlock(&(elem->heap->lock));
 974
 975         return ret;
 976 }
 977
 978 /*
 979  * Function to retrieve data for a given heap
 980  */
 981 int
 982 malloc_heap_get_stats(struct malloc_heap *heap,
 983                 struct rte_malloc_socket_stats *socket_stats)
 984 {
 985         size_t idx;
 986         struct malloc_elem *elem;
 987
 988         rte_spinlock_lock(&heap->lock);
 989
 990         /* Initialise variables for heap */
 991         socket_stats->free_count = 0;
 992         socket_stats->heap_freesz_bytes = 0;
 993         socket_stats->greatest_free_size = 0;
 994
 995         /* Iterate through free list */
 996         for (idx = 0; idx < RTE_HEAP_NUM_FREELISTS; idx++) {
 997                 for (elem = LIST_FIRST(&heap->free_head[idx]);
 998                         !!elem; elem = LIST_NEXT(elem, free_list))
 999                 {
1000                         socket_stats->free_count++;
1001                         socket_stats->heap_freesz_bytes += elem->size;
1002                         if (elem->size > socket_stats->greatest_free_size)
1003                                 socket_stats->greatest_free_size = elem->size;
1004                 }
1005         }
1006         /* Get stats on overall heap and allocated memory on this heap */
1007         socket_stats->heap_totalsz_bytes = heap->total_size;
1008         socket_stats->heap_allocsz_bytes = (socket_stats->heap_totalsz_bytes -
1009                         socket_stats->heap_freesz_bytes);
1010         socket_stats->alloc_count = heap->alloc_count;
1011
1012         rte_spinlock_unlock(&heap->lock);
1013         return 0;
1014 }
1015
1016 /*
1017  * Function to retrieve data for a given heap
1018  */
1019 void
1020 malloc_heap_dump(struct malloc_heap *heap, FILE *f)
1021 {
1022         struct malloc_elem *elem;
1023
1024         rte_spinlock_lock(&heap->lock);
1025
1026         fprintf(f, "Heap size: 0x%zx\n", heap->total_size);
1027         fprintf(f, "Heap alloc count: %u\n", heap->alloc_count);
1028
1029         elem = heap->first;
1030         while (elem) {
1031                 malloc_elem_dump(elem, f);
1032                 elem = elem->next;
1033         }
1034
1035         rte_spinlock_unlock(&heap->lock);
1036 }
1037
1038 static int
1039 destroy_seg(struct malloc_elem *elem, size_t len)
1040 {
1041         struct malloc_heap *heap = elem->heap;
1042         struct rte_memseg_list *msl;
1043
1044         msl = elem->msl;
1045
1046         /* notify all subscribers that a memory area is going to be removed */
1047         eal_memalloc_mem_event_notify(RTE_MEM_EVENT_FREE, elem, len);
1048
1049         /* this element can be removed */
1050         malloc_elem_free_list_remove(elem);
1051         malloc_elem_hide_region(elem, elem, len);
1052
1053         heap->total_size -= len;
1054
1055         memset(elem, 0, sizeof(*elem));
1056
1057         /* destroy the fbarray backing this memory */
1058         if (rte_fbarray_destroy(&msl->memseg_arr) < 0)
1059                 return -1;
1060
1061         /* reset the memseg list */
1062         memset(msl, 0, sizeof(*msl));
1063
1064         return 0;
1065 }
1066
1067 int
1068 malloc_heap_add_external_memory(struct malloc_heap *heap, void *va_addr,
1069                 rte_iova_t iova_addrs[], unsigned int n_pages, size_t page_sz)
1070 {
1071         struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
1072         char fbarray_name[RTE_FBARRAY_NAME_LEN];
1073         struct rte_memseg_list *msl = NULL;
1074         struct rte_fbarray *arr;
1075         size_t seg_len = n_pages * page_sz;
1076         unsigned int i;
1077
1078         /* first, find a free memseg list */
1079         for (i = 0; i < RTE_MAX_MEMSEG_LISTS; i++) {
1080                 struct rte_memseg_list *tmp = &mcfg->memsegs[i];
1081                 if (tmp->base_va == NULL) {
1082                         msl = tmp;
1083                         break;
1084                 }
1085         }
1086         if (msl == NULL) {
1087                 RTE_LOG(ERR, EAL, "Couldn't find empty memseg list\n");
1088                 rte_errno = ENOSPC;
1089                 return -1;
1090         }
1091
1092         snprintf(fbarray_name, sizeof(fbarray_name) - 1, "%s_%p",
1093                         heap->name, va_addr);
1094
1095         /* create the backing fbarray */
1096         if (rte_fbarray_init(&msl->memseg_arr, fbarray_name, n_pages,
1097                         sizeof(struct rte_memseg)) < 0) {
1098                 RTE_LOG(ERR, EAL, "Couldn't create fbarray backing the memseg list\n");
1099                 return -1;
1100         }
1101         arr = &msl->memseg_arr;
1102
1103         /* fbarray created, fill it up */
1104         for (i = 0; i < n_pages; i++) {
1105                 struct rte_memseg *ms;
1106
1107                 rte_fbarray_set_used(arr, i);
1108                 ms = rte_fbarray_get(arr, i);
1109                 ms->addr = RTE_PTR_ADD(va_addr, i * page_sz);
1110                 ms->iova = iova_addrs == NULL ? RTE_BAD_IOVA : iova_addrs[i];
1111                 ms->hugepage_sz = page_sz;
1112                 ms->len = page_sz;
1113                 ms->nchannel = rte_memory_get_nchannel();
1114                 ms->nrank = rte_memory_get_nrank();
1115                 ms->socket_id = heap->socket_id;
1116         }
1117
1118         /* set up the memseg list */
1119         msl->base_va = va_addr;
1120         msl->page_sz = page_sz;
1121         msl->socket_id = heap->socket_id;
1122         msl->len = seg_len;
1123         msl->version = 0;
1124         msl->external = 1;
1125
1126         /* erase contents of new memory */
1127         memset(va_addr, 0, seg_len);
1128
1129         /* now, add newly minted memory to the malloc heap */
1130         malloc_heap_add_memory(heap, msl, va_addr, seg_len);
1131
1132         heap->total_size += seg_len;
1133
1134         /* all done! */
1135         RTE_LOG(DEBUG, EAL, "Added segment for heap %s starting at %p\n",
1136                         heap->name, va_addr);
1137
1138         /* notify all subscribers that a new memory area has been added */
1139         eal_memalloc_mem_event_notify(RTE_MEM_EVENT_ALLOC,
1140                         va_addr, seg_len);
1141
1142         return 0;
1143 }
1144
1145 int
1146 malloc_heap_remove_external_memory(struct malloc_heap *heap, void *va_addr,
1147                 size_t len)
1148 {
1149         struct malloc_elem *elem = heap->first;
1150
1151         /* find element with specified va address */
1152         while (elem != NULL && elem != va_addr) {
1153                 elem = elem->next;
1154                 /* stop if we've blown past our VA */
1155                 if (elem > (struct malloc_elem *)va_addr) {
1156                         rte_errno = ENOENT;
1157                         return -1;
1158                 }
1159         }
1160         /* check if element was found */
1161         if (elem == NULL || elem->msl->len != len) {
1162                 rte_errno = ENOENT;
1163                 return -1;
1164         }
1165         /* if element's size is not equal to segment len, segment is busy */
1166         if (elem->state == ELEM_BUSY || elem->size != len) {
1167                 rte_errno = EBUSY;
1168                 return -1;
1169         }
1170         return destroy_seg(elem, len);
1171 }
1172
1173 int
1174 malloc_heap_create(struct malloc_heap *heap, const char *heap_name)
1175 {
1176         struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
1177         uint32_t next_socket_id = mcfg->next_socket_id;
1178
1179         /* prevent overflow. did you really create 2 billion heaps??? */
1180         if (next_socket_id > INT32_MAX) {
1181                 RTE_LOG(ERR, EAL, "Cannot assign new socket ID's\n");
1182                 rte_errno = ENOSPC;
1183                 return -1;
1184         }
1185
1186         /* initialize empty heap */
1187         heap->alloc_count = 0;
1188         heap->first = NULL;
1189         heap->last = NULL;
1190         LIST_INIT(heap->free_head);
1191         rte_spinlock_init(&heap->lock);
1192         heap->total_size = 0;
1193         heap->socket_id = next_socket_id;
1194
1195         /* we hold a global mem hotplug writelock, so it's safe to increment */
1196         mcfg->next_socket_id++;
1197
1198         /* set up name */
1199         strlcpy(heap->name, heap_name, RTE_HEAP_NAME_MAX_LEN);
1200         return 0;
1201 }
1202
1203 int
1204 malloc_heap_destroy(struct malloc_heap *heap)
1205 {
1206         if (heap->alloc_count != 0) {
1207                 RTE_LOG(ERR, EAL, "Heap is still in use\n");
1208                 rte_errno = EBUSY;
1209                 return -1;
1210         }
1211         if (heap->first != NULL || heap->last != NULL) {
1212                 RTE_LOG(ERR, EAL, "Heap still contains memory segments\n");
1213                 rte_errno = EBUSY;
1214                 return -1;
1215         }
1216         if (heap->total_size != 0)
1217                 RTE_LOG(ERR, EAL, "Total size not zero, heap is likely corrupt\n");
1218
1219         /* after this, the lock will be dropped */
1220         memset(heap, 0, sizeof(*heap));
1221
1222         return 0;
1223 }
1224
1225 int
1226 rte_eal_malloc_heap_init(void)
1227 {
1228         struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
1229         unsigned int i;
1230
1231         if (rte_eal_process_type() == RTE_PROC_PRIMARY) {
1232                 /* assign min socket ID to external heaps */
1233                 mcfg->next_socket_id = EXTERNAL_HEAP_MIN_SOCKET_ID;
1234
1235                 /* assign names to default DPDK heaps */
1236                 for (i = 0; i < rte_socket_count(); i++) {
1237                         struct malloc_heap *heap = &mcfg->malloc_heaps[i];
1238                         char heap_name[RTE_HEAP_NAME_MAX_LEN];
1239                         int socket_id = rte_socket_id_by_idx(i);
1240
1241                         snprintf(heap_name, sizeof(heap_name) - 1,
1242                                         "socket_%i", socket_id);
1243                         strlcpy(heap->name, heap_name, RTE_HEAP_NAME_MAX_LEN);
1244                         heap->socket_id = socket_id;
1245                 }
1246         }
1247
1248
1249         if (register_mp_requests()) {
1250                 RTE_LOG(ERR, EAL, "Couldn't register malloc multiprocess actions\n");
1251                 rte_rwlock_read_unlock(&mcfg->memory_hotplug_lock);
1252                 return -1;
1253         }
1254
1255         /* unlock mem hotplug here. it's safe for primary as no requests can
1256          * even come before primary itself is fully initialized, and secondaries
1257          * do not need to initialize the heap.
1258          */
1259         rte_rwlock_read_unlock(&mcfg->memory_hotplug_lock);
1260
1261         /* secondary process does not need to initialize anything */
1262         if (rte_eal_process_type() != RTE_PROC_PRIMARY)
1263                 return 0;
1264
1265         /* add all IOVA-contiguous areas to the heap */
1266         return rte_memseg_contig_walk(malloc_add_seg, NULL);
1267 }