esp-idf/components/heap/test/test_corruption_check.c
Omar Chebib 2e897c2e74 TLSF: fix the patch for tlsf_check function in ROM
tlsf_check in the patch was not called because the the TLSF functions
table in ROM was still pointing to the ROM implementation.
2022-09-13 14:20:39 +02:00

69 lines
2.4 KiB
C

/*
* SPDX-FileCopyrightText: 2022 Espressif Systems (Shanghai) CO LTD
*
* SPDX-License-Identifier: Unlicense OR CC0-1.0
*/
#include "unity.h"
#include "stdio.h"
#include "esp_heap_caps.h"
/* executing multi_heap_internal_check_block_poisoning()
* takes longer on external RAM and therefore the timeout
* in the test of 30 seconds is exceeded. Execute the test
* on a smaller memory chunk
*/
#ifdef CONFIG_SPIRAM
const size_t MALLOC_SIZE = 16;
#else
const size_t MALLOC_SIZE = 64;
#endif
const uint8_t CORRUPTED_VALUE = 0xaa;
/* This test will corrupt the memory of a free block in the heap and check
* that in the case of comprehensive poisoning the heap corruption is detected
* by heap_caps_check_integrity(). For light poisoning and no poisoning, the test will
* check that heap_caps_check_integrity() does not report the corruption.
*/
TEST_CASE("multi_heap poisoning detection", "[heap]")
{
/* malloc some memory to get a pointer */
uint8_t *ptr = heap_caps_malloc(MALLOC_SIZE, MALLOC_CAP_8BIT);
/* free the memory to free the block but keep the pointer in mind */
heap_caps_free(ptr);
/* variable used in the test */
uint8_t original_value = 0x00;
for (size_t i = 0; i < MALLOC_SIZE; i++)
{
/* keep the good value in store in order to check that when we set the byte back
* to its original value, heap_caps_check_integrity() no longer returns the
* heap corruption. */
original_value = ptr[i];
/* set corrupted value in the free memory*/
ptr[i] = CORRUPTED_VALUE;
bool is_heap_ok = heap_caps_check_integrity(MALLOC_CAP_8BIT, true);
/* fix the corruption by restoring the original value at ptr + i.
* We need to do this before the ASSERT because they may print a message.
* Using print allocates memory on the heap, so the heap has to be fixed. */
ptr[i] = original_value;
#if CONFIG_HEAP_POISONING_COMPREHENSIVE
/* check that heap_caps_check_integrity() detects the corruption */
TEST_ASSERT_FALSE(is_heap_ok);
#else
/* the comprehensive corruption is not checked in the heap_caps_check_integrity() */
TEST_ASSERT_TRUE(is_heap_ok);
#endif
/* check that heap_caps_check_integrity() stops reporting the corruption */
is_heap_ok = heap_caps_check_integrity(MALLOC_CAP_8BIT, true);
TEST_ASSERT_TRUE(is_heap_ok);
}
}