stack_macros.h 8.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129
  1. /*
  2. * FreeRTOS Kernel V10.4.4
  3. * Copyright (C) 2021 Amazon.com, Inc. or its affiliates. All Rights Reserved.
  4. *
  5. * SPDX-License-Identifier: MIT
  6. *
  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
  15. * copies or substantial portions of the Software.
  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. *
  24. * https://www.FreeRTOS.org
  25. * https://github.com/FreeRTOS
  26. *
  27. */
  28. #ifndef STACK_MACROS_H
  29. #define STACK_MACROS_H
  30. /*
  31. * Call the stack overflow hook function if the stack of the task being swapped
  32. * out is currently overflowed, or looks like it might have overflowed in the
  33. * past.
  34. *
  35. * Setting configCHECK_FOR_STACK_OVERFLOW to 1 will cause the macro to check
  36. * the current stack state only - comparing the current top of stack value to
  37. * the stack limit. Setting configCHECK_FOR_STACK_OVERFLOW to greater than 1
  38. * will also cause the last few stack bytes to be checked to ensure the value
  39. * to which the bytes were set when the task was created have not been
  40. * overwritten. Note this second test does not guarantee that an overflowed
  41. * stack will always be recognised.
  42. */
  43. /*-----------------------------------------------------------*/
  44. #if ( ( configCHECK_FOR_STACK_OVERFLOW == 1 ) && ( portSTACK_GROWTH < 0 ) )
  45. /* Only the current stack state is to be checked. */
  46. #define taskCHECK_FOR_STACK_OVERFLOW() \
  47. { \
  48. /* Is the currently saved stack pointer within the stack limit? */ \
  49. if( pxCurrentTCB->pxTopOfStack <= pxCurrentTCB->pxStack ) \
  50. { \
  51. vApplicationStackOverflowHook( ( TaskHandle_t ) pxCurrentTCB, pxCurrentTCB->pcTaskName ); \
  52. } \
  53. }
  54. #endif /* configCHECK_FOR_STACK_OVERFLOW == 1 */
  55. /*-----------------------------------------------------------*/
  56. #if ( ( configCHECK_FOR_STACK_OVERFLOW == 1 ) && ( portSTACK_GROWTH > 0 ) )
  57. /* Only the current stack state is to be checked. */
  58. #define taskCHECK_FOR_STACK_OVERFLOW() \
  59. { \
  60. \
  61. /* Is the currently saved stack pointer within the stack limit? */ \
  62. if( pxCurrentTCB->pxTopOfStack >= pxCurrentTCB->pxEndOfStack ) \
  63. { \
  64. vApplicationStackOverflowHook( ( TaskHandle_t ) pxCurrentTCB, pxCurrentTCB->pcTaskName ); \
  65. } \
  66. }
  67. #endif /* configCHECK_FOR_STACK_OVERFLOW == 1 */
  68. /*-----------------------------------------------------------*/
  69. #if ( ( configCHECK_FOR_STACK_OVERFLOW > 1 ) && ( portSTACK_GROWTH < 0 ) )
  70. #define taskCHECK_FOR_STACK_OVERFLOW() \
  71. { \
  72. const uint32_t * const pulStack = ( uint32_t * ) pxCurrentTCB->pxStack; \
  73. const uint32_t ulCheckValue = ( uint32_t ) 0xa5a5a5a5; \
  74. \
  75. if( ( pulStack[ 0 ] != ulCheckValue ) || \
  76. ( pulStack[ 1 ] != ulCheckValue ) || \
  77. ( pulStack[ 2 ] != ulCheckValue ) || \
  78. ( pulStack[ 3 ] != ulCheckValue ) ) \
  79. { \
  80. vApplicationStackOverflowHook( ( TaskHandle_t ) pxCurrentTCB, pxCurrentTCB->pcTaskName ); \
  81. } \
  82. }
  83. #endif /* #if( configCHECK_FOR_STACK_OVERFLOW > 1 ) */
  84. /*-----------------------------------------------------------*/
  85. #if ( ( configCHECK_FOR_STACK_OVERFLOW > 1 ) && ( portSTACK_GROWTH > 0 ) )
  86. #define taskCHECK_FOR_STACK_OVERFLOW() \
  87. { \
  88. int8_t * pcEndOfStack = ( int8_t * ) pxCurrentTCB->pxEndOfStack; \
  89. static const uint8_t ucExpectedStackBytes[] = { tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, \
  90. tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, \
  91. tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, \
  92. tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, \
  93. tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE }; \
  94. \
  95. \
  96. pcEndOfStack -= sizeof( ucExpectedStackBytes ); \
  97. \
  98. /* Has the extremity of the task stack ever been written over? */ \
  99. if( memcmp( ( void * ) pcEndOfStack, ( void * ) ucExpectedStackBytes, sizeof( ucExpectedStackBytes ) ) != 0 ) \
  100. { \
  101. vApplicationStackOverflowHook( ( TaskHandle_t ) pxCurrentTCB, pxCurrentTCB->pcTaskName ); \
  102. } \
  103. }
  104. #endif /* #if( configCHECK_FOR_STACK_OVERFLOW > 1 ) */
  105. /*-----------------------------------------------------------*/
  106. /* Remove stack overflow macro if not being used. */
  107. #ifndef taskCHECK_FOR_STACK_OVERFLOW
  108. #define taskCHECK_FOR_STACK_OVERFLOW()
  109. #endif
  110. #endif /* STACK_MACROS_H */