1 | /** |
---|
2 | * @file |
---|
3 | * |
---|
4 | * @ingroup RTEMSScoreStack |
---|
5 | * |
---|
6 | * @brief This header file provides interfaces of the |
---|
7 | * @ref RTEMSScoreStack which are only used by the implementation. |
---|
8 | */ |
---|
9 | |
---|
10 | /* |
---|
11 | * COPYRIGHT (c) 1989-2006. |
---|
12 | * On-Line Applications Research Corporation (OAR). |
---|
13 | * |
---|
14 | * The license and distribution terms for this file may be |
---|
15 | * found in the file LICENSE in this distribution or at |
---|
16 | * http://www.rtems.org/license/LICENSE. |
---|
17 | */ |
---|
18 | |
---|
19 | #ifndef _RTEMS_SCORE_STACKIMPL_H |
---|
20 | #define _RTEMS_SCORE_STACKIMPL_H |
---|
21 | |
---|
22 | #include <rtems/score/stack.h> |
---|
23 | #include <rtems/score/context.h> |
---|
24 | #include <rtems/score/tls.h> |
---|
25 | |
---|
26 | #ifdef __cplusplus |
---|
27 | extern "C" { |
---|
28 | #endif |
---|
29 | |
---|
30 | /** |
---|
31 | * @addtogroup RTEMSScoreStack |
---|
32 | * |
---|
33 | * @{ |
---|
34 | */ |
---|
35 | |
---|
36 | /** |
---|
37 | * @brief Initializes stack with the given starting address and size. |
---|
38 | * |
---|
39 | * This routine initializes the_stack record to indicate that |
---|
40 | * size bytes of memory starting at starting_address have been |
---|
41 | * reserved for a stack. |
---|
42 | * |
---|
43 | * @param[out] the_stack The stack to initialize. |
---|
44 | * @param starting_address The starting_address for the new stack. |
---|
45 | * @param size The size of the stack in bytes. |
---|
46 | */ |
---|
47 | RTEMS_INLINE_ROUTINE void _Stack_Initialize ( |
---|
48 | Stack_Control *the_stack, |
---|
49 | void *starting_address, |
---|
50 | size_t size |
---|
51 | ) |
---|
52 | { |
---|
53 | the_stack->area = starting_address; |
---|
54 | the_stack->size = size; |
---|
55 | } |
---|
56 | |
---|
57 | /** |
---|
58 | * @brief Returns the minimum stack size. |
---|
59 | * |
---|
60 | * This function returns the minimum stack size configured |
---|
61 | * for this application. |
---|
62 | * |
---|
63 | * @return The minimum stack size. |
---|
64 | */ |
---|
65 | RTEMS_INLINE_ROUTINE uint32_t _Stack_Minimum (void) |
---|
66 | { |
---|
67 | return rtems_minimum_stack_size; |
---|
68 | } |
---|
69 | |
---|
70 | /** |
---|
71 | * @brief Checks if the size is enough for a valid stack area on this processor. |
---|
72 | * |
---|
73 | * This function returns true if size bytes is enough memory for |
---|
74 | * a valid stack area on this processor, and false otherwise. |
---|
75 | * |
---|
76 | * @param size The stack size to check. |
---|
77 | * @param is_fp Indicates if the stack is for a floating-point thread. |
---|
78 | * |
---|
79 | * @retval true @a size is large enough. |
---|
80 | * @retval false @a size is not large enough. |
---|
81 | */ |
---|
82 | RTEMS_INLINE_ROUTINE bool _Stack_Is_enough( |
---|
83 | size_t size, |
---|
84 | bool is_fp |
---|
85 | ) |
---|
86 | { |
---|
87 | size_t minimum; |
---|
88 | |
---|
89 | minimum = _TLS_Get_allocation_size(); |
---|
90 | minimum += _Stack_Minimum(); |
---|
91 | |
---|
92 | #if ( CPU_HARDWARE_FP == TRUE ) || ( CPU_SOFTWARE_FP == TRUE ) |
---|
93 | if ( is_fp ) { |
---|
94 | minimum += CONTEXT_FP_SIZE; |
---|
95 | } |
---|
96 | #endif |
---|
97 | |
---|
98 | return ( size >= minimum ); |
---|
99 | } |
---|
100 | |
---|
101 | /** |
---|
102 | * @brief Returns the appropriate stack size for the requested size. |
---|
103 | * |
---|
104 | * This function returns the appropriate stack size given the requested |
---|
105 | * size. If the requested size is below the minimum, then the minimum |
---|
106 | * configured stack size is returned. |
---|
107 | * |
---|
108 | * @param size The stack size to check. |
---|
109 | * |
---|
110 | * @return The appropriate stack size. |
---|
111 | */ |
---|
112 | RTEMS_INLINE_ROUTINE size_t _Stack_Ensure_minimum ( |
---|
113 | size_t size |
---|
114 | ) |
---|
115 | { |
---|
116 | if ( size >= _Stack_Minimum() ) |
---|
117 | return size; |
---|
118 | return _Stack_Minimum(); |
---|
119 | } |
---|
120 | |
---|
121 | /** |
---|
122 | * @brief Extend the stack size to account for additional data structures |
---|
123 | * allocated in the stack area of a thread. |
---|
124 | * |
---|
125 | * @param stack_size The stack size. |
---|
126 | * @param is_fp Indicates if the stack is for a floating-point thread. |
---|
127 | * |
---|
128 | * @return The extended stack size. |
---|
129 | */ |
---|
130 | RTEMS_INLINE_ROUTINE size_t _Stack_Extend_size( |
---|
131 | size_t stack_size, |
---|
132 | bool is_fp |
---|
133 | ) |
---|
134 | { |
---|
135 | #if ( CPU_HARDWARE_FP == TRUE ) || ( CPU_SOFTWARE_FP == TRUE ) |
---|
136 | if ( is_fp ) { |
---|
137 | stack_size += CONTEXT_FP_SIZE; |
---|
138 | } |
---|
139 | #else |
---|
140 | (void) is_fp; |
---|
141 | #endif |
---|
142 | |
---|
143 | stack_size += _TLS_Get_allocation_size(); |
---|
144 | |
---|
145 | return stack_size; |
---|
146 | } |
---|
147 | |
---|
148 | /** |
---|
149 | * @brief Allocate the requested stack space. |
---|
150 | * |
---|
151 | * @param stack_size The stack space that is requested. |
---|
152 | * |
---|
153 | * @retval stack_area The allocated stack area. |
---|
154 | * @retval NULL The allocation failed. |
---|
155 | */ |
---|
156 | void *_Stack_Allocate( size_t stack_size ); |
---|
157 | |
---|
158 | /** |
---|
159 | * @brief Free the stack area allocated by _Stack_Allocate(). |
---|
160 | * |
---|
161 | * Do nothing if the stack area is NULL. |
---|
162 | * |
---|
163 | * @param stack_area The stack area to free, or NULL. |
---|
164 | */ |
---|
165 | void _Stack_Free( void *stack_area ); |
---|
166 | |
---|
167 | /** |
---|
168 | * @brief This function does nothing. |
---|
169 | * |
---|
170 | * @param stack_area is not used. |
---|
171 | */ |
---|
172 | void _Stack_Free_nothing( void *stack_area ); |
---|
173 | |
---|
174 | /** @} */ |
---|
175 | |
---|
176 | #ifdef __cplusplus |
---|
177 | } |
---|
178 | #endif |
---|
179 | |
---|
180 | #endif |
---|
181 | /* end of include file */ |
---|