1 /******************************************************************************
3 * Module Name: utalloc - local memory allocation routines
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2015, Intel Corp.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
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.
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.
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.
44 #include <contrib/dev/acpica/include/acpi.h>
45 #include <contrib/dev/acpica/include/accommon.h>
46 #include <contrib/dev/acpica/include/acdebug.h>
48 #define _COMPONENT ACPI_UTILITIES
49 ACPI_MODULE_NAME ("utalloc")
52 #if !defined (USE_NATIVE_ALLOCATE_ZEROED)
53 /*******************************************************************************
55 * FUNCTION: AcpiOsAllocateZeroed
57 * PARAMETERS: Size - Size of the allocation
59 * RETURN: Address of the allocated memory on success, NULL on failure.
61 * DESCRIPTION: Subsystem equivalent of calloc. Allocate and zero memory.
62 * This is the default implementation. Can be overridden via the
63 * USE_NATIVE_ALLOCATE_ZEROED flag.
65 ******************************************************************************/
68 AcpiOsAllocateZeroed (
74 ACPI_FUNCTION_ENTRY ();
77 Allocation = AcpiOsAllocate (Size);
80 /* Clear the memory block */
82 ACPI_MEMSET (Allocation, 0, Size);
88 #endif /* !USE_NATIVE_ALLOCATE_ZEROED */
91 /*******************************************************************************
93 * FUNCTION: AcpiUtCreateCaches
99 * DESCRIPTION: Create all local caches
101 ******************************************************************************/
110 /* Object Caches, for frequently used objects */
112 Status = AcpiOsCreateCache ("Acpi-Namespace", sizeof (ACPI_NAMESPACE_NODE),
113 ACPI_MAX_NAMESPACE_CACHE_DEPTH, &AcpiGbl_NamespaceCache);
114 if (ACPI_FAILURE (Status))
119 Status = AcpiOsCreateCache ("Acpi-State", sizeof (ACPI_GENERIC_STATE),
120 ACPI_MAX_STATE_CACHE_DEPTH, &AcpiGbl_StateCache);
121 if (ACPI_FAILURE (Status))
126 Status = AcpiOsCreateCache ("Acpi-Parse", sizeof (ACPI_PARSE_OBJ_COMMON),
127 ACPI_MAX_PARSE_CACHE_DEPTH, &AcpiGbl_PsNodeCache);
128 if (ACPI_FAILURE (Status))
133 Status = AcpiOsCreateCache ("Acpi-ParseExt", sizeof (ACPI_PARSE_OBJ_NAMED),
134 ACPI_MAX_EXTPARSE_CACHE_DEPTH, &AcpiGbl_PsNodeExtCache);
135 if (ACPI_FAILURE (Status))
140 Status = AcpiOsCreateCache ("Acpi-Operand", sizeof (ACPI_OPERAND_OBJECT),
141 ACPI_MAX_OBJECT_CACHE_DEPTH, &AcpiGbl_OperandCache);
142 if (ACPI_FAILURE (Status))
148 #ifdef ACPI_DBG_TRACK_ALLOCATIONS
150 /* Memory allocation lists */
152 Status = AcpiUtCreateList ("Acpi-Global", 0,
153 &AcpiGbl_GlobalList);
154 if (ACPI_FAILURE (Status))
159 Status = AcpiUtCreateList ("Acpi-Namespace", sizeof (ACPI_NAMESPACE_NODE),
160 &AcpiGbl_NsNodeList);
161 if (ACPI_FAILURE (Status))
171 /*******************************************************************************
173 * FUNCTION: AcpiUtDeleteCaches
179 * DESCRIPTION: Purge and delete all local caches
181 ******************************************************************************/
187 #ifdef ACPI_DBG_TRACK_ALLOCATIONS
190 if (AcpiGbl_DisplayFinalMemStats)
192 ACPI_STRCPY (Buffer, "MEMORY");
193 (void) AcpiDbDisplayStatistics (Buffer);
197 (void) AcpiOsDeleteCache (AcpiGbl_NamespaceCache);
198 AcpiGbl_NamespaceCache = NULL;
200 (void) AcpiOsDeleteCache (AcpiGbl_StateCache);
201 AcpiGbl_StateCache = NULL;
203 (void) AcpiOsDeleteCache (AcpiGbl_OperandCache);
204 AcpiGbl_OperandCache = NULL;
206 (void) AcpiOsDeleteCache (AcpiGbl_PsNodeCache);
207 AcpiGbl_PsNodeCache = NULL;
209 (void) AcpiOsDeleteCache (AcpiGbl_PsNodeExtCache);
210 AcpiGbl_PsNodeExtCache = NULL;
213 #ifdef ACPI_DBG_TRACK_ALLOCATIONS
215 /* Debug only - display leftover memory allocation, if any */
217 AcpiUtDumpAllocations (ACPI_UINT32_MAX, NULL);
219 /* Free memory lists */
221 AcpiOsFree (AcpiGbl_GlobalList);
222 AcpiGbl_GlobalList = NULL;
224 AcpiOsFree (AcpiGbl_NsNodeList);
225 AcpiGbl_NsNodeList = NULL;
232 /*******************************************************************************
234 * FUNCTION: AcpiUtValidateBuffer
236 * PARAMETERS: Buffer - Buffer descriptor to be validated
240 * DESCRIPTION: Perform parameter validation checks on an ACPI_BUFFER
242 ******************************************************************************/
245 AcpiUtValidateBuffer (
249 /* Obviously, the structure pointer must be valid */
253 return (AE_BAD_PARAMETER);
256 /* Special semantics for the length */
258 if ((Buffer->Length == ACPI_NO_BUFFER) ||
259 (Buffer->Length == ACPI_ALLOCATE_BUFFER) ||
260 (Buffer->Length == ACPI_ALLOCATE_LOCAL_BUFFER))
265 /* Length is valid, the buffer pointer must be also */
267 if (!Buffer->Pointer)
269 return (AE_BAD_PARAMETER);
276 /*******************************************************************************
278 * FUNCTION: AcpiUtInitializeBuffer
280 * PARAMETERS: Buffer - Buffer to be validated
281 * RequiredLength - Length needed
285 * DESCRIPTION: Validate that the buffer is of the required length or
286 * allocate a new buffer. Returned buffer is always zeroed.
288 ******************************************************************************/
291 AcpiUtInitializeBuffer (
293 ACPI_SIZE RequiredLength)
295 ACPI_SIZE InputBufferLength;
298 /* Parameter validation */
300 if (!Buffer || !RequiredLength)
302 return (AE_BAD_PARAMETER);
306 * Buffer->Length is used as both an input and output parameter. Get the
307 * input actual length and set the output required buffer length.
309 InputBufferLength = Buffer->Length;
310 Buffer->Length = RequiredLength;
313 * The input buffer length contains the actual buffer length, or the type
314 * of buffer to be allocated by this routine.
316 switch (InputBufferLength)
320 /* Return the exception (and the required buffer length) */
322 return (AE_BUFFER_OVERFLOW);
324 case ACPI_ALLOCATE_BUFFER:
326 * Allocate a new buffer. We directectly call AcpiOsAllocate here to
327 * purposefully bypass the (optionally enabled) internal allocation
328 * tracking mechanism since we only want to track internal
329 * allocations. Note: The caller should use AcpiOsFree to free this
330 * buffer created via ACPI_ALLOCATE_BUFFER.
332 Buffer->Pointer = AcpiOsAllocate (RequiredLength);
335 case ACPI_ALLOCATE_LOCAL_BUFFER:
337 /* Allocate a new buffer with local interface to allow tracking */
339 Buffer->Pointer = ACPI_ALLOCATE (RequiredLength);
344 /* Existing buffer: Validate the size of the buffer */
346 if (InputBufferLength < RequiredLength)
348 return (AE_BUFFER_OVERFLOW);
353 /* Validate allocation from above or input buffer pointer */
355 if (!Buffer->Pointer)
357 return (AE_NO_MEMORY);
360 /* Have a valid buffer, clear it */
362 ACPI_MEMSET (Buffer->Pointer, 0, RequiredLength);