diff options
author | sebastian.huber <sebastian.huber@ad346e48-6743-2946-b04c-964484d2d4e6> | 2019-10-25 13:19:01 +0000 |
---|---|---|
committer | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2019-11-05 07:29:00 +0100 |
commit | 3859cd63afb4cb5f76d125e80f968497478d553f (patch) | |
tree | 642d9c6e78f2fa8dcb1d027496cfb9ca1c710d49 /cpukit/include/rtems/score | |
parent | bsps/arm: Add support for small pages MMU (diff) | |
download | rtems-3859cd63afb4cb5f76d125e80f968497478d553f.tar.bz2 |
rtems-5: Improve heap fatal error information
Update #3806.
Diffstat (limited to 'cpukit/include/rtems/score')
-rw-r--r-- | cpukit/include/rtems/score/heap.h | 64 | ||||
-rw-r--r-- | cpukit/include/rtems/score/heapimpl.h | 7 | ||||
-rw-r--r-- | cpukit/include/rtems/score/interr.h | 7 |
3 files changed, 74 insertions, 4 deletions
diff --git a/cpukit/include/rtems/score/heap.h b/cpukit/include/rtems/score/heap.h index 668a0b7d01..4b620b2715 100644 --- a/cpukit/include/rtems/score/heap.h +++ b/cpukit/include/rtems/score/heap.h @@ -134,6 +134,62 @@ typedef struct Heap_Control Heap_Control; typedef struct Heap_Block Heap_Block; +/** + * @brief The heap error reason. + * + * @see _Heap_Protection_block_error(). + */ +typedef enum { + /** + * @brief There is an unexpected value in the heap block protector area. + */ + HEAP_ERROR_BROKEN_PROTECTOR, + + /** + * @brief There is an unexpected value in the free pattern of a free heap + * block. + */ + HEAP_ERROR_FREE_PATTERN, + + /** + * @brief There is was an attempt to free the same block twice. + */ + HEAP_ERROR_DOUBLE_FREE, + + /** + * @brief The next block of a supposed to be used block does not indicate that + * the block is used. + */ + HEAP_ERROR_BAD_USED_BLOCK, + + /** + * @brief A supposed to be free block is not inside the heap memory area. + */ + HEAP_ERROR_BAD_FREE_BLOCK +} Heap_Error_reason; + +/** + * @brief Context of a heap error. + * + * @see _Heap_Protection_block_error(). + */ +typedef struct { + /** + * @brief The heap of the block. + */ + Heap_Control *heap; + + /** + * @brief The heap block causing the error. + */ + Heap_Block *block; + + /** + * @brief The heap error reason. + */ + Heap_Error_reason reason; +} Heap_Error_context; + #ifndef HEAP_PROTECTION #define HEAP_PROTECTION_HEADER_SIZE 0 #else @@ -153,10 +209,16 @@ typedef struct Heap_Block Heap_Block; Heap_Block *block ); + typedef void (*_Heap_Protection_error_handler)( + Heap_Control *heap, + Heap_Block *block, + Heap_Error_reason reason + ); + typedef struct { _Heap_Protection_handler block_initialize; _Heap_Protection_handler block_check; - _Heap_Protection_handler block_error; + _Heap_Protection_error_handler block_error; void *handler_data; Heap_Block *first_delayed_free_block; Heap_Block *last_delayed_free_block; diff --git a/cpukit/include/rtems/score/heapimpl.h b/cpukit/include/rtems/score/heapimpl.h index cd213ec2d8..d3ee0ff88a 100644 --- a/cpukit/include/rtems/score/heapimpl.h +++ b/cpukit/include/rtems/score/heapimpl.h @@ -379,7 +379,7 @@ Heap_Block *_Heap_Block_allocate( #ifndef HEAP_PROTECTION #define _Heap_Protection_block_initialize( heap, block ) ((void) 0) #define _Heap_Protection_block_check( heap, block ) ((void) 0) - #define _Heap_Protection_block_error( heap, block ) ((void) 0) + #define _Heap_Protection_block_error( heap, block, reason ) ((void) 0) #define _Heap_Protection_free_all_delayed_blocks( heap ) ((void) 0) #else static inline void _Heap_Protection_block_initialize( @@ -400,10 +400,11 @@ Heap_Block *_Heap_Block_allocate( static inline void _Heap_Protection_block_error( Heap_Control *heap, - Heap_Block *block + Heap_Block *block, + Heap_Error_reason reason ) { - (*heap->Protection.block_error)( heap, block ); + (*heap->Protection.block_error)( heap, block, reason ); } static inline void _Heap_Protection_free_all_delayed_blocks( Heap_Control *heap ) diff --git a/cpukit/include/rtems/score/interr.h b/cpukit/include/rtems/score/interr.h index 73b3b077e3..544ad7ab9e 100644 --- a/cpukit/include/rtems/score/interr.h +++ b/cpukit/include/rtems/score/interr.h @@ -140,6 +140,13 @@ typedef enum { RTEMS_FATAL_SOURCE_INVALID_HEAP_FREE = 12, /** + * @brief Fatal source for heap errors. + * + * The fatal code is the address to a heap error context (Heap_Error_context). + */ + RTEMS_FATAL_SOURCE_HEAP = 13, + + /** * @brief The last available fatal source. * * This enum value ensures that the enum type needs at least 32-bits for |