Workspace Handler

Functions
void	_Workspace_Handler_initialization (void *starting_address, size_t size)
	Workspace Handler Initialization.
void *	_Workspace_Allocate (size_t size)
	Allocate Memory from Workspace.
boolean	_Workspace_Free (void *block)
	Free Memory to the Workspace.
void *	_Workspace_Allocate_or_fatal_error (size_t size)
	Workspace Allocate or Fail with Fatal Error.
Variables
SCORE_EXTERN Heap_Control	_Workspace_Area
	Executive Workspace Control.

---

Detailed Description

This handler encapsulates functionality related to the management of the RTEMS Executive Workspace.

---

Function Documentation

void* _Workspace_Allocate

(

size_t

size

)

Allocate Memory from Workspace.

This routine returns the address of a block of memory of size bytes. If a block of the appropriate size cannot be allocated from the workspace, then NULL is returned.

Parameters:

size

is the requested size

Returns:

a pointer to the requested memory or NULL.

void* _Workspace_Allocate_or_fatal_error

(

size_t

size

)

Workspace Allocate or Fail with Fatal Error.

This routine returns the address of a block of memory of size bytes. If a block of the appropriate size cannot be allocated from the workspace, then the internal error handler is invoked.

Parameters:

[in]

size

is the desired number of bytes to allocate

Returns:

If successful, the starting address of the allocated memory

boolean _Workspace_Free

(

void *

block

)

Free Memory to the Workspace.

This function frees the specified block of memory. If the block belongs to the Workspace and can be successfully freed, then TRUE is returned. Otherwise FALSE is returned.

Parameters:

block

is the memory to free

Returns:

TRUE if the free was successful.

void _Workspace_Handler_initialization	(	void *	starting_address,
		size_t	size
	)

Workspace Handler Initialization.

This routine performs the initialization necessary for this handler.

Parameters:

[in]	starting_address	is the base address of the RTEMS Executive Workspace
[in]	size	is the number of bytes in the RTEMS Executive Workspace

---

Variable Documentation

SCORE_EXTERN Heap_Control _Workspace_Area

Executive Workspace Control.

The is the heap control structure that used to manage the RTEMS Executive Workspace.