blob: 41ea1d2e2434d2fb38f0433d35e8797988424af5 (
plain) (
blame)
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
|
/**
* @file
*
* @ingroup RTEMSScoreWorkspace
*
* @brief Information Related to the RAM Workspace
*
* This include file contains information related to the
* RAM Workspace. This Handler provides mechanisms which can be used to
* define, initialize and manipulate the workspace.
*/
/*
* 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>
#ifdef __cplusplus
extern "C" {
#endif
/**
* @defgroup RTEMSScoreWorkspace Workspace Handler
*
* @ingroup RTEMSScore
*
* This handler encapsulates functionality related to the management of
* the RTEMS Executive Workspace.
*
* @{
*/
/**
* @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 areas The heap area for the new workspace.
* @param area_count The number of areas for the allocation.
* @param extend The extension handler for the new workspace.
*/
void _Workspace_Handler_initialization(
Heap_Area *areas,
size_t area_count,
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 Allocates aligned memory from workspace.
*
* @param size The size of the requested memory.
* @param alignment The alignment of the requested memory.
*
* @retval other The memory area begin.
* @retval NULL Not enough resources.
*/
void *_Workspace_Allocate_aligned( size_t size, size_t alignment );
/**
* @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 Allocates workspace or fails with fatal error.
*
* This routine returns the address of a block of memory of @a size
* bytes. If a block of the appropriate size cannot be allocated
* from the workspace, then the internal error handler is invoked.
*
* @param size is the desired number of bytes to allocate
*
* @return The starting address of the allocated memory.
*/
void *_Workspace_Allocate_or_fatal_error(
size_t size
);
/**
* @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 */
|
