begriffs open source - freertos/blob - include/stack_macros.h

   1 /*
   2  * FreeRTOS Kernel V10.4.3
   3  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
   4  *
   5  * Permission is hereby granted, free of charge, to any person obtaining a copy of
   6  * this software and associated documentation files (the "Software"), to deal in
   7  * the Software without restriction, including without limitation the rights to
   8  * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
   9  * the Software, and to permit persons to whom the Software is furnished to do so,
  10  * subject to the following conditions:
  11  *
  12  * The above copyright notice and this permission notice shall be included in all
  13  * copies or substantial portions of the Software.
  14  *
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
  17  * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
  18  * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
  19  * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  20  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  21  *
  22  * https://www.FreeRTOS.org
  23  * https://github.com/FreeRTOS
  24  *
  25  */
  26
  27 #ifndef STACK_MACROS_H
  28 #define STACK_MACROS_H
  29
  30 /*
  31  * Call the stack overflow hook function if the stack of the task being swapped
  32  * out is currently overflowed, or looks like it might have overflowed in the
  33  * past.
  34  *
  35  * Setting configCHECK_FOR_STACK_OVERFLOW to 1 will cause the macro to check
  36  * the current stack state only - comparing the current top of stack value to
  37  * the stack limit.  Setting configCHECK_FOR_STACK_OVERFLOW to greater than 1
  38  * will also cause the last few stack bytes to be checked to ensure the value
  39  * to which the bytes were set when the task was created have not been
  40  * overwritten.  Note this second test does not guarantee that an overflowed
  41  * stack will always be recognised.
  42  */
  43
  44 /*-----------------------------------------------------------*/
  45
  46 #if ( ( configCHECK_FOR_STACK_OVERFLOW == 1 ) && ( portSTACK_GROWTH < 0 ) )
  47
  48 /* Only the current stack state is to be checked. */
  49     #define taskCHECK_FOR_STACK_OVERFLOW()                                                            \
  50     {                                                                                                 \
  51         /* Is the currently saved stack pointer within the stack limit? */                            \
  52         if( pxCurrentTCB->pxTopOfStack <= pxCurrentTCB->pxStack )                                     \
  53         {                                                                                             \
  54             vApplicationStackOverflowHook( ( TaskHandle_t ) pxCurrentTCB, pxCurrentTCB->pcTaskName ); \
  55         }                                                                                             \
  56     }
  57
  58 #endif /* configCHECK_FOR_STACK_OVERFLOW == 1 */
  59 /*-----------------------------------------------------------*/
  60
  61 #if ( ( configCHECK_FOR_STACK_OVERFLOW == 1 ) && ( portSTACK_GROWTH > 0 ) )
  62
  63 /* Only the current stack state is to be checked. */
  64     #define taskCHECK_FOR_STACK_OVERFLOW()                                                            \
  65     {                                                                                                 \
  66                                                                                                       \
  67         /* Is the currently saved stack pointer within the stack limit? */                            \
  68         if( pxCurrentTCB->pxTopOfStack >= pxCurrentTCB->pxEndOfStack )                                \
  69         {                                                                                             \
  70             vApplicationStackOverflowHook( ( TaskHandle_t ) pxCurrentTCB, pxCurrentTCB->pcTaskName ); \
  71         }                                                                                             \
  72     }
  73
  74 #endif /* configCHECK_FOR_STACK_OVERFLOW == 1 */
  75 /*-----------------------------------------------------------*/
  76
  77 #if ( ( configCHECK_FOR_STACK_OVERFLOW > 1 ) && ( portSTACK_GROWTH < 0 ) )
  78
  79     #define taskCHECK_FOR_STACK_OVERFLOW()                                                            \
  80     {                                                                                                 \
  81         const uint32_t * const pulStack = ( uint32_t * ) pxCurrentTCB->pxStack;                       \
  82         const uint32_t ulCheckValue = ( uint32_t ) 0xa5a5a5a5;                                        \
  83                                                                                                       \
  84         if( ( pulStack[ 0 ] != ulCheckValue ) ||                                                      \
  85             ( pulStack[ 1 ] != ulCheckValue ) ||                                                      \
  86             ( pulStack[ 2 ] != ulCheckValue ) ||                                                      \
  87             ( pulStack[ 3 ] != ulCheckValue ) )                                                       \
  88         {                                                                                             \
  89             vApplicationStackOverflowHook( ( TaskHandle_t ) pxCurrentTCB, pxCurrentTCB->pcTaskName ); \
  90         }                                                                                             \
  91     }
  92
  93 #endif /* #if( configCHECK_FOR_STACK_OVERFLOW > 1 ) */
  94 /*-----------------------------------------------------------*/
  95
  96 #if ( ( configCHECK_FOR_STACK_OVERFLOW > 1 ) && ( portSTACK_GROWTH > 0 ) )
  97
  98     #define taskCHECK_FOR_STACK_OVERFLOW()                                                                                                \
  99     {                                                                                                                                     \
 100         int8_t * pcEndOfStack = ( int8_t * ) pxCurrentTCB->pxEndOfStack;                                                                  \
 101         static const uint8_t ucExpectedStackBytes[] = { tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE,   \
 102                                                         tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE,   \
 103                                                         tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE,   \
 104                                                         tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE,   \
 105                                                         tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE }; \
 106                                                                                                                                           \
 107                                                                                                                                           \
 108         pcEndOfStack -= sizeof( ucExpectedStackBytes );                                                                                   \
 109                                                                                                                                           \
 110         /* Has the extremity of the task stack ever been written over? */                                                                 \
 111         if( memcmp( ( void * ) pcEndOfStack, ( void * ) ucExpectedStackBytes, sizeof( ucExpectedStackBytes ) ) != 0 )                     \
 112         {                                                                                                                                 \
 113             vApplicationStackOverflowHook( ( TaskHandle_t ) pxCurrentTCB, pxCurrentTCB->pcTaskName );                                     \
 114         }                                                                                                                                 \
 115     }
 116
 117 #endif /* #if( configCHECK_FOR_STACK_OVERFLOW > 1 ) */
 118 /*-----------------------------------------------------------*/
 119
 120 /* Remove stack overflow macro if not being used. */
 121 #ifndef taskCHECK_FOR_STACK_OVERFLOW
 122     #define taskCHECK_FOR_STACK_OVERFLOW()
 123 #endif
 124
 125
 126
 127 #endif /* STACK_MACROS_H */