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