RTEMS CPU Kit with SuperCore  4.11.3
Data Structures | Macros | Functions | Variables
Stack Handler

This handler encapsulates functionality which is used in the management of thread stacks. More...

Collaboration diagram for Stack Handler:

Data Structures

struct  Stack_Control
 The following defines the control block used to manage each stack. More...
 

Macros

#define STACK_MINIMUM_SIZE   CPU_STACK_MINIMUM_SIZE
 The following constant defines the minimum stack size which every thread must exceed.
 

Functions

RTEMS_INLINE_ROUTINE void _Stack_Initialize (Stack_Control *the_stack, void *starting_address, size_t size)
 This routine initializes the_stack record to indicate that size bytes of memory starting at starting_address have been reserved for a stack.
 
RTEMS_INLINE_ROUTINE uint32_t _Stack_Minimum (void)
 This function returns the minimum stack size configured for this application. More...
 
RTEMS_INLINE_ROUTINE bool _Stack_Is_enough (size_t size)
 This function returns true if size bytes is enough memory for a valid stack area on this processor, and false otherwise. More...
 
RTEMS_INLINE_ROUTINE size_t _Stack_Ensure_minimum (size_t size)
 This function returns the appropriate stack size given the requested size. More...
 

Variables

uint32_t rtems_minimum_stack_size
 This variable contains the the minimum stack size;. More...
 

Detailed Description

This handler encapsulates functionality which is used in the management of thread stacks.

Function Documentation

◆ _Stack_Ensure_minimum()

RTEMS_INLINE_ROUTINE size_t _Stack_Ensure_minimum ( size_t  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.

Parameters
[in]sizeis the stack size to check
Returns
This method returns the appropriate stack size.

◆ _Stack_Is_enough()

RTEMS_INLINE_ROUTINE bool _Stack_Is_enough ( size_t  size)

This function returns true if size bytes is enough memory for a valid stack area on this processor, and false otherwise.

Parameters
[in]sizeis the stack size to check
Returns
This method returns true if the stack is large enough.

◆ _Stack_Minimum()

RTEMS_INLINE_ROUTINE uint32_t _Stack_Minimum ( void  )

This function returns the minimum stack size configured for this application.

Returns
This method returns the minimum stack size;

References rtems_minimum_stack_size.

Variable Documentation

◆ rtems_minimum_stack_size

uint32_t rtems_minimum_stack_size

This variable contains the the minimum stack size;.

Note
It is instantiated and set by User Configuration via confdefs.h.

Referenced by _Stack_Minimum().