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

   1 /*
   2  * FreeRTOS SMP Kernel V202110.00
   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 /*
  47  * portSTACK_LIMIT_PADDING is a number of extra words to consider to be in
  48  * use on the stack.
  49  */
  50 #ifndef portSTACK_LIMIT_PADDING
  51     #define portSTACK_LIMIT_PADDING 0
  52 #endif
  53
  54 #if ( ( configCHECK_FOR_STACK_OVERFLOW == 1 ) && ( portSTACK_GROWTH < 0 ) )
  55
  56 /* Only the current stack state is to be checked. */
  57     #define taskCHECK_FOR_STACK_OVERFLOW()                                                            \
  58     {                                                                                                 \
  59         /* Is the currently saved stack pointer within the stack limit? */                            \
  60         if( pxCurrentTCB->pxTopOfStack <= pxCurrentTCB->pxStack + portSTACK_LIMIT_PADDING )           \
  61         {                                                                                             \
  62             vApplicationStackOverflowHook( ( TaskHandle_t ) pxCurrentTCB, pxCurrentTCB->pcTaskName ); \
  63         }                                                                                             \
  64     }
  65
  66 #endif /* configCHECK_FOR_STACK_OVERFLOW == 1 */
  67 /*-----------------------------------------------------------*/
  68
  69 #if ( ( configCHECK_FOR_STACK_OVERFLOW == 1 ) && ( portSTACK_GROWTH > 0 ) )
  70
  71 /* Only the current stack state is to be checked. */
  72     #define taskCHECK_FOR_STACK_OVERFLOW()                                                            \
  73     {                                                                                                 \
  74                                                                                                       \
  75         /* Is the currently saved stack pointer within the stack limit? */                            \
  76         if( pxCurrentTCB->pxTopOfStack >= pxCurrentTCB->pxEndOfStack - portSTACK_LIMIT_PADDING )      \
  77         {                                                                                             \
  78             vApplicationStackOverflowHook( ( TaskHandle_t ) pxCurrentTCB, pxCurrentTCB->pcTaskName ); \
  79         }                                                                                             \
  80     }
  81
  82 #endif /* configCHECK_FOR_STACK_OVERFLOW == 1 */
  83 /*-----------------------------------------------------------*/
  84
  85 #if ( ( configCHECK_FOR_STACK_OVERFLOW > 1 ) && ( portSTACK_GROWTH < 0 ) )
  86
  87     #define taskCHECK_FOR_STACK_OVERFLOW()                                                            \
  88     {                                                                                                 \
  89         const uint32_t * const pulStack = ( uint32_t * ) pxCurrentTCB->pxStack;                       \
  90         const uint32_t ulCheckValue = ( uint32_t ) 0xa5a5a5a5;                                        \
  91                                                                                                       \
  92         if( ( pulStack[ 0 ] != ulCheckValue ) ||                                                      \
  93             ( pulStack[ 1 ] != ulCheckValue ) ||                                                      \
  94             ( pulStack[ 2 ] != ulCheckValue ) ||                                                      \
  95             ( pulStack[ 3 ] != ulCheckValue ) )                                                       \
  96         {                                                                                             \
  97             vApplicationStackOverflowHook( ( TaskHandle_t ) pxCurrentTCB, pxCurrentTCB->pcTaskName ); \
  98         }                                                                                             \
  99     }
 100
 101 #endif /* #if( configCHECK_FOR_STACK_OVERFLOW > 1 ) */
 102 /*-----------------------------------------------------------*/
 103
 104 #if ( ( configCHECK_FOR_STACK_OVERFLOW > 1 ) && ( portSTACK_GROWTH > 0 ) )
 105
 106     #define taskCHECK_FOR_STACK_OVERFLOW()                                                                                                \
 107     {                                                                                                                                     \
 108         int8_t * pcEndOfStack = ( int8_t * ) pxCurrentTCB->pxEndOfStack;                                                                  \
 109         static const uint8_t ucExpectedStackBytes[] = { tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE,   \
 110                                                         tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE,   \
 111                                                         tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE,   \
 112                                                         tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE,   \
 113                                                         tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE }; \
 114                                                                                                                                           \
 115                                                                                                                                           \
 116         pcEndOfStack -= sizeof( ucExpectedStackBytes );                                                                                   \
 117                                                                                                                                           \
 118         /* Has the extremity of the task stack ever been written over? */                                                                 \
 119         if( memcmp( ( void * ) pcEndOfStack, ( void * ) ucExpectedStackBytes, sizeof( ucExpectedStackBytes ) ) != 0 )                     \
 120         {                                                                                                                                 \
 121             vApplicationStackOverflowHook( ( TaskHandle_t ) pxCurrentTCB, pxCurrentTCB->pcTaskName );                                     \
 122         }                                                                                                                                 \
 123     }
 124
 125 #endif /* #if( configCHECK_FOR_STACK_OVERFLOW > 1 ) */
 126 /*-----------------------------------------------------------*/
 127
 128 /* Remove stack overflow macro if not being used. */
 129 #ifndef taskCHECK_FOR_STACK_OVERFLOW
 130     #define taskCHECK_FOR_STACK_OVERFLOW()
 131 #endif
 132
 133
 134
 135 #endif /* STACK_MACROS_H */