1 /******************************************************************************
3 * Module Name: utalloc - local memory allocation routines
6 *****************************************************************************/
8 /******************************************************************************
12 * Some or all of this work - Copyright (c) 1999 - 2007, Intel Corp.
13 * All rights reserved.
17 * 2.1. This is your license from Intel Corp. under its intellectual property
18 * rights. You may have additional license terms from the party that provided
19 * you this software, covering your right to use that party's intellectual
22 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
23 * copy of the source code appearing in this file ("Covered Code") an
24 * irrevocable, perpetual, worldwide license under Intel's copyrights in the
25 * base code distributed originally by Intel ("Original Intel Code") to copy,
26 * make derivatives, distribute, use and display any portion of the Covered
27 * Code in any form, with the right to sublicense such rights; and
29 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
30 * license (with the right to sublicense), under only those claims of Intel
31 * patents that are infringed by the Original Intel Code, to make, use, sell,
32 * offer to sell, and import the Covered Code and derivative works thereof
33 * solely to the minimum extent necessary to exercise the above copyright
34 * license, and in no event shall the patent license extend to any additions
35 * to or modifications of the Original Intel Code. No other license or right
36 * is granted directly or by implication, estoppel or otherwise;
38 * The above copyright and patent license is granted only if the following
43 * 3.1. Redistribution of Source with Rights to Further Distribute Source.
44 * Redistribution of source code of any substantial portion of the Covered
45 * Code or modification with rights to further distribute source must include
46 * the above Copyright Notice, the above License, this list of Conditions,
47 * and the following Disclaimer and Export Compliance provision. In addition,
48 * Licensee must cause all Covered Code to which Licensee contributes to
49 * contain a file documenting the changes Licensee made to create that Covered
50 * Code and the date of any change. Licensee must include in that file the
51 * documentation of any changes made by any predecessor Licensee. Licensee
52 * must include a prominent statement that the modification is derived,
53 * directly or indirectly, from Original Intel Code.
55 * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
56 * Redistribution of source code of any substantial portion of the Covered
57 * Code or modification without rights to further distribute source must
58 * include the following Disclaimer and Export Compliance provision in the
59 * documentation and/or other materials provided with distribution. In
60 * addition, Licensee may not authorize further sublicense of source of any
61 * portion of the Covered Code, and must include terms to the effect that the
62 * license from Licensee to its licensee is limited to the intellectual
63 * property embodied in the software Licensee provides to its licensee, and
64 * not to intellectual property embodied in modifications its licensee may
67 * 3.3. Redistribution of Executable. Redistribution in executable form of any
68 * substantial portion of the Covered Code or modification must reproduce the
69 * above Copyright Notice, and the following Disclaimer and Export Compliance
70 * provision in the documentation and/or other materials provided with the
73 * 3.4. Intel retains all right, title, and interest in and to the Original
76 * 3.5. Neither the name Intel nor any other trademark owned or controlled by
77 * Intel shall be used in advertising or otherwise to promote the sale, use or
78 * other dealings in products derived from or relating to the Covered Code
79 * without prior written authorization from Intel.
81 * 4. Disclaimer and Export Compliance
83 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
84 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
85 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
86 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
87 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
88 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
91 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
92 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
93 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
94 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
95 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
96 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
97 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
100 * 4.3. Licensee shall not export, either directly or indirectly, any of this
101 * software or system incorporating such software without first obtaining any
102 * required license or other approval from the U. S. Department of Commerce or
103 * any other agency or department of the United States Government. In the
104 * event Licensee exports any such software from the United States or
105 * re-exports any such software from a foreign destination, Licensee shall
106 * ensure that the distribution and export/re-export of the software is in
107 * compliance with all laws, regulations, orders, or other restrictions of the
108 * U.S. Export Administration Regulations. Licensee agrees that neither it nor
109 * any of its subsidiaries will export/re-export any technical data, process,
110 * software, or service, directly or indirectly, to any country for which the
111 * United States government or any agency thereof requires an export license,
112 * other governmental approval, or letter of assurance, without first obtaining
113 * such license, approval or letter.
115 *****************************************************************************/
117 #define __UTALLOC_C__
119 #include <contrib/dev/acpica/acpi.h>
120 #include <contrib/dev/acpica/acdebug.h>
122 #define _COMPONENT ACPI_UTILITIES
123 ACPI_MODULE_NAME ("utalloc")
126 /*******************************************************************************
128 * FUNCTION: AcpiUtCreateCaches
134 * DESCRIPTION: Create all local caches
136 ******************************************************************************/
145 /* Object Caches, for frequently used objects */
147 Status = AcpiOsCreateCache ("Acpi-Namespace", sizeof (ACPI_NAMESPACE_NODE),
148 ACPI_MAX_NAMESPACE_CACHE_DEPTH, &AcpiGbl_NamespaceCache);
149 if (ACPI_FAILURE (Status))
154 Status = AcpiOsCreateCache ("Acpi-State", sizeof (ACPI_GENERIC_STATE),
155 ACPI_MAX_STATE_CACHE_DEPTH, &AcpiGbl_StateCache);
156 if (ACPI_FAILURE (Status))
161 Status = AcpiOsCreateCache ("Acpi-Parse", sizeof (ACPI_PARSE_OBJ_COMMON),
162 ACPI_MAX_PARSE_CACHE_DEPTH, &AcpiGbl_PsNodeCache);
163 if (ACPI_FAILURE (Status))
168 Status = AcpiOsCreateCache ("Acpi-ParseExt", sizeof (ACPI_PARSE_OBJ_NAMED),
169 ACPI_MAX_EXTPARSE_CACHE_DEPTH, &AcpiGbl_PsNodeExtCache);
170 if (ACPI_FAILURE (Status))
175 Status = AcpiOsCreateCache ("Acpi-Operand", sizeof (ACPI_OPERAND_OBJECT),
176 ACPI_MAX_OBJECT_CACHE_DEPTH, &AcpiGbl_OperandCache);
177 if (ACPI_FAILURE (Status))
183 #ifdef ACPI_DBG_TRACK_ALLOCATIONS
185 /* Memory allocation lists */
187 Status = AcpiUtCreateList ("Acpi-Global", 0,
188 &AcpiGbl_GlobalList);
189 if (ACPI_FAILURE (Status))
194 Status = AcpiUtCreateList ("Acpi-Namespace", sizeof (ACPI_NAMESPACE_NODE),
195 &AcpiGbl_NsNodeList);
196 if (ACPI_FAILURE (Status))
206 /*******************************************************************************
208 * FUNCTION: AcpiUtDeleteCaches
214 * DESCRIPTION: Purge and delete all local caches
216 ******************************************************************************/
222 #ifdef ACPI_DBG_TRACK_ALLOCATIONS
225 if (AcpiGbl_DisplayFinalMemStats)
227 ACPI_STRCPY (Buffer, "MEMORY");
228 AcpiDbDisplayStatistics (Buffer);
232 (void) AcpiOsDeleteCache (AcpiGbl_NamespaceCache);
233 AcpiGbl_NamespaceCache = NULL;
235 (void) AcpiOsDeleteCache (AcpiGbl_StateCache);
236 AcpiGbl_StateCache = NULL;
238 (void) AcpiOsDeleteCache (AcpiGbl_OperandCache);
239 AcpiGbl_OperandCache = NULL;
241 (void) AcpiOsDeleteCache (AcpiGbl_PsNodeCache);
242 AcpiGbl_PsNodeCache = NULL;
244 (void) AcpiOsDeleteCache (AcpiGbl_PsNodeExtCache);
245 AcpiGbl_PsNodeExtCache = NULL;
248 #ifdef ACPI_DBG_TRACK_ALLOCATIONS
250 /* Debug only - display leftover memory allocation, if any */
252 AcpiUtDumpAllocations (ACPI_UINT32_MAX, NULL);
254 /* Free memory lists */
256 AcpiOsFree (AcpiGbl_GlobalList);
257 AcpiGbl_GlobalList = NULL;
259 AcpiOsFree (AcpiGbl_NsNodeList);
260 AcpiGbl_NsNodeList = NULL;
267 /*******************************************************************************
269 * FUNCTION: AcpiUtValidateBuffer
271 * PARAMETERS: Buffer - Buffer descriptor to be validated
275 * DESCRIPTION: Perform parameter validation checks on an ACPI_BUFFER
277 ******************************************************************************/
280 AcpiUtValidateBuffer (
284 /* Obviously, the structure pointer must be valid */
288 return (AE_BAD_PARAMETER);
291 /* Special semantics for the length */
293 if ((Buffer->Length == ACPI_NO_BUFFER) ||
294 (Buffer->Length == ACPI_ALLOCATE_BUFFER) ||
295 (Buffer->Length == ACPI_ALLOCATE_LOCAL_BUFFER))
300 /* Length is valid, the buffer pointer must be also */
302 if (!Buffer->Pointer)
304 return (AE_BAD_PARAMETER);
311 /*******************************************************************************
313 * FUNCTION: AcpiUtInitializeBuffer
315 * PARAMETERS: Buffer - Buffer to be validated
316 * RequiredLength - Length needed
320 * DESCRIPTION: Validate that the buffer is of the required length or
321 * allocate a new buffer. Returned buffer is always zeroed.
323 ******************************************************************************/
326 AcpiUtInitializeBuffer (
328 ACPI_SIZE RequiredLength)
330 ACPI_STATUS Status = AE_OK;
333 switch (Buffer->Length)
337 /* Set the exception and returned the required length */
339 Status = AE_BUFFER_OVERFLOW;
343 case ACPI_ALLOCATE_BUFFER:
345 /* Allocate a new buffer */
347 Buffer->Pointer = AcpiOsAllocate (RequiredLength);
348 if (!Buffer->Pointer)
350 return (AE_NO_MEMORY);
353 /* Clear the buffer */
355 ACPI_MEMSET (Buffer->Pointer, 0, RequiredLength);
359 case ACPI_ALLOCATE_LOCAL_BUFFER:
361 /* Allocate a new buffer with local interface to allow tracking */
363 Buffer->Pointer = ACPI_ALLOCATE_ZEROED (RequiredLength);
364 if (!Buffer->Pointer)
366 return (AE_NO_MEMORY);
373 /* Existing buffer: Validate the size of the buffer */
375 if (Buffer->Length < RequiredLength)
377 Status = AE_BUFFER_OVERFLOW;
381 /* Clear the buffer */
383 ACPI_MEMSET (Buffer->Pointer, 0, RequiredLength);
387 Buffer->Length = RequiredLength;
392 /*******************************************************************************
394 * FUNCTION: AcpiUtAllocate
396 * PARAMETERS: Size - Size of the allocation
397 * Component - Component type of caller
398 * Module - Source file name of caller
399 * Line - Line number of caller
401 * RETURN: Address of the allocated memory on success, NULL on failure.
403 * DESCRIPTION: Subsystem equivalent of malloc.
405 ******************************************************************************/
417 ACPI_FUNCTION_TRACE_U32 (UtAllocate, Size);
420 /* Check for an inadvertent size of zero bytes */
424 ACPI_WARNING ((Module, Line,
425 "Attempt to allocate zero bytes, allocating 1 byte"));
429 Allocation = AcpiOsAllocate (Size);
432 /* Report allocation error */
434 ACPI_WARNING ((Module, Line,
435 "Could not allocate size %X", (UINT32) Size));
440 return_PTR (Allocation);
444 /*******************************************************************************
446 * FUNCTION: AcpiUtAllocateZeroed
448 * PARAMETERS: Size - Size of the allocation
449 * Component - Component type of caller
450 * Module - Source file name of caller
451 * Line - Line number of caller
453 * RETURN: Address of the allocated memory on success, NULL on failure.
455 * DESCRIPTION: Subsystem equivalent of calloc. Allocate and zero memory.
457 ******************************************************************************/
460 AcpiUtAllocateZeroed (
469 ACPI_FUNCTION_ENTRY ();
472 Allocation = AcpiUtAllocate (Size, Component, Module, Line);
475 /* Clear the memory block */
477 ACPI_MEMSET (Allocation, 0, Size);