Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | /****************************************************************************** |
2 | * | |
73459f73 | 3 | * Module Name: utalloc - local memory allocation routines |
1da177e4 LT |
4 | * |
5 | *****************************************************************************/ | |
6 | ||
7 | /* | |
4a90c7e8 | 8 | * Copyright (C) 2000 - 2006, R. Byron Moore |
1da177e4 LT |
9 | * All rights reserved. |
10 | * | |
11 | * Redistribution and use in source and binary forms, with or without | |
12 | * modification, are permitted provided that the following conditions | |
13 | * are met: | |
14 | * 1. Redistributions of source code must retain the above copyright | |
15 | * notice, this list of conditions, and the following disclaimer, | |
16 | * without modification. | |
17 | * 2. Redistributions in binary form must reproduce at minimum a disclaimer | |
18 | * substantially similar to the "NO WARRANTY" disclaimer below | |
19 | * ("Disclaimer") and any redistribution must be conditioned upon | |
20 | * including a substantially similar Disclaimer requirement for further | |
21 | * binary redistribution. | |
22 | * 3. Neither the names of the above-listed copyright holders nor the names | |
23 | * of any contributors may be used to endorse or promote products derived | |
24 | * from this software without specific prior written permission. | |
25 | * | |
26 | * Alternatively, this software may be distributed under the terms of the | |
27 | * GNU General Public License ("GPL") version 2 as published by the Free | |
28 | * Software Foundation. | |
29 | * | |
30 | * NO WARRANTY | |
31 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS | |
32 | * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT | |
33 | * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR | |
34 | * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT | |
35 | * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL | |
36 | * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS | |
37 | * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | |
38 | * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, | |
39 | * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING | |
40 | * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE | |
41 | * POSSIBILITY OF SUCH DAMAGES. | |
42 | */ | |
43 | ||
1da177e4 LT |
44 | #include <acpi/acpi.h> |
45 | ||
46 | #define _COMPONENT ACPI_UTILITIES | |
4be44fcd | 47 | ACPI_MODULE_NAME("utalloc") |
1da177e4 | 48 | |
44f6c012 | 49 | /******************************************************************************* |
1da177e4 | 50 | * |
73459f73 | 51 | * FUNCTION: acpi_ut_create_caches |
1da177e4 | 52 | * |
73459f73 | 53 | * PARAMETERS: None |
1da177e4 | 54 | * |
73459f73 | 55 | * RETURN: Status |
1da177e4 | 56 | * |
73459f73 | 57 | * DESCRIPTION: Create all local caches |
1da177e4 LT |
58 | * |
59 | ******************************************************************************/ | |
4be44fcd | 60 | acpi_status acpi_ut_create_caches(void) |
1da177e4 | 61 | { |
4be44fcd | 62 | acpi_status status; |
1da177e4 | 63 | |
73459f73 | 64 | /* Object Caches, for frequently used objects */ |
1da177e4 | 65 | |
4be44fcd | 66 | status = |
61686124 BM |
67 | acpi_os_create_cache("Acpi-Namespace", |
68 | sizeof(struct acpi_namespace_node), | |
69 | ACPI_MAX_NAMESPACE_CACHE_DEPTH, | |
70 | &acpi_gbl_namespace_cache); | |
71 | if (ACPI_FAILURE(status)) { | |
72 | return (status); | |
73 | } | |
74 | ||
75 | status = | |
76 | acpi_os_create_cache("Acpi-State", sizeof(union acpi_generic_state), | |
4be44fcd LB |
77 | ACPI_MAX_STATE_CACHE_DEPTH, |
78 | &acpi_gbl_state_cache); | |
79 | if (ACPI_FAILURE(status)) { | |
73459f73 | 80 | return (status); |
1da177e4 LT |
81 | } |
82 | ||
4be44fcd | 83 | status = |
61686124 | 84 | acpi_os_create_cache("Acpi-Parse", |
4be44fcd LB |
85 | sizeof(struct acpi_parse_obj_common), |
86 | ACPI_MAX_PARSE_CACHE_DEPTH, | |
87 | &acpi_gbl_ps_node_cache); | |
88 | if (ACPI_FAILURE(status)) { | |
73459f73 | 89 | return (status); |
1da177e4 LT |
90 | } |
91 | ||
4be44fcd | 92 | status = |
b229cf92 | 93 | acpi_os_create_cache("Acpi-ParseExt", |
4be44fcd LB |
94 | sizeof(struct acpi_parse_obj_named), |
95 | ACPI_MAX_EXTPARSE_CACHE_DEPTH, | |
96 | &acpi_gbl_ps_node_ext_cache); | |
97 | if (ACPI_FAILURE(status)) { | |
73459f73 RM |
98 | return (status); |
99 | } | |
1da177e4 | 100 | |
4be44fcd | 101 | status = |
61686124 | 102 | acpi_os_create_cache("Acpi-Operand", |
4be44fcd LB |
103 | sizeof(union acpi_operand_object), |
104 | ACPI_MAX_OBJECT_CACHE_DEPTH, | |
105 | &acpi_gbl_operand_cache); | |
106 | if (ACPI_FAILURE(status)) { | |
73459f73 RM |
107 | return (status); |
108 | } | |
1da177e4 | 109 | |
4119532c BM |
110 | #ifdef ACPI_DBG_TRACK_ALLOCATIONS |
111 | ||
112 | /* Memory allocation lists */ | |
113 | ||
114 | status = acpi_ut_create_list("Acpi-Global", 0, &acpi_gbl_global_list); | |
115 | if (ACPI_FAILURE(status)) { | |
116 | return (status); | |
117 | } | |
118 | ||
119 | status = | |
120 | acpi_ut_create_list("Acpi-Namespace", | |
121 | sizeof(struct acpi_namespace_node), | |
122 | &acpi_gbl_ns_node_list); | |
123 | if (ACPI_FAILURE(status)) { | |
124 | return (status); | |
125 | } | |
126 | #endif | |
127 | ||
73459f73 | 128 | return (AE_OK); |
1da177e4 LT |
129 | } |
130 | ||
44f6c012 | 131 | /******************************************************************************* |
1da177e4 | 132 | * |
73459f73 | 133 | * FUNCTION: acpi_ut_delete_caches |
1da177e4 | 134 | * |
73459f73 | 135 | * PARAMETERS: None |
1da177e4 | 136 | * |
73459f73 | 137 | * RETURN: Status |
1da177e4 | 138 | * |
73459f73 | 139 | * DESCRIPTION: Purge and delete all local caches |
1da177e4 LT |
140 | * |
141 | ******************************************************************************/ | |
142 | ||
4be44fcd | 143 | acpi_status acpi_ut_delete_caches(void) |
1da177e4 | 144 | { |
1da177e4 | 145 | |
61686124 BM |
146 | (void)acpi_os_delete_cache(acpi_gbl_namespace_cache); |
147 | acpi_gbl_namespace_cache = NULL; | |
148 | ||
4be44fcd | 149 | (void)acpi_os_delete_cache(acpi_gbl_state_cache); |
73459f73 | 150 | acpi_gbl_state_cache = NULL; |
1da177e4 | 151 | |
4be44fcd | 152 | (void)acpi_os_delete_cache(acpi_gbl_operand_cache); |
73459f73 | 153 | acpi_gbl_operand_cache = NULL; |
1da177e4 | 154 | |
4be44fcd | 155 | (void)acpi_os_delete_cache(acpi_gbl_ps_node_cache); |
73459f73 | 156 | acpi_gbl_ps_node_cache = NULL; |
1da177e4 | 157 | |
4be44fcd | 158 | (void)acpi_os_delete_cache(acpi_gbl_ps_node_ext_cache); |
73459f73 | 159 | acpi_gbl_ps_node_ext_cache = NULL; |
1da177e4 | 160 | |
4119532c BM |
161 | #ifdef ACPI_DBG_TRACK_ALLOCATIONS |
162 | ||
163 | /* Debug only - display leftover memory allocation, if any */ | |
164 | ||
165 | acpi_ut_dump_allocations(ACPI_UINT32_MAX, NULL); | |
166 | ||
167 | /* Free memory lists */ | |
168 | ||
169 | acpi_os_free(acpi_gbl_global_list); | |
170 | acpi_gbl_global_list = NULL; | |
171 | ||
172 | acpi_os_free(acpi_gbl_ns_node_list); | |
173 | acpi_gbl_ns_node_list = NULL; | |
174 | #endif | |
175 | ||
73459f73 | 176 | return (AE_OK); |
1da177e4 | 177 | } |
1da177e4 LT |
178 | |
179 | /******************************************************************************* | |
180 | * | |
181 | * FUNCTION: acpi_ut_validate_buffer | |
182 | * | |
183 | * PARAMETERS: Buffer - Buffer descriptor to be validated | |
184 | * | |
185 | * RETURN: Status | |
186 | * | |
187 | * DESCRIPTION: Perform parameter validation checks on an struct acpi_buffer | |
188 | * | |
189 | ******************************************************************************/ | |
190 | ||
4be44fcd | 191 | acpi_status acpi_ut_validate_buffer(struct acpi_buffer * buffer) |
1da177e4 LT |
192 | { |
193 | ||
194 | /* Obviously, the structure pointer must be valid */ | |
195 | ||
196 | if (!buffer) { | |
197 | return (AE_BAD_PARAMETER); | |
198 | } | |
199 | ||
200 | /* Special semantics for the length */ | |
201 | ||
4be44fcd LB |
202 | if ((buffer->length == ACPI_NO_BUFFER) || |
203 | (buffer->length == ACPI_ALLOCATE_BUFFER) || | |
204 | (buffer->length == ACPI_ALLOCATE_LOCAL_BUFFER)) { | |
1da177e4 LT |
205 | return (AE_OK); |
206 | } | |
207 | ||
208 | /* Length is valid, the buffer pointer must be also */ | |
209 | ||
210 | if (!buffer->pointer) { | |
211 | return (AE_BAD_PARAMETER); | |
212 | } | |
213 | ||
214 | return (AE_OK); | |
215 | } | |
216 | ||
1da177e4 LT |
217 | /******************************************************************************* |
218 | * | |
219 | * FUNCTION: acpi_ut_initialize_buffer | |
220 | * | |
221 | * PARAMETERS: Buffer - Buffer to be validated | |
222 | * required_length - Length needed | |
223 | * | |
224 | * RETURN: Status | |
225 | * | |
226 | * DESCRIPTION: Validate that the buffer is of the required length or | |
227 | * allocate a new buffer. Returned buffer is always zeroed. | |
228 | * | |
229 | ******************************************************************************/ | |
230 | ||
231 | acpi_status | |
4be44fcd LB |
232 | acpi_ut_initialize_buffer(struct acpi_buffer * buffer, |
233 | acpi_size required_length) | |
1da177e4 | 234 | { |
4be44fcd | 235 | acpi_status status = AE_OK; |
1da177e4 LT |
236 | |
237 | switch (buffer->length) { | |
238 | case ACPI_NO_BUFFER: | |
239 | ||
240 | /* Set the exception and returned the required length */ | |
241 | ||
242 | status = AE_BUFFER_OVERFLOW; | |
243 | break; | |
244 | ||
1da177e4 LT |
245 | case ACPI_ALLOCATE_BUFFER: |
246 | ||
247 | /* Allocate a new buffer */ | |
248 | ||
4be44fcd | 249 | buffer->pointer = acpi_os_allocate(required_length); |
1da177e4 LT |
250 | if (!buffer->pointer) { |
251 | return (AE_NO_MEMORY); | |
252 | } | |
253 | ||
254 | /* Clear the buffer */ | |
255 | ||
4be44fcd | 256 | ACPI_MEMSET(buffer->pointer, 0, required_length); |
1da177e4 LT |
257 | break; |
258 | ||
1da177e4 LT |
259 | case ACPI_ALLOCATE_LOCAL_BUFFER: |
260 | ||
261 | /* Allocate a new buffer with local interface to allow tracking */ | |
262 | ||
8313524a | 263 | buffer->pointer = ACPI_ALLOCATE_ZEROED(required_length); |
1da177e4 LT |
264 | if (!buffer->pointer) { |
265 | return (AE_NO_MEMORY); | |
266 | } | |
267 | break; | |
268 | ||
1da177e4 LT |
269 | default: |
270 | ||
271 | /* Existing buffer: Validate the size of the buffer */ | |
272 | ||
273 | if (buffer->length < required_length) { | |
274 | status = AE_BUFFER_OVERFLOW; | |
275 | break; | |
276 | } | |
277 | ||
278 | /* Clear the buffer */ | |
279 | ||
4be44fcd | 280 | ACPI_MEMSET(buffer->pointer, 0, required_length); |
1da177e4 LT |
281 | break; |
282 | } | |
283 | ||
284 | buffer->length = required_length; | |
285 | return (status); | |
286 | } | |
287 | ||
1da177e4 LT |
288 | /******************************************************************************* |
289 | * | |
290 | * FUNCTION: acpi_ut_allocate | |
291 | * | |
292 | * PARAMETERS: Size - Size of the allocation | |
293 | * Component - Component type of caller | |
294 | * Module - Source file name of caller | |
295 | * Line - Line number of caller | |
296 | * | |
297 | * RETURN: Address of the allocated memory on success, NULL on failure. | |
298 | * | |
61686124 | 299 | * DESCRIPTION: Subsystem equivalent of malloc. |
1da177e4 LT |
300 | * |
301 | ******************************************************************************/ | |
302 | ||
4be44fcd | 303 | void *acpi_ut_allocate(acpi_size size, u32 component, char *module, u32 line) |
1da177e4 | 304 | { |
4be44fcd | 305 | void *allocation; |
1da177e4 | 306 | |
b229cf92 | 307 | ACPI_FUNCTION_TRACE_U32(ut_allocate, size); |
1da177e4 LT |
308 | |
309 | /* Check for an inadvertent size of zero bytes */ | |
310 | ||
311 | if (!size) { | |
61686124 BM |
312 | ACPI_WARNING((module, line, |
313 | "Attempt to allocate zero bytes, allocating 1 byte")); | |
1da177e4 LT |
314 | size = 1; |
315 | } | |
316 | ||
4be44fcd | 317 | allocation = acpi_os_allocate(size); |
1da177e4 | 318 | if (!allocation) { |
52fc0b02 | 319 | |
1da177e4 LT |
320 | /* Report allocation error */ |
321 | ||
61686124 BM |
322 | ACPI_WARNING((module, line, |
323 | "Could not allocate size %X", (u32) size)); | |
1da177e4 | 324 | |
4be44fcd | 325 | return_PTR(NULL); |
1da177e4 LT |
326 | } |
327 | ||
4be44fcd | 328 | return_PTR(allocation); |
1da177e4 LT |
329 | } |
330 | ||
1da177e4 LT |
331 | /******************************************************************************* |
332 | * | |
61686124 | 333 | * FUNCTION: acpi_ut_allocate_zeroed |
1da177e4 LT |
334 | * |
335 | * PARAMETERS: Size - Size of the allocation | |
336 | * Component - Component type of caller | |
337 | * Module - Source file name of caller | |
338 | * Line - Line number of caller | |
339 | * | |
340 | * RETURN: Address of the allocated memory on success, NULL on failure. | |
341 | * | |
61686124 | 342 | * DESCRIPTION: Subsystem equivalent of calloc. Allocate and zero memory. |
1da177e4 LT |
343 | * |
344 | ******************************************************************************/ | |
345 | ||
61686124 BM |
346 | void *acpi_ut_allocate_zeroed(acpi_size size, |
347 | u32 component, char *module, u32 line) | |
1da177e4 | 348 | { |
4be44fcd | 349 | void *allocation; |
1da177e4 | 350 | |
4be44fcd | 351 | ACPI_FUNCTION_ENTRY(); |
1da177e4 | 352 | |
61686124 BM |
353 | allocation = acpi_ut_allocate(size, component, module, line); |
354 | if (allocation) { | |
1da177e4 | 355 | |
61686124 | 356 | /* Clear the memory block */ |
1da177e4 | 357 | |
61686124 | 358 | ACPI_MEMSET(allocation, 0, size); |
1da177e4 LT |
359 | } |
360 | ||
61686124 | 361 | return (allocation); |
1da177e4 | 362 | } |