begriffs open source - freertos/blob - Source/include/StackMacros.h

   1 /*\r
   2     FreeRTOS V7.1.0 - Copyright (C) 2011 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     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                 /* Is the currently saved stack pointer within the stack limit? */                                                              \\r
  97                 if( pxCurrentTCB->pxTopOfStack <= pxCurrentTCB->pxStack )                                                                               \\r
  98                 {                                                                                                                                                                                               \\r
  99                         vApplicationStackOverflowHook( ( xTaskHandle ) pxCurrentTCB, pxCurrentTCB->pcTaskName );        \\r
 100                 }                                                                                                                                                                                               \\r
 101         }\r
 102 \r
 103 #endif /* configCHECK_FOR_STACK_OVERFLOW > 0 */\r
 104 /*-----------------------------------------------------------*/\r
 105 \r
 106 #if( ( configCHECK_FOR_STACK_OVERFLOW > 0 ) && ( portSTACK_GROWTH > 0 ) )\r
 107 \r
 108         /* Only the current stack state is to be checked. */\r
 109         #define taskFIRST_CHECK_FOR_STACK_OVERFLOW()                                                                                                            \\r
 110         {                                                                                                                                                                                                       \\r
 111                                                                                                                                                                                                                 \\r
 112                 /* Is the currently saved stack pointer within the stack limit? */                                                              \\r
 113                 if( pxCurrentTCB->pxTopOfStack >= pxCurrentTCB->pxEndOfStack )                                                                  \\r
 114                 {                                                                                                                                                                                               \\r
 115                         vApplicationStackOverflowHook( ( xTaskHandle ) pxCurrentTCB, pxCurrentTCB->pcTaskName );        \\r
 116                 }                                                                                                                                                                                               \\r
 117         }\r
 118 \r
 119 #endif /* configCHECK_FOR_STACK_OVERFLOW == 1 */\r
 120 /*-----------------------------------------------------------*/\r
 121 \r
 122 #if( ( configCHECK_FOR_STACK_OVERFLOW > 1 ) && ( portSTACK_GROWTH < 0 ) )\r
 123 \r
 124         #define taskSECOND_CHECK_FOR_STACK_OVERFLOW()                                                                                                                                                                                           \\r
 125         {                                                                                                                                                                                                                                                                                       \\r
 126         static const unsigned char ucExpectedStackBytes[] = {   tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE,         \\r
 127                                                                                                                         tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE,         \\r
 128                                                                                                                         tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE,         \\r
 129                                                                                                                         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                                                                                                                                                                                                                                                                                                 \\r
 132                                                                                                                                                                                                                                                                                                 \\r
 133                 /* Has the extremity of the task stack ever been written over? */                                                                                                                                               \\r
 134                 if( memcmp( ( void * ) pxCurrentTCB->pxStack, ( void * ) ucExpectedStackBytes, sizeof( ucExpectedStackBytes ) ) != 0 )                                  \\r
 135                 {                                                                                                                                                                                                                                                                               \\r
 136                         vApplicationStackOverflowHook( ( xTaskHandle ) pxCurrentTCB, pxCurrentTCB->pcTaskName );                                                                                        \\r
 137                 }                                                                                                                                                                                                                                                                               \\r
 138         }\r
 139 \r
 140 #endif /* #if( configCHECK_FOR_STACK_OVERFLOW > 1 ) */\r
 141 /*-----------------------------------------------------------*/\r
 142 \r
 143 #if( ( configCHECK_FOR_STACK_OVERFLOW > 1 ) && ( portSTACK_GROWTH > 0 ) )\r
 144 \r
 145         #define taskSECOND_CHECK_FOR_STACK_OVERFLOW()                                                                                                                                                                                           \\r
 146         {                                                                                                                                                                                                                                                                                       \\r
 147         char *pcEndOfStack = ( char * ) pxCurrentTCB->pxEndOfStack;                                                                                                                                                                     \\r
 148         static const unsigned char ucExpectedStackBytes[] = {   tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE,         \\r
 149                                                                                                                         tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE,         \\r
 150                                                                                                                         tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE,         \\r
 151                                                                                                                         tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE,         \\r
 152                                                                                                                         tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE };       \\r
 153                                                                                                                                                                                                                                                                                                 \\r
 154                                                                                                                                                                                                                                                                                                 \\r
 155                 pcEndOfStack -= sizeof( ucExpectedStackBytes );                                                                                                                                                                                 \\r
 156                                                                                                                                                                                                                                                                                                 \\r
 157                 /* Has the extremity of the task stack ever been written over? */                                                                                                                                               \\r
 158                 if( memcmp( ( void * ) pcEndOfStack, ( void * ) ucExpectedStackBytes, sizeof( ucExpectedStackBytes ) ) != 0 )                                                   \\r
 159                 {                                                                                                                                                                                                                                                                               \\r
 160                         vApplicationStackOverflowHook( ( xTaskHandle ) pxCurrentTCB, pxCurrentTCB->pcTaskName );                                                                                        \\r
 161                 }                                                                                                                                                                                                                                                                               \\r
 162         }\r
 163 \r
 164 #endif /* #if( configCHECK_FOR_STACK_OVERFLOW > 1 ) */\r
 165 /*-----------------------------------------------------------*/\r
 166 \r
 167 #endif /* STACK_MACROS_H */\r
 168 \r