2 * FreeRTOS Kernel V10.0.0
\r
3 * Copyright (C) 2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.
\r
5 * Permission is hereby granted, free of charge, to any person obtaining a copy of
\r
6 * this software and associated documentation files (the "Software"), to deal in
\r
7 * the Software without restriction, including without limitation the rights to
\r
8 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
\r
9 * the Software, and to permit persons to whom the Software is furnished to do so,
\r
10 * subject to the following conditions:
\r
12 * The above copyright notice and this permission notice shall be included in all
\r
13 * copies or substantial portions of the Software. If you wish to use our Amazon
\r
14 * FreeRTOS name, please do so in a fair use way that does not cause confusion.
\r
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
\r
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
\r
18 * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
\r
19 * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
\r
20 * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
\r
21 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
\r
23 * http://www.FreeRTOS.org
\r
24 * http://aws.amazon.com/freertos
\r
26 * 1 tab == 4 spaces!
\r
29 #ifndef STACK_MACROS_H
\r
30 #define STACK_MACROS_H
\r
33 * Call the stack overflow hook function if the stack of the task being swapped
\r
34 * out is currently overflowed, or looks like it might have overflowed in the
\r
37 * Setting configCHECK_FOR_STACK_OVERFLOW to 1 will cause the macro to check
\r
38 * the current stack state only - comparing the current top of stack value to
\r
39 * the stack limit. Setting configCHECK_FOR_STACK_OVERFLOW to greater than 1
\r
40 * will also cause the last few stack bytes to be checked to ensure the value
\r
41 * to which the bytes were set when the task was created have not been
\r
42 * overwritten. Note this second test does not guarantee that an overflowed
\r
43 * stack will always be recognised.
\r
46 /*-----------------------------------------------------------*/
\r
48 #if( ( configCHECK_FOR_STACK_OVERFLOW == 1 ) && ( portSTACK_GROWTH < 0 ) )
\r
50 /* Only the current stack state is to be checked. */
\r
51 #define taskCHECK_FOR_STACK_OVERFLOW() \
\r
53 /* Is the currently saved stack pointer within the stack limit? */ \
\r
54 if( pxCurrentTCB->pxTopOfStack <= pxCurrentTCB->pxStack ) \
\r
56 vApplicationStackOverflowHook( ( TaskHandle_t ) pxCurrentTCB, pxCurrentTCB->pcTaskName ); \
\r
60 #endif /* configCHECK_FOR_STACK_OVERFLOW == 1 */
\r
61 /*-----------------------------------------------------------*/
\r
63 #if( ( configCHECK_FOR_STACK_OVERFLOW == 1 ) && ( portSTACK_GROWTH > 0 ) )
\r
65 /* Only the current stack state is to be checked. */
\r
66 #define taskCHECK_FOR_STACK_OVERFLOW() \
\r
69 /* Is the currently saved stack pointer within the stack limit? */ \
\r
70 if( pxCurrentTCB->pxTopOfStack >= pxCurrentTCB->pxEndOfStack ) \
\r
72 vApplicationStackOverflowHook( ( TaskHandle_t ) pxCurrentTCB, pxCurrentTCB->pcTaskName ); \
\r
76 #endif /* configCHECK_FOR_STACK_OVERFLOW == 1 */
\r
77 /*-----------------------------------------------------------*/
\r
79 #if( ( configCHECK_FOR_STACK_OVERFLOW > 1 ) && ( portSTACK_GROWTH < 0 ) )
\r
81 #define taskCHECK_FOR_STACK_OVERFLOW() \
\r
83 const uint32_t * const pulStack = ( uint32_t * ) pxCurrentTCB->pxStack; \
\r
84 const uint32_t ulCheckValue = ( uint32_t ) 0xa5a5a5a5; \
\r
86 if( ( pulStack[ 0 ] != ulCheckValue ) || \
\r
87 ( pulStack[ 1 ] != ulCheckValue ) || \
\r
88 ( pulStack[ 2 ] != ulCheckValue ) || \
\r
89 ( pulStack[ 3 ] != ulCheckValue ) ) \
\r
91 vApplicationStackOverflowHook( ( TaskHandle_t ) pxCurrentTCB, pxCurrentTCB->pcTaskName ); \
\r
95 #endif /* #if( configCHECK_FOR_STACK_OVERFLOW > 1 ) */
\r
96 /*-----------------------------------------------------------*/
\r
98 #if( ( configCHECK_FOR_STACK_OVERFLOW > 1 ) && ( portSTACK_GROWTH > 0 ) )
\r
100 #define taskCHECK_FOR_STACK_OVERFLOW() \
\r
102 int8_t *pcEndOfStack = ( int8_t * ) pxCurrentTCB->pxEndOfStack; \
\r
103 static const uint8_t ucExpectedStackBytes[] = { tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, \
\r
104 tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, \
\r
105 tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, \
\r
106 tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, \
\r
107 tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE }; \
\r
110 pcEndOfStack -= sizeof( ucExpectedStackBytes ); \
\r
112 /* Has the extremity of the task stack ever been written over? */ \
\r
113 if( memcmp( ( void * ) pcEndOfStack, ( void * ) ucExpectedStackBytes, sizeof( ucExpectedStackBytes ) ) != 0 ) \
\r
115 vApplicationStackOverflowHook( ( TaskHandle_t ) pxCurrentTCB, pxCurrentTCB->pcTaskName ); \
\r
119 #endif /* #if( configCHECK_FOR_STACK_OVERFLOW > 1 ) */
\r
120 /*-----------------------------------------------------------*/
\r
122 /* Remove stack overflow macro if not being used. */
\r
123 #ifndef taskCHECK_FOR_STACK_OVERFLOW
\r
124 #define taskCHECK_FOR_STACK_OVERFLOW()
\r
129 #endif /* STACK_MACROS_H */
\r