git.sur5r.net Git - freertos/blob - FreeRTOS/Source/include/StackMacros.h

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