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

   1 /*\r
   2     FreeRTOS V6.0.1 - Copyright (C) 2009 Real Time Engineers Ltd.\r
   3 \r
   4     ***************************************************************************\r
   5     *                                                                         *\r
   6     * If you are:                                                             *\r
   7     *                                                                         *\r
   8     *    + New to FreeRTOS,                                                   *\r
   9     *    + Wanting to learn FreeRTOS or multitasking in general quickly       *\r
  10     *    + Looking for basic training,                                        *\r
  11     *    + Wanting to improve your FreeRTOS skills and productivity           *\r
  12     *                                                                         *\r
  13     * then take a look at the FreeRTOS eBook                                  *\r
  14     *                                                                         *\r
  15     *        "Using the FreeRTOS Real Time Kernel - a Practical Guide"        *\r
  16     *                  http://www.FreeRTOS.org/Documentation                  *\r
  17     *                                                                         *\r
  18     * A pdf reference manual is also available.  Both are usually delivered   *\r
  19     * to your inbox within 20 minutes to two hours when purchased between 8am *\r
  20     * and 8pm GMT (although please allow up to 24 hours in case of            *\r
  21     * exceptional circumstances).  Thank you for your support!                *\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 exception to the GPL is included to allow you to distribute\r
  31     a combined work that includes FreeRTOS without being obliged to provide the\r
  32     source code for proprietary components outside of the FreeRTOS kernel.\r
  33     FreeRTOS is distributed in the hope that it will be useful, but WITHOUT\r
  34     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\r
  35     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     http://www.FreeRTOS.org - Documentation, latest information, license and\r
  45     contact details.\r
  46 \r
  47     http://www.SafeRTOS.com - A version that is certified for use in safety\r
  48     critical systems.\r
  49 \r
  50     http://www.OpenRTOS.com - Commercial support, development, porting,\r
  51     licensing and training services.\r
  52 */\r
  53 \r
  54 #ifndef STACK_MACROS_H\r
  55 #define STACK_MACROS_H\r
  56 \r
  57 /*\r
  58  * Call the stack overflow hook function if the stack of the task being swapped\r
  59  * out is currently overflowed, or looks like it might have overflowed in the\r
  60  * past.\r
  61  *\r
  62  * Setting configCHECK_FOR_STACK_OVERFLOW to 1 will cause the macro to check\r
  63  * the current stack state only - comparing the current top of stack value to\r
  64  * the stack limit.  Setting configCHECK_FOR_STACK_OVERFLOW to greater than 1\r
  65  * will also cause the last few stack bytes to be checked to ensure the value\r
  66  * to which the bytes were set when the task was created have not been \r
  67  * overwritten.  Note this second test does not guarantee that an overflowed\r
  68  * stack will always be recognised.\r
  69  */\r
  70 \r
  71 /*-----------------------------------------------------------*/\r
  72 \r
  73 #if( configCHECK_FOR_STACK_OVERFLOW == 0 )\r
  74 \r
  75         /* FreeRTOSConfig.h is not set to check for stack overflows. */\r
  76         #define taskFIRST_CHECK_FOR_STACK_OVERFLOW()\r
  77         #define taskSECOND_CHECK_FOR_STACK_OVERFLOW()\r
  78 \r
  79 #endif /* configCHECK_FOR_STACK_OVERFLOW == 0 */\r
  80 /*-----------------------------------------------------------*/\r
  81 \r
  82 #if( configCHECK_FOR_STACK_OVERFLOW == 1 )\r
  83 \r
  84         /* FreeRTOSConfig.h is only set to use the first method of\r
  85         overflow checking. */\r
  86         #define taskSECOND_CHECK_FOR_STACK_OVERFLOW()\r
  87 \r
  88 #endif\r
  89 /*-----------------------------------------------------------*/\r
  90 \r
  91 #if( ( configCHECK_FOR_STACK_OVERFLOW > 0 ) && ( portSTACK_GROWTH < 0 ) )\r
  92 \r
  93         /* Only the current stack state is to be checked. */\r
  94         #define taskFIRST_CHECK_FOR_STACK_OVERFLOW()                                                                                                            \\r
  95         {                                                                                                                                                                                                       \\r
  96         extern void vApplicationStackOverflowHook( xTaskHandle *pxTask, signed char *pcTaskName );                      \\r
  97                                                                                                                                                                                                                 \\r
  98                 /* Is the currently saved stack pointer within the stack limit? */                                                              \\r
  99                 if( pxCurrentTCB->pxTopOfStack <= pxCurrentTCB->pxStack )                                                                               \\r
 100                 {                                                                                                                                                                                               \\r
 101                         vApplicationStackOverflowHook( ( xTaskHandle ) pxCurrentTCB, pxCurrentTCB->pcTaskName );        \\r
 102                 }                                                                                                                                                                                               \\r
 103         }\r
 104 \r
 105 #endif /* configCHECK_FOR_STACK_OVERFLOW > 0 */\r
 106 /*-----------------------------------------------------------*/\r
 107 \r
 108 #if( ( configCHECK_FOR_STACK_OVERFLOW > 0 ) && ( portSTACK_GROWTH > 0 ) )\r
 109 \r
 110         /* Only the current stack state is to be checked. */\r
 111         #define taskFIRST_CHECK_FOR_STACK_OVERFLOW()                                                                                                            \\r
 112         {                                                                                                                                                                                                       \\r
 113         extern void vApplicationStackOverflowHook( xTaskHandle *pxTask, signed char *pcTaskName );              \\r
 114                                                                                                                                                                                                                 \\r
 115                 /* Is the currently saved stack pointer within the stack limit? */                                                              \\r
 116                 if( pxCurrentTCB->pxTopOfStack >= pxCurrentTCB->pxEndOfStack )                                                                  \\r
 117                 {                                                                                                                                                                                               \\r
 118                         vApplicationStackOverflowHook( ( xTaskHandle ) pxCurrentTCB, pxCurrentTCB->pcTaskName );        \\r
 119                 }                                                                                                                                                                                               \\r
 120         }\r
 121 \r
 122 #endif /* configCHECK_FOR_STACK_OVERFLOW == 1 */\r
 123 /*-----------------------------------------------------------*/\r
 124 \r
 125 #if( ( configCHECK_FOR_STACK_OVERFLOW > 1 ) && ( portSTACK_GROWTH < 0 ) )\r
 126 \r
 127         #define taskSECOND_CHECK_FOR_STACK_OVERFLOW()                                                                                                                                                                                                   \\r
 128         {                                                                                                                                                                                                                                                                                               \\r
 129         extern void vApplicationStackOverflowHook( xTaskHandle *pxTask, signed char *pcTaskName );                                                                                                      \\r
 130         static const unsigned char ucExpectedStackBytes[] = {   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                                                                                                                                 tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE };       \\r
 135                                                                                                                                                                                                                                                                                                         \\r
 136                                                                                                                                                                                                                                                                                                         \\r
 137                 /* Has the extremity of the task stack ever been written over? */                                                                                                                                                       \\r
 138                 if( memcmp( ( void * ) pxCurrentTCB->pxStack, ( void * ) ucExpectedStackBytes, sizeof( ucExpectedStackBytes ) ) != 0 )                                          \\r
 139                 {                                                                                                                                                                                                                                                                                       \\r
 140                         vApplicationStackOverflowHook( ( xTaskHandle ) pxCurrentTCB, pxCurrentTCB->pcTaskName );                                                                                                \\r
 141                 }                                                                                                                                                                                                                                                                                       \\r
 142         }\r
 143 \r
 144 #endif /* #if( configCHECK_FOR_STACK_OVERFLOW > 1 ) */\r
 145 /*-----------------------------------------------------------*/\r
 146 \r
 147 #if( ( configCHECK_FOR_STACK_OVERFLOW > 1 ) && ( portSTACK_GROWTH > 0 ) )\r
 148 \r
 149         #define taskSECOND_CHECK_FOR_STACK_OVERFLOW()                                                                                                                                                                                                   \\r
 150         {                                                                                                                                                                                                                                                                                               \\r
 151         extern void vApplicationStackOverflowHook( xTaskHandle *pxTask, signed char *pcTaskName );                                                                                                      \\r
 152         char *pcEndOfStack = ( char * ) pxCurrentTCB->pxEndOfStack;                                                                                                                                                             \\r
 153         static const unsigned char ucExpectedStackBytes[] = {   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                                                                                                                                 tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE };       \\r
 158                                                                                                                                                                                                                                                                                                         \\r
 159                                                                                                                                                                                                                                                                                                         \\r
 160                 pcEndOfStack -= sizeof( ucExpectedStackBytes );                                                                                                                                                                                         \\r
 161                                                                                                                                                                                                                                                                                                         \\r
 162                 /* Has the extremity of the task stack ever been written over? */                                                                                                                                                       \\r
 163                 if( memcmp( ( void * ) pcEndOfStack, ( void * ) ucExpectedStackBytes, sizeof( ucExpectedStackBytes ) ) != 0 )                                                           \\r
 164                 {                                                                                                                                                                                                                                                                                       \\r
 165                         vApplicationStackOverflowHook( ( xTaskHandle ) pxCurrentTCB, pxCurrentTCB->pcTaskName );                                                                                                \\r
 166                 }                                                                                                                                                                                                                                                                                       \\r
 167         }\r
 168 \r
 169 #endif /* #if( configCHECK_FOR_STACK_OVERFLOW > 1 ) */\r
 170 /*-----------------------------------------------------------*/\r
 171 \r
 172 #endif /* STACK_MACROS_H */\r
 173 \r