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
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
|
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2008 by Sun Microsystems, Inc.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* $RCSfile: alloc.h,v $
* $Revision: 1.9 $
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef _RTL_ALLOC_H_
#define _RTL_ALLOC_H_
# include <sal/types.h>
#ifdef __cplusplus
extern "C" {
#endif
/** Allocate memory.
@descr A call to this function will return NULL upon the requested
memory size being either zero or larger than currently allocatable.
@param Bytes [in] memory size.
@return pointer to allocated memory.
*/
void * SAL_CALL rtl_allocateMemory (
sal_Size Bytes
) SAL_THROW_EXTERN_C();
/** Reallocate memory.
@descr A call to this function with parameter 'Ptr' being NULL
is equivalent to a rtl_allocateMemory() call.
A call to this function with parameter 'Bytes' being 0
is equivalent to a rtl_freeMemory() call.
@see rtl_allocateMemory()
@see rtl_freeMemory()
@param Ptr [in] pointer to previously allocated memory.
@param Bytes [in] new memory size.
@return pointer to reallocated memory. May differ from Ptr.
*/
void * SAL_CALL rtl_reallocateMemory (
void * Ptr,
sal_Size Bytes
) SAL_THROW_EXTERN_C();
/** Free memory.
@param Ptr [in] pointer to previously allocated memory.
@return none. Memory is released. Ptr is invalid.
*/
void SAL_CALL rtl_freeMemory (
void * Ptr
) SAL_THROW_EXTERN_C();
/** Allocate and zero memory.
@descr A call to this function will return NULL upon the requested
memory size being either zero or larger than currently allocatable.
@param Bytes [in] memory size.
@return pointer to allocated and zero'ed memory.
*/
void * SAL_CALL rtl_allocateZeroMemory (
sal_Size Bytes
) SAL_THROW_EXTERN_C();
/** Zero and free memory.
@param Ptr [in] pointer to previously allocated memory.
@param Bytes [in] memory size.
@return none. Memory is zero'ed and released. Ptr is invalid.
*/
void SAL_CALL rtl_freeZeroMemory (
void * Ptr,
sal_Size Bytes
) SAL_THROW_EXTERN_C();
/** Opaque rtl_arena_type.
*/
typedef struct rtl_arena_st rtl_arena_type;
#define RTL_ARENA_NAME_LENGTH 31
/** rtl_arena_create()
*
* @param pName [in] descriptive name; for debugging purposes.
* @param quantum [in] resource allocation unit / granularity; rounded up to next power of 2.
* @param quantum_cache_max [in] max resources to cache; rounded up to next multiple of quantum; usually 0.
* @param source_arena [in] passed as argument to source_alloc, source_free; usually NULL.
* @param source_alloc [in] function to allocate resources; usually rtl_arena_alloc.
* @param source_free [in] function to free resources; usually rtl_arena_free.
* @param nFlags [in] flags; usually 0.
*
* @return pointer to rtl_arena_type, or NULL upon failure.
*
* @see rtl_arena_destroy()
*/
rtl_arena_type *
SAL_CALL rtl_arena_create (
const char * pName,
sal_Size quantum,
sal_Size quantum_cache_max,
rtl_arena_type * source_arena,
void * (SAL_CALL * source_alloc)(rtl_arena_type *, sal_Size *),
void (SAL_CALL * source_free) (rtl_arena_type *, void *, sal_Size),
int nFlags
) SAL_THROW_EXTERN_C();
/** rtl_arena_destroy()
*
* @param pArena [in] the arena to destroy.
* @return None
*
* @see rtl_arena_create()
*/
void
SAL_CALL rtl_arena_destroy (
rtl_arena_type * pArena
) SAL_THROW_EXTERN_C();
/** rtl_arena_alloc()
*
* @param pArena [in] arena from which resource is allocated.
* @param pBytes [inout] size of resource to allocate.
*
* @return allocated resource, or NULL upon failure.
*
* @see rtl_arena_free()
*/
void *
SAL_CALL rtl_arena_alloc (
rtl_arena_type * pArena,
sal_Size * pBytes
) SAL_THROW_EXTERN_C();
/** rtl_arena_free()
*
* @param pArena [in] arena from which resource was allocated.
* @param pAddr [in] resource to free.
* @param nBytes [in] size of resource.
*
* @return None.
*
* @see rtl_arena_alloc()
*/
void
SAL_CALL rtl_arena_free (
rtl_arena_type * pArena,
void * pAddr,
sal_Size nBytes
) SAL_THROW_EXTERN_C();
/** Opaque rtl_cache_type.
*/
typedef struct rtl_cache_st rtl_cache_type;
#define RTL_CACHE_NAME_LENGTH 31
#define RTL_CACHE_FLAG_BULKDESTROY 1
/** rtl_cache_create()
*
* @param pName [in] descriptive name; for debugging purposes.
* @param nObjSize [in] object size.
* @param nObjAlign [in] object alignment; usually 0 for suitable default.
* @param constructor [in] object constructor callback function; returning 1 for success or 0 for failure.
* @param destructor [in] object destructor callback function.
* @param reclaim [in] reclaim callback function.
* @param pUserArg [in] opaque argument passed to callback functions.
* @param nFlags [in] flags.
*
* @return pointer to rtl_cache_type, or NULL upon failure.
*
* @see rtl_cache_destroy()
*/
rtl_cache_type *
SAL_CALL rtl_cache_create (
const char * pName,
sal_Size nObjSize,
sal_Size nObjAlign,
int (SAL_CALL * constructor)(void * pObj, void * pUserArg),
void (SAL_CALL * destructor) (void * pObj, void * pUserArg),
void (SAL_CALL * reclaim) (void * pUserArg),
void * pUserArg,
rtl_arena_type * pSource,
int nFlags
) SAL_THROW_EXTERN_C();
/** rtl_cache_destroy()
*
* @param pCache [in] the cache to destroy.
*
* @return None.
*
* @see rtl_cache_create()
*/
void
SAL_CALL rtl_cache_destroy (
rtl_cache_type * pCache
) SAL_THROW_EXTERN_C();
/** rtl_cache_alloc()
*
* @param pCache [in] cache from which object is allocated.
*
* @return pointer to allocated object, or NULL upon failure.
*/
void *
SAL_CALL rtl_cache_alloc (
rtl_cache_type * pCache
) SAL_THROW_EXTERN_C();
/** rtl_cache_free()
*
* @param pCache [in] cache from which object was allocated.
* @param pObj [in] object to free.
*
* @return None.
*
* @see rtl_cache_alloc()
*/
void
SAL_CALL rtl_cache_free (
rtl_cache_type * pCache,
void * pObj
) SAL_THROW_EXTERN_C();
#ifdef __cplusplus
}
#endif
#endif /*_RTL_ALLOC_H_ */
|
