feedc0de/esp-idf
1
0
Fork 0
forked from espressif/esp-idf
Code Pull Requests Activity

Merge branch 'feature/heap-fix-ignored-tests' into 'master'

Browse Source 
heap: add all 'ignore' tests to pytest framework

See merge request espressif/esp-idf!20478
This commit is contained in:
Guillaume Souchere
2022-10-06 16:25:18 +08:00
parent a6792c2673 2b5a844640
commit cc545fbf9a
5 changed files with 42 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
components/heap/heap_caps_init.c
View File

@@ -189,14 +189,14 @@ bool heap_caps_check_add_region_allowed(intptr_t heap_start, intptr_t heap_end,
* 3.add region (s3>=s && e3<e) |---------------| correct: bool condition_3 = start >= heap_start && end < heap_end;
* |--------------| correct
*
* 4.add region (s4<e && e4>e) |------------------------| wrong: bool condition_4 = start < heap_end && end > heap_end;
* 4.add region (s4<e && e4>=e) |------------------------| wrong: bool condition_4 = start < heap_end && end >= heap_end;
* |---------------------| wrong
*
* 5.add region (s5>=e) |----| correct: bool condition_5 = start >= heap_end;
*/
bool condition_2 = start < heap_start && end > heap_start; // if true then region not allowed
bool condition_4 = start < heap_end && end > heap_end; // if true then region not allowed
bool condition_4 = start < heap_end && end >= heap_end; // if true then region not allowed
return (condition_2 || condition_4) ? false: true;
}

2
components/heap/test_apps/main/CMakeLists.txt
View File

