1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
|
/* SPDX-License-Identifier: BSD-2-Clause */
/**
* @file
*
* @ingroup RTEMSScoreStack
*
* @brief This header file provides interfaces of the
* @ref RTEMSScoreStack which are only used by the implementation.
*/
/*
* COPYRIGHT (c) 1989-2006.
* On-Line Applications Research Corporation (OAR).
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef _RTEMS_SCORE_STACKIMPL_H
#define _RTEMS_SCORE_STACKIMPL_H
#include <rtems/score/stack.h>
#include <rtems/score/context.h>
#include <rtems/score/tls.h>
#ifdef __cplusplus
extern "C" {
#endif
/**
* @addtogroup RTEMSScoreStack
*
* @{
*/
/**
* @brief Initializes stack with the given starting address and size.
*
* This routine initializes the_stack record to indicate that
* size bytes of memory starting at starting_address have been
* reserved for a stack.
*
* @param[out] the_stack The stack to initialize.
* @param starting_address The starting_address for the new stack.
* @param size The size of the stack in bytes.
*/
RTEMS_INLINE_ROUTINE void _Stack_Initialize (
Stack_Control *the_stack,
void *starting_address,
size_t size
)
{
the_stack->area = starting_address;
the_stack->size = size;
}
/**
* @brief Returns the minimum stack size.
*
* This function returns the minimum stack size configured
* for this application.
*
* @return The minimum stack size.
*/
RTEMS_INLINE_ROUTINE uint32_t _Stack_Minimum (void)
{
return rtems_minimum_stack_size;
}
/**
* @brief Checks if the size is enough for a valid stack area on this processor.
*
* This function returns true if size bytes is enough memory for
* a valid stack area on this processor, and false otherwise.
*
* @param size The stack size to check.
* @param is_fp Indicates if the stack is for a floating-point thread.
*
* @retval true @a size is large enough.
* @retval false @a size is not large enough.
*/
RTEMS_INLINE_ROUTINE bool _Stack_Is_enough(
size_t size,
bool is_fp
)
{
size_t minimum;
minimum = _TLS_Get_allocation_size();
minimum += _Stack_Minimum();
#if ( CPU_HARDWARE_FP == TRUE ) || ( CPU_SOFTWARE_FP == TRUE )
if ( is_fp ) {
minimum += CONTEXT_FP_SIZE;
}
#endif
return ( size >= minimum );
}
/**
* @brief Returns the appropriate stack size for the requested size.
*
* This function returns the appropriate stack size given the requested
* size. If the requested size is below the minimum, then the minimum
* configured stack size is returned.
*
* @param size The stack size to check.
*
* @return The appropriate stack size.
*/
RTEMS_INLINE_ROUTINE size_t _Stack_Ensure_minimum (
size_t size
)
{
if ( size >= _Stack_Minimum() )
return size;
return _Stack_Minimum();
}
/**
* @brief Extends the stack size to account for additional data structures
* allocated in the thread storage area.
*
* @param stack_size is the stack size.
*
* @param is_fp shall be true, if the stack is for a floating-point thread,
* otherwise it shall be false.
*
* @return Returns the extended stack size.
*/
RTEMS_INLINE_ROUTINE size_t _Stack_Extend_size(
size_t stack_size,
bool is_fp
)
{
size_t extra_size;
size_t allocator_overhead;
extra_size = _TLS_Get_allocation_size();
#if ( CPU_HARDWARE_FP == TRUE ) || ( CPU_SOFTWARE_FP == TRUE )
if ( is_fp ) {
/* This addition cannot overflow since the TLS size cannot be that large */
extra_size += CONTEXT_FP_SIZE;
}
#else
(void) is_fp;
#endif
/*
* In order to make sure that a user-provided stack size is the minimum which
* can be allocated for the stack, we have to align it up to the next stack
* boundary.
*/
extra_size += CPU_STACK_ALIGNMENT - 1;
/*
* If the heap allocator does not meet the stack alignment requirement, then
* we have to do the stack alignment manually in _Thread_Initialize() and
* need to allocate extra space for this.
*/
allocator_overhead = CPU_STACK_ALIGNMENT - CPU_HEAP_ALIGNMENT;
if ( stack_size > SIZE_MAX - extra_size - allocator_overhead ) {
/*
* In case of an unsigned integer overflow, saturate at the maximum value.
*/
return SIZE_MAX;
}
stack_size += extra_size;
stack_size = RTEMS_ALIGN_DOWN( stack_size, CPU_STACK_ALIGNMENT );
return stack_size + allocator_overhead;
}
/**
* @brief Allocate the requested stack space.
*
* @param stack_size The stack space that is requested.
*
* @retval stack_area The allocated stack area.
* @retval NULL The allocation failed.
*/
void *_Stack_Allocate( size_t stack_size );
/**
* @brief Free the stack area allocated by _Stack_Allocate().
*
* Do nothing if the stack area is NULL.
*
* @param stack_area The stack area to free, or NULL.
*/
void _Stack_Free( void *stack_area );
/** @} */
#ifdef __cplusplus
}
#endif
#endif
/* end of include file */
|
