lib/librte_eal/common/malloc_elem.c

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(c) 2010-2014 Intel Corporation
   3  */
   4 #include <inttypes.h>
   5 #include <stdint.h>
   6 #include <stddef.h>
   7 #include <stdio.h>
   8 #include <string.h>
   9 #include <unistd.h>
  10 #include <sys/queue.h>
  11
  12 #include <rte_memory.h>
  13 #include <rte_eal.h>
  14 #include <rte_launch.h>
  15 #include <rte_per_lcore.h>
  16 #include <rte_lcore.h>
  17 #include <rte_debug.h>
  18 #include <rte_common.h>
  19 #include <rte_spinlock.h>
  20
  21 #include "eal_internal_cfg.h"
  22 #include "eal_memalloc.h"
  23 #include "malloc_elem.h"
  24 #include "malloc_heap.h"
  25
  26 size_t
  27 malloc_elem_find_max_iova_contig(struct malloc_elem *elem, size_t align)
  28 {
  29         void *cur_page, *contig_seg_start, *page_end, *cur_seg_end;
  30         void *data_start, *data_end;
  31         rte_iova_t expected_iova;
  32         struct rte_memseg *ms;
  33         size_t page_sz, cur, max;
  34
  35         page_sz = (size_t)elem->msl->page_sz;
  36         data_start = RTE_PTR_ADD(elem, MALLOC_ELEM_HEADER_LEN);
  37         data_end = RTE_PTR_ADD(elem, elem->size - MALLOC_ELEM_TRAILER_LEN);
  38         /* segment must start after header and with specified alignment */
  39         contig_seg_start = RTE_PTR_ALIGN_CEIL(data_start, align);
  40
  41         /* if we're in IOVA as VA mode, or if we're in legacy mode with
  42          * hugepages, all elements are IOVA-contiguous. however, we can only
  43          * make these assumptions about internal memory - externally allocated
  44          * segments have to be checked.
  45          */
  46         if (!elem->msl->external &&
  47                         (rte_eal_iova_mode() == RTE_IOVA_VA ||
  48                                 (internal_config.legacy_mem &&
  49                                         rte_eal_has_hugepages())))
  50                 return RTE_PTR_DIFF(data_end, contig_seg_start);
  51
  52         cur_page = RTE_PTR_ALIGN_FLOOR(contig_seg_start, page_sz);
  53         ms = rte_mem_virt2memseg(cur_page, elem->msl);
  54
  55         /* do first iteration outside the loop */
  56         page_end = RTE_PTR_ADD(cur_page, page_sz);
  57         cur_seg_end = RTE_MIN(page_end, data_end);
  58         cur = RTE_PTR_DIFF(cur_seg_end, contig_seg_start) -
  59                         MALLOC_ELEM_TRAILER_LEN;
  60         max = cur;
  61         expected_iova = ms->iova + page_sz;
  62         /* memsegs are contiguous in memory */
  63         ms++;
  64
  65         cur_page = RTE_PTR_ADD(cur_page, page_sz);
  66
  67         while (cur_page < data_end) {
  68                 page_end = RTE_PTR_ADD(cur_page, page_sz);
  69                 cur_seg_end = RTE_MIN(page_end, data_end);
  70
  71                 /* reset start of contiguous segment if unexpected iova */
  72                 if (ms->iova != expected_iova) {
  73                         /* next contiguous segment must start at specified
  74                          * alignment.
  75                          */
  76                         contig_seg_start = RTE_PTR_ALIGN(cur_page, align);
  77                         /* new segment start may be on a different page, so find
  78                          * the page and skip to next iteration to make sure
  79                          * we're not blowing past data end.
  80                          */
  81                         ms = rte_mem_virt2memseg(contig_seg_start, elem->msl);
  82                         cur_page = ms->addr;
  83                         /* don't trigger another recalculation */
  84                         expected_iova = ms->iova;
  85                         continue;
  86                 }
  87                 /* cur_seg_end ends on a page boundary or on data end. if we're
  88                  * looking at data end, then malloc trailer is already included
  89                  * in the calculations. if we're looking at page end, then we
  90                  * know there's more data past this page and thus there's space
  91                  * for malloc element trailer, so don't count it here.
  92                  */
  93                 cur = RTE_PTR_DIFF(cur_seg_end, contig_seg_start);
  94                 /* update max if cur value is bigger */
  95                 if (cur > max)
  96                         max = cur;
  97
  98                 /* move to next page */
  99                 cur_page = page_end;
 100                 expected_iova = ms->iova + page_sz;
 101                 /* memsegs are contiguous in memory */
 102                 ms++;
 103         }
 104
 105         return max;
 106 }
 107
 108 /*
 109  * Initialize a general malloc_elem header structure
 110  */
 111 void
 112 malloc_elem_init(struct malloc_elem *elem, struct malloc_heap *heap,
 113                 struct rte_memseg_list *msl, size_t size)
 114 {
 115         elem->heap = heap;
 116         elem->msl = msl;
 117         elem->prev = NULL;
 118         elem->next = NULL;
 119         memset(&elem->free_list, 0, sizeof(elem->free_list));
 120         elem->state = ELEM_FREE;
 121         elem->size = size;
 122         elem->pad = 0;
 123         set_header(elem);
 124         set_trailer(elem);
 125 }
 126
 127 void
 128 malloc_elem_insert(struct malloc_elem *elem)
 129 {
 130         struct malloc_elem *prev_elem, *next_elem;
 131         struct malloc_heap *heap = elem->heap;
 132
 133         /* first and last elements must be both NULL or both non-NULL */
 134         if ((heap->first == NULL) != (heap->last == NULL)) {
 135                 RTE_LOG(ERR, EAL, "Heap is probably corrupt\n");
 136                 return;
 137         }
 138
 139         if (heap->first == NULL && heap->last == NULL) {
 140                 /* if empty heap */
 141                 heap->first = elem;
 142                 heap->last = elem;
 143                 prev_elem = NULL;
 144                 next_elem = NULL;
 145         } else if (elem < heap->first) {
 146                 /* if lower than start */
 147                 prev_elem = NULL;
 148                 next_elem = heap->first;
 149                 heap->first = elem;
 150         } else if (elem > heap->last) {
 151                 /* if higher than end */
 152                 prev_elem = heap->last;
 153                 next_elem = NULL;
 154                 heap->last = elem;
 155         } else {
 156                 /* the new memory is somewhere inbetween start and end */
 157                 uint64_t dist_from_start, dist_from_end;
 158
 159                 dist_from_end = RTE_PTR_DIFF(heap->last, elem);
 160                 dist_from_start = RTE_PTR_DIFF(elem, heap->first);
 161
 162                 /* check which is closer, and find closest list entries */
 163                 if (dist_from_start < dist_from_end) {
 164                         prev_elem = heap->first;
 165                         while (prev_elem->next < elem)
 166                                 prev_elem = prev_elem->next;
 167                         next_elem = prev_elem->next;
 168                 } else {
 169                         next_elem = heap->last;
 170                         while (next_elem->prev > elem)
 171                                 next_elem = next_elem->prev;
 172                         prev_elem = next_elem->prev;
 173                 }
 174         }
 175
 176         /* insert new element */
 177         elem->prev = prev_elem;
 178         elem->next = next_elem;
 179         if (prev_elem)
 180                 prev_elem->next = elem;
 181         if (next_elem)
 182                 next_elem->prev = elem;
 183 }
 184
 185 /*
 186  * Attempt to find enough physically contiguous memory in this block to store
 187  * our data. Assume that element has at least enough space to fit in the data,
 188  * so we just check the page addresses.
 189  */
 190 static bool
 191 elem_check_phys_contig(const struct rte_memseg_list *msl,
 192                 void *start, size_t size)
 193 {
 194         return eal_memalloc_is_contig(msl, start, size);
 195 }
 196
 197 /*
 198  * calculate the starting point of where data of the requested size
 199  * and alignment would fit in the current element. If the data doesn't
 200  * fit, return NULL.
 201  */
 202 static void *
 203 elem_start_pt(struct malloc_elem *elem, size_t size, unsigned align,
 204                 size_t bound, bool contig)
 205 {
 206         size_t elem_size = elem->size;
 207
 208         /*
 209          * we're allocating from the end, so adjust the size of element by
 210          * alignment size.
 211          */
 212         while (elem_size >= size) {
 213                 const size_t bmask = ~(bound - 1);
 214                 uintptr_t end_pt = (uintptr_t)elem +
 215                                 elem_size - MALLOC_ELEM_TRAILER_LEN;
 216                 uintptr_t new_data_start = RTE_ALIGN_FLOOR((end_pt - size),
 217                                 align);
 218                 uintptr_t new_elem_start;
 219
 220                 /* check boundary */
 221                 if ((new_data_start & bmask) != ((end_pt - 1) & bmask)) {
 222                         end_pt = RTE_ALIGN_FLOOR(end_pt, bound);
 223                         new_data_start = RTE_ALIGN_FLOOR((end_pt - size),
 224                                         align);
 225                         end_pt = new_data_start + size;
 226
 227                         if (((end_pt - 1) & bmask) != (new_data_start & bmask))
 228                                 return NULL;
 229                 }
 230
 231                 new_elem_start = new_data_start - MALLOC_ELEM_HEADER_LEN;
 232
 233                 /* if the new start point is before the exist start,
 234                  * it won't fit
 235                  */
 236                 if (new_elem_start < (uintptr_t)elem)
 237                         return NULL;
 238
 239                 if (contig) {
 240                         size_t new_data_size = end_pt - new_data_start;
 241
 242                         /*
 243                          * if physical contiguousness was requested and we
 244                          * couldn't fit all data into one physically contiguous
 245                          * block, try again with lower addresses.
 246                          */
 247                         if (!elem_check_phys_contig(elem->msl,
 248                                         (void *)new_data_start,
 249                                         new_data_size)) {
 250                                 elem_size -= align;
 251                                 continue;
 252                         }
 253                 }
 254                 return (void *)new_elem_start;
 255         }
 256         return NULL;
 257 }
 258
 259 /*
 260  * use elem_start_pt to determine if we get meet the size and
 261  * alignment request from the current element
 262  */
 263 int
 264 malloc_elem_can_hold(struct malloc_elem *elem, size_t size,     unsigned align,
 265                 size_t bound, bool contig)
 266 {
 267         return elem_start_pt(elem, size, align, bound, contig) != NULL;
 268 }
 269
 270 /*
 271  * split an existing element into two smaller elements at the given
 272  * split_pt parameter.
 273  */
 274 static void
 275 split_elem(struct malloc_elem *elem, struct malloc_elem *split_pt)
 276 {
 277         struct malloc_elem *next_elem = elem->next;
 278         const size_t old_elem_size = (uintptr_t)split_pt - (uintptr_t)elem;
 279         const size_t new_elem_size = elem->size - old_elem_size;
 280
 281         malloc_elem_init(split_pt, elem->heap, elem->msl, new_elem_size);
 282         split_pt->prev = elem;
 283         split_pt->next = next_elem;
 284         if (next_elem)
 285                 next_elem->prev = split_pt;
 286         else
 287                 elem->heap->last = split_pt;
 288         elem->next = split_pt;
 289         elem->size = old_elem_size;
 290         set_trailer(elem);
 291 }
 292
 293 /*
 294  * our malloc heap is a doubly linked list, so doubly remove our element.
 295  */
 296 static void __rte_unused
 297 remove_elem(struct malloc_elem *elem)
 298 {
 299         struct malloc_elem *next, *prev;
 300         next = elem->next;
 301         prev = elem->prev;
 302
 303         if (next)
 304                 next->prev = prev;
 305         else
 306                 elem->heap->last = prev;
 307         if (prev)
 308                 prev->next = next;
 309         else
 310                 elem->heap->first = next;
 311
 312         elem->prev = NULL;
 313         elem->next = NULL;
 314 }
 315
 316 static int
 317 next_elem_is_adjacent(struct malloc_elem *elem)
 318 {
 319         return elem->next == RTE_PTR_ADD(elem, elem->size);
 320 }
 321
 322 static int
 323 prev_elem_is_adjacent(struct malloc_elem *elem)
 324 {
 325         return elem == RTE_PTR_ADD(elem->prev, elem->prev->size);
 326 }
 327
 328 /*
 329  * Given an element size, compute its freelist index.
 330  * We free an element into the freelist containing similarly-sized elements.
 331  * We try to allocate elements starting with the freelist containing
 332  * similarly-sized elements, and if necessary, we search freelists
 333  * containing larger elements.
 334  *
 335  * Example element size ranges for a heap with five free lists:
 336  *   heap->free_head[0] - (0   , 2^8]
 337  *   heap->free_head[1] - (2^8 , 2^10]
 338  *   heap->free_head[2] - (2^10 ,2^12]
 339  *   heap->free_head[3] - (2^12, 2^14]
 340  *   heap->free_head[4] - (2^14, MAX_SIZE]
 341  */
 342 size_t
 343 malloc_elem_free_list_index(size_t size)
 344 {
 345 #define MALLOC_MINSIZE_LOG2   8
 346 #define MALLOC_LOG2_INCREMENT 2
 347
 348         size_t log2;
 349         size_t index;
 350
 351         if (size <= (1UL << MALLOC_MINSIZE_LOG2))
 352                 return 0;
 353
 354         /* Find next power of 2 >= size. */
 355         log2 = sizeof(size) * 8 - __builtin_clzl(size-1);
 356
 357         /* Compute freelist index, based on log2(size). */
 358         index = (log2 - MALLOC_MINSIZE_LOG2 + MALLOC_LOG2_INCREMENT - 1) /
 359                 MALLOC_LOG2_INCREMENT;
 360
 361         return index <= RTE_HEAP_NUM_FREELISTS-1?
 362                 index: RTE_HEAP_NUM_FREELISTS-1;
 363 }
 364
 365 /*
 366  * Add the specified element to its heap's free list.
 367  */
 368 void
 369 malloc_elem_free_list_insert(struct malloc_elem *elem)
 370 {
 371         size_t idx;
 372
 373         idx = malloc_elem_free_list_index(elem->size - MALLOC_ELEM_HEADER_LEN);
 374         elem->state = ELEM_FREE;
 375         LIST_INSERT_HEAD(&elem->heap->free_head[idx], elem, free_list);
 376 }
 377
 378 /*
 379  * Remove the specified element from its heap's free list.
 380  */
 381 void
 382 malloc_elem_free_list_remove(struct malloc_elem *elem)
 383 {
 384         LIST_REMOVE(elem, free_list);
 385 }
 386
 387 /*
 388  * reserve a block of data in an existing malloc_elem. If the malloc_elem
 389  * is much larger than the data block requested, we split the element in two.
 390  * This function is only called from malloc_heap_alloc so parameter checking
 391  * is not done here, as it's done there previously.
 392  */
 393 struct malloc_elem *
 394 malloc_elem_alloc(struct malloc_elem *elem, size_t size, unsigned align,
 395                 size_t bound, bool contig)
 396 {
 397         struct malloc_elem *new_elem = elem_start_pt(elem, size, align, bound,
 398                         contig);
 399         const size_t old_elem_size = (uintptr_t)new_elem - (uintptr_t)elem;
 400         const size_t trailer_size = elem->size - old_elem_size - size -
 401                 MALLOC_ELEM_OVERHEAD;
 402
 403         malloc_elem_free_list_remove(elem);
 404
 405         if (trailer_size > MALLOC_ELEM_OVERHEAD + MIN_DATA_SIZE) {
 406                 /* split it, too much free space after elem */
 407                 struct malloc_elem *new_free_elem =
 408                                 RTE_PTR_ADD(new_elem, size + MALLOC_ELEM_OVERHEAD);
 409
 410                 split_elem(elem, new_free_elem);
 411                 malloc_elem_free_list_insert(new_free_elem);
 412
 413                 if (elem == elem->heap->last)
 414                         elem->heap->last = new_free_elem;
 415         }
 416
 417         if (old_elem_size < MALLOC_ELEM_OVERHEAD + MIN_DATA_SIZE) {
 418                 /* don't split it, pad the element instead */
 419                 elem->state = ELEM_BUSY;
 420                 elem->pad = old_elem_size;
 421
 422                 /* put a dummy header in padding, to point to real element header */
 423                 if (elem->pad > 0) { /* pad will be at least 64-bytes, as everything
 424                                      * is cache-line aligned */
 425                         new_elem->pad = elem->pad;
 426                         new_elem->state = ELEM_PAD;
 427                         new_elem->size = elem->size - elem->pad;
 428                         set_header(new_elem);
 429                 }
 430
 431                 return new_elem;
 432         }
 433
 434         /* we are going to split the element in two. The original element
 435          * remains free, and the new element is the one allocated.
 436          * Re-insert original element, in case its new size makes it
 437          * belong on a different list.
 438          */
 439         split_elem(elem, new_elem);
 440         new_elem->state = ELEM_BUSY;
 441         malloc_elem_free_list_insert(elem);
 442
 443         return new_elem;
 444 }
 445
 446 /*
 447  * join two struct malloc_elem together. elem1 and elem2 must
 448  * be contiguous in memory.
 449  */
 450 static inline void
 451 join_elem(struct malloc_elem *elem1, struct malloc_elem *elem2)
 452 {
 453         struct malloc_elem *next = elem2->next;
 454         elem1->size += elem2->size;
 455         if (next)
 456                 next->prev = elem1;
 457         else
 458                 elem1->heap->last = elem1;
 459         elem1->next = next;
 460 }
 461
 462 struct malloc_elem *
 463 malloc_elem_join_adjacent_free(struct malloc_elem *elem)
 464 {
 465         /*
 466          * check if next element exists, is adjacent and is free, if so join
 467          * with it, need to remove from free list.
 468          */
 469         if (elem->next != NULL && elem->next->state == ELEM_FREE &&
 470                         next_elem_is_adjacent(elem)) {
 471                 void *erase;
 472                 size_t erase_len;
 473
 474                 /* we will want to erase the trailer and header */
 475                 erase = RTE_PTR_SUB(elem->next, MALLOC_ELEM_TRAILER_LEN);
 476                 erase_len = MALLOC_ELEM_OVERHEAD + elem->next->pad;
 477
 478                 /* remove from free list, join to this one */
 479                 malloc_elem_free_list_remove(elem->next);
 480                 join_elem(elem, elem->next);
 481
 482                 /* erase header, trailer and pad */
 483                 memset(erase, 0, erase_len);
 484         }
 485
 486         /*
 487          * check if prev element exists, is adjacent and is free, if so join
 488          * with it, need to remove from free list.
 489          */
 490         if (elem->prev != NULL && elem->prev->state == ELEM_FREE &&
 491                         prev_elem_is_adjacent(elem)) {
 492                 struct malloc_elem *new_elem;
 493                 void *erase;
 494                 size_t erase_len;
 495
 496                 /* we will want to erase trailer and header */
 497                 erase = RTE_PTR_SUB(elem, MALLOC_ELEM_TRAILER_LEN);
 498                 erase_len = MALLOC_ELEM_OVERHEAD + elem->pad;
 499
 500                 /* remove from free list, join to this one */
 501                 malloc_elem_free_list_remove(elem->prev);
 502
 503                 new_elem = elem->prev;
 504                 join_elem(new_elem, elem);
 505
 506                 /* erase header, trailer and pad */
 507                 memset(erase, 0, erase_len);
 508
 509                 elem = new_elem;
 510         }
 511
 512         return elem;
 513 }
 514
 515 /*
 516  * free a malloc_elem block by adding it to the free list. If the
 517  * blocks either immediately before or immediately after newly freed block
 518  * are also free, the blocks are merged together.
 519  */
 520 struct malloc_elem *
 521 malloc_elem_free(struct malloc_elem *elem)
 522 {
 523         void *ptr;
 524         size_t data_len;
 525
 526         ptr = RTE_PTR_ADD(elem, MALLOC_ELEM_HEADER_LEN);
 527         data_len = elem->size - MALLOC_ELEM_OVERHEAD;
 528
 529         elem = malloc_elem_join_adjacent_free(elem);
 530
 531         malloc_elem_free_list_insert(elem);
 532
 533         elem->pad = 0;
 534
 535         /* decrease heap's count of allocated elements */
 536         elem->heap->alloc_count--;
 537
 538         memset(ptr, 0, data_len);
 539
 540         return elem;
 541 }
 542
 543 /* assume all checks were already done */
 544 void
 545 malloc_elem_hide_region(struct malloc_elem *elem, void *start, size_t len)
 546 {
 547         struct malloc_elem *hide_start, *hide_end, *prev, *next;
 548         size_t len_before, len_after;
 549
 550         hide_start = start;
 551         hide_end = RTE_PTR_ADD(start, len);
 552
 553         prev = elem->prev;
 554         next = elem->next;
 555
 556         /* we cannot do anything with non-adjacent elements */
 557         if (next && next_elem_is_adjacent(elem)) {
 558                 len_after = RTE_PTR_DIFF(next, hide_end);
 559                 if (len_after >= MALLOC_ELEM_OVERHEAD + MIN_DATA_SIZE) {
 560                         /* split after */
 561                         split_elem(elem, hide_end);
 562
 563                         malloc_elem_free_list_insert(hide_end);
 564                 } else if (len_after > 0) {
 565                         RTE_LOG(ERR, EAL, "Unaligned element, heap is probably corrupt\n");
 566                         return;
 567                 }
 568         }
 569
 570         /* we cannot do anything with non-adjacent elements */
 571         if (prev && prev_elem_is_adjacent(elem)) {
 572                 len_before = RTE_PTR_DIFF(hide_start, elem);
 573                 if (len_before >= MALLOC_ELEM_OVERHEAD + MIN_DATA_SIZE) {
 574                         /* split before */
 575                         split_elem(elem, hide_start);
 576
 577                         prev = elem;
 578                         elem = hide_start;
 579
 580                         malloc_elem_free_list_insert(prev);
 581                 } else if (len_before > 0) {
 582                         RTE_LOG(ERR, EAL, "Unaligned element, heap is probably corrupt\n");
 583                         return;
 584                 }
 585         }
 586
 587         remove_elem(elem);
 588 }
 589
 590 /*
 591  * attempt to resize a malloc_elem by expanding into any free space
 592  * immediately after it in memory.
 593  */
 594 int
 595 malloc_elem_resize(struct malloc_elem *elem, size_t size)
 596 {
 597         const size_t new_size = size + elem->pad + MALLOC_ELEM_OVERHEAD;
 598
 599         /* if we request a smaller size, then always return ok */
 600         if (elem->size >= new_size)
 601                 return 0;
 602
 603         /* check if there is a next element, it's free and adjacent */
 604         if (!elem->next || elem->next->state != ELEM_FREE ||
 605                         !next_elem_is_adjacent(elem))
 606                 return -1;
 607         if (elem->size + elem->next->size < new_size)
 608                 return -1;
 609
 610         /* we now know the element fits, so remove from free list,
 611          * join the two
 612          */
 613         malloc_elem_free_list_remove(elem->next);
 614         join_elem(elem, elem->next);
 615
 616         if (elem->size - new_size >= MIN_DATA_SIZE + MALLOC_ELEM_OVERHEAD) {
 617                 /* now we have a big block together. Lets cut it down a bit, by splitting */
 618                 struct malloc_elem *split_pt = RTE_PTR_ADD(elem, new_size);
 619                 split_pt = RTE_PTR_ALIGN_CEIL(split_pt, RTE_CACHE_LINE_SIZE);
 620                 split_elem(elem, split_pt);
 621                 malloc_elem_free_list_insert(split_pt);
 622         }
 623         return 0;
 624 }
 625
 626 static inline const char *
 627 elem_state_to_str(enum elem_state state)
 628 {
 629         switch (state) {
 630         case ELEM_PAD:
 631                 return "PAD";
 632         case ELEM_BUSY:
 633                 return "BUSY";
 634         case ELEM_FREE:
 635                 return "FREE";
 636         }
 637         return "ERROR";
 638 }
 639
 640 void
 641 malloc_elem_dump(const struct malloc_elem *elem, FILE *f)
 642 {
 643         fprintf(f, "Malloc element at %p (%s)\n", elem,
 644                         elem_state_to_str(elem->state));
 645         fprintf(f, "  len: 0x%zx pad: 0x%" PRIx32 "\n", elem->size, elem->pad);
 646         fprintf(f, "  prev: %p next: %p\n", elem->prev, elem->next);
 647 }