@@ -1,4 +1,4 @@
set(src_test "test_app_main.c"
set(src_test "test_heap_main.c"
"test_aligned_alloc_caps.c"
"test_allocator_timings.c"
"test_corruption_check.c"

11
components/heap/test_apps/main/test_app_main.c → components/heap/test_apps/main/test_heap_main.c
View File

@@ -8,7 +8,12 @@
#include "unity_test_runner.h"
#include "esp_heap_caps.h"
#define TEST_MEMORY_LEAK_THRESHOLD (-1024)
#define TEST_MEMORY_LEAK_THRESHOLD_DEFAULT -100
static int leak_threshold = TEST_MEMORY_LEAK_THRESHOLD_DEFAULT;
void set_leak_threshold(int threshold)
{
leak_threshold = threshold;
}
static size_t before_free_8bit;
static size_t before_free_32bit;
@@ -17,7 +22,7 @@ static void check_leak(size_t before_free, size_t after_free, const char *type)
{
ssize_t delta = after_free - before_free;
printf("MALLOC_CAP_%s: Before %u bytes free, After %u bytes free (delta %d)\n", type, before_free, after_free, delta);
TEST_ASSERT_MESSAGE(delta >= TEST_MEMORY_LEAK_THRESHOLD, "memory leak");
TEST_ASSERT_MESSAGE(delta >= leak_threshold, "memory leak");
}
void setUp(void)
@@ -32,6 +37,8 @@ void tearDown(void)
size_t after_free_32bit = heap_caps_get_free_size(MALLOC_CAP_32BIT);
check_leak(before_free_8bit, after_free_8bit, "8BIT");
check_leak(before_free_32bit, after_free_32bit, "32BIT");
leak_threshold = TEST_MEMORY_LEAK_THRESHOLD_DEFAULT;
}
void app_main(void)

42
components/heap/test_apps/main/test_runtime_heap_reg.c
View File

@@ -15,13 +15,20 @@
#include "esp_system.h"
#include "heap_memory_layout.h"
#include "../tlsf/tlsf.h"
extern void set_leak_threshold(int threshold);
/* NOTE: This is not a well-formed unit test, it leaks memory */
TEST_CASE("Allocate new heap at runtime", "[heap][ignore]")
TEST_CASE("Allocate new heap at runtime", "[heap]")
{
const size_t BUF_SZ = 1000;
const size_t HEAP_OVERHEAD_MAX = 200;
// 84 bytes of overhead to account for multi_heap structs and eventual
// poisoning bytes + size of control_t from tlsf
const size_t HEAP_OVERHEAD_MAX = tlsf_size() + 84;
const size_t MIN_HEAP_SIZE = HEAP_OVERHEAD_MAX + tlsf_block_size_min();
const size_t BUF_SZ = MIN_HEAP_SIZE;
void *buffer = malloc(BUF_SZ);
TEST_ASSERT_NOT_NULL(buffer);
uint32_t before_free = esp_get_free_heap_size();
TEST_ESP_OK( heap_caps_add_region((intptr_t)buffer, (intptr_t)buffer + BUF_SZ) );
@@ -29,19 +36,23 @@ TEST_CASE("Allocate new heap at runtime", "[heap][ignore]")
printf("Before %"PRIu32" after %"PRIu32"\n", before_free, after_free);
/* allow for some 'heap overhead' from accounting structures */
TEST_ASSERT(after_free >= before_free + BUF_SZ - HEAP_OVERHEAD_MAX);
// set the leak threshold to a bigger value as this test leaks memory
set_leak_threshold(-3000);
}
/* NOTE: This is not a well-formed unit test, it leaks memory and
may fail if run twice in a row without a reset.
*/
TEST_CASE("Allocate new heap with new capability", "[heap][ignore]")
TEST_CASE("Allocate new heap with new capability", "[heap]")
{
const size_t BUF_SZ = 100;
#ifdef CONFIG_ESP_SYSTEM_MEMPROT_FEATURE
const size_t ALLOC_SZ = 32;
#else
const size_t ALLOC_SZ = 64; // More than half of BUF_SZ
#endif
// 84 bytes of overhead to account for multi_heap structs and eventual
// poisoning bytes + size of control_t from tlsf
const size_t HEAP_OVERHEAD = tlsf_size() + 84;
const size_t MIN_HEAP_SIZE = HEAP_OVERHEAD + tlsf_block_size_min();
const size_t BUF_SZ = MIN_HEAP_SIZE;
const size_t ALLOC_SZ = tlsf_block_size_min();
const uint32_t MALLOC_CAP_INVENTED = (1 << 30); /* this must be unused in esp_heap_caps.h */
/* no memory exists to provide this capability */
@@ -54,16 +65,19 @@ TEST_CASE("Allocate new heap with new capability", "[heap][ignore]")
/* ta-da, it's now possible! */
TEST_ASSERT_NOT_NULL( heap_caps_malloc(ALLOC_SZ, MALLOC_CAP_INVENTED) );
// set the leak threshold to a bigger value as this test leaks memory
set_leak_threshold(-3000);
}
/* NOTE: This is not a well-formed unit test.
* If run twice without a reset, it will failed.
*/
TEST_CASE("Add .bss memory to heap region runtime", "[heap][ignore]")
TEST_CASE("Add .bss memory to heap region runtime", "[heap]")
{
#define BUF_SZ 1000
#define HEAP_OVERHEAD_MAX 200
#define HEAP_OVERHEAD_MAX 3248
#define BUF_SZ 3260
static uint8_t s_buffer[BUF_SZ];
printf("s_buffer start %08x end %08x\n", (intptr_t)s_buffer, (intptr_t)s_buffer + BUF_SZ);
@@ -87,10 +101,10 @@ TEST_CASE("Add heap region address range checks", "[heap]")
TEST_ASSERT_TRUE(heap_caps_check_add_region_allowed(heap_start, heap_end, 0x0, 0x1000));
TEST_ASSERT_TRUE(heap_caps_check_add_region_allowed(heap_start, heap_end, 0x1000, 0x2000));
TEST_ASSERT_TRUE(heap_caps_check_add_region_allowed(heap_start, heap_end, 0x1000, 0x3000));
TEST_ASSERT_TRUE(heap_caps_check_add_region_allowed(heap_start, heap_end, 0x3000, 0x4000));
TEST_ASSERT_FALSE(heap_caps_check_add_region_allowed(heap_start, heap_end, 0x0, 0x2000));
TEST_ASSERT_FALSE(heap_caps_check_add_region_allowed(heap_start, heap_end, 0x0, 0x4000));
TEST_ASSERT_FALSE(heap_caps_check_add_region_allowed(heap_start, heap_end, 0x1000, 0x4000));
TEST_ASSERT_FALSE(heap_caps_check_add_region_allowed(heap_start, heap_end, 0x2000, 0x4000));
TEST_ASSERT_FALSE(heap_caps_check_add_region_allowed(heap_start, heap_end, 0x1000, 0x3000));
}

4
components/heap/test_apps/pytest_heap.py
View File

@@ -17,7 +17,7 @@ from pytest_embedded import Dut
)
def test_heap_poisoning(dut: Dut) -> None:
dut.expect_exact('Press ENTER to see the list of tests')
dut.write('![ignore]')
dut.write('*')
dut.expect_unity_test_output(timeout=300)
@@ -34,7 +34,7 @@ def test_heap_poisoning(dut: Dut) -> None:
)
def test_heap(dut: Dut) -> None:
dut.expect_exact('Press ENTER to see the list of tests')
dut.write('![ignore]')
dut.write('*')
dut.expect_unity_test_output(timeout=300)