Home | History | Annotate | Line # | Download | only in utilities
utalloc.c revision 1.1.1.3
      1      1.1    jruoho /******************************************************************************
      2      1.1    jruoho  *
      3      1.1    jruoho  * Module Name: utalloc - local memory allocation routines
      4      1.1    jruoho  *
      5      1.1    jruoho  *****************************************************************************/
      6      1.1    jruoho 
      7  1.1.1.2    jruoho /*
      8  1.1.1.3  christos  * Copyright (C) 2000 - 2013, Intel Corp.
      9      1.1    jruoho  * All rights reserved.
     10      1.1    jruoho  *
     11  1.1.1.2    jruoho  * Redistribution and use in source and binary forms, with or without
     12  1.1.1.2    jruoho  * modification, are permitted provided that the following conditions
     13  1.1.1.2    jruoho  * are met:
     14  1.1.1.2    jruoho  * 1. Redistributions of source code must retain the above copyright
     15  1.1.1.2    jruoho  *    notice, this list of conditions, and the following disclaimer,
     16  1.1.1.2    jruoho  *    without modification.
     17  1.1.1.2    jruoho  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
     18  1.1.1.2    jruoho  *    substantially similar to the "NO WARRANTY" disclaimer below
     19  1.1.1.2    jruoho  *    ("Disclaimer") and any redistribution must be conditioned upon
     20  1.1.1.2    jruoho  *    including a substantially similar Disclaimer requirement for further
     21  1.1.1.2    jruoho  *    binary redistribution.
     22  1.1.1.2    jruoho  * 3. Neither the names of the above-listed copyright holders nor the names
     23  1.1.1.2    jruoho  *    of any contributors may be used to endorse or promote products derived
     24  1.1.1.2    jruoho  *    from this software without specific prior written permission.
     25  1.1.1.2    jruoho  *
     26  1.1.1.2    jruoho  * Alternatively, this software may be distributed under the terms of the
     27  1.1.1.2    jruoho  * GNU General Public License ("GPL") version 2 as published by the Free
     28  1.1.1.2    jruoho  * Software Foundation.
     29  1.1.1.2    jruoho  *
     30  1.1.1.2    jruoho  * NO WARRANTY
     31  1.1.1.2    jruoho  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
     32  1.1.1.2    jruoho  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
     33  1.1.1.2    jruoho  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
     34  1.1.1.2    jruoho  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
     35  1.1.1.2    jruoho  * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
     36  1.1.1.2    jruoho  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
     37  1.1.1.2    jruoho  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
     38  1.1.1.2    jruoho  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
     39  1.1.1.2    jruoho  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
     40  1.1.1.2    jruoho  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
     41  1.1.1.2    jruoho  * POSSIBILITY OF SUCH DAMAGES.
     42  1.1.1.2    jruoho  */
     43      1.1    jruoho 
     44      1.1    jruoho #define __UTALLOC_C__
     45      1.1    jruoho 
     46      1.1    jruoho #include "acpi.h"
     47      1.1    jruoho #include "accommon.h"
     48      1.1    jruoho #include "acdebug.h"
     49      1.1    jruoho 
     50      1.1    jruoho #define _COMPONENT          ACPI_UTILITIES
     51      1.1    jruoho         ACPI_MODULE_NAME    ("utalloc")
     52      1.1    jruoho 
     53      1.1    jruoho 
     54  1.1.1.3  christos #if !defined (USE_NATIVE_ALLOCATE_ZEROED)
     55  1.1.1.3  christos /*******************************************************************************
     56  1.1.1.3  christos  *
     57  1.1.1.3  christos  * FUNCTION:    AcpiOsAllocateZeroed
     58  1.1.1.3  christos  *
     59  1.1.1.3  christos  * PARAMETERS:  Size                - Size of the allocation
     60  1.1.1.3  christos  *
     61  1.1.1.3  christos  * RETURN:      Address of the allocated memory on success, NULL on failure.
     62  1.1.1.3  christos  *
     63  1.1.1.3  christos  * DESCRIPTION: Subsystem equivalent of calloc. Allocate and zero memory.
     64  1.1.1.3  christos  *              This is the default implementation. Can be overridden via the
     65  1.1.1.3  christos  *              USE_NATIVE_ALLOCATE_ZEROED flag.
     66  1.1.1.3  christos  *
     67  1.1.1.3  christos  ******************************************************************************/
     68  1.1.1.3  christos 
     69  1.1.1.3  christos void *
     70  1.1.1.3  christos AcpiOsAllocateZeroed (
     71  1.1.1.3  christos     ACPI_SIZE               Size)
     72  1.1.1.3  christos {
     73  1.1.1.3  christos     void                    *Allocation;
     74  1.1.1.3  christos 
     75  1.1.1.3  christos 
     76  1.1.1.3  christos     ACPI_FUNCTION_ENTRY ();
     77  1.1.1.3  christos 
     78  1.1.1.3  christos 
     79  1.1.1.3  christos     Allocation = AcpiOsAllocate (Size);
     80  1.1.1.3  christos     if (Allocation)
     81  1.1.1.3  christos     {
     82  1.1.1.3  christos         /* Clear the memory block */
     83  1.1.1.3  christos 
     84  1.1.1.3  christos         ACPI_MEMSET (Allocation, 0, Size);
     85  1.1.1.3  christos     }
     86  1.1.1.3  christos 
     87  1.1.1.3  christos     return (Allocation);
     88  1.1.1.3  christos }
     89  1.1.1.3  christos 
     90  1.1.1.3  christos #endif /* !USE_NATIVE_ALLOCATE_ZEROED */
     91  1.1.1.3  christos 
     92  1.1.1.3  christos 
     93      1.1    jruoho /*******************************************************************************
     94      1.1    jruoho  *
     95      1.1    jruoho  * FUNCTION:    AcpiUtCreateCaches
     96      1.1    jruoho  *
     97      1.1    jruoho  * PARAMETERS:  None
     98      1.1    jruoho  *
     99      1.1    jruoho  * RETURN:      Status
    100      1.1    jruoho  *
    101      1.1    jruoho  * DESCRIPTION: Create all local caches
    102      1.1    jruoho  *
    103      1.1    jruoho  ******************************************************************************/
    104      1.1    jruoho 
    105      1.1    jruoho ACPI_STATUS
    106      1.1    jruoho AcpiUtCreateCaches (
    107      1.1    jruoho     void)
    108      1.1    jruoho {
    109      1.1    jruoho     ACPI_STATUS             Status;
    110      1.1    jruoho 
    111      1.1    jruoho 
    112      1.1    jruoho     /* Object Caches, for frequently used objects */
    113      1.1    jruoho 
    114      1.1    jruoho     Status = AcpiOsCreateCache ("Acpi-Namespace", sizeof (ACPI_NAMESPACE_NODE),
    115      1.1    jruoho                 ACPI_MAX_NAMESPACE_CACHE_DEPTH, &AcpiGbl_NamespaceCache);
    116      1.1    jruoho     if (ACPI_FAILURE (Status))
    117      1.1    jruoho     {
    118      1.1    jruoho         return (Status);
    119      1.1    jruoho     }
    120      1.1    jruoho 
    121      1.1    jruoho     Status = AcpiOsCreateCache ("Acpi-State", sizeof (ACPI_GENERIC_STATE),
    122      1.1    jruoho                 ACPI_MAX_STATE_CACHE_DEPTH, &AcpiGbl_StateCache);
    123      1.1    jruoho     if (ACPI_FAILURE (Status))
    124      1.1    jruoho     {
    125      1.1    jruoho         return (Status);
    126      1.1    jruoho     }
    127      1.1    jruoho 
    128      1.1    jruoho     Status = AcpiOsCreateCache ("Acpi-Parse", sizeof (ACPI_PARSE_OBJ_COMMON),
    129      1.1    jruoho                 ACPI_MAX_PARSE_CACHE_DEPTH, &AcpiGbl_PsNodeCache);
    130      1.1    jruoho     if (ACPI_FAILURE (Status))
    131      1.1    jruoho     {
    132      1.1    jruoho         return (Status);
    133      1.1    jruoho     }
    134      1.1    jruoho 
    135      1.1    jruoho     Status = AcpiOsCreateCache ("Acpi-ParseExt", sizeof (ACPI_PARSE_OBJ_NAMED),
    136      1.1    jruoho                 ACPI_MAX_EXTPARSE_CACHE_DEPTH, &AcpiGbl_PsNodeExtCache);
    137      1.1    jruoho     if (ACPI_FAILURE (Status))
    138      1.1    jruoho     {
    139      1.1    jruoho         return (Status);
    140      1.1    jruoho     }
    141      1.1    jruoho 
    142      1.1    jruoho     Status = AcpiOsCreateCache ("Acpi-Operand", sizeof (ACPI_OPERAND_OBJECT),
    143      1.1    jruoho                 ACPI_MAX_OBJECT_CACHE_DEPTH, &AcpiGbl_OperandCache);
    144      1.1    jruoho     if (ACPI_FAILURE (Status))
    145      1.1    jruoho     {
    146      1.1    jruoho         return (Status);
    147      1.1    jruoho     }
    148      1.1    jruoho 
    149      1.1    jruoho 
    150      1.1    jruoho #ifdef ACPI_DBG_TRACK_ALLOCATIONS
    151      1.1    jruoho 
    152      1.1    jruoho     /* Memory allocation lists */
    153      1.1    jruoho 
    154      1.1    jruoho     Status = AcpiUtCreateList ("Acpi-Global", 0,
    155      1.1    jruoho                 &AcpiGbl_GlobalList);
    156      1.1    jruoho     if (ACPI_FAILURE (Status))
    157      1.1    jruoho     {
    158      1.1    jruoho         return (Status);
    159      1.1    jruoho     }
    160      1.1    jruoho 
    161      1.1    jruoho     Status = AcpiUtCreateList ("Acpi-Namespace", sizeof (ACPI_NAMESPACE_NODE),
    162      1.1    jruoho                 &AcpiGbl_NsNodeList);
    163      1.1    jruoho     if (ACPI_FAILURE (Status))
    164      1.1    jruoho     {
    165      1.1    jruoho         return (Status);
    166      1.1    jruoho     }
    167      1.1    jruoho #endif
    168      1.1    jruoho 
    169      1.1    jruoho     return (AE_OK);
    170      1.1    jruoho }
    171      1.1    jruoho 
    172      1.1    jruoho 
    173      1.1    jruoho /*******************************************************************************
    174      1.1    jruoho  *
    175      1.1    jruoho  * FUNCTION:    AcpiUtDeleteCaches
    176      1.1    jruoho  *
    177      1.1    jruoho  * PARAMETERS:  None
    178      1.1    jruoho  *
    179      1.1    jruoho  * RETURN:      Status
    180      1.1    jruoho  *
    181      1.1    jruoho  * DESCRIPTION: Purge and delete all local caches
    182      1.1    jruoho  *
    183      1.1    jruoho  ******************************************************************************/
    184      1.1    jruoho 
    185      1.1    jruoho ACPI_STATUS
    186      1.1    jruoho AcpiUtDeleteCaches (
    187      1.1    jruoho     void)
    188      1.1    jruoho {
    189      1.1    jruoho #ifdef ACPI_DBG_TRACK_ALLOCATIONS
    190      1.1    jruoho     char                    Buffer[7];
    191      1.1    jruoho 
    192      1.1    jruoho     if (AcpiGbl_DisplayFinalMemStats)
    193      1.1    jruoho     {
    194      1.1    jruoho         ACPI_STRCPY (Buffer, "MEMORY");
    195      1.1    jruoho         (void) AcpiDbDisplayStatistics (Buffer);
    196      1.1    jruoho     }
    197      1.1    jruoho #endif
    198      1.1    jruoho 
    199      1.1    jruoho     (void) AcpiOsDeleteCache (AcpiGbl_NamespaceCache);
    200      1.1    jruoho     AcpiGbl_NamespaceCache = NULL;
    201      1.1    jruoho 
    202      1.1    jruoho     (void) AcpiOsDeleteCache (AcpiGbl_StateCache);
    203      1.1    jruoho     AcpiGbl_StateCache = NULL;
    204      1.1    jruoho 
    205      1.1    jruoho     (void) AcpiOsDeleteCache (AcpiGbl_OperandCache);
    206      1.1    jruoho     AcpiGbl_OperandCache = NULL;
    207      1.1    jruoho 
    208      1.1    jruoho     (void) AcpiOsDeleteCache (AcpiGbl_PsNodeCache);
    209      1.1    jruoho     AcpiGbl_PsNodeCache = NULL;
    210      1.1    jruoho 
    211      1.1    jruoho     (void) AcpiOsDeleteCache (AcpiGbl_PsNodeExtCache);
    212      1.1    jruoho     AcpiGbl_PsNodeExtCache = NULL;
    213      1.1    jruoho 
    214      1.1    jruoho 
    215      1.1    jruoho #ifdef ACPI_DBG_TRACK_ALLOCATIONS
    216      1.1    jruoho 
    217      1.1    jruoho     /* Debug only - display leftover memory allocation, if any */
    218      1.1    jruoho 
    219      1.1    jruoho     AcpiUtDumpAllocations (ACPI_UINT32_MAX, NULL);
    220      1.1    jruoho 
    221      1.1    jruoho     /* Free memory lists */
    222      1.1    jruoho 
    223      1.1    jruoho     AcpiOsFree (AcpiGbl_GlobalList);
    224      1.1    jruoho     AcpiGbl_GlobalList = NULL;
    225      1.1    jruoho 
    226      1.1    jruoho     AcpiOsFree (AcpiGbl_NsNodeList);
    227      1.1    jruoho     AcpiGbl_NsNodeList = NULL;
    228      1.1    jruoho #endif
    229      1.1    jruoho 
    230      1.1    jruoho     return (AE_OK);
    231      1.1    jruoho }
    232      1.1    jruoho 
    233      1.1    jruoho 
    234      1.1    jruoho /*******************************************************************************
    235      1.1    jruoho  *
    236      1.1    jruoho  * FUNCTION:    AcpiUtValidateBuffer
    237      1.1    jruoho  *
    238      1.1    jruoho  * PARAMETERS:  Buffer              - Buffer descriptor to be validated
    239      1.1    jruoho  *
    240      1.1    jruoho  * RETURN:      Status
    241      1.1    jruoho  *
    242      1.1    jruoho  * DESCRIPTION: Perform parameter validation checks on an ACPI_BUFFER
    243      1.1    jruoho  *
    244      1.1    jruoho  ******************************************************************************/
    245      1.1    jruoho 
    246      1.1    jruoho ACPI_STATUS
    247      1.1    jruoho AcpiUtValidateBuffer (
    248      1.1    jruoho     ACPI_BUFFER             *Buffer)
    249      1.1    jruoho {
    250      1.1    jruoho 
    251      1.1    jruoho     /* Obviously, the structure pointer must be valid */
    252      1.1    jruoho 
    253      1.1    jruoho     if (!Buffer)
    254      1.1    jruoho     {
    255      1.1    jruoho         return (AE_BAD_PARAMETER);
    256      1.1    jruoho     }
    257      1.1    jruoho 
    258      1.1    jruoho     /* Special semantics for the length */
    259      1.1    jruoho 
    260      1.1    jruoho     if ((Buffer->Length == ACPI_NO_BUFFER)              ||
    261      1.1    jruoho         (Buffer->Length == ACPI_ALLOCATE_BUFFER)        ||
    262      1.1    jruoho         (Buffer->Length == ACPI_ALLOCATE_LOCAL_BUFFER))
    263      1.1    jruoho     {
    264      1.1    jruoho         return (AE_OK);
    265      1.1    jruoho     }
    266      1.1    jruoho 
    267      1.1    jruoho     /* Length is valid, the buffer pointer must be also */
    268      1.1    jruoho 
    269      1.1    jruoho     if (!Buffer->Pointer)
    270      1.1    jruoho     {
    271      1.1    jruoho         return (AE_BAD_PARAMETER);
    272      1.1    jruoho     }
    273      1.1    jruoho 
    274      1.1    jruoho     return (AE_OK);
    275      1.1    jruoho }
    276      1.1    jruoho 
    277      1.1    jruoho 
    278      1.1    jruoho /*******************************************************************************
    279      1.1    jruoho  *
    280      1.1    jruoho  * FUNCTION:    AcpiUtInitializeBuffer
    281      1.1    jruoho  *
    282      1.1    jruoho  * PARAMETERS:  Buffer              - Buffer to be validated
    283      1.1    jruoho  *              RequiredLength      - Length needed
    284      1.1    jruoho  *
    285      1.1    jruoho  * RETURN:      Status
    286      1.1    jruoho  *
    287      1.1    jruoho  * DESCRIPTION: Validate that the buffer is of the required length or
    288      1.1    jruoho  *              allocate a new buffer. Returned buffer is always zeroed.
    289      1.1    jruoho  *
    290      1.1    jruoho  ******************************************************************************/
    291      1.1    jruoho 
    292      1.1    jruoho ACPI_STATUS
    293      1.1    jruoho AcpiUtInitializeBuffer (
    294      1.1    jruoho     ACPI_BUFFER             *Buffer,
    295      1.1    jruoho     ACPI_SIZE               RequiredLength)
    296      1.1    jruoho {
    297      1.1    jruoho     ACPI_SIZE               InputBufferLength;
    298      1.1    jruoho 
    299      1.1    jruoho 
    300      1.1    jruoho     /* Parameter validation */
    301      1.1    jruoho 
    302      1.1    jruoho     if (!Buffer || !RequiredLength)
    303      1.1    jruoho     {
    304      1.1    jruoho         return (AE_BAD_PARAMETER);
    305      1.1    jruoho     }
    306      1.1    jruoho 
    307      1.1    jruoho     /*
    308      1.1    jruoho      * Buffer->Length is used as both an input and output parameter. Get the
    309      1.1    jruoho      * input actual length and set the output required buffer length.
    310      1.1    jruoho      */
    311      1.1    jruoho     InputBufferLength = Buffer->Length;
    312      1.1    jruoho     Buffer->Length = RequiredLength;
    313      1.1    jruoho 
    314      1.1    jruoho     /*
    315      1.1    jruoho      * The input buffer length contains the actual buffer length, or the type
    316      1.1    jruoho      * of buffer to be allocated by this routine.
    317      1.1    jruoho      */
    318      1.1    jruoho     switch (InputBufferLength)
    319      1.1    jruoho     {
    320      1.1    jruoho     case ACPI_NO_BUFFER:
    321      1.1    jruoho 
    322      1.1    jruoho         /* Return the exception (and the required buffer length) */
    323      1.1    jruoho 
    324      1.1    jruoho         return (AE_BUFFER_OVERFLOW);
    325      1.1    jruoho 
    326      1.1    jruoho     case ACPI_ALLOCATE_BUFFER:
    327  1.1.1.3  christos         /*
    328  1.1.1.3  christos          * Allocate a new buffer. We directectly call AcpiOsAllocate here to
    329  1.1.1.3  christos          * purposefully bypass the (optionally enabled) internal allocation
    330  1.1.1.3  christos          * tracking mechanism since we only want to track internal
    331  1.1.1.3  christos          * allocations. Note: The caller should use AcpiOsFree to free this
    332  1.1.1.3  christos          * buffer created via ACPI_ALLOCATE_BUFFER.
    333  1.1.1.3  christos          */
    334      1.1    jruoho         Buffer->Pointer = AcpiOsAllocate (RequiredLength);
    335      1.1    jruoho         break;
    336      1.1    jruoho 
    337      1.1    jruoho     case ACPI_ALLOCATE_LOCAL_BUFFER:
    338      1.1    jruoho 
    339      1.1    jruoho         /* Allocate a new buffer with local interface to allow tracking */
    340      1.1    jruoho 
    341      1.1    jruoho         Buffer->Pointer = ACPI_ALLOCATE (RequiredLength);
    342      1.1    jruoho         break;
    343      1.1    jruoho 
    344      1.1    jruoho     default:
    345      1.1    jruoho 
    346      1.1    jruoho         /* Existing buffer: Validate the size of the buffer */
    347      1.1    jruoho 
    348      1.1    jruoho         if (InputBufferLength < RequiredLength)
    349      1.1    jruoho         {
    350      1.1    jruoho             return (AE_BUFFER_OVERFLOW);
    351      1.1    jruoho         }
    352      1.1    jruoho         break;
    353      1.1    jruoho     }
    354      1.1    jruoho 
    355      1.1    jruoho     /* Validate allocation from above or input buffer pointer */
    356      1.1    jruoho 
    357      1.1    jruoho     if (!Buffer->Pointer)
    358      1.1    jruoho     {
    359      1.1    jruoho         return (AE_NO_MEMORY);
    360      1.1    jruoho     }
    361      1.1    jruoho 
    362      1.1    jruoho     /* Have a valid buffer, clear it */
    363      1.1    jruoho 
    364      1.1    jruoho     ACPI_MEMSET (Buffer->Pointer, 0, RequiredLength);
    365      1.1    jruoho     return (AE_OK);
    366      1.1    jruoho }
    367