heap_1: reject configTOTAL_HEAP_SIZE <= portBYTE_ALIGNMENT at compile time

Defect: pvPortMalloc() in heap_1.c can return a pointer outside the ucHeap
array when configTOTAL_HEAP_SIZE is configured smaller than or equal to
portBYTE_ALIGNMENT.

Root cause: configADJUSTED_HEAP_SIZE is defined as
( configTOTAL_HEAP_SIZE - portBYTE_ALIGNMENT ). When configTOTAL_HEAP_SIZE is
not larger than portBYTE_ALIGNMENT this unsigned subtraction underflows to a
very large size_t value. The "enough room left" check in pvPortMalloc()
compares an unsigned index against configADJUSTED_HEAP_SIZE, so the underflowed
value defeats the check and an allocation can be handed out past the end of the
heap array.

Fix: add a compile-time (compiler, not preprocessor) size check so a
nonsensical, too-small heap is rejected during the build. The compiler-level
check still works when configTOTAL_HEAP_SIZE is defined with a cast such as
( ( size_t ) 0x2000 ).

A host regression test kept outside this repository demonstrates the fault
before the change and its absence afterwards (red then green).
This commit is contained in:
AniruddhaKanhere 2026-07-07 21:45:29 -07:00
parent ae46383c90
commit 2345ff7c88

View file

@ -53,6 +53,17 @@
/* A few bytes might be lost to byte aligning the heap start address. */
#define configADJUSTED_HEAP_SIZE ( configTOTAL_HEAP_SIZE - portBYTE_ALIGNMENT )
/* configTOTAL_HEAP_SIZE must be larger than portBYTE_ALIGNMENT, otherwise the
* configADJUSTED_HEAP_SIZE subtraction above underflows. The "enough room left"
* check in pvPortMalloc() compares an unsigned size_t index against
* configADJUSTED_HEAP_SIZE, so an underflowed (very large) value silently
* defeats that check and pvPortMalloc() can return a pointer outside the ucHeap
* array. Reject such a nonsensical, too-small heap at compile time. This is a
* compiler (not preprocessor) check so that it still works when
* configTOTAL_HEAP_SIZE is defined with a cast, e.g. ( ( size_t ) 0x2000 ). */
typedef char heapCHECK_configTOTAL_HEAP_SIZE_EXCEEDS_portBYTE_ALIGNMENT
[ ( ( configTOTAL_HEAP_SIZE ) > ( portBYTE_ALIGNMENT ) ) ? 1 : -1 ];
/* Max value that fits in a size_t type. */
#define heapSIZE_MAX ( ~( ( size_t ) 0 ) )