blob: 8cbcd7d6bd5e1a8d4b37b24d32a2bcf53d8f6632 [file] [log] [blame]
Erik Schmauss95857632018-03-14 16:13:07 -07001// SPDX-License-Identifier: BSD-3-Clause OR GPL-2.0
Linus Torvalds1da177e2005-04-16 15:20:36 -07002/******************************************************************************
3 *
Robert Moore73459f72005-06-24 00:00:00 -04004 * Module Name: utalloc - local memory allocation routines
Linus Torvalds1da177e2005-04-16 15:20:36 -07005 *
Bob Mooreda6f8322018-01-04 10:06:38 -08006 * Copyright (C) 2000 - 2018, Intel Corp.
Linus Torvalds1da177e2005-04-16 15:20:36 -07007 *
Erik Schmauss95857632018-03-14 16:13:07 -07008 *****************************************************************************/
Linus Torvalds1da177e2005-04-16 15:20:36 -07009
Linus Torvalds1da177e2005-04-16 15:20:36 -070010#include <acpi/acpi.h>
Len Browne2f7a772009-01-09 00:30:03 -050011#include "accommon.h"
12#include "acdebug.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070013
14#define _COMPONENT ACPI_UTILITIES
Len Brown4be44fc2005-08-05 00:44:28 -040015ACPI_MODULE_NAME("utalloc")
Linus Torvalds1da177e2005-04-16 15:20:36 -070016
Lv Zhengb3c86c32013-10-29 09:29:27 +080017#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
Bob Moore4fa46162015-07-01 14:45:11 +080042 memset(allocation, 0, size);
Lv Zhengb3c86c32013-10-29 09:29:27 +080043 }
44
45 return (allocation);
46}
47
48#endif /* !USE_NATIVE_ALLOCATE_ZEROED */
49
Robert Moore44f6c012005-04-18 22:49:35 -040050/*******************************************************************************
Linus Torvalds1da177e2005-04-16 15:20:36 -070051 *
Robert Moore73459f72005-06-24 00:00:00 -040052 * FUNCTION: acpi_ut_create_caches
Linus Torvalds1da177e2005-04-16 15:20:36 -070053 *
Robert Moore73459f72005-06-24 00:00:00 -040054 * PARAMETERS: None
Linus Torvalds1da177e2005-04-16 15:20:36 -070055 *
Robert Moore73459f72005-06-24 00:00:00 -040056 * RETURN: Status
Linus Torvalds1da177e2005-04-16 15:20:36 -070057 *
Robert Moore73459f72005-06-24 00:00:00 -040058 * DESCRIPTION: Create all local caches
Linus Torvalds1da177e2005-04-16 15:20:36 -070059 *
60 ******************************************************************************/
Lv Zhengb3c86c32013-10-29 09:29:27 +080061
Len Brown4be44fc2005-08-05 00:44:28 -040062acpi_status acpi_ut_create_caches(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -070063{
Len Brown4be44fc2005-08-05 00:44:28 -040064 acpi_status status;
Linus Torvalds1da177e2005-04-16 15:20:36 -070065
Robert Moore73459f72005-06-24 00:00:00 -040066 /* Object Caches, for frequently used objects */
67
Len Brown4be44fc2005-08-05 00:44:28 -040068 status =
Bob Moore616861242006-03-17 16:44:00 -050069 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),
Len Brown4be44fc2005-08-05 00:44:28 -040079 ACPI_MAX_STATE_CACHE_DEPTH,
80 &acpi_gbl_state_cache);
81 if (ACPI_FAILURE(status)) {
Robert Moore73459f72005-06-24 00:00:00 -040082 return (status);
83 }
84
Len Brown4be44fc2005-08-05 00:44:28 -040085 status =
Bob Moore616861242006-03-17 16:44:00 -050086 acpi_os_create_cache("Acpi-Parse",
Len Brown4be44fc2005-08-05 00:44:28 -040087 sizeof(struct acpi_parse_obj_common),
88 ACPI_MAX_PARSE_CACHE_DEPTH,
89 &acpi_gbl_ps_node_cache);
90 if (ACPI_FAILURE(status)) {
Robert Moore73459f72005-06-24 00:00:00 -040091 return (status);
92 }
93
Len Brown4be44fc2005-08-05 00:44:28 -040094 status =
Bob Mooreb229cf92006-04-21 17:15:00 -040095 acpi_os_create_cache("Acpi-ParseExt",
Len Brown4be44fc2005-08-05 00:44:28 -040096 sizeof(struct acpi_parse_obj_named),
97 ACPI_MAX_EXTPARSE_CACHE_DEPTH,
98 &acpi_gbl_ps_node_ext_cache);
99 if (ACPI_FAILURE(status)) {
Robert Moore73459f72005-06-24 00:00:00 -0400100 return (status);
101 }
102
Len Brown4be44fc2005-08-05 00:44:28 -0400103 status =
Bob Moore616861242006-03-17 16:44:00 -0500104 acpi_os_create_cache("Acpi-Operand",
Len Brown4be44fc2005-08-05 00:44:28 -0400105 sizeof(union acpi_operand_object),
106 ACPI_MAX_OBJECT_CACHE_DEPTH,
107 &acpi_gbl_operand_cache);
108 if (ACPI_FAILURE(status)) {
Robert Moore73459f72005-06-24 00:00:00 -0400109 return (status);
110 }
Bob Moore9cf7ade2017-04-28 08:53:22 +0800111#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
Bob Moore41195322006-05-26 16:36:00 -0400150#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
Robert Moore73459f72005-06-24 00:00:00 -0400168 return (AE_OK);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700169}
170
Robert Moore44f6c012005-04-18 22:49:35 -0400171/*******************************************************************************
Linus Torvalds1da177e2005-04-16 15:20:36 -0700172 *
Robert Moore73459f72005-06-24 00:00:00 -0400173 * FUNCTION: acpi_ut_delete_caches
Linus Torvalds1da177e2005-04-16 15:20:36 -0700174 *
Robert Moore73459f72005-06-24 00:00:00 -0400175 * PARAMETERS: None
Linus Torvalds1da177e2005-04-16 15:20:36 -0700176 *
Robert Moore73459f72005-06-24 00:00:00 -0400177 * RETURN: Status
Linus Torvalds1da177e2005-04-16 15:20:36 -0700178 *
Robert Moore73459f72005-06-24 00:00:00 -0400179 * DESCRIPTION: Purge and delete all local caches
Linus Torvalds1da177e2005-04-16 15:20:36 -0700180 *
181 ******************************************************************************/
182
Len Brown4be44fc2005-08-05 00:44:28 -0400183acpi_status acpi_ut_delete_caches(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700184{
Bob Moored41eb992007-02-02 19:48:23 +0300185#ifdef ACPI_DBG_TRACK_ALLOCATIONS
186 char buffer[7];
187
188 if (acpi_gbl_display_final_mem_stats) {
Bob Moore4fa46162015-07-01 14:45:11 +0800189 strcpy(buffer, "MEMORY");
Bob Moore1d18c052008-04-10 19:06:40 +0400190 (void)acpi_db_display_statistics(buffer);
Bob Moored41eb992007-02-02 19:48:23 +0300191 }
192#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700193
Bob Moore616861242006-03-17 16:44:00 -0500194 (void)acpi_os_delete_cache(acpi_gbl_namespace_cache);
195 acpi_gbl_namespace_cache = NULL;
196
Len Brown4be44fc2005-08-05 00:44:28 -0400197 (void)acpi_os_delete_cache(acpi_gbl_state_cache);
Robert Moore73459f72005-06-24 00:00:00 -0400198 acpi_gbl_state_cache = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700199
Len Brown4be44fc2005-08-05 00:44:28 -0400200 (void)acpi_os_delete_cache(acpi_gbl_operand_cache);
Robert Moore73459f72005-06-24 00:00:00 -0400201 acpi_gbl_operand_cache = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700202
Len Brown4be44fc2005-08-05 00:44:28 -0400203 (void)acpi_os_delete_cache(acpi_gbl_ps_node_cache);
Robert Moore73459f72005-06-24 00:00:00 -0400204 acpi_gbl_ps_node_cache = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700205
Len Brown4be44fc2005-08-05 00:44:28 -0400206 (void)acpi_os_delete_cache(acpi_gbl_ps_node_ext_cache);
Robert Moore73459f72005-06-24 00:00:00 -0400207 acpi_gbl_ps_node_ext_cache = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700208
Bob Moore9cf7ade2017-04-28 08:53:22 +0800209#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
Bob Moore41195322006-05-26 16:36:00 -0400220#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
Lv Zhengdba47d3a2013-10-31 09:31:00 +0800228 acpi_os_free(acpi_gbl_global_list);
Bob Moore41195322006-05-26 16:36:00 -0400229 acpi_gbl_global_list = NULL;
230
Lv Zhengdba47d3a2013-10-31 09:31:00 +0800231 acpi_os_free(acpi_gbl_ns_node_list);
Bob Moore41195322006-05-26 16:36:00 -0400232 acpi_gbl_ns_node_list = NULL;
233#endif
234
Robert Moore73459f72005-06-24 00:00:00 -0400235 return (AE_OK);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700236}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700237
238/*******************************************************************************
239 *
240 * FUNCTION: acpi_ut_validate_buffer
241 *
Bob Mooreba494be2012-07-12 09:40:10 +0800242 * PARAMETERS: buffer - Buffer descriptor to be validated
Linus Torvalds1da177e2005-04-16 15:20:36 -0700243 *
244 * RETURN: Status
245 *
246 * DESCRIPTION: Perform parameter validation checks on an struct acpi_buffer
247 *
248 ******************************************************************************/
249
Lv Zhengf5c1e1c2016-05-05 12:57:53 +0800250acpi_status acpi_ut_validate_buffer(struct acpi_buffer *buffer)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700251{
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
Len Brown4be44fc2005-08-05 00:44:28 -0400261 if ((buffer->length == ACPI_NO_BUFFER) ||
262 (buffer->length == ACPI_ALLOCATE_BUFFER) ||
263 (buffer->length == ACPI_ALLOCATE_LOCAL_BUFFER)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700264 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
Linus Torvalds1da177e2005-04-16 15:20:36 -0700276/*******************************************************************************
277 *
278 * FUNCTION: acpi_ut_initialize_buffer
279 *
Bob Mooreba494be2012-07-12 09:40:10 +0800280 * PARAMETERS: buffer - Buffer to be validated
Linus Torvalds1da177e2005-04-16 15:20:36 -0700281 * required_length - Length needed
282 *
283 * RETURN: Status
284 *
285 * DESCRIPTION: Validate that the buffer is of the required length or
Bob Moore68e125c2008-09-27 11:34:48 +0800286 * allocate a new buffer. Returned buffer is always zeroed.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700287 *
288 ******************************************************************************/
289
290acpi_status
Lv Zhengf5c1e1c2016-05-05 12:57:53 +0800291acpi_ut_initialize_buffer(struct acpi_buffer *buffer, acpi_size required_length)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700292{
Bob Moore68e125c2008-09-27 11:34:48 +0800293 acpi_size input_buffer_length;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700294
Bob Moore3c7db222008-08-04 11:13:01 +0800295 /* Parameter validation */
296
297 if (!buffer || !required_length) {
298 return (AE_BAD_PARAMETER);
Ingo Molnarf88133d2008-07-21 15:57:45 +0200299 }
Bob Moore3c7db222008-08-04 11:13:01 +0800300
Bob Moore68e125c2008-09-27 11:34:48 +0800301 /*
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) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700313 case ACPI_NO_BUFFER:
314
Bob Moore68e125c2008-09-27 11:34:48 +0800315 /* Return the exception (and the required buffer length) */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700316
Bob Moore68e125c2008-09-27 11:34:48 +0800317 return (AE_BUFFER_OVERFLOW);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700318
Linus Torvalds1da177e2005-04-16 15:20:36 -0700319 case ACPI_ALLOCATE_BUFFER:
Lv Zhengbb3fec12014-01-08 13:43:23 +0800320 /*
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 */
Len Brown4be44fc2005-08-05 00:44:28 -0400327 buffer->pointer = acpi_os_allocate(required_length);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700328 break;
329
Linus Torvalds1da177e2005-04-16 15:20:36 -0700330 case ACPI_ALLOCATE_LOCAL_BUFFER:
331
332 /* Allocate a new buffer with local interface to allow tracking */
333
Bob Moore68e125c2008-09-27 11:34:48 +0800334 buffer->pointer = ACPI_ALLOCATE(required_length);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700335 break;
336
Linus Torvalds1da177e2005-04-16 15:20:36 -0700337 default:
338
339 /* Existing buffer: Validate the size of the buffer */
340
Bob Moore68e125c2008-09-27 11:34:48 +0800341 if (input_buffer_length < required_length) {
342 return (AE_BUFFER_OVERFLOW);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700343 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700344 break;
345 }
346
Bob Moore68e125c2008-09-27 11:34:48 +0800347 /* 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
Bob Moore4fa46162015-07-01 14:45:11 +0800355 memset(buffer->pointer, 0, required_length);
Bob Moore68e125c2008-09-27 11:34:48 +0800356 return (AE_OK);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700357}