4 * Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
11 * * Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * * Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in
15 * the documentation and/or other materials provided with the
17 * * Neither the name of Intel Corporation nor the names of its
18 * contributors may be used to endorse or promote products derived
19 * from this software without specific prior written permission.
21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
40 #include <sys/queue.h>
42 #include <rte_common.h>
43 #include <rte_memory.h>
44 #include <rte_memzone.h>
45 #include <rte_per_lcore.h>
46 #include <rte_launch.h>
48 #include <rte_lcore.h>
49 #include <rte_malloc.h>
50 #include <rte_cycles.h>
51 #include <rte_random.h>
52 #include <rte_string_fns.h>
62 * Allocate some dynamic memory from heap (3 areas). Check that areas
63 * don't overlap and that alignment constraints match. This test is
64 * done many times on different lcores simultaneously.
67 /* Test if memory overlaps: return 1 if true, or 0 if false. */
69 is_memory_overlap(void *p1, size_t len1, void *p2, size_t len2)
71 unsigned long ptr1 = (unsigned long)p1;
72 unsigned long ptr2 = (unsigned long)p2;
74 if (ptr2 >= ptr1 && (ptr2 - ptr1) < len1)
76 else if (ptr2 < ptr1 && (ptr1 - ptr2) < len2)
82 is_aligned(void *p, int align)
84 unsigned long addr = (unsigned long)p;
85 unsigned mask = align - 1;
93 test_align_overlap_per_lcore(__attribute__((unused)) void *arg)
95 const unsigned align1 = 8,
99 void *p1 = NULL, *p2 = NULL, *p3 = NULL;
102 for (i = 0; i < N; i++) {
103 p1 = rte_zmalloc("dummy", 1000, align1);
105 printf("rte_zmalloc returned NULL (i=%u)\n", i);
109 for(j = 0; j < 1000 ; j++) {
110 if( *(char *)p1 != 0) {
111 printf("rte_zmalloc didn't zero the allocated memory\n");
115 p2 = rte_malloc("dummy", 1000, align2);
117 printf("rte_malloc returned NULL (i=%u)\n", i);
122 p3 = rte_malloc("dummy", 1000, align3);
124 printf("rte_malloc returned NULL (i=%u)\n", i);
130 if (is_memory_overlap(p1, 1000, p2, 1000)) {
131 printf("p1 and p2 overlaps\n");
134 if (is_memory_overlap(p2, 1000, p3, 1000)) {
135 printf("p2 and p3 overlaps\n");
138 if (is_memory_overlap(p1, 1000, p3, 1000)) {
139 printf("p1 and p3 overlaps\n");
142 if (!is_aligned(p1, align1)) {
143 printf("p1 is not aligned\n");
146 if (!is_aligned(p2, align2)) {
147 printf("p2 is not aligned\n");
150 if (!is_aligned(p3, align3)) {
151 printf("p3 is not aligned\n");
158 rte_malloc_dump_stats(stdout, "dummy");
164 test_reordered_free_per_lcore(__attribute__((unused)) void *arg)
166 const unsigned align1 = 8,
173 for (i = 0; i < 30; i++) {
174 p1 = rte_zmalloc("dummy", 1000, align1);
176 printf("rte_zmalloc returned NULL (i=%u)\n", i);
180 for(j = 0; j < 1000 ; j++) {
181 if( *(char *)p1 != 0) {
182 printf("rte_zmalloc didn't zero the allocated memory\n");
186 /* use calloc to allocate 1000 16-byte items this time */
187 p2 = rte_calloc("dummy", 1000, 16, align2);
188 /* for third request use regular malloc again */
189 p3 = rte_malloc("dummy", 1000, align3);
191 printf("rte_malloc returned NULL (i=%u)\n", i);
195 if (is_memory_overlap(p1, 1000, p2, 1000)) {
196 printf("p1 and p2 overlaps\n");
199 if (is_memory_overlap(p2, 1000, p3, 1000)) {
200 printf("p2 and p3 overlaps\n");
203 if (is_memory_overlap(p1, 1000, p3, 1000)) {
204 printf("p1 and p3 overlaps\n");
207 if (!is_aligned(p1, align1)) {
208 printf("p1 is not aligned\n");
211 if (!is_aligned(p2, align2)) {
212 printf("p2 is not aligned\n");
215 if (!is_aligned(p3, align3)) {
216 printf("p3 is not aligned\n");
219 /* try freeing in every possible order */
253 rte_malloc_dump_stats(stdout, "dummy");
258 /* test function inside the malloc lib*/
260 test_str_to_size(void)
266 {{ "5G", (uint64_t)5 * 1024 * 1024 *1024 },
267 {"0x20g", (uint64_t)0x20 * 1024 * 1024 *1024},
268 {"10M", 10 * 1024 * 1024},
269 {"050m", 050 * 1024 * 1024},
275 {"-1", 0}, /* negative values return 0 */
278 {"18446744073709551616", 0} /* ULLONG_MAX + 1 == out of range*/
281 for (i = 0; i < sizeof(test_values)/sizeof(test_values[0]); i++)
282 if (rte_str_to_size(test_values[i].str) != test_values[i].value)
288 test_multi_alloc_statistics(void)
291 struct rte_malloc_socket_stats pre_stats, post_stats ,first_stats, second_stats;
294 #ifndef RTE_MALLOC_DEBUG
295 int trailer_size = 0;
297 int trailer_size = RTE_CACHE_LINE_SIZE;
299 int overhead = RTE_CACHE_LINE_SIZE + trailer_size;
301 rte_malloc_get_socket_stats(socket, &pre_stats);
303 void *p1 = rte_malloc_socket("stats", size , align, socket);
307 rte_malloc_dump_stats(stdout, "stats");
309 rte_malloc_get_socket_stats(socket,&post_stats);
310 /* Check statistics reported are correct */
311 /* All post stats should be equal to pre stats after alloc freed */
312 if ((post_stats.heap_totalsz_bytes != pre_stats.heap_totalsz_bytes) &&
313 (post_stats.heap_freesz_bytes!=pre_stats.heap_freesz_bytes) &&
314 (post_stats.heap_allocsz_bytes!=pre_stats.heap_allocsz_bytes)&&
315 (post_stats.alloc_count!=pre_stats.alloc_count)&&
316 (post_stats.free_count!=pre_stats.free_count)) {
317 printf("Malloc statistics are incorrect - freed alloc\n");
320 /* Check two consecutive allocations */
323 rte_malloc_get_socket_stats(socket,&pre_stats);
324 void *p2 = rte_malloc_socket("add", size ,align, socket);
327 rte_malloc_get_socket_stats(socket,&first_stats);
329 void *p3 = rte_malloc_socket("add2", size,align, socket);
333 rte_malloc_get_socket_stats(socket,&second_stats);
338 /* After freeing both allocations check stats return to original */
339 rte_malloc_get_socket_stats(socket, &post_stats);
341 if(second_stats.heap_totalsz_bytes != first_stats.heap_totalsz_bytes) {
342 printf("Incorrect heap statistics: Total size \n");
345 /* Check allocated size is equal to two additions plus overhead */
346 if(second_stats.heap_allocsz_bytes !=
347 size + overhead + first_stats.heap_allocsz_bytes) {
348 printf("Incorrect heap statistics: Allocated size \n");
351 /* Check that allocation count increments correctly i.e. +1 */
352 if (second_stats.alloc_count != first_stats.alloc_count + 1) {
353 printf("Incorrect heap statistics: Allocated count \n");
357 if (second_stats.free_count != first_stats.free_count){
358 printf("Incorrect heap statistics: Free count \n");
362 /* Make sure that we didn't touch our greatest chunk: 2 * 11M) */
363 if (post_stats.greatest_free_size != pre_stats.greatest_free_size) {
364 printf("Incorrect heap statistics: Greatest free size \n");
367 /* Free size must equal the original free size minus the new allocation*/
368 if (first_stats.heap_freesz_bytes <= second_stats.heap_freesz_bytes) {
369 printf("Incorrect heap statistics: Free size \n");
373 if ((post_stats.heap_totalsz_bytes != pre_stats.heap_totalsz_bytes) &&
374 (post_stats.heap_freesz_bytes!=pre_stats.heap_freesz_bytes) &&
375 (post_stats.heap_allocsz_bytes!=pre_stats.heap_allocsz_bytes)&&
376 (post_stats.alloc_count!=pre_stats.alloc_count)&&
377 (post_stats.free_count!=pre_stats.free_count)) {
378 printf("Malloc statistics are incorrect - freed alloc\n");
385 test_rte_malloc_type_limits(void)
387 /* The type-limits functionality is not yet implemented,
388 * so always return 0 no matter what the retval.
390 const char *typename = "limit_test";
391 rte_malloc_set_limit(typename, 64 * 1024);
392 rte_malloc_dump_stats(stdout, typename);
399 const char hello_str[] = "Hello, world!";
400 const unsigned size1 = 1024;
401 const unsigned size2 = size1 + 1024;
402 const unsigned size3 = size2;
403 const unsigned size4 = size3 + 1024;
405 /* test data is the same even if element is moved*/
406 char *ptr1 = rte_zmalloc(NULL, size1, RTE_CACHE_LINE_SIZE);
408 printf("NULL pointer returned from rte_zmalloc\n");
411 snprintf(ptr1, size1, "%s" ,hello_str);
412 char *ptr2 = rte_realloc(ptr1, size2, RTE_CACHE_LINE_SIZE);
415 printf("NULL pointer returned from rte_realloc\n");
419 printf("unexpected - ptr1 == ptr2\n");
421 if (strcmp(ptr2, hello_str) != 0){
422 printf("Error - lost data from pointed area\n");
427 for (i = strnlen(hello_str, sizeof(hello_str)); i < size1; i++)
429 printf("Bad data in realloc\n");
433 /* now allocate third element, free the second
434 * and resize third. It should not move. (ptr1 is now invalid)
436 char *ptr3 = rte_zmalloc(NULL, size3, RTE_CACHE_LINE_SIZE);
438 printf("NULL pointer returned from rte_zmalloc\n");
442 for (i = 0; i < size3; i++)
444 printf("Bad data in zmalloc\n");
450 /* first resize to half the size of the freed block */
451 char *ptr4 = rte_realloc(ptr3, size4, RTE_CACHE_LINE_SIZE);
453 printf("NULL pointer returned from rte_realloc\n");
458 printf("Unexpected - ptr4 != ptr3\n");
462 /* now resize again to the full size of the freed block */
463 ptr4 = rte_realloc(ptr3, size3 + size2 + size1, RTE_CACHE_LINE_SIZE);
465 printf("Unexpected - ptr4 != ptr3 on second resize\n");
471 /* now try a resize to a smaller size, see if it works */
472 const unsigned size5 = 1024;
473 const unsigned size6 = size5 / 2;
474 char *ptr5 = rte_malloc(NULL, size5, RTE_CACHE_LINE_SIZE);
476 printf("NULL pointer returned from rte_malloc\n");
479 char *ptr6 = rte_realloc(ptr5, size6, RTE_CACHE_LINE_SIZE);
481 printf("NULL pointer returned from rte_realloc\n");
486 printf("Error, resizing to a smaller size moved data\n");
492 /* check for behaviour changing alignment */
493 const unsigned size7 = 1024;
494 const unsigned orig_align = RTE_CACHE_LINE_SIZE;
495 unsigned new_align = RTE_CACHE_LINE_SIZE * 2;
496 char *ptr7 = rte_malloc(NULL, size7, orig_align);
498 printf("NULL pointer returned from rte_malloc\n");
501 /* calc an alignment we don't already have */
502 while(RTE_PTR_ALIGN(ptr7, new_align) == ptr7)
504 char *ptr8 = rte_realloc(ptr7, size7, new_align);
506 printf("NULL pointer returned from rte_realloc\n");
510 if (RTE_PTR_ALIGN(ptr8, new_align) != ptr8){
511 printf("Failure to re-align data\n");
517 /* test behaviour when there is a free block after current one,
518 * but its not big enough
520 unsigned size9 = 1024, size10 = 1024;
521 unsigned size11 = size9 + size10 + 256;
522 char *ptr9 = rte_malloc(NULL, size9, RTE_CACHE_LINE_SIZE);
524 printf("NULL pointer returned from rte_malloc\n");
527 char *ptr10 = rte_malloc(NULL, size10, RTE_CACHE_LINE_SIZE);
529 printf("NULL pointer returned from rte_malloc\n");
533 char *ptr11 = rte_realloc(ptr10, size11, RTE_CACHE_LINE_SIZE);
535 printf("NULL pointer returned from rte_realloc\n");
540 printf("Error, unexpected that realloc has not created new buffer\n");
546 /* check we don't crash if we pass null to realloc
547 * We should get a malloc of the size requested*/
548 const size_t size12 = 1024;
550 char *ptr12 = rte_realloc(NULL, size12, RTE_CACHE_LINE_SIZE);
552 printf("NULL pointer returned from rte_realloc\n");
555 if (rte_malloc_validate(ptr12, &size12_check) < 0 ||
556 size12_check != size12){
565 test_random_alloc_free(void *_ __attribute__((unused)))
568 struct mem_list *next;
574 rte_srand((unsigned)rte_rdtsc());
576 for (i = 0; i < N; i++){
577 unsigned free_mem = 0;
578 size_t allocated_size;
580 const unsigned mem_size = sizeof(struct mem_list) + \
581 rte_rand() % (64 * 1024);
582 const unsigned align = 1 << (rte_rand() % 12); /* up to 4k alignment */
583 struct mem_list *entry = rte_malloc(NULL,
587 if (RTE_PTR_ALIGN(entry, align)!= entry)
589 if (rte_malloc_validate(entry, &allocated_size) == -1
590 || allocated_size < mem_size)
592 memset(entry->data, rte_lcore_id(),
593 mem_size - sizeof(*entry));
594 entry->next = list_head;
595 if (rte_malloc_validate(entry, NULL) == -1)
600 /* switch to freeing the memory with a 20% probability */
601 free_mem = ((rte_rand() % 10) >= 8);
604 struct mem_list *entry = list_head;
605 list_head = list_head->next;
609 printf("Lcore %u allocated/freed %u blocks\n", rte_lcore_id(), count);
613 #define err_return() do { \
614 printf("%s: %d - Error\n", __func__, __LINE__); \
619 test_rte_malloc_validate(void)
621 const size_t request_size = 1024;
622 size_t allocated_size;
623 char *data_ptr = rte_malloc(NULL, request_size, RTE_CACHE_LINE_SIZE);
624 #ifdef RTE_MALLOC_DEBUG
626 char *over_write_vals = NULL;
629 if (data_ptr == NULL) {
630 printf("%s: %d - Allocation error\n", __func__, __LINE__);
634 /* check that a null input returns -1 */
635 if (rte_malloc_validate(NULL, NULL) != -1)
638 /* check that we get ok on a valid pointer */
639 if (rte_malloc_validate(data_ptr, &allocated_size) < 0)
642 /* check that the returned size is ok */
643 if (allocated_size < request_size)
646 #ifdef RTE_MALLOC_DEBUG
648 /****** change the header to be bad */
650 over_write_vals = (char *)((uintptr_t)data_ptr - sizeof(save_buf));
651 /* first save the data as a backup before overwriting it */
652 memcpy(save_buf, over_write_vals, sizeof(save_buf));
653 memset(over_write_vals, 1, sizeof(save_buf));
654 /* then run validate */
655 retval = rte_malloc_validate(data_ptr, NULL);
656 /* finally restore the data again */
657 memcpy(over_write_vals, save_buf, sizeof(save_buf));
658 /* check we previously had an error */
662 /* check all ok again */
663 if (rte_malloc_validate(data_ptr, &allocated_size) < 0)
666 /**** change the trailer to be bad */
667 over_write_vals = (char *)((uintptr_t)data_ptr + allocated_size);
668 /* first save the data as a backup before overwriting it */
669 memcpy(save_buf, over_write_vals, sizeof(save_buf));
670 memset(over_write_vals, 1, sizeof(save_buf));
671 /* then run validate */
672 retval = rte_malloc_validate(data_ptr, NULL);
673 /* finally restore the data again */
674 memcpy(over_write_vals, save_buf, sizeof(save_buf));
678 /* check all ok again */
679 if (rte_malloc_validate(data_ptr, &allocated_size) < 0)
693 test_zero_aligned_alloc(void)
695 char *p1 = rte_malloc(NULL,1024, 0);
698 if (!rte_is_aligned(p1, RTE_CACHE_LINE_SIZE))
705 if (p1) rte_free(p1);
710 test_malloc_bad_params(void)
712 const char *type = NULL;
714 unsigned align = RTE_CACHE_LINE_SIZE;
716 /* rte_malloc expected to return null with inappropriate size */
717 char *bad_ptr = rte_malloc(type, size, align);
721 /* rte_malloc expected to return null with inappropriate alignment */
725 bad_ptr = rte_malloc(type, size, align);
732 /* clean up pointer */
738 /* Check if memory is available on a specific socket */
740 is_mem_on_socket(int32_t socket)
742 const struct rte_memseg *ms = rte_eal_get_physmem_layout();
745 for (i = 0; i < RTE_MAX_MEMSEG; i++) {
746 if (socket == ms[i].socket_id)
753 * Find what socket a memory address is on. Only works for addresses within
754 * memsegs, not heap or stack...
757 addr_to_socket(void * addr)
759 const struct rte_memseg *ms = rte_eal_get_physmem_layout();
762 for (i = 0; i < RTE_MAX_MEMSEG; i++) {
763 if ((ms[i].addr <= addr) &&
765 ((uintptr_t)ms[i].addr + (uintptr_t)ms[i].len)))
766 return ms[i].socket_id;
771 /* Test using rte_[c|m|zm]alloc_socket() on a specific socket */
773 test_alloc_single_socket(int32_t socket)
775 const char *type = NULL;
776 const size_t size = 10;
777 const unsigned align = 0;
779 int32_t desired_socket = (socket == SOCKET_ID_ANY) ?
780 (int32_t)rte_socket_id() : socket;
782 /* Test rte_calloc_socket() */
783 mem = rte_calloc_socket(type, size, sizeof(char), align, socket);
786 if (addr_to_socket(mem) != desired_socket) {
792 /* Test rte_malloc_socket() */
793 mem = rte_malloc_socket(type, size, align, socket);
796 if (addr_to_socket(mem) != desired_socket) {
801 /* Test rte_zmalloc_socket() */
802 mem = rte_zmalloc_socket(type, size, align, socket);
805 if (addr_to_socket(mem) != desired_socket) {
815 test_alloc_socket(void)
817 unsigned socket_count = 0;
820 if (test_alloc_single_socket(SOCKET_ID_ANY) < 0)
823 for (i = 0; i < RTE_MAX_NUMA_NODES; i++) {
824 if (is_mem_on_socket(i)) {
826 if (test_alloc_single_socket(i) < 0) {
827 printf("Fail: rte_malloc_socket(..., %u) did not succeed\n",
833 if (test_alloc_single_socket(i) == 0) {
834 printf("Fail: rte_malloc_socket(..., %u) succeeded\n",
841 /* Print warnign if only a single socket, but don't fail the test */
842 if (socket_count < 2) {
843 printf("WARNING: alloc_socket test needs memory on multiple sockets!\n");
855 if (test_str_to_size() < 0){
856 printf("test_str_to_size() failed\n");
859 else printf("test_str_to_size() passed\n");
861 if (test_zero_aligned_alloc() < 0){
862 printf("test_zero_aligned_alloc() failed\n");
865 else printf("test_zero_aligned_alloc() passed\n");
867 if (test_malloc_bad_params() < 0){
868 printf("test_malloc_bad_params() failed\n");
871 else printf("test_malloc_bad_params() passed\n");
873 if (test_realloc() < 0){
874 printf("test_realloc() failed\n");
877 else printf("test_realloc() passed\n");
879 /*----------------------------*/
880 RTE_LCORE_FOREACH_SLAVE(lcore_id) {
881 rte_eal_remote_launch(test_align_overlap_per_lcore, NULL, lcore_id);
884 RTE_LCORE_FOREACH_SLAVE(lcore_id) {
885 if (rte_eal_wait_lcore(lcore_id) < 0)
889 printf("test_align_overlap_per_lcore() failed\n");
892 else printf("test_align_overlap_per_lcore() passed\n");
894 /*----------------------------*/
895 RTE_LCORE_FOREACH_SLAVE(lcore_id) {
896 rte_eal_remote_launch(test_reordered_free_per_lcore, NULL, lcore_id);
899 RTE_LCORE_FOREACH_SLAVE(lcore_id) {
900 if (rte_eal_wait_lcore(lcore_id) < 0)
904 printf("test_reordered_free_per_lcore() failed\n");
907 else printf("test_reordered_free_per_lcore() passed\n");
909 /*----------------------------*/
910 RTE_LCORE_FOREACH_SLAVE(lcore_id) {
911 rte_eal_remote_launch(test_random_alloc_free, NULL, lcore_id);
914 RTE_LCORE_FOREACH_SLAVE(lcore_id) {
915 if (rte_eal_wait_lcore(lcore_id) < 0)
919 printf("test_random_alloc_free() failed\n");
922 else printf("test_random_alloc_free() passed\n");
924 /*----------------------------*/
925 ret = test_rte_malloc_type_limits();
927 printf("test_rte_malloc_type_limits() failed\n");
930 /* TODO: uncomment following line once type limits are valid */
931 /*else printf("test_rte_malloc_type_limits() passed\n");*/
933 /*----------------------------*/
934 ret = test_rte_malloc_validate();
936 printf("test_rte_malloc_validate() failed\n");
939 else printf("test_rte_malloc_validate() passed\n");
941 ret = test_alloc_socket();
943 printf("test_alloc_socket() failed\n");
946 else printf("test_alloc_socket() passed\n");
948 ret = test_multi_alloc_statistics();
950 printf("test_multi_alloc_statistics() failed\n");
954 printf("test_multi_alloc_statistics() passed\n");
959 REGISTER_TEST_COMMAND(malloc_autotest, test_malloc);