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