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_eal_memconfig.h>
16 #include <rte_per_lcore.h>
17 #include <rte_launch.h>
19 #include <rte_lcore.h>
20 #include <rte_malloc.h>
21 #include <rte_cycles.h>
22 #include <rte_random.h>
23 #include <rte_string_fns.h>
31 is_mem_on_socket(int32_t socket);
34 addr_to_socket(void *addr);
40 * Allocate some dynamic memory from heap (3 areas). Check that areas
41 * don't overlap and that alignment constraints match. This test is
42 * done many times on different lcores simultaneously.
45 /* Test if memory overlaps: return 1 if true, or 0 if false. */
47 is_memory_overlap(void *p1, size_t len1, void *p2, size_t len2)
49 unsigned long ptr1 = (unsigned long)p1;
50 unsigned long ptr2 = (unsigned long)p2;
52 if (ptr2 >= ptr1 && (ptr2 - ptr1) < len1)
54 else if (ptr2 < ptr1 && (ptr1 - ptr2) < len2)
60 is_aligned(void *p, int align)
62 unsigned long addr = (unsigned long)p;
63 unsigned mask = align - 1;
71 test_align_overlap_per_lcore(__attribute__((unused)) void *arg)
73 const unsigned align1 = 8,
77 void *p1 = NULL, *p2 = NULL, *p3 = NULL;
80 for (i = 0; i < N; i++) {
81 p1 = rte_zmalloc("dummy", 1000, align1);
83 printf("rte_zmalloc returned NULL (i=%u)\n", i);
87 for(j = 0; j < 1000 ; j++) {
88 if( *(char *)p1 != 0) {
89 printf("rte_zmalloc didn't zero the allocated memory\n");
93 p2 = rte_malloc("dummy", 1000, align2);
95 printf("rte_malloc returned NULL (i=%u)\n", i);
100 p3 = rte_malloc("dummy", 1000, align3);
102 printf("rte_malloc returned NULL (i=%u)\n", i);
108 if (is_memory_overlap(p1, 1000, p2, 1000)) {
109 printf("p1 and p2 overlaps\n");
112 if (is_memory_overlap(p2, 1000, p3, 1000)) {
113 printf("p2 and p3 overlaps\n");
116 if (is_memory_overlap(p1, 1000, p3, 1000)) {
117 printf("p1 and p3 overlaps\n");
120 if (!is_aligned(p1, align1)) {
121 printf("p1 is not aligned\n");
124 if (!is_aligned(p2, align2)) {
125 printf("p2 is not aligned\n");
128 if (!is_aligned(p3, align3)) {
129 printf("p3 is not aligned\n");
136 rte_malloc_dump_stats(stdout, "dummy");
142 test_reordered_free_per_lcore(__attribute__((unused)) void *arg)
144 const unsigned align1 = 8,
151 for (i = 0; i < 30; i++) {
152 p1 = rte_zmalloc("dummy", 1000, align1);
154 printf("rte_zmalloc returned NULL (i=%u)\n", i);
158 for(j = 0; j < 1000 ; j++) {
159 if( *(char *)p1 != 0) {
160 printf("rte_zmalloc didn't zero the allocated memory\n");
164 /* use calloc to allocate 1000 16-byte items this time */
165 p2 = rte_calloc("dummy", 1000, 16, align2);
166 /* for third request use regular malloc again */
167 p3 = rte_malloc("dummy", 1000, align3);
169 printf("rte_malloc returned NULL (i=%u)\n", i);
173 if (is_memory_overlap(p1, 1000, p2, 1000)) {
174 printf("p1 and p2 overlaps\n");
177 if (is_memory_overlap(p2, 1000, p3, 1000)) {
178 printf("p2 and p3 overlaps\n");
181 if (is_memory_overlap(p1, 1000, p3, 1000)) {
182 printf("p1 and p3 overlaps\n");
185 if (!is_aligned(p1, align1)) {
186 printf("p1 is not aligned\n");
189 if (!is_aligned(p2, align2)) {
190 printf("p2 is not aligned\n");
193 if (!is_aligned(p3, align3)) {
194 printf("p3 is not aligned\n");
197 /* try freeing in every possible order */
231 rte_malloc_dump_stats(stdout, "dummy");
236 /* test function inside the malloc lib*/
238 test_str_to_size(void)
244 {{ "5G", (uint64_t)5 * 1024 * 1024 *1024 },
245 {"0x20g", (uint64_t)0x20 * 1024 * 1024 *1024},
246 {"10M", 10 * 1024 * 1024},
247 {"050m", 050 * 1024 * 1024},
253 {"-1", 0}, /* negative values return 0 */
256 {"18446744073709551616", 0} /* ULLONG_MAX + 1 == out of range*/
259 for (i = 0; i < sizeof(test_values)/sizeof(test_values[0]); i++)
260 if (rte_str_to_size(test_values[i].str) != test_values[i].value)
266 test_multi_alloc_statistics(void)
269 struct rte_malloc_socket_stats pre_stats, post_stats ,first_stats, second_stats;
274 /* Dynamically calculate the overhead by allocating one cacheline and
275 * then comparing what was allocated from the heap.
277 rte_malloc_get_socket_stats(socket, &pre_stats);
279 void *dummy = rte_malloc_socket(NULL, RTE_CACHE_LINE_SIZE, 0, socket);
283 rte_malloc_get_socket_stats(socket, &post_stats);
285 /* after subtracting cache line, remainder is overhead */
286 overhead = post_stats.heap_allocsz_bytes - pre_stats.heap_allocsz_bytes;
287 overhead -= RTE_CACHE_LINE_SIZE;
291 /* Now start the real tests */
292 rte_malloc_get_socket_stats(socket, &pre_stats);
294 void *p1 = rte_malloc_socket("stats", size , align, socket);
298 rte_malloc_dump_stats(stdout, "stats");
300 rte_malloc_get_socket_stats(socket,&post_stats);
301 /* Check statistics reported are correct */
302 /* All post stats should be equal to pre stats after alloc freed */
303 if ((post_stats.heap_totalsz_bytes != pre_stats.heap_totalsz_bytes) &&
304 (post_stats.heap_freesz_bytes!=pre_stats.heap_freesz_bytes) &&
305 (post_stats.heap_allocsz_bytes!=pre_stats.heap_allocsz_bytes)&&
306 (post_stats.alloc_count!=pre_stats.alloc_count)&&
307 (post_stats.free_count!=pre_stats.free_count)) {
308 printf("Malloc statistics are incorrect - freed alloc\n");
311 /* Check two consecutive allocations */
314 rte_malloc_get_socket_stats(socket,&pre_stats);
315 void *p2 = rte_malloc_socket("add", size ,align, socket);
318 rte_malloc_get_socket_stats(socket,&first_stats);
320 void *p3 = rte_malloc_socket("add2", size,align, socket);
324 rte_malloc_get_socket_stats(socket,&second_stats);
329 /* After freeing both allocations check stats return to original */
330 rte_malloc_get_socket_stats(socket, &post_stats);
332 if(second_stats.heap_totalsz_bytes != first_stats.heap_totalsz_bytes) {
333 printf("Incorrect heap statistics: Total size \n");
336 /* Check allocated size is equal to two additions plus overhead */
337 if(second_stats.heap_allocsz_bytes !=
338 size + overhead + first_stats.heap_allocsz_bytes) {
339 printf("Incorrect heap statistics: Allocated size \n");
342 /* Check that allocation count increments correctly i.e. +1 */
343 if (second_stats.alloc_count != first_stats.alloc_count + 1) {
344 printf("Incorrect heap statistics: Allocated count \n");
348 if (second_stats.free_count != first_stats.free_count){
349 printf("Incorrect heap statistics: Free count \n");
353 /* Make sure that we didn't touch our greatest chunk: 2 * 11M) */
354 if (post_stats.greatest_free_size != pre_stats.greatest_free_size) {
355 printf("Incorrect heap statistics: Greatest free size \n");
358 /* Free size must equal the original free size minus the new allocation*/
359 if (first_stats.heap_freesz_bytes <= second_stats.heap_freesz_bytes) {
360 printf("Incorrect heap statistics: Free size \n");
364 if ((post_stats.heap_totalsz_bytes != pre_stats.heap_totalsz_bytes) &&
365 (post_stats.heap_freesz_bytes!=pre_stats.heap_freesz_bytes) &&
366 (post_stats.heap_allocsz_bytes!=pre_stats.heap_allocsz_bytes)&&
367 (post_stats.alloc_count!=pre_stats.alloc_count)&&
368 (post_stats.free_count!=pre_stats.free_count)) {
369 printf("Malloc statistics are incorrect - freed alloc\n");
378 const char hello_str[] = "Hello, world!";
379 const unsigned size1 = 1024;
380 const unsigned size2 = size1 + 1024;
381 const unsigned size3 = size2;
382 const unsigned size4 = size3 + 1024;
384 /* test data is the same even if element is moved*/
385 char *ptr1 = rte_zmalloc(NULL, size1, RTE_CACHE_LINE_SIZE);
387 printf("NULL pointer returned from rte_zmalloc\n");
390 strlcpy(ptr1, hello_str, size1);
391 char *ptr2 = rte_realloc(ptr1, size2, RTE_CACHE_LINE_SIZE);
394 printf("NULL pointer returned from rte_realloc\n");
398 printf("unexpected - ptr1 == ptr2\n");
400 if (strcmp(ptr2, hello_str) != 0){
401 printf("Error - lost data from pointed area\n");
406 for (i = strnlen(hello_str, sizeof(hello_str)); i < size1; i++)
408 printf("Bad data in realloc\n");
412 /* now allocate third element, free the second
413 * and resize third. It should not move. (ptr1 is now invalid)
415 char *ptr3 = rte_zmalloc(NULL, size3, RTE_CACHE_LINE_SIZE);
417 printf("NULL pointer returned from rte_zmalloc\n");
421 for (i = 0; i < size3; i++)
423 printf("Bad data in zmalloc\n");
429 /* first resize to half the size of the freed block */
430 char *ptr4 = rte_realloc(ptr3, size4, RTE_CACHE_LINE_SIZE);
432 printf("NULL pointer returned from rte_realloc\n");
437 printf("Unexpected - ptr4 != ptr3\n");
441 /* now resize again to the full size of the freed block */
442 ptr4 = rte_realloc(ptr3, size3 + size2 + size1, RTE_CACHE_LINE_SIZE);
444 printf("Unexpected - ptr4 != ptr3 on second resize\n");
450 /* now try a resize to a smaller size, see if it works */
451 const unsigned size5 = 1024;
452 const unsigned size6 = size5 / 2;
453 char *ptr5 = rte_malloc(NULL, size5, RTE_CACHE_LINE_SIZE);
455 printf("NULL pointer returned from rte_malloc\n");
458 char *ptr6 = rte_realloc(ptr5, size6, RTE_CACHE_LINE_SIZE);
460 printf("NULL pointer returned from rte_realloc\n");
465 printf("Error, resizing to a smaller size moved data\n");
471 /* check for behaviour changing alignment */
472 const unsigned size7 = 1024;
473 const unsigned orig_align = RTE_CACHE_LINE_SIZE;
474 unsigned new_align = RTE_CACHE_LINE_SIZE * 2;
475 char *ptr7 = rte_malloc(NULL, size7, orig_align);
477 printf("NULL pointer returned from rte_malloc\n");
480 /* calc an alignment we don't already have */
481 while(RTE_PTR_ALIGN(ptr7, new_align) == ptr7)
483 char *ptr8 = rte_realloc(ptr7, size7, new_align);
485 printf("NULL pointer returned from rte_realloc\n");
489 if (RTE_PTR_ALIGN(ptr8, new_align) != ptr8){
490 printf("Failure to re-align data\n");
496 /* test behaviour when there is a free block after current one,
497 * but its not big enough
499 unsigned size9 = 1024, size10 = 1024;
500 unsigned size11 = size9 + size10 + 256;
501 char *ptr9 = rte_malloc(NULL, size9, RTE_CACHE_LINE_SIZE);
503 printf("NULL pointer returned from rte_malloc\n");
506 char *ptr10 = rte_malloc(NULL, size10, RTE_CACHE_LINE_SIZE);
508 printf("NULL pointer returned from rte_malloc\n");
512 char *ptr11 = rte_realloc(ptr10, size11, RTE_CACHE_LINE_SIZE);
514 printf("NULL pointer returned from rte_realloc\n");
519 printf("Error, unexpected that realloc has not created new buffer\n");
525 /* check we don't crash if we pass null to realloc
526 * We should get a malloc of the size requested*/
527 const size_t size12 = 1024;
529 char *ptr12 = rte_realloc(NULL, size12, RTE_CACHE_LINE_SIZE);
531 printf("NULL pointer returned from rte_realloc\n");
534 if (rte_malloc_validate(ptr12, &size12_check) < 0 ||
535 size12_check != size12){
541 /* check realloc_socket part */
542 int32_t socket_count = 0, socket_allocated, socket;
547 for (socket = 0; socket < RTE_MAX_NUMA_NODES; socket++) {
548 if (is_mem_on_socket(socket)) {
553 /* j == 1 -> resizing */
554 ptr2 = rte_realloc_socket(ptr1, size,
558 printf("NULL pointer returned from rte_realloc_socket\n");
563 socket_allocated = addr_to_socket(ptr2);
564 if (socket_allocated != socket) {
565 printf("Requested socket (%d) doesn't mach allocated one (%d)\n",
566 socket, socket_allocated);
569 size += RTE_CACHE_LINE_SIZE;
574 /* Print warnign if only a single socket, but don't fail the test */
575 if (socket_count < 2)
576 printf("WARNING: realloc_socket test needs memory on multiple sockets!\n");
586 test_random_alloc_free(void *_ __attribute__((unused)))
589 struct mem_list *next;
595 rte_srand((unsigned)rte_rdtsc());
597 for (i = 0; i < N; i++){
598 unsigned free_mem = 0;
599 size_t allocated_size;
601 const unsigned mem_size = sizeof(struct mem_list) + \
602 rte_rand() % (64 * 1024);
603 const unsigned align = 1 << (rte_rand() % 12); /* up to 4k alignment */
604 struct mem_list *entry = rte_malloc(NULL,
608 if (RTE_PTR_ALIGN(entry, align)!= entry)
610 if (rte_malloc_validate(entry, &allocated_size) == -1
611 || allocated_size < mem_size)
613 memset(entry->data, rte_lcore_id(),
614 mem_size - sizeof(*entry));
615 entry->next = list_head;
616 if (rte_malloc_validate(entry, NULL) == -1)
621 /* switch to freeing the memory with a 20% probability */
622 free_mem = ((rte_rand() % 10) >= 8);
625 struct mem_list *entry = list_head;
626 list_head = list_head->next;
630 printf("Lcore %u allocated/freed %u blocks\n", rte_lcore_id(), count);
634 #define err_return() do { \
635 printf("%s: %d - Error\n", __func__, __LINE__); \
640 test_rte_malloc_validate(void)
642 const size_t request_size = 1024;
643 size_t allocated_size;
644 char *data_ptr = rte_malloc(NULL, request_size, RTE_CACHE_LINE_SIZE);
645 #ifdef RTE_MALLOC_DEBUG
647 char *over_write_vals = NULL;
650 if (data_ptr == NULL) {
651 printf("%s: %d - Allocation error\n", __func__, __LINE__);
655 /* check that a null input returns -1 */
656 if (rte_malloc_validate(NULL, NULL) != -1)
659 /* check that we get ok on a valid pointer */
660 if (rte_malloc_validate(data_ptr, &allocated_size) < 0)
663 /* check that the returned size is ok */
664 if (allocated_size < request_size)
667 #ifdef RTE_MALLOC_DEBUG
669 /****** change the header to be bad */
671 over_write_vals = (char *)((uintptr_t)data_ptr - sizeof(save_buf));
672 /* first save the data as a backup before overwriting it */
673 memcpy(save_buf, over_write_vals, sizeof(save_buf));
674 memset(over_write_vals, 1, sizeof(save_buf));
675 /* then run validate */
676 retval = rte_malloc_validate(data_ptr, NULL);
677 /* finally restore the data again */
678 memcpy(over_write_vals, save_buf, sizeof(save_buf));
679 /* check we previously had an error */
683 /* check all ok again */
684 if (rte_malloc_validate(data_ptr, &allocated_size) < 0)
687 /**** change the trailer to be bad */
688 over_write_vals = (char *)((uintptr_t)data_ptr + allocated_size);
689 /* first save the data as a backup before overwriting it */
690 memcpy(save_buf, over_write_vals, sizeof(save_buf));
691 memset(over_write_vals, 1, sizeof(save_buf));
692 /* then run validate */
693 retval = rte_malloc_validate(data_ptr, NULL);
694 /* finally restore the data again */
695 memcpy(over_write_vals, save_buf, sizeof(save_buf));
699 /* check all ok again */
700 if (rte_malloc_validate(data_ptr, &allocated_size) < 0)
714 test_zero_aligned_alloc(void)
716 char *p1 = rte_malloc(NULL,1024, 0);
719 if (!rte_is_aligned(p1, RTE_CACHE_LINE_SIZE))
726 if (p1) rte_free(p1);
731 test_malloc_bad_params(void)
733 const char *type = NULL;
735 unsigned align = RTE_CACHE_LINE_SIZE;
737 /* rte_malloc expected to return null with inappropriate size */
738 char *bad_ptr = rte_malloc(type, size, align);
742 /* rte_malloc expected to return null with inappropriate alignment */
746 bad_ptr = rte_malloc(type, size, align);
753 /* clean up pointer */
760 check_socket_mem(const struct rte_memseg_list *msl, void *arg)
762 int32_t *socket = arg;
767 return *socket == msl->socket_id;
770 /* Check if memory is available on a specific socket */
772 is_mem_on_socket(int32_t socket)
774 return rte_memseg_list_walk(check_socket_mem, &socket);
779 * Find what socket a memory address is on. Only works for addresses within
780 * memsegs, not heap or stack...
783 addr_to_socket(void * addr)
785 const struct rte_memseg *ms = rte_mem_virt2memseg(addr, NULL);
786 return ms == NULL ? -1 : ms->socket_id;
790 /* Test using rte_[c|m|zm]alloc_socket() on a specific socket */
792 test_alloc_single_socket(int32_t socket)
794 const char *type = NULL;
795 const size_t size = 10;
796 const unsigned align = 0;
798 int32_t desired_socket = (socket == SOCKET_ID_ANY) ?
799 (int32_t)rte_socket_id() : socket;
801 /* Test rte_calloc_socket() */
802 mem = rte_calloc_socket(type, size, sizeof(char), align, socket);
805 if (addr_to_socket(mem) != desired_socket) {
811 /* Test rte_malloc_socket() */
812 mem = rte_malloc_socket(type, size, align, socket);
815 if (addr_to_socket(mem) != desired_socket) {
820 /* Test rte_zmalloc_socket() */
821 mem = rte_zmalloc_socket(type, size, align, socket);
824 if (addr_to_socket(mem) != desired_socket) {
834 test_alloc_socket(void)
836 unsigned socket_count = 0;
839 if (test_alloc_single_socket(SOCKET_ID_ANY) < 0)
842 for (i = 0; i < RTE_MAX_NUMA_NODES; i++) {
843 if (is_mem_on_socket(i)) {
845 if (test_alloc_single_socket(i) < 0) {
846 printf("Fail: rte_malloc_socket(..., %u) did not succeed\n",
852 if (test_alloc_single_socket(i) == 0) {
853 printf("Fail: rte_malloc_socket(..., %u) succeeded\n",
860 /* Print warnign if only a single socket, but don't fail the test */
861 if (socket_count < 2) {
862 printf("WARNING: alloc_socket test needs memory on multiple sockets!\n");
874 if (test_str_to_size() < 0){
875 printf("test_str_to_size() failed\n");
878 else printf("test_str_to_size() passed\n");
880 if (test_zero_aligned_alloc() < 0){
881 printf("test_zero_aligned_alloc() failed\n");
884 else printf("test_zero_aligned_alloc() passed\n");
886 if (test_malloc_bad_params() < 0){
887 printf("test_malloc_bad_params() failed\n");
890 else printf("test_malloc_bad_params() passed\n");
892 if (test_realloc() < 0){
893 printf("test_realloc() failed\n");
896 else printf("test_realloc() passed\n");
898 /*----------------------------*/
899 RTE_LCORE_FOREACH_SLAVE(lcore_id) {
900 rte_eal_remote_launch(test_align_overlap_per_lcore, NULL, lcore_id);
903 RTE_LCORE_FOREACH_SLAVE(lcore_id) {
904 if (rte_eal_wait_lcore(lcore_id) < 0)
908 printf("test_align_overlap_per_lcore() failed\n");
911 else printf("test_align_overlap_per_lcore() passed\n");
913 /*----------------------------*/
914 RTE_LCORE_FOREACH_SLAVE(lcore_id) {
915 rte_eal_remote_launch(test_reordered_free_per_lcore, NULL, lcore_id);
918 RTE_LCORE_FOREACH_SLAVE(lcore_id) {
919 if (rte_eal_wait_lcore(lcore_id) < 0)
923 printf("test_reordered_free_per_lcore() failed\n");
926 else printf("test_reordered_free_per_lcore() passed\n");
928 /*----------------------------*/
929 RTE_LCORE_FOREACH_SLAVE(lcore_id) {
930 rte_eal_remote_launch(test_random_alloc_free, NULL, lcore_id);
933 RTE_LCORE_FOREACH_SLAVE(lcore_id) {
934 if (rte_eal_wait_lcore(lcore_id) < 0)
938 printf("test_random_alloc_free() failed\n");
941 else printf("test_random_alloc_free() passed\n");
943 /*----------------------------*/
944 ret = test_rte_malloc_validate();
946 printf("test_rte_malloc_validate() failed\n");
949 else printf("test_rte_malloc_validate() passed\n");
951 ret = test_alloc_socket();
953 printf("test_alloc_socket() failed\n");
956 else printf("test_alloc_socket() passed\n");
958 ret = test_multi_alloc_statistics();
960 printf("test_multi_alloc_statistics() failed\n");
964 printf("test_multi_alloc_statistics() passed\n");
969 REGISTER_TEST_COMMAND(malloc_autotest, test_malloc);