rtems/score/wkspace.h

0001 /* SPDX-License-Identifier: BSD-2-Clause */
0002
0003 /**
0004  * @file
0005  *
0006  * @ingroup RTEMSScoreWorkspace
0007  *
0008  * @brief This header file provides interfaces of the
0009  *   @ref RTEMSScoreWorkspace which are only used by the implementation.
0010  */
0011
0012 /*
0013  *  COPYRIGHT (c) 1989-2009.
0014  *  On-Line Applications Research Corporation (OAR).
0015  *
0016  * Redistribution and use in source and binary forms, with or without
0017  * modification, are permitted provided that the following conditions
0018  * are met:
0019  * 1. Redistributions of source code must retain the above copyright
0020  *    notice, this list of conditions and the following disclaimer.
0021  * 2. Redistributions in binary form must reproduce the above copyright
0022  *    notice, this list of conditions and the following disclaimer in the
0023  *    documentation and/or other materials provided with the distribution.
0024  *
0025  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
0026  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
0027  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
0028  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
0029  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
0030  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
0031  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
0032  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
0033  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
0034  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
0035  * POSSIBILITY OF SUCH DAMAGE.
0036  */
0037
0038 #ifndef _RTEMS_SCORE_WKSPACE_H
0039 #define _RTEMS_SCORE_WKSPACE_H
0040
0041 #include <rtems/score/heap.h>
0042
0043 #ifdef __cplusplus
0044 extern "C" {
0045 #endif
0046
0047 /**
0048  * @addtogroup RTEMSScoreWorkspace
0049  *
0050  * @{
0051  */
0052
0053 /**
0054  *  @brief Executive workspace control.
0055  *
0056  *  This is the heap control structure used to manage the RTEMS Executive
0057  *  Workspace.
0058  */
0059 extern Heap_Control _Workspace_Area;
0060
0061 /**
0062  * @brief Initializes the workspace handler.
0063  *
0064  * This routine performs the initialization necessary for this handler.
0065  */
0066 void _Workspace_Handler_initialization( void );
0067
0068 /**
0069  * @brief Allocates a memory block of the specified size from the workspace.
0070  *
0071  * @param size The size of the memory block.
0072  *
0073  * @retval pointer The pointer to the memory block.  The pointer is at least
0074  *   aligned by CPU_HEAP_ALIGNMENT.
0075  * @retval NULL No memory block with the requested size is available in the
0076  *   workspace.
0077  */
0078 void *_Workspace_Allocate( size_t size );
0079
0080 /**
0081  * @brief Frees memory to the workspace.
0082  *
0083  * This function frees the specified block of memory.
0084  *
0085  * @param block The memory to free.
0086  *
0087  * @note If @a block is equal to NULL, then the request is ignored.
0088  *        This allows the caller to not worry about whether or not
0089  *        a pointer is NULL.
0090  */
0091 void _Workspace_Free(
0092   void *block
0093 );
0094
0095 /**
0096  * @brief Duplicates string with memory from the workspace.
0097  *
0098  * @param string The pointer to a zero terminated string.
0099  * @param len The length of the string (equal to strlen(string)).
0100  *
0101  * @retval other Duplicated string.
0102  * @retval NULL Not enough memory.
0103  */
0104 char *_Workspace_String_duplicate(
0105   const char *string,
0106   size_t len
0107 );
0108
0109 /** @} */
0110
0111 #ifdef __cplusplus
0112 }
0113 #endif
0114
0115 #endif
0116 /* end of include file */