alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2025-08-10 04:43:33 +00:00
Code Issues Packages Projects Releases Wiki Activity

feat(heap): Add return value to walker callback

Browse Source 
This return value is used by the tlsf_walk_pool
function to be notified of the need to interrupt
the ongoing traversal of the currently traversed
heap.
This commit is contained in:
Guillaume Souchere
2024-02-27 12:32:15 +01:00
parent 5cc69ce12b
commit 34fb83ffbc
6 changed files with 77 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

67
components/heap/test_apps/heap_tests/main/test_walker.c
View File

@@ -7,25 +7,39 @@
#include "stdio.h"
#include "esp_heap_caps.h"
#include "esp_rom_sys.h"
#define PASS_CODE 0x9876BAAB
#define ALLOC_SIZE 16
static bool block_found = false;
static void heap_walker(walker_heap_into_t heap_info, walker_block_info_t block_info, void* user_data)
static void calculate_block_metadata_size(size_t *header, size_t *footer)
{
*header = 0;
*footer = 0;
#if !CONFIG_HEAP_POISONING_DISABLED
*header += 8; // sizeof(poison_head_t)
*footer += 4; // sizeof(poison_tail_t)
#endif
#if CONFIG_HEAP_TASK_TRACKING
*header += 4; // sizeof(TaskHandle_t)
#endif
}
static bool block_found = false;
static bool heap_corrupted = false;
static bool heap_walker(walker_heap_into_t heap_info, walker_block_info_t block_info, void* user_data)
{
if ((intptr_t)heap_info.end - (intptr_t)block_info.ptr < block_info.size)
{
heap_corrupted = true;
return false;
}
TEST_ASSERT(*(uint32_t*)user_data == PASS_CODE);
TEST_ASSERT_NOT_NULL(block_info.ptr);
uint32_t metadata_size_head = 0;
uint32_t metadata_size_tail = 0;
#if !CONFIG_HEAP_POISONING_DISABLED
metadata_size_head += 8; // sizeof(poison_head_t)
metadata_size_tail += 4; // sizeof(poison_tail_t)
#endif
#if CONFIG_HEAP_TASK_TRACKING
metadata_size_head += 4; // sizeof(TaskHandle_t)
#endif
size_t metadata_size_head = 0;
size_t metadata_size_tail = 0;
calculate_block_metadata_size(&metadata_size_head, &metadata_size_tail);
/* look for the first 4 bytes pass code to identify the memory allocated in the test */
const uint32_t pass_code = *((uint32_t*)block_info.ptr + (metadata_size_head / sizeof(uint32_t)));
@@ -34,9 +48,14 @@ static void heap_walker(walker_heap_into_t heap_info, walker_block_info_t block_
TEST_ASSERT_TRUE(block_info.used);
block_found = true;
}
return true;
}
/* This test assures the proper functioning of heap_caps_walk and heap_caps_walk_all
* when a corruption occurs in a random heap. The callback which detects the corruption
* returns false to the walker which should result in the interruption of the heap traversal
* by the walker instead of a crash.
*/
TEST_CASE("heap walker", "[heap]")
{
@@ -53,3 +72,27 @@ TEST_CASE("heap walker", "[heap]")
heap_caps_walk_all(heap_walker, &user_code);
TEST_ASSERT_TRUE(block_found);
}
/* This test assures the proper functioning of heap_caps_walk and heap_caps_walk_all
*/
TEST_CASE("heap walker corrupted heap detection", "[heap]")
{
/* Allocate memory using the MALLOC_CAP_DEFAULT capability */
void *default_ptr = heap_caps_malloc(ALLOC_SIZE, MALLOC_CAP_DEFAULT);
TEST_ASSERT_NOT_NULL(default_ptr);
size_t metadata_size_head = 0;
size_t metadata_size_tail = 0;
calculate_block_metadata_size(&metadata_size_head, &metadata_size_tail);
(void)metadata_size_tail;
*((uint32_t*)default_ptr - (metadata_size_head / 4) - 1) = 0xFF000000;
/* Write the pass code in the first word of the allocated memory */
*((uint32_t*)default_ptr) = (uint32_t)PASS_CODE;
/* call the heap_caps_walker to make sure the hook function is triggered
* and check that the allocated memory is found while walking the heap */
uint32_t user_code = PASS_CODE;
heap_caps_walk_all(heap_walker, &user_code);
TEST_ASSERT_TRUE(heap_corrupted);
}