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

   1 /*\r
   2     FreeRTOS V7.1.1 - Copyright (C) 2012 Real Time Engineers Ltd.\r
   3 \r
   4 \r
   5     ***************************************************************************\r
   6      *                                                                       *\r
   7      *    FreeRTOS tutorial books are available in pdf and paperback.        *\r
   8      *    Complete, revised, and edited pdf reference manuals are also       *\r
   9      *    available.                                                         *\r
  10      *                                                                       *\r
  11      *    Purchasing FreeRTOS documentation will not only help you, by       *\r
  12      *    ensuring you get running as quickly as possible and with an        *\r
  13      *    in-depth knowledge of how to use FreeRTOS, it will also help       *\r
  14      *    the FreeRTOS project to continue with its mission of providing     *\r
  15      *    professional grade, cross platform, de facto standard solutions    *\r
  16      *    for microcontrollers - completely free of charge!                  *\r
  17      *                                                                       *\r
  18      *    >>> See http://www.FreeRTOS.org/Documentation for details. <<<     *\r
  19      *                                                                       *\r
  20      *    Thank you for using FreeRTOS, and thank you for your support!      *\r
  21      *                                                                       *\r
  22     ***************************************************************************\r
  23 \r
  24 \r
  25     This file is part of the FreeRTOS distribution.\r
  26 \r
  27     FreeRTOS is free software; you can redistribute it and/or modify it under\r
  28     the terms of the GNU General Public License (version 2) as published by the\r
  29     Free Software Foundation AND MODIFIED BY the FreeRTOS exception.\r
  30     >>>NOTE<<< The modification to the GPL is included to allow you to\r
  31     distribute a combined work that includes FreeRTOS without being obliged to\r
  32     provide the source code for proprietary components outside of the FreeRTOS\r
  33     kernel.  FreeRTOS is distributed in the hope that it will be useful, but\r
  34     WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY\r
  35     or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for\r
  36     more details. You should have received a copy of the GNU General Public\r
  37     License and the FreeRTOS license exception along with FreeRTOS; if not it\r
  38     can be viewed here: http://www.freertos.org/a00114.html and also obtained\r
  39     by writing to Richard Barry, contact details for whom are available on the\r
  40     FreeRTOS WEB site.\r
  41 \r
  42     1 tab == 4 spaces!\r
  43     \r
  44     ***************************************************************************\r
  45      *                                                                       *\r
  46      *    Having a problem?  Start by reading the FAQ "My application does   *\r
  47      *    not run, what could be wrong?                                      *\r
  48      *                                                                       *\r
  49      *    http://www.FreeRTOS.org/FAQHelp.html                               *\r
  50      *                                                                       *\r
  51     ***************************************************************************\r
  52 \r
  53     \r
  54     http://www.FreeRTOS.org - Documentation, training, latest information, \r
  55     license and contact details.\r
  56     \r
  57     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
  58     including FreeRTOS+Trace - an indispensable productivity tool.\r
  59 \r
  60     Real Time Engineers ltd license FreeRTOS to High Integrity Systems, who sell \r
  61     the code with commercial support, indemnification, and middleware, under \r
  62     the OpenRTOS brand: http://www.OpenRTOS.com.  High Integrity Systems also\r
  63     provide a safety engineered and independently SIL3 certified version under \r
  64     the SafeRTOS brand: http://www.SafeRTOS.com.\r
  65 */\r
  66 \r
  67 #ifndef STACK_MACROS_H\r
  68 #define STACK_MACROS_H\r
  69 \r
  70 /*\r
  71  * Call the stack overflow hook function if the stack of the task being swapped\r
  72  * out is currently overflowed, or looks like it might have overflowed in the\r
  73  * past.\r
  74  *\r
  75  * Setting configCHECK_FOR_STACK_OVERFLOW to 1 will cause the macro to check\r
  76  * the current stack state only - comparing the current top of stack value to\r
  77  * the stack limit.  Setting configCHECK_FOR_STACK_OVERFLOW to greater than 1\r
  78  * will also cause the last few stack bytes to be checked to ensure the value\r
  79  * to which the bytes were set when the task was created have not been\r
  80  * overwritten.  Note this second test does not guarantee that an overflowed\r
  81  * stack will always be recognised.\r
  82  */\r
  83 \r
  84 /*-----------------------------------------------------------*/\r
  85 \r
  86 #if( configCHECK_FOR_STACK_OVERFLOW == 0 )\r
  87 \r
  88         /* FreeRTOSConfig.h is not set to check for stack overflows. */\r
  89         #define taskFIRST_CHECK_FOR_STACK_OVERFLOW()\r
  90         #define taskSECOND_CHECK_FOR_STACK_OVERFLOW()\r
  91 \r
  92 #endif /* configCHECK_FOR_STACK_OVERFLOW == 0 */\r
  93 /*-----------------------------------------------------------*/\r
  94 \r
  95 #if( configCHECK_FOR_STACK_OVERFLOW == 1 )\r
  96 \r
  97         /* FreeRTOSConfig.h is only set to use the first method of\r
  98         overflow checking. */\r
  99         #define taskSECOND_CHECK_FOR_STACK_OVERFLOW()\r
 100 \r
 101 #endif\r
 102 /*-----------------------------------------------------------*/\r
 103 \r
 104 #if( ( configCHECK_FOR_STACK_OVERFLOW > 0 ) && ( portSTACK_GROWTH < 0 ) )\r
 105 \r
 106         /* Only the current stack state is to be checked. */\r
 107         #define taskFIRST_CHECK_FOR_STACK_OVERFLOW()                                                                                                            \\r
 108         {                                                                                                                                                                                                       \\r
 109                 /* Is the currently saved stack pointer within the stack limit? */                                                              \\r
 110                 if( pxCurrentTCB->pxTopOfStack <= pxCurrentTCB->pxStack )                                                                               \\r
 111                 {                                                                                                                                                                                               \\r
 112                         vApplicationStackOverflowHook( ( xTaskHandle ) pxCurrentTCB, pxCurrentTCB->pcTaskName );        \\r
 113                 }                                                                                                                                                                                               \\r
 114         }\r
 115 \r
 116 #endif /* configCHECK_FOR_STACK_OVERFLOW > 0 */\r
 117 /*-----------------------------------------------------------*/\r
 118 \r
 119 #if( ( configCHECK_FOR_STACK_OVERFLOW > 0 ) && ( portSTACK_GROWTH > 0 ) )\r
 120 \r
 121         /* Only the current stack state is to be checked. */\r
 122         #define taskFIRST_CHECK_FOR_STACK_OVERFLOW()                                                                                                            \\r
 123         {                                                                                                                                                                                                       \\r
 124                                                                                                                                                                                                                 \\r
 125                 /* Is the currently saved stack pointer within the stack limit? */                                                              \\r
 126                 if( pxCurrentTCB->pxTopOfStack >= pxCurrentTCB->pxEndOfStack )                                                                  \\r
 127                 {                                                                                                                                                                                               \\r
 128                         vApplicationStackOverflowHook( ( xTaskHandle ) pxCurrentTCB, pxCurrentTCB->pcTaskName );        \\r
 129                 }                                                                                                                                                                                               \\r
 130         }\r
 131 \r
 132 #endif /* configCHECK_FOR_STACK_OVERFLOW == 1 */\r
 133 /*-----------------------------------------------------------*/\r
 134 \r
 135 #if( ( configCHECK_FOR_STACK_OVERFLOW > 1 ) && ( portSTACK_GROWTH < 0 ) )\r
 136 \r
 137         #define taskSECOND_CHECK_FOR_STACK_OVERFLOW()                                                                                                                                                                                           \\r
 138         {                                                                                                                                                                                                                                                                                       \\r
 139         static const unsigned char ucExpectedStackBytes[] = {   tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE,         \\r
 140                                                                                                                         tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE,         \\r
 141                                                                                                                         tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE,         \\r
 142                                                                                                                         tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE,         \\r
 143                                                                                                                         tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE };       \\r
 144                                                                                                                                                                                                                                                                                                 \\r
 145                                                                                                                                                                                                                                                                                                 \\r
 146                 /* Has the extremity of the task stack ever been written over? */                                                                                                                                               \\r
 147                 if( memcmp( ( void * ) pxCurrentTCB->pxStack, ( void * ) ucExpectedStackBytes, sizeof( ucExpectedStackBytes ) ) != 0 )                                  \\r
 148                 {                                                                                                                                                                                                                                                                               \\r
 149                         vApplicationStackOverflowHook( ( xTaskHandle ) pxCurrentTCB, pxCurrentTCB->pcTaskName );                                                                                        \\r
 150                 }                                                                                                                                                                                                                                                                               \\r
 151         }\r
 152 \r
 153 #endif /* #if( configCHECK_FOR_STACK_OVERFLOW > 1 ) */\r
 154 /*-----------------------------------------------------------*/\r
 155 \r
 156 #if( ( configCHECK_FOR_STACK_OVERFLOW > 1 ) && ( portSTACK_GROWTH > 0 ) )\r
 157 \r
 158         #define taskSECOND_CHECK_FOR_STACK_OVERFLOW()                                                                                                                                                                                           \\r
 159         {                                                                                                                                                                                                                                                                                       \\r
 160         char *pcEndOfStack = ( char * ) pxCurrentTCB->pxEndOfStack;                                                                                                                                                                     \\r
 161         static const unsigned char ucExpectedStackBytes[] = {   tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE,         \\r
 162                                                                                                                         tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE,         \\r
 163                                                                                                                         tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE,         \\r
 164                                                                                                                         tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE,         \\r
 165                                                                                                                         tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE };       \\r
 166                                                                                                                                                                                                                                                                                                 \\r
 167                                                                                                                                                                                                                                                                                                 \\r
 168                 pcEndOfStack -= sizeof( ucExpectedStackBytes );                                                                                                                                                                                 \\r
 169                                                                                                                                                                                                                                                                                                 \\r
 170                 /* Has the extremity of the task stack ever been written over? */                                                                                                                                               \\r
 171                 if( memcmp( ( void * ) pcEndOfStack, ( void * ) ucExpectedStackBytes, sizeof( ucExpectedStackBytes ) ) != 0 )                                                   \\r
 172                 {                                                                                                                                                                                                                                                                               \\r
 173                         vApplicationStackOverflowHook( ( xTaskHandle ) pxCurrentTCB, pxCurrentTCB->pcTaskName );                                                                                        \\r
 174                 }                                                                                                                                                                                                                                                                               \\r
 175         }\r
 176 \r
 177 #endif /* #if( configCHECK_FOR_STACK_OVERFLOW > 1 ) */\r
 178 /*-----------------------------------------------------------*/\r
 179 \r
 180 #endif /* STACK_MACROS_H */\r
 181 \r