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

   1 /*\r
   2     FreeRTOS V8.2.0rc1 - Copyright (C) 2014 Real Time Engineers Ltd.\r
   3     All rights reserved\r
   4 \r
   5     VISIT http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.\r
   6 \r
   7     This file is part of the FreeRTOS distribution.\r
   8 \r
   9     FreeRTOS is free software; you can redistribute it and/or modify it under\r
  10     the terms of the GNU General Public License (version 2) as published by the\r
  11     Free Software Foundation >>!AND MODIFIED BY!<< the FreeRTOS exception.\r
  12 \r
  13     >>!   NOTE: The modification to the GPL is included to allow you to     !<<\r
  14     >>!   distribute a combined work that includes FreeRTOS without being   !<<\r
  15     >>!   obliged to provide the source code for proprietary components     !<<\r
  16     >>!   outside of the FreeRTOS kernel.                                   !<<\r
  17 \r
  18     FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY\r
  19     WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS\r
  20     FOR A PARTICULAR PURPOSE.  Full license text is available on the following\r
  21     link: http://www.freertos.org/a00114.html\r
  22 \r
  23     1 tab == 4 spaces!\r
  24 \r
  25     ***************************************************************************\r
  26      *                                                                       *\r
  27      *    Having a problem?  Start by reading the FAQ "My application does   *\r
  28      *    not run, what could be wrong?".  Have you defined configASSERT()?  *\r
  29      *                                                                       *\r
  30      *    http://www.FreeRTOS.org/FAQHelp.html                               *\r
  31      *                                                                       *\r
  32     ***************************************************************************\r
  33 \r
  34     ***************************************************************************\r
  35      *                                                                       *\r
  36      *    FreeRTOS provides completely free yet professionally developed,    *\r
  37      *    robust, strictly quality controlled, supported, and cross          *\r
  38      *    platform software that is more than just the market leader, it     *\r
  39      *    is the industry's de facto standard.                               *\r
  40      *                                                                       *\r
  41      *    Help yourself get started quickly while simultaneously helping     *\r
  42      *    to support the FreeRTOS project by purchasing a FreeRTOS           *\r
  43      *    tutorial book, reference manual, or both:                          *\r
  44      *    http://www.FreeRTOS.org/Documentation                              *\r
  45      *                                                                       *\r
  46     ***************************************************************************\r
  47 \r
  48     ***************************************************************************\r
  49      *                                                                       *\r
  50      *   Investing in training allows your team to be as productive as       *\r
  51      *   possible as early as possible, lowering your overall development    *\r
  52      *   cost, and enabling you to bring a more robust product to market     *\r
  53      *   earlier than would otherwise be possible.  Richard Barry is both    *\r
  54      *   the architect and key author of FreeRTOS, and so also the world's   *\r
  55      *   leading authority on what is the world's most popular real time     *\r
  56      *   kernel for deeply embedded MCU designs.  Obtaining your training    *\r
  57      *   from Richard ensures your team will gain directly from his in-depth *\r
  58      *   product knowledge and years of usage experience.  Contact Real Time *\r
  59      *   Engineers Ltd to enquire about the FreeRTOS Masterclass, presented  *\r
  60      *   by Richard Barry:  http://www.FreeRTOS.org/contact\r
  61      *                                                                       *\r
  62     ***************************************************************************\r
  63 \r
  64     ***************************************************************************\r
  65      *                                                                       *\r
  66      *    You are receiving this top quality software for free.  Please play *\r
  67      *    fair and reciprocate by reporting any suspected issues and         *\r
  68      *    participating in the community forum:                              *\r
  69      *    http://www.FreeRTOS.org/support                                    *\r
  70      *                                                                       *\r
  71      *    Thank you!                                                         *\r
  72      *                                                                       *\r
  73     ***************************************************************************\r
  74 \r
  75     http://www.FreeRTOS.org - Documentation, books, training, latest versions,\r
  76     license and Real Time Engineers Ltd. contact details.\r
  77 \r
  78     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
  79     including FreeRTOS+Trace - an indispensable productivity tool, a DOS\r
  80     compatible FAT file system, and our tiny thread aware UDP/IP stack.\r
  81 \r
  82     http://www.FreeRTOS.org/labs - Where new FreeRTOS products go to incubate.\r
  83     Come and try FreeRTOS+TCP, our new open source TCP/IP stack for FreeRTOS.\r
  84 \r
  85     http://www.OpenRTOS.com - Real Time Engineers ltd license FreeRTOS to High\r
  86     Integrity Systems ltd. to sell under the OpenRTOS brand.  Low cost OpenRTOS\r
  87     licenses offer ticketed support, indemnification and commercial middleware.\r
  88 \r
  89     http://www.SafeRTOS.com - High Integrity Systems also provide a safety\r
  90     engineered and independently SIL3 certified version for use in safety and\r
  91     mission critical applications that require provable dependability.\r
  92 \r
  93     1 tab == 4 spaces!\r
  94 */\r
  95 \r
  96 #ifndef STACK_MACROS_H\r
  97 #define STACK_MACROS_H\r
  98 \r
  99 /*\r
 100  * Call the stack overflow hook function if the stack of the task being swapped\r
 101  * out is currently overflowed, or looks like it might have overflowed in the\r
 102  * past.\r
 103  *\r
 104  * Setting configCHECK_FOR_STACK_OVERFLOW to 1 will cause the macro to check\r
 105  * the current stack state only - comparing the current top of stack value to\r
 106  * the stack limit.  Setting configCHECK_FOR_STACK_OVERFLOW to greater than 1\r
 107  * will also cause the last few stack bytes to be checked to ensure the value\r
 108  * to which the bytes were set when the task was created have not been\r
 109  * overwritten.  Note this second test does not guarantee that an overflowed\r
 110  * stack will always be recognised.\r
 111  */\r
 112 \r
 113 /*-----------------------------------------------------------*/\r
 114 \r
 115 #if( configCHECK_FOR_STACK_OVERFLOW == 0 )\r
 116 \r
 117         /* FreeRTOSConfig.h is not set to check for stack overflows. */\r
 118         #define taskFIRST_CHECK_FOR_STACK_OVERFLOW()\r
 119         #define taskSECOND_CHECK_FOR_STACK_OVERFLOW()\r
 120 \r
 121 #endif /* configCHECK_FOR_STACK_OVERFLOW == 0 */\r
 122 /*-----------------------------------------------------------*/\r
 123 \r
 124 #if( configCHECK_FOR_STACK_OVERFLOW == 1 )\r
 125 \r
 126         /* FreeRTOSConfig.h is only set to use the first method of\r
 127         overflow checking. */\r
 128         #define taskSECOND_CHECK_FOR_STACK_OVERFLOW()\r
 129 \r
 130 #endif\r
 131 /*-----------------------------------------------------------*/\r
 132 \r
 133 #if( ( configCHECK_FOR_STACK_OVERFLOW > 0 ) && ( portSTACK_GROWTH < 0 ) )\r
 134 \r
 135         /* Only the current stack state is to be checked. */\r
 136         #define taskFIRST_CHECK_FOR_STACK_OVERFLOW()                                                                                                            \\r
 137         {                                                                                                                                                                                                       \\r
 138                 /* Is the currently saved stack pointer within the stack limit? */                                                              \\r
 139                 if( pxCurrentTCB->pxTopOfStack <= pxCurrentTCB->pxStack )                                                                               \\r
 140                 {                                                                                                                                                                                               \\r
 141                         vApplicationStackOverflowHook( ( TaskHandle_t ) pxCurrentTCB, pxCurrentTCB->pcTaskName );       \\r
 142                 }                                                                                                                                                                                               \\r
 143         }\r
 144 \r
 145 #endif /* configCHECK_FOR_STACK_OVERFLOW > 0 */\r
 146 /*-----------------------------------------------------------*/\r
 147 \r
 148 #if( ( configCHECK_FOR_STACK_OVERFLOW > 0 ) && ( portSTACK_GROWTH > 0 ) )\r
 149 \r
 150         /* Only the current stack state is to be checked. */\r
 151         #define taskFIRST_CHECK_FOR_STACK_OVERFLOW()                                                                                                            \\r
 152         {                                                                                                                                                                                                       \\r
 153                                                                                                                                                                                                                 \\r
 154                 /* Is the currently saved stack pointer within the stack limit? */                                                              \\r
 155                 if( pxCurrentTCB->pxTopOfStack >= pxCurrentTCB->pxEndOfStack )                                                                  \\r
 156                 {                                                                                                                                                                                               \\r
 157                         vApplicationStackOverflowHook( ( TaskHandle_t ) pxCurrentTCB, pxCurrentTCB->pcTaskName );       \\r
 158                 }                                                                                                                                                                                               \\r
 159         }\r
 160 \r
 161 #endif /* configCHECK_FOR_STACK_OVERFLOW == 1 */\r
 162 /*-----------------------------------------------------------*/\r
 163 \r
 164 #if( ( configCHECK_FOR_STACK_OVERFLOW > 1 ) && ( portSTACK_GROWTH < 0 ) )\r
 165 \r
 166         #define taskSECOND_CHECK_FOR_STACK_OVERFLOW()                                                                                                                                                                           \\r
 167         {                                                                                                                                                                                                                                                                       \\r
 168         static const uint8_t ucExpectedStackBytes[] = { tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE,         \\r
 169                                                                                                         tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE,         \\r
 170                                                                                                         tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE,         \\r
 171                                                                                                         tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE,         \\r
 172                                                                                                         tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE };       \\r
 173                                                                                                                                                                                                                                                                                 \\r
 174                                                                                                                                                                                                                                                                                 \\r
 175                 /* Has the extremity of the task stack ever been written over? */                                                                                                                               \\r
 176                 if( memcmp( ( void * ) pxCurrentTCB->pxStack, ( void * ) ucExpectedStackBytes, sizeof( ucExpectedStackBytes ) ) != 0 )                  \\r
 177                 {                                                                                                                                                                                                                                                               \\r
 178                         vApplicationStackOverflowHook( ( TaskHandle_t ) pxCurrentTCB, pxCurrentTCB->pcTaskName );                                                                       \\r
 179                 }                                                                                                                                                                                                                                                               \\r
 180         }\r
 181 \r
 182 #endif /* #if( configCHECK_FOR_STACK_OVERFLOW > 1 ) */\r
 183 /*-----------------------------------------------------------*/\r
 184 \r
 185 #if( ( configCHECK_FOR_STACK_OVERFLOW > 1 ) && ( portSTACK_GROWTH > 0 ) )\r
 186 \r
 187         #define taskSECOND_CHECK_FOR_STACK_OVERFLOW()                                                                                                                                                                           \\r
 188         {                                                                                                                                                                                                                                                                       \\r
 189         int8_t *pcEndOfStack = ( int8_t * ) pxCurrentTCB->pxEndOfStack;                                                                                                                                         \\r
 190         static const uint8_t ucExpectedStackBytes[] = { tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE,         \\r
 191                                                                                                         tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE,         \\r
 192                                                                                                         tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE,         \\r
 193                                                                                                         tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE,         \\r
 194                                                                                                         tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE };       \\r
 195                                                                                                                                                                                                                                                                                 \\r
 196                                                                                                                                                                                                                                                                                 \\r
 197                 pcEndOfStack -= sizeof( ucExpectedStackBytes );                                                                                                                                                                 \\r
 198                                                                                                                                                                                                                                                                                 \\r
 199                 /* Has the extremity of the task stack ever been written over? */                                                                                                                               \\r
 200                 if( memcmp( ( void * ) pcEndOfStack, ( void * ) ucExpectedStackBytes, sizeof( ucExpectedStackBytes ) ) != 0 )                                   \\r
 201                 {                                                                                                                                                                                                                                                               \\r
 202                         vApplicationStackOverflowHook( ( TaskHandle_t ) pxCurrentTCB, pxCurrentTCB->pcTaskName );                                                                       \\r
 203                 }                                                                                                                                                                                                                                                               \\r
 204         }\r
 205 \r
 206 #endif /* #if( configCHECK_FOR_STACK_OVERFLOW > 1 ) */\r
 207 /*-----------------------------------------------------------*/\r
 208 \r
 209 #endif /* STACK_MACROS_H */\r
 210 \r