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