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

   1 /*\r
   2         FreeRTOS.org V5.1.2 - Copyright (C) 2003-2009 Richard Barry.\r
   3 \r
   4         This file is part of the FreeRTOS.org distribution.\r
   5 \r
   6         FreeRTOS.org is free software; you can redistribute it and/or modify\r
   7         it under the terms of the GNU General Public License as published by\r
   8         the Free Software Foundation; either version 2 of the License, or\r
   9         (at your option) any later version.\r
  10 \r
  11         FreeRTOS.org is distributed in the hope that it will be useful,\r
  12         but WITHOUT ANY WARRANTY; without even the implied warranty of\r
  13         MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
  14         GNU General Public License for more details.\r
  15 \r
  16         You should have received a copy of the GNU General Public License\r
  17         along with FreeRTOS.org; if not, write to the Free Software\r
  18         Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA\r
  19 \r
  20         A special exception to the GPL can be applied should you wish to distribute\r
  21         a combined work that includes FreeRTOS.org, without being obliged to provide\r
  22         the source code for any proprietary components.  See the licensing section\r
  23         of http://www.FreeRTOS.org for full details of how and when the exception\r
  24         can be applied.\r
  25 \r
  26     ***************************************************************************\r
  27     ***************************************************************************\r
  28     *                                                                         *\r
  29     * Get the FreeRTOS eBook!  See http://www.FreeRTOS.org/Documentation      *\r
  30         *                                                                         *\r
  31         * This is a concise, step by step, 'hands on' guide that describes both   *\r
  32         * general multitasking concepts and FreeRTOS specifics. It presents and   *\r
  33         * explains numerous examples that are written using the FreeRTOS API.     *\r
  34         * Full source code for all the examples is provided in an accompanying    *\r
  35         * .zip file.                                                              *\r
  36     *                                                                         *\r
  37     ***************************************************************************\r
  38     ***************************************************************************\r
  39 \r
  40         Please ensure to read the configuration and relevant port sections of the\r
  41         online documentation.\r
  42 \r
  43         http://www.FreeRTOS.org - Documentation, latest information, license and \r
  44         contact details.\r
  45 \r
  46         http://www.SafeRTOS.com - A version that is certified for use in safety \r
  47         critical systems.\r
  48 \r
  49         http://www.OpenRTOS.com - Commercial support, development, porting, \r
  50         licensing and training services.\r
  51 */\r
  52 \r
  53 #ifndef STACK_MACROS_H\r
  54 #define STACK_MACROS_H\r
  55 \r
  56 /*\r
  57  * Call the stack overflow hook function if the stack of the task being swapped\r
  58  * out is currently overflowed, or looks like it might have overflowed in the\r
  59  * past.\r
  60  *\r
  61  * Setting configCHECK_FOR_STACK_OVERFLOW to 1 will cause the macro to check\r
  62  * the current stack state only - comparing the current top of stack value to\r
  63  * the stack limit.  Setting configCHECK_FOR_STACK_OVERFLOW to greater than 1\r
  64  * will also cause the last few stack bytes to be checked to ensure the value\r
  65  * to which the bytes were set when the task was created have not been \r
  66  * overwritten.  Note this second test does not guarantee that an overflowed\r
  67  * stack will always be recognised.\r
  68  */\r
  69 \r
  70 /*-----------------------------------------------------------*/\r
  71 \r
  72 #if( configCHECK_FOR_STACK_OVERFLOW == 0 )\r
  73 \r
  74         /* FreeRTOSConfig.h is not set to check for stack overflows. */\r
  75         #define taskFIRST_CHECK_FOR_STACK_OVERFLOW()\r
  76         #define taskSECOND_CHECK_FOR_STACK_OVERFLOW()\r
  77 \r
  78 #endif /* configCHECK_FOR_STACK_OVERFLOW == 0 */\r
  79 /*-----------------------------------------------------------*/\r
  80 \r
  81 #if( configCHECK_FOR_STACK_OVERFLOW == 1 )\r
  82 \r
  83         /* FreeRTOSConfig.h is only set to use the first method of\r
  84         overflow checking. */\r
  85         #define taskSECOND_CHECK_FOR_STACK_OVERFLOW()\r
  86 \r
  87 #endif\r
  88 /*-----------------------------------------------------------*/\r
  89 \r
  90 #if( ( configCHECK_FOR_STACK_OVERFLOW > 0 ) && ( portSTACK_GROWTH < 0 ) )\r
  91 \r
  92         /* Only the current stack state is to be checked. */\r
  93         #define taskFIRST_CHECK_FOR_STACK_OVERFLOW()                                                                                                            \\r
  94         {                                                                                                                                                                                                       \\r
  95         extern void vApplicationStackOverflowHook( xTaskHandle *pxTask, signed portCHAR *pcTaskName );          \\r
  96                                                                                                                                                                                                                 \\r
  97                 /* Is the currently saved stack pointer within the stack limit? */                                                              \\r
  98                 if( pxCurrentTCB->pxTopOfStack <= pxCurrentTCB->pxStack )                                                                               \\r
  99                 {                                                                                                                                                                                               \\r
 100                         vApplicationStackOverflowHook( ( xTaskHandle ) pxCurrentTCB, pxCurrentTCB->pcTaskName );        \\r
 101                 }                                                                                                                                                                                               \\r
 102         }\r
 103 \r
 104 #endif /* configCHECK_FOR_STACK_OVERFLOW == 1 */\r
 105 /*-----------------------------------------------------------*/\r
 106 \r
 107 #if( ( configCHECK_FOR_STACK_OVERFLOW > 0 ) && ( portSTACK_GROWTH > 0 ) )\r
 108 \r
 109         /* Only the current stack state is to be checked. */\r
 110         #define taskFIRST_CHECK_FOR_STACK_OVERFLOW()                                                                                                            \\r
 111         {                                                                                                                                                                                                       \\r
 112         extern void vApplicationStackOverflowHook( xTaskHandle *pxTask, signed portCHAR *pcTaskName );          \\r
 113                                                                                                                                                                                                                 \\r
 114                 /* Is the currently saved stack pointer within the stack limit? */                                                              \\r
 115                 if( pxCurrentTCB->pxTopOfStack >= pxCurrentTCB->pxEndOfStack )                                                                  \\r
 116                 {                                                                                                                                                                                               \\r
 117                         vApplicationStackOverflowHook( ( xTaskHandle ) pxCurrentTCB, pxCurrentTCB->pcTaskName );        \\r
 118                 }                                                                                                                                                                                               \\r
 119         }\r
 120 \r
 121 #endif /* configCHECK_FOR_STACK_OVERFLOW == 1 */\r
 122 /*-----------------------------------------------------------*/\r
 123 \r
 124 #if( ( configCHECK_FOR_STACK_OVERFLOW > 1 ) && ( portSTACK_GROWTH < 0 ) )\r
 125 \r
 126         #define taskSECOND_CHECK_FOR_STACK_OVERFLOW()                                                                                                                                                                                                   \\r
 127         {                                                                                                                                                                                                                                                                                               \\r
 128         extern void vApplicationStackOverflowHook( xTaskHandle *pxTask, signed portCHAR *pcTaskName );                                                                                                  \\r
 129         static const unsigned portCHAR ucExpectedStackBytes[] = {       tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE,         \\r
 130                                                                                                                                 tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE,         \\r
 131                                                                                                                                 tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE,         \\r
 132                                                                                                                                 tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE,         \\r
 133                                                                                                                                 tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE };       \\r
 134                                                                                                                                                                                                                                                                                                         \\r
 135                                                                                                                                                                                                                                                                                                         \\r
 136                 /* Has the extremity of the task stack ever been written over? */                                                                                                                                                       \\r
 137                 if( memcmp( ( void * ) pxCurrentTCB->pxStack, ( void * ) ucExpectedStackBytes, sizeof( ucExpectedStackBytes ) ) != 0 )                                          \\r
 138                 {                                                                                                                                                                                                                                                                                       \\r
 139                         vApplicationStackOverflowHook( ( xTaskHandle ) pxCurrentTCB, pxCurrentTCB->pcTaskName );                                                                                                \\r
 140                 }                                                                                                                                                                                                                                                                                       \\r
 141         }\r
 142 \r
 143 #endif /* #if( configCHECK_FOR_STACK_OVERFLOW > 1 ) */\r
 144 /*-----------------------------------------------------------*/\r
 145 \r
 146 #if( ( configCHECK_FOR_STACK_OVERFLOW > 1 ) && ( portSTACK_GROWTH > 0 ) )\r
 147 \r
 148         #define taskSECOND_CHECK_FOR_STACK_OVERFLOW()                                                                                                                                                                                                   \\r
 149         {                                                                                                                                                                                                                                                                                               \\r
 150         extern void vApplicationStackOverflowHook( xTaskHandle *pxTask, signed portCHAR *pcTaskName );                                                                                                  \\r
 151         portCHAR *pcEndOfStack = ( portCHAR * ) pxCurrentTCB->pxEndOfStack;                                                                                                                                                             \\r
 152         static const unsigned portCHAR ucExpectedStackBytes[] = {       tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE,         \\r
 153                                                                                                                                 tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE,         \\r
 154                                                                                                                                 tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE,         \\r
 155                                                                                                                                 tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE,         \\r
 156                                                                                                                                 tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE };       \\r
 157                                                                                                                                                                                                                                                                                                         \\r
 158                                                                                                                                                                                                                                                                                                         \\r
 159                 pcEndOfStack -= sizeof( ucExpectedStackBytes );                                                                                                                                                                                         \\r
 160                                                                                                                                                                                                                                                                                                         \\r
 161                 /* Has the extremity of the task stack ever been written over? */                                                                                                                                                       \\r
 162                 if( memcmp( ( void * ) pcEndOfStack, ( void * ) ucExpectedStackBytes, sizeof( ucExpectedStackBytes ) ) != 0 )                                                           \\r
 163                 {                                                                                                                                                                                                                                                                                       \\r
 164                         vApplicationStackOverflowHook( ( xTaskHandle ) pxCurrentTCB, pxCurrentTCB->pcTaskName );                                                                                                \\r
 165                 }                                                                                                                                                                                                                                                                                       \\r
 166         }\r
 167 \r
 168 #endif /* #if( configCHECK_FOR_STACK_OVERFLOW > 1 ) */\r
 169 /*-----------------------------------------------------------*/\r
 170 \r
 171 #endif /* STACK_MACROS_H */\r
 172 \r