1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2010-2019 Intel Corporation
11 #include <sys/queue.h>
13 #include <rte_common.h>
14 #include <rte_memory.h>
15 #include <rte_per_lcore.h>
16 #include <rte_launch.h>
18 #include <rte_lcore.h>
19 #include <rte_malloc.h>
20 #include <rte_cycles.h>
21 #include <rte_random.h>
22 #include <rte_string_fns.h>
30 is_mem_on_socket(int32_t socket);
33 addr_to_socket(void *addr);
39 * Allocate some dynamic memory from heap (3 areas). Check that areas
40 * don't overlap and that alignment constraints match. This test is
41 * done many times on different lcores simultaneously.
44 /* Test if memory overlaps: return 1 if true, or 0 if false. */
46 is_memory_overlap(void *p1, size_t len1, void *p2, size_t len2)
48 unsigned long ptr1 = (unsigned long)p1;
49 unsigned long ptr2 = (unsigned long)p2;
51 if (ptr2 >= ptr1 && (ptr2 - ptr1) < len1)
53 else if (ptr2 < ptr1 && (ptr1 - ptr2) < len2)
59 is_aligned(void *p, int align)
61 unsigned long addr = (unsigned long)p;
62 unsigned mask = align - 1;
70 test_align_overlap_per_lcore(__attribute__((unused)) void *arg)
72 const unsigned align1 = 8,
76 void *p1 = NULL, *p2 = NULL, *p3 = NULL;
79 for (i = 0; i < N; i++) {
80 p1 = rte_zmalloc("dummy", 1000, align1);
82 printf("rte_zmalloc returned NULL (i=%u)\n", i);
86 for(j = 0; j < 1000 ; j++) {
87 if( *(char *)p1 != 0) {
88 printf("rte_zmalloc didn't zero the allocated memory\n");
92 p2 = rte_malloc("dummy", 1000, align2);
94 printf("rte_malloc returned NULL (i=%u)\n", i);
99 p3 = rte_malloc("dummy", 1000, align3);
101 printf("rte_malloc returned NULL (i=%u)\n", i);
107 if (is_memory_overlap(p1, 1000, p2, 1000)) {
108 printf("p1 and p2 overlaps\n");
111 if (is_memory_overlap(p2, 1000, p3, 1000)) {
112 printf("p2 and p3 overlaps\n");
115 if (is_memory_overlap(p1, 1000, p3, 1000)) {
116 printf("p1 and p3 overlaps\n");
119 if (!is_aligned(p1, align1)) {
120 printf("p1 is not aligned\n");
123 if (!is_aligned(p2, align2)) {
124 printf("p2 is not aligned\n");
127 if (!is_aligned(p3, align3)) {
128 printf("p3 is not aligned\n");
135 rte_malloc_dump_stats(stdout, "dummy");
141 test_reordered_free_per_lcore(__attribute__((unused)) void *arg)
143 const unsigned align1 = 8,
150 for (i = 0; i < 30; i++) {
151 p1 = rte_zmalloc("dummy", 1000, align1);
153 printf("rte_zmalloc returned NULL (i=%u)\n", i);
157 for(j = 0; j < 1000 ; j++) {
158 if( *(char *)p1 != 0) {
159 printf("rte_zmalloc didn't zero the allocated memory\n");
163 /* use calloc to allocate 1000 16-byte items this time */
164 p2 = rte_calloc("dummy", 1000, 16, align2);
165 /* for third request use regular malloc again */
166 p3 = rte_malloc("dummy", 1000, align3);
168 printf("rte_malloc returned NULL (i=%u)\n", i);
172 if (is_memory_overlap(p1, 1000, p2, 1000)) {
173 printf("p1 and p2 overlaps\n");
176 if (is_memory_overlap(p2, 1000, p3, 1000)) {
177 printf("p2 and p3 overlaps\n");
180 if (is_memory_overlap(p1, 1000, p3, 1000)) {
181 printf("p1 and p3 overlaps\n");
184 if (!is_aligned(p1, align1)) {
185 printf("p1 is not aligned\n");
188 if (!is_aligned(p2, align2)) {
189 printf("p2 is not aligned\n");
192 if (!is_aligned(p3, align3)) {
193 printf("p3 is not aligned\n");
196 /* try freeing in every possible order */
230 rte_malloc_dump_stats(stdout, "dummy");
235 /* test function inside the malloc lib*/
237 test_str_to_size(void)
243 {{ "5G", (uint64_t)5 * 1024 * 1024 *1024 },
244 {"0x20g", (uint64_t)0x20 * 1024 * 1024 *1024},
245 {"10M", 10 * 1024 * 1024},
246 {"050m", 050 * 1024 * 1024},
252 {"-1", 0}, /* negative values return 0 */
255 {"18446744073709551616", 0} /* ULLONG_MAX + 1 == out of range*/
258 for (i = 0; i < sizeof(test_values)/sizeof(test_values[0]); i++)
259 if (rte_str_to_size(test_values[i].str) != test_values[i].value)
265 test_multi_alloc_statistics(void)
268 struct rte_malloc_socket_stats pre_stats, post_stats ,first_stats, second_stats;
273 /* Dynamically calculate the overhead by allocating one cacheline and
274 * then comparing what was allocated from the heap.
276 rte_malloc_get_socket_stats(socket, &pre_stats);
278 void *dummy = rte_malloc_socket(NULL, RTE_CACHE_LINE_SIZE, 0, socket);
282 rte_malloc_get_socket_stats(socket, &post_stats);
284 /* after subtracting cache line, remainder is overhead */
285 overhead = post_stats.heap_allocsz_bytes - pre_stats.heap_allocsz_bytes;
286 overhead -= RTE_CACHE_LINE_SIZE;
290 /* Now start the real tests */
291 rte_malloc_get_socket_stats(socket, &pre_stats);
293 void *p1 = rte_malloc_socket("stats", size , align, socket);
297 rte_malloc_dump_stats(stdout, "stats");
299 rte_malloc_get_socket_stats(socket,&post_stats);
300 /* Check statistics reported are correct */
301 /* All post stats should be equal to pre stats after alloc freed */
302 if ((post_stats.heap_totalsz_bytes != pre_stats.heap_totalsz_bytes) &&
303 (post_stats.heap_freesz_bytes!=pre_stats.heap_freesz_bytes) &&
304 (post_stats.heap_allocsz_bytes!=pre_stats.heap_allocsz_bytes)&&
305 (post_stats.alloc_count!=pre_stats.alloc_count)&&
306 (post_stats.free_count!=pre_stats.free_count)) {
307 printf("Malloc statistics are incorrect - freed alloc\n");
310 /* Check two consecutive allocations */
313 rte_malloc_get_socket_stats(socket,&pre_stats);
314 void *p2 = rte_malloc_socket("add", size ,align, socket);
317 rte_malloc_get_socket_stats(socket,&first_stats);
319 void *p3 = rte_malloc_socket("add2", size,align, socket);
323 rte_malloc_get_socket_stats(socket,&second_stats);
328 /* After freeing both allocations check stats return to original */
329 rte_malloc_get_socket_stats(socket, &post_stats);
331 if(second_stats.heap_totalsz_bytes != first_stats.heap_totalsz_bytes) {
332 printf("Incorrect heap statistics: Total size \n");
335 /* Check allocated size is equal to two additions plus overhead */
336 if(second_stats.heap_allocsz_bytes !=
337 size + overhead + first_stats.heap_allocsz_bytes) {
338 printf("Incorrect heap statistics: Allocated size \n");
341 /* Check that allocation count increments correctly i.e. +1 */
342 if (second_stats.alloc_count != first_stats.alloc_count + 1) {
343 printf("Incorrect heap statistics: Allocated count \n");
347 if (second_stats.free_count != first_stats.free_count){
348 printf("Incorrect heap statistics: Free count \n");
352 /* Make sure that we didn't touch our greatest chunk: 2 * 11M) */
353 if (post_stats.greatest_free_size != pre_stats.greatest_free_size) {
354 printf("Incorrect heap statistics: Greatest free size \n");
357 /* Free size must equal the original free size minus the new allocation*/
358 if (first_stats.heap_freesz_bytes <= second_stats.heap_freesz_bytes) {
359 printf("Incorrect heap statistics: Free size \n");
363 if ((post_stats.heap_totalsz_bytes != pre_stats.heap_totalsz_bytes) &&
364 (post_stats.heap_freesz_bytes!=pre_stats.heap_freesz_bytes) &&
365 (post_stats.heap_allocsz_bytes!=pre_stats.heap_allocsz_bytes)&&
366 (post_stats.alloc_count!=pre_stats.alloc_count)&&
367 (post_stats.free_count!=pre_stats.free_count)) {
368 printf("Malloc statistics are incorrect - freed alloc\n");
377 const char hello_str[] = "Hello, world!";
378 const unsigned size1 = 1024;
379 const unsigned size2 = size1 + 1024;
380 const unsigned size3 = size2;
381 const unsigned size4 = size3 + 1024;
383 /* test data is the same even if element is moved*/
384 char *ptr1 = rte_zmalloc(NULL, size1, RTE_CACHE_LINE_SIZE);
386 printf("NULL pointer returned from rte_zmalloc\n");
389 strlcpy(ptr1, hello_str, size1);
390 char *ptr2 = rte_realloc(ptr1, size2, RTE_CACHE_LINE_SIZE);
393 printf("NULL pointer returned from rte_realloc\n");
397 printf("unexpected - ptr1 == ptr2\n");
399 if (strcmp(ptr2, hello_str) != 0){
400 printf("Error - lost data from pointed area\n");
405 for (i = strnlen(hello_str, sizeof(hello_str)); i < size1; i++)
407 printf("Bad data in realloc\n");
411 /* now allocate third element, free the second
412 * and resize third. It should not move. (ptr1 is now invalid)
414 char *ptr3 = rte_zmalloc(NULL, size3, RTE_CACHE_LINE_SIZE);
416 printf("NULL pointer returned from rte_zmalloc\n");
420 for (i = 0; i < size3; i++)
422 printf("Bad data in zmalloc\n");
428 /* first resize to half the size of the freed block */
429 char *ptr4 = rte_realloc(ptr3, size4, RTE_CACHE_LINE_SIZE);
431 printf("NULL pointer returned from rte_realloc\n");
436 printf("Unexpected - ptr4 != ptr3\n");
440 /* now resize again to the full size of the freed block */
441 ptr4 = rte_realloc(ptr3, size3 + size2 + size1, RTE_CACHE_LINE_SIZE);
443 printf("Unexpected - ptr4 != ptr3 on second resize\n");
449 /* now try a resize to a smaller size, see if it works */
450 const unsigned size5 = 1024;
451 const unsigned size6 = size5 / 2;
452 char *ptr5 = rte_malloc(NULL, size5, RTE_CACHE_LINE_SIZE);
454 printf("NULL pointer returned from rte_malloc\n");
457 char *ptr6 = rte_realloc(ptr5, size6, RTE_CACHE_LINE_SIZE);
459 printf("NULL pointer returned from rte_realloc\n");
464 printf("Error, resizing to a smaller size moved data\n");
470 /* check for behaviour changing alignment */
471 const unsigned size7 = 1024;
472 const unsigned orig_align = RTE_CACHE_LINE_SIZE;
473 unsigned new_align = RTE_CACHE_LINE_SIZE * 2;
474 char *ptr7 = rte_malloc(NULL, size7, orig_align);
476 printf("NULL pointer returned from rte_malloc\n");
479 /* calc an alignment we don't already have */
480 while(RTE_PTR_ALIGN(ptr7, new_align) == ptr7)
482 char *ptr8 = rte_realloc(ptr7, size7, new_align);
484 printf("NULL pointer returned from rte_realloc\n");
488 if (RTE_PTR_ALIGN(ptr8, new_align) != ptr8){
489 printf("Failure to re-align data\n");
495 /* test behaviour when there is a free block after current one,
496 * but its not big enough
498 unsigned size9 = 1024, size10 = 1024;
499 unsigned size11 = size9 + size10 + 256;
500 char *ptr9 = rte_malloc(NULL, size9, RTE_CACHE_LINE_SIZE);
502 printf("NULL pointer returned from rte_malloc\n");
505 char *ptr10 = rte_malloc(NULL, size10, RTE_CACHE_LINE_SIZE);
507 printf("NULL pointer returned from rte_malloc\n");
511 char *ptr11 = rte_realloc(ptr10, size11, RTE_CACHE_LINE_SIZE);
513 printf("NULL pointer returned from rte_realloc\n");
518 printf("Error, unexpected that realloc has not created new buffer\n");
524 /* check we don't crash if we pass null to realloc
525 * We should get a malloc of the size requested*/
526 const size_t size12 = 1024;
528 char *ptr12 = rte_realloc(NULL, size12, RTE_CACHE_LINE_SIZE);
530 printf("NULL pointer returned from rte_realloc\n");
533 if (rte_malloc_validate(ptr12, &size12_check) < 0 ||
534 size12_check != size12){
540 /* check realloc_socket part */
541 int32_t socket_count = 0, socket_allocated, socket;
546 for (socket = 0; socket < RTE_MAX_NUMA_NODES; socket++) {
547 if (is_mem_on_socket(socket)) {
552 /* j == 1 -> resizing */
553 ptr2 = rte_realloc_socket(ptr1, size,
557 printf("NULL pointer returned from rte_realloc_socket\n");
562 socket_allocated = addr_to_socket(ptr2);
563 if (socket_allocated != socket) {
564 printf("Requested socket (%d) doesn't mach allocated one (%d)\n",
565 socket, socket_allocated);
568 size += RTE_CACHE_LINE_SIZE;
573 /* Print warnign if only a single socket, but don't fail the test */
574 if (socket_count < 2)
575 printf("WARNING: realloc_socket test needs memory on multiple sockets!\n");
585 test_random_alloc_free(void *_ __attribute__((unused)))
588 struct mem_list *next;
594 rte_srand((unsigned)rte_rdtsc());
596 for (i = 0; i < N; i++){
597 unsigned free_mem = 0;
598 size_t allocated_size;
600 const unsigned mem_size = sizeof(struct mem_list) + \
601 rte_rand() % (64 * 1024);
602 const unsigned align = 1 << (rte_rand() % 12); /* up to 4k alignment */
603 struct mem_list *entry = rte_malloc(NULL,
607 if (RTE_PTR_ALIGN(entry, align)!= entry)
609 if (rte_malloc_validate(entry, &allocated_size) == -1
610 || allocated_size < mem_size)
612 memset(entry->data, rte_lcore_id(),
613 mem_size - sizeof(*entry));
614 entry->next = list_head;
615 if (rte_malloc_validate(entry, NULL) == -1)
620 /* switch to freeing the memory with a 20% probability */
621 free_mem = ((rte_rand() % 10) >= 8);
624 struct mem_list *entry = list_head;
625 list_head = list_head->next;
629 printf("Lcore %u allocated/freed %u blocks\n", rte_lcore_id(), count);
633 #define err_return() do { \
634 printf("%s: %d - Error\n", __func__, __LINE__); \
639 test_rte_malloc_validate(void)
641 const size_t request_size = 1024;
642 size_t allocated_size;
643 char *data_ptr = rte_malloc(NULL, request_size, RTE_CACHE_LINE_SIZE);
644 #ifdef RTE_MALLOC_DEBUG
646 char *over_write_vals = NULL;
649 if (data_ptr == NULL) {
650 printf("%s: %d - Allocation error\n", __func__, __LINE__);
654 /* check that a null input returns -1 */
655 if (rte_malloc_validate(NULL, NULL) != -1)
658 /* check that we get ok on a valid pointer */
659 if (rte_malloc_validate(data_ptr, &allocated_size) < 0)
662 /* check that the returned size is ok */
663 if (allocated_size < request_size)
666 #ifdef RTE_MALLOC_DEBUG
668 /****** change the header to be bad */
670 over_write_vals = (char *)((uintptr_t)data_ptr - sizeof(save_buf));
671 /* first save the data as a backup before overwriting it */
672 memcpy(save_buf, over_write_vals, sizeof(save_buf));
673 memset(over_write_vals, 1, sizeof(save_buf));
674 /* then run validate */
675 retval = rte_malloc_validate(data_ptr, NULL);
676 /* finally restore the data again */
677 memcpy(over_write_vals, save_buf, sizeof(save_buf));
678 /* check we previously had an error */
682 /* check all ok again */
683 if (rte_malloc_validate(data_ptr, &allocated_size) < 0)
686 /**** change the trailer to be bad */
687 over_write_vals = (char *)((uintptr_t)data_ptr + allocated_size);
688 /* first save the data as a backup before overwriting it */
689 memcpy(save_buf, over_write_vals, sizeof(save_buf));
690 memset(over_write_vals, 1, sizeof(save_buf));
691 /* then run validate */
692 retval = rte_malloc_validate(data_ptr, NULL);
693 /* finally restore the data again */
694 memcpy(over_write_vals, save_buf, sizeof(save_buf));
698 /* check all ok again */
699 if (rte_malloc_validate(data_ptr, &allocated_size) < 0)
713 test_zero_aligned_alloc(void)
715 char *p1 = rte_malloc(NULL,1024, 0);
718 if (!rte_is_aligned(p1, RTE_CACHE_LINE_SIZE))
725 if (p1) rte_free(p1);
730 test_malloc_bad_params(void)
732 const char *type = NULL;
734 unsigned align = RTE_CACHE_LINE_SIZE;
736 /* rte_malloc expected to return null with inappropriate size */
737 char *bad_ptr = rte_malloc(type, size, align);
741 /* rte_malloc expected to return null with inappropriate alignment */
745 bad_ptr = rte_malloc(type, size, align);
752 /* clean up pointer */
759 check_socket_mem(const struct rte_memseg_list *msl, void *arg)
761 int32_t *socket = arg;
766 return *socket == msl->socket_id;
769 /* Check if memory is available on a specific socket */
771 is_mem_on_socket(int32_t socket)
773 return rte_memseg_list_walk(check_socket_mem, &socket);
778 * Find what socket a memory address is on. Only works for addresses within
779 * memsegs, not heap or stack...
782 addr_to_socket(void * addr)
784 const struct rte_memseg *ms = rte_mem_virt2memseg(addr, NULL);
785 return ms == NULL ? -1 : ms->socket_id;
789 /* Test using rte_[c|m|zm]alloc_socket() on a specific socket */
791 test_alloc_single_socket(int32_t socket)
793 const char *type = NULL;
794 const size_t size = 10;
795 const unsigned align = 0;
797 int32_t desired_socket = (socket == SOCKET_ID_ANY) ?
798 (int32_t)rte_socket_id() : socket;
800 /* Test rte_calloc_socket() */
801 mem = rte_calloc_socket(type, size, sizeof(char), align, socket);
804 if (addr_to_socket(mem) != desired_socket) {
810 /* Test rte_malloc_socket() */
811 mem = rte_malloc_socket(type, size, align, socket);
814 if (addr_to_socket(mem) != desired_socket) {
819 /* Test rte_zmalloc_socket() */
820 mem = rte_zmalloc_socket(type, size, align, socket);
823 if (addr_to_socket(mem) != desired_socket) {
833 test_alloc_socket(void)
835 unsigned socket_count = 0;
838 if (test_alloc_single_socket(SOCKET_ID_ANY) < 0)
841 for (i = 0; i < RTE_MAX_NUMA_NODES; i++) {
842 if (is_mem_on_socket(i)) {
844 if (test_alloc_single_socket(i) < 0) {
845 printf("Fail: rte_malloc_socket(..., %u) did not succeed\n",
851 if (test_alloc_single_socket(i) == 0) {
852 printf("Fail: rte_malloc_socket(..., %u) succeeded\n",
859 /* Print warnign if only a single socket, but don't fail the test */
860 if (socket_count < 2) {
861 printf("WARNING: alloc_socket test needs memory on multiple sockets!\n");
873 if (test_str_to_size() < 0){
874 printf("test_str_to_size() failed\n");
877 else printf("test_str_to_size() passed\n");
879 if (test_zero_aligned_alloc() < 0){
880 printf("test_zero_aligned_alloc() failed\n");
883 else printf("test_zero_aligned_alloc() passed\n");
885 if (test_malloc_bad_params() < 0){
886 printf("test_malloc_bad_params() failed\n");
889 else printf("test_malloc_bad_params() passed\n");
891 if (test_realloc() < 0){
892 printf("test_realloc() failed\n");
895 else printf("test_realloc() passed\n");
897 /*----------------------------*/
898 RTE_LCORE_FOREACH_SLAVE(lcore_id) {
899 rte_eal_remote_launch(test_align_overlap_per_lcore, NULL, lcore_id);
902 RTE_LCORE_FOREACH_SLAVE(lcore_id) {
903 if (rte_eal_wait_lcore(lcore_id) < 0)
907 printf("test_align_overlap_per_lcore() failed\n");
910 else printf("test_align_overlap_per_lcore() passed\n");
912 /*----------------------------*/
913 RTE_LCORE_FOREACH_SLAVE(lcore_id) {
914 rte_eal_remote_launch(test_reordered_free_per_lcore, NULL, lcore_id);
917 RTE_LCORE_FOREACH_SLAVE(lcore_id) {
918 if (rte_eal_wait_lcore(lcore_id) < 0)
922 printf("test_reordered_free_per_lcore() failed\n");
925 else printf("test_reordered_free_per_lcore() passed\n");
927 /*----------------------------*/
928 RTE_LCORE_FOREACH_SLAVE(lcore_id) {
929 rte_eal_remote_launch(test_random_alloc_free, NULL, lcore_id);
932 RTE_LCORE_FOREACH_SLAVE(lcore_id) {
933 if (rte_eal_wait_lcore(lcore_id) < 0)
937 printf("test_random_alloc_free() failed\n");
940 else printf("test_random_alloc_free() passed\n");
942 /*----------------------------*/
943 ret = test_rte_malloc_validate();
945 printf("test_rte_malloc_validate() failed\n");
948 else printf("test_rte_malloc_validate() passed\n");
950 ret = test_alloc_socket();
952 printf("test_alloc_socket() failed\n");
955 else printf("test_alloc_socket() passed\n");
957 ret = test_multi_alloc_statistics();
959 printf("test_multi_alloc_statistics() failed\n");
963 printf("test_multi_alloc_statistics() passed\n");
968 REGISTER_TEST_COMMAND(malloc_autotest, test_malloc);