195857638SErik Schmauss // SPDX-License-Identifier: BSD-3-Clause OR GPL-2.0
295b482a8SLen Brown /******************************************************************************
395b482a8SLen Brown *
495b482a8SLen Brown * Module Name: utalloc - local memory allocation routines
595b482a8SLen Brown *
6*612c2932SBob Moore * Copyright (C) 2000 - 2023, Intel Corp.
795b482a8SLen Brown *
895857638SErik Schmauss *****************************************************************************/
995b482a8SLen Brown
1095b482a8SLen Brown #include <acpi/acpi.h>
11e2f7a777SLen Brown #include "accommon.h"
12e2f7a777SLen Brown #include "acdebug.h"
1395b482a8SLen Brown
1495b482a8SLen Brown #define _COMPONENT ACPI_UTILITIES
1595b482a8SLen Brown ACPI_MODULE_NAME("utalloc")
1695b482a8SLen Brown
17b3c86c30SLv Zheng #if !defined (USE_NATIVE_ALLOCATE_ZEROED)
18b3c86c30SLv Zheng /*******************************************************************************
19b3c86c30SLv Zheng *
20b3c86c30SLv Zheng * FUNCTION: acpi_os_allocate_zeroed
21b3c86c30SLv Zheng *
22b3c86c30SLv Zheng * PARAMETERS: size - Size of the allocation
23b3c86c30SLv Zheng *
24b3c86c30SLv Zheng * RETURN: Address of the allocated memory on success, NULL on failure.
25b3c86c30SLv Zheng *
26b3c86c30SLv Zheng * DESCRIPTION: Subsystem equivalent of calloc. Allocate and zero memory.
27b3c86c30SLv Zheng * This is the default implementation. Can be overridden via the
28b3c86c30SLv Zheng * USE_NATIVE_ALLOCATE_ZEROED flag.
29b3c86c30SLv Zheng *
30b3c86c30SLv Zheng ******************************************************************************/
acpi_os_allocate_zeroed(acpi_size size)31b3c86c30SLv Zheng void *acpi_os_allocate_zeroed(acpi_size size)
32b3c86c30SLv Zheng {
33b3c86c30SLv Zheng void *allocation;
34b3c86c30SLv Zheng
35b3c86c30SLv Zheng ACPI_FUNCTION_ENTRY();
36b3c86c30SLv Zheng
37b3c86c30SLv Zheng allocation = acpi_os_allocate(size);
38b3c86c30SLv Zheng if (allocation) {
39b3c86c30SLv Zheng
40b3c86c30SLv Zheng /* Clear the memory block */
41b3c86c30SLv Zheng
424fa4616eSBob Moore memset(allocation, 0, size);
43b3c86c30SLv Zheng }
44b3c86c30SLv Zheng
45b3c86c30SLv Zheng return (allocation);
46b3c86c30SLv Zheng }
47b3c86c30SLv Zheng
48b3c86c30SLv Zheng #endif /* !USE_NATIVE_ALLOCATE_ZEROED */
49b3c86c30SLv Zheng
5095b482a8SLen Brown /*******************************************************************************
5195b482a8SLen Brown *
5295b482a8SLen Brown * FUNCTION: acpi_ut_create_caches
5395b482a8SLen Brown *
5495b482a8SLen Brown * PARAMETERS: None
5595b482a8SLen Brown *
5695b482a8SLen Brown * RETURN: Status
5795b482a8SLen Brown *
5895b482a8SLen Brown * DESCRIPTION: Create all local caches
5995b482a8SLen Brown *
6095b482a8SLen Brown ******************************************************************************/
61b3c86c30SLv Zheng
acpi_ut_create_caches(void)6295b482a8SLen Brown acpi_status acpi_ut_create_caches(void)
6395b482a8SLen Brown {
6495b482a8SLen Brown acpi_status status;
6595b482a8SLen Brown
6695b482a8SLen Brown /* Object Caches, for frequently used objects */
6795b482a8SLen Brown
6895b482a8SLen Brown status =
6995b482a8SLen Brown acpi_os_create_cache("Acpi-Namespace",
7095b482a8SLen Brown sizeof(struct acpi_namespace_node),
7195b482a8SLen Brown ACPI_MAX_NAMESPACE_CACHE_DEPTH,
7295b482a8SLen Brown &acpi_gbl_namespace_cache);
7395b482a8SLen Brown if (ACPI_FAILURE(status)) {
7495b482a8SLen Brown return (status);
7595b482a8SLen Brown }
7695b482a8SLen Brown
7795b482a8SLen Brown status =
7895b482a8SLen Brown acpi_os_create_cache("Acpi-State", sizeof(union acpi_generic_state),
7995b482a8SLen Brown ACPI_MAX_STATE_CACHE_DEPTH,
8095b482a8SLen Brown &acpi_gbl_state_cache);
8195b482a8SLen Brown if (ACPI_FAILURE(status)) {
8295b482a8SLen Brown return (status);
8395b482a8SLen Brown }
8495b482a8SLen Brown
8595b482a8SLen Brown status =
8695b482a8SLen Brown acpi_os_create_cache("Acpi-Parse",
8795b482a8SLen Brown sizeof(struct acpi_parse_obj_common),
8895b482a8SLen Brown ACPI_MAX_PARSE_CACHE_DEPTH,
8995b482a8SLen Brown &acpi_gbl_ps_node_cache);
9095b482a8SLen Brown if (ACPI_FAILURE(status)) {
9195b482a8SLen Brown return (status);
9295b482a8SLen Brown }
9395b482a8SLen Brown
9495b482a8SLen Brown status =
9595b482a8SLen Brown acpi_os_create_cache("Acpi-ParseExt",
9695b482a8SLen Brown sizeof(struct acpi_parse_obj_named),
9795b482a8SLen Brown ACPI_MAX_EXTPARSE_CACHE_DEPTH,
9895b482a8SLen Brown &acpi_gbl_ps_node_ext_cache);
9995b482a8SLen Brown if (ACPI_FAILURE(status)) {
10095b482a8SLen Brown return (status);
10195b482a8SLen Brown }
10295b482a8SLen Brown
10395b482a8SLen Brown status =
10495b482a8SLen Brown acpi_os_create_cache("Acpi-Operand",
10595b482a8SLen Brown sizeof(union acpi_operand_object),
10695b482a8SLen Brown ACPI_MAX_OBJECT_CACHE_DEPTH,
10795b482a8SLen Brown &acpi_gbl_operand_cache);
10895b482a8SLen Brown if (ACPI_FAILURE(status)) {
10995b482a8SLen Brown return (status);
11095b482a8SLen Brown }
1119cf7adecSBob Moore #ifdef ACPI_ASL_COMPILER
1129cf7adecSBob Moore /*
1139cf7adecSBob Moore * For use with the ASL-/ASL+ option. This cache keeps track of regular
1149cf7adecSBob Moore * 0xA9 0x01 comments.
1159cf7adecSBob Moore */
1169cf7adecSBob Moore status =
1179cf7adecSBob Moore acpi_os_create_cache("Acpi-Comment",
1189cf7adecSBob Moore sizeof(struct acpi_comment_node),
1199cf7adecSBob Moore ACPI_MAX_COMMENT_CACHE_DEPTH,
1209cf7adecSBob Moore &acpi_gbl_reg_comment_cache);
1219cf7adecSBob Moore if (ACPI_FAILURE(status)) {
1229cf7adecSBob Moore return (status);
1239cf7adecSBob Moore }
1249cf7adecSBob Moore
1259cf7adecSBob Moore /*
1269cf7adecSBob Moore * This cache keeps track of the starting addresses of where the comments
1279cf7adecSBob Moore * lie. This helps prevent duplication of comments.
1289cf7adecSBob Moore */
1299cf7adecSBob Moore status =
1309cf7adecSBob Moore acpi_os_create_cache("Acpi-Comment-Addr",
1319cf7adecSBob Moore sizeof(struct acpi_comment_addr_node),
1329cf7adecSBob Moore ACPI_MAX_COMMENT_CACHE_DEPTH,
1339cf7adecSBob Moore &acpi_gbl_comment_addr_cache);
1349cf7adecSBob Moore if (ACPI_FAILURE(status)) {
1359cf7adecSBob Moore return (status);
1369cf7adecSBob Moore }
1379cf7adecSBob Moore
1389cf7adecSBob Moore /*
1399cf7adecSBob Moore * This cache will be used for nodes that represent files.
1409cf7adecSBob Moore */
1419cf7adecSBob Moore status =
1429cf7adecSBob Moore acpi_os_create_cache("Acpi-File", sizeof(struct acpi_file_node),
1439cf7adecSBob Moore ACPI_MAX_COMMENT_CACHE_DEPTH,
1449cf7adecSBob Moore &acpi_gbl_file_cache);
1459cf7adecSBob Moore if (ACPI_FAILURE(status)) {
1469cf7adecSBob Moore return (status);
1479cf7adecSBob Moore }
1489cf7adecSBob Moore #endif
1499cf7adecSBob Moore
15095b482a8SLen Brown #ifdef ACPI_DBG_TRACK_ALLOCATIONS
15195b482a8SLen Brown
15295b482a8SLen Brown /* Memory allocation lists */
15395b482a8SLen Brown
15495b482a8SLen Brown status = acpi_ut_create_list("Acpi-Global", 0, &acpi_gbl_global_list);
15595b482a8SLen Brown if (ACPI_FAILURE(status)) {
15695b482a8SLen Brown return (status);
15795b482a8SLen Brown }
15895b482a8SLen Brown
15995b482a8SLen Brown status =
16095b482a8SLen Brown acpi_ut_create_list("Acpi-Namespace",
16195b482a8SLen Brown sizeof(struct acpi_namespace_node),
16295b482a8SLen Brown &acpi_gbl_ns_node_list);
16395b482a8SLen Brown if (ACPI_FAILURE(status)) {
16495b482a8SLen Brown return (status);
16595b482a8SLen Brown }
16695b482a8SLen Brown #endif
16795b482a8SLen Brown
16895b482a8SLen Brown return (AE_OK);
16995b482a8SLen Brown }
17095b482a8SLen Brown
17195b482a8SLen Brown /*******************************************************************************
17295b482a8SLen Brown *
17395b482a8SLen Brown * FUNCTION: acpi_ut_delete_caches
17495b482a8SLen Brown *
17595b482a8SLen Brown * PARAMETERS: None
17695b482a8SLen Brown *
17795b482a8SLen Brown * RETURN: Status
17895b482a8SLen Brown *
17995b482a8SLen Brown * DESCRIPTION: Purge and delete all local caches
18095b482a8SLen Brown *
18195b482a8SLen Brown ******************************************************************************/
18295b482a8SLen Brown
acpi_ut_delete_caches(void)18395b482a8SLen Brown acpi_status acpi_ut_delete_caches(void)
18495b482a8SLen Brown {
18595b482a8SLen Brown #ifdef ACPI_DBG_TRACK_ALLOCATIONS
18695b482a8SLen Brown char buffer[7];
18795b482a8SLen Brown
18895b482a8SLen Brown if (acpi_gbl_display_final_mem_stats) {
1894fa4616eSBob Moore strcpy(buffer, "MEMORY");
19095b482a8SLen Brown (void)acpi_db_display_statistics(buffer);
19195b482a8SLen Brown }
19295b482a8SLen Brown #endif
19395b482a8SLen Brown
19495b482a8SLen Brown (void)acpi_os_delete_cache(acpi_gbl_namespace_cache);
19595b482a8SLen Brown acpi_gbl_namespace_cache = NULL;
19695b482a8SLen Brown
19795b482a8SLen Brown (void)acpi_os_delete_cache(acpi_gbl_state_cache);
19895b482a8SLen Brown acpi_gbl_state_cache = NULL;
19995b482a8SLen Brown
20095b482a8SLen Brown (void)acpi_os_delete_cache(acpi_gbl_operand_cache);
20195b482a8SLen Brown acpi_gbl_operand_cache = NULL;
20295b482a8SLen Brown
20395b482a8SLen Brown (void)acpi_os_delete_cache(acpi_gbl_ps_node_cache);
20495b482a8SLen Brown acpi_gbl_ps_node_cache = NULL;
20595b482a8SLen Brown
20695b482a8SLen Brown (void)acpi_os_delete_cache(acpi_gbl_ps_node_ext_cache);
20795b482a8SLen Brown acpi_gbl_ps_node_ext_cache = NULL;
20895b482a8SLen Brown
2099cf7adecSBob Moore #ifdef ACPI_ASL_COMPILER
2109cf7adecSBob Moore (void)acpi_os_delete_cache(acpi_gbl_reg_comment_cache);
2119cf7adecSBob Moore acpi_gbl_reg_comment_cache = NULL;
2129cf7adecSBob Moore
2139cf7adecSBob Moore (void)acpi_os_delete_cache(acpi_gbl_comment_addr_cache);
2149cf7adecSBob Moore acpi_gbl_comment_addr_cache = NULL;
2159cf7adecSBob Moore
2169cf7adecSBob Moore (void)acpi_os_delete_cache(acpi_gbl_file_cache);
2179cf7adecSBob Moore acpi_gbl_file_cache = NULL;
2189cf7adecSBob Moore #endif
2199cf7adecSBob Moore
22095b482a8SLen Brown #ifdef ACPI_DBG_TRACK_ALLOCATIONS
22195b482a8SLen Brown
22295b482a8SLen Brown /* Debug only - display leftover memory allocation, if any */
22395b482a8SLen Brown
22495b482a8SLen Brown acpi_ut_dump_allocations(ACPI_UINT32_MAX, NULL);
22595b482a8SLen Brown
22695b482a8SLen Brown /* Free memory lists */
22795b482a8SLen Brown
228dba47d3aSLv Zheng acpi_os_free(acpi_gbl_global_list);
22995b482a8SLen Brown acpi_gbl_global_list = NULL;
23095b482a8SLen Brown
231dba47d3aSLv Zheng acpi_os_free(acpi_gbl_ns_node_list);
23295b482a8SLen Brown acpi_gbl_ns_node_list = NULL;
23395b482a8SLen Brown #endif
23495b482a8SLen Brown
23595b482a8SLen Brown return (AE_OK);
23695b482a8SLen Brown }
23795b482a8SLen Brown
23895b482a8SLen Brown /*******************************************************************************
23995b482a8SLen Brown *
24095b482a8SLen Brown * FUNCTION: acpi_ut_validate_buffer
24195b482a8SLen Brown *
242ba494beeSBob Moore * PARAMETERS: buffer - Buffer descriptor to be validated
24395b482a8SLen Brown *
24495b482a8SLen Brown * RETURN: Status
24595b482a8SLen Brown *
24695b482a8SLen Brown * DESCRIPTION: Perform parameter validation checks on an struct acpi_buffer
24795b482a8SLen Brown *
24895b482a8SLen Brown ******************************************************************************/
24995b482a8SLen Brown
acpi_ut_validate_buffer(struct acpi_buffer * buffer)25095b482a8SLen Brown acpi_status acpi_ut_validate_buffer(struct acpi_buffer *buffer)
25195b482a8SLen Brown {
25295b482a8SLen Brown
25395b482a8SLen Brown /* Obviously, the structure pointer must be valid */
25495b482a8SLen Brown
25595b482a8SLen Brown if (!buffer) {
25695b482a8SLen Brown return (AE_BAD_PARAMETER);
25795b482a8SLen Brown }
25895b482a8SLen Brown
25995b482a8SLen Brown /* Special semantics for the length */
26095b482a8SLen Brown
26195b482a8SLen Brown if ((buffer->length == ACPI_NO_BUFFER) ||
26295b482a8SLen Brown (buffer->length == ACPI_ALLOCATE_BUFFER) ||
26395b482a8SLen Brown (buffer->length == ACPI_ALLOCATE_LOCAL_BUFFER)) {
26495b482a8SLen Brown return (AE_OK);
26595b482a8SLen Brown }
26695b482a8SLen Brown
26795b482a8SLen Brown /* Length is valid, the buffer pointer must be also */
26895b482a8SLen Brown
26995b482a8SLen Brown if (!buffer->pointer) {
27095b482a8SLen Brown return (AE_BAD_PARAMETER);
27195b482a8SLen Brown }
27295b482a8SLen Brown
27395b482a8SLen Brown return (AE_OK);
27495b482a8SLen Brown }
27595b482a8SLen Brown
27695b482a8SLen Brown /*******************************************************************************
27795b482a8SLen Brown *
27895b482a8SLen Brown * FUNCTION: acpi_ut_initialize_buffer
27995b482a8SLen Brown *
280ba494beeSBob Moore * PARAMETERS: buffer - Buffer to be validated
28195b482a8SLen Brown * required_length - Length needed
28295b482a8SLen Brown *
28395b482a8SLen Brown * RETURN: Status
28495b482a8SLen Brown *
28595b482a8SLen Brown * DESCRIPTION: Validate that the buffer is of the required length or
28695b482a8SLen Brown * allocate a new buffer. Returned buffer is always zeroed.
28795b482a8SLen Brown *
28895b482a8SLen Brown ******************************************************************************/
28995b482a8SLen Brown
29095b482a8SLen Brown acpi_status
acpi_ut_initialize_buffer(struct acpi_buffer * buffer,acpi_size required_length)291f5c1e1c5SLv Zheng acpi_ut_initialize_buffer(struct acpi_buffer *buffer, acpi_size required_length)
29295b482a8SLen Brown {
29395b482a8SLen Brown acpi_size input_buffer_length;
29495b482a8SLen Brown
29595b482a8SLen Brown /* Parameter validation */
29695b482a8SLen Brown
29795b482a8SLen Brown if (!buffer || !required_length) {
29895b482a8SLen Brown return (AE_BAD_PARAMETER);
29995b482a8SLen Brown }
30095b482a8SLen Brown
30195b482a8SLen Brown /*
30295b482a8SLen Brown * Buffer->Length is used as both an input and output parameter. Get the
30395b482a8SLen Brown * input actual length and set the output required buffer length.
30495b482a8SLen Brown */
30595b482a8SLen Brown input_buffer_length = buffer->length;
30695b482a8SLen Brown buffer->length = required_length;
30795b482a8SLen Brown
30895b482a8SLen Brown /*
30995b482a8SLen Brown * The input buffer length contains the actual buffer length, or the type
31095b482a8SLen Brown * of buffer to be allocated by this routine.
31195b482a8SLen Brown */
31295b482a8SLen Brown switch (input_buffer_length) {
31395b482a8SLen Brown case ACPI_NO_BUFFER:
31495b482a8SLen Brown
31595b482a8SLen Brown /* Return the exception (and the required buffer length) */
31695b482a8SLen Brown
31795b482a8SLen Brown return (AE_BUFFER_OVERFLOW);
31895b482a8SLen Brown
31995b482a8SLen Brown case ACPI_ALLOCATE_BUFFER:
320bb3fec14SLv Zheng /*
321bb3fec14SLv Zheng * Allocate a new buffer. We directectly call acpi_os_allocate here to
322bb3fec14SLv Zheng * purposefully bypass the (optionally enabled) internal allocation
323bb3fec14SLv Zheng * tracking mechanism since we only want to track internal
324bb3fec14SLv Zheng * allocations. Note: The caller should use acpi_os_free to free this
325bb3fec14SLv Zheng * buffer created via ACPI_ALLOCATE_BUFFER.
326bb3fec14SLv Zheng */
32795b482a8SLen Brown buffer->pointer = acpi_os_allocate(required_length);
32895b482a8SLen Brown break;
32995b482a8SLen Brown
33095b482a8SLen Brown case ACPI_ALLOCATE_LOCAL_BUFFER:
33195b482a8SLen Brown
33295b482a8SLen Brown /* Allocate a new buffer with local interface to allow tracking */
33395b482a8SLen Brown
33495b482a8SLen Brown buffer->pointer = ACPI_ALLOCATE(required_length);
33595b482a8SLen Brown break;
33695b482a8SLen Brown
33795b482a8SLen Brown default:
33895b482a8SLen Brown
33995b482a8SLen Brown /* Existing buffer: Validate the size of the buffer */
34095b482a8SLen Brown
34195b482a8SLen Brown if (input_buffer_length < required_length) {
34295b482a8SLen Brown return (AE_BUFFER_OVERFLOW);
34395b482a8SLen Brown }
34495b482a8SLen Brown break;
34595b482a8SLen Brown }
34695b482a8SLen Brown
34795b482a8SLen Brown /* Validate allocation from above or input buffer pointer */
34895b482a8SLen Brown
34995b482a8SLen Brown if (!buffer->pointer) {
35095b482a8SLen Brown return (AE_NO_MEMORY);
35195b482a8SLen Brown }
35295b482a8SLen Brown
35395b482a8SLen Brown /* Have a valid buffer, clear it */
35495b482a8SLen Brown
3554fa4616eSBob Moore memset(buffer->pointer, 0, required_length);
35695b482a8SLen Brown return (AE_OK);
35795b482a8SLen Brown }
358