1/******************************************************************************
2 *
3 * Module Name: utalloc - local memory allocation routines
4 *
5 *****************************************************************************/
6
7/******************************************************************************
8 *
9 * 1. Copyright Notice
10 *
11 * Some or all of this work - Copyright (c) 1999 - 2012, Intel Corp.
12 * All rights reserved.
13 *
14 * 2. License
15 *
16 * 2.1. This is your license from Intel Corp. under its intellectual property
17 * rights. You may have additional license terms from the party that provided
18 * you this software, covering your right to use that party's intellectual
19 * property rights.
20 *
21 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
22 * copy of the source code appearing in this file ("Covered Code") an
23 * irrevocable, perpetual, worldwide license under Intel's copyrights in the
24 * base code distributed originally by Intel ("Original Intel Code") to copy,
25 * make derivatives, distribute, use and display any portion of the Covered
26 * Code in any form, with the right to sublicense such rights; and
27 *
28 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
29 * license (with the right to sublicense), under only those claims of Intel
30 * patents that are infringed by the Original Intel Code, to make, use, sell,
31 * offer to sell, and import the Covered Code and derivative works thereof
32 * solely to the minimum extent necessary to exercise the above copyright
33 * license, and in no event shall the patent license extend to any additions
34 * to or modifications of the Original Intel Code. No other license or right
35 * is granted directly or by implication, estoppel or otherwise;
36 *
37 * The above copyright and patent license is granted only if the following
38 * conditions are met:
39 *
40 * 3. Conditions
41 *
42 * 3.1. Redistribution of Source with Rights to Further Distribute Source.
43 * Redistribution of source code of any substantial portion of the Covered
44 * Code or modification with rights to further distribute source must include
45 * the above Copyright Notice, the above License, this list of Conditions,
46 * and the following Disclaimer and Export Compliance provision. In addition,
47 * Licensee must cause all Covered Code to which Licensee contributes to
48 * contain a file documenting the changes Licensee made to create that Covered
49 * Code and the date of any change. Licensee must include in that file the
50 * documentation of any changes made by any predecessor Licensee. Licensee
51 * must include a prominent statement that the modification is derived,
52 * directly or indirectly, from Original Intel Code.
53 *
54 * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
55 * Redistribution of source code of any substantial portion of the Covered
56 * Code or modification without rights to further distribute source must
57 * include the following Disclaimer and Export Compliance provision in the
58 * documentation and/or other materials provided with distribution. In
59 * addition, Licensee may not authorize further sublicense of source of any
60 * portion of the Covered Code, and must include terms to the effect that the
61 * license from Licensee to its licensee is limited to the intellectual
62 * property embodied in the software Licensee provides to its licensee, and
63 * not to intellectual property embodied in modifications its licensee may
64 * make.
65 *
66 * 3.3. Redistribution of Executable. Redistribution in executable form of any
67 * substantial portion of the Covered Code or modification must reproduce the
68 * above Copyright Notice, and the following Disclaimer and Export Compliance
69 * provision in the documentation and/or other materials provided with the
70 * distribution.
71 *
72 * 3.4. Intel retains all right, title, and interest in and to the Original
73 * Intel Code.
74 *
75 * 3.5. Neither the name Intel nor any other trademark owned or controlled by
76 * Intel shall be used in advertising or otherwise to promote the sale, use or
77 * other dealings in products derived from or relating to the Covered Code
78 * without prior written authorization from Intel.
79 *
80 * 4. Disclaimer and Export Compliance
81 *
82 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
83 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
84 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
85 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
86 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
87 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
88 * PARTICULAR PURPOSE.
89 *
90 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
91 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
92 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
93 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
94 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
95 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
96 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
97 * LIMITED REMEDY.
98 *
99 * 4.3. Licensee shall not export, either directly or indirectly, any of this
100 * software or system incorporating such software without first obtaining any
101 * required license or other approval from the U. S. Department of Commerce or
102 * any other agency or department of the United States Government. In the
103 * event Licensee exports any such software from the United States or
104 * re-exports any such software from a foreign destination, Licensee shall
105 * ensure that the distribution and export/re-export of the software is in
106 * compliance with all laws, regulations, orders, or other restrictions of the
107 * U.S. Export Administration Regulations. Licensee agrees that neither it nor
108 * any of its subsidiaries will export/re-export any technical data, process,
109 * software, or service, directly or indirectly, to any country for which the
110 * United States government or any agency thereof requires an export license,
111 * other governmental approval, or letter of assurance, without first obtaining
112 * such license, approval or letter.
113 *
114 *****************************************************************************/
115
116#define __UTALLOC_C__
117
118#include "acpi.h"
119#include "accommon.h"
120#include "acdebug.h"
121
122#define _COMPONENT          ACPI_UTILITIES
123        ACPI_MODULE_NAME    ("utalloc")
124
125
126/*******************************************************************************
127 *
128 * FUNCTION:    AcpiUtCreateCaches
129 *
130 * PARAMETERS:  None
131 *
132 * RETURN:      Status
133 *
134 * DESCRIPTION: Create all local caches
135 *
136 ******************************************************************************/
137
138ACPI_STATUS
139AcpiUtCreateCaches (
140    void)
141{
142    ACPI_STATUS             Status;
143
144
145    /* Object Caches, for frequently used objects */
146
147    Status = AcpiOsCreateCache ("Acpi-Namespace", sizeof (ACPI_NAMESPACE_NODE),
148                ACPI_MAX_NAMESPACE_CACHE_DEPTH, &AcpiGbl_NamespaceCache);
149    if (ACPI_FAILURE (Status))
150    {
151        return (Status);
152    }
153
154    Status = AcpiOsCreateCache ("Acpi-State", sizeof (ACPI_GENERIC_STATE),
155                ACPI_MAX_STATE_CACHE_DEPTH, &AcpiGbl_StateCache);
156    if (ACPI_FAILURE (Status))
157    {
158        return (Status);
159    }
160
161    Status = AcpiOsCreateCache ("Acpi-Parse", sizeof (ACPI_PARSE_OBJ_COMMON),
162                ACPI_MAX_PARSE_CACHE_DEPTH, &AcpiGbl_PsNodeCache);
163    if (ACPI_FAILURE (Status))
164    {
165        return (Status);
166    }
167
168    Status = AcpiOsCreateCache ("Acpi-ParseExt", sizeof (ACPI_PARSE_OBJ_NAMED),
169                ACPI_MAX_EXTPARSE_CACHE_DEPTH, &AcpiGbl_PsNodeExtCache);
170    if (ACPI_FAILURE (Status))
171    {
172        return (Status);
173    }
174
175    Status = AcpiOsCreateCache ("Acpi-Operand", sizeof (ACPI_OPERAND_OBJECT),
176                ACPI_MAX_OBJECT_CACHE_DEPTH, &AcpiGbl_OperandCache);
177    if (ACPI_FAILURE (Status))
178    {
179        return (Status);
180    }
181
182
183#ifdef ACPI_DBG_TRACK_ALLOCATIONS
184
185    /* Memory allocation lists */
186
187    Status = AcpiUtCreateList ("Acpi-Global", 0,
188                &AcpiGbl_GlobalList);
189    if (ACPI_FAILURE (Status))
190    {
191        return (Status);
192    }
193
194    Status = AcpiUtCreateList ("Acpi-Namespace", sizeof (ACPI_NAMESPACE_NODE),
195                &AcpiGbl_NsNodeList);
196    if (ACPI_FAILURE (Status))
197    {
198        return (Status);
199    }
200#endif
201
202    return (AE_OK);
203}
204
205
206/*******************************************************************************
207 *
208 * FUNCTION:    AcpiUtDeleteCaches
209 *
210 * PARAMETERS:  None
211 *
212 * RETURN:      Status
213 *
214 * DESCRIPTION: Purge and delete all local caches
215 *
216 ******************************************************************************/
217
218ACPI_STATUS
219AcpiUtDeleteCaches (
220    void)
221{
222#ifdef ACPI_DBG_TRACK_ALLOCATIONS
223    char                    Buffer[7];
224
225    if (AcpiGbl_DisplayFinalMemStats)
226    {
227        ACPI_STRCPY (Buffer, "MEMORY");
228        (void) AcpiDbDisplayStatistics (Buffer);
229    }
230#endif
231
232    (void) AcpiOsDeleteCache (AcpiGbl_NamespaceCache);
233    AcpiGbl_NamespaceCache = NULL;
234
235    (void) AcpiOsDeleteCache (AcpiGbl_StateCache);
236    AcpiGbl_StateCache = NULL;
237
238    (void) AcpiOsDeleteCache (AcpiGbl_OperandCache);
239    AcpiGbl_OperandCache = NULL;
240
241    (void) AcpiOsDeleteCache (AcpiGbl_PsNodeCache);
242    AcpiGbl_PsNodeCache = NULL;
243
244    (void) AcpiOsDeleteCache (AcpiGbl_PsNodeExtCache);
245    AcpiGbl_PsNodeExtCache = NULL;
246
247
248#ifdef ACPI_DBG_TRACK_ALLOCATIONS
249
250    /* Debug only - display leftover memory allocation, if any */
251
252    AcpiUtDumpAllocations (ACPI_UINT32_MAX, NULL);
253
254    /* Free memory lists */
255
256    AcpiOsFree (AcpiGbl_GlobalList);
257    AcpiGbl_GlobalList = NULL;
258
259    AcpiOsFree (AcpiGbl_NsNodeList);
260    AcpiGbl_NsNodeList = NULL;
261#endif
262
263    return (AE_OK);
264}
265
266
267/*******************************************************************************
268 *
269 * FUNCTION:    AcpiUtValidateBuffer
270 *
271 * PARAMETERS:  Buffer              - Buffer descriptor to be validated
272 *
273 * RETURN:      Status
274 *
275 * DESCRIPTION: Perform parameter validation checks on an ACPI_BUFFER
276 *
277 ******************************************************************************/
278
279ACPI_STATUS
280AcpiUtValidateBuffer (
281    ACPI_BUFFER             *Buffer)
282{
283
284    /* Obviously, the structure pointer must be valid */
285
286    if (!Buffer)
287    {
288        return (AE_BAD_PARAMETER);
289    }
290
291    /* Special semantics for the length */
292
293    if ((Buffer->Length == ACPI_NO_BUFFER)              ||
294        (Buffer->Length == ACPI_ALLOCATE_BUFFER)        ||
295        (Buffer->Length == ACPI_ALLOCATE_LOCAL_BUFFER))
296    {
297        return (AE_OK);
298    }
299
300    /* Length is valid, the buffer pointer must be also */
301
302    if (!Buffer->Pointer)
303    {
304        return (AE_BAD_PARAMETER);
305    }
306
307    return (AE_OK);
308}
309
310
311/*******************************************************************************
312 *
313 * FUNCTION:    AcpiUtInitializeBuffer
314 *
315 * PARAMETERS:  Buffer              - Buffer to be validated
316 *              RequiredLength      - Length needed
317 *
318 * RETURN:      Status
319 *
320 * DESCRIPTION: Validate that the buffer is of the required length or
321 *              allocate a new buffer. Returned buffer is always zeroed.
322 *
323 ******************************************************************************/
324
325ACPI_STATUS
326AcpiUtInitializeBuffer (
327    ACPI_BUFFER             *Buffer,
328    ACPI_SIZE               RequiredLength)
329{
330    ACPI_SIZE               InputBufferLength;
331
332
333    /* Parameter validation */
334
335    if (!Buffer || !RequiredLength)
336    {
337        return (AE_BAD_PARAMETER);
338    }
339
340    /*
341     * Buffer->Length is used as both an input and output parameter. Get the
342     * input actual length and set the output required buffer length.
343     */
344    InputBufferLength = Buffer->Length;
345    Buffer->Length = RequiredLength;
346
347    /*
348     * The input buffer length contains the actual buffer length, or the type
349     * of buffer to be allocated by this routine.
350     */
351    switch (InputBufferLength)
352    {
353    case ACPI_NO_BUFFER:
354
355        /* Return the exception (and the required buffer length) */
356
357        return (AE_BUFFER_OVERFLOW);
358
359    case ACPI_ALLOCATE_BUFFER:
360
361        /* Allocate a new buffer */
362
363        Buffer->Pointer = AcpiOsAllocate (RequiredLength);
364        break;
365
366    case ACPI_ALLOCATE_LOCAL_BUFFER:
367
368        /* Allocate a new buffer with local interface to allow tracking */
369
370        Buffer->Pointer = ACPI_ALLOCATE (RequiredLength);
371        break;
372
373    default:
374
375        /* Existing buffer: Validate the size of the buffer */
376
377        if (InputBufferLength < RequiredLength)
378        {
379            return (AE_BUFFER_OVERFLOW);
380        }
381        break;
382    }
383
384    /* Validate allocation from above or input buffer pointer */
385
386    if (!Buffer->Pointer)
387    {
388        return (AE_NO_MEMORY);
389    }
390
391    /* Have a valid buffer, clear it */
392
393    ACPI_MEMSET (Buffer->Pointer, 0, RequiredLength);
394    return (AE_OK);
395}
396
397
398/*******************************************************************************
399 *
400 * FUNCTION:    AcpiUtAllocate
401 *
402 * PARAMETERS:  Size                - Size of the allocation
403 *              Component           - Component type of caller
404 *              Module              - Source file name of caller
405 *              Line                - Line number of caller
406 *
407 * RETURN:      Address of the allocated memory on success, NULL on failure.
408 *
409 * DESCRIPTION: Subsystem equivalent of malloc.
410 *
411 ******************************************************************************/
412
413void *
414AcpiUtAllocate (
415    ACPI_SIZE               Size,
416    UINT32                  Component,
417    const char              *Module,
418    UINT32                  Line)
419{
420    void                    *Allocation;
421
422
423    ACPI_FUNCTION_TRACE_U32 (UtAllocate, Size);
424
425
426    /* Check for an inadvertent size of zero bytes */
427
428    if (!Size)
429    {
430        ACPI_WARNING ((Module, Line,
431            "Attempt to allocate zero bytes, allocating 1 byte"));
432        Size = 1;
433    }
434
435    Allocation = AcpiOsAllocate (Size);
436    if (!Allocation)
437    {
438        /* Report allocation error */
439
440        ACPI_WARNING ((Module, Line,
441            "Could not allocate size %u", (UINT32) Size));
442
443        return_PTR (NULL);
444    }
445
446    return_PTR (Allocation);
447}
448
449
450/*******************************************************************************
451 *
452 * FUNCTION:    AcpiUtAllocateZeroed
453 *
454 * PARAMETERS:  Size                - Size of the allocation
455 *              Component           - Component type of caller
456 *              Module              - Source file name of caller
457 *              Line                - Line number of caller
458 *
459 * RETURN:      Address of the allocated memory on success, NULL on failure.
460 *
461 * DESCRIPTION: Subsystem equivalent of calloc. Allocate and zero memory.
462 *
463 ******************************************************************************/
464
465void *
466AcpiUtAllocateZeroed (
467    ACPI_SIZE               Size,
468    UINT32                  Component,
469    const char              *Module,
470    UINT32                  Line)
471{
472    void                    *Allocation;
473
474
475    ACPI_FUNCTION_ENTRY ();
476
477
478    Allocation = AcpiUtAllocate (Size, Component, Module, Line);
479    if (Allocation)
480    {
481        /* Clear the memory block */
482
483        ACPI_MEMSET (Allocation, 0, Size);
484    }
485
486    return (Allocation);
487}
488