Loading...
1// SPDX-License-Identifier: BSD-3-Clause OR GPL-2.0
2/******************************************************************************
3 *
4 * Module Name: utalloc - local memory allocation routines
5 *
6 * Copyright (C) 2000 - 2023, Intel Corp.
7 *
8 *****************************************************************************/
9
10#include <acpi/acpi.h>
11#include "accommon.h"
12#include "acdebug.h"
13
14#define _COMPONENT ACPI_UTILITIES
15ACPI_MODULE_NAME("utalloc")
16
17#if !defined (USE_NATIVE_ALLOCATE_ZEROED)
18/*******************************************************************************
19 *
20 * FUNCTION: acpi_os_allocate_zeroed
21 *
22 * PARAMETERS: size - Size of the allocation
23 *
24 * RETURN: Address of the allocated memory on success, NULL on failure.
25 *
26 * DESCRIPTION: Subsystem equivalent of calloc. Allocate and zero memory.
27 * This is the default implementation. Can be overridden via the
28 * USE_NATIVE_ALLOCATE_ZEROED flag.
29 *
30 ******************************************************************************/
31void *acpi_os_allocate_zeroed(acpi_size size)
32{
33 void *allocation;
34
35 ACPI_FUNCTION_ENTRY();
36
37 allocation = acpi_os_allocate(size);
38 if (allocation) {
39
40 /* Clear the memory block */
41
42 memset(allocation, 0, size);
43 }
44
45 return (allocation);
46}
47
48#endif /* !USE_NATIVE_ALLOCATE_ZEROED */
49
50/*******************************************************************************
51 *
52 * FUNCTION: acpi_ut_create_caches
53 *
54 * PARAMETERS: None
55 *
56 * RETURN: Status
57 *
58 * DESCRIPTION: Create all local caches
59 *
60 ******************************************************************************/
61
62acpi_status acpi_ut_create_caches(void)
63{
64 acpi_status status;
65
66 /* Object Caches, for frequently used objects */
67
68 status =
69 acpi_os_create_cache("Acpi-Namespace",
70 sizeof(struct acpi_namespace_node),
71 ACPI_MAX_NAMESPACE_CACHE_DEPTH,
72 &acpi_gbl_namespace_cache);
73 if (ACPI_FAILURE(status)) {
74 return (status);
75 }
76
77 status =
78 acpi_os_create_cache("Acpi-State", sizeof(union acpi_generic_state),
79 ACPI_MAX_STATE_CACHE_DEPTH,
80 &acpi_gbl_state_cache);
81 if (ACPI_FAILURE(status)) {
82 return (status);
83 }
84
85 status =
86 acpi_os_create_cache("Acpi-Parse",
87 sizeof(struct acpi_parse_obj_common),
88 ACPI_MAX_PARSE_CACHE_DEPTH,
89 &acpi_gbl_ps_node_cache);
90 if (ACPI_FAILURE(status)) {
91 return (status);
92 }
93
94 status =
95 acpi_os_create_cache("Acpi-ParseExt",
96 sizeof(struct acpi_parse_obj_named),
97 ACPI_MAX_EXTPARSE_CACHE_DEPTH,
98 &acpi_gbl_ps_node_ext_cache);
99 if (ACPI_FAILURE(status)) {
100 return (status);
101 }
102
103 status =
104 acpi_os_create_cache("Acpi-Operand",
105 sizeof(union acpi_operand_object),
106 ACPI_MAX_OBJECT_CACHE_DEPTH,
107 &acpi_gbl_operand_cache);
108 if (ACPI_FAILURE(status)) {
109 return (status);
110 }
111#ifdef ACPI_ASL_COMPILER
112 /*
113 * For use with the ASL-/ASL+ option. This cache keeps track of regular
114 * 0xA9 0x01 comments.
115 */
116 status =
117 acpi_os_create_cache("Acpi-Comment",
118 sizeof(struct acpi_comment_node),
119 ACPI_MAX_COMMENT_CACHE_DEPTH,
120 &acpi_gbl_reg_comment_cache);
121 if (ACPI_FAILURE(status)) {
122 return (status);
123 }
124
125 /*
126 * This cache keeps track of the starting addresses of where the comments
127 * lie. This helps prevent duplication of comments.
128 */
129 status =
130 acpi_os_create_cache("Acpi-Comment-Addr",
131 sizeof(struct acpi_comment_addr_node),
132 ACPI_MAX_COMMENT_CACHE_DEPTH,
133 &acpi_gbl_comment_addr_cache);
134 if (ACPI_FAILURE(status)) {
135 return (status);
136 }
137
138 /*
139 * This cache will be used for nodes that represent files.
140 */
141 status =
142 acpi_os_create_cache("Acpi-File", sizeof(struct acpi_file_node),
143 ACPI_MAX_COMMENT_CACHE_DEPTH,
144 &acpi_gbl_file_cache);
145 if (ACPI_FAILURE(status)) {
146 return (status);
147 }
148#endif
149
150#ifdef ACPI_DBG_TRACK_ALLOCATIONS
151
152 /* Memory allocation lists */
153
154 status = acpi_ut_create_list("Acpi-Global", 0, &acpi_gbl_global_list);
155 if (ACPI_FAILURE(status)) {
156 return (status);
157 }
158
159 status =
160 acpi_ut_create_list("Acpi-Namespace",
161 sizeof(struct acpi_namespace_node),
162 &acpi_gbl_ns_node_list);
163 if (ACPI_FAILURE(status)) {
164 return (status);
165 }
166#endif
167
168 return (AE_OK);
169}
170
171/*******************************************************************************
172 *
173 * FUNCTION: acpi_ut_delete_caches
174 *
175 * PARAMETERS: None
176 *
177 * RETURN: Status
178 *
179 * DESCRIPTION: Purge and delete all local caches
180 *
181 ******************************************************************************/
182
183acpi_status acpi_ut_delete_caches(void)
184{
185#ifdef ACPI_DBG_TRACK_ALLOCATIONS
186 char buffer[7];
187
188 if (acpi_gbl_display_final_mem_stats) {
189 strcpy(buffer, "MEMORY");
190 (void)acpi_db_display_statistics(buffer);
191 }
192#endif
193
194 (void)acpi_os_delete_cache(acpi_gbl_namespace_cache);
195 acpi_gbl_namespace_cache = NULL;
196
197 (void)acpi_os_delete_cache(acpi_gbl_state_cache);
198 acpi_gbl_state_cache = NULL;
199
200 (void)acpi_os_delete_cache(acpi_gbl_operand_cache);
201 acpi_gbl_operand_cache = NULL;
202
203 (void)acpi_os_delete_cache(acpi_gbl_ps_node_cache);
204 acpi_gbl_ps_node_cache = NULL;
205
206 (void)acpi_os_delete_cache(acpi_gbl_ps_node_ext_cache);
207 acpi_gbl_ps_node_ext_cache = NULL;
208
209#ifdef ACPI_ASL_COMPILER
210 (void)acpi_os_delete_cache(acpi_gbl_reg_comment_cache);
211 acpi_gbl_reg_comment_cache = NULL;
212
213 (void)acpi_os_delete_cache(acpi_gbl_comment_addr_cache);
214 acpi_gbl_comment_addr_cache = NULL;
215
216 (void)acpi_os_delete_cache(acpi_gbl_file_cache);
217 acpi_gbl_file_cache = NULL;
218#endif
219
220#ifdef ACPI_DBG_TRACK_ALLOCATIONS
221
222 /* Debug only - display leftover memory allocation, if any */
223
224 acpi_ut_dump_allocations(ACPI_UINT32_MAX, NULL);
225
226 /* Free memory lists */
227
228 acpi_os_free(acpi_gbl_global_list);
229 acpi_gbl_global_list = NULL;
230
231 acpi_os_free(acpi_gbl_ns_node_list);
232 acpi_gbl_ns_node_list = NULL;
233#endif
234
235 return (AE_OK);
236}
237
238/*******************************************************************************
239 *
240 * FUNCTION: acpi_ut_validate_buffer
241 *
242 * PARAMETERS: buffer - Buffer descriptor to be validated
243 *
244 * RETURN: Status
245 *
246 * DESCRIPTION: Perform parameter validation checks on an struct acpi_buffer
247 *
248 ******************************************************************************/
249
250acpi_status acpi_ut_validate_buffer(struct acpi_buffer *buffer)
251{
252
253 /* Obviously, the structure pointer must be valid */
254
255 if (!buffer) {
256 return (AE_BAD_PARAMETER);
257 }
258
259 /* Special semantics for the length */
260
261 if ((buffer->length == ACPI_NO_BUFFER) ||
262 (buffer->length == ACPI_ALLOCATE_BUFFER) ||
263 (buffer->length == ACPI_ALLOCATE_LOCAL_BUFFER)) {
264 return (AE_OK);
265 }
266
267 /* Length is valid, the buffer pointer must be also */
268
269 if (!buffer->pointer) {
270 return (AE_BAD_PARAMETER);
271 }
272
273 return (AE_OK);
274}
275
276/*******************************************************************************
277 *
278 * FUNCTION: acpi_ut_initialize_buffer
279 *
280 * PARAMETERS: buffer - Buffer to be validated
281 * required_length - Length needed
282 *
283 * RETURN: Status
284 *
285 * DESCRIPTION: Validate that the buffer is of the required length or
286 * allocate a new buffer. Returned buffer is always zeroed.
287 *
288 ******************************************************************************/
289
290acpi_status
291acpi_ut_initialize_buffer(struct acpi_buffer *buffer, acpi_size required_length)
292{
293 acpi_size input_buffer_length;
294
295 /* Parameter validation */
296
297 if (!buffer || !required_length) {
298 return (AE_BAD_PARAMETER);
299 }
300
301 /*
302 * Buffer->Length is used as both an input and output parameter. Get the
303 * input actual length and set the output required buffer length.
304 */
305 input_buffer_length = buffer->length;
306 buffer->length = required_length;
307
308 /*
309 * The input buffer length contains the actual buffer length, or the type
310 * of buffer to be allocated by this routine.
311 */
312 switch (input_buffer_length) {
313 case ACPI_NO_BUFFER:
314
315 /* Return the exception (and the required buffer length) */
316
317 return (AE_BUFFER_OVERFLOW);
318
319 case ACPI_ALLOCATE_BUFFER:
320 /*
321 * Allocate a new buffer. We directectly call acpi_os_allocate here to
322 * purposefully bypass the (optionally enabled) internal allocation
323 * tracking mechanism since we only want to track internal
324 * allocations. Note: The caller should use acpi_os_free to free this
325 * buffer created via ACPI_ALLOCATE_BUFFER.
326 */
327 buffer->pointer = acpi_os_allocate(required_length);
328 break;
329
330 case ACPI_ALLOCATE_LOCAL_BUFFER:
331
332 /* Allocate a new buffer with local interface to allow tracking */
333
334 buffer->pointer = ACPI_ALLOCATE(required_length);
335 break;
336
337 default:
338
339 /* Existing buffer: Validate the size of the buffer */
340
341 if (input_buffer_length < required_length) {
342 return (AE_BUFFER_OVERFLOW);
343 }
344 break;
345 }
346
347 /* Validate allocation from above or input buffer pointer */
348
349 if (!buffer->pointer) {
350 return (AE_NO_MEMORY);
351 }
352
353 /* Have a valid buffer, clear it */
354
355 memset(buffer->pointer, 0, required_length);
356 return (AE_OK);
357}
1/******************************************************************************
2 *
3 * Module Name: utalloc - local memory allocation routines
4 *
5 *****************************************************************************/
6
7/*
8 * Copyright (C) 2000 - 2012, Intel Corp.
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
44#include <acpi/acpi.h>
45#include "accommon.h"
46#include "acdebug.h"
47
48#define _COMPONENT ACPI_UTILITIES
49ACPI_MODULE_NAME("utalloc")
50
51/*******************************************************************************
52 *
53 * FUNCTION: acpi_ut_create_caches
54 *
55 * PARAMETERS: None
56 *
57 * RETURN: Status
58 *
59 * DESCRIPTION: Create all local caches
60 *
61 ******************************************************************************/
62acpi_status acpi_ut_create_caches(void)
63{
64 acpi_status status;
65
66 /* Object Caches, for frequently used objects */
67
68 status =
69 acpi_os_create_cache("Acpi-Namespace",
70 sizeof(struct acpi_namespace_node),
71 ACPI_MAX_NAMESPACE_CACHE_DEPTH,
72 &acpi_gbl_namespace_cache);
73 if (ACPI_FAILURE(status)) {
74 return (status);
75 }
76
77 status =
78 acpi_os_create_cache("Acpi-State", sizeof(union acpi_generic_state),
79 ACPI_MAX_STATE_CACHE_DEPTH,
80 &acpi_gbl_state_cache);
81 if (ACPI_FAILURE(status)) {
82 return (status);
83 }
84
85 status =
86 acpi_os_create_cache("Acpi-Parse",
87 sizeof(struct acpi_parse_obj_common),
88 ACPI_MAX_PARSE_CACHE_DEPTH,
89 &acpi_gbl_ps_node_cache);
90 if (ACPI_FAILURE(status)) {
91 return (status);
92 }
93
94 status =
95 acpi_os_create_cache("Acpi-ParseExt",
96 sizeof(struct acpi_parse_obj_named),
97 ACPI_MAX_EXTPARSE_CACHE_DEPTH,
98 &acpi_gbl_ps_node_ext_cache);
99 if (ACPI_FAILURE(status)) {
100 return (status);
101 }
102
103 status =
104 acpi_os_create_cache("Acpi-Operand",
105 sizeof(union acpi_operand_object),
106 ACPI_MAX_OBJECT_CACHE_DEPTH,
107 &acpi_gbl_operand_cache);
108 if (ACPI_FAILURE(status)) {
109 return (status);
110 }
111#ifdef ACPI_DBG_TRACK_ALLOCATIONS
112
113 /* Memory allocation lists */
114
115 status = acpi_ut_create_list("Acpi-Global", 0, &acpi_gbl_global_list);
116 if (ACPI_FAILURE(status)) {
117 return (status);
118 }
119
120 status =
121 acpi_ut_create_list("Acpi-Namespace",
122 sizeof(struct acpi_namespace_node),
123 &acpi_gbl_ns_node_list);
124 if (ACPI_FAILURE(status)) {
125 return (status);
126 }
127#endif
128
129 return (AE_OK);
130}
131
132/*******************************************************************************
133 *
134 * FUNCTION: acpi_ut_delete_caches
135 *
136 * PARAMETERS: None
137 *
138 * RETURN: Status
139 *
140 * DESCRIPTION: Purge and delete all local caches
141 *
142 ******************************************************************************/
143
144acpi_status acpi_ut_delete_caches(void)
145{
146#ifdef ACPI_DBG_TRACK_ALLOCATIONS
147 char buffer[7];
148
149 if (acpi_gbl_display_final_mem_stats) {
150 ACPI_STRCPY(buffer, "MEMORY");
151 (void)acpi_db_display_statistics(buffer);
152 }
153#endif
154
155 (void)acpi_os_delete_cache(acpi_gbl_namespace_cache);
156 acpi_gbl_namespace_cache = NULL;
157
158 (void)acpi_os_delete_cache(acpi_gbl_state_cache);
159 acpi_gbl_state_cache = NULL;
160
161 (void)acpi_os_delete_cache(acpi_gbl_operand_cache);
162 acpi_gbl_operand_cache = NULL;
163
164 (void)acpi_os_delete_cache(acpi_gbl_ps_node_cache);
165 acpi_gbl_ps_node_cache = NULL;
166
167 (void)acpi_os_delete_cache(acpi_gbl_ps_node_ext_cache);
168 acpi_gbl_ps_node_ext_cache = NULL;
169
170#ifdef ACPI_DBG_TRACK_ALLOCATIONS
171
172 /* Debug only - display leftover memory allocation, if any */
173
174 acpi_ut_dump_allocations(ACPI_UINT32_MAX, NULL);
175
176 /* Free memory lists */
177
178 ACPI_FREE(acpi_gbl_global_list);
179 acpi_gbl_global_list = NULL;
180
181 ACPI_FREE(acpi_gbl_ns_node_list);
182 acpi_gbl_ns_node_list = NULL;
183#endif
184
185 return (AE_OK);
186}
187
188/*******************************************************************************
189 *
190 * FUNCTION: acpi_ut_validate_buffer
191 *
192 * PARAMETERS: Buffer - Buffer descriptor to be validated
193 *
194 * RETURN: Status
195 *
196 * DESCRIPTION: Perform parameter validation checks on an struct acpi_buffer
197 *
198 ******************************************************************************/
199
200acpi_status acpi_ut_validate_buffer(struct acpi_buffer * buffer)
201{
202
203 /* Obviously, the structure pointer must be valid */
204
205 if (!buffer) {
206 return (AE_BAD_PARAMETER);
207 }
208
209 /* Special semantics for the length */
210
211 if ((buffer->length == ACPI_NO_BUFFER) ||
212 (buffer->length == ACPI_ALLOCATE_BUFFER) ||
213 (buffer->length == ACPI_ALLOCATE_LOCAL_BUFFER)) {
214 return (AE_OK);
215 }
216
217 /* Length is valid, the buffer pointer must be also */
218
219 if (!buffer->pointer) {
220 return (AE_BAD_PARAMETER);
221 }
222
223 return (AE_OK);
224}
225
226/*******************************************************************************
227 *
228 * FUNCTION: acpi_ut_initialize_buffer
229 *
230 * PARAMETERS: Buffer - Buffer to be validated
231 * required_length - Length needed
232 *
233 * RETURN: Status
234 *
235 * DESCRIPTION: Validate that the buffer is of the required length or
236 * allocate a new buffer. Returned buffer is always zeroed.
237 *
238 ******************************************************************************/
239
240acpi_status
241acpi_ut_initialize_buffer(struct acpi_buffer * buffer,
242 acpi_size required_length)
243{
244 acpi_size input_buffer_length;
245
246 /* Parameter validation */
247
248 if (!buffer || !required_length) {
249 return (AE_BAD_PARAMETER);
250 }
251
252 /*
253 * Buffer->Length is used as both an input and output parameter. Get the
254 * input actual length and set the output required buffer length.
255 */
256 input_buffer_length = buffer->length;
257 buffer->length = required_length;
258
259 /*
260 * The input buffer length contains the actual buffer length, or the type
261 * of buffer to be allocated by this routine.
262 */
263 switch (input_buffer_length) {
264 case ACPI_NO_BUFFER:
265
266 /* Return the exception (and the required buffer length) */
267
268 return (AE_BUFFER_OVERFLOW);
269
270 case ACPI_ALLOCATE_BUFFER:
271
272 /* Allocate a new buffer */
273
274 buffer->pointer = acpi_os_allocate(required_length);
275 break;
276
277 case ACPI_ALLOCATE_LOCAL_BUFFER:
278
279 /* Allocate a new buffer with local interface to allow tracking */
280
281 buffer->pointer = ACPI_ALLOCATE(required_length);
282 break;
283
284 default:
285
286 /* Existing buffer: Validate the size of the buffer */
287
288 if (input_buffer_length < required_length) {
289 return (AE_BUFFER_OVERFLOW);
290 }
291 break;
292 }
293
294 /* Validate allocation from above or input buffer pointer */
295
296 if (!buffer->pointer) {
297 return (AE_NO_MEMORY);
298 }
299
300 /* Have a valid buffer, clear it */
301
302 ACPI_MEMSET(buffer->pointer, 0, required_length);
303 return (AE_OK);
304}
305
306#ifdef NOT_USED_BY_LINUX
307/*******************************************************************************
308 *
309 * FUNCTION: acpi_ut_allocate
310 *
311 * PARAMETERS: Size - Size of the allocation
312 * Component - Component type of caller
313 * Module - Source file name of caller
314 * Line - Line number of caller
315 *
316 * RETURN: Address of the allocated memory on success, NULL on failure.
317 *
318 * DESCRIPTION: Subsystem equivalent of malloc.
319 *
320 ******************************************************************************/
321
322void *acpi_ut_allocate(acpi_size size,
323 u32 component, const char *module, u32 line)
324{
325 void *allocation;
326
327 ACPI_FUNCTION_TRACE_U32(ut_allocate, size);
328
329 /* Check for an inadvertent size of zero bytes */
330
331 if (!size) {
332 ACPI_WARNING((module, line,
333 "Attempt to allocate zero bytes, allocating 1 byte"));
334 size = 1;
335 }
336
337 allocation = acpi_os_allocate(size);
338 if (!allocation) {
339
340 /* Report allocation error */
341
342 ACPI_WARNING((module, line,
343 "Could not allocate size %u", (u32) size));
344
345 return_PTR(NULL);
346 }
347
348 return_PTR(allocation);
349}
350
351/*******************************************************************************
352 *
353 * FUNCTION: acpi_ut_allocate_zeroed
354 *
355 * PARAMETERS: Size - Size of the allocation
356 * Component - Component type of caller
357 * Module - Source file name of caller
358 * Line - Line number of caller
359 *
360 * RETURN: Address of the allocated memory on success, NULL on failure.
361 *
362 * DESCRIPTION: Subsystem equivalent of calloc. Allocate and zero memory.
363 *
364 ******************************************************************************/
365
366void *acpi_ut_allocate_zeroed(acpi_size size,
367 u32 component, const char *module, u32 line)
368{
369 void *allocation;
370
371 ACPI_FUNCTION_ENTRY();
372
373 allocation = acpi_ut_allocate(size, component, module, line);
374 if (allocation) {
375
376 /* Clear the memory block */
377
378 ACPI_MEMSET(allocation, 0, size);
379 }
380
381 return (allocation);
382}
383#endif