os/7.4.2/include/os/StackMacros.h

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