blob: a3af86e878cfd5f0cee5c908fba49a8d401e3903 (
plain) (
tree)
|
|
/**
* @file
*
* @ingroup RTEMSScoreWorkspace
*
* @brief This header file provides interfaces of the
* @ref RTEMSScoreWorkspace which are only used by the implementation.
*/
/*
* COPYRIGHT (c) 1989-2009.
* On-Line Applications Research Corporation (OAR).
*
* The license and distribution terms for this file may be
* found in the file LICENSE in this distribution or at
* http://www.rtems.org/license/LICENSE.
*/
#ifndef _RTEMS_SCORE_WKSPACE_H
#define _RTEMS_SCORE_WKSPACE_H
#include <rtems/score/heap.h>
#include <rtems/score/interr.h>
#include <rtems/score/memory.h>
#ifdef __cplusplus
extern "C" {
#endif
/**
* @addtogroup RTEMSScoreWorkspace
*
* @{
*/
/**
* @brief Executive workspace control.
*
* This is the heap control structure used to manage the RTEMS Executive
* Workspace.
*/
extern Heap_Control _Workspace_Area;
/**
* @brief Initilizes the workspace handler.
*
* This routine performs the initialization necessary for this handler.
*
* @param mem The memory information
* @param extend The extension handler for the new workspace.
*/
void _Workspace_Handler_initialization(
const Memory_Information *mem,
Heap_Initialization_or_extend_handler extend
);
/**
* @brief Allocates a memory block of the specified size from the workspace.
*
* @param size The size of the memory block.
*
* @retval pointer The pointer to the memory block. The pointer is at least
* aligned by CPU_HEAP_ALIGNMENT.
* @retval NULL No memory block with the requested size is available in the
* workspace.
*/
void *_Workspace_Allocate( size_t size );
/**
* @brief Frees memory to the workspace.
*
* This function frees the specified block of memory.
*
* @param block The memory to free.
*
* @note If @a block is equal to NULL, then the request is ignored.
* This allows the caller to not worry about whether or not
* a pointer is NULL.
*/
void _Workspace_Free(
void *block
);
/**
* @brief Duplicates string with memory from the workspace.
*
* @param string The pointer to a zero terminated string.
* @param len The length of the string (equal to strlen(string)).
*
* @retval other Duplicated string.
* @retval NULL Not enough memory.
*/
char *_Workspace_String_duplicate(
const char *string,
size_t len
);
/** @} */
#ifdef __cplusplus
}
#endif
#endif
/* end of include file */
|
